docs/classes/management.SDK.ModulesClient.html
listcreategetdeleteupdatelistActionsrollback
get versions(): VersionsClient
new ModulesClient(options: BaseClientOptions): ModulesClient
list(
request?: GetActionModulesRequestParameters,
requestOptions?: ModulesClient.RequestOptions,
): Promise<Page<ActionModuleListItem, GetActionModulesResponseContent>>
Retrieve a paginated list of all Actions Modules with optional filtering and totals.
OptionalrequestOptions: ModulesClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.actions.modules.list({ page: 1, per_page: 1 })Copy
create(
request: CreateActionModuleRequestContent,
requestOptions?: ModulesClient.RequestOptions,
): HttpResponsePromise<CreateActionModuleResponseContent>
Create a new Actions Module for reusable code across actions.
OptionalrequestOptions: ModulesClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.actions.modules.create({ name: "name", code: "code" })Copy
get(
id: string,
requestOptions?: ModulesClient.RequestOptions,
): HttpResponsePromise<GetActionModuleResponseContent>
Retrieve details of a specific Actions Module by its unique identifier.
The ID of the action module to retrieve.
OptionalrequestOptions: ModulesClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.actions.modules.get("id")Copy
delete(
id: string,
requestOptions?: ModulesClient.RequestOptions,
): HttpResponsePromise<void>
Permanently delete an Actions Module. This will fail if the module is still in use by any actions.
The ID of the Actions Module to delete.
OptionalrequestOptions: ModulesClient.RequestOptionsRequest-specific configuration.
Management.PreconditionFailedError
Management.TooManyRequestsError
await client.actions.modules.delete("id")Copy
update(
id: string,
request?: UpdateActionModuleRequestContent,
requestOptions?: ModulesClient.RequestOptions,
): HttpResponsePromise<UpdateActionModuleResponseContent>
Update properties of an existing Actions Module, such as code, dependencies, or secrets.
The ID of the action module to update.
OptionalrequestOptions: ModulesClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.actions.modules.update("id")Copy
listActions(
id: string,
request?: GetActionModuleActionsRequestParameters,
requestOptions?: ModulesClient.RequestOptions,
): Promise<Page<ActionModuleAction, GetActionModuleActionsResponseContent>>
Lists all actions that are using a specific Actions Module, showing which deployed action versions reference this Actions Module.
The unique ID of the module.
OptionalrequestOptions: ModulesClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.actions.modules.listActions("id", { page: 1, per_page: 1 })Copy
rollback(
id: string,
request: RollbackActionModuleRequestParameters,
requestOptions?: ModulesClient.RequestOptions,
): HttpResponsePromise<RollbackActionModuleResponseContent>
Rolls back an Actions Module's draft to a previously created version. This action copies the code, dependencies, and secrets from the specified version into the current draft.
The unique ID of the module to roll back.
OptionalrequestOptions: ModulesClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.actions.modules.rollback("id", { module_version_id: "module_version_id" })Copy
Protected Readonly_options_options: NormalizedClientOptionsWithAuth<BaseClientOptions>
Protected_versions_versions: VersionsClient | undefined
Member Visibility
ThemeOSLightDark
Accessors versions Constructors constructor Methods listcreategetdeleteupdatelistActionsrollback Properties _options_versions