def update_with_http_info(self, object_type, pipeline_id, stage_id,
**kwargs): # noqa: E501
"""Update a pipeline stage # noqa: E501
Perform a partial update of the pipeline stage identified by `{stageId}` associated with the pipeline identified by `{pipelineId}`. Any properties not included in this update will keep their existing values. The updated stage will be returned in the response. # 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(object_type, pipeline_id, stage_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str object_type: (required)
:param str pipeline_id: (required)
:param str stage_id: (required)
:param bool archived: Whether to return only results that have been archived.
:param PipelineStagePatchInput pipeline_stage_patch_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(PipelineStage, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
"object_type",
"pipeline_id",
"stage_id",
"archived",
"pipeline_stage_patch_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 'object_type' is set
if self.api_client.client_side_validation and (
"object_type" not in local_var_params
or local_var_params["object_type"] is None # noqa: E501
): # noqa: E501
raise ApiValueError(
"Missing the required parameter `object_type` when calling `update`"
) # noqa: E501
# verify the required parameter 'pipeline_id' is set
if self.api_client.client_side_validation and (
"pipeline_id" not in local_var_params
or local_var_params["pipeline_id"] is None # noqa: E501
): # noqa: E501
raise ApiValueError(
"Missing the required parameter `pipeline_id` when calling `update`"
) # noqa: E501
# verify the required parameter 'stage_id' is set
if self.api_client.client_side_validation and (
"stage_id" not in local_var_params
or local_var_params["stage_id"] is None # noqa: E501
): # noqa: E501
raise ApiValueError(
"Missing the required parameter `stage_id` when calling `update`"
) # noqa: E501
collection_formats = {}
path_params = {}
if "object_type" in local_var_params:
path_params["objectType"] = local_var_params[
"object_type"] # noqa: E501
if "pipeline_id" in local_var_params:
path_params["pipelineId"] = local_var_params[
"pipeline_id"] # noqa: E501
if "stage_id" in local_var_params:
path_params["stageId"] = local_var_params["stage_id"] # noqa: E501
query_params = []
if ("archived" in local_var_params
and local_var_params["archived"] is not None): # noqa: E501
query_params.append(
("archived", local_var_params["archived"])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if "pipeline_stage_patch_input" in local_var_params:
body_params = local_var_params["pipeline_stage_patch_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/pipelines/{objectType}/{pipelineId}/stages/{stageId}",
"PATCH",
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type="PipelineStage", # noqa: E501
auth_settings=auth_settings,
async_req=local_var_params.get("async_req"),
_return_http_data_only=local_var_params.get(
"_return_http_data_only"), # noqa: E501
_preload_content=local_var_params.get("_preload_content", True),
_request_timeout=local_var_params.get("_request_timeout"),
collection_formats=collection_formats,
)
def archive_with_http_info(self, object_type, pipeline_id, stage_id,
**kwargs): # noqa: E501
"""Archive a pipeline stage # noqa: E501
Archive the pipeline stage identified by `{stageId}` associated with the pipeline identified by `{pipelineId}`. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.archive_with_http_info(object_type, pipeline_id, stage_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str object_type: (required)
:param str pipeline_id: (required)
:param str stage_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 = ["object_type", "pipeline_id", "stage_id"]
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 archive" % key)
local_var_params[key] = val
del local_var_params["kwargs"]
# verify the required parameter 'object_type' is set
if self.api_client.client_side_validation and (
"object_type" not in local_var_params
or local_var_params["object_type"] is None # noqa: E501
): # noqa: E501
raise ApiValueError(
"Missing the required parameter `object_type` when calling `archive`"
) # noqa: E501
# verify the required parameter 'pipeline_id' is set
if self.api_client.client_side_validation and (
"pipeline_id" not in local_var_params
or local_var_params["pipeline_id"] is None # noqa: E501
): # noqa: E501
raise ApiValueError(
"Missing the required parameter `pipeline_id` when calling `archive`"
) # noqa: E501
# verify the required parameter 'stage_id' is set
if self.api_client.client_side_validation and (
"stage_id" not in local_var_params
or local_var_params["stage_id"] is None # noqa: E501
): # noqa: E501
raise ApiValueError(
"Missing the required parameter `stage_id` when calling `archive`"
) # noqa: E501
collection_formats = {}
path_params = {}
if "object_type" in local_var_params:
path_params["objectType"] = local_var_params[
"object_type"] # noqa: E501
if "pipeline_id" in local_var_params:
path_params["pipelineId"] = local_var_params[
"pipeline_id"] # noqa: E501
if "stage_id" in local_var_params:
path_params["stageId"] = local_var_params["stage_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/pipelines/{objectType}/{pipelineId}/stages/{stageId}",
"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 get_audit_with_http_info(self, object_type, pipeline_id, **kwargs): # noqa: E501
"""Return an audit of all changes to the pipeline # noqa: E501
Return a reverse chronological list of all mutations that have occurred on the pipeline identified by `{pipelineId}`. # 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_audit_with_http_info(object_type, pipeline_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str object_type: (required)
:param str pipeline_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: tuple(CollectionResponsePublicAuditInfoNoPaging, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ["object_type", "pipeline_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 get_audit" % key)
local_var_params[key] = val
del local_var_params["kwargs"]
# verify the required parameter 'object_type' is set
if self.api_client.client_side_validation and ("object_type" not in local_var_params or local_var_params["object_type"] is None): # noqa: E501 # noqa: E501
raise ApiValueError("Missing the required parameter `object_type` when calling `get_audit`") # noqa: E501
# verify the required parameter 'pipeline_id' is set
if self.api_client.client_side_validation and ("pipeline_id" not in local_var_params or local_var_params["pipeline_id"] is None): # noqa: E501 # noqa: E501
raise ApiValueError("Missing the required parameter `pipeline_id` when calling `get_audit`") # noqa: E501
collection_formats = {}
path_params = {}
if "object_type" in local_var_params:
path_params["objectType"] = local_var_params["object_type"] # noqa: E501
if "pipeline_id" in local_var_params:
path_params["pipelineId"] = local_var_params["pipeline_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(["application/json", "*/*"]) # noqa: E501
# Authentication setting
auth_settings = ["hapikey", "oauth2"] # noqa: E501
return self.api_client.call_api(
"/crm/v3/pipelines/{objectType}/{pipelineId}/audit",
"GET",
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type="CollectionResponsePublicAuditInfoNoPaging", # 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, object_type, pipeline_id,
**kwargs): # noqa: E501
"""Update a pipeline # noqa: E501
Perform a partial update of the pipeline identified by `{pipelineId}`. The updated pipeline will be returned in the response. # 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(object_type, pipeline_id, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str object_type: (required)
:param str pipeline_id: (required)
:param bool archived: Whether to return only results that have been archived.
:param PipelinePatchInput pipeline_patch_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(Pipeline, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = [
'object_type', 'pipeline_id', 'archived', 'pipeline_patch_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 'object_type' is set
if self.api_client.client_side_validation and (
'object_type' not in local_var_params or # noqa: E501
local_var_params['object_type'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `object_type` when calling `update`"
) # noqa: E501
# verify the required parameter 'pipeline_id' is set
if self.api_client.client_side_validation and (
'pipeline_id' not in local_var_params or # noqa: E501
local_var_params['pipeline_id'] is None): # noqa: E501
raise ApiValueError(
"Missing the required parameter `pipeline_id` when calling `update`"
) # noqa: E501
collection_formats = {}
path_params = {}
if 'object_type' in local_var_params:
path_params['objectType'] = local_var_params[
'object_type'] # noqa: E501
if 'pipeline_id' in local_var_params:
path_params['pipelineId'] = local_var_params[
'pipeline_id'] # noqa: E501
query_params = []
if 'archived' in local_var_params and local_var_params[
'archived'] is not None: # noqa: E501
query_params.append(
('archived', local_var_params['archived'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'pipeline_patch_input' in local_var_params:
body_params = local_var_params['pipeline_patch_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/pipelines/{objectType}/{pipelineId}',
'PATCH',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='Pipeline', # 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, object_type, **kwargs): # noqa: E501
"""Create a pipeline # noqa: E501
Create a new pipeline with the provided property values. The entire pipeline object, including its unique ID, will be returned in the response. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_with_http_info(object_type, async_req=True)
>>> result = thread.get()
:param async_req bool: execute request asynchronously
:param str object_type: (required)
:param PipelineInput pipeline_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(Pipeline, status_code(int), headers(HTTPHeaderDict))
If the method is called asynchronously,
returns the request thread.
"""
local_var_params = locals()
all_params = ["object_type", "pipeline_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 'object_type' is set
if self.api_client.client_side_validation and (
"object_type" not in local_var_params
or local_var_params["object_type"] is None # noqa: E501
): # noqa: E501
raise ApiValueError(
"Missing the required parameter `object_type` when calling `create`"
) # noqa: E501
collection_formats = {}
path_params = {}
if "object_type" in local_var_params:
path_params["objectType"] = local_var_params[
"object_type"] # noqa: E501
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if "pipeline_input" in local_var_params:
body_params = local_var_params["pipeline_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/pipelines/{objectType}",
"POST",
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type="Pipeline", # 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,
)