ultracart_api 3.11.39 → 3.11.41

data/lib/ultracart_api/models/conversation_pbx_available_phone_numbers_response.rb

@@ -0,0 +1,223 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+OpenAPI spec version: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.15-SNAPSHOT
+
+=end
+
+require 'date'
+
+module UltracartClient
+  class ConversationPbxAvailablePhoneNumbersResponse
+    attr_accessor :available_phone_numbers
+
+    attr_accessor :error
+
+    attr_accessor :metadata
+
+    # Indicates if API call was successful
+    attr_accessor :success
+
+    attr_accessor :warning
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'available_phone_numbers' => :'available_phone_numbers',
+        :'error' => :'error',
+        :'metadata' => :'metadata',
+        :'success' => :'success',
+        :'warning' => :'warning'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'available_phone_numbers' => :'Array<ConversationPbxAvailablePhoneNumber>',
+        :'error' => :'Error',
+        :'metadata' => :'ResponseMetadata',
+        :'success' => :'BOOLEAN',
+        :'warning' => :'Warning'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'available_phone_numbers')
+        if (value = attributes[:'available_phone_numbers']).is_a?(Array)
+          self.available_phone_numbers = value
+        end
+      end
+
+      if attributes.has_key?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.has_key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.has_key?(:'success')
+        self.success = attributes[:'success']
+      end
+
+      if attributes.has_key?(:'warning')
+        self.warning = attributes[:'warning']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          available_phone_numbers == o.available_phone_numbers &&
+          error == o.error &&
+          metadata == o.metadata &&
+          success == o.success &&
+          warning == o.warning
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [available_phone_numbers, error, metadata, success, warning].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = UltracartClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/ultracart_api/models/conversation_pbx_phone_number.rb

@@ -23,6 +23,9 @@ module UltracartClient
     # Conversation Pbx Phone Number UUID
     attr_accessor :conversation_pbx_phone_number_uuid
 
+    # If true, this phone number cannot be deleted through the API. It must be deleted via the Twilio console.
+    attr_accessor :deletion_protected
+
     # Merchant Id
     attr_accessor :merchant_id
 
@@ -57,6 +60,7 @@ module UltracartClient
         :'action' => :'action',
         :'action_target' => :'action_target',
         :'conversation_pbx_phone_number_uuid' => :'conversation_pbx_phone_number_uuid',
+        :'deletion_protected' => :'deletion_protected',
         :'merchant_id' => :'merchant_id',
         :'phone_number' => :'phone_number'
       }
@@ -68,6 +72,7 @@ module UltracartClient
         :'action' => :'String',
         :'action_target' => :'String',
         :'conversation_pbx_phone_number_uuid' => :'String',
+        :'deletion_protected' => :'BOOLEAN',
         :'merchant_id' => :'String',
         :'phone_number' => :'String'
       }
@@ -93,6 +98,10 @@ module UltracartClient
         self.conversation_pbx_phone_number_uuid = attributes[:'conversation_pbx_phone_number_uuid']
       end
 
+      if attributes.has_key?(:'deletion_protected')
+        self.deletion_protected = attributes[:'deletion_protected']
+      end
+
       if attributes.has_key?(:'merchant_id')
         self.merchant_id = attributes[:'merchant_id']
       end
@@ -200,6 +209,7 @@ module UltracartClient
           action == o.action &&
           action_target == o.action_target &&
           conversation_pbx_phone_number_uuid == o.conversation_pbx_phone_number_uuid &&
+          deletion_protected == o.deletion_protected &&
           merchant_id == o.merchant_id &&
           phone_number == o.phone_number
     end
@@ -213,7 +223,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [action, action_target, conversation_pbx_phone_number_uuid, merchant_id, phone_number].hash
+      [action, action_target, conversation_pbx_phone_number_uuid, deletion_protected, merchant_id, phone_number].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/conversation_pbx_phone_number_purchase_request.rb

@@ -0,0 +1,324 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+OpenAPI spec version: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.15-SNAPSHOT
+
+=end
+
+require 'date'
+
+module UltracartClient
+  class ConversationPbxPhoneNumberPurchaseRequest
+    # Initial action for incoming calls
+    attr_accessor :action
+
+    # Initial action target UUID
+    attr_accessor :action_target
+
+    # Address SID if required for regulatory compliance
+    attr_accessor :address_sid
+
+    # Friendly name for the phone number
+    attr_accessor :friendly_name
+
+    # Phone number to purchase in E.164 format (from search results)
+    attr_accessor :phone_number
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'action' => :'action',
+        :'action_target' => :'action_target',
+        :'address_sid' => :'address_sid',
+        :'friendly_name' => :'friendly_name',
+        :'phone_number' => :'phone_number'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'action' => :'String',
+        :'action_target' => :'String',
+        :'address_sid' => :'String',
+        :'friendly_name' => :'String',
+        :'phone_number' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'action')
+        self.action = attributes[:'action']
+      end
+
+      if attributes.has_key?(:'action_target')
+        self.action_target = attributes[:'action_target']
+      end
+
+      if attributes.has_key?(:'address_sid')
+        self.address_sid = attributes[:'address_sid']
+      end
+
+      if attributes.has_key?(:'friendly_name')
+        self.friendly_name = attributes[:'friendly_name']
+      end
+
+      if attributes.has_key?(:'phone_number')
+        self.phone_number = attributes[:'phone_number']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if !@action.nil? && @action.to_s.length > 30
+        invalid_properties.push('invalid value for "action", the character length must be smaller than or equal to 30.')
+      end
+
+      if !@action_target.nil? && @action_target.to_s.length > 50
+        invalid_properties.push('invalid value for "action_target", the character length must be smaller than or equal to 50.')
+      end
+
+      if !@address_sid.nil? && @address_sid.to_s.length > 50
+        invalid_properties.push('invalid value for "address_sid", the character length must be smaller than or equal to 50.')
+      end
+
+      if !@friendly_name.nil? && @friendly_name.to_s.length > 64
+        invalid_properties.push('invalid value for "friendly_name", the character length must be smaller than or equal to 64.')
+      end
+
+      if !@phone_number.nil? && @phone_number.to_s.length > 50
+        invalid_properties.push('invalid value for "phone_number", the character length must be smaller than or equal to 50.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      action_validator = EnumAttributeValidator.new('String', ['time based', 'menu', 'queue', 'voicemail', 'agent'])
+      return false unless action_validator.valid?(@action)
+      return false if !@action.nil? && @action.to_s.length > 30
+      return false if !@action_target.nil? && @action_target.to_s.length > 50
+      return false if !@address_sid.nil? && @address_sid.to_s.length > 50
+      return false if !@friendly_name.nil? && @friendly_name.to_s.length > 64
+      return false if !@phone_number.nil? && @phone_number.to_s.length > 50
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] action Object to be assigned
+    def action=(action)
+      validator = EnumAttributeValidator.new('String', ['time based', 'menu', 'queue', 'voicemail', 'agent'])
+      unless validator.valid?(action)
+        fail ArgumentError, 'invalid value for "action", must be one of #{validator.allowable_values}.'
+      end
+      @action = action
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] action_target Value to be assigned
+    def action_target=(action_target)
+      if !action_target.nil? && action_target.to_s.length > 50
+        fail ArgumentError, 'invalid value for "action_target", the character length must be smaller than or equal to 50.'
+      end
+
+      @action_target = action_target
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] address_sid Value to be assigned
+    def address_sid=(address_sid)
+      if !address_sid.nil? && address_sid.to_s.length > 50
+        fail ArgumentError, 'invalid value for "address_sid", the character length must be smaller than or equal to 50.'
+      end
+
+      @address_sid = address_sid
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] friendly_name Value to be assigned
+    def friendly_name=(friendly_name)
+      if !friendly_name.nil? && friendly_name.to_s.length > 64
+        fail ArgumentError, 'invalid value for "friendly_name", the character length must be smaller than or equal to 64.'
+      end
+
+      @friendly_name = friendly_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] phone_number Value to be assigned
+    def phone_number=(phone_number)
+      if !phone_number.nil? && phone_number.to_s.length > 50
+        fail ArgumentError, 'invalid value for "phone_number", the character length must be smaller than or equal to 50.'
+      end
+
+      @phone_number = phone_number
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          action == o.action &&
+          action_target == o.action_target &&
+          address_sid == o.address_sid &&
+          friendly_name == o.friendly_name &&
+          phone_number == o.phone_number
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [action, action_target, address_sid, friendly_name, phone_number].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = UltracartClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/ultracart_api/version.rb

@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.15-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '3.11.39'
+  VERSION = '3.11.41'
 end

data/lib/ultracart_api.rb

@@ -198,6 +198,9 @@ require 'ultracart_api/models/conversation_messages_response'
 require 'ultracart_api/models/conversation_multimedia_upload_url'
 require 'ultracart_api/models/conversation_multimedia_upload_url_response'
 require 'ultracart_api/models/conversation_participant'
+require 'ultracart_api/models/conversation_pbx_address'
+require 'ultracart_api/models/conversation_pbx_address_response'
+require 'ultracart_api/models/conversation_pbx_addresses_response'
 require 'ultracart_api/models/conversation_pbx_agent'
 require 'ultracart_api/models/conversation_pbx_agent_response'
 require 'ultracart_api/models/conversation_pbx_agents_response'
@@ -207,6 +210,8 @@ require 'ultracart_api/models/conversation_pbx_audio_upload_url'
 require 'ultracart_api/models/conversation_pbx_audio_upload_url_response'
 require 'ultracart_api/models/conversation_pbx_audio_usage_response'
 require 'ultracart_api/models/conversation_pbx_audios_response'
+require 'ultracart_api/models/conversation_pbx_available_phone_number'
+require 'ultracart_api/models/conversation_pbx_available_phone_numbers_response'
 require 'ultracart_api/models/conversation_pbx_customer_snapshot_request'
 require 'ultracart_api/models/conversation_pbx_customer_snapshot_response'
 require 'ultracart_api/models/conversation_pbx_menu'
@@ -214,6 +219,7 @@ require 'ultracart_api/models/conversation_pbx_menu_mapping'
 require 'ultracart_api/models/conversation_pbx_menu_response'
 require 'ultracart_api/models/conversation_pbx_menus_response'
 require 'ultracart_api/models/conversation_pbx_phone_number'
+require 'ultracart_api/models/conversation_pbx_phone_number_purchase_request'
 require 'ultracart_api/models/conversation_pbx_phone_number_response'
 require 'ultracart_api/models/conversation_pbx_phone_numbers_response'
 require 'ultracart_api/models/conversation_pbx_queue'