Module mailslurp_client.api.user_controller_api
MailSlurp API
MailSlurp is an API for sending and receiving emails and SMS from dynamically allocated email addresses and phone numbers. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - Homepage - Get an API KEY - Generated SDK Clients - Examples repository # noqa: E501
The version of the OpenAPI document: 6.5.2 Contact: contact@mailslurp.dev Generated by: https://openapi-generator.tech
Classes
class UserControllerApi (api_client=None)-
NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech
Do not edit the class manually.
Expand source code
class UserControllerApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech Do not edit the class manually. """ def __init__(self, api_client=None): if api_client is None: api_client = ApiClient() self.api_client = api_client def create_inbox_retention_policy(self, create_inbox_retention_policy_options, **kwargs): # noqa: E501 """create_inbox_retention_policy # noqa: E501 Create an inbox retention policy for your account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_inbox_retention_policy(create_inbox_retention_policy_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreateInboxRetentionPolicyOptions create_inbox_retention_policy_options: (required) :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: InboxRetentionPolicyDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_inbox_retention_policy_with_http_info(create_inbox_retention_policy_options, **kwargs) # noqa: E501 def create_inbox_retention_policy_with_http_info(self, create_inbox_retention_policy_options, **kwargs): # noqa: E501 """create_inbox_retention_policy # noqa: E501 Create an inbox retention policy for your account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_inbox_retention_policy_with_http_info(create_inbox_retention_policy_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreateInboxRetentionPolicyOptions create_inbox_retention_policy_options: (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(InboxRetentionPolicyDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'create_inbox_retention_policy_options' ] 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_inbox_retention_policy" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'create_inbox_retention_policy_options' is set if self.api_client.client_side_validation and ('create_inbox_retention_policy_options' not in local_var_params or # noqa: E501 local_var_params['create_inbox_retention_policy_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `create_inbox_retention_policy_options` when calling `create_inbox_retention_policy`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_inbox_retention_policy_options' in local_var_params: body_params = local_var_params['create_inbox_retention_policy_options'] # 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/user/inbox-retention-policies', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxRetentionPolicyDto', # 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_inbox_retention_policy_run(self, **kwargs): # noqa: E501 """create_inbox_retention_policy_run # noqa: E501 Start an asynchronous inbox retention policy run for your account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_inbox_retention_policy_run(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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: InboxRetentionPolicyRunDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_inbox_retention_policy_run_with_http_info(**kwargs) # noqa: E501 def create_inbox_retention_policy_run_with_http_info(self, **kwargs): # noqa: E501 """create_inbox_retention_policy_run # noqa: E501 Start an asynchronous inbox retention policy run for your account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_inbox_retention_policy_run_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: tuple(InboxRetentionPolicyRunDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] 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_inbox_retention_policy_run" % 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 # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/user/inbox-retention-policies/account/run', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxRetentionPolicyRunDto', # 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_or_update_inbox_retention_policy_for_account(self, create_inbox_retention_policy_for_account_options, **kwargs): # noqa: E501 """create_or_update_inbox_retention_policy_for_account # noqa: E501 Create inbox retention policy for your global account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_or_update_inbox_retention_policy_for_account(create_inbox_retention_policy_for_account_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreateInboxRetentionPolicyForAccountOptions create_inbox_retention_policy_for_account_options: (required) :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: InboxRetentionPolicyDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.create_or_update_inbox_retention_policy_for_account_with_http_info(create_inbox_retention_policy_for_account_options, **kwargs) # noqa: E501 def create_or_update_inbox_retention_policy_for_account_with_http_info(self, create_inbox_retention_policy_for_account_options, **kwargs): # noqa: E501 """create_or_update_inbox_retention_policy_for_account # noqa: E501 Create inbox retention policy for your global account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_or_update_inbox_retention_policy_for_account_with_http_info(create_inbox_retention_policy_for_account_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreateInboxRetentionPolicyForAccountOptions create_inbox_retention_policy_for_account_options: (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(InboxRetentionPolicyDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'create_inbox_retention_policy_for_account_options' ] 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_or_update_inbox_retention_policy_for_account" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'create_inbox_retention_policy_for_account_options' is set if self.api_client.client_side_validation and ('create_inbox_retention_policy_for_account_options' not in local_var_params or # noqa: E501 local_var_params['create_inbox_retention_policy_for_account_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `create_inbox_retention_policy_for_account_options` when calling `create_or_update_inbox_retention_policy_for_account`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_inbox_retention_policy_for_account_options' in local_var_params: body_params = local_var_params['create_inbox_retention_policy_for_account_options'] # 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/user/inbox-retention-policies/account', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxRetentionPolicyDto', # 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 delete_inbox_retention_policy(self, policy_id, **kwargs): # noqa: E501 """delete_inbox_retention_policy # noqa: E501 Delete an inbox retention policy for your account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_inbox_retention_policy(policy_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str policy_id: (required) :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: EmptyResponseDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.delete_inbox_retention_policy_with_http_info(policy_id, **kwargs) # noqa: E501 def delete_inbox_retention_policy_with_http_info(self, policy_id, **kwargs): # noqa: E501 """delete_inbox_retention_policy # noqa: E501 Delete an inbox retention policy for your account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_inbox_retention_policy_with_http_info(policy_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str policy_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(EmptyResponseDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'policy_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 delete_inbox_retention_policy" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'policy_id' is set if self.api_client.client_side_validation and ('policy_id' not in local_var_params or # noqa: E501 local_var_params['policy_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `policy_id` when calling `delete_inbox_retention_policy`") # noqa: E501 collection_formats = {} path_params = {} if 'policy_id' in local_var_params: path_params['policyId'] = local_var_params['policy_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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/user/inbox-retention-policies/{policyId}', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='EmptyResponseDto', # 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 delete_inbox_retention_policy_for_account(self, **kwargs): # noqa: E501 """delete_inbox_retention_policy_for_account # noqa: E501 Delete inbox retention policy for your global account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_inbox_retention_policy_for_account(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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: EmptyResponseDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.delete_inbox_retention_policy_for_account_with_http_info(**kwargs) # noqa: E501 def delete_inbox_retention_policy_for_account_with_http_info(self, **kwargs): # noqa: E501 """delete_inbox_retention_policy_for_account # noqa: E501 Delete inbox retention policy for your global account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_inbox_retention_policy_for_account_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: tuple(EmptyResponseDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] 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 delete_inbox_retention_policy_for_account" % 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 # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/user/inbox-retention-policies/account', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='EmptyResponseDto', # 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_entity_automations(self, **kwargs): # noqa: E501 """get_entity_automations # 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_entity_automations(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index :param int size: Optional page size :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param str inbox_id: Optional inbox ID :param str phone_id: Optional phone ID :param str filter: Optional automation type filter :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: PageEntityAutomationItems If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_entity_automations_with_http_info(**kwargs) # noqa: E501 def get_entity_automations_with_http_info(self, **kwargs): # noqa: E501 """get_entity_automations # 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_entity_automations_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index :param int size: Optional page size :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param str inbox_id: Optional inbox ID :param str phone_id: Optional phone ID :param str filter: Optional automation type filter :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(PageEntityAutomationItems, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'page', 'size', 'sort', 'since', 'before', 'inbox_id', 'phone_id', 'filter' ] 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_entity_automations" % key ) local_var_params[key] = val del local_var_params['kwargs'] if self.api_client.client_side_validation and 'size' in local_var_params and local_var_params['size'] > 100: # noqa: E501 raise ApiValueError("Invalid value for parameter `size` when calling `get_entity_automations`, must be a value less than or equal to `100`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501 query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501 if 'phone_id' in local_var_params and local_var_params['phone_id'] is not None: # noqa: E501 query_params.append(('phoneId', local_var_params['phone_id'])) # noqa: E501 if 'filter' in local_var_params and local_var_params['filter'] is not None: # noqa: E501 query_params.append(('filter', local_var_params['filter'])) # noqa: E501 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/user/automations', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageEntityAutomationItems', # 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_entity_events(self, **kwargs): # noqa: E501 """get_entity_events # 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_entity_events(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index :param int size: Optional page size :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param str inbox_id: Optional inbox ID :param str email_id: Optional email ID :param str phone_id: Optional phone ID :param str sms_id: Optional SMS ID :param str attachment_id: Optional attachment ID :param str filter: Optional type filter :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: PageEntityEventItems If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_entity_events_with_http_info(**kwargs) # noqa: E501 def get_entity_events_with_http_info(self, **kwargs): # noqa: E501 """get_entity_events # 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_entity_events_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index :param int size: Optional page size :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param str inbox_id: Optional inbox ID :param str email_id: Optional email ID :param str phone_id: Optional phone ID :param str sms_id: Optional SMS ID :param str attachment_id: Optional attachment ID :param str filter: Optional type filter :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(PageEntityEventItems, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'page', 'size', 'sort', 'since', 'before', 'inbox_id', 'email_id', 'phone_id', 'sms_id', 'attachment_id', 'filter' ] 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_entity_events" % key ) local_var_params[key] = val del local_var_params['kwargs'] if self.api_client.client_side_validation and 'size' in local_var_params and local_var_params['size'] > 100: # noqa: E501 raise ApiValueError("Invalid value for parameter `size` when calling `get_entity_events`, must be a value less than or equal to `100`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 if 'inbox_id' in local_var_params and local_var_params['inbox_id'] is not None: # noqa: E501 query_params.append(('inboxId', local_var_params['inbox_id'])) # noqa: E501 if 'email_id' in local_var_params and local_var_params['email_id'] is not None: # noqa: E501 query_params.append(('emailId', local_var_params['email_id'])) # noqa: E501 if 'phone_id' in local_var_params and local_var_params['phone_id'] is not None: # noqa: E501 query_params.append(('phoneId', local_var_params['phone_id'])) # noqa: E501 if 'sms_id' in local_var_params and local_var_params['sms_id'] is not None: # noqa: E501 query_params.append(('smsId', local_var_params['sms_id'])) # noqa: E501 if 'attachment_id' in local_var_params and local_var_params['attachment_id'] is not None: # noqa: E501 query_params.append(('attachmentId', local_var_params['attachment_id'])) # noqa: E501 if 'filter' in local_var_params and local_var_params['filter'] is not None: # noqa: E501 query_params.append(('filter', local_var_params['filter'])) # noqa: E501 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/user/events', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageEntityEventItems', # 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_entity_favorites(self, **kwargs): # noqa: E501 """get_entity_favorites # 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_entity_favorites(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index :param int size: Optional page size :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param str filter: Optional type filter :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: PageEntityFavouriteItems If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_entity_favorites_with_http_info(**kwargs) # noqa: E501 def get_entity_favorites_with_http_info(self, **kwargs): # noqa: E501 """get_entity_favorites # 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_entity_favorites_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index :param int size: Optional page size :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param str filter: Optional type filter :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(PageEntityFavouriteItems, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'page', 'size', 'sort', 'since', 'before', 'filter' ] 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_entity_favorites" % key ) local_var_params[key] = val del local_var_params['kwargs'] if self.api_client.client_side_validation and 'size' in local_var_params and local_var_params['size'] > 100: # noqa: E501 raise ApiValueError("Invalid value for parameter `size` when calling `get_entity_favorites`, must be a value less than or equal to `100`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 if 'since' in local_var_params and local_var_params['since'] is not None: # noqa: E501 query_params.append(('since', local_var_params['since'])) # noqa: E501 if 'before' in local_var_params and local_var_params['before'] is not None: # noqa: E501 query_params.append(('before', local_var_params['before'])) # noqa: E501 if 'filter' in local_var_params and local_var_params['filter'] is not None: # noqa: E501 query_params.append(('filter', local_var_params['filter'])) # noqa: E501 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/user/favorites', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageEntityFavouriteItems', # 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_inbox_retention_policy(self, policy_id, **kwargs): # noqa: E501 """get_inbox_retention_policy # noqa: E501 Get an inbox retention policy for your account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inbox_retention_policy(policy_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str policy_id: (required) :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: InboxRetentionPolicyDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_inbox_retention_policy_with_http_info(policy_id, **kwargs) # noqa: E501 def get_inbox_retention_policy_with_http_info(self, policy_id, **kwargs): # noqa: E501 """get_inbox_retention_policy # noqa: E501 Get an inbox retention policy for your account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inbox_retention_policy_with_http_info(policy_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str policy_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(InboxRetentionPolicyDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'policy_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 get_inbox_retention_policy" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'policy_id' is set if self.api_client.client_side_validation and ('policy_id' not in local_var_params or # noqa: E501 local_var_params['policy_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `policy_id` when calling `get_inbox_retention_policy`") # noqa: E501 collection_formats = {} path_params = {} if 'policy_id' in local_var_params: path_params['policyId'] = local_var_params['policy_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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/user/inbox-retention-policies/{policyId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxRetentionPolicyDto', # 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_inbox_retention_policy_for_account(self, **kwargs): # noqa: E501 """get_inbox_retention_policy_for_account # noqa: E501 Get inbox retention policy for your global account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inbox_retention_policy_for_account(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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: InboxRetentionPolicyOptionalDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_inbox_retention_policy_for_account_with_http_info(**kwargs) # noqa: E501 def get_inbox_retention_policy_for_account_with_http_info(self, **kwargs): # noqa: E501 """get_inbox_retention_policy_for_account # noqa: E501 Get inbox retention policy for your global account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inbox_retention_policy_for_account_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: tuple(InboxRetentionPolicyOptionalDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] 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_inbox_retention_policy_for_account" % 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 # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/user/inbox-retention-policies/account', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxRetentionPolicyOptionalDto', # 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_inbox_retention_policy_run(self, run_id, **kwargs): # noqa: E501 """get_inbox_retention_policy_run # noqa: E501 Get a previously submitted inbox retention policy run for your account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inbox_retention_policy_run(run_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str run_id: (required) :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: InboxRetentionPolicyRunDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_inbox_retention_policy_run_with_http_info(run_id, **kwargs) # noqa: E501 def get_inbox_retention_policy_run_with_http_info(self, run_id, **kwargs): # noqa: E501 """get_inbox_retention_policy_run # noqa: E501 Get a previously submitted inbox retention policy run for your account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inbox_retention_policy_run_with_http_info(run_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str run_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(InboxRetentionPolicyRunDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'run_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 get_inbox_retention_policy_run" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'run_id' is set if self.api_client.client_side_validation and ('run_id' not in local_var_params or # noqa: E501 local_var_params['run_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `run_id` when calling `get_inbox_retention_policy_run`") # noqa: E501 collection_formats = {} path_params = {} if 'run_id' in local_var_params: path_params['runId'] = local_var_params['run_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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/user/inbox-retention-policies/runs/{runId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxRetentionPolicyRunDto', # 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_inbox_retention_policy_runs(self, **kwargs): # noqa: E501 """get_inbox_retention_policy_runs # noqa: E501 List recent inbox retention policy runs for your account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inbox_retention_policy_runs(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index :param int size: Optional page size :param str sort: Optional createdAt sort direction ASC or DESC :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: PageInboxRetentionPolicyRunProjection If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_inbox_retention_policy_runs_with_http_info(**kwargs) # noqa: E501 def get_inbox_retention_policy_runs_with_http_info(self, **kwargs): # noqa: E501 """get_inbox_retention_policy_runs # noqa: E501 List recent inbox retention policy runs for your account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_inbox_retention_policy_runs_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int page: Optional page index :param int size: Optional page size :param str sort: Optional createdAt sort direction ASC or DESC :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(PageInboxRetentionPolicyRunProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'page', 'size', 'sort' ] 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_inbox_retention_policy_runs" % key ) local_var_params[key] = val del local_var_params['kwargs'] if self.api_client.client_side_validation and 'size' in local_var_params and local_var_params['size'] > 100: # noqa: E501 raise ApiValueError("Invalid value for parameter `size` when calling `get_inbox_retention_policy_runs`, must be a value less than or equal to `100`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 query_params.append(('page', local_var_params['page'])) # noqa: E501 if 'size' in local_var_params and local_var_params['size'] is not None: # noqa: E501 query_params.append(('size', local_var_params['size'])) # noqa: E501 if 'sort' in local_var_params and local_var_params['sort'] is not None: # noqa: E501 query_params.append(('sort', local_var_params['sort'])) # noqa: E501 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/user/inbox-retention-policies/runs', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='PageInboxRetentionPolicyRunProjection', # 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_json_property_as_string(self, _property, json_node, **kwargs): # noqa: E501 """get_json_property_as_string # noqa: E501 Utility function to extract properties from JSON objects in language where this is cumbersome. # 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_json_property_as_string(_property, json_node, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str _property: JSON property name or dot separated path selector such as `a.b.c` (required) :param JsonNode json_node: (required) :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: str If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_json_property_as_string_with_http_info(_property, json_node, **kwargs) # noqa: E501 def get_json_property_as_string_with_http_info(self, _property, json_node, **kwargs): # noqa: E501 """get_json_property_as_string # noqa: E501 Utility function to extract properties from JSON objects in language where this is cumbersome. # 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_json_property_as_string_with_http_info(_property, json_node, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str _property: JSON property name or dot separated path selector such as `a.b.c` (required) :param JsonNode json_node: (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(str, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ '_property', 'json_node' ] 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_json_property_as_string" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter '_property' is set if self.api_client.client_side_validation and ('_property' not in local_var_params or # noqa: E501 local_var_params['_property'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `_property` when calling `get_json_property_as_string`") # noqa: E501 # verify the required parameter 'json_node' is set if self.api_client.client_side_validation and ('json_node' not in local_var_params or # noqa: E501 local_var_params['json_node'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `json_node` when calling `get_json_property_as_string`") # noqa: E501 collection_formats = {} path_params = {} query_params = [] if '_property' in local_var_params and local_var_params['_property'] is not None: # noqa: E501 query_params.append(('property', local_var_params['_property'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None if 'json_node' in local_var_params: body_params = local_var_params['json_node'] # 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/user/json/pluck', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='str', # 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_user_info(self, **kwargs): # noqa: E501 """get_user_info # noqa: E501 Get account information for your user # 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_user_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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: UserInfoDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_user_info_with_http_info(**kwargs) # noqa: E501 def get_user_info_with_http_info(self, **kwargs): # noqa: E501 """get_user_info # noqa: E501 Get account information for your user # 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_user_info_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: tuple(UserInfoDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] 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_user_info" % 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 # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/user/info', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='UserInfoDto', # 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_user_storage_insights(self, **kwargs): # noqa: E501 """get_user_storage_insights # noqa: E501 Get retained storage usage insights for your account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_user_storage_insights(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int limit: Maximum number of inboxes and domains to return :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: UserStorageInsightsDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.get_user_storage_insights_with_http_info(**kwargs) # noqa: E501 def get_user_storage_insights_with_http_info(self, **kwargs): # noqa: E501 """get_user_storage_insights # noqa: E501 Get retained storage usage insights for your account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_user_storage_insights_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int limit: Maximum number of inboxes and domains to return :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(UserStorageInsightsDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ '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_user_storage_insights" % key ) local_var_params[key] = val del local_var_params['kwargs'] if self.api_client.client_side_validation and 'limit' in local_var_params and local_var_params['limit'] > 50: # noqa: E501 raise ApiValueError("Invalid value for parameter `limit` when calling `get_user_storage_insights`, must be a value less than or equal to `50`") # noqa: E501 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 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/user/storage/insights', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='UserStorageInsightsDto', # 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 list_inbox_retention_policies(self, **kwargs): # noqa: E501 """list_inbox_retention_policies # noqa: E501 List inbox retention policies for your account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.list_inbox_retention_policies(async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :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: InboxRetentionPoliciesDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.list_inbox_retention_policies_with_http_info(**kwargs) # noqa: E501 def list_inbox_retention_policies_with_http_info(self, **kwargs): # noqa: E501 """list_inbox_retention_policies # noqa: E501 List inbox retention policies for your account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.list_inbox_retention_policies_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: tuple(InboxRetentionPoliciesDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ ] 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 list_inbox_retention_policies" % 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 # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/user/inbox-retention-policies', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxRetentionPoliciesDto', # 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_inbox_retention_policy(self, policy_id, update_inbox_retention_policy_options, **kwargs): # noqa: E501 """update_inbox_retention_policy # noqa: E501 Update an inbox retention policy for your account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_inbox_retention_policy(policy_id, update_inbox_retention_policy_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str policy_id: (required) :param UpdateInboxRetentionPolicyOptions update_inbox_retention_policy_options: (required) :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: InboxRetentionPolicyDto If the method is called asynchronously, returns the request thread. """ kwargs['_return_http_data_only'] = True return self.update_inbox_retention_policy_with_http_info(policy_id, update_inbox_retention_policy_options, **kwargs) # noqa: E501 def update_inbox_retention_policy_with_http_info(self, policy_id, update_inbox_retention_policy_options, **kwargs): # noqa: E501 """update_inbox_retention_policy # noqa: E501 Update an inbox retention policy for your account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_inbox_retention_policy_with_http_info(policy_id, update_inbox_retention_policy_options, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str policy_id: (required) :param UpdateInboxRetentionPolicyOptions update_inbox_retention_policy_options: (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(InboxRetentionPolicyDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'policy_id', 'update_inbox_retention_policy_options' ] 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_inbox_retention_policy" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'policy_id' is set if self.api_client.client_side_validation and ('policy_id' not in local_var_params or # noqa: E501 local_var_params['policy_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `policy_id` when calling `update_inbox_retention_policy`") # noqa: E501 # verify the required parameter 'update_inbox_retention_policy_options' is set if self.api_client.client_side_validation and ('update_inbox_retention_policy_options' not in local_var_params or # noqa: E501 local_var_params['update_inbox_retention_policy_options'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `update_inbox_retention_policy_options` when calling `update_inbox_retention_policy`") # noqa: E501 collection_formats = {} path_params = {} if 'policy_id' in local_var_params: path_params['policyId'] = local_var_params['policy_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'update_inbox_retention_policy_options' in local_var_params: body_params = local_var_params['update_inbox_retention_policy_options'] # 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 = ['API_KEY'] # noqa: E501 return self.api_client.call_api( '/user/inbox-retention-policies/{policyId}', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InboxRetentionPolicyDto', # 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)Methods
def create_inbox_retention_policy(self, create_inbox_retention_policy_options, **kwargs)-
create_inbox_retention_policy # noqa: E501
Create an inbox retention policy for your account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_inbox_retention_policy(create_inbox_retention_policy_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CreateInboxRetentionPolicyOptions create_inbox_retention_policy_options: (required) :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: InboxRetentionPolicyDto If the method is called asynchronously, returns the request thread.
def create_inbox_retention_policy_run(self, **kwargs)-
create_inbox_retention_policy_run # noqa: E501
Start an asynchronous inbox retention policy run for your account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_inbox_retention_policy_run(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :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: InboxRetentionPolicyRunDto If the method is called asynchronously, returns the request thread.
def create_inbox_retention_policy_run_with_http_info(self, **kwargs)-
create_inbox_retention_policy_run # noqa: E501
Start an asynchronous inbox retention policy run for your account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_inbox_retention_policy_run_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: tuple(InboxRetentionPolicyRunDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def create_inbox_retention_policy_with_http_info(self, create_inbox_retention_policy_options, **kwargs)-
create_inbox_retention_policy # noqa: E501
Create an inbox retention policy for your account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_inbox_retention_policy_with_http_info(create_inbox_retention_policy_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CreateInboxRetentionPolicyOptions create_inbox_retention_policy_options: (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(InboxRetentionPolicyDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def create_or_update_inbox_retention_policy_for_account(self, create_inbox_retention_policy_for_account_options, **kwargs)-
create_or_update_inbox_retention_policy_for_account # noqa: E501
Create inbox retention policy for your global account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_or_update_inbox_retention_policy_for_account(create_inbox_retention_policy_for_account_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CreateInboxRetentionPolicyForAccountOptions create_inbox_retention_policy_for_account_options: (required) :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: InboxRetentionPolicyDto If the method is called asynchronously, returns the request thread.
def create_or_update_inbox_retention_policy_for_account_with_http_info(self, create_inbox_retention_policy_for_account_options, **kwargs)-
create_or_update_inbox_retention_policy_for_account # noqa: E501
Create inbox retention policy for your global account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.create_or_update_inbox_retention_policy_for_account_with_http_info(create_inbox_retention_policy_for_account_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param CreateInboxRetentionPolicyForAccountOptions create_inbox_retention_policy_for_account_options: (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(InboxRetentionPolicyDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def delete_inbox_retention_policy(self, policy_id, **kwargs)-
delete_inbox_retention_policy # noqa: E501
Delete an inbox retention policy for your account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_inbox_retention_policy(policy_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str policy_id: (required) :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: EmptyResponseDto If the method is called asynchronously, returns the request thread.
def delete_inbox_retention_policy_for_account(self, **kwargs)-
delete_inbox_retention_policy_for_account # noqa: E501
Delete inbox retention policy for your global account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_inbox_retention_policy_for_account(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :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: EmptyResponseDto If the method is called asynchronously, returns the request thread.
def delete_inbox_retention_policy_for_account_with_http_info(self, **kwargs)-
delete_inbox_retention_policy_for_account # noqa: E501
Delete inbox retention policy for your global account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_inbox_retention_policy_for_account_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: tuple(EmptyResponseDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def delete_inbox_retention_policy_with_http_info(self, policy_id, **kwargs)-
delete_inbox_retention_policy # noqa: E501
Delete an inbox retention policy for your account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_inbox_retention_policy_with_http_info(policy_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str policy_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(EmptyResponseDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_entity_automations(self, **kwargs)-
get_entity_automations # 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_entity_automations(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param int page: Optional page index :param int size: Optional page size :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param str inbox_id: Optional inbox ID :param str phone_id: Optional phone ID :param str filter: Optional automation type filter :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: PageEntityAutomationItems If the method is called asynchronously, returns the request thread.
def get_entity_automations_with_http_info(self, **kwargs)-
get_entity_automations # 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_entity_automations_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param int page: Optional page index :param int size: Optional page size :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param str inbox_id: Optional inbox ID :param str phone_id: Optional phone ID :param str filter: Optional automation type filter :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(PageEntityAutomationItems, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_entity_events(self, **kwargs)-
get_entity_events # 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_entity_events(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param int page: Optional page index :param int size: Optional page size :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param str inbox_id: Optional inbox ID :param str email_id: Optional email ID :param str phone_id: Optional phone ID :param str sms_id: Optional SMS ID :param str attachment_id: Optional attachment ID :param str filter: Optional type filter :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: PageEntityEventItems If the method is called asynchronously, returns the request thread.
def get_entity_events_with_http_info(self, **kwargs)-
get_entity_events # 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_entity_events_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param int page: Optional page index :param int size: Optional page size :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param str inbox_id: Optional inbox ID :param str email_id: Optional email ID :param str phone_id: Optional phone ID :param str sms_id: Optional SMS ID :param str attachment_id: Optional attachment ID :param str filter: Optional type filter :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(PageEntityEventItems, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_entity_favorites(self, **kwargs)-
get_entity_favorites # 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_entity_favorites(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param int page: Optional page index :param int size: Optional page size :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param str filter: Optional type filter :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: PageEntityFavouriteItems If the method is called asynchronously, returns the request thread.
def get_entity_favorites_with_http_info(self, **kwargs)-
get_entity_favorites # 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_entity_favorites_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param int page: Optional page index :param int size: Optional page size :param str sort: Optional createdAt sort direction ASC or DESC :param datetime since: Filter by created at after the given timestamp :param datetime before: Filter by created at before the given timestamp :param str filter: Optional type filter :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(PageEntityFavouriteItems, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_inbox_retention_policy(self, policy_id, **kwargs)-
get_inbox_retention_policy # noqa: E501
Get an inbox retention policy for your account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inbox_retention_policy(policy_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str policy_id: (required) :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: InboxRetentionPolicyDto If the method is called asynchronously, returns the request thread.
def get_inbox_retention_policy_for_account(self, **kwargs)-
get_inbox_retention_policy_for_account # noqa: E501
Get inbox retention policy for your global account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inbox_retention_policy_for_account(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :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: InboxRetentionPolicyOptionalDto If the method is called asynchronously, returns the request thread.
def get_inbox_retention_policy_for_account_with_http_info(self, **kwargs)-
get_inbox_retention_policy_for_account # noqa: E501
Get inbox retention policy for your global account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inbox_retention_policy_for_account_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: tuple(InboxRetentionPolicyOptionalDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_inbox_retention_policy_run(self, run_id, **kwargs)-
get_inbox_retention_policy_run # noqa: E501
Get a previously submitted inbox retention policy run for your account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inbox_retention_policy_run(run_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str run_id: (required) :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: InboxRetentionPolicyRunDto If the method is called asynchronously, returns the request thread.
def get_inbox_retention_policy_run_with_http_info(self, run_id, **kwargs)-
get_inbox_retention_policy_run # noqa: E501
Get a previously submitted inbox retention policy run for your account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inbox_retention_policy_run_with_http_info(run_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str run_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(InboxRetentionPolicyRunDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_inbox_retention_policy_runs(self, **kwargs)-
get_inbox_retention_policy_runs # noqa: E501
List recent inbox retention policy runs for your account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inbox_retention_policy_runs(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param int page: Optional page index :param int size: Optional page size :param str sort: Optional createdAt sort direction ASC or DESC :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: PageInboxRetentionPolicyRunProjection If the method is called asynchronously, returns the request thread.
def get_inbox_retention_policy_runs_with_http_info(self, **kwargs)-
get_inbox_retention_policy_runs # noqa: E501
List recent inbox retention policy runs for your account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inbox_retention_policy_runs_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param int page: Optional page index :param int size: Optional page size :param str sort: Optional createdAt sort direction ASC or DESC :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(PageInboxRetentionPolicyRunProjection, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_inbox_retention_policy_with_http_info(self, policy_id, **kwargs)-
get_inbox_retention_policy # noqa: E501
Get an inbox retention policy for your account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_inbox_retention_policy_with_http_info(policy_id, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str policy_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(InboxRetentionPolicyDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_json_property_as_string(self, _property, json_node, **kwargs)-
get_json_property_as_string # noqa: E501
Utility function to extract properties from JSON objects in language where this is cumbersome. # 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_json_property_as_string(_property, json_node, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str _property: JSON property name or dot separated path selector such as
a.b.c(required) :param JsonNode json_node: (required) :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: str If the method is called asynchronously, returns the request thread. def get_json_property_as_string_with_http_info(self, _property, json_node, **kwargs)-
get_json_property_as_string # noqa: E501
Utility function to extract properties from JSON objects in language where this is cumbersome. # 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_json_property_as_string_with_http_info(_property, json_node, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str _property: JSON property name or dot separated path selector such as
a.b.c(required) :param JsonNode json_node: (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(str, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. def get_user_info(self, **kwargs)-
get_user_info # noqa: E501
Get account information for your user # 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_user_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :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: UserInfoDto If the method is called asynchronously, returns the request thread.
def get_user_info_with_http_info(self, **kwargs)-
get_user_info # noqa: E501
Get account information for your user # 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_user_info_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: tuple(UserInfoDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def get_user_storage_insights(self, **kwargs)-
get_user_storage_insights # noqa: E501
Get retained storage usage insights for your account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_user_storage_insights(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param int limit: Maximum number of inboxes and domains to return :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: UserStorageInsightsDto If the method is called asynchronously, returns the request thread.
def get_user_storage_insights_with_http_info(self, **kwargs)-
get_user_storage_insights # noqa: E501
Get retained storage usage insights for your account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_user_storage_insights_with_http_info(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param int limit: Maximum number of inboxes and domains to return :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(UserStorageInsightsDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def list_inbox_retention_policies(self, **kwargs)-
list_inbox_retention_policies # noqa: E501
List inbox retention policies for your account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_inbox_retention_policies(async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :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: InboxRetentionPoliciesDto If the method is called asynchronously, returns the request thread.
def list_inbox_retention_policies_with_http_info(self, **kwargs)-
list_inbox_retention_policies # noqa: E501
List inbox retention policies for your account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_inbox_retention_policies_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: tuple(InboxRetentionPoliciesDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.
def update_inbox_retention_policy(self, policy_id, update_inbox_retention_policy_options, **kwargs)-
update_inbox_retention_policy # noqa: E501
Update an inbox retention policy for your account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_inbox_retention_policy(policy_id, update_inbox_retention_policy_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str policy_id: (required) :param UpdateInboxRetentionPolicyOptions update_inbox_retention_policy_options: (required) :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: InboxRetentionPolicyDto If the method is called asynchronously, returns the request thread.
def update_inbox_retention_policy_with_http_info(self, policy_id, update_inbox_retention_policy_options, **kwargs)-
update_inbox_retention_policy # noqa: E501
Update an inbox retention policy for your account # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_inbox_retention_policy_with_http_info(policy_id, update_inbox_retention_policy_options, async_req=True) >>> result = thread.get():param async_req bool: execute request asynchronously :param str policy_id: (required) :param UpdateInboxRetentionPolicyOptions update_inbox_retention_policy_options: (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(InboxRetentionPolicyDto, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread.