/** * Faraday REST API * The [Faraday](https://faraday.ai) API makes it easy to predict customer behavior programmatically. See our [API change policy](https://faraday.ai/legal). * * The version of the OpenAPI document: 1.0.0 * Contact: support@faraday.ai * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import { ArchiveConfig, Connection, ConnectionMergePatch, ConnectionPost, Dataset, RotateCredentialsRequest, Target } from '../models'; export interface ArchiveConnectionRequest { connectionId: string; archiveConfig: ArchiveConfig; } export interface CreateConnectionRequest { connectionFields: ConnectionPost; } export interface DeleteConnectionRequest { connectionId: string; } export interface ForceUpdateConnectionRequest { connectionId: string; } export interface GetConnectionRequest { connectionId: string; } export interface GetConnectionDatasetsRequest { connectionId: string; } export interface GetConnectionTargetsRequest { connectionId: string; } export interface GetConnectionsRequest { ids?: Array; } export interface RotateConnectionCredentialsRequest { connectionId: string; rotateCredentialsRequest: RotateCredentialsRequest; } export interface UnarchiveConnectionRequest { connectionId: string; archiveConfig: ArchiveConfig; } export interface UpdateConnectionRequest { connectionId: string; connectionMergePatch: ConnectionMergePatch; } /** * */ export declare class ConnectionsApi extends runtime.BaseAPI { /** * Archive a connection * Archive a connection */ archiveConnectionRaw(requestParameters: ArchiveConnectionRequest): Promise>; /** * Archive a connection * Archive a connection */ archiveConnection(connectionId: string, archiveConfig: ArchiveConfig): Promise; /** * Add a new connection. Connections are configuration for connecting data between Faraday and an external location. They are required when working with **replication targets**. All connections have a `type` that determines which options may be specified. Connection `type` is specified in the `options` object. * Create connection */ createConnectionRaw(requestParameters: CreateConnectionRequest): Promise>; /** * Add a new connection. Connections are configuration for connecting data between Faraday and an external location. They are required when working with **replication targets**. All connections have a `type` that determines which options may be specified. Connection `type` is specified in the `options` object. * Create connection */ createConnection(connectionFields: ConnectionPost): Promise; /** * Delete a connection * Delete a connection */ deleteConnectionRaw(requestParameters: DeleteConnectionRequest): Promise>; /** * Delete a connection * Delete a connection */ deleteConnection(connectionId: string): Promise; /** * Trigger a rerun for this resource. Faraday automatically updates resources when their config changes, but this option is available in case of transient errors. * Trigger a rerun for this resource. */ forceUpdateConnectionRaw(requestParameters: ForceUpdateConnectionRequest): Promise>; /** * Trigger a rerun for this resource. Faraday automatically updates resources when their config changes, but this option is available in case of transient errors. * Trigger a rerun for this resource. */ forceUpdateConnection(connectionId: string): Promise; /** * Get details on a specific connection * Retrieve a connection */ getConnectionRaw(requestParameters: GetConnectionRequest): Promise>; /** * Get details on a specific connection * Retrieve a connection */ getConnection(connectionId: string): Promise; /** * Get all datasets that use this connection * Retrieve all datasets that use this connection */ getConnectionDatasetsRaw(requestParameters: GetConnectionDatasetsRequest): Promise>>; /** * Get all datasets that use this connection * Retrieve all datasets that use this connection */ getConnectionDatasets(connectionId: string): Promise>; /** * Get all targets that use this connection * Retrieve all targets that use this connection */ getConnectionTargetsRaw(requestParameters: GetConnectionTargetsRequest): Promise>>; /** * Get all targets that use this connection * Retrieve all targets that use this connection */ getConnectionTargets(connectionId: string): Promise>; /** * Get a list of connections defined on the account * List connections */ getConnectionsRaw(requestParameters: GetConnectionsRequest): Promise>>; /** * Get a list of connections defined on the account * List connections */ getConnections(ids?: Array): Promise>; /** * Rotate credentials for a connection. Currently only supported for Snowflake connections. This will regenerate the RSA keypair for the connection. * Rotate credentials for a connection */ rotateConnectionCredentialsRaw(requestParameters: RotateConnectionCredentialsRequest): Promise>; /** * Rotate credentials for a connection. Currently only supported for Snowflake connections. This will regenerate the RSA keypair for the connection. * Rotate credentials for a connection */ rotateConnectionCredentials(connectionId: string, rotateCredentialsRequest: RotateCredentialsRequest): Promise; /** * Unarchive a connection * Unarchive a connection */ unarchiveConnectionRaw(requestParameters: UnarchiveConnectionRequest): Promise>; /** * Unarchive a connection * Unarchive a connection */ unarchiveConnection(connectionId: string, archiveConfig: ArchiveConfig): Promise; /** * Update the configuration of a connection. * Update a connection */ updateConnectionRaw(requestParameters: UpdateConnectionRequest): Promise>; /** * Update the configuration of a connection. * Update a connection */ updateConnection(connectionId: string, connectionMergePatch: ConnectionMergePatch): Promise; }