@tennac-booking/sdk 1.0.97 → 1.0.98
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 +2342 -2430
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +1475 -1614
- 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 +1475 -1614
- 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/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
|
@@ -0,0 +1,408 @@
|
|
|
1
|
+
# ClientAccountsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**clientAuthMe**](#clientauthme) | **GET** /client-accounts/client-auth/me | |
|
|
8
|
+
|[**getClientAccountById**](#getclientaccountbyid) | **GET** /client-accounts/{accountId} | |
|
|
9
|
+
|[**getMyActiveSubscription**](#getmyactivesubscription) | **GET** /client-accounts/me/subscription | |
|
|
10
|
+
|[**getMyClientAccount**](#getmyclientaccount) | **GET** /client-accounts/me | |
|
|
11
|
+
|[**getSubscriptionsHistory**](#getsubscriptionshistory) | **GET** /client-accounts/me/subscriptions-history | |
|
|
12
|
+
|[**listAvailablePrices**](#listavailableprices) | **GET** /client-accounts/available-prices | |
|
|
13
|
+
|[**onboardClientAccount**](#onboardclientaccount) | **POST** /client-accounts/onboarding | |
|
|
14
|
+
|[**registerClientUser**](#registerclientuser) | **POST** /client-accounts/register-client-user | |
|
|
15
|
+
|
|
16
|
+
# **clientAuthMe**
|
|
17
|
+
> ClientMeResponse clientAuthMe()
|
|
18
|
+
|
|
19
|
+
Informations de l\'utilisateur client authentifié (token clientAuth)
|
|
20
|
+
|
|
21
|
+
### Example
|
|
22
|
+
|
|
23
|
+
```typescript
|
|
24
|
+
import {
|
|
25
|
+
ClientAccountsApi,
|
|
26
|
+
Configuration
|
|
27
|
+
} from '@tennac-booking/sdk';
|
|
28
|
+
|
|
29
|
+
const configuration = new Configuration();
|
|
30
|
+
const apiInstance = new ClientAccountsApi(configuration);
|
|
31
|
+
|
|
32
|
+
const { status, data } = await apiInstance.clientAuthMe();
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### Parameters
|
|
36
|
+
This endpoint does not have any parameters.
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
### Return type
|
|
40
|
+
|
|
41
|
+
**ClientMeResponse**
|
|
42
|
+
|
|
43
|
+
### Authorization
|
|
44
|
+
|
|
45
|
+
[clientAuth](../README.md#clientAuth)
|
|
46
|
+
|
|
47
|
+
### HTTP request headers
|
|
48
|
+
|
|
49
|
+
- **Content-Type**: Not defined
|
|
50
|
+
- **Accept**: application/json
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
### HTTP response details
|
|
54
|
+
| Status code | Description | Response headers |
|
|
55
|
+
|-------------|-------------|------------------|
|
|
56
|
+
|**200** | OK | - |
|
|
57
|
+
|
|
58
|
+
[[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)
|
|
59
|
+
|
|
60
|
+
# **getClientAccountById**
|
|
61
|
+
> ClientAccountResponse getClientAccountById()
|
|
62
|
+
|
|
63
|
+
Récupère le compte client par son ID
|
|
64
|
+
|
|
65
|
+
### Example
|
|
66
|
+
|
|
67
|
+
```typescript
|
|
68
|
+
import {
|
|
69
|
+
ClientAccountsApi,
|
|
70
|
+
Configuration
|
|
71
|
+
} from '@tennac-booking/sdk';
|
|
72
|
+
|
|
73
|
+
const configuration = new Configuration();
|
|
74
|
+
const apiInstance = new ClientAccountsApi(configuration);
|
|
75
|
+
|
|
76
|
+
let accountId: string; //L\'ID du compte client (default to undefined)
|
|
77
|
+
|
|
78
|
+
const { status, data } = await apiInstance.getClientAccountById(
|
|
79
|
+
accountId
|
|
80
|
+
);
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
### Parameters
|
|
84
|
+
|
|
85
|
+
|Name | Type | Description | Notes|
|
|
86
|
+
|------------- | ------------- | ------------- | -------------|
|
|
87
|
+
| **accountId** | [**string**] | L\'ID du compte client | defaults to undefined|
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
### Return type
|
|
91
|
+
|
|
92
|
+
**ClientAccountResponse**
|
|
93
|
+
|
|
94
|
+
### Authorization
|
|
95
|
+
|
|
96
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
97
|
+
|
|
98
|
+
### HTTP request headers
|
|
99
|
+
|
|
100
|
+
- **Content-Type**: Not defined
|
|
101
|
+
- **Accept**: application/json
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
### HTTP response details
|
|
105
|
+
| Status code | Description | Response headers |
|
|
106
|
+
|-------------|-------------|------------------|
|
|
107
|
+
|**200** | Compte client récupéré avec succès | - |
|
|
108
|
+
|**401** | Non authentifié | - |
|
|
109
|
+
|**404** | Compte client non trouvé | - |
|
|
110
|
+
|**500** | Erreur serveur | - |
|
|
111
|
+
|
|
112
|
+
[[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
|
+
|
|
114
|
+
# **getMyActiveSubscription**
|
|
115
|
+
> ActiveSubscriptionResponse getMyActiveSubscription()
|
|
116
|
+
|
|
117
|
+
Récupère l\'abonnement actif du compte client authentifié
|
|
118
|
+
|
|
119
|
+
### Example
|
|
120
|
+
|
|
121
|
+
```typescript
|
|
122
|
+
import {
|
|
123
|
+
ClientAccountsApi,
|
|
124
|
+
Configuration
|
|
125
|
+
} from '@tennac-booking/sdk';
|
|
126
|
+
|
|
127
|
+
const configuration = new Configuration();
|
|
128
|
+
const apiInstance = new ClientAccountsApi(configuration);
|
|
129
|
+
|
|
130
|
+
const { status, data } = await apiInstance.getMyActiveSubscription();
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
### Parameters
|
|
134
|
+
This endpoint does not have any parameters.
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
### Return type
|
|
138
|
+
|
|
139
|
+
**ActiveSubscriptionResponse**
|
|
140
|
+
|
|
141
|
+
### Authorization
|
|
142
|
+
|
|
143
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
144
|
+
|
|
145
|
+
### HTTP request headers
|
|
146
|
+
|
|
147
|
+
- **Content-Type**: Not defined
|
|
148
|
+
- **Accept**: application/json
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
### HTTP response details
|
|
152
|
+
| Status code | Description | Response headers |
|
|
153
|
+
|-------------|-------------|------------------|
|
|
154
|
+
|**200** | Abonnement récupéré avec succès | - |
|
|
155
|
+
|**401** | Non authentifié | - |
|
|
156
|
+
|**404** | Compte client ou abonnement non trouvé | - |
|
|
157
|
+
|**500** | Erreur serveur | - |
|
|
158
|
+
|
|
159
|
+
[[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)
|
|
160
|
+
|
|
161
|
+
# **getMyClientAccount**
|
|
162
|
+
> ClientAccountResponse getMyClientAccount()
|
|
163
|
+
|
|
164
|
+
Récupère le compte client de l\'utilisateur authentifié
|
|
165
|
+
|
|
166
|
+
### Example
|
|
167
|
+
|
|
168
|
+
```typescript
|
|
169
|
+
import {
|
|
170
|
+
ClientAccountsApi,
|
|
171
|
+
Configuration
|
|
172
|
+
} from '@tennac-booking/sdk';
|
|
173
|
+
|
|
174
|
+
const configuration = new Configuration();
|
|
175
|
+
const apiInstance = new ClientAccountsApi(configuration);
|
|
176
|
+
|
|
177
|
+
const { status, data } = await apiInstance.getMyClientAccount();
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
### Parameters
|
|
181
|
+
This endpoint does not have any parameters.
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
### Return type
|
|
185
|
+
|
|
186
|
+
**ClientAccountResponse**
|
|
187
|
+
|
|
188
|
+
### Authorization
|
|
189
|
+
|
|
190
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
191
|
+
|
|
192
|
+
### HTTP request headers
|
|
193
|
+
|
|
194
|
+
- **Content-Type**: Not defined
|
|
195
|
+
- **Accept**: application/json
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
### HTTP response details
|
|
199
|
+
| Status code | Description | Response headers |
|
|
200
|
+
|-------------|-------------|------------------|
|
|
201
|
+
|**200** | Compte client récupéré avec succès | - |
|
|
202
|
+
|**401** | Non authentifié | - |
|
|
203
|
+
|**404** | Compte client non trouvé | - |
|
|
204
|
+
|**500** | Erreur serveur | - |
|
|
205
|
+
|
|
206
|
+
[[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)
|
|
207
|
+
|
|
208
|
+
# **getSubscriptionsHistory**
|
|
209
|
+
> GetSubscriptionsHistory200Response getSubscriptionsHistory()
|
|
210
|
+
|
|
211
|
+
Récupère l\'historique des abonnements du compte client authentifié
|
|
212
|
+
|
|
213
|
+
### Example
|
|
214
|
+
|
|
215
|
+
```typescript
|
|
216
|
+
import {
|
|
217
|
+
ClientAccountsApi,
|
|
218
|
+
Configuration
|
|
219
|
+
} from '@tennac-booking/sdk';
|
|
220
|
+
|
|
221
|
+
const configuration = new Configuration();
|
|
222
|
+
const apiInstance = new ClientAccountsApi(configuration);
|
|
223
|
+
|
|
224
|
+
const { status, data } = await apiInstance.getSubscriptionsHistory();
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
### Parameters
|
|
228
|
+
This endpoint does not have any parameters.
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
### Return type
|
|
232
|
+
|
|
233
|
+
**GetSubscriptionsHistory200Response**
|
|
234
|
+
|
|
235
|
+
### Authorization
|
|
236
|
+
|
|
237
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
238
|
+
|
|
239
|
+
### HTTP request headers
|
|
240
|
+
|
|
241
|
+
- **Content-Type**: Not defined
|
|
242
|
+
- **Accept**: application/json
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
### HTTP response details
|
|
246
|
+
| Status code | Description | Response headers |
|
|
247
|
+
|-------------|-------------|------------------|
|
|
248
|
+
|**200** | Historique d\'abonnements récupéré avec succès | - |
|
|
249
|
+
|**401** | Non authentifié | - |
|
|
250
|
+
|**404** | Compte client non trouvé | - |
|
|
251
|
+
|**500** | Erreur serveur | - |
|
|
252
|
+
|
|
253
|
+
[[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)
|
|
254
|
+
|
|
255
|
+
# **listAvailablePrices**
|
|
256
|
+
> Array<any> listAvailablePrices()
|
|
257
|
+
|
|
258
|
+
Liste les prix Stripe disponibles pour les abonnements client
|
|
259
|
+
|
|
260
|
+
### Example
|
|
261
|
+
|
|
262
|
+
```typescript
|
|
263
|
+
import {
|
|
264
|
+
ClientAccountsApi,
|
|
265
|
+
Configuration
|
|
266
|
+
} from '@tennac-booking/sdk';
|
|
267
|
+
|
|
268
|
+
const configuration = new Configuration();
|
|
269
|
+
const apiInstance = new ClientAccountsApi(configuration);
|
|
270
|
+
|
|
271
|
+
const { status, data } = await apiInstance.listAvailablePrices();
|
|
272
|
+
```
|
|
273
|
+
|
|
274
|
+
### Parameters
|
|
275
|
+
This endpoint does not have any parameters.
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
### Return type
|
|
279
|
+
|
|
280
|
+
**Array<any>**
|
|
281
|
+
|
|
282
|
+
### Authorization
|
|
283
|
+
|
|
284
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
285
|
+
|
|
286
|
+
### HTTP request headers
|
|
287
|
+
|
|
288
|
+
- **Content-Type**: Not defined
|
|
289
|
+
- **Accept**: application/json
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
### HTTP response details
|
|
293
|
+
| Status code | Description | Response headers |
|
|
294
|
+
|-------------|-------------|------------------|
|
|
295
|
+
|**200** | Liste des prix récupérée | - |
|
|
296
|
+
|
|
297
|
+
[[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)
|
|
298
|
+
|
|
299
|
+
# **onboardClientAccount**
|
|
300
|
+
> ClientAccountOnboardingResponse onboardClientAccount(clientAccountOnboardingRequest)
|
|
301
|
+
|
|
302
|
+
Crée un nouveau compte client avec onboarding Stripe
|
|
303
|
+
|
|
304
|
+
### Example
|
|
305
|
+
|
|
306
|
+
```typescript
|
|
307
|
+
import {
|
|
308
|
+
ClientAccountsApi,
|
|
309
|
+
Configuration,
|
|
310
|
+
ClientAccountOnboardingRequest
|
|
311
|
+
} from '@tennac-booking/sdk';
|
|
312
|
+
|
|
313
|
+
const configuration = new Configuration();
|
|
314
|
+
const apiInstance = new ClientAccountsApi(configuration);
|
|
315
|
+
|
|
316
|
+
let clientAccountOnboardingRequest: ClientAccountOnboardingRequest; //Les données du compte à créer
|
|
317
|
+
|
|
318
|
+
const { status, data } = await apiInstance.onboardClientAccount(
|
|
319
|
+
clientAccountOnboardingRequest
|
|
320
|
+
);
|
|
321
|
+
```
|
|
322
|
+
|
|
323
|
+
### Parameters
|
|
324
|
+
|
|
325
|
+
|Name | Type | Description | Notes|
|
|
326
|
+
|------------- | ------------- | ------------- | -------------|
|
|
327
|
+
| **clientAccountOnboardingRequest** | **ClientAccountOnboardingRequest**| Les données du compte à créer | |
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
### Return type
|
|
331
|
+
|
|
332
|
+
**ClientAccountOnboardingResponse**
|
|
333
|
+
|
|
334
|
+
### Authorization
|
|
335
|
+
|
|
336
|
+
[clientAuth](../README.md#clientAuth)
|
|
337
|
+
|
|
338
|
+
### HTTP request headers
|
|
339
|
+
|
|
340
|
+
- **Content-Type**: application/json
|
|
341
|
+
- **Accept**: application/json
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
### HTTP response details
|
|
345
|
+
| Status code | Description | Response headers |
|
|
346
|
+
|-------------|-------------|------------------|
|
|
347
|
+
|**201** | Compte client créé avec succès | - |
|
|
348
|
+
|**400** | Données invalides | - |
|
|
349
|
+
|**401** | Non authentifié | - |
|
|
350
|
+
|**409** | Un compte client existe déjà pour cet utilisateur | - |
|
|
351
|
+
|**500** | Erreur serveur | - |
|
|
352
|
+
|
|
353
|
+
[[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)
|
|
354
|
+
|
|
355
|
+
# **registerClientUser**
|
|
356
|
+
> ClientRegisterResponse registerClientUser(clientRegisterRequestBody)
|
|
357
|
+
|
|
358
|
+
Route d\'inscription d\'un utilisateur client (publique)
|
|
359
|
+
|
|
360
|
+
### Example
|
|
361
|
+
|
|
362
|
+
```typescript
|
|
363
|
+
import {
|
|
364
|
+
ClientAccountsApi,
|
|
365
|
+
Configuration,
|
|
366
|
+
ClientRegisterRequestBody
|
|
367
|
+
} from '@tennac-booking/sdk';
|
|
368
|
+
|
|
369
|
+
const configuration = new Configuration();
|
|
370
|
+
const apiInstance = new ClientAccountsApi(configuration);
|
|
371
|
+
|
|
372
|
+
let clientRegisterRequestBody: ClientRegisterRequestBody; //
|
|
373
|
+
|
|
374
|
+
const { status, data } = await apiInstance.registerClientUser(
|
|
375
|
+
clientRegisterRequestBody
|
|
376
|
+
);
|
|
377
|
+
```
|
|
378
|
+
|
|
379
|
+
### Parameters
|
|
380
|
+
|
|
381
|
+
|Name | Type | Description | Notes|
|
|
382
|
+
|------------- | ------------- | ------------- | -------------|
|
|
383
|
+
| **clientRegisterRequestBody** | **ClientRegisterRequestBody**| | |
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
### Return type
|
|
387
|
+
|
|
388
|
+
**ClientRegisterResponse**
|
|
389
|
+
|
|
390
|
+
### Authorization
|
|
391
|
+
|
|
392
|
+
No authorization required
|
|
393
|
+
|
|
394
|
+
### HTTP request headers
|
|
395
|
+
|
|
396
|
+
- **Content-Type**: application/json
|
|
397
|
+
- **Accept**: application/json
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
### HTTP response details
|
|
401
|
+
| Status code | Description | Response headers |
|
|
402
|
+
|-------------|-------------|------------------|
|
|
403
|
+
|**201** | Compte client utilisateur créé | - |
|
|
404
|
+
|**400** | Données invalides | - |
|
|
405
|
+
|**409** | Email déjà utilisé | - |
|
|
406
|
+
|
|
407
|
+
[[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)
|
|
408
|
+
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
# ClientApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**getManagedClubs**](#getmanagedclubs) | **GET** /clients/managed-clubs | |
|
|
8
|
+
|[**onboardClub**](#onboardclub) | **POST** /clients/onboarding | |
|
|
9
|
+
|
|
10
|
+
# **getManagedClubs**
|
|
11
|
+
> ManagedClubsResponse getManagedClubs()
|
|
12
|
+
|
|
13
|
+
Récupère la liste des clubs gérés par l\'utilisateur authentifié
|
|
14
|
+
|
|
15
|
+
### Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import {
|
|
19
|
+
ClientApi,
|
|
20
|
+
Configuration
|
|
21
|
+
} from '@tennac-booking/sdk';
|
|
22
|
+
|
|
23
|
+
const configuration = new Configuration();
|
|
24
|
+
const apiInstance = new ClientApi(configuration);
|
|
25
|
+
|
|
26
|
+
const { status, data } = await apiInstance.getManagedClubs();
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
### Parameters
|
|
30
|
+
This endpoint does not have any parameters.
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
### Return type
|
|
34
|
+
|
|
35
|
+
**ManagedClubsResponse**
|
|
36
|
+
|
|
37
|
+
### Authorization
|
|
38
|
+
|
|
39
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
40
|
+
|
|
41
|
+
### HTTP request headers
|
|
42
|
+
|
|
43
|
+
- **Content-Type**: Not defined
|
|
44
|
+
- **Accept**: application/json
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
### HTTP response details
|
|
48
|
+
| Status code | Description | Response headers |
|
|
49
|
+
|-------------|-------------|------------------|
|
|
50
|
+
|**200** | Clubs récupérés avec succès | - |
|
|
51
|
+
|**401** | Non authentifié | - |
|
|
52
|
+
|**500** | Erreur serveur | - |
|
|
53
|
+
|
|
54
|
+
[[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)
|
|
55
|
+
|
|
56
|
+
# **onboardClub**
|
|
57
|
+
> ClientOnboardingResponse onboardClub(clientOnboardingRequestBody)
|
|
58
|
+
|
|
59
|
+
Enregistre un nouveau club pour la plateforme - Crée un compte Stripe Connect Express - Crée le club dans la base de données - Assigne l\'utilisateur comme manager du club - Crée les paramètres par défaut du club - Envoie le lien d\'onboarding Stripe par email
|
|
60
|
+
|
|
61
|
+
### Example
|
|
62
|
+
|
|
63
|
+
```typescript
|
|
64
|
+
import {
|
|
65
|
+
ClientApi,
|
|
66
|
+
Configuration,
|
|
67
|
+
ClientOnboardingRequestBody
|
|
68
|
+
} from '@tennac-booking/sdk';
|
|
69
|
+
|
|
70
|
+
const configuration = new Configuration();
|
|
71
|
+
const apiInstance = new ClientApi(configuration);
|
|
72
|
+
|
|
73
|
+
let clientOnboardingRequestBody: ClientOnboardingRequestBody; //Les données du club à créer
|
|
74
|
+
|
|
75
|
+
const { status, data } = await apiInstance.onboardClub(
|
|
76
|
+
clientOnboardingRequestBody
|
|
77
|
+
);
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
### Parameters
|
|
81
|
+
|
|
82
|
+
|Name | Type | Description | Notes|
|
|
83
|
+
|------------- | ------------- | ------------- | -------------|
|
|
84
|
+
| **clientOnboardingRequestBody** | **ClientOnboardingRequestBody**| Les données du club à créer | |
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
### Return type
|
|
88
|
+
|
|
89
|
+
**ClientOnboardingResponse**
|
|
90
|
+
|
|
91
|
+
### Authorization
|
|
92
|
+
|
|
93
|
+
No authorization required
|
|
94
|
+
|
|
95
|
+
### HTTP request headers
|
|
96
|
+
|
|
97
|
+
- **Content-Type**: application/json
|
|
98
|
+
- **Accept**: application/json
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
### HTTP response details
|
|
102
|
+
| Status code | Description | Response headers |
|
|
103
|
+
|-------------|-------------|------------------|
|
|
104
|
+
|**201** | Club créé avec succès | - |
|
|
105
|
+
|**400** | Données invalides | - |
|
|
106
|
+
|**500** | Erreur serveur | - |
|
|
107
|
+
|
|
108
|
+
[[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)
|
|
109
|
+
|
|
@@ -1,25 +1,27 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ClientMeResponse
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**
|
|
9
|
-
**
|
|
8
|
+
**id** | **string** | | [default to undefined]
|
|
9
|
+
**email** | **string** | | [default to undefined]
|
|
10
10
|
**firstName** | **string** | | [default to undefined]
|
|
11
|
-
**
|
|
11
|
+
**lastName** | **string** | | [default to undefined]
|
|
12
|
+
**isClient** | **boolean** | | [default to undefined]
|
|
12
13
|
|
|
13
14
|
## Example
|
|
14
15
|
|
|
15
16
|
```typescript
|
|
16
|
-
import {
|
|
17
|
+
import { ClientMeResponse } from '@tennac-booking/sdk';
|
|
17
18
|
|
|
18
|
-
const instance:
|
|
19
|
-
|
|
20
|
-
|
|
19
|
+
const instance: ClientMeResponse = {
|
|
20
|
+
id,
|
|
21
|
+
email,
|
|
21
22
|
firstName,
|
|
22
|
-
|
|
23
|
+
lastName,
|
|
24
|
+
isClient,
|
|
23
25
|
};
|
|
24
26
|
```
|
|
25
27
|
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# ClientOnboardingRequestBody
|
|
2
|
+
|
|
3
|
+
Requête pour l\'onboarding d\'un club
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**clubName** | **string** | Nom du club | [default to undefined]
|
|
10
|
+
**email** | **string** | Email du club pour le compte Stripe | [default to undefined]
|
|
11
|
+
**phone** | **string** | Numéro de téléphone du club (optionnel) | [optional] [default to undefined]
|
|
12
|
+
**address** | **string** | Adresse du club (optionnel) | [optional] [default to undefined]
|
|
13
|
+
**city** | **string** | Ville du club (optionnel) | [optional] [default to undefined]
|
|
14
|
+
**postalCode** | **string** | Code postal du club (optionnel) | [optional] [default to undefined]
|
|
15
|
+
**country** | **string** | Pays du club (optionnel) | [optional] [default to undefined]
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { ClientOnboardingRequestBody } from '@tennac-booking/sdk';
|
|
21
|
+
|
|
22
|
+
const instance: ClientOnboardingRequestBody = {
|
|
23
|
+
clubName,
|
|
24
|
+
email,
|
|
25
|
+
phone,
|
|
26
|
+
address,
|
|
27
|
+
city,
|
|
28
|
+
postalCode,
|
|
29
|
+
country,
|
|
30
|
+
};
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
[[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,27 @@
|
|
|
1
|
+
# ClientOnboardingResponse
|
|
2
|
+
|
|
3
|
+
Réponse pour l\'onboarding d\'un club
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**clubId** | **string** | ID unique du club créé | [default to undefined]
|
|
10
|
+
**stripeAccountId** | **string** | ID du compte Stripe Connect du club | [default to undefined]
|
|
11
|
+
**onboardingLink** | **string** | Lien d\'onboarding Stripe pour configurer le compte | [default to undefined]
|
|
12
|
+
**message** | **string** | Message de confirmation | [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { ClientOnboardingResponse } from '@tennac-booking/sdk';
|
|
18
|
+
|
|
19
|
+
const instance: ClientOnboardingResponse = {
|
|
20
|
+
clubId,
|
|
21
|
+
stripeAccountId,
|
|
22
|
+
onboardingLink,
|
|
23
|
+
message,
|
|
24
|
+
};
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
[[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
|
+
# ClientRegisterRequestBody
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**email** | **string** | | [default to undefined]
|
|
9
|
+
**password** | **string** | | [default to undefined]
|
|
10
|
+
**firstName** | **string** | | [default to undefined]
|
|
11
|
+
**lastName** | **string** | | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { ClientRegisterRequestBody } from '@tennac-booking/sdk';
|
|
17
|
+
|
|
18
|
+
const instance: ClientRegisterRequestBody = {
|
|
19
|
+
email,
|
|
20
|
+
password,
|
|
21
|
+
firstName,
|
|
22
|
+
lastName,
|
|
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,22 @@
|
|
|
1
|
+
# ClientRegisterResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | | [default to undefined]
|
|
9
|
+
**token** | **string** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { ClientRegisterResponse } from '@tennac-booking/sdk';
|
|
15
|
+
|
|
16
|
+
const instance: ClientRegisterResponse = {
|
|
17
|
+
id,
|
|
18
|
+
token,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[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
|
+
# ClientSubscriptionResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | | [default to undefined]
|
|
9
|
+
**subscriptionType** | **string** | | [default to undefined]
|
|
10
|
+
**status** | **string** | | [default to undefined]
|
|
11
|
+
**startDate** | **string** | | [default to undefined]
|
|
12
|
+
**endDate** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**priceAmountInCents** | **number** | | [default to undefined]
|
|
14
|
+
**currency** | **string** | | [default to undefined]
|
|
15
|
+
**billingCycle** | **string** | | [default to undefined]
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { ClientSubscriptionResponse } from '@tennac-booking/sdk';
|
|
21
|
+
|
|
22
|
+
const instance: ClientSubscriptionResponse = {
|
|
23
|
+
id,
|
|
24
|
+
subscriptionType,
|
|
25
|
+
status,
|
|
26
|
+
startDate,
|
|
27
|
+
endDate,
|
|
28
|
+
priceAmountInCents,
|
|
29
|
+
currency,
|
|
30
|
+
billingCycle,
|
|
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)
|