@tennac-booking/sdk 1.0.18 → 1.0.20

package/docs/ClubInfoResponse.md

@@ -14,6 +14,7 @@ Name | Type | Description | Notes
 **phone** | **string** |  | [optional] [default to undefined]
 **email** | **string** |  | [optional] [default to undefined]
 **website** | **string** |  | [optional] [default to undefined]
+**rib** | **string** |  | [optional] [default to undefined]
 **description** | **string** |  | [optional] [default to undefined]
 **logo** | **string** |  | [optional] [default to undefined]
 **isActive** | **boolean** |  | [optional] [default to undefined]
@@ -35,6 +36,7 @@ const instance: ClubInfoResponse = {
     phone,
     email,
     website,
+    rib,
     description,
     logo,
     isActive,

package/docs/DailyTurnoverResponse.md

@@ -0,0 +1,24 @@
+# DailyTurnoverResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**date** | **string** |  | [optional] [default to undefined]
+**totalTurnover** | **number** |  | [optional] [default to undefined]
+**invoiceCount** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DailyTurnoverResponse } from '@tennac-booking/sdk';
+
+const instance: DailyTurnoverResponse = {
+    date,
+    totalTurnover,
+    invoiceCount,
+};
+```
+
+[[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/GetLastSixMonthsTurnover200ResponseInner.md

@@ -6,7 +6,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **year** | **number** |  | [optional] [default to undefined]
-**month** | **number** |  | [optional] [default to undefined]
+**month** | **string** |  | [optional] [default to undefined]
 **total** | **number** |  | [optional] [default to undefined]
 
 ## Example

package/docs/InvoicesResponse.md

@@ -0,0 +1,22 @@
+# InvoicesResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**invoices** | [**Array<InvoicesResponseInvoicesInner>**](InvoicesResponseInvoicesInner.md) |  | [optional] [default to undefined]
+**pagination** | [**InvoicesResponsePagination**](InvoicesResponsePagination.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { InvoicesResponse } from '@tennac-booking/sdk';
+
+const instance: InvoicesResponse = {
+    invoices,
+    pagination,
+};
+```
+
+[[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/InvoicesResponseInvoicesInner.md

@@ -0,0 +1,34 @@
+# InvoicesResponseInvoicesInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**billNumber** | **string** |  | [optional] [default to undefined]
+**date** | **string** |  | [optional] [default to undefined]
+**clientFirstName** | **string** |  | [optional] [default to undefined]
+**clientLastName** | **string** |  | [optional] [default to undefined]
+**clientEmail** | **string** |  | [optional] [default to undefined]
+**totalCost** | **number** |  | [optional] [default to undefined]
+**status** | **string** |  | [optional] [default to undefined]
+**linkToInvoicePDF** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { InvoicesResponseInvoicesInner } from '@tennac-booking/sdk';
+
+const instance: InvoicesResponseInvoicesInner = {
+    billNumber,
+    date,
+    clientFirstName,
+    clientLastName,
+    clientEmail,
+    totalCost,
+    status,
+    linkToInvoicePDF,
+};
+```
+
+[[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/InvoicesResponsePagination.md

@@ -0,0 +1,26 @@
+# InvoicesResponsePagination
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **number** |  | [optional] [default to undefined]
+**page** | **number** |  | [optional] [default to undefined]
+**limit** | **number** |  | [optional] [default to undefined]
+**totalPages** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { InvoicesResponsePagination } from '@tennac-booking/sdk';
+
+const instance: InvoicesResponsePagination = {
+    total,
+    page,
+    limit,
+    totalPages,
+};
+```
+
+[[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/ManagerBookingsApi.md

@@ -0,0 +1,243 @@
+# ManagerBookingsApi
+
+All URIs are relative to *https://api.mon-domaine.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**applyNoShowFee**](#applynoshowfee) | **POST** /api/bookings/{bookingId}/apply-noshow-fee | Appliquer les frais de no-show|
+|[**checkInPlayers**](#checkinplayers) | **POST** /api/bookings/{bookingId}/checkin-players | Enregistrer l\'arrivée des joueurs|
+|[**getBookingPaymentStatus**](#getbookingpaymentstatus) | **GET** /api/bookings/{bookingId}/payment-status | Obtenir le statut des paiements d\'une réservation|
+|[**managerCancelBooking**](#managercancelbooking) | **DELETE** /api/bookings/{bookingId}/manager-cancel | Annuler une réservation (gestionnaire)|
+
+# **applyNoShowFee**
+> NoShowFeeResponse applyNoShowFee()
+
+Applique les frais de no-show à une réservation. Capture automatiquement les paiements autorisés et charge le créateur pour le montant manquant.
+
+### Example
+
+```typescript
+import {
+    ManagerBookingsApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ManagerBookingsApi(configuration);
+
+let bookingId: string; //ID MongoDB de la réservation (default to undefined)
+
+const { status, data } = await apiInstance.applyNoShowFee(
+    bookingId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **bookingId** | [**string**] | ID MongoDB de la réservation | defaults to undefined|
+
+
+### Return type
+
+**NoShowFeeResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Frais de no-show appliqués avec succès |  -  |
+|**400** | Requête invalide |  -  |
+|**401** | Non autorisé |  -  |
+|**403** | Accès interdit |  -  |
+|**404** | Ressource non trouvée |  -  |
+|**500** | Erreur serveur interne |  -  |
+
+[[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)
+
+# **checkInPlayers**
+> CheckInPlayersResponse checkInPlayers(checkInPlayersRequest)
+
+Enregistre l\'arrivée et le paiement des joueurs pour une réservation avec paiement sur place. Met à jour le statut des factures.
+
+### Example
+
+```typescript
+import {
+    ManagerBookingsApi,
+    Configuration,
+    CheckInPlayersRequest
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ManagerBookingsApi(configuration);
+
+let bookingId: string; //ID MongoDB de la réservation (default to undefined)
+let checkInPlayersRequest: CheckInPlayersRequest; //
+
+const { status, data } = await apiInstance.checkInPlayers(
+    bookingId,
+    checkInPlayersRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **checkInPlayersRequest** | **CheckInPlayersRequest**|  | |
+| **bookingId** | [**string**] | ID MongoDB de la réservation | defaults to undefined|
+
+
+### Return type
+
+**CheckInPlayersResponse**
+
+### 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 |  -  |
+|**400** | Requête invalide |  -  |
+|**401** | Non autorisé |  -  |
+|**403** | Accès interdit |  -  |
+|**404** | Réservation non trouvée |  -  |
+|**500** | Erreur serveur interne |  -  |
+
+[[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()
+
+Récupère le statut détaillé des paiements pour tous les joueurs d\'une réservation. Utile pour l\'interface de check-in.
+
+### Example
+
+```typescript
+import {
+    ManagerBookingsApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ManagerBookingsApi(configuration);
+
+let bookingId: string; //ID MongoDB de la réservation (default to undefined)
+
+const { status, data } = await apiInstance.getBookingPaymentStatus(
+    bookingId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **bookingId** | [**string**] | ID MongoDB de la réservation | 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é avec succès |  -  |
+|**400** | ID de réservation invalide |  -  |
+|**401** | Non autorisé |  -  |
+|**403** | Accès interdit |  -  |
+|**404** | Réservation non trouvée |  -  |
+|**500** | Erreur serveur interne |  -  |
+
+[[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)
+
+# **managerCancelBooking**
+> ManagerCancelBookingResponse managerCancelBooking(managerCancelBookingRequest)
+
+Permet à un gestionnaire d\'annuler n\'importe quelle réservation avec une raison obligatoire. Effectue un remboursement automatique si le paiement a été fait en ligne.
+
+### Example
+
+```typescript
+import {
+    ManagerBookingsApi,
+    Configuration,
+    ManagerCancelBookingRequest
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ManagerBookingsApi(configuration);
+
+let bookingId: string; //ID MongoDB de la réservation à annuler (default to undefined)
+let managerCancelBookingRequest: ManagerCancelBookingRequest; //
+
+const { status, data } = await apiInstance.managerCancelBooking(
+    bookingId,
+    managerCancelBookingRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **managerCancelBookingRequest** | **ManagerCancelBookingRequest**|  | |
+| **bookingId** | [**string**] | ID MongoDB de la réservation à annuler | defaults to undefined|
+
+
+### Return type
+
+**ManagerCancelBookingResponse**
+
+### 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 annulée par le gestionnaire avec succès |  -  |
+|**400** | Requête invalide |  -  |
+|**401** | Non autorisé |  -  |
+|**403** | Accès interdit |  -  |
+|**404** | Réservation non trouvée |  -  |
+|**500** | Erreur serveur interne |  -  |
+
+[[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/ManagerCancelBookingRequest.md

@@ -0,0 +1,20 @@
+# ManagerCancelBookingRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**reason** | **string** | Raison obligatoire de l\'annulation par le gestionnaire | [default to undefined]
+
+## Example
+
+```typescript
+import { ManagerCancelBookingRequest } from '@tennac-booking/sdk';
+
+const instance: ManagerCancelBookingRequest = {
+    reason,
+};
+```
+
+[[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/ManagerCancelBookingResponse.md

@@ -5,8 +5,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**message** | **string** | Message de confirmation | [default to undefined]
-**booking** | [**ManagerCancelBookingResponseBooking**](ManagerCancelBookingResponseBooking.md) |  | [default to undefined]
+**message** | **string** |  | [optional] [default to undefined]
+**booking** | [**ManagerCancelBookingResponseBooking**](ManagerCancelBookingResponseBooking.md) |  | [optional] [default to undefined]
 
 ## Example
 

package/docs/ManagerCancelBookingResponseBooking.md

@@ -5,12 +5,12 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **string** | ID de la réservation | [default to undefined]
-**status** | **string** | Nouveau statut de la réservation | [default to undefined]
-**cancellationReason** | **string** | Raison de l\'annulation par le gestionnaire | [default to undefined]
-**cancelledAt** | **string** | Date et heure d\'annulation | [default to undefined]
-**cancelledBy** | **string** | ID du gestionnaire qui a annulé | [default to undefined]
-**cancelledByManager** | **boolean** | Toujours true pour les annulations par gestionnaire | [default to undefined]
+**id** | **string** |  | [optional] [default to undefined]
+**status** | **string** |  | [optional] [default to undefined]
+**cancellationReason** | **string** |  | [optional] [default to undefined]
+**cancelledAt** | **string** |  | [optional] [default to undefined]
+**cancelledBy** | **string** |  | [optional] [default to undefined]
+**cancelledByManager** | **boolean** |  | [optional] [default to undefined]
 
 ## Example
 

package/docs/MonthlyTurnoverResponse.md

@@ -0,0 +1,28 @@
+# MonthlyTurnoverResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**year** | **number** |  | [optional] [default to undefined]
+**month** | **number** |  | [optional] [default to undefined]
+**totalTurnover** | **number** |  | [optional] [default to undefined]
+**invoiceCount** | **number** |  | [optional] [default to undefined]
+**period** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { MonthlyTurnoverResponse } from '@tennac-booking/sdk';
+
+const instance: MonthlyTurnoverResponse = {
+    year,
+    month,
+    totalTurnover,
+    invoiceCount,
+    period,
+};
+```
+
+[[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/NoShowFeeResponse.md

@@ -0,0 +1,30 @@
+# NoShowFeeResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** |  | [optional] [default to undefined]
+**totalExpected** | **number** |  | [optional] [default to undefined]
+**totalCaptured** | **number** |  | [optional] [default to undefined]
+**missingAmount** | **number** |  | [optional] [default to undefined]
+**captureResults** | [**Array<NoShowFeeResponseCaptureResultsInner>**](NoShowFeeResponseCaptureResultsInner.md) |  | [optional] [default to undefined]
+**creatorChargeResult** | [**NoShowFeeResponseCreatorChargeResult**](NoShowFeeResponseCreatorChargeResult.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { NoShowFeeResponse } from '@tennac-booking/sdk';
+
+const instance: NoShowFeeResponse = {
+    message,
+    totalExpected,
+    totalCaptured,
+    missingAmount,
+    captureResults,
+    creatorChargeResult,
+};
+```
+
+[[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/NoShowFeeResponseCaptureResultsInner.md

@@ -0,0 +1,30 @@
+# NoShowFeeResponseCaptureResultsInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **string** |  | [optional] [default to undefined]
+**playerId** | **string** |  | [optional] [default to undefined]
+**paymentIntentId** | **string** |  | [optional] [default to undefined]
+**amount** | **number** |  | [optional] [default to undefined]
+**status** | **string** |  | [optional] [default to undefined]
+**error** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { NoShowFeeResponseCaptureResultsInner } from '@tennac-booking/sdk';
+
+const instance: NoShowFeeResponseCaptureResultsInner = {
+    type,
+    playerId,
+    paymentIntentId,
+    amount,
+    status,
+    error,
+};
+```
+
+[[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/NoShowFeeResponseCreatorChargeResult.md

@@ -0,0 +1,26 @@
+# NoShowFeeResponseCreatorChargeResult
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**success** | **boolean** |  | [optional] [default to undefined]
+**paymentIntentId** | **string** |  | [optional] [default to undefined]
+**amount** | **number** |  | [optional] [default to undefined]
+**error** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { NoShowFeeResponseCreatorChargeResult } from '@tennac-booking/sdk';
+
+const instance: NoShowFeeResponseCreatorChargeResult = {
+    success,
+    paymentIntentId,
+    amount,
+    error,
+};
+```
+
+[[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/StaffClubAnalyticsApi.md

@@ -5,7 +5,7 @@ All URIs are relative to *https://api.mon-domaine.com*
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**getLastSixMonthsTurnover**](#getlastsixmonthsturnover) | **GET** /api/clubs/{id}/turnover | Get monthly turnover for the last six months|
-|[**getNumberOfClubUsers**](#getnumberofclubusers) | **GET** /api/clubs/{id}/user-count | Get number of users subscribed to the club|
+|[**getNumberOfClubUsers**](#getnumberofclubusers) | **GET** /api/clubs/user-count | Get number of users subscribed to the club|
 
 # **getLastSixMonthsTurnover**
 > Array<GetLastSixMonthsTurnover200ResponseInner> getLastSixMonthsTurnover()
@@ -73,18 +73,11 @@ import {
 const configuration = new Configuration();
 const apiInstance = new StaffClubAnalyticsApi(configuration);
 
-let id: string; //ID du club (default to undefined)
-
-const { status, data } = await apiInstance.getNumberOfClubUsers(
-    id
-);
+const { status, data } = await apiInstance.getNumberOfClubUsers();
 ```
 
 ### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] | ID du club | defaults to undefined|
+This endpoint does not have any parameters.
 
 
 ### Return type

package/docs/StaffClubSettingsApi.md

@@ -7,7 +7,7 @@ All URIs are relative to *https://api.mon-domaine.com*
 |[**getClubSettings**](#getclubsettings) | **GET** /api/club-settings | Récupère les paramètres d\'un club|
 
 # **getClubSettings**
-> ClubSettings getClubSettings(getClubSettingsRequest)
+> ClubSettings getClubSettings()
 
 
 ### Example
@@ -15,25 +15,17 @@ All URIs are relative to *https://api.mon-domaine.com*
 ```typescript
 import {
     StaffClubSettingsApi,
-    Configuration,
-    GetClubSettingsRequest
+    Configuration
 } from '@tennac-booking/sdk';
 
 const configuration = new Configuration();
 const apiInstance = new StaffClubSettingsApi(configuration);
 
-let getClubSettingsRequest: GetClubSettingsRequest; //
-
-const { status, data } = await apiInstance.getClubSettings(
-    getClubSettingsRequest
-);
+const { status, data } = await apiInstance.getClubSettings();
 ```
 
 ### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **getClubSettingsRequest** | **GetClubSettingsRequest**|  | |
+This endpoint does not have any parameters.
 
 
 ### Return type
@@ -46,7 +38,7 @@ const { status, data } = await apiInstance.getClubSettings(
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
+ - **Content-Type**: Not defined
  - **Accept**: application/json
 
 

package/docs/YearlyTurnoverResponse.md

@@ -0,0 +1,26 @@
+# YearlyTurnoverResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**year** | **number** |  | [optional] [default to undefined]
+**totalTurnover** | **number** |  | [optional] [default to undefined]
+**totalInvoices** | **number** |  | [optional] [default to undefined]
+**monthlyBreakdown** | [**Array<YearlyTurnoverResponseMonthlyBreakdownInner>**](YearlyTurnoverResponseMonthlyBreakdownInner.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { YearlyTurnoverResponse } from '@tennac-booking/sdk';
+
+const instance: YearlyTurnoverResponse = {
+    year,
+    totalTurnover,
+    totalInvoices,
+    monthlyBreakdown,
+};
+```
+
+[[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/YearlyTurnoverResponseMonthlyBreakdownInner.md

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