@tennac-booking/sdk/docs/SumUpManagerApi.md

OpenAPI client for @tennac-booking/sdk

# 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)