bandwidth-sdk 14.0.0 → 14.1.1

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

@@ -0,0 +1,501 @@
+=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
+  class Address
+    # The name of the business using the toll-free number.
+    attr_accessor :name
+
+    # The address of the business using the toll-free number.
+    attr_accessor :addr1
+
+    # The address of the business using the toll-free number.
+    attr_accessor :addr2
+
+    # The city of the business using the toll-free number.
+    attr_accessor :city
+
+    # The state of the business using the toll-free number.
+    attr_accessor :state
+
+    # The zip of the business using the toll-free number.
+    attr_accessor :zip
+
+    # The website of the business using the toll-free number.
+    attr_accessor :url
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'addr1' => :'addr1',
+        :'addr2' => :'addr2',
+        :'city' => :'city',
+        :'state' => :'state',
+        :'zip' => :'zip',
+        :'url' => :'url'
+      }
+    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
+      {
+        :'name' => :'String',
+        :'addr1' => :'String',
+        :'addr2' => :'String',
+        :'city' => :'String',
+        :'state' => :'String',
+        :'zip' => :'String',
+        :'url' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'addr2',
+      ])
+    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::Address` 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::Address`. 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?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'addr1')
+        self.addr1 = attributes[:'addr1']
+      else
+        self.addr1 = nil
+      end
+
+      if attributes.key?(:'addr2')
+        self.addr2 = attributes[:'addr2']
+      end
+
+      if attributes.key?(:'city')
+        self.city = attributes[:'city']
+      else
+        self.city = nil
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      else
+        self.state = nil
+      end
+
+      if attributes.key?(:'zip')
+        self.zip = attributes[:'zip']
+      else
+        self.zip = nil
+      end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      else
+        self.url = nil
+      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 @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @name.to_s.length > 500
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 500.')
+      end
+
+      if @name.to_s.length < 1
+        invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
+      end
+
+      if @addr1.nil?
+        invalid_properties.push('invalid value for "addr1", addr1 cannot be nil.')
+      end
+
+      if @addr1.to_s.length > 500
+        invalid_properties.push('invalid value for "addr1", the character length must be smaller than or equal to 500.')
+      end
+
+      if @addr1.to_s.length < 1
+        invalid_properties.push('invalid value for "addr1", the character length must be great than or equal to 1.')
+      end
+
+      if !@addr2.nil? && @addr2.to_s.length > 500
+        invalid_properties.push('invalid value for "addr2", the character length must be smaller than or equal to 500.')
+      end
+
+      if !@addr2.nil? && @addr2.to_s.length < 0
+        invalid_properties.push('invalid value for "addr2", the character length must be great than or equal to 0.')
+      end
+
+      if @city.nil?
+        invalid_properties.push('invalid value for "city", city cannot be nil.')
+      end
+
+      if @city.to_s.length > 500
+        invalid_properties.push('invalid value for "city", the character length must be smaller than or equal to 500.')
+      end
+
+      if @city.to_s.length < 1
+        invalid_properties.push('invalid value for "city", the character length must be great than or equal to 1.')
+      end
+
+      if @state.nil?
+        invalid_properties.push('invalid value for "state", state cannot be nil.')
+      end
+
+      if @state.to_s.length > 500
+        invalid_properties.push('invalid value for "state", the character length must be smaller than or equal to 500.')
+      end
+
+      if @state.to_s.length < 1
+        invalid_properties.push('invalid value for "state", the character length must be great than or equal to 1.')
+      end
+
+      if @zip.nil?
+        invalid_properties.push('invalid value for "zip", zip cannot be nil.')
+      end
+
+      pattern = Regexp.new(/[- A-Za-z0-9]{0,500}/)
+      if @zip !~ pattern
+        invalid_properties.push("invalid value for \"zip\", must conform to the pattern #{pattern}.")
+      end
+
+      if @url.nil?
+        invalid_properties.push('invalid value for "url", url cannot be nil.')
+      end
+
+      if @url.to_s.length > 500
+        invalid_properties.push('invalid value for "url", the character length must be smaller than or equal to 500.')
+      end
+
+      if @url.to_s.length < 1
+        invalid_properties.push('invalid value for "url", the character length must be great than or equal to 1.')
+      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 @name.nil?
+      return false if @name.to_s.length > 500
+      return false if @name.to_s.length < 1
+      return false if @addr1.nil?
+      return false if @addr1.to_s.length > 500
+      return false if @addr1.to_s.length < 1
+      return false if !@addr2.nil? && @addr2.to_s.length > 500
+      return false if !@addr2.nil? && @addr2.to_s.length < 0
+      return false if @city.nil?
+      return false if @city.to_s.length > 500
+      return false if @city.to_s.length < 1
+      return false if @state.nil?
+      return false if @state.to_s.length > 500
+      return false if @state.to_s.length < 1
+      return false if @zip.nil?
+      return false if @zip !~ Regexp.new(/[- A-Za-z0-9]{0,500}/)
+      return false if @url.nil?
+      return false if @url.to_s.length > 500
+      return false if @url.to_s.length < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      if name.to_s.length > 500
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 500.'
+      end
+
+      if name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 1.'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] addr1 Value to be assigned
+    def addr1=(addr1)
+      if addr1.nil?
+        fail ArgumentError, 'addr1 cannot be nil'
+      end
+
+      if addr1.to_s.length > 500
+        fail ArgumentError, 'invalid value for "addr1", the character length must be smaller than or equal to 500.'
+      end
+
+      if addr1.to_s.length < 1
+        fail ArgumentError, 'invalid value for "addr1", the character length must be great than or equal to 1.'
+      end
+
+      @addr1 = addr1
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] addr2 Value to be assigned
+    def addr2=(addr2)
+      if !addr2.nil? && addr2.to_s.length > 500
+        fail ArgumentError, 'invalid value for "addr2", the character length must be smaller than or equal to 500.'
+      end
+
+      if !addr2.nil? && addr2.to_s.length < 0
+        fail ArgumentError, 'invalid value for "addr2", the character length must be great than or equal to 0.'
+      end
+
+      @addr2 = addr2
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] city Value to be assigned
+    def city=(city)
+      if city.nil?
+        fail ArgumentError, 'city cannot be nil'
+      end
+
+      if city.to_s.length > 500
+        fail ArgumentError, 'invalid value for "city", the character length must be smaller than or equal to 500.'
+      end
+
+      if city.to_s.length < 1
+        fail ArgumentError, 'invalid value for "city", the character length must be great than or equal to 1.'
+      end
+
+      @city = city
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] state Value to be assigned
+    def state=(state)
+      if state.nil?
+        fail ArgumentError, 'state cannot be nil'
+      end
+
+      if state.to_s.length > 500
+        fail ArgumentError, 'invalid value for "state", the character length must be smaller than or equal to 500.'
+      end
+
+      if state.to_s.length < 1
+        fail ArgumentError, 'invalid value for "state", the character length must be great than or equal to 1.'
+      end
+
+      @state = state
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] zip Value to be assigned
+    def zip=(zip)
+      if zip.nil?
+        fail ArgumentError, 'zip cannot be nil'
+      end
+
+      pattern = Regexp.new(/[- A-Za-z0-9]{0,500}/)
+      if zip !~ pattern
+        fail ArgumentError, "invalid value for \"zip\", must conform to the pattern #{pattern}."
+      end
+
+      @zip = zip
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] url Value to be assigned
+    def url=(url)
+      if url.nil?
+        fail ArgumentError, 'url cannot be nil'
+      end
+
+      if url.to_s.length > 500
+        fail ArgumentError, 'invalid value for "url", the character length must be smaller than or equal to 500.'
+      end
+
+      if url.to_s.length < 1
+        fail ArgumentError, 'invalid value for "url", the character length must be great than or equal to 1.'
+      end
+
+      @url = url
+    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 &&
+          name == o.name &&
+          addr1 == o.addr1 &&
+          addr2 == o.addr2 &&
+          city == o.city &&
+          state == o.state &&
+          zip == o.zip &&
+          url == o.url
+    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
+      [name, addr1, addr2, city, state, zip, url].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