@tennac-booking/sdk 1.0.105 → 1.0.106
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 +5 -1
- package/README.md +6 -1
- package/api.ts +295 -116
- package/dist/api.d.ts +259 -117
- package/dist/api.js +62 -0
- package/dist/esm/api.d.ts +259 -117
- package/dist/esm/api.js +62 -0
- package/docs/ClubEvent.md +26 -0
- package/docs/{PartialClubResponse.md → ClubPageResponse.md} +10 -27
- package/docs/ClubPresentation.md +26 -0
- package/docs/ClubResponse.md +0 -6
- package/docs/ClubsApi.md +56 -2
- package/docs/PartialClubActiveResponse.md +39 -0
- package/docs/PartialClubActiveResponseLocation.md +28 -0
- package/package.json +1 -1
|
@@ -1,42 +1,33 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ClubPageResponse
|
|
2
2
|
|
|
3
|
-
Make all properties in T optional
|
|
4
3
|
|
|
5
4
|
## Properties
|
|
6
5
|
|
|
7
6
|
Name | Type | Description | Notes
|
|
8
7
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **string** | ID unique du club | [
|
|
10
|
-
**name** | **string** | Nom du club | [
|
|
8
|
+
**id** | **string** | ID unique du club | [default to undefined]
|
|
9
|
+
**name** | **string** | Nom du club | [default to undefined]
|
|
11
10
|
**websiteUrl** | **string** | URL du site web du club | [optional] [default to undefined]
|
|
12
11
|
**description** | **string** | Description du club | [optional] [default to undefined]
|
|
13
12
|
**email** | **string** | Email du club | [optional] [default to undefined]
|
|
14
13
|
**phone** | **string** | Téléphone du club | [optional] [default to undefined]
|
|
15
14
|
**picture** | **string** | URL de l\'image du club | [optional] [default to undefined]
|
|
16
|
-
**bannerPictures** | **Array<string>** | | [optional] [default to undefined]
|
|
17
|
-
**galleryPictures** | **Array<string>** | | [optional] [default to undefined]
|
|
18
|
-
**tags** | **Array<string>** | | [optional] [default to undefined]
|
|
19
15
|
**location** | [**ClubResponseLocation**](ClubResponseLocation.md) | | [optional] [default to undefined]
|
|
20
|
-
**isActive** | **boolean** | Statut d\'activation du club | [
|
|
16
|
+
**isActive** | **boolean** | Statut d\'activation du club | [default to undefined]
|
|
21
17
|
**paymentFeature** | **boolean** | Indique si le club utilise la fonctionnalité de paiement | [optional] [default to undefined]
|
|
22
|
-
**stripeAccountId** | **string** | ID du compte Stripe du club | [optional] [default to undefined]
|
|
23
|
-
**clubDashBoardUrl** | **string** | URL du dashboard Stripe du club | [optional] [default to undefined]
|
|
24
18
|
**isNoShowEnabled** | **boolean** | Indique si la fonctionnalité \"no show\" est activée | [optional] [default to undefined]
|
|
25
19
|
**sports** | **Array<string>** | Liste des sports proposés par le club (identifiés par leur clé) | [optional] [default to undefined]
|
|
26
|
-
**
|
|
27
|
-
**
|
|
28
|
-
**maxSlotsPerBooking** | **number** | | [optional] [default to undefined]
|
|
29
|
-
**cancellationLimitHours** | **number** | Limite d\'annulation en heures | [optional] [default to undefined]
|
|
30
|
-
**maxWeeklyBookings** | **number** | Nombre maximum de réservations par semaine | [optional] [default to undefined]
|
|
20
|
+
**clubPresentation** | [**ClubPresentation**](ClubPresentation.md) | | [default to undefined]
|
|
21
|
+
**comingEvent** | [**Array<ClubEvent>**](ClubEvent.md) | | [default to undefined]
|
|
31
22
|
**createdAt** | [**ClubResponseCreatedAt**](ClubResponseCreatedAt.md) | | [optional] [default to undefined]
|
|
32
23
|
**updatedAt** | [**ClubResponseUpdatedAt**](ClubResponseUpdatedAt.md) | | [optional] [default to undefined]
|
|
33
24
|
|
|
34
25
|
## Example
|
|
35
26
|
|
|
36
27
|
```typescript
|
|
37
|
-
import {
|
|
28
|
+
import { ClubPageResponse } from '@tennac-booking/sdk';
|
|
38
29
|
|
|
39
|
-
const instance:
|
|
30
|
+
const instance: ClubPageResponse = {
|
|
40
31
|
id,
|
|
41
32
|
name,
|
|
42
33
|
websiteUrl,
|
|
@@ -44,21 +35,13 @@ const instance: PartialClubResponse = {
|
|
|
44
35
|
email,
|
|
45
36
|
phone,
|
|
46
37
|
picture,
|
|
47
|
-
bannerPictures,
|
|
48
|
-
galleryPictures,
|
|
49
|
-
tags,
|
|
50
38
|
location,
|
|
51
39
|
isActive,
|
|
52
40
|
paymentFeature,
|
|
53
|
-
stripeAccountId,
|
|
54
|
-
clubDashBoardUrl,
|
|
55
41
|
isNoShowEnabled,
|
|
56
42
|
sports,
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
maxSlotsPerBooking,
|
|
60
|
-
cancellationLimitHours,
|
|
61
|
-
maxWeeklyBookings,
|
|
43
|
+
clubPresentation,
|
|
44
|
+
comingEvent,
|
|
62
45
|
createdAt,
|
|
63
46
|
updatedAt,
|
|
64
47
|
};
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# ClubPresentation
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**bannerPictures** | **Array<string>** | | [optional] [default to undefined]
|
|
9
|
+
**galleryPictures** | **Array<string>** | | [optional] [default to undefined]
|
|
10
|
+
**tags** | **Array<string>** | | [optional] [default to undefined]
|
|
11
|
+
**description** | **string** | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { ClubPresentation } from '@tennac-booking/sdk';
|
|
17
|
+
|
|
18
|
+
const instance: ClubPresentation = {
|
|
19
|
+
bannerPictures,
|
|
20
|
+
galleryPictures,
|
|
21
|
+
tags,
|
|
22
|
+
description,
|
|
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)
|
package/docs/ClubResponse.md
CHANGED
|
@@ -12,9 +12,6 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**email** | **string** | Email du club | [optional] [default to undefined]
|
|
13
13
|
**phone** | **string** | Téléphone du club | [optional] [default to undefined]
|
|
14
14
|
**picture** | **string** | URL de l\'image du club | [optional] [default to undefined]
|
|
15
|
-
**bannerPictures** | **Array<string>** | | [optional] [default to undefined]
|
|
16
|
-
**galleryPictures** | **Array<string>** | | [optional] [default to undefined]
|
|
17
|
-
**tags** | **Array<string>** | | [optional] [default to undefined]
|
|
18
15
|
**location** | [**ClubResponseLocation**](ClubResponseLocation.md) | | [optional] [default to undefined]
|
|
19
16
|
**isActive** | **boolean** | Statut d\'activation du club | [default to undefined]
|
|
20
17
|
**paymentFeature** | **boolean** | Indique si le club utilise la fonctionnalité de paiement | [optional] [default to undefined]
|
|
@@ -43,9 +40,6 @@ const instance: ClubResponse = {
|
|
|
43
40
|
email,
|
|
44
41
|
phone,
|
|
45
42
|
picture,
|
|
46
|
-
bannerPictures,
|
|
47
|
-
galleryPictures,
|
|
48
|
-
tags,
|
|
49
43
|
location,
|
|
50
44
|
isActive,
|
|
51
45
|
paymentFeature,
|
package/docs/ClubsApi.md
CHANGED
|
@@ -10,6 +10,7 @@ All URIs are relative to *http://localhost*
|
|
|
10
10
|
|[**getAvailableSlotsBySports**](#getavailableslotsbysports) | **GET** /api/clubs/{id}/sports/{sportId}/slots | |
|
|
11
11
|
|[**getAvailableSlotsBySportsAndDay**](#getavailableslotsbysportsandday) | **GET** /api/clubs/{id}/sports/{sportId}/slots/{day} | |
|
|
12
12
|
|[**getClubInfo**](#getclubinfo) | **GET** /api/clubs/info | |
|
|
13
|
+
|[**getClubPageInfo**](#getclubpageinfo) | **GET** /api/clubs/club-page/{clubId} | |
|
|
13
14
|
|[**getClubUsersById**](#getclubusersbyid) | **GET** /api/clubs/{id}/users | |
|
|
14
15
|
|[**getClubsWithVerificationDomains**](#getclubswithverificationdomains) | **GET** /api/clubs/verification-domains | |
|
|
15
16
|
|[**getCourtsByClubAndSportById**](#getcourtsbyclubandsportbyid) | **GET** /api/clubs/{id}/sports/{sportId}/courts | |
|
|
@@ -18,7 +19,7 @@ All URIs are relative to *http://localhost*
|
|
|
18
19
|
|[**getSportsByClubById**](#getsportsbyclubbyid) | **GET** /api/clubs/{id}/sports | |
|
|
19
20
|
|
|
20
21
|
# **getActiveClubs**
|
|
21
|
-
> Array<
|
|
22
|
+
> Array<PartialClubActiveResponse> getActiveClubs()
|
|
22
23
|
|
|
23
24
|
Récupère la liste des clubs actifs publics Authentification optionnelle : si authentifié, retourne aussi les clubs vérifiés
|
|
24
25
|
|
|
@@ -42,7 +43,7 @@ This endpoint does not have any parameters.
|
|
|
42
43
|
|
|
43
44
|
### Return type
|
|
44
45
|
|
|
45
|
-
**Array<
|
|
46
|
+
**Array<PartialClubActiveResponse>**
|
|
46
47
|
|
|
47
48
|
### Authorization
|
|
48
49
|
|
|
@@ -312,6 +313,59 @@ This endpoint does not have any parameters.
|
|
|
312
313
|
|
|
313
314
|
[[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)
|
|
314
315
|
|
|
316
|
+
# **getClubPageInfo**
|
|
317
|
+
> ClubPageResponse getClubPageInfo()
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
### Example
|
|
321
|
+
|
|
322
|
+
```typescript
|
|
323
|
+
import {
|
|
324
|
+
ClubsApi,
|
|
325
|
+
Configuration
|
|
326
|
+
} from '@tennac-booking/sdk';
|
|
327
|
+
|
|
328
|
+
const configuration = new Configuration();
|
|
329
|
+
const apiInstance = new ClubsApi(configuration);
|
|
330
|
+
|
|
331
|
+
let clubId: string; // (default to undefined)
|
|
332
|
+
|
|
333
|
+
const { status, data } = await apiInstance.getClubPageInfo(
|
|
334
|
+
clubId
|
|
335
|
+
);
|
|
336
|
+
```
|
|
337
|
+
|
|
338
|
+
### Parameters
|
|
339
|
+
|
|
340
|
+
|Name | Type | Description | Notes|
|
|
341
|
+
|------------- | ------------- | ------------- | -------------|
|
|
342
|
+
| **clubId** | [**string**] | | defaults to undefined|
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
### Return type
|
|
346
|
+
|
|
347
|
+
**ClubPageResponse**
|
|
348
|
+
|
|
349
|
+
### Authorization
|
|
350
|
+
|
|
351
|
+
No authorization required
|
|
352
|
+
|
|
353
|
+
### HTTP request headers
|
|
354
|
+
|
|
355
|
+
- **Content-Type**: Not defined
|
|
356
|
+
- **Accept**: application/json
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
### HTTP response details
|
|
360
|
+
| Status code | Description | Response headers |
|
|
361
|
+
|-------------|-------------|------------------|
|
|
362
|
+
|**200** | Informations de la page club | - |
|
|
363
|
+
|**400** | Bad Request | - |
|
|
364
|
+
|**404** | Club non trouvé | - |
|
|
365
|
+
|**500** | Server Error | - |
|
|
366
|
+
|
|
367
|
+
[[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)
|
|
368
|
+
|
|
315
369
|
# **getClubUsersById**
|
|
316
370
|
> GetClubUsersById200Response getClubUsersById()
|
|
317
371
|
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# PartialClubActiveResponse
|
|
2
|
+
|
|
3
|
+
Make all properties in T optional
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**name** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**picture** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**paymentFeature** | **boolean** | | [optional] [default to undefined]
|
|
13
|
+
**isNoShowEnabled** | **boolean** | | [optional] [default to undefined]
|
|
14
|
+
**bannerPictures** | **Array<string>** | | [optional] [default to undefined]
|
|
15
|
+
**galleryPictures** | **Array<string>** | | [optional] [default to undefined]
|
|
16
|
+
**tags** | **Array<string>** | | [optional] [default to undefined]
|
|
17
|
+
**location** | [**PartialClubActiveResponseLocation**](PartialClubActiveResponseLocation.md) | | [optional] [default to undefined]
|
|
18
|
+
**sports** | **Array<string>** | Liste des sports disponibles (clé du sport) | [optional] [default to undefined]
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
import { PartialClubActiveResponse } from '@tennac-booking/sdk';
|
|
24
|
+
|
|
25
|
+
const instance: PartialClubActiveResponse = {
|
|
26
|
+
id,
|
|
27
|
+
name,
|
|
28
|
+
picture,
|
|
29
|
+
paymentFeature,
|
|
30
|
+
isNoShowEnabled,
|
|
31
|
+
bannerPictures,
|
|
32
|
+
galleryPictures,
|
|
33
|
+
tags,
|
|
34
|
+
location,
|
|
35
|
+
sports,
|
|
36
|
+
};
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# PartialClubActiveResponseLocation
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**coordinates** | [**ClubResponseLocationCoordinates**](ClubResponseLocationCoordinates.md) | | [optional] [default to undefined]
|
|
9
|
+
**country** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**zipCode** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**city** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**address** | **string** | | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { PartialClubActiveResponseLocation } from '@tennac-booking/sdk';
|
|
18
|
+
|
|
19
|
+
const instance: PartialClubActiveResponseLocation = {
|
|
20
|
+
coordinates,
|
|
21
|
+
country,
|
|
22
|
+
zipCode,
|
|
23
|
+
city,
|
|
24
|
+
address,
|
|
25
|
+
};
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|