@emilgroup/task-sdk-node 1.0.1-beta.1 → 1.0.1-beta.10

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 (68) hide show
  1. package/.openapi-generator/FILES +6 -11
  2. package/README.md +2 -2
  3. package/api/categories-api.ts +74 -60
  4. package/api/statuses-api.ts +70 -56
  5. package/api/tasks-api.ts +105 -63
  6. package/api.ts +0 -2
  7. package/dist/api/categories-api.d.ts +58 -49
  8. package/dist/api/categories-api.js +53 -47
  9. package/dist/api/statuses-api.d.ts +54 -45
  10. package/dist/api/statuses-api.js +49 -43
  11. package/dist/api/tasks-api.d.ts +77 -50
  12. package/dist/api/tasks-api.js +66 -48
  13. package/dist/api.d.ts +0 -1
  14. package/dist/api.js +0 -1
  15. package/dist/models/category-class.d.ts +6 -0
  16. package/dist/models/create-category-request-dto.d.ts +7 -1
  17. package/dist/models/create-status-request-dto.d.ts +7 -1
  18. package/dist/models/create-task-request-dto.d.ts +31 -13
  19. package/dist/models/create-task-request-dto.js +6 -0
  20. package/dist/models/index.d.ts +6 -10
  21. package/dist/models/index.js +6 -10
  22. package/dist/models/patch-category-request-dto.d.ts +36 -0
  23. package/dist/models/{update-category-response-class.d.ts → patch-category-response-class.d.ts} +3 -3
  24. package/dist/models/{update-status-request-dto.d.ts → patch-status-request-dto.d.ts} +13 -7
  25. package/dist/models/{update-status-response-class.d.ts → patch-status-response-class.d.ts} +3 -3
  26. package/dist/models/patch-task-request-dto.d.ts +108 -0
  27. package/dist/models/{update-task-response-class.d.ts → patch-task-response-class.d.ts} +3 -3
  28. package/dist/models/status-class.d.ts +6 -0
  29. package/dist/models/task-class.d.ts +25 -8
  30. package/dist/models/task-class.js +6 -0
  31. package/models/category-class.ts +6 -0
  32. package/models/create-category-request-dto.ts +7 -1
  33. package/models/create-status-request-dto.ts +7 -1
  34. package/models/create-task-request-dto.ts +34 -13
  35. package/models/index.ts +6 -10
  36. package/models/{update-category-request-dto.ts → patch-category-request-dto.ts} +13 -7
  37. package/models/{update-category-response-class.ts → patch-category-response-class.ts} +3 -3
  38. package/models/{update-status-request-dto.ts → patch-status-request-dto.ts} +13 -7
  39. package/models/{update-status-response-class.ts → patch-status-response-class.ts} +3 -3
  40. package/models/patch-task-request-dto.ts +114 -0
  41. package/models/{update-task-response-class.ts → patch-task-response-class.ts} +3 -3
  42. package/models/status-class.ts +6 -0
  43. package/models/task-class.ts +28 -8
  44. package/package.json +1 -1
  45. package/api/priorities-api.ts +0 -288
  46. package/dist/api/priorities-api.d.ts +0 -162
  47. package/dist/api/priorities-api.js +0 -328
  48. package/dist/models/create-priority-request-dto.d.ts +0 -24
  49. package/dist/models/create-priority-response-class.d.ts +0 -25
  50. package/dist/models/get-priority-response-class.d.ts +0 -25
  51. package/dist/models/priority-class.d.ts +0 -60
  52. package/dist/models/update-category-request-dto.d.ts +0 -30
  53. package/dist/models/update-status-request-dto.js +0 -15
  54. package/dist/models/update-status-response-class.js +0 -15
  55. package/dist/models/update-task-request-dto.d.ts +0 -60
  56. package/dist/models/update-task-request-dto.js +0 -15
  57. package/dist/models/update-task-response-class.js +0 -15
  58. package/models/create-priority-request-dto.ts +0 -30
  59. package/models/create-priority-response-class.ts +0 -31
  60. package/models/get-priority-response-class.ts +0 -31
  61. package/models/priority-class.ts +0 -66
  62. package/models/update-task-request-dto.ts +0 -66
  63. /package/dist/models/{create-priority-request-dto.js → patch-category-request-dto.js} +0 -0
  64. /package/dist/models/{create-priority-response-class.js → patch-category-response-class.js} +0 -0
  65. /package/dist/models/{get-priority-response-class.js → patch-status-request-dto.js} +0 -0
  66. /package/dist/models/{priority-class.js → patch-status-response-class.js} +0 -0
  67. /package/dist/models/{update-category-request-dto.js → patch-task-request-dto.js} +0 -0
  68. /package/dist/models/{update-category-response-class.js → patch-task-response-class.js} +0 -0
@@ -6,7 +6,6 @@ api.ts
6
6
  api/categories-api.ts
7
7
  api/default-api.ts
8
8
  api/hub-spot-api.ts
9
- api/priorities-api.ts
10
9
  api/statuses-api.ts
11
10
  api/tasks-api.ts
12
11
  base.ts
@@ -19,14 +18,11 @@ models/create-category-request-dto.ts
19
18
  models/create-category-response-class.ts
20
19
  models/create-hub-spot-ticket-request-dto.ts
21
20
  models/create-hub-spot-ticket-response-class.ts
22
- models/create-priority-request-dto.ts
23
- models/create-priority-response-class.ts
24
21
  models/create-status-request-dto.ts
25
22
  models/create-status-response-class.ts
26
23
  models/create-task-request-dto.ts
27
24
  models/create-task-response-class.ts
28
25
  models/get-category-response-class.ts
29
- models/get-priority-response-class.ts
30
26
  models/get-status-response-class.ts
31
27
  models/get-task-response-class.ts
32
28
  models/hub-spot-ticket-class.ts
@@ -38,14 +34,13 @@ models/inline-response503.ts
38
34
  models/list-categories-response-class.ts
39
35
  models/list-statuses-response-class.ts
40
36
  models/list-tasks-response-class.ts
41
- models/priority-class.ts
37
+ models/patch-category-request-dto.ts
38
+ models/patch-category-response-class.ts
39
+ models/patch-status-request-dto.ts
40
+ models/patch-status-response-class.ts
41
+ models/patch-task-request-dto.ts
42
+ models/patch-task-response-class.ts
42
43
  models/status-class.ts
43
44
  models/task-class.ts
44
- models/update-category-request-dto.ts
45
- models/update-category-response-class.ts
46
- models/update-status-request-dto.ts
47
- models/update-status-response-class.ts
48
- models/update-task-request-dto.ts
49
- models/update-task-response-class.ts
50
45
  package.json
51
46
  tsconfig.json
package/README.md CHANGED
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
17
17
  Navigate to the folder of your consuming project and run one of the following commands:
18
18
 
19
19
  ```
20
- npm install @emilgroup/task-sdk-node@1.0.1-beta.1 --save
20
+ npm install @emilgroup/task-sdk-node@1.0.1-beta.10 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/task-sdk-node@1.0.1-beta.1
24
+ yarn add @emilgroup/task-sdk-node@1.0.1-beta.10
25
25
  ```
26
26
 
27
27
  And then you can import `TasksApi`.
@@ -29,9 +29,9 @@ import { GetCategoryResponseClass } from '../models';
29
29
  // @ts-ignore
30
30
  import { ListCategoriesResponseClass } from '../models';
31
31
  // @ts-ignore
32
- import { UpdateCategoryRequestDto } from '../models';
32
+ import { PatchCategoryRequestDto } from '../models';
33
33
  // @ts-ignore
34
- import { UpdateCategoryResponseClass } from '../models';
34
+ import { PatchCategoryResponseClass } 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 CategoriesApiAxiosParamCreator = function (configuration?: Configuration) {
44
44
  return {
45
45
  /**
46
- * This will create category.
46
+ * This will create a category.
47
47
  * @summary Create the category
48
48
  * @param {CreateCategoryRequestDto} createCategoryRequestDto
49
49
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -90,7 +90,7 @@ export const CategoriesApiAxiosParamCreator = function (configuration?: Configur
90
90
  };
91
91
  },
92
92
  /**
93
- * This will delete category.
93
+ * This will delete a task category by code.
94
94
  * @summary Delete the category
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,7 +135,7 @@ export const CategoriesApiAxiosParamCreator = function (configuration?: Configur
135
135
  };
136
136
  },
137
137
  /**
138
- * This will get category.
138
+ * Get category by code.
139
139
  * @summary Retrieve the category
140
140
  * @param {string} code
141
141
  * @param {string} expand
@@ -190,14 +190,15 @@ export const CategoriesApiAxiosParamCreator = function (configuration?: Configur
190
190
  * Retrieves a list of categories.
191
191
  * @summary List categories
192
192
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
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, createdAt</i>
194
- * @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, createdAt</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</i>
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, slug, name, createdAt, updatedAt</i>
194
+ * @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, slug, name, createdAt, updatedAt</i>
195
+ * @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, name, slug</i>
196
+ * @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, name, slug</i>
196
197
  * @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/>
197
198
  * @param {*} [options] Override http request option.
198
199
  * @throws {RequiredError}
199
200
  */
200
- listCategories: async (authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
201
+ listCategories: async (authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
201
202
  const localVarPath = `/taskservice/v1/categories`;
202
203
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
203
204
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -224,6 +225,10 @@ export const CategoriesApiAxiosParamCreator = function (configuration?: Configur
224
225
  localVarQueryParameter['filters'] = filters;
225
226
  }
226
227
 
228
+ if (search !== undefined) {
229
+ localVarQueryParameter['search'] = search;
230
+ }
231
+
227
232
  if (order !== undefined) {
228
233
  localVarQueryParameter['order'] = order;
229
234
  }
@@ -248,19 +253,19 @@ export const CategoriesApiAxiosParamCreator = function (configuration?: Configur
248
253
  };
249
254
  },
250
255
  /**
251
- * This will update category.
256
+ * This will partially update a category by code with the provided fields.
252
257
  * @summary Update the category
253
258
  * @param {string} code
254
- * @param {UpdateCategoryRequestDto} updateCategoryRequestDto
259
+ * @param {PatchCategoryRequestDto} patchCategoryRequestDto
255
260
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
256
261
  * @param {*} [options] Override http request option.
257
262
  * @throws {RequiredError}
258
263
  */
259
- updateCategory: async (code: string, updateCategoryRequestDto: UpdateCategoryRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
264
+ patchCategory: async (code: string, patchCategoryRequestDto: PatchCategoryRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
260
265
  // verify required parameter 'code' is not null or undefined
261
- assertParamExists('updateCategory', 'code', code)
262
- // verify required parameter 'updateCategoryRequestDto' is not null or undefined
263
- assertParamExists('updateCategory', 'updateCategoryRequestDto', updateCategoryRequestDto)
266
+ assertParamExists('patchCategory', 'code', code)
267
+ // verify required parameter 'patchCategoryRequestDto' is not null or undefined
268
+ assertParamExists('patchCategory', 'patchCategoryRequestDto', patchCategoryRequestDto)
264
269
  const localVarPath = `/taskservice/v1/categories/{code}`
265
270
  .replace(`{${"code"}}`, encodeURIComponent(String(code)));
266
271
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -272,7 +277,7 @@ export const CategoriesApiAxiosParamCreator = function (configuration?: Configur
272
277
  baseAccessToken = configuration.accessToken;
273
278
  }
274
279
 
275
- const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
280
+ const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
276
281
  const localVarHeaderParameter = {} as any;
277
282
  const localVarQueryParameter = {} as any;
278
283
 
@@ -291,7 +296,7 @@ export const CategoriesApiAxiosParamCreator = function (configuration?: Configur
291
296
  setSearchParams(localVarUrlObj, localVarQueryParameter);
292
297
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
293
298
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
294
- localVarRequestOptions.data = serializeDataIfNeeded(updateCategoryRequestDto, localVarRequestOptions, configuration)
299
+ localVarRequestOptions.data = serializeDataIfNeeded(patchCategoryRequestDto, localVarRequestOptions, configuration)
295
300
 
296
301
  return {
297
302
  url: toPathString(localVarUrlObj),
@@ -309,7 +314,7 @@ export const CategoriesApiFp = function(configuration?: Configuration) {
309
314
  const localVarAxiosParamCreator = CategoriesApiAxiosParamCreator(configuration)
310
315
  return {
311
316
  /**
312
- * This will create category.
317
+ * This will create a category.
313
318
  * @summary Create the category
314
319
  * @param {CreateCategoryRequestDto} createCategoryRequestDto
315
320
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -321,7 +326,7 @@ export const CategoriesApiFp = function(configuration?: Configuration) {
321
326
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
322
327
  },
323
328
  /**
324
- * This will delete category.
329
+ * This will delete a task category by code.
325
330
  * @summary Delete the category
326
331
  * @param {string} code Unique identifier for the object.
327
332
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -333,7 +338,7 @@ export const CategoriesApiFp = function(configuration?: Configuration) {
333
338
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
334
339
  },
335
340
  /**
336
- * This will get category.
341
+ * Get category by code.
337
342
  * @summary Retrieve the category
338
343
  * @param {string} code
339
344
  * @param {string} expand
@@ -349,28 +354,29 @@ export const CategoriesApiFp = function(configuration?: Configuration) {
349
354
  * Retrieves a list of categories.
350
355
  * @summary List categories
351
356
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
352
- * @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, createdAt&lt;/i&gt;
353
- * @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, createdAt&lt;/i&gt;
354
- * @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;
357
+ * @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, slug, name, createdAt, updatedAt&lt;/i&gt;
358
+ * @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, slug, name, createdAt, updatedAt&lt;/i&gt;
359
+ * @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: id, code, name, slug&lt;/i&gt;
360
+ * @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, name, slug&lt;/i&gt;
355
361
  * @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;
356
362
  * @param {*} [options] Override http request option.
357
363
  * @throws {RequiredError}
358
364
  */
359
- async listCategories(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCategoriesResponseClass>> {
360
- const localVarAxiosArgs = await localVarAxiosParamCreator.listCategories(authorization, filter, filters, order, expand, options);
365
+ async listCategories(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCategoriesResponseClass>> {
366
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listCategories(authorization, filter, filters, search, order, expand, options);
361
367
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
362
368
  },
363
369
  /**
364
- * This will update category.
370
+ * This will partially update a category by code with the provided fields.
365
371
  * @summary Update the category
366
372
  * @param {string} code
367
- * @param {UpdateCategoryRequestDto} updateCategoryRequestDto
373
+ * @param {PatchCategoryRequestDto} patchCategoryRequestDto
368
374
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
369
375
  * @param {*} [options] Override http request option.
370
376
  * @throws {RequiredError}
371
377
  */
372
- async updateCategory(code: string, updateCategoryRequestDto: UpdateCategoryRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCategoryResponseClass>> {
373
- const localVarAxiosArgs = await localVarAxiosParamCreator.updateCategory(code, updateCategoryRequestDto, authorization, options);
378
+ async patchCategory(code: string, patchCategoryRequestDto: PatchCategoryRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PatchCategoryResponseClass>> {
379
+ const localVarAxiosArgs = await localVarAxiosParamCreator.patchCategory(code, patchCategoryRequestDto, authorization, options);
374
380
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
375
381
  },
376
382
  }
@@ -384,7 +390,7 @@ export const CategoriesApiFactory = function (configuration?: Configuration, bas
384
390
  const localVarFp = CategoriesApiFp(configuration)
385
391
  return {
386
392
  /**
387
- * This will create category.
393
+ * This will create a category.
388
394
  * @summary Create the category
389
395
  * @param {CreateCategoryRequestDto} createCategoryRequestDto
390
396
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -395,7 +401,7 @@ export const CategoriesApiFactory = function (configuration?: Configuration, bas
395
401
  return localVarFp.createCategory(createCategoryRequestDto, authorization, options).then((request) => request(axios, basePath));
396
402
  },
397
403
  /**
398
- * This will delete category.
404
+ * This will delete a task category by code.
399
405
  * @summary Delete the category
400
406
  * @param {string} code Unique identifier for the object.
401
407
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -406,7 +412,7 @@ export const CategoriesApiFactory = function (configuration?: Configuration, bas
406
412
  return localVarFp.deleteCategory(code, authorization, options).then((request) => request(axios, basePath));
407
413
  },
408
414
  /**
409
- * This will get category.
415
+ * Get category by code.
410
416
  * @summary Retrieve the category
411
417
  * @param {string} code
412
418
  * @param {string} expand
@@ -421,27 +427,28 @@ export const CategoriesApiFactory = function (configuration?: Configuration, bas
421
427
  * Retrieves a list of categories.
422
428
  * @summary List categories
423
429
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
424
- * @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, createdAt&lt;/i&gt;
425
- * @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, createdAt&lt;/i&gt;
426
- * @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;
430
+ * @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, slug, name, createdAt, updatedAt&lt;/i&gt;
431
+ * @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, slug, name, createdAt, updatedAt&lt;/i&gt;
432
+ * @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: id, code, name, slug&lt;/i&gt;
433
+ * @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, name, slug&lt;/i&gt;
427
434
  * @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;
428
435
  * @param {*} [options] Override http request option.
429
436
  * @throws {RequiredError}
430
437
  */
431
- listCategories(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListCategoriesResponseClass> {
432
- return localVarFp.listCategories(authorization, filter, filters, order, expand, options).then((request) => request(axios, basePath));
438
+ listCategories(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListCategoriesResponseClass> {
439
+ return localVarFp.listCategories(authorization, filter, filters, search, order, expand, options).then((request) => request(axios, basePath));
433
440
  },
434
441
  /**
435
- * This will update category.
442
+ * This will partially update a category by code with the provided fields.
436
443
  * @summary Update the category
437
444
  * @param {string} code
438
- * @param {UpdateCategoryRequestDto} updateCategoryRequestDto
445
+ * @param {PatchCategoryRequestDto} patchCategoryRequestDto
439
446
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
440
447
  * @param {*} [options] Override http request option.
441
448
  * @throws {RequiredError}
442
449
  */
443
- updateCategory(code: string, updateCategoryRequestDto: UpdateCategoryRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateCategoryResponseClass> {
444
- return localVarFp.updateCategory(code, updateCategoryRequestDto, authorization, options).then((request) => request(axios, basePath));
450
+ patchCategory(code: string, patchCategoryRequestDto: PatchCategoryRequestDto, authorization?: string, options?: any): AxiosPromise<PatchCategoryResponseClass> {
451
+ return localVarFp.patchCategory(code, patchCategoryRequestDto, authorization, options).then((request) => request(axios, basePath));
445
452
  },
446
453
  };
447
454
  };
@@ -530,21 +537,28 @@ export interface CategoriesApiListCategoriesRequest {
530
537
  readonly authorization?: string
531
538
 
532
539
  /**
533
- * 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, createdAt&lt;/i&gt;
540
+ * 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, slug, name, createdAt, updatedAt&lt;/i&gt;
534
541
  * @type {string}
535
542
  * @memberof CategoriesApiListCategories
536
543
  */
537
544
  readonly filter?: string
538
545
 
539
546
  /**
540
- * 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, createdAt&lt;/i&gt;
547
+ * 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, slug, name, createdAt, updatedAt&lt;/i&gt;
541
548
  * @type {string}
542
549
  * @memberof CategoriesApiListCategories
543
550
  */
544
551
  readonly filters?: string
545
552
 
546
553
  /**
547
- * 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;
554
+ * 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: id, code, name, slug&lt;/i&gt;
555
+ * @type {string}
556
+ * @memberof CategoriesApiListCategories
557
+ */
558
+ readonly search?: string
559
+
560
+ /**
561
+ * 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, name, slug&lt;/i&gt;
548
562
  * @type {string}
549
563
  * @memberof CategoriesApiListCategories
550
564
  */
@@ -559,29 +573,29 @@ export interface CategoriesApiListCategoriesRequest {
559
573
  }
560
574
 
561
575
  /**
562
- * Request parameters for updateCategory operation in CategoriesApi.
576
+ * Request parameters for patchCategory operation in CategoriesApi.
563
577
  * @export
564
- * @interface CategoriesApiUpdateCategoryRequest
578
+ * @interface CategoriesApiPatchCategoryRequest
565
579
  */
566
- export interface CategoriesApiUpdateCategoryRequest {
580
+ export interface CategoriesApiPatchCategoryRequest {
567
581
  /**
568
582
  *
569
583
  * @type {string}
570
- * @memberof CategoriesApiUpdateCategory
584
+ * @memberof CategoriesApiPatchCategory
571
585
  */
572
586
  readonly code: string
573
587
 
574
588
  /**
575
589
  *
576
- * @type {UpdateCategoryRequestDto}
577
- * @memberof CategoriesApiUpdateCategory
590
+ * @type {PatchCategoryRequestDto}
591
+ * @memberof CategoriesApiPatchCategory
578
592
  */
579
- readonly updateCategoryRequestDto: UpdateCategoryRequestDto
593
+ readonly patchCategoryRequestDto: PatchCategoryRequestDto
580
594
 
581
595
  /**
582
596
  * Bearer Token: provided by the login endpoint under the name accessToken.
583
597
  * @type {string}
584
- * @memberof CategoriesApiUpdateCategory
598
+ * @memberof CategoriesApiPatchCategory
585
599
  */
586
600
  readonly authorization?: string
587
601
  }
@@ -594,7 +608,7 @@ export interface CategoriesApiUpdateCategoryRequest {
594
608
  */
595
609
  export class CategoriesApi extends BaseAPI {
596
610
  /**
597
- * This will create category.
611
+ * This will create a category.
598
612
  * @summary Create the category
599
613
  * @param {CategoriesApiCreateCategoryRequest} requestParameters Request parameters.
600
614
  * @param {*} [options] Override http request option.
@@ -606,7 +620,7 @@ export class CategoriesApi extends BaseAPI {
606
620
  }
607
621
 
608
622
  /**
609
- * This will delete category.
623
+ * This will delete a task category by code.
610
624
  * @summary Delete the category
611
625
  * @param {CategoriesApiDeleteCategoryRequest} requestParameters Request parameters.
612
626
  * @param {*} [options] Override http request option.
@@ -618,7 +632,7 @@ export class CategoriesApi extends BaseAPI {
618
632
  }
619
633
 
620
634
  /**
621
- * This will get category.
635
+ * Get category by code.
622
636
  * @summary Retrieve the category
623
637
  * @param {CategoriesApiGetCategoryRequest} requestParameters Request parameters.
624
638
  * @param {*} [options] Override http request option.
@@ -638,18 +652,18 @@ export class CategoriesApi extends BaseAPI {
638
652
  * @memberof CategoriesApi
639
653
  */
640
654
  public listCategories(requestParameters: CategoriesApiListCategoriesRequest = {}, options?: AxiosRequestConfig) {
641
- return CategoriesApiFp(this.configuration).listCategories(requestParameters.authorization, requestParameters.filter, requestParameters.filters, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
655
+ return CategoriesApiFp(this.configuration).listCategories(requestParameters.authorization, requestParameters.filter, requestParameters.filters, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
642
656
  }
643
657
 
644
658
  /**
645
- * This will update category.
659
+ * This will partially update a category by code with the provided fields.
646
660
  * @summary Update the category
647
- * @param {CategoriesApiUpdateCategoryRequest} requestParameters Request parameters.
661
+ * @param {CategoriesApiPatchCategoryRequest} requestParameters Request parameters.
648
662
  * @param {*} [options] Override http request option.
649
663
  * @throws {RequiredError}
650
664
  * @memberof CategoriesApi
651
665
  */
652
- public updateCategory(requestParameters: CategoriesApiUpdateCategoryRequest, options?: AxiosRequestConfig) {
653
- return CategoriesApiFp(this.configuration).updateCategory(requestParameters.code, requestParameters.updateCategoryRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
666
+ public patchCategory(requestParameters: CategoriesApiPatchCategoryRequest, options?: AxiosRequestConfig) {
667
+ return CategoriesApiFp(this.configuration).patchCategory(requestParameters.code, requestParameters.patchCategoryRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
654
668
  }
655
669
  }