ultracart-rest-sdk 4.1.49__py3-none-any.whl → 4.1.54__py3-none-any.whl

ultracart/__init__.py

@@ -11,7 +11,7 @@
 """
 
 
-__version__ = "4.1.49"
+__version__ = "4.1.54"
 
 # import ApiClient
 from ultracart.api_client import ApiClient

ultracart/api/conversation_api.py

@@ -64,6 +64,9 @@ from ultracart.model.conversation_pbx_audio_upload_url_response import Conversat
 from ultracart.model.conversation_pbx_audio_usage_response import ConversationPbxAudioUsageResponse
 from ultracart.model.conversation_pbx_audios_response import ConversationPbxAudiosResponse
 from ultracart.model.conversation_pbx_available_phone_numbers_response import ConversationPbxAvailablePhoneNumbersResponse
+from ultracart.model.conversation_pbx_call_response import ConversationPbxCallResponse
+from ultracart.model.conversation_pbx_call_search_request import ConversationPbxCallSearchRequest
+from ultracart.model.conversation_pbx_call_search_response import ConversationPbxCallSearchResponse
 from ultracart.model.conversation_pbx_customer_snapshot_request import ConversationPbxCustomerSnapshotRequest
 from ultracart.model.conversation_pbx_customer_snapshot_response import ConversationPbxCustomerSnapshotResponse
 from ultracart.model.conversation_pbx_hardware_phone import ConversationPbxHardwarePhone
@@ -2745,6 +2748,58 @@ class ConversationApi(object):
             },
             api_client=api_client
         )
+        self.get_pbx_call_endpoint = _Endpoint(
+            settings={
+                'response_type': (ConversationPbxCallResponse,),
+                'auth': [
+                    'ultraCartOauth',
+                    'ultraCartSimpleApiKey'
+                ],
+                'endpoint_path': '/conversation/pbx/call/{callUuid}',
+                'operation_id': 'get_pbx_call',
+                'http_method': 'GET',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'call_uuid',
+                ],
+                'required': [
+                    'call_uuid',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'call_uuid':
+                        (str,),
+                },
+                'attribute_map': {
+                    'call_uuid': 'callUuid',
+                },
+                'location_map': {
+                    'call_uuid': 'path',
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'application/json'
+                ],
+                'content_type': [],
+            },
+            api_client=api_client
+        )
         self.get_pbx_hardware_phone_endpoint = _Endpoint(
             settings={
                 'response_type': (ConversationPbxHardwarePhoneResponse,),
@@ -4993,6 +5048,74 @@ class ConversationApi(object):
             },
             api_client=api_client
         )
+        self.search_pbx_calls_endpoint = _Endpoint(
+            settings={
+                'response_type': (ConversationPbxCallSearchResponse,),
+                'auth': [
+                    'ultraCartOauth',
+                    'ultraCartSimpleApiKey'
+                ],
+                'endpoint_path': '/conversation/pbx/call/search',
+                'operation_id': 'search_pbx_calls',
+                'http_method': 'POST',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'search_request',
+                    'limit',
+                    'offset',
+                    'sort',
+                ],
+                'required': [
+                    'search_request',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'search_request':
+                        (ConversationPbxCallSearchRequest,),
+                    'limit':
+                        (int,),
+                    'offset':
+                        (int,),
+                    'sort':
+                        (str,),
+                },
+                'attribute_map': {
+                    'limit': '_limit',
+                    'offset': '_offset',
+                    'sort': '_sort',
+                },
+                'location_map': {
+                    'search_request': 'body',
+                    'limit': 'query',
+                    'offset': 'query',
+                    'sort': 'query',
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'application/json'
+                ],
+                'content_type': [
+                    'application/json'
+                ]
+            },
+            api_client=api_client
+        )
         self.sms_unsubscribe_conversation_endpoint = _Endpoint(
             settings={
                 'response_type': None,
@@ -10336,6 +10459,89 @@ class ConversationApi(object):
         kwargs['_request_auths'] = kwargs.get('_request_auths', None)
         return self.get_pbx_audios_endpoint.call_with_http_info(**kwargs)
 
+    def get_pbx_call(
+        self,
+        call_uuid,
+        **kwargs
+    ):
+        """Get pbx call record  # noqa: E501
+
+        Retrieve a single PBX call record with full details   # 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_pbx_call(call_uuid, async_req=True)
+        >>> result = thread.get()
+
+        Args:
+            call_uuid (str):
+
+        Keyword Args:
+            _return_http_data_only (bool): response data without head status
+                code and headers. Default is True.
+            _preload_content (bool): if False, the urllib3.HTTPResponse object
+                will be returned without reading/decoding response data.
+                Default is True.
+            _request_timeout (int/float/tuple): 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.
+                Default is None.
+            _check_input_type (bool): specifies if type checking
+                should be done one the data sent to the server.
+                Default is True.
+            _check_return_type (bool): specifies if type checking
+                should be done one the data received from the server.
+                Default is True.
+            _spec_property_naming (bool): True if the variable names in the input data
+                are serialized names, as specified in the OpenAPI document.
+                False if the variable names in the input data
+                are pythonic names, e.g. snake case (default)
+            _content_type (str/None): force body content-type.
+                Default is None and content-type will be predicted by allowed
+                content-types and body.
+            _host_index (int/None): specifies the index of the server
+                that we want to use.
+                Default is read from the configuration.
+            _request_auths (list): set to override the auth_settings for an a single
+                request; this effectively ignores the authentication
+                in the spec for a single request.
+                Default is None
+            async_req (bool): execute request asynchronously
+
+        Returns:
+            ConversationPbxCallResponse
+                If the method is called asynchronously, returns the request
+                thread.
+        """
+        kwargs['async_req'] = kwargs.get(
+            'async_req', False
+        )
+        kwargs['_return_http_data_only'] = kwargs.get(
+            '_return_http_data_only', True
+        )
+        kwargs['_preload_content'] = kwargs.get(
+            '_preload_content', True
+        )
+        kwargs['_request_timeout'] = kwargs.get(
+            '_request_timeout', None
+        )
+        kwargs['_check_input_type'] = kwargs.get(
+            '_check_input_type', True
+        )
+        kwargs['_check_return_type'] = kwargs.get(
+            '_check_return_type', True
+        )
+        kwargs['_spec_property_naming'] = kwargs.get(
+            '_spec_property_naming', False
+        )
+        kwargs['_content_type'] = kwargs.get(
+            '_content_type')
+        kwargs['_host_index'] = kwargs.get('_host_index')
+        kwargs['_request_auths'] = kwargs.get('_request_auths', None)
+        kwargs['call_uuid'] = \
+            call_uuid
+        return self.get_pbx_call_endpoint.call_with_http_info(**kwargs)
+
     def get_pbx_hardware_phone(
         self,
         conversation_pbx_hardware_phone_uuid,
@@ -13882,6 +14088,92 @@ class ConversationApi(object):
             country
         return self.search_pbx_available_phone_numbers_endpoint.call_with_http_info(**kwargs)
 
+    def search_pbx_calls(
+        self,
+        search_request,
+        **kwargs
+    ):
+        """Search pbx call records  # noqa: E501
+
+        Search and list PBX call records with filtering, sorting, and pagination   # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.search_pbx_calls(search_request, async_req=True)
+        >>> result = thread.get()
+
+        Args:
+            search_request (ConversationPbxCallSearchRequest): Search Request
+
+        Keyword Args:
+            limit (int): The maximum number of records to return on this one API call. (Maximum 200). [optional] if omitted the server will use the default value of 100
+            offset (int): Pagination of the record set.  Offset is a zero based index.. [optional] if omitted the server will use the default value of 0
+            sort (str): The sort order of the calls.. [optional]
+            _return_http_data_only (bool): response data without head status
+                code and headers. Default is True.
+            _preload_content (bool): if False, the urllib3.HTTPResponse object
+                will be returned without reading/decoding response data.
+                Default is True.
+            _request_timeout (int/float/tuple): 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.
+                Default is None.
+            _check_input_type (bool): specifies if type checking
+                should be done one the data sent to the server.
+                Default is True.
+            _check_return_type (bool): specifies if type checking
+                should be done one the data received from the server.
+                Default is True.
+            _spec_property_naming (bool): True if the variable names in the input data
+                are serialized names, as specified in the OpenAPI document.
+                False if the variable names in the input data
+                are pythonic names, e.g. snake case (default)
+            _content_type (str/None): force body content-type.
+                Default is None and content-type will be predicted by allowed
+                content-types and body.
+            _host_index (int/None): specifies the index of the server
+                that we want to use.
+                Default is read from the configuration.
+            _request_auths (list): set to override the auth_settings for an a single
+                request; this effectively ignores the authentication
+                in the spec for a single request.
+                Default is None
+            async_req (bool): execute request asynchronously
+
+        Returns:
+            ConversationPbxCallSearchResponse
+                If the method is called asynchronously, returns the request
+                thread.
+        """
+        kwargs['async_req'] = kwargs.get(
+            'async_req', False
+        )
+        kwargs['_return_http_data_only'] = kwargs.get(
+            '_return_http_data_only', True
+        )
+        kwargs['_preload_content'] = kwargs.get(
+            '_preload_content', True
+        )
+        kwargs['_request_timeout'] = kwargs.get(
+            '_request_timeout', None
+        )
+        kwargs['_check_input_type'] = kwargs.get(
+            '_check_input_type', True
+        )
+        kwargs['_check_return_type'] = kwargs.get(
+            '_check_return_type', True
+        )
+        kwargs['_spec_property_naming'] = kwargs.get(
+            '_spec_property_naming', False
+        )
+        kwargs['_content_type'] = kwargs.get(
+            '_content_type')
+        kwargs['_host_index'] = kwargs.get('_host_index')
+        kwargs['_request_auths'] = kwargs.get('_request_auths', None)
+        kwargs['search_request'] = \
+            search_request
+        return self.search_pbx_calls_endpoint.call_with_http_info(**kwargs)
+
     def sms_unsubscribe_conversation(
         self,
         conversation_uuid,

ultracart/api_client.py

@@ -77,7 +77,7 @@ class ApiClient(object):
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'OpenAPI-Generator/4.1.49/python'
+        self.user_agent = 'OpenAPI-Generator/4.1.54/python'
 
     def __enter__(self):
         return self

ultracart/configuration.py

@@ -422,7 +422,7 @@ conf = ultracart.Configuration(
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 2.0.0\n"\
-               "SDK Package Version: 4.1.49".\
+               "SDK Package Version: 4.1.54".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

ultracart/model/conversation_pbx_agent.py

@@ -56,6 +56,11 @@ class ConversationPbxAgent(ModelNormal):
     """
 
     allowed_values = {
+        ('call_routing_preference',): {
+            'SOFTPHONE': "softphone",
+            'HARDWARE_PHONE': "hardware_phone",
+            'CELLPHONE': "cellphone",
+        },
     }
 
     validations = {
@@ -104,14 +109,17 @@ class ConversationPbxAgent(ModelNormal):
         """
         return {
             'ai': (bool,),  # noqa: E501
+            'call_routing_preference': (str,),  # noqa: E501
             'cellphone': (str,),  # noqa: E501
             'conversation_pbx_agent_uuid': (str,),  # noqa: E501
+            'default_phone_number_uuid': (str,),  # noqa: E501
             'extension': (int,),  # noqa: E501
-            'forward_calls_to_cellphone': (bool,),  # noqa: E501
             'full_name': (str,),  # noqa: E501
+            'hardware_phone_uuids': ([str],),  # noqa: E501
             'login': (str,),  # noqa: E501
             'merchant_id': (str,),  # noqa: E501
             'personal_conversation_pbx_voicemail_mailbox_uuid': (str,),  # noqa: E501
+            'preferred_hardware_phone_uuid': (str,),  # noqa: E501
             'record_outgoing_automatically': (bool,),  # noqa: E501
             'shared_conversation_pbx_voicemail_mailbox_uuid': (str,),  # noqa: E501
             'twilio_taskrouter_worker_id': (str,),  # noqa: E501
@@ -129,14 +137,17 @@ class ConversationPbxAgent(ModelNormal):
 
     attribute_map = {
         'ai': 'ai',  # noqa: E501
+        'call_routing_preference': 'call_routing_preference',  # noqa: E501
         'cellphone': 'cellphone',  # noqa: E501
         'conversation_pbx_agent_uuid': 'conversation_pbx_agent_uuid',  # noqa: E501
+        'default_phone_number_uuid': 'default_phone_number_uuid',  # noqa: E501
         'extension': 'extension',  # noqa: E501
-        'forward_calls_to_cellphone': 'forward_calls_to_cellphone',  # noqa: E501
         'full_name': 'full_name',  # noqa: E501
+        'hardware_phone_uuids': 'hardware_phone_uuids',  # noqa: E501
         'login': 'login',  # noqa: E501
         'merchant_id': 'merchant_id',  # noqa: E501
         'personal_conversation_pbx_voicemail_mailbox_uuid': 'personal_conversation_pbx_voicemail_mailbox_uuid',  # noqa: E501
+        'preferred_hardware_phone_uuid': 'preferred_hardware_phone_uuid',  # noqa: E501
         'record_outgoing_automatically': 'record_outgoing_automatically',  # noqa: E501
         'shared_conversation_pbx_voicemail_mailbox_uuid': 'shared_conversation_pbx_voicemail_mailbox_uuid',  # noqa: E501
         'twilio_taskrouter_worker_id': 'twilio_taskrouter_worker_id',  # noqa: E501
@@ -189,14 +200,17 @@ class ConversationPbxAgent(ModelNormal):
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
             ai (bool): Flag to indicate if the agent is AI. [optional]  # noqa: E501
+            call_routing_preference (str): The call routing preference. [optional]  # noqa: E501
             cellphone (str): Cellphone number of agent in E.164 format. [optional]  # noqa: E501
             conversation_pbx_agent_uuid (str): Conversation Pbx Agent unique identifier. [optional]  # noqa: E501
+            default_phone_number_uuid (str): The default phone number that this agent should dial out to the PSTN with.. [optional]  # noqa: E501
             extension (int): Extension. [optional]  # noqa: E501
-            forward_calls_to_cellphone (bool): True if calls to this agent should be forwarded to their cellphone. [optional]  # noqa: E501
             full_name (str): Full name. [optional]  # noqa: E501
+            hardware_phone_uuids ([str]): Array of hardware phones UUIDs associated with this agent. [optional]  # noqa: E501
             login (str): Agent login. [optional]  # noqa: E501
             merchant_id (str): Merchant Id. [optional]  # noqa: E501
             personal_conversation_pbx_voicemail_mailbox_uuid (str): Personal Conversation Pbx Voicemail Mailbox UUID. [optional]  # noqa: E501
+            preferred_hardware_phone_uuid (str): The hardware phone that will be dialed on an incoming call if routing preference is hardware_phone. [optional]  # noqa: E501
             record_outgoing_automatically (bool): True if outgoing calls should be automatically recorded. [optional]  # noqa: E501
             shared_conversation_pbx_voicemail_mailbox_uuid (str): Shared Conversation Pbx Voicemail Mailbox UUID. [optional]  # noqa: E501
             twilio_taskrouter_worker_id (str): Twilio taskrouter worker Id. [optional]  # noqa: E501
@@ -291,14 +305,17 @@ class ConversationPbxAgent(ModelNormal):
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
             ai (bool): Flag to indicate if the agent is AI. [optional]  # noqa: E501
+            call_routing_preference (str): The call routing preference. [optional]  # noqa: E501
             cellphone (str): Cellphone number of agent in E.164 format. [optional]  # noqa: E501
             conversation_pbx_agent_uuid (str): Conversation Pbx Agent unique identifier. [optional]  # noqa: E501
+            default_phone_number_uuid (str): The default phone number that this agent should dial out to the PSTN with.. [optional]  # noqa: E501
             extension (int): Extension. [optional]  # noqa: E501
-            forward_calls_to_cellphone (bool): True if calls to this agent should be forwarded to their cellphone. [optional]  # noqa: E501
             full_name (str): Full name. [optional]  # noqa: E501
+            hardware_phone_uuids ([str]): Array of hardware phones UUIDs associated with this agent. [optional]  # noqa: E501
             login (str): Agent login. [optional]  # noqa: E501
             merchant_id (str): Merchant Id. [optional]  # noqa: E501
             personal_conversation_pbx_voicemail_mailbox_uuid (str): Personal Conversation Pbx Voicemail Mailbox UUID. [optional]  # noqa: E501
+            preferred_hardware_phone_uuid (str): The hardware phone that will be dialed on an incoming call if routing preference is hardware_phone. [optional]  # noqa: E501
             record_outgoing_automatically (bool): True if outgoing calls should be automatically recorded. [optional]  # noqa: E501
             shared_conversation_pbx_voicemail_mailbox_uuid (str): Shared Conversation Pbx Voicemail Mailbox UUID. [optional]  # noqa: E501
             twilio_taskrouter_worker_id (str): Twilio taskrouter worker Id. [optional]  # noqa: E501