Class WorkflowTransitionRules

Index

Constructors

Methods

deleteWorkflowTransitionRuleConfigurations getWorkflowTransitionRuleConfigurations updateWorkflowTransitionRuleConfigurations

Constructors

constructor

new WorkflowTransitionRules(client: Client): Version3.WorkflowTransitionRules
Parameters
- client: Client
Returns Version3.WorkflowTransitionRules
- Defined in src/version3/workflowTransitionRules.ts:8

Methods

deleteWorkflowTransitionRuleConfigurations

deleteWorkflowTransitionRuleConfigurations<
    T = Version3Models.WorkflowTransitionRulesUpdateErrors,
>(
    parameters:
        | undefined
        | Version3Parameters.DeleteWorkflowTransitionRuleConfigurations,
    callback: Callback<T>,
): Promise<void>
Deletes workflow transition rules from one or more workflows. These rule types are supported:
Only rules created by the calling Connect app can be deleted.

Permissions required: Only Connect apps can use this operation.
Type Parameters
- T = Version3Models.WorkflowTransitionRulesUpdateErrors
Parameters
- parameters: undefined | Version3Parameters.DeleteWorkflowTransitionRuleConfigurations
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflowTransitionRules.ts:161
deleteWorkflowTransitionRuleConfigurations<
    T = Version3Models.WorkflowTransitionRulesUpdateErrors,
>(
    parameters?: Version3Parameters.DeleteWorkflowTransitionRuleConfigurations,
    callback?: undefined,
): Promise<T>
Deletes workflow transition rules from one or more workflows. These rule types are supported:
Only rules created by the calling Connect app can be deleted.

Permissions required: Only Connect apps can use this operation.
Type Parameters
- T = Version3Models.WorkflowTransitionRulesUpdateErrors
Parameters
- Optionalparameters: Version3Parameters.DeleteWorkflowTransitionRuleConfigurations
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflowTransitionRules.ts:177

getWorkflowTransitionRuleConfigurations

getWorkflowTransitionRuleConfigurations<
    T = Version3Models.PageWorkflowTransitionRules,
>(
    parameters: Version3Parameters.GetWorkflowTransitionRuleConfigurations,
    callback: Callback<T>,
): Promise<void>
Returns a paginated list of workflows with transition rules. The workflows can be filtered to return only those containing workflow transition rules:
- Of one or more transition rule types, such as workflow post functions.
- Matching one or more transition rule keys.
Only workflows containing transition rules created by the calling Connect or Forge app are returned.

Due to server-side optimizations, workflows with an empty list of rules may be returned; these workflows can be ignored.

Permissions required: Only Connect or Forge apps can use this operation.
Type Parameters
- T = Version3Models.PageWorkflowTransitionRules
Parameters
- parameters: Version3Parameters.GetWorkflowTransitionRuleConfigurations
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflowTransitionRules.ts:30
getWorkflowTransitionRuleConfigurations<
    T = Version3Models.PageWorkflowTransitionRules,
>(
    parameters: Version3Parameters.GetWorkflowTransitionRuleConfigurations,
    callback?: undefined,
): Promise<T>
Returns a paginated list of workflows with transition rules. The workflows can be filtered to return only those containing workflow transition rules:
- Of one or more transition rule types, such as workflow post functions.
- Matching one or more transition rule keys.
Only workflows containing transition rules created by the calling Connect or Forge app are returned.

Due to server-side optimizations, workflows with an empty list of rules may be returned; these workflows can be ignored.

Permissions required: Only Connect or Forge apps can use this operation.
Type Parameters
- T = Version3Models.PageWorkflowTransitionRules
Parameters
- parameters: Version3Parameters.GetWorkflowTransitionRuleConfigurations
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflowTransitionRules.ts:54

updateWorkflowTransitionRuleConfigurations

updateWorkflowTransitionRuleConfigurations<
    T = Version3Models.WorkflowTransitionRulesUpdateErrors,
>(
    parameters: Version3Parameters.UpdateWorkflowTransitionRuleConfigurations,
    callback: Callback<T>,
): Promise<void>
Updates configuration of workflow transition rules. The following rule types are supported:
Only rules created by the calling Connect or Forge app can be updated.

To assist with app migration, this operation can be used to:
- Disable a rule.
- Add a tag. Use this to filter rules in the Get workflow transition rule configurations.
Rules are enabled if the disabled parameter is not provided.

Permissions required: Only Connect or Forge apps can use this operation.
Type Parameters
- T = Version3Models.WorkflowTransitionRulesUpdateErrors
Parameters
- parameters: Version3Parameters.UpdateWorkflowTransitionRuleConfigurations
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/workflowTransitionRules.ts:103
updateWorkflowTransitionRuleConfigurations<
    T = Version3Models.WorkflowTransitionRulesUpdateErrors,
>(
    parameters: Version3Parameters.UpdateWorkflowTransitionRuleConfigurations,
    callback?: undefined,
): Promise<T>
Updates configuration of workflow transition rules. The following rule types are supported:
Only rules created by the calling Connect or Forge app can be updated.

To assist with app migration, this operation can be used to:
- Disable a rule.
- Add a tag. Use this to filter rules in the Get workflow transition rule configurations.
Rules are enabled if the disabled parameter is not provided.

Permissions required: Only Connect or Forge apps can use this operation.
Type Parameters
- T = Version3Models.WorkflowTransitionRulesUpdateErrors
Parameters
- parameters: Version3Parameters.UpdateWorkflowTransitionRuleConfigurations
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/workflowTransitionRules.ts:130

Class WorkflowTransitionRules

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Version3.WorkflowTransitionRules

Methods

deleteWorkflowTransitionRuleConfigurations

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getWorkflowTransitionRuleConfigurations

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

updateWorkflowTransitionRuleConfigurations

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page