Class: Patch::OrderLineItem

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderLineItem

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
146
147
148
149
150
151
 
# File 'lib/patch_ruby/models/order_line_item.rb', line 100

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

The amount ordered for the given project and vintage year.



34
35
36
 
# File 'lib/patch_ruby/models/order_line_item.rb', line 34

def amount
  @amount
end

#currency ⇒ Object

The currency code for the ‘price`.



43
44
45
 
# File 'lib/patch_ruby/models/order_line_item.rb', line 43

def currency
  @currency
end

#id ⇒ Object

The identifier for this order line item



19
20
21
 
# File 'lib/patch_ruby/models/order_line_item.rb', line 19

def id
  @id
end

#price ⇒ Object

The price for the given amount ordered for the given project and vintage year. Does not include any Patch fee. Prices are always represented in the smallest currency unit (ie cents for USD).



40
41
42
 
# File 'lib/patch_ruby/models/order_line_item.rb', line 40

def price
  @price
end

#project ⇒ Object

An object containing information about the project associated with the inventory allocated.



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

def project
  @project
end

#unit ⇒ Object

The unit of measurement (ie "g" or "Wh") for the ‘amount` ordered for the given project and vintage year.



37
38
39
 
# File 'lib/patch_ruby/models/order_line_item.rb', line 37

def unit
  @unit
end

#vintage_end_year ⇒ Object

The ending year in which the climate impacts of the project occurred, or will occur.



31
32
33
 
# File 'lib/patch_ruby/models/order_line_item.rb', line 31

def vintage_end_year
  @vintage_end_year
end

#vintage_start_year ⇒ Object

The starting year in which the climate impacts of the project occurred, or will occur.



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

def vintage_start_year
  @vintage_start_year
end

#vintage_year ⇒ Object

The year in which the climate impacts of the project occurred, or will occur.



25
26
27
 
# File 'lib/patch_ruby/models/order_line_item.rb', line 25

def vintage_year
  @vintage_year
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



61
62
63
 
# File 'lib/patch_ruby/models/order_line_item.rb', line 61

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/patch_ruby/models/order_line_item.rb', line 46

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



237
238
239
 
# File 'lib/patch_ruby/models/order_line_item.rb', line 237

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



90
91
92
93
94
95
96
 
# File 'lib/patch_ruby/models/order_line_item.rb', line 90

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



81
82
83
84
 
# File 'lib/patch_ruby/models/order_line_item.rb', line 81

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

.openapi_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/patch_ruby/models/order_line_item.rb', line 66

def self.openapi_types
  {
    :'id' => :'String',
    :'project' => :'OrderLineItemProject',
    :'vintage_year' => :'Integer',
    :'vintage_start_year' => :'Integer',
    :'vintage_end_year' => :'Integer',
    :'amount' => :'Integer',
    :'unit' => :'String',
    :'price' => :'Integer',
    :'currency' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/patch_ruby/models/order_line_item.rb', line 208

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



267
268
269
270
271
272
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
 
# File 'lib/patch_ruby/models/order_line_item.rb', line 267

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



338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/patch_ruby/models/order_line_item.rb', line 338

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



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/patch_ruby/models/order_line_item.rb', line 244

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


224
225
226
 
# File 'lib/patch_ruby/models/order_line_item.rb', line 224

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



230
231
232
 
# File 'lib/patch_ruby/models/order_line_item.rb', line 230

def hash
  [id, project, vintage_year, vintage_start_year, vintage_end_year, amount, unit, price, currency].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



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
183
184
185
186
187
188
189
190
 
# File 'lib/patch_ruby/models/order_line_item.rb', line 155

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

  if @vintage_year.nil?
    invalid_properties.push('invalid value for "vintage_year", vintage_year cannot be nil.')
  end

  if @vintage_start_year.nil?
    invalid_properties.push('invalid value for "vintage_start_year", vintage_start_year cannot be nil.')
  end

  if @vintage_end_year.nil?
    invalid_properties.push('invalid value for "vintage_end_year", vintage_end_year cannot be nil.')
  end

  if @amount.nil?
    invalid_properties.push('invalid value for "amount", amount cannot be nil.')
  end

  if @unit.nil?
    invalid_properties.push('invalid value for "unit", unit cannot be nil.')
  end

  if @price.nil?
    invalid_properties.push('invalid value for "price", price cannot be nil.')
  end

  if @currency.nil?
    invalid_properties.push('invalid value for "currency", currency cannot be nil.')
  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



314
315
316
 
# File 'lib/patch_ruby/models/order_line_item.rb', line 314

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



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

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



308
309
310
 
# File 'lib/patch_ruby/models/order_line_item.rb', line 308

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



194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/patch_ruby/models/order_line_item.rb', line 194

def valid?
  return false if @project.nil?
  return false if @vintage_year.nil?
  return false if @vintage_start_year.nil?
  return false if @vintage_end_year.nil?
  return false if @amount.nil?
  return false if @unit.nil?
  return false if @price.nil?
  return false if @currency.nil?
  true
end