Class: Patch::CreateRoadShippingEstimateRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/patch_ruby/models/create_road_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 = {}) ⇒ CreateRoadShippingEstimateRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/patch_ruby/models/create_road_shipping_estimate_request.rb', line 154

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

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

  if attributes.key?(:'emissions_scope')
    self.emissions_scope = attributes[:'emissions_scope']
  else
    self.emissions_scope = 'ttw'
  end

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

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

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

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

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

#cargo_type ⇒ Object

Returns the value of attribute cargo_type.



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

def cargo_type
  @cargo_type
end

#carrier_scac ⇒ Object

Returns the value of attribute carrier_scac.



44
45
46
 
# File 'lib/patch_ruby/models/create_road_shipping_estimate_request.rb', line 44

def carrier_scac
  @carrier_scac
end

#container_size_code ⇒ Object

Returns the value of attribute container_size_code.



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

def container_size_code
  @container_size_code
end

#create_order ⇒ Object

Returns the value of attribute create_order.



48
49
50
 
# File 'lib/patch_ruby/models/create_road_shipping_estimate_request.rb', line 48

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_road_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_road_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_road_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_road_shipping_estimate_request.rb', line 34

def emissions_scope
  @emissions_scope
end

#freight_mass_g ⇒ Object

Returns the value of attribute freight_mass_g.



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

def freight_mass_g
  @freight_mass_g
end

#fuel_type ⇒ Object

Returns the value of attribute fuel_type.



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

def fuel_type
  @fuel_type
end

#number_of_containers ⇒ Object

Returns the value of attribute number_of_containers.



40
41
42
 
# File 'lib/patch_ruby/models/create_road_shipping_estimate_request.rb', line 40

def number_of_containers
  @number_of_containers
end

#origin_country_code ⇒ Object

Returns the value of attribute origin_country_code.



24
25
26
 
# File 'lib/patch_ruby/models/create_road_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_road_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_road_shipping_estimate_request.rb', line 28

def origin_postal_code
  @origin_postal_code
end

#project_id ⇒ Object

Returns the value of attribute project_id.



46
47
48
 
# File 'lib/patch_ruby/models/create_road_shipping_estimate_request.rb', line 46

def project_id
  @project_id
end

#truck_weight_t ⇒ Object

Returns the value of attribute truck_weight_t.



42
43
44
 
# File 'lib/patch_ruby/models/create_road_shipping_estimate_request.rb', line 42

def truck_weight_t
  @truck_weight_t
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



95
96
97
 
# File 'lib/patch_ruby/models/create_road_shipping_estimate_request.rb', line 95

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/patch_ruby/models/create_road_shipping_estimate_request.rb', line 73

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',
    :'cargo_type' => :'cargo_type',
    :'container_size_code' => :'container_size_code',
    :'emissions_scope' => :'emissions_scope',
    :'freight_mass_g' => :'freight_mass_g',
    :'fuel_type' => :'fuel_type',
    :'number_of_containers' => :'number_of_containers',
    :'truck_weight_t' => :'truck_weight_t',
    :'carrier_scac' => :'carrier_scac',
    :'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



402
403
404
 
# File 'lib/patch_ruby/models/create_road_shipping_estimate_request.rb', line 402

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



144
145
146
147
148
149
150
 
# File 'lib/patch_ruby/models/create_road_shipping_estimate_request.rb', line 144

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/patch_ruby/models/create_road_shipping_estimate_request.rb', line 122

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

.openapi_types ⇒ Object

Attribute type mapping.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/patch_ruby/models/create_road_shipping_estimate_request.rb', line 100

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',
    :'cargo_type' => :'String',
    :'container_size_code' => :'String',
    :'emissions_scope' => :'String',
    :'freight_mass_g' => :'Integer',
    :'fuel_type' => :'String',
    :'number_of_containers' => :'Integer',
    :'truck_weight_t' => :'Integer',
    :'carrier_scac' => :'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



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/patch_ruby/models/create_road_shipping_estimate_request.rb', line 366

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 &&
      cargo_type == o.cargo_type &&
      container_size_code == o.container_size_code &&
      emissions_scope == o.emissions_scope &&
      freight_mass_g == o.freight_mass_g &&
      fuel_type == o.fuel_type &&
      number_of_containers == o.number_of_containers &&
      truck_weight_t == o.truck_weight_t &&
      carrier_scac == o.carrier_scac &&
      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



432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/patch_ruby/models/create_road_shipping_estimate_request.rb', line 432

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



503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'lib/patch_ruby/models/create_road_shipping_estimate_request.rb', line 503

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



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/patch_ruby/models/create_road_shipping_estimate_request.rb', line 409

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


389
390
391
 
# File 'lib/patch_ruby/models/create_road_shipping_estimate_request.rb', line 389

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



395
396
397
 
# File 'lib/patch_ruby/models/create_road_shipping_estimate_request.rb', line 395

def hash
  [destination_country_code, destination_locode, destination_postal_code, origin_country_code, origin_locode, origin_postal_code, cargo_type, container_size_code, emissions_scope, freight_mass_g, fuel_type, number_of_containers, truck_weight_t, carrier_scac, 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



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/patch_ruby/models/create_road_shipping_estimate_request.rb', line 242

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

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

  if !@truck_weight_t.nil? && @truck_weight_t > 60
    invalid_properties.push('invalid value for "truck_weight_t", must be smaller than or equal to 60.')
  end

  if !@truck_weight_t.nil? && @truck_weight_t < 0
    invalid_properties.push('invalid value for "truck_weight_t", 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



479
480
481
 
# File 'lib/patch_ruby/models/create_road_shipping_estimate_request.rb', line 479

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



485
486
487
488
489
490
491
492
493
494
495
496
497
 
# File 'lib/patch_ruby/models/create_road_shipping_estimate_request.rb', line 485

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



473
474
475
 
# File 'lib/patch_ruby/models/create_road_shipping_estimate_request.rb', line 473

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



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/patch_ruby/models/create_road_shipping_estimate_request.rb', line 269

def valid?
  cargo_type_validator = EnumAttributeValidator.new('String', ["average_mixed", "container"])
  return false unless cargo_type_validator.valid?(@cargo_type)
  container_size_code_validator = EnumAttributeValidator.new('String', ["20GP", "40GP", "22G1", "42G1", "40HC", "45G1"])
  return false unless container_size_code_validator.valid?(@container_size_code)
  emissions_scope_validator = EnumAttributeValidator.new('String', ["wtt", "ttw", "wtw"])
  return false unless emissions_scope_validator.valid?(@emissions_scope)
  return false if !@freight_mass_g.nil? && @freight_mass_g > 2000000000
  return false if !@freight_mass_g.nil? && @freight_mass_g < 0
  fuel_type_validator = EnumAttributeValidator.new('String', ["cng", "diesel", "lng", "petrol"])
  return false unless fuel_type_validator.valid?(@fuel_type)
  return false if !@number_of_containers.nil? && @number_of_containers < 0
  return false if !@truck_weight_t.nil? && @truck_weight_t > 60
  return false if !@truck_weight_t.nil? && @truck_weight_t < 0
  true
end