Class: Inttegro::Order::PageRequest

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/order/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

#customer_id ⇒ String? (readonly)

When provided, restricts results to orders belonging to this customer. The customer must belong to the authenticated application.

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

Returns:

  • (String, nil) 


36
37
38
39
40
 
# File 'lib/inttegro/order/page_request.rb', line 36

class PageRequest < T::Struct
  const :page_number, T.nilable(Integer), default: nil
  const :page_size, Integer
  const :customer_id, T.nilable(String), default: nil
end

#page_number ⇒ Integer? (readonly)

Zero-based page index to fetch (0-10 inclusive)

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

Returns:

  • (Integer, nil) 


36
37
38
39
40
 
# File 'lib/inttegro/order/page_request.rb', line 36

class PageRequest < T::Struct
  const :page_number, T.nilable(Integer), default: nil
  const :page_size, Integer
  const :customer_id, T.nilable(String), default: nil
end

#page_size ⇒ Integer (readonly)

Number of orders per page (1-256)

Required in the API payload. Wire name: page_size.

Returns:

  • (Integer) 


36
37
38
39
40
 
# File 'lib/inttegro/order/page_request.rb', line 36

class PageRequest < T::Struct
  const :page_number, T.nilable(Integer), default: nil
  const :page_size, Integer
  const :customer_id, T.nilable(String), default: nil
end