@schematichq/schematic-typescript-node 1.3.1 → 1.4.0
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 +36 -2
- package/dist/Client.d.ts +9 -0
- package/dist/api/resources/accounts/client/Client.d.ts +33 -16
- package/dist/api/resources/accounts/client/requests/CountAuditLogsRequest.d.ts +24 -0
- package/dist/api/resources/accounts/client/requests/CreateApiKeyRequestBody.d.ts +1 -0
- package/dist/api/resources/accounts/client/requests/ListAuditLogsRequest.d.ts +24 -0
- package/dist/api/resources/accounts/client/requests/index.d.ts +2 -2
- package/dist/api/resources/accounts/types/{ListApiRequestsParams.d.ts → CountAuditLogsParams.d.ts} +5 -2
- package/dist/api/resources/accounts/types/{CountApiRequestsResponse.d.ts → CountAuditLogsResponse.d.ts} +2 -2
- package/dist/api/resources/accounts/types/{GetApiRequestResponse.d.ts → GetAuditLogResponse.d.ts} +2 -2
- package/dist/api/resources/accounts/types/GetWhoAmIResponse.d.ts +6 -0
- package/dist/api/resources/accounts/types/{CountApiRequestsParams.d.ts → ListAuditLogsParams.d.ts} +5 -2
- package/dist/api/resources/accounts/types/ListAuditLogsResponse.d.ts +6 -0
- package/dist/api/resources/accounts/types/index.d.ts +6 -5
- package/dist/api/resources/billing/client/requests/CreateInvoiceRequestBody.d.ts +2 -0
- package/dist/api/resources/companies/client/Client.d.ts +12 -48
- package/dist/api/resources/companies/client/requests/CountCompaniesRequest.d.ts +27 -0
- package/dist/api/resources/companies/client/requests/ListCompaniesRequest.d.ts +27 -0
- package/dist/api/resources/companies/client/requests/index.d.ts +0 -2
- package/dist/api/resources/companies/types/CountCompaniesParams.d.ts +21 -0
- package/dist/api/resources/companies/types/ListCompaniesParams.d.ts +21 -0
- package/dist/api/resources/companies/types/index.d.ts +0 -4
- package/dist/api/resources/componentspublic/client/Client.d.ts +26 -0
- package/dist/api/resources/componentspublic/client/index.d.ts +1 -0
- package/dist/api/resources/componentspublic/index.d.ts +2 -0
- package/dist/api/resources/componentspublic/types/GetPublicPlansResponse.d.ts +6 -0
- package/dist/api/resources/componentspublic/types/index.d.ts +1 -0
- package/dist/api/resources/credits/client/Client.d.ts +50 -0
- package/dist/api/resources/credits/client/requests/CountBillingPlanCreditGrantsRequest.d.ts +3 -1
- package/dist/api/resources/credits/client/requests/CountCreditEventLedgerRequest.d.ts +26 -0
- package/dist/api/resources/credits/client/requests/ListBillingPlanCreditGrantsRequest.d.ts +3 -1
- package/dist/api/resources/credits/client/requests/ListCreditEventLedgerRequest.d.ts +26 -0
- package/dist/api/resources/credits/client/requests/index.d.ts +2 -0
- package/dist/api/resources/credits/types/CountBillingPlanCreditGrantsParams.d.ts +1 -0
- package/dist/api/resources/credits/types/CountCreditEventLedgerParams.d.ts +16 -0
- package/dist/api/resources/credits/types/CountCreditEventLedgerResponse.d.ts +6 -0
- package/dist/api/resources/credits/types/ListBillingPlanCreditGrantsParams.d.ts +1 -0
- package/dist/api/resources/credits/types/ListCreditEventLedgerParams.d.ts +16 -0
- package/dist/api/resources/credits/types/ListCreditEventLedgerResponse.d.ts +6 -0
- package/dist/api/resources/credits/types/index.d.ts +4 -0
- package/dist/api/resources/entitlements/client/Client.d.ts +22 -0
- package/dist/api/resources/entitlements/client/requests/CountPlanEntitlementsRequest.d.ts +5 -0
- package/dist/api/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.d.ts +1 -0
- package/dist/api/resources/entitlements/client/requests/GetFeatureUsageTimeSeriesRequest.d.ts +18 -0
- package/dist/api/resources/entitlements/client/requests/ListPlanEntitlementsRequest.d.ts +5 -0
- package/dist/api/resources/entitlements/client/requests/index.d.ts +1 -0
- package/dist/api/resources/entitlements/types/CountPlanEntitlementsParams.d.ts +4 -0
- package/dist/api/resources/entitlements/types/GetFeatureUsageTimeSeriesParams.d.ts +11 -0
- package/dist/api/resources/entitlements/types/GetFeatureUsageTimeSeriesResponse.d.ts +6 -0
- package/dist/api/resources/entitlements/types/ListPlanEntitlementsParams.d.ts +4 -0
- package/dist/api/resources/entitlements/types/index.d.ts +2 -0
- package/dist/api/resources/features/client/Client.d.ts +2 -0
- package/dist/api/resources/features/client/requests/CountFeaturesRequest.d.ts +3 -0
- package/dist/api/resources/features/client/requests/ListFeaturesRequest.d.ts +3 -0
- 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 +8 -0
- package/dist/api/resources/planbundle/client/requests/UpdatePlanBundleRequestBody.d.ts +1 -0
- package/dist/api/resources/plangroups/client/Client.d.ts +4 -0
- package/dist/api/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts +6 -0
- package/dist/api/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts +6 -0
- package/dist/api/resources/planmigrations/client/Client.d.ts +109 -0
- package/dist/api/resources/planmigrations/client/index.d.ts +1 -0
- package/dist/api/resources/planmigrations/client/requests/CountCompanyMigrationsRequest.d.ts +20 -0
- package/dist/api/resources/planmigrations/client/requests/CountMigrationsRequest.d.ts +18 -0
- package/dist/api/resources/planmigrations/client/requests/ListCompanyMigrationsRequest.d.ts +20 -0
- package/dist/api/resources/planmigrations/client/requests/ListMigrationsRequest.d.ts +18 -0
- package/dist/api/resources/planmigrations/client/requests/index.d.ts +4 -0
- package/dist/api/resources/planmigrations/index.d.ts +2 -0
- package/dist/api/resources/planmigrations/types/CountCompanyMigrationsParams.d.ts +13 -0
- package/dist/api/resources/planmigrations/types/CountCompanyMigrationsResponse.d.ts +6 -0
- package/dist/api/resources/planmigrations/types/CountMigrationsParams.d.ts +12 -0
- package/dist/api/resources/planmigrations/types/CountMigrationsResponse.d.ts +6 -0
- package/dist/api/resources/planmigrations/types/GetMigrationResponse.d.ts +6 -0
- package/dist/api/resources/planmigrations/types/ListCompanyMigrationsParams.d.ts +13 -0
- package/dist/api/resources/planmigrations/types/ListCompanyMigrationsResponse.d.ts +6 -0
- package/dist/api/resources/planmigrations/types/ListMigrationsParams.d.ts +12 -0
- package/dist/api/resources/planmigrations/types/ListMigrationsResponse.d.ts +6 -0
- package/dist/api/resources/planmigrations/types/index.d.ts +9 -0
- package/dist/api/resources/plans/client/Client.d.ts +41 -3
- package/dist/api/resources/plans/client/requests/GetPlanRequest.d.ts +10 -0
- package/dist/api/resources/plans/client/requests/ListPlanIssuesRequest.d.ts +3 -1
- package/dist/api/resources/plans/client/requests/PublishPlanVersionRequestBody.d.ts +12 -0
- package/dist/api/resources/plans/client/requests/index.d.ts +2 -0
- package/dist/api/resources/plans/types/CountPlansParams.d.ts +1 -0
- package/dist/api/resources/plans/types/DeletePlanVersionResponse.d.ts +6 -0
- package/dist/api/resources/plans/types/GetPlanParams.d.ts +7 -0
- package/dist/api/resources/plans/types/GetPlanResponse.d.ts +1 -1
- package/dist/api/resources/plans/types/ListPlanIssuesParams.d.ts +1 -0
- package/dist/api/resources/plans/types/ListPlansParams.d.ts +1 -0
- package/dist/api/resources/plans/types/PublishPlanVersionResponse.d.ts +6 -0
- package/dist/api/resources/plans/types/index.d.ts +3 -0
- package/dist/api/resources/scheduledcheckout/client/Client.d.ts +83 -0
- package/dist/api/resources/scheduledcheckout/client/index.d.ts +1 -0
- package/dist/api/resources/scheduledcheckout/client/requests/CreateScheduledCheckoutRequest.d.ts +15 -0
- package/dist/api/resources/scheduledcheckout/client/requests/ListScheduledCheckoutsRequest.d.ts +18 -0
- package/dist/api/resources/scheduledcheckout/client/requests/UpdateScheduledCheckoutRequest.d.ts +9 -0
- package/dist/api/resources/scheduledcheckout/client/requests/index.d.ts +3 -0
- package/dist/api/resources/scheduledcheckout/index.d.ts +2 -0
- package/dist/api/resources/scheduledcheckout/types/CreateScheduledCheckoutResponse.d.ts +6 -0
- package/dist/api/resources/scheduledcheckout/types/GetScheduledCheckoutResponse.d.ts +6 -0
- package/dist/api/resources/scheduledcheckout/types/ListScheduledCheckoutsParams.d.ts +12 -0
- package/dist/api/resources/scheduledcheckout/types/ListScheduledCheckoutsResponse.d.ts +6 -0
- package/dist/api/resources/scheduledcheckout/types/UpdateScheduledCheckoutResponse.d.ts +6 -0
- package/dist/api/resources/scheduledcheckout/types/index.d.ts +5 -0
- package/dist/api/types/{PlanChangeActorType.d.ts → ActorType.d.ts} +3 -2
- package/dist/api/types/ApiKeyCreateResponseData.d.ts +1 -0
- package/dist/api/types/ApiKeyResponseData.d.ts +1 -0
- package/dist/api/types/{ApiKeyRequestListResponseData.d.ts → AuditLogListResponseData.d.ts} +4 -4
- package/dist/api/types/{ApiKeyRequestResponseData.d.ts → AuditLogResponseData.d.ts} +3 -5
- package/dist/api/types/BillingCreditResponseData.d.ts +1 -0
- package/dist/api/types/BillingCreditView.d.ts +22 -0
- package/dist/api/types/BillingPlanCreditGrantResponseData.d.ts +9 -2
- package/dist/api/types/CheckFlagResponseData.d.ts +8 -5
- package/dist/api/types/CompanyDetailResponseData.d.ts +2 -0
- package/dist/api/types/CompanyPlanDetailResponseData.d.ts +2 -0
- package/dist/api/types/ComponentDisplaySettings.d.ts +2 -0
- package/dist/api/types/ComponentHydrateResponseData.d.ts +1 -0
- package/dist/api/types/ComponentPreviewResponseData.d.ts +1 -0
- package/dist/api/types/ComponentSettingsResponseData.d.ts +2 -0
- package/dist/api/types/ConditionConditionType.d.ts +1 -1
- package/dist/api/types/ConditionGroupResponseData.d.ts +10 -0
- package/dist/api/types/ConditionGroupView.d.ts +12 -0
- package/dist/api/types/ConditionResponseData.d.ts +28 -0
- package/dist/api/types/ConditionView.d.ts +35 -0
- package/dist/api/types/CreateBillingPlanCreditGrantRequestBody.d.ts +1 -0
- package/dist/api/types/CreateEntitlementInBundleRequestBody.d.ts +2 -0
- package/dist/api/types/CreateEventRequestBody.d.ts +1 -0
- package/dist/api/types/CreditEventLedgerResponseData.d.ts +34 -0
- package/dist/api/types/CreditEventType.d.ts +7 -0
- package/dist/api/types/CreditsAutoTopupCompanySummary.d.ts +4 -0
- package/dist/api/types/CreditsAutoTopupCreditSummary.d.ts +4 -0
- package/dist/api/types/CreditsAutoTopupHardFailure.d.ts +7 -0
- package/dist/api/types/CreditsAutoTopupRetryFailure.d.ts +8 -0
- package/dist/api/types/FeatureCompanyResponseData.d.ts +3 -0
- package/dist/api/types/FeatureCompanyUserResponseData.d.ts +1 -0
- package/dist/api/types/FeatureEntitlement.d.ts +31 -0
- package/dist/api/types/FeatureEntitlementMetricPeriod.d.ts +8 -0
- package/dist/api/types/FeatureEntitlementMonthReset.d.ts +6 -0
- package/dist/api/types/FeatureUsageLegacyResponseData.d.ts +9 -0
- package/dist/api/types/FeatureUsageResponseData.d.ts +3 -0
- package/dist/api/types/FeatureUsageTimeSeriesResponseData.d.ts +8 -0
- package/dist/api/types/FeatureView.d.ts +21 -0
- package/dist/api/types/FlagView.d.ts +17 -0
- package/dist/api/types/InvoiceRequestBody.d.ts +2 -0
- package/dist/api/types/InvoiceResponseData.d.ts +1 -0
- package/dist/api/types/InvoiceStatus.d.ts +8 -0
- package/dist/api/types/LimitTimeSeriesPointResponseData.d.ts +9 -0
- package/dist/api/types/PlanChangeAction.d.ts +1 -0
- package/dist/api/types/PlanChangeResponseData.d.ts +4 -2
- package/dist/api/types/PlanCreditGrantView.d.ts +10 -3
- package/dist/api/types/PlanDetailResponseData.d.ts +2 -0
- package/dist/api/types/PlanGroupDetailResponseData.d.ts +2 -0
- package/dist/api/types/PlanGroupPlanDetailResponseData.d.ts +2 -0
- package/dist/api/types/PlanGroupResponseData.d.ts +2 -0
- package/dist/api/types/PlanVersionCompanyMigrationResponseData.d.ts +14 -0
- package/dist/api/types/PlanVersionCompanyMigrationStatus.d.ts +8 -0
- package/dist/api/types/PlanVersionMigrationResponseData.d.ts +18 -0
- package/dist/api/types/PlanVersionMigrationStatus.d.ts +7 -0
- package/dist/api/types/PlanVersionMigrationStrategy.d.ts +5 -0
- package/dist/api/types/PlanViewPublicResponseData.d.ts +32 -0
- package/dist/api/types/PreviewSubscriptionChangeResponseData.d.ts +2 -0
- package/dist/api/types/PublicPlansResponseData.d.ts +12 -0
- package/dist/api/types/RuleView.d.ts +16 -0
- package/dist/api/types/RulesEngineSchemaVersion.d.ts +1 -1
- package/dist/api/types/RulesengineCheckFlagResult.d.ts +1 -0
- package/dist/api/types/RulesengineCompany.d.ts +2 -1
- package/dist/api/types/RulesengineConditionConditionType.d.ts +1 -1
- package/dist/api/types/RulesengineEntitlementValueType.d.ts +9 -0
- package/dist/api/types/RulesengineFeatureEntitlement.d.ts +31 -0
- package/dist/api/types/RulesengineFeatureEntitlementMetricPeriod.d.ts +8 -0
- package/dist/api/types/RulesengineFeatureEntitlementMonthReset.d.ts +6 -0
- package/dist/api/types/ScheduledCheckoutResponseData.d.ts +17 -0
- package/dist/api/types/ScheduledCheckoutStatus.d.ts +8 -0
- package/dist/api/types/ScheduledDowngradeConfigBehavior.d.ts +5 -0
- package/dist/api/types/ScheduledDowngradeResponseData.d.ts +13 -0
- package/dist/api/types/TimeSeriesGranularity.d.ts +7 -0
- package/dist/api/types/UpsertCompanyRequestBody.d.ts +1 -0
- package/dist/api/types/UsageTimeSeriesPointResponseData.d.ts +6 -0
- package/dist/api/types/WebFeatureUsageWebhookOutput.d.ts +10 -0
- package/dist/api/types/WebhookRequestType.d.ts +1 -0
- package/dist/api/types/WhoAmIResponseData.d.ts +12 -0
- package/dist/api/types/index.d.ts +43 -6
- package/dist/cache/index.d.ts +3 -0
- package/dist/{cache.d.ts → cache/local.d.ts} +9 -10
- package/dist/cache/redis.d.ts +38 -0
- package/dist/cache/types.d.ts +19 -0
- package/dist/datastream/datastream-client.d.ts +239 -0
- package/dist/datastream/index.d.ts +2 -0
- package/dist/datastream/types.d.ts +48 -0
- package/dist/datastream/websocket-client.d.ts +127 -0
- package/dist/index.d.ts +4 -2
- package/dist/index.js +3 -3
- package/dist/rules-engine.d.ts +54 -0
- package/dist/serialization/resources/accounts/client/requests/CreateApiKeyRequestBody.d.ts +1 -0
- package/dist/serialization/resources/accounts/types/CountAuditLogsParams.d.ts +16 -0
- package/dist/serialization/resources/accounts/types/CountAuditLogsResponse.d.ts +12 -0
- package/dist/serialization/resources/accounts/types/GetAuditLogResponse.d.ts +11 -0
- package/dist/serialization/resources/accounts/types/GetWhoAmIResponse.d.ts +11 -0
- package/dist/serialization/resources/accounts/types/ListAuditLogsParams.d.ts +16 -0
- package/dist/serialization/resources/accounts/types/ListAuditLogsResponse.d.ts +12 -0
- package/dist/serialization/resources/accounts/types/index.d.ts +6 -5
- package/dist/serialization/resources/billing/client/requests/CreateInvoiceRequestBody.d.ts +2 -0
- package/dist/serialization/resources/companies/types/CountCompaniesParams.d.ts +13 -0
- package/dist/serialization/resources/companies/types/ListCompaniesParams.d.ts +13 -0
- package/dist/serialization/resources/companies/types/index.d.ts +0 -4
- package/dist/serialization/resources/componentspublic/index.d.ts +1 -0
- package/dist/serialization/resources/componentspublic/types/GetPublicPlansResponse.d.ts +11 -0
- package/dist/serialization/resources/componentspublic/types/index.d.ts +1 -0
- package/dist/serialization/resources/credits/types/CountBillingPlanCreditGrantsParams.d.ts +1 -0
- package/dist/serialization/resources/credits/types/CountCreditEventLedgerParams.d.ts +17 -0
- package/dist/serialization/resources/credits/types/CountCreditEventLedgerResponse.d.ts +12 -0
- package/dist/serialization/resources/credits/types/ListBillingPlanCreditGrantsParams.d.ts +1 -0
- package/dist/serialization/resources/credits/types/ListCreditEventLedgerParams.d.ts +17 -0
- package/dist/serialization/resources/credits/types/ListCreditEventLedgerResponse.d.ts +12 -0
- package/dist/serialization/resources/credits/types/index.d.ts +4 -0
- package/dist/serialization/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.d.ts +1 -0
- package/dist/serialization/resources/entitlements/types/CountPlanEntitlementsParams.d.ts +2 -0
- package/dist/serialization/resources/entitlements/types/GetFeatureUsageTimeSeriesParams.d.ts +14 -0
- package/dist/serialization/resources/entitlements/types/GetFeatureUsageTimeSeriesResponse.d.ts +12 -0
- package/dist/serialization/resources/entitlements/types/ListPlanEntitlementsParams.d.ts +2 -0
- package/dist/serialization/resources/entitlements/types/index.d.ts +2 -0
- package/dist/serialization/resources/features/types/CountFeaturesParams.d.ts +1 -0
- package/dist/serialization/resources/features/types/ListFeaturesParams.d.ts +1 -0
- package/dist/serialization/resources/index.d.ts +7 -0
- package/dist/serialization/resources/planbundle/client/requests/UpdatePlanBundleRequestBody.d.ts +1 -0
- package/dist/serialization/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts +5 -0
- package/dist/serialization/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts +5 -0
- package/dist/serialization/resources/planmigrations/index.d.ts +1 -0
- package/dist/serialization/resources/planmigrations/types/CountCompanyMigrationsParams.d.ts +14 -0
- package/dist/serialization/resources/planmigrations/types/CountCompanyMigrationsResponse.d.ts +12 -0
- package/dist/serialization/resources/planmigrations/types/CountMigrationsParams.d.ts +13 -0
- package/dist/serialization/resources/planmigrations/types/CountMigrationsResponse.d.ts +12 -0
- package/dist/serialization/resources/planmigrations/types/GetMigrationResponse.d.ts +11 -0
- package/dist/serialization/resources/planmigrations/types/ListCompanyMigrationsParams.d.ts +14 -0
- package/dist/serialization/resources/planmigrations/types/ListCompanyMigrationsResponse.d.ts +12 -0
- package/dist/serialization/resources/planmigrations/types/ListMigrationsParams.d.ts +13 -0
- package/dist/serialization/resources/planmigrations/types/ListMigrationsResponse.d.ts +12 -0
- package/dist/serialization/resources/planmigrations/types/index.d.ts +9 -0
- package/dist/serialization/resources/plans/client/requests/PublishPlanVersionRequestBody.d.ts +11 -0
- package/dist/serialization/resources/plans/client/requests/index.d.ts +1 -0
- package/dist/serialization/resources/plans/types/DeletePlanVersionResponse.d.ts +11 -0
- package/dist/serialization/resources/plans/types/GetPlanParams.d.ts +9 -0
- package/dist/serialization/resources/plans/types/GetPlanResponse.d.ts +2 -1
- package/dist/serialization/resources/plans/types/ListPlanIssuesParams.d.ts +1 -0
- package/dist/serialization/resources/plans/types/PublishPlanVersionResponse.d.ts +11 -0
- package/dist/serialization/resources/plans/types/index.d.ts +3 -0
- package/dist/serialization/resources/scheduledcheckout/client/index.d.ts +1 -0
- package/dist/serialization/resources/scheduledcheckout/client/requests/CreateScheduledCheckoutRequest.d.ts +12 -0
- package/dist/serialization/resources/scheduledcheckout/client/requests/UpdateScheduledCheckoutRequest.d.ts +11 -0
- package/dist/serialization/resources/scheduledcheckout/client/requests/index.d.ts +2 -0
- package/dist/serialization/resources/scheduledcheckout/index.d.ts +2 -0
- package/dist/serialization/resources/scheduledcheckout/types/CreateScheduledCheckoutResponse.d.ts +11 -0
- package/dist/serialization/resources/scheduledcheckout/types/GetScheduledCheckoutResponse.d.ts +11 -0
- package/dist/serialization/resources/scheduledcheckout/types/ListScheduledCheckoutsParams.d.ts +13 -0
- package/dist/serialization/resources/scheduledcheckout/types/ListScheduledCheckoutsResponse.d.ts +12 -0
- package/dist/serialization/resources/scheduledcheckout/types/UpdateScheduledCheckoutResponse.d.ts +11 -0
- package/dist/serialization/resources/scheduledcheckout/types/index.d.ts +5 -0
- package/dist/serialization/types/ActorType.d.ts +7 -0
- package/dist/serialization/types/ApiKeyCreateResponseData.d.ts +1 -0
- package/dist/serialization/types/ApiKeyResponseData.d.ts +1 -0
- package/dist/serialization/types/{ApiKeyRequestListResponseData.d.ts → AuditLogListResponseData.d.ts} +5 -5
- package/dist/serialization/types/{ApiKeyRequestResponseData.d.ts → AuditLogResponseData.d.ts} +5 -7
- package/dist/serialization/types/BillingCreditResponseData.d.ts +1 -0
- package/dist/serialization/types/BillingCreditView.d.ts +32 -0
- package/dist/serialization/types/BillingPlanCreditGrantResponseData.d.ts +7 -2
- package/dist/serialization/types/CheckFlagResponseData.d.ts +2 -0
- package/dist/serialization/types/CompanyDetailResponseData.d.ts +4 -0
- package/dist/serialization/types/CompanyPlanDetailResponseData.d.ts +2 -0
- package/dist/serialization/types/ComponentDisplaySettings.d.ts +2 -0
- package/dist/serialization/types/ComponentHydrateResponseData.d.ts +2 -0
- package/dist/serialization/types/ComponentPreviewResponseData.d.ts +2 -0
- package/dist/serialization/types/ComponentSettingsResponseData.d.ts +2 -0
- package/dist/serialization/types/ConditionConditionType.d.ts +1 -1
- package/dist/serialization/types/ConditionGroupResponseData.d.ts +16 -0
- package/dist/serialization/types/ConditionGroupView.d.ts +18 -0
- package/dist/serialization/types/ConditionResponseData.d.ts +34 -0
- package/dist/serialization/types/ConditionView.d.ts +43 -0
- package/dist/serialization/types/CreateBillingPlanCreditGrantRequestBody.d.ts +1 -0
- package/dist/serialization/types/CreateEntitlementInBundleRequestBody.d.ts +2 -0
- package/dist/serialization/types/CreditEventLedgerResponseData.d.ts +47 -0
- package/dist/serialization/types/CreditEventType.d.ts +7 -0
- package/dist/serialization/types/CreditsAutoTopupCompanySummary.d.ts +10 -0
- package/dist/serialization/types/CreditsAutoTopupCreditSummary.d.ts +10 -0
- package/dist/serialization/types/CreditsAutoTopupHardFailure.d.ts +14 -0
- package/dist/serialization/types/CreditsAutoTopupRetryFailure.d.ts +15 -0
- package/dist/serialization/types/FeatureEntitlement.d.ts +25 -0
- package/dist/serialization/types/FeatureEntitlementMetricPeriod.d.ts +7 -0
- package/dist/serialization/types/FeatureEntitlementMonthReset.d.ts +7 -0
- package/dist/serialization/types/FeatureUsageLegacyResponseData.d.ts +16 -0
- package/dist/serialization/types/FeatureUsageTimeSeriesResponseData.d.ts +16 -0
- package/dist/serialization/types/FeatureView.d.ts +32 -0
- package/dist/serialization/types/FlagView.d.ts +25 -0
- package/dist/serialization/types/InvoiceRequestBody.d.ts +2 -0
- package/dist/serialization/types/InvoiceResponseData.d.ts +2 -0
- package/dist/serialization/types/InvoiceStatus.d.ts +7 -0
- package/dist/serialization/types/LimitTimeSeriesPointResponseData.d.ts +16 -0
- package/dist/serialization/types/PlanChangeAction.d.ts +1 -1
- package/dist/serialization/types/PlanChangeResponseData.d.ts +4 -4
- package/dist/serialization/types/PlanCreditGrantView.d.ts +7 -3
- package/dist/serialization/types/PlanDetailResponseData.d.ts +2 -0
- package/dist/serialization/types/PlanGroupDetailResponseData.d.ts +2 -0
- package/dist/serialization/types/PlanGroupPlanDetailResponseData.d.ts +2 -0
- package/dist/serialization/types/PlanGroupResponseData.d.ts +2 -0
- package/dist/serialization/types/PlanVersionCompanyMigrationResponseData.d.ts +20 -0
- package/dist/serialization/types/PlanVersionCompanyMigrationStatus.d.ts +7 -0
- package/dist/serialization/types/PlanVersionMigrationResponseData.d.ts +25 -0
- package/dist/serialization/types/PlanVersionMigrationStatus.d.ts +7 -0
- package/dist/serialization/types/PlanVersionMigrationStrategy.d.ts +7 -0
- package/dist/serialization/types/PlanViewPublicResponseData.d.ts +47 -0
- package/dist/serialization/types/PreviewSubscriptionChangeResponseData.d.ts +2 -0
- package/dist/serialization/types/PublicPlansResponseData.d.ts +21 -0
- package/dist/serialization/types/RuleView.d.ts +23 -0
- package/dist/serialization/types/RulesEngineSchemaVersion.d.ts +1 -1
- package/dist/serialization/types/RulesengineCheckFlagResult.d.ts +2 -0
- package/dist/serialization/types/RulesengineCompany.d.ts +3 -1
- package/dist/serialization/types/RulesengineConditionConditionType.d.ts +1 -1
- package/dist/serialization/types/RulesengineEntitlementValueType.d.ts +7 -0
- package/dist/serialization/types/RulesengineFeatureEntitlement.d.ts +25 -0
- package/dist/serialization/types/RulesengineFeatureEntitlementMetricPeriod.d.ts +7 -0
- package/dist/serialization/types/RulesengineFeatureEntitlementMonthReset.d.ts +7 -0
- package/dist/serialization/types/ScheduledCheckoutResponseData.d.ts +23 -0
- package/dist/serialization/types/ScheduledCheckoutStatus.d.ts +7 -0
- package/dist/serialization/types/ScheduledDowngradeConfigBehavior.d.ts +7 -0
- package/dist/serialization/types/ScheduledDowngradeResponseData.d.ts +19 -0
- package/dist/serialization/types/TimeSeriesGranularity.d.ts +7 -0
- package/dist/serialization/types/UpsertCompanyRequestBody.d.ts +1 -0
- package/dist/serialization/types/UsageTimeSeriesPointResponseData.d.ts +12 -0
- package/dist/serialization/types/WebFeatureUsageWebhookOutput.d.ts +18 -0
- package/dist/serialization/types/WebhookRequestType.d.ts +1 -1
- package/dist/serialization/types/WhoAmIResponseData.d.ts +18 -0
- package/dist/serialization/types/index.d.ts +43 -6
- package/dist/wrapper.d.ts +48 -4
- package/package.json +4 -2
- package/dist/api/resources/accounts/client/requests/CountApiRequestsRequest.d.ts +0 -19
- package/dist/api/resources/accounts/client/requests/ListApiRequestsRequest.d.ts +0 -19
- package/dist/api/resources/accounts/types/ListApiRequestsResponse.d.ts +0 -6
- package/dist/api/resources/companies/client/requests/CountCompaniesForAdvancedFilterRequest.d.ts +0 -46
- package/dist/api/resources/companies/client/requests/ListCompaniesForAdvancedFilterRequest.d.ts +0 -46
- package/dist/api/resources/companies/types/CountCompaniesForAdvancedFilterParams.d.ts +0 -35
- package/dist/api/resources/companies/types/CountCompaniesForAdvancedFilterResponse.d.ts +0 -6
- package/dist/api/resources/companies/types/ListCompaniesForAdvancedFilterParams.d.ts +0 -35
- package/dist/api/resources/companies/types/ListCompaniesForAdvancedFilterResponse.d.ts +0 -6
- package/dist/api/types/CompanyViewWithFeatureUsageResponseData.d.ts +0 -26
- package/dist/api/types/CreditUsageResponseData.d.ts +0 -12
- package/dist/api/types/FeatureUsageDataResponseData.d.ts +0 -19
- package/dist/serialization/resources/accounts/types/CountApiRequestsParams.d.ts +0 -13
- package/dist/serialization/resources/accounts/types/CountApiRequestsResponse.d.ts +0 -12
- package/dist/serialization/resources/accounts/types/GetApiRequestResponse.d.ts +0 -11
- package/dist/serialization/resources/accounts/types/ListApiRequestsParams.d.ts +0 -13
- package/dist/serialization/resources/accounts/types/ListApiRequestsResponse.d.ts +0 -12
- package/dist/serialization/resources/companies/types/CountCompaniesForAdvancedFilterParams.d.ts +0 -26
- package/dist/serialization/resources/companies/types/CountCompaniesForAdvancedFilterResponse.d.ts +0 -12
- package/dist/serialization/resources/companies/types/ListCompaniesForAdvancedFilterParams.d.ts +0 -26
- package/dist/serialization/resources/companies/types/ListCompaniesForAdvancedFilterResponse.d.ts +0 -12
- package/dist/serialization/types/CompanyViewWithFeatureUsageResponseData.d.ts +0 -39
- package/dist/serialization/types/CreditUsageResponseData.d.ts +0 -17
- package/dist/serialization/types/FeatureUsageDataResponseData.d.ts +0 -27
- package/dist/serialization/types/PlanChangeActorType.d.ts +0 -7
|
@@ -1,21 +1,42 @@
|
|
|
1
|
+
import type * as Schematic from "../../../index";
|
|
1
2
|
/**
|
|
2
3
|
* Input parameters
|
|
3
4
|
*/
|
|
4
5
|
export interface ListCompaniesParams {
|
|
6
|
+
/** Filter companies by one or more credit type IDs (each ID starts with bcrd_) */
|
|
7
|
+
creditTypeIds?: string[];
|
|
5
8
|
/** Filter companies by multiple company IDs (starts with comp_) */
|
|
6
9
|
ids?: string[];
|
|
7
10
|
/** Page limit (default 100) */
|
|
8
11
|
limit?: number;
|
|
12
|
+
/** Filter companies that have monetized subscriptions */
|
|
13
|
+
monetizedSubscriptions?: boolean;
|
|
9
14
|
/** Page offset (default 0) */
|
|
10
15
|
offset?: number;
|
|
11
16
|
/** Filter companies by plan ID (starts with plan_) */
|
|
12
17
|
planId?: string;
|
|
18
|
+
/** Filter companies by one or more plan IDs (each ID starts with plan_) */
|
|
19
|
+
planIds?: string[];
|
|
20
|
+
/** Filter companies by plan version ID (starts with plvr_) */
|
|
21
|
+
planVersionId?: string;
|
|
13
22
|
/** Search for companies by name, keys or string traits */
|
|
14
23
|
q?: string;
|
|
24
|
+
/** Column to sort by (e.g. name, created_at, last_seen_at) */
|
|
25
|
+
sortOrderColumn?: string;
|
|
26
|
+
/** Direction to sort by (asc or desc) */
|
|
27
|
+
sortOrderDirection?: Schematic.SortDirection;
|
|
28
|
+
/** Filter companies by one or more subscription statuses */
|
|
29
|
+
subscriptionStatuses?: Schematic.SubscriptionStatus[];
|
|
30
|
+
/** Filter companies by one or more subscription types */
|
|
31
|
+
subscriptionTypes?: Schematic.SubscriptionType[];
|
|
32
|
+
/** Filter companies that have an entitlement (plan entitlement or company override) for the specified feature ID */
|
|
33
|
+
withEntitlementFor?: string;
|
|
15
34
|
/** Filter companies that have a subscription */
|
|
16
35
|
withSubscription?: boolean;
|
|
17
36
|
/** Filter out companies that already have a company override for the specified feature ID */
|
|
18
37
|
withoutFeatureOverrideFor?: string;
|
|
19
38
|
/** Filter out companies that have a plan */
|
|
20
39
|
withoutPlan?: boolean;
|
|
40
|
+
/** Filter out companies that have a subscription */
|
|
41
|
+
withoutSubscription?: boolean;
|
|
21
42
|
}
|
|
@@ -1,5 +1,3 @@
|
|
|
1
|
-
export * from "./CountCompaniesForAdvancedFilterParams";
|
|
2
|
-
export * from "./CountCompaniesForAdvancedFilterResponse";
|
|
3
1
|
export * from "./CountCompaniesParams";
|
|
4
2
|
export * from "./CountCompaniesResponse";
|
|
5
3
|
export * from "./CountEntityKeyDefinitionsParams";
|
|
@@ -31,8 +29,6 @@ export * from "./GetOrCreateEntityTraitDefinitionResponse";
|
|
|
31
29
|
export * from "./GetPlanChangeResponse";
|
|
32
30
|
export * from "./GetPlanTraitResponse";
|
|
33
31
|
export * from "./GetUserResponse";
|
|
34
|
-
export * from "./ListCompaniesForAdvancedFilterParams";
|
|
35
|
-
export * from "./ListCompaniesForAdvancedFilterResponse";
|
|
36
32
|
export * from "./ListCompaniesParams";
|
|
37
33
|
export * from "./ListCompaniesResponse";
|
|
38
34
|
export * from "./ListCompanyMembershipsParams";
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient";
|
|
2
|
+
import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient";
|
|
3
|
+
import * as core from "../../../../core";
|
|
4
|
+
import * as Schematic from "../../../index";
|
|
5
|
+
export declare namespace ComponentspublicClient {
|
|
6
|
+
type Options = BaseClientOptions;
|
|
7
|
+
interface RequestOptions extends BaseRequestOptions {
|
|
8
|
+
}
|
|
9
|
+
}
|
|
10
|
+
export declare class ComponentspublicClient {
|
|
11
|
+
protected readonly _options: NormalizedClientOptionsWithAuth<ComponentspublicClient.Options>;
|
|
12
|
+
constructor(options: ComponentspublicClient.Options);
|
|
13
|
+
/**
|
|
14
|
+
* @param {ComponentspublicClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
15
|
+
*
|
|
16
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
17
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
18
|
+
* @throws {@link Schematic.NotFoundError}
|
|
19
|
+
* @throws {@link Schematic.InternalServerError}
|
|
20
|
+
*
|
|
21
|
+
* @example
|
|
22
|
+
* await client.componentspublic.getPublicPlans()
|
|
23
|
+
*/
|
|
24
|
+
getPublicPlans(requestOptions?: ComponentspublicClient.RequestOptions): core.HttpResponsePromise<Schematic.GetPublicPlansResponse>;
|
|
25
|
+
private __getPublicPlans;
|
|
26
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./GetPublicPlansResponse";
|
|
@@ -403,6 +403,7 @@ export declare class CreditsClient {
|
|
|
403
403
|
* await client.credits.listBillingPlanCreditGrants({
|
|
404
404
|
* creditId: "credit_id",
|
|
405
405
|
* planId: "plan_id",
|
|
406
|
+
* planVersionId: "plan_version_id",
|
|
406
407
|
* limit: 1,
|
|
407
408
|
* offset: 1
|
|
408
409
|
* })
|
|
@@ -481,10 +482,59 @@ export declare class CreditsClient {
|
|
|
481
482
|
* await client.credits.countBillingPlanCreditGrants({
|
|
482
483
|
* creditId: "credit_id",
|
|
483
484
|
* planId: "plan_id",
|
|
485
|
+
* planVersionId: "plan_version_id",
|
|
484
486
|
* limit: 1,
|
|
485
487
|
* offset: 1
|
|
486
488
|
* })
|
|
487
489
|
*/
|
|
488
490
|
countBillingPlanCreditGrants(request?: Schematic.CountBillingPlanCreditGrantsRequest, requestOptions?: CreditsClient.RequestOptions): core.HttpResponsePromise<Schematic.CountBillingPlanCreditGrantsResponse>;
|
|
489
491
|
private __countBillingPlanCreditGrants;
|
|
492
|
+
/**
|
|
493
|
+
* @param {Schematic.ListCreditEventLedgerRequest} request
|
|
494
|
+
* @param {CreditsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
495
|
+
*
|
|
496
|
+
* @throws {@link Schematic.BadRequestError}
|
|
497
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
498
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
499
|
+
* @throws {@link Schematic.NotFoundError}
|
|
500
|
+
* @throws {@link Schematic.InternalServerError}
|
|
501
|
+
*
|
|
502
|
+
* @example
|
|
503
|
+
* await client.credits.listCreditEventLedger({
|
|
504
|
+
* billingCreditId: "billing_credit_id",
|
|
505
|
+
* companyId: "company_id",
|
|
506
|
+
* endTime: "end_time",
|
|
507
|
+
* eventType: "grant",
|
|
508
|
+
* featureId: "feature_id",
|
|
509
|
+
* startTime: "start_time",
|
|
510
|
+
* limit: 1,
|
|
511
|
+
* offset: 1
|
|
512
|
+
* })
|
|
513
|
+
*/
|
|
514
|
+
listCreditEventLedger(request: Schematic.ListCreditEventLedgerRequest, requestOptions?: CreditsClient.RequestOptions): core.HttpResponsePromise<Schematic.ListCreditEventLedgerResponse>;
|
|
515
|
+
private __listCreditEventLedger;
|
|
516
|
+
/**
|
|
517
|
+
* @param {Schematic.CountCreditEventLedgerRequest} request
|
|
518
|
+
* @param {CreditsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
519
|
+
*
|
|
520
|
+
* @throws {@link Schematic.BadRequestError}
|
|
521
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
522
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
523
|
+
* @throws {@link Schematic.NotFoundError}
|
|
524
|
+
* @throws {@link Schematic.InternalServerError}
|
|
525
|
+
*
|
|
526
|
+
* @example
|
|
527
|
+
* await client.credits.countCreditEventLedger({
|
|
528
|
+
* billingCreditId: "billing_credit_id",
|
|
529
|
+
* companyId: "company_id",
|
|
530
|
+
* endTime: "end_time",
|
|
531
|
+
* eventType: "grant",
|
|
532
|
+
* featureId: "feature_id",
|
|
533
|
+
* startTime: "start_time",
|
|
534
|
+
* limit: 1,
|
|
535
|
+
* offset: 1
|
|
536
|
+
* })
|
|
537
|
+
*/
|
|
538
|
+
countCreditEventLedger(request: Schematic.CountCreditEventLedgerRequest, requestOptions?: CreditsClient.RequestOptions): core.HttpResponsePromise<Schematic.CountCreditEventLedgerResponse>;
|
|
539
|
+
private __countCreditEventLedger;
|
|
490
540
|
}
|
|
@@ -3,15 +3,17 @@
|
|
|
3
3
|
* {
|
|
4
4
|
* creditId: "credit_id",
|
|
5
5
|
* planId: "plan_id",
|
|
6
|
+
* planVersionId: "plan_version_id",
|
|
6
7
|
* limit: 1,
|
|
7
8
|
* offset: 1
|
|
8
9
|
* }
|
|
9
10
|
*/
|
|
10
11
|
export interface CountBillingPlanCreditGrantsRequest {
|
|
11
12
|
creditId?: string;
|
|
13
|
+
ids?: string | string[];
|
|
12
14
|
planId?: string;
|
|
13
15
|
planIds?: string | string[];
|
|
14
|
-
|
|
16
|
+
planVersionId?: string;
|
|
15
17
|
/** Page limit (default 100) */
|
|
16
18
|
limit?: number;
|
|
17
19
|
/** Page offset (default 0) */
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import type * as Schematic from "../../../../index";
|
|
2
|
+
/**
|
|
3
|
+
* @example
|
|
4
|
+
* {
|
|
5
|
+
* billingCreditId: "billing_credit_id",
|
|
6
|
+
* companyId: "company_id",
|
|
7
|
+
* endTime: "end_time",
|
|
8
|
+
* eventType: "grant",
|
|
9
|
+
* featureId: "feature_id",
|
|
10
|
+
* startTime: "start_time",
|
|
11
|
+
* limit: 1,
|
|
12
|
+
* offset: 1
|
|
13
|
+
* }
|
|
14
|
+
*/
|
|
15
|
+
export interface CountCreditEventLedgerRequest {
|
|
16
|
+
billingCreditId?: string;
|
|
17
|
+
companyId: string;
|
|
18
|
+
endTime?: string;
|
|
19
|
+
eventType?: Schematic.CreditEventType;
|
|
20
|
+
featureId?: string;
|
|
21
|
+
startTime?: string;
|
|
22
|
+
/** Page limit (default 100) */
|
|
23
|
+
limit?: number;
|
|
24
|
+
/** Page offset (default 0) */
|
|
25
|
+
offset?: number;
|
|
26
|
+
}
|
|
@@ -3,15 +3,17 @@
|
|
|
3
3
|
* {
|
|
4
4
|
* creditId: "credit_id",
|
|
5
5
|
* planId: "plan_id",
|
|
6
|
+
* planVersionId: "plan_version_id",
|
|
6
7
|
* limit: 1,
|
|
7
8
|
* offset: 1
|
|
8
9
|
* }
|
|
9
10
|
*/
|
|
10
11
|
export interface ListBillingPlanCreditGrantsRequest {
|
|
11
12
|
creditId?: string;
|
|
13
|
+
ids?: string | string[];
|
|
12
14
|
planId?: string;
|
|
13
15
|
planIds?: string | string[];
|
|
14
|
-
|
|
16
|
+
planVersionId?: string;
|
|
15
17
|
/** Page limit (default 100) */
|
|
16
18
|
limit?: number;
|
|
17
19
|
/** Page offset (default 0) */
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import type * as Schematic from "../../../../index";
|
|
2
|
+
/**
|
|
3
|
+
* @example
|
|
4
|
+
* {
|
|
5
|
+
* billingCreditId: "billing_credit_id",
|
|
6
|
+
* companyId: "company_id",
|
|
7
|
+
* endTime: "end_time",
|
|
8
|
+
* eventType: "grant",
|
|
9
|
+
* featureId: "feature_id",
|
|
10
|
+
* startTime: "start_time",
|
|
11
|
+
* limit: 1,
|
|
12
|
+
* offset: 1
|
|
13
|
+
* }
|
|
14
|
+
*/
|
|
15
|
+
export interface ListCreditEventLedgerRequest {
|
|
16
|
+
billingCreditId?: string;
|
|
17
|
+
companyId: string;
|
|
18
|
+
endTime?: string;
|
|
19
|
+
eventType?: Schematic.CreditEventType;
|
|
20
|
+
featureId?: string;
|
|
21
|
+
startTime?: string;
|
|
22
|
+
/** Page limit (default 100) */
|
|
23
|
+
limit?: number;
|
|
24
|
+
/** Page offset (default 0) */
|
|
25
|
+
offset?: number;
|
|
26
|
+
}
|
|
@@ -3,6 +3,7 @@ export type { CountBillingCreditsRequest } from "./CountBillingCreditsRequest";
|
|
|
3
3
|
export type { CountBillingPlanCreditGrantsRequest } from "./CountBillingPlanCreditGrantsRequest";
|
|
4
4
|
export type { CountCompanyGrantsRequest } from "./CountCompanyGrantsRequest";
|
|
5
5
|
export type { CountCreditBundlesRequest } from "./CountCreditBundlesRequest";
|
|
6
|
+
export type { CountCreditEventLedgerRequest } from "./CountCreditEventLedgerRequest";
|
|
6
7
|
export type { CountCreditLedgerRequest } from "./CountCreditLedgerRequest";
|
|
7
8
|
export type { CreateBillingCreditRequestBody } from "./CreateBillingCreditRequestBody";
|
|
8
9
|
export type { CreateCompanyCreditGrant } from "./CreateCompanyCreditGrant";
|
|
@@ -13,6 +14,7 @@ export type { ListBillingCreditsRequest } from "./ListBillingCreditsRequest";
|
|
|
13
14
|
export type { ListBillingPlanCreditGrantsRequest } from "./ListBillingPlanCreditGrantsRequest";
|
|
14
15
|
export type { ListCompanyGrantsRequest } from "./ListCompanyGrantsRequest";
|
|
15
16
|
export type { ListCreditBundlesRequest } from "./ListCreditBundlesRequest";
|
|
17
|
+
export type { ListCreditEventLedgerRequest } from "./ListCreditEventLedgerRequest";
|
|
16
18
|
export type { ListGrantsForCreditRequest } from "./ListGrantsForCreditRequest";
|
|
17
19
|
export type { UpdateBillingCreditRequestBody } from "./UpdateBillingCreditRequestBody";
|
|
18
20
|
export type { UpdateCreditBundleDetailsRequestBody } from "./UpdateCreditBundleDetailsRequestBody";
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type * as Schematic from "../../../index";
|
|
2
|
+
/**
|
|
3
|
+
* Input parameters
|
|
4
|
+
*/
|
|
5
|
+
export interface CountCreditEventLedgerParams {
|
|
6
|
+
billingCreditId?: string;
|
|
7
|
+
companyId?: string;
|
|
8
|
+
endTime?: string;
|
|
9
|
+
eventType?: Schematic.CreditEventType;
|
|
10
|
+
featureId?: string;
|
|
11
|
+
/** Page limit (default 100) */
|
|
12
|
+
limit?: number;
|
|
13
|
+
/** Page offset (default 0) */
|
|
14
|
+
offset?: number;
|
|
15
|
+
startTime?: string;
|
|
16
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type * as Schematic from "../../../index";
|
|
2
|
+
/**
|
|
3
|
+
* Input parameters
|
|
4
|
+
*/
|
|
5
|
+
export interface ListCreditEventLedgerParams {
|
|
6
|
+
billingCreditId?: string;
|
|
7
|
+
companyId?: string;
|
|
8
|
+
endTime?: string;
|
|
9
|
+
eventType?: Schematic.CreditEventType;
|
|
10
|
+
featureId?: string;
|
|
11
|
+
/** Page limit (default 100) */
|
|
12
|
+
limit?: number;
|
|
13
|
+
/** Page offset (default 0) */
|
|
14
|
+
offset?: number;
|
|
15
|
+
startTime?: string;
|
|
16
|
+
}
|
|
@@ -8,6 +8,8 @@ export * from "./CountCompanyGrantsParams";
|
|
|
8
8
|
export * from "./CountCompanyGrantsResponse";
|
|
9
9
|
export * from "./CountCreditBundlesParams";
|
|
10
10
|
export * from "./CountCreditBundlesResponse";
|
|
11
|
+
export * from "./CountCreditEventLedgerParams";
|
|
12
|
+
export * from "./CountCreditEventLedgerResponse";
|
|
11
13
|
export * from "./CountCreditLedgerParams";
|
|
12
14
|
export * from "./CountCreditLedgerResponse";
|
|
13
15
|
export * from "./CreateBillingCreditResponse";
|
|
@@ -29,6 +31,8 @@ export * from "./ListCompanyGrantsParams";
|
|
|
29
31
|
export * from "./ListCompanyGrantsResponse";
|
|
30
32
|
export * from "./ListCreditBundlesParams";
|
|
31
33
|
export * from "./ListCreditBundlesResponse";
|
|
34
|
+
export * from "./ListCreditEventLedgerParams";
|
|
35
|
+
export * from "./ListCreditEventLedgerResponse";
|
|
32
36
|
export * from "./ListGrantsForCreditParams";
|
|
33
37
|
export * from "./ListGrantsForCreditResponse";
|
|
34
38
|
export * from "./SoftDeleteBillingCreditResponse";
|
|
@@ -182,6 +182,26 @@ export declare class EntitlementsClient {
|
|
|
182
182
|
*/
|
|
183
183
|
listFeatureUsage(request?: Schematic.ListFeatureUsageRequest, requestOptions?: EntitlementsClient.RequestOptions): core.HttpResponsePromise<Schematic.ListFeatureUsageResponse>;
|
|
184
184
|
private __listFeatureUsage;
|
|
185
|
+
/**
|
|
186
|
+
* @param {Schematic.GetFeatureUsageTimeSeriesRequest} request
|
|
187
|
+
* @param {EntitlementsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
188
|
+
*
|
|
189
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
190
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
191
|
+
* @throws {@link Schematic.NotFoundError}
|
|
192
|
+
* @throws {@link Schematic.InternalServerError}
|
|
193
|
+
*
|
|
194
|
+
* @example
|
|
195
|
+
* await client.entitlements.getFeatureUsageTimeSeries({
|
|
196
|
+
* companyId: "company_id",
|
|
197
|
+
* endTime: new Date("2024-01-15T09:30:00.000Z"),
|
|
198
|
+
* featureId: "feature_id",
|
|
199
|
+
* granularity: "daily",
|
|
200
|
+
* startTime: new Date("2024-01-15T09:30:00.000Z")
|
|
201
|
+
* })
|
|
202
|
+
*/
|
|
203
|
+
getFeatureUsageTimeSeries(request: Schematic.GetFeatureUsageTimeSeriesRequest, requestOptions?: EntitlementsClient.RequestOptions): core.HttpResponsePromise<Schematic.GetFeatureUsageTimeSeriesResponse>;
|
|
204
|
+
private __getFeatureUsageTimeSeries;
|
|
185
205
|
/**
|
|
186
206
|
* @param {Schematic.CountFeatureUsageRequest} request
|
|
187
207
|
* @param {EntitlementsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -258,6 +278,7 @@ export declare class EntitlementsClient {
|
|
|
258
278
|
* await client.entitlements.listPlanEntitlements({
|
|
259
279
|
* featureId: "feature_id",
|
|
260
280
|
* planId: "plan_id",
|
|
281
|
+
* planVersionId: "plan_version_id",
|
|
261
282
|
* q: "q",
|
|
262
283
|
* withMeteredProducts: true,
|
|
263
284
|
* limit: 1,
|
|
@@ -346,6 +367,7 @@ export declare class EntitlementsClient {
|
|
|
346
367
|
* await client.entitlements.countPlanEntitlements({
|
|
347
368
|
* featureId: "feature_id",
|
|
348
369
|
* planId: "plan_id",
|
|
370
|
+
* planVersionId: "plan_version_id",
|
|
349
371
|
* q: "q",
|
|
350
372
|
* withMeteredProducts: true,
|
|
351
373
|
* limit: 1,
|
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
* {
|
|
4
4
|
* featureId: "feature_id",
|
|
5
5
|
* planId: "plan_id",
|
|
6
|
+
* planVersionId: "plan_version_id",
|
|
6
7
|
* q: "q",
|
|
7
8
|
* withMeteredProducts: true,
|
|
8
9
|
* limit: 1,
|
|
@@ -20,6 +21,10 @@ export interface CountPlanEntitlementsRequest {
|
|
|
20
21
|
planId?: string;
|
|
21
22
|
/** Filter plan entitlements by multiple plan IDs (starting with plan_) */
|
|
22
23
|
planIds?: string | string[];
|
|
24
|
+
/** Filter plan entitlements by a single plan version ID (starting with plvr_) */
|
|
25
|
+
planVersionId?: string;
|
|
26
|
+
/** Filter plan entitlements by multiple plan version IDs (starting with plvr_) */
|
|
27
|
+
planVersionIds?: string | string[];
|
|
23
28
|
/** Search for plan entitlements by feature or company name */
|
|
24
29
|
q?: string;
|
|
25
30
|
/** Filter plan entitlements only with metered products */
|
package/dist/api/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.d.ts
CHANGED
|
@@ -21,6 +21,7 @@ export interface CreatePlanEntitlementRequestBody {
|
|
|
21
21
|
monthlyUnitPriceDecimal?: string;
|
|
22
22
|
overageBillingProductId?: string;
|
|
23
23
|
planId: string;
|
|
24
|
+
planVersionId?: string;
|
|
24
25
|
priceBehavior?: Schematic.EntitlementPriceBehavior;
|
|
25
26
|
/** Use MonthlyPriceTiers or YearlyPriceTiers instead */
|
|
26
27
|
priceTiers?: Schematic.CreatePriceTierRequestBody[];
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import type * as Schematic from "../../../../index";
|
|
2
|
+
/**
|
|
3
|
+
* @example
|
|
4
|
+
* {
|
|
5
|
+
* companyId: "company_id",
|
|
6
|
+
* endTime: new Date("2024-01-15T09:30:00.000Z"),
|
|
7
|
+
* featureId: "feature_id",
|
|
8
|
+
* granularity: "daily",
|
|
9
|
+
* startTime: new Date("2024-01-15T09:30:00.000Z")
|
|
10
|
+
* }
|
|
11
|
+
*/
|
|
12
|
+
export interface GetFeatureUsageTimeSeriesRequest {
|
|
13
|
+
companyId: string;
|
|
14
|
+
endTime: Date;
|
|
15
|
+
featureId: string;
|
|
16
|
+
granularity?: Schematic.TimeSeriesGranularity;
|
|
17
|
+
startTime: Date;
|
|
18
|
+
}
|
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
* {
|
|
4
4
|
* featureId: "feature_id",
|
|
5
5
|
* planId: "plan_id",
|
|
6
|
+
* planVersionId: "plan_version_id",
|
|
6
7
|
* q: "q",
|
|
7
8
|
* withMeteredProducts: true,
|
|
8
9
|
* limit: 1,
|
|
@@ -20,6 +21,10 @@ export interface ListPlanEntitlementsRequest {
|
|
|
20
21
|
planId?: string;
|
|
21
22
|
/** Filter plan entitlements by multiple plan IDs (starting with plan_) */
|
|
22
23
|
planIds?: string | string[];
|
|
24
|
+
/** Filter plan entitlements by a single plan version ID (starting with plvr_) */
|
|
25
|
+
planVersionId?: string;
|
|
26
|
+
/** Filter plan entitlements by multiple plan version IDs (starting with plvr_) */
|
|
27
|
+
planVersionIds?: string | string[];
|
|
23
28
|
/** Search for plan entitlements by feature or company name */
|
|
24
29
|
q?: string;
|
|
25
30
|
/** Filter plan entitlements only with metered products */
|
|
@@ -7,6 +7,7 @@ export type { CreateCompanyOverrideRequestBody } from "./CreateCompanyOverrideRe
|
|
|
7
7
|
export type { CreatePlanEntitlementRequestBody } from "./CreatePlanEntitlementRequestBody";
|
|
8
8
|
export type { DuplicatePlanEntitlementsRequestBody } from "./DuplicatePlanEntitlementsRequestBody";
|
|
9
9
|
export type { GetFeatureUsageByCompanyRequest } from "./GetFeatureUsageByCompanyRequest";
|
|
10
|
+
export type { GetFeatureUsageTimeSeriesRequest } from "./GetFeatureUsageTimeSeriesRequest";
|
|
10
11
|
export type { ListCompanyOverridesRequest } from "./ListCompanyOverridesRequest";
|
|
11
12
|
export type { ListFeatureCompaniesRequest } from "./ListFeatureCompaniesRequest";
|
|
12
13
|
export type { ListFeatureUsageRequest } from "./ListFeatureUsageRequest";
|
|
@@ -16,6 +16,10 @@ export interface CountPlanEntitlementsParams {
|
|
|
16
16
|
planId?: string;
|
|
17
17
|
/** Filter plan entitlements by multiple plan IDs (starting with plan_) */
|
|
18
18
|
planIds?: string[];
|
|
19
|
+
/** Filter plan entitlements by a single plan version ID (starting with plvr_) */
|
|
20
|
+
planVersionId?: string;
|
|
21
|
+
/** Filter plan entitlements by multiple plan version IDs (starting with plvr_) */
|
|
22
|
+
planVersionIds?: string[];
|
|
19
23
|
/** Search for plan entitlements by feature or company name */
|
|
20
24
|
q?: string;
|
|
21
25
|
/** Filter plan entitlements only with metered products */
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type * as Schematic from "../../../index";
|
|
2
|
+
/**
|
|
3
|
+
* Input parameters
|
|
4
|
+
*/
|
|
5
|
+
export interface GetFeatureUsageTimeSeriesParams {
|
|
6
|
+
companyId?: string;
|
|
7
|
+
endTime?: Date;
|
|
8
|
+
featureId?: string;
|
|
9
|
+
granularity?: Schematic.TimeSeriesGranularity;
|
|
10
|
+
startTime?: Date;
|
|
11
|
+
}
|
|
@@ -16,6 +16,10 @@ export interface ListPlanEntitlementsParams {
|
|
|
16
16
|
planId?: string;
|
|
17
17
|
/** Filter plan entitlements by multiple plan IDs (starting with plan_) */
|
|
18
18
|
planIds?: string[];
|
|
19
|
+
/** Filter plan entitlements by a single plan version ID (starting with plvr_) */
|
|
20
|
+
planVersionId?: string;
|
|
21
|
+
/** Filter plan entitlements by multiple plan version IDs (starting with plvr_) */
|
|
22
|
+
planVersionIds?: string[];
|
|
19
23
|
/** Search for plan entitlements by feature or company name */
|
|
20
24
|
q?: string;
|
|
21
25
|
/** Filter plan entitlements only with metered products */
|
|
@@ -20,6 +20,8 @@ export * from "./DuplicatePlanEntitlementsResponse";
|
|
|
20
20
|
export * from "./GetCompanyOverrideResponse";
|
|
21
21
|
export * from "./GetFeatureUsageByCompanyParams";
|
|
22
22
|
export * from "./GetFeatureUsageByCompanyResponse";
|
|
23
|
+
export * from "./GetFeatureUsageTimeSeriesParams";
|
|
24
|
+
export * from "./GetFeatureUsageTimeSeriesResponse";
|
|
23
25
|
export * from "./GetPlanEntitlementResponse";
|
|
24
26
|
export * from "./ListCompanyOverridesParams";
|
|
25
27
|
export * from "./ListCompanyOverridesResponse";
|
|
@@ -24,6 +24,7 @@ export declare class FeaturesClient {
|
|
|
24
24
|
* await client.features.listFeatures({
|
|
25
25
|
* q: "q",
|
|
26
26
|
* withoutCompanyOverrideFor: "without_company_override_for",
|
|
27
|
+
* planVersionId: "plan_version_id",
|
|
27
28
|
* withoutPlanEntitlementFor: "without_plan_entitlement_for",
|
|
28
29
|
* booleanRequireEvent: true,
|
|
29
30
|
* limit: 1,
|
|
@@ -110,6 +111,7 @@ export declare class FeaturesClient {
|
|
|
110
111
|
* await client.features.countFeatures({
|
|
111
112
|
* q: "q",
|
|
112
113
|
* withoutCompanyOverrideFor: "without_company_override_for",
|
|
114
|
+
* planVersionId: "plan_version_id",
|
|
113
115
|
* withoutPlanEntitlementFor: "without_plan_entitlement_for",
|
|
114
116
|
* booleanRequireEvent: true,
|
|
115
117
|
* limit: 1,
|
|
@@ -4,6 +4,7 @@ import type * as Schematic from "../../../../index";
|
|
|
4
4
|
* {
|
|
5
5
|
* q: "q",
|
|
6
6
|
* withoutCompanyOverrideFor: "without_company_override_for",
|
|
7
|
+
* planVersionId: "plan_version_id",
|
|
7
8
|
* withoutPlanEntitlementFor: "without_plan_entitlement_for",
|
|
8
9
|
* booleanRequireEvent: true,
|
|
9
10
|
* limit: 1,
|
|
@@ -16,6 +17,8 @@ export interface CountFeaturesRequest {
|
|
|
16
17
|
q?: string;
|
|
17
18
|
/** Filter out features that already have a company override for the specified company ID */
|
|
18
19
|
withoutCompanyOverrideFor?: string;
|
|
20
|
+
/** Filter by plan version ID when used with without_plan_entitlement_for; if not provided, the latest published version is used */
|
|
21
|
+
planVersionId?: string;
|
|
19
22
|
/** Filter out features that already have a plan entitlement for the specified plan ID */
|
|
20
23
|
withoutPlanEntitlementFor?: string;
|
|
21
24
|
/** Filter by one or more feature types (boolean, event, trait) */
|
|
@@ -4,6 +4,7 @@ import type * as Schematic from "../../../../index";
|
|
|
4
4
|
* {
|
|
5
5
|
* q: "q",
|
|
6
6
|
* withoutCompanyOverrideFor: "without_company_override_for",
|
|
7
|
+
* planVersionId: "plan_version_id",
|
|
7
8
|
* withoutPlanEntitlementFor: "without_plan_entitlement_for",
|
|
8
9
|
* booleanRequireEvent: true,
|
|
9
10
|
* limit: 1,
|
|
@@ -16,6 +17,8 @@ export interface ListFeaturesRequest {
|
|
|
16
17
|
q?: string;
|
|
17
18
|
/** Filter out features that already have a company override for the specified company ID */
|
|
18
19
|
withoutCompanyOverrideFor?: string;
|
|
20
|
+
/** Filter by plan version ID when used with without_plan_entitlement_for; if not provided, the latest published version is used */
|
|
21
|
+
planVersionId?: string;
|
|
19
22
|
/** Filter out features that already have a plan entitlement for the specified plan ID */
|
|
20
23
|
withoutPlanEntitlementFor?: string;
|
|
21
24
|
/** Filter by one or more feature types (boolean, event, trait) */
|
|
@@ -12,6 +12,8 @@ export interface CountFeaturesParams {
|
|
|
12
12
|
limit?: number;
|
|
13
13
|
/** Page offset (default 0) */
|
|
14
14
|
offset?: number;
|
|
15
|
+
/** Filter by plan version ID when used with without_plan_entitlement_for; if not provided, the latest published version is used */
|
|
16
|
+
planVersionId?: string;
|
|
15
17
|
/** Search by feature name or ID */
|
|
16
18
|
q?: string;
|
|
17
19
|
/** Filter out features that already have a company override for the specified company ID */
|
|
@@ -12,6 +12,8 @@ export interface ListFeaturesParams {
|
|
|
12
12
|
limit?: number;
|
|
13
13
|
/** Page offset (default 0) */
|
|
14
14
|
offset?: number;
|
|
15
|
+
/** Filter by plan version ID when used with without_plan_entitlement_for; if not provided, the latest published version is used */
|
|
16
|
+
planVersionId?: string;
|
|
15
17
|
/** Search by feature name or ID */
|
|
16
18
|
q?: string;
|
|
17
19
|
/** Filter out features that already have a company override for the specified company ID */
|
|
@@ -16,6 +16,8 @@ export * from "./companies/types";
|
|
|
16
16
|
export * as components from "./components";
|
|
17
17
|
export * from "./components/client/requests";
|
|
18
18
|
export * from "./components/types";
|
|
19
|
+
export * as componentspublic from "./componentspublic";
|
|
20
|
+
export * from "./componentspublic/types";
|
|
19
21
|
export * as credits from "./credits";
|
|
20
22
|
export * from "./credits/client/requests";
|
|
21
23
|
export * from "./credits/types";
|
|
@@ -37,9 +39,15 @@ export * from "./planbundle/types";
|
|
|
37
39
|
export * as plangroups from "./plangroups";
|
|
38
40
|
export * from "./plangroups/client/requests";
|
|
39
41
|
export * from "./plangroups/types";
|
|
42
|
+
export * as planmigrations from "./planmigrations";
|
|
43
|
+
export * from "./planmigrations/client/requests";
|
|
44
|
+
export * from "./planmigrations/types";
|
|
40
45
|
export * as plans from "./plans";
|
|
41
46
|
export * from "./plans/client/requests";
|
|
42
47
|
export * from "./plans/types";
|
|
48
|
+
export * as scheduledcheckout from "./scheduledcheckout";
|
|
49
|
+
export * from "./scheduledcheckout/client/requests";
|
|
50
|
+
export * from "./scheduledcheckout/types";
|
|
43
51
|
export * as webhooks from "./webhooks";
|
|
44
52
|
export * from "./webhooks/client/requests";
|
|
45
53
|
export * from "./webhooks/types";
|