@emilgroup/task-sdk-node 1.2.1-beta.1 → 1.2.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.
package/api.ts CHANGED
@@ -26,18 +26,20 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
26
26
  import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base';
27
27
  import { AssigneesApi } from './api';
28
28
  import { CategoriesApi } from './api';
29
- import { DefaultApi } from './api';
29
+ import { HealthApi } from './api';
30
30
  import { HubSpotApi } from './api';
31
31
  import { RemindersApi } from './api';
32
32
  import { StatusesApi } from './api';
33
+ import { TaskClientApi } from './api';
33
34
  import { TasksApi } from './api';
34
35
 
35
36
 
36
37
  export * from './api/assignees-api';
37
38
  export * from './api/categories-api';
38
- export * from './api/default-api';
39
+ export * from './api/health-api';
39
40
  export * from './api/hub-spot-api';
40
41
  export * from './api/reminders-api';
41
42
  export * from './api/statuses-api';
43
+ export * from './api/task-client-api';
42
44
  export * from './api/tasks-api';
43
45
 
@@ -14,10 +14,10 @@ import { Configuration } from '../configuration';
14
14
  import { RequestArgs, BaseAPI } from '../base';
15
15
  import { InlineResponse200 } from '../models';
16
16
  /**
17
- * DefaultApi - axios parameter creator
17
+ * HealthApi - axios parameter creator
18
18
  * @export
19
19
  */
20
- export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration) => {
20
+ export declare const HealthApiAxiosParamCreator: (configuration?: Configuration) => {
21
21
  /**
22
22
  * 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.
23
23
  * @summary Health Check
@@ -27,10 +27,10 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
27
27
  check: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
28
28
  };
29
29
  /**
30
- * DefaultApi - functional programming interface
30
+ * HealthApi - functional programming interface
31
31
  * @export
32
32
  */
33
- export declare const DefaultApiFp: (configuration?: Configuration) => {
33
+ export declare const HealthApiFp: (configuration?: Configuration) => {
34
34
  /**
35
35
  * 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.
36
36
  * @summary Health Check
@@ -40,10 +40,10 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
40
40
  check(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse200>>;
41
41
  };
42
42
  /**
43
- * DefaultApi - factory interface
43
+ * HealthApi - factory interface
44
44
  * @export
45
45
  */
46
- export declare const DefaultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
46
+ export declare const HealthApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
47
47
  /**
48
48
  * 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.
49
49
  * @summary Health Check
@@ -53,18 +53,18 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
53
53
  check(options?: any): AxiosPromise<InlineResponse200>;
54
54
  };
55
55
  /**
56
- * DefaultApi - object-oriented interface
56
+ * HealthApi - object-oriented interface
57
57
  * @export
58
- * @class DefaultApi
58
+ * @class HealthApi
59
59
  * @extends {BaseAPI}
60
60
  */
61
- export declare class DefaultApi extends BaseAPI {
61
+ export declare class HealthApi extends BaseAPI {
62
62
  /**
63
63
  * 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.
64
64
  * @summary Health Check
65
65
  * @param {*} [options] Override http request option.
66
66
  * @throws {RequiredError}
67
- * @memberof DefaultApi
67
+ * @memberof HealthApi
68
68
  */
69
69
  check(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InlineResponse200, any, {}>>;
70
70
  }
@@ -78,7 +78,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
78
78
  return (mod && mod.__esModule) ? mod : { "default": mod };
79
79
  };
80
80
  Object.defineProperty(exports, "__esModule", { value: true });
81
- exports.DefaultApi = exports.DefaultApiFactory = exports.DefaultApiFp = exports.DefaultApiAxiosParamCreator = void 0;
81
+ exports.HealthApi = exports.HealthApiFactory = exports.HealthApiFp = exports.HealthApiAxiosParamCreator = void 0;
82
82
  var axios_1 = __importDefault(require("axios"));
83
83
  // Some imports not used depending on template conditions
84
84
  // @ts-ignore
@@ -90,10 +90,10 @@ var base_1 = require("../base");
90
90
  var url_1 = require("url");
91
91
  var FormData = require('form-data');
92
92
  /**
93
- * DefaultApi - axios parameter creator
93
+ * HealthApi - axios parameter creator
94
94
  * @export
95
95
  */
96
- var DefaultApiAxiosParamCreator = function (configuration) {
96
+ var HealthApiAxiosParamCreator = function (configuration) {
97
97
  var _this = this;
98
98
  return {
99
99
  /**
@@ -128,13 +128,13 @@ var DefaultApiAxiosParamCreator = function (configuration) {
128
128
  },
129
129
  };
130
130
  };
131
- exports.DefaultApiAxiosParamCreator = DefaultApiAxiosParamCreator;
131
+ exports.HealthApiAxiosParamCreator = HealthApiAxiosParamCreator;
132
132
  /**
133
- * DefaultApi - functional programming interface
133
+ * HealthApi - functional programming interface
134
134
  * @export
135
135
  */
136
- var DefaultApiFp = function (configuration) {
137
- var localVarAxiosParamCreator = (0, exports.DefaultApiAxiosParamCreator)(configuration);
136
+ var HealthApiFp = function (configuration) {
137
+ var localVarAxiosParamCreator = (0, exports.HealthApiAxiosParamCreator)(configuration);
138
138
  return {
139
139
  /**
140
140
  * 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.
@@ -157,13 +157,13 @@ var DefaultApiFp = function (configuration) {
157
157
  },
158
158
  };
159
159
  };
160
- exports.DefaultApiFp = DefaultApiFp;
160
+ exports.HealthApiFp = HealthApiFp;
161
161
  /**
162
- * DefaultApi - factory interface
162
+ * HealthApi - factory interface
163
163
  * @export
164
164
  */
165
- var DefaultApiFactory = function (configuration, basePath, axios) {
166
- var localVarFp = (0, exports.DefaultApiFp)(configuration);
165
+ var HealthApiFactory = function (configuration, basePath, axios) {
166
+ var localVarFp = (0, exports.HealthApiFp)(configuration);
167
167
  return {
168
168
  /**
169
169
  * 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.
@@ -176,16 +176,16 @@ var DefaultApiFactory = function (configuration, basePath, axios) {
176
176
  },
177
177
  };
178
178
  };
179
- exports.DefaultApiFactory = DefaultApiFactory;
179
+ exports.HealthApiFactory = HealthApiFactory;
180
180
  /**
181
- * DefaultApi - object-oriented interface
181
+ * HealthApi - object-oriented interface
182
182
  * @export
183
- * @class DefaultApi
183
+ * @class HealthApi
184
184
  * @extends {BaseAPI}
185
185
  */
186
- var DefaultApi = /** @class */ (function (_super) {
187
- __extends(DefaultApi, _super);
188
- function DefaultApi() {
186
+ var HealthApi = /** @class */ (function (_super) {
187
+ __extends(HealthApi, _super);
188
+ function HealthApi() {
189
189
  return _super !== null && _super.apply(this, arguments) || this;
190
190
  }
191
191
  /**
@@ -193,12 +193,12 @@ var DefaultApi = /** @class */ (function (_super) {
193
193
  * @summary Health Check
194
194
  * @param {*} [options] Override http request option.
195
195
  * @throws {RequiredError}
196
- * @memberof DefaultApi
196
+ * @memberof HealthApi
197
197
  */
198
- DefaultApi.prototype.check = function (options) {
198
+ HealthApi.prototype.check = function (options) {
199
199
  var _this = this;
200
- return (0, exports.DefaultApiFp)(this.configuration).check(options).then(function (request) { return request(_this.axios, _this.basePath); });
200
+ return (0, exports.HealthApiFp)(this.configuration).check(options).then(function (request) { return request(_this.axios, _this.basePath); });
201
201
  };
202
- return DefaultApi;
202
+ return HealthApi;
203
203
  }(base_1.BaseAPI));
204
- exports.DefaultApi = DefaultApi;
204
+ exports.HealthApi = HealthApi;
@@ -26,7 +26,7 @@ import { PatchReminderResponseClass } from '../models';
26
26
  */
27
27
  export declare const RemindersApiAxiosParamCreator: (configuration?: Configuration) => {
28
28
  /**
29
- * This will create a reminder.
29
+ * This will create a reminder. **Required Permissions** \"task-management.tasks.create\"
30
30
  * @summary Create the reminder
31
31
  * @param {CreateReminderRequestDto} createReminderRequestDto
32
32
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -35,7 +35,7 @@ export declare const RemindersApiAxiosParamCreator: (configuration?: Configurati
35
35
  */
36
36
  createReminder: (createReminderRequestDto: CreateReminderRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
37
37
  /**
38
- * This will delete a reminder.
38
+ * This will delete a reminder. **Required Permissions** \"task-management.tasks.delete\"
39
39
  * @summary Delete the reminder
40
40
  * @param {string} code Unique identifier for the object.
41
41
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -44,7 +44,7 @@ export declare const RemindersApiAxiosParamCreator: (configuration?: Configurati
44
44
  */
45
45
  deleteReminder: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
46
46
  /**
47
- * This will get a reminder by code.
47
+ * This will get a reminder by code. **Required Permissions** \"task-management.tasks.view\"
48
48
  * @summary Retrieve the reminder
49
49
  * @param {string} code Unique identifier for the object.
50
50
  * @param {string} expand
@@ -54,30 +54,31 @@ export declare const RemindersApiAxiosParamCreator: (configuration?: Configurati
54
54
  */
55
55
  getReminder: (code: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
56
56
  /**
57
- * This will get reminder counts by status.
57
+ * 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\"
58
58
  * @summary Retrieve the reminder counts
59
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.
60
61
  * @param {*} [options] Override http request option.
61
62
  * @throws {RequiredError}
62
63
  */
63
- getReminderCounts: (authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
64
+ getReminderCounts: (authorization?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
64
65
  /**
65
- * Retrieves a list of reminders.
66
+ * Retrieves a list of reminders. **Required Permissions** \"task-management.tasks.view\"
66
67
  * @summary List reminders
67
68
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
68
69
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
69
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.
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;
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;
73
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;
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 {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;
75
76
  * @param {*} [options] Override http request option.
76
77
  * @throws {RequiredError}
77
78
  */
78
79
  listReminders: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
79
80
  /**
80
- * This will mark a reminder as done.
81
+ * This will mark a reminder as done. **Required Permissions** \"task-management.tasks.update\"
81
82
  * @summary Create the reminder done
82
83
  * @param {string} code
83
84
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -86,7 +87,7 @@ export declare const RemindersApiAxiosParamCreator: (configuration?: Configurati
86
87
  */
87
88
  markReminderDone: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
88
89
  /**
89
- * This will patch a reminder.
90
+ * This will patch a reminder. **Required Permissions** \"task-management.tasks.update\"
90
91
  * @summary Update the reminder
91
92
  * @param {PatchReminderRequestDto} patchReminderRequestDto
92
93
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -101,7 +102,7 @@ export declare const RemindersApiAxiosParamCreator: (configuration?: Configurati
101
102
  */
102
103
  export declare const RemindersApiFp: (configuration?: Configuration) => {
103
104
  /**
104
- * This will create a reminder.
105
+ * This will create a reminder. **Required Permissions** \"task-management.tasks.create\"
105
106
  * @summary Create the reminder
106
107
  * @param {CreateReminderRequestDto} createReminderRequestDto
107
108
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -110,7 +111,7 @@ export declare const RemindersApiFp: (configuration?: Configuration) => {
110
111
  */
111
112
  createReminder(createReminderRequestDto: CreateReminderRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateReminderResponseClass>>;
112
113
  /**
113
- * This will delete a reminder.
114
+ * This will delete a reminder. **Required Permissions** \"task-management.tasks.delete\"
114
115
  * @summary Delete the reminder
115
116
  * @param {string} code Unique identifier for the object.
116
117
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -119,7 +120,7 @@ export declare const RemindersApiFp: (configuration?: Configuration) => {
119
120
  */
120
121
  deleteReminder(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
121
122
  /**
122
- * This will get a reminder by code.
123
+ * This will get a reminder by code. **Required Permissions** \"task-management.tasks.view\"
123
124
  * @summary Retrieve the reminder
124
125
  * @param {string} code Unique identifier for the object.
125
126
  * @param {string} expand
@@ -129,30 +130,31 @@ export declare const RemindersApiFp: (configuration?: Configuration) => {
129
130
  */
130
131
  getReminder(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetReminderResponseClass>>;
131
132
  /**
132
- * This will get reminder counts by status.
133
+ * 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\"
133
134
  * @summary Retrieve the reminder counts
134
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.
135
137
  * @param {*} [options] Override http request option.
136
138
  * @throws {RequiredError}
137
139
  */
138
- getReminderCounts(authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetReminderCountsResponseClass>>;
140
+ getReminderCounts(authorization?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetReminderCountsResponseClass>>;
139
141
  /**
140
- * Retrieves a list of reminders.
142
+ * Retrieves a list of reminders. **Required Permissions** \"task-management.tasks.view\"
141
143
  * @summary List reminders
142
144
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
143
145
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
144
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.
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;
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;
148
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;
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;
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;
150
152
  * @param {*} [options] Override http request option.
151
153
  * @throws {RequiredError}
152
154
  */
153
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>>;
154
156
  /**
155
- * This will mark a reminder as done.
157
+ * This will mark a reminder as done. **Required Permissions** \"task-management.tasks.update\"
156
158
  * @summary Create the reminder done
157
159
  * @param {string} code
158
160
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -161,7 +163,7 @@ export declare const RemindersApiFp: (configuration?: Configuration) => {
161
163
  */
162
164
  markReminderDone(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MarkReminderDoneResponseClass>>;
163
165
  /**
164
- * This will patch a reminder.
166
+ * This will patch a reminder. **Required Permissions** \"task-management.tasks.update\"
165
167
  * @summary Update the reminder
166
168
  * @param {PatchReminderRequestDto} patchReminderRequestDto
167
169
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -176,7 +178,7 @@ export declare const RemindersApiFp: (configuration?: Configuration) => {
176
178
  */
177
179
  export declare const RemindersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
178
180
  /**
179
- * This will create a reminder.
181
+ * This will create a reminder. **Required Permissions** \"task-management.tasks.create\"
180
182
  * @summary Create the reminder
181
183
  * @param {CreateReminderRequestDto} createReminderRequestDto
182
184
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -185,7 +187,7 @@ export declare const RemindersApiFactory: (configuration?: Configuration, basePa
185
187
  */
186
188
  createReminder(createReminderRequestDto: CreateReminderRequestDto, authorization?: string, options?: any): AxiosPromise<CreateReminderResponseClass>;
187
189
  /**
188
- * This will delete a reminder.
190
+ * This will delete a reminder. **Required Permissions** \"task-management.tasks.delete\"
189
191
  * @summary Delete the reminder
190
192
  * @param {string} code Unique identifier for the object.
191
193
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -194,7 +196,7 @@ export declare const RemindersApiFactory: (configuration?: Configuration, basePa
194
196
  */
195
197
  deleteReminder(code: string, authorization?: string, options?: any): AxiosPromise<void>;
196
198
  /**
197
- * This will get a reminder by code.
199
+ * This will get a reminder by code. **Required Permissions** \"task-management.tasks.view\"
198
200
  * @summary Retrieve the reminder
199
201
  * @param {string} code Unique identifier for the object.
200
202
  * @param {string} expand
@@ -204,30 +206,31 @@ export declare const RemindersApiFactory: (configuration?: Configuration, basePa
204
206
  */
205
207
  getReminder(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetReminderResponseClass>;
206
208
  /**
207
- * This will get reminder counts by status.
209
+ * 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\"
208
210
  * @summary Retrieve the reminder counts
209
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.
210
213
  * @param {*} [options] Override http request option.
211
214
  * @throws {RequiredError}
212
215
  */
213
- getReminderCounts(authorization?: string, options?: any): AxiosPromise<GetReminderCountsResponseClass>;
216
+ getReminderCounts(authorization?: string, filters?: string, options?: any): AxiosPromise<GetReminderCountsResponseClass>;
214
217
  /**
215
- * Retrieves a list of reminders.
218
+ * Retrieves a list of reminders. **Required Permissions** \"task-management.tasks.view\"
216
219
  * @summary List reminders
217
220
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
218
221
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
219
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.
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} [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;
223
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;
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;
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;
225
228
  * @param {*} [options] Override http request option.
226
229
  * @throws {RequiredError}
227
230
  */
228
231
  listReminders(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListRemindersResponseClass>;
229
232
  /**
230
- * This will mark a reminder as done.
233
+ * This will mark a reminder as done. **Required Permissions** \"task-management.tasks.update\"
231
234
  * @summary Create the reminder done
232
235
  * @param {string} code
233
236
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -236,7 +239,7 @@ export declare const RemindersApiFactory: (configuration?: Configuration, basePa
236
239
  */
237
240
  markReminderDone(code: string, authorization?: string, options?: any): AxiosPromise<MarkReminderDoneResponseClass>;
238
241
  /**
239
- * This will patch a reminder.
242
+ * This will patch a reminder. **Required Permissions** \"task-management.tasks.update\"
240
243
  * @summary Update the reminder
241
244
  * @param {PatchReminderRequestDto} patchReminderRequestDto
242
245
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -320,6 +323,12 @@ export interface RemindersApiGetReminderCountsRequest {
320
323
  * @memberof RemindersApiGetReminderCounts
321
324
  */
322
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;
323
332
  }
324
333
  /**
325
334
  * Request parameters for listReminders operation in RemindersApi.
@@ -346,19 +355,19 @@ export interface RemindersApiListRemindersRequest {
346
355
  */
347
356
  readonly pageToken?: string;
348
357
  /**
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;
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;
350
359
  * @type {string}
351
360
  * @memberof RemindersApiListReminders
352
361
  */
353
362
  readonly filter?: string;
354
363
  /**
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;
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;
356
365
  * @type {string}
357
366
  * @memberof RemindersApiListReminders
358
367
  */
359
368
  readonly search?: string;
360
369
  /**
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;
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;
362
371
  * @type {string}
363
372
  * @memberof RemindersApiListReminders
364
373
  */
@@ -370,7 +379,7 @@ export interface RemindersApiListRemindersRequest {
370
379
  */
371
380
  readonly expand?: string;
372
381
  /**
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;
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;
374
383
  * @type {string}
375
384
  * @memberof RemindersApiListReminders
376
385
  */
@@ -422,7 +431,7 @@ export interface RemindersApiPatchReminderRequest {
422
431
  */
423
432
  export declare class RemindersApi extends BaseAPI {
424
433
  /**
425
- * This will create a reminder.
434
+ * This will create a reminder. **Required Permissions** \"task-management.tasks.create\"
426
435
  * @summary Create the reminder
427
436
  * @param {RemindersApiCreateReminderRequest} requestParameters Request parameters.
428
437
  * @param {*} [options] Override http request option.
@@ -431,7 +440,7 @@ export declare class RemindersApi extends BaseAPI {
431
440
  */
432
441
  createReminder(requestParameters: RemindersApiCreateReminderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateReminderResponseClass, any, {}>>;
433
442
  /**
434
- * This will delete a reminder.
443
+ * This will delete a reminder. **Required Permissions** \"task-management.tasks.delete\"
435
444
  * @summary Delete the reminder
436
445
  * @param {RemindersApiDeleteReminderRequest} requestParameters Request parameters.
437
446
  * @param {*} [options] Override http request option.
@@ -440,7 +449,7 @@ export declare class RemindersApi extends BaseAPI {
440
449
  */
441
450
  deleteReminder(requestParameters: RemindersApiDeleteReminderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
442
451
  /**
443
- * This will get a reminder by code.
452
+ * This will get a reminder by code. **Required Permissions** \"task-management.tasks.view\"
444
453
  * @summary Retrieve the reminder
445
454
  * @param {RemindersApiGetReminderRequest} requestParameters Request parameters.
446
455
  * @param {*} [options] Override http request option.
@@ -449,7 +458,7 @@ export declare class RemindersApi extends BaseAPI {
449
458
  */
450
459
  getReminder(requestParameters: RemindersApiGetReminderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetReminderResponseClass, any, {}>>;
451
460
  /**
452
- * This will get reminder counts by status.
461
+ * 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\"
453
462
  * @summary Retrieve the reminder counts
454
463
  * @param {RemindersApiGetReminderCountsRequest} requestParameters Request parameters.
455
464
  * @param {*} [options] Override http request option.
@@ -458,7 +467,7 @@ export declare class RemindersApi extends BaseAPI {
458
467
  */
459
468
  getReminderCounts(requestParameters?: RemindersApiGetReminderCountsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetReminderCountsResponseClass, any, {}>>;
460
469
  /**
461
- * Retrieves a list of reminders.
470
+ * Retrieves a list of reminders. **Required Permissions** \"task-management.tasks.view\"
462
471
  * @summary List reminders
463
472
  * @param {RemindersApiListRemindersRequest} requestParameters Request parameters.
464
473
  * @param {*} [options] Override http request option.
@@ -467,7 +476,7 @@ export declare class RemindersApi extends BaseAPI {
467
476
  */
468
477
  listReminders(requestParameters?: RemindersApiListRemindersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListRemindersResponseClass, any, {}>>;
469
478
  /**
470
- * This will mark a reminder as done.
479
+ * This will mark a reminder as done. **Required Permissions** \"task-management.tasks.update\"
471
480
  * @summary Create the reminder done
472
481
  * @param {RemindersApiMarkReminderDoneRequest} requestParameters Request parameters.
473
482
  * @param {*} [options] Override http request option.
@@ -476,7 +485,7 @@ export declare class RemindersApi extends BaseAPI {
476
485
  */
477
486
  markReminderDone(requestParameters: RemindersApiMarkReminderDoneRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<MarkReminderDoneResponseClass, any, {}>>;
478
487
  /**
479
- * This will patch a reminder.
488
+ * This will patch a reminder. **Required Permissions** \"task-management.tasks.update\"
480
489
  * @summary Update the reminder
481
490
  * @param {RemindersApiPatchReminderRequest} requestParameters Request parameters.
482
491
  * @param {*} [options] Override http request option.