Class: TheCompaniesAPI::Generated::Models::PaginationMeta

Inherits:
Object
  • Object
show all
Defined in:
lib/thecompaniesapi/generated/models/pagination_meta.rb

Overview

Metadata about a paginated or billed response.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data = {}) ⇒ PaginationMeta

Initialize a new PaginationMeta

Parameters:

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

    Initial data



42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/thecompaniesapi/generated/models/pagination_meta.rb', line 42

def initialize(data = {})
                @cost = data['cost']
                @credits = data['credits']
                @current_page = data['currentPage']
                @first_page = data['firstPage']
                @free_request = data['freeRequest']
                @last_page = data['lastPage']
                @max_scroll_results_reached = data['maxScrollResultsReached']
                @per_page = data['perPage']
                @total = data['total']
end

Instance Attribute Details

#cost ⇒ Float

Returns cost.

Returns:

  • (Float) —

    cost



12
13
14
 
# File 'lib/thecompaniesapi/generated/models/pagination_meta.rb', line 12

def cost
  @cost
end

#credits ⇒ Float

Returns credits.

Returns:

  • (Float) —

    credits



15
16
17
 
# File 'lib/thecompaniesapi/generated/models/pagination_meta.rb', line 15

def credits
  @credits
end

#current_page ⇒ Float

Returns currentPage.

Returns:

  • (Float) —

    currentPage



18
19
20
 
# File 'lib/thecompaniesapi/generated/models/pagination_meta.rb', line 18

def current_page
  @current_page
end

#first_page ⇒ Float

Returns firstPage.

Returns:

  • (Float) —

    firstPage



21
22
23
 
# File 'lib/thecompaniesapi/generated/models/pagination_meta.rb', line 21

def first_page
  @first_page
end

#free_request ⇒ Boolean

Returns freeRequest.

Returns:

  • (Boolean) —

    freeRequest



24
25
26
 
# File 'lib/thecompaniesapi/generated/models/pagination_meta.rb', line 24

def free_request
  @free_request
end

#last_page ⇒ Float

Returns lastPage.

Returns:

  • (Float) —

    lastPage



27
28
29
 
# File 'lib/thecompaniesapi/generated/models/pagination_meta.rb', line 27

def last_page
  @last_page
end

#max_scroll_results_reached ⇒ Boolean

Returns maxScrollResultsReached.

Returns:

  • (Boolean) —

    maxScrollResultsReached



30
31
32
 
# File 'lib/thecompaniesapi/generated/models/pagination_meta.rb', line 30

def max_scroll_results_reached
  @max_scroll_results_reached
end

#per_page ⇒ Float

Returns perPage.

Returns:

  • (Float) —

    perPage



33
34
35
 
# File 'lib/thecompaniesapi/generated/models/pagination_meta.rb', line 33

def per_page
  @per_page
end

#total ⇒ Float

Returns total.

Returns:

  • (Float) —

    total



36
37
38
 
# File 'lib/thecompaniesapi/generated/models/pagination_meta.rb', line 36

def total
  @total
end

Instance Method Details

#to_hash ⇒ Hash Also known as: to_h

Convert to hash

Returns:

  • (Hash) —

    Hash representation



58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/thecompaniesapi/generated/models/pagination_meta.rb', line 58

def to_hash
  {
          'cost' => @cost,
          'credits' => @credits,
          'currentPage' => @current_page,
          'firstPage' => @first_page,
          'freeRequest' => @free_request,
          'lastPage' => @last_page,
          'maxScrollResultsReached' => @max_scroll_results_reached,
          'perPage' => @per_page,
          'total' => @total,
  }
end