@emilgroup/task-sdk-node 1.2.0 → 1.2.1-beta.1

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 (39) hide show
  1. package/.openapi-generator/FILES +10 -0
  2. package/README.md +2 -2
  3. package/api/reminders-api.ts +877 -0
  4. package/api.ts +2 -0
  5. package/dist/api/reminders-api.d.ts +487 -0
  6. package/dist/api/reminders-api.js +821 -0
  7. package/dist/api.d.ts +1 -0
  8. package/dist/api.js +1 -0
  9. package/dist/models/create-reminder-request-dto.d.ts +54 -0
  10. package/dist/models/create-reminder-request-dto.js +15 -0
  11. package/dist/models/create-reminder-response-class.d.ts +25 -0
  12. package/dist/models/create-reminder-response-class.js +15 -0
  13. package/dist/models/get-reminder-counts-response-class.d.ts +30 -0
  14. package/dist/models/get-reminder-counts-response-class.js +15 -0
  15. package/dist/models/get-reminder-response-class.d.ts +25 -0
  16. package/dist/models/get-reminder-response-class.js +15 -0
  17. package/dist/models/index.d.ts +9 -0
  18. package/dist/models/index.js +9 -0
  19. package/dist/models/list-reminders-response-class.d.ts +43 -0
  20. package/dist/models/list-reminders-response-class.js +15 -0
  21. package/dist/models/mark-reminder-done-response-class.d.ts +25 -0
  22. package/dist/models/mark-reminder-done-response-class.js +15 -0
  23. package/dist/models/patch-reminder-request-dto.d.ts +42 -0
  24. package/dist/models/patch-reminder-request-dto.js +15 -0
  25. package/dist/models/patch-reminder-response-class.d.ts +25 -0
  26. package/dist/models/patch-reminder-response-class.js +15 -0
  27. package/dist/models/reminder-class.d.ts +120 -0
  28. package/dist/models/reminder-class.js +15 -0
  29. package/models/create-reminder-request-dto.ts +60 -0
  30. package/models/create-reminder-response-class.ts +31 -0
  31. package/models/get-reminder-counts-response-class.ts +36 -0
  32. package/models/get-reminder-response-class.ts +31 -0
  33. package/models/index.ts +9 -0
  34. package/models/list-reminders-response-class.ts +49 -0
  35. package/models/mark-reminder-done-response-class.ts +31 -0
  36. package/models/patch-reminder-request-dto.ts +48 -0
  37. package/models/patch-reminder-response-class.ts +31 -0
  38. package/models/reminder-class.ts +126 -0
  39. package/package.json +1 -1
@@ -0,0 +1,877 @@
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 { CreateReminderRequestDto } from '../models';
25
+ // @ts-ignore
26
+ import { CreateReminderResponseClass } from '../models';
27
+ // @ts-ignore
28
+ import { GetReminderCountsResponseClass } from '../models';
29
+ // @ts-ignore
30
+ import { GetReminderResponseClass } from '../models';
31
+ // @ts-ignore
32
+ import { ListRemindersResponseClass } from '../models';
33
+ // @ts-ignore
34
+ import { MarkReminderDoneResponseClass } from '../models';
35
+ // @ts-ignore
36
+ import { PatchReminderRequestDto } from '../models';
37
+ // @ts-ignore
38
+ import { PatchReminderResponseClass } from '../models';
39
+ // URLSearchParams not necessarily used
40
+ // @ts-ignore
41
+ import { URL, URLSearchParams } from 'url';
42
+ const FormData = require('form-data');
43
+ /**
44
+ * RemindersApi - axios parameter creator
45
+ * @export
46
+ */
47
+ export const RemindersApiAxiosParamCreator = function (configuration?: Configuration) {
48
+ return {
49
+ /**
50
+ * This will create a reminder.
51
+ * @summary Create the reminder
52
+ * @param {CreateReminderRequestDto} createReminderRequestDto
53
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
54
+ * @param {*} [options] Override http request option.
55
+ * @throws {RequiredError}
56
+ */
57
+ createReminder: async (createReminderRequestDto: CreateReminderRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
58
+ // verify required parameter 'createReminderRequestDto' is not null or undefined
59
+ assertParamExists('createReminder', 'createReminderRequestDto', createReminderRequestDto)
60
+ const localVarPath = `/taskservice/v1/reminders`;
61
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
62
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
63
+ let baseOptions;
64
+ let baseAccessToken;
65
+ if (configuration) {
66
+ baseOptions = configuration.baseOptions;
67
+ baseAccessToken = configuration.accessToken;
68
+ }
69
+
70
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
71
+ const localVarHeaderParameter = {} as any;
72
+ const localVarQueryParameter = {} as any;
73
+
74
+ // authentication bearer required
75
+ // http bearer authentication required
76
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
77
+
78
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
79
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
80
+ }
81
+
82
+
83
+
84
+ localVarHeaderParameter['Content-Type'] = 'application/json';
85
+
86
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
87
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
88
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
89
+ localVarRequestOptions.data = serializeDataIfNeeded(createReminderRequestDto, localVarRequestOptions, configuration)
90
+
91
+ return {
92
+ url: toPathString(localVarUrlObj),
93
+ options: localVarRequestOptions,
94
+ };
95
+ },
96
+ /**
97
+ * This will delete a reminder.
98
+ * @summary Delete the reminder
99
+ * @param {string} code Unique identifier for the object.
100
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
101
+ * @param {*} [options] Override http request option.
102
+ * @throws {RequiredError}
103
+ */
104
+ deleteReminder: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
105
+ // verify required parameter 'code' is not null or undefined
106
+ assertParamExists('deleteReminder', 'code', code)
107
+ const localVarPath = `/taskservice/v1/reminders/{code}`
108
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
109
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
110
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
111
+ let baseOptions;
112
+ let baseAccessToken;
113
+ if (configuration) {
114
+ baseOptions = configuration.baseOptions;
115
+ baseAccessToken = configuration.accessToken;
116
+ }
117
+
118
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
119
+ const localVarHeaderParameter = {} as any;
120
+ const localVarQueryParameter = {} as any;
121
+
122
+ // authentication bearer required
123
+ // http bearer authentication required
124
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
125
+
126
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
127
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
128
+ }
129
+
130
+
131
+
132
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
133
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
134
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
135
+
136
+ return {
137
+ url: toPathString(localVarUrlObj),
138
+ options: localVarRequestOptions,
139
+ };
140
+ },
141
+ /**
142
+ * This will get a reminder by code.
143
+ * @summary Retrieve the reminder
144
+ * @param {string} code Unique identifier for the object.
145
+ * @param {string} expand
146
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
147
+ * @param {*} [options] Override http request option.
148
+ * @throws {RequiredError}
149
+ */
150
+ getReminder: async (code: string, expand: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
151
+ // verify required parameter 'code' is not null or undefined
152
+ assertParamExists('getReminder', 'code', code)
153
+ // verify required parameter 'expand' is not null or undefined
154
+ assertParamExists('getReminder', 'expand', expand)
155
+ const localVarPath = `/taskservice/v1/reminders/{code}`
156
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
157
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
158
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
159
+ let baseOptions;
160
+ let baseAccessToken;
161
+ if (configuration) {
162
+ baseOptions = configuration.baseOptions;
163
+ baseAccessToken = configuration.accessToken;
164
+ }
165
+
166
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
167
+ const localVarHeaderParameter = {} as any;
168
+ const localVarQueryParameter = {} as any;
169
+
170
+ // authentication bearer required
171
+ // http bearer authentication required
172
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
173
+
174
+ if (expand !== undefined) {
175
+ localVarQueryParameter['expand'] = expand;
176
+ }
177
+
178
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
179
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
180
+ }
181
+
182
+
183
+
184
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
185
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
186
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
187
+
188
+ return {
189
+ url: toPathString(localVarUrlObj),
190
+ options: localVarRequestOptions,
191
+ };
192
+ },
193
+ /**
194
+ * This will get reminder counts by status.
195
+ * @summary Retrieve the reminder counts
196
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
197
+ * @param {*} [options] Override http request option.
198
+ * @throws {RequiredError}
199
+ */
200
+ getReminderCounts: async (authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
201
+ const localVarPath = `/taskservice/v1/reminders/counts`;
202
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
203
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
204
+ let baseOptions;
205
+ let baseAccessToken;
206
+ if (configuration) {
207
+ baseOptions = configuration.baseOptions;
208
+ baseAccessToken = configuration.accessToken;
209
+ }
210
+
211
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
212
+ const localVarHeaderParameter = {} as any;
213
+ const localVarQueryParameter = {} as any;
214
+
215
+ // authentication bearer required
216
+ // http bearer authentication required
217
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
218
+
219
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
220
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
221
+ }
222
+
223
+
224
+
225
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
226
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
227
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
228
+
229
+ return {
230
+ url: toPathString(localVarUrlObj),
231
+ options: localVarRequestOptions,
232
+ };
233
+ },
234
+ /**
235
+ * Retrieves a list of reminders.
236
+ * @summary List reminders
237
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
238
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
239
+ * @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.
240
+ * @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, entityType, entityCode, isDone, userSub, dueAt, createdAt&lt;/i&gt;
241
+ * @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: title, description&lt;/i&gt;
242
+ * @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, dueAt, isDone&lt;/i&gt;
243
+ * @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;
244
+ * @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, entityType, entityCode, isDone, userSub, dueAt, createdAt&lt;/i&gt;
245
+ * @param {*} [options] Override http request option.
246
+ * @throws {RequiredError}
247
+ */
248
+ listReminders: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
249
+ const localVarPath = `/taskservice/v1/reminders`;
250
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
251
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
252
+ let baseOptions;
253
+ let baseAccessToken;
254
+ if (configuration) {
255
+ baseOptions = configuration.baseOptions;
256
+ baseAccessToken = configuration.accessToken;
257
+ }
258
+
259
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
260
+ const localVarHeaderParameter = {} as any;
261
+ const localVarQueryParameter = {} as any;
262
+
263
+ // authentication bearer required
264
+ // http bearer authentication required
265
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
266
+
267
+ if (pageSize !== undefined) {
268
+ localVarQueryParameter['pageSize'] = pageSize;
269
+ }
270
+
271
+ if (pageToken !== undefined) {
272
+ localVarQueryParameter['pageToken'] = pageToken;
273
+ }
274
+
275
+ if (filter !== undefined) {
276
+ localVarQueryParameter['filter'] = filter;
277
+ }
278
+
279
+ if (search !== undefined) {
280
+ localVarQueryParameter['search'] = search;
281
+ }
282
+
283
+ if (order !== undefined) {
284
+ localVarQueryParameter['order'] = order;
285
+ }
286
+
287
+ if (expand !== undefined) {
288
+ localVarQueryParameter['expand'] = expand;
289
+ }
290
+
291
+ if (filters !== undefined) {
292
+ localVarQueryParameter['filters'] = filters;
293
+ }
294
+
295
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
296
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
297
+ }
298
+
299
+
300
+
301
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
302
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
303
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
304
+
305
+ return {
306
+ url: toPathString(localVarUrlObj),
307
+ options: localVarRequestOptions,
308
+ };
309
+ },
310
+ /**
311
+ * This will mark a reminder as done.
312
+ * @summary Create the reminder done
313
+ * @param {string} code
314
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
315
+ * @param {*} [options] Override http request option.
316
+ * @throws {RequiredError}
317
+ */
318
+ markReminderDone: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
319
+ // verify required parameter 'code' is not null or undefined
320
+ assertParamExists('markReminderDone', 'code', code)
321
+ const localVarPath = `/taskservice/v1/reminders/{code}/done`
322
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
323
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
324
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
325
+ let baseOptions;
326
+ let baseAccessToken;
327
+ if (configuration) {
328
+ baseOptions = configuration.baseOptions;
329
+ baseAccessToken = configuration.accessToken;
330
+ }
331
+
332
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
333
+ const localVarHeaderParameter = {} as any;
334
+ const localVarQueryParameter = {} as any;
335
+
336
+ // authentication bearer required
337
+ // http bearer authentication required
338
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
339
+
340
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
341
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
342
+ }
343
+
344
+
345
+
346
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
347
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
348
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
349
+
350
+ return {
351
+ url: toPathString(localVarUrlObj),
352
+ options: localVarRequestOptions,
353
+ };
354
+ },
355
+ /**
356
+ * This will patch a reminder.
357
+ * @summary Update the reminder
358
+ * @param {PatchReminderRequestDto} patchReminderRequestDto
359
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
360
+ * @param {*} [options] Override http request option.
361
+ * @throws {RequiredError}
362
+ */
363
+ patchReminder: async (patchReminderRequestDto: PatchReminderRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
364
+ // verify required parameter 'patchReminderRequestDto' is not null or undefined
365
+ assertParamExists('patchReminder', 'patchReminderRequestDto', patchReminderRequestDto)
366
+ const localVarPath = `/taskservice/v1/reminders`;
367
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
368
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
369
+ let baseOptions;
370
+ let baseAccessToken;
371
+ if (configuration) {
372
+ baseOptions = configuration.baseOptions;
373
+ baseAccessToken = configuration.accessToken;
374
+ }
375
+
376
+ const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
377
+ const localVarHeaderParameter = {} as any;
378
+ const localVarQueryParameter = {} as any;
379
+
380
+ // authentication bearer required
381
+ // http bearer authentication required
382
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
383
+
384
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
385
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
386
+ }
387
+
388
+
389
+
390
+ localVarHeaderParameter['Content-Type'] = 'application/json';
391
+
392
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
393
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
394
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
395
+ localVarRequestOptions.data = serializeDataIfNeeded(patchReminderRequestDto, localVarRequestOptions, configuration)
396
+
397
+ return {
398
+ url: toPathString(localVarUrlObj),
399
+ options: localVarRequestOptions,
400
+ };
401
+ },
402
+ }
403
+ };
404
+
405
+ /**
406
+ * RemindersApi - functional programming interface
407
+ * @export
408
+ */
409
+ export const RemindersApiFp = function(configuration?: Configuration) {
410
+ const localVarAxiosParamCreator = RemindersApiAxiosParamCreator(configuration)
411
+ return {
412
+ /**
413
+ * This will create a reminder.
414
+ * @summary Create the reminder
415
+ * @param {CreateReminderRequestDto} createReminderRequestDto
416
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
417
+ * @param {*} [options] Override http request option.
418
+ * @throws {RequiredError}
419
+ */
420
+ async createReminder(createReminderRequestDto: CreateReminderRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateReminderResponseClass>> {
421
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createReminder(createReminderRequestDto, authorization, options);
422
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
423
+ },
424
+ /**
425
+ * This will delete a reminder.
426
+ * @summary Delete the reminder
427
+ * @param {string} code Unique identifier for the object.
428
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
429
+ * @param {*} [options] Override http request option.
430
+ * @throws {RequiredError}
431
+ */
432
+ async deleteReminder(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
433
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteReminder(code, authorization, options);
434
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
435
+ },
436
+ /**
437
+ * This will get a reminder by code.
438
+ * @summary Retrieve the reminder
439
+ * @param {string} code Unique identifier for the object.
440
+ * @param {string} expand
441
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
442
+ * @param {*} [options] Override http request option.
443
+ * @throws {RequiredError}
444
+ */
445
+ async getReminder(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetReminderResponseClass>> {
446
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getReminder(code, expand, authorization, options);
447
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
448
+ },
449
+ /**
450
+ * This will get reminder counts by status.
451
+ * @summary Retrieve the reminder counts
452
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
453
+ * @param {*} [options] Override http request option.
454
+ * @throws {RequiredError}
455
+ */
456
+ async getReminderCounts(authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetReminderCountsResponseClass>> {
457
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getReminderCounts(authorization, options);
458
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
459
+ },
460
+ /**
461
+ * Retrieves a list of reminders.
462
+ * @summary List reminders
463
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
464
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
465
+ * @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.
466
+ * @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, entityType, entityCode, isDone, userSub, dueAt, createdAt&lt;/i&gt;
467
+ * @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: title, description&lt;/i&gt;
468
+ * @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, dueAt, isDone&lt;/i&gt;
469
+ * @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;
470
+ * @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, entityType, entityCode, isDone, userSub, dueAt, createdAt&lt;/i&gt;
471
+ * @param {*} [options] Override http request option.
472
+ * @throws {RequiredError}
473
+ */
474
+ async listReminders(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRemindersResponseClass>> {
475
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listReminders(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
476
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
477
+ },
478
+ /**
479
+ * This will mark a reminder as done.
480
+ * @summary Create the reminder done
481
+ * @param {string} code
482
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
483
+ * @param {*} [options] Override http request option.
484
+ * @throws {RequiredError}
485
+ */
486
+ async markReminderDone(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MarkReminderDoneResponseClass>> {
487
+ const localVarAxiosArgs = await localVarAxiosParamCreator.markReminderDone(code, authorization, options);
488
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
489
+ },
490
+ /**
491
+ * This will patch a reminder.
492
+ * @summary Update the reminder
493
+ * @param {PatchReminderRequestDto} patchReminderRequestDto
494
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
495
+ * @param {*} [options] Override http request option.
496
+ * @throws {RequiredError}
497
+ */
498
+ async patchReminder(patchReminderRequestDto: PatchReminderRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PatchReminderResponseClass>> {
499
+ const localVarAxiosArgs = await localVarAxiosParamCreator.patchReminder(patchReminderRequestDto, authorization, options);
500
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
501
+ },
502
+ }
503
+ };
504
+
505
+ /**
506
+ * RemindersApi - factory interface
507
+ * @export
508
+ */
509
+ export const RemindersApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
510
+ const localVarFp = RemindersApiFp(configuration)
511
+ return {
512
+ /**
513
+ * This will create a reminder.
514
+ * @summary Create the reminder
515
+ * @param {CreateReminderRequestDto} createReminderRequestDto
516
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
517
+ * @param {*} [options] Override http request option.
518
+ * @throws {RequiredError}
519
+ */
520
+ createReminder(createReminderRequestDto: CreateReminderRequestDto, authorization?: string, options?: any): AxiosPromise<CreateReminderResponseClass> {
521
+ return localVarFp.createReminder(createReminderRequestDto, authorization, options).then((request) => request(axios, basePath));
522
+ },
523
+ /**
524
+ * This will delete a reminder.
525
+ * @summary Delete the reminder
526
+ * @param {string} code Unique identifier for the object.
527
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
528
+ * @param {*} [options] Override http request option.
529
+ * @throws {RequiredError}
530
+ */
531
+ deleteReminder(code: string, authorization?: string, options?: any): AxiosPromise<void> {
532
+ return localVarFp.deleteReminder(code, authorization, options).then((request) => request(axios, basePath));
533
+ },
534
+ /**
535
+ * This will get a reminder by code.
536
+ * @summary Retrieve the reminder
537
+ * @param {string} code Unique identifier for the object.
538
+ * @param {string} expand
539
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
540
+ * @param {*} [options] Override http request option.
541
+ * @throws {RequiredError}
542
+ */
543
+ getReminder(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetReminderResponseClass> {
544
+ return localVarFp.getReminder(code, expand, authorization, options).then((request) => request(axios, basePath));
545
+ },
546
+ /**
547
+ * This will get reminder counts by status.
548
+ * @summary Retrieve the reminder counts
549
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
550
+ * @param {*} [options] Override http request option.
551
+ * @throws {RequiredError}
552
+ */
553
+ getReminderCounts(authorization?: string, options?: any): AxiosPromise<GetReminderCountsResponseClass> {
554
+ return localVarFp.getReminderCounts(authorization, options).then((request) => request(axios, basePath));
555
+ },
556
+ /**
557
+ * Retrieves a list of reminders.
558
+ * @summary List reminders
559
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
560
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
561
+ * @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.
562
+ * @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, entityType, entityCode, isDone, userSub, dueAt, createdAt&lt;/i&gt;
563
+ * @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: title, description&lt;/i&gt;
564
+ * @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, dueAt, isDone&lt;/i&gt;
565
+ * @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;
566
+ * @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, entityType, entityCode, isDone, userSub, dueAt, createdAt&lt;/i&gt;
567
+ * @param {*} [options] Override http request option.
568
+ * @throws {RequiredError}
569
+ */
570
+ listReminders(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListRemindersResponseClass> {
571
+ return localVarFp.listReminders(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
572
+ },
573
+ /**
574
+ * This will mark a reminder as done.
575
+ * @summary Create the reminder done
576
+ * @param {string} code
577
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
578
+ * @param {*} [options] Override http request option.
579
+ * @throws {RequiredError}
580
+ */
581
+ markReminderDone(code: string, authorization?: string, options?: any): AxiosPromise<MarkReminderDoneResponseClass> {
582
+ return localVarFp.markReminderDone(code, authorization, options).then((request) => request(axios, basePath));
583
+ },
584
+ /**
585
+ * This will patch a reminder.
586
+ * @summary Update the reminder
587
+ * @param {PatchReminderRequestDto} patchReminderRequestDto
588
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
589
+ * @param {*} [options] Override http request option.
590
+ * @throws {RequiredError}
591
+ */
592
+ patchReminder(patchReminderRequestDto: PatchReminderRequestDto, authorization?: string, options?: any): AxiosPromise<PatchReminderResponseClass> {
593
+ return localVarFp.patchReminder(patchReminderRequestDto, authorization, options).then((request) => request(axios, basePath));
594
+ },
595
+ };
596
+ };
597
+
598
+ /**
599
+ * Request parameters for createReminder operation in RemindersApi.
600
+ * @export
601
+ * @interface RemindersApiCreateReminderRequest
602
+ */
603
+ export interface RemindersApiCreateReminderRequest {
604
+ /**
605
+ *
606
+ * @type {CreateReminderRequestDto}
607
+ * @memberof RemindersApiCreateReminder
608
+ */
609
+ readonly createReminderRequestDto: CreateReminderRequestDto
610
+
611
+ /**
612
+ * Bearer Token: provided by the login endpoint under the name accessToken.
613
+ * @type {string}
614
+ * @memberof RemindersApiCreateReminder
615
+ */
616
+ readonly authorization?: string
617
+ }
618
+
619
+ /**
620
+ * Request parameters for deleteReminder operation in RemindersApi.
621
+ * @export
622
+ * @interface RemindersApiDeleteReminderRequest
623
+ */
624
+ export interface RemindersApiDeleteReminderRequest {
625
+ /**
626
+ * Unique identifier for the object.
627
+ * @type {string}
628
+ * @memberof RemindersApiDeleteReminder
629
+ */
630
+ readonly code: string
631
+
632
+ /**
633
+ * Bearer Token: provided by the login endpoint under the name accessToken.
634
+ * @type {string}
635
+ * @memberof RemindersApiDeleteReminder
636
+ */
637
+ readonly authorization?: string
638
+ }
639
+
640
+ /**
641
+ * Request parameters for getReminder operation in RemindersApi.
642
+ * @export
643
+ * @interface RemindersApiGetReminderRequest
644
+ */
645
+ export interface RemindersApiGetReminderRequest {
646
+ /**
647
+ * Unique identifier for the object.
648
+ * @type {string}
649
+ * @memberof RemindersApiGetReminder
650
+ */
651
+ readonly code: string
652
+
653
+ /**
654
+ *
655
+ * @type {string}
656
+ * @memberof RemindersApiGetReminder
657
+ */
658
+ readonly expand: string
659
+
660
+ /**
661
+ * Bearer Token: provided by the login endpoint under the name accessToken.
662
+ * @type {string}
663
+ * @memberof RemindersApiGetReminder
664
+ */
665
+ readonly authorization?: string
666
+ }
667
+
668
+ /**
669
+ * Request parameters for getReminderCounts operation in RemindersApi.
670
+ * @export
671
+ * @interface RemindersApiGetReminderCountsRequest
672
+ */
673
+ export interface RemindersApiGetReminderCountsRequest {
674
+ /**
675
+ * Bearer Token: provided by the login endpoint under the name accessToken.
676
+ * @type {string}
677
+ * @memberof RemindersApiGetReminderCounts
678
+ */
679
+ readonly authorization?: string
680
+ }
681
+
682
+ /**
683
+ * Request parameters for listReminders operation in RemindersApi.
684
+ * @export
685
+ * @interface RemindersApiListRemindersRequest
686
+ */
687
+ export interface RemindersApiListRemindersRequest {
688
+ /**
689
+ * Bearer Token: provided by the login endpoint under the name accessToken.
690
+ * @type {string}
691
+ * @memberof RemindersApiListReminders
692
+ */
693
+ readonly authorization?: string
694
+
695
+ /**
696
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
697
+ * @type {number}
698
+ * @memberof RemindersApiListReminders
699
+ */
700
+ readonly pageSize?: number
701
+
702
+ /**
703
+ * 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.
704
+ * @type {string}
705
+ * @memberof RemindersApiListReminders
706
+ */
707
+ readonly pageToken?: string
708
+
709
+ /**
710
+ * 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, entityType, entityCode, isDone, userSub, dueAt, createdAt&lt;/i&gt;
711
+ * @type {string}
712
+ * @memberof RemindersApiListReminders
713
+ */
714
+ readonly filter?: string
715
+
716
+ /**
717
+ * 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: title, description&lt;/i&gt;
718
+ * @type {string}
719
+ * @memberof RemindersApiListReminders
720
+ */
721
+ readonly search?: string
722
+
723
+ /**
724
+ * 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, dueAt, isDone&lt;/i&gt;
725
+ * @type {string}
726
+ * @memberof RemindersApiListReminders
727
+ */
728
+ readonly order?: string
729
+
730
+ /**
731
+ * 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;
732
+ * @type {string}
733
+ * @memberof RemindersApiListReminders
734
+ */
735
+ readonly expand?: string
736
+
737
+ /**
738
+ * 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, entityType, entityCode, isDone, userSub, dueAt, createdAt&lt;/i&gt;
739
+ * @type {string}
740
+ * @memberof RemindersApiListReminders
741
+ */
742
+ readonly filters?: string
743
+ }
744
+
745
+ /**
746
+ * Request parameters for markReminderDone operation in RemindersApi.
747
+ * @export
748
+ * @interface RemindersApiMarkReminderDoneRequest
749
+ */
750
+ export interface RemindersApiMarkReminderDoneRequest {
751
+ /**
752
+ *
753
+ * @type {string}
754
+ * @memberof RemindersApiMarkReminderDone
755
+ */
756
+ readonly code: string
757
+
758
+ /**
759
+ * Bearer Token: provided by the login endpoint under the name accessToken.
760
+ * @type {string}
761
+ * @memberof RemindersApiMarkReminderDone
762
+ */
763
+ readonly authorization?: string
764
+ }
765
+
766
+ /**
767
+ * Request parameters for patchReminder operation in RemindersApi.
768
+ * @export
769
+ * @interface RemindersApiPatchReminderRequest
770
+ */
771
+ export interface RemindersApiPatchReminderRequest {
772
+ /**
773
+ *
774
+ * @type {PatchReminderRequestDto}
775
+ * @memberof RemindersApiPatchReminder
776
+ */
777
+ readonly patchReminderRequestDto: PatchReminderRequestDto
778
+
779
+ /**
780
+ * Bearer Token: provided by the login endpoint under the name accessToken.
781
+ * @type {string}
782
+ * @memberof RemindersApiPatchReminder
783
+ */
784
+ readonly authorization?: string
785
+ }
786
+
787
+ /**
788
+ * RemindersApi - object-oriented interface
789
+ * @export
790
+ * @class RemindersApi
791
+ * @extends {BaseAPI}
792
+ */
793
+ export class RemindersApi extends BaseAPI {
794
+ /**
795
+ * This will create a reminder.
796
+ * @summary Create the reminder
797
+ * @param {RemindersApiCreateReminderRequest} requestParameters Request parameters.
798
+ * @param {*} [options] Override http request option.
799
+ * @throws {RequiredError}
800
+ * @memberof RemindersApi
801
+ */
802
+ public createReminder(requestParameters: RemindersApiCreateReminderRequest, options?: AxiosRequestConfig) {
803
+ return RemindersApiFp(this.configuration).createReminder(requestParameters.createReminderRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
804
+ }
805
+
806
+ /**
807
+ * This will delete a reminder.
808
+ * @summary Delete the reminder
809
+ * @param {RemindersApiDeleteReminderRequest} requestParameters Request parameters.
810
+ * @param {*} [options] Override http request option.
811
+ * @throws {RequiredError}
812
+ * @memberof RemindersApi
813
+ */
814
+ public deleteReminder(requestParameters: RemindersApiDeleteReminderRequest, options?: AxiosRequestConfig) {
815
+ return RemindersApiFp(this.configuration).deleteReminder(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
816
+ }
817
+
818
+ /**
819
+ * This will get a reminder by code.
820
+ * @summary Retrieve the reminder
821
+ * @param {RemindersApiGetReminderRequest} requestParameters Request parameters.
822
+ * @param {*} [options] Override http request option.
823
+ * @throws {RequiredError}
824
+ * @memberof RemindersApi
825
+ */
826
+ public getReminder(requestParameters: RemindersApiGetReminderRequest, options?: AxiosRequestConfig) {
827
+ return RemindersApiFp(this.configuration).getReminder(requestParameters.code, requestParameters.expand, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
828
+ }
829
+
830
+ /**
831
+ * This will get reminder counts by status.
832
+ * @summary Retrieve the reminder counts
833
+ * @param {RemindersApiGetReminderCountsRequest} requestParameters Request parameters.
834
+ * @param {*} [options] Override http request option.
835
+ * @throws {RequiredError}
836
+ * @memberof RemindersApi
837
+ */
838
+ public getReminderCounts(requestParameters: RemindersApiGetReminderCountsRequest = {}, options?: AxiosRequestConfig) {
839
+ return RemindersApiFp(this.configuration).getReminderCounts(requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
840
+ }
841
+
842
+ /**
843
+ * Retrieves a list of reminders.
844
+ * @summary List reminders
845
+ * @param {RemindersApiListRemindersRequest} requestParameters Request parameters.
846
+ * @param {*} [options] Override http request option.
847
+ * @throws {RequiredError}
848
+ * @memberof RemindersApi
849
+ */
850
+ public listReminders(requestParameters: RemindersApiListRemindersRequest = {}, options?: AxiosRequestConfig) {
851
+ return RemindersApiFp(this.configuration).listReminders(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
852
+ }
853
+
854
+ /**
855
+ * This will mark a reminder as done.
856
+ * @summary Create the reminder done
857
+ * @param {RemindersApiMarkReminderDoneRequest} requestParameters Request parameters.
858
+ * @param {*} [options] Override http request option.
859
+ * @throws {RequiredError}
860
+ * @memberof RemindersApi
861
+ */
862
+ public markReminderDone(requestParameters: RemindersApiMarkReminderDoneRequest, options?: AxiosRequestConfig) {
863
+ return RemindersApiFp(this.configuration).markReminderDone(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
864
+ }
865
+
866
+ /**
867
+ * This will patch a reminder.
868
+ * @summary Update the reminder
869
+ * @param {RemindersApiPatchReminderRequest} requestParameters Request parameters.
870
+ * @param {*} [options] Override http request option.
871
+ * @throws {RequiredError}
872
+ * @memberof RemindersApi
873
+ */
874
+ public patchReminder(requestParameters: RemindersApiPatchReminderRequest, options?: AxiosRequestConfig) {
875
+ return RemindersApiFp(this.configuration).patchReminder(requestParameters.patchReminderRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
876
+ }
877
+ }