@tennac-booking/sdk 1.0.143 → 1.0.145

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.
@@ -6,7 +6,10 @@ All URIs are relative to *http://localhost*
6
6
  |------------- | ------------- | -------------|
7
7
  |[**getBookingHistory**](#getbookinghistory) | **GET** /api/bookings/history/{bookingId} | |
8
8
  |[**getBookingPrice**](#getbookingprice) | **POST** /api/bookings/booking-price | |
9
+ |[**getOpenBookings**](#getopenbookings) | **GET** /api/bookings/open | |
9
10
  |[**getQuickReservationSlots**](#getquickreservationslots) | **GET** /api/bookings/quick-reservations | |
11
+ |[**joinOpenBooking**](#joinopenbooking) | **POST** /api/bookings/{bookingId}/open/join | |
12
+ |[**leaveOpenBooking**](#leaveopenbooking) | **DELETE** /api/bookings/{bookingId}/open/leave | |
10
13
 
11
14
  # **getBookingHistory**
12
15
  > BookingHistoryPopulated getBookingHistory()
@@ -110,6 +113,56 @@ const { status, data } = await apiInstance.getBookingPrice(
110
113
 
111
114
  [[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)
112
115
 
116
+ # **getOpenBookings**
117
+ > GetOpenBookings200Response getOpenBookings()
118
+
119
+
120
+ ### Example
121
+
122
+ ```typescript
123
+ import {
124
+ BookingsApi,
125
+ Configuration
126
+ } from '@tennac-booking/sdk';
127
+
128
+ const configuration = new Configuration();
129
+ const apiInstance = new BookingsApi(configuration);
130
+
131
+ let clubId: string; // (optional) (default to undefined)
132
+
133
+ const { status, data } = await apiInstance.getOpenBookings(
134
+ clubId
135
+ );
136
+ ```
137
+
138
+ ### Parameters
139
+
140
+ |Name | Type | Description | Notes|
141
+ |------------- | ------------- | ------------- | -------------|
142
+ | **clubId** | [**string**] | | (optional) defaults to undefined|
143
+
144
+
145
+ ### Return type
146
+
147
+ **GetOpenBookings200Response**
148
+
149
+ ### Authorization
150
+
151
+ [bearerAuth](../README.md#bearerAuth)
152
+
153
+ ### HTTP request headers
154
+
155
+ - **Content-Type**: Not defined
156
+ - **Accept**: application/json
157
+
158
+
159
+ ### HTTP response details
160
+ | Status code | Description | Response headers |
161
+ |-------------|-------------|------------------|
162
+ |**200** | Liste des réservations ouvertes | - |
163
+
164
+ [[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
+
113
166
  # **getQuickReservationSlots**
114
167
  > QuickReservationResponse getQuickReservationSlots()
115
168
 
@@ -191,3 +244,107 @@ No authorization required
191
244
 
192
245
  [[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)
193
246
 
247
+ # **joinOpenBooking**
248
+ > JoinOpenBookingResponse joinOpenBooking(joinOpenEventBookingRequest)
249
+
250
+
251
+ ### Example
252
+
253
+ ```typescript
254
+ import {
255
+ BookingsApi,
256
+ Configuration,
257
+ JoinOpenEventBookingRequest
258
+ } from '@tennac-booking/sdk';
259
+
260
+ const configuration = new Configuration();
261
+ const apiInstance = new BookingsApi(configuration);
262
+
263
+ let bookingId: string; // (default to undefined)
264
+ let joinOpenEventBookingRequest: JoinOpenEventBookingRequest; //
265
+
266
+ const { status, data } = await apiInstance.joinOpenBooking(
267
+ bookingId,
268
+ joinOpenEventBookingRequest
269
+ );
270
+ ```
271
+
272
+ ### Parameters
273
+
274
+ |Name | Type | Description | Notes|
275
+ |------------- | ------------- | ------------- | -------------|
276
+ | **joinOpenEventBookingRequest** | **JoinOpenEventBookingRequest**| | |
277
+ | **bookingId** | [**string**] | | defaults to undefined|
278
+
279
+
280
+ ### Return type
281
+
282
+ **JoinOpenBookingResponse**
283
+
284
+ ### Authorization
285
+
286
+ [bearerAuth](../README.md#bearerAuth)
287
+
288
+ ### HTTP request headers
289
+
290
+ - **Content-Type**: application/json
291
+ - **Accept**: application/json
292
+
293
+
294
+ ### HTTP response details
295
+ | Status code | Description | Response headers |
296
+ |-------------|-------------|------------------|
297
+ |**200** | Créneau ouvert rejoint | - |
298
+
299
+ [[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)
300
+
301
+ # **leaveOpenBooking**
302
+ > RequestPasswordReset200Response leaveOpenBooking()
303
+
304
+
305
+ ### Example
306
+
307
+ ```typescript
308
+ import {
309
+ BookingsApi,
310
+ Configuration
311
+ } from '@tennac-booking/sdk';
312
+
313
+ const configuration = new Configuration();
314
+ const apiInstance = new BookingsApi(configuration);
315
+
316
+ let bookingId: string; // (default to undefined)
317
+
318
+ const { status, data } = await apiInstance.leaveOpenBooking(
319
+ bookingId
320
+ );
321
+ ```
322
+
323
+ ### Parameters
324
+
325
+ |Name | Type | Description | Notes|
326
+ |------------- | ------------- | ------------- | -------------|
327
+ | **bookingId** | [**string**] | | defaults to undefined|
328
+
329
+
330
+ ### Return type
331
+
332
+ **RequestPasswordReset200Response**
333
+
334
+ ### Authorization
335
+
336
+ [bearerAuth](../README.md#bearerAuth)
337
+
338
+ ### HTTP request headers
339
+
340
+ - **Content-Type**: Not defined
341
+ - **Accept**: application/json
342
+
343
+
344
+ ### HTTP response details
345
+ | Status code | Description | Response headers |
346
+ |-------------|-------------|------------------|
347
+ |**200** | Créneau ouvert quitté | - |
348
+
349
+ [[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)
350
+
@@ -6,6 +6,7 @@ All URIs are relative to *http://localhost*
6
6
  |------------- | ------------- | -------------|
7
7
  |[**cancelBooking**](#cancelbooking) | **DELETE** /api/bookings/{bookingId} | |
8
8
  |[**createBooking**](#createbooking) | **POST** /api/bookings | |
9
+ |[**createOpenBooking**](#createopenbooking) | **POST** /api/bookings/open | |
9
10
 
10
11
  # **cancelBooking**
11
12
  > CancelBookingResponse cancelBooking()
@@ -110,3 +111,55 @@ const { status, data } = await apiInstance.createBooking(
110
111
 
111
112
  [[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)
112
113
 
114
+ # **createOpenBooking**
115
+ > BookingResponse createOpenBooking(createOpenBookingRequest)
116
+
117
+ Créer une réservation ouverte (open slot)
118
+
119
+ ### Example
120
+
121
+ ```typescript
122
+ import {
123
+ BookingsUserApi,
124
+ Configuration,
125
+ CreateOpenBookingRequest
126
+ } from '@tennac-booking/sdk';
127
+
128
+ const configuration = new Configuration();
129
+ const apiInstance = new BookingsUserApi(configuration);
130
+
131
+ let createOpenBookingRequest: CreateOpenBookingRequest; //
132
+
133
+ const { status, data } = await apiInstance.createOpenBooking(
134
+ createOpenBookingRequest
135
+ );
136
+ ```
137
+
138
+ ### Parameters
139
+
140
+ |Name | Type | Description | Notes|
141
+ |------------- | ------------- | ------------- | -------------|
142
+ | **createOpenBookingRequest** | **CreateOpenBookingRequest**| | |
143
+
144
+
145
+ ### Return type
146
+
147
+ **BookingResponse**
148
+
149
+ ### Authorization
150
+
151
+ [bearerAuth](../README.md#bearerAuth)
152
+
153
+ ### HTTP request headers
154
+
155
+ - **Content-Type**: application/json
156
+ - **Accept**: application/json
157
+
158
+
159
+ ### HTTP response details
160
+ | Status code | Description | Response headers |
161
+ |-------------|-------------|------------------|
162
+ |**201** | Réservation ouverte créée avec succès | - |
163
+
164
+ [[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
+
@@ -0,0 +1,51 @@
1
+ # ClubCustomerMeApi
2
+
3
+ All URIs are relative to *http://localhost*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**getClubCustomerSettingsByPlayerId**](#getclubcustomersettingsbyplayerid) | **GET** /api/clubCustomers/club-customer/me/settings | |
8
+
9
+ # **getClubCustomerSettingsByPlayerId**
10
+ > ClubCustomerSettingsResponse getClubCustomerSettingsByPlayerId()
11
+
12
+
13
+ ### Example
14
+
15
+ ```typescript
16
+ import {
17
+ ClubCustomerMeApi,
18
+ Configuration
19
+ } from '@tennac-booking/sdk';
20
+
21
+ const configuration = new Configuration();
22
+ const apiInstance = new ClubCustomerMeApi(configuration);
23
+
24
+ const { status, data } = await apiInstance.getClubCustomerSettingsByPlayerId();
25
+ ```
26
+
27
+ ### Parameters
28
+ This endpoint does not have any parameters.
29
+
30
+
31
+ ### Return type
32
+
33
+ **ClubCustomerSettingsResponse**
34
+
35
+ ### Authorization
36
+
37
+ [bearerAuth](../README.md#bearerAuth)
38
+
39
+ ### HTTP request headers
40
+
41
+ - **Content-Type**: Not defined
42
+ - **Accept**: application/json
43
+
44
+
45
+ ### HTTP response details
46
+ | Status code | Description | Response headers |
47
+ |-------------|-------------|------------------|
48
+ |**200** | Réglages du joueur du club | - |
49
+
50
+ [[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)
51
+
@@ -0,0 +1,38 @@
1
+ # ClubCustomerSettingsResponse
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **userId** | **string** | | [default to undefined]
9
+ **clubId** | **string** | | [default to undefined]
10
+ **credits** | **number** | | [default to undefined]
11
+ **isBanned** | **boolean** | | [default to undefined]
12
+ **isIllimited** | **boolean** | | [default to undefined]
13
+ **isFree** | **boolean** | | [default to undefined]
14
+ **isNoShowForced** | **boolean** | | [default to undefined]
15
+ **paymentMethodSetupCompleted** | **boolean** | | [default to undefined]
16
+ **defaultPaymentMethodId** | **string** | | [default to undefined]
17
+ **subscriptions** | **Array<string>** | | [default to undefined]
18
+
19
+ ## Example
20
+
21
+ ```typescript
22
+ import { ClubCustomerSettingsResponse } from '@tennac-booking/sdk';
23
+
24
+ const instance: ClubCustomerSettingsResponse = {
25
+ userId,
26
+ clubId,
27
+ credits,
28
+ isBanned,
29
+ isIllimited,
30
+ isFree,
31
+ isNoShowForced,
32
+ paymentMethodSetupCompleted,
33
+ defaultPaymentMethodId,
34
+ subscriptions,
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,113 @@
1
+ # ClubCustomerStaffApi
2
+
3
+ All URIs are relative to *http://localhost*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**getClubCustomerSettings**](#getclubcustomersettings) | **GET** /api/clubCustomers/clubCustomer/{userId}/settings | |
8
+ |[**updateClubCustomerSettings**](#updateclubcustomersettings) | **PATCH** /api/clubCustomers/clubCustomer/{userId}/settings | |
9
+
10
+ # **getClubCustomerSettings**
11
+ > ClubCustomerSettingsResponse getClubCustomerSettings()
12
+
13
+
14
+ ### Example
15
+
16
+ ```typescript
17
+ import {
18
+ ClubCustomerStaffApi,
19
+ Configuration
20
+ } from '@tennac-booking/sdk';
21
+
22
+ const configuration = new Configuration();
23
+ const apiInstance = new ClubCustomerStaffApi(configuration);
24
+
25
+ let userId: string; // (default to undefined)
26
+
27
+ const { status, data } = await apiInstance.getClubCustomerSettings(
28
+ userId
29
+ );
30
+ ```
31
+
32
+ ### Parameters
33
+
34
+ |Name | Type | Description | Notes|
35
+ |------------- | ------------- | ------------- | -------------|
36
+ | **userId** | [**string**] | | defaults to undefined|
37
+
38
+
39
+ ### Return type
40
+
41
+ **ClubCustomerSettingsResponse**
42
+
43
+ ### Authorization
44
+
45
+ [bearerAuth](../README.md#bearerAuth)
46
+
47
+ ### HTTP request headers
48
+
49
+ - **Content-Type**: Not defined
50
+ - **Accept**: application/json
51
+
52
+
53
+ ### HTTP response details
54
+ | Status code | Description | Response headers |
55
+ |-------------|-------------|------------------|
56
+ |**200** | Réglages du joueur du club | - |
57
+
58
+ [[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)
59
+
60
+ # **updateClubCustomerSettings**
61
+ > ClubCustomerSettingsResponse updateClubCustomerSettings(clubCustomerSettingsResponse)
62
+
63
+
64
+ ### Example
65
+
66
+ ```typescript
67
+ import {
68
+ ClubCustomerStaffApi,
69
+ Configuration,
70
+ ClubCustomerSettingsResponse
71
+ } from '@tennac-booking/sdk';
72
+
73
+ const configuration = new Configuration();
74
+ const apiInstance = new ClubCustomerStaffApi(configuration);
75
+
76
+ let userId: string; // (default to undefined)
77
+ let clubCustomerSettingsResponse: ClubCustomerSettingsResponse; //
78
+
79
+ const { status, data } = await apiInstance.updateClubCustomerSettings(
80
+ userId,
81
+ clubCustomerSettingsResponse
82
+ );
83
+ ```
84
+
85
+ ### Parameters
86
+
87
+ |Name | Type | Description | Notes|
88
+ |------------- | ------------- | ------------- | -------------|
89
+ | **clubCustomerSettingsResponse** | **ClubCustomerSettingsResponse**| | |
90
+ | **userId** | [**string**] | | defaults to undefined|
91
+
92
+
93
+ ### Return type
94
+
95
+ **ClubCustomerSettingsResponse**
96
+
97
+ ### Authorization
98
+
99
+ [bearerAuth](../README.md#bearerAuth)
100
+
101
+ ### HTTP request headers
102
+
103
+ - **Content-Type**: application/json
104
+ - **Accept**: application/json
105
+
106
+
107
+ ### HTTP response details
108
+ | Status code | Description | Response headers |
109
+ |-------------|-------------|------------------|
110
+ |**200** | Réglages mis à jour | - |
111
+
112
+ [[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)
113
+
package/docs/ClubsApi.md CHANGED
@@ -15,6 +15,7 @@ All URIs are relative to *http://localhost*
15
15
  |[**getClubUsersById**](#getclubusersbyid) | **GET** /api/clubs/{id}/users | |
16
16
  |[**getClubsWithVerificationDomains**](#getclubswithverificationdomains) | **GET** /api/clubs/verification-domains | |
17
17
  |[**getCourtsByClubAndSportById**](#getcourtsbyclubandsportbyid) | **GET** /api/clubs/{id}/sports/{sportId}/courts | |
18
+ |[**getPublicClubInfo**](#getpublicclubinfo) | **GET** /api/clubs/{clubId} | |
18
19
  |[**getPublishedActualities**](#getpublishedactualities) | **GET** /api/clubs/{id}/actualities | |
19
20
  |[**getSlotsByClubById**](#getslotsbyclubbyid) | **GET** /api/clubs/{id}/slots | |
20
21
  |[**getSportsByClubById**](#getsportsbyclubbyid) | **GET** /api/clubs/{id}/sports | |
@@ -571,6 +572,60 @@ No authorization required
571
572
 
572
573
  [[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)
573
574
 
575
+ # **getPublicClubInfo**
576
+ > ClubResponse getPublicClubInfo()
577
+
578
+ Récupère les informations publiques d\'un club en fonction de son ID
579
+
580
+ ### Example
581
+
582
+ ```typescript
583
+ import {
584
+ ClubsApi,
585
+ Configuration
586
+ } from '@tennac-booking/sdk';
587
+
588
+ const configuration = new Configuration();
589
+ const apiInstance = new ClubsApi(configuration);
590
+
591
+ let clubId: string; // (default to undefined)
592
+
593
+ const { status, data } = await apiInstance.getPublicClubInfo(
594
+ clubId
595
+ );
596
+ ```
597
+
598
+ ### Parameters
599
+
600
+ |Name | Type | Description | Notes|
601
+ |------------- | ------------- | ------------- | -------------|
602
+ | **clubId** | [**string**] | | defaults to undefined|
603
+
604
+
605
+ ### Return type
606
+
607
+ **ClubResponse**
608
+
609
+ ### Authorization
610
+
611
+ No authorization required
612
+
613
+ ### HTTP request headers
614
+
615
+ - **Content-Type**: Not defined
616
+ - **Accept**: application/json
617
+
618
+
619
+ ### HTTP response details
620
+ | Status code | Description | Response headers |
621
+ |-------------|-------------|------------------|
622
+ |**200** | Informations du club | - |
623
+ |**400** | clubId invalide | - |
624
+ |**404** | Club non trouvé | - |
625
+ |**500** | Erreur serveur | - |
626
+
627
+ [[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)
628
+
574
629
  # **getPublishedActualities**
575
630
  > GetActualities200Response getPublishedActualities()
576
631
 
@@ -11,6 +11,8 @@ Name | Type | Description | Notes
11
11
  **paymentMethod** | [**PaymentMethod**](PaymentMethod.md) | | [optional] [default to undefined]
12
12
  **useDefaultPaymentMethod** | **boolean** | Indique si l\'utilisateur veut utiliser sa méthode de paiement par défaut | [optional] [default to undefined]
13
13
  **creditToUseInCents** | **number** | | [optional] [default to undefined]
14
+ **maxPlayersDesired** | **number** | Pour créneau ouvert: nombre maximal de joueurs souhaités (incluant le créateur) | [optional] [default to undefined]
15
+ **maxPlayers** | **number** | Pour créneau ouvert: nombre maximal de joueurs total (incluant le créateur) - alias de maxPlayersDesired | [optional] [default to undefined]
14
16
 
15
17
  ## Example
16
18
 
@@ -24,6 +26,8 @@ const instance: CreateBookingRequest = {
24
26
  paymentMethod,
25
27
  useDefaultPaymentMethod,
26
28
  creditToUseInCents,
29
+ maxPlayersDesired,
30
+ maxPlayers,
27
31
  };
28
32
  ```
29
33
 
@@ -26,6 +26,7 @@ Name | Type | Description | Notes
26
26
  **subscriberPrices** | [**Array<SubscriberPrice>**](SubscriberPrice.md) | | [optional] [default to undefined]
27
27
  **levels** | **Array<number | null>** | | [optional] [default to undefined]
28
28
  **sponsors** | [**Array<EventSponsor>**](EventSponsor.md) | | [optional] [default to undefined]
29
+ **registrationOpeningDate** | **string** | | [default to undefined]
29
30
  **visibilityType** | **string** | | [default to undefined]
30
31
 
31
32
  ## Example
@@ -55,6 +56,7 @@ const instance: CreateEventRequest = {
55
56
  subscriberPrices,
56
57
  levels,
57
58
  sponsors,
59
+ registrationOpeningDate,
58
60
  visibilityType,
59
61
  };
60
62
  ```
@@ -0,0 +1,28 @@
1
+ # CreateOpenBookingRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **slotIds** | **Array<string>** | ID du créneau à réserver | [default to undefined]
9
+ **paymentMethod** | [**PaymentMethod**](PaymentMethod.md) | | [optional] [default to undefined]
10
+ **useDefaultPaymentMethod** | **boolean** | Indique si l\'utilisateur veut utiliser sa méthode de paiement par défaut | [optional] [default to undefined]
11
+ **creditToUseInCents** | **number** | Crédit à utiliser en centimes | [optional] [default to undefined]
12
+ **maxPlayers** | **number** | Nombre maximal de joueurs souhaités (incluant le créateur) | [default to undefined]
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import { CreateOpenBookingRequest } from '@tennac-booking/sdk';
18
+
19
+ const instance: CreateOpenBookingRequest = {
20
+ slotIds,
21
+ paymentMethod,
22
+ useDefaultPaymentMethod,
23
+ creditToUseInCents,
24
+ maxPlayers,
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)
@@ -28,6 +28,7 @@ Name | Type | Description | Notes
28
28
  **visibilityType** | **string** | | [default to undefined]
29
29
  **levels** | **Array<string | null>** | | [optional] [default to undefined]
30
30
  **sponsors** | [**Array<EventSponsor>**](EventSponsor.md) | | [optional] [default to undefined]
31
+ **registrationOpeningDate** | **string** | | [default to undefined]
31
32
  **createdBy** | **string** | | [optional] [default to undefined]
32
33
  **isActive** | **boolean** | | [default to undefined]
33
34
  **createdAt** | **string** | | [default to undefined]
@@ -62,6 +63,7 @@ const instance: EventResponse = {
62
63
  visibilityType,
63
64
  levels,
64
65
  sponsors,
66
+ registrationOpeningDate,
65
67
  createdBy,
66
68
  isActive,
67
69
  createdAt,