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