UNPKG

@tennac-booking/sdk

Version:

OpenAPI client for @tennac-booking/sdk

368 lines (228 loc) 9.39 kB
# 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)