• management
• SDK
• VersionsClient

Class VersionsClient

Index

Constructors

constructor

Methods

listgetdeploy

Properties

_options

Constructors

constructor

new VersionsClient(options: BaseClientOptions): VersionsClient

Parameters

• options: BaseClientOptions

Returns VersionsClient

Methods

list

list(
actionId: string,
request?: ListActionVersionsRequestParameters,
requestOptions?: VersionsClient.RequestOptions,
): Promise<Page<ActionVersion, ListActionVersionsPaginatedResponseContent>>

Retrieve all of an action's versions. An action version is created whenever an action is deployed. An action version is immutable, once created.

Parameters

• actionId: string

The ID of the action.

• request: ListActionVersionsRequestParameters = {}
• OptionalrequestOptions: VersionsClient.RequestOptions

Request-specific configuration.

Returns Promise<Page<ActionVersion, ListActionVersionsPaginatedResponseContent>>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.actions.versions.list("actionId", { page: 1, per_page: 1 })Copy

get

get(
actionId: string,
id: string,
requestOptions?: VersionsClient.RequestOptions,
): HttpResponsePromise<GetActionVersionResponseContent>

Retrieve a specific version of an action. An action version is created whenever an action is deployed. An action version is immutable, once created.

Parameters

• actionId: string

The ID of the action.

• id: string

The ID of the action version.

• OptionalrequestOptions: VersionsClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<GetActionVersionResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.actions.versions.get("actionId", "id")Copy

deploy

deploy(
actionId: string,
id: string,
request?: DeployActionVersionRequestContent | null,
requestOptions?: VersionsClient.RequestOptions,
): HttpResponsePromise<DeployActionVersionResponseContent>

Performs the equivalent of a roll-back of an action to an earlier, specified version. Creates a new, deployed action version that is identical to the specified version. If this action is currently bound to a trigger, the system will begin executing the newly-created version immediately.

Parameters

• actionId: string

The ID of an action.

• id: string

The ID of an action version.

• Optionalrequest: DeployActionVersionRequestContent | null
• OptionalrequestOptions: VersionsClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<DeployActionVersionResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.actions.versions.deploy("actionId", "id")Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods listgetdeploy Properties _options