@tennac-booking/sdk 1.0.132 → 1.0.134

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.
Files changed (42) hide show
  1. package/.openapi-generator/FILES +337 -362
  2. package/README.md +3 -28
  3. package/api.ts +302 -1442
  4. package/dist/api.d.ts +304 -1400
  5. package/dist/api.js +18 -127
  6. package/dist/esm/api.d.ts +304 -1400
  7. package/dist/esm/api.js +14 -123
  8. package/docs/CreateEventRequest.md +1 -1
  9. package/docs/SportResponse.md +2 -0
  10. package/docs/SubscriptionPlanDiscountUpdateRequest.md +36 -0
  11. package/docs/{UpdatePlanRequest.md → SubscriptionPlanDiscountUpdateRequestValidFrom.md} +3 -7
  12. package/docs/SubscriptionPlanResponse.md +2 -0
  13. package/docs/SubscriptionsManagerApi.md +7 -7
  14. package/docs/UpdateSubscriptionPlanRequest.md +34 -0
  15. package/package.json +1 -1
  16. package/docs/StripeStripeDeletedProduct.md +0 -25
  17. package/docs/StripeStripePrice.md +0 -63
  18. package/docs/StripeStripePriceBillingScheme.md +0 -10
  19. package/docs/StripeStripePriceCurrencyOptions.md +0 -28
  20. package/docs/StripeStripePriceCurrencyOptionsCustomUnitAmount.md +0 -24
  21. package/docs/StripeStripePriceCurrencyOptionsTaxBehavior.md +0 -12
  22. package/docs/StripeStripePriceCurrencyOptionsTier.md +0 -28
  23. package/docs/StripeStripePriceCustomUnitAmount.md +0 -24
  24. package/docs/StripeStripePriceProduct.md +0 -59
  25. package/docs/StripeStripePriceRecurring.md +0 -28
  26. package/docs/StripeStripePriceRecurringInterval.md +0 -14
  27. package/docs/StripeStripePriceRecurringUsageType.md +0 -10
  28. package/docs/StripeStripePriceTaxBehavior.md +0 -12
  29. package/docs/StripeStripePriceTier.md +0 -28
  30. package/docs/StripeStripePriceTiersMode.md +0 -10
  31. package/docs/StripeStripePriceTransformQuantity.md +0 -22
  32. package/docs/StripeStripePriceTransformQuantityRound.md +0 -10
  33. package/docs/StripeStripePriceType.md +0 -10
  34. package/docs/StripeStripeProduct.md +0 -59
  35. package/docs/StripeStripeProductDefaultPrice.md +0 -63
  36. package/docs/StripeStripeProductMarketingFeature.md +0 -20
  37. package/docs/StripeStripeProductPackageDimensions.md +0 -26
  38. package/docs/StripeStripeProductTaxCode.md +0 -27
  39. package/docs/StripeStripeProductType.md +0 -10
  40. package/docs/StripeStripeResponseStripeStripePrice.md +0 -64
  41. package/docs/StripeStripeResponseStripeStripePriceAllOfLastResponse.md +0 -30
  42. package/docs/StripeStripeTaxCode.md +0 -27
package/dist/esm/api.js CHANGED
@@ -292,115 +292,6 @@ export const StaffBookingPaymentState = {
292
292
  Failed: 'failed',
293
293
  Partial: 'partial'
294
294
  };
295
- export const StripeStripeDeletedProductObjectEnum = {
296
- Product: 'product'
297
- };
298
- export const StripeStripePriceObjectEnum = {
299
- Price: 'price'
300
- };
301
- /**
302
- *
303
- * @export
304
- * @enum {string}
305
- */
306
- export const StripeStripePriceBillingScheme = {
307
- PerUnit: 'per_unit',
308
- Tiered: 'tiered'
309
- };
310
- /**
311
- *
312
- * @export
313
- * @enum {string}
314
- */
315
- export const StripeStripePriceCurrencyOptionsTaxBehavior = {
316
- Exclusive: 'exclusive',
317
- Inclusive: 'inclusive',
318
- Unspecified: 'unspecified'
319
- };
320
- export const StripeStripePriceProductObjectEnum = {
321
- Product: 'product'
322
- };
323
- /**
324
- *
325
- * @export
326
- * @enum {string}
327
- */
328
- export const StripeStripePriceRecurringInterval = {
329
- Day: 'day',
330
- Month: 'month',
331
- Week: 'week',
332
- Year: 'year'
333
- };
334
- /**
335
- *
336
- * @export
337
- * @enum {string}
338
- */
339
- export const StripeStripePriceRecurringUsageType = {
340
- Licensed: 'licensed',
341
- Metered: 'metered'
342
- };
343
- /**
344
- *
345
- * @export
346
- * @enum {string}
347
- */
348
- export const StripeStripePriceTaxBehavior = {
349
- Exclusive: 'exclusive',
350
- Inclusive: 'inclusive',
351
- Unspecified: 'unspecified'
352
- };
353
- /**
354
- *
355
- * @export
356
- * @enum {string}
357
- */
358
- export const StripeStripePriceTiersMode = {
359
- Graduated: 'graduated',
360
- Volume: 'volume'
361
- };
362
- /**
363
- *
364
- * @export
365
- * @enum {string}
366
- */
367
- export const StripeStripePriceTransformQuantityRound = {
368
- Down: 'down',
369
- Up: 'up'
370
- };
371
- /**
372
- *
373
- * @export
374
- * @enum {string}
375
- */
376
- export const StripeStripePriceType = {
377
- OneTime: 'one_time',
378
- Recurring: 'recurring'
379
- };
380
- export const StripeStripeProductObjectEnum = {
381
- Product: 'product'
382
- };
383
- export const StripeStripeProductDefaultPriceObjectEnum = {
384
- Price: 'price'
385
- };
386
- export const StripeStripeProductTaxCodeObjectEnum = {
387
- TaxCode: 'tax_code'
388
- };
389
- /**
390
- *
391
- * @export
392
- * @enum {string}
393
- */
394
- export const StripeStripeProductType = {
395
- Good: 'good',
396
- Service: 'service'
397
- };
398
- export const StripeStripeResponseStripeStripePriceObjectEnum = {
399
- Price: 'price'
400
- };
401
- export const StripeStripeTaxCodeObjectEnum = {
402
- TaxCode: 'tax_code'
403
- };
404
295
  /**
405
296
  *
406
297
  * @export
@@ -9558,14 +9449,14 @@ export const SubscriptionsManagerApiAxiosParamCreator = function (configuration)
9558
9449
  };
9559
9450
  }),
9560
9451
  /**
9561
- * Met à jour un plan en créant un nouveau price et en archivant l\'ancien (manager)
9562
- * @param {UpdatePlanRequest} updatePlanRequest
9452
+ * Met à jour un plan en annotant ses métadonnées et, si demandé, son prix (manager)
9453
+ * @param {UpdateSubscriptionPlanRequest} updateSubscriptionPlanRequest
9563
9454
  * @param {*} [options] Override http request option.
9564
9455
  * @throws {RequiredError}
9565
9456
  */
9566
- updatePlan: (updatePlanRequest_1, ...args_1) => __awaiter(this, [updatePlanRequest_1, ...args_1], void 0, function* (updatePlanRequest, options = {}) {
9567
- // verify required parameter 'updatePlanRequest' is not null or undefined
9568
- assertParamExists('updatePlan', 'updatePlanRequest', updatePlanRequest);
9457
+ updatePlan: (updateSubscriptionPlanRequest_1, ...args_1) => __awaiter(this, [updateSubscriptionPlanRequest_1, ...args_1], void 0, function* (updateSubscriptionPlanRequest, options = {}) {
9458
+ // verify required parameter 'updateSubscriptionPlanRequest' is not null or undefined
9459
+ assertParamExists('updatePlan', 'updateSubscriptionPlanRequest', updateSubscriptionPlanRequest);
9569
9460
  const localVarPath = `/api/subscriptions/plans`;
9570
9461
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
9571
9462
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -9583,7 +9474,7 @@ export const SubscriptionsManagerApiAxiosParamCreator = function (configuration)
9583
9474
  setSearchParams(localVarUrlObj, localVarQueryParameter);
9584
9475
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
9585
9476
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
9586
- localVarRequestOptions.data = serializeDataIfNeeded(updatePlanRequest, localVarRequestOptions, configuration);
9477
+ localVarRequestOptions.data = serializeDataIfNeeded(updateSubscriptionPlanRequest, localVarRequestOptions, configuration);
9587
9478
  return {
9588
9479
  url: toPathString(localVarUrlObj),
9589
9480
  options: localVarRequestOptions,
@@ -9644,15 +9535,15 @@ export const SubscriptionsManagerApiFp = function (configuration) {
9644
9535
  });
9645
9536
  },
9646
9537
  /**
9647
- * Met à jour un plan en créant un nouveau price et en archivant l\'ancien (manager)
9648
- * @param {UpdatePlanRequest} updatePlanRequest
9538
+ * Met à jour un plan en annotant ses métadonnées et, si demandé, son prix (manager)
9539
+ * @param {UpdateSubscriptionPlanRequest} updateSubscriptionPlanRequest
9649
9540
  * @param {*} [options] Override http request option.
9650
9541
  * @throws {RequiredError}
9651
9542
  */
9652
- updatePlan(updatePlanRequest, options) {
9543
+ updatePlan(updateSubscriptionPlanRequest, options) {
9653
9544
  return __awaiter(this, void 0, void 0, function* () {
9654
9545
  var _a, _b, _c;
9655
- const localVarAxiosArgs = yield localVarAxiosParamCreator.updatePlan(updatePlanRequest, options);
9546
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.updatePlan(updateSubscriptionPlanRequest, options);
9656
9547
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
9657
9548
  const localVarOperationServerBasePath = (_c = (_b = operationServerMap['SubscriptionsManagerApi.updatePlan']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
9658
9549
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -9695,13 +9586,13 @@ export const SubscriptionsManagerApiFactory = function (configuration, basePath,
9695
9586
  return localVarFp.deletePlan(requestParameters.productId, options).then((request) => request(axios, basePath));
9696
9587
  },
9697
9588
  /**
9698
- * Met à jour un plan en créant un nouveau price et en archivant l\'ancien (manager)
9589
+ * Met à jour un plan en annotant ses métadonnées et, si demandé, son prix (manager)
9699
9590
  * @param {SubscriptionsManagerApiUpdatePlanRequest} requestParameters Request parameters.
9700
9591
  * @param {*} [options] Override http request option.
9701
9592
  * @throws {RequiredError}
9702
9593
  */
9703
9594
  updatePlan(requestParameters, options) {
9704
- return localVarFp.updatePlan(requestParameters.updatePlanRequest, options).then((request) => request(axios, basePath));
9595
+ return localVarFp.updatePlan(requestParameters.updateSubscriptionPlanRequest, options).then((request) => request(axios, basePath));
9705
9596
  },
9706
9597
  };
9707
9598
  };
@@ -9743,14 +9634,14 @@ export class SubscriptionsManagerApi extends BaseAPI {
9743
9634
  return SubscriptionsManagerApiFp(this.configuration).deletePlan(requestParameters.productId, options).then((request) => request(this.axios, this.basePath));
9744
9635
  }
9745
9636
  /**
9746
- * Met à jour un plan en créant un nouveau price et en archivant l\'ancien (manager)
9637
+ * Met à jour un plan en annotant ses métadonnées et, si demandé, son prix (manager)
9747
9638
  * @param {SubscriptionsManagerApiUpdatePlanRequest} requestParameters Request parameters.
9748
9639
  * @param {*} [options] Override http request option.
9749
9640
  * @throws {RequiredError}
9750
9641
  * @memberof SubscriptionsManagerApi
9751
9642
  */
9752
9643
  updatePlan(requestParameters, options) {
9753
- return SubscriptionsManagerApiFp(this.configuration).updatePlan(requestParameters.updatePlanRequest, options).then((request) => request(this.axios, this.basePath));
9644
+ return SubscriptionsManagerApiFp(this.configuration).updatePlan(requestParameters.updateSubscriptionPlanRequest, options).then((request) => request(this.axios, this.basePath));
9754
9645
  }
9755
9646
  }
9756
9647
  /**
@@ -24,7 +24,7 @@ Name | Type | Description | Notes
24
24
  **teamLimit** | **number** | | [optional] [default to undefined]
25
25
  **price** | **number** | | [optional] [default to undefined]
26
26
  **subscriberPrices** | [**Array<SubscriberPrice>**](SubscriberPrice.md) | | [optional] [default to undefined]
27
- **levels** | **Array<string | null>** | | [optional] [default to undefined]
27
+ **levels** | **Array<number | null>** | | [optional] [default to undefined]
28
28
  **sponsors** | [**Array<EventSponsor>**](EventSponsor.md) | | [optional] [default to undefined]
29
29
  **visibilityType** | **string** | | [default to undefined]
30
30
 
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
11
11
  **description** | **string** | Description du sport | [optional] [default to undefined]
12
12
  **levels** | [**Array<SportLevel>**](SportLevel.md) | Niveaux associés au sport | [optional] [default to undefined]
13
13
  **logos** | **Array<string>** | URLs de logos/images pour le sport | [optional] [default to undefined]
14
+ **surface** | **Array<string>** | Types de surface pour le sport | [optional] [default to undefined]
14
15
  **createdBy** | **string** | ID du club créateur | [optional] [default to undefined]
15
16
  **verified** | **boolean** | Sport vérifié/officiel (non modifiable) | [default to undefined]
16
17
  **createdAt** | **string** | Date de création | [default to undefined]
@@ -28,6 +29,7 @@ const instance: SportResponse = {
28
29
  description,
29
30
  levels,
30
31
  logos,
32
+ surface,
31
33
  createdBy,
32
34
  verified,
33
35
  createdAt,
@@ -0,0 +1,36 @@
1
+ # SubscriptionPlanDiscountUpdateRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **type** | [**DiscountType**](DiscountType.md) | | [default to undefined]
9
+ **percentage** | **number** | | [optional] [default to undefined]
10
+ **maxDiscountAmountInCents** | **number** | | [optional] [default to undefined]
11
+ **validFrom** | [**SubscriptionPlanDiscountUpdateRequestValidFrom**](SubscriptionPlanDiscountUpdateRequestValidFrom.md) | | [optional] [default to undefined]
12
+ **validTo** | [**SubscriptionPlanDiscountUpdateRequestValidFrom**](SubscriptionPlanDiscountUpdateRequestValidFrom.md) | | [optional] [default to undefined]
13
+ **offPeakRuleNames** | **Array<string>** | | [optional] [default to undefined]
14
+ **offPeakRules** | [**Array<OffPeakRule>**](OffPeakRule.md) | | [optional] [default to undefined]
15
+ **pricingPeriodIds** | **Array<string>** | | [optional] [default to undefined]
16
+ **bookingFree** | **boolean** | | [optional] [default to undefined]
17
+
18
+ ## Example
19
+
20
+ ```typescript
21
+ import { SubscriptionPlanDiscountUpdateRequest } from '@tennac-booking/sdk';
22
+
23
+ const instance: SubscriptionPlanDiscountUpdateRequest = {
24
+ type,
25
+ percentage,
26
+ maxDiscountAmountInCents,
27
+ validFrom,
28
+ validTo,
29
+ offPeakRuleNames,
30
+ offPeakRules,
31
+ pricingPeriodIds,
32
+ bookingFree,
33
+ };
34
+ ```
35
+
36
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,21 +1,17 @@
1
- # UpdatePlanRequest
1
+ # SubscriptionPlanDiscountUpdateRequestValidFrom
2
2
 
3
3
 
4
4
  ## Properties
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
- **newAmountInCents** | **number** | | [default to undefined]
9
- **oldPriceId** | **string** | | [default to undefined]
10
8
 
11
9
  ## Example
12
10
 
13
11
  ```typescript
14
- import { UpdatePlanRequest } from '@tennac-booking/sdk';
12
+ import { SubscriptionPlanDiscountUpdateRequestValidFrom } from '@tennac-booking/sdk';
15
13
 
16
- const instance: UpdatePlanRequest = {
17
- newAmountInCents,
18
- oldPriceId,
14
+ const instance: SubscriptionPlanDiscountUpdateRequestValidFrom = {
19
15
  };
20
16
  ```
21
17
 
@@ -5,6 +5,7 @@
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
+ **planId** | **string** | | [default to undefined]
8
9
  **productId** | **string** | | [default to undefined]
9
10
  **productName** | **string** | | [default to undefined]
10
11
  **productActive** | **boolean** | | [default to undefined]
@@ -23,6 +24,7 @@ Name | Type | Description | Notes
23
24
  import { SubscriptionPlanResponse } from '@tennac-booking/sdk';
24
25
 
25
26
  const instance: SubscriptionPlanResponse = {
27
+ planId,
26
28
  productId,
27
29
  productName,
28
30
  productActive,
@@ -170,9 +170,9 @@ const { status, data } = await apiInstance.deletePlan(
170
170
  [[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)
171
171
 
172
172
  # **updatePlan**
173
- > StripeStripeResponseStripeStripePrice updatePlan(updatePlanRequest)
173
+ > any updatePlan(updateSubscriptionPlanRequest)
174
174
 
175
- Met à jour un plan en créant un nouveau price et en archivant l\'ancien (manager)
175
+ Met à jour un plan en annotant ses métadonnées et, si demandé, son prix (manager)
176
176
 
177
177
  ### Example
178
178
 
@@ -180,16 +180,16 @@ Met à jour un plan en créant un nouveau price et en archivant l\'ancien (manag
180
180
  import {
181
181
  SubscriptionsManagerApi,
182
182
  Configuration,
183
- UpdatePlanRequest
183
+ UpdateSubscriptionPlanRequest
184
184
  } from '@tennac-booking/sdk';
185
185
 
186
186
  const configuration = new Configuration();
187
187
  const apiInstance = new SubscriptionsManagerApi(configuration);
188
188
 
189
- let updatePlanRequest: UpdatePlanRequest; //
189
+ let updateSubscriptionPlanRequest: UpdateSubscriptionPlanRequest; //
190
190
 
191
191
  const { status, data } = await apiInstance.updatePlan(
192
- updatePlanRequest
192
+ updateSubscriptionPlanRequest
193
193
  );
194
194
  ```
195
195
 
@@ -197,12 +197,12 @@ const { status, data } = await apiInstance.updatePlan(
197
197
 
198
198
  |Name | Type | Description | Notes|
199
199
  |------------- | ------------- | ------------- | -------------|
200
- | **updatePlanRequest** | **UpdatePlanRequest**| | |
200
+ | **updateSubscriptionPlanRequest** | **UpdateSubscriptionPlanRequest**| | |
201
201
 
202
202
 
203
203
  ### Return type
204
204
 
205
- **StripeStripeResponseStripeStripePrice**
205
+ **any**
206
206
 
207
207
  ### Authorization
208
208
 
@@ -0,0 +1,34 @@
1
+ # UpdateSubscriptionPlanRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **productId** | **string** | | [default to undefined]
9
+ **priceId** | **string** | | [optional] [default to undefined]
10
+ **name** | **string** | | [optional] [default to undefined]
11
+ **description** | **string** | | [optional] [default to undefined]
12
+ **currency** | **string** | | [optional] [default to undefined]
13
+ **interval** | [**PlanInterval**](PlanInterval.md) | | [optional] [default to undefined]
14
+ **discount** | [**SubscriptionPlanDiscountUpdateRequest**](SubscriptionPlanDiscountUpdateRequest.md) | | [optional] [default to undefined]
15
+ **newAmountInCents** | **number** | | [optional] [default to undefined]
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import { UpdateSubscriptionPlanRequest } from '@tennac-booking/sdk';
21
+
22
+ const instance: UpdateSubscriptionPlanRequest = {
23
+ productId,
24
+ priceId,
25
+ name,
26
+ description,
27
+ currency,
28
+ interval,
29
+ discount,
30
+ newAmountInCents,
31
+ };
32
+ ```
33
+
34
+ [[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.132",
3
+ "version": "1.0.134",
4
4
  "description": "OpenAPI client for @tennac-booking/sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {
@@ -1,25 +0,0 @@
1
- # StripeStripeDeletedProduct
2
-
3
- The DeletedProduct object.
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **id** | **string** | Unique identifier for the object. | [default to undefined]
10
- **object** | **string** | String representing the object\'s type. Objects of the same type share the same value. | [default to undefined]
11
- **deleted** | **boolean** | Always true for a deleted object | [default to undefined]
12
-
13
- ## Example
14
-
15
- ```typescript
16
- import { StripeStripeDeletedProduct } from '@tennac-booking/sdk';
17
-
18
- const instance: StripeStripeDeletedProduct = {
19
- id,
20
- object,
21
- deleted,
22
- };
23
- ```
24
-
25
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,63 +0,0 @@
1
- # StripeStripePrice
2
-
3
- Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. [Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme. For example, you might have a single \"gold\" product that has prices for $10/month, $100/year, and €9 once. Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription), [create an invoice](https://stripe.com/docs/billing/invoices/create), and more about [products and prices](https://stripe.com/docs/products-prices/overview).
4
-
5
- ## Properties
6
-
7
- Name | Type | Description | Notes
8
- ------------ | ------------- | ------------- | -------------
9
- **id** | **string** | Unique identifier for the object. | [default to undefined]
10
- **object** | **string** | String representing the object\'s type. Objects of the same type share the same value. | [default to undefined]
11
- **active** | **boolean** | Whether the price can be used for new purchases. | [default to undefined]
12
- **billing_scheme** | [**StripeStripePriceBillingScheme**](StripeStripePriceBillingScheme.md) | | [default to undefined]
13
- **created** | **number** | Time at which the object was created. Measured in seconds since the Unix epoch. | [default to undefined]
14
- **currency** | **string** | Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). | [default to undefined]
15
- **currency_options** | [**{ [key: string]: StripeStripePriceCurrencyOptions; }**](StripeStripePriceCurrencyOptions.md) | Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). | [optional] [default to undefined]
16
- **custom_unit_amount** | [**StripeStripePriceCustomUnitAmount**](StripeStripePriceCustomUnitAmount.md) | When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links. | [default to undefined]
17
- **deleted** | **any** | Always true for a deleted object | [optional] [default to undefined]
18
- **livemode** | **boolean** | Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. | [default to undefined]
19
- **lookup_key** | **string** | A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. | [default to undefined]
20
- **metadata** | **{ [key: string]: string; }** | Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. | [default to undefined]
21
- **nickname** | **string** | A brief description of the price, hidden from customers. | [default to undefined]
22
- **product** | [**StripeStripePriceProduct**](StripeStripePriceProduct.md) | | [default to undefined]
23
- **recurring** | [**StripeStripePriceRecurring**](StripeStripePriceRecurring.md) | The recurring components of a price such as `interval` and `usage_type`. | [default to undefined]
24
- **tax_behavior** | [**StripeStripePriceTaxBehavior**](StripeStripePriceTaxBehavior.md) | Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. | [default to undefined]
25
- **tiers** | [**Array<StripeStripePriceTier>**](StripeStripePriceTier.md) | Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. | [optional] [default to undefined]
26
- **tiers_mode** | [**StripeStripePriceTiersMode**](StripeStripePriceTiersMode.md) | Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows. | [default to undefined]
27
- **transform_quantity** | [**StripeStripePriceTransformQuantity**](StripeStripePriceTransformQuantity.md) | Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`. | [default to undefined]
28
- **type** | [**StripeStripePriceType**](StripeStripePriceType.md) | | [default to undefined]
29
- **unit_amount** | **number** | The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. | [default to undefined]
30
- **unit_amount_decimal** | **string** | The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. | [default to undefined]
31
-
32
- ## Example
33
-
34
- ```typescript
35
- import { StripeStripePrice } from '@tennac-booking/sdk';
36
-
37
- const instance: StripeStripePrice = {
38
- id,
39
- object,
40
- active,
41
- billing_scheme,
42
- created,
43
- currency,
44
- currency_options,
45
- custom_unit_amount,
46
- deleted,
47
- livemode,
48
- lookup_key,
49
- metadata,
50
- nickname,
51
- product,
52
- recurring,
53
- tax_behavior,
54
- tiers,
55
- tiers_mode,
56
- transform_quantity,
57
- type,
58
- unit_amount,
59
- unit_amount_decimal,
60
- };
61
- ```
62
-
63
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,10 +0,0 @@
1
- # StripeStripePriceBillingScheme
2
-
3
-
4
- ## Enum
5
-
6
- * `PerUnit` (value: `'per_unit'`)
7
-
8
- * `Tiered` (value: `'tiered'`)
9
-
10
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,28 +0,0 @@
1
- # StripeStripePriceCurrencyOptions
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **custom_unit_amount** | [**StripeStripePriceCurrencyOptionsCustomUnitAmount**](StripeStripePriceCurrencyOptionsCustomUnitAmount.md) | When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links. | [default to undefined]
9
- **tax_behavior** | [**StripeStripePriceCurrencyOptionsTaxBehavior**](StripeStripePriceCurrencyOptionsTaxBehavior.md) | Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. | [default to undefined]
10
- **tiers** | [**Array<StripeStripePriceCurrencyOptionsTier>**](StripeStripePriceCurrencyOptionsTier.md) | Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. | [optional] [default to undefined]
11
- **unit_amount** | **number** | The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. | [default to undefined]
12
- **unit_amount_decimal** | **string** | The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. | [default to undefined]
13
-
14
- ## Example
15
-
16
- ```typescript
17
- import { StripeStripePriceCurrencyOptions } from '@tennac-booking/sdk';
18
-
19
- const instance: StripeStripePriceCurrencyOptions = {
20
- custom_unit_amount,
21
- tax_behavior,
22
- tiers,
23
- unit_amount,
24
- unit_amount_decimal,
25
- };
26
- ```
27
-
28
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,24 +0,0 @@
1
- # StripeStripePriceCurrencyOptionsCustomUnitAmount
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **maximum** | **number** | The maximum unit amount the customer can specify for this item. | [default to undefined]
9
- **minimum** | **number** | The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount. | [default to undefined]
10
- **preset** | **number** | The starting unit amount which can be updated by the customer. | [default to undefined]
11
-
12
- ## Example
13
-
14
- ```typescript
15
- import { StripeStripePriceCurrencyOptionsCustomUnitAmount } from '@tennac-booking/sdk';
16
-
17
- const instance: StripeStripePriceCurrencyOptionsCustomUnitAmount = {
18
- maximum,
19
- minimum,
20
- preset,
21
- };
22
- ```
23
-
24
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,12 +0,0 @@
1
- # StripeStripePriceCurrencyOptionsTaxBehavior
2
-
3
-
4
- ## Enum
5
-
6
- * `Exclusive` (value: `'exclusive'`)
7
-
8
- * `Inclusive` (value: `'inclusive'`)
9
-
10
- * `Unspecified` (value: `'unspecified'`)
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)
@@ -1,28 +0,0 @@
1
- # StripeStripePriceCurrencyOptionsTier
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **flat_amount** | **number** | Price for the entire tier. | [default to undefined]
9
- **flat_amount_decimal** | **string** | Same as `flat_amount`, but contains a decimal value with at most 12 decimal places. | [default to undefined]
10
- **unit_amount** | **number** | Per unit price for units relevant to the tier. | [default to undefined]
11
- **unit_amount_decimal** | **string** | Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. | [default to undefined]
12
- **up_to** | **number** | Up to and including to this quantity will be contained in the tier. | [default to undefined]
13
-
14
- ## Example
15
-
16
- ```typescript
17
- import { StripeStripePriceCurrencyOptionsTier } from '@tennac-booking/sdk';
18
-
19
- const instance: StripeStripePriceCurrencyOptionsTier = {
20
- flat_amount,
21
- flat_amount_decimal,
22
- unit_amount,
23
- unit_amount_decimal,
24
- up_to,
25
- };
26
- ```
27
-
28
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,24 +0,0 @@
1
- # StripeStripePriceCustomUnitAmount
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **maximum** | **number** | The maximum unit amount the customer can specify for this item. | [default to undefined]
9
- **minimum** | **number** | The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount. | [default to undefined]
10
- **preset** | **number** | The starting unit amount which can be updated by the customer. | [default to undefined]
11
-
12
- ## Example
13
-
14
- ```typescript
15
- import { StripeStripePriceCustomUnitAmount } from '@tennac-booking/sdk';
16
-
17
- const instance: StripeStripePriceCustomUnitAmount = {
18
- maximum,
19
- minimum,
20
- preset,
21
- };
22
- ```
23
-
24
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)