Class: AdvancedBilling::PaginatedMetadata

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

Overview

PaginatedMetadata Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(total_count: SKIP, current_page: SKIP, total_pages: SKIP, per_page: SKIP, metadata: SKIP, additional_properties: {}) ⇒ PaginatedMetadata

Returns a new instance of PaginatedMetadata.



59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/advanced_billing/models/paginated_metadata.rb', line 59

def initialize(total_count: SKIP, current_page: SKIP, total_pages: SKIP,
               per_page: SKIP, metadata: SKIP, additional_properties: {})
  @total_count = total_count unless total_count == SKIP
  @current_page = current_page unless current_page == SKIP
  @total_pages = total_pages unless total_pages == SKIP
  @per_page = per_page unless per_page == SKIP
  @metadata = metadata unless metadata == SKIP

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

Instance Attribute Details

#current_page ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


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

def current_page
  @current_page
end

#metadata ⇒ Array[Metadata]

TODO: Write general description for this method

Returns:



30
31
32
 
# File 'lib/advanced_billing/models/paginated_metadata.rb', line 30

def metadata
  @metadata
end

#per_page ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


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

def per_page
  @per_page
end

#total_count ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


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

def total_count
  @total_count
end

#total_pages ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


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

def total_pages
  @total_pages
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/advanced_billing/models/paginated_metadata.rb', line 74

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  total_count = hash.key?('total_count') ? hash['total_count'] : SKIP
  current_page = hash.key?('current_page') ? hash['current_page'] : SKIP
  total_pages = hash.key?('total_pages') ? hash['total_pages'] : SKIP
  per_page = hash.key?('per_page') ? hash['per_page'] : SKIP
  # Parameter is an array, so we need to iterate through it
  metadata = nil
  unless hash['metadata'].nil?
    metadata = []
    hash['metadata'].each do |structure|
      metadata << (Metadata.from_hash(structure) if structure)
    end
  end

  metadata = SKIP unless hash.key?('metadata')

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

  # Create object from extracted values.
  PaginatedMetadata.new(total_count: total_count,
                        current_page: current_page,
                        total_pages: total_pages,
                        per_page: per_page,
                        metadata: metadata,
                        additional_properties: hash)
end

.names ⇒ Object

A mapping from model property names to API property names.



33
34
35
36
37
38
39
40
41
 
# File 'lib/advanced_billing/models/paginated_metadata.rb', line 33

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['total_count'] = 'total_count'
  @_hash['current_page'] = 'current_page'
  @_hash['total_pages'] = 'total_pages'
  @_hash['per_page'] = 'per_page'
  @_hash['metadata'] = 'metadata'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



55
56
57
 
# File 'lib/advanced_billing/models/paginated_metadata.rb', line 55

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



44
45
46
47
48
49
50
51
52
 
# File 'lib/advanced_billing/models/paginated_metadata.rb', line 44

def self.optionals
  %w[
    total_count
    current_page
    total_pages
    per_page
    metadata
  ]
end