Inttegro PHP SDK

SecretKey extends DomainValue
in package

Application

FinalYes

Metadata for an application secret key; the secret token itself is returned only when a key is generated.

This immutable value hydrates decoded API snake_case data into typed camelCase properties. Use fromArray() for wire data; toArray(), array access, and JSON serialization expose the API wire representation. Nullable properties correspond to optional API fields.

Properties

$active : bool: Whether this value is currently active.
$expiresAt : DateTimeImmutable|null: Omitted for keys without a fixed expiry.
$id : string: Application-scoped secret key identifier.
$issuedAt : DateTimeImmutable: Timestamp associated with issued.
$label : string|null: Optional human-readable label for the secret key.
$lastUsedAt : DateTimeImmutable|null: Most recent recorded authentication when available; otherwise omitted.
$revokedAt : DateTimeImmutable|null: Omitted until the key is revoked.
$status : string: Current lifecycle state.
$tokenType : string: Token Type value for this secret key.
$updatedAt : DateTimeImmutable|null: Omitted until the label is changed.
$usageCount : int|null: Number of recorded authentications when available; omitted when zero.

Methods

__construct() : mixed: Hydrates a SecretKey from decoded Inttegro API data.
fromArray() : static: Creates a SecretKey from its decoded API wire representation.
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.

$active read-only

Whether this value is currently active.


        public
            bool
    $active

Required response field. PHP type: bool; wire field: active (boolean).

$expiresAt read-only

Omitted for keys without a fixed expiry.


        public
            DateTimeImmutable|null
    $expiresAt

Optional response field. PHP type: DateTimeImmutable|null; wire field: expires_at (ISO-8601 string with UTC offset). The SDK parses the offset-bearing timestamp into an immutable PHP date-time value.

$id read-only

Application-scoped secret key identifier.


        public
            string
    $id

Required response field. PHP type: string; wire field: id (string).

$issuedAt read-only

Timestamp associated with issued.


        public
            DateTimeImmutable
    $issuedAt

Required response field. PHP type: DateTimeImmutable; wire field: issued_at (ISO-8601 string with UTC offset). The SDK parses the offset-bearing timestamp into an immutable PHP date-time value.

$label read-only

Optional human-readable label for the secret key.


        public
            string|null
    $label

Optional response field. PHP type: string|null; wire field: label (string).

$lastUsedAt read-only

Most recent recorded authentication when available; otherwise omitted.


        public
            DateTimeImmutable|null
    $lastUsedAt

Optional response field. PHP type: DateTimeImmutable|null; wire field: last_used_at (ISO-8601 string with UTC offset). The SDK parses the offset-bearing timestamp into an immutable PHP date-time value.

$revokedAt read-only

Omitted until the key is revoked.


        public
            DateTimeImmutable|null
    $revokedAt

Optional response field. PHP type: DateTimeImmutable|null; wire field: revoked_at (ISO-8601 string with UTC offset). The SDK parses the offset-bearing timestamp into an immutable PHP date-time value.

$status read-only

Current lifecycle state.


        public
            string
    $status

Required response field. PHP type: string; wire field: status (string). Compare against Status cases by using their ->value strings.

$tokenType read-only

Token Type value for this secret key.


        public
            string
    $tokenType

Required response field. PHP type: string; wire field: token_type (string). Compare against TokenType cases by using their ->value strings.

$updatedAt read-only

Omitted until the label is changed.


        public
            DateTimeImmutable|null
    $updatedAt

Optional response field. PHP type: DateTimeImmutable|null; wire field: updated_at (ISO-8601 string with UTC offset). The SDK parses the offset-bearing timestamp into an immutable PHP date-time value.

$usageCount read-only

Number of recorded authentications when available; omitted when zero.


        public
            int|null
    $usageCount

Optional response field. PHP type: int|null; wire field: usage_count (integer).

__construct()

Hydrates a SecretKey from decoded Inttegro API data.


    public
                    __construct(array<string, mixed> $data) : mixed

Parameters

$data : array<string, mixed>: Wire object keyed by snake_case API field names.

fromArray()

Creates a SecretKey from its decoded API wire representation.


    public
            static        fromArray(array<string, mixed> $data) : static

Parameters

$data : array<string, mixed>: Wire object keyed by snake_case API field names.

Return values

static —

A typed, immutable SecretKey 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 camelCase or wire snake_case field name.

Return values

bool

offsetGet()

Reads a typed property through PHP `ArrayAccess`.


    public
                    offsetGet(mixed $offset) : mixed

Parameters

$offset : mixed: PHP camelCase or wire snake_case field 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.

offsetUnset()

Rejects unsetting because domain values are immutable.


    public
                    offsetUnset(mixed $offset) : void

Parameters

$offset : mixed: Ignored field name.

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.

SecretKey extends DomainValue in package Application

Tags

Table of Contents

Properties

Methods

Properties

$active read-only

$expiresAt read-only

$id read-only

$issuedAt read-only

$label read-only

$lastUsedAt read-only

$revokedAt read-only

$status read-only

$tokenType read-only

$updatedAt read-only

$usageCount read-only

Methods

__construct()

Parameters

fromArray()

Parameters

Return values

jsonSerialize()

Return values

offsetExists()

Parameters

Return values

offsetGet()

Parameters

Return values

offsetSet()

Parameters

Tags

offsetUnset()

Parameters

Tags

toArray()

Return values

SecretKey extends DomainValue
in package

Application