@emilgroup/task-sdk 1.3.1-beta.0 → 1.3.1-beta.10

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