Class ConnectionsClient

Index

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
    })
```

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"
        }
    })
```

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")
```

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")
```

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")
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Class ConnectionsClient

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns ConnectionsClient

Methods

list

Parameters

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

Throws

Throws

Throws

Throws

Example

create

Parameters

Returns HttpResponsePromise<CreateFlowsVaultConnectionResponseContent>

Throws

Throws

Throws

Throws

Example

get

Parameters

Returns HttpResponsePromise<GetFlowsVaultConnectionResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

delete

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws

Example

update

Parameters

Returns HttpResponsePromise<UpdateFlowsVaultConnectionResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

Properties

Protected Readonly_options

Settings

On This Page

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

`Protected` `Readonly`_options