@schematichq/schematic-typescript-node 1.6.3 → 1.6.5
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/README.md +18 -3
- package/dist/api/resources/accounts/client/requests/UpdateEnvironmentRequestBody.d.ts +1 -0
- package/dist/api/resources/billing/client/Client.d.ts +38 -6
- package/dist/api/resources/billing/client/requests/CreateBillingPriceRequestBody.d.ts +2 -2
- package/dist/api/resources/billing/client/requests/CreateBillingSubscriptionRequestBody.d.ts +3 -3
- package/dist/api/resources/billing/client/requests/CreateCouponRequestBody.d.ts +2 -1
- package/dist/api/resources/billing/client/requests/CreateInvoiceRequestBody.d.ts +2 -2
- package/dist/api/resources/billing/client/requests/ListBillingPricesRequest.d.ts +2 -2
- package/dist/api/resources/billing/client/requests/ListBillingProductPricesRequest.d.ts +2 -2
- package/dist/api/resources/billing/client/requests/UpdateBillingSettingsRequestBody.d.ts +8 -0
- package/dist/api/resources/billing/client/requests/index.d.ts +1 -0
- package/dist/api/resources/billing/types/GetBillingSettingsResponse.d.ts +6 -0
- package/dist/api/resources/billing/types/ListBillingPricesParams.d.ts +1 -1
- package/dist/api/resources/billing/types/ListBillingProductPricesParams.d.ts +1 -1
- package/dist/api/resources/billing/types/UpdateBillingSettingsResponse.d.ts +6 -0
- package/dist/api/resources/billing/types/index.d.ts +2 -0
- package/dist/api/resources/checkout/client/requests/CheckoutDataRequestBody.d.ts +2 -1
- package/dist/api/resources/companies/client/Client.d.ts +1 -1
- package/dist/api/resources/companies/client/requests/ListPlanChangesRequest.d.ts +1 -1
- package/dist/api/resources/credits/client/Client.d.ts +47 -6
- package/dist/api/resources/credits/client/requests/AcquireCreditLeaseRequestBody.d.ts +2 -0
- package/dist/api/resources/credits/client/requests/CountCreditEventLedgerRequest.d.ts +1 -1
- package/dist/api/resources/credits/client/requests/CreateBillingCreditRequestBody.d.ts +2 -2
- package/dist/api/resources/credits/client/requests/CreateCompanyCreditGrant.d.ts +1 -1
- package/dist/api/resources/credits/client/requests/CreateCreditBundleRequestBody.d.ts +2 -2
- package/dist/api/resources/credits/client/requests/CreateCreditSpendPolicyRequestBody.d.ts +8 -4
- package/dist/api/resources/credits/client/requests/ExtendCreditLeaseRequestBody.d.ts +2 -0
- package/dist/api/resources/credits/client/requests/GetCreditBalanceTimeSeriesRequest.d.ts +15 -0
- package/dist/api/resources/credits/client/requests/GetCreditSpendPolicyUsageRequest.d.ts +13 -0
- package/dist/api/resources/credits/client/requests/ListCreditEventLedgerRequest.d.ts +1 -1
- package/dist/api/resources/credits/client/requests/UpdateCreditSpendPolicyRequestBody.d.ts +3 -0
- package/dist/api/resources/credits/client/requests/index.d.ts +2 -0
- package/dist/api/resources/credits/types/GetCreditBalanceTimeSeriesParams.d.ts +9 -0
- package/dist/api/resources/credits/types/GetCreditBalanceTimeSeriesResponse.d.ts +6 -0
- package/dist/api/resources/credits/types/GetCreditSpendPolicyUsageParams.d.ts +8 -0
- package/dist/api/resources/credits/types/GetCreditSpendPolicyUsageResponse.d.ts +6 -0
- package/dist/api/resources/credits/types/index.d.ts +4 -0
- package/dist/api/resources/entitlements/client/Client.d.ts +69 -0
- package/dist/api/resources/entitlements/client/requests/CountCompanyUserUsageRequest.d.ts +29 -0
- package/dist/api/resources/entitlements/client/requests/CreateBillingLinkedPlanEntitlementRequestBody.d.ts +3 -1
- package/dist/api/resources/entitlements/client/requests/CreateCompanyOverrideRequestBody.d.ts +2 -0
- package/dist/api/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.d.ts +3 -1
- package/dist/api/resources/entitlements/client/requests/GetCompanyUserUsageMetricsRequest.d.ts +16 -0
- package/dist/api/resources/entitlements/client/requests/ListCompanyUserUsageRequest.d.ts +29 -0
- package/dist/api/resources/entitlements/client/requests/UpdateCompanyOverrideRequestBody.d.ts +2 -0
- package/dist/api/resources/entitlements/client/requests/UpdatePlanEntitlementRequestBody.d.ts +3 -1
- package/dist/api/resources/entitlements/client/requests/index.d.ts +3 -0
- package/dist/api/resources/entitlements/types/CountCompanyUserUsageParams.d.ts +20 -0
- package/dist/api/resources/entitlements/types/CountCompanyUserUsageResponse.d.ts +6 -0
- package/dist/api/resources/entitlements/types/GetCompanyUserUsageMetricsParams.d.ts +11 -0
- package/dist/api/resources/entitlements/types/GetCompanyUserUsageMetricsResponse.d.ts +6 -0
- package/dist/api/resources/entitlements/types/ListCompanyUserUsageParams.d.ts +20 -0
- package/dist/api/resources/entitlements/types/ListCompanyUserUsageResponse.d.ts +6 -0
- package/dist/api/resources/entitlements/types/index.d.ts +6 -0
- package/dist/api/resources/features/client/requests/CreateBillingLinkedFeatureRequestBody.d.ts +2 -0
- package/dist/api/resources/features/client/requests/CreateFeatureRequestBody.d.ts +2 -0
- package/dist/api/resources/features/client/requests/UpdateFeatureRequestBody.d.ts +2 -0
- package/dist/api/resources/plangroups/client/Client.d.ts +2 -0
- package/dist/api/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts +2 -0
- package/dist/api/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts +2 -0
- package/dist/api/resources/planmigrations/client/Client.d.ts +2 -0
- package/dist/api/resources/planmigrations/client/requests/CountMigrationsRequest.d.ts +2 -0
- package/dist/api/resources/planmigrations/client/requests/CreateMigrationInput.d.ts +3 -0
- package/dist/api/resources/planmigrations/client/requests/ListMigrationsRequest.d.ts +2 -0
- package/dist/api/resources/planmigrations/types/CountMigrationsParams.d.ts +1 -0
- package/dist/api/resources/planmigrations/types/ListMigrationsParams.d.ts +1 -0
- package/dist/api/resources/plans/client/Client.d.ts +20 -1
- package/dist/api/resources/plans/client/requests/GetPlanVersionDiffRequest.d.ts +10 -0
- package/dist/api/resources/plans/client/requests/ListCustomPlanBillingsRequest.d.ts +2 -2
- package/dist/api/resources/plans/client/requests/PublishPlanVersionRequestBody.d.ts +10 -0
- package/dist/api/resources/plans/client/requests/RetryCustomPlanBillingRequestBody.d.ts +2 -0
- package/dist/api/resources/plans/client/requests/index.d.ts +1 -0
- package/dist/api/resources/plans/types/GetPlanVersionDiffParams.d.ts +7 -0
- package/dist/api/resources/plans/types/GetPlanVersionDiffResponse.d.ts +6 -0
- package/dist/api/resources/plans/types/ListCustomPlanBillingsParams.d.ts +1 -1
- package/dist/api/resources/plans/types/index.d.ts +2 -0
- package/dist/api/types/BillingCouponResponseData.d.ts +1 -1
- package/dist/api/types/BillingCreditGrantResponseData.d.ts +2 -2
- package/dist/api/types/BillingCustomerSubscription.d.ts +2 -1
- package/dist/api/types/BillingPriceResponseData.d.ts +1 -1
- package/dist/api/types/BillingPriceView.d.ts +1 -1
- package/dist/api/types/BillingProductForSubscriptionResponseData.d.ts +1 -1
- package/dist/api/types/BillingProductPriceResponseData.d.ts +1 -1
- package/dist/api/types/BillingProductPricing.d.ts +1 -1
- package/dist/api/types/BillingSettingsResponseData.d.ts +4 -0
- package/dist/api/types/BillingSubscriptionDiscountView.d.ts +2 -1
- package/dist/api/types/BillingSubscriptionResponseData.d.ts +1 -1
- package/dist/api/types/BillingSubscriptionView.d.ts +1 -1
- package/dist/api/types/CaptureRawEvent.d.ts +2 -0
- package/dist/api/types/CatalogConfigOrderedPlan.d.ts +1 -0
- package/dist/api/types/CatalogConfigOrderedPlanResponseData.d.ts +1 -0
- package/dist/api/types/CatalogConfigPlanCredit.d.ts +4 -0
- package/dist/api/types/CatalogConfigPlanCreditResponseData.d.ts +4 -0
- package/dist/api/types/ChangeSubscriptionInternalRequestBody.d.ts +1 -1
- package/dist/api/types/ChangeSubscriptionRequestBody.d.ts +1 -1
- package/dist/api/types/CheckFlagsResponseData.d.ts +2 -0
- package/dist/api/types/CheckoutProblemCode.d.ts +47 -0
- package/dist/api/types/CheckoutProblemResponseData.d.ts +19 -0
- package/dist/api/types/CheckoutProblemSource.d.ts +6 -0
- package/dist/api/types/CheckoutSubscription.d.ts +1 -1
- package/dist/api/types/CompanyBillingEntitySubscriptionResponseData.d.ts +1 -1
- package/dist/api/types/CompanyDetailResponseData.d.ts +1 -0
- package/dist/api/types/CompanyOverrideResponseData.d.ts +2 -0
- package/dist/api/types/CompanyPlanDetailResponseData.d.ts +2 -0
- package/dist/api/types/CompanySubscriptionResponseData.d.ts +1 -1
- package/dist/api/types/CompanyUserUsageMetricsResponseData.d.ts +11 -0
- package/dist/api/types/CompanyUserUsageResponseData.d.ts +15 -0
- package/dist/api/types/CompanyUserUsageRowResponseData.d.ts +13 -0
- package/dist/api/types/ComponentDisplaySettings.d.ts +1 -0
- package/dist/api/types/ComponentSettingsResponseData.d.ts +1 -0
- package/dist/api/types/Condition.d.ts +1 -0
- package/dist/api/types/ConditionResponseData.d.ts +1 -0
- package/dist/api/types/ConditionView.d.ts +1 -0
- package/dist/api/types/CouponRequestBody.d.ts +2 -1
- package/dist/api/types/CreateEntitlementInBundleRequestBody.d.ts +3 -1
- package/dist/api/types/CreateEntitlementReqCommon.d.ts +2 -0
- package/dist/api/types/CreditBalanceEventResponseData.d.ts +10 -0
- package/dist/api/types/CreditBalanceFeatureConsumptionResponseData.d.ts +5 -0
- package/dist/api/types/CreditBalancePointResponseData.d.ts +9 -0
- package/dist/api/types/CreditBalanceTimeSeriesResponseData.d.ts +8 -0
- package/dist/api/types/CreditBundleCurrencyPrice.d.ts +1 -1
- package/dist/api/types/CreditBundleCurrencyPriceRequestBody.d.ts +2 -1
- package/dist/api/types/CreditBundleCurrencyPriceResponseData.d.ts +1 -1
- package/dist/api/types/CreditBurnBreakdownLine.d.ts +6 -0
- package/dist/api/types/CreditCompanyGrantView.d.ts +2 -2
- package/dist/api/types/CreditCurrencyPrice.d.ts +1 -1
- package/dist/api/types/CreditCurrencyPriceRequestBody.d.ts +2 -1
- package/dist/api/types/CreditCurrencyPriceResponseData.d.ts +1 -1
- package/dist/api/types/CreditEventLedgerResponseData.d.ts +6 -1
- package/dist/api/types/CreditEventType.d.ts +3 -0
- package/dist/api/types/CreditLedgerEntryKind.d.ts +10 -0
- package/dist/api/types/CreditSpendPolicy.d.ts +21 -0
- package/dist/api/types/CreditSpendPolicyResponseData.d.ts +9 -0
- package/dist/api/types/CreditSpendWindow.d.ts +6 -0
- package/dist/api/types/CreditSpendWindowUnit.d.ts +6 -0
- package/dist/api/types/CreditUsageReason.d.ts +1 -0
- package/dist/api/types/CreditsInPlan.d.ts +4 -0
- package/dist/api/types/Currency.d.ts +137 -0
- package/dist/api/types/CurrencyPriceRequestBody.d.ts +1 -1
- package/dist/api/types/CustomPlanBillingResponseData.d.ts +9 -1
- package/dist/api/types/EntitlementCurrencyPricesResponseData.d.ts +1 -1
- package/dist/api/types/EnvironmentDetailResponseData.d.ts +1 -0
- package/dist/api/types/EnvironmentResponseData.d.ts +1 -0
- package/dist/api/types/EstimatedPlanTotal.d.ts +6 -0
- package/dist/api/types/FeatureDetailResponseData.d.ts +2 -0
- package/dist/api/types/FeatureEntitlement.d.ts +2 -0
- package/dist/api/types/FeatureEventSource.d.ts +5 -0
- package/dist/api/types/FeatureInPlanResponseData.d.ts +2 -0
- package/dist/api/types/FeatureResponseData.d.ts +2 -0
- package/dist/api/types/FeatureView.d.ts +1 -0
- package/dist/api/types/InvoiceRequestBody.d.ts +1 -1
- package/dist/api/types/InvoiceResponseData.d.ts +1 -1
- package/dist/api/types/ManagePlanPreviewResponseResponseData.d.ts +1 -0
- package/dist/api/types/ManagePlanRequest.d.ts +3 -1
- package/dist/api/types/ManagePlanResponseResponseData.d.ts +2 -0
- package/dist/api/types/MrrResponseData.d.ts +2 -1
- package/dist/api/types/OrderedPlansInGroup.d.ts +1 -0
- package/dist/api/types/PendingMigrationResponseData.d.ts +8 -0
- package/dist/api/types/PlanBillingSource.d.ts +1 -0
- package/dist/api/types/PlanChangeAction.d.ts +1 -0
- package/dist/api/types/PlanChangeAmendmentStatus.d.ts +8 -0
- package/dist/api/types/PlanChangeResponseData.d.ts +4 -0
- package/dist/api/types/PlanCreditOrder.d.ts +4 -0
- package/dist/api/types/PlanCreditVisibility.d.ts +4 -0
- package/dist/api/types/PlanCurrencyPriceRequestBody.d.ts +2 -1
- package/dist/api/types/PlanCurrencyPricesResponseData.d.ts +1 -1
- package/dist/api/types/PlanEntitlementResponseData.d.ts +2 -0
- package/dist/api/types/PlanGroupPlanEntitlementsOrder.d.ts +1 -0
- package/dist/api/types/PlanVersionBillingProductChangeResponseData.d.ts +5 -0
- package/dist/api/types/PlanVersionCreditGrantChangeResponseData.d.ts +9 -0
- package/dist/api/types/PlanVersionDiffChangeType.d.ts +6 -0
- package/dist/api/types/PlanVersionDiffPriceCadence.d.ts +7 -0
- package/dist/api/types/PlanVersionDiffResponseData.d.ts +19 -0
- package/dist/api/types/PlanVersionEntitlementChangeResponseData.d.ts +9 -0
- package/dist/api/types/PlanVersionFieldChangeResponseData.d.ts +5 -0
- package/dist/api/types/PlanVersionMigrationResponseData.d.ts +1 -0
- package/dist/api/types/PlanVersionMigrationStrategy.d.ts +1 -0
- package/dist/api/types/PlanVersionPriceChangeResponseData.d.ts +7 -0
- package/dist/api/types/PlanViewPublicResponseData.d.ts +1 -0
- package/dist/api/types/PreviewSubscriptionChangeResponseData.d.ts +1 -0
- package/dist/api/types/PreviewSubscriptionDiscountResponseData.d.ts +2 -1
- package/dist/api/types/PreviewSubscriptionFinanceResponseData.d.ts +1 -1
- package/dist/api/types/RulesEngineSchemaVersion.d.ts +1 -1
- package/dist/api/types/RulesengineCompany.d.ts +1 -0
- package/dist/api/types/RulesengineCondition.d.ts +1 -0
- package/dist/api/types/RulesengineCreditSpendPolicy.d.ts +21 -0
- package/dist/api/types/RulesengineCreditSpendPolicyScope.d.ts +6 -0
- package/dist/api/types/RulesengineCreditSpendWindow.d.ts +6 -0
- package/dist/api/types/RulesengineFeatureEntitlement.d.ts +2 -0
- package/dist/api/types/RulesengineUser.d.ts +1 -0
- package/dist/api/types/ScheduledDowngradeResponseData.d.ts +2 -1
- package/dist/api/types/UpcomingInvoiceResponseData.d.ts +1 -1
- package/dist/api/types/UpdateEntitlementReqCommon.d.ts +2 -0
- package/dist/api/types/UpsertBillingProductRequestBody.d.ts +1 -1
- package/dist/api/types/UsageBasedEntitlementRequestBody.d.ts +1 -1
- package/dist/api/types/UserUsageMetric.d.ts +5 -0
- package/dist/api/types/index.d.ts +37 -0
- package/dist/core/fetcher/getResponseBody.d.ts +16 -0
- package/dist/core/fetcher/makeRequest.d.ts +6 -1
- package/dist/core/fetcher/requestWithRetries.d.ts +1 -1
- package/dist/core/fetcher/signals.d.ts +1 -0
- package/dist/datastream/datastream-client.d.ts +2 -2
- package/dist/index.js +9 -9
- package/dist/serialization/resources/accounts/client/requests/UpdateEnvironmentRequestBody.d.ts +1 -0
- package/dist/serialization/resources/billing/client/requests/CreateBillingPriceRequestBody.d.ts +2 -1
- package/dist/serialization/resources/billing/client/requests/CreateBillingSubscriptionRequestBody.d.ts +2 -1
- package/dist/serialization/resources/billing/client/requests/CreateCouponRequestBody.d.ts +2 -1
- package/dist/serialization/resources/billing/client/requests/CreateInvoiceRequestBody.d.ts +2 -1
- package/dist/serialization/resources/billing/client/requests/UpdateBillingSettingsRequestBody.d.ts +10 -0
- package/dist/serialization/resources/billing/client/requests/index.d.ts +1 -0
- package/dist/serialization/resources/billing/types/GetBillingSettingsResponse.d.ts +11 -0
- package/dist/serialization/resources/billing/types/ListBillingPricesParams.d.ts +2 -1
- package/dist/serialization/resources/billing/types/ListBillingProductPricesParams.d.ts +2 -1
- package/dist/serialization/resources/billing/types/UpdateBillingSettingsResponse.d.ts +11 -0
- package/dist/serialization/resources/billing/types/index.d.ts +2 -0
- package/dist/serialization/resources/checkout/client/requests/CheckoutDataRequestBody.d.ts +2 -1
- package/dist/serialization/resources/credits/client/requests/AcquireCreditLeaseRequestBody.d.ts +1 -0
- package/dist/serialization/resources/credits/client/requests/CreateBillingCreditRequestBody.d.ts +2 -1
- package/dist/serialization/resources/credits/client/requests/CreateCompanyCreditGrant.d.ts +2 -1
- package/dist/serialization/resources/credits/client/requests/CreateCreditBundleRequestBody.d.ts +2 -1
- package/dist/serialization/resources/credits/client/requests/CreateCreditSpendPolicyRequestBody.d.ts +4 -1
- package/dist/serialization/resources/credits/client/requests/ExtendCreditLeaseRequestBody.d.ts +1 -0
- package/dist/serialization/resources/credits/client/requests/UpdateCreditSpendPolicyRequestBody.d.ts +3 -0
- package/dist/serialization/resources/credits/types/GetCreditBalanceTimeSeriesParams.d.ts +12 -0
- package/dist/serialization/resources/credits/types/GetCreditBalanceTimeSeriesResponse.d.ts +12 -0
- package/dist/serialization/resources/credits/types/GetCreditSpendPolicyUsageParams.d.ts +11 -0
- package/dist/serialization/resources/credits/types/GetCreditSpendPolicyUsageResponse.d.ts +12 -0
- package/dist/serialization/resources/credits/types/index.d.ts +4 -0
- package/dist/serialization/resources/entitlements/client/requests/CreateBillingLinkedPlanEntitlementRequestBody.d.ts +3 -1
- package/dist/serialization/resources/entitlements/client/requests/CreateCompanyOverrideRequestBody.d.ts +1 -0
- package/dist/serialization/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.d.ts +3 -1
- package/dist/serialization/resources/entitlements/client/requests/UpdateCompanyOverrideRequestBody.d.ts +1 -0
- package/dist/serialization/resources/entitlements/client/requests/UpdatePlanEntitlementRequestBody.d.ts +3 -1
- package/dist/serialization/resources/entitlements/types/CountCompanyUserUsageParams.d.ts +16 -0
- package/dist/serialization/resources/entitlements/types/CountCompanyUserUsageResponse.d.ts +12 -0
- package/dist/serialization/resources/entitlements/types/GetCompanyUserUsageMetricsParams.d.ts +11 -0
- package/dist/serialization/resources/entitlements/types/GetCompanyUserUsageMetricsResponse.d.ts +12 -0
- package/dist/serialization/resources/entitlements/types/ListCompanyUserUsageParams.d.ts +16 -0
- package/dist/serialization/resources/entitlements/types/ListCompanyUserUsageResponse.d.ts +12 -0
- package/dist/serialization/resources/entitlements/types/index.d.ts +6 -0
- package/dist/serialization/resources/features/client/requests/CreateBillingLinkedFeatureRequestBody.d.ts +2 -0
- package/dist/serialization/resources/features/client/requests/CreateFeatureRequestBody.d.ts +2 -0
- package/dist/serialization/resources/features/client/requests/UpdateFeatureRequestBody.d.ts +2 -0
- package/dist/serialization/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts +1 -0
- package/dist/serialization/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts +1 -0
- package/dist/serialization/resources/planmigrations/client/requests/CreateMigrationInput.d.ts +1 -0
- package/dist/serialization/resources/planmigrations/types/CountMigrationsParams.d.ts +1 -0
- package/dist/serialization/resources/planmigrations/types/ListMigrationsParams.d.ts +1 -0
- package/dist/serialization/resources/plans/client/requests/PublishPlanVersionRequestBody.d.ts +4 -0
- package/dist/serialization/resources/plans/client/requests/RetryCustomPlanBillingRequestBody.d.ts +1 -0
- package/dist/serialization/resources/plans/types/GetPlanVersionDiffParams.d.ts +9 -0
- package/dist/serialization/resources/plans/types/GetPlanVersionDiffResponse.d.ts +12 -0
- package/dist/serialization/resources/plans/types/index.d.ts +2 -0
- package/dist/serialization/types/BillingCouponResponseData.d.ts +2 -1
- package/dist/serialization/types/BillingCreditGrantResponseData.d.ts +3 -2
- package/dist/serialization/types/BillingCustomerSubscription.d.ts +2 -1
- package/dist/serialization/types/BillingPriceResponseData.d.ts +2 -1
- package/dist/serialization/types/BillingPriceView.d.ts +2 -1
- package/dist/serialization/types/BillingProductForSubscriptionResponseData.d.ts +2 -1
- package/dist/serialization/types/BillingProductPriceResponseData.d.ts +2 -1
- package/dist/serialization/types/BillingProductPricing.d.ts +2 -1
- package/dist/serialization/types/BillingSettingsResponseData.d.ts +10 -0
- package/dist/serialization/types/BillingSubscriptionDiscountView.d.ts +2 -1
- package/dist/serialization/types/BillingSubscriptionResponseData.d.ts +2 -1
- package/dist/serialization/types/BillingSubscriptionView.d.ts +2 -1
- package/dist/serialization/types/CaptureRawEvent.d.ts +2 -0
- package/dist/serialization/types/CatalogConfigOrderedPlan.d.ts +2 -0
- package/dist/serialization/types/CatalogConfigOrderedPlanResponseData.d.ts +2 -0
- package/dist/serialization/types/CatalogConfigPlanCredit.d.ts +10 -0
- package/dist/serialization/types/CatalogConfigPlanCreditResponseData.d.ts +10 -0
- package/dist/serialization/types/ChangeSubscriptionInternalRequestBody.d.ts +2 -1
- package/dist/serialization/types/ChangeSubscriptionRequestBody.d.ts +2 -1
- package/dist/serialization/types/CheckFlagsResponseData.d.ts +2 -0
- package/dist/serialization/types/CheckoutProblemCode.d.ts +7 -0
- package/dist/serialization/types/CheckoutProblemResponseData.d.ts +23 -0
- package/dist/serialization/types/CheckoutProblemSource.d.ts +7 -0
- package/dist/serialization/types/CheckoutSubscription.d.ts +2 -1
- package/dist/serialization/types/CompanyBillingEntitySubscriptionResponseData.d.ts +2 -1
- package/dist/serialization/types/CompanyDetailResponseData.d.ts +1 -0
- package/dist/serialization/types/CompanyOverrideResponseData.d.ts +1 -0
- package/dist/serialization/types/CompanyPlanDetailResponseData.d.ts +4 -0
- package/dist/serialization/types/CompanySubscriptionResponseData.d.ts +2 -1
- package/dist/serialization/types/CompanyUserUsageMetricsResponseData.d.ts +13 -0
- package/dist/serialization/types/CompanyUserUsageResponseData.d.ts +15 -0
- package/dist/serialization/types/CompanyUserUsageRowResponseData.d.ts +14 -0
- package/dist/serialization/types/ComponentDisplaySettings.d.ts +1 -0
- package/dist/serialization/types/ComponentSettingsResponseData.d.ts +1 -0
- package/dist/serialization/types/Condition.d.ts +1 -0
- package/dist/serialization/types/ConditionResponseData.d.ts +1 -0
- package/dist/serialization/types/ConditionView.d.ts +1 -0
- package/dist/serialization/types/CouponRequestBody.d.ts +2 -1
- package/dist/serialization/types/CreateEntitlementInBundleRequestBody.d.ts +3 -1
- package/dist/serialization/types/CreateEntitlementReqCommon.d.ts +1 -0
- package/dist/serialization/types/CreditBalanceEventResponseData.d.ts +18 -0
- package/dist/serialization/types/CreditBalanceFeatureConsumptionResponseData.d.ts +11 -0
- package/dist/serialization/types/CreditBalancePointResponseData.d.ts +13 -0
- package/dist/serialization/types/CreditBalanceTimeSeriesResponseData.d.ts +14 -0
- package/dist/serialization/types/CreditBundleCurrencyPrice.d.ts +2 -1
- package/dist/serialization/types/CreditBundleCurrencyPriceRequestBody.d.ts +2 -1
- package/dist/serialization/types/CreditBundleCurrencyPriceResponseData.d.ts +2 -1
- package/dist/serialization/types/CreditBurnBreakdownLine.d.ts +12 -0
- package/dist/serialization/types/CreditCompanyGrantView.d.ts +3 -2
- package/dist/serialization/types/CreditCurrencyPrice.d.ts +2 -1
- package/dist/serialization/types/CreditCurrencyPriceRequestBody.d.ts +2 -1
- package/dist/serialization/types/CreditCurrencyPriceResponseData.d.ts +2 -1
- package/dist/serialization/types/CreditEventLedgerResponseData.d.ts +8 -1
- package/dist/serialization/types/CreditEventType.d.ts +1 -1
- package/dist/serialization/types/CreditLedgerEntryKind.d.ts +7 -0
- package/dist/serialization/types/CreditSpendPolicy.d.ts +19 -0
- package/dist/serialization/types/CreditSpendPolicyResponseData.d.ts +7 -0
- package/dist/serialization/types/CreditSpendWindow.d.ts +10 -0
- package/dist/serialization/types/CreditSpendWindowUnit.d.ts +7 -0
- package/dist/serialization/types/CreditUsageReason.d.ts +1 -1
- package/dist/serialization/types/CreditsInPlan.d.ts +10 -0
- package/dist/serialization/types/Currency.d.ts +7 -0
- package/dist/serialization/types/CurrencyPriceRequestBody.d.ts +2 -1
- package/dist/serialization/types/CustomPlanBillingResponseData.d.ts +5 -0
- package/dist/serialization/types/EntitlementCurrencyPricesResponseData.d.ts +2 -1
- package/dist/serialization/types/EnvironmentDetailResponseData.d.ts +1 -0
- package/dist/serialization/types/EnvironmentResponseData.d.ts +1 -0
- package/dist/serialization/types/EstimatedPlanTotal.d.ts +13 -0
- package/dist/serialization/types/FeatureDetailResponseData.d.ts +2 -0
- package/dist/serialization/types/FeatureEntitlement.d.ts +1 -0
- package/dist/serialization/types/FeatureEventSource.d.ts +7 -0
- package/dist/serialization/types/FeatureInPlanResponseData.d.ts +2 -0
- package/dist/serialization/types/FeatureResponseData.d.ts +2 -0
- package/dist/serialization/types/FeatureView.d.ts +2 -0
- package/dist/serialization/types/InvoiceRequestBody.d.ts +2 -1
- package/dist/serialization/types/InvoiceResponseData.d.ts +2 -1
- package/dist/serialization/types/ManagePlanPreviewResponseResponseData.d.ts +2 -0
- package/dist/serialization/types/ManagePlanRequest.d.ts +3 -1
- package/dist/serialization/types/ManagePlanResponseResponseData.d.ts +3 -0
- package/dist/serialization/types/MrrResponseData.d.ts +2 -1
- package/dist/serialization/types/OrderedPlansInGroup.d.ts +2 -0
- package/dist/serialization/types/PendingMigrationResponseData.d.ts +5 -0
- package/dist/serialization/types/PlanBillingSource.d.ts +1 -1
- package/dist/serialization/types/PlanChangeAction.d.ts +1 -1
- package/dist/serialization/types/PlanChangeAmendmentStatus.d.ts +7 -0
- package/dist/serialization/types/PlanChangeResponseData.d.ts +3 -0
- package/dist/serialization/types/PlanCreditOrder.d.ts +10 -0
- package/dist/serialization/types/PlanCreditVisibility.d.ts +10 -0
- package/dist/serialization/types/PlanCurrencyPriceRequestBody.d.ts +2 -1
- package/dist/serialization/types/PlanCurrencyPricesResponseData.d.ts +2 -1
- package/dist/serialization/types/PlanEntitlementResponseData.d.ts +1 -0
- package/dist/serialization/types/PlanGroupPlanEntitlementsOrder.d.ts +2 -0
- package/dist/serialization/types/PlanVersionBillingProductChangeResponseData.d.ts +11 -0
- package/dist/serialization/types/PlanVersionCreditGrantChangeResponseData.d.ts +15 -0
- package/dist/serialization/types/PlanVersionDiffChangeType.d.ts +7 -0
- package/dist/serialization/types/PlanVersionDiffPriceCadence.d.ts +7 -0
- package/dist/serialization/types/PlanVersionDiffResponseData.d.ts +22 -0
- package/dist/serialization/types/PlanVersionEntitlementChangeResponseData.d.ts +15 -0
- package/dist/serialization/types/PlanVersionFieldChangeResponseData.d.ts +11 -0
- package/dist/serialization/types/PlanVersionMigrationResponseData.d.ts +1 -0
- package/dist/serialization/types/PlanVersionMigrationStrategy.d.ts +1 -1
- package/dist/serialization/types/PlanVersionPriceChangeResponseData.d.ts +15 -0
- package/dist/serialization/types/PlanViewPublicResponseData.d.ts +2 -0
- package/dist/serialization/types/PreviewSubscriptionChangeResponseData.d.ts +2 -0
- package/dist/serialization/types/PreviewSubscriptionDiscountResponseData.d.ts +2 -1
- package/dist/serialization/types/PreviewSubscriptionFinanceResponseData.d.ts +2 -1
- package/dist/serialization/types/RulesEngineSchemaVersion.d.ts +1 -1
- package/dist/serialization/types/RulesengineCompany.d.ts +2 -0
- package/dist/serialization/types/RulesengineCondition.d.ts +1 -0
- package/dist/serialization/types/RulesengineCreditSpendPolicy.d.ts +19 -0
- package/dist/serialization/types/RulesengineCreditSpendPolicyScope.d.ts +7 -0
- package/dist/serialization/types/RulesengineCreditSpendWindow.d.ts +10 -0
- package/dist/serialization/types/RulesengineFeatureEntitlement.d.ts +1 -0
- package/dist/serialization/types/RulesengineUser.d.ts +2 -0
- package/dist/serialization/types/ScheduledDowngradeResponseData.d.ts +2 -1
- package/dist/serialization/types/UpcomingInvoiceResponseData.d.ts +2 -1
- package/dist/serialization/types/UpdateEntitlementReqCommon.d.ts +1 -0
- package/dist/serialization/types/UpsertBillingProductRequestBody.d.ts +2 -1
- package/dist/serialization/types/UsageBasedEntitlementRequestBody.d.ts +2 -1
- package/dist/serialization/types/UserUsageMetric.d.ts +7 -0
- package/dist/serialization/types/index.d.ts +37 -0
- package/dist/wasm/rulesengine.js +1 -1
- package/dist/wrapper.d.ts +2 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -781,12 +781,27 @@ const client = new SchematicClient({
|
|
|
781
781
|
dataStream: {
|
|
782
782
|
replicatorMode: true,
|
|
783
783
|
redisClient,
|
|
784
|
-
replicatorHealthURL: "http://localhost:8080/health",
|
|
785
|
-
replicatorHealthCheck: 30000, // 30 seconds
|
|
786
784
|
},
|
|
787
785
|
});
|
|
788
786
|
```
|
|
789
787
|
|
|
788
|
+
In replicator mode the SDK polls the replicator's health endpoint to learn when it is ready and which cache version it is writing. The health URL defaults to `http://localhost:8090/ready` and the polling interval defaults to 30 seconds, matching the other Schematic SDKs. If your replicator runs elsewhere, set `replicatorHealthURL` explicitly:
|
|
789
|
+
|
|
790
|
+
```ts
|
|
791
|
+
const client = new SchematicClient({
|
|
792
|
+
apiKey: process.env.SCHEMATIC_API_KEY,
|
|
793
|
+
useDataStream: true,
|
|
794
|
+
dataStream: {
|
|
795
|
+
replicatorMode: true,
|
|
796
|
+
redisClient,
|
|
797
|
+
replicatorHealthURL: "http://my-replicator:8090/ready",
|
|
798
|
+
replicatorHealthCheck: 60000, // 60 seconds
|
|
799
|
+
},
|
|
800
|
+
});
|
|
801
|
+
```
|
|
802
|
+
|
|
803
|
+
Until a health check succeeds, the SDK treats the replicator as not ready: bulk flag checks bypass the shared cache, `track` skips local metric updates, and cache keys use the SDK's own rules engine version rather than the replicator's cache version.
|
|
804
|
+
|
|
790
805
|
### Configuration options
|
|
791
806
|
|
|
792
807
|
| Option | Type | Default | Description |
|
|
@@ -794,7 +809,7 @@ const client = new SchematicClient({
|
|
|
794
809
|
| `replicatorMode` | `boolean` | `false` | Enable replicator mode |
|
|
795
810
|
| `redisClient` | `RedisClient` | — | **Required.** Redis client for reading from the shared cache |
|
|
796
811
|
| `redisKeyPrefix` | `string` | `schematic:` | Key prefix for Redis cache entries |
|
|
797
|
-
| `replicatorHealthURL` | `string` |
|
|
812
|
+
| `replicatorHealthURL` | `string` | `http://localhost:8090/ready` | URL to poll for replicator health status (default applies in replicator mode only) |
|
|
798
813
|
| `replicatorHealthCheck` | `number` | 30000 | Health check polling interval in milliseconds |
|
|
799
814
|
| `cacheTTL` | `number` | 24 hours | Cache TTL in milliseconds |
|
|
800
815
|
|
|
@@ -205,7 +205,7 @@ export declare class BillingClient {
|
|
|
205
205
|
* amountPaid: 1000000,
|
|
206
206
|
* amountRemaining: 1000000,
|
|
207
207
|
* collectionMethod: "collection_method",
|
|
208
|
-
* currency: "
|
|
208
|
+
* currency: "aed",
|
|
209
209
|
* customerExternalId: "customer_external_id",
|
|
210
210
|
* subtotal: 1000000
|
|
211
211
|
* })
|
|
@@ -346,7 +346,7 @@ export declare class BillingClient {
|
|
|
346
346
|
*
|
|
347
347
|
* @example
|
|
348
348
|
* await client.billing.listBillingPrices({
|
|
349
|
-
* currency: "
|
|
349
|
+
* currency: "aed",
|
|
350
350
|
* forInitialPlan: true,
|
|
351
351
|
* forTrialExpiryPlan: true,
|
|
352
352
|
* ids: ["ids"],
|
|
@@ -383,7 +383,7 @@ export declare class BillingClient {
|
|
|
383
383
|
* @example
|
|
384
384
|
* await client.billing.upsertBillingPrice({
|
|
385
385
|
* billingScheme: "per_unit",
|
|
386
|
-
* currency: "
|
|
386
|
+
* currency: "aed",
|
|
387
387
|
* externalAccountId: "external_account_id",
|
|
388
388
|
* interval: "interval",
|
|
389
389
|
* isActive: true,
|
|
@@ -429,7 +429,7 @@ export declare class BillingClient {
|
|
|
429
429
|
*
|
|
430
430
|
* @example
|
|
431
431
|
* await client.billing.listBillingProductPrices({
|
|
432
|
-
* currency: "
|
|
432
|
+
* currency: "aed",
|
|
433
433
|
* forInitialPlan: true,
|
|
434
434
|
* forTrialExpiryPlan: true,
|
|
435
435
|
* ids: ["ids"],
|
|
@@ -593,6 +593,38 @@ export declare class BillingClient {
|
|
|
593
593
|
*/
|
|
594
594
|
updateCompanyBillingProfile(billing_profile_id: string, request: Schematic.UpdateCompanyBillingProfileRequestBody, requestOptions?: BillingClient.RequestOptions): core.HttpResponsePromise<Schematic.UpdateCompanyBillingProfileResponse>;
|
|
595
595
|
private __updateCompanyBillingProfile;
|
|
596
|
+
/**
|
|
597
|
+
* @param {BillingClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
598
|
+
*
|
|
599
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
600
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
601
|
+
* @throws {@link Schematic.NotFoundError}
|
|
602
|
+
* @throws {@link Schematic.InternalServerError}
|
|
603
|
+
* @throws {@link errors.SchematicError}
|
|
604
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
605
|
+
*
|
|
606
|
+
* @example
|
|
607
|
+
* await client.billing.getBillingSettings()
|
|
608
|
+
*/
|
|
609
|
+
getBillingSettings(requestOptions?: BillingClient.RequestOptions): core.HttpResponsePromise<Schematic.GetBillingSettingsResponse>;
|
|
610
|
+
private __getBillingSettings;
|
|
611
|
+
/**
|
|
612
|
+
* @param {Schematic.UpdateBillingSettingsRequestBody} request
|
|
613
|
+
* @param {BillingClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
614
|
+
*
|
|
615
|
+
* @throws {@link Schematic.BadRequestError}
|
|
616
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
617
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
618
|
+
* @throws {@link Schematic.NotFoundError}
|
|
619
|
+
* @throws {@link Schematic.InternalServerError}
|
|
620
|
+
* @throws {@link errors.SchematicError}
|
|
621
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
622
|
+
*
|
|
623
|
+
* @example
|
|
624
|
+
* await client.billing.updateBillingSettings()
|
|
625
|
+
*/
|
|
626
|
+
updateBillingSettings(request?: Schematic.UpdateBillingSettingsRequestBody, requestOptions?: BillingClient.RequestOptions): core.HttpResponsePromise<Schematic.UpdateBillingSettingsResponse>;
|
|
627
|
+
private __updateBillingSettings;
|
|
596
628
|
/**
|
|
597
629
|
* @param {Schematic.CreateBillingSubscriptionRequestBody} request
|
|
598
630
|
* @param {BillingClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -608,7 +640,7 @@ export declare class BillingClient {
|
|
|
608
640
|
* @example
|
|
609
641
|
* await client.billing.upsertBillingSubscription({
|
|
610
642
|
* cancelAtPeriodEnd: true,
|
|
611
|
-
* currency: "
|
|
643
|
+
* currency: "aed",
|
|
612
644
|
* customerExternalId: "customer_external_id",
|
|
613
645
|
* discounts: [{
|
|
614
646
|
* couponExternalId: "coupon_external_id",
|
|
@@ -618,7 +650,7 @@ export declare class BillingClient {
|
|
|
618
650
|
* }],
|
|
619
651
|
* expiredAt: new Date("2024-01-15T09:30:00.000Z"),
|
|
620
652
|
* productExternalIds: [{
|
|
621
|
-
* currency: "
|
|
653
|
+
* currency: "aed",
|
|
622
654
|
* interval: "interval",
|
|
623
655
|
* price: 1000000,
|
|
624
656
|
* priceExternalId: "price_external_id",
|
|
@@ -3,7 +3,7 @@ import type * as Schematic from "../../../../index";
|
|
|
3
3
|
* @example
|
|
4
4
|
* {
|
|
5
5
|
* billingScheme: "per_unit",
|
|
6
|
-
* currency: "
|
|
6
|
+
* currency: "aed",
|
|
7
7
|
* externalAccountId: "external_account_id",
|
|
8
8
|
* interval: "interval",
|
|
9
9
|
* isActive: true,
|
|
@@ -18,7 +18,7 @@ import type * as Schematic from "../../../../index";
|
|
|
18
18
|
*/
|
|
19
19
|
export interface CreateBillingPriceRequestBody {
|
|
20
20
|
billingScheme: Schematic.BillingPriceScheme;
|
|
21
|
-
currency:
|
|
21
|
+
currency: Schematic.Currency;
|
|
22
22
|
externalAccountId: string;
|
|
23
23
|
interval: string;
|
|
24
24
|
intervalCount?: number;
|
package/dist/api/resources/billing/client/requests/CreateBillingSubscriptionRequestBody.d.ts
CHANGED
|
@@ -3,7 +3,7 @@ import type * as Schematic from "../../../../index";
|
|
|
3
3
|
* @example
|
|
4
4
|
* {
|
|
5
5
|
* cancelAtPeriodEnd: true,
|
|
6
|
-
* currency: "
|
|
6
|
+
* currency: "aed",
|
|
7
7
|
* customerExternalId: "customer_external_id",
|
|
8
8
|
* discounts: [{
|
|
9
9
|
* couponExternalId: "coupon_external_id",
|
|
@@ -13,7 +13,7 @@ import type * as Schematic from "../../../../index";
|
|
|
13
13
|
* }],
|
|
14
14
|
* expiredAt: new Date("2024-01-15T09:30:00.000Z"),
|
|
15
15
|
* productExternalIds: [{
|
|
16
|
-
* currency: "
|
|
16
|
+
* currency: "aed",
|
|
17
17
|
* interval: "interval",
|
|
18
18
|
* price: 1000000,
|
|
19
19
|
* priceExternalId: "price_external_id",
|
|
@@ -30,7 +30,7 @@ export interface CreateBillingSubscriptionRequestBody {
|
|
|
30
30
|
cancelAt?: number;
|
|
31
31
|
cancelAtPeriodEnd: boolean;
|
|
32
32
|
companyId?: string;
|
|
33
|
-
currency:
|
|
33
|
+
currency: Schematic.Currency;
|
|
34
34
|
customerExternalId: string;
|
|
35
35
|
defaultPaymentMethodExternalId?: string;
|
|
36
36
|
defaultPaymentMethodId?: string;
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type * as Schematic from "../../../../index";
|
|
1
2
|
/**
|
|
2
3
|
* @example
|
|
3
4
|
* {
|
|
@@ -13,7 +14,7 @@
|
|
|
13
14
|
*/
|
|
14
15
|
export interface CreateCouponRequestBody {
|
|
15
16
|
amountOff: number;
|
|
16
|
-
currency?:
|
|
17
|
+
currency?: Schematic.Currency;
|
|
17
18
|
duration: string;
|
|
18
19
|
durationInMonths: number;
|
|
19
20
|
externalId: string;
|
|
@@ -6,7 +6,7 @@ import type * as Schematic from "../../../../index";
|
|
|
6
6
|
* amountPaid: 1000000,
|
|
7
7
|
* amountRemaining: 1000000,
|
|
8
8
|
* collectionMethod: "collection_method",
|
|
9
|
-
* currency: "
|
|
9
|
+
* currency: "aed",
|
|
10
10
|
* customerExternalId: "customer_external_id",
|
|
11
11
|
* subtotal: 1000000
|
|
12
12
|
* }
|
|
@@ -16,7 +16,7 @@ export interface CreateInvoiceRequestBody {
|
|
|
16
16
|
amountPaid: number;
|
|
17
17
|
amountRemaining: number;
|
|
18
18
|
collectionMethod: string;
|
|
19
|
-
currency:
|
|
19
|
+
currency: Schematic.Currency;
|
|
20
20
|
customerExternalId: string;
|
|
21
21
|
dueDate?: Date;
|
|
22
22
|
endingBalance?: number;
|
|
@@ -2,7 +2,7 @@ import type * as Schematic from "../../../../index";
|
|
|
2
2
|
/**
|
|
3
3
|
* @example
|
|
4
4
|
* {
|
|
5
|
-
* currency: "
|
|
5
|
+
* currency: "aed",
|
|
6
6
|
* forInitialPlan: true,
|
|
7
7
|
* forTrialExpiryPlan: true,
|
|
8
8
|
* ids: ["ids"],
|
|
@@ -24,7 +24,7 @@ import type * as Schematic from "../../../../index";
|
|
|
24
24
|
*/
|
|
25
25
|
export interface ListBillingPricesRequest {
|
|
26
26
|
/** Filter for prices in a specific currency (e.g. usd, eur) */
|
|
27
|
-
currency?:
|
|
27
|
+
currency?: Schematic.Currency;
|
|
28
28
|
/** Filter for prices valid for initial plans (free prices only) */
|
|
29
29
|
forInitialPlan?: boolean;
|
|
30
30
|
/** Filter for prices valid for trial expiry plans (free prices only) */
|
|
@@ -2,7 +2,7 @@ import type * as Schematic from "../../../../index";
|
|
|
2
2
|
/**
|
|
3
3
|
* @example
|
|
4
4
|
* {
|
|
5
|
-
* currency: "
|
|
5
|
+
* currency: "aed",
|
|
6
6
|
* forInitialPlan: true,
|
|
7
7
|
* forTrialExpiryPlan: true,
|
|
8
8
|
* ids: ["ids"],
|
|
@@ -24,7 +24,7 @@ import type * as Schematic from "../../../../index";
|
|
|
24
24
|
*/
|
|
25
25
|
export interface ListBillingProductPricesRequest {
|
|
26
26
|
/** Filter for prices in a specific currency (e.g. usd, eur) */
|
|
27
|
-
currency?:
|
|
27
|
+
currency?: Schematic.Currency;
|
|
28
28
|
/** Filter for prices valid for initial plans (free prices only) */
|
|
29
29
|
forInitialPlan?: boolean;
|
|
30
30
|
/** Filter for prices valid for trial expiry plans (free prices only) */
|
|
@@ -17,4 +17,5 @@ export type { ListCustomersWithSubscriptionsRequest } from "./ListCustomersWithS
|
|
|
17
17
|
export type { ListInvoicesRequest } from "./ListInvoicesRequest";
|
|
18
18
|
export type { ListMetersRequest } from "./ListMetersRequest";
|
|
19
19
|
export type { ListPaymentMethodsRequest } from "./ListPaymentMethodsRequest";
|
|
20
|
+
export type { UpdateBillingSettingsRequestBody } from "./UpdateBillingSettingsRequestBody";
|
|
20
21
|
export type { UpdateCompanyBillingProfileRequestBody } from "./UpdateCompanyBillingProfileRequestBody";
|
|
@@ -4,7 +4,7 @@ import type * as Schematic from "../../../index";
|
|
|
4
4
|
*/
|
|
5
5
|
export interface ListBillingPricesParams {
|
|
6
6
|
/** Filter for prices in a specific currency (e.g. usd, eur) */
|
|
7
|
-
currency?:
|
|
7
|
+
currency?: Schematic.Currency;
|
|
8
8
|
/** Filter for prices valid for initial plans (free prices only) */
|
|
9
9
|
forInitialPlan?: boolean;
|
|
10
10
|
/** Filter for prices valid for trial expiry plans (free prices only) */
|
|
@@ -4,7 +4,7 @@ import type * as Schematic from "../../../index";
|
|
|
4
4
|
*/
|
|
5
5
|
export interface ListBillingProductPricesParams {
|
|
6
6
|
/** Filter for prices in a specific currency (e.g. usd, eur) */
|
|
7
|
-
currency?:
|
|
7
|
+
currency?: Schematic.Currency;
|
|
8
8
|
/** Filter for prices valid for initial plans (free prices only) */
|
|
9
9
|
forInitialPlan?: boolean;
|
|
10
10
|
/** Filter for prices valid for trial expiry plans (free prices only) */
|
|
@@ -8,6 +8,7 @@ export * from "./DeleteBillingInvoiceResponse";
|
|
|
8
8
|
export * from "./DeleteBillingProductResponse";
|
|
9
9
|
export * from "./DeletePaymentMethodByExternalIdResponse";
|
|
10
10
|
export * from "./DeleteProductPriceResponse";
|
|
11
|
+
export * from "./GetBillingSettingsResponse";
|
|
11
12
|
export * from "./ListBillingPricesParams";
|
|
12
13
|
export * from "./ListBillingPricesResponse";
|
|
13
14
|
export * from "./ListBillingProductPricesParams";
|
|
@@ -26,6 +27,7 @@ export * from "./ListMetersParams";
|
|
|
26
27
|
export * from "./ListMetersResponse";
|
|
27
28
|
export * from "./ListPaymentMethodsParams";
|
|
28
29
|
export * from "./ListPaymentMethodsResponse";
|
|
30
|
+
export * from "./UpdateBillingSettingsResponse";
|
|
29
31
|
export * from "./UpdateCompanyBillingProfileResponse";
|
|
30
32
|
export * from "./UpsertBillingCouponResponse";
|
|
31
33
|
export * from "./UpsertBillingCustomerResponse";
|
|
@@ -638,7 +638,7 @@ export declare class CompaniesClient {
|
|
|
638
638
|
*
|
|
639
639
|
* @example
|
|
640
640
|
* await client.companies.listPlanChanges({
|
|
641
|
-
* action: "
|
|
641
|
+
* action: "amendment",
|
|
642
642
|
* basePlanAction: "fallback",
|
|
643
643
|
* companyId: "company_id",
|
|
644
644
|
* companyIds: ["company_ids"],
|
|
@@ -46,7 +46,7 @@ export declare class CreditsClient {
|
|
|
46
46
|
*
|
|
47
47
|
* @example
|
|
48
48
|
* await client.credits.createBillingCredit({
|
|
49
|
-
* currency: "
|
|
49
|
+
* currency: "aed",
|
|
50
50
|
* description: "description",
|
|
51
51
|
* name: "name"
|
|
52
52
|
* })
|
|
@@ -126,6 +126,27 @@ export declare class CreditsClient {
|
|
|
126
126
|
*/
|
|
127
127
|
listCompanyCreditBalances(request: Schematic.ListCompanyCreditBalancesRequest, requestOptions?: CreditsClient.RequestOptions): core.HttpResponsePromise<Schematic.ListCompanyCreditBalancesResponse>;
|
|
128
128
|
private __listCompanyCreditBalances;
|
|
129
|
+
/**
|
|
130
|
+
* @param {Schematic.GetCreditBalanceTimeSeriesRequest} request
|
|
131
|
+
* @param {CreditsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
132
|
+
*
|
|
133
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
134
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
135
|
+
* @throws {@link Schematic.NotFoundError}
|
|
136
|
+
* @throws {@link Schematic.InternalServerError}
|
|
137
|
+
* @throws {@link errors.SchematicError}
|
|
138
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
139
|
+
*
|
|
140
|
+
* @example
|
|
141
|
+
* await client.credits.getCreditBalanceTimeSeries({
|
|
142
|
+
* billingCreditId: "billing_credit_id",
|
|
143
|
+
* companyId: "company_id",
|
|
144
|
+
* endTime: new Date("2024-01-15T09:30:00.000Z"),
|
|
145
|
+
* startTime: new Date("2024-01-15T09:30:00.000Z")
|
|
146
|
+
* })
|
|
147
|
+
*/
|
|
148
|
+
getCreditBalanceTimeSeries(request: Schematic.GetCreditBalanceTimeSeriesRequest, requestOptions?: CreditsClient.RequestOptions): core.HttpResponsePromise<Schematic.GetCreditBalanceTimeSeriesResponse>;
|
|
149
|
+
private __getCreditBalanceTimeSeries;
|
|
129
150
|
/**
|
|
130
151
|
* @param {Schematic.ListCreditBundlesRequest} request
|
|
131
152
|
* @param {CreditsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -166,7 +187,7 @@ export declare class CreditsClient {
|
|
|
166
187
|
* await client.credits.createCreditBundle({
|
|
167
188
|
* bundleName: "bundle_name",
|
|
168
189
|
* creditId: "credit_id",
|
|
169
|
-
* currency: "
|
|
190
|
+
* currency: "aed",
|
|
170
191
|
* pricePerUnit: 1000000
|
|
171
192
|
* })
|
|
172
193
|
*/
|
|
@@ -672,8 +693,7 @@ export declare class CreditsClient {
|
|
|
672
693
|
*
|
|
673
694
|
* @example
|
|
674
695
|
* await client.credits.createCreditSpendPolicy({
|
|
675
|
-
* billingCreditId: "billing_credit_id"
|
|
676
|
-
* maxPerDraw: 1.1
|
|
696
|
+
* billingCreditId: "billing_credit_id"
|
|
677
697
|
* })
|
|
678
698
|
*/
|
|
679
699
|
createCreditSpendPolicy(request: Schematic.CreateCreditSpendPolicyRequestBody, requestOptions?: CreditsClient.RequestOptions): core.HttpResponsePromise<Schematic.CreateCreditSpendPolicyResponse>;
|
|
@@ -754,6 +774,27 @@ export declare class CreditsClient {
|
|
|
754
774
|
*/
|
|
755
775
|
countCreditSpendPolicies(request?: Schematic.CountCreditSpendPoliciesRequest, requestOptions?: CreditsClient.RequestOptions): core.HttpResponsePromise<Schematic.CountCreditSpendPoliciesResponse>;
|
|
756
776
|
private __countCreditSpendPolicies;
|
|
777
|
+
/**
|
|
778
|
+
* @param {Schematic.GetCreditSpendPolicyUsageRequest} request
|
|
779
|
+
* @param {CreditsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
780
|
+
*
|
|
781
|
+
* @throws {@link Schematic.BadRequestError}
|
|
782
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
783
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
784
|
+
* @throws {@link Schematic.NotFoundError}
|
|
785
|
+
* @throws {@link Schematic.InternalServerError}
|
|
786
|
+
* @throws {@link errors.SchematicError}
|
|
787
|
+
* @throws {@link errors.SchematicTimeoutError}
|
|
788
|
+
*
|
|
789
|
+
* @example
|
|
790
|
+
* await client.credits.getCreditSpendPolicyUsage({
|
|
791
|
+
* billingCreditId: "billing_credit_id",
|
|
792
|
+
* companyId: "company_id",
|
|
793
|
+
* userIds: ["user_ids"]
|
|
794
|
+
* })
|
|
795
|
+
*/
|
|
796
|
+
getCreditSpendPolicyUsage(request: Schematic.GetCreditSpendPolicyUsageRequest, requestOptions?: CreditsClient.RequestOptions): core.HttpResponsePromise<Schematic.GetCreditSpendPolicyUsageResponse>;
|
|
797
|
+
private __getCreditSpendPolicyUsage;
|
|
757
798
|
/**
|
|
758
799
|
* @param {Schematic.ListCreditEventLedgerRequest} request
|
|
759
800
|
* @param {CreditsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -771,7 +812,7 @@ export declare class CreditsClient {
|
|
|
771
812
|
* billingCreditId: "billing_credit_id",
|
|
772
813
|
* companyId: "company_id",
|
|
773
814
|
* endTime: "end_time",
|
|
774
|
-
* eventType: "
|
|
815
|
+
* eventType: "adjustment",
|
|
775
816
|
* featureId: "feature_id",
|
|
776
817
|
* startTime: "start_time",
|
|
777
818
|
* limit: 1000000,
|
|
@@ -797,7 +838,7 @@ export declare class CreditsClient {
|
|
|
797
838
|
* billingCreditId: "billing_credit_id",
|
|
798
839
|
* companyId: "company_id",
|
|
799
840
|
* endTime: "end_time",
|
|
800
|
-
* eventType: "
|
|
841
|
+
* eventType: "adjustment",
|
|
801
842
|
* featureId: "feature_id",
|
|
802
843
|
* startTime: "start_time",
|
|
803
844
|
* limit: 1000000,
|
|
@@ -12,4 +12,6 @@ export interface AcquireCreditLeaseRequestBody {
|
|
|
12
12
|
/** When the hold lapses if the lease is never released; defaults to five minutes from now and may be at most one hour out. The unspent hold is refunded on expiry */
|
|
13
13
|
expiresAt?: Date;
|
|
14
14
|
requestedAmount: number;
|
|
15
|
+
/** The user drawing the hold, so a user-scope spend policy applies to it */
|
|
16
|
+
userId?: string;
|
|
15
17
|
}
|
|
@@ -5,7 +5,7 @@ import type * as Schematic from "../../../../index";
|
|
|
5
5
|
* billingCreditId: "billing_credit_id",
|
|
6
6
|
* companyId: "company_id",
|
|
7
7
|
* endTime: "end_time",
|
|
8
|
-
* eventType: "
|
|
8
|
+
* eventType: "adjustment",
|
|
9
9
|
* featureId: "feature_id",
|
|
10
10
|
* startTime: "start_time",
|
|
11
11
|
* limit: 1000000,
|
|
@@ -2,14 +2,14 @@ import type * as Schematic from "../../../../index";
|
|
|
2
2
|
/**
|
|
3
3
|
* @example
|
|
4
4
|
* {
|
|
5
|
-
* currency: "
|
|
5
|
+
* currency: "aed",
|
|
6
6
|
* description: "description",
|
|
7
7
|
* name: "name"
|
|
8
8
|
* }
|
|
9
9
|
*/
|
|
10
10
|
export interface CreateBillingCreditRequestBody {
|
|
11
11
|
burnStrategy?: Schematic.BillingCreditBurnStrategy;
|
|
12
|
-
currency:
|
|
12
|
+
currency: Schematic.Currency;
|
|
13
13
|
currencyPrices?: Schematic.CreditCurrencyPriceRequestBody[];
|
|
14
14
|
defaultExpiryUnit?: Schematic.BillingCreditExpiryUnit;
|
|
15
15
|
defaultExpiryUnitCount?: number;
|
|
@@ -13,7 +13,7 @@ export interface CreateCompanyCreditGrant {
|
|
|
13
13
|
companyId: string;
|
|
14
14
|
creditBundleId?: string;
|
|
15
15
|
creditId: string;
|
|
16
|
-
currency?:
|
|
16
|
+
currency?: Schematic.Currency;
|
|
17
17
|
expiresAt?: Date;
|
|
18
18
|
expiryType?: Schematic.BillingCreditExpiryType;
|
|
19
19
|
expiryUnit?: Schematic.BillingCreditExpiryUnit;
|
|
@@ -4,7 +4,7 @@ import type * as Schematic from "../../../../index";
|
|
|
4
4
|
* {
|
|
5
5
|
* bundleName: "bundle_name",
|
|
6
6
|
* creditId: "credit_id",
|
|
7
|
-
* currency: "
|
|
7
|
+
* currency: "aed",
|
|
8
8
|
* pricePerUnit: 1000000
|
|
9
9
|
* }
|
|
10
10
|
*/
|
|
@@ -14,7 +14,7 @@ export interface CreateCreditBundleRequestBody {
|
|
|
14
14
|
/** Plans whose companies may purchase this bundle. Omitted or empty means the bundle is purchasable on every plan. */
|
|
15
15
|
compatiblePlanIds?: string[];
|
|
16
16
|
creditId: string;
|
|
17
|
-
currency:
|
|
17
|
+
currency: Schematic.Currency;
|
|
18
18
|
currencyPrices?: Schematic.CreditBundleCurrencyPriceRequestBody[];
|
|
19
19
|
expiryType?: Schematic.BillingCreditExpiryType;
|
|
20
20
|
expiryUnit?: Schematic.BillingCreditExpiryUnit;
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
+
import type * as Schematic from "../../../../index";
|
|
1
2
|
/**
|
|
2
3
|
* @example
|
|
3
4
|
* {
|
|
4
|
-
* billingCreditId: "billing_credit_id"
|
|
5
|
-
* maxPerDraw: 1.1
|
|
5
|
+
* billingCreditId: "billing_credit_id"
|
|
6
6
|
* }
|
|
7
7
|
*/
|
|
8
8
|
export interface CreateCreditSpendPolicyRequestBody {
|
|
@@ -10,8 +10,12 @@ export interface CreateCreditSpendPolicyRequestBody {
|
|
|
10
10
|
/** The company the cap applies to. Set exactly one of company_id and user_id. */
|
|
11
11
|
companyId?: string;
|
|
12
12
|
label?: string;
|
|
13
|
-
/** The largest number of credits a single draw may spend. */
|
|
14
|
-
maxPerDraw
|
|
13
|
+
/** The largest number of credits a single draw may spend. Set either this or window_amount. */
|
|
14
|
+
maxPerDraw?: number;
|
|
15
15
|
/** The user the cap applies to. Set exactly one of company_id and user_id. */
|
|
16
16
|
userId?: string;
|
|
17
|
+
/** The number of credits the company or user may spend in one window. Set either this or max_per_draw. */
|
|
18
|
+
windowAmount?: number;
|
|
19
|
+
/** The window that window_amount applies to: one UTC hour or one UTC day. Required with window_amount. */
|
|
20
|
+
windowUnit?: Schematic.CreditSpendWindowUnit;
|
|
17
21
|
}
|
|
@@ -10,4 +10,6 @@ export interface ExtendCreditLeaseRequestBody {
|
|
|
10
10
|
expiresAt?: Date;
|
|
11
11
|
/** A caller-chosen key for safe retries: a second request with the same key returns the lease as it stands instead of growing it again. Keys are unique per environment across every extend */
|
|
12
12
|
idempotencyKey?: string;
|
|
13
|
+
/** The user drawing the top-up, so a user-scope spend policy applies to it */
|
|
14
|
+
userId?: string;
|
|
13
15
|
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {
|
|
4
|
+
* billingCreditId: "billing_credit_id",
|
|
5
|
+
* companyId: "company_id",
|
|
6
|
+
* endTime: new Date("2024-01-15T09:30:00.000Z"),
|
|
7
|
+
* startTime: new Date("2024-01-15T09:30:00.000Z")
|
|
8
|
+
* }
|
|
9
|
+
*/
|
|
10
|
+
export interface GetCreditBalanceTimeSeriesRequest {
|
|
11
|
+
billingCreditId: string;
|
|
12
|
+
companyId: string;
|
|
13
|
+
endTime: Date;
|
|
14
|
+
startTime: Date;
|
|
15
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {
|
|
4
|
+
* billingCreditId: "billing_credit_id",
|
|
5
|
+
* companyId: "company_id",
|
|
6
|
+
* userIds: ["user_ids"]
|
|
7
|
+
* }
|
|
8
|
+
*/
|
|
9
|
+
export interface GetCreditSpendPolicyUsageRequest {
|
|
10
|
+
billingCreditId?: string;
|
|
11
|
+
companyId: string;
|
|
12
|
+
userIds?: string | string[];
|
|
13
|
+
}
|
|
@@ -5,7 +5,7 @@ import type * as Schematic from "../../../../index";
|
|
|
5
5
|
* billingCreditId: "billing_credit_id",
|
|
6
6
|
* companyId: "company_id",
|
|
7
7
|
* endTime: "end_time",
|
|
8
|
-
* eventType: "
|
|
8
|
+
* eventType: "adjustment",
|
|
9
9
|
* featureId: "feature_id",
|
|
10
10
|
* startTime: "start_time",
|
|
11
11
|
* limit: 1000000,
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type * as Schematic from "../../../../index";
|
|
1
2
|
/**
|
|
2
3
|
* @example
|
|
3
4
|
* {}
|
|
@@ -5,4 +6,6 @@
|
|
|
5
6
|
export interface UpdateCreditSpendPolicyRequestBody {
|
|
6
7
|
label?: string;
|
|
7
8
|
maxPerDraw?: number;
|
|
9
|
+
windowAmount?: number;
|
|
10
|
+
windowUnit?: Schematic.CreditSpendWindowUnit;
|
|
8
11
|
}
|
|
@@ -12,6 +12,8 @@ export type { CreateCreditBundleRequestBody } from "./CreateCreditBundleRequestB
|
|
|
12
12
|
export type { CreateCreditSpendPolicyRequestBody } from "./CreateCreditSpendPolicyRequestBody";
|
|
13
13
|
export type { DeleteBillingPlanCreditGrantRequest } from "./DeleteBillingPlanCreditGrantRequest";
|
|
14
14
|
export type { ExtendCreditLeaseRequestBody } from "./ExtendCreditLeaseRequestBody";
|
|
15
|
+
export type { GetCreditBalanceTimeSeriesRequest } from "./GetCreditBalanceTimeSeriesRequest";
|
|
16
|
+
export type { GetCreditSpendPolicyUsageRequest } from "./GetCreditSpendPolicyUsageRequest";
|
|
15
17
|
export type { ListBillingCreditsRequest } from "./ListBillingCreditsRequest";
|
|
16
18
|
export type { ListBillingPlanCreditGrantsRequest } from "./ListBillingPlanCreditGrantsRequest";
|
|
17
19
|
export type { ListCompanyCreditBalancesRequest } from "./ListCompanyCreditBalancesRequest";
|