Class: OpenapiClient::CustomsItem

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/models/customs_item.rb

Overview

The customs declaration for a single item in the shipment.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CustomsItem

Initializes the object

Parameters:

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

    Model attributes in the form of hash



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/openapi_client/models/customs_item.rb', line 88

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

  if attributes.key?(:'description')
    self.description = attributes[:'description']
  else
    self.description = 'null'
  end

  if attributes.key?(:'quantity')
    self.quantity = attributes[:'quantity']
  else
    self.quantity = 0
  end

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

  if attributes.key?(:'harmonized_tariff_code')
    self.harmonized_tariff_code = attributes[:'harmonized_tariff_code']
  else
    self.harmonized_tariff_code = 'null'
  end

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

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

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

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

Instance Attribute Details

#country_of_origin ⇒ Object

The two-letter [ISO 3166-1 country code](en.wikipedia.org/wiki/ISO_3166-1) where this item originated



34
35
36
 
# File 'lib/openapi_client/models/customs_item.rb', line 34

def country_of_origin
  @country_of_origin
end

#customs_item_id ⇒ Object

A string that uniquely identifies the customs item



19
20
21
 
# File 'lib/openapi_client/models/customs_item.rb', line 19

def customs_item_id
  @customs_item_id
end

#description ⇒ Object

A description of the item



22
23
24
 
# File 'lib/openapi_client/models/customs_item.rb', line 22

def description
  @description
end

#harmonized_tariff_code ⇒ Object

The [Harmonized Tariff Code](en.wikipedia.org/wiki/Harmonized_System) of this item.



31
32
33
 
# File 'lib/openapi_client/models/customs_item.rb', line 31

def harmonized_tariff_code
  @harmonized_tariff_code
end

#quantity ⇒ Object

The quantity of this item in the shipment.



25
26
27
 
# File 'lib/openapi_client/models/customs_item.rb', line 25

def quantity
  @quantity
end

#sku ⇒ Object

The SKU (Stock Keeping Unit) of the customs item



39
40
41
 
# File 'lib/openapi_client/models/customs_item.rb', line 39

def sku
  @sku
end

#sku_description ⇒ Object

Description of the Custom Item’s SKU



42
43
44
 
# File 'lib/openapi_client/models/customs_item.rb', line 42

def sku_description
  @sku_description
end

#unit_of_measure ⇒ Object

Returns the value of attribute unit_of_measure.



36
37
38
 
# File 'lib/openapi_client/models/customs_item.rb', line 36

def unit_of_measure
  @unit_of_measure
end

#value ⇒ Object

The total value of the customs item



28
29
30
 
# File 'lib/openapi_client/models/customs_item.rb', line 28

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/openapi_client/models/customs_item.rb', line 45

def self.attribute_map
  {
    :'customs_item_id' => :'customs_item_id',
    :'description' => :'description',
    :'quantity' => :'quantity',
    :'value' => :'value',
    :'harmonized_tariff_code' => :'harmonized_tariff_code',
    :'country_of_origin' => :'country_of_origin',
    :'unit_of_measure' => :'unit_of_measure',
    :'sku' => :'sku',
    :'sku_description' => :'sku_description'
  }
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



223
224
225
 
# File 'lib/openapi_client/models/customs_item.rb', line 223

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



75
76
77
78
79
80
81
82
83
84
 
# File 'lib/openapi_client/models/customs_item.rb', line 75

def self.openapi_nullable
  Set.new([
    :'description',
    :'harmonized_tariff_code',
    :'country_of_origin',
    :'unit_of_measure',
    :'sku',
    :'sku_description'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/openapi_client/models/customs_item.rb', line 60

def self.openapi_types
  {
    :'customs_item_id' => :'String',
    :'description' => :'String',
    :'quantity' => :'Integer',
    :'value' => :'MonetaryValue',
    :'harmonized_tariff_code' => :'String',
    :'country_of_origin' => :'String',
    :'unit_of_measure' => :'String',
    :'sku' => :'String',
    :'sku_description' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/openapi_client/models/customs_item.rb', line 194

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      customs_item_id == o.customs_item_id &&
      description == o.description &&
      quantity == o.quantity &&
      value == o.value &&
      harmonized_tariff_code == o.harmonized_tariff_code &&
      country_of_origin == o.country_of_origin &&
      unit_of_measure == o.unit_of_measure &&
      sku == o.sku &&
      sku_description == o.sku_description
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



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/openapi_client/models/customs_item.rb', line 251

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



320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/openapi_client/models/customs_item.rb', line 320

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



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/openapi_client/models/customs_item.rb', line 230

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


210
211
212
 
# File 'lib/openapi_client/models/customs_item.rb', line 210

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



216
217
218
 
# File 'lib/openapi_client/models/customs_item.rb', line 216

def hash
  [customs_item_id, description, quantity, value, harmonized_tariff_code, country_of_origin, unit_of_measure, sku, sku_description].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



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/openapi_client/models/customs_item.rb', line 146

def list_invalid_properties
  invalid_properties = Array.new
  if @customs_item_id.nil?
    invalid_properties.push('invalid value for "customs_item_id", customs_item_id cannot be nil.')
  end

  if !@description.nil? && @description.to_s.length > 100
    invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 100.')
  end

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



296
297
298
 
# File 'lib/openapi_client/models/customs_item.rb', line 296

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



302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/openapi_client/models/customs_item.rb', line 302

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



290
291
292
 
# File 'lib/openapi_client/models/customs_item.rb', line 290

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



165
166
167
168
169
170
 
# File 'lib/openapi_client/models/customs_item.rb', line 165

def valid?
  return false if @customs_item_id.nil?
  return false if !@description.nil? && @description.to_s.length > 100
  return false if !@quantity.nil? && @quantity < 0
  true
end