@tennac-booking/sdk 1.0.231 → 1.0.232
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 +481 -457
- package/README.md +35 -0
- package/api.ts +10498 -8422
- package/dist/api.d.ts +7432 -6082
- package/dist/api.js +4472 -2537
- package/dist/base.js +2 -5
- package/dist/common.js +38 -22
- package/dist/configuration.js +2 -62
- package/dist/esm/api.d.ts +7432 -6082
- package/dist/esm/api.js +4454 -2531
- package/dist/esm/base.js +2 -5
- package/dist/esm/common.js +38 -22
- package/dist/esm/configuration.js +2 -62
- 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/JobsApi.md +7 -7
- package/docs/PaymentIntentResult.md +28 -0
- package/docs/PaymentProviderType.md +10 -0
- package/docs/PaymentStatus.md +14 -0
- package/docs/PaymentsStaffApi.md +124 -0
- package/docs/SumUpApi.md +63 -0
- package/docs/SumUpManagerApi.md +617 -0
- package/docs/SumupAccountStatusResponse.md +32 -0
- package/docs/SumupCancelPaymentRequest.md +20 -0
- package/docs/SumupConnectUrlResponse.md +20 -0
- package/docs/SumupCreatePaymentRequest.md +32 -0
- package/docs/SumupOAuthCallbackResponse.md +24 -0
- package/docs/SumupPairReaderRequest.md +24 -0
- package/docs/SumupPairReaderResponse.md +20 -0
- package/docs/SumupReaderInfo.md +42 -0
- package/docs/SumupReaderInfoDevice.md +22 -0
- package/docs/SumupReaderResponse.md +20 -0
- package/docs/SumupReaderStatusInfo.md +32 -0
- package/docs/SumupReaderStatusResponse.md +20 -0
- package/docs/SumupReadersResponse.md +20 -0
- package/docs/SumupUpdateReaderRequest.md +22 -0
- package/package.json +1 -1
- package/tsconfig.json +1 -1
package/dist/esm/base.js
CHANGED
|
@@ -29,15 +29,13 @@ export const COLLECTION_FORMATS = {
|
|
|
29
29
|
* @class BaseAPI
|
|
30
30
|
*/
|
|
31
31
|
export class BaseAPI {
|
|
32
|
-
basePath;
|
|
33
|
-
axios;
|
|
34
|
-
configuration;
|
|
35
32
|
constructor(configuration, basePath = BASE_PATH, axios = globalAxios) {
|
|
33
|
+
var _a;
|
|
36
34
|
this.basePath = basePath;
|
|
37
35
|
this.axios = axios;
|
|
38
36
|
if (configuration) {
|
|
39
37
|
this.configuration = configuration;
|
|
40
|
-
this.basePath = configuration.basePath
|
|
38
|
+
this.basePath = (_a = configuration.basePath) !== null && _a !== void 0 ? _a : basePath;
|
|
41
39
|
}
|
|
42
40
|
}
|
|
43
41
|
}
|
|
@@ -49,7 +47,6 @@ export class BaseAPI {
|
|
|
49
47
|
* @extends {Error}
|
|
50
48
|
*/
|
|
51
49
|
export class RequiredError extends Error {
|
|
52
|
-
field;
|
|
53
50
|
constructor(field, msg) {
|
|
54
51
|
super(msg);
|
|
55
52
|
this.field = field;
|
package/dist/esm/common.js
CHANGED
|
@@ -11,6 +11,15 @@
|
|
|
11
11
|
* https://openapi-generator.tech
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
15
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
16
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
17
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
18
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
19
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
20
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
21
|
+
});
|
|
22
|
+
};
|
|
14
23
|
import { RequiredError } from "./base";
|
|
15
24
|
/**
|
|
16
25
|
*
|
|
@@ -31,13 +40,15 @@ export const assertParamExists = function (functionName, paramName, paramValue)
|
|
|
31
40
|
*
|
|
32
41
|
* @export
|
|
33
42
|
*/
|
|
34
|
-
export const setApiKeyToObject =
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
43
|
+
export const setApiKeyToObject = function (object, keyParamName, configuration) {
|
|
44
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
45
|
+
if (configuration && configuration.apiKey) {
|
|
46
|
+
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
|
|
47
|
+
? yield configuration.apiKey(keyParamName)
|
|
48
|
+
: yield configuration.apiKey;
|
|
49
|
+
object[keyParamName] = localVarApiKeyValue;
|
|
50
|
+
}
|
|
51
|
+
});
|
|
41
52
|
};
|
|
42
53
|
/**
|
|
43
54
|
*
|
|
@@ -52,25 +63,29 @@ export const setBasicAuthToObject = function (object, configuration) {
|
|
|
52
63
|
*
|
|
53
64
|
* @export
|
|
54
65
|
*/
|
|
55
|
-
export const setBearerAuthToObject =
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
66
|
+
export const setBearerAuthToObject = function (object, configuration) {
|
|
67
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
68
|
+
if (configuration && configuration.accessToken) {
|
|
69
|
+
const accessToken = typeof configuration.accessToken === 'function'
|
|
70
|
+
? yield configuration.accessToken()
|
|
71
|
+
: yield configuration.accessToken;
|
|
72
|
+
object["Authorization"] = "Bearer " + accessToken;
|
|
73
|
+
}
|
|
74
|
+
});
|
|
62
75
|
};
|
|
63
76
|
/**
|
|
64
77
|
*
|
|
65
78
|
* @export
|
|
66
79
|
*/
|
|
67
|
-
export const setOAuthToObject =
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
80
|
+
export const setOAuthToObject = function (object, name, scopes, configuration) {
|
|
81
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
82
|
+
if (configuration && configuration.accessToken) {
|
|
83
|
+
const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
|
|
84
|
+
? yield configuration.accessToken(name, scopes)
|
|
85
|
+
: yield configuration.accessToken;
|
|
86
|
+
object["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
87
|
+
}
|
|
88
|
+
});
|
|
74
89
|
};
|
|
75
90
|
function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
|
|
76
91
|
if (parameter == null)
|
|
@@ -127,7 +142,8 @@ export const toPathString = function (url) {
|
|
|
127
142
|
*/
|
|
128
143
|
export const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
|
|
129
144
|
return (axios = globalAxios, basePath = BASE_PATH) => {
|
|
130
|
-
|
|
145
|
+
var _a;
|
|
146
|
+
const axiosRequestArgs = Object.assign(Object.assign({}, axiosArgs.options), { url: (axios.defaults.baseURL ? '' : (_a = configuration === null || configuration === void 0 ? void 0 : configuration.basePath) !== null && _a !== void 0 ? _a : basePath) + axiosArgs.url });
|
|
131
147
|
return axios.request(axiosRequestArgs);
|
|
132
148
|
};
|
|
133
149
|
};
|
|
@@ -12,75 +12,15 @@
|
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
14
|
export class Configuration {
|
|
15
|
-
/**
|
|
16
|
-
* parameter for apiKey security
|
|
17
|
-
* @param name security name
|
|
18
|
-
* @memberof Configuration
|
|
19
|
-
*/
|
|
20
|
-
apiKey;
|
|
21
|
-
/**
|
|
22
|
-
* parameter for basic security
|
|
23
|
-
*
|
|
24
|
-
* @type {string}
|
|
25
|
-
* @memberof Configuration
|
|
26
|
-
*/
|
|
27
|
-
username;
|
|
28
|
-
/**
|
|
29
|
-
* parameter for basic security
|
|
30
|
-
*
|
|
31
|
-
* @type {string}
|
|
32
|
-
* @memberof Configuration
|
|
33
|
-
*/
|
|
34
|
-
password;
|
|
35
|
-
/**
|
|
36
|
-
* parameter for oauth2 security
|
|
37
|
-
* @param name security name
|
|
38
|
-
* @param scopes oauth2 scope
|
|
39
|
-
* @memberof Configuration
|
|
40
|
-
*/
|
|
41
|
-
accessToken;
|
|
42
|
-
/**
|
|
43
|
-
* override base path
|
|
44
|
-
*
|
|
45
|
-
* @type {string}
|
|
46
|
-
* @memberof Configuration
|
|
47
|
-
*/
|
|
48
|
-
basePath;
|
|
49
|
-
/**
|
|
50
|
-
* override server index
|
|
51
|
-
*
|
|
52
|
-
* @type {number}
|
|
53
|
-
* @memberof Configuration
|
|
54
|
-
*/
|
|
55
|
-
serverIndex;
|
|
56
|
-
/**
|
|
57
|
-
* base options for axios calls
|
|
58
|
-
*
|
|
59
|
-
* @type {any}
|
|
60
|
-
* @memberof Configuration
|
|
61
|
-
*/
|
|
62
|
-
baseOptions;
|
|
63
|
-
/**
|
|
64
|
-
* The FormData constructor that will be used to create multipart form data
|
|
65
|
-
* requests. You can inject this here so that execution environments that
|
|
66
|
-
* do not support the FormData class can still run the generated client.
|
|
67
|
-
*
|
|
68
|
-
* @type {new () => FormData}
|
|
69
|
-
*/
|
|
70
|
-
formDataCtor;
|
|
71
15
|
constructor(param = {}) {
|
|
16
|
+
var _a;
|
|
72
17
|
this.apiKey = param.apiKey;
|
|
73
18
|
this.username = param.username;
|
|
74
19
|
this.password = param.password;
|
|
75
20
|
this.accessToken = param.accessToken;
|
|
76
21
|
this.basePath = param.basePath;
|
|
77
22
|
this.serverIndex = param.serverIndex;
|
|
78
|
-
this.baseOptions = {
|
|
79
|
-
...param.baseOptions,
|
|
80
|
-
headers: {
|
|
81
|
-
...param.baseOptions?.headers,
|
|
82
|
-
},
|
|
83
|
-
};
|
|
23
|
+
this.baseOptions = Object.assign(Object.assign({}, param.baseOptions), { headers: Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
|
|
84
24
|
this.formDataCtor = param.formDataCtor;
|
|
85
25
|
}
|
|
86
26
|
/**
|
package/docs/BookingsStaffApi.md
CHANGED
|
@@ -5,6 +5,7 @@ All URIs are relative to *http://localhost*
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**checkInPlayer**](#checkinplayer) | **POST** /api/bookings/{bookingId}/check-in | |
|
|
8
|
+
|[**checkInPlayerWithSumup**](#checkinplayerwithsumup) | **POST** /api/bookings/{bookingId}/check-in/sumup | |
|
|
8
9
|
|[**createStaffBooking**](#createstaffbooking) | **POST** /api/bookings/staff | |
|
|
9
10
|
|[**getBookingById**](#getbookingbyid) | **GET** /api/bookings/{bookingId} | |
|
|
10
11
|
|[**getBookingHistoryStaff**](#getbookinghistorystaff) | **GET** /api/bookings/staff/history{bookingId} | |
|
|
@@ -16,7 +17,7 @@ All URIs are relative to *http://localhost*
|
|
|
16
17
|
# **checkInPlayer**
|
|
17
18
|
> CheckInPlayerResponse checkInPlayer(checkInPlayerRequest)
|
|
18
19
|
|
|
19
|
-
Check-in d\'un joueur (paiement en ligne ou sur place)
|
|
20
|
+
Check-in d\'un joueur sans SumUp (paiement en ligne ou sur place)
|
|
20
21
|
|
|
21
22
|
### Example
|
|
22
23
|
|
|
@@ -68,6 +69,61 @@ const { status, data } = await apiInstance.checkInPlayer(
|
|
|
68
69
|
|
|
69
70
|
[[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)
|
|
70
71
|
|
|
72
|
+
# **checkInPlayerWithSumup**
|
|
73
|
+
> CheckInPlayerSumupResponse checkInPlayerWithSumup(checkInPlayerSumupRequest)
|
|
74
|
+
|
|
75
|
+
Check-in d\'un joueur avec création d\'un checkout SumUp
|
|
76
|
+
|
|
77
|
+
### Example
|
|
78
|
+
|
|
79
|
+
```typescript
|
|
80
|
+
import {
|
|
81
|
+
BookingsStaffApi,
|
|
82
|
+
Configuration,
|
|
83
|
+
CheckInPlayerSumupRequest
|
|
84
|
+
} from '@tennac-booking/sdk';
|
|
85
|
+
|
|
86
|
+
const configuration = new Configuration();
|
|
87
|
+
const apiInstance = new BookingsStaffApi(configuration);
|
|
88
|
+
|
|
89
|
+
let bookingId: string; // (default to undefined)
|
|
90
|
+
let checkInPlayerSumupRequest: CheckInPlayerSumupRequest; //
|
|
91
|
+
|
|
92
|
+
const { status, data } = await apiInstance.checkInPlayerWithSumup(
|
|
93
|
+
bookingId,
|
|
94
|
+
checkInPlayerSumupRequest
|
|
95
|
+
);
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
### Parameters
|
|
99
|
+
|
|
100
|
+
|Name | Type | Description | Notes|
|
|
101
|
+
|------------- | ------------- | ------------- | -------------|
|
|
102
|
+
| **checkInPlayerSumupRequest** | **CheckInPlayerSumupRequest**| | |
|
|
103
|
+
| **bookingId** | [**string**] | | defaults to undefined|
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
### Return type
|
|
107
|
+
|
|
108
|
+
**CheckInPlayerSumupResponse**
|
|
109
|
+
|
|
110
|
+
### Authorization
|
|
111
|
+
|
|
112
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
113
|
+
|
|
114
|
+
### HTTP request headers
|
|
115
|
+
|
|
116
|
+
- **Content-Type**: application/json
|
|
117
|
+
- **Accept**: application/json
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
### HTTP response details
|
|
121
|
+
| Status code | Description | Response headers |
|
|
122
|
+
|-------------|-------------|------------------|
|
|
123
|
+
|**200** | Checkout SumUp déclenché | - |
|
|
124
|
+
|
|
125
|
+
[[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)
|
|
126
|
+
|
|
71
127
|
# **createStaffBooking**
|
|
72
128
|
> BookingResponse createStaffBooking(staffCreateBookingRequest)
|
|
73
129
|
|
|
@@ -0,0 +1,22 @@
|
|
|
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)
|
|
@@ -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/JobsApi.md
CHANGED
|
@@ -16,7 +16,7 @@ All URIs are relative to *http://localhost*
|
|
|
16
16
|
# **captureExpiringAuthorizations**
|
|
17
17
|
> JobResult captureExpiringAuthorizations()
|
|
18
18
|
|
|
19
|
-
Job: Capturer les autorisations de paiement qui expirent bientôt
|
|
19
|
+
Job: Capturer les autorisations de paiement qui expirent bientôt Fréquence recommandée: Toutes les 30 minutes
|
|
20
20
|
|
|
21
21
|
### Example
|
|
22
22
|
|
|
@@ -60,7 +60,7 @@ No authorization required
|
|
|
60
60
|
# **capturePastReservations**
|
|
61
61
|
> JobResult capturePastReservations()
|
|
62
62
|
|
|
63
|
-
Job: Capturer les paiements pour les réservations passées
|
|
63
|
+
Job: Capturer les paiements pour les réservations passées Fréquence recommandée: Toutes les heures
|
|
64
64
|
|
|
65
65
|
### Example
|
|
66
66
|
|
|
@@ -104,7 +104,7 @@ No authorization required
|
|
|
104
104
|
# **expireBookingWaitingPayments**
|
|
105
105
|
> JobResult expireBookingWaitingPayments()
|
|
106
106
|
|
|
107
|
-
Job: Expirer les réservations en attente de paiement
|
|
107
|
+
Job: Expirer les réservations en attente de paiement Fréquence recommandée: Toutes les minutes
|
|
108
108
|
|
|
109
109
|
### Example
|
|
110
110
|
|
|
@@ -148,7 +148,7 @@ No authorization required
|
|
|
148
148
|
# **expireWaitlistPayments**
|
|
149
149
|
> JobResult expireWaitlistPayments()
|
|
150
150
|
|
|
151
|
-
Job: Expirer les paiements en attente sur la waitlist
|
|
151
|
+
Job: Expirer les paiements en attente sur la waitlist Fréquence recommandée: Toutes les minutes
|
|
152
152
|
|
|
153
153
|
### Example
|
|
154
154
|
|
|
@@ -236,7 +236,7 @@ No authorization required
|
|
|
236
236
|
# **maintainSlots**
|
|
237
237
|
> JobResult maintainSlots()
|
|
238
238
|
|
|
239
|
-
Job: Maintenir les créneaux (slots)
|
|
239
|
+
Job: Maintenir les créneaux (slots) Fréquence recommandée: Une fois par jour (2h du matin)
|
|
240
240
|
|
|
241
241
|
### Example
|
|
242
242
|
|
|
@@ -280,7 +280,7 @@ No authorization required
|
|
|
280
280
|
# **releaseOldBookings**
|
|
281
281
|
> JobResult releaseOldBookings()
|
|
282
282
|
|
|
283
|
-
Job: Libérer les anciennes réservations
|
|
283
|
+
Job: Libérer les anciennes réservations Fréquence recommandée: Toutes les minutes
|
|
284
284
|
|
|
285
285
|
### Example
|
|
286
286
|
|
|
@@ -324,7 +324,7 @@ No authorization required
|
|
|
324
324
|
# **sendBookingReminders**
|
|
325
325
|
> JobResult sendBookingReminders()
|
|
326
326
|
|
|
327
|
-
Job: Envoyer les rappels de réservation et d\'événements
|
|
327
|
+
Job: Envoyer les rappels de réservation et d\'événements Fréquence recommandée: Toutes les heures
|
|
328
328
|
|
|
329
329
|
### Example
|
|
330
330
|
|
|
@@ -0,0 +1,28 @@
|
|
|
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)
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# PaymentProviderType
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `Stripe` (value: `'stripe'`)
|
|
7
|
+
|
|
8
|
+
* `Sumup` (value: `'sumup'`)
|
|
9
|
+
|
|
10
|
+
[[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,14 @@
|
|
|
1
|
+
# PaymentStatus
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `Pending` (value: `'pending'`)
|
|
7
|
+
|
|
8
|
+
* `Succeeded` (value: `'succeeded'`)
|
|
9
|
+
|
|
10
|
+
* `Failed` (value: `'failed'`)
|
|
11
|
+
|
|
12
|
+
* `Cancelled` (value: `'cancelled'`)
|
|
13
|
+
|
|
14
|
+
[[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,124 @@
|
|
|
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
|
+
|
package/docs/SumUpApi.md
ADDED
|
@@ -0,0 +1,63 @@
|
|
|
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
|
+
|