Class: Patch::CreateRailShippingEstimateRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/patch_ruby/models/create_rail_shipping_estimate_request.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateRailShippingEstimateRequest

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/patch_ruby/models/create_rail_shipping_estimate_request.rb', line 131

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Patch::CreateRailShippingEstimateRequest` 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::CreateRailShippingEstimateRequest`. 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?(:'destination_country_code')
    self.destination_country_code = attributes[:'destination_country_code']
  end

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

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

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

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

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

  if attributes.key?(:'fuel_type')
    self.fuel_type = attributes[:'fuel_type']
  else
    self.fuel_type = 'default'
  end

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

  if attributes.key?(:'emissions_scope')
    self.emissions_scope = attributes[:'emissions_scope']
  else
    self.emissions_scope = 'ttw'
  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

Instance Attribute Details

#create_order ⇒ Object

Returns the value of attribute create_order.



38
39
40
 
# File 'lib/patch_ruby/models/create_rail_shipping_estimate_request.rb', line 38

def create_order
  @create_order
end

#destination_country_code ⇒ Object

Returns the value of attribute destination_country_code.



18
19
20
 
# File 'lib/patch_ruby/models/create_rail_shipping_estimate_request.rb', line 18

def destination_country_code
  @destination_country_code
end

#destination_locode ⇒ Object

Returns the value of attribute destination_locode.



20
21
22
 
# File 'lib/patch_ruby/models/create_rail_shipping_estimate_request.rb', line 20

def destination_locode
  @destination_locode
end

#destination_postal_code ⇒ Object

Returns the value of attribute destination_postal_code.



22
23
24
 
# File 'lib/patch_ruby/models/create_rail_shipping_estimate_request.rb', line 22

def destination_postal_code
  @destination_postal_code
end

#emissions_scope ⇒ Object

Returns the value of attribute emissions_scope.



34
35
36
 
# File 'lib/patch_ruby/models/create_rail_shipping_estimate_request.rb', line 34

def emissions_scope
  @emissions_scope
end

#freight_mass_g ⇒ Object

Returns the value of attribute freight_mass_g.



32
33
34
 
# File 'lib/patch_ruby/models/create_rail_shipping_estimate_request.rb', line 32

def freight_mass_g
  @freight_mass_g
end

#fuel_type ⇒ Object

Returns the value of attribute fuel_type.



30
31
32
 
# File 'lib/patch_ruby/models/create_rail_shipping_estimate_request.rb', line 30

def fuel_type
  @fuel_type
end

#origin_country_code ⇒ Object

Returns the value of attribute origin_country_code.



24
25
26
 
# File 'lib/patch_ruby/models/create_rail_shipping_estimate_request.rb', line 24

def origin_country_code
  @origin_country_code
end

#origin_locode ⇒ Object

Returns the value of attribute origin_locode.



26
27
28
 
# File 'lib/patch_ruby/models/create_rail_shipping_estimate_request.rb', line 26

def origin_locode
  @origin_locode
end

#origin_postal_code ⇒ Object

Returns the value of attribute origin_postal_code.



28
29
30
 
# File 'lib/patch_ruby/models/create_rail_shipping_estimate_request.rb', line 28

def origin_postal_code
  @origin_postal_code
end

#project_id ⇒ Object

Returns the value of attribute project_id.



36
37
38
 
# File 'lib/patch_ruby/models/create_rail_shipping_estimate_request.rb', line 36

def project_id
  @project_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



80
81
82
 
# File 'lib/patch_ruby/models/create_rail_shipping_estimate_request.rb', line 80

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/patch_ruby/models/create_rail_shipping_estimate_request.rb', line 63

def self.attribute_map
  {
    :'destination_country_code' => :'destination_country_code',
    :'destination_locode' => :'destination_locode',
    :'destination_postal_code' => :'destination_postal_code',
    :'origin_country_code' => :'origin_country_code',
    :'origin_locode' => :'origin_locode',
    :'origin_postal_code' => :'origin_postal_code',
    :'fuel_type' => :'fuel_type',
    :'freight_mass_g' => :'freight_mass_g',
    :'emissions_scope' => :'emissions_scope',
    :'project_id' => :'project_id',
    :'create_order' => :'create_order'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



289
290
291
 
# File 'lib/patch_ruby/models/create_rail_shipping_estimate_request.rb', line 289

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.method_missing(message, *args, &block) ⇒ Object

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



121
122
123
124
125
126
127
 
# File 'lib/patch_ruby/models/create_rail_shipping_estimate_request.rb', line 121

def self.method_missing(message, *args, &block)
  if Object.const_defined?('Patch::CreateRailShippingEstimateRequestsApi::OPERATIONS') && Patch::CreateRailShippingEstimateRequestsApi::OPERATIONS.include?(message)
    Patch::CreateRailShippingEstimateRequestsApi.new.send(message, *args)
  else
    super
  end
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/patch_ruby/models/create_rail_shipping_estimate_request.rb', line 102

def self.openapi_nullable
  Set.new([
    :'destination_country_code',
    :'destination_locode',
    :'destination_postal_code',
    :'origin_country_code',
    :'origin_locode',
    :'origin_postal_code',
    :'fuel_type',
    :'emissions_scope',
    :'project_id',
    :'create_order'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/patch_ruby/models/create_rail_shipping_estimate_request.rb', line 85

def self.openapi_types
  {
    :'destination_country_code' => :'String',
    :'destination_locode' => :'String',
    :'destination_postal_code' => :'String',
    :'origin_country_code' => :'String',
    :'origin_locode' => :'String',
    :'origin_postal_code' => :'String',
    :'fuel_type' => :'String',
    :'freight_mass_g' => :'Integer',
    :'emissions_scope' => :'String',
    :'project_id' => :'String',
    :'create_order' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/patch_ruby/models/create_rail_shipping_estimate_request.rb', line 258

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      destination_country_code == o.destination_country_code &&
      destination_locode == o.destination_locode &&
      destination_postal_code == o.destination_postal_code &&
      origin_country_code == o.origin_country_code &&
      origin_locode == o.origin_locode &&
      origin_postal_code == o.origin_postal_code &&
      fuel_type == o.fuel_type &&
      freight_mass_g == o.freight_mass_g &&
      emissions_scope == o.emissions_scope &&
      project_id == o.project_id &&
      create_order == o.create_order
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/patch_ruby/models/create_rail_shipping_estimate_request.rb', line 319

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) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/patch_ruby/models/create_rail_shipping_estimate_request.rb', line 390

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/patch_ruby/models/create_rail_shipping_estimate_request.rb', line 296

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


276
277
278
 
# File 'lib/patch_ruby/models/create_rail_shipping_estimate_request.rb', line 276

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



282
283
284
 
# File 'lib/patch_ruby/models/create_rail_shipping_estimate_request.rb', line 282

def hash
  [destination_country_code, destination_locode, destination_postal_code, origin_country_code, origin_locode, origin_postal_code, fuel_type, freight_mass_g, emissions_scope, project_id, create_order].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/patch_ruby/models/create_rail_shipping_estimate_request.rb', line 197

def list_invalid_properties
  invalid_properties = Array.new
  if !@freight_mass_g.nil? && @freight_mass_g > 2000000000
    invalid_properties.push('invalid value for "freight_mass_g", must be smaller than or equal to 2000000000.')
  end

  if !@freight_mass_g.nil? && @freight_mass_g < 0
    invalid_properties.push('invalid value for "freight_mass_g", must be greater than or equal to 0.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



366
367
368
 
# File 'lib/patch_ruby/models/create_rail_shipping_estimate_request.rb', line 366

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/patch_ruby/models/create_rail_shipping_estimate_request.rb', line 372

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



360
361
362
 
# File 'lib/patch_ruby/models/create_rail_shipping_estimate_request.rb', line 360

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



212
213
214
215
216
217
218
219
220
 
# File 'lib/patch_ruby/models/create_rail_shipping_estimate_request.rb', line 212

def valid?
  fuel_type_validator = EnumAttributeValidator.new('String', ["default", "diesel", "elec"])
  return false unless fuel_type_validator.valid?(@fuel_type)
  return false if !@freight_mass_g.nil? && @freight_mass_g > 2000000000
  return false if !@freight_mass_g.nil? && @freight_mass_g < 0
  emissions_scope_validator = EnumAttributeValidator.new('String', ["wtt", "ttw", "wtw"])
  return false unless emissions_scope_validator.valid?(@emissions_scope)
  true
end