@emilgroup/task-sdk 1.9.1-beta.4 → 1.9.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@1.9.1-beta.4 --save
20
+ npm install @emilgroup/task-sdk@1.9.1-beta.6 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/task-sdk@1.9.1-beta.4
24
+ yarn add @emilgroup/task-sdk@1.9.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';
@@ -130,6 +134,53 @@ export const FiltersApiAxiosParamCreator = function (configuration?: Configurati
130
134
  options: localVarRequestOptions,
131
135
  };
132
136
  },
137
+ /**
138
+ * Test a candidate filter expression against a specific task without saving a filter. **Required Permissions** \"task-management.task-filters.create\"
139
+ * @summary Create the filter dry-run
140
+ * @param {DryRunFilterRequestDto} dryRunFilterRequestDto
141
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
142
+ * @param {*} [options] Override http request option.
143
+ * @throws {RequiredError}
144
+ */
145
+ dryRunFilter: async (dryRunFilterRequestDto: DryRunFilterRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
146
+ // verify required parameter 'dryRunFilterRequestDto' is not null or undefined
147
+ assertParamExists('dryRunFilter', 'dryRunFilterRequestDto', dryRunFilterRequestDto)
148
+ const localVarPath = `/taskservice/v1/filters/dry-run`;
149
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
150
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
151
+ let baseOptions;
152
+ let baseAccessToken;
153
+ if (configuration) {
154
+ baseOptions = configuration.baseOptions;
155
+ baseAccessToken = configuration.accessToken;
156
+ }
157
+
158
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
159
+ const localVarHeaderParameter = {} as any;
160
+ const localVarQueryParameter = {} as any;
161
+
162
+ // authentication bearer required
163
+ // http bearer authentication required
164
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
165
+
166
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
167
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
168
+ }
169
+
170
+
171
+
172
+ localVarHeaderParameter['Content-Type'] = 'application/json';
173
+
174
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
175
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
176
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
177
+ localVarRequestOptions.data = serializeDataIfNeeded(dryRunFilterRequestDto, localVarRequestOptions, configuration)
178
+
179
+ return {
180
+ url: toPathString(localVarUrlObj),
181
+ options: localVarRequestOptions,
182
+ };
183
+ },
133
184
  /**
134
185
  * Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
135
186
  * @summary Retrieve the filter
@@ -176,16 +227,16 @@ export const FiltersApiAxiosParamCreator = function (configuration?: Configurati
176
227
  };
177
228
  },
178
229
  /**
179
- * 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\"
230
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
180
231
  * @summary List filters
181
232
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
182
233
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
183
234
  * @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.
184
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
185
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
186
- * @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.
187
- * @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.
188
- * @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.
235
+ * @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;
236
+ * @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;
237
+ * @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;
238
+ * @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;
239
+ * @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;
189
240
  * @param {*} [options] Override http request option.
190
241
  * @throws {RequiredError}
191
242
  */
@@ -336,6 +387,18 @@ export const FiltersApiFp = function(configuration?: Configuration) {
336
387
  const localVarAxiosArgs = await localVarAxiosParamCreator.deleteFilter(code, authorization, options);
337
388
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
338
389
  },
390
+ /**
391
+ * Test a candidate filter expression against a specific task without saving a filter. **Required Permissions** \"task-management.task-filters.create\"
392
+ * @summary Create the filter dry-run
393
+ * @param {DryRunFilterRequestDto} dryRunFilterRequestDto
394
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
395
+ * @param {*} [options] Override http request option.
396
+ * @throws {RequiredError}
397
+ */
398
+ async dryRunFilter(dryRunFilterRequestDto: DryRunFilterRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DryRunFilterResponseClass>> {
399
+ const localVarAxiosArgs = await localVarAxiosParamCreator.dryRunFilter(dryRunFilterRequestDto, authorization, options);
400
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
401
+ },
339
402
  /**
340
403
  * Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
341
404
  * @summary Retrieve the filter
@@ -349,16 +412,16 @@ export const FiltersApiFp = function(configuration?: Configuration) {
349
412
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
350
413
  },
351
414
  /**
352
- * 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\"
415
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
353
416
  * @summary List filters
354
417
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
355
418
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
356
419
  * @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.
357
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
358
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
359
- * @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.
360
- * @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.
361
- * @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.
420
+ * @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;
421
+ * @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;
422
+ * @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;
423
+ * @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;
424
+ * @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;
362
425
  * @param {*} [options] Override http request option.
363
426
  * @throws {RequiredError}
364
427
  */
@@ -411,6 +474,17 @@ export const FiltersApiFactory = function (configuration?: Configuration, basePa
411
474
  deleteFilter(code: string, authorization?: string, options?: any): AxiosPromise<void> {
412
475
  return localVarFp.deleteFilter(code, authorization, options).then((request) => request(axios, basePath));
413
476
  },
477
+ /**
478
+ * Test a candidate filter expression against a specific task without saving a filter. **Required Permissions** \"task-management.task-filters.create\"
479
+ * @summary Create the filter dry-run
480
+ * @param {DryRunFilterRequestDto} dryRunFilterRequestDto
481
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
482
+ * @param {*} [options] Override http request option.
483
+ * @throws {RequiredError}
484
+ */
485
+ dryRunFilter(dryRunFilterRequestDto: DryRunFilterRequestDto, authorization?: string, options?: any): AxiosPromise<DryRunFilterResponseClass> {
486
+ return localVarFp.dryRunFilter(dryRunFilterRequestDto, authorization, options).then((request) => request(axios, basePath));
487
+ },
414
488
  /**
415
489
  * Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
416
490
  * @summary Retrieve the filter
@@ -423,16 +497,16 @@ export const FiltersApiFactory = function (configuration?: Configuration, basePa
423
497
  return localVarFp.getFilter(code, authorization, options).then((request) => request(axios, basePath));
424
498
  },
425
499
  /**
426
- * 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\"
500
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
427
501
  * @summary List filters
428
502
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
429
503
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
430
504
  * @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.
431
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
432
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
433
- * @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.
434
- * @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.
435
- * @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.
505
+ * @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;
506
+ * @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;
507
+ * @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;
508
+ * @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;
509
+ * @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;
436
510
  * @param {*} [options] Override http request option.
437
511
  * @throws {RequiredError}
438
512
  */
@@ -496,6 +570,27 @@ export interface FiltersApiDeleteFilterRequest {
496
570
  readonly authorization?: string
497
571
  }
498
572
 
573
+ /**
574
+ * Request parameters for dryRunFilter operation in FiltersApi.
575
+ * @export
576
+ * @interface FiltersApiDryRunFilterRequest
577
+ */
578
+ export interface FiltersApiDryRunFilterRequest {
579
+ /**
580
+ *
581
+ * @type {DryRunFilterRequestDto}
582
+ * @memberof FiltersApiDryRunFilter
583
+ */
584
+ readonly dryRunFilterRequestDto: DryRunFilterRequestDto
585
+
586
+ /**
587
+ * Bearer Token: provided by the login endpoint under the name accessToken.
588
+ * @type {string}
589
+ * @memberof FiltersApiDryRunFilter
590
+ */
591
+ readonly authorization?: string
592
+ }
593
+
499
594
  /**
500
595
  * Request parameters for getFilter operation in FiltersApi.
501
596
  * @export
@@ -545,35 +640,35 @@ export interface FiltersApiListFiltersRequest {
545
640
  readonly pageToken?: string
546
641
 
547
642
  /**
548
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
643
+ * 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;
549
644
  * @type {string}
550
645
  * @memberof FiltersApiListFilters
551
646
  */
552
647
  readonly filter?: string
553
648
 
554
649
  /**
555
- * To search the list by any field, pass search&#x3D;xxx to fetch the result.
650
+ * 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;
556
651
  * @type {string}
557
652
  * @memberof FiltersApiListFilters
558
653
  */
559
654
  readonly search?: string
560
655
 
561
656
  /**
562
- * 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.
657
+ * 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;
563
658
  * @type {string}
564
659
  * @memberof FiltersApiListFilters
565
660
  */
566
661
  readonly order?: string
567
662
 
568
663
  /**
569
- * 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.
664
+ * 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;
570
665
  * @type {string}
571
666
  * @memberof FiltersApiListFilters
572
667
  */
573
668
  readonly expand?: string
574
669
 
575
670
  /**
576
- * 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.
671
+ * 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;
577
672
  * @type {string}
578
673
  * @memberof FiltersApiListFilters
579
674
  */
@@ -639,6 +734,18 @@ export class FiltersApi extends BaseAPI {
639
734
  return FiltersApiFp(this.configuration).deleteFilter(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
640
735
  }
641
736
 
737
+ /**
738
+ * Test a candidate filter expression against a specific task without saving a filter. **Required Permissions** \"task-management.task-filters.create\"
739
+ * @summary Create the filter dry-run
740
+ * @param {FiltersApiDryRunFilterRequest} requestParameters Request parameters.
741
+ * @param {*} [options] Override http request option.
742
+ * @throws {RequiredError}
743
+ * @memberof FiltersApi
744
+ */
745
+ public dryRunFilter(requestParameters: FiltersApiDryRunFilterRequest, options?: AxiosRequestConfig) {
746
+ return FiltersApiFp(this.configuration).dryRunFilter(requestParameters.dryRunFilterRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
747
+ }
748
+
642
749
  /**
643
750
  * Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
644
751
  * @summary Retrieve the filter
@@ -652,7 +759,7 @@ export class FiltersApi extends BaseAPI {
652
759
  }
653
760
 
654
761
  /**
655
- * 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\"
762
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
656
763
  * @summary List filters
657
764
  * @param {FiltersApiListFiltersRequest} requestParameters Request parameters.
658
765
  * @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.
@@ -189,6 +189,55 @@ var FiltersApiAxiosParamCreator = function (configuration) {
189
189
  });
190
190
  });
191
191
  },
192
+ /**
193
+ * Test a candidate filter expression against a specific task without saving a filter. **Required Permissions** \"task-management.task-filters.create\"
194
+ * @summary Create the filter dry-run
195
+ * @param {DryRunFilterRequestDto} dryRunFilterRequestDto
196
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
197
+ * @param {*} [options] Override http request option.
198
+ * @throws {RequiredError}
199
+ */
200
+ dryRunFilter: function (dryRunFilterRequestDto, authorization, options) {
201
+ if (options === void 0) { options = {}; }
202
+ return __awaiter(_this, void 0, void 0, function () {
203
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
204
+ return __generator(this, function (_a) {
205
+ switch (_a.label) {
206
+ case 0:
207
+ // verify required parameter 'dryRunFilterRequestDto' is not null or undefined
208
+ (0, common_1.assertParamExists)('dryRunFilter', 'dryRunFilterRequestDto', dryRunFilterRequestDto);
209
+ localVarPath = "/taskservice/v1/filters/dry-run";
210
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
211
+ if (configuration) {
212
+ baseOptions = configuration.baseOptions;
213
+ baseAccessToken = configuration.accessToken;
214
+ }
215
+ localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
216
+ localVarHeaderParameter = {};
217
+ localVarQueryParameter = {};
218
+ // authentication bearer required
219
+ // http bearer authentication required
220
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
221
+ case 1:
222
+ // authentication bearer required
223
+ // http bearer authentication required
224
+ _a.sent();
225
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
226
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
227
+ }
228
+ localVarHeaderParameter['Content-Type'] = 'application/json';
229
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
230
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
231
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
232
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(dryRunFilterRequestDto, localVarRequestOptions, configuration);
233
+ return [2 /*return*/, {
234
+ url: (0, common_1.toPathString)(localVarUrlObj),
235
+ options: localVarRequestOptions,
236
+ }];
237
+ }
238
+ });
239
+ });
240
+ },
192
241
  /**
193
242
  * Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
194
243
  * @summary Retrieve the filter
@@ -238,16 +287,16 @@ var FiltersApiAxiosParamCreator = function (configuration) {
238
287
  });
239
288
  },
240
289
  /**
241
- * 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\"
290
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
242
291
  * @summary List filters
243
292
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
244
293
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
245
294
  * @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.
246
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
247
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
248
- * @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.
249
- * @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.
250
- * @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.
295
+ * @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;
296
+ * @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;
297
+ * @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;
298
+ * @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;
299
+ * @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;
251
300
  * @param {*} [options] Override http request option.
252
301
  * @throws {RequiredError}
253
302
  */
@@ -414,6 +463,27 @@ var FiltersApiFp = function (configuration) {
414
463
  });
415
464
  });
416
465
  },
466
+ /**
467
+ * Test a candidate filter expression against a specific task without saving a filter. **Required Permissions** \"task-management.task-filters.create\"
468
+ * @summary Create the filter dry-run
469
+ * @param {DryRunFilterRequestDto} dryRunFilterRequestDto
470
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
471
+ * @param {*} [options] Override http request option.
472
+ * @throws {RequiredError}
473
+ */
474
+ dryRunFilter: function (dryRunFilterRequestDto, authorization, options) {
475
+ return __awaiter(this, void 0, void 0, function () {
476
+ var localVarAxiosArgs;
477
+ return __generator(this, function (_a) {
478
+ switch (_a.label) {
479
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.dryRunFilter(dryRunFilterRequestDto, authorization, options)];
480
+ case 1:
481
+ localVarAxiosArgs = _a.sent();
482
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
483
+ }
484
+ });
485
+ });
486
+ },
417
487
  /**
418
488
  * Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
419
489
  * @summary Retrieve the filter
@@ -436,16 +506,16 @@ var FiltersApiFp = function (configuration) {
436
506
  });
437
507
  },
438
508
  /**
439
- * 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\"
509
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
440
510
  * @summary List filters
441
511
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
442
512
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
443
513
  * @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.
444
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
445
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
446
- * @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.
447
- * @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.
448
- * @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.
514
+ * @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;
515
+ * @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;
516
+ * @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;
517
+ * @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;
518
+ * @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;
449
519
  * @param {*} [options] Override http request option.
450
520
  * @throws {RequiredError}
451
521
  */
@@ -516,6 +586,17 @@ var FiltersApiFactory = function (configuration, basePath, axios) {
516
586
  deleteFilter: function (code, authorization, options) {
517
587
  return localVarFp.deleteFilter(code, authorization, options).then(function (request) { return request(axios, basePath); });
518
588
  },
589
+ /**
590
+ * Test a candidate filter expression against a specific task without saving a filter. **Required Permissions** \"task-management.task-filters.create\"
591
+ * @summary Create the filter dry-run
592
+ * @param {DryRunFilterRequestDto} dryRunFilterRequestDto
593
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
594
+ * @param {*} [options] Override http request option.
595
+ * @throws {RequiredError}
596
+ */
597
+ dryRunFilter: function (dryRunFilterRequestDto, authorization, options) {
598
+ return localVarFp.dryRunFilter(dryRunFilterRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
599
+ },
519
600
  /**
520
601
  * Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
521
602
  * @summary Retrieve the filter
@@ -528,16 +609,16 @@ var FiltersApiFactory = function (configuration, basePath, axios) {
528
609
  return localVarFp.getFilter(code, authorization, options).then(function (request) { return request(axios, basePath); });
529
610
  },
530
611
  /**
531
- * 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\"
612
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
532
613
  * @summary List filters
533
614
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
534
615
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
535
616
  * @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.
536
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
537
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
538
- * @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.
539
- * @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.
540
- * @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.
617
+ * @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;
618
+ * @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;
619
+ * @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;
620
+ * @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;
621
+ * @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;
541
622
  * @param {*} [options] Override http request option.
542
623
  * @throws {RequiredError}
543
624
  */
@@ -594,6 +675,18 @@ var FiltersApi = /** @class */ (function (_super) {
594
675
  var _this = this;
595
676
  return (0, exports.FiltersApiFp)(this.configuration).deleteFilter(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
596
677
  };
678
+ /**
679
+ * Test a candidate filter expression against a specific task without saving a filter. **Required Permissions** \"task-management.task-filters.create\"
680
+ * @summary Create the filter dry-run
681
+ * @param {FiltersApiDryRunFilterRequest} requestParameters Request parameters.
682
+ * @param {*} [options] Override http request option.
683
+ * @throws {RequiredError}
684
+ * @memberof FiltersApi
685
+ */
686
+ FiltersApi.prototype.dryRunFilter = function (requestParameters, options) {
687
+ var _this = this;
688
+ return (0, exports.FiltersApiFp)(this.configuration).dryRunFilter(requestParameters.dryRunFilterRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
689
+ };
597
690
  /**
598
691
  * Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
599
692
  * @summary Retrieve the filter
@@ -607,7 +700,7 @@ var FiltersApi = /** @class */ (function (_super) {
607
700
  return (0, exports.FiltersApiFp)(this.configuration).getFilter(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
608
701
  };
609
702
  /**
610
- * 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\"
703
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
611
704
  * @summary List filters
612
705
  * @param {FiltersApiListFiltersRequest} requestParameters Request parameters.
613
706
  * @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",
3
- "version": "1.9.1-beta.4",
3
+ "version": "1.9.1-beta.6",
4
4
  "description": "OpenAPI client for @emilgroup/task-sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [