@emilgroup/action-sdk 1.1.1-beta.27 → 1.1.1-beta.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +0 -6
- package/README.md +2 -2
- package/api/actions-api.ts +397 -219
- package/api/executions-api.ts +12 -119
- package/dist/api/actions-api.d.ts +270 -178
- package/dist/api/actions-api.js +328 -153
- package/dist/api/executions-api.d.ts +12 -69
- package/dist/api/executions-api.js +9 -102
- package/dist/models/action-class.d.ts +20 -9
- package/dist/models/action-execution-class.d.ts +0 -36
- package/dist/models/create-action-request-dto.d.ts +5 -47
- package/dist/models/create-action-request-dto.js +0 -6
- package/dist/models/index.d.ts +0 -6
- package/dist/models/index.js +0 -6
- package/dist/models/update-action-request-dto.d.ts +5 -41
- package/dist/models/update-action-request-dto.js +0 -6
- package/models/action-class.ts +20 -9
- package/models/action-execution-class.ts +0 -36
- package/models/create-action-request-dto.ts +5 -50
- package/models/index.ts +0 -6
- package/models/update-action-request-dto.ts +5 -44
- package/package.json +1 -1
- package/dist/models/action-ref-class.d.ts +0 -36
- package/dist/models/action-ref-class.js +0 -15
- package/dist/models/action-version-class.d.ts +0 -127
- package/dist/models/action-version-class.js +0 -21
- package/dist/models/get-action-version-response-class.d.ts +0 -25
- package/dist/models/get-action-version-response-class.js +0 -15
- package/dist/models/list-action-versions-response-class.d.ts +0 -43
- package/dist/models/list-action-versions-response-class.js +0 -15
- package/dist/models/trigger-action-request-dto.d.ts +0 -62
- package/dist/models/trigger-action-request-dto.js +0 -15
- package/dist/models/trigger-action-response-class.d.ts +0 -25
- package/dist/models/trigger-action-response-class.js +0 -15
- package/models/action-ref-class.ts +0 -42
- package/models/action-version-class.ts +0 -136
- package/models/get-action-version-response-class.ts +0 -31
- package/models/list-action-versions-response-class.ts +0 -49
- package/models/trigger-action-request-dto.ts +0 -66
- package/models/trigger-action-response-class.ts +0 -31
package/api/executions-api.ts
CHANGED
|
@@ -24,10 +24,6 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr
|
|
|
24
24
|
import { GetActionExecutionStatusResponseClass } from '../models';
|
|
25
25
|
// @ts-ignore
|
|
26
26
|
import { ListActionExecutionsResponseClass } from '../models';
|
|
27
|
-
// @ts-ignore
|
|
28
|
-
import { TriggerActionRequestDto } from '../models';
|
|
29
|
-
// @ts-ignore
|
|
30
|
-
import { TriggerActionResponseClass } from '../models';
|
|
31
27
|
/**
|
|
32
28
|
* ExecutionsApi - axios parameter creator
|
|
33
29
|
* @export
|
|
@@ -91,11 +87,11 @@ export const ExecutionsApiAxiosParamCreator = function (configuration?: Configur
|
|
|
91
87
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
92
88
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
93
89
|
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
94
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
90
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
95
91
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
96
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug,
|
|
92
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt</i>
|
|
97
93
|
* @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.<br/> <br/>
|
|
98
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
94
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
99
95
|
* @param {*} [options] Override http request option.
|
|
100
96
|
* @throws {RequiredError}
|
|
101
97
|
*/
|
|
@@ -156,53 +152,6 @@ export const ExecutionsApiAxiosParamCreator = function (configuration?: Configur
|
|
|
156
152
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
157
153
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
158
154
|
|
|
159
|
-
return {
|
|
160
|
-
url: toPathString(localVarUrlObj),
|
|
161
|
-
options: localVarRequestOptions,
|
|
162
|
-
};
|
|
163
|
-
},
|
|
164
|
-
/**
|
|
165
|
-
* Triggers an action execution. When the action has an input_validation_schema, the input payload is validated against it; invalid payloads return HTTP 400 with a body containing message and errors (JSON Schema validation errors). **Required Permissions** \"action-management.actions.run\"
|
|
166
|
-
* @summary Create the actionExecution
|
|
167
|
-
* @param {TriggerActionRequestDto} triggerActionRequestDto
|
|
168
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
169
|
-
* @param {*} [options] Override http request option.
|
|
170
|
-
* @throws {RequiredError}
|
|
171
|
-
*/
|
|
172
|
-
triggerAction: async (triggerActionRequestDto: TriggerActionRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
173
|
-
// verify required parameter 'triggerActionRequestDto' is not null or undefined
|
|
174
|
-
assertParamExists('triggerAction', 'triggerActionRequestDto', triggerActionRequestDto)
|
|
175
|
-
const localVarPath = `/actionservice/v1/actions/trigger`;
|
|
176
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
177
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
178
|
-
let baseOptions;
|
|
179
|
-
let baseAccessToken;
|
|
180
|
-
if (configuration) {
|
|
181
|
-
baseOptions = configuration.baseOptions;
|
|
182
|
-
baseAccessToken = configuration.accessToken;
|
|
183
|
-
}
|
|
184
|
-
|
|
185
|
-
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
186
|
-
const localVarHeaderParameter = {} as any;
|
|
187
|
-
const localVarQueryParameter = {} as any;
|
|
188
|
-
|
|
189
|
-
// authentication bearer required
|
|
190
|
-
// http bearer authentication required
|
|
191
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
192
|
-
|
|
193
|
-
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
194
|
-
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
195
|
-
}
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
200
|
-
|
|
201
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
202
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
203
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
204
|
-
localVarRequestOptions.data = serializeDataIfNeeded(triggerActionRequestDto, localVarRequestOptions, configuration)
|
|
205
|
-
|
|
206
155
|
return {
|
|
207
156
|
url: toPathString(localVarUrlObj),
|
|
208
157
|
options: localVarRequestOptions,
|
|
@@ -237,11 +186,11 @@ export const ExecutionsApiFp = function(configuration?: Configuration) {
|
|
|
237
186
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
238
187
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
239
188
|
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
240
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
189
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
241
190
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
242
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug,
|
|
191
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt</i>
|
|
243
192
|
* @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.<br/> <br/>
|
|
244
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
193
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
245
194
|
* @param {*} [options] Override http request option.
|
|
246
195
|
* @throws {RequiredError}
|
|
247
196
|
*/
|
|
@@ -249,18 +198,6 @@ export const ExecutionsApiFp = function(configuration?: Configuration) {
|
|
|
249
198
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listActionExecutions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
250
199
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
251
200
|
},
|
|
252
|
-
/**
|
|
253
|
-
* Triggers an action execution. When the action has an input_validation_schema, the input payload is validated against it; invalid payloads return HTTP 400 with a body containing message and errors (JSON Schema validation errors). **Required Permissions** \"action-management.actions.run\"
|
|
254
|
-
* @summary Create the actionExecution
|
|
255
|
-
* @param {TriggerActionRequestDto} triggerActionRequestDto
|
|
256
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
257
|
-
* @param {*} [options] Override http request option.
|
|
258
|
-
* @throws {RequiredError}
|
|
259
|
-
*/
|
|
260
|
-
async triggerAction(triggerActionRequestDto: TriggerActionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TriggerActionResponseClass>> {
|
|
261
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.triggerAction(triggerActionRequestDto, authorization, options);
|
|
262
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
263
|
-
},
|
|
264
201
|
}
|
|
265
202
|
};
|
|
266
203
|
|
|
@@ -289,28 +226,17 @@ export const ExecutionsApiFactory = function (configuration?: Configuration, bas
|
|
|
289
226
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
290
227
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
291
228
|
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
292
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
229
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
293
230
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
294
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug,
|
|
231
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt</i>
|
|
295
232
|
* @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.<br/> <br/>
|
|
296
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
233
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
297
234
|
* @param {*} [options] Override http request option.
|
|
298
235
|
* @throws {RequiredError}
|
|
299
236
|
*/
|
|
300
237
|
listActionExecutions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListActionExecutionsResponseClass> {
|
|
301
238
|
return localVarFp.listActionExecutions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
302
239
|
},
|
|
303
|
-
/**
|
|
304
|
-
* Triggers an action execution. When the action has an input_validation_schema, the input payload is validated against it; invalid payloads return HTTP 400 with a body containing message and errors (JSON Schema validation errors). **Required Permissions** \"action-management.actions.run\"
|
|
305
|
-
* @summary Create the actionExecution
|
|
306
|
-
* @param {TriggerActionRequestDto} triggerActionRequestDto
|
|
307
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
308
|
-
* @param {*} [options] Override http request option.
|
|
309
|
-
* @throws {RequiredError}
|
|
310
|
-
*/
|
|
311
|
-
triggerAction(triggerActionRequestDto: TriggerActionRequestDto, authorization?: string, options?: any): AxiosPromise<TriggerActionResponseClass> {
|
|
312
|
-
return localVarFp.triggerAction(triggerActionRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
313
|
-
},
|
|
314
240
|
};
|
|
315
241
|
};
|
|
316
242
|
|
|
@@ -370,7 +296,7 @@ export interface ExecutionsApiListActionExecutionsRequest {
|
|
|
370
296
|
readonly pageToken?: string
|
|
371
297
|
|
|
372
298
|
/**
|
|
373
|
-
* Filter the response by one or multiple fields.
|
|
299
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
374
300
|
* @type {string}
|
|
375
301
|
* @memberof ExecutionsApiListActionExecutions
|
|
376
302
|
*/
|
|
@@ -384,7 +310,7 @@ export interface ExecutionsApiListActionExecutionsRequest {
|
|
|
384
310
|
readonly search?: string
|
|
385
311
|
|
|
386
312
|
/**
|
|
387
|
-
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug,
|
|
313
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt</i>
|
|
388
314
|
* @type {string}
|
|
389
315
|
* @memberof ExecutionsApiListActionExecutions
|
|
390
316
|
*/
|
|
@@ -398,34 +324,13 @@ export interface ExecutionsApiListActionExecutionsRequest {
|
|
|
398
324
|
readonly expand?: string
|
|
399
325
|
|
|
400
326
|
/**
|
|
401
|
-
* Filters the response by one or multiple fields.
|
|
327
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, executionCode, actionCode, actionSlug, status, triggeredBy, triggerSource, correlationId, workflowInstanceCode, completedAt, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
402
328
|
* @type {string}
|
|
403
329
|
* @memberof ExecutionsApiListActionExecutions
|
|
404
330
|
*/
|
|
405
331
|
readonly filters?: string
|
|
406
332
|
}
|
|
407
333
|
|
|
408
|
-
/**
|
|
409
|
-
* Request parameters for triggerAction operation in ExecutionsApi.
|
|
410
|
-
* @export
|
|
411
|
-
* @interface ExecutionsApiTriggerActionRequest
|
|
412
|
-
*/
|
|
413
|
-
export interface ExecutionsApiTriggerActionRequest {
|
|
414
|
-
/**
|
|
415
|
-
*
|
|
416
|
-
* @type {TriggerActionRequestDto}
|
|
417
|
-
* @memberof ExecutionsApiTriggerAction
|
|
418
|
-
*/
|
|
419
|
-
readonly triggerActionRequestDto: TriggerActionRequestDto
|
|
420
|
-
|
|
421
|
-
/**
|
|
422
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
423
|
-
* @type {string}
|
|
424
|
-
* @memberof ExecutionsApiTriggerAction
|
|
425
|
-
*/
|
|
426
|
-
readonly authorization?: string
|
|
427
|
-
}
|
|
428
|
-
|
|
429
334
|
/**
|
|
430
335
|
* ExecutionsApi - object-oriented interface
|
|
431
336
|
* @export
|
|
@@ -456,16 +361,4 @@ export class ExecutionsApi extends BaseAPI {
|
|
|
456
361
|
public listActionExecutions(requestParameters: ExecutionsApiListActionExecutionsRequest = {}, options?: AxiosRequestConfig) {
|
|
457
362
|
return ExecutionsApiFp(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));
|
|
458
363
|
}
|
|
459
|
-
|
|
460
|
-
/**
|
|
461
|
-
* Triggers an action execution. When the action has an input_validation_schema, the input payload is validated against it; invalid payloads return HTTP 400 with a body containing message and errors (JSON Schema validation errors). **Required Permissions** \"action-management.actions.run\"
|
|
462
|
-
* @summary Create the actionExecution
|
|
463
|
-
* @param {ExecutionsApiTriggerActionRequest} requestParameters Request parameters.
|
|
464
|
-
* @param {*} [options] Override http request option.
|
|
465
|
-
* @throws {RequiredError}
|
|
466
|
-
* @memberof ExecutionsApi
|
|
467
|
-
*/
|
|
468
|
-
public triggerAction(requestParameters: ExecutionsApiTriggerActionRequest, options?: AxiosRequestConfig) {
|
|
469
|
-
return ExecutionsApiFp(this.configuration).triggerAction(requestParameters.triggerActionRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
470
|
-
}
|
|
471
364
|
}
|