@dimrev4/fitness-v3-backend 0.0.3

package/docs/MeasurementsV1Api.md

@@ -0,0 +1,414 @@
+# MeasurementsV1Api
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**measurementsV1ControllerCreateMeasurement**](#measurementsv1controllercreatemeasurement) | **POST** /api/measurements/v1 | Create a new measurement for the authenticated user|
+|[**measurementsV1ControllerDeleteMeasurement**](#measurementsv1controllerdeletemeasurement) | **DELETE** /api/measurements/v1/{measurementId} | Soft delete a specific measurement for the authenticated user|
+|[**measurementsV1ControllerGetAllByUserId**](#measurementsv1controllergetallbyuserid) | **GET** /api/measurements/v1 | Get all measurements for the authenticated user|
+|[**measurementsV1ControllerGetAllByUserIdAdmin**](#measurementsv1controllergetallbyuseridadmin) | **GET** /api/measurements/v1/group/{groupId} | Get all measurements for the group|
+|[**measurementsV1ControllerGetMeasurementByGroupIdAndMeasurementId**](#measurementsv1controllergetmeasurementbygroupidandmeasurementid) | **GET** /api/measurements/v1/group/{groupId}/{measurementId} | Get a measurement by group and measurement ID|
+|[**measurementsV1ControllerGetMeasurementById**](#measurementsv1controllergetmeasurementbyid) | **GET** /api/measurements/v1/{measurementId} | Get a specific measurement by ID for the authenticated user|
+|[**measurementsV1ControllerUpdateMeasurement**](#measurementsv1controllerupdatemeasurement) | **PATCH** /api/measurements/v1/{measurementId} | Update a specific measurement for the authenticated user|
+
+# **measurementsV1ControllerCreateMeasurement**
+> MeasurementDto measurementsV1ControllerCreateMeasurement(createMeasurementRequestDto)
+
+
+### Example
+
+```typescript
+import {
+    MeasurementsV1Api,
+    Configuration,
+    CreateMeasurementRequestDto
+} from '@dimrev4/fitness-v3-backend-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new MeasurementsV1Api(configuration);
+
+let createMeasurementRequestDto: CreateMeasurementRequestDto; //
+
+const { status, data } = await apiInstance.measurementsV1ControllerCreateMeasurement(
+    createMeasurementRequestDto
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createMeasurementRequestDto** | **CreateMeasurementRequestDto**|  | |
+
+
+### Return type
+
+**MeasurementDto**
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** |  |  -  |
+|**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)
+
+# **measurementsV1ControllerDeleteMeasurement**
+> DeleteMeasurementResponseDto measurementsV1ControllerDeleteMeasurement()
+
+
+### Example
+
+```typescript
+import {
+    MeasurementsV1Api,
+    Configuration
+} from '@dimrev4/fitness-v3-backend-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new MeasurementsV1Api(configuration);
+
+let measurementId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.measurementsV1ControllerDeleteMeasurement(
+    measurementId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **measurementId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**DeleteMeasurementResponseDto**
+
+### 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)
+
+# **measurementsV1ControllerGetAllByUserId**
+> GetMeasurementsResponseDto measurementsV1ControllerGetAllByUserId()
+
+
+### Example
+
+```typescript
+import {
+    MeasurementsV1Api,
+    Configuration
+} from '@dimrev4/fitness-v3-backend-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new MeasurementsV1Api(configuration);
+
+let limit: number; //Limit (optional) (default to undefined)
+let offset: number; //Offset (optional) (default to undefined)
+let fromDate: string; //From date (optional) (default to undefined)
+let toDate: string; //To date (optional) (default to undefined)
+
+const { status, data } = await apiInstance.measurementsV1ControllerGetAllByUserId(
+    limit,
+    offset,
+    fromDate,
+    toDate
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **limit** | [**number**] | Limit | (optional) defaults to undefined|
+| **offset** | [**number**] | Offset | (optional) defaults to undefined|
+| **fromDate** | [**string**] | From date | (optional) defaults to undefined|
+| **toDate** | [**string**] | To date | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetMeasurementsResponseDto**
+
+### 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)
+
+# **measurementsV1ControllerGetAllByUserIdAdmin**
+> GetMeasurementsResponseDto measurementsV1ControllerGetAllByUserIdAdmin()
+
+
+### Example
+
+```typescript
+import {
+    MeasurementsV1Api,
+    Configuration
+} from '@dimrev4/fitness-v3-backend-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new MeasurementsV1Api(configuration);
+
+let groupId: string; // (default to undefined)
+let limit: number; //Limit (optional) (default to undefined)
+let offset: number; //Offset (optional) (default to undefined)
+let fromDate: string; //From date (optional) (default to undefined)
+let toDate: string; //To date (optional) (default to undefined)
+
+const { status, data } = await apiInstance.measurementsV1ControllerGetAllByUserIdAdmin(
+    groupId,
+    limit,
+    offset,
+    fromDate,
+    toDate
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **groupId** | [**string**] |  | defaults to undefined|
+| **limit** | [**number**] | Limit | (optional) defaults to undefined|
+| **offset** | [**number**] | Offset | (optional) defaults to undefined|
+| **fromDate** | [**string**] | From date | (optional) defaults to undefined|
+| **toDate** | [**string**] | To date | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetMeasurementsResponseDto**
+
+### 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)
+
+# **measurementsV1ControllerGetMeasurementByGroupIdAndMeasurementId**
+> MeasurementDto measurementsV1ControllerGetMeasurementByGroupIdAndMeasurementId()
+
+
+### Example
+
+```typescript
+import {
+    MeasurementsV1Api,
+    Configuration
+} from '@dimrev4/fitness-v3-backend-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new MeasurementsV1Api(configuration);
+
+let groupId: string; // (default to undefined)
+let measurementId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.measurementsV1ControllerGetMeasurementByGroupIdAndMeasurementId(
+    groupId,
+    measurementId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **groupId** | [**string**] |  | defaults to undefined|
+| **measurementId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**MeasurementDto**
+
+### 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)
+
+# **measurementsV1ControllerGetMeasurementById**
+> MeasurementDto measurementsV1ControllerGetMeasurementById()
+
+
+### Example
+
+```typescript
+import {
+    MeasurementsV1Api,
+    Configuration
+} from '@dimrev4/fitness-v3-backend-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new MeasurementsV1Api(configuration);
+
+let measurementId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.measurementsV1ControllerGetMeasurementById(
+    measurementId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **measurementId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**MeasurementDto**
+
+### 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)
+
+# **measurementsV1ControllerUpdateMeasurement**
+> MeasurementDto measurementsV1ControllerUpdateMeasurement(updateMeasurementRequestDto)
+
+
+### Example
+
+```typescript
+import {
+    MeasurementsV1Api,
+    Configuration,
+    UpdateMeasurementRequestDto
+} from '@dimrev4/fitness-v3-backend-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new MeasurementsV1Api(configuration);
+
+let measurementId: string; // (default to undefined)
+let updateMeasurementRequestDto: UpdateMeasurementRequestDto; //
+
+const { status, data } = await apiInstance.measurementsV1ControllerUpdateMeasurement(
+    measurementId,
+    updateMeasurementRequestDto
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateMeasurementRequestDto** | **UpdateMeasurementRequestDto**|  | |
+| **measurementId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**MeasurementDto**
+
+### Authorization
+
+[bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **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)
+

package/docs/RegisterRequestDto.md

@@ -0,0 +1,24 @@
+# RegisterRequestDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **string** | Email | [default to undefined]
+**username** | **string** | Username | [default to undefined]
+**password** | **string** | Password | [default to undefined]
+
+## Example
+
+```typescript
+import { RegisterRequestDto } from '@dimrev4/fitness-v3-backend-sdk';
+
+const instance: RegisterRequestDto = {
+    email,
+    username,
+    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/RegisterResponseDto.md

@@ -0,0 +1,20 @@
+# RegisterResponseDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | Message | [default to undefined]
+
+## Example
+
+```typescript
+import { RegisterResponseDto } from '@dimrev4/fitness-v3-backend-sdk';
+
+const instance: RegisterResponseDto = {
+    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/UpdateMeasurementRequestDto.md

@@ -0,0 +1,24 @@
+# UpdateMeasurementRequestDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**weightKG** | **number** | Weight in kilograms | [optional] [default to undefined]
+**heightCM** | **number** | Height in centimeters | [optional] [default to undefined]
+**bmi** | **number** | Body Mass Index | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateMeasurementRequestDto } from '@dimrev4/fitness-v3-backend-sdk';
+
+const instance: UpdateMeasurementRequestDto = {
+    weightKG,
+    heightCM,
+    bmi,
+};
+```
+
+[[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/UserDetailsDto.md

@@ -0,0 +1,32 @@
+# UserDetailsDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | User ID | [default to undefined]
+**username** | **string** | Username | [default to undefined]
+**email** | **string** | User email | [default to undefined]
+**createdAt** | **string** | User creation date | [default to undefined]
+**updatedAt** | **string** | User update date | [default to undefined]
+**deletedAt** | **string** | User deletion date | [default to undefined]
+**userToGroup** | [**Array<UserToGroupDetailsDto>**](UserToGroupDetailsDto.md) | User to Group relations | [default to undefined]
+
+## Example
+
+```typescript
+import { UserDetailsDto } from '@dimrev4/fitness-v3-backend-sdk';
+
+const instance: UserDetailsDto = {
+    id,
+    username,
+    email,
+    createdAt,
+    updatedAt,
+    deletedAt,
+    userToGroup,
+};
+```
+
+[[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/UserDto.md

@@ -0,0 +1,30 @@
+# UserDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | User ID | [default to undefined]
+**username** | **string** | Username | [default to undefined]
+**email** | **string** | User email | [default to undefined]
+**createdAt** | **string** | User creation date | [default to undefined]
+**updatedAt** | **string** | User update date | [default to undefined]
+**deletedAt** | **object** | User deletion date | [default to undefined]
+
+## Example
+
+```typescript
+import { UserDto } from '@dimrev4/fitness-v3-backend-sdk';
+
+const instance: UserDto = {
+    id,
+    username,
+    email,
+    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/UserToGroupDetailsDto.md

@@ -0,0 +1,42 @@
+# UserToGroupDetailsDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**groupId** | **string** | Group ID | [default to undefined]
+**userId** | **string** | User ID | [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]
+**canCreate** | **boolean** | Can create | [default to undefined]
+**canRead** | **boolean** | Can read | [default to undefined]
+**canUpdate** | **boolean** | Can update | [default to undefined]
+**canDelete** | **boolean** | Can delete | [default to undefined]
+**group** | [**GroupDto**](GroupDto.md) | Group | [default to undefined]
+**user** | [**UserDto**](UserDto.md) | User | [default to undefined]
+**isRoot** | **boolean** | Is Root | [default to undefined]
+
+## Example
+
+```typescript
+import { UserToGroupDetailsDto } from '@dimrev4/fitness-v3-backend-sdk';
+
+const instance: UserToGroupDetailsDto = {
+    groupId,
+    userId,
+    createdAt,
+    updatedAt,
+    deletedAt,
+    canCreate,
+    canRead,
+    canUpdate,
+    canDelete,
+    group,
+    user,
+    isRoot,
+};
+```
+
+[[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/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'

package/index.ts

@@ -0,0 +1,18 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Fitness Backend
+ * Fitness Backend API
+ *
+ * The version of the OpenAPI document: 0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+export * from "./api";
+export * from "./configuration";
+