@tennac-booking/sdk
Version:
OpenAPI client for @tennac-booking/sdk
228 lines (148 loc) • 5.73 kB
Markdown
# ClubSettingsApi
All URIs are relative to *https://api.mon-domaine.com*
|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**createClubSettings**](#createclubsettings) | **POST** /api/club-settings | Crée les paramètres d’un club|
|[**deleteClubSettings**](#deleteclubsettings) | **DELETE** /api/club-settings | Supprime les paramètres d’un club|
|[**getClubSettings**](#getclubsettings) | **GET** /api/club-settings | Récupère les paramètres d’un club|
|[**updateClubSettings**](#updateclubsettings) | **PUT** /api/club-settings | Met à jour les paramètres d’un club|
# **createClubSettings**
> ClubSettings createClubSettings(clubSettings)
### Example
```typescript
import {
ClubSettingsApi,
Configuration,
ClubSettings
} from '@tennac-booking/sdk';
const configuration = new Configuration();
const apiInstance = new ClubSettingsApi(configuration);
let clubSettings: ClubSettings; //
const { status, data } = await apiInstance.createClubSettings(
clubSettings
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **clubSettings** | **ClubSettings**| | |
### Return type
**ClubSettings**
### Authorization
[bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**201** | Paramètres créés | - |
|**401** | Non autorisé | - |
|**409** | Paramètres déjà existants | - |
|**500** | Erreur serveur interne | - |
[[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)
# **deleteClubSettings**
> deleteClubSettings(getClubSettingsRequest)
### Example
```typescript
import {
ClubSettingsApi,
Configuration,
GetClubSettingsRequest
} from '@tennac-booking/sdk';
const configuration = new Configuration();
const apiInstance = new ClubSettingsApi(configuration);
let getClubSettingsRequest: GetClubSettingsRequest; //
const { status, data } = await apiInstance.deleteClubSettings(
getClubSettingsRequest
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **getClubSettingsRequest** | **GetClubSettingsRequest**| | |
### Return type
void (empty response body)
### Authorization
[bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Paramètres supprimés | - |
|**401** | Non autorisé | - |
|**404** | Paramètres non trouvés | - |
|**500** | Erreur serveur interne | - |
[[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)
# **getClubSettings**
> ClubSettings getClubSettings(getClubSettingsRequest)
### Example
```typescript
import {
ClubSettingsApi,
Configuration,
GetClubSettingsRequest
} from '@tennac-booking/sdk';
const configuration = new Configuration();
const apiInstance = new ClubSettingsApi(configuration);
let getClubSettingsRequest: GetClubSettingsRequest; //
const { status, data } = await apiInstance.getClubSettings(
getClubSettingsRequest
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **getClubSettingsRequest** | **GetClubSettingsRequest**| | |
### Return type
**ClubSettings**
### Authorization
[bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Paramètres du club | - |
|**401** | Non autorisé | - |
|**404** | Paramètres non trouvés | - |
|**500** | Erreur serveur interne | - |
[[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)
# **updateClubSettings**
> ClubSettings updateClubSettings(clubSettings)
### Example
```typescript
import {
ClubSettingsApi,
Configuration,
ClubSettings
} from '@tennac-booking/sdk';
const configuration = new Configuration();
const apiInstance = new ClubSettingsApi(configuration);
let clubSettings: ClubSettings; //
const { status, data } = await apiInstance.updateClubSettings(
clubSettings
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **clubSettings** | **ClubSettings**| | |
### Return type
**ClubSettings**
### Authorization
[bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Paramètres mis à jour | - |
|**401** | Non autorisé | - |
|**404** | Paramètres non trouvés | - |
|**500** | Erreur serveur interne | - |
[[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)