Back to Node Auth0

Class VersionsClient

docs/classes/management.SDK.VersionsClient.html

5.9.16.1 KB
Original Source

Class VersionsClient

Index

Constructors

constructor

Methods

listcreateget

Properties

_options

Constructors

constructor

new VersionsClient(options: BaseClientOptions): VersionsClient

Parameters

Returns VersionsClient

Methods

list

list(
id: string,
request?: GetActionModuleVersionsRequestParameters,
requestOptions?: VersionsClient.RequestOptions,
): Promise<
Page<ActionModuleVersion, GetActionModuleVersionsResponseContent>,
>

List all published versions of a specific Actions Module.

Parameters

  • id: string

The unique ID of the module.

Request-specific configuration.

Returns Promise<Page<ActionModuleVersion, GetActionModuleVersionsResponseContent>>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

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

create

create(
id: string,
requestOptions?: VersionsClient.RequestOptions,
): HttpResponsePromise<CreateActionModuleVersionResponseContent>

Creates a new immutable version of an Actions Module from the current draft version. This publishes the draft as a new version that can be referenced by actions, while maintaining the existing draft for continued development.

Parameters

  • id: string

The ID of the action module to create a version for.

Request-specific configuration.

Returns HttpResponsePromise<CreateActionModuleVersionResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.ConflictError

Throws

Management.PreconditionFailedError

Example

await client.actions.modules.versions.create("id")Copy

get

get(
id: string,
versionId: string,
requestOptions?: VersionsClient.RequestOptions,
): HttpResponsePromise<GetActionModuleVersionResponseContent>

Retrieve the details of a specific, immutable version of an Actions Module.

Parameters

  • id: string

The unique ID of the module.

  • versionId: string

The unique ID of the module version to retrieve.

Request-specific configuration.

Returns HttpResponsePromise<GetActionModuleVersionResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

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

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

  • Protected
  • Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods listcreateget Properties _options