Class: OryClient::InvoiceDataV1

Inherits:
Object
  • Object
show all
Defined in:
lib/ory-client/models/invoice_data_v1.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InvoiceDataV1

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/ory-client/models/invoice_data_v1.rb', line 99

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'title')
    self.title = attributes[:'title']
  else
    self.title = nil
  end

  if attributes.key?(:'total_in_cent')
    self.total_in_cent = attributes[:'total_in_cent']
  else
    self.total_in_cent = nil
  end
end

Instance Attribute Details

#billing_period ⇒ Object

Returns the value of attribute billing_period.



18
19
20
 
# File 'lib/ory-client/models/invoice_data_v1.rb', line 18

def billing_period
  @billing_period
end

#currency ⇒ Object

The currency of the invoice.



21
22
23
 
# File 'lib/ory-client/models/invoice_data_v1.rb', line 21

def currency
  @currency
end

#deleted ⇒ Object

Deleted is true if the invoice has been soft-deleted.



24
25
26
 
# File 'lib/ory-client/models/invoice_data_v1.rb', line 24

def deleted
  @deleted
end

#items ⇒ Object

The items that are part of this invoice.



27
28
29
 
# File 'lib/ory-client/models/invoice_data_v1.rb', line 27

def items
  @items
end

#plan ⇒ Object

The plan that this invoice is based on, in the format "Name@version".



30
31
32
 
# File 'lib/ory-client/models/invoice_data_v1.rb', line 30

def plan
  @plan
end

#stripe_invoice_item ⇒ Object

Returns the value of attribute stripe_invoice_item.



32
33
34
 
# File 'lib/ory-client/models/invoice_data_v1.rb', line 32

def stripe_invoice_item
  @stripe_invoice_item
end

#stripe_invoice_status ⇒ Object

The status of the invoice, one of ‘draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](stripe.com/docs/billing/invoices/workflow#workflow-overview)



35
36
37
 
# File 'lib/ory-client/models/invoice_data_v1.rb', line 35

def stripe_invoice_status
  @stripe_invoice_status
end

#stripe_link ⇒ Object

An optional link to the invoice on Stripe.



38
39
40
 
# File 'lib/ory-client/models/invoice_data_v1.rb', line 38

def stripe_link
  @stripe_link
end

#subtitle ⇒ Object

The subtitle of the invoice.



41
42
43
 
# File 'lib/ory-client/models/invoice_data_v1.rb', line 41

def subtitle
  @subtitle
end

#tax ⇒ Object

Returns the value of attribute tax.



43
44
45
 
# File 'lib/ory-client/models/invoice_data_v1.rb', line 43

def tax
  @tax
end

#title ⇒ Object

The title of the invoice.



46
47
48
 
# File 'lib/ory-client/models/invoice_data_v1.rb', line 46

def title
  @title
end

#total_in_cent ⇒ Object

Returns the value of attribute total_in_cent.



48
49
50
 
# File 'lib/ory-client/models/invoice_data_v1.rb', line 48

def total_in_cent
  @total_in_cent
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



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
305
306
307
308
 
# File 'lib/ory-client/models/invoice_data_v1.rb', line 271

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 = OryClient.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



69
70
71
 
# File 'lib/ory-client/models/invoice_data_v1.rb', line 69

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/ory-client/models/invoice_data_v1.rb', line 51

def self.attribute_map
  {
    :'billing_period' => :'billing_period',
    :'currency' => :'currency',
    :'deleted' => :'deleted',
    :'items' => :'items',
    :'plan' => :'plan',
    :'stripe_invoice_item' => :'stripe_invoice_item',
    :'stripe_invoice_status' => :'stripe_invoice_status',
    :'stripe_link' => :'stripe_link',
    :'subtitle' => :'subtitle',
    :'tax' => :'tax',
    :'title' => :'title',
    :'total_in_cent' => :'total_in_cent'
  }
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



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/ory-client/models/invoice_data_v1.rb', line 247

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



92
93
94
95
 
# File 'lib/ory-client/models/invoice_data_v1.rb', line 92

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

.openapi_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/ory-client/models/invoice_data_v1.rb', line 74

def self.openapi_types
  {
    :'billing_period' => :'TimeInterval',
    :'currency' => :'String',
    :'deleted' => :'Boolean',
    :'items' => :'Array<LineItemV1>',
    :'plan' => :'String',
    :'stripe_invoice_item' => :'String',
    :'stripe_invoice_status' => :'String',
    :'stripe_link' => :'String',
    :'subtitle' => :'String',
    :'tax' => :'TaxLineItem',
    :'title' => :'String',
    :'total_in_cent' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/ory-client/models/invoice_data_v1.rb', line 215

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      billing_period == o.billing_period &&
      currency == o.currency &&
      deleted == o.deleted &&
      items == o.items &&
      plan == o.plan &&
      stripe_invoice_item == o.stripe_invoice_item &&
      stripe_invoice_status == o.stripe_invoice_status &&
      stripe_link == o.stripe_link &&
      subtitle == o.subtitle &&
      tax == o.tax &&
      title == o.title &&
      total_in_cent == o.total_in_cent
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/ory-client/models/invoice_data_v1.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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


234
235
236
 
# File 'lib/ory-client/models/invoice_data_v1.rb', line 234

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



240
241
242
 
# File 'lib/ory-client/models/invoice_data_v1.rb', line 240

def hash
  [billing_period, currency, deleted, items, plan, stripe_invoice_item, stripe_invoice_status, stripe_link, subtitle, tax, title, total_in_cent].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



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/ory-client/models/invoice_data_v1.rb', line 175

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @billing_period.nil?
    invalid_properties.push('invalid value for "billing_period", billing_period cannot be nil.')
  end

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

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

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

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



318
319
320
 
# File 'lib/ory-client/models/invoice_data_v1.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/ory-client/models/invoice_data_v1.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/ory-client/models/invoice_data_v1.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



203
204
205
206
207
208
209
210
211
 
# File 'lib/ory-client/models/invoice_data_v1.rb', line 203

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @billing_period.nil?
  return false if @currency.nil?
  return false if @items.nil?
  return false if @title.nil?
  return false if @total_in_cent.nil?
  true
end