Class: Inttegro::Order::Page

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/order/page.rb

Overview

Typed representation of the page 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)

The page number returned

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

Returns:

  • (Integer, nil) 


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

class Page < T::Struct
  const :number, T.nilable(Integer), default: nil
  const :size, T.nilable(Integer), default: nil
  const :orders, T.nilable(T::Array[Inttegro::Order]), default: nil
end

#orders ⇒ Array<Inttegro::Order>? (readonly)

Value of the orders field in the Inttegro API payload.

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

Returns:



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

class Page < T::Struct
  const :number, T.nilable(Integer), default: nil
  const :size, T.nilable(Integer), default: nil
  const :orders, T.nilable(T::Array[Inttegro::Order]), default: nil
end

#size ⇒ Integer? (readonly)

The number of orders in this page

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

Returns:

  • (Integer, nil) 


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

class Page < T::Struct
  const :number, T.nilable(Integer), default: nil
  const :size, T.nilable(Integer), default: nil
  const :orders, T.nilable(T::Array[Inttegro::Order]), default: nil
end