@tennac-booking/sdk/docs/ClientApi.md

OpenAPI client for @tennac-booking/sdk

# ClientApi

All URIs are relative to *http://localhost*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**acceptClientTerms**](#acceptclientterms) | **POST** /api/clients/accept-terms | |
|[**clientRegister**](#clientregister) | **POST** /api/clients/register | |
|[**getClientInvoices**](#getclientinvoices) | **GET** /api/clients/invoices | |
|[**getClientSubscriptions**](#getclientsubscriptions) | **GET** /api/clients/subscriptions | |
|[**getCurrentClientTerms**](#getcurrentclientterms) | **GET** /api/clients/terms | |
|[**getManagedClubs**](#getmanagedclubs) | **GET** /api/clients/managed-clubs | |
|[**getOnboardingStatus**](#getonboardingstatus) | **GET** /api/clients/onboarding-status | |
|[**onboardClub**](#onboardclub) | **POST** /api/clients/onboarding | |

# **acceptClientTerms**
> AcceptTermsResponse acceptClientTerms(acceptTermsRequestBody)

Accepte les CGU (Conditions Générales d\'Utilisation) pour le compte client Cette action est nécessaire pour continuer le processus d\'onboarding

### Example

```typescript
import {
    ClientApi,
    Configuration,
    AcceptTermsRequestBody
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new ClientApi(configuration);

let acceptTermsRequestBody: AcceptTermsRequestBody; //

const { status, data } = await apiInstance.acceptClientTerms(
    acceptTermsRequestBody
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **acceptTermsRequestBody** | **AcceptTermsRequestBody**|  | |


### Return type

**AcceptTermsResponse**

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | CGU acceptées avec succès |  -  |
|**401** | Non authentifié |  -  |
|**404** | Compte client ou version CGU introuvable |  -  |
|**500** | Erreur serveur |  -  |

[[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)

# **clientRegister**
> ClientRegister201Response clientRegister(clientRegisterRequest)

Enregistre un nouvel utilisateur client - Crée l\'utilisateur avec un Stripe Customer

### Example

```typescript
import {
    ClientApi,
    Configuration,
    ClientRegisterRequest
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new ClientApi(configuration);

let clientRegisterRequest: ClientRegisterRequest; //

const { status, data } = await apiInstance.clientRegister(
    clientRegisterRequest
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **clientRegisterRequest** | **ClientRegisterRequest**|  | |


### Return type

**ClientRegister201Response**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**201** | Client enregistré avec succès |  -  |
|**400** | Données invalides |  -  |
|**500** | Erreur serveur |  -  |

[[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)

# **getClientInvoices**
> ClientInvoicesResponse getClientInvoices()

Récupère toutes les factures (invoices) des clubs gérés par le client Retourne les factures avec leurs liens de paiement Stripe

### Example

```typescript
import {
    ClientApi,
    Configuration
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new ClientApi(configuration);

const { status, data } = await apiInstance.getClientInvoices();
```

### Parameters
This endpoint does not have any parameters.


### Return type

**ClientInvoicesResponse**

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Factures récupérées avec succès |  -  |
|**401** | Non authentifié |  -  |
|**500** | Erreur serveur |  -  |

[[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)

# **getClientSubscriptions**
> ClientSubscriptionsResponse getClientSubscriptions()

Récupère les abonnements Stripe actifs du compte client de l\'utilisateur courant

### Example

```typescript
import {
    ClientApi,
    Configuration
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new ClientApi(configuration);

const { status, data } = await apiInstance.getClientSubscriptions();
```

### Parameters
This endpoint does not have any parameters.


### Return type

**ClientSubscriptionsResponse**

### Authorization

[clientAuth](../README.md#clientAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Abonnements récupérés |  -  |
|**401** | Non authentifié |  -  |
|**404** | Compte client introuvable |  -  |

[[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)

# **getCurrentClientTerms**
> TermsAndConditionsResponse getCurrentClientTerms()

Récupère la version actuelle des CGU (Conditions Générales d\'Utilisation) pour les clients

### Example

```typescript
import {
    ClientApi,
    Configuration
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new ClientApi(configuration);

let language: string; // (optional) (default to undefined)

const { status, data } = await apiInstance.getCurrentClientTerms(
    language
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **language** | [**string**] |  | (optional) defaults to undefined|


### Return type

**TermsAndConditionsResponse**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | CGU récupérées avec succès |  -  |
|**404** | Aucune version des CGU disponible |  -  |
|**500** | Erreur serveur |  -  |

[[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)

# **getManagedClubs**
> ManagedClubsResponse getManagedClubs()

Récupère la liste des clubs gérés par l\'utilisateur authentifié

### Example

```typescript
import {
    ClientApi,
    Configuration
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new ClientApi(configuration);

const { status, data } = await apiInstance.getManagedClubs();
```

### Parameters
This endpoint does not have any parameters.


### Return type

**ManagedClubsResponse**

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Clubs récupérés avec succès |  -  |
|**401** | Non authentifié |  -  |
|**500** | Erreur serveur |  -  |

[[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)

# **getOnboardingStatus**
> OnboardingStatusResponse getOnboardingStatus()

Récupère le statut d\'onboarding du compte client de l\'utilisateur authentifié Retourne l\'étape actuelle, la progression et les clubs nécessitant une action

### Example

```typescript
import {
    ClientApi,
    Configuration
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new ClientApi(configuration);

const { status, data } = await apiInstance.getOnboardingStatus();
```

### Parameters
This endpoint does not have any parameters.


### Return type

**OnboardingStatusResponse**

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Statut d\'onboarding récupéré |  -  |
|**401** | Non authentifié |  -  |
|**404** | Compte client introuvable |  -  |
|**500** | Erreur serveur |  -  |

[[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)

# **onboardClub**
> ClientFullOnboardingResponse onboardClub(clientOnboardingRequestBody)

Enregistre un nouveau club pour la plateforme  - Crée un compte Stripe Connect Express - Crée le club dans la base de données - Assigne l\'utilisateur comme manager du club - Crée les paramètres par défaut du club - Envoie le lien d\'onboarding Stripe par email

### Example

```typescript
import {
    ClientApi,
    Configuration,
    ClientOnboardingRequestBody
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new ClientApi(configuration);

let clientOnboardingRequestBody: ClientOnboardingRequestBody; //Les données du club à créer

const { status, data } = await apiInstance.onboardClub(
    clientOnboardingRequestBody
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **clientOnboardingRequestBody** | **ClientOnboardingRequestBody**| Les données du club à créer | |


### Return type

**ClientFullOnboardingResponse**

### Authorization

[clientAuth](../README.md#clientAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**201** | Club créé avec succès |  -  |
|**400** | Données invalides |  -  |
|**500** | Erreur serveur |  -  |

[[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)