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

OpenAPI client for @tennac-booking/sdk

# ClubRolesApi

All URIs are relative to *https://api.mon-domaine.com*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**createClubRole**](#createclubrole) | **POST** /api/club-roles | Crée un nouveau rôle de club|
|[**deleteClubRole**](#deleteclubrole) | **DELETE** /api/club-roles/{id} | Supprime un rôle de club|
|[**getAllClubRoles**](#getallclubroles) | **GET** /api/club-roles | Récupère tous les rôles de clubs|
|[**getClubRoleById**](#getclubrolebyid) | **GET** /api/club-roles/{id} | Récupère un rôle de club par son ID|
|[**updateClubRole**](#updateclubrole) | **PUT** /api/club-roles/{id} | Met à jour un rôle de club|

# **createClubRole**
> ClubRoleResponse createClubRole(createClubRoleRequestBody)


### Example

```typescript
import {
    ClubRolesApi,
    Configuration,
    CreateClubRoleRequestBody
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new ClubRolesApi(configuration);

let createClubRoleRequestBody: CreateClubRoleRequestBody; //

const { status, data } = await apiInstance.createClubRole(
    createClubRoleRequestBody
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **createClubRoleRequestBody** | **CreateClubRoleRequestBody**|  | |


### Return type

**ClubRoleResponse**

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**201** | Rôle de club créé |  -  |
|**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)

# **deleteClubRole**
> DeleteClubRole200Response deleteClubRole()


### Example

```typescript
import {
    ClubRolesApi,
    Configuration
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new ClubRolesApi(configuration);

let id: string; //ID du rôle de club (default to undefined)

const { status, data } = await apiInstance.deleteClubRole(
    id
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **id** | [**string**] | ID du rôle de club | defaults to undefined|


### Return type

**DeleteClubRole200Response**

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Rôle de club supprimé |  -  |
|**404** | Rôle de club non trouvé |  -  |
|**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)

# **getAllClubRoles**
> Array<ClubRoleResponse> getAllClubRoles()


### Example

```typescript
import {
    ClubRolesApi,
    Configuration
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new ClubRolesApi(configuration);

const { status, data } = await apiInstance.getAllClubRoles();
```

### Parameters
This endpoint does not have any parameters.


### Return type

**Array<ClubRoleResponse>**

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Liste des rôles de clubs |  -  |
|**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)

# **getClubRoleById**
> ClubRoleResponse getClubRoleById()


### Example

```typescript
import {
    ClubRolesApi,
    Configuration
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new ClubRolesApi(configuration);

let id: string; //ID du rôle de club (default to undefined)

const { status, data } = await apiInstance.getClubRoleById(
    id
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **id** | [**string**] | ID du rôle de club | defaults to undefined|


### Return type

**ClubRoleResponse**

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Rôle de club trouvé |  -  |
|**404** | Rôle de club non trouvé |  -  |
|**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)

# **updateClubRole**
> ClubRoleResponse updateClubRole(updateClubRoleRequestBody)


### Example

```typescript
import {
    ClubRolesApi,
    Configuration,
    UpdateClubRoleRequestBody
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new ClubRolesApi(configuration);

let id: string; //ID du rôle de club (default to undefined)
let updateClubRoleRequestBody: UpdateClubRoleRequestBody; //

const { status, data } = await apiInstance.updateClubRole(
    id,
    updateClubRoleRequestBody
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **updateClubRoleRequestBody** | **UpdateClubRoleRequestBody**|  | |
| **id** | [**string**] | ID du rôle de club | defaults to undefined|


### Return type

**ClubRoleResponse**

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Rôle de club mis à jour |  -  |
|**404** | Rôle de club non trouvé |  -  |
|**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)