@schematichq/schematic-typescript-node 1.4.6 → 1.4.8
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 +118 -2
- package/dist/BaseClient.d.ts +3 -0
- package/dist/Client.d.ts +5 -20
- package/dist/api/resources/accounts/client/Client.d.ts +22 -0
- package/dist/api/resources/accounts/client/requests/CountAccountMembersRequest.d.ts +18 -0
- package/dist/api/resources/accounts/client/requests/ListAccountMembersRequest.d.ts +1 -0
- package/dist/api/resources/accounts/client/requests/ListEnvironmentsRequest.d.ts +1 -0
- package/dist/api/resources/accounts/client/requests/index.d.ts +1 -0
- package/dist/api/resources/accounts/types/CountAccountMembersParams.d.ts +12 -0
- package/dist/api/resources/accounts/types/CountAccountMembersResponse.d.ts +6 -0
- package/dist/api/resources/accounts/types/index.d.ts +2 -0
- package/dist/api/resources/billing/client/Client.d.ts +31 -6
- package/dist/api/resources/billing/client/requests/CountBillingProductsRequest.d.ts +5 -1
- package/dist/api/resources/billing/client/requests/CountCustomersRequest.d.ts +2 -1
- package/dist/api/resources/billing/client/requests/CreateBillingPriceRequestBody.d.ts +2 -0
- package/dist/api/resources/billing/client/requests/ListBillingPricesRequest.d.ts +3 -1
- package/dist/api/resources/billing/client/requests/ListBillingProductPricesRequest.d.ts +3 -1
- package/dist/api/resources/billing/client/requests/ListBillingProductsRequest.d.ts +5 -1
- package/dist/api/resources/billing/client/requests/ListCustomersWithSubscriptionsRequest.d.ts +2 -1
- package/dist/api/resources/billing/types/CountBillingProductsParams.d.ts +2 -0
- package/dist/api/resources/billing/types/DeletePaymentMethodByExternalIdResponse.d.ts +6 -0
- package/dist/api/resources/billing/types/ListBillingProductsParams.d.ts +2 -0
- package/dist/api/resources/billing/types/index.d.ts +1 -0
- package/dist/api/resources/checkout/client/Client.d.ts +22 -0
- package/dist/api/resources/companies/client/Client.d.ts +27 -53
- package/dist/api/resources/companies/client/requests/CountCompaniesRequest.d.ts +8 -0
- package/dist/api/resources/companies/client/requests/CountEntityKeyDefinitionsRequest.d.ts +1 -0
- package/dist/api/resources/companies/client/requests/CountEntityTraitDefinitionsRequest.d.ts +2 -0
- package/dist/api/resources/companies/client/requests/CountPlanTraitsRequest.d.ts +2 -0
- package/dist/api/resources/companies/client/requests/CountUsersRequest.d.ts +1 -0
- package/dist/api/resources/companies/client/requests/GetActiveCompanySubscriptionRequest.d.ts +1 -0
- package/dist/api/resources/companies/client/requests/ListCompaniesRequest.d.ts +8 -0
- package/dist/api/resources/companies/client/requests/ListEntityKeyDefinitionsRequest.d.ts +1 -0
- package/dist/api/resources/companies/client/requests/ListEntityTraitDefinitionsRequest.d.ts +2 -0
- package/dist/api/resources/companies/client/requests/ListPlanChangesRequest.d.ts +2 -0
- package/dist/api/resources/companies/client/requests/ListPlanTraitsRequest.d.ts +2 -0
- package/dist/api/resources/companies/client/requests/ListUsersRequest.d.ts +1 -0
- package/dist/api/resources/companies/client/requests/index.d.ts +0 -2
- package/dist/api/resources/companies/types/CountCompaniesParams.d.ts +2 -0
- package/dist/api/resources/companies/types/ListCompaniesParams.d.ts +2 -0
- package/dist/api/resources/companies/types/index.d.ts +0 -3
- package/dist/api/resources/credits/client/Client.d.ts +84 -0
- package/dist/api/resources/credits/client/requests/AcquireCreditLeaseRequestBody.d.ts +14 -0
- package/dist/api/resources/credits/client/requests/CountBillingCreditsGrantsRequest.d.ts +1 -0
- package/dist/api/resources/credits/client/requests/CountBillingCreditsRequest.d.ts +1 -0
- package/dist/api/resources/credits/client/requests/CountBillingPlanCreditGrantsRequest.d.ts +4 -0
- package/dist/api/resources/credits/client/requests/CountCreditBundlesRequest.d.ts +1 -0
- package/dist/api/resources/credits/client/requests/ExtendCreditLeaseRequestBody.d.ts +10 -0
- package/dist/api/resources/credits/client/requests/ListBillingCreditsRequest.d.ts +1 -0
- package/dist/api/resources/credits/client/requests/ListBillingPlanCreditGrantsRequest.d.ts +4 -0
- package/dist/api/resources/credits/client/requests/ListCompanyCreditBalancesRequest.d.ts +9 -0
- package/dist/api/resources/credits/client/requests/ListCreditBundlesRequest.d.ts +1 -0
- package/dist/api/resources/credits/client/requests/ListGrantsForCreditRequest.d.ts +1 -0
- package/dist/api/resources/credits/client/requests/index.d.ts +3 -0
- package/dist/api/resources/credits/types/AcquireCreditLeaseResponse.d.ts +6 -0
- package/dist/api/resources/credits/types/CountBillingPlanCreditGrantsParams.d.ts +1 -0
- package/dist/api/resources/credits/types/ExtendCreditLeaseResponse.d.ts +6 -0
- package/dist/api/resources/credits/types/ListBillingPlanCreditGrantsParams.d.ts +1 -0
- package/dist/api/resources/credits/types/ListCompanyCreditBalancesParams.d.ts +6 -0
- package/dist/api/resources/credits/types/ListCompanyCreditBalancesResponse.d.ts +6 -0
- package/dist/api/resources/credits/types/ReleaseCreditLeaseResponse.d.ts +6 -0
- package/dist/api/resources/credits/types/index.d.ts +5 -0
- package/dist/api/resources/entitlements/client/Client.d.ts +19 -1
- package/dist/api/resources/entitlements/client/requests/CountCompanyOverridesRequest.d.ts +3 -0
- package/dist/api/resources/entitlements/client/requests/CountFeatureUsageRequest.d.ts +5 -0
- package/dist/api/resources/entitlements/client/requests/CountPlanEntitlementsRequest.d.ts +4 -0
- package/dist/api/resources/entitlements/client/requests/CreateBillingLinkedPlanEntitlementRequestBody.d.ts +9 -3
- package/dist/api/resources/entitlements/client/requests/CreateCompanyOverrideRequestBody.d.ts +2 -2
- package/dist/api/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.d.ts +8 -2
- package/dist/api/resources/entitlements/client/requests/ListCompanyOverridesRequest.d.ts +3 -0
- package/dist/api/resources/entitlements/client/requests/ListFeatureUsageRequest.d.ts +5 -0
- package/dist/api/resources/entitlements/client/requests/ListPlanEntitlementsRequest.d.ts +4 -0
- package/dist/api/resources/entitlements/client/requests/UpdateCompanyOverrideRequestBody.d.ts +2 -2
- package/dist/api/resources/entitlements/client/requests/UpdatePlanEntitlementRequestBody.d.ts +8 -2
- package/dist/api/resources/entitlements/types/CountFeatureUsageParams.d.ts +3 -0
- package/dist/api/resources/entitlements/types/ListFeatureUsageParams.d.ts +3 -0
- package/dist/api/resources/entitlements/types/index.d.ts +0 -10
- package/dist/api/resources/events/client/Client.d.ts +3 -0
- package/dist/api/resources/events/client/requests/GetEventSummariesRequest.d.ts +1 -0
- package/dist/api/resources/events/client/requests/ListEventsRequest.d.ts +3 -0
- package/dist/api/resources/events/types/ListEventsParams.d.ts +1 -0
- package/dist/api/resources/features/client/Client.d.ts +11 -3
- package/dist/api/resources/features/client/requests/CountFeaturesRequest.d.ts +5 -0
- package/dist/api/resources/features/client/requests/CountFlagsRequest.d.ts +1 -0
- package/dist/api/resources/features/client/requests/CreateBillingLinkedFeatureRequestBody.d.ts +2 -2
- package/dist/api/resources/features/client/requests/CreateFeatureRequestBody.d.ts +1 -1
- package/dist/api/resources/features/client/requests/ListFeaturesRequest.d.ts +5 -0
- package/dist/api/resources/features/client/requests/ListFlagsRequest.d.ts +1 -0
- package/dist/api/resources/features/client/requests/UpdateFeatureRequestBody.d.ts +1 -1
- package/dist/api/resources/features/client/requests/UpdateFlagRulesRequestBody.d.ts +2 -2
- package/dist/api/resources/features/types/CountFeaturesParams.d.ts +2 -0
- package/dist/api/resources/features/types/ListFeaturesParams.d.ts +2 -0
- package/dist/api/resources/index.d.ts +4 -0
- package/dist/api/resources/insights/client/Client.d.ts +114 -0
- package/dist/api/resources/insights/client/index.d.ts +1 -0
- package/dist/api/resources/insights/client/requests/GetActivityRequest.d.ts +9 -0
- package/dist/api/resources/insights/client/requests/GetEnvironmentFeatureUsageTimeSeriesRequest.d.ts +16 -0
- package/dist/api/resources/insights/client/requests/GetEnvironmentTraitUsageTimeSeriesRequest.d.ts +16 -0
- package/dist/api/resources/insights/client/requests/GetPlanGrowthRequest.d.ts +9 -0
- package/dist/api/resources/insights/client/requests/GetTopFeaturesByUsageRequest.d.ts +13 -0
- package/dist/api/resources/insights/client/requests/index.d.ts +5 -0
- package/dist/api/resources/insights/exports.d.ts +2 -0
- package/dist/api/resources/insights/index.d.ts +2 -0
- package/dist/api/resources/insights/types/GetActivityParams.d.ts +6 -0
- package/dist/api/resources/insights/types/GetActivityResponse.d.ts +6 -0
- package/dist/api/resources/insights/types/GetEnvironmentFeatureUsageTimeSeriesParams.d.ts +10 -0
- package/dist/api/resources/insights/types/GetEnvironmentFeatureUsageTimeSeriesResponse.d.ts +6 -0
- package/dist/api/resources/insights/types/GetEnvironmentTraitUsageTimeSeriesParams.d.ts +10 -0
- package/dist/api/resources/insights/types/GetEnvironmentTraitUsageTimeSeriesResponse.d.ts +6 -0
- package/dist/api/resources/insights/types/GetPlanGrowthParams.d.ts +6 -0
- package/dist/api/resources/insights/types/GetPlanGrowthResponse.d.ts +6 -0
- package/dist/api/resources/{companies/types/UpdatePlanTraitResponse.d.ts → insights/types/GetSummaryResponse.d.ts} +2 -2
- package/dist/api/resources/insights/types/GetTopFeaturesByUsageParams.d.ts +8 -0
- package/dist/api/resources/insights/types/GetTopFeaturesByUsageResponse.d.ts +6 -0
- package/dist/api/resources/insights/types/index.d.ts +11 -0
- package/dist/api/resources/integrationsapi/client/Client.d.ts +133 -0
- package/dist/api/resources/integrationsapi/client/index.d.ts +1 -1
- package/dist/api/resources/integrationsapi/client/requests/ListIntegrationsRequest.d.ts +24 -0
- package/dist/api/resources/integrationsapi/client/requests/StartDataImportRequestBody.d.ts +12 -0
- package/dist/api/resources/integrationsapi/client/requests/index.d.ts +2 -0
- package/dist/api/resources/integrationsapi/types/AssumeStripeInstalledResponse.d.ts +6 -0
- package/dist/api/resources/integrationsapi/types/InstallIntegrationResponse.d.ts +6 -0
- package/dist/api/resources/integrationsapi/types/InstallStripeResponse.d.ts +6 -0
- package/dist/api/resources/integrationsapi/types/ListIntegrationsParams.d.ts +15 -0
- package/dist/api/resources/integrationsapi/types/ListIntegrationsResponse.d.ts +6 -0
- package/dist/api/resources/integrationsapi/types/LoadSampleDataSetResponse.d.ts +6 -0
- package/dist/api/resources/{companies/types/CreatePlanTraitResponse.d.ts → integrationsapi/types/RunIntegrationResponse.d.ts} +2 -2
- package/dist/api/resources/integrationsapi/types/StartDataImportResponse.d.ts +6 -0
- package/dist/api/resources/{companies/types/DeletePlanTraitResponse.d.ts → integrationsapi/types/UninstallIntegrationResponse.d.ts} +1 -1
- package/dist/api/resources/integrationsapi/types/index.d.ts +9 -0
- package/dist/api/resources/planbundle/client/Client.d.ts +19 -0
- package/dist/api/resources/planbundle/client/requests/CreateCustomPlanBundleRequestBody.d.ts +14 -0
- package/dist/api/resources/planbundle/client/requests/index.d.ts +1 -0
- package/dist/api/resources/planbundle/types/CreateCustomPlanBundleResponse.d.ts +6 -0
- package/dist/api/resources/planbundle/types/index.d.ts +1 -0
- package/dist/api/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts +1 -0
- package/dist/api/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts +1 -0
- package/dist/api/resources/planmigrations/client/Client.d.ts +56 -0
- package/dist/api/resources/planmigrations/client/requests/CreateMigrationInput.d.ts +22 -0
- package/dist/api/resources/planmigrations/client/requests/RetryMigrationRequestBody.d.ts +10 -0
- package/dist/api/resources/planmigrations/client/requests/index.d.ts +2 -0
- package/dist/api/resources/planmigrations/types/CreateMigrationResponse.d.ts +6 -0
- package/dist/api/resources/planmigrations/types/RetryCompanyMigrationResponse.d.ts +6 -0
- package/dist/api/resources/planmigrations/types/RetryMigrationResponse.d.ts +6 -0
- package/dist/api/resources/planmigrations/types/index.d.ts +3 -0
- package/dist/api/resources/plans/client/Client.d.ts +71 -1
- package/dist/api/resources/plans/client/requests/CountPlansRequest.d.ts +10 -0
- package/dist/api/resources/plans/client/requests/CreateBillingLinkedPlanRequestBody.d.ts +2 -1
- package/dist/api/resources/plans/client/requests/ListCustomPlanBillingsRequest.d.ts +26 -0
- package/dist/api/resources/plans/client/requests/ListPlansRequest.d.ts +10 -0
- package/dist/api/resources/plans/client/requests/RetryCustomPlanBillingRequestBody.d.ts +17 -0
- package/dist/api/resources/plans/client/requests/index.d.ts +2 -0
- package/dist/api/resources/plans/types/CountPlansParams.d.ts +6 -0
- package/dist/api/resources/plans/types/ListCustomPlanBillingsParams.d.ts +18 -0
- package/dist/api/resources/plans/types/ListCustomPlanBillingsResponse.d.ts +6 -0
- package/dist/api/resources/plans/types/ListPlansParams.d.ts +6 -0
- package/dist/api/resources/plans/types/MarkCustomPlanBillingPaidResponse.d.ts +6 -0
- package/dist/api/resources/plans/types/RetryCustomPlanBillingResponse.d.ts +6 -0
- package/dist/api/resources/plans/types/index.d.ts +4 -0
- package/dist/api/resources/webhooks/client/Client.d.ts +2 -0
- package/dist/api/resources/webhooks/client/requests/CountWebhookEventsRequest.d.ts +1 -0
- package/dist/api/resources/webhooks/client/requests/ListWebhookEventsRequest.d.ts +1 -0
- package/dist/api/types/AccountMemberResponseData.d.ts +2 -0
- package/dist/api/types/ActivityEntryResponseData.d.ts +8 -0
- package/dist/api/types/ActivityResponseResponseData.d.ts +4 -0
- package/dist/api/types/ApiKeyCreateResponseData.d.ts +2 -0
- package/dist/api/types/ApiKeyIntegrationResponseData.d.ts +6 -0
- package/dist/api/types/ApiKeyResponseData.d.ts +2 -0
- package/dist/api/types/AuditLogListResponseData.d.ts +2 -0
- package/dist/api/types/AuditLogResponseData.d.ts +2 -0
- package/dist/api/types/BillingCreditBundleView.d.ts +1 -1
- package/dist/api/types/BillingCreditGrantReason.d.ts +1 -0
- package/dist/api/types/BillingCreditGrantResponseData.d.ts +4 -0
- package/dist/api/types/BillingCreditLedgerAuthority.d.ts +6 -0
- package/dist/api/types/BillingCreditView.d.ts +2 -0
- package/dist/api/types/BillingPlanCreditGrantResponseData.d.ts +3 -0
- package/dist/api/types/BillingPriceResponseData.d.ts +2 -0
- package/dist/api/types/BillingPriceView.d.ts +2 -0
- package/dist/api/types/BillingProductForSubscriptionResponseData.d.ts +1 -0
- package/dist/api/types/BillingProductPlanResponseData.d.ts +1 -0
- package/dist/api/types/BillingProductPriceResponseData.d.ts +2 -0
- package/dist/api/types/BillingProviderType.d.ts +1 -0
- package/dist/api/types/BillingStrategy.d.ts +6 -0
- package/dist/api/types/ChangeSubscriptionInternalRequestBody.d.ts +2 -0
- package/dist/api/types/ChangeSubscriptionRequestBody.d.ts +2 -0
- package/dist/api/types/ChargeType.d.ts +1 -0
- package/dist/api/types/CheckFlagResponseData.d.ts +2 -2
- package/dist/api/types/CheckoutDataResponseData.d.ts +1 -0
- package/dist/api/types/CheckoutFieldInput.d.ts +8 -0
- package/dist/api/types/CheckoutFieldResponseData.d.ts +12 -0
- package/dist/api/types/CheckoutFieldValue.d.ts +4 -0
- package/dist/api/types/CheckoutFieldWithValue.d.ts +9 -0
- package/dist/api/types/CheckoutSubscription.d.ts +1 -0
- package/dist/api/types/ClerkIntegrationConfig.d.ts +6 -0
- package/dist/api/types/CompanyCreditBalanceResponseData.d.ts +9 -0
- package/dist/api/types/CompanyEventPeriodMetricsResponseData.d.ts +3 -2
- package/dist/api/types/CompanyMatchingCriteria.d.ts +5 -0
- package/dist/api/types/CompanyOverrideResponseData.d.ts +2 -2
- package/dist/api/types/CompanyPlanCreditGrantView.d.ts +41 -0
- package/dist/api/types/CompanyPlanDetailResponseData.d.ts +7 -3
- package/dist/api/types/CompanyPlanWithBillingSubView.d.ts +1 -1
- package/dist/api/types/CompanySubscriptionResponseData.d.ts +1 -0
- package/dist/api/types/{ConditionOperator.d.ts → ComparableOperator.d.ts} +5 -5
- package/dist/api/types/ComponentHydrateResponseData.d.ts +1 -0
- package/dist/api/types/ComponentPreviewResponseData.d.ts +1 -0
- package/dist/api/types/Condition.d.ts +4 -4
- package/dist/api/types/ConditionResponseData.d.ts +4 -4
- package/dist/api/types/{ConditionConditionType.d.ts → ConditionType.d.ts} +2 -2
- package/dist/api/types/ConditionView.d.ts +4 -4
- package/dist/api/types/CreateBillingPlanCreditGrantRequestBody.d.ts +3 -0
- package/dist/api/types/CreateCustomPlanBundlePlanRequestBody.d.ts +7 -0
- package/dist/api/types/CreateEntitlementInBundleRequestBody.d.ts +8 -2
- package/dist/api/types/CreateEntitlementReqCommon.d.ts +2 -2
- package/dist/api/types/CreateEventRequestBody.d.ts +6 -0
- package/dist/api/types/CreateFlagRequestBody.d.ts +1 -1
- package/dist/api/types/CreateOrUpdateConditionRequestBody.d.ts +4 -4
- package/dist/api/types/CreateOrUpdateFlagRequestBody.d.ts +1 -1
- package/dist/api/types/CreateOrUpdateRuleRequestBody.d.ts +1 -1
- package/dist/api/types/CreditCompanyGrantView.d.ts +3 -0
- package/dist/api/types/CreditCurrencyPrice.d.ts +5 -0
- package/dist/api/types/CreditEventLedgerResponseData.d.ts +1 -0
- package/dist/api/types/CreditLeaseResponseData.d.ts +10 -0
- package/dist/api/types/CreditUsageReason.d.ts +8 -0
- package/dist/api/types/CurrencyPriceRequestBody.d.ts +3 -0
- package/dist/api/types/CustomPlanBillingResponseData.d.ts +1 -0
- package/dist/api/types/CustomPlanBillingStatus.d.ts +1 -0
- package/dist/api/types/DataEventPayload.d.ts +3 -0
- package/dist/api/types/DuplicatePlanEntitlementsResponseResponseData.d.ts +1 -0
- package/dist/api/types/EntitlementCurrencyPricesResponseData.d.ts +1 -0
- package/dist/api/types/EnvironmentFeatureUsageTimeSeriesResponseData.d.ts +6 -0
- package/dist/api/types/EnvironmentTraitUsageTimeSeriesResponseData.d.ts +6 -0
- package/dist/api/types/EnvironmentUsagePointResponseData.d.ts +4 -0
- package/dist/api/types/EventBodyTrack.d.ts +2 -0
- package/dist/api/types/EventDetailResponseData.d.ts +3 -0
- package/dist/api/types/EventResponseData.d.ts +2 -0
- package/dist/api/types/FeatureCompanyResponseData.d.ts +4 -3
- package/dist/api/types/FeatureCompanyUserResponseData.d.ts +2 -2
- package/dist/api/types/FeatureDetailResponseData.d.ts +2 -1
- package/dist/api/types/FeatureEntitlement.d.ts +2 -2
- package/dist/api/types/FeatureInPlanResponseData.d.ts +21 -0
- package/dist/api/types/FeatureResponseData.d.ts +1 -1
- package/dist/api/types/FeatureUsageResponseData.d.ts +4 -3
- package/dist/api/types/FeatureView.d.ts +1 -1
- package/dist/api/types/FlagDetailResponseData.d.ts +2 -1
- package/dist/api/types/FlagInPlanResponseData.d.ts +16 -0
- package/dist/api/types/FlagResponseData.d.ts +1 -1
- package/dist/api/types/FlagView.d.ts +0 -1
- package/dist/api/types/InsightsSummaryResponseData.d.ts +9 -0
- package/dist/api/types/InstallIntegrationRequestBody.d.ts +9 -0
- package/dist/api/types/IntegrationCapabilities.d.ts +5 -0
- package/dist/api/types/IntegrationConfig.d.ts +19 -0
- package/dist/api/types/IntegrationInstallConfig.d.ts +13 -0
- package/dist/api/types/IntegrationInstallResponseData.d.ts +6 -0
- package/dist/api/types/IntegrationResponseData.d.ts +8 -0
- package/dist/api/types/IntegrationState.d.ts +6 -0
- package/dist/api/types/IntegrationType.d.ts +2 -0
- package/dist/api/types/IntegrationsDataSetResponseData.d.ts +3 -0
- package/dist/api/types/IntegrationsListResponseData.d.ts +10 -0
- package/dist/api/types/IntegrationsResponseData.d.ts +8 -0
- package/dist/api/types/ManagePlanRequest.d.ts +1 -0
- package/dist/api/types/MarkCustomPlanBillingPaidRequestBody.d.ts +1 -0
- package/dist/api/types/{ConditionMetricPeriod.d.ts → MetricPeriod.d.ts} +2 -2
- package/dist/api/types/MetricPeriodMonthReset.d.ts +5 -0
- package/dist/api/types/MetronomeIntegrationConfig.d.ts +1 -0
- package/dist/api/types/MigrationErrorCode.d.ts +15 -0
- package/dist/api/types/MrrResponseData.d.ts +4 -0
- package/dist/api/types/OrbIntegrationConfig.d.ts +4 -0
- package/dist/api/types/PlanCreditGrantView.d.ts +2 -0
- package/dist/api/types/PlanCurrencyPriceRequestBody.d.ts +1 -0
- package/dist/api/types/PlanCurrencyPricesResponseData.d.ts +1 -0
- package/dist/api/types/PlanDetailResponseData.d.ts +6 -2
- package/dist/api/types/PlanEntitlementResponseData.d.ts +5 -2
- package/dist/api/types/PlanGroupDetailResponseData.d.ts +1 -0
- package/dist/api/types/PlanGroupPlanDetailResponseData.d.ts +7 -3
- package/dist/api/types/PlanGrowthPointResponseData.d.ts +6 -0
- package/dist/api/types/PlanGrowthResponseData.d.ts +4 -0
- package/dist/api/types/PlanPriceCadence.d.ts +6 -0
- package/dist/api/types/PlanVersionCompanyMigrationResponseData.d.ts +1 -0
- package/dist/api/types/PlanVersionMigrationResponseData.d.ts +1 -0
- package/dist/api/types/PlanViewPublicResponseData.d.ts +7 -3
- package/dist/api/types/ReleaseCreditLeaseRequestBody.d.ts +1 -0
- package/dist/api/types/Rule.d.ts +1 -1
- package/dist/api/types/RuleConditionDetailResponseData.d.ts +4 -4
- package/dist/api/types/RuleConditionResponseData.d.ts +4 -4
- package/dist/api/types/RuleDetailResponseData.d.ts +1 -1
- package/dist/api/types/RuleResponseData.d.ts +2 -1
- package/dist/api/types/{RuleRuleType.d.ts → RuleType.d.ts} +4 -4
- package/dist/api/types/RuleView.d.ts +1 -1
- package/dist/api/types/RulesEngineSchemaVersion.d.ts +1 -1
- package/dist/api/types/RulesengineCheckFlagResult.d.ts +2 -2
- package/dist/api/types/RulesengineCompanyMetric.d.ts +2 -2
- package/dist/api/types/RulesengineCondition.d.ts +4 -4
- package/dist/api/types/{RulesengineConditionConditionType.d.ts → RulesengineConditionType.d.ts} +2 -2
- package/dist/api/types/RulesengineFeatureEntitlement.d.ts +2 -2
- package/dist/api/types/RulesengineMetricPeriod.d.ts +7 -0
- package/dist/api/types/RulesengineMetricPeriodMonthReset.d.ts +5 -0
- package/dist/api/types/RulesengineRule.d.ts +1 -1
- package/dist/api/types/{RulesengineRuleRuleType.d.ts → RulesengineRuleType.d.ts} +4 -4
- package/dist/api/types/StripeIntegrationConfig.d.ts +14 -0
- package/dist/api/types/TopFeatureByUsageResponseData.d.ts +8 -0
- package/dist/api/types/TopFeaturesByUsageResponseData.d.ts +4 -0
- package/dist/api/types/UpdateAutoTopupOverrideRequestBody.d.ts +6 -0
- package/dist/api/types/UpdateBillingPlanCreditGrantRequestBody.d.ts +3 -0
- package/dist/api/types/UpdateEntitlementReqCommon.d.ts +2 -2
- package/dist/api/types/UpsertBillingProductRequestBody.d.ts +3 -0
- package/dist/api/types/UsageBasedEntitlementRequestBody.d.ts +6 -0
- package/dist/api/types/UsageBasedEntitlementResponseData.d.ts +5 -2
- package/dist/api/types/WorkOsIntegrationConfig.d.ts +6 -0
- package/dist/api/types/index.d.ts +56 -29
- package/dist/core/auth/AuthProvider.d.ts +1 -0
- package/dist/core/auth/BasicAuth.d.ts +2 -2
- package/dist/core/auth/index.d.ts +1 -1
- package/dist/core/fetcher/Fetcher.d.ts +8 -0
- package/dist/core/schemas/builders/enum/enum.d.ts +1 -0
- package/dist/core/schemas/builders/enum/index.d.ts +1 -1
- package/dist/core/url/QueryStringBuilder.d.ts +47 -0
- package/dist/core/url/index.d.ts +1 -0
- package/dist/core/url/qs.d.ts +2 -1
- package/dist/datastream/merge.d.ts +13 -10
- package/dist/datastream/websocket-client.d.ts +1 -1
- package/dist/errors/SchematicError.d.ts +3 -1
- package/dist/errors/SchematicTimeoutError.d.ts +4 -1
- package/dist/event-capture.d.ts +28 -0
- package/dist/events.d.ts +3 -3
- package/dist/index.d.ts +2 -1
- package/dist/index.js +3 -3
- package/dist/logger.d.ts +20 -0
- package/dist/rules-engine.d.ts +3 -3
- package/dist/serialization/resources/accounts/types/CountAccountMembersParams.d.ts +12 -0
- package/dist/serialization/resources/accounts/types/CountAccountMembersResponse.d.ts +12 -0
- package/dist/serialization/resources/accounts/types/index.d.ts +2 -0
- package/dist/serialization/resources/billing/client/requests/CreateBillingPriceRequestBody.d.ts +2 -0
- package/dist/serialization/resources/billing/types/CountBillingProductsParams.d.ts +1 -0
- package/dist/serialization/resources/billing/types/DeletePaymentMethodByExternalIdResponse.d.ts +11 -0
- package/dist/serialization/resources/billing/types/ListBillingProductsParams.d.ts +1 -0
- package/dist/serialization/resources/billing/types/index.d.ts +1 -0
- package/dist/serialization/resources/companies/client/requests/index.d.ts +0 -2
- package/dist/serialization/resources/companies/types/CountCompaniesParams.d.ts +1 -0
- package/dist/serialization/resources/companies/types/ListCompaniesParams.d.ts +1 -0
- package/dist/serialization/resources/companies/types/index.d.ts +0 -3
- package/dist/serialization/resources/credits/client/requests/AcquireCreditLeaseRequestBody.d.ts +12 -0
- package/dist/serialization/resources/credits/client/requests/ExtendCreditLeaseRequestBody.d.ts +10 -0
- package/dist/serialization/resources/credits/client/requests/index.d.ts +2 -0
- package/dist/serialization/resources/credits/types/AcquireCreditLeaseResponse.d.ts +11 -0
- package/dist/serialization/resources/credits/types/CountBillingPlanCreditGrantsParams.d.ts +1 -0
- package/dist/serialization/resources/credits/types/ExtendCreditLeaseResponse.d.ts +11 -0
- package/dist/serialization/resources/credits/types/ListBillingPlanCreditGrantsParams.d.ts +1 -0
- package/dist/serialization/resources/credits/types/ListCompanyCreditBalancesParams.d.ts +9 -0
- package/dist/serialization/resources/credits/types/ListCompanyCreditBalancesResponse.d.ts +12 -0
- package/dist/serialization/resources/credits/types/ReleaseCreditLeaseResponse.d.ts +11 -0
- package/dist/serialization/resources/credits/types/index.d.ts +5 -0
- package/dist/serialization/resources/entitlements/client/requests/CreateBillingLinkedPlanEntitlementRequestBody.d.ts +9 -4
- package/dist/serialization/resources/entitlements/client/requests/CreateCompanyOverrideRequestBody.d.ts +4 -4
- package/dist/serialization/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.d.ts +9 -4
- package/dist/serialization/resources/entitlements/client/requests/UpdateCompanyOverrideRequestBody.d.ts +4 -4
- package/dist/serialization/resources/entitlements/client/requests/UpdatePlanEntitlementRequestBody.d.ts +9 -4
- package/dist/serialization/resources/entitlements/types/CountFeatureUsageParams.d.ts +2 -0
- package/dist/serialization/resources/entitlements/types/ListFeatureUsageParams.d.ts +2 -0
- package/dist/serialization/resources/entitlements/types/index.d.ts +0 -10
- package/dist/serialization/resources/events/types/ListEventsParams.d.ts +1 -0
- package/dist/serialization/resources/features/client/requests/CreateBillingLinkedFeatureRequestBody.d.ts +1 -1
- package/dist/serialization/resources/features/client/requests/CreateFeatureRequestBody.d.ts +1 -1
- package/dist/serialization/resources/features/client/requests/UpdateFeatureRequestBody.d.ts +1 -1
- package/dist/serialization/resources/features/types/CountFeaturesParams.d.ts +2 -0
- package/dist/serialization/resources/features/types/ListFeaturesParams.d.ts +2 -0
- package/dist/serialization/resources/index.d.ts +4 -0
- package/dist/serialization/resources/insights/index.d.ts +1 -0
- package/dist/serialization/resources/insights/types/GetActivityParams.d.ts +9 -0
- package/dist/serialization/resources/insights/types/GetActivityResponse.d.ts +12 -0
- package/dist/serialization/resources/insights/types/GetEnvironmentFeatureUsageTimeSeriesParams.d.ts +13 -0
- package/dist/serialization/resources/insights/types/GetEnvironmentFeatureUsageTimeSeriesResponse.d.ts +12 -0
- package/dist/serialization/resources/insights/types/GetEnvironmentTraitUsageTimeSeriesParams.d.ts +13 -0
- package/dist/serialization/resources/insights/types/GetEnvironmentTraitUsageTimeSeriesResponse.d.ts +12 -0
- package/dist/serialization/resources/insights/types/GetPlanGrowthParams.d.ts +9 -0
- package/dist/serialization/resources/insights/types/GetPlanGrowthResponse.d.ts +12 -0
- package/dist/serialization/resources/insights/types/GetSummaryResponse.d.ts +11 -0
- package/dist/serialization/resources/insights/types/GetTopFeaturesByUsageParams.d.ts +11 -0
- package/dist/serialization/resources/insights/types/GetTopFeaturesByUsageResponse.d.ts +12 -0
- package/dist/serialization/resources/insights/types/index.d.ts +11 -0
- package/dist/serialization/resources/integrationsapi/client/index.d.ts +1 -0
- package/dist/serialization/resources/integrationsapi/client/requests/StartDataImportRequestBody.d.ts +12 -0
- package/dist/serialization/resources/integrationsapi/client/requests/index.d.ts +1 -0
- package/dist/serialization/resources/integrationsapi/index.d.ts +1 -0
- package/dist/serialization/resources/integrationsapi/types/AssumeStripeInstalledResponse.d.ts +11 -0
- package/dist/serialization/resources/integrationsapi/types/InstallIntegrationResponse.d.ts +11 -0
- package/dist/serialization/resources/integrationsapi/types/InstallStripeResponse.d.ts +11 -0
- package/dist/serialization/resources/integrationsapi/types/ListIntegrationsParams.d.ts +17 -0
- package/dist/serialization/resources/integrationsapi/types/ListIntegrationsResponse.d.ts +12 -0
- package/dist/serialization/resources/integrationsapi/types/LoadSampleDataSetResponse.d.ts +11 -0
- package/dist/serialization/resources/integrationsapi/types/RunIntegrationResponse.d.ts +11 -0
- package/dist/serialization/resources/integrationsapi/types/StartDataImportResponse.d.ts +11 -0
- package/dist/serialization/resources/{companies/types/DeletePlanTraitResponse.d.ts → integrationsapi/types/UninstallIntegrationResponse.d.ts} +2 -2
- package/dist/serialization/resources/integrationsapi/types/index.d.ts +9 -0
- package/dist/serialization/resources/planbundle/client/requests/CreateCustomPlanBundleRequestBody.d.ts +14 -0
- package/dist/serialization/resources/planbundle/client/requests/index.d.ts +1 -0
- package/dist/serialization/resources/planbundle/types/CreateCustomPlanBundleResponse.d.ts +11 -0
- package/dist/serialization/resources/planbundle/types/index.d.ts +1 -0
- package/dist/serialization/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts +2 -0
- package/dist/serialization/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts +2 -0
- package/dist/serialization/resources/planmigrations/client/index.d.ts +1 -0
- package/dist/serialization/resources/planmigrations/client/requests/CreateMigrationInput.d.ts +17 -0
- package/dist/serialization/resources/planmigrations/client/requests/RetryMigrationRequestBody.d.ts +10 -0
- package/dist/serialization/resources/planmigrations/client/requests/index.d.ts +2 -0
- package/dist/serialization/resources/planmigrations/index.d.ts +1 -0
- package/dist/serialization/resources/planmigrations/types/CreateMigrationResponse.d.ts +11 -0
- package/dist/serialization/resources/planmigrations/types/RetryCompanyMigrationResponse.d.ts +11 -0
- package/dist/serialization/resources/planmigrations/types/RetryMigrationResponse.d.ts +11 -0
- package/dist/serialization/resources/planmigrations/types/index.d.ts +3 -0
- package/dist/serialization/resources/plans/client/requests/CreateBillingLinkedPlanRequestBody.d.ts +1 -0
- package/dist/serialization/resources/plans/client/requests/RetryCustomPlanBillingRequestBody.d.ts +14 -0
- package/dist/serialization/resources/plans/client/requests/index.d.ts +1 -0
- package/dist/serialization/resources/plans/types/CountPlansParams.d.ts +3 -0
- package/dist/serialization/resources/plans/types/ListCustomPlanBillingsParams.d.ts +15 -0
- package/dist/serialization/resources/plans/types/ListCustomPlanBillingsResponse.d.ts +12 -0
- package/dist/serialization/resources/plans/types/ListPlansParams.d.ts +3 -0
- package/dist/serialization/resources/plans/types/MarkCustomPlanBillingPaidResponse.d.ts +11 -0
- package/dist/serialization/resources/plans/types/RetryCustomPlanBillingResponse.d.ts +11 -0
- package/dist/serialization/resources/plans/types/index.d.ts +4 -0
- package/dist/serialization/types/AccountMemberResponseData.d.ts +2 -0
- package/dist/serialization/types/ActivityEntryResponseData.d.ts +14 -0
- package/dist/serialization/types/ActivityResponseResponseData.d.ts +10 -0
- package/dist/serialization/types/ApiKeyCreateResponseData.d.ts +4 -0
- package/dist/serialization/types/ApiKeyIntegrationResponseData.d.ts +13 -0
- package/dist/serialization/types/ApiKeyResponseData.d.ts +4 -0
- package/dist/serialization/types/AuditLogListResponseData.d.ts +4 -0
- package/dist/serialization/types/AuditLogResponseData.d.ts +4 -0
- package/dist/serialization/types/BillingCreditBundleView.d.ts +1 -1
- package/dist/serialization/types/BillingCreditGrantReason.d.ts +1 -1
- package/dist/serialization/types/BillingCreditGrantResponseData.d.ts +3 -0
- package/dist/serialization/types/BillingCreditLedgerAuthority.d.ts +7 -0
- package/dist/serialization/types/BillingCreditView.d.ts +4 -0
- package/dist/serialization/types/BillingPlanCreditGrantResponseData.d.ts +2 -0
- package/dist/serialization/types/BillingPriceResponseData.d.ts +2 -0
- package/dist/serialization/types/BillingPriceView.d.ts +2 -0
- package/dist/serialization/types/BillingProductForSubscriptionResponseData.d.ts +1 -0
- package/dist/serialization/types/BillingProductPlanResponseData.d.ts +2 -0
- package/dist/serialization/types/BillingProductPriceResponseData.d.ts +2 -0
- package/dist/serialization/types/BillingProviderType.d.ts +1 -1
- package/dist/serialization/types/BillingStrategy.d.ts +7 -0
- package/dist/serialization/types/ChangeSubscriptionInternalRequestBody.d.ts +4 -0
- package/dist/serialization/types/ChangeSubscriptionRequestBody.d.ts +4 -0
- package/dist/serialization/types/ChargeType.d.ts +1 -1
- package/dist/serialization/types/CheckFlagResponseData.d.ts +4 -2
- package/dist/serialization/types/CheckoutDataResponseData.d.ts +2 -0
- package/dist/serialization/types/CheckoutFieldInput.d.ts +14 -0
- package/dist/serialization/types/CheckoutFieldResponseData.d.ts +18 -0
- package/dist/serialization/types/CheckoutFieldValue.d.ts +10 -0
- package/dist/serialization/types/CheckoutFieldWithValue.d.ts +15 -0
- package/dist/serialization/types/CheckoutSubscription.d.ts +1 -0
- package/dist/serialization/types/ClerkIntegrationConfig.d.ts +10 -0
- package/dist/serialization/types/CompanyCreditBalanceResponseData.d.ts +15 -0
- package/dist/serialization/types/CompanyEventPeriodMetricsResponseData.d.ts +4 -2
- package/dist/serialization/types/CompanyMatchingCriteria.d.ts +7 -0
- package/dist/serialization/types/CompanyOverrideResponseData.d.ts +4 -2
- package/dist/serialization/types/CompanyPlanCreditGrantView.d.ts +48 -0
- package/dist/serialization/types/CompanyPlanDetailResponseData.d.ts +10 -4
- package/dist/serialization/types/CompanyPlanWithBillingSubView.d.ts +2 -2
- package/dist/serialization/types/CompanySubscriptionResponseData.d.ts +2 -0
- package/dist/serialization/types/ComparableOperator.d.ts +7 -0
- package/dist/serialization/types/ComponentHydrateResponseData.d.ts +2 -0
- package/dist/serialization/types/ComponentPreviewResponseData.d.ts +2 -0
- package/dist/serialization/types/Condition.d.ts +8 -8
- package/dist/serialization/types/ConditionResponseData.d.ts +8 -4
- package/dist/serialization/types/{ConditionConditionType.d.ts → ConditionType.d.ts} +2 -2
- package/dist/serialization/types/ConditionView.d.ts +8 -4
- package/dist/serialization/types/CreateBillingPlanCreditGrantRequestBody.d.ts +2 -0
- package/dist/serialization/types/CreateCustomPlanBundlePlanRequestBody.d.ts +13 -0
- package/dist/serialization/types/CreateEntitlementInBundleRequestBody.d.ts +9 -4
- package/dist/serialization/types/CreateEntitlementReqCommon.d.ts +4 -4
- package/dist/serialization/types/CreateEventRequestBody.d.ts +3 -0
- package/dist/serialization/types/CreateFlagRequestBody.d.ts +1 -1
- package/dist/serialization/types/CreateOrUpdateConditionRequestBody.d.ts +8 -8
- package/dist/serialization/types/CreateOrUpdateFlagRequestBody.d.ts +1 -1
- package/dist/serialization/types/CreateOrUpdateRuleRequestBody.d.ts +2 -2
- package/dist/serialization/types/CreditCompanyGrantView.d.ts +3 -0
- package/dist/serialization/types/CreditCurrencyPrice.d.ts +11 -0
- package/dist/serialization/types/CreditEventLedgerResponseData.d.ts +2 -0
- package/dist/serialization/types/CreditLeaseResponseData.d.ts +16 -0
- package/dist/serialization/types/CreditUsageReason.d.ts +7 -0
- package/dist/serialization/types/CurrencyPriceRequestBody.d.ts +3 -0
- package/dist/serialization/types/CustomPlanBillingResponseData.d.ts +1 -0
- package/dist/serialization/types/CustomPlanBillingStatus.d.ts +1 -1
- package/dist/serialization/types/DataEventPayload.d.ts +3 -0
- package/dist/serialization/types/DuplicatePlanEntitlementsResponseResponseData.d.ts +2 -0
- package/dist/serialization/types/EntitlementCurrencyPricesResponseData.d.ts +1 -0
- package/dist/serialization/types/EnvironmentFeatureUsageTimeSeriesResponseData.d.ts +12 -0
- package/dist/serialization/types/EnvironmentTraitUsageTimeSeriesResponseData.d.ts +12 -0
- package/dist/serialization/types/EnvironmentUsagePointResponseData.d.ts +10 -0
- package/dist/serialization/types/EventBodyTrack.d.ts +1 -0
- package/dist/serialization/types/EventDetailResponseData.d.ts +4 -0
- package/dist/serialization/types/EventResponseData.d.ts +2 -0
- package/dist/serialization/types/FeatureCompanyResponseData.d.ts +7 -4
- package/dist/serialization/types/FeatureCompanyUserResponseData.d.ts +4 -2
- package/dist/serialization/types/FeatureDetailResponseData.d.ts +3 -1
- package/dist/serialization/types/FeatureEntitlement.d.ts +4 -4
- package/dist/serialization/types/FeatureInPlanResponseData.d.ts +33 -0
- package/dist/serialization/types/FeatureResponseData.d.ts +1 -1
- package/dist/serialization/types/FeatureUsageResponseData.d.ts +7 -4
- package/dist/serialization/types/FeatureView.d.ts +1 -1
- package/dist/serialization/types/FlagDetailResponseData.d.ts +3 -1
- package/dist/serialization/types/FlagInPlanResponseData.d.ts +24 -0
- package/dist/serialization/types/FlagResponseData.d.ts +1 -1
- package/dist/serialization/types/FlagView.d.ts +0 -1
- package/dist/serialization/types/InsightsSummaryResponseData.d.ts +15 -0
- package/dist/serialization/types/InstallIntegrationRequestBody.d.ts +16 -0
- package/dist/serialization/types/IntegrationCapabilities.d.ts +11 -0
- package/dist/serialization/types/IntegrationConfig.d.ts +27 -0
- package/dist/serialization/types/IntegrationInstallConfig.d.ts +20 -0
- package/dist/serialization/types/IntegrationInstallResponseData.d.ts +14 -0
- package/dist/serialization/types/IntegrationResponseData.d.ts +15 -0
- package/dist/serialization/types/IntegrationState.d.ts +7 -0
- package/dist/serialization/types/IntegrationType.d.ts +1 -1
- package/dist/serialization/types/IntegrationsDataSetResponseData.d.ts +9 -0
- package/dist/serialization/types/IntegrationsListResponseData.d.ts +19 -0
- package/dist/serialization/types/IntegrationsResponseData.d.ts +15 -0
- package/dist/serialization/types/ManagePlanRequest.d.ts +2 -0
- package/dist/serialization/types/MarkCustomPlanBillingPaidRequestBody.d.ts +7 -0
- package/dist/serialization/types/{ConditionMetricPeriod.d.ts → MetricPeriod.d.ts} +2 -2
- package/dist/serialization/types/MetricPeriodMonthReset.d.ts +7 -0
- package/dist/serialization/types/MetronomeIntegrationConfig.d.ts +7 -0
- package/dist/serialization/types/MigrationErrorCode.d.ts +7 -0
- package/dist/serialization/types/MrrResponseData.d.ts +10 -0
- package/dist/serialization/types/OrbIntegrationConfig.d.ts +9 -0
- package/dist/serialization/types/PlanCreditGrantView.d.ts +2 -0
- package/dist/serialization/types/PlanCurrencyPriceRequestBody.d.ts +1 -0
- package/dist/serialization/types/PlanCurrencyPricesResponseData.d.ts +1 -0
- package/dist/serialization/types/PlanDetailResponseData.d.ts +9 -3
- package/dist/serialization/types/PlanEntitlementResponseData.d.ts +6 -2
- package/dist/serialization/types/PlanGroupDetailResponseData.d.ts +2 -0
- package/dist/serialization/types/PlanGroupPlanDetailResponseData.d.ts +10 -4
- package/dist/serialization/types/PlanGrowthPointResponseData.d.ts +12 -0
- package/dist/serialization/types/PlanGrowthResponseData.d.ts +10 -0
- package/dist/serialization/types/PlanPriceCadence.d.ts +7 -0
- package/dist/serialization/types/PlanVersionCompanyMigrationResponseData.d.ts +2 -0
- package/dist/serialization/types/PlanVersionMigrationResponseData.d.ts +1 -0
- package/dist/serialization/types/PlanViewPublicResponseData.d.ts +10 -4
- package/dist/serialization/types/ReleaseCreditLeaseRequestBody.d.ts +7 -0
- package/dist/serialization/types/Rule.d.ts +2 -2
- package/dist/serialization/types/RuleConditionDetailResponseData.d.ts +8 -4
- package/dist/serialization/types/RuleConditionResponseData.d.ts +8 -4
- package/dist/serialization/types/RuleDetailResponseData.d.ts +2 -1
- package/dist/serialization/types/RuleResponseData.d.ts +2 -1
- package/dist/serialization/types/RuleType.d.ts +7 -0
- package/dist/serialization/types/RuleView.d.ts +2 -1
- package/dist/serialization/types/RulesEngineSchemaVersion.d.ts +1 -1
- package/dist/serialization/types/RulesengineCheckFlagResult.d.ts +4 -4
- package/dist/serialization/types/RulesengineCompanyMetric.d.ts +4 -4
- package/dist/serialization/types/RulesengineCondition.d.ts +8 -8
- package/dist/serialization/types/{RulesengineConditionConditionType.d.ts → RulesengineConditionType.d.ts} +2 -2
- package/dist/serialization/types/RulesengineFeatureEntitlement.d.ts +4 -4
- package/dist/serialization/types/RulesengineMetricPeriod.d.ts +7 -0
- package/dist/serialization/types/RulesengineMetricPeriodMonthReset.d.ts +7 -0
- package/dist/serialization/types/RulesengineRule.d.ts +2 -2
- package/dist/serialization/types/RulesengineRuleType.d.ts +7 -0
- package/dist/serialization/types/StripeIntegrationConfig.d.ts +14 -0
- package/dist/serialization/types/TopFeatureByUsageResponseData.d.ts +14 -0
- package/dist/serialization/types/TopFeaturesByUsageResponseData.d.ts +10 -0
- package/dist/serialization/types/UpdateAutoTopupOverrideRequestBody.d.ts +12 -0
- package/dist/serialization/types/UpdateBillingPlanCreditGrantRequestBody.d.ts +2 -0
- package/dist/serialization/types/UpdateEntitlementReqCommon.d.ts +4 -4
- package/dist/serialization/types/UpsertBillingProductRequestBody.d.ts +4 -0
- package/dist/serialization/types/UsageBasedEntitlementRequestBody.d.ts +5 -0
- package/dist/serialization/types/UsageBasedEntitlementResponseData.d.ts +6 -2
- package/dist/serialization/types/WorkOsIntegrationConfig.d.ts +10 -0
- package/dist/serialization/types/index.d.ts +56 -29
- package/dist/version.d.ts +2 -0
- package/dist/wasm/rulesengine.d.ts +1 -0
- package/dist/wasm/rulesengine.js +43 -11
- package/dist/wasm/rulesengine_bg.wasm.d.ts +1 -0
- package/dist/wrapper.d.ts +40 -5
- package/package.json +3 -3
- package/dist/api/resources/companies/client/requests/CreatePlanTraitRequestBody.d.ts +0 -13
- package/dist/api/resources/companies/client/requests/UpdatePlanTraitRequestBody.d.ts +0 -11
- package/dist/api/resources/entitlements/types/CreateBillingLinkedPlanEntitlementRequestBodyMetricPeriod.d.ts +0 -7
- package/dist/api/resources/entitlements/types/CreateBillingLinkedPlanEntitlementRequestBodyMetricPeriodMonthReset.d.ts +0 -5
- package/dist/api/resources/entitlements/types/CreateCompanyOverrideRequestBodyMetricPeriod.d.ts +0 -7
- package/dist/api/resources/entitlements/types/CreateCompanyOverrideRequestBodyMetricPeriodMonthReset.d.ts +0 -5
- package/dist/api/resources/entitlements/types/CreatePlanEntitlementRequestBodyMetricPeriod.d.ts +0 -7
- package/dist/api/resources/entitlements/types/CreatePlanEntitlementRequestBodyMetricPeriodMonthReset.d.ts +0 -5
- package/dist/api/resources/entitlements/types/UpdateCompanyOverrideRequestBodyMetricPeriod.d.ts +0 -7
- package/dist/api/resources/entitlements/types/UpdateCompanyOverrideRequestBodyMetricPeriodMonthReset.d.ts +0 -5
- package/dist/api/resources/entitlements/types/UpdatePlanEntitlementRequestBodyMetricPeriod.d.ts +0 -7
- package/dist/api/resources/entitlements/types/UpdatePlanEntitlementRequestBodyMetricPeriodMonthReset.d.ts +0 -5
- package/dist/api/types/ConditionMetricPeriodMonthReset.d.ts +0 -5
- package/dist/api/types/CreateEntitlementInBundleRequestBodyMetricPeriod.d.ts +0 -7
- package/dist/api/types/CreateEntitlementInBundleRequestBodyMetricPeriodMonthReset.d.ts +0 -5
- package/dist/api/types/CreateEntitlementReqCommonMetricPeriod.d.ts +0 -7
- package/dist/api/types/CreateEntitlementReqCommonMetricPeriodMonthReset.d.ts +0 -5
- package/dist/api/types/CreateOrUpdateConditionRequestBodyConditionType.d.ts +0 -10
- package/dist/api/types/CreateOrUpdateConditionRequestBodyMetricPeriod.d.ts +0 -8
- package/dist/api/types/CreateOrUpdateConditionRequestBodyMetricPeriodMonthReset.d.ts +0 -6
- package/dist/api/types/CreateOrUpdateConditionRequestBodyOperator.d.ts +0 -11
- package/dist/api/types/CreateOrUpdateRuleRequestBodyRuleType.d.ts +0 -8
- package/dist/api/types/FeatureEntitlementMetricPeriod.d.ts +0 -8
- package/dist/api/types/FeatureEntitlementMonthReset.d.ts +0 -6
- package/dist/api/types/RulesengineCheckFlagResultFeatureUsagePeriod.d.ts +0 -7
- package/dist/api/types/RulesengineCheckFlagResultRuleType.d.ts +0 -10
- package/dist/api/types/RulesengineCompanyMetricMonthReset.d.ts +0 -5
- package/dist/api/types/RulesengineCompanyMetricPeriod.d.ts +0 -7
- package/dist/api/types/RulesengineConditionMetricPeriod.d.ts +0 -7
- package/dist/api/types/RulesengineConditionMetricPeriodMonthReset.d.ts +0 -5
- package/dist/api/types/RulesengineConditionOperator.d.ts +0 -11
- package/dist/api/types/RulesengineFeatureEntitlementMetricPeriod.d.ts +0 -8
- package/dist/api/types/RulesengineFeatureEntitlementMonthReset.d.ts +0 -6
- package/dist/api/types/UpdateEntitlementReqCommonMetricPeriod.d.ts +0 -7
- package/dist/api/types/UpdateEntitlementReqCommonMetricPeriodMonthReset.d.ts +0 -5
- package/dist/serialization/resources/companies/client/requests/CreatePlanTraitRequestBody.d.ts +0 -11
- package/dist/serialization/resources/companies/client/requests/UpdatePlanTraitRequestBody.d.ts +0 -10
- package/dist/serialization/resources/companies/types/CreatePlanTraitResponse.d.ts +0 -11
- package/dist/serialization/resources/companies/types/UpdatePlanTraitResponse.d.ts +0 -11
- package/dist/serialization/resources/entitlements/types/CreateBillingLinkedPlanEntitlementRequestBodyMetricPeriod.d.ts +0 -7
- package/dist/serialization/resources/entitlements/types/CreateBillingLinkedPlanEntitlementRequestBodyMetricPeriodMonthReset.d.ts +0 -7
- package/dist/serialization/resources/entitlements/types/CreateCompanyOverrideRequestBodyMetricPeriod.d.ts +0 -7
- package/dist/serialization/resources/entitlements/types/CreateCompanyOverrideRequestBodyMetricPeriodMonthReset.d.ts +0 -7
- package/dist/serialization/resources/entitlements/types/CreatePlanEntitlementRequestBodyMetricPeriod.d.ts +0 -7
- package/dist/serialization/resources/entitlements/types/CreatePlanEntitlementRequestBodyMetricPeriodMonthReset.d.ts +0 -7
- package/dist/serialization/resources/entitlements/types/UpdateCompanyOverrideRequestBodyMetricPeriod.d.ts +0 -7
- package/dist/serialization/resources/entitlements/types/UpdateCompanyOverrideRequestBodyMetricPeriodMonthReset.d.ts +0 -7
- package/dist/serialization/resources/entitlements/types/UpdatePlanEntitlementRequestBodyMetricPeriod.d.ts +0 -7
- package/dist/serialization/resources/entitlements/types/UpdatePlanEntitlementRequestBodyMetricPeriodMonthReset.d.ts +0 -7
- package/dist/serialization/types/ConditionMetricPeriodMonthReset.d.ts +0 -7
- package/dist/serialization/types/ConditionOperator.d.ts +0 -7
- package/dist/serialization/types/CreateEntitlementInBundleRequestBodyMetricPeriod.d.ts +0 -7
- package/dist/serialization/types/CreateEntitlementInBundleRequestBodyMetricPeriodMonthReset.d.ts +0 -7
- package/dist/serialization/types/CreateEntitlementReqCommonMetricPeriod.d.ts +0 -7
- package/dist/serialization/types/CreateEntitlementReqCommonMetricPeriodMonthReset.d.ts +0 -7
- package/dist/serialization/types/CreateOrUpdateConditionRequestBodyConditionType.d.ts +0 -7
- package/dist/serialization/types/CreateOrUpdateConditionRequestBodyMetricPeriod.d.ts +0 -7
- package/dist/serialization/types/CreateOrUpdateConditionRequestBodyMetricPeriodMonthReset.d.ts +0 -7
- package/dist/serialization/types/CreateOrUpdateConditionRequestBodyOperator.d.ts +0 -7
- package/dist/serialization/types/CreateOrUpdateRuleRequestBodyRuleType.d.ts +0 -7
- package/dist/serialization/types/FeatureEntitlementMetricPeriod.d.ts +0 -7
- package/dist/serialization/types/FeatureEntitlementMonthReset.d.ts +0 -7
- package/dist/serialization/types/RuleRuleType.d.ts +0 -7
- package/dist/serialization/types/RulesengineCheckFlagResultFeatureUsagePeriod.d.ts +0 -7
- package/dist/serialization/types/RulesengineCheckFlagResultRuleType.d.ts +0 -7
- package/dist/serialization/types/RulesengineCompanyMetricMonthReset.d.ts +0 -7
- package/dist/serialization/types/RulesengineCompanyMetricPeriod.d.ts +0 -7
- package/dist/serialization/types/RulesengineConditionMetricPeriod.d.ts +0 -7
- package/dist/serialization/types/RulesengineConditionMetricPeriodMonthReset.d.ts +0 -7
- package/dist/serialization/types/RulesengineConditionOperator.d.ts +0 -7
- package/dist/serialization/types/RulesengineFeatureEntitlementMetricPeriod.d.ts +0 -7
- package/dist/serialization/types/RulesengineFeatureEntitlementMonthReset.d.ts +0 -7
- package/dist/serialization/types/RulesengineRuleRuleType.d.ts +0 -7
- package/dist/serialization/types/UpdateEntitlementReqCommonMetricPeriod.d.ts +0 -7
- package/dist/serialization/types/UpdateEntitlementReqCommonMetricPeriodMonthReset.d.ts +0 -7
- package/dist/wasm/rulesengine_bg.wasm +0 -0
|
@@ -3,7 +3,7 @@ export interface ConditionResponseData {
|
|
|
3
3
|
accountId: string;
|
|
4
4
|
comparisonTraitId?: string;
|
|
5
5
|
conditionGroupId?: string;
|
|
6
|
-
conditionType:
|
|
6
|
+
conditionType: Schematic.ConditionType;
|
|
7
7
|
consumptionRate?: number;
|
|
8
8
|
createdAt: Date;
|
|
9
9
|
creditId?: string;
|
|
@@ -11,10 +11,10 @@ export interface ConditionResponseData {
|
|
|
11
11
|
eventSubtype?: string;
|
|
12
12
|
flagId?: string;
|
|
13
13
|
id: string;
|
|
14
|
-
metricPeriod?:
|
|
15
|
-
metricPeriodMonthReset?:
|
|
14
|
+
metricPeriod?: Schematic.MetricPeriod;
|
|
15
|
+
metricPeriodMonthReset?: Schematic.MetricPeriodMonthReset;
|
|
16
16
|
metricValue?: number;
|
|
17
|
-
operator:
|
|
17
|
+
operator: Schematic.ComparableOperator;
|
|
18
18
|
resourceUnspecifiedIds: string[];
|
|
19
19
|
ruleId: string;
|
|
20
20
|
traitEntityType?: Schematic.EntityType;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export declare const
|
|
1
|
+
export declare const ConditionType: {
|
|
2
2
|
readonly BasePlan: "base_plan";
|
|
3
3
|
readonly BillingProduct: "billing_product";
|
|
4
4
|
readonly Company: "company";
|
|
@@ -9,4 +9,4 @@ export declare const ConditionConditionType: {
|
|
|
9
9
|
readonly Trait: "trait";
|
|
10
10
|
readonly User: "user";
|
|
11
11
|
};
|
|
12
|
-
export type
|
|
12
|
+
export type ConditionType = (typeof ConditionType)[keyof typeof ConditionType];
|
|
@@ -6,7 +6,7 @@ export interface ConditionView {
|
|
|
6
6
|
comparisonTrait?: Schematic.EntityTraitDefinitionResponseData;
|
|
7
7
|
comparisonTraitId?: string;
|
|
8
8
|
conditionGroupId?: string;
|
|
9
|
-
conditionType:
|
|
9
|
+
conditionType: Schematic.ConditionType;
|
|
10
10
|
consumptionRate?: number;
|
|
11
11
|
createdAt: Date;
|
|
12
12
|
creditId?: string;
|
|
@@ -14,10 +14,10 @@ export interface ConditionView {
|
|
|
14
14
|
eventSubtype?: string;
|
|
15
15
|
flagId?: string;
|
|
16
16
|
id: string;
|
|
17
|
-
metricPeriod?:
|
|
18
|
-
metricPeriodMonthReset?:
|
|
17
|
+
metricPeriod?: Schematic.MetricPeriod;
|
|
18
|
+
metricPeriodMonthReset?: Schematic.MetricPeriodMonthReset;
|
|
19
19
|
metricValue?: number;
|
|
20
|
-
operator:
|
|
20
|
+
operator: Schematic.ComparableOperator;
|
|
21
21
|
planVersions: Schematic.GenericPreviewObject[];
|
|
22
22
|
plans: Schematic.GenericPreviewObject[];
|
|
23
23
|
resourceUnspecifiedIds: string[];
|
|
@@ -7,6 +7,7 @@ export interface CreateBillingPlanCreditGrantRequestBody {
|
|
|
7
7
|
autoTopupExpiryType?: Schematic.BillingCreditExpiryType;
|
|
8
8
|
autoTopupExpiryUnit?: Schematic.BillingCreditExpiryUnit;
|
|
9
9
|
autoTopupExpiryUnitCount?: number;
|
|
10
|
+
autoTopupSelfService?: boolean;
|
|
10
11
|
autoTopupThresholdCredits?: number;
|
|
11
12
|
autoTopupThresholdPercent?: number;
|
|
12
13
|
creditAmount: number;
|
|
@@ -19,4 +20,6 @@ export interface CreateBillingPlanCreditGrantRequestBody {
|
|
|
19
20
|
resetCadence: Schematic.BillingPlanCreditGrantResetCadence;
|
|
20
21
|
resetStart: Schematic.BillingPlanCreditGrantResetStart;
|
|
21
22
|
resetType?: Schematic.BillingPlanCreditGrantResetType;
|
|
23
|
+
/** Percentage of unused credits that carry over when this grant resets. Only applies when reset_type is plan_period. Rolled-over credits expire at the next reset and are not rolled again. Defaults to 0. */
|
|
24
|
+
rolloverPercentage?: number;
|
|
22
25
|
}
|
|
@@ -6,8 +6,8 @@ export interface CreateEntitlementInBundleRequestBody {
|
|
|
6
6
|
currency?: string;
|
|
7
7
|
currencyPrices?: Schematic.CurrencyPriceRequestBody[];
|
|
8
8
|
featureId: string;
|
|
9
|
-
metricPeriod?: Schematic.
|
|
10
|
-
metricPeriodMonthReset?: Schematic.
|
|
9
|
+
metricPeriod?: Schematic.MetricPeriod;
|
|
10
|
+
metricPeriodMonthReset?: Schematic.MetricPeriodMonthReset;
|
|
11
11
|
monthlyMeteredPriceId?: string;
|
|
12
12
|
monthlyPriceTiers?: Schematic.CreatePriceTierRequestBody[];
|
|
13
13
|
monthlyUnitPrice?: number;
|
|
@@ -18,8 +18,14 @@ export interface CreateEntitlementInBundleRequestBody {
|
|
|
18
18
|
priceBehavior?: Schematic.EntitlementPriceBehavior;
|
|
19
19
|
/** Use MonthlyPriceTiers or YearlyPriceTiers instead */
|
|
20
20
|
priceTiers?: Schematic.CreatePriceTierRequestBody[];
|
|
21
|
+
quarterlyMeteredPriceId?: string;
|
|
22
|
+
quarterlyPriceTiers?: Schematic.CreatePriceTierRequestBody[];
|
|
23
|
+
quarterlyUnitPrice?: number;
|
|
24
|
+
quarterlyUnitPriceDecimal?: string;
|
|
21
25
|
softLimit?: number;
|
|
22
26
|
tierMode?: Schematic.BillingTiersMode;
|
|
27
|
+
/** The committed unit quantity for this entitlement. For custom plans this is the quantity the company is contractually committed to; for standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. Note: this is not yet enforced/auto-provisioned as a true default — it is currently stored for downstream billing use. */
|
|
28
|
+
usageQuantity?: number;
|
|
23
29
|
valueBool?: boolean;
|
|
24
30
|
valueCreditId?: string;
|
|
25
31
|
valueNumeric?: number;
|
|
@@ -2,8 +2,8 @@ import type * as Schematic from "../index";
|
|
|
2
2
|
export interface CreateEntitlementReqCommon {
|
|
3
3
|
creditConsumptionRate?: number;
|
|
4
4
|
featureId: string;
|
|
5
|
-
metricPeriod?: Schematic.
|
|
6
|
-
metricPeriodMonthReset?: Schematic.
|
|
5
|
+
metricPeriod?: Schematic.MetricPeriod;
|
|
6
|
+
metricPeriodMonthReset?: Schematic.MetricPeriodMonthReset;
|
|
7
7
|
valueBool?: boolean;
|
|
8
8
|
valueCreditId?: string;
|
|
9
9
|
valueNumeric?: number;
|
|
@@ -1,8 +1,14 @@
|
|
|
1
1
|
import type * as Schematic from "../index";
|
|
2
2
|
export interface CreateEventRequestBody {
|
|
3
|
+
/** Requires a secret API key, and trusted_client_clock. Import historical data without affecting billing. */
|
|
4
|
+
backfill?: boolean;
|
|
3
5
|
body?: Schematic.EventBody;
|
|
4
6
|
/** Either 'identify' or 'track' */
|
|
5
7
|
eventType: Schematic.EventType;
|
|
8
|
+
/** Optional client-supplied key. Duplicate events with the same key (scoped to the environment) are dropped for 24h. */
|
|
9
|
+
idempotencyKey?: string;
|
|
6
10
|
/** Optionally provide a timestamp at which the event was sent to Schematic */
|
|
7
11
|
sentAt?: Date;
|
|
12
|
+
/** Requires a secret API key and sent_at. Use sent_at as the effective timestamp. */
|
|
13
|
+
trustedClientClock?: boolean;
|
|
8
14
|
}
|
|
@@ -2,7 +2,7 @@ import type * as Schematic from "../index";
|
|
|
2
2
|
export interface CreateOrUpdateConditionRequestBody {
|
|
3
3
|
/** Optionally provide a trait ID to compare a metric or trait value against instead of a value */
|
|
4
4
|
comparisonTraitId?: string;
|
|
5
|
-
conditionType: Schematic.
|
|
5
|
+
conditionType: Schematic.ConditionType;
|
|
6
6
|
/** Cost of credit to use to measure this condition */
|
|
7
7
|
creditCost?: number;
|
|
8
8
|
/** ID of credit to use to measure this condition */
|
|
@@ -11,12 +11,12 @@ export interface CreateOrUpdateConditionRequestBody {
|
|
|
11
11
|
eventSubtype?: string;
|
|
12
12
|
id?: string;
|
|
13
13
|
/** Period of time over which to measure the track event metric */
|
|
14
|
-
metricPeriod?: Schematic.
|
|
14
|
+
metricPeriod?: Schematic.MetricPeriod;
|
|
15
15
|
/** When metric_period=current_month, specify whether the month restarts based on the calendar month or the billing period */
|
|
16
|
-
metricPeriodMonthReset?: Schematic.
|
|
16
|
+
metricPeriodMonthReset?: Schematic.MetricPeriodMonthReset;
|
|
17
17
|
/** Value to compare the track event metric against */
|
|
18
18
|
metricValue?: number;
|
|
19
|
-
operator: Schematic.
|
|
19
|
+
operator: Schematic.ComparableOperator;
|
|
20
20
|
/** List of resource IDs (companies, users, or plans) targeted by this condition */
|
|
21
21
|
resourceIds: string[];
|
|
22
22
|
/** ID of trait to use to measure this condition */
|
|
@@ -25,7 +25,10 @@ export interface CreditCompanyGrantView {
|
|
|
25
25
|
quantityUsed: number;
|
|
26
26
|
renewalEnabled: boolean;
|
|
27
27
|
renewalPeriod?: Schematic.BillingPlanCreditGrantResetCadence;
|
|
28
|
+
reserved?: number;
|
|
29
|
+
settled?: number;
|
|
28
30
|
singularName?: string;
|
|
31
|
+
sourceGrantId?: string;
|
|
29
32
|
sourceLabel: string;
|
|
30
33
|
transfers?: Schematic.CreditTransferView[];
|
|
31
34
|
updatedAt: Date;
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
export declare const CreditUsageReason: {
|
|
2
|
+
readonly LeaseHold: "lease_hold";
|
|
3
|
+
readonly LeaseRelease: "lease_release";
|
|
4
|
+
readonly ManualAdjustment: "manual_adjustment";
|
|
5
|
+
readonly Reconciliation: "reconciliation";
|
|
6
|
+
readonly Track: "track";
|
|
7
|
+
};
|
|
8
|
+
export type CreditUsageReason = (typeof CreditUsageReason)[keyof typeof CreditUsageReason];
|
|
@@ -4,6 +4,9 @@ export interface CurrencyPriceRequestBody {
|
|
|
4
4
|
monthlyPriceTiers?: Schematic.CreatePriceTierRequestBody[];
|
|
5
5
|
monthlyUnitPrice?: number;
|
|
6
6
|
monthlyUnitPriceDecimal?: string;
|
|
7
|
+
quarterlyPriceTiers?: Schematic.CreatePriceTierRequestBody[];
|
|
8
|
+
quarterlyUnitPrice?: number;
|
|
9
|
+
quarterlyUnitPriceDecimal?: string;
|
|
7
10
|
yearlyPriceTiers?: Schematic.CreatePriceTierRequestBody[];
|
|
8
11
|
yearlyUnitPrice?: number;
|
|
9
12
|
yearlyUnitPriceDecimal?: string;
|
|
@@ -1,7 +1,10 @@
|
|
|
1
1
|
import type * as Schematic from "../index";
|
|
2
2
|
export interface DataEventPayload {
|
|
3
3
|
apiKey: string;
|
|
4
|
+
backfill?: boolean;
|
|
4
5
|
body?: Record<string, unknown>;
|
|
6
|
+
idempotencyKey?: string;
|
|
5
7
|
sentAt?: Date;
|
|
8
|
+
trustedClientClock?: boolean;
|
|
6
9
|
type: Schematic.EventType;
|
|
7
10
|
}
|
|
@@ -3,6 +3,8 @@ export interface EventBodyTrack {
|
|
|
3
3
|
company?: Record<string, string>;
|
|
4
4
|
/** The name of the type of track event */
|
|
5
5
|
event: string;
|
|
6
|
+
/** Credit lease ID this track event is redeeming against */
|
|
7
|
+
leaseId?: string;
|
|
6
8
|
/** Optionally specify the quantity of the event */
|
|
7
9
|
quantity?: number;
|
|
8
10
|
/** A map of trait names to trait values */
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import type * as Schematic from "../index";
|
|
2
2
|
export interface EventDetailResponseData {
|
|
3
3
|
apiKey?: string;
|
|
4
|
+
apiKeyView?: Schematic.ApiKeyResponseData;
|
|
4
5
|
body: Record<string, unknown>;
|
|
5
6
|
bodyPreview: string;
|
|
6
7
|
capturedAt: Date;
|
|
@@ -12,6 +13,8 @@ export interface EventDetailResponseData {
|
|
|
12
13
|
featureIds: string[];
|
|
13
14
|
features: Schematic.PreviewObject[];
|
|
14
15
|
id: string;
|
|
16
|
+
idempotencyKey?: string;
|
|
17
|
+
leaseId?: string;
|
|
15
18
|
loadedAt?: Date;
|
|
16
19
|
processedAt?: Date;
|
|
17
20
|
quantity: number;
|
|
@@ -32,7 +32,7 @@ export interface FeatureCompanyResponseData {
|
|
|
32
32
|
/** Source of the entitlement (plan or company_override) */
|
|
33
33
|
entitlementSource?: string;
|
|
34
34
|
entitlementType: Schematic.EntitlementType;
|
|
35
|
-
feature?: Schematic.
|
|
35
|
+
feature?: Schematic.FeatureInPlanResponseData;
|
|
36
36
|
/** Whether a valid allocation exists */
|
|
37
37
|
hasValidAllocation?: boolean;
|
|
38
38
|
/** Whether this is an unlimited allocation */
|
|
@@ -40,17 +40,18 @@ export interface FeatureCompanyResponseData {
|
|
|
40
40
|
/** The time at which the metric will reset. */
|
|
41
41
|
metricResetAt?: Date;
|
|
42
42
|
/** If the period is current_month, when the month resets. */
|
|
43
|
-
monthReset?:
|
|
43
|
+
monthReset?: Schematic.MetricPeriodMonthReset;
|
|
44
44
|
monthlyUsageBasedPrice?: Schematic.BillingPriceView;
|
|
45
45
|
/** Amount of usage exceeding soft limit (overage pricing only) */
|
|
46
46
|
overuse?: number;
|
|
47
47
|
/** Percentage of allocation consumed (0-100+) */
|
|
48
48
|
percentUsed?: number;
|
|
49
49
|
/** The period over which usage is measured. */
|
|
50
|
-
period?:
|
|
50
|
+
period?: Schematic.MetricPeriod;
|
|
51
51
|
plan?: Schematic.PlanResponseData;
|
|
52
52
|
planEntitlement?: Schematic.PlanEntitlementResponseData;
|
|
53
53
|
priceBehavior?: Schematic.EntitlementPriceBehavior;
|
|
54
|
+
quarterlyUsageBasedPrice?: Schematic.BillingPriceView;
|
|
54
55
|
/** The soft limit for the feature usage. Available only for overage price behavior */
|
|
55
56
|
softLimit?: number;
|
|
56
57
|
/** The amount of usage that has been consumed; a null value indicates that usage is not being measured or that this is a credit-based entitlement (use credit_used instead). */
|
|
@@ -13,9 +13,9 @@ export interface FeatureCompanyUserResponseData {
|
|
|
13
13
|
/** The time at which the metric will resets. */
|
|
14
14
|
metricResetAt?: Date;
|
|
15
15
|
/** If the period is current_month, when the month resets. */
|
|
16
|
-
monthReset?:
|
|
16
|
+
monthReset?: Schematic.MetricPeriodMonthReset;
|
|
17
17
|
/** The period over which usage is measured. */
|
|
18
|
-
period?:
|
|
18
|
+
period?: Schematic.MetricPeriod;
|
|
19
19
|
plan?: Schematic.PlanResponseData;
|
|
20
20
|
/** The amount of usage that has been consumed; a null value indicates that usage is not being measured. */
|
|
21
21
|
usage?: number;
|
|
@@ -10,7 +10,8 @@ export interface FeatureDetailResponseData {
|
|
|
10
10
|
icon: string;
|
|
11
11
|
id: string;
|
|
12
12
|
lifecyclePhase?: Schematic.FeatureLifecyclePhase;
|
|
13
|
-
|
|
13
|
+
maintainer?: Schematic.AccountMemberResponseData;
|
|
14
|
+
maintainerAccountMemberId?: string;
|
|
14
15
|
name: string;
|
|
15
16
|
plans: Schematic.PreviewObject[];
|
|
16
17
|
pluralName?: string;
|
|
@@ -17,11 +17,11 @@ export interface FeatureEntitlement {
|
|
|
17
17
|
/** The key of the flag associated with the feature */
|
|
18
18
|
featureKey: string;
|
|
19
19
|
/** For event-based feature entitlements, the period over which usage is tracked */
|
|
20
|
-
metricPeriod?: Schematic.
|
|
20
|
+
metricPeriod?: Schematic.MetricPeriod;
|
|
21
21
|
/** For event-based feature entitlements, when the usage period will reset */
|
|
22
22
|
metricResetAt?: Date;
|
|
23
23
|
/** For event-based feature entitlements that have a monthly period, whether that monthly reset is based on the calendar month or a billing cycle */
|
|
24
|
-
monthReset?: Schematic.
|
|
24
|
+
monthReset?: Schematic.MetricPeriodMonthReset;
|
|
25
25
|
/** For usage-based pricing, the soft limit for overage charges or the next tier boundary */
|
|
26
26
|
softLimit?: number;
|
|
27
27
|
/** If the company has a numeric entitlement for this feature, the current usage amount */
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import type * as Schematic from "../index";
|
|
2
|
+
export interface FeatureInPlanResponseData {
|
|
3
|
+
billingLinkedResource?: Schematic.BillingLinkedResourceResponseData;
|
|
4
|
+
createdAt: Date;
|
|
5
|
+
description: string;
|
|
6
|
+
eventSubtype?: string;
|
|
7
|
+
eventSummary?: Schematic.EventSummaryResponseData;
|
|
8
|
+
featureType: Schematic.FeatureType;
|
|
9
|
+
flags: Schematic.FlagInPlanResponseData[];
|
|
10
|
+
icon: string;
|
|
11
|
+
id: string;
|
|
12
|
+
lifecyclePhase?: Schematic.FeatureLifecyclePhase;
|
|
13
|
+
maintainerAccountMemberId?: string;
|
|
14
|
+
name: string;
|
|
15
|
+
plans: Schematic.PreviewObject[];
|
|
16
|
+
pluralName?: string;
|
|
17
|
+
singularName?: string;
|
|
18
|
+
trait?: Schematic.EntityTraitDefinitionResponseData;
|
|
19
|
+
traitId?: string;
|
|
20
|
+
updatedAt: Date;
|
|
21
|
+
}
|
|
@@ -30,7 +30,7 @@ export interface FeatureUsageResponseData {
|
|
|
30
30
|
/** Source of the entitlement (plan or company_override) */
|
|
31
31
|
entitlementSource?: string;
|
|
32
32
|
entitlementType: Schematic.EntitlementType;
|
|
33
|
-
feature?: Schematic.
|
|
33
|
+
feature?: Schematic.FeatureInPlanResponseData;
|
|
34
34
|
/** Whether a valid allocation exists */
|
|
35
35
|
hasValidAllocation?: boolean;
|
|
36
36
|
/** Whether this is an unlimited allocation */
|
|
@@ -38,17 +38,18 @@ export interface FeatureUsageResponseData {
|
|
|
38
38
|
/** The time at which the metric will reset. */
|
|
39
39
|
metricResetAt?: Date;
|
|
40
40
|
/** If the period is current_month, when the month resets. */
|
|
41
|
-
monthReset?:
|
|
41
|
+
monthReset?: Schematic.MetricPeriodMonthReset;
|
|
42
42
|
monthlyUsageBasedPrice?: Schematic.BillingPriceView;
|
|
43
43
|
/** Amount of usage exceeding soft limit (overage pricing only) */
|
|
44
44
|
overuse?: number;
|
|
45
45
|
/** Percentage of allocation consumed (0-100+) */
|
|
46
46
|
percentUsed?: number;
|
|
47
47
|
/** The period over which usage is measured. */
|
|
48
|
-
period?:
|
|
48
|
+
period?: Schematic.MetricPeriod;
|
|
49
49
|
plan?: Schematic.PlanResponseData;
|
|
50
50
|
planEntitlement?: Schematic.PlanEntitlementResponseData;
|
|
51
51
|
priceBehavior?: Schematic.EntitlementPriceBehavior;
|
|
52
|
+
quarterlyUsageBasedPrice?: Schematic.BillingPriceView;
|
|
52
53
|
/** The soft limit for the feature usage. Available only for overage price behavior */
|
|
53
54
|
softLimit?: number;
|
|
54
55
|
/** The amount of usage that has been consumed; a null value indicates that usage is not being measured or that this is a credit-based entitlement (use credit_used instead). */
|
|
@@ -11,7 +11,6 @@ export interface FeatureView {
|
|
|
11
11
|
icon: string;
|
|
12
12
|
id: string;
|
|
13
13
|
lifecyclePhase?: Schematic.FeatureLifecyclePhase;
|
|
14
|
-
maintainerId?: string;
|
|
15
14
|
name: string;
|
|
16
15
|
plans: Schematic.PreviewObject[];
|
|
17
16
|
pluralName?: string;
|
|
@@ -19,4 +18,5 @@ export interface FeatureView {
|
|
|
19
18
|
trait?: Schematic.EntityTraitDefinitionResponseData;
|
|
20
19
|
traitId?: string;
|
|
21
20
|
updatedAt: Date;
|
|
21
|
+
usageLimitTraitId?: string;
|
|
22
22
|
}
|
|
@@ -9,7 +9,8 @@ export interface FlagDetailResponseData {
|
|
|
9
9
|
id: string;
|
|
10
10
|
key: string;
|
|
11
11
|
lastCheckedAt?: Date;
|
|
12
|
-
|
|
12
|
+
maintainer?: Schematic.AccountMemberResponseData;
|
|
13
|
+
maintainerAccountMemberId?: string;
|
|
13
14
|
name: string;
|
|
14
15
|
rules: Schematic.RuleDetailResponseData[];
|
|
15
16
|
updatedAt: Date;
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type * as Schematic from "../index";
|
|
2
|
+
export interface FlagInPlanResponseData {
|
|
3
|
+
createdAt: Date;
|
|
4
|
+
defaultValue: boolean;
|
|
5
|
+
description: string;
|
|
6
|
+
feature?: Schematic.FeatureResponseData;
|
|
7
|
+
featureId?: string;
|
|
8
|
+
flagType: Schematic.FlagType;
|
|
9
|
+
id: string;
|
|
10
|
+
key: string;
|
|
11
|
+
lastCheckedAt?: Date;
|
|
12
|
+
maintainerAccountMemberId?: string;
|
|
13
|
+
name: string;
|
|
14
|
+
rules: Schematic.RuleDetailResponseData[];
|
|
15
|
+
updatedAt: Date;
|
|
16
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type * as Schematic from "../index";
|
|
2
|
+
export interface InstallIntegrationRequestBody {
|
|
3
|
+
companyMatchingCriteria?: Schematic.CompanyMatchingCriteria;
|
|
4
|
+
companyMatchingField?: string;
|
|
5
|
+
config?: Record<string, unknown>;
|
|
6
|
+
isSandbox?: boolean;
|
|
7
|
+
liveMode?: boolean;
|
|
8
|
+
type: Schematic.IntegrationType;
|
|
9
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import type * as Schematic from "../index";
|
|
2
|
+
export type IntegrationConfig = Schematic.IntegrationConfig.Clerk | Schematic.IntegrationConfig.Metronome | Schematic.IntegrationConfig.Orb | Schematic.IntegrationConfig.Stripe | Schematic.IntegrationConfig.Workos;
|
|
3
|
+
export declare namespace IntegrationConfig {
|
|
4
|
+
interface Clerk extends Schematic.ClerkIntegrationConfig {
|
|
5
|
+
type: "clerk";
|
|
6
|
+
}
|
|
7
|
+
interface Metronome extends Schematic.MetronomeIntegrationConfig {
|
|
8
|
+
type: "metronome";
|
|
9
|
+
}
|
|
10
|
+
interface Orb extends Schematic.OrbIntegrationConfig {
|
|
11
|
+
type: "orb";
|
|
12
|
+
}
|
|
13
|
+
interface Stripe extends Schematic.StripeIntegrationConfig {
|
|
14
|
+
type: "stripe";
|
|
15
|
+
}
|
|
16
|
+
interface Workos extends Schematic.WorkOsIntegrationConfig {
|
|
17
|
+
type: "workos";
|
|
18
|
+
}
|
|
19
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type * as Schematic from "../index";
|
|
2
|
+
export interface IntegrationInstallConfig {
|
|
3
|
+
companyMatchingCriteria?: Schematic.CompanyMatchingCriteria;
|
|
4
|
+
companyMatchingField?: string;
|
|
5
|
+
config?: Schematic.IntegrationConfig;
|
|
6
|
+
createdAt: Date;
|
|
7
|
+
id: string;
|
|
8
|
+
integrationId: string;
|
|
9
|
+
isAppInstall: boolean;
|
|
10
|
+
isConnectInstall: boolean;
|
|
11
|
+
liveMode: boolean;
|
|
12
|
+
updatedAt: Date;
|
|
13
|
+
}
|