@embedworkflow/sdk 1.0.0 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/push-tag.yaml +34 -0
- package/.openapi-generator/FILES +87 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +23 -0
- package/README.md +2 -2
- package/api/accounts-api.ts +540 -0
- package/api/action-types-api.ts +697 -0
- package/api/actions-api.ts +786 -0
- package/api/app-connections-api.ts +556 -0
- package/api/available-apps-api.ts +239 -0
- package/api/data-fields-api.ts +404 -0
- package/api/events-api.ts +172 -0
- package/api/executions-api.ts +361 -0
- package/api/installed-apps-api.ts +410 -0
- package/api/payments-api.ts +172 -0
- package/api/triggers-api.ts +437 -0
- package/api/users-api.ts +531 -0
- package/api/workflows-api.ts +1302 -0
- package/api.ts +30 -0
- package/base.ts +86 -0
- package/common.ts +150 -0
- package/configuration.ts +110 -0
- package/dist/api/accounts-api.d.ts +124 -3
- package/dist/api/accounts-api.js +182 -1
- package/dist/api/action-types-api.d.ts +43 -36
- package/dist/api/action-types-api.js +27 -20
- package/dist/api/actions-api.d.ts +6 -6
- package/dist/api/app-connections-api.d.ts +28 -27
- package/dist/api/app-connections-api.js +25 -25
- package/dist/api/available-apps-api.d.ts +2 -2
- package/dist/api/data-fields-api.d.ts +46 -2
- package/dist/api/data-fields-api.js +68 -0
- package/dist/api/events-api.d.ts +1 -1
- package/dist/api/executions-api.d.ts +3 -3
- package/dist/api/installed-apps-api.d.ts +14 -14
- package/dist/api/payments-api.d.ts +1 -1
- package/dist/api/triggers-api.d.ts +22 -20
- package/dist/api/triggers-api.js +12 -12
- package/dist/api/users-api.d.ts +24 -18
- package/dist/api/users-api.js +14 -7
- package/dist/api/workflows-api.d.ts +114 -32
- package/dist/api/workflows-api.js +125 -8
- package/dist/common.d.ts +1 -1
- package/dist/esm/api/accounts-api.d.ts +124 -3
- package/dist/esm/api/accounts-api.js +181 -0
- package/dist/esm/api/action-types-api.d.ts +43 -36
- package/dist/esm/api/action-types-api.js +27 -20
- package/dist/esm/api/actions-api.d.ts +6 -6
- package/dist/esm/api/app-connections-api.d.ts +28 -27
- package/dist/esm/api/app-connections-api.js +25 -25
- package/dist/esm/api/available-apps-api.d.ts +2 -2
- package/dist/esm/api/data-fields-api.d.ts +46 -2
- package/dist/esm/api/data-fields-api.js +69 -1
- package/dist/esm/api/events-api.d.ts +1 -1
- package/dist/esm/api/executions-api.d.ts +3 -3
- package/dist/esm/api/installed-apps-api.d.ts +14 -14
- package/dist/esm/api/payments-api.d.ts +1 -1
- package/dist/esm/api/triggers-api.d.ts +22 -20
- package/dist/esm/api/triggers-api.js +12 -12
- package/dist/esm/api/users-api.d.ts +24 -18
- package/dist/esm/api/users-api.js +14 -7
- package/dist/esm/api/workflows-api.d.ts +114 -32
- package/dist/esm/api/workflows-api.js +124 -7
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/models/catch-hook-request.d.ts +25 -0
- package/dist/esm/models/{api-v1-action-types-post-request-form-draft-inner.d.ts → create-action-type-request-form-draft-inner.d.ts} +18 -12
- package/dist/esm/models/{api-v1-action-types-post-request-form-draft-inner.js → create-action-type-request-form-draft-inner.js} +1 -1
- package/dist/esm/models/{api-v1-action-types-post-request-icon-draft.d.ts → create-action-type-request-icon-draft.d.ts} +5 -5
- package/dist/{models/api-v1-action-types-post-request.d.ts → esm/models/create-action-type-request.d.ts} +34 -22
- package/dist/{models/retrieve-action-type404-response.d.ts → esm/models/create-action-type422-response.d.ts} +5 -5
- package/dist/esm/models/{api-v1-app-connections-post-request.d.ts → create-app-connection-request.d.ts} +6 -6
- package/dist/esm/models/create-workflow201-response.d.ts +262 -0
- package/dist/{models/clone-workflow201-response.js → esm/models/create-workflow201-response.js} +5 -4
- package/dist/esm/models/delete-action-type200-response.d.ts +24 -0
- package/dist/esm/models/delete-action-type200-response.js +14 -0
- package/dist/esm/models/evaluate-expression-request.d.ts +32 -0
- package/dist/esm/models/evaluate-expression-request.js +14 -0
- package/dist/esm/models/evaluate-expression200-response.d.ts +24 -0
- package/dist/esm/models/evaluate-expression200-response.js +14 -0
- package/dist/esm/models/export-configuration200-response-configuration.d.ts +16 -0
- package/dist/esm/models/export-configuration200-response-configuration.js +14 -0
- package/dist/esm/models/export-configuration200-response.d.ts +25 -0
- package/dist/esm/models/export-configuration200-response.js +14 -0
- package/dist/esm/models/import-configuration201-response.d.ts +6 -0
- package/dist/esm/models/index.d.ts +19 -8
- package/dist/esm/models/index.js +19 -8
- package/dist/{models/retrieve-installed-app200-response.d.ts → esm/models/install-app201-response.d.ts} +19 -19
- package/dist/esm/models/install-app201-response.js +14 -0
- package/dist/esm/models/list-action-types200-response-collection-inner.d.ts +58 -0
- package/dist/esm/models/list-action-types200-response-collection-inner.js +9 -0
- package/dist/esm/models/list-data-fields200-response-collection-inner.d.ts +18 -0
- package/dist/esm/models/list-triggers200-response-collection-inner.d.ts +18 -0
- package/dist/esm/models/list-users200-response-collection-inner.d.ts +6 -6
- package/dist/{models/retrieve-workflow200-response.d.ts → esm/models/list-workflows200-response-collection-inner.d.ts} +60 -68
- package/dist/esm/models/{retrieve-workflow200-response.js → list-workflows200-response-collection-inner.js} +1 -1
- package/dist/esm/models/list-workflows200-response.d.ts +32 -0
- package/dist/esm/models/list-workflows200-response.js +14 -0
- package/dist/esm/models/retrieve-account-usage200-response.d.ts +60 -0
- package/dist/esm/models/retrieve-account-usage200-response.js +14 -0
- package/dist/esm/models/retrieve-account200-response.d.ts +19 -1
- package/dist/esm/models/update-account-request-action-type-categories-inner-icon.d.ts +36 -0
- package/dist/esm/models/update-account-request-action-type-categories-inner-icon.js +14 -0
- package/dist/esm/models/update-account-request-action-type-categories-inner.d.ts +43 -0
- package/dist/esm/models/update-account-request-action-type-categories-inner.js +14 -0
- package/dist/esm/models/update-account-request.d.ts +13 -0
- package/dist/esm/models/update-action-type-request.d.ts +12 -0
- package/dist/esm/models/update-trigger-request.d.ts +30 -0
- package/dist/esm/models/update-trigger-request.js +14 -0
- package/dist/esm/models/update-workflow-request.d.ts +7 -1
- package/dist/esm/models/upsert-user-request.d.ts +6 -0
- package/dist/models/catch-hook-request.d.ts +25 -0
- package/dist/models/{api-v1-action-types-post-request-form-draft-inner.d.ts → create-action-type-request-form-draft-inner.d.ts} +18 -12
- package/dist/models/{api-v1-action-types-post-request-form-draft-inner.js → create-action-type-request-form-draft-inner.js} +2 -2
- package/dist/models/{api-v1-action-types-post-request-icon-draft.d.ts → create-action-type-request-icon-draft.d.ts} +5 -5
- package/dist/{esm/models/api-v1-action-types-post-request.d.ts → models/create-action-type-request.d.ts} +34 -22
- package/dist/{esm/models/retrieve-action-type404-response.d.ts → models/create-action-type422-response.d.ts} +5 -5
- package/dist/models/{api-v1-app-connections-post-request.d.ts → create-app-connection-request.d.ts} +6 -6
- package/dist/models/create-workflow201-response.d.ts +262 -0
- package/dist/models/create-workflow201-response.js +24 -0
- package/dist/models/delete-action-type200-response.d.ts +24 -0
- package/dist/models/delete-action-type200-response.js +15 -0
- package/dist/models/evaluate-expression-request.d.ts +32 -0
- package/dist/models/evaluate-expression-request.js +15 -0
- package/dist/models/evaluate-expression200-response.d.ts +24 -0
- package/dist/models/evaluate-expression200-response.js +15 -0
- package/dist/models/export-configuration200-response-configuration.d.ts +16 -0
- package/dist/models/export-configuration200-response-configuration.js +15 -0
- package/dist/models/export-configuration200-response.d.ts +25 -0
- package/dist/models/export-configuration200-response.js +15 -0
- package/dist/models/import-configuration201-response.d.ts +6 -0
- package/dist/models/index.d.ts +19 -8
- package/dist/models/index.js +19 -8
- package/dist/{esm/models/retrieve-installed-app200-response.d.ts → models/install-app201-response.d.ts} +19 -19
- package/dist/models/install-app201-response.js +15 -0
- package/dist/models/list-action-types200-response-collection-inner.d.ts +58 -0
- package/dist/models/list-action-types200-response-collection-inner.js +10 -1
- package/dist/models/list-data-fields200-response-collection-inner.d.ts +18 -0
- package/dist/models/list-triggers200-response-collection-inner.d.ts +18 -0
- package/dist/models/list-users200-response-collection-inner.d.ts +6 -6
- package/dist/{esm/models/retrieve-workflow200-response.d.ts → models/list-workflows200-response-collection-inner.d.ts} +60 -68
- package/dist/models/{retrieve-workflow200-response.js → list-workflows200-response-collection-inner.js} +2 -2
- package/dist/models/list-workflows200-response.d.ts +32 -0
- package/dist/models/list-workflows200-response.js +15 -0
- package/dist/models/retrieve-account-usage200-response.d.ts +60 -0
- package/dist/models/retrieve-account-usage200-response.js +15 -0
- package/dist/models/retrieve-account200-response.d.ts +19 -1
- package/dist/models/update-account-request-action-type-categories-inner-icon.d.ts +36 -0
- package/dist/models/update-account-request-action-type-categories-inner-icon.js +15 -0
- package/dist/models/update-account-request-action-type-categories-inner.d.ts +43 -0
- package/dist/models/update-account-request-action-type-categories-inner.js +15 -0
- package/dist/models/update-account-request.d.ts +13 -0
- package/dist/models/update-action-type-request.d.ts +12 -0
- package/dist/models/update-trigger-request.d.ts +30 -0
- package/dist/models/update-trigger-request.js +15 -0
- package/dist/models/update-workflow-request.d.ts +7 -1
- package/dist/models/upsert-user-request.d.ts +6 -0
- package/git_push.sh +57 -0
- package/index.ts +111 -0
- package/models/catch-hook-request.ts +32 -0
- package/models/create-action-type-request-form-draft-inner.ts +88 -0
- package/models/create-action-type-request-icon-draft.ts +42 -0
- package/models/create-action-type-request.ts +129 -0
- package/models/create-action-type422-response.ts +42 -0
- package/models/create-app-connection-request.ts +48 -0
- package/models/create-user-token-request.ts +38 -0
- package/models/create-user-token200-response.ts +30 -0
- package/models/create-workflow-request-template-draft-nodes-inner.ts +138 -0
- package/models/create-workflow-request-template-draft.ts +39 -0
- package/models/create-workflow-request.ts +75 -0
- package/models/create-workflow201-response.ts +266 -0
- package/models/delete-action-type200-response.ts +30 -0
- package/models/delete-workflow200-response-one-of.ts +30 -0
- package/models/delete-workflow200-response-one-of1.ts +30 -0
- package/models/delete-workflow200-response.ts +30 -0
- package/models/discard-workflow-draft-request.ts +36 -0
- package/models/evaluate-expression-request.ts +36 -0
- package/models/evaluate-expression200-response.ts +30 -0
- package/models/execute-workflow-request.ts +50 -0
- package/models/execute-workflow201-response.ts +126 -0
- package/models/export-configuration200-response-configuration.ts +23 -0
- package/models/export-configuration200-response.ts +33 -0
- package/models/import-configuration-request-schema.ts +24 -0
- package/models/import-configuration-request.ts +50 -0
- package/models/import-configuration201-response.ts +60 -0
- package/models/index.ts +70 -0
- package/models/install-app-request.ts +36 -0
- package/models/install-app201-response.ts +126 -0
- package/models/list-action-types200-response-collection-inner.ts +325 -0
- package/models/list-action-types200-response-meta.ts +42 -0
- package/models/list-action-types200-response.ts +42 -0
- package/models/list-actions200-response-collection-inner.ts +150 -0
- package/models/list-actions200-response.ts +42 -0
- package/models/list-app-connections200-response-collection-inner.ts +72 -0
- package/models/list-app-connections200-response.ts +42 -0
- package/models/list-available-apps200-response-collection-inner.ts +72 -0
- package/models/list-available-apps200-response.ts +42 -0
- package/{dist/esm/models/clone-workflow201-response.js → models/list-data-fields-type-parameter.ts} +11 -5
- package/models/list-data-fields200-response-collection-inner.ts +108 -0
- package/models/list-data-fields200-response.ts +42 -0
- package/models/list-events200-response-collection-inner.ts +84 -0
- package/models/list-events200-response.ts +42 -0
- package/models/list-installed-apps200-response-collection-inner.ts +120 -0
- package/models/list-installed-apps200-response.ts +42 -0
- package/models/list-triggers200-response-collection-inner.ts +126 -0
- package/models/list-triggers200-response.ts +42 -0
- package/models/list-users200-response-collection-inner.ts +90 -0
- package/models/list-users200-response.ts +42 -0
- package/models/list-workflow-executions200-response.ts +42 -0
- package/models/list-workflow-versions200-response-collection-inner.ts +66 -0
- package/models/list-workflow-versions200-response.ts +42 -0
- package/{dist/esm/models/clone-workflow201-response.d.ts → models/list-workflows200-response-collection-inner.ts} +76 -47
- package/models/list-workflows200-response.ts +42 -0
- package/models/publish-workflow-request.ts +30 -0
- package/models/retrieve-account-usage200-response.ts +66 -0
- package/models/retrieve-account200-response.ts +114 -0
- package/models/retrieve-available-app200-response.ts +78 -0
- package/models/retrieve-execution200-response.ts +138 -0
- package/models/retry-action-request.ts +38 -0
- package/models/stop-executions-request.ts +38 -0
- package/models/trigger-workflow-request.ts +54 -0
- package/models/update-account-request-action-type-categories-inner-icon.ts +42 -0
- package/models/update-account-request-action-type-categories-inner.ts +51 -0
- package/models/update-account-request-user-data-schema-inner.ts +54 -0
- package/models/update-account-request.ts +96 -0
- package/models/update-action-type-request.ts +48 -0
- package/models/update-installed-app-request.ts +30 -0
- package/models/update-trigger-request.ts +36 -0
- package/models/update-workflow-request.ts +93 -0
- package/models/upsert-user-request.ts +54 -0
- package/package.json +4 -6
- package/tsconfig.esm.json +7 -0
- package/tsconfig.json +18 -0
- package/dist/models/clone-workflow201-response.d.ts +0 -183
- /package/dist/esm/models/{api-v1-action-types-post-request-icon-draft.js → catch-hook-request.js} +0 -0
- /package/dist/esm/models/{api-v1-action-types-post-request.js → create-action-type-request-icon-draft.js} +0 -0
- /package/dist/esm/models/{api-v1-app-connections-post-request.js → create-action-type-request.js} +0 -0
- /package/dist/esm/models/{retrieve-action-type404-response.js → create-action-type422-response.js} +0 -0
- /package/dist/esm/models/{retrieve-installed-app200-response.js → create-app-connection-request.js} +0 -0
- /package/dist/models/{api-v1-action-types-post-request-icon-draft.js → catch-hook-request.js} +0 -0
- /package/dist/models/{api-v1-action-types-post-request.js → create-action-type-request-icon-draft.js} +0 -0
- /package/dist/models/{api-v1-app-connections-post-request.js → create-action-type-request.js} +0 -0
- /package/dist/models/{retrieve-action-type404-response.js → create-action-type422-response.js} +0 -0
- /package/dist/models/{retrieve-installed-app200-response.js → create-app-connection-request.js} +0 -0
|
@@ -12,15 +12,17 @@
|
|
|
12
12
|
import type { Configuration } from '../configuration';
|
|
13
13
|
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
-
import {
|
|
15
|
+
import { CatchHookRequest } from '../models';
|
|
16
|
+
import { CreateWorkflow201Response } from '../models';
|
|
16
17
|
import { CreateWorkflowRequest } from '../models';
|
|
17
18
|
import { DeleteWorkflow200Response } from '../models';
|
|
18
19
|
import { DiscardWorkflowDraftRequest } from '../models';
|
|
19
20
|
import { ExecuteWorkflow201Response } from '../models';
|
|
20
21
|
import { ExecuteWorkflowRequest } from '../models';
|
|
21
22
|
import { ListWorkflowVersions200Response } from '../models';
|
|
23
|
+
import { ListWorkflows200Response } from '../models';
|
|
24
|
+
import { ListWorkflows200ResponseCollectionInner } from '../models';
|
|
22
25
|
import { PublishWorkflowRequest } from '../models';
|
|
23
|
-
import { RetrieveWorkflow200Response } from '../models';
|
|
24
26
|
import { TriggerWorkflowRequest } from '../models';
|
|
25
27
|
import { UpdateWorkflowRequest } from '../models';
|
|
26
28
|
/**
|
|
@@ -28,6 +30,15 @@ import { UpdateWorkflowRequest } from '../models';
|
|
|
28
30
|
* @export
|
|
29
31
|
*/
|
|
30
32
|
export declare const WorkflowsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
33
|
+
/**
|
|
34
|
+
*
|
|
35
|
+
* @summary Catch hook
|
|
36
|
+
* @param {string} hookId The trigger\'s hook id used for third party webhooks
|
|
37
|
+
* @param {CatchHookRequest} [catchHookRequest]
|
|
38
|
+
* @param {*} [options] Override http request option.
|
|
39
|
+
* @throws {RequiredError}
|
|
40
|
+
*/
|
|
41
|
+
catchHook: (hookId: string, catchHookRequest?: CatchHookRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
31
42
|
/**
|
|
32
43
|
*
|
|
33
44
|
* @summary Clone workflow
|
|
@@ -92,10 +103,15 @@ export declare const WorkflowsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
92
103
|
* @param {string} [endingBefore] Cursor for pagination - return results before this ID
|
|
93
104
|
* @param {number} [limit] Number of items to return (max 100)
|
|
94
105
|
* @param {Array<string>} [expand] Expand related objects
|
|
106
|
+
* @param {string} [userKey] Unique user identifier
|
|
107
|
+
* @param {boolean} [isTemplate] Filter workflows by is_template value
|
|
108
|
+
* @param {boolean} [on] Filter workflows by on value
|
|
109
|
+
* @param {string} [orderBy] Field to order results by
|
|
110
|
+
* @param {ListWorkflowsOrderDirectionEnum} [orderDirection]
|
|
95
111
|
* @param {*} [options] Override http request option.
|
|
96
112
|
* @throws {RequiredError}
|
|
97
113
|
*/
|
|
98
|
-
listWorkflows: (startingAfter?: string, endingBefore?: string, limit?: number, expand?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
114
|
+
listWorkflows: (startingAfter?: string, endingBefore?: string, limit?: number, expand?: Array<string>, userKey?: string, isTemplate?: boolean, on?: boolean, orderBy?: string, orderDirection?: ListWorkflowsOrderDirectionEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
99
115
|
/**
|
|
100
116
|
*
|
|
101
117
|
* @summary Publish workflow
|
|
@@ -139,6 +155,15 @@ export declare const WorkflowsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
139
155
|
* @export
|
|
140
156
|
*/
|
|
141
157
|
export declare const WorkflowsApiFp: (configuration?: Configuration) => {
|
|
158
|
+
/**
|
|
159
|
+
*
|
|
160
|
+
* @summary Catch hook
|
|
161
|
+
* @param {string} hookId The trigger\'s hook id used for third party webhooks
|
|
162
|
+
* @param {CatchHookRequest} [catchHookRequest]
|
|
163
|
+
* @param {*} [options] Override http request option.
|
|
164
|
+
* @throws {RequiredError}
|
|
165
|
+
*/
|
|
166
|
+
catchHook(hookId: string, catchHookRequest?: CatchHookRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
142
167
|
/**
|
|
143
168
|
*
|
|
144
169
|
* @summary Clone workflow
|
|
@@ -147,7 +172,7 @@ export declare const WorkflowsApiFp: (configuration?: Configuration) => {
|
|
|
147
172
|
* @param {*} [options] Override http request option.
|
|
148
173
|
* @throws {RequiredError}
|
|
149
174
|
*/
|
|
150
|
-
cloneWorkflow(id: string, discardWorkflowDraftRequest?: DiscardWorkflowDraftRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
175
|
+
cloneWorkflow(id: string, discardWorkflowDraftRequest?: DiscardWorkflowDraftRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListWorkflows200ResponseCollectionInner>>;
|
|
151
176
|
/**
|
|
152
177
|
*
|
|
153
178
|
* @summary Create workflow
|
|
@@ -155,7 +180,7 @@ export declare const WorkflowsApiFp: (configuration?: Configuration) => {
|
|
|
155
180
|
* @param {*} [options] Override http request option.
|
|
156
181
|
* @throws {RequiredError}
|
|
157
182
|
*/
|
|
158
|
-
createWorkflow(createWorkflowRequest?: CreateWorkflowRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
183
|
+
createWorkflow(createWorkflowRequest?: CreateWorkflowRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateWorkflow201Response>>;
|
|
159
184
|
/**
|
|
160
185
|
*
|
|
161
186
|
* @summary Delete workflow
|
|
@@ -174,7 +199,7 @@ export declare const WorkflowsApiFp: (configuration?: Configuration) => {
|
|
|
174
199
|
* @param {*} [options] Override http request option.
|
|
175
200
|
* @throws {RequiredError}
|
|
176
201
|
*/
|
|
177
|
-
discardWorkflowDraft(id: string, discardWorkflowDraftRequest?: DiscardWorkflowDraftRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
202
|
+
discardWorkflowDraft(id: string, discardWorkflowDraftRequest?: DiscardWorkflowDraftRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateWorkflow201Response>>;
|
|
178
203
|
/**
|
|
179
204
|
*
|
|
180
205
|
* @summary Execute workflow
|
|
@@ -203,10 +228,15 @@ export declare const WorkflowsApiFp: (configuration?: Configuration) => {
|
|
|
203
228
|
* @param {string} [endingBefore] Cursor for pagination - return results before this ID
|
|
204
229
|
* @param {number} [limit] Number of items to return (max 100)
|
|
205
230
|
* @param {Array<string>} [expand] Expand related objects
|
|
231
|
+
* @param {string} [userKey] Unique user identifier
|
|
232
|
+
* @param {boolean} [isTemplate] Filter workflows by is_template value
|
|
233
|
+
* @param {boolean} [on] Filter workflows by on value
|
|
234
|
+
* @param {string} [orderBy] Field to order results by
|
|
235
|
+
* @param {ListWorkflowsOrderDirectionEnum} [orderDirection]
|
|
206
236
|
* @param {*} [options] Override http request option.
|
|
207
237
|
* @throws {RequiredError}
|
|
208
238
|
*/
|
|
209
|
-
listWorkflows(startingAfter?: string, endingBefore?: string, limit?: number, expand?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
239
|
+
listWorkflows(startingAfter?: string, endingBefore?: string, limit?: number, expand?: Array<string>, userKey?: string, isTemplate?: boolean, on?: boolean, orderBy?: string, orderDirection?: ListWorkflowsOrderDirectionEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListWorkflows200Response>>;
|
|
210
240
|
/**
|
|
211
241
|
*
|
|
212
242
|
* @summary Publish workflow
|
|
@@ -215,7 +245,7 @@ export declare const WorkflowsApiFp: (configuration?: Configuration) => {
|
|
|
215
245
|
* @param {*} [options] Override http request option.
|
|
216
246
|
* @throws {RequiredError}
|
|
217
247
|
*/
|
|
218
|
-
publishWorkflow(id: string, publishWorkflowRequest?: PublishWorkflowRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
248
|
+
publishWorkflow(id: string, publishWorkflowRequest?: PublishWorkflowRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateWorkflow201Response>>;
|
|
219
249
|
/**
|
|
220
250
|
*
|
|
221
251
|
* @summary Retrieve workflow
|
|
@@ -226,7 +256,7 @@ export declare const WorkflowsApiFp: (configuration?: Configuration) => {
|
|
|
226
256
|
* @param {*} [options] Override http request option.
|
|
227
257
|
* @throws {RequiredError}
|
|
228
258
|
*/
|
|
229
|
-
retrieveWorkflow(id: string, idType?: string, userKey?: string, expand?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
259
|
+
retrieveWorkflow(id: string, idType?: string, userKey?: string, expand?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateWorkflow201Response>>;
|
|
230
260
|
/**
|
|
231
261
|
*
|
|
232
262
|
* @summary Trigger workflow
|
|
@@ -250,6 +280,15 @@ export declare const WorkflowsApiFp: (configuration?: Configuration) => {
|
|
|
250
280
|
* @export
|
|
251
281
|
*/
|
|
252
282
|
export declare const WorkflowsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
283
|
+
/**
|
|
284
|
+
*
|
|
285
|
+
* @summary Catch hook
|
|
286
|
+
* @param {string} hookId The trigger\'s hook id used for third party webhooks
|
|
287
|
+
* @param {CatchHookRequest} [catchHookRequest]
|
|
288
|
+
* @param {*} [options] Override http request option.
|
|
289
|
+
* @throws {RequiredError}
|
|
290
|
+
*/
|
|
291
|
+
catchHook(hookId: string, catchHookRequest?: CatchHookRequest, options?: any): AxiosPromise<object>;
|
|
253
292
|
/**
|
|
254
293
|
*
|
|
255
294
|
* @summary Clone workflow
|
|
@@ -258,7 +297,7 @@ export declare const WorkflowsApiFactory: (configuration?: Configuration, basePa
|
|
|
258
297
|
* @param {*} [options] Override http request option.
|
|
259
298
|
* @throws {RequiredError}
|
|
260
299
|
*/
|
|
261
|
-
cloneWorkflow(id: string, discardWorkflowDraftRequest?: DiscardWorkflowDraftRequest, options?: any): AxiosPromise<
|
|
300
|
+
cloneWorkflow(id: string, discardWorkflowDraftRequest?: DiscardWorkflowDraftRequest, options?: any): AxiosPromise<ListWorkflows200ResponseCollectionInner>;
|
|
262
301
|
/**
|
|
263
302
|
*
|
|
264
303
|
* @summary Create workflow
|
|
@@ -266,7 +305,7 @@ export declare const WorkflowsApiFactory: (configuration?: Configuration, basePa
|
|
|
266
305
|
* @param {*} [options] Override http request option.
|
|
267
306
|
* @throws {RequiredError}
|
|
268
307
|
*/
|
|
269
|
-
createWorkflow(createWorkflowRequest?: CreateWorkflowRequest, options?: any): AxiosPromise<
|
|
308
|
+
createWorkflow(createWorkflowRequest?: CreateWorkflowRequest, options?: any): AxiosPromise<CreateWorkflow201Response>;
|
|
270
309
|
/**
|
|
271
310
|
*
|
|
272
311
|
* @summary Delete workflow
|
|
@@ -285,7 +324,7 @@ export declare const WorkflowsApiFactory: (configuration?: Configuration, basePa
|
|
|
285
324
|
* @param {*} [options] Override http request option.
|
|
286
325
|
* @throws {RequiredError}
|
|
287
326
|
*/
|
|
288
|
-
discardWorkflowDraft(id: string, discardWorkflowDraftRequest?: DiscardWorkflowDraftRequest, options?: any): AxiosPromise<
|
|
327
|
+
discardWorkflowDraft(id: string, discardWorkflowDraftRequest?: DiscardWorkflowDraftRequest, options?: any): AxiosPromise<CreateWorkflow201Response>;
|
|
289
328
|
/**
|
|
290
329
|
*
|
|
291
330
|
* @summary Execute workflow
|
|
@@ -314,10 +353,15 @@ export declare const WorkflowsApiFactory: (configuration?: Configuration, basePa
|
|
|
314
353
|
* @param {string} [endingBefore] Cursor for pagination - return results before this ID
|
|
315
354
|
* @param {number} [limit] Number of items to return (max 100)
|
|
316
355
|
* @param {Array<string>} [expand] Expand related objects
|
|
356
|
+
* @param {string} [userKey] Unique user identifier
|
|
357
|
+
* @param {boolean} [isTemplate] Filter workflows by is_template value
|
|
358
|
+
* @param {boolean} [on] Filter workflows by on value
|
|
359
|
+
* @param {string} [orderBy] Field to order results by
|
|
360
|
+
* @param {ListWorkflowsOrderDirectionEnum} [orderDirection]
|
|
317
361
|
* @param {*} [options] Override http request option.
|
|
318
362
|
* @throws {RequiredError}
|
|
319
363
|
*/
|
|
320
|
-
listWorkflows(startingAfter?: string, endingBefore?: string, limit?: number, expand?: Array<string>, options?: any): AxiosPromise<
|
|
364
|
+
listWorkflows(startingAfter?: string, endingBefore?: string, limit?: number, expand?: Array<string>, userKey?: string, isTemplate?: boolean, on?: boolean, orderBy?: string, orderDirection?: ListWorkflowsOrderDirectionEnum, options?: any): AxiosPromise<ListWorkflows200Response>;
|
|
321
365
|
/**
|
|
322
366
|
*
|
|
323
367
|
* @summary Publish workflow
|
|
@@ -326,7 +370,7 @@ export declare const WorkflowsApiFactory: (configuration?: Configuration, basePa
|
|
|
326
370
|
* @param {*} [options] Override http request option.
|
|
327
371
|
* @throws {RequiredError}
|
|
328
372
|
*/
|
|
329
|
-
publishWorkflow(id: string, publishWorkflowRequest?: PublishWorkflowRequest, options?: any): AxiosPromise<
|
|
373
|
+
publishWorkflow(id: string, publishWorkflowRequest?: PublishWorkflowRequest, options?: any): AxiosPromise<CreateWorkflow201Response>;
|
|
330
374
|
/**
|
|
331
375
|
*
|
|
332
376
|
* @summary Retrieve workflow
|
|
@@ -337,7 +381,7 @@ export declare const WorkflowsApiFactory: (configuration?: Configuration, basePa
|
|
|
337
381
|
* @param {*} [options] Override http request option.
|
|
338
382
|
* @throws {RequiredError}
|
|
339
383
|
*/
|
|
340
|
-
retrieveWorkflow(id: string, idType?: string, userKey?: string, expand?: Array<string>, options?: any): AxiosPromise<
|
|
384
|
+
retrieveWorkflow(id: string, idType?: string, userKey?: string, expand?: Array<string>, options?: any): AxiosPromise<CreateWorkflow201Response>;
|
|
341
385
|
/**
|
|
342
386
|
*
|
|
343
387
|
* @summary Trigger workflow
|
|
@@ -362,6 +406,16 @@ export declare const WorkflowsApiFactory: (configuration?: Configuration, basePa
|
|
|
362
406
|
* @interface WorkflowsApi
|
|
363
407
|
*/
|
|
364
408
|
export interface WorkflowsApiInterface {
|
|
409
|
+
/**
|
|
410
|
+
*
|
|
411
|
+
* @summary Catch hook
|
|
412
|
+
* @param {string} hookId The trigger\'s hook id used for third party webhooks
|
|
413
|
+
* @param {CatchHookRequest} [catchHookRequest]
|
|
414
|
+
* @param {*} [options] Override http request option.
|
|
415
|
+
* @throws {RequiredError}
|
|
416
|
+
* @memberof WorkflowsApiInterface
|
|
417
|
+
*/
|
|
418
|
+
catchHook(hookId: string, catchHookRequest?: CatchHookRequest, options?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
365
419
|
/**
|
|
366
420
|
*
|
|
367
421
|
* @summary Clone workflow
|
|
@@ -371,7 +425,7 @@ export interface WorkflowsApiInterface {
|
|
|
371
425
|
* @throws {RequiredError}
|
|
372
426
|
* @memberof WorkflowsApiInterface
|
|
373
427
|
*/
|
|
374
|
-
cloneWorkflow(id: string, discardWorkflowDraftRequest?: DiscardWorkflowDraftRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
428
|
+
cloneWorkflow(id: string, discardWorkflowDraftRequest?: DiscardWorkflowDraftRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListWorkflows200ResponseCollectionInner>;
|
|
375
429
|
/**
|
|
376
430
|
*
|
|
377
431
|
* @summary Create workflow
|
|
@@ -380,7 +434,7 @@ export interface WorkflowsApiInterface {
|
|
|
380
434
|
* @throws {RequiredError}
|
|
381
435
|
* @memberof WorkflowsApiInterface
|
|
382
436
|
*/
|
|
383
|
-
createWorkflow(createWorkflowRequest?: CreateWorkflowRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
437
|
+
createWorkflow(createWorkflowRequest?: CreateWorkflowRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateWorkflow201Response>;
|
|
384
438
|
/**
|
|
385
439
|
*
|
|
386
440
|
* @summary Delete workflow
|
|
@@ -401,7 +455,7 @@ export interface WorkflowsApiInterface {
|
|
|
401
455
|
* @throws {RequiredError}
|
|
402
456
|
* @memberof WorkflowsApiInterface
|
|
403
457
|
*/
|
|
404
|
-
discardWorkflowDraft(id: string, discardWorkflowDraftRequest?: DiscardWorkflowDraftRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
458
|
+
discardWorkflowDraft(id: string, discardWorkflowDraftRequest?: DiscardWorkflowDraftRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateWorkflow201Response>;
|
|
405
459
|
/**
|
|
406
460
|
*
|
|
407
461
|
* @summary Execute workflow
|
|
@@ -432,11 +486,16 @@ export interface WorkflowsApiInterface {
|
|
|
432
486
|
* @param {string} [endingBefore] Cursor for pagination - return results before this ID
|
|
433
487
|
* @param {number} [limit] Number of items to return (max 100)
|
|
434
488
|
* @param {Array<string>} [expand] Expand related objects
|
|
489
|
+
* @param {string} [userKey] Unique user identifier
|
|
490
|
+
* @param {boolean} [isTemplate] Filter workflows by is_template value
|
|
491
|
+
* @param {boolean} [on] Filter workflows by on value
|
|
492
|
+
* @param {string} [orderBy] Field to order results by
|
|
493
|
+
* @param {ListWorkflowsOrderDirectionEnum} [orderDirection]
|
|
435
494
|
* @param {*} [options] Override http request option.
|
|
436
495
|
* @throws {RequiredError}
|
|
437
496
|
* @memberof WorkflowsApiInterface
|
|
438
497
|
*/
|
|
439
|
-
listWorkflows(startingAfter?: string, endingBefore?: string, limit?: number, expand?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
498
|
+
listWorkflows(startingAfter?: string, endingBefore?: string, limit?: number, expand?: Array<string>, userKey?: string, isTemplate?: boolean, on?: boolean, orderBy?: string, orderDirection?: ListWorkflowsOrderDirectionEnum, options?: RawAxiosRequestConfig): AxiosPromise<ListWorkflows200Response>;
|
|
440
499
|
/**
|
|
441
500
|
*
|
|
442
501
|
* @summary Publish workflow
|
|
@@ -446,7 +505,7 @@ export interface WorkflowsApiInterface {
|
|
|
446
505
|
* @throws {RequiredError}
|
|
447
506
|
* @memberof WorkflowsApiInterface
|
|
448
507
|
*/
|
|
449
|
-
publishWorkflow(id: string, publishWorkflowRequest?: PublishWorkflowRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
508
|
+
publishWorkflow(id: string, publishWorkflowRequest?: PublishWorkflowRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateWorkflow201Response>;
|
|
450
509
|
/**
|
|
451
510
|
*
|
|
452
511
|
* @summary Retrieve workflow
|
|
@@ -458,7 +517,7 @@ export interface WorkflowsApiInterface {
|
|
|
458
517
|
* @throws {RequiredError}
|
|
459
518
|
* @memberof WorkflowsApiInterface
|
|
460
519
|
*/
|
|
461
|
-
retrieveWorkflow(id: string, idType?: string, userKey?: string, expand?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
520
|
+
retrieveWorkflow(id: string, idType?: string, userKey?: string, expand?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<CreateWorkflow201Response>;
|
|
462
521
|
/**
|
|
463
522
|
*
|
|
464
523
|
* @summary Trigger workflow
|
|
@@ -486,6 +545,16 @@ export interface WorkflowsApiInterface {
|
|
|
486
545
|
* @extends {BaseAPI}
|
|
487
546
|
*/
|
|
488
547
|
export declare class WorkflowsApi extends BaseAPI implements WorkflowsApiInterface {
|
|
548
|
+
/**
|
|
549
|
+
*
|
|
550
|
+
* @summary Catch hook
|
|
551
|
+
* @param {string} hookId The trigger\'s hook id used for third party webhooks
|
|
552
|
+
* @param {CatchHookRequest} [catchHookRequest]
|
|
553
|
+
* @param {*} [options] Override http request option.
|
|
554
|
+
* @throws {RequiredError}
|
|
555
|
+
* @memberof WorkflowsApi
|
|
556
|
+
*/
|
|
557
|
+
catchHook(hookId: string, catchHookRequest?: CatchHookRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
|
|
489
558
|
/**
|
|
490
559
|
*
|
|
491
560
|
* @summary Clone workflow
|
|
@@ -495,7 +564,7 @@ export declare class WorkflowsApi extends BaseAPI implements WorkflowsApiInterfa
|
|
|
495
564
|
* @throws {RequiredError}
|
|
496
565
|
* @memberof WorkflowsApi
|
|
497
566
|
*/
|
|
498
|
-
cloneWorkflow(id: string, discardWorkflowDraftRequest?: DiscardWorkflowDraftRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
567
|
+
cloneWorkflow(id: string, discardWorkflowDraftRequest?: DiscardWorkflowDraftRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListWorkflows200ResponseCollectionInner, any, {}>>;
|
|
499
568
|
/**
|
|
500
569
|
*
|
|
501
570
|
* @summary Create workflow
|
|
@@ -504,7 +573,7 @@ export declare class WorkflowsApi extends BaseAPI implements WorkflowsApiInterfa
|
|
|
504
573
|
* @throws {RequiredError}
|
|
505
574
|
* @memberof WorkflowsApi
|
|
506
575
|
*/
|
|
507
|
-
createWorkflow(createWorkflowRequest?: CreateWorkflowRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
576
|
+
createWorkflow(createWorkflowRequest?: CreateWorkflowRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateWorkflow201Response, any, {}>>;
|
|
508
577
|
/**
|
|
509
578
|
*
|
|
510
579
|
* @summary Delete workflow
|
|
@@ -515,7 +584,7 @@ export declare class WorkflowsApi extends BaseAPI implements WorkflowsApiInterfa
|
|
|
515
584
|
* @throws {RequiredError}
|
|
516
585
|
* @memberof WorkflowsApi
|
|
517
586
|
*/
|
|
518
|
-
deleteWorkflow(id: string, idType?: string, userKey?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteWorkflow200Response, any>>;
|
|
587
|
+
deleteWorkflow(id: string, idType?: string, userKey?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteWorkflow200Response, any, {}>>;
|
|
519
588
|
/**
|
|
520
589
|
*
|
|
521
590
|
* @summary Discard workflow draft
|
|
@@ -525,7 +594,7 @@ export declare class WorkflowsApi extends BaseAPI implements WorkflowsApiInterfa
|
|
|
525
594
|
* @throws {RequiredError}
|
|
526
595
|
* @memberof WorkflowsApi
|
|
527
596
|
*/
|
|
528
|
-
discardWorkflowDraft(id: string, discardWorkflowDraftRequest?: DiscardWorkflowDraftRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
597
|
+
discardWorkflowDraft(id: string, discardWorkflowDraftRequest?: DiscardWorkflowDraftRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateWorkflow201Response, any, {}>>;
|
|
529
598
|
/**
|
|
530
599
|
*
|
|
531
600
|
* @summary Execute workflow
|
|
@@ -535,7 +604,7 @@ export declare class WorkflowsApi extends BaseAPI implements WorkflowsApiInterfa
|
|
|
535
604
|
* @throws {RequiredError}
|
|
536
605
|
* @memberof WorkflowsApi
|
|
537
606
|
*/
|
|
538
|
-
executeWorkflow(id: string, executeWorkflowRequest?: ExecuteWorkflowRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ExecuteWorkflow201Response, any>>;
|
|
607
|
+
executeWorkflow(id: string, executeWorkflowRequest?: ExecuteWorkflowRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ExecuteWorkflow201Response, any, {}>>;
|
|
539
608
|
/**
|
|
540
609
|
*
|
|
541
610
|
* @summary List workflow versions
|
|
@@ -548,7 +617,7 @@ export declare class WorkflowsApi extends BaseAPI implements WorkflowsApiInterfa
|
|
|
548
617
|
* @throws {RequiredError}
|
|
549
618
|
* @memberof WorkflowsApi
|
|
550
619
|
*/
|
|
551
|
-
listWorkflowVersions(workflowId: string, startingAfter?: string, endingBefore?: string, limit?: number, userKey?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListWorkflowVersions200Response, any>>;
|
|
620
|
+
listWorkflowVersions(workflowId: string, startingAfter?: string, endingBefore?: string, limit?: number, userKey?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListWorkflowVersions200Response, any, {}>>;
|
|
552
621
|
/**
|
|
553
622
|
*
|
|
554
623
|
* @summary List workflows
|
|
@@ -556,11 +625,16 @@ export declare class WorkflowsApi extends BaseAPI implements WorkflowsApiInterfa
|
|
|
556
625
|
* @param {string} [endingBefore] Cursor for pagination - return results before this ID
|
|
557
626
|
* @param {number} [limit] Number of items to return (max 100)
|
|
558
627
|
* @param {Array<string>} [expand] Expand related objects
|
|
628
|
+
* @param {string} [userKey] Unique user identifier
|
|
629
|
+
* @param {boolean} [isTemplate] Filter workflows by is_template value
|
|
630
|
+
* @param {boolean} [on] Filter workflows by on value
|
|
631
|
+
* @param {string} [orderBy] Field to order results by
|
|
632
|
+
* @param {ListWorkflowsOrderDirectionEnum} [orderDirection]
|
|
559
633
|
* @param {*} [options] Override http request option.
|
|
560
634
|
* @throws {RequiredError}
|
|
561
635
|
* @memberof WorkflowsApi
|
|
562
636
|
*/
|
|
563
|
-
listWorkflows(startingAfter?: string, endingBefore?: string, limit?: number, expand?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
637
|
+
listWorkflows(startingAfter?: string, endingBefore?: string, limit?: number, expand?: Array<string>, userKey?: string, isTemplate?: boolean, on?: boolean, orderBy?: string, orderDirection?: ListWorkflowsOrderDirectionEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListWorkflows200Response, any, {}>>;
|
|
564
638
|
/**
|
|
565
639
|
*
|
|
566
640
|
* @summary Publish workflow
|
|
@@ -570,7 +644,7 @@ export declare class WorkflowsApi extends BaseAPI implements WorkflowsApiInterfa
|
|
|
570
644
|
* @throws {RequiredError}
|
|
571
645
|
* @memberof WorkflowsApi
|
|
572
646
|
*/
|
|
573
|
-
publishWorkflow(id: string, publishWorkflowRequest?: PublishWorkflowRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
647
|
+
publishWorkflow(id: string, publishWorkflowRequest?: PublishWorkflowRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateWorkflow201Response, any, {}>>;
|
|
574
648
|
/**
|
|
575
649
|
*
|
|
576
650
|
* @summary Retrieve workflow
|
|
@@ -582,7 +656,7 @@ export declare class WorkflowsApi extends BaseAPI implements WorkflowsApiInterfa
|
|
|
582
656
|
* @throws {RequiredError}
|
|
583
657
|
* @memberof WorkflowsApi
|
|
584
658
|
*/
|
|
585
|
-
retrieveWorkflow(id: string, idType?: string, userKey?: string, expand?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
659
|
+
retrieveWorkflow(id: string, idType?: string, userKey?: string, expand?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateWorkflow201Response, any, {}>>;
|
|
586
660
|
/**
|
|
587
661
|
*
|
|
588
662
|
* @summary Trigger workflow
|
|
@@ -591,7 +665,7 @@ export declare class WorkflowsApi extends BaseAPI implements WorkflowsApiInterfa
|
|
|
591
665
|
* @throws {RequiredError}
|
|
592
666
|
* @memberof WorkflowsApi
|
|
593
667
|
*/
|
|
594
|
-
triggerWorkflow(triggerWorkflowRequest?: TriggerWorkflowRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
668
|
+
triggerWorkflow(triggerWorkflowRequest?: TriggerWorkflowRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
|
|
595
669
|
/**
|
|
596
670
|
*
|
|
597
671
|
* @summary Update workflow
|
|
@@ -601,5 +675,13 @@ export declare class WorkflowsApi extends BaseAPI implements WorkflowsApiInterfa
|
|
|
601
675
|
* @throws {RequiredError}
|
|
602
676
|
* @memberof WorkflowsApi
|
|
603
677
|
*/
|
|
604
|
-
updateWorkflow(id: string, updateWorkflowRequest?: UpdateWorkflowRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
678
|
+
updateWorkflow(id: string, updateWorkflowRequest?: UpdateWorkflowRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
605
679
|
}
|
|
680
|
+
/**
|
|
681
|
+
* @export
|
|
682
|
+
*/
|
|
683
|
+
export declare const ListWorkflowsOrderDirectionEnum: {
|
|
684
|
+
readonly Asc: "asc";
|
|
685
|
+
readonly Desc: "desc";
|
|
686
|
+
};
|
|
687
|
+
export type ListWorkflowsOrderDirectionEnum = typeof ListWorkflowsOrderDirectionEnum[keyof typeof ListWorkflowsOrderDirectionEnum];
|
|
@@ -32,6 +32,41 @@ import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
|
|
|
32
32
|
*/
|
|
33
33
|
export const WorkflowsApiAxiosParamCreator = function (configuration) {
|
|
34
34
|
return {
|
|
35
|
+
/**
|
|
36
|
+
*
|
|
37
|
+
* @summary Catch hook
|
|
38
|
+
* @param {string} hookId The trigger\'s hook id used for third party webhooks
|
|
39
|
+
* @param {CatchHookRequest} [catchHookRequest]
|
|
40
|
+
* @param {*} [options] Override http request option.
|
|
41
|
+
* @throws {RequiredError}
|
|
42
|
+
*/
|
|
43
|
+
catchHook: (hookId, catchHookRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
44
|
+
// verify required parameter 'hookId' is not null or undefined
|
|
45
|
+
assertParamExists('catchHook', 'hookId', hookId);
|
|
46
|
+
const localVarPath = `/api/v1/hooks/{hook_id}/catch`
|
|
47
|
+
.replace(`{${"hook_id"}}`, encodeURIComponent(String(hookId)));
|
|
48
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
49
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
50
|
+
let baseOptions;
|
|
51
|
+
if (configuration) {
|
|
52
|
+
baseOptions = configuration.baseOptions;
|
|
53
|
+
}
|
|
54
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
55
|
+
const localVarHeaderParameter = {};
|
|
56
|
+
const localVarQueryParameter = {};
|
|
57
|
+
// authentication bearer required
|
|
58
|
+
// http bearer authentication required
|
|
59
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
60
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
61
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
62
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
63
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
64
|
+
localVarRequestOptions.data = serializeDataIfNeeded(catchHookRequest, localVarRequestOptions, configuration);
|
|
65
|
+
return {
|
|
66
|
+
url: toPathString(localVarUrlObj),
|
|
67
|
+
options: localVarRequestOptions,
|
|
68
|
+
};
|
|
69
|
+
}),
|
|
35
70
|
/**
|
|
36
71
|
*
|
|
37
72
|
* @summary Clone workflow
|
|
@@ -263,10 +298,15 @@ export const WorkflowsApiAxiosParamCreator = function (configuration) {
|
|
|
263
298
|
* @param {string} [endingBefore] Cursor for pagination - return results before this ID
|
|
264
299
|
* @param {number} [limit] Number of items to return (max 100)
|
|
265
300
|
* @param {Array<string>} [expand] Expand related objects
|
|
301
|
+
* @param {string} [userKey] Unique user identifier
|
|
302
|
+
* @param {boolean} [isTemplate] Filter workflows by is_template value
|
|
303
|
+
* @param {boolean} [on] Filter workflows by on value
|
|
304
|
+
* @param {string} [orderBy] Field to order results by
|
|
305
|
+
* @param {ListWorkflowsOrderDirectionEnum} [orderDirection]
|
|
266
306
|
* @param {*} [options] Override http request option.
|
|
267
307
|
* @throws {RequiredError}
|
|
268
308
|
*/
|
|
269
|
-
listWorkflows: (startingAfter, endingBefore, limit, expand, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
309
|
+
listWorkflows: (startingAfter, endingBefore, limit, expand, userKey, isTemplate, on, orderBy, orderDirection, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
270
310
|
const localVarPath = `/api/v1/workflows`;
|
|
271
311
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
272
312
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -292,6 +332,21 @@ export const WorkflowsApiAxiosParamCreator = function (configuration) {
|
|
|
292
332
|
if (expand) {
|
|
293
333
|
localVarQueryParameter['expand'] = expand;
|
|
294
334
|
}
|
|
335
|
+
if (userKey !== undefined) {
|
|
336
|
+
localVarQueryParameter['user_key'] = userKey;
|
|
337
|
+
}
|
|
338
|
+
if (isTemplate !== undefined) {
|
|
339
|
+
localVarQueryParameter['is_template'] = isTemplate;
|
|
340
|
+
}
|
|
341
|
+
if (on !== undefined) {
|
|
342
|
+
localVarQueryParameter['on'] = on;
|
|
343
|
+
}
|
|
344
|
+
if (orderBy !== undefined) {
|
|
345
|
+
localVarQueryParameter['order_by'] = orderBy;
|
|
346
|
+
}
|
|
347
|
+
if (orderDirection !== undefined) {
|
|
348
|
+
localVarQueryParameter['order_direction'] = orderDirection;
|
|
349
|
+
}
|
|
295
350
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
296
351
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
297
352
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -454,6 +509,23 @@ export const WorkflowsApiAxiosParamCreator = function (configuration) {
|
|
|
454
509
|
export const WorkflowsApiFp = function (configuration) {
|
|
455
510
|
const localVarAxiosParamCreator = WorkflowsApiAxiosParamCreator(configuration);
|
|
456
511
|
return {
|
|
512
|
+
/**
|
|
513
|
+
*
|
|
514
|
+
* @summary Catch hook
|
|
515
|
+
* @param {string} hookId The trigger\'s hook id used for third party webhooks
|
|
516
|
+
* @param {CatchHookRequest} [catchHookRequest]
|
|
517
|
+
* @param {*} [options] Override http request option.
|
|
518
|
+
* @throws {RequiredError}
|
|
519
|
+
*/
|
|
520
|
+
catchHook(hookId, catchHookRequest, options) {
|
|
521
|
+
var _a, _b, _c;
|
|
522
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
523
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.catchHook(hookId, catchHookRequest, options);
|
|
524
|
+
const index = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
525
|
+
const operationBasePath = (_c = (_b = operationServerMap['WorkflowsApi.catchHook']) === null || _b === void 0 ? void 0 : _b[index]) === null || _c === void 0 ? void 0 : _c.url;
|
|
526
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
|
|
527
|
+
});
|
|
528
|
+
},
|
|
457
529
|
/**
|
|
458
530
|
*
|
|
459
531
|
* @summary Clone workflow
|
|
@@ -566,13 +638,18 @@ export const WorkflowsApiFp = function (configuration) {
|
|
|
566
638
|
* @param {string} [endingBefore] Cursor for pagination - return results before this ID
|
|
567
639
|
* @param {number} [limit] Number of items to return (max 100)
|
|
568
640
|
* @param {Array<string>} [expand] Expand related objects
|
|
641
|
+
* @param {string} [userKey] Unique user identifier
|
|
642
|
+
* @param {boolean} [isTemplate] Filter workflows by is_template value
|
|
643
|
+
* @param {boolean} [on] Filter workflows by on value
|
|
644
|
+
* @param {string} [orderBy] Field to order results by
|
|
645
|
+
* @param {ListWorkflowsOrderDirectionEnum} [orderDirection]
|
|
569
646
|
* @param {*} [options] Override http request option.
|
|
570
647
|
* @throws {RequiredError}
|
|
571
648
|
*/
|
|
572
|
-
listWorkflows(startingAfter, endingBefore, limit, expand, options) {
|
|
649
|
+
listWorkflows(startingAfter, endingBefore, limit, expand, userKey, isTemplate, on, orderBy, orderDirection, options) {
|
|
573
650
|
var _a, _b, _c;
|
|
574
651
|
return __awaiter(this, void 0, void 0, function* () {
|
|
575
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.listWorkflows(startingAfter, endingBefore, limit, expand, options);
|
|
652
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listWorkflows(startingAfter, endingBefore, limit, expand, userKey, isTemplate, on, orderBy, orderDirection, options);
|
|
576
653
|
const index = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
577
654
|
const operationBasePath = (_c = (_b = operationServerMap['WorkflowsApi.listWorkflows']) === null || _b === void 0 ? void 0 : _b[index]) === null || _c === void 0 ? void 0 : _c.url;
|
|
578
655
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath);
|
|
@@ -656,6 +733,17 @@ export const WorkflowsApiFp = function (configuration) {
|
|
|
656
733
|
export const WorkflowsApiFactory = function (configuration, basePath, axios) {
|
|
657
734
|
const localVarFp = WorkflowsApiFp(configuration);
|
|
658
735
|
return {
|
|
736
|
+
/**
|
|
737
|
+
*
|
|
738
|
+
* @summary Catch hook
|
|
739
|
+
* @param {string} hookId The trigger\'s hook id used for third party webhooks
|
|
740
|
+
* @param {CatchHookRequest} [catchHookRequest]
|
|
741
|
+
* @param {*} [options] Override http request option.
|
|
742
|
+
* @throws {RequiredError}
|
|
743
|
+
*/
|
|
744
|
+
catchHook(hookId, catchHookRequest, options) {
|
|
745
|
+
return localVarFp.catchHook(hookId, catchHookRequest, options).then((request) => request(axios, basePath));
|
|
746
|
+
},
|
|
659
747
|
/**
|
|
660
748
|
*
|
|
661
749
|
* @summary Clone workflow
|
|
@@ -732,11 +820,16 @@ export const WorkflowsApiFactory = function (configuration, basePath, axios) {
|
|
|
732
820
|
* @param {string} [endingBefore] Cursor for pagination - return results before this ID
|
|
733
821
|
* @param {number} [limit] Number of items to return (max 100)
|
|
734
822
|
* @param {Array<string>} [expand] Expand related objects
|
|
823
|
+
* @param {string} [userKey] Unique user identifier
|
|
824
|
+
* @param {boolean} [isTemplate] Filter workflows by is_template value
|
|
825
|
+
* @param {boolean} [on] Filter workflows by on value
|
|
826
|
+
* @param {string} [orderBy] Field to order results by
|
|
827
|
+
* @param {ListWorkflowsOrderDirectionEnum} [orderDirection]
|
|
735
828
|
* @param {*} [options] Override http request option.
|
|
736
829
|
* @throws {RequiredError}
|
|
737
830
|
*/
|
|
738
|
-
listWorkflows(startingAfter, endingBefore, limit, expand, options) {
|
|
739
|
-
return localVarFp.listWorkflows(startingAfter, endingBefore, limit, expand, options).then((request) => request(axios, basePath));
|
|
831
|
+
listWorkflows(startingAfter, endingBefore, limit, expand, userKey, isTemplate, on, orderBy, orderDirection, options) {
|
|
832
|
+
return localVarFp.listWorkflows(startingAfter, endingBefore, limit, expand, userKey, isTemplate, on, orderBy, orderDirection, options).then((request) => request(axios, basePath));
|
|
740
833
|
},
|
|
741
834
|
/**
|
|
742
835
|
*
|
|
@@ -792,6 +885,18 @@ export const WorkflowsApiFactory = function (configuration, basePath, axios) {
|
|
|
792
885
|
* @extends {BaseAPI}
|
|
793
886
|
*/
|
|
794
887
|
export class WorkflowsApi extends BaseAPI {
|
|
888
|
+
/**
|
|
889
|
+
*
|
|
890
|
+
* @summary Catch hook
|
|
891
|
+
* @param {string} hookId The trigger\'s hook id used for third party webhooks
|
|
892
|
+
* @param {CatchHookRequest} [catchHookRequest]
|
|
893
|
+
* @param {*} [options] Override http request option.
|
|
894
|
+
* @throws {RequiredError}
|
|
895
|
+
* @memberof WorkflowsApi
|
|
896
|
+
*/
|
|
897
|
+
catchHook(hookId, catchHookRequest, options) {
|
|
898
|
+
return WorkflowsApiFp(this.configuration).catchHook(hookId, catchHookRequest, options).then((request) => request(this.axios, this.basePath));
|
|
899
|
+
}
|
|
795
900
|
/**
|
|
796
901
|
*
|
|
797
902
|
* @summary Clone workflow
|
|
@@ -874,12 +979,17 @@ export class WorkflowsApi extends BaseAPI {
|
|
|
874
979
|
* @param {string} [endingBefore] Cursor for pagination - return results before this ID
|
|
875
980
|
* @param {number} [limit] Number of items to return (max 100)
|
|
876
981
|
* @param {Array<string>} [expand] Expand related objects
|
|
982
|
+
* @param {string} [userKey] Unique user identifier
|
|
983
|
+
* @param {boolean} [isTemplate] Filter workflows by is_template value
|
|
984
|
+
* @param {boolean} [on] Filter workflows by on value
|
|
985
|
+
* @param {string} [orderBy] Field to order results by
|
|
986
|
+
* @param {ListWorkflowsOrderDirectionEnum} [orderDirection]
|
|
877
987
|
* @param {*} [options] Override http request option.
|
|
878
988
|
* @throws {RequiredError}
|
|
879
989
|
* @memberof WorkflowsApi
|
|
880
990
|
*/
|
|
881
|
-
listWorkflows(startingAfter, endingBefore, limit, expand, options) {
|
|
882
|
-
return WorkflowsApiFp(this.configuration).listWorkflows(startingAfter, endingBefore, limit, expand, options).then((request) => request(this.axios, this.basePath));
|
|
991
|
+
listWorkflows(startingAfter, endingBefore, limit, expand, userKey, isTemplate, on, orderBy, orderDirection, options) {
|
|
992
|
+
return WorkflowsApiFp(this.configuration).listWorkflows(startingAfter, endingBefore, limit, expand, userKey, isTemplate, on, orderBy, orderDirection, options).then((request) => request(this.axios, this.basePath));
|
|
883
993
|
}
|
|
884
994
|
/**
|
|
885
995
|
*
|
|
@@ -931,3 +1041,10 @@ export class WorkflowsApi extends BaseAPI {
|
|
|
931
1041
|
return WorkflowsApiFp(this.configuration).updateWorkflow(id, updateWorkflowRequest, options).then((request) => request(this.axios, this.basePath));
|
|
932
1042
|
}
|
|
933
1043
|
}
|
|
1044
|
+
/**
|
|
1045
|
+
* @export
|
|
1046
|
+
*/
|
|
1047
|
+
export const ListWorkflowsOrderDirectionEnum = {
|
|
1048
|
+
Asc: 'asc',
|
|
1049
|
+
Desc: 'desc'
|
|
1050
|
+
};
|
package/dist/esm/common.d.ts
CHANGED
|
@@ -62,4 +62,4 @@ export declare const toPathString: (url: URL) => string;
|
|
|
62
62
|
*
|
|
63
63
|
* @export
|
|
64
64
|
*/
|
|
65
|
-
export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T, any>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
|
|
65
|
+
export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T, any, {}>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* API V1
|
|
3
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: v1
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface CatchHookRequest
|
|
16
|
+
*/
|
|
17
|
+
export interface CatchHookRequest {
|
|
18
|
+
[key: string]: any;
|
|
19
|
+
/**
|
|
20
|
+
* User\'s key
|
|
21
|
+
* @type {string}
|
|
22
|
+
* @memberof CatchHookRequest
|
|
23
|
+
*/
|
|
24
|
+
'user_key': string;
|
|
25
|
+
}
|