ultracart-rest-sdk 3.11.36__py3-none-any.whl → 3.11.45__py3-none-any.whl

ultracart/models/conversation_pbx_available_phone_numbers_response.py

@@ -0,0 +1,221 @@
+# 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 ConversationPbxAvailablePhoneNumbersResponse(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 = {
+        'available_phone_numbers': 'list[ConversationPbxAvailablePhoneNumber]',
+        'error': 'Error',
+        'metadata': 'ResponseMetadata',
+        'success': 'bool',
+        'warning': 'Warning'
+    }
+
+    attribute_map = {
+        'available_phone_numbers': 'available_phone_numbers',
+        'error': 'error',
+        'metadata': 'metadata',
+        'success': 'success',
+        'warning': 'warning'
+    }
+
+    def __init__(self, available_phone_numbers=None, error=None, metadata=None, success=None, warning=None):  # noqa: E501
+        """ConversationPbxAvailablePhoneNumbersResponse - a model defined in Swagger"""  # noqa: E501
+
+        self._available_phone_numbers = None
+        self._error = None
+        self._metadata = None
+        self._success = None
+        self._warning = None
+        self.discriminator = None
+
+        if available_phone_numbers is not None:
+            self.available_phone_numbers = available_phone_numbers
+        if error is not None:
+            self.error = error
+        if metadata is not None:
+            self.metadata = metadata
+        if success is not None:
+            self.success = success
+        if warning is not None:
+            self.warning = warning
+
+    @property
+    def available_phone_numbers(self):
+        """Gets the available_phone_numbers of this ConversationPbxAvailablePhoneNumbersResponse.  # noqa: E501
+
+
+        :return: The available_phone_numbers of this ConversationPbxAvailablePhoneNumbersResponse.  # noqa: E501
+        :rtype: list[ConversationPbxAvailablePhoneNumber]
+        """
+        return self._available_phone_numbers
+
+    @available_phone_numbers.setter
+    def available_phone_numbers(self, available_phone_numbers):
+        """Sets the available_phone_numbers of this ConversationPbxAvailablePhoneNumbersResponse.
+
+
+        :param available_phone_numbers: The available_phone_numbers of this ConversationPbxAvailablePhoneNumbersResponse.  # noqa: E501
+        :type: list[ConversationPbxAvailablePhoneNumber]
+        """
+
+        self._available_phone_numbers = available_phone_numbers
+
+    @property
+    def error(self):
+        """Gets the error of this ConversationPbxAvailablePhoneNumbersResponse.  # noqa: E501
+
+
+        :return: The error of this ConversationPbxAvailablePhoneNumbersResponse.  # noqa: E501
+        :rtype: Error
+        """
+        return self._error
+
+    @error.setter
+    def error(self, error):
+        """Sets the error of this ConversationPbxAvailablePhoneNumbersResponse.
+
+
+        :param error: The error of this ConversationPbxAvailablePhoneNumbersResponse.  # noqa: E501
+        :type: Error
+        """
+
+        self._error = error
+
+    @property
+    def metadata(self):
+        """Gets the metadata of this ConversationPbxAvailablePhoneNumbersResponse.  # noqa: E501
+
+
+        :return: The metadata of this ConversationPbxAvailablePhoneNumbersResponse.  # noqa: E501
+        :rtype: ResponseMetadata
+        """
+        return self._metadata
+
+    @metadata.setter
+    def metadata(self, metadata):
+        """Sets the metadata of this ConversationPbxAvailablePhoneNumbersResponse.
+
+
+        :param metadata: The metadata of this ConversationPbxAvailablePhoneNumbersResponse.  # noqa: E501
+        :type: ResponseMetadata
+        """
+
+        self._metadata = metadata
+
+    @property
+    def success(self):
+        """Gets the success of this ConversationPbxAvailablePhoneNumbersResponse.  # noqa: E501
+
+        Indicates if API call was successful  # noqa: E501
+
+        :return: The success of this ConversationPbxAvailablePhoneNumbersResponse.  # noqa: E501
+        :rtype: bool
+        """
+        return self._success
+
+    @success.setter
+    def success(self, success):
+        """Sets the success of this ConversationPbxAvailablePhoneNumbersResponse.
+
+        Indicates if API call was successful  # noqa: E501
+
+        :param success: The success of this ConversationPbxAvailablePhoneNumbersResponse.  # noqa: E501
+        :type: bool
+        """
+
+        self._success = success
+
+    @property
+    def warning(self):
+        """Gets the warning of this ConversationPbxAvailablePhoneNumbersResponse.  # noqa: E501
+
+
+        :return: The warning of this ConversationPbxAvailablePhoneNumbersResponse.  # noqa: E501
+        :rtype: Warning
+        """
+        return self._warning
+
+    @warning.setter
+    def warning(self, warning):
+        """Sets the warning of this ConversationPbxAvailablePhoneNumbersResponse.
+
+
+        :param warning: The warning of this ConversationPbxAvailablePhoneNumbersResponse.  # noqa: E501
+        :type: Warning
+        """
+
+        self._warning = warning
+
+    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(ConversationPbxAvailablePhoneNumbersResponse, 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, ConversationPbxAvailablePhoneNumbersResponse):
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        """Returns true if both objects are not equal"""
+        return not self == other

ultracart/models/conversation_pbx_phone_number.py

@@ -33,7 +33,9 @@ class ConversationPbxPhoneNumber(object):
     swagger_types = {
         'action': 'str',
         'action_target': 'str',
+        'address_sid': 'str',
         'conversation_pbx_phone_number_uuid': 'str',
+        'deletion_protected': 'bool',
         'merchant_id': 'str',
         'phone_number': 'str'
     }
@@ -41,17 +43,21 @@ class ConversationPbxPhoneNumber(object):
     attribute_map = {
         'action': 'action',
         'action_target': 'action_target',
+        'address_sid': 'address_sid',
         'conversation_pbx_phone_number_uuid': 'conversation_pbx_phone_number_uuid',
+        'deletion_protected': 'deletion_protected',
         'merchant_id': 'merchant_id',
         'phone_number': 'phone_number'
     }
 
-    def __init__(self, action=None, action_target=None, conversation_pbx_phone_number_uuid=None, merchant_id=None, phone_number=None):  # noqa: E501
+    def __init__(self, action=None, action_target=None, address_sid=None, conversation_pbx_phone_number_uuid=None, deletion_protected=None, merchant_id=None, phone_number=None):  # noqa: E501
         """ConversationPbxPhoneNumber - a model defined in Swagger"""  # noqa: E501
 
         self._action = None
         self._action_target = None
+        self._address_sid = None
         self._conversation_pbx_phone_number_uuid = None
+        self._deletion_protected = None
         self._merchant_id = None
         self._phone_number = None
         self.discriminator = None
@@ -60,8 +66,12 @@ class ConversationPbxPhoneNumber(object):
             self.action = action
         if action_target is not None:
             self.action_target = action_target
+        if address_sid is not None:
+            self.address_sid = address_sid
         if conversation_pbx_phone_number_uuid is not None:
             self.conversation_pbx_phone_number_uuid = conversation_pbx_phone_number_uuid
+        if deletion_protected is not None:
+            self.deletion_protected = deletion_protected
         if merchant_id is not None:
             self.merchant_id = merchant_id
         if phone_number is not None:
@@ -121,6 +131,31 @@ class ConversationPbxPhoneNumber(object):
 
         self._action_target = action_target
 
+    @property
+    def address_sid(self):
+        """Gets the address_sid of this ConversationPbxPhoneNumber.  # noqa: E501
+
+        Twilio Address SID linked to this phone number for regulatory compliance  # noqa: E501
+
+        :return: The address_sid of this ConversationPbxPhoneNumber.  # noqa: E501
+        :rtype: str
+        """
+        return self._address_sid
+
+    @address_sid.setter
+    def address_sid(self, address_sid):
+        """Sets the address_sid of this ConversationPbxPhoneNumber.
+
+        Twilio Address SID linked to this phone number for regulatory compliance  # noqa: E501
+
+        :param address_sid: The address_sid of this ConversationPbxPhoneNumber.  # noqa: E501
+        :type: str
+        """
+        if address_sid is not None and len(address_sid) > 50:
+            raise ValueError("Invalid value for `address_sid`, length must be less than or equal to `50`")  # noqa: E501
+
+        self._address_sid = address_sid
+
     @property
     def conversation_pbx_phone_number_uuid(self):
         """Gets the conversation_pbx_phone_number_uuid of this ConversationPbxPhoneNumber.  # noqa: E501
@@ -146,6 +181,29 @@ class ConversationPbxPhoneNumber(object):
 
         self._conversation_pbx_phone_number_uuid = conversation_pbx_phone_number_uuid
 
+    @property
+    def deletion_protected(self):
+        """Gets the deletion_protected of this ConversationPbxPhoneNumber.  # noqa: E501
+
+        If true, this phone number cannot be deleted through the API. It must be deleted via the Twilio console.  # noqa: E501
+
+        :return: The deletion_protected of this ConversationPbxPhoneNumber.  # noqa: E501
+        :rtype: bool
+        """
+        return self._deletion_protected
+
+    @deletion_protected.setter
+    def deletion_protected(self, deletion_protected):
+        """Sets the deletion_protected of this ConversationPbxPhoneNumber.
+
+        If true, this phone number cannot be deleted through the API. It must be deleted via the Twilio console.  # noqa: E501
+
+        :param deletion_protected: The deletion_protected of this ConversationPbxPhoneNumber.  # noqa: E501
+        :type: bool
+        """
+
+        self._deletion_protected = deletion_protected
+
     @property
     def merchant_id(self):
         """Gets the merchant_id of this ConversationPbxPhoneNumber.  # noqa: E501

ultracart/models/conversation_pbx_phone_number_purchase_request.py

@@ -0,0 +1,243 @@
+# 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 ConversationPbxPhoneNumberPurchaseRequest(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 = {
+        'action': 'str',
+        'action_target': 'str',
+        'address_sid': 'str',
+        'friendly_name': 'str',
+        'phone_number': 'str'
+    }
+
+    attribute_map = {
+        'action': 'action',
+        'action_target': 'action_target',
+        'address_sid': 'address_sid',
+        'friendly_name': 'friendly_name',
+        'phone_number': 'phone_number'
+    }
+
+    def __init__(self, action=None, action_target=None, address_sid=None, friendly_name=None, phone_number=None):  # noqa: E501
+        """ConversationPbxPhoneNumberPurchaseRequest - a model defined in Swagger"""  # noqa: E501
+
+        self._action = None
+        self._action_target = None
+        self._address_sid = None
+        self._friendly_name = None
+        self._phone_number = None
+        self.discriminator = None
+
+        if action is not None:
+            self.action = action
+        if action_target is not None:
+            self.action_target = action_target
+        if address_sid is not None:
+            self.address_sid = address_sid
+        if friendly_name is not None:
+            self.friendly_name = friendly_name
+        if phone_number is not None:
+            self.phone_number = phone_number
+
+    @property
+    def action(self):
+        """Gets the action of this ConversationPbxPhoneNumberPurchaseRequest.  # noqa: E501
+
+        Initial action for incoming calls  # noqa: E501
+
+        :return: The action of this ConversationPbxPhoneNumberPurchaseRequest.  # noqa: E501
+        :rtype: str
+        """
+        return self._action
+
+    @action.setter
+    def action(self, action):
+        """Sets the action of this ConversationPbxPhoneNumberPurchaseRequest.
+
+        Initial action for incoming calls  # noqa: E501
+
+        :param action: The action of this ConversationPbxPhoneNumberPurchaseRequest.  # noqa: E501
+        :type: str
+        """
+        allowed_values = ["time based", "menu", "queue", "voicemail", "agent"]  # noqa: E501
+        if action not in allowed_values:
+            raise ValueError(
+                "Invalid value for `action` ({0}), must be one of {1}"  # noqa: E501
+                .format(action, allowed_values)
+            )
+
+        self._action = action
+
+    @property
+    def action_target(self):
+        """Gets the action_target of this ConversationPbxPhoneNumberPurchaseRequest.  # noqa: E501
+
+        Initial action target UUID  # noqa: E501
+
+        :return: The action_target of this ConversationPbxPhoneNumberPurchaseRequest.  # noqa: E501
+        :rtype: str
+        """
+        return self._action_target
+
+    @action_target.setter
+    def action_target(self, action_target):
+        """Sets the action_target of this ConversationPbxPhoneNumberPurchaseRequest.
+
+        Initial action target UUID  # noqa: E501
+
+        :param action_target: The action_target of this ConversationPbxPhoneNumberPurchaseRequest.  # noqa: E501
+        :type: str
+        """
+        if action_target is not None and len(action_target) > 50:
+            raise ValueError("Invalid value for `action_target`, length must be less than or equal to `50`")  # noqa: E501
+
+        self._action_target = action_target
+
+    @property
+    def address_sid(self):
+        """Gets the address_sid of this ConversationPbxPhoneNumberPurchaseRequest.  # noqa: E501
+
+        Address SID if required for regulatory compliance  # noqa: E501
+
+        :return: The address_sid of this ConversationPbxPhoneNumberPurchaseRequest.  # noqa: E501
+        :rtype: str
+        """
+        return self._address_sid
+
+    @address_sid.setter
+    def address_sid(self, address_sid):
+        """Sets the address_sid of this ConversationPbxPhoneNumberPurchaseRequest.
+
+        Address SID if required for regulatory compliance  # noqa: E501
+
+        :param address_sid: The address_sid of this ConversationPbxPhoneNumberPurchaseRequest.  # noqa: E501
+        :type: str
+        """
+        if address_sid is not None and len(address_sid) > 50:
+            raise ValueError("Invalid value for `address_sid`, length must be less than or equal to `50`")  # noqa: E501
+
+        self._address_sid = address_sid
+
+    @property
+    def friendly_name(self):
+        """Gets the friendly_name of this ConversationPbxPhoneNumberPurchaseRequest.  # noqa: E501
+
+        Friendly name for the phone number  # noqa: E501
+
+        :return: The friendly_name of this ConversationPbxPhoneNumberPurchaseRequest.  # noqa: E501
+        :rtype: str
+        """
+        return self._friendly_name
+
+    @friendly_name.setter
+    def friendly_name(self, friendly_name):
+        """Sets the friendly_name of this ConversationPbxPhoneNumberPurchaseRequest.
+
+        Friendly name for the phone number  # noqa: E501
+
+        :param friendly_name: The friendly_name of this ConversationPbxPhoneNumberPurchaseRequest.  # noqa: E501
+        :type: str
+        """
+        if friendly_name is not None and len(friendly_name) > 64:
+            raise ValueError("Invalid value for `friendly_name`, length must be less than or equal to `64`")  # noqa: E501
+
+        self._friendly_name = friendly_name
+
+    @property
+    def phone_number(self):
+        """Gets the phone_number of this ConversationPbxPhoneNumberPurchaseRequest.  # noqa: E501
+
+        Phone number to purchase in E.164 format (from search results)  # noqa: E501
+
+        :return: The phone_number of this ConversationPbxPhoneNumberPurchaseRequest.  # noqa: E501
+        :rtype: str
+        """
+        return self._phone_number
+
+    @phone_number.setter
+    def phone_number(self, phone_number):
+        """Sets the phone_number of this ConversationPbxPhoneNumberPurchaseRequest.
+
+        Phone number to purchase in E.164 format (from search results)  # noqa: E501
+
+        :param phone_number: The phone_number of this ConversationPbxPhoneNumberPurchaseRequest.  # noqa: E501
+        :type: str
+        """
+        if phone_number is not None and len(phone_number) > 50:
+            raise ValueError("Invalid value for `phone_number`, length must be less than or equal to `50`")  # noqa: E501
+
+        self._phone_number = phone_number
+
+    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(ConversationPbxPhoneNumberPurchaseRequest, 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, ConversationPbxPhoneNumberPurchaseRequest):
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        """Returns true if both objects are not equal"""
+        return not self == other

ultracart/models/conversation_pbx_queue.py

@@ -31,6 +31,8 @@ class ConversationPbxQueue(object):
                             and the value is json key in definition.
     """
     swagger_types = {
+        'ai_priority': 'str',
+        'ai_timeout_seconds': 'int',
         'announce_queue_position': 'bool',
         'conversation_pbx_queue_uuid': 'str',
         'conversation_voicemail_mailbox_uuid': 'str',
@@ -55,6 +57,8 @@ class ConversationPbxQueue(object):
     }
 
     attribute_map = {
+        'ai_priority': 'ai_priority',
+        'ai_timeout_seconds': 'ai_timeout_seconds',
         'announce_queue_position': 'announce_queue_position',
         'conversation_pbx_queue_uuid': 'conversation_pbx_queue_uuid',
         'conversation_voicemail_mailbox_uuid': 'conversation_voicemail_mailbox_uuid',
@@ -78,9 +82,11 @@ class ConversationPbxQueue(object):
         'wrap_up_seconds': 'wrap_up_seconds'
     }
 
-    def __init__(self, announce_queue_position=None, conversation_pbx_queue_uuid=None, conversation_voicemail_mailbox_uuid=None, hold_conversation_pbx_audio_uuid=None, max_hold_seconds=None, members=None, merchant_id=None, name=None, no_agent_available_play_audio_uuid=None, no_agent_available_say=None, no_agent_available_say_voice=None, play_audio_uuid=None, record_call=None, say=None, say_voice=None, twilio_taskrouter_workflow_sid=None, twilio_workspace_queue_sid=None, voicemail=None, wait_critical_seconds=None, wait_warning_seconds=None, wrap_up_seconds=None):  # noqa: E501
+    def __init__(self, ai_priority=None, ai_timeout_seconds=None, announce_queue_position=None, conversation_pbx_queue_uuid=None, conversation_voicemail_mailbox_uuid=None, hold_conversation_pbx_audio_uuid=None, max_hold_seconds=None, members=None, merchant_id=None, name=None, no_agent_available_play_audio_uuid=None, no_agent_available_say=None, no_agent_available_say_voice=None, play_audio_uuid=None, record_call=None, say=None, say_voice=None, twilio_taskrouter_workflow_sid=None, twilio_workspace_queue_sid=None, voicemail=None, wait_critical_seconds=None, wait_warning_seconds=None, wrap_up_seconds=None):  # noqa: E501
         """ConversationPbxQueue - a model defined in Swagger"""  # noqa: E501
 
+        self._ai_priority = None
+        self._ai_timeout_seconds = None
         self._announce_queue_position = None
         self._conversation_pbx_queue_uuid = None
         self._conversation_voicemail_mailbox_uuid = None
@@ -104,6 +110,10 @@ class ConversationPbxQueue(object):
         self._wrap_up_seconds = None
         self.discriminator = None
 
+        if ai_priority is not None:
+            self.ai_priority = ai_priority
+        if ai_timeout_seconds is not None:
+            self.ai_timeout_seconds = ai_timeout_seconds
         if announce_queue_position is not None:
             self.announce_queue_position = announce_queue_position
         if conversation_pbx_queue_uuid is not None:
@@ -147,6 +157,58 @@ class ConversationPbxQueue(object):
         if wrap_up_seconds is not None:
             self.wrap_up_seconds = wrap_up_seconds
 
+    @property
+    def ai_priority(self):
+        """Gets the ai_priority of this ConversationPbxQueue.  # noqa: E501
+
+        AI Agent Priority compared to human agents  # noqa: E501
+
+        :return: The ai_priority of this ConversationPbxQueue.  # noqa: E501
+        :rtype: str
+        """
+        return self._ai_priority
+
+    @ai_priority.setter
+    def ai_priority(self, ai_priority):
+        """Sets the ai_priority of this ConversationPbxQueue.
+
+        AI Agent Priority compared to human agents  # noqa: E501
+
+        :param ai_priority: The ai_priority of this ConversationPbxQueue.  # noqa: E501
+        :type: str
+        """
+        allowed_values = ["neutral", "first", "backup"]  # noqa: E501
+        if ai_priority not in allowed_values:
+            raise ValueError(
+                "Invalid value for `ai_priority` ({0}), must be one of {1}"  # noqa: E501
+                .format(ai_priority, allowed_values)
+            )
+
+        self._ai_priority = ai_priority
+
+    @property
+    def ai_timeout_seconds(self):
+        """Gets the ai_timeout_seconds of this ConversationPbxQueue.  # noqa: E501
+
+        AI timeout seconds  # noqa: E501
+
+        :return: The ai_timeout_seconds of this ConversationPbxQueue.  # noqa: E501
+        :rtype: int
+        """
+        return self._ai_timeout_seconds
+
+    @ai_timeout_seconds.setter
+    def ai_timeout_seconds(self, ai_timeout_seconds):
+        """Sets the ai_timeout_seconds of this ConversationPbxQueue.
+
+        AI timeout seconds  # noqa: E501
+
+        :param ai_timeout_seconds: The ai_timeout_seconds of this ConversationPbxQueue.  # noqa: E501
+        :type: int
+        """
+
+        self._ai_timeout_seconds = ai_timeout_seconds
+
     @property
     def announce_queue_position(self):
         """Gets the announce_queue_position of this ConversationPbxQueue.  # noqa: E501