@emilgroup/task-sdk-node 1.0.1-beta.3 → 1.0.1-beta.35

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.
Files changed (61) hide show
  1. package/.openapi-generator/FILES +9 -6
  2. package/README.md +2 -2
  3. package/api/assignees-api.ts +166 -0
  4. package/api/categories-api.ts +111 -85
  5. package/api/default-api.ts +1 -1
  6. package/api/hub-spot-api.ts +4 -4
  7. package/api/statuses-api.ts +71 -73
  8. package/api/tasks-api.ts +119 -93
  9. package/api.ts +2 -0
  10. package/dist/api/assignees-api.d.ts +96 -0
  11. package/dist/api/assignees-api.js +228 -0
  12. package/dist/api/categories-api.d.ts +83 -65
  13. package/dist/api/categories-api.js +75 -65
  14. package/dist/api/default-api.js +1 -1
  15. package/dist/api/hub-spot-api.d.ts +4 -4
  16. package/dist/api/hub-spot-api.js +4 -4
  17. package/dist/api/statuses-api.d.ts +60 -60
  18. package/dist/api/statuses-api.js +54 -56
  19. package/dist/api/tasks-api.d.ts +91 -73
  20. package/dist/api/tasks-api.js +81 -71
  21. package/dist/api.d.ts +1 -0
  22. package/dist/api.js +1 -0
  23. package/dist/models/assignee-class.d.ts +24 -0
  24. package/dist/models/create-status-request-dto.d.ts +6 -0
  25. package/dist/models/create-task-request-dto.d.ts +23 -4
  26. package/dist/models/create-task-request-dto.js +7 -1
  27. package/dist/models/index.d.ts +8 -6
  28. package/dist/models/index.js +8 -6
  29. package/dist/models/list-assignees-response-class.d.ts +43 -0
  30. package/dist/models/{update-category-request-dto.d.ts → patch-category-request-dto.d.ts} +7 -7
  31. package/dist/models/{update-category-response-class.d.ts → patch-category-response-class.d.ts} +3 -3
  32. package/dist/models/{update-status-request-dto.d.ts → patch-status-request-dto.d.ts} +13 -7
  33. package/dist/models/{update-status-response-class.d.ts → patch-status-response-class.d.ts} +3 -3
  34. package/dist/models/patch-task-request-dto.d.ts +139 -0
  35. package/dist/models/patch-task-request-dto.js +22 -0
  36. package/dist/models/{update-task-response-class.d.ts → patch-task-response-class.d.ts} +3 -3
  37. package/dist/models/patch-task-response-class.js +15 -0
  38. package/dist/models/status-class.d.ts +6 -0
  39. package/dist/models/task-class.d.ts +34 -4
  40. package/models/assignee-class.ts +30 -0
  41. package/models/create-status-request-dto.ts +6 -0
  42. package/models/create-task-request-dto.ts +24 -4
  43. package/models/index.ts +8 -6
  44. package/models/list-assignees-response-class.ts +49 -0
  45. package/models/{update-category-request-dto.ts → patch-category-request-dto.ts} +7 -7
  46. package/models/{update-category-response-class.ts → patch-category-response-class.ts} +3 -3
  47. package/models/{update-status-request-dto.ts → patch-status-request-dto.ts} +13 -7
  48. package/models/{update-status-response-class.ts → patch-status-response-class.ts} +3 -3
  49. package/models/patch-task-request-dto.ts +148 -0
  50. package/models/{update-task-response-class.ts → patch-task-response-class.ts} +3 -3
  51. package/models/status-class.ts +6 -0
  52. package/models/task-class.ts +34 -4
  53. package/package.json +2 -2
  54. package/dist/models/update-task-request-dto.d.ts +0 -72
  55. package/models/update-task-request-dto.ts +0 -78
  56. /package/dist/models/{update-category-request-dto.js → assignee-class.js} +0 -0
  57. /package/dist/models/{update-category-response-class.js → list-assignees-response-class.js} +0 -0
  58. /package/dist/models/{update-status-request-dto.js → patch-category-request-dto.js} +0 -0
  59. /package/dist/models/{update-status-response-class.js → patch-category-response-class.js} +0 -0
  60. /package/dist/models/{update-task-request-dto.js → patch-status-request-dto.js} +0 -0
  61. /package/dist/models/{update-task-response-class.js → patch-status-response-class.js} +0 -0
@@ -97,7 +97,7 @@ var TasksApiAxiosParamCreator = function (configuration) {
97
97
  var _this = this;
98
98
  return {
99
99
  /**
100
- * This will create task.
100
+ * This will create a task. **Required Permissions** \"task-management.tasks.create\"
101
101
  * @summary Create the task
102
102
  * @param {CreateTaskRequestDto} createTaskRequestDto
103
103
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -146,7 +146,7 @@ var TasksApiAxiosParamCreator = function (configuration) {
146
146
  });
147
147
  },
148
148
  /**
149
- * This will delete a task by code.
149
+ * This will delete a task by code. **Required Permissions** \"task-management.tasks.delete\"
150
150
  * @summary Delete the task
151
151
  * @param {string} code Unique identifier for the object.
152
152
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -194,15 +194,15 @@ var TasksApiAxiosParamCreator = function (configuration) {
194
194
  });
195
195
  },
196
196
  /**
197
- * This will get a task by code.
197
+ * This will get a task by code. **Required Permissions** \"task-management.tasks.view\"
198
198
  * @summary Retrieve the task
199
199
  * @param {string} code
200
- * @param {string} expand
201
200
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
201
+ * @param {string} [expand] Expand to fetch additional information about the task.
202
202
  * @param {*} [options] Override http request option.
203
203
  * @throws {RequiredError}
204
204
  */
205
- getTask: function (code, expand, authorization, options) {
205
+ getTask: function (code, authorization, expand, options) {
206
206
  if (options === void 0) { options = {}; }
207
207
  return __awaiter(_this, void 0, void 0, function () {
208
208
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -211,8 +211,6 @@ var TasksApiAxiosParamCreator = function (configuration) {
211
211
  case 0:
212
212
  // verify required parameter 'code' is not null or undefined
213
213
  (0, common_1.assertParamExists)('getTask', 'code', code);
214
- // verify required parameter 'expand' is not null or undefined
215
- (0, common_1.assertParamExists)('getTask', 'expand', expand);
216
214
  localVarPath = "/taskservice/v1/tasks/{code}"
217
215
  .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
218
216
  localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -248,18 +246,20 @@ var TasksApiAxiosParamCreator = function (configuration) {
248
246
  });
249
247
  },
250
248
  /**
251
- * Retrieves a list of tasks.
249
+ * Retrieves a list of tasks. **Required Permissions** \"task-management.tasks.view\"
252
250
  * @summary List tasks
253
251
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
254
- * @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} [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>
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} [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
- * @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>
252
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
253
+ * @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
+ * @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, entityType, entityCode, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
255
+ * @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>
256
+ * @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, entityType, entityCode, status, priority</i>
257
+ * @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>
258
+ * @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, entityType, entityCode, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
259
259
  * @param {*} [options] Override http request option.
260
260
  * @throws {RequiredError}
261
261
  */
262
- listTasks: function (authorization, filter, filters, search, order, expand, options) {
262
+ listTasks: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
263
263
  if (options === void 0) { options = {}; }
264
264
  return __awaiter(_this, void 0, void 0, function () {
265
265
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -282,12 +282,15 @@ var TasksApiAxiosParamCreator = function (configuration) {
282
282
  // authentication bearer required
283
283
  // http bearer authentication required
284
284
  _a.sent();
285
+ if (pageSize !== undefined) {
286
+ localVarQueryParameter['pageSize'] = pageSize;
287
+ }
288
+ if (pageToken !== undefined) {
289
+ localVarQueryParameter['pageToken'] = pageToken;
290
+ }
285
291
  if (filter !== undefined) {
286
292
  localVarQueryParameter['filter'] = filter;
287
293
  }
288
- if (filters !== undefined) {
289
- localVarQueryParameter['filters'] = filters;
290
- }
291
294
  if (search !== undefined) {
292
295
  localVarQueryParameter['search'] = search;
293
296
  }
@@ -297,6 +300,9 @@ var TasksApiAxiosParamCreator = function (configuration) {
297
300
  if (expand !== undefined) {
298
301
  localVarQueryParameter['expand'] = expand;
299
302
  }
303
+ if (filters !== undefined) {
304
+ localVarQueryParameter['filters'] = filters;
305
+ }
300
306
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
301
307
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
302
308
  }
@@ -312,15 +318,15 @@ var TasksApiAxiosParamCreator = function (configuration) {
312
318
  });
313
319
  },
314
320
  /**
315
- * This will update a task by code.
321
+ * This will partially update a task by code with the provided fields. **Required Permissions** \"task-management.tasks.update\"
316
322
  * @summary Update the task
317
323
  * @param {string} code
318
- * @param {UpdateTaskRequestDto} updateTaskRequestDto
324
+ * @param {PatchTaskRequestDto} patchTaskRequestDto
319
325
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
320
326
  * @param {*} [options] Override http request option.
321
327
  * @throws {RequiredError}
322
328
  */
323
- updateTask: function (code, updateTaskRequestDto, authorization, options) {
329
+ patchTask: function (code, patchTaskRequestDto, authorization, options) {
324
330
  if (options === void 0) { options = {}; }
325
331
  return __awaiter(_this, void 0, void 0, function () {
326
332
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -328,9 +334,9 @@ var TasksApiAxiosParamCreator = function (configuration) {
328
334
  switch (_a.label) {
329
335
  case 0:
330
336
  // verify required parameter 'code' is not null or undefined
331
- (0, common_1.assertParamExists)('updateTask', 'code', code);
332
- // verify required parameter 'updateTaskRequestDto' is not null or undefined
333
- (0, common_1.assertParamExists)('updateTask', 'updateTaskRequestDto', updateTaskRequestDto);
337
+ (0, common_1.assertParamExists)('patchTask', 'code', code);
338
+ // verify required parameter 'patchTaskRequestDto' is not null or undefined
339
+ (0, common_1.assertParamExists)('patchTask', 'patchTaskRequestDto', patchTaskRequestDto);
334
340
  localVarPath = "/taskservice/v1/tasks/{code}"
335
341
  .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
336
342
  localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -338,7 +344,7 @@ var TasksApiAxiosParamCreator = function (configuration) {
338
344
  baseOptions = configuration.baseOptions;
339
345
  baseAccessToken = configuration.accessToken;
340
346
  }
341
- localVarRequestOptions = __assign(__assign({ method: 'PUT' }, baseOptions), options);
347
+ localVarRequestOptions = __assign(__assign({ method: 'PATCH' }, baseOptions), options);
342
348
  localVarHeaderParameter = {};
343
349
  localVarQueryParameter = {};
344
350
  // authentication bearer required
@@ -355,7 +361,7 @@ var TasksApiAxiosParamCreator = function (configuration) {
355
361
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
356
362
  headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
357
363
  localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
358
- localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(updateTaskRequestDto, localVarRequestOptions, configuration);
364
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(patchTaskRequestDto, localVarRequestOptions, configuration);
359
365
  return [2 /*return*/, {
360
366
  url: (0, common_1.toPathString)(localVarUrlObj),
361
367
  options: localVarRequestOptions,
@@ -375,7 +381,7 @@ var TasksApiFp = function (configuration) {
375
381
  var localVarAxiosParamCreator = (0, exports.TasksApiAxiosParamCreator)(configuration);
376
382
  return {
377
383
  /**
378
- * This will create task.
384
+ * This will create a task. **Required Permissions** \"task-management.tasks.create\"
379
385
  * @summary Create the task
380
386
  * @param {CreateTaskRequestDto} createTaskRequestDto
381
387
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -396,7 +402,7 @@ var TasksApiFp = function (configuration) {
396
402
  });
397
403
  },
398
404
  /**
399
- * This will delete a task by code.
405
+ * This will delete a task by code. **Required Permissions** \"task-management.tasks.delete\"
400
406
  * @summary Delete the task
401
407
  * @param {string} code Unique identifier for the object.
402
408
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -417,20 +423,20 @@ var TasksApiFp = function (configuration) {
417
423
  });
418
424
  },
419
425
  /**
420
- * This will get a task by code.
426
+ * This will get a task by code. **Required Permissions** \"task-management.tasks.view\"
421
427
  * @summary Retrieve the task
422
428
  * @param {string} code
423
- * @param {string} expand
424
429
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
430
+ * @param {string} [expand] Expand to fetch additional information about the task.
425
431
  * @param {*} [options] Override http request option.
426
432
  * @throws {RequiredError}
427
433
  */
428
- getTask: function (code, expand, authorization, options) {
434
+ getTask: function (code, authorization, expand, options) {
429
435
  return __awaiter(this, void 0, void 0, function () {
430
436
  var localVarAxiosArgs;
431
437
  return __generator(this, function (_a) {
432
438
  switch (_a.label) {
433
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.getTask(code, expand, authorization, options)];
439
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getTask(code, authorization, expand, options)];
434
440
  case 1:
435
441
  localVarAxiosArgs = _a.sent();
436
442
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -439,23 +445,25 @@ var TasksApiFp = function (configuration) {
439
445
  });
440
446
  },
441
447
  /**
442
- * Retrieves a list of tasks.
448
+ * Retrieves a list of tasks. **Required Permissions** \"task-management.tasks.view\"
443
449
  * @summary List tasks
444
450
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
445
- * @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} [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>
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>
448
- * @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
- * @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>
451
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
452
+ * @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.
453
+ * @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, entityType, entityCode, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
454
+ * @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>
455
+ * @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, entityType, entityCode, status, priority</i>
456
+ * @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>
457
+ * @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, entityType, entityCode, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
450
458
  * @param {*} [options] Override http request option.
451
459
  * @throws {RequiredError}
452
460
  */
453
- listTasks: function (authorization, filter, filters, search, order, expand, options) {
461
+ listTasks: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
454
462
  return __awaiter(this, void 0, void 0, function () {
455
463
  var localVarAxiosArgs;
456
464
  return __generator(this, function (_a) {
457
465
  switch (_a.label) {
458
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.listTasks(authorization, filter, filters, search, order, expand, options)];
466
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.listTasks(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
459
467
  case 1:
460
468
  localVarAxiosArgs = _a.sent();
461
469
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -464,20 +472,20 @@ var TasksApiFp = function (configuration) {
464
472
  });
465
473
  },
466
474
  /**
467
- * This will update a task by code.
475
+ * This will partially update a task by code with the provided fields. **Required Permissions** \"task-management.tasks.update\"
468
476
  * @summary Update the task
469
477
  * @param {string} code
470
- * @param {UpdateTaskRequestDto} updateTaskRequestDto
478
+ * @param {PatchTaskRequestDto} patchTaskRequestDto
471
479
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
472
480
  * @param {*} [options] Override http request option.
473
481
  * @throws {RequiredError}
474
482
  */
475
- updateTask: function (code, updateTaskRequestDto, authorization, options) {
483
+ patchTask: function (code, patchTaskRequestDto, authorization, options) {
476
484
  return __awaiter(this, void 0, void 0, function () {
477
485
  var localVarAxiosArgs;
478
486
  return __generator(this, function (_a) {
479
487
  switch (_a.label) {
480
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.updateTask(code, updateTaskRequestDto, authorization, options)];
488
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.patchTask(code, patchTaskRequestDto, authorization, options)];
481
489
  case 1:
482
490
  localVarAxiosArgs = _a.sent();
483
491
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -496,7 +504,7 @@ var TasksApiFactory = function (configuration, basePath, axios) {
496
504
  var localVarFp = (0, exports.TasksApiFp)(configuration);
497
505
  return {
498
506
  /**
499
- * This will create task.
507
+ * This will create a task. **Required Permissions** \"task-management.tasks.create\"
500
508
  * @summary Create the task
501
509
  * @param {CreateTaskRequestDto} createTaskRequestDto
502
510
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -507,7 +515,7 @@ var TasksApiFactory = function (configuration, basePath, axios) {
507
515
  return localVarFp.createTask(createTaskRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
508
516
  },
509
517
  /**
510
- * This will delete a task by code.
518
+ * This will delete a task by code. **Required Permissions** \"task-management.tasks.delete\"
511
519
  * @summary Delete the task
512
520
  * @param {string} code Unique identifier for the object.
513
521
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -518,43 +526,45 @@ var TasksApiFactory = function (configuration, basePath, axios) {
518
526
  return localVarFp.deleteTask(code, authorization, options).then(function (request) { return request(axios, basePath); });
519
527
  },
520
528
  /**
521
- * This will get a task by code.
529
+ * This will get a task by code. **Required Permissions** \"task-management.tasks.view\"
522
530
  * @summary Retrieve the task
523
531
  * @param {string} code
524
- * @param {string} expand
525
532
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
533
+ * @param {string} [expand] Expand to fetch additional information about the task.
526
534
  * @param {*} [options] Override http request option.
527
535
  * @throws {RequiredError}
528
536
  */
529
- getTask: function (code, expand, authorization, options) {
530
- return localVarFp.getTask(code, expand, authorization, options).then(function (request) { return request(axios, basePath); });
537
+ getTask: function (code, authorization, expand, options) {
538
+ return localVarFp.getTask(code, authorization, expand, options).then(function (request) { return request(axios, basePath); });
531
539
  },
532
540
  /**
533
- * Retrieves a list of tasks.
541
+ * Retrieves a list of tasks. **Required Permissions** \"task-management.tasks.view\"
534
542
  * @summary List tasks
535
543
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
536
- * @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} [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>
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>
539
- * @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
- * @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>
544
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
545
+ * @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.
546
+ * @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, entityType, entityCode, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
547
+ * @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>
548
+ * @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, entityType, entityCode, status, priority</i>
549
+ * @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>
550
+ * @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, entityType, entityCode, dueDate, createdAt, updatedAt, status.slug, categories.slug</i>
541
551
  * @param {*} [options] Override http request option.
542
552
  * @throws {RequiredError}
543
553
  */
544
- listTasks: function (authorization, filter, filters, search, order, expand, options) {
545
- return localVarFp.listTasks(authorization, filter, filters, search, order, expand, options).then(function (request) { return request(axios, basePath); });
554
+ listTasks: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
555
+ return localVarFp.listTasks(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
546
556
  },
547
557
  /**
548
- * This will update a task by code.
558
+ * This will partially update a task by code with the provided fields. **Required Permissions** \"task-management.tasks.update\"
549
559
  * @summary Update the task
550
560
  * @param {string} code
551
- * @param {UpdateTaskRequestDto} updateTaskRequestDto
561
+ * @param {PatchTaskRequestDto} patchTaskRequestDto
552
562
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
553
563
  * @param {*} [options] Override http request option.
554
564
  * @throws {RequiredError}
555
565
  */
556
- updateTask: function (code, updateTaskRequestDto, authorization, options) {
557
- return localVarFp.updateTask(code, updateTaskRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
566
+ patchTask: function (code, patchTaskRequestDto, authorization, options) {
567
+ return localVarFp.patchTask(code, patchTaskRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
558
568
  },
559
569
  };
560
570
  };
@@ -571,7 +581,7 @@ var TasksApi = /** @class */ (function (_super) {
571
581
  return _super !== null && _super.apply(this, arguments) || this;
572
582
  }
573
583
  /**
574
- * This will create task.
584
+ * This will create a task. **Required Permissions** \"task-management.tasks.create\"
575
585
  * @summary Create the task
576
586
  * @param {TasksApiCreateTaskRequest} requestParameters Request parameters.
577
587
  * @param {*} [options] Override http request option.
@@ -583,7 +593,7 @@ var TasksApi = /** @class */ (function (_super) {
583
593
  return (0, exports.TasksApiFp)(this.configuration).createTask(requestParameters.createTaskRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
584
594
  };
585
595
  /**
586
- * This will delete a task by code.
596
+ * This will delete a task by code. **Required Permissions** \"task-management.tasks.delete\"
587
597
  * @summary Delete the task
588
598
  * @param {TasksApiDeleteTaskRequest} requestParameters Request parameters.
589
599
  * @param {*} [options] Override http request option.
@@ -595,7 +605,7 @@ var TasksApi = /** @class */ (function (_super) {
595
605
  return (0, exports.TasksApiFp)(this.configuration).deleteTask(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
596
606
  };
597
607
  /**
598
- * This will get a task by code.
608
+ * This will get a task by code. **Required Permissions** \"task-management.tasks.view\"
599
609
  * @summary Retrieve the task
600
610
  * @param {TasksApiGetTaskRequest} requestParameters Request parameters.
601
611
  * @param {*} [options] Override http request option.
@@ -604,10 +614,10 @@ var TasksApi = /** @class */ (function (_super) {
604
614
  */
605
615
  TasksApi.prototype.getTask = function (requestParameters, options) {
606
616
  var _this = this;
607
- return (0, exports.TasksApiFp)(this.configuration).getTask(requestParameters.code, requestParameters.expand, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
617
+ return (0, exports.TasksApiFp)(this.configuration).getTask(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
608
618
  };
609
619
  /**
610
- * Retrieves a list of tasks.
620
+ * Retrieves a list of tasks. **Required Permissions** \"task-management.tasks.view\"
611
621
  * @summary List tasks
612
622
  * @param {TasksApiListTasksRequest} requestParameters Request parameters.
613
623
  * @param {*} [options] Override http request option.
@@ -617,19 +627,19 @@ var TasksApi = /** @class */ (function (_super) {
617
627
  TasksApi.prototype.listTasks = function (requestParameters, options) {
618
628
  var _this = this;
619
629
  if (requestParameters === void 0) { requestParameters = {}; }
620
- return (0, exports.TasksApiFp)(this.configuration).listTasks(requestParameters.authorization, requestParameters.filter, requestParameters.filters, requestParameters.search, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
630
+ 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
631
  };
622
632
  /**
623
- * This will update a task by code.
633
+ * This will partially update a task by code with the provided fields. **Required Permissions** \"task-management.tasks.update\"
624
634
  * @summary Update the task
625
- * @param {TasksApiUpdateTaskRequest} requestParameters Request parameters.
635
+ * @param {TasksApiPatchTaskRequest} requestParameters Request parameters.
626
636
  * @param {*} [options] Override http request option.
627
637
  * @throws {RequiredError}
628
638
  * @memberof TasksApi
629
639
  */
630
- TasksApi.prototype.updateTask = function (requestParameters, options) {
640
+ TasksApi.prototype.patchTask = function (requestParameters, options) {
631
641
  var _this = this;
632
- return (0, exports.TasksApiFp)(this.configuration).updateTask(requestParameters.code, requestParameters.updateTaskRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
642
+ return (0, exports.TasksApiFp)(this.configuration).patchTask(requestParameters.code, requestParameters.patchTaskRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
633
643
  };
634
644
  return TasksApi;
635
645
  }(base_1.BaseAPI));
package/dist/api.d.ts CHANGED
@@ -9,6 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ export * from './api/assignees-api';
12
13
  export * from './api/categories-api';
13
14
  export * from './api/default-api';
14
15
  export * from './api/hub-spot-api';
package/dist/api.js CHANGED
@@ -27,6 +27,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
27
27
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
28
28
  };
29
29
  Object.defineProperty(exports, "__esModule", { value: true });
30
+ __exportStar(require("./api/assignees-api"), exports);
30
31
  __exportStar(require("./api/categories-api"), exports);
31
32
  __exportStar(require("./api/default-api"), exports);
32
33
  __exportStar(require("./api/hub-spot-api"), exports);
@@ -0,0 +1,24 @@
1
+ /**
2
+ * EMIL TaskService
3
+ * The EMIL Task API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface AssigneeClass
16
+ */
17
+ export interface AssigneeClass {
18
+ /**
19
+ * Assignee code/identifier
20
+ * @type {string}
21
+ * @memberof AssigneeClass
22
+ */
23
+ 'code': string;
24
+ }
@@ -27,4 +27,10 @@ export interface CreateStatusRequestDto {
27
27
  * @memberof CreateStatusRequestDto
28
28
  */
29
29
  'slug'?: string;
30
+ /**
31
+ * Sort order for workflow display (must be unique per tenant). Lower values appear first.
32
+ * @type {number}
33
+ * @memberof CreateStatusRequestDto
34
+ */
35
+ 'sortOrder': number;
30
36
  }
@@ -34,17 +34,17 @@ export interface CreateTaskRequestDto {
34
34
  */
35
35
  'assignee'?: string;
36
36
  /**
37
- * Task category slug
38
- * @type {string}
37
+ * Task category slugs (array of category slugs)
38
+ * @type {Array<string>}
39
39
  * @memberof CreateTaskRequestDto
40
40
  */
41
- 'categorySlug'?: string;
41
+ 'categorySlugs'?: Array<string>;
42
42
  /**
43
43
  * Task status slug
44
44
  * @type {string}
45
45
  * @memberof CreateTaskRequestDto
46
46
  */
47
- 'statusSlug'?: string;
47
+ 'statusSlug': string;
48
48
  /**
49
49
  * Task priority
50
50
  * @type {string}
@@ -63,6 +63,18 @@ export interface CreateTaskRequestDto {
63
63
  * @memberof CreateTaskRequestDto
64
64
  */
65
65
  'dueDate'?: string;
66
+ /**
67
+ * Connected entity type. Must be one of: LEAD, POLICY, CLAIM, PARTNER (uppercase). If provided, entityCode is required.
68
+ * @type {string}
69
+ * @memberof CreateTaskRequestDto
70
+ */
71
+ 'entityType'?: CreateTaskRequestDtoEntityTypeEnum;
72
+ /**
73
+ * Connected entity code. Unique code of the linked entity. If provided, entityType is required.
74
+ * @type {string}
75
+ * @memberof CreateTaskRequestDto
76
+ */
77
+ 'entityCode'?: string;
66
78
  }
67
79
  export declare const CreateTaskRequestDtoPriorityEnum: {
68
80
  readonly Low: "LOW";
@@ -70,3 +82,10 @@ export declare const CreateTaskRequestDtoPriorityEnum: {
70
82
  readonly High: "HIGH";
71
83
  };
72
84
  export type CreateTaskRequestDtoPriorityEnum = typeof CreateTaskRequestDtoPriorityEnum[keyof typeof CreateTaskRequestDtoPriorityEnum];
85
+ export declare const CreateTaskRequestDtoEntityTypeEnum: {
86
+ readonly Lead: "LEAD";
87
+ readonly Policy: "POLICY";
88
+ readonly Claim: "CLAIM";
89
+ readonly Partner: "PARTNER";
90
+ };
91
+ export type CreateTaskRequestDtoEntityTypeEnum = typeof CreateTaskRequestDtoEntityTypeEnum[keyof typeof CreateTaskRequestDtoEntityTypeEnum];
@@ -13,9 +13,15 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.CreateTaskRequestDtoPriorityEnum = void 0;
16
+ exports.CreateTaskRequestDtoEntityTypeEnum = exports.CreateTaskRequestDtoPriorityEnum = void 0;
17
17
  exports.CreateTaskRequestDtoPriorityEnum = {
18
18
  Low: 'LOW',
19
19
  Medium: 'MEDIUM',
20
20
  High: 'HIGH'
21
21
  };
22
+ exports.CreateTaskRequestDtoEntityTypeEnum = {
23
+ Lead: 'LEAD',
24
+ Policy: 'POLICY',
25
+ Claim: 'CLAIM',
26
+ Partner: 'PARTNER'
27
+ };
@@ -1,3 +1,4 @@
1
+ export * from './assignee-class';
1
2
  export * from './category-class';
2
3
  export * from './create-category-request-dto';
3
4
  export * from './create-category-response-class';
@@ -15,14 +16,15 @@ export * from './hub-spot-ticket-error-class';
15
16
  export * from './hub-spot-ticket-name-value-dto';
16
17
  export * from './inline-response200';
17
18
  export * from './inline-response503';
19
+ export * from './list-assignees-response-class';
18
20
  export * from './list-categories-response-class';
19
21
  export * from './list-statuses-response-class';
20
22
  export * from './list-tasks-response-class';
23
+ export * from './patch-category-request-dto';
24
+ export * from './patch-category-response-class';
25
+ export * from './patch-status-request-dto';
26
+ export * from './patch-status-response-class';
27
+ export * from './patch-task-request-dto';
28
+ export * from './patch-task-response-class';
21
29
  export * from './status-class';
22
30
  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';
@@ -14,6 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
14
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./assignee-class"), exports);
17
18
  __exportStar(require("./category-class"), exports);
18
19
  __exportStar(require("./create-category-request-dto"), exports);
19
20
  __exportStar(require("./create-category-response-class"), exports);
@@ -31,14 +32,15 @@ __exportStar(require("./hub-spot-ticket-error-class"), exports);
31
32
  __exportStar(require("./hub-spot-ticket-name-value-dto"), exports);
32
33
  __exportStar(require("./inline-response200"), exports);
33
34
  __exportStar(require("./inline-response503"), exports);
35
+ __exportStar(require("./list-assignees-response-class"), exports);
34
36
  __exportStar(require("./list-categories-response-class"), exports);
35
37
  __exportStar(require("./list-statuses-response-class"), exports);
36
38
  __exportStar(require("./list-tasks-response-class"), exports);
39
+ __exportStar(require("./patch-category-request-dto"), exports);
40
+ __exportStar(require("./patch-category-response-class"), exports);
41
+ __exportStar(require("./patch-status-request-dto"), exports);
42
+ __exportStar(require("./patch-status-response-class"), exports);
43
+ __exportStar(require("./patch-task-request-dto"), exports);
44
+ __exportStar(require("./patch-task-response-class"), exports);
37
45
  __exportStar(require("./status-class"), exports);
38
46
  __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);