@emilgroup/task-sdk 1.3.1-beta.1 → 1.3.1-beta.5

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.
@@ -5,10 +5,11 @@ README.md
5
5
  api.ts
6
6
  api/assignees-api.ts
7
7
  api/categories-api.ts
8
- api/default-api.ts
8
+ api/health-api.ts
9
9
  api/hub-spot-api.ts
10
10
  api/reminders-api.ts
11
11
  api/statuses-api.ts
12
+ api/task-client-api.ts
12
13
  api/tasks-api.ts
13
14
  base.ts
14
15
  common.ts
package/README.md CHANGED
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
17
17
  Navigate to the folder of your consuming project and run one of the following commands:
18
18
 
19
19
  ```
20
- npm install @emilgroup/task-sdk@1.3.1-beta.1 --save
20
+ npm install @emilgroup/task-sdk@1.3.1-beta.5 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/task-sdk@1.3.1-beta.1
24
+ yarn add @emilgroup/task-sdk@1.3.1-beta.5
25
25
  ```
26
26
 
27
27
  And then you can import `TasksApi`.
@@ -25,10 +25,10 @@ import { InlineResponse200 } from '../models';
25
25
  // @ts-ignore
26
26
  import { InlineResponse503 } from '../models';
27
27
  /**
28
- * DefaultApi - axios parameter creator
28
+ * HealthApi - axios parameter creator
29
29
  * @export
30
30
  */
31
- export const DefaultApiAxiosParamCreator = function (configuration?: Configuration) {
31
+ export const HealthApiAxiosParamCreator = function (configuration?: Configuration) {
32
32
  return {
33
33
  /**
34
34
  * Returns the health status of the TaskService service. This endpoint is used to monitor the operational status of the TaskService service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
@@ -66,11 +66,11 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati
66
66
  };
67
67
 
68
68
  /**
69
- * DefaultApi - functional programming interface
69
+ * HealthApi - functional programming interface
70
70
  * @export
71
71
  */
72
- export const DefaultApiFp = function(configuration?: Configuration) {
73
- const localVarAxiosParamCreator = DefaultApiAxiosParamCreator(configuration)
72
+ export const HealthApiFp = function(configuration?: Configuration) {
73
+ const localVarAxiosParamCreator = HealthApiAxiosParamCreator(configuration)
74
74
  return {
75
75
  /**
76
76
  * Returns the health status of the TaskService service. This endpoint is used to monitor the operational status of the TaskService service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
@@ -86,11 +86,11 @@ export const DefaultApiFp = function(configuration?: Configuration) {
86
86
  };
87
87
 
88
88
  /**
89
- * DefaultApi - factory interface
89
+ * HealthApi - factory interface
90
90
  * @export
91
91
  */
92
- export const DefaultApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
93
- const localVarFp = DefaultApiFp(configuration)
92
+ export const HealthApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
93
+ const localVarFp = HealthApiFp(configuration)
94
94
  return {
95
95
  /**
96
96
  * Returns the health status of the TaskService service. This endpoint is used to monitor the operational status of the TaskService service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
@@ -105,20 +105,20 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa
105
105
  };
106
106
 
107
107
  /**
108
- * DefaultApi - object-oriented interface
108
+ * HealthApi - object-oriented interface
109
109
  * @export
110
- * @class DefaultApi
110
+ * @class HealthApi
111
111
  * @extends {BaseAPI}
112
112
  */
113
- export class DefaultApi extends BaseAPI {
113
+ export class HealthApi extends BaseAPI {
114
114
  /**
115
115
  * Returns the health status of the TaskService service. This endpoint is used to monitor the operational status of the TaskService service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
116
116
  * @summary Health Check
117
117
  * @param {*} [options] Override http request option.
118
118
  * @throws {RequiredError}
119
- * @memberof DefaultApi
119
+ * @memberof HealthApi
120
120
  */
121
121
  public check(options?: AxiosRequestConfig) {
122
- return DefaultApiFp(this.configuration).check(options).then((request) => request(this.axios, this.basePath));
122
+ return HealthApiFp(this.configuration).check(options).then((request) => request(this.axios, this.basePath));
123
123
  }
124
124
  }
@@ -43,7 +43,7 @@ import { PatchReminderResponseClass } from '../models';
43
43
  export const RemindersApiAxiosParamCreator = function (configuration?: Configuration) {
44
44
  return {
45
45
  /**
46
- * This will create a reminder.
46
+ * This will create a reminder. **Required Permissions** \"task-management.tasks.create\"
47
47
  * @summary Create the reminder
48
48
  * @param {CreateReminderRequestDto} createReminderRequestDto
49
49
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -90,7 +90,7 @@ export const RemindersApiAxiosParamCreator = function (configuration?: Configura
90
90
  };
91
91
  },
92
92
  /**
93
- * This will delete a reminder.
93
+ * This will delete a reminder. **Required Permissions** \"task-management.tasks.delete\"
94
94
  * @summary Delete the reminder
95
95
  * @param {string} code Unique identifier for the object.
96
96
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -135,7 +135,7 @@ export const RemindersApiAxiosParamCreator = function (configuration?: Configura
135
135
  };
136
136
  },
137
137
  /**
138
- * This will get a reminder by code.
138
+ * This will get a reminder by code. **Required Permissions** \"task-management.tasks.view\"
139
139
  * @summary Retrieve the reminder
140
140
  * @param {string} code Unique identifier for the object.
141
141
  * @param {string} expand
@@ -187,13 +187,14 @@ export const RemindersApiAxiosParamCreator = function (configuration?: Configura
187
187
  };
188
188
  },
189
189
  /**
190
- * This will get reminder counts by status.
190
+ * This will get reminder counts by status. Accepts the same advanced `filters` query parameter as the list reminders endpoint. **Required Permissions** \"task-management.tasks.view\"
191
191
  * @summary Retrieve the reminder counts
192
192
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
193
+ * @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.
193
194
  * @param {*} [options] Override http request option.
194
195
  * @throws {RequiredError}
195
196
  */
196
- getReminderCounts: async (authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
197
+ getReminderCounts: async (authorization?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
197
198
  const localVarPath = `/taskservice/v1/reminders/counts`;
198
199
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
199
200
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -212,6 +213,10 @@ export const RemindersApiAxiosParamCreator = function (configuration?: Configura
212
213
  // http bearer authentication required
213
214
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
214
215
 
216
+ if (filters !== undefined) {
217
+ localVarQueryParameter['filters'] = filters;
218
+ }
219
+
215
220
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
216
221
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
217
222
  }
@@ -228,16 +233,16 @@ export const RemindersApiAxiosParamCreator = function (configuration?: Configura
228
233
  };
229
234
  },
230
235
  /**
231
- * Retrieves a list of reminders.
236
+ * Retrieves a list of reminders. **Required Permissions** \"task-management.tasks.view\"
232
237
  * @summary List reminders
233
238
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
234
239
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
235
240
  * @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.
236
- * @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;
237
- * @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;
238
- * @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;
241
+ * @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;
242
+ * @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;
243
+ * @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;
239
244
  * @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;
240
- * @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 {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;
241
246
  * @param {*} [options] Override http request option.
242
247
  * @throws {RequiredError}
243
248
  */
@@ -304,7 +309,7 @@ export const RemindersApiAxiosParamCreator = function (configuration?: Configura
304
309
  };
305
310
  },
306
311
  /**
307
- * This will mark a reminder as done.
312
+ * This will mark a reminder as done. **Required Permissions** \"task-management.tasks.update\"
308
313
  * @summary Create the reminder done
309
314
  * @param {string} code
310
315
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -349,7 +354,7 @@ export const RemindersApiAxiosParamCreator = function (configuration?: Configura
349
354
  };
350
355
  },
351
356
  /**
352
- * This will patch a reminder.
357
+ * This will patch a reminder. **Required Permissions** \"task-management.tasks.update\"
353
358
  * @summary Update the reminder
354
359
  * @param {PatchReminderRequestDto} patchReminderRequestDto
355
360
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -406,7 +411,7 @@ export const RemindersApiFp = function(configuration?: Configuration) {
406
411
  const localVarAxiosParamCreator = RemindersApiAxiosParamCreator(configuration)
407
412
  return {
408
413
  /**
409
- * This will create a reminder.
414
+ * This will create a reminder. **Required Permissions** \"task-management.tasks.create\"
410
415
  * @summary Create the reminder
411
416
  * @param {CreateReminderRequestDto} createReminderRequestDto
412
417
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -418,7 +423,7 @@ export const RemindersApiFp = function(configuration?: Configuration) {
418
423
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
419
424
  },
420
425
  /**
421
- * This will delete a reminder.
426
+ * This will delete a reminder. **Required Permissions** \"task-management.tasks.delete\"
422
427
  * @summary Delete the reminder
423
428
  * @param {string} code Unique identifier for the object.
424
429
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -430,7 +435,7 @@ export const RemindersApiFp = function(configuration?: Configuration) {
430
435
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
431
436
  },
432
437
  /**
433
- * This will get a reminder by code.
438
+ * This will get a reminder by code. **Required Permissions** \"task-management.tasks.view\"
434
439
  * @summary Retrieve the reminder
435
440
  * @param {string} code Unique identifier for the object.
436
441
  * @param {string} expand
@@ -443,27 +448,28 @@ export const RemindersApiFp = function(configuration?: Configuration) {
443
448
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
444
449
  },
445
450
  /**
446
- * This will get reminder counts by status.
451
+ * This will get reminder counts by status. Accepts the same advanced `filters` query parameter as the list reminders endpoint. **Required Permissions** \"task-management.tasks.view\"
447
452
  * @summary Retrieve the reminder counts
448
453
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
454
+ * @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.
449
455
  * @param {*} [options] Override http request option.
450
456
  * @throws {RequiredError}
451
457
  */
452
- async getReminderCounts(authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetReminderCountsResponseClass>> {
453
- const localVarAxiosArgs = await localVarAxiosParamCreator.getReminderCounts(authorization, options);
458
+ async getReminderCounts(authorization?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetReminderCountsResponseClass>> {
459
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getReminderCounts(authorization, filters, options);
454
460
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
455
461
  },
456
462
  /**
457
- * Retrieves a list of reminders.
463
+ * Retrieves a list of reminders. **Required Permissions** \"task-management.tasks.view\"
458
464
  * @summary List reminders
459
465
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
460
466
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
461
467
  * @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.
462
- * @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;
463
- * @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;
464
- * @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;
468
+ * @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;
469
+ * @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;
470
+ * @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;
465
471
  * @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;
466
- * @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;
472
+ * @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;
467
473
  * @param {*} [options] Override http request option.
468
474
  * @throws {RequiredError}
469
475
  */
@@ -472,7 +478,7 @@ export const RemindersApiFp = function(configuration?: Configuration) {
472
478
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
473
479
  },
474
480
  /**
475
- * This will mark a reminder as done.
481
+ * This will mark a reminder as done. **Required Permissions** \"task-management.tasks.update\"
476
482
  * @summary Create the reminder done
477
483
  * @param {string} code
478
484
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -484,7 +490,7 @@ export const RemindersApiFp = function(configuration?: Configuration) {
484
490
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
485
491
  },
486
492
  /**
487
- * This will patch a reminder.
493
+ * This will patch a reminder. **Required Permissions** \"task-management.tasks.update\"
488
494
  * @summary Update the reminder
489
495
  * @param {PatchReminderRequestDto} patchReminderRequestDto
490
496
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -506,7 +512,7 @@ export const RemindersApiFactory = function (configuration?: Configuration, base
506
512
  const localVarFp = RemindersApiFp(configuration)
507
513
  return {
508
514
  /**
509
- * This will create a reminder.
515
+ * This will create a reminder. **Required Permissions** \"task-management.tasks.create\"
510
516
  * @summary Create the reminder
511
517
  * @param {CreateReminderRequestDto} createReminderRequestDto
512
518
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -517,7 +523,7 @@ export const RemindersApiFactory = function (configuration?: Configuration, base
517
523
  return localVarFp.createReminder(createReminderRequestDto, authorization, options).then((request) => request(axios, basePath));
518
524
  },
519
525
  /**
520
- * This will delete a reminder.
526
+ * This will delete a reminder. **Required Permissions** \"task-management.tasks.delete\"
521
527
  * @summary Delete the reminder
522
528
  * @param {string} code Unique identifier for the object.
523
529
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -528,7 +534,7 @@ export const RemindersApiFactory = function (configuration?: Configuration, base
528
534
  return localVarFp.deleteReminder(code, authorization, options).then((request) => request(axios, basePath));
529
535
  },
530
536
  /**
531
- * This will get a reminder by code.
537
+ * This will get a reminder by code. **Required Permissions** \"task-management.tasks.view\"
532
538
  * @summary Retrieve the reminder
533
539
  * @param {string} code Unique identifier for the object.
534
540
  * @param {string} expand
@@ -540,26 +546,27 @@ export const RemindersApiFactory = function (configuration?: Configuration, base
540
546
  return localVarFp.getReminder(code, expand, authorization, options).then((request) => request(axios, basePath));
541
547
  },
542
548
  /**
543
- * This will get reminder counts by status.
549
+ * This will get reminder counts by status. Accepts the same advanced `filters` query parameter as the list reminders endpoint. **Required Permissions** \"task-management.tasks.view\"
544
550
  * @summary Retrieve the reminder counts
545
551
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
552
+ * @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.
546
553
  * @param {*} [options] Override http request option.
547
554
  * @throws {RequiredError}
548
555
  */
549
- getReminderCounts(authorization?: string, options?: any): AxiosPromise<GetReminderCountsResponseClass> {
550
- return localVarFp.getReminderCounts(authorization, options).then((request) => request(axios, basePath));
556
+ getReminderCounts(authorization?: string, filters?: string, options?: any): AxiosPromise<GetReminderCountsResponseClass> {
557
+ return localVarFp.getReminderCounts(authorization, filters, options).then((request) => request(axios, basePath));
551
558
  },
552
559
  /**
553
- * Retrieves a list of reminders.
560
+ * Retrieves a list of reminders. **Required Permissions** \"task-management.tasks.view\"
554
561
  * @summary List reminders
555
562
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
556
563
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
557
564
  * @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.
558
- * @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;
559
- * @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;
560
- * @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} [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;
566
+ * @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;
567
+ * @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;
561
568
  * @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;
562
- * @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;
569
+ * @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;
563
570
  * @param {*} [options] Override http request option.
564
571
  * @throws {RequiredError}
565
572
  */
@@ -567,7 +574,7 @@ export const RemindersApiFactory = function (configuration?: Configuration, base
567
574
  return localVarFp.listReminders(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
568
575
  },
569
576
  /**
570
- * This will mark a reminder as done.
577
+ * This will mark a reminder as done. **Required Permissions** \"task-management.tasks.update\"
571
578
  * @summary Create the reminder done
572
579
  * @param {string} code
573
580
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -578,7 +585,7 @@ export const RemindersApiFactory = function (configuration?: Configuration, base
578
585
  return localVarFp.markReminderDone(code, authorization, options).then((request) => request(axios, basePath));
579
586
  },
580
587
  /**
581
- * This will patch a reminder.
588
+ * This will patch a reminder. **Required Permissions** \"task-management.tasks.update\"
582
589
  * @summary Update the reminder
583
590
  * @param {PatchReminderRequestDto} patchReminderRequestDto
584
591
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -673,6 +680,13 @@ export interface RemindersApiGetReminderCountsRequest {
673
680
  * @memberof RemindersApiGetReminderCounts
674
681
  */
675
682
  readonly authorization?: string
683
+
684
+ /**
685
+ * 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.
686
+ * @type {string}
687
+ * @memberof RemindersApiGetReminderCounts
688
+ */
689
+ readonly filters?: string
676
690
  }
677
691
 
678
692
  /**
@@ -703,21 +717,21 @@ export interface RemindersApiListRemindersRequest {
703
717
  readonly pageToken?: string
704
718
 
705
719
  /**
706
- * 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;
720
+ * 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;
707
721
  * @type {string}
708
722
  * @memberof RemindersApiListReminders
709
723
  */
710
724
  readonly filter?: string
711
725
 
712
726
  /**
713
- * 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;
727
+ * 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;
714
728
  * @type {string}
715
729
  * @memberof RemindersApiListReminders
716
730
  */
717
731
  readonly search?: string
718
732
 
719
733
  /**
720
- * 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;
734
+ * 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;
721
735
  * @type {string}
722
736
  * @memberof RemindersApiListReminders
723
737
  */
@@ -731,7 +745,7 @@ export interface RemindersApiListRemindersRequest {
731
745
  readonly expand?: string
732
746
 
733
747
  /**
734
- * 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;
748
+ * 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;
735
749
  * @type {string}
736
750
  * @memberof RemindersApiListReminders
737
751
  */
@@ -788,7 +802,7 @@ export interface RemindersApiPatchReminderRequest {
788
802
  */
789
803
  export class RemindersApi extends BaseAPI {
790
804
  /**
791
- * This will create a reminder.
805
+ * This will create a reminder. **Required Permissions** \"task-management.tasks.create\"
792
806
  * @summary Create the reminder
793
807
  * @param {RemindersApiCreateReminderRequest} requestParameters Request parameters.
794
808
  * @param {*} [options] Override http request option.
@@ -800,7 +814,7 @@ export class RemindersApi extends BaseAPI {
800
814
  }
801
815
 
802
816
  /**
803
- * This will delete a reminder.
817
+ * This will delete a reminder. **Required Permissions** \"task-management.tasks.delete\"
804
818
  * @summary Delete the reminder
805
819
  * @param {RemindersApiDeleteReminderRequest} requestParameters Request parameters.
806
820
  * @param {*} [options] Override http request option.
@@ -812,7 +826,7 @@ export class RemindersApi extends BaseAPI {
812
826
  }
813
827
 
814
828
  /**
815
- * This will get a reminder by code.
829
+ * This will get a reminder by code. **Required Permissions** \"task-management.tasks.view\"
816
830
  * @summary Retrieve the reminder
817
831
  * @param {RemindersApiGetReminderRequest} requestParameters Request parameters.
818
832
  * @param {*} [options] Override http request option.
@@ -824,7 +838,7 @@ export class RemindersApi extends BaseAPI {
824
838
  }
825
839
 
826
840
  /**
827
- * This will get reminder counts by status.
841
+ * This will get reminder counts by status. Accepts the same advanced `filters` query parameter as the list reminders endpoint. **Required Permissions** \"task-management.tasks.view\"
828
842
  * @summary Retrieve the reminder counts
829
843
  * @param {RemindersApiGetReminderCountsRequest} requestParameters Request parameters.
830
844
  * @param {*} [options] Override http request option.
@@ -832,11 +846,11 @@ export class RemindersApi extends BaseAPI {
832
846
  * @memberof RemindersApi
833
847
  */
834
848
  public getReminderCounts(requestParameters: RemindersApiGetReminderCountsRequest = {}, options?: AxiosRequestConfig) {
835
- return RemindersApiFp(this.configuration).getReminderCounts(requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
849
+ return RemindersApiFp(this.configuration).getReminderCounts(requestParameters.authorization, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
836
850
  }
837
851
 
838
852
  /**
839
- * Retrieves a list of reminders.
853
+ * Retrieves a list of reminders. **Required Permissions** \"task-management.tasks.view\"
840
854
  * @summary List reminders
841
855
  * @param {RemindersApiListRemindersRequest} requestParameters Request parameters.
842
856
  * @param {*} [options] Override http request option.
@@ -848,7 +862,7 @@ export class RemindersApi extends BaseAPI {
848
862
  }
849
863
 
850
864
  /**
851
- * This will mark a reminder as done.
865
+ * This will mark a reminder as done. **Required Permissions** \"task-management.tasks.update\"
852
866
  * @summary Create the reminder done
853
867
  * @param {RemindersApiMarkReminderDoneRequest} requestParameters Request parameters.
854
868
  * @param {*} [options] Override http request option.
@@ -860,7 +874,7 @@ export class RemindersApi extends BaseAPI {
860
874
  }
861
875
 
862
876
  /**
863
- * This will patch a reminder.
877
+ * This will patch a reminder. **Required Permissions** \"task-management.tasks.update\"
864
878
  * @summary Update the reminder
865
879
  * @param {RemindersApiPatchReminderRequest} requestParameters Request parameters.
866
880
  * @param {*} [options] Override http request option.