Class ConnectionsClient

Index

Constructors

constructor

new ConnectionsClient(options: BaseClientOptions): ConnectionsClient
Parameters
- options: BaseClientOptions
Returns ConnectionsClient

Methods

list

list(
    id: string,
    request?: ListOrganizationAllConnectionsRequestParameters,
    requestOptions?: ConnectionsClient.RequestOptions,
): Promise<
    Page<
        OrganizationAllConnectionPost,
        ListOrganizationAllConnectionsOffsetPaginatedResponseContent,
    >,
>
Parameters
- id: string
  Organization identifier.
- request: ListOrganizationAllConnectionsRequestParameters = {}
- OptionalrequestOptions: ConnectionsClient.RequestOptions
  Request-specific configuration.
Returns Promise<
    Page<
        OrganizationAllConnectionPost,
        ListOrganizationAllConnectionsOffsetPaginatedResponseContent,
    >,
>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.organizations.connections.list("id", {
        page: 1,
        per_page: 1,
        include_totals: true,
        is_enabled: true
    })
```

create

create(
    id: string,
    request: CreateOrganizationAllConnectionRequestParameters,
    requestOptions?: ConnectionsClient.RequestOptions,
): HttpResponsePromise<CreateOrganizationAllConnectionResponseContent>
Parameters
- id: string
  Organization identifier.
- request: CreateOrganizationAllConnectionRequestParameters
- OptionalrequestOptions: ConnectionsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<CreateOrganizationAllConnectionResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.ConflictError

Throws
Management.TooManyRequestsError
Example
```
await client.organizations.connections.create("id", {
        connection_id: "connection_id"
    })
```

get

get(
    id: string,
    connection_id: string,
    requestOptions?: ConnectionsClient.RequestOptions,
): HttpResponsePromise<GetOrganizationAllConnectionResponseContent>
Parameters
- id: string
  Organization identifier.
- connection_id: string
  Connection identifier.
- OptionalrequestOptions: ConnectionsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<GetOrganizationAllConnectionResponseContent>
Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.organizations.connections.get("id", "connection_id")
```

delete

delete(
    id: string,
    connection_id: string,
    requestOptions?: ConnectionsClient.RequestOptions,
): HttpResponsePromise<void>
Parameters
- id: string
  Organization identifier.
- connection_id: string
  Connection identifier.
- OptionalrequestOptions: ConnectionsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.organizations.connections.delete("id", "connection_id")
```

update

update(
    id: string,
    connection_id: string,
    request?: UpdateOrganizationConnectionRequestParameters,
    requestOptions?: ConnectionsClient.RequestOptions,
): HttpResponsePromise<UpdateOrganizationAllConnectionResponseContent>
Parameters
- id: string
  Organization identifier.
- connection_id: string
  Connection identifier.
- request: UpdateOrganizationConnectionRequestParameters = {}
- OptionalrequestOptions: ConnectionsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<UpdateOrganizationAllConnectionResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.organizations.connections.update("id", "connection_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< OrganizationAllConnectionPost, ListOrganizationAllConnectionsOffsetPaginatedResponseContent, >,>

Throws

Throws

Throws

Throws

Example

create

Parameters

Returns HttpResponsePromise<CreateOrganizationAllConnectionResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

get

Parameters

Returns HttpResponsePromise<GetOrganizationAllConnectionResponseContent>

Throws

Throws

Throws

Throws

Example

delete

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Example

update

Parameters

Returns HttpResponsePromise<UpdateOrganizationAllConnectionResponseContent>

Throws

Throws

Throws

Throws

Example

Properties

Protected Readonly_options

Settings

On This Page

Returns Promise<
Page<
OrganizationAllConnectionPost,
ListOrganizationAllConnectionsOffsetPaginatedResponseContent,
>,
>

`Protected` `Readonly`_options