UNPKG

@tennac-booking/sdk

Version:

OpenAPI client for @tennac-booking/sdk

512 lines (337 loc) 13.7 kB
# WaitListApi All URIs are relative to *http://localhost* |Method | HTTP request | Description| |------------- | ------------- | -------------| |[**getBookingPosition**](#getbookingposition) | **GET** /api/waitlist/booking/{bookingId}/position | | |[**getEventBookingPosition**](#geteventbookingposition) | **GET** /api/waitlist/event-booking/{eventBookingId}/position | | |[**getEventPosition**](#geteventposition) | **GET** /api/waitlist/event/{eventId}/position | | |[**joinBookingWaitList**](#joinbookingwaitlist) | **POST** /api/waitlist/booking/{bookingId}/join | | |[**joinEventBookingWaitList**](#joineventbookingwaitlist) | **POST** /api/waitlist/event-booking/{eventBookingId}/join | | |[**joinEventWaitList**](#joineventwaitlist) | **POST** /api/waitlist/event/{eventId}/join | | |[**leaveBookingWaitList**](#leavebookingwaitlist) | **DELETE** /api/waitlist/booking/{bookingId}/leave | | |[**leaveEventBookingWaitList**](#leaveeventbookingwaitlist) | **DELETE** /api/waitlist/event-booking/{eventBookingId}/leave | | |[**leaveEventWaitList**](#leaveeventwaitlist) | **DELETE** /api/waitlist/event/{eventId}/leave | | # **getBookingPosition** > WaitListPositionResponse getBookingPosition() Obtenir la position actuelle dans la file d\'attente d\'un booking ### Example ```typescript import { WaitListApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new WaitListApi(configuration); let bookingId: string; // (default to undefined) const { status, data } = await apiInstance.getBookingPosition( bookingId ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **bookingId** | [**string**] | | defaults to undefined| ### Return type **WaitListPositionResponse** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Position récupérée avec succès | - | |**404** | Non trouvé dans la file d\'attente | - | |**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) # **getEventBookingPosition** > WaitListPositionResponse getEventBookingPosition() Obtenir la position actuelle dans la file d\'attente d\'un eventBooking ### Example ```typescript import { WaitListApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new WaitListApi(configuration); let eventBookingId: string; // (default to undefined) const { status, data } = await apiInstance.getEventBookingPosition( eventBookingId ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **eventBookingId** | [**string**] | | defaults to undefined| ### Return type **WaitListPositionResponse** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Position récupérée avec succès | - | |**404** | Non trouvé dans la file d\'attente | - | |**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) # **getEventPosition** > WaitListPositionResponse getEventPosition() Obtenir la position actuelle dans la file d\'attente d\'un event ### Example ```typescript import { WaitListApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new WaitListApi(configuration); let eventId: string; // (default to undefined) const { status, data } = await apiInstance.getEventPosition( eventId ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **eventId** | [**string**] | | defaults to undefined| ### Return type **WaitListPositionResponse** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Position récupérée avec succès | - | |**404** | Non trouvé dans la file d\'attente | - | |**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) # **joinBookingWaitList** > JoinEventWaitList200Response joinBookingWaitList() Rejoindre la file d\'attente pour un booking (créneau ouvert) ### Example ```typescript import { WaitListApi, Configuration, JoinWaitListRequest } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new WaitListApi(configuration); let bookingId: string; // (default to undefined) let joinWaitListRequest: JoinWaitListRequest; // (optional) const { status, data } = await apiInstance.joinBookingWaitList( bookingId, joinWaitListRequest ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **joinWaitListRequest** | **JoinWaitListRequest**| | | | **bookingId** | [**string**] | | defaults to undefined| ### Return type **JoinEventWaitList200Response** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Ajouté à la file d\'attente avec succès | - | |**400** | Requête invalide | - | |**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) # **joinEventBookingWaitList** > JoinEventWaitList200Response joinEventBookingWaitList() Rejoindre la file d\'attente pour un eventBooking (event en équipe avec créneau ouvert) ### Example ```typescript import { WaitListApi, Configuration, JoinWaitListRequest } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new WaitListApi(configuration); let eventBookingId: string; // (default to undefined) let joinWaitListRequest: JoinWaitListRequest; // (optional) const { status, data } = await apiInstance.joinEventBookingWaitList( eventBookingId, joinWaitListRequest ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **joinWaitListRequest** | **JoinWaitListRequest**| | | | **eventBookingId** | [**string**] | | defaults to undefined| ### Return type **JoinEventWaitList200Response** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Ajouté à la file d\'attente avec succès | - | |**400** | Requête invalide | - | |**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) # **joinEventWaitList** > JoinEventWaitList200Response joinEventWaitList() Rejoindre la file d\'attente pour un event (participation solo) ### Example ```typescript import { WaitListApi, Configuration, JoinWaitListRequest } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new WaitListApi(configuration); let eventId: string; // (default to undefined) let joinWaitListRequest: JoinWaitListRequest; // (optional) const { status, data } = await apiInstance.joinEventWaitList( eventId, joinWaitListRequest ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **joinWaitListRequest** | **JoinWaitListRequest**| | | | **eventId** | [**string**] | | defaults to undefined| ### Return type **JoinEventWaitList200Response** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Ajouté à la file d\'attente 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) # **leaveBookingWaitList** > LeaveEventWaitList200Response leaveBookingWaitList() Quitter la file d\'attente d\'un booking ### Example ```typescript import { WaitListApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new WaitListApi(configuration); let bookingId: string; // (default to undefined) const { status, data } = await apiInstance.leaveBookingWaitList( 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** | Retiré de la file d\'attente avec succès | - | |**400** | Requête invalide | - | |**404** | Non trouvé dans la file d\'attente | - | |**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) # **leaveEventBookingWaitList** > LeaveEventWaitList200Response leaveEventBookingWaitList() Quitter la file d\'attente d\'un eventBooking ### Example ```typescript import { WaitListApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new WaitListApi(configuration); let eventBookingId: string; // (default to undefined) const { status, data } = await apiInstance.leaveEventBookingWaitList( 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** | Retiré de la file d\'attente avec succès | - | |**400** | Requête invalide | - | |**404** | Non trouvé dans la file d\'attente | - | |**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) # **leaveEventWaitList** > LeaveEventWaitList200Response leaveEventWaitList() Quitter la file d\'attente d\'un event ### Example ```typescript import { WaitListApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new WaitListApi(configuration); let eventId: string; // (default to undefined) const { status, data } = await apiInstance.leaveEventWaitList( 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** | Retiré de la file d\'attente avec succès | - | |**400** | Requête invalide | - | |**404** | Non trouvé dans la file d\'attente | - | |**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)