@embedworkflow/sdk 1.0.0 → 1.2.0

package/dist/api/workflows-api.d.ts

@@ -12,15 +12,17 @@
 import type { Configuration } from '../configuration';
 import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
 import { RequestArgs, BaseAPI } from '../base';
-import { CloneWorkflow201Response } from '../models';
+import { CatchHookRequest } from '../models';
+import { CreateWorkflow201Response } from '../models';
 import { CreateWorkflowRequest } from '../models';
 import { DeleteWorkflow200Response } from '../models';
 import { DiscardWorkflowDraftRequest } from '../models';
 import { ExecuteWorkflow201Response } from '../models';
 import { ExecuteWorkflowRequest } from '../models';
 import { ListWorkflowVersions200Response } from '../models';
+import { ListWorkflows200Response } from '../models';
+import { ListWorkflows200ResponseCollectionInner } from '../models';
 import { PublishWorkflowRequest } from '../models';
-import { RetrieveWorkflow200Response } from '../models';
 import { TriggerWorkflowRequest } from '../models';
 import { UpdateWorkflowRequest } from '../models';
 /**
@@ -28,6 +30,15 @@ import { UpdateWorkflowRequest } from '../models';
  * @export
  */
 export declare const WorkflowsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Catch hook
+     * @param {string} hookId The trigger\'s hook id used for third party webhooks
+     * @param {CatchHookRequest} [catchHookRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    catchHook: (hookId: string, catchHookRequest?: CatchHookRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Clone workflow
@@ -92,10 +103,15 @@ export declare const WorkflowsApiAxiosParamCreator: (configuration?: Configurati
      * @param {string} [endingBefore] Cursor for pagination - return results before this ID
      * @param {number} [limit] Number of items to return (max 100)
      * @param {Array<string>} [expand] Expand related objects
+     * @param {string} [userKey] Unique user identifier
+     * @param {boolean} [isTemplate] Filter workflows by is_template value
+     * @param {boolean} [on] Filter workflows by on value
+     * @param {string} [orderBy] Field to order results by
+     * @param {ListWorkflowsOrderDirectionEnum} [orderDirection]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listWorkflows: (startingAfter?: string, endingBefore?: string, limit?: number, expand?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    listWorkflows: (startingAfter?: string, endingBefore?: string, limit?: number, expand?: Array<string>, userKey?: string, isTemplate?: boolean, on?: boolean, orderBy?: string, orderDirection?: ListWorkflowsOrderDirectionEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Publish workflow
@@ -139,6 +155,15 @@ export declare const WorkflowsApiAxiosParamCreator: (configuration?: Configurati
  * @export
  */
 export declare const WorkflowsApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Catch hook
+     * @param {string} hookId The trigger\&#39;s hook id used for third party webhooks
+     * @param {CatchHookRequest} [catchHookRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    catchHook(hookId: string, catchHookRequest?: CatchHookRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
     /**
      *
      * @summary Clone workflow
@@ -147,7 +172,7 @@ export declare const WorkflowsApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    cloneWorkflow(id: string, discardWorkflowDraftRequest?: DiscardWorkflowDraftRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CloneWorkflow201Response>>;
+    cloneWorkflow(id: string, discardWorkflowDraftRequest?: DiscardWorkflowDraftRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListWorkflows200ResponseCollectionInner>>;
     /**
      *
      * @summary Create workflow
@@ -155,7 +180,7 @@ export declare const WorkflowsApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createWorkflow(createWorkflowRequest?: CreateWorkflowRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    createWorkflow(createWorkflowRequest?: CreateWorkflowRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateWorkflow201Response>>;
     /**
      *
      * @summary Delete workflow
@@ -174,7 +199,7 @@ export declare const WorkflowsApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    discardWorkflowDraft(id: string, discardWorkflowDraftRequest?: DiscardWorkflowDraftRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RetrieveWorkflow200Response>>;
+    discardWorkflowDraft(id: string, discardWorkflowDraftRequest?: DiscardWorkflowDraftRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateWorkflow201Response>>;
     /**
      *
      * @summary Execute workflow
@@ -203,10 +228,15 @@ export declare const WorkflowsApiFp: (configuration?: Configuration) => {
      * @param {string} [endingBefore] Cursor for pagination - return results before this ID
      * @param {number} [limit] Number of items to return (max 100)
      * @param {Array<string>} [expand] Expand related objects
+     * @param {string} [userKey] Unique user identifier
+     * @param {boolean} [isTemplate] Filter workflows by is_template value
+     * @param {boolean} [on] Filter workflows by on value
+     * @param {string} [orderBy] Field to order results by
+     * @param {ListWorkflowsOrderDirectionEnum} [orderDirection]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listWorkflows(startingAfter?: string, endingBefore?: string, limit?: number, expand?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    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>>;
     /**
      *
      * @summary Publish workflow
@@ -215,7 +245,7 @@ export declare const WorkflowsApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    publishWorkflow(id: string, publishWorkflowRequest?: PublishWorkflowRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RetrieveWorkflow200Response>>;
+    publishWorkflow(id: string, publishWorkflowRequest?: PublishWorkflowRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateWorkflow201Response>>;
     /**
      *
      * @summary Retrieve workflow
@@ -226,7 +256,7 @@ export declare const WorkflowsApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    retrieveWorkflow(id: string, idType?: string, userKey?: string, expand?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RetrieveWorkflow200Response>>;
+    retrieveWorkflow(id: string, idType?: string, userKey?: string, expand?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateWorkflow201Response>>;
     /**
      *
      * @summary Trigger workflow
@@ -250,6 +280,15 @@ export declare const WorkflowsApiFp: (configuration?: Configuration) => {
  * @export
  */
 export declare const WorkflowsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Catch hook
+     * @param {string} hookId The trigger\&#39;s hook id used for third party webhooks
+     * @param {CatchHookRequest} [catchHookRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    catchHook(hookId: string, catchHookRequest?: CatchHookRequest, options?: any): AxiosPromise<object>;
     /**
      *
      * @summary Clone workflow
@@ -258,7 +297,7 @@ export declare const WorkflowsApiFactory: (configuration?: Configuration, basePa
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    cloneWorkflow(id: string, discardWorkflowDraftRequest?: DiscardWorkflowDraftRequest, options?: any): AxiosPromise<CloneWorkflow201Response>;
+    cloneWorkflow(id: string, discardWorkflowDraftRequest?: DiscardWorkflowDraftRequest, options?: any): AxiosPromise<ListWorkflows200ResponseCollectionInner>;
     /**
      *
      * @summary Create workflow
@@ -266,7 +305,7 @@ export declare const WorkflowsApiFactory: (configuration?: Configuration, basePa
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createWorkflow(createWorkflowRequest?: CreateWorkflowRequest, options?: any): AxiosPromise<void>;
+    createWorkflow(createWorkflowRequest?: CreateWorkflowRequest, options?: any): AxiosPromise<CreateWorkflow201Response>;
     /**
      *
      * @summary Delete workflow
@@ -285,7 +324,7 @@ export declare const WorkflowsApiFactory: (configuration?: Configuration, basePa
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    discardWorkflowDraft(id: string, discardWorkflowDraftRequest?: DiscardWorkflowDraftRequest, options?: any): AxiosPromise<RetrieveWorkflow200Response>;
+    discardWorkflowDraft(id: string, discardWorkflowDraftRequest?: DiscardWorkflowDraftRequest, options?: any): AxiosPromise<CreateWorkflow201Response>;
     /**
      *
      * @summary Execute workflow
@@ -314,10 +353,15 @@ export declare const WorkflowsApiFactory: (configuration?: Configuration, basePa
      * @param {string} [endingBefore] Cursor for pagination - return results before this ID
      * @param {number} [limit] Number of items to return (max 100)
      * @param {Array<string>} [expand] Expand related objects
+     * @param {string} [userKey] Unique user identifier
+     * @param {boolean} [isTemplate] Filter workflows by is_template value
+     * @param {boolean} [on] Filter workflows by on value
+     * @param {string} [orderBy] Field to order results by
+     * @param {ListWorkflowsOrderDirectionEnum} [orderDirection]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listWorkflows(startingAfter?: string, endingBefore?: string, limit?: number, expand?: Array<string>, options?: any): AxiosPromise<void>;
+    listWorkflows(startingAfter?: string, endingBefore?: string, limit?: number, expand?: Array<string>, userKey?: string, isTemplate?: boolean, on?: boolean, orderBy?: string, orderDirection?: ListWorkflowsOrderDirectionEnum, options?: any): AxiosPromise<ListWorkflows200Response>;
     /**
      *
      * @summary Publish workflow
@@ -326,7 +370,7 @@ export declare const WorkflowsApiFactory: (configuration?: Configuration, basePa
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    publishWorkflow(id: string, publishWorkflowRequest?: PublishWorkflowRequest, options?: any): AxiosPromise<RetrieveWorkflow200Response>;
+    publishWorkflow(id: string, publishWorkflowRequest?: PublishWorkflowRequest, options?: any): AxiosPromise<CreateWorkflow201Response>;
     /**
      *
      * @summary Retrieve workflow
@@ -337,7 +381,7 @@ export declare const WorkflowsApiFactory: (configuration?: Configuration, basePa
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    retrieveWorkflow(id: string, idType?: string, userKey?: string, expand?: Array<string>, options?: any): AxiosPromise<RetrieveWorkflow200Response>;
+    retrieveWorkflow(id: string, idType?: string, userKey?: string, expand?: Array<string>, options?: any): AxiosPromise<CreateWorkflow201Response>;
     /**
      *
      * @summary Trigger workflow
@@ -362,6 +406,16 @@ export declare const WorkflowsApiFactory: (configuration?: Configuration, basePa
  * @interface WorkflowsApi
  */
 export interface WorkflowsApiInterface {
+    /**
+     *
+     * @summary Catch hook
+     * @param {string} hookId The trigger\&#39;s hook id used for third party webhooks
+     * @param {CatchHookRequest} [catchHookRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowsApiInterface
+     */
+    catchHook(hookId: string, catchHookRequest?: CatchHookRequest, options?: RawAxiosRequestConfig): AxiosPromise<object>;
     /**
      *
      * @summary Clone workflow
@@ -371,7 +425,7 @@ export interface WorkflowsApiInterface {
      * @throws {RequiredError}
      * @memberof WorkflowsApiInterface
      */
-    cloneWorkflow(id: string, discardWorkflowDraftRequest?: DiscardWorkflowDraftRequest, options?: RawAxiosRequestConfig): AxiosPromise<CloneWorkflow201Response>;
+    cloneWorkflow(id: string, discardWorkflowDraftRequest?: DiscardWorkflowDraftRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListWorkflows200ResponseCollectionInner>;
     /**
      *
      * @summary Create workflow
@@ -380,7 +434,7 @@ export interface WorkflowsApiInterface {
      * @throws {RequiredError}
      * @memberof WorkflowsApiInterface
      */
-    createWorkflow(createWorkflowRequest?: CreateWorkflowRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    createWorkflow(createWorkflowRequest?: CreateWorkflowRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateWorkflow201Response>;
     /**
      *
      * @summary Delete workflow
@@ -401,7 +455,7 @@ export interface WorkflowsApiInterface {
      * @throws {RequiredError}
      * @memberof WorkflowsApiInterface
      */
-    discardWorkflowDraft(id: string, discardWorkflowDraftRequest?: DiscardWorkflowDraftRequest, options?: RawAxiosRequestConfig): AxiosPromise<RetrieveWorkflow200Response>;
+    discardWorkflowDraft(id: string, discardWorkflowDraftRequest?: DiscardWorkflowDraftRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateWorkflow201Response>;
     /**
      *
      * @summary Execute workflow
@@ -432,11 +486,16 @@ export interface WorkflowsApiInterface {
      * @param {string} [endingBefore] Cursor for pagination - return results before this ID
      * @param {number} [limit] Number of items to return (max 100)
      * @param {Array<string>} [expand] Expand related objects
+     * @param {string} [userKey] Unique user identifier
+     * @param {boolean} [isTemplate] Filter workflows by is_template value
+     * @param {boolean} [on] Filter workflows by on value
+     * @param {string} [orderBy] Field to order results by
+     * @param {ListWorkflowsOrderDirectionEnum} [orderDirection]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof WorkflowsApiInterface
      */
-    listWorkflows(startingAfter?: string, endingBefore?: string, limit?: number, expand?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    listWorkflows(startingAfter?: string, endingBefore?: string, limit?: number, expand?: Array<string>, userKey?: string, isTemplate?: boolean, on?: boolean, orderBy?: string, orderDirection?: ListWorkflowsOrderDirectionEnum, options?: RawAxiosRequestConfig): AxiosPromise<ListWorkflows200Response>;
     /**
      *
      * @summary Publish workflow
@@ -446,7 +505,7 @@ export interface WorkflowsApiInterface {
      * @throws {RequiredError}
      * @memberof WorkflowsApiInterface
      */
-    publishWorkflow(id: string, publishWorkflowRequest?: PublishWorkflowRequest, options?: RawAxiosRequestConfig): AxiosPromise<RetrieveWorkflow200Response>;
+    publishWorkflow(id: string, publishWorkflowRequest?: PublishWorkflowRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateWorkflow201Response>;
     /**
      *
      * @summary Retrieve workflow
@@ -458,7 +517,7 @@ export interface WorkflowsApiInterface {
      * @throws {RequiredError}
      * @memberof WorkflowsApiInterface
      */
-    retrieveWorkflow(id: string, idType?: string, userKey?: string, expand?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<RetrieveWorkflow200Response>;
+    retrieveWorkflow(id: string, idType?: string, userKey?: string, expand?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<CreateWorkflow201Response>;
     /**
      *
      * @summary Trigger workflow
@@ -486,6 +545,16 @@ export interface WorkflowsApiInterface {
  * @extends {BaseAPI}
  */
 export declare class WorkflowsApi extends BaseAPI implements WorkflowsApiInterface {
+    /**
+     *
+     * @summary Catch hook
+     * @param {string} hookId The trigger\&#39;s hook id used for third party webhooks
+     * @param {CatchHookRequest} [catchHookRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowsApi
+     */
+    catchHook(hookId: string, catchHookRequest?: CatchHookRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
     /**
      *
      * @summary Clone workflow
@@ -495,7 +564,7 @@ export declare class WorkflowsApi extends BaseAPI implements WorkflowsApiInterfa
      * @throws {RequiredError}
      * @memberof WorkflowsApi
      */
-    cloneWorkflow(id: string, discardWorkflowDraftRequest?: DiscardWorkflowDraftRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CloneWorkflow201Response, any>>;
+    cloneWorkflow(id: string, discardWorkflowDraftRequest?: DiscardWorkflowDraftRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListWorkflows200ResponseCollectionInner, any, {}>>;
     /**
      *
      * @summary Create workflow
@@ -504,7 +573,7 @@ export declare class WorkflowsApi extends BaseAPI implements WorkflowsApiInterfa
      * @throws {RequiredError}
      * @memberof WorkflowsApi
      */
-    createWorkflow(createWorkflowRequest?: CreateWorkflowRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    createWorkflow(createWorkflowRequest?: CreateWorkflowRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateWorkflow201Response, any, {}>>;
     /**
      *
      * @summary Delete workflow
@@ -515,7 +584,7 @@ export declare class WorkflowsApi extends BaseAPI implements WorkflowsApiInterfa
      * @throws {RequiredError}
      * @memberof WorkflowsApi
      */
-    deleteWorkflow(id: string, idType?: string, userKey?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteWorkflow200Response, any>>;
+    deleteWorkflow(id: string, idType?: string, userKey?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteWorkflow200Response, any, {}>>;
     /**
      *
      * @summary Discard workflow draft
@@ -525,7 +594,7 @@ export declare class WorkflowsApi extends BaseAPI implements WorkflowsApiInterfa
      * @throws {RequiredError}
      * @memberof WorkflowsApi
      */
-    discardWorkflowDraft(id: string, discardWorkflowDraftRequest?: DiscardWorkflowDraftRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RetrieveWorkflow200Response, any>>;
+    discardWorkflowDraft(id: string, discardWorkflowDraftRequest?: DiscardWorkflowDraftRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateWorkflow201Response, any, {}>>;
     /**
      *
      * @summary Execute workflow
@@ -535,7 +604,7 @@ export declare class WorkflowsApi extends BaseAPI implements WorkflowsApiInterfa
      * @throws {RequiredError}
      * @memberof WorkflowsApi
      */
-    executeWorkflow(id: string, executeWorkflowRequest?: ExecuteWorkflowRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ExecuteWorkflow201Response, any>>;
+    executeWorkflow(id: string, executeWorkflowRequest?: ExecuteWorkflowRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ExecuteWorkflow201Response, any, {}>>;
     /**
      *
      * @summary List workflow versions
@@ -548,7 +617,7 @@ export declare class WorkflowsApi extends BaseAPI implements WorkflowsApiInterfa
      * @throws {RequiredError}
      * @memberof WorkflowsApi
      */
-    listWorkflowVersions(workflowId: string, startingAfter?: string, endingBefore?: string, limit?: number, userKey?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListWorkflowVersions200Response, any>>;
+    listWorkflowVersions(workflowId: string, startingAfter?: string, endingBefore?: string, limit?: number, userKey?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListWorkflowVersions200Response, any, {}>>;
     /**
      *
      * @summary List workflows
@@ -556,11 +625,16 @@ export declare class WorkflowsApi extends BaseAPI implements WorkflowsApiInterfa
      * @param {string} [endingBefore] Cursor for pagination - return results before this ID
      * @param {number} [limit] Number of items to return (max 100)
      * @param {Array<string>} [expand] Expand related objects
+     * @param {string} [userKey] Unique user identifier
+     * @param {boolean} [isTemplate] Filter workflows by is_template value
+     * @param {boolean} [on] Filter workflows by on value
+     * @param {string} [orderBy] Field to order results by
+     * @param {ListWorkflowsOrderDirectionEnum} [orderDirection]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof WorkflowsApi
      */
-    listWorkflows(startingAfter?: string, endingBefore?: string, limit?: number, expand?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    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, {}>>;
     /**
      *
      * @summary Publish workflow
@@ -570,7 +644,7 @@ export declare class WorkflowsApi extends BaseAPI implements WorkflowsApiInterfa
      * @throws {RequiredError}
      * @memberof WorkflowsApi
      */
-    publishWorkflow(id: string, publishWorkflowRequest?: PublishWorkflowRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RetrieveWorkflow200Response, any>>;
+    publishWorkflow(id: string, publishWorkflowRequest?: PublishWorkflowRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateWorkflow201Response, any, {}>>;
     /**
      *
      * @summary Retrieve workflow
@@ -582,7 +656,7 @@ export declare class WorkflowsApi extends BaseAPI implements WorkflowsApiInterfa
      * @throws {RequiredError}
      * @memberof WorkflowsApi
      */
-    retrieveWorkflow(id: string, idType?: string, userKey?: string, expand?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RetrieveWorkflow200Response, any>>;
+    retrieveWorkflow(id: string, idType?: string, userKey?: string, expand?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateWorkflow201Response, any, {}>>;
     /**
      *
      * @summary Trigger workflow
@@ -591,7 +665,7 @@ export declare class WorkflowsApi extends BaseAPI implements WorkflowsApiInterfa
      * @throws {RequiredError}
      * @memberof WorkflowsApi
      */
-    triggerWorkflow(triggerWorkflowRequest?: TriggerWorkflowRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
+    triggerWorkflow(triggerWorkflowRequest?: TriggerWorkflowRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
     /**
      *
      * @summary Update workflow
@@ -601,5 +675,13 @@ export declare class WorkflowsApi extends BaseAPI implements WorkflowsApiInterfa
      * @throws {RequiredError}
      * @memberof WorkflowsApi
      */
-    updateWorkflow(id: string, updateWorkflowRequest?: UpdateWorkflowRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    updateWorkflow(id: string, updateWorkflowRequest?: UpdateWorkflowRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
 }
+/**
+ * @export
+ */
+export declare const ListWorkflowsOrderDirectionEnum: {
+    readonly Asc: "asc";
+    readonly Desc: "desc";
+};
+export type ListWorkflowsOrderDirectionEnum = typeof ListWorkflowsOrderDirectionEnum[keyof typeof ListWorkflowsOrderDirectionEnum];

package/dist/api/workflows-api.js

@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WorkflowsApi = exports.WorkflowsApiFactory = exports.WorkflowsApiFp = exports.WorkflowsApiAxiosParamCreator = void 0;
+exports.ListWorkflowsOrderDirectionEnum = exports.WorkflowsApi = exports.WorkflowsApiFactory = exports.WorkflowsApiFp = exports.WorkflowsApiAxiosParamCreator = void 0;
 const axios_1 = require("axios");
 // Some imports not used depending on template conditions
 // @ts-ignore
@@ -35,6 +35,41 @@ const base_1 = require("../base");
  */
 const WorkflowsApiAxiosParamCreator = function (configuration) {
     return {
+        /**
+         *
+         * @summary Catch hook
+         * @param {string} hookId The trigger\'s hook id used for third party webhooks
+         * @param {CatchHookRequest} [catchHookRequest]
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        catchHook: (hookId, catchHookRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'hookId' is not null or undefined
+            (0, common_1.assertParamExists)('catchHook', 'hookId', hookId);
+            const localVarPath = `/api/v1/hooks/{hook_id}/catch`
+                .replace(`{${"hook_id"}}`, encodeURIComponent(String(hookId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication bearer required
+            // http bearer authentication required
+            yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(catchHookRequest, localVarRequestOptions, configuration);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          *
          * @summary Clone workflow
@@ -266,10 +301,15 @@ const WorkflowsApiAxiosParamCreator = function (configuration) {
          * @param {string} [endingBefore] Cursor for pagination - return results before this ID
          * @param {number} [limit] Number of items to return (max 100)
          * @param {Array<string>} [expand] Expand related objects
+         * @param {string} [userKey] Unique user identifier
+         * @param {boolean} [isTemplate] Filter workflows by is_template value
+         * @param {boolean} [on] Filter workflows by on value
+         * @param {string} [orderBy] Field to order results by
+         * @param {ListWorkflowsOrderDirectionEnum} [orderDirection]
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listWorkflows: (startingAfter, endingBefore, limit, expand, options = {}) => __awaiter(this, void 0, void 0, function* () {
+        listWorkflows: (startingAfter, endingBefore, limit, expand, userKey, isTemplate, on, orderBy, orderDirection, options = {}) => __awaiter(this, void 0, void 0, function* () {
             const localVarPath = `/api/v1/workflows`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -295,6 +335,21 @@ const WorkflowsApiAxiosParamCreator = function (configuration) {
             if (expand) {
                 localVarQueryParameter['expand'] = expand;
             }
+            if (userKey !== undefined) {
+                localVarQueryParameter['user_key'] = userKey;
+            }
+            if (isTemplate !== undefined) {
+                localVarQueryParameter['is_template'] = isTemplate;
+            }
+            if (on !== undefined) {
+                localVarQueryParameter['on'] = on;
+            }
+            if (orderBy !== undefined) {
+                localVarQueryParameter['order_by'] = orderBy;
+            }
+            if (orderDirection !== undefined) {
+                localVarQueryParameter['order_direction'] = orderDirection;
+            }
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -458,6 +513,23 @@ exports.WorkflowsApiAxiosParamCreator = WorkflowsApiAxiosParamCreator;
 const WorkflowsApiFp = function (configuration) {
     const localVarAxiosParamCreator = (0, exports.WorkflowsApiAxiosParamCreator)(configuration);
     return {
+        /**
+         *
+         * @summary Catch hook
+         * @param {string} hookId The trigger\&#39;s hook id used for third party webhooks
+         * @param {CatchHookRequest} [catchHookRequest]
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        catchHook(hookId, catchHookRequest, options) {
+            var _a, _b, _c;
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.catchHook(hookId, catchHookRequest, options);
+                const index = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const operationBasePath = (_c = (_b = base_1.operationServerMap['WorkflowsApi.catchHook']) === null || _b === void 0 ? void 0 : _b[index]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, operationBasePath || basePath);
+            });
+        },
         /**
          *
          * @summary Clone workflow
@@ -570,13 +642,18 @@ const WorkflowsApiFp = function (configuration) {
          * @param {string} [endingBefore] Cursor for pagination - return results before this ID
          * @param {number} [limit] Number of items to return (max 100)
          * @param {Array<string>} [expand] Expand related objects
+         * @param {string} [userKey] Unique user identifier
+         * @param {boolean} [isTemplate] Filter workflows by is_template value
+         * @param {boolean} [on] Filter workflows by on value
+         * @param {string} [orderBy] Field to order results by
+         * @param {ListWorkflowsOrderDirectionEnum} [orderDirection]
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listWorkflows(startingAfter, endingBefore, limit, expand, options) {
+        listWorkflows(startingAfter, endingBefore, limit, expand, userKey, isTemplate, on, orderBy, orderDirection, options) {
             var _a, _b, _c;
             return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.listWorkflows(startingAfter, endingBefore, limit, expand, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.listWorkflows(startingAfter, endingBefore, limit, expand, userKey, isTemplate, on, orderBy, orderDirection, options);
                 const index = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
                 const operationBasePath = (_c = (_b = base_1.operationServerMap['WorkflowsApi.listWorkflows']) === null || _b === void 0 ? void 0 : _b[index]) === null || _c === void 0 ? void 0 : _c.url;
                 return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, operationBasePath || basePath);
@@ -661,6 +738,17 @@ exports.WorkflowsApiFp = WorkflowsApiFp;
 const WorkflowsApiFactory = function (configuration, basePath, axios) {
     const localVarFp = (0, exports.WorkflowsApiFp)(configuration);
     return {
+        /**
+         *
+         * @summary Catch hook
+         * @param {string} hookId The trigger\&#39;s hook id used for third party webhooks
+         * @param {CatchHookRequest} [catchHookRequest]
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        catchHook(hookId, catchHookRequest, options) {
+            return localVarFp.catchHook(hookId, catchHookRequest, options).then((request) => request(axios, basePath));
+        },
         /**
          *
          * @summary Clone workflow
@@ -737,11 +825,16 @@ const WorkflowsApiFactory = function (configuration, basePath, axios) {
          * @param {string} [endingBefore] Cursor for pagination - return results before this ID
          * @param {number} [limit] Number of items to return (max 100)
          * @param {Array<string>} [expand] Expand related objects
+         * @param {string} [userKey] Unique user identifier
+         * @param {boolean} [isTemplate] Filter workflows by is_template value
+         * @param {boolean} [on] Filter workflows by on value
+         * @param {string} [orderBy] Field to order results by
+         * @param {ListWorkflowsOrderDirectionEnum} [orderDirection]
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listWorkflows(startingAfter, endingBefore, limit, expand, options) {
-            return localVarFp.listWorkflows(startingAfter, endingBefore, limit, expand, options).then((request) => request(axios, basePath));
+        listWorkflows(startingAfter, endingBefore, limit, expand, userKey, isTemplate, on, orderBy, orderDirection, options) {
+            return localVarFp.listWorkflows(startingAfter, endingBefore, limit, expand, userKey, isTemplate, on, orderBy, orderDirection, options).then((request) => request(axios, basePath));
         },
         /**
          *
@@ -798,6 +891,18 @@ exports.WorkflowsApiFactory = WorkflowsApiFactory;
  * @extends {BaseAPI}
  */
 class WorkflowsApi extends base_1.BaseAPI {
+    /**
+     *
+     * @summary Catch hook
+     * @param {string} hookId The trigger\&#39;s hook id used for third party webhooks
+     * @param {CatchHookRequest} [catchHookRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof WorkflowsApi
+     */
+    catchHook(hookId, catchHookRequest, options) {
+        return (0, exports.WorkflowsApiFp)(this.configuration).catchHook(hookId, catchHookRequest, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      *
      * @summary Clone workflow
@@ -880,12 +985,17 @@ class WorkflowsApi extends base_1.BaseAPI {
      * @param {string} [endingBefore] Cursor for pagination - return results before this ID
      * @param {number} [limit] Number of items to return (max 100)
      * @param {Array<string>} [expand] Expand related objects
+     * @param {string} [userKey] Unique user identifier
+     * @param {boolean} [isTemplate] Filter workflows by is_template value
+     * @param {boolean} [on] Filter workflows by on value
+     * @param {string} [orderBy] Field to order results by
+     * @param {ListWorkflowsOrderDirectionEnum} [orderDirection]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof WorkflowsApi
      */
-    listWorkflows(startingAfter, endingBefore, limit, expand, options) {
-        return (0, exports.WorkflowsApiFp)(this.configuration).listWorkflows(startingAfter, endingBefore, limit, expand, options).then((request) => request(this.axios, this.basePath));
+    listWorkflows(startingAfter, endingBefore, limit, expand, userKey, isTemplate, on, orderBy, orderDirection, options) {
+        return (0, exports.WorkflowsApiFp)(this.configuration).listWorkflows(startingAfter, endingBefore, limit, expand, userKey, isTemplate, on, orderBy, orderDirection, options).then((request) => request(this.axios, this.basePath));
     }
     /**
      *
@@ -938,3 +1048,10 @@ class WorkflowsApi extends base_1.BaseAPI {
     }
 }
 exports.WorkflowsApi = WorkflowsApi;
+/**
+ * @export
+ */
+exports.ListWorkflowsOrderDirectionEnum = {
+    Asc: 'asc',
+    Desc: 'desc'
+};

package/dist/common.d.ts

@@ -62,4 +62,4 @@ export declare const toPathString: (url: URL) => string;
  *
  * @export
  */
-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>;
+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>;