@emilgroup/task-sdk 1.0.1-beta.1 → 1.0.1-beta.11

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 (73) hide show
  1. package/.openapi-generator/FILES +9 -11
  2. package/README.md +2 -2
  3. package/api/assignees-api.ts +162 -0
  4. package/api/categories-api.ts +74 -60
  5. package/api/statuses-api.ts +70 -56
  6. package/api/tasks-api.ts +105 -63
  7. package/api.ts +2 -2
  8. package/dist/api/assignees-api.d.ts +96 -0
  9. package/dist/api/assignees-api.js +224 -0
  10. package/dist/api/categories-api.d.ts +58 -49
  11. package/dist/api/categories-api.js +53 -47
  12. package/dist/api/statuses-api.d.ts +54 -45
  13. package/dist/api/statuses-api.js +49 -43
  14. package/dist/api/tasks-api.d.ts +77 -50
  15. package/dist/api/tasks-api.js +66 -48
  16. package/dist/api.d.ts +1 -1
  17. package/dist/api.js +1 -1
  18. package/dist/models/{create-priority-request-dto.d.ts → assignee-class.d.ts} +5 -5
  19. package/dist/models/category-class.d.ts +6 -0
  20. package/dist/models/create-category-request-dto.d.ts +7 -1
  21. package/dist/models/create-status-request-dto.d.ts +7 -1
  22. package/dist/models/create-task-request-dto.d.ts +31 -13
  23. package/dist/models/create-task-request-dto.js +6 -0
  24. package/dist/models/index.d.ts +8 -10
  25. package/dist/models/index.js +8 -10
  26. package/dist/models/list-assignees-response-class.d.ts +43 -0
  27. package/dist/models/patch-category-request-dto.d.ts +36 -0
  28. package/dist/models/{update-category-response-class.d.ts → patch-category-response-class.d.ts} +3 -3
  29. package/dist/models/{update-status-request-dto.d.ts → patch-status-request-dto.d.ts} +13 -7
  30. package/dist/models/{update-status-response-class.d.ts → patch-status-response-class.d.ts} +3 -3
  31. package/dist/models/patch-task-request-dto.d.ts +108 -0
  32. package/dist/models/{update-task-response-class.d.ts → patch-task-response-class.d.ts} +3 -3
  33. package/dist/models/status-class.d.ts +6 -0
  34. package/dist/models/task-class.d.ts +25 -8
  35. package/dist/models/task-class.js +6 -0
  36. package/models/{create-priority-request-dto.ts → assignee-class.ts} +5 -5
  37. package/models/category-class.ts +6 -0
  38. package/models/create-category-request-dto.ts +7 -1
  39. package/models/create-status-request-dto.ts +7 -1
  40. package/models/create-task-request-dto.ts +34 -13
  41. package/models/index.ts +8 -10
  42. package/models/list-assignees-response-class.ts +49 -0
  43. package/models/{update-category-request-dto.ts → patch-category-request-dto.ts} +13 -7
  44. package/models/{update-category-response-class.ts → patch-category-response-class.ts} +3 -3
  45. package/models/{update-status-request-dto.ts → patch-status-request-dto.ts} +13 -7
  46. package/models/{update-status-response-class.ts → patch-status-response-class.ts} +3 -3
  47. package/models/patch-task-request-dto.ts +114 -0
  48. package/models/{update-task-response-class.ts → patch-task-response-class.ts} +3 -3
  49. package/models/status-class.ts +6 -0
  50. package/models/task-class.ts +28 -8
  51. package/package.json +1 -1
  52. package/api/priorities-api.ts +0 -284
  53. package/dist/api/priorities-api.d.ts +0 -162
  54. package/dist/api/priorities-api.js +0 -324
  55. package/dist/models/create-priority-response-class.d.ts +0 -25
  56. package/dist/models/get-priority-response-class.d.ts +0 -25
  57. package/dist/models/priority-class.d.ts +0 -60
  58. package/dist/models/update-category-request-dto.d.ts +0 -30
  59. package/dist/models/update-task-request-dto.d.ts +0 -60
  60. package/dist/models/update-task-request-dto.js +0 -15
  61. package/dist/models/update-task-response-class.js +0 -15
  62. package/models/create-priority-response-class.ts +0 -31
  63. package/models/get-priority-response-class.ts +0 -31
  64. package/models/priority-class.ts +0 -66
  65. package/models/update-task-request-dto.ts +0 -66
  66. /package/dist/models/{create-priority-request-dto.js → assignee-class.js} +0 -0
  67. /package/dist/models/{create-priority-response-class.js → list-assignees-response-class.js} +0 -0
  68. /package/dist/models/{get-priority-response-class.js → patch-category-request-dto.js} +0 -0
  69. /package/dist/models/{priority-class.js → patch-category-response-class.js} +0 -0
  70. /package/dist/models/{update-category-request-dto.js → patch-status-request-dto.js} +0 -0
  71. /package/dist/models/{update-category-response-class.js → patch-status-response-class.js} +0 -0
  72. /package/dist/models/{update-status-request-dto.js → patch-task-request-dto.js} +0 -0
  73. /package/dist/models/{update-status-response-class.js → patch-task-response-class.js} +0 -0
package/api/tasks-api.ts CHANGED
@@ -29,9 +29,9 @@ import { GetTaskResponseClass } from '../models';
29
29
  // @ts-ignore
30
30
  import { ListTasksResponseClass } from '../models';
31
31
  // @ts-ignore
32
- import { UpdateTaskRequestDto } from '../models';
32
+ import { PatchTaskRequestDto } from '../models';
33
33
  // @ts-ignore
34
- import { UpdateTaskResponseClass } from '../models';
34
+ import { PatchTaskResponseClass } from '../models';
35
35
  /**
36
36
  * TasksApi - axios parameter creator
37
37
  * @export
@@ -86,7 +86,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
86
86
  };
87
87
  },
88
88
  /**
89
- * This will delete task.
89
+ * This will delete a task by code.
90
90
  * @summary Delete the task
91
91
  * @param {string} code Unique identifier for the object.
92
92
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -131,7 +131,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
131
131
  };
132
132
  },
133
133
  /**
134
- * This will get task.
134
+ * This will get a task by code.
135
135
  * @summary Retrieve the task
136
136
  * @param {string} code
137
137
  * @param {string} expand
@@ -186,14 +186,17 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
186
186
  * Retrieves a list of tasks.
187
187
  * @summary List tasks
188
188
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
189
- * @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, priorityId, createdAt</i>
190
- * @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, priorityId, createdAt</i>
191
- * @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</i>
192
- * @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, priority<i>
189
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
190
+ * @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.
191
+ * @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>
192
+ * @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>
193
+ * @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>
194
+ * @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>
195
+ * @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>
193
196
  * @param {*} [options] Override http request option.
194
197
  * @throws {RequiredError}
195
198
  */
196
- listTasks: async (authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
199
+ listTasks: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
197
200
  const localVarPath = `/taskservice/v1/tasks`;
198
201
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
199
202
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -212,12 +215,20 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
212
215
  // http bearer authentication required
213
216
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
214
217
 
218
+ if (pageSize !== undefined) {
219
+ localVarQueryParameter['pageSize'] = pageSize;
220
+ }
221
+
222
+ if (pageToken !== undefined) {
223
+ localVarQueryParameter['pageToken'] = pageToken;
224
+ }
225
+
215
226
  if (filter !== undefined) {
216
227
  localVarQueryParameter['filter'] = filter;
217
228
  }
218
229
 
219
- if (filters !== undefined) {
220
- localVarQueryParameter['filters'] = filters;
230
+ if (search !== undefined) {
231
+ localVarQueryParameter['search'] = search;
221
232
  }
222
233
 
223
234
  if (order !== undefined) {
@@ -228,6 +239,10 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
228
239
  localVarQueryParameter['expand'] = expand;
229
240
  }
230
241
 
242
+ if (filters !== undefined) {
243
+ localVarQueryParameter['filters'] = filters;
244
+ }
245
+
231
246
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
232
247
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
233
248
  }
@@ -244,19 +259,19 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
244
259
  };
245
260
  },
246
261
  /**
247
- * This will update task.
262
+ * This will partially update a task by code with the provided fields.
248
263
  * @summary Update the task
249
264
  * @param {string} code
250
- * @param {UpdateTaskRequestDto} updateTaskRequestDto
265
+ * @param {PatchTaskRequestDto} patchTaskRequestDto
251
266
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
252
267
  * @param {*} [options] Override http request option.
253
268
  * @throws {RequiredError}
254
269
  */
255
- updateTask: async (code: string, updateTaskRequestDto: UpdateTaskRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
270
+ patchTask: async (code: string, patchTaskRequestDto: PatchTaskRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
256
271
  // verify required parameter 'code' is not null or undefined
257
- assertParamExists('updateTask', 'code', code)
258
- // verify required parameter 'updateTaskRequestDto' is not null or undefined
259
- assertParamExists('updateTask', 'updateTaskRequestDto', updateTaskRequestDto)
272
+ assertParamExists('patchTask', 'code', code)
273
+ // verify required parameter 'patchTaskRequestDto' is not null or undefined
274
+ assertParamExists('patchTask', 'patchTaskRequestDto', patchTaskRequestDto)
260
275
  const localVarPath = `/taskservice/v1/tasks/{code}`
261
276
  .replace(`{${"code"}}`, encodeURIComponent(String(code)));
262
277
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -268,7 +283,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
268
283
  baseAccessToken = configuration.accessToken;
269
284
  }
270
285
 
271
- const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
286
+ const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
272
287
  const localVarHeaderParameter = {} as any;
273
288
  const localVarQueryParameter = {} as any;
274
289
 
@@ -287,7 +302,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
287
302
  setSearchParams(localVarUrlObj, localVarQueryParameter);
288
303
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
289
304
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
290
- localVarRequestOptions.data = serializeDataIfNeeded(updateTaskRequestDto, localVarRequestOptions, configuration)
305
+ localVarRequestOptions.data = serializeDataIfNeeded(patchTaskRequestDto, localVarRequestOptions, configuration)
291
306
 
292
307
  return {
293
308
  url: toPathString(localVarUrlObj),
@@ -317,7 +332,7 @@ export const TasksApiFp = function(configuration?: Configuration) {
317
332
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
318
333
  },
319
334
  /**
320
- * This will delete task.
335
+ * This will delete a task by code.
321
336
  * @summary Delete the task
322
337
  * @param {string} code Unique identifier for the object.
323
338
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -329,7 +344,7 @@ export const TasksApiFp = function(configuration?: Configuration) {
329
344
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
330
345
  },
331
346
  /**
332
- * This will get task.
347
+ * This will get a task by code.
333
348
  * @summary Retrieve the task
334
349
  * @param {string} code
335
350
  * @param {string} expand
@@ -345,28 +360,31 @@ export const TasksApiFp = function(configuration?: Configuration) {
345
360
  * Retrieves a list of tasks.
346
361
  * @summary List tasks
347
362
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
348
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, categoryId, statusId, priorityId, createdAt&lt;/i&gt;
349
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, categoryId, statusId, priorityId, createdAt&lt;/i&gt;
350
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt&lt;/i&gt;
351
- * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: category, status, priority&lt;i&gt;
363
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
364
+ * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
365
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, categories.slug&lt;/i&gt;
366
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: subject, description&lt;/i&gt;
367
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, updatedAt, assignee, reporter, dueDate&lt;/i&gt;
368
+ * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: categories, status&lt;i&gt;
369
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, categories.slug&lt;/i&gt;
352
370
  * @param {*} [options] Override http request option.
353
371
  * @throws {RequiredError}
354
372
  */
355
- async listTasks(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTasksResponseClass>> {
356
- const localVarAxiosArgs = await localVarAxiosParamCreator.listTasks(authorization, filter, filters, order, expand, options);
373
+ 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>> {
374
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listTasks(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
357
375
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
358
376
  },
359
377
  /**
360
- * This will update task.
378
+ * This will partially update a task by code with the provided fields.
361
379
  * @summary Update the task
362
380
  * @param {string} code
363
- * @param {UpdateTaskRequestDto} updateTaskRequestDto
381
+ * @param {PatchTaskRequestDto} patchTaskRequestDto
364
382
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
365
383
  * @param {*} [options] Override http request option.
366
384
  * @throws {RequiredError}
367
385
  */
368
- async updateTask(code: string, updateTaskRequestDto: UpdateTaskRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateTaskResponseClass>> {
369
- const localVarAxiosArgs = await localVarAxiosParamCreator.updateTask(code, updateTaskRequestDto, authorization, options);
386
+ async patchTask(code: string, patchTaskRequestDto: PatchTaskRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PatchTaskResponseClass>> {
387
+ const localVarAxiosArgs = await localVarAxiosParamCreator.patchTask(code, patchTaskRequestDto, authorization, options);
370
388
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
371
389
  },
372
390
  }
@@ -391,7 +409,7 @@ export const TasksApiFactory = function (configuration?: Configuration, basePath
391
409
  return localVarFp.createTask(createTaskRequestDto, authorization, options).then((request) => request(axios, basePath));
392
410
  },
393
411
  /**
394
- * This will delete task.
412
+ * This will delete a task by code.
395
413
  * @summary Delete the task
396
414
  * @param {string} code Unique identifier for the object.
397
415
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -402,7 +420,7 @@ export const TasksApiFactory = function (configuration?: Configuration, basePath
402
420
  return localVarFp.deleteTask(code, authorization, options).then((request) => request(axios, basePath));
403
421
  },
404
422
  /**
405
- * This will get task.
423
+ * This will get a task by code.
406
424
  * @summary Retrieve the task
407
425
  * @param {string} code
408
426
  * @param {string} expand
@@ -417,27 +435,30 @@ export const TasksApiFactory = function (configuration?: Configuration, basePath
417
435
  * Retrieves a list of tasks.
418
436
  * @summary List tasks
419
437
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
420
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, categoryId, statusId, priorityId, createdAt&lt;/i&gt;
421
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, categoryId, statusId, priorityId, createdAt&lt;/i&gt;
422
- * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt&lt;/i&gt;
423
- * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: category, status, priority&lt;i&gt;
438
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
439
+ * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
440
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, categories.slug&lt;/i&gt;
441
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: subject, description&lt;/i&gt;
442
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, updatedAt, assignee, reporter, dueDate&lt;/i&gt;
443
+ * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: categories, status&lt;i&gt;
444
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, categories.slug&lt;/i&gt;
424
445
  * @param {*} [options] Override http request option.
425
446
  * @throws {RequiredError}
426
447
  */
427
- listTasks(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListTasksResponseClass> {
428
- return localVarFp.listTasks(authorization, filter, filters, order, expand, options).then((request) => request(axios, basePath));
448
+ listTasks(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListTasksResponseClass> {
449
+ return localVarFp.listTasks(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
429
450
  },
430
451
  /**
431
- * This will update task.
452
+ * This will partially update a task by code with the provided fields.
432
453
  * @summary Update the task
433
454
  * @param {string} code
434
- * @param {UpdateTaskRequestDto} updateTaskRequestDto
455
+ * @param {PatchTaskRequestDto} patchTaskRequestDto
435
456
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
436
457
  * @param {*} [options] Override http request option.
437
458
  * @throws {RequiredError}
438
459
  */
439
- updateTask(code: string, updateTaskRequestDto: UpdateTaskRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateTaskResponseClass> {
440
- return localVarFp.updateTask(code, updateTaskRequestDto, authorization, options).then((request) => request(axios, basePath));
460
+ patchTask(code: string, patchTaskRequestDto: PatchTaskRequestDto, authorization?: string, options?: any): AxiosPromise<PatchTaskResponseClass> {
461
+ return localVarFp.patchTask(code, patchTaskRequestDto, authorization, options).then((request) => request(axios, basePath));
441
462
  },
442
463
  };
443
464
  };
@@ -526,58 +547,79 @@ export interface TasksApiListTasksRequest {
526
547
  readonly authorization?: string
527
548
 
528
549
  /**
529
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, categoryId, statusId, priorityId, createdAt&lt;/i&gt;
550
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
551
+ * @type {number}
552
+ * @memberof TasksApiListTasks
553
+ */
554
+ readonly pageSize?: number
555
+
556
+ /**
557
+ * 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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
558
+ * @type {string}
559
+ * @memberof TasksApiListTasks
560
+ */
561
+ readonly pageToken?: string
562
+
563
+ /**
564
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, categories.slug&lt;/i&gt;
530
565
  * @type {string}
531
566
  * @memberof TasksApiListTasks
532
567
  */
533
568
  readonly filter?: string
534
569
 
535
570
  /**
536
- * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, categoryId, statusId, priorityId, createdAt&lt;/i&gt;
571
+ * Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: subject, description&lt;/i&gt;
537
572
  * @type {string}
538
573
  * @memberof TasksApiListTasks
539
574
  */
540
- readonly filters?: string
575
+ readonly search?: string
541
576
 
542
577
  /**
543
- * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt&lt;/i&gt;
578
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, updatedAt, assignee, reporter, dueDate&lt;/i&gt;
544
579
  * @type {string}
545
580
  * @memberof TasksApiListTasks
546
581
  */
547
582
  readonly order?: string
548
583
 
549
584
  /**
550
- * 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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: category, status, priority&lt;i&gt;
585
+ * 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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: categories, status&lt;i&gt;
551
586
  * @type {string}
552
587
  * @memberof TasksApiListTasks
553
588
  */
554
589
  readonly expand?: string
590
+
591
+ /**
592
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, categories.slug&lt;/i&gt;
593
+ * @type {string}
594
+ * @memberof TasksApiListTasks
595
+ */
596
+ readonly filters?: string
555
597
  }
556
598
 
557
599
  /**
558
- * Request parameters for updateTask operation in TasksApi.
600
+ * Request parameters for patchTask operation in TasksApi.
559
601
  * @export
560
- * @interface TasksApiUpdateTaskRequest
602
+ * @interface TasksApiPatchTaskRequest
561
603
  */
562
- export interface TasksApiUpdateTaskRequest {
604
+ export interface TasksApiPatchTaskRequest {
563
605
  /**
564
606
  *
565
607
  * @type {string}
566
- * @memberof TasksApiUpdateTask
608
+ * @memberof TasksApiPatchTask
567
609
  */
568
610
  readonly code: string
569
611
 
570
612
  /**
571
613
  *
572
- * @type {UpdateTaskRequestDto}
573
- * @memberof TasksApiUpdateTask
614
+ * @type {PatchTaskRequestDto}
615
+ * @memberof TasksApiPatchTask
574
616
  */
575
- readonly updateTaskRequestDto: UpdateTaskRequestDto
617
+ readonly patchTaskRequestDto: PatchTaskRequestDto
576
618
 
577
619
  /**
578
620
  * Bearer Token: provided by the login endpoint under the name accessToken.
579
621
  * @type {string}
580
- * @memberof TasksApiUpdateTask
622
+ * @memberof TasksApiPatchTask
581
623
  */
582
624
  readonly authorization?: string
583
625
  }
@@ -602,7 +644,7 @@ export class TasksApi extends BaseAPI {
602
644
  }
603
645
 
604
646
  /**
605
- * This will delete task.
647
+ * This will delete a task by code.
606
648
  * @summary Delete the task
607
649
  * @param {TasksApiDeleteTaskRequest} requestParameters Request parameters.
608
650
  * @param {*} [options] Override http request option.
@@ -614,7 +656,7 @@ export class TasksApi extends BaseAPI {
614
656
  }
615
657
 
616
658
  /**
617
- * This will get task.
659
+ * This will get a task by code.
618
660
  * @summary Retrieve the task
619
661
  * @param {TasksApiGetTaskRequest} requestParameters Request parameters.
620
662
  * @param {*} [options] Override http request option.
@@ -634,18 +676,18 @@ export class TasksApi extends BaseAPI {
634
676
  * @memberof TasksApi
635
677
  */
636
678
  public listTasks(requestParameters: TasksApiListTasksRequest = {}, options?: AxiosRequestConfig) {
637
- return TasksApiFp(this.configuration).listTasks(requestParameters.authorization, requestParameters.filter, requestParameters.filters, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
679
+ 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));
638
680
  }
639
681
 
640
682
  /**
641
- * This will update task.
683
+ * This will partially update a task by code with the provided fields.
642
684
  * @summary Update the task
643
- * @param {TasksApiUpdateTaskRequest} requestParameters Request parameters.
685
+ * @param {TasksApiPatchTaskRequest} requestParameters Request parameters.
644
686
  * @param {*} [options] Override http request option.
645
687
  * @throws {RequiredError}
646
688
  * @memberof TasksApi
647
689
  */
648
- public updateTask(requestParameters: TasksApiUpdateTaskRequest, options?: AxiosRequestConfig) {
649
- return TasksApiFp(this.configuration).updateTask(requestParameters.code, requestParameters.updateTaskRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
690
+ public patchTask(requestParameters: TasksApiPatchTaskRequest, options?: AxiosRequestConfig) {
691
+ return TasksApiFp(this.configuration).patchTask(requestParameters.code, requestParameters.patchTaskRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
650
692
  }
651
693
  }
package/api.ts CHANGED
@@ -20,18 +20,18 @@ import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig, AxiosResp
20
20
  import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
21
21
  // @ts-ignore
22
22
  import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base';
23
+ import { AssigneesApi } from './api';
23
24
  import { CategoriesApi } from './api';
24
25
  import { DefaultApi } from './api';
25
26
  import { HubSpotApi } from './api';
26
- import { PrioritiesApi } from './api';
27
27
  import { StatusesApi } from './api';
28
28
  import { TasksApi } from './api';
29
29
 
30
30
 
31
+ export * from './api/assignees-api';
31
32
  export * from './api/categories-api';
32
33
  export * from './api/default-api';
33
34
  export * from './api/hub-spot-api';
34
- export * from './api/priorities-api';
35
35
  export * from './api/statuses-api';
36
36
  export * from './api/tasks-api';
37
37
 
@@ -0,0 +1,96 @@
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
+ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
+ import { Configuration } from '../configuration';
14
+ import { RequestArgs, BaseAPI } from '../base';
15
+ import { ListAssigneesResponseClass } from '../models';
16
+ /**
17
+ * AssigneesApi - axios parameter creator
18
+ * @export
19
+ */
20
+ export declare const AssigneesApiAxiosParamCreator: (configuration?: Configuration) => {
21
+ /**
22
+ * Retrieves a list of distinct assignees from tasks.
23
+ * @summary List assignees
24
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
25
+ * @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.&lt;br/&gt; &lt;br/&gt;
26
+ * @param {*} [options] Override http request option.
27
+ * @throws {RequiredError}
28
+ */
29
+ listAssignees: (authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
30
+ };
31
+ /**
32
+ * AssigneesApi - functional programming interface
33
+ * @export
34
+ */
35
+ export declare const AssigneesApiFp: (configuration?: Configuration) => {
36
+ /**
37
+ * Retrieves a list of distinct assignees from tasks.
38
+ * @summary List assignees
39
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
40
+ * @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.&lt;br/&gt; &lt;br/&gt;
41
+ * @param {*} [options] Override http request option.
42
+ * @throws {RequiredError}
43
+ */
44
+ listAssignees(authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListAssigneesResponseClass>>;
45
+ };
46
+ /**
47
+ * AssigneesApi - factory interface
48
+ * @export
49
+ */
50
+ export declare const AssigneesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
51
+ /**
52
+ * Retrieves a list of distinct assignees from tasks.
53
+ * @summary List assignees
54
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
55
+ * @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.&lt;br/&gt; &lt;br/&gt;
56
+ * @param {*} [options] Override http request option.
57
+ * @throws {RequiredError}
58
+ */
59
+ listAssignees(authorization?: string, expand?: string, options?: any): AxiosPromise<ListAssigneesResponseClass>;
60
+ };
61
+ /**
62
+ * Request parameters for listAssignees operation in AssigneesApi.
63
+ * @export
64
+ * @interface AssigneesApiListAssigneesRequest
65
+ */
66
+ export interface AssigneesApiListAssigneesRequest {
67
+ /**
68
+ * Bearer Token: provided by the login endpoint under the name accessToken.
69
+ * @type {string}
70
+ * @memberof AssigneesApiListAssignees
71
+ */
72
+ readonly authorization?: string;
73
+ /**
74
+ * 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.&lt;br/&gt; &lt;br/&gt;
75
+ * @type {string}
76
+ * @memberof AssigneesApiListAssignees
77
+ */
78
+ readonly expand?: string;
79
+ }
80
+ /**
81
+ * AssigneesApi - object-oriented interface
82
+ * @export
83
+ * @class AssigneesApi
84
+ * @extends {BaseAPI}
85
+ */
86
+ export declare class AssigneesApi extends BaseAPI {
87
+ /**
88
+ * Retrieves a list of distinct assignees from tasks.
89
+ * @summary List assignees
90
+ * @param {AssigneesApiListAssigneesRequest} requestParameters Request parameters.
91
+ * @param {*} [options] Override http request option.
92
+ * @throws {RequiredError}
93
+ * @memberof AssigneesApi
94
+ */
95
+ listAssignees(requestParameters?: AssigneesApiListAssigneesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListAssigneesResponseClass, any, {}>>;
96
+ }