ultracart-rest-sdk 3.11.56__py3-none-any.whl → 3.11.57__py3-none-any.whl

ultracart/models/conversation_agent_auth.py

@@ -35,6 +35,7 @@ class ConversationAgentAuth(object):
         'chat_user': 'bool',
         'conversation_participant_arn': 'str',
         'conversation_participant_name': 'str',
+        'default_phone_number': 'str',
         'group_ids': 'list[int]',
         'jwt': 'str',
         'merchant_id': 'str',
@@ -56,6 +57,7 @@ class ConversationAgentAuth(object):
         'chat_user': 'chat_user',
         'conversation_participant_arn': 'conversation_participant_arn',
         'conversation_participant_name': 'conversation_participant_name',
+        'default_phone_number': 'default_phone_number',
         'group_ids': 'group_ids',
         'jwt': 'jwt',
         'merchant_id': 'merchant_id',
@@ -72,13 +74,14 @@ class ConversationAgentAuth(object):
         'websocket_url': 'websocket_url'
     }
 
-    def __init__(self, chat_admin=None, chat_user=None, conversation_participant_arn=None, conversation_participant_name=None, group_ids=None, jwt=None, merchant_id=None, pbx_admin=None, pbx_jwt=None, pbx_supervisor=None, pbx_user=None, pbx_voice_identity=None, pbx_voice_token=None, pbx_worker_token=None, pbx_worker_token_v2=None, twilio_accounts=None, user_id=None, websocket_url=None):  # noqa: E501
+    def __init__(self, chat_admin=None, chat_user=None, conversation_participant_arn=None, conversation_participant_name=None, default_phone_number=None, group_ids=None, jwt=None, merchant_id=None, pbx_admin=None, pbx_jwt=None, pbx_supervisor=None, pbx_user=None, pbx_voice_identity=None, pbx_voice_token=None, pbx_worker_token=None, pbx_worker_token_v2=None, twilio_accounts=None, user_id=None, websocket_url=None):  # noqa: E501
         """ConversationAgentAuth - a model defined in Swagger"""  # noqa: E501
 
         self._chat_admin = None
         self._chat_user = None
         self._conversation_participant_arn = None
         self._conversation_participant_name = None
+        self._default_phone_number = None
         self._group_ids = None
         self._jwt = None
         self._merchant_id = None
@@ -103,6 +106,8 @@ class ConversationAgentAuth(object):
             self.conversation_participant_arn = conversation_participant_arn
         if conversation_participant_name is not None:
             self.conversation_participant_name = conversation_participant_name
+        if default_phone_number is not None:
+            self.default_phone_number = default_phone_number
         if group_ids is not None:
             self.group_ids = group_ids
         if jwt is not None:
@@ -216,6 +221,29 @@ class ConversationAgentAuth(object):
 
         self._conversation_participant_name = conversation_participant_name
 
+    @property
+    def default_phone_number(self):
+        """Gets the default_phone_number of this ConversationAgentAuth.  # noqa: E501
+
+        The default phone number this agent should use when making an outbound call.  # noqa: E501
+
+        :return: The default_phone_number of this ConversationAgentAuth.  # noqa: E501
+        :rtype: str
+        """
+        return self._default_phone_number
+
+    @default_phone_number.setter
+    def default_phone_number(self, default_phone_number):
+        """Sets the default_phone_number of this ConversationAgentAuth.
+
+        The default phone number this agent should use when making an outbound call.  # noqa: E501
+
+        :param default_phone_number: The default_phone_number of this ConversationAgentAuth.  # noqa: E501
+        :type: str
+        """
+
+        self._default_phone_number = default_phone_number
+
     @property
     def group_ids(self):
         """Gets the group_ids of this ConversationAgentAuth.  # noqa: E501

ultracart/models/conversation_pbx_agent.py

@@ -35,6 +35,7 @@ class ConversationPbxAgent(object):
         'call_routing_preference': 'str',
         'cellphone': 'str',
         'conversation_pbx_agent_uuid': 'str',
+        'cos_uuid': 'str',
         'default_phone_number_uuid': 'str',
         'extension': 'int',
         'full_name': 'str',
@@ -58,6 +59,7 @@ class ConversationPbxAgent(object):
         'call_routing_preference': 'call_routing_preference',
         'cellphone': 'cellphone',
         'conversation_pbx_agent_uuid': 'conversation_pbx_agent_uuid',
+        'cos_uuid': 'cos_uuid',
         'default_phone_number_uuid': 'default_phone_number_uuid',
         'extension': 'extension',
         'full_name': 'full_name',
@@ -76,13 +78,14 @@ class ConversationPbxAgent(object):
         'voicemail': 'voicemail'
     }
 
-    def __init__(self, ai=None, call_routing_preference=None, cellphone=None, conversation_pbx_agent_uuid=None, default_phone_number_uuid=None, extension=None, full_name=None, hardware_phone_uuids=None, login=None, merchant_id=None, personal_conversation_pbx_voicemail_mailbox_uuid=None, preferred_hardware_phone_uuid=None, record_outgoing_automatically=None, shared_conversation_pbx_voicemail_mailbox_uuid=None, twilio_taskrouter_worker_id=None, unavailable_play_audio_uuid=None, unavailable_say=None, unavailable_say_voice=None, user_id=None, voicemail=None):  # noqa: E501
+    def __init__(self, ai=None, call_routing_preference=None, cellphone=None, conversation_pbx_agent_uuid=None, cos_uuid=None, default_phone_number_uuid=None, extension=None, full_name=None, hardware_phone_uuids=None, login=None, merchant_id=None, personal_conversation_pbx_voicemail_mailbox_uuid=None, preferred_hardware_phone_uuid=None, record_outgoing_automatically=None, shared_conversation_pbx_voicemail_mailbox_uuid=None, twilio_taskrouter_worker_id=None, unavailable_play_audio_uuid=None, unavailable_say=None, unavailable_say_voice=None, user_id=None, voicemail=None):  # noqa: E501
         """ConversationPbxAgent - a model defined in Swagger"""  # noqa: E501
 
         self._ai = None
         self._call_routing_preference = None
         self._cellphone = None
         self._conversation_pbx_agent_uuid = None
+        self._cos_uuid = None
         self._default_phone_number_uuid = None
         self._extension = None
         self._full_name = None
@@ -109,6 +112,8 @@ class ConversationPbxAgent(object):
             self.cellphone = cellphone
         if conversation_pbx_agent_uuid is not None:
             self.conversation_pbx_agent_uuid = conversation_pbx_agent_uuid
+        if cos_uuid is not None:
+            self.cos_uuid = cos_uuid
         if default_phone_number_uuid is not None:
             self.default_phone_number_uuid = default_phone_number_uuid
         if extension is not None:
@@ -242,6 +247,29 @@ class ConversationPbxAgent(object):
 
         self._conversation_pbx_agent_uuid = conversation_pbx_agent_uuid
 
+    @property
+    def cos_uuid(self):
+        """Gets the cos_uuid of this ConversationPbxAgent.  # noqa: E501
+
+        Class of Service UUID. If null, the merchant default CoS applies.  # noqa: E501
+
+        :return: The cos_uuid of this ConversationPbxAgent.  # noqa: E501
+        :rtype: str
+        """
+        return self._cos_uuid
+
+    @cos_uuid.setter
+    def cos_uuid(self, cos_uuid):
+        """Sets the cos_uuid of this ConversationPbxAgent.
+
+        Class of Service UUID. If null, the merchant default CoS applies.  # noqa: E501
+
+        :param cos_uuid: The cos_uuid of this ConversationPbxAgent.  # noqa: E501
+        :type: str
+        """
+
+        self._cos_uuid = cos_uuid
+
     @property
     def default_phone_number_uuid(self):
         """Gets the default_phone_number_uuid of this ConversationPbxAgent.  # noqa: E501
@@ -571,8 +599,12 @@ class ConversationPbxAgent(object):
         :param unavailable_say_voice: The unavailable_say_voice of this ConversationPbxAgent.  # noqa: E501
         :type: str
         """
-        if unavailable_say_voice is not None and len(unavailable_say_voice) > 50:
-            raise ValueError("Invalid value for `unavailable_say_voice`, length must be less than or equal to `50`")  # noqa: E501
+        allowed_values = ["man", "woman"]  # noqa: E501
+        if unavailable_say_voice not in allowed_values:
+            raise ValueError(
+                "Invalid value for `unavailable_say_voice` ({0}), must be one of {1}"  # noqa: E501
+                .format(unavailable_say_voice, allowed_values)
+            )
 
         self._unavailable_say_voice = unavailable_say_voice
 

ultracart/models/conversation_pbx_call_recording.py

@@ -34,6 +34,7 @@ class ConversationPbxCallRecording(object):
         'channels': 'int',
         'duration_seconds': 'int',
         'is_primary': 'bool',
+        'recording_s3_key': 'str',
         'recording_sid': 'str',
         'recording_url': 'str',
         'status': 'str',
@@ -44,18 +45,20 @@ class ConversationPbxCallRecording(object):
         'channels': 'channels',
         'duration_seconds': 'duration_seconds',
         'is_primary': 'is_primary',
+        'recording_s3_key': 'recording_s3_key',
         'recording_sid': 'recording_sid',
         'recording_url': 'recording_url',
         'status': 'status',
         'transcript': 'transcript'
     }
 
-    def __init__(self, channels=None, duration_seconds=None, is_primary=None, recording_sid=None, recording_url=None, status=None, transcript=None):  # noqa: E501
+    def __init__(self, channels=None, duration_seconds=None, is_primary=None, recording_s3_key=None, recording_sid=None, recording_url=None, status=None, transcript=None):  # noqa: E501
         """ConversationPbxCallRecording - a model defined in Swagger"""  # noqa: E501
 
         self._channels = None
         self._duration_seconds = None
         self._is_primary = None
+        self._recording_s3_key = None
         self._recording_sid = None
         self._recording_url = None
         self._status = None
@@ -68,6 +71,8 @@ class ConversationPbxCallRecording(object):
             self.duration_seconds = duration_seconds
         if is_primary is not None:
             self.is_primary = is_primary
+        if recording_s3_key is not None:
+            self.recording_s3_key = recording_s3_key
         if recording_sid is not None:
             self.recording_sid = recording_sid
         if recording_url is not None:
@@ -146,6 +151,29 @@ class ConversationPbxCallRecording(object):
 
         self._is_primary = is_primary
 
+    @property
+    def recording_s3_key(self):
+        """Gets the recording_s3_key of this ConversationPbxCallRecording.  # noqa: E501
+
+        S3 key for the recording audio file  # noqa: E501
+
+        :return: The recording_s3_key of this ConversationPbxCallRecording.  # noqa: E501
+        :rtype: str
+        """
+        return self._recording_s3_key
+
+    @recording_s3_key.setter
+    def recording_s3_key(self, recording_s3_key):
+        """Sets the recording_s3_key of this ConversationPbxCallRecording.
+
+        S3 key for the recording audio file  # noqa: E501
+
+        :param recording_s3_key: The recording_s3_key of this ConversationPbxCallRecording.  # noqa: E501
+        :type: str
+        """
+
+        self._recording_s3_key = recording_s3_key
+
     @property
     def recording_sid(self):
         """Gets the recording_sid of this ConversationPbxCallRecording.  # noqa: E501

ultracart/models/conversation_pbx_class_of_service.py

@@ -0,0 +1,347 @@
+# coding: utf-8
+
+"""
+    UltraCart Rest API V2
+
+    UltraCart REST API Version 2  # noqa: E501
+
+    OpenAPI spec version: 2.0.0
+    Contact: support@ultracart.com
+    Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+
+import pprint
+import re  # noqa: F401
+
+import six
+
+
+class ConversationPbxClassOfService(object):
+    """NOTE: This class is auto generated by the swagger code generator program.
+
+    Do not edit the class manually.
+    """
+
+    """
+    Attributes:
+      swagger_types (dict): The key is attribute name
+                            and the value is attribute type.
+      attribute_map (dict): The key is attribute name
+                            and the value is json key in definition.
+    """
+    swagger_types = {
+        'allowed_countries': 'list[str]',
+        'block_premium_numbers': 'bool',
+        'conversation_pbx_class_of_service_uuid': 'str',
+        'default_flag': 'bool',
+        'description': 'str',
+        'merchant_id': 'str',
+        'name': 'str',
+        'outbound_enabled': 'bool',
+        'time_range_uuid': 'str'
+    }
+
+    attribute_map = {
+        'allowed_countries': 'allowed_countries',
+        'block_premium_numbers': 'block_premium_numbers',
+        'conversation_pbx_class_of_service_uuid': 'conversation_pbx_class_of_service_uuid',
+        'default_flag': 'default_flag',
+        'description': 'description',
+        'merchant_id': 'merchant_id',
+        'name': 'name',
+        'outbound_enabled': 'outbound_enabled',
+        'time_range_uuid': 'time_range_uuid'
+    }
+
+    def __init__(self, allowed_countries=None, block_premium_numbers=None, conversation_pbx_class_of_service_uuid=None, default_flag=None, description=None, merchant_id=None, name=None, outbound_enabled=None, time_range_uuid=None):  # noqa: E501
+        """ConversationPbxClassOfService - a model defined in Swagger"""  # noqa: E501
+
+        self._allowed_countries = None
+        self._block_premium_numbers = None
+        self._conversation_pbx_class_of_service_uuid = None
+        self._default_flag = None
+        self._description = None
+        self._merchant_id = None
+        self._name = None
+        self._outbound_enabled = None
+        self._time_range_uuid = None
+        self.discriminator = None
+
+        if allowed_countries is not None:
+            self.allowed_countries = allowed_countries
+        if block_premium_numbers is not None:
+            self.block_premium_numbers = block_premium_numbers
+        if conversation_pbx_class_of_service_uuid is not None:
+            self.conversation_pbx_class_of_service_uuid = conversation_pbx_class_of_service_uuid
+        if default_flag is not None:
+            self.default_flag = default_flag
+        if description is not None:
+            self.description = description
+        if merchant_id is not None:
+            self.merchant_id = merchant_id
+        if name is not None:
+            self.name = name
+        if outbound_enabled is not None:
+            self.outbound_enabled = outbound_enabled
+        if time_range_uuid is not None:
+            self.time_range_uuid = time_range_uuid
+
+    @property
+    def allowed_countries(self):
+        """Gets the allowed_countries of this ConversationPbxClassOfService.  # noqa: E501
+
+        E.164 country calling codes (e.g. 1 for US/Canada, 44 for UK). Empty means domestic only.  # noqa: E501
+
+        :return: The allowed_countries of this ConversationPbxClassOfService.  # noqa: E501
+        :rtype: list[str]
+        """
+        return self._allowed_countries
+
+    @allowed_countries.setter
+    def allowed_countries(self, allowed_countries):
+        """Sets the allowed_countries of this ConversationPbxClassOfService.
+
+        E.164 country calling codes (e.g. 1 for US/Canada, 44 for UK). Empty means domestic only.  # noqa: E501
+
+        :param allowed_countries: The allowed_countries of this ConversationPbxClassOfService.  # noqa: E501
+        :type: list[str]
+        """
+
+        self._allowed_countries = allowed_countries
+
+    @property
+    def block_premium_numbers(self):
+        """Gets the block_premium_numbers of this ConversationPbxClassOfService.  # noqa: E501
+
+        Block calls to 900, 976, premium-rate, and shortcode destinations  # noqa: E501
+
+        :return: The block_premium_numbers of this ConversationPbxClassOfService.  # noqa: E501
+        :rtype: bool
+        """
+        return self._block_premium_numbers
+
+    @block_premium_numbers.setter
+    def block_premium_numbers(self, block_premium_numbers):
+        """Sets the block_premium_numbers of this ConversationPbxClassOfService.
+
+        Block calls to 900, 976, premium-rate, and shortcode destinations  # noqa: E501
+
+        :param block_premium_numbers: The block_premium_numbers of this ConversationPbxClassOfService.  # noqa: E501
+        :type: bool
+        """
+
+        self._block_premium_numbers = block_premium_numbers
+
+    @property
+    def conversation_pbx_class_of_service_uuid(self):
+        """Gets the conversation_pbx_class_of_service_uuid of this ConversationPbxClassOfService.  # noqa: E501
+
+        Class of Service unique identifier  # noqa: E501
+
+        :return: The conversation_pbx_class_of_service_uuid of this ConversationPbxClassOfService.  # noqa: E501
+        :rtype: str
+        """
+        return self._conversation_pbx_class_of_service_uuid
+
+    @conversation_pbx_class_of_service_uuid.setter
+    def conversation_pbx_class_of_service_uuid(self, conversation_pbx_class_of_service_uuid):
+        """Sets the conversation_pbx_class_of_service_uuid of this ConversationPbxClassOfService.
+
+        Class of Service unique identifier  # noqa: E501
+
+        :param conversation_pbx_class_of_service_uuid: The conversation_pbx_class_of_service_uuid of this ConversationPbxClassOfService.  # noqa: E501
+        :type: str
+        """
+
+        self._conversation_pbx_class_of_service_uuid = conversation_pbx_class_of_service_uuid
+
+    @property
+    def default_flag(self):
+        """Gets the default_flag of this ConversationPbxClassOfService.  # noqa: E501
+
+        If true, this CoS applies to all agents without an explicit cos_uuid. Only one per merchant.  # noqa: E501
+
+        :return: The default_flag of this ConversationPbxClassOfService.  # noqa: E501
+        :rtype: bool
+        """
+        return self._default_flag
+
+    @default_flag.setter
+    def default_flag(self, default_flag):
+        """Sets the default_flag of this ConversationPbxClassOfService.
+
+        If true, this CoS applies to all agents without an explicit cos_uuid. Only one per merchant.  # noqa: E501
+
+        :param default_flag: The default_flag of this ConversationPbxClassOfService.  # noqa: E501
+        :type: bool
+        """
+
+        self._default_flag = default_flag
+
+    @property
+    def description(self):
+        """Gets the description of this ConversationPbxClassOfService.  # noqa: E501
+
+        Description of the class of service  # noqa: E501
+
+        :return: The description of this ConversationPbxClassOfService.  # noqa: E501
+        :rtype: str
+        """
+        return self._description
+
+    @description.setter
+    def description(self, description):
+        """Sets the description of this ConversationPbxClassOfService.
+
+        Description of the class of service  # noqa: E501
+
+        :param description: The description of this ConversationPbxClassOfService.  # noqa: E501
+        :type: str
+        """
+        if description is not None and len(description) > 500:
+            raise ValueError("Invalid value for `description`, length must be less than or equal to `500`")  # noqa: E501
+
+        self._description = description
+
+    @property
+    def merchant_id(self):
+        """Gets the merchant_id of this ConversationPbxClassOfService.  # noqa: E501
+
+        Merchant Id  # noqa: E501
+
+        :return: The merchant_id of this ConversationPbxClassOfService.  # noqa: E501
+        :rtype: str
+        """
+        return self._merchant_id
+
+    @merchant_id.setter
+    def merchant_id(self, merchant_id):
+        """Sets the merchant_id of this ConversationPbxClassOfService.
+
+        Merchant Id  # noqa: E501
+
+        :param merchant_id: The merchant_id of this ConversationPbxClassOfService.  # noqa: E501
+        :type: str
+        """
+        if merchant_id is not None and len(merchant_id) > 5:
+            raise ValueError("Invalid value for `merchant_id`, length must be less than or equal to `5`")  # noqa: E501
+
+        self._merchant_id = merchant_id
+
+    @property
+    def name(self):
+        """Gets the name of this ConversationPbxClassOfService.  # noqa: E501
+
+        Display name for the class of service  # noqa: E501
+
+        :return: The name of this ConversationPbxClassOfService.  # noqa: E501
+        :rtype: str
+        """
+        return self._name
+
+    @name.setter
+    def name(self, name):
+        """Sets the name of this ConversationPbxClassOfService.
+
+        Display name for the class of service  # noqa: E501
+
+        :param name: The name of this ConversationPbxClassOfService.  # noqa: E501
+        :type: str
+        """
+        if name is not None and len(name) > 100:
+            raise ValueError("Invalid value for `name`, length must be less than or equal to `100`")  # noqa: E501
+
+        self._name = name
+
+    @property
+    def outbound_enabled(self):
+        """Gets the outbound_enabled of this ConversationPbxClassOfService.  # noqa: E501
+
+        Whether agents with this CoS can make outbound calls  # noqa: E501
+
+        :return: The outbound_enabled of this ConversationPbxClassOfService.  # noqa: E501
+        :rtype: bool
+        """
+        return self._outbound_enabled
+
+    @outbound_enabled.setter
+    def outbound_enabled(self, outbound_enabled):
+        """Sets the outbound_enabled of this ConversationPbxClassOfService.
+
+        Whether agents with this CoS can make outbound calls  # noqa: E501
+
+        :param outbound_enabled: The outbound_enabled of this ConversationPbxClassOfService.  # noqa: E501
+        :type: bool
+        """
+
+        self._outbound_enabled = outbound_enabled
+
+    @property
+    def time_range_uuid(self):
+        """Gets the time_range_uuid of this ConversationPbxClassOfService.  # noqa: E501
+
+        UUID of a time range. If set, outbound calls only permitted during those time windows.  # noqa: E501
+
+        :return: The time_range_uuid of this ConversationPbxClassOfService.  # noqa: E501
+        :rtype: str
+        """
+        return self._time_range_uuid
+
+    @time_range_uuid.setter
+    def time_range_uuid(self, time_range_uuid):
+        """Sets the time_range_uuid of this ConversationPbxClassOfService.
+
+        UUID of a time range. If set, outbound calls only permitted during those time windows.  # noqa: E501
+
+        :param time_range_uuid: The time_range_uuid of this ConversationPbxClassOfService.  # noqa: E501
+        :type: str
+        """
+
+        self._time_range_uuid = time_range_uuid
+
+    def to_dict(self):
+        """Returns the model properties as a dict"""
+        result = {}
+
+        for attr, _ in six.iteritems(self.swagger_types):
+            value = getattr(self, attr)
+            if isinstance(value, list):
+                result[attr] = list(map(
+                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+                    value
+                ))
+            elif hasattr(value, "to_dict"):
+                result[attr] = value.to_dict()
+            elif isinstance(value, dict):
+                result[attr] = dict(map(
+                    lambda item: (item[0], item[1].to_dict())
+                    if hasattr(item[1], "to_dict") else item,
+                    value.items()
+                ))
+            else:
+                result[attr] = value
+        if issubclass(ConversationPbxClassOfService, dict):
+            for key, value in self.items():
+                result[key] = value
+
+        return result
+
+    def to_str(self):
+        """Returns the string representation of the model"""
+        return pprint.pformat(self.to_dict())
+
+    def __repr__(self):
+        """For `print` and `pprint`"""
+        return self.to_str()
+
+    def __eq__(self, other):
+        """Returns true if both objects are equal"""
+        if not isinstance(other, ConversationPbxClassOfService):
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        """Returns true if both objects are not equal"""
+        return not self == other