ultracart-rest-sdk 4.1.27__py3-none-any.whl → 4.1.37__py3-none-any.whl

ultracart/api/order_api.py

@@ -28,6 +28,7 @@ from ultracart.model.accounts_receivable_retry_stats_response import AccountsRec
 from ultracart.model.base_response import BaseResponse
 from ultracart.model.error_response import ErrorResponse
 from ultracart.model.order import Order
+from ultracart.model.order_assign_to_affiliate_request import OrderAssignToAffiliateRequest
 from ultracart.model.order_by_token_query import OrderByTokenQuery
 from ultracart.model.order_edi_documents_response import OrderEdiDocumentsResponse
 from ultracart.model.order_format import OrderFormat
@@ -129,6 +130,70 @@ class OrderApi(object):
             },
             api_client=api_client
         )
+        self.assign_to_affiliate_endpoint = _Endpoint(
+            settings={
+                'response_type': (OrderResponse,),
+                'auth': [
+                    'ultraCartOauth',
+                    'ultraCartSimpleApiKey'
+                ],
+                'endpoint_path': '/order/orders/{order_id}/assignToAffiliate',
+                'operation_id': 'assign_to_affiliate',
+                'http_method': 'POST',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'order_id',
+                    'assign_to_affiliate_request',
+                    'expand',
+                ],
+                'required': [
+                    'order_id',
+                    'assign_to_affiliate_request',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'order_id':
+                        (str,),
+                    'assign_to_affiliate_request':
+                        (OrderAssignToAffiliateRequest,),
+                    'expand':
+                        (str,),
+                },
+                'attribute_map': {
+                    'order_id': 'order_id',
+                    'expand': '_expand',
+                },
+                'location_map': {
+                    'order_id': 'path',
+                    'assign_to_affiliate_request': 'body',
+                    'expand': 'query',
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'application/json'
+                ],
+                'content_type': [
+                    'application/json'
+                ]
+            },
+            api_client=api_client
+        )
         self.block_refund_on_order_endpoint = _Endpoint(
             settings={
                 'response_type': None,
@@ -2033,6 +2098,94 @@ class OrderApi(object):
             desired_total
         return self.adjust_order_total_endpoint.call_with_http_info(**kwargs)
 
+    def assign_to_affiliate(
+        self,
+        order_id,
+        assign_to_affiliate_request,
+        **kwargs
+    ):
+        """Assigns an order to an affiliate  # noqa: E501
+
+        Assigns an order to an affiliate.   # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.assign_to_affiliate(order_id, assign_to_affiliate_request, async_req=True)
+        >>> result = thread.get()
+
+        Args:
+            order_id (str): The order id to assign to the affiliate.
+            assign_to_affiliate_request (OrderAssignToAffiliateRequest): Assign to affiliate request
+
+        Keyword Args:
+            expand (str): The object expansion to perform on the result.  See documentation for examples. [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:
+            OrderResponse
+                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['order_id'] = \
+            order_id
+        kwargs['assign_to_affiliate_request'] = \
+            assign_to_affiliate_request
+        return self.assign_to_affiliate_endpoint.call_with_http_info(**kwargs)
+
     def block_refund_on_order(
         self,
         order_id,

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.27/python'
+        self.user_agent = 'OpenAPI-Generator/4.1.37/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.27".\
+               "SDK Package Version: 4.1.37".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

ultracart/model/conversation_agent_auth.py

@@ -100,6 +100,7 @@ class ConversationAgentAuth(ModelNormal):
             'pbx_voice_identity': (str,),  # noqa: E501
             'pbx_voice_token': (str,),  # noqa: E501
             'pbx_worker_token': (str,),  # noqa: E501
+            'pbx_worker_token_v2': (str,),  # noqa: E501
             'twilio_accounts': ([ConversationTwilioAccount],),  # noqa: E501
             'user_id': (int,),  # noqa: E501
             'websocket_url': (str,),  # noqa: E501
@@ -123,6 +124,7 @@ class ConversationAgentAuth(ModelNormal):
         'pbx_voice_identity': 'pbx_voice_identity',  # noqa: E501
         'pbx_voice_token': 'pbx_voice_token',  # noqa: E501
         'pbx_worker_token': 'pbx_worker_token',  # noqa: E501
+        'pbx_worker_token_v2': 'pbx_worker_token_v2',  # noqa: E501
         'twilio_accounts': 'twilio_accounts',  # noqa: E501
         'user_id': 'user_id',  # noqa: E501
         'websocket_url': 'websocket_url',  # noqa: E501
@@ -181,6 +183,7 @@ class ConversationAgentAuth(ModelNormal):
             pbx_voice_identity (str): [optional]  # noqa: E501
             pbx_voice_token (str): [optional]  # noqa: E501
             pbx_worker_token (str): [optional]  # noqa: E501
+            pbx_worker_token_v2 (str): [optional]  # noqa: E501
             twilio_accounts ([ConversationTwilioAccount]): [optional]  # noqa: E501
             user_id (int): UltraCart User ID. [optional]  # noqa: E501
             websocket_url (str): [optional]  # noqa: E501
@@ -281,6 +284,7 @@ class ConversationAgentAuth(ModelNormal):
             pbx_voice_identity (str): [optional]  # noqa: E501
             pbx_voice_token (str): [optional]  # noqa: E501
             pbx_worker_token (str): [optional]  # noqa: E501
+            pbx_worker_token_v2 (str): [optional]  # noqa: E501
             twilio_accounts ([ConversationTwilioAccount]): [optional]  # noqa: E501
             user_id (int): UltraCart User ID. [optional]  # noqa: E501
             websocket_url (str): [optional]  # noqa: E501

ultracart/model/conversation_agent_profile.py

@@ -91,6 +91,7 @@ class ConversationAgentProfile(ModelNormal):
             'ai_chat_instructions': (str,),  # noqa: E501
             'ai_persona': (str,),  # noqa: E501
             'ai_sms_instructions': (str,),  # noqa: E501
+            'ai_ticket_instructions': (str,),  # noqa: E501
             'chat_limit': (int,),  # noqa: E501
             'default_language_iso_code': (str,),  # noqa: E501
             'default_status': (str,),  # noqa: E501
@@ -99,6 +100,8 @@ class ConversationAgentProfile(ModelNormal):
             'profile_image_upload_key': (str,),  # noqa: E501
             'profile_image_url': (str,),  # noqa: E501
             'user_id': (int,),  # noqa: E501
+            'zohodesk_classifications': ([str],),  # noqa: E501
+            'zohodesk_departments': ([str],),  # noqa: E501
         }
 
     @cached_property
@@ -111,6 +114,7 @@ class ConversationAgentProfile(ModelNormal):
         'ai_chat_instructions': 'ai_chat_instructions',  # noqa: E501
         'ai_persona': 'ai_persona',  # noqa: E501
         'ai_sms_instructions': 'ai_sms_instructions',  # noqa: E501
+        'ai_ticket_instructions': 'ai_ticket_instructions',  # noqa: E501
         'chat_limit': 'chat_limit',  # noqa: E501
         'default_language_iso_code': 'default_language_iso_code',  # noqa: E501
         'default_status': 'default_status',  # noqa: E501
@@ -119,6 +123,8 @@ class ConversationAgentProfile(ModelNormal):
         'profile_image_upload_key': 'profile_image_upload_key',  # noqa: E501
         'profile_image_url': 'profile_image_url',  # noqa: E501
         'user_id': 'user_id',  # noqa: E501
+        'zohodesk_classifications': 'zohodesk_classifications',  # noqa: E501
+        'zohodesk_departments': 'zohodesk_departments',  # noqa: E501
     }
 
     read_only_vars = {
@@ -166,6 +172,7 @@ class ConversationAgentProfile(ModelNormal):
             ai_chat_instructions (str): Additional instructions for this AI when handle web chats. [optional]  # noqa: E501
             ai_persona (str): Persona of this AI agent. [optional]  # noqa: E501
             ai_sms_instructions (str): Additional instructions for this AI when handle SMS messages. [optional]  # noqa: E501
+            ai_ticket_instructions (str): Additional instructions for this AI when handling ticket draft replies. [optional]  # noqa: E501
             chat_limit (int): The number of engagement chats that can be pushed on them at any given time.. [optional]  # noqa: E501
             default_language_iso_code (str): The default language the agent is chatting in. [optional]  # noqa: E501
             default_status (str): Default status when the agent loads conversations app.. [optional]  # noqa: E501
@@ -174,6 +181,8 @@ class ConversationAgentProfile(ModelNormal):
             profile_image_upload_key (str): An upload key used to update the profile image.. [optional]  # noqa: E501
             profile_image_url (str): Their current profile image URL. [optional]  # noqa: E501
             user_id (int): User ID associated with the agent.  Populated by getAgentProfiles call only.. [optional]  # noqa: E501
+            zohodesk_classifications ([str]): Restrict this agent to drafting replies only to tickets with these classifications. [optional]  # noqa: E501
+            zohodesk_departments ([str]): Restrict this agent to drafting replies only to these department ids. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -263,6 +272,7 @@ class ConversationAgentProfile(ModelNormal):
             ai_chat_instructions (str): Additional instructions for this AI when handle web chats. [optional]  # noqa: E501
             ai_persona (str): Persona of this AI agent. [optional]  # noqa: E501
             ai_sms_instructions (str): Additional instructions for this AI when handle SMS messages. [optional]  # noqa: E501
+            ai_ticket_instructions (str): Additional instructions for this AI when handling ticket draft replies. [optional]  # noqa: E501
             chat_limit (int): The number of engagement chats that can be pushed on them at any given time.. [optional]  # noqa: E501
             default_language_iso_code (str): The default language the agent is chatting in. [optional]  # noqa: E501
             default_status (str): Default status when the agent loads conversations app.. [optional]  # noqa: E501
@@ -271,6 +281,8 @@ class ConversationAgentProfile(ModelNormal):
             profile_image_upload_key (str): An upload key used to update the profile image.. [optional]  # noqa: E501
             profile_image_url (str): Their current profile image URL. [optional]  # noqa: E501
             user_id (int): User ID associated with the agent.  Populated by getAgentProfiles call only.. [optional]  # noqa: E501
+            zohodesk_classifications ([str]): Restrict this agent to drafting replies only to tickets with these classifications. [optional]  # noqa: E501
+            zohodesk_departments ([str]): Restrict this agent to drafting replies only to these department ids. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)

ultracart/model/conversation_mcp_server.py

@@ -0,0 +1,297 @@
+"""
+    UltraCart Rest API V2
+
+    UltraCart REST API Version 2  # noqa: E501
+
+    The version of the OpenAPI document: 2.0.0
+    Contact: support@ultracart.com
+    Generated by: https://openapi-generator.tech
+"""
+
+
+import re  # noqa: F401
+import sys  # noqa: F401
+
+from ultracart.model_utils import (  # noqa: F401
+    ApiTypeError,
+    ModelComposed,
+    ModelNormal,
+    ModelSimple,
+    cached_property,
+    change_keys_js_to_python,
+    convert_js_args_to_python_args,
+    date,
+    datetime,
+    file_type,
+    none_type,
+    validate_get_composed_info,
+    OpenApiModel
+)
+from ultracart.exceptions import ApiAttributeError
+
+
+
+class ConversationMcpServer(ModelNormal):
+    """NOTE: This class is auto generated by OpenAPI Generator.
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+
+    Attributes:
+      allowed_values (dict): The key is the tuple path to the attribute
+          and the for var_name this is (var_name,). The value is a dict
+          with a capitalized key describing the allowed value and an allowed
+          value. These dicts store the allowed enum values.
+      attribute_map (dict): The key is attribute name
+          and the value is json key in definition.
+      discriminator_value_class_map (dict): A dict to go from the discriminator
+          variable value to the discriminator class name.
+      validations (dict): The key is the tuple path to the attribute
+          and the for var_name this is (var_name,). The value is a dict
+          that stores validations for max_length, min_length, max_items,
+          min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+          inclusive_minimum, and regex.
+      additional_properties_type (tuple): A tuple of classes accepted
+          as additional properties values.
+    """
+
+    allowed_values = {
+        ('auth_method',): {
+            'NONE': "none",
+            'HEADER': "header",
+            'BASIC': "basic",
+        },
+    }
+
+    validations = {
+    }
+
+    @cached_property
+    def additional_properties_type():
+        """
+        This must be a method because a model may have properties that are
+        of type self, this must run after the class is loaded
+        """
+        return (bool, date, datetime, dict, float, int, list, str, none_type,)  # noqa: E501
+
+    _nullable = False
+
+    @cached_property
+    def openapi_types():
+        """
+        This must be a method because a model may have properties that are
+        of type self, this must run after the class is loaded
+
+        Returns
+            openapi_types (dict): The key is attribute name
+                and the value is attribute type.
+        """
+        return {
+            'auth_method': (str,),  # noqa: E501
+            'basic_password': (str,),  # noqa: E501
+            'basic_user_name': (str,),  # noqa: E501
+            'header_name': (str,),  # noqa: E501
+            'header_value': (str,),  # noqa: E501
+            'mcp_server_uuid': (str,),  # noqa: E501
+            'priority': (int,),  # noqa: E501
+            'url': (str,),  # noqa: E501
+        }
+
+    @cached_property
+    def discriminator():
+        return None
+
+
+    attribute_map = {
+        'auth_method': 'auth_method',  # noqa: E501
+        'basic_password': 'basic_password',  # noqa: E501
+        'basic_user_name': 'basic_user_name',  # noqa: E501
+        'header_name': 'header_name',  # noqa: E501
+        'header_value': 'header_value',  # noqa: E501
+        'mcp_server_uuid': 'mcp_server_uuid',  # noqa: E501
+        'priority': 'priority',  # noqa: E501
+        'url': 'url',  # noqa: E501
+    }
+
+    read_only_vars = {
+    }
+
+    _composed_schemas = {}
+
+    @classmethod
+    @convert_js_args_to_python_args
+    def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
+        """ConversationMcpServer - a model defined in OpenAPI
+
+        Keyword Args:
+            _check_type (bool): if True, values for parameters in openapi_types
+                                will be type checked and a TypeError will be
+                                raised if the wrong type is input.
+                                Defaults to True
+            _path_to_item (tuple/list): This is a list of keys or values to
+                                drill down to the model in received_data
+                                when deserializing a response
+            _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)
+            _configuration (Configuration): the instance to use when
+                                deserializing a file_type parameter.
+                                If passed, type conversion is attempted
+                                If omitted no type conversion is done.
+            _visited_composed_classes (tuple): This stores a tuple of
+                                classes that we have traveled through so that
+                                if we see that class again we will not use its
+                                discriminator again.
+                                When traveling through a discriminator, the
+                                composed schema that is
+                                is traveled through is added to this set.
+                                For example if Animal has a discriminator
+                                petType and we pass in "Dog", and the class Dog
+                                allOf includes Animal, we move through Animal
+                                once using the discriminator, and pick Dog.
+                                Then in Dog, we will make an instance of the
+                                Animal class but this time we won't travel
+                                through its discriminator because we passed in
+                                _visited_composed_classes = (Animal,)
+            auth_method (str): Authorization Method. [optional]  # noqa: E501
+            basic_password (str): Basic password. [optional]  # noqa: E501
+            basic_user_name (str): Basic user name. [optional]  # noqa: E501
+            header_name (str): Header name. [optional]  # noqa: E501
+            header_value (str): Header value. [optional]  # noqa: E501
+            mcp_server_uuid (str): UUID of the MCP server configuration. [optional]  # noqa: E501
+            priority (int): Priority on which the MCP server tools are incorporated into the model.  Lower number comes first. [optional]  # noqa: E501
+            url (str): URL to the MCP server (must be https). [optional]  # noqa: E501
+        """
+
+        _check_type = kwargs.pop('_check_type', True)
+        _spec_property_naming = kwargs.pop('_spec_property_naming', True)
+        _path_to_item = kwargs.pop('_path_to_item', ())
+        _configuration = kwargs.pop('_configuration', None)
+        _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+        self = super(OpenApiModel, cls).__new__(cls)
+
+        if args:
+            for arg in args:
+                if isinstance(arg, dict):
+                    kwargs.update(arg)
+                else:
+                    raise ApiTypeError(
+                        "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+                            args,
+                            self.__class__.__name__,
+                        ),
+                        path_to_item=_path_to_item,
+                        valid_classes=(self.__class__,),
+                    )
+
+        self._data_store = {}
+        self._check_type = _check_type
+        self._spec_property_naming = _spec_property_naming
+        self._path_to_item = _path_to_item
+        self._configuration = _configuration
+        self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+        for var_name, var_value in kwargs.items():
+            if var_name not in self.attribute_map and \
+                        self._configuration is not None and \
+                        self._configuration.discard_unknown_keys and \
+                        self.additional_properties_type is None:
+                # discard variable.
+                continue
+            setattr(self, var_name, var_value)
+        return self
+
+    required_properties = set([
+        '_data_store',
+        '_check_type',
+        '_spec_property_naming',
+        '_path_to_item',
+        '_configuration',
+        '_visited_composed_classes',
+    ])
+
+    @convert_js_args_to_python_args
+    def __init__(self, *args, **kwargs):  # noqa: E501
+        """ConversationMcpServer - a model defined in OpenAPI
+
+        Keyword Args:
+            _check_type (bool): if True, values for parameters in openapi_types
+                                will be type checked and a TypeError will be
+                                raised if the wrong type is input.
+                                Defaults to True
+            _path_to_item (tuple/list): This is a list of keys or values to
+                                drill down to the model in received_data
+                                when deserializing a response
+            _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)
+            _configuration (Configuration): the instance to use when
+                                deserializing a file_type parameter.
+                                If passed, type conversion is attempted
+                                If omitted no type conversion is done.
+            _visited_composed_classes (tuple): This stores a tuple of
+                                classes that we have traveled through so that
+                                if we see that class again we will not use its
+                                discriminator again.
+                                When traveling through a discriminator, the
+                                composed schema that is
+                                is traveled through is added to this set.
+                                For example if Animal has a discriminator
+                                petType and we pass in "Dog", and the class Dog
+                                allOf includes Animal, we move through Animal
+                                once using the discriminator, and pick Dog.
+                                Then in Dog, we will make an instance of the
+                                Animal class but this time we won't travel
+                                through its discriminator because we passed in
+                                _visited_composed_classes = (Animal,)
+            auth_method (str): Authorization Method. [optional]  # noqa: E501
+            basic_password (str): Basic password. [optional]  # noqa: E501
+            basic_user_name (str): Basic user name. [optional]  # noqa: E501
+            header_name (str): Header name. [optional]  # noqa: E501
+            header_value (str): Header value. [optional]  # noqa: E501
+            mcp_server_uuid (str): UUID of the MCP server configuration. [optional]  # noqa: E501
+            priority (int): Priority on which the MCP server tools are incorporated into the model.  Lower number comes first. [optional]  # noqa: E501
+            url (str): URL to the MCP server (must be https). [optional]  # noqa: E501
+        """
+
+        _check_type = kwargs.pop('_check_type', True)
+        _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+        _path_to_item = kwargs.pop('_path_to_item', ())
+        _configuration = kwargs.pop('_configuration', None)
+        _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+        if args:
+            for arg in args:
+                if isinstance(arg, dict):
+                    kwargs.update(arg)
+                else:
+                    raise ApiTypeError(
+                        "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+                            args,
+                            self.__class__.__name__,
+                        ),
+                        path_to_item=_path_to_item,
+                        valid_classes=(self.__class__,),
+                    )
+
+        self._data_store = {}
+        self._check_type = _check_type
+        self._spec_property_naming = _spec_property_naming
+        self._path_to_item = _path_to_item
+        self._configuration = _configuration
+        self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+        for var_name, var_value in kwargs.items():
+            if var_name not in self.attribute_map and \
+                        self._configuration is not None and \
+                        self._configuration.discard_unknown_keys and \
+                        self.additional_properties_type is None:
+                # discard variable.
+                continue
+            setattr(self, var_name, var_value)
+            if var_name in self.read_only_vars:
+                raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+                                     f"class with read only attributes.")