UNPKG

@tennac-booking/sdk

Version:

OpenAPI client for @tennac-booking/sdk

178 lines (117 loc) 4.31 kB
# ClubRolesManagerApi All URIs are relative to *http://localhost* |Method | HTTP request | Description| |------------- | ------------- | -------------| |[**createClubRole**](#createclubrole) | **POST** /api/club-roles | | |[**deleteClubRole**](#deleteclubrole) | **DELETE** /api/club-roles/{id} | | |[**updateClubRole**](#updateclubrole) | **PUT** /api/club-roles/{id} | | # **createClubRole** > ClubRoleResponse createClubRole(createClubRoleRequest) Crée un rôle de club ### Example ```typescript import { ClubRolesManagerApi, Configuration, CreateClubRoleRequest } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new ClubRolesManagerApi(configuration); let createClubRoleRequest: CreateClubRoleRequest; // const { status, data } = await apiInstance.createClubRole( createClubRoleRequest ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **createClubRoleRequest** | **CreateClubRoleRequest**| | | ### 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** | Role créé | - | |**400** | Bad Request | - | |**401** | Unauthorized | - | |**500** | Server Error | - | [[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** > DeleteClubRoleResponse deleteClubRole() Supprime un rôle de club ### Example ```typescript import { ClubRolesManagerApi, Configuration } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new ClubRolesManagerApi(configuration); let id: string; // (default to undefined) const { status, data } = await apiInstance.deleteClubRole( id ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **id** | [**string**] | | defaults to undefined| ### Return type **DeleteClubRoleResponse** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Role supprimé | - | |**401** | Unauthorized | - | |**404** | Not Found | - | |**500** | Server Error | - | [[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(updateClubRoleRequest) Met à jour un rôle de club ### Example ```typescript import { ClubRolesManagerApi, Configuration, UpdateClubRoleRequest } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new ClubRolesManagerApi(configuration); let id: string; // (default to undefined) let updateClubRoleRequest: UpdateClubRoleRequest; // const { status, data } = await apiInstance.updateClubRole( id, updateClubRoleRequest ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **updateClubRoleRequest** | **UpdateClubRoleRequest**| | | | **id** | [**string**] | | 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** | Role mis à jour | - | |**401** | Unauthorized | - | |**404** | Not Found | - | |**500** | Server Error | - | [[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)