Class: AdvancedBilling::ListInvoiceEventsResponse

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/advanced_billing/models/list_invoice_events_response.rb

Overview

ListInvoiceEventsResponse Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(events: SKIP, page: SKIP, per_page: SKIP, total_pages: SKIP, additional_properties: {}) ⇒ ListInvoiceEventsResponse

Returns a new instance of ListInvoiceEventsResponse.



53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/advanced_billing/models/list_invoice_events_response.rb', line 53

def initialize(events: SKIP, page: SKIP, per_page: SKIP, total_pages: SKIP,
               additional_properties: {})
  @events = events unless events == SKIP
  @page = page unless page == SKIP
  @per_page = per_page unless per_page == SKIP
  @total_pages = total_pages unless total_pages == SKIP

  # Add additional model properties to the instance.
  additional_properties.each do |_name, _value|
    instance_variable_set("@#{_name}", _value)
  end
end

Instance Attribute Details

#events ⇒ Array[Object]

TODO: Write general description for this method

Returns:

  • (Array[Object]) 


14
15
16
 
# File 'lib/advanced_billing/models/list_invoice_events_response.rb', line 14

def events
  @events
end

#page ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


18
19
20
 
# File 'lib/advanced_billing/models/list_invoice_events_response.rb', line 18

def page
  @page
end

#per_page ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


22
23
24
 
# File 'lib/advanced_billing/models/list_invoice_events_response.rb', line 22

def per_page
  @per_page
end

#total_pages ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


26
27
28
 
# File 'lib/advanced_billing/models/list_invoice_events_response.rb', line 26

def total_pages
  @total_pages
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/advanced_billing/models/list_invoice_events_response.rb', line 67

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  events = hash.key?('events') ? APIHelper.deserialize_union_type(
    UnionTypeLookUp.get(:InvoiceEvent), hash['events']
  ) : SKIP
  page = hash.key?('page') ? hash['page'] : SKIP
  per_page = hash.key?('per_page') ? hash['per_page'] : SKIP
  total_pages = hash.key?('total_pages') ? hash['total_pages'] : SKIP

  # Clean out expected properties from Hash.
  names.each_value { |k| hash.delete(k) }

  # Create object from extracted values.
  ListInvoiceEventsResponse.new(events: events,
                                page: page,
                                per_page: per_page,
                                total_pages: total_pages,
                                additional_properties: hash)
end

.names ⇒ Object

A mapping from model property names to API property names.



29
30
31
32
33
34
35
36
 
# File 'lib/advanced_billing/models/list_invoice_events_response.rb', line 29

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['events'] = 'events'
  @_hash['page'] = 'page'
  @_hash['per_page'] = 'per_page'
  @_hash['total_pages'] = 'total_pages'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



49
50
51
 
# File 'lib/advanced_billing/models/list_invoice_events_response.rb', line 49

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



39
40
41
42
43
44
45
46
 
# File 'lib/advanced_billing/models/list_invoice_events_response.rb', line 39

def self.optionals
  %w[
    events
    page
    per_page
    total_pages
  ]
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:



91
92
93
94
95
96
97
 
# File 'lib/advanced_billing/models/list_invoice_events_response.rb', line 91

def self.validate(value)
  return true if value.instance_of? self

  return false unless value.instance_of? Hash

  true
end