@tennac-booking/sdk 1.0.140 → 1.0.142
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +16 -4
- package/README.md +25 -3
- package/api.ts +1249 -150
- package/dist/api.d.ts +810 -111
- package/dist/api.js +616 -4
- package/dist/esm/api.d.ts +810 -111
- package/dist/esm/api.js +612 -0
- package/docs/BookingsPerDayItem.md +22 -0
- package/docs/BookingsPerDayResponse.md +24 -0
- package/docs/ClubAnalyticsStaffApi.md +376 -0
- package/docs/{ClubDaySchedule.md → ClubDayInterval.md} +7 -7
- package/docs/ClubHoursSettingsResponse.md +1 -1
- package/docs/ClubNewBookingsResponse.md +24 -0
- package/docs/ClubNewSubscribersResponse.md +24 -0
- package/docs/ClubSettingsManagerApi.md +107 -0
- package/docs/ClubSubscriberSummaryResponse.md +20 -0
- package/docs/DuplicateClubDayScheduleRequest.md +22 -0
- package/docs/LeastBookedTimeSlotItem.md +26 -0
- package/docs/LeastBookedTimeSlotsResponse.md +24 -0
- package/docs/LeastBookedWeekdayResponse.md +26 -0
- package/docs/NoShowRateResponse.md +28 -0
- package/docs/PartialRecordWeekdayKeyClubDayScheduleOrNullOrUndefined.md +33 -0
- package/docs/RecordWeekdayKeyClubDaySchedule.md +33 -0
- package/docs/UpdateClubDayScheduleRequest.md +20 -0
- package/docs/UpdateClubHoursSettingsRequest.md +1 -1
- package/docs/WeekdayAverageItem.md +28 -0
- package/docs/WeekdayKey.md +20 -0
- package/package.json +1 -1
- package/docs/ClubWeeklySchedule.md +0 -32
- package/docs/PartialClubWeeklySchedule.md +0 -33
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# BookingsPerDayItem
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**date** | **string** | Jour au format YYYY-MM-DD | [default to undefined]
|
|
9
|
+
**bookingsCount** | **number** | Nombre de réservations dont la séance se déroule ce jour-là | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { BookingsPerDayItem } from '@tennac-booking/sdk';
|
|
15
|
+
|
|
16
|
+
const instance: BookingsPerDayItem = {
|
|
17
|
+
date,
|
|
18
|
+
bookingsCount,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# BookingsPerDayResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**startDate** | **string** | Date de début incluse (format ISO) | [default to undefined]
|
|
9
|
+
**endDate** | **string** | Date de fin incluse (format ISO) | [default to undefined]
|
|
10
|
+
**dailyCounts** | [**Array<BookingsPerDayItem>**](BookingsPerDayItem.md) | Comptes quotidiens | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { BookingsPerDayResponse } from '@tennac-booking/sdk';
|
|
16
|
+
|
|
17
|
+
const instance: BookingsPerDayResponse = {
|
|
18
|
+
startDate,
|
|
19
|
+
endDate,
|
|
20
|
+
dailyCounts,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -5,15 +5,22 @@ All URIs are relative to *http://localhost*
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**getAnalyticsBySport**](#getanalyticsbysport) | **GET** /api/club-analytics/sport/{sportId}/analytics | |
|
|
8
|
+
|[**getBookingsPerDay**](#getbookingsperday) | **GET** /api/club-analytics/bookings/per-day | |
|
|
8
9
|
|[**getClubPlayerBookingsById**](#getclubplayerbookingsbyid) | **GET** /api/club-analytics/players/{playerId}/bookings | |
|
|
9
10
|
|[**getClubPlayerById**](#getclubplayerbyid) | **GET** /api/club-analytics/players/{playerId} | |
|
|
10
11
|
|[**getClubPlayerStatisticsById**](#getclubplayerstatisticsbyid) | **GET** /api/club-analytics/players/{playerId}/statistics | |
|
|
11
12
|
|[**getClubPlayers**](#getclubplayers) | **GET** /api/club-analytics/players | |
|
|
13
|
+
|[**getClubSubscribersSummary**](#getclubsubscriberssummary) | **GET** /api/club-analytics/subscribers/total | |
|
|
12
14
|
|[**getDailyTurnOver**](#getdailyturnover) | **GET** /api/club-analytics/daily-turnover | |
|
|
13
15
|
|[**getGenderPercentage**](#getgenderpercentage) | **GET** /api/club-analytics/gender-percentage | |
|
|
14
16
|
|[**getInfillPercentagePerPeriod**](#getinfillpercentageperperiod) | **GET** /api/club-analytics/infill-percentage | |
|
|
15
17
|
|[**getLastSixMonthsTurnover**](#getlastsixmonthsturnover) | **GET** /api/club-analytics/last-six-months-turnover | |
|
|
18
|
+
|[**getLeastBookedTimeSlots**](#getleastbookedtimeslots) | **GET** /api/club-analytics/bookings/least-booked-time-slots | |
|
|
19
|
+
|[**getLeastBookedWeekday**](#getleastbookedweekday) | **GET** /api/club-analytics/bookings/least-booked-weekday | |
|
|
16
20
|
|[**getMonthlyTurnOver**](#getmonthlyturnover) | **GET** /api/club-analytics/monthly-turnover | |
|
|
21
|
+
|[**getNewBookingsCount**](#getnewbookingscount) | **GET** /api/club-analytics/bookings/new | |
|
|
22
|
+
|[**getNewSubscribersCount**](#getnewsubscriberscount) | **GET** /api/club-analytics/subscribers/new | |
|
|
23
|
+
|[**getNoShowRate**](#getnoshowrate) | **GET** /api/club-analytics/bookings/no-show-rate | |
|
|
17
24
|
|[**getNumberOfClubUsers**](#getnumberofclubusers) | **GET** /api/club-analytics/users-count | |
|
|
18
25
|
|[**getRetentionRate**](#getretentionrate) | **GET** /api/club-analytics/retention-rate | |
|
|
19
26
|
|[**getRevenueBySport**](#getrevenuebysport) | **GET** /api/club-analytics/revenue-by-sport | |
|
|
@@ -75,6 +82,62 @@ const { status, data } = await apiInstance.getAnalyticsBySport(
|
|
|
75
82
|
|
|
76
83
|
[[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)
|
|
77
84
|
|
|
85
|
+
# **getBookingsPerDay**
|
|
86
|
+
> BookingsPerDayResponse getBookingsPerDay()
|
|
87
|
+
|
|
88
|
+
Nombre de réservations par jour en fonction des slots
|
|
89
|
+
|
|
90
|
+
### Example
|
|
91
|
+
|
|
92
|
+
```typescript
|
|
93
|
+
import {
|
|
94
|
+
ClubAnalyticsStaffApi,
|
|
95
|
+
Configuration
|
|
96
|
+
} from '@tennac-booking/sdk';
|
|
97
|
+
|
|
98
|
+
const configuration = new Configuration();
|
|
99
|
+
const apiInstance = new ClubAnalyticsStaffApi(configuration);
|
|
100
|
+
|
|
101
|
+
let startDate: string; // (optional) (default to undefined)
|
|
102
|
+
let endDate: string; // (optional) (default to undefined)
|
|
103
|
+
|
|
104
|
+
const { status, data } = await apiInstance.getBookingsPerDay(
|
|
105
|
+
startDate,
|
|
106
|
+
endDate
|
|
107
|
+
);
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
### Parameters
|
|
111
|
+
|
|
112
|
+
|Name | Type | Description | Notes|
|
|
113
|
+
|------------- | ------------- | ------------- | -------------|
|
|
114
|
+
| **startDate** | [**string**] | | (optional) defaults to undefined|
|
|
115
|
+
| **endDate** | [**string**] | | (optional) defaults to undefined|
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
### Return type
|
|
119
|
+
|
|
120
|
+
**BookingsPerDayResponse**
|
|
121
|
+
|
|
122
|
+
### Authorization
|
|
123
|
+
|
|
124
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
125
|
+
|
|
126
|
+
### HTTP request headers
|
|
127
|
+
|
|
128
|
+
- **Content-Type**: Not defined
|
|
129
|
+
- **Accept**: application/json
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
### HTTP response details
|
|
133
|
+
| Status code | Description | Response headers |
|
|
134
|
+
|-------------|-------------|------------------|
|
|
135
|
+
|**200** | Réservations par jour | - |
|
|
136
|
+
|**400** | Bad Request | - |
|
|
137
|
+
|**401** | Unauthorized | - |
|
|
138
|
+
|
|
139
|
+
[[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)
|
|
140
|
+
|
|
78
141
|
# **getClubPlayerBookingsById**
|
|
79
142
|
> ClubPlayerBookingsResponse getClubPlayerBookingsById()
|
|
80
143
|
|
|
@@ -307,6 +370,52 @@ const { status, data } = await apiInstance.getClubPlayers(
|
|
|
307
370
|
|
|
308
371
|
[[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)
|
|
309
372
|
|
|
373
|
+
# **getClubSubscribersSummary**
|
|
374
|
+
> ClubSubscriberSummaryResponse getClubSubscribersSummary()
|
|
375
|
+
|
|
376
|
+
Nombre total d\'abonnés actifs du club
|
|
377
|
+
|
|
378
|
+
### Example
|
|
379
|
+
|
|
380
|
+
```typescript
|
|
381
|
+
import {
|
|
382
|
+
ClubAnalyticsStaffApi,
|
|
383
|
+
Configuration
|
|
384
|
+
} from '@tennac-booking/sdk';
|
|
385
|
+
|
|
386
|
+
const configuration = new Configuration();
|
|
387
|
+
const apiInstance = new ClubAnalyticsStaffApi(configuration);
|
|
388
|
+
|
|
389
|
+
const { status, data } = await apiInstance.getClubSubscribersSummary();
|
|
390
|
+
```
|
|
391
|
+
|
|
392
|
+
### Parameters
|
|
393
|
+
This endpoint does not have any parameters.
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
### Return type
|
|
397
|
+
|
|
398
|
+
**ClubSubscriberSummaryResponse**
|
|
399
|
+
|
|
400
|
+
### Authorization
|
|
401
|
+
|
|
402
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
403
|
+
|
|
404
|
+
### HTTP request headers
|
|
405
|
+
|
|
406
|
+
- **Content-Type**: Not defined
|
|
407
|
+
- **Accept**: application/json
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
### HTTP response details
|
|
411
|
+
| Status code | Description | Response headers |
|
|
412
|
+
|-------------|-------------|------------------|
|
|
413
|
+
|**200** | Total des abonnés | - |
|
|
414
|
+
|**400** | Bad Request | - |
|
|
415
|
+
|**401** | Unauthorized | - |
|
|
416
|
+
|
|
417
|
+
[[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)
|
|
418
|
+
|
|
310
419
|
# **getDailyTurnOver**
|
|
311
420
|
> DailyTurnoverResponse getDailyTurnOver()
|
|
312
421
|
|
|
@@ -510,6 +619,105 @@ This endpoint does not have any parameters.
|
|
|
510
619
|
|
|
511
620
|
[[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)
|
|
512
621
|
|
|
622
|
+
# **getLeastBookedTimeSlots**
|
|
623
|
+
> LeastBookedTimeSlotsResponse getLeastBookedTimeSlots()
|
|
624
|
+
|
|
625
|
+
Créneaux horaires les moins réservés (3 derniers mois)
|
|
626
|
+
|
|
627
|
+
### Example
|
|
628
|
+
|
|
629
|
+
```typescript
|
|
630
|
+
import {
|
|
631
|
+
ClubAnalyticsStaffApi,
|
|
632
|
+
Configuration
|
|
633
|
+
} from '@tennac-booking/sdk';
|
|
634
|
+
|
|
635
|
+
const configuration = new Configuration();
|
|
636
|
+
const apiInstance = new ClubAnalyticsStaffApi(configuration);
|
|
637
|
+
|
|
638
|
+
let limit: number; // (optional) (default to undefined)
|
|
639
|
+
|
|
640
|
+
const { status, data } = await apiInstance.getLeastBookedTimeSlots(
|
|
641
|
+
limit
|
|
642
|
+
);
|
|
643
|
+
```
|
|
644
|
+
|
|
645
|
+
### Parameters
|
|
646
|
+
|
|
647
|
+
|Name | Type | Description | Notes|
|
|
648
|
+
|------------- | ------------- | ------------- | -------------|
|
|
649
|
+
| **limit** | [**number**] | | (optional) defaults to undefined|
|
|
650
|
+
|
|
651
|
+
|
|
652
|
+
### Return type
|
|
653
|
+
|
|
654
|
+
**LeastBookedTimeSlotsResponse**
|
|
655
|
+
|
|
656
|
+
### Authorization
|
|
657
|
+
|
|
658
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
659
|
+
|
|
660
|
+
### HTTP request headers
|
|
661
|
+
|
|
662
|
+
- **Content-Type**: Not defined
|
|
663
|
+
- **Accept**: application/json
|
|
664
|
+
|
|
665
|
+
|
|
666
|
+
### HTTP response details
|
|
667
|
+
| Status code | Description | Response headers |
|
|
668
|
+
|-------------|-------------|------------------|
|
|
669
|
+
|**200** | Créneaux les moins réservés | - |
|
|
670
|
+
|**400** | Bad Request | - |
|
|
671
|
+
|**401** | Unauthorized | - |
|
|
672
|
+
|
|
673
|
+
[[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)
|
|
674
|
+
|
|
675
|
+
# **getLeastBookedWeekday**
|
|
676
|
+
> LeastBookedWeekdayResponse getLeastBookedWeekday()
|
|
677
|
+
|
|
678
|
+
Jour de la semaine le moins réservé (3 derniers mois)
|
|
679
|
+
|
|
680
|
+
### Example
|
|
681
|
+
|
|
682
|
+
```typescript
|
|
683
|
+
import {
|
|
684
|
+
ClubAnalyticsStaffApi,
|
|
685
|
+
Configuration
|
|
686
|
+
} from '@tennac-booking/sdk';
|
|
687
|
+
|
|
688
|
+
const configuration = new Configuration();
|
|
689
|
+
const apiInstance = new ClubAnalyticsStaffApi(configuration);
|
|
690
|
+
|
|
691
|
+
const { status, data } = await apiInstance.getLeastBookedWeekday();
|
|
692
|
+
```
|
|
693
|
+
|
|
694
|
+
### Parameters
|
|
695
|
+
This endpoint does not have any parameters.
|
|
696
|
+
|
|
697
|
+
|
|
698
|
+
### Return type
|
|
699
|
+
|
|
700
|
+
**LeastBookedWeekdayResponse**
|
|
701
|
+
|
|
702
|
+
### Authorization
|
|
703
|
+
|
|
704
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
705
|
+
|
|
706
|
+
### HTTP request headers
|
|
707
|
+
|
|
708
|
+
- **Content-Type**: Not defined
|
|
709
|
+
- **Accept**: application/json
|
|
710
|
+
|
|
711
|
+
|
|
712
|
+
### HTTP response details
|
|
713
|
+
| Status code | Description | Response headers |
|
|
714
|
+
|-------------|-------------|------------------|
|
|
715
|
+
|**200** | Jour le moins réservé | - |
|
|
716
|
+
|**400** | Bad Request | - |
|
|
717
|
+
|**401** | Unauthorized | - |
|
|
718
|
+
|
|
719
|
+
[[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)
|
|
720
|
+
|
|
513
721
|
# **getMonthlyTurnOver**
|
|
514
722
|
> MonthlyTurnoverResponse getMonthlyTurnOver()
|
|
515
723
|
|
|
@@ -567,6 +775,174 @@ const { status, data } = await apiInstance.getMonthlyTurnOver(
|
|
|
567
775
|
|
|
568
776
|
[[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)
|
|
569
777
|
|
|
778
|
+
# **getNewBookingsCount**
|
|
779
|
+
> ClubNewBookingsResponse getNewBookingsCount()
|
|
780
|
+
|
|
781
|
+
Nouvelles réservations créées sur une période
|
|
782
|
+
|
|
783
|
+
### Example
|
|
784
|
+
|
|
785
|
+
```typescript
|
|
786
|
+
import {
|
|
787
|
+
ClubAnalyticsStaffApi,
|
|
788
|
+
Configuration
|
|
789
|
+
} from '@tennac-booking/sdk';
|
|
790
|
+
|
|
791
|
+
const configuration = new Configuration();
|
|
792
|
+
const apiInstance = new ClubAnalyticsStaffApi(configuration);
|
|
793
|
+
|
|
794
|
+
let startDate: string; // (optional) (default to undefined)
|
|
795
|
+
let endDate: string; // (optional) (default to undefined)
|
|
796
|
+
|
|
797
|
+
const { status, data } = await apiInstance.getNewBookingsCount(
|
|
798
|
+
startDate,
|
|
799
|
+
endDate
|
|
800
|
+
);
|
|
801
|
+
```
|
|
802
|
+
|
|
803
|
+
### Parameters
|
|
804
|
+
|
|
805
|
+
|Name | Type | Description | Notes|
|
|
806
|
+
|------------- | ------------- | ------------- | -------------|
|
|
807
|
+
| **startDate** | [**string**] | | (optional) defaults to undefined|
|
|
808
|
+
| **endDate** | [**string**] | | (optional) defaults to undefined|
|
|
809
|
+
|
|
810
|
+
|
|
811
|
+
### Return type
|
|
812
|
+
|
|
813
|
+
**ClubNewBookingsResponse**
|
|
814
|
+
|
|
815
|
+
### Authorization
|
|
816
|
+
|
|
817
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
818
|
+
|
|
819
|
+
### HTTP request headers
|
|
820
|
+
|
|
821
|
+
- **Content-Type**: Not defined
|
|
822
|
+
- **Accept**: application/json
|
|
823
|
+
|
|
824
|
+
|
|
825
|
+
### HTTP response details
|
|
826
|
+
| Status code | Description | Response headers |
|
|
827
|
+
|-------------|-------------|------------------|
|
|
828
|
+
|**200** | Nouvelles réservations | - |
|
|
829
|
+
|**400** | Bad Request | - |
|
|
830
|
+
|**401** | Unauthorized | - |
|
|
831
|
+
|
|
832
|
+
[[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)
|
|
833
|
+
|
|
834
|
+
# **getNewSubscribersCount**
|
|
835
|
+
> ClubNewSubscribersResponse getNewSubscribersCount()
|
|
836
|
+
|
|
837
|
+
Nouveaux abonnés sur une période
|
|
838
|
+
|
|
839
|
+
### Example
|
|
840
|
+
|
|
841
|
+
```typescript
|
|
842
|
+
import {
|
|
843
|
+
ClubAnalyticsStaffApi,
|
|
844
|
+
Configuration
|
|
845
|
+
} from '@tennac-booking/sdk';
|
|
846
|
+
|
|
847
|
+
const configuration = new Configuration();
|
|
848
|
+
const apiInstance = new ClubAnalyticsStaffApi(configuration);
|
|
849
|
+
|
|
850
|
+
let startDate: string; // (optional) (default to undefined)
|
|
851
|
+
let endDate: string; // (optional) (default to undefined)
|
|
852
|
+
|
|
853
|
+
const { status, data } = await apiInstance.getNewSubscribersCount(
|
|
854
|
+
startDate,
|
|
855
|
+
endDate
|
|
856
|
+
);
|
|
857
|
+
```
|
|
858
|
+
|
|
859
|
+
### Parameters
|
|
860
|
+
|
|
861
|
+
|Name | Type | Description | Notes|
|
|
862
|
+
|------------- | ------------- | ------------- | -------------|
|
|
863
|
+
| **startDate** | [**string**] | | (optional) defaults to undefined|
|
|
864
|
+
| **endDate** | [**string**] | | (optional) defaults to undefined|
|
|
865
|
+
|
|
866
|
+
|
|
867
|
+
### Return type
|
|
868
|
+
|
|
869
|
+
**ClubNewSubscribersResponse**
|
|
870
|
+
|
|
871
|
+
### Authorization
|
|
872
|
+
|
|
873
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
874
|
+
|
|
875
|
+
### HTTP request headers
|
|
876
|
+
|
|
877
|
+
- **Content-Type**: Not defined
|
|
878
|
+
- **Accept**: application/json
|
|
879
|
+
|
|
880
|
+
|
|
881
|
+
### HTTP response details
|
|
882
|
+
| Status code | Description | Response headers |
|
|
883
|
+
|-------------|-------------|------------------|
|
|
884
|
+
|**200** | Nouveaux abonnés sur la période | - |
|
|
885
|
+
|**400** | Bad Request | - |
|
|
886
|
+
|**401** | Unauthorized | - |
|
|
887
|
+
|
|
888
|
+
[[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)
|
|
889
|
+
|
|
890
|
+
# **getNoShowRate**
|
|
891
|
+
> NoShowRateResponse getNoShowRate()
|
|
892
|
+
|
|
893
|
+
Taux de no-show global ou sur une période
|
|
894
|
+
|
|
895
|
+
### Example
|
|
896
|
+
|
|
897
|
+
```typescript
|
|
898
|
+
import {
|
|
899
|
+
ClubAnalyticsStaffApi,
|
|
900
|
+
Configuration
|
|
901
|
+
} from '@tennac-booking/sdk';
|
|
902
|
+
|
|
903
|
+
const configuration = new Configuration();
|
|
904
|
+
const apiInstance = new ClubAnalyticsStaffApi(configuration);
|
|
905
|
+
|
|
906
|
+
let startDate: string; // (optional) (default to undefined)
|
|
907
|
+
let endDate: string; // (optional) (default to undefined)
|
|
908
|
+
|
|
909
|
+
const { status, data } = await apiInstance.getNoShowRate(
|
|
910
|
+
startDate,
|
|
911
|
+
endDate
|
|
912
|
+
);
|
|
913
|
+
```
|
|
914
|
+
|
|
915
|
+
### Parameters
|
|
916
|
+
|
|
917
|
+
|Name | Type | Description | Notes|
|
|
918
|
+
|------------- | ------------- | ------------- | -------------|
|
|
919
|
+
| **startDate** | [**string**] | | (optional) defaults to undefined|
|
|
920
|
+
| **endDate** | [**string**] | | (optional) defaults to undefined|
|
|
921
|
+
|
|
922
|
+
|
|
923
|
+
### Return type
|
|
924
|
+
|
|
925
|
+
**NoShowRateResponse**
|
|
926
|
+
|
|
927
|
+
### Authorization
|
|
928
|
+
|
|
929
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
930
|
+
|
|
931
|
+
### HTTP request headers
|
|
932
|
+
|
|
933
|
+
- **Content-Type**: Not defined
|
|
934
|
+
- **Accept**: application/json
|
|
935
|
+
|
|
936
|
+
|
|
937
|
+
### HTTP response details
|
|
938
|
+
| Status code | Description | Response headers |
|
|
939
|
+
|-------------|-------------|------------------|
|
|
940
|
+
|**200** | Taux de no-show | - |
|
|
941
|
+
|**400** | Bad Request | - |
|
|
942
|
+
|**401** | Unauthorized | - |
|
|
943
|
+
|
|
944
|
+
[[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)
|
|
945
|
+
|
|
570
946
|
# **getNumberOfClubUsers**
|
|
571
947
|
> ClubUserCountResponse getNumberOfClubUsers()
|
|
572
948
|
|
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ClubDayInterval
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**
|
|
9
|
-
**
|
|
8
|
+
**start** | **string** | | [default to undefined]
|
|
9
|
+
**end** | **string** | | [default to undefined]
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import {
|
|
14
|
+
import { ClubDayInterval } from '@tennac-booking/sdk';
|
|
15
15
|
|
|
16
|
-
const instance:
|
|
17
|
-
|
|
18
|
-
|
|
16
|
+
const instance: ClubDayInterval = {
|
|
17
|
+
start,
|
|
18
|
+
end,
|
|
19
19
|
};
|
|
20
20
|
```
|
|
21
21
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**schedule** | [**
|
|
8
|
+
**schedule** | [**RecordWeekdayKeyClubDaySchedule**](RecordWeekdayKeyClubDaySchedule.md) | | [default to undefined]
|
|
9
9
|
**pricingPeriods** | [**Array<ClubPricingPeriodResponse>**](ClubPricingPeriodResponse.md) | | [default to undefined]
|
|
10
10
|
|
|
11
11
|
## Example
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# ClubNewBookingsResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**startDate** | **string** | Date de début incluse (format ISO) | [default to undefined]
|
|
9
|
+
**endDate** | **string** | Date de fin incluse (format ISO) | [default to undefined]
|
|
10
|
+
**newBookings** | **number** | Nombre de nouvelles réservations créées durant la période | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ClubNewBookingsResponse } from '@tennac-booking/sdk';
|
|
16
|
+
|
|
17
|
+
const instance: ClubNewBookingsResponse = {
|
|
18
|
+
startDate,
|
|
19
|
+
endDate,
|
|
20
|
+
newBookings,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# ClubNewSubscribersResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**startDate** | **string** | Date de début incluse (format ISO) | [default to undefined]
|
|
9
|
+
**endDate** | **string** | Date de fin incluse (format ISO) | [default to undefined]
|
|
10
|
+
**newSubscribers** | **number** | Nombre de nouveaux abonnés sur la période | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ClubNewSubscribersResponse } from '@tennac-booking/sdk';
|
|
16
|
+
|
|
17
|
+
const instance: ClubNewSubscribersResponse = {
|
|
18
|
+
startDate,
|
|
19
|
+
endDate,
|
|
20
|
+
newSubscribers,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -4,12 +4,65 @@ All URIs are relative to *http://localhost*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
+
|[**duplicateDaySchedule**](#duplicatedayschedule) | **POST** /api/club-settings/hours/day/duplicate | |
|
|
7
8
|
|[**updateAccessSettings**](#updateaccesssettings) | **PATCH** /api/club-settings/access | |
|
|
8
9
|
|[**updateClubGeneralSettings**](#updateclubgeneralsettings) | **PATCH** /api/club-settings/settings/general | |
|
|
10
|
+
|[**updateDaySchedule**](#updatedayschedule) | **PATCH** /api/club-settings/hours/day/{day} | |
|
|
9
11
|
|[**updateHoursSettings**](#updatehourssettings) | **PUT** /api/club-settings/hours | |
|
|
10
12
|
|[**updatePresentationSettings**](#updatepresentationsettings) | **PATCH** /api/club-settings/presentation | |
|
|
11
13
|
|[**updateReservationSettings**](#updatereservationsettings) | **PUT** /api/club-settings/reservation | |
|
|
12
14
|
|
|
15
|
+
# **duplicateDaySchedule**
|
|
16
|
+
> ClubHoursSettingsResponse duplicateDaySchedule(duplicateClubDayScheduleRequest)
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
### Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import {
|
|
23
|
+
ClubSettingsManagerApi,
|
|
24
|
+
Configuration,
|
|
25
|
+
DuplicateClubDayScheduleRequest
|
|
26
|
+
} from '@tennac-booking/sdk';
|
|
27
|
+
|
|
28
|
+
const configuration = new Configuration();
|
|
29
|
+
const apiInstance = new ClubSettingsManagerApi(configuration);
|
|
30
|
+
|
|
31
|
+
let duplicateClubDayScheduleRequest: DuplicateClubDayScheduleRequest; //
|
|
32
|
+
|
|
33
|
+
const { status, data } = await apiInstance.duplicateDaySchedule(
|
|
34
|
+
duplicateClubDayScheduleRequest
|
|
35
|
+
);
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### Parameters
|
|
39
|
+
|
|
40
|
+
|Name | Type | Description | Notes|
|
|
41
|
+
|------------- | ------------- | ------------- | -------------|
|
|
42
|
+
| **duplicateClubDayScheduleRequest** | **DuplicateClubDayScheduleRequest**| | |
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
### Return type
|
|
46
|
+
|
|
47
|
+
**ClubHoursSettingsResponse**
|
|
48
|
+
|
|
49
|
+
### Authorization
|
|
50
|
+
|
|
51
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
52
|
+
|
|
53
|
+
### HTTP request headers
|
|
54
|
+
|
|
55
|
+
- **Content-Type**: application/json
|
|
56
|
+
- **Accept**: application/json
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
### HTTP response details
|
|
60
|
+
| Status code | Description | Response headers |
|
|
61
|
+
|-------------|-------------|------------------|
|
|
62
|
+
|**200** | Intervalles du jour dupliqués | - |
|
|
63
|
+
|
|
64
|
+
[[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)
|
|
65
|
+
|
|
13
66
|
# **updateAccessSettings**
|
|
14
67
|
> ClubAccessSettingsResponse updateAccessSettings(updateClubAccessSettingsRequest)
|
|
15
68
|
|
|
@@ -112,6 +165,60 @@ const { status, data } = await apiInstance.updateClubGeneralSettings(
|
|
|
112
165
|
|
|
113
166
|
[[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)
|
|
114
167
|
|
|
168
|
+
# **updateDaySchedule**
|
|
169
|
+
> ClubHoursSettingsResponse updateDaySchedule(updateClubDayScheduleRequest)
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
### Example
|
|
173
|
+
|
|
174
|
+
```typescript
|
|
175
|
+
import {
|
|
176
|
+
ClubSettingsManagerApi,
|
|
177
|
+
Configuration,
|
|
178
|
+
UpdateClubDayScheduleRequest
|
|
179
|
+
} from '@tennac-booking/sdk';
|
|
180
|
+
|
|
181
|
+
const configuration = new Configuration();
|
|
182
|
+
const apiInstance = new ClubSettingsManagerApi(configuration);
|
|
183
|
+
|
|
184
|
+
let day: WeekdayKey; // (default to undefined)
|
|
185
|
+
let updateClubDayScheduleRequest: UpdateClubDayScheduleRequest; //
|
|
186
|
+
|
|
187
|
+
const { status, data } = await apiInstance.updateDaySchedule(
|
|
188
|
+
day,
|
|
189
|
+
updateClubDayScheduleRequest
|
|
190
|
+
);
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
### Parameters
|
|
194
|
+
|
|
195
|
+
|Name | Type | Description | Notes|
|
|
196
|
+
|------------- | ------------- | ------------- | -------------|
|
|
197
|
+
| **updateClubDayScheduleRequest** | **UpdateClubDayScheduleRequest**| | |
|
|
198
|
+
| **day** | **WeekdayKey** | | defaults to undefined|
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
### Return type
|
|
202
|
+
|
|
203
|
+
**ClubHoursSettingsResponse**
|
|
204
|
+
|
|
205
|
+
### Authorization
|
|
206
|
+
|
|
207
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
208
|
+
|
|
209
|
+
### HTTP request headers
|
|
210
|
+
|
|
211
|
+
- **Content-Type**: application/json
|
|
212
|
+
- **Accept**: application/json
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
### HTTP response details
|
|
216
|
+
| Status code | Description | Response headers |
|
|
217
|
+
|-------------|-------------|------------------|
|
|
218
|
+
|**200** | Intervalles d\'un jour mis à jour | - |
|
|
219
|
+
|
|
220
|
+
[[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)
|
|
221
|
+
|
|
115
222
|
# **updateHoursSettings**
|
|
116
223
|
> ClubHoursSettingsResponse updateHoursSettings(updateClubHoursSettingsRequest)
|
|
117
224
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# ClubSubscriberSummaryResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**totalSubscribers** | **number** | Nombre total d\'abonnés actifs au club | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { ClubSubscriberSummaryResponse } from '@tennac-booking/sdk';
|
|
14
|
+
|
|
15
|
+
const instance: ClubSubscriberSummaryResponse = {
|
|
16
|
+
totalSubscribers,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|