@emilgroup/action-sdk 1.0.1-beta.23 → 1.1.1-beta.1

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@1.0.1-beta.23 --save
20
+ npm install @emilgroup/action-sdk@1.1.1-beta.1 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/action-sdk@1.0.1-beta.23
24
+ yarn add @emilgroup/action-sdk@1.1.1-beta.1
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';
@@ -166,6 +170,133 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
166
170
 
167
171
 
168
172
 
173
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
174
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
175
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
176
+
177
+ return {
178
+ url: toPathString(localVarUrlObj),
179
+ options: localVarRequestOptions,
180
+ };
181
+ },
182
+ /**
183
+ * Retrieves the latest action execution status by executionCode or correlationId
184
+ * @summary Retrieve the actionExecution
185
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
186
+ * @param {string} [executionCode] Action execution code
187
+ * @param {string} [correlationId] Correlation ID (e.g. webhook execution code that triggered this action execution)
188
+ * @param {*} [options] Override http request option.
189
+ * @throws {RequiredError}
190
+ */
191
+ getActionExecutionStatus: async (authorization?: string, executionCode?: string, correlationId?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
192
+ const localVarPath = `/actionservice/v1/actions/executions/status`;
193
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
194
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
195
+ let baseOptions;
196
+ let baseAccessToken;
197
+ if (configuration) {
198
+ baseOptions = configuration.baseOptions;
199
+ baseAccessToken = configuration.accessToken;
200
+ }
201
+
202
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
203
+ const localVarHeaderParameter = {} as any;
204
+ const localVarQueryParameter = {} as any;
205
+
206
+ // authentication bearer required
207
+ // http bearer authentication required
208
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
209
+
210
+ if (executionCode !== undefined) {
211
+ localVarQueryParameter['executionCode'] = executionCode;
212
+ }
213
+
214
+ if (correlationId !== undefined) {
215
+ localVarQueryParameter['correlationId'] = correlationId;
216
+ }
217
+
218
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
219
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
220
+ }
221
+
222
+
223
+
224
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
225
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
226
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
227
+
228
+ return {
229
+ url: toPathString(localVarUrlObj),
230
+ options: localVarRequestOptions,
231
+ };
232
+ },
233
+ /**
234
+ * Lists action executions with optional filters
235
+ * @summary List actionExecutions
236
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
237
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
238
+ * @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.
239
+ * @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;
240
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
241
+ * @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;
242
+ * @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;
243
+ * @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;
244
+ * @param {*} [options] Override http request option.
245
+ * @throws {RequiredError}
246
+ */
247
+ listActionExecutions: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
248
+ const localVarPath = `/actionservice/v1/actions/executions`;
249
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
250
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
251
+ let baseOptions;
252
+ let baseAccessToken;
253
+ if (configuration) {
254
+ baseOptions = configuration.baseOptions;
255
+ baseAccessToken = configuration.accessToken;
256
+ }
257
+
258
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
259
+ const localVarHeaderParameter = {} as any;
260
+ const localVarQueryParameter = {} as any;
261
+
262
+ // authentication bearer required
263
+ // http bearer authentication required
264
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
265
+
266
+ if (pageSize !== undefined) {
267
+ localVarQueryParameter['pageSize'] = pageSize;
268
+ }
269
+
270
+ if (pageToken !== undefined) {
271
+ localVarQueryParameter['pageToken'] = pageToken;
272
+ }
273
+
274
+ if (filter !== undefined) {
275
+ localVarQueryParameter['filter'] = filter;
276
+ }
277
+
278
+ if (search !== undefined) {
279
+ localVarQueryParameter['search'] = search;
280
+ }
281
+
282
+ if (order !== undefined) {
283
+ localVarQueryParameter['order'] = order;
284
+ }
285
+
286
+ if (expand !== undefined) {
287
+ localVarQueryParameter['expand'] = expand;
288
+ }
289
+
290
+ if (filters !== undefined) {
291
+ localVarQueryParameter['filters'] = filters;
292
+ }
293
+
294
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
295
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
296
+ }
297
+
298
+
299
+
169
300
  setSearchParams(localVarUrlObj, localVarQueryParameter);
170
301
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
171
302
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -348,6 +479,37 @@ export const ActionsApiFp = function(configuration?: Configuration) {
348
479
  const localVarAxiosArgs = await localVarAxiosParamCreator.getAction(code, authorization, options);
349
480
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
350
481
  },
482
+ /**
483
+ * Retrieves the latest action execution status by executionCode or correlationId
484
+ * @summary Retrieve the actionExecution
485
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
486
+ * @param {string} [executionCode] Action execution code
487
+ * @param {string} [correlationId] Correlation ID (e.g. webhook execution code that triggered this action execution)
488
+ * @param {*} [options] Override http request option.
489
+ * @throws {RequiredError}
490
+ */
491
+ async getActionExecutionStatus(authorization?: string, executionCode?: string, correlationId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetActionExecutionStatusResponseClass>> {
492
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getActionExecutionStatus(authorization, executionCode, correlationId, options);
493
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
494
+ },
495
+ /**
496
+ * Lists action executions with optional filters
497
+ * @summary List actionExecutions
498
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
499
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
500
+ * @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.
501
+ * @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;
502
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
503
+ * @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;
504
+ * @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;
505
+ * @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;
506
+ * @param {*} [options] Override http request option.
507
+ * @throws {RequiredError}
508
+ */
509
+ 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>> {
510
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listActionExecutions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
511
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
512
+ },
351
513
  /**
352
514
  * Lists all action configurations with optional filters
353
515
  * @summary List actions
@@ -422,6 +584,35 @@ export const ActionsApiFactory = function (configuration?: Configuration, basePa
422
584
  getAction(code: string, authorization?: string, options?: any): AxiosPromise<GetActionResponseClass> {
423
585
  return localVarFp.getAction(code, authorization, options).then((request) => request(axios, basePath));
424
586
  },
587
+ /**
588
+ * Retrieves the latest action execution status by executionCode or correlationId
589
+ * @summary Retrieve the actionExecution
590
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
591
+ * @param {string} [executionCode] Action execution code
592
+ * @param {string} [correlationId] Correlation ID (e.g. webhook execution code that triggered this action execution)
593
+ * @param {*} [options] Override http request option.
594
+ * @throws {RequiredError}
595
+ */
596
+ getActionExecutionStatus(authorization?: string, executionCode?: string, correlationId?: string, options?: any): AxiosPromise<GetActionExecutionStatusResponseClass> {
597
+ return localVarFp.getActionExecutionStatus(authorization, executionCode, correlationId, options).then((request) => request(axios, basePath));
598
+ },
599
+ /**
600
+ * Lists action executions with optional filters
601
+ * @summary List actionExecutions
602
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
603
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
604
+ * @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.
605
+ * @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;
606
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
607
+ * @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;
608
+ * @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;
609
+ * @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;
610
+ * @param {*} [options] Override http request option.
611
+ * @throws {RequiredError}
612
+ */
613
+ listActionExecutions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListActionExecutionsResponseClass> {
614
+ return localVarFp.listActionExecutions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
615
+ },
425
616
  /**
426
617
  * Lists all action configurations with optional filters
427
618
  * @summary List actions
@@ -517,6 +708,97 @@ export interface ActionsApiGetActionRequest {
517
708
  readonly authorization?: string
518
709
  }
519
710
 
711
+ /**
712
+ * Request parameters for getActionExecutionStatus operation in ActionsApi.
713
+ * @export
714
+ * @interface ActionsApiGetActionExecutionStatusRequest
715
+ */
716
+ export interface ActionsApiGetActionExecutionStatusRequest {
717
+ /**
718
+ * Bearer Token: provided by the login endpoint under the name accessToken.
719
+ * @type {string}
720
+ * @memberof ActionsApiGetActionExecutionStatus
721
+ */
722
+ readonly authorization?: string
723
+
724
+ /**
725
+ * Action execution code
726
+ * @type {string}
727
+ * @memberof ActionsApiGetActionExecutionStatus
728
+ */
729
+ readonly executionCode?: string
730
+
731
+ /**
732
+ * Correlation ID (e.g. webhook execution code that triggered this action execution)
733
+ * @type {string}
734
+ * @memberof ActionsApiGetActionExecutionStatus
735
+ */
736
+ readonly correlationId?: string
737
+ }
738
+
739
+ /**
740
+ * Request parameters for listActionExecutions operation in ActionsApi.
741
+ * @export
742
+ * @interface ActionsApiListActionExecutionsRequest
743
+ */
744
+ export interface ActionsApiListActionExecutionsRequest {
745
+ /**
746
+ * Bearer Token: provided by the login endpoint under the name accessToken.
747
+ * @type {string}
748
+ * @memberof ActionsApiListActionExecutions
749
+ */
750
+ readonly authorization?: string
751
+
752
+ /**
753
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
754
+ * @type {number}
755
+ * @memberof ActionsApiListActionExecutions
756
+ */
757
+ readonly pageSize?: number
758
+
759
+ /**
760
+ * 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.
761
+ * @type {string}
762
+ * @memberof ActionsApiListActionExecutions
763
+ */
764
+ readonly pageToken?: string
765
+
766
+ /**
767
+ * 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;
768
+ * @type {string}
769
+ * @memberof ActionsApiListActionExecutions
770
+ */
771
+ readonly filter?: string
772
+
773
+ /**
774
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
775
+ * @type {string}
776
+ * @memberof ActionsApiListActionExecutions
777
+ */
778
+ readonly search?: string
779
+
780
+ /**
781
+ * 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;
782
+ * @type {string}
783
+ * @memberof ActionsApiListActionExecutions
784
+ */
785
+ readonly order?: string
786
+
787
+ /**
788
+ * 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;
789
+ * @type {string}
790
+ * @memberof ActionsApiListActionExecutions
791
+ */
792
+ readonly expand?: string
793
+
794
+ /**
795
+ * 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;
796
+ * @type {string}
797
+ * @memberof ActionsApiListActionExecutions
798
+ */
799
+ readonly filters?: string
800
+ }
801
+
520
802
  /**
521
803
  * Request parameters for listActions operation in ActionsApi.
522
804
  * @export
@@ -651,6 +933,30 @@ export class ActionsApi extends BaseAPI {
651
933
  return ActionsApiFp(this.configuration).getAction(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
652
934
  }
653
935
 
936
+ /**
937
+ * Retrieves the latest action execution status by executionCode or correlationId
938
+ * @summary Retrieve the actionExecution
939
+ * @param {ActionsApiGetActionExecutionStatusRequest} requestParameters Request parameters.
940
+ * @param {*} [options] Override http request option.
941
+ * @throws {RequiredError}
942
+ * @memberof ActionsApi
943
+ */
944
+ public getActionExecutionStatus(requestParameters: ActionsApiGetActionExecutionStatusRequest = {}, options?: AxiosRequestConfig) {
945
+ return ActionsApiFp(this.configuration).getActionExecutionStatus(requestParameters.authorization, requestParameters.executionCode, requestParameters.correlationId, options).then((request) => request(this.axios, this.basePath));
946
+ }
947
+
948
+ /**
949
+ * Lists action executions with optional filters
950
+ * @summary List actionExecutions
951
+ * @param {ActionsApiListActionExecutionsRequest} requestParameters Request parameters.
952
+ * @param {*} [options] Override http request option.
953
+ * @throws {RequiredError}
954
+ * @memberof ActionsApi
955
+ */
956
+ public listActionExecutions(requestParameters: ActionsApiListActionExecutionsRequest = {}, options?: AxiosRequestConfig) {
957
+ 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));
958
+ }
959
+
654
960
  /**
655
961
  * Lists all action configurations with optional filters
656
962
  * @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 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 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 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 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