@emilgroup/action-sdk 1.1.1-beta.6 → 1.2.0
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 +7 -0
- package/README.md +2 -2
- package/api/actions-api.ts +559 -130
- package/api/executions-api.ts +471 -0
- package/api.ts +2 -0
- package/dist/api/actions-api.d.ts +358 -112
- package/dist/api/actions-api.js +427 -97
- package/dist/api/executions-api.d.ts +272 -0
- package/dist/api/executions-api.js +452 -0
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/models/action-class.d.ts +9 -20
- package/dist/models/action-execution-class.d.ts +36 -0
- package/dist/models/action-ref-class.d.ts +36 -0
- package/dist/models/action-ref-class.js +15 -0
- package/dist/models/action-version-class.d.ts +127 -0
- package/dist/models/action-version-class.js +21 -0
- package/dist/models/create-action-request-dto.d.ts +47 -5
- package/dist/models/create-action-request-dto.js +6 -0
- package/dist/models/get-action-version-response-class.d.ts +25 -0
- package/dist/models/get-action-version-response-class.js +15 -0
- package/dist/models/index.d.ts +6 -0
- package/dist/models/index.js +6 -0
- package/dist/models/list-action-versions-response-class.d.ts +43 -0
- package/dist/models/list-action-versions-response-class.js +15 -0
- package/dist/models/trigger-action-request-dto.d.ts +62 -0
- package/dist/models/trigger-action-request-dto.js +15 -0
- package/dist/models/trigger-action-response-class.d.ts +25 -0
- package/dist/models/trigger-action-response-class.js +15 -0
- package/dist/models/update-action-request-dto.d.ts +41 -5
- package/dist/models/update-action-request-dto.js +6 -0
- package/models/action-class.ts +9 -20
- package/models/action-execution-class.ts +36 -0
- package/models/action-ref-class.ts +42 -0
- package/models/action-version-class.ts +136 -0
- package/models/create-action-request-dto.ts +50 -5
- package/models/get-action-version-response-class.ts +31 -0
- package/models/index.ts +6 -0
- package/models/list-action-versions-response-class.ts +49 -0
- package/models/trigger-action-request-dto.ts +66 -0
- package/models/trigger-action-response-class.ts +31 -0
- package/models/update-action-request-dto.ts +44 -5
- package/package.json +1 -1
package/api/actions-api.ts
CHANGED
|
@@ -25,11 +25,11 @@ import { CreateActionRequestDto } from '../models';
|
|
|
25
25
|
// @ts-ignore
|
|
26
26
|
import { CreateActionResponseClass } from '../models';
|
|
27
27
|
// @ts-ignore
|
|
28
|
-
import { GetActionExecutionStatusResponseClass } from '../models';
|
|
29
|
-
// @ts-ignore
|
|
30
28
|
import { GetActionResponseClass } from '../models';
|
|
31
29
|
// @ts-ignore
|
|
32
|
-
import {
|
|
30
|
+
import { GetActionVersionResponseClass } from '../models';
|
|
31
|
+
// @ts-ignore
|
|
32
|
+
import { ListActionVersionsResponseClass } from '../models';
|
|
33
33
|
// @ts-ignore
|
|
34
34
|
import { ListActionsResponseClass } from '../models';
|
|
35
35
|
// @ts-ignore
|
|
@@ -43,7 +43,7 @@ import { UpdateActionResponseClass } from '../models';
|
|
|
43
43
|
export const ActionsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
44
44
|
return {
|
|
45
45
|
/**
|
|
46
|
-
* Creates a new action configuration
|
|
46
|
+
* Creates a new action configuration **Required Permissions** \"action-management.actions.create\"
|
|
47
47
|
* @summary Create the action
|
|
48
48
|
* @param {CreateActionRequestDto} createActionRequestDto
|
|
49
49
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -90,7 +90,7 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
90
90
|
};
|
|
91
91
|
},
|
|
92
92
|
/**
|
|
93
|
-
* Deletes an action configuration by its code
|
|
93
|
+
* Deletes an action configuration by its code **Required Permissions** \"action-management.actions.delete\"
|
|
94
94
|
* @summary Delete the action
|
|
95
95
|
* @param {string} code Action code
|
|
96
96
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -135,14 +135,60 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
135
135
|
};
|
|
136
136
|
},
|
|
137
137
|
/**
|
|
138
|
-
*
|
|
138
|
+
* Deletes a specific action version by its version code **Required Permissions** \"action-management.actions.delete\"
|
|
139
|
+
* @summary Delete the action version
|
|
140
|
+
* @param {string} versionCode Version code (e.g. acv_<nanoid>)
|
|
141
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
142
|
+
* @param {*} [options] Override http request option.
|
|
143
|
+
* @throws {RequiredError}
|
|
144
|
+
*/
|
|
145
|
+
deleteActionVersion: async (versionCode: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
146
|
+
// verify required parameter 'versionCode' is not null or undefined
|
|
147
|
+
assertParamExists('deleteActionVersion', 'versionCode', versionCode)
|
|
148
|
+
const localVarPath = `/actionservice/v1/actions/versions/{versionCode}`
|
|
149
|
+
.replace(`{${"versionCode"}}`, encodeURIComponent(String(versionCode)));
|
|
150
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
151
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
152
|
+
let baseOptions;
|
|
153
|
+
let baseAccessToken;
|
|
154
|
+
if (configuration) {
|
|
155
|
+
baseOptions = configuration.baseOptions;
|
|
156
|
+
baseAccessToken = configuration.accessToken;
|
|
157
|
+
}
|
|
158
|
+
|
|
159
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
160
|
+
const localVarHeaderParameter = {} as any;
|
|
161
|
+
const localVarQueryParameter = {} as any;
|
|
162
|
+
|
|
163
|
+
// authentication bearer required
|
|
164
|
+
// http bearer authentication required
|
|
165
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
166
|
+
|
|
167
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
168
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
169
|
+
}
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
174
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
175
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
176
|
+
|
|
177
|
+
return {
|
|
178
|
+
url: toPathString(localVarUrlObj),
|
|
179
|
+
options: localVarRequestOptions,
|
|
180
|
+
};
|
|
181
|
+
},
|
|
182
|
+
/**
|
|
183
|
+
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
139
184
|
* @summary Retrieve the action
|
|
140
185
|
* @param {string} code Action code
|
|
141
186
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
187
|
+
* @param {string} [expand] Expand to fetch additional information (e.g. inputValidationSchema)
|
|
142
188
|
* @param {*} [options] Override http request option.
|
|
143
189
|
* @throws {RequiredError}
|
|
144
190
|
*/
|
|
145
|
-
getAction: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
191
|
+
getAction: async (code: string, authorization?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
146
192
|
// verify required parameter 'code' is not null or undefined
|
|
147
193
|
assertParamExists('getAction', 'code', code)
|
|
148
194
|
const localVarPath = `/actionservice/v1/actions/{code}`
|
|
@@ -164,6 +210,10 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
164
210
|
// http bearer authentication required
|
|
165
211
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
166
212
|
|
|
213
|
+
if (expand !== undefined) {
|
|
214
|
+
localVarQueryParameter['expand'] = expand;
|
|
215
|
+
}
|
|
216
|
+
|
|
167
217
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
168
218
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
169
219
|
}
|
|
@@ -180,16 +230,19 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
180
230
|
};
|
|
181
231
|
},
|
|
182
232
|
/**
|
|
183
|
-
*
|
|
184
|
-
* @summary Retrieve the
|
|
233
|
+
* Gets a specific action version by its version code **Required Permissions** \"action-management.actions.view\"
|
|
234
|
+
* @summary Retrieve the action version
|
|
235
|
+
* @param {string} versionCode Version code (e.g. acv_<nanoid>)
|
|
185
236
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
186
|
-
* @param {string} [
|
|
187
|
-
* @param {string} [correlationId] Correlation ID (e.g. webhook execution code that triggered this action execution)
|
|
237
|
+
* @param {string} [expand]
|
|
188
238
|
* @param {*} [options] Override http request option.
|
|
189
239
|
* @throws {RequiredError}
|
|
190
240
|
*/
|
|
191
|
-
|
|
192
|
-
|
|
241
|
+
getActionVersion: async (versionCode: string, authorization?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
242
|
+
// verify required parameter 'versionCode' is not null or undefined
|
|
243
|
+
assertParamExists('getActionVersion', 'versionCode', versionCode)
|
|
244
|
+
const localVarPath = `/actionservice/v1/actions/versions/{versionCode}`
|
|
245
|
+
.replace(`{${"versionCode"}}`, encodeURIComponent(String(versionCode)));
|
|
193
246
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
194
247
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
195
248
|
let baseOptions;
|
|
@@ -207,12 +260,8 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
207
260
|
// http bearer authentication required
|
|
208
261
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
209
262
|
|
|
210
|
-
if (
|
|
211
|
-
localVarQueryParameter['
|
|
212
|
-
}
|
|
213
|
-
|
|
214
|
-
if (correlationId !== undefined) {
|
|
215
|
-
localVarQueryParameter['correlationId'] = correlationId;
|
|
263
|
+
if (expand !== undefined) {
|
|
264
|
+
localVarQueryParameter['expand'] = expand;
|
|
216
265
|
}
|
|
217
266
|
|
|
218
267
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
@@ -231,21 +280,25 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
231
280
|
};
|
|
232
281
|
},
|
|
233
282
|
/**
|
|
234
|
-
* Lists
|
|
235
|
-
* @summary List
|
|
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
|
|
236
286
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
237
287
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
238
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.
|
|
239
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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>
|
|
240
290
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
241
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id,
|
|
242
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
243
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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>
|
|
244
294
|
* @param {*} [options] Override http request option.
|
|
245
295
|
* @throws {RequiredError}
|
|
246
296
|
*/
|
|
247
|
-
|
|
248
|
-
|
|
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)));
|
|
249
302
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
250
303
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
251
304
|
let baseOptions;
|
|
@@ -307,16 +360,16 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
307
360
|
};
|
|
308
361
|
},
|
|
309
362
|
/**
|
|
310
|
-
* Lists all action configurations with optional filters
|
|
363
|
+
* Lists all action configurations with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
311
364
|
* @summary List actions
|
|
312
365
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
313
366
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
314
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.
|
|
315
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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>
|
|
316
369
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
317
|
-
* @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,
|
|
318
|
-
* @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/>
|
|
319
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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>
|
|
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>
|
|
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>
|
|
320
373
|
* @param {*} [options] Override http request option.
|
|
321
374
|
* @throws {RequiredError}
|
|
322
375
|
*/
|
|
@@ -383,7 +436,83 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
383
436
|
};
|
|
384
437
|
},
|
|
385
438
|
/**
|
|
386
|
-
*
|
|
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
|
|
441
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
442
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
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.
|
|
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>
|
|
445
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
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>
|
|
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>
|
|
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>
|
|
449
|
+
* @param {*} [options] Override http request option.
|
|
450
|
+
* @throws {RequiredError}
|
|
451
|
+
*/
|
|
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`;
|
|
454
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
455
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
456
|
+
let baseOptions;
|
|
457
|
+
let baseAccessToken;
|
|
458
|
+
if (configuration) {
|
|
459
|
+
baseOptions = configuration.baseOptions;
|
|
460
|
+
baseAccessToken = configuration.accessToken;
|
|
461
|
+
}
|
|
462
|
+
|
|
463
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
464
|
+
const localVarHeaderParameter = {} as any;
|
|
465
|
+
const localVarQueryParameter = {} as any;
|
|
466
|
+
|
|
467
|
+
// authentication bearer required
|
|
468
|
+
// http bearer authentication required
|
|
469
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
470
|
+
|
|
471
|
+
if (pageSize !== undefined) {
|
|
472
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
473
|
+
}
|
|
474
|
+
|
|
475
|
+
if (pageToken !== undefined) {
|
|
476
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
477
|
+
}
|
|
478
|
+
|
|
479
|
+
if (filter !== undefined) {
|
|
480
|
+
localVarQueryParameter['filter'] = filter;
|
|
481
|
+
}
|
|
482
|
+
|
|
483
|
+
if (search !== undefined) {
|
|
484
|
+
localVarQueryParameter['search'] = search;
|
|
485
|
+
}
|
|
486
|
+
|
|
487
|
+
if (order !== undefined) {
|
|
488
|
+
localVarQueryParameter['order'] = order;
|
|
489
|
+
}
|
|
490
|
+
|
|
491
|
+
if (expand !== undefined) {
|
|
492
|
+
localVarQueryParameter['expand'] = expand;
|
|
493
|
+
}
|
|
494
|
+
|
|
495
|
+
if (filters !== undefined) {
|
|
496
|
+
localVarQueryParameter['filters'] = filters;
|
|
497
|
+
}
|
|
498
|
+
|
|
499
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
500
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
501
|
+
}
|
|
502
|
+
|
|
503
|
+
|
|
504
|
+
|
|
505
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
506
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
507
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
508
|
+
|
|
509
|
+
return {
|
|
510
|
+
url: toPathString(localVarUrlObj),
|
|
511
|
+
options: localVarRequestOptions,
|
|
512
|
+
};
|
|
513
|
+
},
|
|
514
|
+
/**
|
|
515
|
+
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\" **Required Permissions** \"action-management.actions.view\"
|
|
387
516
|
* @summary Update the action
|
|
388
517
|
* @param {string} code Action code
|
|
389
518
|
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
@@ -421,6 +550,57 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
421
550
|
|
|
422
551
|
|
|
423
552
|
|
|
553
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
554
|
+
|
|
555
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
556
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
557
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
558
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updateActionRequestDto, localVarRequestOptions, configuration)
|
|
559
|
+
|
|
560
|
+
return {
|
|
561
|
+
url: toPathString(localVarUrlObj),
|
|
562
|
+
options: localVarRequestOptions,
|
|
563
|
+
};
|
|
564
|
+
},
|
|
565
|
+
/**
|
|
566
|
+
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\" **Required Permissions** \"action-management.actions.view\"
|
|
567
|
+
* @summary Update the action
|
|
568
|
+
* @param {string} code Action code
|
|
569
|
+
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
570
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
571
|
+
* @param {*} [options] Override http request option.
|
|
572
|
+
* @throws {RequiredError}
|
|
573
|
+
*/
|
|
574
|
+
updateAction_1: async (code: string, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
575
|
+
// verify required parameter 'code' is not null or undefined
|
|
576
|
+
assertParamExists('updateAction_1', 'code', code)
|
|
577
|
+
// verify required parameter 'updateActionRequestDto' is not null or undefined
|
|
578
|
+
assertParamExists('updateAction_1', 'updateActionRequestDto', updateActionRequestDto)
|
|
579
|
+
const localVarPath = `/actionservice/v1/actions/{code}`
|
|
580
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
581
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
582
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
583
|
+
let baseOptions;
|
|
584
|
+
let baseAccessToken;
|
|
585
|
+
if (configuration) {
|
|
586
|
+
baseOptions = configuration.baseOptions;
|
|
587
|
+
baseAccessToken = configuration.accessToken;
|
|
588
|
+
}
|
|
589
|
+
|
|
590
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
591
|
+
const localVarHeaderParameter = {} as any;
|
|
592
|
+
const localVarQueryParameter = {} as any;
|
|
593
|
+
|
|
594
|
+
// authentication bearer required
|
|
595
|
+
// http bearer authentication required
|
|
596
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
597
|
+
|
|
598
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
599
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
600
|
+
}
|
|
601
|
+
|
|
602
|
+
|
|
603
|
+
|
|
424
604
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
425
605
|
|
|
426
606
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -444,7 +624,7 @@ export const ActionsApiFp = function(configuration?: Configuration) {
|
|
|
444
624
|
const localVarAxiosParamCreator = ActionsApiAxiosParamCreator(configuration)
|
|
445
625
|
return {
|
|
446
626
|
/**
|
|
447
|
-
* Creates a new action configuration
|
|
627
|
+
* Creates a new action configuration **Required Permissions** \"action-management.actions.create\"
|
|
448
628
|
* @summary Create the action
|
|
449
629
|
* @param {CreateActionRequestDto} createActionRequestDto
|
|
450
630
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -456,7 +636,7 @@ export const ActionsApiFp = function(configuration?: Configuration) {
|
|
|
456
636
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
457
637
|
},
|
|
458
638
|
/**
|
|
459
|
-
* Deletes an action configuration by its code
|
|
639
|
+
* Deletes an action configuration by its code **Required Permissions** \"action-management.actions.delete\"
|
|
460
640
|
* @summary Delete the action
|
|
461
641
|
* @param {string} code Action code
|
|
462
642
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -468,59 +648,73 @@ export const ActionsApiFp = function(configuration?: Configuration) {
|
|
|
468
648
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
469
649
|
},
|
|
470
650
|
/**
|
|
471
|
-
*
|
|
651
|
+
* Deletes a specific action version by its version code **Required Permissions** \"action-management.actions.delete\"
|
|
652
|
+
* @summary Delete the action version
|
|
653
|
+
* @param {string} versionCode Version code (e.g. acv_<nanoid>)
|
|
654
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
655
|
+
* @param {*} [options] Override http request option.
|
|
656
|
+
* @throws {RequiredError}
|
|
657
|
+
*/
|
|
658
|
+
async deleteActionVersion(versionCode: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
659
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteActionVersion(versionCode, authorization, options);
|
|
660
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
661
|
+
},
|
|
662
|
+
/**
|
|
663
|
+
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
472
664
|
* @summary Retrieve the action
|
|
473
665
|
* @param {string} code Action code
|
|
474
666
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
667
|
+
* @param {string} [expand] Expand to fetch additional information (e.g. inputValidationSchema)
|
|
475
668
|
* @param {*} [options] Override http request option.
|
|
476
669
|
* @throws {RequiredError}
|
|
477
670
|
*/
|
|
478
|
-
async getAction(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetActionResponseClass>> {
|
|
479
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getAction(code, authorization, options);
|
|
671
|
+
async getAction(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetActionResponseClass>> {
|
|
672
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getAction(code, authorization, expand, options);
|
|
480
673
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
481
674
|
},
|
|
482
675
|
/**
|
|
483
|
-
*
|
|
484
|
-
* @summary Retrieve the
|
|
676
|
+
* Gets a specific action version by its version code **Required Permissions** \"action-management.actions.view\"
|
|
677
|
+
* @summary Retrieve the action version
|
|
678
|
+
* @param {string} versionCode Version code (e.g. acv_<nanoid>)
|
|
485
679
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
486
|
-
* @param {string} [
|
|
487
|
-
* @param {string} [correlationId] Correlation ID (e.g. webhook execution code that triggered this action execution)
|
|
680
|
+
* @param {string} [expand]
|
|
488
681
|
* @param {*} [options] Override http request option.
|
|
489
682
|
* @throws {RequiredError}
|
|
490
683
|
*/
|
|
491
|
-
async
|
|
492
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
684
|
+
async getActionVersion(versionCode: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetActionVersionResponseClass>> {
|
|
685
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getActionVersion(versionCode, authorization, expand, options);
|
|
493
686
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
494
687
|
},
|
|
495
688
|
/**
|
|
496
|
-
* Lists
|
|
497
|
-
* @summary List
|
|
689
|
+
* Lists all versions for an action by code **Required Permissions** \"action-management.actions.view\"
|
|
690
|
+
* @summary List action versions
|
|
691
|
+
* @param {string} code Action code
|
|
498
692
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
499
693
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
500
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.
|
|
501
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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>
|
|
502
696
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
503
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id,
|
|
504
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
505
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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>
|
|
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>
|
|
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>
|
|
506
700
|
* @param {*} [options] Override http request option.
|
|
507
701
|
* @throws {RequiredError}
|
|
508
702
|
*/
|
|
509
|
-
async
|
|
510
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
703
|
+
async listActionVersions(code: string, 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>> {
|
|
704
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listActionVersions(code, authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
511
705
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
512
706
|
},
|
|
513
707
|
/**
|
|
514
|
-
* Lists all action configurations with optional filters
|
|
708
|
+
* Lists all action configurations with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
515
709
|
* @summary List actions
|
|
516
710
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
517
711
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
518
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.
|
|
519
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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>
|
|
520
714
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
521
|
-
* @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,
|
|
522
|
-
* @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/>
|
|
523
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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>
|
|
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>
|
|
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>
|
|
524
718
|
* @param {*} [options] Override http request option.
|
|
525
719
|
* @throws {RequiredError}
|
|
526
720
|
*/
|
|
@@ -529,7 +723,25 @@ export const ActionsApiFp = function(configuration?: Configuration) {
|
|
|
529
723
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
530
724
|
},
|
|
531
725
|
/**
|
|
532
|
-
*
|
|
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
|
+
},
|
|
743
|
+
/**
|
|
744
|
+
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\" **Required Permissions** \"action-management.actions.view\"
|
|
533
745
|
* @summary Update the action
|
|
534
746
|
* @param {string} code Action code
|
|
535
747
|
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
@@ -541,6 +753,19 @@ export const ActionsApiFp = function(configuration?: Configuration) {
|
|
|
541
753
|
const localVarAxiosArgs = await localVarAxiosParamCreator.updateAction(code, updateActionRequestDto, authorization, options);
|
|
542
754
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
543
755
|
},
|
|
756
|
+
/**
|
|
757
|
+
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\" **Required Permissions** \"action-management.actions.view\"
|
|
758
|
+
* @summary Update the action
|
|
759
|
+
* @param {string} code Action code
|
|
760
|
+
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
761
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
762
|
+
* @param {*} [options] Override http request option.
|
|
763
|
+
* @throws {RequiredError}
|
|
764
|
+
*/
|
|
765
|
+
async updateAction_1(code: string, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateActionResponseClass>> {
|
|
766
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateAction_1(code, updateActionRequestDto, authorization, options);
|
|
767
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
768
|
+
},
|
|
544
769
|
}
|
|
545
770
|
};
|
|
546
771
|
|
|
@@ -552,7 +777,7 @@ export const ActionsApiFactory = function (configuration?: Configuration, basePa
|
|
|
552
777
|
const localVarFp = ActionsApiFp(configuration)
|
|
553
778
|
return {
|
|
554
779
|
/**
|
|
555
|
-
* Creates a new action configuration
|
|
780
|
+
* Creates a new action configuration **Required Permissions** \"action-management.actions.create\"
|
|
556
781
|
* @summary Create the action
|
|
557
782
|
* @param {CreateActionRequestDto} createActionRequestDto
|
|
558
783
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -563,7 +788,7 @@ export const ActionsApiFactory = function (configuration?: Configuration, basePa
|
|
|
563
788
|
return localVarFp.createAction(createActionRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
564
789
|
},
|
|
565
790
|
/**
|
|
566
|
-
* Deletes an action configuration by its code
|
|
791
|
+
* Deletes an action configuration by its code **Required Permissions** \"action-management.actions.delete\"
|
|
567
792
|
* @summary Delete the action
|
|
568
793
|
* @param {string} code Action code
|
|
569
794
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -574,56 +799,69 @@ export const ActionsApiFactory = function (configuration?: Configuration, basePa
|
|
|
574
799
|
return localVarFp.deleteAction(code, authorization, options).then((request) => request(axios, basePath));
|
|
575
800
|
},
|
|
576
801
|
/**
|
|
577
|
-
*
|
|
802
|
+
* Deletes a specific action version by its version code **Required Permissions** \"action-management.actions.delete\"
|
|
803
|
+
* @summary Delete the action version
|
|
804
|
+
* @param {string} versionCode Version code (e.g. acv_<nanoid>)
|
|
805
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
806
|
+
* @param {*} [options] Override http request option.
|
|
807
|
+
* @throws {RequiredError}
|
|
808
|
+
*/
|
|
809
|
+
deleteActionVersion(versionCode: string, authorization?: string, options?: any): AxiosPromise<void> {
|
|
810
|
+
return localVarFp.deleteActionVersion(versionCode, authorization, options).then((request) => request(axios, basePath));
|
|
811
|
+
},
|
|
812
|
+
/**
|
|
813
|
+
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
578
814
|
* @summary Retrieve the action
|
|
579
815
|
* @param {string} code Action code
|
|
580
816
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
817
|
+
* @param {string} [expand] Expand to fetch additional information (e.g. inputValidationSchema)
|
|
581
818
|
* @param {*} [options] Override http request option.
|
|
582
819
|
* @throws {RequiredError}
|
|
583
820
|
*/
|
|
584
|
-
getAction(code: string, authorization?: string, options?: any): AxiosPromise<GetActionResponseClass> {
|
|
585
|
-
return localVarFp.getAction(code, authorization, options).then((request) => request(axios, basePath));
|
|
821
|
+
getAction(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetActionResponseClass> {
|
|
822
|
+
return localVarFp.getAction(code, authorization, expand, options).then((request) => request(axios, basePath));
|
|
586
823
|
},
|
|
587
824
|
/**
|
|
588
|
-
*
|
|
589
|
-
* @summary Retrieve the
|
|
825
|
+
* Gets a specific action version by its version code **Required Permissions** \"action-management.actions.view\"
|
|
826
|
+
* @summary Retrieve the action version
|
|
827
|
+
* @param {string} versionCode Version code (e.g. acv_<nanoid>)
|
|
590
828
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
591
|
-
* @param {string} [
|
|
592
|
-
* @param {string} [correlationId] Correlation ID (e.g. webhook execution code that triggered this action execution)
|
|
829
|
+
* @param {string} [expand]
|
|
593
830
|
* @param {*} [options] Override http request option.
|
|
594
831
|
* @throws {RequiredError}
|
|
595
832
|
*/
|
|
596
|
-
|
|
597
|
-
return localVarFp.
|
|
833
|
+
getActionVersion(versionCode: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetActionVersionResponseClass> {
|
|
834
|
+
return localVarFp.getActionVersion(versionCode, authorization, expand, options).then((request) => request(axios, basePath));
|
|
598
835
|
},
|
|
599
836
|
/**
|
|
600
|
-
* Lists
|
|
601
|
-
* @summary List
|
|
837
|
+
* Lists all versions for an action by code **Required Permissions** \"action-management.actions.view\"
|
|
838
|
+
* @summary List action versions
|
|
839
|
+
* @param {string} code Action code
|
|
602
840
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
603
841
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
604
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.
|
|
605
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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>
|
|
606
844
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
607
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id,
|
|
608
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
609
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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>
|
|
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>
|
|
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>
|
|
610
848
|
* @param {*} [options] Override http request option.
|
|
611
849
|
* @throws {RequiredError}
|
|
612
850
|
*/
|
|
613
|
-
|
|
614
|
-
return localVarFp.
|
|
851
|
+
listActionVersions(code: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListActionVersionsResponseClass> {
|
|
852
|
+
return localVarFp.listActionVersions(code, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
615
853
|
},
|
|
616
854
|
/**
|
|
617
|
-
* Lists all action configurations with optional filters
|
|
855
|
+
* Lists all action configurations with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
618
856
|
* @summary List actions
|
|
619
857
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
620
858
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
621
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.
|
|
622
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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>
|
|
623
861
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
624
|
-
* @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,
|
|
625
|
-
* @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/>
|
|
626
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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>
|
|
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>
|
|
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>
|
|
627
865
|
* @param {*} [options] Override http request option.
|
|
628
866
|
* @throws {RequiredError}
|
|
629
867
|
*/
|
|
@@ -631,7 +869,24 @@ export const ActionsApiFactory = function (configuration?: Configuration, basePa
|
|
|
631
869
|
return localVarFp.listActions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
632
870
|
},
|
|
633
871
|
/**
|
|
634
|
-
*
|
|
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
|
+
},
|
|
888
|
+
/**
|
|
889
|
+
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\" **Required Permissions** \"action-management.actions.view\"
|
|
635
890
|
* @summary Update the action
|
|
636
891
|
* @param {string} code Action code
|
|
637
892
|
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
@@ -642,6 +897,18 @@ export const ActionsApiFactory = function (configuration?: Configuration, basePa
|
|
|
642
897
|
updateAction(code: string, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateActionResponseClass> {
|
|
643
898
|
return localVarFp.updateAction(code, updateActionRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
644
899
|
},
|
|
900
|
+
/**
|
|
901
|
+
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\" **Required Permissions** \"action-management.actions.view\"
|
|
902
|
+
* @summary Update the action
|
|
903
|
+
* @param {string} code Action code
|
|
904
|
+
* @param {UpdateActionRequestDto} updateActionRequestDto
|
|
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
|
+
updateAction_1(code: string, updateActionRequestDto: UpdateActionRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateActionResponseClass> {
|
|
910
|
+
return localVarFp.updateAction_1(code, updateActionRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
911
|
+
},
|
|
645
912
|
};
|
|
646
913
|
};
|
|
647
914
|
|
|
@@ -687,6 +954,27 @@ export interface ActionsApiDeleteActionRequest {
|
|
|
687
954
|
readonly authorization?: string
|
|
688
955
|
}
|
|
689
956
|
|
|
957
|
+
/**
|
|
958
|
+
* Request parameters for deleteActionVersion operation in ActionsApi.
|
|
959
|
+
* @export
|
|
960
|
+
* @interface ActionsApiDeleteActionVersionRequest
|
|
961
|
+
*/
|
|
962
|
+
export interface ActionsApiDeleteActionVersionRequest {
|
|
963
|
+
/**
|
|
964
|
+
* Version code (e.g. acv_<nanoid>)
|
|
965
|
+
* @type {string}
|
|
966
|
+
* @memberof ActionsApiDeleteActionVersion
|
|
967
|
+
*/
|
|
968
|
+
readonly versionCode: string
|
|
969
|
+
|
|
970
|
+
/**
|
|
971
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
972
|
+
* @type {string}
|
|
973
|
+
* @memberof ActionsApiDeleteActionVersion
|
|
974
|
+
*/
|
|
975
|
+
readonly authorization?: string
|
|
976
|
+
}
|
|
977
|
+
|
|
690
978
|
/**
|
|
691
979
|
* Request parameters for getAction operation in ActionsApi.
|
|
692
980
|
* @export
|
|
@@ -706,95 +994,109 @@ export interface ActionsApiGetActionRequest {
|
|
|
706
994
|
* @memberof ActionsApiGetAction
|
|
707
995
|
*/
|
|
708
996
|
readonly authorization?: string
|
|
997
|
+
|
|
998
|
+
/**
|
|
999
|
+
* Expand to fetch additional information (e.g. inputValidationSchema)
|
|
1000
|
+
* @type {string}
|
|
1001
|
+
* @memberof ActionsApiGetAction
|
|
1002
|
+
*/
|
|
1003
|
+
readonly expand?: string
|
|
709
1004
|
}
|
|
710
1005
|
|
|
711
1006
|
/**
|
|
712
|
-
* Request parameters for
|
|
1007
|
+
* Request parameters for getActionVersion operation in ActionsApi.
|
|
713
1008
|
* @export
|
|
714
|
-
* @interface
|
|
1009
|
+
* @interface ActionsApiGetActionVersionRequest
|
|
715
1010
|
*/
|
|
716
|
-
export interface
|
|
1011
|
+
export interface ActionsApiGetActionVersionRequest {
|
|
717
1012
|
/**
|
|
718
|
-
*
|
|
1013
|
+
* Version code (e.g. acv_<nanoid>)
|
|
719
1014
|
* @type {string}
|
|
720
|
-
* @memberof
|
|
1015
|
+
* @memberof ActionsApiGetActionVersion
|
|
721
1016
|
*/
|
|
722
|
-
readonly
|
|
1017
|
+
readonly versionCode: string
|
|
723
1018
|
|
|
724
1019
|
/**
|
|
725
|
-
*
|
|
1020
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
726
1021
|
* @type {string}
|
|
727
|
-
* @memberof
|
|
1022
|
+
* @memberof ActionsApiGetActionVersion
|
|
728
1023
|
*/
|
|
729
|
-
readonly
|
|
1024
|
+
readonly authorization?: string
|
|
730
1025
|
|
|
731
1026
|
/**
|
|
732
|
-
*
|
|
1027
|
+
*
|
|
733
1028
|
* @type {string}
|
|
734
|
-
* @memberof
|
|
1029
|
+
* @memberof ActionsApiGetActionVersion
|
|
735
1030
|
*/
|
|
736
|
-
readonly
|
|
1031
|
+
readonly expand?: string
|
|
737
1032
|
}
|
|
738
1033
|
|
|
739
1034
|
/**
|
|
740
|
-
* Request parameters for
|
|
1035
|
+
* Request parameters for listActionVersions operation in ActionsApi.
|
|
741
1036
|
* @export
|
|
742
|
-
* @interface
|
|
1037
|
+
* @interface ActionsApiListActionVersionsRequest
|
|
743
1038
|
*/
|
|
744
|
-
export interface
|
|
1039
|
+
export interface ActionsApiListActionVersionsRequest {
|
|
1040
|
+
/**
|
|
1041
|
+
* Action code
|
|
1042
|
+
* @type {string}
|
|
1043
|
+
* @memberof ActionsApiListActionVersions
|
|
1044
|
+
*/
|
|
1045
|
+
readonly code: string
|
|
1046
|
+
|
|
745
1047
|
/**
|
|
746
1048
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
747
1049
|
* @type {string}
|
|
748
|
-
* @memberof
|
|
1050
|
+
* @memberof ActionsApiListActionVersions
|
|
749
1051
|
*/
|
|
750
1052
|
readonly authorization?: string
|
|
751
1053
|
|
|
752
1054
|
/**
|
|
753
1055
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
754
1056
|
* @type {number}
|
|
755
|
-
* @memberof
|
|
1057
|
+
* @memberof ActionsApiListActionVersions
|
|
756
1058
|
*/
|
|
757
1059
|
readonly pageSize?: number
|
|
758
1060
|
|
|
759
1061
|
/**
|
|
760
1062
|
* 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.
|
|
761
1063
|
* @type {string}
|
|
762
|
-
* @memberof
|
|
1064
|
+
* @memberof ActionsApiListActionVersions
|
|
763
1065
|
*/
|
|
764
1066
|
readonly pageToken?: string
|
|
765
1067
|
|
|
766
1068
|
/**
|
|
767
|
-
* Filter the response by one or multiple fields.
|
|
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>
|
|
768
1070
|
* @type {string}
|
|
769
|
-
* @memberof
|
|
1071
|
+
* @memberof ActionsApiListActionVersions
|
|
770
1072
|
*/
|
|
771
1073
|
readonly filter?: string
|
|
772
1074
|
|
|
773
1075
|
/**
|
|
774
1076
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
775
1077
|
* @type {string}
|
|
776
|
-
* @memberof
|
|
1078
|
+
* @memberof ActionsApiListActionVersions
|
|
777
1079
|
*/
|
|
778
1080
|
readonly search?: string
|
|
779
1081
|
|
|
780
1082
|
/**
|
|
781
|
-
* 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,
|
|
1083
|
+
* 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>
|
|
782
1084
|
* @type {string}
|
|
783
|
-
* @memberof
|
|
1085
|
+
* @memberof ActionsApiListActionVersions
|
|
784
1086
|
*/
|
|
785
1087
|
readonly order?: string
|
|
786
1088
|
|
|
787
1089
|
/**
|
|
788
|
-
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
1090
|
+
* 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>
|
|
789
1091
|
* @type {string}
|
|
790
|
-
* @memberof
|
|
1092
|
+
* @memberof ActionsApiListActionVersions
|
|
791
1093
|
*/
|
|
792
1094
|
readonly expand?: string
|
|
793
1095
|
|
|
794
1096
|
/**
|
|
795
|
-
* Filters the response by one or multiple fields.
|
|
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>
|
|
796
1098
|
* @type {string}
|
|
797
|
-
* @memberof
|
|
1099
|
+
* @memberof ActionsApiListActionVersions
|
|
798
1100
|
*/
|
|
799
1101
|
readonly filters?: string
|
|
800
1102
|
}
|
|
@@ -827,7 +1129,7 @@ export interface ActionsApiListActionsRequest {
|
|
|
827
1129
|
readonly pageToken?: string
|
|
828
1130
|
|
|
829
1131
|
/**
|
|
830
|
-
* Filter the response by one or multiple fields.
|
|
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>
|
|
831
1133
|
* @type {string}
|
|
832
1134
|
* @memberof ActionsApiListActions
|
|
833
1135
|
*/
|
|
@@ -841,27 +1143,90 @@ export interface ActionsApiListActionsRequest {
|
|
|
841
1143
|
readonly search?: string
|
|
842
1144
|
|
|
843
1145
|
/**
|
|
844
|
-
* 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,
|
|
1146
|
+
* 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>
|
|
845
1147
|
* @type {string}
|
|
846
1148
|
* @memberof ActionsApiListActions
|
|
847
1149
|
*/
|
|
848
1150
|
readonly order?: string
|
|
849
1151
|
|
|
850
1152
|
/**
|
|
851
|
-
* 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/>
|
|
1153
|
+
* 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>
|
|
852
1154
|
* @type {string}
|
|
853
1155
|
* @memberof ActionsApiListActions
|
|
854
1156
|
*/
|
|
855
1157
|
readonly expand?: string
|
|
856
1158
|
|
|
857
1159
|
/**
|
|
858
|
-
* Filters the response by one or multiple fields.
|
|
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>
|
|
859
1161
|
* @type {string}
|
|
860
1162
|
* @memberof ActionsApiListActions
|
|
861
1163
|
*/
|
|
862
1164
|
readonly filters?: string
|
|
863
1165
|
}
|
|
864
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
|
+
|
|
865
1230
|
/**
|
|
866
1231
|
* Request parameters for updateAction operation in ActionsApi.
|
|
867
1232
|
* @export
|
|
@@ -890,6 +1255,34 @@ export interface ActionsApiUpdateActionRequest {
|
|
|
890
1255
|
readonly authorization?: string
|
|
891
1256
|
}
|
|
892
1257
|
|
|
1258
|
+
/**
|
|
1259
|
+
* Request parameters for updateAction_1 operation in ActionsApi.
|
|
1260
|
+
* @export
|
|
1261
|
+
* @interface ActionsApiUpdateAction0Request
|
|
1262
|
+
*/
|
|
1263
|
+
export interface ActionsApiUpdateAction0Request {
|
|
1264
|
+
/**
|
|
1265
|
+
* Action code
|
|
1266
|
+
* @type {string}
|
|
1267
|
+
* @memberof ActionsApiUpdateAction0
|
|
1268
|
+
*/
|
|
1269
|
+
readonly code: string
|
|
1270
|
+
|
|
1271
|
+
/**
|
|
1272
|
+
*
|
|
1273
|
+
* @type {UpdateActionRequestDto}
|
|
1274
|
+
* @memberof ActionsApiUpdateAction0
|
|
1275
|
+
*/
|
|
1276
|
+
readonly updateActionRequestDto: UpdateActionRequestDto
|
|
1277
|
+
|
|
1278
|
+
/**
|
|
1279
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1280
|
+
* @type {string}
|
|
1281
|
+
* @memberof ActionsApiUpdateAction0
|
|
1282
|
+
*/
|
|
1283
|
+
readonly authorization?: string
|
|
1284
|
+
}
|
|
1285
|
+
|
|
893
1286
|
/**
|
|
894
1287
|
* ActionsApi - object-oriented interface
|
|
895
1288
|
* @export
|
|
@@ -898,7 +1291,7 @@ export interface ActionsApiUpdateActionRequest {
|
|
|
898
1291
|
*/
|
|
899
1292
|
export class ActionsApi extends BaseAPI {
|
|
900
1293
|
/**
|
|
901
|
-
* Creates a new action configuration
|
|
1294
|
+
* Creates a new action configuration **Required Permissions** \"action-management.actions.create\"
|
|
902
1295
|
* @summary Create the action
|
|
903
1296
|
* @param {ActionsApiCreateActionRequest} requestParameters Request parameters.
|
|
904
1297
|
* @param {*} [options] Override http request option.
|
|
@@ -910,7 +1303,7 @@ export class ActionsApi extends BaseAPI {
|
|
|
910
1303
|
}
|
|
911
1304
|
|
|
912
1305
|
/**
|
|
913
|
-
* Deletes an action configuration by its code
|
|
1306
|
+
* Deletes an action configuration by its code **Required Permissions** \"action-management.actions.delete\"
|
|
914
1307
|
* @summary Delete the action
|
|
915
1308
|
* @param {ActionsApiDeleteActionRequest} requestParameters Request parameters.
|
|
916
1309
|
* @param {*} [options] Override http request option.
|
|
@@ -922,7 +1315,19 @@ export class ActionsApi extends BaseAPI {
|
|
|
922
1315
|
}
|
|
923
1316
|
|
|
924
1317
|
/**
|
|
925
|
-
*
|
|
1318
|
+
* Deletes a specific action version by its version code **Required Permissions** \"action-management.actions.delete\"
|
|
1319
|
+
* @summary Delete the action version
|
|
1320
|
+
* @param {ActionsApiDeleteActionVersionRequest} requestParameters Request parameters.
|
|
1321
|
+
* @param {*} [options] Override http request option.
|
|
1322
|
+
* @throws {RequiredError}
|
|
1323
|
+
* @memberof ActionsApi
|
|
1324
|
+
*/
|
|
1325
|
+
public deleteActionVersion(requestParameters: ActionsApiDeleteActionVersionRequest, options?: AxiosRequestConfig) {
|
|
1326
|
+
return ActionsApiFp(this.configuration).deleteActionVersion(requestParameters.versionCode, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
1327
|
+
}
|
|
1328
|
+
|
|
1329
|
+
/**
|
|
1330
|
+
* Retrieves an action configuration by its code **Required Permissions** \"action-management.actions.view\"
|
|
926
1331
|
* @summary Retrieve the action
|
|
927
1332
|
* @param {ActionsApiGetActionRequest} requestParameters Request parameters.
|
|
928
1333
|
* @param {*} [options] Override http request option.
|
|
@@ -930,35 +1335,35 @@ export class ActionsApi extends BaseAPI {
|
|
|
930
1335
|
* @memberof ActionsApi
|
|
931
1336
|
*/
|
|
932
1337
|
public getAction(requestParameters: ActionsApiGetActionRequest, options?: AxiosRequestConfig) {
|
|
933
|
-
return ActionsApiFp(this.configuration).getAction(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
1338
|
+
return ActionsApiFp(this.configuration).getAction(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
934
1339
|
}
|
|
935
1340
|
|
|
936
1341
|
/**
|
|
937
|
-
*
|
|
938
|
-
* @summary Retrieve the
|
|
939
|
-
* @param {
|
|
1342
|
+
* Gets a specific action version by its version code **Required Permissions** \"action-management.actions.view\"
|
|
1343
|
+
* @summary Retrieve the action version
|
|
1344
|
+
* @param {ActionsApiGetActionVersionRequest} requestParameters Request parameters.
|
|
940
1345
|
* @param {*} [options] Override http request option.
|
|
941
1346
|
* @throws {RequiredError}
|
|
942
1347
|
* @memberof ActionsApi
|
|
943
1348
|
*/
|
|
944
|
-
public
|
|
945
|
-
return ActionsApiFp(this.configuration).
|
|
1349
|
+
public getActionVersion(requestParameters: ActionsApiGetActionVersionRequest, options?: AxiosRequestConfig) {
|
|
1350
|
+
return ActionsApiFp(this.configuration).getActionVersion(requestParameters.versionCode, requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
946
1351
|
}
|
|
947
1352
|
|
|
948
1353
|
/**
|
|
949
|
-
* Lists
|
|
950
|
-
* @summary List
|
|
951
|
-
* @param {
|
|
1354
|
+
* Lists all versions for an action by code **Required Permissions** \"action-management.actions.view\"
|
|
1355
|
+
* @summary List action versions
|
|
1356
|
+
* @param {ActionsApiListActionVersionsRequest} requestParameters Request parameters.
|
|
952
1357
|
* @param {*} [options] Override http request option.
|
|
953
1358
|
* @throws {RequiredError}
|
|
954
1359
|
* @memberof ActionsApi
|
|
955
1360
|
*/
|
|
956
|
-
public
|
|
957
|
-
return ActionsApiFp(this.configuration).
|
|
1361
|
+
public listActionVersions(requestParameters: ActionsApiListActionVersionsRequest, options?: AxiosRequestConfig) {
|
|
1362
|
+
return ActionsApiFp(this.configuration).listActionVersions(requestParameters.code, requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
958
1363
|
}
|
|
959
1364
|
|
|
960
1365
|
/**
|
|
961
|
-
* Lists all action configurations with optional filters
|
|
1366
|
+
* Lists all action configurations with optional filters **Required Permissions** \"action-management.actions.view\"
|
|
962
1367
|
* @summary List actions
|
|
963
1368
|
* @param {ActionsApiListActionsRequest} requestParameters Request parameters.
|
|
964
1369
|
* @param {*} [options] Override http request option.
|
|
@@ -970,7 +1375,19 @@ export class ActionsApi extends BaseAPI {
|
|
|
970
1375
|
}
|
|
971
1376
|
|
|
972
1377
|
/**
|
|
973
|
-
*
|
|
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
|
+
|
|
1389
|
+
/**
|
|
1390
|
+
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\" **Required Permissions** \"action-management.actions.view\"
|
|
974
1391
|
* @summary Update the action
|
|
975
1392
|
* @param {ActionsApiUpdateActionRequest} requestParameters Request parameters.
|
|
976
1393
|
* @param {*} [options] Override http request option.
|
|
@@ -980,4 +1397,16 @@ export class ActionsApi extends BaseAPI {
|
|
|
980
1397
|
public updateAction(requestParameters: ActionsApiUpdateActionRequest, options?: AxiosRequestConfig) {
|
|
981
1398
|
return ActionsApiFp(this.configuration).updateAction(requestParameters.code, requestParameters.updateActionRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
982
1399
|
}
|
|
1400
|
+
|
|
1401
|
+
/**
|
|
1402
|
+
* Updates an existing action configuration (patch semantics) **Required Permissions** \"action-management.actions.update\" **Required Permissions** \"action-management.actions.view\"
|
|
1403
|
+
* @summary Update the action
|
|
1404
|
+
* @param {ActionsApiUpdateAction0Request} requestParameters Request parameters.
|
|
1405
|
+
* @param {*} [options] Override http request option.
|
|
1406
|
+
* @throws {RequiredError}
|
|
1407
|
+
* @memberof ActionsApi
|
|
1408
|
+
*/
|
|
1409
|
+
public updateAction_1(requestParameters: ActionsApiUpdateAction0Request, options?: AxiosRequestConfig) {
|
|
1410
|
+
return ActionsApiFp(this.configuration).updateAction_1(requestParameters.code, requestParameters.updateActionRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
1411
|
+
}
|
|
983
1412
|
}
|