@tennac-booking/sdk
Version:
OpenAPI client for @tennac-booking/sdk
387 lines (250 loc) • 10.3 kB
Markdown
# WaitListStaffApi
All URIs are relative to *http://localhost*
|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**getBookingWaitList**](#getbookingwaitlist) | **GET** /api/waitlist/booking/{bookingId}/list | |
|[**getEventBookingWaitList**](#geteventbookingwaitlist) | **GET** /api/waitlist/event-booking/{eventBookingId}/list | |
|[**getEventWaitList**](#geteventwaitlist) | **GET** /api/waitlist/event/{eventId}/list | |
|[**getEventWaitListPlayers**](#geteventwaitlistplayers) | **GET** /api/waitlist/event/{eventId}/players | |
|[**processBookingWaitList**](#processbookingwaitlist) | **POST** /api/waitlist/booking/{bookingId}/process | |
|[**processEventBookingWaitList**](#processeventbookingwaitlist) | **POST** /api/waitlist/event-booking/{eventBookingId}/process | |
|[**processEventWaitList**](#processeventwaitlist) | **POST** /api/waitlist/event/{eventId}/process | |
# **getBookingWaitList**
> WaitListListResponse getBookingWaitList()
Obtenir la liste complète de la file d\'attente pour un booking (staff only)
### Example
```typescript
import {
WaitListStaffApi,
Configuration
} from '@tennac-booking/sdk';
const configuration = new Configuration();
const apiInstance = new WaitListStaffApi(configuration);
let bookingId: string; // (default to undefined)
const { status, data } = await apiInstance.getBookingWaitList(
bookingId
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **bookingId** | [**string**] | | defaults to undefined|
### Return type
**WaitListListResponse**
### Authorization
[bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | File d\'attente récupérée avec succès | - |
|**404** | Réservation non trouvée | - |
|**500** | Erreur serveur | - |
[[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)
# **getEventBookingWaitList**
> WaitListListResponse getEventBookingWaitList()
Obtenir la liste complète de la file d\'attente pour un eventBooking (staff only)
### Example
```typescript
import {
WaitListStaffApi,
Configuration
} from '@tennac-booking/sdk';
const configuration = new Configuration();
const apiInstance = new WaitListStaffApi(configuration);
let eventBookingId: string; // (default to undefined)
const { status, data } = await apiInstance.getEventBookingWaitList(
eventBookingId
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventBookingId** | [**string**] | | defaults to undefined|
### Return type
**WaitListListResponse**
### Authorization
[bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | File d\'attente récupérée avec succès | - |
|**404** | Inscription événement non trouvée | - |
|**500** | Erreur serveur | - |
[[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)
# **getEventWaitList**
> WaitListListResponse getEventWaitList()
Obtenir la liste complète de la file d\'attente pour un event (staff only)
### Example
```typescript
import {
WaitListStaffApi,
Configuration
} from '@tennac-booking/sdk';
const configuration = new Configuration();
const apiInstance = new WaitListStaffApi(configuration);
let eventId: string; // (default to undefined)
const { status, data } = await apiInstance.getEventWaitList(
eventId
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | | defaults to undefined|
### Return type
**WaitListListResponse**
### Authorization
[bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | File d\'attente récupérée avec succès | - |
|**404** | Événement non trouvé | - |
|**500** | Erreur serveur | - |
[[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)
# **getEventWaitListPlayers**
> WaitListPlayersListResponse getEventWaitListPlayers()
Obtenir la liste des joueurs dans la file d\'attente pour un event (staff only)
### Example
```typescript
import {
WaitListStaffApi,
Configuration
} from '@tennac-booking/sdk';
const configuration = new Configuration();
const apiInstance = new WaitListStaffApi(configuration);
let eventId: string; // (default to undefined)
const { status, data } = await apiInstance.getEventWaitListPlayers(
eventId
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | | defaults to undefined|
### Return type
**WaitListPlayersListResponse**
### Authorization
[bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Joueurs en file d\'attente récupérés avec succès | - |
|**400** | Requête invalide | - |
|**404** | Événement non trouvé | - |
|**500** | Erreur serveur | - |
[[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)
# **processBookingWaitList**
> LeaveEventWaitList200Response processBookingWaitList()
Forcer le traitement de la waitlist pour un booking (staff only)
### Example
```typescript
import {
WaitListStaffApi,
Configuration
} from '@tennac-booking/sdk';
const configuration = new Configuration();
const apiInstance = new WaitListStaffApi(configuration);
let bookingId: string; // (default to undefined)
const { status, data } = await apiInstance.processBookingWaitList(
bookingId
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **bookingId** | [**string**] | | defaults to undefined|
### Return type
**LeaveEventWaitList200Response**
### Authorization
[bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | File d\'attente traitée avec succès | - |
|**404** | Réservation non trouvée | - |
|**500** | Erreur serveur | - |
[[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)
# **processEventBookingWaitList**
> LeaveEventWaitList200Response processEventBookingWaitList()
Forcer le traitement de la waitlist pour un eventBooking (staff only)
### Example
```typescript
import {
WaitListStaffApi,
Configuration
} from '@tennac-booking/sdk';
const configuration = new Configuration();
const apiInstance = new WaitListStaffApi(configuration);
let eventBookingId: string; // (default to undefined)
const { status, data } = await apiInstance.processEventBookingWaitList(
eventBookingId
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventBookingId** | [**string**] | | defaults to undefined|
### Return type
**LeaveEventWaitList200Response**
### Authorization
[bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | File d\'attente traitée avec succès | - |
|**404** | Inscription événement non trouvée | - |
|**500** | Erreur serveur | - |
[[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)
# **processEventWaitList**
> LeaveEventWaitList200Response processEventWaitList()
Forcer le traitement de la waitlist pour un event (staff only)
### Example
```typescript
import {
WaitListStaffApi,
Configuration
} from '@tennac-booking/sdk';
const configuration = new Configuration();
const apiInstance = new WaitListStaffApi(configuration);
let eventId: string; // (default to undefined)
const { status, data } = await apiInstance.processEventWaitList(
eventId
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | | defaults to undefined|
### Return type
**LeaveEventWaitList200Response**
### Authorization
[bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | File d\'attente traitée avec succès | - |
|**404** | Événement non trouvé | - |
|**500** | Erreur serveur | - |
[[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)