@emilgroup/task-sdk-node 1.0.1-beta.3 → 1.0.1-beta.34
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 +9 -6
- package/README.md +2 -2
- package/api/assignees-api.ts +166 -0
- package/api/categories-api.ts +111 -85
- package/api/default-api.ts +1 -1
- package/api/hub-spot-api.ts +4 -4
- package/api/statuses-api.ts +71 -73
- package/api/tasks-api.ts +119 -93
- package/api.ts +2 -0
- package/dist/api/assignees-api.d.ts +96 -0
- package/dist/api/assignees-api.js +228 -0
- package/dist/api/categories-api.d.ts +83 -65
- package/dist/api/categories-api.js +75 -65
- package/dist/api/default-api.js +1 -1
- package/dist/api/hub-spot-api.d.ts +4 -4
- package/dist/api/hub-spot-api.js +4 -4
- package/dist/api/statuses-api.d.ts +60 -60
- package/dist/api/statuses-api.js +54 -56
- package/dist/api/tasks-api.d.ts +91 -73
- package/dist/api/tasks-api.js +81 -71
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/models/assignee-class.d.ts +24 -0
- package/dist/models/create-status-request-dto.d.ts +6 -0
- package/dist/models/create-task-request-dto.d.ts +4 -4
- package/dist/models/index.d.ts +8 -6
- package/dist/models/index.js +8 -6
- package/dist/models/list-assignees-response-class.d.ts +43 -0
- 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} +13 -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 +114 -0
- package/dist/models/patch-task-request-dto.js +15 -0
- package/dist/models/{update-task-response-class.d.ts → patch-task-response-class.d.ts} +3 -3
- package/dist/models/patch-task-response-class.js +15 -0
- package/dist/models/status-class.d.ts +6 -0
- package/dist/models/task-class.d.ts +16 -4
- package/models/assignee-class.ts +30 -0
- package/models/create-status-request-dto.ts +6 -0
- package/models/create-task-request-dto.ts +4 -4
- package/models/index.ts +8 -6
- package/models/list-assignees-response-class.ts +49 -0
- 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} +13 -7
- package/models/{update-status-response-class.ts → patch-status-response-class.ts} +3 -3
- package/models/patch-task-request-dto.ts +120 -0
- package/models/{update-task-response-class.ts → patch-task-response-class.ts} +3 -3
- package/models/status-class.ts +6 -0
- package/models/task-class.ts +16 -4
- package/package.json +2 -2
- 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 → assignee-class.js} +0 -0
- /package/dist/models/{update-category-response-class.js → list-assignees-response-class.js} +0 -0
- /package/dist/models/{update-status-request-dto.js → patch-category-request-dto.js} +0 -0
- /package/dist/models/{update-status-response-class.js → patch-category-response-class.js} +0 -0
- /package/dist/models/{update-task-request-dto.js → patch-status-request-dto.js} +0 -0
- /package/dist/models/{update-task-response-class.js → patch-status-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';
|
|
@@ -43,7 +43,7 @@ const FormData = require('form-data');
|
|
|
43
43
|
export const TasksApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
44
44
|
return {
|
|
45
45
|
/**
|
|
46
|
-
* This will create task.
|
|
46
|
+
* This will create a task. **Required Permissions** \"task-management.tasks.create\"
|
|
47
47
|
* @summary Create the task
|
|
48
48
|
* @param {CreateTaskRequestDto} createTaskRequestDto
|
|
49
49
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -90,7 +90,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
90
90
|
};
|
|
91
91
|
},
|
|
92
92
|
/**
|
|
93
|
-
* This will delete a task by code.
|
|
93
|
+
* This will delete a task by code. **Required Permissions** \"task-management.tasks.delete\"
|
|
94
94
|
* @summary Delete the task
|
|
95
95
|
* @param {string} code Unique identifier for the object.
|
|
96
96
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -135,19 +135,17 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
135
135
|
};
|
|
136
136
|
},
|
|
137
137
|
/**
|
|
138
|
-
* This will get a task by code.
|
|
138
|
+
* This will get a task by code. **Required Permissions** \"task-management.tasks.view\"
|
|
139
139
|
* @summary Retrieve the task
|
|
140
140
|
* @param {string} code
|
|
141
|
-
* @param {string} expand
|
|
142
141
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
142
|
+
* @param {string} [expand] Expand to fetch additional information about the task.
|
|
143
143
|
* @param {*} [options] Override http request option.
|
|
144
144
|
* @throws {RequiredError}
|
|
145
145
|
*/
|
|
146
|
-
getTask: async (code: string,
|
|
146
|
+
getTask: async (code: string, authorization?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
147
147
|
// verify required parameter 'code' is not null or undefined
|
|
148
148
|
assertParamExists('getTask', 'code', code)
|
|
149
|
-
// verify required parameter 'expand' is not null or undefined
|
|
150
|
-
assertParamExists('getTask', 'expand', expand)
|
|
151
149
|
const localVarPath = `/taskservice/v1/tasks/{code}`
|
|
152
150
|
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
153
151
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -187,18 +185,20 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
187
185
|
};
|
|
188
186
|
},
|
|
189
187
|
/**
|
|
190
|
-
* Retrieves a list of tasks.
|
|
188
|
+
* Retrieves a list of tasks. **Required Permissions** \"task-management.tasks.view\"
|
|
191
189
|
* @summary List tasks
|
|
192
190
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
193
|
-
* @param {
|
|
194
|
-
* @param {string} [
|
|
195
|
-
* @param {string} [
|
|
196
|
-
* @param {string} [
|
|
197
|
-
* @param {string} [
|
|
191
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
192
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
193
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
|
|
194
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: subject, description</i>
|
|
195
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, assignee, reporter, dueDate, status, priority</i>
|
|
196
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: categories, status<i>
|
|
197
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
|
|
198
198
|
* @param {*} [options] Override http request option.
|
|
199
199
|
* @throws {RequiredError}
|
|
200
200
|
*/
|
|
201
|
-
listTasks: async (authorization?: string,
|
|
201
|
+
listTasks: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
202
202
|
const localVarPath = `/taskservice/v1/tasks`;
|
|
203
203
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
204
204
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -217,12 +217,16 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
217
217
|
// http bearer authentication required
|
|
218
218
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
219
219
|
|
|
220
|
-
if (
|
|
221
|
-
localVarQueryParameter['
|
|
220
|
+
if (pageSize !== undefined) {
|
|
221
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
222
222
|
}
|
|
223
223
|
|
|
224
|
-
if (
|
|
225
|
-
localVarQueryParameter['
|
|
224
|
+
if (pageToken !== undefined) {
|
|
225
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
226
|
+
}
|
|
227
|
+
|
|
228
|
+
if (filter !== undefined) {
|
|
229
|
+
localVarQueryParameter['filter'] = filter;
|
|
226
230
|
}
|
|
227
231
|
|
|
228
232
|
if (search !== undefined) {
|
|
@@ -237,6 +241,10 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
237
241
|
localVarQueryParameter['expand'] = expand;
|
|
238
242
|
}
|
|
239
243
|
|
|
244
|
+
if (filters !== undefined) {
|
|
245
|
+
localVarQueryParameter['filters'] = filters;
|
|
246
|
+
}
|
|
247
|
+
|
|
240
248
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
241
249
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
242
250
|
}
|
|
@@ -253,19 +261,19 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
253
261
|
};
|
|
254
262
|
},
|
|
255
263
|
/**
|
|
256
|
-
* This will update a task by code.
|
|
264
|
+
* This will partially update a task by code with the provided fields. **Required Permissions** \"task-management.tasks.update\"
|
|
257
265
|
* @summary Update the task
|
|
258
266
|
* @param {string} code
|
|
259
|
-
* @param {
|
|
267
|
+
* @param {PatchTaskRequestDto} patchTaskRequestDto
|
|
260
268
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
261
269
|
* @param {*} [options] Override http request option.
|
|
262
270
|
* @throws {RequiredError}
|
|
263
271
|
*/
|
|
264
|
-
|
|
272
|
+
patchTask: async (code: string, patchTaskRequestDto: PatchTaskRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
265
273
|
// verify required parameter 'code' is not null or undefined
|
|
266
|
-
assertParamExists('
|
|
267
|
-
// verify required parameter '
|
|
268
|
-
assertParamExists('
|
|
274
|
+
assertParamExists('patchTask', 'code', code)
|
|
275
|
+
// verify required parameter 'patchTaskRequestDto' is not null or undefined
|
|
276
|
+
assertParamExists('patchTask', 'patchTaskRequestDto', patchTaskRequestDto)
|
|
269
277
|
const localVarPath = `/taskservice/v1/tasks/{code}`
|
|
270
278
|
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
271
279
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -277,7 +285,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
277
285
|
baseAccessToken = configuration.accessToken;
|
|
278
286
|
}
|
|
279
287
|
|
|
280
|
-
const localVarRequestOptions = { method: '
|
|
288
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
281
289
|
const localVarHeaderParameter = {} as any;
|
|
282
290
|
const localVarQueryParameter = {} as any;
|
|
283
291
|
|
|
@@ -296,7 +304,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
296
304
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
297
305
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
298
306
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
299
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
307
|
+
localVarRequestOptions.data = serializeDataIfNeeded(patchTaskRequestDto, localVarRequestOptions, configuration)
|
|
300
308
|
|
|
301
309
|
return {
|
|
302
310
|
url: toPathString(localVarUrlObj),
|
|
@@ -314,7 +322,7 @@ export const TasksApiFp = function(configuration?: Configuration) {
|
|
|
314
322
|
const localVarAxiosParamCreator = TasksApiAxiosParamCreator(configuration)
|
|
315
323
|
return {
|
|
316
324
|
/**
|
|
317
|
-
* This will create task.
|
|
325
|
+
* This will create a task. **Required Permissions** \"task-management.tasks.create\"
|
|
318
326
|
* @summary Create the task
|
|
319
327
|
* @param {CreateTaskRequestDto} createTaskRequestDto
|
|
320
328
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -326,7 +334,7 @@ export const TasksApiFp = function(configuration?: Configuration) {
|
|
|
326
334
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
327
335
|
},
|
|
328
336
|
/**
|
|
329
|
-
* This will delete a task by code.
|
|
337
|
+
* This will delete a task by code. **Required Permissions** \"task-management.tasks.delete\"
|
|
330
338
|
* @summary Delete the task
|
|
331
339
|
* @param {string} code Unique identifier for the object.
|
|
332
340
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -338,45 +346,47 @@ export const TasksApiFp = function(configuration?: Configuration) {
|
|
|
338
346
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
339
347
|
},
|
|
340
348
|
/**
|
|
341
|
-
* This will get a task by code.
|
|
349
|
+
* This will get a task by code. **Required Permissions** \"task-management.tasks.view\"
|
|
342
350
|
* @summary Retrieve the task
|
|
343
351
|
* @param {string} code
|
|
344
|
-
* @param {string} expand
|
|
345
352
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
353
|
+
* @param {string} [expand] Expand to fetch additional information about the task.
|
|
346
354
|
* @param {*} [options] Override http request option.
|
|
347
355
|
* @throws {RequiredError}
|
|
348
356
|
*/
|
|
349
|
-
async getTask(code: string,
|
|
350
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getTask(code,
|
|
357
|
+
async getTask(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTaskResponseClass>> {
|
|
358
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getTask(code, authorization, expand, options);
|
|
351
359
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
352
360
|
},
|
|
353
361
|
/**
|
|
354
|
-
* Retrieves a list of tasks.
|
|
362
|
+
* Retrieves a list of tasks. **Required Permissions** \"task-management.tasks.view\"
|
|
355
363
|
* @summary List tasks
|
|
356
364
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
357
|
-
* @param {
|
|
358
|
-
* @param {string} [
|
|
359
|
-
* @param {string} [
|
|
360
|
-
* @param {string} [
|
|
361
|
-
* @param {string} [
|
|
365
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
366
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
367
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
|
|
368
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: subject, description</i>
|
|
369
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, assignee, reporter, dueDate, status, priority</i>
|
|
370
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: categories, status<i>
|
|
371
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
|
|
362
372
|
* @param {*} [options] Override http request option.
|
|
363
373
|
* @throws {RequiredError}
|
|
364
374
|
*/
|
|
365
|
-
async listTasks(authorization?: string,
|
|
366
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listTasks(authorization,
|
|
375
|
+
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>> {
|
|
376
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listTasks(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
367
377
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
368
378
|
},
|
|
369
379
|
/**
|
|
370
|
-
* This will update a task by code.
|
|
380
|
+
* This will partially update a task by code with the provided fields. **Required Permissions** \"task-management.tasks.update\"
|
|
371
381
|
* @summary Update the task
|
|
372
382
|
* @param {string} code
|
|
373
|
-
* @param {
|
|
383
|
+
* @param {PatchTaskRequestDto} patchTaskRequestDto
|
|
374
384
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
375
385
|
* @param {*} [options] Override http request option.
|
|
376
386
|
* @throws {RequiredError}
|
|
377
387
|
*/
|
|
378
|
-
async
|
|
379
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
388
|
+
async patchTask(code: string, patchTaskRequestDto: PatchTaskRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PatchTaskResponseClass>> {
|
|
389
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.patchTask(code, patchTaskRequestDto, authorization, options);
|
|
380
390
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
381
391
|
},
|
|
382
392
|
}
|
|
@@ -390,7 +400,7 @@ export const TasksApiFactory = function (configuration?: Configuration, basePath
|
|
|
390
400
|
const localVarFp = TasksApiFp(configuration)
|
|
391
401
|
return {
|
|
392
402
|
/**
|
|
393
|
-
* This will create task.
|
|
403
|
+
* This will create a task. **Required Permissions** \"task-management.tasks.create\"
|
|
394
404
|
* @summary Create the task
|
|
395
405
|
* @param {CreateTaskRequestDto} createTaskRequestDto
|
|
396
406
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -401,7 +411,7 @@ export const TasksApiFactory = function (configuration?: Configuration, basePath
|
|
|
401
411
|
return localVarFp.createTask(createTaskRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
402
412
|
},
|
|
403
413
|
/**
|
|
404
|
-
* This will delete a task by code.
|
|
414
|
+
* This will delete a task by code. **Required Permissions** \"task-management.tasks.delete\"
|
|
405
415
|
* @summary Delete the task
|
|
406
416
|
* @param {string} code Unique identifier for the object.
|
|
407
417
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -412,43 +422,45 @@ export const TasksApiFactory = function (configuration?: Configuration, basePath
|
|
|
412
422
|
return localVarFp.deleteTask(code, authorization, options).then((request) => request(axios, basePath));
|
|
413
423
|
},
|
|
414
424
|
/**
|
|
415
|
-
* This will get a task by code.
|
|
425
|
+
* This will get a task by code. **Required Permissions** \"task-management.tasks.view\"
|
|
416
426
|
* @summary Retrieve the task
|
|
417
427
|
* @param {string} code
|
|
418
|
-
* @param {string} expand
|
|
419
428
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
429
|
+
* @param {string} [expand] Expand to fetch additional information about the task.
|
|
420
430
|
* @param {*} [options] Override http request option.
|
|
421
431
|
* @throws {RequiredError}
|
|
422
432
|
*/
|
|
423
|
-
getTask(code: string,
|
|
424
|
-
return localVarFp.getTask(code,
|
|
433
|
+
getTask(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetTaskResponseClass> {
|
|
434
|
+
return localVarFp.getTask(code, authorization, expand, options).then((request) => request(axios, basePath));
|
|
425
435
|
},
|
|
426
436
|
/**
|
|
427
|
-
* Retrieves a list of tasks.
|
|
437
|
+
* Retrieves a list of tasks. **Required Permissions** \"task-management.tasks.view\"
|
|
428
438
|
* @summary List tasks
|
|
429
439
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
430
|
-
* @param {
|
|
431
|
-
* @param {string} [
|
|
432
|
-
* @param {string} [
|
|
433
|
-
* @param {string} [
|
|
434
|
-
* @param {string} [
|
|
440
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
441
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
442
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
|
|
443
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: subject, description</i>
|
|
444
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, assignee, reporter, dueDate, status, priority</i>
|
|
445
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: categories, status<i>
|
|
446
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
|
|
435
447
|
* @param {*} [options] Override http request option.
|
|
436
448
|
* @throws {RequiredError}
|
|
437
449
|
*/
|
|
438
|
-
listTasks(authorization?: string,
|
|
439
|
-
return localVarFp.listTasks(authorization,
|
|
450
|
+
listTasks(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListTasksResponseClass> {
|
|
451
|
+
return localVarFp.listTasks(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
440
452
|
},
|
|
441
453
|
/**
|
|
442
|
-
* This will update a task by code.
|
|
454
|
+
* This will partially update a task by code with the provided fields. **Required Permissions** \"task-management.tasks.update\"
|
|
443
455
|
* @summary Update the task
|
|
444
456
|
* @param {string} code
|
|
445
|
-
* @param {
|
|
457
|
+
* @param {PatchTaskRequestDto} patchTaskRequestDto
|
|
446
458
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
447
459
|
* @param {*} [options] Override http request option.
|
|
448
460
|
* @throws {RequiredError}
|
|
449
461
|
*/
|
|
450
|
-
|
|
451
|
-
return localVarFp.
|
|
462
|
+
patchTask(code: string, patchTaskRequestDto: PatchTaskRequestDto, authorization?: string, options?: any): AxiosPromise<PatchTaskResponseClass> {
|
|
463
|
+
return localVarFp.patchTask(code, patchTaskRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
452
464
|
},
|
|
453
465
|
};
|
|
454
466
|
};
|
|
@@ -509,18 +521,18 @@ export interface TasksApiGetTaskRequest {
|
|
|
509
521
|
readonly code: string
|
|
510
522
|
|
|
511
523
|
/**
|
|
512
|
-
*
|
|
524
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
513
525
|
* @type {string}
|
|
514
526
|
* @memberof TasksApiGetTask
|
|
515
527
|
*/
|
|
516
|
-
readonly
|
|
528
|
+
readonly authorization?: string
|
|
517
529
|
|
|
518
530
|
/**
|
|
519
|
-
*
|
|
531
|
+
* Expand to fetch additional information about the task.
|
|
520
532
|
* @type {string}
|
|
521
533
|
* @memberof TasksApiGetTask
|
|
522
534
|
*/
|
|
523
|
-
readonly
|
|
535
|
+
readonly expand?: string
|
|
524
536
|
}
|
|
525
537
|
|
|
526
538
|
/**
|
|
@@ -537,65 +549,79 @@ export interface TasksApiListTasksRequest {
|
|
|
537
549
|
readonly authorization?: string
|
|
538
550
|
|
|
539
551
|
/**
|
|
540
|
-
*
|
|
552
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
553
|
+
* @type {number}
|
|
554
|
+
* @memberof TasksApiListTasks
|
|
555
|
+
*/
|
|
556
|
+
readonly pageSize?: number
|
|
557
|
+
|
|
558
|
+
/**
|
|
559
|
+
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
541
560
|
* @type {string}
|
|
542
561
|
* @memberof TasksApiListTasks
|
|
543
562
|
*/
|
|
544
|
-
readonly
|
|
563
|
+
readonly pageToken?: string
|
|
545
564
|
|
|
546
565
|
/**
|
|
547
|
-
*
|
|
566
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
|
|
548
567
|
* @type {string}
|
|
549
568
|
* @memberof TasksApiListTasks
|
|
550
569
|
*/
|
|
551
|
-
readonly
|
|
570
|
+
readonly filter?: string
|
|
552
571
|
|
|
553
572
|
/**
|
|
554
|
-
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields:
|
|
573
|
+
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: subject, description</i>
|
|
555
574
|
* @type {string}
|
|
556
575
|
* @memberof TasksApiListTasks
|
|
557
576
|
*/
|
|
558
577
|
readonly search?: string
|
|
559
578
|
|
|
560
579
|
/**
|
|
561
|
-
* 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>
|
|
580
|
+
* 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, status, priority</i>
|
|
562
581
|
* @type {string}
|
|
563
582
|
* @memberof TasksApiListTasks
|
|
564
583
|
*/
|
|
565
584
|
readonly order?: string
|
|
566
585
|
|
|
567
586
|
/**
|
|
568
|
-
* 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:
|
|
587
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: categories, status<i>
|
|
569
588
|
* @type {string}
|
|
570
589
|
* @memberof TasksApiListTasks
|
|
571
590
|
*/
|
|
572
591
|
readonly expand?: string
|
|
592
|
+
|
|
593
|
+
/**
|
|
594
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
|
|
595
|
+
* @type {string}
|
|
596
|
+
* @memberof TasksApiListTasks
|
|
597
|
+
*/
|
|
598
|
+
readonly filters?: string
|
|
573
599
|
}
|
|
574
600
|
|
|
575
601
|
/**
|
|
576
|
-
* Request parameters for
|
|
602
|
+
* Request parameters for patchTask operation in TasksApi.
|
|
577
603
|
* @export
|
|
578
|
-
* @interface
|
|
604
|
+
* @interface TasksApiPatchTaskRequest
|
|
579
605
|
*/
|
|
580
|
-
export interface
|
|
606
|
+
export interface TasksApiPatchTaskRequest {
|
|
581
607
|
/**
|
|
582
608
|
*
|
|
583
609
|
* @type {string}
|
|
584
|
-
* @memberof
|
|
610
|
+
* @memberof TasksApiPatchTask
|
|
585
611
|
*/
|
|
586
612
|
readonly code: string
|
|
587
613
|
|
|
588
614
|
/**
|
|
589
615
|
*
|
|
590
|
-
* @type {
|
|
591
|
-
* @memberof
|
|
616
|
+
* @type {PatchTaskRequestDto}
|
|
617
|
+
* @memberof TasksApiPatchTask
|
|
592
618
|
*/
|
|
593
|
-
readonly
|
|
619
|
+
readonly patchTaskRequestDto: PatchTaskRequestDto
|
|
594
620
|
|
|
595
621
|
/**
|
|
596
622
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
597
623
|
* @type {string}
|
|
598
|
-
* @memberof
|
|
624
|
+
* @memberof TasksApiPatchTask
|
|
599
625
|
*/
|
|
600
626
|
readonly authorization?: string
|
|
601
627
|
}
|
|
@@ -608,7 +634,7 @@ export interface TasksApiUpdateTaskRequest {
|
|
|
608
634
|
*/
|
|
609
635
|
export class TasksApi extends BaseAPI {
|
|
610
636
|
/**
|
|
611
|
-
* This will create task.
|
|
637
|
+
* This will create a task. **Required Permissions** \"task-management.tasks.create\"
|
|
612
638
|
* @summary Create the task
|
|
613
639
|
* @param {TasksApiCreateTaskRequest} requestParameters Request parameters.
|
|
614
640
|
* @param {*} [options] Override http request option.
|
|
@@ -620,7 +646,7 @@ export class TasksApi extends BaseAPI {
|
|
|
620
646
|
}
|
|
621
647
|
|
|
622
648
|
/**
|
|
623
|
-
* This will delete a task by code.
|
|
649
|
+
* This will delete a task by code. **Required Permissions** \"task-management.tasks.delete\"
|
|
624
650
|
* @summary Delete the task
|
|
625
651
|
* @param {TasksApiDeleteTaskRequest} requestParameters Request parameters.
|
|
626
652
|
* @param {*} [options] Override http request option.
|
|
@@ -632,7 +658,7 @@ export class TasksApi extends BaseAPI {
|
|
|
632
658
|
}
|
|
633
659
|
|
|
634
660
|
/**
|
|
635
|
-
* This will get a task by code.
|
|
661
|
+
* This will get a task by code. **Required Permissions** \"task-management.tasks.view\"
|
|
636
662
|
* @summary Retrieve the task
|
|
637
663
|
* @param {TasksApiGetTaskRequest} requestParameters Request parameters.
|
|
638
664
|
* @param {*} [options] Override http request option.
|
|
@@ -640,11 +666,11 @@ export class TasksApi extends BaseAPI {
|
|
|
640
666
|
* @memberof TasksApi
|
|
641
667
|
*/
|
|
642
668
|
public getTask(requestParameters: TasksApiGetTaskRequest, options?: AxiosRequestConfig) {
|
|
643
|
-
return TasksApiFp(this.configuration).getTask(requestParameters.code, requestParameters.
|
|
669
|
+
return TasksApiFp(this.configuration).getTask(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
644
670
|
}
|
|
645
671
|
|
|
646
672
|
/**
|
|
647
|
-
* Retrieves a list of tasks.
|
|
673
|
+
* Retrieves a list of tasks. **Required Permissions** \"task-management.tasks.view\"
|
|
648
674
|
* @summary List tasks
|
|
649
675
|
* @param {TasksApiListTasksRequest} requestParameters Request parameters.
|
|
650
676
|
* @param {*} [options] Override http request option.
|
|
@@ -652,18 +678,18 @@ export class TasksApi extends BaseAPI {
|
|
|
652
678
|
* @memberof TasksApi
|
|
653
679
|
*/
|
|
654
680
|
public listTasks(requestParameters: TasksApiListTasksRequest = {}, options?: AxiosRequestConfig) {
|
|
655
|
-
return TasksApiFp(this.configuration).listTasks(requestParameters.authorization, requestParameters.
|
|
681
|
+
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
682
|
}
|
|
657
683
|
|
|
658
684
|
/**
|
|
659
|
-
* This will update a task by code.
|
|
685
|
+
* This will partially update a task by code with the provided fields. **Required Permissions** \"task-management.tasks.update\"
|
|
660
686
|
* @summary Update the task
|
|
661
|
-
* @param {
|
|
687
|
+
* @param {TasksApiPatchTaskRequest} requestParameters Request parameters.
|
|
662
688
|
* @param {*} [options] Override http request option.
|
|
663
689
|
* @throws {RequiredError}
|
|
664
690
|
* @memberof TasksApi
|
|
665
691
|
*/
|
|
666
|
-
public
|
|
667
|
-
return TasksApiFp(this.configuration).
|
|
692
|
+
public patchTask(requestParameters: TasksApiPatchTaskRequest, options?: AxiosRequestConfig) {
|
|
693
|
+
return TasksApiFp(this.configuration).patchTask(requestParameters.code, requestParameters.patchTaskRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
668
694
|
}
|
|
669
695
|
}
|
package/api.ts
CHANGED
|
@@ -24,6 +24,7 @@ import FormData from 'form-data'
|
|
|
24
24
|
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
|
|
25
25
|
// @ts-ignore
|
|
26
26
|
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base';
|
|
27
|
+
import { AssigneesApi } from './api';
|
|
27
28
|
import { CategoriesApi } from './api';
|
|
28
29
|
import { DefaultApi } from './api';
|
|
29
30
|
import { HubSpotApi } from './api';
|
|
@@ -31,6 +32,7 @@ import { StatusesApi } from './api';
|
|
|
31
32
|
import { TasksApi } from './api';
|
|
32
33
|
|
|
33
34
|
|
|
35
|
+
export * from './api/assignees-api';
|
|
34
36
|
export * from './api/categories-api';
|
|
35
37
|
export * from './api/default-api';
|
|
36
38
|
export * from './api/hub-spot-api';
|