class OpenapiClient::RateEstimateOptions

Attributes

address_residential_indicator[RW]
confirmation[RW]
dimensions[RW]

The dimensions of the package

from_city_locality[RW]

from postal code

from_country_code[RW]
from_postal_code[RW]
from_state_province[RW]

From state province

ship_date[RW]

ship date

to_city_locality[RW]

The city locality the package is being shipped to

to_country_code[RW]
to_postal_code[RW]
to_state_province[RW]

To state province

weight[RW]

The weight of the package

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/openapi_client/models/rate_estimate_options.rb, line 51
def self.attribute_map
  {
    :'from_country_code' => :'from_country_code',
    :'from_postal_code' => :'from_postal_code',
    :'from_city_locality' => :'from_city_locality',
    :'from_state_province' => :'from_state_province',
    :'to_country_code' => :'to_country_code',
    :'to_postal_code' => :'to_postal_code',
    :'to_city_locality' => :'to_city_locality',
    :'to_state_province' => :'to_state_province',
    :'weight' => :'weight',
    :'dimensions' => :'dimensions',
    :'confirmation' => :'confirmation',
    :'address_residential_indicator' => :'address_residential_indicator',
    :'ship_date' => :'ship_date'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/openapi_client/models/rate_estimate_options.rb, line 270
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/openapi_client/models/rate_estimate_options.rb, line 96
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::RateEstimateOptions` 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 `OpenapiClient::RateEstimateOptions`. 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?(:'from_country_code')
    self.from_country_code = attributes[:'from_country_code']
  end

  if attributes.key?(:'from_postal_code')
    self.from_postal_code = attributes[:'from_postal_code']
  end

  if attributes.key?(:'from_city_locality')
    self.from_city_locality = attributes[:'from_city_locality']
  end

  if attributes.key?(:'from_state_province')
    self.from_state_province = attributes[:'from_state_province']
  end

  if attributes.key?(:'to_country_code')
    self.to_country_code = attributes[:'to_country_code']
  end

  if attributes.key?(:'to_postal_code')
    self.to_postal_code = attributes[:'to_postal_code']
  end

  if attributes.key?(:'to_city_locality')
    self.to_city_locality = attributes[:'to_city_locality']
  end

  if attributes.key?(:'to_state_province')
    self.to_state_province = attributes[:'to_state_province']
  end

  if attributes.key?(:'weight')
    self.weight = attributes[:'weight']
  end

  if attributes.key?(:'dimensions')
    self.dimensions = attributes[:'dimensions']
  end

  if attributes.key?(:'confirmation')
    self.confirmation = attributes[:'confirmation']
  end

  if attributes.key?(:'address_residential_indicator')
    self.address_residential_indicator = attributes[:'address_residential_indicator']
  end

  if attributes.key?(:'ship_date')
    self.ship_date = attributes[:'ship_date']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/openapi_client/models/rate_estimate_options.rb, line 89
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/openapi_client/models/rate_estimate_options.rb, line 70
def self.openapi_types
  {
    :'from_country_code' => :'String',
    :'from_postal_code' => :'String',
    :'from_city_locality' => :'String',
    :'from_state_province' => :'String',
    :'to_country_code' => :'String',
    :'to_postal_code' => :'String',
    :'to_city_locality' => :'String',
    :'to_state_province' => :'String',
    :'weight' => :'Weight',
    :'dimensions' => :'Dimensions',
    :'confirmation' => :'DeliveryConfirmation',
    :'address_residential_indicator' => :'AddressResidentialIndicator',
    :'ship_date' => :'DateTime'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/openapi_client/models/rate_estimate_options.rb, line 237
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      from_country_code == o.from_country_code &&
      from_postal_code == o.from_postal_code &&
      from_city_locality == o.from_city_locality &&
      from_state_province == o.from_state_province &&
      to_country_code == o.to_country_code &&
      to_postal_code == o.to_postal_code &&
      to_city_locality == o.to_city_locality &&
      to_state_province == o.to_state_province &&
      weight == o.weight &&
      dimensions == o.dimensions &&
      confirmation == o.confirmation &&
      address_residential_indicator == o.address_residential_indicator &&
      ship_date == o.ship_date
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/openapi_client/models/rate_estimate_options.rb, line 298
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
    OpenapiClient.const_get(type).build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

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

# File lib/openapi_client/models/rate_estimate_options.rb, line 367
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
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/openapi_client/models/rate_estimate_options.rb, line 277
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/openapi_client/models/rate_estimate_options.rb, line 257
def eql?(o)
  self == o
end
from_city_locality=(from_city_locality) click to toggle source

Custom attribute writer method with validation @param [Object] from_city_locality Value to be assigned

# File lib/openapi_client/models/rate_estimate_options.rb, line 197
def from_city_locality=(from_city_locality)
  if !from_city_locality.nil? && from_city_locality.to_s.length < 1
    fail ArgumentError, 'invalid value for "from_city_locality", the character length must be great than or equal to 1.'
  end

  @from_city_locality = from_city_locality
end
from_state_province=(from_state_province) click to toggle source

Custom attribute writer method with validation @param [Object] from_state_province Value to be assigned

# File lib/openapi_client/models/rate_estimate_options.rb, line 207
def from_state_province=(from_state_province)
  if !from_state_province.nil? && from_state_province.to_s.length < 1
    fail ArgumentError, 'invalid value for "from_state_province", the character length must be great than or equal to 1.'
  end

  @from_state_province = from_state_province
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/openapi_client/models/rate_estimate_options.rb, line 263
def hash
  [from_country_code, from_postal_code, from_city_locality, from_state_province, to_country_code, to_postal_code, to_city_locality, to_state_province, weight, dimensions, confirmation, address_residential_indicator, ship_date].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/openapi_client/models/rate_estimate_options.rb, line 164
def list_invalid_properties
  invalid_properties = Array.new
  if !@from_city_locality.nil? && @from_city_locality.to_s.length < 1
    invalid_properties.push('invalid value for "from_city_locality", the character length must be great than or equal to 1.')
  end

  if !@from_state_province.nil? && @from_state_province.to_s.length < 1
    invalid_properties.push('invalid value for "from_state_province", the character length must be great than or equal to 1.')
  end

  if !@to_city_locality.nil? && @to_city_locality.to_s.length < 1
    invalid_properties.push('invalid value for "to_city_locality", the character length must be great than or equal to 1.')
  end

  if !@to_state_province.nil? && @to_state_province.to_s.length < 1
    invalid_properties.push('invalid value for "to_state_province", the character length must be great than or equal to 1.')
  end

  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/openapi_client/models/rate_estimate_options.rb, line 343
def to_body
  to_hash
end
to_city_locality=(to_city_locality) click to toggle source

Custom attribute writer method with validation @param [Object] to_city_locality Value to be assigned

# File lib/openapi_client/models/rate_estimate_options.rb, line 217
def to_city_locality=(to_city_locality)
  if !to_city_locality.nil? && to_city_locality.to_s.length < 1
    fail ArgumentError, 'invalid value for "to_city_locality", the character length must be great than or equal to 1.'
  end

  @to_city_locality = to_city_locality
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/openapi_client/models/rate_estimate_options.rb, line 349
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
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/openapi_client/models/rate_estimate_options.rb, line 337
def to_s
  to_hash.to_s
end
to_state_province=(to_state_province) click to toggle source

Custom attribute writer method with validation @param [Object] to_state_province Value to be assigned

# File lib/openapi_client/models/rate_estimate_options.rb, line 227
def to_state_province=(to_state_province)
  if !to_state_province.nil? && to_state_province.to_s.length < 1
    fail ArgumentError, 'invalid value for "to_state_province", the character length must be great than or equal to 1.'
  end

  @to_state_province = to_state_province
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/openapi_client/models/rate_estimate_options.rb, line 187
def valid?
  return false if !@from_city_locality.nil? && @from_city_locality.to_s.length < 1
  return false if !@from_state_province.nil? && @from_state_province.to_s.length < 1
  return false if !@to_city_locality.nil? && @to_city_locality.to_s.length < 1
  return false if !@to_state_province.nil? && @to_state_province.to_s.length < 1
  true
end