@emilgroup/task-sdk 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 -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
package/api/tasks-api.ts DELETED
@@ -1,693 +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 { CreateTaskRequestDto } from '../models';
25
- // @ts-ignore
26
- import { CreateTaskResponseClass } from '../models';
27
- // @ts-ignore
28
- import { GetTaskResponseClass } from '../models';
29
- // @ts-ignore
30
- import { ListTasksResponseClass } from '../models';
31
- // @ts-ignore
32
- import { PatchTaskRequestDto } from '../models';
33
- // @ts-ignore
34
- import { PatchTaskResponseClass } from '../models';
35
- /**
36
- * TasksApi - axios parameter creator
37
- * @export
38
- */
39
- export const TasksApiAxiosParamCreator = function (configuration?: Configuration) {
40
- return {
41
- /**
42
- * This will create task.
43
- * @summary Create the task
44
- * @param {CreateTaskRequestDto} createTaskRequestDto
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
- createTask: async (createTaskRequestDto: CreateTaskRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
50
- // verify required parameter 'createTaskRequestDto' is not null or undefined
51
- assertParamExists('createTask', 'createTaskRequestDto', createTaskRequestDto)
52
- const localVarPath = `/taskservice/v1/tasks`;
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(createTaskRequestDto, localVarRequestOptions, configuration)
82
-
83
- return {
84
- url: toPathString(localVarUrlObj),
85
- options: localVarRequestOptions,
86
- };
87
- },
88
- /**
89
- * This will delete a task by code.
90
- * @summary Delete the task
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
- deleteTask: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
97
- // verify required parameter 'code' is not null or undefined
98
- assertParamExists('deleteTask', 'code', code)
99
- const localVarPath = `/taskservice/v1/tasks/{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
- * This will get a task by code.
135
- * @summary Retrieve the task
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
- getTask: async (code: string, expand: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
143
- // verify required parameter 'code' is not null or undefined
144
- assertParamExists('getTask', 'code', code)
145
- // verify required parameter 'expand' is not null or undefined
146
- assertParamExists('getTask', 'expand', expand)
147
- const localVarPath = `/taskservice/v1/tasks/{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 tasks.
187
- * @summary List tasks
188
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
189
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
190
- * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
191
- * @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, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug&lt;/i&gt;
192
- * @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: subject, description&lt;/i&gt;
193
- * @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, assignee, reporter, dueDate&lt;/i&gt;
194
- * @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; &lt;i&gt;Allowed values: category, status&lt;i&gt;
195
- * @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, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug&lt;/i&gt;
196
- * @param {*} [options] Override http request option.
197
- * @throws {RequiredError}
198
- */
199
- listTasks: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
200
- const localVarPath = `/taskservice/v1/tasks`;
201
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
202
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
203
- let baseOptions;
204
- let baseAccessToken;
205
- if (configuration) {
206
- baseOptions = configuration.baseOptions;
207
- baseAccessToken = configuration.accessToken;
208
- }
209
-
210
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
211
- const localVarHeaderParameter = {} as any;
212
- const localVarQueryParameter = {} as any;
213
-
214
- // authentication bearer required
215
- // http bearer authentication required
216
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
217
-
218
- if (pageSize !== undefined) {
219
- localVarQueryParameter['pageSize'] = pageSize;
220
- }
221
-
222
- if (pageToken !== undefined) {
223
- localVarQueryParameter['pageToken'] = pageToken;
224
- }
225
-
226
- if (filter !== undefined) {
227
- localVarQueryParameter['filter'] = filter;
228
- }
229
-
230
- if (search !== undefined) {
231
- localVarQueryParameter['search'] = search;
232
- }
233
-
234
- if (order !== undefined) {
235
- localVarQueryParameter['order'] = order;
236
- }
237
-
238
- if (expand !== undefined) {
239
- localVarQueryParameter['expand'] = expand;
240
- }
241
-
242
- if (filters !== undefined) {
243
- localVarQueryParameter['filters'] = filters;
244
- }
245
-
246
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
247
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
248
- }
249
-
250
-
251
-
252
- setSearchParams(localVarUrlObj, localVarQueryParameter);
253
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
254
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
255
-
256
- return {
257
- url: toPathString(localVarUrlObj),
258
- options: localVarRequestOptions,
259
- };
260
- },
261
- /**
262
- * This will partially update a task by code with the provided fields.
263
- * @summary Update the task
264
- * @param {string} code
265
- * @param {PatchTaskRequestDto} patchTaskRequestDto
266
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
267
- * @param {*} [options] Override http request option.
268
- * @throws {RequiredError}
269
- */
270
- patchTask: async (code: string, patchTaskRequestDto: PatchTaskRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
271
- // verify required parameter 'code' is not null or undefined
272
- assertParamExists('patchTask', 'code', code)
273
- // verify required parameter 'patchTaskRequestDto' is not null or undefined
274
- assertParamExists('patchTask', 'patchTaskRequestDto', patchTaskRequestDto)
275
- const localVarPath = `/taskservice/v1/tasks/{code}`
276
- .replace(`{${"code"}}`, encodeURIComponent(String(code)));
277
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
278
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
279
- let baseOptions;
280
- let baseAccessToken;
281
- if (configuration) {
282
- baseOptions = configuration.baseOptions;
283
- baseAccessToken = configuration.accessToken;
284
- }
285
-
286
- const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
287
- const localVarHeaderParameter = {} as any;
288
- const localVarQueryParameter = {} as any;
289
-
290
- // authentication bearer required
291
- // http bearer authentication required
292
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
293
-
294
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
295
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
296
- }
297
-
298
-
299
-
300
- localVarHeaderParameter['Content-Type'] = 'application/json';
301
-
302
- setSearchParams(localVarUrlObj, localVarQueryParameter);
303
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
304
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
305
- localVarRequestOptions.data = serializeDataIfNeeded(patchTaskRequestDto, localVarRequestOptions, configuration)
306
-
307
- return {
308
- url: toPathString(localVarUrlObj),
309
- options: localVarRequestOptions,
310
- };
311
- },
312
- }
313
- };
314
-
315
- /**
316
- * TasksApi - functional programming interface
317
- * @export
318
- */
319
- export const TasksApiFp = function(configuration?: Configuration) {
320
- const localVarAxiosParamCreator = TasksApiAxiosParamCreator(configuration)
321
- return {
322
- /**
323
- * This will create task.
324
- * @summary Create the task
325
- * @param {CreateTaskRequestDto} createTaskRequestDto
326
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
327
- * @param {*} [options] Override http request option.
328
- * @throws {RequiredError}
329
- */
330
- async createTask(createTaskRequestDto: CreateTaskRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateTaskResponseClass>> {
331
- const localVarAxiosArgs = await localVarAxiosParamCreator.createTask(createTaskRequestDto, authorization, options);
332
- return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
333
- },
334
- /**
335
- * This will delete a task by code.
336
- * @summary Delete the task
337
- * @param {string} code Unique identifier for the object.
338
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
339
- * @param {*} [options] Override http request option.
340
- * @throws {RequiredError}
341
- */
342
- async deleteTask(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
343
- const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTask(code, authorization, options);
344
- return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
345
- },
346
- /**
347
- * This will get a task by code.
348
- * @summary Retrieve the task
349
- * @param {string} code
350
- * @param {string} expand
351
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
352
- * @param {*} [options] Override http request option.
353
- * @throws {RequiredError}
354
- */
355
- async getTask(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTaskResponseClass>> {
356
- const localVarAxiosArgs = await localVarAxiosParamCreator.getTask(code, expand, authorization, options);
357
- return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
358
- },
359
- /**
360
- * Retrieves a list of tasks.
361
- * @summary List tasks
362
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
363
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
364
- * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
365
- * @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, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug&lt;/i&gt;
366
- * @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: subject, description&lt;/i&gt;
367
- * @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, assignee, reporter, dueDate&lt;/i&gt;
368
- * @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; &lt;i&gt;Allowed values: category, status&lt;i&gt;
369
- * @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, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug&lt;/i&gt;
370
- * @param {*} [options] Override http request option.
371
- * @throws {RequiredError}
372
- */
373
- async listTasks(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTasksResponseClass>> {
374
- const localVarAxiosArgs = await localVarAxiosParamCreator.listTasks(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
375
- return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
376
- },
377
- /**
378
- * This will partially update a task by code with the provided fields.
379
- * @summary Update the task
380
- * @param {string} code
381
- * @param {PatchTaskRequestDto} patchTaskRequestDto
382
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
383
- * @param {*} [options] Override http request option.
384
- * @throws {RequiredError}
385
- */
386
- async patchTask(code: string, patchTaskRequestDto: PatchTaskRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PatchTaskResponseClass>> {
387
- const localVarAxiosArgs = await localVarAxiosParamCreator.patchTask(code, patchTaskRequestDto, authorization, options);
388
- return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
389
- },
390
- }
391
- };
392
-
393
- /**
394
- * TasksApi - factory interface
395
- * @export
396
- */
397
- export const TasksApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
398
- const localVarFp = TasksApiFp(configuration)
399
- return {
400
- /**
401
- * This will create task.
402
- * @summary Create the task
403
- * @param {CreateTaskRequestDto} createTaskRequestDto
404
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
405
- * @param {*} [options] Override http request option.
406
- * @throws {RequiredError}
407
- */
408
- createTask(createTaskRequestDto: CreateTaskRequestDto, authorization?: string, options?: any): AxiosPromise<CreateTaskResponseClass> {
409
- return localVarFp.createTask(createTaskRequestDto, authorization, options).then((request) => request(axios, basePath));
410
- },
411
- /**
412
- * This will delete a task by code.
413
- * @summary Delete the task
414
- * @param {string} code Unique identifier for the object.
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
- deleteTask(code: string, authorization?: string, options?: any): AxiosPromise<void> {
420
- return localVarFp.deleteTask(code, authorization, options).then((request) => request(axios, basePath));
421
- },
422
- /**
423
- * This will get a task by code.
424
- * @summary Retrieve the task
425
- * @param {string} code
426
- * @param {string} expand
427
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
428
- * @param {*} [options] Override http request option.
429
- * @throws {RequiredError}
430
- */
431
- getTask(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetTaskResponseClass> {
432
- return localVarFp.getTask(code, expand, authorization, options).then((request) => request(axios, basePath));
433
- },
434
- /**
435
- * Retrieves a list of tasks.
436
- * @summary List tasks
437
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
438
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
439
- * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
440
- * @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, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug&lt;/i&gt;
441
- * @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: subject, description&lt;/i&gt;
442
- * @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, assignee, reporter, dueDate&lt;/i&gt;
443
- * @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; &lt;i&gt;Allowed values: category, status&lt;i&gt;
444
- * @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, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug&lt;/i&gt;
445
- * @param {*} [options] Override http request option.
446
- * @throws {RequiredError}
447
- */
448
- listTasks(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListTasksResponseClass> {
449
- return localVarFp.listTasks(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
450
- },
451
- /**
452
- * This will partially update a task by code with the provided fields.
453
- * @summary Update the task
454
- * @param {string} code
455
- * @param {PatchTaskRequestDto} patchTaskRequestDto
456
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
457
- * @param {*} [options] Override http request option.
458
- * @throws {RequiredError}
459
- */
460
- patchTask(code: string, patchTaskRequestDto: PatchTaskRequestDto, authorization?: string, options?: any): AxiosPromise<PatchTaskResponseClass> {
461
- return localVarFp.patchTask(code, patchTaskRequestDto, authorization, options).then((request) => request(axios, basePath));
462
- },
463
- };
464
- };
465
-
466
- /**
467
- * Request parameters for createTask operation in TasksApi.
468
- * @export
469
- * @interface TasksApiCreateTaskRequest
470
- */
471
- export interface TasksApiCreateTaskRequest {
472
- /**
473
- *
474
- * @type {CreateTaskRequestDto}
475
- * @memberof TasksApiCreateTask
476
- */
477
- readonly createTaskRequestDto: CreateTaskRequestDto
478
-
479
- /**
480
- * Bearer Token: provided by the login endpoint under the name accessToken.
481
- * @type {string}
482
- * @memberof TasksApiCreateTask
483
- */
484
- readonly authorization?: string
485
- }
486
-
487
- /**
488
- * Request parameters for deleteTask operation in TasksApi.
489
- * @export
490
- * @interface TasksApiDeleteTaskRequest
491
- */
492
- export interface TasksApiDeleteTaskRequest {
493
- /**
494
- * Unique identifier for the object.
495
- * @type {string}
496
- * @memberof TasksApiDeleteTask
497
- */
498
- readonly code: string
499
-
500
- /**
501
- * Bearer Token: provided by the login endpoint under the name accessToken.
502
- * @type {string}
503
- * @memberof TasksApiDeleteTask
504
- */
505
- readonly authorization?: string
506
- }
507
-
508
- /**
509
- * Request parameters for getTask operation in TasksApi.
510
- * @export
511
- * @interface TasksApiGetTaskRequest
512
- */
513
- export interface TasksApiGetTaskRequest {
514
- /**
515
- *
516
- * @type {string}
517
- * @memberof TasksApiGetTask
518
- */
519
- readonly code: string
520
-
521
- /**
522
- *
523
- * @type {string}
524
- * @memberof TasksApiGetTask
525
- */
526
- readonly expand: string
527
-
528
- /**
529
- * Bearer Token: provided by the login endpoint under the name accessToken.
530
- * @type {string}
531
- * @memberof TasksApiGetTask
532
- */
533
- readonly authorization?: string
534
- }
535
-
536
- /**
537
- * Request parameters for listTasks operation in TasksApi.
538
- * @export
539
- * @interface TasksApiListTasksRequest
540
- */
541
- export interface TasksApiListTasksRequest {
542
- /**
543
- * Bearer Token: provided by the login endpoint under the name accessToken.
544
- * @type {string}
545
- * @memberof TasksApiListTasks
546
- */
547
- readonly authorization?: string
548
-
549
- /**
550
- * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
551
- * @type {number}
552
- * @memberof TasksApiListTasks
553
- */
554
- readonly pageSize?: number
555
-
556
- /**
557
- * A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
558
- * @type {string}
559
- * @memberof TasksApiListTasks
560
- */
561
- readonly pageToken?: string
562
-
563
- /**
564
- * 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, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug&lt;/i&gt;
565
- * @type {string}
566
- * @memberof TasksApiListTasks
567
- */
568
- readonly filter?: string
569
-
570
- /**
571
- * 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: subject, description&lt;/i&gt;
572
- * @type {string}
573
- * @memberof TasksApiListTasks
574
- */
575
- readonly search?: string
576
-
577
- /**
578
- * 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, assignee, reporter, dueDate&lt;/i&gt;
579
- * @type {string}
580
- * @memberof TasksApiListTasks
581
- */
582
- readonly order?: string
583
-
584
- /**
585
- * 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; &lt;i&gt;Allowed values: category, status&lt;i&gt;
586
- * @type {string}
587
- * @memberof TasksApiListTasks
588
- */
589
- readonly expand?: string
590
-
591
- /**
592
- * 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, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug&lt;/i&gt;
593
- * @type {string}
594
- * @memberof TasksApiListTasks
595
- */
596
- readonly filters?: string
597
- }
598
-
599
- /**
600
- * Request parameters for patchTask operation in TasksApi.
601
- * @export
602
- * @interface TasksApiPatchTaskRequest
603
- */
604
- export interface TasksApiPatchTaskRequest {
605
- /**
606
- *
607
- * @type {string}
608
- * @memberof TasksApiPatchTask
609
- */
610
- readonly code: string
611
-
612
- /**
613
- *
614
- * @type {PatchTaskRequestDto}
615
- * @memberof TasksApiPatchTask
616
- */
617
- readonly patchTaskRequestDto: PatchTaskRequestDto
618
-
619
- /**
620
- * Bearer Token: provided by the login endpoint under the name accessToken.
621
- * @type {string}
622
- * @memberof TasksApiPatchTask
623
- */
624
- readonly authorization?: string
625
- }
626
-
627
- /**
628
- * TasksApi - object-oriented interface
629
- * @export
630
- * @class TasksApi
631
- * @extends {BaseAPI}
632
- */
633
- export class TasksApi extends BaseAPI {
634
- /**
635
- * This will create task.
636
- * @summary Create the task
637
- * @param {TasksApiCreateTaskRequest} requestParameters Request parameters.
638
- * @param {*} [options] Override http request option.
639
- * @throws {RequiredError}
640
- * @memberof TasksApi
641
- */
642
- public createTask(requestParameters: TasksApiCreateTaskRequest, options?: AxiosRequestConfig) {
643
- return TasksApiFp(this.configuration).createTask(requestParameters.createTaskRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
644
- }
645
-
646
- /**
647
- * This will delete a task by code.
648
- * @summary Delete the task
649
- * @param {TasksApiDeleteTaskRequest} requestParameters Request parameters.
650
- * @param {*} [options] Override http request option.
651
- * @throws {RequiredError}
652
- * @memberof TasksApi
653
- */
654
- public deleteTask(requestParameters: TasksApiDeleteTaskRequest, options?: AxiosRequestConfig) {
655
- return TasksApiFp(this.configuration).deleteTask(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
656
- }
657
-
658
- /**
659
- * This will get a task by code.
660
- * @summary Retrieve the task
661
- * @param {TasksApiGetTaskRequest} requestParameters Request parameters.
662
- * @param {*} [options] Override http request option.
663
- * @throws {RequiredError}
664
- * @memberof TasksApi
665
- */
666
- public getTask(requestParameters: TasksApiGetTaskRequest, options?: AxiosRequestConfig) {
667
- return TasksApiFp(this.configuration).getTask(requestParameters.code, requestParameters.expand, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
668
- }
669
-
670
- /**
671
- * Retrieves a list of tasks.
672
- * @summary List tasks
673
- * @param {TasksApiListTasksRequest} requestParameters Request parameters.
674
- * @param {*} [options] Override http request option.
675
- * @throws {RequiredError}
676
- * @memberof TasksApi
677
- */
678
- public listTasks(requestParameters: TasksApiListTasksRequest = {}, options?: AxiosRequestConfig) {
679
- return TasksApiFp(this.configuration).listTasks(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
680
- }
681
-
682
- /**
683
- * This will partially update a task by code with the provided fields.
684
- * @summary Update the task
685
- * @param {TasksApiPatchTaskRequest} requestParameters Request parameters.
686
- * @param {*} [options] Override http request option.
687
- * @throws {RequiredError}
688
- * @memberof TasksApi
689
- */
690
- public patchTask(requestParameters: TasksApiPatchTaskRequest, options?: AxiosRequestConfig) {
691
- return TasksApiFp(this.configuration).patchTask(requestParameters.code, requestParameters.patchTaskRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
692
- }
693
- }