@emilgroup/action-sdk-node 1.0.1-beta.47 → 1.0.1-beta.51
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';
|
|
@@ -180,71 +174,6 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
180
174
|
|
|
181
175
|
|
|
182
176
|
|
|
183
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
184
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
185
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
186
|
-
|
|
187
|
-
return {
|
|
188
|
-
url: toPathString(localVarUrlObj),
|
|
189
|
-
options: localVarRequestOptions,
|
|
190
|
-
};
|
|
191
|
-
},
|
|
192
|
-
/**
|
|
193
|
-
* Exports entity actions for a product version as YAML (productSlug, productVersionId, entity_actions by type). **Required Permissions** \"action-management.actions.view\"
|
|
194
|
-
* @summary Retrieve the entity-actions-yaml
|
|
195
|
-
* @param {string} productSlug Product slug
|
|
196
|
-
* @param {number} productVersionId Product version ID
|
|
197
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
198
|
-
* @param {Array<string>} [actionSlugs] Optional list of action slugs to export; if omitted, all actions for the product version are exported
|
|
199
|
-
* @param {boolean} [includeDisabled] Include draft (disabled) actions
|
|
200
|
-
* @param {*} [options] Override http request option.
|
|
201
|
-
* @throws {RequiredError}
|
|
202
|
-
*/
|
|
203
|
-
exportActionsAsYaml: async (productSlug: string, productVersionId: number, authorization?: string, actionSlugs?: Array<string>, includeDisabled?: boolean, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
204
|
-
// verify required parameter 'productSlug' is not null or undefined
|
|
205
|
-
assertParamExists('exportActionsAsYaml', 'productSlug', productSlug)
|
|
206
|
-
// verify required parameter 'productVersionId' is not null or undefined
|
|
207
|
-
assertParamExists('exportActionsAsYaml', 'productVersionId', productVersionId)
|
|
208
|
-
const localVarPath = `/actionservice/v1/actions/entity-actions-yaml`;
|
|
209
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
210
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
211
|
-
let baseOptions;
|
|
212
|
-
let baseAccessToken;
|
|
213
|
-
if (configuration) {
|
|
214
|
-
baseOptions = configuration.baseOptions;
|
|
215
|
-
baseAccessToken = configuration.accessToken;
|
|
216
|
-
}
|
|
217
|
-
|
|
218
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
219
|
-
const localVarHeaderParameter = {} as any;
|
|
220
|
-
const localVarQueryParameter = {} as any;
|
|
221
|
-
|
|
222
|
-
// authentication bearer required
|
|
223
|
-
// http bearer authentication required
|
|
224
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
225
|
-
|
|
226
|
-
if (productSlug !== undefined) {
|
|
227
|
-
localVarQueryParameter['productSlug'] = productSlug;
|
|
228
|
-
}
|
|
229
|
-
|
|
230
|
-
if (productVersionId !== undefined) {
|
|
231
|
-
localVarQueryParameter['productVersionId'] = productVersionId;
|
|
232
|
-
}
|
|
233
|
-
|
|
234
|
-
if (actionSlugs) {
|
|
235
|
-
localVarQueryParameter['actionSlugs'] = actionSlugs;
|
|
236
|
-
}
|
|
237
|
-
|
|
238
|
-
if (includeDisabled !== undefined) {
|
|
239
|
-
localVarQueryParameter['includeDisabled'] = includeDisabled;
|
|
240
|
-
}
|
|
241
|
-
|
|
242
|
-
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
243
|
-
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
244
|
-
}
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
177
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
249
178
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
250
179
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -355,17 +284,25 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
355
284
|
};
|
|
356
285
|
},
|
|
357
286
|
/**
|
|
358
|
-
*
|
|
359
|
-
* @summary
|
|
360
|
-
* @param {
|
|
287
|
+
* Lists all versions for an action by code **Required Permissions** \"action-management.actions.view\"
|
|
288
|
+
* @summary List action versions
|
|
289
|
+
* @param {string} code Action code
|
|
361
290
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
291
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
292
|
+
* @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.
|
|
293
|
+
* @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>
|
|
294
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
295
|
+
* @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>
|
|
296
|
+
* @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>
|
|
297
|
+
* @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>
|
|
362
298
|
* @param {*} [options] Override http request option.
|
|
363
299
|
* @throws {RequiredError}
|
|
364
300
|
*/
|
|
365
|
-
|
|
366
|
-
// verify required parameter '
|
|
367
|
-
assertParamExists('
|
|
368
|
-
const localVarPath = `/actionservice/v1/actions/
|
|
301
|
+
listActionVersions: async (code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
302
|
+
// verify required parameter 'code' is not null or undefined
|
|
303
|
+
assertParamExists('listActionVersions', 'code', code)
|
|
304
|
+
const localVarPath = `/actionservice/v1/actions/{code}/versions`
|
|
305
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
369
306
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
370
307
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
371
308
|
let baseOptions;
|
|
@@ -375,7 +312,7 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
375
312
|
baseAccessToken = configuration.accessToken;
|
|
376
313
|
}
|
|
377
314
|
|
|
378
|
-
const localVarRequestOptions = { method: '
|
|
315
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
379
316
|
const localVarHeaderParameter = {} as any;
|
|
380
317
|
const localVarQueryParameter = {} as any;
|
|
381
318
|
|
|
@@ -383,18 +320,43 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
383
320
|
// http bearer authentication required
|
|
384
321
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
385
322
|
|
|
323
|
+
if (pageSize !== undefined) {
|
|
324
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
325
|
+
}
|
|
326
|
+
|
|
327
|
+
if (pageToken !== undefined) {
|
|
328
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
329
|
+
}
|
|
330
|
+
|
|
331
|
+
if (filter !== undefined) {
|
|
332
|
+
localVarQueryParameter['filter'] = filter;
|
|
333
|
+
}
|
|
334
|
+
|
|
335
|
+
if (search !== undefined) {
|
|
336
|
+
localVarQueryParameter['search'] = search;
|
|
337
|
+
}
|
|
338
|
+
|
|
339
|
+
if (order !== undefined) {
|
|
340
|
+
localVarQueryParameter['order'] = order;
|
|
341
|
+
}
|
|
342
|
+
|
|
343
|
+
if (expand !== undefined) {
|
|
344
|
+
localVarQueryParameter['expand'] = expand;
|
|
345
|
+
}
|
|
346
|
+
|
|
347
|
+
if (filters !== undefined) {
|
|
348
|
+
localVarQueryParameter['filters'] = filters;
|
|
349
|
+
}
|
|
350
|
+
|
|
386
351
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
387
352
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
388
353
|
}
|
|
389
354
|
|
|
390
355
|
|
|
391
356
|
|
|
392
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
393
|
-
|
|
394
357
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
395
358
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
396
359
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
397
|
-
localVarRequestOptions.data = serializeDataIfNeeded(importActionsFromYamlRequestDto, localVarRequestOptions, configuration)
|
|
398
360
|
|
|
399
361
|
return {
|
|
400
362
|
url: toPathString(localVarUrlObj),
|
|
@@ -402,25 +364,21 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
402
364
|
};
|
|
403
365
|
},
|
|
404
366
|
/**
|
|
405
|
-
* Lists all
|
|
406
|
-
* @summary List
|
|
407
|
-
* @param {string} code Action code
|
|
367
|
+
* Lists all action configurations with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
368
|
+
* @summary List actions
|
|
408
369
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
409
370
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
410
371
|
* @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.
|
|
411
|
-
* @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>
|
|
372
|
+
* @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>
|
|
412
373
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
413
374
|
* @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>
|
|
414
375
|
* @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>
|
|
415
|
-
* @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>
|
|
376
|
+
* @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>
|
|
416
377
|
* @param {*} [options] Override http request option.
|
|
417
378
|
* @throws {RequiredError}
|
|
418
379
|
*/
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
assertParamExists('listActionVersions', 'code', code)
|
|
422
|
-
const localVarPath = `/actionservice/v1/actions/{code}/versions`
|
|
423
|
-
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
380
|
+
listActions: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
381
|
+
const localVarPath = `/actionservice/v1/actions`;
|
|
424
382
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
425
383
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
426
384
|
let baseOptions;
|
|
@@ -482,21 +440,21 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
482
440
|
};
|
|
483
441
|
},
|
|
484
442
|
/**
|
|
485
|
-
* Lists all action
|
|
486
|
-
* @summary List
|
|
443
|
+
* 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\"
|
|
444
|
+
* @summary List action versions
|
|
487
445
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
488
446
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
489
447
|
* @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.
|
|
490
|
-
* @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>
|
|
448
|
+
* @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>
|
|
491
449
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
492
450
|
* @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>
|
|
493
451
|
* @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>
|
|
494
|
-
* @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>
|
|
452
|
+
* @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>
|
|
495
453
|
* @param {*} [options] Override http request option.
|
|
496
454
|
* @throws {RequiredError}
|
|
497
455
|
*/
|
|
498
|
-
|
|
499
|
-
const localVarPath = `/actionservice/v1/actions`;
|
|
456
|
+
listAllActionVersions: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
457
|
+
const localVarPath = `/actionservice/v1/actions/versions`;
|
|
500
458
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
501
459
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
502
460
|
let baseOptions;
|
|
@@ -705,21 +663,6 @@ export const ActionsApiFp = function(configuration?: Configuration) {
|
|
|
705
663
|
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteActionVersion(versionCode, authorization, options);
|
|
706
664
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
707
665
|
},
|
|
708
|
-
/**
|
|
709
|
-
* Exports entity actions for a product version as YAML (productSlug, productVersionId, entity_actions by type). **Required Permissions** \"action-management.actions.view\"
|
|
710
|
-
* @summary Retrieve the entity-actions-yaml
|
|
711
|
-
* @param {string} productSlug Product slug
|
|
712
|
-
* @param {number} productVersionId Product version ID
|
|
713
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
714
|
-
* @param {Array<string>} [actionSlugs] Optional list of action slugs to export; if omitted, all actions for the product version are exported
|
|
715
|
-
* @param {boolean} [includeDisabled] Include draft (disabled) actions
|
|
716
|
-
* @param {*} [options] Override http request option.
|
|
717
|
-
* @throws {RequiredError}
|
|
718
|
-
*/
|
|
719
|
-
async exportActionsAsYaml(productSlug: string, productVersionId: number, authorization?: string, actionSlugs?: Array<string>, includeDisabled?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportActionsAsYamlResponseClass>> {
|
|
720
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.exportActionsAsYaml(productSlug, productVersionId, authorization, actionSlugs, includeDisabled, options);
|
|
721
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
722
|
-
},
|
|
723
666
|
/**
|
|
724
667
|
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
725
668
|
* @summary Retrieve the action
|
|
@@ -746,18 +689,6 @@ export const ActionsApiFp = function(configuration?: Configuration) {
|
|
|
746
689
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getActionVersion(versionCode, authorization, expand, options);
|
|
747
690
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
748
691
|
},
|
|
749
|
-
/**
|
|
750
|
-
* 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\"
|
|
751
|
-
* @summary Update the entity-actions-yaml
|
|
752
|
-
* @param {ImportActionsFromYamlRequestDto} importActionsFromYamlRequestDto
|
|
753
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
754
|
-
* @param {*} [options] Override http request option.
|
|
755
|
-
* @throws {RequiredError}
|
|
756
|
-
*/
|
|
757
|
-
async importActionsFromYaml(importActionsFromYamlRequestDto: ImportActionsFromYamlRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImportActionsFromYamlResponseClass>> {
|
|
758
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.importActionsFromYaml(importActionsFromYamlRequestDto, authorization, options);
|
|
759
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
760
|
-
},
|
|
761
692
|
/**
|
|
762
693
|
* Lists all versions for an action by code **Required Permissions** \"action-management.actions.view\"
|
|
763
694
|
* @summary List action versions
|
|
@@ -765,11 +696,11 @@ export const ActionsApiFp = function(configuration?: Configuration) {
|
|
|
765
696
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
766
697
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
767
698
|
* @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.
|
|
768
|
-
* @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>
|
|
699
|
+
* @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>
|
|
769
700
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
770
701
|
* @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>
|
|
771
702
|
* @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>
|
|
772
|
-
* @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>
|
|
703
|
+
* @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>
|
|
773
704
|
* @param {*} [options] Override http request option.
|
|
774
705
|
* @throws {RequiredError}
|
|
775
706
|
*/
|
|
@@ -783,11 +714,11 @@ export const ActionsApiFp = function(configuration?: Configuration) {
|
|
|
783
714
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
784
715
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
785
716
|
* @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.
|
|
786
|
-
* @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>
|
|
717
|
+
* @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>
|
|
787
718
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
788
719
|
* @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>
|
|
789
720
|
* @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>
|
|
790
|
-
* @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>
|
|
721
|
+
* @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>
|
|
791
722
|
* @param {*} [options] Override http request option.
|
|
792
723
|
* @throws {RequiredError}
|
|
793
724
|
*/
|
|
@@ -795,6 +726,24 @@ export const ActionsApiFp = function(configuration?: Configuration) {
|
|
|
795
726
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listActions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
796
727
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
797
728
|
},
|
|
729
|
+
/**
|
|
730
|
+
* 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\"
|
|
731
|
+
* @summary List action versions
|
|
732
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
733
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
734
|
+
* @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.
|
|
735
|
+
* @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>
|
|
736
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
737
|
+
* @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>
|
|
738
|
+
* @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>
|
|
739
|
+
* @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>
|
|
740
|
+
* @param {*} [options] Override http request option.
|
|
741
|
+
* @throws {RequiredError}
|
|
742
|
+
*/
|
|
743
|
+
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>> {
|
|
744
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listAllActionVersions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
745
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
746
|
+
},
|
|
798
747
|
/**
|
|
799
748
|
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\" **Required Permissions** \"action-management.actions.view\"
|
|
800
749
|
* @summary Update the action
|
|
@@ -864,20 +813,6 @@ export const ActionsApiFactory = function (configuration?: Configuration, basePa
|
|
|
864
813
|
deleteActionVersion(versionCode: string, authorization?: string, options?: any): AxiosPromise<void> {
|
|
865
814
|
return localVarFp.deleteActionVersion(versionCode, authorization, options).then((request) => request(axios, basePath));
|
|
866
815
|
},
|
|
867
|
-
/**
|
|
868
|
-
* Exports entity actions for a product version as YAML (productSlug, productVersionId, entity_actions by type). **Required Permissions** \"action-management.actions.view\"
|
|
869
|
-
* @summary Retrieve the entity-actions-yaml
|
|
870
|
-
* @param {string} productSlug Product slug
|
|
871
|
-
* @param {number} productVersionId Product version ID
|
|
872
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
873
|
-
* @param {Array<string>} [actionSlugs] Optional list of action slugs to export; if omitted, all actions for the product version are exported
|
|
874
|
-
* @param {boolean} [includeDisabled] Include draft (disabled) actions
|
|
875
|
-
* @param {*} [options] Override http request option.
|
|
876
|
-
* @throws {RequiredError}
|
|
877
|
-
*/
|
|
878
|
-
exportActionsAsYaml(productSlug: string, productVersionId: number, authorization?: string, actionSlugs?: Array<string>, includeDisabled?: boolean, options?: any): AxiosPromise<ExportActionsAsYamlResponseClass> {
|
|
879
|
-
return localVarFp.exportActionsAsYaml(productSlug, productVersionId, authorization, actionSlugs, includeDisabled, options).then((request) => request(axios, basePath));
|
|
880
|
-
},
|
|
881
816
|
/**
|
|
882
817
|
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
883
818
|
* @summary Retrieve the action
|
|
@@ -902,17 +837,6 @@ export const ActionsApiFactory = function (configuration?: Configuration, basePa
|
|
|
902
837
|
getActionVersion(versionCode: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetActionVersionResponseClass> {
|
|
903
838
|
return localVarFp.getActionVersion(versionCode, authorization, expand, options).then((request) => request(axios, basePath));
|
|
904
839
|
},
|
|
905
|
-
/**
|
|
906
|
-
* 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\"
|
|
907
|
-
* @summary Update the entity-actions-yaml
|
|
908
|
-
* @param {ImportActionsFromYamlRequestDto} importActionsFromYamlRequestDto
|
|
909
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
910
|
-
* @param {*} [options] Override http request option.
|
|
911
|
-
* @throws {RequiredError}
|
|
912
|
-
*/
|
|
913
|
-
importActionsFromYaml(importActionsFromYamlRequestDto: ImportActionsFromYamlRequestDto, authorization?: string, options?: any): AxiosPromise<ImportActionsFromYamlResponseClass> {
|
|
914
|
-
return localVarFp.importActionsFromYaml(importActionsFromYamlRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
915
|
-
},
|
|
916
840
|
/**
|
|
917
841
|
* Lists all versions for an action by code **Required Permissions** \"action-management.actions.view\"
|
|
918
842
|
* @summary List action versions
|
|
@@ -920,11 +844,11 @@ export const ActionsApiFactory = function (configuration?: Configuration, basePa
|
|
|
920
844
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
921
845
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
922
846
|
* @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.
|
|
923
|
-
* @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>
|
|
847
|
+
* @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>
|
|
924
848
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
925
849
|
* @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>
|
|
926
850
|
* @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>
|
|
927
|
-
* @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>
|
|
851
|
+
* @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>
|
|
928
852
|
* @param {*} [options] Override http request option.
|
|
929
853
|
* @throws {RequiredError}
|
|
930
854
|
*/
|
|
@@ -937,17 +861,34 @@ export const ActionsApiFactory = function (configuration?: Configuration, basePa
|
|
|
937
861
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
938
862
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
939
863
|
* @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.
|
|
940
|
-
* @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>
|
|
864
|
+
* @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>
|
|
941
865
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
942
866
|
* @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>
|
|
943
867
|
* @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>
|
|
944
|
-
* @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>
|
|
868
|
+
* @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>
|
|
945
869
|
* @param {*} [options] Override http request option.
|
|
946
870
|
* @throws {RequiredError}
|
|
947
871
|
*/
|
|
948
872
|
listActions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListActionsResponseClass> {
|
|
949
873
|
return localVarFp.listActions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
950
874
|
},
|
|
875
|
+
/**
|
|
876
|
+
* 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\"
|
|
877
|
+
* @summary List action versions
|
|
878
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
879
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
880
|
+
* @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.
|
|
881
|
+
* @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>
|
|
882
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
883
|
+
* @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>
|
|
884
|
+
* @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>
|
|
885
|
+
* @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>
|
|
886
|
+
* @param {*} [options] Override http request option.
|
|
887
|
+
* @throws {RequiredError}
|
|
888
|
+
*/
|
|
889
|
+
listAllActionVersions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListActionVersionsResponseClass> {
|
|
890
|
+
return localVarFp.listAllActionVersions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
891
|
+
},
|
|
951
892
|
/**
|
|
952
893
|
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\" **Required Permissions** \"action-management.actions.view\"
|
|
953
894
|
* @summary Update the action
|
|
@@ -1038,48 +979,6 @@ export interface ActionsApiDeleteActionVersionRequest {
|
|
|
1038
979
|
readonly authorization?: string
|
|
1039
980
|
}
|
|
1040
981
|
|
|
1041
|
-
/**
|
|
1042
|
-
* Request parameters for exportActionsAsYaml operation in ActionsApi.
|
|
1043
|
-
* @export
|
|
1044
|
-
* @interface ActionsApiExportActionsAsYamlRequest
|
|
1045
|
-
*/
|
|
1046
|
-
export interface ActionsApiExportActionsAsYamlRequest {
|
|
1047
|
-
/**
|
|
1048
|
-
* Product slug
|
|
1049
|
-
* @type {string}
|
|
1050
|
-
* @memberof ActionsApiExportActionsAsYaml
|
|
1051
|
-
*/
|
|
1052
|
-
readonly productSlug: string
|
|
1053
|
-
|
|
1054
|
-
/**
|
|
1055
|
-
* Product version ID
|
|
1056
|
-
* @type {number}
|
|
1057
|
-
* @memberof ActionsApiExportActionsAsYaml
|
|
1058
|
-
*/
|
|
1059
|
-
readonly productVersionId: number
|
|
1060
|
-
|
|
1061
|
-
/**
|
|
1062
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1063
|
-
* @type {string}
|
|
1064
|
-
* @memberof ActionsApiExportActionsAsYaml
|
|
1065
|
-
*/
|
|
1066
|
-
readonly authorization?: string
|
|
1067
|
-
|
|
1068
|
-
/**
|
|
1069
|
-
* Optional list of action slugs to export; if omitted, all actions for the product version are exported
|
|
1070
|
-
* @type {Array<string>}
|
|
1071
|
-
* @memberof ActionsApiExportActionsAsYaml
|
|
1072
|
-
*/
|
|
1073
|
-
readonly actionSlugs?: Array<string>
|
|
1074
|
-
|
|
1075
|
-
/**
|
|
1076
|
-
* Include draft (disabled) actions
|
|
1077
|
-
* @type {boolean}
|
|
1078
|
-
* @memberof ActionsApiExportActionsAsYaml
|
|
1079
|
-
*/
|
|
1080
|
-
readonly includeDisabled?: boolean
|
|
1081
|
-
}
|
|
1082
|
-
|
|
1083
982
|
/**
|
|
1084
983
|
* Request parameters for getAction operation in ActionsApi.
|
|
1085
984
|
* @export
|
|
@@ -1136,27 +1035,6 @@ export interface ActionsApiGetActionVersionRequest {
|
|
|
1136
1035
|
readonly expand?: string
|
|
1137
1036
|
}
|
|
1138
1037
|
|
|
1139
|
-
/**
|
|
1140
|
-
* Request parameters for importActionsFromYaml operation in ActionsApi.
|
|
1141
|
-
* @export
|
|
1142
|
-
* @interface ActionsApiImportActionsFromYamlRequest
|
|
1143
|
-
*/
|
|
1144
|
-
export interface ActionsApiImportActionsFromYamlRequest {
|
|
1145
|
-
/**
|
|
1146
|
-
*
|
|
1147
|
-
* @type {ImportActionsFromYamlRequestDto}
|
|
1148
|
-
* @memberof ActionsApiImportActionsFromYaml
|
|
1149
|
-
*/
|
|
1150
|
-
readonly importActionsFromYamlRequestDto: ImportActionsFromYamlRequestDto
|
|
1151
|
-
|
|
1152
|
-
/**
|
|
1153
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1154
|
-
* @type {string}
|
|
1155
|
-
* @memberof ActionsApiImportActionsFromYaml
|
|
1156
|
-
*/
|
|
1157
|
-
readonly authorization?: string
|
|
1158
|
-
}
|
|
1159
|
-
|
|
1160
1038
|
/**
|
|
1161
1039
|
* Request parameters for listActionVersions operation in ActionsApi.
|
|
1162
1040
|
* @export
|
|
@@ -1192,7 +1070,7 @@ export interface ActionsApiListActionVersionsRequest {
|
|
|
1192
1070
|
readonly pageToken?: string
|
|
1193
1071
|
|
|
1194
1072
|
/**
|
|
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</i>
|
|
1073
|
+
* 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
1074
|
* @type {string}
|
|
1197
1075
|
* @memberof ActionsApiListActionVersions
|
|
1198
1076
|
*/
|
|
@@ -1220,7 +1098,7 @@ export interface ActionsApiListActionVersionsRequest {
|
|
|
1220
1098
|
readonly expand?: string
|
|
1221
1099
|
|
|
1222
1100
|
/**
|
|
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</i>
|
|
1101
|
+
* 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
1102
|
* @type {string}
|
|
1225
1103
|
* @memberof ActionsApiListActionVersions
|
|
1226
1104
|
*/
|
|
@@ -1255,7 +1133,7 @@ export interface ActionsApiListActionsRequest {
|
|
|
1255
1133
|
readonly pageToken?: string
|
|
1256
1134
|
|
|
1257
1135
|
/**
|
|
1258
|
-
* 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>
|
|
1136
|
+
* 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>
|
|
1259
1137
|
* @type {string}
|
|
1260
1138
|
* @memberof ActionsApiListActions
|
|
1261
1139
|
*/
|
|
@@ -1283,13 +1161,76 @@ export interface ActionsApiListActionsRequest {
|
|
|
1283
1161
|
readonly expand?: string
|
|
1284
1162
|
|
|
1285
1163
|
/**
|
|
1286
|
-
* 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>
|
|
1164
|
+
* 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>
|
|
1287
1165
|
* @type {string}
|
|
1288
1166
|
* @memberof ActionsApiListActions
|
|
1289
1167
|
*/
|
|
1290
1168
|
readonly filters?: string
|
|
1291
1169
|
}
|
|
1292
1170
|
|
|
1171
|
+
/**
|
|
1172
|
+
* Request parameters for listAllActionVersions operation in ActionsApi.
|
|
1173
|
+
* @export
|
|
1174
|
+
* @interface ActionsApiListAllActionVersionsRequest
|
|
1175
|
+
*/
|
|
1176
|
+
export interface ActionsApiListAllActionVersionsRequest {
|
|
1177
|
+
/**
|
|
1178
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1179
|
+
* @type {string}
|
|
1180
|
+
* @memberof ActionsApiListAllActionVersions
|
|
1181
|
+
*/
|
|
1182
|
+
readonly authorization?: string
|
|
1183
|
+
|
|
1184
|
+
/**
|
|
1185
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
1186
|
+
* @type {number}
|
|
1187
|
+
* @memberof ActionsApiListAllActionVersions
|
|
1188
|
+
*/
|
|
1189
|
+
readonly pageSize?: number
|
|
1190
|
+
|
|
1191
|
+
/**
|
|
1192
|
+
* 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.
|
|
1193
|
+
* @type {string}
|
|
1194
|
+
* @memberof ActionsApiListAllActionVersions
|
|
1195
|
+
*/
|
|
1196
|
+
readonly pageToken?: string
|
|
1197
|
+
|
|
1198
|
+
/**
|
|
1199
|
+
* 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>
|
|
1200
|
+
* @type {string}
|
|
1201
|
+
* @memberof ActionsApiListAllActionVersions
|
|
1202
|
+
*/
|
|
1203
|
+
readonly filter?: string
|
|
1204
|
+
|
|
1205
|
+
/**
|
|
1206
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
1207
|
+
* @type {string}
|
|
1208
|
+
* @memberof ActionsApiListAllActionVersions
|
|
1209
|
+
*/
|
|
1210
|
+
readonly search?: string
|
|
1211
|
+
|
|
1212
|
+
/**
|
|
1213
|
+
* 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>
|
|
1214
|
+
* @type {string}
|
|
1215
|
+
* @memberof ActionsApiListAllActionVersions
|
|
1216
|
+
*/
|
|
1217
|
+
readonly order?: string
|
|
1218
|
+
|
|
1219
|
+
/**
|
|
1220
|
+
* 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>
|
|
1221
|
+
* @type {string}
|
|
1222
|
+
* @memberof ActionsApiListAllActionVersions
|
|
1223
|
+
*/
|
|
1224
|
+
readonly expand?: string
|
|
1225
|
+
|
|
1226
|
+
/**
|
|
1227
|
+
* 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>
|
|
1228
|
+
* @type {string}
|
|
1229
|
+
* @memberof ActionsApiListAllActionVersions
|
|
1230
|
+
*/
|
|
1231
|
+
readonly filters?: string
|
|
1232
|
+
}
|
|
1233
|
+
|
|
1293
1234
|
/**
|
|
1294
1235
|
* Request parameters for updateAction operation in ActionsApi.
|
|
1295
1236
|
* @export
|
|
@@ -1389,18 +1330,6 @@ export class ActionsApi extends BaseAPI {
|
|
|
1389
1330
|
return ActionsApiFp(this.configuration).deleteActionVersion(requestParameters.versionCode, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
1390
1331
|
}
|
|
1391
1332
|
|
|
1392
|
-
/**
|
|
1393
|
-
* Exports entity actions for a product version as YAML (productSlug, productVersionId, entity_actions by type). **Required Permissions** \"action-management.actions.view\"
|
|
1394
|
-
* @summary Retrieve the entity-actions-yaml
|
|
1395
|
-
* @param {ActionsApiExportActionsAsYamlRequest} requestParameters Request parameters.
|
|
1396
|
-
* @param {*} [options] Override http request option.
|
|
1397
|
-
* @throws {RequiredError}
|
|
1398
|
-
* @memberof ActionsApi
|
|
1399
|
-
*/
|
|
1400
|
-
public exportActionsAsYaml(requestParameters: ActionsApiExportActionsAsYamlRequest, options?: AxiosRequestConfig) {
|
|
1401
|
-
return ActionsApiFp(this.configuration).exportActionsAsYaml(requestParameters.productSlug, requestParameters.productVersionId, requestParameters.authorization, requestParameters.actionSlugs, requestParameters.includeDisabled, options).then((request) => request(this.axios, this.basePath));
|
|
1402
|
-
}
|
|
1403
|
-
|
|
1404
1333
|
/**
|
|
1405
1334
|
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
1406
1335
|
* @summary Retrieve the action
|
|
@@ -1425,18 +1354,6 @@ export class ActionsApi extends BaseAPI {
|
|
|
1425
1354
|
return ActionsApiFp(this.configuration).getActionVersion(requestParameters.versionCode, requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
1426
1355
|
}
|
|
1427
1356
|
|
|
1428
|
-
/**
|
|
1429
|
-
* 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\"
|
|
1430
|
-
* @summary Update the entity-actions-yaml
|
|
1431
|
-
* @param {ActionsApiImportActionsFromYamlRequest} requestParameters Request parameters.
|
|
1432
|
-
* @param {*} [options] Override http request option.
|
|
1433
|
-
* @throws {RequiredError}
|
|
1434
|
-
* @memberof ActionsApi
|
|
1435
|
-
*/
|
|
1436
|
-
public importActionsFromYaml(requestParameters: ActionsApiImportActionsFromYamlRequest, options?: AxiosRequestConfig) {
|
|
1437
|
-
return ActionsApiFp(this.configuration).importActionsFromYaml(requestParameters.importActionsFromYamlRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
1438
|
-
}
|
|
1439
|
-
|
|
1440
1357
|
/**
|
|
1441
1358
|
* Lists all versions for an action by code **Required Permissions** \"action-management.actions.view\"
|
|
1442
1359
|
* @summary List action versions
|
|
@@ -1461,6 +1378,18 @@ export class ActionsApi extends BaseAPI {
|
|
|
1461
1378
|
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));
|
|
1462
1379
|
}
|
|
1463
1380
|
|
|
1381
|
+
/**
|
|
1382
|
+
* 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\"
|
|
1383
|
+
* @summary List action versions
|
|
1384
|
+
* @param {ActionsApiListAllActionVersionsRequest} requestParameters Request parameters.
|
|
1385
|
+
* @param {*} [options] Override http request option.
|
|
1386
|
+
* @throws {RequiredError}
|
|
1387
|
+
* @memberof ActionsApi
|
|
1388
|
+
*/
|
|
1389
|
+
public listAllActionVersions(requestParameters: ActionsApiListAllActionVersionsRequest = {}, options?: AxiosRequestConfig) {
|
|
1390
|
+
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));
|
|
1391
|
+
}
|
|
1392
|
+
|
|
1464
1393
|
/**
|
|
1465
1394
|
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\" **Required Permissions** \"action-management.actions.view\"
|
|
1466
1395
|
* @summary Update the action
|