@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/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 { PatchTaskRequestDto } from '../models';
|
|
20
|
+
import { PatchTaskResponseClass } from '../models';
|
|
21
21
|
/**
|
|
22
22
|
* TasksApi - axios parameter creator
|
|
23
23
|
* @export
|
|
@@ -55,25 +55,27 @@ 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 {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
59
|
+
* @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.
|
|
58
60
|
* @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} [
|
|
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>
|
|
61
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
61
62
|
* @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>
|
|
62
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: category, status<i>
|
|
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, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
63
65
|
* @param {*} [options] Override http request option.
|
|
64
66
|
* @throws {RequiredError}
|
|
65
67
|
*/
|
|
66
|
-
listTasks: (authorization?: string,
|
|
68
|
+
listTasks: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
67
69
|
/**
|
|
68
|
-
* This will update a task by code.
|
|
70
|
+
* This will partially update a task by code with the provided fields.
|
|
69
71
|
* @summary Update the task
|
|
70
72
|
* @param {string} code
|
|
71
|
-
* @param {
|
|
73
|
+
* @param {PatchTaskRequestDto} patchTaskRequestDto
|
|
72
74
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
73
75
|
* @param {*} [options] Override http request option.
|
|
74
76
|
* @throws {RequiredError}
|
|
75
77
|
*/
|
|
76
|
-
|
|
78
|
+
patchTask: (code: string, patchTaskRequestDto: PatchTaskRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
77
79
|
};
|
|
78
80
|
/**
|
|
79
81
|
* TasksApi - functional programming interface
|
|
@@ -112,25 +114,27 @@ export declare const TasksApiFp: (configuration?: Configuration) => {
|
|
|
112
114
|
* Retrieves a list of tasks.
|
|
113
115
|
* @summary List tasks
|
|
114
116
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
117
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
118
|
+
* @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.
|
|
115
119
|
* @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} [
|
|
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>
|
|
120
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
118
121
|
* @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>
|
|
119
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: category, status<i>
|
|
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, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
120
124
|
* @param {*} [options] Override http request option.
|
|
121
125
|
* @throws {RequiredError}
|
|
122
126
|
*/
|
|
123
|
-
listTasks(authorization?: string,
|
|
127
|
+
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>>;
|
|
124
128
|
/**
|
|
125
|
-
* This will update a task by code.
|
|
129
|
+
* This will partially update a task by code with the provided fields.
|
|
126
130
|
* @summary Update the task
|
|
127
131
|
* @param {string} code
|
|
128
|
-
* @param {
|
|
132
|
+
* @param {PatchTaskRequestDto} patchTaskRequestDto
|
|
129
133
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
130
134
|
* @param {*} [options] Override http request option.
|
|
131
135
|
* @throws {RequiredError}
|
|
132
136
|
*/
|
|
133
|
-
|
|
137
|
+
patchTask(code: string, patchTaskRequestDto: PatchTaskRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PatchTaskResponseClass>>;
|
|
134
138
|
};
|
|
135
139
|
/**
|
|
136
140
|
* TasksApi - factory interface
|
|
@@ -169,25 +173,27 @@ export declare const TasksApiFactory: (configuration?: Configuration, basePath?:
|
|
|
169
173
|
* Retrieves a list of tasks.
|
|
170
174
|
* @summary List tasks
|
|
171
175
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
176
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
177
|
+
* @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.
|
|
172
178
|
* @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} [
|
|
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>
|
|
179
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
175
180
|
* @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>
|
|
176
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: category, status<i>
|
|
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, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
177
183
|
* @param {*} [options] Override http request option.
|
|
178
184
|
* @throws {RequiredError}
|
|
179
185
|
*/
|
|
180
|
-
listTasks(authorization?: string,
|
|
186
|
+
listTasks(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListTasksResponseClass>;
|
|
181
187
|
/**
|
|
182
|
-
* This will update a task by code.
|
|
188
|
+
* This will partially update a task by code with the provided fields.
|
|
183
189
|
* @summary Update the task
|
|
184
190
|
* @param {string} code
|
|
185
|
-
* @param {
|
|
191
|
+
* @param {PatchTaskRequestDto} patchTaskRequestDto
|
|
186
192
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
187
193
|
* @param {*} [options] Override http request option.
|
|
188
194
|
* @throws {RequiredError}
|
|
189
195
|
*/
|
|
190
|
-
|
|
196
|
+
patchTask(code: string, patchTaskRequestDto: PatchTaskRequestDto, authorization?: string, options?: any): AxiosPromise<PatchTaskResponseClass>;
|
|
191
197
|
};
|
|
192
198
|
/**
|
|
193
199
|
* Request parameters for createTask operation in TasksApi.
|
|
@@ -265,19 +271,25 @@ export interface TasksApiListTasksRequest {
|
|
|
265
271
|
*/
|
|
266
272
|
readonly authorization?: string;
|
|
267
273
|
/**
|
|
268
|
-
*
|
|
274
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
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.
|
|
269
281
|
* @type {string}
|
|
270
282
|
* @memberof TasksApiListTasks
|
|
271
283
|
*/
|
|
272
|
-
readonly
|
|
284
|
+
readonly pageToken?: string;
|
|
273
285
|
/**
|
|
274
|
-
*
|
|
286
|
+
* 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>
|
|
275
287
|
* @type {string}
|
|
276
288
|
* @memberof TasksApiListTasks
|
|
277
289
|
*/
|
|
278
|
-
readonly
|
|
290
|
+
readonly filter?: string;
|
|
279
291
|
/**
|
|
280
|
-
*
|
|
292
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
281
293
|
* @type {string}
|
|
282
294
|
* @memberof TasksApiListTasks
|
|
283
295
|
*/
|
|
@@ -294,29 +306,35 @@ export interface TasksApiListTasksRequest {
|
|
|
294
306
|
* @memberof TasksApiListTasks
|
|
295
307
|
*/
|
|
296
308
|
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, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
311
|
+
* @type {string}
|
|
312
|
+
* @memberof TasksApiListTasks
|
|
313
|
+
*/
|
|
314
|
+
readonly filters?: string;
|
|
297
315
|
}
|
|
298
316
|
/**
|
|
299
|
-
* Request parameters for
|
|
317
|
+
* Request parameters for patchTask operation in TasksApi.
|
|
300
318
|
* @export
|
|
301
|
-
* @interface
|
|
319
|
+
* @interface TasksApiPatchTaskRequest
|
|
302
320
|
*/
|
|
303
|
-
export interface
|
|
321
|
+
export interface TasksApiPatchTaskRequest {
|
|
304
322
|
/**
|
|
305
323
|
*
|
|
306
324
|
* @type {string}
|
|
307
|
-
* @memberof
|
|
325
|
+
* @memberof TasksApiPatchTask
|
|
308
326
|
*/
|
|
309
327
|
readonly code: string;
|
|
310
328
|
/**
|
|
311
329
|
*
|
|
312
|
-
* @type {
|
|
313
|
-
* @memberof
|
|
330
|
+
* @type {PatchTaskRequestDto}
|
|
331
|
+
* @memberof TasksApiPatchTask
|
|
314
332
|
*/
|
|
315
|
-
readonly
|
|
333
|
+
readonly patchTaskRequestDto: PatchTaskRequestDto;
|
|
316
334
|
/**
|
|
317
335
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
318
336
|
* @type {string}
|
|
319
|
-
* @memberof
|
|
337
|
+
* @memberof TasksApiPatchTask
|
|
320
338
|
*/
|
|
321
339
|
readonly authorization?: string;
|
|
322
340
|
}
|
|
@@ -364,12 +382,12 @@ export declare class TasksApi extends BaseAPI {
|
|
|
364
382
|
*/
|
|
365
383
|
listTasks(requestParameters?: TasksApiListTasksRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTasksResponseClass, any, {}>>;
|
|
366
384
|
/**
|
|
367
|
-
* This will update a task by code.
|
|
385
|
+
* This will partially update a task by code with the provided fields.
|
|
368
386
|
* @summary Update the task
|
|
369
|
-
* @param {
|
|
387
|
+
* @param {TasksApiPatchTaskRequest} requestParameters Request parameters.
|
|
370
388
|
* @param {*} [options] Override http request option.
|
|
371
389
|
* @throws {RequiredError}
|
|
372
390
|
* @memberof TasksApi
|
|
373
391
|
*/
|
|
374
|
-
|
|
392
|
+
patchTask(requestParameters: TasksApiPatchTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PatchTaskResponseClass, any, {}>>;
|
|
375
393
|
}
|
package/dist/api/tasks-api.js
CHANGED
|
@@ -251,15 +251,17 @@ var TasksApiAxiosParamCreator = function (configuration) {
|
|
|
251
251
|
* Retrieves a list of tasks.
|
|
252
252
|
* @summary List tasks
|
|
253
253
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
254
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
255
|
+
* @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.
|
|
254
256
|
* @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>
|
|
255
|
-
* @param {string} [
|
|
256
|
-
* @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>
|
|
257
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
257
258
|
* @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>
|
|
258
259
|
* @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>
|
|
260
|
+
* @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>
|
|
259
261
|
* @param {*} [options] Override http request option.
|
|
260
262
|
* @throws {RequiredError}
|
|
261
263
|
*/
|
|
262
|
-
listTasks: function (authorization,
|
|
264
|
+
listTasks: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
263
265
|
if (options === void 0) { options = {}; }
|
|
264
266
|
return __awaiter(_this, void 0, void 0, function () {
|
|
265
267
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -282,12 +284,15 @@ var TasksApiAxiosParamCreator = function (configuration) {
|
|
|
282
284
|
// authentication bearer required
|
|
283
285
|
// http bearer authentication required
|
|
284
286
|
_a.sent();
|
|
287
|
+
if (pageSize !== undefined) {
|
|
288
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
289
|
+
}
|
|
290
|
+
if (pageToken !== undefined) {
|
|
291
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
292
|
+
}
|
|
285
293
|
if (filter !== undefined) {
|
|
286
294
|
localVarQueryParameter['filter'] = filter;
|
|
287
295
|
}
|
|
288
|
-
if (filters !== undefined) {
|
|
289
|
-
localVarQueryParameter['filters'] = filters;
|
|
290
|
-
}
|
|
291
296
|
if (search !== undefined) {
|
|
292
297
|
localVarQueryParameter['search'] = search;
|
|
293
298
|
}
|
|
@@ -297,6 +302,9 @@ var TasksApiAxiosParamCreator = function (configuration) {
|
|
|
297
302
|
if (expand !== undefined) {
|
|
298
303
|
localVarQueryParameter['expand'] = expand;
|
|
299
304
|
}
|
|
305
|
+
if (filters !== undefined) {
|
|
306
|
+
localVarQueryParameter['filters'] = filters;
|
|
307
|
+
}
|
|
300
308
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
301
309
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
302
310
|
}
|
|
@@ -312,15 +320,15 @@ var TasksApiAxiosParamCreator = function (configuration) {
|
|
|
312
320
|
});
|
|
313
321
|
},
|
|
314
322
|
/**
|
|
315
|
-
* This will update a task by code.
|
|
323
|
+
* This will partially update a task by code with the provided fields.
|
|
316
324
|
* @summary Update the task
|
|
317
325
|
* @param {string} code
|
|
318
|
-
* @param {
|
|
326
|
+
* @param {PatchTaskRequestDto} patchTaskRequestDto
|
|
319
327
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
320
328
|
* @param {*} [options] Override http request option.
|
|
321
329
|
* @throws {RequiredError}
|
|
322
330
|
*/
|
|
323
|
-
|
|
331
|
+
patchTask: function (code, patchTaskRequestDto, authorization, options) {
|
|
324
332
|
if (options === void 0) { options = {}; }
|
|
325
333
|
return __awaiter(_this, void 0, void 0, function () {
|
|
326
334
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -328,9 +336,9 @@ var TasksApiAxiosParamCreator = function (configuration) {
|
|
|
328
336
|
switch (_a.label) {
|
|
329
337
|
case 0:
|
|
330
338
|
// verify required parameter 'code' is not null or undefined
|
|
331
|
-
(0, common_1.assertParamExists)('
|
|
332
|
-
// verify required parameter '
|
|
333
|
-
(0, common_1.assertParamExists)('
|
|
339
|
+
(0, common_1.assertParamExists)('patchTask', 'code', code);
|
|
340
|
+
// verify required parameter 'patchTaskRequestDto' is not null or undefined
|
|
341
|
+
(0, common_1.assertParamExists)('patchTask', 'patchTaskRequestDto', patchTaskRequestDto);
|
|
334
342
|
localVarPath = "/taskservice/v1/tasks/{code}"
|
|
335
343
|
.replace("{".concat("code", "}"), encodeURIComponent(String(code)));
|
|
336
344
|
localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -338,7 +346,7 @@ var TasksApiAxiosParamCreator = function (configuration) {
|
|
|
338
346
|
baseOptions = configuration.baseOptions;
|
|
339
347
|
baseAccessToken = configuration.accessToken;
|
|
340
348
|
}
|
|
341
|
-
localVarRequestOptions = __assign(__assign({ method: '
|
|
349
|
+
localVarRequestOptions = __assign(__assign({ method: 'PATCH' }, baseOptions), options);
|
|
342
350
|
localVarHeaderParameter = {};
|
|
343
351
|
localVarQueryParameter = {};
|
|
344
352
|
// authentication bearer required
|
|
@@ -355,7 +363,7 @@ var TasksApiAxiosParamCreator = function (configuration) {
|
|
|
355
363
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
356
364
|
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
357
365
|
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
358
|
-
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(
|
|
366
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(patchTaskRequestDto, localVarRequestOptions, configuration);
|
|
359
367
|
return [2 /*return*/, {
|
|
360
368
|
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
361
369
|
options: localVarRequestOptions,
|
|
@@ -442,20 +450,22 @@ var TasksApiFp = function (configuration) {
|
|
|
442
450
|
* Retrieves a list of tasks.
|
|
443
451
|
* @summary List tasks
|
|
444
452
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
453
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
454
|
+
* @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.
|
|
445
455
|
* @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>
|
|
446
|
-
* @param {string} [
|
|
447
|
-
* @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>
|
|
456
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
448
457
|
* @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>
|
|
449
458
|
* @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>
|
|
459
|
+
* @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>
|
|
450
460
|
* @param {*} [options] Override http request option.
|
|
451
461
|
* @throws {RequiredError}
|
|
452
462
|
*/
|
|
453
|
-
listTasks: function (authorization,
|
|
463
|
+
listTasks: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
454
464
|
return __awaiter(this, void 0, void 0, function () {
|
|
455
465
|
var localVarAxiosArgs;
|
|
456
466
|
return __generator(this, function (_a) {
|
|
457
467
|
switch (_a.label) {
|
|
458
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listTasks(authorization,
|
|
468
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listTasks(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
|
|
459
469
|
case 1:
|
|
460
470
|
localVarAxiosArgs = _a.sent();
|
|
461
471
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -464,20 +474,20 @@ var TasksApiFp = function (configuration) {
|
|
|
464
474
|
});
|
|
465
475
|
},
|
|
466
476
|
/**
|
|
467
|
-
* This will update a task by code.
|
|
477
|
+
* This will partially update a task by code with the provided fields.
|
|
468
478
|
* @summary Update the task
|
|
469
479
|
* @param {string} code
|
|
470
|
-
* @param {
|
|
480
|
+
* @param {PatchTaskRequestDto} patchTaskRequestDto
|
|
471
481
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
472
482
|
* @param {*} [options] Override http request option.
|
|
473
483
|
* @throws {RequiredError}
|
|
474
484
|
*/
|
|
475
|
-
|
|
485
|
+
patchTask: function (code, patchTaskRequestDto, authorization, options) {
|
|
476
486
|
return __awaiter(this, void 0, void 0, function () {
|
|
477
487
|
var localVarAxiosArgs;
|
|
478
488
|
return __generator(this, function (_a) {
|
|
479
489
|
switch (_a.label) {
|
|
480
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.
|
|
490
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.patchTask(code, patchTaskRequestDto, authorization, options)];
|
|
481
491
|
case 1:
|
|
482
492
|
localVarAxiosArgs = _a.sent();
|
|
483
493
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -533,28 +543,30 @@ var TasksApiFactory = function (configuration, basePath, axios) {
|
|
|
533
543
|
* Retrieves a list of tasks.
|
|
534
544
|
* @summary List tasks
|
|
535
545
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
546
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
547
|
+
* @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.
|
|
536
548
|
* @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>
|
|
537
|
-
* @param {string} [
|
|
538
|
-
* @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>
|
|
549
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
539
550
|
* @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>
|
|
540
551
|
* @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>
|
|
552
|
+
* @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>
|
|
541
553
|
* @param {*} [options] Override http request option.
|
|
542
554
|
* @throws {RequiredError}
|
|
543
555
|
*/
|
|
544
|
-
listTasks: function (authorization,
|
|
545
|
-
return localVarFp.listTasks(authorization,
|
|
556
|
+
listTasks: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
557
|
+
return localVarFp.listTasks(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
546
558
|
},
|
|
547
559
|
/**
|
|
548
|
-
* This will update a task by code.
|
|
560
|
+
* This will partially update a task by code with the provided fields.
|
|
549
561
|
* @summary Update the task
|
|
550
562
|
* @param {string} code
|
|
551
|
-
* @param {
|
|
563
|
+
* @param {PatchTaskRequestDto} patchTaskRequestDto
|
|
552
564
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
553
565
|
* @param {*} [options] Override http request option.
|
|
554
566
|
* @throws {RequiredError}
|
|
555
567
|
*/
|
|
556
|
-
|
|
557
|
-
return localVarFp.
|
|
568
|
+
patchTask: function (code, patchTaskRequestDto, authorization, options) {
|
|
569
|
+
return localVarFp.patchTask(code, patchTaskRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
558
570
|
},
|
|
559
571
|
};
|
|
560
572
|
};
|
|
@@ -617,19 +629,19 @@ var TasksApi = /** @class */ (function (_super) {
|
|
|
617
629
|
TasksApi.prototype.listTasks = function (requestParameters, options) {
|
|
618
630
|
var _this = this;
|
|
619
631
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
620
|
-
return (0, exports.TasksApiFp)(this.configuration).listTasks(requestParameters.authorization, requestParameters.
|
|
632
|
+
return (0, exports.TasksApiFp)(this.configuration).listTasks(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
621
633
|
};
|
|
622
634
|
/**
|
|
623
|
-
* This will update a task by code.
|
|
635
|
+
* This will partially update a task by code with the provided fields.
|
|
624
636
|
* @summary Update the task
|
|
625
|
-
* @param {
|
|
637
|
+
* @param {TasksApiPatchTaskRequest} requestParameters Request parameters.
|
|
626
638
|
* @param {*} [options] Override http request option.
|
|
627
639
|
* @throws {RequiredError}
|
|
628
640
|
* @memberof TasksApi
|
|
629
641
|
*/
|
|
630
|
-
TasksApi.prototype.
|
|
642
|
+
TasksApi.prototype.patchTask = function (requestParameters, options) {
|
|
631
643
|
var _this = this;
|
|
632
|
-
return (0, exports.TasksApiFp)(this.configuration).
|
|
644
|
+
return (0, exports.TasksApiFp)(this.configuration).patchTask(requestParameters.code, requestParameters.patchTaskRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
633
645
|
};
|
|
634
646
|
return TasksApi;
|
|
635
647
|
}(base_1.BaseAPI));
|
package/dist/models/index.d.ts
CHANGED
|
@@ -18,11 +18,11 @@ export * from './inline-response503';
|
|
|
18
18
|
export * from './list-categories-response-class';
|
|
19
19
|
export * from './list-statuses-response-class';
|
|
20
20
|
export * from './list-tasks-response-class';
|
|
21
|
+
export * from './patch-category-request-dto';
|
|
22
|
+
export * from './patch-category-response-class';
|
|
23
|
+
export * from './patch-status-request-dto';
|
|
24
|
+
export * from './patch-status-response-class';
|
|
25
|
+
export * from './patch-task-request-dto';
|
|
26
|
+
export * from './patch-task-response-class';
|
|
21
27
|
export * from './status-class';
|
|
22
28
|
export * from './task-class';
|
|
23
|
-
export * from './update-category-request-dto';
|
|
24
|
-
export * from './update-category-response-class';
|
|
25
|
-
export * from './update-status-request-dto';
|
|
26
|
-
export * from './update-status-response-class';
|
|
27
|
-
export * from './update-task-request-dto';
|
|
28
|
-
export * from './update-task-response-class';
|
package/dist/models/index.js
CHANGED
|
@@ -34,11 +34,11 @@ __exportStar(require("./inline-response503"), exports);
|
|
|
34
34
|
__exportStar(require("./list-categories-response-class"), exports);
|
|
35
35
|
__exportStar(require("./list-statuses-response-class"), exports);
|
|
36
36
|
__exportStar(require("./list-tasks-response-class"), exports);
|
|
37
|
+
__exportStar(require("./patch-category-request-dto"), exports);
|
|
38
|
+
__exportStar(require("./patch-category-response-class"), exports);
|
|
39
|
+
__exportStar(require("./patch-status-request-dto"), exports);
|
|
40
|
+
__exportStar(require("./patch-status-response-class"), exports);
|
|
41
|
+
__exportStar(require("./patch-task-request-dto"), exports);
|
|
42
|
+
__exportStar(require("./patch-task-response-class"), exports);
|
|
37
43
|
__exportStar(require("./status-class"), exports);
|
|
38
44
|
__exportStar(require("./task-class"), exports);
|
|
39
|
-
__exportStar(require("./update-category-request-dto"), exports);
|
|
40
|
-
__exportStar(require("./update-category-response-class"), exports);
|
|
41
|
-
__exportStar(require("./update-status-request-dto"), exports);
|
|
42
|
-
__exportStar(require("./update-status-response-class"), exports);
|
|
43
|
-
__exportStar(require("./update-task-request-dto"), exports);
|
|
44
|
-
__exportStar(require("./update-task-response-class"), exports);
|
|
@@ -12,25 +12,25 @@
|
|
|
12
12
|
/**
|
|
13
13
|
*
|
|
14
14
|
* @export
|
|
15
|
-
* @interface
|
|
15
|
+
* @interface PatchCategoryRequestDto
|
|
16
16
|
*/
|
|
17
|
-
export interface
|
|
17
|
+
export interface PatchCategoryRequestDto {
|
|
18
18
|
/**
|
|
19
19
|
* Category code: unique identifier of the category
|
|
20
20
|
* @type {string}
|
|
21
|
-
* @memberof
|
|
21
|
+
* @memberof PatchCategoryRequestDto
|
|
22
22
|
*/
|
|
23
23
|
'code': string;
|
|
24
24
|
/**
|
|
25
25
|
* Category name: display name of the category
|
|
26
26
|
* @type {string}
|
|
27
|
-
* @memberof
|
|
27
|
+
* @memberof PatchCategoryRequestDto
|
|
28
28
|
*/
|
|
29
|
-
'name'
|
|
29
|
+
'name'?: string;
|
|
30
30
|
/**
|
|
31
31
|
* Category slug: URL-friendly identifier
|
|
32
32
|
* @type {string}
|
|
33
|
-
* @memberof
|
|
33
|
+
* @memberof PatchCategoryRequestDto
|
|
34
34
|
*/
|
|
35
|
-
'slug'
|
|
35
|
+
'slug'?: string;
|
|
36
36
|
}
|
package/dist/models/{update-category-response-class.d.ts → patch-category-response-class.d.ts}
RENAMED
|
@@ -13,13 +13,13 @@ import { CategoryClass } from './category-class';
|
|
|
13
13
|
/**
|
|
14
14
|
*
|
|
15
15
|
* @export
|
|
16
|
-
* @interface
|
|
16
|
+
* @interface PatchCategoryResponseClass
|
|
17
17
|
*/
|
|
18
|
-
export interface
|
|
18
|
+
export interface PatchCategoryResponseClass {
|
|
19
19
|
/**
|
|
20
20
|
* category
|
|
21
21
|
* @type {CategoryClass}
|
|
22
|
-
* @memberof
|
|
22
|
+
* @memberof PatchCategoryResponseClass
|
|
23
23
|
*/
|
|
24
24
|
'category'?: CategoryClass;
|
|
25
25
|
}
|
|
@@ -12,25 +12,25 @@
|
|
|
12
12
|
/**
|
|
13
13
|
*
|
|
14
14
|
* @export
|
|
15
|
-
* @interface
|
|
15
|
+
* @interface PatchStatusRequestDto
|
|
16
16
|
*/
|
|
17
|
-
export interface
|
|
17
|
+
export interface PatchStatusRequestDto {
|
|
18
18
|
/**
|
|
19
19
|
* Status code: unique identifier of the status
|
|
20
20
|
* @type {string}
|
|
21
|
-
* @memberof
|
|
21
|
+
* @memberof PatchStatusRequestDto
|
|
22
22
|
*/
|
|
23
23
|
'code': string;
|
|
24
24
|
/**
|
|
25
25
|
* Status name: display name of the status
|
|
26
26
|
* @type {string}
|
|
27
|
-
* @memberof
|
|
27
|
+
* @memberof PatchStatusRequestDto
|
|
28
28
|
*/
|
|
29
|
-
'name'
|
|
29
|
+
'name'?: string;
|
|
30
30
|
/**
|
|
31
31
|
* Status slug: URL-friendly identifier
|
|
32
32
|
* @type {string}
|
|
33
|
-
* @memberof
|
|
33
|
+
* @memberof PatchStatusRequestDto
|
|
34
34
|
*/
|
|
35
|
-
'slug'
|
|
35
|
+
'slug'?: string;
|
|
36
36
|
}
|
|
@@ -13,13 +13,13 @@ import { StatusClass } from './status-class';
|
|
|
13
13
|
/**
|
|
14
14
|
*
|
|
15
15
|
* @export
|
|
16
|
-
* @interface
|
|
16
|
+
* @interface PatchStatusResponseClass
|
|
17
17
|
*/
|
|
18
|
-
export interface
|
|
18
|
+
export interface PatchStatusResponseClass {
|
|
19
19
|
/**
|
|
20
20
|
* status
|
|
21
21
|
* @type {StatusClass}
|
|
22
|
-
* @memberof
|
|
22
|
+
* @memberof PatchStatusResponseClass
|
|
23
23
|
*/
|
|
24
24
|
'status'?: StatusClass;
|
|
25
25
|
}
|