@emilgroup/task-sdk-node 1.0.1-beta.4 → 1.0.1-beta.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +6 -6
- package/README.md +2 -2
- package/api/categories-api.ts +36 -50
- package/api/statuses-api.ts +36 -50
- package/api/tasks-api.ts +79 -51
- package/dist/api/categories-api.d.ts +25 -34
- package/dist/api/categories-api.js +26 -32
- package/dist/api/statuses-api.d.ts +25 -34
- package/dist/api/statuses-api.js +26 -32
- package/dist/api/tasks-api.d.ts +54 -36
- package/dist/api/tasks-api.js +47 -35
- package/dist/models/index.d.ts +6 -6
- package/dist/models/index.js +6 -6
- package/dist/models/{update-category-request-dto.d.ts → patch-category-request-dto.d.ts} +7 -7
- package/dist/models/{update-category-response-class.d.ts → patch-category-response-class.d.ts} +3 -3
- package/dist/models/{update-status-request-dto.d.ts → patch-status-request-dto.d.ts} +7 -7
- package/dist/models/{update-status-response-class.d.ts → patch-status-response-class.d.ts} +3 -3
- package/dist/models/patch-task-request-dto.d.ts +108 -0
- package/dist/models/{update-task-response-class.d.ts → patch-task-response-class.d.ts} +3 -3
- package/models/index.ts +6 -6
- package/models/{update-category-request-dto.ts → patch-category-request-dto.ts} +7 -7
- package/models/{update-category-response-class.ts → patch-category-response-class.ts} +3 -3
- package/models/{update-status-request-dto.ts → patch-status-request-dto.ts} +7 -7
- package/models/{update-status-response-class.ts → patch-status-response-class.ts} +3 -3
- package/models/patch-task-request-dto.ts +114 -0
- package/models/{update-task-response-class.ts → patch-task-response-class.ts} +3 -3
- package/package.json +1 -1
- package/dist/models/update-task-request-dto.d.ts +0 -72
- package/models/update-task-request-dto.ts +0 -78
- /package/dist/models/{update-category-request-dto.js → patch-category-request-dto.js} +0 -0
- /package/dist/models/{update-category-response-class.js → patch-category-response-class.js} +0 -0
- /package/dist/models/{update-status-request-dto.js → patch-status-request-dto.js} +0 -0
- /package/dist/models/{update-status-response-class.js → patch-status-response-class.js} +0 -0
- /package/dist/models/{update-task-request-dto.js → patch-task-request-dto.js} +0 -0
- /package/dist/models/{update-task-response-class.js → patch-task-response-class.js} +0 -0
package/api/tasks-api.ts
CHANGED
|
@@ -29,9 +29,9 @@ import { GetTaskResponseClass } from '../models';
|
|
|
29
29
|
// @ts-ignore
|
|
30
30
|
import { ListTasksResponseClass } from '../models';
|
|
31
31
|
// @ts-ignore
|
|
32
|
-
import {
|
|
32
|
+
import { PatchTaskRequestDto } from '../models';
|
|
33
33
|
// @ts-ignore
|
|
34
|
-
import {
|
|
34
|
+
import { PatchTaskResponseClass } from '../models';
|
|
35
35
|
// URLSearchParams not necessarily used
|
|
36
36
|
// @ts-ignore
|
|
37
37
|
import { URL, URLSearchParams } from 'url';
|
|
@@ -190,15 +190,17 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
190
190
|
* Retrieves a list of tasks.
|
|
191
191
|
* @summary List tasks
|
|
192
192
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
193
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
194
|
+
* @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
195
|
* @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, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</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, subject, description, assignee, reporter</i>
|
|
196
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
196
197
|
* @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</i>
|
|
197
198
|
* @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: category, status<i>
|
|
199
|
+
* @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, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
198
200
|
* @param {*} [options] Override http request option.
|
|
199
201
|
* @throws {RequiredError}
|
|
200
202
|
*/
|
|
201
|
-
listTasks: async (authorization?: string,
|
|
203
|
+
listTasks: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
202
204
|
const localVarPath = `/taskservice/v1/tasks`;
|
|
203
205
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
204
206
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -217,12 +219,16 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
217
219
|
// http bearer authentication required
|
|
218
220
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
219
221
|
|
|
220
|
-
if (
|
|
221
|
-
localVarQueryParameter['
|
|
222
|
+
if (pageSize !== undefined) {
|
|
223
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
222
224
|
}
|
|
223
225
|
|
|
224
|
-
if (
|
|
225
|
-
localVarQueryParameter['
|
|
226
|
+
if (pageToken !== undefined) {
|
|
227
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
228
|
+
}
|
|
229
|
+
|
|
230
|
+
if (filter !== undefined) {
|
|
231
|
+
localVarQueryParameter['filter'] = filter;
|
|
226
232
|
}
|
|
227
233
|
|
|
228
234
|
if (search !== undefined) {
|
|
@@ -237,6 +243,10 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
237
243
|
localVarQueryParameter['expand'] = expand;
|
|
238
244
|
}
|
|
239
245
|
|
|
246
|
+
if (filters !== undefined) {
|
|
247
|
+
localVarQueryParameter['filters'] = filters;
|
|
248
|
+
}
|
|
249
|
+
|
|
240
250
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
241
251
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
242
252
|
}
|
|
@@ -253,19 +263,19 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
253
263
|
};
|
|
254
264
|
},
|
|
255
265
|
/**
|
|
256
|
-
* This will update a task by code.
|
|
266
|
+
* This will partially update a task by code with the provided fields.
|
|
257
267
|
* @summary Update the task
|
|
258
268
|
* @param {string} code
|
|
259
|
-
* @param {
|
|
269
|
+
* @param {PatchTaskRequestDto} patchTaskRequestDto
|
|
260
270
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
261
271
|
* @param {*} [options] Override http request option.
|
|
262
272
|
* @throws {RequiredError}
|
|
263
273
|
*/
|
|
264
|
-
|
|
274
|
+
patchTask: async (code: string, patchTaskRequestDto: PatchTaskRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
265
275
|
// verify required parameter 'code' is not null or undefined
|
|
266
|
-
assertParamExists('
|
|
267
|
-
// verify required parameter '
|
|
268
|
-
assertParamExists('
|
|
276
|
+
assertParamExists('patchTask', 'code', code)
|
|
277
|
+
// verify required parameter 'patchTaskRequestDto' is not null or undefined
|
|
278
|
+
assertParamExists('patchTask', 'patchTaskRequestDto', patchTaskRequestDto)
|
|
269
279
|
const localVarPath = `/taskservice/v1/tasks/{code}`
|
|
270
280
|
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
271
281
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -277,7 +287,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
277
287
|
baseAccessToken = configuration.accessToken;
|
|
278
288
|
}
|
|
279
289
|
|
|
280
|
-
const localVarRequestOptions = { method: '
|
|
290
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
281
291
|
const localVarHeaderParameter = {} as any;
|
|
282
292
|
const localVarQueryParameter = {} as any;
|
|
283
293
|
|
|
@@ -296,7 +306,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
296
306
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
297
307
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
298
308
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
299
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
309
|
+
localVarRequestOptions.data = serializeDataIfNeeded(patchTaskRequestDto, localVarRequestOptions, configuration)
|
|
300
310
|
|
|
301
311
|
return {
|
|
302
312
|
url: toPathString(localVarUrlObj),
|
|
@@ -354,29 +364,31 @@ export const TasksApiFp = function(configuration?: Configuration) {
|
|
|
354
364
|
* Retrieves a list of tasks.
|
|
355
365
|
* @summary List tasks
|
|
356
366
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
367
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
368
|
+
* @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
369
|
* @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, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</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, subject, description, assignee, reporter</i>
|
|
370
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
360
371
|
* @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</i>
|
|
361
372
|
* @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: category, status<i>
|
|
373
|
+
* @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, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
362
374
|
* @param {*} [options] Override http request option.
|
|
363
375
|
* @throws {RequiredError}
|
|
364
376
|
*/
|
|
365
|
-
async listTasks(authorization?: string,
|
|
366
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listTasks(authorization,
|
|
377
|
+
async listTasks(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTasksResponseClass>> {
|
|
378
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listTasks(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
367
379
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
368
380
|
},
|
|
369
381
|
/**
|
|
370
|
-
* This will update a task by code.
|
|
382
|
+
* This will partially update a task by code with the provided fields.
|
|
371
383
|
* @summary Update the task
|
|
372
384
|
* @param {string} code
|
|
373
|
-
* @param {
|
|
385
|
+
* @param {PatchTaskRequestDto} patchTaskRequestDto
|
|
374
386
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
375
387
|
* @param {*} [options] Override http request option.
|
|
376
388
|
* @throws {RequiredError}
|
|
377
389
|
*/
|
|
378
|
-
async
|
|
379
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
390
|
+
async patchTask(code: string, patchTaskRequestDto: PatchTaskRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PatchTaskResponseClass>> {
|
|
391
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.patchTask(code, patchTaskRequestDto, authorization, options);
|
|
380
392
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
381
393
|
},
|
|
382
394
|
}
|
|
@@ -427,28 +439,30 @@ export const TasksApiFactory = function (configuration?: Configuration, basePath
|
|
|
427
439
|
* Retrieves a list of tasks.
|
|
428
440
|
* @summary List tasks
|
|
429
441
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
442
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
443
|
+
* @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
444
|
* @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, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</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, subject, description, assignee, reporter</i>
|
|
445
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
433
446
|
* @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</i>
|
|
434
447
|
* @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: category, status<i>
|
|
448
|
+
* @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, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
435
449
|
* @param {*} [options] Override http request option.
|
|
436
450
|
* @throws {RequiredError}
|
|
437
451
|
*/
|
|
438
|
-
listTasks(authorization?: string,
|
|
439
|
-
return localVarFp.listTasks(authorization,
|
|
452
|
+
listTasks(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListTasksResponseClass> {
|
|
453
|
+
return localVarFp.listTasks(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
440
454
|
},
|
|
441
455
|
/**
|
|
442
|
-
* This will update a task by code.
|
|
456
|
+
* This will partially update a task by code with the provided fields.
|
|
443
457
|
* @summary Update the task
|
|
444
458
|
* @param {string} code
|
|
445
|
-
* @param {
|
|
459
|
+
* @param {PatchTaskRequestDto} patchTaskRequestDto
|
|
446
460
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
447
461
|
* @param {*} [options] Override http request option.
|
|
448
462
|
* @throws {RequiredError}
|
|
449
463
|
*/
|
|
450
|
-
|
|
451
|
-
return localVarFp.
|
|
464
|
+
patchTask(code: string, patchTaskRequestDto: PatchTaskRequestDto, authorization?: string, options?: any): AxiosPromise<PatchTaskResponseClass> {
|
|
465
|
+
return localVarFp.patchTask(code, patchTaskRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
452
466
|
},
|
|
453
467
|
};
|
|
454
468
|
};
|
|
@@ -537,21 +551,28 @@ export interface TasksApiListTasksRequest {
|
|
|
537
551
|
readonly authorization?: string
|
|
538
552
|
|
|
539
553
|
/**
|
|
540
|
-
*
|
|
554
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
555
|
+
* @type {number}
|
|
556
|
+
* @memberof TasksApiListTasks
|
|
557
|
+
*/
|
|
558
|
+
readonly pageSize?: number
|
|
559
|
+
|
|
560
|
+
/**
|
|
561
|
+
* 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
562
|
* @type {string}
|
|
542
563
|
* @memberof TasksApiListTasks
|
|
543
564
|
*/
|
|
544
|
-
readonly
|
|
565
|
+
readonly pageToken?: string
|
|
545
566
|
|
|
546
567
|
/**
|
|
547
|
-
*
|
|
568
|
+
* 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, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
548
569
|
* @type {string}
|
|
549
570
|
* @memberof TasksApiListTasks
|
|
550
571
|
*/
|
|
551
|
-
readonly
|
|
572
|
+
readonly filter?: string
|
|
552
573
|
|
|
553
574
|
/**
|
|
554
|
-
*
|
|
575
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
555
576
|
* @type {string}
|
|
556
577
|
* @memberof TasksApiListTasks
|
|
557
578
|
*/
|
|
@@ -570,32 +591,39 @@ export interface TasksApiListTasksRequest {
|
|
|
570
591
|
* @memberof TasksApiListTasks
|
|
571
592
|
*/
|
|
572
593
|
readonly expand?: string
|
|
594
|
+
|
|
595
|
+
/**
|
|
596
|
+
* 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, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
597
|
+
* @type {string}
|
|
598
|
+
* @memberof TasksApiListTasks
|
|
599
|
+
*/
|
|
600
|
+
readonly filters?: string
|
|
573
601
|
}
|
|
574
602
|
|
|
575
603
|
/**
|
|
576
|
-
* Request parameters for
|
|
604
|
+
* Request parameters for patchTask operation in TasksApi.
|
|
577
605
|
* @export
|
|
578
|
-
* @interface
|
|
606
|
+
* @interface TasksApiPatchTaskRequest
|
|
579
607
|
*/
|
|
580
|
-
export interface
|
|
608
|
+
export interface TasksApiPatchTaskRequest {
|
|
581
609
|
/**
|
|
582
610
|
*
|
|
583
611
|
* @type {string}
|
|
584
|
-
* @memberof
|
|
612
|
+
* @memberof TasksApiPatchTask
|
|
585
613
|
*/
|
|
586
614
|
readonly code: string
|
|
587
615
|
|
|
588
616
|
/**
|
|
589
617
|
*
|
|
590
|
-
* @type {
|
|
591
|
-
* @memberof
|
|
618
|
+
* @type {PatchTaskRequestDto}
|
|
619
|
+
* @memberof TasksApiPatchTask
|
|
592
620
|
*/
|
|
593
|
-
readonly
|
|
621
|
+
readonly patchTaskRequestDto: PatchTaskRequestDto
|
|
594
622
|
|
|
595
623
|
/**
|
|
596
624
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
597
625
|
* @type {string}
|
|
598
|
-
* @memberof
|
|
626
|
+
* @memberof TasksApiPatchTask
|
|
599
627
|
*/
|
|
600
628
|
readonly authorization?: string
|
|
601
629
|
}
|
|
@@ -652,18 +680,18 @@ export class TasksApi extends BaseAPI {
|
|
|
652
680
|
* @memberof TasksApi
|
|
653
681
|
*/
|
|
654
682
|
public listTasks(requestParameters: TasksApiListTasksRequest = {}, options?: AxiosRequestConfig) {
|
|
655
|
-
return TasksApiFp(this.configuration).listTasks(requestParameters.authorization, requestParameters.
|
|
683
|
+
return TasksApiFp(this.configuration).listTasks(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
684
|
}
|
|
657
685
|
|
|
658
686
|
/**
|
|
659
|
-
* This will update a task by code.
|
|
687
|
+
* This will partially update a task by code with the provided fields.
|
|
660
688
|
* @summary Update the task
|
|
661
|
-
* @param {
|
|
689
|
+
* @param {TasksApiPatchTaskRequest} requestParameters Request parameters.
|
|
662
690
|
* @param {*} [options] Override http request option.
|
|
663
691
|
* @throws {RequiredError}
|
|
664
692
|
* @memberof TasksApi
|
|
665
693
|
*/
|
|
666
|
-
public
|
|
667
|
-
return TasksApiFp(this.configuration).
|
|
694
|
+
public patchTask(requestParameters: TasksApiPatchTaskRequest, options?: AxiosRequestConfig) {
|
|
695
|
+
return TasksApiFp(this.configuration).patchTask(requestParameters.code, requestParameters.patchTaskRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
668
696
|
}
|
|
669
697
|
}
|
|
@@ -16,8 +16,8 @@ import { CreateCategoryRequestDto } from '../models';
|
|
|
16
16
|
import { CreateCategoryResponseClass } from '../models';
|
|
17
17
|
import { GetCategoryResponseClass } from '../models';
|
|
18
18
|
import { ListCategoriesResponseClass } from '../models';
|
|
19
|
-
import {
|
|
20
|
-
import {
|
|
19
|
+
import { PatchCategoryRequestDto } from '../models';
|
|
20
|
+
import { PatchCategoryResponseClass } from '../models';
|
|
21
21
|
/**
|
|
22
22
|
* CategoriesApi - axios parameter creator
|
|
23
23
|
* @export
|
|
@@ -57,23 +57,22 @@ export declare const CategoriesApiAxiosParamCreator: (configuration?: Configurat
|
|
|
57
57
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
58
58
|
* @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>
|
|
59
59
|
* @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>
|
|
60
|
-
* @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>
|
|
61
60
|
* @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>
|
|
62
61
|
* @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/>
|
|
63
62
|
* @param {*} [options] Override http request option.
|
|
64
63
|
* @throws {RequiredError}
|
|
65
64
|
*/
|
|
66
|
-
listCategories: (authorization?: string, filter?: string, filters?: string,
|
|
65
|
+
listCategories: (authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
67
66
|
/**
|
|
68
|
-
* This will update category.
|
|
67
|
+
* This will partially update a category by code with the provided fields.
|
|
69
68
|
* @summary Update the category
|
|
70
69
|
* @param {string} code
|
|
71
|
-
* @param {
|
|
70
|
+
* @param {PatchCategoryRequestDto} patchCategoryRequestDto
|
|
72
71
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
73
72
|
* @param {*} [options] Override http request option.
|
|
74
73
|
* @throws {RequiredError}
|
|
75
74
|
*/
|
|
76
|
-
|
|
75
|
+
patchCategory: (code: string, patchCategoryRequestDto: PatchCategoryRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
77
76
|
};
|
|
78
77
|
/**
|
|
79
78
|
* CategoriesApi - functional programming interface
|
|
@@ -114,23 +113,22 @@ export declare const CategoriesApiFp: (configuration?: Configuration) => {
|
|
|
114
113
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
115
114
|
* @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>
|
|
116
115
|
* @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>
|
|
117
|
-
* @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>
|
|
118
116
|
* @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>
|
|
119
117
|
* @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/>
|
|
120
118
|
* @param {*} [options] Override http request option.
|
|
121
119
|
* @throws {RequiredError}
|
|
122
120
|
*/
|
|
123
|
-
listCategories(authorization?: string, filter?: string, filters?: string,
|
|
121
|
+
listCategories(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCategoriesResponseClass>>;
|
|
124
122
|
/**
|
|
125
|
-
* This will update category.
|
|
123
|
+
* This will partially update a category by code with the provided fields.
|
|
126
124
|
* @summary Update the category
|
|
127
125
|
* @param {string} code
|
|
128
|
-
* @param {
|
|
126
|
+
* @param {PatchCategoryRequestDto} patchCategoryRequestDto
|
|
129
127
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
130
128
|
* @param {*} [options] Override http request option.
|
|
131
129
|
* @throws {RequiredError}
|
|
132
130
|
*/
|
|
133
|
-
|
|
131
|
+
patchCategory(code: string, patchCategoryRequestDto: PatchCategoryRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PatchCategoryResponseClass>>;
|
|
134
132
|
};
|
|
135
133
|
/**
|
|
136
134
|
* CategoriesApi - factory interface
|
|
@@ -171,23 +169,22 @@ export declare const CategoriesApiFactory: (configuration?: Configuration, baseP
|
|
|
171
169
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
172
170
|
* @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>
|
|
173
171
|
* @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>
|
|
174
|
-
* @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>
|
|
175
172
|
* @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>
|
|
176
173
|
* @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/>
|
|
177
174
|
* @param {*} [options] Override http request option.
|
|
178
175
|
* @throws {RequiredError}
|
|
179
176
|
*/
|
|
180
|
-
listCategories(authorization?: string, filter?: string, filters?: string,
|
|
177
|
+
listCategories(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListCategoriesResponseClass>;
|
|
181
178
|
/**
|
|
182
|
-
* This will update category.
|
|
179
|
+
* This will partially update a category by code with the provided fields.
|
|
183
180
|
* @summary Update the category
|
|
184
181
|
* @param {string} code
|
|
185
|
-
* @param {
|
|
182
|
+
* @param {PatchCategoryRequestDto} patchCategoryRequestDto
|
|
186
183
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
187
184
|
* @param {*} [options] Override http request option.
|
|
188
185
|
* @throws {RequiredError}
|
|
189
186
|
*/
|
|
190
|
-
|
|
187
|
+
patchCategory(code: string, patchCategoryRequestDto: PatchCategoryRequestDto, authorization?: string, options?: any): AxiosPromise<PatchCategoryResponseClass>;
|
|
191
188
|
};
|
|
192
189
|
/**
|
|
193
190
|
* Request parameters for createCategory operation in CategoriesApi.
|
|
@@ -276,12 +273,6 @@ export interface CategoriesApiListCategoriesRequest {
|
|
|
276
273
|
* @memberof CategoriesApiListCategories
|
|
277
274
|
*/
|
|
278
275
|
readonly filters?: string;
|
|
279
|
-
/**
|
|
280
|
-
* 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>
|
|
281
|
-
* @type {string}
|
|
282
|
-
* @memberof CategoriesApiListCategories
|
|
283
|
-
*/
|
|
284
|
-
readonly search?: string;
|
|
285
276
|
/**
|
|
286
277
|
* 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>
|
|
287
278
|
* @type {string}
|
|
@@ -296,27 +287,27 @@ export interface CategoriesApiListCategoriesRequest {
|
|
|
296
287
|
readonly expand?: string;
|
|
297
288
|
}
|
|
298
289
|
/**
|
|
299
|
-
* Request parameters for
|
|
290
|
+
* Request parameters for patchCategory operation in CategoriesApi.
|
|
300
291
|
* @export
|
|
301
|
-
* @interface
|
|
292
|
+
* @interface CategoriesApiPatchCategoryRequest
|
|
302
293
|
*/
|
|
303
|
-
export interface
|
|
294
|
+
export interface CategoriesApiPatchCategoryRequest {
|
|
304
295
|
/**
|
|
305
296
|
*
|
|
306
297
|
* @type {string}
|
|
307
|
-
* @memberof
|
|
298
|
+
* @memberof CategoriesApiPatchCategory
|
|
308
299
|
*/
|
|
309
300
|
readonly code: string;
|
|
310
301
|
/**
|
|
311
302
|
*
|
|
312
|
-
* @type {
|
|
313
|
-
* @memberof
|
|
303
|
+
* @type {PatchCategoryRequestDto}
|
|
304
|
+
* @memberof CategoriesApiPatchCategory
|
|
314
305
|
*/
|
|
315
|
-
readonly
|
|
306
|
+
readonly patchCategoryRequestDto: PatchCategoryRequestDto;
|
|
316
307
|
/**
|
|
317
308
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
318
309
|
* @type {string}
|
|
319
|
-
* @memberof
|
|
310
|
+
* @memberof CategoriesApiPatchCategory
|
|
320
311
|
*/
|
|
321
312
|
readonly authorization?: string;
|
|
322
313
|
}
|
|
@@ -364,12 +355,12 @@ export declare class CategoriesApi extends BaseAPI {
|
|
|
364
355
|
*/
|
|
365
356
|
listCategories(requestParameters?: CategoriesApiListCategoriesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCategoriesResponseClass, any, {}>>;
|
|
366
357
|
/**
|
|
367
|
-
* This will update category.
|
|
358
|
+
* This will partially update a category by code with the provided fields.
|
|
368
359
|
* @summary Update the category
|
|
369
|
-
* @param {
|
|
360
|
+
* @param {CategoriesApiPatchCategoryRequest} requestParameters Request parameters.
|
|
370
361
|
* @param {*} [options] Override http request option.
|
|
371
362
|
* @throws {RequiredError}
|
|
372
363
|
* @memberof CategoriesApi
|
|
373
364
|
*/
|
|
374
|
-
|
|
365
|
+
patchCategory(requestParameters: CategoriesApiPatchCategoryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PatchCategoryResponseClass, any, {}>>;
|
|
375
366
|
}
|