@tennac-booking/sdk 1.0.227 → 1.0.229
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 +51 -29
- package/README.md +76 -48
- package/api.ts +4783 -3563
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +4841 -3732
- package/dist/api.js +2058 -1812
- 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 +4841 -3732
- package/dist/esm/api.js +1788 -1538
- 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/AgendaBooking.md +2 -0
- package/docs/AuthApi.md +113 -0
- package/docs/BookingClubInfo.md +2 -0
- package/docs/BookingPopulated.md +9 -1
- package/docs/BookingSummary.md +6 -4
- package/docs/BookingsApi.md +29 -80
- package/docs/BookingsStaffApi.md +1 -57
- package/docs/BookingsUserApi.md +58 -6
- package/docs/{CheckInPlayerSumupResponse.md → CloseOpenBookingResponse.md} +5 -7
- package/docs/ClubPageResponse.md +16 -0
- package/docs/ClubPageResponseClubCustomerStatus.md +27 -0
- package/docs/ClubPageResponseSportsIdsLookup.md +23 -0
- package/docs/ClubPricingPeriodPayload.md +32 -0
- package/docs/ClubPricingPeriodResponse.md +6 -6
- package/docs/ClubReservationSettingsResponse.md +2 -2
- package/docs/ClubResponse.md +12 -2
- package/docs/ClubSummary.md +6 -0
- package/docs/ComingEventsPageResponse.md +22 -0
- package/docs/CourtEnvironment.md +10 -0
- package/docs/CreateBookingRequest.md +0 -2
- package/docs/CreateOpenBookingRequest.md +6 -4
- package/docs/CreateSubscriptionPlanRequestDiscount.md +4 -0
- package/docs/EstimateOpenBookingJoinRequest.md +24 -0
- package/docs/EventBookingDetailSummary.md +2 -0
- package/docs/EventBookingResponse.md +2 -0
- package/docs/EventResponse.md +2 -0
- package/docs/EventsApi.md +113 -0
- package/docs/EventsStaffApi.md +119 -25
- package/docs/GetClubsWithVerificationDomains200ResponseInner.md +2 -0
- package/docs/GetOpenEventBookingsBySport200Response.md +20 -0
- package/docs/GetOpenEventBookingsBySport200ResponseEventBookingsInner.md +46 -0
- package/docs/{SumupPairReaderResponse.md → Health200Response.md} +7 -5
- package/docs/IUserAttributes.md +4 -0
- package/docs/{SumupReaderInfoDevice.md → JobResult.md} +9 -7
- package/docs/JobsApi.md +367 -0
- package/docs/JoinOpenBookingRequest.md +28 -0
- package/docs/MarkNotificationsReadRequest.md +22 -0
- package/docs/{SumupConnectUrlResponse.md → MarkNotificationsReadResponse.md} +5 -5
- package/docs/MyClubInfosResponse.md +0 -2
- package/docs/{PaymentStatus.md → NotificationActorType.md} +4 -6
- package/docs/NotificationData.md +22 -0
- package/docs/NotificationInitiator.md +28 -0
- package/docs/NotificationParticipantPreview.md +24 -0
- package/docs/NotificationPreview.md +78 -0
- package/docs/NotificationResponse.md +46 -0
- package/docs/{SumupUpdateReaderRequest.md → NotificationResponseClub.md} +7 -5
- package/docs/NotificationSlotPreview.md +24 -0
- package/docs/NotificationSportPreview.md +24 -0
- package/docs/{SumupReaderStatusResponse.md → NotificationTargetPreview.md} +7 -5
- package/docs/NotificationType.md +26 -0
- package/docs/OpenBookingBasePriceResponse.md +24 -0
- package/docs/OpenBookingInfo.md +7 -5
- package/docs/OpenBookingJoinEstimateResponse.md +26 -0
- package/docs/OpenBookingPriceBody.md +26 -0
- package/docs/PartnerSearchItem.md +28 -0
- package/docs/PartnerSearchResponse.md +22 -0
- package/docs/PartnerSearchResponseMeta.md +26 -0
- package/docs/PlayerPrice.md +3 -1
- package/docs/PricingPeriodDiscount.md +24 -0
- package/docs/PublicEmailApi.md +4 -4
- package/docs/QuickReservationClubSummary.md +12 -0
- package/docs/QuickReservationCourtType.md +10 -0
- package/docs/RequestOrganizationEmailCodeBody.md +22 -0
- package/docs/RequestOrganizationEmailCodeResponse.md +22 -0
- package/docs/RequestVerificationCodeBody.md +26 -0
- package/docs/{SumupReaderResponse.md → RequestVerificationCodeResponse.md} +5 -5
- package/docs/SportResponse.md +2 -0
- package/docs/StaffEventBookingResponse.md +2 -0
- package/docs/StaffEventsPageResponse.md +22 -0
- package/docs/StaffUserProfileResponse.md +4 -0
- package/docs/SubscriptionPlanDiscountResponse.md +2 -0
- package/docs/SubscriptionPlanDiscountUpdateRequest.md +2 -0
- package/docs/{PaymentProviderType.md → SupportedLanguage.md} +3 -3
- package/docs/UpdateClubHoursSettingsRequest.md +1 -1
- package/docs/UpdateClubReservationSettingsRequest.md +2 -2
- package/docs/UserClubMembership.md +2 -0
- package/docs/UserNextBookingSummary.md +26 -0
- package/docs/UserNotificationsResponse.md +22 -0
- package/docs/UserNotificationsResponseMeta.md +28 -0
- package/docs/UserProfileResponse.md +12 -0
- package/docs/UsersApi.md +273 -0
- package/docs/VerifyOrganizationEmailCodeBody.md +24 -0
- package/docs/VerifyOrganizationEmailCodeResponse.md +22 -0
- package/docs/VerifyVerificationCodeBody.md +24 -0
- package/docs/{SumupCancelPaymentRequest.md → VerifyVerificationCodeResponse.md} +5 -5
- package/docs/WaitListEntryWithPlayer.md +44 -0
- package/docs/WaitListPlayer.md +28 -0
- package/docs/WaitListPlayersListResponse.md +22 -0
- package/docs/WaitListStaffApi.md +55 -0
- package/index.ts +1 -1
- package/package.json +1 -1
- package/docs/CheckInPlayerSumupRequest.md +0 -22
- package/docs/CheckInSumupPaymentInfo.md +0 -26
- package/docs/GetOpenBookingPrice200Response.md +0 -24
- package/docs/GetOpenBookingPriceRequest.md +0 -26
- package/docs/JoinPriceEstimateResponse.md +0 -38
- package/docs/JoinPriceEstimateResponseSubscriptionInfo.md +0 -25
- package/docs/OpenBookingSlotInfo.md +0 -24
- package/docs/PaymentIntentResult.md +0 -28
- package/docs/PaymentsStaffApi.md +0 -124
- package/docs/StaffEventsPaginatedResponse.md +0 -26
- package/docs/SumUpApi.md +0 -63
- package/docs/SumUpManagerApi.md +0 -617
- package/docs/SumupAccountStatusResponse.md +0 -32
- package/docs/SumupCreatePaymentRequest.md +0 -32
- package/docs/SumupOAuthCallbackResponse.md +0 -24
- package/docs/SumupPairReaderRequest.md +0 -24
- package/docs/SumupReaderInfo.md +0 -42
- package/docs/SumupReaderStatusInfo.md +0 -32
- package/docs/SumupReadersResponse.md +0 -20
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# WaitListPlayersListResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**waitList** | [**Array<WaitListEntryWithPlayer>**](WaitListEntryWithPlayer.md) | | [default to undefined]
|
|
9
|
+
**total** | **number** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { WaitListPlayersListResponse } from '@tennac-booking/sdk';
|
|
15
|
+
|
|
16
|
+
const instance: WaitListPlayersListResponse = {
|
|
17
|
+
waitList,
|
|
18
|
+
total,
|
|
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)
|
package/docs/WaitListStaffApi.md
CHANGED
|
@@ -7,6 +7,7 @@ All URIs are relative to *http://localhost*
|
|
|
7
7
|
|[**getBookingWaitList**](#getbookingwaitlist) | **GET** /api/waitlist/booking/{bookingId}/list | |
|
|
8
8
|
|[**getEventBookingWaitList**](#geteventbookingwaitlist) | **GET** /api/waitlist/event-booking/{eventBookingId}/list | |
|
|
9
9
|
|[**getEventWaitList**](#geteventwaitlist) | **GET** /api/waitlist/event/{eventId}/list | |
|
|
10
|
+
|[**getEventWaitListPlayers**](#geteventwaitlistplayers) | **GET** /api/waitlist/event/{eventId}/players | |
|
|
10
11
|
|[**processBookingWaitList**](#processbookingwaitlist) | **POST** /api/waitlist/booking/{bookingId}/process | |
|
|
11
12
|
|[**processEventBookingWaitList**](#processeventbookingwaitlist) | **POST** /api/waitlist/event-booking/{eventBookingId}/process | |
|
|
12
13
|
|[**processEventWaitList**](#processeventwaitlist) | **POST** /api/waitlist/event/{eventId}/process | |
|
|
@@ -170,6 +171,60 @@ const { status, data } = await apiInstance.getEventWaitList(
|
|
|
170
171
|
|
|
171
172
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
172
173
|
|
|
174
|
+
# **getEventWaitListPlayers**
|
|
175
|
+
> WaitListPlayersListResponse getEventWaitListPlayers()
|
|
176
|
+
|
|
177
|
+
Obtenir la liste des joueurs dans la file d\'attente pour un event (staff only)
|
|
178
|
+
|
|
179
|
+
### Example
|
|
180
|
+
|
|
181
|
+
```typescript
|
|
182
|
+
import {
|
|
183
|
+
WaitListStaffApi,
|
|
184
|
+
Configuration
|
|
185
|
+
} from '@tennac-booking/sdk';
|
|
186
|
+
|
|
187
|
+
const configuration = new Configuration();
|
|
188
|
+
const apiInstance = new WaitListStaffApi(configuration);
|
|
189
|
+
|
|
190
|
+
let eventId: string; // (default to undefined)
|
|
191
|
+
|
|
192
|
+
const { status, data } = await apiInstance.getEventWaitListPlayers(
|
|
193
|
+
eventId
|
|
194
|
+
);
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
### Parameters
|
|
198
|
+
|
|
199
|
+
|Name | Type | Description | Notes|
|
|
200
|
+
|------------- | ------------- | ------------- | -------------|
|
|
201
|
+
| **eventId** | [**string**] | | defaults to undefined|
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
### Return type
|
|
205
|
+
|
|
206
|
+
**WaitListPlayersListResponse**
|
|
207
|
+
|
|
208
|
+
### Authorization
|
|
209
|
+
|
|
210
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
211
|
+
|
|
212
|
+
### HTTP request headers
|
|
213
|
+
|
|
214
|
+
- **Content-Type**: Not defined
|
|
215
|
+
- **Accept**: application/json
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
### HTTP response details
|
|
219
|
+
| Status code | Description | Response headers |
|
|
220
|
+
|-------------|-------------|------------------|
|
|
221
|
+
|**200** | Joueurs en file d\'attente récupérés avec succès | - |
|
|
222
|
+
|**400** | Requête invalide | - |
|
|
223
|
+
|**404** | Événement non trouvé | - |
|
|
224
|
+
|**500** | Erreur serveur | - |
|
|
225
|
+
|
|
226
|
+
[[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)
|
|
227
|
+
|
|
173
228
|
# **processBookingWaitList**
|
|
174
229
|
> LeaveEventWaitList200Response processBookingWaitList()
|
|
175
230
|
|
package/index.ts
CHANGED
package/package.json
CHANGED
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
# CheckInPlayerSumupRequest
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**playerId** | **string** | ID du joueur qui a payé/est arrivé | [default to undefined]
|
|
9
|
-
**readerId** | **string** | Reader SumUp ciblé (optionnel) | [optional] [default to undefined]
|
|
10
|
-
|
|
11
|
-
## Example
|
|
12
|
-
|
|
13
|
-
```typescript
|
|
14
|
-
import { CheckInPlayerSumupRequest } from '@tennac-booking/sdk';
|
|
15
|
-
|
|
16
|
-
const instance: CheckInPlayerSumupRequest = {
|
|
17
|
-
playerId,
|
|
18
|
-
readerId,
|
|
19
|
-
};
|
|
20
|
-
```
|
|
21
|
-
|
|
22
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
# CheckInSumupPaymentInfo
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**paymentId** | **string** | ID du paiement SumUp | [default to undefined]
|
|
9
|
-
**checkoutId** | **string** | ID du checkout SumUp | [optional] [default to undefined]
|
|
10
|
-
**status** | [**PaymentStatus**](PaymentStatus.md) | | [default to undefined]
|
|
11
|
-
**readerId** | **string** | Reader SumUp utilisé | [optional] [default to undefined]
|
|
12
|
-
|
|
13
|
-
## Example
|
|
14
|
-
|
|
15
|
-
```typescript
|
|
16
|
-
import { CheckInSumupPaymentInfo } from '@tennac-booking/sdk';
|
|
17
|
-
|
|
18
|
-
const instance: CheckInSumupPaymentInfo = {
|
|
19
|
-
paymentId,
|
|
20
|
-
checkoutId,
|
|
21
|
-
status,
|
|
22
|
-
readerId,
|
|
23
|
-
};
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
# GetOpenBookingPrice200Response
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**totalBasePrice** | **number** | | [default to undefined]
|
|
9
|
-
**playersPrices** | [**Array<PlayerPrice>**](PlayerPrice.md) | | [default to undefined]
|
|
10
|
-
**basePricePerPlayer** | **number** | | [default to undefined]
|
|
11
|
-
|
|
12
|
-
## Example
|
|
13
|
-
|
|
14
|
-
```typescript
|
|
15
|
-
import { GetOpenBookingPrice200Response } from '@tennac-booking/sdk';
|
|
16
|
-
|
|
17
|
-
const instance: GetOpenBookingPrice200Response = {
|
|
18
|
-
totalBasePrice,
|
|
19
|
-
playersPrices,
|
|
20
|
-
basePricePerPlayer,
|
|
21
|
-
};
|
|
22
|
-
```
|
|
23
|
-
|
|
24
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
# GetOpenBookingPriceRequest
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**creditsByPlayer** | **{ [key: string]: number; }** | Construct a type with a set of properties K of type T | [optional] [default to undefined]
|
|
9
|
-
**initialPlayerIds** | **Array<string>** | | [optional] [default to undefined]
|
|
10
|
-
**maxPlayers** | **number** | | [default to undefined]
|
|
11
|
-
**slotIds** | **Array<string>** | | [default to undefined]
|
|
12
|
-
|
|
13
|
-
## Example
|
|
14
|
-
|
|
15
|
-
```typescript
|
|
16
|
-
import { GetOpenBookingPriceRequest } from '@tennac-booking/sdk';
|
|
17
|
-
|
|
18
|
-
const instance: GetOpenBookingPriceRequest = {
|
|
19
|
-
creditsByPlayer,
|
|
20
|
-
initialPlayerIds,
|
|
21
|
-
maxPlayers,
|
|
22
|
-
slotIds,
|
|
23
|
-
};
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,38 +0,0 @@
|
|
|
1
|
-
# JoinPriceEstimateResponse
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**bookingId** | **string** | ID de la réservation | [default to undefined]
|
|
9
|
-
**basePrice** | **number** | Prix de base sans réductions (en centimes) | [default to undefined]
|
|
10
|
-
**priceAfterSubscription** | **number** | Prix après application de l\'abonnement (en centimes) | [default to undefined]
|
|
11
|
-
**subscriptionDiscount** | **number** | Montant de la réduction d\'abonnement (en centimes) | [default to undefined]
|
|
12
|
-
**subscriptionInfo** | [**JoinPriceEstimateResponseSubscriptionInfo**](JoinPriceEstimateResponseSubscriptionInfo.md) | | [optional] [default to undefined]
|
|
13
|
-
**availableCreditsInCents** | **number** | Crédits disponibles pour le joueur dans ce club (en centimes) | [default to undefined]
|
|
14
|
-
**creditToUseInCents** | **number** | Crédits qui seront utilisés (en centimes) | [default to undefined]
|
|
15
|
-
**finalPriceInCents** | **number** | Prix final après toutes les réductions et crédits (en centimes) | [default to undefined]
|
|
16
|
-
**canJoin** | **boolean** | Indique si le joueur peut rejoindre la réservation | [default to undefined]
|
|
17
|
-
**reason** | **string** | Raison si le joueur ne peut pas rejoindre | [optional] [default to undefined]
|
|
18
|
-
|
|
19
|
-
## Example
|
|
20
|
-
|
|
21
|
-
```typescript
|
|
22
|
-
import { JoinPriceEstimateResponse } from '@tennac-booking/sdk';
|
|
23
|
-
|
|
24
|
-
const instance: JoinPriceEstimateResponse = {
|
|
25
|
-
bookingId,
|
|
26
|
-
basePrice,
|
|
27
|
-
priceAfterSubscription,
|
|
28
|
-
subscriptionDiscount,
|
|
29
|
-
subscriptionInfo,
|
|
30
|
-
availableCreditsInCents,
|
|
31
|
-
creditToUseInCents,
|
|
32
|
-
finalPriceInCents,
|
|
33
|
-
canJoin,
|
|
34
|
-
reason,
|
|
35
|
-
};
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
# JoinPriceEstimateResponseSubscriptionInfo
|
|
2
|
-
|
|
3
|
-
Informations sur l\'abonnement du joueur
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type | Description | Notes
|
|
8
|
-
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**subscriptionName** | **string** | | [optional] [default to undefined]
|
|
10
|
-
**discountPercentage** | **number** | | [optional] [default to undefined]
|
|
11
|
-
**hasSubscription** | **boolean** | | [default to undefined]
|
|
12
|
-
|
|
13
|
-
## Example
|
|
14
|
-
|
|
15
|
-
```typescript
|
|
16
|
-
import { JoinPriceEstimateResponseSubscriptionInfo } from '@tennac-booking/sdk';
|
|
17
|
-
|
|
18
|
-
const instance: JoinPriceEstimateResponseSubscriptionInfo = {
|
|
19
|
-
subscriptionName,
|
|
20
|
-
discountPercentage,
|
|
21
|
-
hasSubscription,
|
|
22
|
-
};
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
# OpenBookingSlotInfo
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**id** | **string** | ID du slot | [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
|
-
|
|
12
|
-
## Example
|
|
13
|
-
|
|
14
|
-
```typescript
|
|
15
|
-
import { OpenBookingSlotInfo } from '@tennac-booking/sdk';
|
|
16
|
-
|
|
17
|
-
const instance: OpenBookingSlotInfo = {
|
|
18
|
-
id,
|
|
19
|
-
startDate,
|
|
20
|
-
endDate,
|
|
21
|
-
};
|
|
22
|
-
```
|
|
23
|
-
|
|
24
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
# PaymentIntentResult
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**paymentId** | **string** | | [default to undefined]
|
|
9
|
-
**externalId** | **string** | | [default to undefined]
|
|
10
|
-
**status** | [**PaymentStatus**](PaymentStatus.md) | | [default to undefined]
|
|
11
|
-
**provider** | [**PaymentProviderType**](PaymentProviderType.md) | | [default to undefined]
|
|
12
|
-
**readerId** | **string** | | [optional] [default to undefined]
|
|
13
|
-
|
|
14
|
-
## Example
|
|
15
|
-
|
|
16
|
-
```typescript
|
|
17
|
-
import { PaymentIntentResult } from '@tennac-booking/sdk';
|
|
18
|
-
|
|
19
|
-
const instance: PaymentIntentResult = {
|
|
20
|
-
paymentId,
|
|
21
|
-
externalId,
|
|
22
|
-
status,
|
|
23
|
-
provider,
|
|
24
|
-
readerId,
|
|
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)
|
package/docs/PaymentsStaffApi.md
DELETED
|
@@ -1,124 +0,0 @@
|
|
|
1
|
-
# PaymentsStaffApi
|
|
2
|
-
|
|
3
|
-
All URIs are relative to *http://localhost*
|
|
4
|
-
|
|
5
|
-
|Method | HTTP request | Description|
|
|
6
|
-
|------------- | ------------- | -------------|
|
|
7
|
-
|[**cancelSumupPayment**](#cancelsumuppayment) | **POST** /api/clubs/{clubId}/payments/sumup/{paymentId}/cancel | |
|
|
8
|
-
|[**createSumupPayment**](#createsumuppayment) | **POST** /api/clubs/{clubId}/payments/sumup | |
|
|
9
|
-
|
|
10
|
-
# **cancelSumupPayment**
|
|
11
|
-
> cancelSumupPayment()
|
|
12
|
-
|
|
13
|
-
Cancel a SumUp reader checkout.
|
|
14
|
-
|
|
15
|
-
### Example
|
|
16
|
-
|
|
17
|
-
```typescript
|
|
18
|
-
import {
|
|
19
|
-
PaymentsStaffApi,
|
|
20
|
-
Configuration,
|
|
21
|
-
SumupCancelPaymentRequest
|
|
22
|
-
} from '@tennac-booking/sdk';
|
|
23
|
-
|
|
24
|
-
const configuration = new Configuration();
|
|
25
|
-
const apiInstance = new PaymentsStaffApi(configuration);
|
|
26
|
-
|
|
27
|
-
let clubId: string; // (default to undefined)
|
|
28
|
-
let paymentId: string; // (default to undefined)
|
|
29
|
-
let sumupCancelPaymentRequest: SumupCancelPaymentRequest; // (optional)
|
|
30
|
-
|
|
31
|
-
const { status, data } = await apiInstance.cancelSumupPayment(
|
|
32
|
-
clubId,
|
|
33
|
-
paymentId,
|
|
34
|
-
sumupCancelPaymentRequest
|
|
35
|
-
);
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
### Parameters
|
|
39
|
-
|
|
40
|
-
|Name | Type | Description | Notes|
|
|
41
|
-
|------------- | ------------- | ------------- | -------------|
|
|
42
|
-
| **sumupCancelPaymentRequest** | **SumupCancelPaymentRequest**| | |
|
|
43
|
-
| **clubId** | [**string**] | | defaults to undefined|
|
|
44
|
-
| **paymentId** | [**string**] | | defaults to undefined|
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
### Return type
|
|
48
|
-
|
|
49
|
-
void (empty response body)
|
|
50
|
-
|
|
51
|
-
### Authorization
|
|
52
|
-
|
|
53
|
-
[bearerAuth](../README.md#bearerAuth)
|
|
54
|
-
|
|
55
|
-
### HTTP request headers
|
|
56
|
-
|
|
57
|
-
- **Content-Type**: application/json
|
|
58
|
-
- **Accept**: Not defined
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
### HTTP response details
|
|
62
|
-
| Status code | Description | Response headers |
|
|
63
|
-
|-------------|-------------|------------------|
|
|
64
|
-
|**204** | Paiement annulé | - |
|
|
65
|
-
|**400** | Bad Request | - |
|
|
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
|
-
# **createSumupPayment**
|
|
70
|
-
> PaymentIntentResult createSumupPayment(sumupCreatePaymentRequest)
|
|
71
|
-
|
|
72
|
-
Start a SumUp reader checkout (manual payment trigger).
|
|
73
|
-
|
|
74
|
-
### Example
|
|
75
|
-
|
|
76
|
-
```typescript
|
|
77
|
-
import {
|
|
78
|
-
PaymentsStaffApi,
|
|
79
|
-
Configuration,
|
|
80
|
-
SumupCreatePaymentRequest
|
|
81
|
-
} from '@tennac-booking/sdk';
|
|
82
|
-
|
|
83
|
-
const configuration = new Configuration();
|
|
84
|
-
const apiInstance = new PaymentsStaffApi(configuration);
|
|
85
|
-
|
|
86
|
-
let clubId: string; // (default to undefined)
|
|
87
|
-
let sumupCreatePaymentRequest: SumupCreatePaymentRequest; //
|
|
88
|
-
|
|
89
|
-
const { status, data } = await apiInstance.createSumupPayment(
|
|
90
|
-
clubId,
|
|
91
|
-
sumupCreatePaymentRequest
|
|
92
|
-
);
|
|
93
|
-
```
|
|
94
|
-
|
|
95
|
-
### Parameters
|
|
96
|
-
|
|
97
|
-
|Name | Type | Description | Notes|
|
|
98
|
-
|------------- | ------------- | ------------- | -------------|
|
|
99
|
-
| **sumupCreatePaymentRequest** | **SumupCreatePaymentRequest**| | |
|
|
100
|
-
| **clubId** | [**string**] | | defaults to undefined|
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
### Return type
|
|
104
|
-
|
|
105
|
-
**PaymentIntentResult**
|
|
106
|
-
|
|
107
|
-
### Authorization
|
|
108
|
-
|
|
109
|
-
[bearerAuth](../README.md#bearerAuth)
|
|
110
|
-
|
|
111
|
-
### HTTP request headers
|
|
112
|
-
|
|
113
|
-
- **Content-Type**: application/json
|
|
114
|
-
- **Accept**: application/json
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
### HTTP response details
|
|
118
|
-
| Status code | Description | Response headers |
|
|
119
|
-
|-------------|-------------|------------------|
|
|
120
|
-
|**201** | Paiement SumUp créé | - |
|
|
121
|
-
|**400** | Bad Request | - |
|
|
122
|
-
|
|
123
|
-
[[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)
|
|
124
|
-
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
# StaffEventsPaginatedResponse
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**upcoming** | [**Array<EventResponse>**](EventResponse.md) | | [default to undefined]
|
|
9
|
-
**past** | [**Array<EventResponse>**](EventResponse.md) | | [default to undefined]
|
|
10
|
-
**upcomingPagination** | [**PaginationInfo**](PaginationInfo.md) | | [default to undefined]
|
|
11
|
-
**pastPagination** | [**PaginationInfo**](PaginationInfo.md) | | [default to undefined]
|
|
12
|
-
|
|
13
|
-
## Example
|
|
14
|
-
|
|
15
|
-
```typescript
|
|
16
|
-
import { StaffEventsPaginatedResponse } from '@tennac-booking/sdk';
|
|
17
|
-
|
|
18
|
-
const instance: StaffEventsPaginatedResponse = {
|
|
19
|
-
upcoming,
|
|
20
|
-
past,
|
|
21
|
-
upcomingPagination,
|
|
22
|
-
pastPagination,
|
|
23
|
-
};
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/SumUpApi.md
DELETED
|
@@ -1,63 +0,0 @@
|
|
|
1
|
-
# SumUpApi
|
|
2
|
-
|
|
3
|
-
All URIs are relative to *http://localhost*
|
|
4
|
-
|
|
5
|
-
|Method | HTTP request | Description|
|
|
6
|
-
|------------- | ------------- | -------------|
|
|
7
|
-
|[**sumupOauthCallback**](#sumupoauthcallback) | **GET** /api/sumup/oauth/callback | |
|
|
8
|
-
|
|
9
|
-
# **sumupOauthCallback**
|
|
10
|
-
> SumupOAuthCallbackResponse sumupOauthCallback()
|
|
11
|
-
|
|
12
|
-
OAuth callback for SumUp.
|
|
13
|
-
|
|
14
|
-
### Example
|
|
15
|
-
|
|
16
|
-
```typescript
|
|
17
|
-
import {
|
|
18
|
-
SumUpApi,
|
|
19
|
-
Configuration
|
|
20
|
-
} from '@tennac-booking/sdk';
|
|
21
|
-
|
|
22
|
-
const configuration = new Configuration();
|
|
23
|
-
const apiInstance = new SumUpApi(configuration);
|
|
24
|
-
|
|
25
|
-
let code: string; // (default to undefined)
|
|
26
|
-
let state: string; // (default to undefined)
|
|
27
|
-
|
|
28
|
-
const { status, data } = await apiInstance.sumupOauthCallback(
|
|
29
|
-
code,
|
|
30
|
-
state
|
|
31
|
-
);
|
|
32
|
-
```
|
|
33
|
-
|
|
34
|
-
### Parameters
|
|
35
|
-
|
|
36
|
-
|Name | Type | Description | Notes|
|
|
37
|
-
|------------- | ------------- | ------------- | -------------|
|
|
38
|
-
| **code** | [**string**] | | defaults to undefined|
|
|
39
|
-
| **state** | [**string**] | | defaults to undefined|
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
### Return type
|
|
43
|
-
|
|
44
|
-
**SumupOAuthCallbackResponse**
|
|
45
|
-
|
|
46
|
-
### Authorization
|
|
47
|
-
|
|
48
|
-
No authorization required
|
|
49
|
-
|
|
50
|
-
### HTTP request headers
|
|
51
|
-
|
|
52
|
-
- **Content-Type**: Not defined
|
|
53
|
-
- **Accept**: application/json
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
### HTTP response details
|
|
57
|
-
| Status code | Description | Response headers |
|
|
58
|
-
|-------------|-------------|------------------|
|
|
59
|
-
|**200** | Connexion SumUp enregistrée | - |
|
|
60
|
-
|**400** | Bad Request | - |
|
|
61
|
-
|
|
62
|
-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
63
|
-
|