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

package/dist/api/reminders-api.js

@@ -93,7 +93,7 @@ var RemindersApiAxiosParamCreator = function (configuration) {
     var _this = this;
     return {
         /**
-         * This will create a reminder.
+         * This will create a reminder.  **Required Permissions**  \"task-management.tasks.create\"
          * @summary Create the reminder
          * @param {CreateReminderRequestDto} createReminderRequestDto
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -142,7 +142,7 @@ var RemindersApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         * This will delete a reminder.
+         * This will delete a reminder.  **Required Permissions**  \"task-management.tasks.delete\"
          * @summary Delete the reminder
          * @param {string} code Unique identifier for the object.
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -190,7 +190,7 @@ var RemindersApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         * This will get a reminder by code.
+         * This will get a reminder by code.  **Required Permissions**  \"task-management.tasks.view\"
          * @summary Retrieve the reminder
          * @param {string} code Unique identifier for the object.
          * @param {string} expand
@@ -244,13 +244,14 @@ var RemindersApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         * This will get reminder counts by status.
+         * 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\"
          * @summary Retrieve the reminder counts
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @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.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getReminderCounts: function (authorization, options) {
+        getReminderCounts: function (authorization, filters, options) {
             if (options === void 0) { options = {}; }
             return __awaiter(_this, void 0, void 0, function () {
                 var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -273,6 +274,9 @@ var RemindersApiAxiosParamCreator = function (configuration) {
                             // authentication bearer required
                             // http bearer authentication required
                             _a.sent();
+                            if (filters !== undefined) {
+                                localVarQueryParameter['filters'] = filters;
+                            }
                             if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
                                 localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
                             }
@@ -288,16 +292,16 @@ var RemindersApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         * Retrieves a list of reminders.
+         * Retrieves a list of reminders.  **Required Permissions**  \"task-management.tasks.view\"
          * @summary List reminders
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
          * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
          * @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
-         * @param {string} [filter] Filter the response by one or multiple fields.             In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/>             <br/>             <i>Allowed values: id, code, entityType, entityCode, isDone, userSub, dueAt, createdAt</i>
-         * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.<br/>           <br/>           <i>Searchable fields: title, description</i>
-         * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.<br/>           <br/>           <i>Allowed values: id, createdAt, updatedAt, dueAt, isDone</i>
+         * @param {string} [filter] Filter the response by one or multiple fields.             In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/>             <br/>             <i>Allowed values: id, code, entityType, entityCode, isDone, status, userSub, entityNumber, dueAt, createdAt</i>
+         * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.<br/>           <br/>           <i>Searchable fields: code, title, description, entityCode, entityNumber, userSub, userName</i>
+         * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.<br/>           <br/>           <i>Allowed values: id, createdAt, updatedAt, dueAt, isDone, status</i>
          * @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.<br/>       <br/>
-         * @param {string} [filters] Filters the response by one or multiple fields.           Advanced filter functionality allows you to perform more complex filtering operations.<br/>           <br/>           <i>Allowed values: id, code, entityType, entityCode, isDone, userSub, dueAt, createdAt</i>
+         * @param {string} [filters] Filters the response by one or multiple fields.           Advanced filter functionality allows you to perform more complex filtering operations.<br/>           <br/>           <i>Allowed values: id, code, entityType, entityCode, isDone, status, userSub, entityNumber, dueAt, createdAt</i>
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -360,7 +364,7 @@ var RemindersApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         * This will mark a reminder as done.
+         * This will mark a reminder as done.  **Required Permissions**  \"task-management.tasks.update\"
          * @summary Create the reminder done
          * @param {string} code
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -408,7 +412,7 @@ var RemindersApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         * This will patch a reminder.
+         * This will patch a reminder.  **Required Permissions**  \"task-management.tasks.update\"
          * @summary Update the reminder
          * @param {PatchReminderRequestDto} patchReminderRequestDto
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -467,7 +471,7 @@ var RemindersApiFp = function (configuration) {
     var localVarAxiosParamCreator = (0, exports.RemindersApiAxiosParamCreator)(configuration);
     return {
         /**
-         * This will create a reminder.
+         * This will create a reminder.  **Required Permissions**  \"task-management.tasks.create\"
          * @summary Create the reminder
          * @param {CreateReminderRequestDto} createReminderRequestDto
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -488,7 +492,7 @@ var RemindersApiFp = function (configuration) {
             });
         },
         /**
-         * This will delete a reminder.
+         * This will delete a reminder.  **Required Permissions**  \"task-management.tasks.delete\"
          * @summary Delete the reminder
          * @param {string} code Unique identifier for the object.
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -509,7 +513,7 @@ var RemindersApiFp = function (configuration) {
             });
         },
         /**
-         * This will get a reminder by code.
+         * This will get a reminder by code.  **Required Permissions**  \"task-management.tasks.view\"
          * @summary Retrieve the reminder
          * @param {string} code Unique identifier for the object.
          * @param {string} expand
@@ -531,18 +535,19 @@ var RemindersApiFp = function (configuration) {
             });
         },
         /**
-         * This will get reminder counts by status.
+         * 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\"
          * @summary Retrieve the reminder counts
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @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.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getReminderCounts: function (authorization, options) {
+        getReminderCounts: function (authorization, filters, options) {
             return __awaiter(this, void 0, void 0, function () {
                 var localVarAxiosArgs;
                 return __generator(this, function (_a) {
                     switch (_a.label) {
-                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.getReminderCounts(authorization, options)];
+                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.getReminderCounts(authorization, filters, options)];
                         case 1:
                             localVarAxiosArgs = _a.sent();
                             return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -551,16 +556,16 @@ var RemindersApiFp = function (configuration) {
             });
         },
         /**
-         * Retrieves a list of reminders.
+         * Retrieves a list of reminders.  **Required Permissions**  \"task-management.tasks.view\"
          * @summary List reminders
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
          * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
          * @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
-         * @param {string} [filter] Filter the response by one or multiple fields.             In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/>             <br/>             <i>Allowed values: id, code, entityType, entityCode, isDone, userSub, dueAt, createdAt</i>
-         * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.<br/>           <br/>           <i>Searchable fields: title, description</i>
-         * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.<br/>           <br/>           <i>Allowed values: id, createdAt, updatedAt, dueAt, isDone</i>
+         * @param {string} [filter] Filter the response by one or multiple fields.             In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/>             <br/>             <i>Allowed values: id, code, entityType, entityCode, isDone, status, userSub, entityNumber, dueAt, createdAt</i>
+         * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.<br/>           <br/>           <i>Searchable fields: code, title, description, entityCode, entityNumber, userSub, userName</i>
+         * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.<br/>           <br/>           <i>Allowed values: id, createdAt, updatedAt, dueAt, isDone, status</i>
          * @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.<br/>       <br/>
-         * @param {string} [filters] Filters the response by one or multiple fields.           Advanced filter functionality allows you to perform more complex filtering operations.<br/>           <br/>           <i>Allowed values: id, code, entityType, entityCode, isDone, userSub, dueAt, createdAt</i>
+         * @param {string} [filters] Filters the response by one or multiple fields.           Advanced filter functionality allows you to perform more complex filtering operations.<br/>           <br/>           <i>Allowed values: id, code, entityType, entityCode, isDone, status, userSub, entityNumber, dueAt, createdAt</i>
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -578,7 +583,7 @@ var RemindersApiFp = function (configuration) {
             });
         },
         /**
-         * This will mark a reminder as done.
+         * This will mark a reminder as done.  **Required Permissions**  \"task-management.tasks.update\"
          * @summary Create the reminder done
          * @param {string} code
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -599,7 +604,7 @@ var RemindersApiFp = function (configuration) {
             });
         },
         /**
-         * This will patch a reminder.
+         * This will patch a reminder.  **Required Permissions**  \"task-management.tasks.update\"
          * @summary Update the reminder
          * @param {PatchReminderRequestDto} patchReminderRequestDto
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -630,7 +635,7 @@ var RemindersApiFactory = function (configuration, basePath, axios) {
     var localVarFp = (0, exports.RemindersApiFp)(configuration);
     return {
         /**
-         * This will create a reminder.
+         * This will create a reminder.  **Required Permissions**  \"task-management.tasks.create\"
          * @summary Create the reminder
          * @param {CreateReminderRequestDto} createReminderRequestDto
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -641,7 +646,7 @@ var RemindersApiFactory = function (configuration, basePath, axios) {
             return localVarFp.createReminder(createReminderRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
         },
         /**
-         * This will delete a reminder.
+         * This will delete a reminder.  **Required Permissions**  \"task-management.tasks.delete\"
          * @summary Delete the reminder
          * @param {string} code Unique identifier for the object.
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -652,7 +657,7 @@ var RemindersApiFactory = function (configuration, basePath, axios) {
             return localVarFp.deleteReminder(code, authorization, options).then(function (request) { return request(axios, basePath); });
         },
         /**
-         * This will get a reminder by code.
+         * This will get a reminder by code.  **Required Permissions**  \"task-management.tasks.view\"
          * @summary Retrieve the reminder
          * @param {string} code Unique identifier for the object.
          * @param {string} expand
@@ -664,26 +669,27 @@ var RemindersApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getReminder(code, expand, authorization, options).then(function (request) { return request(axios, basePath); });
         },
         /**
-         * This will get reminder counts by status.
+         * 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\"
          * @summary Retrieve the reminder counts
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @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.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getReminderCounts: function (authorization, options) {
-            return localVarFp.getReminderCounts(authorization, options).then(function (request) { return request(axios, basePath); });
+        getReminderCounts: function (authorization, filters, options) {
+            return localVarFp.getReminderCounts(authorization, filters, options).then(function (request) { return request(axios, basePath); });
         },
         /**
-         * Retrieves a list of reminders.
+         * Retrieves a list of reminders.  **Required Permissions**  \"task-management.tasks.view\"
          * @summary List reminders
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
          * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
          * @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
-         * @param {string} [filter] Filter the response by one or multiple fields.             In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/>             <br/>             <i>Allowed values: id, code, entityType, entityCode, isDone, userSub, dueAt, createdAt</i>
-         * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.<br/>           <br/>           <i>Searchable fields: title, description</i>
-         * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.<br/>           <br/>           <i>Allowed values: id, createdAt, updatedAt, dueAt, isDone</i>
+         * @param {string} [filter] Filter the response by one or multiple fields.             In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/>             <br/>             <i>Allowed values: id, code, entityType, entityCode, isDone, status, userSub, entityNumber, dueAt, createdAt</i>
+         * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.<br/>           <br/>           <i>Searchable fields: code, title, description, entityCode, entityNumber, userSub, userName</i>
+         * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.<br/>           <br/>           <i>Allowed values: id, createdAt, updatedAt, dueAt, isDone, status</i>
          * @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.<br/>       <br/>
-         * @param {string} [filters] Filters the response by one or multiple fields.           Advanced filter functionality allows you to perform more complex filtering operations.<br/>           <br/>           <i>Allowed values: id, code, entityType, entityCode, isDone, userSub, dueAt, createdAt</i>
+         * @param {string} [filters] Filters the response by one or multiple fields.           Advanced filter functionality allows you to perform more complex filtering operations.<br/>           <br/>           <i>Allowed values: id, code, entityType, entityCode, isDone, status, userSub, entityNumber, dueAt, createdAt</i>
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -691,7 +697,7 @@ var RemindersApiFactory = function (configuration, basePath, axios) {
             return localVarFp.listReminders(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
         },
         /**
-         * This will mark a reminder as done.
+         * This will mark a reminder as done.  **Required Permissions**  \"task-management.tasks.update\"
          * @summary Create the reminder done
          * @param {string} code
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -702,7 +708,7 @@ var RemindersApiFactory = function (configuration, basePath, axios) {
             return localVarFp.markReminderDone(code, authorization, options).then(function (request) { return request(axios, basePath); });
         },
         /**
-         * This will patch a reminder.
+         * This will patch a reminder.  **Required Permissions**  \"task-management.tasks.update\"
          * @summary Update the reminder
          * @param {PatchReminderRequestDto} patchReminderRequestDto
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -727,7 +733,7 @@ var RemindersApi = /** @class */ (function (_super) {
         return _super !== null && _super.apply(this, arguments) || this;
     }
     /**
-     * This will create a reminder.
+     * This will create a reminder.  **Required Permissions**  \"task-management.tasks.create\"
      * @summary Create the reminder
      * @param {RemindersApiCreateReminderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -739,7 +745,7 @@ var RemindersApi = /** @class */ (function (_super) {
         return (0, exports.RemindersApiFp)(this.configuration).createReminder(requestParameters.createReminderRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
-     * This will delete a reminder.
+     * This will delete a reminder.  **Required Permissions**  \"task-management.tasks.delete\"
      * @summary Delete the reminder
      * @param {RemindersApiDeleteReminderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -751,7 +757,7 @@ var RemindersApi = /** @class */ (function (_super) {
         return (0, exports.RemindersApiFp)(this.configuration).deleteReminder(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
-     * This will get a reminder by code.
+     * This will get a reminder by code.  **Required Permissions**  \"task-management.tasks.view\"
      * @summary Retrieve the reminder
      * @param {RemindersApiGetReminderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -763,7 +769,7 @@ var RemindersApi = /** @class */ (function (_super) {
         return (0, exports.RemindersApiFp)(this.configuration).getReminder(requestParameters.code, requestParameters.expand, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
-     * This will get reminder counts by status.
+     * 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\"
      * @summary Retrieve the reminder counts
      * @param {RemindersApiGetReminderCountsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -773,10 +779,10 @@ var RemindersApi = /** @class */ (function (_super) {
     RemindersApi.prototype.getReminderCounts = function (requestParameters, options) {
         var _this = this;
         if (requestParameters === void 0) { requestParameters = {}; }
-        return (0, exports.RemindersApiFp)(this.configuration).getReminderCounts(requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
+        return (0, exports.RemindersApiFp)(this.configuration).getReminderCounts(requestParameters.authorization, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
-     * Retrieves a list of reminders.
+     * Retrieves a list of reminders.  **Required Permissions**  \"task-management.tasks.view\"
      * @summary List reminders
      * @param {RemindersApiListRemindersRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -789,7 +795,7 @@ var RemindersApi = /** @class */ (function (_super) {
         return (0, exports.RemindersApiFp)(this.configuration).listReminders(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
-     * This will mark a reminder as done.
+     * This will mark a reminder as done.  **Required Permissions**  \"task-management.tasks.update\"
      * @summary Create the reminder done
      * @param {RemindersApiMarkReminderDoneRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -801,7 +807,7 @@ var RemindersApi = /** @class */ (function (_super) {
         return (0, exports.RemindersApiFp)(this.configuration).markReminderDone(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
-     * This will patch a reminder.
+     * This will patch a reminder.  **Required Permissions**  \"task-management.tasks.update\"
      * @summary Update the reminder
      * @param {RemindersApiPatchReminderRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.