@emilgroup/task-sdk-node 1.0.1-beta.12 → 1.0.1-beta.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/api/categories-api.ts +62 -36
- package/api/default-api.ts +1 -1
- package/api/statuses-api.ts +17 -19
- package/api/tasks-api.ts +13 -15
- package/dist/api/categories-api.d.ts +42 -24
- package/dist/api/categories-api.js +36 -26
- package/dist/api/default-api.js +1 -1
- package/dist/api/statuses-api.d.ts +14 -14
- package/dist/api/statuses-api.js +12 -14
- package/dist/api/tasks-api.d.ts +10 -10
- package/dist/api/tasks-api.js +9 -11
- package/dist/models/create-task-request-dto.d.ts +2 -2
- package/dist/models/task-class.d.ts +15 -3
- package/models/create-task-request-dto.ts +2 -2
- package/models/task-class.ts +15 -3
- package/package.json +1 -1
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.0.1-beta.
|
|
20
|
+
npm install @emilgroup/task-sdk-node@1.0.1-beta.14 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/task-sdk-node@1.0.1-beta.
|
|
24
|
+
yarn add @emilgroup/task-sdk-node@1.0.1-beta.14
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `TasksApi`.
|
package/api/categories-api.ts
CHANGED
|
@@ -138,16 +138,14 @@ export const CategoriesApiAxiosParamCreator = function (configuration?: Configur
|
|
|
138
138
|
* Get category by code.
|
|
139
139
|
* @summary Retrieve the category
|
|
140
140
|
* @param {string} code
|
|
141
|
-
* @param {string} expand
|
|
142
141
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
142
|
+
* @param {string} [expand] Expand to fetch additional information about the category.
|
|
143
143
|
* @param {*} [options] Override http request option.
|
|
144
144
|
* @throws {RequiredError}
|
|
145
145
|
*/
|
|
146
|
-
getCategory: async (code: string,
|
|
146
|
+
getCategory: async (code: string, authorization?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
147
147
|
// verify required parameter 'code' is not null or undefined
|
|
148
148
|
assertParamExists('getCategory', 'code', code)
|
|
149
|
-
// verify required parameter 'expand' is not null or undefined
|
|
150
|
-
assertParamExists('getCategory', 'expand', expand)
|
|
151
149
|
const localVarPath = `/taskservice/v1/categories/{code}`
|
|
152
150
|
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
153
151
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -190,15 +188,17 @@ export const CategoriesApiAxiosParamCreator = function (configuration?: Configur
|
|
|
190
188
|
* Retrieves a list of categories.
|
|
191
189
|
* @summary List categories
|
|
192
190
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
191
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
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
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, slug, name, createdAt, updatedAt</i>
|
|
194
|
-
* @param {string} [
|
|
195
|
-
* @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: id, code, name, slug</i>
|
|
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: name, slug</i>
|
|
196
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, name, slug</i>
|
|
197
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/>
|
|
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, slug, name, createdAt, updatedAt</i>
|
|
198
198
|
* @param {*} [options] Override http request option.
|
|
199
199
|
* @throws {RequiredError}
|
|
200
200
|
*/
|
|
201
|
-
listCategories: async (authorization?: string,
|
|
201
|
+
listCategories: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
202
202
|
const localVarPath = `/taskservice/v1/categories`;
|
|
203
203
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
204
204
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -217,12 +217,16 @@ export const CategoriesApiAxiosParamCreator = function (configuration?: Configur
|
|
|
217
217
|
// http bearer authentication required
|
|
218
218
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
219
219
|
|
|
220
|
-
if (
|
|
221
|
-
localVarQueryParameter['
|
|
220
|
+
if (pageSize !== undefined) {
|
|
221
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
222
222
|
}
|
|
223
223
|
|
|
224
|
-
if (
|
|
225
|
-
localVarQueryParameter['
|
|
224
|
+
if (pageToken !== undefined) {
|
|
225
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
226
|
+
}
|
|
227
|
+
|
|
228
|
+
if (filter !== undefined) {
|
|
229
|
+
localVarQueryParameter['filter'] = filter;
|
|
226
230
|
}
|
|
227
231
|
|
|
228
232
|
if (search !== undefined) {
|
|
@@ -237,6 +241,10 @@ export const CategoriesApiAxiosParamCreator = function (configuration?: Configur
|
|
|
237
241
|
localVarQueryParameter['expand'] = expand;
|
|
238
242
|
}
|
|
239
243
|
|
|
244
|
+
if (filters !== undefined) {
|
|
245
|
+
localVarQueryParameter['filters'] = filters;
|
|
246
|
+
}
|
|
247
|
+
|
|
240
248
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
241
249
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
242
250
|
}
|
|
@@ -341,29 +349,31 @@ export const CategoriesApiFp = function(configuration?: Configuration) {
|
|
|
341
349
|
* Get category by code.
|
|
342
350
|
* @summary Retrieve the category
|
|
343
351
|
* @param {string} code
|
|
344
|
-
* @param {string} expand
|
|
345
352
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
353
|
+
* @param {string} [expand] Expand to fetch additional information about the category.
|
|
346
354
|
* @param {*} [options] Override http request option.
|
|
347
355
|
* @throws {RequiredError}
|
|
348
356
|
*/
|
|
349
|
-
async getCategory(code: string,
|
|
350
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getCategory(code,
|
|
357
|
+
async getCategory(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCategoryResponseClass>> {
|
|
358
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getCategory(code, authorization, expand, options);
|
|
351
359
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
352
360
|
},
|
|
353
361
|
/**
|
|
354
362
|
* Retrieves a list of categories.
|
|
355
363
|
* @summary List categories
|
|
356
364
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
365
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
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.
|
|
357
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, slug, name, createdAt, updatedAt</i>
|
|
358
|
-
* @param {string} [
|
|
359
|
-
* @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: id, code, name, slug</i>
|
|
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: name, slug</i>
|
|
360
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, name, slug</i>
|
|
361
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/>
|
|
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, slug, name, createdAt, updatedAt</i>
|
|
362
372
|
* @param {*} [options] Override http request option.
|
|
363
373
|
* @throws {RequiredError}
|
|
364
374
|
*/
|
|
365
|
-
async listCategories(authorization?: string,
|
|
366
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listCategories(authorization,
|
|
375
|
+
async listCategories(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCategoriesResponseClass>> {
|
|
376
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listCategories(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
367
377
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
368
378
|
},
|
|
369
379
|
/**
|
|
@@ -415,28 +425,30 @@ export const CategoriesApiFactory = function (configuration?: Configuration, bas
|
|
|
415
425
|
* Get category by code.
|
|
416
426
|
* @summary Retrieve the category
|
|
417
427
|
* @param {string} code
|
|
418
|
-
* @param {string} expand
|
|
419
428
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
429
|
+
* @param {string} [expand] Expand to fetch additional information about the category.
|
|
420
430
|
* @param {*} [options] Override http request option.
|
|
421
431
|
* @throws {RequiredError}
|
|
422
432
|
*/
|
|
423
|
-
getCategory(code: string,
|
|
424
|
-
return localVarFp.getCategory(code,
|
|
433
|
+
getCategory(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetCategoryResponseClass> {
|
|
434
|
+
return localVarFp.getCategory(code, authorization, expand, options).then((request) => request(axios, basePath));
|
|
425
435
|
},
|
|
426
436
|
/**
|
|
427
437
|
* Retrieves a list of categories.
|
|
428
438
|
* @summary List categories
|
|
429
439
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
440
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
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.
|
|
430
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, slug, name, createdAt, updatedAt</i>
|
|
431
|
-
* @param {string} [
|
|
432
|
-
* @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: id, code, name, slug</i>
|
|
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: name, slug</i>
|
|
433
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, name, slug</i>
|
|
434
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/>
|
|
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, slug, name, createdAt, updatedAt</i>
|
|
435
447
|
* @param {*} [options] Override http request option.
|
|
436
448
|
* @throws {RequiredError}
|
|
437
449
|
*/
|
|
438
|
-
listCategories(authorization?: string,
|
|
439
|
-
return localVarFp.listCategories(authorization,
|
|
450
|
+
listCategories(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCategoriesResponseClass> {
|
|
451
|
+
return localVarFp.listCategories(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
440
452
|
},
|
|
441
453
|
/**
|
|
442
454
|
* This will partially update a category by code with the provided fields.
|
|
@@ -509,18 +521,18 @@ export interface CategoriesApiGetCategoryRequest {
|
|
|
509
521
|
readonly code: string
|
|
510
522
|
|
|
511
523
|
/**
|
|
512
|
-
*
|
|
524
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
513
525
|
* @type {string}
|
|
514
526
|
* @memberof CategoriesApiGetCategory
|
|
515
527
|
*/
|
|
516
|
-
readonly
|
|
528
|
+
readonly authorization?: string
|
|
517
529
|
|
|
518
530
|
/**
|
|
519
|
-
*
|
|
531
|
+
* Expand to fetch additional information about the category.
|
|
520
532
|
* @type {string}
|
|
521
533
|
* @memberof CategoriesApiGetCategory
|
|
522
534
|
*/
|
|
523
|
-
readonly
|
|
535
|
+
readonly expand?: string
|
|
524
536
|
}
|
|
525
537
|
|
|
526
538
|
/**
|
|
@@ -537,21 +549,28 @@ export interface CategoriesApiListCategoriesRequest {
|
|
|
537
549
|
readonly authorization?: string
|
|
538
550
|
|
|
539
551
|
/**
|
|
540
|
-
*
|
|
552
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
553
|
+
* @type {number}
|
|
554
|
+
* @memberof CategoriesApiListCategories
|
|
555
|
+
*/
|
|
556
|
+
readonly pageSize?: number
|
|
557
|
+
|
|
558
|
+
/**
|
|
559
|
+
* 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.
|
|
541
560
|
* @type {string}
|
|
542
561
|
* @memberof CategoriesApiListCategories
|
|
543
562
|
*/
|
|
544
|
-
readonly
|
|
563
|
+
readonly pageToken?: string
|
|
545
564
|
|
|
546
565
|
/**
|
|
547
|
-
*
|
|
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, slug, name, createdAt, updatedAt</i>
|
|
548
567
|
* @type {string}
|
|
549
568
|
* @memberof CategoriesApiListCategories
|
|
550
569
|
*/
|
|
551
|
-
readonly
|
|
570
|
+
readonly filter?: string
|
|
552
571
|
|
|
553
572
|
/**
|
|
554
|
-
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields:
|
|
573
|
+
* 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>
|
|
555
574
|
* @type {string}
|
|
556
575
|
* @memberof CategoriesApiListCategories
|
|
557
576
|
*/
|
|
@@ -570,6 +589,13 @@ export interface CategoriesApiListCategoriesRequest {
|
|
|
570
589
|
* @memberof CategoriesApiListCategories
|
|
571
590
|
*/
|
|
572
591
|
readonly expand?: string
|
|
592
|
+
|
|
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, slug, name, createdAt, updatedAt</i>
|
|
595
|
+
* @type {string}
|
|
596
|
+
* @memberof CategoriesApiListCategories
|
|
597
|
+
*/
|
|
598
|
+
readonly filters?: string
|
|
573
599
|
}
|
|
574
600
|
|
|
575
601
|
/**
|
|
@@ -640,7 +666,7 @@ export class CategoriesApi extends BaseAPI {
|
|
|
640
666
|
* @memberof CategoriesApi
|
|
641
667
|
*/
|
|
642
668
|
public getCategory(requestParameters: CategoriesApiGetCategoryRequest, options?: AxiosRequestConfig) {
|
|
643
|
-
return CategoriesApiFp(this.configuration).getCategory(requestParameters.code, requestParameters.
|
|
669
|
+
return CategoriesApiFp(this.configuration).getCategory(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
644
670
|
}
|
|
645
671
|
|
|
646
672
|
/**
|
|
@@ -652,7 +678,7 @@ export class CategoriesApi extends BaseAPI {
|
|
|
652
678
|
* @memberof CategoriesApi
|
|
653
679
|
*/
|
|
654
680
|
public listCategories(requestParameters: CategoriesApiListCategoriesRequest = {}, options?: AxiosRequestConfig) {
|
|
655
|
-
return CategoriesApiFp(this.configuration).listCategories(requestParameters.authorization, requestParameters.
|
|
681
|
+
return CategoriesApiFp(this.configuration).listCategories(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
656
682
|
}
|
|
657
683
|
|
|
658
684
|
/**
|
package/api/default-api.ts
CHANGED
|
@@ -41,7 +41,7 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
41
41
|
* @throws {RequiredError}
|
|
42
42
|
*/
|
|
43
43
|
check: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
44
|
-
const localVarPath = `/
|
|
44
|
+
const localVarPath = `/taskservice/health`;
|
|
45
45
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
46
46
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
47
47
|
let baseOptions;
|
package/api/statuses-api.ts
CHANGED
|
@@ -138,16 +138,14 @@ export const StatusesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
138
138
|
* Get status by code.
|
|
139
139
|
* @summary Retrieve the status
|
|
140
140
|
* @param {string} code
|
|
141
|
-
* @param {string} expand
|
|
142
141
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
142
|
+
* @param {string} [expand] Expand to fetch additional information about the status.
|
|
143
143
|
* @param {*} [options] Override http request option.
|
|
144
144
|
* @throws {RequiredError}
|
|
145
145
|
*/
|
|
146
|
-
getStatus: async (code: string,
|
|
146
|
+
getStatus: async (code: string, authorization?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
147
147
|
// verify required parameter 'code' is not null or undefined
|
|
148
148
|
assertParamExists('getStatus', 'code', code)
|
|
149
|
-
// verify required parameter 'expand' is not null or undefined
|
|
150
|
-
assertParamExists('getStatus', 'expand', expand)
|
|
151
149
|
const localVarPath = `/taskservice/v1/statuses/{code}`
|
|
152
150
|
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
153
151
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -192,7 +190,7 @@ export const StatusesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
192
190
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
193
191
|
* @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, createdAt, updatedAt</i>
|
|
194
192
|
* @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, createdAt, updatedAt</i>
|
|
195
|
-
* @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:
|
|
193
|
+
* @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: code, name, slug</i>
|
|
196
194
|
* @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</i>
|
|
197
195
|
* @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/>
|
|
198
196
|
* @param {*} [options] Override http request option.
|
|
@@ -341,13 +339,13 @@ export const StatusesApiFp = function(configuration?: Configuration) {
|
|
|
341
339
|
* Get status by code.
|
|
342
340
|
* @summary Retrieve the status
|
|
343
341
|
* @param {string} code
|
|
344
|
-
* @param {string} expand
|
|
345
342
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
343
|
+
* @param {string} [expand] Expand to fetch additional information about the status.
|
|
346
344
|
* @param {*} [options] Override http request option.
|
|
347
345
|
* @throws {RequiredError}
|
|
348
346
|
*/
|
|
349
|
-
async getStatus(code: string,
|
|
350
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getStatus(code,
|
|
347
|
+
async getStatus(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetStatusResponseClass>> {
|
|
348
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getStatus(code, authorization, expand, options);
|
|
351
349
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
352
350
|
},
|
|
353
351
|
/**
|
|
@@ -356,7 +354,7 @@ export const StatusesApiFp = function(configuration?: Configuration) {
|
|
|
356
354
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
357
355
|
* @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, createdAt, updatedAt</i>
|
|
358
356
|
* @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, createdAt, updatedAt</i>
|
|
359
|
-
* @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:
|
|
357
|
+
* @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: code, name, slug</i>
|
|
360
358
|
* @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</i>
|
|
361
359
|
* @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/>
|
|
362
360
|
* @param {*} [options] Override http request option.
|
|
@@ -415,13 +413,13 @@ export const StatusesApiFactory = function (configuration?: Configuration, baseP
|
|
|
415
413
|
* Get status by code.
|
|
416
414
|
* @summary Retrieve the status
|
|
417
415
|
* @param {string} code
|
|
418
|
-
* @param {string} expand
|
|
419
416
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
417
|
+
* @param {string} [expand] Expand to fetch additional information about the status.
|
|
420
418
|
* @param {*} [options] Override http request option.
|
|
421
419
|
* @throws {RequiredError}
|
|
422
420
|
*/
|
|
423
|
-
getStatus(code: string,
|
|
424
|
-
return localVarFp.getStatus(code,
|
|
421
|
+
getStatus(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetStatusResponseClass> {
|
|
422
|
+
return localVarFp.getStatus(code, authorization, expand, options).then((request) => request(axios, basePath));
|
|
425
423
|
},
|
|
426
424
|
/**
|
|
427
425
|
* Retrieves a list of statuses.
|
|
@@ -429,7 +427,7 @@ export const StatusesApiFactory = function (configuration?: Configuration, baseP
|
|
|
429
427
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
430
428
|
* @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, createdAt, updatedAt</i>
|
|
431
429
|
* @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, createdAt, updatedAt</i>
|
|
432
|
-
* @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:
|
|
430
|
+
* @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: code, name, slug</i>
|
|
433
431
|
* @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</i>
|
|
434
432
|
* @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/>
|
|
435
433
|
* @param {*} [options] Override http request option.
|
|
@@ -509,18 +507,18 @@ export interface StatusesApiGetStatusRequest {
|
|
|
509
507
|
readonly code: string
|
|
510
508
|
|
|
511
509
|
/**
|
|
512
|
-
*
|
|
510
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
513
511
|
* @type {string}
|
|
514
512
|
* @memberof StatusesApiGetStatus
|
|
515
513
|
*/
|
|
516
|
-
readonly
|
|
514
|
+
readonly authorization?: string
|
|
517
515
|
|
|
518
516
|
/**
|
|
519
|
-
*
|
|
517
|
+
* Expand to fetch additional information about the status.
|
|
520
518
|
* @type {string}
|
|
521
519
|
* @memberof StatusesApiGetStatus
|
|
522
520
|
*/
|
|
523
|
-
readonly
|
|
521
|
+
readonly expand?: string
|
|
524
522
|
}
|
|
525
523
|
|
|
526
524
|
/**
|
|
@@ -551,7 +549,7 @@ export interface StatusesApiListStatusesRequest {
|
|
|
551
549
|
readonly filters?: string
|
|
552
550
|
|
|
553
551
|
/**
|
|
554
|
-
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields:
|
|
552
|
+
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, name, slug</i>
|
|
555
553
|
* @type {string}
|
|
556
554
|
* @memberof StatusesApiListStatuses
|
|
557
555
|
*/
|
|
@@ -640,7 +638,7 @@ export class StatusesApi extends BaseAPI {
|
|
|
640
638
|
* @memberof StatusesApi
|
|
641
639
|
*/
|
|
642
640
|
public getStatus(requestParameters: StatusesApiGetStatusRequest, options?: AxiosRequestConfig) {
|
|
643
|
-
return StatusesApiFp(this.configuration).getStatus(requestParameters.code, requestParameters.
|
|
641
|
+
return StatusesApiFp(this.configuration).getStatus(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
644
642
|
}
|
|
645
643
|
|
|
646
644
|
/**
|
package/api/tasks-api.ts
CHANGED
|
@@ -138,16 +138,14 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
138
138
|
* This will get a task by code.
|
|
139
139
|
* @summary Retrieve the task
|
|
140
140
|
* @param {string} code
|
|
141
|
-
* @param {string} expand
|
|
142
141
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
142
|
+
* @param {string} [expand] Expand to fetch additional information about the task.
|
|
143
143
|
* @param {*} [options] Override http request option.
|
|
144
144
|
* @throws {RequiredError}
|
|
145
145
|
*/
|
|
146
|
-
getTask: async (code: string,
|
|
146
|
+
getTask: async (code: string, authorization?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
147
147
|
// verify required parameter 'code' is not null or undefined
|
|
148
148
|
assertParamExists('getTask', 'code', code)
|
|
149
|
-
// verify required parameter 'expand' is not null or undefined
|
|
150
|
-
assertParamExists('getTask', 'expand', expand)
|
|
151
149
|
const localVarPath = `/taskservice/v1/tasks/{code}`
|
|
152
150
|
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
153
151
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -351,13 +349,13 @@ export const TasksApiFp = function(configuration?: Configuration) {
|
|
|
351
349
|
* This will get a task by code.
|
|
352
350
|
* @summary Retrieve the task
|
|
353
351
|
* @param {string} code
|
|
354
|
-
* @param {string} expand
|
|
355
352
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
353
|
+
* @param {string} [expand] Expand to fetch additional information about the task.
|
|
356
354
|
* @param {*} [options] Override http request option.
|
|
357
355
|
* @throws {RequiredError}
|
|
358
356
|
*/
|
|
359
|
-
async getTask(code: string,
|
|
360
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getTask(code,
|
|
357
|
+
async getTask(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTaskResponseClass>> {
|
|
358
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getTask(code, authorization, expand, options);
|
|
361
359
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
362
360
|
},
|
|
363
361
|
/**
|
|
@@ -427,13 +425,13 @@ export const TasksApiFactory = function (configuration?: Configuration, basePath
|
|
|
427
425
|
* This will get a task by code.
|
|
428
426
|
* @summary Retrieve the task
|
|
429
427
|
* @param {string} code
|
|
430
|
-
* @param {string} expand
|
|
431
428
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
429
|
+
* @param {string} [expand] Expand to fetch additional information about the task.
|
|
432
430
|
* @param {*} [options] Override http request option.
|
|
433
431
|
* @throws {RequiredError}
|
|
434
432
|
*/
|
|
435
|
-
getTask(code: string,
|
|
436
|
-
return localVarFp.getTask(code,
|
|
433
|
+
getTask(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetTaskResponseClass> {
|
|
434
|
+
return localVarFp.getTask(code, authorization, expand, options).then((request) => request(axios, basePath));
|
|
437
435
|
},
|
|
438
436
|
/**
|
|
439
437
|
* Retrieves a list of tasks.
|
|
@@ -523,18 +521,18 @@ export interface TasksApiGetTaskRequest {
|
|
|
523
521
|
readonly code: string
|
|
524
522
|
|
|
525
523
|
/**
|
|
526
|
-
*
|
|
524
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
527
525
|
* @type {string}
|
|
528
526
|
* @memberof TasksApiGetTask
|
|
529
527
|
*/
|
|
530
|
-
readonly
|
|
528
|
+
readonly authorization?: string
|
|
531
529
|
|
|
532
530
|
/**
|
|
533
|
-
*
|
|
531
|
+
* Expand to fetch additional information about the task.
|
|
534
532
|
* @type {string}
|
|
535
533
|
* @memberof TasksApiGetTask
|
|
536
534
|
*/
|
|
537
|
-
readonly
|
|
535
|
+
readonly expand?: string
|
|
538
536
|
}
|
|
539
537
|
|
|
540
538
|
/**
|
|
@@ -668,7 +666,7 @@ export class TasksApi extends BaseAPI {
|
|
|
668
666
|
* @memberof TasksApi
|
|
669
667
|
*/
|
|
670
668
|
public getTask(requestParameters: TasksApiGetTaskRequest, options?: AxiosRequestConfig) {
|
|
671
|
-
return TasksApiFp(this.configuration).getTask(requestParameters.code, requestParameters.
|
|
669
|
+
return TasksApiFp(this.configuration).getTask(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
672
670
|
}
|
|
673
671
|
|
|
674
672
|
/**
|