UNPKG

1.87 kBTypeScriptView Raw
1import type { AppID, CursorPaginationEnabled, SortDir, TokenOverridable } from '../common';
2interface CollaboratorIDs {
3 /** @description Array of collaborators (encoded user IDs) - maximum of 50 items. */
4 collaborator_ids: [string, ...string[]];
5}
6interface WorkflowIDs {
7 /** @description Array of workflow IDs - maximum of 50 items. */
8 workflow_ids: [string, ...string[]];
9}
10export interface AdminWorkflowsCollaboratorsAddArguments extends CollaboratorIDs, WorkflowIDs, TokenOverridable {
11}
12export interface AdminWorkflowsCollaboratorsRemoveArguments extends CollaboratorIDs, WorkflowIDs, TokenOverridable {
13}
14export interface AdminWorkflowsPermissionsLookupArguments extends WorkflowIDs, TokenOverridable {
15 /**
16 * @description Maximum number of triggers to fetch for each workflow when determining overall run permissions.
17 * Defaults to `100`. Maximum of `1000`.
18 */
19 max_workflow_triggers?: number;
20}
21export interface AdminWorkflowsSearchArguments extends Partial<AppID>, Partial<CollaboratorIDs>, SortDir, TokenOverridable, CursorPaginationEnabled {
22 /** @description Only include workflows with no collaborators in the result; default is `false`. */
23 no_collaborators?: boolean;
24 /** @description Number of trigger IDs to fetch for each workflow; default is `0`. */
25 num_trigger_ids?: number;
26 /** @description A search query to filter for workflow name or description. */
27 query?: string;
28 /** @description The field used to sort the returned workflows. Currently only `premium_runs` is supported. */
29 sort?: 'premium_runs';
30 /** @description Source of workflow creation, either from `code` or `workflow_builder`. */
31 source?: 'code' | 'workflow_builder';
32}
33export interface AdminWorkflowsUnpublishArguments extends WorkflowIDs, TokenOverridable {
34}
35export {};
36//# sourceMappingURL=workflows.d.ts.map
\No newline at end of file