@tennac-booking/sdk 1.0.174 → 1.0.175

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.
@@ -0,0 +1,499 @@
1
+ # WaitListApi
2
+
3
+ All URIs are relative to *http://localhost*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**getBookingPosition**](#getbookingposition) | **GET** /api/waitlist/booking/{bookingId}/position | |
8
+ |[**getEventBookingPosition**](#geteventbookingposition) | **GET** /api/waitlist/event-booking/{eventBookingId}/position | |
9
+ |[**getEventPosition**](#geteventposition) | **GET** /api/waitlist/event/{eventId}/position | |
10
+ |[**joinBookingWaitList**](#joinbookingwaitlist) | **POST** /api/waitlist/booking/{bookingId}/join | |
11
+ |[**joinEventBookingWaitList**](#joineventbookingwaitlist) | **POST** /api/waitlist/event-booking/{eventBookingId}/join | |
12
+ |[**joinEventWaitList**](#joineventwaitlist) | **POST** /api/waitlist/event/{eventId}/join | |
13
+ |[**leaveBookingWaitList**](#leavebookingwaitlist) | **DELETE** /api/waitlist/booking/{bookingId}/leave | |
14
+ |[**leaveEventBookingWaitList**](#leaveeventbookingwaitlist) | **DELETE** /api/waitlist/event-booking/{eventBookingId}/leave | |
15
+ |[**leaveEventWaitList**](#leaveeventwaitlist) | **DELETE** /api/waitlist/event/{eventId}/leave | |
16
+
17
+ # **getBookingPosition**
18
+ > WaitListPositionResponse getBookingPosition()
19
+
20
+ Obtenir la position actuelle dans la file d\'attente d\'un booking
21
+
22
+ ### Example
23
+
24
+ ```typescript
25
+ import {
26
+ WaitListApi,
27
+ Configuration
28
+ } from '@tennac-booking/sdk';
29
+
30
+ const configuration = new Configuration();
31
+ const apiInstance = new WaitListApi(configuration);
32
+
33
+ let bookingId: string; // (default to undefined)
34
+
35
+ const { status, data } = await apiInstance.getBookingPosition(
36
+ bookingId
37
+ );
38
+ ```
39
+
40
+ ### Parameters
41
+
42
+ |Name | Type | Description | Notes|
43
+ |------------- | ------------- | ------------- | -------------|
44
+ | **bookingId** | [**string**] | | defaults to undefined|
45
+
46
+
47
+ ### Return type
48
+
49
+ **WaitListPositionResponse**
50
+
51
+ ### Authorization
52
+
53
+ [bearerAuth](../README.md#bearerAuth)
54
+
55
+ ### HTTP request headers
56
+
57
+ - **Content-Type**: Not defined
58
+ - **Accept**: application/json
59
+
60
+
61
+ ### HTTP response details
62
+ | Status code | Description | Response headers |
63
+ |-------------|-------------|------------------|
64
+ |**200** | Position récupérée avec succès | - |
65
+ |**404** | Non trouvé dans la file d\'attente | - |
66
+ |**500** | Erreur serveur | - |
67
+
68
+ [[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)
69
+
70
+ # **getEventBookingPosition**
71
+ > WaitListPositionResponse getEventBookingPosition()
72
+
73
+ Obtenir la position actuelle dans la file d\'attente d\'un eventBooking
74
+
75
+ ### Example
76
+
77
+ ```typescript
78
+ import {
79
+ WaitListApi,
80
+ Configuration
81
+ } from '@tennac-booking/sdk';
82
+
83
+ const configuration = new Configuration();
84
+ const apiInstance = new WaitListApi(configuration);
85
+
86
+ let eventBookingId: string; // (default to undefined)
87
+
88
+ const { status, data } = await apiInstance.getEventBookingPosition(
89
+ eventBookingId
90
+ );
91
+ ```
92
+
93
+ ### Parameters
94
+
95
+ |Name | Type | Description | Notes|
96
+ |------------- | ------------- | ------------- | -------------|
97
+ | **eventBookingId** | [**string**] | | defaults to undefined|
98
+
99
+
100
+ ### Return type
101
+
102
+ **WaitListPositionResponse**
103
+
104
+ ### Authorization
105
+
106
+ [bearerAuth](../README.md#bearerAuth)
107
+
108
+ ### HTTP request headers
109
+
110
+ - **Content-Type**: Not defined
111
+ - **Accept**: application/json
112
+
113
+
114
+ ### HTTP response details
115
+ | Status code | Description | Response headers |
116
+ |-------------|-------------|------------------|
117
+ |**200** | Position récupérée avec succès | - |
118
+ |**404** | Non trouvé dans la file d\'attente | - |
119
+ |**500** | Erreur serveur | - |
120
+
121
+ [[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)
122
+
123
+ # **getEventPosition**
124
+ > WaitListPositionResponse getEventPosition()
125
+
126
+ Obtenir la position actuelle dans la file d\'attente d\'un event
127
+
128
+ ### Example
129
+
130
+ ```typescript
131
+ import {
132
+ WaitListApi,
133
+ Configuration
134
+ } from '@tennac-booking/sdk';
135
+
136
+ const configuration = new Configuration();
137
+ const apiInstance = new WaitListApi(configuration);
138
+
139
+ let eventId: string; // (default to undefined)
140
+
141
+ const { status, data } = await apiInstance.getEventPosition(
142
+ eventId
143
+ );
144
+ ```
145
+
146
+ ### Parameters
147
+
148
+ |Name | Type | Description | Notes|
149
+ |------------- | ------------- | ------------- | -------------|
150
+ | **eventId** | [**string**] | | defaults to undefined|
151
+
152
+
153
+ ### Return type
154
+
155
+ **WaitListPositionResponse**
156
+
157
+ ### Authorization
158
+
159
+ [bearerAuth](../README.md#bearerAuth)
160
+
161
+ ### HTTP request headers
162
+
163
+ - **Content-Type**: Not defined
164
+ - **Accept**: application/json
165
+
166
+
167
+ ### HTTP response details
168
+ | Status code | Description | Response headers |
169
+ |-------------|-------------|------------------|
170
+ |**200** | Position récupérée avec succès | - |
171
+ |**404** | Non trouvé dans la file d\'attente | - |
172
+ |**500** | Erreur serveur | - |
173
+
174
+ [[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)
175
+
176
+ # **joinBookingWaitList**
177
+ > JoinEventWaitList200Response joinBookingWaitList()
178
+
179
+ Rejoindre la file d\'attente pour un booking (créneau ouvert)
180
+
181
+ ### Example
182
+
183
+ ```typescript
184
+ import {
185
+ WaitListApi,
186
+ Configuration
187
+ } from '@tennac-booking/sdk';
188
+
189
+ const configuration = new Configuration();
190
+ const apiInstance = new WaitListApi(configuration);
191
+
192
+ let bookingId: string; // (default to undefined)
193
+
194
+ const { status, data } = await apiInstance.joinBookingWaitList(
195
+ bookingId
196
+ );
197
+ ```
198
+
199
+ ### Parameters
200
+
201
+ |Name | Type | Description | Notes|
202
+ |------------- | ------------- | ------------- | -------------|
203
+ | **bookingId** | [**string**] | | defaults to undefined|
204
+
205
+
206
+ ### Return type
207
+
208
+ **JoinEventWaitList200Response**
209
+
210
+ ### Authorization
211
+
212
+ [bearerAuth](../README.md#bearerAuth)
213
+
214
+ ### HTTP request headers
215
+
216
+ - **Content-Type**: Not defined
217
+ - **Accept**: application/json
218
+
219
+
220
+ ### HTTP response details
221
+ | Status code | Description | Response headers |
222
+ |-------------|-------------|------------------|
223
+ |**200** | Ajouté à la file d\'attente avec succès | - |
224
+ |**400** | Requête invalide | - |
225
+ |**404** | Réservation non trouvée | - |
226
+ |**500** | Erreur serveur | - |
227
+
228
+ [[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)
229
+
230
+ # **joinEventBookingWaitList**
231
+ > JoinEventWaitList200Response joinEventBookingWaitList()
232
+
233
+ Rejoindre la file d\'attente pour un eventBooking (event en équipe avec créneau ouvert)
234
+
235
+ ### Example
236
+
237
+ ```typescript
238
+ import {
239
+ WaitListApi,
240
+ Configuration
241
+ } from '@tennac-booking/sdk';
242
+
243
+ const configuration = new Configuration();
244
+ const apiInstance = new WaitListApi(configuration);
245
+
246
+ let eventBookingId: string; // (default to undefined)
247
+
248
+ const { status, data } = await apiInstance.joinEventBookingWaitList(
249
+ eventBookingId
250
+ );
251
+ ```
252
+
253
+ ### Parameters
254
+
255
+ |Name | Type | Description | Notes|
256
+ |------------- | ------------- | ------------- | -------------|
257
+ | **eventBookingId** | [**string**] | | defaults to undefined|
258
+
259
+
260
+ ### Return type
261
+
262
+ **JoinEventWaitList200Response**
263
+
264
+ ### Authorization
265
+
266
+ [bearerAuth](../README.md#bearerAuth)
267
+
268
+ ### HTTP request headers
269
+
270
+ - **Content-Type**: Not defined
271
+ - **Accept**: application/json
272
+
273
+
274
+ ### HTTP response details
275
+ | Status code | Description | Response headers |
276
+ |-------------|-------------|------------------|
277
+ |**200** | Ajouté à la file d\'attente avec succès | - |
278
+ |**400** | Requête invalide | - |
279
+ |**404** | Inscription événement non trouvée | - |
280
+ |**500** | Erreur serveur | - |
281
+
282
+ [[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)
283
+
284
+ # **joinEventWaitList**
285
+ > JoinEventWaitList200Response joinEventWaitList()
286
+
287
+ Rejoindre la file d\'attente pour un event (participation solo)
288
+
289
+ ### Example
290
+
291
+ ```typescript
292
+ import {
293
+ WaitListApi,
294
+ Configuration
295
+ } from '@tennac-booking/sdk';
296
+
297
+ const configuration = new Configuration();
298
+ const apiInstance = new WaitListApi(configuration);
299
+
300
+ let eventId: string; // (default to undefined)
301
+
302
+ const { status, data } = await apiInstance.joinEventWaitList(
303
+ eventId
304
+ );
305
+ ```
306
+
307
+ ### Parameters
308
+
309
+ |Name | Type | Description | Notes|
310
+ |------------- | ------------- | ------------- | -------------|
311
+ | **eventId** | [**string**] | | defaults to undefined|
312
+
313
+
314
+ ### Return type
315
+
316
+ **JoinEventWaitList200Response**
317
+
318
+ ### Authorization
319
+
320
+ [bearerAuth](../README.md#bearerAuth)
321
+
322
+ ### HTTP request headers
323
+
324
+ - **Content-Type**: Not defined
325
+ - **Accept**: application/json
326
+
327
+
328
+ ### HTTP response details
329
+ | Status code | Description | Response headers |
330
+ |-------------|-------------|------------------|
331
+ |**200** | Ajouté à la file d\'attente avec succès | - |
332
+ |**400** | Requête invalide | - |
333
+ |**404** | Événement non trouvé | - |
334
+ |**500** | Erreur serveur | - |
335
+
336
+ [[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)
337
+
338
+ # **leaveBookingWaitList**
339
+ > LeaveEventWaitList200Response leaveBookingWaitList()
340
+
341
+ Quitter la file d\'attente d\'un booking
342
+
343
+ ### Example
344
+
345
+ ```typescript
346
+ import {
347
+ WaitListApi,
348
+ Configuration
349
+ } from '@tennac-booking/sdk';
350
+
351
+ const configuration = new Configuration();
352
+ const apiInstance = new WaitListApi(configuration);
353
+
354
+ let bookingId: string; // (default to undefined)
355
+
356
+ const { status, data } = await apiInstance.leaveBookingWaitList(
357
+ bookingId
358
+ );
359
+ ```
360
+
361
+ ### Parameters
362
+
363
+ |Name | Type | Description | Notes|
364
+ |------------- | ------------- | ------------- | -------------|
365
+ | **bookingId** | [**string**] | | defaults to undefined|
366
+
367
+
368
+ ### Return type
369
+
370
+ **LeaveEventWaitList200Response**
371
+
372
+ ### Authorization
373
+
374
+ [bearerAuth](../README.md#bearerAuth)
375
+
376
+ ### HTTP request headers
377
+
378
+ - **Content-Type**: Not defined
379
+ - **Accept**: application/json
380
+
381
+
382
+ ### HTTP response details
383
+ | Status code | Description | Response headers |
384
+ |-------------|-------------|------------------|
385
+ |**200** | Retiré de la file d\'attente avec succès | - |
386
+ |**400** | Requête invalide | - |
387
+ |**404** | Non trouvé dans la file d\'attente | - |
388
+ |**500** | Erreur serveur | - |
389
+
390
+ [[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)
391
+
392
+ # **leaveEventBookingWaitList**
393
+ > LeaveEventWaitList200Response leaveEventBookingWaitList()
394
+
395
+ Quitter la file d\'attente d\'un eventBooking
396
+
397
+ ### Example
398
+
399
+ ```typescript
400
+ import {
401
+ WaitListApi,
402
+ Configuration
403
+ } from '@tennac-booking/sdk';
404
+
405
+ const configuration = new Configuration();
406
+ const apiInstance = new WaitListApi(configuration);
407
+
408
+ let eventBookingId: string; // (default to undefined)
409
+
410
+ const { status, data } = await apiInstance.leaveEventBookingWaitList(
411
+ eventBookingId
412
+ );
413
+ ```
414
+
415
+ ### Parameters
416
+
417
+ |Name | Type | Description | Notes|
418
+ |------------- | ------------- | ------------- | -------------|
419
+ | **eventBookingId** | [**string**] | | defaults to undefined|
420
+
421
+
422
+ ### Return type
423
+
424
+ **LeaveEventWaitList200Response**
425
+
426
+ ### Authorization
427
+
428
+ [bearerAuth](../README.md#bearerAuth)
429
+
430
+ ### HTTP request headers
431
+
432
+ - **Content-Type**: Not defined
433
+ - **Accept**: application/json
434
+
435
+
436
+ ### HTTP response details
437
+ | Status code | Description | Response headers |
438
+ |-------------|-------------|------------------|
439
+ |**200** | Retiré de la file d\'attente avec succès | - |
440
+ |**400** | Requête invalide | - |
441
+ |**404** | Non trouvé dans la file d\'attente | - |
442
+ |**500** | Erreur serveur | - |
443
+
444
+ [[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)
445
+
446
+ # **leaveEventWaitList**
447
+ > LeaveEventWaitList200Response leaveEventWaitList()
448
+
449
+ Quitter la file d\'attente d\'un event
450
+
451
+ ### Example
452
+
453
+ ```typescript
454
+ import {
455
+ WaitListApi,
456
+ Configuration
457
+ } from '@tennac-booking/sdk';
458
+
459
+ const configuration = new Configuration();
460
+ const apiInstance = new WaitListApi(configuration);
461
+
462
+ let eventId: string; // (default to undefined)
463
+
464
+ const { status, data } = await apiInstance.leaveEventWaitList(
465
+ eventId
466
+ );
467
+ ```
468
+
469
+ ### Parameters
470
+
471
+ |Name | Type | Description | Notes|
472
+ |------------- | ------------- | ------------- | -------------|
473
+ | **eventId** | [**string**] | | defaults to undefined|
474
+
475
+
476
+ ### Return type
477
+
478
+ **LeaveEventWaitList200Response**
479
+
480
+ ### Authorization
481
+
482
+ [bearerAuth](../README.md#bearerAuth)
483
+
484
+ ### HTTP request headers
485
+
486
+ - **Content-Type**: Not defined
487
+ - **Accept**: application/json
488
+
489
+
490
+ ### HTTP response details
491
+ | Status code | Description | Response headers |
492
+ |-------------|-------------|------------------|
493
+ |**200** | Retiré de la file d\'attente avec succès | - |
494
+ |**400** | Requête invalide | - |
495
+ |**404** | Non trouvé dans la file d\'attente | - |
496
+ |**500** | Erreur serveur | - |
497
+
498
+ [[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)
499
+
@@ -1,21 +1,21 @@
1
- # GetWaitListForEvent200Response
1
+ # WaitListListResponse
2
2
 
3
3
 
4
4
  ## Properties
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
- **total** | **number** | | [default to undefined]
9
8
  **waitList** | [**Array<WaitListResponse>**](WaitListResponse.md) | | [default to undefined]
9
+ **total** | **number** | | [default to undefined]
10
10
 
11
11
  ## Example
12
12
 
13
13
  ```typescript
14
- import { GetWaitListForEvent200Response } from '@tennac-booking/sdk';
14
+ import { WaitListListResponse } from '@tennac-booking/sdk';
15
15
 
16
- const instance: GetWaitListForEvent200Response = {
17
- total,
16
+ const instance: WaitListListResponse = {
18
17
  waitList,
18
+ total,
19
19
  };
20
20
  ```
21
21
 
@@ -1,21 +1,21 @@
1
- # GetUserPosition200Response
1
+ # WaitListPositionResponse
2
2
 
3
3
 
4
4
  ## Properties
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
- **message** | **string** | | [optional] [default to undefined]
9
8
  **position** | **number** | | [default to undefined]
9
+ **message** | **string** | | [optional] [default to undefined]
10
10
 
11
11
  ## Example
12
12
 
13
13
  ```typescript
14
- import { GetUserPosition200Response } from '@tennac-booking/sdk';
14
+ import { WaitListPositionResponse } from '@tennac-booking/sdk';
15
15
 
16
- const instance: GetUserPosition200Response = {
17
- message,
16
+ const instance: WaitListPositionResponse = {
18
17
  position,
18
+ message,
19
19
  };
20
20
  ```
21
21
 
@@ -6,14 +6,17 @@
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
8
  **id** | **string** | | [default to undefined]
9
- **eventId** | **string** | | [default to undefined]
10
9
  **userId** | **string** | | [default to undefined]
10
+ **clubId** | **string** | | [default to undefined]
11
+ **targetType** | **string** | | [default to undefined]
12
+ **targetId** | **string** | | [default to undefined]
11
13
  **status** | **string** | | [default to undefined]
12
14
  **position** | **number** | | [default to undefined]
13
15
  **priceInCents** | **number** | | [default to undefined]
14
- **paymentAuthorized** | **boolean** | | [default to undefined]
15
16
  **joinedAt** | **string** | | [default to undefined]
16
- **expiresAt** | **string** | | [optional] [default to undefined]
17
+ **notifiedAt** | **string** | | [optional] [default to undefined]
18
+ **paymentExpiresAt** | **string** | | [optional] [default to undefined]
19
+ **confirmedAt** | **string** | | [optional] [default to undefined]
17
20
  **paymentLink** | **string** | | [optional] [default to undefined]
18
21
 
19
22
  ## Example
@@ -23,14 +26,17 @@ import { WaitListResponse } from '@tennac-booking/sdk';
23
26
 
24
27
  const instance: WaitListResponse = {
25
28
  id,
26
- eventId,
27
29
  userId,
30
+ clubId,
31
+ targetType,
32
+ targetId,
28
33
  status,
29
34
  position,
30
35
  priceInCents,
31
- paymentAuthorized,
32
36
  joinedAt,
33
- expiresAt,
37
+ notifiedAt,
38
+ paymentExpiresAt,
39
+ confirmedAt,
34
40
  paymentLink,
35
41
  };
36
42
  ```