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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (64) hide show
  1. package/.openapi-generator/FILES +8 -0
  2. package/README.md +2 -2
  3. package/api/assignees-api.ts +4 -2
  4. package/api/categories-api.ts +20 -10
  5. package/api/filters-api.ts +153 -34
  6. package/api/hub-spot-api.ts +4 -2
  7. package/api/reminders-api.ts +28 -14
  8. package/api/statuses-api.ts +20 -10
  9. package/api/task-client-api.ts +329 -42
  10. package/api/tasks-api.ts +281 -18
  11. package/common.ts +3 -2
  12. package/dist/api/assignees-api.d.ts +1 -1
  13. package/dist/api/assignees-api.js +4 -3
  14. package/dist/api/categories-api.d.ts +5 -5
  15. package/dist/api/categories-api.js +29 -18
  16. package/dist/api/filters-api.d.ts +86 -29
  17. package/dist/api/filters-api.js +147 -38
  18. package/dist/api/health-api.d.ts +1 -1
  19. package/dist/api/hub-spot-api.d.ts +1 -1
  20. package/dist/api/hub-spot-api.js +7 -4
  21. package/dist/api/reminders-api.d.ts +7 -7
  22. package/dist/api/reminders-api.js +40 -25
  23. package/dist/api/statuses-api.d.ts +5 -5
  24. package/dist/api/statuses-api.js +29 -18
  25. package/dist/api/task-client-api.d.ts +165 -25
  26. package/dist/api/task-client-api.js +313 -67
  27. package/dist/api/tasks-api.d.ts +153 -13
  28. package/dist/api/tasks-api.js +244 -24
  29. package/dist/common.d.ts +1 -1
  30. package/dist/common.js +1 -0
  31. package/dist/models/add-secondary-link-response-class.d.ts +25 -0
  32. package/dist/models/add-secondary-link-response-class.js +15 -0
  33. package/dist/models/create-task-request-dto.d.ts +13 -0
  34. package/dist/models/dry-run-filter-clause-class.d.ts +42 -0
  35. package/dist/models/dry-run-filter-clause-class.js +15 -0
  36. package/dist/models/dry-run-filter-request-dto.d.ts +30 -0
  37. package/dist/models/dry-run-filter-request-dto.js +15 -0
  38. package/dist/models/dry-run-filter-response-class.d.ts +37 -0
  39. package/dist/models/dry-run-filter-response-class.js +15 -0
  40. package/dist/models/entity-ref-class.d.ts +34 -0
  41. package/dist/models/entity-ref-class.js +19 -0
  42. package/dist/models/entity-ref-dto.d.ts +34 -0
  43. package/dist/models/entity-ref-dto.js +19 -0
  44. package/dist/models/index.d.ts +8 -0
  45. package/dist/models/index.js +8 -0
  46. package/dist/models/patch-task-request-dto.d.ts +12 -0
  47. package/dist/models/remove-secondary-link-response-class.d.ts +25 -0
  48. package/dist/models/remove-secondary-link-response-class.js +15 -0
  49. package/dist/models/secondary-link-class.d.ts +31 -0
  50. package/dist/models/secondary-link-class.js +15 -0
  51. package/dist/models/task-class.d.ts +7 -0
  52. package/models/add-secondary-link-response-class.ts +31 -0
  53. package/models/create-task-request-dto.ts +13 -0
  54. package/models/dry-run-filter-clause-class.ts +48 -0
  55. package/models/dry-run-filter-request-dto.ts +36 -0
  56. package/models/dry-run-filter-response-class.ts +43 -0
  57. package/models/entity-ref-class.ts +43 -0
  58. package/models/entity-ref-dto.ts +43 -0
  59. package/models/index.ts +8 -0
  60. package/models/patch-task-request-dto.ts +12 -0
  61. package/models/remove-secondary-link-response-class.ts +31 -0
  62. package/models/secondary-link-class.ts +37 -0
  63. package/models/task-class.ts +7 -0
  64. package/package.json +2 -2
@@ -107,7 +107,7 @@ var CategoriesApiAxiosParamCreator = function (configuration) {
107
107
  createCategory: function (createCategoryRequestDto, authorization, options) {
108
108
  if (options === void 0) { options = {}; }
109
109
  return __awaiter(_this, void 0, void 0, function () {
110
- var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
110
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, authorizationValue, headersFromBaseOptions;
111
111
  return __generator(this, function (_a) {
112
112
  switch (_a.label) {
113
113
  case 0:
@@ -124,13 +124,16 @@ var CategoriesApiAxiosParamCreator = function (configuration) {
124
124
  localVarQueryParameter = {};
125
125
  // authentication bearer required
126
126
  // http bearer authentication required
127
- return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
127
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)
128
+ // Only Authorization falls back to the configured token; an empty value is never sent.
129
+ ];
128
130
  case 1:
129
131
  // authentication bearer required
130
132
  // http bearer authentication required
131
133
  _a.sent();
132
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
133
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
134
+ authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
135
+ if (authorizationValue) {
136
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
134
137
  }
135
138
  localVarHeaderParameter['Content-Type'] = 'application/json';
136
139
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
@@ -156,7 +159,7 @@ var CategoriesApiAxiosParamCreator = function (configuration) {
156
159
  deleteCategory: function (code, authorization, options) {
157
160
  if (options === void 0) { options = {}; }
158
161
  return __awaiter(_this, void 0, void 0, function () {
159
- var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
162
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, authorizationValue, headersFromBaseOptions;
160
163
  return __generator(this, function (_a) {
161
164
  switch (_a.label) {
162
165
  case 0:
@@ -174,13 +177,16 @@ var CategoriesApiAxiosParamCreator = function (configuration) {
174
177
  localVarQueryParameter = {};
175
178
  // authentication bearer required
176
179
  // http bearer authentication required
177
- return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
180
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)
181
+ // Only Authorization falls back to the configured token; an empty value is never sent.
182
+ ];
178
183
  case 1:
179
184
  // authentication bearer required
180
185
  // http bearer authentication required
181
186
  _a.sent();
182
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
183
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
187
+ authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
188
+ if (authorizationValue) {
189
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
184
190
  }
185
191
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
186
192
  headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -205,7 +211,7 @@ var CategoriesApiAxiosParamCreator = function (configuration) {
205
211
  getCategory: function (code, authorization, expand, options) {
206
212
  if (options === void 0) { options = {}; }
207
213
  return __awaiter(_this, void 0, void 0, function () {
208
- var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
214
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, authorizationValue, headersFromBaseOptions;
209
215
  return __generator(this, function (_a) {
210
216
  switch (_a.label) {
211
217
  case 0:
@@ -231,8 +237,9 @@ var CategoriesApiAxiosParamCreator = function (configuration) {
231
237
  if (expand !== undefined) {
232
238
  localVarQueryParameter['expand'] = expand;
233
239
  }
234
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
235
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
240
+ authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
241
+ if (authorizationValue) {
242
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
236
243
  }
237
244
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
238
245
  headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -262,7 +269,7 @@ var CategoriesApiAxiosParamCreator = function (configuration) {
262
269
  listCategories: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
263
270
  if (options === void 0) { options = {}; }
264
271
  return __awaiter(_this, void 0, void 0, function () {
265
- var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
272
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, authorizationValue, headersFromBaseOptions;
266
273
  return __generator(this, function (_a) {
267
274
  switch (_a.label) {
268
275
  case 0:
@@ -303,8 +310,9 @@ var CategoriesApiAxiosParamCreator = function (configuration) {
303
310
  if (filters !== undefined) {
304
311
  localVarQueryParameter['filters'] = filters;
305
312
  }
306
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
307
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
313
+ authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
314
+ if (authorizationValue) {
315
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
308
316
  }
309
317
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
310
318
  headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -329,7 +337,7 @@ var CategoriesApiAxiosParamCreator = function (configuration) {
329
337
  patchCategory: function (code, patchCategoryRequestDto, authorization, options) {
330
338
  if (options === void 0) { options = {}; }
331
339
  return __awaiter(_this, void 0, void 0, function () {
332
- var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
340
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, authorizationValue, headersFromBaseOptions;
333
341
  return __generator(this, function (_a) {
334
342
  switch (_a.label) {
335
343
  case 0:
@@ -349,13 +357,16 @@ var CategoriesApiAxiosParamCreator = function (configuration) {
349
357
  localVarQueryParameter = {};
350
358
  // authentication bearer required
351
359
  // http bearer authentication required
352
- return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
360
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)
361
+ // Only Authorization falls back to the configured token; an empty value is never sent.
362
+ ];
353
363
  case 1:
354
364
  // authentication bearer required
355
365
  // http bearer authentication required
356
366
  _a.sent();
357
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
358
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
367
+ authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
368
+ if (authorizationValue) {
369
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
359
370
  }
360
371
  localVarHeaderParameter['Content-Type'] = 'application/json';
361
372
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
@@ -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
  */
@@ -344,7 +392,7 @@ export declare class FiltersApi extends BaseAPI {
344
392
  * @throws {RequiredError}
345
393
  * @memberof FiltersApi
346
394
  */
347
- createFilter(requestParameters: FiltersApiCreateFilterRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateFilterResponseClass, any, {}>>;
395
+ createFilter(requestParameters: FiltersApiCreateFilterRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateFilterResponseClass, any, {}, any>>;
348
396
  /**
349
397
  * Delete a filter by its code. **Required Permissions** \"task-management.task-filters.delete\"
350
398
  * @summary Delete the filter
@@ -353,7 +401,16 @@ export declare class FiltersApi extends BaseAPI {
353
401
  * @throws {RequiredError}
354
402
  * @memberof FiltersApi
355
403
  */
356
- deleteFilter(requestParameters: FiltersApiDeleteFilterRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
404
+ deleteFilter(requestParameters: FiltersApiDeleteFilterRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}, 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, {}, any>>;
357
414
  /**
358
415
  * Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
359
416
  * @summary Retrieve the filter
@@ -362,16 +419,16 @@ export declare class FiltersApi extends BaseAPI {
362
419
  * @throws {RequiredError}
363
420
  * @memberof FiltersApi
364
421
  */
365
- getFilter(requestParameters: FiltersApiGetFilterRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFilterResponseClass, any, {}>>;
422
+ getFilter(requestParameters: FiltersApiGetFilterRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFilterResponseClass, any, {}, 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.
371
428
  * @throws {RequiredError}
372
429
  * @memberof FiltersApi
373
430
  */
374
- listFilters(requestParameters?: FiltersApiListFiltersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFiltersResponseClass, any, {}>>;
431
+ listFilters(requestParameters?: FiltersApiListFiltersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFiltersResponseClass, any, {}, any>>;
375
432
  /**
376
433
  * Update a filter (slug, name, description, expression, target group, priority, is_active, is_fallback). **Required Permissions** \"task-management.task-filters.update\"
377
434
  * @summary Update the filter
@@ -380,5 +437,5 @@ export declare class FiltersApi extends BaseAPI {
380
437
  * @throws {RequiredError}
381
438
  * @memberof FiltersApi
382
439
  */
383
- updateFilter(requestParameters: FiltersApiUpdateFilterRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateFilterResponseClass, any, {}>>;
440
+ updateFilter(requestParameters: FiltersApiUpdateFilterRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateFilterResponseClass, any, {}, any>>;
384
441
  }