@emilgroup/task-sdk 1.0.1-beta.8 → 1.0.2

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 (126) hide show
  1. package/README.md +1 -51
  2. package/index.js +99 -0
  3. package/package.json +8 -21
  4. package/scripts/deploy.js +240 -0
  5. package/.openapi-generator/FILES +0 -46
  6. package/.openapi-generator/VERSION +0 -1
  7. package/.openapi-generator-ignore +0 -23
  8. package/api/categories-api.ts +0 -665
  9. package/api/default-api.ts +0 -124
  10. package/api/hub-spot-api.ts +0 -165
  11. package/api/statuses-api.ts +0 -665
  12. package/api/tasks-api.ts +0 -693
  13. package/api.ts +0 -35
  14. package/base.ts +0 -331
  15. package/common.ts +0 -198
  16. package/configuration.ts +0 -110
  17. package/dist/api/categories-api.d.ts +0 -375
  18. package/dist/api/categories-api.js +0 -632
  19. package/dist/api/default-api.d.ts +0 -70
  20. package/dist/api/default-api.js +0 -200
  21. package/dist/api/hub-spot-api.d.ts +0 -97
  22. package/dist/api/hub-spot-api.js +0 -224
  23. package/dist/api/statuses-api.d.ts +0 -375
  24. package/dist/api/statuses-api.js +0 -632
  25. package/dist/api/tasks-api.d.ts +0 -393
  26. package/dist/api/tasks-api.js +0 -644
  27. package/dist/api.d.ts +0 -16
  28. package/dist/api.js +0 -34
  29. package/dist/base.d.ts +0 -86
  30. package/dist/base.js +0 -367
  31. package/dist/common.d.ts +0 -91
  32. package/dist/common.js +0 -276
  33. package/dist/configuration.d.ts +0 -89
  34. package/dist/configuration.js +0 -52
  35. package/dist/index.d.ts +0 -15
  36. package/dist/index.js +0 -36
  37. package/dist/models/category-class.d.ts +0 -66
  38. package/dist/models/category-class.js +0 -15
  39. package/dist/models/create-category-request-dto.d.ts +0 -30
  40. package/dist/models/create-category-request-dto.js +0 -15
  41. package/dist/models/create-category-response-class.d.ts +0 -25
  42. package/dist/models/create-category-response-class.js +0 -15
  43. package/dist/models/create-hub-spot-ticket-request-dto.d.ts +0 -31
  44. package/dist/models/create-hub-spot-ticket-request-dto.js +0 -15
  45. package/dist/models/create-hub-spot-ticket-response-class.d.ts +0 -25
  46. package/dist/models/create-hub-spot-ticket-response-class.js +0 -15
  47. package/dist/models/create-status-request-dto.d.ts +0 -30
  48. package/dist/models/create-status-request-dto.js +0 -15
  49. package/dist/models/create-status-response-class.d.ts +0 -25
  50. package/dist/models/create-status-response-class.js +0 -15
  51. package/dist/models/create-task-request-dto.d.ts +0 -72
  52. package/dist/models/create-task-request-dto.js +0 -21
  53. package/dist/models/create-task-response-class.d.ts +0 -25
  54. package/dist/models/create-task-response-class.js +0 -15
  55. package/dist/models/get-category-response-class.d.ts +0 -25
  56. package/dist/models/get-category-response-class.js +0 -15
  57. package/dist/models/get-status-response-class.d.ts +0 -25
  58. package/dist/models/get-status-response-class.js +0 -15
  59. package/dist/models/get-task-response-class.d.ts +0 -25
  60. package/dist/models/get-task-response-class.js +0 -15
  61. package/dist/models/hub-spot-ticket-class.d.ts +0 -49
  62. package/dist/models/hub-spot-ticket-class.js +0 -15
  63. package/dist/models/hub-spot-ticket-error-class.d.ts +0 -30
  64. package/dist/models/hub-spot-ticket-error-class.js +0 -15
  65. package/dist/models/hub-spot-ticket-name-value-dto.d.ts +0 -30
  66. package/dist/models/hub-spot-ticket-name-value-dto.js +0 -15
  67. package/dist/models/index.d.ts +0 -28
  68. package/dist/models/index.js +0 -44
  69. package/dist/models/inline-response200.d.ts +0 -54
  70. package/dist/models/inline-response200.js +0 -15
  71. package/dist/models/inline-response503.d.ts +0 -54
  72. package/dist/models/inline-response503.js +0 -15
  73. package/dist/models/list-categories-response-class.d.ts +0 -43
  74. package/dist/models/list-categories-response-class.js +0 -15
  75. package/dist/models/list-statuses-response-class.d.ts +0 -43
  76. package/dist/models/list-statuses-response-class.js +0 -15
  77. package/dist/models/list-tasks-response-class.d.ts +0 -43
  78. package/dist/models/list-tasks-response-class.js +0 -15
  79. package/dist/models/patch-category-request-dto.d.ts +0 -36
  80. package/dist/models/patch-category-request-dto.js +0 -15
  81. package/dist/models/patch-category-response-class.d.ts +0 -25
  82. package/dist/models/patch-category-response-class.js +0 -15
  83. package/dist/models/patch-status-request-dto.d.ts +0 -36
  84. package/dist/models/patch-status-request-dto.js +0 -15
  85. package/dist/models/patch-status-response-class.d.ts +0 -25
  86. package/dist/models/patch-status-response-class.js +0 -15
  87. package/dist/models/patch-task-request-dto.d.ts +0 -108
  88. package/dist/models/patch-task-request-dto.js +0 -15
  89. package/dist/models/patch-task-response-class.d.ts +0 -25
  90. package/dist/models/patch-task-response-class.js +0 -15
  91. package/dist/models/status-class.d.ts +0 -66
  92. package/dist/models/status-class.js +0 -15
  93. package/dist/models/task-class.d.ts +0 -116
  94. package/dist/models/task-class.js +0 -21
  95. package/git_push.sh +0 -57
  96. package/index.ts +0 -19
  97. package/models/category-class.ts +0 -72
  98. package/models/create-category-request-dto.ts +0 -36
  99. package/models/create-category-response-class.ts +0 -31
  100. package/models/create-hub-spot-ticket-request-dto.ts +0 -37
  101. package/models/create-hub-spot-ticket-response-class.ts +0 -31
  102. package/models/create-status-request-dto.ts +0 -36
  103. package/models/create-status-response-class.ts +0 -31
  104. package/models/create-task-request-dto.ts +0 -81
  105. package/models/create-task-response-class.ts +0 -31
  106. package/models/get-category-response-class.ts +0 -31
  107. package/models/get-status-response-class.ts +0 -31
  108. package/models/get-task-response-class.ts +0 -31
  109. package/models/hub-spot-ticket-class.ts +0 -55
  110. package/models/hub-spot-ticket-error-class.ts +0 -36
  111. package/models/hub-spot-ticket-name-value-dto.ts +0 -36
  112. package/models/index.ts +0 -28
  113. package/models/inline-response200.ts +0 -48
  114. package/models/inline-response503.ts +0 -48
  115. package/models/list-categories-response-class.ts +0 -49
  116. package/models/list-statuses-response-class.ts +0 -49
  117. package/models/list-tasks-response-class.ts +0 -49
  118. package/models/patch-category-request-dto.ts +0 -42
  119. package/models/patch-category-response-class.ts +0 -31
  120. package/models/patch-status-request-dto.ts +0 -42
  121. package/models/patch-status-response-class.ts +0 -31
  122. package/models/patch-task-request-dto.ts +0 -114
  123. package/models/patch-task-response-class.ts +0 -31
  124. package/models/status-class.ts +0 -72
  125. package/models/task-class.ts +0 -125
  126. package/tsconfig.json +0 -23
@@ -1,665 +0,0 @@
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 { CreateCategoryRequestDto } from '../models';
25
- // @ts-ignore
26
- import { CreateCategoryResponseClass } from '../models';
27
- // @ts-ignore
28
- import { GetCategoryResponseClass } from '../models';
29
- // @ts-ignore
30
- import { ListCategoriesResponseClass } from '../models';
31
- // @ts-ignore
32
- import { PatchCategoryRequestDto } from '../models';
33
- // @ts-ignore
34
- import { PatchCategoryResponseClass } from '../models';
35
- /**
36
- * CategoriesApi - axios parameter creator
37
- * @export
38
- */
39
- export const CategoriesApiAxiosParamCreator = function (configuration?: Configuration) {
40
- return {
41
- /**
42
- * This will create a category.
43
- * @summary Create the category
44
- * @param {CreateCategoryRequestDto} createCategoryRequestDto
45
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
46
- * @param {*} [options] Override http request option.
47
- * @throws {RequiredError}
48
- */
49
- createCategory: async (createCategoryRequestDto: CreateCategoryRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
50
- // verify required parameter 'createCategoryRequestDto' is not null or undefined
51
- assertParamExists('createCategory', 'createCategoryRequestDto', createCategoryRequestDto)
52
- const localVarPath = `/taskservice/v1/categories`;
53
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
54
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
55
- let baseOptions;
56
- let baseAccessToken;
57
- if (configuration) {
58
- baseOptions = configuration.baseOptions;
59
- baseAccessToken = configuration.accessToken;
60
- }
61
-
62
- const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
63
- const localVarHeaderParameter = {} as any;
64
- const localVarQueryParameter = {} as any;
65
-
66
- // authentication bearer required
67
- // http bearer authentication required
68
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
69
-
70
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
71
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
72
- }
73
-
74
-
75
-
76
- localVarHeaderParameter['Content-Type'] = 'application/json';
77
-
78
- setSearchParams(localVarUrlObj, localVarQueryParameter);
79
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
80
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
81
- localVarRequestOptions.data = serializeDataIfNeeded(createCategoryRequestDto, localVarRequestOptions, configuration)
82
-
83
- return {
84
- url: toPathString(localVarUrlObj),
85
- options: localVarRequestOptions,
86
- };
87
- },
88
- /**
89
- * This will delete a task category by code.
90
- * @summary Delete the category
91
- * @param {string} code Unique identifier for the object.
92
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
93
- * @param {*} [options] Override http request option.
94
- * @throws {RequiredError}
95
- */
96
- deleteCategory: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
97
- // verify required parameter 'code' is not null or undefined
98
- assertParamExists('deleteCategory', 'code', code)
99
- const localVarPath = `/taskservice/v1/categories/{code}`
100
- .replace(`{${"code"}}`, encodeURIComponent(String(code)));
101
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
102
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
103
- let baseOptions;
104
- let baseAccessToken;
105
- if (configuration) {
106
- baseOptions = configuration.baseOptions;
107
- baseAccessToken = configuration.accessToken;
108
- }
109
-
110
- const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
111
- const localVarHeaderParameter = {} as any;
112
- const localVarQueryParameter = {} as any;
113
-
114
- // authentication bearer required
115
- // http bearer authentication required
116
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
117
-
118
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
119
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
120
- }
121
-
122
-
123
-
124
- setSearchParams(localVarUrlObj, localVarQueryParameter);
125
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
126
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
127
-
128
- return {
129
- url: toPathString(localVarUrlObj),
130
- options: localVarRequestOptions,
131
- };
132
- },
133
- /**
134
- * Get category by code.
135
- * @summary Retrieve the category
136
- * @param {string} code
137
- * @param {string} expand
138
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
139
- * @param {*} [options] Override http request option.
140
- * @throws {RequiredError}
141
- */
142
- getCategory: async (code: string, expand: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
143
- // verify required parameter 'code' is not null or undefined
144
- assertParamExists('getCategory', 'code', code)
145
- // verify required parameter 'expand' is not null or undefined
146
- assertParamExists('getCategory', 'expand', expand)
147
- const localVarPath = `/taskservice/v1/categories/{code}`
148
- .replace(`{${"code"}}`, encodeURIComponent(String(code)));
149
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
150
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
151
- let baseOptions;
152
- let baseAccessToken;
153
- if (configuration) {
154
- baseOptions = configuration.baseOptions;
155
- baseAccessToken = configuration.accessToken;
156
- }
157
-
158
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
159
- const localVarHeaderParameter = {} as any;
160
- const localVarQueryParameter = {} as any;
161
-
162
- // authentication bearer required
163
- // http bearer authentication required
164
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
165
-
166
- if (expand !== undefined) {
167
- localVarQueryParameter['expand'] = expand;
168
- }
169
-
170
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
171
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
172
- }
173
-
174
-
175
-
176
- setSearchParams(localVarUrlObj, localVarQueryParameter);
177
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
178
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
179
-
180
- return {
181
- url: toPathString(localVarUrlObj),
182
- options: localVarRequestOptions,
183
- };
184
- },
185
- /**
186
- * Retrieves a list of categories.
187
- * @summary List categories
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, 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;
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;
194
- * @param {*} [options] Override http request option.
195
- * @throws {RequiredError}
196
- */
197
- listCategories: async (authorization?: string, filter?: string, filters?: string, search?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
198
- const localVarPath = `/taskservice/v1/categories`;
199
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
200
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
201
- let baseOptions;
202
- let baseAccessToken;
203
- if (configuration) {
204
- baseOptions = configuration.baseOptions;
205
- baseAccessToken = configuration.accessToken;
206
- }
207
-
208
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
209
- const localVarHeaderParameter = {} as any;
210
- const localVarQueryParameter = {} as any;
211
-
212
- // authentication bearer required
213
- // http bearer authentication required
214
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
215
-
216
- if (filter !== undefined) {
217
- localVarQueryParameter['filter'] = filter;
218
- }
219
-
220
- if (filters !== undefined) {
221
- localVarQueryParameter['filters'] = filters;
222
- }
223
-
224
- if (search !== undefined) {
225
- localVarQueryParameter['search'] = search;
226
- }
227
-
228
- if (order !== undefined) {
229
- localVarQueryParameter['order'] = order;
230
- }
231
-
232
- if (expand !== undefined) {
233
- localVarQueryParameter['expand'] = expand;
234
- }
235
-
236
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
237
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
238
- }
239
-
240
-
241
-
242
- setSearchParams(localVarUrlObj, localVarQueryParameter);
243
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
244
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
245
-
246
- return {
247
- url: toPathString(localVarUrlObj),
248
- options: localVarRequestOptions,
249
- };
250
- },
251
- /**
252
- * This will partially update a category by code with the provided fields.
253
- * @summary Update the category
254
- * @param {string} code
255
- * @param {PatchCategoryRequestDto} patchCategoryRequestDto
256
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
257
- * @param {*} [options] Override http request option.
258
- * @throws {RequiredError}
259
- */
260
- patchCategory: async (code: string, patchCategoryRequestDto: PatchCategoryRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
261
- // verify required parameter 'code' is not null or undefined
262
- assertParamExists('patchCategory', 'code', code)
263
- // verify required parameter 'patchCategoryRequestDto' is not null or undefined
264
- assertParamExists('patchCategory', 'patchCategoryRequestDto', patchCategoryRequestDto)
265
- const localVarPath = `/taskservice/v1/categories/{code}`
266
- .replace(`{${"code"}}`, encodeURIComponent(String(code)));
267
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
268
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
269
- let baseOptions;
270
- let baseAccessToken;
271
- if (configuration) {
272
- baseOptions = configuration.baseOptions;
273
- baseAccessToken = configuration.accessToken;
274
- }
275
-
276
- const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
277
- const localVarHeaderParameter = {} as any;
278
- const localVarQueryParameter = {} as any;
279
-
280
- // authentication bearer required
281
- // http bearer authentication required
282
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
283
-
284
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
285
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
286
- }
287
-
288
-
289
-
290
- localVarHeaderParameter['Content-Type'] = 'application/json';
291
-
292
- setSearchParams(localVarUrlObj, localVarQueryParameter);
293
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
294
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
295
- localVarRequestOptions.data = serializeDataIfNeeded(patchCategoryRequestDto, localVarRequestOptions, configuration)
296
-
297
- return {
298
- url: toPathString(localVarUrlObj),
299
- options: localVarRequestOptions,
300
- };
301
- },
302
- }
303
- };
304
-
305
- /**
306
- * CategoriesApi - functional programming interface
307
- * @export
308
- */
309
- export const CategoriesApiFp = function(configuration?: Configuration) {
310
- const localVarAxiosParamCreator = CategoriesApiAxiosParamCreator(configuration)
311
- return {
312
- /**
313
- * This will create a category.
314
- * @summary Create the category
315
- * @param {CreateCategoryRequestDto} createCategoryRequestDto
316
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
317
- * @param {*} [options] Override http request option.
318
- * @throws {RequiredError}
319
- */
320
- async createCategory(createCategoryRequestDto: CreateCategoryRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCategoryResponseClass>> {
321
- const localVarAxiosArgs = await localVarAxiosParamCreator.createCategory(createCategoryRequestDto, authorization, options);
322
- return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
323
- },
324
- /**
325
- * This will delete a task category by code.
326
- * @summary Delete the category
327
- * @param {string} code Unique identifier for the object.
328
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
329
- * @param {*} [options] Override http request option.
330
- * @throws {RequiredError}
331
- */
332
- async deleteCategory(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
333
- const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCategory(code, authorization, options);
334
- return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
335
- },
336
- /**
337
- * Get category by code.
338
- * @summary Retrieve the category
339
- * @param {string} code
340
- * @param {string} expand
341
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
342
- * @param {*} [options] Override http request option.
343
- * @throws {RequiredError}
344
- */
345
- async getCategory(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCategoryResponseClass>> {
346
- const localVarAxiosArgs = await localVarAxiosParamCreator.getCategory(code, expand, authorization, options);
347
- return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
348
- },
349
- /**
350
- * Retrieves a list of categories.
351
- * @summary List categories
352
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
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;
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;
358
- * @param {*} [options] Override http request option.
359
- * @throws {RequiredError}
360
- */
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);
363
- return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
364
- },
365
- /**
366
- * This will partially update a category by code with the provided fields.
367
- * @summary Update the category
368
- * @param {string} code
369
- * @param {PatchCategoryRequestDto} patchCategoryRequestDto
370
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
371
- * @param {*} [options] Override http request option.
372
- * @throws {RequiredError}
373
- */
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);
376
- return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
377
- },
378
- }
379
- };
380
-
381
- /**
382
- * CategoriesApi - factory interface
383
- * @export
384
- */
385
- export const CategoriesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
386
- const localVarFp = CategoriesApiFp(configuration)
387
- return {
388
- /**
389
- * This will create a category.
390
- * @summary Create the category
391
- * @param {CreateCategoryRequestDto} createCategoryRequestDto
392
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
393
- * @param {*} [options] Override http request option.
394
- * @throws {RequiredError}
395
- */
396
- createCategory(createCategoryRequestDto: CreateCategoryRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCategoryResponseClass> {
397
- return localVarFp.createCategory(createCategoryRequestDto, authorization, options).then((request) => request(axios, basePath));
398
- },
399
- /**
400
- * This will delete a task category by code.
401
- * @summary Delete the category
402
- * @param {string} code Unique identifier for the object.
403
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
404
- * @param {*} [options] Override http request option.
405
- * @throws {RequiredError}
406
- */
407
- deleteCategory(code: string, authorization?: string, options?: any): AxiosPromise<void> {
408
- return localVarFp.deleteCategory(code, authorization, options).then((request) => request(axios, basePath));
409
- },
410
- /**
411
- * Get category by code.
412
- * @summary Retrieve the category
413
- * @param {string} code
414
- * @param {string} expand
415
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
416
- * @param {*} [options] Override http request option.
417
- * @throws {RequiredError}
418
- */
419
- getCategory(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetCategoryResponseClass> {
420
- return localVarFp.getCategory(code, expand, authorization, options).then((request) => request(axios, basePath));
421
- },
422
- /**
423
- * Retrieves a list of categories.
424
- * @summary List categories
425
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
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;
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;
431
- * @param {*} [options] Override http request option.
432
- * @throws {RequiredError}
433
- */
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));
436
- },
437
- /**
438
- * This will partially update a category by code with the provided fields.
439
- * @summary Update the category
440
- * @param {string} code
441
- * @param {PatchCategoryRequestDto} patchCategoryRequestDto
442
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
443
- * @param {*} [options] Override http request option.
444
- * @throws {RequiredError}
445
- */
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));
448
- },
449
- };
450
- };
451
-
452
- /**
453
- * Request parameters for createCategory operation in CategoriesApi.
454
- * @export
455
- * @interface CategoriesApiCreateCategoryRequest
456
- */
457
- export interface CategoriesApiCreateCategoryRequest {
458
- /**
459
- *
460
- * @type {CreateCategoryRequestDto}
461
- * @memberof CategoriesApiCreateCategory
462
- */
463
- readonly createCategoryRequestDto: CreateCategoryRequestDto
464
-
465
- /**
466
- * Bearer Token: provided by the login endpoint under the name accessToken.
467
- * @type {string}
468
- * @memberof CategoriesApiCreateCategory
469
- */
470
- readonly authorization?: string
471
- }
472
-
473
- /**
474
- * Request parameters for deleteCategory operation in CategoriesApi.
475
- * @export
476
- * @interface CategoriesApiDeleteCategoryRequest
477
- */
478
- export interface CategoriesApiDeleteCategoryRequest {
479
- /**
480
- * Unique identifier for the object.
481
- * @type {string}
482
- * @memberof CategoriesApiDeleteCategory
483
- */
484
- readonly code: string
485
-
486
- /**
487
- * Bearer Token: provided by the login endpoint under the name accessToken.
488
- * @type {string}
489
- * @memberof CategoriesApiDeleteCategory
490
- */
491
- readonly authorization?: string
492
- }
493
-
494
- /**
495
- * Request parameters for getCategory operation in CategoriesApi.
496
- * @export
497
- * @interface CategoriesApiGetCategoryRequest
498
- */
499
- export interface CategoriesApiGetCategoryRequest {
500
- /**
501
- *
502
- * @type {string}
503
- * @memberof CategoriesApiGetCategory
504
- */
505
- readonly code: string
506
-
507
- /**
508
- *
509
- * @type {string}
510
- * @memberof CategoriesApiGetCategory
511
- */
512
- readonly expand: string
513
-
514
- /**
515
- * Bearer Token: provided by the login endpoint under the name accessToken.
516
- * @type {string}
517
- * @memberof CategoriesApiGetCategory
518
- */
519
- readonly authorization?: string
520
- }
521
-
522
- /**
523
- * Request parameters for listCategories operation in CategoriesApi.
524
- * @export
525
- * @interface CategoriesApiListCategoriesRequest
526
- */
527
- export interface CategoriesApiListCategoriesRequest {
528
- /**
529
- * Bearer Token: provided by the login endpoint under the name accessToken.
530
- * @type {string}
531
- * @memberof CategoriesApiListCategories
532
- */
533
- readonly authorization?: string
534
-
535
- /**
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;
537
- * @type {string}
538
- * @memberof CategoriesApiListCategories
539
- */
540
- readonly filter?: string
541
-
542
- /**
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;
544
- * @type {string}
545
- * @memberof CategoriesApiListCategories
546
- */
547
- readonly filters?: string
548
-
549
- /**
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;
558
- * @type {string}
559
- * @memberof CategoriesApiListCategories
560
- */
561
- readonly order?: string
562
-
563
- /**
564
- * 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;
565
- * @type {string}
566
- * @memberof CategoriesApiListCategories
567
- */
568
- readonly expand?: string
569
- }
570
-
571
- /**
572
- * Request parameters for patchCategory operation in CategoriesApi.
573
- * @export
574
- * @interface CategoriesApiPatchCategoryRequest
575
- */
576
- export interface CategoriesApiPatchCategoryRequest {
577
- /**
578
- *
579
- * @type {string}
580
- * @memberof CategoriesApiPatchCategory
581
- */
582
- readonly code: string
583
-
584
- /**
585
- *
586
- * @type {PatchCategoryRequestDto}
587
- * @memberof CategoriesApiPatchCategory
588
- */
589
- readonly patchCategoryRequestDto: PatchCategoryRequestDto
590
-
591
- /**
592
- * Bearer Token: provided by the login endpoint under the name accessToken.
593
- * @type {string}
594
- * @memberof CategoriesApiPatchCategory
595
- */
596
- readonly authorization?: string
597
- }
598
-
599
- /**
600
- * CategoriesApi - object-oriented interface
601
- * @export
602
- * @class CategoriesApi
603
- * @extends {BaseAPI}
604
- */
605
- export class CategoriesApi extends BaseAPI {
606
- /**
607
- * This will create a category.
608
- * @summary Create the category
609
- * @param {CategoriesApiCreateCategoryRequest} requestParameters Request parameters.
610
- * @param {*} [options] Override http request option.
611
- * @throws {RequiredError}
612
- * @memberof CategoriesApi
613
- */
614
- public createCategory(requestParameters: CategoriesApiCreateCategoryRequest, options?: AxiosRequestConfig) {
615
- return CategoriesApiFp(this.configuration).createCategory(requestParameters.createCategoryRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
616
- }
617
-
618
- /**
619
- * This will delete a task category by code.
620
- * @summary Delete the category
621
- * @param {CategoriesApiDeleteCategoryRequest} requestParameters Request parameters.
622
- * @param {*} [options] Override http request option.
623
- * @throws {RequiredError}
624
- * @memberof CategoriesApi
625
- */
626
- public deleteCategory(requestParameters: CategoriesApiDeleteCategoryRequest, options?: AxiosRequestConfig) {
627
- return CategoriesApiFp(this.configuration).deleteCategory(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
628
- }
629
-
630
- /**
631
- * Get category by code.
632
- * @summary Retrieve the category
633
- * @param {CategoriesApiGetCategoryRequest} requestParameters Request parameters.
634
- * @param {*} [options] Override http request option.
635
- * @throws {RequiredError}
636
- * @memberof CategoriesApi
637
- */
638
- public getCategory(requestParameters: CategoriesApiGetCategoryRequest, options?: AxiosRequestConfig) {
639
- return CategoriesApiFp(this.configuration).getCategory(requestParameters.code, requestParameters.expand, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
640
- }
641
-
642
- /**
643
- * Retrieves a list of categories.
644
- * @summary List categories
645
- * @param {CategoriesApiListCategoriesRequest} requestParameters Request parameters.
646
- * @param {*} [options] Override http request option.
647
- * @throws {RequiredError}
648
- * @memberof CategoriesApi
649
- */
650
- public listCategories(requestParameters: CategoriesApiListCategoriesRequest = {}, options?: AxiosRequestConfig) {
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));
652
- }
653
-
654
- /**
655
- * This will partially update a category by code with the provided fields.
656
- * @summary Update the category
657
- * @param {CategoriesApiPatchCategoryRequest} requestParameters Request parameters.
658
- * @param {*} [options] Override http request option.
659
- * @throws {RequiredError}
660
- * @memberof CategoriesApi
661
- */
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));
664
- }
665
- }