@schematichq/schematic-typescript-node 1.2.2 → 1.2.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/Client.d.ts +69 -2
- package/dist/api/resources/accesstokens/client/Client.d.ts +3 -3
- package/dist/api/resources/accesstokens/client/requests/IssueTemporaryAccessTokenRequestBody.d.ts +1 -0
- package/dist/api/resources/accounts/client/Client.d.ts +29 -8
- package/dist/api/resources/accounts/client/requests/CountApiKeysRequest.d.ts +4 -1
- package/dist/api/resources/accounts/client/requests/CountApiRequestsRequest.d.ts +7 -1
- package/dist/api/resources/accounts/client/requests/ListApiKeysRequest.d.ts +4 -1
- package/dist/api/resources/accounts/client/requests/ListApiRequestsRequest.d.ts +7 -1
- package/dist/api/resources/accounts/client/requests/ListEnvironmentsRequest.d.ts +4 -1
- package/dist/api/resources/accounts/types/ListApiKeysResponse.d.ts +0 -1
- package/dist/api/resources/accounts/types/ListApiRequestsResponse.d.ts +0 -1
- package/dist/api/resources/accounts/types/ListEnvironmentsResponse.d.ts +0 -1
- package/dist/api/resources/billing/client/Client.d.ts +87 -15
- package/dist/api/resources/billing/client/requests/CountBillingProductsRequest.d.ts +12 -1
- package/dist/api/resources/billing/client/requests/CountCustomersRequest.d.ts +7 -1
- package/dist/api/resources/billing/client/requests/{CreateBillingSubscriptionsRequestBody.d.ts → CreateBillingSubscriptionRequestBody.d.ts} +3 -2
- package/dist/api/resources/billing/client/requests/ListBillingProductsRequest.d.ts +12 -1
- package/dist/api/resources/billing/client/requests/ListCouponsRequest.d.ts +6 -1
- package/dist/api/resources/billing/client/requests/ListCustomersWithSubscriptionsRequest.d.ts +7 -1
- package/dist/api/resources/billing/client/requests/ListInvoicesRequest.d.ts +4 -1
- package/dist/api/resources/billing/client/requests/ListMetersRequest.d.ts +5 -1
- package/dist/api/resources/billing/client/requests/ListPaymentMethodsRequest.d.ts +4 -1
- package/dist/api/resources/billing/client/requests/ListProductPricesRequest.d.ts +12 -1
- package/dist/api/resources/billing/client/requests/SearchBillingPricesRequest.d.ts +28 -3
- package/dist/api/resources/billing/client/requests/index.d.ts +1 -1
- package/dist/api/resources/billing/types/CreateBillingSubscriptionRequestBodyTrialEndSetting.d.ts +8 -0
- package/dist/api/resources/billing/types/ListBillingProductsResponse.d.ts +0 -1
- package/dist/api/resources/billing/types/ListCouponsResponse.d.ts +0 -1
- package/dist/api/resources/billing/types/ListCustomersWithSubscriptionsResponse.d.ts +0 -1
- package/dist/api/resources/billing/types/ListInvoicesResponse.d.ts +0 -1
- package/dist/api/resources/billing/types/ListMetersResponse.d.ts +0 -1
- package/dist/api/resources/billing/types/ListPaymentMethodsResponse.d.ts +0 -1
- package/dist/api/resources/billing/types/ListProductPricesResponse.d.ts +0 -1
- package/dist/api/resources/billing/types/SearchBillingPricesParams.d.ts +7 -0
- package/dist/api/resources/billing/types/SearchBillingPricesResponse.d.ts +0 -1
- package/dist/api/resources/billing/types/index.d.ts +2 -2
- package/dist/api/resources/checkout/client/Client.d.ts +59 -3
- package/dist/api/resources/checkout/types/CheckoutInternalResponse.d.ts +1 -1
- package/dist/api/resources/checkout/types/ManagePlanResponse.d.ts +9 -0
- package/dist/api/resources/checkout/types/PreviewManagePlanResponse.d.ts +9 -0
- package/dist/api/resources/checkout/types/index.d.ts +2 -0
- package/dist/api/resources/companies/client/Client.d.ts +132 -19
- package/dist/api/resources/companies/client/requests/CountCompaniesForAdvancedFilterRequest.d.ts +15 -2
- package/dist/api/resources/companies/client/requests/CountCompaniesRequest.d.ts +9 -1
- package/dist/api/resources/companies/client/requests/CountEntityKeyDefinitionsRequest.d.ts +6 -1
- package/dist/api/resources/companies/client/requests/CountEntityTraitDefinitionsRequest.d.ts +7 -1
- package/dist/api/resources/companies/client/requests/CountPlanTraitsRequest.d.ts +6 -1
- package/dist/api/resources/companies/client/requests/CountUsersRequest.d.ts +7 -1
- package/dist/api/resources/companies/client/requests/GetActiveCompanySubscriptionRequest.d.ts +5 -1
- package/dist/api/resources/companies/client/requests/GetActiveDealsRequest.d.ts +3 -1
- package/dist/api/resources/companies/client/requests/GetEntityTraitValuesRequest.d.ts +4 -1
- package/dist/api/resources/companies/client/requests/ListCompaniesForAdvancedFilterRequest.d.ts +15 -2
- package/dist/api/resources/companies/client/requests/ListCompaniesRequest.d.ts +9 -1
- package/dist/api/resources/companies/client/requests/ListCompanyMembershipsRequest.d.ts +6 -1
- package/dist/api/resources/companies/client/requests/ListEntityKeyDefinitionsRequest.d.ts +6 -1
- package/dist/api/resources/companies/client/requests/ListEntityTraitDefinitionsRequest.d.ts +7 -1
- package/dist/api/resources/companies/client/requests/ListPlanTraitsRequest.d.ts +6 -1
- package/dist/api/resources/companies/client/requests/ListUsersRequest.d.ts +7 -1
- package/dist/api/resources/companies/client/requests/UpdatePlanTraitBulkRequestBody.d.ts +18 -0
- package/dist/api/resources/companies/client/requests/index.d.ts +1 -0
- package/dist/api/resources/companies/types/CountCompaniesForAdvancedFilterParams.d.ts +3 -1
- package/dist/api/resources/companies/types/GetActiveCompanySubscriptionResponse.d.ts +0 -1
- package/dist/api/resources/companies/types/GetActiveDealsResponse.d.ts +0 -1
- package/dist/api/resources/companies/types/GetEntityTraitValuesResponse.d.ts +0 -1
- package/dist/api/resources/companies/types/ListCompaniesForAdvancedFilterParams.d.ts +3 -1
- package/dist/api/resources/companies/types/ListCompaniesForAdvancedFilterResponse.d.ts +0 -1
- package/dist/api/resources/companies/types/ListCompaniesResponse.d.ts +0 -1
- package/dist/api/resources/companies/types/ListCompanyMembershipsResponse.d.ts +0 -1
- package/dist/api/resources/companies/types/ListEntityKeyDefinitionsResponse.d.ts +0 -1
- package/dist/api/resources/companies/types/ListEntityTraitDefinitionsResponse.d.ts +0 -1
- package/dist/api/resources/companies/types/ListPlanTraitsResponse.d.ts +0 -1
- package/dist/api/resources/companies/types/ListUsersResponse.d.ts +0 -1
- package/dist/api/resources/companies/types/UpdatePlanTraitsBulkResponse.d.ts +9 -0
- package/dist/api/resources/companies/types/index.d.ts +1 -0
- package/dist/api/resources/components/client/Client.d.ts +17 -6
- package/dist/api/resources/components/client/requests/CountComponentsRequest.d.ts +5 -1
- package/dist/api/resources/components/client/requests/ListComponentsRequest.d.ts +5 -1
- package/dist/api/resources/components/client/requests/PreviewComponentDataRequest.d.ts +4 -1
- package/dist/api/resources/components/types/ListComponentsResponse.d.ts +0 -1
- package/dist/api/resources/credits/client/Client.d.ts +104 -12
- package/dist/api/resources/credits/client/requests/CountBillingCreditsGrantsRequest.d.ts +5 -1
- package/dist/api/resources/credits/client/requests/CountBillingCreditsRequest.d.ts +5 -1
- package/dist/api/resources/credits/client/requests/CountBillingPlanCreditGrantsRequest.d.ts +6 -1
- package/dist/api/resources/credits/client/requests/CountCreditBundlesRequest.d.ts +7 -1
- package/dist/api/resources/credits/client/requests/CountCreditLedgerRequest.d.ts +33 -0
- package/dist/api/resources/credits/client/requests/CreateBillingPlanCreditGrantRequestBody.d.ts +4 -0
- package/dist/api/resources/credits/client/requests/CreateCompanyCreditGrant.d.ts +5 -0
- package/dist/api/resources/credits/client/requests/CreateCreditBundleRequestBody.d.ts +1 -1
- package/dist/api/resources/credits/client/requests/GetEnrichedCreditLedgerRequest.d.ts +33 -0
- package/dist/api/resources/credits/client/requests/ListBillingCreditsRequest.d.ts +5 -1
- package/dist/api/resources/credits/client/requests/ListBillingPlanCreditGrantsRequest.d.ts +6 -1
- package/dist/api/resources/credits/client/requests/ListCompanyGrantsRequest.d.ts +7 -1
- package/dist/api/resources/credits/client/requests/ListCreditBundlesRequest.d.ts +7 -1
- package/dist/api/resources/credits/client/requests/ListGrantsForCreditRequest.d.ts +5 -1
- package/dist/api/resources/credits/client/requests/UpdateCreditBundleDetailsRequestBody.d.ts +1 -0
- package/dist/api/resources/credits/client/requests/index.d.ts +2 -0
- package/dist/api/resources/credits/types/CountCreditLedgerParams.d.ts +19 -0
- package/dist/api/resources/credits/types/CountCreditLedgerRequestPeriod.d.ts +10 -0
- package/dist/api/resources/credits/types/CountCreditLedgerResponse.d.ts +9 -0
- package/dist/api/resources/credits/types/CountCreditLedgerResponseParamsPeriod.d.ts +10 -0
- package/dist/api/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyExpiryType.d.ts +11 -0
- package/dist/api/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyExpiryUnit.d.ts +8 -0
- package/dist/api/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyResetType.d.ts +8 -0
- package/dist/api/resources/credits/types/CreateCompanyCreditGrantExpiryType.d.ts +11 -0
- package/dist/api/resources/credits/types/CreateCompanyCreditGrantExpiryUnit.d.ts +8 -0
- package/dist/api/resources/credits/types/CreateCreditBundleRequestBodyExpiryType.d.ts +5 -2
- package/dist/api/resources/credits/types/CreateCreditBundleRequestBodyExpiryUnit.d.ts +8 -0
- package/dist/api/resources/credits/types/GetEnrichedCreditLedgerParams.d.ts +19 -0
- package/dist/api/resources/credits/types/GetEnrichedCreditLedgerRequestPeriod.d.ts +10 -0
- package/dist/api/resources/credits/types/GetEnrichedCreditLedgerResponse.d.ts +9 -0
- package/dist/api/resources/credits/types/GetEnrichedCreditLedgerResponseParamsPeriod.d.ts +10 -0
- package/dist/api/resources/credits/types/ListBillingCreditsResponse.d.ts +0 -1
- package/dist/api/resources/credits/types/ListBillingPlanCreditGrantsResponse.d.ts +0 -1
- package/dist/api/resources/credits/types/ListCompanyGrantsResponse.d.ts +0 -1
- package/dist/api/resources/credits/types/ListCreditBundlesResponse.d.ts +0 -1
- package/dist/api/resources/credits/types/ListGrantsForCreditResponse.d.ts +0 -1
- package/dist/api/resources/credits/types/UpdateCreditBundleDetailsRequestBodyExpiryType.d.ts +5 -2
- package/dist/api/resources/credits/types/UpdateCreditBundleDetailsRequestBodyExpiryUnit.d.ts +8 -0
- package/dist/api/resources/credits/types/ZeroOutGrantRequestBodyReason.d.ts +2 -1
- package/dist/api/resources/credits/types/index.d.ts +15 -0
- package/dist/api/resources/crm/client/Client.d.ts +8 -4
- package/dist/api/resources/crm/client/requests/ListCrmProductsRequest.d.ts +5 -1
- package/dist/api/resources/crm/types/ListCrmProductsResponse.d.ts +0 -1
- package/dist/api/resources/dataexports/client/Client.d.ts +3 -3
- package/dist/api/resources/entitlements/client/Client.d.ts +65 -13
- package/dist/api/resources/entitlements/client/requests/CountCompanyOverridesRequest.d.ts +8 -1
- package/dist/api/resources/entitlements/client/requests/CountFeatureCompaniesRequest.d.ts +4 -1
- package/dist/api/resources/entitlements/client/requests/CountFeatureUsageRequest.d.ts +7 -1
- package/dist/api/resources/entitlements/client/requests/CountFeatureUsersRequest.d.ts +4 -1
- package/dist/api/resources/entitlements/client/requests/CountPlanEntitlementsRequest.d.ts +8 -1
- package/dist/api/resources/entitlements/client/requests/CreateCompanyOverrideRequestBody.d.ts +1 -0
- package/dist/api/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.d.ts +1 -0
- package/dist/api/resources/entitlements/client/requests/ListCompanyOverridesRequest.d.ts +8 -1
- package/dist/api/resources/entitlements/client/requests/ListFeatureCompaniesRequest.d.ts +4 -1
- package/dist/api/resources/entitlements/client/requests/ListFeatureUsageRequest.d.ts +7 -1
- package/dist/api/resources/entitlements/client/requests/ListFeatureUsersRequest.d.ts +4 -1
- package/dist/api/resources/entitlements/client/requests/ListPlanEntitlementsRequest.d.ts +8 -1
- package/dist/api/resources/entitlements/client/requests/UpdateCompanyOverrideRequestBody.d.ts +1 -0
- package/dist/api/resources/entitlements/client/requests/UpdatePlanEntitlementRequestBody.d.ts +1 -0
- package/dist/api/resources/entitlements/types/ListCompanyOverridesResponse.d.ts +0 -1
- package/dist/api/resources/entitlements/types/ListFeatureCompaniesResponse.d.ts +0 -1
- package/dist/api/resources/entitlements/types/ListFeatureUsageResponse.d.ts +0 -1
- package/dist/api/resources/entitlements/types/ListFeatureUsersResponse.d.ts +0 -1
- package/dist/api/resources/entitlements/types/ListPlanEntitlementsResponse.d.ts +0 -1
- package/dist/api/resources/events/client/Client.d.ts +16 -5
- package/dist/api/resources/events/client/requests/GetEventSummariesRequest.d.ts +5 -1
- package/dist/api/resources/events/client/requests/ListEventsRequest.d.ts +8 -1
- package/dist/api/resources/events/types/GetEventSummariesResponse.d.ts +0 -1
- package/dist/api/resources/events/types/ListEventsResponse.d.ts +0 -1
- package/dist/api/resources/features/client/Client.d.ts +31 -7
- package/dist/api/resources/features/client/requests/CountFeaturesRequest.d.ts +11 -1
- package/dist/api/resources/features/client/requests/CountFlagsRequest.d.ts +9 -1
- package/dist/api/resources/features/client/requests/ListFeaturesRequest.d.ts +11 -1
- package/dist/api/resources/features/client/requests/ListFlagsRequest.d.ts +9 -1
- package/dist/api/resources/features/types/CountFeaturesParams.d.ts +1 -0
- package/dist/api/resources/features/types/CountFlagsParams.d.ts +1 -0
- package/dist/api/resources/features/types/ListAudienceCompaniesResponse.d.ts +0 -1
- package/dist/api/resources/features/types/ListAudienceUsersResponse.d.ts +0 -1
- package/dist/api/resources/features/types/ListFeaturesParams.d.ts +1 -0
- package/dist/api/resources/features/types/ListFeaturesResponse.d.ts +0 -1
- package/dist/api/resources/features/types/ListFlagsParams.d.ts +1 -0
- package/dist/api/resources/features/types/ListFlagsResponse.d.ts +0 -1
- package/dist/api/resources/plangroups/client/Client.d.ts +21 -5
- package/dist/api/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts +22 -1
- package/dist/api/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts +22 -1
- package/dist/api/resources/plans/client/Client.d.ts +50 -5
- package/dist/api/resources/plans/client/requests/CountPlansRequest.d.ts +31 -1
- package/dist/api/resources/plans/client/requests/ListPlanIssuesRequest.d.ts +12 -0
- package/dist/api/resources/plans/client/requests/ListPlansRequest.d.ts +31 -1
- package/dist/api/resources/plans/client/requests/index.d.ts +1 -0
- package/dist/api/resources/plans/types/CountPlansParams.d.ts +8 -0
- package/dist/api/resources/plans/types/ListPlanIssuesParams.d.ts +9 -0
- package/dist/api/resources/plans/types/ListPlanIssuesResponse.d.ts +9 -0
- package/dist/api/resources/plans/types/ListPlansParams.d.ts +8 -0
- package/dist/api/resources/plans/types/ListPlansResponse.d.ts +0 -1
- package/dist/api/resources/plans/types/index.d.ts +2 -0
- package/dist/api/resources/webhooks/client/Client.d.ts +25 -7
- package/dist/api/resources/webhooks/client/requests/CountWebhookEventsRequest.d.ts +6 -1
- package/dist/api/resources/webhooks/client/requests/CountWebhooksRequest.d.ts +5 -1
- package/dist/api/resources/webhooks/client/requests/ListWebhookEventsRequest.d.ts +6 -1
- package/dist/api/resources/webhooks/client/requests/ListWebhooksRequest.d.ts +5 -1
- package/dist/api/resources/webhooks/types/CreateWebhookRequestBodyRequestTypesItem.d.ts +3 -1
- package/dist/api/resources/webhooks/types/ListWebhookEventsResponse.d.ts +0 -1
- package/dist/api/resources/webhooks/types/ListWebhooksResponse.d.ts +0 -1
- package/dist/api/resources/webhooks/types/UpdateWebhookRequestBodyRequestTypesItem.d.ts +3 -1
- package/dist/api/types/ApiKeyCreateResponseData.d.ts +0 -3
- package/dist/api/types/ApiKeyRequestResponseData.d.ts +2 -3
- package/dist/api/types/ApiKeyResponseData.d.ts +0 -3
- package/dist/api/types/BillingCreditBundleResponseData.d.ts +1 -0
- package/dist/api/types/BillingCreditBundleView.d.ts +1 -0
- package/dist/api/types/BillingCreditGrantResponseData.d.ts +1 -0
- package/dist/api/types/BillingCreditLedgerResponseData.d.ts +11 -0
- package/dist/api/types/BillingCustomerResponseData.d.ts +0 -3
- package/dist/api/types/BillingPlanCreditGrantResponseData.d.ts +7 -0
- package/dist/api/types/BillingProductDetailResponseData.d.ts +2 -1
- package/dist/api/types/BillingProductForSubscriptionResponseData.d.ts +2 -0
- package/dist/api/types/BillingProductPlanResponseData.d.ts +0 -3
- package/dist/api/types/BillingProductPricing.d.ts +2 -0
- package/dist/api/types/BillingProductResponseData.d.ts +2 -1
- package/dist/api/types/BillingSubscriptionView.d.ts +0 -3
- package/dist/api/types/CheckFlagResponseData.d.ts +0 -3
- package/dist/api/types/CheckFlagsResponseData.d.ts +0 -3
- package/dist/api/types/CheckoutDataResponseData.d.ts +0 -3
- package/dist/api/types/CheckoutSettingsResponseData.d.ts +8 -0
- package/dist/api/types/CheckoutSubscription.d.ts +25 -0
- package/dist/api/types/CompanyDetailResponseData.d.ts +1 -0
- package/dist/api/types/CompanyLedgerResponseData.d.ts +8 -0
- package/dist/api/types/CompanyOverrideNoteResponseData.d.ts +11 -0
- package/dist/api/types/CompanyOverrideResponseData.d.ts +1 -0
- package/dist/api/types/CompanyPlanDetailResponseData.d.ts +1 -0
- package/dist/api/types/CompanyViewWithFeatureUsageResponseData.d.ts +1 -0
- package/dist/api/types/ComponentCheckoutSettings.d.ts +9 -0
- package/dist/api/types/ComponentHydrateResponseData.d.ts +4 -0
- package/dist/api/types/ComponentPreviewResponseData.d.ts +4 -3
- package/dist/api/types/ComponentResponseData.d.ts +0 -3
- package/dist/api/types/Condition.d.ts +21 -0
- package/dist/api/types/ConditionGroup.d.ts +7 -0
- package/dist/api/types/CountResponse.d.ts +2 -4
- package/dist/api/types/CreditCompanyGrantView.d.ts +3 -0
- package/dist/api/types/CreditGrantDetail.d.ts +10 -0
- package/dist/api/types/CreditGrantDetailGrantReason.d.ts +9 -0
- package/dist/api/types/CreditLedgerEnrichedEntryResponseData.d.ts +27 -0
- package/dist/api/types/CreditUsage.d.ts +14 -0
- package/dist/api/types/CreditUsageResponseData.d.ts +14 -0
- package/dist/api/types/CrmDealResponseData.d.ts +0 -3
- package/dist/api/types/CrmLineItemResponseData.d.ts +0 -3
- package/dist/api/types/CrmProductResponseData.d.ts +0 -3
- package/dist/api/types/DataExportResponseData.d.ts +0 -3
- package/dist/api/types/EnvironmentDetailResponseData.d.ts +0 -3
- package/dist/api/types/EnvironmentResponseData.d.ts +0 -3
- package/dist/api/types/FeatureCompanyResponseData.d.ts +34 -1
- package/dist/api/types/FeatureCompanyResponseDataCreditGrantReason.d.ts +12 -0
- package/dist/api/types/FeatureCompanyUserResponseDataAllocationType.d.ts +2 -1
- package/dist/api/types/FeatureLedgerResponseData.d.ts +9 -0
- package/dist/api/types/FeatureUsageDataResponseData.d.ts +8 -0
- package/dist/api/types/FeatureUsageResponseData.d.ts +25 -0
- package/dist/api/types/FeatureUsageResponseDataCreditGrantReason.d.ts +12 -0
- package/dist/api/types/IssueTemporaryAccessTokenResponseData.d.ts +0 -3
- package/dist/api/types/ManagePlanPreviewResponseResponseData.d.ts +7 -0
- package/dist/api/types/ManagePlanRequest.d.ts +15 -0
- package/dist/api/types/ManagePlanResponseResponseData.d.ts +8 -0
- package/dist/api/types/PlanAudienceDetailResponseData.d.ts +0 -3
- package/dist/api/types/PlanCreditGrantView.d.ts +4 -0
- package/dist/api/types/PlanDetailResponseData.d.ts +1 -0
- package/dist/api/types/PlanEntitlementResponseData.d.ts +1 -0
- package/dist/api/types/PlanGroupDetailResponseData.d.ts +16 -3
- package/dist/api/types/PlanGroupPlanDetailResponseData.d.ts +1 -0
- package/dist/api/types/PlanGroupResponseData.d.ts +11 -3
- package/dist/api/types/PlanIssueResponseData.d.ts +9 -0
- package/dist/api/types/PlanSelection.d.ts +7 -0
- package/dist/api/types/PlanTraitResponseData.d.ts +0 -3
- package/dist/api/types/PreviewSubscriptionChangeResponseData.d.ts +0 -3
- package/dist/api/types/PreviewSubscriptionFinanceResponseData.d.ts +3 -0
- package/dist/api/types/RawEventBatchResponseData.d.ts +0 -3
- package/dist/api/types/Rule.d.ts +16 -0
- package/dist/api/types/RulesDetailResponseData.d.ts +0 -3
- package/dist/api/types/SegmentStatusResp.d.ts +0 -3
- package/dist/api/types/TraitDefinition.d.ts +8 -0
- package/dist/api/types/UpdatePlanTraitTraitRequestBody.d.ts +7 -0
- package/dist/api/types/UsageBasedEntitlementRequestBody.d.ts +1 -0
- package/dist/api/types/UsageBasedEntitlementResponseData.d.ts +1 -0
- package/dist/api/types/index.d.ts +24 -0
- package/dist/events.d.ts +1 -0
- package/dist/index.js +3 -3
- package/dist/serialization/resources/billing/client/requests/{CreateBillingSubscriptionsRequestBody.d.ts → CreateBillingSubscriptionRequestBody.d.ts} +5 -4
- package/dist/serialization/resources/billing/client/requests/index.d.ts +1 -1
- package/dist/serialization/resources/billing/types/CreateBillingSubscriptionRequestBodyTrialEndSetting.d.ts +10 -0
- package/dist/serialization/resources/billing/types/SearchBillingPricesParams.d.ts +4 -0
- package/dist/serialization/resources/billing/types/index.d.ts +2 -2
- package/dist/serialization/resources/checkout/types/CheckoutInternalResponse.d.ts +2 -2
- package/dist/serialization/resources/checkout/types/ManagePlanResponse.d.ts +14 -0
- package/dist/serialization/resources/checkout/types/PreviewManagePlanResponse.d.ts +14 -0
- package/dist/serialization/resources/checkout/types/index.d.ts +2 -0
- package/dist/serialization/resources/companies/client/requests/UpdatePlanTraitBulkRequestBody.d.ts +14 -0
- package/dist/serialization/resources/companies/client/requests/index.d.ts +1 -0
- package/dist/serialization/resources/companies/types/CountCompaniesForAdvancedFilterParams.d.ts +1 -0
- package/dist/serialization/resources/companies/types/ListCompaniesForAdvancedFilterParams.d.ts +1 -0
- package/dist/serialization/resources/companies/types/UpdatePlanTraitsBulkResponse.d.ts +14 -0
- package/dist/serialization/resources/companies/types/index.d.ts +1 -0
- package/dist/serialization/resources/credits/client/requests/CreateBillingPlanCreditGrantRequestBody.d.ts +7 -0
- package/dist/serialization/resources/credits/client/requests/CreateCompanyCreditGrant.d.ts +6 -0
- package/dist/serialization/resources/credits/client/requests/CreateCreditBundleRequestBody.d.ts +2 -1
- package/dist/serialization/resources/credits/client/requests/UpdateCreditBundleDetailsRequestBody.d.ts +2 -0
- package/dist/serialization/resources/credits/types/CountCreditLedgerParams.d.ts +20 -0
- package/dist/serialization/resources/credits/types/CountCreditLedgerRequestPeriod.d.ts +10 -0
- package/dist/serialization/resources/credits/types/CountCreditLedgerResponse.d.ts +15 -0
- package/dist/serialization/resources/credits/types/CountCreditLedgerResponseParamsPeriod.d.ts +10 -0
- package/dist/serialization/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyExpiryType.d.ts +10 -0
- package/dist/serialization/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyExpiryUnit.d.ts +10 -0
- package/dist/serialization/resources/credits/types/CreateBillingPlanCreditGrantRequestBodyResetType.d.ts +10 -0
- package/dist/serialization/resources/credits/types/CreateCompanyCreditGrantExpiryType.d.ts +10 -0
- package/dist/serialization/resources/credits/types/CreateCompanyCreditGrantExpiryUnit.d.ts +10 -0
- package/dist/serialization/resources/credits/types/CreateCreditBundleRequestBodyExpiryType.d.ts +1 -1
- package/dist/serialization/resources/credits/types/CreateCreditBundleRequestBodyExpiryUnit.d.ts +10 -0
- package/dist/serialization/resources/credits/types/GetEnrichedCreditLedgerParams.d.ts +20 -0
- package/dist/serialization/resources/credits/types/GetEnrichedCreditLedgerRequestPeriod.d.ts +10 -0
- package/dist/serialization/resources/credits/types/GetEnrichedCreditLedgerResponse.d.ts +15 -0
- package/dist/serialization/resources/credits/types/GetEnrichedCreditLedgerResponseParamsPeriod.d.ts +10 -0
- package/dist/serialization/resources/credits/types/UpdateCreditBundleDetailsRequestBodyExpiryType.d.ts +1 -1
- package/dist/serialization/resources/credits/types/UpdateCreditBundleDetailsRequestBodyExpiryUnit.d.ts +10 -0
- package/dist/serialization/resources/credits/types/ZeroOutGrantRequestBodyReason.d.ts +1 -1
- package/dist/serialization/resources/credits/types/index.d.ts +15 -0
- package/dist/serialization/resources/entitlements/client/requests/CreateCompanyOverrideRequestBody.d.ts +1 -0
- package/dist/serialization/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.d.ts +1 -0
- package/dist/serialization/resources/entitlements/client/requests/UpdateCompanyOverrideRequestBody.d.ts +1 -0
- package/dist/serialization/resources/entitlements/client/requests/UpdatePlanEntitlementRequestBody.d.ts +1 -0
- package/dist/serialization/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts +13 -0
- package/dist/serialization/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts +13 -0
- package/dist/serialization/resources/plans/types/CountPlansParams.d.ts +4 -0
- package/dist/serialization/resources/plans/types/ListPlanIssuesParams.d.ts +12 -0
- package/dist/serialization/resources/plans/types/ListPlanIssuesResponse.d.ts +15 -0
- package/dist/serialization/resources/plans/types/ListPlansParams.d.ts +4 -0
- package/dist/serialization/resources/plans/types/index.d.ts +2 -0
- package/dist/serialization/resources/webhooks/types/CreateWebhookRequestBodyRequestTypesItem.d.ts +1 -1
- package/dist/serialization/resources/webhooks/types/UpdateWebhookRequestBodyRequestTypesItem.d.ts +1 -1
- package/dist/serialization/types/ApiKeyRequestResponseData.d.ts +2 -0
- package/dist/serialization/types/BillingCreditBundleResponseData.d.ts +1 -0
- package/dist/serialization/types/BillingCreditBundleView.d.ts +1 -0
- package/dist/serialization/types/BillingCreditGrantResponseData.d.ts +1 -0
- package/dist/serialization/types/BillingCreditLedgerResponseData.d.ts +17 -0
- package/dist/serialization/types/BillingPlanCreditGrantResponseData.d.ts +7 -0
- package/dist/serialization/types/BillingProductDetailResponseData.d.ts +1 -1
- package/dist/serialization/types/BillingProductForSubscriptionResponseData.d.ts +2 -0
- package/dist/serialization/types/BillingProductPricing.d.ts +2 -0
- package/dist/serialization/types/BillingProductResponseData.d.ts +1 -1
- package/dist/serialization/types/CheckoutSettingsResponseData.d.ts +14 -0
- package/dist/serialization/types/CheckoutSubscription.d.ts +31 -0
- package/dist/serialization/types/CompanyDetailResponseData.d.ts +2 -0
- package/dist/serialization/types/CompanyLedgerResponseData.d.ts +14 -0
- package/dist/serialization/types/CompanyOverrideNoteResponseData.d.ts +17 -0
- package/dist/serialization/types/CompanyOverrideResponseData.d.ts +2 -0
- package/dist/serialization/types/CompanyPlanDetailResponseData.d.ts +2 -0
- package/dist/serialization/types/CompanyViewWithFeatureUsageResponseData.d.ts +2 -0
- package/dist/serialization/types/ComponentCheckoutSettings.d.ts +15 -0
- package/dist/serialization/types/ComponentHydrateResponseData.d.ts +5 -0
- package/dist/serialization/types/ComponentPreviewResponseData.d.ts +5 -0
- package/dist/serialization/types/Condition.d.ts +27 -0
- package/dist/serialization/types/ConditionGroup.d.ts +13 -0
- package/dist/serialization/types/CountResponse.d.ts +1 -1
- package/dist/serialization/types/CreditCompanyGrantView.d.ts +3 -0
- package/dist/serialization/types/CreditGrantDetail.d.ts +16 -0
- package/dist/serialization/types/CreditGrantDetailGrantReason.d.ts +10 -0
- package/dist/serialization/types/CreditLedgerEnrichedEntryResponseData.d.ts +35 -0
- package/dist/serialization/types/CreditUsage.d.ts +20 -0
- package/dist/serialization/types/CreditUsageResponseData.d.ts +20 -0
- package/dist/serialization/types/FeatureCompanyResponseData.d.ts +28 -0
- package/dist/serialization/types/FeatureCompanyResponseDataCreditGrantReason.d.ts +10 -0
- package/dist/serialization/types/FeatureCompanyUserResponseDataAllocationType.d.ts +1 -1
- package/dist/serialization/types/FeatureLedgerResponseData.d.ts +15 -0
- package/dist/serialization/types/FeatureUsageDataResponseData.d.ts +9 -0
- package/dist/serialization/types/FeatureUsageResponseData.d.ts +17 -0
- package/dist/serialization/types/FeatureUsageResponseDataCreditGrantReason.d.ts +10 -0
- package/dist/serialization/types/ManagePlanPreviewResponseResponseData.d.ts +13 -0
- package/dist/serialization/types/ManagePlanRequest.d.ts +23 -0
- package/dist/serialization/types/ManagePlanResponseResponseData.d.ts +14 -0
- package/dist/serialization/types/PlanCreditGrantView.d.ts +4 -0
- package/dist/serialization/types/PlanDetailResponseData.d.ts +2 -0
- package/dist/serialization/types/PlanEntitlementResponseData.d.ts +1 -0
- package/dist/serialization/types/PlanGroupDetailResponseData.d.ts +18 -0
- package/dist/serialization/types/PlanGroupPlanDetailResponseData.d.ts +2 -0
- package/dist/serialization/types/PlanGroupResponseData.d.ts +12 -0
- package/dist/serialization/types/PlanIssueResponseData.d.ts +15 -0
- package/dist/serialization/types/PlanSelection.d.ts +13 -0
- package/dist/serialization/types/PreviewSubscriptionFinanceResponseData.d.ts +3 -0
- package/dist/serialization/types/Rule.d.ts +23 -0
- package/dist/serialization/types/TraitDefinition.d.ts +14 -0
- package/dist/serialization/types/UpdatePlanTraitTraitRequestBody.d.ts +13 -0
- package/dist/serialization/types/UsageBasedEntitlementRequestBody.d.ts +1 -0
- package/dist/serialization/types/UsageBasedEntitlementResponseData.d.ts +1 -0
- package/dist/serialization/types/index.d.ts +24 -0
- package/package.json +1 -1
- package/dist/api/resources/billing/types/CreateBillingSubscriptionsRequestBodyTrialEndSetting.d.ts +0 -8
- package/dist/serialization/resources/billing/types/CreateBillingSubscriptionsRequestBodyTrialEndSetting.d.ts +0 -10
|
@@ -8,13 +8,17 @@ export interface ComponentHydrateResponseData {
|
|
|
8
8
|
activeUsageBasedEntitlements: Schematic.UsageBasedEntitlementResponseData[];
|
|
9
9
|
addOnCompatibilities: Schematic.CompatiblePlans[];
|
|
10
10
|
capabilities?: Schematic.ComponentCapabilities;
|
|
11
|
+
checkoutSettings: Schematic.ComponentCheckoutSettings;
|
|
11
12
|
company?: Schematic.CompanyDetailResponseData;
|
|
12
13
|
component?: Schematic.ComponentResponseData;
|
|
13
14
|
creditBundles: Schematic.BillingCreditBundleView[];
|
|
14
15
|
creditGrants: Schematic.CreditCompanyGrantView[];
|
|
15
16
|
defaultPlan?: Schematic.PlanDetailResponseData;
|
|
16
17
|
featureUsage?: Schematic.FeatureUsageDetailResponseData;
|
|
18
|
+
postTrialPlan?: Schematic.PlanDetailResponseData;
|
|
19
|
+
showCredits: boolean;
|
|
17
20
|
showPeriodToggle: boolean;
|
|
21
|
+
showZeroPriceAsFree: boolean;
|
|
18
22
|
stripeEmbed?: Schematic.StripeEmbedInfo;
|
|
19
23
|
subscription?: Schematic.CompanySubscriptionResponseData;
|
|
20
24
|
trialPaymentMethodRequired?: boolean;
|
|
@@ -2,15 +2,13 @@
|
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
4
|
import * as Schematic from "../index";
|
|
5
|
-
/**
|
|
6
|
-
* The returned resource
|
|
7
|
-
*/
|
|
8
5
|
export interface ComponentPreviewResponseData {
|
|
9
6
|
activeAddOns: Schematic.CompanyPlanDetailResponseData[];
|
|
10
7
|
activePlans: Schematic.CompanyPlanDetailResponseData[];
|
|
11
8
|
activeUsageBasedEntitlements: Schematic.UsageBasedEntitlementResponseData[];
|
|
12
9
|
addOnCompatibilities: Schematic.CompatiblePlans[];
|
|
13
10
|
capabilities?: Schematic.ComponentCapabilities;
|
|
11
|
+
checkoutSettings: Schematic.ComponentCheckoutSettings;
|
|
14
12
|
company?: Schematic.CompanyDetailResponseData;
|
|
15
13
|
component?: Schematic.ComponentResponseData;
|
|
16
14
|
creditBundles: Schematic.BillingCreditBundleView[];
|
|
@@ -18,7 +16,10 @@ export interface ComponentPreviewResponseData {
|
|
|
18
16
|
defaultPlan?: Schematic.PlanDetailResponseData;
|
|
19
17
|
featureUsage?: Schematic.FeatureUsageDetailResponseData;
|
|
20
18
|
invoices: Schematic.InvoiceResponseData[];
|
|
19
|
+
postTrialPlan?: Schematic.PlanDetailResponseData;
|
|
20
|
+
showCredits: boolean;
|
|
21
21
|
showPeriodToggle: boolean;
|
|
22
|
+
showZeroPriceAsFree: boolean;
|
|
22
23
|
stripeEmbed?: Schematic.StripeEmbedInfo;
|
|
23
24
|
subscription?: Schematic.CompanySubscriptionResponseData;
|
|
24
25
|
trialPaymentMethodRequired?: boolean;
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as Schematic from "../index";
|
|
5
|
+
export interface Condition {
|
|
6
|
+
accountId: string;
|
|
7
|
+
comparisonTraitDefinition?: Schematic.TraitDefinition;
|
|
8
|
+
conditionType: string;
|
|
9
|
+
consumptionRate?: number;
|
|
10
|
+
creditId?: string;
|
|
11
|
+
environmentId: string;
|
|
12
|
+
eventSubtype?: string;
|
|
13
|
+
id: string;
|
|
14
|
+
metricPeriod?: string;
|
|
15
|
+
metricPeriodMonthReset?: string;
|
|
16
|
+
metricValue?: number;
|
|
17
|
+
operator: string;
|
|
18
|
+
resourceIds: string[];
|
|
19
|
+
traitDefinition?: Schematic.TraitDefinition;
|
|
20
|
+
traitValue: string;
|
|
21
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as Schematic from "../index";
|
|
5
|
+
export interface CreditGrantDetail {
|
|
6
|
+
creditTypeIcon?: string;
|
|
7
|
+
expiresAt?: Date;
|
|
8
|
+
grantReason: Schematic.CreditGrantDetailGrantReason;
|
|
9
|
+
quantity: number;
|
|
10
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
export type CreditGrantDetailGrantReason = "free" | "plan" | "purchased";
|
|
5
|
+
export declare const CreditGrantDetailGrantReason: {
|
|
6
|
+
readonly Free: "free";
|
|
7
|
+
readonly Plan: "plan";
|
|
8
|
+
readonly Purchased: "purchased";
|
|
9
|
+
};
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as Schematic from "../index";
|
|
5
|
+
export interface CreditLedgerEnrichedEntryResponseData {
|
|
6
|
+
billingCreditId: string;
|
|
7
|
+
company?: Schematic.CompanyLedgerResponseData;
|
|
8
|
+
companyId: string;
|
|
9
|
+
credit?: Schematic.BillingCreditLedgerResponseData;
|
|
10
|
+
expiredGrantCount: number;
|
|
11
|
+
feature?: Schematic.FeatureLedgerResponseData;
|
|
12
|
+
featureId?: string;
|
|
13
|
+
firstTransactionAt: Date;
|
|
14
|
+
freeGrantCount: number;
|
|
15
|
+
grantCount: number;
|
|
16
|
+
lastTransactionAt: Date;
|
|
17
|
+
manuallyZeroedCount: number;
|
|
18
|
+
netChange: number;
|
|
19
|
+
planGrantCount: number;
|
|
20
|
+
purchasedGrantCount: number;
|
|
21
|
+
timeBucket: Date;
|
|
22
|
+
totalConsumed: number;
|
|
23
|
+
totalGranted: number;
|
|
24
|
+
transactionCount: number;
|
|
25
|
+
usageCount: number;
|
|
26
|
+
zeroedOutCount: number;
|
|
27
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as Schematic from "../index";
|
|
5
|
+
export interface CreditUsage {
|
|
6
|
+
creditConsumptionRate?: number;
|
|
7
|
+
creditGrantCounts?: Record<string, number>;
|
|
8
|
+
creditGrantDetails?: Schematic.CreditGrantDetail[];
|
|
9
|
+
creditRemaining?: number;
|
|
10
|
+
creditTotal?: number;
|
|
11
|
+
creditTypeIcon?: string;
|
|
12
|
+
creditTypeName?: string;
|
|
13
|
+
creditUsed?: number;
|
|
14
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as Schematic from "../index";
|
|
5
|
+
export interface CreditUsageResponseData {
|
|
6
|
+
creditConsumptionRate?: number;
|
|
7
|
+
creditGrantCounts?: Record<string, number>;
|
|
8
|
+
creditGrantDetails: Schematic.CreditGrantDetail[];
|
|
9
|
+
creditRemaining?: number;
|
|
10
|
+
creditTotal?: number;
|
|
11
|
+
creditTypeIcon?: string;
|
|
12
|
+
creditTypeName?: string;
|
|
13
|
+
creditUsed?: number;
|
|
14
|
+
}
|
|
@@ -10,17 +10,50 @@ export interface FeatureCompanyResponseData {
|
|
|
10
10
|
/** The type of allocation that is being used. */
|
|
11
11
|
allocationType: Schematic.FeatureCompanyResponseDataAllocationType;
|
|
12
12
|
company?: Schematic.CompanyDetailResponseData;
|
|
13
|
+
companyOverride?: Schematic.CompanyOverrideResponseData;
|
|
14
|
+
/** The rate at which credits are consumed per unit of usage */
|
|
15
|
+
creditConsumptionRate?: number;
|
|
16
|
+
creditGrantCounts?: Record<string, number>;
|
|
17
|
+
creditGrantDetails?: Schematic.CreditGrantDetail[];
|
|
18
|
+
/** Reason for the credit grant */
|
|
19
|
+
creditGrantReason?: Schematic.FeatureCompanyResponseDataCreditGrantReason;
|
|
20
|
+
creditRemaining?: number;
|
|
21
|
+
creditTotal?: number;
|
|
22
|
+
/** Icon identifier for the credit type */
|
|
23
|
+
creditTypeIcon?: string;
|
|
24
|
+
creditUsage?: Schematic.CreditUsage;
|
|
25
|
+
creditUsed?: number;
|
|
26
|
+
/** Effective limit for usage calculations. For overage pricing, this is the soft limit where overage charges begin. For tiered pricing, this is the first tier boundary. For other pricing models, this is the base allocation. Used to calculate usage percentages and determine access thresholds. */
|
|
27
|
+
effectiveLimit?: number;
|
|
28
|
+
/** Per-unit price for current usage scenario */
|
|
29
|
+
effectivePrice?: number;
|
|
13
30
|
entitlementExpirationDate?: Date;
|
|
14
31
|
entitlementId: string;
|
|
32
|
+
/** Source of the entitlement (plan or company_override) */
|
|
33
|
+
entitlementSource?: string;
|
|
15
34
|
entitlementType: string;
|
|
16
35
|
feature?: Schematic.FeatureDetailResponseData;
|
|
17
|
-
/**
|
|
36
|
+
/** Whether a valid allocation exists */
|
|
37
|
+
hasValidAllocation?: boolean;
|
|
38
|
+
/** Whether this is an unlimited allocation */
|
|
39
|
+
isUnlimited?: boolean;
|
|
40
|
+
/** The time at which the metric will reset. */
|
|
18
41
|
metricResetAt?: Date;
|
|
19
42
|
/** If the period is current_month, when the month resets. */
|
|
20
43
|
monthReset?: string;
|
|
44
|
+
monthlyUsageBasedPrice?: Schematic.BillingPriceView;
|
|
45
|
+
/** Amount of usage exceeding soft limit (overage pricing only) */
|
|
46
|
+
overuse?: number;
|
|
47
|
+
/** Percentage of allocation consumed (0-100+) */
|
|
48
|
+
percentUsed?: number;
|
|
21
49
|
/** The period over which usage is measured. */
|
|
22
50
|
period?: string;
|
|
23
51
|
plan?: Schematic.PlanResponseData;
|
|
52
|
+
planEntitlement?: Schematic.PlanEntitlementResponseData;
|
|
53
|
+
priceBehavior?: string;
|
|
54
|
+
/** The soft limit for the feature usage. Available only for overage price behavior */
|
|
55
|
+
softLimit?: number;
|
|
24
56
|
/** The amount of usage that has been consumed; a null value indicates that usage is not being measured. */
|
|
25
57
|
usage?: number;
|
|
58
|
+
yearlyUsageBasedPrice?: Schematic.BillingPriceView;
|
|
26
59
|
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* Reason for the credit grant
|
|
6
|
+
*/
|
|
7
|
+
export type FeatureCompanyResponseDataCreditGrantReason = "free" | "plan" | "purchased";
|
|
8
|
+
export declare const FeatureCompanyResponseDataCreditGrantReason: {
|
|
9
|
+
readonly Free: "free";
|
|
10
|
+
readonly Plan: "plan";
|
|
11
|
+
readonly Purchased: "purchased";
|
|
12
|
+
};
|
|
@@ -4,10 +4,11 @@
|
|
|
4
4
|
/**
|
|
5
5
|
* The type of allocation that is being used.
|
|
6
6
|
*/
|
|
7
|
-
export type FeatureCompanyUserResponseDataAllocationType = "boolean" | "numeric" | "trait" | "unlimited";
|
|
7
|
+
export type FeatureCompanyUserResponseDataAllocationType = "boolean" | "numeric" | "trait" | "unlimited" | "unknown";
|
|
8
8
|
export declare const FeatureCompanyUserResponseDataAllocationType: {
|
|
9
9
|
readonly Boolean: "boolean";
|
|
10
10
|
readonly Numeric: "numeric";
|
|
11
11
|
readonly Trait: "trait";
|
|
12
12
|
readonly Unlimited: "unlimited";
|
|
13
|
+
readonly Unknown: "unknown";
|
|
13
14
|
};
|
|
@@ -1,7 +1,10 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
|
+
import * as Schematic from "../index";
|
|
4
5
|
export interface FeatureUsageDataResponseData {
|
|
6
|
+
creditTypeId?: string;
|
|
7
|
+
creditUsage?: Schematic.CreditUsageResponseData;
|
|
5
8
|
entitlementSource: string;
|
|
6
9
|
entitlementValueType: string;
|
|
7
10
|
featureId: string;
|
|
@@ -9,6 +12,11 @@ export interface FeatureUsageDataResponseData {
|
|
|
9
12
|
featureType: string;
|
|
10
13
|
hardLimit: string;
|
|
11
14
|
hasAccess: boolean;
|
|
15
|
+
metricResetAt?: Date;
|
|
16
|
+
monthlyUsageBasedPrice?: Schematic.BillingPriceView;
|
|
17
|
+
priceBehavior?: string;
|
|
12
18
|
softLimit: string;
|
|
13
19
|
usage: string;
|
|
20
|
+
valueNumeric?: number;
|
|
21
|
+
yearlyUsageBasedPrice?: Schematic.BillingPriceView;
|
|
14
22
|
}
|
|
@@ -10,15 +10,40 @@ export interface FeatureUsageResponseData {
|
|
|
10
10
|
/** The type of allocation that is being used. */
|
|
11
11
|
allocationType: Schematic.FeatureUsageResponseDataAllocationType;
|
|
12
12
|
companyOverride?: Schematic.CompanyOverrideResponseData;
|
|
13
|
+
/** The rate at which credits are consumed per unit of usage */
|
|
14
|
+
creditConsumptionRate?: number;
|
|
15
|
+
creditGrantCounts?: Record<string, number>;
|
|
16
|
+
creditGrantDetails?: Schematic.CreditGrantDetail[];
|
|
17
|
+
/** Reason for the credit grant */
|
|
18
|
+
creditGrantReason?: Schematic.FeatureUsageResponseDataCreditGrantReason;
|
|
19
|
+
creditRemaining?: number;
|
|
20
|
+
creditTotal?: number;
|
|
21
|
+
/** Icon identifier for the credit type */
|
|
22
|
+
creditTypeIcon?: string;
|
|
23
|
+
creditUsed?: number;
|
|
24
|
+
/** Effective limit for usage calculations. For overage pricing, this is the soft limit where overage charges begin. For tiered pricing, this is the first tier boundary. For other pricing models, this is the base allocation. Used to calculate usage percentages and determine access thresholds. */
|
|
25
|
+
effectiveLimit?: number;
|
|
26
|
+
/** Per-unit price for current usage scenario */
|
|
27
|
+
effectivePrice?: number;
|
|
13
28
|
entitlementExpirationDate?: Date;
|
|
14
29
|
entitlementId: string;
|
|
30
|
+
/** Source of the entitlement (plan or company_override) */
|
|
31
|
+
entitlementSource?: string;
|
|
15
32
|
entitlementType: string;
|
|
16
33
|
feature?: Schematic.FeatureDetailResponseData;
|
|
34
|
+
/** Whether a valid allocation exists */
|
|
35
|
+
hasValidAllocation?: boolean;
|
|
36
|
+
/** Whether this is an unlimited allocation */
|
|
37
|
+
isUnlimited?: boolean;
|
|
17
38
|
/** The time at which the metric will reset. */
|
|
18
39
|
metricResetAt?: Date;
|
|
19
40
|
/** If the period is current_month, when the month resets. */
|
|
20
41
|
monthReset?: string;
|
|
21
42
|
monthlyUsageBasedPrice?: Schematic.BillingPriceView;
|
|
43
|
+
/** Amount of usage exceeding soft limit (overage pricing only) */
|
|
44
|
+
overuse?: number;
|
|
45
|
+
/** Percentage of allocation consumed (0-100+) */
|
|
46
|
+
percentUsed?: number;
|
|
22
47
|
/** The period over which usage is measured. */
|
|
23
48
|
period?: string;
|
|
24
49
|
plan?: Schematic.PlanResponseData;
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* Reason for the credit grant
|
|
6
|
+
*/
|
|
7
|
+
export type FeatureUsageResponseDataCreditGrantReason = "free" | "plan" | "purchased";
|
|
8
|
+
export declare const FeatureUsageResponseDataCreditGrantReason: {
|
|
9
|
+
readonly Free: "free";
|
|
10
|
+
readonly Plan: "plan";
|
|
11
|
+
readonly Purchased: "purchased";
|
|
12
|
+
};
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as Schematic from "../index";
|
|
5
|
+
export interface ManagePlanRequest {
|
|
6
|
+
addOnSelections: Schematic.PlanSelection[];
|
|
7
|
+
basePlanId?: string;
|
|
8
|
+
basePlanPriceId?: string;
|
|
9
|
+
companyId: string;
|
|
10
|
+
couponExternalId?: string;
|
|
11
|
+
creditBundles: Schematic.UpdateCreditBundleRequestBody[];
|
|
12
|
+
payInAdvanceEntitlements: Schematic.UpdatePayInAdvanceRequestBody[];
|
|
13
|
+
paymentMethodExternalId?: string;
|
|
14
|
+
promoCode?: string;
|
|
15
|
+
}
|
|
@@ -2,9 +2,6 @@
|
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
4
|
import * as Schematic from "../index";
|
|
5
|
-
/**
|
|
6
|
-
* The updated resource
|
|
7
|
-
*/
|
|
8
5
|
export interface PlanAudienceDetailResponseData {
|
|
9
6
|
conditionGroups: Schematic.RuleConditionGroupDetailResponseData[];
|
|
10
7
|
conditions: Schematic.RuleConditionDetailResponseData[];
|
|
@@ -8,12 +8,16 @@ export interface PlanCreditGrantView {
|
|
|
8
8
|
creditIcon?: string;
|
|
9
9
|
creditId: string;
|
|
10
10
|
creditName: string;
|
|
11
|
+
expiryType?: string;
|
|
12
|
+
expiryUnit?: string;
|
|
13
|
+
expiryUnitCount?: number;
|
|
11
14
|
id: string;
|
|
12
15
|
planId: string;
|
|
13
16
|
planName: string;
|
|
14
17
|
pluralName?: string;
|
|
15
18
|
resetCadence: string;
|
|
16
19
|
resetStart: string;
|
|
20
|
+
resetType: string;
|
|
17
21
|
singularName?: string;
|
|
18
22
|
updatedAt: Date;
|
|
19
23
|
}
|
|
@@ -13,6 +13,7 @@ export interface PlanDetailResponseData {
|
|
|
13
13
|
features: Schematic.FeatureDetailResponseData[];
|
|
14
14
|
icon: string;
|
|
15
15
|
id: string;
|
|
16
|
+
includedCreditGrants?: Schematic.BillingPlanCreditGrantResponseData[];
|
|
16
17
|
isDefault: boolean;
|
|
17
18
|
isFree: boolean;
|
|
18
19
|
isTrialable: boolean;
|
|
@@ -2,21 +2,34 @@
|
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
4
|
import * as Schematic from "../index";
|
|
5
|
-
/**
|
|
6
|
-
* The returned resource
|
|
7
|
-
*/
|
|
8
5
|
export interface PlanGroupDetailResponseData {
|
|
9
6
|
addOns: Schematic.PlanGroupPlanDetailResponseData[];
|
|
7
|
+
checkoutSettings: Schematic.CheckoutSettingsResponseData;
|
|
10
8
|
customPlanConfig?: Schematic.CustomPlanViewConfigResponseData;
|
|
11
9
|
customPlanId?: string;
|
|
12
10
|
defaultPlan?: Schematic.PlanGroupPlanDetailResponseData;
|
|
13
11
|
defaultPlanId?: string;
|
|
12
|
+
fallbackPlan?: Schematic.PlanGroupPlanDetailResponseData;
|
|
13
|
+
fallbackPlanId?: string;
|
|
14
14
|
id: string;
|
|
15
|
+
initialPlan?: Schematic.PlanGroupPlanDetailResponseData;
|
|
16
|
+
initialPlanId?: string;
|
|
17
|
+
initialPlanPrice?: Schematic.BillingPriceResponseData;
|
|
18
|
+
initialPlanPriceId?: string;
|
|
15
19
|
orderedAddOnList: Schematic.PlanGroupPlanEntitlementsOrder[];
|
|
16
20
|
orderedBundleList: Schematic.PlanGroupBundleOrder[];
|
|
17
21
|
orderedPlanList: Schematic.PlanGroupPlanEntitlementsOrder[];
|
|
18
22
|
plans: Schematic.PlanGroupPlanDetailResponseData[];
|
|
23
|
+
preventDowngradesWhenOverLimit: boolean;
|
|
24
|
+
showCredits: boolean;
|
|
19
25
|
showPeriodToggle: boolean;
|
|
26
|
+
showZeroPriceAsFree: boolean;
|
|
27
|
+
syncCustomerBillingDetailsForTax: boolean;
|
|
28
|
+
taxCollectionEnabled: boolean;
|
|
20
29
|
trialDays?: number;
|
|
30
|
+
trialExpiryPlan?: Schematic.PlanGroupPlanDetailResponseData;
|
|
31
|
+
trialExpiryPlanId?: string;
|
|
32
|
+
trialExpiryPlanPrice?: Schematic.BillingPriceResponseData;
|
|
33
|
+
trialExpiryPlanPriceId?: string;
|
|
21
34
|
trialPaymentMethodRequired?: boolean;
|
|
22
35
|
}
|
|
@@ -16,6 +16,7 @@ export interface PlanGroupPlanDetailResponseData {
|
|
|
16
16
|
features: Schematic.FeatureDetailResponseData[];
|
|
17
17
|
icon: string;
|
|
18
18
|
id: string;
|
|
19
|
+
includedCreditGrants?: Schematic.BillingPlanCreditGrantResponseData[];
|
|
19
20
|
isCustom: boolean;
|
|
20
21
|
isDefault: boolean;
|
|
21
22
|
isFree: boolean;
|
|
@@ -2,17 +2,25 @@
|
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
4
|
import * as Schematic from "../index";
|
|
5
|
-
/**
|
|
6
|
-
* The updated resource
|
|
7
|
-
*/
|
|
8
5
|
export interface PlanGroupResponseData {
|
|
9
6
|
addOnCompatibilities: Schematic.CompatiblePlansResponseData[];
|
|
10
7
|
addOnIds: string[];
|
|
8
|
+
checkoutSettings: Schematic.CheckoutSettingsResponseData;
|
|
11
9
|
defaultPlanId?: string;
|
|
10
|
+
fallbackPlanId?: string;
|
|
12
11
|
id: string;
|
|
12
|
+
initialPlanId?: string;
|
|
13
|
+
initialPlanPriceId?: string;
|
|
13
14
|
orderedAddOnIds: Schematic.OrderedPlansInGroup[];
|
|
14
15
|
planIds: Schematic.OrderedPlansInGroup[];
|
|
16
|
+
preventDowngradesWhenOverLimit: boolean;
|
|
17
|
+
showCredits: boolean;
|
|
15
18
|
showPeriodToggle: boolean;
|
|
19
|
+
showZeroPriceAsFree: boolean;
|
|
20
|
+
syncCustomerBillingDetailsForTax: boolean;
|
|
21
|
+
taxCollectionEnabled: boolean;
|
|
16
22
|
trialDays?: number;
|
|
23
|
+
trialExpiryPlanId?: string;
|
|
24
|
+
trialExpiryPlanPriceId?: string;
|
|
17
25
|
trialPaymentMethodRequired?: boolean;
|
|
18
26
|
}
|