@tennac-booking/sdk 1.0.60 → 1.0.61
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +40 -5
- package/README.md +47 -14
- package/api.ts +6803 -5030
- package/base.ts +2 -2
- package/common.ts +2 -2
- package/configuration.ts +2 -2
- package/dist/api.d.ts +3874 -2297
- package/dist/api.js +899 -495
- package/dist/base.d.ts +2 -2
- package/dist/base.js +2 -2
- package/dist/common.d.ts +2 -2
- package/dist/common.js +2 -2
- package/dist/configuration.d.ts +2 -2
- package/dist/configuration.js +2 -2
- package/dist/esm/api.d.ts +3874 -2297
- package/dist/esm/api.js +880 -493
- package/dist/esm/base.d.ts +2 -2
- package/dist/esm/base.js +2 -2
- package/dist/esm/common.d.ts +2 -2
- package/dist/esm/common.js +2 -2
- package/dist/esm/configuration.d.ts +2 -2
- package/dist/esm/configuration.js +2 -2
- package/dist/esm/index.d.ts +2 -2
- package/dist/esm/index.js +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +2 -2
- package/docs/ClubResponse.md +0 -1
- package/docs/ClubsManagerApi.md +0 -55
- package/docs/ClubsStaffApi.md +2 -2
- package/docs/{SubscriptionSessionRequestBody.md → CreatePlan201Response.md} +5 -5
- package/docs/CreateSubscriptionPlanRequest.md +10 -4
- package/docs/CreateSubscriptionPlanRequestDiscount.md +32 -0
- package/docs/DefaultApi.md +0 -54
- package/docs/{DeleteClubResponse.md → DeleteSubscriptionPlanResponse.md} +4 -4
- package/docs/DiscountType.md +14 -0
- package/docs/OffPeakRule.md +26 -0
- package/docs/PlanInterval.md +14 -0
- package/docs/PublicSubscriptionPlanResponse.md +30 -0
- package/docs/StripeStripeDeletedProduct.md +25 -0
- package/docs/StripeStripePrice.md +63 -0
- package/docs/StripeStripePriceBillingScheme.md +10 -0
- package/docs/StripeStripePriceCurrencyOptions.md +28 -0
- package/docs/StripeStripePriceCurrencyOptionsCustomUnitAmount.md +24 -0
- package/docs/StripeStripePriceCurrencyOptionsTaxBehavior.md +12 -0
- package/docs/StripeStripePriceCurrencyOptionsTier.md +28 -0
- package/docs/StripeStripePriceCustomUnitAmount.md +24 -0
- package/docs/StripeStripePriceProduct.md +59 -0
- package/docs/StripeStripePriceRecurring.md +28 -0
- package/docs/StripeStripePriceRecurringInterval.md +14 -0
- package/docs/StripeStripePriceRecurringUsageType.md +10 -0
- package/docs/StripeStripePriceTaxBehavior.md +12 -0
- package/docs/StripeStripePriceTier.md +28 -0
- package/docs/StripeStripePriceTiersMode.md +10 -0
- package/docs/StripeStripePriceTransformQuantity.md +22 -0
- package/docs/StripeStripePriceTransformQuantityRound.md +10 -0
- package/docs/StripeStripePriceType.md +10 -0
- package/docs/StripeStripeProduct.md +59 -0
- package/docs/StripeStripeProductDefaultPrice.md +63 -0
- package/docs/{GetCourtsByClub200Response.md → StripeStripeProductMarketingFeature.md} +5 -5
- package/docs/StripeStripeProductPackageDimensions.md +26 -0
- package/docs/StripeStripeProductTaxCode.md +27 -0
- package/docs/StripeStripeProductType.md +10 -0
- package/docs/StripeStripeResponseStripeStripePrice.md +64 -0
- package/docs/StripeStripeResponseStripeStripePriceAllOfLastResponse.md +30 -0
- package/docs/StripeStripeTaxCode.md +27 -0
- package/docs/{SubscribeToClubRequestBody.md → SubscribeRequestBody.md} +3 -3
- package/docs/SubscriptionPlanResponse.md +14 -2
- package/docs/SubscriptionsManagerApi.md +171 -0
- package/docs/SubscriptionsPublicApi.md +60 -0
- package/docs/SubscriptionsStaffApi.md +54 -0
- package/docs/SubscriptionsUserApi.md +222 -0
- package/docs/UpdatePlanRequest.md +24 -0
- package/docs/UsersApi.md +0 -256
- package/index.ts +2 -2
- package/package.json +1 -1
- package/docs/SubscriptionSessionResponse.md +0 -20
package/dist/esm/base.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* openapi.json
|
|
3
|
-
* API
|
|
3
|
+
* Pandook API Documentation
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.0.
|
|
5
|
+
* The version of the OpenAPI document: 1.0.61
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/base.js
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* openapi.json
|
|
5
|
-
* API
|
|
5
|
+
* Pandook API Documentation
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.0.
|
|
7
|
+
* The version of the OpenAPI document: 1.0.61
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* openapi.json
|
|
3
|
-
* API
|
|
3
|
+
* Pandook API Documentation
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.0.
|
|
5
|
+
* The version of the OpenAPI document: 1.0.61
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.js
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* openapi.json
|
|
5
|
-
* API
|
|
5
|
+
* Pandook API Documentation
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.0.
|
|
7
|
+
* The version of the OpenAPI document: 1.0.61
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* openapi.json
|
|
3
|
-
* API
|
|
3
|
+
* Pandook API Documentation
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.0.
|
|
5
|
+
* The version of the OpenAPI document: 1.0.61
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* openapi.json
|
|
5
|
-
* API
|
|
5
|
+
* Pandook API Documentation
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.0.
|
|
7
|
+
* The version of the OpenAPI document: 1.0.61
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/index.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* openapi.json
|
|
3
|
-
* API
|
|
3
|
+
* Pandook API Documentation
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.0.
|
|
5
|
+
* The version of the OpenAPI document: 1.0.61
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/index.js
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* openapi.json
|
|
5
|
-
* API
|
|
5
|
+
* Pandook API Documentation
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.0.
|
|
7
|
+
* The version of the OpenAPI document: 1.0.61
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/index.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* openapi.json
|
|
3
|
-
* API
|
|
3
|
+
* Pandook API Documentation
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.0.
|
|
5
|
+
* The version of the OpenAPI document: 1.0.61
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/index.js
CHANGED
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
/* eslint-disable */
|
|
4
4
|
/**
|
|
5
5
|
* openapi.json
|
|
6
|
-
* API
|
|
6
|
+
* Pandook API Documentation
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 1.0.
|
|
8
|
+
* The version of the OpenAPI document: 1.0.61
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/docs/ClubResponse.md
CHANGED
package/docs/ClubsManagerApi.md
CHANGED
|
@@ -10,7 +10,6 @@ All URIs are relative to *http://localhost*
|
|
|
10
10
|
|[**createCourtForClub**](#createcourtforclub) | **POST** /api/clubs/courts | |
|
|
11
11
|
|[**createPriceForSubscriptionPlan**](#createpriceforsubscriptionplan) | **POST** /api/clubs/subscription-plans/{productId}/prices | |
|
|
12
12
|
|[**createSportForClub**](#createsportforclub) | **POST** /api/clubs/sports | |
|
|
13
|
-
|[**createSubscriptionPlanForClub**](#createsubscriptionplanforclub) | **POST** /api/clubs/subscription-plans | |
|
|
14
13
|
|[**deleteActuality**](#deleteactuality) | **DELETE** /api/clubs/actualities/{actualityId} | |
|
|
15
14
|
|[**deleteCourt**](#deletecourt) | **DELETE** /api/clubs/courts/{courtId} | |
|
|
16
15
|
|[**deleteSlotsByClubInRange**](#deleteslotsbyclubinrange) | **DELETE** /api/clubs/slots | |
|
|
@@ -338,60 +337,6 @@ const { status, data } = await apiInstance.createSportForClub(
|
|
|
338
337
|
|
|
339
338
|
[[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)
|
|
340
339
|
|
|
341
|
-
# **createSubscriptionPlanForClub**
|
|
342
|
-
> SubscriptionPlanResponse createSubscriptionPlanForClub(createSubscriptionPlanRequest)
|
|
343
|
-
|
|
344
|
-
Crée un plan d\'abonnement Stripe pour un club
|
|
345
|
-
|
|
346
|
-
### Example
|
|
347
|
-
|
|
348
|
-
```typescript
|
|
349
|
-
import {
|
|
350
|
-
ClubsManagerApi,
|
|
351
|
-
Configuration,
|
|
352
|
-
CreateSubscriptionPlanRequest
|
|
353
|
-
} from '@tennac-booking/sdk';
|
|
354
|
-
|
|
355
|
-
const configuration = new Configuration();
|
|
356
|
-
const apiInstance = new ClubsManagerApi(configuration);
|
|
357
|
-
|
|
358
|
-
let createSubscriptionPlanRequest: CreateSubscriptionPlanRequest; //
|
|
359
|
-
|
|
360
|
-
const { status, data } = await apiInstance.createSubscriptionPlanForClub(
|
|
361
|
-
createSubscriptionPlanRequest
|
|
362
|
-
);
|
|
363
|
-
```
|
|
364
|
-
|
|
365
|
-
### Parameters
|
|
366
|
-
|
|
367
|
-
|Name | Type | Description | Notes|
|
|
368
|
-
|------------- | ------------- | ------------- | -------------|
|
|
369
|
-
| **createSubscriptionPlanRequest** | **CreateSubscriptionPlanRequest**| | |
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
### Return type
|
|
373
|
-
|
|
374
|
-
**SubscriptionPlanResponse**
|
|
375
|
-
|
|
376
|
-
### Authorization
|
|
377
|
-
|
|
378
|
-
[bearerAuth](../README.md#bearerAuth)
|
|
379
|
-
|
|
380
|
-
### HTTP request headers
|
|
381
|
-
|
|
382
|
-
- **Content-Type**: application/json
|
|
383
|
-
- **Accept**: application/json
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
### HTTP response details
|
|
387
|
-
| Status code | Description | Response headers |
|
|
388
|
-
|-------------|-------------|------------------|
|
|
389
|
-
|**201** | Plan d\'abonnement créé | - |
|
|
390
|
-
|**400** | Bad Request | - |
|
|
391
|
-
|**500** | Server Error | - |
|
|
392
|
-
|
|
393
|
-
[[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)
|
|
394
|
-
|
|
395
340
|
# **deleteActuality**
|
|
396
341
|
> DeleteSlotsByClubInRange200Response deleteActuality()
|
|
397
342
|
|
package/docs/ClubsStaffApi.md
CHANGED
|
@@ -189,7 +189,7 @@ This endpoint does not have any parameters.
|
|
|
189
189
|
[[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)
|
|
190
190
|
|
|
191
191
|
# **getCourtsByClub**
|
|
192
|
-
>
|
|
192
|
+
> Array<CourtResponse> getCourtsByClub()
|
|
193
193
|
|
|
194
194
|
Récupère les terrains d\'un club
|
|
195
195
|
|
|
@@ -213,7 +213,7 @@ This endpoint does not have any parameters.
|
|
|
213
213
|
|
|
214
214
|
### Return type
|
|
215
215
|
|
|
216
|
-
**
|
|
216
|
+
**Array<CourtResponse>**
|
|
217
217
|
|
|
218
218
|
### Authorization
|
|
219
219
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# CreatePlan201Response
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -6,16 +6,16 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**priceId** | **string** | | [default to undefined]
|
|
9
|
-
**
|
|
9
|
+
**productId** | **string** | | [default to undefined]
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import {
|
|
14
|
+
import { CreatePlan201Response } from '@tennac-booking/sdk';
|
|
15
15
|
|
|
16
|
-
const instance:
|
|
16
|
+
const instance: CreatePlan201Response = {
|
|
17
17
|
priceId,
|
|
18
|
-
|
|
18
|
+
productId,
|
|
19
19
|
};
|
|
20
20
|
```
|
|
21
21
|
|
|
@@ -5,10 +5,13 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**
|
|
9
|
-
**
|
|
10
|
-
**
|
|
11
|
-
**
|
|
8
|
+
**clubId** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**name** | **string** | | [default to undefined]
|
|
10
|
+
**description** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**amountInCents** | **number** | | [default to undefined]
|
|
12
|
+
**currency** | **string** | | [default to undefined]
|
|
13
|
+
**interval** | [**PlanInterval**](PlanInterval.md) | | [default to undefined]
|
|
14
|
+
**discount** | [**CreateSubscriptionPlanRequestDiscount**](CreateSubscriptionPlanRequestDiscount.md) | | [optional] [default to undefined]
|
|
12
15
|
|
|
13
16
|
## Example
|
|
14
17
|
|
|
@@ -16,10 +19,13 @@ Name | Type | Description | Notes
|
|
|
16
19
|
import { CreateSubscriptionPlanRequest } from '@tennac-booking/sdk';
|
|
17
20
|
|
|
18
21
|
const instance: CreateSubscriptionPlanRequest = {
|
|
22
|
+
clubId,
|
|
19
23
|
name,
|
|
24
|
+
description,
|
|
20
25
|
amountInCents,
|
|
21
26
|
currency,
|
|
22
27
|
interval,
|
|
28
|
+
discount,
|
|
23
29
|
};
|
|
24
30
|
```
|
|
25
31
|
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# CreateSubscriptionPlanRequestDiscount
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**bookingFree** | **boolean** | | [optional] [default to undefined]
|
|
9
|
+
**offPeakRules** | [**Array<OffPeakRule>**](OffPeakRule.md) | | [optional] [default to undefined]
|
|
10
|
+
**validTo** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**validFrom** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**maxDiscountAmountInCents** | **number** | | [optional] [default to undefined]
|
|
13
|
+
**percentage** | **number** | | [optional] [default to undefined]
|
|
14
|
+
**type** | [**DiscountType**](DiscountType.md) | | [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { CreateSubscriptionPlanRequestDiscount } from '@tennac-booking/sdk';
|
|
20
|
+
|
|
21
|
+
const instance: CreateSubscriptionPlanRequestDiscount = {
|
|
22
|
+
bookingFree,
|
|
23
|
+
offPeakRules,
|
|
24
|
+
validTo,
|
|
25
|
+
validFrom,
|
|
26
|
+
maxDiscountAmountInCents,
|
|
27
|
+
percentage,
|
|
28
|
+
type,
|
|
29
|
+
};
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[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/DefaultApi.md
CHANGED
|
@@ -5,7 +5,6 @@ All URIs are relative to *http://localhost*
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**createClub**](#createclub) | **POST** /api/clubs | |
|
|
8
|
-
|[**deleteClub**](#deleteclub) | **DELETE** /api/clubs/{id} | |
|
|
9
8
|
|
|
10
9
|
# **createClub**
|
|
11
10
|
> ClubResponse createClub(createClubRequest)
|
|
@@ -61,56 +60,3 @@ No authorization required
|
|
|
61
60
|
|
|
62
61
|
[[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)
|
|
63
62
|
|
|
64
|
-
# **deleteClub**
|
|
65
|
-
> DeleteClubResponse deleteClub()
|
|
66
|
-
|
|
67
|
-
Supprime un club et toutes ses données associées
|
|
68
|
-
|
|
69
|
-
### Example
|
|
70
|
-
|
|
71
|
-
```typescript
|
|
72
|
-
import {
|
|
73
|
-
DefaultApi,
|
|
74
|
-
Configuration
|
|
75
|
-
} from '@tennac-booking/sdk';
|
|
76
|
-
|
|
77
|
-
const configuration = new Configuration();
|
|
78
|
-
const apiInstance = new DefaultApi(configuration);
|
|
79
|
-
|
|
80
|
-
let id: string; // (default to undefined)
|
|
81
|
-
|
|
82
|
-
const { status, data } = await apiInstance.deleteClub(
|
|
83
|
-
id
|
|
84
|
-
);
|
|
85
|
-
```
|
|
86
|
-
|
|
87
|
-
### Parameters
|
|
88
|
-
|
|
89
|
-
|Name | Type | Description | Notes|
|
|
90
|
-
|------------- | ------------- | ------------- | -------------|
|
|
91
|
-
| **id** | [**string**] | | defaults to undefined|
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
### Return type
|
|
95
|
-
|
|
96
|
-
**DeleteClubResponse**
|
|
97
|
-
|
|
98
|
-
### Authorization
|
|
99
|
-
|
|
100
|
-
[bearerAuth](../README.md#bearerAuth)
|
|
101
|
-
|
|
102
|
-
### HTTP request headers
|
|
103
|
-
|
|
104
|
-
- **Content-Type**: Not defined
|
|
105
|
-
- **Accept**: application/json
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
### HTTP response details
|
|
109
|
-
| Status code | Description | Response headers |
|
|
110
|
-
|-------------|-------------|------------------|
|
|
111
|
-
|**200** | Club supprimé | - |
|
|
112
|
-
|**404** | Club non trouvé | - |
|
|
113
|
-
|**500** | Server Error | - |
|
|
114
|
-
|
|
115
|
-
[[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)
|
|
116
|
-
|
|
@@ -1,18 +1,18 @@
|
|
|
1
|
-
#
|
|
1
|
+
# DeleteSubscriptionPlanResponse
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**message** | **string** |
|
|
8
|
+
**message** | **string** | | [default to undefined]
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
13
|
-
import {
|
|
13
|
+
import { DeleteSubscriptionPlanResponse } from '@tennac-booking/sdk';
|
|
14
14
|
|
|
15
|
-
const instance:
|
|
15
|
+
const instance: DeleteSubscriptionPlanResponse = {
|
|
16
16
|
message,
|
|
17
17
|
};
|
|
18
18
|
```
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# DiscountType
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `None` (value: `'none'`)
|
|
7
|
+
|
|
8
|
+
* `Free` (value: `'free'`)
|
|
9
|
+
|
|
10
|
+
* `Percentage` (value: `'percentage'`)
|
|
11
|
+
|
|
12
|
+
* `OffPeak` (value: `'off_peak'`)
|
|
13
|
+
|
|
14
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# OffPeakRule
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**percentage** | **number** | | [default to undefined]
|
|
9
|
+
**endHour** | **number** | | [default to undefined]
|
|
10
|
+
**startHour** | **number** | | [default to undefined]
|
|
11
|
+
**dayOfWeek** | **number** | | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { OffPeakRule } from '@tennac-booking/sdk';
|
|
17
|
+
|
|
18
|
+
const instance: OffPeakRule = {
|
|
19
|
+
percentage,
|
|
20
|
+
endHour,
|
|
21
|
+
startHour,
|
|
22
|
+
dayOfWeek,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# PlanInterval
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `Monthly` (value: `'monthly'`)
|
|
7
|
+
|
|
8
|
+
* `Yearly` (value: `'yearly'`)
|
|
9
|
+
|
|
10
|
+
* `Trimester` (value: `'trimester'`)
|
|
11
|
+
|
|
12
|
+
* `Semester` (value: `'semester'`)
|
|
13
|
+
|
|
14
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# PublicSubscriptionPlanResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**priceId** | **string** | | [default to undefined]
|
|
9
|
+
**name** | **string** | | [default to undefined]
|
|
10
|
+
**amountInCents** | **number** | | [default to undefined]
|
|
11
|
+
**currency** | **string** | | [default to undefined]
|
|
12
|
+
**interval** | [**PlanInterval**](PlanInterval.md) | | [optional] [default to undefined]
|
|
13
|
+
**description** | **string** | | [optional] [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { PublicSubscriptionPlanResponse } from '@tennac-booking/sdk';
|
|
19
|
+
|
|
20
|
+
const instance: PublicSubscriptionPlanResponse = {
|
|
21
|
+
priceId,
|
|
22
|
+
name,
|
|
23
|
+
amountInCents,
|
|
24
|
+
currency,
|
|
25
|
+
interval,
|
|
26
|
+
description,
|
|
27
|
+
};
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# StripeStripeDeletedProduct
|
|
2
|
+
|
|
3
|
+
The DeletedProduct object.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | Unique identifier for the object. | [default to undefined]
|
|
10
|
+
**object** | **string** | String representing the object\'s type. Objects of the same type share the same value. | [default to undefined]
|
|
11
|
+
**deleted** | **boolean** | Always true for a deleted object | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { StripeStripeDeletedProduct } from '@tennac-booking/sdk';
|
|
17
|
+
|
|
18
|
+
const instance: StripeStripeDeletedProduct = {
|
|
19
|
+
id,
|
|
20
|
+
object,
|
|
21
|
+
deleted,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
# StripeStripePrice
|
|
2
|
+
|
|
3
|
+
Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. [Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme. For example, you might have a single \"gold\" product that has prices for $10/month, $100/year, and €9 once. Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription), [create an invoice](https://stripe.com/docs/billing/invoices/create), and more about [products and prices](https://stripe.com/docs/products-prices/overview).
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | Unique identifier for the object. | [default to undefined]
|
|
10
|
+
**object** | **string** | String representing the object\'s type. Objects of the same type share the same value. | [default to undefined]
|
|
11
|
+
**active** | **boolean** | Whether the price can be used for new purchases. | [default to undefined]
|
|
12
|
+
**billing_scheme** | [**StripeStripePriceBillingScheme**](StripeStripePriceBillingScheme.md) | | [default to undefined]
|
|
13
|
+
**created** | **number** | Time at which the object was created. Measured in seconds since the Unix epoch. | [default to undefined]
|
|
14
|
+
**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]
|
|
15
|
+
**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]
|
|
16
|
+
**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]
|
|
17
|
+
**deleted** | **any** | Always true for a deleted object | [optional] [default to undefined]
|
|
18
|
+
**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]
|
|
19
|
+
**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]
|
|
20
|
+
**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]
|
|
21
|
+
**nickname** | **string** | A brief description of the price, hidden from customers. | [default to undefined]
|
|
22
|
+
**product** | [**StripeStripePriceProduct**](StripeStripePriceProduct.md) | | [default to undefined]
|
|
23
|
+
**recurring** | [**StripeStripePriceRecurring**](StripeStripePriceRecurring.md) | The recurring components of a price such as `interval` and `usage_type`. | [default to undefined]
|
|
24
|
+
**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]
|
|
25
|
+
**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]
|
|
26
|
+
**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]
|
|
27
|
+
**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]
|
|
28
|
+
**type** | [**StripeStripePriceType**](StripeStripePriceType.md) | | [default to undefined]
|
|
29
|
+
**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]
|
|
30
|
+
**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]
|
|
31
|
+
|
|
32
|
+
## Example
|
|
33
|
+
|
|
34
|
+
```typescript
|
|
35
|
+
import { StripeStripePrice } from '@tennac-booking/sdk';
|
|
36
|
+
|
|
37
|
+
const instance: StripeStripePrice = {
|
|
38
|
+
id,
|
|
39
|
+
object,
|
|
40
|
+
active,
|
|
41
|
+
billing_scheme,
|
|
42
|
+
created,
|
|
43
|
+
currency,
|
|
44
|
+
currency_options,
|
|
45
|
+
custom_unit_amount,
|
|
46
|
+
deleted,
|
|
47
|
+
livemode,
|
|
48
|
+
lookup_key,
|
|
49
|
+
metadata,
|
|
50
|
+
nickname,
|
|
51
|
+
product,
|
|
52
|
+
recurring,
|
|
53
|
+
tax_behavior,
|
|
54
|
+
tiers,
|
|
55
|
+
tiers_mode,
|
|
56
|
+
transform_quantity,
|
|
57
|
+
type,
|
|
58
|
+
unit_amount,
|
|
59
|
+
unit_amount_decimal,
|
|
60
|
+
};
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# StripeStripePriceBillingScheme
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `PerUnit` (value: `'per_unit'`)
|
|
7
|
+
|
|
8
|
+
* `Tiered` (value: `'tiered'`)
|
|
9
|
+
|
|
10
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# StripeStripePriceCurrencyOptions
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**custom_unit_amount** | [**StripeStripePriceCurrencyOptionsCustomUnitAmount**](StripeStripePriceCurrencyOptionsCustomUnitAmount.md) | When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links. | [default to undefined]
|
|
9
|
+
**tax_behavior** | [**StripeStripePriceCurrencyOptionsTaxBehavior**](StripeStripePriceCurrencyOptionsTaxBehavior.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]
|
|
10
|
+
**tiers** | [**Array<StripeStripePriceCurrencyOptionsTier>**](StripeStripePriceCurrencyOptionsTier.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]
|
|
11
|
+
**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]
|
|
12
|
+
**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]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { StripeStripePriceCurrencyOptions } from '@tennac-booking/sdk';
|
|
18
|
+
|
|
19
|
+
const instance: StripeStripePriceCurrencyOptions = {
|
|
20
|
+
custom_unit_amount,
|
|
21
|
+
tax_behavior,
|
|
22
|
+
tiers,
|
|
23
|
+
unit_amount,
|
|
24
|
+
unit_amount_decimal,
|
|
25
|
+
};
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# StripeStripePriceCurrencyOptionsCustomUnitAmount
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**maximum** | **number** | The maximum unit amount the customer can specify for this item. | [default to undefined]
|
|
9
|
+
**minimum** | **number** | The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount. | [default to undefined]
|
|
10
|
+
**preset** | **number** | The starting unit amount which can be updated by the customer. | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { StripeStripePriceCurrencyOptionsCustomUnitAmount } from '@tennac-booking/sdk';
|
|
16
|
+
|
|
17
|
+
const instance: StripeStripePriceCurrencyOptionsCustomUnitAmount = {
|
|
18
|
+
maximum,
|
|
19
|
+
minimum,
|
|
20
|
+
preset,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|