@tennac-booking/sdk 1.0.11 → 1.0.13

package/docs/ClubSubscriptionsApi.md

@@ -0,0 +1,408 @@
+# ClubSubscriptionsApi
+
+All URIs are relative to *https://api.mon-domaine.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**archivePriceForSubscriptionPlan**](#archivepriceforsubscriptionplan) | **DELETE** /api/clubs/{id}/subscription-plans/{priceId}/archive-price | Archiver un prix|
+|[**createPriceForSubscriptionPlan**](#createpriceforsubscriptionplan) | **POST** /api/clubs/{id}/subscription-plans/{productId}/prices | Créer un nouveau prix pour un plan|
+|[**createSubscriptionPlanForClub**](#createsubscriptionplanforclub) | **POST** /api/clubs/{id}/subscription-plans | Créer un plan d\'abonnement pour un club|
+|[**deleteSubscriptionPlanForClub**](#deletesubscriptionplanforclub) | **DELETE** /api/clubs/{id}/subscription-plans/{productId} | Supprimer un plan d\'abonnement pour un club|
+|[**restoreSubscriptionPlanForClub**](#restoresubscriptionplanforclub) | **POST** /api/clubs/{id}/subscription-plans/{productId}/restore | Réactiver un plan d\'abonnement|
+|[**restoreSubscriptionPriceForClub**](#restoresubscriptionpriceforclub) | **POST** /api/clubs/{id}/subscription-plans/{priceId}/restore-price | Réactiver un prix|
+|[**updateSubscriptionPlanForClub**](#updatesubscriptionplanforclub) | **PUT** /api/clubs/{id}/subscription-plans/{priceId} | Mettre à jour un plan d\'abonnement|
+
+# **archivePriceForSubscriptionPlan**
+> PriceResponse archivePriceForSubscriptionPlan()
+
+
+### Example
+
+```typescript
+import {
+    ClubSubscriptionsApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubSubscriptionsApi(configuration);
+
+let id: string; //ID du club (default to undefined)
+let priceId: string; //ID du prix Stripe (default to undefined)
+
+const { status, data } = await apiInstance.archivePriceForSubscriptionPlan(
+    id,
+    priceId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | ID du club | defaults to undefined|
+| **priceId** | [**string**] | ID du prix Stripe | defaults to undefined|
+
+
+### Return type
+
+**PriceResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Prix archivé avec succès |  -  |
+|**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)
+
+# **createPriceForSubscriptionPlan**
+> PriceResponse createPriceForSubscriptionPlan(createPriceRequest)
+
+
+### Example
+
+```typescript
+import {
+    ClubSubscriptionsApi,
+    Configuration,
+    CreatePriceRequest
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubSubscriptionsApi(configuration);
+
+let id: string; //ID du club (default to undefined)
+let productId: string; //ID du produit Stripe (default to undefined)
+let createPriceRequest: CreatePriceRequest; //
+
+const { status, data } = await apiInstance.createPriceForSubscriptionPlan(
+    id,
+    productId,
+    createPriceRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createPriceRequest** | **CreatePriceRequest**|  | |
+| **id** | [**string**] | ID du club | defaults to undefined|
+| **productId** | [**string**] | ID du produit Stripe | defaults to undefined|
+
+
+### Return type
+
+**PriceResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Prix créé avec succès |  -  |
+|**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)
+
+# **createSubscriptionPlanForClub**
+> SubscriptionPlanResponse createSubscriptionPlanForClub(createSubscriptionPlanRequest)
+
+
+### Example
+
+```typescript
+import {
+    ClubSubscriptionsApi,
+    Configuration,
+    CreateSubscriptionPlanRequest
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubSubscriptionsApi(configuration);
+
+let id: string; //ID du club (default to undefined)
+let createSubscriptionPlanRequest: CreateSubscriptionPlanRequest; //
+
+const { status, data } = await apiInstance.createSubscriptionPlanForClub(
+    id,
+    createSubscriptionPlanRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createSubscriptionPlanRequest** | **CreateSubscriptionPlanRequest**|  | |
+| **id** | [**string**] | ID du club | defaults to undefined|
+
+
+### Return type
+
+**SubscriptionPlanResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Plan d\'abonnement créé avec succès |  -  |
+|**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)
+
+# **deleteSubscriptionPlanForClub**
+> deleteSubscriptionPlanForClub()
+
+
+### Example
+
+```typescript
+import {
+    ClubSubscriptionsApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubSubscriptionsApi(configuration);
+
+let id: string; //ID du club (default to undefined)
+let productId: string; //ID du produit Stripe (default to undefined)
+
+const { status, data } = await apiInstance.deleteSubscriptionPlanForClub(
+    id,
+    productId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | ID du club | defaults to undefined|
+| **productId** | [**string**] | ID du produit Stripe | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Plan d\'abonnement supprimé avec succès |  -  |
+|**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)
+
+# **restoreSubscriptionPlanForClub**
+> RestoreSubscriptionPlanForClub200Response restoreSubscriptionPlanForClub()
+
+
+### Example
+
+```typescript
+import {
+    ClubSubscriptionsApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubSubscriptionsApi(configuration);
+
+let id: string; //ID du club (default to undefined)
+let productId: string; //ID du produit Stripe (default to undefined)
+
+const { status, data } = await apiInstance.restoreSubscriptionPlanForClub(
+    id,
+    productId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | ID du club | defaults to undefined|
+| **productId** | [**string**] | ID du produit Stripe | defaults to undefined|
+
+
+### Return type
+
+**RestoreSubscriptionPlanForClub200Response**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Plan d\'abonnement réactivé avec succès |  -  |
+|**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)
+
+# **restoreSubscriptionPriceForClub**
+> PriceResponse restoreSubscriptionPriceForClub()
+
+
+### Example
+
+```typescript
+import {
+    ClubSubscriptionsApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubSubscriptionsApi(configuration);
+
+let id: string; //ID du club (default to undefined)
+let priceId: string; //ID du prix Stripe (default to undefined)
+
+const { status, data } = await apiInstance.restoreSubscriptionPriceForClub(
+    id,
+    priceId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | ID du club | defaults to undefined|
+| **priceId** | [**string**] | ID du prix Stripe | defaults to undefined|
+
+
+### Return type
+
+**PriceResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Prix réactivé avec succès |  -  |
+|**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)
+
+# **updateSubscriptionPlanForClub**
+> UpdateSubscriptionPlanResponse updateSubscriptionPlanForClub(updateSubscriptionPlanRequest)
+
+
+### Example
+
+```typescript
+import {
+    ClubSubscriptionsApi,
+    Configuration,
+    UpdateSubscriptionPlanRequest
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubSubscriptionsApi(configuration);
+
+let id: string; //ID du club (default to undefined)
+let priceId: string; //ID du prix Stripe (default to undefined)
+let updateSubscriptionPlanRequest: UpdateSubscriptionPlanRequest; //
+
+const { status, data } = await apiInstance.updateSubscriptionPlanForClub(
+    id,
+    priceId,
+    updateSubscriptionPlanRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateSubscriptionPlanRequest** | **UpdateSubscriptionPlanRequest**|  | |
+| **id** | [**string**] | ID du club | defaults to undefined|
+| **priceId** | [**string**] | ID du prix Stripe | defaults to undefined|
+
+
+### Return type
+
+**UpdateSubscriptionPlanResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Plan d\'abonnement mis à jour avec succès |  -  |
+|**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)
+