@tennac-booking/sdk
Version:
OpenAPI client for @tennac-booking/sdk
383 lines (246 loc) • 10.1 kB
Markdown
# BookingsUserApi
All URIs are relative to *http://localhost*
|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**cancelBooking**](#cancelbooking) | **DELETE** /api/bookings/{bookingId} | |
|[**closeOpenBooking**](#closeopenbooking) | **POST** /api/bookings/{bookingId}/close | |
|[**createBooking**](#createbooking) | **POST** /api/bookings | |
|[**createOpenBooking**](#createopenbooking) | **POST** /api/bookings/open | |
|[**getOpenBookingPrice**](#getopenbookingprice) | **POST** /api/bookings/open/booking-price | |
|[**respondToBookingInvitation**](#respondtobookinginvitation) | **POST** /api/bookings/{bookingId}/respond-invitation | |
|[**updateOpenBooking**](#updateopenbooking) | **PATCH** /api/bookings/{bookingId}/open | |
# **cancelBooking**
> CancelBookingResponse cancelBooking()
Annuler une réservation (par le créateur)
### Example
```typescript
import {
BookingsUserApi,
Configuration
} from '@tennac-booking/sdk';
const configuration = new Configuration();
const apiInstance = new BookingsUserApi(configuration);
let bookingId: string; // (default to undefined)
const { status, data } = await apiInstance.cancelBooking(
bookingId
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **bookingId** | [**string**] | | defaults to undefined|
### Return type
**CancelBookingResponse**
### 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 annulé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)
# **closeOpenBooking**
> CloseOpenBookingResponse closeOpenBooking()
Fermer une réservation ouverte et la passer en ACTIVE Accessible uniquement au créateur de la réservation
### Example
```typescript
import {
BookingsUserApi,
Configuration
} from '@tennac-booking/sdk';
const configuration = new Configuration();
const apiInstance = new BookingsUserApi(configuration);
let bookingId: string; // (default to undefined)
const { status, data } = await apiInstance.closeOpenBooking(
bookingId
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **bookingId** | [**string**] | | defaults to undefined|
### Return type
**CloseOpenBookingResponse**
### 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 fermée et activé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)
# **createBooking**
> BookingResponse createBooking(createBookingRequest)
Créer une réservation Gère tous les scénarios de paiement (créateur paie tout, paiement divisé, gratuit)
### Example
```typescript
import {
BookingsUserApi,
Configuration,
CreateBookingRequest
} from '@tennac-booking/sdk';
const configuration = new Configuration();
const apiInstance = new BookingsUserApi(configuration);
let createBookingRequest: CreateBookingRequest; //
const { status, data } = await apiInstance.createBooking(
createBookingRequest
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **createBookingRequest** | **CreateBookingRequest**| | |
### 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 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)
# **createOpenBooking**
> BookingResponse createOpenBooking(createOpenBookingRequest)
Créer une réservation ouverte (open slot)
### Example
```typescript
import {
BookingsUserApi,
Configuration,
CreateOpenBookingRequest
} from '@tennac-booking/sdk';
const configuration = new Configuration();
const apiInstance = new BookingsUserApi(configuration);
let createOpenBookingRequest: CreateOpenBookingRequest; //
const { status, data } = await apiInstance.createOpenBooking(
createOpenBookingRequest
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **createOpenBookingRequest** | **CreateOpenBookingRequest**| | |
### 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 ouverte 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)
# **getOpenBookingPrice**
> BookingPriceResponse getOpenBookingPrice(openBookingPriceBody)
Calculer le prix d\'une réservation ouverte avec joueurs initiaux
### Example
```typescript
import {
BookingsUserApi,
Configuration,
OpenBookingPriceBody
} from '@tennac-booking/sdk';
const configuration = new Configuration();
const apiInstance = new BookingsUserApi(configuration);
let openBookingPriceBody: OpenBookingPriceBody; //
const { status, data } = await apiInstance.getOpenBookingPrice(
openBookingPriceBody
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **openBookingPriceBody** | **OpenBookingPriceBody**| | |
### Return type
**BookingPriceResponse**
### Authorization
[bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Prix de réservation ouverte calculé | - |
[[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)
# **respondToBookingInvitation**
> AcceptBookingInvitationResponse respondToBookingInvitation(acceptBookingInvitationRequest)
Accepter ou refuser une invitation à une réservation
### Example
```typescript
import {
BookingsUserApi,
Configuration,
AcceptBookingInvitationRequest
} from '@tennac-booking/sdk';
const configuration = new Configuration();
const apiInstance = new BookingsUserApi(configuration);
let bookingId: string; // (default to undefined)
let acceptBookingInvitationRequest: AcceptBookingInvitationRequest; //
const { status, data } = await apiInstance.respondToBookingInvitation(
bookingId,
acceptBookingInvitationRequest
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **acceptBookingInvitationRequest** | **AcceptBookingInvitationRequest**| | |
| **bookingId** | [**string**] | | defaults to undefined|
### Return type
**AcceptBookingInvitationResponse**
### Authorization
[bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Réponse à l\'invitation enregistré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)
# **updateOpenBooking**
> UpdateOpenBooking200Response updateOpenBooking(updateOpenBookingRequest)
Mettre à jour une réservation ouverte (description et niveau minimal)
### Example
```typescript
import {
BookingsUserApi,
Configuration,
UpdateOpenBookingRequest
} from '@tennac-booking/sdk';
const configuration = new Configuration();
const apiInstance = new BookingsUserApi(configuration);
let bookingId: string; // (default to undefined)
let updateOpenBookingRequest: UpdateOpenBookingRequest; //
const { status, data } = await apiInstance.updateOpenBooking(
bookingId,
updateOpenBookingRequest
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **updateOpenBookingRequest** | **UpdateOpenBookingRequest**| | |
| **bookingId** | [**string**] | | defaults to undefined|
### Return type
**UpdateOpenBooking200Response**
### Authorization
[bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Réservation ouverte mise à jour 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)