class Patch::CreateShippingEstimateRequest

Attributes

create_order[RW]
distance_m[RW]
package_mass_g[RW]
project_id[RW]
transportation_method[RW]

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/patch_ruby/models/create_shipping_estimate_request.rb, line 62
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

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

# File lib/patch_ruby/models/create_shipping_estimate_request.rb, line 51
def self.attribute_map
  {
    :'distance_m' => :'distance_m',
    :'package_mass_g' => :'package_mass_g',
    :'transportation_method' => :'transportation_method',
    :'project_id' => :'project_id',
    :'create_order' => :'create_order'
  }
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/patch_ruby/models/create_shipping_estimate_request.rb, line 258
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
method_missing(message, *args, &block) click to toggle source

Allows models with corresponding API classes to delegate API operations to those API classes Exposes Model.operation_id which delegates to ModelsApi.new.operation_id Eg. Order.create_order delegates to OrdersApi.new.create_order

Calls superclass method
# File lib/patch_ruby/models/create_shipping_estimate_request.rb, line 89
def self.method_missing(message, *args, &block)
  if Object.const_defined?('Patch::CreateShippingEstimateRequestsApi::OPERATIONS') && Patch::CreateShippingEstimateRequestsApi::OPERATIONS.include?(message)
    Patch::CreateShippingEstimateRequestsApi.new.send(message, *args)
  else
    super
  end
end
new(attributes = {}) click to toggle source

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

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

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

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

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

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

List of attributes with nullable: true

# File lib/patch_ruby/models/create_shipping_estimate_request.rb, line 78
def self.openapi_nullable
  Set.new([
    :'project_id',
    :'create_order'
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/patch_ruby/models/create_shipping_estimate_request.rb, line 67
def self.openapi_types
  {
    :'distance_m' => :'Integer',
    :'package_mass_g' => :'Integer',
    :'transportation_method' => :'String',
    :'project_id' => :'String',
    :'create_order' => :'Boolean'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/patch_ruby/models/create_shipping_estimate_request.rb, line 233
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      distance_m == o.distance_m &&
      package_mass_g == o.package_mass_g &&
      transportation_method == o.transportation_method &&
      project_id == o.project_id &&
      create_order == o.create_order
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/patch_ruby/models/create_shipping_estimate_request.rb, line 288
def _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 = Patch.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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/patch_ruby/models/create_shipping_estimate_request.rb, line 359
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/patch_ruby/models/create_shipping_estimate_request.rb, line 265
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[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
  end

  self
end
distance_m=(distance_m) click to toggle source

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

# File lib/patch_ruby/models/create_shipping_estimate_request.rb, line 187
def distance_m=(distance_m)
  if distance_m.nil?
    fail ArgumentError, 'distance_m cannot be nil'
  end

  if distance_m > 400000000
    fail ArgumentError, 'invalid value for "distance_m", must be smaller than or equal to 400000000.'
  end

  if distance_m < 0
    fail ArgumentError, 'invalid value for "distance_m", must be greater than or equal to 0.'
  end

  @distance_m = distance_m
end
eql?(o) click to toggle source

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

# File lib/patch_ruby/models/create_shipping_estimate_request.rb, line 245
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/patch_ruby/models/create_shipping_estimate_request.rb, line 251
def hash
  [distance_m, package_mass_g, transportation_method, project_id, create_order].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/patch_ruby/models/create_shipping_estimate_request.rb, line 137
def list_invalid_properties
  invalid_properties = Array.new
  if @distance_m.nil?
    invalid_properties.push('invalid value for "distance_m", distance_m cannot be nil.')
  end

  if @distance_m > 400000000
    invalid_properties.push('invalid value for "distance_m", must be smaller than or equal to 400000000.')
  end

  if @distance_m < 0
    invalid_properties.push('invalid value for "distance_m", must be greater than or equal to 0.')
  end

  if @package_mass_g.nil?
    invalid_properties.push('invalid value for "package_mass_g", package_mass_g cannot be nil.')
  end

  if @package_mass_g > 2000000000
    invalid_properties.push('invalid value for "package_mass_g", must be smaller than or equal to 2000000000.')
  end

  if @package_mass_g < 0
    invalid_properties.push('invalid value for "package_mass_g", must be greater than or equal to 0.')
  end

  if @transportation_method.nil?
    invalid_properties.push('invalid value for "transportation_method", transportation_method cannot be nil.')
  end

  invalid_properties
end
package_mass_g=(package_mass_g) click to toggle source

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

# File lib/patch_ruby/models/create_shipping_estimate_request.rb, line 205
def package_mass_g=(package_mass_g)
  if package_mass_g.nil?
    fail ArgumentError, 'package_mass_g cannot be nil'
  end

  if package_mass_g > 2000000000
    fail ArgumentError, 'invalid value for "package_mass_g", must be smaller than or equal to 2000000000.'
  end

  if package_mass_g < 0
    fail ArgumentError, 'invalid value for "package_mass_g", must be greater than or equal to 0.'
  end

  @package_mass_g = package_mass_g
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/patch_ruby/models/create_shipping_estimate_request.rb, line 335
def to_body
  to_hash
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/patch_ruby/models/create_shipping_estimate_request.rb, line 341
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/patch_ruby/models/create_shipping_estimate_request.rb, line 329
def to_s
  to_hash.to_s
end
transportation_method=(transportation_method) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] transportation_method Object to be assigned

# File lib/patch_ruby/models/create_shipping_estimate_request.rb, line 223
def transportation_method=(transportation_method)
  validator = EnumAttributeValidator.new('String', ["air", "rail", "road", "sea"])
  unless validator.valid?(transportation_method)
    fail ArgumentError, "invalid value for \"transportation_method\", must be one of #{validator.allowable_values}."
  end
  @transportation_method = transportation_method
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/patch_ruby/models/create_shipping_estimate_request.rb, line 172
def valid?
  return false if @distance_m.nil?
  return false if @distance_m > 400000000
  return false if @distance_m < 0
  return false if @package_mass_g.nil?
  return false if @package_mass_g > 2000000000
  return false if @package_mass_g < 0
  return false if @transportation_method.nil?
  transportation_method_validator = EnumAttributeValidator.new('String', ["air", "rail", "road", "sea"])
  return false unless transportation_method_validator.valid?(@transportation_method)
  true
end