ultracart-rest-sdk 4.1.10__tar.gz → 4.1.12__tar.gz

{ultracart_rest_sdk-4.1.10 → ultracart_rest_sdk-4.1.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.2
 Name: ultracart_rest_sdk
-Version: 4.1.10
+Version: 4.1.12
 Summary: UltraCart Rest API V2
 Home-page: UNKNOWN
 Author: UltraCart Support

{ultracart_rest_sdk-4.1.10 → ultracart_rest_sdk-4.1.12}/README.md

@@ -7,7 +7,7 @@ Note: Every method has a sample for every language.  See https://github.com/Ultr
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.1.10
+- Package version: 4.1.12
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
 
@@ -97,6 +97,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.12 | 05/19/2025 | conversations - AI agent capabilities method |
+| 4.1.11 | 05/19/2025 | conversations - virtual AI budgets |
 | 4.1.10 | 05/06/2025 | conversation - ConversationAgentProfile.user_id added for agent profiles call |
 | 4.1.9 | 05/05/2025 | conversations - method to fetch all agent profiles for admin screens |
 | 4.1.8 | 04/22/2025 | order property fields for created_by and created_dts |

{ultracart_rest_sdk-4.1.10 → ultracart_rest_sdk-4.1.12}/setup.py

@@ -12,7 +12,7 @@
 from setuptools import setup, find_packages  # noqa: H301
 
 NAME = "ultracart_rest_sdk"
-VERSION = "4.1.10"
+VERSION = "4.1.12"
 # To install the library, run the following
 #
 # python setup.py install

{ultracart_rest_sdk-4.1.10 → ultracart_rest_sdk-4.1.12}/ultracart/__init__.py

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

{ultracart_rest_sdk-4.1.10 → ultracart_rest_sdk-4.1.12}/ultracart/api/conversation_api.py

@@ -79,6 +79,10 @@ from ultracart.model.conversation_search_request import ConversationSearchReques
 from ultracart.model.conversation_search_response import ConversationSearchResponse
 from ultracart.model.conversation_start_request import ConversationStartRequest
 from ultracart.model.conversation_start_response import ConversationStartResponse
+from ultracart.model.conversation_virtual_agent_budget import ConversationVirtualAgentBudget
+from ultracart.model.conversation_virtual_agent_budget_response import ConversationVirtualAgentBudgetResponse
+from ultracart.model.conversation_virtual_agent_capabilities import ConversationVirtualAgentCapabilities
+from ultracart.model.conversation_virtual_agent_capabilities_response import ConversationVirtualAgentCapabilitiesResponse
 from ultracart.model.conversation_webchat_context import ConversationWebchatContext
 from ultracart.model.conversation_webchat_queue_status_update_request import ConversationWebchatQueueStatusUpdateRequest
 from ultracart.model.conversation_webchat_queue_statuses_response import ConversationWebchatQueueStatusesResponse
@@ -2768,6 +2772,96 @@ class ConversationApi(object):
             },
             api_client=api_client
         )
+        self.get_virtual_agent_budget_endpoint = _Endpoint(
+            settings={
+                'response_type': (ConversationVirtualAgentBudgetResponse,),
+                'auth': [
+                    'ultraCartOauth',
+                    'ultraCartSimpleApiKey'
+                ],
+                'endpoint_path': '/conversation/virtualagent/budget',
+                'operation_id': 'get_virtual_agent_budget',
+                'http_method': 'GET',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                ],
+                'required': [],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                },
+                'attribute_map': {
+                },
+                'location_map': {
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'application/json'
+                ],
+                'content_type': [],
+            },
+            api_client=api_client
+        )
+        self.get_virtual_agent_capabilities_endpoint = _Endpoint(
+            settings={
+                'response_type': (ConversationVirtualAgentCapabilitiesResponse,),
+                'auth': [
+                    'ultraCartOauth',
+                    'ultraCartSimpleApiKey'
+                ],
+                'endpoint_path': '/conversation/virtualagent/capabilities',
+                'operation_id': 'get_virtual_agent_capabilities',
+                'http_method': 'GET',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                ],
+                'required': [],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                },
+                'attribute_map': {
+                },
+                'location_map': {
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'application/json'
+                ],
+                'content_type': [],
+            },
+            api_client=api_client
+        )
         self.insert_conversation_canned_message_endpoint = _Endpoint(
             settings={
                 'response_type': (ConversationCannedMessageResponse,),
@@ -4488,6 +4582,112 @@ class ConversationApi(object):
             },
             api_client=api_client
         )
+        self.update_virtual_agent_budget_endpoint = _Endpoint(
+            settings={
+                'response_type': (ConversationVirtualAgentBudgetResponse,),
+                'auth': [
+                    'ultraCartOauth',
+                    'ultraCartSimpleApiKey'
+                ],
+                'endpoint_path': '/conversation/virtualagent/budget',
+                'operation_id': 'update_virtual_agent_budget',
+                'http_method': 'PUT',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'virtual_agent_budget',
+                ],
+                'required': [
+                    'virtual_agent_budget',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'virtual_agent_budget':
+                        (ConversationVirtualAgentBudget,),
+                },
+                'attribute_map': {
+                },
+                'location_map': {
+                    'virtual_agent_budget': 'body',
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'application/json'
+                ],
+                'content_type': [
+                    'application/json'
+                ]
+            },
+            api_client=api_client
+        )
+        self.update_virtual_agent_capabilities_endpoint = _Endpoint(
+            settings={
+                'response_type': (ConversationVirtualAgentCapabilitiesResponse,),
+                'auth': [
+                    'ultraCartOauth',
+                    'ultraCartSimpleApiKey'
+                ],
+                'endpoint_path': '/conversation/virtualagent/capabilities',
+                'operation_id': 'update_virtual_agent_capabilities',
+                'http_method': 'PUT',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'virtual_agent_capabilities',
+                ],
+                'required': [
+                    'virtual_agent_capabilities',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'virtual_agent_capabilities':
+                        (ConversationVirtualAgentCapabilities,),
+                },
+                'attribute_map': {
+                },
+                'location_map': {
+                    'virtual_agent_capabilities': 'body',
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'application/json'
+                ],
+                'content_type': [
+                    'application/json'
+                ]
+            },
+            api_client=api_client
+        )
 
     def delete_conversation_canned_message(
         self,
@@ -8801,6 +9001,162 @@ class ConversationApi(object):
         kwargs['_request_auths'] = kwargs.get('_request_auths', None)
         return self.get_pbx_voicemail_mailboxes_endpoint.call_with_http_info(**kwargs)
 
+    def get_virtual_agent_budget(
+        self,
+        **kwargs
+    ):
+        """Get virtual agent budget  # noqa: E501
+
+        Retrieve virtual agent budget   # 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_virtual_agent_budget(async_req=True)
+        >>> result = thread.get()
+
+
+        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:
+            ConversationVirtualAgentBudgetResponse
+                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)
+        return self.get_virtual_agent_budget_endpoint.call_with_http_info(**kwargs)
+
+    def get_virtual_agent_capabilities(
+        self,
+        **kwargs
+    ):
+        """Get virtual agent capabilities  # noqa: E501
+
+        Retrieve virtual agent capabilities   # 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_virtual_agent_capabilities(async_req=True)
+        >>> result = thread.get()
+
+
+        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:
+            ConversationVirtualAgentCapabilitiesResponse
+                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)
+        return self.get_virtual_agent_capabilities_endpoint.call_with_http_info(**kwargs)
+
     def insert_conversation_canned_message(
         self,
         canned_message,
@@ -11427,3 +11783,169 @@ class ConversationApi(object):
             pbx_voicemail_mailbox
         return self.update_pbx_voicemail_mailbox_endpoint.call_with_http_info(**kwargs)
 
+    def update_virtual_agent_budget(
+        self,
+        virtual_agent_budget,
+        **kwargs
+    ):
+        """Update virtual agent budget  # noqa: E501
+
+        Update virtual agent budget   # 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_virtual_agent_budget(virtual_agent_budget, async_req=True)
+        >>> result = thread.get()
+
+        Args:
+            virtual_agent_budget (ConversationVirtualAgentBudget): Virtual Agent Budget
+
+        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:
+            ConversationVirtualAgentBudgetResponse
+                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['virtual_agent_budget'] = \
+            virtual_agent_budget
+        return self.update_virtual_agent_budget_endpoint.call_with_http_info(**kwargs)
+
+    def update_virtual_agent_capabilities(
+        self,
+        virtual_agent_capabilities,
+        **kwargs
+    ):
+        """Update virtual agent capabilities  # noqa: E501
+
+        Update virtual agent capabilities   # 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_virtual_agent_capabilities(virtual_agent_capabilities, async_req=True)
+        >>> result = thread.get()
+
+        Args:
+            virtual_agent_capabilities (ConversationVirtualAgentCapabilities): Virtual Agent Capabilities
+
+        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:
+            ConversationVirtualAgentCapabilitiesResponse
+                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['virtual_agent_capabilities'] = \
+            virtual_agent_capabilities
+        return self.update_virtual_agent_capabilities_endpoint.call_with_http_info(**kwargs)
+

{ultracart_rest_sdk-4.1.10 → ultracart_rest_sdk-4.1.12}/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.10/python'
+        self.user_agent = 'OpenAPI-Generator/4.1.12/python'
 
     def __enter__(self):
         return self

{ultracart_rest_sdk-4.1.10 → ultracart_rest_sdk-4.1.12}/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.10".\
+               "SDK Package Version: 4.1.12".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):