tuix-projects-service-client 0.0.21 → 0.0.22

package/apis/ClientApi.ts

@@ -58,6 +58,21 @@ import {
     ClientJiraUserDTOFromJSON,
     ClientJiraUserDTOToJSON,
 } from '../models/ClientJiraUserDTO';
+import {
+    type ClientSlackUserAccountDTO,
+    ClientSlackUserAccountDTOFromJSON,
+    ClientSlackUserAccountDTOToJSON,
+} from '../models/ClientSlackUserAccountDTO';
+import {
+    type ClientSlackUserDTO,
+    ClientSlackUserDTOFromJSON,
+    ClientSlackUserDTOToJSON,
+} from '../models/ClientSlackUserDTO';
+import {
+    type ClientUpdateSlackUserDTO,
+    ClientUpdateSlackUserDTOFromJSON,
+    ClientUpdateSlackUserDTOToJSON,
+} from '../models/ClientUpdateSlackUserDTO';
 import {
     type CompanyDTO,
     CompanyDTOFromJSON,
@@ -83,6 +98,11 @@ import {
     CreateJiraUserRequestDTOFromJSON,
     CreateJiraUserRequestDTOToJSON,
 } from '../models/CreateJiraUserRequestDTO';
+import {
+    type CreateSlackUserRequestDTO,
+    CreateSlackUserRequestDTOFromJSON,
+    CreateSlackUserRequestDTOToJSON,
+} from '../models/CreateSlackUserRequestDTO';
 import {
     type EmployeeDTO,
     EmployeeDTOFromJSON,
@@ -284,6 +304,10 @@ export interface CreateProjectRequest {
     projectInputDTO: ProjectInputDTO;
 }
 
+export interface CreateSlackUserRequest {
+    createSlackUserRequestDTO: CreateSlackUserRequestDTO;
+}
+
 export interface DeleteClientRequest {
     clientId: string;
 }
@@ -538,6 +562,10 @@ export interface UpdateProjectRequest {
     projectUpdateDTO: ProjectUpdateDTO;
 }
 
+export interface UpdateSlackUserRequest {
+    clientUpdateSlackUserDTO: ClientUpdateSlackUserDTO;
+}
+
 export interface UpdateTeamRequest {
     projectId: string;
     teamUpdateDTO: TeamUpdateDTO;
@@ -1233,6 +1261,59 @@ export class ClientApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for createSlackUser without sending the request
+     */
+    async createSlackUserRequestOpts(requestParameters: CreateSlackUserRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['createSlackUserRequestDTO'] == null) {
+            throw new runtime.RequiredError(
+                'createSlackUserRequestDTO',
+                'Required parameter "createSlackUserRequestDTO" was null or undefined when calling createSlackUser().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth0JWT authentication
+        }
+
+
+        let urlPath = `/slackbot-users`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CreateSlackUserRequestDTOToJSON(requestParameters['createSlackUserRequestDTO']),
+        };
+    }
+
+    /**
+     * Create a new Slack user account for the authenticated user
+     * Create Slack user
+     */
+    async createSlackUserRaw(requestParameters: CreateSlackUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClientSlackUserAccountDTO>> {
+        const requestOptions = await this.createSlackUserRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ClientSlackUserAccountDTOFromJSON(jsonValue));
+    }
+
+    /**
+     * Create a new Slack user account for the authenticated user
+     * Create Slack user
+     */
+    async createSlackUser(requestParameters: CreateSlackUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClientSlackUserAccountDTO> {
+        const response = await this.createSlackUserRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for deleteClient without sending the request
      */
@@ -1583,6 +1664,48 @@ export class ClientApi extends runtime.BaseAPI {
         await this.deleteProjectRaw(requestParameters, initOverrides);
     }
 
+    /**
+     * Creates request options for deleteSlackUser without sending the request
+     */
+    async deleteSlackUserRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth0JWT authentication
+        }
+
+
+        let urlPath = `/slackbot-users`;
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Delete the authenticated user\'s Slack account
+     * Delete Slack user
+     */
+    async deleteSlackUserRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deleteSlackUserRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Delete the authenticated user\'s Slack account
+     * Delete Slack user
+     */
+    async deleteSlackUser(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteSlackUserRaw(initOverrides);
+    }
+
     /**
      * Creates request options for downloadAdjustedTimesheetPdf without sending the request
      */
@@ -3294,6 +3417,49 @@ export class ClientApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for getSlackUserAccount without sending the request
+     */
+    async getSlackUserAccountRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth0JWT authentication
+        }
+
+
+        let urlPath = `/slackbot-users`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get Slack account information for the authenticated user
+     * Get Slack user account
+     */
+    async getSlackUserAccountRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClientSlackUserAccountDTO>> {
+        const requestOptions = await this.getSlackUserAccountRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ClientSlackUserAccountDTOFromJSON(jsonValue));
+    }
+
+    /**
+     * Get Slack account information for the authenticated user
+     * Get Slack user account
+     */
+    async getSlackUserAccount(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClientSlackUserAccountDTO> {
+        const response = await this.getSlackUserAccountRaw(initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for getTeam without sending the request
      */
@@ -4230,6 +4396,59 @@ export class ClientApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for updateSlackUser without sending the request
+     */
+    async updateSlackUserRequestOpts(requestParameters: UpdateSlackUserRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['clientUpdateSlackUserDTO'] == null) {
+            throw new runtime.RequiredError(
+                'clientUpdateSlackUserDTO',
+                'Required parameter "clientUpdateSlackUserDTO" was null or undefined when calling updateSlackUser().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["Authorization"] = await this.configuration.apiKey("Authorization"); // auth0JWT authentication
+        }
+
+
+        let urlPath = `/slackbot-users`;
+
+        return {
+            path: urlPath,
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ClientUpdateSlackUserDTOToJSON(requestParameters['clientUpdateSlackUserDTO']),
+        };
+    }
+
+    /**
+     * Update Slack user settings for the authenticated user
+     * Update Slack user
+     */
+    async updateSlackUserRaw(requestParameters: UpdateSlackUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClientSlackUserDTO>> {
+        const requestOptions = await this.updateSlackUserRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ClientSlackUserDTOFromJSON(jsonValue));
+    }
+
+    /**
+     * Update Slack user settings for the authenticated user
+     * Update Slack user
+     */
+    async updateSlackUser(requestParameters: UpdateSlackUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClientSlackUserDTO> {
+        const response = await this.updateSlackUserRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for updateTeam without sending the request
      */

package/docs/ClientApi.md

@@ -16,6 +16,7 @@ All URIs are relative to *http://localhost:3000*
 | [**createHoliday**](ClientApi.md#createholiday) | **POST** /holidays |  |
 | [**createJiraUser**](ClientApi.md#createjirauser) | **POST** /jira-users | Create Jira user |
 | [**createProject**](ClientApi.md#createproject) | **POST** /projects | Creates a new project |
+| [**createSlackUser**](ClientApi.md#createslackuser) | **POST** /slackbot-users | Create Slack user |
 | [**deleteClient**](ClientApi.md#deleteclient) | **DELETE** /clients/{clientId} | Delete client |
 | [**deleteCompany**](ClientApi.md#deletecompany) | **DELETE** /companies/{companyId} | Delete a company |
 | [**deleteEmployee**](ClientApi.md#deleteemployee) | **DELETE** /employees/{userId} | Delete an employee |
@@ -23,6 +24,7 @@ All URIs are relative to *http://localhost:3000*
 | [**deleteGithubUser**](ClientApi.md#deletegithubuser) | **DELETE** /github-users | Delete GitHub user |
 | [**deleteHoliday**](ClientApi.md#deleteholiday) | **DELETE** /holidays/{holidayId} | Delete a holiday |
 | [**deleteProject**](ClientApi.md#deleteproject) | **DELETE** /projects/{projectId} | Delete a project |
+| [**deleteSlackUser**](ClientApi.md#deleteslackuser) | **DELETE** /slackbot-users | Delete Slack user |
 | [**downloadAdjustedTimesheetPdf**](ClientApi.md#downloadadjustedtimesheetpdf) | **GET** /projects/{projectId}/adjusted-timesheets/{timesheetId}/download | Download an AdjustedTimesheet report in PDF format |
 | [**downloadClientInvoicePdf**](ClientApi.md#downloadclientinvoicepdf) | **GET** /clients/{clientId}/invoices/{invoiceId}/download | Download client invoice pdf |
 | [**downloadEmployeeInvoicePdf**](ClientApi.md#downloademployeeinvoicepdf) | **GET** /employees/{userId}/invoices/{employeeInvoiceId}/download | Download the employee invoice report in PDF format |
@@ -53,6 +55,7 @@ All URIs are relative to *http://localhost:3000*
 | [**getProjectReportByUser**](ClientApi.md#getprojectreportbyuser) | **GET** /api/project-reports | Get all projects an employee has access to |
 | [**getProjects**](ClientApi.md#getprojects) | **GET** /projects | Get all projects a user or employee has access to |
 | [**getProjectsAsEmployee**](ClientApi.md#getprojectsasemployee) | **GET** /employee-projects | Get all projects an employee has access to |
+| [**getSlackUserAccount**](ClientApi.md#getslackuseraccount) | **GET** /slackbot-users | Get Slack user account |
 | [**getTeam**](ClientApi.md#getteam) | **GET** /projects/{projectId}/team | Get all users in a project |
 | [**getTimesheet**](ClientApi.md#gettimesheet) | **GET** /projects/{projectId}/timesheets/{timesheetId} | Get a timesheet |
 | [**getTimesheets**](ClientApi.md#gettimesheets) | **GET** /projects/{projectId}/timesheets | Get all timesheets in a project without timesheet entries. |
@@ -68,6 +71,7 @@ All URIs are relative to *http://localhost:3000*
 | [**updateEmployeeData**](ClientApi.md#updateemployeedata) | **PATCH** /employees/{userId} | Update an employee |
 | [**updateGlobalTimesheetEntry**](ClientApi.md#updateglobaltimesheetentry) | **PATCH** /projects/{projectId}/global-timesheets/{timesheetId}/entries/{entryId} | Update a global timesheet entry |
 | [**updateProject**](ClientApi.md#updateproject) | **PATCH** /projects/{projectId} | Update a project by ID |
+| [**updateSlackUser**](ClientApi.md#updateslackuser) | **PATCH** /slackbot-users | Update Slack user |
 | [**updateTeam**](ClientApi.md#updateteam) | **PATCH** /projects/{projectId}/team | Update a project team |
 | [**updateTimesheetEntry**](ClientApi.md#updatetimesheetentry) | **PATCH** /projects/{projectId}/timesheets/{timesheetId}/entries/{entryId} | Update a timesheet entry |
 
@@ -1011,6 +1015,79 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## createSlackUser
+
+> ClientSlackUserAccountDTO createSlackUser(createSlackUserRequestDTO)
+
+Create Slack user
+
+Create a new Slack user account for the authenticated user
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClientApi,
+} from '';
+import type { CreateSlackUserRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: auth0JWT
+    apiKey: "YOUR API KEY",
+  });
+  const api = new ClientApi(config);
+
+  const body = {
+    // CreateSlackUserRequestDTO | User data
+    createSlackUserRequestDTO: ...,
+  } satisfies CreateSlackUserRequest;
+
+  try {
+    const data = await api.createSlackUser(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createSlackUserRequestDTO** | [CreateSlackUserRequestDTO](CreateSlackUserRequestDTO.md) | User data | |
+
+### Return type
+
+[**ClientSlackUserAccountDTO**](ClientSlackUserAccountDTO.md)
+
+### Authorization
+
+[auth0JWT](../README.md#auth0JWT)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Created |  -  |
+| **400** | Return an error if user ID format is invalid or request body is invalid |  -  |
+| **500** | Return an error if the server finds an error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## deleteClient
 
 > deleteClient(clientId)
@@ -1542,6 +1619,72 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## deleteSlackUser
+
+> deleteSlackUser()
+
+Delete Slack user
+
+Delete the authenticated user\'s Slack account
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClientApi,
+} from '';
+import type { DeleteSlackUserRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: auth0JWT
+    apiKey: "YOUR API KEY",
+  });
+  const api = new ClientApi(config);
+
+  try {
+    const data = await api.deleteSlackUser();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[auth0JWT](../README.md#auth0JWT)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | No Content |  -  |
+| **400** | Return an error if user ID format is invalid |  -  |
+| **404** | Return an error if the user is not found |  -  |
+| **500** | Return an error if the server finds an error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## downloadAdjustedTimesheetPdf
 
 > string downloadAdjustedTimesheetPdf(projectId, timesheetId)
@@ -3919,6 +4062,72 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## getSlackUserAccount
+
+> ClientSlackUserAccountDTO getSlackUserAccount()
+
+Get Slack user account
+
+Get Slack account information for the authenticated user
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClientApi,
+} from '';
+import type { GetSlackUserAccountRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: auth0JWT
+    apiKey: "YOUR API KEY",
+  });
+  const api = new ClientApi(config);
+
+  try {
+    const data = await api.getSlackUserAccount();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ClientSlackUserAccountDTO**](ClientSlackUserAccountDTO.md)
+
+### Authorization
+
+[auth0JWT](../README.md#auth0JWT)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **400** | Return an error if user ID format is invalid |  -  |
+| **404** | Return an error if Slack account is not found |  -  |
+| **500** | Return an error if the server finds an error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## getTeam
 
 > PaginatedUsers getTeam(projectId, page, pageSize, search)
@@ -5138,6 +5347,80 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## updateSlackUser
+
+> ClientSlackUserDTO updateSlackUser(clientUpdateSlackUserDTO)
+
+Update Slack user
+
+Update Slack user settings for the authenticated user
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClientApi,
+} from '';
+import type { UpdateSlackUserRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: auth0JWT
+    apiKey: "YOUR API KEY",
+  });
+  const api = new ClientApi(config);
+
+  const body = {
+    // ClientUpdateSlackUserDTO | User update data
+    clientUpdateSlackUserDTO: ...,
+  } satisfies UpdateSlackUserRequest;
+
+  try {
+    const data = await api.updateSlackUser(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **clientUpdateSlackUserDTO** | [ClientUpdateSlackUserDTO](ClientUpdateSlackUserDTO.md) | User update data | |
+
+### Return type
+
+[**ClientSlackUserDTO**](ClientSlackUserDTO.md)
+
+### Authorization
+
+[auth0JWT](../README.md#auth0JWT)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **400** | Return an error if user ID format is invalid or request body is invalid |  -  |
+| **404** | Return an error if the user is not found |  -  |
+| **500** | Return an error if the server finds an error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## updateTeam
 
 > updateTeam(projectId, teamUpdateDTO)

package/docs/ClientSlackAccountResponseDTO.md

@@ -0,0 +1,34 @@
+
+# ClientSlackAccountResponseDTO
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`slackAccountId` | string
+
+## Example
+
+```typescript
+import type { ClientSlackAccountResponseDTO } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "slackAccountId": null,
+} satisfies ClientSlackAccountResponseDTO
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ClientSlackAccountResponseDTO
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ClientSlackUserAccountDTO.md

@@ -0,0 +1,36 @@
+
+# ClientSlackUserAccountDTO
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`slackAccount` | [ClientSlackAccountResponseDTO](ClientSlackAccountResponseDTO.md)
+
+## Example
+
+```typescript
+import type { ClientSlackUserAccountDTO } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "slackAccount": null,
+} satisfies ClientSlackUserAccountDTO
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ClientSlackUserAccountDTO
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+