UpdateDataIntegration
in package
implements
JsonSerializable
uses
JsonSerializableTrait
Read onlyYes
Table of Contents
Interfaces
- JsonSerializable
Properties
- $apiKey : ApiKeyInstallation|null
- An API key to install or rotate for a tenant on an `api_key` integration. Upserts the tenant installation identified by `user_id` (and optional `organization_id`).
- $credentials : DataIntegrationCredentialsInput|null
- New OAuth credentials for the Data Integration. When provided, rotates the stored client secret. Mutually exclusive with `api_key`.
- $customProvider : UpdateCustomProviderDefinition|null
- Updates to a custom provider's OAuth definition. Only valid for custom-provider integrations.
- $description : string|null
- An optional description of the Data Integration.
- $enabled : bool|null
- Whether the Data Integration is enabled.
- $scopes : array<string|int, string>|null
- The OAuth scopes to request for the Data Integration. Pass `null` to reset to the provider's configured scopes.
Methods
- __construct() : mixed
- fromArray() : self
- jsonSerialize() : array<string|int, mixed>
- toArray() : array<string|int, mixed>
Properties
$apiKey
An API key to install or rotate for a tenant on an `api_key` integration. Upserts the tenant installation identified by `user_id` (and optional `organization_id`).
public
ApiKeyInstallation|null
$apiKey
= null
$credentials
New OAuth credentials for the Data Integration. When provided, rotates the stored client secret. Mutually exclusive with `api_key`.
public
DataIntegrationCredentialsInput|null
$credentials
= null
$customProvider
Updates to a custom provider's OAuth definition. Only valid for custom-provider integrations.
public
UpdateCustomProviderDefinition|null
$customProvider
= null
$description
An optional description of the Data Integration.
public
string|null
$description
= null
$enabled
Whether the Data Integration is enabled.
public
bool|null
$enabled
= null
$scopes
The OAuth scopes to request for the Data Integration. Pass `null` to reset to the provider's configured scopes.
public
array<string|int, string>|null
$scopes
= null
Methods
__construct()
public
__construct([string|null $description = null ][, bool|null $enabled = null ][, array<string|int, mixed>|null $scopes = null ][, DataIntegrationCredentialsInput|null $credentials = null ][, ApiKeyInstallation|null $apiKey = null ][, UpdateCustomProviderDefinition|null $customProvider = null ]) : mixed
Parameters
- $description : string|null = null
- $enabled : bool|null = null
- $scopes : array<string|int, mixed>|null = null
- $credentials : DataIntegrationCredentialsInput|null = null
- $apiKey : ApiKeyInstallation|null = null
- $customProvider : UpdateCustomProviderDefinition|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>