Class Clients

Index

Constructors

Methods

get update _getAuthorizationHeader

Properties

Constructors

constructor

new Clients(_options: Clients.Options): Clients
Parameters
- _options: Clients.Options
Returns Clients

Methods

get

get(
    id: string,
    request?: Management.GetConnectionEnabledClientsRequestParameters,
    requestOptions?: Clients.RequestOptions,
): Promise<Page<ConnectionEnabledClient>>
Retrieve all clients that have the specified connection enabled.

Note: The first time you call this endpoint, omit the from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no further results are remaining.
Parameters
- id: string
  The id of the connection for which enabled clients are to be retrieved
- request: Management.GetConnectionEnabledClientsRequestParameters = {}
- OptionalrequestOptions: Clients.RequestOptions
  Request-specific configuration.
Returns Promise<Page<ConnectionEnabledClient>>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.connections.clients.get("id")
```

update

update(
    id: string,
    request: UpdateEnabledClientConnectionsRequestContent,
    requestOptions?: Clients.RequestOptions,
): HttpResponsePromise<void>
Parameters
- id: string
  The id of the connection to modify
- request: UpdateEnabledClientConnectionsRequestContent
- OptionalrequestOptions: Clients.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.connections.clients.update("id", [{
            client_id: "client_id",
            status: true
        }])
```

`Protected`_getAuthorizationHeader

_getAuthorizationHeader(): Promise<string>
Returns Promise<string>

Properties

`Protected` `Readonly`_options

_options: Clients.Options