def get_page_with_http_info(self, **kwargs): # noqa: E501 """List # noqa: E501 Read a page of quotes. Control what is returned via the `properties` query param. # 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_page_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int limit: The maximum number of results to display per page. :param str after: The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results. :param list[str] properties: A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. :param list[str] associations: A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. :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(CollectionResponseSimplePublicObject, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ "limit", "after", "properties", "associations", "archived", ] # 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 get_page" % key) local_var_params[key] = val del local_var_params["kwargs"] collection_formats = {} path_params = {} query_params = [] if ("limit" in local_var_params and local_var_params["limit"] is not None): # noqa: E501 query_params.append( ("limit", local_var_params["limit"])) # noqa: E501 if ("after" in local_var_params and local_var_params["after"] is not None): # noqa: E501 query_params.append( ("after", local_var_params["after"])) # noqa: E501 if ("properties" in local_var_params and local_var_params["properties"] is not None): # noqa: E501 query_params.append( ("properties", local_var_params["properties"])) # noqa: E501 collection_formats["properties"] = "multi" # noqa: E501 if ("associations" in local_var_params and local_var_params["associations"] is not None): # noqa: E501 query_params.append( ("associations", local_var_params["associations"])) # noqa: E501 collection_formats["associations"] = "multi" # noqa: E501 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"] # noqa: E501 return self.api_client.call_api( "/crm/v3/objects/quotes", "GET", path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type="CollectionResponseSimplePublicObject", # 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_id_with_http_info(self, quote_id, **kwargs): # noqa: E501 """Read # noqa: E501 Read an Object identified by `{quoteId}`. `{quoteId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param. # 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_id_with_http_info(quote_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str quote_id: (required) :param list[str] properties: A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. :param list[str] associations: A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. :param bool archived: Whether to return only results that have been archived. :param str id_property: The name of a property whose values are unique for this object type :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(SimplePublicObject, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ "quote_id", "properties", "associations", "archived", "id_property", ] # 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 get_by_id" % key) local_var_params[key] = val del local_var_params["kwargs"] # verify the required parameter 'quote_id' is set if self.api_client.client_side_validation and ( "quote_id" not in local_var_params or local_var_params["quote_id"] is None # noqa: E501 ): # noqa: E501 raise ApiValueError( "Missing the required parameter `quote_id` when calling `get_by_id`" ) # noqa: E501 collection_formats = {} path_params = {} if "quote_id" in local_var_params: path_params["quoteId"] = local_var_params["quote_id"] # noqa: E501 query_params = [] if ("properties" in local_var_params and local_var_params["properties"] is not None): # noqa: E501 query_params.append( ("properties", local_var_params["properties"])) # noqa: E501 collection_formats["properties"] = "multi" # noqa: E501 if ("associations" in local_var_params and local_var_params["associations"] is not None): # noqa: E501 query_params.append( ("associations", local_var_params["associations"])) # noqa: E501 collection_formats["associations"] = "multi" # noqa: E501 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 if ("id_property" in local_var_params and local_var_params["id_property"] is not None): # noqa: E501 query_params.append( ("idProperty", local_var_params["id_property"])) # 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"] # noqa: E501 return self.api_client.call_api( "/crm/v3/objects/quotes/{quoteId}", "GET", path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type="SimplePublicObject", # 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_all_with_http_info(self, quote_id, to_object_type, **kwargs): # noqa: E501 """List associations of a quote by type # 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(quote_id, to_object_type, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str quote_id: (required) :param str to_object_type: (required) :param str after: The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results. :param int limit: The maximum number of results to display per page. :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(CollectionResponseAssociatedIdForwardPaging, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ["quote_id", "to_object_type", "after", "limit"] # 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 get_all" % key) local_var_params[key] = val del local_var_params["kwargs"] # verify the required parameter 'quote_id' is set if self.api_client.client_side_validation and ( "quote_id" not in local_var_params or local_var_params["quote_id"] is None ): # noqa: E501 # noqa: E501 raise ApiValueError( "Missing the required parameter `quote_id` when calling `get_all`" ) # noqa: E501 # verify the required parameter 'to_object_type' is set if self.api_client.client_side_validation and ( "to_object_type" not in local_var_params or local_var_params["to_object_type"] is None ): # noqa: E501 # noqa: E501 raise ApiValueError( "Missing the required parameter `to_object_type` when calling `get_all`" ) # noqa: E501 collection_formats = {} path_params = {} if "quote_id" in local_var_params: path_params["quoteId"] = local_var_params["quote_id"] # noqa: E501 if "to_object_type" in local_var_params: path_params["toObjectType"] = local_var_params[ "to_object_type"] # noqa: E501 query_params = [] if "after" in local_var_params and local_var_params[ "after"] is not None: # noqa: E501 query_params.append( ("after", local_var_params["after"])) # noqa: E501 if "limit" in local_var_params and local_var_params[ "limit"] is not None: # noqa: E501 query_params.append( ("limit", local_var_params["limit"])) # 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/objects/quotes/{quoteId}/associations/{toObjectType}", "GET", path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type= "CollectionResponseAssociatedIdForwardPaging", # 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, quote_id, to_object_type, to_object_id, association_type, **kwargs): # noqa: E501 """Remove an association between two quotes # 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(quote_id, to_object_type, to_object_id, association_type, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str quote_id: (required) :param str to_object_type: (required) :param str to_object_id: (required) :param str association_type: (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 = [ 'quote_id', 'to_object_type', 'to_object_id', 'association_type' ] # 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 'quote_id' is set if self.api_client.client_side_validation and ( 'quote_id' not in local_var_params or # noqa: E501 local_var_params['quote_id'] is None): # noqa: E501 raise ApiValueError( "Missing the required parameter `quote_id` when calling `archive`" ) # noqa: E501 # verify the required parameter 'to_object_type' is set if self.api_client.client_side_validation and ( 'to_object_type' not in local_var_params or # noqa: E501 local_var_params['to_object_type'] is None): # noqa: E501 raise ApiValueError( "Missing the required parameter `to_object_type` when calling `archive`" ) # noqa: E501 # verify the required parameter 'to_object_id' is set if self.api_client.client_side_validation and ( 'to_object_id' not in local_var_params or # noqa: E501 local_var_params['to_object_id'] is None): # noqa: E501 raise ApiValueError( "Missing the required parameter `to_object_id` when calling `archive`" ) # noqa: E501 # verify the required parameter 'association_type' is set if self.api_client.client_side_validation and ( 'association_type' not in local_var_params or # noqa: E501 local_var_params['association_type'] is None): # noqa: E501 raise ApiValueError( "Missing the required parameter `association_type` when calling `archive`" ) # noqa: E501 collection_formats = {} path_params = {} if 'quote_id' in local_var_params: path_params['quoteId'] = local_var_params['quote_id'] # noqa: E501 if 'to_object_type' in local_var_params: path_params['toObjectType'] = local_var_params[ 'to_object_type'] # noqa: E501 if 'to_object_id' in local_var_params: path_params['toObjectId'] = local_var_params[ 'to_object_id'] # noqa: E501 if 'association_type' in local_var_params: path_params['associationType'] = local_var_params[ 'association_type'] # 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/objects/quotes/{quoteId}/associations/{toObjectType}/{toObjectId}/{associationType}', '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, batch_read_input_simple_public_object_id, **kwargs ): # noqa: E501 """Read a batch of quotes by internal ID, or unique property values # noqa: E501 Read a list of quotes given a collection of IDs. Use the `properties` request body property to control which properties are returned. # 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(batch_read_input_simple_public_object_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param BatchReadInputSimplePublicObjectId batch_read_input_simple_public_object_id: (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(BatchResponseSimplePublicObject, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ["batch_read_input_simple_public_object_id", "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 read" % key ) local_var_params[key] = val del local_var_params["kwargs"] # verify the required parameter 'batch_read_input_simple_public_object_id' is set if self.api_client.client_side_validation and ( "batch_read_input_simple_public_object_id" not in local_var_params or local_var_params[ # noqa: E501 "batch_read_input_simple_public_object_id" ] is None ): # noqa: E501 raise ApiValueError( "Missing the required parameter `batch_read_input_simple_public_object_id` when calling `read`" ) # noqa: E501 collection_formats = {} path_params = {} 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 if "batch_read_input_simple_public_object_id" in local_var_params: body_params = local_var_params["batch_read_input_simple_public_object_id"] # 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"] # noqa: E501 return self.api_client.call_api( "/crm/v3/objects/quotes/batch/read", "POST", path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type="BatchResponseSimplePublicObject", # 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 create_with_http_info(self, quote_id, to_object_type, to_object_id, association_type, **kwargs): # noqa: E501 """Associate a quote with another object # 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(quote_id, to_object_type, to_object_id, association_type, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str quote_id: (required) :param str to_object_type: (required) :param str to_object_id: (required) :param str association_type: (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: tuple(SimplePublicObjectWithAssociations, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ "quote_id", "to_object_type", "to_object_id", "association_type" ] # 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 'quote_id' is set if self.api_client.client_side_validation and ( "quote_id" not in local_var_params or local_var_params["quote_id"] is None ): # noqa: E501 # noqa: E501 raise ApiValueError( "Missing the required parameter `quote_id` when calling `create`" ) # noqa: E501 # verify the required parameter 'to_object_type' is set if self.api_client.client_side_validation and ( "to_object_type" not in local_var_params or local_var_params["to_object_type"] is None ): # noqa: E501 # noqa: E501 raise ApiValueError( "Missing the required parameter `to_object_type` when calling `create`" ) # noqa: E501 # verify the required parameter 'to_object_id' is set if self.api_client.client_side_validation and ( "to_object_id" not in local_var_params or local_var_params["to_object_id"] is None ): # noqa: E501 # noqa: E501 raise ApiValueError( "Missing the required parameter `to_object_id` when calling `create`" ) # noqa: E501 # verify the required parameter 'association_type' is set if self.api_client.client_side_validation and ( "association_type" not in local_var_params or local_var_params["association_type"] is None ): # noqa: E501 # noqa: E501 raise ApiValueError( "Missing the required parameter `association_type` when calling `create`" ) # noqa: E501 collection_formats = {} path_params = {} if "quote_id" in local_var_params: path_params["quoteId"] = local_var_params["quote_id"] # noqa: E501 if "to_object_type" in local_var_params: path_params["toObjectType"] = local_var_params[ "to_object_type"] # noqa: E501 if "to_object_id" in local_var_params: path_params["toObjectId"] = local_var_params[ "to_object_id"] # noqa: E501 if "association_type" in local_var_params: path_params["associationType"] = local_var_params[ "association_type"] # 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( ["application/json", "*/*"]) # noqa: E501 # Authentication setting auth_settings = ["hapikey", "oauth2"] # noqa: E501 return self.api_client.call_api( "/crm/v3/objects/quotes/{quoteId}/associations/{toObjectType}/{toObjectId}/{associationType}", "PUT", path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type="SimplePublicObjectWithAssociations", # 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 update_with_http_info(self, quote_id, **kwargs): # noqa: E501 """Update # noqa: E501 Perform a partial update of an Object identified by `{quoteId}`. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_with_http_info(quote_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str quote_id: (required) :param SimplePublicObjectInput simple_public_object_input: :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(SimplePublicObject, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['quote_id', 'simple_public_object_input'] # 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 update" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'quote_id' is set if self.api_client.client_side_validation and ('quote_id' not in local_var_params or # noqa: E501 local_var_params['quote_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `quote_id` when calling `update`") # noqa: E501 collection_formats = {} path_params = {} if 'quote_id' in local_var_params: path_params['quoteId'] = local_var_params['quote_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'simple_public_object_input' in local_var_params: body_params = local_var_params['simple_public_object_input'] # 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/objects/quotes/{quoteId}', 'PATCH', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='SimplePublicObject', # 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 do_search_with_http_info(self, **kwargs): # noqa: E501 """Filter, Sort, and Search CRM Objects # noqa: E501 Filter, Sort, and Search CRM Objects # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.do_search_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param PublicObjectSearchRequest public_object_search_request: :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(CollectionResponseWithTotalSimplePublicObject, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['public_object_search_request'] # 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 do_search" % key ) local_var_params[key] = val del local_var_params['kwargs'] collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'public_object_search_request' in local_var_params: body_params = local_var_params['public_object_search_request'] # 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/objects/quotes/search', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='CollectionResponseWithTotalSimplePublicObject', # 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, **kwargs): # noqa: E501 """Read a batch of quotes by internal ID, or unique property values # noqa: E501 Read a list of quotes given a collection of IDs. Use the `properties` request body property to control which properties are returned. # 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(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param bool archived: Whether to return only results that have been archived. :param BatchReadInputSimplePublicObjectId batch_read_input_simple_public_object_id: :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(BatchResponseSimplePublicObject, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['archived', 'batch_read_input_simple_public_object_id'] # 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'] collection_formats = {} path_params = {} 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 if 'batch_read_input_simple_public_object_id' in local_var_params: body_params = local_var_params[ 'batch_read_input_simple_public_object_id'] # 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/objects/quotes/batch/read', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='BatchResponseSimplePublicObject', # 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, **kwargs): # noqa: E501 """Archive a batch of quotes by ID # noqa: E501 Archive a list of quotes given a collection of IDs. This method will return a `204 No Content` response on success regardless of the initial state of the object (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_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param BatchInputSimplePublicObjectId batch_input_simple_public_object_id: :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 = ['batch_input_simple_public_object_id'] # 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'] collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'batch_input_simple_public_object_id' in local_var_params: body_params = local_var_params[ 'batch_input_simple_public_object_id'] # 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/objects/quotes/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)
def do_search_with_http_info( self, public_object_search_request, **kwargs ): # noqa: E501 """Filter, Sort, and Search CRM Objects # noqa: E501 Filter, Sort, and Search CRM Objects # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.do_search_with_http_info(public_object_search_request, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param PublicObjectSearchRequest public_object_search_request: (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: tuple(CollectionResponseWithTotalSimplePublicObject, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ["public_object_search_request"] # 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 do_search" % key ) local_var_params[key] = val del local_var_params["kwargs"] # verify the required parameter 'public_object_search_request' is set if self.api_client.client_side_validation and ( "public_object_search_request" not in local_var_params or local_var_params["public_object_search_request"] is None # noqa: E501 ): # noqa: E501 raise ApiValueError( "Missing the required parameter `public_object_search_request` when calling `do_search`" ) # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if "public_object_search_request" in local_var_params: body_params = local_var_params["public_object_search_request"] # 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"] # noqa: E501 return self.api_client.call_api( "/crm/v3/objects/quotes/search", "POST", path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type="CollectionResponseWithTotalSimplePublicObject", # 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, quote_id, **kwargs): # noqa: E501 """Archive # noqa: E501 Move an Object identified by `{quoteId}` 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(quote_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str quote_id: (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 = ["quote_id"] # 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 'quote_id' is set if self.api_client.client_side_validation and ( "quote_id" not in local_var_params or local_var_params["quote_id"] is None # noqa: E501 ): # noqa: E501 raise ApiValueError( "Missing the required parameter `quote_id` when calling `archive`" ) # noqa: E501 collection_formats = {} path_params = {} if "quote_id" in local_var_params: path_params["quoteId"] = local_var_params["quote_id"] # 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/objects/quotes/{quoteId}", "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 create_with_http_info(self, **kwargs): # noqa: E501 """Create # noqa: E501 Create a quote with the given properties and return a copy of the object, including the ID. Documentation and examples for creating native quotes is provided. # 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(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param SimplePublicObjectInput simple_public_object_input: :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(SimplePublicObject, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ["simple_public_object_input"] # 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"] collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if "simple_public_object_input" in local_var_params: body_params = local_var_params["simple_public_object_input"] # 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/objects/quotes", "POST", path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type="SimplePublicObject", # 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 update_0_with_http_info(self, **kwargs): # noqa: E501 """update_0 # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_0_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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 = [] # 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 update_0" % key) local_var_params[key] = val del local_var_params["kwargs"] collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # Authentication setting auth_settings = [] # noqa: E501 return self.api_client.call_api( "/crm/v3/objects/quotes/batch/update", "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, )
def update_with_http_info(self, quote_id, simple_public_object_input, **kwargs): # noqa: E501 """Update # noqa: E501 Perform a partial update of an Object identified by `{quoteId}`. `{quoteId}` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_with_http_info(quote_id, simple_public_object_input, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str quote_id: (required) :param SimplePublicObjectInput simple_public_object_input: (required) :param str id_property: The name of a property whose values are unique for this object type :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(SimplePublicObject, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ["quote_id", "simple_public_object_input", "id_property"] # 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 update" % key) local_var_params[key] = val del local_var_params["kwargs"] # verify the required parameter 'quote_id' is set if self.api_client.client_side_validation and ( "quote_id" not in local_var_params or local_var_params["quote_id"] is None ): # noqa: E501 # noqa: E501 raise ApiValueError( "Missing the required parameter `quote_id` when calling `update`" ) # noqa: E501 # verify the required parameter 'simple_public_object_input' is set if self.api_client.client_side_validation and ( "simple_public_object_input" not in local_var_params or local_var_params["simple_public_object_input"] is None ): # noqa: E501 # noqa: E501 raise ApiValueError( "Missing the required parameter `simple_public_object_input` when calling `update`" ) # noqa: E501 collection_formats = {} path_params = {} if "quote_id" in local_var_params: path_params["quoteId"] = local_var_params["quote_id"] # noqa: E501 query_params = [] if "id_property" in local_var_params and local_var_params[ "id_property"] is not None: # noqa: E501 query_params.append( ("idProperty", local_var_params["id_property"])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None if "simple_public_object_input" in local_var_params: body_params = local_var_params["simple_public_object_input"] # 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( ["application/json"]) # noqa: E501 # noqa: E501 # Authentication setting auth_settings = ["hapikey", "oauth2"] # noqa: E501 return self.api_client.call_api( "/crm/v3/objects/quotes/{quoteId}", "PATCH", path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type="SimplePublicObject", # 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, )