@tennac-booking/sdk 1.0.181 → 1.0.183

package/docs/PaymentIntentResult.md

@@ -0,0 +1,28 @@
+# PaymentIntentResult
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**paymentId** | **string** |  | [default to undefined]
+**externalId** | **string** |  | [default to undefined]
+**status** | [**PaymentStatus**](PaymentStatus.md) |  | [default to undefined]
+**provider** | [**PaymentProviderType**](PaymentProviderType.md) |  | [default to undefined]
+**readerId** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PaymentIntentResult } from '@tennac-booking/sdk';
+
+const instance: PaymentIntentResult = {
+    paymentId,
+    externalId,
+    status,
+    provider,
+    readerId,
+};
+```
+
+[[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/PaymentProviderType.md

@@ -0,0 +1,10 @@
+# PaymentProviderType
+
+
+## Enum
+
+* `Stripe` (value: `'stripe'`)
+
+* `Sumup` (value: `'sumup'`)
+
+[[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/PaymentStatus.md

@@ -0,0 +1,14 @@
+# PaymentStatus
+
+
+## Enum
+
+* `Pending` (value: `'pending'`)
+
+* `Succeeded` (value: `'succeeded'`)
+
+* `Failed` (value: `'failed'`)
+
+* `Cancelled` (value: `'cancelled'`)
+
+[[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

@@ -0,0 +1,124 @@
+# PaymentsStaffApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**cancelSumupPayment**](#cancelsumuppayment) | **POST** /api/clubs/{clubId}/payments/sumup/{paymentId}/cancel | |
+|[**createSumupPayment**](#createsumuppayment) | **POST** /api/clubs/{clubId}/payments/sumup | |
+
+# **cancelSumupPayment**
+> cancelSumupPayment()
+
+Cancel a SumUp reader checkout.
+
+### Example
+
+```typescript
+import {
+    PaymentsStaffApi,
+    Configuration,
+    SumupCancelPaymentRequest
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new PaymentsStaffApi(configuration);
+
+let clubId: string; // (default to undefined)
+let paymentId: string; // (default to undefined)
+let sumupCancelPaymentRequest: SumupCancelPaymentRequest; // (optional)
+
+const { status, data } = await apiInstance.cancelSumupPayment(
+    clubId,
+    paymentId,
+    sumupCancelPaymentRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **sumupCancelPaymentRequest** | **SumupCancelPaymentRequest**|  | |
+| **clubId** | [**string**] |  | defaults to undefined|
+| **paymentId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Paiement annulé |  -  |
+|**400** | Bad Request |  -  |
+
+[[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)
+
+# **createSumupPayment**
+> PaymentIntentResult createSumupPayment(sumupCreatePaymentRequest)
+
+Start a SumUp reader checkout (manual payment trigger).
+
+### Example
+
+```typescript
+import {
+    PaymentsStaffApi,
+    Configuration,
+    SumupCreatePaymentRequest
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new PaymentsStaffApi(configuration);
+
+let clubId: string; // (default to undefined)
+let sumupCreatePaymentRequest: SumupCreatePaymentRequest; //
+
+const { status, data } = await apiInstance.createSumupPayment(
+    clubId,
+    sumupCreatePaymentRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **sumupCreatePaymentRequest** | **SumupCreatePaymentRequest**|  | |
+| **clubId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**PaymentIntentResult**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Paiement SumUp créé |  -  |
+|**400** | Bad Request |  -  |
+
+[[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)
+

package/docs/SumUpApi.md

@@ -0,0 +1,63 @@
+# SumUpApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**sumupOauthCallback**](#sumupoauthcallback) | **GET** /api/sumup/oauth/callback | |
+
+# **sumupOauthCallback**
+> SumupOAuthCallbackResponse sumupOauthCallback()
+
+OAuth callback for SumUp.
+
+### Example
+
+```typescript
+import {
+    SumUpApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SumUpApi(configuration);
+
+let code: string; // (default to undefined)
+let state: string; // (default to undefined)
+
+const { status, data } = await apiInstance.sumupOauthCallback(
+    code,
+    state
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **code** | [**string**] |  | defaults to undefined|
+| **state** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**SumupOAuthCallbackResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Connexion SumUp enregistrée |  -  |
+|**400** | Bad Request |  -  |
+
+[[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)
+

package/docs/SumUpManagerApi.md

@@ -0,0 +1,332 @@
+# SumUpManagerApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**disconnectSumup**](#disconnectsumup) | **POST** /api/clubs/{clubId}/sumup/disconnect | |
+|[**getSumupConnectUrl**](#getsumupconnecturl) | **GET** /api/clubs/{clubId}/sumup/connect | |
+|[**getSumupStatus**](#getsumupstatus) | **GET** /api/clubs/{clubId}/sumup/status | |
+|[**listSumupReaders**](#listsumupreaders) | **GET** /api/clubs/{clubId}/sumup/readers | |
+|[**pairSumupReader**](#pairsumupreader) | **POST** /api/clubs/{clubId}/sumup/readers/pair | |
+|[**selectSumupReader**](#selectsumupreader) | **POST** /api/clubs/{clubId}/sumup/readers/{readerId}/select | |
+
+# **disconnectSumup**
+> disconnectSumup()
+
+Disconnect SumUp account for a club.
+
+### Example
+
+```typescript
+import {
+    SumUpManagerApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SumUpManagerApi(configuration);
+
+let clubId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.disconnectSumup(
+    clubId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **clubId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | SumUp déconnecté |  -  |
+|**400** | Bad Request |  -  |
+
+[[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)
+
+# **getSumupConnectUrl**
+> SumupConnectUrlResponse getSumupConnectUrl()
+
+Start SumUp OAuth connection for a club.
+
+### Example
+
+```typescript
+import {
+    SumUpManagerApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SumUpManagerApi(configuration);
+
+let clubId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getSumupConnectUrl(
+    clubId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **clubId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**SumupConnectUrlResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | URL OAuth SumUp |  -  |
+|**400** | Bad Request |  -  |
+
+[[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)
+
+# **getSumupStatus**
+> SumupAccountStatusResponse getSumupStatus()
+
+Get SumUp connection status for a club.
+
+### Example
+
+```typescript
+import {
+    SumUpManagerApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SumUpManagerApi(configuration);
+
+let clubId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getSumupStatus(
+    clubId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **clubId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**SumupAccountStatusResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Statut SumUp |  -  |
+|**400** | Bad Request |  -  |
+
+[[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)
+
+# **listSumupReaders**
+> SumupReadersResponse listSumupReaders()
+
+List SumUp readers for a club.
+
+### Example
+
+```typescript
+import {
+    SumUpManagerApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SumUpManagerApi(configuration);
+
+let clubId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.listSumupReaders(
+    clubId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **clubId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**SumupReadersResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Readers SumUp |  -  |
+|**400** | Bad Request |  -  |
+
+[[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)
+
+# **pairSumupReader**
+> SumupPairReaderResponse pairSumupReader(sumupPairReaderRequest)
+
+Pair a SumUp reader with a club.
+
+### Example
+
+```typescript
+import {
+    SumUpManagerApi,
+    Configuration,
+    SumupPairReaderRequest
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SumUpManagerApi(configuration);
+
+let clubId: string; // (default to undefined)
+let sumupPairReaderRequest: SumupPairReaderRequest; //
+
+const { status, data } = await apiInstance.pairSumupReader(
+    clubId,
+    sumupPairReaderRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **sumupPairReaderRequest** | **SumupPairReaderRequest**|  | |
+| **clubId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**SumupPairReaderResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Reader SumUp pairé |  -  |
+|**400** | Bad Request |  -  |
+
+[[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)
+
+# **selectSumupReader**
+> selectSumupReader()
+
+Select a SumUp reader for a club.
+
+### Example
+
+```typescript
+import {
+    SumUpManagerApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SumUpManagerApi(configuration);
+
+let clubId: string; // (default to undefined)
+let readerId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.selectSumupReader(
+    clubId,
+    readerId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **clubId** | [**string**] |  | defaults to undefined|
+| **readerId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Reader sélectionné |  -  |
+|**400** | Bad Request |  -  |
+
+[[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)
+

package/docs/SumupAccountStatusResponse.md

@@ -0,0 +1,32 @@
+# SumupAccountStatusResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**connected** | **boolean** |  | [default to undefined]
+**merchantCode** | **string** |  | [optional] [default to undefined]
+**readerId** | **string** |  | [optional] [default to undefined]
+**readerName** | **string** |  | [optional] [default to undefined]
+**readerPairedAt** | **string** |  | [optional] [default to undefined]
+**scope** | **string** |  | [optional] [default to undefined]
+**connectedAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SumupAccountStatusResponse } from '@tennac-booking/sdk';
+
+const instance: SumupAccountStatusResponse = {
+    connected,
+    merchantCode,
+    readerId,
+    readerName,
+    readerPairedAt,
+    scope,
+    connectedAt,
+};
+```
+
+[[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/SumupCancelPaymentRequest.md

@@ -0,0 +1,20 @@
+# SumupCancelPaymentRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**checkoutId** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SumupCancelPaymentRequest } from '@tennac-booking/sdk';
+
+const instance: SumupCancelPaymentRequest = {
+    checkoutId,
+};
+```
+
+[[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/SumupConnectUrlResponse.md

@@ -0,0 +1,20 @@
+# SumupConnectUrlResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { SumupConnectUrlResponse } from '@tennac-booking/sdk';
+
+const instance: SumupConnectUrlResponse = {
+    url,
+};
+```
+
+[[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/SumupCreatePaymentRequest.md

@@ -0,0 +1,32 @@
+# SumupCreatePaymentRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amountInCents** | **number** |  | [default to undefined]
+**currency** | **string** |  | [default to undefined]
+**readerId** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**reference** | **string** |  | [optional] [default to undefined]
+**metadata** | **{ [key: string]: string; }** | Construct a type with a set of properties K of type T | [optional] [default to undefined]
+**userId** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SumupCreatePaymentRequest } from '@tennac-booking/sdk';
+
+const instance: SumupCreatePaymentRequest = {
+    amountInCents,
+    currency,
+    readerId,
+    description,
+    reference,
+    metadata,
+    userId,
+};
+```
+
+[[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/SumupOAuthCallbackResponse.md

@@ -0,0 +1,24 @@
+# SumupOAuthCallbackResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**clubId** | **string** |  | [default to undefined]
+**merchantCode** | **string** |  | [default to undefined]
+**scope** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SumupOAuthCallbackResponse } from '@tennac-booking/sdk';
+
+const instance: SumupOAuthCallbackResponse = {
+    clubId,
+    merchantCode,
+    scope,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)