@schematichq/schematic-typescript-node 1.3.0 → 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 +12 -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/Client.d.ts +0 -3
- package/dist/api/resources/billing/client/requests/CountBillingProductsRequest.d.ts +1 -1
- package/dist/api/resources/billing/client/requests/CountCustomersRequest.d.ts +0 -2
- package/dist/api/resources/billing/client/requests/CreateBillingCustomerRequestBody.d.ts +0 -2
- package/dist/api/resources/billing/client/requests/CreateInvoiceRequestBody.d.ts +2 -0
- package/dist/api/resources/billing/client/requests/ListBillingProductsRequest.d.ts +1 -1
- package/dist/api/resources/billing/client/requests/ListCustomersWithSubscriptionsRequest.d.ts +0 -2
- package/dist/api/resources/billing/types/CountBillingProductsParams.d.ts +1 -1
- package/dist/api/resources/billing/types/CountCustomersParams.d.ts +0 -1
- package/dist/api/resources/billing/types/ListBillingProductsParams.d.ts +1 -1
- package/dist/api/resources/billing/types/ListCustomersWithSubscriptionsParams.d.ts +0 -1
- 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 +71 -0
- package/dist/api/resources/credits/client/requests/CountBillingPlanCreditGrantsRequest.d.ts +3 -1
- package/dist/api/resources/credits/client/requests/CountCompanyGrantsRequest.d.ts +20 -0
- 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 +3 -2
- package/dist/api/resources/credits/types/CountBillingPlanCreditGrantsParams.d.ts +1 -0
- package/dist/api/resources/credits/types/CountCompanyGrantsParams.d.ts +13 -0
- package/dist/api/resources/credits/types/CountCompanyGrantsResponse.d.ts +6 -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 +6 -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 +11 -0
- package/dist/api/resources/planbundle/client/Client.d.ts +52 -0
- package/dist/api/resources/planbundle/client/index.d.ts +1 -0
- package/dist/api/resources/planbundle/client/requests/CreatePlanBundleRequestBody.d.ts +16 -0
- package/dist/api/resources/planbundle/client/requests/UpdatePlanBundleRequestBody.d.ts +17 -0
- package/dist/api/resources/planbundle/client/requests/index.d.ts +2 -0
- package/dist/api/resources/planbundle/index.d.ts +2 -0
- package/dist/api/resources/planbundle/types/CreatePlanBundleResponse.d.ts +6 -0
- package/dist/api/resources/planbundle/types/UpdatePlanBundleResponse.d.ts +6 -0
- package/dist/api/resources/planbundle/types/index.d.ts +2 -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 -3
- 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/BillingCreditGrantResponseData.d.ts +2 -0
- package/dist/api/types/BillingCreditResponseData.d.ts +1 -0
- package/dist/api/types/BillingCreditView.d.ts +22 -0
- package/dist/api/types/BillingCustomerResponseData.d.ts +0 -1
- package/dist/api/types/BillingCustomerWithSubscriptionsResponseData.d.ts +0 -1
- 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 +3 -0
- package/dist/api/types/CompanyPlanWithBillingSubView.d.ts +1 -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/{resources/credits/client/requests → types}/CreateBillingPlanCreditGrantRequestBody.d.ts +2 -11
- package/dist/api/types/CreateEntitlementInBundleRequestBody.d.ts +31 -0
- package/dist/api/types/CreateEntitlementInBundleRequestBodyMetricPeriod.d.ts +7 -0
- package/dist/api/types/CreateEntitlementInBundleRequestBodyMetricPeriodMonthReset.d.ts +5 -0
- package/dist/api/types/CreateEventRequestBody.d.ts +1 -0
- package/dist/api/types/CreatePlanRequestBody.d.ts +7 -0
- package/dist/api/types/CreditCompanyGrantView.d.ts +2 -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/DeleteBillingPlanCreditGrantRequestBody.d.ts +3 -0
- package/dist/api/types/EventDetailResponseData.d.ts +1 -1
- package/dist/api/types/EventResponseData.d.ts +1 -1
- 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/PlanBundleAction.d.ts +6 -0
- package/dist/api/types/PlanBundleCreditGrantRequestBody.d.ts +8 -0
- package/dist/api/types/PlanBundleEntitlementRequestBody.d.ts +6 -0
- package/dist/api/types/PlanBundleResponseData.d.ts +8 -0
- package/dist/api/types/PlanChangeAction.d.ts +1 -0
- package/dist/api/types/PlanChangeResponseData.d.ts +4 -2
- package/dist/api/types/PlanChangeSubscriptionAction.d.ts +1 -0
- package/dist/api/types/PlanCreditGrantView.d.ts +10 -3
- package/dist/api/types/PlanDetailResponseData.d.ts +3 -0
- package/dist/api/types/PlanGroupDetailResponseData.d.ts +2 -0
- package/dist/api/types/PlanGroupPlanDetailResponseData.d.ts +3 -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/PlanVersionResponseData.d.ts +14 -0
- package/dist/api/types/PlanVersionStatus.d.ts +6 -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/RawEventResponseData.d.ts +1 -1
- 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/{resources/credits/client/requests → types}/UpdateBillingPlanCreditGrantRequestBody.d.ts +1 -8
- package/dist/api/{resources/plans/client/requests → types}/UpdatePlanRequestBody.d.ts +0 -6
- package/dist/api/{resources/plans/client/requests → types}/UpsertBillingProductRequestBody.d.ts +1 -8
- 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 +3 -0
- package/dist/api/types/WhoAmIResponseData.d.ts +12 -0
- package/dist/api/types/index.d.ts +58 -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/CreateBillingCustomerRequestBody.d.ts +0 -1
- package/dist/serialization/resources/billing/client/requests/CreateInvoiceRequestBody.d.ts +2 -0
- package/dist/serialization/resources/billing/types/CountCustomersParams.d.ts +0 -1
- package/dist/serialization/resources/billing/types/ListCustomersWithSubscriptionsParams.d.ts +0 -1
- 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/client/requests/index.d.ts +0 -2
- package/dist/serialization/resources/credits/types/CountBillingPlanCreditGrantsParams.d.ts +1 -0
- package/dist/serialization/resources/credits/types/CountCompanyGrantsParams.d.ts +15 -0
- package/dist/serialization/resources/credits/types/CountCompanyGrantsResponse.d.ts +12 -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 +6 -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 +10 -0
- package/dist/serialization/resources/planbundle/client/index.d.ts +1 -0
- package/dist/serialization/resources/planbundle/client/requests/CreatePlanBundleRequestBody.d.ts +18 -0
- package/dist/serialization/resources/planbundle/client/requests/UpdatePlanBundleRequestBody.d.ts +19 -0
- package/dist/serialization/resources/planbundle/client/requests/index.d.ts +2 -0
- package/dist/serialization/resources/planbundle/index.d.ts +2 -0
- package/dist/serialization/resources/planbundle/types/CreatePlanBundleResponse.d.ts +11 -0
- package/dist/serialization/resources/planbundle/types/UpdatePlanBundleResponse.d.ts +11 -0
- package/dist/serialization/resources/planbundle/types/index.d.ts +2 -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 -3
- 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/BillingCreditGrantResponseData.d.ts +3 -0
- package/dist/serialization/types/BillingCreditResponseData.d.ts +1 -0
- package/dist/serialization/types/BillingCreditView.d.ts +32 -0
- package/dist/serialization/types/BillingCustomerResponseData.d.ts +0 -1
- package/dist/serialization/types/BillingCustomerWithSubscriptionsResponseData.d.ts +0 -1
- 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 +4 -0
- package/dist/serialization/types/CompanyPlanWithBillingSubView.d.ts +1 -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/{resources/credits/client/requests → types}/CreateBillingPlanCreditGrantRequestBody.d.ts +11 -10
- package/dist/serialization/types/CreateEntitlementInBundleRequestBody.d.ts +41 -0
- package/dist/serialization/types/CreateEntitlementInBundleRequestBodyMetricPeriod.d.ts +7 -0
- package/dist/serialization/types/CreateEntitlementInBundleRequestBodyMetricPeriodMonthReset.d.ts +7 -0
- package/dist/serialization/types/CreatePlanRequestBody.d.ts +13 -0
- package/dist/serialization/types/CreditCompanyGrantView.d.ts +3 -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/DeleteBillingPlanCreditGrantRequestBody.d.ts +9 -0
- package/dist/serialization/types/EventDetailResponseData.d.ts +1 -1
- package/dist/serialization/types/EventResponseData.d.ts +1 -1
- 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/PlanBundleAction.d.ts +7 -0
- package/dist/serialization/types/PlanBundleCreditGrantRequestBody.d.ts +17 -0
- package/dist/serialization/types/PlanBundleEntitlementRequestBody.d.ts +13 -0
- package/dist/serialization/types/PlanBundleResponseData.d.ts +18 -0
- package/dist/serialization/types/PlanChangeAction.d.ts +1 -1
- package/dist/serialization/types/PlanChangeResponseData.d.ts +4 -4
- package/dist/serialization/types/PlanChangeSubscriptionAction.d.ts +1 -1
- package/dist/serialization/types/PlanCreditGrantView.d.ts +7 -3
- package/dist/serialization/types/PlanDetailResponseData.d.ts +4 -0
- package/dist/serialization/types/PlanGroupDetailResponseData.d.ts +2 -0
- package/dist/serialization/types/PlanGroupPlanDetailResponseData.d.ts +4 -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/PlanVersionResponseData.d.ts +21 -0
- package/dist/serialization/types/PlanVersionStatus.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/RawEventResponseData.d.ts +1 -1
- 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/{resources/credits/client/requests → types}/UpdateBillingPlanCreditGrantRequestBody.d.ts +10 -10
- package/dist/serialization/types/UpdatePlanRequestBody.d.ts +11 -0
- package/dist/serialization/{resources/plans/client/requests → types}/UpsertBillingProductRequestBody.d.ts +5 -5
- 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 +58 -6
- package/dist/wrapper.d.ts +58 -5
- 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/resources/plans/client/requests/CreatePlanRequestBody.d.ts +0 -15
- 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/resources/plans/client/requests/CreatePlanRequestBody.d.ts +0 -13
- package/dist/serialization/resources/plans/client/requests/UpdatePlanRequestBody.d.ts +0 -11
- 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
package/README.md
CHANGED
|
@@ -30,7 +30,7 @@ client.close();
|
|
|
30
30
|
By default, the client will do some local caching for flag checks. If you would like to change this behavior, you can do so using an initialization option to specify the max size of the cache (in terms of number of records) and the max age of the cache (in milliseconds):
|
|
31
31
|
|
|
32
32
|
```ts
|
|
33
|
-
import { LocalCache, SchematicClient } from "@schematichq/schematic-typescript-node";
|
|
33
|
+
import { LocalCache, SchematicClient, type CheckFlagWithEntitlementResponse } from "@schematichq/schematic-typescript-node";
|
|
34
34
|
|
|
35
35
|
const apiKey = process.env.SCHEMATIC_API_KEY;
|
|
36
36
|
const cacheSize = 100;
|
|
@@ -38,7 +38,7 @@ const cacheTTL = 1000; // in milliseconds
|
|
|
38
38
|
const client = new SchematicClient({
|
|
39
39
|
apiKey,
|
|
40
40
|
cacheProviders: {
|
|
41
|
-
flagChecks: [new LocalCache<
|
|
41
|
+
flagChecks: [new LocalCache<CheckFlagWithEntitlementResponse>({ maxItems: cacheSize, ttl: cacheTTL })],
|
|
42
42
|
},
|
|
43
43
|
});
|
|
44
44
|
|
|
@@ -340,6 +340,40 @@ client
|
|
|
340
340
|
client.close();
|
|
341
341
|
```
|
|
342
342
|
|
|
343
|
+
### Checking flags with entitlement details
|
|
344
|
+
|
|
345
|
+
If you need more detail about how a flag check was resolved, including any entitlement associated with the check, use `checkFlagWithEntitlement`. This returns a response object with the flag value, the reason for the evaluation result, and entitlement details such as usage, allocation, and credit balances when applicable.
|
|
346
|
+
|
|
347
|
+
```ts
|
|
348
|
+
import { SchematicClient } from "@schematichq/schematic-typescript-node";
|
|
349
|
+
|
|
350
|
+
const apiKey = process.env.SCHEMATIC_API_KEY;
|
|
351
|
+
const client = new SchematicClient({ apiKey });
|
|
352
|
+
|
|
353
|
+
const evaluationCtx = {
|
|
354
|
+
company: { id: "your-company-id" },
|
|
355
|
+
user: {
|
|
356
|
+
email: "wcoyote@acme.net",
|
|
357
|
+
userId: "your-user-id",
|
|
358
|
+
},
|
|
359
|
+
};
|
|
360
|
+
|
|
361
|
+
client
|
|
362
|
+
.checkFlagWithEntitlement(evaluationCtx, "some-flag-key")
|
|
363
|
+
.then((resp) => {
|
|
364
|
+
console.log(`Flag: ${resp.flagKey}, Value: ${resp.value}, Reason: ${resp.reason}`);
|
|
365
|
+
|
|
366
|
+
if (resp.entitlement) {
|
|
367
|
+
console.log(`Entitlement type: ${resp.entitlement.valueType}`);
|
|
368
|
+
console.log(`Usage: ${resp.entitlement.usage}, Allocation: ${resp.entitlement.allocation}`);
|
|
369
|
+
console.log(`Credit remaining: ${resp.entitlement.creditRemaining}`);
|
|
370
|
+
}
|
|
371
|
+
})
|
|
372
|
+
.catch(console.error);
|
|
373
|
+
|
|
374
|
+
client.close();
|
|
375
|
+
```
|
|
376
|
+
|
|
343
377
|
### Checking multiple flags
|
|
344
378
|
|
|
345
379
|
The `checkFlags` method allows you to efficiently check multiple feature flags in a single operation. When you provide specific flag keys, it will only return the flag values for those flags, leveraging intelligent caching to minimize API calls.
|
package/dist/Client.d.ts
CHANGED
|
@@ -4,13 +4,17 @@ import { BillingClient } from "./api/resources/billing/client/Client";
|
|
|
4
4
|
import { CheckoutClient } from "./api/resources/checkout/client/Client";
|
|
5
5
|
import { CompaniesClient } from "./api/resources/companies/client/Client";
|
|
6
6
|
import { ComponentsClient } from "./api/resources/components/client/Client";
|
|
7
|
+
import { ComponentspublicClient } from "./api/resources/componentspublic/client/Client";
|
|
7
8
|
import { CreditsClient } from "./api/resources/credits/client/Client";
|
|
8
9
|
import { DataexportsClient } from "./api/resources/dataexports/client/Client";
|
|
9
10
|
import { EntitlementsClient } from "./api/resources/entitlements/client/Client";
|
|
10
11
|
import { EventsClient } from "./api/resources/events/client/Client";
|
|
11
12
|
import { FeaturesClient } from "./api/resources/features/client/Client";
|
|
13
|
+
import { PlanbundleClient } from "./api/resources/planbundle/client/Client";
|
|
12
14
|
import { PlangroupsClient } from "./api/resources/plangroups/client/Client";
|
|
15
|
+
import { PlanmigrationsClient } from "./api/resources/planmigrations/client/Client";
|
|
13
16
|
import { PlansClient } from "./api/resources/plans/client/Client";
|
|
17
|
+
import { ScheduledcheckoutClient } from "./api/resources/scheduledcheckout/client/Client";
|
|
14
18
|
import { WebhooksClient } from "./api/resources/webhooks/client/Client";
|
|
15
19
|
import type { BaseClientOptions, BaseRequestOptions } from "./BaseClient";
|
|
16
20
|
import { type NormalizedClientOptionsWithAuth } from "./BaseClient";
|
|
@@ -33,7 +37,11 @@ export declare class SchematicClient {
|
|
|
33
37
|
protected _dataexports: DataexportsClient | undefined;
|
|
34
38
|
protected _events: EventsClient | undefined;
|
|
35
39
|
protected _features: FeaturesClient | undefined;
|
|
40
|
+
protected _planbundle: PlanbundleClient | undefined;
|
|
36
41
|
protected _plangroups: PlangroupsClient | undefined;
|
|
42
|
+
protected _planmigrations: PlanmigrationsClient | undefined;
|
|
43
|
+
protected _componentspublic: ComponentspublicClient | undefined;
|
|
44
|
+
protected _scheduledcheckout: ScheduledcheckoutClient | undefined;
|
|
37
45
|
protected _accesstokens: AccesstokensClient | undefined;
|
|
38
46
|
protected _webhooks: WebhooksClient | undefined;
|
|
39
47
|
constructor(options: SchematicClient.Options);
|
|
@@ -48,7 +56,11 @@ export declare class SchematicClient {
|
|
|
48
56
|
get dataexports(): DataexportsClient;
|
|
49
57
|
get events(): EventsClient;
|
|
50
58
|
get features(): FeaturesClient;
|
|
59
|
+
get planbundle(): PlanbundleClient;
|
|
51
60
|
get plangroups(): PlangroupsClient;
|
|
61
|
+
get planmigrations(): PlanmigrationsClient;
|
|
62
|
+
get componentspublic(): ComponentspublicClient;
|
|
63
|
+
get scheduledcheckout(): ScheduledcheckoutClient;
|
|
52
64
|
get accesstokens(): AccesstokensClient;
|
|
53
65
|
get webhooks(): WebhooksClient;
|
|
54
66
|
/**
|
|
@@ -113,7 +113,7 @@ export declare class AccountsClient {
|
|
|
113
113
|
countApiKeys(request: Schematic.CountApiKeysRequest, requestOptions?: AccountsClient.RequestOptions): core.HttpResponsePromise<Schematic.CountApiKeysResponse>;
|
|
114
114
|
private __countApiKeys;
|
|
115
115
|
/**
|
|
116
|
-
* @param {Schematic.
|
|
116
|
+
* @param {Schematic.ListAuditLogsRequest} request
|
|
117
117
|
* @param {AccountsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
118
118
|
*
|
|
119
119
|
* @throws {@link Schematic.BadRequestError}
|
|
@@ -123,18 +123,20 @@ export declare class AccountsClient {
|
|
|
123
123
|
* @throws {@link Schematic.InternalServerError}
|
|
124
124
|
*
|
|
125
125
|
* @example
|
|
126
|
-
* await client.accounts.
|
|
127
|
-
*
|
|
128
|
-
*
|
|
126
|
+
* await client.accounts.listAuditLogs({
|
|
127
|
+
* actorType: "api_key",
|
|
128
|
+
* endTime: new Date("2024-01-15T09:30:00.000Z"),
|
|
129
129
|
* environmentId: "environment_id",
|
|
130
|
+
* q: "q",
|
|
131
|
+
* startTime: new Date("2024-01-15T09:30:00.000Z"),
|
|
130
132
|
* limit: 1,
|
|
131
133
|
* offset: 1
|
|
132
134
|
* })
|
|
133
135
|
*/
|
|
134
|
-
|
|
135
|
-
private
|
|
136
|
+
listAuditLogs(request?: Schematic.ListAuditLogsRequest, requestOptions?: AccountsClient.RequestOptions): core.HttpResponsePromise<Schematic.ListAuditLogsResponse>;
|
|
137
|
+
private __listAuditLogs;
|
|
136
138
|
/**
|
|
137
|
-
* @param {string}
|
|
139
|
+
* @param {string} audit_log_id - audit_log_id
|
|
138
140
|
* @param {AccountsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
139
141
|
*
|
|
140
142
|
* @throws {@link Schematic.UnauthorizedError}
|
|
@@ -143,12 +145,12 @@ export declare class AccountsClient {
|
|
|
143
145
|
* @throws {@link Schematic.InternalServerError}
|
|
144
146
|
*
|
|
145
147
|
* @example
|
|
146
|
-
* await client.accounts.
|
|
148
|
+
* await client.accounts.getAuditLog("audit_log_id")
|
|
147
149
|
*/
|
|
148
|
-
|
|
149
|
-
private
|
|
150
|
+
getAuditLog(audit_log_id: string, requestOptions?: AccountsClient.RequestOptions): core.HttpResponsePromise<Schematic.GetAuditLogResponse>;
|
|
151
|
+
private __getAuditLog;
|
|
150
152
|
/**
|
|
151
|
-
* @param {Schematic.
|
|
153
|
+
* @param {Schematic.CountAuditLogsRequest} request
|
|
152
154
|
* @param {AccountsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
153
155
|
*
|
|
154
156
|
* @throws {@link Schematic.BadRequestError}
|
|
@@ -158,16 +160,18 @@ export declare class AccountsClient {
|
|
|
158
160
|
* @throws {@link Schematic.InternalServerError}
|
|
159
161
|
*
|
|
160
162
|
* @example
|
|
161
|
-
* await client.accounts.
|
|
162
|
-
*
|
|
163
|
-
*
|
|
163
|
+
* await client.accounts.countAuditLogs({
|
|
164
|
+
* actorType: "api_key",
|
|
165
|
+
* endTime: new Date("2024-01-15T09:30:00.000Z"),
|
|
164
166
|
* environmentId: "environment_id",
|
|
167
|
+
* q: "q",
|
|
168
|
+
* startTime: new Date("2024-01-15T09:30:00.000Z"),
|
|
165
169
|
* limit: 1,
|
|
166
170
|
* offset: 1
|
|
167
171
|
* })
|
|
168
172
|
*/
|
|
169
|
-
|
|
170
|
-
private
|
|
173
|
+
countAuditLogs(request?: Schematic.CountAuditLogsRequest, requestOptions?: AccountsClient.RequestOptions): core.HttpResponsePromise<Schematic.CountAuditLogsResponse>;
|
|
174
|
+
private __countAuditLogs;
|
|
171
175
|
/**
|
|
172
176
|
* @param {Schematic.ListEnvironmentsRequest} request
|
|
173
177
|
* @param {AccountsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -263,4 +267,17 @@ export declare class AccountsClient {
|
|
|
263
267
|
*/
|
|
264
268
|
quickstart(requestOptions?: AccountsClient.RequestOptions): core.HttpResponsePromise<Schematic.QuickstartResponse>;
|
|
265
269
|
private __quickstart;
|
|
270
|
+
/**
|
|
271
|
+
* @param {AccountsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
272
|
+
*
|
|
273
|
+
* @throws {@link Schematic.UnauthorizedError}
|
|
274
|
+
* @throws {@link Schematic.ForbiddenError}
|
|
275
|
+
* @throws {@link Schematic.NotFoundError}
|
|
276
|
+
* @throws {@link Schematic.InternalServerError}
|
|
277
|
+
*
|
|
278
|
+
* @example
|
|
279
|
+
* await client.accounts.getWhoAmI()
|
|
280
|
+
*/
|
|
281
|
+
getWhoAmI(requestOptions?: AccountsClient.RequestOptions): core.HttpResponsePromise<Schematic.GetWhoAmIResponse>;
|
|
282
|
+
private __getWhoAmI;
|
|
266
283
|
}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import type * as Schematic from "../../../../index";
|
|
2
|
+
/**
|
|
3
|
+
* @example
|
|
4
|
+
* {
|
|
5
|
+
* actorType: "api_key",
|
|
6
|
+
* endTime: new Date("2024-01-15T09:30:00.000Z"),
|
|
7
|
+
* environmentId: "environment_id",
|
|
8
|
+
* q: "q",
|
|
9
|
+
* startTime: new Date("2024-01-15T09:30:00.000Z"),
|
|
10
|
+
* limit: 1,
|
|
11
|
+
* offset: 1
|
|
12
|
+
* }
|
|
13
|
+
*/
|
|
14
|
+
export interface CountAuditLogsRequest {
|
|
15
|
+
actorType?: Schematic.ActorType;
|
|
16
|
+
endTime?: Date;
|
|
17
|
+
environmentId?: string;
|
|
18
|
+
q?: string;
|
|
19
|
+
startTime?: Date;
|
|
20
|
+
/** Page limit (default 100) */
|
|
21
|
+
limit?: number;
|
|
22
|
+
/** Page offset (default 0) */
|
|
23
|
+
offset?: number;
|
|
24
|
+
}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import type * as Schematic from "../../../../index";
|
|
2
|
+
/**
|
|
3
|
+
* @example
|
|
4
|
+
* {
|
|
5
|
+
* actorType: "api_key",
|
|
6
|
+
* endTime: new Date("2024-01-15T09:30:00.000Z"),
|
|
7
|
+
* environmentId: "environment_id",
|
|
8
|
+
* q: "q",
|
|
9
|
+
* startTime: new Date("2024-01-15T09:30:00.000Z"),
|
|
10
|
+
* limit: 1,
|
|
11
|
+
* offset: 1
|
|
12
|
+
* }
|
|
13
|
+
*/
|
|
14
|
+
export interface ListAuditLogsRequest {
|
|
15
|
+
actorType?: Schematic.ActorType;
|
|
16
|
+
endTime?: Date;
|
|
17
|
+
environmentId?: string;
|
|
18
|
+
q?: string;
|
|
19
|
+
startTime?: Date;
|
|
20
|
+
/** Page limit (default 100) */
|
|
21
|
+
limit?: number;
|
|
22
|
+
/** Page offset (default 0) */
|
|
23
|
+
offset?: number;
|
|
24
|
+
}
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
export type { CountApiKeysRequest } from "./CountApiKeysRequest";
|
|
2
|
-
export type {
|
|
2
|
+
export type { CountAuditLogsRequest } from "./CountAuditLogsRequest";
|
|
3
3
|
export type { CreateApiKeyRequestBody } from "./CreateApiKeyRequestBody";
|
|
4
4
|
export type { CreateEnvironmentRequestBody } from "./CreateEnvironmentRequestBody";
|
|
5
5
|
export type { ListApiKeysRequest } from "./ListApiKeysRequest";
|
|
6
|
-
export type {
|
|
6
|
+
export type { ListAuditLogsRequest } from "./ListAuditLogsRequest";
|
|
7
7
|
export type { ListEnvironmentsRequest } from "./ListEnvironmentsRequest";
|
|
8
8
|
export type { UpdateApiKeyRequestBody } from "./UpdateApiKeyRequestBody";
|
|
9
9
|
export type { UpdateEnvironmentRequestBody } from "./UpdateEnvironmentRequestBody";
|
package/dist/api/resources/accounts/types/{ListApiRequestsParams.d.ts → CountAuditLogsParams.d.ts}
RENAMED
|
@@ -1,12 +1,15 @@
|
|
|
1
|
+
import type * as Schematic from "../../../index";
|
|
1
2
|
/**
|
|
2
3
|
* Input parameters
|
|
3
4
|
*/
|
|
4
|
-
export interface
|
|
5
|
+
export interface CountAuditLogsParams {
|
|
6
|
+
actorType?: Schematic.ActorType;
|
|
7
|
+
endTime?: Date;
|
|
5
8
|
environmentId?: string;
|
|
6
9
|
/** Page limit (default 100) */
|
|
7
10
|
limit?: number;
|
|
8
11
|
/** Page offset (default 0) */
|
|
9
12
|
offset?: number;
|
|
10
13
|
q?: string;
|
|
11
|
-
|
|
14
|
+
startTime?: Date;
|
|
12
15
|
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type * as Schematic from "../../../index";
|
|
2
|
-
export interface
|
|
2
|
+
export interface CountAuditLogsResponse {
|
|
3
3
|
data: Schematic.CountResponse;
|
|
4
4
|
/** Input parameters */
|
|
5
|
-
params: Schematic.
|
|
5
|
+
params: Schematic.CountAuditLogsParams;
|
|
6
6
|
}
|
package/dist/api/resources/accounts/types/{GetApiRequestResponse.d.ts → GetAuditLogResponse.d.ts}
RENAMED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type * as Schematic from "../../../index";
|
|
2
|
-
export interface
|
|
3
|
-
data: Schematic.
|
|
2
|
+
export interface GetAuditLogResponse {
|
|
3
|
+
data: Schematic.AuditLogResponseData;
|
|
4
4
|
/** Input parameters */
|
|
5
5
|
params: Record<string, unknown>;
|
|
6
6
|
}
|
package/dist/api/resources/accounts/types/{CountApiRequestsParams.d.ts → ListAuditLogsParams.d.ts}
RENAMED
|
@@ -1,12 +1,15 @@
|
|
|
1
|
+
import type * as Schematic from "../../../index";
|
|
1
2
|
/**
|
|
2
3
|
* Input parameters
|
|
3
4
|
*/
|
|
4
|
-
export interface
|
|
5
|
+
export interface ListAuditLogsParams {
|
|
6
|
+
actorType?: Schematic.ActorType;
|
|
7
|
+
endTime?: Date;
|
|
5
8
|
environmentId?: string;
|
|
6
9
|
/** Page limit (default 100) */
|
|
7
10
|
limit?: number;
|
|
8
11
|
/** Page offset (default 0) */
|
|
9
12
|
offset?: number;
|
|
10
13
|
q?: string;
|
|
11
|
-
|
|
14
|
+
startTime?: Date;
|
|
12
15
|
}
|
|
@@ -1,18 +1,19 @@
|
|
|
1
1
|
export * from "./CountApiKeysParams";
|
|
2
2
|
export * from "./CountApiKeysResponse";
|
|
3
|
-
export * from "./
|
|
4
|
-
export * from "./
|
|
3
|
+
export * from "./CountAuditLogsParams";
|
|
4
|
+
export * from "./CountAuditLogsResponse";
|
|
5
5
|
export * from "./CreateApiKeyResponse";
|
|
6
6
|
export * from "./CreateEnvironmentResponse";
|
|
7
7
|
export * from "./DeleteApiKeyResponse";
|
|
8
8
|
export * from "./DeleteEnvironmentResponse";
|
|
9
9
|
export * from "./GetApiKeyResponse";
|
|
10
|
-
export * from "./
|
|
10
|
+
export * from "./GetAuditLogResponse";
|
|
11
11
|
export * from "./GetEnvironmentResponse";
|
|
12
|
+
export * from "./GetWhoAmIResponse";
|
|
12
13
|
export * from "./ListApiKeysParams";
|
|
13
14
|
export * from "./ListApiKeysResponse";
|
|
14
|
-
export * from "./
|
|
15
|
-
export * from "./
|
|
15
|
+
export * from "./ListAuditLogsParams";
|
|
16
|
+
export * from "./ListAuditLogsResponse";
|
|
16
17
|
export * from "./ListEnvironmentsParams";
|
|
17
18
|
export * from "./ListEnvironmentsResponse";
|
|
18
19
|
export * from "./QuickstartResponse";
|
|
@@ -68,7 +68,6 @@ export declare class BillingClient {
|
|
|
68
68
|
* await client.billing.upsertBillingCustomer({
|
|
69
69
|
* email: "email",
|
|
70
70
|
* externalId: "external_id",
|
|
71
|
-
* failedToImport: true,
|
|
72
71
|
* meta: {
|
|
73
72
|
* "key": "value"
|
|
74
73
|
* },
|
|
@@ -89,7 +88,6 @@ export declare class BillingClient {
|
|
|
89
88
|
*
|
|
90
89
|
* @example
|
|
91
90
|
* await client.billing.listCustomersWithSubscriptions({
|
|
92
|
-
* failedToImport: true,
|
|
93
91
|
* name: "name",
|
|
94
92
|
* providerType: "schematic",
|
|
95
93
|
* q: "q",
|
|
@@ -111,7 +109,6 @@ export declare class BillingClient {
|
|
|
111
109
|
*
|
|
112
110
|
* @example
|
|
113
111
|
* await client.billing.countCustomers({
|
|
114
|
-
* failedToImport: true,
|
|
115
112
|
* name: "name",
|
|
116
113
|
* providerType: "schematic",
|
|
117
114
|
* q: "q",
|
|
@@ -17,7 +17,7 @@ import type * as Schematic from "../../../../index";
|
|
|
17
17
|
*/
|
|
18
18
|
export interface CountBillingProductsRequest {
|
|
19
19
|
ids?: string | string[];
|
|
20
|
-
/** Filter products that are active */
|
|
20
|
+
/** Filter products that are active. Defaults to true if not specified */
|
|
21
21
|
isActive?: boolean;
|
|
22
22
|
name?: string;
|
|
23
23
|
priceUsageType?: Schematic.BillingPriceUsageType;
|
|
@@ -2,7 +2,6 @@ import type * as Schematic from "../../../../index";
|
|
|
2
2
|
/**
|
|
3
3
|
* @example
|
|
4
4
|
* {
|
|
5
|
-
* failedToImport: true,
|
|
6
5
|
* name: "name",
|
|
7
6
|
* providerType: "schematic",
|
|
8
7
|
* q: "q",
|
|
@@ -12,7 +11,6 @@ import type * as Schematic from "../../../../index";
|
|
|
12
11
|
*/
|
|
13
12
|
export interface CountCustomersRequest {
|
|
14
13
|
companyIds?: string | string[];
|
|
15
|
-
failedToImport?: boolean;
|
|
16
14
|
name?: string;
|
|
17
15
|
providerType?: Schematic.BillingProviderType;
|
|
18
16
|
q?: string;
|
|
@@ -4,7 +4,6 @@ import type * as Schematic from "../../../../index";
|
|
|
4
4
|
* {
|
|
5
5
|
* email: "email",
|
|
6
6
|
* externalId: "external_id",
|
|
7
|
-
* failedToImport: true,
|
|
8
7
|
* meta: {
|
|
9
8
|
* "key": "value"
|
|
10
9
|
* },
|
|
@@ -16,7 +15,6 @@ export interface CreateBillingCustomerRequestBody {
|
|
|
16
15
|
defaultPaymentMethodId?: string;
|
|
17
16
|
email: string;
|
|
18
17
|
externalId: string;
|
|
19
|
-
failedToImport: boolean;
|
|
20
18
|
meta: Record<string, string>;
|
|
21
19
|
name: string;
|
|
22
20
|
providerType?: Schematic.BillingProviderType;
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type * as Schematic from "../../../../index";
|
|
1
2
|
/**
|
|
2
3
|
* @example
|
|
3
4
|
* {
|
|
@@ -20,6 +21,7 @@ export interface CreateInvoiceRequestBody {
|
|
|
20
21
|
dueDate?: Date;
|
|
21
22
|
externalId?: string;
|
|
22
23
|
paymentMethodExternalId?: string;
|
|
24
|
+
status?: Schematic.InvoiceStatus;
|
|
23
25
|
subscriptionExternalId?: string;
|
|
24
26
|
subtotal: number;
|
|
25
27
|
url?: string;
|
|
@@ -17,7 +17,7 @@ import type * as Schematic from "../../../../index";
|
|
|
17
17
|
*/
|
|
18
18
|
export interface ListBillingProductsRequest {
|
|
19
19
|
ids?: string | string[];
|
|
20
|
-
/** Filter products that are active */
|
|
20
|
+
/** Filter products that are active. Defaults to true if not specified */
|
|
21
21
|
isActive?: boolean;
|
|
22
22
|
name?: string;
|
|
23
23
|
priceUsageType?: Schematic.BillingPriceUsageType;
|
package/dist/api/resources/billing/client/requests/ListCustomersWithSubscriptionsRequest.d.ts
CHANGED
|
@@ -2,7 +2,6 @@ import type * as Schematic from "../../../../index";
|
|
|
2
2
|
/**
|
|
3
3
|
* @example
|
|
4
4
|
* {
|
|
5
|
-
* failedToImport: true,
|
|
6
5
|
* name: "name",
|
|
7
6
|
* providerType: "schematic",
|
|
8
7
|
* q: "q",
|
|
@@ -12,7 +11,6 @@ import type * as Schematic from "../../../../index";
|
|
|
12
11
|
*/
|
|
13
12
|
export interface ListCustomersWithSubscriptionsRequest {
|
|
14
13
|
companyIds?: string | string[];
|
|
15
|
-
failedToImport?: boolean;
|
|
16
14
|
name?: string;
|
|
17
15
|
providerType?: Schematic.BillingProviderType;
|
|
18
16
|
q?: string;
|
|
@@ -4,7 +4,7 @@ import type * as Schematic from "../../../index";
|
|
|
4
4
|
*/
|
|
5
5
|
export interface CountBillingProductsParams {
|
|
6
6
|
ids?: string[];
|
|
7
|
-
/** Filter products that are active */
|
|
7
|
+
/** Filter products that are active. Defaults to true if not specified */
|
|
8
8
|
isActive?: boolean;
|
|
9
9
|
/** Page limit (default 100) */
|
|
10
10
|
limit?: number;
|
|
@@ -4,7 +4,7 @@ import type * as Schematic from "../../../index";
|
|
|
4
4
|
*/
|
|
5
5
|
export interface ListBillingProductsParams {
|
|
6
6
|
ids?: string[];
|
|
7
|
-
/** Filter products that are active */
|
|
7
|
+
/** Filter products that are active. Defaults to true if not specified */
|
|
8
8
|
isActive?: boolean;
|
|
9
9
|
/** Page limit (default 100) */
|
|
10
10
|
limit?: number;
|
|
@@ -22,10 +22,16 @@ export declare class CompaniesClient {
|
|
|
22
22
|
*
|
|
23
23
|
* @example
|
|
24
24
|
* await client.companies.listCompanies({
|
|
25
|
+
* monetizedSubscriptions: true,
|
|
25
26
|
* planId: "plan_id",
|
|
27
|
+
* planVersionId: "plan_version_id",
|
|
26
28
|
* q: "q",
|
|
29
|
+
* sortOrderColumn: "sort_order_column",
|
|
30
|
+
* sortOrderDirection: "asc",
|
|
31
|
+
* withEntitlementFor: "with_entitlement_for",
|
|
27
32
|
* withoutFeatureOverrideFor: "without_feature_override_for",
|
|
28
33
|
* withoutPlan: true,
|
|
34
|
+
* withoutSubscription: true,
|
|
29
35
|
* withSubscription: true,
|
|
30
36
|
* limit: 1,
|
|
31
37
|
* offset: 1
|
|
@@ -97,10 +103,16 @@ export declare class CompaniesClient {
|
|
|
97
103
|
*
|
|
98
104
|
* @example
|
|
99
105
|
* await client.companies.countCompanies({
|
|
106
|
+
* monetizedSubscriptions: true,
|
|
100
107
|
* planId: "plan_id",
|
|
108
|
+
* planVersionId: "plan_version_id",
|
|
101
109
|
* q: "q",
|
|
110
|
+
* sortOrderColumn: "sort_order_column",
|
|
111
|
+
* sortOrderDirection: "asc",
|
|
112
|
+
* withEntitlementFor: "with_entitlement_for",
|
|
102
113
|
* withoutFeatureOverrideFor: "without_feature_override_for",
|
|
103
114
|
* withoutPlan: true,
|
|
115
|
+
* withoutSubscription: true,
|
|
104
116
|
* withSubscription: true,
|
|
105
117
|
* limit: 1,
|
|
106
118
|
* offset: 1
|
|
@@ -108,30 +120,6 @@ export declare class CompaniesClient {
|
|
|
108
120
|
*/
|
|
109
121
|
countCompanies(request?: Schematic.CountCompaniesRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.CountCompaniesResponse>;
|
|
110
122
|
private __countCompanies;
|
|
111
|
-
/**
|
|
112
|
-
* @param {Schematic.CountCompaniesForAdvancedFilterRequest} request
|
|
113
|
-
* @param {CompaniesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
114
|
-
*
|
|
115
|
-
* @throws {@link Schematic.BadRequestError}
|
|
116
|
-
* @throws {@link Schematic.UnauthorizedError}
|
|
117
|
-
* @throws {@link Schematic.ForbiddenError}
|
|
118
|
-
* @throws {@link Schematic.NotFoundError}
|
|
119
|
-
* @throws {@link Schematic.InternalServerError}
|
|
120
|
-
*
|
|
121
|
-
* @example
|
|
122
|
-
* await client.companies.countCompaniesForAdvancedFilter({
|
|
123
|
-
* monetizedSubscriptions: true,
|
|
124
|
-
* q: "q",
|
|
125
|
-
* withoutPlan: true,
|
|
126
|
-
* withoutSubscription: true,
|
|
127
|
-
* sortOrderColumn: "sort_order_column",
|
|
128
|
-
* sortOrderDirection: "asc",
|
|
129
|
-
* limit: 1,
|
|
130
|
-
* offset: 1
|
|
131
|
-
* })
|
|
132
|
-
*/
|
|
133
|
-
countCompaniesForAdvancedFilter(request?: Schematic.CountCompaniesForAdvancedFilterRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.CountCompaniesForAdvancedFilterResponse>;
|
|
134
|
-
private __countCompaniesForAdvancedFilter;
|
|
135
123
|
/**
|
|
136
124
|
* @param {Schematic.UpsertCompanyRequestBody} request
|
|
137
125
|
* @param {CompaniesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -170,30 +158,6 @@ export declare class CompaniesClient {
|
|
|
170
158
|
*/
|
|
171
159
|
deleteCompanyByKeys(request: Schematic.KeysRequestBody, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.DeleteCompanyByKeysResponse>;
|
|
172
160
|
private __deleteCompanyByKeys;
|
|
173
|
-
/**
|
|
174
|
-
* @param {Schematic.ListCompaniesForAdvancedFilterRequest} request
|
|
175
|
-
* @param {CompaniesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
176
|
-
*
|
|
177
|
-
* @throws {@link Schematic.BadRequestError}
|
|
178
|
-
* @throws {@link Schematic.UnauthorizedError}
|
|
179
|
-
* @throws {@link Schematic.ForbiddenError}
|
|
180
|
-
* @throws {@link Schematic.NotFoundError}
|
|
181
|
-
* @throws {@link Schematic.InternalServerError}
|
|
182
|
-
*
|
|
183
|
-
* @example
|
|
184
|
-
* await client.companies.listCompaniesForAdvancedFilter({
|
|
185
|
-
* monetizedSubscriptions: true,
|
|
186
|
-
* q: "q",
|
|
187
|
-
* withoutPlan: true,
|
|
188
|
-
* withoutSubscription: true,
|
|
189
|
-
* sortOrderColumn: "sort_order_column",
|
|
190
|
-
* sortOrderDirection: "asc",
|
|
191
|
-
* limit: 1,
|
|
192
|
-
* offset: 1
|
|
193
|
-
* })
|
|
194
|
-
*/
|
|
195
|
-
listCompaniesForAdvancedFilter(request?: Schematic.ListCompaniesForAdvancedFilterRequest, requestOptions?: CompaniesClient.RequestOptions): core.HttpResponsePromise<Schematic.ListCompaniesForAdvancedFilterResponse>;
|
|
196
|
-
private __listCompaniesForAdvancedFilter;
|
|
197
161
|
/**
|
|
198
162
|
* @param {Schematic.LookupCompanyRequest} request
|
|
199
163
|
* @param {CompaniesClient.RequestOptions} requestOptions - Request-specific configuration.
|