Class: Inttegro::SecretKey::PageRequest

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/secret_key/page_request.rb

Overview

Typed representation of the page request object in the Inttegro API.

This generated model is immutable. Construct it with .new, or decode a string-keyed API payload with .from_hash. #serialize produces a string-keyed hash using the original wire field names and serialized enum values.

Instance Attribute Summary collapse

Instance Attribute Details

#number ⇒ Integer? (readonly)

Page number. Omitted or 0 is normalized to 1.

Optional in the API payload; omitted values default to nil. Wire name: number.

Returns:

  • (Integer, nil) 


35
36
37
38
39
 
# File 'lib/inttegro/secret_key/page_request.rb', line 35

class PageRequest < T::Struct
  const :page, T.nilable(Integer), default: nil
  const :number, T.nilable(Integer), default: nil
  const :size, T.nilable(Integer), default: nil
end

#page ⇒ Integer? (readonly)

Page number alias. Omitted or 0 is normalized to 1.

Optional in the API payload; omitted values default to nil. Wire name: page.

Returns:

  • (Integer, nil) 


35
36
37
38
39
 
# File 'lib/inttegro/secret_key/page_request.rb', line 35

class PageRequest < T::Struct
  const :page, T.nilable(Integer), default: nil
  const :number, T.nilable(Integer), default: nil
  const :size, T.nilable(Integer), default: nil
end

#size ⇒ Integer? (readonly)

Requested page size. Omitted or 0 becomes 50; values above 100 are capped at 100.

Optional in the API payload; omitted values default to nil. Wire name: size.

Returns:

  • (Integer, nil) 


35
36
37
38
39
 
# File 'lib/inttegro/secret_key/page_request.rb', line 35

class PageRequest < T::Struct
  const :page, T.nilable(Integer), default: nil
  const :number, T.nilable(Integer), default: nil
  const :size, T.nilable(Integer), default: nil
end