@emilgroup/task-sdk 1.9.1-beta.5 → 1.9.1-beta.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
17
17
  Navigate to the folder of your consuming project and run one of the following commands:
18
18
 
19
19
  ```
20
- npm install @emilgroup/task-sdk@1.9.1-beta.5 --save
20
+ npm install @emilgroup/task-sdk@1.9.1-beta.6 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/task-sdk@1.9.1-beta.5
24
+ yarn add @emilgroup/task-sdk@1.9.1-beta.6
25
25
  ```
26
26
 
27
27
  And then you can import `TasksApi`.
@@ -227,16 +227,16 @@ export const FiltersApiAxiosParamCreator = function (configuration?: Configurati
227
227
  };
228
228
  },
229
229
  /**
230
- * Returns a list of filters you have previously created. The filters are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"task-management.task-filters.view\"
230
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
231
231
  * @summary List filters
232
232
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
233
233
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
234
234
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
235
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
236
- * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
237
- * @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.
238
- * @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.
239
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
235
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority</i>
236
+ * @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>
237
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, name, slug, priority</i>
238
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
239
+ * @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>
240
240
  * @param {*} [options] Override http request option.
241
241
  * @throws {RequiredError}
242
242
  */
@@ -412,16 +412,16 @@ export const FiltersApiFp = function(configuration?: Configuration) {
412
412
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
413
413
  },
414
414
  /**
415
- * Returns a list of filters you have previously created. The filters are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"task-management.task-filters.view\"
415
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
416
416
  * @summary List filters
417
417
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
418
418
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
419
419
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
420
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
421
- * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
422
- * @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.
423
- * @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.
424
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
420
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority</i>
421
+ * @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>
422
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, name, slug, priority</i>
423
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
424
+ * @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>
425
425
  * @param {*} [options] Override http request option.
426
426
  * @throws {RequiredError}
427
427
  */
@@ -497,16 +497,16 @@ export const FiltersApiFactory = function (configuration?: Configuration, basePa
497
497
  return localVarFp.getFilter(code, authorization, options).then((request) => request(axios, basePath));
498
498
  },
499
499
  /**
500
- * Returns a list of filters you have previously created. The filters are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"task-management.task-filters.view\"
500
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
501
501
  * @summary List filters
502
502
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
503
503
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
504
504
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
505
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
506
- * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
507
- * @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.
508
- * @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.
509
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
505
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority</i>
506
+ * @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>
507
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, name, slug, priority</i>
508
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
509
+ * @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>
510
510
  * @param {*} [options] Override http request option.
511
511
  * @throws {RequiredError}
512
512
  */
@@ -640,35 +640,35 @@ export interface FiltersApiListFiltersRequest {
640
640
  readonly pageToken?: string
641
641
 
642
642
  /**
643
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
643
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority</i>
644
644
  * @type {string}
645
645
  * @memberof FiltersApiListFilters
646
646
  */
647
647
  readonly filter?: string
648
648
 
649
649
  /**
650
- * To search the list by any field, pass search=xxx to fetch the result.
650
+ * 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>
651
651
  * @type {string}
652
652
  * @memberof FiltersApiListFilters
653
653
  */
654
654
  readonly search?: string
655
655
 
656
656
  /**
657
- * The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
657
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, name, slug, priority</i>
658
658
  * @type {string}
659
659
  * @memberof FiltersApiListFilters
660
660
  */
661
661
  readonly order?: string
662
662
 
663
663
  /**
664
- * Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
664
+ * Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
665
665
  * @type {string}
666
666
  * @memberof FiltersApiListFilters
667
667
  */
668
668
  readonly expand?: string
669
669
 
670
670
  /**
671
- * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
671
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority</i>
672
672
  * @type {string}
673
673
  * @memberof FiltersApiListFilters
674
674
  */
@@ -759,7 +759,7 @@ export class FiltersApi extends BaseAPI {
759
759
  }
760
760
 
761
761
  /**
762
- * Returns a list of filters you have previously created. The filters are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"task-management.task-filters.view\"
762
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
763
763
  * @summary List filters
764
764
  * @param {FiltersApiListFiltersRequest} requestParameters Request parameters.
765
765
  * @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.
@@ -287,16 +287,16 @@ var FiltersApiAxiosParamCreator = function (configuration) {
287
287
  });
288
288
  },
289
289
  /**
290
- * Returns a list of filters you have previously created. The filters are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"task-management.task-filters.view\"
290
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
291
291
  * @summary List filters
292
292
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
293
293
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
294
294
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
295
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
296
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
297
- * @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.
298
- * @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.
299
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
295
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority&lt;/i&gt;
296
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: name, slug&lt;/i&gt;
297
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, updatedAt, name, slug, priority&lt;/i&gt;
298
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
299
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority&lt;/i&gt;
300
300
  * @param {*} [options] Override http request option.
301
301
  * @throws {RequiredError}
302
302
  */
@@ -506,16 +506,16 @@ var FiltersApiFp = function (configuration) {
506
506
  });
507
507
  },
508
508
  /**
509
- * Returns a list of filters you have previously created. The filters are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"task-management.task-filters.view\"
509
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
510
510
  * @summary List filters
511
511
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
512
512
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
513
513
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
514
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
515
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
516
- * @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.
517
- * @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.
518
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
514
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority&lt;/i&gt;
515
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: name, slug&lt;/i&gt;
516
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, updatedAt, name, slug, priority&lt;/i&gt;
517
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
518
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority&lt;/i&gt;
519
519
  * @param {*} [options] Override http request option.
520
520
  * @throws {RequiredError}
521
521
  */
@@ -609,16 +609,16 @@ var FiltersApiFactory = function (configuration, basePath, axios) {
609
609
  return localVarFp.getFilter(code, authorization, options).then(function (request) { return request(axios, basePath); });
610
610
  },
611
611
  /**
612
- * Returns a list of filters you have previously created. The filters are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"task-management.task-filters.view\"
612
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
613
613
  * @summary List filters
614
614
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
615
615
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
616
616
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
617
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
618
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
619
- * @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.
620
- * @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.
621
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
617
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority&lt;/i&gt;
618
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: name, slug&lt;/i&gt;
619
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, updatedAt, name, slug, priority&lt;/i&gt;
620
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
621
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority&lt;/i&gt;
622
622
  * @param {*} [options] Override http request option.
623
623
  * @throws {RequiredError}
624
624
  */
@@ -700,7 +700,7 @@ var FiltersApi = /** @class */ (function (_super) {
700
700
  return (0, exports.FiltersApiFp)(this.configuration).getFilter(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
701
701
  };
702
702
  /**
703
- * Returns a list of filters you have previously created. The filters are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"task-management.task-filters.view\"
703
+ * Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
704
704
  * @summary List filters
705
705
  * @param {FiltersApiListFiltersRequest} requestParameters Request parameters.
706
706
  * @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",
3
- "version": "1.9.1-beta.5",
3
+ "version": "1.9.1-beta.6",
4
4
  "description": "OpenAPI client for @emilgroup/task-sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [