@tennac-booking/sdk 1.0.97 → 1.0.99
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.
- package/.openapi-generator/FILES +264 -267
- package/README.md +46 -45
- package/api.ts +2348 -2430
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +1477 -1610
- package/dist/api.js +1192 -1061
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +1477 -1610
- package/dist/esm/api.js +1157 -1035
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/ActiveSubscriptionResponse.md +22 -0
- package/docs/AddClubMemberRequest.md +1 -7
- package/docs/{ClubDaySchedule.md → AddCreditsToCustomer200Response.md} +5 -7
- package/docs/AddCreditsToCustomerRequest.md +22 -0
- package/docs/BookingPopulated.md +3 -3
- package/docs/BookingPriceBody.md +4 -2
- package/docs/BookingPriceResponse.md +2 -0
- package/docs/BookingSummary.md +4 -0
- package/docs/ClientAccountOnboardingRequest.md +29 -0
- package/docs/ClientAccountOnboardingResponse.md +34 -0
- package/docs/ClientAccountResponse.md +44 -0
- package/docs/ClientAccountsApi.md +408 -0
- package/docs/ClientApi.md +109 -0
- package/docs/{ClubPlayerStatisticsResponseMostPlayedPartnersInner.md → ClientMeResponse.md} +11 -9
- package/docs/ClientOnboardingRequestBody.md +33 -0
- package/docs/ClientOnboardingResponse.md +27 -0
- package/docs/ClientRegisterRequestBody.md +26 -0
- package/docs/ClientRegisterResponse.md +22 -0
- package/docs/ClientSubscriptionResponse.md +34 -0
- package/docs/ClubAnalyticsStaffApi.md +0 -314
- package/docs/ClubSettingsManagerApi.md +60 -54
- package/docs/ClubSettingsResponse.md +39 -0
- package/docs/ClubsManagerApi.md +58 -52
- package/docs/ClubsStaffApi.md +0 -44
- package/docs/CourtResponse.md +1 -1
- package/docs/CreateBookingRequest.md +1 -1
- package/docs/CreateClubSettingsRequest.md +34 -0
- package/docs/CreateCourtRequest.md +1 -1
- package/docs/CreateEventRequest.md +1 -3
- package/docs/DeleteClubSettingsResponse.md +20 -0
- package/docs/EventResponse.md +1 -1
- package/docs/EventResponseCourtsInner.md +18 -0
- package/docs/GetSubscriptionsHistory200Response.md +22 -0
- package/docs/IUserAttributes.md +2 -0
- package/docs/ManagedClubsResponse.md +23 -0
- package/docs/PlayerPrice.md +2 -0
- package/docs/PlayerShare.md +22 -0
- package/docs/PlayerWithPaymentMethod.md +2 -0
- package/docs/SlotInfo.md +2 -2
- package/docs/SportsStaffApi.md +55 -0
- package/docs/StaffUserProfileResponse.md +2 -0
- package/docs/UpdateClubSettingsRequest.md +32 -0
- package/docs/UpdateEventRequest.md +1 -1
- package/docs/UserClubMembership.md +34 -0
- package/docs/UserClubMembershipsResponse.md +20 -0
- package/docs/UserInfo.md +0 -2
- package/docs/UserProfileResponse.md +2 -0
- package/docs/UsersApi.md +46 -0
- package/index.ts +1 -1
- package/package.json +1 -1
- package/docs/ClubGeneralSettingsResponse.md +0 -32
- package/docs/ClubHoursSettingsResponse.md +0 -22
- package/docs/ClubLocationSettings.md +0 -26
- package/docs/ClubPlayerBookingItem.md +0 -36
- package/docs/ClubPlayerBookingsPagination.md +0 -28
- package/docs/ClubPlayerBookingsResponse.md +0 -24
- package/docs/ClubPlayerDetailResponse.md +0 -46
- package/docs/ClubPlayerDetailResponseSportsLevelsInner.md +0 -22
- package/docs/ClubPlayerStatisticsResponse.md +0 -42
- package/docs/ClubPlayerStatisticsResponseBookingAmountEvolutionThisMonthInner.md +0 -22
- package/docs/ClubPlayerStatisticsResponseFavoriteClub.md +0 -23
- package/docs/ClubPlayerStatisticsResponseMostPlayedClub.md +0 -25
- package/docs/ClubPlayerSubscriptionSummary.md +0 -28
- package/docs/ClubPresentationSettingsResponse.md +0 -26
- package/docs/ClubPricingPeriodResponse.md +0 -30
- package/docs/ClubReservationSettingsResponse.md +0 -28
- package/docs/ClubSettingsStaffApi.md +0 -183
- package/docs/ClubWeeklySchedule.md +0 -32
- package/docs/CourtBookingShareItem.md +0 -26
- package/docs/PartialClubWeeklySchedule.md +0 -33
- package/docs/RetentionRateResponse.md +0 -24
- package/docs/RevenueBySportItem.md +0 -24
- package/docs/UpdateClubGeneralSettingsRequest.md +0 -34
- package/docs/UpdateClubHoursSettingsRequest.md +0 -22
- package/docs/UpdateClubPresentationSettingsRequest.md +0 -26
- package/docs/UpdateClubReservationSettingsRequest.md +0 -28
|
@@ -5,9 +5,6 @@ All URIs are relative to *http://localhost*
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**getAnalyticsBySport**](#getanalyticsbysport) | **GET** /api/club-analytics/sport/{sportId}/analytics | |
|
|
8
|
-
|[**getClubPlayerBookingsById**](#getclubplayerbookingsbyid) | **GET** /api/club-analytics/players/{playerId}/bookings | |
|
|
9
|
-
|[**getClubPlayerById**](#getclubplayerbyid) | **GET** /api/club-analytics/players/{playerId} | |
|
|
10
|
-
|[**getClubPlayerStatisticsById**](#getclubplayerstatisticsbyid) | **GET** /api/club-analytics/players/{playerId}/statistics | |
|
|
11
8
|
|[**getClubPlayers**](#getclubplayers) | **GET** /api/club-analytics/players | |
|
|
12
9
|
|[**getDailyTurnOver**](#getdailyturnover) | **GET** /api/club-analytics/daily-turnover | |
|
|
13
10
|
|[**getGenderPercentage**](#getgenderpercentage) | **GET** /api/club-analytics/gender-percentage | |
|
|
@@ -15,10 +12,7 @@ All URIs are relative to *http://localhost*
|
|
|
15
12
|
|[**getLastSixMonthsTurnover**](#getlastsixmonthsturnover) | **GET** /api/club-analytics/last-six-months-turnover | |
|
|
16
13
|
|[**getMonthlyTurnOver**](#getmonthlyturnover) | **GET** /api/club-analytics/monthly-turnover | |
|
|
17
14
|
|[**getNumberOfClubUsers**](#getnumberofclubusers) | **GET** /api/club-analytics/users-count | |
|
|
18
|
-
|[**getRetentionRate**](#getretentionrate) | **GET** /api/club-analytics/retention-rate | |
|
|
19
|
-
|[**getRevenueBySport**](#getrevenuebysport) | **GET** /api/club-analytics/revenue-by-sport | |
|
|
20
15
|
|[**getTenNextBookings**](#gettennextbookings) | **GET** /api/club-analytics/next-bookings | |
|
|
21
|
-
|[**getTopCourtsByBookings**](#gettopcourtsbybookings) | **GET** /api/club-analytics/top-courts | |
|
|
22
16
|
|[**getYearlyTurnOver**](#getyearlyturnover) | **GET** /api/club-analytics/yearly-turnover | |
|
|
23
17
|
|
|
24
18
|
# **getAnalyticsBySport**
|
|
@@ -75,176 +69,6 @@ const { status, data } = await apiInstance.getAnalyticsBySport(
|
|
|
75
69
|
|
|
76
70
|
[[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)
|
|
77
71
|
|
|
78
|
-
# **getClubPlayerBookingsById**
|
|
79
|
-
> ClubPlayerBookingsResponse getClubPlayerBookingsById()
|
|
80
|
-
|
|
81
|
-
Récupère les réservations d\'un joueur par son ID (à venir et passées)
|
|
82
|
-
|
|
83
|
-
### Example
|
|
84
|
-
|
|
85
|
-
```typescript
|
|
86
|
-
import {
|
|
87
|
-
ClubAnalyticsStaffApi,
|
|
88
|
-
Configuration
|
|
89
|
-
} from '@tennac-booking/sdk';
|
|
90
|
-
|
|
91
|
-
const configuration = new Configuration();
|
|
92
|
-
const apiInstance = new ClubAnalyticsStaffApi(configuration);
|
|
93
|
-
|
|
94
|
-
let playerId: string; // (default to undefined)
|
|
95
|
-
let page: number; // (optional) (default to undefined)
|
|
96
|
-
let pageSize: number; // (optional) (default to undefined)
|
|
97
|
-
|
|
98
|
-
const { status, data } = await apiInstance.getClubPlayerBookingsById(
|
|
99
|
-
playerId,
|
|
100
|
-
page,
|
|
101
|
-
pageSize
|
|
102
|
-
);
|
|
103
|
-
```
|
|
104
|
-
|
|
105
|
-
### Parameters
|
|
106
|
-
|
|
107
|
-
|Name | Type | Description | Notes|
|
|
108
|
-
|------------- | ------------- | ------------- | -------------|
|
|
109
|
-
| **playerId** | [**string**] | | defaults to undefined|
|
|
110
|
-
| **page** | [**number**] | | (optional) defaults to undefined|
|
|
111
|
-
| **pageSize** | [**number**] | | (optional) defaults to undefined|
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
### Return type
|
|
115
|
-
|
|
116
|
-
**ClubPlayerBookingsResponse**
|
|
117
|
-
|
|
118
|
-
### Authorization
|
|
119
|
-
|
|
120
|
-
[bearerAuth](../README.md#bearerAuth)
|
|
121
|
-
|
|
122
|
-
### HTTP request headers
|
|
123
|
-
|
|
124
|
-
- **Content-Type**: Not defined
|
|
125
|
-
- **Accept**: application/json
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
### HTTP response details
|
|
129
|
-
| Status code | Description | Response headers |
|
|
130
|
-
|-------------|-------------|------------------|
|
|
131
|
-
|**200** | Réservations du joueur | - |
|
|
132
|
-
|**400** | Bad Request | - |
|
|
133
|
-
|**401** | Unauthorized | - |
|
|
134
|
-
|**500** | Server Error | - |
|
|
135
|
-
|
|
136
|
-
[[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)
|
|
137
|
-
|
|
138
|
-
# **getClubPlayerById**
|
|
139
|
-
> ClubPlayerDetailResponse getClubPlayerById()
|
|
140
|
-
|
|
141
|
-
Récupère les informations détaillées d\'un joueur par son ID
|
|
142
|
-
|
|
143
|
-
### Example
|
|
144
|
-
|
|
145
|
-
```typescript
|
|
146
|
-
import {
|
|
147
|
-
ClubAnalyticsStaffApi,
|
|
148
|
-
Configuration
|
|
149
|
-
} from '@tennac-booking/sdk';
|
|
150
|
-
|
|
151
|
-
const configuration = new Configuration();
|
|
152
|
-
const apiInstance = new ClubAnalyticsStaffApi(configuration);
|
|
153
|
-
|
|
154
|
-
let playerId: string; // (default to undefined)
|
|
155
|
-
|
|
156
|
-
const { status, data } = await apiInstance.getClubPlayerById(
|
|
157
|
-
playerId
|
|
158
|
-
);
|
|
159
|
-
```
|
|
160
|
-
|
|
161
|
-
### Parameters
|
|
162
|
-
|
|
163
|
-
|Name | Type | Description | Notes|
|
|
164
|
-
|------------- | ------------- | ------------- | -------------|
|
|
165
|
-
| **playerId** | [**string**] | | defaults to undefined|
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
### Return type
|
|
169
|
-
|
|
170
|
-
**ClubPlayerDetailResponse**
|
|
171
|
-
|
|
172
|
-
### Authorization
|
|
173
|
-
|
|
174
|
-
[bearerAuth](../README.md#bearerAuth)
|
|
175
|
-
|
|
176
|
-
### HTTP request headers
|
|
177
|
-
|
|
178
|
-
- **Content-Type**: Not defined
|
|
179
|
-
- **Accept**: application/json
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
### HTTP response details
|
|
183
|
-
| Status code | Description | Response headers |
|
|
184
|
-
|-------------|-------------|------------------|
|
|
185
|
-
|**200** | Informations du joueur | - |
|
|
186
|
-
|**400** | Bad Request | - |
|
|
187
|
-
|**401** | Unauthorized | - |
|
|
188
|
-
|**404** | Not Found | - |
|
|
189
|
-
|**500** | Server Error | - |
|
|
190
|
-
|
|
191
|
-
[[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)
|
|
192
|
-
|
|
193
|
-
# **getClubPlayerStatisticsById**
|
|
194
|
-
> ClubPlayerStatisticsResponse getClubPlayerStatisticsById()
|
|
195
|
-
|
|
196
|
-
Récupère les statistiques d\'un joueur pour le staff
|
|
197
|
-
|
|
198
|
-
### Example
|
|
199
|
-
|
|
200
|
-
```typescript
|
|
201
|
-
import {
|
|
202
|
-
ClubAnalyticsStaffApi,
|
|
203
|
-
Configuration
|
|
204
|
-
} from '@tennac-booking/sdk';
|
|
205
|
-
|
|
206
|
-
const configuration = new Configuration();
|
|
207
|
-
const apiInstance = new ClubAnalyticsStaffApi(configuration);
|
|
208
|
-
|
|
209
|
-
let playerId: string; // (default to undefined)
|
|
210
|
-
|
|
211
|
-
const { status, data } = await apiInstance.getClubPlayerStatisticsById(
|
|
212
|
-
playerId
|
|
213
|
-
);
|
|
214
|
-
```
|
|
215
|
-
|
|
216
|
-
### Parameters
|
|
217
|
-
|
|
218
|
-
|Name | Type | Description | Notes|
|
|
219
|
-
|------------- | ------------- | ------------- | -------------|
|
|
220
|
-
| **playerId** | [**string**] | | defaults to undefined|
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
### Return type
|
|
224
|
-
|
|
225
|
-
**ClubPlayerStatisticsResponse**
|
|
226
|
-
|
|
227
|
-
### Authorization
|
|
228
|
-
|
|
229
|
-
[bearerAuth](../README.md#bearerAuth)
|
|
230
|
-
|
|
231
|
-
### HTTP request headers
|
|
232
|
-
|
|
233
|
-
- **Content-Type**: Not defined
|
|
234
|
-
- **Accept**: application/json
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
### HTTP response details
|
|
238
|
-
| Status code | Description | Response headers |
|
|
239
|
-
|-------------|-------------|------------------|
|
|
240
|
-
|**200** | Statistiques du joueur | - |
|
|
241
|
-
|**400** | Bad Request | - |
|
|
242
|
-
|**401** | Unauthorized | - |
|
|
243
|
-
|**404** | Not Found | - |
|
|
244
|
-
|**500** | Server Error | - |
|
|
245
|
-
|
|
246
|
-
[[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)
|
|
247
|
-
|
|
248
72
|
# **getClubPlayers**
|
|
249
73
|
> Array<ClubPlayerResponse> getClubPlayers()
|
|
250
74
|
|
|
@@ -597,98 +421,6 @@ This endpoint does not have any parameters.
|
|
|
597
421
|
|
|
598
422
|
[[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)
|
|
599
423
|
|
|
600
|
-
# **getRetentionRate**
|
|
601
|
-
> RetentionRateResponse getRetentionRate()
|
|
602
|
-
|
|
603
|
-
Calcule le taux de fidélisation des joueurs
|
|
604
|
-
|
|
605
|
-
### Example
|
|
606
|
-
|
|
607
|
-
```typescript
|
|
608
|
-
import {
|
|
609
|
-
ClubAnalyticsStaffApi,
|
|
610
|
-
Configuration
|
|
611
|
-
} from '@tennac-booking/sdk';
|
|
612
|
-
|
|
613
|
-
const configuration = new Configuration();
|
|
614
|
-
const apiInstance = new ClubAnalyticsStaffApi(configuration);
|
|
615
|
-
|
|
616
|
-
const { status, data } = await apiInstance.getRetentionRate();
|
|
617
|
-
```
|
|
618
|
-
|
|
619
|
-
### Parameters
|
|
620
|
-
This endpoint does not have any parameters.
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
### Return type
|
|
624
|
-
|
|
625
|
-
**RetentionRateResponse**
|
|
626
|
-
|
|
627
|
-
### Authorization
|
|
628
|
-
|
|
629
|
-
[bearerAuth](../README.md#bearerAuth)
|
|
630
|
-
|
|
631
|
-
### HTTP request headers
|
|
632
|
-
|
|
633
|
-
- **Content-Type**: Not defined
|
|
634
|
-
- **Accept**: application/json
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
### HTTP response details
|
|
638
|
-
| Status code | Description | Response headers |
|
|
639
|
-
|-------------|-------------|------------------|
|
|
640
|
-
|**200** | Taux de fidélisation | - |
|
|
641
|
-
|**401** | Unauthorized | - |
|
|
642
|
-
|**500** | Server Error | - |
|
|
643
|
-
|
|
644
|
-
[[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)
|
|
645
|
-
|
|
646
|
-
# **getRevenueBySport**
|
|
647
|
-
> Array<RevenueBySportItem> getRevenueBySport()
|
|
648
|
-
|
|
649
|
-
Récupère le chiffre d\'affaires par sport
|
|
650
|
-
|
|
651
|
-
### Example
|
|
652
|
-
|
|
653
|
-
```typescript
|
|
654
|
-
import {
|
|
655
|
-
ClubAnalyticsStaffApi,
|
|
656
|
-
Configuration
|
|
657
|
-
} from '@tennac-booking/sdk';
|
|
658
|
-
|
|
659
|
-
const configuration = new Configuration();
|
|
660
|
-
const apiInstance = new ClubAnalyticsStaffApi(configuration);
|
|
661
|
-
|
|
662
|
-
const { status, data } = await apiInstance.getRevenueBySport();
|
|
663
|
-
```
|
|
664
|
-
|
|
665
|
-
### Parameters
|
|
666
|
-
This endpoint does not have any parameters.
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
### Return type
|
|
670
|
-
|
|
671
|
-
**Array<RevenueBySportItem>**
|
|
672
|
-
|
|
673
|
-
### Authorization
|
|
674
|
-
|
|
675
|
-
[bearerAuth](../README.md#bearerAuth)
|
|
676
|
-
|
|
677
|
-
### HTTP request headers
|
|
678
|
-
|
|
679
|
-
- **Content-Type**: Not defined
|
|
680
|
-
- **Accept**: application/json
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
### HTTP response details
|
|
684
|
-
| Status code | Description | Response headers |
|
|
685
|
-
|-------------|-------------|------------------|
|
|
686
|
-
|**200** | Répartition du CA par sport | - |
|
|
687
|
-
|**401** | Unauthorized | - |
|
|
688
|
-
|**500** | Server Error | - |
|
|
689
|
-
|
|
690
|
-
[[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)
|
|
691
|
-
|
|
692
424
|
# **getTenNextBookings**
|
|
693
425
|
> Array<BookingAnalyticsResponse> getTenNextBookings()
|
|
694
426
|
|
|
@@ -735,52 +467,6 @@ This endpoint does not have any parameters.
|
|
|
735
467
|
|
|
736
468
|
[[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)
|
|
737
469
|
|
|
738
|
-
# **getTopCourtsByBookings**
|
|
739
|
-
> Array<CourtBookingShareItem> getTopCourtsByBookings()
|
|
740
|
-
|
|
741
|
-
Classement des terrains les plus réservés
|
|
742
|
-
|
|
743
|
-
### Example
|
|
744
|
-
|
|
745
|
-
```typescript
|
|
746
|
-
import {
|
|
747
|
-
ClubAnalyticsStaffApi,
|
|
748
|
-
Configuration
|
|
749
|
-
} from '@tennac-booking/sdk';
|
|
750
|
-
|
|
751
|
-
const configuration = new Configuration();
|
|
752
|
-
const apiInstance = new ClubAnalyticsStaffApi(configuration);
|
|
753
|
-
|
|
754
|
-
const { status, data } = await apiInstance.getTopCourtsByBookings();
|
|
755
|
-
```
|
|
756
|
-
|
|
757
|
-
### Parameters
|
|
758
|
-
This endpoint does not have any parameters.
|
|
759
|
-
|
|
760
|
-
|
|
761
|
-
### Return type
|
|
762
|
-
|
|
763
|
-
**Array<CourtBookingShareItem>**
|
|
764
|
-
|
|
765
|
-
### Authorization
|
|
766
|
-
|
|
767
|
-
[bearerAuth](../README.md#bearerAuth)
|
|
768
|
-
|
|
769
|
-
### HTTP request headers
|
|
770
|
-
|
|
771
|
-
- **Content-Type**: Not defined
|
|
772
|
-
- **Accept**: application/json
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
### HTTP response details
|
|
776
|
-
| Status code | Description | Response headers |
|
|
777
|
-
|-------------|-------------|------------------|
|
|
778
|
-
|**200** | Terrains les plus réservés | - |
|
|
779
|
-
|**401** | Unauthorized | - |
|
|
780
|
-
|**500** | Server Error | - |
|
|
781
|
-
|
|
782
|
-
[[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)
|
|
783
|
-
|
|
784
470
|
# **getYearlyTurnOver**
|
|
785
471
|
> YearlyTurnoverResponse getYearlyTurnOver()
|
|
786
472
|
|
|
@@ -4,14 +4,15 @@ All URIs are relative to *http://localhost*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**
|
|
8
|
-
|[**
|
|
9
|
-
|[**
|
|
10
|
-
|[**
|
|
7
|
+
|[**createClubSettings**](#createclubsettings) | **POST** /api/club-settings/{clubId} | |
|
|
8
|
+
|[**deleteClubSettings**](#deleteclubsettings) | **DELETE** /api/club-settings | |
|
|
9
|
+
|[**getClubSettings**](#getclubsettings) | **GET** /api/club-settings | |
|
|
10
|
+
|[**updateClubSettings**](#updateclubsettings) | **PUT** /api/club-settings | |
|
|
11
11
|
|
|
12
|
-
# **
|
|
13
|
-
>
|
|
12
|
+
# **createClubSettings**
|
|
13
|
+
> ClubSettingsResponse createClubSettings(createClubSettingsRequest)
|
|
14
14
|
|
|
15
|
+
Crée les paramètres d\'un club
|
|
15
16
|
|
|
16
17
|
### Example
|
|
17
18
|
|
|
@@ -19,16 +20,18 @@ All URIs are relative to *http://localhost*
|
|
|
19
20
|
import {
|
|
20
21
|
ClubSettingsManagerApi,
|
|
21
22
|
Configuration,
|
|
22
|
-
|
|
23
|
+
CreateClubSettingsRequest
|
|
23
24
|
} from '@tennac-booking/sdk';
|
|
24
25
|
|
|
25
26
|
const configuration = new Configuration();
|
|
26
27
|
const apiInstance = new ClubSettingsManagerApi(configuration);
|
|
27
28
|
|
|
28
|
-
let
|
|
29
|
+
let clubId: string; // (default to undefined)
|
|
30
|
+
let createClubSettingsRequest: CreateClubSettingsRequest; //
|
|
29
31
|
|
|
30
|
-
const { status, data } = await apiInstance.
|
|
31
|
-
|
|
32
|
+
const { status, data } = await apiInstance.createClubSettings(
|
|
33
|
+
clubId,
|
|
34
|
+
createClubSettingsRequest
|
|
32
35
|
);
|
|
33
36
|
```
|
|
34
37
|
|
|
@@ -36,12 +39,13 @@ const { status, data } = await apiInstance.updateClubGeneralSettings(
|
|
|
36
39
|
|
|
37
40
|
|Name | Type | Description | Notes|
|
|
38
41
|
|------------- | ------------- | ------------- | -------------|
|
|
39
|
-
| **
|
|
42
|
+
| **createClubSettingsRequest** | **CreateClubSettingsRequest**| | |
|
|
43
|
+
| **clubId** | [**string**] | | defaults to undefined|
|
|
40
44
|
|
|
41
45
|
|
|
42
46
|
### Return type
|
|
43
47
|
|
|
44
|
-
**
|
|
48
|
+
**ClubSettingsResponse**
|
|
45
49
|
|
|
46
50
|
### Authorization
|
|
47
51
|
|
|
@@ -56,43 +60,39 @@ const { status, data } = await apiInstance.updateClubGeneralSettings(
|
|
|
56
60
|
### HTTP response details
|
|
57
61
|
| Status code | Description | Response headers |
|
|
58
62
|
|-------------|-------------|------------------|
|
|
59
|
-
|**
|
|
63
|
+
|**201** | Paramètres créés | - |
|
|
64
|
+
|**400** | Bad Request | - |
|
|
65
|
+
|**401** | Unauthorized | - |
|
|
66
|
+
|**500** | Server Error | - |
|
|
60
67
|
|
|
61
68
|
[[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)
|
|
62
69
|
|
|
63
|
-
# **
|
|
64
|
-
>
|
|
70
|
+
# **deleteClubSettings**
|
|
71
|
+
> DeleteClubSettingsResponse deleteClubSettings()
|
|
65
72
|
|
|
73
|
+
Supprime les paramètres d\'un club
|
|
66
74
|
|
|
67
75
|
### Example
|
|
68
76
|
|
|
69
77
|
```typescript
|
|
70
78
|
import {
|
|
71
79
|
ClubSettingsManagerApi,
|
|
72
|
-
Configuration
|
|
73
|
-
UpdateClubHoursSettingsRequest
|
|
80
|
+
Configuration
|
|
74
81
|
} from '@tennac-booking/sdk';
|
|
75
82
|
|
|
76
83
|
const configuration = new Configuration();
|
|
77
84
|
const apiInstance = new ClubSettingsManagerApi(configuration);
|
|
78
85
|
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
const { status, data } = await apiInstance.updateHoursSettings(
|
|
82
|
-
updateClubHoursSettingsRequest
|
|
83
|
-
);
|
|
86
|
+
const { status, data } = await apiInstance.deleteClubSettings();
|
|
84
87
|
```
|
|
85
88
|
|
|
86
89
|
### Parameters
|
|
87
|
-
|
|
88
|
-
|Name | Type | Description | Notes|
|
|
89
|
-
|------------- | ------------- | ------------- | -------------|
|
|
90
|
-
| **updateClubHoursSettingsRequest** | **UpdateClubHoursSettingsRequest**| | |
|
|
90
|
+
This endpoint does not have any parameters.
|
|
91
91
|
|
|
92
92
|
|
|
93
93
|
### Return type
|
|
94
94
|
|
|
95
|
-
**
|
|
95
|
+
**DeleteClubSettingsResponse**
|
|
96
96
|
|
|
97
97
|
### Authorization
|
|
98
98
|
|
|
@@ -100,50 +100,47 @@ const { status, data } = await apiInstance.updateHoursSettings(
|
|
|
100
100
|
|
|
101
101
|
### HTTP request headers
|
|
102
102
|
|
|
103
|
-
- **Content-Type**:
|
|
103
|
+
- **Content-Type**: Not defined
|
|
104
104
|
- **Accept**: application/json
|
|
105
105
|
|
|
106
106
|
|
|
107
107
|
### HTTP response details
|
|
108
108
|
| Status code | Description | Response headers |
|
|
109
109
|
|-------------|-------------|------------------|
|
|
110
|
-
|**200** |
|
|
110
|
+
|**200** | Paramètres supprimés | - |
|
|
111
|
+
|**400** | Bad Request | - |
|
|
112
|
+
|**401** | Unauthorized | - |
|
|
113
|
+
|**404** | Paramètres non trouvés | - |
|
|
114
|
+
|**500** | Server Error | - |
|
|
111
115
|
|
|
112
116
|
[[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)
|
|
113
117
|
|
|
114
|
-
# **
|
|
115
|
-
>
|
|
118
|
+
# **getClubSettings**
|
|
119
|
+
> ClubSettingsResponse getClubSettings()
|
|
116
120
|
|
|
121
|
+
Récupère les paramètres d\'un club
|
|
117
122
|
|
|
118
123
|
### Example
|
|
119
124
|
|
|
120
125
|
```typescript
|
|
121
126
|
import {
|
|
122
127
|
ClubSettingsManagerApi,
|
|
123
|
-
Configuration
|
|
124
|
-
ClubPresentationSettingsResponse
|
|
128
|
+
Configuration
|
|
125
129
|
} from '@tennac-booking/sdk';
|
|
126
130
|
|
|
127
131
|
const configuration = new Configuration();
|
|
128
132
|
const apiInstance = new ClubSettingsManagerApi(configuration);
|
|
129
133
|
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
const { status, data } = await apiInstance.updatePresentationSettings(
|
|
133
|
-
clubPresentationSettingsResponse
|
|
134
|
-
);
|
|
134
|
+
const { status, data } = await apiInstance.getClubSettings();
|
|
135
135
|
```
|
|
136
136
|
|
|
137
137
|
### Parameters
|
|
138
|
-
|
|
139
|
-
|Name | Type | Description | Notes|
|
|
140
|
-
|------------- | ------------- | ------------- | -------------|
|
|
141
|
-
| **clubPresentationSettingsResponse** | **ClubPresentationSettingsResponse**| | |
|
|
138
|
+
This endpoint does not have any parameters.
|
|
142
139
|
|
|
143
140
|
|
|
144
141
|
### Return type
|
|
145
142
|
|
|
146
|
-
**
|
|
143
|
+
**ClubSettingsResponse**
|
|
147
144
|
|
|
148
145
|
### Authorization
|
|
149
146
|
|
|
@@ -151,20 +148,25 @@ const { status, data } = await apiInstance.updatePresentationSettings(
|
|
|
151
148
|
|
|
152
149
|
### HTTP request headers
|
|
153
150
|
|
|
154
|
-
- **Content-Type**:
|
|
151
|
+
- **Content-Type**: Not defined
|
|
155
152
|
- **Accept**: application/json
|
|
156
153
|
|
|
157
154
|
|
|
158
155
|
### HTTP response details
|
|
159
156
|
| Status code | Description | Response headers |
|
|
160
157
|
|-------------|-------------|------------------|
|
|
161
|
-
|**200** | Paramètres
|
|
158
|
+
|**200** | Paramètres du club | - |
|
|
159
|
+
|**400** | Bad Request | - |
|
|
160
|
+
|**401** | Unauthorized | - |
|
|
161
|
+
|**404** | Paramètres non trouvés | - |
|
|
162
|
+
|**500** | Server Error | - |
|
|
162
163
|
|
|
163
164
|
[[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)
|
|
164
165
|
|
|
165
|
-
# **
|
|
166
|
-
>
|
|
166
|
+
# **updateClubSettings**
|
|
167
|
+
> ClubSettingsResponse updateClubSettings(updateClubSettingsRequest)
|
|
167
168
|
|
|
169
|
+
Met à jour les paramètres d\'un club
|
|
168
170
|
|
|
169
171
|
### Example
|
|
170
172
|
|
|
@@ -172,16 +174,16 @@ const { status, data } = await apiInstance.updatePresentationSettings(
|
|
|
172
174
|
import {
|
|
173
175
|
ClubSettingsManagerApi,
|
|
174
176
|
Configuration,
|
|
175
|
-
|
|
177
|
+
UpdateClubSettingsRequest
|
|
176
178
|
} from '@tennac-booking/sdk';
|
|
177
179
|
|
|
178
180
|
const configuration = new Configuration();
|
|
179
181
|
const apiInstance = new ClubSettingsManagerApi(configuration);
|
|
180
182
|
|
|
181
|
-
let
|
|
183
|
+
let updateClubSettingsRequest: UpdateClubSettingsRequest; //
|
|
182
184
|
|
|
183
|
-
const { status, data } = await apiInstance.
|
|
184
|
-
|
|
185
|
+
const { status, data } = await apiInstance.updateClubSettings(
|
|
186
|
+
updateClubSettingsRequest
|
|
185
187
|
);
|
|
186
188
|
```
|
|
187
189
|
|
|
@@ -189,12 +191,12 @@ const { status, data } = await apiInstance.updateReservationSettings(
|
|
|
189
191
|
|
|
190
192
|
|Name | Type | Description | Notes|
|
|
191
193
|
|------------- | ------------- | ------------- | -------------|
|
|
192
|
-
| **
|
|
194
|
+
| **updateClubSettingsRequest** | **UpdateClubSettingsRequest**| | |
|
|
193
195
|
|
|
194
196
|
|
|
195
197
|
### Return type
|
|
196
198
|
|
|
197
|
-
**
|
|
199
|
+
**ClubSettingsResponse**
|
|
198
200
|
|
|
199
201
|
### Authorization
|
|
200
202
|
|
|
@@ -209,7 +211,11 @@ const { status, data } = await apiInstance.updateReservationSettings(
|
|
|
209
211
|
### HTTP response details
|
|
210
212
|
| Status code | Description | Response headers |
|
|
211
213
|
|-------------|-------------|------------------|
|
|
212
|
-
|**200** | Paramètres
|
|
214
|
+
|**200** | Paramètres mis à jour | - |
|
|
215
|
+
|**400** | Bad Request | - |
|
|
216
|
+
|**401** | Unauthorized | - |
|
|
217
|
+
|**404** | Paramètres non trouvés | - |
|
|
218
|
+
|**500** | Server Error | - |
|
|
213
219
|
|
|
214
220
|
[[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)
|
|
215
221
|
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# ClubSettingsResponse
|
|
2
|
+
|
|
3
|
+
Types TSOA pour les paramètres du club
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**_id** | **string** | ID unique des paramètres | [default to undefined]
|
|
10
|
+
**clubId** | **string** | ID du club | [default to undefined]
|
|
11
|
+
**maxWeeklyBookings** | **number** | Nombre maximum de réservations par semaine | [default to undefined]
|
|
12
|
+
**sameTimeBookingsLimit** | **number** | Limite de réservations simultanées | [optional] [default to undefined]
|
|
13
|
+
**cancellationLimitHours** | **number** | Limite d\'annulation en heures | [default to undefined]
|
|
14
|
+
**availabilityPeriodInDays** | **number** | Période de disponibilité en jours | [default to undefined]
|
|
15
|
+
**sponsors** | **Array<string>** | Liste des sponsors | [default to undefined]
|
|
16
|
+
**timeBeforePayment** | **number** | Temps avant paiement en minutes | [default to undefined]
|
|
17
|
+
**createdAt** | **string** | Date de création | [default to undefined]
|
|
18
|
+
**updatedAt** | **string** | Date de mise à jour | [default to undefined]
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
import { ClubSettingsResponse } from '@tennac-booking/sdk';
|
|
24
|
+
|
|
25
|
+
const instance: ClubSettingsResponse = {
|
|
26
|
+
_id,
|
|
27
|
+
clubId,
|
|
28
|
+
maxWeeklyBookings,
|
|
29
|
+
sameTimeBookingsLimit,
|
|
30
|
+
cancellationLimitHours,
|
|
31
|
+
availabilityPeriodInDays,
|
|
32
|
+
sponsors,
|
|
33
|
+
timeBeforePayment,
|
|
34
|
+
createdAt,
|
|
35
|
+
updatedAt,
|
|
36
|
+
};
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|