PipeConnectedAccount
in package
implements
JsonSerializable
uses
JsonSerializableTrait
Table of Contents
Interfaces
- JsonSerializable
Properties
- $accountDisplayName : string|null
- A mutable, non-unique display name for the provider account connection. Historical events may omit this field.
- $accountIdentifier : string|null
- A best-effort identifier for the provider account this connection points at. It is not the connection identifier or a selector. Historical events may omit this field.
- $apiKeyLast4 : string|null
- The last four characters of the API key, or null for other authentication methods. Historical events may omit this field.
- $authMethod : DataIntegrationAuthMethods|null
- How the connection authenticates. Historical events may omit this field.
- $connectionRole : ConnectedAccountConnectionRole|null
- Whether this is the compatibility connection visible to undeclared clients or a standard connection for plural-aware clients. Historical events may omit this field.
- $createdAt : DateTimeImmutable
- An ISO 8601 timestamp.
- $dataIntegrationId : string
- The unique ID of the data integration.
- $id : string
- The unique ID of the connected account.
- $object : string
- The connected account object.
- $organizationId : string|null
- The ID of the Organization the connected account belongs to.
- $providerSlug : string
- The provider slug for this connected account.
- $scopes : array<string|int, string>
- The OAuth scopes granted for this connected account.
- $state : PipeConnectedAccountState
- The state of the connected account.
- $updatedAt : DateTimeImmutable
- An ISO 8601 timestamp.
- $userId : string|null
- The ID of the User the connected account belongs to.
Methods
- __construct() : mixed
- fromArray() : self
- jsonSerialize() : array<string|int, mixed>
- toArray() : array<string|int, mixed>
Properties
$accountDisplayName
A mutable, non-unique display name for the provider account connection. Historical events may omit this field.
public
string|null
$accountDisplayName
= null
$accountIdentifier
A best-effort identifier for the provider account this connection points at. It is not the connection identifier or a selector. Historical events may omit this field.
public
string|null
$accountIdentifier
= null
$apiKeyLast4
The last four characters of the API key, or null for other authentication methods. Historical events may omit this field.
public
string|null
$apiKeyLast4
= null
$authMethod
How the connection authenticates. Historical events may omit this field.
public
DataIntegrationAuthMethods|null
$authMethod
= null
$connectionRole
Whether this is the compatibility connection visible to undeclared clients or a standard connection for plural-aware clients. Historical events may omit this field.
public
ConnectedAccountConnectionRole|null
$connectionRole
= null
$createdAt
An ISO 8601 timestamp.
public
DateTimeImmutable
$createdAt
$dataIntegrationId
The unique ID of the data integration.
public
string
$dataIntegrationId
$id
The unique ID of the connected account.
public
string
$id
$object
The connected account object.
public
string
$object
$organizationId
The ID of the Organization the connected account belongs to.
public
string|null
$organizationId
$providerSlug
The provider slug for this connected account.
public
string
$providerSlug
$scopes
The OAuth scopes granted for this connected account.
public
array<string|int, string>
$scopes
$state
The state of the connected account.
public
PipeConnectedAccountState
$state
$updatedAt
An ISO 8601 timestamp.
public
DateTimeImmutable
$updatedAt
$userId
The ID of the User the connected account belongs to.
public
string|null
$userId
Methods
__construct()
public
__construct(string $object, string $id, string $dataIntegrationId, string $providerSlug, string|null $userId, string|null $organizationId, array<string|int, mixed> $scopes, PipeConnectedAccountState $state, DateTimeImmutable $createdAt, DateTimeImmutable $updatedAt[, ConnectedAccountConnectionRole|null $connectionRole = null ][, string|null $accountIdentifier = null ][, string|null $accountDisplayName = null ][, DataIntegrationAuthMethods|null $authMethod = null ][, string|null $apiKeyLast4 = null ]) : mixed
Parameters
- $object : string
- $id : string
- $dataIntegrationId : string
- $providerSlug : string
- $userId : string|null
- $organizationId : string|null
- $scopes : array<string|int, mixed>
- $state : PipeConnectedAccountState
- $createdAt : DateTimeImmutable
- $updatedAt : DateTimeImmutable
- $connectionRole : ConnectedAccountConnectionRole|null = null
- $accountIdentifier : string|null = null
- $accountDisplayName : string|null = null
- $authMethod : DataIntegrationAuthMethods|null = null
- $apiKeyLast4 : string|null = null
fromArray()
public
static fromArray(array<string|int, mixed> $data) : self
Parameters
- $data : array<string|int, mixed>
Return values
selfjsonSerialize()
public
jsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed>toArray()
public
toArray() : array<string|int, mixed>