Class: Telnyx::Models::BrandedCallingPaginationMeta

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/branded_calling_pagination_meta.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(page_number:, page_size:, total_pages:, total_results:) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::BrandedCallingPaginationMeta for more details.

JSON:API pagination metadata returned with every paginated list response. Page numbering is 1-based. ‘page_size` reports the number of items actually returned in `data` for this page; the requested size is taken from the `page` query parameter.

Parameters:

  • page_number (Integer) —

    1-based index of this page. Echoes the ‘page` query parameter (default `

  • page_size (Integer) —

    Number of items returned in this page’s ‘data` array. Capped at 250.

  • total_pages (Integer) —

    Total number of pages available given the current ‘page_size`.

  • total_results (Integer) —

    Total number of items across all pages (excludes soft-deleted rows).




# File 'lib/telnyx/models/branded_calling_pagination_meta.rb', line 31

Instance Attribute Details

#page_number ⇒ Integer

1-based index of this page. Echoes the ‘page` query parameter (default `1`).

Returns:

  • (Integer) 


11
 
# File 'lib/telnyx/models/branded_calling_pagination_meta.rb', line 11

required :page_number, Integer

#page_size ⇒ Integer

Number of items returned in this page’s ‘data` array. Capped at 250.

Returns:

  • (Integer) 


17
 
# File 'lib/telnyx/models/branded_calling_pagination_meta.rb', line 17

required :page_size, Integer

#total_pages ⇒ Integer

Total number of pages available given the current ‘page_size`.

Returns:

  • (Integer) 


23
 
# File 'lib/telnyx/models/branded_calling_pagination_meta.rb', line 23

required :total_pages, Integer

#total_results ⇒ Integer

Total number of items across all pages (excludes soft-deleted rows).

Returns:

  • (Integer) 


29
 
# File 'lib/telnyx/models/branded_calling_pagination_meta.rb', line 29

required :total_results, Integer