@tennac-booking/sdk 1.0.13 → 1.0.14
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 +29 -5
- package/README.md +58 -49
- package/api.ts +3581 -3057
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +2134 -1695
- package/dist/api.js +2693 -2281
- 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 +2134 -1695
- package/dist/esm/api.js +2435 -2081
- 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/AdminClubSlotsApi.md +62 -0
- package/docs/AdminClubsApi.md +108 -0
- package/docs/ApiErrorResponse.md +1 -1
- package/docs/BookingsApi.md +4 -60
- package/docs/ChangePasswordResponse.md +1 -1
- package/docs/{ClubSportsApi.md → ClubAnalyticsApi.md} +20 -27
- package/docs/ClubBookingsApi.md +59 -0
- package/docs/ClubInfoResponse.md +6 -6
- package/docs/ClubResponse.md +6 -6
- package/docs/ClubRoleResponse.md +6 -6
- package/docs/ClubRolesApi.md +8 -8
- package/docs/ClubSettings.md +7 -1
- package/docs/ClubSlotsApi.md +0 -225
- package/docs/ClubsApi.md +6 -425
- package/docs/ClubsResponse.md +22 -0
- package/docs/CourtResponse.md +7 -7
- package/docs/CourtStatus.md +5 -2
- package/docs/CreateClubRequest.md +12 -10
- package/docs/CreateClubSettingsRequest.md +28 -0
- package/docs/CreateCourtRequest.md +2 -0
- package/docs/CreatePriceRequest.md +4 -4
- package/docs/CreateSportRequest.md +4 -0
- package/docs/CreateSubscriptionPlanRequest.md +3 -3
- package/docs/DeleteClubSettingsRequest.md +20 -0
- package/docs/{DeleteClub200Response.md → DeleteSlotsResponse.md} +3 -3
- package/docs/{GenerateSlotsForNextThreeWeeks201Response.md → DeleteSport200Response.md} +3 -3
- package/docs/GenerateSlotsResponse.md +20 -0
- package/docs/GetClubInfos200Response.md +30 -0
- package/docs/GetCourtsByClubAndSport200Response.md +26 -0
- package/docs/GetLastSixMonthsTurnover200ResponseInner.md +24 -0
- package/docs/GetNumberOfClubUsers200Response.md +20 -0
- package/docs/GetUserRolesResponseRolesInner.md +4 -6
- package/docs/GoogleSignInRequestBody.md +2 -2
- package/docs/GoogleSignInResponse.md +2 -8
- package/docs/{ClubCourtsApi.md → ManagerClubCourtsApi.md} +5 -5
- package/docs/ManagerClubSlotsApi.md +125 -0
- package/docs/ManagerClubsApi.md +280 -0
- package/docs/PriceResponse.md +2 -8
- package/docs/RefreshTokenResponse.md +2 -6
- package/docs/SlotResponse.md +2 -8
- package/docs/SportResponse.md +0 -2
- package/docs/SportsApi.md +10 -120
- package/docs/StaffClubSettingsApi.md +62 -0
- package/docs/StaffSportsApi.md +62 -0
- package/docs/SubscriptionPlanResponse.md +4 -8
- package/docs/UpdateClubSettingsRequest.md +28 -0
- package/docs/UpdateSportRequest.md +4 -0
- package/docs/UpdateSubscriptionPlanRequest.md +3 -3
- package/docs/UpdateSubscriptionPlanResponse.md +2 -2
- package/docs/{ClubSettingsApi.md → UserAuthenticationApi.md} +54 -55
- package/docs/UserBookingsApi.md +63 -0
- package/docs/UserClubCourtsApi.md +64 -0
- package/docs/UserClubSlotsApi.md +60 -0
- package/docs/UserClubSportsApi.md +60 -0
- package/docs/UserClubsApi.md +53 -0
- package/docs/UserProfileApi.md +271 -0
- package/docs/UserResponse.md +8 -14
- package/docs/UserSubscriptionsApi.md +222 -0
- package/docs/UsersApi.md +0 -725
- package/docs/UsersResponse.md +22 -0
- package/index.ts +1 -1
- package/package.json +32 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# DeleteSlotsResponse
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -10,9 +10,9 @@ Name | Type | Description | Notes
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
13
|
-
import {
|
|
13
|
+
import { DeleteSlotsResponse } from '@tennac-booking/sdk';
|
|
14
14
|
|
|
15
|
-
const instance:
|
|
15
|
+
const instance: DeleteSlotsResponse = {
|
|
16
16
|
message,
|
|
17
17
|
};
|
|
18
18
|
```
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# DeleteSport200Response
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -10,9 +10,9 @@ Name | Type | Description | Notes
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
13
|
-
import {
|
|
13
|
+
import { DeleteSport200Response } from '@tennac-booking/sdk';
|
|
14
14
|
|
|
15
|
-
const instance:
|
|
15
|
+
const instance: DeleteSport200Response = {
|
|
16
16
|
message,
|
|
17
17
|
};
|
|
18
18
|
```
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# GenerateSlotsResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**message** | **string** | | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { GenerateSlotsResponse } from '@tennac-booking/sdk';
|
|
14
|
+
|
|
15
|
+
const instance: GenerateSlotsResponse = {
|
|
16
|
+
message,
|
|
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)
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# GetClubInfos200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**name** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**address** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**email** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**phone** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**rib** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**websiteUrl** | **string** | | [optional] [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { GetClubInfos200Response } from '@tennac-booking/sdk';
|
|
19
|
+
|
|
20
|
+
const instance: GetClubInfos200Response = {
|
|
21
|
+
name,
|
|
22
|
+
address,
|
|
23
|
+
email,
|
|
24
|
+
phone,
|
|
25
|
+
rib,
|
|
26
|
+
websiteUrl,
|
|
27
|
+
};
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
[[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
|
+
# GetCourtsByClubAndSport200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**courts** | [**Array<CourtResponse>**](CourtResponse.md) | | [optional] [default to undefined]
|
|
9
|
+
**total** | **number** | Nombre total de terrains | [optional] [default to undefined]
|
|
10
|
+
**clubId** | **string** | ID du club | [optional] [default to undefined]
|
|
11
|
+
**sportId** | **string** | ID du sport | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { GetCourtsByClubAndSport200Response } from '@tennac-booking/sdk';
|
|
17
|
+
|
|
18
|
+
const instance: GetCourtsByClubAndSport200Response = {
|
|
19
|
+
courts,
|
|
20
|
+
total,
|
|
21
|
+
clubId,
|
|
22
|
+
sportId,
|
|
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,24 @@
|
|
|
1
|
+
# GetLastSixMonthsTurnover200ResponseInner
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**year** | **number** | | [optional] [default to undefined]
|
|
9
|
+
**month** | **number** | | [optional] [default to undefined]
|
|
10
|
+
**total** | **number** | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { GetLastSixMonthsTurnover200ResponseInner } from '@tennac-booking/sdk';
|
|
16
|
+
|
|
17
|
+
const instance: GetLastSixMonthsTurnover200ResponseInner = {
|
|
18
|
+
year,
|
|
19
|
+
month,
|
|
20
|
+
total,
|
|
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)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# GetNumberOfClubUsers200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**count** | **number** | | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { GetNumberOfClubUsers200Response } from '@tennac-booking/sdk';
|
|
14
|
+
|
|
15
|
+
const instance: GetNumberOfClubUsers200Response = {
|
|
16
|
+
count,
|
|
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)
|
|
@@ -5,11 +5,10 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**clubId** | **string** |
|
|
9
|
-
**clubName** | **string** |
|
|
10
|
-
**roleId** | **string** |
|
|
11
|
-
**roleName** | **string** |
|
|
12
|
-
**permissions** | **Array<string>** | Permissions associées au rôle | [optional] [default to undefined]
|
|
8
|
+
**clubId** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**clubName** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**roleId** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**roleName** | **string** | | [optional] [default to undefined]
|
|
13
12
|
|
|
14
13
|
## Example
|
|
15
14
|
|
|
@@ -21,7 +20,6 @@ const instance: GetUserRolesResponseRolesInner = {
|
|
|
21
20
|
clubName,
|
|
22
21
|
roleId,
|
|
23
22
|
roleName,
|
|
24
|
-
permissions,
|
|
25
23
|
};
|
|
26
24
|
```
|
|
27
25
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**
|
|
8
|
+
**googleToken** | **string** | | [default to undefined]
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|
|
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
|
|
|
13
13
|
import { GoogleSignInRequestBody } from '@tennac-booking/sdk';
|
|
14
14
|
|
|
15
15
|
const instance: GoogleSignInRequestBody = {
|
|
16
|
-
|
|
16
|
+
googleToken,
|
|
17
17
|
};
|
|
18
18
|
```
|
|
19
19
|
|
|
@@ -5,12 +5,9 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**token** | **string** |
|
|
9
|
-
**refreshToken** | **string** |
|
|
10
|
-
**sessionDuration** | **number** | Durée de la session en secondes | [optional] [default to undefined]
|
|
11
|
-
**sessionEnd** | **number** | Timestamp de fin de session | [optional] [default to undefined]
|
|
8
|
+
**token** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**refreshToken** | **string** | | [optional] [default to undefined]
|
|
12
10
|
**user** | [**UserResponse**](UserResponse.md) | | [optional] [default to undefined]
|
|
13
|
-
**isNewUser** | **boolean** | Indique si c\'est un nouvel utilisateur | [optional] [default to undefined]
|
|
14
11
|
|
|
15
12
|
## Example
|
|
16
13
|
|
|
@@ -20,10 +17,7 @@ import { GoogleSignInResponse } from '@tennac-booking/sdk';
|
|
|
20
17
|
const instance: GoogleSignInResponse = {
|
|
21
18
|
token,
|
|
22
19
|
refreshToken,
|
|
23
|
-
sessionDuration,
|
|
24
|
-
sessionEnd,
|
|
25
20
|
user,
|
|
26
|
-
isNewUser,
|
|
27
21
|
};
|
|
28
22
|
```
|
|
29
23
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ManagerClubCourtsApi
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *https://api.mon-domaine.com*
|
|
4
4
|
|
|
@@ -15,13 +15,13 @@ All URIs are relative to *https://api.mon-domaine.com*
|
|
|
15
15
|
|
|
16
16
|
```typescript
|
|
17
17
|
import {
|
|
18
|
-
|
|
18
|
+
ManagerClubCourtsApi,
|
|
19
19
|
Configuration,
|
|
20
20
|
CreateCourtRequest
|
|
21
21
|
} from '@tennac-booking/sdk';
|
|
22
22
|
|
|
23
23
|
const configuration = new Configuration();
|
|
24
|
-
const apiInstance = new
|
|
24
|
+
const apiInstance = new ManagerClubCourtsApi(configuration);
|
|
25
25
|
|
|
26
26
|
let id: string; //ID du club (default to undefined)
|
|
27
27
|
let createCourtRequest: CreateCourtRequest; //
|
|
@@ -72,12 +72,12 @@ const { status, data } = await apiInstance.createCourtForClub(
|
|
|
72
72
|
|
|
73
73
|
```typescript
|
|
74
74
|
import {
|
|
75
|
-
|
|
75
|
+
ManagerClubCourtsApi,
|
|
76
76
|
Configuration
|
|
77
77
|
} from '@tennac-booking/sdk';
|
|
78
78
|
|
|
79
79
|
const configuration = new Configuration();
|
|
80
|
-
const apiInstance = new
|
|
80
|
+
const apiInstance = new ManagerClubCourtsApi(configuration);
|
|
81
81
|
|
|
82
82
|
let id: string; //ID du club (default to undefined)
|
|
83
83
|
|
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
# ManagerClubSlotsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.mon-domaine.com*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**deleteSlotsByClubInRange**](#deleteslotsbyclubinrange) | **DELETE** /api/clubs/{id}/slots | Supprimer des créneaux pour un club sur une plage de dates|
|
|
8
|
+
|[**getSlotsByClub**](#getslotsbyclub) | **GET** /api/clubs/{id}/slots | Récupérer tous les créneaux pour un club|
|
|
9
|
+
|
|
10
|
+
# **deleteSlotsByClubInRange**
|
|
11
|
+
> DeleteSlotsByClubInRange200Response deleteSlotsByClubInRange()
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
### Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import {
|
|
18
|
+
ManagerClubSlotsApi,
|
|
19
|
+
Configuration
|
|
20
|
+
} from '@tennac-booking/sdk';
|
|
21
|
+
|
|
22
|
+
const configuration = new Configuration();
|
|
23
|
+
const apiInstance = new ManagerClubSlotsApi(configuration);
|
|
24
|
+
|
|
25
|
+
let id: string; //ID du club (default to undefined)
|
|
26
|
+
let start: string; //Date de début (format ISO) (default to undefined)
|
|
27
|
+
let end: string; //Date de fin (format ISO) (default to undefined)
|
|
28
|
+
|
|
29
|
+
const { status, data } = await apiInstance.deleteSlotsByClubInRange(
|
|
30
|
+
id,
|
|
31
|
+
start,
|
|
32
|
+
end
|
|
33
|
+
);
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### Parameters
|
|
37
|
+
|
|
38
|
+
|Name | Type | Description | Notes|
|
|
39
|
+
|------------- | ------------- | ------------- | -------------|
|
|
40
|
+
| **id** | [**string**] | ID du club | defaults to undefined|
|
|
41
|
+
| **start** | [**string**] | Date de début (format ISO) | defaults to undefined|
|
|
42
|
+
| **end** | [**string**] | Date de fin (format ISO) | defaults to undefined|
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
### Return type
|
|
46
|
+
|
|
47
|
+
**DeleteSlotsByClubInRange200Response**
|
|
48
|
+
|
|
49
|
+
### Authorization
|
|
50
|
+
|
|
51
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
52
|
+
|
|
53
|
+
### HTTP request headers
|
|
54
|
+
|
|
55
|
+
- **Content-Type**: Not defined
|
|
56
|
+
- **Accept**: application/json
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
### HTTP response details
|
|
60
|
+
| Status code | Description | Response headers |
|
|
61
|
+
|-------------|-------------|------------------|
|
|
62
|
+
|**200** | Créneaux supprimés avec succès | - |
|
|
63
|
+
|**400** | Requête invalide | - |
|
|
64
|
+
|**500** | Erreur serveur interne | - |
|
|
65
|
+
|
|
66
|
+
[[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)
|
|
67
|
+
|
|
68
|
+
# **getSlotsByClub**
|
|
69
|
+
> SlotsResponse getSlotsByClub()
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
### Example
|
|
73
|
+
|
|
74
|
+
```typescript
|
|
75
|
+
import {
|
|
76
|
+
ManagerClubSlotsApi,
|
|
77
|
+
Configuration
|
|
78
|
+
} from '@tennac-booking/sdk';
|
|
79
|
+
|
|
80
|
+
const configuration = new Configuration();
|
|
81
|
+
const apiInstance = new ManagerClubSlotsApi(configuration);
|
|
82
|
+
|
|
83
|
+
let id: string; //ID du club (default to undefined)
|
|
84
|
+
let start: string; //Date de début (format ISO) (optional) (default to undefined)
|
|
85
|
+
let end: string; //Date de fin (format ISO) (optional) (default to undefined)
|
|
86
|
+
|
|
87
|
+
const { status, data } = await apiInstance.getSlotsByClub(
|
|
88
|
+
id,
|
|
89
|
+
start,
|
|
90
|
+
end
|
|
91
|
+
);
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### Parameters
|
|
95
|
+
|
|
96
|
+
|Name | Type | Description | Notes|
|
|
97
|
+
|------------- | ------------- | ------------- | -------------|
|
|
98
|
+
| **id** | [**string**] | ID du club | defaults to undefined|
|
|
99
|
+
| **start** | [**string**] | Date de début (format ISO) | (optional) defaults to undefined|
|
|
100
|
+
| **end** | [**string**] | Date de fin (format ISO) | (optional) defaults to undefined|
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
### Return type
|
|
104
|
+
|
|
105
|
+
**SlotsResponse**
|
|
106
|
+
|
|
107
|
+
### Authorization
|
|
108
|
+
|
|
109
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
110
|
+
|
|
111
|
+
### HTTP request headers
|
|
112
|
+
|
|
113
|
+
- **Content-Type**: Not defined
|
|
114
|
+
- **Accept**: application/json
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
### HTTP response details
|
|
118
|
+
| Status code | Description | Response headers |
|
|
119
|
+
|-------------|-------------|------------------|
|
|
120
|
+
|**200** | Liste des créneaux du club | - |
|
|
121
|
+
|**400** | Requête invalide | - |
|
|
122
|
+
|**500** | Erreur serveur interne | - |
|
|
123
|
+
|
|
124
|
+
[[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)
|
|
125
|
+
|
|
@@ -0,0 +1,280 @@
|
|
|
1
|
+
# ManagerClubsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.mon-domaine.com*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**addClubMember**](#addclubmember) | **PUT** /api/clubs/{id}/add_members | Ajouter un membre à un club|
|
|
8
|
+
|[**getClubInfo**](#getclubinfo) | **GET** /api/clubs/{id} | Récupérer les informations d\'un club|
|
|
9
|
+
|[**getClubMembers**](#getclubmembers) | **GET** /api/clubs/{id}/members | Récupérer les membres d\'un club|
|
|
10
|
+
|[**getClubRoles**](#getclubroles) | **GET** /api/clubs/{id}/roles | Récupérer les rôles d\'un club|
|
|
11
|
+
|[**updateClub**](#updateclub) | **PUT** /api/clubs/{id} | Mettre à jour un club existant|
|
|
12
|
+
|
|
13
|
+
# **addClubMember**
|
|
14
|
+
> AddClubMemberResponse addClubMember(addClubMemberRequest)
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
### Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import {
|
|
21
|
+
ManagerClubsApi,
|
|
22
|
+
Configuration,
|
|
23
|
+
AddClubMemberRequest
|
|
24
|
+
} from '@tennac-booking/sdk';
|
|
25
|
+
|
|
26
|
+
const configuration = new Configuration();
|
|
27
|
+
const apiInstance = new ManagerClubsApi(configuration);
|
|
28
|
+
|
|
29
|
+
let id: string; //ID du club (default to undefined)
|
|
30
|
+
let addClubMemberRequest: AddClubMemberRequest; //
|
|
31
|
+
|
|
32
|
+
const { status, data } = await apiInstance.addClubMember(
|
|
33
|
+
id,
|
|
34
|
+
addClubMemberRequest
|
|
35
|
+
);
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### Parameters
|
|
39
|
+
|
|
40
|
+
|Name | Type | Description | Notes|
|
|
41
|
+
|------------- | ------------- | ------------- | -------------|
|
|
42
|
+
| **addClubMemberRequest** | **AddClubMemberRequest**| | |
|
|
43
|
+
| **id** | [**string**] | ID du club | defaults to undefined|
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
### Return type
|
|
47
|
+
|
|
48
|
+
**AddClubMemberResponse**
|
|
49
|
+
|
|
50
|
+
### Authorization
|
|
51
|
+
|
|
52
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
53
|
+
|
|
54
|
+
### HTTP request headers
|
|
55
|
+
|
|
56
|
+
- **Content-Type**: application/json
|
|
57
|
+
- **Accept**: application/json
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
### HTTP response details
|
|
61
|
+
| Status code | Description | Response headers |
|
|
62
|
+
|-------------|-------------|------------------|
|
|
63
|
+
|**201** | Membre ajouté avec succès | - |
|
|
64
|
+
|**400** | Requête invalide | - |
|
|
65
|
+
|**404** | Ressource non trouvée | - |
|
|
66
|
+
|**500** | Erreur serveur interne | - |
|
|
67
|
+
|
|
68
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
69
|
+
|
|
70
|
+
# **getClubInfo**
|
|
71
|
+
> ClubInfoResponse getClubInfo()
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
### Example
|
|
75
|
+
|
|
76
|
+
```typescript
|
|
77
|
+
import {
|
|
78
|
+
ManagerClubsApi,
|
|
79
|
+
Configuration
|
|
80
|
+
} from '@tennac-booking/sdk';
|
|
81
|
+
|
|
82
|
+
const configuration = new Configuration();
|
|
83
|
+
const apiInstance = new ManagerClubsApi(configuration);
|
|
84
|
+
|
|
85
|
+
let id: string; //ID du club (default to undefined)
|
|
86
|
+
|
|
87
|
+
const { status, data } = await apiInstance.getClubInfo(
|
|
88
|
+
id
|
|
89
|
+
);
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
### Parameters
|
|
93
|
+
|
|
94
|
+
|Name | Type | Description | Notes|
|
|
95
|
+
|------------- | ------------- | ------------- | -------------|
|
|
96
|
+
| **id** | [**string**] | ID du club | defaults to undefined|
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
### Return type
|
|
100
|
+
|
|
101
|
+
**ClubInfoResponse**
|
|
102
|
+
|
|
103
|
+
### Authorization
|
|
104
|
+
|
|
105
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
106
|
+
|
|
107
|
+
### HTTP request headers
|
|
108
|
+
|
|
109
|
+
- **Content-Type**: Not defined
|
|
110
|
+
- **Accept**: application/json
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
### HTTP response details
|
|
114
|
+
| Status code | Description | Response headers |
|
|
115
|
+
|-------------|-------------|------------------|
|
|
116
|
+
|**200** | Informations du club | - |
|
|
117
|
+
|**404** | Ressource non trouvée | - |
|
|
118
|
+
|**500** | Erreur serveur interne | - |
|
|
119
|
+
|
|
120
|
+
[[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)
|
|
121
|
+
|
|
122
|
+
# **getClubMembers**
|
|
123
|
+
> ClubMembersResponse getClubMembers()
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
### Example
|
|
127
|
+
|
|
128
|
+
```typescript
|
|
129
|
+
import {
|
|
130
|
+
ManagerClubsApi,
|
|
131
|
+
Configuration
|
|
132
|
+
} from '@tennac-booking/sdk';
|
|
133
|
+
|
|
134
|
+
const configuration = new Configuration();
|
|
135
|
+
const apiInstance = new ManagerClubsApi(configuration);
|
|
136
|
+
|
|
137
|
+
let id: string; //ID du club (default to undefined)
|
|
138
|
+
|
|
139
|
+
const { status, data } = await apiInstance.getClubMembers(
|
|
140
|
+
id
|
|
141
|
+
);
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
### Parameters
|
|
145
|
+
|
|
146
|
+
|Name | Type | Description | Notes|
|
|
147
|
+
|------------- | ------------- | ------------- | -------------|
|
|
148
|
+
| **id** | [**string**] | ID du club | defaults to undefined|
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
### Return type
|
|
152
|
+
|
|
153
|
+
**ClubMembersResponse**
|
|
154
|
+
|
|
155
|
+
### Authorization
|
|
156
|
+
|
|
157
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
158
|
+
|
|
159
|
+
### HTTP request headers
|
|
160
|
+
|
|
161
|
+
- **Content-Type**: Not defined
|
|
162
|
+
- **Accept**: application/json
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
### HTTP response details
|
|
166
|
+
| Status code | Description | Response headers |
|
|
167
|
+
|-------------|-------------|------------------|
|
|
168
|
+
|**200** | Liste des membres du club | - |
|
|
169
|
+
|**500** | Erreur serveur interne | - |
|
|
170
|
+
|
|
171
|
+
[[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)
|
|
172
|
+
|
|
173
|
+
# **getClubRoles**
|
|
174
|
+
> ClubRolesResponse getClubRoles()
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
### Example
|
|
178
|
+
|
|
179
|
+
```typescript
|
|
180
|
+
import {
|
|
181
|
+
ManagerClubsApi,
|
|
182
|
+
Configuration
|
|
183
|
+
} from '@tennac-booking/sdk';
|
|
184
|
+
|
|
185
|
+
const configuration = new Configuration();
|
|
186
|
+
const apiInstance = new ManagerClubsApi(configuration);
|
|
187
|
+
|
|
188
|
+
let id: string; //ID du club (default to undefined)
|
|
189
|
+
|
|
190
|
+
const { status, data } = await apiInstance.getClubRoles(
|
|
191
|
+
id
|
|
192
|
+
);
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
### Parameters
|
|
196
|
+
|
|
197
|
+
|Name | Type | Description | Notes|
|
|
198
|
+
|------------- | ------------- | ------------- | -------------|
|
|
199
|
+
| **id** | [**string**] | ID du club | defaults to undefined|
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
### Return type
|
|
203
|
+
|
|
204
|
+
**ClubRolesResponse**
|
|
205
|
+
|
|
206
|
+
### Authorization
|
|
207
|
+
|
|
208
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
209
|
+
|
|
210
|
+
### HTTP request headers
|
|
211
|
+
|
|
212
|
+
- **Content-Type**: Not defined
|
|
213
|
+
- **Accept**: application/json
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
### HTTP response details
|
|
217
|
+
| Status code | Description | Response headers |
|
|
218
|
+
|-------------|-------------|------------------|
|
|
219
|
+
|**200** | Liste des rôles du club | - |
|
|
220
|
+
|**500** | Erreur serveur interne | - |
|
|
221
|
+
|
|
222
|
+
[[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)
|
|
223
|
+
|
|
224
|
+
# **updateClub**
|
|
225
|
+
> ClubResponse updateClub(updateClubRequest)
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
### Example
|
|
229
|
+
|
|
230
|
+
```typescript
|
|
231
|
+
import {
|
|
232
|
+
ManagerClubsApi,
|
|
233
|
+
Configuration,
|
|
234
|
+
UpdateClubRequest
|
|
235
|
+
} from '@tennac-booking/sdk';
|
|
236
|
+
|
|
237
|
+
const configuration = new Configuration();
|
|
238
|
+
const apiInstance = new ManagerClubsApi(configuration);
|
|
239
|
+
|
|
240
|
+
let id: string; //ID du club (default to undefined)
|
|
241
|
+
let updateClubRequest: UpdateClubRequest; //
|
|
242
|
+
|
|
243
|
+
const { status, data } = await apiInstance.updateClub(
|
|
244
|
+
id,
|
|
245
|
+
updateClubRequest
|
|
246
|
+
);
|
|
247
|
+
```
|
|
248
|
+
|
|
249
|
+
### Parameters
|
|
250
|
+
|
|
251
|
+
|Name | Type | Description | Notes|
|
|
252
|
+
|------------- | ------------- | ------------- | -------------|
|
|
253
|
+
| **updateClubRequest** | **UpdateClubRequest**| | |
|
|
254
|
+
| **id** | [**string**] | ID du club | defaults to undefined|
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
### Return type
|
|
258
|
+
|
|
259
|
+
**ClubResponse**
|
|
260
|
+
|
|
261
|
+
### Authorization
|
|
262
|
+
|
|
263
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
264
|
+
|
|
265
|
+
### HTTP request headers
|
|
266
|
+
|
|
267
|
+
- **Content-Type**: application/json
|
|
268
|
+
- **Accept**: application/json
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
### HTTP response details
|
|
272
|
+
| Status code | Description | Response headers |
|
|
273
|
+
|-------------|-------------|------------------|
|
|
274
|
+
|**200** | Club mis à jour avec succès | - |
|
|
275
|
+
|**400** | Requête invalide | - |
|
|
276
|
+
|**404** | Ressource non trouvée | - |
|
|
277
|
+
|**500** | Erreur serveur interne | - |
|
|
278
|
+
|
|
279
|
+
[[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)
|
|
280
|
+
|