@tennac-booking/sdk
Version:
OpenAPI client for @tennac-booking/sdk
610 lines (394 loc) • 15.2 kB
Markdown
# ClubsStaffApi
All URIs are relative to *http://localhost*
|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**createOnsiteInvoiceForBooking**](#createonsiteinvoiceforbooking) | **POST** /api/clubs/staff/bookings/{bookingId}/invoices | |
|[**getActualities**](#getactualities) | **GET** /api/clubs/staff/actualities | |
|[**getClubDashboardContext**](#getclubdashboardcontext) | **GET** /api/clubs/dashboard/context | |
|[**getClubInfos**](#getclubinfos) | **GET** /api/clubs/infos | |
|[**getClubMembers**](#getclubmembers) | **GET** /api/clubs/members | |
|[**getClubPresentationSettings**](#getclubpresentationsettings) | **GET** /api/clubs/settings/presentation | |
|[**getClubRoles**](#getclubroles) | **GET** /api/clubs/roles | |
|[**getClubType**](#getclubtype) | **GET** /api/clubs/clubType | |
|[**getCourtsByClub**](#getcourtsbyclub) | **GET** /api/clubs/courts | |
|[**getInvoices**](#getinvoices) | **GET** /api/clubs/invoices | |
|[**getUserProfileStaff**](#getuserprofilestaff) | **GET** /api/clubs/staff/profile/{id} | |
|[**updateUserCreditsStaff**](#updateusercreditsstaff) | **PUT** /api/clubs/staff/user-credits/{id} | |
# **createOnsiteInvoiceForBooking**
> CreateOnsiteInvoiceResponse createOnsiteInvoiceForBooking(createOnsiteInvoiceRequest)
Crée une facture manuelle (on-site) et l\'associe à une réservation
### Example
```typescript
import {
ClubsStaffApi,
Configuration,
CreateOnsiteInvoiceRequest
} from '@tennac-booking/sdk';
const configuration = new Configuration();
const apiInstance = new ClubsStaffApi(configuration);
let bookingId: string; // (default to undefined)
let createOnsiteInvoiceRequest: CreateOnsiteInvoiceRequest; //
const { status, data } = await apiInstance.createOnsiteInvoiceForBooking(
bookingId,
createOnsiteInvoiceRequest
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **createOnsiteInvoiceRequest** | **CreateOnsiteInvoiceRequest**| | |
| **bookingId** | [**string**] | | defaults to undefined|
### Return type
**CreateOnsiteInvoiceResponse**
### Authorization
[bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**201** | Invoice créé et lié à la réservation | - |
|**400** | Requête invalide | - |
|**404** | Réservation non trouvée | - |
|**500** | Erreur serveur | - |
[[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)
# **getActualities**
> StaffActualitiesPaginatedResponse getActualities()
### Example
```typescript
import {
ClubsStaffApi,
Configuration
} from '@tennac-booking/sdk';
const configuration = new Configuration();
const apiInstance = new ClubsStaffApi(configuration);
const { status, data } = await apiInstance.getActualities();
```
### Parameters
This endpoint does not have any parameters.
### Return type
**StaffActualitiesPaginatedResponse**
### Authorization
[bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Actualités | - |
[[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)
# **getClubDashboardContext**
> ClubDashboardContextResponse getClubDashboardContext()
### Example
```typescript
import {
ClubsStaffApi,
Configuration
} from '@tennac-booking/sdk';
const configuration = new Configuration();
const apiInstance = new ClubsStaffApi(configuration);
const { status, data } = await apiInstance.getClubDashboardContext();
```
### Parameters
This endpoint does not have any parameters.
### Return type
**ClubDashboardContextResponse**
### Authorization
[bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Contexte du dashboard club | - |
|**400** | Bad Request | - |
|**404** | Club non trouvé | - |
|**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)
# **getClubInfos**
> any getClubInfos()
### Example
```typescript
import {
ClubsStaffApi,
Configuration
} from '@tennac-booking/sdk';
const configuration = new Configuration();
const apiInstance = new ClubsStaffApi(configuration);
const { status, data } = await apiInstance.getClubInfos();
```
### Parameters
This endpoint does not have any parameters.
### Return type
**any**
### Authorization
[bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Infos du club | - |
[[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)
# **getClubMembers**
> GetClubMembers200Response getClubMembers()
Récupère les membres d\'un club
### Example
```typescript
import {
ClubsStaffApi,
Configuration
} from '@tennac-booking/sdk';
const configuration = new Configuration();
const apiInstance = new ClubsStaffApi(configuration);
const { status, data } = await apiInstance.getClubMembers();
```
### Parameters
This endpoint does not have any parameters.
### Return type
**GetClubMembers200Response**
### 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 membres du club | - |
|**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)
# **getClubPresentationSettings**
> ClubPresentationSettingsResponse getClubPresentationSettings()
### Example
```typescript
import {
ClubsStaffApi,
Configuration
} from '@tennac-booking/sdk';
const configuration = new Configuration();
const apiInstance = new ClubsStaffApi(configuration);
const { status, data } = await apiInstance.getClubPresentationSettings();
```
### Parameters
This endpoint does not have any parameters.
### Return type
**ClubPresentationSettingsResponse**
### Authorization
[bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Présentation du club | - |
[[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)
# **getClubRoles**
> GetClubRoles200Response getClubRoles()
Récupère les rôles d\'un club
### Example
```typescript
import {
ClubsStaffApi,
Configuration
} from '@tennac-booking/sdk';
const configuration = new Configuration();
const apiInstance = new ClubsStaffApi(configuration);
const { status, data } = await apiInstance.getClubRoles();
```
### Parameters
This endpoint does not have any parameters.
### Return type
**GetClubRoles200Response**
### 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 du club | - |
|**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)
# **getClubType**
> GetClubType200Response getClubType()
### Example
```typescript
import {
ClubsStaffApi,
Configuration
} from '@tennac-booking/sdk';
const configuration = new Configuration();
const apiInstance = new ClubsStaffApi(configuration);
const { status, data } = await apiInstance.getClubType();
```
### Parameters
This endpoint does not have any parameters.
### Return type
**GetClubType200Response**
### Authorization
[bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Type de club | - |
|**400** | Bad Request | - |
|**404** | Club non trouvé | - |
|**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)
# **getCourtsByClub**
> Array<CourtResponse> getCourtsByClub()
Récupère les terrains d\'un club
### Example
```typescript
import {
ClubsStaffApi,
Configuration
} from '@tennac-booking/sdk';
const configuration = new Configuration();
const apiInstance = new ClubsStaffApi(configuration);
const { status, data } = await apiInstance.getCourtsByClub();
```
### Parameters
This endpoint does not have any parameters.
### Return type
**Array<CourtResponse>**
### 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 terrains du club | - |
|**400** | Bad Request | - |
|**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)
# **getInvoices**
> any getInvoices()
### Example
```typescript
import {
ClubsStaffApi,
Configuration
} from '@tennac-booking/sdk';
const configuration = new Configuration();
const apiInstance = new ClubsStaffApi(configuration);
let page: number; // (optional) (default to undefined)
let pageSize: number; // (optional) (default to undefined)
let search: string; // (optional) (default to undefined)
let filters: string; // (optional) (default to undefined)
let sorting: string; // (optional) (default to undefined)
let status: string; // (optional) (default to undefined)
let startDate: string; // (optional) (default to undefined)
let endDate: string; // (optional) (default to undefined)
const { status, data } = await apiInstance.getInvoices(
page,
pageSize,
search,
filters,
sorting,
status,
startDate,
endDate
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **page** | [**number**] | | (optional) defaults to undefined|
| **pageSize** | [**number**] | | (optional) defaults to undefined|
| **search** | [**string**] | | (optional) defaults to undefined|
| **filters** | [**string**] | | (optional) defaults to undefined|
| **sorting** | [**string**] | | (optional) defaults to undefined|
| **status** | [**string**] | | (optional) defaults to undefined|
| **startDate** | [**string**] | | (optional) defaults to undefined|
| **endDate** | [**string**] | | (optional) defaults to undefined|
### Return type
**any**
### Authorization
[bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Factures | - |
[[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)
# **getUserProfileStaff**
> StaffUserProfileResponse getUserProfileStaff()
### Example
```typescript
import {
ClubsStaffApi,
Configuration
} from '@tennac-booking/sdk';
const configuration = new Configuration();
const apiInstance = new ClubsStaffApi(configuration);
let id: string; // (default to undefined)
const { status, data } = await apiInstance.getUserProfileStaff(
id
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **id** | [**string**] | | defaults to undefined|
### Return type
**StaffUserProfileResponse**
### Authorization
[bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Ok | - |
[[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)
# **updateUserCreditsStaff**
> StaffUserProfileResponse updateUserCreditsStaff(updateUserCreditsRequest)
### Example
```typescript
import {
ClubsStaffApi,
Configuration,
UpdateUserCreditsRequest
} from '@tennac-booking/sdk';
const configuration = new Configuration();
const apiInstance = new ClubsStaffApi(configuration);
let id: string; // (default to undefined)
let updateUserCreditsRequest: UpdateUserCreditsRequest; //
const { status, data } = await apiInstance.updateUserCreditsStaff(
id,
updateUserCreditsRequest
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **updateUserCreditsRequest** | **UpdateUserCreditsRequest**| | |
| **id** | [**string**] | | defaults to undefined|
### Return type
**StaffUserProfileResponse**
### Authorization
[bearerAuth](../README.md#bearerAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Ok | - |
[[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)