@tennac-booking/sdk 1.0.45 → 1.0.46

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.
@@ -1,20 +0,0 @@
1
- # GoogleSignInRequestBody
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **googleToken** | **string** | | [default to undefined]
9
-
10
- ## Example
11
-
12
- ```typescript
13
- import { GoogleSignInRequestBody } from '@tennac-booking/sdk';
14
-
15
- const instance: GoogleSignInRequestBody = {
16
- googleToken,
17
- };
18
- ```
19
-
20
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,24 +0,0 @@
1
- # GoogleSignInResponse
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **token** | **string** | | [optional] [default to undefined]
9
- **refreshToken** | **string** | | [optional] [default to undefined]
10
- **user** | [**UserResponse**](UserResponse.md) | | [optional] [default to undefined]
11
-
12
- ## Example
13
-
14
- ```typescript
15
- import { GoogleSignInResponse } from '@tennac-booking/sdk';
16
-
17
- const instance: GoogleSignInResponse = {
18
- token,
19
- refreshToken,
20
- user,
21
- };
22
- ```
23
-
24
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,26 +0,0 @@
1
- # InitiateSubscriptionSessionRequestBody
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **clubId** | **string** | ID du club | [default to undefined]
9
- **priceId** | **string** | ID du prix d\'abonnement | [default to undefined]
10
- **successUrl** | **string** | URL de redirection en cas de succès | [optional] [default to undefined]
11
- **cancelUrl** | **string** | URL de redirection en cas d\'annulation | [optional] [default to undefined]
12
-
13
- ## Example
14
-
15
- ```typescript
16
- import { InitiateSubscriptionSessionRequestBody } from '@tennac-booking/sdk';
17
-
18
- const instance: InitiateSubscriptionSessionRequestBody = {
19
- clubId,
20
- priceId,
21
- successUrl,
22
- cancelUrl,
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)
@@ -1,22 +0,0 @@
1
- # InitiateSubscriptionSessionResponse
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **sessionId** | **string** | ID de la session Stripe | [optional] [default to undefined]
9
- **url** | **string** | URL de la session de paiement | [optional] [default to undefined]
10
-
11
- ## Example
12
-
13
- ```typescript
14
- import { InitiateSubscriptionSessionResponse } from '@tennac-booking/sdk';
15
-
16
- const instance: InitiateSubscriptionSessionResponse = {
17
- sessionId,
18
- url,
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)
@@ -1,20 +0,0 @@
1
- # ProfileVisibilityResponse
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **isProfileVisible** | **boolean** | | [optional] [default to undefined]
9
-
10
- ## Example
11
-
12
- ```typescript
13
- import { ProfileVisibilityResponse } from '@tennac-booking/sdk';
14
-
15
- const instance: ProfileVisibilityResponse = {
16
- isProfileVisible,
17
- };
18
- ```
19
-
20
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,110 +0,0 @@
1
- # StaffProfileApi
2
-
3
- All URIs are relative to */api*
4
-
5
- |Method | HTTP request | Description|
6
- |------------- | ------------- | -------------|
7
- |[**getUserProfileStaff**](#getuserprofilestaff) | **GET** /api/users/staff/profile/:id | Récupère le profil d\'un utilisateur par son ID (données staff uniquement)|
8
- |[**getUserRolesInClubs**](#getuserrolesinclubs) | **GET** /api/users/me/roles | Récupère les rôles de l\'utilisateur dans les clubs|
9
-
10
- # **getUserProfileStaff**
11
- > UserInfoStaff getUserProfileStaff()
12
-
13
-
14
- ### Example
15
-
16
- ```typescript
17
- import {
18
- StaffProfileApi,
19
- Configuration
20
- } from '@tennac-booking/sdk';
21
-
22
- const configuration = new Configuration();
23
- const apiInstance = new StaffProfileApi(configuration);
24
-
25
- let id: string; //ID de l\'utilisateur (default to undefined)
26
-
27
- const { status, data } = await apiInstance.getUserProfileStaff(
28
- id
29
- );
30
- ```
31
-
32
- ### Parameters
33
-
34
- |Name | Type | Description | Notes|
35
- |------------- | ------------- | ------------- | -------------|
36
- | **id** | [**string**] | ID de l\'utilisateur | defaults to undefined|
37
-
38
-
39
- ### Return type
40
-
41
- **UserInfoStaff**
42
-
43
- ### Authorization
44
-
45
- [bearerAuth](../README.md#bearerAuth)
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** | Profil utilisateur | - |
57
- |**400** | Requête invalide | - |
58
- |**401** | Non autorisé | - |
59
- |**403** | Accès interdit | - |
60
- |**404** | Ressource non trouvée | - |
61
- |**500** | Erreur serveur interne | - |
62
-
63
- [[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)
64
-
65
- # **getUserRolesInClubs**
66
- > GetUserRolesResponse getUserRolesInClubs()
67
-
68
-
69
- ### Example
70
-
71
- ```typescript
72
- import {
73
- StaffProfileApi,
74
- Configuration
75
- } from '@tennac-booking/sdk';
76
-
77
- const configuration = new Configuration();
78
- const apiInstance = new StaffProfileApi(configuration);
79
-
80
- const { status, data } = await apiInstance.getUserRolesInClubs();
81
- ```
82
-
83
- ### Parameters
84
- This endpoint does not have any parameters.
85
-
86
-
87
- ### Return type
88
-
89
- **GetUserRolesResponse**
90
-
91
- ### Authorization
92
-
93
- [bearerAuth](../README.md#bearerAuth)
94
-
95
- ### HTTP request headers
96
-
97
- - **Content-Type**: Not defined
98
- - **Accept**: application/json
99
-
100
-
101
- ### HTTP response details
102
- | Status code | Description | Response headers |
103
- |-------------|-------------|------------------|
104
- |**200** | Liste des rôles dans les clubs | - |
105
- |**400** | Requête invalide | - |
106
- |**401** | Non autorisé | - |
107
- |**500** | Erreur serveur interne | - |
108
-
109
- [[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)
110
-
package/docs/UserApi.md DELETED
@@ -1,63 +0,0 @@
1
- # UserApi
2
-
3
- All URIs are relative to */api*
4
-
5
- |Method | HTTP request | Description|
6
- |------------- | ------------- | -------------|
7
- |[**updateCustomer**](#updatecustomer) | **PUT** /api/users/me/customer | Met à jour le Customer Stripe de l\'utilisateur|
8
-
9
- # **updateCustomer**
10
- > UpdateCustomerResponse updateCustomer(updateCustomerRequestBody)
11
-
12
-
13
- ### Example
14
-
15
- ```typescript
16
- import {
17
- UserApi,
18
- Configuration,
19
- UpdateCustomerRequestBody
20
- } from '@tennac-booking/sdk';
21
-
22
- const configuration = new Configuration();
23
- const apiInstance = new UserApi(configuration);
24
-
25
- let updateCustomerRequestBody: UpdateCustomerRequestBody; //
26
-
27
- const { status, data } = await apiInstance.updateCustomer(
28
- updateCustomerRequestBody
29
- );
30
- ```
31
-
32
- ### Parameters
33
-
34
- |Name | Type | Description | Notes|
35
- |------------- | ------------- | ------------- | -------------|
36
- | **updateCustomerRequestBody** | **UpdateCustomerRequestBody**| | |
37
-
38
-
39
- ### Return type
40
-
41
- **UpdateCustomerResponse**
42
-
43
- ### Authorization
44
-
45
- [bearerAuth](../README.md#bearerAuth)
46
-
47
- ### HTTP request headers
48
-
49
- - **Content-Type**: application/json
50
- - **Accept**: application/json
51
-
52
-
53
- ### HTTP response details
54
- | Status code | Description | Response headers |
55
- |-------------|-------------|------------------|
56
- |**200** | Customer mis à jour | - |
57
- |**400** | Requête invalide | - |
58
- |**401** | Non autorisé | - |
59
- |**404** | Ressource non trouvée | - |
60
- |**500** | Erreur serveur interne | - |
61
-
62
- [[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)
63
-
@@ -1,226 +0,0 @@
1
- # UserAuthenticationApi
2
-
3
- All URIs are relative to */api*
4
-
5
- |Method | HTTP request | Description|
6
- |------------- | ------------- | -------------|
7
- |[**login**](#login) | **POST** /api/users/login | Authentifie un utilisateur|
8
- |[**refreshToken**](#refreshtoken) | **POST** /api/users/refresh-token | Rafraîchit le token d\'accès|
9
- |[**register**](#register) | **POST** /api/users | Crée un nouvel utilisateur|
10
- |[**signInOrSignUpWithGoogle**](#signinorsignupwithgoogle) | **POST** /api/users/googleSignin | Authentifie ou crée un utilisateur via Google OAuth|
11
-
12
- # **login**
13
- > LoginResponse login(loginRequestBody)
14
-
15
-
16
- ### Example
17
-
18
- ```typescript
19
- import {
20
- UserAuthenticationApi,
21
- Configuration,
22
- LoginRequestBody
23
- } from '@tennac-booking/sdk';
24
-
25
- const configuration = new Configuration();
26
- const apiInstance = new UserAuthenticationApi(configuration);
27
-
28
- let loginRequestBody: LoginRequestBody; //
29
-
30
- const { status, data } = await apiInstance.login(
31
- loginRequestBody
32
- );
33
- ```
34
-
35
- ### Parameters
36
-
37
- |Name | Type | Description | Notes|
38
- |------------- | ------------- | ------------- | -------------|
39
- | **loginRequestBody** | **LoginRequestBody**| | |
40
-
41
-
42
- ### Return type
43
-
44
- **LoginResponse**
45
-
46
- ### Authorization
47
-
48
- [bearerAuth](../README.md#bearerAuth)
49
-
50
- ### HTTP request headers
51
-
52
- - **Content-Type**: application/json
53
- - **Accept**: application/json
54
-
55
-
56
- ### HTTP response details
57
- | Status code | Description | Response headers |
58
- |-------------|-------------|------------------|
59
- |**200** | Authentification réussie | - |
60
- |**400** | Requête invalide | - |
61
- |**401** | Non autorisé | - |
62
- |**500** | Erreur serveur interne | - |
63
-
64
- [[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)
65
-
66
- # **refreshToken**
67
- > RefreshTokenResponse refreshToken(refreshTokenRequestBody)
68
-
69
-
70
- ### Example
71
-
72
- ```typescript
73
- import {
74
- UserAuthenticationApi,
75
- Configuration,
76
- RefreshTokenRequestBody
77
- } from '@tennac-booking/sdk';
78
-
79
- const configuration = new Configuration();
80
- const apiInstance = new UserAuthenticationApi(configuration);
81
-
82
- let refreshTokenRequestBody: RefreshTokenRequestBody; //
83
-
84
- const { status, data } = await apiInstance.refreshToken(
85
- refreshTokenRequestBody
86
- );
87
- ```
88
-
89
- ### Parameters
90
-
91
- |Name | Type | Description | Notes|
92
- |------------- | ------------- | ------------- | -------------|
93
- | **refreshTokenRequestBody** | **RefreshTokenRequestBody**| | |
94
-
95
-
96
- ### Return type
97
-
98
- **RefreshTokenResponse**
99
-
100
- ### Authorization
101
-
102
- [bearerAuth](../README.md#bearerAuth)
103
-
104
- ### HTTP request headers
105
-
106
- - **Content-Type**: application/json
107
- - **Accept**: application/json
108
-
109
-
110
- ### HTTP response details
111
- | Status code | Description | Response headers |
112
- |-------------|-------------|------------------|
113
- |**200** | Nouveaux tokens | - |
114
- |**400** | Requête invalide | - |
115
- |**401** | Non autorisé | - |
116
- |**500** | Erreur serveur interne | - |
117
-
118
- [[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)
119
-
120
- # **register**
121
- > UserResponse register(registerRequestBody)
122
-
123
-
124
- ### Example
125
-
126
- ```typescript
127
- import {
128
- UserAuthenticationApi,
129
- Configuration,
130
- RegisterRequestBody
131
- } from '@tennac-booking/sdk';
132
-
133
- const configuration = new Configuration();
134
- const apiInstance = new UserAuthenticationApi(configuration);
135
-
136
- let registerRequestBody: RegisterRequestBody; //
137
-
138
- const { status, data } = await apiInstance.register(
139
- registerRequestBody
140
- );
141
- ```
142
-
143
- ### Parameters
144
-
145
- |Name | Type | Description | Notes|
146
- |------------- | ------------- | ------------- | -------------|
147
- | **registerRequestBody** | **RegisterRequestBody**| | |
148
-
149
-
150
- ### Return type
151
-
152
- **UserResponse**
153
-
154
- ### Authorization
155
-
156
- [bearerAuth](../README.md#bearerAuth)
157
-
158
- ### HTTP request headers
159
-
160
- - **Content-Type**: application/json
161
- - **Accept**: application/json
162
-
163
-
164
- ### HTTP response details
165
- | Status code | Description | Response headers |
166
- |-------------|-------------|------------------|
167
- |**201** | Utilisateur créé | - |
168
- |**400** | Requête invalide | - |
169
- |**409** | Email déjà utilisé | - |
170
- |**500** | Erreur serveur interne | - |
171
-
172
- [[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)
173
-
174
- # **signInOrSignUpWithGoogle**
175
- > GoogleSignInResponse signInOrSignUpWithGoogle(googleSignInRequestBody)
176
-
177
-
178
- ### Example
179
-
180
- ```typescript
181
- import {
182
- UserAuthenticationApi,
183
- Configuration,
184
- GoogleSignInRequestBody
185
- } from '@tennac-booking/sdk';
186
-
187
- const configuration = new Configuration();
188
- const apiInstance = new UserAuthenticationApi(configuration);
189
-
190
- let googleSignInRequestBody: GoogleSignInRequestBody; //
191
-
192
- const { status, data } = await apiInstance.signInOrSignUpWithGoogle(
193
- googleSignInRequestBody
194
- );
195
- ```
196
-
197
- ### Parameters
198
-
199
- |Name | Type | Description | Notes|
200
- |------------- | ------------- | ------------- | -------------|
201
- | **googleSignInRequestBody** | **GoogleSignInRequestBody**| | |
202
-
203
-
204
- ### Return type
205
-
206
- **GoogleSignInResponse**
207
-
208
- ### Authorization
209
-
210
- [bearerAuth](../README.md#bearerAuth)
211
-
212
- ### HTTP request headers
213
-
214
- - **Content-Type**: application/json
215
- - **Accept**: application/json
216
-
217
-
218
- ### HTTP response details
219
- | Status code | Description | Response headers |
220
- |-------------|-------------|------------------|
221
- |**200** | Authentification Google réussie | - |
222
- |**400** | Requête invalide | - |
223
- |**500** | Erreur serveur interne | - |
224
-
225
- [[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)
226
-
@@ -1,26 +0,0 @@
1
- # UserBookingsResponse
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **bookings** | [**Array<Booking>**](Booking.md) | | [optional] [default to undefined]
9
- **total** | **number** | | [optional] [default to undefined]
10
- **limit** | **number** | | [optional] [default to undefined]
11
- **skip** | **number** | | [optional] [default to undefined]
12
-
13
- ## Example
14
-
15
- ```typescript
16
- import { UserBookingsResponse } from '@tennac-booking/sdk';
17
-
18
- const instance: UserBookingsResponse = {
19
- bookings,
20
- total,
21
- limit,
22
- skip,
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)
@@ -1,20 +0,0 @@
1
- # UserCityResponse
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **city** | **string** | | [optional] [default to undefined]
9
-
10
- ## Example
11
-
12
- ```typescript
13
- import { UserCityResponse } from '@tennac-booking/sdk';
14
-
15
- const instance: UserCityResponse = {
16
- city,
17
- };
18
- ```
19
-
20
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,20 +0,0 @@
1
- # UserDescriptionResponse
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **description** | **string** | | [optional] [default to undefined]
9
-
10
- ## Example
11
-
12
- ```typescript
13
- import { UserDescriptionResponse } from '@tennac-booking/sdk';
14
-
15
- const instance: UserDescriptionResponse = {
16
- description,
17
- };
18
- ```
19
-
20
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,20 +0,0 @@
1
- # UserFavoriteClubsResponse
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **favoriteClubs** | [**Array<FavoriteClubItem>**](FavoriteClubItem.md) | | [optional] [default to undefined]
9
-
10
- ## Example
11
-
12
- ```typescript
13
- import { UserFavoriteClubsResponse } from '@tennac-booking/sdk';
14
-
15
- const instance: UserFavoriteClubsResponse = {
16
- favoriteClubs,
17
- };
18
- ```
19
-
20
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)