UpdateRequest
extends DomainValue
in package
Typed fields for updating a customer.
Table of Contents
Properties
- $billingAddress : AddressInput|null
- Replacement billing address. PHP type: `AddressInput|null`; wire field: `billing_address` (`object`).
- $customData : CustomDataInput|null
- Replacement merchant-defined values. PHP type: `CustomDataInput|null`; wire field: `custom_data` (`object`).
- $customerId : string
- Customer to update. PHP type: `string`; wire field: `customer_id` (`string`).
- $emailAddress : string|null
- Replacement email address. PHP type: `string|null`; wire field: `email_address` (`string`).
- $name : string|null
- Replacement customer name. PHP type: `string|null`; wire field: `name` (`string`).
- $phoneNumber : string|null
- Replacement phone number. PHP type: `string|null`; wire field: `phone_number` (`string`).
- $reference : string|null
- Replacement merchant reference. PHP type: `string|null`; wire field: `reference` (`string`).
- $shippingAddress : AddressInput|null
- Replacement shipping address. PHP type: `AddressInput|null`; wire field: `shipping_address` (`object`).
- $suffix : string|null
- Replacement name suffix. PHP type: `string|null`; wire field: `suffix` (`string`).
- $title : string|null
- Replacement title. PHP type: `string|null`; wire field: `title` (`string`).
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
$billingAddress read-only
Replacement billing address. PHP type: `AddressInput|null`; wire field: `billing_address` (`object`).
public
AddressInput|null
$billingAddress
$customData read-only
Replacement merchant-defined values. PHP type: `CustomDataInput|null`; wire field: `custom_data` (`object`).
public
CustomDataInput|null
$customData
$customerId read-only
Customer to update. PHP type: `string`; wire field: `customer_id` (`string`).
public
string
$customerId
$emailAddress read-only
Replacement email address. PHP type: `string|null`; wire field: `email_address` (`string`).
public
string|null
$emailAddress
$name read-only
Replacement customer name. PHP type: `string|null`; wire field: `name` (`string`).
public
string|null
$name
$phoneNumber read-only
Replacement phone number. PHP type: `string|null`; wire field: `phone_number` (`string`).
public
string|null
$phoneNumber
$reference read-only
Replacement merchant reference. PHP type: `string|null`; wire field: `reference` (`string`).
public
string|null
$reference
$shippingAddress read-only
Replacement shipping address. PHP type: `AddressInput|null`; wire field: `shipping_address` (`object`).
public
AddressInput|null
$shippingAddress
$suffix read-only
Replacement name suffix. PHP type: `string|null`; wire field: `suffix` (`string`).
public
string|null
$suffix
$title read-only
Replacement title. PHP type: `string|null`; wire field: `title` (`string`).
public
string|null
$title
Methods
__construct()
public
__construct(array<string, mixed> $data) : mixed
Parameters
- $data : array<string, mixed>
fromArray()
Creates a typed value from a decoded API object.
public
static fromArray(array<string, mixed> $data) : static
Parameters
- $data : array<string, mixed>
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>