def create_with_http_info(self, object_type, **kwargs): # noqa: E501 """Create a property group # noqa: E501 Create and return a copy of a new property group. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_with_http_info(object_type, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str object_type: (required) :param PropertyGroupCreate property_group_create: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(PropertyGroup, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['object_type', 'property_group_create'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError("Got an unexpected keyword argument '%s'" " to method create" % key) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'object_type' is set if self.api_client.client_side_validation and ( 'object_type' not in local_var_params or # noqa: E501 local_var_params['object_type'] is None): # noqa: E501 raise ApiValueError( "Missing the required parameter `object_type` when calling `create`" ) # noqa: E501 collection_formats = {} path_params = {} if 'object_type' in local_var_params: path_params['objectType'] = local_var_params[ 'object_type'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'property_group_create' in local_var_params: body_params = local_var_params['property_group_create'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json', '*/*']) # noqa: E501 # HTTP header `Content-Type` header_params[ 'Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['hapikey', 'oauth2'] # noqa: E501 return self.api_client.call_api( '/crm/v3/properties/{objectType}/groups', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PropertyGroup', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get( '_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
def get_by_name_with_http_info(self, object_type, property_name, **kwargs): # noqa: E501 """Read a property # noqa: E501 Read a property identified by {propertyName}. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_by_name_with_http_info(object_type, property_name, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str object_type: (required) :param str property_name: (required) :param bool archived: Whether to return only results that have been archived. :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(ModelProperty, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['object_type', 'property_name', 'archived'] all_params.extend([ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ]) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError("Got an unexpected keyword argument '%s'" " to method get_by_name" % key) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'object_type' is set if self.api_client.client_side_validation and ( 'object_type' not in local_var_params or # noqa: E501 local_var_params['object_type'] is None): # noqa: E501 raise ApiValueError( "Missing the required parameter `object_type` when calling `get_by_name`" ) # noqa: E501 # verify the required parameter 'property_name' is set if self.api_client.client_side_validation and ( 'property_name' not in local_var_params or # noqa: E501 local_var_params['property_name'] is None): # noqa: E501 raise ApiValueError( "Missing the required parameter `property_name` when calling `get_by_name`" ) # noqa: E501 collection_formats = {} path_params = {} if 'object_type' in local_var_params: path_params['objectType'] = local_var_params[ 'object_type'] # noqa: E501 if 'property_name' in local_var_params: path_params['propertyName'] = local_var_params[ 'property_name'] # noqa: E501 query_params = [] if 'archived' in local_var_params and local_var_params[ 'archived'] is not None: # noqa: E501 query_params.append( ('archived', local_var_params['archived'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json', '*/*']) # noqa: E501 # Authentication setting auth_settings = ['hapikey', 'oauth2'] # noqa: E501 return self.api_client.call_api( '/crm/v3/properties/{objectType}/{propertyName}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ModelProperty', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get( '_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
def archive_with_http_info(self, object_type, group_name, **kwargs): # noqa: E501 """Archive a property group # noqa: E501 Move a property group identified by {groupName} to the recycling bin. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.archive_with_http_info(object_type, group_name, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str object_type: (required) :param str group_name: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ["object_type", "group_name"] # noqa: E501 all_params.append("async_req") all_params.append("_return_http_data_only") all_params.append("_preload_content") all_params.append("_request_timeout") for key, val in six.iteritems(local_var_params["kwargs"]): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method archive" % key ) local_var_params[key] = val del local_var_params["kwargs"] # verify the required parameter 'object_type' is set if self.api_client.client_side_validation and ( "object_type" not in local_var_params or local_var_params["object_type"] is None # noqa: E501 ): # noqa: E501 raise ApiValueError( "Missing the required parameter `object_type` when calling `archive`" ) # noqa: E501 # verify the required parameter 'group_name' is set if self.api_client.client_side_validation and ( "group_name" not in local_var_params or local_var_params["group_name"] is None # noqa: E501 ): # noqa: E501 raise ApiValueError( "Missing the required parameter `group_name` when calling `archive`" ) # noqa: E501 collection_formats = {} path_params = {} if "object_type" in local_var_params: path_params["objectType"] = local_var_params["object_type"] # noqa: E501 if "group_name" in local_var_params: path_params["groupName"] = local_var_params["group_name"] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params["Accept"] = self.api_client.select_header_accept( ["*/*"] ) # noqa: E501 # Authentication setting auth_settings = ["hapikey", "oauth2"] # noqa: E501 return self.api_client.call_api( "/crm/v3/properties/{objectType}/groups/{groupName}", "DELETE", path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get("async_req"), _return_http_data_only=local_var_params.get( "_return_http_data_only" ), # noqa: E501 _preload_content=local_var_params.get("_preload_content", True), _request_timeout=local_var_params.get("_request_timeout"), collection_formats=collection_formats, )
def read_with_http_info(self, object_type, **kwargs): # noqa: E501 """Read a batch of properties # noqa: E501 Read a provided list of properties. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.read_with_http_info(object_type, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str object_type: (required) :param BatchReadInputPropertyName batch_read_input_property_name: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(BatchResponseProperty, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ["object_type", "batch_read_input_property_name"] # noqa: E501 all_params.append("async_req") all_params.append("_return_http_data_only") all_params.append("_preload_content") all_params.append("_request_timeout") for key, val in six.iteritems(local_var_params["kwargs"]): if key not in all_params: raise ApiTypeError("Got an unexpected keyword argument '%s'" " to method read" % key) local_var_params[key] = val del local_var_params["kwargs"] # verify the required parameter 'object_type' is set if self.api_client.client_side_validation and ( "object_type" not in local_var_params or local_var_params["object_type"] is None # noqa: E501 ): # noqa: E501 raise ApiValueError( "Missing the required parameter `object_type` when calling `read`" ) # noqa: E501 collection_formats = {} path_params = {} if "object_type" in local_var_params: path_params["objectType"] = local_var_params[ "object_type"] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if "batch_read_input_property_name" in local_var_params: body_params = local_var_params["batch_read_input_property_name"] # HTTP header `Accept` header_params["Accept"] = self.api_client.select_header_accept( ["application/json", "*/*"]) # noqa: E501 # HTTP header `Content-Type` header_params[ "Content-Type"] = self.api_client.select_header_content_type( # noqa: E501 ["application/json"]) # noqa: E501 # Authentication setting auth_settings = ["hapikey", "oauth2"] # noqa: E501 return self.api_client.call_api( "/crm/v3/properties/{objectType}/batch/read", "POST", path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type="BatchResponseProperty", # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get("async_req"), _return_http_data_only=local_var_params.get( "_return_http_data_only"), # noqa: E501 _preload_content=local_var_params.get("_preload_content", True), _request_timeout=local_var_params.get("_request_timeout"), collection_formats=collection_formats, )
def request(self, method, url, query_params=None, headers=None, post_params=None, body=None, _preload_content=True, _request_timeout=None): """Makes the HTTP request using RESTClient.""" if method == "GET": return self.rest_client.GET(url, query_params=query_params, _preload_content=_preload_content, _request_timeout=_request_timeout, headers=headers) elif method == "HEAD": return self.rest_client.HEAD(url, query_params=query_params, _preload_content=_preload_content, _request_timeout=_request_timeout, headers=headers) elif method == "OPTIONS": return self.rest_client.OPTIONS(url, query_params=query_params, headers=headers, _preload_content=_preload_content, _request_timeout=_request_timeout) elif method == "POST": return self.rest_client.POST(url, query_params=query_params, headers=headers, post_params=post_params, _preload_content=_preload_content, _request_timeout=_request_timeout, body=body) elif method == "PUT": return self.rest_client.PUT(url, query_params=query_params, headers=headers, post_params=post_params, _preload_content=_preload_content, _request_timeout=_request_timeout, body=body) elif method == "PATCH": return self.rest_client.PATCH(url, query_params=query_params, headers=headers, post_params=post_params, _preload_content=_preload_content, _request_timeout=_request_timeout, body=body) elif method == "DELETE": return self.rest_client.DELETE(url, query_params=query_params, headers=headers, _preload_content=_preload_content, _request_timeout=_request_timeout, body=body) else: raise ApiValueError("http method must be `GET`, `HEAD`, `OPTIONS`," " `POST`, `PATCH`, `PUT` or `DELETE`.")
def get_all_with_http_info(self, object_type, **kwargs): # noqa: E501 """Read all properties # noqa: E501 Read all existing properties for the specified object type and HubSpot account. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_all_with_http_info(object_type, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str object_type: (required) :param bool archived: Whether to return only results that have been archived. :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(CollectionResponseProperty, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ["object_type", "archived"] all_params.extend( [ "async_req", "_return_http_data_only", "_preload_content", "_request_timeout", ] ) for key, val in six.iteritems(local_var_params["kwargs"]): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_all" % key ) local_var_params[key] = val del local_var_params["kwargs"] # verify the required parameter 'object_type' is set if self.api_client.client_side_validation and ( "object_type" not in local_var_params or local_var_params["object_type"] is None # noqa: E501 ): # noqa: E501 raise ApiValueError( "Missing the required parameter `object_type` when calling `get_all`" ) # noqa: E501 collection_formats = {} path_params = {} if "object_type" in local_var_params: path_params["objectType"] = local_var_params["object_type"] # noqa: E501 query_params = [] if ( "archived" in local_var_params and local_var_params["archived"] is not None ): # noqa: E501 query_params.append( ("archived", local_var_params["archived"]) ) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params["Accept"] = self.api_client.select_header_accept( ["application/json", "*/*"] ) # noqa: E501 # Authentication setting auth_settings = ["hapikey", "oauth2"] # noqa: E501 return self.api_client.call_api( "/crm/v3/properties/{objectType}", "GET", path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type="CollectionResponseProperty", # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get("async_req"), _return_http_data_only=local_var_params.get( "_return_http_data_only" ), # noqa: E501 _preload_content=local_var_params.get("_preload_content", True), _request_timeout=local_var_params.get("_request_timeout"), collection_formats=collection_formats, )
def request(self, method, url, query_params=None, headers=None, body=None, post_params=None, _preload_content=True, _request_timeout=None): """Perform requests. :param method: http request method :param url: http request url :param query_params: query parameters in the url :param headers: http request headers :param body: request json body, for `application/json` :param post_params: request post parameters, `application/x-www-form-urlencoded` and `multipart/form-data` :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. """ method = method.upper() assert method in [ 'GET', 'HEAD', 'DELETE', 'POST', 'PUT', 'PATCH', 'OPTIONS' ] if post_params and body: raise ApiValueError( "body parameter cannot be used with post_params parameter.") post_params = post_params or {} headers = headers or {} timeout = None if _request_timeout: if isinstance(_request_timeout, (int, ) if six.PY3 else (int, long)): # noqa: E501,F821 timeout = urllib3.Timeout(total=_request_timeout) elif (isinstance(_request_timeout, tuple) and len(_request_timeout) == 2): timeout = urllib3.Timeout(connect=_request_timeout[0], read=_request_timeout[1]) if 'Content-Type' not in headers: headers['Content-Type'] = 'application/json' try: # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE` if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']: if query_params: url += '?' + urlencode(query_params) if re.search('json', headers['Content-Type'], re.IGNORECASE): request_body = None if body is not None: request_body = json.dumps(body) r = self.pool_manager.request( method, url, body=request_body, preload_content=_preload_content, timeout=timeout, headers=headers) elif headers[ 'Content-Type'] == 'application/x-www-form-urlencoded': # noqa: E501 r = self.pool_manager.request( method, url, fields=post_params, encode_multipart=False, preload_content=_preload_content, timeout=timeout, headers=headers) elif headers['Content-Type'] == 'multipart/form-data': # must del headers['Content-Type'], or the correct # Content-Type which generated by urllib3 will be # overwritten. del headers['Content-Type'] r = self.pool_manager.request( method, url, fields=post_params, encode_multipart=True, preload_content=_preload_content, timeout=timeout, headers=headers) # Pass a `string` parameter directly in the body to support # other content types than Json when `body` argument is # provided in serialized form elif isinstance(body, str) or isinstance(body, bytes): request_body = body r = self.pool_manager.request( method, url, body=request_body, preload_content=_preload_content, timeout=timeout, headers=headers) else: # Cannot generate the request from given parameters msg = """Cannot prepare a request message for provided arguments. Please check that your arguments match declared content type.""" raise ApiException(status=0, reason=msg) # For `GET`, `HEAD` else: r = self.pool_manager.request(method, url, fields=query_params, preload_content=_preload_content, timeout=timeout, headers=headers) except urllib3.exceptions.SSLError as e: msg = "{0}\n{1}".format(type(e).__name__, str(e)) raise ApiException(status=0, reason=msg) if _preload_content: r = RESTResponse(r) # In the python 3, the response.data is bytes. # we need to decode it to string. if six.PY3: r.data = r.data.decode('utf8') # log response body logger.debug("response body: %s", r.data) if not 200 <= r.status <= 299: raise ApiException(http_resp=r) return r
def archive_batch_with_http_info(self, object_type, **kwargs): # noqa: E501 """Archive a batch of properties # noqa: E501 Archive a provided list of properties. This method will return a 204 No Content response on success regardless of the initial state of the property (e.g. active, already archived, non-existent). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.archive_batch_with_http_info(object_type, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str object_type: (required) :param BatchInputPropertyName batch_input_property_name: :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['object_type', 'batch_input_property_name'] # noqa: E501 all_params.append('async_req') all_params.append('_return_http_data_only') all_params.append('_preload_content') all_params.append('_request_timeout') for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError("Got an unexpected keyword argument '%s'" " to method archive_batch" % key) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'object_type' is set if self.api_client.client_side_validation and ( 'object_type' not in local_var_params or # noqa: E501 local_var_params['object_type'] is None): # noqa: E501 raise ApiValueError( "Missing the required parameter `object_type` when calling `archive_batch`" ) # noqa: E501 collection_formats = {} path_params = {} if 'object_type' in local_var_params: path_params['objectType'] = local_var_params[ 'object_type'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'batch_input_property_name' in local_var_params: body_params = local_var_params['batch_input_property_name'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params[ 'Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['hapikey', 'oauth2'] # noqa: E501 return self.api_client.call_api( '/crm/v3/properties/{objectType}/batch/archive', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get( '_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)