Class: Telnyx::Models::Metadata

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/metadata.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:, total_pages:, page_size: nil, total_results: nil) ⇒ Object

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

Parameters:

  • page_number (Integer) —

    Current Page based on pagination settings (included when defaults are used.)

  • total_pages (Integer) —

    Total number of pages based on pagination settings

  • page_size (Integer) (defaults to: nil) —

    Number of results to return per page based on pagination settings (included when

  • total_results (Integer) (defaults to: nil) —

    Total number of results




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

Instance Attribute Details

#page_number ⇒ Integer

Current Page based on pagination settings (included when defaults are used.)

Returns:

  • (Integer) 


10
 
# File 'lib/telnyx/models/metadata.rb', line 10

required :page_number, Integer

#page_size ⇒ Integer?

Number of results to return per page based on pagination settings (included when defaults are used.)

Returns:

  • (Integer, nil) 


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

optional :page_size, Integer

#total_pages ⇒ Integer

Total number of pages based on pagination settings

Returns:

  • (Integer) 


16
 
# File 'lib/telnyx/models/metadata.rb', line 16

required :total_pages, Integer

#total_results ⇒ Integer?

Total number of results

Returns:

  • (Integer, nil) 


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

optional :total_results, Integer