bandwidth-sdk 15.1.0 → 16.0.0

data/lib/bandwidth-sdk/models/multi_channel_message_response_data.rb

@@ -0,0 +1,372 @@
+=begin
+#Bandwidth
+
+#Bandwidth's Communication APIs
+
+The version of the OpenAPI document: 1.0.0
+Contact: letstalk@bandwidth.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.8.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Bandwidth
+  # The data returned in a multichannel message response.
+  class MultiChannelMessageResponseData
+    # The ID of the message.
+    attr_accessor :message_id
+
+    # The time the message was received by the Bandwidth API.
+    attr_accessor :time
+
+    attr_accessor :direction
+
+    # The destination phone number(s) of the message, in E164 format.
+    attr_accessor :to
+
+    # A list of message bodies. The messages will be attempted in the order they are listed. Once a message sends successfully, the others will be ignored.
+    attr_accessor :channel_list
+
+    # A custom string that will be included in callback events of the message. Max 1024 characters.
+    attr_accessor :tag
+
+    attr_accessor :priority
+
+    # A string with the date/time value that the message will automatically expire by. This must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. Must be a date-time in the future.
+    attr_accessor :expiration
+
+    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
+      {
+        :'message_id' => :'messageId',
+        :'time' => :'time',
+        :'direction' => :'direction',
+        :'to' => :'to',
+        :'channel_list' => :'channelList',
+        :'tag' => :'tag',
+        :'priority' => :'priority',
+        :'expiration' => :'expiration'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'message_id' => :'String',
+        :'time' => :'Time',
+        :'direction' => :'MessageDirectionEnum',
+        :'to' => :'Array<String>',
+        :'channel_list' => :'Array<MultiChannelMessageResponseDataChannelListInner>',
+        :'tag' => :'String',
+        :'priority' => :'PriorityEnum',
+        :'expiration' => :'Time'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, 'The input argument (attributes) must be a hash in `Bandwidth::MultiChannelMessageResponseData` initialize method'
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Bandwidth::MultiChannelMessageResponseData`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'message_id')
+        self.message_id = attributes[:'message_id']
+      else
+        self.message_id = nil
+      end
+
+      if attributes.key?(:'time')
+        self.time = attributes[:'time']
+      else
+        self.time = nil
+      end
+
+      if attributes.key?(:'direction')
+        self.direction = attributes[:'direction']
+      else
+        self.direction = nil
+      end
+
+      if attributes.key?(:'to')
+        if (value = attributes[:'to']).is_a?(Array)
+          self.to = value
+        end
+      else
+        self.to = nil
+      end
+
+      if attributes.key?(:'channel_list')
+        if (value = attributes[:'channel_list']).is_a?(Array)
+          self.channel_list = value
+        end
+      else
+        self.channel_list = nil
+      end
+
+      if attributes.key?(:'tag')
+        self.tag = attributes[:'tag']
+      end
+
+      if attributes.key?(:'priority')
+        self.priority = attributes[:'priority']
+      end
+
+      if attributes.key?(:'expiration')
+        self.expiration = attributes[:'expiration']
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @message_id.nil?
+        invalid_properties.push('invalid value for "message_id", message_id cannot be nil.')
+      end
+
+      if @time.nil?
+        invalid_properties.push('invalid value for "time", time cannot be nil.')
+      end
+
+      if @direction.nil?
+        invalid_properties.push('invalid value for "direction", direction cannot be nil.')
+      end
+
+      if @to.nil?
+        invalid_properties.push('invalid value for "to", to cannot be nil.')
+      end
+
+      if @channel_list.nil?
+        invalid_properties.push('invalid value for "channel_list", channel_list cannot be nil.')
+      end
+
+      if @channel_list.length > 4
+        invalid_properties.push('invalid value for "channel_list", number of items must be less than or equal to 4.')
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @message_id.nil?
+      return false if @time.nil?
+      return false if @direction.nil?
+      return false if @to.nil?
+      return false if @channel_list.nil?
+      return false if @channel_list.length > 4
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] to Value to be assigned
+    def to=(to)
+      if to.nil?
+        fail ArgumentError, 'to cannot be nil'
+      end
+
+      @to = to
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] channel_list Value to be assigned
+    def channel_list=(channel_list)
+      if channel_list.nil?
+        fail ArgumentError, 'channel_list cannot be nil'
+      end
+
+      if channel_list.length > 4
+        fail ArgumentError, 'invalid value for "channel_list", number of items must be less than or equal to 4.'
+      end
+
+      @channel_list = channel_list
+    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 &&
+          message_id == o.message_id &&
+          time == o.time &&
+          direction == o.direction &&
+          to == o.to &&
+          channel_list == o.channel_list &&
+          tag == o.tag &&
+          priority == o.priority &&
+          expiration == o.expiration
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [message_id, time, direction, to, channel_list, tag, priority, expiration].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif 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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = Bandwidth.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        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/bandwidth-sdk/models/{multi_channel_message_data.rb → multi_channel_message_response_data_channel_list_inner.rb}

@@ -14,30 +14,19 @@ require 'date'
 require 'time'
 
 module Bandwidth
-  class MultiChannelMessageData
-    # The ID of the message.
-    attr_accessor :message_id
-
-    attr_accessor :status
-
-    # The time the message was received by the Bandwidth API.
-    attr_accessor :time
-
-    attr_accessor :direction
-
+  class MultiChannelMessageResponseDataChannelListInner
     # The sender ID of the message. This could be an alphanumeric sender ID.
     attr_accessor :from
 
-    # The phone number the message should be sent to in E164 format.
-    attr_accessor :to
-
     # The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard.
     attr_accessor :application_id
 
     attr_accessor :channel
 
-    # A custom string that will be included in callback events of the message. Max 1024 characters.
-    attr_accessor :tag
+    attr_accessor :content
+
+    # The Bandwidth senderId associated with the message. Identical to 'from'.
+    attr_accessor :owner
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -64,15 +53,11 @@ module Bandwidth
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'message_id' => :'messageId',
-        :'status' => :'status',
-        :'time' => :'time',
-        :'direction' => :'direction',
         :'from' => :'from',
-        :'to' => :'to',
         :'application_id' => :'applicationId',
         :'channel' => :'channel',
-        :'tag' => :'tag'
+        :'content' => :'content',
+        :'owner' => :'owner'
       }
     end
 
@@ -84,15 +69,11 @@ module Bandwidth
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'message_id' => :'String',
-        :'status' => :'MultiChannelStatusEnum',
-        :'time' => :'Time',
-        :'direction' => :'MultiChannelMessageDirectionEnum',
         :'from' => :'String',
-        :'to' => :'String',
         :'application_id' => :'String',
         :'channel' => :'MultiChannelMessageChannelEnum',
-        :'tag' => :'String'
+        :'content' => :'MultiChannelChannelListObjectContent',
+        :'owner' => :'String'
       }
     end
 
@@ -102,55 +83,56 @@ module Bandwidth
       ])
     end
 
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'MultiChannelChannelListObject'
+      ]
+    end
+
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, 'The input argument (attributes) must be a hash in `Bandwidth::MultiChannelMessageData` initialize method'
+        fail ArgumentError, 'The input argument (attributes) must be a hash in `Bandwidth::MultiChannelMessageResponseDataChannelListInner` initialize method'
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `Bandwidth::MultiChannelMessageData`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Bandwidth::MultiChannelMessageResponseDataChannelListInner`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'message_id')
-        self.message_id = attributes[:'message_id']
-      end
-
-      if attributes.key?(:'status')
-        self.status = attributes[:'status']
-      end
-
-      if attributes.key?(:'time')
-        self.time = attributes[:'time']
-      end
-
-      if attributes.key?(:'direction')
-        self.direction = attributes[:'direction']
-      end
-
       if attributes.key?(:'from')
         self.from = attributes[:'from']
-      end
-
-      if attributes.key?(:'to')
-        self.to = attributes[:'to']
+      else
+        self.from = nil
       end
 
       if attributes.key?(:'application_id')
         self.application_id = attributes[:'application_id']
+      else
+        self.application_id = nil
       end
 
       if attributes.key?(:'channel')
         self.channel = attributes[:'channel']
+      else
+        self.channel = nil
       end
 
-      if attributes.key?(:'tag')
-        self.tag = attributes[:'tag']
+      if attributes.key?(:'content')
+        self.content = attributes[:'content']
+      else
+        self.content = nil
+      end
+
+      if attributes.key?(:'owner')
+        self.owner = attributes[:'owner']
+      else
+        self.owner = nil
       end
     end
 
@@ -159,6 +141,26 @@ module Bandwidth
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
+      if @from.nil?
+        invalid_properties.push('invalid value for "from", from cannot be nil.')
+      end
+
+      if @application_id.nil?
+        invalid_properties.push('invalid value for "application_id", application_id cannot be nil.')
+      end
+
+      if @channel.nil?
+        invalid_properties.push('invalid value for "channel", channel cannot be nil.')
+      end
+
+      if @content.nil?
+        invalid_properties.push('invalid value for "content", content cannot be nil.')
+      end
+
+      if @owner.nil?
+        invalid_properties.push('invalid value for "owner", owner cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -166,6 +168,11 @@ module Bandwidth
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @from.nil?
+      return false if @application_id.nil?
+      return false if @channel.nil?
+      return false if @content.nil?
+      return false if @owner.nil?
       true
     end
 
@@ -174,15 +181,11 @@ module Bandwidth
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          message_id == o.message_id &&
-          status == o.status &&
-          time == o.time &&
-          direction == o.direction &&
           from == o.from &&
-          to == o.to &&
           application_id == o.application_id &&
           channel == o.channel &&
-          tag == o.tag
+          content == o.content &&
+          owner == o.owner
     end
 
     # @see the `==` method
@@ -194,7 +197,7 @@ module Bandwidth
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [message_id, status, time, direction, from, to, application_id, channel, tag].hash
+      [from, application_id, channel, content, owner].hash
     end
 
     # Builds the object from hash

data/lib/bandwidth-sdk/models/rbm_action_base.rb

@@ -21,7 +21,7 @@ module Bandwidth
     attr_accessor :text
 
     # Base64 payload the customer receives when the reply is clicked.
-    attr_accessor :post_back_data
+    attr_accessor :postback_data
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -50,7 +50,7 @@ module Bandwidth
       {
         :'type' => :'type',
         :'text' => :'text',
-        :'post_back_data' => :'postBackData'
+        :'postback_data' => :'postbackData'
       }
     end
 
@@ -64,7 +64,7 @@ module Bandwidth
       {
         :'type' => :'RbmActionTypeEnum',
         :'text' => :'String',
-        :'post_back_data' => :'String'
+        :'postback_data' => :'String'
       }
     end
 
@@ -101,10 +101,10 @@ module Bandwidth
         self.text = nil
       end
 
-      if attributes.key?(:'post_back_data')
-        self.post_back_data = attributes[:'post_back_data']
+      if attributes.key?(:'postback_data')
+        self.postback_data = attributes[:'postback_data']
       else
-        self.post_back_data = nil
+        self.postback_data = nil
       end
     end
 
@@ -125,12 +125,12 @@ module Bandwidth
         invalid_properties.push('invalid value for "text", the character length must be smaller than or equal to 25.')
       end
 
-      if @post_back_data.nil?
-        invalid_properties.push('invalid value for "post_back_data", post_back_data cannot be nil.')
+      if @postback_data.nil?
+        invalid_properties.push('invalid value for "postback_data", postback_data cannot be nil.')
       end
 
-      if @post_back_data.to_s.length > 2048
-        invalid_properties.push('invalid value for "post_back_data", the character length must be smaller than or equal to 2048.')
+      if @postback_data.to_s.length > 2048
+        invalid_properties.push('invalid value for "postback_data", the character length must be smaller than or equal to 2048.')
       end
 
       invalid_properties
@@ -143,8 +143,8 @@ module Bandwidth
       return false if @type.nil?
       return false if @text.nil?
       return false if @text.to_s.length > 25
-      return false if @post_back_data.nil?
-      return false if @post_back_data.to_s.length > 2048
+      return false if @postback_data.nil?
+      return false if @postback_data.to_s.length > 2048
       true
     end
 
@@ -163,17 +163,17 @@ module Bandwidth
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] post_back_data Value to be assigned
-    def post_back_data=(post_back_data)
-      if post_back_data.nil?
-        fail ArgumentError, 'post_back_data cannot be nil'
+    # @param [Object] postback_data Value to be assigned
+    def postback_data=(postback_data)
+      if postback_data.nil?
+        fail ArgumentError, 'postback_data cannot be nil'
       end
 
-      if post_back_data.to_s.length > 2048
-        fail ArgumentError, 'invalid value for "post_back_data", the character length must be smaller than or equal to 2048.'
+      if postback_data.to_s.length > 2048
+        fail ArgumentError, 'invalid value for "postback_data", the character length must be smaller than or equal to 2048.'
       end
 
-      @post_back_data = post_back_data
+      @postback_data = postback_data
     end
 
     # Checks equality by comparing each attribute.
@@ -183,7 +183,7 @@ module Bandwidth
       self.class == o.class &&
           type == o.type &&
           text == o.text &&
-          post_back_data == o.post_back_data
+          postback_data == o.postback_data
     end
 
     # @see the `==` method
@@ -195,7 +195,7 @@ module Bandwidth
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [type, text, post_back_data].hash
+      [type, text, postback_data].hash
     end
 
     # Builds the object from hash