@openmeter/sdk 1.0.0-beta.232 → 1.0.0-beta.233
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/src/client/schemas.d.cts +100 -13
- package/dist/cjs/src/client/subscriptions.d.cts +10 -0
- package/dist/cjs/src/zod/index.cjs +1764 -1556
- package/dist/cjs/src/zod/index.cjs.map +1 -1
- package/dist/cjs/src/zod/index.d.cts +97 -69
- package/dist/src/client/schemas.d.ts +100 -13
- package/dist/src/client/subscriptions.d.ts +10 -0
- package/dist/src/zod/index.d.ts +97 -69
- package/dist/src/zod/index.js +1754 -1546
- package/dist/src/zod/index.js.map +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +3 -3
|
@@ -53,17 +53,17 @@ exports.updatePlanBodyPhasesItemNameMax = exports.updatePlanBodyPhasesItemKeyReg
|
|
|
53
53
|
exports.UpdatePlanBody = exports.updatePlanBodyPhasesItemRateCardsItemTwoDiscountsOneUsageOneQuantityOneRegExp = exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneFiveMaximumAmountOneRegExp = exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneFiveMinimumAmountOneRegExp = exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneFiveQuantityPerPackageOneRegExp = exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneFiveAmountOneRegExp = exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneFourMaximumAmountOneRegExp = exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneFourMinimumAmountOneRegExp = exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneFourMultiplierDefault = exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneFourMultiplierOneRegExp = exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneThreeMaximumAmountOneRegExp = exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneThreeMinimumAmountOneRegExp = exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneThreeTiersItemUnitPriceOneAmountOneRegExp = exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneThreeTiersItemFlatPriceOneAmountOneRegExp = exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneThreeTiersItemUpToAmountOneRegExp = exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneTwoMaximumAmountOneRegExp = exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneTwoMinimumAmountOneRegExp = exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneTwoAmountOneRegExp = exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneOnePaymentTermDefault = exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneOneAmountOneRegExp = exports.updatePlanBodyPhasesItemRateCardsItemTwoTaxConfigOneTaxCodeIdRegExp = exports.updatePlanBodyPhasesItemRateCardsItemTwoTaxConfigOneStripeOneCodeRegExp = exports.updatePlanBodyPhasesItemRateCardsItemTwoEntitlementTemplateOneOnePreserveOverageAtResetDefault = exports.updatePlanBodyPhasesItemRateCardsItemTwoEntitlementTemplateOneOneIssueAfterResetPriorityMax = exports.updatePlanBodyPhasesItemRateCardsItemTwoEntitlementTemplateOneOneIssueAfterResetPriorityDefault = exports.updatePlanBodyPhasesItemRateCardsItemTwoEntitlementTemplateOneOneIssueAfterResetMin = exports.updatePlanBodyPhasesItemRateCardsItemTwoEntitlementTemplateOneOneIsSoftLimitDefault = exports.updatePlanBodyPhasesItemRateCardsItemTwoFeatureKeyRegExp = exports.updatePlanBodyPhasesItemRateCardsItemTwoFeatureKeyMax = exports.updatePlanBodyPhasesItemRateCardsItemTwoDescriptionMax = exports.updatePlanBodyPhasesItemRateCardsItemTwoNameMax = exports.updatePlanBodyPhasesItemRateCardsItemTwoKeyRegExp = exports.updatePlanBodyPhasesItemRateCardsItemTwoKeyMax = exports.updatePlanBodyPhasesItemRateCardsItemOneDiscountsOneUsageOneQuantityOneRegExp = exports.updatePlanBodyPhasesItemRateCardsItemOnePriceOnePaymentTermDefault = exports.updatePlanBodyPhasesItemRateCardsItemOnePriceOneAmountOneRegExp = exports.updatePlanBodyPhasesItemRateCardsItemOneTaxConfigOneTaxCodeIdRegExp = exports.updatePlanBodyPhasesItemRateCardsItemOneTaxConfigOneStripeOneCodeRegExp = exports.updatePlanBodyPhasesItemRateCardsItemOneEntitlementTemplateOneOnePreserveOverageAtResetDefault = exports.updatePlanBodyPhasesItemRateCardsItemOneEntitlementTemplateOneOneIssueAfterResetPriorityMax = exports.updatePlanBodyPhasesItemRateCardsItemOneEntitlementTemplateOneOneIssueAfterResetPriorityDefault = exports.updatePlanBodyPhasesItemRateCardsItemOneEntitlementTemplateOneOneIssueAfterResetMin = exports.updatePlanBodyPhasesItemRateCardsItemOneEntitlementTemplateOneOneIsSoftLimitDefault = exports.updatePlanBodyPhasesItemRateCardsItemOneFeatureKeyRegExp = exports.updatePlanBodyPhasesItemRateCardsItemOneFeatureKeyMax = exports.updatePlanBodyPhasesItemRateCardsItemOneDescriptionMax = exports.updatePlanBodyPhasesItemRateCardsItemOneNameMax = exports.updatePlanBodyPhasesItemRateCardsItemOneKeyRegExp = exports.updatePlanBodyPhasesItemRateCardsItemOneKeyMax = exports.updatePlanBodyPhasesItemDescriptionMax = void 0;
|
|
54
54
|
exports.ListPortalTokensQueryParams = exports.listPortalTokensQueryLimitMax = exports.listPortalTokensQueryLimitDefault = exports.CreatePortalTokenBody = exports.QueryPortalMeterQueryParams = exports.queryPortalMeterQueryFilterCustomerIdMax = exports.queryPortalMeterQueryWindowTimeZoneDefault = exports.queryPortalMeterQueryClientIdMax = exports.QueryPortalMeterParams = exports.queryPortalMeterPathMeterSlugRegExp = exports.queryPortalMeterPathMeterSlugMax = exports.PublishPlanParams = exports.publishPlanPathPlanIdRegExp = exports.ArchivePlanParams = exports.archivePlanPathPlanIdRegExp = exports.DeletePlanAddonParams = exports.deletePlanAddonPathPlanAddonIdRegExp = exports.deletePlanAddonPathPlanIdRegExp = exports.GetPlanAddonParams = exports.getPlanAddonPathPlanAddonIdRegExp = exports.getPlanAddonPathPlanAddonIdMax = exports.getPlanAddonPathPlanIdRegExp = exports.getPlanAddonPathPlanIdMax = exports.UpdatePlanAddonBody = exports.UpdatePlanAddonParams = exports.updatePlanAddonPathPlanAddonIdRegExp = exports.updatePlanAddonPathPlanIdRegExp = exports.CreatePlanAddonBody = exports.createPlanAddonBodyAddonIdRegExp = exports.CreatePlanAddonParams = exports.createPlanAddonPathPlanIdRegExp = exports.ListPlanAddonsQueryParams = exports.listPlanAddonsQueryOrderDefault = exports.listPlanAddonsQueryPageSizeMax = exports.listPlanAddonsQueryPageSizeDefault = exports.listPlanAddonsQueryPageDefault = exports.listPlanAddonsQueryKeyItemRegExp = exports.listPlanAddonsQueryKeyItemMax = exports.listPlanAddonsQueryIdItemRegExp = exports.listPlanAddonsQueryIncludeDeletedDefault = exports.ListPlanAddonsParams = exports.listPlanAddonsPathPlanIdRegExp = exports.listPlanAddonsPathPlanIdMax = exports.DeletePlanParams = exports.deletePlanPathPlanIdRegExp = exports.GetPlanQueryParams = exports.getPlanQueryIncludeLatestDefault = exports.GetPlanParams = exports.getPlanPathPlanIdRegExp = exports.getPlanPathPlanIdMax = void 0;
|
|
55
55
|
exports.listEntitlementGrantsQueryIncludeDeletedDefault = exports.ListEntitlementGrantsParams = exports.ListSubjectEntitlementsQueryParams = exports.listSubjectEntitlementsQueryIncludeDeletedDefault = exports.ListSubjectEntitlementsParams = exports.CreateEntitlementBody = exports.createEntitlementBodyThreeUsagePeriodOneIntervalOneOneRegExp = exports.createEntitlementBodyThreeFeatureIdRegExp = exports.createEntitlementBodyThreeFeatureKeyRegExp = exports.createEntitlementBodyThreeFeatureKeyMax = exports.createEntitlementBodyTwoUsagePeriodOneIntervalOneOneRegExp = exports.createEntitlementBodyTwoFeatureIdRegExp = exports.createEntitlementBodyTwoFeatureKeyRegExp = exports.createEntitlementBodyTwoFeatureKeyMax = exports.createEntitlementBodyOnePreserveOverageAtResetDefault = exports.createEntitlementBodyOneIssueAfterResetPriorityMax = exports.createEntitlementBodyOneIssueAfterResetPriorityDefault = exports.createEntitlementBodyOneIssueAfterResetMin = exports.createEntitlementBodyOneUsagePeriodOneIntervalOneOneRegExp = exports.createEntitlementBodyOneIsUnlimitedDefault = exports.createEntitlementBodyOneIsSoftLimitDefault = exports.createEntitlementBodyOneFeatureIdRegExp = exports.createEntitlementBodyOneFeatureKeyRegExp = exports.createEntitlementBodyOneFeatureKeyMax = exports.CreateEntitlementParams = exports.DeleteSubjectParams = exports.GetSubjectParams = exports.UpsertSubjectBody = exports.UpsertSubjectBodyItem = exports.CreateStripeCheckoutSessionBody = exports.createStripeCheckoutSessionBodyOptionsOneCustomTextOneTermsOfServiceAcceptanceMessageMax = exports.createStripeCheckoutSessionBodyOptionsOneCustomTextOneSubmitMessageMax = exports.createStripeCheckoutSessionBodyOptionsOneCustomTextOneShippingAddressMessageMax = exports.createStripeCheckoutSessionBodyOptionsOneCustomTextOneAfterSubmitMessageMax = exports.createStripeCheckoutSessionBodyOptionsOneCurrencyOneRegExp = exports.createStripeCheckoutSessionBodyOptionsOneCurrencyOneMax = exports.createStripeCheckoutSessionBodyOptionsOneCurrencyOneMin = exports.createStripeCheckoutSessionBodyCustomerThreeBillingAddressOneCountryOneRegExp = exports.createStripeCheckoutSessionBodyCustomerThreeBillingAddressOneCountryOneMax = exports.createStripeCheckoutSessionBodyCustomerThreeBillingAddressOneCountryOneMin = exports.createStripeCheckoutSessionBodyCustomerThreeCurrencyOneRegExp = exports.createStripeCheckoutSessionBodyCustomerThreeCurrencyOneMax = exports.createStripeCheckoutSessionBodyCustomerThreeCurrencyOneMin = exports.createStripeCheckoutSessionBodyCustomerThreeUsageAttributionOneSubjectKeysMin = exports.createStripeCheckoutSessionBodyCustomerThreeKeyMax = exports.createStripeCheckoutSessionBodyCustomerThreeDescriptionMax = exports.createStripeCheckoutSessionBodyCustomerThreeNameMax = exports.createStripeCheckoutSessionBodyCustomerOneIdRegExp = exports.createStripeCheckoutSessionBodyAppIdRegExp = exports.InvalidatePortalTokensBody = void 0;
|
|
56
|
-
exports.
|
|
57
|
-
exports.
|
|
58
|
-
exports.
|
|
59
|
-
exports.
|
|
60
|
-
exports.
|
|
61
|
-
exports.
|
|
62
|
-
exports.
|
|
63
|
-
exports.
|
|
64
|
-
exports.ListGrantsV2QueryParams = exports.listGrantsV2QueryOrderDefault = exports.listGrantsV2QueryLimitMax = exports.listGrantsV2QueryLimitDefault = exports.listGrantsV2QueryOffsetMin = exports.listGrantsV2QueryOffsetDefault = exports.listGrantsV2QueryPageSizeMax = exports.listGrantsV2QueryPageSizeDefault = exports.listGrantsV2QueryPageDefault = exports.listGrantsV2QueryIncludeDeletedDefault = exports.listGrantsV2QueryCustomerItemTwoMax = exports.listGrantsV2QueryCustomerItemOneRegExp = exports.ListEventsV2QueryParams = exports.listEventsV2QueryClientIdMax = exports.listEventsV2QueryLimitMax = exports.listEventsV2QueryLimitDefault = exports.GetEntitlementByIdV2Params = exports.getEntitlementByIdV2PathEntitlementIdRegExp = exports.ListEntitlementsV2QueryParams = void 0;
|
|
65
|
-
/**
|
|
66
|
-
* Generated by orval
|
|
56
|
+
exports.createSubscriptionBodyTwoCustomPlanOneOneCurrencyOneMax = exports.createSubscriptionBodyTwoCustomPlanOneOneCurrencyOneMin = exports.createSubscriptionBodyTwoCustomPlanOneOneDescriptionMax = exports.createSubscriptionBodyTwoCustomPlanOneOneNameMax = exports.createSubscriptionBodyTwoCostBasisModeDefault = exports.createSubscriptionBodyOneCustomerKeyMax = exports.createSubscriptionBodyOneCustomerIdRegExp = exports.createSubscriptionBodyOneTimingDefault = exports.createSubscriptionBodyOneCostBasisModeDefault = exports.createSubscriptionBodyOnePlanOneKeyRegExp = exports.createSubscriptionBodyOnePlanOneKeyMax = exports.ResetEntitlementUsageBody = exports.ResetEntitlementUsageParams = exports.GetEntitlementHistoryQueryParams = exports.getEntitlementHistoryQueryWindowTimeZoneDefault = exports.GetEntitlementHistoryParams = exports.DeleteEntitlementParams = exports.GetEntitlementParams = exports.GetEntitlementValueQueryParams = exports.GetEntitlementValueParams = exports.OverrideEntitlementBody = exports.overrideEntitlementBodyThreeUsagePeriodOneIntervalOneOneRegExp = exports.overrideEntitlementBodyThreeFeatureIdRegExp = exports.overrideEntitlementBodyThreeFeatureKeyRegExp = exports.overrideEntitlementBodyThreeFeatureKeyMax = exports.overrideEntitlementBodyTwoUsagePeriodOneIntervalOneOneRegExp = exports.overrideEntitlementBodyTwoFeatureIdRegExp = exports.overrideEntitlementBodyTwoFeatureKeyRegExp = exports.overrideEntitlementBodyTwoFeatureKeyMax = exports.overrideEntitlementBodyOnePreserveOverageAtResetDefault = exports.overrideEntitlementBodyOneIssueAfterResetPriorityMax = exports.overrideEntitlementBodyOneIssueAfterResetPriorityDefault = exports.overrideEntitlementBodyOneIssueAfterResetMin = exports.overrideEntitlementBodyOneUsagePeriodOneIntervalOneOneRegExp = exports.overrideEntitlementBodyOneIsUnlimitedDefault = exports.overrideEntitlementBodyOneIsSoftLimitDefault = exports.overrideEntitlementBodyOneFeatureIdRegExp = exports.overrideEntitlementBodyOneFeatureKeyRegExp = exports.overrideEntitlementBodyOneFeatureKeyMax = exports.OverrideEntitlementParams = exports.CreateGrantBody = exports.createGrantBodyRecurrenceOneIntervalOneOneRegExp = exports.createGrantBodyMinRolloverAmountDefault = exports.createGrantBodyMaxRolloverAmountDefault = exports.createGrantBodyExpirationOneCountMax = exports.createGrantBodyPriorityMax = exports.createGrantBodyAmountMin = exports.CreateGrantParams = exports.ListEntitlementGrantsQueryParams = exports.listEntitlementGrantsQueryOrderByDefault = void 0;
|
|
57
|
+
exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFourMultiplierOneRegExp = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneThreeMaximumAmountOneRegExp = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneThreeMinimumAmountOneRegExp = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneThreeTiersItemUnitPriceOneAmountOneRegExp = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneThreeTiersItemFlatPriceOneAmountOneRegExp = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneThreeTiersItemUpToAmountOneRegExp = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneTwoMaximumAmountOneRegExp = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneTwoMinimumAmountOneRegExp = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneTwoAmountOneRegExp = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneOnePaymentTermDefault = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneOneAmountOneRegExp = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoTaxConfigOneTaxCodeIdRegExp = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoTaxConfigOneStripeOneCodeRegExp = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoEntitlementTemplateOneOnePreserveOverageAtResetDefault = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoEntitlementTemplateOneOneIssueAfterResetPriorityMax = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoEntitlementTemplateOneOneIssueAfterResetPriorityDefault = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoEntitlementTemplateOneOneIssueAfterResetMin = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoEntitlementTemplateOneOneIsSoftLimitDefault = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoFeatureKeyRegExp = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoFeatureKeyMax = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoDescriptionMax = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoNameMax = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoKeyRegExp = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoKeyMax = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemOneDiscountsOneUsageOneQuantityOneRegExp = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemOnePriceOnePaymentTermDefault = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemOnePriceOneAmountOneRegExp = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemOneTaxConfigOneTaxCodeIdRegExp = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemOneTaxConfigOneStripeOneCodeRegExp = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemOneEntitlementTemplateOneOnePreserveOverageAtResetDefault = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemOneEntitlementTemplateOneOneIssueAfterResetPriorityMax = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemOneEntitlementTemplateOneOneIssueAfterResetPriorityDefault = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemOneEntitlementTemplateOneOneIssueAfterResetMin = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemOneEntitlementTemplateOneOneIsSoftLimitDefault = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemOneFeatureKeyRegExp = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemOneFeatureKeyMax = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemOneDescriptionMax = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemOneNameMax = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemOneKeyRegExp = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemOneKeyMax = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemDescriptionMax = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemNameMax = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemKeyRegExp = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemKeyMax = exports.createSubscriptionBodyTwoCustomPlanOneOneSettlementModeDefault = exports.createSubscriptionBodyTwoCustomPlanOneOneProRatingConfigDefault = exports.createSubscriptionBodyTwoCustomPlanOneOneProRatingConfigOneModeDefault = exports.createSubscriptionBodyTwoCustomPlanOneOneProRatingConfigOneEnabledDefault = exports.createSubscriptionBodyTwoCustomPlanOneOneCurrencyDefault = exports.createSubscriptionBodyTwoCustomPlanOneOneCurrencyOneRegExp = void 0;
|
|
58
|
+
exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneTwoMinimumAmountOneRegExp = exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneTwoAmountOneRegExp = exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneOnePaymentTermDefault = exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneOneAmountOneRegExp = exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoTaxConfigOneTaxCodeIdRegExp = exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoTaxConfigOneStripeOneCodeRegExp = exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoEntitlementTemplateOneOnePreserveOverageAtResetDefault = exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoEntitlementTemplateOneOneIssueAfterResetPriorityMax = exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoEntitlementTemplateOneOneIssueAfterResetPriorityDefault = exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoEntitlementTemplateOneOneIssueAfterResetMin = exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoEntitlementTemplateOneOneIsSoftLimitDefault = exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoFeatureKeyRegExp = exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoFeatureKeyMax = exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoDescriptionMax = exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoNameMax = exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoKeyRegExp = exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoKeyMax = exports.editSubscriptionBodyCustomizationsItemOneRateCardOneDiscountsOneUsageOneQuantityOneRegExp = exports.editSubscriptionBodyCustomizationsItemOneRateCardOnePriceOnePaymentTermDefault = exports.editSubscriptionBodyCustomizationsItemOneRateCardOnePriceOneAmountOneRegExp = exports.editSubscriptionBodyCustomizationsItemOneRateCardOneTaxConfigOneTaxCodeIdRegExp = exports.editSubscriptionBodyCustomizationsItemOneRateCardOneTaxConfigOneStripeOneCodeRegExp = exports.editSubscriptionBodyCustomizationsItemOneRateCardOneEntitlementTemplateOneOnePreserveOverageAtResetDefault = exports.editSubscriptionBodyCustomizationsItemOneRateCardOneEntitlementTemplateOneOneIssueAfterResetPriorityMax = exports.editSubscriptionBodyCustomizationsItemOneRateCardOneEntitlementTemplateOneOneIssueAfterResetPriorityDefault = exports.editSubscriptionBodyCustomizationsItemOneRateCardOneEntitlementTemplateOneOneIssueAfterResetMin = exports.editSubscriptionBodyCustomizationsItemOneRateCardOneEntitlementTemplateOneOneIsSoftLimitDefault = exports.editSubscriptionBodyCustomizationsItemOneRateCardOneFeatureKeyRegExp = exports.editSubscriptionBodyCustomizationsItemOneRateCardOneFeatureKeyMax = exports.editSubscriptionBodyCustomizationsItemOneRateCardOneDescriptionMax = exports.editSubscriptionBodyCustomizationsItemOneRateCardOneNameMax = exports.editSubscriptionBodyCustomizationsItemOneRateCardOneKeyRegExp = exports.editSubscriptionBodyCustomizationsItemOneRateCardOneKeyMax = exports.EditSubscriptionParams = exports.editSubscriptionPathSubscriptionIdRegExp = exports.GetSubscriptionQueryParams = exports.GetSubscriptionParams = exports.getSubscriptionPathSubscriptionIdRegExp = exports.CreateSubscriptionBody = exports.createSubscriptionBodyTwoCustomerKeyMax = exports.createSubscriptionBodyTwoCustomerIdRegExp = exports.createSubscriptionBodyTwoTimingDefault = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoDiscountsOneUsageOneQuantityOneRegExp = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFiveMaximumAmountOneRegExp = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFiveMinimumAmountOneRegExp = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFiveQuantityPerPackageOneRegExp = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFiveAmountOneRegExp = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFourMaximumAmountOneRegExp = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFourMinimumAmountOneRegExp = exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFourMultiplierDefault = void 0;
|
|
59
|
+
exports.changeSubscriptionBodyTwoCostBasisModeDefault = exports.changeSubscriptionBodyOneCostBasisModeDefault = exports.changeSubscriptionBodyOnePlanOneKeyRegExp = exports.changeSubscriptionBodyOnePlanOneKeyMax = exports.ChangeSubscriptionParams = exports.changeSubscriptionPathSubscriptionIdRegExp = exports.CancelSubscriptionBody = exports.CancelSubscriptionParams = exports.cancelSubscriptionPathSubscriptionIdRegExp = exports.UpdateSubscriptionAddonBody = exports.updateSubscriptionAddonBodyQuantityMin = exports.updateSubscriptionAddonBodyDescriptionMax = exports.updateSubscriptionAddonBodyNameMax = exports.UpdateSubscriptionAddonParams = exports.updateSubscriptionAddonPathSubscriptionAddonIdRegExp = exports.updateSubscriptionAddonPathSubscriptionIdRegExp = exports.GetSubscriptionAddonParams = exports.getSubscriptionAddonPathSubscriptionAddonIdRegExp = exports.getSubscriptionAddonPathSubscriptionIdRegExp = exports.ListSubscriptionAddonsParams = exports.listSubscriptionAddonsPathSubscriptionIdRegExp = exports.CreateSubscriptionAddonBody = exports.createSubscriptionAddonBodyAddonIdRegExp = exports.createSubscriptionAddonBodyQuantityMin = exports.createSubscriptionAddonBodyDescriptionMax = exports.createSubscriptionAddonBodyNameMax = exports.CreateSubscriptionAddonParams = exports.createSubscriptionAddonPathSubscriptionIdRegExp = exports.DeleteSubscriptionParams = exports.deleteSubscriptionPathSubscriptionIdRegExp = exports.EditSubscriptionBody = exports.editSubscriptionBodyCustomizationsMax = exports.editSubscriptionBodyCustomizationsItemThreePhaseKeyRegExp = exports.editSubscriptionBodyCustomizationsItemThreePhaseKeyMax = exports.editSubscriptionBodyCustomizationsItemThreePhaseDiscountsOneUsageOneQuantityOneRegExp = exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoDiscountsOneUsageOneQuantityOneRegExp = exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneFiveMaximumAmountOneRegExp = exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneFiveMinimumAmountOneRegExp = exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneFiveQuantityPerPackageOneRegExp = exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneFiveAmountOneRegExp = exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneFourMaximumAmountOneRegExp = exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneFourMinimumAmountOneRegExp = exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneFourMultiplierDefault = exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneFourMultiplierOneRegExp = exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneThreeMaximumAmountOneRegExp = exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneThreeMinimumAmountOneRegExp = exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneThreeTiersItemUnitPriceOneAmountOneRegExp = exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneThreeTiersItemFlatPriceOneAmountOneRegExp = exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneThreeTiersItemUpToAmountOneRegExp = exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneTwoMaximumAmountOneRegExp = void 0;
|
|
60
|
+
exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneThreeTiersItemFlatPriceOneAmountOneRegExp = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneThreeTiersItemUpToAmountOneRegExp = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneTwoMaximumAmountOneRegExp = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneTwoMinimumAmountOneRegExp = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneTwoAmountOneRegExp = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneOnePaymentTermDefault = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneOneAmountOneRegExp = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoTaxConfigOneTaxCodeIdRegExp = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoTaxConfigOneStripeOneCodeRegExp = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoEntitlementTemplateOneOnePreserveOverageAtResetDefault = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoEntitlementTemplateOneOneIssueAfterResetPriorityMax = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoEntitlementTemplateOneOneIssueAfterResetPriorityDefault = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoEntitlementTemplateOneOneIssueAfterResetMin = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoEntitlementTemplateOneOneIsSoftLimitDefault = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoFeatureKeyRegExp = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoFeatureKeyMax = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoDescriptionMax = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoNameMax = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoKeyRegExp = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoKeyMax = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemOneDiscountsOneUsageOneQuantityOneRegExp = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemOnePriceOnePaymentTermDefault = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemOnePriceOneAmountOneRegExp = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemOneTaxConfigOneTaxCodeIdRegExp = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemOneTaxConfigOneStripeOneCodeRegExp = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemOneEntitlementTemplateOneOnePreserveOverageAtResetDefault = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemOneEntitlementTemplateOneOneIssueAfterResetPriorityMax = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemOneEntitlementTemplateOneOneIssueAfterResetPriorityDefault = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemOneEntitlementTemplateOneOneIssueAfterResetMin = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemOneEntitlementTemplateOneOneIsSoftLimitDefault = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemOneFeatureKeyRegExp = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemOneFeatureKeyMax = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemOneDescriptionMax = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemOneNameMax = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemOneKeyRegExp = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemOneKeyMax = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemDescriptionMax = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemNameMax = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemKeyRegExp = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemKeyMax = exports.changeSubscriptionBodyTwoCustomPlanOneOneSettlementModeDefault = exports.changeSubscriptionBodyTwoCustomPlanOneOneProRatingConfigDefault = exports.changeSubscriptionBodyTwoCustomPlanOneOneProRatingConfigOneModeDefault = exports.changeSubscriptionBodyTwoCustomPlanOneOneProRatingConfigOneEnabledDefault = exports.changeSubscriptionBodyTwoCustomPlanOneOneCurrencyDefault = exports.changeSubscriptionBodyTwoCustomPlanOneOneCurrencyOneRegExp = exports.changeSubscriptionBodyTwoCustomPlanOneOneCurrencyOneMax = exports.changeSubscriptionBodyTwoCustomPlanOneOneCurrencyOneMin = exports.changeSubscriptionBodyTwoCustomPlanOneOneDescriptionMax = exports.changeSubscriptionBodyTwoCustomPlanOneOneNameMax = void 0;
|
|
61
|
+
exports.CreateCustomerEntitlementV2Body = exports.createCustomerEntitlementV2BodyThreeUsagePeriodOneIntervalOneOneRegExp = exports.createCustomerEntitlementV2BodyThreeFeatureIdRegExp = exports.createCustomerEntitlementV2BodyThreeFeatureKeyRegExp = exports.createCustomerEntitlementV2BodyThreeFeatureKeyMax = exports.createCustomerEntitlementV2BodyTwoUsagePeriodOneIntervalOneOneRegExp = exports.createCustomerEntitlementV2BodyTwoFeatureIdRegExp = exports.createCustomerEntitlementV2BodyTwoFeatureKeyRegExp = exports.createCustomerEntitlementV2BodyTwoFeatureKeyMax = exports.createCustomerEntitlementV2BodyOneGrantsItemExpirationOneCountMax = exports.createCustomerEntitlementV2BodyOneGrantsItemRecurrenceOneIntervalOneOneRegExp = exports.createCustomerEntitlementV2BodyOneGrantsItemMinRolloverAmountDefault = exports.createCustomerEntitlementV2BodyOneGrantsItemPriorityMax = exports.createCustomerEntitlementV2BodyOneGrantsItemAmountMin = exports.createCustomerEntitlementV2BodyOneIssueOnePriorityMax = exports.createCustomerEntitlementV2BodyOneIssueOnePriorityDefault = exports.createCustomerEntitlementV2BodyOneIssueOneAmountMin = exports.createCustomerEntitlementV2BodyOneIssueAfterResetPriorityMax = exports.createCustomerEntitlementV2BodyOneIssueAfterResetPriorityDefault = exports.createCustomerEntitlementV2BodyOneIssueAfterResetMin = exports.createCustomerEntitlementV2BodyOnePreserveOverageAtResetDefault = exports.createCustomerEntitlementV2BodyOneUsagePeriodOneIntervalOneOneRegExp = exports.createCustomerEntitlementV2BodyOneIsSoftLimitDefault = exports.createCustomerEntitlementV2BodyOneFeatureIdRegExp = exports.createCustomerEntitlementV2BodyOneFeatureKeyRegExp = exports.createCustomerEntitlementV2BodyOneFeatureKeyMax = exports.CreateCustomerEntitlementV2Params = exports.createCustomerEntitlementV2PathCustomerIdOrKeyTwoMax = exports.createCustomerEntitlementV2PathCustomerIdOrKeyOneRegExp = exports.UnscheduleCancelationParams = exports.unscheduleCancelationPathSubscriptionIdRegExp = exports.RestoreSubscriptionParams = exports.restoreSubscriptionPathSubscriptionIdRegExp = exports.MigrateSubscriptionBody = exports.migrateSubscriptionBodyTimingDefault = exports.MigrateSubscriptionParams = exports.migrateSubscriptionPathSubscriptionIdRegExp = exports.ChangeSubscriptionBody = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoDiscountsOneUsageOneQuantityOneRegExp = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFiveMaximumAmountOneRegExp = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFiveMinimumAmountOneRegExp = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFiveQuantityPerPackageOneRegExp = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFiveAmountOneRegExp = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFourMaximumAmountOneRegExp = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFourMinimumAmountOneRegExp = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFourMultiplierDefault = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFourMultiplierOneRegExp = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneThreeMaximumAmountOneRegExp = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneThreeMinimumAmountOneRegExp = exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneThreeTiersItemUnitPriceOneAmountOneRegExp = void 0;
|
|
62
|
+
exports.GetCustomerEntitlementHistoryV2Params = exports.getCustomerEntitlementHistoryV2PathEntitlementIdOrFeatureKeyRegExp = exports.getCustomerEntitlementHistoryV2PathEntitlementIdOrFeatureKeyMax = exports.getCustomerEntitlementHistoryV2PathCustomerIdOrKeyTwoMax = exports.getCustomerEntitlementHistoryV2PathCustomerIdOrKeyOneRegExp = exports.CreateCustomerEntitlementGrantV2Body = exports.createCustomerEntitlementGrantV2BodyExpirationOneCountMax = exports.createCustomerEntitlementGrantV2BodyRecurrenceOneIntervalOneOneRegExp = exports.createCustomerEntitlementGrantV2BodyMinRolloverAmountDefault = exports.createCustomerEntitlementGrantV2BodyPriorityMax = exports.createCustomerEntitlementGrantV2BodyAmountMin = exports.CreateCustomerEntitlementGrantV2Params = exports.createCustomerEntitlementGrantV2PathEntitlementIdOrFeatureKeyRegExp = exports.createCustomerEntitlementGrantV2PathEntitlementIdOrFeatureKeyMax = exports.createCustomerEntitlementGrantV2PathCustomerIdOrKeyTwoMax = exports.createCustomerEntitlementGrantV2PathCustomerIdOrKeyOneRegExp = exports.ListCustomerEntitlementGrantsV2QueryParams = exports.listCustomerEntitlementGrantsV2QueryOrderDefault = exports.listCustomerEntitlementGrantsV2QueryLimitMax = exports.listCustomerEntitlementGrantsV2QueryLimitDefault = exports.listCustomerEntitlementGrantsV2QueryOffsetMin = exports.listCustomerEntitlementGrantsV2QueryOffsetDefault = exports.listCustomerEntitlementGrantsV2QueryPageSizeMax = exports.listCustomerEntitlementGrantsV2QueryPageSizeDefault = exports.listCustomerEntitlementGrantsV2QueryPageDefault = exports.listCustomerEntitlementGrantsV2QueryIncludeDeletedDefault = exports.ListCustomerEntitlementGrantsV2Params = exports.listCustomerEntitlementGrantsV2PathEntitlementIdOrFeatureKeyRegExp = exports.listCustomerEntitlementGrantsV2PathEntitlementIdOrFeatureKeyMax = exports.listCustomerEntitlementGrantsV2PathCustomerIdOrKeyTwoMax = exports.listCustomerEntitlementGrantsV2PathCustomerIdOrKeyOneRegExp = exports.DeleteCustomerEntitlementV2Params = exports.deleteCustomerEntitlementV2PathEntitlementIdOrFeatureKeyRegExp = exports.deleteCustomerEntitlementV2PathEntitlementIdOrFeatureKeyMax = exports.deleteCustomerEntitlementV2PathCustomerIdOrKeyTwoMax = exports.deleteCustomerEntitlementV2PathCustomerIdOrKeyOneRegExp = exports.GetCustomerEntitlementV2Params = exports.getCustomerEntitlementV2PathEntitlementIdOrFeatureKeyRegExp = exports.getCustomerEntitlementV2PathEntitlementIdOrFeatureKeyMax = exports.getCustomerEntitlementV2PathCustomerIdOrKeyTwoMax = exports.getCustomerEntitlementV2PathCustomerIdOrKeyOneRegExp = exports.ListCustomerEntitlementsV2QueryParams = exports.listCustomerEntitlementsV2QueryOrderDefault = exports.listCustomerEntitlementsV2QueryPageSizeMax = exports.listCustomerEntitlementsV2QueryPageSizeDefault = exports.listCustomerEntitlementsV2QueryPageDefault = exports.listCustomerEntitlementsV2QueryIncludeDeletedDefault = exports.ListCustomerEntitlementsV2Params = exports.listCustomerEntitlementsV2PathCustomerIdOrKeyTwoMax = exports.listCustomerEntitlementsV2PathCustomerIdOrKeyOneRegExp = void 0;
|
|
63
|
+
exports.listEntitlementsV2QueryOffsetDefault = exports.listEntitlementsV2QueryPageSizeMax = exports.listEntitlementsV2QueryPageSizeDefault = exports.listEntitlementsV2QueryPageDefault = exports.listEntitlementsV2QueryExcludeInactiveDefault = exports.GetCustomerEntitlementValueV2QueryParams = exports.GetCustomerEntitlementValueV2Params = exports.getCustomerEntitlementValueV2PathEntitlementIdOrFeatureKeyRegExp = exports.getCustomerEntitlementValueV2PathEntitlementIdOrFeatureKeyMax = exports.getCustomerEntitlementValueV2PathCustomerIdOrKeyTwoMax = exports.getCustomerEntitlementValueV2PathCustomerIdOrKeyOneRegExp = exports.ResetCustomerEntitlementUsageV2Body = exports.ResetCustomerEntitlementUsageV2Params = exports.resetCustomerEntitlementUsageV2PathEntitlementIdOrFeatureKeyRegExp = exports.resetCustomerEntitlementUsageV2PathEntitlementIdOrFeatureKeyMax = exports.resetCustomerEntitlementUsageV2PathCustomerIdOrKeyTwoMax = exports.resetCustomerEntitlementUsageV2PathCustomerIdOrKeyOneRegExp = exports.OverrideCustomerEntitlementV2Body = exports.overrideCustomerEntitlementV2BodyThreeUsagePeriodOneIntervalOneOneRegExp = exports.overrideCustomerEntitlementV2BodyThreeFeatureIdRegExp = exports.overrideCustomerEntitlementV2BodyThreeFeatureKeyRegExp = exports.overrideCustomerEntitlementV2BodyThreeFeatureKeyMax = exports.overrideCustomerEntitlementV2BodyTwoUsagePeriodOneIntervalOneOneRegExp = exports.overrideCustomerEntitlementV2BodyTwoFeatureIdRegExp = exports.overrideCustomerEntitlementV2BodyTwoFeatureKeyRegExp = exports.overrideCustomerEntitlementV2BodyTwoFeatureKeyMax = exports.overrideCustomerEntitlementV2BodyOneGrantsItemExpirationOneCountMax = exports.overrideCustomerEntitlementV2BodyOneGrantsItemRecurrenceOneIntervalOneOneRegExp = exports.overrideCustomerEntitlementV2BodyOneGrantsItemMinRolloverAmountDefault = exports.overrideCustomerEntitlementV2BodyOneGrantsItemPriorityMax = exports.overrideCustomerEntitlementV2BodyOneGrantsItemAmountMin = exports.overrideCustomerEntitlementV2BodyOneIssueOnePriorityMax = exports.overrideCustomerEntitlementV2BodyOneIssueOnePriorityDefault = exports.overrideCustomerEntitlementV2BodyOneIssueOneAmountMin = exports.overrideCustomerEntitlementV2BodyOneIssueAfterResetPriorityMax = exports.overrideCustomerEntitlementV2BodyOneIssueAfterResetPriorityDefault = exports.overrideCustomerEntitlementV2BodyOneIssueAfterResetMin = exports.overrideCustomerEntitlementV2BodyOnePreserveOverageAtResetDefault = exports.overrideCustomerEntitlementV2BodyOneUsagePeriodOneIntervalOneOneRegExp = exports.overrideCustomerEntitlementV2BodyOneIsSoftLimitDefault = exports.overrideCustomerEntitlementV2BodyOneFeatureIdRegExp = exports.overrideCustomerEntitlementV2BodyOneFeatureKeyRegExp = exports.overrideCustomerEntitlementV2BodyOneFeatureKeyMax = exports.OverrideCustomerEntitlementV2Params = exports.overrideCustomerEntitlementV2PathEntitlementIdOrFeatureKeyTwoMax = exports.overrideCustomerEntitlementV2PathEntitlementIdOrFeatureKeyOneRegExp = exports.overrideCustomerEntitlementV2PathCustomerIdOrKeyTwoMax = exports.overrideCustomerEntitlementV2PathCustomerIdOrKeyOneRegExp = exports.GetCustomerEntitlementHistoryV2QueryParams = exports.getCustomerEntitlementHistoryV2QueryWindowTimeZoneDefault = void 0;
|
|
64
|
+
exports.ListGrantsV2QueryParams = exports.listGrantsV2QueryOrderDefault = exports.listGrantsV2QueryLimitMax = exports.listGrantsV2QueryLimitDefault = exports.listGrantsV2QueryOffsetMin = exports.listGrantsV2QueryOffsetDefault = exports.listGrantsV2QueryPageSizeMax = exports.listGrantsV2QueryPageSizeDefault = exports.listGrantsV2QueryPageDefault = exports.listGrantsV2QueryIncludeDeletedDefault = exports.listGrantsV2QueryCustomerItemTwoMax = exports.listGrantsV2QueryCustomerItemOneRegExp = exports.ListEventsV2QueryParams = exports.listEventsV2QueryClientIdMax = exports.listEventsV2QueryLimitMax = exports.listEventsV2QueryLimitDefault = exports.GetEntitlementByIdV2Params = exports.getEntitlementByIdV2PathEntitlementIdRegExp = exports.ListEntitlementsV2QueryParams = exports.listEntitlementsV2QueryOrderDefault = exports.listEntitlementsV2QueryLimitMax = exports.listEntitlementsV2QueryLimitDefault = exports.listEntitlementsV2QueryOffsetMin = void 0;
|
|
65
|
+
/**
|
|
66
|
+
* Generated by orval 🍺
|
|
67
67
|
* Do not edit manually.
|
|
68
68
|
* OpenMeter Cloud API
|
|
69
69
|
* OpenMeter is a cloud native usage metering service.
|
|
@@ -117,7 +117,7 @@ exports.ListAddonsQueryParams = zod.object({
|
|
|
117
117
|
.optional()
|
|
118
118
|
.describe('Filter by addon.key attribute'),
|
|
119
119
|
keyVersion: zod
|
|
120
|
-
.record(zod.string(), zod.array(zod.coerce.number()))
|
|
120
|
+
.record(zod.string(), zod.array(zod.coerce.number().int()))
|
|
121
121
|
.optional()
|
|
122
122
|
.describe('Filter by addon.key and addon.version attributes'),
|
|
123
123
|
order: zod
|
|
@@ -131,11 +131,13 @@ exports.ListAddonsQueryParams = zod.object({
|
|
|
131
131
|
.describe('The order by field.'),
|
|
132
132
|
page: zod.coerce
|
|
133
133
|
.number()
|
|
134
|
+
.int()
|
|
134
135
|
.min(1)
|
|
135
136
|
.default(exports.listAddonsQueryPageDefault)
|
|
136
137
|
.describe('Page index.\n\nDefault is 1.'),
|
|
137
138
|
pageSize: zod.coerce
|
|
138
139
|
.number()
|
|
140
|
+
.int()
|
|
139
141
|
.min(1)
|
|
140
142
|
.max(exports.listAddonsQueryPageSizeMax)
|
|
141
143
|
.default(exports.listAddonsQueryPageSizeDefault)
|
|
@@ -298,6 +300,7 @@ exports.CreateAddonBody = zod
|
|
|
298
300
|
.describe('You can grant usage automatically alongside the entitlement, the example scenario would be creating a starting balance.\nIf an amount is specified here, a grant will be created alongside the entitlement with the specified amount.\nThat grant will have it\'s rollover settings configured in a way that after each reset operation, the balance will return the original amount specified here.\nManually creating such a grant would mean having the "amount", "minRolloverAmount", and "maxRolloverAmount" fields all be the same.'),
|
|
299
301
|
issueAfterResetPriority: zod.coerce
|
|
300
302
|
.number()
|
|
303
|
+
.int()
|
|
301
304
|
.min(1)
|
|
302
305
|
.max(exports.createAddonBodyRateCardsItemOneEntitlementTemplateOneOneIssueAfterResetPriorityMax)
|
|
303
306
|
.default(exports.createAddonBodyRateCardsItemOneEntitlementTemplateOneOneIssueAfterResetPriorityDefault)
|
|
@@ -477,6 +480,7 @@ exports.CreateAddonBody = zod
|
|
|
477
480
|
.describe('You can grant usage automatically alongside the entitlement, the example scenario would be creating a starting balance.\nIf an amount is specified here, a grant will be created alongside the entitlement with the specified amount.\nThat grant will have it\'s rollover settings configured in a way that after each reset operation, the balance will return the original amount specified here.\nManually creating such a grant would mean having the "amount", "minRolloverAmount", and "maxRolloverAmount" fields all be the same.'),
|
|
478
481
|
issueAfterResetPriority: zod.coerce
|
|
479
482
|
.number()
|
|
483
|
+
.int()
|
|
480
484
|
.min(1)
|
|
481
485
|
.max(exports.createAddonBodyRateCardsItemTwoEntitlementTemplateOneOneIssueAfterResetPriorityMax)
|
|
482
486
|
.default(exports.createAddonBodyRateCardsItemTwoEntitlementTemplateOneOneIssueAfterResetPriorityDefault)
|
|
@@ -550,167 +554,170 @@ exports.CreateAddonBody = zod
|
|
|
550
554
|
price: zod
|
|
551
555
|
.union([
|
|
552
556
|
zod
|
|
553
|
-
.
|
|
554
|
-
|
|
555
|
-
.string()
|
|
556
|
-
.regex(exports.createAddonBodyRateCardsItemTwoPriceOneOneAmountOneRegExp)
|
|
557
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
558
|
-
.describe('The amount of the flat price.'),
|
|
559
|
-
paymentTerm: zod
|
|
560
|
-
.enum(['in_advance', 'in_arrears'])
|
|
561
|
-
.describe('The payment term of a flat price.\nOne of: in_advance or in_arrears.')
|
|
562
|
-
.default(exports.createAddonBodyRateCardsItemTwoPriceOneOnePaymentTermDefault)
|
|
563
|
-
.describe('The payment term of the flat price.\nDefaults to in advance.'),
|
|
564
|
-
type: zod
|
|
565
|
-
.enum(['flat'])
|
|
566
|
-
.describe('The type of the price.'),
|
|
567
|
-
})
|
|
568
|
-
.describe('Flat price with payment term.'),
|
|
569
|
-
zod
|
|
570
|
-
.object({
|
|
571
|
-
amount: zod.coerce
|
|
572
|
-
.string()
|
|
573
|
-
.regex(exports.createAddonBodyRateCardsItemTwoPriceOneTwoAmountOneRegExp)
|
|
574
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
575
|
-
.describe('The amount of the unit price.'),
|
|
576
|
-
maximumAmount: zod.coerce
|
|
577
|
-
.string()
|
|
578
|
-
.regex(exports.createAddonBodyRateCardsItemTwoPriceOneTwoMaximumAmountOneRegExp)
|
|
579
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
580
|
-
.optional()
|
|
581
|
-
.describe('The customer is limited to spend at most the amount.'),
|
|
582
|
-
minimumAmount: zod.coerce
|
|
583
|
-
.string()
|
|
584
|
-
.regex(exports.createAddonBodyRateCardsItemTwoPriceOneTwoMinimumAmountOneRegExp)
|
|
585
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
586
|
-
.optional()
|
|
587
|
-
.describe('The customer is committed to spend at least the amount.'),
|
|
588
|
-
type: zod
|
|
589
|
-
.enum(['unit'])
|
|
590
|
-
.describe('The type of the price.'),
|
|
591
|
-
})
|
|
592
|
-
.describe('Unit price with spend commitments.'),
|
|
593
|
-
zod
|
|
594
|
-
.object({
|
|
595
|
-
maximumAmount: zod.coerce
|
|
596
|
-
.string()
|
|
597
|
-
.regex(exports.createAddonBodyRateCardsItemTwoPriceOneThreeMaximumAmountOneRegExp)
|
|
598
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
599
|
-
.optional()
|
|
600
|
-
.describe('The customer is limited to spend at most the amount.'),
|
|
601
|
-
minimumAmount: zod.coerce
|
|
602
|
-
.string()
|
|
603
|
-
.regex(exports.createAddonBodyRateCardsItemTwoPriceOneThreeMinimumAmountOneRegExp)
|
|
604
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
605
|
-
.optional()
|
|
606
|
-
.describe('The customer is committed to spend at least the amount.'),
|
|
607
|
-
mode: zod
|
|
608
|
-
.enum(['volume', 'graduated'])
|
|
609
|
-
.describe('The mode of the tiered price.')
|
|
610
|
-
.describe('Defines if the tiering mode is volume-based or graduated:\n- In `volume`-based tiering, the maximum quantity within a period determines the per unit price.\n- In `graduated` tiering, pricing can change as the quantity grows.'),
|
|
611
|
-
tiers: zod
|
|
612
|
-
.array(zod
|
|
557
|
+
.union([
|
|
558
|
+
zod
|
|
613
559
|
.object({
|
|
614
|
-
|
|
615
|
-
.
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
.
|
|
626
|
-
.
|
|
627
|
-
|
|
628
|
-
|
|
560
|
+
amount: zod.coerce
|
|
561
|
+
.string()
|
|
562
|
+
.regex(exports.createAddonBodyRateCardsItemTwoPriceOneOneAmountOneRegExp)
|
|
563
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
564
|
+
.describe('The amount of the flat price.'),
|
|
565
|
+
paymentTerm: zod
|
|
566
|
+
.enum(['in_advance', 'in_arrears'])
|
|
567
|
+
.describe('The payment term of a flat price.\nOne of: in_advance or in_arrears.')
|
|
568
|
+
.default(exports.createAddonBodyRateCardsItemTwoPriceOneOnePaymentTermDefault)
|
|
569
|
+
.describe('The payment term of the flat price.\nDefaults to in advance.'),
|
|
570
|
+
type: zod
|
|
571
|
+
.enum(['flat'])
|
|
572
|
+
.describe('The type of the price.'),
|
|
573
|
+
})
|
|
574
|
+
.describe('Flat price with payment term.'),
|
|
575
|
+
zod
|
|
576
|
+
.object({
|
|
577
|
+
amount: zod.coerce
|
|
578
|
+
.string()
|
|
579
|
+
.regex(exports.createAddonBodyRateCardsItemTwoPriceOneTwoAmountOneRegExp)
|
|
580
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
581
|
+
.describe('The amount of the unit price.'),
|
|
582
|
+
maximumAmount: zod.coerce
|
|
583
|
+
.string()
|
|
584
|
+
.regex(exports.createAddonBodyRateCardsItemTwoPriceOneTwoMaximumAmountOneRegExp)
|
|
585
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
586
|
+
.optional()
|
|
587
|
+
.describe('The customer is limited to spend at most the amount.'),
|
|
588
|
+
minimumAmount: zod.coerce
|
|
589
|
+
.string()
|
|
590
|
+
.regex(exports.createAddonBodyRateCardsItemTwoPriceOneTwoMinimumAmountOneRegExp)
|
|
591
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
592
|
+
.optional()
|
|
593
|
+
.describe('The customer is committed to spend at least the amount.'),
|
|
594
|
+
type: zod
|
|
595
|
+
.enum(['unit'])
|
|
596
|
+
.describe('The type of the price.'),
|
|
597
|
+
})
|
|
598
|
+
.describe('Unit price with spend commitments.'),
|
|
599
|
+
zod
|
|
600
|
+
.object({
|
|
601
|
+
maximumAmount: zod.coerce
|
|
602
|
+
.string()
|
|
603
|
+
.regex(exports.createAddonBodyRateCardsItemTwoPriceOneThreeMaximumAmountOneRegExp)
|
|
604
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
605
|
+
.optional()
|
|
606
|
+
.describe('The customer is limited to spend at most the amount.'),
|
|
607
|
+
minimumAmount: zod.coerce
|
|
608
|
+
.string()
|
|
609
|
+
.regex(exports.createAddonBodyRateCardsItemTwoPriceOneThreeMinimumAmountOneRegExp)
|
|
610
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
611
|
+
.optional()
|
|
612
|
+
.describe('The customer is committed to spend at least the amount.'),
|
|
613
|
+
mode: zod
|
|
614
|
+
.enum(['volume', 'graduated'])
|
|
615
|
+
.describe('The mode of the tiered price.')
|
|
616
|
+
.describe('Defines if the tiering mode is volume-based or graduated:\n- In `volume`-based tiering, the maximum quantity within a period determines the per unit price.\n- In `graduated` tiering, pricing can change as the quantity grows.'),
|
|
617
|
+
tiers: zod
|
|
618
|
+
.array(zod
|
|
629
619
|
.object({
|
|
630
|
-
|
|
620
|
+
flatPrice: zod
|
|
621
|
+
.object({
|
|
622
|
+
amount: zod.coerce
|
|
623
|
+
.string()
|
|
624
|
+
.regex(exports.createAddonBodyRateCardsItemTwoPriceOneThreeTiersItemFlatPriceOneAmountOneRegExp)
|
|
625
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
626
|
+
.describe('The amount of the flat price.'),
|
|
627
|
+
type: zod
|
|
628
|
+
.enum(['flat'])
|
|
629
|
+
.describe('The type of the price.'),
|
|
630
|
+
})
|
|
631
|
+
.describe('Flat price.')
|
|
632
|
+
.nullable()
|
|
633
|
+
.describe('The flat price component of the tier.'),
|
|
634
|
+
unitPrice: zod
|
|
635
|
+
.object({
|
|
636
|
+
amount: zod.coerce
|
|
637
|
+
.string()
|
|
638
|
+
.regex(exports.createAddonBodyRateCardsItemTwoPriceOneThreeTiersItemUnitPriceOneAmountOneRegExp)
|
|
639
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
640
|
+
.describe('The amount of the unit price.'),
|
|
641
|
+
type: zod
|
|
642
|
+
.enum(['unit'])
|
|
643
|
+
.describe('The type of the price.'),
|
|
644
|
+
})
|
|
645
|
+
.describe('Unit price.')
|
|
646
|
+
.nullable()
|
|
647
|
+
.describe('The unit price component of the tier.'),
|
|
648
|
+
upToAmount: zod.coerce
|
|
631
649
|
.string()
|
|
632
|
-
.regex(exports.
|
|
650
|
+
.regex(exports.createAddonBodyRateCardsItemTwoPriceOneThreeTiersItemUpToAmountOneRegExp)
|
|
633
651
|
.describe('Numeric represents an arbitrary precision number.')
|
|
634
|
-
.
|
|
635
|
-
|
|
636
|
-
.enum(['unit'])
|
|
637
|
-
.describe('The type of the price.'),
|
|
652
|
+
.optional()
|
|
653
|
+
.describe('Up to and including to this quantity will be contained in the tier.\nIf null, the tier is open-ended.'),
|
|
638
654
|
})
|
|
639
|
-
.describe('
|
|
640
|
-
.
|
|
641
|
-
.describe('The
|
|
642
|
-
|
|
655
|
+
.describe('A price tier.\nAt least one price component is required in each tier.'))
|
|
656
|
+
.min(1)
|
|
657
|
+
.describe('The tiers of the tiered price.\nAt least one price component is required in each tier.'),
|
|
658
|
+
type: zod
|
|
659
|
+
.enum(['tiered'])
|
|
660
|
+
.describe('The type of the price.\n\nOne of: flat, unit, or tiered.'),
|
|
661
|
+
})
|
|
662
|
+
.describe('Tiered price with spend commitments.'),
|
|
663
|
+
zod
|
|
664
|
+
.object({
|
|
665
|
+
maximumAmount: zod.coerce
|
|
666
|
+
.string()
|
|
667
|
+
.regex(exports.createAddonBodyRateCardsItemTwoPriceOneFourMaximumAmountOneRegExp)
|
|
668
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
669
|
+
.optional()
|
|
670
|
+
.describe('The customer is limited to spend at most the amount.'),
|
|
671
|
+
minimumAmount: zod.coerce
|
|
643
672
|
.string()
|
|
644
|
-
.regex(exports.
|
|
673
|
+
.regex(exports.createAddonBodyRateCardsItemTwoPriceOneFourMinimumAmountOneRegExp)
|
|
645
674
|
.describe('Numeric represents an arbitrary precision number.')
|
|
646
675
|
.optional()
|
|
647
|
-
.describe('
|
|
676
|
+
.describe('The customer is committed to spend at least the amount.'),
|
|
677
|
+
multiplier: zod.coerce
|
|
678
|
+
.string()
|
|
679
|
+
.regex(exports.createAddonBodyRateCardsItemTwoPriceOneFourMultiplierOneRegExp)
|
|
680
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
681
|
+
.default(exports.createAddonBodyRateCardsItemTwoPriceOneFourMultiplierDefault)
|
|
682
|
+
.describe('The multiplier to apply to the base price to get the dynamic price.\n\nExamples:\n- 0.0: the price is zero\n- 0.5: the price is 50% of the base price\n- 1.0: the price is the same as the base price\n- 1.5: the price is 150% of the base price'),
|
|
683
|
+
type: zod
|
|
684
|
+
.enum(['dynamic'])
|
|
685
|
+
.describe('The type of the price.'),
|
|
648
686
|
})
|
|
649
|
-
.describe('
|
|
650
|
-
|
|
651
|
-
.
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
.
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
.
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
.
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
zod
|
|
683
|
-
.object({
|
|
684
|
-
amount: zod.coerce
|
|
685
|
-
.string()
|
|
686
|
-
.regex(exports.createAddonBodyRateCardsItemTwoPriceOneFiveAmountOneRegExp)
|
|
687
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
688
|
-
.describe('The price of one package.'),
|
|
689
|
-
maximumAmount: zod.coerce
|
|
690
|
-
.string()
|
|
691
|
-
.regex(exports.createAddonBodyRateCardsItemTwoPriceOneFiveMaximumAmountOneRegExp)
|
|
692
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
693
|
-
.optional()
|
|
694
|
-
.describe('The customer is limited to spend at most the amount.'),
|
|
695
|
-
minimumAmount: zod.coerce
|
|
696
|
-
.string()
|
|
697
|
-
.regex(exports.createAddonBodyRateCardsItemTwoPriceOneFiveMinimumAmountOneRegExp)
|
|
698
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
699
|
-
.optional()
|
|
700
|
-
.describe('The customer is committed to spend at least the amount.'),
|
|
701
|
-
quantityPerPackage: zod.coerce
|
|
702
|
-
.string()
|
|
703
|
-
.regex(exports.createAddonBodyRateCardsItemTwoPriceOneFiveQuantityPerPackageOneRegExp)
|
|
704
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
705
|
-
.describe('The quantity per package.'),
|
|
706
|
-
type: zod
|
|
707
|
-
.enum(['package'])
|
|
708
|
-
.describe('The type of the price.'),
|
|
709
|
-
})
|
|
710
|
-
.describe('Package price with spend commitments.'),
|
|
687
|
+
.describe('Dynamic price with spend commitments.'),
|
|
688
|
+
zod
|
|
689
|
+
.object({
|
|
690
|
+
amount: zod.coerce
|
|
691
|
+
.string()
|
|
692
|
+
.regex(exports.createAddonBodyRateCardsItemTwoPriceOneFiveAmountOneRegExp)
|
|
693
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
694
|
+
.describe('The price of one package.'),
|
|
695
|
+
maximumAmount: zod.coerce
|
|
696
|
+
.string()
|
|
697
|
+
.regex(exports.createAddonBodyRateCardsItemTwoPriceOneFiveMaximumAmountOneRegExp)
|
|
698
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
699
|
+
.optional()
|
|
700
|
+
.describe('The customer is limited to spend at most the amount.'),
|
|
701
|
+
minimumAmount: zod.coerce
|
|
702
|
+
.string()
|
|
703
|
+
.regex(exports.createAddonBodyRateCardsItemTwoPriceOneFiveMinimumAmountOneRegExp)
|
|
704
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
705
|
+
.optional()
|
|
706
|
+
.describe('The customer is committed to spend at least the amount.'),
|
|
707
|
+
quantityPerPackage: zod.coerce
|
|
708
|
+
.string()
|
|
709
|
+
.regex(exports.createAddonBodyRateCardsItemTwoPriceOneFiveQuantityPerPackageOneRegExp)
|
|
710
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
711
|
+
.describe('The quantity per package.'),
|
|
712
|
+
type: zod
|
|
713
|
+
.enum(['package'])
|
|
714
|
+
.describe('The type of the price.'),
|
|
715
|
+
})
|
|
716
|
+
.describe('Package price with spend commitments.'),
|
|
717
|
+
])
|
|
718
|
+
.describe('The price of the usage based rate card.'),
|
|
719
|
+
zod.null(),
|
|
711
720
|
])
|
|
712
|
-
.describe('The price of the usage based rate card.')
|
|
713
|
-
.nullable()
|
|
714
721
|
.describe('The price of the rate card.\nWhen null, the feature or service is free.'),
|
|
715
722
|
taxConfig: zod
|
|
716
723
|
.object({
|
|
@@ -892,6 +899,7 @@ exports.UpdateAddonBody = zod
|
|
|
892
899
|
.describe('You can grant usage automatically alongside the entitlement, the example scenario would be creating a starting balance.\nIf an amount is specified here, a grant will be created alongside the entitlement with the specified amount.\nThat grant will have it\'s rollover settings configured in a way that after each reset operation, the balance will return the original amount specified here.\nManually creating such a grant would mean having the "amount", "minRolloverAmount", and "maxRolloverAmount" fields all be the same.'),
|
|
893
900
|
issueAfterResetPriority: zod.coerce
|
|
894
901
|
.number()
|
|
902
|
+
.int()
|
|
895
903
|
.min(1)
|
|
896
904
|
.max(exports.updateAddonBodyRateCardsItemOneEntitlementTemplateOneOneIssueAfterResetPriorityMax)
|
|
897
905
|
.default(exports.updateAddonBodyRateCardsItemOneEntitlementTemplateOneOneIssueAfterResetPriorityDefault)
|
|
@@ -1071,6 +1079,7 @@ exports.UpdateAddonBody = zod
|
|
|
1071
1079
|
.describe('You can grant usage automatically alongside the entitlement, the example scenario would be creating a starting balance.\nIf an amount is specified here, a grant will be created alongside the entitlement with the specified amount.\nThat grant will have it\'s rollover settings configured in a way that after each reset operation, the balance will return the original amount specified here.\nManually creating such a grant would mean having the "amount", "minRolloverAmount", and "maxRolloverAmount" fields all be the same.'),
|
|
1072
1080
|
issueAfterResetPriority: zod.coerce
|
|
1073
1081
|
.number()
|
|
1082
|
+
.int()
|
|
1074
1083
|
.min(1)
|
|
1075
1084
|
.max(exports.updateAddonBodyRateCardsItemTwoEntitlementTemplateOneOneIssueAfterResetPriorityMax)
|
|
1076
1085
|
.default(exports.updateAddonBodyRateCardsItemTwoEntitlementTemplateOneOneIssueAfterResetPriorityDefault)
|
|
@@ -1144,167 +1153,170 @@ exports.UpdateAddonBody = zod
|
|
|
1144
1153
|
price: zod
|
|
1145
1154
|
.union([
|
|
1146
1155
|
zod
|
|
1147
|
-
.
|
|
1148
|
-
|
|
1149
|
-
.string()
|
|
1150
|
-
.regex(exports.updateAddonBodyRateCardsItemTwoPriceOneOneAmountOneRegExp)
|
|
1151
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
1152
|
-
.describe('The amount of the flat price.'),
|
|
1153
|
-
paymentTerm: zod
|
|
1154
|
-
.enum(['in_advance', 'in_arrears'])
|
|
1155
|
-
.describe('The payment term of a flat price.\nOne of: in_advance or in_arrears.')
|
|
1156
|
-
.default(exports.updateAddonBodyRateCardsItemTwoPriceOneOnePaymentTermDefault)
|
|
1157
|
-
.describe('The payment term of the flat price.\nDefaults to in advance.'),
|
|
1158
|
-
type: zod
|
|
1159
|
-
.enum(['flat'])
|
|
1160
|
-
.describe('The type of the price.'),
|
|
1161
|
-
})
|
|
1162
|
-
.describe('Flat price with payment term.'),
|
|
1163
|
-
zod
|
|
1164
|
-
.object({
|
|
1165
|
-
amount: zod.coerce
|
|
1166
|
-
.string()
|
|
1167
|
-
.regex(exports.updateAddonBodyRateCardsItemTwoPriceOneTwoAmountOneRegExp)
|
|
1168
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
1169
|
-
.describe('The amount of the unit price.'),
|
|
1170
|
-
maximumAmount: zod.coerce
|
|
1171
|
-
.string()
|
|
1172
|
-
.regex(exports.updateAddonBodyRateCardsItemTwoPriceOneTwoMaximumAmountOneRegExp)
|
|
1173
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
1174
|
-
.optional()
|
|
1175
|
-
.describe('The customer is limited to spend at most the amount.'),
|
|
1176
|
-
minimumAmount: zod.coerce
|
|
1177
|
-
.string()
|
|
1178
|
-
.regex(exports.updateAddonBodyRateCardsItemTwoPriceOneTwoMinimumAmountOneRegExp)
|
|
1179
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
1180
|
-
.optional()
|
|
1181
|
-
.describe('The customer is committed to spend at least the amount.'),
|
|
1182
|
-
type: zod
|
|
1183
|
-
.enum(['unit'])
|
|
1184
|
-
.describe('The type of the price.'),
|
|
1185
|
-
})
|
|
1186
|
-
.describe('Unit price with spend commitments.'),
|
|
1187
|
-
zod
|
|
1188
|
-
.object({
|
|
1189
|
-
maximumAmount: zod.coerce
|
|
1190
|
-
.string()
|
|
1191
|
-
.regex(exports.updateAddonBodyRateCardsItemTwoPriceOneThreeMaximumAmountOneRegExp)
|
|
1192
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
1193
|
-
.optional()
|
|
1194
|
-
.describe('The customer is limited to spend at most the amount.'),
|
|
1195
|
-
minimumAmount: zod.coerce
|
|
1196
|
-
.string()
|
|
1197
|
-
.regex(exports.updateAddonBodyRateCardsItemTwoPriceOneThreeMinimumAmountOneRegExp)
|
|
1198
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
1199
|
-
.optional()
|
|
1200
|
-
.describe('The customer is committed to spend at least the amount.'),
|
|
1201
|
-
mode: zod
|
|
1202
|
-
.enum(['volume', 'graduated'])
|
|
1203
|
-
.describe('The mode of the tiered price.')
|
|
1204
|
-
.describe('Defines if the tiering mode is volume-based or graduated:\n- In `volume`-based tiering, the maximum quantity within a period determines the per unit price.\n- In `graduated` tiering, pricing can change as the quantity grows.'),
|
|
1205
|
-
tiers: zod
|
|
1206
|
-
.array(zod
|
|
1156
|
+
.union([
|
|
1157
|
+
zod
|
|
1207
1158
|
.object({
|
|
1208
|
-
|
|
1209
|
-
.
|
|
1210
|
-
|
|
1211
|
-
|
|
1212
|
-
|
|
1213
|
-
|
|
1214
|
-
|
|
1215
|
-
|
|
1216
|
-
|
|
1217
|
-
|
|
1218
|
-
|
|
1219
|
-
.
|
|
1220
|
-
.
|
|
1221
|
-
|
|
1222
|
-
|
|
1159
|
+
amount: zod.coerce
|
|
1160
|
+
.string()
|
|
1161
|
+
.regex(exports.updateAddonBodyRateCardsItemTwoPriceOneOneAmountOneRegExp)
|
|
1162
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
1163
|
+
.describe('The amount of the flat price.'),
|
|
1164
|
+
paymentTerm: zod
|
|
1165
|
+
.enum(['in_advance', 'in_arrears'])
|
|
1166
|
+
.describe('The payment term of a flat price.\nOne of: in_advance or in_arrears.')
|
|
1167
|
+
.default(exports.updateAddonBodyRateCardsItemTwoPriceOneOnePaymentTermDefault)
|
|
1168
|
+
.describe('The payment term of the flat price.\nDefaults to in advance.'),
|
|
1169
|
+
type: zod
|
|
1170
|
+
.enum(['flat'])
|
|
1171
|
+
.describe('The type of the price.'),
|
|
1172
|
+
})
|
|
1173
|
+
.describe('Flat price with payment term.'),
|
|
1174
|
+
zod
|
|
1175
|
+
.object({
|
|
1176
|
+
amount: zod.coerce
|
|
1177
|
+
.string()
|
|
1178
|
+
.regex(exports.updateAddonBodyRateCardsItemTwoPriceOneTwoAmountOneRegExp)
|
|
1179
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
1180
|
+
.describe('The amount of the unit price.'),
|
|
1181
|
+
maximumAmount: zod.coerce
|
|
1182
|
+
.string()
|
|
1183
|
+
.regex(exports.updateAddonBodyRateCardsItemTwoPriceOneTwoMaximumAmountOneRegExp)
|
|
1184
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
1185
|
+
.optional()
|
|
1186
|
+
.describe('The customer is limited to spend at most the amount.'),
|
|
1187
|
+
minimumAmount: zod.coerce
|
|
1188
|
+
.string()
|
|
1189
|
+
.regex(exports.updateAddonBodyRateCardsItemTwoPriceOneTwoMinimumAmountOneRegExp)
|
|
1190
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
1191
|
+
.optional()
|
|
1192
|
+
.describe('The customer is committed to spend at least the amount.'),
|
|
1193
|
+
type: zod
|
|
1194
|
+
.enum(['unit'])
|
|
1195
|
+
.describe('The type of the price.'),
|
|
1196
|
+
})
|
|
1197
|
+
.describe('Unit price with spend commitments.'),
|
|
1198
|
+
zod
|
|
1199
|
+
.object({
|
|
1200
|
+
maximumAmount: zod.coerce
|
|
1201
|
+
.string()
|
|
1202
|
+
.regex(exports.updateAddonBodyRateCardsItemTwoPriceOneThreeMaximumAmountOneRegExp)
|
|
1203
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
1204
|
+
.optional()
|
|
1205
|
+
.describe('The customer is limited to spend at most the amount.'),
|
|
1206
|
+
minimumAmount: zod.coerce
|
|
1207
|
+
.string()
|
|
1208
|
+
.regex(exports.updateAddonBodyRateCardsItemTwoPriceOneThreeMinimumAmountOneRegExp)
|
|
1209
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
1210
|
+
.optional()
|
|
1211
|
+
.describe('The customer is committed to spend at least the amount.'),
|
|
1212
|
+
mode: zod
|
|
1213
|
+
.enum(['volume', 'graduated'])
|
|
1214
|
+
.describe('The mode of the tiered price.')
|
|
1215
|
+
.describe('Defines if the tiering mode is volume-based or graduated:\n- In `volume`-based tiering, the maximum quantity within a period determines the per unit price.\n- In `graduated` tiering, pricing can change as the quantity grows.'),
|
|
1216
|
+
tiers: zod
|
|
1217
|
+
.array(zod
|
|
1223
1218
|
.object({
|
|
1224
|
-
|
|
1219
|
+
flatPrice: zod
|
|
1220
|
+
.object({
|
|
1221
|
+
amount: zod.coerce
|
|
1222
|
+
.string()
|
|
1223
|
+
.regex(exports.updateAddonBodyRateCardsItemTwoPriceOneThreeTiersItemFlatPriceOneAmountOneRegExp)
|
|
1224
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
1225
|
+
.describe('The amount of the flat price.'),
|
|
1226
|
+
type: zod
|
|
1227
|
+
.enum(['flat'])
|
|
1228
|
+
.describe('The type of the price.'),
|
|
1229
|
+
})
|
|
1230
|
+
.describe('Flat price.')
|
|
1231
|
+
.nullable()
|
|
1232
|
+
.describe('The flat price component of the tier.'),
|
|
1233
|
+
unitPrice: zod
|
|
1234
|
+
.object({
|
|
1235
|
+
amount: zod.coerce
|
|
1236
|
+
.string()
|
|
1237
|
+
.regex(exports.updateAddonBodyRateCardsItemTwoPriceOneThreeTiersItemUnitPriceOneAmountOneRegExp)
|
|
1238
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
1239
|
+
.describe('The amount of the unit price.'),
|
|
1240
|
+
type: zod
|
|
1241
|
+
.enum(['unit'])
|
|
1242
|
+
.describe('The type of the price.'),
|
|
1243
|
+
})
|
|
1244
|
+
.describe('Unit price.')
|
|
1245
|
+
.nullable()
|
|
1246
|
+
.describe('The unit price component of the tier.'),
|
|
1247
|
+
upToAmount: zod.coerce
|
|
1225
1248
|
.string()
|
|
1226
|
-
.regex(exports.
|
|
1249
|
+
.regex(exports.updateAddonBodyRateCardsItemTwoPriceOneThreeTiersItemUpToAmountOneRegExp)
|
|
1227
1250
|
.describe('Numeric represents an arbitrary precision number.')
|
|
1228
|
-
.
|
|
1229
|
-
|
|
1230
|
-
.enum(['unit'])
|
|
1231
|
-
.describe('The type of the price.'),
|
|
1251
|
+
.optional()
|
|
1252
|
+
.describe('Up to and including to this quantity will be contained in the tier.\nIf null, the tier is open-ended.'),
|
|
1232
1253
|
})
|
|
1233
|
-
.describe('
|
|
1234
|
-
.
|
|
1235
|
-
.describe('The
|
|
1236
|
-
|
|
1254
|
+
.describe('A price tier.\nAt least one price component is required in each tier.'))
|
|
1255
|
+
.min(1)
|
|
1256
|
+
.describe('The tiers of the tiered price.\nAt least one price component is required in each tier.'),
|
|
1257
|
+
type: zod
|
|
1258
|
+
.enum(['tiered'])
|
|
1259
|
+
.describe('The type of the price.\n\nOne of: flat, unit, or tiered.'),
|
|
1260
|
+
})
|
|
1261
|
+
.describe('Tiered price with spend commitments.'),
|
|
1262
|
+
zod
|
|
1263
|
+
.object({
|
|
1264
|
+
maximumAmount: zod.coerce
|
|
1265
|
+
.string()
|
|
1266
|
+
.regex(exports.updateAddonBodyRateCardsItemTwoPriceOneFourMaximumAmountOneRegExp)
|
|
1267
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
1268
|
+
.optional()
|
|
1269
|
+
.describe('The customer is limited to spend at most the amount.'),
|
|
1270
|
+
minimumAmount: zod.coerce
|
|
1237
1271
|
.string()
|
|
1238
|
-
.regex(exports.
|
|
1272
|
+
.regex(exports.updateAddonBodyRateCardsItemTwoPriceOneFourMinimumAmountOneRegExp)
|
|
1239
1273
|
.describe('Numeric represents an arbitrary precision number.')
|
|
1240
1274
|
.optional()
|
|
1241
|
-
.describe('
|
|
1275
|
+
.describe('The customer is committed to spend at least the amount.'),
|
|
1276
|
+
multiplier: zod.coerce
|
|
1277
|
+
.string()
|
|
1278
|
+
.regex(exports.updateAddonBodyRateCardsItemTwoPriceOneFourMultiplierOneRegExp)
|
|
1279
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
1280
|
+
.default(exports.updateAddonBodyRateCardsItemTwoPriceOneFourMultiplierDefault)
|
|
1281
|
+
.describe('The multiplier to apply to the base price to get the dynamic price.\n\nExamples:\n- 0.0: the price is zero\n- 0.5: the price is 50% of the base price\n- 1.0: the price is the same as the base price\n- 1.5: the price is 150% of the base price'),
|
|
1282
|
+
type: zod
|
|
1283
|
+
.enum(['dynamic'])
|
|
1284
|
+
.describe('The type of the price.'),
|
|
1242
1285
|
})
|
|
1243
|
-
.describe('
|
|
1244
|
-
|
|
1245
|
-
.
|
|
1246
|
-
|
|
1247
|
-
|
|
1248
|
-
|
|
1249
|
-
|
|
1250
|
-
|
|
1251
|
-
|
|
1252
|
-
|
|
1253
|
-
|
|
1254
|
-
|
|
1255
|
-
|
|
1256
|
-
|
|
1257
|
-
.
|
|
1258
|
-
|
|
1259
|
-
|
|
1260
|
-
|
|
1261
|
-
|
|
1262
|
-
|
|
1263
|
-
.
|
|
1264
|
-
|
|
1265
|
-
|
|
1266
|
-
|
|
1267
|
-
|
|
1268
|
-
|
|
1269
|
-
|
|
1270
|
-
|
|
1271
|
-
|
|
1272
|
-
.
|
|
1273
|
-
|
|
1274
|
-
|
|
1275
|
-
|
|
1276
|
-
zod
|
|
1277
|
-
.object({
|
|
1278
|
-
amount: zod.coerce
|
|
1279
|
-
.string()
|
|
1280
|
-
.regex(exports.updateAddonBodyRateCardsItemTwoPriceOneFiveAmountOneRegExp)
|
|
1281
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
1282
|
-
.describe('The price of one package.'),
|
|
1283
|
-
maximumAmount: zod.coerce
|
|
1284
|
-
.string()
|
|
1285
|
-
.regex(exports.updateAddonBodyRateCardsItemTwoPriceOneFiveMaximumAmountOneRegExp)
|
|
1286
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
1287
|
-
.optional()
|
|
1288
|
-
.describe('The customer is limited to spend at most the amount.'),
|
|
1289
|
-
minimumAmount: zod.coerce
|
|
1290
|
-
.string()
|
|
1291
|
-
.regex(exports.updateAddonBodyRateCardsItemTwoPriceOneFiveMinimumAmountOneRegExp)
|
|
1292
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
1293
|
-
.optional()
|
|
1294
|
-
.describe('The customer is committed to spend at least the amount.'),
|
|
1295
|
-
quantityPerPackage: zod.coerce
|
|
1296
|
-
.string()
|
|
1297
|
-
.regex(exports.updateAddonBodyRateCardsItemTwoPriceOneFiveQuantityPerPackageOneRegExp)
|
|
1298
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
1299
|
-
.describe('The quantity per package.'),
|
|
1300
|
-
type: zod
|
|
1301
|
-
.enum(['package'])
|
|
1302
|
-
.describe('The type of the price.'),
|
|
1303
|
-
})
|
|
1304
|
-
.describe('Package price with spend commitments.'),
|
|
1286
|
+
.describe('Dynamic price with spend commitments.'),
|
|
1287
|
+
zod
|
|
1288
|
+
.object({
|
|
1289
|
+
amount: zod.coerce
|
|
1290
|
+
.string()
|
|
1291
|
+
.regex(exports.updateAddonBodyRateCardsItemTwoPriceOneFiveAmountOneRegExp)
|
|
1292
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
1293
|
+
.describe('The price of one package.'),
|
|
1294
|
+
maximumAmount: zod.coerce
|
|
1295
|
+
.string()
|
|
1296
|
+
.regex(exports.updateAddonBodyRateCardsItemTwoPriceOneFiveMaximumAmountOneRegExp)
|
|
1297
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
1298
|
+
.optional()
|
|
1299
|
+
.describe('The customer is limited to spend at most the amount.'),
|
|
1300
|
+
minimumAmount: zod.coerce
|
|
1301
|
+
.string()
|
|
1302
|
+
.regex(exports.updateAddonBodyRateCardsItemTwoPriceOneFiveMinimumAmountOneRegExp)
|
|
1303
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
1304
|
+
.optional()
|
|
1305
|
+
.describe('The customer is committed to spend at least the amount.'),
|
|
1306
|
+
quantityPerPackage: zod.coerce
|
|
1307
|
+
.string()
|
|
1308
|
+
.regex(exports.updateAddonBodyRateCardsItemTwoPriceOneFiveQuantityPerPackageOneRegExp)
|
|
1309
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
1310
|
+
.describe('The quantity per package.'),
|
|
1311
|
+
type: zod
|
|
1312
|
+
.enum(['package'])
|
|
1313
|
+
.describe('The type of the price.'),
|
|
1314
|
+
})
|
|
1315
|
+
.describe('Package price with spend commitments.'),
|
|
1316
|
+
])
|
|
1317
|
+
.describe('The price of the usage based rate card.'),
|
|
1318
|
+
zod.null(),
|
|
1305
1319
|
])
|
|
1306
|
-
.describe('The price of the usage based rate card.')
|
|
1307
|
-
.nullable()
|
|
1308
1320
|
.describe('The price of the rate card.\nWhen null, the feature or service is free.'),
|
|
1309
1321
|
taxConfig: zod
|
|
1310
1322
|
.object({
|
|
@@ -1407,11 +1419,13 @@ exports.listAppsQueryPageSizeMax = 1000;
|
|
|
1407
1419
|
exports.ListAppsQueryParams = zod.object({
|
|
1408
1420
|
page: zod.coerce
|
|
1409
1421
|
.number()
|
|
1422
|
+
.int()
|
|
1410
1423
|
.min(1)
|
|
1411
1424
|
.default(exports.listAppsQueryPageDefault)
|
|
1412
1425
|
.describe('Page index.\n\nDefault is 1.'),
|
|
1413
1426
|
pageSize: zod.coerce
|
|
1414
1427
|
.number()
|
|
1428
|
+
.int()
|
|
1415
1429
|
.min(1)
|
|
1416
1430
|
.max(exports.listAppsQueryPageSizeMax)
|
|
1417
1431
|
.default(exports.listAppsQueryPageSizeDefault)
|
|
@@ -1675,7 +1689,7 @@ exports.AppStripeWebhookParams = zod.object({
|
|
|
1675
1689
|
});
|
|
1676
1690
|
exports.AppStripeWebhookBody = zod
|
|
1677
1691
|
.object({
|
|
1678
|
-
created: zod.coerce.number().describe('The event created timestamp.'),
|
|
1692
|
+
created: zod.coerce.number().int().describe('The event created timestamp.'),
|
|
1679
1693
|
data: zod
|
|
1680
1694
|
.object({
|
|
1681
1695
|
object: zod.unknown(),
|
|
@@ -1761,11 +1775,13 @@ exports.ListBillingProfileCustomerOverridesQueryParams = zod.object({
|
|
|
1761
1775
|
.describe('The order by field.'),
|
|
1762
1776
|
page: zod.coerce
|
|
1763
1777
|
.number()
|
|
1778
|
+
.int()
|
|
1764
1779
|
.min(1)
|
|
1765
1780
|
.default(exports.listBillingProfileCustomerOverridesQueryPageDefault)
|
|
1766
1781
|
.describe('Page index.\n\nDefault is 1.'),
|
|
1767
1782
|
pageSize: zod.coerce
|
|
1768
1783
|
.number()
|
|
1784
|
+
.int()
|
|
1769
1785
|
.min(1)
|
|
1770
1786
|
.max(exports.listBillingProfileCustomerOverridesQueryPageSizeMax)
|
|
1771
1787
|
.default(exports.listBillingProfileCustomerOverridesQueryPageSizeDefault)
|
|
@@ -2153,167 +2169,170 @@ exports.CreatePendingInvoiceLineBody = zod
|
|
|
2153
2169
|
price: zod
|
|
2154
2170
|
.union([
|
|
2155
2171
|
zod
|
|
2156
|
-
.
|
|
2157
|
-
|
|
2158
|
-
.string()
|
|
2159
|
-
.regex(exports.createPendingInvoiceLineBodyLinesItemRateCardOnePriceOneOneAmountOneRegExp)
|
|
2160
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
2161
|
-
.describe('The amount of the flat price.'),
|
|
2162
|
-
paymentTerm: zod
|
|
2163
|
-
.enum(['in_advance', 'in_arrears'])
|
|
2164
|
-
.describe('The payment term of a flat price.\nOne of: in_advance or in_arrears.')
|
|
2165
|
-
.default(exports.createPendingInvoiceLineBodyLinesItemRateCardOnePriceOneOnePaymentTermDefault)
|
|
2166
|
-
.describe('The payment term of the flat price.\nDefaults to in advance.'),
|
|
2167
|
-
type: zod
|
|
2168
|
-
.enum(['flat'])
|
|
2169
|
-
.describe('The type of the price.'),
|
|
2170
|
-
})
|
|
2171
|
-
.describe('Flat price with payment term.'),
|
|
2172
|
-
zod
|
|
2173
|
-
.object({
|
|
2174
|
-
amount: zod.coerce
|
|
2175
|
-
.string()
|
|
2176
|
-
.regex(exports.createPendingInvoiceLineBodyLinesItemRateCardOnePriceOneTwoAmountOneRegExp)
|
|
2177
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
2178
|
-
.describe('The amount of the unit price.'),
|
|
2179
|
-
maximumAmount: zod.coerce
|
|
2180
|
-
.string()
|
|
2181
|
-
.regex(exports.createPendingInvoiceLineBodyLinesItemRateCardOnePriceOneTwoMaximumAmountOneRegExp)
|
|
2182
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
2183
|
-
.optional()
|
|
2184
|
-
.describe('The customer is limited to spend at most the amount.'),
|
|
2185
|
-
minimumAmount: zod.coerce
|
|
2186
|
-
.string()
|
|
2187
|
-
.regex(exports.createPendingInvoiceLineBodyLinesItemRateCardOnePriceOneTwoMinimumAmountOneRegExp)
|
|
2188
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
2189
|
-
.optional()
|
|
2190
|
-
.describe('The customer is committed to spend at least the amount.'),
|
|
2191
|
-
type: zod
|
|
2192
|
-
.enum(['unit'])
|
|
2193
|
-
.describe('The type of the price.'),
|
|
2194
|
-
})
|
|
2195
|
-
.describe('Unit price with spend commitments.'),
|
|
2196
|
-
zod
|
|
2197
|
-
.object({
|
|
2198
|
-
maximumAmount: zod.coerce
|
|
2199
|
-
.string()
|
|
2200
|
-
.regex(exports.createPendingInvoiceLineBodyLinesItemRateCardOnePriceOneThreeMaximumAmountOneRegExp)
|
|
2201
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
2202
|
-
.optional()
|
|
2203
|
-
.describe('The customer is limited to spend at most the amount.'),
|
|
2204
|
-
minimumAmount: zod.coerce
|
|
2205
|
-
.string()
|
|
2206
|
-
.regex(exports.createPendingInvoiceLineBodyLinesItemRateCardOnePriceOneThreeMinimumAmountOneRegExp)
|
|
2207
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
2208
|
-
.optional()
|
|
2209
|
-
.describe('The customer is committed to spend at least the amount.'),
|
|
2210
|
-
mode: zod
|
|
2211
|
-
.enum(['volume', 'graduated'])
|
|
2212
|
-
.describe('The mode of the tiered price.')
|
|
2213
|
-
.describe('Defines if the tiering mode is volume-based or graduated:\n- In `volume`-based tiering, the maximum quantity within a period determines the per unit price.\n- In `graduated` tiering, pricing can change as the quantity grows.'),
|
|
2214
|
-
tiers: zod
|
|
2215
|
-
.array(zod
|
|
2172
|
+
.union([
|
|
2173
|
+
zod
|
|
2216
2174
|
.object({
|
|
2217
|
-
|
|
2218
|
-
.
|
|
2219
|
-
|
|
2220
|
-
|
|
2221
|
-
|
|
2222
|
-
|
|
2223
|
-
|
|
2224
|
-
|
|
2225
|
-
|
|
2226
|
-
|
|
2227
|
-
|
|
2228
|
-
.
|
|
2229
|
-
.
|
|
2230
|
-
|
|
2231
|
-
|
|
2175
|
+
amount: zod.coerce
|
|
2176
|
+
.string()
|
|
2177
|
+
.regex(exports.createPendingInvoiceLineBodyLinesItemRateCardOnePriceOneOneAmountOneRegExp)
|
|
2178
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
2179
|
+
.describe('The amount of the flat price.'),
|
|
2180
|
+
paymentTerm: zod
|
|
2181
|
+
.enum(['in_advance', 'in_arrears'])
|
|
2182
|
+
.describe('The payment term of a flat price.\nOne of: in_advance or in_arrears.')
|
|
2183
|
+
.default(exports.createPendingInvoiceLineBodyLinesItemRateCardOnePriceOneOnePaymentTermDefault)
|
|
2184
|
+
.describe('The payment term of the flat price.\nDefaults to in advance.'),
|
|
2185
|
+
type: zod
|
|
2186
|
+
.enum(['flat'])
|
|
2187
|
+
.describe('The type of the price.'),
|
|
2188
|
+
})
|
|
2189
|
+
.describe('Flat price with payment term.'),
|
|
2190
|
+
zod
|
|
2191
|
+
.object({
|
|
2192
|
+
amount: zod.coerce
|
|
2193
|
+
.string()
|
|
2194
|
+
.regex(exports.createPendingInvoiceLineBodyLinesItemRateCardOnePriceOneTwoAmountOneRegExp)
|
|
2195
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
2196
|
+
.describe('The amount of the unit price.'),
|
|
2197
|
+
maximumAmount: zod.coerce
|
|
2198
|
+
.string()
|
|
2199
|
+
.regex(exports.createPendingInvoiceLineBodyLinesItemRateCardOnePriceOneTwoMaximumAmountOneRegExp)
|
|
2200
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
2201
|
+
.optional()
|
|
2202
|
+
.describe('The customer is limited to spend at most the amount.'),
|
|
2203
|
+
minimumAmount: zod.coerce
|
|
2204
|
+
.string()
|
|
2205
|
+
.regex(exports.createPendingInvoiceLineBodyLinesItemRateCardOnePriceOneTwoMinimumAmountOneRegExp)
|
|
2206
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
2207
|
+
.optional()
|
|
2208
|
+
.describe('The customer is committed to spend at least the amount.'),
|
|
2209
|
+
type: zod
|
|
2210
|
+
.enum(['unit'])
|
|
2211
|
+
.describe('The type of the price.'),
|
|
2212
|
+
})
|
|
2213
|
+
.describe('Unit price with spend commitments.'),
|
|
2214
|
+
zod
|
|
2215
|
+
.object({
|
|
2216
|
+
maximumAmount: zod.coerce
|
|
2217
|
+
.string()
|
|
2218
|
+
.regex(exports.createPendingInvoiceLineBodyLinesItemRateCardOnePriceOneThreeMaximumAmountOneRegExp)
|
|
2219
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
2220
|
+
.optional()
|
|
2221
|
+
.describe('The customer is limited to spend at most the amount.'),
|
|
2222
|
+
minimumAmount: zod.coerce
|
|
2223
|
+
.string()
|
|
2224
|
+
.regex(exports.createPendingInvoiceLineBodyLinesItemRateCardOnePriceOneThreeMinimumAmountOneRegExp)
|
|
2225
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
2226
|
+
.optional()
|
|
2227
|
+
.describe('The customer is committed to spend at least the amount.'),
|
|
2228
|
+
mode: zod
|
|
2229
|
+
.enum(['volume', 'graduated'])
|
|
2230
|
+
.describe('The mode of the tiered price.')
|
|
2231
|
+
.describe('Defines if the tiering mode is volume-based or graduated:\n- In `volume`-based tiering, the maximum quantity within a period determines the per unit price.\n- In `graduated` tiering, pricing can change as the quantity grows.'),
|
|
2232
|
+
tiers: zod
|
|
2233
|
+
.array(zod
|
|
2232
2234
|
.object({
|
|
2233
|
-
|
|
2235
|
+
flatPrice: zod
|
|
2236
|
+
.object({
|
|
2237
|
+
amount: zod.coerce
|
|
2238
|
+
.string()
|
|
2239
|
+
.regex(exports.createPendingInvoiceLineBodyLinesItemRateCardOnePriceOneThreeTiersItemFlatPriceOneAmountOneRegExp)
|
|
2240
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
2241
|
+
.describe('The amount of the flat price.'),
|
|
2242
|
+
type: zod
|
|
2243
|
+
.enum(['flat'])
|
|
2244
|
+
.describe('The type of the price.'),
|
|
2245
|
+
})
|
|
2246
|
+
.describe('Flat price.')
|
|
2247
|
+
.nullable()
|
|
2248
|
+
.describe('The flat price component of the tier.'),
|
|
2249
|
+
unitPrice: zod
|
|
2250
|
+
.object({
|
|
2251
|
+
amount: zod.coerce
|
|
2252
|
+
.string()
|
|
2253
|
+
.regex(exports.createPendingInvoiceLineBodyLinesItemRateCardOnePriceOneThreeTiersItemUnitPriceOneAmountOneRegExp)
|
|
2254
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
2255
|
+
.describe('The amount of the unit price.'),
|
|
2256
|
+
type: zod
|
|
2257
|
+
.enum(['unit'])
|
|
2258
|
+
.describe('The type of the price.'),
|
|
2259
|
+
})
|
|
2260
|
+
.describe('Unit price.')
|
|
2261
|
+
.nullable()
|
|
2262
|
+
.describe('The unit price component of the tier.'),
|
|
2263
|
+
upToAmount: zod.coerce
|
|
2234
2264
|
.string()
|
|
2235
|
-
.regex(exports.
|
|
2265
|
+
.regex(exports.createPendingInvoiceLineBodyLinesItemRateCardOnePriceOneThreeTiersItemUpToAmountOneRegExp)
|
|
2236
2266
|
.describe('Numeric represents an arbitrary precision number.')
|
|
2237
|
-
.
|
|
2238
|
-
|
|
2239
|
-
.enum(['unit'])
|
|
2240
|
-
.describe('The type of the price.'),
|
|
2267
|
+
.optional()
|
|
2268
|
+
.describe('Up to and including to this quantity will be contained in the tier.\nIf null, the tier is open-ended.'),
|
|
2241
2269
|
})
|
|
2242
|
-
.describe('
|
|
2243
|
-
.
|
|
2244
|
-
.describe('The
|
|
2245
|
-
|
|
2270
|
+
.describe('A price tier.\nAt least one price component is required in each tier.'))
|
|
2271
|
+
.min(1)
|
|
2272
|
+
.describe('The tiers of the tiered price.\nAt least one price component is required in each tier.'),
|
|
2273
|
+
type: zod
|
|
2274
|
+
.enum(['tiered'])
|
|
2275
|
+
.describe('The type of the price.\n\nOne of: flat, unit, or tiered.'),
|
|
2276
|
+
})
|
|
2277
|
+
.describe('Tiered price with spend commitments.'),
|
|
2278
|
+
zod
|
|
2279
|
+
.object({
|
|
2280
|
+
maximumAmount: zod.coerce
|
|
2246
2281
|
.string()
|
|
2247
|
-
.regex(exports.
|
|
2282
|
+
.regex(exports.createPendingInvoiceLineBodyLinesItemRateCardOnePriceOneFourMaximumAmountOneRegExp)
|
|
2248
2283
|
.describe('Numeric represents an arbitrary precision number.')
|
|
2249
2284
|
.optional()
|
|
2250
|
-
.describe('
|
|
2285
|
+
.describe('The customer is limited to spend at most the amount.'),
|
|
2286
|
+
minimumAmount: zod.coerce
|
|
2287
|
+
.string()
|
|
2288
|
+
.regex(exports.createPendingInvoiceLineBodyLinesItemRateCardOnePriceOneFourMinimumAmountOneRegExp)
|
|
2289
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
2290
|
+
.optional()
|
|
2291
|
+
.describe('The customer is committed to spend at least the amount.'),
|
|
2292
|
+
multiplier: zod.coerce
|
|
2293
|
+
.string()
|
|
2294
|
+
.regex(exports.createPendingInvoiceLineBodyLinesItemRateCardOnePriceOneFourMultiplierOneRegExp)
|
|
2295
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
2296
|
+
.default(exports.createPendingInvoiceLineBodyLinesItemRateCardOnePriceOneFourMultiplierDefault)
|
|
2297
|
+
.describe('The multiplier to apply to the base price to get the dynamic price.\n\nExamples:\n- 0.0: the price is zero\n- 0.5: the price is 50% of the base price\n- 1.0: the price is the same as the base price\n- 1.5: the price is 150% of the base price'),
|
|
2298
|
+
type: zod
|
|
2299
|
+
.enum(['dynamic'])
|
|
2300
|
+
.describe('The type of the price.'),
|
|
2251
2301
|
})
|
|
2252
|
-
.describe('
|
|
2253
|
-
|
|
2254
|
-
.
|
|
2255
|
-
|
|
2256
|
-
|
|
2257
|
-
|
|
2258
|
-
|
|
2259
|
-
|
|
2260
|
-
|
|
2261
|
-
|
|
2262
|
-
|
|
2263
|
-
|
|
2264
|
-
|
|
2265
|
-
|
|
2266
|
-
.
|
|
2267
|
-
|
|
2268
|
-
|
|
2269
|
-
|
|
2270
|
-
|
|
2271
|
-
|
|
2272
|
-
.
|
|
2273
|
-
|
|
2274
|
-
|
|
2275
|
-
|
|
2276
|
-
|
|
2277
|
-
|
|
2278
|
-
|
|
2279
|
-
|
|
2280
|
-
|
|
2281
|
-
.
|
|
2282
|
-
|
|
2283
|
-
|
|
2284
|
-
|
|
2285
|
-
zod
|
|
2286
|
-
.object({
|
|
2287
|
-
amount: zod.coerce
|
|
2288
|
-
.string()
|
|
2289
|
-
.regex(exports.createPendingInvoiceLineBodyLinesItemRateCardOnePriceOneFiveAmountOneRegExp)
|
|
2290
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
2291
|
-
.describe('The price of one package.'),
|
|
2292
|
-
maximumAmount: zod.coerce
|
|
2293
|
-
.string()
|
|
2294
|
-
.regex(exports.createPendingInvoiceLineBodyLinesItemRateCardOnePriceOneFiveMaximumAmountOneRegExp)
|
|
2295
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
2296
|
-
.optional()
|
|
2297
|
-
.describe('The customer is limited to spend at most the amount.'),
|
|
2298
|
-
minimumAmount: zod.coerce
|
|
2299
|
-
.string()
|
|
2300
|
-
.regex(exports.createPendingInvoiceLineBodyLinesItemRateCardOnePriceOneFiveMinimumAmountOneRegExp)
|
|
2301
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
2302
|
-
.optional()
|
|
2303
|
-
.describe('The customer is committed to spend at least the amount.'),
|
|
2304
|
-
quantityPerPackage: zod.coerce
|
|
2305
|
-
.string()
|
|
2306
|
-
.regex(exports.createPendingInvoiceLineBodyLinesItemRateCardOnePriceOneFiveQuantityPerPackageOneRegExp)
|
|
2307
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
2308
|
-
.describe('The quantity per package.'),
|
|
2309
|
-
type: zod
|
|
2310
|
-
.enum(['package'])
|
|
2311
|
-
.describe('The type of the price.'),
|
|
2312
|
-
})
|
|
2313
|
-
.describe('Package price with spend commitments.'),
|
|
2302
|
+
.describe('Dynamic price with spend commitments.'),
|
|
2303
|
+
zod
|
|
2304
|
+
.object({
|
|
2305
|
+
amount: zod.coerce
|
|
2306
|
+
.string()
|
|
2307
|
+
.regex(exports.createPendingInvoiceLineBodyLinesItemRateCardOnePriceOneFiveAmountOneRegExp)
|
|
2308
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
2309
|
+
.describe('The price of one package.'),
|
|
2310
|
+
maximumAmount: zod.coerce
|
|
2311
|
+
.string()
|
|
2312
|
+
.regex(exports.createPendingInvoiceLineBodyLinesItemRateCardOnePriceOneFiveMaximumAmountOneRegExp)
|
|
2313
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
2314
|
+
.optional()
|
|
2315
|
+
.describe('The customer is limited to spend at most the amount.'),
|
|
2316
|
+
minimumAmount: zod.coerce
|
|
2317
|
+
.string()
|
|
2318
|
+
.regex(exports.createPendingInvoiceLineBodyLinesItemRateCardOnePriceOneFiveMinimumAmountOneRegExp)
|
|
2319
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
2320
|
+
.optional()
|
|
2321
|
+
.describe('The customer is committed to spend at least the amount.'),
|
|
2322
|
+
quantityPerPackage: zod.coerce
|
|
2323
|
+
.string()
|
|
2324
|
+
.regex(exports.createPendingInvoiceLineBodyLinesItemRateCardOnePriceOneFiveQuantityPerPackageOneRegExp)
|
|
2325
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
2326
|
+
.describe('The quantity per package.'),
|
|
2327
|
+
type: zod
|
|
2328
|
+
.enum(['package'])
|
|
2329
|
+
.describe('The type of the price.'),
|
|
2330
|
+
})
|
|
2331
|
+
.describe('Package price with spend commitments.'),
|
|
2332
|
+
])
|
|
2333
|
+
.describe('The price of the usage based rate card.'),
|
|
2334
|
+
zod.null(),
|
|
2314
2335
|
])
|
|
2315
|
-
.describe('The price of the usage based rate card.')
|
|
2316
|
-
.nullable()
|
|
2317
2336
|
.describe('The price of the rate card.\nWhen null, the feature or service is free.'),
|
|
2318
2337
|
taxConfig: zod
|
|
2319
2338
|
.object({
|
|
@@ -2733,167 +2752,170 @@ exports.SimulateInvoiceBody = zod
|
|
|
2733
2752
|
price: zod
|
|
2734
2753
|
.union([
|
|
2735
2754
|
zod
|
|
2736
|
-
.
|
|
2737
|
-
|
|
2738
|
-
.string()
|
|
2739
|
-
.regex(exports.simulateInvoiceBodyLinesItemRateCardOnePriceOneOneAmountOneRegExp)
|
|
2740
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
2741
|
-
.describe('The amount of the flat price.'),
|
|
2742
|
-
paymentTerm: zod
|
|
2743
|
-
.enum(['in_advance', 'in_arrears'])
|
|
2744
|
-
.describe('The payment term of a flat price.\nOne of: in_advance or in_arrears.')
|
|
2745
|
-
.default(exports.simulateInvoiceBodyLinesItemRateCardOnePriceOneOnePaymentTermDefault)
|
|
2746
|
-
.describe('The payment term of the flat price.\nDefaults to in advance.'),
|
|
2747
|
-
type: zod
|
|
2748
|
-
.enum(['flat'])
|
|
2749
|
-
.describe('The type of the price.'),
|
|
2750
|
-
})
|
|
2751
|
-
.describe('Flat price with payment term.'),
|
|
2752
|
-
zod
|
|
2753
|
-
.object({
|
|
2754
|
-
amount: zod.coerce
|
|
2755
|
-
.string()
|
|
2756
|
-
.regex(exports.simulateInvoiceBodyLinesItemRateCardOnePriceOneTwoAmountOneRegExp)
|
|
2757
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
2758
|
-
.describe('The amount of the unit price.'),
|
|
2759
|
-
maximumAmount: zod.coerce
|
|
2760
|
-
.string()
|
|
2761
|
-
.regex(exports.simulateInvoiceBodyLinesItemRateCardOnePriceOneTwoMaximumAmountOneRegExp)
|
|
2762
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
2763
|
-
.optional()
|
|
2764
|
-
.describe('The customer is limited to spend at most the amount.'),
|
|
2765
|
-
minimumAmount: zod.coerce
|
|
2766
|
-
.string()
|
|
2767
|
-
.regex(exports.simulateInvoiceBodyLinesItemRateCardOnePriceOneTwoMinimumAmountOneRegExp)
|
|
2768
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
2769
|
-
.optional()
|
|
2770
|
-
.describe('The customer is committed to spend at least the amount.'),
|
|
2771
|
-
type: zod
|
|
2772
|
-
.enum(['unit'])
|
|
2773
|
-
.describe('The type of the price.'),
|
|
2774
|
-
})
|
|
2775
|
-
.describe('Unit price with spend commitments.'),
|
|
2776
|
-
zod
|
|
2777
|
-
.object({
|
|
2778
|
-
maximumAmount: zod.coerce
|
|
2779
|
-
.string()
|
|
2780
|
-
.regex(exports.simulateInvoiceBodyLinesItemRateCardOnePriceOneThreeMaximumAmountOneRegExp)
|
|
2781
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
2782
|
-
.optional()
|
|
2783
|
-
.describe('The customer is limited to spend at most the amount.'),
|
|
2784
|
-
minimumAmount: zod.coerce
|
|
2785
|
-
.string()
|
|
2786
|
-
.regex(exports.simulateInvoiceBodyLinesItemRateCardOnePriceOneThreeMinimumAmountOneRegExp)
|
|
2787
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
2788
|
-
.optional()
|
|
2789
|
-
.describe('The customer is committed to spend at least the amount.'),
|
|
2790
|
-
mode: zod
|
|
2791
|
-
.enum(['volume', 'graduated'])
|
|
2792
|
-
.describe('The mode of the tiered price.')
|
|
2793
|
-
.describe('Defines if the tiering mode is volume-based or graduated:\n- In `volume`-based tiering, the maximum quantity within a period determines the per unit price.\n- In `graduated` tiering, pricing can change as the quantity grows.'),
|
|
2794
|
-
tiers: zod
|
|
2795
|
-
.array(zod
|
|
2755
|
+
.union([
|
|
2756
|
+
zod
|
|
2796
2757
|
.object({
|
|
2797
|
-
|
|
2798
|
-
.
|
|
2799
|
-
|
|
2800
|
-
|
|
2801
|
-
|
|
2802
|
-
|
|
2803
|
-
|
|
2804
|
-
|
|
2805
|
-
|
|
2806
|
-
|
|
2807
|
-
|
|
2808
|
-
.
|
|
2809
|
-
.
|
|
2810
|
-
|
|
2811
|
-
|
|
2758
|
+
amount: zod.coerce
|
|
2759
|
+
.string()
|
|
2760
|
+
.regex(exports.simulateInvoiceBodyLinesItemRateCardOnePriceOneOneAmountOneRegExp)
|
|
2761
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
2762
|
+
.describe('The amount of the flat price.'),
|
|
2763
|
+
paymentTerm: zod
|
|
2764
|
+
.enum(['in_advance', 'in_arrears'])
|
|
2765
|
+
.describe('The payment term of a flat price.\nOne of: in_advance or in_arrears.')
|
|
2766
|
+
.default(exports.simulateInvoiceBodyLinesItemRateCardOnePriceOneOnePaymentTermDefault)
|
|
2767
|
+
.describe('The payment term of the flat price.\nDefaults to in advance.'),
|
|
2768
|
+
type: zod
|
|
2769
|
+
.enum(['flat'])
|
|
2770
|
+
.describe('The type of the price.'),
|
|
2771
|
+
})
|
|
2772
|
+
.describe('Flat price with payment term.'),
|
|
2773
|
+
zod
|
|
2774
|
+
.object({
|
|
2775
|
+
amount: zod.coerce
|
|
2776
|
+
.string()
|
|
2777
|
+
.regex(exports.simulateInvoiceBodyLinesItemRateCardOnePriceOneTwoAmountOneRegExp)
|
|
2778
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
2779
|
+
.describe('The amount of the unit price.'),
|
|
2780
|
+
maximumAmount: zod.coerce
|
|
2781
|
+
.string()
|
|
2782
|
+
.regex(exports.simulateInvoiceBodyLinesItemRateCardOnePriceOneTwoMaximumAmountOneRegExp)
|
|
2783
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
2784
|
+
.optional()
|
|
2785
|
+
.describe('The customer is limited to spend at most the amount.'),
|
|
2786
|
+
minimumAmount: zod.coerce
|
|
2787
|
+
.string()
|
|
2788
|
+
.regex(exports.simulateInvoiceBodyLinesItemRateCardOnePriceOneTwoMinimumAmountOneRegExp)
|
|
2789
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
2790
|
+
.optional()
|
|
2791
|
+
.describe('The customer is committed to spend at least the amount.'),
|
|
2792
|
+
type: zod
|
|
2793
|
+
.enum(['unit'])
|
|
2794
|
+
.describe('The type of the price.'),
|
|
2795
|
+
})
|
|
2796
|
+
.describe('Unit price with spend commitments.'),
|
|
2797
|
+
zod
|
|
2798
|
+
.object({
|
|
2799
|
+
maximumAmount: zod.coerce
|
|
2800
|
+
.string()
|
|
2801
|
+
.regex(exports.simulateInvoiceBodyLinesItemRateCardOnePriceOneThreeMaximumAmountOneRegExp)
|
|
2802
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
2803
|
+
.optional()
|
|
2804
|
+
.describe('The customer is limited to spend at most the amount.'),
|
|
2805
|
+
minimumAmount: zod.coerce
|
|
2806
|
+
.string()
|
|
2807
|
+
.regex(exports.simulateInvoiceBodyLinesItemRateCardOnePriceOneThreeMinimumAmountOneRegExp)
|
|
2808
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
2809
|
+
.optional()
|
|
2810
|
+
.describe('The customer is committed to spend at least the amount.'),
|
|
2811
|
+
mode: zod
|
|
2812
|
+
.enum(['volume', 'graduated'])
|
|
2813
|
+
.describe('The mode of the tiered price.')
|
|
2814
|
+
.describe('Defines if the tiering mode is volume-based or graduated:\n- In `volume`-based tiering, the maximum quantity within a period determines the per unit price.\n- In `graduated` tiering, pricing can change as the quantity grows.'),
|
|
2815
|
+
tiers: zod
|
|
2816
|
+
.array(zod
|
|
2812
2817
|
.object({
|
|
2813
|
-
|
|
2818
|
+
flatPrice: zod
|
|
2819
|
+
.object({
|
|
2820
|
+
amount: zod.coerce
|
|
2821
|
+
.string()
|
|
2822
|
+
.regex(exports.simulateInvoiceBodyLinesItemRateCardOnePriceOneThreeTiersItemFlatPriceOneAmountOneRegExp)
|
|
2823
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
2824
|
+
.describe('The amount of the flat price.'),
|
|
2825
|
+
type: zod
|
|
2826
|
+
.enum(['flat'])
|
|
2827
|
+
.describe('The type of the price.'),
|
|
2828
|
+
})
|
|
2829
|
+
.describe('Flat price.')
|
|
2830
|
+
.nullable()
|
|
2831
|
+
.describe('The flat price component of the tier.'),
|
|
2832
|
+
unitPrice: zod
|
|
2833
|
+
.object({
|
|
2834
|
+
amount: zod.coerce
|
|
2835
|
+
.string()
|
|
2836
|
+
.regex(exports.simulateInvoiceBodyLinesItemRateCardOnePriceOneThreeTiersItemUnitPriceOneAmountOneRegExp)
|
|
2837
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
2838
|
+
.describe('The amount of the unit price.'),
|
|
2839
|
+
type: zod
|
|
2840
|
+
.enum(['unit'])
|
|
2841
|
+
.describe('The type of the price.'),
|
|
2842
|
+
})
|
|
2843
|
+
.describe('Unit price.')
|
|
2844
|
+
.nullable()
|
|
2845
|
+
.describe('The unit price component of the tier.'),
|
|
2846
|
+
upToAmount: zod.coerce
|
|
2814
2847
|
.string()
|
|
2815
|
-
.regex(exports.
|
|
2848
|
+
.regex(exports.simulateInvoiceBodyLinesItemRateCardOnePriceOneThreeTiersItemUpToAmountOneRegExp)
|
|
2816
2849
|
.describe('Numeric represents an arbitrary precision number.')
|
|
2817
|
-
.
|
|
2818
|
-
|
|
2819
|
-
.enum(['unit'])
|
|
2820
|
-
.describe('The type of the price.'),
|
|
2850
|
+
.optional()
|
|
2851
|
+
.describe('Up to and including to this quantity will be contained in the tier.\nIf null, the tier is open-ended.'),
|
|
2821
2852
|
})
|
|
2822
|
-
.describe('
|
|
2823
|
-
.
|
|
2824
|
-
.describe('The
|
|
2825
|
-
|
|
2853
|
+
.describe('A price tier.\nAt least one price component is required in each tier.'))
|
|
2854
|
+
.min(1)
|
|
2855
|
+
.describe('The tiers of the tiered price.\nAt least one price component is required in each tier.'),
|
|
2856
|
+
type: zod
|
|
2857
|
+
.enum(['tiered'])
|
|
2858
|
+
.describe('The type of the price.\n\nOne of: flat, unit, or tiered.'),
|
|
2859
|
+
})
|
|
2860
|
+
.describe('Tiered price with spend commitments.'),
|
|
2861
|
+
zod
|
|
2862
|
+
.object({
|
|
2863
|
+
maximumAmount: zod.coerce
|
|
2864
|
+
.string()
|
|
2865
|
+
.regex(exports.simulateInvoiceBodyLinesItemRateCardOnePriceOneFourMaximumAmountOneRegExp)
|
|
2866
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
2867
|
+
.optional()
|
|
2868
|
+
.describe('The customer is limited to spend at most the amount.'),
|
|
2869
|
+
minimumAmount: zod.coerce
|
|
2826
2870
|
.string()
|
|
2827
|
-
.regex(exports.
|
|
2871
|
+
.regex(exports.simulateInvoiceBodyLinesItemRateCardOnePriceOneFourMinimumAmountOneRegExp)
|
|
2828
2872
|
.describe('Numeric represents an arbitrary precision number.')
|
|
2829
2873
|
.optional()
|
|
2830
|
-
.describe('
|
|
2874
|
+
.describe('The customer is committed to spend at least the amount.'),
|
|
2875
|
+
multiplier: zod.coerce
|
|
2876
|
+
.string()
|
|
2877
|
+
.regex(exports.simulateInvoiceBodyLinesItemRateCardOnePriceOneFourMultiplierOneRegExp)
|
|
2878
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
2879
|
+
.default(exports.simulateInvoiceBodyLinesItemRateCardOnePriceOneFourMultiplierDefault)
|
|
2880
|
+
.describe('The multiplier to apply to the base price to get the dynamic price.\n\nExamples:\n- 0.0: the price is zero\n- 0.5: the price is 50% of the base price\n- 1.0: the price is the same as the base price\n- 1.5: the price is 150% of the base price'),
|
|
2881
|
+
type: zod
|
|
2882
|
+
.enum(['dynamic'])
|
|
2883
|
+
.describe('The type of the price.'),
|
|
2831
2884
|
})
|
|
2832
|
-
.describe('
|
|
2833
|
-
|
|
2834
|
-
.
|
|
2835
|
-
|
|
2836
|
-
|
|
2837
|
-
|
|
2838
|
-
|
|
2839
|
-
|
|
2840
|
-
|
|
2841
|
-
|
|
2842
|
-
|
|
2843
|
-
|
|
2844
|
-
|
|
2845
|
-
|
|
2846
|
-
.
|
|
2847
|
-
|
|
2848
|
-
|
|
2849
|
-
|
|
2850
|
-
|
|
2851
|
-
|
|
2852
|
-
.
|
|
2853
|
-
|
|
2854
|
-
|
|
2855
|
-
|
|
2856
|
-
|
|
2857
|
-
|
|
2858
|
-
|
|
2859
|
-
|
|
2860
|
-
|
|
2861
|
-
.
|
|
2862
|
-
|
|
2863
|
-
|
|
2864
|
-
|
|
2865
|
-
zod
|
|
2866
|
-
.object({
|
|
2867
|
-
amount: zod.coerce
|
|
2868
|
-
.string()
|
|
2869
|
-
.regex(exports.simulateInvoiceBodyLinesItemRateCardOnePriceOneFiveAmountOneRegExp)
|
|
2870
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
2871
|
-
.describe('The price of one package.'),
|
|
2872
|
-
maximumAmount: zod.coerce
|
|
2873
|
-
.string()
|
|
2874
|
-
.regex(exports.simulateInvoiceBodyLinesItemRateCardOnePriceOneFiveMaximumAmountOneRegExp)
|
|
2875
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
2876
|
-
.optional()
|
|
2877
|
-
.describe('The customer is limited to spend at most the amount.'),
|
|
2878
|
-
minimumAmount: zod.coerce
|
|
2879
|
-
.string()
|
|
2880
|
-
.regex(exports.simulateInvoiceBodyLinesItemRateCardOnePriceOneFiveMinimumAmountOneRegExp)
|
|
2881
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
2882
|
-
.optional()
|
|
2883
|
-
.describe('The customer is committed to spend at least the amount.'),
|
|
2884
|
-
quantityPerPackage: zod.coerce
|
|
2885
|
-
.string()
|
|
2886
|
-
.regex(exports.simulateInvoiceBodyLinesItemRateCardOnePriceOneFiveQuantityPerPackageOneRegExp)
|
|
2887
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
2888
|
-
.describe('The quantity per package.'),
|
|
2889
|
-
type: zod
|
|
2890
|
-
.enum(['package'])
|
|
2891
|
-
.describe('The type of the price.'),
|
|
2892
|
-
})
|
|
2893
|
-
.describe('Package price with spend commitments.'),
|
|
2885
|
+
.describe('Dynamic price with spend commitments.'),
|
|
2886
|
+
zod
|
|
2887
|
+
.object({
|
|
2888
|
+
amount: zod.coerce
|
|
2889
|
+
.string()
|
|
2890
|
+
.regex(exports.simulateInvoiceBodyLinesItemRateCardOnePriceOneFiveAmountOneRegExp)
|
|
2891
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
2892
|
+
.describe('The price of one package.'),
|
|
2893
|
+
maximumAmount: zod.coerce
|
|
2894
|
+
.string()
|
|
2895
|
+
.regex(exports.simulateInvoiceBodyLinesItemRateCardOnePriceOneFiveMaximumAmountOneRegExp)
|
|
2896
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
2897
|
+
.optional()
|
|
2898
|
+
.describe('The customer is limited to spend at most the amount.'),
|
|
2899
|
+
minimumAmount: zod.coerce
|
|
2900
|
+
.string()
|
|
2901
|
+
.regex(exports.simulateInvoiceBodyLinesItemRateCardOnePriceOneFiveMinimumAmountOneRegExp)
|
|
2902
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
2903
|
+
.optional()
|
|
2904
|
+
.describe('The customer is committed to spend at least the amount.'),
|
|
2905
|
+
quantityPerPackage: zod.coerce
|
|
2906
|
+
.string()
|
|
2907
|
+
.regex(exports.simulateInvoiceBodyLinesItemRateCardOnePriceOneFiveQuantityPerPackageOneRegExp)
|
|
2908
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
2909
|
+
.describe('The quantity per package.'),
|
|
2910
|
+
type: zod
|
|
2911
|
+
.enum(['package'])
|
|
2912
|
+
.describe('The type of the price.'),
|
|
2913
|
+
})
|
|
2914
|
+
.describe('Package price with spend commitments.'),
|
|
2915
|
+
])
|
|
2916
|
+
.describe('The price of the usage based rate card.'),
|
|
2917
|
+
zod.null(),
|
|
2894
2918
|
])
|
|
2895
|
-
.describe('The price of the usage based rate card.')
|
|
2896
|
-
.nullable()
|
|
2897
2919
|
.describe('The price of the rate card.\nWhen null, the feature or service is free.'),
|
|
2898
2920
|
taxConfig: zod
|
|
2899
2921
|
.object({
|
|
@@ -3051,11 +3073,13 @@ exports.ListInvoicesQueryParams = zod.object({
|
|
|
3051
3073
|
.describe('The order by field.'),
|
|
3052
3074
|
page: zod.coerce
|
|
3053
3075
|
.number()
|
|
3076
|
+
.int()
|
|
3054
3077
|
.min(1)
|
|
3055
3078
|
.default(exports.listInvoicesQueryPageDefault)
|
|
3056
3079
|
.describe('Page index.\n\nDefault is 1.'),
|
|
3057
3080
|
pageSize: zod.coerce
|
|
3058
3081
|
.number()
|
|
3082
|
+
.int()
|
|
3059
3083
|
.min(1)
|
|
3060
3084
|
.max(exports.listInvoicesQueryPageSizeMax)
|
|
3061
3085
|
.default(exports.listInvoicesQueryPageSizeDefault)
|
|
@@ -3563,167 +3587,170 @@ exports.UpdateInvoiceBody = zod
|
|
|
3563
3587
|
price: zod
|
|
3564
3588
|
.union([
|
|
3565
3589
|
zod
|
|
3566
|
-
.
|
|
3567
|
-
|
|
3568
|
-
.string()
|
|
3569
|
-
.regex(exports.updateInvoiceBodyLinesItemRateCardOnePriceOneOneAmountOneRegExp)
|
|
3570
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
3571
|
-
.describe('The amount of the flat price.'),
|
|
3572
|
-
paymentTerm: zod
|
|
3573
|
-
.enum(['in_advance', 'in_arrears'])
|
|
3574
|
-
.describe('The payment term of a flat price.\nOne of: in_advance or in_arrears.')
|
|
3575
|
-
.default(exports.updateInvoiceBodyLinesItemRateCardOnePriceOneOnePaymentTermDefault)
|
|
3576
|
-
.describe('The payment term of the flat price.\nDefaults to in advance.'),
|
|
3577
|
-
type: zod
|
|
3578
|
-
.enum(['flat'])
|
|
3579
|
-
.describe('The type of the price.'),
|
|
3580
|
-
})
|
|
3581
|
-
.describe('Flat price with payment term.'),
|
|
3582
|
-
zod
|
|
3583
|
-
.object({
|
|
3584
|
-
amount: zod.coerce
|
|
3585
|
-
.string()
|
|
3586
|
-
.regex(exports.updateInvoiceBodyLinesItemRateCardOnePriceOneTwoAmountOneRegExp)
|
|
3587
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
3588
|
-
.describe('The amount of the unit price.'),
|
|
3589
|
-
maximumAmount: zod.coerce
|
|
3590
|
-
.string()
|
|
3591
|
-
.regex(exports.updateInvoiceBodyLinesItemRateCardOnePriceOneTwoMaximumAmountOneRegExp)
|
|
3592
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
3593
|
-
.optional()
|
|
3594
|
-
.describe('The customer is limited to spend at most the amount.'),
|
|
3595
|
-
minimumAmount: zod.coerce
|
|
3596
|
-
.string()
|
|
3597
|
-
.regex(exports.updateInvoiceBodyLinesItemRateCardOnePriceOneTwoMinimumAmountOneRegExp)
|
|
3598
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
3599
|
-
.optional()
|
|
3600
|
-
.describe('The customer is committed to spend at least the amount.'),
|
|
3601
|
-
type: zod
|
|
3602
|
-
.enum(['unit'])
|
|
3603
|
-
.describe('The type of the price.'),
|
|
3604
|
-
})
|
|
3605
|
-
.describe('Unit price with spend commitments.'),
|
|
3606
|
-
zod
|
|
3607
|
-
.object({
|
|
3608
|
-
maximumAmount: zod.coerce
|
|
3609
|
-
.string()
|
|
3610
|
-
.regex(exports.updateInvoiceBodyLinesItemRateCardOnePriceOneThreeMaximumAmountOneRegExp)
|
|
3611
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
3612
|
-
.optional()
|
|
3613
|
-
.describe('The customer is limited to spend at most the amount.'),
|
|
3614
|
-
minimumAmount: zod.coerce
|
|
3615
|
-
.string()
|
|
3616
|
-
.regex(exports.updateInvoiceBodyLinesItemRateCardOnePriceOneThreeMinimumAmountOneRegExp)
|
|
3617
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
3618
|
-
.optional()
|
|
3619
|
-
.describe('The customer is committed to spend at least the amount.'),
|
|
3620
|
-
mode: zod
|
|
3621
|
-
.enum(['volume', 'graduated'])
|
|
3622
|
-
.describe('The mode of the tiered price.')
|
|
3623
|
-
.describe('Defines if the tiering mode is volume-based or graduated:\n- In `volume`-based tiering, the maximum quantity within a period determines the per unit price.\n- In `graduated` tiering, pricing can change as the quantity grows.'),
|
|
3624
|
-
tiers: zod
|
|
3625
|
-
.array(zod
|
|
3590
|
+
.union([
|
|
3591
|
+
zod
|
|
3626
3592
|
.object({
|
|
3627
|
-
|
|
3628
|
-
.
|
|
3629
|
-
|
|
3630
|
-
|
|
3631
|
-
|
|
3632
|
-
|
|
3633
|
-
|
|
3634
|
-
|
|
3635
|
-
|
|
3636
|
-
|
|
3637
|
-
|
|
3638
|
-
.
|
|
3639
|
-
.
|
|
3640
|
-
|
|
3641
|
-
|
|
3593
|
+
amount: zod.coerce
|
|
3594
|
+
.string()
|
|
3595
|
+
.regex(exports.updateInvoiceBodyLinesItemRateCardOnePriceOneOneAmountOneRegExp)
|
|
3596
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
3597
|
+
.describe('The amount of the flat price.'),
|
|
3598
|
+
paymentTerm: zod
|
|
3599
|
+
.enum(['in_advance', 'in_arrears'])
|
|
3600
|
+
.describe('The payment term of a flat price.\nOne of: in_advance or in_arrears.')
|
|
3601
|
+
.default(exports.updateInvoiceBodyLinesItemRateCardOnePriceOneOnePaymentTermDefault)
|
|
3602
|
+
.describe('The payment term of the flat price.\nDefaults to in advance.'),
|
|
3603
|
+
type: zod
|
|
3604
|
+
.enum(['flat'])
|
|
3605
|
+
.describe('The type of the price.'),
|
|
3606
|
+
})
|
|
3607
|
+
.describe('Flat price with payment term.'),
|
|
3608
|
+
zod
|
|
3609
|
+
.object({
|
|
3610
|
+
amount: zod.coerce
|
|
3611
|
+
.string()
|
|
3612
|
+
.regex(exports.updateInvoiceBodyLinesItemRateCardOnePriceOneTwoAmountOneRegExp)
|
|
3613
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
3614
|
+
.describe('The amount of the unit price.'),
|
|
3615
|
+
maximumAmount: zod.coerce
|
|
3616
|
+
.string()
|
|
3617
|
+
.regex(exports.updateInvoiceBodyLinesItemRateCardOnePriceOneTwoMaximumAmountOneRegExp)
|
|
3618
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
3619
|
+
.optional()
|
|
3620
|
+
.describe('The customer is limited to spend at most the amount.'),
|
|
3621
|
+
minimumAmount: zod.coerce
|
|
3622
|
+
.string()
|
|
3623
|
+
.regex(exports.updateInvoiceBodyLinesItemRateCardOnePriceOneTwoMinimumAmountOneRegExp)
|
|
3624
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
3625
|
+
.optional()
|
|
3626
|
+
.describe('The customer is committed to spend at least the amount.'),
|
|
3627
|
+
type: zod
|
|
3628
|
+
.enum(['unit'])
|
|
3629
|
+
.describe('The type of the price.'),
|
|
3630
|
+
})
|
|
3631
|
+
.describe('Unit price with spend commitments.'),
|
|
3632
|
+
zod
|
|
3633
|
+
.object({
|
|
3634
|
+
maximumAmount: zod.coerce
|
|
3635
|
+
.string()
|
|
3636
|
+
.regex(exports.updateInvoiceBodyLinesItemRateCardOnePriceOneThreeMaximumAmountOneRegExp)
|
|
3637
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
3638
|
+
.optional()
|
|
3639
|
+
.describe('The customer is limited to spend at most the amount.'),
|
|
3640
|
+
minimumAmount: zod.coerce
|
|
3641
|
+
.string()
|
|
3642
|
+
.regex(exports.updateInvoiceBodyLinesItemRateCardOnePriceOneThreeMinimumAmountOneRegExp)
|
|
3643
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
3644
|
+
.optional()
|
|
3645
|
+
.describe('The customer is committed to spend at least the amount.'),
|
|
3646
|
+
mode: zod
|
|
3647
|
+
.enum(['volume', 'graduated'])
|
|
3648
|
+
.describe('The mode of the tiered price.')
|
|
3649
|
+
.describe('Defines if the tiering mode is volume-based or graduated:\n- In `volume`-based tiering, the maximum quantity within a period determines the per unit price.\n- In `graduated` tiering, pricing can change as the quantity grows.'),
|
|
3650
|
+
tiers: zod
|
|
3651
|
+
.array(zod
|
|
3642
3652
|
.object({
|
|
3643
|
-
|
|
3653
|
+
flatPrice: zod
|
|
3654
|
+
.object({
|
|
3655
|
+
amount: zod.coerce
|
|
3656
|
+
.string()
|
|
3657
|
+
.regex(exports.updateInvoiceBodyLinesItemRateCardOnePriceOneThreeTiersItemFlatPriceOneAmountOneRegExp)
|
|
3658
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
3659
|
+
.describe('The amount of the flat price.'),
|
|
3660
|
+
type: zod
|
|
3661
|
+
.enum(['flat'])
|
|
3662
|
+
.describe('The type of the price.'),
|
|
3663
|
+
})
|
|
3664
|
+
.describe('Flat price.')
|
|
3665
|
+
.nullable()
|
|
3666
|
+
.describe('The flat price component of the tier.'),
|
|
3667
|
+
unitPrice: zod
|
|
3668
|
+
.object({
|
|
3669
|
+
amount: zod.coerce
|
|
3670
|
+
.string()
|
|
3671
|
+
.regex(exports.updateInvoiceBodyLinesItemRateCardOnePriceOneThreeTiersItemUnitPriceOneAmountOneRegExp)
|
|
3672
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
3673
|
+
.describe('The amount of the unit price.'),
|
|
3674
|
+
type: zod
|
|
3675
|
+
.enum(['unit'])
|
|
3676
|
+
.describe('The type of the price.'),
|
|
3677
|
+
})
|
|
3678
|
+
.describe('Unit price.')
|
|
3679
|
+
.nullable()
|
|
3680
|
+
.describe('The unit price component of the tier.'),
|
|
3681
|
+
upToAmount: zod.coerce
|
|
3644
3682
|
.string()
|
|
3645
|
-
.regex(exports.
|
|
3683
|
+
.regex(exports.updateInvoiceBodyLinesItemRateCardOnePriceOneThreeTiersItemUpToAmountOneRegExp)
|
|
3646
3684
|
.describe('Numeric represents an arbitrary precision number.')
|
|
3647
|
-
.
|
|
3648
|
-
|
|
3649
|
-
.enum(['unit'])
|
|
3650
|
-
.describe('The type of the price.'),
|
|
3685
|
+
.optional()
|
|
3686
|
+
.describe('Up to and including to this quantity will be contained in the tier.\nIf null, the tier is open-ended.'),
|
|
3651
3687
|
})
|
|
3652
|
-
.describe('
|
|
3653
|
-
.
|
|
3654
|
-
.describe('The
|
|
3655
|
-
|
|
3688
|
+
.describe('A price tier.\nAt least one price component is required in each tier.'))
|
|
3689
|
+
.min(1)
|
|
3690
|
+
.describe('The tiers of the tiered price.\nAt least one price component is required in each tier.'),
|
|
3691
|
+
type: zod
|
|
3692
|
+
.enum(['tiered'])
|
|
3693
|
+
.describe('The type of the price.\n\nOne of: flat, unit, or tiered.'),
|
|
3694
|
+
})
|
|
3695
|
+
.describe('Tiered price with spend commitments.'),
|
|
3696
|
+
zod
|
|
3697
|
+
.object({
|
|
3698
|
+
maximumAmount: zod.coerce
|
|
3699
|
+
.string()
|
|
3700
|
+
.regex(exports.updateInvoiceBodyLinesItemRateCardOnePriceOneFourMaximumAmountOneRegExp)
|
|
3701
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
3702
|
+
.optional()
|
|
3703
|
+
.describe('The customer is limited to spend at most the amount.'),
|
|
3704
|
+
minimumAmount: zod.coerce
|
|
3656
3705
|
.string()
|
|
3657
|
-
.regex(exports.
|
|
3706
|
+
.regex(exports.updateInvoiceBodyLinesItemRateCardOnePriceOneFourMinimumAmountOneRegExp)
|
|
3658
3707
|
.describe('Numeric represents an arbitrary precision number.')
|
|
3659
3708
|
.optional()
|
|
3660
|
-
.describe('
|
|
3709
|
+
.describe('The customer is committed to spend at least the amount.'),
|
|
3710
|
+
multiplier: zod.coerce
|
|
3711
|
+
.string()
|
|
3712
|
+
.regex(exports.updateInvoiceBodyLinesItemRateCardOnePriceOneFourMultiplierOneRegExp)
|
|
3713
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
3714
|
+
.default(exports.updateInvoiceBodyLinesItemRateCardOnePriceOneFourMultiplierDefault)
|
|
3715
|
+
.describe('The multiplier to apply to the base price to get the dynamic price.\n\nExamples:\n- 0.0: the price is zero\n- 0.5: the price is 50% of the base price\n- 1.0: the price is the same as the base price\n- 1.5: the price is 150% of the base price'),
|
|
3716
|
+
type: zod
|
|
3717
|
+
.enum(['dynamic'])
|
|
3718
|
+
.describe('The type of the price.'),
|
|
3661
3719
|
})
|
|
3662
|
-
.describe('
|
|
3663
|
-
|
|
3664
|
-
.
|
|
3665
|
-
|
|
3666
|
-
|
|
3667
|
-
|
|
3668
|
-
|
|
3669
|
-
|
|
3670
|
-
|
|
3671
|
-
|
|
3672
|
-
|
|
3673
|
-
|
|
3674
|
-
|
|
3675
|
-
|
|
3676
|
-
.
|
|
3677
|
-
|
|
3678
|
-
|
|
3679
|
-
|
|
3680
|
-
|
|
3681
|
-
|
|
3682
|
-
.
|
|
3683
|
-
|
|
3684
|
-
|
|
3685
|
-
|
|
3686
|
-
|
|
3687
|
-
|
|
3688
|
-
|
|
3689
|
-
|
|
3690
|
-
|
|
3691
|
-
.
|
|
3692
|
-
|
|
3693
|
-
|
|
3694
|
-
|
|
3695
|
-
zod
|
|
3696
|
-
.object({
|
|
3697
|
-
amount: zod.coerce
|
|
3698
|
-
.string()
|
|
3699
|
-
.regex(exports.updateInvoiceBodyLinesItemRateCardOnePriceOneFiveAmountOneRegExp)
|
|
3700
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
3701
|
-
.describe('The price of one package.'),
|
|
3702
|
-
maximumAmount: zod.coerce
|
|
3703
|
-
.string()
|
|
3704
|
-
.regex(exports.updateInvoiceBodyLinesItemRateCardOnePriceOneFiveMaximumAmountOneRegExp)
|
|
3705
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
3706
|
-
.optional()
|
|
3707
|
-
.describe('The customer is limited to spend at most the amount.'),
|
|
3708
|
-
minimumAmount: zod.coerce
|
|
3709
|
-
.string()
|
|
3710
|
-
.regex(exports.updateInvoiceBodyLinesItemRateCardOnePriceOneFiveMinimumAmountOneRegExp)
|
|
3711
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
3712
|
-
.optional()
|
|
3713
|
-
.describe('The customer is committed to spend at least the amount.'),
|
|
3714
|
-
quantityPerPackage: zod.coerce
|
|
3715
|
-
.string()
|
|
3716
|
-
.regex(exports.updateInvoiceBodyLinesItemRateCardOnePriceOneFiveQuantityPerPackageOneRegExp)
|
|
3717
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
3718
|
-
.describe('The quantity per package.'),
|
|
3719
|
-
type: zod
|
|
3720
|
-
.enum(['package'])
|
|
3721
|
-
.describe('The type of the price.'),
|
|
3722
|
-
})
|
|
3723
|
-
.describe('Package price with spend commitments.'),
|
|
3720
|
+
.describe('Dynamic price with spend commitments.'),
|
|
3721
|
+
zod
|
|
3722
|
+
.object({
|
|
3723
|
+
amount: zod.coerce
|
|
3724
|
+
.string()
|
|
3725
|
+
.regex(exports.updateInvoiceBodyLinesItemRateCardOnePriceOneFiveAmountOneRegExp)
|
|
3726
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
3727
|
+
.describe('The price of one package.'),
|
|
3728
|
+
maximumAmount: zod.coerce
|
|
3729
|
+
.string()
|
|
3730
|
+
.regex(exports.updateInvoiceBodyLinesItemRateCardOnePriceOneFiveMaximumAmountOneRegExp)
|
|
3731
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
3732
|
+
.optional()
|
|
3733
|
+
.describe('The customer is limited to spend at most the amount.'),
|
|
3734
|
+
minimumAmount: zod.coerce
|
|
3735
|
+
.string()
|
|
3736
|
+
.regex(exports.updateInvoiceBodyLinesItemRateCardOnePriceOneFiveMinimumAmountOneRegExp)
|
|
3737
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
3738
|
+
.optional()
|
|
3739
|
+
.describe('The customer is committed to spend at least the amount.'),
|
|
3740
|
+
quantityPerPackage: zod.coerce
|
|
3741
|
+
.string()
|
|
3742
|
+
.regex(exports.updateInvoiceBodyLinesItemRateCardOnePriceOneFiveQuantityPerPackageOneRegExp)
|
|
3743
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
3744
|
+
.describe('The quantity per package.'),
|
|
3745
|
+
type: zod
|
|
3746
|
+
.enum(['package'])
|
|
3747
|
+
.describe('The type of the price.'),
|
|
3748
|
+
})
|
|
3749
|
+
.describe('Package price with spend commitments.'),
|
|
3750
|
+
])
|
|
3751
|
+
.describe('The price of the usage based rate card.'),
|
|
3752
|
+
zod.null(),
|
|
3724
3753
|
])
|
|
3725
|
-
.describe('The price of the usage based rate card.')
|
|
3726
|
-
.nullable()
|
|
3727
3754
|
.describe('The price of the rate card.\nWhen null, the feature or service is free.'),
|
|
3728
3755
|
taxConfig: zod
|
|
3729
3756
|
.object({
|
|
@@ -4140,11 +4167,13 @@ exports.ListBillingProfilesQueryParams = zod.object({
|
|
|
4140
4167
|
.describe('The order by field.'),
|
|
4141
4168
|
page: zod.coerce
|
|
4142
4169
|
.number()
|
|
4170
|
+
.int()
|
|
4143
4171
|
.min(1)
|
|
4144
4172
|
.default(exports.listBillingProfilesQueryPageDefault)
|
|
4145
4173
|
.describe('Page index.\n\nDefault is 1.'),
|
|
4146
4174
|
pageSize: zod.coerce
|
|
4147
4175
|
.number()
|
|
4176
|
+
.int()
|
|
4148
4177
|
.min(1)
|
|
4149
4178
|
.max(exports.listBillingProfilesQueryPageSizeMax)
|
|
4150
4179
|
.default(exports.listBillingProfilesQueryPageSizeDefault)
|
|
@@ -4851,11 +4880,13 @@ exports.ListCustomersQueryParams = zod.object({
|
|
|
4851
4880
|
.describe('The order by field.'),
|
|
4852
4881
|
page: zod.coerce
|
|
4853
4882
|
.number()
|
|
4883
|
+
.int()
|
|
4854
4884
|
.min(1)
|
|
4855
4885
|
.default(exports.listCustomersQueryPageDefault)
|
|
4856
4886
|
.describe('Page index.\n\nDefault is 1.'),
|
|
4857
4887
|
pageSize: zod.coerce
|
|
4858
4888
|
.number()
|
|
4889
|
+
.int()
|
|
4859
4890
|
.min(1)
|
|
4860
4891
|
.max(exports.listCustomersQueryPageSizeMax)
|
|
4861
4892
|
.default(exports.listCustomersQueryPageSizeDefault)
|
|
@@ -5068,11 +5099,13 @@ exports.listCustomerAppDataQueryPageSizeMax = 1000;
|
|
|
5068
5099
|
exports.ListCustomerAppDataQueryParams = zod.object({
|
|
5069
5100
|
page: zod.coerce
|
|
5070
5101
|
.number()
|
|
5102
|
+
.int()
|
|
5071
5103
|
.min(1)
|
|
5072
5104
|
.default(exports.listCustomerAppDataQueryPageDefault)
|
|
5073
5105
|
.describe('Page index.\n\nDefault is 1.'),
|
|
5074
5106
|
pageSize: zod.coerce
|
|
5075
5107
|
.number()
|
|
5108
|
+
.int()
|
|
5076
5109
|
.min(1)
|
|
5077
5110
|
.max(exports.listCustomerAppDataQueryPageSizeMax)
|
|
5078
5111
|
.default(exports.listCustomerAppDataQueryPageSizeDefault)
|
|
@@ -5522,11 +5555,13 @@ exports.ListCustomerSubscriptionsQueryParams = zod.object({
|
|
|
5522
5555
|
.describe('The order by field.'),
|
|
5523
5556
|
page: zod.coerce
|
|
5524
5557
|
.number()
|
|
5558
|
+
.int()
|
|
5525
5559
|
.min(1)
|
|
5526
5560
|
.default(exports.listCustomerSubscriptionsQueryPageDefault)
|
|
5527
5561
|
.describe('Page index.\n\nDefault is 1.'),
|
|
5528
5562
|
pageSize: zod.coerce
|
|
5529
5563
|
.number()
|
|
5564
|
+
.int()
|
|
5530
5565
|
.min(1)
|
|
5531
5566
|
.max(exports.listCustomerSubscriptionsQueryPageSizeMax)
|
|
5532
5567
|
.default(exports.listCustomerSubscriptionsQueryPageSizeDefault)
|
|
@@ -5572,12 +5607,14 @@ exports.ListEntitlementsQueryParams = zod.object({
|
|
|
5572
5607
|
.describe('Filtering by multiple features.\n\nUsage: `?feature=feature-1&feature=feature-2`'),
|
|
5573
5608
|
limit: zod.coerce
|
|
5574
5609
|
.number()
|
|
5610
|
+
.int()
|
|
5575
5611
|
.min(1)
|
|
5576
5612
|
.max(exports.listEntitlementsQueryLimitMax)
|
|
5577
5613
|
.default(exports.listEntitlementsQueryLimitDefault)
|
|
5578
5614
|
.describe('Number of items to return.\n\nDefault is 100.'),
|
|
5579
5615
|
offset: zod.coerce
|
|
5580
5616
|
.number()
|
|
5617
|
+
.int()
|
|
5581
5618
|
.min(exports.listEntitlementsQueryOffsetMin)
|
|
5582
5619
|
.default(exports.listEntitlementsQueryOffsetDefault)
|
|
5583
5620
|
.describe('Number of items to skip.\n\nDefault is 0.'),
|
|
@@ -5592,11 +5629,13 @@ exports.ListEntitlementsQueryParams = zod.object({
|
|
|
5592
5629
|
.describe('The order by field.'),
|
|
5593
5630
|
page: zod.coerce
|
|
5594
5631
|
.number()
|
|
5632
|
+
.int()
|
|
5595
5633
|
.min(1)
|
|
5596
5634
|
.default(exports.listEntitlementsQueryPageDefault)
|
|
5597
5635
|
.describe('Page index.\n\nDefault is 1.'),
|
|
5598
5636
|
pageSize: zod.coerce
|
|
5599
5637
|
.number()
|
|
5638
|
+
.int()
|
|
5600
5639
|
.min(1)
|
|
5601
5640
|
.max(exports.listEntitlementsQueryPageSizeMax)
|
|
5602
5641
|
.default(exports.listEntitlementsQueryPageSizeDefault)
|
|
@@ -5661,6 +5700,7 @@ exports.ListEventsQueryParams = zod.object({
|
|
|
5661
5700
|
.describe('End date-time in RFC 3339 format.\n\nInclusive.'),
|
|
5662
5701
|
limit: zod.coerce
|
|
5663
5702
|
.number()
|
|
5703
|
+
.int()
|
|
5664
5704
|
.min(1)
|
|
5665
5705
|
.max(exports.listEventsQueryLimitMax)
|
|
5666
5706
|
.default(exports.listEventsQueryLimitDefault)
|
|
@@ -5738,6 +5778,7 @@ exports.ListFeaturesQueryParams = zod.object({
|
|
|
5738
5778
|
.describe('Include archived features in response.'),
|
|
5739
5779
|
limit: zod.coerce
|
|
5740
5780
|
.number()
|
|
5781
|
+
.int()
|
|
5741
5782
|
.min(1)
|
|
5742
5783
|
.max(exports.listFeaturesQueryLimitMax)
|
|
5743
5784
|
.default(exports.listFeaturesQueryLimitDefault)
|
|
@@ -5748,6 +5789,7 @@ exports.ListFeaturesQueryParams = zod.object({
|
|
|
5748
5789
|
.describe('Filter by meterSlug'),
|
|
5749
5790
|
offset: zod.coerce
|
|
5750
5791
|
.number()
|
|
5792
|
+
.int()
|
|
5751
5793
|
.min(exports.listFeaturesQueryOffsetMin)
|
|
5752
5794
|
.default(exports.listFeaturesQueryOffsetDefault)
|
|
5753
5795
|
.describe('Number of items to skip.\n\nDefault is 0.'),
|
|
@@ -5762,11 +5804,13 @@ exports.ListFeaturesQueryParams = zod.object({
|
|
|
5762
5804
|
.describe('The order by field.'),
|
|
5763
5805
|
page: zod.coerce
|
|
5764
5806
|
.number()
|
|
5807
|
+
.int()
|
|
5765
5808
|
.min(1)
|
|
5766
5809
|
.default(exports.listFeaturesQueryPageDefault)
|
|
5767
5810
|
.describe('Page index.\n\nDefault is 1.'),
|
|
5768
5811
|
pageSize: zod.coerce
|
|
5769
5812
|
.number()
|
|
5813
|
+
.int()
|
|
5770
5814
|
.min(1)
|
|
5771
5815
|
.max(exports.listFeaturesQueryPageSizeMax)
|
|
5772
5816
|
.default(exports.listFeaturesQueryPageSizeDefault)
|
|
@@ -6002,12 +6046,14 @@ exports.ListGrantsQueryParams = zod.object({
|
|
|
6002
6046
|
.describe('Include deleted'),
|
|
6003
6047
|
limit: zod.coerce
|
|
6004
6048
|
.number()
|
|
6049
|
+
.int()
|
|
6005
6050
|
.min(1)
|
|
6006
6051
|
.max(exports.listGrantsQueryLimitMax)
|
|
6007
6052
|
.default(exports.listGrantsQueryLimitDefault)
|
|
6008
6053
|
.describe('Number of items to return.\n\nDefault is 100.'),
|
|
6009
6054
|
offset: zod.coerce
|
|
6010
6055
|
.number()
|
|
6056
|
+
.int()
|
|
6011
6057
|
.min(exports.listGrantsQueryOffsetMin)
|
|
6012
6058
|
.default(exports.listGrantsQueryOffsetDefault)
|
|
6013
6059
|
.describe('Number of items to skip.\n\nDefault is 0.'),
|
|
@@ -6022,11 +6068,13 @@ exports.ListGrantsQueryParams = zod.object({
|
|
|
6022
6068
|
.describe('The order by field.'),
|
|
6023
6069
|
page: zod.coerce
|
|
6024
6070
|
.number()
|
|
6071
|
+
.int()
|
|
6025
6072
|
.min(1)
|
|
6026
6073
|
.default(exports.listGrantsQueryPageDefault)
|
|
6027
6074
|
.describe('Page index.\n\nDefault is 1.'),
|
|
6028
6075
|
pageSize: zod.coerce
|
|
6029
6076
|
.number()
|
|
6077
|
+
.int()
|
|
6030
6078
|
.min(1)
|
|
6031
6079
|
.max(exports.listGrantsQueryPageSizeMax)
|
|
6032
6080
|
.default(exports.listGrantsQueryPageSizeDefault)
|
|
@@ -6067,11 +6115,13 @@ exports.listMarketplaceListingsQueryPageSizeMax = 1000;
|
|
|
6067
6115
|
exports.ListMarketplaceListingsQueryParams = zod.object({
|
|
6068
6116
|
page: zod.coerce
|
|
6069
6117
|
.number()
|
|
6118
|
+
.int()
|
|
6070
6119
|
.min(1)
|
|
6071
6120
|
.default(exports.listMarketplaceListingsQueryPageDefault)
|
|
6072
6121
|
.describe('Page index.\n\nDefault is 1.'),
|
|
6073
6122
|
pageSize: zod.coerce
|
|
6074
6123
|
.number()
|
|
6124
|
+
.int()
|
|
6075
6125
|
.min(1)
|
|
6076
6126
|
.max(exports.listMarketplaceListingsQueryPageSizeMax)
|
|
6077
6127
|
.default(exports.listMarketplaceListingsQueryPageSizeDefault)
|
|
@@ -6202,11 +6252,13 @@ exports.ListMetersQueryParams = zod.object({
|
|
|
6202
6252
|
.describe('The order by field.'),
|
|
6203
6253
|
page: zod.coerce
|
|
6204
6254
|
.number()
|
|
6255
|
+
.int()
|
|
6205
6256
|
.min(1)
|
|
6206
6257
|
.default(exports.listMetersQueryPageDefault)
|
|
6207
6258
|
.describe('Page index.\n\nDefault is 1.'),
|
|
6208
6259
|
pageSize: zod.coerce
|
|
6209
6260
|
.number()
|
|
6261
|
+
.int()
|
|
6210
6262
|
.min(1)
|
|
6211
6263
|
.max(exports.listMetersQueryPageSizeMax)
|
|
6212
6264
|
.default(exports.listMetersQueryPageSizeDefault)
|
|
@@ -6223,7 +6275,15 @@ exports.createMeterBodySlugRegExp = /^[a-z0-9]+(?:_[a-z0-9]+)*$/;
|
|
|
6223
6275
|
exports.CreateMeterBody = zod
|
|
6224
6276
|
.object({
|
|
6225
6277
|
aggregation: zod
|
|
6226
|
-
.enum(
|
|
6278
|
+
.enum({
|
|
6279
|
+
Avg: 'AVG',
|
|
6280
|
+
Count: 'COUNT',
|
|
6281
|
+
Latest: 'LATEST',
|
|
6282
|
+
Max: 'MAX',
|
|
6283
|
+
Min: 'MIN',
|
|
6284
|
+
Sum: 'SUM',
|
|
6285
|
+
UniqueCount: 'UNIQUE_COUNT',
|
|
6286
|
+
})
|
|
6227
6287
|
.describe('The aggregation type to use for the meter.')
|
|
6228
6288
|
.describe('The aggregation type to use for the meter.'),
|
|
6229
6289
|
description: zod.coerce
|
|
@@ -6405,7 +6465,12 @@ exports.QueryMeterQueryParams = zod.object({
|
|
|
6405
6465
|
.optional()
|
|
6406
6466
|
.describe('End date-time in RFC 3339 format.\n\nInclusive.\n\nFor example: ?to=2025-02-01T00%3A00%3A00.000Z'),
|
|
6407
6467
|
windowSize: zod
|
|
6408
|
-
.enum(
|
|
6468
|
+
.enum({
|
|
6469
|
+
Day: 'DAY',
|
|
6470
|
+
Hour: 'HOUR',
|
|
6471
|
+
Minute: 'MINUTE',
|
|
6472
|
+
Month: 'MONTH',
|
|
6473
|
+
})
|
|
6409
6474
|
.optional()
|
|
6410
6475
|
.describe('If not specified, a single usage aggregate will be returned for the entirety of the specified period for each subject and group.\n\nFor example: ?windowSize=DAY'),
|
|
6411
6476
|
windowTimeZone: zod.coerce
|
|
@@ -6529,7 +6594,12 @@ exports.QueryMeterPostBody = zod
|
|
|
6529
6594
|
.optional()
|
|
6530
6595
|
.describe('End date-time in RFC 3339 format.\n\nInclusive.'),
|
|
6531
6596
|
windowSize: zod
|
|
6532
|
-
.enum(
|
|
6597
|
+
.enum({
|
|
6598
|
+
Day: 'DAY',
|
|
6599
|
+
Hour: 'HOUR',
|
|
6600
|
+
Minute: 'MINUTE',
|
|
6601
|
+
Month: 'MONTH',
|
|
6602
|
+
})
|
|
6533
6603
|
.describe('Aggregation window size.')
|
|
6534
6604
|
.optional()
|
|
6535
6605
|
.describe('If not specified, a single usage aggregate will be returned for the entirety of the specified period for each subject and group.'),
|
|
@@ -6592,11 +6662,13 @@ exports.ListNotificationChannelsQueryParams = zod.object({
|
|
|
6592
6662
|
.describe('The order by field.'),
|
|
6593
6663
|
page: zod.coerce
|
|
6594
6664
|
.number()
|
|
6665
|
+
.int()
|
|
6595
6666
|
.min(1)
|
|
6596
6667
|
.default(exports.listNotificationChannelsQueryPageDefault)
|
|
6597
6668
|
.describe('Page index.\n\nDefault is 1.'),
|
|
6598
6669
|
pageSize: zod.coerce
|
|
6599
6670
|
.number()
|
|
6671
|
+
.int()
|
|
6600
6672
|
.min(1)
|
|
6601
6673
|
.max(exports.listNotificationChannelsQueryPageSizeMax)
|
|
6602
6674
|
.default(exports.listNotificationChannelsQueryPageSizeDefault)
|
|
@@ -6745,11 +6817,13 @@ exports.ListNotificationEventsQueryParams = zod.object({
|
|
|
6745
6817
|
.describe('The order by field.'),
|
|
6746
6818
|
page: zod.coerce
|
|
6747
6819
|
.number()
|
|
6820
|
+
.int()
|
|
6748
6821
|
.min(1)
|
|
6749
6822
|
.default(exports.listNotificationEventsQueryPageDefault)
|
|
6750
6823
|
.describe('Page index.\n\nDefault is 1.'),
|
|
6751
6824
|
pageSize: zod.coerce
|
|
6752
6825
|
.number()
|
|
6826
|
+
.int()
|
|
6753
6827
|
.min(1)
|
|
6754
6828
|
.max(exports.listNotificationEventsQueryPageSizeMax)
|
|
6755
6829
|
.default(exports.listNotificationEventsQueryPageSizeDefault)
|
|
@@ -6841,11 +6915,13 @@ exports.ListNotificationRulesQueryParams = zod.object({
|
|
|
6841
6915
|
.describe('The order by field.'),
|
|
6842
6916
|
page: zod.coerce
|
|
6843
6917
|
.number()
|
|
6918
|
+
.int()
|
|
6844
6919
|
.min(1)
|
|
6845
6920
|
.default(exports.listNotificationRulesQueryPageDefault)
|
|
6846
6921
|
.describe('Page index.\n\nDefault is 1.'),
|
|
6847
6922
|
pageSize: zod.coerce
|
|
6848
6923
|
.number()
|
|
6924
|
+
.int()
|
|
6849
6925
|
.min(1)
|
|
6850
6926
|
.max(exports.listNotificationRulesQueryPageSizeMax)
|
|
6851
6927
|
.default(exports.listNotificationRulesQueryPageSizeDefault)
|
|
@@ -6911,13 +6987,13 @@ exports.CreateNotificationRuleBody = zod
|
|
|
6911
6987
|
.array(zod
|
|
6912
6988
|
.object({
|
|
6913
6989
|
type: zod
|
|
6914
|
-
.enum(
|
|
6915
|
-
'
|
|
6916
|
-
'NUMBER',
|
|
6917
|
-
'
|
|
6918
|
-
'usage_percentage',
|
|
6919
|
-
'usage_value',
|
|
6920
|
-
|
|
6990
|
+
.enum({
|
|
6991
|
+
BalanceValue: 'balance_value',
|
|
6992
|
+
Number: 'NUMBER',
|
|
6993
|
+
Percent: 'PERCENT',
|
|
6994
|
+
UsagePercentage: 'usage_percentage',
|
|
6995
|
+
UsageValue: 'usage_value',
|
|
6996
|
+
})
|
|
6921
6997
|
.describe('Type of the rule in the balance threshold specification:\n* `balance_value`: threshold defined by the remaining balance value based on usage and the total of grants in the current usage period\n* `usage_percentage`: threshold defined by the usage percentage compared to the total of grants in the current usage period\n* `usage_value`: threshold defined by the usage value in the current usage period\n* `NUMBER` (**deprecated**): see `usage_value`\n* `PERCENT` (**deprecated**): see `usage_percentage`')
|
|
6922
6998
|
.describe('Type of the threshold.'),
|
|
6923
6999
|
value: zod.coerce.number().describe('Value of the threshold.'),
|
|
@@ -7087,13 +7163,13 @@ exports.UpdateNotificationRuleBody = zod
|
|
|
7087
7163
|
.array(zod
|
|
7088
7164
|
.object({
|
|
7089
7165
|
type: zod
|
|
7090
|
-
.enum(
|
|
7091
|
-
'
|
|
7092
|
-
'NUMBER',
|
|
7093
|
-
'
|
|
7094
|
-
'usage_percentage',
|
|
7095
|
-
'usage_value',
|
|
7096
|
-
|
|
7166
|
+
.enum({
|
|
7167
|
+
BalanceValue: 'balance_value',
|
|
7168
|
+
Number: 'NUMBER',
|
|
7169
|
+
Percent: 'PERCENT',
|
|
7170
|
+
UsagePercentage: 'usage_percentage',
|
|
7171
|
+
UsageValue: 'usage_value',
|
|
7172
|
+
})
|
|
7097
7173
|
.describe('Type of the rule in the balance threshold specification:\n* `balance_value`: threshold defined by the remaining balance value based on usage and the total of grants in the current usage period\n* `usage_percentage`: threshold defined by the usage percentage compared to the total of grants in the current usage period\n* `usage_value`: threshold defined by the usage value in the current usage period\n* `NUMBER` (**deprecated**): see `usage_value`\n* `PERCENT` (**deprecated**): see `usage_percentage`')
|
|
7098
7174
|
.describe('Type of the threshold.'),
|
|
7099
7175
|
value: zod.coerce.number().describe('Value of the threshold.'),
|
|
@@ -7271,7 +7347,7 @@ exports.ListPlansQueryParams = zod.object({
|
|
|
7271
7347
|
.optional()
|
|
7272
7348
|
.describe('Filter by plan.key attribute'),
|
|
7273
7349
|
keyVersion: zod
|
|
7274
|
-
.record(zod.string(), zod.array(zod.coerce.number()))
|
|
7350
|
+
.record(zod.string(), zod.array(zod.coerce.number().int()))
|
|
7275
7351
|
.optional()
|
|
7276
7352
|
.describe('Filter by plan.key and plan.version attributes'),
|
|
7277
7353
|
order: zod
|
|
@@ -7285,11 +7361,13 @@ exports.ListPlansQueryParams = zod.object({
|
|
|
7285
7361
|
.describe('The order by field.'),
|
|
7286
7362
|
page: zod.coerce
|
|
7287
7363
|
.number()
|
|
7364
|
+
.int()
|
|
7288
7365
|
.min(1)
|
|
7289
7366
|
.default(exports.listPlansQueryPageDefault)
|
|
7290
7367
|
.describe('Page index.\n\nDefault is 1.'),
|
|
7291
7368
|
pageSize: zod.coerce
|
|
7292
7369
|
.number()
|
|
7370
|
+
.int()
|
|
7293
7371
|
.min(1)
|
|
7294
7372
|
.max(exports.listPlansQueryPageSizeMax)
|
|
7295
7373
|
.default(exports.listPlansQueryPageSizeDefault)
|
|
@@ -7500,6 +7578,7 @@ exports.CreatePlanBody = zod
|
|
|
7500
7578
|
.describe('You can grant usage automatically alongside the entitlement, the example scenario would be creating a starting balance.\nIf an amount is specified here, a grant will be created alongside the entitlement with the specified amount.\nThat grant will have it\'s rollover settings configured in a way that after each reset operation, the balance will return the original amount specified here.\nManually creating such a grant would mean having the "amount", "minRolloverAmount", and "maxRolloverAmount" fields all be the same.'),
|
|
7501
7579
|
issueAfterResetPriority: zod.coerce
|
|
7502
7580
|
.number()
|
|
7581
|
+
.int()
|
|
7503
7582
|
.min(1)
|
|
7504
7583
|
.max(exports.createPlanBodyPhasesItemRateCardsItemOneEntitlementTemplateOneOneIssueAfterResetPriorityMax)
|
|
7505
7584
|
.default(exports.createPlanBodyPhasesItemRateCardsItemOneEntitlementTemplateOneOneIssueAfterResetPriorityDefault)
|
|
@@ -7681,6 +7760,7 @@ exports.CreatePlanBody = zod
|
|
|
7681
7760
|
.describe('You can grant usage automatically alongside the entitlement, the example scenario would be creating a starting balance.\nIf an amount is specified here, a grant will be created alongside the entitlement with the specified amount.\nThat grant will have it\'s rollover settings configured in a way that after each reset operation, the balance will return the original amount specified here.\nManually creating such a grant would mean having the "amount", "minRolloverAmount", and "maxRolloverAmount" fields all be the same.'),
|
|
7682
7761
|
issueAfterResetPriority: zod.coerce
|
|
7683
7762
|
.number()
|
|
7763
|
+
.int()
|
|
7684
7764
|
.min(1)
|
|
7685
7765
|
.max(exports.createPlanBodyPhasesItemRateCardsItemTwoEntitlementTemplateOneOneIssueAfterResetPriorityMax)
|
|
7686
7766
|
.default(exports.createPlanBodyPhasesItemRateCardsItemTwoEntitlementTemplateOneOneIssueAfterResetPriorityDefault)
|
|
@@ -7754,167 +7834,170 @@ exports.CreatePlanBody = zod
|
|
|
7754
7834
|
price: zod
|
|
7755
7835
|
.union([
|
|
7756
7836
|
zod
|
|
7757
|
-
.
|
|
7758
|
-
|
|
7759
|
-
.string()
|
|
7760
|
-
.regex(exports.createPlanBodyPhasesItemRateCardsItemTwoPriceOneOneAmountOneRegExp)
|
|
7761
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
7762
|
-
.describe('The amount of the flat price.'),
|
|
7763
|
-
paymentTerm: zod
|
|
7764
|
-
.enum(['in_advance', 'in_arrears'])
|
|
7765
|
-
.describe('The payment term of a flat price.\nOne of: in_advance or in_arrears.')
|
|
7766
|
-
.default(exports.createPlanBodyPhasesItemRateCardsItemTwoPriceOneOnePaymentTermDefault)
|
|
7767
|
-
.describe('The payment term of the flat price.\nDefaults to in advance.'),
|
|
7768
|
-
type: zod
|
|
7769
|
-
.enum(['flat'])
|
|
7770
|
-
.describe('The type of the price.'),
|
|
7771
|
-
})
|
|
7772
|
-
.describe('Flat price with payment term.'),
|
|
7773
|
-
zod
|
|
7774
|
-
.object({
|
|
7775
|
-
amount: zod.coerce
|
|
7776
|
-
.string()
|
|
7777
|
-
.regex(exports.createPlanBodyPhasesItemRateCardsItemTwoPriceOneTwoAmountOneRegExp)
|
|
7778
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
7779
|
-
.describe('The amount of the unit price.'),
|
|
7780
|
-
maximumAmount: zod.coerce
|
|
7781
|
-
.string()
|
|
7782
|
-
.regex(exports.createPlanBodyPhasesItemRateCardsItemTwoPriceOneTwoMaximumAmountOneRegExp)
|
|
7783
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
7784
|
-
.optional()
|
|
7785
|
-
.describe('The customer is limited to spend at most the amount.'),
|
|
7786
|
-
minimumAmount: zod.coerce
|
|
7787
|
-
.string()
|
|
7788
|
-
.regex(exports.createPlanBodyPhasesItemRateCardsItemTwoPriceOneTwoMinimumAmountOneRegExp)
|
|
7789
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
7790
|
-
.optional()
|
|
7791
|
-
.describe('The customer is committed to spend at least the amount.'),
|
|
7792
|
-
type: zod
|
|
7793
|
-
.enum(['unit'])
|
|
7794
|
-
.describe('The type of the price.'),
|
|
7795
|
-
})
|
|
7796
|
-
.describe('Unit price with spend commitments.'),
|
|
7797
|
-
zod
|
|
7798
|
-
.object({
|
|
7799
|
-
maximumAmount: zod.coerce
|
|
7800
|
-
.string()
|
|
7801
|
-
.regex(exports.createPlanBodyPhasesItemRateCardsItemTwoPriceOneThreeMaximumAmountOneRegExp)
|
|
7802
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
7803
|
-
.optional()
|
|
7804
|
-
.describe('The customer is limited to spend at most the amount.'),
|
|
7805
|
-
minimumAmount: zod.coerce
|
|
7806
|
-
.string()
|
|
7807
|
-
.regex(exports.createPlanBodyPhasesItemRateCardsItemTwoPriceOneThreeMinimumAmountOneRegExp)
|
|
7808
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
7809
|
-
.optional()
|
|
7810
|
-
.describe('The customer is committed to spend at least the amount.'),
|
|
7811
|
-
mode: zod
|
|
7812
|
-
.enum(['volume', 'graduated'])
|
|
7813
|
-
.describe('The mode of the tiered price.')
|
|
7814
|
-
.describe('Defines if the tiering mode is volume-based or graduated:\n- In `volume`-based tiering, the maximum quantity within a period determines the per unit price.\n- In `graduated` tiering, pricing can change as the quantity grows.'),
|
|
7815
|
-
tiers: zod
|
|
7816
|
-
.array(zod
|
|
7837
|
+
.union([
|
|
7838
|
+
zod
|
|
7817
7839
|
.object({
|
|
7818
|
-
|
|
7819
|
-
.
|
|
7820
|
-
|
|
7821
|
-
|
|
7822
|
-
|
|
7823
|
-
|
|
7824
|
-
|
|
7825
|
-
|
|
7826
|
-
|
|
7827
|
-
|
|
7828
|
-
|
|
7829
|
-
.
|
|
7830
|
-
.
|
|
7831
|
-
|
|
7832
|
-
|
|
7840
|
+
amount: zod.coerce
|
|
7841
|
+
.string()
|
|
7842
|
+
.regex(exports.createPlanBodyPhasesItemRateCardsItemTwoPriceOneOneAmountOneRegExp)
|
|
7843
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
7844
|
+
.describe('The amount of the flat price.'),
|
|
7845
|
+
paymentTerm: zod
|
|
7846
|
+
.enum(['in_advance', 'in_arrears'])
|
|
7847
|
+
.describe('The payment term of a flat price.\nOne of: in_advance or in_arrears.')
|
|
7848
|
+
.default(exports.createPlanBodyPhasesItemRateCardsItemTwoPriceOneOnePaymentTermDefault)
|
|
7849
|
+
.describe('The payment term of the flat price.\nDefaults to in advance.'),
|
|
7850
|
+
type: zod
|
|
7851
|
+
.enum(['flat'])
|
|
7852
|
+
.describe('The type of the price.'),
|
|
7853
|
+
})
|
|
7854
|
+
.describe('Flat price with payment term.'),
|
|
7855
|
+
zod
|
|
7856
|
+
.object({
|
|
7857
|
+
amount: zod.coerce
|
|
7858
|
+
.string()
|
|
7859
|
+
.regex(exports.createPlanBodyPhasesItemRateCardsItemTwoPriceOneTwoAmountOneRegExp)
|
|
7860
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
7861
|
+
.describe('The amount of the unit price.'),
|
|
7862
|
+
maximumAmount: zod.coerce
|
|
7863
|
+
.string()
|
|
7864
|
+
.regex(exports.createPlanBodyPhasesItemRateCardsItemTwoPriceOneTwoMaximumAmountOneRegExp)
|
|
7865
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
7866
|
+
.optional()
|
|
7867
|
+
.describe('The customer is limited to spend at most the amount.'),
|
|
7868
|
+
minimumAmount: zod.coerce
|
|
7869
|
+
.string()
|
|
7870
|
+
.regex(exports.createPlanBodyPhasesItemRateCardsItemTwoPriceOneTwoMinimumAmountOneRegExp)
|
|
7871
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
7872
|
+
.optional()
|
|
7873
|
+
.describe('The customer is committed to spend at least the amount.'),
|
|
7874
|
+
type: zod
|
|
7875
|
+
.enum(['unit'])
|
|
7876
|
+
.describe('The type of the price.'),
|
|
7877
|
+
})
|
|
7878
|
+
.describe('Unit price with spend commitments.'),
|
|
7879
|
+
zod
|
|
7880
|
+
.object({
|
|
7881
|
+
maximumAmount: zod.coerce
|
|
7882
|
+
.string()
|
|
7883
|
+
.regex(exports.createPlanBodyPhasesItemRateCardsItemTwoPriceOneThreeMaximumAmountOneRegExp)
|
|
7884
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
7885
|
+
.optional()
|
|
7886
|
+
.describe('The customer is limited to spend at most the amount.'),
|
|
7887
|
+
minimumAmount: zod.coerce
|
|
7888
|
+
.string()
|
|
7889
|
+
.regex(exports.createPlanBodyPhasesItemRateCardsItemTwoPriceOneThreeMinimumAmountOneRegExp)
|
|
7890
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
7891
|
+
.optional()
|
|
7892
|
+
.describe('The customer is committed to spend at least the amount.'),
|
|
7893
|
+
mode: zod
|
|
7894
|
+
.enum(['volume', 'graduated'])
|
|
7895
|
+
.describe('The mode of the tiered price.')
|
|
7896
|
+
.describe('Defines if the tiering mode is volume-based or graduated:\n- In `volume`-based tiering, the maximum quantity within a period determines the per unit price.\n- In `graduated` tiering, pricing can change as the quantity grows.'),
|
|
7897
|
+
tiers: zod
|
|
7898
|
+
.array(zod
|
|
7833
7899
|
.object({
|
|
7834
|
-
|
|
7900
|
+
flatPrice: zod
|
|
7901
|
+
.object({
|
|
7902
|
+
amount: zod.coerce
|
|
7903
|
+
.string()
|
|
7904
|
+
.regex(exports.createPlanBodyPhasesItemRateCardsItemTwoPriceOneThreeTiersItemFlatPriceOneAmountOneRegExp)
|
|
7905
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
7906
|
+
.describe('The amount of the flat price.'),
|
|
7907
|
+
type: zod
|
|
7908
|
+
.enum(['flat'])
|
|
7909
|
+
.describe('The type of the price.'),
|
|
7910
|
+
})
|
|
7911
|
+
.describe('Flat price.')
|
|
7912
|
+
.nullable()
|
|
7913
|
+
.describe('The flat price component of the tier.'),
|
|
7914
|
+
unitPrice: zod
|
|
7915
|
+
.object({
|
|
7916
|
+
amount: zod.coerce
|
|
7917
|
+
.string()
|
|
7918
|
+
.regex(exports.createPlanBodyPhasesItemRateCardsItemTwoPriceOneThreeTiersItemUnitPriceOneAmountOneRegExp)
|
|
7919
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
7920
|
+
.describe('The amount of the unit price.'),
|
|
7921
|
+
type: zod
|
|
7922
|
+
.enum(['unit'])
|
|
7923
|
+
.describe('The type of the price.'),
|
|
7924
|
+
})
|
|
7925
|
+
.describe('Unit price.')
|
|
7926
|
+
.nullable()
|
|
7927
|
+
.describe('The unit price component of the tier.'),
|
|
7928
|
+
upToAmount: zod.coerce
|
|
7835
7929
|
.string()
|
|
7836
|
-
.regex(exports.
|
|
7930
|
+
.regex(exports.createPlanBodyPhasesItemRateCardsItemTwoPriceOneThreeTiersItemUpToAmountOneRegExp)
|
|
7837
7931
|
.describe('Numeric represents an arbitrary precision number.')
|
|
7838
|
-
.
|
|
7839
|
-
|
|
7840
|
-
.enum(['unit'])
|
|
7841
|
-
.describe('The type of the price.'),
|
|
7932
|
+
.optional()
|
|
7933
|
+
.describe('Up to and including to this quantity will be contained in the tier.\nIf null, the tier is open-ended.'),
|
|
7842
7934
|
})
|
|
7843
|
-
.describe('
|
|
7844
|
-
.
|
|
7845
|
-
.describe('The
|
|
7846
|
-
|
|
7935
|
+
.describe('A price tier.\nAt least one price component is required in each tier.'))
|
|
7936
|
+
.min(1)
|
|
7937
|
+
.describe('The tiers of the tiered price.\nAt least one price component is required in each tier.'),
|
|
7938
|
+
type: zod
|
|
7939
|
+
.enum(['tiered'])
|
|
7940
|
+
.describe('The type of the price.\n\nOne of: flat, unit, or tiered.'),
|
|
7941
|
+
})
|
|
7942
|
+
.describe('Tiered price with spend commitments.'),
|
|
7943
|
+
zod
|
|
7944
|
+
.object({
|
|
7945
|
+
maximumAmount: zod.coerce
|
|
7847
7946
|
.string()
|
|
7848
|
-
.regex(exports.
|
|
7947
|
+
.regex(exports.createPlanBodyPhasesItemRateCardsItemTwoPriceOneFourMaximumAmountOneRegExp)
|
|
7849
7948
|
.describe('Numeric represents an arbitrary precision number.')
|
|
7850
7949
|
.optional()
|
|
7851
|
-
.describe('
|
|
7950
|
+
.describe('The customer is limited to spend at most the amount.'),
|
|
7951
|
+
minimumAmount: zod.coerce
|
|
7952
|
+
.string()
|
|
7953
|
+
.regex(exports.createPlanBodyPhasesItemRateCardsItemTwoPriceOneFourMinimumAmountOneRegExp)
|
|
7954
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
7955
|
+
.optional()
|
|
7956
|
+
.describe('The customer is committed to spend at least the amount.'),
|
|
7957
|
+
multiplier: zod.coerce
|
|
7958
|
+
.string()
|
|
7959
|
+
.regex(exports.createPlanBodyPhasesItemRateCardsItemTwoPriceOneFourMultiplierOneRegExp)
|
|
7960
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
7961
|
+
.default(exports.createPlanBodyPhasesItemRateCardsItemTwoPriceOneFourMultiplierDefault)
|
|
7962
|
+
.describe('The multiplier to apply to the base price to get the dynamic price.\n\nExamples:\n- 0.0: the price is zero\n- 0.5: the price is 50% of the base price\n- 1.0: the price is the same as the base price\n- 1.5: the price is 150% of the base price'),
|
|
7963
|
+
type: zod
|
|
7964
|
+
.enum(['dynamic'])
|
|
7965
|
+
.describe('The type of the price.'),
|
|
7852
7966
|
})
|
|
7853
|
-
.describe('
|
|
7854
|
-
|
|
7855
|
-
.
|
|
7856
|
-
|
|
7857
|
-
|
|
7858
|
-
|
|
7859
|
-
|
|
7860
|
-
|
|
7861
|
-
|
|
7862
|
-
|
|
7863
|
-
|
|
7864
|
-
|
|
7865
|
-
|
|
7866
|
-
|
|
7867
|
-
.
|
|
7868
|
-
|
|
7869
|
-
|
|
7870
|
-
|
|
7871
|
-
|
|
7872
|
-
|
|
7873
|
-
.
|
|
7874
|
-
|
|
7875
|
-
|
|
7876
|
-
|
|
7877
|
-
|
|
7878
|
-
|
|
7879
|
-
|
|
7880
|
-
|
|
7881
|
-
|
|
7882
|
-
.
|
|
7883
|
-
|
|
7884
|
-
|
|
7885
|
-
|
|
7886
|
-
zod
|
|
7887
|
-
.object({
|
|
7888
|
-
amount: zod.coerce
|
|
7889
|
-
.string()
|
|
7890
|
-
.regex(exports.createPlanBodyPhasesItemRateCardsItemTwoPriceOneFiveAmountOneRegExp)
|
|
7891
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
7892
|
-
.describe('The price of one package.'),
|
|
7893
|
-
maximumAmount: zod.coerce
|
|
7894
|
-
.string()
|
|
7895
|
-
.regex(exports.createPlanBodyPhasesItemRateCardsItemTwoPriceOneFiveMaximumAmountOneRegExp)
|
|
7896
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
7897
|
-
.optional()
|
|
7898
|
-
.describe('The customer is limited to spend at most the amount.'),
|
|
7899
|
-
minimumAmount: zod.coerce
|
|
7900
|
-
.string()
|
|
7901
|
-
.regex(exports.createPlanBodyPhasesItemRateCardsItemTwoPriceOneFiveMinimumAmountOneRegExp)
|
|
7902
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
7903
|
-
.optional()
|
|
7904
|
-
.describe('The customer is committed to spend at least the amount.'),
|
|
7905
|
-
quantityPerPackage: zod.coerce
|
|
7906
|
-
.string()
|
|
7907
|
-
.regex(exports.createPlanBodyPhasesItemRateCardsItemTwoPriceOneFiveQuantityPerPackageOneRegExp)
|
|
7908
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
7909
|
-
.describe('The quantity per package.'),
|
|
7910
|
-
type: zod
|
|
7911
|
-
.enum(['package'])
|
|
7912
|
-
.describe('The type of the price.'),
|
|
7913
|
-
})
|
|
7914
|
-
.describe('Package price with spend commitments.'),
|
|
7967
|
+
.describe('Dynamic price with spend commitments.'),
|
|
7968
|
+
zod
|
|
7969
|
+
.object({
|
|
7970
|
+
amount: zod.coerce
|
|
7971
|
+
.string()
|
|
7972
|
+
.regex(exports.createPlanBodyPhasesItemRateCardsItemTwoPriceOneFiveAmountOneRegExp)
|
|
7973
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
7974
|
+
.describe('The price of one package.'),
|
|
7975
|
+
maximumAmount: zod.coerce
|
|
7976
|
+
.string()
|
|
7977
|
+
.regex(exports.createPlanBodyPhasesItemRateCardsItemTwoPriceOneFiveMaximumAmountOneRegExp)
|
|
7978
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
7979
|
+
.optional()
|
|
7980
|
+
.describe('The customer is limited to spend at most the amount.'),
|
|
7981
|
+
minimumAmount: zod.coerce
|
|
7982
|
+
.string()
|
|
7983
|
+
.regex(exports.createPlanBodyPhasesItemRateCardsItemTwoPriceOneFiveMinimumAmountOneRegExp)
|
|
7984
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
7985
|
+
.optional()
|
|
7986
|
+
.describe('The customer is committed to spend at least the amount.'),
|
|
7987
|
+
quantityPerPackage: zod.coerce
|
|
7988
|
+
.string()
|
|
7989
|
+
.regex(exports.createPlanBodyPhasesItemRateCardsItemTwoPriceOneFiveQuantityPerPackageOneRegExp)
|
|
7990
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
7991
|
+
.describe('The quantity per package.'),
|
|
7992
|
+
type: zod
|
|
7993
|
+
.enum(['package'])
|
|
7994
|
+
.describe('The type of the price.'),
|
|
7995
|
+
})
|
|
7996
|
+
.describe('Package price with spend commitments.'),
|
|
7997
|
+
])
|
|
7998
|
+
.describe('The price of the usage based rate card.'),
|
|
7999
|
+
zod.null(),
|
|
7915
8000
|
])
|
|
7916
|
-
.describe('The price of the usage based rate card.')
|
|
7917
|
-
.nullable()
|
|
7918
8001
|
.describe('The price of the rate card.\nWhen null, the feature or service is free.'),
|
|
7919
8002
|
taxConfig: zod
|
|
7920
8003
|
.object({
|
|
@@ -8183,6 +8266,7 @@ exports.UpdatePlanBody = zod
|
|
|
8183
8266
|
.describe('You can grant usage automatically alongside the entitlement, the example scenario would be creating a starting balance.\nIf an amount is specified here, a grant will be created alongside the entitlement with the specified amount.\nThat grant will have it\'s rollover settings configured in a way that after each reset operation, the balance will return the original amount specified here.\nManually creating such a grant would mean having the "amount", "minRolloverAmount", and "maxRolloverAmount" fields all be the same.'),
|
|
8184
8267
|
issueAfterResetPriority: zod.coerce
|
|
8185
8268
|
.number()
|
|
8269
|
+
.int()
|
|
8186
8270
|
.min(1)
|
|
8187
8271
|
.max(exports.updatePlanBodyPhasesItemRateCardsItemOneEntitlementTemplateOneOneIssueAfterResetPriorityMax)
|
|
8188
8272
|
.default(exports.updatePlanBodyPhasesItemRateCardsItemOneEntitlementTemplateOneOneIssueAfterResetPriorityDefault)
|
|
@@ -8364,6 +8448,7 @@ exports.UpdatePlanBody = zod
|
|
|
8364
8448
|
.describe('You can grant usage automatically alongside the entitlement, the example scenario would be creating a starting balance.\nIf an amount is specified here, a grant will be created alongside the entitlement with the specified amount.\nThat grant will have it\'s rollover settings configured in a way that after each reset operation, the balance will return the original amount specified here.\nManually creating such a grant would mean having the "amount", "minRolloverAmount", and "maxRolloverAmount" fields all be the same.'),
|
|
8365
8449
|
issueAfterResetPriority: zod.coerce
|
|
8366
8450
|
.number()
|
|
8451
|
+
.int()
|
|
8367
8452
|
.min(1)
|
|
8368
8453
|
.max(exports.updatePlanBodyPhasesItemRateCardsItemTwoEntitlementTemplateOneOneIssueAfterResetPriorityMax)
|
|
8369
8454
|
.default(exports.updatePlanBodyPhasesItemRateCardsItemTwoEntitlementTemplateOneOneIssueAfterResetPriorityDefault)
|
|
@@ -8437,167 +8522,170 @@ exports.UpdatePlanBody = zod
|
|
|
8437
8522
|
price: zod
|
|
8438
8523
|
.union([
|
|
8439
8524
|
zod
|
|
8440
|
-
.
|
|
8441
|
-
|
|
8442
|
-
.string()
|
|
8443
|
-
.regex(exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneOneAmountOneRegExp)
|
|
8444
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
8445
|
-
.describe('The amount of the flat price.'),
|
|
8446
|
-
paymentTerm: zod
|
|
8447
|
-
.enum(['in_advance', 'in_arrears'])
|
|
8448
|
-
.describe('The payment term of a flat price.\nOne of: in_advance or in_arrears.')
|
|
8449
|
-
.default(exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneOnePaymentTermDefault)
|
|
8450
|
-
.describe('The payment term of the flat price.\nDefaults to in advance.'),
|
|
8451
|
-
type: zod
|
|
8452
|
-
.enum(['flat'])
|
|
8453
|
-
.describe('The type of the price.'),
|
|
8454
|
-
})
|
|
8455
|
-
.describe('Flat price with payment term.'),
|
|
8456
|
-
zod
|
|
8457
|
-
.object({
|
|
8458
|
-
amount: zod.coerce
|
|
8459
|
-
.string()
|
|
8460
|
-
.regex(exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneTwoAmountOneRegExp)
|
|
8461
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
8462
|
-
.describe('The amount of the unit price.'),
|
|
8463
|
-
maximumAmount: zod.coerce
|
|
8464
|
-
.string()
|
|
8465
|
-
.regex(exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneTwoMaximumAmountOneRegExp)
|
|
8466
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
8467
|
-
.optional()
|
|
8468
|
-
.describe('The customer is limited to spend at most the amount.'),
|
|
8469
|
-
minimumAmount: zod.coerce
|
|
8470
|
-
.string()
|
|
8471
|
-
.regex(exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneTwoMinimumAmountOneRegExp)
|
|
8472
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
8473
|
-
.optional()
|
|
8474
|
-
.describe('The customer is committed to spend at least the amount.'),
|
|
8475
|
-
type: zod
|
|
8476
|
-
.enum(['unit'])
|
|
8477
|
-
.describe('The type of the price.'),
|
|
8478
|
-
})
|
|
8479
|
-
.describe('Unit price with spend commitments.'),
|
|
8480
|
-
zod
|
|
8481
|
-
.object({
|
|
8482
|
-
maximumAmount: zod.coerce
|
|
8483
|
-
.string()
|
|
8484
|
-
.regex(exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneThreeMaximumAmountOneRegExp)
|
|
8485
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
8486
|
-
.optional()
|
|
8487
|
-
.describe('The customer is limited to spend at most the amount.'),
|
|
8488
|
-
minimumAmount: zod.coerce
|
|
8489
|
-
.string()
|
|
8490
|
-
.regex(exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneThreeMinimumAmountOneRegExp)
|
|
8491
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
8492
|
-
.optional()
|
|
8493
|
-
.describe('The customer is committed to spend at least the amount.'),
|
|
8494
|
-
mode: zod
|
|
8495
|
-
.enum(['volume', 'graduated'])
|
|
8496
|
-
.describe('The mode of the tiered price.')
|
|
8497
|
-
.describe('Defines if the tiering mode is volume-based or graduated:\n- In `volume`-based tiering, the maximum quantity within a period determines the per unit price.\n- In `graduated` tiering, pricing can change as the quantity grows.'),
|
|
8498
|
-
tiers: zod
|
|
8499
|
-
.array(zod
|
|
8525
|
+
.union([
|
|
8526
|
+
zod
|
|
8500
8527
|
.object({
|
|
8501
|
-
|
|
8502
|
-
.
|
|
8503
|
-
|
|
8504
|
-
|
|
8505
|
-
|
|
8506
|
-
|
|
8507
|
-
|
|
8508
|
-
|
|
8509
|
-
|
|
8510
|
-
|
|
8511
|
-
|
|
8512
|
-
.
|
|
8513
|
-
.
|
|
8514
|
-
|
|
8515
|
-
|
|
8528
|
+
amount: zod.coerce
|
|
8529
|
+
.string()
|
|
8530
|
+
.regex(exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneOneAmountOneRegExp)
|
|
8531
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
8532
|
+
.describe('The amount of the flat price.'),
|
|
8533
|
+
paymentTerm: zod
|
|
8534
|
+
.enum(['in_advance', 'in_arrears'])
|
|
8535
|
+
.describe('The payment term of a flat price.\nOne of: in_advance or in_arrears.')
|
|
8536
|
+
.default(exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneOnePaymentTermDefault)
|
|
8537
|
+
.describe('The payment term of the flat price.\nDefaults to in advance.'),
|
|
8538
|
+
type: zod
|
|
8539
|
+
.enum(['flat'])
|
|
8540
|
+
.describe('The type of the price.'),
|
|
8541
|
+
})
|
|
8542
|
+
.describe('Flat price with payment term.'),
|
|
8543
|
+
zod
|
|
8544
|
+
.object({
|
|
8545
|
+
amount: zod.coerce
|
|
8546
|
+
.string()
|
|
8547
|
+
.regex(exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneTwoAmountOneRegExp)
|
|
8548
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
8549
|
+
.describe('The amount of the unit price.'),
|
|
8550
|
+
maximumAmount: zod.coerce
|
|
8551
|
+
.string()
|
|
8552
|
+
.regex(exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneTwoMaximumAmountOneRegExp)
|
|
8553
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
8554
|
+
.optional()
|
|
8555
|
+
.describe('The customer is limited to spend at most the amount.'),
|
|
8556
|
+
minimumAmount: zod.coerce
|
|
8557
|
+
.string()
|
|
8558
|
+
.regex(exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneTwoMinimumAmountOneRegExp)
|
|
8559
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
8560
|
+
.optional()
|
|
8561
|
+
.describe('The customer is committed to spend at least the amount.'),
|
|
8562
|
+
type: zod
|
|
8563
|
+
.enum(['unit'])
|
|
8564
|
+
.describe('The type of the price.'),
|
|
8565
|
+
})
|
|
8566
|
+
.describe('Unit price with spend commitments.'),
|
|
8567
|
+
zod
|
|
8568
|
+
.object({
|
|
8569
|
+
maximumAmount: zod.coerce
|
|
8570
|
+
.string()
|
|
8571
|
+
.regex(exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneThreeMaximumAmountOneRegExp)
|
|
8572
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
8573
|
+
.optional()
|
|
8574
|
+
.describe('The customer is limited to spend at most the amount.'),
|
|
8575
|
+
minimumAmount: zod.coerce
|
|
8576
|
+
.string()
|
|
8577
|
+
.regex(exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneThreeMinimumAmountOneRegExp)
|
|
8578
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
8579
|
+
.optional()
|
|
8580
|
+
.describe('The customer is committed to spend at least the amount.'),
|
|
8581
|
+
mode: zod
|
|
8582
|
+
.enum(['volume', 'graduated'])
|
|
8583
|
+
.describe('The mode of the tiered price.')
|
|
8584
|
+
.describe('Defines if the tiering mode is volume-based or graduated:\n- In `volume`-based tiering, the maximum quantity within a period determines the per unit price.\n- In `graduated` tiering, pricing can change as the quantity grows.'),
|
|
8585
|
+
tiers: zod
|
|
8586
|
+
.array(zod
|
|
8516
8587
|
.object({
|
|
8517
|
-
|
|
8588
|
+
flatPrice: zod
|
|
8589
|
+
.object({
|
|
8590
|
+
amount: zod.coerce
|
|
8591
|
+
.string()
|
|
8592
|
+
.regex(exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneThreeTiersItemFlatPriceOneAmountOneRegExp)
|
|
8593
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
8594
|
+
.describe('The amount of the flat price.'),
|
|
8595
|
+
type: zod
|
|
8596
|
+
.enum(['flat'])
|
|
8597
|
+
.describe('The type of the price.'),
|
|
8598
|
+
})
|
|
8599
|
+
.describe('Flat price.')
|
|
8600
|
+
.nullable()
|
|
8601
|
+
.describe('The flat price component of the tier.'),
|
|
8602
|
+
unitPrice: zod
|
|
8603
|
+
.object({
|
|
8604
|
+
amount: zod.coerce
|
|
8605
|
+
.string()
|
|
8606
|
+
.regex(exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneThreeTiersItemUnitPriceOneAmountOneRegExp)
|
|
8607
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
8608
|
+
.describe('The amount of the unit price.'),
|
|
8609
|
+
type: zod
|
|
8610
|
+
.enum(['unit'])
|
|
8611
|
+
.describe('The type of the price.'),
|
|
8612
|
+
})
|
|
8613
|
+
.describe('Unit price.')
|
|
8614
|
+
.nullable()
|
|
8615
|
+
.describe('The unit price component of the tier.'),
|
|
8616
|
+
upToAmount: zod.coerce
|
|
8518
8617
|
.string()
|
|
8519
|
-
.regex(exports.
|
|
8618
|
+
.regex(exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneThreeTiersItemUpToAmountOneRegExp)
|
|
8520
8619
|
.describe('Numeric represents an arbitrary precision number.')
|
|
8521
|
-
.
|
|
8522
|
-
|
|
8523
|
-
.enum(['unit'])
|
|
8524
|
-
.describe('The type of the price.'),
|
|
8620
|
+
.optional()
|
|
8621
|
+
.describe('Up to and including to this quantity will be contained in the tier.\nIf null, the tier is open-ended.'),
|
|
8525
8622
|
})
|
|
8526
|
-
.describe('
|
|
8527
|
-
.
|
|
8528
|
-
.describe('The
|
|
8529
|
-
|
|
8623
|
+
.describe('A price tier.\nAt least one price component is required in each tier.'))
|
|
8624
|
+
.min(1)
|
|
8625
|
+
.describe('The tiers of the tiered price.\nAt least one price component is required in each tier.'),
|
|
8626
|
+
type: zod
|
|
8627
|
+
.enum(['tiered'])
|
|
8628
|
+
.describe('The type of the price.\n\nOne of: flat, unit, or tiered.'),
|
|
8629
|
+
})
|
|
8630
|
+
.describe('Tiered price with spend commitments.'),
|
|
8631
|
+
zod
|
|
8632
|
+
.object({
|
|
8633
|
+
maximumAmount: zod.coerce
|
|
8530
8634
|
.string()
|
|
8531
|
-
.regex(exports.
|
|
8635
|
+
.regex(exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneFourMaximumAmountOneRegExp)
|
|
8532
8636
|
.describe('Numeric represents an arbitrary precision number.')
|
|
8533
8637
|
.optional()
|
|
8534
|
-
.describe('
|
|
8638
|
+
.describe('The customer is limited to spend at most the amount.'),
|
|
8639
|
+
minimumAmount: zod.coerce
|
|
8640
|
+
.string()
|
|
8641
|
+
.regex(exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneFourMinimumAmountOneRegExp)
|
|
8642
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
8643
|
+
.optional()
|
|
8644
|
+
.describe('The customer is committed to spend at least the amount.'),
|
|
8645
|
+
multiplier: zod.coerce
|
|
8646
|
+
.string()
|
|
8647
|
+
.regex(exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneFourMultiplierOneRegExp)
|
|
8648
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
8649
|
+
.default(exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneFourMultiplierDefault)
|
|
8650
|
+
.describe('The multiplier to apply to the base price to get the dynamic price.\n\nExamples:\n- 0.0: the price is zero\n- 0.5: the price is 50% of the base price\n- 1.0: the price is the same as the base price\n- 1.5: the price is 150% of the base price'),
|
|
8651
|
+
type: zod
|
|
8652
|
+
.enum(['dynamic'])
|
|
8653
|
+
.describe('The type of the price.'),
|
|
8535
8654
|
})
|
|
8536
|
-
.describe('
|
|
8537
|
-
|
|
8538
|
-
.
|
|
8539
|
-
|
|
8540
|
-
|
|
8541
|
-
|
|
8542
|
-
|
|
8543
|
-
|
|
8544
|
-
|
|
8545
|
-
|
|
8546
|
-
|
|
8547
|
-
|
|
8548
|
-
|
|
8549
|
-
|
|
8550
|
-
.
|
|
8551
|
-
|
|
8552
|
-
|
|
8553
|
-
|
|
8554
|
-
|
|
8555
|
-
|
|
8556
|
-
.
|
|
8557
|
-
|
|
8558
|
-
|
|
8559
|
-
|
|
8560
|
-
|
|
8561
|
-
|
|
8562
|
-
|
|
8563
|
-
|
|
8564
|
-
|
|
8565
|
-
.
|
|
8566
|
-
|
|
8567
|
-
|
|
8568
|
-
|
|
8569
|
-
zod
|
|
8570
|
-
.object({
|
|
8571
|
-
amount: zod.coerce
|
|
8572
|
-
.string()
|
|
8573
|
-
.regex(exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneFiveAmountOneRegExp)
|
|
8574
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
8575
|
-
.describe('The price of one package.'),
|
|
8576
|
-
maximumAmount: zod.coerce
|
|
8577
|
-
.string()
|
|
8578
|
-
.regex(exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneFiveMaximumAmountOneRegExp)
|
|
8579
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
8580
|
-
.optional()
|
|
8581
|
-
.describe('The customer is limited to spend at most the amount.'),
|
|
8582
|
-
minimumAmount: zod.coerce
|
|
8583
|
-
.string()
|
|
8584
|
-
.regex(exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneFiveMinimumAmountOneRegExp)
|
|
8585
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
8586
|
-
.optional()
|
|
8587
|
-
.describe('The customer is committed to spend at least the amount.'),
|
|
8588
|
-
quantityPerPackage: zod.coerce
|
|
8589
|
-
.string()
|
|
8590
|
-
.regex(exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneFiveQuantityPerPackageOneRegExp)
|
|
8591
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
8592
|
-
.describe('The quantity per package.'),
|
|
8593
|
-
type: zod
|
|
8594
|
-
.enum(['package'])
|
|
8595
|
-
.describe('The type of the price.'),
|
|
8596
|
-
})
|
|
8597
|
-
.describe('Package price with spend commitments.'),
|
|
8655
|
+
.describe('Dynamic price with spend commitments.'),
|
|
8656
|
+
zod
|
|
8657
|
+
.object({
|
|
8658
|
+
amount: zod.coerce
|
|
8659
|
+
.string()
|
|
8660
|
+
.regex(exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneFiveAmountOneRegExp)
|
|
8661
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
8662
|
+
.describe('The price of one package.'),
|
|
8663
|
+
maximumAmount: zod.coerce
|
|
8664
|
+
.string()
|
|
8665
|
+
.regex(exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneFiveMaximumAmountOneRegExp)
|
|
8666
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
8667
|
+
.optional()
|
|
8668
|
+
.describe('The customer is limited to spend at most the amount.'),
|
|
8669
|
+
minimumAmount: zod.coerce
|
|
8670
|
+
.string()
|
|
8671
|
+
.regex(exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneFiveMinimumAmountOneRegExp)
|
|
8672
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
8673
|
+
.optional()
|
|
8674
|
+
.describe('The customer is committed to spend at least the amount.'),
|
|
8675
|
+
quantityPerPackage: zod.coerce
|
|
8676
|
+
.string()
|
|
8677
|
+
.regex(exports.updatePlanBodyPhasesItemRateCardsItemTwoPriceOneFiveQuantityPerPackageOneRegExp)
|
|
8678
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
8679
|
+
.describe('The quantity per package.'),
|
|
8680
|
+
type: zod
|
|
8681
|
+
.enum(['package'])
|
|
8682
|
+
.describe('The type of the price.'),
|
|
8683
|
+
})
|
|
8684
|
+
.describe('Package price with spend commitments.'),
|
|
8685
|
+
])
|
|
8686
|
+
.describe('The price of the usage based rate card.'),
|
|
8687
|
+
zod.null(),
|
|
8598
8688
|
])
|
|
8599
|
-
.describe('The price of the usage based rate card.')
|
|
8600
|
-
.nullable()
|
|
8601
8689
|
.describe('The price of the rate card.\nWhen null, the feature or service is free.'),
|
|
8602
8690
|
taxConfig: zod
|
|
8603
8691
|
.object({
|
|
@@ -8741,7 +8829,7 @@ exports.ListPlanAddonsQueryParams = zod.object({
|
|
|
8741
8829
|
.optional()
|
|
8742
8830
|
.describe('Filter by addon.key attribute.'),
|
|
8743
8831
|
keyVersion: zod
|
|
8744
|
-
.record(zod.string(), zod.array(zod.coerce.number()))
|
|
8832
|
+
.record(zod.string(), zod.array(zod.coerce.number().int()))
|
|
8745
8833
|
.optional()
|
|
8746
8834
|
.describe('Filter by addon.key and addon.version attributes.'),
|
|
8747
8835
|
order: zod
|
|
@@ -8755,11 +8843,13 @@ exports.ListPlanAddonsQueryParams = zod.object({
|
|
|
8755
8843
|
.describe('The order by field.'),
|
|
8756
8844
|
page: zod.coerce
|
|
8757
8845
|
.number()
|
|
8846
|
+
.int()
|
|
8758
8847
|
.min(1)
|
|
8759
8848
|
.default(exports.listPlanAddonsQueryPageDefault)
|
|
8760
8849
|
.describe('Page index.\n\nDefault is 1.'),
|
|
8761
8850
|
pageSize: zod.coerce
|
|
8762
8851
|
.number()
|
|
8852
|
+
.int()
|
|
8763
8853
|
.min(1)
|
|
8764
8854
|
.max(exports.listPlanAddonsQueryPageSizeMax)
|
|
8765
8855
|
.default(exports.listPlanAddonsQueryPageSizeDefault)
|
|
@@ -8785,6 +8875,7 @@ exports.CreatePlanAddonBody = zod
|
|
|
8785
8875
|
.describe('The key of the plan phase from the add-on becomes available for purchase.'),
|
|
8786
8876
|
maxQuantity: zod.coerce
|
|
8787
8877
|
.number()
|
|
8878
|
+
.int()
|
|
8788
8879
|
.optional()
|
|
8789
8880
|
.describe('The maximum number of times the add-on can be purchased for the plan.\nIt is not applicable for add-ons with single instance type.'),
|
|
8790
8881
|
metadata: zod
|
|
@@ -8811,6 +8902,7 @@ exports.UpdatePlanAddonBody = zod
|
|
|
8811
8902
|
.describe('The key of the plan phase from the add-on becomes available for purchase.'),
|
|
8812
8903
|
maxQuantity: zod.coerce
|
|
8813
8904
|
.number()
|
|
8905
|
+
.int()
|
|
8814
8906
|
.optional()
|
|
8815
8907
|
.describe('The maximum number of times the add-on can be purchased for the plan.\nIt is not applicable for add-ons with single instance type.'),
|
|
8816
8908
|
metadata: zod
|
|
@@ -8913,7 +9005,12 @@ exports.QueryPortalMeterQueryParams = zod.object({
|
|
|
8913
9005
|
.optional()
|
|
8914
9006
|
.describe('End date-time in RFC 3339 format.\n\nInclusive.\n\nFor example: ?to=2025-02-01T00%3A00%3A00.000Z'),
|
|
8915
9007
|
windowSize: zod
|
|
8916
|
-
.enum(
|
|
9008
|
+
.enum({
|
|
9009
|
+
Day: 'DAY',
|
|
9010
|
+
Hour: 'HOUR',
|
|
9011
|
+
Minute: 'MINUTE',
|
|
9012
|
+
Month: 'MONTH',
|
|
9013
|
+
})
|
|
8917
9014
|
.optional()
|
|
8918
9015
|
.describe('If not specified, a single usage aggregate will be returned for the entirety of the specified period for each subject and group.\n\nFor example: ?windowSize=DAY'),
|
|
8919
9016
|
windowTimeZone: zod.coerce
|
|
@@ -8943,6 +9040,7 @@ exports.listPortalTokensQueryLimitMax = 100;
|
|
|
8943
9040
|
exports.ListPortalTokensQueryParams = zod.object({
|
|
8944
9041
|
limit: zod.coerce
|
|
8945
9042
|
.number()
|
|
9043
|
+
.int()
|
|
8946
9044
|
.min(1)
|
|
8947
9045
|
.max(exports.listPortalTokensQueryLimitMax)
|
|
8948
9046
|
.default(exports.listPortalTokensQueryLimitDefault),
|
|
@@ -9207,6 +9305,7 @@ exports.CreateStripeCheckoutSessionBody = zod
|
|
|
9207
9305
|
.describe('Display additional text for your customers using custom text.'),
|
|
9208
9306
|
expiresAt: zod.coerce
|
|
9209
9307
|
.number()
|
|
9308
|
+
.int()
|
|
9210
9309
|
.optional()
|
|
9211
9310
|
.describe('The Epoch time in seconds at which the Checkout Session will expire.\nIt can be anywhere from 30 minutes to 24 hours after Checkout Session creation. By default, this value is 24 hours from creation.'),
|
|
9212
9311
|
locale: zod.coerce.string().optional(),
|
|
@@ -9380,6 +9479,7 @@ exports.CreateEntitlementBody = zod
|
|
|
9380
9479
|
.describe('You can grant usage automatically alongside the entitlement, the example scenario would be creating a starting balance.\nIf an amount is specified here, a grant will be created alongside the entitlement with the specified amount.\nThat grant will have it\'s rollover settings configured in a way that after each reset operation, the balance will return the original amount specified here.\nManually creating such a grant would mean having the "amount", "minRolloverAmount", and "maxRolloverAmount" fields all be the same.'),
|
|
9381
9480
|
issueAfterResetPriority: zod.coerce
|
|
9382
9481
|
.number()
|
|
9482
|
+
.int()
|
|
9383
9483
|
.min(1)
|
|
9384
9484
|
.max(exports.createEntitlementBodyOneIssueAfterResetPriorityMax)
|
|
9385
9485
|
.default(exports.createEntitlementBodyOneIssueAfterResetPriorityDefault)
|
|
@@ -9391,7 +9491,10 @@ exports.CreateEntitlementBody = zod
|
|
|
9391
9491
|
measureUsageFrom: zod
|
|
9392
9492
|
.union([
|
|
9393
9493
|
zod
|
|
9394
|
-
.enum(
|
|
9494
|
+
.enum({
|
|
9495
|
+
CurrentPeriodStart: 'CURRENT_PERIOD_START',
|
|
9496
|
+
Now: 'NOW',
|
|
9497
|
+
})
|
|
9395
9498
|
.describe('Start of measurement options'),
|
|
9396
9499
|
zod.coerce
|
|
9397
9500
|
.date()
|
|
@@ -9601,6 +9704,7 @@ exports.CreateGrantBody = zod
|
|
|
9601
9704
|
.object({
|
|
9602
9705
|
count: zod.coerce
|
|
9603
9706
|
.number()
|
|
9707
|
+
.int()
|
|
9604
9708
|
.min(1)
|
|
9605
9709
|
.max(exports.createGrantBodyExpirationOneCountMax)
|
|
9606
9710
|
.describe('The number of time units in the expiration period.'),
|
|
@@ -9626,6 +9730,7 @@ exports.CreateGrantBody = zod
|
|
|
9626
9730
|
.describe('Grants are rolled over at reset, after which they can have a different balance compared to what they had before the reset.\nBalance after the reset is calculated as: Balance_After_Reset = MIN(MaxRolloverAmount, MAX(Balance_Before_Reset, MinRolloverAmount))'),
|
|
9627
9731
|
priority: zod.coerce
|
|
9628
9732
|
.number()
|
|
9733
|
+
.int()
|
|
9629
9734
|
.min(1)
|
|
9630
9735
|
.max(exports.createGrantBodyPriorityMax)
|
|
9631
9736
|
.optional()
|
|
@@ -9711,6 +9816,7 @@ exports.OverrideEntitlementBody = zod
|
|
|
9711
9816
|
.describe('You can grant usage automatically alongside the entitlement, the example scenario would be creating a starting balance.\nIf an amount is specified here, a grant will be created alongside the entitlement with the specified amount.\nThat grant will have it\'s rollover settings configured in a way that after each reset operation, the balance will return the original amount specified here.\nManually creating such a grant would mean having the "amount", "minRolloverAmount", and "maxRolloverAmount" fields all be the same.'),
|
|
9712
9817
|
issueAfterResetPriority: zod.coerce
|
|
9713
9818
|
.number()
|
|
9819
|
+
.int()
|
|
9714
9820
|
.min(1)
|
|
9715
9821
|
.max(exports.overrideEntitlementBodyOneIssueAfterResetPriorityMax)
|
|
9716
9822
|
.default(exports.overrideEntitlementBodyOneIssueAfterResetPriorityDefault)
|
|
@@ -9722,7 +9828,10 @@ exports.OverrideEntitlementBody = zod
|
|
|
9722
9828
|
measureUsageFrom: zod
|
|
9723
9829
|
.union([
|
|
9724
9830
|
zod
|
|
9725
|
-
.enum(
|
|
9831
|
+
.enum({
|
|
9832
|
+
CurrentPeriodStart: 'CURRENT_PERIOD_START',
|
|
9833
|
+
Now: 'NOW',
|
|
9834
|
+
})
|
|
9726
9835
|
.describe('Start of measurement options'),
|
|
9727
9836
|
zod.coerce
|
|
9728
9837
|
.date()
|
|
@@ -9919,7 +10028,12 @@ exports.GetEntitlementHistoryQueryParams = zod.object({
|
|
|
9919
10028
|
.optional()
|
|
9920
10029
|
.describe('End of time range to query entitlement: date-time in RFC 3339 format. Defaults to now.\nIf not now then gets truncated to the granularity of the underlying meter.'),
|
|
9921
10030
|
windowSize: zod
|
|
9922
|
-
.enum(
|
|
10031
|
+
.enum({
|
|
10032
|
+
Day: 'DAY',
|
|
10033
|
+
Hour: 'HOUR',
|
|
10034
|
+
Minute: 'MINUTE',
|
|
10035
|
+
Month: 'MONTH',
|
|
10036
|
+
})
|
|
9923
10037
|
.describe('Windowsize'),
|
|
9924
10038
|
windowTimeZone: zod.coerce
|
|
9925
10039
|
.string()
|
|
@@ -9960,9 +10074,11 @@ exports.ResetEntitlementUsageBody = zod
|
|
|
9960
10074
|
*/
|
|
9961
10075
|
exports.createSubscriptionBodyOnePlanOneKeyMax = 64;
|
|
9962
10076
|
exports.createSubscriptionBodyOnePlanOneKeyRegExp = /^[a-z0-9]+(?:_[a-z0-9]+)*$/;
|
|
10077
|
+
exports.createSubscriptionBodyOneCostBasisModeDefault = 'dynamic';
|
|
9963
10078
|
exports.createSubscriptionBodyOneTimingDefault = 'immediate';
|
|
9964
10079
|
exports.createSubscriptionBodyOneCustomerIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
9965
10080
|
exports.createSubscriptionBodyOneCustomerKeyMax = 256;
|
|
10081
|
+
exports.createSubscriptionBodyTwoCostBasisModeDefault = 'dynamic';
|
|
9966
10082
|
exports.createSubscriptionBodyTwoCustomPlanOneOneNameMax = 256;
|
|
9967
10083
|
exports.createSubscriptionBodyTwoCustomPlanOneOneDescriptionMax = 1024;
|
|
9968
10084
|
exports.createSubscriptionBodyTwoCustomPlanOneOneCurrencyOneMin = 3;
|
|
@@ -10049,6 +10165,11 @@ exports.CreateSubscriptionBody = zod
|
|
|
10049
10165
|
.date()
|
|
10050
10166
|
.optional()
|
|
10051
10167
|
.describe('The billing anchor of the subscription. The provided date will be normalized according to the billing cadence to the nearest recurrence before start time. If not provided, the subscription start time will be used.'),
|
|
10168
|
+
costBasisMode: zod
|
|
10169
|
+
.enum(['dynamic', 'pinned'])
|
|
10170
|
+
.describe('Controls how custom-currency cost bases are selected for the subscription.')
|
|
10171
|
+
.default(exports.createSubscriptionBodyOneCostBasisModeDefault)
|
|
10172
|
+
.describe('Controls how custom-currency cost bases are selected for the new subscription.'),
|
|
10052
10173
|
customerId: zod.coerce
|
|
10053
10174
|
.string()
|
|
10054
10175
|
.regex(exports.createSubscriptionBodyOneCustomerIdRegExp)
|
|
@@ -10083,6 +10204,7 @@ exports.CreateSubscriptionBody = zod
|
|
|
10083
10204
|
.describe('The plan key.'),
|
|
10084
10205
|
version: zod.coerce
|
|
10085
10206
|
.number()
|
|
10207
|
+
.int()
|
|
10086
10208
|
.optional()
|
|
10087
10209
|
.describe('The plan version.'),
|
|
10088
10210
|
})
|
|
@@ -10118,6 +10240,11 @@ exports.CreateSubscriptionBody = zod
|
|
|
10118
10240
|
.date()
|
|
10119
10241
|
.optional()
|
|
10120
10242
|
.describe('The billing anchor of the subscription. The provided date will be normalized according to the billing cadence to the nearest recurrence before start time. If not provided, the subscription start time will be used.'),
|
|
10243
|
+
costBasisMode: zod
|
|
10244
|
+
.enum(['dynamic', 'pinned'])
|
|
10245
|
+
.describe('Controls how custom-currency cost bases are selected for the subscription.')
|
|
10246
|
+
.default(exports.createSubscriptionBodyTwoCostBasisModeDefault)
|
|
10247
|
+
.describe('Controls how custom-currency cost bases are selected for the new subscription.'),
|
|
10121
10248
|
customerId: zod.coerce
|
|
10122
10249
|
.string()
|
|
10123
10250
|
.regex(exports.createSubscriptionBodyTwoCustomerIdRegExp)
|
|
@@ -10251,6 +10378,7 @@ exports.CreateSubscriptionBody = zod
|
|
|
10251
10378
|
.describe('You can grant usage automatically alongside the entitlement, the example scenario would be creating a starting balance.\nIf an amount is specified here, a grant will be created alongside the entitlement with the specified amount.\nThat grant will have it\'s rollover settings configured in a way that after each reset operation, the balance will return the original amount specified here.\nManually creating such a grant would mean having the "amount", "minRolloverAmount", and "maxRolloverAmount" fields all be the same.'),
|
|
10252
10379
|
issueAfterResetPriority: zod.coerce
|
|
10253
10380
|
.number()
|
|
10381
|
+
.int()
|
|
10254
10382
|
.min(1)
|
|
10255
10383
|
.max(exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemOneEntitlementTemplateOneOneIssueAfterResetPriorityMax)
|
|
10256
10384
|
.default(exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemOneEntitlementTemplateOneOneIssueAfterResetPriorityDefault)
|
|
@@ -10432,6 +10560,7 @@ exports.CreateSubscriptionBody = zod
|
|
|
10432
10560
|
.describe('You can grant usage automatically alongside the entitlement, the example scenario would be creating a starting balance.\nIf an amount is specified here, a grant will be created alongside the entitlement with the specified amount.\nThat grant will have it\'s rollover settings configured in a way that after each reset operation, the balance will return the original amount specified here.\nManually creating such a grant would mean having the "amount", "minRolloverAmount", and "maxRolloverAmount" fields all be the same.'),
|
|
10433
10561
|
issueAfterResetPriority: zod.coerce
|
|
10434
10562
|
.number()
|
|
10563
|
+
.int()
|
|
10435
10564
|
.min(1)
|
|
10436
10565
|
.max(exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoEntitlementTemplateOneOneIssueAfterResetPriorityMax)
|
|
10437
10566
|
.default(exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoEntitlementTemplateOneOneIssueAfterResetPriorityDefault)
|
|
@@ -10505,167 +10634,173 @@ exports.CreateSubscriptionBody = zod
|
|
|
10505
10634
|
price: zod
|
|
10506
10635
|
.union([
|
|
10507
10636
|
zod
|
|
10508
|
-
.
|
|
10509
|
-
|
|
10510
|
-
.string()
|
|
10511
|
-
.regex(exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneOneAmountOneRegExp)
|
|
10512
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
10513
|
-
.describe('The amount of the flat price.'),
|
|
10514
|
-
paymentTerm: zod
|
|
10515
|
-
.enum(['in_advance', 'in_arrears'])
|
|
10516
|
-
.describe('The payment term of a flat price.\nOne of: in_advance or in_arrears.')
|
|
10517
|
-
.default(exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneOnePaymentTermDefault)
|
|
10518
|
-
.describe('The payment term of the flat price.\nDefaults to in advance.'),
|
|
10519
|
-
type: zod
|
|
10520
|
-
.enum(['flat'])
|
|
10521
|
-
.describe('The type of the price.'),
|
|
10522
|
-
})
|
|
10523
|
-
.describe('Flat price with payment term.'),
|
|
10524
|
-
zod
|
|
10525
|
-
.object({
|
|
10526
|
-
amount: zod.coerce
|
|
10527
|
-
.string()
|
|
10528
|
-
.regex(exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneTwoAmountOneRegExp)
|
|
10529
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
10530
|
-
.describe('The amount of the unit price.'),
|
|
10531
|
-
maximumAmount: zod.coerce
|
|
10532
|
-
.string()
|
|
10533
|
-
.regex(exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneTwoMaximumAmountOneRegExp)
|
|
10534
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
10535
|
-
.optional()
|
|
10536
|
-
.describe('The customer is limited to spend at most the amount.'),
|
|
10537
|
-
minimumAmount: zod.coerce
|
|
10538
|
-
.string()
|
|
10539
|
-
.regex(exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneTwoMinimumAmountOneRegExp)
|
|
10540
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
10541
|
-
.optional()
|
|
10542
|
-
.describe('The customer is committed to spend at least the amount.'),
|
|
10543
|
-
type: zod
|
|
10544
|
-
.enum(['unit'])
|
|
10545
|
-
.describe('The type of the price.'),
|
|
10546
|
-
})
|
|
10547
|
-
.describe('Unit price with spend commitments.'),
|
|
10548
|
-
zod
|
|
10549
|
-
.object({
|
|
10550
|
-
maximumAmount: zod.coerce
|
|
10551
|
-
.string()
|
|
10552
|
-
.regex(exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneThreeMaximumAmountOneRegExp)
|
|
10553
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
10554
|
-
.optional()
|
|
10555
|
-
.describe('The customer is limited to spend at most the amount.'),
|
|
10556
|
-
minimumAmount: zod.coerce
|
|
10557
|
-
.string()
|
|
10558
|
-
.regex(exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneThreeMinimumAmountOneRegExp)
|
|
10559
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
10560
|
-
.optional()
|
|
10561
|
-
.describe('The customer is committed to spend at least the amount.'),
|
|
10562
|
-
mode: zod
|
|
10563
|
-
.enum(['volume', 'graduated'])
|
|
10564
|
-
.describe('The mode of the tiered price.')
|
|
10565
|
-
.describe('Defines if the tiering mode is volume-based or graduated:\n- In `volume`-based tiering, the maximum quantity within a period determines the per unit price.\n- In `graduated` tiering, pricing can change as the quantity grows.'),
|
|
10566
|
-
tiers: zod
|
|
10567
|
-
.array(zod
|
|
10637
|
+
.union([
|
|
10638
|
+
zod
|
|
10568
10639
|
.object({
|
|
10569
|
-
|
|
10570
|
-
.
|
|
10571
|
-
|
|
10572
|
-
|
|
10573
|
-
|
|
10574
|
-
|
|
10575
|
-
|
|
10576
|
-
|
|
10577
|
-
|
|
10578
|
-
|
|
10579
|
-
|
|
10580
|
-
.
|
|
10581
|
-
.
|
|
10582
|
-
|
|
10583
|
-
|
|
10640
|
+
amount: zod.coerce
|
|
10641
|
+
.string()
|
|
10642
|
+
.regex(exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneOneAmountOneRegExp)
|
|
10643
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
10644
|
+
.describe('The amount of the flat price.'),
|
|
10645
|
+
paymentTerm: zod
|
|
10646
|
+
.enum([
|
|
10647
|
+
'in_advance',
|
|
10648
|
+
'in_arrears',
|
|
10649
|
+
])
|
|
10650
|
+
.describe('The payment term of a flat price.\nOne of: in_advance or in_arrears.')
|
|
10651
|
+
.default(exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneOnePaymentTermDefault)
|
|
10652
|
+
.describe('The payment term of the flat price.\nDefaults to in advance.'),
|
|
10653
|
+
type: zod
|
|
10654
|
+
.enum(['flat'])
|
|
10655
|
+
.describe('The type of the price.'),
|
|
10656
|
+
})
|
|
10657
|
+
.describe('Flat price with payment term.'),
|
|
10658
|
+
zod
|
|
10659
|
+
.object({
|
|
10660
|
+
amount: zod.coerce
|
|
10661
|
+
.string()
|
|
10662
|
+
.regex(exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneTwoAmountOneRegExp)
|
|
10663
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
10664
|
+
.describe('The amount of the unit price.'),
|
|
10665
|
+
maximumAmount: zod.coerce
|
|
10666
|
+
.string()
|
|
10667
|
+
.regex(exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneTwoMaximumAmountOneRegExp)
|
|
10668
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
10669
|
+
.optional()
|
|
10670
|
+
.describe('The customer is limited to spend at most the amount.'),
|
|
10671
|
+
minimumAmount: zod.coerce
|
|
10672
|
+
.string()
|
|
10673
|
+
.regex(exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneTwoMinimumAmountOneRegExp)
|
|
10674
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
10675
|
+
.optional()
|
|
10676
|
+
.describe('The customer is committed to spend at least the amount.'),
|
|
10677
|
+
type: zod
|
|
10678
|
+
.enum(['unit'])
|
|
10679
|
+
.describe('The type of the price.'),
|
|
10680
|
+
})
|
|
10681
|
+
.describe('Unit price with spend commitments.'),
|
|
10682
|
+
zod
|
|
10683
|
+
.object({
|
|
10684
|
+
maximumAmount: zod.coerce
|
|
10685
|
+
.string()
|
|
10686
|
+
.regex(exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneThreeMaximumAmountOneRegExp)
|
|
10687
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
10688
|
+
.optional()
|
|
10689
|
+
.describe('The customer is limited to spend at most the amount.'),
|
|
10690
|
+
minimumAmount: zod.coerce
|
|
10691
|
+
.string()
|
|
10692
|
+
.regex(exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneThreeMinimumAmountOneRegExp)
|
|
10693
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
10694
|
+
.optional()
|
|
10695
|
+
.describe('The customer is committed to spend at least the amount.'),
|
|
10696
|
+
mode: zod
|
|
10697
|
+
.enum(['volume', 'graduated'])
|
|
10698
|
+
.describe('The mode of the tiered price.')
|
|
10699
|
+
.describe('Defines if the tiering mode is volume-based or graduated:\n- In `volume`-based tiering, the maximum quantity within a period determines the per unit price.\n- In `graduated` tiering, pricing can change as the quantity grows.'),
|
|
10700
|
+
tiers: zod
|
|
10701
|
+
.array(zod
|
|
10584
10702
|
.object({
|
|
10585
|
-
|
|
10703
|
+
flatPrice: zod
|
|
10704
|
+
.object({
|
|
10705
|
+
amount: zod.coerce
|
|
10706
|
+
.string()
|
|
10707
|
+
.regex(exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneThreeTiersItemFlatPriceOneAmountOneRegExp)
|
|
10708
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
10709
|
+
.describe('The amount of the flat price.'),
|
|
10710
|
+
type: zod
|
|
10711
|
+
.enum(['flat'])
|
|
10712
|
+
.describe('The type of the price.'),
|
|
10713
|
+
})
|
|
10714
|
+
.describe('Flat price.')
|
|
10715
|
+
.nullable()
|
|
10716
|
+
.describe('The flat price component of the tier.'),
|
|
10717
|
+
unitPrice: zod
|
|
10718
|
+
.object({
|
|
10719
|
+
amount: zod.coerce
|
|
10720
|
+
.string()
|
|
10721
|
+
.regex(exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneThreeTiersItemUnitPriceOneAmountOneRegExp)
|
|
10722
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
10723
|
+
.describe('The amount of the unit price.'),
|
|
10724
|
+
type: zod
|
|
10725
|
+
.enum(['unit'])
|
|
10726
|
+
.describe('The type of the price.'),
|
|
10727
|
+
})
|
|
10728
|
+
.describe('Unit price.')
|
|
10729
|
+
.nullable()
|
|
10730
|
+
.describe('The unit price component of the tier.'),
|
|
10731
|
+
upToAmount: zod.coerce
|
|
10586
10732
|
.string()
|
|
10587
|
-
.regex(exports.
|
|
10733
|
+
.regex(exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneThreeTiersItemUpToAmountOneRegExp)
|
|
10588
10734
|
.describe('Numeric represents an arbitrary precision number.')
|
|
10589
|
-
.
|
|
10590
|
-
|
|
10591
|
-
.enum(['unit'])
|
|
10592
|
-
.describe('The type of the price.'),
|
|
10735
|
+
.optional()
|
|
10736
|
+
.describe('Up to and including to this quantity will be contained in the tier.\nIf null, the tier is open-ended.'),
|
|
10593
10737
|
})
|
|
10594
|
-
.describe('
|
|
10595
|
-
.
|
|
10596
|
-
.describe('The
|
|
10597
|
-
|
|
10738
|
+
.describe('A price tier.\nAt least one price component is required in each tier.'))
|
|
10739
|
+
.min(1)
|
|
10740
|
+
.describe('The tiers of the tiered price.\nAt least one price component is required in each tier.'),
|
|
10741
|
+
type: zod
|
|
10742
|
+
.enum(['tiered'])
|
|
10743
|
+
.describe('The type of the price.\n\nOne of: flat, unit, or tiered.'),
|
|
10744
|
+
})
|
|
10745
|
+
.describe('Tiered price with spend commitments.'),
|
|
10746
|
+
zod
|
|
10747
|
+
.object({
|
|
10748
|
+
maximumAmount: zod.coerce
|
|
10598
10749
|
.string()
|
|
10599
|
-
.regex(exports.
|
|
10750
|
+
.regex(exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFourMaximumAmountOneRegExp)
|
|
10600
10751
|
.describe('Numeric represents an arbitrary precision number.')
|
|
10601
10752
|
.optional()
|
|
10602
|
-
.describe('
|
|
10753
|
+
.describe('The customer is limited to spend at most the amount.'),
|
|
10754
|
+
minimumAmount: zod.coerce
|
|
10755
|
+
.string()
|
|
10756
|
+
.regex(exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFourMinimumAmountOneRegExp)
|
|
10757
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
10758
|
+
.optional()
|
|
10759
|
+
.describe('The customer is committed to spend at least the amount.'),
|
|
10760
|
+
multiplier: zod.coerce
|
|
10761
|
+
.string()
|
|
10762
|
+
.regex(exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFourMultiplierOneRegExp)
|
|
10763
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
10764
|
+
.default(exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFourMultiplierDefault)
|
|
10765
|
+
.describe('The multiplier to apply to the base price to get the dynamic price.\n\nExamples:\n- 0.0: the price is zero\n- 0.5: the price is 50% of the base price\n- 1.0: the price is the same as the base price\n- 1.5: the price is 150% of the base price'),
|
|
10766
|
+
type: zod
|
|
10767
|
+
.enum(['dynamic'])
|
|
10768
|
+
.describe('The type of the price.'),
|
|
10769
|
+
})
|
|
10770
|
+
.describe('Dynamic price with spend commitments.'),
|
|
10771
|
+
zod
|
|
10772
|
+
.object({
|
|
10773
|
+
amount: zod.coerce
|
|
10774
|
+
.string()
|
|
10775
|
+
.regex(exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFiveAmountOneRegExp)
|
|
10776
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
10777
|
+
.describe('The price of one package.'),
|
|
10778
|
+
maximumAmount: zod.coerce
|
|
10779
|
+
.string()
|
|
10780
|
+
.regex(exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFiveMaximumAmountOneRegExp)
|
|
10781
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
10782
|
+
.optional()
|
|
10783
|
+
.describe('The customer is limited to spend at most the amount.'),
|
|
10784
|
+
minimumAmount: zod.coerce
|
|
10785
|
+
.string()
|
|
10786
|
+
.regex(exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFiveMinimumAmountOneRegExp)
|
|
10787
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
10788
|
+
.optional()
|
|
10789
|
+
.describe('The customer is committed to spend at least the amount.'),
|
|
10790
|
+
quantityPerPackage: zod.coerce
|
|
10791
|
+
.string()
|
|
10792
|
+
.regex(exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFiveQuantityPerPackageOneRegExp)
|
|
10793
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
10794
|
+
.describe('The quantity per package.'),
|
|
10795
|
+
type: zod
|
|
10796
|
+
.enum(['package'])
|
|
10797
|
+
.describe('The type of the price.'),
|
|
10603
10798
|
})
|
|
10604
|
-
.describe('
|
|
10605
|
-
|
|
10606
|
-
|
|
10607
|
-
|
|
10608
|
-
.enum(['tiered'])
|
|
10609
|
-
.describe('The type of the price.\n\nOne of: flat, unit, or tiered.'),
|
|
10610
|
-
})
|
|
10611
|
-
.describe('Tiered price with spend commitments.'),
|
|
10612
|
-
zod
|
|
10613
|
-
.object({
|
|
10614
|
-
maximumAmount: zod.coerce
|
|
10615
|
-
.string()
|
|
10616
|
-
.regex(exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFourMaximumAmountOneRegExp)
|
|
10617
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
10618
|
-
.optional()
|
|
10619
|
-
.describe('The customer is limited to spend at most the amount.'),
|
|
10620
|
-
minimumAmount: zod.coerce
|
|
10621
|
-
.string()
|
|
10622
|
-
.regex(exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFourMinimumAmountOneRegExp)
|
|
10623
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
10624
|
-
.optional()
|
|
10625
|
-
.describe('The customer is committed to spend at least the amount.'),
|
|
10626
|
-
multiplier: zod.coerce
|
|
10627
|
-
.string()
|
|
10628
|
-
.regex(exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFourMultiplierOneRegExp)
|
|
10629
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
10630
|
-
.default(exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFourMultiplierDefault)
|
|
10631
|
-
.describe('The multiplier to apply to the base price to get the dynamic price.\n\nExamples:\n- 0.0: the price is zero\n- 0.5: the price is 50% of the base price\n- 1.0: the price is the same as the base price\n- 1.5: the price is 150% of the base price'),
|
|
10632
|
-
type: zod
|
|
10633
|
-
.enum(['dynamic'])
|
|
10634
|
-
.describe('The type of the price.'),
|
|
10635
|
-
})
|
|
10636
|
-
.describe('Dynamic price with spend commitments.'),
|
|
10637
|
-
zod
|
|
10638
|
-
.object({
|
|
10639
|
-
amount: zod.coerce
|
|
10640
|
-
.string()
|
|
10641
|
-
.regex(exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFiveAmountOneRegExp)
|
|
10642
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
10643
|
-
.describe('The price of one package.'),
|
|
10644
|
-
maximumAmount: zod.coerce
|
|
10645
|
-
.string()
|
|
10646
|
-
.regex(exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFiveMaximumAmountOneRegExp)
|
|
10647
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
10648
|
-
.optional()
|
|
10649
|
-
.describe('The customer is limited to spend at most the amount.'),
|
|
10650
|
-
minimumAmount: zod.coerce
|
|
10651
|
-
.string()
|
|
10652
|
-
.regex(exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFiveMinimumAmountOneRegExp)
|
|
10653
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
10654
|
-
.optional()
|
|
10655
|
-
.describe('The customer is committed to spend at least the amount.'),
|
|
10656
|
-
quantityPerPackage: zod.coerce
|
|
10657
|
-
.string()
|
|
10658
|
-
.regex(exports.createSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFiveQuantityPerPackageOneRegExp)
|
|
10659
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
10660
|
-
.describe('The quantity per package.'),
|
|
10661
|
-
type: zod
|
|
10662
|
-
.enum(['package'])
|
|
10663
|
-
.describe('The type of the price.'),
|
|
10664
|
-
})
|
|
10665
|
-
.describe('Package price with spend commitments.'),
|
|
10799
|
+
.describe('Package price with spend commitments.'),
|
|
10800
|
+
])
|
|
10801
|
+
.describe('The price of the usage based rate card.'),
|
|
10802
|
+
zod.null(),
|
|
10666
10803
|
])
|
|
10667
|
-
.describe('The price of the usage based rate card.')
|
|
10668
|
-
.nullable()
|
|
10669
10804
|
.describe('The price of the rate card.\nWhen null, the feature or service is free.'),
|
|
10670
10805
|
taxConfig: zod
|
|
10671
10806
|
.object({
|
|
@@ -10896,6 +11031,7 @@ exports.EditSubscriptionBody = zod
|
|
|
10896
11031
|
.describe('You can grant usage automatically alongside the entitlement, the example scenario would be creating a starting balance.\nIf an amount is specified here, a grant will be created alongside the entitlement with the specified amount.\nThat grant will have it\'s rollover settings configured in a way that after each reset operation, the balance will return the original amount specified here.\nManually creating such a grant would mean having the "amount", "minRolloverAmount", and "maxRolloverAmount" fields all be the same.'),
|
|
10897
11032
|
issueAfterResetPriority: zod.coerce
|
|
10898
11033
|
.number()
|
|
11034
|
+
.int()
|
|
10899
11035
|
.min(1)
|
|
10900
11036
|
.max(exports.editSubscriptionBodyCustomizationsItemOneRateCardOneEntitlementTemplateOneOneIssueAfterResetPriorityMax)
|
|
10901
11037
|
.default(exports.editSubscriptionBodyCustomizationsItemOneRateCardOneEntitlementTemplateOneOneIssueAfterResetPriorityDefault)
|
|
@@ -11077,6 +11213,7 @@ exports.EditSubscriptionBody = zod
|
|
|
11077
11213
|
.describe('You can grant usage automatically alongside the entitlement, the example scenario would be creating a starting balance.\nIf an amount is specified here, a grant will be created alongside the entitlement with the specified amount.\nThat grant will have it\'s rollover settings configured in a way that after each reset operation, the balance will return the original amount specified here.\nManually creating such a grant would mean having the "amount", "minRolloverAmount", and "maxRolloverAmount" fields all be the same.'),
|
|
11078
11214
|
issueAfterResetPriority: zod.coerce
|
|
11079
11215
|
.number()
|
|
11216
|
+
.int()
|
|
11080
11217
|
.min(1)
|
|
11081
11218
|
.max(exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoEntitlementTemplateOneOneIssueAfterResetPriorityMax)
|
|
11082
11219
|
.default(exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoEntitlementTemplateOneOneIssueAfterResetPriorityDefault)
|
|
@@ -11150,167 +11287,170 @@ exports.EditSubscriptionBody = zod
|
|
|
11150
11287
|
price: zod
|
|
11151
11288
|
.union([
|
|
11152
11289
|
zod
|
|
11153
|
-
.
|
|
11154
|
-
|
|
11155
|
-
.string()
|
|
11156
|
-
.regex(exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneOneAmountOneRegExp)
|
|
11157
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
11158
|
-
.describe('The amount of the flat price.'),
|
|
11159
|
-
paymentTerm: zod
|
|
11160
|
-
.enum(['in_advance', 'in_arrears'])
|
|
11161
|
-
.describe('The payment term of a flat price.\nOne of: in_advance or in_arrears.')
|
|
11162
|
-
.default(exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneOnePaymentTermDefault)
|
|
11163
|
-
.describe('The payment term of the flat price.\nDefaults to in advance.'),
|
|
11164
|
-
type: zod
|
|
11165
|
-
.enum(['flat'])
|
|
11166
|
-
.describe('The type of the price.'),
|
|
11167
|
-
})
|
|
11168
|
-
.describe('Flat price with payment term.'),
|
|
11169
|
-
zod
|
|
11170
|
-
.object({
|
|
11171
|
-
amount: zod.coerce
|
|
11172
|
-
.string()
|
|
11173
|
-
.regex(exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneTwoAmountOneRegExp)
|
|
11174
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
11175
|
-
.describe('The amount of the unit price.'),
|
|
11176
|
-
maximumAmount: zod.coerce
|
|
11177
|
-
.string()
|
|
11178
|
-
.regex(exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneTwoMaximumAmountOneRegExp)
|
|
11179
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
11180
|
-
.optional()
|
|
11181
|
-
.describe('The customer is limited to spend at most the amount.'),
|
|
11182
|
-
minimumAmount: zod.coerce
|
|
11183
|
-
.string()
|
|
11184
|
-
.regex(exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneTwoMinimumAmountOneRegExp)
|
|
11185
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
11186
|
-
.optional()
|
|
11187
|
-
.describe('The customer is committed to spend at least the amount.'),
|
|
11188
|
-
type: zod
|
|
11189
|
-
.enum(['unit'])
|
|
11190
|
-
.describe('The type of the price.'),
|
|
11191
|
-
})
|
|
11192
|
-
.describe('Unit price with spend commitments.'),
|
|
11193
|
-
zod
|
|
11194
|
-
.object({
|
|
11195
|
-
maximumAmount: zod.coerce
|
|
11196
|
-
.string()
|
|
11197
|
-
.regex(exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneThreeMaximumAmountOneRegExp)
|
|
11198
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
11199
|
-
.optional()
|
|
11200
|
-
.describe('The customer is limited to spend at most the amount.'),
|
|
11201
|
-
minimumAmount: zod.coerce
|
|
11202
|
-
.string()
|
|
11203
|
-
.regex(exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneThreeMinimumAmountOneRegExp)
|
|
11204
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
11205
|
-
.optional()
|
|
11206
|
-
.describe('The customer is committed to spend at least the amount.'),
|
|
11207
|
-
mode: zod
|
|
11208
|
-
.enum(['volume', 'graduated'])
|
|
11209
|
-
.describe('The mode of the tiered price.')
|
|
11210
|
-
.describe('Defines if the tiering mode is volume-based or graduated:\n- In `volume`-based tiering, the maximum quantity within a period determines the per unit price.\n- In `graduated` tiering, pricing can change as the quantity grows.'),
|
|
11211
|
-
tiers: zod
|
|
11212
|
-
.array(zod
|
|
11290
|
+
.union([
|
|
11291
|
+
zod
|
|
11213
11292
|
.object({
|
|
11214
|
-
|
|
11215
|
-
.
|
|
11216
|
-
|
|
11217
|
-
|
|
11218
|
-
|
|
11219
|
-
|
|
11220
|
-
|
|
11221
|
-
|
|
11222
|
-
|
|
11223
|
-
|
|
11224
|
-
|
|
11225
|
-
.
|
|
11226
|
-
.
|
|
11227
|
-
|
|
11228
|
-
|
|
11293
|
+
amount: zod.coerce
|
|
11294
|
+
.string()
|
|
11295
|
+
.regex(exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneOneAmountOneRegExp)
|
|
11296
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
11297
|
+
.describe('The amount of the flat price.'),
|
|
11298
|
+
paymentTerm: zod
|
|
11299
|
+
.enum(['in_advance', 'in_arrears'])
|
|
11300
|
+
.describe('The payment term of a flat price.\nOne of: in_advance or in_arrears.')
|
|
11301
|
+
.default(exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneOnePaymentTermDefault)
|
|
11302
|
+
.describe('The payment term of the flat price.\nDefaults to in advance.'),
|
|
11303
|
+
type: zod
|
|
11304
|
+
.enum(['flat'])
|
|
11305
|
+
.describe('The type of the price.'),
|
|
11306
|
+
})
|
|
11307
|
+
.describe('Flat price with payment term.'),
|
|
11308
|
+
zod
|
|
11309
|
+
.object({
|
|
11310
|
+
amount: zod.coerce
|
|
11311
|
+
.string()
|
|
11312
|
+
.regex(exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneTwoAmountOneRegExp)
|
|
11313
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
11314
|
+
.describe('The amount of the unit price.'),
|
|
11315
|
+
maximumAmount: zod.coerce
|
|
11316
|
+
.string()
|
|
11317
|
+
.regex(exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneTwoMaximumAmountOneRegExp)
|
|
11318
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
11319
|
+
.optional()
|
|
11320
|
+
.describe('The customer is limited to spend at most the amount.'),
|
|
11321
|
+
minimumAmount: zod.coerce
|
|
11322
|
+
.string()
|
|
11323
|
+
.regex(exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneTwoMinimumAmountOneRegExp)
|
|
11324
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
11325
|
+
.optional()
|
|
11326
|
+
.describe('The customer is committed to spend at least the amount.'),
|
|
11327
|
+
type: zod
|
|
11328
|
+
.enum(['unit'])
|
|
11329
|
+
.describe('The type of the price.'),
|
|
11330
|
+
})
|
|
11331
|
+
.describe('Unit price with spend commitments.'),
|
|
11332
|
+
zod
|
|
11333
|
+
.object({
|
|
11334
|
+
maximumAmount: zod.coerce
|
|
11335
|
+
.string()
|
|
11336
|
+
.regex(exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneThreeMaximumAmountOneRegExp)
|
|
11337
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
11338
|
+
.optional()
|
|
11339
|
+
.describe('The customer is limited to spend at most the amount.'),
|
|
11340
|
+
minimumAmount: zod.coerce
|
|
11341
|
+
.string()
|
|
11342
|
+
.regex(exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneThreeMinimumAmountOneRegExp)
|
|
11343
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
11344
|
+
.optional()
|
|
11345
|
+
.describe('The customer is committed to spend at least the amount.'),
|
|
11346
|
+
mode: zod
|
|
11347
|
+
.enum(['volume', 'graduated'])
|
|
11348
|
+
.describe('The mode of the tiered price.')
|
|
11349
|
+
.describe('Defines if the tiering mode is volume-based or graduated:\n- In `volume`-based tiering, the maximum quantity within a period determines the per unit price.\n- In `graduated` tiering, pricing can change as the quantity grows.'),
|
|
11350
|
+
tiers: zod
|
|
11351
|
+
.array(zod
|
|
11229
11352
|
.object({
|
|
11230
|
-
|
|
11353
|
+
flatPrice: zod
|
|
11354
|
+
.object({
|
|
11355
|
+
amount: zod.coerce
|
|
11356
|
+
.string()
|
|
11357
|
+
.regex(exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneThreeTiersItemFlatPriceOneAmountOneRegExp)
|
|
11358
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
11359
|
+
.describe('The amount of the flat price.'),
|
|
11360
|
+
type: zod
|
|
11361
|
+
.enum(['flat'])
|
|
11362
|
+
.describe('The type of the price.'),
|
|
11363
|
+
})
|
|
11364
|
+
.describe('Flat price.')
|
|
11365
|
+
.nullable()
|
|
11366
|
+
.describe('The flat price component of the tier.'),
|
|
11367
|
+
unitPrice: zod
|
|
11368
|
+
.object({
|
|
11369
|
+
amount: zod.coerce
|
|
11370
|
+
.string()
|
|
11371
|
+
.regex(exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneThreeTiersItemUnitPriceOneAmountOneRegExp)
|
|
11372
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
11373
|
+
.describe('The amount of the unit price.'),
|
|
11374
|
+
type: zod
|
|
11375
|
+
.enum(['unit'])
|
|
11376
|
+
.describe('The type of the price.'),
|
|
11377
|
+
})
|
|
11378
|
+
.describe('Unit price.')
|
|
11379
|
+
.nullable()
|
|
11380
|
+
.describe('The unit price component of the tier.'),
|
|
11381
|
+
upToAmount: zod.coerce
|
|
11231
11382
|
.string()
|
|
11232
|
-
.regex(exports.
|
|
11383
|
+
.regex(exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneThreeTiersItemUpToAmountOneRegExp)
|
|
11233
11384
|
.describe('Numeric represents an arbitrary precision number.')
|
|
11234
|
-
.
|
|
11235
|
-
|
|
11236
|
-
.enum(['unit'])
|
|
11237
|
-
.describe('The type of the price.'),
|
|
11385
|
+
.optional()
|
|
11386
|
+
.describe('Up to and including to this quantity will be contained in the tier.\nIf null, the tier is open-ended.'),
|
|
11238
11387
|
})
|
|
11239
|
-
.describe('
|
|
11240
|
-
.
|
|
11241
|
-
.describe('The
|
|
11242
|
-
|
|
11388
|
+
.describe('A price tier.\nAt least one price component is required in each tier.'))
|
|
11389
|
+
.min(1)
|
|
11390
|
+
.describe('The tiers of the tiered price.\nAt least one price component is required in each tier.'),
|
|
11391
|
+
type: zod
|
|
11392
|
+
.enum(['tiered'])
|
|
11393
|
+
.describe('The type of the price.\n\nOne of: flat, unit, or tiered.'),
|
|
11394
|
+
})
|
|
11395
|
+
.describe('Tiered price with spend commitments.'),
|
|
11396
|
+
zod
|
|
11397
|
+
.object({
|
|
11398
|
+
maximumAmount: zod.coerce
|
|
11399
|
+
.string()
|
|
11400
|
+
.regex(exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneFourMaximumAmountOneRegExp)
|
|
11401
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
11402
|
+
.optional()
|
|
11403
|
+
.describe('The customer is limited to spend at most the amount.'),
|
|
11404
|
+
minimumAmount: zod.coerce
|
|
11405
|
+
.string()
|
|
11406
|
+
.regex(exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneFourMinimumAmountOneRegExp)
|
|
11407
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
11408
|
+
.optional()
|
|
11409
|
+
.describe('The customer is committed to spend at least the amount.'),
|
|
11410
|
+
multiplier: zod.coerce
|
|
11411
|
+
.string()
|
|
11412
|
+
.regex(exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneFourMultiplierOneRegExp)
|
|
11413
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
11414
|
+
.default(exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneFourMultiplierDefault)
|
|
11415
|
+
.describe('The multiplier to apply to the base price to get the dynamic price.\n\nExamples:\n- 0.0: the price is zero\n- 0.5: the price is 50% of the base price\n- 1.0: the price is the same as the base price\n- 1.5: the price is 150% of the base price'),
|
|
11416
|
+
type: zod
|
|
11417
|
+
.enum(['dynamic'])
|
|
11418
|
+
.describe('The type of the price.'),
|
|
11419
|
+
})
|
|
11420
|
+
.describe('Dynamic price with spend commitments.'),
|
|
11421
|
+
zod
|
|
11422
|
+
.object({
|
|
11423
|
+
amount: zod.coerce
|
|
11424
|
+
.string()
|
|
11425
|
+
.regex(exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneFiveAmountOneRegExp)
|
|
11426
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
11427
|
+
.describe('The price of one package.'),
|
|
11428
|
+
maximumAmount: zod.coerce
|
|
11429
|
+
.string()
|
|
11430
|
+
.regex(exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneFiveMaximumAmountOneRegExp)
|
|
11431
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
11432
|
+
.optional()
|
|
11433
|
+
.describe('The customer is limited to spend at most the amount.'),
|
|
11434
|
+
minimumAmount: zod.coerce
|
|
11243
11435
|
.string()
|
|
11244
|
-
.regex(exports.
|
|
11436
|
+
.regex(exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneFiveMinimumAmountOneRegExp)
|
|
11245
11437
|
.describe('Numeric represents an arbitrary precision number.')
|
|
11246
11438
|
.optional()
|
|
11247
|
-
.describe('
|
|
11439
|
+
.describe('The customer is committed to spend at least the amount.'),
|
|
11440
|
+
quantityPerPackage: zod.coerce
|
|
11441
|
+
.string()
|
|
11442
|
+
.regex(exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneFiveQuantityPerPackageOneRegExp)
|
|
11443
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
11444
|
+
.describe('The quantity per package.'),
|
|
11445
|
+
type: zod
|
|
11446
|
+
.enum(['package'])
|
|
11447
|
+
.describe('The type of the price.'),
|
|
11248
11448
|
})
|
|
11249
|
-
.describe('
|
|
11250
|
-
|
|
11251
|
-
|
|
11252
|
-
|
|
11253
|
-
.enum(['tiered'])
|
|
11254
|
-
.describe('The type of the price.\n\nOne of: flat, unit, or tiered.'),
|
|
11255
|
-
})
|
|
11256
|
-
.describe('Tiered price with spend commitments.'),
|
|
11257
|
-
zod
|
|
11258
|
-
.object({
|
|
11259
|
-
maximumAmount: zod.coerce
|
|
11260
|
-
.string()
|
|
11261
|
-
.regex(exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneFourMaximumAmountOneRegExp)
|
|
11262
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
11263
|
-
.optional()
|
|
11264
|
-
.describe('The customer is limited to spend at most the amount.'),
|
|
11265
|
-
minimumAmount: zod.coerce
|
|
11266
|
-
.string()
|
|
11267
|
-
.regex(exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneFourMinimumAmountOneRegExp)
|
|
11268
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
11269
|
-
.optional()
|
|
11270
|
-
.describe('The customer is committed to spend at least the amount.'),
|
|
11271
|
-
multiplier: zod.coerce
|
|
11272
|
-
.string()
|
|
11273
|
-
.regex(exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneFourMultiplierOneRegExp)
|
|
11274
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
11275
|
-
.default(exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneFourMultiplierDefault)
|
|
11276
|
-
.describe('The multiplier to apply to the base price to get the dynamic price.\n\nExamples:\n- 0.0: the price is zero\n- 0.5: the price is 50% of the base price\n- 1.0: the price is the same as the base price\n- 1.5: the price is 150% of the base price'),
|
|
11277
|
-
type: zod
|
|
11278
|
-
.enum(['dynamic'])
|
|
11279
|
-
.describe('The type of the price.'),
|
|
11280
|
-
})
|
|
11281
|
-
.describe('Dynamic price with spend commitments.'),
|
|
11282
|
-
zod
|
|
11283
|
-
.object({
|
|
11284
|
-
amount: zod.coerce
|
|
11285
|
-
.string()
|
|
11286
|
-
.regex(exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneFiveAmountOneRegExp)
|
|
11287
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
11288
|
-
.describe('The price of one package.'),
|
|
11289
|
-
maximumAmount: zod.coerce
|
|
11290
|
-
.string()
|
|
11291
|
-
.regex(exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneFiveMaximumAmountOneRegExp)
|
|
11292
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
11293
|
-
.optional()
|
|
11294
|
-
.describe('The customer is limited to spend at most the amount.'),
|
|
11295
|
-
minimumAmount: zod.coerce
|
|
11296
|
-
.string()
|
|
11297
|
-
.regex(exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneFiveMinimumAmountOneRegExp)
|
|
11298
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
11299
|
-
.optional()
|
|
11300
|
-
.describe('The customer is committed to spend at least the amount.'),
|
|
11301
|
-
quantityPerPackage: zod.coerce
|
|
11302
|
-
.string()
|
|
11303
|
-
.regex(exports.editSubscriptionBodyCustomizationsItemOneRateCardTwoPriceOneFiveQuantityPerPackageOneRegExp)
|
|
11304
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
11305
|
-
.describe('The quantity per package.'),
|
|
11306
|
-
type: zod
|
|
11307
|
-
.enum(['package'])
|
|
11308
|
-
.describe('The type of the price.'),
|
|
11309
|
-
})
|
|
11310
|
-
.describe('Package price with spend commitments.'),
|
|
11449
|
+
.describe('Package price with spend commitments.'),
|
|
11450
|
+
])
|
|
11451
|
+
.describe('The price of the usage based rate card.'),
|
|
11452
|
+
zod.null(),
|
|
11311
11453
|
])
|
|
11312
|
-
.describe('The price of the usage based rate card.')
|
|
11313
|
-
.nullable()
|
|
11314
11454
|
.describe('The price of the rate card.\nWhen null, the feature or service is free.'),
|
|
11315
11455
|
taxConfig: zod
|
|
11316
11456
|
.object({
|
|
@@ -11510,6 +11650,7 @@ exports.CreateSubscriptionAddonBody = zod
|
|
|
11510
11650
|
.describe('Human-readable name for the resource. Between 1 and 256 characters.'),
|
|
11511
11651
|
quantity: zod.coerce
|
|
11512
11652
|
.number()
|
|
11653
|
+
.int()
|
|
11513
11654
|
.min(exports.createSubscriptionAddonBodyQuantityMin)
|
|
11514
11655
|
.describe('The quantity of the add-on. Always 1 for single instance add-ons.'),
|
|
11515
11656
|
timing: zod
|
|
@@ -11586,6 +11727,7 @@ exports.UpdateSubscriptionAddonBody = zod
|
|
|
11586
11727
|
.describe('Human-readable name for the resource. Between 1 and 256 characters.'),
|
|
11587
11728
|
quantity: zod.coerce
|
|
11588
11729
|
.number()
|
|
11730
|
+
.int()
|
|
11589
11731
|
.min(exports.updateSubscriptionAddonBodyQuantityMin)
|
|
11590
11732
|
.optional()
|
|
11591
11733
|
.describe('The quantity of the add-on. Always 1 for single instance add-ons.'),
|
|
@@ -11641,6 +11783,8 @@ exports.ChangeSubscriptionParams = zod.object({
|
|
|
11641
11783
|
});
|
|
11642
11784
|
exports.changeSubscriptionBodyOnePlanOneKeyMax = 64;
|
|
11643
11785
|
exports.changeSubscriptionBodyOnePlanOneKeyRegExp = /^[a-z0-9]+(?:_[a-z0-9]+)*$/;
|
|
11786
|
+
exports.changeSubscriptionBodyOneCostBasisModeDefault = 'dynamic';
|
|
11787
|
+
exports.changeSubscriptionBodyTwoCostBasisModeDefault = 'dynamic';
|
|
11644
11788
|
exports.changeSubscriptionBodyTwoCustomPlanOneOneNameMax = 256;
|
|
11645
11789
|
exports.changeSubscriptionBodyTwoCustomPlanOneOneDescriptionMax = 1024;
|
|
11646
11790
|
exports.changeSubscriptionBodyTwoCustomPlanOneOneCurrencyOneMin = 3;
|
|
@@ -11724,6 +11868,11 @@ exports.ChangeSubscriptionBody = zod
|
|
|
11724
11868
|
.date()
|
|
11725
11869
|
.optional()
|
|
11726
11870
|
.describe('The billing anchor of the subscription. The provided date will be normalized according to the billing cadence to the nearest recurrence before start time. If not provided, the previous subscription billing anchor will be used.'),
|
|
11871
|
+
costBasisMode: zod
|
|
11872
|
+
.enum(['dynamic', 'pinned'])
|
|
11873
|
+
.describe('Controls how custom-currency cost bases are selected for the subscription.')
|
|
11874
|
+
.default(exports.changeSubscriptionBodyOneCostBasisModeDefault)
|
|
11875
|
+
.describe('Controls how custom-currency cost bases are selected for the new subscription.'),
|
|
11727
11876
|
description: zod.coerce
|
|
11728
11877
|
.string()
|
|
11729
11878
|
.optional()
|
|
@@ -11747,6 +11896,7 @@ exports.ChangeSubscriptionBody = zod
|
|
|
11747
11896
|
.describe('The plan key.'),
|
|
11748
11897
|
version: zod.coerce
|
|
11749
11898
|
.number()
|
|
11899
|
+
.int()
|
|
11750
11900
|
.optional()
|
|
11751
11901
|
.describe('The plan version.'),
|
|
11752
11902
|
})
|
|
@@ -11781,6 +11931,11 @@ exports.ChangeSubscriptionBody = zod
|
|
|
11781
11931
|
.date()
|
|
11782
11932
|
.optional()
|
|
11783
11933
|
.describe('The billing anchor of the subscription. The provided date will be normalized according to the billing cadence to the nearest recurrence before start time. If not provided, the previous subscription billing anchor will be used.'),
|
|
11934
|
+
costBasisMode: zod
|
|
11935
|
+
.enum(['dynamic', 'pinned'])
|
|
11936
|
+
.describe('Controls how custom-currency cost bases are selected for the subscription.')
|
|
11937
|
+
.default(exports.changeSubscriptionBodyTwoCostBasisModeDefault)
|
|
11938
|
+
.describe('Controls how custom-currency cost bases are selected for the new subscription.'),
|
|
11784
11939
|
customPlan: zod
|
|
11785
11940
|
.object({
|
|
11786
11941
|
alignment: zod
|
|
@@ -11903,6 +12058,7 @@ exports.ChangeSubscriptionBody = zod
|
|
|
11903
12058
|
.describe('You can grant usage automatically alongside the entitlement, the example scenario would be creating a starting balance.\nIf an amount is specified here, a grant will be created alongside the entitlement with the specified amount.\nThat grant will have it\'s rollover settings configured in a way that after each reset operation, the balance will return the original amount specified here.\nManually creating such a grant would mean having the "amount", "minRolloverAmount", and "maxRolloverAmount" fields all be the same.'),
|
|
11904
12059
|
issueAfterResetPriority: zod.coerce
|
|
11905
12060
|
.number()
|
|
12061
|
+
.int()
|
|
11906
12062
|
.min(1)
|
|
11907
12063
|
.max(exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemOneEntitlementTemplateOneOneIssueAfterResetPriorityMax)
|
|
11908
12064
|
.default(exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemOneEntitlementTemplateOneOneIssueAfterResetPriorityDefault)
|
|
@@ -12084,6 +12240,7 @@ exports.ChangeSubscriptionBody = zod
|
|
|
12084
12240
|
.describe('You can grant usage automatically alongside the entitlement, the example scenario would be creating a starting balance.\nIf an amount is specified here, a grant will be created alongside the entitlement with the specified amount.\nThat grant will have it\'s rollover settings configured in a way that after each reset operation, the balance will return the original amount specified here.\nManually creating such a grant would mean having the "amount", "minRolloverAmount", and "maxRolloverAmount" fields all be the same.'),
|
|
12085
12241
|
issueAfterResetPriority: zod.coerce
|
|
12086
12242
|
.number()
|
|
12243
|
+
.int()
|
|
12087
12244
|
.min(1)
|
|
12088
12245
|
.max(exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoEntitlementTemplateOneOneIssueAfterResetPriorityMax)
|
|
12089
12246
|
.default(exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoEntitlementTemplateOneOneIssueAfterResetPriorityDefault)
|
|
@@ -12157,167 +12314,173 @@ exports.ChangeSubscriptionBody = zod
|
|
|
12157
12314
|
price: zod
|
|
12158
12315
|
.union([
|
|
12159
12316
|
zod
|
|
12160
|
-
.
|
|
12161
|
-
|
|
12162
|
-
.string()
|
|
12163
|
-
.regex(exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneOneAmountOneRegExp)
|
|
12164
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
12165
|
-
.describe('The amount of the flat price.'),
|
|
12166
|
-
paymentTerm: zod
|
|
12167
|
-
.enum(['in_advance', 'in_arrears'])
|
|
12168
|
-
.describe('The payment term of a flat price.\nOne of: in_advance or in_arrears.')
|
|
12169
|
-
.default(exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneOnePaymentTermDefault)
|
|
12170
|
-
.describe('The payment term of the flat price.\nDefaults to in advance.'),
|
|
12171
|
-
type: zod
|
|
12172
|
-
.enum(['flat'])
|
|
12173
|
-
.describe('The type of the price.'),
|
|
12174
|
-
})
|
|
12175
|
-
.describe('Flat price with payment term.'),
|
|
12176
|
-
zod
|
|
12177
|
-
.object({
|
|
12178
|
-
amount: zod.coerce
|
|
12179
|
-
.string()
|
|
12180
|
-
.regex(exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneTwoAmountOneRegExp)
|
|
12181
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
12182
|
-
.describe('The amount of the unit price.'),
|
|
12183
|
-
maximumAmount: zod.coerce
|
|
12184
|
-
.string()
|
|
12185
|
-
.regex(exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneTwoMaximumAmountOneRegExp)
|
|
12186
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
12187
|
-
.optional()
|
|
12188
|
-
.describe('The customer is limited to spend at most the amount.'),
|
|
12189
|
-
minimumAmount: zod.coerce
|
|
12190
|
-
.string()
|
|
12191
|
-
.regex(exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneTwoMinimumAmountOneRegExp)
|
|
12192
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
12193
|
-
.optional()
|
|
12194
|
-
.describe('The customer is committed to spend at least the amount.'),
|
|
12195
|
-
type: zod
|
|
12196
|
-
.enum(['unit'])
|
|
12197
|
-
.describe('The type of the price.'),
|
|
12198
|
-
})
|
|
12199
|
-
.describe('Unit price with spend commitments.'),
|
|
12200
|
-
zod
|
|
12201
|
-
.object({
|
|
12202
|
-
maximumAmount: zod.coerce
|
|
12203
|
-
.string()
|
|
12204
|
-
.regex(exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneThreeMaximumAmountOneRegExp)
|
|
12205
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
12206
|
-
.optional()
|
|
12207
|
-
.describe('The customer is limited to spend at most the amount.'),
|
|
12208
|
-
minimumAmount: zod.coerce
|
|
12209
|
-
.string()
|
|
12210
|
-
.regex(exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneThreeMinimumAmountOneRegExp)
|
|
12211
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
12212
|
-
.optional()
|
|
12213
|
-
.describe('The customer is committed to spend at least the amount.'),
|
|
12214
|
-
mode: zod
|
|
12215
|
-
.enum(['volume', 'graduated'])
|
|
12216
|
-
.describe('The mode of the tiered price.')
|
|
12217
|
-
.describe('Defines if the tiering mode is volume-based or graduated:\n- In `volume`-based tiering, the maximum quantity within a period determines the per unit price.\n- In `graduated` tiering, pricing can change as the quantity grows.'),
|
|
12218
|
-
tiers: zod
|
|
12219
|
-
.array(zod
|
|
12317
|
+
.union([
|
|
12318
|
+
zod
|
|
12220
12319
|
.object({
|
|
12221
|
-
|
|
12222
|
-
.
|
|
12223
|
-
|
|
12224
|
-
|
|
12225
|
-
|
|
12226
|
-
|
|
12227
|
-
|
|
12228
|
-
|
|
12229
|
-
|
|
12230
|
-
|
|
12231
|
-
|
|
12232
|
-
.
|
|
12233
|
-
.
|
|
12234
|
-
|
|
12235
|
-
|
|
12320
|
+
amount: zod.coerce
|
|
12321
|
+
.string()
|
|
12322
|
+
.regex(exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneOneAmountOneRegExp)
|
|
12323
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
12324
|
+
.describe('The amount of the flat price.'),
|
|
12325
|
+
paymentTerm: zod
|
|
12326
|
+
.enum([
|
|
12327
|
+
'in_advance',
|
|
12328
|
+
'in_arrears',
|
|
12329
|
+
])
|
|
12330
|
+
.describe('The payment term of a flat price.\nOne of: in_advance or in_arrears.')
|
|
12331
|
+
.default(exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneOnePaymentTermDefault)
|
|
12332
|
+
.describe('The payment term of the flat price.\nDefaults to in advance.'),
|
|
12333
|
+
type: zod
|
|
12334
|
+
.enum(['flat'])
|
|
12335
|
+
.describe('The type of the price.'),
|
|
12336
|
+
})
|
|
12337
|
+
.describe('Flat price with payment term.'),
|
|
12338
|
+
zod
|
|
12339
|
+
.object({
|
|
12340
|
+
amount: zod.coerce
|
|
12341
|
+
.string()
|
|
12342
|
+
.regex(exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneTwoAmountOneRegExp)
|
|
12343
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
12344
|
+
.describe('The amount of the unit price.'),
|
|
12345
|
+
maximumAmount: zod.coerce
|
|
12346
|
+
.string()
|
|
12347
|
+
.regex(exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneTwoMaximumAmountOneRegExp)
|
|
12348
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
12349
|
+
.optional()
|
|
12350
|
+
.describe('The customer is limited to spend at most the amount.'),
|
|
12351
|
+
minimumAmount: zod.coerce
|
|
12352
|
+
.string()
|
|
12353
|
+
.regex(exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneTwoMinimumAmountOneRegExp)
|
|
12354
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
12355
|
+
.optional()
|
|
12356
|
+
.describe('The customer is committed to spend at least the amount.'),
|
|
12357
|
+
type: zod
|
|
12358
|
+
.enum(['unit'])
|
|
12359
|
+
.describe('The type of the price.'),
|
|
12360
|
+
})
|
|
12361
|
+
.describe('Unit price with spend commitments.'),
|
|
12362
|
+
zod
|
|
12363
|
+
.object({
|
|
12364
|
+
maximumAmount: zod.coerce
|
|
12365
|
+
.string()
|
|
12366
|
+
.regex(exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneThreeMaximumAmountOneRegExp)
|
|
12367
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
12368
|
+
.optional()
|
|
12369
|
+
.describe('The customer is limited to spend at most the amount.'),
|
|
12370
|
+
minimumAmount: zod.coerce
|
|
12371
|
+
.string()
|
|
12372
|
+
.regex(exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneThreeMinimumAmountOneRegExp)
|
|
12373
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
12374
|
+
.optional()
|
|
12375
|
+
.describe('The customer is committed to spend at least the amount.'),
|
|
12376
|
+
mode: zod
|
|
12377
|
+
.enum(['volume', 'graduated'])
|
|
12378
|
+
.describe('The mode of the tiered price.')
|
|
12379
|
+
.describe('Defines if the tiering mode is volume-based or graduated:\n- In `volume`-based tiering, the maximum quantity within a period determines the per unit price.\n- In `graduated` tiering, pricing can change as the quantity grows.'),
|
|
12380
|
+
tiers: zod
|
|
12381
|
+
.array(zod
|
|
12236
12382
|
.object({
|
|
12237
|
-
|
|
12383
|
+
flatPrice: zod
|
|
12384
|
+
.object({
|
|
12385
|
+
amount: zod.coerce
|
|
12386
|
+
.string()
|
|
12387
|
+
.regex(exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneThreeTiersItemFlatPriceOneAmountOneRegExp)
|
|
12388
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
12389
|
+
.describe('The amount of the flat price.'),
|
|
12390
|
+
type: zod
|
|
12391
|
+
.enum(['flat'])
|
|
12392
|
+
.describe('The type of the price.'),
|
|
12393
|
+
})
|
|
12394
|
+
.describe('Flat price.')
|
|
12395
|
+
.nullable()
|
|
12396
|
+
.describe('The flat price component of the tier.'),
|
|
12397
|
+
unitPrice: zod
|
|
12398
|
+
.object({
|
|
12399
|
+
amount: zod.coerce
|
|
12400
|
+
.string()
|
|
12401
|
+
.regex(exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneThreeTiersItemUnitPriceOneAmountOneRegExp)
|
|
12402
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
12403
|
+
.describe('The amount of the unit price.'),
|
|
12404
|
+
type: zod
|
|
12405
|
+
.enum(['unit'])
|
|
12406
|
+
.describe('The type of the price.'),
|
|
12407
|
+
})
|
|
12408
|
+
.describe('Unit price.')
|
|
12409
|
+
.nullable()
|
|
12410
|
+
.describe('The unit price component of the tier.'),
|
|
12411
|
+
upToAmount: zod.coerce
|
|
12238
12412
|
.string()
|
|
12239
|
-
.regex(exports.
|
|
12413
|
+
.regex(exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneThreeTiersItemUpToAmountOneRegExp)
|
|
12240
12414
|
.describe('Numeric represents an arbitrary precision number.')
|
|
12241
|
-
.
|
|
12242
|
-
|
|
12243
|
-
.enum(['unit'])
|
|
12244
|
-
.describe('The type of the price.'),
|
|
12415
|
+
.optional()
|
|
12416
|
+
.describe('Up to and including to this quantity will be contained in the tier.\nIf null, the tier is open-ended.'),
|
|
12245
12417
|
})
|
|
12246
|
-
.describe('
|
|
12247
|
-
.
|
|
12248
|
-
.describe('The
|
|
12249
|
-
|
|
12418
|
+
.describe('A price tier.\nAt least one price component is required in each tier.'))
|
|
12419
|
+
.min(1)
|
|
12420
|
+
.describe('The tiers of the tiered price.\nAt least one price component is required in each tier.'),
|
|
12421
|
+
type: zod
|
|
12422
|
+
.enum(['tiered'])
|
|
12423
|
+
.describe('The type of the price.\n\nOne of: flat, unit, or tiered.'),
|
|
12424
|
+
})
|
|
12425
|
+
.describe('Tiered price with spend commitments.'),
|
|
12426
|
+
zod
|
|
12427
|
+
.object({
|
|
12428
|
+
maximumAmount: zod.coerce
|
|
12250
12429
|
.string()
|
|
12251
|
-
.regex(exports.
|
|
12430
|
+
.regex(exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFourMaximumAmountOneRegExp)
|
|
12252
12431
|
.describe('Numeric represents an arbitrary precision number.')
|
|
12253
12432
|
.optional()
|
|
12254
|
-
.describe('
|
|
12433
|
+
.describe('The customer is limited to spend at most the amount.'),
|
|
12434
|
+
minimumAmount: zod.coerce
|
|
12435
|
+
.string()
|
|
12436
|
+
.regex(exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFourMinimumAmountOneRegExp)
|
|
12437
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
12438
|
+
.optional()
|
|
12439
|
+
.describe('The customer is committed to spend at least the amount.'),
|
|
12440
|
+
multiplier: zod.coerce
|
|
12441
|
+
.string()
|
|
12442
|
+
.regex(exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFourMultiplierOneRegExp)
|
|
12443
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
12444
|
+
.default(exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFourMultiplierDefault)
|
|
12445
|
+
.describe('The multiplier to apply to the base price to get the dynamic price.\n\nExamples:\n- 0.0: the price is zero\n- 0.5: the price is 50% of the base price\n- 1.0: the price is the same as the base price\n- 1.5: the price is 150% of the base price'),
|
|
12446
|
+
type: zod
|
|
12447
|
+
.enum(['dynamic'])
|
|
12448
|
+
.describe('The type of the price.'),
|
|
12255
12449
|
})
|
|
12256
|
-
.describe('
|
|
12257
|
-
|
|
12258
|
-
.
|
|
12259
|
-
|
|
12260
|
-
|
|
12261
|
-
|
|
12262
|
-
|
|
12263
|
-
|
|
12264
|
-
|
|
12265
|
-
|
|
12266
|
-
|
|
12267
|
-
|
|
12268
|
-
|
|
12269
|
-
|
|
12270
|
-
.
|
|
12271
|
-
|
|
12272
|
-
|
|
12273
|
-
|
|
12274
|
-
|
|
12275
|
-
|
|
12276
|
-
.
|
|
12277
|
-
|
|
12278
|
-
|
|
12279
|
-
|
|
12280
|
-
|
|
12281
|
-
|
|
12282
|
-
|
|
12283
|
-
|
|
12284
|
-
|
|
12285
|
-
.
|
|
12286
|
-
|
|
12287
|
-
|
|
12288
|
-
|
|
12289
|
-
zod
|
|
12290
|
-
.object({
|
|
12291
|
-
amount: zod.coerce
|
|
12292
|
-
.string()
|
|
12293
|
-
.regex(exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFiveAmountOneRegExp)
|
|
12294
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
12295
|
-
.describe('The price of one package.'),
|
|
12296
|
-
maximumAmount: zod.coerce
|
|
12297
|
-
.string()
|
|
12298
|
-
.regex(exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFiveMaximumAmountOneRegExp)
|
|
12299
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
12300
|
-
.optional()
|
|
12301
|
-
.describe('The customer is limited to spend at most the amount.'),
|
|
12302
|
-
minimumAmount: zod.coerce
|
|
12303
|
-
.string()
|
|
12304
|
-
.regex(exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFiveMinimumAmountOneRegExp)
|
|
12305
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
12306
|
-
.optional()
|
|
12307
|
-
.describe('The customer is committed to spend at least the amount.'),
|
|
12308
|
-
quantityPerPackage: zod.coerce
|
|
12309
|
-
.string()
|
|
12310
|
-
.regex(exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFiveQuantityPerPackageOneRegExp)
|
|
12311
|
-
.describe('Numeric represents an arbitrary precision number.')
|
|
12312
|
-
.describe('The quantity per package.'),
|
|
12313
|
-
type: zod
|
|
12314
|
-
.enum(['package'])
|
|
12315
|
-
.describe('The type of the price.'),
|
|
12316
|
-
})
|
|
12317
|
-
.describe('Package price with spend commitments.'),
|
|
12450
|
+
.describe('Dynamic price with spend commitments.'),
|
|
12451
|
+
zod
|
|
12452
|
+
.object({
|
|
12453
|
+
amount: zod.coerce
|
|
12454
|
+
.string()
|
|
12455
|
+
.regex(exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFiveAmountOneRegExp)
|
|
12456
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
12457
|
+
.describe('The price of one package.'),
|
|
12458
|
+
maximumAmount: zod.coerce
|
|
12459
|
+
.string()
|
|
12460
|
+
.regex(exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFiveMaximumAmountOneRegExp)
|
|
12461
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
12462
|
+
.optional()
|
|
12463
|
+
.describe('The customer is limited to spend at most the amount.'),
|
|
12464
|
+
minimumAmount: zod.coerce
|
|
12465
|
+
.string()
|
|
12466
|
+
.regex(exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFiveMinimumAmountOneRegExp)
|
|
12467
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
12468
|
+
.optional()
|
|
12469
|
+
.describe('The customer is committed to spend at least the amount.'),
|
|
12470
|
+
quantityPerPackage: zod.coerce
|
|
12471
|
+
.string()
|
|
12472
|
+
.regex(exports.changeSubscriptionBodyTwoCustomPlanOneOnePhasesItemRateCardsItemTwoPriceOneFiveQuantityPerPackageOneRegExp)
|
|
12473
|
+
.describe('Numeric represents an arbitrary precision number.')
|
|
12474
|
+
.describe('The quantity per package.'),
|
|
12475
|
+
type: zod
|
|
12476
|
+
.enum(['package'])
|
|
12477
|
+
.describe('The type of the price.'),
|
|
12478
|
+
})
|
|
12479
|
+
.describe('Package price with spend commitments.'),
|
|
12480
|
+
])
|
|
12481
|
+
.describe('The price of the usage based rate card.'),
|
|
12482
|
+
zod.null(),
|
|
12318
12483
|
])
|
|
12319
|
-
.describe('The price of the usage based rate card.')
|
|
12320
|
-
.nullable()
|
|
12321
12484
|
.describe('The price of the rate card.\nWhen null, the feature or service is free.'),
|
|
12322
12485
|
taxConfig: zod
|
|
12323
12486
|
.object({
|
|
@@ -12406,9 +12569,17 @@ exports.ChangeSubscriptionBody = zod
|
|
|
12406
12569
|
])
|
|
12407
12570
|
.describe('Change a subscription.');
|
|
12408
12571
|
/**
|
|
12409
|
-
* Migrates
|
|
12410
|
-
* If
|
|
12411
|
-
*
|
|
12572
|
+
* Migrates a running subscription to a later version of its current plan.
|
|
12573
|
+
* If startingPhase is omitted and billingAnchor is omitted or unchanged, the subscription is amended in place.
|
|
12574
|
+
* Unchanged items retain their service periods. Changed or removed items end at
|
|
12575
|
+
* the effective time; replacements and additions start from that time.
|
|
12576
|
+
* For in-place migrations, existing addons must be compatible with the target plan version.
|
|
12577
|
+
* The phase timeline, billing anchor, and subscription-level billing settings
|
|
12578
|
+
* are preserved. Both response entries refer to the same subscription:
|
|
12579
|
+
* current is the before snapshot and next is the amended view.
|
|
12580
|
+
* Providing startingPhase or a different billingAnchor uses subscription change: the current subscription
|
|
12581
|
+
* ends and a replacement starts at the effective time. This resets the phase timeline
|
|
12582
|
+
* and can produce billing adjustments. Addons are not transferred to the replacement.
|
|
12412
12583
|
* @summary Migrate subscription
|
|
12413
12584
|
*/
|
|
12414
12585
|
exports.migrateSubscriptionPathSubscriptionIdRegExp = /^[0-7][0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{25}$/;
|
|
@@ -12422,17 +12593,18 @@ exports.MigrateSubscriptionBody = zod.object({
|
|
|
12422
12593
|
billingAnchor: zod.coerce
|
|
12423
12594
|
.date()
|
|
12424
12595
|
.optional()
|
|
12425
|
-
.describe(
|
|
12596
|
+
.describe("The anchor used with the plan's billing cadence to calculate billing periods.\nIf startingPhase is omitted and this anchor is omitted or equal to the existing one, migration preserves the current subscription.\nProviding a different anchor ends the current subscription and creates a replacement.\nThe supplied anchor is preserved; it may be before or after the replacement's start time."),
|
|
12426
12597
|
startingPhase: zod.coerce
|
|
12427
12598
|
.string()
|
|
12428
12599
|
.min(1)
|
|
12429
12600
|
.optional()
|
|
12430
|
-
.describe('
|
|
12601
|
+
.describe('Explicitly replace the subscription, starting in this target plan phase.\nProviding this field always selects replacement, even if the phase matches the current one.\nReplacement may produce billing adjustments and does not transfer addons.\nOmit it to migrate in place; incompatible phase timelines then return an error.'),
|
|
12431
12602
|
targetVersion: zod.coerce
|
|
12432
12603
|
.number()
|
|
12604
|
+
.int()
|
|
12433
12605
|
.min(1)
|
|
12434
12606
|
.optional()
|
|
12435
|
-
.describe('
|
|
12607
|
+
.describe('A strictly later version of the current plan to migrate to.\nIf not provided, the subscription will migrate to the latest version of the current plan.'),
|
|
12436
12608
|
timing: zod
|
|
12437
12609
|
.union([
|
|
12438
12610
|
zod
|
|
@@ -12444,7 +12616,7 @@ exports.MigrateSubscriptionBody = zod.object({
|
|
|
12444
12616
|
])
|
|
12445
12617
|
.describe('Subscription edit timing defined when the changes should take effect.\nIf the provided configuration is not supported by the subscription, an error will be returned.')
|
|
12446
12618
|
.default(exports.migrateSubscriptionBodyTimingDefault)
|
|
12447
|
-
.describe('
|
|
12619
|
+
.describe('When the migration takes effect: immediately, at the next billing cycle, or at an explicit billing-aligned timestamp.\nIn-place migrations may be scheduled into a later phase when the current and target phase timelines match.\nThe target plan reference is saved immediately; changed items take effect at the requested time.\nPast or unsupported times return an error.'),
|
|
12448
12620
|
});
|
|
12449
12621
|
/**
|
|
12450
12622
|
* Restores a canceled subscription.
|
|
@@ -12555,6 +12727,7 @@ exports.CreateCustomerEntitlementV2Body = zod
|
|
|
12555
12727
|
.object({
|
|
12556
12728
|
count: zod.coerce
|
|
12557
12729
|
.number()
|
|
12730
|
+
.int()
|
|
12558
12731
|
.min(1)
|
|
12559
12732
|
.max(exports.createCustomerEntitlementV2BodyOneGrantsItemExpirationOneCountMax)
|
|
12560
12733
|
.describe('The number of time units in the expiration period.'),
|
|
@@ -12581,6 +12754,7 @@ exports.CreateCustomerEntitlementV2Body = zod
|
|
|
12581
12754
|
.describe('Grants are rolled over at reset, after which they can have a different balance compared to what they had before the reset.\nBalance after the reset is calculated as: Balance_After_Reset = MIN(MaxRolloverAmount, MAX(Balance_Before_Reset, MinRolloverAmount))'),
|
|
12582
12755
|
priority: zod.coerce
|
|
12583
12756
|
.number()
|
|
12757
|
+
.int()
|
|
12584
12758
|
.min(1)
|
|
12585
12759
|
.max(exports.createCustomerEntitlementV2BodyOneGrantsItemPriorityMax)
|
|
12586
12760
|
.optional()
|
|
@@ -12622,6 +12796,7 @@ exports.CreateCustomerEntitlementV2Body = zod
|
|
|
12622
12796
|
.describe('The initial grant amount'),
|
|
12623
12797
|
priority: zod.coerce
|
|
12624
12798
|
.number()
|
|
12799
|
+
.int()
|
|
12625
12800
|
.min(1)
|
|
12626
12801
|
.max(exports.createCustomerEntitlementV2BodyOneIssueOnePriorityMax)
|
|
12627
12802
|
.default(exports.createCustomerEntitlementV2BodyOneIssueOnePriorityDefault)
|
|
@@ -12637,6 +12812,7 @@ exports.CreateCustomerEntitlementV2Body = zod
|
|
|
12637
12812
|
.describe('You can grant usage automatically alongside the entitlement, the example scenario would be creating a starting balance.\nIf an amount is specified here, a grant will be created alongside the entitlement with the specified amount.\nThat grant will have it\'s rollover settings configured in a way that after each reset operation, the balance will return the original amount specified here.\nManually creating such a grant would mean having the "amount", "minRolloverAmount", and "maxRolloverAmount" fields all be the same.'),
|
|
12638
12813
|
issueAfterResetPriority: zod.coerce
|
|
12639
12814
|
.number()
|
|
12815
|
+
.int()
|
|
12640
12816
|
.min(1)
|
|
12641
12817
|
.max(exports.createCustomerEntitlementV2BodyOneIssueAfterResetPriorityMax)
|
|
12642
12818
|
.default(exports.createCustomerEntitlementV2BodyOneIssueAfterResetPriorityDefault)
|
|
@@ -12644,7 +12820,10 @@ exports.CreateCustomerEntitlementV2Body = zod
|
|
|
12644
12820
|
measureUsageFrom: zod
|
|
12645
12821
|
.union([
|
|
12646
12822
|
zod
|
|
12647
|
-
.enum(
|
|
12823
|
+
.enum({
|
|
12824
|
+
CurrentPeriodStart: 'CURRENT_PERIOD_START',
|
|
12825
|
+
Now: 'NOW',
|
|
12826
|
+
})
|
|
12648
12827
|
.describe('Start of measurement options'),
|
|
12649
12828
|
zod.coerce
|
|
12650
12829
|
.date()
|
|
@@ -12815,11 +12994,13 @@ exports.ListCustomerEntitlementsV2QueryParams = zod.object({
|
|
|
12815
12994
|
.describe('The order by field.'),
|
|
12816
12995
|
page: zod.coerce
|
|
12817
12996
|
.number()
|
|
12997
|
+
.int()
|
|
12818
12998
|
.min(1)
|
|
12819
12999
|
.default(exports.listCustomerEntitlementsV2QueryPageDefault)
|
|
12820
13000
|
.describe('Page index.\n\nDefault is 1.'),
|
|
12821
13001
|
pageSize: zod.coerce
|
|
12822
13002
|
.number()
|
|
13003
|
+
.int()
|
|
12823
13004
|
.min(1)
|
|
12824
13005
|
.max(exports.listCustomerEntitlementsV2QueryPageSizeMax)
|
|
12825
13006
|
.default(exports.listCustomerEntitlementsV2QueryPageSizeDefault)
|
|
@@ -12920,12 +13101,14 @@ exports.ListCustomerEntitlementGrantsV2QueryParams = zod.object({
|
|
|
12920
13101
|
.default(exports.listCustomerEntitlementGrantsV2QueryIncludeDeletedDefault),
|
|
12921
13102
|
limit: zod.coerce
|
|
12922
13103
|
.number()
|
|
13104
|
+
.int()
|
|
12923
13105
|
.min(1)
|
|
12924
13106
|
.max(exports.listCustomerEntitlementGrantsV2QueryLimitMax)
|
|
12925
13107
|
.default(exports.listCustomerEntitlementGrantsV2QueryLimitDefault)
|
|
12926
13108
|
.describe('Number of items to return.\n\nDefault is 100.'),
|
|
12927
13109
|
offset: zod.coerce
|
|
12928
13110
|
.number()
|
|
13111
|
+
.int()
|
|
12929
13112
|
.min(exports.listCustomerEntitlementGrantsV2QueryOffsetMin)
|
|
12930
13113
|
.default(exports.listCustomerEntitlementGrantsV2QueryOffsetDefault)
|
|
12931
13114
|
.describe('Number of items to skip.\n\nDefault is 0.'),
|
|
@@ -12940,11 +13123,13 @@ exports.ListCustomerEntitlementGrantsV2QueryParams = zod.object({
|
|
|
12940
13123
|
.describe('The order by field.'),
|
|
12941
13124
|
page: zod.coerce
|
|
12942
13125
|
.number()
|
|
13126
|
+
.int()
|
|
12943
13127
|
.min(1)
|
|
12944
13128
|
.default(exports.listCustomerEntitlementGrantsV2QueryPageDefault)
|
|
12945
13129
|
.describe('Page index.\n\nDefault is 1.'),
|
|
12946
13130
|
pageSize: zod.coerce
|
|
12947
13131
|
.number()
|
|
13132
|
+
.int()
|
|
12948
13133
|
.min(1)
|
|
12949
13134
|
.max(exports.listCustomerEntitlementGrantsV2QueryPageSizeMax)
|
|
12950
13135
|
.default(exports.listCustomerEntitlementGrantsV2QueryPageSizeDefault)
|
|
@@ -13009,6 +13194,7 @@ exports.CreateCustomerEntitlementGrantV2Body = zod
|
|
|
13009
13194
|
.object({
|
|
13010
13195
|
count: zod.coerce
|
|
13011
13196
|
.number()
|
|
13197
|
+
.int()
|
|
13012
13198
|
.min(1)
|
|
13013
13199
|
.max(exports.createCustomerEntitlementGrantV2BodyExpirationOneCountMax)
|
|
13014
13200
|
.describe('The number of time units in the expiration period.'),
|
|
@@ -13035,6 +13221,7 @@ exports.CreateCustomerEntitlementGrantV2Body = zod
|
|
|
13035
13221
|
.describe('Grants are rolled over at reset, after which they can have a different balance compared to what they had before the reset.\nBalance after the reset is calculated as: Balance_After_Reset = MIN(MaxRolloverAmount, MAX(Balance_Before_Reset, MinRolloverAmount))'),
|
|
13036
13222
|
priority: zod.coerce
|
|
13037
13223
|
.number()
|
|
13224
|
+
.int()
|
|
13038
13225
|
.min(1)
|
|
13039
13226
|
.max(exports.createCustomerEntitlementGrantV2BodyPriorityMax)
|
|
13040
13227
|
.optional()
|
|
@@ -13103,7 +13290,12 @@ exports.GetCustomerEntitlementHistoryV2QueryParams = zod.object({
|
|
|
13103
13290
|
.optional()
|
|
13104
13291
|
.describe('End of time range to query entitlement: date-time in RFC 3339 format. Defaults to now.\nIf not now then gets truncated to the granularity of the underlying meter.'),
|
|
13105
13292
|
windowSize: zod
|
|
13106
|
-
.enum(
|
|
13293
|
+
.enum({
|
|
13294
|
+
Day: 'DAY',
|
|
13295
|
+
Hour: 'HOUR',
|
|
13296
|
+
Minute: 'MINUTE',
|
|
13297
|
+
Month: 'MONTH',
|
|
13298
|
+
})
|
|
13107
13299
|
.describe('Windowsize'),
|
|
13108
13300
|
windowTimeZone: zod.coerce
|
|
13109
13301
|
.string()
|
|
@@ -13204,6 +13396,7 @@ exports.OverrideCustomerEntitlementV2Body = zod
|
|
|
13204
13396
|
.object({
|
|
13205
13397
|
count: zod.coerce
|
|
13206
13398
|
.number()
|
|
13399
|
+
.int()
|
|
13207
13400
|
.min(1)
|
|
13208
13401
|
.max(exports.overrideCustomerEntitlementV2BodyOneGrantsItemExpirationOneCountMax)
|
|
13209
13402
|
.describe('The number of time units in the expiration period.'),
|
|
@@ -13230,6 +13423,7 @@ exports.OverrideCustomerEntitlementV2Body = zod
|
|
|
13230
13423
|
.describe('Grants are rolled over at reset, after which they can have a different balance compared to what they had before the reset.\nBalance after the reset is calculated as: Balance_After_Reset = MIN(MaxRolloverAmount, MAX(Balance_Before_Reset, MinRolloverAmount))'),
|
|
13231
13424
|
priority: zod.coerce
|
|
13232
13425
|
.number()
|
|
13426
|
+
.int()
|
|
13233
13427
|
.min(1)
|
|
13234
13428
|
.max(exports.overrideCustomerEntitlementV2BodyOneGrantsItemPriorityMax)
|
|
13235
13429
|
.optional()
|
|
@@ -13271,6 +13465,7 @@ exports.OverrideCustomerEntitlementV2Body = zod
|
|
|
13271
13465
|
.describe('The initial grant amount'),
|
|
13272
13466
|
priority: zod.coerce
|
|
13273
13467
|
.number()
|
|
13468
|
+
.int()
|
|
13274
13469
|
.min(1)
|
|
13275
13470
|
.max(exports.overrideCustomerEntitlementV2BodyOneIssueOnePriorityMax)
|
|
13276
13471
|
.default(exports.overrideCustomerEntitlementV2BodyOneIssueOnePriorityDefault)
|
|
@@ -13286,6 +13481,7 @@ exports.OverrideCustomerEntitlementV2Body = zod
|
|
|
13286
13481
|
.describe('You can grant usage automatically alongside the entitlement, the example scenario would be creating a starting balance.\nIf an amount is specified here, a grant will be created alongside the entitlement with the specified amount.\nThat grant will have it\'s rollover settings configured in a way that after each reset operation, the balance will return the original amount specified here.\nManually creating such a grant would mean having the "amount", "minRolloverAmount", and "maxRolloverAmount" fields all be the same.'),
|
|
13287
13482
|
issueAfterResetPriority: zod.coerce
|
|
13288
13483
|
.number()
|
|
13484
|
+
.int()
|
|
13289
13485
|
.min(1)
|
|
13290
13486
|
.max(exports.overrideCustomerEntitlementV2BodyOneIssueAfterResetPriorityMax)
|
|
13291
13487
|
.default(exports.overrideCustomerEntitlementV2BodyOneIssueAfterResetPriorityDefault)
|
|
@@ -13293,7 +13489,10 @@ exports.OverrideCustomerEntitlementV2Body = zod
|
|
|
13293
13489
|
measureUsageFrom: zod
|
|
13294
13490
|
.union([
|
|
13295
13491
|
zod
|
|
13296
|
-
.enum(
|
|
13492
|
+
.enum({
|
|
13493
|
+
CurrentPeriodStart: 'CURRENT_PERIOD_START',
|
|
13494
|
+
Now: 'NOW',
|
|
13495
|
+
})
|
|
13297
13496
|
.describe('Start of measurement options'),
|
|
13298
13497
|
zod.coerce
|
|
13299
13498
|
.date()
|
|
@@ -13537,12 +13736,14 @@ exports.ListEntitlementsV2QueryParams = zod.object({
|
|
|
13537
13736
|
.describe('Filtering by multiple features.\n\nUsage: `?feature=feature-1&feature=feature-2`'),
|
|
13538
13737
|
limit: zod.coerce
|
|
13539
13738
|
.number()
|
|
13739
|
+
.int()
|
|
13540
13740
|
.min(1)
|
|
13541
13741
|
.max(exports.listEntitlementsV2QueryLimitMax)
|
|
13542
13742
|
.default(exports.listEntitlementsV2QueryLimitDefault)
|
|
13543
13743
|
.describe('Number of items to return.\n\nDefault is 100.'),
|
|
13544
13744
|
offset: zod.coerce
|
|
13545
13745
|
.number()
|
|
13746
|
+
.int()
|
|
13546
13747
|
.min(exports.listEntitlementsV2QueryOffsetMin)
|
|
13547
13748
|
.default(exports.listEntitlementsV2QueryOffsetDefault)
|
|
13548
13749
|
.describe('Number of items to skip.\n\nDefault is 0.'),
|
|
@@ -13557,11 +13758,13 @@ exports.ListEntitlementsV2QueryParams = zod.object({
|
|
|
13557
13758
|
.describe('The order by field.'),
|
|
13558
13759
|
page: zod.coerce
|
|
13559
13760
|
.number()
|
|
13761
|
+
.int()
|
|
13560
13762
|
.min(1)
|
|
13561
13763
|
.default(exports.listEntitlementsV2QueryPageDefault)
|
|
13562
13764
|
.describe('Page index.\n\nDefault is 1.'),
|
|
13563
13765
|
pageSize: zod.coerce
|
|
13564
13766
|
.number()
|
|
13767
|
+
.int()
|
|
13565
13768
|
.min(1)
|
|
13566
13769
|
.max(exports.listEntitlementsV2QueryPageSizeMax)
|
|
13567
13770
|
.default(exports.listEntitlementsV2QueryPageSizeDefault)
|
|
@@ -13597,6 +13800,7 @@ exports.ListEventsV2QueryParams = zod.object({
|
|
|
13597
13800
|
.describe('The cursor after which to start the pagination.'),
|
|
13598
13801
|
limit: zod.coerce
|
|
13599
13802
|
.number()
|
|
13803
|
+
.int()
|
|
13600
13804
|
.min(1)
|
|
13601
13805
|
.max(exports.listEventsV2QueryLimitMax)
|
|
13602
13806
|
.default(exports.listEventsV2QueryLimitDefault)
|
|
@@ -13646,12 +13850,14 @@ exports.ListGrantsV2QueryParams = zod.object({
|
|
|
13646
13850
|
.describe('Include deleted'),
|
|
13647
13851
|
limit: zod.coerce
|
|
13648
13852
|
.number()
|
|
13853
|
+
.int()
|
|
13649
13854
|
.min(1)
|
|
13650
13855
|
.max(exports.listGrantsV2QueryLimitMax)
|
|
13651
13856
|
.default(exports.listGrantsV2QueryLimitDefault)
|
|
13652
13857
|
.describe('Number of items to return.\n\nDefault is 100.'),
|
|
13653
13858
|
offset: zod.coerce
|
|
13654
13859
|
.number()
|
|
13860
|
+
.int()
|
|
13655
13861
|
.min(exports.listGrantsV2QueryOffsetMin)
|
|
13656
13862
|
.default(exports.listGrantsV2QueryOffsetDefault)
|
|
13657
13863
|
.describe('Number of items to skip.\n\nDefault is 0.'),
|
|
@@ -13666,11 +13872,13 @@ exports.ListGrantsV2QueryParams = zod.object({
|
|
|
13666
13872
|
.describe('The order by field.'),
|
|
13667
13873
|
page: zod.coerce
|
|
13668
13874
|
.number()
|
|
13875
|
+
.int()
|
|
13669
13876
|
.min(1)
|
|
13670
13877
|
.default(exports.listGrantsV2QueryPageDefault)
|
|
13671
13878
|
.describe('Page index.\n\nDefault is 1.'),
|
|
13672
13879
|
pageSize: zod.coerce
|
|
13673
13880
|
.number()
|
|
13881
|
+
.int()
|
|
13674
13882
|
.min(1)
|
|
13675
13883
|
.max(exports.listGrantsV2QueryPageSizeMax)
|
|
13676
13884
|
.default(exports.listGrantsV2QueryPageSizeDefault)
|