bandwidth-sdk 18.0.0 → 18.1.0

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

@@ -0,0 +1,259 @@
+=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.17.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Bandwidth
+  class Page < ApiModelBase
+    # The number of items per page.
+    attr_accessor :page_size
+
+    # The total number of items.
+    attr_accessor :total_elements
+
+    # The total number of pages.
+    attr_accessor :total_pages
+
+    # The current page number.
+    attr_accessor :page_number
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'page_size' => :'pageSize',
+        :'total_elements' => :'totalElements',
+        :'total_pages' => :'totalPages',
+        :'page_number' => :'pageNumber'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'page_size' => :'Integer',
+        :'total_elements' => :'Integer',
+        :'total_pages' => :'Integer',
+        :'page_number' => :'Integer'
+      }
+    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::Page` initialize method'
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Bandwidth::Page`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'page_size')
+        self.page_size = attributes[:'page_size']
+      else
+        self.page_size = nil
+      end
+
+      if attributes.key?(:'total_elements')
+        self.total_elements = attributes[:'total_elements']
+      end
+
+      if attributes.key?(:'total_pages')
+        self.total_pages = attributes[:'total_pages']
+      end
+
+      if attributes.key?(:'page_number')
+        self.page_number = attributes[:'page_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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @page_size.nil?
+        invalid_properties.push('invalid value for "page_size", page_size cannot be nil.')
+      end
+
+      if @page_size < 0
+        invalid_properties.push('invalid value for "page_size", must be greater than or equal to 0.')
+      end
+
+      if !@total_elements.nil? && @total_elements < 0
+        invalid_properties.push('invalid value for "total_elements", must be greater than or equal to 0.')
+      end
+
+      if !@total_pages.nil? && @total_pages < 0
+        invalid_properties.push('invalid value for "total_pages", must be greater than or equal to 0.')
+      end
+
+      if !@page_number.nil? && @page_number < 0
+        invalid_properties.push('invalid value for "page_number", must be greater than or equal to 0.')
+      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 @page_size.nil?
+      return false if @page_size < 0
+      return false if !@total_elements.nil? && @total_elements < 0
+      return false if !@total_pages.nil? && @total_pages < 0
+      return false if !@page_number.nil? && @page_number < 0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] page_size Value to be assigned
+    def page_size=(page_size)
+      if page_size.nil?
+        fail ArgumentError, 'page_size cannot be nil'
+      end
+
+      if page_size < 0
+        fail ArgumentError, 'invalid value for "page_size", must be greater than or equal to 0.'
+      end
+
+      @page_size = page_size
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] total_elements Value to be assigned
+    def total_elements=(total_elements)
+      if total_elements.nil?
+        fail ArgumentError, 'total_elements cannot be nil'
+      end
+
+      if total_elements < 0
+        fail ArgumentError, 'invalid value for "total_elements", must be greater than or equal to 0.'
+      end
+
+      @total_elements = total_elements
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] total_pages Value to be assigned
+    def total_pages=(total_pages)
+      if total_pages.nil?
+        fail ArgumentError, 'total_pages cannot be nil'
+      end
+
+      if total_pages < 0
+        fail ArgumentError, 'invalid value for "total_pages", must be greater than or equal to 0.'
+      end
+
+      @total_pages = total_pages
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] page_number Value to be assigned
+    def page_number=(page_number)
+      if page_number.nil?
+        fail ArgumentError, 'page_number cannot be nil'
+      end
+
+      if page_number < 0
+        fail ArgumentError, 'invalid value for "page_number", must be greater than or equal to 0.'
+      end
+
+      @page_number = page_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 &&
+          page_size == o.page_size &&
+          total_elements == o.total_elements &&
+          total_pages == o.total_pages &&
+          page_number == o.page_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 [Integer] Hash code
+    def hash
+      [page_size, total_elements, total_pages, page_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 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
+
+    # 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
+  end
+end

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

@@ -0,0 +1,175 @@
+=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.17.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Bandwidth
+  class SipConnectionMetadata < ApiModelBase
+    # The IP address of the SIP connection.
+    attr_accessor :ip_address
+
+    # The port of the SIP connection.
+    attr_accessor :port
+
+    attr_accessor :credentials
+
+    # The User-to-User Information header for the SIP connection.
+    attr_accessor :uui_header
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'ip_address' => :'ipAddress',
+        :'port' => :'port',
+        :'credentials' => :'credentials',
+        :'uui_header' => :'uuiHeader'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'ip_address' => :'String',
+        :'port' => :'Integer',
+        :'credentials' => :'SipCredentials',
+        :'uui_header' => :'String'
+      }
+    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::SipConnectionMetadata` initialize method'
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Bandwidth::SipConnectionMetadata`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'ip_address')
+        self.ip_address = attributes[:'ip_address']
+      end
+
+      if attributes.key?(:'port')
+        self.port = attributes[:'port']
+      end
+
+      if attributes.key?(:'credentials')
+        self.credentials = attributes[:'credentials']
+      end
+
+      if attributes.key?(:'uui_header')
+        self.uui_header = attributes[:'uui_header']
+      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
+      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'
+      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 &&
+          ip_address == o.ip_address &&
+          port == o.port &&
+          credentials == o.credentials &&
+          uui_header == o.uui_header
+    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
+      [ip_address, port, credentials, uui_header].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
+
+    # 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
+  end
+end

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

@@ -0,0 +1,156 @@
+=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.17.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Bandwidth
+  class SipCredentials < ApiModelBase
+    # The username for the SIP connection.
+    attr_accessor :username
+
+    # The password for the SIP connection.
+    attr_accessor :password
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'username' => :'username',
+        :'password' => :'password'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'username' => :'String',
+        :'password' => :'String'
+      }
+    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::SipCredentials` initialize method'
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Bandwidth::SipCredentials`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'username')
+        self.username = attributes[:'username']
+      end
+
+      if attributes.key?(:'password')
+        self.password = attributes[:'password']
+      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
+      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'
+      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 &&
+          username == o.username &&
+          password == o.password
+    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
+      [username, password].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
+
+    # 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
+  end
+end

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

@@ -34,7 +34,7 @@ module Bandwidth
     # Optional error code, applicable only when type is `message-failed`.
     attr_accessor :error_code
 
-    # The name of the Authorized Message Provider (AMP) that handled this message.  In the US, this is the carrier that the message was sent to. This field is present only when this account feature has been enabled.
+    # The name of the Authorized Message Provider (AMP) that handled this message. In the US, this is the carrier that the message was sent to. This field is present only when this account feature has been enabled.
     attr_accessor :carrier_name
 
     class EnumAttributeValidator

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

@@ -18,10 +18,14 @@ module Bandwidth
     # Telephone numbers in E.164 format.
     attr_accessor :phone_numbers
 
+    # Override the default RCS sender/agent ID used when checking RCS capabilities. When provided, this value is used as the `sender` in the RCS capability-check request instead of the account default. Must be 1–40 characters and contain only letters, digits, underscores, or hyphens.
+    attr_accessor :rcs_agent
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'phone_numbers' => :'phoneNumbers'
+        :'phone_numbers' => :'phoneNumbers',
+        :'rcs_agent' => :'rcsAgent'
       }
     end
 
@@ -38,7 +42,8 @@ module Bandwidth
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'phone_numbers' => :'Array<String>'
+        :'phone_numbers' => :'Array<String>',
+        :'rcs_agent' => :'String'
       }
     end
 
@@ -71,6 +76,10 @@ module Bandwidth
       else
         self.phone_numbers = nil
       end
+
+      if attributes.key?(:'rcs_agent')
+        self.rcs_agent = attributes[:'rcs_agent']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -82,6 +91,11 @@ module Bandwidth
         invalid_properties.push('invalid value for "phone_numbers", phone_numbers cannot be nil.')
       end
 
+      pattern = Regexp.new(/^[A-Za-z0-9_-]{1,40}$/)
+      if !@rcs_agent.nil? && @rcs_agent !~ pattern
+        invalid_properties.push("invalid value for \"rcs_agent\", must conform to the pattern #{pattern}.")
+      end
+
       invalid_properties
     end
 
@@ -90,6 +104,7 @@ module Bandwidth
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @phone_numbers.nil?
+      return false if !@rcs_agent.nil? && @rcs_agent !~ Regexp.new(/^[A-Za-z0-9_-]{1,40}$/)
       true
     end
 
@@ -103,12 +118,28 @@ module Bandwidth
       @phone_numbers = phone_numbers
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] rcs_agent Value to be assigned
+    def rcs_agent=(rcs_agent)
+      if rcs_agent.nil?
+        fail ArgumentError, 'rcs_agent cannot be nil'
+      end
+
+      pattern = Regexp.new(/^[A-Za-z0-9_-]{1,40}$/)
+      if rcs_agent !~ pattern
+        fail ArgumentError, "invalid value for \"rcs_agent\", must conform to the pattern #{pattern}."
+      end
+
+      @rcs_agent = rcs_agent
+    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 &&
-          phone_numbers == o.phone_numbers
+          phone_numbers == o.phone_numbers &&
+          rcs_agent == o.rcs_agent
     end
 
     # @see the `==` method
@@ -120,7 +151,7 @@ module Bandwidth
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [phone_numbers].hash
+      [phone_numbers, rcs_agent].hash
     end
 
     # Builds the object from hash