ultracart-rest-sdk 4.1.41__py3-none-any.whl → 4.1.54__py3-none-any.whl

ultracart/model/conversation_pbx_available_phone_number.py

@@ -108,6 +108,7 @@ class ConversationPbxAvailablePhoneNumber(ModelNormal):
             'friendly_name': (str,),  # noqa: E501
             'locality': (str,),  # noqa: E501
             'mms': (bool,),  # noqa: E501
+            'monthly_cost': (float,),  # noqa: E501
             'phone_number': (str,),  # noqa: E501
             'region': (str,),  # noqa: E501
             'sms': (bool,),  # noqa: E501
@@ -125,6 +126,7 @@ class ConversationPbxAvailablePhoneNumber(ModelNormal):
         'friendly_name': 'friendly_name',  # noqa: E501
         'locality': 'locality',  # noqa: E501
         'mms': 'mms',  # noqa: E501
+        'monthly_cost': 'monthly_cost',  # noqa: E501
         'phone_number': 'phone_number',  # noqa: E501
         'region': 'region',  # noqa: E501
         'sms': 'sms',  # noqa: E501
@@ -177,6 +179,7 @@ class ConversationPbxAvailablePhoneNumber(ModelNormal):
             friendly_name (str): Friendly formatted phone number. [optional]  # noqa: E501
             locality (str): City/Locality. [optional]  # noqa: E501
             mms (bool): MMS capability. [optional]  # noqa: E501
+            monthly_cost (float): Monthly cost for this phone number. [optional]  # noqa: E501
             phone_number (str): Phone number in E.164 format. [optional]  # noqa: E501
             region (str): State/Province/Region. [optional]  # noqa: E501
             sms (bool): SMS capability. [optional]  # noqa: E501
@@ -271,6 +274,7 @@ class ConversationPbxAvailablePhoneNumber(ModelNormal):
             friendly_name (str): Friendly formatted phone number. [optional]  # noqa: E501
             locality (str): City/Locality. [optional]  # noqa: E501
             mms (bool): MMS capability. [optional]  # noqa: E501
+            monthly_cost (float): Monthly cost for this phone number. [optional]  # noqa: E501
             phone_number (str): Phone number in E.164 format. [optional]  # noqa: E501
             region (str): State/Province/Region. [optional]  # noqa: E501
             sms (bool): SMS capability. [optional]  # noqa: E501

ultracart/model/conversation_pbx_call.py

@@ -0,0 +1,370 @@
+"""
+    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
+
+
+def lazy_import():
+    from ultracart.model.conversation_pbx_call_agent import ConversationPbxCallAgent
+    from ultracart.model.conversation_pbx_call_ai_engagement import ConversationPbxCallAiEngagement
+    from ultracart.model.conversation_pbx_call_caller import ConversationPbxCallCaller
+    from ultracart.model.conversation_pbx_call_financial import ConversationPbxCallFinancial
+    from ultracart.model.conversation_pbx_call_hold import ConversationPbxCallHold
+    from ultracart.model.conversation_pbx_call_recording import ConversationPbxCallRecording
+    from ultracart.model.conversation_pbx_call_routing import ConversationPbxCallRouting
+    from ultracart.model.conversation_pbx_call_timeline import ConversationPbxCallTimeline
+    from ultracart.model.conversation_pbx_call_transfer import ConversationPbxCallTransfer
+    globals()['ConversationPbxCallAgent'] = ConversationPbxCallAgent
+    globals()['ConversationPbxCallAiEngagement'] = ConversationPbxCallAiEngagement
+    globals()['ConversationPbxCallCaller'] = ConversationPbxCallCaller
+    globals()['ConversationPbxCallFinancial'] = ConversationPbxCallFinancial
+    globals()['ConversationPbxCallHold'] = ConversationPbxCallHold
+    globals()['ConversationPbxCallRecording'] = ConversationPbxCallRecording
+    globals()['ConversationPbxCallRouting'] = ConversationPbxCallRouting
+    globals()['ConversationPbxCallTimeline'] = ConversationPbxCallTimeline
+    globals()['ConversationPbxCallTransfer'] = ConversationPbxCallTransfer
+
+
+class ConversationPbxCall(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
+        """
+        lazy_import()
+        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.
+        """
+        lazy_import()
+        return {
+            'account_sid': (str,),  # noqa: E501
+            'agents': ([ConversationPbxCallAgent],),  # noqa: E501
+            'ai_agent_engagements': ([ConversationPbxCallAiEngagement],),  # noqa: E501
+            'call_sid': (str,),  # noqa: E501
+            'call_uuid': (str,),  # noqa: E501
+            'caller': (ConversationPbxCallCaller,),  # noqa: E501
+            'conference_sid': (str,),  # noqa: E501
+            'created_at_dts': (str,),  # noqa: E501
+            'customer_name': (str,),  # noqa: E501
+            'customer_profile_oid': (str,),  # noqa: E501
+            'disposition': (str,),  # noqa: E501
+            'email': (str,),  # noqa: E501
+            'financial': (ConversationPbxCallFinancial,),  # noqa: E501
+            'holds': ([ConversationPbxCallHold],),  # noqa: E501
+            'merchant_id': (str,),  # noqa: E501
+            'recording_sids': ([str],),  # noqa: E501
+            'recordings': ([ConversationPbxCallRecording],),  # noqa: E501
+            'routing': (ConversationPbxCallRouting,),  # noqa: E501
+            'status': (str,),  # noqa: E501
+            'timeline': (ConversationPbxCallTimeline,),  # noqa: E501
+            'transfers': ([ConversationPbxCallTransfer],),  # noqa: E501
+            'updated_at_dts': (str,),  # noqa: E501
+        }
+
+    @cached_property
+    def discriminator():
+        return None
+
+
+    attribute_map = {
+        'account_sid': 'account_sid',  # noqa: E501
+        'agents': 'agents',  # noqa: E501
+        'ai_agent_engagements': 'ai_agent_engagements',  # noqa: E501
+        'call_sid': 'call_sid',  # noqa: E501
+        'call_uuid': 'call_uuid',  # noqa: E501
+        'caller': 'caller',  # noqa: E501
+        'conference_sid': 'conference_sid',  # noqa: E501
+        'created_at_dts': 'created_at_dts',  # noqa: E501
+        'customer_name': 'customer_name',  # noqa: E501
+        'customer_profile_oid': 'customer_profile_oid',  # noqa: E501
+        'disposition': 'disposition',  # noqa: E501
+        'email': 'email',  # noqa: E501
+        'financial': 'financial',  # noqa: E501
+        'holds': 'holds',  # noqa: E501
+        'merchant_id': 'merchant_id',  # noqa: E501
+        'recording_sids': 'recording_sids',  # noqa: E501
+        'recordings': 'recordings',  # noqa: E501
+        'routing': 'routing',  # noqa: E501
+        'status': 'status',  # noqa: E501
+        'timeline': 'timeline',  # noqa: E501
+        'transfers': 'transfers',  # noqa: E501
+        'updated_at_dts': 'updated_at_dts',  # noqa: E501
+    }
+
+    read_only_vars = {
+    }
+
+    _composed_schemas = {}
+
+    @classmethod
+    @convert_js_args_to_python_args
+    def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
+        """ConversationPbxCall - 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,)
+            account_sid (str): Twilio account SID. [optional]  # noqa: E501
+            agents ([ConversationPbxCallAgent]): List of agents who participated in this call. [optional]  # noqa: E501
+            ai_agent_engagements ([ConversationPbxCallAiEngagement]): List of AI agent engagements during the call. [optional]  # noqa: E501
+            call_sid (str): Twilio call SID for the primary (customer) call leg. [optional]  # noqa: E501
+            call_uuid (str): Unique identifier for this call record. [optional]  # noqa: E501
+            caller (ConversationPbxCallCaller): [optional]  # noqa: E501
+            conference_sid (str): Twilio conference SID if this call used conferencing. [optional]  # noqa: E501
+            created_at_dts (str): Timestamp when the call record was created. [optional]  # noqa: E501
+            customer_name (str): Customer name associated with this call. [optional]  # noqa: E501
+            customer_profile_oid (str): UltraCart customer profile OID if the caller was matched to a customer. [optional]  # noqa: E501
+            disposition (str): Call disposition describing how the call ended. [optional]  # noqa: E501
+            email (str): Email address of the caller if known. [optional]  # noqa: E501
+            financial (ConversationPbxCallFinancial): [optional]  # noqa: E501
+            holds ([ConversationPbxCallHold]): List of hold events during the call. [optional]  # noqa: E501
+            merchant_id (str): Merchant identifier. [optional]  # noqa: E501
+            recording_sids ([str]): List of all Twilio recording SIDs associated with this call. [optional]  # noqa: E501
+            recordings ([ConversationPbxCallRecording]): List of recordings made during the call. [optional]  # noqa: E501
+            routing (ConversationPbxCallRouting): [optional]  # noqa: E501
+            status (str): Final status of the call. [optional]  # noqa: E501
+            timeline (ConversationPbxCallTimeline): [optional]  # noqa: E501
+            transfers ([ConversationPbxCallTransfer]): List of transfer events during the call. [optional]  # noqa: E501
+            updated_at_dts (str): Timestamp when the call record was last updated. [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
+        """ConversationPbxCall - 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,)
+            account_sid (str): Twilio account SID. [optional]  # noqa: E501
+            agents ([ConversationPbxCallAgent]): List of agents who participated in this call. [optional]  # noqa: E501
+            ai_agent_engagements ([ConversationPbxCallAiEngagement]): List of AI agent engagements during the call. [optional]  # noqa: E501
+            call_sid (str): Twilio call SID for the primary (customer) call leg. [optional]  # noqa: E501
+            call_uuid (str): Unique identifier for this call record. [optional]  # noqa: E501
+            caller (ConversationPbxCallCaller): [optional]  # noqa: E501
+            conference_sid (str): Twilio conference SID if this call used conferencing. [optional]  # noqa: E501
+            created_at_dts (str): Timestamp when the call record was created. [optional]  # noqa: E501
+            customer_name (str): Customer name associated with this call. [optional]  # noqa: E501
+            customer_profile_oid (str): UltraCart customer profile OID if the caller was matched to a customer. [optional]  # noqa: E501
+            disposition (str): Call disposition describing how the call ended. [optional]  # noqa: E501
+            email (str): Email address of the caller if known. [optional]  # noqa: E501
+            financial (ConversationPbxCallFinancial): [optional]  # noqa: E501
+            holds ([ConversationPbxCallHold]): List of hold events during the call. [optional]  # noqa: E501
+            merchant_id (str): Merchant identifier. [optional]  # noqa: E501
+            recording_sids ([str]): List of all Twilio recording SIDs associated with this call. [optional]  # noqa: E501
+            recordings ([ConversationPbxCallRecording]): List of recordings made during the call. [optional]  # noqa: E501
+            routing (ConversationPbxCallRouting): [optional]  # noqa: E501
+            status (str): Final status of the call. [optional]  # noqa: E501
+            timeline (ConversationPbxCallTimeline): [optional]  # noqa: E501
+            transfers ([ConversationPbxCallTransfer]): List of transfer events during the call. [optional]  # noqa: E501
+            updated_at_dts (str): Timestamp when the call record was last updated. [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.")