@tennac-booking/sdk 1.0.37 → 1.0.40

package/docs/UsersApi.md

@@ -0,0 +1,1888 @@
+# UsersApi
+
+All URIs are relative to */api*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**addFavoriteClub**](#addfavoriteclub) | **POST** /users/me/favorite-clubs | |
+|[**addFavoritePlayer**](#addfavoriteplayer) | **POST** /users/me/favoritesPlayers | |
+|[**addPaymentMethodSetup**](#addpaymentmethodsetup) | **POST** /users/addPaymentMethodSetup | |
+|[**cancelSubscription**](#cancelsubscription) | **DELETE** /users/me/subscriptions/{clubId}/{subscriptionId} | |
+|[**changePassword**](#changepassword) | **PUT** /users/me/password | |
+|[**confirmPaymentMethodSetup**](#confirmpaymentmethodsetup) | **POST** /users/confirmPaymentMethodSetup | |
+|[**getAllUsers**](#getallusers) | **GET** /users | |
+|[**getBookingDetail**](#getbookingdetail) | **GET** /users/me/booking-detail/{bookingId} | |
+|[**getFavoriteClubs**](#getfavoriteclubs) | **GET** /users/me/favorite-clubs | |
+|[**getFavoritesPlayers**](#getfavoritesplayers) | **GET** /users/me/favoritesPlayers | |
+|[**getFrequentlyPlayedWith**](#getfrequentlyplayedwith) | **GET** /users/me/frequentlyPlayedWith | |
+|[**getFrequentlyVisitedClub**](#getfrequentlyvisitedclub) | **GET** /users/me/frequentlyVisitedClub | |
+|[**getMe**](#getme) | **GET** /users/me | |
+|[**getNearestClubs**](#getnearestclubs) | **GET** /users/me/nearest-clubs | |
+|[**getNearestClubsFromCoordinates**](#getnearestclubsfromcoordinates) | **GET** /users/nearest-clubs/coordinates | |
+|[**getNearestUsers**](#getnearestusers) | **GET** /users/me/nearest-players | |
+|[**getNearestUsersFromCoordinates**](#getnearestusersfromcoordinates) | **GET** /users/nearest-players/coordinates | |
+|[**getUserBookings**](#getuserbookings) | **GET** /users/me/bookings | |
+|[**getUserProfileById**](#getuserprofilebyid) | **GET** /users/profile/{id} | |
+|[**getUserProfileStaff**](#getuserprofilestaff) | **GET** /users/staff/profile/{id} | |
+|[**getUserRolesInClubs**](#getuserrolesinclubs) | **GET** /users/me/roles | |
+|[**getUserSubscriptions**](#getusersubscriptions) | **GET** /users/me/subscriptions | |
+|[**initiateSubscriptionSession**](#initiatesubscriptionsession) | **POST** /users/me/subscription-session | |
+|[**login**](#login) | **POST** /users/login | |
+|[**refreshToken**](#refreshtoken) | **POST** /users/refresh-token | |
+|[**register**](#register) | **POST** /users | |
+|[**removeFavoriteClub**](#removefavoriteclub) | **DELETE** /users/me/favorite-clubs/{clubId} | |
+|[**removeFavoritePlayer**](#removefavoriteplayer) | **DELETE** /users/me/favoritesPlayers/{favoritePlayerId} | |
+|[**requestPasswordReset**](#requestpasswordreset) | **POST** /users/me/request-password-rest | |
+|[**resumeSubscription**](#resumesubscription) | **POST** /users/me/subscriptions/{clubId}/{subscriptionId}/resume | |
+|[**setupPaymentMethod**](#setuppaymentmethod) | **POST** /users/setupPaymentMethod | |
+|[**signInOrSignUpWithGoogle**](#signinorsignupwithgoogle) | **POST** /users/googleSignin | |
+|[**subscribeToClub**](#subscribetoclub) | **POST** /users/me/subscribe | |
+|[**updateCustomer**](#updatecustomer) | **PUT** /users/me/customer | |
+|[**updateLevelBySports**](#updatelevelbysports) | **PUT** /users/me/level-by-sports | |
+|[**updateMe**](#updateme) | **PUT** /users/me | |
+|[**updateProfilePicture**](#updateprofilepicture) | **PUT** /users/me/profile-picture | |
+
+# **addFavoriteClub**
+> FavoriteClubMutationResponse addFavoriteClub(favoriteClubRequestBody)
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration,
+    FavoriteClubRequestBody
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let favoriteClubRequestBody: FavoriteClubRequestBody; //
+
+const { status, data } = await apiInstance.addFavoriteClub(
+    favoriteClubRequestBody
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **favoriteClubRequestBody** | **FavoriteClubRequestBody**|  | |
+
+
+### Return type
+
+**FavoriteClubMutationResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Ok |  -  |
+
+[[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)
+
+# **addFavoritePlayer**
+> FavoritePlayerMutationResponse addFavoritePlayer(favoritePlayerRequestBody)
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration,
+    FavoritePlayerRequestBody
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let favoritePlayerRequestBody: FavoritePlayerRequestBody; //
+
+const { status, data } = await apiInstance.addFavoritePlayer(
+    favoritePlayerRequestBody
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **favoritePlayerRequestBody** | **FavoritePlayerRequestBody**|  | |
+
+
+### Return type
+
+**FavoritePlayerMutationResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Ok |  -  |
+
+[[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)
+
+# **addPaymentMethodSetup**
+> PaymentMethodSetupResponse addPaymentMethodSetup(addPaymentMethodRequestBody)
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration,
+    AddPaymentMethodRequestBody
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let addPaymentMethodRequestBody: AddPaymentMethodRequestBody; //
+
+const { status, data } = await apiInstance.addPaymentMethodSetup(
+    addPaymentMethodRequestBody
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **addPaymentMethodRequestBody** | **AddPaymentMethodRequestBody**|  | |
+
+
+### Return type
+
+**PaymentMethodSetupResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Ok |  -  |
+
+[[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)
+
+# **cancelSubscription**
+> SubscriptionMutationResponse cancelSubscription()
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let clubId: string; // (default to undefined)
+let subscriptionId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.cancelSubscription(
+    clubId,
+    subscriptionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **clubId** | [**string**] |  | defaults to undefined|
+| **subscriptionId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**SubscriptionMutationResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Ok |  -  |
+
+[[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)
+
+# **changePassword**
+> ChangePasswordResponse changePassword(changePasswordRequestBody)
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration,
+    ChangePasswordRequestBody
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let changePasswordRequestBody: ChangePasswordRequestBody; //
+
+const { status, data } = await apiInstance.changePassword(
+    changePasswordRequestBody
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **changePasswordRequestBody** | **ChangePasswordRequestBody**|  | |
+
+
+### Return type
+
+**ChangePasswordResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Ok |  -  |
+
+[[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)
+
+# **confirmPaymentMethodSetup**
+> ConfirmPaymentMethodResponse confirmPaymentMethodSetup(confirmPaymentMethodRequestBody)
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration,
+    ConfirmPaymentMethodRequestBody
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let confirmPaymentMethodRequestBody: ConfirmPaymentMethodRequestBody; //
+
+const { status, data } = await apiInstance.confirmPaymentMethodSetup(
+    confirmPaymentMethodRequestBody
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **confirmPaymentMethodRequestBody** | **ConfirmPaymentMethodRequestBody**|  | |
+
+
+### Return type
+
+**ConfirmPaymentMethodResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Ok |  -  |
+
+[[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)
+
+# **getAllUsers**
+> Array<BaseUser> getAllUsers()
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+const { status, data } = await apiInstance.getAllUsers();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<BaseUser>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Ok |  -  |
+
+[[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)
+
+# **getBookingDetail**
+> BookingDetailResponse getBookingDetail()
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let bookingId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getBookingDetail(
+    bookingId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **bookingId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**BookingDetailResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Ok |  -  |
+
+[[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)
+
+# **getFavoriteClubs**
+> FavoriteClubsResponse getFavoriteClubs()
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+const { status, data } = await apiInstance.getFavoriteClubs();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**FavoriteClubsResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Ok |  -  |
+
+[[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)
+
+# **getFavoritesPlayers**
+> FavoritePlayersResponse getFavoritesPlayers()
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+const { status, data } = await apiInstance.getFavoritesPlayers();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**FavoritePlayersResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Ok |  -  |
+
+[[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)
+
+# **getFrequentlyPlayedWith**
+> Array<FrequentPlayer> getFrequentlyPlayedWith()
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+const { status, data } = await apiInstance.getFrequentlyPlayedWith();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<FrequentPlayer>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Ok |  -  |
+
+[[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)
+
+# **getFrequentlyVisitedClub**
+> Array<FrequentClub> getFrequentlyVisitedClub()
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+const { status, data } = await apiInstance.getFrequentlyVisitedClub();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<FrequentClub>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Ok |  -  |
+
+[[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)
+
+# **getMe**
+> UserProfileResponse getMe()
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+const { status, data } = await apiInstance.getMe();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**UserProfileResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Ok |  -  |
+
+[[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)
+
+# **getNearestClubs**
+> Array<{ [key: string]: any; }> getNearestClubs()
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let radiusInKm: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getNearestClubs(
+    radiusInKm,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **radiusInKm** | [**number**] |  | (optional) defaults to undefined|
+| **limit** | [**number**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<{ [key: string]: any; }>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Ok |  -  |
+
+[[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)
+
+# **getNearestClubsFromCoordinates**
+> Array<{ [key: string]: any; }> getNearestClubsFromCoordinates()
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let latitude: number; // (optional) (default to undefined)
+let longitude: number; // (optional) (default to undefined)
+let radiusInKm: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getNearestClubsFromCoordinates(
+    latitude,
+    longitude,
+    radiusInKm,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **latitude** | [**number**] |  | (optional) defaults to undefined|
+| **longitude** | [**number**] |  | (optional) defaults to undefined|
+| **radiusInKm** | [**number**] |  | (optional) defaults to undefined|
+| **limit** | [**number**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<{ [key: string]: any; }>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Ok |  -  |
+
+[[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)
+
+# **getNearestUsers**
+> Array<{ [key: string]: any; }> getNearestUsers()
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let radiusInKm: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getNearestUsers(
+    radiusInKm,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **radiusInKm** | [**number**] |  | (optional) defaults to undefined|
+| **limit** | [**number**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<{ [key: string]: any; }>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Ok |  -  |
+
+[[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)
+
+# **getNearestUsersFromCoordinates**
+> Array<{ [key: string]: any; }> getNearestUsersFromCoordinates()
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let latitude: number; // (optional) (default to undefined)
+let longitude: number; // (optional) (default to undefined)
+let radiusInKm: number; // (optional) (default to undefined)
+let limit: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getNearestUsersFromCoordinates(
+    latitude,
+    longitude,
+    radiusInKm,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **latitude** | [**number**] |  | (optional) defaults to undefined|
+| **longitude** | [**number**] |  | (optional) defaults to undefined|
+| **radiusInKm** | [**number**] |  | (optional) defaults to undefined|
+| **limit** | [**number**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<{ [key: string]: any; }>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Ok |  -  |
+
+[[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)
+
+# **getUserBookings**
+> Array<BookingSummary> getUserBookings()
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let limit: number; // (optional) (default to undefined)
+let skip: number; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getUserBookings(
+    limit,
+    skip
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **limit** | [**number**] |  | (optional) defaults to undefined|
+| **skip** | [**number**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**Array<BookingSummary>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Ok |  -  |
+
+[[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)
+
+# **getUserProfileById**
+> BaseUser getUserProfileById()
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getUserProfileById(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**BaseUser**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Ok |  -  |
+
+[[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)
+
+# **getUserProfileStaff**
+> StaffUserProfileResponse getUserProfileStaff()
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getUserProfileStaff(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**StaffUserProfileResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Ok |  -  |
+
+[[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)
+
+# **getUserRolesInClubs**
+> UserRolesResponse getUserRolesInClubs()
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+const { status, data } = await apiInstance.getUserRolesInClubs();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**UserRolesResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Ok |  -  |
+
+[[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)
+
+# **getUserSubscriptions**
+> UserSubscriptionsResponse getUserSubscriptions()
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+const { status, data } = await apiInstance.getUserSubscriptions();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**UserSubscriptionsResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Ok |  -  |
+
+[[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)
+
+# **initiateSubscriptionSession**
+> SubscriptionSessionResponse initiateSubscriptionSession(subscriptionSessionRequestBody)
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration,
+    SubscriptionSessionRequestBody
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let subscriptionSessionRequestBody: SubscriptionSessionRequestBody; //
+
+const { status, data } = await apiInstance.initiateSubscriptionSession(
+    subscriptionSessionRequestBody
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **subscriptionSessionRequestBody** | **SubscriptionSessionRequestBody**|  | |
+
+
+### Return type
+
+**SubscriptionSessionResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Ok |  -  |
+
+[[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)
+
+# **login**
+> LoginResponse login(loginRequestBody)
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration,
+    LoginRequestBody
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let loginRequestBody: LoginRequestBody; //
+
+const { status, data } = await apiInstance.login(
+    loginRequestBody
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **loginRequestBody** | **LoginRequestBody**|  | |
+
+
+### Return type
+
+**LoginResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Ok |  -  |
+
+[[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)
+
+# **refreshToken**
+> RefreshTokenResponse refreshToken(refreshTokenRequestBody)
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration,
+    RefreshTokenRequestBody
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let refreshTokenRequestBody: RefreshTokenRequestBody; //
+
+const { status, data } = await apiInstance.refreshToken(
+    refreshTokenRequestBody
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **refreshTokenRequestBody** | **RefreshTokenRequestBody**|  | |
+
+
+### Return type
+
+**RefreshTokenResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Ok |  -  |
+
+[[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)
+
+# **register**
+> BaseUser register(registerRequestBody)
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration,
+    RegisterRequestBody
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let registerRequestBody: RegisterRequestBody; //
+
+const { status, data } = await apiInstance.register(
+    registerRequestBody
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **registerRequestBody** | **RegisterRequestBody**|  | |
+
+
+### Return type
+
+**BaseUser**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Created |  -  |
+
+[[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)
+
+# **removeFavoriteClub**
+> FavoriteClubMutationResponse removeFavoriteClub()
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let clubId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.removeFavoriteClub(
+    clubId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **clubId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**FavoriteClubMutationResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Ok |  -  |
+
+[[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)
+
+# **removeFavoritePlayer**
+> FavoritePlayerMutationResponse removeFavoritePlayer()
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let favoritePlayerId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.removeFavoritePlayer(
+    favoritePlayerId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **favoritePlayerId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**FavoritePlayerMutationResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Ok |  -  |
+
+[[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)
+
+# **requestPasswordReset**
+> requestPasswordReset(passwordResetRequestBody)
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration,
+    PasswordResetRequestBody
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let passwordResetRequestBody: PasswordResetRequestBody; //
+
+const { status, data } = await apiInstance.requestPasswordReset(
+    passwordResetRequestBody
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passwordResetRequestBody** | **PasswordResetRequestBody**|  | |
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**501** | Not Implemented |  -  |
+
+[[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)
+
+# **resumeSubscription**
+> SubscriptionMutationResponse resumeSubscription()
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let clubId: string; // (default to undefined)
+let subscriptionId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.resumeSubscription(
+    clubId,
+    subscriptionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **clubId** | [**string**] |  | defaults to undefined|
+| **subscriptionId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**SubscriptionMutationResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Ok |  -  |
+
+[[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)
+
+# **setupPaymentMethod**
+> SetupPaymentMethodResponse setupPaymentMethod(setupPaymentMethodRequestBody)
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration,
+    SetupPaymentMethodRequestBody
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let setupPaymentMethodRequestBody: SetupPaymentMethodRequestBody; //
+
+const { status, data } = await apiInstance.setupPaymentMethod(
+    setupPaymentMethodRequestBody
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **setupPaymentMethodRequestBody** | **SetupPaymentMethodRequestBody**|  | |
+
+
+### Return type
+
+**SetupPaymentMethodResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Ok |  -  |
+
+[[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)
+
+# **signInOrSignUpWithGoogle**
+> GoogleAuthResponse signInOrSignUpWithGoogle(googleAuthRequestBody)
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration,
+    GoogleAuthRequestBody
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let googleAuthRequestBody: GoogleAuthRequestBody; //
+
+const { status, data } = await apiInstance.signInOrSignUpWithGoogle(
+    googleAuthRequestBody
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **googleAuthRequestBody** | **GoogleAuthRequestBody**|  | |
+
+
+### Return type
+
+**GoogleAuthResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Ok |  -  |
+
+[[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)
+
+# **subscribeToClub**
+> { [key: string]: any; } subscribeToClub(subscribeToClubRequestBody)
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration,
+    SubscribeToClubRequestBody
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let subscribeToClubRequestBody: SubscribeToClubRequestBody; //
+
+const { status, data } = await apiInstance.subscribeToClub(
+    subscribeToClubRequestBody
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **subscribeToClubRequestBody** | **SubscribeToClubRequestBody**|  | |
+
+
+### Return type
+
+**{ [key: string]: any; }**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Created |  -  |
+
+[[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)
+
+# **updateCustomer**
+> UpdateCustomerResponse updateCustomer(updateCustomerRequestBody)
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration,
+    UpdateCustomerRequestBody
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let updateCustomerRequestBody: UpdateCustomerRequestBody; //
+
+const { status, data } = await apiInstance.updateCustomer(
+    updateCustomerRequestBody
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateCustomerRequestBody** | **UpdateCustomerRequestBody**|  | |
+
+
+### Return type
+
+**UpdateCustomerResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Ok |  -  |
+
+[[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)
+
+# **updateLevelBySports**
+> BaseUser updateLevelBySports(updateLevelBySportsRequestBody)
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration,
+    UpdateLevelBySportsRequestBody
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let updateLevelBySportsRequestBody: UpdateLevelBySportsRequestBody; //
+
+const { status, data } = await apiInstance.updateLevelBySports(
+    updateLevelBySportsRequestBody
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateLevelBySportsRequestBody** | **UpdateLevelBySportsRequestBody**|  | |
+
+
+### Return type
+
+**BaseUser**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Ok |  -  |
+
+[[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)
+
+# **updateMe**
+> UserProfileResponse updateMe(updateUserRequestBody)
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration,
+    UpdateUserRequestBody
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let updateUserRequestBody: UpdateUserRequestBody; //
+
+const { status, data } = await apiInstance.updateMe(
+    updateUserRequestBody
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateUserRequestBody** | **UpdateUserRequestBody**|  | |
+
+
+### Return type
+
+**UserProfileResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Ok |  -  |
+
+[[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)
+
+# **updateProfilePicture**
+> ProfilePictureResponse updateProfilePicture(profilePictureUpdateRequestBody)
+
+
+### Example
+
+```typescript
+import {
+    UsersApi,
+    Configuration,
+    ProfilePictureUpdateRequestBody
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UsersApi(configuration);
+
+let profilePictureUpdateRequestBody: ProfilePictureUpdateRequestBody; //
+
+const { status, data } = await apiInstance.updateProfilePicture(
+    profilePictureUpdateRequestBody
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **profilePictureUpdateRequestBody** | **ProfilePictureUpdateRequestBody**|  | |
+
+
+### Return type
+
+**ProfilePictureResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Ok |  -  |
+
+[[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)
+