@tennac-booking/sdk 1.0.18 → 1.0.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (58) hide show
  1. package/.openapi-generator/FILES +22 -0
  2. package/README.md +31 -3
  3. package/api.ts +1983 -271
  4. package/base.ts +1 -1
  5. package/common.ts +1 -1
  6. package/configuration.ts +1 -1
  7. package/dist/api.d.ts +1472 -245
  8. package/dist/api.js +944 -116
  9. package/dist/base.d.ts +1 -1
  10. package/dist/base.js +1 -1
  11. package/dist/common.d.ts +1 -1
  12. package/dist/common.js +1 -1
  13. package/dist/configuration.d.ts +1 -1
  14. package/dist/configuration.js +1 -1
  15. package/dist/esm/api.d.ts +1472 -245
  16. package/dist/esm/api.js +927 -111
  17. package/dist/esm/base.d.ts +1 -1
  18. package/dist/esm/base.js +1 -1
  19. package/dist/esm/common.d.ts +1 -1
  20. package/dist/esm/common.js +1 -1
  21. package/dist/esm/configuration.d.ts +1 -1
  22. package/dist/esm/configuration.js +1 -1
  23. package/dist/esm/index.d.ts +1 -1
  24. package/dist/esm/index.js +1 -1
  25. package/dist/index.d.ts +1 -1
  26. package/dist/index.js +1 -1
  27. package/docs/BookingPaymentStatusResponse.md +24 -0
  28. package/docs/BookingPaymentStatusResponseBooking.md +26 -0
  29. package/docs/BookingPaymentStatusResponsePaymentStatusInner.md +36 -0
  30. package/docs/BookingPaymentStatusResponseSummary.md +28 -0
  31. package/docs/BookingsApi.md +68 -0
  32. package/docs/CancelBookingRequest.md +20 -0
  33. package/docs/CancelBookingResponse.md +2 -2
  34. package/docs/CancelBookingResponseBooking.md +6 -6
  35. package/docs/CheckInPlayersRequest.md +20 -0
  36. package/docs/CheckInPlayersResponse.md +30 -0
  37. package/docs/CheckInPlayersResponseCheckedInPlayersInner.md +34 -0
  38. package/docs/ClubAnalyticsApi.md +253 -0
  39. package/docs/ClubInfoResponse.md +2 -0
  40. package/docs/DailyTurnoverResponse.md +24 -0
  41. package/docs/GetLastSixMonthsTurnover200ResponseInner.md +1 -1
  42. package/docs/InvoicesResponse.md +22 -0
  43. package/docs/InvoicesResponseInvoicesInner.md +34 -0
  44. package/docs/InvoicesResponsePagination.md +26 -0
  45. package/docs/ManagerBookingsApi.md +243 -0
  46. package/docs/ManagerCancelBookingRequest.md +20 -0
  47. package/docs/ManagerCancelBookingResponse.md +2 -2
  48. package/docs/ManagerCancelBookingResponseBooking.md +6 -6
  49. package/docs/MonthlyTurnoverResponse.md +28 -0
  50. package/docs/NoShowFeeResponse.md +30 -0
  51. package/docs/NoShowFeeResponseCaptureResultsInner.md +30 -0
  52. package/docs/NoShowFeeResponseCreatorChargeResult.md +26 -0
  53. package/docs/StaffClubAnalyticsApi.md +3 -10
  54. package/docs/StaffClubSettingsApi.md +5 -13
  55. package/docs/YearlyTurnoverResponse.md +26 -0
  56. package/docs/YearlyTurnoverResponseMonthlyBreakdownInner.md +24 -0
  57. package/index.ts +1 -1
  58. package/package.json +1 -1
@@ -2,7 +2,7 @@
2
2
  * Pickle Ball API
3
3
  * API for managing pickle ball games and players
4
4
  *
5
- * The version of the OpenAPI document: 1.0.17
5
+ * The version of the OpenAPI document: 1.0.19
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/base.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Pickle Ball API
5
5
  * API for managing pickle ball games and players
6
6
  *
7
- * The version of the OpenAPI document: 1.0.17
7
+ * The version of the OpenAPI document: 1.0.19
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Pickle Ball API
3
3
  * API for managing pickle ball games and players
4
4
  *
5
- * The version of the OpenAPI document: 1.0.17
5
+ * The version of the OpenAPI document: 1.0.19
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Pickle Ball API
5
5
  * API for managing pickle ball games and players
6
6
  *
7
- * The version of the OpenAPI document: 1.0.17
7
+ * The version of the OpenAPI document: 1.0.19
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Pickle Ball API
3
3
  * API for managing pickle ball games and players
4
4
  *
5
- * The version of the OpenAPI document: 1.0.17
5
+ * The version of the OpenAPI document: 1.0.19
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Pickle Ball API
5
5
  * API for managing pickle ball games and players
6
6
  *
7
- * The version of the OpenAPI document: 1.0.17
7
+ * The version of the OpenAPI document: 1.0.19
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Pickle Ball API
3
3
  * API for managing pickle ball games and players
4
4
  *
5
- * The version of the OpenAPI document: 1.0.17
5
+ * The version of the OpenAPI document: 1.0.19
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/index.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Pickle Ball API
5
5
  * API for managing pickle ball games and players
6
6
  *
7
- * The version of the OpenAPI document: 1.0.17
7
+ * The version of the OpenAPI document: 1.0.19
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/index.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Pickle Ball API
3
3
  * API for managing pickle ball games and players
4
4
  *
5
- * The version of the OpenAPI document: 1.0.17
5
+ * The version of the OpenAPI document: 1.0.19
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/index.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Pickle Ball API
6
6
  * API for managing pickle ball games and players
7
7
  *
8
- * The version of the OpenAPI document: 1.0.17
8
+ * The version of the OpenAPI document: 1.0.19
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -0,0 +1,24 @@
1
+ # BookingPaymentStatusResponse
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **booking** | [**BookingPaymentStatusResponseBooking**](BookingPaymentStatusResponseBooking.md) | | [optional] [default to undefined]
9
+ **paymentStatus** | [**Array<BookingPaymentStatusResponsePaymentStatusInner>**](BookingPaymentStatusResponsePaymentStatusInner.md) | | [optional] [default to undefined]
10
+ **summary** | [**BookingPaymentStatusResponseSummary**](BookingPaymentStatusResponseSummary.md) | | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { BookingPaymentStatusResponse } from '@tennac-booking/sdk';
16
+
17
+ const instance: BookingPaymentStatusResponse = {
18
+ booking,
19
+ paymentStatus,
20
+ summary,
21
+ };
22
+ ```
23
+
24
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,26 @@
1
+ # BookingPaymentStatusResponseBooking
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **string** | | [optional] [default to undefined]
9
+ **status** | **string** | | [optional] [default to undefined]
10
+ **isCreatorPayingAll** | **boolean** | | [optional] [default to undefined]
11
+ **totalPrice** | **number** | | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { BookingPaymentStatusResponseBooking } from '@tennac-booking/sdk';
17
+
18
+ const instance: BookingPaymentStatusResponseBooking = {
19
+ id,
20
+ status,
21
+ isCreatorPayingAll,
22
+ totalPrice,
23
+ };
24
+ ```
25
+
26
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,36 @@
1
+ # BookingPaymentStatusResponsePaymentStatusInner
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **playerId** | **string** | | [optional] [default to undefined]
9
+ **playerName** | **string** | | [optional] [default to undefined]
10
+ **playerEmail** | **string** | | [optional] [default to undefined]
11
+ **amount** | **number** | | [optional] [default to undefined]
12
+ **paymentMethod** | **string** | | [optional] [default to undefined]
13
+ **status** | **string** | | [optional] [default to undefined]
14
+ **accepted** | **boolean** | | [optional] [default to undefined]
15
+ **hasPaid** | **boolean** | | [optional] [default to undefined]
16
+ **needsCheckIn** | **boolean** | Indique si le joueur a besoin d\'être enregistré (paiement sur place en attente) | [optional] [default to undefined]
17
+
18
+ ## Example
19
+
20
+ ```typescript
21
+ import { BookingPaymentStatusResponsePaymentStatusInner } from '@tennac-booking/sdk';
22
+
23
+ const instance: BookingPaymentStatusResponsePaymentStatusInner = {
24
+ playerId,
25
+ playerName,
26
+ playerEmail,
27
+ amount,
28
+ paymentMethod,
29
+ status,
30
+ accepted,
31
+ hasPaid,
32
+ needsCheckIn,
33
+ };
34
+ ```
35
+
36
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,28 @@
1
+ # BookingPaymentStatusResponseSummary
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **totalPlayers** | **number** | | [optional] [default to undefined]
9
+ **playersWhoHavePaid** | **number** | | [optional] [default to undefined]
10
+ **playersNeedingCheckIn** | **number** | | [optional] [default to undefined]
11
+ **totalAmount** | **number** | | [optional] [default to undefined]
12
+ **paidAmount** | **number** | | [optional] [default to undefined]
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import { BookingPaymentStatusResponseSummary } from '@tennac-booking/sdk';
18
+
19
+ const instance: BookingPaymentStatusResponseSummary = {
20
+ totalPlayers,
21
+ playersWhoHavePaid,
22
+ playersNeedingCheckIn,
23
+ totalAmount,
24
+ paidAmount,
25
+ };
26
+ ```
27
+
28
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,68 @@
1
+ # BookingsApi
2
+
3
+ All URIs are relative to *https://api.mon-domaine.com*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**cancelBooking**](#cancelbooking) | **DELETE** /api/bookings/{bookingId}/cancel | Annuler une réservation (créateur uniquement)|
8
+
9
+ # **cancelBooking**
10
+ > CancelBookingResponse cancelBooking(cancelBookingRequest)
11
+
12
+ Permet au créateur d\'une réservation de l\'annuler. Rouvre automatiquement le créneau et envoie des emails de notification à tous les participants.
13
+
14
+ ### Example
15
+
16
+ ```typescript
17
+ import {
18
+ BookingsApi,
19
+ Configuration,
20
+ CancelBookingRequest
21
+ } from '@tennac-booking/sdk';
22
+
23
+ const configuration = new Configuration();
24
+ const apiInstance = new BookingsApi(configuration);
25
+
26
+ let bookingId: string; //ID MongoDB de la réservation à annuler (default to undefined)
27
+ let cancelBookingRequest: CancelBookingRequest; //
28
+
29
+ const { status, data } = await apiInstance.cancelBooking(
30
+ bookingId,
31
+ cancelBookingRequest
32
+ );
33
+ ```
34
+
35
+ ### Parameters
36
+
37
+ |Name | Type | Description | Notes|
38
+ |------------- | ------------- | ------------- | -------------|
39
+ | **cancelBookingRequest** | **CancelBookingRequest**| | |
40
+ | **bookingId** | [**string**] | ID MongoDB de la réservation à annuler | defaults to undefined|
41
+
42
+
43
+ ### Return type
44
+
45
+ **CancelBookingResponse**
46
+
47
+ ### Authorization
48
+
49
+ [bearerAuth](../README.md#bearerAuth)
50
+
51
+ ### HTTP request headers
52
+
53
+ - **Content-Type**: application/json
54
+ - **Accept**: application/json
55
+
56
+
57
+ ### HTTP response details
58
+ | Status code | Description | Response headers |
59
+ |-------------|-------------|------------------|
60
+ |**200** | Réservation annulée avec succès | - |
61
+ |**400** | Requête invalide | - |
62
+ |**401** | Non autorisé | - |
63
+ |**403** | Accès interdit - Seul le créateur peut annuler | - |
64
+ |**404** | Réservation non trouvée | - |
65
+ |**500** | Erreur serveur interne | - |
66
+
67
+ [[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)
68
+
@@ -0,0 +1,20 @@
1
+ # CancelBookingRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **userId** | **string** | ID de l\'utilisateur créateur pour vérification | [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { CancelBookingRequest } from '@tennac-booking/sdk';
14
+
15
+ const instance: CancelBookingRequest = {
16
+ userId,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -5,8 +5,8 @@
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
- **message** | **string** | Message de confirmation | [default to undefined]
9
- **booking** | [**CancelBookingResponseBooking**](CancelBookingResponseBooking.md) | | [default to undefined]
8
+ **message** | **string** | | [optional] [default to undefined]
9
+ **booking** | [**CancelBookingResponseBooking**](CancelBookingResponseBooking.md) | | [optional] [default to undefined]
10
10
 
11
11
  ## Example
12
12
 
@@ -5,12 +5,12 @@
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
- **id** | **string** | ID de la réservation | [default to undefined]
9
- **status** | **string** | Nouveau statut de la réservation | [default to undefined]
10
- **cancelledAt** | **string** | Date et heure d\'annulation | [default to undefined]
11
- **cancelledBy** | **string** | ID de l\'utilisateur qui a annulé | [default to undefined]
12
- **cancelledByManager** | **boolean** | Indique si annulé par un gestionnaire | [default to undefined]
13
- **cancellationReason** | **string** | Raison de l\'annulation (si fournie) | [optional] [default to undefined]
8
+ **id** | **string** | | [optional] [default to undefined]
9
+ **status** | **string** | | [optional] [default to undefined]
10
+ **cancelledAt** | **string** | | [optional] [default to undefined]
11
+ **cancelledBy** | **string** | | [optional] [default to undefined]
12
+ **cancelledByManager** | **boolean** | | [optional] [default to undefined]
13
+ **cancellationReason** | **string** | | [optional] [default to undefined]
14
14
 
15
15
  ## Example
16
16
 
@@ -0,0 +1,20 @@
1
+ # CheckInPlayersRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **playerIds** | **Array<string>** | Liste des IDs des joueurs qui ont payé/sont arrivés | [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { CheckInPlayersRequest } from '@tennac-booking/sdk';
14
+
15
+ const instance: CheckInPlayersRequest = {
16
+ playerIds,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,30 @@
1
+ # CheckInPlayersResponse
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **message** | **string** | | [optional] [default to undefined]
9
+ **checkedInPlayers** | [**Array<CheckInPlayersResponseCheckedInPlayersInner>**](CheckInPlayersResponseCheckedInPlayersInner.md) | | [optional] [default to undefined]
10
+ **notFoundPlayers** | **Array<string>** | | [optional] [default to undefined]
11
+ **allPlayersCheckedIn** | **boolean** | | [optional] [default to undefined]
12
+ **bookingFullyPaid** | **boolean** | | [optional] [default to undefined]
13
+ **totalPlayers** | **number** | | [optional] [default to undefined]
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import { CheckInPlayersResponse } from '@tennac-booking/sdk';
19
+
20
+ const instance: CheckInPlayersResponse = {
21
+ message,
22
+ checkedInPlayers,
23
+ notFoundPlayers,
24
+ allPlayersCheckedIn,
25
+ bookingFullyPaid,
26
+ totalPlayers,
27
+ };
28
+ ```
29
+
30
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,34 @@
1
+ # CheckInPlayersResponseCheckedInPlayersInner
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **playerId** | **string** | | [optional] [default to undefined]
9
+ **invoiceId** | **string** | | [optional] [default to undefined]
10
+ **amount** | **number** | | [optional] [default to undefined]
11
+ **previousStatus** | **string** | | [optional] [default to undefined]
12
+ **newStatus** | **string** | | [optional] [default to undefined]
13
+ **status** | **string** | | [optional] [default to undefined]
14
+ **paymentMethod** | **string** | | [optional] [default to undefined]
15
+ **note** | **string** | | [optional] [default to undefined]
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import { CheckInPlayersResponseCheckedInPlayersInner } from '@tennac-booking/sdk';
21
+
22
+ const instance: CheckInPlayersResponseCheckedInPlayersInner = {
23
+ playerId,
24
+ invoiceId,
25
+ amount,
26
+ previousStatus,
27
+ newStatus,
28
+ status,
29
+ paymentMethod,
30
+ note,
31
+ };
32
+ ```
33
+
34
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,253 @@
1
+ # ClubAnalyticsApi
2
+
3
+ All URIs are relative to *https://api.mon-domaine.com*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**getDailyTurnOver**](#getdailyturnover) | **GET** /api/clubs/{id}/turnover/daily | Chiffre d\'affaires quotidien|
8
+ |[**getInvoices**](#getinvoices) | **GET** /api/clubs/{id}/invoices | Récupérer les factures du club|
9
+ |[**getMonthlyTurnOver**](#getmonthlyturnover) | **GET** /api/clubs/{id}/turnover/monthly | Chiffre d\'affaires mensuel|
10
+ |[**getYearlyTurnOver**](#getyearlyturnover) | **GET** /api/clubs/{id}/turnover/yearly | Chiffre d\'affaires annuel|
11
+
12
+ # **getDailyTurnOver**
13
+ > DailyTurnoverResponse getDailyTurnOver()
14
+
15
+
16
+ ### Example
17
+
18
+ ```typescript
19
+ import {
20
+ ClubAnalyticsApi,
21
+ Configuration
22
+ } from '@tennac-booking/sdk';
23
+
24
+ const configuration = new Configuration();
25
+ const apiInstance = new ClubAnalyticsApi(configuration);
26
+
27
+ let id: string; //ID du club (default to undefined)
28
+ let date: string; //Date (format YYYY-MM-DD) (default to undefined)
29
+
30
+ const { status, data } = await apiInstance.getDailyTurnOver(
31
+ id,
32
+ date
33
+ );
34
+ ```
35
+
36
+ ### Parameters
37
+
38
+ |Name | Type | Description | Notes|
39
+ |------------- | ------------- | ------------- | -------------|
40
+ | **id** | [**string**] | ID du club | defaults to undefined|
41
+ | **date** | [**string**] | Date (format YYYY-MM-DD) | defaults to undefined|
42
+
43
+
44
+ ### Return type
45
+
46
+ **DailyTurnoverResponse**
47
+
48
+ ### Authorization
49
+
50
+ [bearerAuth](../README.md#bearerAuth)
51
+
52
+ ### HTTP request headers
53
+
54
+ - **Content-Type**: Not defined
55
+ - **Accept**: application/json
56
+
57
+
58
+ ### HTTP response details
59
+ | Status code | Description | Response headers |
60
+ |-------------|-------------|------------------|
61
+ |**200** | Chiffre d\'affaires quotidien | - |
62
+ |**400** | Requête invalide | - |
63
+ |**401** | Non autorisé | - |
64
+ |**403** | Accès interdit | - |
65
+ |**500** | Erreur serveur interne | - |
66
+
67
+ [[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)
68
+
69
+ # **getInvoices**
70
+ > InvoicesResponse getInvoices()
71
+
72
+
73
+ ### Example
74
+
75
+ ```typescript
76
+ import {
77
+ ClubAnalyticsApi,
78
+ Configuration
79
+ } from '@tennac-booking/sdk';
80
+
81
+ const configuration = new Configuration();
82
+ const apiInstance = new ClubAnalyticsApi(configuration);
83
+
84
+ let id: string; //ID du club (default to undefined)
85
+ let page: number; //Numéro de page (optional) (default to 1)
86
+ let limit: number; //Nombre d\'éléments par page (optional) (default to 10)
87
+ let status: 'pending' | 'paid' | 'failed' | 'authorized' | 'canceled' | 'expired'; //Filtrer par statut (optional) (default to undefined)
88
+ let startDate: string; //Date de début (ISO format) (optional) (default to undefined)
89
+ let endDate: string; //Date de fin (ISO format) (optional) (default to undefined)
90
+
91
+ const { status, data } = await apiInstance.getInvoices(
92
+ id,
93
+ page,
94
+ limit,
95
+ status,
96
+ startDate,
97
+ endDate
98
+ );
99
+ ```
100
+
101
+ ### Parameters
102
+
103
+ |Name | Type | Description | Notes|
104
+ |------------- | ------------- | ------------- | -------------|
105
+ | **id** | [**string**] | ID du club | defaults to undefined|
106
+ | **page** | [**number**] | Numéro de page | (optional) defaults to 1|
107
+ | **limit** | [**number**] | Nombre d\'éléments par page | (optional) defaults to 10|
108
+ | **status** | [**&#39;pending&#39; | &#39;paid&#39; | &#39;failed&#39; | &#39;authorized&#39; | &#39;canceled&#39; | &#39;expired&#39;**]**Array<&#39;pending&#39; &#124; &#39;paid&#39; &#124; &#39;failed&#39; &#124; &#39;authorized&#39; &#124; &#39;canceled&#39; &#124; &#39;expired&#39;>** | Filtrer par statut | (optional) defaults to undefined|
109
+ | **startDate** | [**string**] | Date de début (ISO format) | (optional) defaults to undefined|
110
+ | **endDate** | [**string**] | Date de fin (ISO format) | (optional) defaults to undefined|
111
+
112
+
113
+ ### Return type
114
+
115
+ **InvoicesResponse**
116
+
117
+ ### Authorization
118
+
119
+ [bearerAuth](../README.md#bearerAuth)
120
+
121
+ ### HTTP request headers
122
+
123
+ - **Content-Type**: Not defined
124
+ - **Accept**: application/json
125
+
126
+
127
+ ### HTTP response details
128
+ | Status code | Description | Response headers |
129
+ |-------------|-------------|------------------|
130
+ |**200** | Liste des factures | - |
131
+ |**401** | Non autorisé | - |
132
+ |**403** | Accès interdit | - |
133
+ |**500** | Erreur serveur interne | - |
134
+
135
+ [[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)
136
+
137
+ # **getMonthlyTurnOver**
138
+ > MonthlyTurnoverResponse getMonthlyTurnOver()
139
+
140
+
141
+ ### Example
142
+
143
+ ```typescript
144
+ import {
145
+ ClubAnalyticsApi,
146
+ Configuration
147
+ } from '@tennac-booking/sdk';
148
+
149
+ const configuration = new Configuration();
150
+ const apiInstance = new ClubAnalyticsApi(configuration);
151
+
152
+ let id: string; //ID du club (default to undefined)
153
+ let year: number; //Année (default to undefined)
154
+ let month: number; //Mois (1-12) (default to undefined)
155
+
156
+ const { status, data } = await apiInstance.getMonthlyTurnOver(
157
+ id,
158
+ year,
159
+ month
160
+ );
161
+ ```
162
+
163
+ ### Parameters
164
+
165
+ |Name | Type | Description | Notes|
166
+ |------------- | ------------- | ------------- | -------------|
167
+ | **id** | [**string**] | ID du club | defaults to undefined|
168
+ | **year** | [**number**] | Année | defaults to undefined|
169
+ | **month** | [**number**] | Mois (1-12) | defaults to undefined|
170
+
171
+
172
+ ### Return type
173
+
174
+ **MonthlyTurnoverResponse**
175
+
176
+ ### Authorization
177
+
178
+ [bearerAuth](../README.md#bearerAuth)
179
+
180
+ ### HTTP request headers
181
+
182
+ - **Content-Type**: Not defined
183
+ - **Accept**: application/json
184
+
185
+
186
+ ### HTTP response details
187
+ | Status code | Description | Response headers |
188
+ |-------------|-------------|------------------|
189
+ |**200** | Chiffre d\&#39;affaires mensuel | - |
190
+ |**400** | Requête invalide | - |
191
+ |**401** | Non autorisé | - |
192
+ |**403** | Accès interdit | - |
193
+ |**500** | Erreur serveur interne | - |
194
+
195
+ [[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)
196
+
197
+ # **getYearlyTurnOver**
198
+ > YearlyTurnoverResponse getYearlyTurnOver()
199
+
200
+
201
+ ### Example
202
+
203
+ ```typescript
204
+ import {
205
+ ClubAnalyticsApi,
206
+ Configuration
207
+ } from '@tennac-booking/sdk';
208
+
209
+ const configuration = new Configuration();
210
+ const apiInstance = new ClubAnalyticsApi(configuration);
211
+
212
+ let id: string; //ID du club (default to undefined)
213
+ let year: number; //Année (default to undefined)
214
+
215
+ const { status, data } = await apiInstance.getYearlyTurnOver(
216
+ id,
217
+ year
218
+ );
219
+ ```
220
+
221
+ ### Parameters
222
+
223
+ |Name | Type | Description | Notes|
224
+ |------------- | ------------- | ------------- | -------------|
225
+ | **id** | [**string**] | ID du club | defaults to undefined|
226
+ | **year** | [**number**] | Année | defaults to undefined|
227
+
228
+
229
+ ### Return type
230
+
231
+ **YearlyTurnoverResponse**
232
+
233
+ ### Authorization
234
+
235
+ [bearerAuth](../README.md#bearerAuth)
236
+
237
+ ### HTTP request headers
238
+
239
+ - **Content-Type**: Not defined
240
+ - **Accept**: application/json
241
+
242
+
243
+ ### HTTP response details
244
+ | Status code | Description | Response headers |
245
+ |-------------|-------------|------------------|
246
+ |**200** | Chiffre d\&#39;affaires annuel | - |
247
+ |**400** | Requête invalide | - |
248
+ |**401** | Non autorisé | - |
249
+ |**403** | Accès interdit | - |
250
+ |**500** | Erreur serveur interne | - |
251
+
252
+ [[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)
253
+