IOrganizationAutomationService

IOrganizationAutomationService.deleteAutomation()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Delete automation from any workspace within the organization

deleteAutomation(id: string, workspaceId: string): Promise<void>;

Parameters

Returns

Promise<void>

Promise resolved when the automation is deleted.

IOrganizationAutomationService.deleteAutomations()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Delete multiple automations across workspaces for centralized management

Deletes multiple automations identified by their IDs from any workspace within the organization.

deleteAutomations(automations: Array<{
        id: string;
        workspaceId: string;
    }>): Promise<void>;

Parameters

Returns

Promise<void>

Promise resolved when the automations are deleted.

IOrganizationAutomationService.getAutomationsQuery()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

List automations across the organization for centralized management

getAutomationsQuery(options?: IGetAutomationsQueryOptions): IOrganizationAutomationsQuery;

Parameters

Returns

IOrganizationAutomationsQuery

methods for querying organization automations

IOrganizationAutomationService.pauseAutomation()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Pause automation from any workspace within the organization

pauseAutomation(id: string, workspaceId: string): Promise<void>;

Parameters

Returns

Promise<void>

Promise resolved when the automation is paused.

IOrganizationAutomationService.pauseAutomations()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Pause multiple automations across workspaces for centralized management

Pauses multiple automations identified by their IDs from any workspace within the organization.

pauseAutomations(automations: Array<{
        id: string;
        workspaceId: string;
    }>): Promise<void>;

Parameters

Returns

Promise<void>

Promise resolved when the automations are paused.

IOrganizationAutomationService.resumeAutomation()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Resume automation from any workspace within the organization

resumeAutomation(id: string, workspaceId: string): Promise<void>;

Parameters

Returns

Promise<void>

Promise resolved when the automation is resumed.

IOrganizationAutomationService.resumeAutomations()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Resume multiple automations across workspaces for centralized management

Resumes multiple automations identified by their IDs from any workspace within the organization.

resumeAutomations(automations: Array<{
        id: string;
        workspaceId: string;
    }>): Promise<void>;

Parameters

Returns

Promise<void>

Promise resolved when the automations are resumed.

IOrganizationAutomationService.unsubscribeAutomation()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Unsubscribe from automation from any workspace within the organization

unsubscribeAutomation(id: string, workspaceId: string): Promise<void>;

Parameters

Returns

Promise<void>

Promise resolved when unsubscribed from the automation.

IOrganizationAutomationService.unsubscribeAutomations()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Unsubscribe from multiple automations across workspaces for centralized management

Unsubscribes from multiple automations identified by their IDs from any workspace within the organization.

unsubscribeAutomations(automations: Array<{
        id: string;
        workspaceId: string;
    }>): Promise<void>;

Parameters

Returns

Promise<void>

Promise resolved when unsubscribed from the automations.