@emilgroup/task-sdk 1.3.0 → 1.3.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 +873 -0
  4. package/api.ts +2 -0
  5. package/dist/api/reminders-api.d.ts +487 -0
  6. package/dist/api/reminders-api.js +817 -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
package/api.ts CHANGED
@@ -24,6 +24,7 @@ import { AssigneesApi } from './api';
24
24
  import { CategoriesApi } from './api';
25
25
  import { DefaultApi } from './api';
26
26
  import { HubSpotApi } from './api';
27
+ import { RemindersApi } from './api';
27
28
  import { StatusesApi } from './api';
28
29
  import { TasksApi } from './api';
29
30
 
@@ -32,6 +33,7 @@ export * from './api/assignees-api';
32
33
  export * from './api/categories-api';
33
34
  export * from './api/default-api';
34
35
  export * from './api/hub-spot-api';
36
+ export * from './api/reminders-api';
35
37
  export * from './api/statuses-api';
36
38
  export * from './api/tasks-api';
37
39
 
@@ -0,0 +1,487 @@
1
+ /**
2
+ * EMIL TaskService
3
+ * The EMIL Task API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
+ import { Configuration } from '../configuration';
14
+ import { RequestArgs, BaseAPI } from '../base';
15
+ import { CreateReminderRequestDto } from '../models';
16
+ import { CreateReminderResponseClass } from '../models';
17
+ import { GetReminderCountsResponseClass } from '../models';
18
+ import { GetReminderResponseClass } from '../models';
19
+ import { ListRemindersResponseClass } from '../models';
20
+ import { MarkReminderDoneResponseClass } from '../models';
21
+ import { PatchReminderRequestDto } from '../models';
22
+ import { PatchReminderResponseClass } from '../models';
23
+ /**
24
+ * RemindersApi - axios parameter creator
25
+ * @export
26
+ */
27
+ export declare const RemindersApiAxiosParamCreator: (configuration?: Configuration) => {
28
+ /**
29
+ * This will create a reminder.
30
+ * @summary Create the reminder
31
+ * @param {CreateReminderRequestDto} createReminderRequestDto
32
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
33
+ * @param {*} [options] Override http request option.
34
+ * @throws {RequiredError}
35
+ */
36
+ createReminder: (createReminderRequestDto: CreateReminderRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
37
+ /**
38
+ * This will delete a reminder.
39
+ * @summary Delete the reminder
40
+ * @param {string} code Unique identifier for the object.
41
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
42
+ * @param {*} [options] Override http request option.
43
+ * @throws {RequiredError}
44
+ */
45
+ deleteReminder: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
46
+ /**
47
+ * This will get a reminder by code.
48
+ * @summary Retrieve the reminder
49
+ * @param {string} code Unique identifier for the object.
50
+ * @param {string} expand
51
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
52
+ * @param {*} [options] Override http request option.
53
+ * @throws {RequiredError}
54
+ */
55
+ getReminder: (code: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
56
+ /**
57
+ * This will get reminder counts by status.
58
+ * @summary Retrieve the reminder counts
59
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
60
+ * @param {*} [options] Override http request option.
61
+ * @throws {RequiredError}
62
+ */
63
+ getReminderCounts: (authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
64
+ /**
65
+ * Retrieves a list of reminders.
66
+ * @summary List reminders
67
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
68
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
69
+ * @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.
70
+ * @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;
71
+ * @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;
72
+ * @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;
73
+ * @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;
74
+ * @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;
75
+ * @param {*} [options] Override http request option.
76
+ * @throws {RequiredError}
77
+ */
78
+ listReminders: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
79
+ /**
80
+ * This will mark a reminder as done.
81
+ * @summary Create the reminder done
82
+ * @param {string} code
83
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
84
+ * @param {*} [options] Override http request option.
85
+ * @throws {RequiredError}
86
+ */
87
+ markReminderDone: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
88
+ /**
89
+ * This will patch a reminder.
90
+ * @summary Update the reminder
91
+ * @param {PatchReminderRequestDto} patchReminderRequestDto
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
+ patchReminder: (patchReminderRequestDto: PatchReminderRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
97
+ };
98
+ /**
99
+ * RemindersApi - functional programming interface
100
+ * @export
101
+ */
102
+ export declare const RemindersApiFp: (configuration?: Configuration) => {
103
+ /**
104
+ * This will create a reminder.
105
+ * @summary Create the reminder
106
+ * @param {CreateReminderRequestDto} createReminderRequestDto
107
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
108
+ * @param {*} [options] Override http request option.
109
+ * @throws {RequiredError}
110
+ */
111
+ createReminder(createReminderRequestDto: CreateReminderRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateReminderResponseClass>>;
112
+ /**
113
+ * This will delete a reminder.
114
+ * @summary Delete the reminder
115
+ * @param {string} code Unique identifier for the object.
116
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
117
+ * @param {*} [options] Override http request option.
118
+ * @throws {RequiredError}
119
+ */
120
+ deleteReminder(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
121
+ /**
122
+ * This will get a reminder by code.
123
+ * @summary Retrieve the reminder
124
+ * @param {string} code Unique identifier for the object.
125
+ * @param {string} expand
126
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
127
+ * @param {*} [options] Override http request option.
128
+ * @throws {RequiredError}
129
+ */
130
+ getReminder(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetReminderResponseClass>>;
131
+ /**
132
+ * This will get reminder counts by status.
133
+ * @summary Retrieve the reminder counts
134
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
135
+ * @param {*} [options] Override http request option.
136
+ * @throws {RequiredError}
137
+ */
138
+ getReminderCounts(authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetReminderCountsResponseClass>>;
139
+ /**
140
+ * Retrieves a list of reminders.
141
+ * @summary List reminders
142
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
143
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
144
+ * @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.
145
+ * @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;
146
+ * @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;
147
+ * @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;
148
+ * @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;
149
+ * @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;
150
+ * @param {*} [options] Override http request option.
151
+ * @throws {RequiredError}
152
+ */
153
+ 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>>;
154
+ /**
155
+ * This will mark a reminder as done.
156
+ * @summary Create the reminder done
157
+ * @param {string} code
158
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
159
+ * @param {*} [options] Override http request option.
160
+ * @throws {RequiredError}
161
+ */
162
+ markReminderDone(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MarkReminderDoneResponseClass>>;
163
+ /**
164
+ * This will patch a reminder.
165
+ * @summary Update the reminder
166
+ * @param {PatchReminderRequestDto} patchReminderRequestDto
167
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
168
+ * @param {*} [options] Override http request option.
169
+ * @throws {RequiredError}
170
+ */
171
+ patchReminder(patchReminderRequestDto: PatchReminderRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PatchReminderResponseClass>>;
172
+ };
173
+ /**
174
+ * RemindersApi - factory interface
175
+ * @export
176
+ */
177
+ export declare const RemindersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
178
+ /**
179
+ * This will create a reminder.
180
+ * @summary Create the reminder
181
+ * @param {CreateReminderRequestDto} createReminderRequestDto
182
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
183
+ * @param {*} [options] Override http request option.
184
+ * @throws {RequiredError}
185
+ */
186
+ createReminder(createReminderRequestDto: CreateReminderRequestDto, authorization?: string, options?: any): AxiosPromise<CreateReminderResponseClass>;
187
+ /**
188
+ * This will delete a reminder.
189
+ * @summary Delete the reminder
190
+ * @param {string} code Unique identifier for the object.
191
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
192
+ * @param {*} [options] Override http request option.
193
+ * @throws {RequiredError}
194
+ */
195
+ deleteReminder(code: string, authorization?: string, options?: any): AxiosPromise<void>;
196
+ /**
197
+ * This will get a reminder by code.
198
+ * @summary Retrieve the reminder
199
+ * @param {string} code Unique identifier for the object.
200
+ * @param {string} expand
201
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
202
+ * @param {*} [options] Override http request option.
203
+ * @throws {RequiredError}
204
+ */
205
+ getReminder(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetReminderResponseClass>;
206
+ /**
207
+ * This will get reminder counts by status.
208
+ * @summary Retrieve the reminder counts
209
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
210
+ * @param {*} [options] Override http request option.
211
+ * @throws {RequiredError}
212
+ */
213
+ getReminderCounts(authorization?: string, options?: any): AxiosPromise<GetReminderCountsResponseClass>;
214
+ /**
215
+ * Retrieves a list of reminders.
216
+ * @summary List reminders
217
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
218
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
219
+ * @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.
220
+ * @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;
221
+ * @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;
222
+ * @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;
223
+ * @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;
224
+ * @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;
225
+ * @param {*} [options] Override http request option.
226
+ * @throws {RequiredError}
227
+ */
228
+ listReminders(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListRemindersResponseClass>;
229
+ /**
230
+ * This will mark a reminder as done.
231
+ * @summary Create the reminder done
232
+ * @param {string} code
233
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
234
+ * @param {*} [options] Override http request option.
235
+ * @throws {RequiredError}
236
+ */
237
+ markReminderDone(code: string, authorization?: string, options?: any): AxiosPromise<MarkReminderDoneResponseClass>;
238
+ /**
239
+ * This will patch a reminder.
240
+ * @summary Update the reminder
241
+ * @param {PatchReminderRequestDto} patchReminderRequestDto
242
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
243
+ * @param {*} [options] Override http request option.
244
+ * @throws {RequiredError}
245
+ */
246
+ patchReminder(patchReminderRequestDto: PatchReminderRequestDto, authorization?: string, options?: any): AxiosPromise<PatchReminderResponseClass>;
247
+ };
248
+ /**
249
+ * Request parameters for createReminder operation in RemindersApi.
250
+ * @export
251
+ * @interface RemindersApiCreateReminderRequest
252
+ */
253
+ export interface RemindersApiCreateReminderRequest {
254
+ /**
255
+ *
256
+ * @type {CreateReminderRequestDto}
257
+ * @memberof RemindersApiCreateReminder
258
+ */
259
+ readonly createReminderRequestDto: CreateReminderRequestDto;
260
+ /**
261
+ * Bearer Token: provided by the login endpoint under the name accessToken.
262
+ * @type {string}
263
+ * @memberof RemindersApiCreateReminder
264
+ */
265
+ readonly authorization?: string;
266
+ }
267
+ /**
268
+ * Request parameters for deleteReminder operation in RemindersApi.
269
+ * @export
270
+ * @interface RemindersApiDeleteReminderRequest
271
+ */
272
+ export interface RemindersApiDeleteReminderRequest {
273
+ /**
274
+ * Unique identifier for the object.
275
+ * @type {string}
276
+ * @memberof RemindersApiDeleteReminder
277
+ */
278
+ readonly code: string;
279
+ /**
280
+ * Bearer Token: provided by the login endpoint under the name accessToken.
281
+ * @type {string}
282
+ * @memberof RemindersApiDeleteReminder
283
+ */
284
+ readonly authorization?: string;
285
+ }
286
+ /**
287
+ * Request parameters for getReminder operation in RemindersApi.
288
+ * @export
289
+ * @interface RemindersApiGetReminderRequest
290
+ */
291
+ export interface RemindersApiGetReminderRequest {
292
+ /**
293
+ * Unique identifier for the object.
294
+ * @type {string}
295
+ * @memberof RemindersApiGetReminder
296
+ */
297
+ readonly code: string;
298
+ /**
299
+ *
300
+ * @type {string}
301
+ * @memberof RemindersApiGetReminder
302
+ */
303
+ readonly expand: string;
304
+ /**
305
+ * Bearer Token: provided by the login endpoint under the name accessToken.
306
+ * @type {string}
307
+ * @memberof RemindersApiGetReminder
308
+ */
309
+ readonly authorization?: string;
310
+ }
311
+ /**
312
+ * Request parameters for getReminderCounts operation in RemindersApi.
313
+ * @export
314
+ * @interface RemindersApiGetReminderCountsRequest
315
+ */
316
+ export interface RemindersApiGetReminderCountsRequest {
317
+ /**
318
+ * Bearer Token: provided by the login endpoint under the name accessToken.
319
+ * @type {string}
320
+ * @memberof RemindersApiGetReminderCounts
321
+ */
322
+ readonly authorization?: string;
323
+ }
324
+ /**
325
+ * Request parameters for listReminders operation in RemindersApi.
326
+ * @export
327
+ * @interface RemindersApiListRemindersRequest
328
+ */
329
+ export interface RemindersApiListRemindersRequest {
330
+ /**
331
+ * Bearer Token: provided by the login endpoint under the name accessToken.
332
+ * @type {string}
333
+ * @memberof RemindersApiListReminders
334
+ */
335
+ readonly authorization?: string;
336
+ /**
337
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
338
+ * @type {number}
339
+ * @memberof RemindersApiListReminders
340
+ */
341
+ readonly pageSize?: number;
342
+ /**
343
+ * 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.
344
+ * @type {string}
345
+ * @memberof RemindersApiListReminders
346
+ */
347
+ readonly pageToken?: string;
348
+ /**
349
+ * 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;
350
+ * @type {string}
351
+ * @memberof RemindersApiListReminders
352
+ */
353
+ readonly filter?: string;
354
+ /**
355
+ * 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;
356
+ * @type {string}
357
+ * @memberof RemindersApiListReminders
358
+ */
359
+ readonly search?: string;
360
+ /**
361
+ * 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;
362
+ * @type {string}
363
+ * @memberof RemindersApiListReminders
364
+ */
365
+ readonly order?: string;
366
+ /**
367
+ * 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;
368
+ * @type {string}
369
+ * @memberof RemindersApiListReminders
370
+ */
371
+ readonly expand?: string;
372
+ /**
373
+ * 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;
374
+ * @type {string}
375
+ * @memberof RemindersApiListReminders
376
+ */
377
+ readonly filters?: string;
378
+ }
379
+ /**
380
+ * Request parameters for markReminderDone operation in RemindersApi.
381
+ * @export
382
+ * @interface RemindersApiMarkReminderDoneRequest
383
+ */
384
+ export interface RemindersApiMarkReminderDoneRequest {
385
+ /**
386
+ *
387
+ * @type {string}
388
+ * @memberof RemindersApiMarkReminderDone
389
+ */
390
+ readonly code: string;
391
+ /**
392
+ * Bearer Token: provided by the login endpoint under the name accessToken.
393
+ * @type {string}
394
+ * @memberof RemindersApiMarkReminderDone
395
+ */
396
+ readonly authorization?: string;
397
+ }
398
+ /**
399
+ * Request parameters for patchReminder operation in RemindersApi.
400
+ * @export
401
+ * @interface RemindersApiPatchReminderRequest
402
+ */
403
+ export interface RemindersApiPatchReminderRequest {
404
+ /**
405
+ *
406
+ * @type {PatchReminderRequestDto}
407
+ * @memberof RemindersApiPatchReminder
408
+ */
409
+ readonly patchReminderRequestDto: PatchReminderRequestDto;
410
+ /**
411
+ * Bearer Token: provided by the login endpoint under the name accessToken.
412
+ * @type {string}
413
+ * @memberof RemindersApiPatchReminder
414
+ */
415
+ readonly authorization?: string;
416
+ }
417
+ /**
418
+ * RemindersApi - object-oriented interface
419
+ * @export
420
+ * @class RemindersApi
421
+ * @extends {BaseAPI}
422
+ */
423
+ export declare class RemindersApi extends BaseAPI {
424
+ /**
425
+ * This will create a reminder.
426
+ * @summary Create the reminder
427
+ * @param {RemindersApiCreateReminderRequest} requestParameters Request parameters.
428
+ * @param {*} [options] Override http request option.
429
+ * @throws {RequiredError}
430
+ * @memberof RemindersApi
431
+ */
432
+ createReminder(requestParameters: RemindersApiCreateReminderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateReminderResponseClass, any, {}>>;
433
+ /**
434
+ * This will delete a reminder.
435
+ * @summary Delete the reminder
436
+ * @param {RemindersApiDeleteReminderRequest} requestParameters Request parameters.
437
+ * @param {*} [options] Override http request option.
438
+ * @throws {RequiredError}
439
+ * @memberof RemindersApi
440
+ */
441
+ deleteReminder(requestParameters: RemindersApiDeleteReminderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
442
+ /**
443
+ * This will get a reminder by code.
444
+ * @summary Retrieve the reminder
445
+ * @param {RemindersApiGetReminderRequest} requestParameters Request parameters.
446
+ * @param {*} [options] Override http request option.
447
+ * @throws {RequiredError}
448
+ * @memberof RemindersApi
449
+ */
450
+ getReminder(requestParameters: RemindersApiGetReminderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetReminderResponseClass, any, {}>>;
451
+ /**
452
+ * This will get reminder counts by status.
453
+ * @summary Retrieve the reminder counts
454
+ * @param {RemindersApiGetReminderCountsRequest} requestParameters Request parameters.
455
+ * @param {*} [options] Override http request option.
456
+ * @throws {RequiredError}
457
+ * @memberof RemindersApi
458
+ */
459
+ getReminderCounts(requestParameters?: RemindersApiGetReminderCountsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetReminderCountsResponseClass, any, {}>>;
460
+ /**
461
+ * Retrieves a list of reminders.
462
+ * @summary List reminders
463
+ * @param {RemindersApiListRemindersRequest} requestParameters Request parameters.
464
+ * @param {*} [options] Override http request option.
465
+ * @throws {RequiredError}
466
+ * @memberof RemindersApi
467
+ */
468
+ listReminders(requestParameters?: RemindersApiListRemindersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListRemindersResponseClass, any, {}>>;
469
+ /**
470
+ * This will mark a reminder as done.
471
+ * @summary Create the reminder done
472
+ * @param {RemindersApiMarkReminderDoneRequest} requestParameters Request parameters.
473
+ * @param {*} [options] Override http request option.
474
+ * @throws {RequiredError}
475
+ * @memberof RemindersApi
476
+ */
477
+ markReminderDone(requestParameters: RemindersApiMarkReminderDoneRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<MarkReminderDoneResponseClass, any, {}>>;
478
+ /**
479
+ * This will patch a reminder.
480
+ * @summary Update the reminder
481
+ * @param {RemindersApiPatchReminderRequest} requestParameters Request parameters.
482
+ * @param {*} [options] Override http request option.
483
+ * @throws {RequiredError}
484
+ * @memberof RemindersApi
485
+ */
486
+ patchReminder(requestParameters: RemindersApiPatchReminderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PatchReminderResponseClass, any, {}>>;
487
+ }