Class: UltracartClient::ItemIdentifiers

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/item_identifiers.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ItemIdentifiers

Initializes the object

Parameters:

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

    Model attributes in the form of hash



83
84
85
86
87
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
# File 'lib/ultracart_api/models/item_identifiers.rb', line 83

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

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

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

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

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

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

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

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

Instance Attribute Details

#barcodeObject

Barcode



19
20
21
# File 'lib/ultracart_api/models/item_identifiers.rb', line 19

def barcode
  @barcode
end

#barcode_gtin12Object

Barcode - GTIN 12



22
23
24
# File 'lib/ultracart_api/models/item_identifiers.rb', line 22

def barcode_gtin12
  @barcode_gtin12
end

#barcode_gtin14Object

Barcode - GTIN 14



25
26
27
# File 'lib/ultracart_api/models/item_identifiers.rb', line 25

def barcode_gtin14
  @barcode_gtin14
end

#barcode_upc11Object

Barcode - UPC 11



28
29
30
# File 'lib/ultracart_api/models/item_identifiers.rb', line 28

def barcode_upc11
  @barcode_upc11
end

#barcode_upc12Object

Barcode - UPC 12



31
32
33
# File 'lib/ultracart_api/models/item_identifiers.rb', line 31

def barcode_upc12
  @barcode_upc12
end

#manufacturer_nameObject

Manufacturer Name



34
35
36
# File 'lib/ultracart_api/models/item_identifiers.rb', line 34

def manufacturer_name
  @manufacturer_name
end

#manufacturer_skuObject

Manufacturer SKU



37
38
39
# File 'lib/ultracart_api/models/item_identifiers.rb', line 37

def manufacturer_sku
  @manufacturer_sku
end

#unspscObject

UNSPSC



40
41
42
# File 'lib/ultracart_api/models/item_identifiers.rb', line 40

def unspsc
  @unspsc
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



57
58
59
# File 'lib/ultracart_api/models/item_identifiers.rb', line 57

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



43
44
45
46
47
48
49
50
51
52
53
54
# File 'lib/ultracart_api/models/item_identifiers.rb', line 43

def self.attribute_map
  {
    :'barcode' => :'barcode',
    :'barcode_gtin12' => :'barcode_gtin12',
    :'barcode_gtin14' => :'barcode_gtin14',
    :'barcode_upc11' => :'barcode_upc11',
    :'barcode_upc12' => :'barcode_upc12',
    :'manufacturer_name' => :'manufacturer_name',
    :'manufacturer_sku' => :'manufacturer_sku',
    :'unspsc' => :'unspsc'
  }
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



292
293
294
# File 'lib/ultracart_api/models/item_identifiers.rb', line 292

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

.openapi_nullableObject

List of attributes with nullable: true



76
77
78
79
# File 'lib/ultracart_api/models/item_identifiers.rb', line 76

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_typesObject

Attribute type mapping.



62
63
64
65
66
67
68
69
70
71
72
73
# File 'lib/ultracart_api/models/item_identifiers.rb', line 62

def self.openapi_types
  {
    :'barcode' => :'String',
    :'barcode_gtin12' => :'String',
    :'barcode_gtin14' => :'String',
    :'barcode_upc11' => :'String',
    :'barcode_upc12' => :'String',
    :'manufacturer_name' => :'String',
    :'manufacturer_sku' => :'String',
    :'unspsc' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



264
265
266
267
268
269
270
271
272
273
274
275
# File 'lib/ultracart_api/models/item_identifiers.rb', line 264

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      barcode == o.barcode &&
      barcode_gtin12 == o.barcode_gtin12 &&
      barcode_gtin14 == o.barcode_gtin14 &&
      barcode_upc11 == o.barcode_upc11 &&
      barcode_upc12 == o.barcode_upc12 &&
      manufacturer_name == o.manufacturer_name &&
      manufacturer_sku == o.manufacturer_sku &&
      unspsc == o.unspsc
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



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
357
358
359
360
# File 'lib/ultracart_api/models/item_identifiers.rb', line 323

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 = UltracartClient.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



394
395
396
397
398
399
400
401
402
403
404
405
406
# File 'lib/ultracart_api/models/item_identifiers.rb', line 394

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



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
# File 'lib/ultracart_api/models/item_identifiers.rb', line 299

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  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


279
280
281
# File 'lib/ultracart_api/models/item_identifiers.rb', line 279

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



285
286
287
# File 'lib/ultracart_api/models/item_identifiers.rb', line 285

def hash
  [barcode, barcode_gtin12, barcode_gtin14, barcode_upc11, barcode_upc12, manufacturer_name, manufacturer_sku, unspsc].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



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
# File 'lib/ultracart_api/models/item_identifiers.rb', line 131

def list_invalid_properties
  invalid_properties = Array.new
  if !@barcode.nil? && @barcode.to_s.length > 30
    invalid_properties.push('invalid value for "barcode", the character length must be smaller than or equal to 30.')
  end

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

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

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

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

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

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

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



370
371
372
# File 'lib/ultracart_api/models/item_identifiers.rb', line 370

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



376
377
378
379
380
381
382
383
384
385
386
387
388
# File 'lib/ultracart_api/models/item_identifiers.rb', line 376

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



364
365
366
# File 'lib/ultracart_api/models/item_identifiers.rb', line 364

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



170
171
172
173
174
175
176
177
178
179
180
# File 'lib/ultracart_api/models/item_identifiers.rb', line 170

def valid?
  return false if !@barcode.nil? && @barcode.to_s.length > 30
  return false if !@barcode_gtin12.nil? && @barcode_gtin12.to_s.length > 12
  return false if !@barcode_gtin14.nil? && @barcode_gtin14.to_s.length > 14
  return false if !@barcode_upc11.nil? && @barcode_upc11.to_s.length > 11
  return false if !@barcode_upc12.nil? && @barcode_upc12.to_s.length > 12
  return false if !@manufacturer_name.nil? && @manufacturer_name.to_s.length > 50
  return false if !@manufacturer_sku.nil? && @manufacturer_sku.to_s.length > 25
  return false if !@unspsc.nil? && @unspsc.to_s.length > 20
  true
end