@tennac-booking/sdk 1.0.184 → 1.0.185

package/docs/SumUpManagerApi.md

@@ -1,332 +0,0 @@
-# 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

@@ -1,32 +0,0 @@
-# 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

@@ -1,20 +0,0 @@
-# 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

@@ -1,20 +0,0 @@
-# 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

@@ -1,32 +0,0 @@
-# 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

@@ -1,24 +0,0 @@
-# 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)

package/docs/SumupPairReaderRequest.md

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

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

@@ -1,34 +0,0 @@
-# SumupReaderInfo
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**reader_id** | **string** |  | [optional] [default to undefined]
-**id** | **string** |  | [optional] [default to undefined]
-**serial_number** | **string** |  | [optional] [default to undefined]
-**name** | **string** |  | [optional] [default to undefined]
-**status** | **string** |  | [optional] [default to undefined]
-**model** | **string** |  | [optional] [default to undefined]
-**device_type** | **string** |  | [optional] [default to undefined]
-**last_seen_at** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { SumupReaderInfo } from '@tennac-booking/sdk';
-
-const instance: SumupReaderInfo = {
-    reader_id,
-    id,
-    serial_number,
-    name,
-    status,
-    model,
-    device_type,
-    last_seen_at,
-};
-```
-
-[[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/SumupReadersResponse.md

@@ -1,20 +0,0 @@
-# SumupReadersResponse
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**readers** | [**Array<SumupReaderInfo>**](SumupReaderInfo.md) |  | [default to undefined]
-
-## Example
-
-```typescript
-import { SumupReadersResponse } from '@tennac-booking/sdk';
-
-const instance: SumupReadersResponse = {
-    readers,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)