@emilgroup/action-sdk 1.1.1-beta.23 → 1.1.1-beta.27
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 +1 -3
- package/README.md +2 -2
- package/api/actions-api.ts +178 -249
- package/dist/api/actions-api.d.ts +125 -156
- package/dist/api/actions-api.js +107 -185
- package/dist/models/{export-actions-as-yaml-response-class.d.ts → action-ref-class.d.ts} +17 -5
- package/dist/models/action-version-class.d.ts +7 -0
- package/dist/models/index.d.ts +1 -3
- package/dist/models/index.js +1 -3
- package/models/{export-actions-as-yaml-response-class.ts → action-ref-class.ts} +17 -5
- package/models/action-version-class.ts +7 -0
- package/models/index.ts +1 -3
- package/package.json +1 -1
- package/dist/models/import-actions-from-yaml-request-dto.d.ts +0 -36
- package/dist/models/import-actions-from-yaml-request-dto.js +0 -15
- package/dist/models/import-actions-from-yaml-response-class.d.ts +0 -37
- package/dist/models/import-actions-from-yaml-response-class.js +0 -15
- package/models/import-actions-from-yaml-request-dto.ts +0 -42
- package/models/import-actions-from-yaml-response-class.ts +0 -43
- /package/dist/models/{export-actions-as-yaml-response-class.js → action-ref-class.js} +0 -0
package/api/actions-api.ts
CHANGED
|
@@ -25,16 +25,10 @@ import { CreateActionRequestDto } from '../models';
|
|
|
25
25
|
// @ts-ignore
|
|
26
26
|
import { CreateActionResponseClass } from '../models';
|
|
27
27
|
// @ts-ignore
|
|
28
|
-
import { ExportActionsAsYamlResponseClass } from '../models';
|
|
29
|
-
// @ts-ignore
|
|
30
28
|
import { GetActionResponseClass } from '../models';
|
|
31
29
|
// @ts-ignore
|
|
32
30
|
import { GetActionVersionResponseClass } from '../models';
|
|
33
31
|
// @ts-ignore
|
|
34
|
-
import { ImportActionsFromYamlRequestDto } from '../models';
|
|
35
|
-
// @ts-ignore
|
|
36
|
-
import { ImportActionsFromYamlResponseClass } from '../models';
|
|
37
|
-
// @ts-ignore
|
|
38
32
|
import { ListActionVersionsResponseClass } from '../models';
|
|
39
33
|
// @ts-ignore
|
|
40
34
|
import { ListActionsResponseClass } from '../models';
|
|
@@ -176,71 +170,6 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
176
170
|
|
|
177
171
|
|
|
178
172
|
|
|
179
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
180
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
181
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
182
|
-
|
|
183
|
-
return {
|
|
184
|
-
url: toPathString(localVarUrlObj),
|
|
185
|
-
options: localVarRequestOptions,
|
|
186
|
-
};
|
|
187
|
-
},
|
|
188
|
-
/**
|
|
189
|
-
* Exports entity actions for a product version as YAML (productSlug, productVersionId, entity_actions by type). **Required Permissions** \"action-management.actions.view\"
|
|
190
|
-
* @summary Retrieve the entity-actions-yaml
|
|
191
|
-
* @param {string} productSlug Product slug
|
|
192
|
-
* @param {number} productVersionId Product version ID
|
|
193
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
194
|
-
* @param {Array<string>} [actionSlugs] Optional list of action slugs to export; if omitted, all actions for the product version are exported
|
|
195
|
-
* @param {boolean} [includeDisabled] Include draft (disabled) actions
|
|
196
|
-
* @param {*} [options] Override http request option.
|
|
197
|
-
* @throws {RequiredError}
|
|
198
|
-
*/
|
|
199
|
-
exportActionsAsYaml: async (productSlug: string, productVersionId: number, authorization?: string, actionSlugs?: Array<string>, includeDisabled?: boolean, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
200
|
-
// verify required parameter 'productSlug' is not null or undefined
|
|
201
|
-
assertParamExists('exportActionsAsYaml', 'productSlug', productSlug)
|
|
202
|
-
// verify required parameter 'productVersionId' is not null or undefined
|
|
203
|
-
assertParamExists('exportActionsAsYaml', 'productVersionId', productVersionId)
|
|
204
|
-
const localVarPath = `/actionservice/v1/actions/entity-actions-yaml`;
|
|
205
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
206
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
207
|
-
let baseOptions;
|
|
208
|
-
let baseAccessToken;
|
|
209
|
-
if (configuration) {
|
|
210
|
-
baseOptions = configuration.baseOptions;
|
|
211
|
-
baseAccessToken = configuration.accessToken;
|
|
212
|
-
}
|
|
213
|
-
|
|
214
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
215
|
-
const localVarHeaderParameter = {} as any;
|
|
216
|
-
const localVarQueryParameter = {} as any;
|
|
217
|
-
|
|
218
|
-
// authentication bearer required
|
|
219
|
-
// http bearer authentication required
|
|
220
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
221
|
-
|
|
222
|
-
if (productSlug !== undefined) {
|
|
223
|
-
localVarQueryParameter['productSlug'] = productSlug;
|
|
224
|
-
}
|
|
225
|
-
|
|
226
|
-
if (productVersionId !== undefined) {
|
|
227
|
-
localVarQueryParameter['productVersionId'] = productVersionId;
|
|
228
|
-
}
|
|
229
|
-
|
|
230
|
-
if (actionSlugs) {
|
|
231
|
-
localVarQueryParameter['actionSlugs'] = actionSlugs;
|
|
232
|
-
}
|
|
233
|
-
|
|
234
|
-
if (includeDisabled !== undefined) {
|
|
235
|
-
localVarQueryParameter['includeDisabled'] = includeDisabled;
|
|
236
|
-
}
|
|
237
|
-
|
|
238
|
-
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
239
|
-
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
240
|
-
}
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
173
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
245
174
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
246
175
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -351,17 +280,25 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
351
280
|
};
|
|
352
281
|
},
|
|
353
282
|
/**
|
|
354
|
-
*
|
|
355
|
-
* @summary
|
|
356
|
-
* @param {
|
|
283
|
+
* Lists all versions for an action by code **Required Permissions** \"action-management.actions.view\"
|
|
284
|
+
* @summary List action versions
|
|
285
|
+
* @param {string} code Action code
|
|
357
286
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
287
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
288
|
+
* @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.
|
|
289
|
+
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
290
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
291
|
+
* @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, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy, owner</i>
|
|
292
|
+
* @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>
|
|
293
|
+
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
358
294
|
* @param {*} [options] Override http request option.
|
|
359
295
|
* @throws {RequiredError}
|
|
360
296
|
*/
|
|
361
|
-
|
|
362
|
-
// verify required parameter '
|
|
363
|
-
assertParamExists('
|
|
364
|
-
const localVarPath = `/actionservice/v1/actions/
|
|
297
|
+
listActionVersions: async (code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
298
|
+
// verify required parameter 'code' is not null or undefined
|
|
299
|
+
assertParamExists('listActionVersions', 'code', code)
|
|
300
|
+
const localVarPath = `/actionservice/v1/actions/{code}/versions`
|
|
301
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
365
302
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
366
303
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
367
304
|
let baseOptions;
|
|
@@ -371,7 +308,7 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
371
308
|
baseAccessToken = configuration.accessToken;
|
|
372
309
|
}
|
|
373
310
|
|
|
374
|
-
const localVarRequestOptions = { method: '
|
|
311
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
375
312
|
const localVarHeaderParameter = {} as any;
|
|
376
313
|
const localVarQueryParameter = {} as any;
|
|
377
314
|
|
|
@@ -379,18 +316,43 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
379
316
|
// http bearer authentication required
|
|
380
317
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
381
318
|
|
|
319
|
+
if (pageSize !== undefined) {
|
|
320
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
321
|
+
}
|
|
322
|
+
|
|
323
|
+
if (pageToken !== undefined) {
|
|
324
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
325
|
+
}
|
|
326
|
+
|
|
327
|
+
if (filter !== undefined) {
|
|
328
|
+
localVarQueryParameter['filter'] = filter;
|
|
329
|
+
}
|
|
330
|
+
|
|
331
|
+
if (search !== undefined) {
|
|
332
|
+
localVarQueryParameter['search'] = search;
|
|
333
|
+
}
|
|
334
|
+
|
|
335
|
+
if (order !== undefined) {
|
|
336
|
+
localVarQueryParameter['order'] = order;
|
|
337
|
+
}
|
|
338
|
+
|
|
339
|
+
if (expand !== undefined) {
|
|
340
|
+
localVarQueryParameter['expand'] = expand;
|
|
341
|
+
}
|
|
342
|
+
|
|
343
|
+
if (filters !== undefined) {
|
|
344
|
+
localVarQueryParameter['filters'] = filters;
|
|
345
|
+
}
|
|
346
|
+
|
|
382
347
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
383
348
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
384
349
|
}
|
|
385
350
|
|
|
386
351
|
|
|
387
352
|
|
|
388
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
389
|
-
|
|
390
353
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
391
354
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
392
355
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
393
|
-
localVarRequestOptions.data = serializeDataIfNeeded(importActionsFromYamlRequestDto, localVarRequestOptions, configuration)
|
|
394
356
|
|
|
395
357
|
return {
|
|
396
358
|
url: toPathString(localVarUrlObj),
|
|
@@ -398,25 +360,21 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
398
360
|
};
|
|
399
361
|
},
|
|
400
362
|
/**
|
|
401
|
-
* Lists all
|
|
402
|
-
* @summary List
|
|
403
|
-
* @param {string} code Action code
|
|
363
|
+
* Lists all action configurations with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
364
|
+
* @summary List actions
|
|
404
365
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
405
366
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
406
367
|
* @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.
|
|
407
|
-
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
368
|
+
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
408
369
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
409
370
|
* @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, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy, owner</i>
|
|
410
371
|
* @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>
|
|
411
|
-
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
372
|
+
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
412
373
|
* @param {*} [options] Override http request option.
|
|
413
374
|
* @throws {RequiredError}
|
|
414
375
|
*/
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
assertParamExists('listActionVersions', 'code', code)
|
|
418
|
-
const localVarPath = `/actionservice/v1/actions/{code}/versions`
|
|
419
|
-
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
376
|
+
listActions: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
377
|
+
const localVarPath = `/actionservice/v1/actions`;
|
|
420
378
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
421
379
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
422
380
|
let baseOptions;
|
|
@@ -478,21 +436,21 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
478
436
|
};
|
|
479
437
|
},
|
|
480
438
|
/**
|
|
481
|
-
* Lists all action
|
|
482
|
-
* @summary List
|
|
439
|
+
* Lists all action versions. Use filters e.g. isActive==true, entityType==LEAD, name, slug. No parent action code required. **Required Permissions** \"action-management.actions.view\"
|
|
440
|
+
* @summary List action versions
|
|
483
441
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
484
442
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
485
443
|
* @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.
|
|
486
|
-
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
444
|
+
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
487
445
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
488
446
|
* @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, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy, owner</i>
|
|
489
447
|
* @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>
|
|
490
|
-
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
448
|
+
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
491
449
|
* @param {*} [options] Override http request option.
|
|
492
450
|
* @throws {RequiredError}
|
|
493
451
|
*/
|
|
494
|
-
|
|
495
|
-
const localVarPath = `/actionservice/v1/actions`;
|
|
452
|
+
listAllActionVersions: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
453
|
+
const localVarPath = `/actionservice/v1/actions/versions`;
|
|
496
454
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
497
455
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
498
456
|
let baseOptions;
|
|
@@ -701,21 +659,6 @@ export const ActionsApiFp = function(configuration?: Configuration) {
|
|
|
701
659
|
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteActionVersion(versionCode, authorization, options);
|
|
702
660
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
703
661
|
},
|
|
704
|
-
/**
|
|
705
|
-
* Exports entity actions for a product version as YAML (productSlug, productVersionId, entity_actions by type). **Required Permissions** \"action-management.actions.view\"
|
|
706
|
-
* @summary Retrieve the entity-actions-yaml
|
|
707
|
-
* @param {string} productSlug Product slug
|
|
708
|
-
* @param {number} productVersionId Product version ID
|
|
709
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
710
|
-
* @param {Array<string>} [actionSlugs] Optional list of action slugs to export; if omitted, all actions for the product version are exported
|
|
711
|
-
* @param {boolean} [includeDisabled] Include draft (disabled) actions
|
|
712
|
-
* @param {*} [options] Override http request option.
|
|
713
|
-
* @throws {RequiredError}
|
|
714
|
-
*/
|
|
715
|
-
async exportActionsAsYaml(productSlug: string, productVersionId: number, authorization?: string, actionSlugs?: Array<string>, includeDisabled?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportActionsAsYamlResponseClass>> {
|
|
716
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.exportActionsAsYaml(productSlug, productVersionId, authorization, actionSlugs, includeDisabled, options);
|
|
717
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
718
|
-
},
|
|
719
662
|
/**
|
|
720
663
|
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
721
664
|
* @summary Retrieve the action
|
|
@@ -742,18 +685,6 @@ export const ActionsApiFp = function(configuration?: Configuration) {
|
|
|
742
685
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getActionVersion(versionCode, authorization, expand, options);
|
|
743
686
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
744
687
|
},
|
|
745
|
-
/**
|
|
746
|
-
* Imports entity actions from YAML for a product version. Validates YAML structure and workflow existence; creates or updates actions (never deletes). **Required Permissions** \"action-management.actions.create\"
|
|
747
|
-
* @summary Update the entity-actions-yaml
|
|
748
|
-
* @param {ImportActionsFromYamlRequestDto} importActionsFromYamlRequestDto
|
|
749
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
750
|
-
* @param {*} [options] Override http request option.
|
|
751
|
-
* @throws {RequiredError}
|
|
752
|
-
*/
|
|
753
|
-
async importActionsFromYaml(importActionsFromYamlRequestDto: ImportActionsFromYamlRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImportActionsFromYamlResponseClass>> {
|
|
754
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.importActionsFromYaml(importActionsFromYamlRequestDto, authorization, options);
|
|
755
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
756
|
-
},
|
|
757
688
|
/**
|
|
758
689
|
* Lists all versions for an action by code **Required Permissions** \"action-management.actions.view\"
|
|
759
690
|
* @summary List action versions
|
|
@@ -761,11 +692,11 @@ export const ActionsApiFp = function(configuration?: Configuration) {
|
|
|
761
692
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
762
693
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
763
694
|
* @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.
|
|
764
|
-
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
695
|
+
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
765
696
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
766
697
|
* @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, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy, owner</i>
|
|
767
698
|
* @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>
|
|
768
|
-
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
699
|
+
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
769
700
|
* @param {*} [options] Override http request option.
|
|
770
701
|
* @throws {RequiredError}
|
|
771
702
|
*/
|
|
@@ -779,11 +710,11 @@ export const ActionsApiFp = function(configuration?: Configuration) {
|
|
|
779
710
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
780
711
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
781
712
|
* @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.
|
|
782
|
-
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
713
|
+
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
783
714
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
784
715
|
* @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, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy, owner</i>
|
|
785
716
|
* @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>
|
|
786
|
-
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
717
|
+
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
787
718
|
* @param {*} [options] Override http request option.
|
|
788
719
|
* @throws {RequiredError}
|
|
789
720
|
*/
|
|
@@ -791,6 +722,24 @@ export const ActionsApiFp = function(configuration?: Configuration) {
|
|
|
791
722
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listActions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
792
723
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
793
724
|
},
|
|
725
|
+
/**
|
|
726
|
+
* Lists all action versions. Use filters e.g. isActive==true, entityType==LEAD, name, slug. No parent action code required. **Required Permissions** \"action-management.actions.view\"
|
|
727
|
+
* @summary List action versions
|
|
728
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
729
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
730
|
+
* @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.
|
|
731
|
+
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
732
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
733
|
+
* @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, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy, owner</i>
|
|
734
|
+
* @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>
|
|
735
|
+
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
736
|
+
* @param {*} [options] Override http request option.
|
|
737
|
+
* @throws {RequiredError}
|
|
738
|
+
*/
|
|
739
|
+
async listAllActionVersions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListActionVersionsResponseClass>> {
|
|
740
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listAllActionVersions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
741
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
742
|
+
},
|
|
794
743
|
/**
|
|
795
744
|
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\" **Required Permissions** \"action-management.actions.view\"
|
|
796
745
|
* @summary Update the action
|
|
@@ -860,20 +809,6 @@ export const ActionsApiFactory = function (configuration?: Configuration, basePa
|
|
|
860
809
|
deleteActionVersion(versionCode: string, authorization?: string, options?: any): AxiosPromise<void> {
|
|
861
810
|
return localVarFp.deleteActionVersion(versionCode, authorization, options).then((request) => request(axios, basePath));
|
|
862
811
|
},
|
|
863
|
-
/**
|
|
864
|
-
* Exports entity actions for a product version as YAML (productSlug, productVersionId, entity_actions by type). **Required Permissions** \"action-management.actions.view\"
|
|
865
|
-
* @summary Retrieve the entity-actions-yaml
|
|
866
|
-
* @param {string} productSlug Product slug
|
|
867
|
-
* @param {number} productVersionId Product version ID
|
|
868
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
869
|
-
* @param {Array<string>} [actionSlugs] Optional list of action slugs to export; if omitted, all actions for the product version are exported
|
|
870
|
-
* @param {boolean} [includeDisabled] Include draft (disabled) actions
|
|
871
|
-
* @param {*} [options] Override http request option.
|
|
872
|
-
* @throws {RequiredError}
|
|
873
|
-
*/
|
|
874
|
-
exportActionsAsYaml(productSlug: string, productVersionId: number, authorization?: string, actionSlugs?: Array<string>, includeDisabled?: boolean, options?: any): AxiosPromise<ExportActionsAsYamlResponseClass> {
|
|
875
|
-
return localVarFp.exportActionsAsYaml(productSlug, productVersionId, authorization, actionSlugs, includeDisabled, options).then((request) => request(axios, basePath));
|
|
876
|
-
},
|
|
877
812
|
/**
|
|
878
813
|
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
879
814
|
* @summary Retrieve the action
|
|
@@ -898,17 +833,6 @@ export const ActionsApiFactory = function (configuration?: Configuration, basePa
|
|
|
898
833
|
getActionVersion(versionCode: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetActionVersionResponseClass> {
|
|
899
834
|
return localVarFp.getActionVersion(versionCode, authorization, expand, options).then((request) => request(axios, basePath));
|
|
900
835
|
},
|
|
901
|
-
/**
|
|
902
|
-
* Imports entity actions from YAML for a product version. Validates YAML structure and workflow existence; creates or updates actions (never deletes). **Required Permissions** \"action-management.actions.create\"
|
|
903
|
-
* @summary Update the entity-actions-yaml
|
|
904
|
-
* @param {ImportActionsFromYamlRequestDto} importActionsFromYamlRequestDto
|
|
905
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
906
|
-
* @param {*} [options] Override http request option.
|
|
907
|
-
* @throws {RequiredError}
|
|
908
|
-
*/
|
|
909
|
-
importActionsFromYaml(importActionsFromYamlRequestDto: ImportActionsFromYamlRequestDto, authorization?: string, options?: any): AxiosPromise<ImportActionsFromYamlResponseClass> {
|
|
910
|
-
return localVarFp.importActionsFromYaml(importActionsFromYamlRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
911
|
-
},
|
|
912
836
|
/**
|
|
913
837
|
* Lists all versions for an action by code **Required Permissions** \"action-management.actions.view\"
|
|
914
838
|
* @summary List action versions
|
|
@@ -916,11 +840,11 @@ export const ActionsApiFactory = function (configuration?: Configuration, basePa
|
|
|
916
840
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
917
841
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
918
842
|
* @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.
|
|
919
|
-
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
843
|
+
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
920
844
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
921
845
|
* @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, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy, owner</i>
|
|
922
846
|
* @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>
|
|
923
|
-
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
847
|
+
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
924
848
|
* @param {*} [options] Override http request option.
|
|
925
849
|
* @throws {RequiredError}
|
|
926
850
|
*/
|
|
@@ -933,17 +857,34 @@ export const ActionsApiFactory = function (configuration?: Configuration, basePa
|
|
|
933
857
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
934
858
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
935
859
|
* @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.
|
|
936
|
-
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
860
|
+
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
937
861
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
938
862
|
* @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, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy, owner</i>
|
|
939
863
|
* @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>
|
|
940
|
-
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
864
|
+
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
941
865
|
* @param {*} [options] Override http request option.
|
|
942
866
|
* @throws {RequiredError}
|
|
943
867
|
*/
|
|
944
868
|
listActions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListActionsResponseClass> {
|
|
945
869
|
return localVarFp.listActions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
946
870
|
},
|
|
871
|
+
/**
|
|
872
|
+
* Lists all action versions. Use filters e.g. isActive==true, entityType==LEAD, name, slug. No parent action code required. **Required Permissions** \"action-management.actions.view\"
|
|
873
|
+
* @summary List action versions
|
|
874
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
875
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
876
|
+
* @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.
|
|
877
|
+
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
878
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
879
|
+
* @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, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy, owner</i>
|
|
880
|
+
* @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>
|
|
881
|
+
* @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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
882
|
+
* @param {*} [options] Override http request option.
|
|
883
|
+
* @throws {RequiredError}
|
|
884
|
+
*/
|
|
885
|
+
listAllActionVersions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListActionVersionsResponseClass> {
|
|
886
|
+
return localVarFp.listAllActionVersions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
887
|
+
},
|
|
947
888
|
/**
|
|
948
889
|
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\" **Required Permissions** \"action-management.actions.view\"
|
|
949
890
|
* @summary Update the action
|
|
@@ -1034,48 +975,6 @@ export interface ActionsApiDeleteActionVersionRequest {
|
|
|
1034
975
|
readonly authorization?: string
|
|
1035
976
|
}
|
|
1036
977
|
|
|
1037
|
-
/**
|
|
1038
|
-
* Request parameters for exportActionsAsYaml operation in ActionsApi.
|
|
1039
|
-
* @export
|
|
1040
|
-
* @interface ActionsApiExportActionsAsYamlRequest
|
|
1041
|
-
*/
|
|
1042
|
-
export interface ActionsApiExportActionsAsYamlRequest {
|
|
1043
|
-
/**
|
|
1044
|
-
* Product slug
|
|
1045
|
-
* @type {string}
|
|
1046
|
-
* @memberof ActionsApiExportActionsAsYaml
|
|
1047
|
-
*/
|
|
1048
|
-
readonly productSlug: string
|
|
1049
|
-
|
|
1050
|
-
/**
|
|
1051
|
-
* Product version ID
|
|
1052
|
-
* @type {number}
|
|
1053
|
-
* @memberof ActionsApiExportActionsAsYaml
|
|
1054
|
-
*/
|
|
1055
|
-
readonly productVersionId: number
|
|
1056
|
-
|
|
1057
|
-
/**
|
|
1058
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1059
|
-
* @type {string}
|
|
1060
|
-
* @memberof ActionsApiExportActionsAsYaml
|
|
1061
|
-
*/
|
|
1062
|
-
readonly authorization?: string
|
|
1063
|
-
|
|
1064
|
-
/**
|
|
1065
|
-
* Optional list of action slugs to export; if omitted, all actions for the product version are exported
|
|
1066
|
-
* @type {Array<string>}
|
|
1067
|
-
* @memberof ActionsApiExportActionsAsYaml
|
|
1068
|
-
*/
|
|
1069
|
-
readonly actionSlugs?: Array<string>
|
|
1070
|
-
|
|
1071
|
-
/**
|
|
1072
|
-
* Include draft (disabled) actions
|
|
1073
|
-
* @type {boolean}
|
|
1074
|
-
* @memberof ActionsApiExportActionsAsYaml
|
|
1075
|
-
*/
|
|
1076
|
-
readonly includeDisabled?: boolean
|
|
1077
|
-
}
|
|
1078
|
-
|
|
1079
978
|
/**
|
|
1080
979
|
* Request parameters for getAction operation in ActionsApi.
|
|
1081
980
|
* @export
|
|
@@ -1132,27 +1031,6 @@ export interface ActionsApiGetActionVersionRequest {
|
|
|
1132
1031
|
readonly expand?: string
|
|
1133
1032
|
}
|
|
1134
1033
|
|
|
1135
|
-
/**
|
|
1136
|
-
* Request parameters for importActionsFromYaml operation in ActionsApi.
|
|
1137
|
-
* @export
|
|
1138
|
-
* @interface ActionsApiImportActionsFromYamlRequest
|
|
1139
|
-
*/
|
|
1140
|
-
export interface ActionsApiImportActionsFromYamlRequest {
|
|
1141
|
-
/**
|
|
1142
|
-
*
|
|
1143
|
-
* @type {ImportActionsFromYamlRequestDto}
|
|
1144
|
-
* @memberof ActionsApiImportActionsFromYaml
|
|
1145
|
-
*/
|
|
1146
|
-
readonly importActionsFromYamlRequestDto: ImportActionsFromYamlRequestDto
|
|
1147
|
-
|
|
1148
|
-
/**
|
|
1149
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1150
|
-
* @type {string}
|
|
1151
|
-
* @memberof ActionsApiImportActionsFromYaml
|
|
1152
|
-
*/
|
|
1153
|
-
readonly authorization?: string
|
|
1154
|
-
}
|
|
1155
|
-
|
|
1156
1034
|
/**
|
|
1157
1035
|
* Request parameters for listActionVersions operation in ActionsApi.
|
|
1158
1036
|
* @export
|
|
@@ -1188,7 +1066,7 @@ export interface ActionsApiListActionVersionsRequest {
|
|
|
1188
1066
|
readonly pageToken?: string
|
|
1189
1067
|
|
|
1190
1068
|
/**
|
|
1191
|
-
* 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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
1069
|
+
* 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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
1192
1070
|
* @type {string}
|
|
1193
1071
|
* @memberof ActionsApiListActionVersions
|
|
1194
1072
|
*/
|
|
@@ -1216,7 +1094,7 @@ export interface ActionsApiListActionVersionsRequest {
|
|
|
1216
1094
|
readonly expand?: string
|
|
1217
1095
|
|
|
1218
1096
|
/**
|
|
1219
|
-
* 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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
1097
|
+
* 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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
1220
1098
|
* @type {string}
|
|
1221
1099
|
* @memberof ActionsApiListActionVersions
|
|
1222
1100
|
*/
|
|
@@ -1251,7 +1129,7 @@ export interface ActionsApiListActionsRequest {
|
|
|
1251
1129
|
readonly pageToken?: string
|
|
1252
1130
|
|
|
1253
1131
|
/**
|
|
1254
|
-
* 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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
1132
|
+
* 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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
1255
1133
|
* @type {string}
|
|
1256
1134
|
* @memberof ActionsApiListActions
|
|
1257
1135
|
*/
|
|
@@ -1279,13 +1157,76 @@ export interface ActionsApiListActionsRequest {
|
|
|
1279
1157
|
readonly expand?: string
|
|
1280
1158
|
|
|
1281
1159
|
/**
|
|
1282
|
-
* 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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy</i>
|
|
1160
|
+
* 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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
1283
1161
|
* @type {string}
|
|
1284
1162
|
* @memberof ActionsApiListActions
|
|
1285
1163
|
*/
|
|
1286
1164
|
readonly filters?: string
|
|
1287
1165
|
}
|
|
1288
1166
|
|
|
1167
|
+
/**
|
|
1168
|
+
* Request parameters for listAllActionVersions operation in ActionsApi.
|
|
1169
|
+
* @export
|
|
1170
|
+
* @interface ActionsApiListAllActionVersionsRequest
|
|
1171
|
+
*/
|
|
1172
|
+
export interface ActionsApiListAllActionVersionsRequest {
|
|
1173
|
+
/**
|
|
1174
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1175
|
+
* @type {string}
|
|
1176
|
+
* @memberof ActionsApiListAllActionVersions
|
|
1177
|
+
*/
|
|
1178
|
+
readonly authorization?: string
|
|
1179
|
+
|
|
1180
|
+
/**
|
|
1181
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
1182
|
+
* @type {number}
|
|
1183
|
+
* @memberof ActionsApiListAllActionVersions
|
|
1184
|
+
*/
|
|
1185
|
+
readonly pageSize?: number
|
|
1186
|
+
|
|
1187
|
+
/**
|
|
1188
|
+
* 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.
|
|
1189
|
+
* @type {string}
|
|
1190
|
+
* @memberof ActionsApiListAllActionVersions
|
|
1191
|
+
*/
|
|
1192
|
+
readonly pageToken?: string
|
|
1193
|
+
|
|
1194
|
+
/**
|
|
1195
|
+
* 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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
1196
|
+
* @type {string}
|
|
1197
|
+
* @memberof ActionsApiListAllActionVersions
|
|
1198
|
+
*/
|
|
1199
|
+
readonly filter?: string
|
|
1200
|
+
|
|
1201
|
+
/**
|
|
1202
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
1203
|
+
* @type {string}
|
|
1204
|
+
* @memberof ActionsApiListAllActionVersions
|
|
1205
|
+
*/
|
|
1206
|
+
readonly search?: string
|
|
1207
|
+
|
|
1208
|
+
/**
|
|
1209
|
+
* 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, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, createdAt, updatedAt, createdBy, updatedBy, owner</i>
|
|
1210
|
+
* @type {string}
|
|
1211
|
+
* @memberof ActionsApiListAllActionVersions
|
|
1212
|
+
*/
|
|
1213
|
+
readonly order?: string
|
|
1214
|
+
|
|
1215
|
+
/**
|
|
1216
|
+
* 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>
|
|
1217
|
+
* @type {string}
|
|
1218
|
+
* @memberof ActionsApiListAllActionVersions
|
|
1219
|
+
*/
|
|
1220
|
+
readonly expand?: string
|
|
1221
|
+
|
|
1222
|
+
/**
|
|
1223
|
+
* 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, actionConfigId, code, versionNumber, isActive, isAvailableInUi, workflowCode, workflowSlug, entityType, productVersionId, productSlug, owner, createdAt, updatedAt, createdBy, updatedBy, name, slug</i>
|
|
1224
|
+
* @type {string}
|
|
1225
|
+
* @memberof ActionsApiListAllActionVersions
|
|
1226
|
+
*/
|
|
1227
|
+
readonly filters?: string
|
|
1228
|
+
}
|
|
1229
|
+
|
|
1289
1230
|
/**
|
|
1290
1231
|
* Request parameters for updateAction operation in ActionsApi.
|
|
1291
1232
|
* @export
|
|
@@ -1385,18 +1326,6 @@ export class ActionsApi extends BaseAPI {
|
|
|
1385
1326
|
return ActionsApiFp(this.configuration).deleteActionVersion(requestParameters.versionCode, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
1386
1327
|
}
|
|
1387
1328
|
|
|
1388
|
-
/**
|
|
1389
|
-
* Exports entity actions for a product version as YAML (productSlug, productVersionId, entity_actions by type). **Required Permissions** \"action-management.actions.view\"
|
|
1390
|
-
* @summary Retrieve the entity-actions-yaml
|
|
1391
|
-
* @param {ActionsApiExportActionsAsYamlRequest} requestParameters Request parameters.
|
|
1392
|
-
* @param {*} [options] Override http request option.
|
|
1393
|
-
* @throws {RequiredError}
|
|
1394
|
-
* @memberof ActionsApi
|
|
1395
|
-
*/
|
|
1396
|
-
public exportActionsAsYaml(requestParameters: ActionsApiExportActionsAsYamlRequest, options?: AxiosRequestConfig) {
|
|
1397
|
-
return ActionsApiFp(this.configuration).exportActionsAsYaml(requestParameters.productSlug, requestParameters.productVersionId, requestParameters.authorization, requestParameters.actionSlugs, requestParameters.includeDisabled, options).then((request) => request(this.axios, this.basePath));
|
|
1398
|
-
}
|
|
1399
|
-
|
|
1400
1329
|
/**
|
|
1401
1330
|
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
1402
1331
|
* @summary Retrieve the action
|
|
@@ -1421,18 +1350,6 @@ export class ActionsApi extends BaseAPI {
|
|
|
1421
1350
|
return ActionsApiFp(this.configuration).getActionVersion(requestParameters.versionCode, requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
1422
1351
|
}
|
|
1423
1352
|
|
|
1424
|
-
/**
|
|
1425
|
-
* Imports entity actions from YAML for a product version. Validates YAML structure and workflow existence; creates or updates actions (never deletes). **Required Permissions** \"action-management.actions.create\"
|
|
1426
|
-
* @summary Update the entity-actions-yaml
|
|
1427
|
-
* @param {ActionsApiImportActionsFromYamlRequest} requestParameters Request parameters.
|
|
1428
|
-
* @param {*} [options] Override http request option.
|
|
1429
|
-
* @throws {RequiredError}
|
|
1430
|
-
* @memberof ActionsApi
|
|
1431
|
-
*/
|
|
1432
|
-
public importActionsFromYaml(requestParameters: ActionsApiImportActionsFromYamlRequest, options?: AxiosRequestConfig) {
|
|
1433
|
-
return ActionsApiFp(this.configuration).importActionsFromYaml(requestParameters.importActionsFromYamlRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
1434
|
-
}
|
|
1435
|
-
|
|
1436
1353
|
/**
|
|
1437
1354
|
* Lists all versions for an action by code **Required Permissions** \"action-management.actions.view\"
|
|
1438
1355
|
* @summary List action versions
|
|
@@ -1457,6 +1374,18 @@ export class ActionsApi extends BaseAPI {
|
|
|
1457
1374
|
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));
|
|
1458
1375
|
}
|
|
1459
1376
|
|
|
1377
|
+
/**
|
|
1378
|
+
* Lists all action versions. Use filters e.g. isActive==true, entityType==LEAD, name, slug. No parent action code required. **Required Permissions** \"action-management.actions.view\"
|
|
1379
|
+
* @summary List action versions
|
|
1380
|
+
* @param {ActionsApiListAllActionVersionsRequest} requestParameters Request parameters.
|
|
1381
|
+
* @param {*} [options] Override http request option.
|
|
1382
|
+
* @throws {RequiredError}
|
|
1383
|
+
* @memberof ActionsApi
|
|
1384
|
+
*/
|
|
1385
|
+
public listAllActionVersions(requestParameters: ActionsApiListAllActionVersionsRequest = {}, options?: AxiosRequestConfig) {
|
|
1386
|
+
return ActionsApiFp(this.configuration).listAllActionVersions(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
1387
|
+
}
|
|
1388
|
+
|
|
1460
1389
|
/**
|
|
1461
1390
|
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\" **Required Permissions** \"action-management.actions.view\"
|
|
1462
1391
|
* @summary Update the action
|