@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
@@ -3,10 +3,10 @@
3
3
  .openapi-generator-ignore
4
4
  README.md
5
5
  api.ts
6
+ api/assignees-api.ts
6
7
  api/categories-api.ts
7
8
  api/default-api.ts
8
9
  api/hub-spot-api.ts
9
- api/priorities-api.ts
10
10
  api/statuses-api.ts
11
11
  api/tasks-api.ts
12
12
  base.ts
@@ -14,19 +14,17 @@ common.ts
14
14
  configuration.ts
15
15
  git_push.sh
16
16
  index.ts
17
+ models/assignee-class.ts
17
18
  models/category-class.ts
18
19
  models/create-category-request-dto.ts
19
20
  models/create-category-response-class.ts
20
21
  models/create-hub-spot-ticket-request-dto.ts
21
22
  models/create-hub-spot-ticket-response-class.ts
22
- models/create-priority-request-dto.ts
23
- models/create-priority-response-class.ts
24
23
  models/create-status-request-dto.ts
25
24
  models/create-status-response-class.ts
26
25
  models/create-task-request-dto.ts
27
26
  models/create-task-response-class.ts
28
27
  models/get-category-response-class.ts
29
- models/get-priority-response-class.ts
30
28
  models/get-status-response-class.ts
31
29
  models/get-task-response-class.ts
32
30
  models/hub-spot-ticket-class.ts
@@ -35,17 +33,17 @@ models/hub-spot-ticket-name-value-dto.ts
35
33
  models/index.ts
36
34
  models/inline-response200.ts
37
35
  models/inline-response503.ts
36
+ models/list-assignees-response-class.ts
38
37
  models/list-categories-response-class.ts
39
38
  models/list-statuses-response-class.ts
40
39
  models/list-tasks-response-class.ts
41
- models/priority-class.ts
40
+ models/patch-category-request-dto.ts
41
+ models/patch-category-response-class.ts
42
+ models/patch-status-request-dto.ts
43
+ models/patch-status-response-class.ts
44
+ models/patch-task-request-dto.ts
45
+ models/patch-task-response-class.ts
42
46
  models/status-class.ts
43
47
  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
48
  package.json
51
49
  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@1.0.1-beta.1 --save
20
+ npm install @emilgroup/task-sdk@1.0.1-beta.11 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/task-sdk@1.0.1-beta.1
24
+ yarn add @emilgroup/task-sdk@1.0.1-beta.11
25
25
  ```
26
26
 
27
27
  And then you can import `TasksApi`.
@@ -0,0 +1,162 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL TaskService
5
+ * The EMIL Task API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
17
+ import { Configuration } from '../configuration';
18
+ // Some imports not used depending on template conditions
19
+ // @ts-ignore
20
+ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
21
+ // @ts-ignore
22
+ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
23
+ // @ts-ignore
24
+ import { ListAssigneesResponseClass } from '../models';
25
+ /**
26
+ * AssigneesApi - axios parameter creator
27
+ * @export
28
+ */
29
+ export const AssigneesApiAxiosParamCreator = function (configuration?: Configuration) {
30
+ return {
31
+ /**
32
+ * Retrieves a list of distinct assignees from tasks.
33
+ * @summary List assignees
34
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
35
+ * @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/>
36
+ * @param {*} [options] Override http request option.
37
+ * @throws {RequiredError}
38
+ */
39
+ listAssignees: async (authorization?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
40
+ const localVarPath = `/taskservice/v1/assignees`;
41
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
42
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
43
+ let baseOptions;
44
+ let baseAccessToken;
45
+ if (configuration) {
46
+ baseOptions = configuration.baseOptions;
47
+ baseAccessToken = configuration.accessToken;
48
+ }
49
+
50
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
51
+ const localVarHeaderParameter = {} as any;
52
+ const localVarQueryParameter = {} as any;
53
+
54
+ // authentication bearer required
55
+ // http bearer authentication required
56
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
57
+
58
+ if (expand !== undefined) {
59
+ localVarQueryParameter['expand'] = expand;
60
+ }
61
+
62
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
63
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
64
+ }
65
+
66
+
67
+
68
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
69
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
70
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
71
+
72
+ return {
73
+ url: toPathString(localVarUrlObj),
74
+ options: localVarRequestOptions,
75
+ };
76
+ },
77
+ }
78
+ };
79
+
80
+ /**
81
+ * AssigneesApi - functional programming interface
82
+ * @export
83
+ */
84
+ export const AssigneesApiFp = function(configuration?: Configuration) {
85
+ const localVarAxiosParamCreator = AssigneesApiAxiosParamCreator(configuration)
86
+ return {
87
+ /**
88
+ * Retrieves a list of distinct assignees from tasks.
89
+ * @summary List assignees
90
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
91
+ * @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;
92
+ * @param {*} [options] Override http request option.
93
+ * @throws {RequiredError}
94
+ */
95
+ async listAssignees(authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListAssigneesResponseClass>> {
96
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listAssignees(authorization, expand, options);
97
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
98
+ },
99
+ }
100
+ };
101
+
102
+ /**
103
+ * AssigneesApi - factory interface
104
+ * @export
105
+ */
106
+ export const AssigneesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
107
+ const localVarFp = AssigneesApiFp(configuration)
108
+ return {
109
+ /**
110
+ * Retrieves a list of distinct assignees from tasks.
111
+ * @summary List assignees
112
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
113
+ * @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;
114
+ * @param {*} [options] Override http request option.
115
+ * @throws {RequiredError}
116
+ */
117
+ listAssignees(authorization?: string, expand?: string, options?: any): AxiosPromise<ListAssigneesResponseClass> {
118
+ return localVarFp.listAssignees(authorization, expand, options).then((request) => request(axios, basePath));
119
+ },
120
+ };
121
+ };
122
+
123
+ /**
124
+ * Request parameters for listAssignees operation in AssigneesApi.
125
+ * @export
126
+ * @interface AssigneesApiListAssigneesRequest
127
+ */
128
+ export interface AssigneesApiListAssigneesRequest {
129
+ /**
130
+ * Bearer Token: provided by the login endpoint under the name accessToken.
131
+ * @type {string}
132
+ * @memberof AssigneesApiListAssignees
133
+ */
134
+ readonly authorization?: string
135
+
136
+ /**
137
+ * 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;
138
+ * @type {string}
139
+ * @memberof AssigneesApiListAssignees
140
+ */
141
+ readonly expand?: string
142
+ }
143
+
144
+ /**
145
+ * AssigneesApi - object-oriented interface
146
+ * @export
147
+ * @class AssigneesApi
148
+ * @extends {BaseAPI}
149
+ */
150
+ export class AssigneesApi extends BaseAPI {
151
+ /**
152
+ * Retrieves a list of distinct assignees from tasks.
153
+ * @summary List assignees
154
+ * @param {AssigneesApiListAssigneesRequest} requestParameters Request parameters.
155
+ * @param {*} [options] Override http request option.
156
+ * @throws {RequiredError}
157
+ * @memberof AssigneesApi
158
+ */
159
+ public listAssignees(requestParameters: AssigneesApiListAssigneesRequest = {}, options?: AxiosRequestConfig) {
160
+ return AssigneesApiFp(this.configuration).listAssignees(requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
161
+ }
162
+ }
@@ -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
  /**
36
36
  * CategoriesApi - axios parameter creator
37
37
  * @export
@@ -39,7 +39,7 @@ import { UpdateCategoryResponseClass } from '../models';
39
39
  export const CategoriesApiAxiosParamCreator = function (configuration?: Configuration) {
40
40
  return {
41
41
  /**
42
- * This will create category.
42
+ * This will create a category.
43
43
  * @summary Create the category
44
44
  * @param {CreateCategoryRequestDto} createCategoryRequestDto
45
45
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -86,7 +86,7 @@ export const CategoriesApiAxiosParamCreator = function (configuration?: Configur
86
86
  };
87
87
  },
88
88
  /**
89
- * This will delete category.
89
+ * This will delete a task category by code.
90
90
  * @summary Delete the category
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 CategoriesApiAxiosParamCreator = function (configuration?: Configur
131
131
  };
132
132
  },
133
133
  /**
134
- * This will get category.
134
+ * Get category by code.
135
135
  * @summary Retrieve the category
136
136
  * @param {string} code
137
137
  * @param {string} expand
@@ -186,14 +186,15 @@ export const CategoriesApiAxiosParamCreator = function (configuration?: Configur
186
186
  * Retrieves a list of categories.
187
187
  * @summary List categories
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, createdAt&lt;/i&gt;
190
- * @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;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt&lt;/i&gt;
189
+ * @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;
190
+ * @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;
191
+ * @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;
192
+ * @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;
192
193
  * @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;
193
194
  * @param {*} [options] Override http request option.
194
195
  * @throws {RequiredError}
195
196
  */
196
- listCategories: async (authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
197
+ listCategories: async (authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
197
198
  const localVarPath = `/taskservice/v1/categories`;
198
199
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
199
200
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -220,6 +221,10 @@ export const CategoriesApiAxiosParamCreator = function (configuration?: Configur
220
221
  localVarQueryParameter['filters'] = filters;
221
222
  }
222
223
 
224
+ if (search !== undefined) {
225
+ localVarQueryParameter['search'] = search;
226
+ }
227
+
223
228
  if (order !== undefined) {
224
229
  localVarQueryParameter['order'] = order;
225
230
  }
@@ -244,19 +249,19 @@ export const CategoriesApiAxiosParamCreator = function (configuration?: Configur
244
249
  };
245
250
  },
246
251
  /**
247
- * This will update category.
252
+ * This will partially update a category by code with the provided fields.
248
253
  * @summary Update the category
249
254
  * @param {string} code
250
- * @param {UpdateCategoryRequestDto} updateCategoryRequestDto
255
+ * @param {PatchCategoryRequestDto} patchCategoryRequestDto
251
256
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
252
257
  * @param {*} [options] Override http request option.
253
258
  * @throws {RequiredError}
254
259
  */
255
- updateCategory: async (code: string, updateCategoryRequestDto: UpdateCategoryRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
260
+ patchCategory: async (code: string, patchCategoryRequestDto: PatchCategoryRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
256
261
  // verify required parameter 'code' is not null or undefined
257
- assertParamExists('updateCategory', 'code', code)
258
- // verify required parameter 'updateCategoryRequestDto' is not null or undefined
259
- assertParamExists('updateCategory', 'updateCategoryRequestDto', updateCategoryRequestDto)
262
+ assertParamExists('patchCategory', 'code', code)
263
+ // verify required parameter 'patchCategoryRequestDto' is not null or undefined
264
+ assertParamExists('patchCategory', 'patchCategoryRequestDto', patchCategoryRequestDto)
260
265
  const localVarPath = `/taskservice/v1/categories/{code}`
261
266
  .replace(`{${"code"}}`, encodeURIComponent(String(code)));
262
267
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -268,7 +273,7 @@ export const CategoriesApiAxiosParamCreator = function (configuration?: Configur
268
273
  baseAccessToken = configuration.accessToken;
269
274
  }
270
275
 
271
- const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
276
+ const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
272
277
  const localVarHeaderParameter = {} as any;
273
278
  const localVarQueryParameter = {} as any;
274
279
 
@@ -287,7 +292,7 @@ export const CategoriesApiAxiosParamCreator = function (configuration?: Configur
287
292
  setSearchParams(localVarUrlObj, localVarQueryParameter);
288
293
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
289
294
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
290
- localVarRequestOptions.data = serializeDataIfNeeded(updateCategoryRequestDto, localVarRequestOptions, configuration)
295
+ localVarRequestOptions.data = serializeDataIfNeeded(patchCategoryRequestDto, localVarRequestOptions, configuration)
291
296
 
292
297
  return {
293
298
  url: toPathString(localVarUrlObj),
@@ -305,7 +310,7 @@ export const CategoriesApiFp = function(configuration?: Configuration) {
305
310
  const localVarAxiosParamCreator = CategoriesApiAxiosParamCreator(configuration)
306
311
  return {
307
312
  /**
308
- * This will create category.
313
+ * This will create a category.
309
314
  * @summary Create the category
310
315
  * @param {CreateCategoryRequestDto} createCategoryRequestDto
311
316
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -317,7 +322,7 @@ export const CategoriesApiFp = function(configuration?: Configuration) {
317
322
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
318
323
  },
319
324
  /**
320
- * This will delete category.
325
+ * This will delete a task category by code.
321
326
  * @summary Delete the category
322
327
  * @param {string} code Unique identifier for the object.
323
328
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -329,7 +334,7 @@ export const CategoriesApiFp = function(configuration?: Configuration) {
329
334
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
330
335
  },
331
336
  /**
332
- * This will get category.
337
+ * Get category by code.
333
338
  * @summary Retrieve the category
334
339
  * @param {string} code
335
340
  * @param {string} expand
@@ -345,28 +350,29 @@ export const CategoriesApiFp = function(configuration?: Configuration) {
345
350
  * Retrieves a list of categories.
346
351
  * @summary List categories
347
352
  * @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, 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, 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;
353
+ * @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;
354
+ * @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;
355
+ * @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;
356
+ * @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;
351
357
  * @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;
352
358
  * @param {*} [options] Override http request option.
353
359
  * @throws {RequiredError}
354
360
  */
355
- async listCategories(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCategoriesResponseClass>> {
356
- const localVarAxiosArgs = await localVarAxiosParamCreator.listCategories(authorization, filter, filters, order, expand, options);
361
+ async listCategories(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCategoriesResponseClass>> {
362
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listCategories(authorization, filter, filters, search, order, expand, options);
357
363
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
358
364
  },
359
365
  /**
360
- * This will update category.
366
+ * This will partially update a category by code with the provided fields.
361
367
  * @summary Update the category
362
368
  * @param {string} code
363
- * @param {UpdateCategoryRequestDto} updateCategoryRequestDto
369
+ * @param {PatchCategoryRequestDto} patchCategoryRequestDto
364
370
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
365
371
  * @param {*} [options] Override http request option.
366
372
  * @throws {RequiredError}
367
373
  */
368
- async updateCategory(code: string, updateCategoryRequestDto: UpdateCategoryRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCategoryResponseClass>> {
369
- const localVarAxiosArgs = await localVarAxiosParamCreator.updateCategory(code, updateCategoryRequestDto, authorization, options);
374
+ async patchCategory(code: string, patchCategoryRequestDto: PatchCategoryRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PatchCategoryResponseClass>> {
375
+ const localVarAxiosArgs = await localVarAxiosParamCreator.patchCategory(code, patchCategoryRequestDto, authorization, options);
370
376
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
371
377
  },
372
378
  }
@@ -380,7 +386,7 @@ export const CategoriesApiFactory = function (configuration?: Configuration, bas
380
386
  const localVarFp = CategoriesApiFp(configuration)
381
387
  return {
382
388
  /**
383
- * This will create category.
389
+ * This will create a category.
384
390
  * @summary Create the category
385
391
  * @param {CreateCategoryRequestDto} createCategoryRequestDto
386
392
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -391,7 +397,7 @@ export const CategoriesApiFactory = function (configuration?: Configuration, bas
391
397
  return localVarFp.createCategory(createCategoryRequestDto, authorization, options).then((request) => request(axios, basePath));
392
398
  },
393
399
  /**
394
- * This will delete category.
400
+ * This will delete a task category by code.
395
401
  * @summary Delete the category
396
402
  * @param {string} code Unique identifier for the object.
397
403
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -402,7 +408,7 @@ export const CategoriesApiFactory = function (configuration?: Configuration, bas
402
408
  return localVarFp.deleteCategory(code, authorization, options).then((request) => request(axios, basePath));
403
409
  },
404
410
  /**
405
- * This will get category.
411
+ * Get category by code.
406
412
  * @summary Retrieve the category
407
413
  * @param {string} code
408
414
  * @param {string} expand
@@ -417,27 +423,28 @@ export const CategoriesApiFactory = function (configuration?: Configuration, bas
417
423
  * Retrieves a list of categories.
418
424
  * @summary List categories
419
425
  * @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, 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, 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;
426
+ * @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;
427
+ * @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;
428
+ * @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;
429
+ * @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;
423
430
  * @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;
424
431
  * @param {*} [options] Override http request option.
425
432
  * @throws {RequiredError}
426
433
  */
427
- listCategories(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListCategoriesResponseClass> {
428
- return localVarFp.listCategories(authorization, filter, filters, order, expand, options).then((request) => request(axios, basePath));
434
+ listCategories(authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListCategoriesResponseClass> {
435
+ return localVarFp.listCategories(authorization, filter, filters, search, order, expand, options).then((request) => request(axios, basePath));
429
436
  },
430
437
  /**
431
- * This will update category.
438
+ * This will partially update a category by code with the provided fields.
432
439
  * @summary Update the category
433
440
  * @param {string} code
434
- * @param {UpdateCategoryRequestDto} updateCategoryRequestDto
441
+ * @param {PatchCategoryRequestDto} patchCategoryRequestDto
435
442
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
436
443
  * @param {*} [options] Override http request option.
437
444
  * @throws {RequiredError}
438
445
  */
439
- updateCategory(code: string, updateCategoryRequestDto: UpdateCategoryRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateCategoryResponseClass> {
440
- return localVarFp.updateCategory(code, updateCategoryRequestDto, authorization, options).then((request) => request(axios, basePath));
446
+ patchCategory(code: string, patchCategoryRequestDto: PatchCategoryRequestDto, authorization?: string, options?: any): AxiosPromise<PatchCategoryResponseClass> {
447
+ return localVarFp.patchCategory(code, patchCategoryRequestDto, authorization, options).then((request) => request(axios, basePath));
441
448
  },
442
449
  };
443
450
  };
@@ -526,21 +533,28 @@ export interface CategoriesApiListCategoriesRequest {
526
533
  readonly authorization?: string
527
534
 
528
535
  /**
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, createdAt&lt;/i&gt;
536
+ * 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;
530
537
  * @type {string}
531
538
  * @memberof CategoriesApiListCategories
532
539
  */
533
540
  readonly filter?: string
534
541
 
535
542
  /**
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, createdAt&lt;/i&gt;
543
+ * 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;
537
544
  * @type {string}
538
545
  * @memberof CategoriesApiListCategories
539
546
  */
540
547
  readonly filters?: string
541
548
 
542
549
  /**
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;
550
+ * 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;
551
+ * @type {string}
552
+ * @memberof CategoriesApiListCategories
553
+ */
554
+ readonly search?: string
555
+
556
+ /**
557
+ * 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;
544
558
  * @type {string}
545
559
  * @memberof CategoriesApiListCategories
546
560
  */
@@ -555,29 +569,29 @@ export interface CategoriesApiListCategoriesRequest {
555
569
  }
556
570
 
557
571
  /**
558
- * Request parameters for updateCategory operation in CategoriesApi.
572
+ * Request parameters for patchCategory operation in CategoriesApi.
559
573
  * @export
560
- * @interface CategoriesApiUpdateCategoryRequest
574
+ * @interface CategoriesApiPatchCategoryRequest
561
575
  */
562
- export interface CategoriesApiUpdateCategoryRequest {
576
+ export interface CategoriesApiPatchCategoryRequest {
563
577
  /**
564
578
  *
565
579
  * @type {string}
566
- * @memberof CategoriesApiUpdateCategory
580
+ * @memberof CategoriesApiPatchCategory
567
581
  */
568
582
  readonly code: string
569
583
 
570
584
  /**
571
585
  *
572
- * @type {UpdateCategoryRequestDto}
573
- * @memberof CategoriesApiUpdateCategory
586
+ * @type {PatchCategoryRequestDto}
587
+ * @memberof CategoriesApiPatchCategory
574
588
  */
575
- readonly updateCategoryRequestDto: UpdateCategoryRequestDto
589
+ readonly patchCategoryRequestDto: PatchCategoryRequestDto
576
590
 
577
591
  /**
578
592
  * Bearer Token: provided by the login endpoint under the name accessToken.
579
593
  * @type {string}
580
- * @memberof CategoriesApiUpdateCategory
594
+ * @memberof CategoriesApiPatchCategory
581
595
  */
582
596
  readonly authorization?: string
583
597
  }
@@ -590,7 +604,7 @@ export interface CategoriesApiUpdateCategoryRequest {
590
604
  */
591
605
  export class CategoriesApi extends BaseAPI {
592
606
  /**
593
- * This will create category.
607
+ * This will create a category.
594
608
  * @summary Create the category
595
609
  * @param {CategoriesApiCreateCategoryRequest} requestParameters Request parameters.
596
610
  * @param {*} [options] Override http request option.
@@ -602,7 +616,7 @@ export class CategoriesApi extends BaseAPI {
602
616
  }
603
617
 
604
618
  /**
605
- * This will delete category.
619
+ * This will delete a task category by code.
606
620
  * @summary Delete the category
607
621
  * @param {CategoriesApiDeleteCategoryRequest} requestParameters Request parameters.
608
622
  * @param {*} [options] Override http request option.
@@ -614,7 +628,7 @@ export class CategoriesApi extends BaseAPI {
614
628
  }
615
629
 
616
630
  /**
617
- * This will get category.
631
+ * Get category by code.
618
632
  * @summary Retrieve the category
619
633
  * @param {CategoriesApiGetCategoryRequest} requestParameters Request parameters.
620
634
  * @param {*} [options] Override http request option.
@@ -634,18 +648,18 @@ export class CategoriesApi extends BaseAPI {
634
648
  * @memberof CategoriesApi
635
649
  */
636
650
  public listCategories(requestParameters: CategoriesApiListCategoriesRequest = {}, options?: AxiosRequestConfig) {
637
- return CategoriesApiFp(this.configuration).listCategories(requestParameters.authorization, requestParameters.filter, requestParameters.filters, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
651
+ 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));
638
652
  }
639
653
 
640
654
  /**
641
- * This will update category.
655
+ * This will partially update a category by code with the provided fields.
642
656
  * @summary Update the category
643
- * @param {CategoriesApiUpdateCategoryRequest} requestParameters Request parameters.
657
+ * @param {CategoriesApiPatchCategoryRequest} requestParameters Request parameters.
644
658
  * @param {*} [options] Override http request option.
645
659
  * @throws {RequiredError}
646
660
  * @memberof CategoriesApi
647
661
  */
648
- public updateCategory(requestParameters: CategoriesApiUpdateCategoryRequest, options?: AxiosRequestConfig) {
649
- return CategoriesApiFp(this.configuration).updateCategory(requestParameters.code, requestParameters.updateCategoryRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
662
+ public patchCategory(requestParameters: CategoriesApiPatchCategoryRequest, options?: AxiosRequestConfig) {
663
+ return CategoriesApiFp(this.configuration).patchCategory(requestParameters.code, requestParameters.patchCategoryRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
650
664
  }
651
665
  }