@tennac-booking/sdk 1.0.231 → 1.0.233

package/docs/SumUpManagerApi.md

@@ -0,0 +1,617 @@
+# SumUpManagerApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createSumupReader**](#createsumupreader) | **POST** /api/clubs/{clubId}/sumup/readers | |
+|[**deleteSumupReader**](#deletesumupreader) | **DELETE** /api/clubs/{clubId}/sumup/readers/{readerId} | |
+|[**disconnectSumup**](#disconnectsumup) | **POST** /api/clubs/{clubId}/sumup/disconnect | |
+|[**getSumupConnectUrl**](#getsumupconnecturl) | **GET** /api/clubs/{clubId}/sumup/connect | |
+|[**getSumupReader**](#getsumupreader) | **GET** /api/clubs/{clubId}/sumup/readers/{readerId} | |
+|[**getSumupReaderStatus**](#getsumupreaderstatus) | **GET** /api/clubs/{clubId}/sumup/readers/{readerId}/status | |
+|[**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 | |
+|[**updateSumupReader**](#updatesumupreader) | **PATCH** /api/clubs/{clubId}/sumup/readers/{readerId} | |
+
+# **createSumupReader**
+> SumupPairReaderResponse createSumupReader(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.createSumupReader(
+    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 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)
+
+# **deleteSumupReader**
+> deleteSumupReader()
+
+Delete a SumUp reader.
+
+### 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.deleteSumupReader(
+    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 SumUp supprimé |  -  |
+|**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)
+
+# **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)
+
+# **getSumupReader**
+> SumupReaderResponse getSumupReader()
+
+Retrieve a SumUp reader.
+
+### 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.getSumupReader(
+    clubId,
+    readerId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **clubId** | [**string**] |  | defaults to undefined|
+| **readerId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**SumupReaderResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Reader 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)
+
+# **getSumupReaderStatus**
+> SumupReaderStatusResponse getSumupReaderStatus()
+
+Get SumUp reader status.
+
+### 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.getSumupReaderStatus(
+    clubId,
+    readerId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **clubId** | [**string**] |  | defaults to undefined|
+| **readerId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**SumupReaderStatusResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Reader status |  -  |
+|**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)
+
+# **updateSumupReader**
+> SumupReaderResponse updateSumupReader(sumupUpdateReaderRequest)
+
+Update a SumUp reader.
+
+### Example
+
+```typescript
+import {
+    SumUpManagerApi,
+    Configuration,
+    SumupUpdateReaderRequest
+} 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)
+let sumupUpdateReaderRequest: SumupUpdateReaderRequest; //
+
+const { status, data } = await apiInstance.updateSumupReader(
+    clubId,
+    readerId,
+    sumupUpdateReaderRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **sumupUpdateReaderRequest** | **SumupUpdateReaderRequest**|  | |
+| **clubId** | [**string**] |  | defaults to undefined|
+| **readerId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**SumupReaderResponse**
+
+### 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 mis à jour |  -  |
+|**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)