@emilgroup/task-sdk-node 1.0.1-beta.3 → 1.0.1-beta.34

package/dist/api/statuses-api.js

@@ -97,7 +97,7 @@ var StatusesApiAxiosParamCreator = function (configuration) {
     var _this = this;
     return {
         /**
-         * This will create a status.
+         * This will create a status.  **Required Permissions**  \"task-management.tasks.create\"
          * @summary Create the status
          * @param {CreateStatusRequestDto} createStatusRequestDto
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -146,7 +146,7 @@ var StatusesApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         * This will delete status.
+         * This will delete status.  **Required Permissions**  \"task-management.tasks.delete\"
          * @summary Delete the status
          * @param {string} code Unique identifier for the object.
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -194,15 +194,15 @@ var StatusesApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         * Get status by code.
+         * Get status by code.  **Required Permissions**  \"task-management.tasks.view\"
          * @summary Retrieve the status
          * @param {string} code
-         * @param {string} expand
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {string} [expand] Expand to fetch additional information about the status.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getStatus: function (code, expand, authorization, options) {
+        getStatus: function (code, authorization, expand, options) {
             if (options === void 0) { options = {}; }
             return __awaiter(_this, void 0, void 0, function () {
                 var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -211,8 +211,6 @@ var StatusesApiAxiosParamCreator = function (configuration) {
                         case 0:
                             // verify required parameter 'code' is not null or undefined
                             (0, common_1.assertParamExists)('getStatus', 'code', code);
-                            // verify required parameter 'expand' is not null or undefined
-                            (0, common_1.assertParamExists)('getStatus', 'expand', expand);
                             localVarPath = "/taskservice/v1/statuses/{code}"
                                 .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
                             localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -248,12 +246,12 @@ var StatusesApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         * Retrieves a list of statuses.
+         * Retrieves a list of statuses.  **Required Permissions**  \"task-management.tasks.view\"
          * @summary List statuses
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
-         * @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, slug, name, createdAt, updatedAt</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, slug, name, createdAt, updatedAt</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: id, code, name, slug</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, slug, name, createdAt, updatedAt</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, slug, name, createdAt, updatedAt</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, name, slug</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, name, slug</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 {*} [options] Override http request option.
@@ -312,15 +310,15 @@ var StatusesApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         * This will update status.
+         * This will partially update a status by code with the provided fields.  **Required Permissions**  \"task-management.tasks.update\"
          * @summary Update the status
          * @param {string} code
-         * @param {UpdateStatusRequestDto} updateStatusRequestDto
+         * @param {PatchStatusRequestDto} patchStatusRequestDto
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        updateStatus: function (code, updateStatusRequestDto, authorization, options) {
+        patchStatus: function (code, patchStatusRequestDto, authorization, options) {
             if (options === void 0) { options = {}; }
             return __awaiter(_this, void 0, void 0, function () {
                 var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -328,9 +326,9 @@ var StatusesApiAxiosParamCreator = function (configuration) {
                     switch (_a.label) {
                         case 0:
                             // verify required parameter 'code' is not null or undefined
-                            (0, common_1.assertParamExists)('updateStatus', 'code', code);
-                            // verify required parameter 'updateStatusRequestDto' is not null or undefined
-                            (0, common_1.assertParamExists)('updateStatus', 'updateStatusRequestDto', updateStatusRequestDto);
+                            (0, common_1.assertParamExists)('patchStatus', 'code', code);
+                            // verify required parameter 'patchStatusRequestDto' is not null or undefined
+                            (0, common_1.assertParamExists)('patchStatus', 'patchStatusRequestDto', patchStatusRequestDto);
                             localVarPath = "/taskservice/v1/statuses/{code}"
                                 .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
                             localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -338,7 +336,7 @@ var StatusesApiAxiosParamCreator = function (configuration) {
                                 baseOptions = configuration.baseOptions;
                                 baseAccessToken = configuration.accessToken;
                             }
-                            localVarRequestOptions = __assign(__assign({ method: 'PUT' }, baseOptions), options);
+                            localVarRequestOptions = __assign(__assign({ method: 'PATCH' }, baseOptions), options);
                             localVarHeaderParameter = {};
                             localVarQueryParameter = {};
                             // authentication bearer required
@@ -355,7 +353,7 @@ var StatusesApiAxiosParamCreator = function (configuration) {
                             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
                             headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
                             localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
-                            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(updateStatusRequestDto, localVarRequestOptions, configuration);
+                            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(patchStatusRequestDto, localVarRequestOptions, configuration);
                             return [2 /*return*/, {
                                     url: (0, common_1.toPathString)(localVarUrlObj),
                                     options: localVarRequestOptions,
@@ -375,7 +373,7 @@ var StatusesApiFp = function (configuration) {
     var localVarAxiosParamCreator = (0, exports.StatusesApiAxiosParamCreator)(configuration);
     return {
         /**
-         * This will create a status.
+         * This will create a status.  **Required Permissions**  \"task-management.tasks.create\"
          * @summary Create the status
          * @param {CreateStatusRequestDto} createStatusRequestDto
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -396,7 +394,7 @@ var StatusesApiFp = function (configuration) {
             });
         },
         /**
-         * This will delete status.
+         * This will delete status.  **Required Permissions**  \"task-management.tasks.delete\"
          * @summary Delete the status
          * @param {string} code Unique identifier for the object.
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -417,20 +415,20 @@ var StatusesApiFp = function (configuration) {
             });
         },
         /**
-         * Get status by code.
+         * Get status by code.  **Required Permissions**  \"task-management.tasks.view\"
          * @summary Retrieve the status
          * @param {string} code
-         * @param {string} expand
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {string} [expand] Expand to fetch additional information about the status.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getStatus: function (code, expand, authorization, options) {
+        getStatus: function (code, authorization, expand, 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.getStatus(code, expand, authorization, options)];
+                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.getStatus(code, authorization, expand, options)];
                         case 1:
                             localVarAxiosArgs = _a.sent();
                             return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -439,12 +437,12 @@ var StatusesApiFp = function (configuration) {
             });
         },
         /**
-         * Retrieves a list of statuses.
+         * Retrieves a list of statuses.  **Required Permissions**  \"task-management.tasks.view\"
          * @summary List statuses
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
-         * @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, slug, name, createdAt, updatedAt</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, slug, name, createdAt, updatedAt</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: id, code, name, slug</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, slug, name, createdAt, updatedAt</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, slug, name, createdAt, updatedAt</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, name, slug</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, name, slug</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 {*} [options] Override http request option.
@@ -464,20 +462,20 @@ var StatusesApiFp = function (configuration) {
             });
         },
         /**
-         * This will update status.
+         * This will partially update a status by code with the provided fields.  **Required Permissions**  \"task-management.tasks.update\"
          * @summary Update the status
          * @param {string} code
-         * @param {UpdateStatusRequestDto} updateStatusRequestDto
+         * @param {PatchStatusRequestDto} patchStatusRequestDto
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        updateStatus: function (code, updateStatusRequestDto, authorization, options) {
+        patchStatus: function (code, patchStatusRequestDto, authorization, 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.updateStatus(code, updateStatusRequestDto, authorization, options)];
+                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.patchStatus(code, patchStatusRequestDto, authorization, options)];
                         case 1:
                             localVarAxiosArgs = _a.sent();
                             return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -496,7 +494,7 @@ var StatusesApiFactory = function (configuration, basePath, axios) {
     var localVarFp = (0, exports.StatusesApiFp)(configuration);
     return {
         /**
-         * This will create a status.
+         * This will create a status.  **Required Permissions**  \"task-management.tasks.create\"
          * @summary Create the status
          * @param {CreateStatusRequestDto} createStatusRequestDto
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -507,7 +505,7 @@ var StatusesApiFactory = function (configuration, basePath, axios) {
             return localVarFp.createStatus(createStatusRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
         },
         /**
-         * This will delete status.
+         * This will delete status.  **Required Permissions**  \"task-management.tasks.delete\"
          * @summary Delete the status
          * @param {string} code Unique identifier for the object.
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -518,24 +516,24 @@ var StatusesApiFactory = function (configuration, basePath, axios) {
             return localVarFp.deleteStatus(code, authorization, options).then(function (request) { return request(axios, basePath); });
         },
         /**
-         * Get status by code.
+         * Get status by code.  **Required Permissions**  \"task-management.tasks.view\"
          * @summary Retrieve the status
          * @param {string} code
-         * @param {string} expand
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {string} [expand] Expand to fetch additional information about the status.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getStatus: function (code, expand, authorization, options) {
-            return localVarFp.getStatus(code, expand, authorization, options).then(function (request) { return request(axios, basePath); });
+        getStatus: function (code, authorization, expand, options) {
+            return localVarFp.getStatus(code, authorization, expand, options).then(function (request) { return request(axios, basePath); });
         },
         /**
-         * Retrieves a list of statuses.
+         * Retrieves a list of statuses.  **Required Permissions**  \"task-management.tasks.view\"
          * @summary List statuses
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
-         * @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, slug, name, createdAt, updatedAt</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, slug, name, createdAt, updatedAt</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: id, code, name, slug</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, slug, name, createdAt, updatedAt</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, slug, name, createdAt, updatedAt</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, name, slug</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, name, slug</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 {*} [options] Override http request option.
@@ -545,16 +543,16 @@ var StatusesApiFactory = function (configuration, basePath, axios) {
             return localVarFp.listStatuses(authorization, filter, filters, search, order, expand, options).then(function (request) { return request(axios, basePath); });
         },
         /**
-         * This will update status.
+         * This will partially update a status by code with the provided fields.  **Required Permissions**  \"task-management.tasks.update\"
          * @summary Update the status
          * @param {string} code
-         * @param {UpdateStatusRequestDto} updateStatusRequestDto
+         * @param {PatchStatusRequestDto} patchStatusRequestDto
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        updateStatus: function (code, updateStatusRequestDto, authorization, options) {
-            return localVarFp.updateStatus(code, updateStatusRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
+        patchStatus: function (code, patchStatusRequestDto, authorization, options) {
+            return localVarFp.patchStatus(code, patchStatusRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
         },
     };
 };
@@ -571,7 +569,7 @@ var StatusesApi = /** @class */ (function (_super) {
         return _super !== null && _super.apply(this, arguments) || this;
     }
     /**
-     * This will create a status.
+     * This will create a status.  **Required Permissions**  \"task-management.tasks.create\"
      * @summary Create the status
      * @param {StatusesApiCreateStatusRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -583,7 +581,7 @@ var StatusesApi = /** @class */ (function (_super) {
         return (0, exports.StatusesApiFp)(this.configuration).createStatus(requestParameters.createStatusRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
-     * This will delete status.
+     * This will delete status.  **Required Permissions**  \"task-management.tasks.delete\"
      * @summary Delete the status
      * @param {StatusesApiDeleteStatusRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -595,7 +593,7 @@ var StatusesApi = /** @class */ (function (_super) {
         return (0, exports.StatusesApiFp)(this.configuration).deleteStatus(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
-     * Get status by code.
+     * Get status by code.  **Required Permissions**  \"task-management.tasks.view\"
      * @summary Retrieve the status
      * @param {StatusesApiGetStatusRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -604,10 +602,10 @@ var StatusesApi = /** @class */ (function (_super) {
      */
     StatusesApi.prototype.getStatus = function (requestParameters, options) {
         var _this = this;
-        return (0, exports.StatusesApiFp)(this.configuration).getStatus(requestParameters.code, requestParameters.expand, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
+        return (0, exports.StatusesApiFp)(this.configuration).getStatus(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
-     * Retrieves a list of statuses.
+     * Retrieves a list of statuses.  **Required Permissions**  \"task-management.tasks.view\"
      * @summary List statuses
      * @param {StatusesApiListStatusesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -620,16 +618,16 @@ var StatusesApi = /** @class */ (function (_super) {
         return (0, exports.StatusesApiFp)(this.configuration).listStatuses(requestParameters.authorization, requestParameters.filter, requestParameters.filters, requestParameters.search, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
-     * This will update status.
+     * This will partially update a status by code with the provided fields.  **Required Permissions**  \"task-management.tasks.update\"
      * @summary Update the status
-     * @param {StatusesApiUpdateStatusRequest} requestParameters Request parameters.
+     * @param {StatusesApiPatchStatusRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof StatusesApi
      */
-    StatusesApi.prototype.updateStatus = function (requestParameters, options) {
+    StatusesApi.prototype.patchStatus = function (requestParameters, options) {
         var _this = this;
-        return (0, exports.StatusesApiFp)(this.configuration).updateStatus(requestParameters.code, requestParameters.updateStatusRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
+        return (0, exports.StatusesApiFp)(this.configuration).patchStatus(requestParameters.code, requestParameters.patchStatusRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     return StatusesApi;
 }(base_1.BaseAPI));