UNPKG

@tennac-booking/sdk

Version:

OpenAPI client for @tennac-booking/sdk

653 lines (421 loc) 16.9 kB
# BookingsStaffApi All URIs are relative to *http://localhost* |Method | HTTP request | Description| |------------- | ------------- | -------------| |[**bookingGuestCheckin**](#bookingguestcheckin) | **POST** /api/bookings/{bookingId}/guest-checkin | | |[**checkInPlayer**](#checkinplayer) | **POST** /api/bookings/{bookingId}/check-in | | |[**checkInPlayerWithSumup**](#checkinplayerwithsumup) | **POST** /api/bookings/{bookingId}/check-in/sumup | | |[**createStaffBooking**](#createstaffbooking) | **POST** /api/bookings/staff | | |[**getBookingById**](#getbookingbyid) | **GET** /api/bookings/{bookingId} | | |[**getBookingHistoryStaff**](#getbookinghistorystaff) | **GET** /api/bookings/staff/history{bookingId} | | |[**getBookingManagerConsole**](#getbookingmanagerconsole) | **GET** /api/bookings/{bookingId}/manager-console | | |[**getBookingPaymentStatus**](#getbookingpaymentstatus) | **GET** /api/bookings/{bookingId}/payment-status | | |[**getDailyBookings**](#getdailybookings) | **GET** /api/bookings/daily/{date} | | |[**getNoShowPreview**](#getnoshowpreview) | **GET** /api/bookings/{bookingId}/no-show-preview | | |[**getWeeklyBookings**](#getweeklybookings) | **GET** /api/bookings/weekly/{weekId} | | |[**listClubBookings**](#listclubbookings) | **GET** /api/bookings/staff | | # **bookingGuestCheckin** > BookingGuestCheckinResponse bookingGuestCheckin() Check-in d\'un invité sans compte (paiement sur place) ### Example ```typescript import { BookingsStaffApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new BookingsStaffApi(configuration); let bookingId: string; // (default to undefined) const { status, data } = await apiInstance.bookingGuestCheckin( bookingId ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **bookingId** | [**string**] | | defaults to undefined| ### Return type **BookingGuestCheckinResponse** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Check-in invité effectué avec succès | - | [[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) # **checkInPlayer** > CheckInPlayerResponse checkInPlayer(checkInPlayerRequest) Check-in d\'un joueur sans SumUp (paiement en ligne ou sur place) ### Example ```typescript import { BookingsStaffApi, Configuration, CheckInPlayerRequest } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new BookingsStaffApi(configuration); let bookingId: string; // (default to undefined) let checkInPlayerRequest: CheckInPlayerRequest; // const { status, data } = await apiInstance.checkInPlayer( bookingId, checkInPlayerRequest ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **checkInPlayerRequest** | **CheckInPlayerRequest**| | | | **bookingId** | [**string**] | | defaults to undefined| ### Return type **CheckInPlayerResponse** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Check-in effectué avec succès | - | [[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) # **checkInPlayerWithSumup** > CheckInPlayerSumupResponse checkInPlayerWithSumup(checkInPlayerSumupRequest) Check-in d\'un joueur avec création d\'un checkout SumUp ### Example ```typescript import { BookingsStaffApi, Configuration, CheckInPlayerSumupRequest } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new BookingsStaffApi(configuration); let bookingId: string; // (default to undefined) let checkInPlayerSumupRequest: CheckInPlayerSumupRequest; // const { status, data } = await apiInstance.checkInPlayerWithSumup( bookingId, checkInPlayerSumupRequest ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **checkInPlayerSumupRequest** | **CheckInPlayerSumupRequest**| | | | **bookingId** | [**string**] | | defaults to undefined| ### Return type **CheckInPlayerSumupResponse** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Checkout SumUp déclenché | - | [[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) # **createStaffBooking** > BookingResponse createStaffBooking(staffCreateBookingRequest) Créer une réservation pour un joueur depuis l\'espace staff ### Example ```typescript import { BookingsStaffApi, Configuration, StaffCreateBookingRequest } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new BookingsStaffApi(configuration); let staffCreateBookingRequest: StaffCreateBookingRequest; // const { status, data } = await apiInstance.createStaffBooking( staffCreateBookingRequest ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **staffCreateBookingRequest** | **StaffCreateBookingRequest**| | | ### Return type **BookingResponse** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**201** | Réservation staff créée avec succès | - | [[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) # **getBookingById** > BookingPopulated getBookingById() Obtenir une réservation par ID ### Example ```typescript import { BookingsStaffApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new BookingsStaffApi(configuration); let bookingId: string; // (default to undefined) const { status, data } = await apiInstance.getBookingById( bookingId ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **bookingId** | [**string**] | | defaults to undefined| ### Return type **BookingPopulated** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Réservation récupérée | - | [[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) # **getBookingHistoryStaff** > BookingHistoryPopulated getBookingHistoryStaff() Obtenir l\'historique d\'une réservation par ID ### Example ```typescript import { BookingsStaffApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new BookingsStaffApi(configuration); let bookingId: string; // (default to undefined) const { status, data } = await apiInstance.getBookingHistoryStaff( bookingId ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **bookingId** | [**string**] | | defaults to undefined| ### Return type **BookingHistoryPopulated** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Réservation récupérée | - | [[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) # **getBookingManagerConsole** > BookingManagerConsoleResponse getBookingManagerConsole() Obtenir les données consolidées de la console manager d\'une réservation ### Example ```typescript import { BookingsStaffApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new BookingsStaffApi(configuration); let bookingId: string; // (default to undefined) const { status, data } = await apiInstance.getBookingManagerConsole( bookingId ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **bookingId** | [**string**] | | defaults to undefined| ### Return type **BookingManagerConsoleResponse** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Données manager console récupérées | - | [[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) # **getBookingPaymentStatus** > BookingPaymentStatusResponse getBookingPaymentStatus() Obtenir le statut des paiements d\'une réservation ### Example ```typescript import { BookingsStaffApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new BookingsStaffApi(configuration); let bookingId: string; // (default to undefined) const { status, data } = await apiInstance.getBookingPaymentStatus( bookingId ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **bookingId** | [**string**] | | defaults to undefined| ### Return type **BookingPaymentStatusResponse** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Statut des paiements récupéré | - | [[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) # **getDailyBookings** > BookingsWithTimeBoundsResponse getDailyBookings() Obtenir les réservations journalières ### Example ```typescript import { BookingsStaffApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new BookingsStaffApi(configuration); let date: string; // (default to undefined) const { status, data } = await apiInstance.getDailyBookings( date ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **date** | [**string**] | | defaults to undefined| ### Return type **BookingsWithTimeBoundsResponse** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Réservations journalières récupérées | - | [[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) # **getNoShowPreview** > NoShowPreviewResponse getNoShowPreview() Prévisualiser l\'application des frais de no-show ### Example ```typescript import { BookingsStaffApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new BookingsStaffApi(configuration); let bookingId: string; // (default to undefined) const { status, data } = await apiInstance.getNoShowPreview( bookingId ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **bookingId** | [**string**] | | defaults to undefined| ### Return type **NoShowPreviewResponse** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Prévisualisation no-show récupérée | - | [[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) # **getWeeklyBookings** > BookingsWithTimeBoundsResponse getWeeklyBookings() Obtenir les réservations hebdomadaires ### Example ```typescript import { BookingsStaffApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new BookingsStaffApi(configuration); let weekId: string; // (default to undefined) const { status, data } = await apiInstance.getWeeklyBookings( weekId ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **weekId** | [**string**] | | defaults to undefined| ### Return type **BookingsWithTimeBoundsResponse** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Réservations hebdomadaires récupérées | - | [[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) # **listClubBookings** > StaffBookingsPaginatedResponse listClubBookings() Liste paginée des réservations du club pour le staff ### Example ```typescript import { BookingsStaffApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new BookingsStaffApi(configuration); let page: number; // (optional) (default to undefined) let pageSize: number; // (optional) (default to undefined) let search: string; // (optional) (default to undefined) let filters: string; // (optional) (default to undefined) let sorting: string; // (optional) (default to undefined) const { status, data } = await apiInstance.listClubBookings( page, pageSize, search, filters, sorting ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **page** | [**number**] | | (optional) defaults to undefined| | **pageSize** | [**number**] | | (optional) defaults to undefined| | **search** | [**string**] | | (optional) defaults to undefined| | **filters** | [**string**] | | (optional) defaults to undefined| | **sorting** | [**string**] | | (optional) defaults to undefined| ### Return type **StaffBookingsPaginatedResponse** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Réservations récupérées | - | [[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)