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 update_params_for_auth(self, headers, querys, auth_settings):
"""Updates header and query params based on authentication setting.
:param headers: Header parameters dict to be updated.
:param querys: Query parameters tuple list to be updated.
:param auth_settings: Authentication setting identifiers list.
"""
if not auth_settings:
return
for auth in auth_settings:
auth_setting = self.configuration.auth_settings().get(auth)
if auth_setting:
if auth_setting['in'] == 'cookie':
headers['Cookie'] = auth_setting['value']
elif auth_setting['in'] == 'header':
headers[auth_setting['key']] = auth_setting['value']
elif auth_setting['in'] == 'query':
querys.append((auth_setting['key'], auth_setting['value']))
else:
raise ApiValueError(
'Authentication token must be in `query` or `header`')
def update_params_for_auth(self, headers, querys, auth_settings):
"""Updates header and query params based on authentication setting.
:param headers: Header parameters dict to be updated.
:param querys: Query parameters tuple list to be updated.
:param auth_settings: Authentication setting identifiers list.
"""
if not auth_settings:
return
for auth in auth_settings:
auth_setting = self.configuration.auth_settings().get(auth)
if auth_setting:
if auth_setting["in"] == "cookie":
headers["Cookie"] = auth_setting["value"]
elif auth_setting["in"] == "header":
headers[auth_setting["key"]] = auth_setting["value"]
elif auth_setting["in"] == "query":
querys.append((auth_setting["key"], auth_setting["value"]))
else:
raise ApiValueError(
"Authentication token must be in `query` or `header`")
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)
# 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_with_http_info(self, line_item_id, to_object_type,
to_object_id, association_type,
**kwargs): # noqa: E501
"""Remove an association between two line items # 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(line_item_id, to_object_type, to_object_id, association_type, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str line_item_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 = [
"line_item_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 'line_item_id' is set
if self.api_client.client_side_validation and (
"line_item_id" not in local_var_params
or local_var_params["line_item_id"] is None # noqa: E501
): # noqa: E501
raise ApiValueError(
"Missing the required parameter `line_item_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 local_var_params["to_object_type"] is None # noqa: E501
): # 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 local_var_params["to_object_id"] is None # noqa: E501
): # 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 local_var_params["association_type"] is None # noqa: E501
): # noqa: E501
raise ApiValueError(
"Missing the required parameter `association_type` when calling `archive`"
) # noqa: E501
collection_formats = {}
path_params = {}
if "line_item_id" in local_var_params:
path_params["lineItemId"] = local_var_params[
"line_item_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/line_items/{lineItemId}/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 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", "oauth2"] # noqa: E501
return self.api_client.call_api(
"/crm/v3/objects/line_items/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, line_item_id, **kwargs): # noqa: E501
"""Archive # noqa: E501
Move an Object identified by `{lineItemId}` 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(line_item_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str line_item_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 = ['line_item_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 'line_item_id' is set
if self.api_client.client_side_validation and (
'line_item_id' not in local_var_params or # noqa: E501
local_var_params['line_item_id'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `line_item_id` when calling `archive`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'line_item_id' in local_var_params:
path_params['lineItemId'] = local_var_params[
'line_item_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/line_items/{lineItemId}',
'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 update_with_http_info(self, line_item_id, **kwargs): # noqa: E501
"""Update # noqa: E501
Perform a partial update of an Object identified by `{lineItemId}`. 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(line_item_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str line_item_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 = ['line_item_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 'line_item_id' is set
if self.api_client.client_side_validation and (
'line_item_id' not in local_var_params or # noqa: E501
local_var_params['line_item_id'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `line_item_id` when calling `update`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'line_item_id' in local_var_params:
path_params['lineItemId'] = local_var_params[
'line_item_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/line_items/{lineItemId}',
'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 get_by_id_with_http_info(self, line_item_id, **kwargs): # noqa: E501
"""Read # noqa: E501
Read an Object identified by `{lineItemId}`. `{lineItemId}` 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(line_item_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str line_item_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 = [
'line_item_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 'line_item_id' is set
if self.api_client.client_side_validation and (
'line_item_id' not in local_var_params or # noqa: E501
local_var_params['line_item_id'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `line_item_id` when calling `get_by_id`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'line_item_id' in local_var_params:
path_params['lineItemId'] = local_var_params[
'line_item_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', 'oauth2'] # noqa: E501
return self.api_client.call_api(
'/crm/v3/objects/line_items/{lineItemId}',
'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, line_item_id, to_object_type,
**kwargs): # noqa: E501
"""List associations of a line item 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(line_item_id, to_object_type, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str line_item_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 = ['line_item_id', 'to_object_type', 'after', 'limit']
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 'line_item_id' is set
if self.api_client.client_side_validation and (
'line_item_id' not in local_var_params or # noqa: E501
local_var_params['line_item_id'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `line_item_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 # noqa: E501
local_var_params['to_object_type'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `to_object_type` when calling `get_all`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'line_item_id' in local_var_params:
path_params['lineItemId'] = local_var_params[
'line_item_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/line_items/{lineItemId}/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 create_with_http_info(self, line_item_id, to_object_type, to_object_id,
association_type, **kwargs): # noqa: E501
"""Associate a line item 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(line_item_id, to_object_type, to_object_id, association_type, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str line_item_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 = [
'line_item_id', 'to_object_type', 'to_object_id',
'association_type'
]
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 create" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# verify the required parameter 'line_item_id' is set
if self.api_client.client_side_validation and (
'line_item_id' not in local_var_params or # noqa: E501
local_var_params['line_item_id'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `line_item_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 # noqa: E501
local_var_params['to_object_type'] is None): # 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 # noqa: E501
local_var_params['to_object_id'] is None): # 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 # noqa: E501
local_var_params['association_type'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `association_type` when calling `create`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'line_item_id' in local_var_params:
path_params['lineItemId'] = local_var_params[
'line_item_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/line_items/{lineItemId}/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, line_item_id, simple_public_object_input,
**kwargs): # noqa: E501
"""Update # noqa: E501
Perform a partial update of an Object identified by `{lineItemId}`. `{lineItemId}` 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(line_item_id, simple_public_object_input, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str line_item_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 = [
"line_item_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 'line_item_id' is set
if self.api_client.client_side_validation and (
"line_item_id" not in local_var_params
or local_var_params["line_item_id"] is None
): # noqa: E501 # noqa: E501
raise ApiValueError(
"Missing the required parameter `line_item_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 "line_item_id" in local_var_params:
path_params["lineItemId"] = local_var_params[
"line_item_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/line_items/{lineItemId}",
"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 archive_with_http_info(self, batch_input_simple_public_object_id,
**kwargs): # noqa: E501
"""Archive a batch of line items by ID # noqa: E501
Archive a list of line items 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(batch_input_simple_public_object_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param BatchInputSimplePublicObjectId batch_input_simple_public_object_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 = ["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"]
# verify the required parameter 'batch_input_simple_public_object_id' is set
if self.api_client.client_side_validation and (
"batch_input_simple_public_object_id" not in local_var_params
or local_var_params[
"batch_input_simple_public_object_id"] # noqa: E501
is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `batch_input_simple_public_object_id` when calling `archive`"
) # noqa: E501
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/line_items/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 read_with_http_info(self, batch_read_input_simple_public_object_id,
**kwargs): # noqa: E501
"""Read a batch of line items by internal ID, or unique property values # noqa: E501
Read a list of line items 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",
] # 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 '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", "oauth2"] # noqa: E501
return self.api_client.call_api(
"/crm/v3/objects/line_items/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 update_with_http_info(
self, batch_input_simple_public_object_batch_input, **kwargs
): # noqa: E501
"""Update a batch of line items # noqa: E501
Perform a partial upate on a batch of line items. This follows the same rules as performing partial updates on an individual 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.update_with_http_info(batch_input_simple_public_object_batch_input, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param BatchInputSimplePublicObjectBatchInput batch_input_simple_public_object_batch_input: (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(BatchResponseSimplePublicObject, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ["batch_input_simple_public_object_batch_input"]
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 update" % key
)
local_var_params[key] = val
del local_var_params["kwargs"]
# verify the required parameter 'batch_input_simple_public_object_batch_input' is set
if self.api_client.client_side_validation and (
"batch_input_simple_public_object_batch_input" not in local_var_params
or local_var_params[ # noqa: E501
"batch_input_simple_public_object_batch_input"
]
is None
): # noqa: E501
raise ApiValueError(
"Missing the required parameter `batch_input_simple_public_object_batch_input` when calling `update`"
) # noqa: E501
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if "batch_input_simple_public_object_batch_input" in local_var_params:
body_params = local_var_params[
"batch_input_simple_public_object_batch_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/line_items/batch/update",
"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, simple_public_object_input,
**kwargs): # noqa: E501
"""Create # noqa: E501
Create a line item with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard line items 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(simple_public_object_input, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param SimplePublicObjectInput simple_public_object_input: (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(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']
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 create" % key)
local_var_params[key] = val
del local_var_params['kwargs']
# 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 # noqa: E501
local_var_params['simple_public_object_input'] is None
): # noqa: E501
raise ApiValueError(
"Missing the required parameter `simple_public_object_input` when calling `create`"
) # noqa: E501
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/line_items',
'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)
