@emilgroup/action-sdk-node 1.0.1-beta.23 → 1.0.1-beta.31

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.
@@ -11,14 +11,18 @@ configuration.ts
11
11
  git_push.sh
12
12
  index.ts
13
13
  models/action-class.ts
14
+ models/action-execution-class.ts
14
15
  models/create-action-request-dto.ts
15
16
  models/create-action-response-class.ts
17
+ models/get-action-execution-status-response-class.ts
16
18
  models/get-action-response-class.ts
17
19
  models/index.ts
18
20
  models/inline-response200.ts
19
21
  models/inline-response503.ts
22
+ models/list-action-executions-response-class.ts
20
23
  models/list-actions-response-class.ts
21
24
  models/update-action-request-dto.ts
22
25
  models/update-action-response-class.ts
26
+ models/workflow-output-reference-class.ts
23
27
  package.json
24
28
  tsconfig.json
package/README.md CHANGED
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
17
17
  Navigate to the folder of your consuming project and run one of the following commands:
18
18
 
19
19
  ```
20
- npm install @emilgroup/action-sdk-node@1.0.1-beta.23 --save
20
+ npm install @emilgroup/action-sdk-node@1.0.1-beta.31 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/action-sdk-node@1.0.1-beta.23
24
+ yarn add @emilgroup/action-sdk-node@1.0.1-beta.31
25
25
  ```
26
26
 
27
27
  And then you can import `ActionsApi`.
@@ -25,8 +25,12 @@ import { CreateActionRequestDto } from '../models';
25
25
  // @ts-ignore
26
26
  import { CreateActionResponseClass } from '../models';
27
27
  // @ts-ignore
28
+ import { GetActionExecutionStatusResponseClass } from '../models';
29
+ // @ts-ignore
28
30
  import { GetActionResponseClass } from '../models';
29
31
  // @ts-ignore
32
+ import { ListActionExecutionsResponseClass } from '../models';
33
+ // @ts-ignore
30
34
  import { ListActionsResponseClass } from '../models';
31
35
  // @ts-ignore
32
36
  import { UpdateActionRequestDto } from '../models';
@@ -170,6 +174,133 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
170
174
 
171
175
 
172
176
 
177
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
178
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
179
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
180
+
181
+ return {
182
+ url: toPathString(localVarUrlObj),
183
+ options: localVarRequestOptions,
184
+ };
185
+ },
186
+ /**
187
+ * Retrieves the latest action execution status by executionCode or correlationId
188
+ * @summary Retrieve the actionExecution
189
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
190
+ * @param {string} [executionCode] Action execution code
191
+ * @param {string} [correlationId] Correlation ID (e.g. webhook execution code that triggered this action execution)
192
+ * @param {*} [options] Override http request option.
193
+ * @throws {RequiredError}
194
+ */
195
+ getActionExecutionStatus: async (authorization?: string, executionCode?: string, correlationId?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
196
+ const localVarPath = `/actionservice/v1/actions/executions/status`;
197
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
198
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
199
+ let baseOptions;
200
+ let baseAccessToken;
201
+ if (configuration) {
202
+ baseOptions = configuration.baseOptions;
203
+ baseAccessToken = configuration.accessToken;
204
+ }
205
+
206
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
207
+ const localVarHeaderParameter = {} as any;
208
+ const localVarQueryParameter = {} as any;
209
+
210
+ // authentication bearer required
211
+ // http bearer authentication required
212
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
213
+
214
+ if (executionCode !== undefined) {
215
+ localVarQueryParameter['executionCode'] = executionCode;
216
+ }
217
+
218
+ if (correlationId !== undefined) {
219
+ localVarQueryParameter['correlationId'] = correlationId;
220
+ }
221
+
222
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
223
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
224
+ }
225
+
226
+
227
+
228
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
229
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
230
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
231
+
232
+ return {
233
+ url: toPathString(localVarUrlObj),
234
+ options: localVarRequestOptions,
235
+ };
236
+ },
237
+ /**
238
+ * Lists action executions (latest status per execution only) with optional filters
239
+ * @summary List actionExecutions
240
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
241
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
242
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
243
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
244
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
245
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt&lt;/i&gt;
246
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
247
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
248
+ * @param {*} [options] Override http request option.
249
+ * @throws {RequiredError}
250
+ */
251
+ listActionExecutions: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
252
+ const localVarPath = `/actionservice/v1/actions/executions`;
253
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
254
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
255
+ let baseOptions;
256
+ let baseAccessToken;
257
+ if (configuration) {
258
+ baseOptions = configuration.baseOptions;
259
+ baseAccessToken = configuration.accessToken;
260
+ }
261
+
262
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
263
+ const localVarHeaderParameter = {} as any;
264
+ const localVarQueryParameter = {} as any;
265
+
266
+ // authentication bearer required
267
+ // http bearer authentication required
268
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
269
+
270
+ if (pageSize !== undefined) {
271
+ localVarQueryParameter['pageSize'] = pageSize;
272
+ }
273
+
274
+ if (pageToken !== undefined) {
275
+ localVarQueryParameter['pageToken'] = pageToken;
276
+ }
277
+
278
+ if (filter !== undefined) {
279
+ localVarQueryParameter['filter'] = filter;
280
+ }
281
+
282
+ if (search !== undefined) {
283
+ localVarQueryParameter['search'] = search;
284
+ }
285
+
286
+ if (order !== undefined) {
287
+ localVarQueryParameter['order'] = order;
288
+ }
289
+
290
+ if (expand !== undefined) {
291
+ localVarQueryParameter['expand'] = expand;
292
+ }
293
+
294
+ if (filters !== undefined) {
295
+ localVarQueryParameter['filters'] = filters;
296
+ }
297
+
298
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
299
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
300
+ }
301
+
302
+
303
+
173
304
  setSearchParams(localVarUrlObj, localVarQueryParameter);
174
305
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
175
306
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -352,6 +483,37 @@ export const ActionsApiFp = function(configuration?: Configuration) {
352
483
  const localVarAxiosArgs = await localVarAxiosParamCreator.getAction(code, authorization, options);
353
484
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
354
485
  },
486
+ /**
487
+ * Retrieves the latest action execution status by executionCode or correlationId
488
+ * @summary Retrieve the actionExecution
489
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
490
+ * @param {string} [executionCode] Action execution code
491
+ * @param {string} [correlationId] Correlation ID (e.g. webhook execution code that triggered this action execution)
492
+ * @param {*} [options] Override http request option.
493
+ * @throws {RequiredError}
494
+ */
495
+ async getActionExecutionStatus(authorization?: string, executionCode?: string, correlationId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetActionExecutionStatusResponseClass>> {
496
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getActionExecutionStatus(authorization, executionCode, correlationId, options);
497
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
498
+ },
499
+ /**
500
+ * Lists action executions (latest status per execution only) with optional filters
501
+ * @summary List actionExecutions
502
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
503
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
504
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
505
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
506
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
507
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt&lt;/i&gt;
508
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
509
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
510
+ * @param {*} [options] Override http request option.
511
+ * @throws {RequiredError}
512
+ */
513
+ async listActionExecutions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListActionExecutionsResponseClass>> {
514
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listActionExecutions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
515
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
516
+ },
355
517
  /**
356
518
  * Lists all action configurations with optional filters
357
519
  * @summary List actions
@@ -426,6 +588,35 @@ export const ActionsApiFactory = function (configuration?: Configuration, basePa
426
588
  getAction(code: string, authorization?: string, options?: any): AxiosPromise<GetActionResponseClass> {
427
589
  return localVarFp.getAction(code, authorization, options).then((request) => request(axios, basePath));
428
590
  },
591
+ /**
592
+ * Retrieves the latest action execution status by executionCode or correlationId
593
+ * @summary Retrieve the actionExecution
594
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
595
+ * @param {string} [executionCode] Action execution code
596
+ * @param {string} [correlationId] Correlation ID (e.g. webhook execution code that triggered this action execution)
597
+ * @param {*} [options] Override http request option.
598
+ * @throws {RequiredError}
599
+ */
600
+ getActionExecutionStatus(authorization?: string, executionCode?: string, correlationId?: string, options?: any): AxiosPromise<GetActionExecutionStatusResponseClass> {
601
+ return localVarFp.getActionExecutionStatus(authorization, executionCode, correlationId, options).then((request) => request(axios, basePath));
602
+ },
603
+ /**
604
+ * Lists action executions (latest status per execution only) with optional filters
605
+ * @summary List actionExecutions
606
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
607
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
608
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
609
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
610
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
611
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt&lt;/i&gt;
612
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
613
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
614
+ * @param {*} [options] Override http request option.
615
+ * @throws {RequiredError}
616
+ */
617
+ listActionExecutions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListActionExecutionsResponseClass> {
618
+ return localVarFp.listActionExecutions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
619
+ },
429
620
  /**
430
621
  * Lists all action configurations with optional filters
431
622
  * @summary List actions
@@ -521,6 +712,97 @@ export interface ActionsApiGetActionRequest {
521
712
  readonly authorization?: string
522
713
  }
523
714
 
715
+ /**
716
+ * Request parameters for getActionExecutionStatus operation in ActionsApi.
717
+ * @export
718
+ * @interface ActionsApiGetActionExecutionStatusRequest
719
+ */
720
+ export interface ActionsApiGetActionExecutionStatusRequest {
721
+ /**
722
+ * Bearer Token: provided by the login endpoint under the name accessToken.
723
+ * @type {string}
724
+ * @memberof ActionsApiGetActionExecutionStatus
725
+ */
726
+ readonly authorization?: string
727
+
728
+ /**
729
+ * Action execution code
730
+ * @type {string}
731
+ * @memberof ActionsApiGetActionExecutionStatus
732
+ */
733
+ readonly executionCode?: string
734
+
735
+ /**
736
+ * Correlation ID (e.g. webhook execution code that triggered this action execution)
737
+ * @type {string}
738
+ * @memberof ActionsApiGetActionExecutionStatus
739
+ */
740
+ readonly correlationId?: string
741
+ }
742
+
743
+ /**
744
+ * Request parameters for listActionExecutions operation in ActionsApi.
745
+ * @export
746
+ * @interface ActionsApiListActionExecutionsRequest
747
+ */
748
+ export interface ActionsApiListActionExecutionsRequest {
749
+ /**
750
+ * Bearer Token: provided by the login endpoint under the name accessToken.
751
+ * @type {string}
752
+ * @memberof ActionsApiListActionExecutions
753
+ */
754
+ readonly authorization?: string
755
+
756
+ /**
757
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
758
+ * @type {number}
759
+ * @memberof ActionsApiListActionExecutions
760
+ */
761
+ readonly pageSize?: number
762
+
763
+ /**
764
+ * A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
765
+ * @type {string}
766
+ * @memberof ActionsApiListActionExecutions
767
+ */
768
+ readonly pageToken?: string
769
+
770
+ /**
771
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
772
+ * @type {string}
773
+ * @memberof ActionsApiListActionExecutions
774
+ */
775
+ readonly filter?: string
776
+
777
+ /**
778
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
779
+ * @type {string}
780
+ * @memberof ActionsApiListActionExecutions
781
+ */
782
+ readonly search?: string
783
+
784
+ /**
785
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt&lt;/i&gt;
786
+ * @type {string}
787
+ * @memberof ActionsApiListActionExecutions
788
+ */
789
+ readonly order?: string
790
+
791
+ /**
792
+ * Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
793
+ * @type {string}
794
+ * @memberof ActionsApiListActionExecutions
795
+ */
796
+ readonly expand?: string
797
+
798
+ /**
799
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
800
+ * @type {string}
801
+ * @memberof ActionsApiListActionExecutions
802
+ */
803
+ readonly filters?: string
804
+ }
805
+
524
806
  /**
525
807
  * Request parameters for listActions operation in ActionsApi.
526
808
  * @export
@@ -655,6 +937,30 @@ export class ActionsApi extends BaseAPI {
655
937
  return ActionsApiFp(this.configuration).getAction(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
656
938
  }
657
939
 
940
+ /**
941
+ * Retrieves the latest action execution status by executionCode or correlationId
942
+ * @summary Retrieve the actionExecution
943
+ * @param {ActionsApiGetActionExecutionStatusRequest} requestParameters Request parameters.
944
+ * @param {*} [options] Override http request option.
945
+ * @throws {RequiredError}
946
+ * @memberof ActionsApi
947
+ */
948
+ public getActionExecutionStatus(requestParameters: ActionsApiGetActionExecutionStatusRequest = {}, options?: AxiosRequestConfig) {
949
+ return ActionsApiFp(this.configuration).getActionExecutionStatus(requestParameters.authorization, requestParameters.executionCode, requestParameters.correlationId, options).then((request) => request(this.axios, this.basePath));
950
+ }
951
+
952
+ /**
953
+ * Lists action executions (latest status per execution only) with optional filters
954
+ * @summary List actionExecutions
955
+ * @param {ActionsApiListActionExecutionsRequest} requestParameters Request parameters.
956
+ * @param {*} [options] Override http request option.
957
+ * @throws {RequiredError}
958
+ * @memberof ActionsApi
959
+ */
960
+ public listActionExecutions(requestParameters: ActionsApiListActionExecutionsRequest = {}, options?: AxiosRequestConfig) {
961
+ return ActionsApiFp(this.configuration).listActionExecutions(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
962
+ }
963
+
658
964
  /**
659
965
  * Lists all action configurations with optional filters
660
966
  * @summary List actions
@@ -14,7 +14,9 @@ import { Configuration } from '../configuration';
14
14
  import { RequestArgs, BaseAPI } from '../base';
15
15
  import { CreateActionRequestDto } from '../models';
16
16
  import { CreateActionResponseClass } from '../models';
17
+ import { GetActionExecutionStatusResponseClass } from '../models';
17
18
  import { GetActionResponseClass } from '../models';
19
+ import { ListActionExecutionsResponseClass } from '../models';
18
20
  import { ListActionsResponseClass } from '../models';
19
21
  import { UpdateActionRequestDto } from '../models';
20
22
  import { UpdateActionResponseClass } from '../models';
@@ -50,6 +52,31 @@ export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration
50
52
  * @throws {RequiredError}
51
53
  */
52
54
  getAction: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
55
+ /**
56
+ * Retrieves the latest action execution status by executionCode or correlationId
57
+ * @summary Retrieve the actionExecution
58
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
59
+ * @param {string} [executionCode] Action execution code
60
+ * @param {string} [correlationId] Correlation ID (e.g. webhook execution code that triggered this action execution)
61
+ * @param {*} [options] Override http request option.
62
+ * @throws {RequiredError}
63
+ */
64
+ getActionExecutionStatus: (authorization?: string, executionCode?: string, correlationId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
65
+ /**
66
+ * Lists action executions (latest status per execution only) with optional filters
67
+ * @summary List actionExecutions
68
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
69
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
70
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
71
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
72
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
73
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt&lt;/i&gt;
74
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
75
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
76
+ * @param {*} [options] Override http request option.
77
+ * @throws {RequiredError}
78
+ */
79
+ listActionExecutions: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
53
80
  /**
54
81
  * Lists all action configurations with optional filters
55
82
  * @summary List actions
@@ -108,6 +135,31 @@ export declare const ActionsApiFp: (configuration?: Configuration) => {
108
135
  * @throws {RequiredError}
109
136
  */
110
137
  getAction(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetActionResponseClass>>;
138
+ /**
139
+ * Retrieves the latest action execution status by executionCode or correlationId
140
+ * @summary Retrieve the actionExecution
141
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
142
+ * @param {string} [executionCode] Action execution code
143
+ * @param {string} [correlationId] Correlation ID (e.g. webhook execution code that triggered this action execution)
144
+ * @param {*} [options] Override http request option.
145
+ * @throws {RequiredError}
146
+ */
147
+ getActionExecutionStatus(authorization?: string, executionCode?: string, correlationId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetActionExecutionStatusResponseClass>>;
148
+ /**
149
+ * Lists action executions (latest status per execution only) with optional filters
150
+ * @summary List actionExecutions
151
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
152
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
153
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
154
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
155
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
156
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt&lt;/i&gt;
157
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
158
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
159
+ * @param {*} [options] Override http request option.
160
+ * @throws {RequiredError}
161
+ */
162
+ listActionExecutions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListActionExecutionsResponseClass>>;
111
163
  /**
112
164
  * Lists all action configurations with optional filters
113
165
  * @summary List actions
@@ -166,6 +218,31 @@ export declare const ActionsApiFactory: (configuration?: Configuration, basePath
166
218
  * @throws {RequiredError}
167
219
  */
168
220
  getAction(code: string, authorization?: string, options?: any): AxiosPromise<GetActionResponseClass>;
221
+ /**
222
+ * Retrieves the latest action execution status by executionCode or correlationId
223
+ * @summary Retrieve the actionExecution
224
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
225
+ * @param {string} [executionCode] Action execution code
226
+ * @param {string} [correlationId] Correlation ID (e.g. webhook execution code that triggered this action execution)
227
+ * @param {*} [options] Override http request option.
228
+ * @throws {RequiredError}
229
+ */
230
+ getActionExecutionStatus(authorization?: string, executionCode?: string, correlationId?: string, options?: any): AxiosPromise<GetActionExecutionStatusResponseClass>;
231
+ /**
232
+ * Lists action executions (latest status per execution only) with optional filters
233
+ * @summary List actionExecutions
234
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
235
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
236
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
237
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
238
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
239
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt&lt;/i&gt;
240
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
241
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
242
+ * @param {*} [options] Override http request option.
243
+ * @throws {RequiredError}
244
+ */
245
+ listActionExecutions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListActionExecutionsResponseClass>;
169
246
  /**
170
247
  * Lists all action configurations with optional filters
171
248
  * @summary List actions
@@ -249,6 +326,86 @@ export interface ActionsApiGetActionRequest {
249
326
  */
250
327
  readonly authorization?: string;
251
328
  }
329
+ /**
330
+ * Request parameters for getActionExecutionStatus operation in ActionsApi.
331
+ * @export
332
+ * @interface ActionsApiGetActionExecutionStatusRequest
333
+ */
334
+ export interface ActionsApiGetActionExecutionStatusRequest {
335
+ /**
336
+ * Bearer Token: provided by the login endpoint under the name accessToken.
337
+ * @type {string}
338
+ * @memberof ActionsApiGetActionExecutionStatus
339
+ */
340
+ readonly authorization?: string;
341
+ /**
342
+ * Action execution code
343
+ * @type {string}
344
+ * @memberof ActionsApiGetActionExecutionStatus
345
+ */
346
+ readonly executionCode?: string;
347
+ /**
348
+ * Correlation ID (e.g. webhook execution code that triggered this action execution)
349
+ * @type {string}
350
+ * @memberof ActionsApiGetActionExecutionStatus
351
+ */
352
+ readonly correlationId?: string;
353
+ }
354
+ /**
355
+ * Request parameters for listActionExecutions operation in ActionsApi.
356
+ * @export
357
+ * @interface ActionsApiListActionExecutionsRequest
358
+ */
359
+ export interface ActionsApiListActionExecutionsRequest {
360
+ /**
361
+ * Bearer Token: provided by the login endpoint under the name accessToken.
362
+ * @type {string}
363
+ * @memberof ActionsApiListActionExecutions
364
+ */
365
+ readonly authorization?: string;
366
+ /**
367
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
368
+ * @type {number}
369
+ * @memberof ActionsApiListActionExecutions
370
+ */
371
+ readonly pageSize?: number;
372
+ /**
373
+ * A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
374
+ * @type {string}
375
+ * @memberof ActionsApiListActionExecutions
376
+ */
377
+ readonly pageToken?: string;
378
+ /**
379
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
380
+ * @type {string}
381
+ * @memberof ActionsApiListActionExecutions
382
+ */
383
+ readonly filter?: string;
384
+ /**
385
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
386
+ * @type {string}
387
+ * @memberof ActionsApiListActionExecutions
388
+ */
389
+ readonly search?: string;
390
+ /**
391
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt&lt;/i&gt;
392
+ * @type {string}
393
+ * @memberof ActionsApiListActionExecutions
394
+ */
395
+ readonly order?: string;
396
+ /**
397
+ * Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
398
+ * @type {string}
399
+ * @memberof ActionsApiListActionExecutions
400
+ */
401
+ readonly expand?: string;
402
+ /**
403
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
404
+ * @type {string}
405
+ * @memberof ActionsApiListActionExecutions
406
+ */
407
+ readonly filters?: string;
408
+ }
252
409
  /**
253
410
  * Request parameters for listActions operation in ActionsApi.
254
411
  * @export
@@ -363,6 +520,24 @@ export declare class ActionsApi extends BaseAPI {
363
520
  * @memberof ActionsApi
364
521
  */
365
522
  getAction(requestParameters: ActionsApiGetActionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetActionResponseClass, any, {}>>;
523
+ /**
524
+ * Retrieves the latest action execution status by executionCode or correlationId
525
+ * @summary Retrieve the actionExecution
526
+ * @param {ActionsApiGetActionExecutionStatusRequest} requestParameters Request parameters.
527
+ * @param {*} [options] Override http request option.
528
+ * @throws {RequiredError}
529
+ * @memberof ActionsApi
530
+ */
531
+ getActionExecutionStatus(requestParameters?: ActionsApiGetActionExecutionStatusRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetActionExecutionStatusResponseClass, any, {}>>;
532
+ /**
533
+ * Lists action executions (latest status per execution only) with optional filters
534
+ * @summary List actionExecutions
535
+ * @param {ActionsApiListActionExecutionsRequest} requestParameters Request parameters.
536
+ * @param {*} [options] Override http request option.
537
+ * @throws {RequiredError}
538
+ * @memberof ActionsApi
539
+ */
540
+ listActionExecutions(requestParameters?: ActionsApiListActionExecutionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListActionExecutionsResponseClass, any, {}>>;
366
541
  /**
367
542
  * Lists all action configurations with optional filters
368
543
  * @summary List actions