@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
@@ -17,6 +17,7 @@ common.ts
17
17
  configuration.ts
18
18
  git_push.sh
19
19
  index.ts
20
+ models/add-secondary-link-response-class.ts
20
21
  models/assignee-class.ts
21
22
  models/category-class.ts
22
23
  models/create-category-request-dto.ts
@@ -31,6 +32,11 @@ models/create-status-request-dto.ts
31
32
  models/create-status-response-class.ts
32
33
  models/create-task-request-dto.ts
33
34
  models/create-task-response-class.ts
35
+ models/dry-run-filter-clause-class.ts
36
+ models/dry-run-filter-request-dto.ts
37
+ models/dry-run-filter-response-class.ts
38
+ models/entity-ref-class.ts
39
+ models/entity-ref-dto.ts
34
40
  models/filter-class.ts
35
41
  models/get-category-response-class.ts
36
42
  models/get-filter-response-class.ts
@@ -60,6 +66,8 @@ models/patch-status-response-class.ts
60
66
  models/patch-task-request-dto.ts
61
67
  models/patch-task-response-class.ts
62
68
  models/reminder-class.ts
69
+ models/remove-secondary-link-response-class.ts
70
+ models/secondary-link-class.ts
63
71
  models/status-class.ts
64
72
  models/task-class.ts
65
73
  models/update-filter-request-dto.ts
package/README.md CHANGED
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
17
17
  Navigate to the folder of your consuming project and run one of the following commands:
18
18
 
19
19
  ```
20
- npm install @emilgroup/task-sdk-node@1.7.1-beta.4 --save
20
+ npm install @emilgroup/task-sdk-node@1.7.1-beta.41 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/task-sdk-node@1.7.1-beta.4
24
+ yarn add @emilgroup/task-sdk-node@1.7.1-beta.41
25
25
  ```
26
26
 
27
27
  And then you can import `TasksApi`.
@@ -63,8 +63,10 @@ export const AssigneesApiAxiosParamCreator = function (configuration?: Configura
63
63
  localVarQueryParameter['expand'] = expand;
64
64
  }
65
65
 
66
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
67
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
66
+ // Only Authorization falls back to the configured token; an empty value is never sent.
67
+ const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
68
+ if (authorizationValue) {
69
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
68
70
  }
69
71
 
70
72
 
@@ -71,8 +71,10 @@ export const CategoriesApiAxiosParamCreator = function (configuration?: Configur
71
71
  // http bearer authentication required
72
72
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
73
73
 
74
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
75
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
74
+ // Only Authorization falls back to the configured token; an empty value is never sent.
75
+ const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
76
+ if (authorizationValue) {
77
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
76
78
  }
77
79
 
78
80
 
@@ -119,8 +121,10 @@ export const CategoriesApiAxiosParamCreator = function (configuration?: Configur
119
121
  // http bearer authentication required
120
122
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
121
123
 
122
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
123
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
124
+ // Only Authorization falls back to the configured token; an empty value is never sent.
125
+ const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
126
+ if (authorizationValue) {
127
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
124
128
  }
125
129
 
126
130
 
@@ -169,8 +173,10 @@ export const CategoriesApiAxiosParamCreator = function (configuration?: Configur
169
173
  localVarQueryParameter['expand'] = expand;
170
174
  }
171
175
 
172
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
173
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
176
+ // Only Authorization falls back to the configured token; an empty value is never sent.
177
+ const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
178
+ if (authorizationValue) {
179
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
174
180
  }
175
181
 
176
182
 
@@ -245,8 +251,10 @@ export const CategoriesApiAxiosParamCreator = function (configuration?: Configur
245
251
  localVarQueryParameter['filters'] = filters;
246
252
  }
247
253
 
248
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
249
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
254
+ // Only Authorization falls back to the configured token; an empty value is never sent.
255
+ const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
256
+ if (authorizationValue) {
257
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
250
258
  }
251
259
 
252
260
 
@@ -293,8 +301,10 @@ export const CategoriesApiAxiosParamCreator = function (configuration?: Configur
293
301
  // http bearer authentication required
294
302
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
295
303
 
296
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
297
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
304
+ // Only Authorization falls back to the configured token; an empty value is never sent.
305
+ const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
306
+ if (authorizationValue) {
307
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
298
308
  }
299
309
 
300
310
 
@@ -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';
@@ -71,8 +75,10 @@ export const FiltersApiAxiosParamCreator = function (configuration?: Configurati
71
75
  // http bearer authentication required
72
76
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
73
77
 
74
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
75
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
78
+ // Only Authorization falls back to the configured token; an empty value is never sent.
79
+ const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
80
+ if (authorizationValue) {
81
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
76
82
  }
77
83
 
78
84
 
@@ -119,8 +125,10 @@ export const FiltersApiAxiosParamCreator = function (configuration?: Configurati
119
125
  // http bearer authentication required
120
126
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
121
127
 
122
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
123
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
128
+ // Only Authorization falls back to the configured token; an empty value is never sent.
129
+ const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
130
+ if (authorizationValue) {
131
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
124
132
  }
125
133
 
126
134
 
@@ -134,6 +142,55 @@ export const FiltersApiAxiosParamCreator = function (configuration?: Configurati
134
142
  options: localVarRequestOptions,
135
143
  };
136
144
  },
145
+ /**
146
+ * Test a candidate filter expression against a specific task without saving a filter. **Required Permissions** \"task-management.task-filters.create\"
147
+ * @summary Create the filter dry-run
148
+ * @param {DryRunFilterRequestDto} dryRunFilterRequestDto
149
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
150
+ * @param {*} [options] Override http request option.
151
+ * @throws {RequiredError}
152
+ */
153
+ dryRunFilter: async (dryRunFilterRequestDto: DryRunFilterRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
154
+ // verify required parameter 'dryRunFilterRequestDto' is not null or undefined
155
+ assertParamExists('dryRunFilter', 'dryRunFilterRequestDto', dryRunFilterRequestDto)
156
+ const localVarPath = `/taskservice/v1/filters/dry-run`;
157
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
158
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
159
+ let baseOptions;
160
+ let baseAccessToken;
161
+ if (configuration) {
162
+ baseOptions = configuration.baseOptions;
163
+ baseAccessToken = configuration.accessToken;
164
+ }
165
+
166
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
167
+ const localVarHeaderParameter = {} as any;
168
+ const localVarQueryParameter = {} as any;
169
+
170
+ // authentication bearer required
171
+ // http bearer authentication required
172
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
173
+
174
+ // Only Authorization falls back to the configured token; an empty value is never sent.
175
+ const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
176
+ if (authorizationValue) {
177
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
178
+ }
179
+
180
+
181
+
182
+ localVarHeaderParameter['Content-Type'] = 'application/json';
183
+
184
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
185
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
186
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
187
+ localVarRequestOptions.data = serializeDataIfNeeded(dryRunFilterRequestDto, localVarRequestOptions, configuration)
188
+
189
+ return {
190
+ url: toPathString(localVarUrlObj),
191
+ options: localVarRequestOptions,
192
+ };
193
+ },
137
194
  /**
138
195
  * Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
139
196
  * @summary Retrieve the filter
@@ -164,8 +221,10 @@ export const FiltersApiAxiosParamCreator = function (configuration?: Configurati
164
221
  // http bearer authentication required
165
222
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
166
223
 
167
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
168
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
224
+ // Only Authorization falls back to the configured token; an empty value is never sent.
225
+ const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
226
+ if (authorizationValue) {
227
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
169
228
  }
170
229
 
171
230
 
@@ -180,16 +239,16 @@ export const FiltersApiAxiosParamCreator = function (configuration?: Configurati
180
239
  };
181
240
  },
182
241
  /**
183
- * Returns a list of filters you have previously created. The filters are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"task-management.task-filters.view\"
242
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
184
243
  * @summary List filters
185
244
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
186
245
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
187
246
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
188
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
189
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
190
- * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
191
- * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
192
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
247
+ * @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;
248
+ * @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;
249
+ * @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;
250
+ * @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;
251
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority&lt;/i&gt;
193
252
  * @param {*} [options] Override http request option.
194
253
  * @throws {RequiredError}
195
254
  */
@@ -240,8 +299,10 @@ export const FiltersApiAxiosParamCreator = function (configuration?: Configurati
240
299
  localVarQueryParameter['filters'] = filters;
241
300
  }
242
301
 
243
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
244
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
302
+ // Only Authorization falls back to the configured token; an empty value is never sent.
303
+ const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
304
+ if (authorizationValue) {
305
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
245
306
  }
246
307
 
247
308
 
@@ -288,8 +349,10 @@ export const FiltersApiAxiosParamCreator = function (configuration?: Configurati
288
349
  // http bearer authentication required
289
350
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
290
351
 
291
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
292
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
352
+ // Only Authorization falls back to the configured token; an empty value is never sent.
353
+ const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
354
+ if (authorizationValue) {
355
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
293
356
  }
294
357
 
295
358
 
@@ -340,6 +403,18 @@ export const FiltersApiFp = function(configuration?: Configuration) {
340
403
  const localVarAxiosArgs = await localVarAxiosParamCreator.deleteFilter(code, authorization, options);
341
404
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
342
405
  },
406
+ /**
407
+ * Test a candidate filter expression against a specific task without saving a filter. **Required Permissions** \"task-management.task-filters.create\"
408
+ * @summary Create the filter dry-run
409
+ * @param {DryRunFilterRequestDto} dryRunFilterRequestDto
410
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
411
+ * @param {*} [options] Override http request option.
412
+ * @throws {RequiredError}
413
+ */
414
+ async dryRunFilter(dryRunFilterRequestDto: DryRunFilterRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DryRunFilterResponseClass>> {
415
+ const localVarAxiosArgs = await localVarAxiosParamCreator.dryRunFilter(dryRunFilterRequestDto, authorization, options);
416
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
417
+ },
343
418
  /**
344
419
  * Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
345
420
  * @summary Retrieve the filter
@@ -353,16 +428,16 @@ export const FiltersApiFp = function(configuration?: Configuration) {
353
428
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
354
429
  },
355
430
  /**
356
- * Returns a list of filters you have previously created. The filters are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"task-management.task-filters.view\"
431
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
357
432
  * @summary List filters
358
433
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
359
434
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
360
435
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
361
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
362
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
363
- * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
364
- * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
365
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
436
+ * @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;
437
+ * @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;
438
+ * @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;
439
+ * @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;
440
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority&lt;/i&gt;
366
441
  * @param {*} [options] Override http request option.
367
442
  * @throws {RequiredError}
368
443
  */
@@ -415,6 +490,17 @@ export const FiltersApiFactory = function (configuration?: Configuration, basePa
415
490
  deleteFilter(code: string, authorization?: string, options?: any): AxiosPromise<void> {
416
491
  return localVarFp.deleteFilter(code, authorization, options).then((request) => request(axios, basePath));
417
492
  },
493
+ /**
494
+ * Test a candidate filter expression against a specific task without saving a filter. **Required Permissions** \"task-management.task-filters.create\"
495
+ * @summary Create the filter dry-run
496
+ * @param {DryRunFilterRequestDto} dryRunFilterRequestDto
497
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
498
+ * @param {*} [options] Override http request option.
499
+ * @throws {RequiredError}
500
+ */
501
+ dryRunFilter(dryRunFilterRequestDto: DryRunFilterRequestDto, authorization?: string, options?: any): AxiosPromise<DryRunFilterResponseClass> {
502
+ return localVarFp.dryRunFilter(dryRunFilterRequestDto, authorization, options).then((request) => request(axios, basePath));
503
+ },
418
504
  /**
419
505
  * Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
420
506
  * @summary Retrieve the filter
@@ -427,16 +513,16 @@ export const FiltersApiFactory = function (configuration?: Configuration, basePa
427
513
  return localVarFp.getFilter(code, authorization, options).then((request) => request(axios, basePath));
428
514
  },
429
515
  /**
430
- * Returns a list of filters you have previously created. The filters are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"task-management.task-filters.view\"
516
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
431
517
  * @summary List filters
432
518
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
433
519
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
434
520
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
435
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
436
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
437
- * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
438
- * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
439
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
521
+ * @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;
522
+ * @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;
523
+ * @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;
524
+ * @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;
525
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority&lt;/i&gt;
440
526
  * @param {*} [options] Override http request option.
441
527
  * @throws {RequiredError}
442
528
  */
@@ -500,6 +586,27 @@ export interface FiltersApiDeleteFilterRequest {
500
586
  readonly authorization?: string
501
587
  }
502
588
 
589
+ /**
590
+ * Request parameters for dryRunFilter operation in FiltersApi.
591
+ * @export
592
+ * @interface FiltersApiDryRunFilterRequest
593
+ */
594
+ export interface FiltersApiDryRunFilterRequest {
595
+ /**
596
+ *
597
+ * @type {DryRunFilterRequestDto}
598
+ * @memberof FiltersApiDryRunFilter
599
+ */
600
+ readonly dryRunFilterRequestDto: DryRunFilterRequestDto
601
+
602
+ /**
603
+ * Bearer Token: provided by the login endpoint under the name accessToken.
604
+ * @type {string}
605
+ * @memberof FiltersApiDryRunFilter
606
+ */
607
+ readonly authorization?: string
608
+ }
609
+
503
610
  /**
504
611
  * Request parameters for getFilter operation in FiltersApi.
505
612
  * @export
@@ -549,35 +656,35 @@ export interface FiltersApiListFiltersRequest {
549
656
  readonly pageToken?: string
550
657
 
551
658
  /**
552
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
659
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority&lt;/i&gt;
553
660
  * @type {string}
554
661
  * @memberof FiltersApiListFilters
555
662
  */
556
663
  readonly filter?: string
557
664
 
558
665
  /**
559
- * To search the list by any field, pass search&#x3D;xxx to fetch the result.
666
+ * Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: name, slug&lt;/i&gt;
560
667
  * @type {string}
561
668
  * @memberof FiltersApiListFilters
562
669
  */
563
670
  readonly search?: string
564
671
 
565
672
  /**
566
- * The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
673
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, updatedAt, name, slug, priority&lt;/i&gt;
567
674
  * @type {string}
568
675
  * @memberof FiltersApiListFilters
569
676
  */
570
677
  readonly order?: string
571
678
 
572
679
  /**
573
- * Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
680
+ * Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
574
681
  * @type {string}
575
682
  * @memberof FiltersApiListFilters
576
683
  */
577
684
  readonly expand?: string
578
685
 
579
686
  /**
580
- * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
687
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority&lt;/i&gt;
581
688
  * @type {string}
582
689
  * @memberof FiltersApiListFilters
583
690
  */
@@ -643,6 +750,18 @@ export class FiltersApi extends BaseAPI {
643
750
  return FiltersApiFp(this.configuration).deleteFilter(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
644
751
  }
645
752
 
753
+ /**
754
+ * Test a candidate filter expression against a specific task without saving a filter. **Required Permissions** \"task-management.task-filters.create\"
755
+ * @summary Create the filter dry-run
756
+ * @param {FiltersApiDryRunFilterRequest} requestParameters Request parameters.
757
+ * @param {*} [options] Override http request option.
758
+ * @throws {RequiredError}
759
+ * @memberof FiltersApi
760
+ */
761
+ public dryRunFilter(requestParameters: FiltersApiDryRunFilterRequest, options?: AxiosRequestConfig) {
762
+ return FiltersApiFp(this.configuration).dryRunFilter(requestParameters.dryRunFilterRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
763
+ }
764
+
646
765
  /**
647
766
  * Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
648
767
  * @summary Retrieve the filter
@@ -656,7 +775,7 @@ export class FiltersApi extends BaseAPI {
656
775
  }
657
776
 
658
777
  /**
659
- * Returns a list of filters you have previously created. The filters are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"task-management.task-filters.view\"
778
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
660
779
  * @summary List filters
661
780
  * @param {FiltersApiListFiltersRequest} requestParameters Request parameters.
662
781
  * @param {*} [options] Override http request option.
@@ -63,8 +63,10 @@ export const HubSpotApiAxiosParamCreator = function (configuration?: Configurati
63
63
  // http bearer authentication required
64
64
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
65
65
 
66
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
67
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
66
+ // Only Authorization falls back to the configured token; an empty value is never sent.
67
+ const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
68
+ if (authorizationValue) {
69
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
68
70
  }
69
71
 
70
72
 
@@ -75,8 +75,10 @@ export const RemindersApiAxiosParamCreator = function (configuration?: Configura
75
75
  // http bearer authentication required
76
76
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
77
77
 
78
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
79
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
78
+ // Only Authorization falls back to the configured token; an empty value is never sent.
79
+ const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
80
+ if (authorizationValue) {
81
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
80
82
  }
81
83
 
82
84
 
@@ -123,8 +125,10 @@ export const RemindersApiAxiosParamCreator = function (configuration?: Configura
123
125
  // http bearer authentication required
124
126
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
125
127
 
126
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
127
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
128
+ // Only Authorization falls back to the configured token; an empty value is never sent.
129
+ const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
130
+ if (authorizationValue) {
131
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
128
132
  }
129
133
 
130
134
 
@@ -175,8 +179,10 @@ export const RemindersApiAxiosParamCreator = function (configuration?: Configura
175
179
  localVarQueryParameter['expand'] = expand;
176
180
  }
177
181
 
178
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
179
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
182
+ // Only Authorization falls back to the configured token; an empty value is never sent.
183
+ const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
184
+ if (authorizationValue) {
185
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
180
186
  }
181
187
 
182
188
 
@@ -221,8 +227,10 @@ export const RemindersApiAxiosParamCreator = function (configuration?: Configura
221
227
  localVarQueryParameter['filters'] = filters;
222
228
  }
223
229
 
224
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
225
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
230
+ // Only Authorization falls back to the configured token; an empty value is never sent.
231
+ const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
232
+ if (authorizationValue) {
233
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
226
234
  }
227
235
 
228
236
 
@@ -297,8 +305,10 @@ export const RemindersApiAxiosParamCreator = function (configuration?: Configura
297
305
  localVarQueryParameter['filters'] = filters;
298
306
  }
299
307
 
300
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
301
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
308
+ // Only Authorization falls back to the configured token; an empty value is never sent.
309
+ const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
310
+ if (authorizationValue) {
311
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
302
312
  }
303
313
 
304
314
 
@@ -342,8 +352,10 @@ export const RemindersApiAxiosParamCreator = function (configuration?: Configura
342
352
  // http bearer authentication required
343
353
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
344
354
 
345
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
346
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
355
+ // Only Authorization falls back to the configured token; an empty value is never sent.
356
+ const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
357
+ if (authorizationValue) {
358
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
347
359
  }
348
360
 
349
361
 
@@ -386,8 +398,10 @@ export const RemindersApiAxiosParamCreator = function (configuration?: Configura
386
398
  // http bearer authentication required
387
399
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
388
400
 
389
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
390
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
401
+ // Only Authorization falls back to the configured token; an empty value is never sent.
402
+ const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
403
+ if (authorizationValue) {
404
+ localVarHeaderParameter['Authorization'] = String(authorizationValue);
391
405
  }
392
406
 
393
407