@tennac-booking/sdk 1.0.218 → 1.0.219

package/docs/JobsApi.md

@@ -1,367 +0,0 @@
-# JobsApi
-
-All URIs are relative to *http://localhost*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**captureExpiringAuthorizations**](#captureexpiringauthorizations) | **GET** /api/jobs/capture-expiring-authorizations | Capture les autorisations Stripe qui expirent dans moins de 4h|
-|[**capturePastReservations**](#capturepastreservations) | **GET** /api/jobs/capture-past-reservations | Capture les paiements autorisés pour les réservations passées|
-|[**expireBookingWaitingPayments**](#expirebookingwaitingpayments) | **GET** /api/jobs/expire-booking-waiting-payments | Expire les réservations en attente de paiement|
-|[**expireWaitlistPayments**](#expirewaitlistpayments) | **GET** /api/jobs/expire-waitlist-payments | Expire les paiements en attente sur la waitlist|
-|[**health**](#health) | **GET** /api/jobs/health | Health check pour les jobs|
-|[**maintainSlots**](#maintainslots) | **GET** /api/jobs/maintain-slots | Génère les créneaux futurs et nettoie les anciens|
-|[**releaseOldBookings**](#releaseoldbookings) | **GET** /api/jobs/release-old-bookings | Libère les anciennes réservations terminées|
-|[**sendBookingReminders**](#sendbookingreminders) | **GET** /api/jobs/send-booking-reminders | Envoie des emails de rappel 24h avant les réservations et événements|
-
-# **captureExpiringAuthorizations**
-> JobResult captureExpiringAuthorizations()
-
-Job: Capturer les autorisations de paiement qui expirent bientôt Fréquence recommandée: Toutes les 30 minutes
-
-### Example
-
-```typescript
-import {
-    JobsApi,
-    Configuration
-} from '@tennac-booking/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new JobsApi(configuration);
-
-const { status, data } = await apiInstance.captureExpiringAuthorizations();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**JobResult**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Job executed successfully |  -  |
-
-[[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)
-
-# **capturePastReservations**
-> JobResult capturePastReservations()
-
-Job: Capturer les paiements pour les réservations passées Fréquence recommandée: Toutes les heures
-
-### Example
-
-```typescript
-import {
-    JobsApi,
-    Configuration
-} from '@tennac-booking/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new JobsApi(configuration);
-
-const { status, data } = await apiInstance.capturePastReservations();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**JobResult**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Job executed successfully |  -  |
-
-[[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)
-
-# **expireBookingWaitingPayments**
-> JobResult expireBookingWaitingPayments()
-
-Job: Expirer les réservations en attente de paiement Fréquence recommandée: Toutes les minutes
-
-### Example
-
-```typescript
-import {
-    JobsApi,
-    Configuration
-} from '@tennac-booking/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new JobsApi(configuration);
-
-const { status, data } = await apiInstance.expireBookingWaitingPayments();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**JobResult**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Job executed successfully |  -  |
-
-[[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)
-
-# **expireWaitlistPayments**
-> JobResult expireWaitlistPayments()
-
-Job: Expirer les paiements en attente sur la waitlist Fréquence recommandée: Toutes les minutes
-
-### Example
-
-```typescript
-import {
-    JobsApi,
-    Configuration
-} from '@tennac-booking/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new JobsApi(configuration);
-
-const { status, data } = await apiInstance.expireWaitlistPayments();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**JobResult**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Job executed successfully |  -  |
-
-[[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)
-
-# **health**
-> Health200Response health()
-
-Route de santé pour vérifier que le service jobs est opérationnel
-
-### Example
-
-```typescript
-import {
-    JobsApi,
-    Configuration
-} from '@tennac-booking/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new JobsApi(configuration);
-
-const { status, data } = await apiInstance.health();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**Health200Response**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Service is healthy |  -  |
-
-[[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)
-
-# **maintainSlots**
-> JobResult maintainSlots()
-
-Job: Maintenir les créneaux (slots) Fréquence recommandée: Une fois par jour (2h du matin)
-
-### Example
-
-```typescript
-import {
-    JobsApi,
-    Configuration
-} from '@tennac-booking/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new JobsApi(configuration);
-
-const { status, data } = await apiInstance.maintainSlots();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**JobResult**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Job executed successfully |  -  |
-
-[[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)
-
-# **releaseOldBookings**
-> JobResult releaseOldBookings()
-
-Job: Libérer les anciennes réservations Fréquence recommandée: Toutes les minutes
-
-### Example
-
-```typescript
-import {
-    JobsApi,
-    Configuration
-} from '@tennac-booking/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new JobsApi(configuration);
-
-const { status, data } = await apiInstance.releaseOldBookings();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**JobResult**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Job executed successfully |  -  |
-
-[[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)
-
-# **sendBookingReminders**
-> JobResult sendBookingReminders()
-
-Job: Envoyer les rappels de réservation et d\'événements Fréquence recommandée: Toutes les heures
-
-### Example
-
-```typescript
-import {
-    JobsApi,
-    Configuration
-} from '@tennac-booking/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new JobsApi(configuration);
-
-const { status, data } = await apiInstance.sendBookingReminders();
-```
-
-### Parameters
-This endpoint does not have any parameters.
-
-
-### Return type
-
-**JobResult**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Job executed successfully |  -  |
-
-[[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)
-

package/docs/JoinOpenBookingRequest.md

@@ -1,28 +0,0 @@
-# JoinOpenBookingRequest
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**playerShares** | [**Array<PlayerShare>**](PlayerShare.md) | Liste des parts de paiement par joueur (utiliser ceci OU isCreatorPayingAll) | [optional] [default to undefined]
-**isCreatorPayingAll** | **boolean** | Indique si le joueur qui rejoint paie pour tous les joueurs qu\'il ajoute (incompatible avec playerShares) | [optional] [default to undefined]
-**paymentMethod** | [**PaymentMethod**](PaymentMethod.md) |  | [optional] [default to undefined]
-**useDefaultPaymentMethod** | **boolean** | Indique si l\'utilisateur veut utiliser sa méthode de paiement par défaut | [optional] [default to undefined]
-**creditToUseInCents** | **number** | Crédit à utiliser en centimes | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { JoinOpenBookingRequest } from '@tennac-booking/sdk';
-
-const instance: JoinOpenBookingRequest = {
-    playerShares,
-    isCreatorPayingAll,
-    paymentMethod,
-    useDefaultPaymentMethod,
-    creditToUseInCents,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/MarkNotificationsReadRequest.md

@@ -1,22 +0,0 @@
-# MarkNotificationsReadRequest
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**notificationIds** | **Array<string>** |  | [optional] [default to undefined]
-**readAll** | **boolean** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { MarkNotificationsReadRequest } from '@tennac-booking/sdk';
-
-const instance: MarkNotificationsReadRequest = {
-    notificationIds,
-    readAll,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/NotificationData.md

@@ -1,22 +0,0 @@
-# NotificationData
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pathname** | **string** |  | [default to undefined]
-**params** | **{ [key: string]: string; }** | Construct a type with a set of properties K of type T | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { NotificationData } from '@tennac-booking/sdk';
-
-const instance: NotificationData = {
-    pathname,
-    params,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/NotificationParticipantPreview.md

@@ -1,22 +0,0 @@
-# NotificationParticipantPreview
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** |  | [optional] [default to undefined]
-**name** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { NotificationParticipantPreview } from '@tennac-booking/sdk';
-
-const instance: NotificationParticipantPreview = {
-    id,
-    name,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/NotificationPreview.md

@@ -1,60 +0,0 @@
-# NotificationPreview
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**bookingId** | **string** |  | [optional] [default to undefined]
-**eventId** | **string** |  | [optional] [default to undefined]
-**eventBookingId** | **string** |  | [optional] [default to undefined]
-**clubId** | **string** |  | [optional] [default to undefined]
-**clubName** | **string** |  | [optional] [default to undefined]
-**clubPicture** | **string** |  | [optional] [default to undefined]
-**courtName** | **string** |  | [optional] [default to undefined]
-**eventName** | **string** |  | [optional] [default to undefined]
-**startDate** | **string** |  | [optional] [default to undefined]
-**endDate** | **string** |  | [optional] [default to undefined]
-**reminderDelayHours** | **number** |  | [optional] [default to undefined]
-**reason** | **string** |  | [optional] [default to undefined]
-**joinerId** | **string** |  | [optional] [default to undefined]
-**joinerName** | **string** |  | [optional] [default to undefined]
-**targetLabel** | **string** |  | [optional] [default to undefined]
-**targetType** | **string** |  | [optional] [default to undefined]
-**targetId** | **string** |  | [optional] [default to undefined]
-**priceInCents** | **number** |  | [optional] [default to undefined]
-**expiresAt** | **string** |  | [optional] [default to undefined]
-**waitingListPaymentHoldDuration** | **number** |  | [optional] [default to undefined]
-**participants** | [**Array<NotificationParticipantPreview>**](NotificationParticipantPreview.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { NotificationPreview } from '@tennac-booking/sdk';
-
-const instance: NotificationPreview = {
-    bookingId,
-    eventId,
-    eventBookingId,
-    clubId,
-    clubName,
-    clubPicture,
-    courtName,
-    eventName,
-    startDate,
-    endDate,
-    reminderDelayHours,
-    reason,
-    joinerId,
-    joinerName,
-    targetLabel,
-    targetType,
-    targetId,
-    priceInCents,
-    expiresAt,
-    waitingListPaymentHoldDuration,
-    participants,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/NotificationResponse.md

@@ -1,36 +0,0 @@
-# NotificationResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** |  | [default to undefined]
-**type** | [**NotificationType**](NotificationType.md) |  | [default to undefined]
-**title** | **string** |  | [default to undefined]
-**message** | **string** |  | [default to undefined]
-**data** | [**NotificationData**](NotificationData.md) |  | [optional] [default to undefined]
-**preview** | [**NotificationPreview**](NotificationPreview.md) |  | [optional] [default to undefined]
-**createdAt** | **string** |  | [default to undefined]
-**readAt** | **string** |  | [optional] [default to undefined]
-**isRead** | **boolean** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { NotificationResponse } from '@tennac-booking/sdk';
-
-const instance: NotificationResponse = {
-    id,
-    type,
-    title,
-    message,
-    data,
-    preview,
-    createdAt,
-    readAt,
-    isRead,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/NotificationType.md

@@ -1,26 +0,0 @@
-# NotificationType
-
-
-## Enum
-
-* `BookingCreated` (value: `'booking_created'`)
-
-* `BookingSetupRequired` (value: `'booking_setup_required'`)
-
-* `BookingCancelled` (value: `'booking_cancelled'`)
-
-* `BookingReminder` (value: `'booking_reminder'`)
-
-* `EventRegistrationConfirmed` (value: `'event_registration_confirmed'`)
-
-* `EventReminder` (value: `'event_reminder'`)
-
-* `OpenBookingJoined` (value: `'open_booking_joined'`)
-
-* `OpenBookingJoinConfirmed` (value: `'open_booking_join_confirmed'`)
-
-* `WaitlistSpotAvailable` (value: `'waitlist_spot_available'`)
-
-* `WaitlistConfirmed` (value: `'waitlist_confirmed'`)
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/OpenBookingBasePriceResponse.md

@@ -1,24 +0,0 @@
-# OpenBookingBasePriceResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**basePricePerPlayer** | **number** | Prix de base par joueur (en centimes) pour rejoindre | [default to undefined]
-**totalBasePrice** | **number** | Prix total de base de la réservation (en centimes) | [default to undefined]
-**availableSlots** | **number** | Nombre de places restantes | [default to undefined]
-
-## Example
-
-```typescript
-import { OpenBookingBasePriceResponse } from '@tennac-booking/sdk';
-
-const instance: OpenBookingBasePriceResponse = {
-    basePricePerPlayer,
-    totalBasePrice,
-    availableSlots,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/OpenBookingJoinEstimateResponse.md

@@ -1,26 +0,0 @@
-# OpenBookingJoinEstimateResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**basePricePerPlayer** | **number** | Prix de base par joueur (en centimes) | [default to undefined]
-**playersPrices** | [**Array<PlayerPrice>**](PlayerPrice.md) | Détails de prix pour chaque joueur qui rejoint | [default to undefined]
-**availableCreditsInCents** | **number** | Crédits disponibles pour l\'utilisateur qui demande à rejoindre (en centimes) | [default to undefined]
-**availableSlots** | **number** | Nombre de places restantes | [default to undefined]
-
-## Example
-
-```typescript
-import { OpenBookingJoinEstimateResponse } from '@tennac-booking/sdk';
-
-const instance: OpenBookingJoinEstimateResponse = {
-    basePricePerPlayer,
-    playersPrices,
-    availableCreditsInCents,
-    availableSlots,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/OpenBookingPriceBody.md

@@ -1,26 +0,0 @@
-# OpenBookingPriceBody
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**slotIds** | **Array<string>** |  | [default to undefined]
-**playerShares** | [**Array<PlayerShare>**](PlayerShare.md) |  | [optional] [default to undefined]
-**creditToUseInCents** | **number** |  | [optional] [default to undefined]
-**maxPlayersDesired** | **number** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { OpenBookingPriceBody } from '@tennac-booking/sdk';
-
-const instance: OpenBookingPriceBody = {
-    slotIds,
-    playerShares,
-    creditToUseInCents,
-    maxPlayersDesired,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PartnerSearchItem.md

@@ -1,28 +0,0 @@
-# PartnerSearchItem
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** |  | [default to undefined]
-**firstName** | **string** |  | [default to undefined]
-**lastName** | **string** |  | [default to undefined]
-**profilePicture** | **string** |  | [default to undefined]
-**isFavorite** | **boolean** |  | [default to undefined]
-
-## Example
-
-```typescript
-import { PartnerSearchItem } from '@tennac-booking/sdk';
-
-const instance: PartnerSearchItem = {
-    id,
-    firstName,
-    lastName,
-    profilePicture,
-    isFavorite,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)