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