Class ConnectionProfilesClient

Index

Constructors

constructor

new ConnectionProfilesClient(
options: BaseClientOptions,
): ConnectionProfilesClient
Parameters
- options: BaseClientOptions
Returns ConnectionProfilesClient

Methods

list

list(
    request?: ListConnectionProfileRequestParameters,
    requestOptions?: ConnectionProfilesClient.RequestOptions,
): Promise<
    Page<ConnectionProfile, ListConnectionProfilesPaginatedResponseContent>,
>
Retrieve a list of Connection Profiles. This endpoint supports Checkpoint pagination.
Parameters
- request: ListConnectionProfileRequestParameters = {}
- OptionalrequestOptions: ConnectionProfilesClient.RequestOptions
  Request-specific configuration.
Returns Promise<Page<ConnectionProfile, ListConnectionProfilesPaginatedResponseContent>>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError

Throws
errors.ManagementError

Throws
errors.ManagementTimeoutError
Example
```
await client.connectionProfiles.list({
        from: "from",
        take: 1
    })
```

create

create(
request: CreateConnectionProfileRequestContent,
requestOptions?: ConnectionProfilesClient.RequestOptions,
): HttpResponsePromise<CreateConnectionProfileResponseContent>
Create a Connection Profile.
Parameters
- request: CreateConnectionProfileRequestContent
- OptionalrequestOptions: ConnectionProfilesClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<CreateConnectionProfileResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.ConflictError

Throws
Management.TooManyRequestsError

Throws
errors.ManagementError

Throws
errors.ManagementTimeoutError
Example
```
await client.connectionProfiles.create({
        name: "name"
    })
```

listTemplates

listTemplates(
requestOptions?: ConnectionProfilesClient.RequestOptions,
): HttpResponsePromise<ListConnectionProfileTemplateResponseContent>
Retrieve a list of Connection Profile Templates.
Parameters
- OptionalrequestOptions: ConnectionProfilesClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<ListConnectionProfileTemplateResponseContent>
Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError

Throws
errors.ManagementError

Throws
errors.ManagementTimeoutError
Example
```
await client.connectionProfiles.listTemplates()
```

getTemplate

getTemplate(
id: string,
requestOptions?: ConnectionProfilesClient.RequestOptions,
): HttpResponsePromise<GetConnectionProfileTemplateResponseContent>
Retrieve a Connection Profile Template.
Parameters
- id: string
  ID of the connection-profile-template to retrieve.
- OptionalrequestOptions: ConnectionProfilesClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<GetConnectionProfileTemplateResponseContent>
Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError

Throws
errors.ManagementError

Throws
errors.ManagementTimeoutError
Example
```
await client.connectionProfiles.getTemplate("id")
```

get

get(
id: string,
requestOptions?: ConnectionProfilesClient.RequestOptions,
): HttpResponsePromise<GetConnectionProfileResponseContent>
Retrieve details about a single Connection Profile specified by ID.
Parameters
- id: string
  ID of the connection-profile to retrieve.
- OptionalrequestOptions: ConnectionProfilesClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<GetConnectionProfileResponseContent>
Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError

Throws
errors.ManagementError

Throws
errors.ManagementTimeoutError
Example
```
await client.connectionProfiles.get("id")
```

delete

delete(
id: string,
requestOptions?: ConnectionProfilesClient.RequestOptions,
): HttpResponsePromise<void>
Delete a single Connection Profile specified by ID.
Parameters
- id: string
  ID of the connection-profile to delete.
- OptionalrequestOptions: ConnectionProfilesClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError

Throws
errors.ManagementError

Throws
errors.ManagementTimeoutError
Example
```
await client.connectionProfiles.delete("id")
```

update

update(
    id: string,
    request?: UpdateConnectionProfileRequestContent,
    requestOptions?: ConnectionProfilesClient.RequestOptions,
): HttpResponsePromise<UpdateConnectionProfileResponseContent>
Update the details of a specific Connection Profile.
Parameters
- id: string
  ID of the connection profile to update.
- request: UpdateConnectionProfileRequestContent = {}
- OptionalrequestOptions: ConnectionProfilesClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<UpdateConnectionProfileResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError

Throws
errors.ManagementError

Throws
errors.ManagementTimeoutError
Example
```
await client.connectionProfiles.update("id")
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Class ConnectionProfilesClient

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns ConnectionProfilesClient

Methods

list

Parameters

Returns Promise<Page<ConnectionProfile, ListConnectionProfilesPaginatedResponseContent>>

Throws

Throws

Throws

Throws

Throws

Throws

Example

create

Parameters

Returns HttpResponsePromise<CreateConnectionProfileResponseContent>

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Example

listTemplates

Parameters

Returns HttpResponsePromise<ListConnectionProfileTemplateResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

getTemplate

Parameters

Returns HttpResponsePromise<GetConnectionProfileTemplateResponseContent>

Throws

Throws

Throws

Throws

Throws

Throws

Example

get

Parameters

Returns HttpResponsePromise<GetConnectionProfileResponseContent>

Throws

Throws

Throws

Throws

Throws

Throws

Example

delete

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws

Throws

Example

update

Parameters

Returns HttpResponsePromise<UpdateConnectionProfileResponseContent>

Throws

Throws

Throws

Throws

Throws

Throws

Throws

Example

`Protected` `Readonly`_options