@tennac-booking/sdk 1.0.115 → 1.0.116
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 +305 -300
- package/README.md +10 -2
- package/api.ts +352 -21
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +273 -21
- package/dist/api.js +155 -25
- 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 +273 -21
- package/dist/esm/api.js +151 -21
- 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/ActiveClub.md +24 -0
- package/docs/ActiveClubListResponse.md +20 -0
- package/docs/AddClubMemberResponse.md +22 -0
- package/docs/AddFavoriteClubRequestBody.md +20 -0
- package/docs/AddFavoritePlayerRequestBody.md +20 -0
- package/docs/AddPaymentMethodSetupRequestBody.md +20 -0
- package/docs/AddPaymentMethodSetupResponse.md +24 -0
- package/docs/AdminClubAnalyticsApi.md +249 -0
- package/docs/AdminClubSlotsApi.md +182 -0
- package/docs/AdminClubSubscriptionsApi.md +394 -0
- package/docs/AdminClubsApi.md +170 -0
- package/docs/ApiErrorResponse.md +22 -0
- package/docs/BlockSlotResponse.md +22 -0
- package/docs/Booking.md +32 -0
- package/docs/BookingPaymentStatusResponsePaymentStatusInner.md +36 -0
- package/docs/BookingPopulatedPaymentByPlayersStatusInner.md +22 -0
- package/docs/BookingPopulatedPaymentByPlayersStatusInnerInvoicesInner.md +24 -0
- package/docs/BookingPopulatedSlotId.md +26 -0
- package/docs/BookingPopulatedSlotIdCourtId.md +22 -0
- package/docs/BookingPopulatedUserId.md +24 -0
- package/docs/BookingsUserApi.md +1 -1
- package/docs/CancelBookingResponseBooking.md +30 -0
- package/docs/CheckInPlayersResponseCheckedInPlayersInner.md +34 -0
- package/docs/ClientApi.md +49 -2
- package/docs/ClientFullOnboardingResponseClub.md +2 -0
- package/docs/ClientOnboardingRequestBody.md +2 -0
- package/docs/ClientSubscription.md +31 -0
- package/docs/ClientSubscriptionItem.md +25 -0
- package/docs/ClientSubscriptionsResponse.md +21 -0
- package/docs/Club.md +46 -0
- package/docs/ClubInfoResponse.md +48 -0
- package/docs/ClubListResponse.md +22 -0
- package/docs/ClubMember.md +34 -0
- package/docs/ClubMembersResponse.md +22 -0
- package/docs/ClubRole.md +30 -0
- package/docs/ClubRolesResponse.md +22 -0
- package/docs/ClubSettings.md +40 -0
- package/docs/ClubsApi.md +2 -2
- package/docs/ClubsResponse.md +22 -0
- package/docs/ConfirmPaymentMethodSetupRequestBody.md +20 -0
- package/docs/ConfirmPaymentMethodSetupResponse.md +22 -0
- package/docs/Court.md +32 -0
- package/docs/CourtsResponse.md +22 -0
- package/docs/CreateClubRoleRequestBody.md +24 -0
- package/docs/CreateClubSettingsRequest.md +28 -0
- package/docs/CreatePriceRequest.md +26 -0
- package/docs/DeleteClub200Response.md +20 -0
- package/docs/DeleteClubRole200Response.md +20 -0
- package/docs/DeleteClubSettingsRequest.md +20 -0
- package/docs/DeleteEvent200Response.md +20 -0
- package/docs/DeleteSlotsByClubInRange200Response.md +20 -0
- package/docs/DeleteSlotsResponse.md +20 -0
- package/docs/DeleteSport200Response.md +20 -0
- package/docs/EstimateEventPrice200Response.md +26 -0
- package/docs/EstimateEventPriceRequest.md +22 -0
- package/docs/EstimateEventPriceRequestSharesInner.md +22 -0
- package/docs/Event.md +40 -0
- package/docs/EventBooking.md +32 -0
- package/docs/EventRegistrationRequest.md +22 -0
- package/docs/EventsApi.md +58 -0
- package/docs/FavoriteClubItem.md +26 -0
- package/docs/FavoriteClubResponse.md +22 -0
- package/docs/FavoritePlayerPublic.md +28 -0
- package/docs/FavoritePlayersIdsResponse.md +22 -0
- package/docs/FrequentlyPlayedWithItem.md +28 -0
- package/docs/FrequentlyVisitedClubItem.md +24 -0
- package/docs/GenerateSlotsResponse.md +20 -0
- package/docs/GetActiveClubs200Response.md +20 -0
- package/docs/GetClubInfos200Response.md +30 -0
- package/docs/GetCourtsByClubAndSport200Response.md +26 -0
- package/docs/GetLastSixMonthsTurnover200ResponseInner.md +22 -0
- package/docs/GetNumberOfClubUsers200Response.md +20 -0
- package/docs/GetPublishedEventsByClubId200Response.md +20 -0
- package/docs/GetUserRolesResponse.md +20 -0
- package/docs/GetUserRolesResponseRolesInner.md +26 -0
- package/docs/GetUserSubscriptionsResponse.md +22 -0
- package/docs/GoogleSignInRequestBody.md +20 -0
- package/docs/GoogleSignInResponse.md +24 -0
- package/docs/InitiateSubscriptionSessionRequestBody.md +26 -0
- package/docs/InitiateSubscriptionSessionResponse.md +22 -0
- package/docs/InvoicesResponse.md +22 -0
- package/docs/InvoicesResponseInvoicesInner.md +34 -0
- package/docs/InvoicesResponsePagination.md +26 -0
- package/docs/JoinEventRequestPlayersPaymentMethodsInner.md +2 -0
- package/docs/LevelBySportsItem.md +22 -0
- package/docs/ManagerBookingsApi.md +125 -0
- package/docs/ManagerCancelBookingResponseBooking.md +30 -0
- package/docs/ManagerClubCourtsApi.md +108 -0
- package/docs/ManagerClubRolesApi.md +268 -0
- package/docs/ManagerClubSlotsApi.md +119 -0
- package/docs/ManagerClubSubscriptionsApi.md +387 -0
- package/docs/ManagerClubsApi.md +253 -0
- package/docs/ManagerEventResponse.md +22 -0
- package/docs/ManagerEventsApi.md +227 -0
- package/docs/ManagerSportsApi.md +174 -0
- package/docs/NoShowFeeResponseCaptureResultsInner.md +30 -0
- package/docs/NoShowFeeResponseCreatorChargeResult.md +26 -0
- package/docs/PriceResponse.md +32 -0
- package/docs/ProfileVisibilityResponse.md +20 -0
- package/docs/PublicClubUser.md +46 -0
- package/docs/PublicClubUserFrequentlyPlayedWithInner.md +28 -0
- package/docs/PublicClubUserFrequentlyVisitedClubsInner.md +24 -0
- package/docs/PublicClubUserLevelBySportsInner.md +22 -0
- package/docs/RegisterForEvent201Response.md +20 -0
- package/docs/RestoreSubscriptionPlanForClub200Response.md +20 -0
- package/docs/SetupPaymentMethodRequestBody.md +20 -0
- package/docs/SetupPaymentMethodResponse.md +24 -0
- package/docs/Slot.md +24 -0
- package/docs/SlotException.md +26 -0
- package/docs/SlotResponse.md +34 -0
- package/docs/SlotsResponse.md +22 -0
- package/docs/Sport.md +24 -0
- package/docs/SportsResponse.md +22 -0
- package/docs/StaffClubAnalyticsApi.md +104 -0
- package/docs/StaffClubBookingsApi.md +52 -0
- package/docs/StaffClubsApi.md +100 -0
- package/docs/StaffEventResponse.md +20 -0
- package/docs/StaffEventsApi.md +54 -0
- package/docs/StaffProfileApi.md +54 -0
- package/docs/StripeStatus.md +16 -0
- package/docs/SubscribeToClubRequestBody.md +22 -0
- package/docs/SubscriptionPlan.md +36 -0
- package/docs/SubscriptionResponse.md +36 -0
- package/docs/UpdateClubRoleRequestBody.md +24 -0
- package/docs/UpdateClubSettingsRequest.md +28 -0
- package/docs/UpdateCustomerRequestBodyAddress.md +30 -0
- package/docs/UpdateCustomerResponseCustomer.md +28 -0
- package/docs/UpdateProfilePictureRequestBody.md +20 -0
- package/docs/UpdateProfileVisibilityRequestBody.md +20 -0
- package/docs/UpdateSubscriptionPlanRequest.md +24 -0
- package/docs/UpdateSubscriptionPlanResponse.md +22 -0
- package/docs/UpdateUserCityRequestBody.md +20 -0
- package/docs/UpdateUserDescriptionRequestBody.md +20 -0
- package/docs/User.md +40 -0
- package/docs/UserAuthenticationApi.md +226 -0
- package/docs/UserBookingsApi.md +120 -0
- package/docs/UserCityResponse.md +20 -0
- package/docs/UserClubCourtsApi.md +64 -0
- package/docs/UserClubSlotsApi.md +181 -0
- package/docs/UserClubSportsApi.md +60 -0
- package/docs/UserClubsApi.md +53 -0
- package/docs/UserDescriptionResponse.md +20 -0
- package/docs/UserFavoriteClubsResponse.md +20 -0
- package/docs/UserPaymentApi.md +176 -0
- package/docs/UserProfileApi.md +1201 -0
- package/docs/UserResponse.md +38 -0
- package/docs/UserSubscriptionsApi.md +222 -0
- package/docs/UsersResponse.md +22 -0
- package/docs/YearlyTurnoverResponseMonthlyBreakdownInner.md +24 -0
- package/index.ts +1 -1
- package/package.json +1 -1
|
@@ -0,0 +1,1201 @@
|
|
|
1
|
+
# UserProfileApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.mon-domaine.com*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**addFavoriteClub**](#addfavoriteclub) | **POST** /api/users/me/favorite-clubs | Add a club to the user\'s favorite list|
|
|
8
|
+
|[**addFavoritePlayer**](#addfavoriteplayer) | **POST** /api/users/me/favoritesPlayers | Ajoute un joueur aux favoris de l\'utilisateur connecté|
|
|
9
|
+
|[**changePassword**](#changepassword) | **PUT** /api/users/me/password | Modifie le mot de passe de l\'utilisateur connecté|
|
|
10
|
+
|[**getAllUsers**](#getallusers) | **GET** /api/users | Récupère la liste des utilisateurs avec filtres et pagination|
|
|
11
|
+
|[**getFavoriteClubs**](#getfavoriteclubs) | **GET** /api/users/me/favorite-clubs | Retrieve the list of favorite clubs for the logged-in user|
|
|
12
|
+
|[**getFavoritesPlayers**](#getfavoritesplayers) | **GET** /api/users/me/favoritesPlayers | Récupère les joueurs favoris (profils visibles) de l\'utilisateur connecté|
|
|
13
|
+
|[**getFrequentlyPlayedWith**](#getfrequentlyplayedwith) | **GET** /api/users/me/frequentlyPlayedWith | Joueurs avec lesquels l\'utilisateur a le plus joué (profils visibles)|
|
|
14
|
+
|[**getFrequentlyVisitedClub**](#getfrequentlyvisitedclub) | **GET** /api/users/me/frequentlyVisitedClub | Clubs les plus fréquemment visités par l\'utilisateur connecté|
|
|
15
|
+
|[**getProfilePicture**](#getprofilepicture) | **GET** /api/users/me/profile-picture | Récupère l\'URL de la photo de profil de l\'utilisateur connecté|
|
|
16
|
+
|[**getPublicUserProfile**](#getpublicuserprofile) | **GET** /api/users/profile/{id} | Récupère le profil public d\'un utilisateur par son ID|
|
|
17
|
+
|[**getUserBookings**](#getuserbookings) | **GET** /api/users/me/bookings | Récupère toutes les réservations de l\'utilisateur connecté (triées par date de création décroissante)|
|
|
18
|
+
|[**getUserCity**](#getusercity) | **GET** /api/users/me/city | Récupère la ville de l\'utilisateur connecté|
|
|
19
|
+
|[**getUserDescription**](#getuserdescription) | **GET** /api/users/me/description | Récupère la description de l\'utilisateur connecté|
|
|
20
|
+
|[**getUserInfo**](#getuserinfo) | **GET** /api/users/me | Récupère les informations de l\'utilisateur connecté|
|
|
21
|
+
|[**getUserProfileVisibility**](#getuserprofilevisibility) | **GET** /api/users/me/profile-visibility | Récupère la visibilité du profil de l\'utilisateur connecté|
|
|
22
|
+
|[**removeFavoriteClub**](#removefavoriteclub) | **DELETE** /api/users/me/favorite-clubs/{clubId} | Remove a club from the user\'s favorite list|
|
|
23
|
+
|[**removeFavoritePlayer**](#removefavoriteplayer) | **DELETE** /api/users/me/favoritesPlayers/{favoritePlayerId} | Retire un joueur des favoris de l\'utilisateur connecté|
|
|
24
|
+
|[**updateLevelBySports**](#updatelevelbysports) | **PUT** /api/users/me/level-by-sports | Met à jour le tableau levelBySports de l\'utilisateur connecté|
|
|
25
|
+
|[**updateProfilePicture**](#updateprofilepicture) | **PUT** /api/users/me/profile-picture | Met à jour l\'URL de la photo de profil de l\'utilisateur connecté|
|
|
26
|
+
|[**updateProfileVisibility**](#updateprofilevisibility) | **PUT** /api/users/me/profile-visibility | Met à jour la visibilité du profil de l\'utilisateur connecté|
|
|
27
|
+
|[**updateUser**](#updateuser) | **PUT** /api/users/me | Met à jour les données de l\'utilisateur connecté|
|
|
28
|
+
|[**updateUserCity**](#updateusercity) | **PUT** /api/users/me/city | Met à jour la ville de l\'utilisateur connecté|
|
|
29
|
+
|[**updateUserDescription**](#updateuserdescription) | **PUT** /api/users/me/description | Met à jour la description de l\'utilisateur connecté|
|
|
30
|
+
|
|
31
|
+
# **addFavoriteClub**
|
|
32
|
+
> FavoriteClubResponse addFavoriteClub(addFavoriteClubRequestBody)
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
### Example
|
|
36
|
+
|
|
37
|
+
```typescript
|
|
38
|
+
import {
|
|
39
|
+
UserProfileApi,
|
|
40
|
+
Configuration,
|
|
41
|
+
AddFavoriteClubRequestBody
|
|
42
|
+
} from '@tennac-booking/sdk';
|
|
43
|
+
|
|
44
|
+
const configuration = new Configuration();
|
|
45
|
+
const apiInstance = new UserProfileApi(configuration);
|
|
46
|
+
|
|
47
|
+
let addFavoriteClubRequestBody: AddFavoriteClubRequestBody; //
|
|
48
|
+
|
|
49
|
+
const { status, data } = await apiInstance.addFavoriteClub(
|
|
50
|
+
addFavoriteClubRequestBody
|
|
51
|
+
);
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
### Parameters
|
|
55
|
+
|
|
56
|
+
|Name | Type | Description | Notes|
|
|
57
|
+
|------------- | ------------- | ------------- | -------------|
|
|
58
|
+
| **addFavoriteClubRequestBody** | **AddFavoriteClubRequestBody**| | |
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
### Return type
|
|
62
|
+
|
|
63
|
+
**FavoriteClubResponse**
|
|
64
|
+
|
|
65
|
+
### Authorization
|
|
66
|
+
|
|
67
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
68
|
+
|
|
69
|
+
### HTTP request headers
|
|
70
|
+
|
|
71
|
+
- **Content-Type**: application/json
|
|
72
|
+
- **Accept**: application/json
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
### HTTP response details
|
|
76
|
+
| Status code | Description | Response headers |
|
|
77
|
+
|-------------|-------------|------------------|
|
|
78
|
+
|**200** | Club added to favorites | - |
|
|
79
|
+
|**400** | Requête invalide | - |
|
|
80
|
+
|**401** | Non autorisé | - |
|
|
81
|
+
|**500** | Erreur serveur interne | - |
|
|
82
|
+
|
|
83
|
+
[[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)
|
|
84
|
+
|
|
85
|
+
# **addFavoritePlayer**
|
|
86
|
+
> FavoritePlayersIdsResponse addFavoritePlayer(addFavoritePlayerRequestBody)
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
### Example
|
|
90
|
+
|
|
91
|
+
```typescript
|
|
92
|
+
import {
|
|
93
|
+
UserProfileApi,
|
|
94
|
+
Configuration,
|
|
95
|
+
AddFavoritePlayerRequestBody
|
|
96
|
+
} from '@tennac-booking/sdk';
|
|
97
|
+
|
|
98
|
+
const configuration = new Configuration();
|
|
99
|
+
const apiInstance = new UserProfileApi(configuration);
|
|
100
|
+
|
|
101
|
+
let addFavoritePlayerRequestBody: AddFavoritePlayerRequestBody; //
|
|
102
|
+
|
|
103
|
+
const { status, data } = await apiInstance.addFavoritePlayer(
|
|
104
|
+
addFavoritePlayerRequestBody
|
|
105
|
+
);
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
### Parameters
|
|
109
|
+
|
|
110
|
+
|Name | Type | Description | Notes|
|
|
111
|
+
|------------- | ------------- | ------------- | -------------|
|
|
112
|
+
| **addFavoritePlayerRequestBody** | **AddFavoritePlayerRequestBody**| | |
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
### Return type
|
|
116
|
+
|
|
117
|
+
**FavoritePlayersIdsResponse**
|
|
118
|
+
|
|
119
|
+
### Authorization
|
|
120
|
+
|
|
121
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
122
|
+
|
|
123
|
+
### HTTP request headers
|
|
124
|
+
|
|
125
|
+
- **Content-Type**: application/json
|
|
126
|
+
- **Accept**: application/json
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
### HTTP response details
|
|
130
|
+
| Status code | Description | Response headers |
|
|
131
|
+
|-------------|-------------|------------------|
|
|
132
|
+
|**200** | Joueur ajouté aux favoris | - |
|
|
133
|
+
|**400** | Requête invalide | - |
|
|
134
|
+
|**401** | Non autorisé | - |
|
|
135
|
+
|**404** | Ressource non trouvée | - |
|
|
136
|
+
|**500** | Erreur serveur interne | - |
|
|
137
|
+
|
|
138
|
+
[[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)
|
|
139
|
+
|
|
140
|
+
# **changePassword**
|
|
141
|
+
> ChangePasswordResponse changePassword(changePasswordRequestBody)
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
### Example
|
|
145
|
+
|
|
146
|
+
```typescript
|
|
147
|
+
import {
|
|
148
|
+
UserProfileApi,
|
|
149
|
+
Configuration,
|
|
150
|
+
ChangePasswordRequestBody
|
|
151
|
+
} from '@tennac-booking/sdk';
|
|
152
|
+
|
|
153
|
+
const configuration = new Configuration();
|
|
154
|
+
const apiInstance = new UserProfileApi(configuration);
|
|
155
|
+
|
|
156
|
+
let changePasswordRequestBody: ChangePasswordRequestBody; //
|
|
157
|
+
|
|
158
|
+
const { status, data } = await apiInstance.changePassword(
|
|
159
|
+
changePasswordRequestBody
|
|
160
|
+
);
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
### Parameters
|
|
164
|
+
|
|
165
|
+
|Name | Type | Description | Notes|
|
|
166
|
+
|------------- | ------------- | ------------- | -------------|
|
|
167
|
+
| **changePasswordRequestBody** | **ChangePasswordRequestBody**| | |
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
### Return type
|
|
171
|
+
|
|
172
|
+
**ChangePasswordResponse**
|
|
173
|
+
|
|
174
|
+
### Authorization
|
|
175
|
+
|
|
176
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
177
|
+
|
|
178
|
+
### HTTP request headers
|
|
179
|
+
|
|
180
|
+
- **Content-Type**: application/json
|
|
181
|
+
- **Accept**: application/json
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
### HTTP response details
|
|
185
|
+
| Status code | Description | Response headers |
|
|
186
|
+
|-------------|-------------|------------------|
|
|
187
|
+
|**200** | Mot de passe modifié | - |
|
|
188
|
+
|**400** | Requête invalide | - |
|
|
189
|
+
|**401** | Non autorisé | - |
|
|
190
|
+
|**404** | Ressource non trouvée | - |
|
|
191
|
+
|**500** | Erreur serveur interne | - |
|
|
192
|
+
|
|
193
|
+
[[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)
|
|
194
|
+
|
|
195
|
+
# **getAllUsers**
|
|
196
|
+
> Array<UserResponse> getAllUsers()
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
### Example
|
|
200
|
+
|
|
201
|
+
```typescript
|
|
202
|
+
import {
|
|
203
|
+
UserProfileApi,
|
|
204
|
+
Configuration
|
|
205
|
+
} from '@tennac-booking/sdk';
|
|
206
|
+
|
|
207
|
+
const configuration = new Configuration();
|
|
208
|
+
const apiInstance = new UserProfileApi(configuration);
|
|
209
|
+
|
|
210
|
+
let limit: number; //Nombre maximum d\'utilisateurs à retourner (optional) (default to 20)
|
|
211
|
+
let skip: number; //Nombre d\'utilisateurs à ignorer (pagination) (optional) (default to 0)
|
|
212
|
+
let search: string; //Recherche dans firstName, lastName, email (optional) (default to undefined)
|
|
213
|
+
|
|
214
|
+
const { status, data } = await apiInstance.getAllUsers(
|
|
215
|
+
limit,
|
|
216
|
+
skip,
|
|
217
|
+
search
|
|
218
|
+
);
|
|
219
|
+
```
|
|
220
|
+
|
|
221
|
+
### Parameters
|
|
222
|
+
|
|
223
|
+
|Name | Type | Description | Notes|
|
|
224
|
+
|------------- | ------------- | ------------- | -------------|
|
|
225
|
+
| **limit** | [**number**] | Nombre maximum d\'utilisateurs à retourner | (optional) defaults to 20|
|
|
226
|
+
| **skip** | [**number**] | Nombre d\'utilisateurs à ignorer (pagination) | (optional) defaults to 0|
|
|
227
|
+
| **search** | [**string**] | Recherche dans firstName, lastName, email | (optional) defaults to undefined|
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
### Return type
|
|
231
|
+
|
|
232
|
+
**Array<UserResponse>**
|
|
233
|
+
|
|
234
|
+
### Authorization
|
|
235
|
+
|
|
236
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
237
|
+
|
|
238
|
+
### HTTP request headers
|
|
239
|
+
|
|
240
|
+
- **Content-Type**: Not defined
|
|
241
|
+
- **Accept**: application/json
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
### HTTP response details
|
|
245
|
+
| Status code | Description | Response headers |
|
|
246
|
+
|-------------|-------------|------------------|
|
|
247
|
+
|**200** | Liste des utilisateurs | - |
|
|
248
|
+
|**401** | Non autorisé | - |
|
|
249
|
+
|**500** | Erreur serveur interne | - |
|
|
250
|
+
|
|
251
|
+
[[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)
|
|
252
|
+
|
|
253
|
+
# **getFavoriteClubs**
|
|
254
|
+
> UserFavoriteClubsResponse getFavoriteClubs()
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
### Example
|
|
258
|
+
|
|
259
|
+
```typescript
|
|
260
|
+
import {
|
|
261
|
+
UserProfileApi,
|
|
262
|
+
Configuration
|
|
263
|
+
} from '@tennac-booking/sdk';
|
|
264
|
+
|
|
265
|
+
const configuration = new Configuration();
|
|
266
|
+
const apiInstance = new UserProfileApi(configuration);
|
|
267
|
+
|
|
268
|
+
const { status, data } = await apiInstance.getFavoriteClubs();
|
|
269
|
+
```
|
|
270
|
+
|
|
271
|
+
### Parameters
|
|
272
|
+
This endpoint does not have any parameters.
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
### Return type
|
|
276
|
+
|
|
277
|
+
**UserFavoriteClubsResponse**
|
|
278
|
+
|
|
279
|
+
### Authorization
|
|
280
|
+
|
|
281
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
282
|
+
|
|
283
|
+
### HTTP request headers
|
|
284
|
+
|
|
285
|
+
- **Content-Type**: Not defined
|
|
286
|
+
- **Accept**: application/json
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
### HTTP response details
|
|
290
|
+
| Status code | Description | Response headers |
|
|
291
|
+
|-------------|-------------|------------------|
|
|
292
|
+
|**200** | List of favorite clubs | - |
|
|
293
|
+
|**401** | Non autorisé | - |
|
|
294
|
+
|**500** | Erreur serveur interne | - |
|
|
295
|
+
|
|
296
|
+
[[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)
|
|
297
|
+
|
|
298
|
+
# **getFavoritesPlayers**
|
|
299
|
+
> FavoritePlayersResponse getFavoritesPlayers()
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
### Example
|
|
303
|
+
|
|
304
|
+
```typescript
|
|
305
|
+
import {
|
|
306
|
+
UserProfileApi,
|
|
307
|
+
Configuration
|
|
308
|
+
} from '@tennac-booking/sdk';
|
|
309
|
+
|
|
310
|
+
const configuration = new Configuration();
|
|
311
|
+
const apiInstance = new UserProfileApi(configuration);
|
|
312
|
+
|
|
313
|
+
const { status, data } = await apiInstance.getFavoritesPlayers();
|
|
314
|
+
```
|
|
315
|
+
|
|
316
|
+
### Parameters
|
|
317
|
+
This endpoint does not have any parameters.
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
### Return type
|
|
321
|
+
|
|
322
|
+
**FavoritePlayersResponse**
|
|
323
|
+
|
|
324
|
+
### Authorization
|
|
325
|
+
|
|
326
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
327
|
+
|
|
328
|
+
### HTTP request headers
|
|
329
|
+
|
|
330
|
+
- **Content-Type**: Not defined
|
|
331
|
+
- **Accept**: application/json
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
### HTTP response details
|
|
335
|
+
| Status code | Description | Response headers |
|
|
336
|
+
|-------------|-------------|------------------|
|
|
337
|
+
|**200** | Liste des joueurs favoris visibles | - |
|
|
338
|
+
|**401** | Non autorisé | - |
|
|
339
|
+
|**500** | Erreur serveur interne | - |
|
|
340
|
+
|
|
341
|
+
[[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)
|
|
342
|
+
|
|
343
|
+
# **getFrequentlyPlayedWith**
|
|
344
|
+
> Array<FrequentlyPlayedWithItem> getFrequentlyPlayedWith()
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
### Example
|
|
348
|
+
|
|
349
|
+
```typescript
|
|
350
|
+
import {
|
|
351
|
+
UserProfileApi,
|
|
352
|
+
Configuration
|
|
353
|
+
} from '@tennac-booking/sdk';
|
|
354
|
+
|
|
355
|
+
const configuration = new Configuration();
|
|
356
|
+
const apiInstance = new UserProfileApi(configuration);
|
|
357
|
+
|
|
358
|
+
const { status, data } = await apiInstance.getFrequentlyPlayedWith();
|
|
359
|
+
```
|
|
360
|
+
|
|
361
|
+
### Parameters
|
|
362
|
+
This endpoint does not have any parameters.
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
### Return type
|
|
366
|
+
|
|
367
|
+
**Array<FrequentlyPlayedWithItem>**
|
|
368
|
+
|
|
369
|
+
### Authorization
|
|
370
|
+
|
|
371
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
372
|
+
|
|
373
|
+
### HTTP request headers
|
|
374
|
+
|
|
375
|
+
- **Content-Type**: Not defined
|
|
376
|
+
- **Accept**: application/json
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
### HTTP response details
|
|
380
|
+
| Status code | Description | Response headers |
|
|
381
|
+
|-------------|-------------|------------------|
|
|
382
|
+
|**200** | Liste des joueurs triée par nombre de parties jouées | - |
|
|
383
|
+
|**401** | Non autorisé | - |
|
|
384
|
+
|**500** | Erreur serveur interne | - |
|
|
385
|
+
|
|
386
|
+
[[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)
|
|
387
|
+
|
|
388
|
+
# **getFrequentlyVisitedClub**
|
|
389
|
+
> Array<FrequentlyVisitedClubItem> getFrequentlyVisitedClub()
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
### Example
|
|
393
|
+
|
|
394
|
+
```typescript
|
|
395
|
+
import {
|
|
396
|
+
UserProfileApi,
|
|
397
|
+
Configuration
|
|
398
|
+
} from '@tennac-booking/sdk';
|
|
399
|
+
|
|
400
|
+
const configuration = new Configuration();
|
|
401
|
+
const apiInstance = new UserProfileApi(configuration);
|
|
402
|
+
|
|
403
|
+
const { status, data } = await apiInstance.getFrequentlyVisitedClub();
|
|
404
|
+
```
|
|
405
|
+
|
|
406
|
+
### Parameters
|
|
407
|
+
This endpoint does not have any parameters.
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
### Return type
|
|
411
|
+
|
|
412
|
+
**Array<FrequentlyVisitedClubItem>**
|
|
413
|
+
|
|
414
|
+
### Authorization
|
|
415
|
+
|
|
416
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
417
|
+
|
|
418
|
+
### HTTP request headers
|
|
419
|
+
|
|
420
|
+
- **Content-Type**: Not defined
|
|
421
|
+
- **Accept**: application/json
|
|
422
|
+
|
|
423
|
+
|
|
424
|
+
### HTTP response details
|
|
425
|
+
| Status code | Description | Response headers |
|
|
426
|
+
|-------------|-------------|------------------|
|
|
427
|
+
|**200** | Liste des clubs triée par nombre de visites | - |
|
|
428
|
+
|**401** | Non autorisé | - |
|
|
429
|
+
|**500** | Erreur serveur interne | - |
|
|
430
|
+
|
|
431
|
+
[[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)
|
|
432
|
+
|
|
433
|
+
# **getProfilePicture**
|
|
434
|
+
> ProfilePictureResponse getProfilePicture()
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
### Example
|
|
438
|
+
|
|
439
|
+
```typescript
|
|
440
|
+
import {
|
|
441
|
+
UserProfileApi,
|
|
442
|
+
Configuration
|
|
443
|
+
} from '@tennac-booking/sdk';
|
|
444
|
+
|
|
445
|
+
const configuration = new Configuration();
|
|
446
|
+
const apiInstance = new UserProfileApi(configuration);
|
|
447
|
+
|
|
448
|
+
const { status, data } = await apiInstance.getProfilePicture();
|
|
449
|
+
```
|
|
450
|
+
|
|
451
|
+
### Parameters
|
|
452
|
+
This endpoint does not have any parameters.
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
### Return type
|
|
456
|
+
|
|
457
|
+
**ProfilePictureResponse**
|
|
458
|
+
|
|
459
|
+
### Authorization
|
|
460
|
+
|
|
461
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
462
|
+
|
|
463
|
+
### HTTP request headers
|
|
464
|
+
|
|
465
|
+
- **Content-Type**: Not defined
|
|
466
|
+
- **Accept**: application/json
|
|
467
|
+
|
|
468
|
+
|
|
469
|
+
### HTTP response details
|
|
470
|
+
| Status code | Description | Response headers |
|
|
471
|
+
|-------------|-------------|------------------|
|
|
472
|
+
|**200** | URL de la photo de profil | - |
|
|
473
|
+
|**401** | Non autorisé | - |
|
|
474
|
+
|**404** | Ressource non trouvée | - |
|
|
475
|
+
|**500** | Erreur serveur interne | - |
|
|
476
|
+
|
|
477
|
+
[[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)
|
|
478
|
+
|
|
479
|
+
# **getPublicUserProfile**
|
|
480
|
+
> PublicClubUser getPublicUserProfile()
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
### Example
|
|
484
|
+
|
|
485
|
+
```typescript
|
|
486
|
+
import {
|
|
487
|
+
UserProfileApi,
|
|
488
|
+
Configuration
|
|
489
|
+
} from '@tennac-booking/sdk';
|
|
490
|
+
|
|
491
|
+
const configuration = new Configuration();
|
|
492
|
+
const apiInstance = new UserProfileApi(configuration);
|
|
493
|
+
|
|
494
|
+
let id: string; //ID de l\'utilisateur (default to undefined)
|
|
495
|
+
|
|
496
|
+
const { status, data } = await apiInstance.getPublicUserProfile(
|
|
497
|
+
id
|
|
498
|
+
);
|
|
499
|
+
```
|
|
500
|
+
|
|
501
|
+
### Parameters
|
|
502
|
+
|
|
503
|
+
|Name | Type | Description | Notes|
|
|
504
|
+
|------------- | ------------- | ------------- | -------------|
|
|
505
|
+
| **id** | [**string**] | ID de l\'utilisateur | defaults to undefined|
|
|
506
|
+
|
|
507
|
+
|
|
508
|
+
### Return type
|
|
509
|
+
|
|
510
|
+
**PublicClubUser**
|
|
511
|
+
|
|
512
|
+
### Authorization
|
|
513
|
+
|
|
514
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
515
|
+
|
|
516
|
+
### HTTP request headers
|
|
517
|
+
|
|
518
|
+
- **Content-Type**: Not defined
|
|
519
|
+
- **Accept**: application/json
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
### HTTP response details
|
|
523
|
+
| Status code | Description | Response headers |
|
|
524
|
+
|-------------|-------------|------------------|
|
|
525
|
+
|**200** | Profil public de l\'utilisateur | - |
|
|
526
|
+
|**401** | Non autorisé | - |
|
|
527
|
+
|**500** | Erreur serveur interne | - |
|
|
528
|
+
|
|
529
|
+
[[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)
|
|
530
|
+
|
|
531
|
+
# **getUserBookings**
|
|
532
|
+
> UserBookingsResponse getUserBookings()
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
### Example
|
|
536
|
+
|
|
537
|
+
```typescript
|
|
538
|
+
import {
|
|
539
|
+
UserProfileApi,
|
|
540
|
+
Configuration
|
|
541
|
+
} from '@tennac-booking/sdk';
|
|
542
|
+
|
|
543
|
+
const configuration = new Configuration();
|
|
544
|
+
const apiInstance = new UserProfileApi(configuration);
|
|
545
|
+
|
|
546
|
+
let limit: number; //Nombre maximum de réservations à retourner (optional) (default to 20)
|
|
547
|
+
let skip: number; //Nombre de réservations à ignorer (pagination) (optional) (default to 0)
|
|
548
|
+
|
|
549
|
+
const { status, data } = await apiInstance.getUserBookings(
|
|
550
|
+
limit,
|
|
551
|
+
skip
|
|
552
|
+
);
|
|
553
|
+
```
|
|
554
|
+
|
|
555
|
+
### Parameters
|
|
556
|
+
|
|
557
|
+
|Name | Type | Description | Notes|
|
|
558
|
+
|------------- | ------------- | ------------- | -------------|
|
|
559
|
+
| **limit** | [**number**] | Nombre maximum de réservations à retourner | (optional) defaults to 20|
|
|
560
|
+
| **skip** | [**number**] | Nombre de réservations à ignorer (pagination) | (optional) defaults to 0|
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
### Return type
|
|
564
|
+
|
|
565
|
+
**UserBookingsResponse**
|
|
566
|
+
|
|
567
|
+
### Authorization
|
|
568
|
+
|
|
569
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
570
|
+
|
|
571
|
+
### HTTP request headers
|
|
572
|
+
|
|
573
|
+
- **Content-Type**: Not defined
|
|
574
|
+
- **Accept**: application/json
|
|
575
|
+
|
|
576
|
+
|
|
577
|
+
### HTTP response details
|
|
578
|
+
| Status code | Description | Response headers |
|
|
579
|
+
|-------------|-------------|------------------|
|
|
580
|
+
|**200** | Réservations de l\'utilisateur | - |
|
|
581
|
+
|**401** | Non autorisé | - |
|
|
582
|
+
|**500** | Erreur serveur interne | - |
|
|
583
|
+
|
|
584
|
+
[[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)
|
|
585
|
+
|
|
586
|
+
# **getUserCity**
|
|
587
|
+
> UserCityResponse getUserCity()
|
|
588
|
+
|
|
589
|
+
|
|
590
|
+
### Example
|
|
591
|
+
|
|
592
|
+
```typescript
|
|
593
|
+
import {
|
|
594
|
+
UserProfileApi,
|
|
595
|
+
Configuration
|
|
596
|
+
} from '@tennac-booking/sdk';
|
|
597
|
+
|
|
598
|
+
const configuration = new Configuration();
|
|
599
|
+
const apiInstance = new UserProfileApi(configuration);
|
|
600
|
+
|
|
601
|
+
const { status, data } = await apiInstance.getUserCity();
|
|
602
|
+
```
|
|
603
|
+
|
|
604
|
+
### Parameters
|
|
605
|
+
This endpoint does not have any parameters.
|
|
606
|
+
|
|
607
|
+
|
|
608
|
+
### Return type
|
|
609
|
+
|
|
610
|
+
**UserCityResponse**
|
|
611
|
+
|
|
612
|
+
### Authorization
|
|
613
|
+
|
|
614
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
615
|
+
|
|
616
|
+
### HTTP request headers
|
|
617
|
+
|
|
618
|
+
- **Content-Type**: Not defined
|
|
619
|
+
- **Accept**: application/json
|
|
620
|
+
|
|
621
|
+
|
|
622
|
+
### HTTP response details
|
|
623
|
+
| Status code | Description | Response headers |
|
|
624
|
+
|-------------|-------------|------------------|
|
|
625
|
+
|**200** | Ville de l\'utilisateur | - |
|
|
626
|
+
|**401** | Non autorisé | - |
|
|
627
|
+
|**404** | Ressource non trouvée | - |
|
|
628
|
+
|**500** | Erreur serveur interne | - |
|
|
629
|
+
|
|
630
|
+
[[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)
|
|
631
|
+
|
|
632
|
+
# **getUserDescription**
|
|
633
|
+
> UserDescriptionResponse getUserDescription()
|
|
634
|
+
|
|
635
|
+
|
|
636
|
+
### Example
|
|
637
|
+
|
|
638
|
+
```typescript
|
|
639
|
+
import {
|
|
640
|
+
UserProfileApi,
|
|
641
|
+
Configuration
|
|
642
|
+
} from '@tennac-booking/sdk';
|
|
643
|
+
|
|
644
|
+
const configuration = new Configuration();
|
|
645
|
+
const apiInstance = new UserProfileApi(configuration);
|
|
646
|
+
|
|
647
|
+
const { status, data } = await apiInstance.getUserDescription();
|
|
648
|
+
```
|
|
649
|
+
|
|
650
|
+
### Parameters
|
|
651
|
+
This endpoint does not have any parameters.
|
|
652
|
+
|
|
653
|
+
|
|
654
|
+
### Return type
|
|
655
|
+
|
|
656
|
+
**UserDescriptionResponse**
|
|
657
|
+
|
|
658
|
+
### Authorization
|
|
659
|
+
|
|
660
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
661
|
+
|
|
662
|
+
### HTTP request headers
|
|
663
|
+
|
|
664
|
+
- **Content-Type**: Not defined
|
|
665
|
+
- **Accept**: application/json
|
|
666
|
+
|
|
667
|
+
|
|
668
|
+
### HTTP response details
|
|
669
|
+
| Status code | Description | Response headers |
|
|
670
|
+
|-------------|-------------|------------------|
|
|
671
|
+
|**200** | Description de l\'utilisateur | - |
|
|
672
|
+
|**401** | Non autorisé | - |
|
|
673
|
+
|**404** | Ressource non trouvée | - |
|
|
674
|
+
|**500** | Erreur serveur interne | - |
|
|
675
|
+
|
|
676
|
+
[[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)
|
|
677
|
+
|
|
678
|
+
# **getUserInfo**
|
|
679
|
+
> UserResponse getUserInfo()
|
|
680
|
+
|
|
681
|
+
|
|
682
|
+
### Example
|
|
683
|
+
|
|
684
|
+
```typescript
|
|
685
|
+
import {
|
|
686
|
+
UserProfileApi,
|
|
687
|
+
Configuration
|
|
688
|
+
} from '@tennac-booking/sdk';
|
|
689
|
+
|
|
690
|
+
const configuration = new Configuration();
|
|
691
|
+
const apiInstance = new UserProfileApi(configuration);
|
|
692
|
+
|
|
693
|
+
const { status, data } = await apiInstance.getUserInfo();
|
|
694
|
+
```
|
|
695
|
+
|
|
696
|
+
### Parameters
|
|
697
|
+
This endpoint does not have any parameters.
|
|
698
|
+
|
|
699
|
+
|
|
700
|
+
### Return type
|
|
701
|
+
|
|
702
|
+
**UserResponse**
|
|
703
|
+
|
|
704
|
+
### Authorization
|
|
705
|
+
|
|
706
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
707
|
+
|
|
708
|
+
### HTTP request headers
|
|
709
|
+
|
|
710
|
+
- **Content-Type**: Not defined
|
|
711
|
+
- **Accept**: application/json
|
|
712
|
+
|
|
713
|
+
|
|
714
|
+
### HTTP response details
|
|
715
|
+
| Status code | Description | Response headers |
|
|
716
|
+
|-------------|-------------|------------------|
|
|
717
|
+
|**200** | Informations de l\'utilisateur | - |
|
|
718
|
+
|**401** | Non autorisé | - |
|
|
719
|
+
|**404** | Ressource non trouvée | - |
|
|
720
|
+
|**500** | Erreur serveur interne | - |
|
|
721
|
+
|
|
722
|
+
[[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)
|
|
723
|
+
|
|
724
|
+
# **getUserProfileVisibility**
|
|
725
|
+
> ProfileVisibilityResponse getUserProfileVisibility()
|
|
726
|
+
|
|
727
|
+
|
|
728
|
+
### Example
|
|
729
|
+
|
|
730
|
+
```typescript
|
|
731
|
+
import {
|
|
732
|
+
UserProfileApi,
|
|
733
|
+
Configuration
|
|
734
|
+
} from '@tennac-booking/sdk';
|
|
735
|
+
|
|
736
|
+
const configuration = new Configuration();
|
|
737
|
+
const apiInstance = new UserProfileApi(configuration);
|
|
738
|
+
|
|
739
|
+
const { status, data } = await apiInstance.getUserProfileVisibility();
|
|
740
|
+
```
|
|
741
|
+
|
|
742
|
+
### Parameters
|
|
743
|
+
This endpoint does not have any parameters.
|
|
744
|
+
|
|
745
|
+
|
|
746
|
+
### Return type
|
|
747
|
+
|
|
748
|
+
**ProfileVisibilityResponse**
|
|
749
|
+
|
|
750
|
+
### Authorization
|
|
751
|
+
|
|
752
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
753
|
+
|
|
754
|
+
### HTTP request headers
|
|
755
|
+
|
|
756
|
+
- **Content-Type**: Not defined
|
|
757
|
+
- **Accept**: application/json
|
|
758
|
+
|
|
759
|
+
|
|
760
|
+
### HTTP response details
|
|
761
|
+
| Status code | Description | Response headers |
|
|
762
|
+
|-------------|-------------|------------------|
|
|
763
|
+
|**200** | Visibilité du profil de l\'utilisateur | - |
|
|
764
|
+
|**401** | Non autorisé | - |
|
|
765
|
+
|**404** | Ressource non trouvée | - |
|
|
766
|
+
|**500** | Erreur serveur interne | - |
|
|
767
|
+
|
|
768
|
+
[[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)
|
|
769
|
+
|
|
770
|
+
# **removeFavoriteClub**
|
|
771
|
+
> FavoriteClubResponse removeFavoriteClub()
|
|
772
|
+
|
|
773
|
+
|
|
774
|
+
### Example
|
|
775
|
+
|
|
776
|
+
```typescript
|
|
777
|
+
import {
|
|
778
|
+
UserProfileApi,
|
|
779
|
+
Configuration
|
|
780
|
+
} from '@tennac-booking/sdk';
|
|
781
|
+
|
|
782
|
+
const configuration = new Configuration();
|
|
783
|
+
const apiInstance = new UserProfileApi(configuration);
|
|
784
|
+
|
|
785
|
+
let clubId: string; //ID of the club to remove from favorites (default to undefined)
|
|
786
|
+
|
|
787
|
+
const { status, data } = await apiInstance.removeFavoriteClub(
|
|
788
|
+
clubId
|
|
789
|
+
);
|
|
790
|
+
```
|
|
791
|
+
|
|
792
|
+
### Parameters
|
|
793
|
+
|
|
794
|
+
|Name | Type | Description | Notes|
|
|
795
|
+
|------------- | ------------- | ------------- | -------------|
|
|
796
|
+
| **clubId** | [**string**] | ID of the club to remove from favorites | defaults to undefined|
|
|
797
|
+
|
|
798
|
+
|
|
799
|
+
### Return type
|
|
800
|
+
|
|
801
|
+
**FavoriteClubResponse**
|
|
802
|
+
|
|
803
|
+
### Authorization
|
|
804
|
+
|
|
805
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
806
|
+
|
|
807
|
+
### HTTP request headers
|
|
808
|
+
|
|
809
|
+
- **Content-Type**: Not defined
|
|
810
|
+
- **Accept**: application/json
|
|
811
|
+
|
|
812
|
+
|
|
813
|
+
### HTTP response details
|
|
814
|
+
| Status code | Description | Response headers |
|
|
815
|
+
|-------------|-------------|------------------|
|
|
816
|
+
|**200** | Club removed from favorites | - |
|
|
817
|
+
|**400** | Requête invalide | - |
|
|
818
|
+
|**401** | Non autorisé | - |
|
|
819
|
+
|**500** | Erreur serveur interne | - |
|
|
820
|
+
|
|
821
|
+
[[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)
|
|
822
|
+
|
|
823
|
+
# **removeFavoritePlayer**
|
|
824
|
+
> FavoritePlayersIdsResponse removeFavoritePlayer()
|
|
825
|
+
|
|
826
|
+
|
|
827
|
+
### Example
|
|
828
|
+
|
|
829
|
+
```typescript
|
|
830
|
+
import {
|
|
831
|
+
UserProfileApi,
|
|
832
|
+
Configuration
|
|
833
|
+
} from '@tennac-booking/sdk';
|
|
834
|
+
|
|
835
|
+
const configuration = new Configuration();
|
|
836
|
+
const apiInstance = new UserProfileApi(configuration);
|
|
837
|
+
|
|
838
|
+
let favoritePlayerId: string; //ID du joueur à retirer des favoris (default to undefined)
|
|
839
|
+
|
|
840
|
+
const { status, data } = await apiInstance.removeFavoritePlayer(
|
|
841
|
+
favoritePlayerId
|
|
842
|
+
);
|
|
843
|
+
```
|
|
844
|
+
|
|
845
|
+
### Parameters
|
|
846
|
+
|
|
847
|
+
|Name | Type | Description | Notes|
|
|
848
|
+
|------------- | ------------- | ------------- | -------------|
|
|
849
|
+
| **favoritePlayerId** | [**string**] | ID du joueur à retirer des favoris | defaults to undefined|
|
|
850
|
+
|
|
851
|
+
|
|
852
|
+
### Return type
|
|
853
|
+
|
|
854
|
+
**FavoritePlayersIdsResponse**
|
|
855
|
+
|
|
856
|
+
### Authorization
|
|
857
|
+
|
|
858
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
859
|
+
|
|
860
|
+
### HTTP request headers
|
|
861
|
+
|
|
862
|
+
- **Content-Type**: Not defined
|
|
863
|
+
- **Accept**: application/json
|
|
864
|
+
|
|
865
|
+
|
|
866
|
+
### HTTP response details
|
|
867
|
+
| Status code | Description | Response headers |
|
|
868
|
+
|-------------|-------------|------------------|
|
|
869
|
+
|**200** | Joueur retiré des favoris | - |
|
|
870
|
+
|**400** | Requête invalide | - |
|
|
871
|
+
|**401** | Non autorisé | - |
|
|
872
|
+
|**404** | Ressource non trouvée | - |
|
|
873
|
+
|**500** | Erreur serveur interne | - |
|
|
874
|
+
|
|
875
|
+
[[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)
|
|
876
|
+
|
|
877
|
+
# **updateLevelBySports**
|
|
878
|
+
> UserResponse updateLevelBySports(updateLevelBySportsRequestBody)
|
|
879
|
+
|
|
880
|
+
|
|
881
|
+
### Example
|
|
882
|
+
|
|
883
|
+
```typescript
|
|
884
|
+
import {
|
|
885
|
+
UserProfileApi,
|
|
886
|
+
Configuration,
|
|
887
|
+
UpdateLevelBySportsRequestBody
|
|
888
|
+
} from '@tennac-booking/sdk';
|
|
889
|
+
|
|
890
|
+
const configuration = new Configuration();
|
|
891
|
+
const apiInstance = new UserProfileApi(configuration);
|
|
892
|
+
|
|
893
|
+
let updateLevelBySportsRequestBody: UpdateLevelBySportsRequestBody; //
|
|
894
|
+
|
|
895
|
+
const { status, data } = await apiInstance.updateLevelBySports(
|
|
896
|
+
updateLevelBySportsRequestBody
|
|
897
|
+
);
|
|
898
|
+
```
|
|
899
|
+
|
|
900
|
+
### Parameters
|
|
901
|
+
|
|
902
|
+
|Name | Type | Description | Notes|
|
|
903
|
+
|------------- | ------------- | ------------- | -------------|
|
|
904
|
+
| **updateLevelBySportsRequestBody** | **UpdateLevelBySportsRequestBody**| | |
|
|
905
|
+
|
|
906
|
+
|
|
907
|
+
### Return type
|
|
908
|
+
|
|
909
|
+
**UserResponse**
|
|
910
|
+
|
|
911
|
+
### Authorization
|
|
912
|
+
|
|
913
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
914
|
+
|
|
915
|
+
### HTTP request headers
|
|
916
|
+
|
|
917
|
+
- **Content-Type**: application/json
|
|
918
|
+
- **Accept**: application/json
|
|
919
|
+
|
|
920
|
+
|
|
921
|
+
### HTTP response details
|
|
922
|
+
| Status code | Description | Response headers |
|
|
923
|
+
|-------------|-------------|------------------|
|
|
924
|
+
|**200** | Utilisateur mis à jour | - |
|
|
925
|
+
|**400** | Requête invalide | - |
|
|
926
|
+
|**401** | Non autorisé | - |
|
|
927
|
+
|**500** | Erreur serveur interne | - |
|
|
928
|
+
|
|
929
|
+
[[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)
|
|
930
|
+
|
|
931
|
+
# **updateProfilePicture**
|
|
932
|
+
> ProfilePictureResponse updateProfilePicture(updateProfilePictureRequestBody)
|
|
933
|
+
|
|
934
|
+
|
|
935
|
+
### Example
|
|
936
|
+
|
|
937
|
+
```typescript
|
|
938
|
+
import {
|
|
939
|
+
UserProfileApi,
|
|
940
|
+
Configuration,
|
|
941
|
+
UpdateProfilePictureRequestBody
|
|
942
|
+
} from '@tennac-booking/sdk';
|
|
943
|
+
|
|
944
|
+
const configuration = new Configuration();
|
|
945
|
+
const apiInstance = new UserProfileApi(configuration);
|
|
946
|
+
|
|
947
|
+
let updateProfilePictureRequestBody: UpdateProfilePictureRequestBody; //
|
|
948
|
+
|
|
949
|
+
const { status, data } = await apiInstance.updateProfilePicture(
|
|
950
|
+
updateProfilePictureRequestBody
|
|
951
|
+
);
|
|
952
|
+
```
|
|
953
|
+
|
|
954
|
+
### Parameters
|
|
955
|
+
|
|
956
|
+
|Name | Type | Description | Notes|
|
|
957
|
+
|------------- | ------------- | ------------- | -------------|
|
|
958
|
+
| **updateProfilePictureRequestBody** | **UpdateProfilePictureRequestBody**| | |
|
|
959
|
+
|
|
960
|
+
|
|
961
|
+
### Return type
|
|
962
|
+
|
|
963
|
+
**ProfilePictureResponse**
|
|
964
|
+
|
|
965
|
+
### Authorization
|
|
966
|
+
|
|
967
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
968
|
+
|
|
969
|
+
### HTTP request headers
|
|
970
|
+
|
|
971
|
+
- **Content-Type**: application/json
|
|
972
|
+
- **Accept**: application/json
|
|
973
|
+
|
|
974
|
+
|
|
975
|
+
### HTTP response details
|
|
976
|
+
| Status code | Description | Response headers |
|
|
977
|
+
|-------------|-------------|------------------|
|
|
978
|
+
|**200** | Nouvelle URL de la photo de profil | - |
|
|
979
|
+
|**400** | Requête invalide | - |
|
|
980
|
+
|**401** | Non autorisé | - |
|
|
981
|
+
|**404** | Ressource non trouvée | - |
|
|
982
|
+
|**500** | Erreur serveur interne | - |
|
|
983
|
+
|
|
984
|
+
[[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)
|
|
985
|
+
|
|
986
|
+
# **updateProfileVisibility**
|
|
987
|
+
> UserResponse updateProfileVisibility(updateProfileVisibilityRequestBody)
|
|
988
|
+
|
|
989
|
+
|
|
990
|
+
### Example
|
|
991
|
+
|
|
992
|
+
```typescript
|
|
993
|
+
import {
|
|
994
|
+
UserProfileApi,
|
|
995
|
+
Configuration,
|
|
996
|
+
UpdateProfileVisibilityRequestBody
|
|
997
|
+
} from '@tennac-booking/sdk';
|
|
998
|
+
|
|
999
|
+
const configuration = new Configuration();
|
|
1000
|
+
const apiInstance = new UserProfileApi(configuration);
|
|
1001
|
+
|
|
1002
|
+
let updateProfileVisibilityRequestBody: UpdateProfileVisibilityRequestBody; //
|
|
1003
|
+
|
|
1004
|
+
const { status, data } = await apiInstance.updateProfileVisibility(
|
|
1005
|
+
updateProfileVisibilityRequestBody
|
|
1006
|
+
);
|
|
1007
|
+
```
|
|
1008
|
+
|
|
1009
|
+
### Parameters
|
|
1010
|
+
|
|
1011
|
+
|Name | Type | Description | Notes|
|
|
1012
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1013
|
+
| **updateProfileVisibilityRequestBody** | **UpdateProfileVisibilityRequestBody**| | |
|
|
1014
|
+
|
|
1015
|
+
|
|
1016
|
+
### Return type
|
|
1017
|
+
|
|
1018
|
+
**UserResponse**
|
|
1019
|
+
|
|
1020
|
+
### Authorization
|
|
1021
|
+
|
|
1022
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1023
|
+
|
|
1024
|
+
### HTTP request headers
|
|
1025
|
+
|
|
1026
|
+
- **Content-Type**: application/json
|
|
1027
|
+
- **Accept**: application/json
|
|
1028
|
+
|
|
1029
|
+
|
|
1030
|
+
### HTTP response details
|
|
1031
|
+
| Status code | Description | Response headers |
|
|
1032
|
+
|-------------|-------------|------------------|
|
|
1033
|
+
|**200** | Visibilité du profil mise à jour | - |
|
|
1034
|
+
|**400** | Requête invalide | - |
|
|
1035
|
+
|**401** | Non autorisé | - |
|
|
1036
|
+
|**500** | Erreur serveur interne | - |
|
|
1037
|
+
|
|
1038
|
+
[[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)
|
|
1039
|
+
|
|
1040
|
+
# **updateUser**
|
|
1041
|
+
> UserResponse updateUser(updateUserRequestBody)
|
|
1042
|
+
|
|
1043
|
+
|
|
1044
|
+
### Example
|
|
1045
|
+
|
|
1046
|
+
```typescript
|
|
1047
|
+
import {
|
|
1048
|
+
UserProfileApi,
|
|
1049
|
+
Configuration,
|
|
1050
|
+
UpdateUserRequestBody
|
|
1051
|
+
} from '@tennac-booking/sdk';
|
|
1052
|
+
|
|
1053
|
+
const configuration = new Configuration();
|
|
1054
|
+
const apiInstance = new UserProfileApi(configuration);
|
|
1055
|
+
|
|
1056
|
+
let updateUserRequestBody: UpdateUserRequestBody; //
|
|
1057
|
+
|
|
1058
|
+
const { status, data } = await apiInstance.updateUser(
|
|
1059
|
+
updateUserRequestBody
|
|
1060
|
+
);
|
|
1061
|
+
```
|
|
1062
|
+
|
|
1063
|
+
### Parameters
|
|
1064
|
+
|
|
1065
|
+
|Name | Type | Description | Notes|
|
|
1066
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1067
|
+
| **updateUserRequestBody** | **UpdateUserRequestBody**| | |
|
|
1068
|
+
|
|
1069
|
+
|
|
1070
|
+
### Return type
|
|
1071
|
+
|
|
1072
|
+
**UserResponse**
|
|
1073
|
+
|
|
1074
|
+
### Authorization
|
|
1075
|
+
|
|
1076
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1077
|
+
|
|
1078
|
+
### HTTP request headers
|
|
1079
|
+
|
|
1080
|
+
- **Content-Type**: application/json
|
|
1081
|
+
- **Accept**: application/json
|
|
1082
|
+
|
|
1083
|
+
|
|
1084
|
+
### HTTP response details
|
|
1085
|
+
| Status code | Description | Response headers |
|
|
1086
|
+
|-------------|-------------|------------------|
|
|
1087
|
+
|**200** | Utilisateur mis à jour | - |
|
|
1088
|
+
|**400** | Requête invalide | - |
|
|
1089
|
+
|**401** | Non autorisé | - |
|
|
1090
|
+
|**500** | Erreur serveur interne | - |
|
|
1091
|
+
|
|
1092
|
+
[[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)
|
|
1093
|
+
|
|
1094
|
+
# **updateUserCity**
|
|
1095
|
+
> UserResponse updateUserCity(updateUserCityRequestBody)
|
|
1096
|
+
|
|
1097
|
+
|
|
1098
|
+
### Example
|
|
1099
|
+
|
|
1100
|
+
```typescript
|
|
1101
|
+
import {
|
|
1102
|
+
UserProfileApi,
|
|
1103
|
+
Configuration,
|
|
1104
|
+
UpdateUserCityRequestBody
|
|
1105
|
+
} from '@tennac-booking/sdk';
|
|
1106
|
+
|
|
1107
|
+
const configuration = new Configuration();
|
|
1108
|
+
const apiInstance = new UserProfileApi(configuration);
|
|
1109
|
+
|
|
1110
|
+
let updateUserCityRequestBody: UpdateUserCityRequestBody; //
|
|
1111
|
+
|
|
1112
|
+
const { status, data } = await apiInstance.updateUserCity(
|
|
1113
|
+
updateUserCityRequestBody
|
|
1114
|
+
);
|
|
1115
|
+
```
|
|
1116
|
+
|
|
1117
|
+
### Parameters
|
|
1118
|
+
|
|
1119
|
+
|Name | Type | Description | Notes|
|
|
1120
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1121
|
+
| **updateUserCityRequestBody** | **UpdateUserCityRequestBody**| | |
|
|
1122
|
+
|
|
1123
|
+
|
|
1124
|
+
### Return type
|
|
1125
|
+
|
|
1126
|
+
**UserResponse**
|
|
1127
|
+
|
|
1128
|
+
### Authorization
|
|
1129
|
+
|
|
1130
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1131
|
+
|
|
1132
|
+
### HTTP request headers
|
|
1133
|
+
|
|
1134
|
+
- **Content-Type**: application/json
|
|
1135
|
+
- **Accept**: application/json
|
|
1136
|
+
|
|
1137
|
+
|
|
1138
|
+
### HTTP response details
|
|
1139
|
+
| Status code | Description | Response headers |
|
|
1140
|
+
|-------------|-------------|------------------|
|
|
1141
|
+
|**200** | Ville mise à jour | - |
|
|
1142
|
+
|**400** | Requête invalide | - |
|
|
1143
|
+
|**401** | Non autorisé | - |
|
|
1144
|
+
|**500** | Erreur serveur interne | - |
|
|
1145
|
+
|
|
1146
|
+
[[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)
|
|
1147
|
+
|
|
1148
|
+
# **updateUserDescription**
|
|
1149
|
+
> UserResponse updateUserDescription(updateUserDescriptionRequestBody)
|
|
1150
|
+
|
|
1151
|
+
|
|
1152
|
+
### Example
|
|
1153
|
+
|
|
1154
|
+
```typescript
|
|
1155
|
+
import {
|
|
1156
|
+
UserProfileApi,
|
|
1157
|
+
Configuration,
|
|
1158
|
+
UpdateUserDescriptionRequestBody
|
|
1159
|
+
} from '@tennac-booking/sdk';
|
|
1160
|
+
|
|
1161
|
+
const configuration = new Configuration();
|
|
1162
|
+
const apiInstance = new UserProfileApi(configuration);
|
|
1163
|
+
|
|
1164
|
+
let updateUserDescriptionRequestBody: UpdateUserDescriptionRequestBody; //
|
|
1165
|
+
|
|
1166
|
+
const { status, data } = await apiInstance.updateUserDescription(
|
|
1167
|
+
updateUserDescriptionRequestBody
|
|
1168
|
+
);
|
|
1169
|
+
```
|
|
1170
|
+
|
|
1171
|
+
### Parameters
|
|
1172
|
+
|
|
1173
|
+
|Name | Type | Description | Notes|
|
|
1174
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1175
|
+
| **updateUserDescriptionRequestBody** | **UpdateUserDescriptionRequestBody**| | |
|
|
1176
|
+
|
|
1177
|
+
|
|
1178
|
+
### Return type
|
|
1179
|
+
|
|
1180
|
+
**UserResponse**
|
|
1181
|
+
|
|
1182
|
+
### Authorization
|
|
1183
|
+
|
|
1184
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1185
|
+
|
|
1186
|
+
### HTTP request headers
|
|
1187
|
+
|
|
1188
|
+
- **Content-Type**: application/json
|
|
1189
|
+
- **Accept**: application/json
|
|
1190
|
+
|
|
1191
|
+
|
|
1192
|
+
### HTTP response details
|
|
1193
|
+
| Status code | Description | Response headers |
|
|
1194
|
+
|-------------|-------------|------------------|
|
|
1195
|
+
|**200** | Description mise à jour | - |
|
|
1196
|
+
|**400** | Requête invalide | - |
|
|
1197
|
+
|**401** | Non autorisé | - |
|
|
1198
|
+
|**500** | Erreur serveur interne | - |
|
|
1199
|
+
|
|
1200
|
+
[[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)
|
|
1201
|
+
|