@emilgroup/task-sdk-node 1.7.1-beta.0 → 1.7.1-beta.10
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/.openapi-generator/FILES +3 -0
- package/README.md +2 -2
- package/api/filters-api.ts +131 -24
- package/api/task-client-api.ts +8 -8
- package/api/tasks-api.ts +8 -8
- package/dist/api/filters-api.d.ts +81 -24
- package/dist/api/filters-api.js +112 -19
- package/dist/api/task-client-api.d.ts +8 -8
- package/dist/api/task-client-api.js +6 -6
- package/dist/api/tasks-api.d.ts +8 -8
- package/dist/api/tasks-api.js +6 -6
- package/dist/models/create-task-request-dto.d.ts +6 -0
- package/dist/models/dry-run-filter-clause-class.d.ts +42 -0
- package/dist/models/dry-run-filter-clause-class.js +15 -0
- package/dist/models/dry-run-filter-request-dto.d.ts +30 -0
- package/dist/models/dry-run-filter-request-dto.js +15 -0
- package/dist/models/dry-run-filter-response-class.d.ts +37 -0
- package/dist/models/dry-run-filter-response-class.js +15 -0
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +3 -0
- package/dist/models/patch-task-request-dto.d.ts +12 -0
- package/dist/models/task-class.d.ts +6 -0
- package/models/create-task-request-dto.ts +6 -0
- package/models/dry-run-filter-clause-class.ts +48 -0
- package/models/dry-run-filter-request-dto.ts +36 -0
- package/models/dry-run-filter-response-class.ts +43 -0
- package/models/index.ts +3 -0
- package/models/patch-task-request-dto.ts +12 -0
- package/models/task-class.ts +6 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -31,6 +31,9 @@ models/create-status-request-dto.ts
|
|
|
31
31
|
models/create-status-response-class.ts
|
|
32
32
|
models/create-task-request-dto.ts
|
|
33
33
|
models/create-task-response-class.ts
|
|
34
|
+
models/dry-run-filter-clause-class.ts
|
|
35
|
+
models/dry-run-filter-request-dto.ts
|
|
36
|
+
models/dry-run-filter-response-class.ts
|
|
34
37
|
models/filter-class.ts
|
|
35
38
|
models/get-category-response-class.ts
|
|
36
39
|
models/get-filter-response-class.ts
|
package/README.md
CHANGED
|
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
|
|
|
17
17
|
Navigate to the folder of your consuming project and run one of the following commands:
|
|
18
18
|
|
|
19
19
|
```
|
|
20
|
-
npm install @emilgroup/task-sdk-node@1.7.1-beta.
|
|
20
|
+
npm install @emilgroup/task-sdk-node@1.7.1-beta.10 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/task-sdk-node@1.7.1-beta.
|
|
24
|
+
yarn add @emilgroup/task-sdk-node@1.7.1-beta.10
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `TasksApi`.
|
package/api/filters-api.ts
CHANGED
|
@@ -25,6 +25,10 @@ import { CreateFilterRequestDto } from '../models';
|
|
|
25
25
|
// @ts-ignore
|
|
26
26
|
import { CreateFilterResponseClass } from '../models';
|
|
27
27
|
// @ts-ignore
|
|
28
|
+
import { DryRunFilterRequestDto } from '../models';
|
|
29
|
+
// @ts-ignore
|
|
30
|
+
import { DryRunFilterResponseClass } from '../models';
|
|
31
|
+
// @ts-ignore
|
|
28
32
|
import { GetFilterResponseClass } from '../models';
|
|
29
33
|
// @ts-ignore
|
|
30
34
|
import { ListFiltersResponseClass } from '../models';
|
|
@@ -134,6 +138,53 @@ export const FiltersApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
134
138
|
options: localVarRequestOptions,
|
|
135
139
|
};
|
|
136
140
|
},
|
|
141
|
+
/**
|
|
142
|
+
* Test a candidate filter expression against a specific task without saving a filter. **Required Permissions** \"task-management.task-filters.create\"
|
|
143
|
+
* @summary Create the filter dry-run
|
|
144
|
+
* @param {DryRunFilterRequestDto} dryRunFilterRequestDto
|
|
145
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
146
|
+
* @param {*} [options] Override http request option.
|
|
147
|
+
* @throws {RequiredError}
|
|
148
|
+
*/
|
|
149
|
+
dryRunFilter: async (dryRunFilterRequestDto: DryRunFilterRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
150
|
+
// verify required parameter 'dryRunFilterRequestDto' is not null or undefined
|
|
151
|
+
assertParamExists('dryRunFilter', 'dryRunFilterRequestDto', dryRunFilterRequestDto)
|
|
152
|
+
const localVarPath = `/taskservice/v1/filters/dry-run`;
|
|
153
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
154
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
155
|
+
let baseOptions;
|
|
156
|
+
let baseAccessToken;
|
|
157
|
+
if (configuration) {
|
|
158
|
+
baseOptions = configuration.baseOptions;
|
|
159
|
+
baseAccessToken = configuration.accessToken;
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
163
|
+
const localVarHeaderParameter = {} as any;
|
|
164
|
+
const localVarQueryParameter = {} as any;
|
|
165
|
+
|
|
166
|
+
// authentication bearer required
|
|
167
|
+
// http bearer authentication required
|
|
168
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
169
|
+
|
|
170
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
171
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
172
|
+
}
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
177
|
+
|
|
178
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
179
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
180
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
181
|
+
localVarRequestOptions.data = serializeDataIfNeeded(dryRunFilterRequestDto, localVarRequestOptions, configuration)
|
|
182
|
+
|
|
183
|
+
return {
|
|
184
|
+
url: toPathString(localVarUrlObj),
|
|
185
|
+
options: localVarRequestOptions,
|
|
186
|
+
};
|
|
187
|
+
},
|
|
137
188
|
/**
|
|
138
189
|
* Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
|
|
139
190
|
* @summary Retrieve the filter
|
|
@@ -180,16 +231,16 @@ export const FiltersApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
180
231
|
};
|
|
181
232
|
},
|
|
182
233
|
/**
|
|
183
|
-
*
|
|
234
|
+
* Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
|
|
184
235
|
* @summary List filters
|
|
185
236
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
186
237
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
187
238
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
188
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
189
|
-
* @param {string} [search]
|
|
190
|
-
* @param {string} [order]
|
|
191
|
-
* @param {string} [expand]
|
|
192
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
239
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority</i>
|
|
240
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: name, slug</i>
|
|
241
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, name, slug, priority</i>
|
|
242
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
243
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority</i>
|
|
193
244
|
* @param {*} [options] Override http request option.
|
|
194
245
|
* @throws {RequiredError}
|
|
195
246
|
*/
|
|
@@ -340,6 +391,18 @@ export const FiltersApiFp = function(configuration?: Configuration) {
|
|
|
340
391
|
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteFilter(code, authorization, options);
|
|
341
392
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
342
393
|
},
|
|
394
|
+
/**
|
|
395
|
+
* Test a candidate filter expression against a specific task without saving a filter. **Required Permissions** \"task-management.task-filters.create\"
|
|
396
|
+
* @summary Create the filter dry-run
|
|
397
|
+
* @param {DryRunFilterRequestDto} dryRunFilterRequestDto
|
|
398
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
399
|
+
* @param {*} [options] Override http request option.
|
|
400
|
+
* @throws {RequiredError}
|
|
401
|
+
*/
|
|
402
|
+
async dryRunFilter(dryRunFilterRequestDto: DryRunFilterRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DryRunFilterResponseClass>> {
|
|
403
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.dryRunFilter(dryRunFilterRequestDto, authorization, options);
|
|
404
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
405
|
+
},
|
|
343
406
|
/**
|
|
344
407
|
* Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
|
|
345
408
|
* @summary Retrieve the filter
|
|
@@ -353,16 +416,16 @@ export const FiltersApiFp = function(configuration?: Configuration) {
|
|
|
353
416
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
354
417
|
},
|
|
355
418
|
/**
|
|
356
|
-
*
|
|
419
|
+
* Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
|
|
357
420
|
* @summary List filters
|
|
358
421
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
359
422
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
360
423
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
361
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
362
|
-
* @param {string} [search]
|
|
363
|
-
* @param {string} [order]
|
|
364
|
-
* @param {string} [expand]
|
|
365
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
424
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority</i>
|
|
425
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: name, slug</i>
|
|
426
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, name, slug, priority</i>
|
|
427
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
428
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority</i>
|
|
366
429
|
* @param {*} [options] Override http request option.
|
|
367
430
|
* @throws {RequiredError}
|
|
368
431
|
*/
|
|
@@ -415,6 +478,17 @@ export const FiltersApiFactory = function (configuration?: Configuration, basePa
|
|
|
415
478
|
deleteFilter(code: string, authorization?: string, options?: any): AxiosPromise<void> {
|
|
416
479
|
return localVarFp.deleteFilter(code, authorization, options).then((request) => request(axios, basePath));
|
|
417
480
|
},
|
|
481
|
+
/**
|
|
482
|
+
* Test a candidate filter expression against a specific task without saving a filter. **Required Permissions** \"task-management.task-filters.create\"
|
|
483
|
+
* @summary Create the filter dry-run
|
|
484
|
+
* @param {DryRunFilterRequestDto} dryRunFilterRequestDto
|
|
485
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
486
|
+
* @param {*} [options] Override http request option.
|
|
487
|
+
* @throws {RequiredError}
|
|
488
|
+
*/
|
|
489
|
+
dryRunFilter(dryRunFilterRequestDto: DryRunFilterRequestDto, authorization?: string, options?: any): AxiosPromise<DryRunFilterResponseClass> {
|
|
490
|
+
return localVarFp.dryRunFilter(dryRunFilterRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
491
|
+
},
|
|
418
492
|
/**
|
|
419
493
|
* Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
|
|
420
494
|
* @summary Retrieve the filter
|
|
@@ -427,16 +501,16 @@ export const FiltersApiFactory = function (configuration?: Configuration, basePa
|
|
|
427
501
|
return localVarFp.getFilter(code, authorization, options).then((request) => request(axios, basePath));
|
|
428
502
|
},
|
|
429
503
|
/**
|
|
430
|
-
*
|
|
504
|
+
* Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
|
|
431
505
|
* @summary List filters
|
|
432
506
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
433
507
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
434
508
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
435
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
436
|
-
* @param {string} [search]
|
|
437
|
-
* @param {string} [order]
|
|
438
|
-
* @param {string} [expand]
|
|
439
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
509
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority</i>
|
|
510
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: name, slug</i>
|
|
511
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, name, slug, priority</i>
|
|
512
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
513
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority</i>
|
|
440
514
|
* @param {*} [options] Override http request option.
|
|
441
515
|
* @throws {RequiredError}
|
|
442
516
|
*/
|
|
@@ -500,6 +574,27 @@ export interface FiltersApiDeleteFilterRequest {
|
|
|
500
574
|
readonly authorization?: string
|
|
501
575
|
}
|
|
502
576
|
|
|
577
|
+
/**
|
|
578
|
+
* Request parameters for dryRunFilter operation in FiltersApi.
|
|
579
|
+
* @export
|
|
580
|
+
* @interface FiltersApiDryRunFilterRequest
|
|
581
|
+
*/
|
|
582
|
+
export interface FiltersApiDryRunFilterRequest {
|
|
583
|
+
/**
|
|
584
|
+
*
|
|
585
|
+
* @type {DryRunFilterRequestDto}
|
|
586
|
+
* @memberof FiltersApiDryRunFilter
|
|
587
|
+
*/
|
|
588
|
+
readonly dryRunFilterRequestDto: DryRunFilterRequestDto
|
|
589
|
+
|
|
590
|
+
/**
|
|
591
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
592
|
+
* @type {string}
|
|
593
|
+
* @memberof FiltersApiDryRunFilter
|
|
594
|
+
*/
|
|
595
|
+
readonly authorization?: string
|
|
596
|
+
}
|
|
597
|
+
|
|
503
598
|
/**
|
|
504
599
|
* Request parameters for getFilter operation in FiltersApi.
|
|
505
600
|
* @export
|
|
@@ -549,35 +644,35 @@ export interface FiltersApiListFiltersRequest {
|
|
|
549
644
|
readonly pageToken?: string
|
|
550
645
|
|
|
551
646
|
/**
|
|
552
|
-
* Filter the response by one or multiple fields.
|
|
647
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority</i>
|
|
553
648
|
* @type {string}
|
|
554
649
|
* @memberof FiltersApiListFilters
|
|
555
650
|
*/
|
|
556
651
|
readonly filter?: string
|
|
557
652
|
|
|
558
653
|
/**
|
|
559
|
-
*
|
|
654
|
+
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: name, slug</i>
|
|
560
655
|
* @type {string}
|
|
561
656
|
* @memberof FiltersApiListFilters
|
|
562
657
|
*/
|
|
563
658
|
readonly search?: string
|
|
564
659
|
|
|
565
660
|
/**
|
|
566
|
-
*
|
|
661
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, name, slug, priority</i>
|
|
567
662
|
* @type {string}
|
|
568
663
|
* @memberof FiltersApiListFilters
|
|
569
664
|
*/
|
|
570
665
|
readonly order?: string
|
|
571
666
|
|
|
572
667
|
/**
|
|
573
|
-
*
|
|
668
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
574
669
|
* @type {string}
|
|
575
670
|
* @memberof FiltersApiListFilters
|
|
576
671
|
*/
|
|
577
672
|
readonly expand?: string
|
|
578
673
|
|
|
579
674
|
/**
|
|
580
|
-
* Filters the response by one or multiple fields.
|
|
675
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority</i>
|
|
581
676
|
* @type {string}
|
|
582
677
|
* @memberof FiltersApiListFilters
|
|
583
678
|
*/
|
|
@@ -643,6 +738,18 @@ export class FiltersApi extends BaseAPI {
|
|
|
643
738
|
return FiltersApiFp(this.configuration).deleteFilter(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
644
739
|
}
|
|
645
740
|
|
|
741
|
+
/**
|
|
742
|
+
* Test a candidate filter expression against a specific task without saving a filter. **Required Permissions** \"task-management.task-filters.create\"
|
|
743
|
+
* @summary Create the filter dry-run
|
|
744
|
+
* @param {FiltersApiDryRunFilterRequest} requestParameters Request parameters.
|
|
745
|
+
* @param {*} [options] Override http request option.
|
|
746
|
+
* @throws {RequiredError}
|
|
747
|
+
* @memberof FiltersApi
|
|
748
|
+
*/
|
|
749
|
+
public dryRunFilter(requestParameters: FiltersApiDryRunFilterRequest, options?: AxiosRequestConfig) {
|
|
750
|
+
return FiltersApiFp(this.configuration).dryRunFilter(requestParameters.dryRunFilterRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
751
|
+
}
|
|
752
|
+
|
|
646
753
|
/**
|
|
647
754
|
* Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
|
|
648
755
|
* @summary Retrieve the filter
|
|
@@ -656,7 +763,7 @@ export class FiltersApi extends BaseAPI {
|
|
|
656
763
|
}
|
|
657
764
|
|
|
658
765
|
/**
|
|
659
|
-
*
|
|
766
|
+
* Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
|
|
660
767
|
* @summary List filters
|
|
661
768
|
* @param {FiltersApiListFiltersRequest} requestParameters Request parameters.
|
|
662
769
|
* @param {*} [options] Override http request option.
|
package/api/task-client-api.ts
CHANGED
|
@@ -739,11 +739,11 @@ export const TaskClientApiAxiosParamCreator = function (configuration?: Configur
|
|
|
739
739
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
740
740
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
741
741
|
* @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.
|
|
742
|
-
* @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>
|
|
742
|
+
* @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>
|
|
743
743
|
* @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>
|
|
744
744
|
* @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>
|
|
745
745
|
* @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>
|
|
746
|
-
* @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>
|
|
746
|
+
* @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>
|
|
747
747
|
* @param {*} [options] Override http request option.
|
|
748
748
|
* @throws {RequiredError}
|
|
749
749
|
*/
|
|
@@ -1147,11 +1147,11 @@ export const TaskClientApiFp = function(configuration?: Configuration) {
|
|
|
1147
1147
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1148
1148
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
1149
1149
|
* @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.
|
|
1150
|
-
* @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>
|
|
1150
|
+
* @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>
|
|
1151
1151
|
* @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>
|
|
1152
1152
|
* @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>
|
|
1153
1153
|
* @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>
|
|
1154
|
-
* @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>
|
|
1154
|
+
* @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>
|
|
1155
1155
|
* @param {*} [options] Override http request option.
|
|
1156
1156
|
* @throws {RequiredError}
|
|
1157
1157
|
*/
|
|
@@ -1370,11 +1370,11 @@ export const TaskClientApiFactory = function (configuration?: Configuration, bas
|
|
|
1370
1370
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
1371
1371
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
1372
1372
|
* @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.
|
|
1373
|
-
* @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>
|
|
1373
|
+
* @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>
|
|
1374
1374
|
* @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>
|
|
1375
1375
|
* @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>
|
|
1376
1376
|
* @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>
|
|
1377
|
-
* @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>
|
|
1377
|
+
* @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>
|
|
1378
1378
|
* @param {*} [options] Override http request option.
|
|
1379
1379
|
* @throws {RequiredError}
|
|
1380
1380
|
*/
|
|
@@ -1812,7 +1812,7 @@ export interface TaskClientApiListTasksRequest {
|
|
|
1812
1812
|
readonly pageToken?: string
|
|
1813
1813
|
|
|
1814
1814
|
/**
|
|
1815
|
-
* 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>
|
|
1815
|
+
* 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>
|
|
1816
1816
|
* @type {string}
|
|
1817
1817
|
* @memberof TaskClientApiListTasks
|
|
1818
1818
|
*/
|
|
@@ -1840,7 +1840,7 @@ export interface TaskClientApiListTasksRequest {
|
|
|
1840
1840
|
readonly expand?: string
|
|
1841
1841
|
|
|
1842
1842
|
/**
|
|
1843
|
-
* 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>
|
|
1843
|
+
* 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>
|
|
1844
1844
|
* @type {string}
|
|
1845
1845
|
* @memberof TaskClientApiListTasks
|
|
1846
1846
|
*/
|
package/api/tasks-api.ts
CHANGED
|
@@ -190,11 +190,11 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
190
190
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
191
191
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
192
192
|
* @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.
|
|
193
|
-
* @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>
|
|
193
|
+
* @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>
|
|
194
194
|
* @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>
|
|
195
195
|
* @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>
|
|
196
196
|
* @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>
|
|
197
|
-
* @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>
|
|
197
|
+
* @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>
|
|
198
198
|
* @param {*} [options] Override http request option.
|
|
199
199
|
* @throws {RequiredError}
|
|
200
200
|
*/
|
|
@@ -364,11 +364,11 @@ export const TasksApiFp = function(configuration?: Configuration) {
|
|
|
364
364
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
365
365
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
366
366
|
* @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.
|
|
367
|
-
* @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>
|
|
367
|
+
* @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>
|
|
368
368
|
* @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>
|
|
369
369
|
* @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>
|
|
370
370
|
* @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>
|
|
371
|
-
* @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>
|
|
371
|
+
* @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>
|
|
372
372
|
* @param {*} [options] Override http request option.
|
|
373
373
|
* @throws {RequiredError}
|
|
374
374
|
*/
|
|
@@ -439,11 +439,11 @@ export const TasksApiFactory = function (configuration?: Configuration, basePath
|
|
|
439
439
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
440
440
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
441
441
|
* @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.
|
|
442
|
-
* @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>
|
|
442
|
+
* @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>
|
|
443
443
|
* @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>
|
|
444
444
|
* @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>
|
|
445
445
|
* @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>
|
|
446
|
-
* @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>
|
|
446
|
+
* @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>
|
|
447
447
|
* @param {*} [options] Override http request option.
|
|
448
448
|
* @throws {RequiredError}
|
|
449
449
|
*/
|
|
@@ -563,7 +563,7 @@ export interface TasksApiListTasksRequest {
|
|
|
563
563
|
readonly pageToken?: string
|
|
564
564
|
|
|
565
565
|
/**
|
|
566
|
-
* 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>
|
|
566
|
+
* 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>
|
|
567
567
|
* @type {string}
|
|
568
568
|
* @memberof TasksApiListTasks
|
|
569
569
|
*/
|
|
@@ -591,7 +591,7 @@ export interface TasksApiListTasksRequest {
|
|
|
591
591
|
readonly expand?: string
|
|
592
592
|
|
|
593
593
|
/**
|
|
594
|
-
* 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>
|
|
594
|
+
* 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>
|
|
595
595
|
* @type {string}
|
|
596
596
|
* @memberof TasksApiListTasks
|
|
597
597
|
*/
|