ultracart-rest-sdk 3.11.51__py3-none-any.whl → 3.11.54__py3-none-any.whl

ultracart/__init__.py

@@ -237,6 +237,25 @@ from ultracart.models.conversation_pbx_audio_usage_response import ConversationP
 from ultracart.models.conversation_pbx_audios_response import ConversationPbxAudiosResponse
 from ultracart.models.conversation_pbx_available_phone_number import ConversationPbxAvailablePhoneNumber
 from ultracart.models.conversation_pbx_available_phone_numbers_response import ConversationPbxAvailablePhoneNumbersResponse
+from ultracart.models.conversation_pbx_call import ConversationPbxCall
+from ultracart.models.conversation_pbx_call_agent import ConversationPbxCallAgent
+from ultracart.models.conversation_pbx_call_ai_cost import ConversationPbxCallAiCost
+from ultracart.models.conversation_pbx_call_ai_engagement import ConversationPbxCallAiEngagement
+from ultracart.models.conversation_pbx_call_ai_tool_call import ConversationPbxCallAiToolCall
+from ultracart.models.conversation_pbx_call_ai_whisper import ConversationPbxCallAiWhisper
+from ultracart.models.conversation_pbx_call_caller import ConversationPbxCallCaller
+from ultracart.models.conversation_pbx_call_financial import ConversationPbxCallFinancial
+from ultracart.models.conversation_pbx_call_hold import ConversationPbxCallHold
+from ultracart.models.conversation_pbx_call_queue import ConversationPbxCallQueue
+from ultracart.models.conversation_pbx_call_recording import ConversationPbxCallRecording
+from ultracart.models.conversation_pbx_call_response import ConversationPbxCallResponse
+from ultracart.models.conversation_pbx_call_routing import ConversationPbxCallRouting
+from ultracart.models.conversation_pbx_call_search_request import ConversationPbxCallSearchRequest
+from ultracart.models.conversation_pbx_call_search_response import ConversationPbxCallSearchResponse
+from ultracart.models.conversation_pbx_call_timeline import ConversationPbxCallTimeline
+from ultracart.models.conversation_pbx_call_transcript import ConversationPbxCallTranscript
+from ultracart.models.conversation_pbx_call_transcript_segment import ConversationPbxCallTranscriptSegment
+from ultracart.models.conversation_pbx_call_transfer import ConversationPbxCallTransfer
 from ultracart.models.conversation_pbx_customer_snapshot_request import ConversationPbxCustomerSnapshotRequest
 from ultracart.models.conversation_pbx_customer_snapshot_response import ConversationPbxCustomerSnapshotResponse
 from ultracart.models.conversation_pbx_hardware_phone import ConversationPbxHardwarePhone

ultracart/api/conversation_api.py

@@ -5047,6 +5047,105 @@ class ConversationApi(object):
             _request_timeout=params.get('_request_timeout'),
             collection_formats=collection_formats)
 
+    def get_pbx_call(self, call_uuid, **kwargs):  # noqa: E501
+        """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()
+
+        :param async_req bool
+        :param str call_uuid: (required)
+        :return: ConversationPbxCallResponse
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('async_req'):
+            return self.get_pbx_call_with_http_info(call_uuid, **kwargs)  # noqa: E501
+        else:
+            (data) = self.get_pbx_call_with_http_info(call_uuid, **kwargs)  # noqa: E501
+            return data
+
+    def get_pbx_call_with_http_info(self, call_uuid, **kwargs):  # noqa: E501
+        """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_with_http_info(call_uuid, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param str call_uuid: (required)
+        :return: ConversationPbxCallResponse
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['call_uuid']  # noqa: E501
+        all_params.append('async_req')
+        all_params.append('_return_http_data_only')
+        all_params.append('_preload_content')
+        all_params.append('_request_timeout')
+
+        params = locals()
+        for key, val in six.iteritems(params['kwargs']):
+            if key not in all_params:
+                raise TypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method get_pbx_call" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'call_uuid' is set
+        if ('call_uuid' not in params or
+                params['call_uuid'] is None):
+            raise ValueError("Missing the required parameter `call_uuid` when calling `get_pbx_call`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'call_uuid' in params:
+            path_params['callUuid'] = params['call_uuid']  # noqa: E501
+
+        query_params = []
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['application/json'])  # noqa: E501
+
+        # 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 = ['ultraCartOauth', 'ultraCartSimpleApiKey']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/conversation/pbx/call/{callUuid}', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='ConversationPbxCallResponse',  # noqa: E501
+            auth_settings=auth_settings,
+            async_req=params.get('async_req'),
+            _return_http_data_only=params.get('_return_http_data_only'),
+            _preload_content=params.get('_preload_content', True),
+            _request_timeout=params.get('_request_timeout'),
+            collection_formats=collection_formats)
+
     def get_pbx_hardware_phone(self, conversation_pbx_hardware_phone_uuid, **kwargs):  # noqa: E501
         """Get pbx hardware phone  # noqa: E501
 
@@ -9292,6 +9391,117 @@ class ConversationApi(object):
             _request_timeout=params.get('_request_timeout'),
             collection_formats=collection_formats)
 
+    def search_pbx_calls(self, search_request, **kwargs):  # noqa: E501
+        """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()
+
+        :param async_req bool
+        :param ConversationPbxCallSearchRequest search_request: Search Request (required)
+        :param int limit: The maximum number of records to return on this one API call. (Maximum 200)
+        :param int offset: Pagination of the record set.  Offset is a zero based index.
+        :param str sort: The sort order of the calls.
+        :return: ConversationPbxCallSearchResponse
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('async_req'):
+            return self.search_pbx_calls_with_http_info(search_request, **kwargs)  # noqa: E501
+        else:
+            (data) = self.search_pbx_calls_with_http_info(search_request, **kwargs)  # noqa: E501
+            return data
+
+    def search_pbx_calls_with_http_info(self, search_request, **kwargs):  # noqa: E501
+        """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_with_http_info(search_request, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param ConversationPbxCallSearchRequest search_request: Search Request (required)
+        :param int limit: The maximum number of records to return on this one API call. (Maximum 200)
+        :param int offset: Pagination of the record set.  Offset is a zero based index.
+        :param str sort: The sort order of the calls.
+        :return: ConversationPbxCallSearchResponse
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['search_request', 'limit', 'offset', 'sort']  # noqa: E501
+        all_params.append('async_req')
+        all_params.append('_return_http_data_only')
+        all_params.append('_preload_content')
+        all_params.append('_request_timeout')
+
+        params = locals()
+        for key, val in six.iteritems(params['kwargs']):
+            if key not in all_params:
+                raise TypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method search_pbx_calls" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'search_request' is set
+        if ('search_request' not in params or
+                params['search_request'] is None):
+            raise ValueError("Missing the required parameter `search_request` when calling `search_pbx_calls`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+
+        query_params = []
+        if 'limit' in params:
+            query_params.append(('_limit', params['limit']))  # noqa: E501
+        if 'offset' in params:
+            query_params.append(('_offset', params['offset']))  # noqa: E501
+        if 'sort' in params:
+            query_params.append(('_sort', params['sort']))  # noqa: E501
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        if 'search_request' in params:
+            body_params = params['search_request']
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['application/json'])  # noqa: E501
+
+        # HTTP header `Content-Type`
+        header_params['Content-Type'] = self.api_client.select_header_content_type(  # noqa: E501
+            ['application/json'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['ultraCartOauth', 'ultraCartSimpleApiKey']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/conversation/pbx/call/search', 'POST',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='ConversationPbxCallSearchResponse',  # noqa: E501
+            auth_settings=auth_settings,
+            async_req=params.get('async_req'),
+            _return_http_data_only=params.get('_return_http_data_only'),
+            _preload_content=params.get('_preload_content', True),
+            _request_timeout=params.get('_request_timeout'),
+            collection_formats=collection_formats)
+
     def sms_unsubscribe_conversation(self, conversation_uuid, **kwargs):  # noqa: E501
         """Unsubscribe any SMS participants in this conversation  # noqa: E501
 

ultracart/api_client.py

@@ -74,7 +74,7 @@ class ApiClient(object):
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'Swagger-Codegen/3.11.51/python'
+        self.user_agent = 'Swagger-Codegen/3.11.54/python'
 
     def __del__(self):
         if self._pool is not None:

ultracart/configuration.py

@@ -266,5 +266,5 @@ class Configuration(object):
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 2.0.0\n"\
-               "SDK Package Version: 3.11.51".\
+               "SDK Package Version: 3.11.54".\
                format(env=sys.platform, pyversion=sys.version)

ultracart/models/__init__.py

@@ -211,6 +211,25 @@ from ultracart.models.conversation_pbx_audio_usage_response import ConversationP
 from ultracart.models.conversation_pbx_audios_response import ConversationPbxAudiosResponse
 from ultracart.models.conversation_pbx_available_phone_number import ConversationPbxAvailablePhoneNumber
 from ultracart.models.conversation_pbx_available_phone_numbers_response import ConversationPbxAvailablePhoneNumbersResponse
+from ultracart.models.conversation_pbx_call import ConversationPbxCall
+from ultracart.models.conversation_pbx_call_agent import ConversationPbxCallAgent
+from ultracart.models.conversation_pbx_call_ai_cost import ConversationPbxCallAiCost
+from ultracart.models.conversation_pbx_call_ai_engagement import ConversationPbxCallAiEngagement
+from ultracart.models.conversation_pbx_call_ai_tool_call import ConversationPbxCallAiToolCall
+from ultracart.models.conversation_pbx_call_ai_whisper import ConversationPbxCallAiWhisper
+from ultracart.models.conversation_pbx_call_caller import ConversationPbxCallCaller
+from ultracart.models.conversation_pbx_call_financial import ConversationPbxCallFinancial
+from ultracart.models.conversation_pbx_call_hold import ConversationPbxCallHold
+from ultracart.models.conversation_pbx_call_queue import ConversationPbxCallQueue
+from ultracart.models.conversation_pbx_call_recording import ConversationPbxCallRecording
+from ultracart.models.conversation_pbx_call_response import ConversationPbxCallResponse
+from ultracart.models.conversation_pbx_call_routing import ConversationPbxCallRouting
+from ultracart.models.conversation_pbx_call_search_request import ConversationPbxCallSearchRequest
+from ultracart.models.conversation_pbx_call_search_response import ConversationPbxCallSearchResponse
+from ultracart.models.conversation_pbx_call_timeline import ConversationPbxCallTimeline
+from ultracart.models.conversation_pbx_call_transcript import ConversationPbxCallTranscript
+from ultracart.models.conversation_pbx_call_transcript_segment import ConversationPbxCallTranscriptSegment
+from ultracart.models.conversation_pbx_call_transfer import ConversationPbxCallTransfer
 from ultracart.models.conversation_pbx_customer_snapshot_request import ConversationPbxCustomerSnapshotRequest
 from ultracart.models.conversation_pbx_customer_snapshot_response import ConversationPbxCustomerSnapshotResponse
 from ultracart.models.conversation_pbx_hardware_phone import ConversationPbxHardwarePhone

ultracart/models/conversation_pbx_agent.py

@@ -35,6 +35,7 @@ class ConversationPbxAgent(object):
         'call_routing_preference': 'str',
         'cellphone': 'str',
         'conversation_pbx_agent_uuid': 'str',
+        'default_phone_number_uuid': 'str',
         'extension': 'int',
         'full_name': 'str',
         'hardware_phone_uuids': 'list[str]',
@@ -57,6 +58,7 @@ class ConversationPbxAgent(object):
         'call_routing_preference': 'call_routing_preference',
         'cellphone': 'cellphone',
         'conversation_pbx_agent_uuid': 'conversation_pbx_agent_uuid',
+        'default_phone_number_uuid': 'default_phone_number_uuid',
         'extension': 'extension',
         'full_name': 'full_name',
         'hardware_phone_uuids': 'hardware_phone_uuids',
@@ -74,13 +76,14 @@ class ConversationPbxAgent(object):
         'voicemail': 'voicemail'
     }
 
-    def __init__(self, ai=None, call_routing_preference=None, cellphone=None, conversation_pbx_agent_uuid=None, extension=None, full_name=None, hardware_phone_uuids=None, login=None, merchant_id=None, personal_conversation_pbx_voicemail_mailbox_uuid=None, preferred_hardware_phone_uuid=None, record_outgoing_automatically=None, shared_conversation_pbx_voicemail_mailbox_uuid=None, twilio_taskrouter_worker_id=None, unavailable_play_audio_uuid=None, unavailable_say=None, unavailable_say_voice=None, user_id=None, voicemail=None):  # noqa: E501
+    def __init__(self, ai=None, call_routing_preference=None, cellphone=None, conversation_pbx_agent_uuid=None, default_phone_number_uuid=None, extension=None, full_name=None, hardware_phone_uuids=None, login=None, merchant_id=None, personal_conversation_pbx_voicemail_mailbox_uuid=None, preferred_hardware_phone_uuid=None, record_outgoing_automatically=None, shared_conversation_pbx_voicemail_mailbox_uuid=None, twilio_taskrouter_worker_id=None, unavailable_play_audio_uuid=None, unavailable_say=None, unavailable_say_voice=None, user_id=None, voicemail=None):  # noqa: E501
         """ConversationPbxAgent - a model defined in Swagger"""  # noqa: E501
 
         self._ai = None
         self._call_routing_preference = None
         self._cellphone = None
         self._conversation_pbx_agent_uuid = None
+        self._default_phone_number_uuid = None
         self._extension = None
         self._full_name = None
         self._hardware_phone_uuids = None
@@ -106,6 +109,8 @@ class ConversationPbxAgent(object):
             self.cellphone = cellphone
         if conversation_pbx_agent_uuid is not None:
             self.conversation_pbx_agent_uuid = conversation_pbx_agent_uuid
+        if default_phone_number_uuid is not None:
+            self.default_phone_number_uuid = default_phone_number_uuid
         if extension is not None:
             self.extension = extension
         if full_name is not None:
@@ -237,6 +242,29 @@ class ConversationPbxAgent(object):
 
         self._conversation_pbx_agent_uuid = conversation_pbx_agent_uuid
 
+    @property
+    def default_phone_number_uuid(self):
+        """Gets the default_phone_number_uuid of this ConversationPbxAgent.  # noqa: E501
+
+        The default phone number that this agent should dial out to the PSTN with.  # noqa: E501
+
+        :return: The default_phone_number_uuid of this ConversationPbxAgent.  # noqa: E501
+        :rtype: str
+        """
+        return self._default_phone_number_uuid
+
+    @default_phone_number_uuid.setter
+    def default_phone_number_uuid(self, default_phone_number_uuid):
+        """Sets the default_phone_number_uuid of this ConversationPbxAgent.
+
+        The default phone number that this agent should dial out to the PSTN with.  # noqa: E501
+
+        :param default_phone_number_uuid: The default_phone_number_uuid of this ConversationPbxAgent.  # noqa: E501
+        :type: str
+        """
+
+        self._default_phone_number_uuid = default_phone_number_uuid
+
     @property
     def extension(self):
         """Gets the extension of this ConversationPbxAgent.  # noqa: E501