PageRequest
extends DomainValue
in package
Pagination parameters for retrieving payout history.
The API uses one-based page numbers. Page size is optional and may be at most 256.
Table of Contents
Properties
- $pageNumber : int
- One-based page index, from 1 through 10.
- $pageSize : int|null
- Maximum number of payouts to return, from 1 through 256.
Methods
- __construct() : mixed
- fromArray() : static
- Creates a typed value from a decoded API object.
- jsonSerialize() : array<string, mixed>
- Returns the same API wire object as `toArray()` for `json_encode()`.
- offsetExists() : bool
- Reports whether a non-null property exists for a PHP or API field name.
- offsetGet() : mixed
- Reads a typed property through PHP `ArrayAccess`.
- offsetSet() : void
- Rejects mutation because domain values are immutable.
- offsetUnset() : void
- Rejects unsetting because domain values are immutable.
- toArray() : array<string, mixed>
- Converts typed properties back to the API's wire representation.
Properties
$pageNumber read-only
One-based page index, from 1 through 10.
public
int
$pageNumber
Required request field. PHP type: int; wire field: page_number (integer).
$pageSize read-only
Maximum number of payouts to return, from 1 through 256.
public
int|null
$pageSize
Optional request field. PHP type: int|null; wire field: page_size (integer).
Methods
__construct()
public
__construct(array{page_number: int, page_size?: int|null} $data) : mixed
Parameters
- $data : array{page_number: int, page_size?: int|null}
fromArray()
Creates a typed value from a decoded API object.
public
static fromArray(array{page_number: int, page_size?: int|null} $data) : static
Parameters
- $data : array{page_number: int, page_size?: int|null}
Return values
static —A typed, immutable domain value.
jsonSerialize()
Returns the same API wire object as `toArray()` for `json_encode()`.
public
jsonSerialize() : array<string, mixed>
Return values
array<string, mixed>offsetExists()
Reports whether a non-null property exists for a PHP or API field name.
public
offsetExists(mixed $offset) : bool
Both paymentId and payment_id address the same typed property.
Parameters
- $offset : mixed
-
PHP
camelCaseor wiresnake_casefield name.
Return values
booloffsetGet()
Reads a typed property through PHP `ArrayAccess`.
public
offsetGet(mixed $offset) : mixed
Parameters
- $offset : mixed
-
PHP
camelCaseor wiresnake_casefield name.
Return values
mixed —The PHP-native property value.
offsetSet()
Rejects mutation because domain values are immutable.
public
offsetSet(mixed $offset, mixed $value) : void
Parameters
- $offset : mixed
-
Ignored field name.
- $value : mixed
-
Ignored replacement value.
Tags
offsetUnset()
Rejects unsetting because domain values are immutable.
public
offsetUnset(mixed $offset) : void
Parameters
- $offset : mixed
-
Ignored field name.
Tags
toArray()
Converts typed properties back to the API's wire representation.
public
toArray() : array<string, mixed>
Property names become snake_case. Nested values, arrays, backed enums, and timestamps are
normalized recursively so the result is safe to pass to json_encode().
Return values
array<string, mixed> —The recursively normalized API object.