@tennac-booking/sdk 1.0.68 → 1.0.70
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 +9 -2
- package/README.md +15 -5
- package/api.ts +889 -66
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +650 -42
- package/dist/api.js +295 -8
- 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 +650 -42
- package/dist/esm/api.js +292 -5
- 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/BookingDetailResponse.md +1 -1
- package/docs/{BookingHistory.md → BookingHistoryPopulated.md} +4 -4
- package/docs/BookingPopulated.md +27 -7
- package/docs/BookingStatus.md +3 -3
- package/docs/BookingSummary.md +1 -1
- package/docs/BookingsApi.md +81 -2
- package/docs/BookingsStaffApi.md +3 -3
- package/docs/CourtResponse.md +4 -0
- package/docs/CreateBookingRequest.md +2 -0
- package/docs/{BookingSummaryBookingHistory.md → PlayerCategoriesResponse.md} +5 -3
- package/docs/PlayerCategory.md +26 -0
- package/docs/PlayerCategoryId.md +16 -0
- package/docs/PlayerListResponse.md +26 -0
- package/docs/QuickReservationClubSummary.md +28 -0
- package/docs/QuickReservationClubSummaryLocation.md +31 -0
- package/docs/QuickReservationResponse.md +22 -0
- package/docs/QuickReservationSlotSummary.md +42 -0
- package/docs/UserInfo.md +4 -0
- package/docs/UserProfileResponse.md +2 -0
- package/docs/UsersApi.md +122 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/docs/BookingsApi.md
CHANGED
|
@@ -5,9 +5,10 @@ All URIs are relative to *http://localhost*
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**getBookingHistory**](#getbookinghistory) | **GET** /api/bookings/history/{bookingId} | |
|
|
8
|
+
|[**getQuickReservationSlots**](#getquickreservationslots) | **GET** /api/bookings/quick-reservations | |
|
|
8
9
|
|
|
9
10
|
# **getBookingHistory**
|
|
10
|
-
>
|
|
11
|
+
> BookingHistoryPopulated getBookingHistory()
|
|
11
12
|
|
|
12
13
|
Obtenir l\'historique d\'une réservation par ID
|
|
13
14
|
|
|
@@ -38,7 +39,7 @@ const { status, data } = await apiInstance.getBookingHistory(
|
|
|
38
39
|
|
|
39
40
|
### Return type
|
|
40
41
|
|
|
41
|
-
**
|
|
42
|
+
**BookingHistoryPopulated**
|
|
42
43
|
|
|
43
44
|
### Authorization
|
|
44
45
|
|
|
@@ -57,3 +58,81 @@ const { status, data } = await apiInstance.getBookingHistory(
|
|
|
57
58
|
|
|
58
59
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
59
60
|
|
|
61
|
+
# **getQuickReservationSlots**
|
|
62
|
+
> QuickReservationResponse getQuickReservationSlots()
|
|
63
|
+
|
|
64
|
+
Recherche des créneaux disponibles pour une réservation rapide
|
|
65
|
+
|
|
66
|
+
### Example
|
|
67
|
+
|
|
68
|
+
```typescript
|
|
69
|
+
import {
|
|
70
|
+
BookingsApi,
|
|
71
|
+
Configuration
|
|
72
|
+
} from '@tennac-booking/sdk';
|
|
73
|
+
|
|
74
|
+
const configuration = new Configuration();
|
|
75
|
+
const apiInstance = new BookingsApi(configuration);
|
|
76
|
+
|
|
77
|
+
let latitude: number; // (optional) (default to undefined)
|
|
78
|
+
let longitude: number; // (optional) (default to undefined)
|
|
79
|
+
let radiusInKm: number; // (optional) (default to undefined)
|
|
80
|
+
let date: string; // (optional) (default to undefined)
|
|
81
|
+
let sportId: string; // (optional) (default to undefined)
|
|
82
|
+
let startTime: string; // (optional) (default to undefined)
|
|
83
|
+
let priceMax: number; // (optional) (default to undefined)
|
|
84
|
+
let courtTypes: string; // (optional) (default to undefined)
|
|
85
|
+
let limitPerClub: number; // (optional) (default to undefined)
|
|
86
|
+
let maxClubs: number; // (optional) (default to undefined)
|
|
87
|
+
|
|
88
|
+
const { status, data } = await apiInstance.getQuickReservationSlots(
|
|
89
|
+
latitude,
|
|
90
|
+
longitude,
|
|
91
|
+
radiusInKm,
|
|
92
|
+
date,
|
|
93
|
+
sportId,
|
|
94
|
+
startTime,
|
|
95
|
+
priceMax,
|
|
96
|
+
courtTypes,
|
|
97
|
+
limitPerClub,
|
|
98
|
+
maxClubs
|
|
99
|
+
);
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
### Parameters
|
|
103
|
+
|
|
104
|
+
|Name | Type | Description | Notes|
|
|
105
|
+
|------------- | ------------- | ------------- | -------------|
|
|
106
|
+
| **latitude** | [**number**] | | (optional) defaults to undefined|
|
|
107
|
+
| **longitude** | [**number**] | | (optional) defaults to undefined|
|
|
108
|
+
| **radiusInKm** | [**number**] | | (optional) defaults to undefined|
|
|
109
|
+
| **date** | [**string**] | | (optional) defaults to undefined|
|
|
110
|
+
| **sportId** | [**string**] | | (optional) defaults to undefined|
|
|
111
|
+
| **startTime** | [**string**] | | (optional) defaults to undefined|
|
|
112
|
+
| **priceMax** | [**number**] | | (optional) defaults to undefined|
|
|
113
|
+
| **courtTypes** | [**string**] | | (optional) defaults to undefined|
|
|
114
|
+
| **limitPerClub** | [**number**] | | (optional) defaults to undefined|
|
|
115
|
+
| **maxClubs** | [**number**] | | (optional) defaults to undefined|
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
### Return type
|
|
119
|
+
|
|
120
|
+
**QuickReservationResponse**
|
|
121
|
+
|
|
122
|
+
### Authorization
|
|
123
|
+
|
|
124
|
+
No authorization required
|
|
125
|
+
|
|
126
|
+
### HTTP request headers
|
|
127
|
+
|
|
128
|
+
- **Content-Type**: Not defined
|
|
129
|
+
- **Accept**: application/json
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
### HTTP response details
|
|
133
|
+
| Status code | Description | Response headers |
|
|
134
|
+
|-------------|-------------|------------------|
|
|
135
|
+
|**200** | Créneaux disponibles pour réservation rapide | - |
|
|
136
|
+
|
|
137
|
+
[[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)
|
|
138
|
+
|
package/docs/BookingsStaffApi.md
CHANGED
|
@@ -6,7 +6,7 @@ All URIs are relative to *http://localhost*
|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**checkInPlayers**](#checkinplayers) | **POST** /api/bookings/{bookingId}/check-in | |
|
|
8
8
|
|[**getBookingById**](#getbookingbyid) | **GET** /api/bookings/{bookingId} | |
|
|
9
|
-
|[**getBookingHistoryStaff**](#getbookinghistorystaff) | **GET** /api/bookings/staff/{bookingId} | |
|
|
9
|
+
|[**getBookingHistoryStaff**](#getbookinghistorystaff) | **GET** /api/bookings/staff/history{bookingId} | |
|
|
10
10
|
|[**getBookingPaymentStatus**](#getbookingpaymentstatus) | **GET** /api/bookings/{bookingId}/payment-status | |
|
|
11
11
|
|[**getDailyBookings**](#getdailybookings) | **GET** /api/bookings/daily/{date} | |
|
|
12
12
|
|[**getWeeklyBookings**](#getweeklybookings) | **GET** /api/bookings/weekly/{weekId} | |
|
|
@@ -118,7 +118,7 @@ const { status, data } = await apiInstance.getBookingById(
|
|
|
118
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
119
|
|
|
120
120
|
# **getBookingHistoryStaff**
|
|
121
|
-
>
|
|
121
|
+
> BookingHistoryPopulated getBookingHistoryStaff()
|
|
122
122
|
|
|
123
123
|
Obtenir l\'historique d\'une réservation par ID
|
|
124
124
|
|
|
@@ -149,7 +149,7 @@ const { status, data } = await apiInstance.getBookingHistoryStaff(
|
|
|
149
149
|
|
|
150
150
|
### Return type
|
|
151
151
|
|
|
152
|
-
**
|
|
152
|
+
**BookingHistoryPopulated**
|
|
153
153
|
|
|
154
154
|
### Authorization
|
|
155
155
|
|
package/docs/CourtResponse.md
CHANGED
|
@@ -9,6 +9,8 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**name** | **string** | Nom du terrain | [default to undefined]
|
|
10
10
|
**status** | **string** | Statut du terrain | [default to undefined]
|
|
11
11
|
**comments** | **string** | Commentaires sur le terrain | [optional] [default to undefined]
|
|
12
|
+
**pricePerHour** | **number** | | [optional] [default to undefined]
|
|
13
|
+
**bookingCount** | **number** | | [optional] [default to undefined]
|
|
12
14
|
**slotDefaultDuration** | **number** | Durée par défaut d\'un créneau en minutes | [default to undefined]
|
|
13
15
|
**startTimeInTheDayInMinutes** | **number** | Heure de début en minutes depuis minuit | [default to undefined]
|
|
14
16
|
**endTimeInTheDayInMinutes** | **number** | Heure de fin en minutes depuis minuit | [default to undefined]
|
|
@@ -30,6 +32,8 @@ const instance: CourtResponse = {
|
|
|
30
32
|
name,
|
|
31
33
|
status,
|
|
32
34
|
comments,
|
|
35
|
+
pricePerHour,
|
|
36
|
+
bookingCount,
|
|
33
37
|
slotDefaultDuration,
|
|
34
38
|
startTimeInTheDayInMinutes,
|
|
35
39
|
endTimeInTheDayInMinutes,
|
|
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**players** | [**Array<PlayerWithPaymentMethod>**](PlayerWithPaymentMethod.md) | Liste des joueurs avec leurs méthodes de paiement | [default to undefined]
|
|
10
10
|
**isCreatorPayingAll** | **boolean** | Indique si le créateur paie pour tous les joueurs | [optional] [default to undefined]
|
|
11
11
|
**paymentMethod** | [**PaymentMethod**](PaymentMethod.md) | | [optional] [default to undefined]
|
|
12
|
+
**useDefaultPaymentMethod** | **boolean** | Indique si l\'utilisateur veut utiliser sa méthode de paiement par défaut | [optional] [default to undefined]
|
|
12
13
|
|
|
13
14
|
## Example
|
|
14
15
|
|
|
@@ -20,6 +21,7 @@ const instance: CreateBookingRequest = {
|
|
|
20
21
|
players,
|
|
21
22
|
isCreatorPayingAll,
|
|
22
23
|
paymentMethod,
|
|
24
|
+
useDefaultPaymentMethod,
|
|
23
25
|
};
|
|
24
26
|
```
|
|
25
27
|
|
|
@@ -1,17 +1,19 @@
|
|
|
1
|
-
#
|
|
1
|
+
# PlayerCategoriesResponse
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**categories** | [**Array<PlayerCategory>**](PlayerCategory.md) | | [default to undefined]
|
|
8
9
|
|
|
9
10
|
## Example
|
|
10
11
|
|
|
11
12
|
```typescript
|
|
12
|
-
import {
|
|
13
|
+
import { PlayerCategoriesResponse } from '@tennac-booking/sdk';
|
|
13
14
|
|
|
14
|
-
const instance:
|
|
15
|
+
const instance: PlayerCategoriesResponse = {
|
|
16
|
+
categories,
|
|
15
17
|
};
|
|
16
18
|
```
|
|
17
19
|
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# PlayerCategory
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | [**PlayerCategoryId**](PlayerCategoryId.md) | | [default to undefined]
|
|
9
|
+
**label** | **string** | | [default to undefined]
|
|
10
|
+
**description** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**limit** | **number** | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { PlayerCategory } from '@tennac-booking/sdk';
|
|
17
|
+
|
|
18
|
+
const instance: PlayerCategory = {
|
|
19
|
+
id,
|
|
20
|
+
label,
|
|
21
|
+
description,
|
|
22
|
+
limit,
|
|
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,16 @@
|
|
|
1
|
+
# PlayerCategoryId
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `SameLevel` (value: `'same-level'`)
|
|
7
|
+
|
|
8
|
+
* `MutualConnections` (value: `'mutual-connections'`)
|
|
9
|
+
|
|
10
|
+
* `ClubMembers` (value: `'club-members'`)
|
|
11
|
+
|
|
12
|
+
* `MostActive` (value: `'most-active'`)
|
|
13
|
+
|
|
14
|
+
* `Nearby` (value: `'nearby'`)
|
|
15
|
+
|
|
16
|
+
[[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
|
+
# PlayerListResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**players** | [**Array<PlayerSummary>**](PlayerSummary.md) | | [default to undefined]
|
|
9
|
+
**total** | **number** | | [optional] [default to undefined]
|
|
10
|
+
**hasMore** | **boolean** | | [optional] [default to undefined]
|
|
11
|
+
**nextOffset** | **number** | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { PlayerListResponse } from '@tennac-booking/sdk';
|
|
17
|
+
|
|
18
|
+
const instance: PlayerListResponse = {
|
|
19
|
+
players,
|
|
20
|
+
total,
|
|
21
|
+
hasMore,
|
|
22
|
+
nextOffset,
|
|
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,28 @@
|
|
|
1
|
+
# QuickReservationClubSummary
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**clubId** | **string** | ID du club | [default to undefined]
|
|
9
|
+
**clubName** | **string** | Nom du club | [default to undefined]
|
|
10
|
+
**distanceInMeters** | **number** | Distance par rapport à la recherche, en mètres | [default to undefined]
|
|
11
|
+
**location** | [**QuickReservationClubSummaryLocation**](QuickReservationClubSummaryLocation.md) | | [optional] [default to undefined]
|
|
12
|
+
**slots** | [**Array<QuickReservationSlotSummary>**](QuickReservationSlotSummary.md) | Créneaux disponibles correspondant aux filtres | [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { QuickReservationClubSummary } from '@tennac-booking/sdk';
|
|
18
|
+
|
|
19
|
+
const instance: QuickReservationClubSummary = {
|
|
20
|
+
clubId,
|
|
21
|
+
clubName,
|
|
22
|
+
distanceInMeters,
|
|
23
|
+
location,
|
|
24
|
+
slots,
|
|
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)
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# QuickReservationClubSummaryLocation
|
|
2
|
+
|
|
3
|
+
Localisation du club
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**country** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**postalCode** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**city** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**address** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**longitude** | **number** | | [optional] [default to undefined]
|
|
14
|
+
**latitude** | **number** | | [optional] [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { QuickReservationClubSummaryLocation } from '@tennac-booking/sdk';
|
|
20
|
+
|
|
21
|
+
const instance: QuickReservationClubSummaryLocation = {
|
|
22
|
+
country,
|
|
23
|
+
postalCode,
|
|
24
|
+
city,
|
|
25
|
+
address,
|
|
26
|
+
longitude,
|
|
27
|
+
latitude,
|
|
28
|
+
};
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# QuickReservationResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**totalClubs** | **number** | Nombre total de clubs contenant des créneaux disponibles | [default to undefined]
|
|
9
|
+
**clubs** | [**Array<QuickReservationClubSummary>**](QuickReservationClubSummary.md) | Liste des clubs et de leurs créneaux disponibles | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { QuickReservationResponse } from '@tennac-booking/sdk';
|
|
15
|
+
|
|
16
|
+
const instance: QuickReservationResponse = {
|
|
17
|
+
totalClubs,
|
|
18
|
+
clubs,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# QuickReservationSlotSummary
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | ID du créneau | [default to undefined]
|
|
9
|
+
**startDate** | **string** | Date de début ISO | [default to undefined]
|
|
10
|
+
**endDate** | **string** | Date de fin ISO | [default to undefined]
|
|
11
|
+
**durationMinutes** | **number** | Durée du créneau en minutes | [default to undefined]
|
|
12
|
+
**courtId** | **string** | ID du terrain | [default to undefined]
|
|
13
|
+
**courtName** | **string** | Nom du terrain | [default to undefined]
|
|
14
|
+
**isIndoor** | **boolean** | Indique si le terrain est en intérieur | [default to undefined]
|
|
15
|
+
**surface** | **string** | Surface du terrain | [optional] [default to undefined]
|
|
16
|
+
**pricePerHour** | **number** | Prix horaire du terrain (en euros) | [optional] [default to undefined]
|
|
17
|
+
**totalPrice** | **number** | Prix total estimé pour le créneau (en euros) | [optional] [default to undefined]
|
|
18
|
+
**sportId** | **string** | ID du sport associé | [default to undefined]
|
|
19
|
+
**sportKey** | **string** | Clé du sport associé | [optional] [default to undefined]
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
```typescript
|
|
24
|
+
import { QuickReservationSlotSummary } from '@tennac-booking/sdk';
|
|
25
|
+
|
|
26
|
+
const instance: QuickReservationSlotSummary = {
|
|
27
|
+
id,
|
|
28
|
+
startDate,
|
|
29
|
+
endDate,
|
|
30
|
+
durationMinutes,
|
|
31
|
+
courtId,
|
|
32
|
+
courtName,
|
|
33
|
+
isIndoor,
|
|
34
|
+
surface,
|
|
35
|
+
pricePerHour,
|
|
36
|
+
totalPrice,
|
|
37
|
+
sportId,
|
|
38
|
+
sportKey,
|
|
39
|
+
};
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
[[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/UserInfo.md
CHANGED
|
@@ -8,6 +8,8 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**id** | **string** | ID de l\'utilisateur | [default to undefined]
|
|
9
9
|
**firstName** | **string** | Prénom | [default to undefined]
|
|
10
10
|
**lastName** | **string** | Nom | [default to undefined]
|
|
11
|
+
**email** | **string** | | [default to undefined]
|
|
12
|
+
**profilePictureUrl** | **string** | | [optional] [default to undefined]
|
|
11
13
|
|
|
12
14
|
## Example
|
|
13
15
|
|
|
@@ -18,6 +20,8 @@ const instance: UserInfo = {
|
|
|
18
20
|
id,
|
|
19
21
|
firstName,
|
|
20
22
|
lastName,
|
|
23
|
+
email,
|
|
24
|
+
profilePictureUrl,
|
|
21
25
|
};
|
|
22
26
|
```
|
|
23
27
|
|
|
@@ -39,6 +39,7 @@ Name | Type | Description | Notes
|
|
|
39
39
|
**sports** | **{ [key: string]: any; }** | Construct a type with a set of properties K of type T | [optional] [default to undefined]
|
|
40
40
|
**upcomingBookingsCount** | **number** | | [optional] [default to undefined]
|
|
41
41
|
**subscriptionsCount** | **number** | | [optional] [default to undefined]
|
|
42
|
+
**subscriptions** | [**Array<ClubSubscriptions>**](ClubSubscriptions.md) | | [optional] [default to undefined]
|
|
42
43
|
**frequentlyVisitedClubs** | [**Array<ClubSummary>**](ClubSummary.md) | | [optional] [default to undefined]
|
|
43
44
|
**frequentlyPlayedWith** | [**Array<PlayerSummary>**](PlayerSummary.md) | | [optional] [default to undefined]
|
|
44
45
|
**stripeLinks** | **{ [key: string]: any; }** | Construct a type with a set of properties K of type T | [optional] [default to undefined]
|
|
@@ -83,6 +84,7 @@ const instance: UserProfileResponse = {
|
|
|
83
84
|
sports,
|
|
84
85
|
upcomingBookingsCount,
|
|
85
86
|
subscriptionsCount,
|
|
87
|
+
subscriptions,
|
|
86
88
|
frequentlyVisitedClubs,
|
|
87
89
|
frequentlyPlayedWith,
|
|
88
90
|
stripeLinks,
|
package/docs/UsersApi.md
CHANGED
|
@@ -21,8 +21,10 @@ All URIs are relative to *http://localhost*
|
|
|
21
21
|
|[**getNearestClubsFromCoordinates**](#getnearestclubsfromcoordinates) | **GET** /api/users/nearest-clubs/coordinates | |
|
|
22
22
|
|[**getNearestUsers**](#getnearestusers) | **GET** /api/users/me/nearest-players | |
|
|
23
23
|
|[**getNearestUsersFromCoordinates**](#getnearestusersfromcoordinates) | **GET** /api/users/nearest-players/coordinates | |
|
|
24
|
+
|[**getPlayerCategories**](#getplayercategories) | **GET** /api/users/players/categories | |
|
|
24
25
|
|[**getUserBookings**](#getuserbookings) | **GET** /api/users/me/bookings | |
|
|
25
26
|
|[**getUserProfileById**](#getuserprofilebyid) | **GET** /api/users/profile/{id} | |
|
|
27
|
+
|[**listPlayers**](#listplayers) | **GET** /api/users/players | |
|
|
26
28
|
|[**login**](#login) | **POST** /api/users/login | |
|
|
27
29
|
|[**refreshToken**](#refreshtoken) | **POST** /api/users/refresh-token | |
|
|
28
30
|
|[**register**](#register) | **POST** /api/users | |
|
|
@@ -872,6 +874,49 @@ No authorization required
|
|
|
872
874
|
- **Accept**: application/json
|
|
873
875
|
|
|
874
876
|
|
|
877
|
+
### HTTP response details
|
|
878
|
+
| Status code | Description | Response headers |
|
|
879
|
+
|-------------|-------------|------------------|
|
|
880
|
+
|**200** | Ok | - |
|
|
881
|
+
|
|
882
|
+
[[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)
|
|
883
|
+
|
|
884
|
+
# **getPlayerCategories**
|
|
885
|
+
> PlayerCategoriesResponse getPlayerCategories()
|
|
886
|
+
|
|
887
|
+
|
|
888
|
+
### Example
|
|
889
|
+
|
|
890
|
+
```typescript
|
|
891
|
+
import {
|
|
892
|
+
UsersApi,
|
|
893
|
+
Configuration
|
|
894
|
+
} from '@tennac-booking/sdk';
|
|
895
|
+
|
|
896
|
+
const configuration = new Configuration();
|
|
897
|
+
const apiInstance = new UsersApi(configuration);
|
|
898
|
+
|
|
899
|
+
const { status, data } = await apiInstance.getPlayerCategories();
|
|
900
|
+
```
|
|
901
|
+
|
|
902
|
+
### Parameters
|
|
903
|
+
This endpoint does not have any parameters.
|
|
904
|
+
|
|
905
|
+
|
|
906
|
+
### Return type
|
|
907
|
+
|
|
908
|
+
**PlayerCategoriesResponse**
|
|
909
|
+
|
|
910
|
+
### Authorization
|
|
911
|
+
|
|
912
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
913
|
+
|
|
914
|
+
### HTTP request headers
|
|
915
|
+
|
|
916
|
+
- **Content-Type**: Not defined
|
|
917
|
+
- **Accept**: application/json
|
|
918
|
+
|
|
919
|
+
|
|
875
920
|
### HTTP response details
|
|
876
921
|
| Status code | Description | Response headers |
|
|
877
922
|
|-------------|-------------|------------------|
|
|
@@ -975,6 +1020,83 @@ const { status, data } = await apiInstance.getUserProfileById(
|
|
|
975
1020
|
- **Accept**: application/json
|
|
976
1021
|
|
|
977
1022
|
|
|
1023
|
+
### HTTP response details
|
|
1024
|
+
| Status code | Description | Response headers |
|
|
1025
|
+
|-------------|-------------|------------------|
|
|
1026
|
+
|**200** | Ok | - |
|
|
1027
|
+
|
|
1028
|
+
[[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)
|
|
1029
|
+
|
|
1030
|
+
# **listPlayers**
|
|
1031
|
+
> PlayerListResponse listPlayers()
|
|
1032
|
+
|
|
1033
|
+
|
|
1034
|
+
### Example
|
|
1035
|
+
|
|
1036
|
+
```typescript
|
|
1037
|
+
import {
|
|
1038
|
+
UsersApi,
|
|
1039
|
+
Configuration
|
|
1040
|
+
} from '@tennac-booking/sdk';
|
|
1041
|
+
|
|
1042
|
+
const configuration = new Configuration();
|
|
1043
|
+
const apiInstance = new UsersApi(configuration);
|
|
1044
|
+
|
|
1045
|
+
let category: PlayerCategoryId; // (optional) (default to undefined)
|
|
1046
|
+
let search: string; // (optional) (default to undefined)
|
|
1047
|
+
let gender: string; // (optional) (default to undefined)
|
|
1048
|
+
let sharedClub: boolean; // (optional) (default to undefined)
|
|
1049
|
+
let sportLevels: string; // (optional) (default to undefined)
|
|
1050
|
+
let limit: number; // (optional) (default to undefined)
|
|
1051
|
+
let offset: number; // (optional) (default to undefined)
|
|
1052
|
+
let latitude: number; // (optional) (default to undefined)
|
|
1053
|
+
let longitude: number; // (optional) (default to undefined)
|
|
1054
|
+
let radiusInKm: number; // (optional) (default to undefined)
|
|
1055
|
+
|
|
1056
|
+
const { status, data } = await apiInstance.listPlayers(
|
|
1057
|
+
category,
|
|
1058
|
+
search,
|
|
1059
|
+
gender,
|
|
1060
|
+
sharedClub,
|
|
1061
|
+
sportLevels,
|
|
1062
|
+
limit,
|
|
1063
|
+
offset,
|
|
1064
|
+
latitude,
|
|
1065
|
+
longitude,
|
|
1066
|
+
radiusInKm
|
|
1067
|
+
);
|
|
1068
|
+
```
|
|
1069
|
+
|
|
1070
|
+
### Parameters
|
|
1071
|
+
|
|
1072
|
+
|Name | Type | Description | Notes|
|
|
1073
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1074
|
+
| **category** | **PlayerCategoryId** | | (optional) defaults to undefined|
|
|
1075
|
+
| **search** | [**string**] | | (optional) defaults to undefined|
|
|
1076
|
+
| **gender** | [**string**] | | (optional) defaults to undefined|
|
|
1077
|
+
| **sharedClub** | [**boolean**] | | (optional) defaults to undefined|
|
|
1078
|
+
| **sportLevels** | [**string**] | | (optional) defaults to undefined|
|
|
1079
|
+
| **limit** | [**number**] | | (optional) defaults to undefined|
|
|
1080
|
+
| **offset** | [**number**] | | (optional) defaults to undefined|
|
|
1081
|
+
| **latitude** | [**number**] | | (optional) defaults to undefined|
|
|
1082
|
+
| **longitude** | [**number**] | | (optional) defaults to undefined|
|
|
1083
|
+
| **radiusInKm** | [**number**] | | (optional) defaults to undefined|
|
|
1084
|
+
|
|
1085
|
+
|
|
1086
|
+
### Return type
|
|
1087
|
+
|
|
1088
|
+
**PlayerListResponse**
|
|
1089
|
+
|
|
1090
|
+
### Authorization
|
|
1091
|
+
|
|
1092
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1093
|
+
|
|
1094
|
+
### HTTP request headers
|
|
1095
|
+
|
|
1096
|
+
- **Content-Type**: Not defined
|
|
1097
|
+
- **Accept**: application/json
|
|
1098
|
+
|
|
1099
|
+
|
|
978
1100
|
### HTTP response details
|
|
979
1101
|
| Status code | Description | Response headers |
|
|
980
1102
|
|-------------|-------------|------------------|
|
package/index.ts
CHANGED