@emilgroup/task-sdk-node 1.7.1-beta.4 → 1.7.1-beta.6

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.
@@ -31,6 +31,9 @@ models/create-status-request-dto.ts
31
31
  models/create-status-response-class.ts
32
32
  models/create-task-request-dto.ts
33
33
  models/create-task-response-class.ts
34
+ models/dry-run-filter-clause-class.ts
35
+ models/dry-run-filter-request-dto.ts
36
+ models/dry-run-filter-response-class.ts
34
37
  models/filter-class.ts
35
38
  models/get-category-response-class.ts
36
39
  models/get-filter-response-class.ts
package/README.md CHANGED
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
17
17
  Navigate to the folder of your consuming project and run one of the following commands:
18
18
 
19
19
  ```
20
- npm install @emilgroup/task-sdk-node@1.7.1-beta.4 --save
20
+ npm install @emilgroup/task-sdk-node@1.7.1-beta.6 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/task-sdk-node@1.7.1-beta.4
24
+ yarn add @emilgroup/task-sdk-node@1.7.1-beta.6
25
25
  ```
26
26
 
27
27
  And then you can import `TasksApi`.
@@ -25,6 +25,10 @@ import { CreateFilterRequestDto } from '../models';
25
25
  // @ts-ignore
26
26
  import { CreateFilterResponseClass } from '../models';
27
27
  // @ts-ignore
28
+ import { DryRunFilterRequestDto } from '../models';
29
+ // @ts-ignore
30
+ import { DryRunFilterResponseClass } from '../models';
31
+ // @ts-ignore
28
32
  import { GetFilterResponseClass } from '../models';
29
33
  // @ts-ignore
30
34
  import { ListFiltersResponseClass } from '../models';
@@ -134,6 +138,53 @@ export const FiltersApiAxiosParamCreator = function (configuration?: Configurati
134
138
  options: localVarRequestOptions,
135
139
  };
136
140
  },
141
+ /**
142
+ * Test a candidate filter expression against a specific task without saving a filter. **Required Permissions** \"task-management.task-filters.create\"
143
+ * @summary Create the filter dry-run
144
+ * @param {DryRunFilterRequestDto} dryRunFilterRequestDto
145
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
146
+ * @param {*} [options] Override http request option.
147
+ * @throws {RequiredError}
148
+ */
149
+ dryRunFilter: async (dryRunFilterRequestDto: DryRunFilterRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
150
+ // verify required parameter 'dryRunFilterRequestDto' is not null or undefined
151
+ assertParamExists('dryRunFilter', 'dryRunFilterRequestDto', dryRunFilterRequestDto)
152
+ const localVarPath = `/taskservice/v1/filters/dry-run`;
153
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
154
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
155
+ let baseOptions;
156
+ let baseAccessToken;
157
+ if (configuration) {
158
+ baseOptions = configuration.baseOptions;
159
+ baseAccessToken = configuration.accessToken;
160
+ }
161
+
162
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
163
+ const localVarHeaderParameter = {} as any;
164
+ const localVarQueryParameter = {} as any;
165
+
166
+ // authentication bearer required
167
+ // http bearer authentication required
168
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
169
+
170
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
171
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
172
+ }
173
+
174
+
175
+
176
+ localVarHeaderParameter['Content-Type'] = 'application/json';
177
+
178
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
179
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
180
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
181
+ localVarRequestOptions.data = serializeDataIfNeeded(dryRunFilterRequestDto, localVarRequestOptions, configuration)
182
+
183
+ return {
184
+ url: toPathString(localVarUrlObj),
185
+ options: localVarRequestOptions,
186
+ };
187
+ },
137
188
  /**
138
189
  * Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
139
190
  * @summary Retrieve the filter
@@ -180,16 +231,16 @@ export const FiltersApiAxiosParamCreator = function (configuration?: Configurati
180
231
  };
181
232
  },
182
233
  /**
183
- * 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\"
234
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
184
235
  * @summary List filters
185
236
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
186
237
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
187
238
  * @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.
188
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
189
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
190
- * @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.
191
- * @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.
192
- * @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.
239
+ * @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;
240
+ * @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;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, updatedAt, name, slug, priority&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt;
243
+ * @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;
193
244
  * @param {*} [options] Override http request option.
194
245
  * @throws {RequiredError}
195
246
  */
@@ -340,6 +391,18 @@ export const FiltersApiFp = function(configuration?: Configuration) {
340
391
  const localVarAxiosArgs = await localVarAxiosParamCreator.deleteFilter(code, authorization, options);
341
392
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
342
393
  },
394
+ /**
395
+ * Test a candidate filter expression against a specific task without saving a filter. **Required Permissions** \"task-management.task-filters.create\"
396
+ * @summary Create the filter dry-run
397
+ * @param {DryRunFilterRequestDto} dryRunFilterRequestDto
398
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
399
+ * @param {*} [options] Override http request option.
400
+ * @throws {RequiredError}
401
+ */
402
+ async dryRunFilter(dryRunFilterRequestDto: DryRunFilterRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DryRunFilterResponseClass>> {
403
+ const localVarAxiosArgs = await localVarAxiosParamCreator.dryRunFilter(dryRunFilterRequestDto, authorization, options);
404
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
405
+ },
343
406
  /**
344
407
  * Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
345
408
  * @summary Retrieve the filter
@@ -353,16 +416,16 @@ export const FiltersApiFp = function(configuration?: Configuration) {
353
416
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
354
417
  },
355
418
  /**
356
- * 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\"
419
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
357
420
  * @summary List filters
358
421
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
359
422
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
360
423
  * @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.
361
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
362
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
363
- * @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.
364
- * @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.
365
- * @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.
424
+ * @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;
425
+ * @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;
426
+ * @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;
427
+ * @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;
428
+ * @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;
366
429
  * @param {*} [options] Override http request option.
367
430
  * @throws {RequiredError}
368
431
  */
@@ -415,6 +478,17 @@ export const FiltersApiFactory = function (configuration?: Configuration, basePa
415
478
  deleteFilter(code: string, authorization?: string, options?: any): AxiosPromise<void> {
416
479
  return localVarFp.deleteFilter(code, authorization, options).then((request) => request(axios, basePath));
417
480
  },
481
+ /**
482
+ * Test a candidate filter expression against a specific task without saving a filter. **Required Permissions** \"task-management.task-filters.create\"
483
+ * @summary Create the filter dry-run
484
+ * @param {DryRunFilterRequestDto} dryRunFilterRequestDto
485
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
486
+ * @param {*} [options] Override http request option.
487
+ * @throws {RequiredError}
488
+ */
489
+ dryRunFilter(dryRunFilterRequestDto: DryRunFilterRequestDto, authorization?: string, options?: any): AxiosPromise<DryRunFilterResponseClass> {
490
+ return localVarFp.dryRunFilter(dryRunFilterRequestDto, authorization, options).then((request) => request(axios, basePath));
491
+ },
418
492
  /**
419
493
  * Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
420
494
  * @summary Retrieve the filter
@@ -427,16 +501,16 @@ export const FiltersApiFactory = function (configuration?: Configuration, basePa
427
501
  return localVarFp.getFilter(code, authorization, options).then((request) => request(axios, basePath));
428
502
  },
429
503
  /**
430
- * 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\"
504
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
431
505
  * @summary List filters
432
506
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
433
507
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
434
508
  * @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.
435
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
436
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
437
- * @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.
438
- * @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.
439
- * @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.
509
+ * @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;
510
+ * @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;
511
+ * @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;
512
+ * @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;
513
+ * @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;
440
514
  * @param {*} [options] Override http request option.
441
515
  * @throws {RequiredError}
442
516
  */
@@ -500,6 +574,27 @@ export interface FiltersApiDeleteFilterRequest {
500
574
  readonly authorization?: string
501
575
  }
502
576
 
577
+ /**
578
+ * Request parameters for dryRunFilter operation in FiltersApi.
579
+ * @export
580
+ * @interface FiltersApiDryRunFilterRequest
581
+ */
582
+ export interface FiltersApiDryRunFilterRequest {
583
+ /**
584
+ *
585
+ * @type {DryRunFilterRequestDto}
586
+ * @memberof FiltersApiDryRunFilter
587
+ */
588
+ readonly dryRunFilterRequestDto: DryRunFilterRequestDto
589
+
590
+ /**
591
+ * Bearer Token: provided by the login endpoint under the name accessToken.
592
+ * @type {string}
593
+ * @memberof FiltersApiDryRunFilter
594
+ */
595
+ readonly authorization?: string
596
+ }
597
+
503
598
  /**
504
599
  * Request parameters for getFilter operation in FiltersApi.
505
600
  * @export
@@ -549,35 +644,35 @@ export interface FiltersApiListFiltersRequest {
549
644
  readonly pageToken?: string
550
645
 
551
646
  /**
552
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
647
+ * 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;
553
648
  * @type {string}
554
649
  * @memberof FiltersApiListFilters
555
650
  */
556
651
  readonly filter?: string
557
652
 
558
653
  /**
559
- * To search the list by any field, pass search&#x3D;xxx to fetch the result.
654
+ * 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;
560
655
  * @type {string}
561
656
  * @memberof FiltersApiListFilters
562
657
  */
563
658
  readonly search?: string
564
659
 
565
660
  /**
566
- * 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.
661
+ * 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;
567
662
  * @type {string}
568
663
  * @memberof FiltersApiListFilters
569
664
  */
570
665
  readonly order?: string
571
666
 
572
667
  /**
573
- * 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.
668
+ * 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;
574
669
  * @type {string}
575
670
  * @memberof FiltersApiListFilters
576
671
  */
577
672
  readonly expand?: string
578
673
 
579
674
  /**
580
- * 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.
675
+ * 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;
581
676
  * @type {string}
582
677
  * @memberof FiltersApiListFilters
583
678
  */
@@ -643,6 +738,18 @@ export class FiltersApi extends BaseAPI {
643
738
  return FiltersApiFp(this.configuration).deleteFilter(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
644
739
  }
645
740
 
741
+ /**
742
+ * Test a candidate filter expression against a specific task without saving a filter. **Required Permissions** \"task-management.task-filters.create\"
743
+ * @summary Create the filter dry-run
744
+ * @param {FiltersApiDryRunFilterRequest} requestParameters Request parameters.
745
+ * @param {*} [options] Override http request option.
746
+ * @throws {RequiredError}
747
+ * @memberof FiltersApi
748
+ */
749
+ public dryRunFilter(requestParameters: FiltersApiDryRunFilterRequest, options?: AxiosRequestConfig) {
750
+ return FiltersApiFp(this.configuration).dryRunFilter(requestParameters.dryRunFilterRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
751
+ }
752
+
646
753
  /**
647
754
  * Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
648
755
  * @summary Retrieve the filter
@@ -656,7 +763,7 @@ export class FiltersApi extends BaseAPI {
656
763
  }
657
764
 
658
765
  /**
659
- * 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\"
766
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
660
767
  * @summary List filters
661
768
  * @param {FiltersApiListFiltersRequest} requestParameters Request parameters.
662
769
  * @param {*} [options] Override http request option.
@@ -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.
@@ -193,6 +193,55 @@ var FiltersApiAxiosParamCreator = function (configuration) {
193
193
  });
194
194
  });
195
195
  },
196
+ /**
197
+ * Test a candidate filter expression against a specific task without saving a filter. **Required Permissions** \"task-management.task-filters.create\"
198
+ * @summary Create the filter dry-run
199
+ * @param {DryRunFilterRequestDto} dryRunFilterRequestDto
200
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
201
+ * @param {*} [options] Override http request option.
202
+ * @throws {RequiredError}
203
+ */
204
+ dryRunFilter: function (dryRunFilterRequestDto, authorization, options) {
205
+ if (options === void 0) { options = {}; }
206
+ return __awaiter(_this, void 0, void 0, function () {
207
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
208
+ return __generator(this, function (_a) {
209
+ switch (_a.label) {
210
+ case 0:
211
+ // verify required parameter 'dryRunFilterRequestDto' is not null or undefined
212
+ (0, common_1.assertParamExists)('dryRunFilter', 'dryRunFilterRequestDto', dryRunFilterRequestDto);
213
+ localVarPath = "/taskservice/v1/filters/dry-run";
214
+ localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
215
+ if (configuration) {
216
+ baseOptions = configuration.baseOptions;
217
+ baseAccessToken = configuration.accessToken;
218
+ }
219
+ localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
220
+ localVarHeaderParameter = {};
221
+ localVarQueryParameter = {};
222
+ // authentication bearer required
223
+ // http bearer authentication required
224
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
225
+ case 1:
226
+ // authentication bearer required
227
+ // http bearer authentication required
228
+ _a.sent();
229
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
230
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
231
+ }
232
+ localVarHeaderParameter['Content-Type'] = 'application/json';
233
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
234
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
235
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
236
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(dryRunFilterRequestDto, localVarRequestOptions, configuration);
237
+ return [2 /*return*/, {
238
+ url: (0, common_1.toPathString)(localVarUrlObj),
239
+ options: localVarRequestOptions,
240
+ }];
241
+ }
242
+ });
243
+ });
244
+ },
196
245
  /**
197
246
  * Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
198
247
  * @summary Retrieve the filter
@@ -242,16 +291,16 @@ var FiltersApiAxiosParamCreator = function (configuration) {
242
291
  });
243
292
  },
244
293
  /**
245
- * 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\"
294
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
246
295
  * @summary List filters
247
296
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
248
297
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
249
298
  * @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.
250
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
251
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
252
- * @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.
253
- * @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.
254
- * @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.
299
+ * @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;
300
+ * @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;
301
+ * @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;
302
+ * @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;
303
+ * @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;
255
304
  * @param {*} [options] Override http request option.
256
305
  * @throws {RequiredError}
257
306
  */
@@ -418,6 +467,27 @@ var FiltersApiFp = function (configuration) {
418
467
  });
419
468
  });
420
469
  },
470
+ /**
471
+ * Test a candidate filter expression against a specific task without saving a filter. **Required Permissions** \"task-management.task-filters.create\"
472
+ * @summary Create the filter dry-run
473
+ * @param {DryRunFilterRequestDto} dryRunFilterRequestDto
474
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
475
+ * @param {*} [options] Override http request option.
476
+ * @throws {RequiredError}
477
+ */
478
+ dryRunFilter: function (dryRunFilterRequestDto, authorization, options) {
479
+ return __awaiter(this, void 0, void 0, function () {
480
+ var localVarAxiosArgs;
481
+ return __generator(this, function (_a) {
482
+ switch (_a.label) {
483
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.dryRunFilter(dryRunFilterRequestDto, authorization, options)];
484
+ case 1:
485
+ localVarAxiosArgs = _a.sent();
486
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
487
+ }
488
+ });
489
+ });
490
+ },
421
491
  /**
422
492
  * Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
423
493
  * @summary Retrieve the filter
@@ -440,16 +510,16 @@ var FiltersApiFp = function (configuration) {
440
510
  });
441
511
  },
442
512
  /**
443
- * 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\"
513
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
444
514
  * @summary List filters
445
515
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
446
516
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
447
517
  * @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.
448
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
449
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
450
- * @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.
451
- * @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.
452
- * @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.
518
+ * @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;
519
+ * @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;
520
+ * @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;
521
+ * @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;
522
+ * @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;
453
523
  * @param {*} [options] Override http request option.
454
524
  * @throws {RequiredError}
455
525
  */
@@ -520,6 +590,17 @@ var FiltersApiFactory = function (configuration, basePath, axios) {
520
590
  deleteFilter: function (code, authorization, options) {
521
591
  return localVarFp.deleteFilter(code, authorization, options).then(function (request) { return request(axios, basePath); });
522
592
  },
593
+ /**
594
+ * Test a candidate filter expression against a specific task without saving a filter. **Required Permissions** \"task-management.task-filters.create\"
595
+ * @summary Create the filter dry-run
596
+ * @param {DryRunFilterRequestDto} dryRunFilterRequestDto
597
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
598
+ * @param {*} [options] Override http request option.
599
+ * @throws {RequiredError}
600
+ */
601
+ dryRunFilter: function (dryRunFilterRequestDto, authorization, options) {
602
+ return localVarFp.dryRunFilter(dryRunFilterRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
603
+ },
523
604
  /**
524
605
  * Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
525
606
  * @summary Retrieve the filter
@@ -532,16 +613,16 @@ var FiltersApiFactory = function (configuration, basePath, axios) {
532
613
  return localVarFp.getFilter(code, authorization, options).then(function (request) { return request(axios, basePath); });
533
614
  },
534
615
  /**
535
- * 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\"
616
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
536
617
  * @summary List filters
537
618
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
538
619
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
539
620
  * @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.
540
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
541
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
542
- * @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.
543
- * @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.
544
- * @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.
621
+ * @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;
622
+ * @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;
623
+ * @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;
624
+ * @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;
625
+ * @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;
545
626
  * @param {*} [options] Override http request option.
546
627
  * @throws {RequiredError}
547
628
  */
@@ -598,6 +679,18 @@ var FiltersApi = /** @class */ (function (_super) {
598
679
  var _this = this;
599
680
  return (0, exports.FiltersApiFp)(this.configuration).deleteFilter(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
600
681
  };
682
+ /**
683
+ * Test a candidate filter expression against a specific task without saving a filter. **Required Permissions** \"task-management.task-filters.create\"
684
+ * @summary Create the filter dry-run
685
+ * @param {FiltersApiDryRunFilterRequest} requestParameters Request parameters.
686
+ * @param {*} [options] Override http request option.
687
+ * @throws {RequiredError}
688
+ * @memberof FiltersApi
689
+ */
690
+ FiltersApi.prototype.dryRunFilter = function (requestParameters, options) {
691
+ var _this = this;
692
+ return (0, exports.FiltersApiFp)(this.configuration).dryRunFilter(requestParameters.dryRunFilterRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
693
+ };
601
694
  /**
602
695
  * Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
603
696
  * @summary Retrieve the filter
@@ -611,7 +704,7 @@ var FiltersApi = /** @class */ (function (_super) {
611
704
  return (0, exports.FiltersApiFp)(this.configuration).getFilter(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
612
705
  };
613
706
  /**
614
- * 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\"
707
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
615
708
  * @summary List filters
616
709
  * @param {FiltersApiListFiltersRequest} requestParameters Request parameters.
617
710
  * @param {*} [options] Override http request option.
@@ -0,0 +1,42 @@
1
+ /**
2
+ * EMIL TaskService
3
+ * The EMIL Task API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface DryRunFilterClauseClass
16
+ */
17
+ export interface DryRunFilterClauseClass {
18
+ /**
19
+ * Textual fragment of the expression.
20
+ * @type {string}
21
+ * @memberof DryRunFilterClauseClass
22
+ */
23
+ 'clause': string;
24
+ /**
25
+ * Whether this clause matched.
26
+ * @type {boolean}
27
+ * @memberof DryRunFilterClauseClass
28
+ */
29
+ 'matched': boolean;
30
+ /**
31
+ * Actual value of the field side at evaluation time.
32
+ * @type {string}
33
+ * @memberof DryRunFilterClauseClass
34
+ */
35
+ 'resolvedValue'?: string;
36
+ /**
37
+ * Clause-specific error (e.g. did not evaluate to a boolean).
38
+ * @type {string}
39
+ * @memberof DryRunFilterClauseClass
40
+ */
41
+ 'error'?: string;
42
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * EMIL TaskService
6
+ * The EMIL Task API description
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ * Contact: kontakt@emil.de
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,30 @@
1
+ /**
2
+ * EMIL TaskService
3
+ * The EMIL Task API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface DryRunFilterRequestDto
16
+ */
17
+ export interface DryRunFilterRequestDto {
18
+ /**
19
+ * FEEL expression to test against the task.
20
+ * @type {string}
21
+ * @memberof DryRunFilterRequestDto
22
+ */
23
+ 'expression': string;
24
+ /**
25
+ * Code of the task to evaluate the expression against.
26
+ * @type {string}
27
+ * @memberof DryRunFilterRequestDto
28
+ */
29
+ 'taskCode': string;
30
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * EMIL TaskService
6
+ * The EMIL Task API description
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ * Contact: kontakt@emil.de
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,37 @@
1
+ /**
2
+ * EMIL TaskService
3
+ * The EMIL Task API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { DryRunFilterClauseClass } from './dry-run-filter-clause-class';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface DryRunFilterResponseClass
17
+ */
18
+ export interface DryRunFilterResponseClass {
19
+ /**
20
+ * Whether the expression matched the task.
21
+ * @type {boolean}
22
+ * @memberof DryRunFilterResponseClass
23
+ */
24
+ 'matched': boolean;
25
+ /**
26
+ * Per top-level clause breakdown of the evaluation.
27
+ * @type {Array<DryRunFilterClauseClass>}
28
+ * @memberof DryRunFilterResponseClass
29
+ */
30
+ 'clauses': Array<DryRunFilterClauseClass>;
31
+ /**
32
+ * Error if the expression failed — invalid field, syntax, or evaluation.
33
+ * @type {string}
34
+ * @memberof DryRunFilterResponseClass
35
+ */
36
+ 'error'?: string;
37
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * EMIL TaskService
6
+ * The EMIL Task API description
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ * Contact: kontakt@emil.de
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -12,6 +12,9 @@ export * from './create-status-request-dto';
12
12
  export * from './create-status-response-class';
13
13
  export * from './create-task-request-dto';
14
14
  export * from './create-task-response-class';
15
+ export * from './dry-run-filter-clause-class';
16
+ export * from './dry-run-filter-request-dto';
17
+ export * from './dry-run-filter-response-class';
15
18
  export * from './filter-class';
16
19
  export * from './get-category-response-class';
17
20
  export * from './get-filter-response-class';
@@ -28,6 +28,9 @@ __exportStar(require("./create-status-request-dto"), exports);
28
28
  __exportStar(require("./create-status-response-class"), exports);
29
29
  __exportStar(require("./create-task-request-dto"), exports);
30
30
  __exportStar(require("./create-task-response-class"), exports);
31
+ __exportStar(require("./dry-run-filter-clause-class"), exports);
32
+ __exportStar(require("./dry-run-filter-request-dto"), exports);
33
+ __exportStar(require("./dry-run-filter-response-class"), exports);
31
34
  __exportStar(require("./filter-class"), exports);
32
35
  __exportStar(require("./get-category-response-class"), exports);
33
36
  __exportStar(require("./get-filter-response-class"), exports);
@@ -0,0 +1,48 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL TaskService
5
+ * The EMIL Task API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface DryRunFilterClauseClass
21
+ */
22
+ export interface DryRunFilterClauseClass {
23
+ /**
24
+ * Textual fragment of the expression.
25
+ * @type {string}
26
+ * @memberof DryRunFilterClauseClass
27
+ */
28
+ 'clause': string;
29
+ /**
30
+ * Whether this clause matched.
31
+ * @type {boolean}
32
+ * @memberof DryRunFilterClauseClass
33
+ */
34
+ 'matched': boolean;
35
+ /**
36
+ * Actual value of the field side at evaluation time.
37
+ * @type {string}
38
+ * @memberof DryRunFilterClauseClass
39
+ */
40
+ 'resolvedValue'?: string;
41
+ /**
42
+ * Clause-specific error (e.g. did not evaluate to a boolean).
43
+ * @type {string}
44
+ * @memberof DryRunFilterClauseClass
45
+ */
46
+ 'error'?: string;
47
+ }
48
+
@@ -0,0 +1,36 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL TaskService
5
+ * The EMIL Task API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface DryRunFilterRequestDto
21
+ */
22
+ export interface DryRunFilterRequestDto {
23
+ /**
24
+ * FEEL expression to test against the task.
25
+ * @type {string}
26
+ * @memberof DryRunFilterRequestDto
27
+ */
28
+ 'expression': string;
29
+ /**
30
+ * Code of the task to evaluate the expression against.
31
+ * @type {string}
32
+ * @memberof DryRunFilterRequestDto
33
+ */
34
+ 'taskCode': string;
35
+ }
36
+
@@ -0,0 +1,43 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL TaskService
5
+ * The EMIL Task API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import { DryRunFilterClauseClass } from './dry-run-filter-clause-class';
17
+
18
+ /**
19
+ *
20
+ * @export
21
+ * @interface DryRunFilterResponseClass
22
+ */
23
+ export interface DryRunFilterResponseClass {
24
+ /**
25
+ * Whether the expression matched the task.
26
+ * @type {boolean}
27
+ * @memberof DryRunFilterResponseClass
28
+ */
29
+ 'matched': boolean;
30
+ /**
31
+ * Per top-level clause breakdown of the evaluation.
32
+ * @type {Array<DryRunFilterClauseClass>}
33
+ * @memberof DryRunFilterResponseClass
34
+ */
35
+ 'clauses': Array<DryRunFilterClauseClass>;
36
+ /**
37
+ * Error if the expression failed — invalid field, syntax, or evaluation.
38
+ * @type {string}
39
+ * @memberof DryRunFilterResponseClass
40
+ */
41
+ 'error'?: string;
42
+ }
43
+
package/models/index.ts CHANGED
@@ -12,6 +12,9 @@ export * from './create-status-request-dto';
12
12
  export * from './create-status-response-class';
13
13
  export * from './create-task-request-dto';
14
14
  export * from './create-task-response-class';
15
+ export * from './dry-run-filter-clause-class';
16
+ export * from './dry-run-filter-request-dto';
17
+ export * from './dry-run-filter-response-class';
15
18
  export * from './filter-class';
16
19
  export * from './get-category-response-class';
17
20
  export * from './get-filter-response-class';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@emilgroup/task-sdk-node",
3
- "version": "1.7.1-beta.4",
3
+ "version": "1.7.1-beta.6",
4
4
  "description": "OpenAPI client for @emilgroup/task-sdk-node",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [