@emilgroup/action-sdk 1.1.1-beta.14 → 1.1.1-beta.16
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/README.md +2 -2
- package/api/actions-api.ts +160 -12
- package/dist/api/actions-api.d.ts +94 -12
- package/dist/api/actions-api.js +123 -9
- package/dist/models/action-class.d.ts +7 -1
- package/dist/models/create-action-request-dto.d.ts +15 -3
- package/dist/models/update-action-request-dto.d.ts +14 -2
- package/models/action-class.ts +7 -1
- package/models/create-action-request-dto.ts +15 -3
- package/models/update-action-request-dto.ts +14 -2
- package/package.json +1 -1
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.1.1-beta.
|
|
20
|
+
npm install @emilgroup/action-sdk@1.1.1-beta.16 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/action-sdk@1.1.1-beta.
|
|
24
|
+
yarn add @emilgroup/action-sdk@1.1.1-beta.16
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `ActionsApi`.
|
package/api/actions-api.ts
CHANGED
|
@@ -304,11 +304,11 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
304
304
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
305
305
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
306
306
|
* @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.
|
|
307
|
-
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
307
|
+
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
308
308
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
309
|
-
* @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, code, name, slug, isEnabled, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt</i>
|
|
309
|
+
* @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, code, name, slug, isEnabled, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt</i>
|
|
310
310
|
* @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/> <i>Allowed values: inputValidationSchema<i>
|
|
311
|
-
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
311
|
+
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
312
312
|
* @param {*} [options] Override http request option.
|
|
313
313
|
* @throws {RequiredError}
|
|
314
314
|
*/
|
|
@@ -365,6 +365,71 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
365
365
|
|
|
366
366
|
|
|
367
367
|
|
|
368
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
369
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
370
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
371
|
+
|
|
372
|
+
return {
|
|
373
|
+
url: toPathString(localVarUrlObj),
|
|
374
|
+
options: localVarRequestOptions,
|
|
375
|
+
};
|
|
376
|
+
},
|
|
377
|
+
/**
|
|
378
|
+
* Lists actions available for a given entity. Fetches entity snapshot by type and code, then returns actions configured for that entity type, product version, and tenant. **Required Permissions** \"action-management.actions.view\"
|
|
379
|
+
* @summary Retrieve the actionsByEntity
|
|
380
|
+
* @param {string} entityCode Code of the entity (e.g. policy code, lead code)
|
|
381
|
+
* @param {'POLICY' | 'LEAD' | 'CLAIM'} entityType Entity type: Policy, Lead, Claim
|
|
382
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
383
|
+
* @param {boolean} [includeDisabled] Include disabled (draft) actions
|
|
384
|
+
* @param {boolean} [includeNotAvailableInUi] Include actions that are not available in UI
|
|
385
|
+
* @param {*} [options] Override http request option.
|
|
386
|
+
* @throws {RequiredError}
|
|
387
|
+
*/
|
|
388
|
+
listActionsByEntity: async (entityCode: string, entityType: 'POLICY' | 'LEAD' | 'CLAIM', authorization?: string, includeDisabled?: boolean, includeNotAvailableInUi?: boolean, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
389
|
+
// verify required parameter 'entityCode' is not null or undefined
|
|
390
|
+
assertParamExists('listActionsByEntity', 'entityCode', entityCode)
|
|
391
|
+
// verify required parameter 'entityType' is not null or undefined
|
|
392
|
+
assertParamExists('listActionsByEntity', 'entityType', entityType)
|
|
393
|
+
const localVarPath = `/actionservice/v1/actions/by-entity`;
|
|
394
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
395
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
396
|
+
let baseOptions;
|
|
397
|
+
let baseAccessToken;
|
|
398
|
+
if (configuration) {
|
|
399
|
+
baseOptions = configuration.baseOptions;
|
|
400
|
+
baseAccessToken = configuration.accessToken;
|
|
401
|
+
}
|
|
402
|
+
|
|
403
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
404
|
+
const localVarHeaderParameter = {} as any;
|
|
405
|
+
const localVarQueryParameter = {} as any;
|
|
406
|
+
|
|
407
|
+
// authentication bearer required
|
|
408
|
+
// http bearer authentication required
|
|
409
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
410
|
+
|
|
411
|
+
if (entityCode !== undefined) {
|
|
412
|
+
localVarQueryParameter['entityCode'] = entityCode;
|
|
413
|
+
}
|
|
414
|
+
|
|
415
|
+
if (entityType !== undefined) {
|
|
416
|
+
localVarQueryParameter['entityType'] = entityType;
|
|
417
|
+
}
|
|
418
|
+
|
|
419
|
+
if (includeDisabled !== undefined) {
|
|
420
|
+
localVarQueryParameter['includeDisabled'] = includeDisabled;
|
|
421
|
+
}
|
|
422
|
+
|
|
423
|
+
if (includeNotAvailableInUi !== undefined) {
|
|
424
|
+
localVarQueryParameter['includeNotAvailableInUi'] = includeNotAvailableInUi;
|
|
425
|
+
}
|
|
426
|
+
|
|
427
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
428
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
429
|
+
}
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
|
|
368
433
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
369
434
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
370
435
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -505,11 +570,11 @@ export const ActionsApiFp = function(configuration?: Configuration) {
|
|
|
505
570
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
506
571
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
507
572
|
* @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.
|
|
508
|
-
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
573
|
+
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
509
574
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
510
|
-
* @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, code, name, slug, isEnabled, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt</i>
|
|
575
|
+
* @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, code, name, slug, isEnabled, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt</i>
|
|
511
576
|
* @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/> <i>Allowed values: inputValidationSchema<i>
|
|
512
|
-
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
577
|
+
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
513
578
|
* @param {*} [options] Override http request option.
|
|
514
579
|
* @throws {RequiredError}
|
|
515
580
|
*/
|
|
@@ -517,6 +582,21 @@ export const ActionsApiFp = function(configuration?: Configuration) {
|
|
|
517
582
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listActions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
518
583
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
519
584
|
},
|
|
585
|
+
/**
|
|
586
|
+
* Lists actions available for a given entity. Fetches entity snapshot by type and code, then returns actions configured for that entity type, product version, and tenant. **Required Permissions** \"action-management.actions.view\"
|
|
587
|
+
* @summary Retrieve the actionsByEntity
|
|
588
|
+
* @param {string} entityCode Code of the entity (e.g. policy code, lead code)
|
|
589
|
+
* @param {'POLICY' | 'LEAD' | 'CLAIM'} entityType Entity type: Policy, Lead, Claim
|
|
590
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
591
|
+
* @param {boolean} [includeDisabled] Include disabled (draft) actions
|
|
592
|
+
* @param {boolean} [includeNotAvailableInUi] Include actions that are not available in UI
|
|
593
|
+
* @param {*} [options] Override http request option.
|
|
594
|
+
* @throws {RequiredError}
|
|
595
|
+
*/
|
|
596
|
+
async listActionsByEntity(entityCode: string, entityType: 'POLICY' | 'LEAD' | 'CLAIM', authorization?: string, includeDisabled?: boolean, includeNotAvailableInUi?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListActionsResponseClass>> {
|
|
597
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listActionsByEntity(entityCode, entityType, authorization, includeDisabled, includeNotAvailableInUi, options);
|
|
598
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
599
|
+
},
|
|
520
600
|
/**
|
|
521
601
|
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
522
602
|
* @summary Update the action
|
|
@@ -605,17 +685,31 @@ export const ActionsApiFactory = function (configuration?: Configuration, basePa
|
|
|
605
685
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
606
686
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
607
687
|
* @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.
|
|
608
|
-
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
688
|
+
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
609
689
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
610
|
-
* @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, code, name, slug, isEnabled, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt</i>
|
|
690
|
+
* @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, code, name, slug, isEnabled, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt</i>
|
|
611
691
|
* @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/> <i>Allowed values: inputValidationSchema<i>
|
|
612
|
-
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
692
|
+
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
613
693
|
* @param {*} [options] Override http request option.
|
|
614
694
|
* @throws {RequiredError}
|
|
615
695
|
*/
|
|
616
696
|
listActions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListActionsResponseClass> {
|
|
617
697
|
return localVarFp.listActions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
618
698
|
},
|
|
699
|
+
/**
|
|
700
|
+
* Lists actions available for a given entity. Fetches entity snapshot by type and code, then returns actions configured for that entity type, product version, and tenant. **Required Permissions** \"action-management.actions.view\"
|
|
701
|
+
* @summary Retrieve the actionsByEntity
|
|
702
|
+
* @param {string} entityCode Code of the entity (e.g. policy code, lead code)
|
|
703
|
+
* @param {'POLICY' | 'LEAD' | 'CLAIM'} entityType Entity type: Policy, Lead, Claim
|
|
704
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
705
|
+
* @param {boolean} [includeDisabled] Include disabled (draft) actions
|
|
706
|
+
* @param {boolean} [includeNotAvailableInUi] Include actions that are not available in UI
|
|
707
|
+
* @param {*} [options] Override http request option.
|
|
708
|
+
* @throws {RequiredError}
|
|
709
|
+
*/
|
|
710
|
+
listActionsByEntity(entityCode: string, entityType: 'POLICY' | 'LEAD' | 'CLAIM', authorization?: string, includeDisabled?: boolean, includeNotAvailableInUi?: boolean, options?: any): AxiosPromise<ListActionsResponseClass> {
|
|
711
|
+
return localVarFp.listActionsByEntity(entityCode, entityType, authorization, includeDisabled, includeNotAvailableInUi, options).then((request) => request(axios, basePath));
|
|
712
|
+
},
|
|
619
713
|
/**
|
|
620
714
|
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
621
715
|
* @summary Update the action
|
|
@@ -792,7 +886,7 @@ export interface ActionsApiListActionsRequest {
|
|
|
792
886
|
readonly pageToken?: string
|
|
793
887
|
|
|
794
888
|
/**
|
|
795
|
-
* 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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
889
|
+
* 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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
796
890
|
* @type {string}
|
|
797
891
|
* @memberof ActionsApiListActions
|
|
798
892
|
*/
|
|
@@ -806,7 +900,7 @@ export interface ActionsApiListActionsRequest {
|
|
|
806
900
|
readonly search?: string
|
|
807
901
|
|
|
808
902
|
/**
|
|
809
|
-
* 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, code, name, slug, isEnabled, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt</i>
|
|
903
|
+
* 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, code, name, slug, isEnabled, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt</i>
|
|
810
904
|
* @type {string}
|
|
811
905
|
* @memberof ActionsApiListActions
|
|
812
906
|
*/
|
|
@@ -820,13 +914,55 @@ export interface ActionsApiListActionsRequest {
|
|
|
820
914
|
readonly expand?: string
|
|
821
915
|
|
|
822
916
|
/**
|
|
823
|
-
* 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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
917
|
+
* 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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
824
918
|
* @type {string}
|
|
825
919
|
* @memberof ActionsApiListActions
|
|
826
920
|
*/
|
|
827
921
|
readonly filters?: string
|
|
828
922
|
}
|
|
829
923
|
|
|
924
|
+
/**
|
|
925
|
+
* Request parameters for listActionsByEntity operation in ActionsApi.
|
|
926
|
+
* @export
|
|
927
|
+
* @interface ActionsApiListActionsByEntityRequest
|
|
928
|
+
*/
|
|
929
|
+
export interface ActionsApiListActionsByEntityRequest {
|
|
930
|
+
/**
|
|
931
|
+
* Code of the entity (e.g. policy code, lead code)
|
|
932
|
+
* @type {string}
|
|
933
|
+
* @memberof ActionsApiListActionsByEntity
|
|
934
|
+
*/
|
|
935
|
+
readonly entityCode: string
|
|
936
|
+
|
|
937
|
+
/**
|
|
938
|
+
* Entity type: Policy, Lead, Claim
|
|
939
|
+
* @type {'POLICY' | 'LEAD' | 'CLAIM'}
|
|
940
|
+
* @memberof ActionsApiListActionsByEntity
|
|
941
|
+
*/
|
|
942
|
+
readonly entityType: 'POLICY' | 'LEAD' | 'CLAIM'
|
|
943
|
+
|
|
944
|
+
/**
|
|
945
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
946
|
+
* @type {string}
|
|
947
|
+
* @memberof ActionsApiListActionsByEntity
|
|
948
|
+
*/
|
|
949
|
+
readonly authorization?: string
|
|
950
|
+
|
|
951
|
+
/**
|
|
952
|
+
* Include disabled (draft) actions
|
|
953
|
+
* @type {boolean}
|
|
954
|
+
* @memberof ActionsApiListActionsByEntity
|
|
955
|
+
*/
|
|
956
|
+
readonly includeDisabled?: boolean
|
|
957
|
+
|
|
958
|
+
/**
|
|
959
|
+
* Include actions that are not available in UI
|
|
960
|
+
* @type {boolean}
|
|
961
|
+
* @memberof ActionsApiListActionsByEntity
|
|
962
|
+
*/
|
|
963
|
+
readonly includeNotAvailableInUi?: boolean
|
|
964
|
+
}
|
|
965
|
+
|
|
830
966
|
/**
|
|
831
967
|
* Request parameters for updateAction operation in ActionsApi.
|
|
832
968
|
* @export
|
|
@@ -934,6 +1070,18 @@ export class ActionsApi extends BaseAPI {
|
|
|
934
1070
|
return ActionsApiFp(this.configuration).listActions(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
935
1071
|
}
|
|
936
1072
|
|
|
1073
|
+
/**
|
|
1074
|
+
* Lists actions available for a given entity. Fetches entity snapshot by type and code, then returns actions configured for that entity type, product version, and tenant. **Required Permissions** \"action-management.actions.view\"
|
|
1075
|
+
* @summary Retrieve the actionsByEntity
|
|
1076
|
+
* @param {ActionsApiListActionsByEntityRequest} requestParameters Request parameters.
|
|
1077
|
+
* @param {*} [options] Override http request option.
|
|
1078
|
+
* @throws {RequiredError}
|
|
1079
|
+
* @memberof ActionsApi
|
|
1080
|
+
*/
|
|
1081
|
+
public listActionsByEntity(requestParameters: ActionsApiListActionsByEntityRequest, options?: AxiosRequestConfig) {
|
|
1082
|
+
return ActionsApiFp(this.configuration).listActionsByEntity(requestParameters.entityCode, requestParameters.entityType, requestParameters.authorization, requestParameters.includeDisabled, requestParameters.includeNotAvailableInUi, options).then((request) => request(this.axios, this.basePath));
|
|
1083
|
+
}
|
|
1084
|
+
|
|
937
1085
|
/**
|
|
938
1086
|
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
939
1087
|
* @summary Update the action
|
|
@@ -81,15 +81,27 @@ export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
81
81
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
82
82
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
83
83
|
* @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.
|
|
84
|
-
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
84
|
+
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
85
85
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
86
|
-
* @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, code, name, slug, isEnabled, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt</i>
|
|
86
|
+
* @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, code, name, slug, isEnabled, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt</i>
|
|
87
87
|
* @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/> <i>Allowed values: inputValidationSchema<i>
|
|
88
|
-
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
88
|
+
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
89
89
|
* @param {*} [options] Override http request option.
|
|
90
90
|
* @throws {RequiredError}
|
|
91
91
|
*/
|
|
92
92
|
listActions: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
93
|
+
/**
|
|
94
|
+
* Lists actions available for a given entity. Fetches entity snapshot by type and code, then returns actions configured for that entity type, product version, and tenant. **Required Permissions** \"action-management.actions.view\"
|
|
95
|
+
* @summary Retrieve the actionsByEntity
|
|
96
|
+
* @param {string} entityCode Code of the entity (e.g. policy code, lead code)
|
|
97
|
+
* @param {'POLICY' | 'LEAD' | 'CLAIM'} entityType Entity type: Policy, Lead, Claim
|
|
98
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
99
|
+
* @param {boolean} [includeDisabled] Include disabled (draft) actions
|
|
100
|
+
* @param {boolean} [includeNotAvailableInUi] Include actions that are not available in UI
|
|
101
|
+
* @param {*} [options] Override http request option.
|
|
102
|
+
* @throws {RequiredError}
|
|
103
|
+
*/
|
|
104
|
+
listActionsByEntity: (entityCode: string, entityType: 'POLICY' | 'LEAD' | 'CLAIM', authorization?: string, includeDisabled?: boolean, includeNotAvailableInUi?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
93
105
|
/**
|
|
94
106
|
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
95
107
|
* @summary Update the action
|
|
@@ -161,15 +173,27 @@ export declare const ActionsApiFp: (configuration?: Configuration) => {
|
|
|
161
173
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
162
174
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
163
175
|
* @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.
|
|
164
|
-
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
176
|
+
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
165
177
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
166
|
-
* @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, code, name, slug, isEnabled, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt</i>
|
|
178
|
+
* @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, code, name, slug, isEnabled, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt</i>
|
|
167
179
|
* @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/> <i>Allowed values: inputValidationSchema<i>
|
|
168
|
-
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
180
|
+
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
169
181
|
* @param {*} [options] Override http request option.
|
|
170
182
|
* @throws {RequiredError}
|
|
171
183
|
*/
|
|
172
184
|
listActions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListActionsResponseClass>>;
|
|
185
|
+
/**
|
|
186
|
+
* Lists actions available for a given entity. Fetches entity snapshot by type and code, then returns actions configured for that entity type, product version, and tenant. **Required Permissions** \"action-management.actions.view\"
|
|
187
|
+
* @summary Retrieve the actionsByEntity
|
|
188
|
+
* @param {string} entityCode Code of the entity (e.g. policy code, lead code)
|
|
189
|
+
* @param {'POLICY' | 'LEAD' | 'CLAIM'} entityType Entity type: Policy, Lead, Claim
|
|
190
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
191
|
+
* @param {boolean} [includeDisabled] Include disabled (draft) actions
|
|
192
|
+
* @param {boolean} [includeNotAvailableInUi] Include actions that are not available in UI
|
|
193
|
+
* @param {*} [options] Override http request option.
|
|
194
|
+
* @throws {RequiredError}
|
|
195
|
+
*/
|
|
196
|
+
listActionsByEntity(entityCode: string, entityType: 'POLICY' | 'LEAD' | 'CLAIM', authorization?: string, includeDisabled?: boolean, includeNotAvailableInUi?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListActionsResponseClass>>;
|
|
173
197
|
/**
|
|
174
198
|
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
175
199
|
* @summary Update the action
|
|
@@ -241,15 +265,27 @@ export declare const ActionsApiFactory: (configuration?: Configuration, basePath
|
|
|
241
265
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
242
266
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
243
267
|
* @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.
|
|
244
|
-
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
268
|
+
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
245
269
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
246
|
-
* @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, code, name, slug, isEnabled, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt</i>
|
|
270
|
+
* @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, code, name, slug, isEnabled, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt</i>
|
|
247
271
|
* @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/> <i>Allowed values: inputValidationSchema<i>
|
|
248
|
-
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
272
|
+
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
249
273
|
* @param {*} [options] Override http request option.
|
|
250
274
|
* @throws {RequiredError}
|
|
251
275
|
*/
|
|
252
276
|
listActions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListActionsResponseClass>;
|
|
277
|
+
/**
|
|
278
|
+
* Lists actions available for a given entity. Fetches entity snapshot by type and code, then returns actions configured for that entity type, product version, and tenant. **Required Permissions** \"action-management.actions.view\"
|
|
279
|
+
* @summary Retrieve the actionsByEntity
|
|
280
|
+
* @param {string} entityCode Code of the entity (e.g. policy code, lead code)
|
|
281
|
+
* @param {'POLICY' | 'LEAD' | 'CLAIM'} entityType Entity type: Policy, Lead, Claim
|
|
282
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
283
|
+
* @param {boolean} [includeDisabled] Include disabled (draft) actions
|
|
284
|
+
* @param {boolean} [includeNotAvailableInUi] Include actions that are not available in UI
|
|
285
|
+
* @param {*} [options] Override http request option.
|
|
286
|
+
* @throws {RequiredError}
|
|
287
|
+
*/
|
|
288
|
+
listActionsByEntity(entityCode: string, entityType: 'POLICY' | 'LEAD' | 'CLAIM', authorization?: string, includeDisabled?: boolean, includeNotAvailableInUi?: boolean, options?: any): AxiosPromise<ListActionsResponseClass>;
|
|
253
289
|
/**
|
|
254
290
|
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
255
291
|
* @summary Update the action
|
|
@@ -405,7 +441,7 @@ export interface ActionsApiListActionsRequest {
|
|
|
405
441
|
*/
|
|
406
442
|
readonly pageToken?: string;
|
|
407
443
|
/**
|
|
408
|
-
* 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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
444
|
+
* 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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
409
445
|
* @type {string}
|
|
410
446
|
* @memberof ActionsApiListActions
|
|
411
447
|
*/
|
|
@@ -417,7 +453,7 @@ export interface ActionsApiListActionsRequest {
|
|
|
417
453
|
*/
|
|
418
454
|
readonly search?: string;
|
|
419
455
|
/**
|
|
420
|
-
* 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, code, name, slug, isEnabled, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt</i>
|
|
456
|
+
* 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, code, name, slug, isEnabled, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt</i>
|
|
421
457
|
* @type {string}
|
|
422
458
|
* @memberof ActionsApiListActions
|
|
423
459
|
*/
|
|
@@ -429,12 +465,49 @@ export interface ActionsApiListActionsRequest {
|
|
|
429
465
|
*/
|
|
430
466
|
readonly expand?: string;
|
|
431
467
|
/**
|
|
432
|
-
* 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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
468
|
+
* 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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
433
469
|
* @type {string}
|
|
434
470
|
* @memberof ActionsApiListActions
|
|
435
471
|
*/
|
|
436
472
|
readonly filters?: string;
|
|
437
473
|
}
|
|
474
|
+
/**
|
|
475
|
+
* Request parameters for listActionsByEntity operation in ActionsApi.
|
|
476
|
+
* @export
|
|
477
|
+
* @interface ActionsApiListActionsByEntityRequest
|
|
478
|
+
*/
|
|
479
|
+
export interface ActionsApiListActionsByEntityRequest {
|
|
480
|
+
/**
|
|
481
|
+
* Code of the entity (e.g. policy code, lead code)
|
|
482
|
+
* @type {string}
|
|
483
|
+
* @memberof ActionsApiListActionsByEntity
|
|
484
|
+
*/
|
|
485
|
+
readonly entityCode: string;
|
|
486
|
+
/**
|
|
487
|
+
* Entity type: Policy, Lead, Claim
|
|
488
|
+
* @type {'POLICY' | 'LEAD' | 'CLAIM'}
|
|
489
|
+
* @memberof ActionsApiListActionsByEntity
|
|
490
|
+
*/
|
|
491
|
+
readonly entityType: 'POLICY' | 'LEAD' | 'CLAIM';
|
|
492
|
+
/**
|
|
493
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
494
|
+
* @type {string}
|
|
495
|
+
* @memberof ActionsApiListActionsByEntity
|
|
496
|
+
*/
|
|
497
|
+
readonly authorization?: string;
|
|
498
|
+
/**
|
|
499
|
+
* Include disabled (draft) actions
|
|
500
|
+
* @type {boolean}
|
|
501
|
+
* @memberof ActionsApiListActionsByEntity
|
|
502
|
+
*/
|
|
503
|
+
readonly includeDisabled?: boolean;
|
|
504
|
+
/**
|
|
505
|
+
* Include actions that are not available in UI
|
|
506
|
+
* @type {boolean}
|
|
507
|
+
* @memberof ActionsApiListActionsByEntity
|
|
508
|
+
*/
|
|
509
|
+
readonly includeNotAvailableInUi?: boolean;
|
|
510
|
+
}
|
|
438
511
|
/**
|
|
439
512
|
* Request parameters for updateAction operation in ActionsApi.
|
|
440
513
|
* @export
|
|
@@ -521,6 +594,15 @@ export declare class ActionsApi extends BaseAPI {
|
|
|
521
594
|
* @memberof ActionsApi
|
|
522
595
|
*/
|
|
523
596
|
listActions(requestParameters?: ActionsApiListActionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListActionsResponseClass, any, {}>>;
|
|
597
|
+
/**
|
|
598
|
+
* Lists actions available for a given entity. Fetches entity snapshot by type and code, then returns actions configured for that entity type, product version, and tenant. **Required Permissions** \"action-management.actions.view\"
|
|
599
|
+
* @summary Retrieve the actionsByEntity
|
|
600
|
+
* @param {ActionsApiListActionsByEntityRequest} requestParameters Request parameters.
|
|
601
|
+
* @param {*} [options] Override http request option.
|
|
602
|
+
* @throws {RequiredError}
|
|
603
|
+
* @memberof ActionsApi
|
|
604
|
+
*/
|
|
605
|
+
listActionsByEntity(requestParameters: ActionsApiListActionsByEntityRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListActionsResponseClass, any, {}>>;
|
|
524
606
|
/**
|
|
525
607
|
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
526
608
|
* @summary Update the action
|
package/dist/api/actions-api.js
CHANGED
|
@@ -360,11 +360,11 @@ var ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
360
360
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
361
361
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
362
362
|
* @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.
|
|
363
|
-
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
363
|
+
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
364
364
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
365
|
-
* @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, code, name, slug, isEnabled, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt</i>
|
|
365
|
+
* @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, code, name, slug, isEnabled, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt</i>
|
|
366
366
|
* @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/> <i>Allowed values: inputValidationSchema<i>
|
|
367
|
-
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
367
|
+
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
368
368
|
* @param {*} [options] Override http request option.
|
|
369
369
|
* @throws {RequiredError}
|
|
370
370
|
*/
|
|
@@ -426,6 +426,70 @@ var ActionsApiAxiosParamCreator = function (configuration) {
|
|
|
426
426
|
});
|
|
427
427
|
});
|
|
428
428
|
},
|
|
429
|
+
/**
|
|
430
|
+
* Lists actions available for a given entity. Fetches entity snapshot by type and code, then returns actions configured for that entity type, product version, and tenant. **Required Permissions** \"action-management.actions.view\"
|
|
431
|
+
* @summary Retrieve the actionsByEntity
|
|
432
|
+
* @param {string} entityCode Code of the entity (e.g. policy code, lead code)
|
|
433
|
+
* @param {'POLICY' | 'LEAD' | 'CLAIM'} entityType Entity type: Policy, Lead, Claim
|
|
434
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
435
|
+
* @param {boolean} [includeDisabled] Include disabled (draft) actions
|
|
436
|
+
* @param {boolean} [includeNotAvailableInUi] Include actions that are not available in UI
|
|
437
|
+
* @param {*} [options] Override http request option.
|
|
438
|
+
* @throws {RequiredError}
|
|
439
|
+
*/
|
|
440
|
+
listActionsByEntity: function (entityCode, entityType, authorization, includeDisabled, includeNotAvailableInUi, options) {
|
|
441
|
+
if (options === void 0) { options = {}; }
|
|
442
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
443
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
444
|
+
return __generator(this, function (_a) {
|
|
445
|
+
switch (_a.label) {
|
|
446
|
+
case 0:
|
|
447
|
+
// verify required parameter 'entityCode' is not null or undefined
|
|
448
|
+
(0, common_1.assertParamExists)('listActionsByEntity', 'entityCode', entityCode);
|
|
449
|
+
// verify required parameter 'entityType' is not null or undefined
|
|
450
|
+
(0, common_1.assertParamExists)('listActionsByEntity', 'entityType', entityType);
|
|
451
|
+
localVarPath = "/actionservice/v1/actions/by-entity";
|
|
452
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
453
|
+
if (configuration) {
|
|
454
|
+
baseOptions = configuration.baseOptions;
|
|
455
|
+
baseAccessToken = configuration.accessToken;
|
|
456
|
+
}
|
|
457
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
|
|
458
|
+
localVarHeaderParameter = {};
|
|
459
|
+
localVarQueryParameter = {};
|
|
460
|
+
// authentication bearer required
|
|
461
|
+
// http bearer authentication required
|
|
462
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
463
|
+
case 1:
|
|
464
|
+
// authentication bearer required
|
|
465
|
+
// http bearer authentication required
|
|
466
|
+
_a.sent();
|
|
467
|
+
if (entityCode !== undefined) {
|
|
468
|
+
localVarQueryParameter['entityCode'] = entityCode;
|
|
469
|
+
}
|
|
470
|
+
if (entityType !== undefined) {
|
|
471
|
+
localVarQueryParameter['entityType'] = entityType;
|
|
472
|
+
}
|
|
473
|
+
if (includeDisabled !== undefined) {
|
|
474
|
+
localVarQueryParameter['includeDisabled'] = includeDisabled;
|
|
475
|
+
}
|
|
476
|
+
if (includeNotAvailableInUi !== undefined) {
|
|
477
|
+
localVarQueryParameter['includeNotAvailableInUi'] = includeNotAvailableInUi;
|
|
478
|
+
}
|
|
479
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
480
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
481
|
+
}
|
|
482
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
483
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
484
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
485
|
+
return [2 /*return*/, {
|
|
486
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
487
|
+
options: localVarRequestOptions,
|
|
488
|
+
}];
|
|
489
|
+
}
|
|
490
|
+
});
|
|
491
|
+
});
|
|
492
|
+
},
|
|
429
493
|
/**
|
|
430
494
|
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
431
495
|
* @summary Update the action
|
|
@@ -604,11 +668,11 @@ var ActionsApiFp = function (configuration) {
|
|
|
604
668
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
605
669
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
606
670
|
* @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.
|
|
607
|
-
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
671
|
+
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
608
672
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
609
|
-
* @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, code, name, slug, isEnabled, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt</i>
|
|
673
|
+
* @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, code, name, slug, isEnabled, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt</i>
|
|
610
674
|
* @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/> <i>Allowed values: inputValidationSchema<i>
|
|
611
|
-
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
675
|
+
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
612
676
|
* @param {*} [options] Override http request option.
|
|
613
677
|
* @throws {RequiredError}
|
|
614
678
|
*/
|
|
@@ -625,6 +689,30 @@ var ActionsApiFp = function (configuration) {
|
|
|
625
689
|
});
|
|
626
690
|
});
|
|
627
691
|
},
|
|
692
|
+
/**
|
|
693
|
+
* Lists actions available for a given entity. Fetches entity snapshot by type and code, then returns actions configured for that entity type, product version, and tenant. **Required Permissions** \"action-management.actions.view\"
|
|
694
|
+
* @summary Retrieve the actionsByEntity
|
|
695
|
+
* @param {string} entityCode Code of the entity (e.g. policy code, lead code)
|
|
696
|
+
* @param {'POLICY' | 'LEAD' | 'CLAIM'} entityType Entity type: Policy, Lead, Claim
|
|
697
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
698
|
+
* @param {boolean} [includeDisabled] Include disabled (draft) actions
|
|
699
|
+
* @param {boolean} [includeNotAvailableInUi] Include actions that are not available in UI
|
|
700
|
+
* @param {*} [options] Override http request option.
|
|
701
|
+
* @throws {RequiredError}
|
|
702
|
+
*/
|
|
703
|
+
listActionsByEntity: function (entityCode, entityType, authorization, includeDisabled, includeNotAvailableInUi, options) {
|
|
704
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
705
|
+
var localVarAxiosArgs;
|
|
706
|
+
return __generator(this, function (_a) {
|
|
707
|
+
switch (_a.label) {
|
|
708
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listActionsByEntity(entityCode, entityType, authorization, includeDisabled, includeNotAvailableInUi, options)];
|
|
709
|
+
case 1:
|
|
710
|
+
localVarAxiosArgs = _a.sent();
|
|
711
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
712
|
+
}
|
|
713
|
+
});
|
|
714
|
+
});
|
|
715
|
+
},
|
|
628
716
|
/**
|
|
629
717
|
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
630
718
|
* @summary Update the action
|
|
@@ -722,17 +810,31 @@ var ActionsApiFactory = function (configuration, basePath, axios) {
|
|
|
722
810
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
723
811
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
724
812
|
* @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.
|
|
725
|
-
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
813
|
+
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
726
814
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
727
|
-
* @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, code, name, slug, isEnabled, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt</i>
|
|
815
|
+
* @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, code, name, slug, isEnabled, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, configVersion, createdAt, updatedAt</i>
|
|
728
816
|
* @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/> <i>Allowed values: inputValidationSchema<i>
|
|
729
|
-
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
817
|
+
* @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, code, name, slug, isEnabled, configVersion, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
730
818
|
* @param {*} [options] Override http request option.
|
|
731
819
|
* @throws {RequiredError}
|
|
732
820
|
*/
|
|
733
821
|
listActions: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
734
822
|
return localVarFp.listActions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
735
823
|
},
|
|
824
|
+
/**
|
|
825
|
+
* Lists actions available for a given entity. Fetches entity snapshot by type and code, then returns actions configured for that entity type, product version, and tenant. **Required Permissions** \"action-management.actions.view\"
|
|
826
|
+
* @summary Retrieve the actionsByEntity
|
|
827
|
+
* @param {string} entityCode Code of the entity (e.g. policy code, lead code)
|
|
828
|
+
* @param {'POLICY' | 'LEAD' | 'CLAIM'} entityType Entity type: Policy, Lead, Claim
|
|
829
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
830
|
+
* @param {boolean} [includeDisabled] Include disabled (draft) actions
|
|
831
|
+
* @param {boolean} [includeNotAvailableInUi] Include actions that are not available in UI
|
|
832
|
+
* @param {*} [options] Override http request option.
|
|
833
|
+
* @throws {RequiredError}
|
|
834
|
+
*/
|
|
835
|
+
listActionsByEntity: function (entityCode, entityType, authorization, includeDisabled, includeNotAvailableInUi, options) {
|
|
836
|
+
return localVarFp.listActionsByEntity(entityCode, entityType, authorization, includeDisabled, includeNotAvailableInUi, options).then(function (request) { return request(axios, basePath); });
|
|
837
|
+
},
|
|
736
838
|
/**
|
|
737
839
|
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
738
840
|
* @summary Update the action
|
|
@@ -832,6 +934,18 @@ var ActionsApi = /** @class */ (function (_super) {
|
|
|
832
934
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
833
935
|
return (0, exports.ActionsApiFp)(this.configuration).listActions(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
834
936
|
};
|
|
937
|
+
/**
|
|
938
|
+
* Lists actions available for a given entity. Fetches entity snapshot by type and code, then returns actions configured for that entity type, product version, and tenant. **Required Permissions** \"action-management.actions.view\"
|
|
939
|
+
* @summary Retrieve the actionsByEntity
|
|
940
|
+
* @param {ActionsApiListActionsByEntityRequest} requestParameters Request parameters.
|
|
941
|
+
* @param {*} [options] Override http request option.
|
|
942
|
+
* @throws {RequiredError}
|
|
943
|
+
* @memberof ActionsApi
|
|
944
|
+
*/
|
|
945
|
+
ActionsApi.prototype.listActionsByEntity = function (requestParameters, options) {
|
|
946
|
+
var _this = this;
|
|
947
|
+
return (0, exports.ActionsApiFp)(this.configuration).listActionsByEntity(requestParameters.entityCode, requestParameters.entityType, requestParameters.authorization, requestParameters.includeDisabled, requestParameters.includeNotAvailableInUi, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
948
|
+
};
|
|
835
949
|
/**
|
|
836
950
|
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\"
|
|
837
951
|
* @summary Update the action
|
|
@@ -40,7 +40,13 @@ export interface ActionClass {
|
|
|
40
40
|
*/
|
|
41
41
|
'slug': string;
|
|
42
42
|
/**
|
|
43
|
-
* BPMN/workflow
|
|
43
|
+
* BPMN/workflow slug identifying the workflow to execute when this action is triggered
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof ActionClass
|
|
46
|
+
*/
|
|
47
|
+
'workflowSlug': string;
|
|
48
|
+
/**
|
|
49
|
+
* BPMN/workflow code resolved from workflow_slug or provided directly (used when triggering)
|
|
44
50
|
* @type {string}
|
|
45
51
|
* @memberof ActionClass
|
|
46
52
|
*/
|
|
@@ -28,11 +28,17 @@ export interface CreateActionRequestDto {
|
|
|
28
28
|
*/
|
|
29
29
|
'slug'?: string;
|
|
30
30
|
/**
|
|
31
|
-
* BPMN/workflow
|
|
31
|
+
* BPMN/workflow slug. When provided, productSlug and productVersionId are required to resolve the workflow. At least one of workflowSlug or workflowCode required.
|
|
32
32
|
* @type {string}
|
|
33
33
|
* @memberof CreateActionRequestDto
|
|
34
34
|
*/
|
|
35
|
-
'
|
|
35
|
+
'workflowSlug'?: string;
|
|
36
|
+
/**
|
|
37
|
+
* BPMN/workflow code. At least one of workflowSlug or workflowCode is required.
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof CreateActionRequestDto
|
|
40
|
+
*/
|
|
41
|
+
'workflowCode'?: string;
|
|
36
42
|
/**
|
|
37
43
|
* true = published (triggerable), false = draft. Default true.
|
|
38
44
|
* @type {boolean}
|
|
@@ -58,11 +64,17 @@ export interface CreateActionRequestDto {
|
|
|
58
64
|
*/
|
|
59
65
|
'entityType'?: CreateActionRequestDtoEntityTypeEnum;
|
|
60
66
|
/**
|
|
61
|
-
* Product version ID.
|
|
67
|
+
* Product version ID. Required for entity actions (when entityType is set).
|
|
62
68
|
* @type {number}
|
|
63
69
|
* @memberof CreateActionRequestDto
|
|
64
70
|
*/
|
|
65
71
|
'productVersionId'?: number;
|
|
72
|
+
/**
|
|
73
|
+
* Product slug. Required for entity actions (when entityType is set). Must match the product that owns productVersionId.
|
|
74
|
+
* @type {string}
|
|
75
|
+
* @memberof CreateActionRequestDto
|
|
76
|
+
*/
|
|
77
|
+
'productSlug'?: string;
|
|
66
78
|
/**
|
|
67
79
|
* Optional JSON Schema to validate input_payload when triggering the action
|
|
68
80
|
* @type {object}
|
|
@@ -34,7 +34,13 @@ export interface UpdateActionRequestDto {
|
|
|
34
34
|
*/
|
|
35
35
|
'slug'?: string;
|
|
36
36
|
/**
|
|
37
|
-
* BPMN/workflow
|
|
37
|
+
* BPMN/workflow slug. When provided, productSlug and productVersionId are required to resolve the workflow.
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof UpdateActionRequestDto
|
|
40
|
+
*/
|
|
41
|
+
'workflowSlug'?: string;
|
|
42
|
+
/**
|
|
43
|
+
* BPMN/workflow code. When provided, used directly (no product required for resolution).
|
|
38
44
|
* @type {string}
|
|
39
45
|
* @memberof UpdateActionRequestDto
|
|
40
46
|
*/
|
|
@@ -64,11 +70,17 @@ export interface UpdateActionRequestDto {
|
|
|
64
70
|
*/
|
|
65
71
|
'entityType'?: UpdateActionRequestDtoEntityTypeEnum;
|
|
66
72
|
/**
|
|
67
|
-
* Product version ID.
|
|
73
|
+
* Product version ID. Required when updating an entity action (entityType set).
|
|
68
74
|
* @type {number}
|
|
69
75
|
* @memberof UpdateActionRequestDto
|
|
70
76
|
*/
|
|
71
77
|
'productVersionId'?: number;
|
|
78
|
+
/**
|
|
79
|
+
* Product slug. Required when updating an entity action. Must match the product that owns productVersionId.
|
|
80
|
+
* @type {string}
|
|
81
|
+
* @memberof UpdateActionRequestDto
|
|
82
|
+
*/
|
|
83
|
+
'productSlug'?: string;
|
|
72
84
|
/**
|
|
73
85
|
* Optional JSON Schema to validate input_payload when triggering the action
|
|
74
86
|
* @type {object}
|
package/models/action-class.ts
CHANGED
|
@@ -45,7 +45,13 @@ export interface ActionClass {
|
|
|
45
45
|
*/
|
|
46
46
|
'slug': string;
|
|
47
47
|
/**
|
|
48
|
-
* BPMN/workflow
|
|
48
|
+
* BPMN/workflow slug identifying the workflow to execute when this action is triggered
|
|
49
|
+
* @type {string}
|
|
50
|
+
* @memberof ActionClass
|
|
51
|
+
*/
|
|
52
|
+
'workflowSlug': string;
|
|
53
|
+
/**
|
|
54
|
+
* BPMN/workflow code resolved from workflow_slug or provided directly (used when triggering)
|
|
49
55
|
* @type {string}
|
|
50
56
|
* @memberof ActionClass
|
|
51
57
|
*/
|
|
@@ -33,11 +33,17 @@ export interface CreateActionRequestDto {
|
|
|
33
33
|
*/
|
|
34
34
|
'slug'?: string;
|
|
35
35
|
/**
|
|
36
|
-
* BPMN/workflow
|
|
36
|
+
* BPMN/workflow slug. When provided, productSlug and productVersionId are required to resolve the workflow. At least one of workflowSlug or workflowCode required.
|
|
37
37
|
* @type {string}
|
|
38
38
|
* @memberof CreateActionRequestDto
|
|
39
39
|
*/
|
|
40
|
-
'
|
|
40
|
+
'workflowSlug'?: string;
|
|
41
|
+
/**
|
|
42
|
+
* BPMN/workflow code. At least one of workflowSlug or workflowCode is required.
|
|
43
|
+
* @type {string}
|
|
44
|
+
* @memberof CreateActionRequestDto
|
|
45
|
+
*/
|
|
46
|
+
'workflowCode'?: string;
|
|
41
47
|
/**
|
|
42
48
|
* true = published (triggerable), false = draft. Default true.
|
|
43
49
|
* @type {boolean}
|
|
@@ -63,11 +69,17 @@ export interface CreateActionRequestDto {
|
|
|
63
69
|
*/
|
|
64
70
|
'entityType'?: CreateActionRequestDtoEntityTypeEnum;
|
|
65
71
|
/**
|
|
66
|
-
* Product version ID.
|
|
72
|
+
* Product version ID. Required for entity actions (when entityType is set).
|
|
67
73
|
* @type {number}
|
|
68
74
|
* @memberof CreateActionRequestDto
|
|
69
75
|
*/
|
|
70
76
|
'productVersionId'?: number;
|
|
77
|
+
/**
|
|
78
|
+
* Product slug. Required for entity actions (when entityType is set). Must match the product that owns productVersionId.
|
|
79
|
+
* @type {string}
|
|
80
|
+
* @memberof CreateActionRequestDto
|
|
81
|
+
*/
|
|
82
|
+
'productSlug'?: string;
|
|
71
83
|
/**
|
|
72
84
|
* Optional JSON Schema to validate input_payload when triggering the action
|
|
73
85
|
* @type {object}
|
|
@@ -39,7 +39,13 @@ export interface UpdateActionRequestDto {
|
|
|
39
39
|
*/
|
|
40
40
|
'slug'?: string;
|
|
41
41
|
/**
|
|
42
|
-
* BPMN/workflow
|
|
42
|
+
* BPMN/workflow slug. When provided, productSlug and productVersionId are required to resolve the workflow.
|
|
43
|
+
* @type {string}
|
|
44
|
+
* @memberof UpdateActionRequestDto
|
|
45
|
+
*/
|
|
46
|
+
'workflowSlug'?: string;
|
|
47
|
+
/**
|
|
48
|
+
* BPMN/workflow code. When provided, used directly (no product required for resolution).
|
|
43
49
|
* @type {string}
|
|
44
50
|
* @memberof UpdateActionRequestDto
|
|
45
51
|
*/
|
|
@@ -69,11 +75,17 @@ export interface UpdateActionRequestDto {
|
|
|
69
75
|
*/
|
|
70
76
|
'entityType'?: UpdateActionRequestDtoEntityTypeEnum;
|
|
71
77
|
/**
|
|
72
|
-
* Product version ID.
|
|
78
|
+
* Product version ID. Required when updating an entity action (entityType set).
|
|
73
79
|
* @type {number}
|
|
74
80
|
* @memberof UpdateActionRequestDto
|
|
75
81
|
*/
|
|
76
82
|
'productVersionId'?: number;
|
|
83
|
+
/**
|
|
84
|
+
* Product slug. Required when updating an entity action. Must match the product that owns productVersionId.
|
|
85
|
+
* @type {string}
|
|
86
|
+
* @memberof UpdateActionRequestDto
|
|
87
|
+
*/
|
|
88
|
+
'productSlug'?: string;
|
|
77
89
|
/**
|
|
78
90
|
* Optional JSON Schema to validate input_payload when triggering the action
|
|
79
91
|
* @type {object}
|