Class: Zernio::ProductVariant

Inherits:
ApiModelBase show all
Defined in:
lib/zernio-sdk/models/product_variant.rb

Overview

A purchasable variant of a product (one per option combination).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ ProductVariant

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
143
144
145
 
# File 'lib/zernio-sdk/models/product_variant.rb', line 94

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Zernio::ProductVariant` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Zernio::ProductVariant`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#available_for_sale ⇒ Object

Returns the value of attribute available_for_sale.



38
39
40
 
# File 'lib/zernio-sdk/models/product_variant.rb', line 38

def available_for_sale
  @available_for_sale
end

#barcode ⇒ Object

Returns the value of attribute barcode.



27
28
29
 
# File 'lib/zernio-sdk/models/product_variant.rb', line 27

def barcode
  @barcode
end

#compare_at_price ⇒ Object

Strike-through price; null when the variant is not on sale.



33
34
35
 
# File 'lib/zernio-sdk/models/product_variant.rb', line 33

def compare_at_price
  @compare_at_price
end

#id ⇒ Object

Platform-native variant id (numeric string for Shopify).



20
21
22
 
# File 'lib/zernio-sdk/models/product_variant.rb', line 20

def id
  @id
end

#inventory_quantity ⇒ Object

Units on hand across locations; null when inventory is not tracked.



36
37
38
 
# File 'lib/zernio-sdk/models/product_variant.rb', line 36

def inventory_quantity
  @inventory_quantity
end

#price ⇒ Object

Decimal amount in the store currency, e.g. "19.90".



30
31
32
 
# File 'lib/zernio-sdk/models/product_variant.rb', line 30

def price
  @price
end

#selected_options ⇒ Object

Returns the value of attribute selected_options.



40
41
42
 
# File 'lib/zernio-sdk/models/product_variant.rb', line 40

def selected_options
  @selected_options
end

#sku ⇒ Object

Returns the value of attribute sku.



25
26
27
 
# File 'lib/zernio-sdk/models/product_variant.rb', line 25

def sku
  @sku
end

#title ⇒ Object

Option combination label, e.g. "S / Blue".



23
24
25
 
# File 'lib/zernio-sdk/models/product_variant.rb', line 23

def title
  @title
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



58
59
60
 
# File 'lib/zernio-sdk/models/product_variant.rb', line 58

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



63
64
65
 
# File 'lib/zernio-sdk/models/product_variant.rb', line 63

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/zernio-sdk/models/product_variant.rb', line 43

def self.attribute_map
  {
    :'id' => :'id',
    :'title' => :'title',
    :'sku' => :'sku',
    :'barcode' => :'barcode',
    :'price' => :'price',
    :'compare_at_price' => :'compareAtPrice',
    :'inventory_quantity' => :'inventoryQuantity',
    :'available_for_sale' => :'availableForSale',
    :'selected_options' => :'selectedOptions'
  }
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



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/zernio-sdk/models/product_variant.rb', line 193

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



83
84
85
86
87
88
89
90
 
# File 'lib/zernio-sdk/models/product_variant.rb', line 83

def self.openapi_nullable
  Set.new([
    :'sku',
    :'barcode',
    :'compare_at_price',
    :'inventory_quantity',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/zernio-sdk/models/product_variant.rb', line 68

def self.openapi_types
  {
    :'id' => :'String',
    :'title' => :'String',
    :'sku' => :'String',
    :'barcode' => :'String',
    :'price' => :'String',
    :'compare_at_price' => :'String',
    :'inventory_quantity' => :'Integer',
    :'available_for_sale' => :'Boolean',
    :'selected_options' => :'Array<ProductVariantSelectedOptionsInner>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/zernio-sdk/models/product_variant.rb', line 164

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      title == o.title &&
      sku == o.sku &&
      barcode == o.barcode &&
      price == o.price &&
      compare_at_price == o.compare_at_price &&
      inventory_quantity == o.inventory_quantity &&
      available_for_sale == o.available_for_sale &&
      selected_options == o.selected_options
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


180
181
182
 
# File 'lib/zernio-sdk/models/product_variant.rb', line 180

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



186
187
188
 
# File 'lib/zernio-sdk/models/product_variant.rb', line 186

def hash
  [id, title, sku, barcode, price, compare_at_price, inventory_quantity, available_for_sale, selected_options].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



149
150
151
152
153
 
# File 'lib/zernio-sdk/models/product_variant.rb', line 149

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/zernio-sdk/models/product_variant.rb', line 215

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

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



157
158
159
160
 
# File 'lib/zernio-sdk/models/product_variant.rb', line 157

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end