Class: DevDraftAI::UpdateProductDto

Inherits:
Object
  • Object
show all
Defined in:
lib/devdraft/models/update_product_dto.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateProductDto

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/devdraft/models/update_product_dto.rb', line 118

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

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

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

  if attributes.key?(:'currency')
    self.currency = attributes[:'currency']
  else
    self.currency = 'USD'
  end

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

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

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

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

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

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

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

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

Instance Attribute Details

#currency ⇒ Object

Currency code for the price. Defaults to USD if not specified.



26
27
28
 
# File 'lib/devdraft/models/update_product_dto.rb', line 26

def currency
  @currency
end

#description ⇒ Object

Detailed description of the product. Supports markdown formatting for rich text display.



20
21
22
 
# File 'lib/devdraft/models/update_product_dto.rb', line 20

def description
  @description
end

#images ⇒ Object

Array of image URLs



50
51
52
 
# File 'lib/devdraft/models/update_product_dto.rb', line 50

def images
  @images
end

#name ⇒ Object

Product name as it will appear to customers. Should be clear and descriptive.



17
18
19
 
# File 'lib/devdraft/models/update_product_dto.rb', line 17

def name
  @name
end

#price ⇒ Object

Product price in the specified currency. Must be greater than 0.



23
24
25
 
# File 'lib/devdraft/models/update_product_dto.rb', line 23

def price
  @price
end

#product_type ⇒ Object

Product type



47
48
49
 
# File 'lib/devdraft/models/update_product_dto.rb', line 47

def product_type
  @product_type
end

#quantity ⇒ Object

Quantity available



38
39
40
 
# File 'lib/devdraft/models/update_product_dto.rb', line 38

def quantity
  @quantity
end

#status ⇒ Object

Product status



44
45
46
 
# File 'lib/devdraft/models/update_product_dto.rb', line 44

def status
  @status
end

#stock_count ⇒ Object

Stock count



41
42
43
 
# File 'lib/devdraft/models/update_product_dto.rb', line 41

def stock_count
  @stock_count
end

#type ⇒ Object

Product type



29
30
31
 
# File 'lib/devdraft/models/update_product_dto.rb', line 29

def type
  @type
end

#unit ⇒ Object

Unit of measurement



35
36
37
 
# File 'lib/devdraft/models/update_product_dto.rb', line 35

def unit
  @unit
end

#weight ⇒ Object

Weight of the product



32
33
34
 
# File 'lib/devdraft/models/update_product_dto.rb', line 32

def weight
  @weight
end

Class Method Details

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/devdraft/models/update_product_dto.rb', line 75

def self.attribute_map
  {
    :'name' => :'name',
    :'description' => :'description',
    :'price' => :'price',
    :'currency' => :'currency',
    :'type' => :'type',
    :'weight' => :'weight',
    :'unit' => :'unit',
    :'quantity' => :'quantity',
    :'stock_count' => :'stockCount',
    :'status' => :'status',
    :'product_type' => :'productType',
    :'images' => :'images'
  }
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



243
244
245
 
# File 'lib/devdraft/models/update_product_dto.rb', line 243

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



111
112
113
114
 
# File 'lib/devdraft/models/update_product_dto.rb', line 111

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

.openapi_types ⇒ Object

Attribute type mapping.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/devdraft/models/update_product_dto.rb', line 93

def self.openapi_types
  {
    :'name' => :'Object',
    :'description' => :'Object',
    :'price' => :'Object',
    :'currency' => :'Object',
    :'type' => :'Object',
    :'weight' => :'Object',
    :'unit' => :'Object',
    :'quantity' => :'Object',
    :'stock_count' => :'Object',
    :'status' => :'Object',
    :'product_type' => :'Object',
    :'images' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/devdraft/models/update_product_dto.rb', line 211

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      description == o.description &&
      price == o.price &&
      currency == o.currency &&
      type == o.type &&
      weight == o.weight &&
      unit == o.unit &&
      quantity == o.quantity &&
      stock_count == o.stock_count &&
      status == o.status &&
      product_type == o.product_type &&
      images == o.images
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



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/devdraft/models/update_product_dto.rb', line 273

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
    DevDraftAI.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



342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/devdraft/models/update_product_dto.rb', line 342

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



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/devdraft/models/update_product_dto.rb', line 250

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]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


230
231
232
 
# File 'lib/devdraft/models/update_product_dto.rb', line 230

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



236
237
238
 
# File 'lib/devdraft/models/update_product_dto.rb', line 236

def hash
  [name, description, price, currency, type, weight, unit, quantity, stock_count, status, product_type, images].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



186
187
188
189
 
# File 'lib/devdraft/models/update_product_dto.rb', line 186

def list_invalid_properties
  invalid_properties = Array.new
  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



318
319
320
 
# File 'lib/devdraft/models/update_product_dto.rb', line 318

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



324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/devdraft/models/update_product_dto.rb', line 324

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



312
313
314
 
# File 'lib/devdraft/models/update_product_dto.rb', line 312

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



193
194
195
196
197
 
# File 'lib/devdraft/models/update_product_dto.rb', line 193

def valid?
  currency_validator = EnumAttributeValidator.new('Object', ['USD', 'EUR', 'GBP', 'CAD', 'AUD', 'JPY'])
  return false unless currency_validator.valid?(@currency)
  true
end