@tennac-booking/sdk 1.0.142 → 1.0.144
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 +4 -0
- package/README.md +4 -0
- package/api.ts +491 -7
- package/dist/api.d.ts +363 -4
- package/dist/api.js +207 -11
- package/dist/esm/api.d.ts +363 -4
- package/dist/esm/api.js +199 -7
- package/docs/BookingsPerDayItem.md +8 -0
- package/docs/ClubAnalyticsStaffApi.md +12 -2
- package/docs/ClubCustomerSettingsResponse.md +38 -0
- package/docs/ClubCustomerStaffApi.md +113 -0
- package/docs/ClubNewBookingsResponse.md +8 -0
- package/docs/ClubNewSubscribersResponse.md +8 -0
- package/docs/CreateEventRequest.md +2 -0
- package/docs/EventResponse.md +2 -0
- package/docs/MonthlyTurnoverResponse.md +8 -0
- package/docs/RetentionRateResponse.md +8 -0
- package/docs/TrendDirection.md +12 -0
- package/docs/UpdateEventRequest.md +2 -0
- package/package.json +1 -1
package/dist/esm/api.js
CHANGED
|
@@ -305,6 +305,16 @@ export const SurfaceType = {
|
|
|
305
305
|
Carpet: 'carpet',
|
|
306
306
|
Wooden: 'wooden'
|
|
307
307
|
};
|
|
308
|
+
/**
|
|
309
|
+
*
|
|
310
|
+
* @export
|
|
311
|
+
* @enum {string}
|
|
312
|
+
*/
|
|
313
|
+
export const TrendDirection = {
|
|
314
|
+
Up: 'up',
|
|
315
|
+
Down: 'down',
|
|
316
|
+
Steady: 'steady'
|
|
317
|
+
};
|
|
308
318
|
export const UpdateClubMemberRequestRoleEnum = {
|
|
309
319
|
Admin: 'admin',
|
|
310
320
|
Manager: 'manager',
|
|
@@ -2598,10 +2608,12 @@ export const ClubAnalyticsStaffApiAxiosParamCreator = function (configuration) {
|
|
|
2598
2608
|
}),
|
|
2599
2609
|
/**
|
|
2600
2610
|
* Calcule le taux de fidélisation des joueurs
|
|
2611
|
+
* @param {string} [startDate]
|
|
2612
|
+
* @param {string} [endDate]
|
|
2601
2613
|
* @param {*} [options] Override http request option.
|
|
2602
2614
|
* @throws {RequiredError}
|
|
2603
2615
|
*/
|
|
2604
|
-
getRetentionRate: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
|
|
2616
|
+
getRetentionRate: (startDate_1, endDate_1, ...args_1) => __awaiter(this, [startDate_1, endDate_1, ...args_1], void 0, function* (startDate, endDate, options = {}) {
|
|
2605
2617
|
const localVarPath = `/api/club-analytics/retention-rate`;
|
|
2606
2618
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2607
2619
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -2615,6 +2627,12 @@ export const ClubAnalyticsStaffApiAxiosParamCreator = function (configuration) {
|
|
|
2615
2627
|
// authentication bearerAuth required
|
|
2616
2628
|
// http bearer authentication required
|
|
2617
2629
|
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
2630
|
+
if (startDate !== undefined) {
|
|
2631
|
+
localVarQueryParameter['startDate'] = startDate;
|
|
2632
|
+
}
|
|
2633
|
+
if (endDate !== undefined) {
|
|
2634
|
+
localVarQueryParameter['endDate'] = endDate;
|
|
2635
|
+
}
|
|
2618
2636
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2619
2637
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2620
2638
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -3024,13 +3042,15 @@ export const ClubAnalyticsStaffApiFp = function (configuration) {
|
|
|
3024
3042
|
},
|
|
3025
3043
|
/**
|
|
3026
3044
|
* Calcule le taux de fidélisation des joueurs
|
|
3045
|
+
* @param {string} [startDate]
|
|
3046
|
+
* @param {string} [endDate]
|
|
3027
3047
|
* @param {*} [options] Override http request option.
|
|
3028
3048
|
* @throws {RequiredError}
|
|
3029
3049
|
*/
|
|
3030
|
-
getRetentionRate(options) {
|
|
3050
|
+
getRetentionRate(startDate, endDate, options) {
|
|
3031
3051
|
return __awaiter(this, void 0, void 0, function* () {
|
|
3032
3052
|
var _a, _b, _c;
|
|
3033
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getRetentionRate(options);
|
|
3053
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getRetentionRate(startDate, endDate, options);
|
|
3034
3054
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
3035
3055
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ClubAnalyticsStaffApi.getRetentionRate']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
3036
3056
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -3261,11 +3281,12 @@ export const ClubAnalyticsStaffApiFactory = function (configuration, basePath, a
|
|
|
3261
3281
|
},
|
|
3262
3282
|
/**
|
|
3263
3283
|
* Calcule le taux de fidélisation des joueurs
|
|
3284
|
+
* @param {ClubAnalyticsStaffApiGetRetentionRateRequest} requestParameters Request parameters.
|
|
3264
3285
|
* @param {*} [options] Override http request option.
|
|
3265
3286
|
* @throws {RequiredError}
|
|
3266
3287
|
*/
|
|
3267
|
-
getRetentionRate(options) {
|
|
3268
|
-
return localVarFp.getRetentionRate(options).then((request) => request(axios, basePath));
|
|
3288
|
+
getRetentionRate(requestParameters = {}, options) {
|
|
3289
|
+
return localVarFp.getRetentionRate(requestParameters.startDate, requestParameters.endDate, options).then((request) => request(axios, basePath));
|
|
3269
3290
|
},
|
|
3270
3291
|
/**
|
|
3271
3292
|
* Récupère le chiffre d\'affaires par sport
|
|
@@ -3486,12 +3507,13 @@ export class ClubAnalyticsStaffApi extends BaseAPI {
|
|
|
3486
3507
|
}
|
|
3487
3508
|
/**
|
|
3488
3509
|
* Calcule le taux de fidélisation des joueurs
|
|
3510
|
+
* @param {ClubAnalyticsStaffApiGetRetentionRateRequest} requestParameters Request parameters.
|
|
3489
3511
|
* @param {*} [options] Override http request option.
|
|
3490
3512
|
* @throws {RequiredError}
|
|
3491
3513
|
* @memberof ClubAnalyticsStaffApi
|
|
3492
3514
|
*/
|
|
3493
|
-
getRetentionRate(options) {
|
|
3494
|
-
return ClubAnalyticsStaffApiFp(this.configuration).getRetentionRate(options).then((request) => request(this.axios, this.basePath));
|
|
3515
|
+
getRetentionRate(requestParameters = {}, options) {
|
|
3516
|
+
return ClubAnalyticsStaffApiFp(this.configuration).getRetentionRate(requestParameters.startDate, requestParameters.endDate, options).then((request) => request(this.axios, this.basePath));
|
|
3495
3517
|
}
|
|
3496
3518
|
/**
|
|
3497
3519
|
* Récupère le chiffre d\'affaires par sport
|
|
@@ -3531,6 +3553,176 @@ export class ClubAnalyticsStaffApi extends BaseAPI {
|
|
|
3531
3553
|
return ClubAnalyticsStaffApiFp(this.configuration).getYearlyTurnOver(requestParameters.year, options).then((request) => request(this.axios, this.basePath));
|
|
3532
3554
|
}
|
|
3533
3555
|
}
|
|
3556
|
+
/**
|
|
3557
|
+
* ClubCustomerStaffApi - axios parameter creator
|
|
3558
|
+
* @export
|
|
3559
|
+
*/
|
|
3560
|
+
export const ClubCustomerStaffApiAxiosParamCreator = function (configuration) {
|
|
3561
|
+
return {
|
|
3562
|
+
/**
|
|
3563
|
+
*
|
|
3564
|
+
* @param {string} userId
|
|
3565
|
+
* @param {*} [options] Override http request option.
|
|
3566
|
+
* @throws {RequiredError}
|
|
3567
|
+
*/
|
|
3568
|
+
getClubCustomerSettings: (userId_1, ...args_1) => __awaiter(this, [userId_1, ...args_1], void 0, function* (userId, options = {}) {
|
|
3569
|
+
// verify required parameter 'userId' is not null or undefined
|
|
3570
|
+
assertParamExists('getClubCustomerSettings', 'userId', userId);
|
|
3571
|
+
const localVarPath = `/api/clubCustomers/clubCustomer/{userId}/settings`
|
|
3572
|
+
.replace(`{${"userId"}}`, encodeURIComponent(String(userId)));
|
|
3573
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3574
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3575
|
+
let baseOptions;
|
|
3576
|
+
if (configuration) {
|
|
3577
|
+
baseOptions = configuration.baseOptions;
|
|
3578
|
+
}
|
|
3579
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
3580
|
+
const localVarHeaderParameter = {};
|
|
3581
|
+
const localVarQueryParameter = {};
|
|
3582
|
+
// authentication bearerAuth required
|
|
3583
|
+
// http bearer authentication required
|
|
3584
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3585
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3586
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3587
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
3588
|
+
return {
|
|
3589
|
+
url: toPathString(localVarUrlObj),
|
|
3590
|
+
options: localVarRequestOptions,
|
|
3591
|
+
};
|
|
3592
|
+
}),
|
|
3593
|
+
/**
|
|
3594
|
+
*
|
|
3595
|
+
* @param {string} userId
|
|
3596
|
+
* @param {ClubCustomerSettingsResponse} clubCustomerSettingsResponse
|
|
3597
|
+
* @param {*} [options] Override http request option.
|
|
3598
|
+
* @throws {RequiredError}
|
|
3599
|
+
*/
|
|
3600
|
+
updateClubCustomerSettings: (userId_1, clubCustomerSettingsResponse_1, ...args_1) => __awaiter(this, [userId_1, clubCustomerSettingsResponse_1, ...args_1], void 0, function* (userId, clubCustomerSettingsResponse, options = {}) {
|
|
3601
|
+
// verify required parameter 'userId' is not null or undefined
|
|
3602
|
+
assertParamExists('updateClubCustomerSettings', 'userId', userId);
|
|
3603
|
+
// verify required parameter 'clubCustomerSettingsResponse' is not null or undefined
|
|
3604
|
+
assertParamExists('updateClubCustomerSettings', 'clubCustomerSettingsResponse', clubCustomerSettingsResponse);
|
|
3605
|
+
const localVarPath = `/api/clubCustomers/clubCustomer/{userId}/settings`
|
|
3606
|
+
.replace(`{${"userId"}}`, encodeURIComponent(String(userId)));
|
|
3607
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3608
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3609
|
+
let baseOptions;
|
|
3610
|
+
if (configuration) {
|
|
3611
|
+
baseOptions = configuration.baseOptions;
|
|
3612
|
+
}
|
|
3613
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
|
|
3614
|
+
const localVarHeaderParameter = {};
|
|
3615
|
+
const localVarQueryParameter = {};
|
|
3616
|
+
// authentication bearerAuth required
|
|
3617
|
+
// http bearer authentication required
|
|
3618
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
3619
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
3620
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3621
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3622
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
3623
|
+
localVarRequestOptions.data = serializeDataIfNeeded(clubCustomerSettingsResponse, localVarRequestOptions, configuration);
|
|
3624
|
+
return {
|
|
3625
|
+
url: toPathString(localVarUrlObj),
|
|
3626
|
+
options: localVarRequestOptions,
|
|
3627
|
+
};
|
|
3628
|
+
}),
|
|
3629
|
+
};
|
|
3630
|
+
};
|
|
3631
|
+
/**
|
|
3632
|
+
* ClubCustomerStaffApi - functional programming interface
|
|
3633
|
+
* @export
|
|
3634
|
+
*/
|
|
3635
|
+
export const ClubCustomerStaffApiFp = function (configuration) {
|
|
3636
|
+
const localVarAxiosParamCreator = ClubCustomerStaffApiAxiosParamCreator(configuration);
|
|
3637
|
+
return {
|
|
3638
|
+
/**
|
|
3639
|
+
*
|
|
3640
|
+
* @param {string} userId
|
|
3641
|
+
* @param {*} [options] Override http request option.
|
|
3642
|
+
* @throws {RequiredError}
|
|
3643
|
+
*/
|
|
3644
|
+
getClubCustomerSettings(userId, options) {
|
|
3645
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
3646
|
+
var _a, _b, _c;
|
|
3647
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getClubCustomerSettings(userId, options);
|
|
3648
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
3649
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ClubCustomerStaffApi.getClubCustomerSettings']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
3650
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3651
|
+
});
|
|
3652
|
+
},
|
|
3653
|
+
/**
|
|
3654
|
+
*
|
|
3655
|
+
* @param {string} userId
|
|
3656
|
+
* @param {ClubCustomerSettingsResponse} clubCustomerSettingsResponse
|
|
3657
|
+
* @param {*} [options] Override http request option.
|
|
3658
|
+
* @throws {RequiredError}
|
|
3659
|
+
*/
|
|
3660
|
+
updateClubCustomerSettings(userId, clubCustomerSettingsResponse, options) {
|
|
3661
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
3662
|
+
var _a, _b, _c;
|
|
3663
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.updateClubCustomerSettings(userId, clubCustomerSettingsResponse, options);
|
|
3664
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
3665
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ClubCustomerStaffApi.updateClubCustomerSettings']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
3666
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3667
|
+
});
|
|
3668
|
+
},
|
|
3669
|
+
};
|
|
3670
|
+
};
|
|
3671
|
+
/**
|
|
3672
|
+
* ClubCustomerStaffApi - factory interface
|
|
3673
|
+
* @export
|
|
3674
|
+
*/
|
|
3675
|
+
export const ClubCustomerStaffApiFactory = function (configuration, basePath, axios) {
|
|
3676
|
+
const localVarFp = ClubCustomerStaffApiFp(configuration);
|
|
3677
|
+
return {
|
|
3678
|
+
/**
|
|
3679
|
+
*
|
|
3680
|
+
* @param {ClubCustomerStaffApiGetClubCustomerSettingsRequest} requestParameters Request parameters.
|
|
3681
|
+
* @param {*} [options] Override http request option.
|
|
3682
|
+
* @throws {RequiredError}
|
|
3683
|
+
*/
|
|
3684
|
+
getClubCustomerSettings(requestParameters, options) {
|
|
3685
|
+
return localVarFp.getClubCustomerSettings(requestParameters.userId, options).then((request) => request(axios, basePath));
|
|
3686
|
+
},
|
|
3687
|
+
/**
|
|
3688
|
+
*
|
|
3689
|
+
* @param {ClubCustomerStaffApiUpdateClubCustomerSettingsRequest} requestParameters Request parameters.
|
|
3690
|
+
* @param {*} [options] Override http request option.
|
|
3691
|
+
* @throws {RequiredError}
|
|
3692
|
+
*/
|
|
3693
|
+
updateClubCustomerSettings(requestParameters, options) {
|
|
3694
|
+
return localVarFp.updateClubCustomerSettings(requestParameters.userId, requestParameters.clubCustomerSettingsResponse, options).then((request) => request(axios, basePath));
|
|
3695
|
+
},
|
|
3696
|
+
};
|
|
3697
|
+
};
|
|
3698
|
+
/**
|
|
3699
|
+
* ClubCustomerStaffApi - object-oriented interface
|
|
3700
|
+
* @export
|
|
3701
|
+
* @class ClubCustomerStaffApi
|
|
3702
|
+
* @extends {BaseAPI}
|
|
3703
|
+
*/
|
|
3704
|
+
export class ClubCustomerStaffApi extends BaseAPI {
|
|
3705
|
+
/**
|
|
3706
|
+
*
|
|
3707
|
+
* @param {ClubCustomerStaffApiGetClubCustomerSettingsRequest} requestParameters Request parameters.
|
|
3708
|
+
* @param {*} [options] Override http request option.
|
|
3709
|
+
* @throws {RequiredError}
|
|
3710
|
+
* @memberof ClubCustomerStaffApi
|
|
3711
|
+
*/
|
|
3712
|
+
getClubCustomerSettings(requestParameters, options) {
|
|
3713
|
+
return ClubCustomerStaffApiFp(this.configuration).getClubCustomerSettings(requestParameters.userId, options).then((request) => request(this.axios, this.basePath));
|
|
3714
|
+
}
|
|
3715
|
+
/**
|
|
3716
|
+
*
|
|
3717
|
+
* @param {ClubCustomerStaffApiUpdateClubCustomerSettingsRequest} requestParameters Request parameters.
|
|
3718
|
+
* @param {*} [options] Override http request option.
|
|
3719
|
+
* @throws {RequiredError}
|
|
3720
|
+
* @memberof ClubCustomerStaffApi
|
|
3721
|
+
*/
|
|
3722
|
+
updateClubCustomerSettings(requestParameters, options) {
|
|
3723
|
+
return ClubCustomerStaffApiFp(this.configuration).updateClubCustomerSettings(requestParameters.userId, requestParameters.clubCustomerSettingsResponse, options).then((request) => request(this.axios, this.basePath));
|
|
3724
|
+
}
|
|
3725
|
+
}
|
|
3534
3726
|
/**
|
|
3535
3727
|
* ClubRolesManagerApi - axios parameter creator
|
|
3536
3728
|
* @export
|
|
@@ -5,6 +5,10 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**value** | **number** | Valeur mesurée sur la période actuelle | [default to undefined]
|
|
9
|
+
**reference** | **number** | Valeur de référence calculée avec la comparaison Same Weekday | [default to undefined]
|
|
10
|
+
**delta** | **number** | Différence entre la valeur actuelle et la référence | [default to undefined]
|
|
11
|
+
**trend** | [**TrendDirection**](TrendDirection.md) | | [default to undefined]
|
|
8
12
|
**date** | **string** | Jour au format YYYY-MM-DD | [default to undefined]
|
|
9
13
|
**bookingsCount** | **number** | Nombre de réservations dont la séance se déroule ce jour-là | [default to undefined]
|
|
10
14
|
|
|
@@ -14,6 +18,10 @@ Name | Type | Description | Notes
|
|
|
14
18
|
import { BookingsPerDayItem } from '@tennac-booking/sdk';
|
|
15
19
|
|
|
16
20
|
const instance: BookingsPerDayItem = {
|
|
21
|
+
value,
|
|
22
|
+
reference,
|
|
23
|
+
delta,
|
|
24
|
+
trend,
|
|
17
25
|
date,
|
|
18
26
|
bookingsCount,
|
|
19
27
|
};
|
|
@@ -1005,11 +1005,21 @@ import {
|
|
|
1005
1005
|
const configuration = new Configuration();
|
|
1006
1006
|
const apiInstance = new ClubAnalyticsStaffApi(configuration);
|
|
1007
1007
|
|
|
1008
|
-
|
|
1008
|
+
let startDate: string; // (optional) (default to undefined)
|
|
1009
|
+
let endDate: string; // (optional) (default to undefined)
|
|
1010
|
+
|
|
1011
|
+
const { status, data } = await apiInstance.getRetentionRate(
|
|
1012
|
+
startDate,
|
|
1013
|
+
endDate
|
|
1014
|
+
);
|
|
1009
1015
|
```
|
|
1010
1016
|
|
|
1011
1017
|
### Parameters
|
|
1012
|
-
|
|
1018
|
+
|
|
1019
|
+
|Name | Type | Description | Notes|
|
|
1020
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1021
|
+
| **startDate** | [**string**] | | (optional) defaults to undefined|
|
|
1022
|
+
| **endDate** | [**string**] | | (optional) defaults to undefined|
|
|
1013
1023
|
|
|
1014
1024
|
|
|
1015
1025
|
### Return type
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# ClubCustomerSettingsResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**userId** | **string** | | [default to undefined]
|
|
9
|
+
**clubId** | **string** | | [default to undefined]
|
|
10
|
+
**credits** | **number** | | [default to undefined]
|
|
11
|
+
**isBanned** | **boolean** | | [default to undefined]
|
|
12
|
+
**isIllimited** | **boolean** | | [default to undefined]
|
|
13
|
+
**isFree** | **boolean** | | [default to undefined]
|
|
14
|
+
**isNoShowForced** | **boolean** | | [default to undefined]
|
|
15
|
+
**paymentMethodSetupCompleted** | **boolean** | | [default to undefined]
|
|
16
|
+
**defaultPaymentMethodId** | **string** | | [default to undefined]
|
|
17
|
+
**subscriptions** | **Array<string>** | | [default to undefined]
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import { ClubCustomerSettingsResponse } from '@tennac-booking/sdk';
|
|
23
|
+
|
|
24
|
+
const instance: ClubCustomerSettingsResponse = {
|
|
25
|
+
userId,
|
|
26
|
+
clubId,
|
|
27
|
+
credits,
|
|
28
|
+
isBanned,
|
|
29
|
+
isIllimited,
|
|
30
|
+
isFree,
|
|
31
|
+
isNoShowForced,
|
|
32
|
+
paymentMethodSetupCompleted,
|
|
33
|
+
defaultPaymentMethodId,
|
|
34
|
+
subscriptions,
|
|
35
|
+
};
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
[[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,113 @@
|
|
|
1
|
+
# ClubCustomerStaffApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**getClubCustomerSettings**](#getclubcustomersettings) | **GET** /api/clubCustomers/clubCustomer/{userId}/settings | |
|
|
8
|
+
|[**updateClubCustomerSettings**](#updateclubcustomersettings) | **PATCH** /api/clubCustomers/clubCustomer/{userId}/settings | |
|
|
9
|
+
|
|
10
|
+
# **getClubCustomerSettings**
|
|
11
|
+
> ClubCustomerSettingsResponse getClubCustomerSettings()
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
### Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import {
|
|
18
|
+
ClubCustomerStaffApi,
|
|
19
|
+
Configuration
|
|
20
|
+
} from '@tennac-booking/sdk';
|
|
21
|
+
|
|
22
|
+
const configuration = new Configuration();
|
|
23
|
+
const apiInstance = new ClubCustomerStaffApi(configuration);
|
|
24
|
+
|
|
25
|
+
let userId: string; // (default to undefined)
|
|
26
|
+
|
|
27
|
+
const { status, data } = await apiInstance.getClubCustomerSettings(
|
|
28
|
+
userId
|
|
29
|
+
);
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
### Parameters
|
|
33
|
+
|
|
34
|
+
|Name | Type | Description | Notes|
|
|
35
|
+
|------------- | ------------- | ------------- | -------------|
|
|
36
|
+
| **userId** | [**string**] | | defaults to undefined|
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
### Return type
|
|
40
|
+
|
|
41
|
+
**ClubCustomerSettingsResponse**
|
|
42
|
+
|
|
43
|
+
### Authorization
|
|
44
|
+
|
|
45
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
46
|
+
|
|
47
|
+
### HTTP request headers
|
|
48
|
+
|
|
49
|
+
- **Content-Type**: Not defined
|
|
50
|
+
- **Accept**: application/json
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
### HTTP response details
|
|
54
|
+
| Status code | Description | Response headers |
|
|
55
|
+
|-------------|-------------|------------------|
|
|
56
|
+
|**200** | Réglages du joueur du club | - |
|
|
57
|
+
|
|
58
|
+
[[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)
|
|
59
|
+
|
|
60
|
+
# **updateClubCustomerSettings**
|
|
61
|
+
> ClubCustomerSettingsResponse updateClubCustomerSettings(clubCustomerSettingsResponse)
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
### Example
|
|
65
|
+
|
|
66
|
+
```typescript
|
|
67
|
+
import {
|
|
68
|
+
ClubCustomerStaffApi,
|
|
69
|
+
Configuration,
|
|
70
|
+
ClubCustomerSettingsResponse
|
|
71
|
+
} from '@tennac-booking/sdk';
|
|
72
|
+
|
|
73
|
+
const configuration = new Configuration();
|
|
74
|
+
const apiInstance = new ClubCustomerStaffApi(configuration);
|
|
75
|
+
|
|
76
|
+
let userId: string; // (default to undefined)
|
|
77
|
+
let clubCustomerSettingsResponse: ClubCustomerSettingsResponse; //
|
|
78
|
+
|
|
79
|
+
const { status, data } = await apiInstance.updateClubCustomerSettings(
|
|
80
|
+
userId,
|
|
81
|
+
clubCustomerSettingsResponse
|
|
82
|
+
);
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
### Parameters
|
|
86
|
+
|
|
87
|
+
|Name | Type | Description | Notes|
|
|
88
|
+
|------------- | ------------- | ------------- | -------------|
|
|
89
|
+
| **clubCustomerSettingsResponse** | **ClubCustomerSettingsResponse**| | |
|
|
90
|
+
| **userId** | [**string**] | | defaults to undefined|
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
### Return type
|
|
94
|
+
|
|
95
|
+
**ClubCustomerSettingsResponse**
|
|
96
|
+
|
|
97
|
+
### Authorization
|
|
98
|
+
|
|
99
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
100
|
+
|
|
101
|
+
### HTTP request headers
|
|
102
|
+
|
|
103
|
+
- **Content-Type**: application/json
|
|
104
|
+
- **Accept**: application/json
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
### HTTP response details
|
|
108
|
+
| Status code | Description | Response headers |
|
|
109
|
+
|-------------|-------------|------------------|
|
|
110
|
+
|**200** | Réglages mis à jour | - |
|
|
111
|
+
|
|
112
|
+
[[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)
|
|
113
|
+
|
|
@@ -5,6 +5,10 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**value** | **number** | Valeur mesurée sur la période actuelle | [default to undefined]
|
|
9
|
+
**reference** | **number** | Valeur de référence calculée avec la comparaison Same Weekday | [default to undefined]
|
|
10
|
+
**delta** | **number** | Différence entre la valeur actuelle et la référence | [default to undefined]
|
|
11
|
+
**trend** | [**TrendDirection**](TrendDirection.md) | | [default to undefined]
|
|
8
12
|
**startDate** | **string** | Date de début incluse (format ISO) | [default to undefined]
|
|
9
13
|
**endDate** | **string** | Date de fin incluse (format ISO) | [default to undefined]
|
|
10
14
|
**newBookings** | **number** | Nombre de nouvelles réservations créées durant la période | [default to undefined]
|
|
@@ -15,6 +19,10 @@ Name | Type | Description | Notes
|
|
|
15
19
|
import { ClubNewBookingsResponse } from '@tennac-booking/sdk';
|
|
16
20
|
|
|
17
21
|
const instance: ClubNewBookingsResponse = {
|
|
22
|
+
value,
|
|
23
|
+
reference,
|
|
24
|
+
delta,
|
|
25
|
+
trend,
|
|
18
26
|
startDate,
|
|
19
27
|
endDate,
|
|
20
28
|
newBookings,
|
|
@@ -5,6 +5,10 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**value** | **number** | Valeur mesurée sur la période actuelle | [default to undefined]
|
|
9
|
+
**reference** | **number** | Valeur de référence calculée avec la comparaison Same Weekday | [default to undefined]
|
|
10
|
+
**delta** | **number** | Différence entre la valeur actuelle et la référence | [default to undefined]
|
|
11
|
+
**trend** | [**TrendDirection**](TrendDirection.md) | | [default to undefined]
|
|
8
12
|
**startDate** | **string** | Date de début incluse (format ISO) | [default to undefined]
|
|
9
13
|
**endDate** | **string** | Date de fin incluse (format ISO) | [default to undefined]
|
|
10
14
|
**newSubscribers** | **number** | Nombre de nouveaux abonnés sur la période | [default to undefined]
|
|
@@ -15,6 +19,10 @@ Name | Type | Description | Notes
|
|
|
15
19
|
import { ClubNewSubscribersResponse } from '@tennac-booking/sdk';
|
|
16
20
|
|
|
17
21
|
const instance: ClubNewSubscribersResponse = {
|
|
22
|
+
value,
|
|
23
|
+
reference,
|
|
24
|
+
delta,
|
|
25
|
+
trend,
|
|
18
26
|
startDate,
|
|
19
27
|
endDate,
|
|
20
28
|
newSubscribers,
|
|
@@ -26,6 +26,7 @@ Name | Type | Description | Notes
|
|
|
26
26
|
**subscriberPrices** | [**Array<SubscriberPrice>**](SubscriberPrice.md) | | [optional] [default to undefined]
|
|
27
27
|
**levels** | **Array<number | null>** | | [optional] [default to undefined]
|
|
28
28
|
**sponsors** | [**Array<EventSponsor>**](EventSponsor.md) | | [optional] [default to undefined]
|
|
29
|
+
**registrationOpeningDate** | **string** | | [default to undefined]
|
|
29
30
|
**visibilityType** | **string** | | [default to undefined]
|
|
30
31
|
|
|
31
32
|
## Example
|
|
@@ -55,6 +56,7 @@ const instance: CreateEventRequest = {
|
|
|
55
56
|
subscriberPrices,
|
|
56
57
|
levels,
|
|
57
58
|
sponsors,
|
|
59
|
+
registrationOpeningDate,
|
|
58
60
|
visibilityType,
|
|
59
61
|
};
|
|
60
62
|
```
|
package/docs/EventResponse.md
CHANGED
|
@@ -28,6 +28,7 @@ Name | Type | Description | Notes
|
|
|
28
28
|
**visibilityType** | **string** | | [default to undefined]
|
|
29
29
|
**levels** | **Array<string | null>** | | [optional] [default to undefined]
|
|
30
30
|
**sponsors** | [**Array<EventSponsor>**](EventSponsor.md) | | [optional] [default to undefined]
|
|
31
|
+
**registrationOpeningDate** | **string** | | [default to undefined]
|
|
31
32
|
**createdBy** | **string** | | [optional] [default to undefined]
|
|
32
33
|
**isActive** | **boolean** | | [default to undefined]
|
|
33
34
|
**createdAt** | **string** | | [default to undefined]
|
|
@@ -62,6 +63,7 @@ const instance: EventResponse = {
|
|
|
62
63
|
visibilityType,
|
|
63
64
|
levels,
|
|
64
65
|
sponsors,
|
|
66
|
+
registrationOpeningDate,
|
|
65
67
|
createdBy,
|
|
66
68
|
isActive,
|
|
67
69
|
createdAt,
|
|
@@ -5,6 +5,10 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**value** | **number** | Valeur mesurée sur la période actuelle | [default to undefined]
|
|
9
|
+
**reference** | **number** | Valeur de référence calculée avec la comparaison Same Weekday | [default to undefined]
|
|
10
|
+
**delta** | **number** | Différence entre la valeur actuelle et la référence | [default to undefined]
|
|
11
|
+
**trend** | [**TrendDirection**](TrendDirection.md) | | [default to undefined]
|
|
8
12
|
**year** | **number** | Année | [default to undefined]
|
|
9
13
|
**month** | **number** | Mois | [default to undefined]
|
|
10
14
|
**totalTurnover** | **number** | Chiffre d\'affaires total du mois | [default to undefined]
|
|
@@ -17,6 +21,10 @@ Name | Type | Description | Notes
|
|
|
17
21
|
import { MonthlyTurnoverResponse } from '@tennac-booking/sdk';
|
|
18
22
|
|
|
19
23
|
const instance: MonthlyTurnoverResponse = {
|
|
24
|
+
value,
|
|
25
|
+
reference,
|
|
26
|
+
delta,
|
|
27
|
+
trend,
|
|
20
28
|
year,
|
|
21
29
|
month,
|
|
22
30
|
totalTurnover,
|
|
@@ -5,6 +5,10 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**value** | **number** | Valeur mesurée sur la période actuelle | [default to undefined]
|
|
9
|
+
**reference** | **number** | Valeur de référence calculée avec la comparaison Same Weekday | [default to undefined]
|
|
10
|
+
**delta** | **number** | Différence entre la valeur actuelle et la référence | [default to undefined]
|
|
11
|
+
**trend** | [**TrendDirection**](TrendDirection.md) | | [default to undefined]
|
|
8
12
|
**retentionRate** | **number** | Pourcentage de joueurs fidèles (>= 2 réservations) | [default to undefined]
|
|
9
13
|
**loyalPlayers** | **number** | Nombre de joueurs fidèles | [default to undefined]
|
|
10
14
|
**totalPlayers** | **number** | Nombre total de joueurs ayant réservé | [default to undefined]
|
|
@@ -15,6 +19,10 @@ Name | Type | Description | Notes
|
|
|
15
19
|
import { RetentionRateResponse } from '@tennac-booking/sdk';
|
|
16
20
|
|
|
17
21
|
const instance: RetentionRateResponse = {
|
|
22
|
+
value,
|
|
23
|
+
reference,
|
|
24
|
+
delta,
|
|
25
|
+
trend,
|
|
18
26
|
retentionRate,
|
|
19
27
|
loyalPlayers,
|
|
20
28
|
totalPlayers,
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# TrendDirection
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `Up` (value: `'up'`)
|
|
7
|
+
|
|
8
|
+
* `Down` (value: `'down'`)
|
|
9
|
+
|
|
10
|
+
* `Steady` (value: `'steady'`)
|
|
11
|
+
|
|
12
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -25,6 +25,7 @@ Name | Type | Description | Notes
|
|
|
25
25
|
**subscriberPrices** | [**Array<SubscriberPrice>**](SubscriberPrice.md) | | [optional] [default to undefined]
|
|
26
26
|
**visibilityType** | **string** | | [optional] [default to undefined]
|
|
27
27
|
**levels** | **Array<string | null>** | | [optional] [default to undefined]
|
|
28
|
+
**registrationOpeningDate** | **string** | | [optional] [default to undefined]
|
|
28
29
|
**sponsors** | [**Array<EventSponsor>**](EventSponsor.md) | | [optional] [default to undefined]
|
|
29
30
|
|
|
30
31
|
## Example
|
|
@@ -53,6 +54,7 @@ const instance: UpdateEventRequest = {
|
|
|
53
54
|
subscriberPrices,
|
|
54
55
|
visibilityType,
|
|
55
56
|
levels,
|
|
57
|
+
registrationOpeningDate,
|
|
56
58
|
sponsors,
|
|
57
59
|
};
|
|
58
60
|
```
|