ultracart-rest-sdk 4.1.18__tar.gz → 4.1.19__tar.gz

{ultracart_rest_sdk-4.1.18 → ultracart_rest_sdk-4.1.19}/PKG-INFO

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

{ultracart_rest_sdk-4.1.18 → ultracart_rest_sdk-4.1.19}/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.18
+- Package version: 4.1.19
 - 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,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.19 | 08/04/2025 | conversations api - add zoho departments to getCapabilities call |
 | 4.1.18 | 08/04/2025 | more internal development on loyalty step for storefront flows |
 | 4.1.17 | 08/04/2025 | small changes to internal flow app to support loyalty tier moves |
 | 4.1.16 | 07/28/2025 | updated doc samples |

{ultracart_rest_sdk-4.1.18 → ultracart_rest_sdk-4.1.19}/setup.py

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

{ultracart_rest_sdk-4.1.18 → ultracart_rest_sdk-4.1.19}/ultracart/__init__.py

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

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

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

{ultracart_rest_sdk-4.1.18 → ultracart_rest_sdk-4.1.19}/ultracart/model/conversation_virtual_agent_capabilities.py

@@ -30,6 +30,10 @@ from ultracart.model_utils import (  # noqa: F401
 from ultracart.exceptions import ApiAttributeError
 
 
+def lazy_import():
+    from ultracart.model.conversation_virtual_agent_capability_zoho_desk_department import ConversationVirtualAgentCapabilityZohoDeskDepartment
+    globals()['ConversationVirtualAgentCapabilityZohoDeskDepartment'] = ConversationVirtualAgentCapabilityZohoDeskDepartment
+
 
 class ConversationVirtualAgentCapabilities(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
@@ -59,8 +63,8 @@ class ConversationVirtualAgentCapabilities(ModelNormal):
         ('open_support_ticket_channel',): {
             'NONE': "none",
             'EMAIL': "email",
-            'ULTRACART_TASK': "UltraCart Task",
-            'ZOHO_DESK_TICKET': "Zoho Desk Ticket",
+            'ULTRACART_TASK': "ultracart_task",
+            'ZOHO_DESK_TICKET': "zoho_desk_ticket",
         },
     }
 
@@ -73,6 +77,7 @@ class ConversationVirtualAgentCapabilities(ModelNormal):
         This must be a method because a model may have properties that are
         of type self, this must run after the class is loaded
         """
+        lazy_import()
         return (bool, date, datetime, dict, float, int, list, str, none_type,)  # noqa: E501
 
     _nullable = False
@@ -87,6 +92,7 @@ class ConversationVirtualAgentCapabilities(ModelNormal):
             openapi_types (dict): The key is attribute name
                 and the value is attribute type.
         """
+        lazy_import()
         return {
             'cancel_subscription': (bool,),  # noqa: E501
             'delay_subscription': (bool,),  # noqa: E501
@@ -95,10 +101,13 @@ class ConversationVirtualAgentCapabilities(ModelNormal):
             'open_support_ticket': (bool,),  # noqa: E501
             'open_support_ticket_channel': (str,),  # noqa: E501
             'open_support_ticket_channel_email': (str,),  # noqa: E501
+            'open_support_ticket_zoho_desk_department_id': (str,),  # noqa: E501
             'pause_subscription': (bool,),  # noqa: E501
             'resume_subscription': (bool,),  # noqa: E501
             'transfer_chat_to_live_agent': (bool,),  # noqa: E501
             'update_subscription_credit_card': (bool,),  # noqa: E501
+            'zoho_desk_available': (bool,),  # noqa: E501
+            'zoho_desk_departments': ([ConversationVirtualAgentCapabilityZohoDeskDepartment],),  # noqa: E501
         }
 
     @cached_property
@@ -114,10 +123,13 @@ class ConversationVirtualAgentCapabilities(ModelNormal):
         'open_support_ticket': 'open_support_ticket',  # noqa: E501
         'open_support_ticket_channel': 'open_support_ticket_channel',  # noqa: E501
         'open_support_ticket_channel_email': 'open_support_ticket_channel_email',  # noqa: E501
+        'open_support_ticket_zoho_desk_department_id': 'open_support_ticket_zoho_desk_department_id',  # noqa: E501
         'pause_subscription': 'pause_subscription',  # noqa: E501
         'resume_subscription': 'resume_subscription',  # noqa: E501
         'transfer_chat_to_live_agent': 'transfer_chat_to_live_agent',  # noqa: E501
         'update_subscription_credit_card': 'update_subscription_credit_card',  # noqa: E501
+        'zoho_desk_available': 'zoho_desk_available',  # noqa: E501
+        'zoho_desk_departments': 'zoho_desk_departments',  # noqa: E501
     }
 
     read_only_vars = {
@@ -168,10 +180,13 @@ class ConversationVirtualAgentCapabilities(ModelNormal):
             open_support_ticket (bool): [optional]  # noqa: E501
             open_support_ticket_channel (str): Channel to use to open the support ticket. [optional]  # noqa: E501
             open_support_ticket_channel_email (str): Email to send support ticket to. [optional]  # noqa: E501
+            open_support_ticket_zoho_desk_department_id (str): Department ID to open a Zoho Desk ticket for. [optional]  # noqa: E501
             pause_subscription (bool): [optional]  # noqa: E501
             resume_subscription (bool): [optional]  # noqa: E501
             transfer_chat_to_live_agent (bool): [optional]  # noqa: E501
             update_subscription_credit_card (bool): [optional]  # noqa: E501
+            zoho_desk_available (bool): True if Zoho Desk is connected to UltraCart. [optional]  # noqa: E501
+            zoho_desk_departments ([ConversationVirtualAgentCapabilityZohoDeskDepartment]): Array of Zoho Desk Department if zoho desk is connected to UltraCart. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -264,10 +279,13 @@ class ConversationVirtualAgentCapabilities(ModelNormal):
             open_support_ticket (bool): [optional]  # noqa: E501
             open_support_ticket_channel (str): Channel to use to open the support ticket. [optional]  # noqa: E501
             open_support_ticket_channel_email (str): Email to send support ticket to. [optional]  # noqa: E501
+            open_support_ticket_zoho_desk_department_id (str): Department ID to open a Zoho Desk ticket for. [optional]  # noqa: E501
             pause_subscription (bool): [optional]  # noqa: E501
             resume_subscription (bool): [optional]  # noqa: E501
             transfer_chat_to_live_agent (bool): [optional]  # noqa: E501
             update_subscription_credit_card (bool): [optional]  # noqa: E501
+            zoho_desk_available (bool): True if Zoho Desk is connected to UltraCart. [optional]  # noqa: E501
+            zoho_desk_departments ([ConversationVirtualAgentCapabilityZohoDeskDepartment]): Array of Zoho Desk Department if zoho desk is connected to UltraCart. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)

ultracart_rest_sdk-4.1.19/ultracart/model/conversation_virtual_agent_capability_zoho_desk_department.py

@@ -0,0 +1,268 @@
+"""
+    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 ConversationVirtualAgentCapabilityZohoDeskDepartment(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 = {
+    }
+
+    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 {
+            'department_id': (str,),  # noqa: E501
+            'department_name': (str,),  # noqa: E501
+        }
+
+    @cached_property
+    def discriminator():
+        return None
+
+
+    attribute_map = {
+        'department_id': 'department_id',  # noqa: E501
+        'department_name': 'department_name',  # noqa: E501
+    }
+
+    read_only_vars = {
+    }
+
+    _composed_schemas = {}
+
+    @classmethod
+    @convert_js_args_to_python_args
+    def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
+        """ConversationVirtualAgentCapabilityZohoDeskDepartment - 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,)
+            department_id (str): [optional]  # noqa: E501
+            department_name (str): [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
+        """ConversationVirtualAgentCapabilityZohoDeskDepartment - 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,)
+            department_id (str): [optional]  # noqa: E501
+            department_name (str): [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.")

{ultracart_rest_sdk-4.1.18 → ultracart_rest_sdk-4.1.19}/ultracart/model/custom_dashboard.py

@@ -31,7 +31,9 @@ from ultracart.exceptions import ApiAttributeError
 
 
 def lazy_import():
+    from ultracart.model.custom_dashboard_execution_parameter import CustomDashboardExecutionParameter
     from ultracart.model.custom_dashboard_page import CustomDashboardPage
+    globals()['CustomDashboardExecutionParameter'] = CustomDashboardExecutionParameter
     globals()['CustomDashboardPage'] = CustomDashboardPage
 
 
@@ -92,6 +94,7 @@ class CustomDashboard(ModelNormal):
             'merchant_id': (str,),  # noqa: E501
             'name': (str,),  # noqa: E501
             'pages': ([CustomDashboardPage],),  # noqa: E501
+            'parameters': ([CustomDashboardExecutionParameter],),  # noqa: E501
         }
 
     @cached_property
@@ -104,6 +107,7 @@ class CustomDashboard(ModelNormal):
         'merchant_id': 'merchant_id',  # noqa: E501
         'name': 'name',  # noqa: E501
         'pages': 'pages',  # noqa: E501
+        'parameters': 'parameters',  # noqa: E501
     }
 
     read_only_vars = {
@@ -151,6 +155,7 @@ class CustomDashboard(ModelNormal):
             merchant_id (str): [optional]  # noqa: E501
             name (str): [optional]  # noqa: E501
             pages ([CustomDashboardPage]): [optional]  # noqa: E501
+            parameters ([CustomDashboardExecutionParameter]): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -240,6 +245,7 @@ class CustomDashboard(ModelNormal):
             merchant_id (str): [optional]  # noqa: E501
             name (str): [optional]  # noqa: E501
             pages ([CustomDashboardPage]): [optional]  # noqa: E501
+            parameters ([CustomDashboardExecutionParameter]): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)