Class: GetAroundOwner::Invoice

Inherits:
Object
  • Object
show all
Defined in:
lib/get_around_owner/models/invoice.rb

Overview

An invoice.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Invoice

Initializes the object

Parameters:

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

    Model attributes in the form of hash



82
83
84
85
86
87
88
89
90
91
92
93
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
 
# File 'lib/get_around_owner/models/invoice.rb', line 82

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

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

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

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

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

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

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

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

Instance Attribute Details

#charges ⇒ Object

Array of charges



42
43
44
 
# File 'lib/get_around_owner/models/invoice.rb', line 42

def charges
  @charges
end

#currency ⇒ Object

The currency of the invoice amount (ISO 4217 alphabetic code)



36
37
38
 
# File 'lib/get_around_owner/models/invoice.rb', line 36

def currency
  @currency
end

#emitted_at ⇒ Object

The date at which the invoice was emitted



30
31
32
 
# File 'lib/get_around_owner/models/invoice.rb', line 30

def emitted_at
  @emitted_at
end

#entity_type ⇒ Object

The type of entity the invoice is related to



39
40
41
 
# File 'lib/get_around_owner/models/invoice.rb', line 39

def entity_type
  @entity_type
end

#id ⇒ Object

The invoice ID



18
19
20
 
# File 'lib/get_around_owner/models/invoice.rb', line 18

def id
  @id
end

#pdf_url ⇒ Object

The temporary url (lifetime: 20min) to download the pdf of the tax invoice is generated each to time you call the endpoint. Also, the ‘links’ variable will not be present if there is no uploaded invoice yet. This could happen if the job to generate & upload the invoice is not done yet.



21
22
23
 
# File 'lib/get_around_owner/models/invoice.rb', line 21

def pdf_url
  @pdf_url
end

#product_id ⇒ Object

The id of the product the invoice is related to



27
28
29
 
# File 'lib/get_around_owner/models/invoice.rb', line 27

def product_id
  @product_id
end

#product_type ⇒ Object

The type of product the invoice is related to



24
25
26
 
# File 'lib/get_around_owner/models/invoice.rb', line 24

def product_type
  @product_type
end

#total_price ⇒ Object

The invoice amount, which is what you will receive (or which will be debited from your account if it is negative)



33
34
35
 
# File 'lib/get_around_owner/models/invoice.rb', line 33

def total_price
  @total_price
end

Class Method Details

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/get_around_owner/models/invoice.rb', line 45

def self.attribute_map
  {
    :'id' => :'id',
    :'pdf_url' => :'pdf_url',
    :'product_type' => :'product_type',
    :'product_id' => :'product_id',
    :'emitted_at' => :'emitted_at',
    :'total_price' => :'total_price',
    :'currency' => :'currency',
    :'entity_type' => :'entity_type',
    :'charges' => :'charges'
  }
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



216
217
218
 
# File 'lib/get_around_owner/models/invoice.rb', line 216

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



75
76
77
78
 
# File 'lib/get_around_owner/models/invoice.rb', line 75

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

.openapi_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/get_around_owner/models/invoice.rb', line 60

def self.openapi_types
  {
    :'id' => :'Object',
    :'pdf_url' => :'Object',
    :'product_type' => :'Object',
    :'product_id' => :'Object',
    :'emitted_at' => :'Object',
    :'total_price' => :'Object',
    :'currency' => :'Object',
    :'entity_type' => :'Object',
    :'charges' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/get_around_owner/models/invoice.rb', line 187

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      pdf_url == o.pdf_url &&
      product_type == o.product_type &&
      product_id == o.product_id &&
      emitted_at == o.emitted_at &&
      total_price == o.total_price &&
      currency == o.currency &&
      entity_type == o.entity_type &&
      charges == o.charges
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



246
247
248
249
250
251
252
253
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
 
# File 'lib/get_around_owner/models/invoice.rb', line 246

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



315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/get_around_owner/models/invoice.rb', line 315

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



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/get_around_owner/models/invoice.rb', line 223

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


203
204
205
 
# File 'lib/get_around_owner/models/invoice.rb', line 203

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



209
210
211
 
# File 'lib/get_around_owner/models/invoice.rb', line 209

def hash
  [id, pdf_url, product_type, product_id, emitted_at, total_price, currency, entity_type, charges].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



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/get_around_owner/models/invoice.rb', line 134

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

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

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

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

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

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

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

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



291
292
293
 
# File 'lib/get_around_owner/models/invoice.rb', line 291

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



297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/get_around_owner/models/invoice.rb', line 297

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



285
286
287
 
# File 'lib/get_around_owner/models/invoice.rb', line 285

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
183
 
# File 'lib/get_around_owner/models/invoice.rb', line 173

def valid?
  return false if @id.nil?
  return false if @pdf_url.nil?
  return false if @product_type.nil?
  return false if @product_id.nil?
  return false if @emitted_at.nil?
  return false if @total_price.nil?
  return false if @currency.nil?
  return false if @entity_type.nil?
  true
end