Class: CtdDocumentation::PaginatedResponse

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/ctd_documentation/models/paginated_response.rb

Overview

PaginatedResponse Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(count_filtered = SKIP, count_total = SKIP, count_in_page = SKIP) ⇒ PaginatedResponse

Returns a new instance of PaginatedResponse.



47
48
49
50
51
52
53
 
# File 'lib/ctd_documentation/models/paginated_response.rb', line 47

def initialize(count_filtered = SKIP,
               count_total = SKIP,
               count_in_page = SKIP)
  @count_filtered = count_filtered unless count_filtered == SKIP
  @count_total = count_total unless count_total == SKIP
  @count_in_page = count_in_page unless count_in_page == SKIP
end

Instance Attribute Details

#count_filtered ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


14
15
16
 
# File 'lib/ctd_documentation/models/paginated_response.rb', line 14

def count_filtered
  @count_filtered
end

#count_in_page ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


22
23
24
 
# File 'lib/ctd_documentation/models/paginated_response.rb', line 22

def count_in_page
  @count_in_page
end

#count_total ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


18
19
20
 
# File 'lib/ctd_documentation/models/paginated_response.rb', line 18

def count_total
  @count_total
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/ctd_documentation/models/paginated_response.rb', line 56

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  count_filtered =
    hash.key?('count_filtered') ? hash['count_filtered'] : SKIP
  count_total = hash.key?('count_total') ? hash['count_total'] : SKIP
  count_in_page = hash.key?('count_in_page') ? hash['count_in_page'] : SKIP

  # Create object from extracted values.

  PaginatedResponse.new(count_filtered,
                        count_total,
                        count_in_page)
end

.names ⇒ Object

A mapping from model property names to API property names.



25
26
27
28
29
30
31
 
# File 'lib/ctd_documentation/models/paginated_response.rb', line 25

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['count_filtered'] = 'count_filtered'
  @_hash['count_total'] = 'count_total'
  @_hash['count_in_page'] = 'count_in_page'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



43
44
45
 
# File 'lib/ctd_documentation/models/paginated_response.rb', line 43

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



34
35
36
37
38
39
40
 
# File 'lib/ctd_documentation/models/paginated_response.rb', line 34

def self.optionals
  %w[
    count_filtered
    count_total
    count_in_page
  ]
end