@tennac-booking/sdk 1.0.176 → 1.0.177
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 +5 -0
- package/README.md +9 -2
- package/api.ts +415 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +328 -1
- package/dist/api.js +137 -1
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +328 -1
- package/dist/esm/api.js +137 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/BookingPlayerInfo.md +26 -0
- package/docs/BookingPopulated.md +2 -0
- package/docs/BookingSummary.md +12 -0
- package/docs/BookingsApi.md +55 -0
- package/docs/BookingsUserApi.md +53 -0
- package/docs/CreateOpenBookingRequest.md +2 -0
- package/docs/GetOpenBookingPrice200Response.md +24 -0
- package/docs/GetOpenBookingPriceRequest.md +26 -0
- package/docs/JoinPriceEstimateResponse.md +38 -0
- package/docs/JoinPriceEstimateResponseSubscriptionInfo.md +25 -0
- package/docs/OpenBookingInfo.md +2 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/esm/common.d.ts
CHANGED
package/dist/esm/common.js
CHANGED
package/dist/esm/index.d.ts
CHANGED
package/dist/esm/index.js
CHANGED
package/dist/index.d.ts
CHANGED
package/dist/index.js
CHANGED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# BookingPlayerInfo
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | | [default to undefined]
|
|
9
|
+
**firstName** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**lastName** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**profilePicture** | **string** | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { BookingPlayerInfo } from '@tennac-booking/sdk';
|
|
17
|
+
|
|
18
|
+
const instance: BookingPlayerInfo = {
|
|
19
|
+
id,
|
|
20
|
+
firstName,
|
|
21
|
+
lastName,
|
|
22
|
+
profilePicture,
|
|
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)
|
package/docs/BookingPopulated.md
CHANGED
|
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**creator** | [**UserInfo**](UserInfo.md) | | [default to undefined]
|
|
11
11
|
**slotInfos** | [**SlotInfo**](SlotInfo.md) | | [default to undefined]
|
|
12
12
|
**players** | [**Array<UserInfo>**](UserInfo.md) | | [default to undefined]
|
|
13
|
+
**initialPlayers** | [**Array<UserInfo>**](UserInfo.md) | Joueurs inclus à la création de la réservation (pour les créneaux ouverts) | [optional] [default to undefined]
|
|
13
14
|
**paymentByPlayers** | [**Array<PaymentByPlayerInfo>**](PaymentByPlayerInfo.md) | Statut des paiements par joueur | [default to undefined]
|
|
14
15
|
**noShowChargeApplied** | **boolean** | | [optional] [default to undefined]
|
|
15
16
|
**noShowChargeAmount** | **number** | | [optional] [default to undefined]
|
|
@@ -32,6 +33,7 @@ const instance: BookingPopulated = {
|
|
|
32
33
|
creator,
|
|
33
34
|
slotInfos,
|
|
34
35
|
players,
|
|
36
|
+
initialPlayers,
|
|
35
37
|
paymentByPlayers,
|
|
36
38
|
noShowChargeApplied,
|
|
37
39
|
noShowChargeAmount,
|
package/docs/BookingSummary.md
CHANGED
|
@@ -15,6 +15,12 @@ Name | Type | Description | Notes
|
|
|
15
15
|
**totalPrice** | **number** | | [default to undefined]
|
|
16
16
|
**slotIds** | **Array<string>** | | [default to undefined]
|
|
17
17
|
**isPublic** | **boolean** | | [default to undefined]
|
|
18
|
+
**isOpen** | **boolean** | | [default to undefined]
|
|
19
|
+
**maxPlayers** | **number** | | [optional] [default to undefined]
|
|
20
|
+
**maxPlayersDesired** | **number** | | [optional] [default to undefined]
|
|
21
|
+
**description** | **string** | | [optional] [default to undefined]
|
|
22
|
+
**minLevel** | **string** | | [optional] [default to undefined]
|
|
23
|
+
**initialPlayers** | [**Array<BookingPlayerInfo>**](BookingPlayerInfo.md) | | [optional] [default to undefined]
|
|
18
24
|
**requestingUserId** | **string** | | [default to undefined]
|
|
19
25
|
**creatorPaymentMethodId** | **string** | | [optional] [default to undefined]
|
|
20
26
|
**paymentMethodSetupCompleted** | **boolean** | | [default to undefined]
|
|
@@ -63,6 +69,12 @@ const instance: BookingSummary = {
|
|
|
63
69
|
totalPrice,
|
|
64
70
|
slotIds,
|
|
65
71
|
isPublic,
|
|
72
|
+
isOpen,
|
|
73
|
+
maxPlayers,
|
|
74
|
+
maxPlayersDesired,
|
|
75
|
+
description,
|
|
76
|
+
minLevel,
|
|
77
|
+
initialPlayers,
|
|
66
78
|
requestingUserId,
|
|
67
79
|
creatorPaymentMethodId,
|
|
68
80
|
paymentMethodSetupCompleted,
|
package/docs/BookingsApi.md
CHANGED
|
@@ -9,6 +9,7 @@ All URIs are relative to *http://localhost*
|
|
|
9
9
|
|[**getBookingHistory**](#getbookinghistory) | **GET** /api/bookings/history/{bookingId} | |
|
|
10
10
|
|[**getBookingPrice**](#getbookingprice) | **POST** /api/bookings/booking-price | |
|
|
11
11
|
|[**getGuestBookingPrice**](#getguestbookingprice) | **POST** /api/bookings/guest/booking-price | |
|
|
12
|
+
|[**getJoinPriceEstimate**](#getjoinpriceestimate) | **GET** /api/bookings/{bookingId}/join-price-estimate | |
|
|
12
13
|
|[**getOpenBookingJoinPrice**](#getopenbookingjoinprice) | **GET** /api/bookings/{bookingId}/open/join-price | |
|
|
13
14
|
|[**getOpenBookings**](#getopenbookings) | **GET** /api/bookings/open | |
|
|
14
15
|
|[**getQuickReservationSlots**](#getquickreservationslots) | **GET** /api/bookings/quick-reservations | |
|
|
@@ -275,6 +276,60 @@ No authorization required
|
|
|
275
276
|
|
|
276
277
|
[[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)
|
|
277
278
|
|
|
279
|
+
# **getJoinPriceEstimate**
|
|
280
|
+
> JoinPriceEstimateResponse getJoinPriceEstimate()
|
|
281
|
+
|
|
282
|
+
Estimation complète du prix pour rejoindre une réservation ouverte Retourne tous les détails: prix de base, réductions, crédits disponibles, et prix final
|
|
283
|
+
|
|
284
|
+
### Example
|
|
285
|
+
|
|
286
|
+
```typescript
|
|
287
|
+
import {
|
|
288
|
+
BookingsApi,
|
|
289
|
+
Configuration
|
|
290
|
+
} from '@tennac-booking/sdk';
|
|
291
|
+
|
|
292
|
+
const configuration = new Configuration();
|
|
293
|
+
const apiInstance = new BookingsApi(configuration);
|
|
294
|
+
|
|
295
|
+
let bookingId: string; // (default to undefined)
|
|
296
|
+
let creditToUseInCents: number; // (optional) (default to undefined)
|
|
297
|
+
|
|
298
|
+
const { status, data } = await apiInstance.getJoinPriceEstimate(
|
|
299
|
+
bookingId,
|
|
300
|
+
creditToUseInCents
|
|
301
|
+
);
|
|
302
|
+
```
|
|
303
|
+
|
|
304
|
+
### Parameters
|
|
305
|
+
|
|
306
|
+
|Name | Type | Description | Notes|
|
|
307
|
+
|------------- | ------------- | ------------- | -------------|
|
|
308
|
+
| **bookingId** | [**string**] | | defaults to undefined|
|
|
309
|
+
| **creditToUseInCents** | [**number**] | | (optional) defaults to undefined|
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
### Return type
|
|
313
|
+
|
|
314
|
+
**JoinPriceEstimateResponse**
|
|
315
|
+
|
|
316
|
+
### Authorization
|
|
317
|
+
|
|
318
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
319
|
+
|
|
320
|
+
### HTTP request headers
|
|
321
|
+
|
|
322
|
+
- **Content-Type**: Not defined
|
|
323
|
+
- **Accept**: application/json
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
### HTTP response details
|
|
327
|
+
| Status code | Description | Response headers |
|
|
328
|
+
|-------------|-------------|------------------|
|
|
329
|
+
|**200** | Estimation complète du prix calculée | - |
|
|
330
|
+
|
|
331
|
+
[[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)
|
|
332
|
+
|
|
278
333
|
# **getOpenBookingJoinPrice**
|
|
279
334
|
> GetOpenEventBookingJoinPrice200Response getOpenBookingJoinPrice()
|
|
280
335
|
|
package/docs/BookingsUserApi.md
CHANGED
|
@@ -7,6 +7,7 @@ All URIs are relative to *http://localhost*
|
|
|
7
7
|
|[**cancelBooking**](#cancelbooking) | **DELETE** /api/bookings/{bookingId} | |
|
|
8
8
|
|[**createBooking**](#createbooking) | **POST** /api/bookings | |
|
|
9
9
|
|[**createOpenBooking**](#createopenbooking) | **POST** /api/bookings/open | |
|
|
10
|
+
|[**getOpenBookingPrice**](#getopenbookingprice) | **POST** /api/bookings/open/booking-price | |
|
|
10
11
|
|[**updateOpenBooking**](#updateopenbooking) | **PATCH** /api/bookings/{bookingId}/open | |
|
|
11
12
|
|
|
12
13
|
# **cancelBooking**
|
|
@@ -164,6 +165,58 @@ const { status, data } = await apiInstance.createOpenBooking(
|
|
|
164
165
|
|
|
165
166
|
[[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)
|
|
166
167
|
|
|
168
|
+
# **getOpenBookingPrice**
|
|
169
|
+
> GetOpenBookingPrice200Response getOpenBookingPrice(getOpenBookingPriceRequest)
|
|
170
|
+
|
|
171
|
+
Calculer le prix d\'une réservation ouverte avec joueurs initiaux
|
|
172
|
+
|
|
173
|
+
### Example
|
|
174
|
+
|
|
175
|
+
```typescript
|
|
176
|
+
import {
|
|
177
|
+
BookingsUserApi,
|
|
178
|
+
Configuration,
|
|
179
|
+
GetOpenBookingPriceRequest
|
|
180
|
+
} from '@tennac-booking/sdk';
|
|
181
|
+
|
|
182
|
+
const configuration = new Configuration();
|
|
183
|
+
const apiInstance = new BookingsUserApi(configuration);
|
|
184
|
+
|
|
185
|
+
let getOpenBookingPriceRequest: GetOpenBookingPriceRequest; //
|
|
186
|
+
|
|
187
|
+
const { status, data } = await apiInstance.getOpenBookingPrice(
|
|
188
|
+
getOpenBookingPriceRequest
|
|
189
|
+
);
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
### Parameters
|
|
193
|
+
|
|
194
|
+
|Name | Type | Description | Notes|
|
|
195
|
+
|------------- | ------------- | ------------- | -------------|
|
|
196
|
+
| **getOpenBookingPriceRequest** | **GetOpenBookingPriceRequest**| | |
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
### Return type
|
|
200
|
+
|
|
201
|
+
**GetOpenBookingPrice200Response**
|
|
202
|
+
|
|
203
|
+
### Authorization
|
|
204
|
+
|
|
205
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
206
|
+
|
|
207
|
+
### HTTP request headers
|
|
208
|
+
|
|
209
|
+
- **Content-Type**: application/json
|
|
210
|
+
- **Accept**: application/json
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
### HTTP response details
|
|
214
|
+
| Status code | Description | Response headers |
|
|
215
|
+
|-------------|-------------|------------------|
|
|
216
|
+
|**200** | Prix de réservation ouverte calculé | - |
|
|
217
|
+
|
|
218
|
+
[[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)
|
|
219
|
+
|
|
167
220
|
# **updateOpenBooking**
|
|
168
221
|
> UpdateOpenBooking200Response updateOpenBooking(updateOpenBookingRequest)
|
|
169
222
|
|
|
@@ -12,6 +12,7 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**maxPlayers** | **number** | Nombre maximal de joueurs souhaités (incluant le créateur) | [default to undefined]
|
|
13
13
|
**description** | **string** | Description de la réservation ouverte | [optional] [default to undefined]
|
|
14
14
|
**minLevel** | **string** | Niveau minimal souhaité pour rejoindre | [optional] [default to undefined]
|
|
15
|
+
**initialPlayerIds** | **Array<string>** | IDs des joueurs inclus de base dans la réservation (en plus du créateur) | [optional] [default to undefined]
|
|
15
16
|
|
|
16
17
|
## Example
|
|
17
18
|
|
|
@@ -26,6 +27,7 @@ const instance: CreateOpenBookingRequest = {
|
|
|
26
27
|
maxPlayers,
|
|
27
28
|
description,
|
|
28
29
|
minLevel,
|
|
30
|
+
initialPlayerIds,
|
|
29
31
|
};
|
|
30
32
|
```
|
|
31
33
|
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# GetOpenBookingPrice200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**totalBasePrice** | **number** | | [default to undefined]
|
|
9
|
+
**playersPrices** | [**Array<PlayerPrice>**](PlayerPrice.md) | | [default to undefined]
|
|
10
|
+
**basePricePerPlayer** | **number** | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { GetOpenBookingPrice200Response } from '@tennac-booking/sdk';
|
|
16
|
+
|
|
17
|
+
const instance: GetOpenBookingPrice200Response = {
|
|
18
|
+
totalBasePrice,
|
|
19
|
+
playersPrices,
|
|
20
|
+
basePricePerPlayer,
|
|
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)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# GetOpenBookingPriceRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**creditsByPlayer** | **{ [key: string]: number; }** | Construct a type with a set of properties K of type T | [optional] [default to undefined]
|
|
9
|
+
**initialPlayerIds** | **Array<string>** | | [optional] [default to undefined]
|
|
10
|
+
**maxPlayers** | **number** | | [default to undefined]
|
|
11
|
+
**slotIds** | **Array<string>** | | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { GetOpenBookingPriceRequest } from '@tennac-booking/sdk';
|
|
17
|
+
|
|
18
|
+
const instance: GetOpenBookingPriceRequest = {
|
|
19
|
+
creditsByPlayer,
|
|
20
|
+
initialPlayerIds,
|
|
21
|
+
maxPlayers,
|
|
22
|
+
slotIds,
|
|
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,38 @@
|
|
|
1
|
+
# JoinPriceEstimateResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**bookingId** | **string** | ID de la réservation | [default to undefined]
|
|
9
|
+
**basePrice** | **number** | Prix de base sans réductions (en centimes) | [default to undefined]
|
|
10
|
+
**priceAfterSubscription** | **number** | Prix après application de l\'abonnement (en centimes) | [default to undefined]
|
|
11
|
+
**subscriptionDiscount** | **number** | Montant de la réduction d\'abonnement (en centimes) | [default to undefined]
|
|
12
|
+
**subscriptionInfo** | [**JoinPriceEstimateResponseSubscriptionInfo**](JoinPriceEstimateResponseSubscriptionInfo.md) | | [optional] [default to undefined]
|
|
13
|
+
**availableCreditsInCents** | **number** | Crédits disponibles pour le joueur dans ce club (en centimes) | [default to undefined]
|
|
14
|
+
**creditToUseInCents** | **number** | Crédits qui seront utilisés (en centimes) | [default to undefined]
|
|
15
|
+
**finalPriceInCents** | **number** | Prix final après toutes les réductions et crédits (en centimes) | [default to undefined]
|
|
16
|
+
**canJoin** | **boolean** | Indique si le joueur peut rejoindre la réservation | [default to undefined]
|
|
17
|
+
**reason** | **string** | Raison si le joueur ne peut pas rejoindre | [optional] [default to undefined]
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import { JoinPriceEstimateResponse } from '@tennac-booking/sdk';
|
|
23
|
+
|
|
24
|
+
const instance: JoinPriceEstimateResponse = {
|
|
25
|
+
bookingId,
|
|
26
|
+
basePrice,
|
|
27
|
+
priceAfterSubscription,
|
|
28
|
+
subscriptionDiscount,
|
|
29
|
+
subscriptionInfo,
|
|
30
|
+
availableCreditsInCents,
|
|
31
|
+
creditToUseInCents,
|
|
32
|
+
finalPriceInCents,
|
|
33
|
+
canJoin,
|
|
34
|
+
reason,
|
|
35
|
+
};
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
[[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
|
+
# JoinPriceEstimateResponseSubscriptionInfo
|
|
2
|
+
|
|
3
|
+
Informations sur l\'abonnement du joueur
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**subscriptionName** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**discountPercentage** | **number** | | [optional] [default to undefined]
|
|
11
|
+
**hasSubscription** | **boolean** | | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { JoinPriceEstimateResponseSubscriptionInfo } from '@tennac-booking/sdk';
|
|
17
|
+
|
|
18
|
+
const instance: JoinPriceEstimateResponseSubscriptionInfo = {
|
|
19
|
+
subscriptionName,
|
|
20
|
+
discountPercentage,
|
|
21
|
+
hasSubscription,
|
|
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)
|
package/docs/OpenBookingInfo.md
CHANGED
|
@@ -20,6 +20,7 @@ Name | Type | Description | Notes
|
|
|
20
20
|
**description** | **string** | Description de la réservation | [optional] [default to undefined]
|
|
21
21
|
**maxPlayers** | **number** | Nombre maximal de joueurs | [optional] [default to undefined]
|
|
22
22
|
**currentPlayersCount** | **number** | Nombre de joueurs actuels | [default to undefined]
|
|
23
|
+
**basePriceToJoin** | **number** | Prix de base pour rejoindre la réservation (en centimes) | [optional] [default to undefined]
|
|
23
24
|
|
|
24
25
|
## Example
|
|
25
26
|
|
|
@@ -42,6 +43,7 @@ const instance: OpenBookingInfo = {
|
|
|
42
43
|
description,
|
|
43
44
|
maxPlayers,
|
|
44
45
|
currentPlayersCount,
|
|
46
|
+
basePriceToJoin,
|
|
45
47
|
};
|
|
46
48
|
```
|
|
47
49
|
|
package/index.ts
CHANGED