• management
• SDK
• ConnectionsClient

Class ConnectionsClient

Index

Constructors

constructor

Methods

listcreategetdeleteupdate

Properties

_options

Constructors

constructor

new ConnectionsClient(options: BaseClientOptions): ConnectionsClient

Parameters

• options: BaseClientOptions

Returns ConnectionsClient

Methods

list

list(
request?: ListFlowsVaultConnectionsRequestParameters,
requestOptions?: ConnectionsClient.RequestOptions,
): Promise<
Page<
FlowsVaultConnectionSummary,
ListFlowsVaultConnectionsOffsetPaginatedResponseContent,
>,
>

Parameters

• request: ListFlowsVaultConnectionsRequestParameters = {}
• OptionalrequestOptions: ConnectionsClient.RequestOptions

Request-specific configuration.

Returns Promise< Page< FlowsVaultConnectionSummary, ListFlowsVaultConnectionsOffsetPaginatedResponseContent, >, >

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.flows.vault.connections.list({ page: 1, per_page: 1, include_totals: true })Copy

create

create(
request: CreateFlowsVaultConnectionRequestContent,
requestOptions?: ConnectionsClient.RequestOptions,
): HttpResponsePromise<CreateFlowsVaultConnectionResponseContent>

Parameters

• request: CreateFlowsVaultConnectionRequestContent
• OptionalrequestOptions: ConnectionsClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<CreateFlowsVaultConnectionResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.flows.vault.connections.create({ name: "name", app_id: "ACTIVECAMPAIGN", setup: { type: "API_KEY", api_key: "api_key", base_url: "base_url" } })Copy

get

get(
id: string,
requestOptions?: ConnectionsClient.RequestOptions,
): HttpResponsePromise<GetFlowsVaultConnectionResponseContent>

Parameters

• id: string

Flows Vault connection ID

• OptionalrequestOptions: ConnectionsClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<GetFlowsVaultConnectionResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.flows.vault.connections.get("id")Copy

delete

delete(
id: string,
requestOptions?: ConnectionsClient.RequestOptions,
): HttpResponsePromise<void>

Parameters

• id: string

Vault connection id

• OptionalrequestOptions: ConnectionsClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.flows.vault.connections.delete("id")Copy

update

update(
id: string,
request?: UpdateFlowsVaultConnectionRequestContent,
requestOptions?: ConnectionsClient.RequestOptions,
): HttpResponsePromise<UpdateFlowsVaultConnectionResponseContent>

Parameters

• id: string

Flows Vault connection ID

• request: UpdateFlowsVaultConnectionRequestContent = {}
• OptionalrequestOptions: ConnectionsClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<UpdateFlowsVaultConnectionResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.flows.vault.connections.update("id")Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods listcreategetdeleteupdate Properties _options