@dimrev4/fitness-v3-backend 0.0.3

package/docs/AuthV1Api.md

@@ -0,0 +1,257 @@
+# AuthV1Api
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**authV1ControllerConfirmOtp**](#authv1controllerconfirmotp) | **POST** /api/auth/v1/confirm-otp | Confirm OTP|
+|[**authV1ControllerGetMe**](#authv1controllergetme) | **POST** /api/auth/v1/get-me | Get Me|
+|[**authV1ControllerLogin**](#authv1controllerlogin) | **POST** /api/auth/v1/login | Login|
+|[**authV1ControllerLogout**](#authv1controllerlogout) | **POST** /api/auth/v1/logout | Logout|
+|[**authV1ControllerRegister**](#authv1controllerregister) | **POST** /api/auth/v1/register | Register|
+
+# **authV1ControllerConfirmOtp**
+> LoginResponseDto authV1ControllerConfirmOtp(confirmOtpRequestDto)
+
+
+### Example
+
+```typescript
+import {
+    AuthV1Api,
+    Configuration,
+    ConfirmOtpRequestDto
+} from '@dimrev4/fitness-v3-backend-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AuthV1Api(configuration);
+
+let confirmOtpRequestDto: ConfirmOtpRequestDto; //
+
+const { status, data } = await apiInstance.authV1ControllerConfirmOtp(
+    confirmOtpRequestDto
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **confirmOtpRequestDto** | **ConfirmOtpRequestDto**|  | |
+
+
+### Return type
+
+**LoginResponseDto**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **authV1ControllerGetMe**
+> GetMeResponseDto authV1ControllerGetMe()
+
+
+### Example
+
+```typescript
+import {
+    AuthV1Api,
+    Configuration
+} from '@dimrev4/fitness-v3-backend-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AuthV1Api(configuration);
+
+const { status, data } = await apiInstance.authV1ControllerGetMe();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**GetMeResponseDto**
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+|**400** | Invalid JWT payload structure or validation failed |  -  |
+|**401** | JWT token is missing, expired, or invalid |  -  |
+|**500** | Internal server error during JWT validation |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **authV1ControllerLogin**
+> LoginResponseDto authV1ControllerLogin(loginRequestDto)
+
+
+### Example
+
+```typescript
+import {
+    AuthV1Api,
+    Configuration,
+    LoginRequestDto
+} from '@dimrev4/fitness-v3-backend-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AuthV1Api(configuration);
+
+let loginRequestDto: LoginRequestDto; //
+
+const { status, data } = await apiInstance.authV1ControllerLogin(
+    loginRequestDto
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **loginRequestDto** | **LoginRequestDto**|  | |
+
+
+### Return type
+
+**LoginResponseDto**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **authV1ControllerLogout**
+> LogoutResponseDto authV1ControllerLogout()
+
+
+### Example
+
+```typescript
+import {
+    AuthV1Api,
+    Configuration
+} from '@dimrev4/fitness-v3-backend-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AuthV1Api(configuration);
+
+const { status, data } = await apiInstance.authV1ControllerLogout();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**LogoutResponseDto**
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+|**400** | Invalid JWT payload structure or validation failed |  -  |
+|**401** | JWT token is missing, expired, or invalid |  -  |
+|**500** | Internal server error during JWT validation |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **authV1ControllerRegister**
+> RegisterResponseDto authV1ControllerRegister(registerRequestDto)
+
+
+### Example
+
+```typescript
+import {
+    AuthV1Api,
+    Configuration,
+    RegisterRequestDto
+} from '@dimrev4/fitness-v3-backend-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AuthV1Api(configuration);
+
+let registerRequestDto: RegisterRequestDto; //
+
+const { status, data } = await apiInstance.authV1ControllerRegister(
+    registerRequestDto
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **registerRequestDto** | **RegisterRequestDto**|  | |
+
+
+### Return type
+
+**RegisterResponseDto**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/ConfirmOtpRequestDto.md

@@ -0,0 +1,22 @@
+# ConfirmOtpRequestDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **string** | Email | [default to undefined]
+**otp** | **string** | OTP | [default to undefined]
+
+## Example
+
+```typescript
+import { ConfirmOtpRequestDto } from '@dimrev4/fitness-v3-backend-sdk';
+
+const instance: ConfirmOtpRequestDto = {
+    email,
+    otp,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CreateMeasurementRequestDto.md

@@ -0,0 +1,26 @@
+# CreateMeasurementRequestDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**weightKG** | **number** | Weight in kilograms | [default to undefined]
+**heightCM** | **number** | Height in centimeters | [default to undefined]
+**bmi** | **number** | Body Mass Index | [default to undefined]
+**date** | **string** | Measurement date | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateMeasurementRequestDto } from '@dimrev4/fitness-v3-backend-sdk';
+
+const instance: CreateMeasurementRequestDto = {
+    weightKG,
+    heightCM,
+    bmi,
+    date,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/DeleteMeasurementResponseDto.md

@@ -0,0 +1,22 @@
+# DeleteMeasurementResponseDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | Success message | [default to undefined]
+**id** | **string** | ID of the deleted measurement | [default to undefined]
+
+## Example
+
+```typescript
+import { DeleteMeasurementResponseDto } from '@dimrev4/fitness-v3-backend-sdk';
+
+const instance: DeleteMeasurementResponseDto = {
+    message,
+    id,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GetMeResponseDto.md

@@ -0,0 +1,20 @@
+# GetMeResponseDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user** | [**UserDetailsDto**](UserDetailsDto.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetMeResponseDto } from '@dimrev4/fitness-v3-backend-sdk';
+
+const instance: GetMeResponseDto = {
+    user,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GetMeasurementsResponseDto.md

@@ -0,0 +1,30 @@
+# GetMeasurementsResponseDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**MeasurementDto**](MeasurementDto.md) |  | [default to undefined]
+**totalItems** | **number** |  | [default to undefined]
+**totalPages** | **number** |  | [default to undefined]
+**currentPage** | **number** |  | [default to undefined]
+**hasNextPage** | **boolean** |  | [default to undefined]
+**hasPreviousPage** | **boolean** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetMeasurementsResponseDto } from '@dimrev4/fitness-v3-backend-sdk';
+
+const instance: GetMeasurementsResponseDto = {
+    items,
+    totalItems,
+    totalPages,
+    currentPage,
+    hasNextPage,
+    hasPreviousPage,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GroupDto.md

@@ -0,0 +1,28 @@
+# GroupDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Group ID | [default to undefined]
+**name** | **string** | Group name | [default to undefined]
+**createdAt** | **string** | Group creation date | [default to undefined]
+**updatedAt** | **string** | Group update date | [default to undefined]
+**deletedAt** | **string** | Group deletion date | [default to undefined]
+
+## Example
+
+```typescript
+import { GroupDto } from '@dimrev4/fitness-v3-backend-sdk';
+
+const instance: GroupDto = {
+    id,
+    name,
+    createdAt,
+    updatedAt,
+    deletedAt,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/LoginRequestDto.md

@@ -0,0 +1,22 @@
+# LoginRequestDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **string** | Email | [default to undefined]
+**password** | **string** | Password | [default to undefined]
+
+## Example
+
+```typescript
+import { LoginRequestDto } from '@dimrev4/fitness-v3-backend-sdk';
+
+const instance: LoginRequestDto = {
+    email,
+    password,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/LoginResponseDto.md

@@ -0,0 +1,22 @@
+# LoginResponseDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user** | [**UserDetailsDto**](UserDetailsDto.md) |  | [default to undefined]
+**accessToken** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { LoginResponseDto } from '@dimrev4/fitness-v3-backend-sdk';
+
+const instance: LoginResponseDto = {
+    user,
+    accessToken,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/LogoutResponseDto.md

@@ -0,0 +1,20 @@
+# LogoutResponseDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | Success message | [default to undefined]
+
+## Example
+
+```typescript
+import { LogoutResponseDto } from '@dimrev4/fitness-v3-backend-sdk';
+
+const instance: LogoutResponseDto = {
+    message,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/MeasurementDto.md

@@ -0,0 +1,36 @@
+# MeasurementDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Measurement ID | [default to undefined]
+**date** | **string** | Measurement take date | [default to undefined]
+**weightKG** | **number** | Weight in KG | [default to undefined]
+**heightCM** | **number** | Height in CM | [default to undefined]
+**bmi** | **number** | BMI | [default to undefined]
+**userId** | **string** | User ID | [default to undefined]
+**createdAt** | **string** | Measurement creation date | [default to undefined]
+**updatedAt** | **string** | Measurement update date | [default to undefined]
+**deletedAt** | **string** | Measurement deletion date | [default to undefined]
+
+## Example
+
+```typescript
+import { MeasurementDto } from '@dimrev4/fitness-v3-backend-sdk';
+
+const instance: MeasurementDto = {
+    id,
+    date,
+    weightKG,
+    heightCM,
+    bmi,
+    userId,
+    createdAt,
+    updatedAt,
+    deletedAt,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)