@tennac-booking/sdk 1.0.60 → 1.0.62

package/docs/StripeStripeResponseStripeStripePrice.md

@@ -0,0 +1,64 @@
+# StripeStripeResponseStripeStripePrice
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique identifier for the object. | [default to undefined]
+**object** | **string** | String representing the object\'s type. Objects of the same type share the same value. | [default to undefined]
+**active** | **boolean** | Whether the price can be used for new purchases. | [default to undefined]
+**billing_scheme** | [**StripeStripePriceBillingScheme**](StripeStripePriceBillingScheme.md) |  | [default to undefined]
+**created** | **number** | Time at which the object was created. Measured in seconds since the Unix epoch. | [default to undefined]
+**currency** | **string** | Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). | [default to undefined]
+**currency_options** | [**{ [key: string]: StripeStripePriceCurrencyOptions; }**](StripeStripePriceCurrencyOptions.md) | Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). | [optional] [default to undefined]
+**custom_unit_amount** | [**StripeStripePriceCustomUnitAmount**](StripeStripePriceCustomUnitAmount.md) | When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links. | [default to undefined]
+**deleted** | **any** | Always true for a deleted object | [optional] [default to undefined]
+**livemode** | **boolean** | Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. | [default to undefined]
+**lookup_key** | **string** | A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. | [default to undefined]
+**metadata** | **{ [key: string]: string; }** | Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. | [default to undefined]
+**nickname** | **string** | A brief description of the price, hidden from customers. | [default to undefined]
+**product** | [**StripeStripePriceProduct**](StripeStripePriceProduct.md) |  | [default to undefined]
+**recurring** | [**StripeStripePriceRecurring**](StripeStripePriceRecurring.md) | The recurring components of a price such as `interval` and `usage_type`. | [default to undefined]
+**tax_behavior** | [**StripeStripePriceTaxBehavior**](StripeStripePriceTaxBehavior.md) | Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. | [default to undefined]
+**tiers** | [**Array<StripeStripePriceTier>**](StripeStripePriceTier.md) | Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. | [optional] [default to undefined]
+**tiers_mode** | [**StripeStripePriceTiersMode**](StripeStripePriceTiersMode.md) | Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows. | [default to undefined]
+**transform_quantity** | [**StripeStripePriceTransformQuantity**](StripeStripePriceTransformQuantity.md) | Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`. | [default to undefined]
+**type** | [**StripeStripePriceType**](StripeStripePriceType.md) |  | [default to undefined]
+**unit_amount** | **number** | The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. | [default to undefined]
+**unit_amount_decimal** | **string** | The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. | [default to undefined]
+**lastResponse** | [**StripeStripeResponseStripeStripePriceAllOfLastResponse**](StripeStripeResponseStripeStripePriceAllOfLastResponse.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { StripeStripeResponseStripeStripePrice } from '@tennac-booking/sdk';
+
+const instance: StripeStripeResponseStripeStripePrice = {
+    id,
+    object,
+    active,
+    billing_scheme,
+    created,
+    currency,
+    currency_options,
+    custom_unit_amount,
+    deleted,
+    livemode,
+    lookup_key,
+    metadata,
+    nickname,
+    product,
+    recurring,
+    tax_behavior,
+    tiers,
+    tiers_mode,
+    transform_quantity,
+    type,
+    unit_amount,
+    unit_amount_decimal,
+    lastResponse,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/StripeStripeResponseStripeStripePriceAllOfLastResponse.md

@@ -0,0 +1,30 @@
+# StripeStripeResponseStripeStripePriceAllOfLastResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**stripeAccount** | **string** |  | [optional] [default to undefined]
+**idempotencyKey** | **string** |  | [optional] [default to undefined]
+**apiVersion** | **string** |  | [optional] [default to undefined]
+**statusCode** | **number** |  | [default to undefined]
+**requestId** | **string** |  | [default to undefined]
+**headers** | **{ [key: string]: string; }** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { StripeStripeResponseStripeStripePriceAllOfLastResponse } from '@tennac-booking/sdk';
+
+const instance: StripeStripeResponseStripeStripePriceAllOfLastResponse = {
+    stripeAccount,
+    idempotencyKey,
+    apiVersion,
+    statusCode,
+    requestId,
+    headers,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/StripeStripeTaxCode.md

@@ -0,0 +1,27 @@
+# StripeStripeTaxCode
+
+[Tax codes](https://stripe.com/docs/tax/tax-categories) classify goods and services for tax purposes.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique identifier for the object. | [default to undefined]
+**object** | **string** | String representing the object\'s type. Objects of the same type share the same value. | [default to undefined]
+**description** | **string** | A detailed description of which types of products the tax code represents. | [default to undefined]
+**name** | **string** | A short name for the tax code. | [default to undefined]
+
+## Example
+
+```typescript
+import { StripeStripeTaxCode } from '@tennac-booking/sdk';
+
+const instance: StripeStripeTaxCode = {
+    id,
+    object,
+    description,
+    name,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/{SubscribeToClubRequestBody.md → SubscribeRequestBody.md}

@@ -1,4 +1,4 @@
-# SubscribeToClubRequestBody
+# SubscribeRequestBody
 
 
 ## Properties
@@ -11,9 +11,9 @@ Name | Type | Description | Notes
 ## Example
 
 ```typescript
-import { SubscribeToClubRequestBody } from '@tennac-booking/sdk';
+import { SubscribeRequestBody } from '@tennac-booking/sdk';
 
-const instance: SubscribeToClubRequestBody = {
+const instance: SubscribeRequestBody = {
     clubId,
     priceId,
 };

package/docs/SubscriptionPlanResponse.md

@@ -5,8 +5,14 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**productId** | **string** | ID du produit Stripe | [default to undefined]
-**priceId** | **string** | ID du prix Stripe | [default to undefined]
+**productId** | **string** |  | [default to undefined]
+**productName** | **string** |  | [default to undefined]
+**productActive** | **boolean** |  | [default to undefined]
+**priceId** | **string** |  | [default to undefined]
+**amountInCents** | **number** |  | [default to undefined]
+**currency** | **string** |  | [default to undefined]
+**interval** | [**PlanInterval**](PlanInterval.md) |  | [optional] [default to undefined]
+**priceActive** | **boolean** |  | [default to undefined]
 
 ## Example
 
@@ -15,7 +21,13 @@ import { SubscriptionPlanResponse } from '@tennac-booking/sdk';
 
 const instance: SubscriptionPlanResponse = {
     productId,
+    productName,
+    productActive,
     priceId,
+    amountInCents,
+    currency,
+    interval,
+    priceActive,
 };
 ```
 

package/docs/SubscriptionsManagerApi.md

@@ -0,0 +1,171 @@
+# SubscriptionsManagerApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createPlan**](#createplan) | **POST** /api/subscriptions/plans | |
+|[**deletePlan**](#deleteplan) | **DELETE** /api/subscriptions/plans/{productId} | |
+|[**updatePlan**](#updateplan) | **PUT** /api/subscriptions/plans | |
+
+# **createPlan**
+> CreatePlan201Response createPlan(createSubscriptionPlanRequest)
+
+Crée un nouveau plan d\'abonnement (produit + price) pour le club (manager)
+
+### Example
+
+```typescript
+import {
+    SubscriptionsManagerApi,
+    Configuration,
+    CreateSubscriptionPlanRequest
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SubscriptionsManagerApi(configuration);
+
+let createSubscriptionPlanRequest: CreateSubscriptionPlanRequest; //
+
+const { status, data } = await apiInstance.createPlan(
+    createSubscriptionPlanRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createSubscriptionPlanRequest** | **CreateSubscriptionPlanRequest**|  | |
+
+
+### Return type
+
+**CreatePlan201Response**
+
+### 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 créé |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorized |  -  |
+
+[[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)
+
+# **deletePlan**
+> DeleteSubscriptionPlanResponse deletePlan()
+
+Supprime (archive) un plan par productId (manager)
+
+### Example
+
+```typescript
+import {
+    SubscriptionsManagerApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SubscriptionsManagerApi(configuration);
+
+let productId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.deletePlan(
+    productId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **productId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**DeleteSubscriptionPlanResponse**
+
+### 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 supprimé |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorized |  -  |
+
+[[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)
+
+# **updatePlan**
+> StripeStripeResponseStripeStripePrice updatePlan(updatePlanRequest)
+
+Met à jour un plan en créant un nouveau price et en archivant l\'ancien (manager)
+
+### Example
+
+```typescript
+import {
+    SubscriptionsManagerApi,
+    Configuration,
+    UpdatePlanRequest
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SubscriptionsManagerApi(configuration);
+
+let updatePlanRequest: UpdatePlanRequest; //
+
+const { status, data } = await apiInstance.updatePlan(
+    updatePlanRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updatePlanRequest** | **UpdatePlanRequest**|  | |
+
+
+### Return type
+
+**StripeStripeResponseStripeStripePrice**
+
+### 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 mis à jour |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorized |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/SubscriptionsPublicApi.md

@@ -0,0 +1,60 @@
+# SubscriptionsPublicApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getPublicPlans**](#getpublicplans) | **GET** /api/subscriptions/plans/{clubId} | |
+
+# **getPublicPlans**
+> Array<PublicSubscriptionPlanResponse> getPublicPlans()
+
+Liste simplifiée des plans d\'abonnement actifs d\'un club (public)
+
+### Example
+
+```typescript
+import {
+    SubscriptionsPublicApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SubscriptionsPublicApi(configuration);
+
+let clubId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getPublicPlans(
+    clubId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **clubId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**Array<PublicSubscriptionPlanResponse>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Plans publics du club |  -  |
+|**404** | Club ou plans introuvables |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/SubscriptionsStaffApi.md

@@ -0,0 +1,54 @@
+# SubscriptionsStaffApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getClubPlans**](#getclubplans) | **GET** /api/subscriptions/plans | |
+
+# **getClubPlans**
+> Array<SubscriptionPlanResponse> getClubPlans()
+
+Liste détaillée des plans (actifs/inactifs) du club courant (staff)
+
+### Example
+
+```typescript
+import {
+    SubscriptionsStaffApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SubscriptionsStaffApi(configuration);
+
+const { status, data } = await apiInstance.getClubPlans();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<SubscriptionPlanResponse>**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Plans du club |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorized |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/SubscriptionsUserApi.md

@@ -0,0 +1,222 @@
+# SubscriptionsUserApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**cancel**](#cancel) | **DELETE** /api/subscriptions/{clubId}/{subscriptionId} | |
+|[**mySubscriptions**](#mysubscriptions) | **GET** /api/subscriptions/me | |
+|[**resume**](#resume) | **POST** /api/subscriptions/{clubId}/{subscriptionId}/resume | |
+|[**subscribe**](#subscribe) | **POST** /api/subscriptions/subscribe | |
+
+# **cancel**
+> SubscriptionMutationResponse cancel()
+
+Annuler un abonnement à la fin de la période (auth classique)
+
+### Example
+
+```typescript
+import {
+    SubscriptionsUserApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SubscriptionsUserApi(configuration);
+
+let clubId: string; // (default to undefined)
+let subscriptionId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.cancel(
+    clubId,
+    subscriptionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **clubId** | [**string**] |  | defaults to undefined|
+| **subscriptionId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**SubscriptionMutationResponse**
+
+### 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é (fin de période) |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorized |  -  |
+
+[[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)
+
+# **mySubscriptions**
+> UserSubscriptionsResponse mySubscriptions()
+
+Liste les abonnements de l\'utilisateur courant, groupés par club (auth classique)
+
+### Example
+
+```typescript
+import {
+    SubscriptionsUserApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SubscriptionsUserApi(configuration);
+
+const { status, data } = await apiInstance.mySubscriptions();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**UserSubscriptionsResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Abonnements de l\'utilisateur |  -  |
+|**401** | Unauthorized |  -  |
+
+[[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)
+
+# **resume**
+> SubscriptionMutationResponse resume()
+
+Reprendre un abonnement annulé en fin de période (auth classique)
+
+### Example
+
+```typescript
+import {
+    SubscriptionsUserApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SubscriptionsUserApi(configuration);
+
+let clubId: string; // (default to undefined)
+let subscriptionId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.resume(
+    clubId,
+    subscriptionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **clubId** | [**string**] |  | defaults to undefined|
+| **subscriptionId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**SubscriptionMutationResponse**
+
+### 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 repris |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorized |  -  |
+
+[[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)
+
+# **subscribe**
+> SubscriptionMutationResponse subscribe(subscribeRequestBody)
+
+S\'abonner à un plan (auth classique)
+
+### Example
+
+```typescript
+import {
+    SubscriptionsUserApi,
+    Configuration,
+    SubscribeRequestBody
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SubscriptionsUserApi(configuration);
+
+let subscribeRequestBody: SubscribeRequestBody; //
+
+const { status, data } = await apiInstance.subscribe(
+    subscribeRequestBody
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **subscribeRequestBody** | **SubscribeRequestBody**|  | |
+
+
+### Return type
+
+**SubscriptionMutationResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Abonnement créé |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorized |  -  |
+
+[[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)
+