Class: Patch::CreateOrderLineItemRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/patch_ruby/models/create_order_line_item_request.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateOrderLineItemRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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/patch_ruby/models/create_order_line_item_request.rb', line 106

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

Returns the value of attribute amount.



26
27
28
 
# File 'lib/patch_ruby/models/create_order_line_item_request.rb', line 26

def amount
  @amount
end

#currency ⇒ Object

Returns the value of attribute currency.



24
25
26
 
# File 'lib/patch_ruby/models/create_order_line_item_request.rb', line 24

def currency
  @currency
end

#price ⇒ Object

Returns the value of attribute price.



22
23
24
 
# File 'lib/patch_ruby/models/create_order_line_item_request.rb', line 22

def price
  @price
end

#project_id ⇒ Object

Returns the value of attribute project_id.



18
19
20
 
# File 'lib/patch_ruby/models/create_order_line_item_request.rb', line 18

def project_id
  @project_id
end

#unit ⇒ Object

Returns the value of attribute unit.



28
29
30
 
# File 'lib/patch_ruby/models/create_order_line_item_request.rb', line 28

def unit
  @unit
end

#vintage_year ⇒ Object

Returns the value of attribute vintage_year.



20
21
22
 
# File 'lib/patch_ruby/models/create_order_line_item_request.rb', line 20

def vintage_year
  @vintage_year
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



65
66
67
 
# File 'lib/patch_ruby/models/create_order_line_item_request.rb', line 65

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
 
# File 'lib/patch_ruby/models/create_order_line_item_request.rb', line 53

def self.attribute_map
  {
    :'project_id' => :'project_id',
    :'vintage_year' => :'vintage_year',
    :'price' => :'price',
    :'currency' => :'currency',
    :'amount' => :'amount',
    :'unit' => :'unit'
  }
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



260
261
262
 
# File 'lib/patch_ruby/models/create_order_line_item_request.rb', line 260

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



96
97
98
99
100
101
102
 
# File 'lib/patch_ruby/models/create_order_line_item_request.rb', line 96

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



82
83
84
85
86
87
88
89
90
 
# File 'lib/patch_ruby/models/create_order_line_item_request.rb', line 82

def self.openapi_nullable
  Set.new([
    :'vintage_year',
    :'price',
    :'currency',
    :'amount',
    :'unit'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
 
# File 'lib/patch_ruby/models/create_order_line_item_request.rb', line 70

def self.openapi_types
  {
    :'project_id' => :'String',
    :'vintage_year' => :'Integer',
    :'price' => :'Integer',
    :'currency' => :'String',
    :'amount' => :'Integer',
    :'unit' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



234
235
236
237
238
239
240
241
242
243
 
# File 'lib/patch_ruby/models/create_order_line_item_request.rb', line 234

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      project_id == o.project_id &&
      vintage_year == o.vintage_year &&
      price == o.price &&
      currency == o.currency &&
      amount == o.amount &&
      unit == o.unit
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



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/patch_ruby/models/create_order_line_item_request.rb', line 290

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



361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/patch_ruby/models/create_order_line_item_request.rb', line 361

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



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

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


247
248
249
 
# File 'lib/patch_ruby/models/create_order_line_item_request.rb', line 247

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



253
254
255
 
# File 'lib/patch_ruby/models/create_order_line_item_request.rb', line 253

def hash
  [project_id, vintage_year, price, currency, amount, unit].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
162
163
164
165
166
167
168
169
 
# File 'lib/patch_ruby/models/create_order_line_item_request.rb', line 146

def list_invalid_properties
  invalid_properties = Array.new
  if !@vintage_year.nil? && @vintage_year > 2100
    invalid_properties.push('invalid value for "vintage_year", must be smaller than or equal to 2100.')
  end

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

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

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

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



337
338
339
 
# File 'lib/patch_ruby/models/create_order_line_item_request.rb', line 337

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



343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/patch_ruby/models/create_order_line_item_request.rb', line 343

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



331
332
333
 
# File 'lib/patch_ruby/models/create_order_line_item_request.rb', line 331

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



173
174
175
176
177
178
179
180
181
182
 
# File 'lib/patch_ruby/models/create_order_line_item_request.rb', line 173

def valid?
  return false if !@vintage_year.nil? && @vintage_year > 2100
  return false if !@vintage_year.nil? && @vintage_year < 1900
  return false if !@price.nil? && @price < 2
  return false if !@amount.nil? && @amount > 100000000000
  return false if !@amount.nil? && @amount < 0
  unit_validator = EnumAttributeValidator.new('String', ["g", "Wh"])
  return false unless unit_validator.valid?(@unit)
  true
end