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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
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.5 --save
20
+ npm install @emilgroup/task-sdk-node@1.7.1-beta.6 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/task-sdk-node@1.7.1-beta.5
24
+ yarn add @emilgroup/task-sdk-node@1.7.1-beta.6
25
25
  ```
26
26
 
27
27
  And then you can import `TasksApi`.
@@ -231,16 +231,16 @@ export const FiltersApiAxiosParamCreator = function (configuration?: Configurati
231
231
  };
232
232
  },
233
233
  /**
234
- * Returns a list of filters you have previously created. The filters are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"task-management.task-filters.view\"
234
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
235
235
  * @summary List filters
236
236
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
237
237
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
238
238
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
239
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
240
- * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
241
- * @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.
242
- * @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.
243
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
239
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority</i>
240
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: name, slug</i>
241
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, name, slug, priority</i>
242
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
243
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority</i>
244
244
  * @param {*} [options] Override http request option.
245
245
  * @throws {RequiredError}
246
246
  */
@@ -416,16 +416,16 @@ export const FiltersApiFp = function(configuration?: Configuration) {
416
416
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
417
417
  },
418
418
  /**
419
- * Returns a list of filters you have previously created. The filters are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"task-management.task-filters.view\"
419
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
420
420
  * @summary List filters
421
421
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
422
422
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
423
423
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
424
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
425
- * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
426
- * @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.
427
- * @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.
428
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
424
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority</i>
425
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: name, slug</i>
426
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, name, slug, priority</i>
427
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
428
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority</i>
429
429
  * @param {*} [options] Override http request option.
430
430
  * @throws {RequiredError}
431
431
  */
@@ -501,16 +501,16 @@ export const FiltersApiFactory = function (configuration?: Configuration, basePa
501
501
  return localVarFp.getFilter(code, authorization, options).then((request) => request(axios, basePath));
502
502
  },
503
503
  /**
504
- * Returns a list of filters you have previously created. The filters are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"task-management.task-filters.view\"
504
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
505
505
  * @summary List filters
506
506
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
507
507
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
508
508
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
509
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
510
- * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
511
- * @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.
512
- * @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.
513
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
509
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority</i>
510
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: name, slug</i>
511
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, name, slug, priority</i>
512
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
513
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority</i>
514
514
  * @param {*} [options] Override http request option.
515
515
  * @throws {RequiredError}
516
516
  */
@@ -644,35 +644,35 @@ export interface FiltersApiListFiltersRequest {
644
644
  readonly pageToken?: string
645
645
 
646
646
  /**
647
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
647
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority</i>
648
648
  * @type {string}
649
649
  * @memberof FiltersApiListFilters
650
650
  */
651
651
  readonly filter?: string
652
652
 
653
653
  /**
654
- * To search the list by any field, pass search=xxx to fetch the result.
654
+ * Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: name, slug</i>
655
655
  * @type {string}
656
656
  * @memberof FiltersApiListFilters
657
657
  */
658
658
  readonly search?: string
659
659
 
660
660
  /**
661
- * The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
661
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, name, slug, priority</i>
662
662
  * @type {string}
663
663
  * @memberof FiltersApiListFilters
664
664
  */
665
665
  readonly order?: string
666
666
 
667
667
  /**
668
- * Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
668
+ * Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
669
669
  * @type {string}
670
670
  * @memberof FiltersApiListFilters
671
671
  */
672
672
  readonly expand?: string
673
673
 
674
674
  /**
675
- * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
675
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority</i>
676
676
  * @type {string}
677
677
  * @memberof FiltersApiListFilters
678
678
  */
@@ -763,7 +763,7 @@ export class FiltersApi extends BaseAPI {
763
763
  }
764
764
 
765
765
  /**
766
- * Returns a list of filters you have previously created. The filters are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"task-management.task-filters.view\"
766
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
767
767
  * @summary List filters
768
768
  * @param {FiltersApiListFiltersRequest} requestParameters Request parameters.
769
769
  * @param {*} [options] Override http request option.
@@ -62,16 +62,16 @@ export declare const FiltersApiAxiosParamCreator: (configuration?: Configuration
62
62
  */
63
63
  getFilter: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
64
64
  /**
65
- * 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\"
66
66
  * @summary List filters
67
67
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
68
68
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
69
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.
70
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
71
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
72
- * @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.
73
- * @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.
74
- * @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;
75
75
  * @param {*} [options] Override http request option.
76
76
  * @throws {RequiredError}
77
77
  */
@@ -129,16 +129,16 @@ export declare const FiltersApiFp: (configuration?: Configuration) => {
129
129
  */
130
130
  getFilter(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFilterResponseClass>>;
131
131
  /**
132
- * 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\"
133
133
  * @summary List filters
134
134
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
135
135
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
136
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.
137
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
138
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
139
- * @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.
140
- * @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.
141
- * @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;
142
142
  * @param {*} [options] Override http request option.
143
143
  * @throws {RequiredError}
144
144
  */
@@ -196,16 +196,16 @@ export declare const FiltersApiFactory: (configuration?: Configuration, basePath
196
196
  */
197
197
  getFilter(code: string, authorization?: string, options?: any): AxiosPromise<GetFilterResponseClass>;
198
198
  /**
199
- * 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\"
200
200
  * @summary List filters
201
201
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
202
202
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
203
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.
204
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
205
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
206
- * @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.
207
- * @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.
208
- * @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;
209
209
  * @param {*} [options] Override http request option.
210
210
  * @throws {RequiredError}
211
211
  */
@@ -322,31 +322,31 @@ export interface FiltersApiListFiltersRequest {
322
322
  */
323
323
  readonly pageToken?: string;
324
324
  /**
325
- * 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;
326
326
  * @type {string}
327
327
  * @memberof FiltersApiListFilters
328
328
  */
329
329
  readonly filter?: string;
330
330
  /**
331
- * 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;
332
332
  * @type {string}
333
333
  * @memberof FiltersApiListFilters
334
334
  */
335
335
  readonly search?: string;
336
336
  /**
337
- * 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;
338
338
  * @type {string}
339
339
  * @memberof FiltersApiListFilters
340
340
  */
341
341
  readonly order?: string;
342
342
  /**
343
- * 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;
344
344
  * @type {string}
345
345
  * @memberof FiltersApiListFilters
346
346
  */
347
347
  readonly expand?: string;
348
348
  /**
349
- * 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;
350
350
  * @type {string}
351
351
  * @memberof FiltersApiListFilters
352
352
  */
@@ -421,7 +421,7 @@ export declare class FiltersApi extends BaseAPI {
421
421
  */
422
422
  getFilter(requestParameters: FiltersApiGetFilterRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFilterResponseClass, any, {}>>;
423
423
  /**
424
- * 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\"
425
425
  * @summary List filters
426
426
  * @param {FiltersApiListFiltersRequest} requestParameters Request parameters.
427
427
  * @param {*} [options] Override http request option.
@@ -291,16 +291,16 @@ var FiltersApiAxiosParamCreator = function (configuration) {
291
291
  });
292
292
  },
293
293
  /**
294
- * Returns a list of filters you have previously created. The filters are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"task-management.task-filters.view\"
294
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
295
295
  * @summary List filters
296
296
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
297
297
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
298
298
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
299
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
300
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
301
- * @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.
302
- * @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.
303
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
299
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority&lt;/i&gt;
300
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: name, slug&lt;/i&gt;
301
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, updatedAt, name, slug, priority&lt;/i&gt;
302
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
303
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority&lt;/i&gt;
304
304
  * @param {*} [options] Override http request option.
305
305
  * @throws {RequiredError}
306
306
  */
@@ -510,16 +510,16 @@ var FiltersApiFp = function (configuration) {
510
510
  });
511
511
  },
512
512
  /**
513
- * Returns a list of filters you have previously created. The filters are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"task-management.task-filters.view\"
513
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
514
514
  * @summary List filters
515
515
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
516
516
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
517
517
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
518
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
519
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
520
- * @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.
521
- * @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.
522
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
518
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority&lt;/i&gt;
519
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: name, slug&lt;/i&gt;
520
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, updatedAt, name, slug, priority&lt;/i&gt;
521
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
522
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority&lt;/i&gt;
523
523
  * @param {*} [options] Override http request option.
524
524
  * @throws {RequiredError}
525
525
  */
@@ -613,16 +613,16 @@ var FiltersApiFactory = function (configuration, basePath, axios) {
613
613
  return localVarFp.getFilter(code, authorization, options).then(function (request) { return request(axios, basePath); });
614
614
  },
615
615
  /**
616
- * Returns a list of filters you have previously created. The filters are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"task-management.task-filters.view\"
616
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
617
617
  * @summary List filters
618
618
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
619
619
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
620
620
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
621
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
622
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
623
- * @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.
624
- * @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.
625
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
621
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority&lt;/i&gt;
622
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: name, slug&lt;/i&gt;
623
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, updatedAt, name, slug, priority&lt;/i&gt;
624
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
625
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority&lt;/i&gt;
626
626
  * @param {*} [options] Override http request option.
627
627
  * @throws {RequiredError}
628
628
  */
@@ -704,7 +704,7 @@ var FiltersApi = /** @class */ (function (_super) {
704
704
  return (0, exports.FiltersApiFp)(this.configuration).getFilter(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
705
705
  };
706
706
  /**
707
- * Returns a list of filters you have previously created. The filters are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"task-management.task-filters.view\"
707
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
708
708
  * @summary List filters
709
709
  * @param {FiltersApiListFiltersRequest} requestParameters Request parameters.
710
710
  * @param {*} [options] Override http request option.
@@ -28,13 +28,13 @@ export interface DryRunFilterClauseClass {
28
28
  */
29
29
  'matched': boolean;
30
30
  /**
31
- * Actual value of the left-hand side at evaluation time.
31
+ * Actual value of the field side at evaluation time.
32
32
  * @type {string}
33
33
  * @memberof DryRunFilterClauseClass
34
34
  */
35
35
  'resolvedValue'?: string;
36
36
  /**
37
- * Null-path / type error specific to this clause.
37
+ * Clause-specific error (e.g. did not evaluate to a boolean).
38
38
  * @type {string}
39
39
  * @memberof DryRunFilterClauseClass
40
40
  */
@@ -23,13 +23,13 @@ export interface DryRunFilterResponseClass {
23
23
  */
24
24
  'matched': boolean;
25
25
  /**
26
- * Per-clause breakdown of the evaluation (not yet populated).
26
+ * Per top-level clause breakdown of the evaluation.
27
27
  * @type {Array<DryRunFilterClauseClass>}
28
28
  * @memberof DryRunFilterResponseClass
29
29
  */
30
30
  'clauses': Array<DryRunFilterClauseClass>;
31
31
  /**
32
- * Syntax / evaluation error if the expression failed.
32
+ * Error if the expression failed — invalid field, syntax, or evaluation.
33
33
  * @type {string}
34
34
  * @memberof DryRunFilterResponseClass
35
35
  */
@@ -33,13 +33,13 @@ export interface DryRunFilterClauseClass {
33
33
  */
34
34
  'matched': boolean;
35
35
  /**
36
- * Actual value of the left-hand side at evaluation time.
36
+ * Actual value of the field side at evaluation time.
37
37
  * @type {string}
38
38
  * @memberof DryRunFilterClauseClass
39
39
  */
40
40
  'resolvedValue'?: string;
41
41
  /**
42
- * Null-path / type error specific to this clause.
42
+ * Clause-specific error (e.g. did not evaluate to a boolean).
43
43
  * @type {string}
44
44
  * @memberof DryRunFilterClauseClass
45
45
  */
@@ -28,13 +28,13 @@ export interface DryRunFilterResponseClass {
28
28
  */
29
29
  'matched': boolean;
30
30
  /**
31
- * Per-clause breakdown of the evaluation (not yet populated).
31
+ * Per top-level clause breakdown of the evaluation.
32
32
  * @type {Array<DryRunFilterClauseClass>}
33
33
  * @memberof DryRunFilterResponseClass
34
34
  */
35
35
  'clauses': Array<DryRunFilterClauseClass>;
36
36
  /**
37
- * Syntax / evaluation error if the expression failed.
37
+ * Error if the expression failed — invalid field, syntax, or evaluation.
38
38
  * @type {string}
39
39
  * @memberof DryRunFilterResponseClass
40
40
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@emilgroup/task-sdk-node",
3
- "version": "1.7.1-beta.5",
3
+ "version": "1.7.1-beta.6",
4
4
  "description": "OpenAPI client for @emilgroup/task-sdk-node",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [