@tennac-booking/sdk 1.0.175 → 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 +409 -398
- package/README.md +18 -3
- package/api.ts +843 -19
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +656 -9
- package/dist/api.js +273 -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 +656 -9
- package/dist/esm/api.js +273 -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 +57 -2
- package/docs/BookingsUserApi.md +109 -0
- package/docs/CreateOpenBookingRequest.md +6 -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 +50 -0
- package/docs/OpenBookingPlayerInfo.md +26 -0
- package/docs/OpenBookingSlotInfo.md +24 -0
- package/docs/OpenBookingSportInfo.md +24 -0
- package/docs/{GetOpenBookings200Response.md → OpenBookingsResponse.md} +4 -4
- package/docs/UpdateOpenBooking200Response.md +22 -0
- package/docs/UpdateOpenBookingRequest.md +22 -0
- package/docs/UsersApi.md +55 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/docs/BookingsUserApi.md
CHANGED
|
@@ -7,6 +7,8 @@ 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 | |
|
|
11
|
+
|[**updateOpenBooking**](#updateopenbooking) | **PATCH** /api/bookings/{bookingId}/open | |
|
|
10
12
|
|
|
11
13
|
# **cancelBooking**
|
|
12
14
|
> CancelBookingResponse cancelBooking()
|
|
@@ -163,3 +165,110 @@ const { status, data } = await apiInstance.createOpenBooking(
|
|
|
163
165
|
|
|
164
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)
|
|
165
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
|
+
|
|
220
|
+
# **updateOpenBooking**
|
|
221
|
+
> UpdateOpenBooking200Response updateOpenBooking(updateOpenBookingRequest)
|
|
222
|
+
|
|
223
|
+
Mettre à jour une réservation ouverte (description et niveau minimal)
|
|
224
|
+
|
|
225
|
+
### Example
|
|
226
|
+
|
|
227
|
+
```typescript
|
|
228
|
+
import {
|
|
229
|
+
BookingsUserApi,
|
|
230
|
+
Configuration,
|
|
231
|
+
UpdateOpenBookingRequest
|
|
232
|
+
} from '@tennac-booking/sdk';
|
|
233
|
+
|
|
234
|
+
const configuration = new Configuration();
|
|
235
|
+
const apiInstance = new BookingsUserApi(configuration);
|
|
236
|
+
|
|
237
|
+
let bookingId: string; // (default to undefined)
|
|
238
|
+
let updateOpenBookingRequest: UpdateOpenBookingRequest; //
|
|
239
|
+
|
|
240
|
+
const { status, data } = await apiInstance.updateOpenBooking(
|
|
241
|
+
bookingId,
|
|
242
|
+
updateOpenBookingRequest
|
|
243
|
+
);
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
### Parameters
|
|
247
|
+
|
|
248
|
+
|Name | Type | Description | Notes|
|
|
249
|
+
|------------- | ------------- | ------------- | -------------|
|
|
250
|
+
| **updateOpenBookingRequest** | **UpdateOpenBookingRequest**| | |
|
|
251
|
+
| **bookingId** | [**string**] | | defaults to undefined|
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
### Return type
|
|
255
|
+
|
|
256
|
+
**UpdateOpenBooking200Response**
|
|
257
|
+
|
|
258
|
+
### Authorization
|
|
259
|
+
|
|
260
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
261
|
+
|
|
262
|
+
### HTTP request headers
|
|
263
|
+
|
|
264
|
+
- **Content-Type**: application/json
|
|
265
|
+
- **Accept**: application/json
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
### HTTP response details
|
|
269
|
+
| Status code | Description | Response headers |
|
|
270
|
+
|-------------|-------------|------------------|
|
|
271
|
+
|**200** | Réservation ouverte mise à jour avec succès | - |
|
|
272
|
+
|
|
273
|
+
[[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)
|
|
274
|
+
|
|
@@ -10,6 +10,9 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**useDefaultPaymentMethod** | **boolean** | Indique si l\'utilisateur veut utiliser sa méthode de paiement par défaut | [optional] [default to undefined]
|
|
11
11
|
**creditToUseInCents** | **number** | Crédit à utiliser en centimes | [optional] [default to undefined]
|
|
12
12
|
**maxPlayers** | **number** | Nombre maximal de joueurs souhaités (incluant le créateur) | [default to undefined]
|
|
13
|
+
**description** | **string** | Description de la réservation ouverte | [optional] [default to undefined]
|
|
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]
|
|
13
16
|
|
|
14
17
|
## Example
|
|
15
18
|
|
|
@@ -22,6 +25,9 @@ const instance: CreateOpenBookingRequest = {
|
|
|
22
25
|
useDefaultPaymentMethod,
|
|
23
26
|
creditToUseInCents,
|
|
24
27
|
maxPlayers,
|
|
28
|
+
description,
|
|
29
|
+
minLevel,
|
|
30
|
+
initialPlayerIds,
|
|
25
31
|
};
|
|
26
32
|
```
|
|
27
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)
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# OpenBookingInfo
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | ID de la réservation | [default to undefined]
|
|
9
|
+
**clubId** | **string** | ID du club | [default to undefined]
|
|
10
|
+
**userId** | **string** | ID de l\'utilisateur créateur | [default to undefined]
|
|
11
|
+
**players** | [**Array<OpenBookingPlayerInfo>**](OpenBookingPlayerInfo.md) | Liste des joueurs avec leurs infos | [default to undefined]
|
|
12
|
+
**status** | [**BookingStatus**](BookingStatus.md) | | [default to undefined]
|
|
13
|
+
**totalPrice** | **number** | Prix total en euros | [default to undefined]
|
|
14
|
+
**slots** | [**Array<OpenBookingSlotInfo>**](OpenBookingSlotInfo.md) | Informations des créneaux | [default to undefined]
|
|
15
|
+
**isCreatorPayingAll** | **boolean** | Indique si le créateur paie pour tous | [default to undefined]
|
|
16
|
+
**createdAt** | **string** | Date de création | [default to undefined]
|
|
17
|
+
**updatedAt** | **string** | Date de mise à jour | [default to undefined]
|
|
18
|
+
**sport** | [**OpenBookingSportInfo**](OpenBookingSportInfo.md) | | [optional] [default to undefined]
|
|
19
|
+
**minLevel** | **string** | Niveau minimal souhaité | [optional] [default to undefined]
|
|
20
|
+
**description** | **string** | Description de la réservation | [optional] [default to undefined]
|
|
21
|
+
**maxPlayers** | **number** | Nombre maximal de joueurs | [optional] [default to undefined]
|
|
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]
|
|
24
|
+
|
|
25
|
+
## Example
|
|
26
|
+
|
|
27
|
+
```typescript
|
|
28
|
+
import { OpenBookingInfo } from '@tennac-booking/sdk';
|
|
29
|
+
|
|
30
|
+
const instance: OpenBookingInfo = {
|
|
31
|
+
id,
|
|
32
|
+
clubId,
|
|
33
|
+
userId,
|
|
34
|
+
players,
|
|
35
|
+
status,
|
|
36
|
+
totalPrice,
|
|
37
|
+
slots,
|
|
38
|
+
isCreatorPayingAll,
|
|
39
|
+
createdAt,
|
|
40
|
+
updatedAt,
|
|
41
|
+
sport,
|
|
42
|
+
minLevel,
|
|
43
|
+
description,
|
|
44
|
+
maxPlayers,
|
|
45
|
+
currentPlayersCount,
|
|
46
|
+
basePriceToJoin,
|
|
47
|
+
};
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
[[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
|
+
# OpenBookingPlayerInfo
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | ID du joueur | [default to undefined]
|
|
9
|
+
**firstName** | **string** | Prénom | [default to undefined]
|
|
10
|
+
**lastName** | **string** | Nom | [default to undefined]
|
|
11
|
+
**profilePicture** | **string** | Photo de profil | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { OpenBookingPlayerInfo } from '@tennac-booking/sdk';
|
|
17
|
+
|
|
18
|
+
const instance: OpenBookingPlayerInfo = {
|
|
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)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# OpenBookingSlotInfo
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | ID du slot | [default to undefined]
|
|
9
|
+
**startDate** | **string** | Date de début ISO | [default to undefined]
|
|
10
|
+
**endDate** | **string** | Date de fin ISO | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { OpenBookingSlotInfo } from '@tennac-booking/sdk';
|
|
16
|
+
|
|
17
|
+
const instance: OpenBookingSlotInfo = {
|
|
18
|
+
id,
|
|
19
|
+
startDate,
|
|
20
|
+
endDate,
|
|
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,24 @@
|
|
|
1
|
+
# OpenBookingSportInfo
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | ID du sport | [default to undefined]
|
|
9
|
+
**key** | **string** | Clé du sport | [default to undefined]
|
|
10
|
+
**name** | **string** | Nom du sport | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { OpenBookingSportInfo } from '@tennac-booking/sdk';
|
|
16
|
+
|
|
17
|
+
const instance: OpenBookingSportInfo = {
|
|
18
|
+
id,
|
|
19
|
+
key,
|
|
20
|
+
name,
|
|
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)
|
|
@@ -1,18 +1,18 @@
|
|
|
1
|
-
#
|
|
1
|
+
# OpenBookingsResponse
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**bookings** | [**Array<
|
|
8
|
+
**bookings** | [**Array<OpenBookingInfo>**](OpenBookingInfo.md) | Liste des réservations ouvertes | [default to undefined]
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
13
|
-
import {
|
|
13
|
+
import { OpenBookingsResponse } from '@tennac-booking/sdk';
|
|
14
14
|
|
|
15
|
-
const instance:
|
|
15
|
+
const instance: OpenBookingsResponse = {
|
|
16
16
|
bookings,
|
|
17
17
|
};
|
|
18
18
|
```
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# UpdateOpenBooking200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**booking** | [**BookingInfo**](BookingInfo.md) | | [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { UpdateOpenBooking200Response } from '@tennac-booking/sdk';
|
|
15
|
+
|
|
16
|
+
const instance: UpdateOpenBooking200Response = {
|
|
17
|
+
booking,
|
|
18
|
+
message,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[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,22 @@
|
|
|
1
|
+
# UpdateOpenBookingRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**description** | **string** | Description de la réservation ouverte | [optional] [default to undefined]
|
|
9
|
+
**minLevel** | **string** | Niveau minimal souhaité pour rejoindre | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { UpdateOpenBookingRequest } from '@tennac-booking/sdk';
|
|
15
|
+
|
|
16
|
+
const instance: UpdateOpenBookingRequest = {
|
|
17
|
+
description,
|
|
18
|
+
minLevel,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[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/UsersApi.md
CHANGED
|
@@ -25,6 +25,7 @@ All URIs are relative to *http://localhost*
|
|
|
25
25
|
|[**getUserBookings**](#getuserbookings) | **GET** /api/users/me/bookings | |
|
|
26
26
|
|[**getUserEvents**](#getuserevents) | **GET** /api/users/me/events | |
|
|
27
27
|
|[**getUserProfileById**](#getuserprofilebyid) | **GET** /api/users/profile/{id} | |
|
|
28
|
+
|[**leaveBooking**](#leavebooking) | **DELETE** /api/users/me/bookings/{bookingId}/leave | |
|
|
28
29
|
|[**listPlayers**](#listplayers) | **GET** /api/users/players | |
|
|
29
30
|
|[**login**](#login) | **POST** /api/users/login | |
|
|
30
31
|
|[**loginClubMember**](#loginclubmember) | **POST** /api/users/club-members/login | |
|
|
@@ -1076,6 +1077,60 @@ const { status, data } = await apiInstance.getUserProfileById(
|
|
|
1076
1077
|
|
|
1077
1078
|
[[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)
|
|
1078
1079
|
|
|
1080
|
+
# **leaveBooking**
|
|
1081
|
+
> LeaveEventWaitList200Response leaveBooking()
|
|
1082
|
+
|
|
1083
|
+
Quitter une réservation
|
|
1084
|
+
|
|
1085
|
+
### Example
|
|
1086
|
+
|
|
1087
|
+
```typescript
|
|
1088
|
+
import {
|
|
1089
|
+
UsersApi,
|
|
1090
|
+
Configuration
|
|
1091
|
+
} from '@tennac-booking/sdk';
|
|
1092
|
+
|
|
1093
|
+
const configuration = new Configuration();
|
|
1094
|
+
const apiInstance = new UsersApi(configuration);
|
|
1095
|
+
|
|
1096
|
+
let bookingId: string; // (default to undefined)
|
|
1097
|
+
|
|
1098
|
+
const { status, data } = await apiInstance.leaveBooking(
|
|
1099
|
+
bookingId
|
|
1100
|
+
);
|
|
1101
|
+
```
|
|
1102
|
+
|
|
1103
|
+
### Parameters
|
|
1104
|
+
|
|
1105
|
+
|Name | Type | Description | Notes|
|
|
1106
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1107
|
+
| **bookingId** | [**string**] | | defaults to undefined|
|
|
1108
|
+
|
|
1109
|
+
|
|
1110
|
+
### Return type
|
|
1111
|
+
|
|
1112
|
+
**LeaveEventWaitList200Response**
|
|
1113
|
+
|
|
1114
|
+
### Authorization
|
|
1115
|
+
|
|
1116
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1117
|
+
|
|
1118
|
+
### HTTP request headers
|
|
1119
|
+
|
|
1120
|
+
- **Content-Type**: Not defined
|
|
1121
|
+
- **Accept**: application/json
|
|
1122
|
+
|
|
1123
|
+
|
|
1124
|
+
### HTTP response details
|
|
1125
|
+
| Status code | Description | Response headers |
|
|
1126
|
+
|-------------|-------------|------------------|
|
|
1127
|
+
|**200** | Réservation quittée avec succès | - |
|
|
1128
|
+
|**400** | Requête invalide | - |
|
|
1129
|
+
|**404** | Réservation non trouvée | - |
|
|
1130
|
+
|**500** | Erreur serveur | - |
|
|
1131
|
+
|
|
1132
|
+
[[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)
|
|
1133
|
+
|
|
1079
1134
|
# **listPlayers**
|
|
1080
1135
|
> PlayerListResponse listPlayers()
|
|
1081
1136
|
|
package/index.ts
CHANGED