Class: LinodeOpenapiClient::AddedGetInvoiceItems200DataInner

Inherits:
Object
  • Object
show all
Defined in:
lib/linode_openapi_client/models/added_get_invoice_items200_data_inner.rb

Overview

An InvoiceItem object.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AddedGetInvoiceItems200DataInner

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/linode_openapi_client/models/added_get_invoice_items200_data_inner.rb', line 117

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

Read-only The price, in US dollars, of the Invoice Item. Equal to the unit price multiplied by quantity.



29
30
31
 
# File 'lib/linode_openapi_client/models/added_get_invoice_items200_data_inner.rb', line 29

def amount
  @amount
end

#from ⇒ Object

Read-only The date the Invoice Item started, based on month.



35
36
37
 
# File 'lib/linode_openapi_client/models/added_get_invoice_items200_data_inner.rb', line 35

def from
  @from
end

#label ⇒ Object

Read-only The Invoice Item’s display label.



20
21
22
 
# File 'lib/linode_openapi_client/models/added_get_invoice_items200_data_inner.rb', line 20

def label
  @label
end

#quantity ⇒ Object

Read-only The quantity of this Item for the specified Invoice.



32
33
34
 
# File 'lib/linode_openapi_client/models/added_get_invoice_items200_data_inner.rb', line 32

def quantity
  @quantity
end

#region ⇒ Object

Read-only The ID of the applicable Region associated with this Invoice Item. ‘null` if there is no applicable Region.



47
48
49
 
# File 'lib/linode_openapi_client/models/added_get_invoice_items200_data_inner.rb', line 47

def region
  @region
end

#tax ⇒ Object

Read-only The amount of tax levied on this Item in US Dollars.



38
39
40
 
# File 'lib/linode_openapi_client/models/added_get_invoice_items200_data_inner.rb', line 38

def tax
  @tax
end

#to ⇒ Object

Read-only The date the Invoice Item ended, based on month.



26
27
28
 
# File 'lib/linode_openapi_client/models/added_get_invoice_items200_data_inner.rb', line 26

def to
  @to
end

#total ⇒ Object

Read-only The price of this Item after taxes in US Dollars.



44
45
46
 
# File 'lib/linode_openapi_client/models/added_get_invoice_items200_data_inner.rb', line 44

def total
  @total
end

#type ⇒ Object

Read-only The type of service, ether ‘hourly` or `misc`.



23
24
25
 
# File 'lib/linode_openapi_client/models/added_get_invoice_items200_data_inner.rb', line 23

def type
  @type
end

#unit_price ⇒ Object

Read-only The monthly service fee in US Dollars for this Item.



41
42
43
 
# File 'lib/linode_openapi_client/models/added_get_invoice_items200_data_inner.rb', line 41

def unit_price
  @unit_price
end

Class Method Details

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



254
255
256
257
258
259
260
261
262
263
264
265
266
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
 
# File 'lib/linode_openapi_client/models/added_get_invoice_items200_data_inner.rb', line 254

def self._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 = LinodeOpenapiClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



88
89
90
 
# File 'lib/linode_openapi_client/models/added_get_invoice_items200_data_inner.rb', line 88

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/linode_openapi_client/models/added_get_invoice_items200_data_inner.rb', line 72

def self.attribute_map
  {
    :'label' => :'label',
    :'type' => :'type',
    :'to' => :'to',
    :'amount' => :'amount',
    :'quantity' => :'quantity',
    :'from' => :'from',
    :'tax' => :'tax',
    :'unit_price' => :'unit_price',
    :'total' => :'total',
    :'region' => :'region'
  }
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



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/linode_openapi_client/models/added_get_invoice_items200_data_inner.rb', line 230

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



109
110
111
112
113
 
# File 'lib/linode_openapi_client/models/added_get_invoice_items200_data_inner.rb', line 109

def self.openapi_nullable
  Set.new([
    :'region'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'label' => :'String',
    :'type' => :'String',
    :'to' => :'Time',
    :'amount' => :'Float',
    :'quantity' => :'Integer',
    :'from' => :'Time',
    :'tax' => :'Float',
    :'unit_price' => :'String',
    :'total' => :'Float',
    :'region' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/linode_openapi_client/models/added_get_invoice_items200_data_inner.rb', line 200

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      label == o.label &&
      type == o.type &&
      to == o.to &&
      amount == o.amount &&
      quantity == o.quantity &&
      from == o.from &&
      tax == o.tax &&
      unit_price == o.unit_price &&
      total == o.total &&
      region == o.region
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



325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/linode_openapi_client/models/added_get_invoice_items200_data_inner.rb', line 325

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


217
218
219
 
# File 'lib/linode_openapi_client/models/added_get_invoice_items200_data_inner.rb', line 217

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



223
224
225
 
# File 'lib/linode_openapi_client/models/added_get_invoice_items200_data_inner.rb', line 223

def hash
  [label, type, to, amount, quantity, from, tax, unit_price, total, region].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



173
174
175
176
177
 
# File 'lib/linode_openapi_client/models/added_get_invoice_items200_data_inner.rb', line 173

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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



301
302
303
 
# File 'lib/linode_openapi_client/models/added_get_invoice_items200_data_inner.rb', line 301

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



307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/linode_openapi_client/models/added_get_invoice_items200_data_inner.rb', line 307

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



295
296
297
 
# File 'lib/linode_openapi_client/models/added_get_invoice_items200_data_inner.rb', line 295

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



181
182
183
184
185
186
 
# File 'lib/linode_openapi_client/models/added_get_invoice_items200_data_inner.rb', line 181

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  type_validator = EnumAttributeValidator.new('String', ["hourly", "misc"])
  return false unless type_validator.valid?(@type)
  true
end