@tennac-booking/sdk 1.0.54 → 1.0.60
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 +182 -220
- package/README.md +162 -167
- package/api.ts +7179 -7614
- package/base.ts +2 -2
- package/common.ts +2 -2
- package/configuration.ts +2 -2
- package/dist/api.d.ts +4662 -5750
- package/dist/api.js +3587 -2956
- package/dist/base.d.ts +2 -2
- package/dist/base.js +2 -2
- package/dist/common.d.ts +2 -2
- package/dist/common.js +2 -2
- package/dist/configuration.d.ts +2 -2
- package/dist/configuration.js +2 -2
- package/dist/esm/api.d.ts +4662 -5750
- package/dist/esm/api.js +3513 -2861
- package/dist/esm/base.d.ts +2 -2
- package/dist/esm/base.js +2 -2
- package/dist/esm/common.d.ts +2 -2
- package/dist/esm/common.js +2 -2
- package/dist/esm/configuration.d.ts +2 -2
- package/dist/esm/configuration.js +2 -2
- package/dist/esm/index.d.ts +2 -2
- package/dist/esm/index.js +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +2 -2
- package/docs/{ApiErrorResponse.md → AddClubMember201Response.md} +6 -6
- package/docs/AddClubMemberRequest.md +7 -3
- package/docs/BookingAnalyticsResponse.md +34 -0
- package/docs/BookingHistory.md +34 -0
- package/docs/BookingInfo.md +50 -0
- package/docs/BookingPaymentStatusResponse.md +3 -3
- package/docs/BookingPaymentStatusResponseBooking.md +8 -7
- package/docs/BookingPaymentStatusResponseSummary.md +10 -9
- package/docs/BookingPopulated.md +5 -5
- package/docs/BookingResponse.md +4 -4
- package/docs/{UpdateProfileVisibilityRequestBody.md → BookingResponseOnsitePaymentsInner.md} +7 -5
- package/docs/BookingStatus.md +9 -1
- package/docs/BookingsApi.md +10 -64
- package/docs/{ManagerBookingsApi.md → BookingsManagerApi.md} +14 -24
- package/docs/BookingsStaffApi.md +323 -0
- package/docs/{UserBookingsApi.md → BookingsUserApi.md} +17 -25
- package/docs/CancelBookingResponse.md +2 -2
- package/docs/CaptureResult.md +30 -0
- package/docs/CheckInPlayersRequest.md +20 -0
- package/docs/CheckInPlayersResponse.md +6 -6
- package/docs/CheckedInPlayer.md +34 -0
- package/docs/ClubAnalyticsApi.md +20 -160
- package/docs/ClubAnalyticsStaffApi.md +523 -0
- package/docs/ClubMemberResponse.md +24 -0
- package/docs/{FrequentPlayer.md → ClubMemberResponseUser.md} +10 -11
- package/docs/ClubPlayerResponse.md +36 -0
- package/docs/ClubResponse.md +23 -14
- package/docs/ClubResponseCreatedAt.md +19 -0
- package/docs/{Location.md → ClubResponseLocation.md} +9 -12
- package/docs/{GetNumberOfClubUsers200Response.md → ClubResponseLocationCoordinates.md} +7 -5
- package/docs/ClubResponseUpdatedAt.md +19 -0
- package/docs/ClubRoleResponse.md +11 -9
- package/docs/ClubRolesManagerApi.md +177 -0
- package/docs/{StaffClubsApi.md → ClubRolesStaffApi.md} +41 -34
- package/docs/{ManagerClubCourtsApi.md → ClubSettingsManagerApi.md} +64 -63
- package/docs/ClubSettingsResponse.md +41 -0
- package/docs/{PublicClubUserFrequentlyVisitedClubsInner.md → ClubSummary.md} +10 -6
- package/docs/{AddFavoriteClubRequestBody.md → ClubUserCountResponse.md} +5 -5
- package/docs/ClubsApi.md +515 -8
- package/docs/ClubsManagerApi.md +1005 -0
- package/docs/{ManagerClubsApi.md → ClubsStaffApi.md} +138 -62
- package/docs/CourtInfo.md +28 -0
- package/docs/CourtResponse.md +16 -16
- package/docs/CourtStatus.md +2 -5
- package/docs/CreateBookingRequest.md +1 -3
- package/docs/CreateClubRequest.md +22 -0
- package/docs/CreateClubRoleRequest.md +24 -0
- package/docs/CreateClubSettingsRequest.md +34 -0
- package/docs/{ActiveClubListResponse.md → CreateCourtForClub201Response.md} +5 -5
- package/docs/CreateCourtRequest.md +10 -12
- package/docs/CreateEventRequest.md +1 -3
- package/docs/CreateSportForClub201Response.md +20 -0
- package/docs/{Sport.md → CreateSportForClubRequest.md} +4 -6
- package/docs/CreateSportRequest.md +1 -7
- package/docs/CreateSubscriptionPlanRequest.md +6 -4
- package/docs/CreatorChargeResult.md +26 -0
- package/docs/DailyTurnoverResponse.md +3 -3
- package/docs/{ManagerSportsApi.md → DefaultApi.md} +35 -38
- package/docs/{DeleteEvent200Response.md → DeleteClubResponse.md} +4 -4
- package/docs/{CourtDeleteResponse.md → DeleteClubRoleResponse.md} +4 -4
- package/docs/DeleteClubSettingsResponse.md +20 -0
- package/docs/{DeleteClubRole200Response.md → DeleteCourtResponse.md} +4 -4
- package/docs/{DeleteSport200Response.md → DeleteEventResponse.md} +4 -4
- package/docs/DeleteSlotsByClubInRange200Response.md +1 -1
- package/docs/DeleteSportResponse.md +20 -0
- package/docs/EventResponse.md +40 -0
- package/docs/EventResponseCourtsInner.md +18 -0
- package/docs/EventsApi.md +21 -21
- package/docs/{StaffEventResponse.md → EventsListResponse.md} +4 -4
- package/docs/{ManagerEventsApi.md → EventsManagerApi.md} +38 -40
- package/docs/{StaffEventsApi.md → EventsStaffApi.md} +11 -10
- package/docs/FavoriteClubsResponse.md +1 -1
- package/docs/FavoritePlayersResponse.md +1 -1
- package/docs/{GenderPercentage.md → GenderPercentageResponse.md} +7 -7
- package/docs/GetActualities200Response.md +20 -0
- package/docs/GetAvailableSlotsBySports200Response.md +20 -0
- package/docs/{ClubMembersResponse.md → GetClubMembers200Response.md} +6 -6
- package/docs/GetClubRoles200Response.md +20 -0
- package/docs/GetClubUsersById200Response.md +1 -1
- package/docs/{CourtsResponse.md → GetCourtsByClub200Response.md} +4 -6
- package/docs/GetCourtsByClubAndSportById200Response.md +26 -0
- package/docs/GetInfillPercentagePerPeriod200Response.md +5 -5
- package/docs/{SlotsResponse.md → GetSlotsByClubById200Response.md} +6 -6
- package/docs/GetSportsByClubById200Response.md +20 -0
- package/docs/{Court.md → ICourtData.md} +18 -6
- package/docs/{DiagnosticsResponse.md → InvoiceInfo.md} +8 -8
- package/docs/{ClubListResponse.md → LastSixMonthsTurnoverItem.md} +7 -7
- package/docs/ManagerCancelBookingRequest.md +1 -1
- package/docs/ManagerCancelBookingResponse.md +2 -2
- package/docs/MonthlyBreakdown.md +24 -0
- package/docs/MonthlyTurnoverResponse.md +6 -5
- package/docs/NoShowFeeResponse.md +6 -6
- package/docs/PartialClubResponse.md +49 -0
- package/docs/PaymentByPlayerInfo.md +22 -0
- package/docs/PaymentMethod.md +2 -1
- package/docs/PlayerPaymentInfo.md +36 -0
- package/docs/PlayerSummary.md +40 -0
- package/docs/PublicUserProfileResponse.md +44 -0
- package/docs/PublishEventResponse.md +20 -0
- package/docs/SlotInfo.md +26 -0
- package/docs/SportAnalyticsResponse.md +24 -0
- package/docs/SportInfo.md +22 -0
- package/docs/SportResponse.md +8 -11
- package/docs/SportWithAnalytics.md +36 -0
- package/docs/SportsManagerApi.md +177 -0
- package/docs/{StaffClubBookingsApi.md → SportsStaffApi.md} +14 -11
- package/docs/SubscriptionPlanResponse.md +4 -14
- package/docs/SurfaceType.md +12 -0
- package/docs/UpdateActuality200Response.md +20 -0
- package/docs/UpdateClubRequest.md +11 -11
- package/docs/UpdateClubRequestLocation.md +29 -0
- package/docs/{BookingPopulatedSlotIdCourtIdSportId.md → UpdateClubRequestLocationCoordinates.md} +7 -7
- package/docs/UpdateClubRoleRequest.md +22 -0
- package/docs/UpdateClubSettingsRequest.md +14 -10
- package/docs/UpdateSportRequest.md +1 -5
- package/docs/UpdateSubscriptionPlanForClub200Response.md +20 -0
- package/docs/{BookingPopulatedUserId.md → UserInfo.md} +6 -6
- package/docs/UserLocationSummary.md +44 -0
- package/docs/UserProfileResponse.md +2 -2
- package/docs/UsersApi.md +38 -133
- package/docs/YearlyTurnoverResponse.md +4 -4
- package/index.ts +2 -2
- package/package.json +1 -1
- package/docs/ActiveClub.md +0 -30
- package/docs/AddClubMemberResponse.md +0 -22
- package/docs/AddPaymentMethodSetupRequestBody.md +0 -20
- package/docs/AddPaymentMethodSetupResponse.md +0 -24
- package/docs/BlockSlotResponse.md +0 -22
- package/docs/Booking.md +0 -32
- package/docs/BookingHistoryResponse.md +0 -22
- package/docs/BookingHistoryResponseHistoryInner.md +0 -32
- package/docs/BookingPaymentStatusResponsePaymentStatusInner.md +0 -36
- package/docs/BookingPopulatedPaymentByPlayersStatusInner.md +0 -22
- package/docs/BookingPopulatedPaymentByPlayersStatusInnerInvoicesInner.md +0 -24
- package/docs/BookingPopulatedSlotId.md +0 -26
- package/docs/BookingPopulatedSlotIdCourtId.md +0 -28
- package/docs/BookingsStaffWeeklyWeekIdGet200Response.md +0 -20
- package/docs/CancelBookingResponseBooking.md +0 -30
- package/docs/CheckInPlayersResponseCheckedInPlayersInner.md +0 -34
- package/docs/Club.md +0 -40
- package/docs/ClubInfoResponse.md +0 -48
- package/docs/ClubMember.md +0 -24
- package/docs/ClubRole.md +0 -30
- package/docs/ClubRolesResponse.md +0 -22
- package/docs/ClubSettings.md +0 -40
- package/docs/ClubStaffResponse.md +0 -48
- package/docs/ConfirmPaymentMethodSetupRequestBody.md +0 -20
- package/docs/ConfirmPaymentMethodSetupResponse.md +0 -22
- package/docs/CourtWithNameResponse.md +0 -48
- package/docs/CourtsWithNameResponse.md +0 -22
- package/docs/CreateClubRoleRequestBody.md +0 -24
- package/docs/CreatePriceRequest.md +0 -26
- package/docs/DiagnosticsApi.md +0 -97
- package/docs/Event.md +0 -40
- package/docs/EventBooking.md +0 -32
- package/docs/EventRegistrationRequest.md +0 -22
- package/docs/FrequentClub.md +0 -24
- package/docs/FrequentlyPlayedWithItem.md +0 -28
- package/docs/FrequentlyVisitedClubItem.md +0 -24
- package/docs/GetActiveClubs200Response.md +0 -20
- package/docs/GetClubInfos200Response.md +0 -30
- package/docs/GetCourtsByClubAndSport200Response.md +0 -26
- package/docs/GetLastSixMonthsTurnover200ResponseInner.md +0 -22
- package/docs/GetPublishedEventsByClubId200Response.md +0 -20
- package/docs/InvoicesResponse.md +0 -22
- package/docs/InvoicesResponseInvoicesInner.md +0 -34
- package/docs/InvoicesResponsePagination.md +0 -26
- package/docs/LevelBySportsItem.md +0 -22
- package/docs/ManagerCancelBookingResponseBooking.md +0 -30
- package/docs/ManagerClubRolesApi.md +0 -268
- package/docs/ManagerClubSlotsApi.md +0 -119
- package/docs/ManagerClubSubscriptionsApi.md +0 -387
- package/docs/ManagerEventResponse.md +0 -22
- package/docs/NoShowFeeResponseCaptureResultsInner.md +0 -30
- package/docs/NoShowFeeResponseCreatorChargeResult.md +0 -26
- package/docs/PaymentStatus.md +0 -30
- package/docs/PriceResponse.md +0 -32
- package/docs/PublicClubUser.md +0 -46
- package/docs/PublicClubUserFrequentlyPlayedWithInner.md +0 -28
- package/docs/PublicClubUserLevelBySportsInner.md +0 -22
- package/docs/RegisterForEvent201Response.md +0 -20
- package/docs/RestoreSubscriptionPlanForClub200Response.md +0 -20
- package/docs/SdkDiagnosticsResponse.md +0 -28
- package/docs/SdkDiagnosticsResponseOpenapi.md +0 -24
- package/docs/SdkDiagnosticsResponseSdk.md +0 -24
- package/docs/Slot.md +0 -24
- package/docs/SlotException.md +0 -26
- package/docs/SlotResponse.md +0 -34
- package/docs/StaffBookingsApi.md +0 -61
- package/docs/StaffClubAnalyticsApi.md +0 -254
- package/docs/StripeLink.md +0 -26
- package/docs/StripeStatus.md +0 -16
- package/docs/SubscriptionPlan.md +0 -36
- package/docs/SubscriptionResponse.md +0 -36
- package/docs/UpdateClubRoleRequestBody.md +0 -24
- package/docs/UpdateCourtRequest.md +0 -38
- package/docs/UpdateProfilePictureRequestBody.md +0 -20
- package/docs/UpdateSubscriptionPlanRequest.md +0 -24
- package/docs/UpdateSubscriptionPlanResponse.md +0 -22
- package/docs/UpdateUserCityRequestBody.md +0 -20
- package/docs/UpdateUserDescriptionRequestBody.md +0 -20
- package/docs/UserBookingItem.md +0 -46
- package/docs/UserClubCourtsApi.md +0 -64
- package/docs/UserClubSlotsApi.md +0 -181
- package/docs/UserClubSportsApi.md +0 -60
- package/docs/UserClubsApi.md +0 -145
- package/docs/UserInfoStaff.md +0 -38
- package/docs/UserStaffResponse.md +0 -40
- package/docs/YearlyTurnoverResponseMonthlyBreakdownInner.md +0 -24
|
@@ -1,29 +1,29 @@
|
|
|
1
|
-
#
|
|
1
|
+
# BookingsManagerApi
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *http://localhost*
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**applyNoShowFee**](#applynoshowfee) | **POST** /api/bookings/{bookingId}/
|
|
8
|
-
|[**managerCancelBooking**](#managercancelbooking) | **
|
|
7
|
+
|[**applyNoShowFee**](#applynoshowfee) | **POST** /api/bookings/{bookingId}/no-show | |
|
|
8
|
+
|[**managerCancelBooking**](#managercancelbooking) | **POST** /api/bookings/{bookingId}/manager-cancel | |
|
|
9
9
|
|
|
10
10
|
# **applyNoShowFee**
|
|
11
11
|
> NoShowFeeResponse applyNoShowFee()
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
Appliquer des frais de no-show
|
|
14
14
|
|
|
15
15
|
### Example
|
|
16
16
|
|
|
17
17
|
```typescript
|
|
18
18
|
import {
|
|
19
|
-
|
|
19
|
+
BookingsManagerApi,
|
|
20
20
|
Configuration
|
|
21
21
|
} from '@tennac-booking/sdk';
|
|
22
22
|
|
|
23
23
|
const configuration = new Configuration();
|
|
24
|
-
const apiInstance = new
|
|
24
|
+
const apiInstance = new BookingsManagerApi(configuration);
|
|
25
25
|
|
|
26
|
-
let bookingId: string; //
|
|
26
|
+
let bookingId: string; // (default to undefined)
|
|
27
27
|
|
|
28
28
|
const { status, data } = await apiInstance.applyNoShowFee(
|
|
29
29
|
bookingId
|
|
@@ -34,7 +34,7 @@ const { status, data } = await apiInstance.applyNoShowFee(
|
|
|
34
34
|
|
|
35
35
|
|Name | Type | Description | Notes|
|
|
36
36
|
|------------- | ------------- | ------------- | -------------|
|
|
37
|
-
| **bookingId** | [**string**] |
|
|
37
|
+
| **bookingId** | [**string**] | | defaults to undefined|
|
|
38
38
|
|
|
39
39
|
|
|
40
40
|
### Return type
|
|
@@ -54,33 +54,28 @@ const { status, data } = await apiInstance.applyNoShowFee(
|
|
|
54
54
|
### HTTP response details
|
|
55
55
|
| Status code | Description | Response headers |
|
|
56
56
|
|-------------|-------------|------------------|
|
|
57
|
-
|**200** | Frais de no-show
|
|
58
|
-
|**400** | Requête invalide | - |
|
|
59
|
-
|**401** | Non autorisé | - |
|
|
60
|
-
|**403** | Accès interdit | - |
|
|
61
|
-
|**404** | Ressource non trouvée | - |
|
|
62
|
-
|**500** | Erreur serveur interne | - |
|
|
57
|
+
|**200** | Frais de no-show appliqué avec succès | - |
|
|
63
58
|
|
|
64
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)
|
|
65
60
|
|
|
66
61
|
# **managerCancelBooking**
|
|
67
62
|
> ManagerCancelBookingResponse managerCancelBooking(managerCancelBookingRequest)
|
|
68
63
|
|
|
69
|
-
|
|
64
|
+
Annuler une réservation (par un gestionnaire)
|
|
70
65
|
|
|
71
66
|
### Example
|
|
72
67
|
|
|
73
68
|
```typescript
|
|
74
69
|
import {
|
|
75
|
-
|
|
70
|
+
BookingsManagerApi,
|
|
76
71
|
Configuration,
|
|
77
72
|
ManagerCancelBookingRequest
|
|
78
73
|
} from '@tennac-booking/sdk';
|
|
79
74
|
|
|
80
75
|
const configuration = new Configuration();
|
|
81
|
-
const apiInstance = new
|
|
76
|
+
const apiInstance = new BookingsManagerApi(configuration);
|
|
82
77
|
|
|
83
|
-
let bookingId: string; //
|
|
78
|
+
let bookingId: string; // (default to undefined)
|
|
84
79
|
let managerCancelBookingRequest: ManagerCancelBookingRequest; //
|
|
85
80
|
|
|
86
81
|
const { status, data } = await apiInstance.managerCancelBooking(
|
|
@@ -94,7 +89,7 @@ const { status, data } = await apiInstance.managerCancelBooking(
|
|
|
94
89
|
|Name | Type | Description | Notes|
|
|
95
90
|
|------------- | ------------- | ------------- | -------------|
|
|
96
91
|
| **managerCancelBookingRequest** | **ManagerCancelBookingRequest**| | |
|
|
97
|
-
| **bookingId** | [**string**] |
|
|
92
|
+
| **bookingId** | [**string**] | | defaults to undefined|
|
|
98
93
|
|
|
99
94
|
|
|
100
95
|
### Return type
|
|
@@ -115,11 +110,6 @@ const { status, data } = await apiInstance.managerCancelBooking(
|
|
|
115
110
|
| Status code | Description | Response headers |
|
|
116
111
|
|-------------|-------------|------------------|
|
|
117
112
|
|**200** | Réservation annulée par le gestionnaire avec succès | - |
|
|
118
|
-
|**400** | Requête invalide | - |
|
|
119
|
-
|**401** | Non autorisé | - |
|
|
120
|
-
|**403** | Accès interdit | - |
|
|
121
|
-
|**404** | Réservation non trouvée | - |
|
|
122
|
-
|**500** | Erreur serveur interne | - |
|
|
123
113
|
|
|
124
114
|
[[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
115
|
|
|
@@ -0,0 +1,323 @@
|
|
|
1
|
+
# BookingsStaffApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**checkInPlayers**](#checkinplayers) | **POST** /api/bookings/{bookingId}/check-in | |
|
|
8
|
+
|[**getBookingById**](#getbookingbyid) | **GET** /api/bookings/{bookingId} | |
|
|
9
|
+
|[**getBookingHistoryStaff**](#getbookinghistorystaff) | **GET** /api/bookings/staff/{bookingId} | |
|
|
10
|
+
|[**getBookingPaymentStatus**](#getbookingpaymentstatus) | **GET** /api/bookings/{bookingId}/payment-status | |
|
|
11
|
+
|[**getDailyBookings**](#getdailybookings) | **GET** /api/bookings/daily/{date} | |
|
|
12
|
+
|[**getWeeklyBookings**](#getweeklybookings) | **GET** /api/bookings/weekly/{weekId} | |
|
|
13
|
+
|
|
14
|
+
# **checkInPlayers**
|
|
15
|
+
> CheckInPlayersResponse checkInPlayers(checkInPlayersRequest)
|
|
16
|
+
|
|
17
|
+
Check-in des joueurs
|
|
18
|
+
|
|
19
|
+
### Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import {
|
|
23
|
+
BookingsStaffApi,
|
|
24
|
+
Configuration,
|
|
25
|
+
CheckInPlayersRequest
|
|
26
|
+
} from '@tennac-booking/sdk';
|
|
27
|
+
|
|
28
|
+
const configuration = new Configuration();
|
|
29
|
+
const apiInstance = new BookingsStaffApi(configuration);
|
|
30
|
+
|
|
31
|
+
let bookingId: string; // (default to undefined)
|
|
32
|
+
let checkInPlayersRequest: CheckInPlayersRequest; //
|
|
33
|
+
|
|
34
|
+
const { status, data } = await apiInstance.checkInPlayers(
|
|
35
|
+
bookingId,
|
|
36
|
+
checkInPlayersRequest
|
|
37
|
+
);
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### Parameters
|
|
41
|
+
|
|
42
|
+
|Name | Type | Description | Notes|
|
|
43
|
+
|------------- | ------------- | ------------- | -------------|
|
|
44
|
+
| **checkInPlayersRequest** | **CheckInPlayersRequest**| | |
|
|
45
|
+
| **bookingId** | [**string**] | | defaults to undefined|
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
### Return type
|
|
49
|
+
|
|
50
|
+
**CheckInPlayersResponse**
|
|
51
|
+
|
|
52
|
+
### Authorization
|
|
53
|
+
|
|
54
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
55
|
+
|
|
56
|
+
### HTTP request headers
|
|
57
|
+
|
|
58
|
+
- **Content-Type**: application/json
|
|
59
|
+
- **Accept**: application/json
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
### HTTP response details
|
|
63
|
+
| Status code | Description | Response headers |
|
|
64
|
+
|-------------|-------------|------------------|
|
|
65
|
+
|**200** | Check-in effectué avec succès | - |
|
|
66
|
+
|
|
67
|
+
[[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)
|
|
68
|
+
|
|
69
|
+
# **getBookingById**
|
|
70
|
+
> BookingPopulated getBookingById()
|
|
71
|
+
|
|
72
|
+
Obtenir une réservation par ID
|
|
73
|
+
|
|
74
|
+
### Example
|
|
75
|
+
|
|
76
|
+
```typescript
|
|
77
|
+
import {
|
|
78
|
+
BookingsStaffApi,
|
|
79
|
+
Configuration
|
|
80
|
+
} from '@tennac-booking/sdk';
|
|
81
|
+
|
|
82
|
+
const configuration = new Configuration();
|
|
83
|
+
const apiInstance = new BookingsStaffApi(configuration);
|
|
84
|
+
|
|
85
|
+
let bookingId: string; // (default to undefined)
|
|
86
|
+
|
|
87
|
+
const { status, data } = await apiInstance.getBookingById(
|
|
88
|
+
bookingId
|
|
89
|
+
);
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
### Parameters
|
|
93
|
+
|
|
94
|
+
|Name | Type | Description | Notes|
|
|
95
|
+
|------------- | ------------- | ------------- | -------------|
|
|
96
|
+
| **bookingId** | [**string**] | | defaults to undefined|
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
### Return type
|
|
100
|
+
|
|
101
|
+
**BookingPopulated**
|
|
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** | Réservation récupérée | - |
|
|
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
|
+
# **getBookingHistoryStaff**
|
|
121
|
+
> BookingHistory getBookingHistoryStaff()
|
|
122
|
+
|
|
123
|
+
Obtenir l\'historique d\'une réservation par ID
|
|
124
|
+
|
|
125
|
+
### Example
|
|
126
|
+
|
|
127
|
+
```typescript
|
|
128
|
+
import {
|
|
129
|
+
BookingsStaffApi,
|
|
130
|
+
Configuration
|
|
131
|
+
} from '@tennac-booking/sdk';
|
|
132
|
+
|
|
133
|
+
const configuration = new Configuration();
|
|
134
|
+
const apiInstance = new BookingsStaffApi(configuration);
|
|
135
|
+
|
|
136
|
+
let bookingId: string; // (default to undefined)
|
|
137
|
+
|
|
138
|
+
const { status, data } = await apiInstance.getBookingHistoryStaff(
|
|
139
|
+
bookingId
|
|
140
|
+
);
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
### Parameters
|
|
144
|
+
|
|
145
|
+
|Name | Type | Description | Notes|
|
|
146
|
+
|------------- | ------------- | ------------- | -------------|
|
|
147
|
+
| **bookingId** | [**string**] | | defaults to undefined|
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
### Return type
|
|
151
|
+
|
|
152
|
+
**BookingHistory**
|
|
153
|
+
|
|
154
|
+
### Authorization
|
|
155
|
+
|
|
156
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
157
|
+
|
|
158
|
+
### HTTP request headers
|
|
159
|
+
|
|
160
|
+
- **Content-Type**: Not defined
|
|
161
|
+
- **Accept**: application/json
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
### HTTP response details
|
|
165
|
+
| Status code | Description | Response headers |
|
|
166
|
+
|-------------|-------------|------------------|
|
|
167
|
+
|**200** | Réservation récupérée | - |
|
|
168
|
+
|
|
169
|
+
[[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)
|
|
170
|
+
|
|
171
|
+
# **getBookingPaymentStatus**
|
|
172
|
+
> BookingPaymentStatusResponse getBookingPaymentStatus()
|
|
173
|
+
|
|
174
|
+
Obtenir le statut des paiements d\'une réservation
|
|
175
|
+
|
|
176
|
+
### Example
|
|
177
|
+
|
|
178
|
+
```typescript
|
|
179
|
+
import {
|
|
180
|
+
BookingsStaffApi,
|
|
181
|
+
Configuration
|
|
182
|
+
} from '@tennac-booking/sdk';
|
|
183
|
+
|
|
184
|
+
const configuration = new Configuration();
|
|
185
|
+
const apiInstance = new BookingsStaffApi(configuration);
|
|
186
|
+
|
|
187
|
+
let bookingId: string; // (default to undefined)
|
|
188
|
+
|
|
189
|
+
const { status, data } = await apiInstance.getBookingPaymentStatus(
|
|
190
|
+
bookingId
|
|
191
|
+
);
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
### Parameters
|
|
195
|
+
|
|
196
|
+
|Name | Type | Description | Notes|
|
|
197
|
+
|------------- | ------------- | ------------- | -------------|
|
|
198
|
+
| **bookingId** | [**string**] | | defaults to undefined|
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
### Return type
|
|
202
|
+
|
|
203
|
+
**BookingPaymentStatusResponse**
|
|
204
|
+
|
|
205
|
+
### Authorization
|
|
206
|
+
|
|
207
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
208
|
+
|
|
209
|
+
### HTTP request headers
|
|
210
|
+
|
|
211
|
+
- **Content-Type**: Not defined
|
|
212
|
+
- **Accept**: application/json
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
### HTTP response details
|
|
216
|
+
| Status code | Description | Response headers |
|
|
217
|
+
|-------------|-------------|------------------|
|
|
218
|
+
|**200** | Statut des paiements récupéré | - |
|
|
219
|
+
|
|
220
|
+
[[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)
|
|
221
|
+
|
|
222
|
+
# **getDailyBookings**
|
|
223
|
+
> Array<BookingPopulated> getDailyBookings()
|
|
224
|
+
|
|
225
|
+
Obtenir les réservations journalières
|
|
226
|
+
|
|
227
|
+
### Example
|
|
228
|
+
|
|
229
|
+
```typescript
|
|
230
|
+
import {
|
|
231
|
+
BookingsStaffApi,
|
|
232
|
+
Configuration
|
|
233
|
+
} from '@tennac-booking/sdk';
|
|
234
|
+
|
|
235
|
+
const configuration = new Configuration();
|
|
236
|
+
const apiInstance = new BookingsStaffApi(configuration);
|
|
237
|
+
|
|
238
|
+
let date: string; // (default to undefined)
|
|
239
|
+
|
|
240
|
+
const { status, data } = await apiInstance.getDailyBookings(
|
|
241
|
+
date
|
|
242
|
+
);
|
|
243
|
+
```
|
|
244
|
+
|
|
245
|
+
### Parameters
|
|
246
|
+
|
|
247
|
+
|Name | Type | Description | Notes|
|
|
248
|
+
|------------- | ------------- | ------------- | -------------|
|
|
249
|
+
| **date** | [**string**] | | defaults to undefined|
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
### Return type
|
|
253
|
+
|
|
254
|
+
**Array<BookingPopulated>**
|
|
255
|
+
|
|
256
|
+
### Authorization
|
|
257
|
+
|
|
258
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
259
|
+
|
|
260
|
+
### HTTP request headers
|
|
261
|
+
|
|
262
|
+
- **Content-Type**: Not defined
|
|
263
|
+
- **Accept**: application/json
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
### HTTP response details
|
|
267
|
+
| Status code | Description | Response headers |
|
|
268
|
+
|-------------|-------------|------------------|
|
|
269
|
+
|**200** | Réservations journalières récupérées | - |
|
|
270
|
+
|
|
271
|
+
[[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)
|
|
272
|
+
|
|
273
|
+
# **getWeeklyBookings**
|
|
274
|
+
> Array<BookingPopulated> getWeeklyBookings()
|
|
275
|
+
|
|
276
|
+
Obtenir les réservations hebdomadaires
|
|
277
|
+
|
|
278
|
+
### Example
|
|
279
|
+
|
|
280
|
+
```typescript
|
|
281
|
+
import {
|
|
282
|
+
BookingsStaffApi,
|
|
283
|
+
Configuration
|
|
284
|
+
} from '@tennac-booking/sdk';
|
|
285
|
+
|
|
286
|
+
const configuration = new Configuration();
|
|
287
|
+
const apiInstance = new BookingsStaffApi(configuration);
|
|
288
|
+
|
|
289
|
+
let weekId: string; // (default to undefined)
|
|
290
|
+
|
|
291
|
+
const { status, data } = await apiInstance.getWeeklyBookings(
|
|
292
|
+
weekId
|
|
293
|
+
);
|
|
294
|
+
```
|
|
295
|
+
|
|
296
|
+
### Parameters
|
|
297
|
+
|
|
298
|
+
|Name | Type | Description | Notes|
|
|
299
|
+
|------------- | ------------- | ------------- | -------------|
|
|
300
|
+
| **weekId** | [**string**] | | defaults to undefined|
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
### Return type
|
|
304
|
+
|
|
305
|
+
**Array<BookingPopulated>**
|
|
306
|
+
|
|
307
|
+
### Authorization
|
|
308
|
+
|
|
309
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
310
|
+
|
|
311
|
+
### HTTP request headers
|
|
312
|
+
|
|
313
|
+
- **Content-Type**: Not defined
|
|
314
|
+
- **Accept**: application/json
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
### HTTP response details
|
|
318
|
+
| Status code | Description | Response headers |
|
|
319
|
+
|-------------|-------------|------------------|
|
|
320
|
+
|**200** | Réservations hebdomadaires récupérées | - |
|
|
321
|
+
|
|
322
|
+
[[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)
|
|
323
|
+
|
|
@@ -1,32 +1,32 @@
|
|
|
1
|
-
#
|
|
1
|
+
# BookingsUserApi
|
|
2
2
|
|
|
3
3
|
All URIs are relative to *http://localhost*
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**
|
|
8
|
-
|[**createBooking**](#createbooking) | **POST** /api/bookings |
|
|
7
|
+
|[**cancelBooking**](#cancelbooking) | **DELETE** /api/bookings/{bookingId} | |
|
|
8
|
+
|[**createBooking**](#createbooking) | **POST** /api/bookings | |
|
|
9
9
|
|
|
10
|
-
# **
|
|
11
|
-
>
|
|
10
|
+
# **cancelBooking**
|
|
11
|
+
> CancelBookingResponse cancelBooking()
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
Annuler une réservation (par le créateur)
|
|
14
14
|
|
|
15
15
|
### Example
|
|
16
16
|
|
|
17
17
|
```typescript
|
|
18
18
|
import {
|
|
19
|
-
|
|
19
|
+
BookingsUserApi,
|
|
20
20
|
Configuration
|
|
21
21
|
} from '@tennac-booking/sdk';
|
|
22
22
|
|
|
23
23
|
const configuration = new Configuration();
|
|
24
|
-
const apiInstance = new
|
|
24
|
+
const apiInstance = new BookingsUserApi(configuration);
|
|
25
25
|
|
|
26
|
-
let
|
|
26
|
+
let bookingId: string; // (default to undefined)
|
|
27
27
|
|
|
28
|
-
const { status, data } = await apiInstance.
|
|
29
|
-
|
|
28
|
+
const { status, data } = await apiInstance.cancelBooking(
|
|
29
|
+
bookingId
|
|
30
30
|
);
|
|
31
31
|
```
|
|
32
32
|
|
|
@@ -34,12 +34,12 @@ const { status, data } = await apiInstance.blockSlot(
|
|
|
34
34
|
|
|
35
35
|
|Name | Type | Description | Notes|
|
|
36
36
|
|------------- | ------------- | ------------- | -------------|
|
|
37
|
-
| **
|
|
37
|
+
| **bookingId** | [**string**] | | defaults to undefined|
|
|
38
38
|
|
|
39
39
|
|
|
40
40
|
### Return type
|
|
41
41
|
|
|
42
|
-
**
|
|
42
|
+
**CancelBookingResponse**
|
|
43
43
|
|
|
44
44
|
### Authorization
|
|
45
45
|
|
|
@@ -54,30 +54,26 @@ const { status, data } = await apiInstance.blockSlot(
|
|
|
54
54
|
### HTTP response details
|
|
55
55
|
| Status code | Description | Response headers |
|
|
56
56
|
|-------------|-------------|------------------|
|
|
57
|
-
|**200** |
|
|
58
|
-
|**400** | Requête invalide | - |
|
|
59
|
-
|**401** | Non autorisé | - |
|
|
60
|
-
|**404** | Ressource non trouvée | - |
|
|
61
|
-
|**500** | Erreur serveur interne | - |
|
|
57
|
+
|**200** | Réservation annulée avec succès | - |
|
|
62
58
|
|
|
63
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)
|
|
64
60
|
|
|
65
61
|
# **createBooking**
|
|
66
62
|
> BookingResponse createBooking(createBookingRequest)
|
|
67
63
|
|
|
68
|
-
|
|
64
|
+
Créer une réservation Gère tous les scénarios de paiement (créateur paie tout, paiement divisé, gratuit)
|
|
69
65
|
|
|
70
66
|
### Example
|
|
71
67
|
|
|
72
68
|
```typescript
|
|
73
69
|
import {
|
|
74
|
-
|
|
70
|
+
BookingsUserApi,
|
|
75
71
|
Configuration,
|
|
76
72
|
CreateBookingRequest
|
|
77
73
|
} from '@tennac-booking/sdk';
|
|
78
74
|
|
|
79
75
|
const configuration = new Configuration();
|
|
80
|
-
const apiInstance = new
|
|
76
|
+
const apiInstance = new BookingsUserApi(configuration);
|
|
81
77
|
|
|
82
78
|
let createBookingRequest: CreateBookingRequest; //
|
|
83
79
|
|
|
@@ -111,10 +107,6 @@ const { status, data } = await apiInstance.createBooking(
|
|
|
111
107
|
| Status code | Description | Response headers |
|
|
112
108
|
|-------------|-------------|------------------|
|
|
113
109
|
|**201** | Réservation créée avec succès | - |
|
|
114
|
-
|**400** | Requête invalide | - |
|
|
115
|
-
|**401** | Non autorisé | - |
|
|
116
|
-
|**404** | Ressource non trouvée | - |
|
|
117
|
-
|**500** | Erreur serveur interne | - |
|
|
118
110
|
|
|
119
111
|
[[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)
|
|
120
112
|
|
|
@@ -5,8 +5,8 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**message** | **string** |
|
|
9
|
-
**booking** | [**
|
|
8
|
+
**message** | **string** | Message de confirmation | [default to undefined]
|
|
9
|
+
**booking** | [**BookingInfo**](BookingInfo.md) | | [default to undefined]
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# CaptureResult
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**type** | **string** | Type de paiement | [default to undefined]
|
|
9
|
+
**playerId** | **string** | ID du joueur (optionnel) | [optional] [default to undefined]
|
|
10
|
+
**paymentIntentId** | **string** | ID du PaymentIntent Stripe | [default to undefined]
|
|
11
|
+
**amount** | **number** | Montant capturé | [optional] [default to undefined]
|
|
12
|
+
**status** | **string** | Statut de la capture | [default to undefined]
|
|
13
|
+
**error** | **string** | Erreur (si échoué) | [optional] [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { CaptureResult } from '@tennac-booking/sdk';
|
|
19
|
+
|
|
20
|
+
const instance: CaptureResult = {
|
|
21
|
+
type,
|
|
22
|
+
playerId,
|
|
23
|
+
paymentIntentId,
|
|
24
|
+
amount,
|
|
25
|
+
status,
|
|
26
|
+
error,
|
|
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,20 @@
|
|
|
1
|
+
# CheckInPlayersRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**playerIds** | **Array<string>** | Liste des IDs des joueurs qui ont payé/sont arrivés | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { CheckInPlayersRequest } from '@tennac-booking/sdk';
|
|
14
|
+
|
|
15
|
+
const instance: CheckInPlayersRequest = {
|
|
16
|
+
playerIds,
|
|
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,12 +5,12 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**message** | **string** |
|
|
9
|
-
**checkedInPlayers** | [**Array<
|
|
10
|
-
**notFoundPlayers** | **Array<string>** |
|
|
11
|
-
**allPlayersCheckedIn** | **boolean** |
|
|
12
|
-
**bookingFullyPaid** | **boolean** |
|
|
13
|
-
**totalPlayers** | **number** |
|
|
8
|
+
**message** | **string** | Message de confirmation | [default to undefined]
|
|
9
|
+
**checkedInPlayers** | [**Array<CheckedInPlayer>**](CheckedInPlayer.md) | Joueurs ayant effectué le check-in | [default to undefined]
|
|
10
|
+
**notFoundPlayers** | **Array<string>** | Joueurs non trouvés | [default to undefined]
|
|
11
|
+
**allPlayersCheckedIn** | **boolean** | Tous les joueurs ont fait le check-in | [default to undefined]
|
|
12
|
+
**bookingFullyPaid** | **boolean** | Réservation entièrement payée | [default to undefined]
|
|
13
|
+
**totalPlayers** | **number** | Nombre total de joueurs | [default to undefined]
|
|
14
14
|
|
|
15
15
|
## Example
|
|
16
16
|
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# CheckedInPlayer
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**playerId** | **string** | ID du joueur | [default to undefined]
|
|
9
|
+
**invoiceId** | **string** | ID de la facture | [default to undefined]
|
|
10
|
+
**amount** | **number** | Montant payé | [default to undefined]
|
|
11
|
+
**previousStatus** | **string** | Statut précédent (optionnel) | [optional] [default to undefined]
|
|
12
|
+
**newStatus** | **string** | Nouveau statut (optionnel) | [optional] [default to undefined]
|
|
13
|
+
**status** | **string** | Statut actuel | [optional] [default to undefined]
|
|
14
|
+
**paymentMethod** | [**PaymentMethod**](PaymentMethod.md) | | [optional] [default to undefined]
|
|
15
|
+
**note** | **string** | Note additionnelle | [optional] [default to undefined]
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { CheckedInPlayer } from '@tennac-booking/sdk';
|
|
21
|
+
|
|
22
|
+
const instance: CheckedInPlayer = {
|
|
23
|
+
playerId,
|
|
24
|
+
invoiceId,
|
|
25
|
+
amount,
|
|
26
|
+
previousStatus,
|
|
27
|
+
newStatus,
|
|
28
|
+
status,
|
|
29
|
+
paymentMethod,
|
|
30
|
+
note,
|
|
31
|
+
};
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|