@tennac-booking/sdk 1.0.182 → 1.0.184
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +5 -0
- package/README.md +7 -0
- package/api.ts +319 -4
- package/dist/api.d.ts +223 -4
- package/dist/api.js +146 -4
- package/dist/esm/api.d.ts +223 -4
- package/dist/esm/api.js +146 -4
- package/docs/BookingsStaffApi.md +57 -1
- package/docs/CheckInPlayerSumupRequest.md +22 -0
- package/docs/CheckInPlayerSumupResponse.md +24 -0
- package/docs/CheckInSumupPaymentInfo.md +26 -0
- package/docs/SumUpManagerApi.md +57 -0
- package/docs/SumupAccountStatusResponse.md +4 -0
- package/docs/SumupPairReaderRequest.md +22 -0
- package/docs/SumupPairReaderResponse.md +20 -0
- package/package.json +1 -1
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# CheckInPlayerSumupResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**message** | **string** | Message de confirmation | [default to undefined]
|
|
9
|
+
**invoice** | [**CheckedInPlayer**](CheckedInPlayer.md) | | [default to undefined]
|
|
10
|
+
**sumupPayment** | [**CheckInSumupPaymentInfo**](CheckInSumupPaymentInfo.md) | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { CheckInPlayerSumupResponse } from '@tennac-booking/sdk';
|
|
16
|
+
|
|
17
|
+
const instance: CheckInPlayerSumupResponse = {
|
|
18
|
+
message,
|
|
19
|
+
invoice,
|
|
20
|
+
sumupPayment,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,26 @@
|
|
|
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)
|
package/docs/SumUpManagerApi.md
CHANGED
|
@@ -8,6 +8,7 @@ All URIs are relative to *http://localhost*
|
|
|
8
8
|
|[**getSumupConnectUrl**](#getsumupconnecturl) | **GET** /api/clubs/{clubId}/sumup/connect | |
|
|
9
9
|
|[**getSumupStatus**](#getsumupstatus) | **GET** /api/clubs/{clubId}/sumup/status | |
|
|
10
10
|
|[**listSumupReaders**](#listsumupreaders) | **GET** /api/clubs/{clubId}/sumup/readers | |
|
|
11
|
+
|[**pairSumupReader**](#pairsumupreader) | **POST** /api/clubs/{clubId}/sumup/readers/pair | |
|
|
11
12
|
|[**selectSumupReader**](#selectsumupreader) | **POST** /api/clubs/{clubId}/sumup/readers/{readerId}/select | |
|
|
12
13
|
|
|
13
14
|
# **disconnectSumup**
|
|
@@ -218,6 +219,62 @@ const { status, data } = await apiInstance.listSumupReaders(
|
|
|
218
219
|
|
|
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)
|
|
220
221
|
|
|
222
|
+
# **pairSumupReader**
|
|
223
|
+
> SumupPairReaderResponse pairSumupReader(sumupPairReaderRequest)
|
|
224
|
+
|
|
225
|
+
Pair a SumUp reader with a club.
|
|
226
|
+
|
|
227
|
+
### Example
|
|
228
|
+
|
|
229
|
+
```typescript
|
|
230
|
+
import {
|
|
231
|
+
SumUpManagerApi,
|
|
232
|
+
Configuration,
|
|
233
|
+
SumupPairReaderRequest
|
|
234
|
+
} from '@tennac-booking/sdk';
|
|
235
|
+
|
|
236
|
+
const configuration = new Configuration();
|
|
237
|
+
const apiInstance = new SumUpManagerApi(configuration);
|
|
238
|
+
|
|
239
|
+
let clubId: string; // (default to undefined)
|
|
240
|
+
let sumupPairReaderRequest: SumupPairReaderRequest; //
|
|
241
|
+
|
|
242
|
+
const { status, data } = await apiInstance.pairSumupReader(
|
|
243
|
+
clubId,
|
|
244
|
+
sumupPairReaderRequest
|
|
245
|
+
);
|
|
246
|
+
```
|
|
247
|
+
|
|
248
|
+
### Parameters
|
|
249
|
+
|
|
250
|
+
|Name | Type | Description | Notes|
|
|
251
|
+
|------------- | ------------- | ------------- | -------------|
|
|
252
|
+
| **sumupPairReaderRequest** | **SumupPairReaderRequest**| | |
|
|
253
|
+
| **clubId** | [**string**] | | defaults to undefined|
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
### Return type
|
|
257
|
+
|
|
258
|
+
**SumupPairReaderResponse**
|
|
259
|
+
|
|
260
|
+
### Authorization
|
|
261
|
+
|
|
262
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
263
|
+
|
|
264
|
+
### HTTP request headers
|
|
265
|
+
|
|
266
|
+
- **Content-Type**: application/json
|
|
267
|
+
- **Accept**: application/json
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
### HTTP response details
|
|
271
|
+
| Status code | Description | Response headers |
|
|
272
|
+
|-------------|-------------|------------------|
|
|
273
|
+
|**200** | Reader SumUp pairé | - |
|
|
274
|
+
|**400** | Bad Request | - |
|
|
275
|
+
|
|
276
|
+
[[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)
|
|
277
|
+
|
|
221
278
|
# **selectSumupReader**
|
|
222
279
|
> selectSumupReader()
|
|
223
280
|
|
|
@@ -8,6 +8,8 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**connected** | **boolean** | | [default to undefined]
|
|
9
9
|
**merchantCode** | **string** | | [optional] [default to undefined]
|
|
10
10
|
**readerId** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**readerName** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**readerPairedAt** | **string** | | [optional] [default to undefined]
|
|
11
13
|
**scope** | **string** | | [optional] [default to undefined]
|
|
12
14
|
**connectedAt** | **string** | | [optional] [default to undefined]
|
|
13
15
|
|
|
@@ -20,6 +22,8 @@ const instance: SumupAccountStatusResponse = {
|
|
|
20
22
|
connected,
|
|
21
23
|
merchantCode,
|
|
22
24
|
readerId,
|
|
25
|
+
readerName,
|
|
26
|
+
readerPairedAt,
|
|
23
27
|
scope,
|
|
24
28
|
connectedAt,
|
|
25
29
|
};
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# SumupPairReaderRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**pairingCode** | **string** | | [default to undefined]
|
|
9
|
+
**name** | **string** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { SumupPairReaderRequest } from '@tennac-booking/sdk';
|
|
15
|
+
|
|
16
|
+
const instance: SumupPairReaderRequest = {
|
|
17
|
+
pairingCode,
|
|
18
|
+
name,
|
|
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,20 @@
|
|
|
1
|
+
# SumupPairReaderResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**reader** | [**SumupReaderInfo**](SumupReaderInfo.md) | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { SumupPairReaderResponse } from '@tennac-booking/sdk';
|
|
14
|
+
|
|
15
|
+
const instance: SumupPairReaderResponse = {
|
|
16
|
+
reader,
|
|
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)
|