tuix-timesheets-api 0.66.0 → 0.68.0

package/.openapi-generator/FILES

@@ -12,10 +12,10 @@ models/ClientInvoiceDTO.ts
 models/CompanyDTO.ts
 models/CreateEmployeeInvoiceInputDTO.ts
 models/CreateGithubUserDTO.ts
-models/CreateJiraAccountDto.ts
-models/CreateJiraUserDto.ts
+models/CreateJiraAccountDTO.ts
+models/CreateJiraUserDTO.ts
 models/CreateTokenResponseDTO.ts
-models/CreateUserDto.ts
+models/CreateUserDTO.ts
 models/EmployeeDTO.ts
 models/EmployeeInvoiceDTO.ts
 models/EmployeeProjectDTO.ts
@@ -29,8 +29,8 @@ models/GlobalTimesheetEntryDTO.ts
 models/GlobalTimesheetEntryUpdateDTO.ts
 models/HolidayCreateDTO.ts
 models/HolidayDTO.ts
-models/JiraAccountDto.ts
-models/JiraUserDto.ts
+models/JiraAccountDTO.ts
+models/JiraUserDTO.ts
 models/MarkEmployeeInvoicePaidDTO.ts
 models/MarkInvoicePaidDTO.ts
 models/PaginatedAdjustedTimesheets.ts
@@ -50,8 +50,8 @@ models/ProjectDTO.ts
 models/ProjectInputDTO.ts
 models/ProjectUpdateDTO.ts
 models/RolePermissionsDTO.ts
-models/SlackAccountReponseDto.ts
-models/SlackUserDto.ts
+models/SlackAccountResponseDTO.ts
+models/SlackUserDTO.ts
 models/TeamUpdateDTO.ts
 models/TimesheetDTO.ts
 models/TimesheetEmployeeInfo.ts
@@ -60,7 +60,7 @@ models/TimesheetEntryUpdateDTO.ts
 models/TokenDTO.ts
 models/TokenInputDTO.ts
 models/TokenValidationErrorDTO.ts
-models/UpdateUserDto.ts
+models/UpdateUserDTO.ts
 models/UserEnrollDTO.ts
 models/index.ts
 runtime.ts

package/apis/TuixTimesheetsClientApi.js

@@ -44,11 +44,12 @@ const index_1 = require("../models/index");
  */
 class TuixTimesheetsClientApi extends runtime.BaseAPI {
     /**
+     * Add a new jira account to the current user
      * Add a new jira account to the user
      */
     async addJiraAccountRaw(requestParameters, initOverrides) {
-        if (requestParameters.createJiraAccountDto === null || requestParameters.createJiraAccountDto === undefined) {
-            throw new runtime.RequiredError('createJiraAccountDto', 'Required parameter requestParameters.createJiraAccountDto was null or undefined when calling addJiraAccount.');
+        if (requestParameters.createJiraAccountDTO === null || requestParameters.createJiraAccountDTO === undefined) {
+            throw new runtime.RequiredError('createJiraAccountDTO', 'Required parameter requestParameters.createJiraAccountDTO was null or undefined when calling addJiraAccount.');
         }
         const queryParameters = {};
         const headerParameters = {};
@@ -61,11 +62,12 @@ class TuixTimesheetsClientApi extends runtime.BaseAPI {
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
-            body: (0, index_1.CreateJiraAccountDtoToJSON)(requestParameters.createJiraAccountDto),
+            body: (0, index_1.CreateJiraAccountDTOToJSON)(requestParameters.createJiraAccountDTO),
         }, initOverrides);
-        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.JiraAccountDtoFromJSON)(jsonValue));
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.JiraAccountDTOFromJSON)(jsonValue));
     }
     /**
+     * Add a new jira account to the current user
      * Add a new jira account to the user
      */
     async addJiraAccount(requestParameters, initOverrides) {
@@ -320,11 +322,12 @@ class TuixTimesheetsClientApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
+     * Create a new user with the provided information Collaborator role required
      * Create a new user
      */
     async createJiraUserRaw(requestParameters, initOverrides) {
-        if (requestParameters.createJiraUserDto === null || requestParameters.createJiraUserDto === undefined) {
-            throw new runtime.RequiredError('createJiraUserDto', 'Required parameter requestParameters.createJiraUserDto was null or undefined when calling createJiraUser.');
+        if (requestParameters.createJiraUserDTO === null || requestParameters.createJiraUserDTO === undefined) {
+            throw new runtime.RequiredError('createJiraUserDTO', 'Required parameter requestParameters.createJiraUserDTO was null or undefined when calling createJiraUser.');
         }
         const queryParameters = {};
         const headerParameters = {};
@@ -337,11 +340,12 @@ class TuixTimesheetsClientApi extends runtime.BaseAPI {
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
-            body: (0, index_1.CreateJiraUserDtoToJSON)(requestParameters.createJiraUserDto),
+            body: (0, index_1.CreateJiraUserDTOToJSON)(requestParameters.createJiraUserDTO),
         }, initOverrides);
-        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.JiraUserDtoFromJSON)(jsonValue));
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.JiraUserDTOFromJSON)(jsonValue));
     }
     /**
+     * Create a new user with the provided information Collaborator role required
      * Create a new user
      */
     async createJiraUser(requestParameters, initOverrides) {
@@ -380,11 +384,12 @@ class TuixTimesheetsClientApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     *
+     * Create a new Slack user account
+     * Create Slack user
      */
     async createSlackUserRaw(requestParameters, initOverrides) {
-        if (requestParameters.createUserDto === null || requestParameters.createUserDto === undefined) {
-            throw new runtime.RequiredError('createUserDto', 'Required parameter requestParameters.createUserDto was null or undefined when calling createSlackUser.');
+        if (requestParameters.createUserDTO === null || requestParameters.createUserDTO === undefined) {
+            throw new runtime.RequiredError('createUserDTO', 'Required parameter requestParameters.createUserDTO was null or undefined when calling createSlackUser.');
         }
         const queryParameters = {};
         const headerParameters = {};
@@ -397,12 +402,13 @@ class TuixTimesheetsClientApi extends runtime.BaseAPI {
             method: 'POST',
             headers: headerParameters,
             query: queryParameters,
-            body: (0, index_1.CreateUserDtoToJSON)(requestParameters.createUserDto),
+            body: (0, index_1.CreateUserDTOToJSON)(requestParameters.createUserDTO),
         }, initOverrides);
-        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.SlackAccountReponseDtoFromJSON)(jsonValue));
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.SlackAccountResponseDTOFromJSON)(jsonValue));
     }
     /**
-     *
+     * Create a new Slack user account
+     * Create Slack user
      */
     async createSlackUser(requestParameters, initOverrides) {
         const response = await this.createSlackUserRaw(requestParameters, initOverrides);
@@ -636,7 +642,8 @@ class TuixTimesheetsClientApi extends runtime.BaseAPI {
         await this.deleteProjectRaw(requestParameters, initOverrides);
     }
     /**
-     *
+     * Delete the authenticated user\'s Slack account
+     * Delete Slack user
      */
     async deleteSlackUserRaw(initOverrides) {
         const queryParameters = {};
@@ -653,7 +660,8 @@ class TuixTimesheetsClientApi extends runtime.BaseAPI {
         return new runtime.VoidApiResponse(response);
     }
     /**
-     *
+     * Delete the authenticated user\'s Slack account
+     * Delete Slack user
      */
     async deleteSlackUser(initOverrides) {
         await this.deleteSlackUserRaw(initOverrides);
@@ -1452,6 +1460,7 @@ class TuixTimesheetsClientApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
+     * Get all jira accounts for the current user
      * Get jira accounts
      */
     async getJiraAccountsRaw(initOverrides) {
@@ -1466,9 +1475,10 @@ class TuixTimesheetsClientApi extends runtime.BaseAPI {
             headers: headerParameters,
             query: queryParameters,
         }, initOverrides);
-        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.JiraAccountDtoFromJSON));
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.JiraAccountDTOFromJSON));
     }
     /**
+     * Get all jira accounts for the current user
      * Get jira accounts
      */
     async getJiraAccounts(initOverrides) {
@@ -1476,7 +1486,8 @@ class TuixTimesheetsClientApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * Get user
+     * Get current user information
+     * Get current user
      */
     async getJiraUserRaw(initOverrides) {
         const queryParameters = {};
@@ -1490,10 +1501,11 @@ class TuixTimesheetsClientApi extends runtime.BaseAPI {
             headers: headerParameters,
             query: queryParameters,
         }, initOverrides);
-        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.JiraUserDtoFromJSON)(jsonValue));
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.JiraUserDTOFromJSON)(jsonValue));
     }
     /**
-     * Get user
+     * Get current user information
+     * Get current user
      */
     async getJiraUser(initOverrides) {
         const response = await this.getJiraUserRaw(initOverrides);
@@ -1666,7 +1678,8 @@ class TuixTimesheetsClientApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     *
+     * Get the Slack account for the authenticated user
+     * Get Slack account
      */
     async getSlackAccountRaw(initOverrides) {
         const queryParameters = {};
@@ -1680,10 +1693,11 @@ class TuixTimesheetsClientApi extends runtime.BaseAPI {
             headers: headerParameters,
             query: queryParameters,
         }, initOverrides);
-        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.SlackAccountReponseDtoFromJSON)(jsonValue));
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.SlackAccountResponseDTOFromJSON)(jsonValue));
     }
     /**
-     *
+     * Get the Slack account for the authenticated user
+     * Get Slack account
      */
     async getSlackAccount(initOverrides) {
         const response = await this.getSlackAccountRaw(initOverrides);
@@ -1885,9 +1899,10 @@ class TuixTimesheetsClientApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     *
+     * Handle incoming Slack action from interactive components
+     * Handle Slack action
      */
-    async handleActionRaw(initOverrides) {
+    async handleSlackActionRaw(initOverrides) {
         const queryParameters = {};
         const headerParameters = {};
         const response = await this.request({
@@ -1899,10 +1914,11 @@ class TuixTimesheetsClientApi extends runtime.BaseAPI {
         return new runtime.VoidApiResponse(response);
     }
     /**
-     *
+     * Handle incoming Slack action from interactive components
+     * Handle Slack action
      */
-    async handleAction(initOverrides) {
-        await this.handleActionRaw(initOverrides);
+    async handleSlackAction(initOverrides) {
+        await this.handleSlackActionRaw(initOverrides);
     }
     /**
      * Invite an employee to a company
@@ -2039,6 +2055,7 @@ class TuixTimesheetsClientApi extends runtime.BaseAPI {
         await this.openSentTimesheetRaw(requestParameters, initOverrides);
     }
     /**
+     * Remove specific jira account for the current user
      * Remove jira account
      */
     async removeJiraAccountRaw(requestParameters, initOverrides) {
@@ -2059,6 +2076,7 @@ class TuixTimesheetsClientApi extends runtime.BaseAPI {
         return new runtime.VoidApiResponse(response);
     }
     /**
+     * Remove specific jira account for the current user
      * Remove jira account
      */
     async removeJiraAccount(requestParameters, initOverrides) {
@@ -2310,14 +2328,15 @@ class TuixTimesheetsClientApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     *
+     * Update user settings
+     * Update Slack user
      */
-    async updateSlackbotUserRaw(requestParameters, initOverrides) {
+    async updateSlackUserRaw(requestParameters, initOverrides) {
         if (requestParameters.userId === null || requestParameters.userId === undefined) {
-            throw new runtime.RequiredError('userId', 'Required parameter requestParameters.userId was null or undefined when calling updateSlackbotUser.');
+            throw new runtime.RequiredError('userId', 'Required parameter requestParameters.userId was null or undefined when calling updateSlackUser.');
         }
-        if (requestParameters.updateUserDto === null || requestParameters.updateUserDto === undefined) {
-            throw new runtime.RequiredError('updateUserDto', 'Required parameter requestParameters.updateUserDto was null or undefined when calling updateSlackbotUser.');
+        if (requestParameters.updateUserDTO === null || requestParameters.updateUserDTO === undefined) {
+            throw new runtime.RequiredError('updateUserDTO', 'Required parameter requestParameters.updateUserDTO was null or undefined when calling updateSlackUser.');
         }
         const queryParameters = {};
         const headerParameters = {};
@@ -2330,15 +2349,16 @@ class TuixTimesheetsClientApi extends runtime.BaseAPI {
             method: 'PATCH',
             headers: headerParameters,
             query: queryParameters,
-            body: (0, index_1.UpdateUserDtoToJSON)(requestParameters.updateUserDto),
+            body: (0, index_1.UpdateUserDTOToJSON)(requestParameters.updateUserDTO),
         }, initOverrides);
-        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.SlackUserDtoFromJSON)(jsonValue));
+        return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.SlackUserDTOFromJSON)(jsonValue));
     }
     /**
-     *
+     * Update user settings
+     * Update Slack user
      */
-    async updateSlackbotUser(requestParameters, initOverrides) {
-        const response = await this.updateSlackbotUserRaw(requestParameters, initOverrides);
+    async updateSlackUser(requestParameters, initOverrides) {
+        const response = await this.updateSlackUserRaw(requestParameters, initOverrides);
         return await response.value();
     }
     /**