tuix-projects-service-client 0.0.37 → 0.0.39

package/docs/ClientApi.md

@@ -18,6 +18,7 @@ All URIs are relative to *http://localhost:3000*
 | [**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 |
+| [**createToken**](ClientApi.md#createtoken) | **POST** /pats | Create a new API token with role-based permissions |
 | [**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 |
@@ -26,6 +27,7 @@ All URIs are relative to *http://localhost:3000*
 | [**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 |
+| [**deleteToken**](ClientApi.md#deletetoken) | **DELETE** /pats/{tokenId} | Delete an API token by ID |
 | [**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 |
@@ -60,6 +62,9 @@ All URIs are relative to *http://localhost:3000*
 | [**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. |
+| [**getToken**](ClientApi.md#gettoken) | **GET** /pats/{tokenId} | Get a specific API token by ID |
+| [**getUserPermissions**](ClientApi.md#getuserpermissions) | **GET** /permissions | Get all available permissions for current user based on their role |
+| [**getUserTokens**](ClientApi.md#getusertokens) | **GET** /pats | Get all API tokens for current user with pagination |
 | [**inviteEmployee**](ClientApi.md#inviteemployee) | **POST** /employees/invite | Invite an employee to a company |
 | [**markEmployeeInvoiceAsPaid**](ClientApi.md#markemployeeinvoiceaspaid) | **POST** /employees/{userId}/invoices/{employeeInvoiceId}/mark-paid | Mark an employee invoice as paid |
 | [**markInvoiceAsPaid**](ClientApi.md#markinvoiceaspaid) | **POST** /clients/{clientId}/invoices/{invoiceId}/mark-paid | Mark a client invoice as paid with the specified date and time |
@@ -1167,6 +1172,82 @@ 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)
 
 
+## createToken
+
+> CreateTokenResponseDTO createToken(tokenInputDTO)
+
+Create a new API token with role-based permissions
+
+Create a new API token
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClientApi,
+} from '';
+import type { CreateTokenRequest } 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 = {
+    // TokenInputDTO | Token creation data
+    tokenInputDTO: ...,
+  } satisfies CreateTokenRequest;
+
+  try {
+    const data = await api.createToken(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **tokenInputDTO** | [TokenInputDTO](TokenInputDTO.md) | Token creation data | |
+
+### Return type
+
+[**CreateTokenResponseDTO**](CreateTokenResponseDTO.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** | Return the created token (only shown once) |  -  |
+| **400** | Return detailed validation error if permissions are not allowed for the role |  -  |
+| **401** | Return an error if the user is not authenticated |  -  |
+| **403** | Return an error if the user does not have the required permissions |  -  |
+| **409** | Return an error if the token name already exists |  -  |
+| **500** | Return an error if the server encounters 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)
@@ -1764,6 +1845,82 @@ This endpoint does not need any parameter.
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## deleteToken
+
+> deleteToken(tokenId)
+
+Delete an API token by ID
+
+Delete token
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClientApi,
+} from '';
+import type { DeleteTokenRequest } 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 = {
+    // string | Token ID
+    tokenId: tokenId_example,
+  } satisfies DeleteTokenRequest;
+
+  try {
+    const data = await api.deleteToken(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **tokenId** | `string` | Token ID | [Defaults to `undefined`] |
+
+### 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** | Token deleted successfully |  -  |
+| **400** | Return an error if provided ID is not a valid UUID |  -  |
+| **401** | Return an error if the user is not authenticated |  -  |
+| **403** | Return an error if the user does not have the required permissions |  -  |
+| **404** | Return an error if the token is not found |  -  |
+| **500** | Return an error if the server encounters 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)
@@ -4459,6 +4616,225 @@ 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)
 
 
+## getToken
+
+> TokenDTO getToken(tokenId)
+
+Get a specific API token by ID
+
+Get token by ID
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClientApi,
+} from '';
+import type { GetTokenRequest } 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 = {
+    // string | Token ID
+    tokenId: tokenId_example,
+  } satisfies GetTokenRequest;
+
+  try {
+    const data = await api.getToken(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **tokenId** | `string` | Token ID | [Defaults to `undefined`] |
+
+### Return type
+
+[**TokenDTO**](TokenDTO.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** | Return the token details |  -  |
+| **400** | Return an error if provided ID is not a valid UUID |  -  |
+| **401** | Return an error if the user is not authenticated |  -  |
+| **403** | Return an error if the user does not have the required permissions |  -  |
+| **404** | Return an error if the token is not found |  -  |
+| **500** | Return an error if the server encounters 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)
+
+
+## getUserPermissions
+
+> RolePermissionsDTO getUserPermissions()
+
+Get all available permissions for current user based on their role
+
+Get permissions for current user
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClientApi,
+} from '';
+import type { GetUserPermissionsRequest } 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.getUserPermissions();
+    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
+
+[**RolePermissionsDTO**](RolePermissionsDTO.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** | Return user permissions |  -  |
+| **401** | Return an error if the user is not authenticated |  -  |
+| **500** | Return an error if the server encounters 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)
+
+
+## getUserTokens
+
+> PaginatedTokens getUserTokens(page, pageSize)
+
+Get all API tokens for current user with pagination
+
+Get all tokens for current user with pagination
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClientApi,
+} from '';
+import type { GetUserTokensRequest } 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 = {
+    // number | Page number (default: 1) (optional)
+    page: 56,
+    // number | Page size (default: 10) (optional)
+    pageSize: 56,
+  } satisfies GetUserTokensRequest;
+
+  try {
+    const data = await api.getUserTokens(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **page** | `number` | Page number (default: 1) | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` | Page size (default: 10) | [Optional] [Defaults to `10`] |
+
+### Return type
+
+[**PaginatedTokens**](PaginatedTokens.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** | Return paginated list of user tokens |  -  |
+| **400** | Return an error if pagination parameters are invalid |  -  |
+| **401** | Return an error if the user is not authenticated |  -  |
+| **403** | Return an error if the user does not have the required permissions |  -  |
+| **500** | Return an error if the server encounters 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)
+
+
 ## inviteEmployee
 
 > EmployeeDTO inviteEmployee(employeeDTO)

package/docs/CreateTokenResponseDTO.md

@@ -0,0 +1,46 @@
+
+# CreateTokenResponseDTO
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`createdAt` | string
+`expiresAt` | string
+`permissions` | [Array<PermissionDTO>](PermissionDTO.md)
+`role` | string
+`token` | string
+`tokenId` | string
+`tokenName` | string
+
+## Example
+
+```typescript
+import type { CreateTokenResponseDTO } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "createdAt": null,
+  "expiresAt": null,
+  "permissions": null,
+  "role": null,
+  "token": null,
+  "tokenId": null,
+  "tokenName": null,
+} satisfies CreateTokenResponseDTO
+
+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 CreateTokenResponseDTO
+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/PaginatedTokens.md

@@ -0,0 +1,42 @@
+
+# PaginatedTokens
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`items` | [Array<TokenDTO>](TokenDTO.md)
+`page` | number
+`pageSize` | number
+`totalItems` | number
+`totalPages` | number
+
+## Example
+
+```typescript
+import type { PaginatedTokens } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "items": null,
+  "page": null,
+  "pageSize": null,
+  "totalItems": null,
+  "totalPages": null,
+} satisfies PaginatedTokens
+
+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 PaginatedTokens
+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/PermissionDTO.md

@@ -0,0 +1,40 @@
+
+# PermissionDTO
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`category` | string
+`description` | string
+`id` | string
+`name` | string
+
+## Example
+
+```typescript
+import type { PermissionDTO } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "category": null,
+  "description": null,
+  "id": null,
+  "name": null,
+} satisfies PermissionDTO
+
+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 PermissionDTO
+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/RolePermissionsDTO.md

@@ -0,0 +1,36 @@
+
+# RolePermissionsDTO
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`permissions` | [Array<PermissionDTO>](PermissionDTO.md)
+`role` | string
+
+## Example
+
+```typescript
+import type { RolePermissionsDTO } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "permissions": null,
+  "role": null,
+} satisfies RolePermissionsDTO
+
+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 RolePermissionsDTO
+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/TokenDTO.md

@@ -0,0 +1,46 @@
+
+# TokenDTO
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`createdAt` | string
+`expiresAt` | string
+`id` | string
+`name` | string
+`permissions` | [Array<PermissionDTO>](PermissionDTO.md)
+`role` | string
+`updatedAt` | string
+
+## Example
+
+```typescript
+import type { TokenDTO } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "createdAt": null,
+  "expiresAt": null,
+  "id": null,
+  "name": null,
+  "permissions": null,
+  "role": null,
+  "updatedAt": null,
+} satisfies TokenDTO
+
+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 TokenDTO
+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/TokenInputDTO.md

@@ -0,0 +1,38 @@
+
+# TokenInputDTO
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`expiresAt` | string
+`permissionIds` | Array<string>
+`tokenName` | string
+
+## Example
+
+```typescript
+import type { TokenInputDTO } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "expiresAt": null,
+  "permissionIds": null,
+  "tokenName": null,
+} satisfies TokenInputDTO
+
+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 TokenInputDTO
+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/TokenValidationErrorDTO.md

@@ -0,0 +1,42 @@
+
+# TokenValidationErrorDTO
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`availablePermissions` | [Array<PermissionDTO>](PermissionDTO.md)
+`invalidPermissions` | Array<string>
+`message` | string
+`role` | string
+`validPermissions` | [Array<PermissionDTO>](PermissionDTO.md)
+
+## Example
+
+```typescript
+import type { TokenValidationErrorDTO } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "availablePermissions": null,
+  "invalidPermissions": null,
+  "message": null,
+  "role": null,
+  "validPermissions": null,
+} satisfies TokenValidationErrorDTO
+
+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 TokenValidationErrorDTO
+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)
+
+