@tennac-booking/sdk 1.0.142 → 1.0.143

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.
@@ -1,5 +1,6 @@
1
1
  .gitignore
2
2
  .npmignore
3
+ .openapi-generator-ignore
3
4
  README.md
4
5
  api.ts
5
6
  base.ts
@@ -301,6 +302,7 @@ docs/SubscriptionsUserApi.md
301
302
  docs/SurfaceType.md
302
303
  docs/Team.md
303
304
  docs/TimeBounds.md
305
+ docs/TrendDirection.md
304
306
  docs/UpdateActuality200Response.md
305
307
  docs/UpdateClubAccessSettingsRequest.md
306
308
  docs/UpdateClubDayScheduleRequest.md
package/README.md CHANGED
@@ -509,6 +509,7 @@ Class | Method | HTTP request | Description
509
509
  - [SurfaceType](docs/SurfaceType.md)
510
510
  - [Team](docs/Team.md)
511
511
  - [TimeBounds](docs/TimeBounds.md)
512
+ - [TrendDirection](docs/TrendDirection.md)
512
513
  - [UpdateActuality200Response](docs/UpdateActuality200Response.md)
513
514
  - [UpdateClubAccessSettingsRequest](docs/UpdateClubAccessSettingsRequest.md)
514
515
  - [UpdateClubDayScheduleRequest](docs/UpdateClubDayScheduleRequest.md)
package/api.ts CHANGED
@@ -1263,6 +1263,30 @@ export interface BookingSummaryClubAddress {
1263
1263
  * @interface BookingsPerDayItem
1264
1264
  */
1265
1265
  export interface BookingsPerDayItem {
1266
+ /**
1267
+ * Valeur mesurée sur la période actuelle
1268
+ * @type {number}
1269
+ * @memberof BookingsPerDayItem
1270
+ */
1271
+ 'value': number;
1272
+ /**
1273
+ * Valeur de référence calculée avec la comparaison Same Weekday
1274
+ * @type {number}
1275
+ * @memberof BookingsPerDayItem
1276
+ */
1277
+ 'reference': number;
1278
+ /**
1279
+ * Différence entre la valeur actuelle et la référence
1280
+ * @type {number}
1281
+ * @memberof BookingsPerDayItem
1282
+ */
1283
+ 'delta': number;
1284
+ /**
1285
+ *
1286
+ * @type {TrendDirection}
1287
+ * @memberof BookingsPerDayItem
1288
+ */
1289
+ 'trend': TrendDirection;
1266
1290
  /**
1267
1291
  * Jour au format YYYY-MM-DD
1268
1292
  * @type {string}
@@ -1276,6 +1300,8 @@ export interface BookingsPerDayItem {
1276
1300
  */
1277
1301
  'bookingsCount': number;
1278
1302
  }
1303
+
1304
+
1279
1305
  /**
1280
1306
  *
1281
1307
  * @export
@@ -2234,6 +2260,30 @@ export interface ClubMetadataResponseLocation {
2234
2260
  * @interface ClubNewBookingsResponse
2235
2261
  */
2236
2262
  export interface ClubNewBookingsResponse {
2263
+ /**
2264
+ * Valeur mesurée sur la période actuelle
2265
+ * @type {number}
2266
+ * @memberof ClubNewBookingsResponse
2267
+ */
2268
+ 'value': number;
2269
+ /**
2270
+ * Valeur de référence calculée avec la comparaison Same Weekday
2271
+ * @type {number}
2272
+ * @memberof ClubNewBookingsResponse
2273
+ */
2274
+ 'reference': number;
2275
+ /**
2276
+ * Différence entre la valeur actuelle et la référence
2277
+ * @type {number}
2278
+ * @memberof ClubNewBookingsResponse
2279
+ */
2280
+ 'delta': number;
2281
+ /**
2282
+ *
2283
+ * @type {TrendDirection}
2284
+ * @memberof ClubNewBookingsResponse
2285
+ */
2286
+ 'trend': TrendDirection;
2237
2287
  /**
2238
2288
  * Date de début incluse (format ISO)
2239
2289
  * @type {string}
@@ -2253,12 +2303,38 @@ export interface ClubNewBookingsResponse {
2253
2303
  */
2254
2304
  'newBookings': number;
2255
2305
  }
2306
+
2307
+
2256
2308
  /**
2257
2309
  *
2258
2310
  * @export
2259
2311
  * @interface ClubNewSubscribersResponse
2260
2312
  */
2261
2313
  export interface ClubNewSubscribersResponse {
2314
+ /**
2315
+ * Valeur mesurée sur la période actuelle
2316
+ * @type {number}
2317
+ * @memberof ClubNewSubscribersResponse
2318
+ */
2319
+ 'value': number;
2320
+ /**
2321
+ * Valeur de référence calculée avec la comparaison Same Weekday
2322
+ * @type {number}
2323
+ * @memberof ClubNewSubscribersResponse
2324
+ */
2325
+ 'reference': number;
2326
+ /**
2327
+ * Différence entre la valeur actuelle et la référence
2328
+ * @type {number}
2329
+ * @memberof ClubNewSubscribersResponse
2330
+ */
2331
+ 'delta': number;
2332
+ /**
2333
+ *
2334
+ * @type {TrendDirection}
2335
+ * @memberof ClubNewSubscribersResponse
2336
+ */
2337
+ 'trend': TrendDirection;
2262
2338
  /**
2263
2339
  * Date de début incluse (format ISO)
2264
2340
  * @type {string}
@@ -2278,6 +2354,8 @@ export interface ClubNewSubscribersResponse {
2278
2354
  */
2279
2355
  'newSubscribers': number;
2280
2356
  }
2357
+
2358
+
2281
2359
  /**
2282
2360
  *
2283
2361
  * @export
@@ -6742,6 +6820,30 @@ export interface MonthlyBreakdown {
6742
6820
  * @interface MonthlyTurnoverResponse
6743
6821
  */
6744
6822
  export interface MonthlyTurnoverResponse {
6823
+ /**
6824
+ * Valeur mesurée sur la période actuelle
6825
+ * @type {number}
6826
+ * @memberof MonthlyTurnoverResponse
6827
+ */
6828
+ 'value': number;
6829
+ /**
6830
+ * Valeur de référence calculée avec la comparaison Same Weekday
6831
+ * @type {number}
6832
+ * @memberof MonthlyTurnoverResponse
6833
+ */
6834
+ 'reference': number;
6835
+ /**
6836
+ * Différence entre la valeur actuelle et la référence
6837
+ * @type {number}
6838
+ * @memberof MonthlyTurnoverResponse
6839
+ */
6840
+ 'delta': number;
6841
+ /**
6842
+ *
6843
+ * @type {TrendDirection}
6844
+ * @memberof MonthlyTurnoverResponse
6845
+ */
6846
+ 'trend': TrendDirection;
6745
6847
  /**
6746
6848
  * Année
6747
6849
  * @type {number}
@@ -6773,6 +6875,8 @@ export interface MonthlyTurnoverResponse {
6773
6875
  */
6774
6876
  'period': string;
6775
6877
  }
6878
+
6879
+
6776
6880
  /**
6777
6881
  *
6778
6882
  * @export
@@ -8568,6 +8672,30 @@ export interface ResetPasswordRequest {
8568
8672
  * @interface RetentionRateResponse
8569
8673
  */
8570
8674
  export interface RetentionRateResponse {
8675
+ /**
8676
+ * Valeur mesurée sur la période actuelle
8677
+ * @type {number}
8678
+ * @memberof RetentionRateResponse
8679
+ */
8680
+ 'value': number;
8681
+ /**
8682
+ * Valeur de référence calculée avec la comparaison Same Weekday
8683
+ * @type {number}
8684
+ * @memberof RetentionRateResponse
8685
+ */
8686
+ 'reference': number;
8687
+ /**
8688
+ * Différence entre la valeur actuelle et la référence
8689
+ * @type {number}
8690
+ * @memberof RetentionRateResponse
8691
+ */
8692
+ 'delta': number;
8693
+ /**
8694
+ *
8695
+ * @type {TrendDirection}
8696
+ * @memberof RetentionRateResponse
8697
+ */
8698
+ 'trend': TrendDirection;
8571
8699
  /**
8572
8700
  * Pourcentage de joueurs fidèles (>= 2 réservations)
8573
8701
  * @type {number}
@@ -8587,6 +8715,8 @@ export interface RetentionRateResponse {
8587
8715
  */
8588
8716
  'totalPlayers': number;
8589
8717
  }
8718
+
8719
+
8590
8720
  /**
8591
8721
  *
8592
8722
  * @export
@@ -9848,6 +9978,21 @@ export interface TimeBounds {
9848
9978
  */
9849
9979
  'end': string;
9850
9980
  }
9981
+ /**
9982
+ *
9983
+ * @export
9984
+ * @enum {string}
9985
+ */
9986
+
9987
+ export const TrendDirection = {
9988
+ Up: 'up',
9989
+ Down: 'down',
9990
+ Steady: 'steady'
9991
+ } as const;
9992
+
9993
+ export type TrendDirection = typeof TrendDirection[keyof typeof TrendDirection];
9994
+
9995
+
9851
9996
  /**
9852
9997
  *
9853
9998
  * @export
@@ -14536,10 +14681,12 @@ export const ClubAnalyticsStaffApiAxiosParamCreator = function (configuration?:
14536
14681
  },
14537
14682
  /**
14538
14683
  * Calcule le taux de fidélisation des joueurs
14684
+ * @param {string} [startDate]
14685
+ * @param {string} [endDate]
14539
14686
  * @param {*} [options] Override http request option.
14540
14687
  * @throws {RequiredError}
14541
14688
  */
14542
- getRetentionRate: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
14689
+ getRetentionRate: async (startDate?: string, endDate?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
14543
14690
  const localVarPath = `/api/club-analytics/retention-rate`;
14544
14691
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
14545
14692
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -14556,6 +14703,14 @@ export const ClubAnalyticsStaffApiAxiosParamCreator = function (configuration?:
14556
14703
  // http bearer authentication required
14557
14704
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
14558
14705
 
14706
+ if (startDate !== undefined) {
14707
+ localVarQueryParameter['startDate'] = startDate;
14708
+ }
14709
+
14710
+ if (endDate !== undefined) {
14711
+ localVarQueryParameter['endDate'] = endDate;
14712
+ }
14713
+
14559
14714
 
14560
14715
 
14561
14716
  setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -14940,11 +15095,13 @@ export const ClubAnalyticsStaffApiFp = function(configuration?: Configuration) {
14940
15095
  },
14941
15096
  /**
14942
15097
  * Calcule le taux de fidélisation des joueurs
15098
+ * @param {string} [startDate]
15099
+ * @param {string} [endDate]
14943
15100
  * @param {*} [options] Override http request option.
14944
15101
  * @throws {RequiredError}
14945
15102
  */
14946
- async getRetentionRate(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RetentionRateResponse>> {
14947
- const localVarAxiosArgs = await localVarAxiosParamCreator.getRetentionRate(options);
15103
+ async getRetentionRate(startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RetentionRateResponse>> {
15104
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getRetentionRate(startDate, endDate, options);
14948
15105
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
14949
15106
  const localVarOperationServerBasePath = operationServerMap['ClubAnalyticsStaffApi.getRetentionRate']?.[localVarOperationServerIndex]?.url;
14950
15107
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -15163,11 +15320,12 @@ export const ClubAnalyticsStaffApiFactory = function (configuration?: Configurat
15163
15320
  },
15164
15321
  /**
15165
15322
  * Calcule le taux de fidélisation des joueurs
15323
+ * @param {ClubAnalyticsStaffApiGetRetentionRateRequest} requestParameters Request parameters.
15166
15324
  * @param {*} [options] Override http request option.
15167
15325
  * @throws {RequiredError}
15168
15326
  */
15169
- getRetentionRate(options?: RawAxiosRequestConfig): AxiosPromise<RetentionRateResponse> {
15170
- return localVarFp.getRetentionRate(options).then((request) => request(axios, basePath));
15327
+ getRetentionRate(requestParameters: ClubAnalyticsStaffApiGetRetentionRateRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise<RetentionRateResponse> {
15328
+ return localVarFp.getRetentionRate(requestParameters.startDate, requestParameters.endDate, options).then((request) => request(axios, basePath));
15171
15329
  },
15172
15330
  /**
15173
15331
  * Récupère le chiffre d\'affaires par sport
@@ -15464,6 +15622,27 @@ export interface ClubAnalyticsStaffApiGetNoShowRateRequest {
15464
15622
  readonly endDate?: string
15465
15623
  }
15466
15624
 
15625
+ /**
15626
+ * Request parameters for getRetentionRate operation in ClubAnalyticsStaffApi.
15627
+ * @export
15628
+ * @interface ClubAnalyticsStaffApiGetRetentionRateRequest
15629
+ */
15630
+ export interface ClubAnalyticsStaffApiGetRetentionRateRequest {
15631
+ /**
15632
+ *
15633
+ * @type {string}
15634
+ * @memberof ClubAnalyticsStaffApiGetRetentionRate
15635
+ */
15636
+ readonly startDate?: string
15637
+
15638
+ /**
15639
+ *
15640
+ * @type {string}
15641
+ * @memberof ClubAnalyticsStaffApiGetRetentionRate
15642
+ */
15643
+ readonly endDate?: string
15644
+ }
15645
+
15467
15646
  /**
15468
15647
  * Request parameters for getYearlyTurnOver operation in ClubAnalyticsStaffApi.
15469
15648
  * @export
@@ -15680,12 +15859,13 @@ export class ClubAnalyticsStaffApi extends BaseAPI {
15680
15859
 
15681
15860
  /**
15682
15861
  * Calcule le taux de fidélisation des joueurs
15862
+ * @param {ClubAnalyticsStaffApiGetRetentionRateRequest} requestParameters Request parameters.
15683
15863
  * @param {*} [options] Override http request option.
15684
15864
  * @throws {RequiredError}
15685
15865
  * @memberof ClubAnalyticsStaffApi
15686
15866
  */
15687
- public getRetentionRate(options?: RawAxiosRequestConfig) {
15688
- return ClubAnalyticsStaffApiFp(this.configuration).getRetentionRate(options).then((request) => request(this.axios, this.basePath));
15867
+ public getRetentionRate(requestParameters: ClubAnalyticsStaffApiGetRetentionRateRequest = {}, options?: RawAxiosRequestConfig) {
15868
+ return ClubAnalyticsStaffApiFp(this.configuration).getRetentionRate(requestParameters.startDate, requestParameters.endDate, options).then((request) => request(this.axios, this.basePath));
15689
15869
  }
15690
15870
 
15691
15871
  /**
package/dist/api.d.ts CHANGED
@@ -1232,6 +1232,30 @@ export interface BookingSummaryClubAddress {
1232
1232
  * @interface BookingsPerDayItem
1233
1233
  */
1234
1234
  export interface BookingsPerDayItem {
1235
+ /**
1236
+ * Valeur mesurée sur la période actuelle
1237
+ * @type {number}
1238
+ * @memberof BookingsPerDayItem
1239
+ */
1240
+ 'value': number;
1241
+ /**
1242
+ * Valeur de référence calculée avec la comparaison Same Weekday
1243
+ * @type {number}
1244
+ * @memberof BookingsPerDayItem
1245
+ */
1246
+ 'reference': number;
1247
+ /**
1248
+ * Différence entre la valeur actuelle et la référence
1249
+ * @type {number}
1250
+ * @memberof BookingsPerDayItem
1251
+ */
1252
+ 'delta': number;
1253
+ /**
1254
+ *
1255
+ * @type {TrendDirection}
1256
+ * @memberof BookingsPerDayItem
1257
+ */
1258
+ 'trend': TrendDirection;
1235
1259
  /**
1236
1260
  * Jour au format YYYY-MM-DD
1237
1261
  * @type {string}
@@ -2192,6 +2216,30 @@ export interface ClubMetadataResponseLocation {
2192
2216
  * @interface ClubNewBookingsResponse
2193
2217
  */
2194
2218
  export interface ClubNewBookingsResponse {
2219
+ /**
2220
+ * Valeur mesurée sur la période actuelle
2221
+ * @type {number}
2222
+ * @memberof ClubNewBookingsResponse
2223
+ */
2224
+ 'value': number;
2225
+ /**
2226
+ * Valeur de référence calculée avec la comparaison Same Weekday
2227
+ * @type {number}
2228
+ * @memberof ClubNewBookingsResponse
2229
+ */
2230
+ 'reference': number;
2231
+ /**
2232
+ * Différence entre la valeur actuelle et la référence
2233
+ * @type {number}
2234
+ * @memberof ClubNewBookingsResponse
2235
+ */
2236
+ 'delta': number;
2237
+ /**
2238
+ *
2239
+ * @type {TrendDirection}
2240
+ * @memberof ClubNewBookingsResponse
2241
+ */
2242
+ 'trend': TrendDirection;
2195
2243
  /**
2196
2244
  * Date de début incluse (format ISO)
2197
2245
  * @type {string}
@@ -2217,6 +2265,30 @@ export interface ClubNewBookingsResponse {
2217
2265
  * @interface ClubNewSubscribersResponse
2218
2266
  */
2219
2267
  export interface ClubNewSubscribersResponse {
2268
+ /**
2269
+ * Valeur mesurée sur la période actuelle
2270
+ * @type {number}
2271
+ * @memberof ClubNewSubscribersResponse
2272
+ */
2273
+ 'value': number;
2274
+ /**
2275
+ * Valeur de référence calculée avec la comparaison Same Weekday
2276
+ * @type {number}
2277
+ * @memberof ClubNewSubscribersResponse
2278
+ */
2279
+ 'reference': number;
2280
+ /**
2281
+ * Différence entre la valeur actuelle et la référence
2282
+ * @type {number}
2283
+ * @memberof ClubNewSubscribersResponse
2284
+ */
2285
+ 'delta': number;
2286
+ /**
2287
+ *
2288
+ * @type {TrendDirection}
2289
+ * @memberof ClubNewSubscribersResponse
2290
+ */
2291
+ 'trend': TrendDirection;
2220
2292
  /**
2221
2293
  * Date de début incluse (format ISO)
2222
2294
  * @type {string}
@@ -6627,6 +6699,30 @@ export interface MonthlyBreakdown {
6627
6699
  * @interface MonthlyTurnoverResponse
6628
6700
  */
6629
6701
  export interface MonthlyTurnoverResponse {
6702
+ /**
6703
+ * Valeur mesurée sur la période actuelle
6704
+ * @type {number}
6705
+ * @memberof MonthlyTurnoverResponse
6706
+ */
6707
+ 'value': number;
6708
+ /**
6709
+ * Valeur de référence calculée avec la comparaison Same Weekday
6710
+ * @type {number}
6711
+ * @memberof MonthlyTurnoverResponse
6712
+ */
6713
+ 'reference': number;
6714
+ /**
6715
+ * Différence entre la valeur actuelle et la référence
6716
+ * @type {number}
6717
+ * @memberof MonthlyTurnoverResponse
6718
+ */
6719
+ 'delta': number;
6720
+ /**
6721
+ *
6722
+ * @type {TrendDirection}
6723
+ * @memberof MonthlyTurnoverResponse
6724
+ */
6725
+ 'trend': TrendDirection;
6630
6726
  /**
6631
6727
  * Année
6632
6728
  * @type {number}
@@ -8419,6 +8515,30 @@ export interface ResetPasswordRequest {
8419
8515
  * @interface RetentionRateResponse
8420
8516
  */
8421
8517
  export interface RetentionRateResponse {
8518
+ /**
8519
+ * Valeur mesurée sur la période actuelle
8520
+ * @type {number}
8521
+ * @memberof RetentionRateResponse
8522
+ */
8523
+ 'value': number;
8524
+ /**
8525
+ * Valeur de référence calculée avec la comparaison Same Weekday
8526
+ * @type {number}
8527
+ * @memberof RetentionRateResponse
8528
+ */
8529
+ 'reference': number;
8530
+ /**
8531
+ * Différence entre la valeur actuelle et la référence
8532
+ * @type {number}
8533
+ * @memberof RetentionRateResponse
8534
+ */
8535
+ 'delta': number;
8536
+ /**
8537
+ *
8538
+ * @type {TrendDirection}
8539
+ * @memberof RetentionRateResponse
8540
+ */
8541
+ 'trend': TrendDirection;
8422
8542
  /**
8423
8543
  * Pourcentage de joueurs fidèles (>= 2 réservations)
8424
8544
  * @type {number}
@@ -9675,6 +9795,17 @@ export interface TimeBounds {
9675
9795
  */
9676
9796
  'end': string;
9677
9797
  }
9798
+ /**
9799
+ *
9800
+ * @export
9801
+ * @enum {string}
9802
+ */
9803
+ export declare const TrendDirection: {
9804
+ readonly Up: "up";
9805
+ readonly Down: "down";
9806
+ readonly Steady: "steady";
9807
+ };
9808
+ export type TrendDirection = typeof TrendDirection[keyof typeof TrendDirection];
9678
9809
  /**
9679
9810
  *
9680
9811
  * @export
@@ -12741,10 +12872,12 @@ export declare const ClubAnalyticsStaffApiAxiosParamCreator: (configuration?: Co
12741
12872
  getNumberOfClubUsers: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
12742
12873
  /**
12743
12874
  * Calcule le taux de fidélisation des joueurs
12875
+ * @param {string} [startDate]
12876
+ * @param {string} [endDate]
12744
12877
  * @param {*} [options] Override http request option.
12745
12878
  * @throws {RequiredError}
12746
12879
  */
12747
- getRetentionRate: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
12880
+ getRetentionRate: (startDate?: string, endDate?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
12748
12881
  /**
12749
12882
  * Récupère le chiffre d\'affaires par sport
12750
12883
  * @param {*} [options] Override http request option.
@@ -12910,10 +13043,12 @@ export declare const ClubAnalyticsStaffApiFp: (configuration?: Configuration) =>
12910
13043
  getNumberOfClubUsers(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClubUserCountResponse>>;
12911
13044
  /**
12912
13045
  * Calcule le taux de fidélisation des joueurs
13046
+ * @param {string} [startDate]
13047
+ * @param {string} [endDate]
12913
13048
  * @param {*} [options] Override http request option.
12914
13049
  * @throws {RequiredError}
12915
13050
  */
12916
- getRetentionRate(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RetentionRateResponse>>;
13051
+ getRetentionRate(startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RetentionRateResponse>>;
12917
13052
  /**
12918
13053
  * Récupère le chiffre d\'affaires par sport
12919
13054
  * @param {*} [options] Override http request option.
@@ -13068,10 +13203,11 @@ export declare const ClubAnalyticsStaffApiFactory: (configuration?: Configuratio
13068
13203
  getNumberOfClubUsers(options?: RawAxiosRequestConfig): AxiosPromise<ClubUserCountResponse>;
13069
13204
  /**
13070
13205
  * Calcule le taux de fidélisation des joueurs
13206
+ * @param {ClubAnalyticsStaffApiGetRetentionRateRequest} requestParameters Request parameters.
13071
13207
  * @param {*} [options] Override http request option.
13072
13208
  * @throws {RequiredError}
13073
13209
  */
13074
- getRetentionRate(options?: RawAxiosRequestConfig): AxiosPromise<RetentionRateResponse>;
13210
+ getRetentionRate(requestParameters?: ClubAnalyticsStaffApiGetRetentionRateRequest, options?: RawAxiosRequestConfig): AxiosPromise<RetentionRateResponse>;
13075
13211
  /**
13076
13212
  * Récupère le chiffre d\'affaires par sport
13077
13213
  * @param {*} [options] Override http request option.
@@ -13333,6 +13469,25 @@ export interface ClubAnalyticsStaffApiGetNoShowRateRequest {
13333
13469
  */
13334
13470
  readonly endDate?: string;
13335
13471
  }
13472
+ /**
13473
+ * Request parameters for getRetentionRate operation in ClubAnalyticsStaffApi.
13474
+ * @export
13475
+ * @interface ClubAnalyticsStaffApiGetRetentionRateRequest
13476
+ */
13477
+ export interface ClubAnalyticsStaffApiGetRetentionRateRequest {
13478
+ /**
13479
+ *
13480
+ * @type {string}
13481
+ * @memberof ClubAnalyticsStaffApiGetRetentionRate
13482
+ */
13483
+ readonly startDate?: string;
13484
+ /**
13485
+ *
13486
+ * @type {string}
13487
+ * @memberof ClubAnalyticsStaffApiGetRetentionRate
13488
+ */
13489
+ readonly endDate?: string;
13490
+ }
13336
13491
  /**
13337
13492
  * Request parameters for getYearlyTurnOver operation in ClubAnalyticsStaffApi.
13338
13493
  * @export
@@ -13494,11 +13649,12 @@ export declare class ClubAnalyticsStaffApi extends BaseAPI {
13494
13649
  getNumberOfClubUsers(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ClubUserCountResponse, any, {}>>;
13495
13650
  /**
13496
13651
  * Calcule le taux de fidélisation des joueurs
13652
+ * @param {ClubAnalyticsStaffApiGetRetentionRateRequest} requestParameters Request parameters.
13497
13653
  * @param {*} [options] Override http request option.
13498
13654
  * @throws {RequiredError}
13499
13655
  * @memberof ClubAnalyticsStaffApi
13500
13656
  */
13501
- getRetentionRate(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RetentionRateResponse, any, {}>>;
13657
+ getRetentionRate(requestParameters?: ClubAnalyticsStaffApiGetRetentionRateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RetentionRateResponse, any, {}>>;
13502
13658
  /**
13503
13659
  * Récupère le chiffre d\'affaires par sport
13504
13660
  * @param {*} [options] Override http request option.
package/dist/api.js CHANGED
@@ -22,10 +22,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
22
22
  });
23
23
  };
24
24
  Object.defineProperty(exports, "__esModule", { value: true });
25
- exports.BookingsApiAxiosParamCreator = exports.WeekdayKey = exports.VisibilityType = exports.UserLocationSummaryTypeEnum = exports.UpdateRecurringDefinitionRequestRecurringTypeEnum = exports.UpdateRecurringDefinitionRequestParticipationTypeEnum = exports.UpdateRecurringDefinitionRequestTypeEnum = exports.UpdateRecurringDefinitionRequestVisibilityTypeEnum = exports.UpdateEventRequestVisibilityTypeEnum = exports.UpdateEventRequestParticipationTypeEnum = exports.UpdateEventRequestRecurringTypeEnum = exports.UpdateEventRequestTypeEnum = exports.UpdateClubRoleRequestRoleEnum = exports.UpdateClubMemberRequestRoleEnum = exports.SurfaceType = exports.StaffBookingPaymentState = exports.SportKey = exports.RegisterRequestBodyLocationTypeEnum = exports.RecurringDefinitionResponseRecurringTypeEnum = exports.PublicAccessSettingsPaymentModeEnum = exports.PlayerCategoryId = exports.PlanInterval = exports.PaymentMethod = exports.ParticipationType = exports.PartialPublicAccessSettingsPaymentModeEnum = exports.InvoiceStatusSETUPSUCCESS = exports.InvoiceStatusSETUPPENDING = exports.InvoiceStatus = exports.ImageContextType = exports.IUserLocationTypeEnum = exports.Gender = exports.EventResponseVisibilityTypeEnum = exports.EventResponseParticipationTypeEnum = exports.EventResponseRecurringTypeEnum = exports.EventResponseTypeEnum = exports.EventBookingStatus = exports.DiscountType = exports.CreateEventRequestVisibilityTypeEnum = exports.CreateEventRequestParticipationTypeEnum = exports.CreateEventRequestRecurringTypeEnum = exports.CreateEventRequestTypeEnum = exports.CreateClubRoleRequestRoleEnum = exports.CourtStatus = exports.ClubRoleResponseRoleEnum = exports.ClientOnboardingRequestBodyClubTypeEnum = exports.CaptureResultStatusEnum = exports.CaptureResultTypeEnum = exports.BookingStatus = exports.BookingHistoryPopulatedPerformedByTypeEnum = exports.AgendaPaymentStatus = void 0;
26
- exports.ClubsManagerApiFactory = exports.ClubsManagerApiFp = exports.ClubsManagerApiAxiosParamCreator = exports.ClubsApi = exports.ClubsApiFactory = exports.ClubsApiFp = exports.ClubsApiAxiosParamCreator = exports.ClubSettingsStaffApi = exports.ClubSettingsStaffApiFactory = exports.ClubSettingsStaffApiFp = exports.ClubSettingsStaffApiAxiosParamCreator = exports.ClubSettingsManagerApi = exports.ClubSettingsManagerApiFactory = exports.ClubSettingsManagerApiFp = exports.ClubSettingsManagerApiAxiosParamCreator = exports.ClubRolesStaffApi = exports.ClubRolesStaffApiFactory = exports.ClubRolesStaffApiFp = exports.ClubRolesStaffApiAxiosParamCreator = exports.ClubRolesManagerApi = exports.ClubRolesManagerApiFactory = exports.ClubRolesManagerApiFp = exports.ClubRolesManagerApiAxiosParamCreator = exports.ClubAnalyticsStaffApi = exports.ClubAnalyticsStaffApiFactory = exports.ClubAnalyticsStaffApiFp = exports.ClubAnalyticsStaffApiAxiosParamCreator = exports.ClubAnalyticsApi = exports.ClubAnalyticsApiFactory = exports.ClubAnalyticsApiFp = exports.ClubAnalyticsApiAxiosParamCreator = exports.ClientApi = exports.ClientApiFactory = exports.ClientApiFp = exports.ClientApiAxiosParamCreator = exports.BookingsUserApi = exports.BookingsUserApiFactory = exports.BookingsUserApiFp = exports.BookingsUserApiAxiosParamCreator = exports.BookingsStaffApi = exports.BookingsStaffApiFactory = exports.BookingsStaffApiFp = exports.BookingsStaffApiAxiosParamCreator = exports.BookingsManagerApi = exports.BookingsManagerApiFactory = exports.BookingsManagerApiFp = exports.BookingsManagerApiAxiosParamCreator = exports.BookingsApi = exports.BookingsApiFactory = exports.BookingsApiFp = void 0;
27
- exports.SubscriptionsStaffApiAxiosParamCreator = exports.SubscriptionsPublicApi = exports.SubscriptionsPublicApiFactory = exports.SubscriptionsPublicApiFp = exports.SubscriptionsPublicApiAxiosParamCreator = exports.SubscriptionsManagerApi = exports.SubscriptionsManagerApiFactory = exports.SubscriptionsManagerApiFp = exports.SubscriptionsManagerApiAxiosParamCreator = exports.SportsPublicApi = exports.SportsPublicApiFactory = exports.SportsPublicApiFp = exports.SportsPublicApiAxiosParamCreator = exports.SportsManagerApi = exports.SportsManagerApiFactory = exports.SportsManagerApiFp = exports.SportsManagerApiAxiosParamCreator = exports.ImagesApi = exports.ImagesApiFactory = exports.ImagesApiFp = exports.ImagesApiAxiosParamCreator = exports.GetWeeklyEventsTypeEnum = exports.GetWeeklyEventsVisibilityTypeEnum = exports.GetMonthlyEventsTypeEnum = exports.GetMonthlyEventsVisibilityTypeEnum = exports.GetDailyEventsTypeEnum = exports.GetDailyEventsVisibilityTypeEnum = exports.EventsStaffApi = exports.EventsStaffApiFactory = exports.EventsStaffApiFp = exports.EventsStaffApiAxiosParamCreator = exports.EventsManagerApi = exports.EventsManagerApiFactory = exports.EventsManagerApiFp = exports.EventsManagerApiAxiosParamCreator = exports.GetPublishedEventsByClubIdTypeEnum = exports.GetPublishedEventsByClubIdVisibilityTypeEnum = exports.EventsApi = exports.EventsApiFactory = exports.EventsApiFp = exports.EventsApiAxiosParamCreator = exports.DefaultApi = exports.DefaultApiFactory = exports.DefaultApiFp = exports.DefaultApiAxiosParamCreator = exports.ClubsStaffApi = exports.ClubsStaffApiFactory = exports.ClubsStaffApiFp = exports.ClubsStaffApiAxiosParamCreator = exports.ClubsManagerApi = void 0;
28
- exports.UsersApi = exports.UsersApiFactory = exports.UsersApiFp = exports.UsersApiAxiosParamCreator = exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiAxiosParamCreator = exports.SubscriptionsUserApi = exports.SubscriptionsUserApiFactory = exports.SubscriptionsUserApiFp = exports.SubscriptionsUserApiAxiosParamCreator = exports.SubscriptionsStaffApi = exports.SubscriptionsStaffApiFactory = exports.SubscriptionsStaffApiFp = void 0;
25
+ exports.WeekdayKey = exports.VisibilityType = exports.UserLocationSummaryTypeEnum = exports.UpdateRecurringDefinitionRequestRecurringTypeEnum = exports.UpdateRecurringDefinitionRequestParticipationTypeEnum = exports.UpdateRecurringDefinitionRequestTypeEnum = exports.UpdateRecurringDefinitionRequestVisibilityTypeEnum = exports.UpdateEventRequestVisibilityTypeEnum = exports.UpdateEventRequestParticipationTypeEnum = exports.UpdateEventRequestRecurringTypeEnum = exports.UpdateEventRequestTypeEnum = exports.UpdateClubRoleRequestRoleEnum = exports.UpdateClubMemberRequestRoleEnum = exports.TrendDirection = exports.SurfaceType = exports.StaffBookingPaymentState = exports.SportKey = exports.RegisterRequestBodyLocationTypeEnum = exports.RecurringDefinitionResponseRecurringTypeEnum = exports.PublicAccessSettingsPaymentModeEnum = exports.PlayerCategoryId = exports.PlanInterval = exports.PaymentMethod = exports.ParticipationType = exports.PartialPublicAccessSettingsPaymentModeEnum = exports.InvoiceStatusSETUPSUCCESS = exports.InvoiceStatusSETUPPENDING = exports.InvoiceStatus = exports.ImageContextType = exports.IUserLocationTypeEnum = exports.Gender = exports.EventResponseVisibilityTypeEnum = exports.EventResponseParticipationTypeEnum = exports.EventResponseRecurringTypeEnum = exports.EventResponseTypeEnum = exports.EventBookingStatus = exports.DiscountType = exports.CreateEventRequestVisibilityTypeEnum = exports.CreateEventRequestParticipationTypeEnum = exports.CreateEventRequestRecurringTypeEnum = exports.CreateEventRequestTypeEnum = exports.CreateClubRoleRequestRoleEnum = exports.CourtStatus = exports.ClubRoleResponseRoleEnum = exports.ClientOnboardingRequestBodyClubTypeEnum = exports.CaptureResultStatusEnum = exports.CaptureResultTypeEnum = exports.BookingStatus = exports.BookingHistoryPopulatedPerformedByTypeEnum = exports.AgendaPaymentStatus = void 0;
26
+ exports.ClubsManagerApiFp = exports.ClubsManagerApiAxiosParamCreator = exports.ClubsApi = exports.ClubsApiFactory = exports.ClubsApiFp = exports.ClubsApiAxiosParamCreator = exports.ClubSettingsStaffApi = exports.ClubSettingsStaffApiFactory = exports.ClubSettingsStaffApiFp = exports.ClubSettingsStaffApiAxiosParamCreator = exports.ClubSettingsManagerApi = exports.ClubSettingsManagerApiFactory = exports.ClubSettingsManagerApiFp = exports.ClubSettingsManagerApiAxiosParamCreator = exports.ClubRolesStaffApi = exports.ClubRolesStaffApiFactory = exports.ClubRolesStaffApiFp = exports.ClubRolesStaffApiAxiosParamCreator = exports.ClubRolesManagerApi = exports.ClubRolesManagerApiFactory = exports.ClubRolesManagerApiFp = exports.ClubRolesManagerApiAxiosParamCreator = exports.ClubAnalyticsStaffApi = exports.ClubAnalyticsStaffApiFactory = exports.ClubAnalyticsStaffApiFp = exports.ClubAnalyticsStaffApiAxiosParamCreator = exports.ClubAnalyticsApi = exports.ClubAnalyticsApiFactory = exports.ClubAnalyticsApiFp = exports.ClubAnalyticsApiAxiosParamCreator = exports.ClientApi = exports.ClientApiFactory = exports.ClientApiFp = exports.ClientApiAxiosParamCreator = exports.BookingsUserApi = exports.BookingsUserApiFactory = exports.BookingsUserApiFp = exports.BookingsUserApiAxiosParamCreator = exports.BookingsStaffApi = exports.BookingsStaffApiFactory = exports.BookingsStaffApiFp = exports.BookingsStaffApiAxiosParamCreator = exports.BookingsManagerApi = exports.BookingsManagerApiFactory = exports.BookingsManagerApiFp = exports.BookingsManagerApiAxiosParamCreator = exports.BookingsApi = exports.BookingsApiFactory = exports.BookingsApiFp = exports.BookingsApiAxiosParamCreator = void 0;
27
+ exports.SubscriptionsPublicApi = exports.SubscriptionsPublicApiFactory = exports.SubscriptionsPublicApiFp = exports.SubscriptionsPublicApiAxiosParamCreator = exports.SubscriptionsManagerApi = exports.SubscriptionsManagerApiFactory = exports.SubscriptionsManagerApiFp = exports.SubscriptionsManagerApiAxiosParamCreator = exports.SportsPublicApi = exports.SportsPublicApiFactory = exports.SportsPublicApiFp = exports.SportsPublicApiAxiosParamCreator = exports.SportsManagerApi = exports.SportsManagerApiFactory = exports.SportsManagerApiFp = exports.SportsManagerApiAxiosParamCreator = exports.ImagesApi = exports.ImagesApiFactory = exports.ImagesApiFp = exports.ImagesApiAxiosParamCreator = exports.GetWeeklyEventsTypeEnum = exports.GetWeeklyEventsVisibilityTypeEnum = exports.GetMonthlyEventsTypeEnum = exports.GetMonthlyEventsVisibilityTypeEnum = exports.GetDailyEventsTypeEnum = exports.GetDailyEventsVisibilityTypeEnum = exports.EventsStaffApi = exports.EventsStaffApiFactory = exports.EventsStaffApiFp = exports.EventsStaffApiAxiosParamCreator = exports.EventsManagerApi = exports.EventsManagerApiFactory = exports.EventsManagerApiFp = exports.EventsManagerApiAxiosParamCreator = exports.GetPublishedEventsByClubIdTypeEnum = exports.GetPublishedEventsByClubIdVisibilityTypeEnum = exports.EventsApi = exports.EventsApiFactory = exports.EventsApiFp = exports.EventsApiAxiosParamCreator = exports.DefaultApi = exports.DefaultApiFactory = exports.DefaultApiFp = exports.DefaultApiAxiosParamCreator = exports.ClubsStaffApi = exports.ClubsStaffApiFactory = exports.ClubsStaffApiFp = exports.ClubsStaffApiAxiosParamCreator = exports.ClubsManagerApi = exports.ClubsManagerApiFactory = void 0;
28
+ exports.UsersApi = exports.UsersApiFactory = exports.UsersApiFp = exports.UsersApiAxiosParamCreator = exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiAxiosParamCreator = exports.SubscriptionsUserApi = exports.SubscriptionsUserApiFactory = exports.SubscriptionsUserApiFp = exports.SubscriptionsUserApiAxiosParamCreator = exports.SubscriptionsStaffApi = exports.SubscriptionsStaffApiFactory = exports.SubscriptionsStaffApiFp = exports.SubscriptionsStaffApiAxiosParamCreator = void 0;
29
29
  const axios_1 = require("axios");
30
30
  // Some imports not used depending on template conditions
31
31
  // @ts-ignore
@@ -311,6 +311,16 @@ exports.SurfaceType = {
311
311
  Carpet: 'carpet',
312
312
  Wooden: 'wooden'
313
313
  };
314
+ /**
315
+ *
316
+ * @export
317
+ * @enum {string}
318
+ */
319
+ exports.TrendDirection = {
320
+ Up: 'up',
321
+ Down: 'down',
322
+ Steady: 'steady'
323
+ };
314
324
  exports.UpdateClubMemberRequestRoleEnum = {
315
325
  Admin: 'admin',
316
326
  Manager: 'manager',
@@ -2628,10 +2638,12 @@ const ClubAnalyticsStaffApiAxiosParamCreator = function (configuration) {
2628
2638
  }),
2629
2639
  /**
2630
2640
  * Calcule le taux de fidélisation des joueurs
2641
+ * @param {string} [startDate]
2642
+ * @param {string} [endDate]
2631
2643
  * @param {*} [options] Override http request option.
2632
2644
  * @throws {RequiredError}
2633
2645
  */
2634
- getRetentionRate: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
2646
+ getRetentionRate: (startDate_1, endDate_1, ...args_1) => __awaiter(this, [startDate_1, endDate_1, ...args_1], void 0, function* (startDate, endDate, options = {}) {
2635
2647
  const localVarPath = `/api/club-analytics/retention-rate`;
2636
2648
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
2637
2649
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -2645,6 +2657,12 @@ const ClubAnalyticsStaffApiAxiosParamCreator = function (configuration) {
2645
2657
  // authentication bearerAuth required
2646
2658
  // http bearer authentication required
2647
2659
  yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
2660
+ if (startDate !== undefined) {
2661
+ localVarQueryParameter['startDate'] = startDate;
2662
+ }
2663
+ if (endDate !== undefined) {
2664
+ localVarQueryParameter['endDate'] = endDate;
2665
+ }
2648
2666
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
2649
2667
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
2650
2668
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -3055,13 +3073,15 @@ const ClubAnalyticsStaffApiFp = function (configuration) {
3055
3073
  },
3056
3074
  /**
3057
3075
  * Calcule le taux de fidélisation des joueurs
3076
+ * @param {string} [startDate]
3077
+ * @param {string} [endDate]
3058
3078
  * @param {*} [options] Override http request option.
3059
3079
  * @throws {RequiredError}
3060
3080
  */
3061
- getRetentionRate(options) {
3081
+ getRetentionRate(startDate, endDate, options) {
3062
3082
  return __awaiter(this, void 0, void 0, function* () {
3063
3083
  var _a, _b, _c;
3064
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getRetentionRate(options);
3084
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getRetentionRate(startDate, endDate, options);
3065
3085
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
3066
3086
  const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ClubAnalyticsStaffApi.getRetentionRate']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
3067
3087
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -3293,11 +3313,12 @@ const ClubAnalyticsStaffApiFactory = function (configuration, basePath, axios) {
3293
3313
  },
3294
3314
  /**
3295
3315
  * Calcule le taux de fidélisation des joueurs
3316
+ * @param {ClubAnalyticsStaffApiGetRetentionRateRequest} requestParameters Request parameters.
3296
3317
  * @param {*} [options] Override http request option.
3297
3318
  * @throws {RequiredError}
3298
3319
  */
3299
- getRetentionRate(options) {
3300
- return localVarFp.getRetentionRate(options).then((request) => request(axios, basePath));
3320
+ getRetentionRate(requestParameters = {}, options) {
3321
+ return localVarFp.getRetentionRate(requestParameters.startDate, requestParameters.endDate, options).then((request) => request(axios, basePath));
3301
3322
  },
3302
3323
  /**
3303
3324
  * Récupère le chiffre d\'affaires par sport
@@ -3519,12 +3540,13 @@ class ClubAnalyticsStaffApi extends base_1.BaseAPI {
3519
3540
  }
3520
3541
  /**
3521
3542
  * Calcule le taux de fidélisation des joueurs
3543
+ * @param {ClubAnalyticsStaffApiGetRetentionRateRequest} requestParameters Request parameters.
3522
3544
  * @param {*} [options] Override http request option.
3523
3545
  * @throws {RequiredError}
3524
3546
  * @memberof ClubAnalyticsStaffApi
3525
3547
  */
3526
- getRetentionRate(options) {
3527
- return (0, exports.ClubAnalyticsStaffApiFp)(this.configuration).getRetentionRate(options).then((request) => request(this.axios, this.basePath));
3548
+ getRetentionRate(requestParameters = {}, options) {
3549
+ return (0, exports.ClubAnalyticsStaffApiFp)(this.configuration).getRetentionRate(requestParameters.startDate, requestParameters.endDate, options).then((request) => request(this.axios, this.basePath));
3528
3550
  }
3529
3551
  /**
3530
3552
  * Récupère le chiffre d\'affaires par sport
package/dist/esm/api.d.ts CHANGED
@@ -1232,6 +1232,30 @@ export interface BookingSummaryClubAddress {
1232
1232
  * @interface BookingsPerDayItem
1233
1233
  */
1234
1234
  export interface BookingsPerDayItem {
1235
+ /**
1236
+ * Valeur mesurée sur la période actuelle
1237
+ * @type {number}
1238
+ * @memberof BookingsPerDayItem
1239
+ */
1240
+ 'value': number;
1241
+ /**
1242
+ * Valeur de référence calculée avec la comparaison Same Weekday
1243
+ * @type {number}
1244
+ * @memberof BookingsPerDayItem
1245
+ */
1246
+ 'reference': number;
1247
+ /**
1248
+ * Différence entre la valeur actuelle et la référence
1249
+ * @type {number}
1250
+ * @memberof BookingsPerDayItem
1251
+ */
1252
+ 'delta': number;
1253
+ /**
1254
+ *
1255
+ * @type {TrendDirection}
1256
+ * @memberof BookingsPerDayItem
1257
+ */
1258
+ 'trend': TrendDirection;
1235
1259
  /**
1236
1260
  * Jour au format YYYY-MM-DD
1237
1261
  * @type {string}
@@ -2192,6 +2216,30 @@ export interface ClubMetadataResponseLocation {
2192
2216
  * @interface ClubNewBookingsResponse
2193
2217
  */
2194
2218
  export interface ClubNewBookingsResponse {
2219
+ /**
2220
+ * Valeur mesurée sur la période actuelle
2221
+ * @type {number}
2222
+ * @memberof ClubNewBookingsResponse
2223
+ */
2224
+ 'value': number;
2225
+ /**
2226
+ * Valeur de référence calculée avec la comparaison Same Weekday
2227
+ * @type {number}
2228
+ * @memberof ClubNewBookingsResponse
2229
+ */
2230
+ 'reference': number;
2231
+ /**
2232
+ * Différence entre la valeur actuelle et la référence
2233
+ * @type {number}
2234
+ * @memberof ClubNewBookingsResponse
2235
+ */
2236
+ 'delta': number;
2237
+ /**
2238
+ *
2239
+ * @type {TrendDirection}
2240
+ * @memberof ClubNewBookingsResponse
2241
+ */
2242
+ 'trend': TrendDirection;
2195
2243
  /**
2196
2244
  * Date de début incluse (format ISO)
2197
2245
  * @type {string}
@@ -2217,6 +2265,30 @@ export interface ClubNewBookingsResponse {
2217
2265
  * @interface ClubNewSubscribersResponse
2218
2266
  */
2219
2267
  export interface ClubNewSubscribersResponse {
2268
+ /**
2269
+ * Valeur mesurée sur la période actuelle
2270
+ * @type {number}
2271
+ * @memberof ClubNewSubscribersResponse
2272
+ */
2273
+ 'value': number;
2274
+ /**
2275
+ * Valeur de référence calculée avec la comparaison Same Weekday
2276
+ * @type {number}
2277
+ * @memberof ClubNewSubscribersResponse
2278
+ */
2279
+ 'reference': number;
2280
+ /**
2281
+ * Différence entre la valeur actuelle et la référence
2282
+ * @type {number}
2283
+ * @memberof ClubNewSubscribersResponse
2284
+ */
2285
+ 'delta': number;
2286
+ /**
2287
+ *
2288
+ * @type {TrendDirection}
2289
+ * @memberof ClubNewSubscribersResponse
2290
+ */
2291
+ 'trend': TrendDirection;
2220
2292
  /**
2221
2293
  * Date de début incluse (format ISO)
2222
2294
  * @type {string}
@@ -6627,6 +6699,30 @@ export interface MonthlyBreakdown {
6627
6699
  * @interface MonthlyTurnoverResponse
6628
6700
  */
6629
6701
  export interface MonthlyTurnoverResponse {
6702
+ /**
6703
+ * Valeur mesurée sur la période actuelle
6704
+ * @type {number}
6705
+ * @memberof MonthlyTurnoverResponse
6706
+ */
6707
+ 'value': number;
6708
+ /**
6709
+ * Valeur de référence calculée avec la comparaison Same Weekday
6710
+ * @type {number}
6711
+ * @memberof MonthlyTurnoverResponse
6712
+ */
6713
+ 'reference': number;
6714
+ /**
6715
+ * Différence entre la valeur actuelle et la référence
6716
+ * @type {number}
6717
+ * @memberof MonthlyTurnoverResponse
6718
+ */
6719
+ 'delta': number;
6720
+ /**
6721
+ *
6722
+ * @type {TrendDirection}
6723
+ * @memberof MonthlyTurnoverResponse
6724
+ */
6725
+ 'trend': TrendDirection;
6630
6726
  /**
6631
6727
  * Année
6632
6728
  * @type {number}
@@ -8419,6 +8515,30 @@ export interface ResetPasswordRequest {
8419
8515
  * @interface RetentionRateResponse
8420
8516
  */
8421
8517
  export interface RetentionRateResponse {
8518
+ /**
8519
+ * Valeur mesurée sur la période actuelle
8520
+ * @type {number}
8521
+ * @memberof RetentionRateResponse
8522
+ */
8523
+ 'value': number;
8524
+ /**
8525
+ * Valeur de référence calculée avec la comparaison Same Weekday
8526
+ * @type {number}
8527
+ * @memberof RetentionRateResponse
8528
+ */
8529
+ 'reference': number;
8530
+ /**
8531
+ * Différence entre la valeur actuelle et la référence
8532
+ * @type {number}
8533
+ * @memberof RetentionRateResponse
8534
+ */
8535
+ 'delta': number;
8536
+ /**
8537
+ *
8538
+ * @type {TrendDirection}
8539
+ * @memberof RetentionRateResponse
8540
+ */
8541
+ 'trend': TrendDirection;
8422
8542
  /**
8423
8543
  * Pourcentage de joueurs fidèles (>= 2 réservations)
8424
8544
  * @type {number}
@@ -9675,6 +9795,17 @@ export interface TimeBounds {
9675
9795
  */
9676
9796
  'end': string;
9677
9797
  }
9798
+ /**
9799
+ *
9800
+ * @export
9801
+ * @enum {string}
9802
+ */
9803
+ export declare const TrendDirection: {
9804
+ readonly Up: "up";
9805
+ readonly Down: "down";
9806
+ readonly Steady: "steady";
9807
+ };
9808
+ export type TrendDirection = typeof TrendDirection[keyof typeof TrendDirection];
9678
9809
  /**
9679
9810
  *
9680
9811
  * @export
@@ -12741,10 +12872,12 @@ export declare const ClubAnalyticsStaffApiAxiosParamCreator: (configuration?: Co
12741
12872
  getNumberOfClubUsers: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
12742
12873
  /**
12743
12874
  * Calcule le taux de fidélisation des joueurs
12875
+ * @param {string} [startDate]
12876
+ * @param {string} [endDate]
12744
12877
  * @param {*} [options] Override http request option.
12745
12878
  * @throws {RequiredError}
12746
12879
  */
12747
- getRetentionRate: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
12880
+ getRetentionRate: (startDate?: string, endDate?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
12748
12881
  /**
12749
12882
  * Récupère le chiffre d\'affaires par sport
12750
12883
  * @param {*} [options] Override http request option.
@@ -12910,10 +13043,12 @@ export declare const ClubAnalyticsStaffApiFp: (configuration?: Configuration) =>
12910
13043
  getNumberOfClubUsers(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClubUserCountResponse>>;
12911
13044
  /**
12912
13045
  * Calcule le taux de fidélisation des joueurs
13046
+ * @param {string} [startDate]
13047
+ * @param {string} [endDate]
12913
13048
  * @param {*} [options] Override http request option.
12914
13049
  * @throws {RequiredError}
12915
13050
  */
12916
- getRetentionRate(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RetentionRateResponse>>;
13051
+ getRetentionRate(startDate?: string, endDate?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RetentionRateResponse>>;
12917
13052
  /**
12918
13053
  * Récupère le chiffre d\'affaires par sport
12919
13054
  * @param {*} [options] Override http request option.
@@ -13068,10 +13203,11 @@ export declare const ClubAnalyticsStaffApiFactory: (configuration?: Configuratio
13068
13203
  getNumberOfClubUsers(options?: RawAxiosRequestConfig): AxiosPromise<ClubUserCountResponse>;
13069
13204
  /**
13070
13205
  * Calcule le taux de fidélisation des joueurs
13206
+ * @param {ClubAnalyticsStaffApiGetRetentionRateRequest} requestParameters Request parameters.
13071
13207
  * @param {*} [options] Override http request option.
13072
13208
  * @throws {RequiredError}
13073
13209
  */
13074
- getRetentionRate(options?: RawAxiosRequestConfig): AxiosPromise<RetentionRateResponse>;
13210
+ getRetentionRate(requestParameters?: ClubAnalyticsStaffApiGetRetentionRateRequest, options?: RawAxiosRequestConfig): AxiosPromise<RetentionRateResponse>;
13075
13211
  /**
13076
13212
  * Récupère le chiffre d\'affaires par sport
13077
13213
  * @param {*} [options] Override http request option.
@@ -13333,6 +13469,25 @@ export interface ClubAnalyticsStaffApiGetNoShowRateRequest {
13333
13469
  */
13334
13470
  readonly endDate?: string;
13335
13471
  }
13472
+ /**
13473
+ * Request parameters for getRetentionRate operation in ClubAnalyticsStaffApi.
13474
+ * @export
13475
+ * @interface ClubAnalyticsStaffApiGetRetentionRateRequest
13476
+ */
13477
+ export interface ClubAnalyticsStaffApiGetRetentionRateRequest {
13478
+ /**
13479
+ *
13480
+ * @type {string}
13481
+ * @memberof ClubAnalyticsStaffApiGetRetentionRate
13482
+ */
13483
+ readonly startDate?: string;
13484
+ /**
13485
+ *
13486
+ * @type {string}
13487
+ * @memberof ClubAnalyticsStaffApiGetRetentionRate
13488
+ */
13489
+ readonly endDate?: string;
13490
+ }
13336
13491
  /**
13337
13492
  * Request parameters for getYearlyTurnOver operation in ClubAnalyticsStaffApi.
13338
13493
  * @export
@@ -13494,11 +13649,12 @@ export declare class ClubAnalyticsStaffApi extends BaseAPI {
13494
13649
  getNumberOfClubUsers(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ClubUserCountResponse, any, {}>>;
13495
13650
  /**
13496
13651
  * Calcule le taux de fidélisation des joueurs
13652
+ * @param {ClubAnalyticsStaffApiGetRetentionRateRequest} requestParameters Request parameters.
13497
13653
  * @param {*} [options] Override http request option.
13498
13654
  * @throws {RequiredError}
13499
13655
  * @memberof ClubAnalyticsStaffApi
13500
13656
  */
13501
- getRetentionRate(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RetentionRateResponse, any, {}>>;
13657
+ getRetentionRate(requestParameters?: ClubAnalyticsStaffApiGetRetentionRateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RetentionRateResponse, any, {}>>;
13502
13658
  /**
13503
13659
  * Récupère le chiffre d\'affaires par sport
13504
13660
  * @param {*} [options] Override http request option.
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
@@ -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
- const { status, data } = await apiInstance.getRetentionRate();
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
- This endpoint does not have any parameters.
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
@@ -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,
@@ -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\&#39;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 (&gt;&#x3D; 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)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tennac-booking/sdk",
3
- "version": "1.0.142",
3
+ "version": "1.0.143",
4
4
  "description": "OpenAPI client for @tennac-booking/sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {