@emilgroup/task-sdk 1.0.1-beta.10 → 1.0.1-beta.4
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 +30 -30
- package/api/statuses-api.ts +30 -30
- package/api/tasks-api.ts +58 -86
- package/dist/api/categories-api.d.ts +22 -22
- package/dist/api/categories-api.js +20 -20
- package/dist/api/statuses-api.d.ts +22 -22
- package/dist/api/statuses-api.js +20 -20
- package/dist/api/tasks-api.d.ts +43 -61
- package/dist/api/tasks-api.js +41 -53
- package/dist/models/create-task-request-dto.d.ts +3 -3
- package/dist/models/index.d.ts +6 -6
- package/dist/models/index.js +6 -6
- package/dist/models/task-class.d.ts +3 -3
- package/dist/models/{patch-category-request-dto.d.ts → update-category-request-dto.d.ts} +7 -7
- package/dist/models/{patch-category-response-class.d.ts → update-category-response-class.d.ts} +3 -3
- package/dist/models/{patch-status-request-dto.d.ts → update-status-request-dto.d.ts} +7 -7
- package/dist/models/{patch-status-response-class.d.ts → update-status-response-class.d.ts} +3 -3
- package/dist/models/update-task-request-dto.d.ts +72 -0
- package/dist/models/{patch-task-response-class.d.ts → update-task-response-class.d.ts} +3 -3
- package/models/create-task-request-dto.ts +3 -3
- package/models/index.ts +6 -6
- package/models/task-class.ts +3 -3
- package/models/{patch-category-request-dto.ts → update-category-request-dto.ts} +7 -7
- package/models/{patch-category-response-class.ts → update-category-response-class.ts} +3 -3
- package/models/{patch-status-request-dto.ts → update-status-request-dto.ts} +7 -7
- package/models/{patch-status-response-class.ts → update-status-response-class.ts} +3 -3
- package/models/update-task-request-dto.ts +78 -0
- package/models/{patch-task-response-class.ts → update-task-response-class.ts} +3 -3
- package/package.json +1 -1
- package/dist/models/patch-task-request-dto.d.ts +0 -108
- package/models/patch-task-request-dto.ts +0 -114
- /package/dist/models/{patch-category-request-dto.js → update-category-request-dto.js} +0 -0
- /package/dist/models/{patch-category-response-class.js → update-category-response-class.js} +0 -0
- /package/dist/models/{patch-status-request-dto.js → update-status-request-dto.js} +0 -0
- /package/dist/models/{patch-status-response-class.js → update-status-response-class.js} +0 -0
- /package/dist/models/{patch-task-request-dto.js → update-task-request-dto.js} +0 -0
- /package/dist/models/{patch-task-response-class.js → update-task-response-class.js} +0 -0
|
@@ -16,8 +16,8 @@ import { CreateStatusRequestDto } from '../models';
|
|
|
16
16
|
import { CreateStatusResponseClass } from '../models';
|
|
17
17
|
import { GetStatusResponseClass } from '../models';
|
|
18
18
|
import { ListStatusesResponseClass } from '../models';
|
|
19
|
-
import {
|
|
20
|
-
import {
|
|
19
|
+
import { UpdateStatusRequestDto } from '../models';
|
|
20
|
+
import { UpdateStatusResponseClass } from '../models';
|
|
21
21
|
/**
|
|
22
22
|
* StatusesApi - axios parameter creator
|
|
23
23
|
* @export
|
|
@@ -65,15 +65,15 @@ export declare const StatusesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
65
65
|
*/
|
|
66
66
|
listStatuses: (authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
67
67
|
/**
|
|
68
|
-
* This will
|
|
68
|
+
* This will update status.
|
|
69
69
|
* @summary Update the status
|
|
70
70
|
* @param {string} code
|
|
71
|
-
* @param {
|
|
71
|
+
* @param {UpdateStatusRequestDto} updateStatusRequestDto
|
|
72
72
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
73
73
|
* @param {*} [options] Override http request option.
|
|
74
74
|
* @throws {RequiredError}
|
|
75
75
|
*/
|
|
76
|
-
|
|
76
|
+
updateStatus: (code: string, updateStatusRequestDto: UpdateStatusRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
77
77
|
};
|
|
78
78
|
/**
|
|
79
79
|
* StatusesApi - functional programming interface
|
|
@@ -122,15 +122,15 @@ export declare const StatusesApiFp: (configuration?: Configuration) => {
|
|
|
122
122
|
*/
|
|
123
123
|
listStatuses(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListStatusesResponseClass>>;
|
|
124
124
|
/**
|
|
125
|
-
* This will
|
|
125
|
+
* This will update status.
|
|
126
126
|
* @summary Update the status
|
|
127
127
|
* @param {string} code
|
|
128
|
-
* @param {
|
|
128
|
+
* @param {UpdateStatusRequestDto} updateStatusRequestDto
|
|
129
129
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
130
130
|
* @param {*} [options] Override http request option.
|
|
131
131
|
* @throws {RequiredError}
|
|
132
132
|
*/
|
|
133
|
-
|
|
133
|
+
updateStatus(code: string, updateStatusRequestDto: UpdateStatusRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateStatusResponseClass>>;
|
|
134
134
|
};
|
|
135
135
|
/**
|
|
136
136
|
* StatusesApi - factory interface
|
|
@@ -179,15 +179,15 @@ export declare const StatusesApiFactory: (configuration?: Configuration, basePat
|
|
|
179
179
|
*/
|
|
180
180
|
listStatuses(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListStatusesResponseClass>;
|
|
181
181
|
/**
|
|
182
|
-
* This will
|
|
182
|
+
* This will update status.
|
|
183
183
|
* @summary Update the status
|
|
184
184
|
* @param {string} code
|
|
185
|
-
* @param {
|
|
185
|
+
* @param {UpdateStatusRequestDto} updateStatusRequestDto
|
|
186
186
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
187
187
|
* @param {*} [options] Override http request option.
|
|
188
188
|
* @throws {RequiredError}
|
|
189
189
|
*/
|
|
190
|
-
|
|
190
|
+
updateStatus(code: string, updateStatusRequestDto: UpdateStatusRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateStatusResponseClass>;
|
|
191
191
|
};
|
|
192
192
|
/**
|
|
193
193
|
* Request parameters for createStatus operation in StatusesApi.
|
|
@@ -296,27 +296,27 @@ export interface StatusesApiListStatusesRequest {
|
|
|
296
296
|
readonly expand?: string;
|
|
297
297
|
}
|
|
298
298
|
/**
|
|
299
|
-
* Request parameters for
|
|
299
|
+
* Request parameters for updateStatus operation in StatusesApi.
|
|
300
300
|
* @export
|
|
301
|
-
* @interface
|
|
301
|
+
* @interface StatusesApiUpdateStatusRequest
|
|
302
302
|
*/
|
|
303
|
-
export interface
|
|
303
|
+
export interface StatusesApiUpdateStatusRequest {
|
|
304
304
|
/**
|
|
305
305
|
*
|
|
306
306
|
* @type {string}
|
|
307
|
-
* @memberof
|
|
307
|
+
* @memberof StatusesApiUpdateStatus
|
|
308
308
|
*/
|
|
309
309
|
readonly code: string;
|
|
310
310
|
/**
|
|
311
311
|
*
|
|
312
|
-
* @type {
|
|
313
|
-
* @memberof
|
|
312
|
+
* @type {UpdateStatusRequestDto}
|
|
313
|
+
* @memberof StatusesApiUpdateStatus
|
|
314
314
|
*/
|
|
315
|
-
readonly
|
|
315
|
+
readonly updateStatusRequestDto: UpdateStatusRequestDto;
|
|
316
316
|
/**
|
|
317
317
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
318
318
|
* @type {string}
|
|
319
|
-
* @memberof
|
|
319
|
+
* @memberof StatusesApiUpdateStatus
|
|
320
320
|
*/
|
|
321
321
|
readonly authorization?: string;
|
|
322
322
|
}
|
|
@@ -364,12 +364,12 @@ export declare class StatusesApi extends BaseAPI {
|
|
|
364
364
|
*/
|
|
365
365
|
listStatuses(requestParameters?: StatusesApiListStatusesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListStatusesResponseClass, any, {}>>;
|
|
366
366
|
/**
|
|
367
|
-
* This will
|
|
367
|
+
* This will update status.
|
|
368
368
|
* @summary Update the status
|
|
369
|
-
* @param {
|
|
369
|
+
* @param {StatusesApiUpdateStatusRequest} requestParameters Request parameters.
|
|
370
370
|
* @param {*} [options] Override http request option.
|
|
371
371
|
* @throws {RequiredError}
|
|
372
372
|
* @memberof StatusesApi
|
|
373
373
|
*/
|
|
374
|
-
|
|
374
|
+
updateStatus(requestParameters: StatusesApiUpdateStatusRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateStatusResponseClass, any, {}>>;
|
|
375
375
|
}
|
package/dist/api/statuses-api.js
CHANGED
|
@@ -308,15 +308,15 @@ var StatusesApiAxiosParamCreator = function (configuration) {
|
|
|
308
308
|
});
|
|
309
309
|
},
|
|
310
310
|
/**
|
|
311
|
-
* This will
|
|
311
|
+
* This will update status.
|
|
312
312
|
* @summary Update the status
|
|
313
313
|
* @param {string} code
|
|
314
|
-
* @param {
|
|
314
|
+
* @param {UpdateStatusRequestDto} updateStatusRequestDto
|
|
315
315
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
316
316
|
* @param {*} [options] Override http request option.
|
|
317
317
|
* @throws {RequiredError}
|
|
318
318
|
*/
|
|
319
|
-
|
|
319
|
+
updateStatus: function (code, updateStatusRequestDto, authorization, options) {
|
|
320
320
|
if (options === void 0) { options = {}; }
|
|
321
321
|
return __awaiter(_this, void 0, void 0, function () {
|
|
322
322
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -324,9 +324,9 @@ var StatusesApiAxiosParamCreator = function (configuration) {
|
|
|
324
324
|
switch (_a.label) {
|
|
325
325
|
case 0:
|
|
326
326
|
// verify required parameter 'code' is not null or undefined
|
|
327
|
-
(0, common_1.assertParamExists)('
|
|
328
|
-
// verify required parameter '
|
|
329
|
-
(0, common_1.assertParamExists)('
|
|
327
|
+
(0, common_1.assertParamExists)('updateStatus', 'code', code);
|
|
328
|
+
// verify required parameter 'updateStatusRequestDto' is not null or undefined
|
|
329
|
+
(0, common_1.assertParamExists)('updateStatus', 'updateStatusRequestDto', updateStatusRequestDto);
|
|
330
330
|
localVarPath = "/taskservice/v1/statuses/{code}"
|
|
331
331
|
.replace("{".concat("code", "}"), encodeURIComponent(String(code)));
|
|
332
332
|
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -334,7 +334,7 @@ var StatusesApiAxiosParamCreator = function (configuration) {
|
|
|
334
334
|
baseOptions = configuration.baseOptions;
|
|
335
335
|
baseAccessToken = configuration.accessToken;
|
|
336
336
|
}
|
|
337
|
-
localVarRequestOptions = __assign(__assign({ method: '
|
|
337
|
+
localVarRequestOptions = __assign(__assign({ method: 'PUT' }, baseOptions), options);
|
|
338
338
|
localVarHeaderParameter = {};
|
|
339
339
|
localVarQueryParameter = {};
|
|
340
340
|
// authentication bearer required
|
|
@@ -351,7 +351,7 @@ var StatusesApiAxiosParamCreator = function (configuration) {
|
|
|
351
351
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
352
352
|
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
353
353
|
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
354
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(
|
|
354
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(updateStatusRequestDto, localVarRequestOptions, configuration);
|
|
355
355
|
return [2 /*return*/, {
|
|
356
356
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
357
357
|
options: localVarRequestOptions,
|
|
@@ -460,20 +460,20 @@ var StatusesApiFp = function (configuration) {
|
|
|
460
460
|
});
|
|
461
461
|
},
|
|
462
462
|
/**
|
|
463
|
-
* This will
|
|
463
|
+
* This will update status.
|
|
464
464
|
* @summary Update the status
|
|
465
465
|
* @param {string} code
|
|
466
|
-
* @param {
|
|
466
|
+
* @param {UpdateStatusRequestDto} updateStatusRequestDto
|
|
467
467
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
468
468
|
* @param {*} [options] Override http request option.
|
|
469
469
|
* @throws {RequiredError}
|
|
470
470
|
*/
|
|
471
|
-
|
|
471
|
+
updateStatus: function (code, updateStatusRequestDto, authorization, options) {
|
|
472
472
|
return __awaiter(this, void 0, void 0, function () {
|
|
473
473
|
var localVarAxiosArgs;
|
|
474
474
|
return __generator(this, function (_a) {
|
|
475
475
|
switch (_a.label) {
|
|
476
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.
|
|
476
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.updateStatus(code, updateStatusRequestDto, authorization, options)];
|
|
477
477
|
case 1:
|
|
478
478
|
localVarAxiosArgs = _a.sent();
|
|
479
479
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -541,16 +541,16 @@ var StatusesApiFactory = function (configuration, basePath, axios) {
|
|
|
541
541
|
return localVarFp.listStatuses(authorization, filter, filters, search, order, expand, options).then(function (request) { return request(axios, basePath); });
|
|
542
542
|
},
|
|
543
543
|
/**
|
|
544
|
-
* This will
|
|
544
|
+
* This will update status.
|
|
545
545
|
* @summary Update the status
|
|
546
546
|
* @param {string} code
|
|
547
|
-
* @param {
|
|
547
|
+
* @param {UpdateStatusRequestDto} updateStatusRequestDto
|
|
548
548
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
549
549
|
* @param {*} [options] Override http request option.
|
|
550
550
|
* @throws {RequiredError}
|
|
551
551
|
*/
|
|
552
|
-
|
|
553
|
-
return localVarFp.
|
|
552
|
+
updateStatus: function (code, updateStatusRequestDto, authorization, options) {
|
|
553
|
+
return localVarFp.updateStatus(code, updateStatusRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
554
554
|
},
|
|
555
555
|
};
|
|
556
556
|
};
|
|
@@ -616,16 +616,16 @@ var StatusesApi = /** @class */ (function (_super) {
|
|
|
616
616
|
return (0, exports.StatusesApiFp)(this.configuration).listStatuses(requestParameters.authorization, requestParameters.filter, requestParameters.filters, requestParameters.search, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
617
617
|
};
|
|
618
618
|
/**
|
|
619
|
-
* This will
|
|
619
|
+
* This will update status.
|
|
620
620
|
* @summary Update the status
|
|
621
|
-
* @param {
|
|
621
|
+
* @param {StatusesApiUpdateStatusRequest} requestParameters Request parameters.
|
|
622
622
|
* @param {*} [options] Override http request option.
|
|
623
623
|
* @throws {RequiredError}
|
|
624
624
|
* @memberof StatusesApi
|
|
625
625
|
*/
|
|
626
|
-
StatusesApi.prototype.
|
|
626
|
+
StatusesApi.prototype.updateStatus = function (requestParameters, options) {
|
|
627
627
|
var _this = this;
|
|
628
|
-
return (0, exports.StatusesApiFp)(this.configuration).
|
|
628
|
+
return (0, exports.StatusesApiFp)(this.configuration).updateStatus(requestParameters.code, requestParameters.updateStatusRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
629
629
|
};
|
|
630
630
|
return StatusesApi;
|
|
631
631
|
}(base_1.BaseAPI));
|
package/dist/api/tasks-api.d.ts
CHANGED
|
@@ -16,8 +16,8 @@ import { CreateTaskRequestDto } from '../models';
|
|
|
16
16
|
import { CreateTaskResponseClass } from '../models';
|
|
17
17
|
import { GetTaskResponseClass } from '../models';
|
|
18
18
|
import { ListTasksResponseClass } from '../models';
|
|
19
|
-
import {
|
|
20
|
-
import {
|
|
19
|
+
import { UpdateTaskRequestDto } from '../models';
|
|
20
|
+
import { UpdateTaskResponseClass } from '../models';
|
|
21
21
|
/**
|
|
22
22
|
* TasksApi - axios parameter creator
|
|
23
23
|
* @export
|
|
@@ -55,27 +55,25 @@ export declare const TasksApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
55
55
|
* Retrieves a list of tasks.
|
|
56
56
|
* @summary List tasks
|
|
57
57
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
58
|
-
* @param {
|
|
59
|
-
* @param {string} [
|
|
60
|
-
* @param {string} [
|
|
61
|
-
* @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>
|
|
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, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
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, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</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, subject, description, assignee, reporter</i>
|
|
62
61
|
* @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>
|
|
63
|
-
* @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:
|
|
64
|
-
* @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, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
|
|
62
|
+
* @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>
|
|
65
63
|
* @param {*} [options] Override http request option.
|
|
66
64
|
* @throws {RequiredError}
|
|
67
65
|
*/
|
|
68
|
-
listTasks: (authorization?: string,
|
|
66
|
+
listTasks: (authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
69
67
|
/**
|
|
70
|
-
* This will
|
|
68
|
+
* This will update a task by code.
|
|
71
69
|
* @summary Update the task
|
|
72
70
|
* @param {string} code
|
|
73
|
-
* @param {
|
|
71
|
+
* @param {UpdateTaskRequestDto} updateTaskRequestDto
|
|
74
72
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
75
73
|
* @param {*} [options] Override http request option.
|
|
76
74
|
* @throws {RequiredError}
|
|
77
75
|
*/
|
|
78
|
-
|
|
76
|
+
updateTask: (code: string, updateTaskRequestDto: UpdateTaskRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
79
77
|
};
|
|
80
78
|
/**
|
|
81
79
|
* TasksApi - functional programming interface
|
|
@@ -114,27 +112,25 @@ export declare const TasksApiFp: (configuration?: Configuration) => {
|
|
|
114
112
|
* Retrieves a list of tasks.
|
|
115
113
|
* @summary List tasks
|
|
116
114
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
117
|
-
* @param {
|
|
118
|
-
* @param {string} [
|
|
119
|
-
* @param {string} [
|
|
120
|
-
* @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>
|
|
115
|
+
* @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>
|
|
116
|
+
* @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>
|
|
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, subject, description, assignee, reporter</i>
|
|
121
118
|
* @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>
|
|
122
|
-
* @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:
|
|
123
|
-
* @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, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
|
|
119
|
+
* @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>
|
|
124
120
|
* @param {*} [options] Override http request option.
|
|
125
121
|
* @throws {RequiredError}
|
|
126
122
|
*/
|
|
127
|
-
listTasks(authorization?: string,
|
|
123
|
+
listTasks(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTasksResponseClass>>;
|
|
128
124
|
/**
|
|
129
|
-
* This will
|
|
125
|
+
* This will update a task by code.
|
|
130
126
|
* @summary Update the task
|
|
131
127
|
* @param {string} code
|
|
132
|
-
* @param {
|
|
128
|
+
* @param {UpdateTaskRequestDto} updateTaskRequestDto
|
|
133
129
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
134
130
|
* @param {*} [options] Override http request option.
|
|
135
131
|
* @throws {RequiredError}
|
|
136
132
|
*/
|
|
137
|
-
|
|
133
|
+
updateTask(code: string, updateTaskRequestDto: UpdateTaskRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateTaskResponseClass>>;
|
|
138
134
|
};
|
|
139
135
|
/**
|
|
140
136
|
* TasksApi - factory interface
|
|
@@ -173,27 +169,25 @@ export declare const TasksApiFactory: (configuration?: Configuration, basePath?:
|
|
|
173
169
|
* Retrieves a list of tasks.
|
|
174
170
|
* @summary List tasks
|
|
175
171
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
176
|
-
* @param {
|
|
177
|
-
* @param {string} [
|
|
178
|
-
* @param {string} [
|
|
179
|
-
* @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>
|
|
172
|
+
* @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>
|
|
173
|
+
* @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>
|
|
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, subject, description, assignee, reporter</i>
|
|
180
175
|
* @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>
|
|
181
|
-
* @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:
|
|
182
|
-
* @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, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
|
|
176
|
+
* @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>
|
|
183
177
|
* @param {*} [options] Override http request option.
|
|
184
178
|
* @throws {RequiredError}
|
|
185
179
|
*/
|
|
186
|
-
listTasks(authorization?: string,
|
|
180
|
+
listTasks(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListTasksResponseClass>;
|
|
187
181
|
/**
|
|
188
|
-
* This will
|
|
182
|
+
* This will update a task by code.
|
|
189
183
|
* @summary Update the task
|
|
190
184
|
* @param {string} code
|
|
191
|
-
* @param {
|
|
185
|
+
* @param {UpdateTaskRequestDto} updateTaskRequestDto
|
|
192
186
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
193
187
|
* @param {*} [options] Override http request option.
|
|
194
188
|
* @throws {RequiredError}
|
|
195
189
|
*/
|
|
196
|
-
|
|
190
|
+
updateTask(code: string, updateTaskRequestDto: UpdateTaskRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateTaskResponseClass>;
|
|
197
191
|
};
|
|
198
192
|
/**
|
|
199
193
|
* Request parameters for createTask operation in TasksApi.
|
|
@@ -271,25 +265,19 @@ export interface TasksApiListTasksRequest {
|
|
|
271
265
|
*/
|
|
272
266
|
readonly authorization?: string;
|
|
273
267
|
/**
|
|
274
|
-
*
|
|
275
|
-
* @type {number}
|
|
276
|
-
* @memberof TasksApiListTasks
|
|
277
|
-
*/
|
|
278
|
-
readonly pageSize?: number;
|
|
279
|
-
/**
|
|
280
|
-
* 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.
|
|
268
|
+
* 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>
|
|
281
269
|
* @type {string}
|
|
282
270
|
* @memberof TasksApiListTasks
|
|
283
271
|
*/
|
|
284
|
-
readonly
|
|
272
|
+
readonly filter?: string;
|
|
285
273
|
/**
|
|
286
|
-
*
|
|
274
|
+
* 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>
|
|
287
275
|
* @type {string}
|
|
288
276
|
* @memberof TasksApiListTasks
|
|
289
277
|
*/
|
|
290
|
-
readonly
|
|
278
|
+
readonly filters?: string;
|
|
291
279
|
/**
|
|
292
|
-
* 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>
|
|
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, subject, description, assignee, reporter</i>
|
|
293
281
|
* @type {string}
|
|
294
282
|
* @memberof TasksApiListTasks
|
|
295
283
|
*/
|
|
@@ -301,40 +289,34 @@ export interface TasksApiListTasksRequest {
|
|
|
301
289
|
*/
|
|
302
290
|
readonly order?: string;
|
|
303
291
|
/**
|
|
304
|
-
* 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:
|
|
292
|
+
* 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>
|
|
305
293
|
* @type {string}
|
|
306
294
|
* @memberof TasksApiListTasks
|
|
307
295
|
*/
|
|
308
296
|
readonly expand?: string;
|
|
309
|
-
/**
|
|
310
|
-
* 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, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
|
|
311
|
-
* @type {string}
|
|
312
|
-
* @memberof TasksApiListTasks
|
|
313
|
-
*/
|
|
314
|
-
readonly filters?: string;
|
|
315
297
|
}
|
|
316
298
|
/**
|
|
317
|
-
* Request parameters for
|
|
299
|
+
* Request parameters for updateTask operation in TasksApi.
|
|
318
300
|
* @export
|
|
319
|
-
* @interface
|
|
301
|
+
* @interface TasksApiUpdateTaskRequest
|
|
320
302
|
*/
|
|
321
|
-
export interface
|
|
303
|
+
export interface TasksApiUpdateTaskRequest {
|
|
322
304
|
/**
|
|
323
305
|
*
|
|
324
306
|
* @type {string}
|
|
325
|
-
* @memberof
|
|
307
|
+
* @memberof TasksApiUpdateTask
|
|
326
308
|
*/
|
|
327
309
|
readonly code: string;
|
|
328
310
|
/**
|
|
329
311
|
*
|
|
330
|
-
* @type {
|
|
331
|
-
* @memberof
|
|
312
|
+
* @type {UpdateTaskRequestDto}
|
|
313
|
+
* @memberof TasksApiUpdateTask
|
|
332
314
|
*/
|
|
333
|
-
readonly
|
|
315
|
+
readonly updateTaskRequestDto: UpdateTaskRequestDto;
|
|
334
316
|
/**
|
|
335
317
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
336
318
|
* @type {string}
|
|
337
|
-
* @memberof
|
|
319
|
+
* @memberof TasksApiUpdateTask
|
|
338
320
|
*/
|
|
339
321
|
readonly authorization?: string;
|
|
340
322
|
}
|
|
@@ -382,12 +364,12 @@ export declare class TasksApi extends BaseAPI {
|
|
|
382
364
|
*/
|
|
383
365
|
listTasks(requestParameters?: TasksApiListTasksRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTasksResponseClass, any, {}>>;
|
|
384
366
|
/**
|
|
385
|
-
* This will
|
|
367
|
+
* This will update a task by code.
|
|
386
368
|
* @summary Update the task
|
|
387
|
-
* @param {
|
|
369
|
+
* @param {TasksApiUpdateTaskRequest} requestParameters Request parameters.
|
|
388
370
|
* @param {*} [options] Override http request option.
|
|
389
371
|
* @throws {RequiredError}
|
|
390
372
|
* @memberof TasksApi
|
|
391
373
|
*/
|
|
392
|
-
|
|
374
|
+
updateTask(requestParameters: TasksApiUpdateTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateTaskResponseClass, any, {}>>;
|
|
393
375
|
}
|