@tennac-booking/sdk 1.0.74 → 1.0.76

package/dist/esm/base.d.ts

@@ -2,7 +2,7 @@
  * openapi.json
  * Pandook API Documentation
  *
- * The version of the OpenAPI document: 1.0.74
+ * The version of the OpenAPI document: 1.0.75
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/base.js

@@ -4,7 +4,7 @@
  * openapi.json
  * Pandook API Documentation
  *
- * The version of the OpenAPI document: 1.0.74
+ * The version of the OpenAPI document: 1.0.75
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/common.d.ts

@@ -2,7 +2,7 @@
  * openapi.json
  * Pandook API Documentation
  *
- * The version of the OpenAPI document: 1.0.74
+ * The version of the OpenAPI document: 1.0.75
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/common.js

@@ -4,7 +4,7 @@
  * openapi.json
  * Pandook API Documentation
  *
- * The version of the OpenAPI document: 1.0.74
+ * The version of the OpenAPI document: 1.0.75
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/configuration.d.ts

@@ -2,7 +2,7 @@
  * openapi.json
  * Pandook API Documentation
  *
- * The version of the OpenAPI document: 1.0.74
+ * The version of the OpenAPI document: 1.0.75
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/configuration.js

@@ -4,7 +4,7 @@
  * openapi.json
  * Pandook API Documentation
  *
- * The version of the OpenAPI document: 1.0.74
+ * The version of the OpenAPI document: 1.0.75
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/index.d.ts

@@ -2,7 +2,7 @@
  * openapi.json
  * Pandook API Documentation
  *
- * The version of the OpenAPI document: 1.0.74
+ * The version of the OpenAPI document: 1.0.75
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/index.js

@@ -4,7 +4,7 @@
  * openapi.json
  * Pandook API Documentation
  *
- * The version of the OpenAPI document: 1.0.74
+ * The version of the OpenAPI document: 1.0.75
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/index.d.ts

@@ -2,7 +2,7 @@
  * openapi.json
  * Pandook API Documentation
  *
- * The version of the OpenAPI document: 1.0.74
+ * The version of the OpenAPI document: 1.0.75
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/index.js

@@ -5,7 +5,7 @@
  * openapi.json
  * Pandook API Documentation
  *
- * The version of the OpenAPI document: 1.0.74
+ * The version of the OpenAPI document: 1.0.75
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/docs/{BookingPriceBody.md → AddPaymentMethodRequestBody.md}

@@ -1,21 +1,19 @@
-# BookingPriceBody
+# AddPaymentMethodRequestBody
 
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**slotIds** | **Array<string>** |  | [default to undefined]
-**players** | **Array<string>** |  | [default to undefined]
+**paymentMethodId** | **string** |  | [default to undefined]
 
 ## Example
 
 ```typescript
-import { BookingPriceBody } from '@tennac-booking/sdk';
+import { AddPaymentMethodRequestBody } from '@tennac-booking/sdk';
 
-const instance: BookingPriceBody = {
-    slotIds,
-    players,
+const instance: AddPaymentMethodRequestBody = {
+    paymentMethodId,
 };
 ```
 

package/docs/BookingInfo.md

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 **playersIds** | **Array<string>** | Liste des IDs des joueurs | [default to undefined]
 **status** | [**BookingStatus**](BookingStatus.md) |  | [default to undefined]
 **totalPrice** | **number** | Prix total en euros | [default to undefined]
-**slotIds** | **Array<string>** | ID du créneau | [default to undefined]
+**slotId** | **string** | ID du créneau | [default to undefined]
 **isCreatorPayingAll** | **boolean** | Indique si le créateur paie pour tous | [default to undefined]
 **createdAt** | **string** | Date de création | [default to undefined]
 **updatedAt** | **string** | Date de mise à jour | [default to undefined]
@@ -34,7 +34,7 @@ const instance: BookingInfo = {
     playersIds,
     status,
     totalPrice,
-    slotIds,
+    slotId,
     isCreatorPayingAll,
     createdAt,
     updatedAt,

package/docs/BookingPopulated.md

@@ -14,7 +14,6 @@ Name | Type | Description | Notes
 **noShowChargeAmount** | **number** |  | [optional] [default to undefined]
 **totalPrice** | **number** |  | [default to undefined]
 **isCreatorPayingAll** | **boolean** |  | [default to undefined]
-**playersIds** | **Array<string>** |  | [default to undefined]
 **history** | [**Array<BookingHistoryPopulated>**](BookingHistoryPopulated.md) |  | [default to undefined]
 **status** | [**BookingStatus**](BookingStatus.md) |  | [default to undefined]
 **cancelledByManager** | **boolean** |  | [optional] [default to undefined]
@@ -36,7 +35,6 @@ const instance: BookingPopulated = {
     noShowChargeAmount,
     totalPrice,
     isCreatorPayingAll,
-    playersIds,
     history,
     status,
     cancelledByManager,

package/docs/BookingsApi.md

@@ -5,7 +5,6 @@ All URIs are relative to *http://localhost*
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**getBookingHistory**](#getbookinghistory) | **GET** /api/bookings/history/{bookingId} | |
-|[**getBookingPrice**](#getbookingprice) | **POST** /api/bookings/booking-price | |
 |[**getQuickReservationSlots**](#getquickreservationslots) | **GET** /api/bookings/quick-reservations | |
 
 # **getBookingHistory**
@@ -59,57 +58,6 @@ const { status, data } = await apiInstance.getBookingHistory(
 
 [[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)
 
-# **getBookingPrice**
-> Array<PlayerPrice> getBookingPrice(bookingPriceBody)
-
-
-### Example
-
-```typescript
-import {
-    BookingsApi,
-    Configuration,
-    BookingPriceBody
-} from '@tennac-booking/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new BookingsApi(configuration);
-
-let bookingPriceBody: BookingPriceBody; //
-
-const { status, data } = await apiInstance.getBookingPrice(
-    bookingPriceBody
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **bookingPriceBody** | **BookingPriceBody**|  | |
-
-
-### Return type
-
-**Array<PlayerPrice>**
-
-### 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é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)
-
 # **getQuickReservationSlots**
 > QuickReservationResponse getQuickReservationSlots()
 

package/docs/ClubAnalyticsStaffApi.md

@@ -5,6 +5,9 @@ All URIs are relative to *http://localhost*
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**getAnalyticsBySport**](#getanalyticsbysport) | **GET** /api/club-analytics/sport/{sportId}/analytics | |
+|[**getClubPlayerBookingsById**](#getclubplayerbookingsbyid) | **GET** /api/club-analytics/players/{playerId}/bookings | |
+|[**getClubPlayerById**](#getclubplayerbyid) | **GET** /api/club-analytics/players/{playerId} | |
+|[**getClubPlayerStatisticsById**](#getclubplayerstatisticsbyid) | **GET** /api/club-analytics/players/{playerId}/statistics | |
 |[**getClubPlayers**](#getclubplayers) | **GET** /api/club-analytics/players | |
 |[**getDailyTurnOver**](#getdailyturnover) | **GET** /api/club-analytics/daily-turnover | |
 |[**getGenderPercentage**](#getgenderpercentage) | **GET** /api/club-analytics/gender-percentage | |
@@ -69,6 +72,170 @@ const { status, data } = await apiInstance.getAnalyticsBySport(
 
 [[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)
 
+# **getClubPlayerBookingsById**
+> ClubPlayerBookingsResponse getClubPlayerBookingsById()
+
+Récupère les réservations d\'un joueur par son ID (à venir et passées)
+
+### Example
+
+```typescript
+import {
+    ClubAnalyticsStaffApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubAnalyticsStaffApi(configuration);
+
+let playerId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getClubPlayerBookingsById(
+    playerId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **playerId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ClubPlayerBookingsResponse**
+
+### 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 du joueur |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorized |  -  |
+|**500** | Server Error |  -  |
+
+[[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)
+
+# **getClubPlayerById**
+> ClubPlayerDetailResponse getClubPlayerById()
+
+Récupère les informations détaillées d\'un joueur par son ID
+
+### Example
+
+```typescript
+import {
+    ClubAnalyticsStaffApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubAnalyticsStaffApi(configuration);
+
+let playerId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getClubPlayerById(
+    playerId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **playerId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ClubPlayerDetailResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Informations du joueur |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorized |  -  |
+|**404** | Not Found |  -  |
+|**500** | Server Error |  -  |
+
+[[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)
+
+# **getClubPlayerStatisticsById**
+> ClubPlayerStatisticsResponse getClubPlayerStatisticsById()
+
+Récupère les statistiques d\'un joueur pour le staff
+
+### Example
+
+```typescript
+import {
+    ClubAnalyticsStaffApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubAnalyticsStaffApi(configuration);
+
+let playerId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getClubPlayerStatisticsById(
+    playerId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **playerId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ClubPlayerStatisticsResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Statistiques du joueur |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorized |  -  |
+|**404** | Not Found |  -  |
+|**500** | Server Error |  -  |
+
+[[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)
+
 # **getClubPlayers**
 > Array<ClubPlayerResponse> getClubPlayers()
 

package/docs/ClubPlayerBookingItem.md

@@ -0,0 +1,36 @@
+# ClubPlayerBookingItem
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | ID de la réservation | [default to undefined]
+**startDate** | **string** | Date de début de la réservation | [default to undefined]
+**endDate** | **string** | Date de fin de la réservation | [default to undefined]
+**location** | **string** | Nom du terrain ou emplacement | [default to undefined]
+**sport** | **string** | Nom du sport associé | [default to undefined]
+**status** | **string** | Statut de la réservation | [default to undefined]
+**totalPrice** | **number** | Prix total de la réservation en centimes | [default to undefined]
+**isCreator** | **boolean** | Indique si le joueur est le créateur de la réservation | [default to undefined]
+**participantsCount** | **number** | Nombre total de participants | [default to undefined]
+
+## Example
+
+```typescript
+import { ClubPlayerBookingItem } from '@tennac-booking/sdk';
+
+const instance: ClubPlayerBookingItem = {
+    id,
+    startDate,
+    endDate,
+    location,
+    sport,
+    status,
+    totalPrice,
+    isCreator,
+    participantsCount,
+};
+```
+
+[[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/ClubPlayerBookingsResponse.md

@@ -0,0 +1,22 @@
+# ClubPlayerBookingsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**upcomingBookings** | [**Array<ClubPlayerBookingItem>**](ClubPlayerBookingItem.md) | Réservations à venir | [default to undefined]
+**pastBookings** | [**Array<ClubPlayerBookingItem>**](ClubPlayerBookingItem.md) | Réservations passées | [default to undefined]
+
+## Example
+
+```typescript
+import { ClubPlayerBookingsResponse } from '@tennac-booking/sdk';
+
+const instance: ClubPlayerBookingsResponse = {
+    upcomingBookings,
+    pastBookings,
+};
+```
+
+[[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/ClubPlayerDetailResponse.md

@@ -0,0 +1,46 @@
+# ClubPlayerDetailResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | ID du joueur | [default to undefined]
+**name** | **string** | Nom complet | [default to undefined]
+**firstName** | **string** | Prénom | [default to undefined]
+**lastName** | **string** | Nom | [default to undefined]
+**email** | **string** | Email | [default to undefined]
+**phoneNumber** | **string** | Numéro de téléphone | [default to undefined]
+**profilePictureUrl** | **string** | URL de la photo de profil | [default to undefined]
+**isAccountVerified** | **boolean** | Compte vérifié | [default to undefined]
+**subscriptionsToMyClub** | [**Array<ClubPlayerSubscriptionSummary>**](ClubPlayerSubscriptionSummary.md) | Abonnements au club courant | [default to undefined]
+**profileDescription** | **string** | Description du profil | [default to undefined]
+**gender** | **string** | Genre | [default to undefined]
+**city** | **string** | Ville | [default to undefined]
+**sportsLevels** | [**Array<ClubPlayerDetailResponseSportsLevelsInner>**](ClubPlayerDetailResponseSportsLevelsInner.md) | Niveaux par sport | [default to undefined]
+**birthDate** | **string** | Date de naissance | [default to undefined]
+
+## Example
+
+```typescript
+import { ClubPlayerDetailResponse } from '@tennac-booking/sdk';
+
+const instance: ClubPlayerDetailResponse = {
+    id,
+    name,
+    firstName,
+    lastName,
+    email,
+    phoneNumber,
+    profilePictureUrl,
+    isAccountVerified,
+    subscriptionsToMyClub,
+    profileDescription,
+    gender,
+    city,
+    sportsLevels,
+    birthDate,
+};
+```
+
+[[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/ClubPlayerDetailResponseSportsLevelsInner.md

@@ -0,0 +1,22 @@
+# ClubPlayerDetailResponseSportsLevelsInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**level** | **string** |  | [default to undefined]
+**sport** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ClubPlayerDetailResponseSportsLevelsInner } from '@tennac-booking/sdk';
+
+const instance: ClubPlayerDetailResponseSportsLevelsInner = {
+    level,
+    sport,
+};
+```
+
+[[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/ClubPlayerStatisticsResponse.md

@@ -0,0 +1,42 @@
+# ClubPlayerStatisticsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**totalBookings** | **number** | Nombre total de réservations (tous clubs confondus) | [default to undefined]
+**totalBookingsInMyClub** | **number** | Nombre total de réservations dans le club courant | [default to undefined]
+**totalSpentAmount** | **number** | Somme totale dépensée dans le club courant (centimes) | [default to undefined]
+**favoriteSport** | **string** | Sport le plus pratiqué dans le club courant | [default to undefined]
+**averageBookingLeadTimeHours** | **number** | Temps moyen entre la réservation et le début du créneau (heures) | [default to undefined]
+**bookingCancellationRate** | **number** | Taux d\'annulation dans le club courant (0-1) | [default to undefined]
+**activeSubscriptionsToMyClub** | **number** | Nombre d\'abonnements actifs au club courant | [default to undefined]
+**favoriteTimeSlot** | **string** | Heure de créneau favorite dans le club courant (format HH:00) | [default to undefined]
+**favoriteClub** | [**ClubPlayerStatisticsResponseFavoriteClub**](ClubPlayerStatisticsResponseFavoriteClub.md) |  | [default to undefined]
+**mostPlayedClub** | [**ClubPlayerStatisticsResponseMostPlayedClub**](ClubPlayerStatisticsResponseMostPlayedClub.md) |  | [default to undefined]
+**bookingAmountEvolutionThisMonth** | [**Array<ClubPlayerStatisticsResponseBookingAmountEvolutionThisMonthInner>**](ClubPlayerStatisticsResponseBookingAmountEvolutionThisMonthInner.md) | Évolution quotidienne des montants dépensés ce mois-ci | [default to undefined]
+**mostPlayedPartners** | [**Array<ClubPlayerStatisticsResponseMostPlayedPartnersInner>**](ClubPlayerStatisticsResponseMostPlayedPartnersInner.md) | Joueurs les plus joués dans le club courant | [default to undefined]
+
+## Example
+
+```typescript
+import { ClubPlayerStatisticsResponse } from '@tennac-booking/sdk';
+
+const instance: ClubPlayerStatisticsResponse = {
+    totalBookings,
+    totalBookingsInMyClub,
+    totalSpentAmount,
+    favoriteSport,
+    averageBookingLeadTimeHours,
+    bookingCancellationRate,
+    activeSubscriptionsToMyClub,
+    favoriteTimeSlot,
+    favoriteClub,
+    mostPlayedClub,
+    bookingAmountEvolutionThisMonth,
+    mostPlayedPartners,
+};
+```
+
+[[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/ClubPlayerStatisticsResponseBookingAmountEvolutionThisMonthInner.md

@@ -0,0 +1,22 @@
+# ClubPlayerStatisticsResponseBookingAmountEvolutionThisMonthInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **number** |  | [default to undefined]
+**day** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ClubPlayerStatisticsResponseBookingAmountEvolutionThisMonthInner } from '@tennac-booking/sdk';
+
+const instance: ClubPlayerStatisticsResponseBookingAmountEvolutionThisMonthInner = {
+    amount,
+    day,
+};
+```
+
+[[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/ClubPlayerStatisticsResponseFavoriteClub.md

@@ -0,0 +1,23 @@
+# ClubPlayerStatisticsResponseFavoriteClub
+
+Club favori selon le profil utilisateur
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [default to undefined]
+**clubId** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ClubPlayerStatisticsResponseFavoriteClub } from '@tennac-booking/sdk';
+
+const instance: ClubPlayerStatisticsResponseFavoriteClub = {
+    name,
+    clubId,
+};
+```
+
+[[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/ClubPlayerStatisticsResponseMostPlayedClub.md

@@ -0,0 +1,25 @@
+# ClubPlayerStatisticsResponseMostPlayedClub
+
+Club où le joueur a le plus joué
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**bookingsCount** | **number** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**clubId** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ClubPlayerStatisticsResponseMostPlayedClub } from '@tennac-booking/sdk';
+
+const instance: ClubPlayerStatisticsResponseMostPlayedClub = {
+    bookingsCount,
+    name,
+    clubId,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)