@emilgroup/task-sdk 1.9.0 → 1.9.1-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (41) hide show
  1. package/.openapi-generator/FILES +8 -0
  2. package/README.md +2 -2
  3. package/api/filters-api.ts +677 -0
  4. package/api/task-client-api.ts +8 -8
  5. package/api/tasks-api.ts +8 -8
  6. package/api.ts +2 -0
  7. package/dist/api/filters-api.d.ts +384 -0
  8. package/dist/api/filters-api.js +636 -0
  9. package/dist/api/task-client-api.d.ts +8 -8
  10. package/dist/api/task-client-api.js +6 -6
  11. package/dist/api/tasks-api.d.ts +8 -8
  12. package/dist/api/tasks-api.js +6 -6
  13. package/dist/api.d.ts +1 -0
  14. package/dist/api.js +1 -0
  15. package/dist/models/create-filter-request-dto.d.ts +66 -0
  16. package/dist/models/create-filter-request-dto.js +15 -0
  17. package/dist/models/create-filter-response-class.d.ts +25 -0
  18. package/dist/models/create-filter-response-class.js +15 -0
  19. package/dist/models/filter-class.d.ts +102 -0
  20. package/dist/models/filter-class.js +15 -0
  21. package/dist/models/get-filter-response-class.d.ts +25 -0
  22. package/dist/models/get-filter-response-class.js +15 -0
  23. package/dist/models/index.d.ts +7 -0
  24. package/dist/models/index.js +7 -0
  25. package/dist/models/list-filters-response-class.d.ts +43 -0
  26. package/dist/models/list-filters-response-class.js +15 -0
  27. package/dist/models/task-class.d.ts +6 -0
  28. package/dist/models/update-filter-request-dto.d.ts +60 -0
  29. package/dist/models/update-filter-request-dto.js +15 -0
  30. package/dist/models/update-filter-response-class.d.ts +25 -0
  31. package/dist/models/update-filter-response-class.js +15 -0
  32. package/models/create-filter-request-dto.ts +72 -0
  33. package/models/create-filter-response-class.ts +31 -0
  34. package/models/filter-class.ts +108 -0
  35. package/models/get-filter-response-class.ts +31 -0
  36. package/models/index.ts +7 -0
  37. package/models/list-filters-response-class.ts +49 -0
  38. package/models/task-class.ts +6 -0
  39. package/models/update-filter-request-dto.ts +66 -0
  40. package/models/update-filter-response-class.ts +31 -0
  41. package/package.json +1 -1
@@ -735,11 +735,11 @@ export const TaskClientApiAxiosParamCreator = function (configuration?: Configur
735
735
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
736
736
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
737
737
  * @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.
738
- * @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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
738
+ * @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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
739
739
  * @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: subject, description</i>
740
740
  * @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, assignee, reporter, dueDate, entityType, entityCode, status, priority</i>
741
741
  * @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/> <i>Allowed values: categories, status<i>
742
- * @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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
742
+ * @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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
743
743
  * @param {*} [options] Override http request option.
744
744
  * @throws {RequiredError}
745
745
  */
@@ -1143,11 +1143,11 @@ export const TaskClientApiFp = function(configuration?: Configuration) {
1143
1143
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
1144
1144
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
1145
1145
  * @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.
1146
- * @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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
1146
+ * @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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
1147
1147
  * @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: subject, description</i>
1148
1148
  * @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, assignee, reporter, dueDate, entityType, entityCode, status, priority</i>
1149
1149
  * @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/> <i>Allowed values: categories, status<i>
1150
- * @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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
1150
+ * @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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
1151
1151
  * @param {*} [options] Override http request option.
1152
1152
  * @throws {RequiredError}
1153
1153
  */
@@ -1366,11 +1366,11 @@ export const TaskClientApiFactory = function (configuration?: Configuration, bas
1366
1366
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
1367
1367
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
1368
1368
  * @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.
1369
- * @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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
1369
+ * @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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
1370
1370
  * @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: subject, description</i>
1371
1371
  * @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, assignee, reporter, dueDate, entityType, entityCode, status, priority</i>
1372
1372
  * @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/> <i>Allowed values: categories, status<i>
1373
- * @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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
1373
+ * @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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
1374
1374
  * @param {*} [options] Override http request option.
1375
1375
  * @throws {RequiredError}
1376
1376
  */
@@ -1808,7 +1808,7 @@ export interface TaskClientApiListTasksRequest {
1808
1808
  readonly pageToken?: string
1809
1809
 
1810
1810
  /**
1811
- * 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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
1811
+ * 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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
1812
1812
  * @type {string}
1813
1813
  * @memberof TaskClientApiListTasks
1814
1814
  */
@@ -1836,7 +1836,7 @@ export interface TaskClientApiListTasksRequest {
1836
1836
  readonly expand?: string
1837
1837
 
1838
1838
  /**
1839
- * 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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
1839
+ * 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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
1840
1840
  * @type {string}
1841
1841
  * @memberof TaskClientApiListTasks
1842
1842
  */
package/api/tasks-api.ts CHANGED
@@ -186,11 +186,11 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
186
186
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
187
187
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
188
188
  * @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.
189
- * @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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
189
+ * @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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
190
190
  * @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: subject, description</i>
191
191
  * @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, assignee, reporter, dueDate, entityType, entityCode, status, priority</i>
192
192
  * @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/> <i>Allowed values: categories, status<i>
193
- * @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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
193
+ * @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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
194
194
  * @param {*} [options] Override http request option.
195
195
  * @throws {RequiredError}
196
196
  */
@@ -360,11 +360,11 @@ export const TasksApiFp = function(configuration?: Configuration) {
360
360
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
361
361
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
362
362
  * @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.
363
- * @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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
363
+ * @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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
364
364
  * @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: subject, description</i>
365
365
  * @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, assignee, reporter, dueDate, entityType, entityCode, status, priority</i>
366
366
  * @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/> <i>Allowed values: categories, status<i>
367
- * @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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
367
+ * @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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
368
368
  * @param {*} [options] Override http request option.
369
369
  * @throws {RequiredError}
370
370
  */
@@ -435,11 +435,11 @@ export const TasksApiFactory = function (configuration?: Configuration, basePath
435
435
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
436
436
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
437
437
  * @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.
438
- * @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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
438
+ * @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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
439
439
  * @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: subject, description</i>
440
440
  * @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, assignee, reporter, dueDate, entityType, entityCode, status, priority</i>
441
441
  * @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/> <i>Allowed values: categories, status<i>
442
- * @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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
442
+ * @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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
443
443
  * @param {*} [options] Override http request option.
444
444
  * @throws {RequiredError}
445
445
  */
@@ -559,7 +559,7 @@ export interface TasksApiListTasksRequest {
559
559
  readonly pageToken?: string
560
560
 
561
561
  /**
562
- * 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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
562
+ * 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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
563
563
  * @type {string}
564
564
  * @memberof TasksApiListTasks
565
565
  */
@@ -587,7 +587,7 @@ export interface TasksApiListTasksRequest {
587
587
  readonly expand?: string
588
588
 
589
589
  /**
590
- * 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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
590
+ * 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, statusId, priority, assignee, reporter, entityType, entityCode, entityNumber, userGroupCode, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
591
591
  * @type {string}
592
592
  * @memberof TasksApiListTasks
593
593
  */
package/api.ts CHANGED
@@ -22,6 +22,7 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
22
22
  import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base';
23
23
  import { AssigneesApi } from './api';
24
24
  import { CategoriesApi } from './api';
25
+ import { FiltersApi } from './api';
25
26
  import { HealthApi } from './api';
26
27
  import { HubSpotApi } from './api';
27
28
  import { RemindersApi } from './api';
@@ -32,6 +33,7 @@ import { TasksApi } from './api';
32
33
 
33
34
  export * from './api/assignees-api';
34
35
  export * from './api/categories-api';
36
+ export * from './api/filters-api';
35
37
  export * from './api/health-api';
36
38
  export * from './api/hub-spot-api';
37
39
  export * from './api/reminders-api';
@@ -0,0 +1,384 @@
1
+ /**
2
+ * EMIL TaskService
3
+ * The EMIL Task API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
+ import { Configuration } from '../configuration';
14
+ import { RequestArgs, BaseAPI } from '../base';
15
+ import { CreateFilterRequestDto } from '../models';
16
+ import { CreateFilterResponseClass } from '../models';
17
+ import { GetFilterResponseClass } from '../models';
18
+ import { ListFiltersResponseClass } from '../models';
19
+ import { UpdateFilterRequestDto } from '../models';
20
+ import { UpdateFilterResponseClass } from '../models';
21
+ /**
22
+ * FiltersApi - axios parameter creator
23
+ * @export
24
+ */
25
+ export declare const FiltersApiAxiosParamCreator: (configuration?: Configuration) => {
26
+ /**
27
+ * Create a routing filter targeting a user-group. **Required Permissions** \"task-management.task-filters.create\"
28
+ * @summary Create the filter
29
+ * @param {CreateFilterRequestDto} createFilterRequestDto
30
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
31
+ * @param {*} [options] Override http request option.
32
+ * @throws {RequiredError}
33
+ */
34
+ createFilter: (createFilterRequestDto: CreateFilterRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
35
+ /**
36
+ * Delete a filter by its code. **Required Permissions** \"task-management.task-filters.delete\"
37
+ * @summary Delete the filter
38
+ * @param {string} code Unique identifier for the object.
39
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
40
+ * @param {*} [options] Override http request option.
41
+ * @throws {RequiredError}
42
+ */
43
+ deleteFilter: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
44
+ /**
45
+ * Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
46
+ * @summary Retrieve the filter
47
+ * @param {string} code Unique identifier for the object.
48
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
49
+ * @param {*} [options] Override http request option.
50
+ * @throws {RequiredError}
51
+ */
52
+ getFilter: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
53
+ /**
54
+ * Returns a list of filters you have previously created. The filters are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"task-management.task-filters.view\"
55
+ * @summary List filters
56
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
57
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
58
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
59
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
60
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
61
+ * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
62
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
63
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
64
+ * @param {*} [options] Override http request option.
65
+ * @throws {RequiredError}
66
+ */
67
+ listFilters: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
68
+ /**
69
+ * Update a filter (slug, name, description, expression, target group, priority, is_active, is_fallback). **Required Permissions** \"task-management.task-filters.update\"
70
+ * @summary Update the filter
71
+ * @param {string} code Unique identifier for the object.
72
+ * @param {UpdateFilterRequestDto} updateFilterRequestDto
73
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
74
+ * @param {*} [options] Override http request option.
75
+ * @throws {RequiredError}
76
+ */
77
+ updateFilter: (code: string, updateFilterRequestDto: UpdateFilterRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
78
+ };
79
+ /**
80
+ * FiltersApi - functional programming interface
81
+ * @export
82
+ */
83
+ export declare const FiltersApiFp: (configuration?: Configuration) => {
84
+ /**
85
+ * Create a routing filter targeting a user-group. **Required Permissions** \"task-management.task-filters.create\"
86
+ * @summary Create the filter
87
+ * @param {CreateFilterRequestDto} createFilterRequestDto
88
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
89
+ * @param {*} [options] Override http request option.
90
+ * @throws {RequiredError}
91
+ */
92
+ createFilter(createFilterRequestDto: CreateFilterRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateFilterResponseClass>>;
93
+ /**
94
+ * Delete a filter by its code. **Required Permissions** \"task-management.task-filters.delete\"
95
+ * @summary Delete the filter
96
+ * @param {string} code Unique identifier for the object.
97
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
98
+ * @param {*} [options] Override http request option.
99
+ * @throws {RequiredError}
100
+ */
101
+ deleteFilter(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
102
+ /**
103
+ * Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
104
+ * @summary Retrieve the filter
105
+ * @param {string} code Unique identifier for the object.
106
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
107
+ * @param {*} [options] Override http request option.
108
+ * @throws {RequiredError}
109
+ */
110
+ getFilter(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFilterResponseClass>>;
111
+ /**
112
+ * Returns a list of filters you have previously created. The filters are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"task-management.task-filters.view\"
113
+ * @summary List filters
114
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
115
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
116
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
117
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
118
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
119
+ * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
120
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
121
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
122
+ * @param {*} [options] Override http request option.
123
+ * @throws {RequiredError}
124
+ */
125
+ listFilters(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFiltersResponseClass>>;
126
+ /**
127
+ * Update a filter (slug, name, description, expression, target group, priority, is_active, is_fallback). **Required Permissions** \"task-management.task-filters.update\"
128
+ * @summary Update the filter
129
+ * @param {string} code Unique identifier for the object.
130
+ * @param {UpdateFilterRequestDto} updateFilterRequestDto
131
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
132
+ * @param {*} [options] Override http request option.
133
+ * @throws {RequiredError}
134
+ */
135
+ updateFilter(code: string, updateFilterRequestDto: UpdateFilterRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateFilterResponseClass>>;
136
+ };
137
+ /**
138
+ * FiltersApi - factory interface
139
+ * @export
140
+ */
141
+ export declare const FiltersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
142
+ /**
143
+ * Create a routing filter targeting a user-group. **Required Permissions** \"task-management.task-filters.create\"
144
+ * @summary Create the filter
145
+ * @param {CreateFilterRequestDto} createFilterRequestDto
146
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
147
+ * @param {*} [options] Override http request option.
148
+ * @throws {RequiredError}
149
+ */
150
+ createFilter(createFilterRequestDto: CreateFilterRequestDto, authorization?: string, options?: any): AxiosPromise<CreateFilterResponseClass>;
151
+ /**
152
+ * Delete a filter by its code. **Required Permissions** \"task-management.task-filters.delete\"
153
+ * @summary Delete the filter
154
+ * @param {string} code Unique identifier for the object.
155
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
156
+ * @param {*} [options] Override http request option.
157
+ * @throws {RequiredError}
158
+ */
159
+ deleteFilter(code: string, authorization?: string, options?: any): AxiosPromise<void>;
160
+ /**
161
+ * Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
162
+ * @summary Retrieve the filter
163
+ * @param {string} code Unique identifier for the object.
164
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
165
+ * @param {*} [options] Override http request option.
166
+ * @throws {RequiredError}
167
+ */
168
+ getFilter(code: string, authorization?: string, options?: any): AxiosPromise<GetFilterResponseClass>;
169
+ /**
170
+ * Returns a list of filters you have previously created. The filters are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"task-management.task-filters.view\"
171
+ * @summary List filters
172
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
173
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
174
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
175
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
176
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
177
+ * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
178
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
179
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
180
+ * @param {*} [options] Override http request option.
181
+ * @throws {RequiredError}
182
+ */
183
+ listFilters(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListFiltersResponseClass>;
184
+ /**
185
+ * Update a filter (slug, name, description, expression, target group, priority, is_active, is_fallback). **Required Permissions** \"task-management.task-filters.update\"
186
+ * @summary Update the filter
187
+ * @param {string} code Unique identifier for the object.
188
+ * @param {UpdateFilterRequestDto} updateFilterRequestDto
189
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
190
+ * @param {*} [options] Override http request option.
191
+ * @throws {RequiredError}
192
+ */
193
+ updateFilter(code: string, updateFilterRequestDto: UpdateFilterRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateFilterResponseClass>;
194
+ };
195
+ /**
196
+ * Request parameters for createFilter operation in FiltersApi.
197
+ * @export
198
+ * @interface FiltersApiCreateFilterRequest
199
+ */
200
+ export interface FiltersApiCreateFilterRequest {
201
+ /**
202
+ *
203
+ * @type {CreateFilterRequestDto}
204
+ * @memberof FiltersApiCreateFilter
205
+ */
206
+ readonly createFilterRequestDto: CreateFilterRequestDto;
207
+ /**
208
+ * Bearer Token: provided by the login endpoint under the name accessToken.
209
+ * @type {string}
210
+ * @memberof FiltersApiCreateFilter
211
+ */
212
+ readonly authorization?: string;
213
+ }
214
+ /**
215
+ * Request parameters for deleteFilter operation in FiltersApi.
216
+ * @export
217
+ * @interface FiltersApiDeleteFilterRequest
218
+ */
219
+ export interface FiltersApiDeleteFilterRequest {
220
+ /**
221
+ * Unique identifier for the object.
222
+ * @type {string}
223
+ * @memberof FiltersApiDeleteFilter
224
+ */
225
+ readonly code: string;
226
+ /**
227
+ * Bearer Token: provided by the login endpoint under the name accessToken.
228
+ * @type {string}
229
+ * @memberof FiltersApiDeleteFilter
230
+ */
231
+ readonly authorization?: string;
232
+ }
233
+ /**
234
+ * Request parameters for getFilter operation in FiltersApi.
235
+ * @export
236
+ * @interface FiltersApiGetFilterRequest
237
+ */
238
+ export interface FiltersApiGetFilterRequest {
239
+ /**
240
+ * Unique identifier for the object.
241
+ * @type {string}
242
+ * @memberof FiltersApiGetFilter
243
+ */
244
+ readonly code: string;
245
+ /**
246
+ * Bearer Token: provided by the login endpoint under the name accessToken.
247
+ * @type {string}
248
+ * @memberof FiltersApiGetFilter
249
+ */
250
+ readonly authorization?: string;
251
+ }
252
+ /**
253
+ * Request parameters for listFilters operation in FiltersApi.
254
+ * @export
255
+ * @interface FiltersApiListFiltersRequest
256
+ */
257
+ export interface FiltersApiListFiltersRequest {
258
+ /**
259
+ * Bearer Token: provided by the login endpoint under the name accessToken.
260
+ * @type {string}
261
+ * @memberof FiltersApiListFilters
262
+ */
263
+ readonly authorization?: string;
264
+ /**
265
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
266
+ * @type {number}
267
+ * @memberof FiltersApiListFilters
268
+ */
269
+ readonly pageSize?: number;
270
+ /**
271
+ * 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.
272
+ * @type {string}
273
+ * @memberof FiltersApiListFilters
274
+ */
275
+ readonly pageToken?: string;
276
+ /**
277
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
278
+ * @type {string}
279
+ * @memberof FiltersApiListFilters
280
+ */
281
+ readonly filter?: string;
282
+ /**
283
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
284
+ * @type {string}
285
+ * @memberof FiltersApiListFilters
286
+ */
287
+ readonly search?: string;
288
+ /**
289
+ * The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
290
+ * @type {string}
291
+ * @memberof FiltersApiListFilters
292
+ */
293
+ readonly order?: string;
294
+ /**
295
+ * Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
296
+ * @type {string}
297
+ * @memberof FiltersApiListFilters
298
+ */
299
+ readonly expand?: string;
300
+ /**
301
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
302
+ * @type {string}
303
+ * @memberof FiltersApiListFilters
304
+ */
305
+ readonly filters?: string;
306
+ }
307
+ /**
308
+ * Request parameters for updateFilter operation in FiltersApi.
309
+ * @export
310
+ * @interface FiltersApiUpdateFilterRequest
311
+ */
312
+ export interface FiltersApiUpdateFilterRequest {
313
+ /**
314
+ * Unique identifier for the object.
315
+ * @type {string}
316
+ * @memberof FiltersApiUpdateFilter
317
+ */
318
+ readonly code: string;
319
+ /**
320
+ *
321
+ * @type {UpdateFilterRequestDto}
322
+ * @memberof FiltersApiUpdateFilter
323
+ */
324
+ readonly updateFilterRequestDto: UpdateFilterRequestDto;
325
+ /**
326
+ * Bearer Token: provided by the login endpoint under the name accessToken.
327
+ * @type {string}
328
+ * @memberof FiltersApiUpdateFilter
329
+ */
330
+ readonly authorization?: string;
331
+ }
332
+ /**
333
+ * FiltersApi - object-oriented interface
334
+ * @export
335
+ * @class FiltersApi
336
+ * @extends {BaseAPI}
337
+ */
338
+ export declare class FiltersApi extends BaseAPI {
339
+ /**
340
+ * Create a routing filter targeting a user-group. **Required Permissions** \"task-management.task-filters.create\"
341
+ * @summary Create the filter
342
+ * @param {FiltersApiCreateFilterRequest} requestParameters Request parameters.
343
+ * @param {*} [options] Override http request option.
344
+ * @throws {RequiredError}
345
+ * @memberof FiltersApi
346
+ */
347
+ createFilter(requestParameters: FiltersApiCreateFilterRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateFilterResponseClass, any, {}>>;
348
+ /**
349
+ * Delete a filter by its code. **Required Permissions** \"task-management.task-filters.delete\"
350
+ * @summary Delete the filter
351
+ * @param {FiltersApiDeleteFilterRequest} requestParameters Request parameters.
352
+ * @param {*} [options] Override http request option.
353
+ * @throws {RequiredError}
354
+ * @memberof FiltersApi
355
+ */
356
+ deleteFilter(requestParameters: FiltersApiDeleteFilterRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
357
+ /**
358
+ * Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
359
+ * @summary Retrieve the filter
360
+ * @param {FiltersApiGetFilterRequest} requestParameters Request parameters.
361
+ * @param {*} [options] Override http request option.
362
+ * @throws {RequiredError}
363
+ * @memberof FiltersApi
364
+ */
365
+ getFilter(requestParameters: FiltersApiGetFilterRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetFilterResponseClass, any, {}>>;
366
+ /**
367
+ * Returns a list of filters you have previously created. The filters are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"task-management.task-filters.view\"
368
+ * @summary List filters
369
+ * @param {FiltersApiListFiltersRequest} requestParameters Request parameters.
370
+ * @param {*} [options] Override http request option.
371
+ * @throws {RequiredError}
372
+ * @memberof FiltersApi
373
+ */
374
+ listFilters(requestParameters?: FiltersApiListFiltersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFiltersResponseClass, any, {}>>;
375
+ /**
376
+ * Update a filter (slug, name, description, expression, target group, priority, is_active, is_fallback). **Required Permissions** \"task-management.task-filters.update\"
377
+ * @summary Update the filter
378
+ * @param {FiltersApiUpdateFilterRequest} requestParameters Request parameters.
379
+ * @param {*} [options] Override http request option.
380
+ * @throws {RequiredError}
381
+ * @memberof FiltersApi
382
+ */
383
+ updateFilter(requestParameters: FiltersApiUpdateFilterRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateFilterResponseClass, any, {}>>;
384
+ }