@tennac-booking/sdk 1.0.122 → 1.0.124

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.
@@ -202,6 +202,8 @@ docs/PaymentByPlayerInfo.md
202
202
  docs/PaymentMethod.md
203
203
  docs/PickIUserLocationExcludeKeyofIUserLocationType.md
204
204
  docs/PlanInterval.md
205
+ docs/PlanPrice.md
206
+ docs/PlanPriceInput.md
205
207
  docs/PlayerCategoriesResponse.md
206
208
  docs/PlayerCategory.md
207
209
  docs/PlayerCategoryId.md
@@ -281,6 +283,7 @@ docs/SubscribeRequestBody.md
281
283
  docs/SubscriberPrice.md
282
284
  docs/SubscriptionInfo.md
283
285
  docs/SubscriptionMutationResponse.md
286
+ docs/SubscriptionPlanDiscountResponse.md
284
287
  docs/SubscriptionPlanResponse.md
285
288
  docs/SubscriptionsManagerApi.md
286
289
  docs/SubscriptionsPublicApi.md
package/README.md CHANGED
@@ -171,6 +171,7 @@ Class | Method | HTTP request | Description
171
171
  *SportsManagerApi* | [**deleteSport**](docs/SportsManagerApi.md#deletesport) | **DELETE** /api/sports/{id} |
172
172
  *SportsManagerApi* | [**updateSport**](docs/SportsManagerApi.md#updatesport) | **PUT** /api/sports/{id} |
173
173
  *SportsPublicApi* | [**getVerifiedSports**](docs/SportsPublicApi.md#getverifiedsports) | **GET** /api/sports/verified |
174
+ *SubscriptionsManagerApi* | [**archivePlan**](docs/SubscriptionsManagerApi.md#archiveplan) | **POST** /api/subscriptions/plans/{productId}/archive |
174
175
  *SubscriptionsManagerApi* | [**createPlan**](docs/SubscriptionsManagerApi.md#createplan) | **POST** /api/subscriptions/plans |
175
176
  *SubscriptionsManagerApi* | [**deletePlan**](docs/SubscriptionsManagerApi.md#deleteplan) | **DELETE** /api/subscriptions/plans/{productId} |
176
177
  *SubscriptionsManagerApi* | [**updatePlan**](docs/SubscriptionsManagerApi.md#updateplan) | **PUT** /api/subscriptions/plans |
@@ -399,6 +400,8 @@ Class | Method | HTTP request | Description
399
400
  - [PaymentMethod](docs/PaymentMethod.md)
400
401
  - [PickIUserLocationExcludeKeyofIUserLocationType](docs/PickIUserLocationExcludeKeyofIUserLocationType.md)
401
402
  - [PlanInterval](docs/PlanInterval.md)
403
+ - [PlanPrice](docs/PlanPrice.md)
404
+ - [PlanPriceInput](docs/PlanPriceInput.md)
402
405
  - [PlayerCategoriesResponse](docs/PlayerCategoriesResponse.md)
403
406
  - [PlayerCategory](docs/PlayerCategory.md)
404
407
  - [PlayerCategoryId](docs/PlayerCategoryId.md)
@@ -476,6 +479,7 @@ Class | Method | HTTP request | Description
476
479
  - [SubscriberPrice](docs/SubscriberPrice.md)
477
480
  - [SubscriptionInfo](docs/SubscriptionInfo.md)
478
481
  - [SubscriptionMutationResponse](docs/SubscriptionMutationResponse.md)
482
+ - [SubscriptionPlanDiscountResponse](docs/SubscriptionPlanDiscountResponse.md)
479
483
  - [SubscriptionPlanResponse](docs/SubscriptionPlanResponse.md)
480
484
  - [SurfaceType](docs/SurfaceType.md)
481
485
  - [Team](docs/Team.md)
package/api.ts CHANGED
@@ -2747,11 +2747,11 @@ export interface ClubPlayerSubscriptionSummary {
2747
2747
  */
2748
2748
  'name': string | null;
2749
2749
  /**
2750
- * Montant en centimes
2751
- * @type {number}
2750
+ * Tarifications disponibles
2751
+ * @type {Array<PlanPrice>}
2752
2752
  * @memberof ClubPlayerSubscriptionSummary
2753
2753
  */
2754
- 'amountInCents': number | null;
2754
+ 'prices': Array<PlanPrice>;
2755
2755
  /**
2756
2756
  * Devise
2757
2757
  * @type {string}
@@ -2759,7 +2759,7 @@ export interface ClubPlayerSubscriptionSummary {
2759
2759
  */
2760
2760
  'currency': string | null;
2761
2761
  /**
2762
- * Intervalle de facturation
2762
+ * Intervalle par défaut
2763
2763
  * @type {string}
2764
2764
  * @memberof ClubPlayerSubscriptionSummary
2765
2765
  */
@@ -3985,6 +3985,12 @@ export interface CreateOnsiteInvoiceResponseInvoice {
3985
3985
  * @interface CreatePlan201Response
3986
3986
  */
3987
3987
  export interface CreatePlan201Response {
3988
+ /**
3989
+ *
3990
+ * @type {Array<string>}
3991
+ * @memberof CreatePlan201Response
3992
+ */
3993
+ 'priceIds': Array<string>;
3988
3994
  /**
3989
3995
  *
3990
3996
  * @type {string}
@@ -4099,10 +4105,10 @@ export interface CreateSubscriptionPlanRequest {
4099
4105
  'description'?: string;
4100
4106
  /**
4101
4107
  *
4102
- * @type {number}
4108
+ * @type {Array<PlanPriceInput>}
4103
4109
  * @memberof CreateSubscriptionPlanRequest
4104
4110
  */
4105
- 'amountInCents': number;
4111
+ 'prices': Array<PlanPriceInput>;
4106
4112
  /**
4107
4113
  *
4108
4114
  * @type {string}
@@ -4302,6 +4308,12 @@ export interface DeleteSubscriptionPlanResponse {
4302
4308
  * @memberof DeleteSubscriptionPlanResponse
4303
4309
  */
4304
4310
  'message': string;
4311
+ /**
4312
+ *
4313
+ * @type {boolean}
4314
+ * @memberof DeleteSubscriptionPlanResponse
4315
+ */
4316
+ 'archivedInstead'?: boolean;
4305
4317
  }
4306
4318
  /**
4307
4319
  *
@@ -6095,7 +6107,7 @@ export interface MonthlyBreakdown {
6095
6107
  'invoiceCount': number;
6096
6108
  }
6097
6109
  /**
6098
- * Types TSOA pour les analytics du club
6110
+ *
6099
6111
  * @export
6100
6112
  * @interface MonthlyTurnoverResponse
6101
6113
  */
@@ -6539,6 +6551,60 @@ export const PlanInterval = {
6539
6551
  export type PlanInterval = typeof PlanInterval[keyof typeof PlanInterval];
6540
6552
 
6541
6553
 
6554
+ /**
6555
+ *
6556
+ * @export
6557
+ * @interface PlanPrice
6558
+ */
6559
+ export interface PlanPrice {
6560
+ /**
6561
+ *
6562
+ * @type {number}
6563
+ * @memberof PlanPrice
6564
+ */
6565
+ 'amountInCents': number;
6566
+ /**
6567
+ *
6568
+ * @type {PlanInterval}
6569
+ * @memberof PlanPrice
6570
+ */
6571
+ 'interval': PlanInterval;
6572
+ /**
6573
+ *
6574
+ * @type {boolean}
6575
+ * @memberof PlanPrice
6576
+ */
6577
+ 'active'?: boolean;
6578
+ /**
6579
+ *
6580
+ * @type {string}
6581
+ * @memberof PlanPrice
6582
+ */
6583
+ 'stripePriceId'?: string;
6584
+ }
6585
+
6586
+
6587
+ /**
6588
+ *
6589
+ * @export
6590
+ * @interface PlanPriceInput
6591
+ */
6592
+ export interface PlanPriceInput {
6593
+ /**
6594
+ *
6595
+ * @type {number}
6596
+ * @memberof PlanPriceInput
6597
+ */
6598
+ 'amountInCents': number;
6599
+ /**
6600
+ *
6601
+ * @type {PlanInterval}
6602
+ * @memberof PlanPriceInput
6603
+ */
6604
+ 'interval': PlanInterval;
6605
+ }
6606
+
6607
+
6542
6608
  /**
6543
6609
  *
6544
6610
  * @export
@@ -6921,13 +6987,19 @@ export interface PublicSubscriptionPlanResponse {
6921
6987
  * @type {number}
6922
6988
  * @memberof PublicSubscriptionPlanResponse
6923
6989
  */
6924
- 'amountInCents': number;
6990
+ 'amountInCents'?: number;
6925
6991
  /**
6926
6992
  *
6927
6993
  * @type {string}
6928
6994
  * @memberof PublicSubscriptionPlanResponse
6929
6995
  */
6930
6996
  'currency': string;
6997
+ /**
6998
+ *
6999
+ * @type {Array<PlanPrice>}
7000
+ * @memberof PublicSubscriptionPlanResponse
7001
+ */
7002
+ 'prices': Array<PlanPrice>;
6931
7003
  /**
6932
7004
  *
6933
7005
  * @type {PlanInterval}
@@ -6940,6 +7012,12 @@ export interface PublicSubscriptionPlanResponse {
6940
7012
  * @memberof PublicSubscriptionPlanResponse
6941
7013
  */
6942
7014
  'description'?: string;
7015
+ /**
7016
+ *
7017
+ * @type {SubscriptionPlanDiscountResponse}
7018
+ * @memberof PublicSubscriptionPlanResponse
7019
+ */
7020
+ 'discount'?: SubscriptionPlanDiscountResponse;
6943
7021
  }
6944
7022
 
6945
7023
 
@@ -7571,6 +7649,12 @@ export interface SendSubscriptionInvitationRequest {
7571
7649
  * @memberof SendSubscriptionInvitationRequest
7572
7650
  */
7573
7651
  'productId': string;
7652
+ /**
7653
+ * Price spécifique proposé dans l\'invitation (facultatif).
7654
+ * @type {string}
7655
+ * @memberof SendSubscriptionInvitationRequest
7656
+ */
7657
+ 'priceId'?: string;
7574
7658
  }
7575
7659
  /**
7576
7660
  *
@@ -9736,6 +9820,63 @@ export interface SubscriptionMutationResponse {
9736
9820
  */
9737
9821
  'subscription': { [key: string]: any; };
9738
9822
  }
9823
+ /**
9824
+ *
9825
+ * @export
9826
+ * @interface SubscriptionPlanDiscountResponse
9827
+ */
9828
+ export interface SubscriptionPlanDiscountResponse {
9829
+ /**
9830
+ *
9831
+ * @type {DiscountType}
9832
+ * @memberof SubscriptionPlanDiscountResponse
9833
+ */
9834
+ 'type': DiscountType;
9835
+ /**
9836
+ *
9837
+ * @type {number}
9838
+ * @memberof SubscriptionPlanDiscountResponse
9839
+ */
9840
+ 'percentage'?: number;
9841
+ /**
9842
+ *
9843
+ * @type {number}
9844
+ * @memberof SubscriptionPlanDiscountResponse
9845
+ */
9846
+ 'maxDiscountAmountInCents'?: number;
9847
+ /**
9848
+ *
9849
+ * @type {string}
9850
+ * @memberof SubscriptionPlanDiscountResponse
9851
+ */
9852
+ 'validFrom'?: string;
9853
+ /**
9854
+ *
9855
+ * @type {string}
9856
+ * @memberof SubscriptionPlanDiscountResponse
9857
+ */
9858
+ 'validTo'?: string;
9859
+ /**
9860
+ *
9861
+ * @type {Array<string>}
9862
+ * @memberof SubscriptionPlanDiscountResponse
9863
+ */
9864
+ 'offPeakRuleNames'?: Array<string>;
9865
+ /**
9866
+ *
9867
+ * @type {Array<OffPeakRule>}
9868
+ * @memberof SubscriptionPlanDiscountResponse
9869
+ */
9870
+ 'offPeakRules'?: Array<OffPeakRule>;
9871
+ /**
9872
+ *
9873
+ * @type {boolean}
9874
+ * @memberof SubscriptionPlanDiscountResponse
9875
+ */
9876
+ 'bookingFree'?: boolean;
9877
+ }
9878
+
9879
+
9739
9880
  /**
9740
9881
  *
9741
9882
  * @export
@@ -9771,13 +9912,19 @@ export interface SubscriptionPlanResponse {
9771
9912
  * @type {number}
9772
9913
  * @memberof SubscriptionPlanResponse
9773
9914
  */
9774
- 'amountInCents': number;
9915
+ 'amountInCents'?: number;
9775
9916
  /**
9776
9917
  *
9777
9918
  * @type {string}
9778
9919
  * @memberof SubscriptionPlanResponse
9779
9920
  */
9780
9921
  'currency': string;
9922
+ /**
9923
+ *
9924
+ * @type {Array<PlanPrice>}
9925
+ * @memberof SubscriptionPlanResponse
9926
+ */
9927
+ 'prices': Array<PlanPrice>;
9781
9928
  /**
9782
9929
  *
9783
9930
  * @type {PlanInterval}
@@ -9790,6 +9937,18 @@ export interface SubscriptionPlanResponse {
9790
9937
  * @memberof SubscriptionPlanResponse
9791
9938
  */
9792
9939
  'priceActive': boolean;
9940
+ /**
9941
+ *
9942
+ * @type {string}
9943
+ * @memberof SubscriptionPlanResponse
9944
+ */
9945
+ 'description'?: string;
9946
+ /**
9947
+ *
9948
+ * @type {SubscriptionPlanDiscountResponse}
9949
+ * @memberof SubscriptionPlanResponse
9950
+ */
9951
+ 'discount'?: SubscriptionPlanDiscountResponse;
9793
9952
  }
9794
9953
 
9795
9954
 
@@ -22241,6 +22400,43 @@ export class SportsPublicApi extends BaseAPI {
22241
22400
  */
22242
22401
  export const SubscriptionsManagerApiAxiosParamCreator = function (configuration?: Configuration) {
22243
22402
  return {
22403
+ /**
22404
+ * Supprime (archive) un plan par productId (manager)
22405
+ * @param {string} productId
22406
+ * @param {*} [options] Override http request option.
22407
+ * @throws {RequiredError}
22408
+ */
22409
+ archivePlan: async (productId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
22410
+ // verify required parameter 'productId' is not null or undefined
22411
+ assertParamExists('archivePlan', 'productId', productId)
22412
+ const localVarPath = `/api/subscriptions/plans/{productId}/archive`
22413
+ .replace(`{${"productId"}}`, encodeURIComponent(String(productId)));
22414
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
22415
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
22416
+ let baseOptions;
22417
+ if (configuration) {
22418
+ baseOptions = configuration.baseOptions;
22419
+ }
22420
+
22421
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
22422
+ const localVarHeaderParameter = {} as any;
22423
+ const localVarQueryParameter = {} as any;
22424
+
22425
+ // authentication bearerAuth required
22426
+ // http bearer authentication required
22427
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
22428
+
22429
+
22430
+
22431
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
22432
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
22433
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
22434
+
22435
+ return {
22436
+ url: toPathString(localVarUrlObj),
22437
+ options: localVarRequestOptions,
22438
+ };
22439
+ },
22244
22440
  /**
22245
22441
  * Crée un nouveau plan d\'abonnement (produit + price) pour le club (manager)
22246
22442
  * @param {CreateSubscriptionPlanRequest} createSubscriptionPlanRequest
@@ -22281,7 +22477,7 @@ export const SubscriptionsManagerApiAxiosParamCreator = function (configuration?
22281
22477
  };
22282
22478
  },
22283
22479
  /**
22284
- * Supprime (archive) un plan par productId (manager)
22480
+ * Supprime un plan par productId (manager)
22285
22481
  * @param {string} productId
22286
22482
  * @param {*} [options] Override http request option.
22287
22483
  * @throws {RequiredError}
@@ -22366,6 +22562,18 @@ export const SubscriptionsManagerApiAxiosParamCreator = function (configuration?
22366
22562
  export const SubscriptionsManagerApiFp = function(configuration?: Configuration) {
22367
22563
  const localVarAxiosParamCreator = SubscriptionsManagerApiAxiosParamCreator(configuration)
22368
22564
  return {
22565
+ /**
22566
+ * Supprime (archive) un plan par productId (manager)
22567
+ * @param {string} productId
22568
+ * @param {*} [options] Override http request option.
22569
+ * @throws {RequiredError}
22570
+ */
22571
+ async archivePlan(productId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteSubscriptionPlanResponse>> {
22572
+ const localVarAxiosArgs = await localVarAxiosParamCreator.archivePlan(productId, options);
22573
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
22574
+ const localVarOperationServerBasePath = operationServerMap['SubscriptionsManagerApi.archivePlan']?.[localVarOperationServerIndex]?.url;
22575
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
22576
+ },
22369
22577
  /**
22370
22578
  * Crée un nouveau plan d\'abonnement (produit + price) pour le club (manager)
22371
22579
  * @param {CreateSubscriptionPlanRequest} createSubscriptionPlanRequest
@@ -22379,7 +22587,7 @@ export const SubscriptionsManagerApiFp = function(configuration?: Configuration)
22379
22587
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
22380
22588
  },
22381
22589
  /**
22382
- * Supprime (archive) un plan par productId (manager)
22590
+ * Supprime un plan par productId (manager)
22383
22591
  * @param {string} productId
22384
22592
  * @param {*} [options] Override http request option.
22385
22593
  * @throws {RequiredError}
@@ -22412,6 +22620,15 @@ export const SubscriptionsManagerApiFp = function(configuration?: Configuration)
22412
22620
  export const SubscriptionsManagerApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
22413
22621
  const localVarFp = SubscriptionsManagerApiFp(configuration)
22414
22622
  return {
22623
+ /**
22624
+ * Supprime (archive) un plan par productId (manager)
22625
+ * @param {SubscriptionsManagerApiArchivePlanRequest} requestParameters Request parameters.
22626
+ * @param {*} [options] Override http request option.
22627
+ * @throws {RequiredError}
22628
+ */
22629
+ archivePlan(requestParameters: SubscriptionsManagerApiArchivePlanRequest, options?: RawAxiosRequestConfig): AxiosPromise<DeleteSubscriptionPlanResponse> {
22630
+ return localVarFp.archivePlan(requestParameters.productId, options).then((request) => request(axios, basePath));
22631
+ },
22415
22632
  /**
22416
22633
  * Crée un nouveau plan d\'abonnement (produit + price) pour le club (manager)
22417
22634
  * @param {SubscriptionsManagerApiCreatePlanRequest} requestParameters Request parameters.
@@ -22422,7 +22639,7 @@ export const SubscriptionsManagerApiFactory = function (configuration?: Configur
22422
22639
  return localVarFp.createPlan(requestParameters.createSubscriptionPlanRequest, options).then((request) => request(axios, basePath));
22423
22640
  },
22424
22641
  /**
22425
- * Supprime (archive) un plan par productId (manager)
22642
+ * Supprime un plan par productId (manager)
22426
22643
  * @param {SubscriptionsManagerApiDeletePlanRequest} requestParameters Request parameters.
22427
22644
  * @param {*} [options] Override http request option.
22428
22645
  * @throws {RequiredError}
@@ -22442,6 +22659,20 @@ export const SubscriptionsManagerApiFactory = function (configuration?: Configur
22442
22659
  };
22443
22660
  };
22444
22661
 
22662
+ /**
22663
+ * Request parameters for archivePlan operation in SubscriptionsManagerApi.
22664
+ * @export
22665
+ * @interface SubscriptionsManagerApiArchivePlanRequest
22666
+ */
22667
+ export interface SubscriptionsManagerApiArchivePlanRequest {
22668
+ /**
22669
+ *
22670
+ * @type {string}
22671
+ * @memberof SubscriptionsManagerApiArchivePlan
22672
+ */
22673
+ readonly productId: string
22674
+ }
22675
+
22445
22676
  /**
22446
22677
  * Request parameters for createPlan operation in SubscriptionsManagerApi.
22447
22678
  * @export
@@ -22491,6 +22722,17 @@ export interface SubscriptionsManagerApiUpdatePlanRequest {
22491
22722
  * @extends {BaseAPI}
22492
22723
  */
22493
22724
  export class SubscriptionsManagerApi extends BaseAPI {
22725
+ /**
22726
+ * Supprime (archive) un plan par productId (manager)
22727
+ * @param {SubscriptionsManagerApiArchivePlanRequest} requestParameters Request parameters.
22728
+ * @param {*} [options] Override http request option.
22729
+ * @throws {RequiredError}
22730
+ * @memberof SubscriptionsManagerApi
22731
+ */
22732
+ public archivePlan(requestParameters: SubscriptionsManagerApiArchivePlanRequest, options?: RawAxiosRequestConfig) {
22733
+ return SubscriptionsManagerApiFp(this.configuration).archivePlan(requestParameters.productId, options).then((request) => request(this.axios, this.basePath));
22734
+ }
22735
+
22494
22736
  /**
22495
22737
  * Crée un nouveau plan d\'abonnement (produit + price) pour le club (manager)
22496
22738
  * @param {SubscriptionsManagerApiCreatePlanRequest} requestParameters Request parameters.
@@ -22503,7 +22745,7 @@ export class SubscriptionsManagerApi extends BaseAPI {
22503
22745
  }
22504
22746
 
22505
22747
  /**
22506
- * Supprime (archive) un plan par productId (manager)
22748
+ * Supprime un plan par productId (manager)
22507
22749
  * @param {SubscriptionsManagerApiDeletePlanRequest} requestParameters Request parameters.
22508
22750
  * @param {*} [options] Override http request option.
22509
22751
  * @throws {RequiredError}