@emilgroup/task-sdk-node 1.7.1-beta.3 → 1.7.1-beta.31

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.
Files changed (45) hide show
  1. package/.openapi-generator/FILES +8 -0
  2. package/README.md +2 -2
  3. package/api/filters-api.ts +131 -24
  4. package/api/task-client-api.ts +257 -8
  5. package/api/tasks-api.ts +257 -8
  6. package/dist/api/filters-api.d.ts +81 -24
  7. package/dist/api/filters-api.js +112 -19
  8. package/dist/api/task-client-api.d.ts +148 -8
  9. package/dist/api/task-client-api.js +209 -6
  10. package/dist/api/tasks-api.d.ts +148 -8
  11. package/dist/api/tasks-api.js +209 -6
  12. package/dist/models/add-secondary-link-response-class.d.ts +25 -0
  13. package/dist/models/add-secondary-link-response-class.js +15 -0
  14. package/dist/models/create-task-request-dto.d.ts +13 -0
  15. package/dist/models/dry-run-filter-clause-class.d.ts +42 -0
  16. package/dist/models/dry-run-filter-clause-class.js +15 -0
  17. package/dist/models/dry-run-filter-request-dto.d.ts +30 -0
  18. package/dist/models/dry-run-filter-request-dto.js +15 -0
  19. package/dist/models/dry-run-filter-response-class.d.ts +37 -0
  20. package/dist/models/dry-run-filter-response-class.js +15 -0
  21. package/dist/models/entity-ref-class.d.ts +34 -0
  22. package/dist/models/entity-ref-class.js +19 -0
  23. package/dist/models/entity-ref-dto.d.ts +34 -0
  24. package/dist/models/entity-ref-dto.js +19 -0
  25. package/dist/models/index.d.ts +8 -0
  26. package/dist/models/index.js +8 -0
  27. package/dist/models/patch-task-request-dto.d.ts +12 -0
  28. package/dist/models/remove-secondary-link-response-class.d.ts +25 -0
  29. package/dist/models/remove-secondary-link-response-class.js +15 -0
  30. package/dist/models/secondary-link-class.d.ts +31 -0
  31. package/dist/models/secondary-link-class.js +15 -0
  32. package/dist/models/task-class.d.ts +7 -0
  33. package/models/add-secondary-link-response-class.ts +31 -0
  34. package/models/create-task-request-dto.ts +13 -0
  35. package/models/dry-run-filter-clause-class.ts +48 -0
  36. package/models/dry-run-filter-request-dto.ts +36 -0
  37. package/models/dry-run-filter-response-class.ts +43 -0
  38. package/models/entity-ref-class.ts +43 -0
  39. package/models/entity-ref-dto.ts +43 -0
  40. package/models/index.ts +8 -0
  41. package/models/patch-task-request-dto.ts +12 -0
  42. package/models/remove-secondary-link-response-class.ts +31 -0
  43. package/models/secondary-link-class.ts +37 -0
  44. package/models/task-class.ts +7 -0
  45. package/package.json +1 -1
package/api/tasks-api.ts CHANGED
@@ -21,10 +21,14 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
21
21
  // @ts-ignore
22
22
  import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
23
23
  // @ts-ignore
24
+ import { AddSecondaryLinkResponseClass } from '../models';
25
+ // @ts-ignore
24
26
  import { CreateTaskRequestDto } from '../models';
25
27
  // @ts-ignore
26
28
  import { CreateTaskResponseClass } from '../models';
27
29
  // @ts-ignore
30
+ import { EntityRefDto } from '../models';
31
+ // @ts-ignore
28
32
  import { GetTaskResponseClass } from '../models';
29
33
  // @ts-ignore
30
34
  import { ListTasksResponseClass } from '../models';
@@ -32,6 +36,8 @@ import { ListTasksResponseClass } from '../models';
32
36
  import { PatchTaskRequestDto } from '../models';
33
37
  // @ts-ignore
34
38
  import { PatchTaskResponseClass } from '../models';
39
+ // @ts-ignore
40
+ import { RemoveSecondaryLinkResponseClass } from '../models';
35
41
  // URLSearchParams not necessarily used
36
42
  // @ts-ignore
37
43
  import { URL, URLSearchParams } from 'url';
@@ -42,6 +48,57 @@ const FormData = require('form-data');
42
48
  */
43
49
  export const TasksApiAxiosParamCreator = function (configuration?: Configuration) {
44
50
  return {
51
+ /**
52
+ * Adds a secondary link from a task to a record in another service, for example an email thread. The record must exist. Adding a record that is already linked returns the task unchanged. **Required Permissions** \"task-management.tasks.update\"
53
+ * @summary Create the task secondary link
54
+ * @param {string} code
55
+ * @param {EntityRefDto} entityRefDto
56
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
57
+ * @param {*} [options] Override http request option.
58
+ * @throws {RequiredError}
59
+ */
60
+ addSecondaryLink: async (code: string, entityRefDto: EntityRefDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
61
+ // verify required parameter 'code' is not null or undefined
62
+ assertParamExists('addSecondaryLink', 'code', code)
63
+ // verify required parameter 'entityRefDto' is not null or undefined
64
+ assertParamExists('addSecondaryLink', 'entityRefDto', entityRefDto)
65
+ const localVarPath = `/taskservice/v1/tasks/{code}/secondary-links`
66
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
67
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
68
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
69
+ let baseOptions;
70
+ let baseAccessToken;
71
+ if (configuration) {
72
+ baseOptions = configuration.baseOptions;
73
+ baseAccessToken = configuration.accessToken;
74
+ }
75
+
76
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
77
+ const localVarHeaderParameter = {} as any;
78
+ const localVarQueryParameter = {} as any;
79
+
80
+ // authentication bearer required
81
+ // http bearer authentication required
82
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
83
+
84
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
85
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
86
+ }
87
+
88
+
89
+
90
+ localVarHeaderParameter['Content-Type'] = 'application/json';
91
+
92
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
93
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
94
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
95
+ localVarRequestOptions.data = serializeDataIfNeeded(entityRefDto, localVarRequestOptions, configuration)
96
+
97
+ return {
98
+ url: toPathString(localVarUrlObj),
99
+ options: localVarRequestOptions,
100
+ };
101
+ },
45
102
  /**
46
103
  * This will create a task. **Required Permissions** \"task-management.tasks.create\"
47
104
  * @summary Create the task
@@ -190,11 +247,11 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
190
247
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
191
248
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
192
249
  * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
193
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug&lt;/i&gt;
250
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug, secondaryLinks.type, secondaryLinks.code&lt;/i&gt;
194
251
  * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: subject, description&lt;/i&gt;
195
252
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, updatedAt, assignee, reporter, dueDate, entityType, entityCode, status, priority&lt;/i&gt;
196
253
  * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: categories, status&lt;i&gt;
197
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug&lt;/i&gt;
254
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug, secondaryLinks.type, secondaryLinks.code&lt;/i&gt;
198
255
  * @param {*} [options] Override http request option.
199
256
  * @throws {RequiredError}
200
257
  */
@@ -306,6 +363,59 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
306
363
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
307
364
  localVarRequestOptions.data = serializeDataIfNeeded(patchTaskRequestDto, localVarRequestOptions, configuration)
308
365
 
366
+ return {
367
+ url: toPathString(localVarUrlObj),
368
+ options: localVarRequestOptions,
369
+ };
370
+ },
371
+ /**
372
+ * Removes a secondary link between a task and a record in another service. The task and the record are kept. Removing a link that does not exist returns the task unchanged. **Required Permissions** \"task-management.tasks.update\"
373
+ * @summary Delete the task secondary link
374
+ * @param {string} code
375
+ * @param {string} linkType
376
+ * @param {string} linkCode
377
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
378
+ * @param {*} [options] Override http request option.
379
+ * @throws {RequiredError}
380
+ */
381
+ removeSecondaryLink: async (code: string, linkType: string, linkCode: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
382
+ // verify required parameter 'code' is not null or undefined
383
+ assertParamExists('removeSecondaryLink', 'code', code)
384
+ // verify required parameter 'linkType' is not null or undefined
385
+ assertParamExists('removeSecondaryLink', 'linkType', linkType)
386
+ // verify required parameter 'linkCode' is not null or undefined
387
+ assertParamExists('removeSecondaryLink', 'linkCode', linkCode)
388
+ const localVarPath = `/taskservice/v1/tasks/{code}/secondary-links/{linkType}/{linkCode}`
389
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)))
390
+ .replace(`{${"linkType"}}`, encodeURIComponent(String(linkType)))
391
+ .replace(`{${"linkCode"}}`, encodeURIComponent(String(linkCode)));
392
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
393
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
394
+ let baseOptions;
395
+ let baseAccessToken;
396
+ if (configuration) {
397
+ baseOptions = configuration.baseOptions;
398
+ baseAccessToken = configuration.accessToken;
399
+ }
400
+
401
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
402
+ const localVarHeaderParameter = {} as any;
403
+ const localVarQueryParameter = {} as any;
404
+
405
+ // authentication bearer required
406
+ // http bearer authentication required
407
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
408
+
409
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
410
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
411
+ }
412
+
413
+
414
+
415
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
416
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
417
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
418
+
309
419
  return {
310
420
  url: toPathString(localVarUrlObj),
311
421
  options: localVarRequestOptions,
@@ -321,6 +431,19 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
321
431
  export const TasksApiFp = function(configuration?: Configuration) {
322
432
  const localVarAxiosParamCreator = TasksApiAxiosParamCreator(configuration)
323
433
  return {
434
+ /**
435
+ * Adds a secondary link from a task to a record in another service, for example an email thread. The record must exist. Adding a record that is already linked returns the task unchanged. **Required Permissions** \"task-management.tasks.update\"
436
+ * @summary Create the task secondary link
437
+ * @param {string} code
438
+ * @param {EntityRefDto} entityRefDto
439
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
440
+ * @param {*} [options] Override http request option.
441
+ * @throws {RequiredError}
442
+ */
443
+ async addSecondaryLink(code: string, entityRefDto: EntityRefDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AddSecondaryLinkResponseClass>> {
444
+ const localVarAxiosArgs = await localVarAxiosParamCreator.addSecondaryLink(code, entityRefDto, authorization, options);
445
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
446
+ },
324
447
  /**
325
448
  * This will create a task. **Required Permissions** \"task-management.tasks.create\"
326
449
  * @summary Create the task
@@ -364,11 +487,11 @@ export const TasksApiFp = function(configuration?: Configuration) {
364
487
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
365
488
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
366
489
  * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
367
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug&lt;/i&gt;
490
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug, secondaryLinks.type, secondaryLinks.code&lt;/i&gt;
368
491
  * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: subject, description&lt;/i&gt;
369
492
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, updatedAt, assignee, reporter, dueDate, entityType, entityCode, status, priority&lt;/i&gt;
370
493
  * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: categories, status&lt;i&gt;
371
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug&lt;/i&gt;
494
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug, secondaryLinks.type, secondaryLinks.code&lt;/i&gt;
372
495
  * @param {*} [options] Override http request option.
373
496
  * @throws {RequiredError}
374
497
  */
@@ -389,6 +512,20 @@ export const TasksApiFp = function(configuration?: Configuration) {
389
512
  const localVarAxiosArgs = await localVarAxiosParamCreator.patchTask(code, patchTaskRequestDto, authorization, options);
390
513
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
391
514
  },
515
+ /**
516
+ * Removes a secondary link between a task and a record in another service. The task and the record are kept. Removing a link that does not exist returns the task unchanged. **Required Permissions** \"task-management.tasks.update\"
517
+ * @summary Delete the task secondary link
518
+ * @param {string} code
519
+ * @param {string} linkType
520
+ * @param {string} linkCode
521
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
522
+ * @param {*} [options] Override http request option.
523
+ * @throws {RequiredError}
524
+ */
525
+ async removeSecondaryLink(code: string, linkType: string, linkCode: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoveSecondaryLinkResponseClass>> {
526
+ const localVarAxiosArgs = await localVarAxiosParamCreator.removeSecondaryLink(code, linkType, linkCode, authorization, options);
527
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
528
+ },
392
529
  }
393
530
  };
394
531
 
@@ -399,6 +536,18 @@ export const TasksApiFp = function(configuration?: Configuration) {
399
536
  export const TasksApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
400
537
  const localVarFp = TasksApiFp(configuration)
401
538
  return {
539
+ /**
540
+ * Adds a secondary link from a task to a record in another service, for example an email thread. The record must exist. Adding a record that is already linked returns the task unchanged. **Required Permissions** \"task-management.tasks.update\"
541
+ * @summary Create the task secondary link
542
+ * @param {string} code
543
+ * @param {EntityRefDto} entityRefDto
544
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
545
+ * @param {*} [options] Override http request option.
546
+ * @throws {RequiredError}
547
+ */
548
+ addSecondaryLink(code: string, entityRefDto: EntityRefDto, authorization?: string, options?: any): AxiosPromise<AddSecondaryLinkResponseClass> {
549
+ return localVarFp.addSecondaryLink(code, entityRefDto, authorization, options).then((request) => request(axios, basePath));
550
+ },
402
551
  /**
403
552
  * This will create a task. **Required Permissions** \"task-management.tasks.create\"
404
553
  * @summary Create the task
@@ -439,11 +588,11 @@ export const TasksApiFactory = function (configuration?: Configuration, basePath
439
588
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
440
589
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
441
590
  * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
442
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug&lt;/i&gt;
591
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug, secondaryLinks.type, secondaryLinks.code&lt;/i&gt;
443
592
  * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: subject, description&lt;/i&gt;
444
593
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, updatedAt, assignee, reporter, dueDate, entityType, entityCode, status, priority&lt;/i&gt;
445
594
  * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: categories, status&lt;i&gt;
446
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug&lt;/i&gt;
595
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug, secondaryLinks.type, secondaryLinks.code&lt;/i&gt;
447
596
  * @param {*} [options] Override http request option.
448
597
  * @throws {RequiredError}
449
598
  */
@@ -462,9 +611,50 @@ export const TasksApiFactory = function (configuration?: Configuration, basePath
462
611
  patchTask(code: string, patchTaskRequestDto: PatchTaskRequestDto, authorization?: string, options?: any): AxiosPromise<PatchTaskResponseClass> {
463
612
  return localVarFp.patchTask(code, patchTaskRequestDto, authorization, options).then((request) => request(axios, basePath));
464
613
  },
614
+ /**
615
+ * Removes a secondary link between a task and a record in another service. The task and the record are kept. Removing a link that does not exist returns the task unchanged. **Required Permissions** \"task-management.tasks.update\"
616
+ * @summary Delete the task secondary link
617
+ * @param {string} code
618
+ * @param {string} linkType
619
+ * @param {string} linkCode
620
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
621
+ * @param {*} [options] Override http request option.
622
+ * @throws {RequiredError}
623
+ */
624
+ removeSecondaryLink(code: string, linkType: string, linkCode: string, authorization?: string, options?: any): AxiosPromise<RemoveSecondaryLinkResponseClass> {
625
+ return localVarFp.removeSecondaryLink(code, linkType, linkCode, authorization, options).then((request) => request(axios, basePath));
626
+ },
465
627
  };
466
628
  };
467
629
 
630
+ /**
631
+ * Request parameters for addSecondaryLink operation in TasksApi.
632
+ * @export
633
+ * @interface TasksApiAddSecondaryLinkRequest
634
+ */
635
+ export interface TasksApiAddSecondaryLinkRequest {
636
+ /**
637
+ *
638
+ * @type {string}
639
+ * @memberof TasksApiAddSecondaryLink
640
+ */
641
+ readonly code: string
642
+
643
+ /**
644
+ *
645
+ * @type {EntityRefDto}
646
+ * @memberof TasksApiAddSecondaryLink
647
+ */
648
+ readonly entityRefDto: EntityRefDto
649
+
650
+ /**
651
+ * Bearer Token: provided by the login endpoint under the name accessToken.
652
+ * @type {string}
653
+ * @memberof TasksApiAddSecondaryLink
654
+ */
655
+ readonly authorization?: string
656
+ }
657
+
468
658
  /**
469
659
  * Request parameters for createTask operation in TasksApi.
470
660
  * @export
@@ -563,7 +753,7 @@ export interface TasksApiListTasksRequest {
563
753
  readonly pageToken?: string
564
754
 
565
755
  /**
566
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug&lt;/i&gt;
756
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug, secondaryLinks.type, secondaryLinks.code&lt;/i&gt;
567
757
  * @type {string}
568
758
  * @memberof TasksApiListTasks
569
759
  */
@@ -591,7 +781,7 @@ export interface TasksApiListTasksRequest {
591
781
  readonly expand?: string
592
782
 
593
783
  /**
594
- * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug&lt;/i&gt;
784
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug, secondaryLinks.type, secondaryLinks.code&lt;/i&gt;
595
785
  * @type {string}
596
786
  * @memberof TasksApiListTasks
597
787
  */
@@ -626,6 +816,41 @@ export interface TasksApiPatchTaskRequest {
626
816
  readonly authorization?: string
627
817
  }
628
818
 
819
+ /**
820
+ * Request parameters for removeSecondaryLink operation in TasksApi.
821
+ * @export
822
+ * @interface TasksApiRemoveSecondaryLinkRequest
823
+ */
824
+ export interface TasksApiRemoveSecondaryLinkRequest {
825
+ /**
826
+ *
827
+ * @type {string}
828
+ * @memberof TasksApiRemoveSecondaryLink
829
+ */
830
+ readonly code: string
831
+
832
+ /**
833
+ *
834
+ * @type {string}
835
+ * @memberof TasksApiRemoveSecondaryLink
836
+ */
837
+ readonly linkType: string
838
+
839
+ /**
840
+ *
841
+ * @type {string}
842
+ * @memberof TasksApiRemoveSecondaryLink
843
+ */
844
+ readonly linkCode: string
845
+
846
+ /**
847
+ * Bearer Token: provided by the login endpoint under the name accessToken.
848
+ * @type {string}
849
+ * @memberof TasksApiRemoveSecondaryLink
850
+ */
851
+ readonly authorization?: string
852
+ }
853
+
629
854
  /**
630
855
  * TasksApi - object-oriented interface
631
856
  * @export
@@ -633,6 +858,18 @@ export interface TasksApiPatchTaskRequest {
633
858
  * @extends {BaseAPI}
634
859
  */
635
860
  export class TasksApi extends BaseAPI {
861
+ /**
862
+ * Adds a secondary link from a task to a record in another service, for example an email thread. The record must exist. Adding a record that is already linked returns the task unchanged. **Required Permissions** \"task-management.tasks.update\"
863
+ * @summary Create the task secondary link
864
+ * @param {TasksApiAddSecondaryLinkRequest} requestParameters Request parameters.
865
+ * @param {*} [options] Override http request option.
866
+ * @throws {RequiredError}
867
+ * @memberof TasksApi
868
+ */
869
+ public addSecondaryLink(requestParameters: TasksApiAddSecondaryLinkRequest, options?: AxiosRequestConfig) {
870
+ return TasksApiFp(this.configuration).addSecondaryLink(requestParameters.code, requestParameters.entityRefDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
871
+ }
872
+
636
873
  /**
637
874
  * This will create a task. **Required Permissions** \"task-management.tasks.create\"
638
875
  * @summary Create the task
@@ -692,4 +929,16 @@ export class TasksApi extends BaseAPI {
692
929
  public patchTask(requestParameters: TasksApiPatchTaskRequest, options?: AxiosRequestConfig) {
693
930
  return TasksApiFp(this.configuration).patchTask(requestParameters.code, requestParameters.patchTaskRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
694
931
  }
932
+
933
+ /**
934
+ * Removes a secondary link between a task and a record in another service. The task and the record are kept. Removing a link that does not exist returns the task unchanged. **Required Permissions** \"task-management.tasks.update\"
935
+ * @summary Delete the task secondary link
936
+ * @param {TasksApiRemoveSecondaryLinkRequest} requestParameters Request parameters.
937
+ * @param {*} [options] Override http request option.
938
+ * @throws {RequiredError}
939
+ * @memberof TasksApi
940
+ */
941
+ public removeSecondaryLink(requestParameters: TasksApiRemoveSecondaryLinkRequest, options?: AxiosRequestConfig) {
942
+ return TasksApiFp(this.configuration).removeSecondaryLink(requestParameters.code, requestParameters.linkType, requestParameters.linkCode, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
943
+ }
695
944
  }
@@ -14,6 +14,8 @@ import { Configuration } from '../configuration';
14
14
  import { RequestArgs, BaseAPI } from '../base';
15
15
  import { CreateFilterRequestDto } from '../models';
16
16
  import { CreateFilterResponseClass } from '../models';
17
+ import { DryRunFilterRequestDto } from '../models';
18
+ import { DryRunFilterResponseClass } from '../models';
17
19
  import { GetFilterResponseClass } from '../models';
18
20
  import { ListFiltersResponseClass } from '../models';
19
21
  import { UpdateFilterRequestDto } from '../models';
@@ -41,6 +43,15 @@ export declare const FiltersApiAxiosParamCreator: (configuration?: Configuration
41
43
  * @throws {RequiredError}
42
44
  */
43
45
  deleteFilter: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
46
+ /**
47
+ * Test a candidate filter expression against a specific task without saving a filter. **Required Permissions** \"task-management.task-filters.create\"
48
+ * @summary Create the filter dry-run
49
+ * @param {DryRunFilterRequestDto} dryRunFilterRequestDto
50
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
51
+ * @param {*} [options] Override http request option.
52
+ * @throws {RequiredError}
53
+ */
54
+ dryRunFilter: (dryRunFilterRequestDto: DryRunFilterRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
44
55
  /**
45
56
  * Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
46
57
  * @summary Retrieve the filter
@@ -51,16 +62,16 @@ export declare const FiltersApiAxiosParamCreator: (configuration?: Configuration
51
62
  */
52
63
  getFilter: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
53
64
  /**
54
- * Returns a list of filters you have previously created. The filters are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"task-management.task-filters.view\"
65
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
55
66
  * @summary List filters
56
67
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
57
68
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
58
69
  * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
59
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
60
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
61
- * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
62
- * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
63
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
70
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority&lt;/i&gt;
71
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: name, slug&lt;/i&gt;
72
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, updatedAt, name, slug, priority&lt;/i&gt;
73
+ * @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.&lt;br/&gt; &lt;br/&gt;
74
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority&lt;/i&gt;
64
75
  * @param {*} [options] Override http request option.
65
76
  * @throws {RequiredError}
66
77
  */
@@ -99,6 +110,15 @@ export declare const FiltersApiFp: (configuration?: Configuration) => {
99
110
  * @throws {RequiredError}
100
111
  */
101
112
  deleteFilter(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
113
+ /**
114
+ * Test a candidate filter expression against a specific task without saving a filter. **Required Permissions** \"task-management.task-filters.create\"
115
+ * @summary Create the filter dry-run
116
+ * @param {DryRunFilterRequestDto} dryRunFilterRequestDto
117
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
118
+ * @param {*} [options] Override http request option.
119
+ * @throws {RequiredError}
120
+ */
121
+ dryRunFilter(dryRunFilterRequestDto: DryRunFilterRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DryRunFilterResponseClass>>;
102
122
  /**
103
123
  * Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
104
124
  * @summary Retrieve the filter
@@ -109,16 +129,16 @@ export declare const FiltersApiFp: (configuration?: Configuration) => {
109
129
  */
110
130
  getFilter(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFilterResponseClass>>;
111
131
  /**
112
- * Returns a list of filters you have previously created. The filters are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"task-management.task-filters.view\"
132
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
113
133
  * @summary List filters
114
134
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
115
135
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
116
136
  * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
117
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
118
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
119
- * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
120
- * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
121
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
137
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority&lt;/i&gt;
138
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: name, slug&lt;/i&gt;
139
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, updatedAt, name, slug, priority&lt;/i&gt;
140
+ * @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.&lt;br/&gt; &lt;br/&gt;
141
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority&lt;/i&gt;
122
142
  * @param {*} [options] Override http request option.
123
143
  * @throws {RequiredError}
124
144
  */
@@ -157,6 +177,15 @@ export declare const FiltersApiFactory: (configuration?: Configuration, basePath
157
177
  * @throws {RequiredError}
158
178
  */
159
179
  deleteFilter(code: string, authorization?: string, options?: any): AxiosPromise<void>;
180
+ /**
181
+ * Test a candidate filter expression against a specific task without saving a filter. **Required Permissions** \"task-management.task-filters.create\"
182
+ * @summary Create the filter dry-run
183
+ * @param {DryRunFilterRequestDto} dryRunFilterRequestDto
184
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
185
+ * @param {*} [options] Override http request option.
186
+ * @throws {RequiredError}
187
+ */
188
+ dryRunFilter(dryRunFilterRequestDto: DryRunFilterRequestDto, authorization?: string, options?: any): AxiosPromise<DryRunFilterResponseClass>;
160
189
  /**
161
190
  * Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
162
191
  * @summary Retrieve the filter
@@ -167,16 +196,16 @@ export declare const FiltersApiFactory: (configuration?: Configuration, basePath
167
196
  */
168
197
  getFilter(code: string, authorization?: string, options?: any): AxiosPromise<GetFilterResponseClass>;
169
198
  /**
170
- * Returns a list of filters you have previously created. The filters are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"task-management.task-filters.view\"
199
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
171
200
  * @summary List filters
172
201
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
173
202
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
174
203
  * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
175
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
176
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
177
- * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
178
- * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
179
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
204
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority&lt;/i&gt;
205
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: name, slug&lt;/i&gt;
206
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, updatedAt, name, slug, priority&lt;/i&gt;
207
+ * @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.&lt;br/&gt; &lt;br/&gt;
208
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority&lt;/i&gt;
180
209
  * @param {*} [options] Override http request option.
181
210
  * @throws {RequiredError}
182
211
  */
@@ -230,6 +259,25 @@ export interface FiltersApiDeleteFilterRequest {
230
259
  */
231
260
  readonly authorization?: string;
232
261
  }
262
+ /**
263
+ * Request parameters for dryRunFilter operation in FiltersApi.
264
+ * @export
265
+ * @interface FiltersApiDryRunFilterRequest
266
+ */
267
+ export interface FiltersApiDryRunFilterRequest {
268
+ /**
269
+ *
270
+ * @type {DryRunFilterRequestDto}
271
+ * @memberof FiltersApiDryRunFilter
272
+ */
273
+ readonly dryRunFilterRequestDto: DryRunFilterRequestDto;
274
+ /**
275
+ * Bearer Token: provided by the login endpoint under the name accessToken.
276
+ * @type {string}
277
+ * @memberof FiltersApiDryRunFilter
278
+ */
279
+ readonly authorization?: string;
280
+ }
233
281
  /**
234
282
  * Request parameters for getFilter operation in FiltersApi.
235
283
  * @export
@@ -274,31 +322,31 @@ export interface FiltersApiListFiltersRequest {
274
322
  */
275
323
  readonly pageToken?: string;
276
324
  /**
277
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
325
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority&lt;/i&gt;
278
326
  * @type {string}
279
327
  * @memberof FiltersApiListFilters
280
328
  */
281
329
  readonly filter?: string;
282
330
  /**
283
- * To search the list by any field, pass search&#x3D;xxx to fetch the result.
331
+ * Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: name, slug&lt;/i&gt;
284
332
  * @type {string}
285
333
  * @memberof FiltersApiListFilters
286
334
  */
287
335
  readonly search?: string;
288
336
  /**
289
- * The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
337
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, updatedAt, name, slug, priority&lt;/i&gt;
290
338
  * @type {string}
291
339
  * @memberof FiltersApiListFilters
292
340
  */
293
341
  readonly order?: string;
294
342
  /**
295
- * Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
343
+ * 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.&lt;br/&gt; &lt;br/&gt;
296
344
  * @type {string}
297
345
  * @memberof FiltersApiListFilters
298
346
  */
299
347
  readonly expand?: string;
300
348
  /**
301
- * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
349
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority&lt;/i&gt;
302
350
  * @type {string}
303
351
  * @memberof FiltersApiListFilters
304
352
  */
@@ -354,6 +402,15 @@ export declare class FiltersApi extends BaseAPI {
354
402
  * @memberof FiltersApi
355
403
  */
356
404
  deleteFilter(requestParameters: FiltersApiDeleteFilterRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
405
+ /**
406
+ * Test a candidate filter expression against a specific task without saving a filter. **Required Permissions** \"task-management.task-filters.create\"
407
+ * @summary Create the filter dry-run
408
+ * @param {FiltersApiDryRunFilterRequest} requestParameters Request parameters.
409
+ * @param {*} [options] Override http request option.
410
+ * @throws {RequiredError}
411
+ * @memberof FiltersApi
412
+ */
413
+ dryRunFilter(requestParameters: FiltersApiDryRunFilterRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DryRunFilterResponseClass, any, {}>>;
357
414
  /**
358
415
  * Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
359
416
  * @summary Retrieve the filter
@@ -364,7 +421,7 @@ export declare class FiltersApi extends BaseAPI {
364
421
  */
365
422
  getFilter(requestParameters: FiltersApiGetFilterRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFilterResponseClass, any, {}>>;
366
423
  /**
367
- * Returns a list of filters you have previously created. The filters are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"task-management.task-filters.view\"
424
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
368
425
  * @summary List filters
369
426
  * @param {FiltersApiListFiltersRequest} requestParameters Request parameters.
370
427
  * @param {*} [options] Override http request option.