Class: Sentdm::Models::PaginationMeta

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Sentdm::Models::PaginationMeta

Defined in:

lib/sentdm/models/pagination_meta.rb

Defined Under Namespace

Classes: Cursors

Instance Attribute Summary

• #cursors ⇒ Sentdm::Models::PaginationMeta::Cursors^?

  Cursor-based pagination pointers.

• #has_more ⇒ Boolean^?

  Whether there are more pages after this one.

• #page ⇒ Integer^?

  Current page number (1-indexed).

• #page_size ⇒ Integer^?

  Number of items per page.

• #total_count ⇒ Integer^?

  Total number of items across all pages.

• #total_pages ⇒ Integer^?

  Total number of pages.

Instance Method Summary

• #initialize(cursors: nil, has_more: nil, page: nil, page_size: nil, total_count: nil, total_pages: nil) ⇒ Object constructor

  Pagination metadata for list responses.

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(cursors: nil, has_more: nil, page: nil, page_size: nil, total_count: nil, total_pages: nil) ⇒ Object

Pagination metadata for list responses

Parameters:

• cursors (Sentdm::Models::PaginationMeta::Cursors, nil) (defaults to: nil) —

  Cursor-based pagination pointers

• has_more (Boolean) (defaults to: nil) —

  Whether there are more pages after this one

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

  Current page number (1-indexed)

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

  Number of items per page

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

  Total number of items across all pages

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

  Total number of pages

# File 'lib/sentdm/models/pagination_meta.rb', line 42

Instance Attribute Details

#cursors ⇒ Sentdm::Models::PaginationMeta::Cursors^?

Cursor-based pagination pointers

Returns:

• (Sentdm::Models::PaginationMeta::Cursors, nil)

# File 'lib/sentdm/models/pagination_meta.rb', line 10

optional :cursors, -> { Sentdm::PaginationMeta::Cursors }, nil?: true

#has_more ⇒ Boolean^?

Whether there are more pages after this one

Returns:

• (Boolean, nil)

# File 'lib/sentdm/models/pagination_meta.rb', line 16

optional :has_more, Sentdm::Internal::Type::Boolean

#page ⇒ Integer^?

Current page number (1-indexed)

Returns:

• (Integer, nil)

# File 'lib/sentdm/models/pagination_meta.rb', line 22

optional :page, Integer

#page_size ⇒ Integer^?

Number of items per page

Returns:

• (Integer, nil)

# File 'lib/sentdm/models/pagination_meta.rb', line 28

optional :page_size, Integer

#total_count ⇒ Integer^?

Total number of items across all pages

Returns:

• (Integer, nil)

# File 'lib/sentdm/models/pagination_meta.rb', line 34

optional :total_count, Integer

#total_pages ⇒ Integer^?

Total number of pages

Returns:

• (Integer, nil)

# File 'lib/sentdm/models/pagination_meta.rb', line 40

optional :total_pages, Integer