@tennac-booking/sdk 1.0.13 → 1.0.14

package/docs/UsersApi.md

@@ -4,679 +4,8 @@ All URIs are relative to *https://api.mon-domaine.com*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**cancelSubscription**](#cancelsubscription) | **DELETE** /api/users/me/subscriptions/{clubId}/{subscriptionId} | Annule un abonnement utilisateur|
-|[**changePassword**](#changepassword) | **PUT** /api/users/me/password | Modifie le mot de passe de l\'utilisateur connecté|
-|[**getAllUsers**](#getallusers) | **GET** /api/users | Récupère la liste des utilisateurs avec filtres et pagination|
-|[**getUserInfo**](#getuserinfo) | **GET** /api/users/me | Récupère les informations de l\'utilisateur connecté|
-|[**getUserRolesInClubs**](#getuserrolesinclubs) | **GET** /api/users/me/roles | Récupère les rôles de l\'utilisateur dans les clubs|
-|[**getUserSubscriptions**](#getusersubscriptions) | **GET** /api/users/me/subscriptions | Récupère les abonnements de l\'utilisateur connecté|
-|[**initiateSubscriptionSession**](#initiatesubscriptionsession) | **POST** /api/users/me/subscription-session | Initie une session d\'abonnement Stripe|
-|[**login**](#login) | **POST** /api/users/login | Authentifie un utilisateur|
-|[**refreshToken**](#refreshtoken) | **POST** /api/users/refresh-token | Rafraîchit le token d\'accès|
-|[**register**](#register) | **POST** /api/users | Crée un nouvel utilisateur|
-|[**resumeSubscription**](#resumesubscription) | **POST** /api/users/me/subscriptions/{clubId}/{subscriptionId}/resume | Réactive un abonnement utilisateur|
-|[**signInOrSignUpWithGoogle**](#signinorsignupwithgoogle) | **POST** /api/users/googleSignin | Authentifie ou crée un utilisateur via Google OAuth|
 |[**subscribeToClub**](#subscribetoclub) | **POST** /api/users/me/subscribe | Abonne l\'utilisateur connecté à un club|
 |[**updateCustomer**](#updatecustomer) | **PUT** /api/users/me/customer | Met à jour le Customer Stripe de l\'utilisateur|
-|[**updateUser**](#updateuser) | **PUT** /api/users/me | Met à jour les données de l\'utilisateur connecté|
-
-# **cancelSubscription**
-> SubscriptionResponse cancelSubscription()
-
-
-### Example
-
-```typescript
-import {
-    UsersApi,
-    Configuration
-} from '@tennac-booking/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new UsersApi(configuration);
-
-let clubId: string; //ID du club (default to undefined)
-let subscriptionId: string; //ID de l\'abonnement à annuler (default to undefined)
-
-const { status, data } = await apiInstance.cancelSubscription(
-    clubId,
-    subscriptionId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **clubId** | [**string**] | ID du club | defaults to undefined|
-| **subscriptionId** | [**string**] | ID de l\'abonnement à annuler | defaults to undefined|
-
-
-### Return type
-
-**SubscriptionResponse**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Abonnement annulé |  -  |
-|**400** | Requête invalide |  -  |
-|**401** | Non autorisé |  -  |
-|**500** | Erreur serveur interne |  -  |
-
-[[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
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Mot de passe modifié |  -  |
-|**400** | Requête invalide |  -  |
-|**401** | Non autorisé |  -  |
-|**404** | Ressource non trouvée |  -  |
-|**500** | Erreur serveur interne |  -  |
-
-[[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<UserResponse> getAllUsers()
-
-
-### Example
-
-```typescript
-import {
-    UsersApi,
-    Configuration
-} from '@tennac-booking/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new UsersApi(configuration);
-
-let limit: number; //Nombre maximum d\'utilisateurs à retourner (optional) (default to 20)
-let skip: number; //Nombre d\'utilisateurs à ignorer (pagination) (optional) (default to 0)
-let search: string; //Recherche dans firstName, lastName, email (optional) (default to undefined)
-let sport: string; //Filtre par sport (optional) (default to undefined)
-let matchType: string; //Filtre par type de match (optional) (default to undefined)
-let niveau: string; //Filtre par niveau (optional) (default to undefined)
-let rank: string; //Filtre par rang (optional) (default to undefined)
-let isLookingForPartner: 'true' | 'false'; //Filtre par disponibilité pour partenaire (optional) (default to undefined)
-let username: string; //Filtre par nom d\'utilisateur (optional) (default to undefined)
-let email: string; //Filtre par email (optional) (default to undefined)
-let description: string; //Filtre par description (optional) (default to undefined)
-let gender: string; //Filtre par genre (optional) (default to undefined)
-
-const { status, data } = await apiInstance.getAllUsers(
-    limit,
-    skip,
-    search,
-    sport,
-    matchType,
-    niveau,
-    rank,
-    isLookingForPartner,
-    username,
-    email,
-    description,
-    gender
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **limit** | [**number**] | Nombre maximum d\&#39;utilisateurs à retourner | (optional) defaults to 20|
-| **skip** | [**number**] | Nombre d\&#39;utilisateurs à ignorer (pagination) | (optional) defaults to 0|
-| **search** | [**string**] | Recherche dans firstName, lastName, email | (optional) defaults to undefined|
-| **sport** | [**string**] | Filtre par sport | (optional) defaults to undefined|
-| **matchType** | [**string**] | Filtre par type de match | (optional) defaults to undefined|
-| **niveau** | [**string**] | Filtre par niveau | (optional) defaults to undefined|
-| **rank** | [**string**] | Filtre par rang | (optional) defaults to undefined|
-| **isLookingForPartner** | [**&#39;true&#39; | &#39;false&#39;**]**Array<&#39;true&#39; &#124; &#39;false&#39;>** | Filtre par disponibilité pour partenaire | (optional) defaults to undefined|
-| **username** | [**string**] | Filtre par nom d\&#39;utilisateur | (optional) defaults to undefined|
-| **email** | [**string**] | Filtre par email | (optional) defaults to undefined|
-| **description** | [**string**] | Filtre par description | (optional) defaults to undefined|
-| **gender** | [**string**] | Filtre par genre | (optional) defaults to undefined|
-
-
-### Return type
-
-**Array<UserResponse>**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Liste des utilisateurs |  -  |
-|**401** | Non autorisé |  -  |
-|**500** | Erreur serveur interne |  -  |
-
-[[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)
-
-# **getUserInfo**
-> UserResponse getUserInfo()
-
-
-### Example
-
-```typescript
-import {
-    UsersApi,
-    Configuration
-} from '@tennac-booking/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new UsersApi(configuration);
-
-const { status, data } = await apiInstance.getUserInfo();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**UserResponse**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Informations de l\&#39;utilisateur |  -  |
-|**401** | Non autorisé |  -  |
-|**404** | Ressource non trouvée |  -  |
-|**500** | Erreur serveur interne |  -  |
-
-[[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**
-> GetUserRolesResponse 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
-
-**GetUserRolesResponse**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Liste des rôles dans les clubs |  -  |
-|**400** | Requête invalide |  -  |
-|**401** | Non autorisé |  -  |
-|**500** | Erreur serveur interne |  -  |
-
-[[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**
-> GetUserSubscriptionsResponse 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
-
-**GetUserSubscriptionsResponse**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Liste des abonnements |  -  |
-|**401** | Non autorisé |  -  |
-|**500** | Erreur serveur interne |  -  |
-
-[[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**
-> InitiateSubscriptionSessionResponse initiateSubscriptionSession(initiateSubscriptionSessionRequestBody)
-
-
-### Example
-
-```typescript
-import {
-    UsersApi,
-    Configuration,
-    InitiateSubscriptionSessionRequestBody
-} from '@tennac-booking/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new UsersApi(configuration);
-
-let initiateSubscriptionSessionRequestBody: InitiateSubscriptionSessionRequestBody; //
-
-const { status, data } = await apiInstance.initiateSubscriptionSession(
-    initiateSubscriptionSessionRequestBody
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **initiateSubscriptionSessionRequestBody** | **InitiateSubscriptionSessionRequestBody**|  | |
-
-
-### Return type
-
-**InitiateSubscriptionSessionResponse**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Session d\&#39;abonnement créée |  -  |
-|**400** | Requête invalide |  -  |
-|**401** | Non autorisé |  -  |
-|**500** | Erreur serveur interne |  -  |
-
-[[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
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Authentification réussie |  -  |
-|**400** | Requête invalide |  -  |
-|**401** | Non autorisé |  -  |
-|**500** | Erreur serveur interne |  -  |
-
-[[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
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Nouveaux tokens |  -  |
-|**400** | Requête invalide |  -  |
-|**401** | Non autorisé |  -  |
-|**500** | Erreur serveur interne |  -  |
-
-[[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**
-> UserResponse 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
-
-**UserResponse**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**201** | Utilisateur créé |  -  |
-|**400** | Requête invalide |  -  |
-|**409** | Email déjà utilisé |  -  |
-|**500** | Erreur serveur interne |  -  |
-
-[[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**
-> SubscriptionResponse resumeSubscription()
-
-
-### Example
-
-```typescript
-import {
-    UsersApi,
-    Configuration
-} from '@tennac-booking/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new UsersApi(configuration);
-
-let clubId: string; //ID du club (default to undefined)
-let subscriptionId: string; //ID de l\'abonnement à réactiver (default to undefined)
-
-const { status, data } = await apiInstance.resumeSubscription(
-    clubId,
-    subscriptionId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **clubId** | [**string**] | ID du club | defaults to undefined|
-| **subscriptionId** | [**string**] | ID de l\&#39;abonnement à réactiver | defaults to undefined|
-
-
-### Return type
-
-**SubscriptionResponse**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Abonnement réactivé |  -  |
-|**400** | Requête invalide |  -  |
-|**401** | Non autorisé |  -  |
-|**500** | Erreur serveur interne |  -  |
-
-[[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**
-> GoogleSignInResponse signInOrSignUpWithGoogle(googleSignInRequestBody)
-
-
-### Example
-
-```typescript
-import {
-    UsersApi,
-    Configuration,
-    GoogleSignInRequestBody
-} from '@tennac-booking/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new UsersApi(configuration);
-
-let googleSignInRequestBody: GoogleSignInRequestBody; //
-
-const { status, data } = await apiInstance.signInOrSignUpWithGoogle(
-    googleSignInRequestBody
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **googleSignInRequestBody** | **GoogleSignInRequestBody**|  | |
-
-
-### Return type
-
-**GoogleSignInResponse**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Authentification Google réussie |  -  |
-|**400** | Requête invalide |  -  |
-|**500** | Erreur serveur interne |  -  |
-
-[[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**
 > SubscriptionResponse subscribeToClub(subscribeToClubRequestBody)
@@ -788,57 +117,3 @@ const { status, data } = await apiInstance.updateCustomer(
 
 [[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)
 
-# **updateUser**
-> UserResponse updateUser(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.updateUser(
-    updateUserRequestBody
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **updateUserRequestBody** | **UpdateUserRequestBody**|  | |
-
-
-### Return type
-
-**UserResponse**
-
-### Authorization
-
-[bearerAuth](../README.md#bearerAuth)
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Utilisateur mis à jour |  -  |
-|**400** | Requête invalide |  -  |
-|**401** | Non autorisé |  -  |
-|**500** | Erreur serveur interne |  -  |
-
-[[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)
-