ultracart-rest-sdk 4.0.207__py3-none-any.whl → 4.0.209__py3-none-any.whl

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

ultracart/model/auto_order.py

@@ -118,6 +118,7 @@ class AutoOrder(ModelNormal):
             'items': ([AutoOrderItem],),  # noqa: E501
             'logs': ([AutoOrderLog],),  # noqa: E501
             'management': (AutoOrderManagement,),  # noqa: E501
+            'merchant_id': (str,),  # noqa: E501
             'next_attempt': (str,),  # noqa: E501
             'original_order': (Order,),  # noqa: E501
             'original_order_id': (str,),  # noqa: E501
@@ -150,6 +151,7 @@ class AutoOrder(ModelNormal):
         'items': 'items',  # noqa: E501
         'logs': 'logs',  # noqa: E501
         'management': 'management',  # noqa: E501
+        'merchant_id': 'merchant_id',  # noqa: E501
         'next_attempt': 'next_attempt',  # noqa: E501
         'original_order': 'original_order',  # noqa: E501
         'original_order_id': 'original_order_id',  # noqa: E501
@@ -217,6 +219,7 @@ class AutoOrder(ModelNormal):
             items ([AutoOrderItem]): The items that are setup to rebill. [optional]  # noqa: E501
             logs ([AutoOrderLog]): Logs associated with this auto order. [optional]  # noqa: E501
             management (AutoOrderManagement): [optional]  # noqa: E501
+            merchant_id (str): UltraCart merchant ID owning this order. [optional]  # noqa: E501
             next_attempt (str): The next time that the auto order will be attempted for processing. [optional]  # noqa: E501
             original_order (Order): [optional]  # noqa: E501
             original_order_id (str): The original order id that this auto order is associated with.. [optional]  # noqa: E501
@@ -326,6 +329,7 @@ class AutoOrder(ModelNormal):
             items ([AutoOrderItem]): The items that are setup to rebill. [optional]  # noqa: E501
             logs ([AutoOrderLog]): Logs associated with this auto order. [optional]  # noqa: E501
             management (AutoOrderManagement): [optional]  # noqa: E501
+            merchant_id (str): UltraCart merchant ID owning this order. [optional]  # noqa: E501
             next_attempt (str): The next time that the auto order will be attempted for processing. [optional]  # noqa: E501
             original_order (Order): [optional]  # noqa: E501
             original_order_id (str): The original order id that this auto order is associated with.. [optional]  # noqa: E501

ultracart/model/auto_order_item.py

@@ -122,6 +122,7 @@ class AutoOrderItem(ModelNormal):
             'future_schedules': ([AutoOrderItemFutureSchedule],),  # noqa: E501
             'last_order_dts': (str,),  # noqa: E501
             'life_time_value': (float,),  # noqa: E501
+            'next_item_id': (str,),  # noqa: E501
             'next_preshipment_notice_dts': (str,),  # noqa: E501
             'next_shipment_dts': (str,),  # noqa: E501
             'no_order_after_dts': (str,),  # noqa: E501
@@ -156,6 +157,7 @@ class AutoOrderItem(ModelNormal):
         'future_schedules': 'future_schedules',  # noqa: E501
         'last_order_dts': 'last_order_dts',  # noqa: E501
         'life_time_value': 'life_time_value',  # noqa: E501
+        'next_item_id': 'next_item_id',  # noqa: E501
         'next_preshipment_notice_dts': 'next_preshipment_notice_dts',  # noqa: E501
         'next_shipment_dts': 'next_shipment_dts',  # noqa: E501
         'no_order_after_dts': 'no_order_after_dts',  # noqa: E501
@@ -225,6 +227,7 @@ class AutoOrderItem(ModelNormal):
             future_schedules ([AutoOrderItemFutureSchedule]): The future rebill schedule for this item up to the next ten rebills. [optional]  # noqa: E501
             last_order_dts (str): Date/time of the last order of this item. [optional]  # noqa: E501
             life_time_value (float): The life time value of this item including the original purchase. [optional]  # noqa: E501
+            next_item_id (str): Calculated next item id. [optional]  # noqa: E501
             next_preshipment_notice_dts (str): The date/time of when the next pre-shipment notice should be sent. [optional]  # noqa: E501
             next_shipment_dts (str): Date/time that this item is scheduled to rebill. [optional]  # noqa: E501
             no_order_after_dts (str): Date/time after which no additional rebills of this item should occur. [optional]  # noqa: E501
@@ -336,6 +339,7 @@ class AutoOrderItem(ModelNormal):
             future_schedules ([AutoOrderItemFutureSchedule]): The future rebill schedule for this item up to the next ten rebills. [optional]  # noqa: E501
             last_order_dts (str): Date/time of the last order of this item. [optional]  # noqa: E501
             life_time_value (float): The life time value of this item including the original purchase. [optional]  # noqa: E501
+            next_item_id (str): Calculated next item id. [optional]  # noqa: E501
             next_preshipment_notice_dts (str): The date/time of when the next pre-shipment notice should be sent. [optional]  # noqa: E501
             next_shipment_dts (str): Date/time that this item is scheduled to rebill. [optional]  # noqa: E501
             no_order_after_dts (str): Date/time after which no additional rebills of this item should occur. [optional]  # noqa: E501

ultracart/model/conversation_pbx_phone_number_response.py

@@ -109,7 +109,7 @@ class ConversationPbxPhoneNumberResponse(ModelNormal):
     attribute_map = {
         'error': 'error',  # noqa: E501
         'metadata': 'metadata',  # noqa: E501
-        'phone_number': 'phoneNumber',  # noqa: E501
+        'phone_number': 'phone_number',  # noqa: E501
         'success': 'success',  # noqa: E501
         'warning': 'warning',  # noqa: E501
     }

ultracart/model/conversation_pbx_phone_numbers_response.py

@@ -109,7 +109,7 @@ class ConversationPbxPhoneNumbersResponse(ModelNormal):
     attribute_map = {
         'error': 'error',  # noqa: E501
         'metadata': 'metadata',  # noqa: E501
-        'phone_numbers': 'phoneNumbers',  # noqa: E501
+        'phone_numbers': 'phone_numbers',  # noqa: E501
         'success': 'success',  # noqa: E501
         'warning': 'warning',  # noqa: E501
     }

ultracart/model/conversation_pbx_time_based_response.py

@@ -110,7 +110,7 @@ class ConversationPbxTimeBasedResponse(ModelNormal):
         'error': 'error',  # noqa: E501
         'metadata': 'metadata',  # noqa: E501
         'success': 'success',  # noqa: E501
-        'time_based': 'timeBased',  # noqa: E501
+        'time_based': 'time_based',  # noqa: E501
         'warning': 'warning',  # noqa: E501
     }
 

ultracart/model/conversation_pbx_time_baseds_response.py

@@ -110,7 +110,7 @@ class ConversationPbxTimeBasedsResponse(ModelNormal):
         'error': 'error',  # noqa: E501
         'metadata': 'metadata',  # noqa: E501
         'success': 'success',  # noqa: E501
-        'time_baseds': 'timeBaseds',  # noqa: E501
+        'time_baseds': 'time_baseds',  # noqa: E501
         'warning': 'warning',  # noqa: E501
     }
 

ultracart/model/conversation_pbx_time_range_response.py

@@ -110,7 +110,7 @@ class ConversationPbxTimeRangeResponse(ModelNormal):
         'error': 'error',  # noqa: E501
         'metadata': 'metadata',  # noqa: E501
         'success': 'success',  # noqa: E501
-        'time_range': 'timeRange',  # noqa: E501
+        'time_range': 'time_range',  # noqa: E501
         'warning': 'warning',  # noqa: E501
     }
 

ultracart/model/conversation_pbx_time_ranges_response.py

@@ -110,7 +110,7 @@ class ConversationPbxTimeRangesResponse(ModelNormal):
         'error': 'error',  # noqa: E501
         'metadata': 'metadata',  # noqa: E501
         'success': 'success',  # noqa: E501
-        'time_ranges': 'timeRanges',  # noqa: E501
+        'time_ranges': 'time_ranges',  # noqa: E501
         'warning': 'warning',  # noqa: E501
     }
 

ultracart/model/conversation_pbx_voicemail_mailbox.py

@@ -56,6 +56,10 @@ class ConversationPbxVoicemailMailbox(ModelNormal):
     """
 
     allowed_values = {
+        ('voicemail_mailbox_type',): {
+            'AGENT': "agent",
+            'SHARED': "shared",
+        },
     }
 
     validations = {

ultracart/model/conversation_pbx_voicemail_mailbox_response.py

@@ -110,7 +110,7 @@ class ConversationPbxVoicemailMailboxResponse(ModelNormal):
         'error': 'error',  # noqa: E501
         'metadata': 'metadata',  # noqa: E501
         'success': 'success',  # noqa: E501
-        'voicemail_mailbox': 'voicemailMailbox',  # noqa: E501
+        'voicemail_mailbox': 'voicemail_mailbox',  # noqa: E501
         'warning': 'warning',  # noqa: E501
     }
 

ultracart/model/conversation_pbx_voicemail_mailboxes_response.py

@@ -110,7 +110,7 @@ class ConversationPbxVoicemailMailboxesResponse(ModelNormal):
         'error': 'error',  # noqa: E501
         'metadata': 'metadata',  # noqa: E501
         'success': 'success',  # noqa: E501
-        'voicemail_mailboxes': 'voicemailMailboxes',  # noqa: E501
+        'voicemail_mailboxes': 'voicemail_mailboxes',  # noqa: E501
         'warning': 'warning',  # noqa: E501
     }
 

ultracart/model/conversation_pbx_voicemail_message.py

@@ -0,0 +1,315 @@
+"""
+    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 ConversationPbxVoicemailMessage(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 = {
+        ('recording_status',): {
+            'COMPLETED': "completed",
+        },
+    }
+
+    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 {
+            'call_sid': (str,),  # noqa: E501
+            'duration': (int,),  # noqa: E501
+            '_from': (str,),  # noqa: E501
+            'from_caller_id': (str,),  # noqa: E501
+            'listened': (bool,),  # noqa: E501
+            'merchant_id': (str,),  # noqa: E501
+            'recording_sid': (str,),  # noqa: E501
+            'recording_size_bytes': (int,),  # noqa: E501
+            'recording_status': (str,),  # noqa: E501
+            'recording_url': (str,),  # noqa: E501
+            'transcript_json': (str,),  # noqa: E501
+            'transcript_text': (str,),  # noqa: E501
+            'voicemail_dts': (str,),  # noqa: E501
+        }
+
+    @cached_property
+    def discriminator():
+        return None
+
+
+    attribute_map = {
+        'call_sid': 'call_sid',  # noqa: E501
+        'duration': 'duration',  # noqa: E501
+        '_from': 'from',  # noqa: E501
+        'from_caller_id': 'from_caller_id',  # noqa: E501
+        'listened': 'listened',  # noqa: E501
+        'merchant_id': 'merchant_id',  # noqa: E501
+        'recording_sid': 'recording_sid',  # noqa: E501
+        'recording_size_bytes': 'recording_size_bytes',  # noqa: E501
+        'recording_status': 'recording_status',  # noqa: E501
+        'recording_url': 'recording_url',  # noqa: E501
+        'transcript_json': 'transcript_json',  # noqa: E501
+        'transcript_text': 'transcript_text',  # noqa: E501
+        'voicemail_dts': 'voicemail_dts',  # noqa: E501
+    }
+
+    read_only_vars = {
+    }
+
+    _composed_schemas = {}
+
+    @classmethod
+    @convert_js_args_to_python_args
+    def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
+        """ConversationPbxVoicemailMessage - 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,)
+            call_sid (str): Call SID. [optional]  # noqa: E501
+            duration (int): Duration in seconds. [optional]  # noqa: E501
+            _from (str): From phone number in E.164. [optional]  # noqa: E501
+            from_caller_id (str): From caller id (if available). [optional]  # noqa: E501
+            listened (bool): True if the voicemail has been listened to in the user interface. [optional]  # noqa: E501
+            merchant_id (str): Merchant ID. [optional]  # noqa: E501
+            recording_sid (str): Recording SID. [optional]  # noqa: E501
+            recording_size_bytes (int): Recording size in bytes. [optional]  # noqa: E501
+            recording_status (str): Recording Status. [optional] if omitted the server will use the default value of "completed"  # noqa: E501
+            recording_url (str): Recording URL (expires in 4 hours). [optional]  # noqa: E501
+            transcript_json (str): JSON version of the transcript. [optional]  # noqa: E501
+            transcript_text (str): Formatted text of the transcript. [optional]  # noqa: E501
+            voicemail_dts (str): Voicemail date/time. [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
+        """ConversationPbxVoicemailMessage - 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,)
+            call_sid (str): Call SID. [optional]  # noqa: E501
+            duration (int): Duration in seconds. [optional]  # noqa: E501
+            _from (str): From phone number in E.164. [optional]  # noqa: E501
+            from_caller_id (str): From caller id (if available). [optional]  # noqa: E501
+            listened (bool): True if the voicemail has been listened to in the user interface. [optional]  # noqa: E501
+            merchant_id (str): Merchant ID. [optional]  # noqa: E501
+            recording_sid (str): Recording SID. [optional]  # noqa: E501
+            recording_size_bytes (int): Recording size in bytes. [optional]  # noqa: E501
+            recording_status (str): Recording Status. [optional] if omitted the server will use the default value of "completed"  # noqa: E501
+            recording_url (str): Recording URL (expires in 4 hours). [optional]  # noqa: E501
+            transcript_json (str): JSON version of the transcript. [optional]  # noqa: E501
+            transcript_text (str): Formatted text of the transcript. [optional]  # noqa: E501
+            voicemail_dts (str): Voicemail date/time. [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.")