@emilgroup/task-sdk 1.9.1-beta.0 → 1.9.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@1.9.1-beta.
|
|
20
|
+
npm install @emilgroup/task-sdk@1.9.1-beta.10 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/task-sdk@1.9.1-beta.
|
|
24
|
+
yarn add @emilgroup/task-sdk@1.9.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';
|
|
@@ -130,6 +134,53 @@ export const FiltersApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
130
134
|
options: localVarRequestOptions,
|
|
131
135
|
};
|
|
132
136
|
},
|
|
137
|
+
/**
|
|
138
|
+
* Test a candidate filter expression against a specific task without saving a filter. **Required Permissions** \"task-management.task-filters.create\"
|
|
139
|
+
* @summary Create the filter dry-run
|
|
140
|
+
* @param {DryRunFilterRequestDto} dryRunFilterRequestDto
|
|
141
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
142
|
+
* @param {*} [options] Override http request option.
|
|
143
|
+
* @throws {RequiredError}
|
|
144
|
+
*/
|
|
145
|
+
dryRunFilter: async (dryRunFilterRequestDto: DryRunFilterRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
146
|
+
// verify required parameter 'dryRunFilterRequestDto' is not null or undefined
|
|
147
|
+
assertParamExists('dryRunFilter', 'dryRunFilterRequestDto', dryRunFilterRequestDto)
|
|
148
|
+
const localVarPath = `/taskservice/v1/filters/dry-run`;
|
|
149
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
150
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
151
|
+
let baseOptions;
|
|
152
|
+
let baseAccessToken;
|
|
153
|
+
if (configuration) {
|
|
154
|
+
baseOptions = configuration.baseOptions;
|
|
155
|
+
baseAccessToken = configuration.accessToken;
|
|
156
|
+
}
|
|
157
|
+
|
|
158
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
159
|
+
const localVarHeaderParameter = {} as any;
|
|
160
|
+
const localVarQueryParameter = {} as any;
|
|
161
|
+
|
|
162
|
+
// authentication bearer required
|
|
163
|
+
// http bearer authentication required
|
|
164
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
165
|
+
|
|
166
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
167
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
168
|
+
}
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
173
|
+
|
|
174
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
175
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
176
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
177
|
+
localVarRequestOptions.data = serializeDataIfNeeded(dryRunFilterRequestDto, localVarRequestOptions, configuration)
|
|
178
|
+
|
|
179
|
+
return {
|
|
180
|
+
url: toPathString(localVarUrlObj),
|
|
181
|
+
options: localVarRequestOptions,
|
|
182
|
+
};
|
|
183
|
+
},
|
|
133
184
|
/**
|
|
134
185
|
* Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
|
|
135
186
|
* @summary Retrieve the filter
|
|
@@ -176,16 +227,16 @@ export const FiltersApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
176
227
|
};
|
|
177
228
|
},
|
|
178
229
|
/**
|
|
179
|
-
*
|
|
230
|
+
* Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
|
|
180
231
|
* @summary List filters
|
|
181
232
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
182
233
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
183
234
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
184
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
185
|
-
* @param {string} [search]
|
|
186
|
-
* @param {string} [order]
|
|
187
|
-
* @param {string} [expand]
|
|
188
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
235
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority</i>
|
|
236
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: name, slug</i>
|
|
237
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, name, slug, priority</i>
|
|
238
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
239
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority</i>
|
|
189
240
|
* @param {*} [options] Override http request option.
|
|
190
241
|
* @throws {RequiredError}
|
|
191
242
|
*/
|
|
@@ -336,6 +387,18 @@ export const FiltersApiFp = function(configuration?: Configuration) {
|
|
|
336
387
|
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteFilter(code, authorization, options);
|
|
337
388
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
338
389
|
},
|
|
390
|
+
/**
|
|
391
|
+
* Test a candidate filter expression against a specific task without saving a filter. **Required Permissions** \"task-management.task-filters.create\"
|
|
392
|
+
* @summary Create the filter dry-run
|
|
393
|
+
* @param {DryRunFilterRequestDto} dryRunFilterRequestDto
|
|
394
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
395
|
+
* @param {*} [options] Override http request option.
|
|
396
|
+
* @throws {RequiredError}
|
|
397
|
+
*/
|
|
398
|
+
async dryRunFilter(dryRunFilterRequestDto: DryRunFilterRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DryRunFilterResponseClass>> {
|
|
399
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.dryRunFilter(dryRunFilterRequestDto, authorization, options);
|
|
400
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
401
|
+
},
|
|
339
402
|
/**
|
|
340
403
|
* Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
|
|
341
404
|
* @summary Retrieve the filter
|
|
@@ -349,16 +412,16 @@ export const FiltersApiFp = function(configuration?: Configuration) {
|
|
|
349
412
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
350
413
|
},
|
|
351
414
|
/**
|
|
352
|
-
*
|
|
415
|
+
* Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
|
|
353
416
|
* @summary List filters
|
|
354
417
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
355
418
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
356
419
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
357
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
358
|
-
* @param {string} [search]
|
|
359
|
-
* @param {string} [order]
|
|
360
|
-
* @param {string} [expand]
|
|
361
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
420
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority</i>
|
|
421
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: name, slug</i>
|
|
422
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, name, slug, priority</i>
|
|
423
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
424
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority</i>
|
|
362
425
|
* @param {*} [options] Override http request option.
|
|
363
426
|
* @throws {RequiredError}
|
|
364
427
|
*/
|
|
@@ -411,6 +474,17 @@ export const FiltersApiFactory = function (configuration?: Configuration, basePa
|
|
|
411
474
|
deleteFilter(code: string, authorization?: string, options?: any): AxiosPromise<void> {
|
|
412
475
|
return localVarFp.deleteFilter(code, authorization, options).then((request) => request(axios, basePath));
|
|
413
476
|
},
|
|
477
|
+
/**
|
|
478
|
+
* Test a candidate filter expression against a specific task without saving a filter. **Required Permissions** \"task-management.task-filters.create\"
|
|
479
|
+
* @summary Create the filter dry-run
|
|
480
|
+
* @param {DryRunFilterRequestDto} dryRunFilterRequestDto
|
|
481
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
482
|
+
* @param {*} [options] Override http request option.
|
|
483
|
+
* @throws {RequiredError}
|
|
484
|
+
*/
|
|
485
|
+
dryRunFilter(dryRunFilterRequestDto: DryRunFilterRequestDto, authorization?: string, options?: any): AxiosPromise<DryRunFilterResponseClass> {
|
|
486
|
+
return localVarFp.dryRunFilter(dryRunFilterRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
487
|
+
},
|
|
414
488
|
/**
|
|
415
489
|
* Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
|
|
416
490
|
* @summary Retrieve the filter
|
|
@@ -423,16 +497,16 @@ export const FiltersApiFactory = function (configuration?: Configuration, basePa
|
|
|
423
497
|
return localVarFp.getFilter(code, authorization, options).then((request) => request(axios, basePath));
|
|
424
498
|
},
|
|
425
499
|
/**
|
|
426
|
-
*
|
|
500
|
+
* Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
|
|
427
501
|
* @summary List filters
|
|
428
502
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
429
503
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
430
504
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
431
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
432
|
-
* @param {string} [search]
|
|
433
|
-
* @param {string} [order]
|
|
434
|
-
* @param {string} [expand]
|
|
435
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
505
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority</i>
|
|
506
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: name, slug</i>
|
|
507
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, name, slug, priority</i>
|
|
508
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
509
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority</i>
|
|
436
510
|
* @param {*} [options] Override http request option.
|
|
437
511
|
* @throws {RequiredError}
|
|
438
512
|
*/
|
|
@@ -496,6 +570,27 @@ export interface FiltersApiDeleteFilterRequest {
|
|
|
496
570
|
readonly authorization?: string
|
|
497
571
|
}
|
|
498
572
|
|
|
573
|
+
/**
|
|
574
|
+
* Request parameters for dryRunFilter operation in FiltersApi.
|
|
575
|
+
* @export
|
|
576
|
+
* @interface FiltersApiDryRunFilterRequest
|
|
577
|
+
*/
|
|
578
|
+
export interface FiltersApiDryRunFilterRequest {
|
|
579
|
+
/**
|
|
580
|
+
*
|
|
581
|
+
* @type {DryRunFilterRequestDto}
|
|
582
|
+
* @memberof FiltersApiDryRunFilter
|
|
583
|
+
*/
|
|
584
|
+
readonly dryRunFilterRequestDto: DryRunFilterRequestDto
|
|
585
|
+
|
|
586
|
+
/**
|
|
587
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
588
|
+
* @type {string}
|
|
589
|
+
* @memberof FiltersApiDryRunFilter
|
|
590
|
+
*/
|
|
591
|
+
readonly authorization?: string
|
|
592
|
+
}
|
|
593
|
+
|
|
499
594
|
/**
|
|
500
595
|
* Request parameters for getFilter operation in FiltersApi.
|
|
501
596
|
* @export
|
|
@@ -545,35 +640,35 @@ export interface FiltersApiListFiltersRequest {
|
|
|
545
640
|
readonly pageToken?: string
|
|
546
641
|
|
|
547
642
|
/**
|
|
548
|
-
* Filter the response by one or multiple fields.
|
|
643
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority</i>
|
|
549
644
|
* @type {string}
|
|
550
645
|
* @memberof FiltersApiListFilters
|
|
551
646
|
*/
|
|
552
647
|
readonly filter?: string
|
|
553
648
|
|
|
554
649
|
/**
|
|
555
|
-
*
|
|
650
|
+
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: name, slug</i>
|
|
556
651
|
* @type {string}
|
|
557
652
|
* @memberof FiltersApiListFilters
|
|
558
653
|
*/
|
|
559
654
|
readonly search?: string
|
|
560
655
|
|
|
561
656
|
/**
|
|
562
|
-
*
|
|
657
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, name, slug, priority</i>
|
|
563
658
|
* @type {string}
|
|
564
659
|
* @memberof FiltersApiListFilters
|
|
565
660
|
*/
|
|
566
661
|
readonly order?: string
|
|
567
662
|
|
|
568
663
|
/**
|
|
569
|
-
*
|
|
664
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
570
665
|
* @type {string}
|
|
571
666
|
* @memberof FiltersApiListFilters
|
|
572
667
|
*/
|
|
573
668
|
readonly expand?: string
|
|
574
669
|
|
|
575
670
|
/**
|
|
576
|
-
* Filters the response by one or multiple fields.
|
|
671
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, name, targetUserGroupCode, isActive, isFallback, priority</i>
|
|
577
672
|
* @type {string}
|
|
578
673
|
* @memberof FiltersApiListFilters
|
|
579
674
|
*/
|
|
@@ -639,6 +734,18 @@ export class FiltersApi extends BaseAPI {
|
|
|
639
734
|
return FiltersApiFp(this.configuration).deleteFilter(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
640
735
|
}
|
|
641
736
|
|
|
737
|
+
/**
|
|
738
|
+
* Test a candidate filter expression against a specific task without saving a filter. **Required Permissions** \"task-management.task-filters.create\"
|
|
739
|
+
* @summary Create the filter dry-run
|
|
740
|
+
* @param {FiltersApiDryRunFilterRequest} requestParameters Request parameters.
|
|
741
|
+
* @param {*} [options] Override http request option.
|
|
742
|
+
* @throws {RequiredError}
|
|
743
|
+
* @memberof FiltersApi
|
|
744
|
+
*/
|
|
745
|
+
public dryRunFilter(requestParameters: FiltersApiDryRunFilterRequest, options?: AxiosRequestConfig) {
|
|
746
|
+
return FiltersApiFp(this.configuration).dryRunFilter(requestParameters.dryRunFilterRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
747
|
+
}
|
|
748
|
+
|
|
642
749
|
/**
|
|
643
750
|
* Fetch a filter by its code. **Required Permissions** \"task-management.task-filters.view\"
|
|
644
751
|
* @summary Retrieve the filter
|
|
@@ -652,7 +759,7 @@ export class FiltersApi extends BaseAPI {
|
|
|
652
759
|
}
|
|
653
760
|
|
|
654
761
|
/**
|
|
655
|
-
*
|
|
762
|
+
* Retrieves a list of routing filters. **Required Permissions** \"task-management.task-filters.view\"
|
|
656
763
|
* @summary List filters
|
|
657
764
|
* @param {FiltersApiListFiltersRequest} requestParameters Request parameters.
|
|
658
765
|
* @param {*} [options] Override http request option.
|
package/api/task-client-api.ts
CHANGED
|
@@ -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
|
*/
|