React SDK API Models

API model types used by the Prequel Import React SDK public hooks. These types are re-exported from the Import API client so their shapes are available without duplicating them on the main React SDK reference page.

AbsSourceOptions

AbsSourceOptions = object

Properties

bucket_name

bucket_name: string

Container name

storage_account_name

storage_account_name: string

Storage account name

auth_method

auth_method: "azure_service_shared_access_signature"

Auth method

azure_service_shared_access_signature

azure_service_shared_access_signature: AzureServiceSharedAccessSignature

SAS Token

AwsAccessKeys

AwsAccessKeys = object

Properties

access_id

access_id: string

Bucket access ID

secret_key

secret_key: string

Bucket secret key

AwsiamRole

AwsiamRole = object

Properties

aws_iam_role_arn

aws_iam_role_arn: string

IAM role ARN

AzureServiceSharedAccessSignature

AzureServiceSharedAccessSignature = object

Properties

shared_access_signature_token

shared_access_signature_token: string

Storage Account SAS Token

BearerTokenAuth

BearerTokenAuth = object

Properties

bearer_token

bearer_token: string

Bearer Token

BigQuerySourceOptions

BigQuerySourceOptions = object & BigQuerySourceOptionsGcpServiceAccountRole | object & BigQuerySourceOptionsFederatedGcpServiceAccountRole | object & BigQuerySourceOptionsGcpServiceAccountKey

CredentialSource

CredentialSource = object

Properties

environment_id

environment_id: string

region_url

region_url: string

url

url: string

regional_cred_verification_url

regional_cred_verification_url: string

DeltaSharingSourceOptions

DeltaSharingSourceOptions = object & DeltaSharingSourceOptionsBearerToken | object & DeltaSharingSourceOptionsOAuth2

FederatedGcpServiceAccountRole

FederatedGcpServiceAccountRole = object

Properties

service_account_email

service_account_email: string

Service account email

workload_identity_federation_metadata?

optional workload_identity_federation_metadata?: GcpExternalAccountMetadata

Workload identity metadata

GcpServiceAccountRole

GcpServiceAccountRole = object

Properties

service_account_email

service_account_email: string

Service account email

GcpSourceServiceAccountKey

GcpSourceServiceAccountKey = object

Properties

service_account_email

service_account_email: string

Source service account email

service_account_key

service_account_key: unknown

JSON Token The credentials (JSON) that will be used to extract data from your BigQuery database. Create a service account just for this use.

GcsAccessKeys

GcsAccessKeys = object

Properties

access_key

access_key: string

Bucket access ID The access key to use for authentication.

secret

secret: string

Bucket secret key The secret to use for authentication.

GcsSourceOptions

GcsSourceOptions = object & GcsSourceOptionsGcpServiceAccountRole | object & GcsSourceOptionsFederatedGcpServiceAccountRole | object & GcsSourceOptionsGcshmacKeys | object & GcsSourceOptionsGcpServiceAccountKey

GcpExternalAccountMetadata

GcpExternalAccountMetadata = object

Properties

type

type: string

audience

audience: string

subject_token_type

subject_token_type: string

service_account_impersonation_url

service_account_impersonation_url: string

token_url

token_url: string

credential_source

credential_source: CredentialSource

OAuthAuth

OAuthAuth = object

Properties

client_id

client_id: string

Client ID

client_secret

client_secret: string

Client Secret

PasswordAuth

PasswordAuth = object

Properties

username

username: string

Username

password

password: string

Password

PostgresSourceOptions

PostgresSourceOptions = object

Properties

host

host: string

Host Host address of the database.

port

port: number

Port

database

database: string

Database Name of the database.

auth_method

auth_method: "password_auth"

Auth method Authentication method.

password_auth

password_auth: PasswordAuth

Username and Password Required details for username/password authentication.

use_ssh_tunnel?

optional use_ssh_tunnel?: boolean

Use SSH Tunnel Whether to use an SSH tunnel for the connection.

ssh_tunnel?

optional ssh_tunnel?: SshTunnelParams

Required details if using SSH tunneling.

disable_ssl?

optional disable_ssl?: boolean

Disable SSL

PublicKeyAuth

PublicKeyAuth = object

Properties

public_key

public_key: string

Public key This is the PKCS8 public key generated for keypair authentication.

RedshiftAccessKeys

RedshiftAccessKeys = object

Properties

password

password: string

Password

access_id

access_id: string

Bucket access ID

secret_key

secret_key: string

Bucket secret key

RedshiftServerlessSourceOptions

RedshiftServerlessSourceOptions = object & RedshiftServerlessSourceOptionsAwsAccessKeys | object & RedshiftServerlessSourceOptionsAwsiamRole

RedshiftSourceOptions

RedshiftSourceOptions = object & RedshiftSourceOptionsAwsAccessKeys | object & RedshiftSourceOptionsAwsiamRole

S3CompatibleSourceOptions

S3CompatibleSourceOptions = object

Properties

host

host: string

Host

port

port: number

Port

bucket_name

bucket_name: string

Bucket name

auth_method

auth_method: "access_keys"

Auth method

aws_access_keys

aws_access_keys: AwsAccessKeys

Access Keys Required details for access key authentication.

disable_ssl?

optional disable_ssl?: boolean

Disable SSL

use_ssh_tunnel?

optional use_ssh_tunnel?: boolean

Use SSH Tunnel Whether to use an SSH tunnel for the connection.

ssh_tunnel?

optional ssh_tunnel?: SshTunnelParams

Required details if using SSH tunneling.

S3SourceOptions

S3SourceOptions = object & S3SourceOptionsAwsiamRole | object & S3SourceOptionsAwsAccessKeys

SftpSourceOptions

SftpSourceOptions = object

Properties

username

username: string

Username

host

host: string

Host

port

port: number

Port

auth_method

auth_method: "public_key_auth"

Auth method

public_key_auth

public_key_auth: PublicKeyAuth

Key Pair Authentication

SshTunnelParams

SshTunnelParams = object

Properties

ssh_tunnel_host

ssh_tunnel_host: string

SSH tunnel host

ssh_tunnel_port

ssh_tunnel_port: number

SSH tunnel port

ssh_tunnel_username

ssh_tunnel_username: string

SSH tunnel username

ssh_public_key?

optional ssh_public_key?: "primary_public_key" | "secondary_public_key"

SSH Public Key This is the public SSH key that will be used to establish the SSH tunnel. It should be added to the list of authorized keys on the bastion host.

SnowflakeSourceOptions

SnowflakeSourceOptions = SnowflakeSourceOptionsPublicKeyAuth

SourceOptions

SourceOptions = { vendor: "postgres"; postgres: PostgresSourceOptions; } | { vendor: "redshift"; redshift: RedshiftSourceOptions; } | { vendor: "redshift_serverless"; redshift_serverless: RedshiftServerlessSourceOptions; } | { vendor: "bigquery"; bigquery: BigQuerySourceOptions; } | { vendor: "s3"; s3: S3SourceOptions; } | { vendor: "abs"; abs: AbsSourceOptions; } | { vendor: "sftp"; sftp: SftpSourceOptions; } | { vendor: "gcs"; gcs: GcsSourceOptions; } | { vendor: "s3_compatible"; s3_compatible: S3CompatibleSourceOptions; } | { vendor: "snowflake"; snowflake: SnowflakeSourceOptions; } | { vendor: "delta_sharing"; delta_sharing: DeltaSharingSourceOptions; } & object

Type Declaration

provider_id

provider_id: string

Provider ID ID of the import provider this source belongs to.

name

name: string

Name Unique name for this import source.

AbsDatalakeResource

AbsDatalakeResource = object

Properties

prefix

prefix: string

container_name

container_name: string

storage_account_name

storage_account_name: string

auth_method

auth_method: string

azure_storage_account_access_key?

optional azure_storage_account_access_key?: AzureStorageAccountAccessKeyResource

AwsAccessKeysResource

AwsAccessKeysResource = object

Properties

access_key_id

access_key_id: string

AwsiamRoleResource

AwsiamRoleResource = object

Properties

aws_iam_role

aws_iam_role: string

AzureStorageAccountAccessKeyResource

AzureStorageAccountAccessKeyResource = object

Index Signature

[key: string]: never

DatalakeResource

DatalakeResource = { storage: "s3"; s3: S3DatalakeResource; } | { storage: "s3_compatible"; s3_compatible: S3CompatibleDatalakeResource; } | { storage: "gcs"; gcs: GcsDatalakeResource; } | { storage: "abs"; abs: AbsDatalakeResource; } & object

Type Declaration

id

id: string

name

name: string

retention_window_days?

optional retention_window_days?: number

created_at

created_at: string

updated_at

updated_at: string

FederatedGcpDatalakeServiceAccountRoleResource

FederatedGcpDatalakeServiceAccountRoleResource = object

Properties

gcp_service_account_email

gcp_service_account_email: string

GcpDatalakeServiceAccountKeyResource

GcpDatalakeServiceAccountKeyResource = object

Properties

service_account_email

service_account_email: string

GcpDatalakeServiceAccountRoleResource

GcpDatalakeServiceAccountRoleResource = object

Properties

gcp_service_account_email

gcp_service_account_email: string

GcsDatalakeResource

GcsDatalakeResource = object & GcsDatalakeResourceGcpServiceAccountRole | object & GcsDatalakeResourceGcpServiceAccountKey | object & GcsDatalakeResourceFederatedGcpServiceAccountRole

ListDatalakesResponse

ListDatalakesResponse = object

Properties

datalakes

datalakes: DatalakeResource[]

S3CompatibleDatalakeResource

S3CompatibleDatalakeResource = object

Properties

prefix

prefix: string

bucket_name

bucket_name: string

bucket_region

bucket_region: string

bucket_host

bucket_host: string

bucket_port

bucket_port: number

aws_access_keys

aws_access_keys: AwsAccessKeysResource

S3DatalakeResource

S3DatalakeResource = object & S3DatalakeResourceAwsiamRole | object & S3DatalakeResourceAwsAccessKeys

AbsDatalakeOptions

AbsDatalakeOptions = object

Properties

prefix

prefix: string

Prefix to use for the ABS bucket.

container_name

container_name: string

Container Name

storage_account_name

storage_account_name: string

Storage Account Name

auth_method

auth_method: "azure_storage_account_access_key"

Auth Method

azure_storage_account_access_key?

optional azure_storage_account_access_key?: AzureStorageAccountAccessKey

Required parameters to authenticate to Azure using an access key.

AzureStorageAccountAccessKey

AzureStorageAccountAccessKey = object

Properties

storage_account_access_key

storage_account_access_key: string

Access key

CreateDatalakeRequest

CreateDatalakeRequest = object

Properties

datalake

datalake: DatalakeOptions

DatalakeOptions

DatalakeOptions = { storage: "s3"; s3: S3DatalakeOptions; } | { storage: "s3_compatible"; s3_compatible: S3CompatibleDatalakeOptions; } | { storage: "gcs"; gcs: GcsDatalakeOptions; } | { storage: "abs"; abs: AbsDatalakeOptions; } & object

Type Declaration

name

name: string

Name Unique name for this import datalake.

retention_window_days?

optional retention_window_days?: number

Retention Window (Days) Number of days to retain data. Null means infinite retention.

FederatedGcpDatalakeServiceAccountRole

FederatedGcpDatalakeServiceAccountRole = object

Properties

service_account_email

service_account_email: string

Datalake service account email

workload_identity_federation_metadata?

optional workload_identity_federation_metadata?: GcpExternalAccountMetadata

Workload identity metadata

GcpDatalakeServiceAccountKey

GcpDatalakeServiceAccountKey = object

Properties

service_account_email

service_account_email: string

Datalake service account email

service_account_key

service_account_key: unknown

JSON Token The credentials (JSON) that will be used to access the datalake. Create a service account just for this use.

GcpDatalakeServiceAccountRole

GcpDatalakeServiceAccountRole = object

Properties

gcp_service_account_email

gcp_service_account_email: string

GCP Service Account Email Email of the GCP service account.

GcsDatalakeOptions

GcsDatalakeOptions = object & GcsDatalakeOptionsGcpServiceAccountRole | object & GcsDatalakeOptionsGcpServiceAccountKey | object & GcsDatalakeOptionsFederatedGcpServiceAccountRole

S3CompatibleDatalakeOptions

S3CompatibleDatalakeOptions = object

Properties

prefix

prefix: string

Prefix to use for the S3 bucket.

bucket_name

bucket_name: string

Bucket Name

bucket_region

bucket_region: string

Region

bucket_host

bucket_host: string

Host

bucket_port

bucket_port: number

Port

aws_access_keys

aws_access_keys: AwsAccessKeys

Access credentials for S3-compatible storage.

S3DatalakeOptions

S3DatalakeOptions = object & S3DatalakeOptionsAwsiamRole | object & S3DatalakeOptionsAwsAccessKeys

GetDatalakeResponse

GetDatalakeResponse = object

Properties

datalake

datalake: DatalakeResource

DatalakeUpdateOptions

DatalakeUpdateOptions = object

Properties

name?

optional name?: string

Unique name for this import datalake.

retention_window_days?

optional retention_window_days?: number

Number of days to retain data. Null means infinite retention.

s3?

optional s3?: UpdateS3DatalakeOptions

s3_compatible?

optional s3_compatible?: UpdateS3CompatibleDatalakeOptions

gcs?

optional gcs?: UpdateGcsDatalakeOptions

abs?

optional abs?: UpdateAbsDatalakeOptions

UpdateAbsDatalakeOptions

UpdateAbsDatalakeOptions = object

Properties

prefix?

optional prefix?: string

Prefix to use for the ABS bucket.

container_name?

optional container_name?: string

storage_account_name?

optional storage_account_name?: string

auth_method?

optional auth_method?: "azure_storage_account_access_key"

azure_storage_account_access_key?

optional azure_storage_account_access_key?: UpdateAzureStorageAccountAccessKey

UpdateAwsAccessKeys

UpdateAwsAccessKeys = object

Properties

access_id?

optional access_id?: string

The access key ID to use for authentication.

secret_key?

optional secret_key?: string

The secret key to use for authentication.

UpdateAzureStorageAccountAccessKey

UpdateAzureStorageAccountAccessKey = object

Properties

storage_account_access_key?

optional storage_account_access_key?: string

Access key

UpdateDatalakeRequest

UpdateDatalakeRequest = object

Properties

datalake

datalake: DatalakeUpdateOptions

UpdateGcpDatalakeServiceAccountKey

UpdateGcpDatalakeServiceAccountKey = object

Properties

service_account_email?

optional service_account_email?: string

The email of the GCP service account to use for authentication.

service_account_key?

optional service_account_key?: unknown

The full Google-generated JSON service account key object.

UpdateGcpDatalakeServiceAccountRole

UpdateGcpDatalakeServiceAccountRole = object

Properties

gcp_service_account_email?

optional gcp_service_account_email?: string

Email of the GCP service account.

UpdateGcsDatalakeOptions

UpdateGcsDatalakeOptions = object

Properties

prefix?

optional prefix?: string

Prefix to use for the GCS bucket.

auth_method?

optional auth_method?: "gcp_service_account_role" | "gcp_service_account_key" | "federated_gcp_service_account_role"

gcp_service_account_role?

optional gcp_service_account_role?: UpdateGcpDatalakeServiceAccountRole

gcp_service_account_key?

optional gcp_service_account_key?: UpdateGcpDatalakeServiceAccountKey

federated_gcp_service_account_role?

optional federated_gcp_service_account_role?: UpdateGcpDatalakeServiceAccountRole

UpdateS3CompatibleDatalakeOptions

UpdateS3CompatibleDatalakeOptions = object

Properties

prefix?

optional prefix?: string

Prefix to use for the S3 bucket.

bucket_host?

optional bucket_host?: string

Host for S3-compatible storage.

bucket_port?

optional bucket_port?: number

Port for S3-compatible storage.

aws_access_keys?

optional aws_access_keys?: UpdateAwsAccessKeys

UpdateS3DatalakeOptions

UpdateS3DatalakeOptions = object

Properties

prefix?

optional prefix?: string

Prefix to use for the S3 bucket.

auth_method?

optional auth_method?: "aws_iam_role" | "aws_access_keys"

aws_iam_role?

optional aws_iam_role?: AwsiamRole

aws_access_keys?

optional aws_access_keys?: UpdateAwsAccessKeys

DatalakeQueryRequest

DatalakeQueryRequest = object

Properties

dataset_ids

dataset_ids: string[]

query

query: string

DatalakeQueryResponse

DatalakeQueryResponse = object

Properties

schema

schema: QueryResultSchemaField[]

records

records: unknown[]

QueryResultSchemaField

QueryResultSchemaField = object

Properties

name

name: string

database_type_name?

optional database_type_name?: string

length?

optional length?: number

precision?

optional precision?: number

scale?

optional scale?: number

nullable?

optional nullable?: boolean

ListProvidersResponse

ListProvidersResponse = object

Properties

providers

providers: ProviderResource[]

ProviderResource

ProviderResource = object

Properties

name

name: string

id

id: string

is_enabled

is_enabled: boolean

datalake_id

datalake_id: string

products

products: string[]

machine_type_id?

optional machine_type_id?: string

created_at

created_at: string

updated_at

updated_at: string

ProviderOptions

ProviderOptions = object

Properties

name

name: string

Name Unique name for this provider.

id

id: string

ID Unique identifier for this provider.

datalake_id

datalake_id: string

Datalake ID The ID of the datalake this provider belongs to.

is_enabled?

optional is_enabled?: boolean

Enabled Whether this provider is enabled.

products

products: string[]

Products The names of the products to be assigned to this provider.

machine_type_id?

optional machine_type_id?: string

Machine Type ID Optional machine type for resource allocation.

GetProviderResponse

GetProviderResponse = object

Properties

provider

provider: ProviderResource

UpdateProviderOptions

UpdateProviderOptions = object

Properties

name?

optional name?: string

Name for this provider.

is_enabled?

optional is_enabled?: boolean

Whether this provider is enabled.

products?

optional products?: string[]

The names of the products to be assigned to this provider.

machine_type_id?

optional machine_type_id?: string

Machine type for resource allocation.

AbsSourceResource

AbsSourceResource = object

Properties

is_valid

is_valid: boolean

bucket_name

bucket_name: string

storage_account_name

storage_account_name: string

auth_method

auth_method: string

BigQuerySourceResource

BigQuerySourceResource = object & BigQuerySourceResourceGcpServiceAccountRole | object & BigQuerySourceResourceFederatedGcpServiceAccountRole | object & BigQuerySourceResourceGcpServiceAccountKey

DeltaSharingSourceResource

DeltaSharingSourceResource = object

Properties

is_valid

is_valid: boolean

host

host: string

port

port: number

auth_method

auth_method: string

oauth_client_id?

optional oauth_client_id?: string

FederatedGcpServiceAccountRoleResource

FederatedGcpServiceAccountRoleResource = object

Properties

service_account_email

service_account_email: string

GcpServiceAccountKeyResource

GcpServiceAccountKeyResource = object

Properties

service_account_email

service_account_email: string

GcpServiceAccountRoleResource

GcpServiceAccountRoleResource = object

Properties

service_account_email

service_account_email: string

GcsAccessKeysResource

GcsAccessKeysResource = object

Properties

access_id

access_id: string

GcsSourceResource

GcsSourceResource = object

Properties

is_valid

is_valid: boolean

bucket_name

bucket_name: string

region

region: string

auth_method

auth_method: string

gcp_service_account_role?

optional gcp_service_account_role?: GcpServiceAccountRoleResource

federated_gcp_service_account_role?

optional federated_gcp_service_account_role?: FederatedGcpServiceAccountRoleResource

gcs_hmac_keys?

optional gcs_hmac_keys?: GcsAccessKeysResource

gcp_service_account_key?

optional gcp_service_account_key?: GcpServiceAccountKeyResource

ListSourcesResponse

ListSourcesResponse = object

Properties

sources

sources: SourceResource[]

PostgresSourceResource

PostgresSourceResource = object

Properties

is_valid

is_valid: boolean

host

host: string

port

port: number

database

database: string

username

username: string

auth_method

auth_method: string

use_ssh_tunnel

use_ssh_tunnel: boolean

ssh_tunnel?

optional ssh_tunnel?: SshTunnelResource

disable_ssl

disable_ssl: boolean

connection_timeout_in_seconds

connection_timeout_in_seconds: number

PublicKeyAuthResource

PublicKeyAuthResource = object

Properties

public_key

public_key: string

RedshiftAccessKeysResource

RedshiftAccessKeysResource = object

Properties

access_id

access_id: string

RedshiftServerlessSourceResource

RedshiftServerlessSourceResource = object

Properties

is_valid

is_valid: boolean

host

host: string

port

port: number

database

database: string

region?

optional region?: string

workgroup

workgroup: string

auth_method

auth_method: string

aws_iam_role?

optional aws_iam_role?: AwsiamRoleResource

aws_access_keys?

optional aws_access_keys?: RedshiftAccessKeysResource

use_ssh_tunnel

use_ssh_tunnel: boolean

ssh_tunnel?

optional ssh_tunnel?: SshTunnelResource

disable_ssl

disable_ssl: boolean

connection_timeout_in_seconds

connection_timeout_in_seconds: number

RedshiftSourceResource

RedshiftSourceResource = object

Properties

is_valid

is_valid: boolean

host

host: string

port

port: number

database

database: string

cluster?

optional cluster?: string

region?

optional region?: string

workgroup?

optional workgroup?: string

username?

optional username?: string

auth_method

auth_method: string

aws_iam_role?

optional aws_iam_role?: AwsiamRoleResource

aws_access_keys?

optional aws_access_keys?: RedshiftAccessKeysResource

use_ssh_tunnel

use_ssh_tunnel: boolean

ssh_tunnel?

optional ssh_tunnel?: SshTunnelResource

disable_ssl

disable_ssl: boolean

connection_timeout_in_seconds

connection_timeout_in_seconds: number

S3CompatibleSourceResource

S3CompatibleSourceResource = object

Properties

is_valid

is_valid: boolean

host

host: string

port

port: number

bucket_name

bucket_name: string

auth_method

auth_method: string

aws_access_keys?

optional aws_access_keys?: AwsAccessKeysResource

disable_ssl

disable_ssl: boolean

use_ssh_tunnel

use_ssh_tunnel: boolean

ssh_tunnel?

optional ssh_tunnel?: SshTunnelResource

S3SourceResource

S3SourceResource = object

Properties

is_valid

is_valid: boolean

bucket_name

bucket_name: string

region

region: string

auth_method

auth_method: string

aws_iam_role?

optional aws_iam_role?: AwsiamRoleResource

aws_access_keys?

optional aws_access_keys?: AwsAccessKeysResource

bucket_host?

optional bucket_host?: string

use_ssh_tunnel

use_ssh_tunnel: boolean

ssh_tunnel?

optional ssh_tunnel?: SshTunnelResource

SftpSourceResource

SftpSourceResource = object

Properties

is_valid

is_valid: boolean

username

username: string

host

host: string

port

port: number

auth_method

auth_method: string

SshTunnelResource

SshTunnelResource = object

Properties

ssh_tunnel_host?

optional ssh_tunnel_host?: string

ssh_tunnel_port?

optional ssh_tunnel_port?: number

ssh_tunnel_username?

optional ssh_tunnel_username?: string

ssh_public_key?

optional ssh_public_key?: string

SnowflakeSourceResource

SnowflakeSourceResource = object

Properties

is_valid

is_valid: boolean

host

host: string

port

port: number

database

database: string

username

username: string

auth_method

auth_method: "public_key_auth"

public_key_auth?

optional public_key_auth?: PublicKeyAuthResource

SourceResource

SourceResource = { vendor: "postgres"; postgres: PostgresSourceResource; } | { vendor: "redshift"; redshift: RedshiftSourceResource; } | { vendor: "redshift_serverless"; redshift_serverless: RedshiftServerlessSourceResource; } | { vendor: "bigquery"; bigquery: BigQuerySourceResource; } | { vendor: "s3"; s3: S3SourceResource; } | { vendor: "abs"; abs: AbsSourceResource; } | { vendor: "sftp"; sftp: SftpSourceResource; } | { vendor: "gcs"; gcs: GcsSourceResource; } | { vendor: "s3_compatible"; s3_compatible: S3CompatibleSourceResource; } | { vendor: "snowflake"; snowflake: SnowflakeSourceResource; } | { vendor: "delta_sharing"; delta_sharing: DeltaSharingSourceResource; } & object

Type Declaration

id

id: string

provider_id

provider_id: string

name

name: string

created_at

created_at: string

updated_at

updated_at: string

CreateSourceRequest

CreateSourceRequest = object

Properties

source

source: SourceOptions

GetSourceResponse

GetSourceResponse = object

Properties

source

source: SourceResource

UpdateAbsSourceOptions

UpdateAbsSourceOptions = object

Properties

bucket_name?

optional bucket_name?: string

The name of the ABS container.

storage_account_name?

optional storage_account_name?: string

The name of the Azure storage account.

auth_method?

optional auth_method?: "azure_service_shared_access_signature"

Authentication method.

azure_service_shared_access_signature?

optional azure_service_shared_access_signature?: UpdateAzureServiceSharedAccessSignature

Required parameters to authenticate to Azure using a SAS token.

UpdateAzureServiceSharedAccessSignature

UpdateAzureServiceSharedAccessSignature = object

Properties

shared_access_signature_token?

optional shared_access_signature_token?: string

Storage Account SAS Token

UpdateBigQuerySourceOptions

UpdateBigQuerySourceOptions = object

Properties

project_id?

optional project_id?: string

Project ID

region?

optional region?: string

Region

auth_method?

optional auth_method?: "gcp_service_account_role" | "gcp_service_account_key" | "federated_gcp_service_account_role"

Auth method The method of authentication to use for this source.

gcp_service_account_role?

optional gcp_service_account_role?: UpdateGcpServiceAccountRole

Required details if authenticating using a GCP service account role.

federated_gcp_service_account_role?

optional federated_gcp_service_account_role?: UpdateFederatedGcpServiceAccountRole

Required details if authenticating using a GCP service account role.

gcp_service_account_key?

optional gcp_service_account_key?: UpdateGcpSourceServiceAccountKey

Required details if authenticating using a GCP service account key.

UpdateDeltaSharingSourceOptions

UpdateDeltaSharingSourceOptions = object

Properties

host?

optional host?: string

The hostname of the Delta Sharing server.

port?

optional port?: number

The port of the Delta Sharing server.

auth_method?

optional auth_method?: "bearer_token" | "oauth2"

bearer_token?

optional bearer_token?: BearerTokenAuth

Required details for bearer token authentication.

oauth2?

optional oauth2?: OAuthAuth

Required details for OAuth2 authentication.

UpdateFederatedGcpServiceAccountRole

UpdateFederatedGcpServiceAccountRole = object

Properties

service_account_email

service_account_email: string

Service account email

workload_identity_federation_metadata?

optional workload_identity_federation_metadata?: GcpExternalAccountMetadata

Workload identity metadata

UpdateGcpServiceAccountRole

UpdateGcpServiceAccountRole = object

Properties

service_account_email?

optional service_account_email?: string

The email of the GCP service account to use for authentication.

workload_identity_federation_metadata?

optional workload_identity_federation_metadata?: GcpExternalAccountMetadata

Workload identity metadata The federation metadata to use for authentication.

UpdateGcpSourceServiceAccountKey

UpdateGcpSourceServiceAccountKey = object

Properties

service_account_email?

optional service_account_email?: string

The email of the GCP service account to use for authentication.

service_account_key?

optional service_account_key?: unknown

The full Google-generated JSON service account key object.

UpdateGcsAccessKeys

UpdateGcsAccessKeys = object

Properties

access_key?

optional access_key?: string

The access key to use for authentication.

secret?

optional secret?: string

The secret to use for authentication.

UpdateGcsSourceOptions

UpdateGcsSourceOptions = object

Properties

bucket_name?

optional bucket_name?: string

The name of the GCS bucket.

region?

optional region?: string

The GCP region of the GCS bucket.

auth_method?

optional auth_method?: "gcp_service_account_role" | "federated_gcp_service_account_role" | "gcs_hmac_keys" | "gcp_service_account_key"

Authentication method.

gcp_service_account_role?

optional gcp_service_account_role?: UpdateGcpServiceAccountRole

Required details if authenticating using a GCP service account role.

federated_gcp_service_account_role?

optional federated_gcp_service_account_role?: UpdateFederatedGcpServiceAccountRole

Required details if authenticating using a GCP service account role.

gcs_hmac_keys?

optional gcs_hmac_keys?: UpdateGcsAccessKeys

Required details if authenticating using GCS HMAC keys.

gcp_service_account_key?

optional gcp_service_account_key?: UpdateGcpSourceServiceAccountKey

Required details if authenticating using a GCP service account key.

UpdatePasswordAuth

UpdatePasswordAuth = object

Properties

username?

optional username?: string

The username to use for authentication.

password?

optional password?: string

The password to use for authentication.

UpdatePostgresSourceOptions

UpdatePostgresSourceOptions = object

Properties

host?

optional host?: string

The hostname of the PostgreSQL server.

port?

optional port?: number

The port of the PostgreSQL server.

database?

optional database?: string

The name of the database to connect to.

auth_method?

optional auth_method?: "password_auth"

Authentication method.

password_auth?

optional password_auth?: UpdatePasswordAuth

Required details for username/password authentication.

use_ssh_tunnel?

optional use_ssh_tunnel?: boolean

Use SSH Tunnel Whether to use an SSH tunnel for the connection.

ssh_tunnel?

optional ssh_tunnel?: SshTunnelParams

Required details if using SSH tunneling.

disable_ssl?

optional disable_ssl?: boolean

Whether to disable SSL for the connection.

UpdatePublicKeyAuth

UpdatePublicKeyAuth = object

Properties

public_key?

optional public_key?: string

Public key This is the PKCS8 public key generated for keypair authentication.

UpdateRedshiftAccessKeys

UpdateRedshiftAccessKeys = object

Properties

password

password: string

Password

access_id

access_id: string

Bucket access ID

secret_key

secret_key: string

Bucket secret key

UpdateRedshiftServerlessSourceOptions

UpdateRedshiftServerlessSourceOptions = object

Properties

host?

optional host?: string

The hostname of the Redshift Serverless server.

port?

optional port?: number

The port of the Redshift Serverless server.

database?

optional database?: string

The name of the database to connect to.

workgroup?

optional workgroup?: string

The name of the Redshift Serverless workgroup.

region?

optional region?: string

The AWS region of the Redshift Serverless workgroup.

auth_method?

optional auth_method?: "aws_iam_role" | "aws_access_keys"

aws_access_keys?

optional aws_access_keys?: UpdateRedshiftAccessKeys

Required details for AWS access keys authentication.

aws_iam_role?

optional aws_iam_role?: AwsiamRole

Required details for AWS IAM role authentication.

use_ssh_tunnel?

optional use_ssh_tunnel?: boolean

Use SSH Tunnel Whether to use an SSH tunnel for the connection.

ssh_tunnel?

optional ssh_tunnel?: SshTunnelParams

Required details if using SSH tunneling.

disable_ssl?

optional disable_ssl?: boolean

Whether to disable SSL for the connection.

connection_timeout_in_seconds?

optional connection_timeout_in_seconds?: number

Duration to wait for successful connection.

UpdateRedshiftSourceOptions

UpdateRedshiftSourceOptions = object

Properties

host?

optional host?: string

The hostname of the Redshift server.

port?

optional port?: number

The port of the Redshift server.

database?

optional database?: string

The name of the database to connect to.

cluster?

optional cluster?: string

The name of the Redshift cluster.

region?

optional region?: string

The AWS region of the Redshift cluster.

workgroup?

optional workgroup?: string

The name of the Redshift Serverless workgroup.

username?

optional username?: string

The username for authentication.

auth_method?

optional auth_method?: "aws_iam_role" | "aws_access_keys"

aws_access_keys?

optional aws_access_keys?: UpdateRedshiftAccessKeys

Required details for AWS access keys authentication.

aws_iam_role?

optional aws_iam_role?: AwsiamRole

Required details for AWS IAM role authentication.

use_ssh_tunnel?

optional use_ssh_tunnel?: boolean

Use SSH Tunnel Whether to use an SSH tunnel for the connection.

ssh_tunnel?

optional ssh_tunnel?: SshTunnelParams

Required details if using SSH tunneling.

disable_ssl?

optional disable_ssl?: boolean

Whether to disable SSL for the connection.

connection_timeout_in_seconds?

optional connection_timeout_in_seconds?: number

Duration to wait for successful connection.

UpdateS3CompatibleSourceOptions

UpdateS3CompatibleSourceOptions = object

Properties

host?

optional host?: string

The hostname of the S3-compatible server.

port?

optional port?: number

The port of the S3-compatible server.

bucket_name?

optional bucket_name?: string

The name of the S3-compatible bucket.

auth_method?

optional auth_method?: "access_keys"

Authentication method.

aws_access_keys?

optional aws_access_keys?: UpdateAwsAccessKeys

Required details for access key authentication.

disable_ssl?

optional disable_ssl?: boolean

Whether to disable SSL for the connection.

use_ssh_tunnel?

optional use_ssh_tunnel?: boolean

Use SSH Tunnel Whether to use an SSH tunnel for the connection.

ssh_tunnel?

optional ssh_tunnel?: SshTunnelParams

Required details if using SSH tunneling.

UpdateS3SourceOptions

UpdateS3SourceOptions = object

Properties

bucket_name?

optional bucket_name?: string

The name of the S3 bucket.

region?

optional region?: string

The AWS region of the S3 bucket.

auth_method?

optional auth_method?: "aws_iam_role" | "aws_access_keys"

aws_iam_role?

optional aws_iam_role?: AwsiamRole

Required details for AWS IAM role authentication.

aws_access_keys?

optional aws_access_keys?: UpdateAwsAccessKeys

Required details for AWS access keys authentication.

bucket_host?

optional bucket_host?: string

The host address of the S3 bucket.

use_ssh_tunnel?

optional use_ssh_tunnel?: boolean

Use SSH Tunnel Whether to use an SSH tunnel for the connection.

ssh_tunnel?

optional ssh_tunnel?: SshTunnelParams

Required details if using SSH tunneling.

UpdateSftpSourceOptions

UpdateSftpSourceOptions = object

Properties

username?

optional username?: string

The username for the SFTP connection.

host?

optional host?: string

The hostname of the SFTP server.

port?

optional port?: number

The port of the SFTP server.

auth_method?

optional auth_method?: "public_key_auth"

Authentication method.

public_key_auth?

optional public_key_auth?: UpdatePublicKeyAuth

Required details for public key authentication.

UpdateSnowflakeSourceOptions

UpdateSnowflakeSourceOptions = object

Properties

host?

optional host?: string

The hostname of the Snowflake account.

port?

optional port?: number

The port of the Snowflake server.

database?

optional database?: string

The name of the database to connect to.

username?

optional username?: string

The username for authentication.

auth_method?

optional auth_method?: "public_key_auth"

public_key_auth?

optional public_key_auth?: UpdatePublicKeyAuth

Required details for public key authentication.

UpdateSourceOptions

UpdateSourceOptions = object

Properties

name?

optional name?: string

Unique name for this import source.

vendor?

readonly optional vendor?: string

postgres?

optional postgres?: UpdatePostgresSourceOptions

PostgreSQL

redshift?

optional redshift?: UpdateRedshiftSourceOptions

Amazon Redshift

redshift_serverless?

optional redshift_serverless?: UpdateRedshiftServerlessSourceOptions

Amazon Redshift Serverless

bigquery?

optional bigquery?: UpdateBigQuerySourceOptions

Google BigQuery

s3?

optional s3?: UpdateS3SourceOptions

Amazon S3

abs?

optional abs?: UpdateAbsSourceOptions

Azure Blob Storage

sftp?

optional sftp?: UpdateSftpSourceOptions

SFTP

gcs?

optional gcs?: UpdateGcsSourceOptions

Google Cloud Storage

s3_compatible?

optional s3_compatible?: UpdateS3CompatibleSourceOptions

S3 Compatible

snowflake?

optional snowflake?: UpdateSnowflakeSourceOptions

Snowflake

delta_sharing?

optional delta_sharing?: UpdateDeltaSharingSourceOptions

Delta Sharing

UpdateSourceRequest

UpdateSourceRequest = object

Properties

source

source: UpdateSourceOptions

ListSourceTablesResponse

ListSourceTablesResponse = object

Properties

tables

tables: SourceTable[]

SourcePreviewSchemaField

SourcePreviewSchemaField = object

Properties

name

name: string

raw_type

raw_type: string

prequel_type

prequel_type: string

ordinal_position

ordinal_position: number

is_nullable?

optional is_nullable?: boolean

SourceTable

SourceTable = object

Properties

namespace

namespace: string

name

name: string

columns

columns: SourcePreviewSchemaField[]

GlobOptions

GlobOptions = object

Properties

pattern

pattern: string

Pattern Glob pattern for object files.

format

format: "csv" | "parquet" | "jsonl" | "json"

Format Format of the object files.

SQLOptions

SQLOptions = object

Properties

query

query: string

Query SQL query to execute.

SourcePreviewOptions

SourcePreviewOptions = { method: "table"; table: TableOptions; } | { method: "sql"; sql: SQLOptions; } | { method: "glob"; glob: GlobOptions; }

Union Members

Type Literal

{ method: "table"; table: TableOptions; }

method

method: "table"

table

table: TableOptions

Table Configuration

Type Literal

{ method: "sql"; sql: SQLOptions; }

method

method: "sql"

sql

sql: SQLOptions

SQL Configuration

Type Literal

{ method: "glob"; glob: GlobOptions; }

method

method: "glob"

glob

glob: GlobOptions

Glob Configuration

TableOptions

TableOptions = object

Properties

source_table_namespace

source_table_namespace: string

Source Table Namespace Namespace or schema of the source table.

source_table_name

source_table_name: string

Source Table Name Name of the source table.

SourceSchemaResponse

SourceSchemaResponse = object

Properties

schema

schema: SourcePreviewSchemaField[]

SourcePreviewResponse

SourcePreviewResponse = object

Properties

schema

schema: SourcePreviewSchemaField[]

records

records: unknown[]

DatasetResource

DatasetResource = { type: "dimension"; dimension: DimensionResource; } | { type: "fact"; fact: FactResource; } & { method: "table"; table: TableResource; } | { method: "sql"; sql: SqlResource; } | { method: "glob"; glob: GlobResource; } & object

Type Declaration

id

id: string

name

name: string

source_id

source_id: string

is_enabled

is_enabled: boolean

frequency_minutes

frequency_minutes: number

datalake_schema

datalake_schema: string

datalake_table_name

datalake_table_name: string

created_at

created_at: string

updated_at

updated_at: string

DimensionResource

DimensionResource = object

Properties

primary_key_column

primary_key_column: string

last_modified_column?

optional last_modified_column?: string

is_deleted_column?

optional is_deleted_column?: string

FactResource

FactResource = object

Properties

primary_key_column

primary_key_column: string

created_at_column

created_at_column: string

GlobResource

GlobResource = object

Properties

pattern

pattern: string

format

format: string

ListDatasetsResponse

ListDatasetsResponse = object

Properties

datasets

datasets: DatasetResource[]

SqlResource

SqlResource = object

Properties

query

query: string

TableResource

TableResource = object

Properties

source_table_namespace

source_table_namespace: string

source_table_name

source_table_name: string

CreateDatasetRequest

CreateDatasetRequest = object

Properties

dataset

dataset: DatasetOptions

DatasetOptions

DatasetOptions = { type: "dimension"; dimension: DimensionOptions; } | { type: "fact"; fact: FactOptions; } & { method: "table"; table: TableOptions; } | { method: "sql"; sql: SQLOptions; } | { method: "glob"; glob: GlobOptions; } & object

Type Declaration

name?

optional name?: string

Name Name of the dataset.

source_id

source_id: string

Source ID ID of the import source this dataset belongs to.

is_enabled?

optional is_enabled?: boolean

Enabled Whether this dataset is enabled.

frequency_minutes

frequency_minutes: number

Frequency Minutes Frequency in minutes for syncing this dataset.

DimensionOptions

DimensionOptions = object

Properties

primary_key_column

primary_key_column: string

Primary Key Column Name of the primary key column.

last_modified_column?

optional last_modified_column?: string

Last Modified Column Name of the last modified timestamp column (optional).

is_deleted_column?

optional is_deleted_column?: string

Is Deleted Column Name of the soft delete column (optional).

FactOptions

FactOptions = object

Properties

primary_key_column

primary_key_column: string

Primary Key Column Name of the primary key column.

created_at_column

created_at_column: string

Created At Column Name of the created at timestamp column (required for facts).

GetDatasetResponse

GetDatasetResponse = object

Properties

dataset

dataset: DatasetResource

UpdateDatasetOptions

UpdateDatasetOptions = object

Properties

name?

optional name?: string

Name of the dataset.

frequency_minutes?

optional frequency_minutes?: number

Frequency in minutes for syncing this dataset.

is_enabled?

optional is_enabled?: boolean

Whether this dataset is enabled.

UpdateDatasetRequest

UpdateDatasetRequest = object

Properties

dataset

dataset: UpdateDatasetOptions

DatasetSchemaColumn

DatasetSchemaColumn = object

Properties

column_name

column_name: string

Column Name The name of the column in the dataset.

prequel_type

prequel_type: string

Prequel Type The most recent normalized Prequel data type for this column.

source_type

source_type: string

Source Type The most recent raw data type from the source for this column.

seen_source_types

seen_source_types: string[]

Seen Source Types All distinct raw source types seen historically for this column.

seen_prequel_types

seen_prequel_types: string[]

Seen Prequel Types All distinct normalized Prequel types seen historically for this column.

in_latest_extract

in_latest_extract: boolean

In Latest Extract Indicates if this column was present in the most recent successful extract.

first_seen_at

first_seen_at: string

First Seen At The timestamp when this column was first extracted.

last_seen_at

last_seen_at: string

Last Seen At The timestamp when this column was most recently extracted.

GetDatasetSchemaResponse

GetDatasetSchemaResponse = object

Properties

columns

columns: DatasetSchemaColumn[]

ErrorResource

ErrorResource = object

Properties

error_code

error_code: string

title

title: string

blame

blame: string

documentation_url

documentation_url: string

trace

trace: string

message

message: string

ExtractResource

ExtractResource = object

Properties

id

id: string

dataset_id

dataset_id: string

submitted_at

submitted_at: string

started_at?

optional started_at?: string

ended_at?

optional ended_at?: string

records_processed?

optional records_processed?: number

records_existing_updated?

optional records_existing_updated?: number

records_existing_unchanged?

optional records_existing_unchanged?: number

records_existing_deleted?

optional records_existing_deleted?: number

records_new_inserted?

optional records_new_inserted?: number

records_errored?

optional records_errored?: number

error?

optional error?: ErrorResource

DatasetRandomSampleRequest

DatasetRandomSampleRequest = object

Properties

sample_size

sample_size: number

DatasetRandomSampleResponse

DatasetRandomSampleResponse = object

Properties

schema

schema: QueryResultSchemaField[]

records

records: unknown[]

HttpRequestTemplate

HttpRequestTemplate = object

Properties

method

method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE"

Method HTTP method for the request.

uri

uri: string

URI Request URI with template variables.

headers?

optional headers?: object

Headers HTTP headers.

Index Signature

[key: string]: string

body?

optional body?: string

Body Request body template.

WebhookBatchResource

WebhookBatchResource = object

Properties

request_template

request_template: HttpRequestTemplate

format

format: string

max_size_per_batch

max_size_per_batch: number

max_batches_per_minute

max_batches_per_minute: number

max_concurrency

max_concurrency: number

WebhookRecordResource

WebhookRecordResource = object

Properties

request_template

request_template: HttpRequestTemplate

max_records_per_minute

max_records_per_minute: number

max_concurrency

max_concurrency: number

WebhookBatchOptions

WebhookBatchOptions = object

Properties

request_template

request_template: HttpRequestTemplate

Request Template HTTP request template for sending batch data.

format

format: "parquet" | "csv" | "json"

Format Batch file format.

max_size_per_batch?

optional max_size_per_batch?: number

Max Size Per Batch Maximum records per batch.

max_batches_per_minute?

optional max_batches_per_minute?: number

Max Batches Per Minute Rate limit for batches per minute.

max_concurrency?

optional max_concurrency?: number

Max Concurrency Maximum concurrent request clients.

WebhookRecordOptions

WebhookRecordOptions = object

Properties

request_template

request_template: HttpRequestTemplate

Request Template HTTP request template for records.

max_records_per_minute?

optional max_records_per_minute?: number

Max Records Per Minute Rate limit for records per minute.

max_concurrency?

optional max_concurrency?: number

Max Concurrency Maximum concurrent request clients.

UpdateDestinationOptions

UpdateDestinationOptions = object

Properties

name?

optional name?: string

Unique name for this destination.

type?

optional type?: "webhook_record" | "webhook_batch"

Destination type.

record_schema?

optional record_schema?: unknown

JSON Schema for validating records (JSON5 supported).

webhook_record?

optional webhook_record?: UpdateWebhookRecordOptions

HTTP Record Configuration

webhook_batch?

optional webhook_batch?: UpdateWebhookBatchOptions

HTTP Batch Configuration

UpdateDestinationRequest

UpdateDestinationRequest = object

Properties

destination

destination: UpdateDestinationOptions

UpdateWebhookBatchOptions

UpdateWebhookBatchOptions = object

Properties

request_template?

optional request_template?: HttpRequestTemplate

HTTP request template for sending batch data.

format?

optional format?: "parquet" | "csv" | "json"

max_size_per_batch?

optional max_size_per_batch?: number

Maximum records per batch.

max_batches_per_minute?

optional max_batches_per_minute?: number

Rate limit for batches per minute.

max_concurrency?

optional max_concurrency?: number

Maximum concurrent request clients.

UpdateWebhookRecordOptions

UpdateWebhookRecordOptions = object

Properties

request_template?

optional request_template?: HttpRequestTemplate

HTTP request template for records.

max_records_per_minute?

optional max_records_per_minute?: number

Rate limit for records per minute.

max_concurrency?

optional max_concurrency?: number

Maximum concurrent request clients.

ListProductsResponse

ListProductsResponse = object

Properties

products

products: ProductResource[]

ProductResource

ProductResource = object

Properties

id

id: string

name

name: string

description?

optional description?: string

destinations

destinations: string[]

created_at

created_at: string

updated_at

updated_at: string

GetProductResponse

GetProductResponse = object

Properties

product

product: ProductResource

ListStreamsResponse

ListStreamsResponse = object

Properties

streams

streams: StreamResource[]

MappingResource

MappingResource = object

Properties

field_type

field_type: string

column?

optional column?: object

Index Signature

[key: string]: string

expression?

optional expression?: object

Index Signature

[key: string]: string

target_field

target_field: string

StreamResource

StreamResource = object

Properties

id

id: string

name

name: string

is_enabled

is_enabled: boolean

destination_is_circuit_broken

destination_is_circuit_broken: boolean

destination_id

destination_id: string

dataset_id

dataset_id: string

mappings

mappings: MappingResource[]

created_at

created_at: string

updated_at

updated_at: string

MappingOptions

MappingOptions = object

Properties

field_type

field_type: string

Field Type Type of field mapping (field or expression).

column?

optional column?: object

Column Column reference for field type mappings.

Index Signature

[key: string]: string

expression?

optional expression?: object

Expression Configuration for expression field mappings.

Index Signature

[key: string]: string

target_field

target_field: string

Target Field The target field name in the destination.

StreamOptions

StreamOptions = object

Properties

name

name: string

Name Name for this stream.

is_enabled?

optional is_enabled?: boolean

Is Enabled Whether this stream is enabled.

destination_is_circuit_broken?

optional destination_is_circuit_broken?: boolean

Destination Is Circuit Broken Whether the destination is failing continuously.

destination_id

destination_id: string

Destination ID The ID of the destination this stream connects to.

dataset_id

dataset_id: string

Dataset ID The ID of the dataset this stream uses as source.

mappings

mappings: MappingOptions[]

Mappings Field mappings for this stream.

GetStreamResponse

GetStreamResponse = object

Properties

stream

stream: StreamResource

UpdateStreamOptions

UpdateStreamOptions = object

Properties

name?

optional name?: string

Name for this stream.

is_enabled?

optional is_enabled?: boolean

Whether this stream is enabled.

destination_is_circuit_broken?

optional destination_is_circuit_broken?: boolean

Whether the destination is failing continuously.

mappings?

optional mappings?: MappingOptions[]

Field mappings for this stream.

LoadResource

LoadResource = object

Properties

id

id: string

stream_id

stream_id: string

submitted_at

submitted_at: string

started_at?

optional started_at?: string

ended_at?

optional ended_at?: string

records_processed?

optional records_processed?: number

records_transformed?

optional records_transformed?: number

records_valid?

optional records_valid?: number

records_loaded?

optional records_loaded?: number

records_errored?

optional records_errored?: number

error?

optional error?: ErrorResource

record_ids?

optional record_ids?: string[]

actor_id

actor_id: string

actor_type

actor_type: string

TestStreamTransformRequest

TestStreamTransformRequest = object

Properties

record_ids

record_ids: string[]

Record IDs List of specific record IDs to test the transformation against.

stream?

optional stream?: UpdateStreamOptions

Stream Optional partial stream patch merged onto the saved stream to preview transform output without persisting.

TestStreamTransformResponse

TestStreamTransformResponse = object

Properties

schema

schema: QueryResultSchemaField[]

records

records: unknown[]

TestNewStreamRequest

TestNewStreamRequest = object

Properties

stream

stream: StreamOptions

Stream Candidate stream definition to test.

record_ids

record_ids: string[]

Record IDs List of specific record IDs to test the transformation against.

TestNewSourceRequest

TestNewSourceRequest = object

Properties

source

source: SourceOptions

Source Candidate source definition to test.

TestSourceResponse

TestSourceResponse = object

Properties

code?

optional code?: string

message?

optional message?: string

TestSourceRequest

TestSourceRequest = object

Properties

source?

optional source?: UpdateSourceOptions

Source Optional partial source patch merged onto the saved source to test connection without persisting.

ListExtractsResponse

ListExtractsResponse = object

Properties

extracts

extracts: ExtractResource[]

GetExtractResponse

GetExtractResponse = object

Properties

extract

extract: ExtractResource

DebugError

DebugError = object

Properties

error_code

error_code: string

error_trace

error_trace: string

ExtractDebugRecord

ExtractDebugRecord = object

Properties

record_id

record_id: string

event_timestamp

event_timestamp: string

extract?

optional extract?: ExtractDebugStage

ExtractDebugResponse

ExtractDebugResponse = object

Properties

records

records: ExtractDebugRecord[]

ExtractDebugStage

ExtractDebugStage = object

Properties

last_seen_at

last_seen_at: string

last_extracted_at

last_extracted_at: string

last_modified_in_source_at?

optional last_modified_in_source_at?: string

error?

optional error?: DebugError

is_deleted?

optional is_deleted?: boolean

ListLoadsResponse

ListLoadsResponse = object

Properties

loads

loads: LoadResource[]

GetLoadResponse

GetLoadResponse = object

Properties

load

load: LoadResource

TestExpressionRequest

TestExpressionRequest = object

Properties

data

data: string

The data to use for the expression evaluation.

expr

expr: string

The expression to evaluate.

TestExpressionResponse

TestExpressionResponse = object

Properties

result?

optional result?: unknown

The result of the expression evaluation.

error?

optional error?: string

The error returned by the expression evaluation.

SSHKeyResponse

SSHKeyResponse = object

Properties

public_key

public_key: string

Public key used to verify Prequel-generated signatures. Formatted as a SSH-RSA public key.

public_key_pkcs8

public_key_pkcs8: string

Public key used to verify Prequel key pair auth. Formatted as a PKCS#8 PEM-encoded public key.

SourceFormFieldAttributes

SourceFormFieldAttributes = object

Properties

label

label: string

description?

optional description?: string

placeholder?

optional placeholder?: string

form_element

form_element: string

input_type?

optional input_type?: string

key_format?

optional key_format?: string

BigQuerySourceOptionsGcpServiceAccountRole

BigQuerySourceOptionsGcpServiceAccountRole = object

GCP Service Account

Properties

project_id

project_id: string

Project ID

region

region: string

Region

auth_method

auth_method: "gcp_service_account_role"

gcp_service_account_role

gcp_service_account_role: GcpServiceAccountRole

GCP Service Account Required details if authenticating using a GCP service account role.

BigQuerySourceOptionsFederatedGcpServiceAccountRole

BigQuerySourceOptionsFederatedGcpServiceAccountRole = object

Federation

Properties

project_id

project_id: string

Project ID

region

region: string

Region

auth_method

auth_method: "federated_gcp_service_account_role"

federated_gcp_service_account_role

federated_gcp_service_account_role: FederatedGcpServiceAccountRole

Federation Required details if authenticating using a GCP service account role.

BigQuerySourceOptionsGcpServiceAccountKey

BigQuerySourceOptionsGcpServiceAccountKey = object

Direct Access

Properties

project_id

project_id: string

Project ID

region

region: string

Region

auth_method

auth_method: "gcp_service_account_key"

gcp_service_account_key

gcp_service_account_key: GcpSourceServiceAccountKey

Direct Access Required details if authenticating using a GCP service account key.

DeltaSharingSourceOptionsBearerToken

DeltaSharingSourceOptionsBearerToken = object

Bearer Token

Properties

host

host: string

Host Host address of the Delta Sharing server.

port

port: number

Port

auth_method

auth_method: "bearer_token"

bearer_token

bearer_token: BearerTokenAuth

Bearer Token Required details for bearer token authentication.

DeltaSharingSourceOptionsOAuth2

DeltaSharingSourceOptionsOAuth2 = object

OAuth2

Properties

host

host: string

Host Host address of the Delta Sharing server.

port

port: number

Port

auth_method

auth_method: "oauth2"

oauth2

oauth2: OAuthAuth

OAuth2 Required details for OAuth2 authentication.

GcsSourceOptionsGcpServiceAccountRole

GcsSourceOptionsGcpServiceAccountRole = object

GCP Service Account

Properties

bucket_name

bucket_name: string

GCS bucket name

region

region: string

Region

auth_method

auth_method: "gcp_service_account_role"

gcp_service_account_role

gcp_service_account_role: GcpServiceAccountRole

GCP Service Account Required details if authenticating using a GCP service account role.

GcsSourceOptionsFederatedGcpServiceAccountRole

GcsSourceOptionsFederatedGcpServiceAccountRole = object

Federation

Properties

bucket_name

bucket_name: string

GCS bucket name

region

region: string

Region

auth_method

auth_method: "federated_gcp_service_account_role"

federated_gcp_service_account_role

federated_gcp_service_account_role: FederatedGcpServiceAccountRole

Federation Required details if authenticating using a GCP service account role.

GcsSourceOptionsGcshmacKeys

GcsSourceOptionsGcshmacKeys = object

GCS HMAC Keys

Properties

bucket_name

bucket_name: string

GCS bucket name

region

region: string

Region

auth_method

auth_method: "gcs_hmac_keys"

gcs_hmac_keys

gcs_hmac_keys: GcsAccessKeys

GCS HMAC Keys Required details if authenticating using GCS HMAC keys.

GcsSourceOptionsGcpServiceAccountKey

GcsSourceOptionsGcpServiceAccountKey = object

Direct Access

Properties

bucket_name

bucket_name: string

GCS bucket name

region

region: string

Region

auth_method

auth_method: "gcp_service_account_key"

gcp_service_account_key

gcp_service_account_key: GcpSourceServiceAccountKey

Direct Access Required details if authenticating using a GCP service account key.

RedshiftServerlessSourceOptionsAwsAccessKeys

RedshiftServerlessSourceOptionsAwsAccessKeys = object

AWS Access Keys

Properties

host

host: string

Host Host address of the Redshift Serverless workgroup.

port

port: number

Port

database

database: string

Database Name of the database.

workgroup

workgroup: string

Workgroup Redshift Serverless Workgroup name

region

region: string

Region AWS Region identifier

use_ssh_tunnel?

optional use_ssh_tunnel?: boolean

Use SSH Tunnel Whether to use an SSH tunnel for the connection.

ssh_tunnel?

optional ssh_tunnel?: SshTunnelParams

Required details if using SSH tunneling.

disable_ssl?

optional disable_ssl?: boolean

Disable SSL

connection_timeout_in_seconds?

optional connection_timeout_in_seconds?: number

Connection Timeout Duration to wait for successful connection

auth_method

auth_method: "aws_access_keys"

aws_access_keys

aws_access_keys: RedshiftAccessKeys

AWS Access Keys Required details for AWS access keys authentication.

RedshiftServerlessSourceOptionsAwsiamRole

RedshiftServerlessSourceOptionsAwsiamRole = object

AWS IAM Role

Properties

host

host: string

Host Host address of the Redshift Serverless workgroup.

port

port: number

Port

database

database: string

Database Name of the database.

workgroup

workgroup: string

Workgroup Redshift Serverless Workgroup name

region

region: string

Region AWS Region identifier

use_ssh_tunnel?

optional use_ssh_tunnel?: boolean

Use SSH Tunnel Whether to use an SSH tunnel for the connection.

ssh_tunnel?

optional ssh_tunnel?: SshTunnelParams

Required details if using SSH tunneling.

disable_ssl?

optional disable_ssl?: boolean

Disable SSL

connection_timeout_in_seconds?

optional connection_timeout_in_seconds?: number

Connection Timeout Duration to wait for successful connection

auth_method

auth_method: "aws_iam_role"

aws_iam_role

aws_iam_role: AwsiamRole

AWS IAM Role Required details for AWS IAM role authentication.

RedshiftSourceOptionsAwsAccessKeys

RedshiftSourceOptionsAwsAccessKeys = object

AWS Access Keys

Properties

host

host: string

Host Host address of the Redshift cluster.

port

port: number

Port

database

database: string

Database Name of the database.

cluster

cluster: string

Cluster Redshift Cluster identifier

region

region: string

Region AWS Region identifier

username

username: string

Username

use_ssh_tunnel?

optional use_ssh_tunnel?: boolean

Use SSH Tunnel Whether to use an SSH tunnel for the connection.

ssh_tunnel?

optional ssh_tunnel?: SshTunnelParams

Required details if using SSH tunneling.

disable_ssl?

optional disable_ssl?: boolean

Disable SSL

connection_timeout_in_seconds?

optional connection_timeout_in_seconds?: number

Connection Timeout Duration to wait for successful connection

auth_method

auth_method: "aws_access_keys"

aws_access_keys

aws_access_keys: RedshiftAccessKeys

AWS Access Keys Required details for AWS access keys authentication.

RedshiftSourceOptionsAwsiamRole

RedshiftSourceOptionsAwsiamRole = object

AWS IAM Role

Properties

host

host: string

Host Host address of the Redshift cluster.

port

port: number

Port

database

database: string

Database Name of the database.

cluster

cluster: string

Cluster Redshift Cluster identifier

region

region: string

Region AWS Region identifier

username

username: string

Username

use_ssh_tunnel?

optional use_ssh_tunnel?: boolean

Use SSH Tunnel Whether to use an SSH tunnel for the connection.

ssh_tunnel?

optional ssh_tunnel?: SshTunnelParams

Required details if using SSH tunneling.

disable_ssl?

optional disable_ssl?: boolean

Disable SSL

connection_timeout_in_seconds?

optional connection_timeout_in_seconds?: number

Connection Timeout Duration to wait for successful connection

auth_method

auth_method: "aws_iam_role"

aws_iam_role

aws_iam_role: AwsiamRole

AWS IAM Role Required details for AWS IAM role authentication.

S3SourceOptionsAwsiamRole

S3SourceOptionsAwsiamRole = object

AWS IAM Role

Properties

bucket_name

bucket_name: string

S3 bucket name

region

region: string

Region

bucket_host?

optional bucket_host?: string

Bucket host

use_ssh_tunnel?

optional use_ssh_tunnel?: boolean

Use SSH Tunnel Whether to use an SSH tunnel for the connection.

ssh_tunnel?

optional ssh_tunnel?: SshTunnelParams

Required details if using SSH tunneling.

auth_method

auth_method: "aws_iam_role"

aws_iam_role

aws_iam_role: AwsiamRole

AWS IAM Role Required details for AWS IAM role authentication.

S3SourceOptionsAwsAccessKeys

S3SourceOptionsAwsAccessKeys = object

AWS Access Keys

Properties

bucket_name

bucket_name: string

S3 bucket name

region

region: string

Region

bucket_host?

optional bucket_host?: string

Bucket host

use_ssh_tunnel?

optional use_ssh_tunnel?: boolean

Use SSH Tunnel Whether to use an SSH tunnel for the connection.

ssh_tunnel?

optional ssh_tunnel?: SshTunnelParams

Required details if using SSH tunneling.

auth_method

auth_method: "aws_access_keys"

aws_access_keys

aws_access_keys: AwsAccessKeys

AWS Access Keys Required details for AWS access keys authentication.

SnowflakeSourceOptionsPublicKeyAuth

SnowflakeSourceOptionsPublicKeyAuth = object

Key Pair Authentication

Properties

host

host: string

Account host Host address of the Snowflake account.

port

port: number

Port

database

database: string

Database Name of the database.

username

username: string

Username

auth_method

auth_method: "public_key_auth"

public_key_auth

public_key_auth: PublicKeyAuth

Key Pair Authentication Required details for public key authentication.

GcsDatalakeResourceGcpServiceAccountRole

GcsDatalakeResourceGcpServiceAccountRole = object

Properties

prefix

prefix: string

bucket_name

bucket_name: string

bucket_region

bucket_region: string

auth_method

auth_method: "gcp_service_account_role"

gcp_service_account_role

gcp_service_account_role: GcpDatalakeServiceAccountRoleResource

GcsDatalakeResourceGcpServiceAccountKey

GcsDatalakeResourceGcpServiceAccountKey = object

Properties

prefix

prefix: string

bucket_name

bucket_name: string

bucket_region

bucket_region: string

auth_method

auth_method: "gcp_service_account_key"

gcp_service_account_key

gcp_service_account_key: GcpDatalakeServiceAccountKeyResource

GcsDatalakeResourceFederatedGcpServiceAccountRole

GcsDatalakeResourceFederatedGcpServiceAccountRole = object

Properties

prefix

prefix: string

bucket_name

bucket_name: string

bucket_region

bucket_region: string

auth_method

auth_method: "federated_gcp_service_account_role"

federated_gcp_service_account_role

federated_gcp_service_account_role: FederatedGcpDatalakeServiceAccountRoleResource

S3DatalakeResourceAwsiamRole

S3DatalakeResourceAwsiamRole = object

Properties

prefix

prefix: string

bucket_name

bucket_name: string

bucket_region

bucket_region: string

auth_method

auth_method: "aws_iam_role"

aws_iam_role

aws_iam_role: AwsiamRoleResource

S3DatalakeResourceAwsAccessKeys

S3DatalakeResourceAwsAccessKeys = object

Properties

prefix

prefix: string

bucket_name

bucket_name: string

bucket_region

bucket_region: string

auth_method

auth_method: "aws_access_keys"

aws_access_keys

aws_access_keys: AwsAccessKeysResource

GcsDatalakeOptionsGcpServiceAccountRole

GcsDatalakeOptionsGcpServiceAccountRole = object

Properties

prefix

prefix: string

Prefix to use for the GCS bucket.

bucket_name

bucket_name: string

Bucket Name

bucket_region

bucket_region: string

Region GCS region (e.g. us-central1).

auth_method

auth_method: "gcp_service_account_role"

gcp_service_account_role

gcp_service_account_role: GcpDatalakeServiceAccountRole

GcsDatalakeOptionsGcpServiceAccountKey

GcsDatalakeOptionsGcpServiceAccountKey = object

Properties

prefix

prefix: string

Prefix to use for the GCS bucket.

bucket_name

bucket_name: string

Bucket Name

bucket_region

bucket_region: string

Region GCS region (e.g. us-central1).

auth_method

auth_method: "gcp_service_account_key"

gcp_service_account_key

gcp_service_account_key: GcpDatalakeServiceAccountKey

GcsDatalakeOptionsFederatedGcpServiceAccountRole

GcsDatalakeOptionsFederatedGcpServiceAccountRole = object

Properties

prefix

prefix: string

Prefix to use for the GCS bucket.

bucket_name

bucket_name: string

Bucket Name

bucket_region

bucket_region: string

Region GCS region (e.g. us-central1).

auth_method

auth_method: "federated_gcp_service_account_role"

federated_gcp_service_account_role

federated_gcp_service_account_role: FederatedGcpDatalakeServiceAccountRole

Required details if authenticating using Workload Identity Federation.

S3DatalakeOptionsAwsiamRole

S3DatalakeOptionsAwsiamRole = object

Properties

bucket_name

bucket_name: string

Bucket Name Name of the S3 bucket.

prefix

prefix: string

Prefix to use for the S3 bucket.

bucket_region

bucket_region: string

Region AWS region where the bucket is located.

auth_method

auth_method: "aws_iam_role"

aws_iam_role

aws_iam_role: AwsiamRole

S3DatalakeOptionsAwsAccessKeys

S3DatalakeOptionsAwsAccessKeys = object

Properties

bucket_name

bucket_name: string

Bucket Name Name of the S3 bucket.

prefix

prefix: string

Prefix to use for the S3 bucket.

bucket_region

bucket_region: string

Region AWS region where the bucket is located.

auth_method

auth_method: "aws_access_keys"

aws_access_keys

aws_access_keys: AwsAccessKeys

Required details if authenticating using AWS access keys.

BigQuerySourceResourceGcpServiceAccountRole

BigQuerySourceResourceGcpServiceAccountRole = object

Properties

project_id

project_id: string

region

region: string

auth_method

auth_method: "gcp_service_account_role"

gcp_service_account_role

gcp_service_account_role: GcpServiceAccountRoleResource

BigQuerySourceResourceFederatedGcpServiceAccountRole

BigQuerySourceResourceFederatedGcpServiceAccountRole = object

Properties

project_id

project_id: string

region

region: string

auth_method

auth_method: "federated_gcp_service_account_role"

federated_gcp_service_account_role

federated_gcp_service_account_role: FederatedGcpServiceAccountRoleResource

BigQuerySourceResourceGcpServiceAccountKey

BigQuerySourceResourceGcpServiceAccountKey = object

Properties

project_id

project_id: string

region

region: string

auth_method

auth_method: "gcp_service_account_key"

gcp_service_account_key

gcp_service_account_key: GcpServiceAccountKeyResource

DatasetFrequencyMinutes

DatasetFrequencyMinutes = typeof DATASET_FREQUENCY_MINUTES[number]

DestinationResource

DestinationResource = object

Properties

id

id: string

name

name: string

type

type: string

created_at

created_at: string

updated_at

updated_at: string

webhook_record?

optional webhook_record?: WebhookRecordResource

webhook_batch?

optional webhook_batch?: WebhookBatchResource

record_schema

record_schema: unknown

GetDestinationResponse

GetDestinationResponse = object

Properties

destination

destination: DestinationResource

ListDestinationsResponse

ListDestinationsResponse = object

Properties

destinations

destinations: DestinationResource[]

SourceFormEnumObject

SourceFormEnumObject = object

Properties

key

key: unknown

display

display: string

icon_url?

optional icon_url?: string

disabled?

optional disabled?: boolean

SourceFormField

SourceFormField = object

Properties

path

path: string

name

name: string

parent?

optional parent?: unknown

type

type: string

required

required: boolean

read_only?

optional read_only?: boolean

refetch_on_change

refetch_on_change: boolean

const?

optional const?: unknown

default?

optional default?: unknown

enum?

optional enum?: SourceFormEnumObject[]

attributes

attributes: SourceFormFieldAttributes

SourceFormResponse

SourceFormResponse = object

Properties

fields

fields: SourceFormField[]

SourceConnectionTestResult

SourceConnectionTestResult = object

Properties

status

status: "success" | "error"

code?

optional code?: string

message?

optional message?: string

DeepPartial

DeepPartial<T> = T extends object ? { [K in keyof T]?: DeepPartial<T[K]> } : T

Type Parameters

Type Parameter
`T`

SourceFormSource

SourceFormSource = DeepPartial<SourceOptions> & object

Type Declaration

provider_id?

optional provider_id?: string

name?

optional name?: string

vendor?

optional vendor?: string

Variables

DATASET_FREQUENCY_MINUTES

const DATASET_FREQUENCY_MINUTES: readonly [10, 15, 60, 360, 720, 1440]

⌘I

​React SDK API Models

​AbsSourceOptions

​Properties

bucket_name

storage_account_name

auth_method

azure_service_shared_access_signature

​AwsAccessKeys

​Properties

access_id

secret_key

​AwsiamRole

​Properties

aws_iam_role_arn

​AzureServiceSharedAccessSignature

​Properties

shared_access_signature_token

​BearerTokenAuth

​Properties

bearer_token

​BigQuerySourceOptions

​CredentialSource

​Properties

environment_id

region_url

url

regional_cred_verification_url

​DeltaSharingSourceOptions

​FederatedGcpServiceAccountRole

​Properties

service_account_email

workload_identity_federation_metadata?

​GcpServiceAccountRole

​Properties

service_account_email

​GcpSourceServiceAccountKey

​Properties

service_account_email

service_account_key

​GcsAccessKeys

​Properties

access_key

secret

​GcsSourceOptions

​GcpExternalAccountMetadata

​Properties

type

audience

subject_token_type

service_account_impersonation_url

token_url

credential_source

​OAuthAuth

​Properties

client_id

client_secret

​PasswordAuth

​Properties

username

password

​PostgresSourceOptions

​Properties

host

port

database

auth_method

password_auth

use_ssh_tunnel?

ssh_tunnel?

disable_ssl?

​PublicKeyAuth

​Properties

public_key

​RedshiftAccessKeys

​Properties

password

access_id

secret_key

​RedshiftServerlessSourceOptions

​RedshiftSourceOptions

React SDK API Models

AbsSourceOptions

Properties

AwsAccessKeys

Properties

AwsiamRole

Properties

AzureServiceSharedAccessSignature

Properties

BearerTokenAuth

Properties

BigQuerySourceOptions

CredentialSource

Properties

DeltaSharingSourceOptions

FederatedGcpServiceAccountRole

Properties

GcpServiceAccountRole

Properties

GcpSourceServiceAccountKey

Properties

GcsAccessKeys

Properties

GcsSourceOptions

GcpExternalAccountMetadata

Properties

OAuthAuth

Properties

PasswordAuth

Properties

PostgresSourceOptions

Properties

PublicKeyAuth

Properties

RedshiftAccessKeys

Properties

RedshiftServerlessSourceOptions

RedshiftSourceOptions

S3CompatibleSourceOptions

Properties

S3SourceOptions

SftpSourceOptions

Properties

SshTunnelParams

Properties

SnowflakeSourceOptions

SourceOptions

Type Declaration

AbsDatalakeResource

Properties

AwsAccessKeysResource

Properties

AwsiamRoleResource

Properties

AzureStorageAccountAccessKeyResource

Index Signature

DatalakeResource

Type Declaration

FederatedGcpDatalakeServiceAccountRoleResource

Properties

GcpDatalakeServiceAccountKeyResource

Properties

GcpDatalakeServiceAccountRoleResource

Properties