@schematichq/schematic-typescript-node 1.4.4 → 1.4.6
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/LICENSE +1 -1
- package/dist/BaseClient.d.ts +1 -1
- package/dist/Client.d.ts +14 -0
- package/dist/api/resources/accesstokens/exports.d.ts +2 -0
- package/dist/api/resources/accounts/client/Client.d.ts +43 -10
- package/dist/api/resources/accounts/client/requests/CountApiKeysRequest.d.ts +2 -2
- package/dist/api/resources/accounts/client/requests/CountAuditLogsRequest.d.ts +2 -2
- package/dist/api/resources/accounts/client/requests/ListAccountMembersRequest.d.ts +17 -0
- package/dist/api/resources/accounts/client/requests/ListApiKeysRequest.d.ts +2 -2
- package/dist/api/resources/accounts/client/requests/ListAuditLogsRequest.d.ts +2 -2
- package/dist/api/resources/accounts/client/requests/ListEnvironmentsRequest.d.ts +2 -2
- package/dist/api/resources/accounts/client/requests/index.d.ts +1 -0
- package/dist/api/resources/accounts/exports.d.ts +2 -0
- package/dist/api/resources/accounts/types/GetAccountMemberResponse.d.ts +6 -0
- package/dist/api/resources/accounts/types/ListAccountMembersParams.d.ts +12 -0
- package/dist/api/resources/accounts/types/ListAccountMembersResponse.d.ts +6 -0
- package/dist/api/resources/accounts/types/index.d.ts +3 -0
- package/dist/api/resources/billing/client/Client.d.ts +42 -40
- package/dist/api/resources/billing/client/requests/CountBillingProductsRequest.d.ts +3 -3
- package/dist/api/resources/billing/client/requests/CountCustomersRequest.d.ts +3 -3
- package/dist/api/resources/billing/client/requests/CreateBillingPriceRequestBody.d.ts +1 -1
- package/dist/api/resources/billing/client/requests/CreateBillingSubscriptionRequestBody.d.ts +4 -3
- package/dist/api/resources/billing/client/requests/CreateCouponRequestBody.d.ts +4 -4
- package/dist/api/resources/billing/client/requests/CreateInvoiceRequestBody.d.ts +4 -4
- package/dist/api/resources/billing/client/requests/CreateMeterRequestBody.d.ts +2 -0
- package/dist/api/resources/billing/client/requests/ListBillingPricesRequest.d.ts +7 -4
- package/dist/api/resources/billing/client/requests/ListBillingProductPricesRequest.d.ts +7 -4
- package/dist/api/resources/billing/client/requests/ListBillingProductsRequest.d.ts +3 -3
- package/dist/api/resources/billing/client/requests/ListCouponsRequest.d.ts +2 -2
- package/dist/api/resources/billing/client/requests/ListCustomersWithSubscriptionsRequest.d.ts +3 -3
- package/dist/api/resources/billing/client/requests/ListInvoicesRequest.d.ts +2 -2
- package/dist/api/resources/billing/client/requests/ListMetersRequest.d.ts +2 -2
- package/dist/api/resources/billing/client/requests/ListPaymentMethodsRequest.d.ts +2 -2
- package/dist/api/resources/billing/exports.d.ts +2 -0
- package/dist/api/resources/billing/types/ListBillingPricesParams.d.ts +2 -0
- package/dist/api/resources/billing/types/ListBillingProductPricesParams.d.ts +2 -0
- package/dist/api/resources/checkout/client/Client.d.ts +8 -8
- package/dist/api/resources/checkout/exports.d.ts +2 -0
- package/dist/api/resources/companies/client/Client.d.ts +38 -30
- package/dist/api/resources/companies/client/requests/CountCompaniesRequest.d.ts +5 -2
- package/dist/api/resources/companies/client/requests/CountEntityKeyDefinitionsRequest.d.ts +2 -2
- package/dist/api/resources/companies/client/requests/CountEntityTraitDefinitionsRequest.d.ts +2 -2
- package/dist/api/resources/companies/client/requests/CountPlanTraitsRequest.d.ts +2 -2
- package/dist/api/resources/companies/client/requests/CountUsersRequest.d.ts +2 -2
- package/dist/api/resources/companies/client/requests/GetActiveCompanySubscriptionRequest.d.ts +2 -2
- package/dist/api/resources/companies/client/requests/GetEntityTraitValuesRequest.d.ts +2 -2
- package/dist/api/resources/companies/client/requests/ListCompaniesRequest.d.ts +5 -2
- package/dist/api/resources/companies/client/requests/ListCompanyMembershipsRequest.d.ts +2 -2
- package/dist/api/resources/companies/client/requests/ListEntityKeyDefinitionsRequest.d.ts +2 -2
- package/dist/api/resources/companies/client/requests/ListEntityTraitDefinitionsRequest.d.ts +2 -2
- package/dist/api/resources/companies/client/requests/ListPlanChangesRequest.d.ts +7 -6
- package/dist/api/resources/companies/client/requests/ListPlanTraitsRequest.d.ts +2 -2
- package/dist/api/resources/companies/client/requests/ListUsersRequest.d.ts +2 -2
- package/dist/api/resources/companies/exports.d.ts +2 -0
- package/dist/api/resources/companies/types/CountCompaniesParams.d.ts +2 -0
- package/dist/api/resources/companies/types/ListCompaniesParams.d.ts +2 -0
- package/dist/api/resources/companies/types/ListPlanChangesParams.d.ts +3 -2
- package/dist/api/resources/components/client/Client.d.ts +4 -4
- package/dist/api/resources/components/client/requests/CountComponentsRequest.d.ts +2 -2
- package/dist/api/resources/components/client/requests/ListComponentsRequest.d.ts +2 -2
- package/dist/api/resources/components/exports.d.ts +2 -0
- package/dist/api/resources/componentspublic/exports.d.ts +2 -0
- package/dist/api/resources/credits/client/Client.d.ts +47 -33
- package/dist/api/resources/credits/client/requests/CountBillingCreditsGrantsRequest.d.ts +2 -2
- package/dist/api/resources/credits/client/requests/CountBillingCreditsRequest.d.ts +2 -2
- package/dist/api/resources/credits/client/requests/CountBillingPlanCreditGrantsRequest.d.ts +2 -2
- package/dist/api/resources/credits/client/requests/CountCompanyGrantsRequest.d.ts +2 -2
- package/dist/api/resources/credits/client/requests/CountCreditBundlesRequest.d.ts +2 -2
- package/dist/api/resources/credits/client/requests/CountCreditEventLedgerRequest.d.ts +2 -2
- package/dist/api/resources/credits/client/requests/CountCreditLedgerRequest.d.ts +2 -2
- package/dist/api/resources/credits/client/requests/CreateBillingCreditRequestBody.d.ts +1 -0
- package/dist/api/resources/credits/client/requests/CreateCompanyCreditGrant.d.ts +3 -2
- package/dist/api/resources/credits/client/requests/CreateCreditBundleRequestBody.d.ts +2 -1
- package/dist/api/resources/credits/client/requests/GetEnrichedCreditLedgerRequest.d.ts +2 -2
- package/dist/api/resources/credits/client/requests/ListBillingCreditsRequest.d.ts +2 -2
- package/dist/api/resources/credits/client/requests/ListBillingPlanCreditGrantsRequest.d.ts +2 -2
- package/dist/api/resources/credits/client/requests/ListCompanyGrantsRequest.d.ts +2 -2
- package/dist/api/resources/credits/client/requests/ListCreditBundlesRequest.d.ts +2 -2
- package/dist/api/resources/credits/client/requests/ListCreditEventLedgerRequest.d.ts +2 -2
- package/dist/api/resources/credits/client/requests/ListGrantsForCreditRequest.d.ts +2 -2
- package/dist/api/resources/credits/client/requests/UpdateBillingCreditRequestBody.d.ts +1 -0
- package/dist/api/resources/credits/client/requests/UpdateCreditBundleDetailsRequestBody.d.ts +2 -1
- package/dist/api/resources/credits/exports.d.ts +2 -0
- package/dist/api/resources/credits/types/GetSingleBillingPlanCreditGrantResponse.d.ts +6 -0
- package/dist/api/resources/credits/types/index.d.ts +1 -0
- package/dist/api/resources/dataexports/exports.d.ts +2 -0
- package/dist/api/resources/entitlements/client/Client.d.ts +41 -20
- package/dist/api/resources/entitlements/client/requests/CountCompanyOverridesRequest.d.ts +2 -2
- package/dist/api/resources/entitlements/client/requests/CountFeatureCompaniesRequest.d.ts +2 -2
- package/dist/api/resources/entitlements/client/requests/CountFeatureUsageRequest.d.ts +2 -2
- package/dist/api/resources/entitlements/client/requests/CountFeatureUsersRequest.d.ts +2 -2
- package/dist/api/resources/entitlements/client/requests/CountPlanEntitlementsRequest.d.ts +2 -2
- package/dist/api/resources/entitlements/client/requests/CreateBillingLinkedPlanEntitlementRequestBody.d.ts +44 -0
- package/dist/api/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.d.ts +1 -0
- package/dist/api/resources/entitlements/client/requests/ListCompanyOverridesRequest.d.ts +2 -2
- package/dist/api/resources/entitlements/client/requests/ListFeatureCompaniesRequest.d.ts +2 -2
- package/dist/api/resources/entitlements/client/requests/ListFeatureUsageRequest.d.ts +2 -2
- package/dist/api/resources/entitlements/client/requests/ListFeatureUsersRequest.d.ts +2 -2
- package/dist/api/resources/entitlements/client/requests/ListPlanEntitlementsRequest.d.ts +2 -2
- package/dist/api/resources/entitlements/client/requests/UpdatePlanEntitlementRequestBody.d.ts +1 -0
- package/dist/api/resources/entitlements/client/requests/index.d.ts +1 -0
- package/dist/api/resources/entitlements/exports.d.ts +2 -0
- package/dist/api/resources/entitlements/types/CreateBillingLinkedPlanEntitlementRequestBodyMetricPeriod.d.ts +7 -0
- package/dist/api/resources/entitlements/types/CreateBillingLinkedPlanEntitlementRequestBodyMetricPeriodMonthReset.d.ts +5 -0
- package/dist/api/resources/entitlements/types/UpsertPlanEntitlementForBillingProductResponse.d.ts +6 -0
- package/dist/api/resources/entitlements/types/index.d.ts +3 -0
- package/dist/api/resources/events/client/Client.d.ts +4 -4
- package/dist/api/resources/events/client/requests/GetEventSummariesRequest.d.ts +2 -2
- package/dist/api/resources/events/client/requests/ListEventsRequest.d.ts +2 -2
- package/dist/api/resources/events/exports.d.ts +2 -0
- package/dist/api/resources/features/client/Client.d.ts +34 -13
- package/dist/api/resources/features/client/requests/CountFeaturesRequest.d.ts +10 -10
- package/dist/api/resources/features/client/requests/CountFlagsRequest.d.ts +2 -2
- package/dist/api/resources/features/client/requests/CreateBillingLinkedFeatureRequestBody.d.ts +26 -0
- package/dist/api/resources/features/client/requests/ListFeaturesRequest.d.ts +10 -10
- package/dist/api/resources/features/client/requests/ListFlagsRequest.d.ts +2 -2
- package/dist/api/resources/features/client/requests/UpdateFlagRulesRequestBody.d.ts +1 -1
- package/dist/api/resources/features/client/requests/index.d.ts +1 -0
- package/dist/api/resources/features/exports.d.ts +2 -0
- package/dist/api/resources/features/types/UpsertFeatureForBillingProductResponse.d.ts +6 -0
- package/dist/api/resources/features/types/index.d.ts +1 -0
- package/dist/api/resources/index.d.ts +2 -0
- package/dist/api/resources/integrationsapi/client/Client.d.ts +27 -0
- package/dist/api/resources/integrationsapi/client/index.d.ts +1 -0
- package/dist/api/resources/integrationsapi/exports.d.ts +2 -0
- package/dist/api/resources/integrationsapi/index.d.ts +2 -0
- package/dist/api/resources/integrationsapi/types/GetIntegrationWebhookUrlResponse.d.ts +6 -0
- package/dist/api/resources/integrationsapi/types/index.d.ts +1 -0
- package/dist/api/resources/planbundle/exports.d.ts +2 -0
- package/dist/api/resources/plangroups/exports.d.ts +2 -0
- package/dist/api/resources/planmigrations/client/Client.d.ts +8 -8
- package/dist/api/resources/planmigrations/client/requests/CountCompanyMigrationsRequest.d.ts +2 -2
- package/dist/api/resources/planmigrations/client/requests/CountMigrationsRequest.d.ts +2 -2
- package/dist/api/resources/planmigrations/client/requests/ListCompanyMigrationsRequest.d.ts +2 -2
- package/dist/api/resources/planmigrations/client/requests/ListMigrationsRequest.d.ts +2 -2
- package/dist/api/resources/planmigrations/exports.d.ts +2 -0
- package/dist/api/resources/plans/client/Client.d.ts +98 -7
- package/dist/api/resources/plans/client/requests/CountBillingProductMatchCompaniesRequest.d.ts +19 -0
- package/dist/api/resources/plans/client/requests/CountPlansRequest.d.ts +8 -2
- package/dist/api/resources/plans/client/requests/CreateBillingLinkedPlanRequestBody.d.ts +19 -0
- package/dist/api/resources/plans/client/requests/CreateCustomPlanRequestBody.d.ts +16 -0
- package/dist/api/resources/plans/client/requests/DeletePlanVersionRequest.d.ts +9 -0
- package/dist/api/resources/plans/client/requests/ListBillingProductMatchCompaniesRequest.d.ts +19 -0
- package/dist/api/resources/plans/client/requests/ListPlansRequest.d.ts +8 -2
- package/dist/api/resources/plans/client/requests/PublishPlanVersionRequestBody.d.ts +9 -1
- package/dist/api/resources/plans/client/requests/index.d.ts +5 -0
- package/dist/api/resources/plans/exports.d.ts +2 -0
- package/dist/api/resources/plans/types/CountBillingProductMatchCompaniesParams.d.ts +13 -0
- package/dist/api/resources/plans/types/CountBillingProductMatchCompaniesResponse.d.ts +6 -0
- package/dist/api/resources/plans/types/CountPlansParams.d.ts +4 -0
- package/dist/api/resources/plans/types/CreateCustomPlanResponse.d.ts +6 -0
- package/dist/api/resources/plans/types/DeletePlanVersionParams.d.ts +6 -0
- package/dist/api/resources/plans/types/DeletePlanVersionResponse.d.ts +1 -1
- package/dist/api/resources/plans/types/ListBillingProductMatchCompaniesParams.d.ts +13 -0
- package/dist/api/resources/plans/types/ListBillingProductMatchCompaniesResponse.d.ts +6 -0
- package/dist/api/resources/plans/types/ListPlansParams.d.ts +4 -0
- package/dist/api/resources/plans/types/UpsertPlanForBillingProductResponse.d.ts +6 -0
- package/dist/api/resources/plans/types/index.d.ts +7 -0
- package/dist/api/resources/scheduledcheckout/client/Client.d.ts +2 -2
- package/dist/api/resources/scheduledcheckout/client/requests/ListScheduledCheckoutsRequest.d.ts +2 -2
- package/dist/api/resources/scheduledcheckout/exports.d.ts +2 -0
- package/dist/api/resources/webhooks/client/Client.d.ts +8 -8
- package/dist/api/resources/webhooks/client/requests/CountWebhookEventsRequest.d.ts +2 -2
- package/dist/api/resources/webhooks/client/requests/CountWebhooksRequest.d.ts +2 -2
- package/dist/api/resources/webhooks/client/requests/ListWebhookEventsRequest.d.ts +2 -2
- package/dist/api/resources/webhooks/client/requests/ListWebhooksRequest.d.ts +2 -2
- package/dist/api/resources/webhooks/exports.d.ts +2 -0
- package/dist/api/types/AccountMemberPermission.d.ts +18 -0
- package/dist/api/types/AccountMemberResponseData.d.ts +11 -0
- package/dist/api/types/AccountMemberRole.d.ts +5 -0
- package/dist/api/types/BillingCreditBundleResponseData.d.ts +2 -0
- package/dist/api/types/BillingCreditBundleView.d.ts +1 -0
- package/dist/api/types/BillingCreditGrantReason.d.ts +1 -0
- package/dist/api/types/BillingCreditGrantResponseData.d.ts +1 -0
- package/dist/api/types/BillingCreditResponseData.d.ts +1 -0
- package/dist/api/types/BillingLinkedResourceResponseData.d.ts +6 -0
- package/dist/api/types/BillingPlanCreditGrantResponseData.d.ts +1 -0
- package/dist/api/types/BillingProductPlanResponseData.d.ts +1 -1
- package/dist/api/types/BillingProviderType.d.ts +1 -0
- package/dist/api/types/CheckoutSubscription.d.ts +1 -0
- package/dist/api/types/CompanyDetailResponseData.d.ts +1 -0
- package/dist/api/types/CompanyPlanDetailResponseData.d.ts +7 -2
- package/dist/api/types/ConditionGroupResponseData.d.ts +0 -1
- package/dist/api/types/ConditionGroupView.d.ts +0 -1
- package/dist/api/types/ConditionResponseData.d.ts +0 -1
- package/dist/api/types/ConditionView.d.ts +0 -1
- package/dist/api/types/CreateBillingPlanCreditGrantRequestBody.d.ts +1 -0
- package/dist/api/types/CreateEntitlementInBundleRequestBody.d.ts +1 -0
- package/dist/api/types/CreatePlanRequestBody.d.ts +1 -1
- package/dist/api/types/CreditBundleCurrencyPrice.d.ts +5 -0
- package/dist/api/types/CreditBundleCurrencyPriceRequestBody.d.ts +5 -0
- package/dist/api/types/CreditBundleCurrencyPriceResponseData.d.ts +5 -0
- package/dist/api/types/CreditCompanyGrantView.d.ts +1 -0
- package/dist/api/types/CreditCurrencyPriceRequestBody.d.ts +5 -0
- package/dist/api/types/CreditCurrencyPriceResponseData.d.ts +5 -0
- package/dist/api/types/CurrencyPriceRequestBody.d.ts +10 -0
- package/dist/api/types/CustomPlanActivationStrategy.d.ts +5 -0
- package/dist/api/types/CustomPlanBillingResponseData.d.ts +14 -0
- package/dist/api/types/CustomPlanBillingStatus.d.ts +6 -0
- package/dist/api/types/DatastreamCompanyPlan.d.ts +2 -0
- package/dist/api/types/EntitlementCurrencyPricesResponseData.d.ts +6 -0
- package/dist/api/types/FeatureDetailResponseData.d.ts +1 -0
- package/dist/api/types/FeatureView.d.ts +1 -0
- package/dist/api/types/IntegrationType.d.ts +7 -0
- package/dist/api/types/IntegrationWebhookUrlResponseData.d.ts +5 -0
- package/dist/api/types/ManagePlanRequest.d.ts +1 -0
- package/dist/api/types/PlanCreditGrantView.d.ts +1 -0
- package/dist/api/types/PlanCurrencyPriceRequestBody.d.ts +6 -0
- package/dist/api/types/PlanCurrencyPricesResponseData.d.ts +7 -0
- package/dist/api/types/PlanDetailResponseData.d.ts +7 -2
- package/dist/api/types/PlanEntitlementResponseData.d.ts +2 -0
- package/dist/api/types/PlanGroupPlanDetailResponseData.d.ts +7 -2
- package/dist/api/types/PlanIcon.d.ts +28 -0
- package/dist/api/types/PlanResponseData.d.ts +3 -1
- package/dist/api/types/PlanSelection.d.ts +1 -0
- package/dist/api/types/PlanVersionResponseData.d.ts +1 -1
- package/dist/api/types/PlanViewPublicResponseData.d.ts +7 -2
- package/dist/api/types/RuleView.d.ts +0 -1
- package/dist/api/types/RulesEngineSchemaVersion.d.ts +1 -1
- package/dist/api/types/TrialStatus.d.ts +6 -0
- package/dist/api/types/UpdateBillingPlanCreditGrantRequestBody.d.ts +1 -0
- package/dist/api/types/UpdatePlanRequestBody.d.ts +2 -1
- package/dist/api/types/UpsertBillingProductRequestBody.d.ts +1 -0
- package/dist/api/types/UsageBasedEntitlementRequestBody.d.ts +1 -0
- package/dist/api/types/WebScheduledDowngradeWebhookOutput.d.ts +10 -0
- package/dist/api/types/WebhookRequestType.d.ts +1 -0
- package/dist/api/types/WebhookUrl.d.ts +5 -0
- package/dist/api/types/index.d.ts +22 -1
- package/dist/auth/HeaderAuthProvider.d.ts +14 -10
- package/dist/core/fetcher/BinaryResponse.d.ts +1 -1
- package/dist/core/fetcher/EndpointSupplier.d.ts +2 -2
- package/dist/core/fetcher/Fetcher.d.ts +1 -2
- package/dist/core/fetcher/index.d.ts +2 -0
- package/dist/core/fetcher/makePassthroughRequest.d.ts +49 -0
- package/dist/core/fetcher/makeRequest.d.ts +6 -1
- package/dist/core/headers.d.ts +2 -2
- package/dist/core/schemas/builders/record/index.d.ts +2 -2
- package/dist/core/schemas/builders/record/record.d.ts +2 -1
- package/dist/core/schemas/builders/record/types.d.ts +2 -0
- package/dist/datastream/merge.d.ts +25 -0
- package/dist/datastream/types.d.ts +1 -0
- package/dist/index.js +3 -3
- package/dist/serialization/resources/accounts/types/GetAccountMemberResponse.d.ts +11 -0
- package/dist/serialization/resources/accounts/types/ListAccountMembersParams.d.ts +12 -0
- package/dist/serialization/resources/accounts/types/ListAccountMembersResponse.d.ts +12 -0
- package/dist/serialization/resources/accounts/types/index.d.ts +3 -0
- package/dist/serialization/resources/billing/client/requests/CreateBillingSubscriptionRequestBody.d.ts +2 -0
- package/dist/serialization/resources/billing/client/requests/CreateMeterRequestBody.d.ts +2 -0
- package/dist/serialization/resources/billing/types/ListBillingPricesParams.d.ts +1 -0
- package/dist/serialization/resources/billing/types/ListBillingProductPricesParams.d.ts +1 -0
- package/dist/serialization/resources/companies/types/CountCompaniesParams.d.ts +1 -0
- package/dist/serialization/resources/companies/types/ListCompaniesParams.d.ts +1 -0
- package/dist/serialization/resources/companies/types/ListPlanChangesParams.d.ts +4 -2
- package/dist/serialization/resources/credits/client/requests/CreateBillingCreditRequestBody.d.ts +2 -0
- package/dist/serialization/resources/credits/client/requests/CreateCompanyCreditGrant.d.ts +1 -0
- package/dist/serialization/resources/credits/client/requests/CreateCreditBundleRequestBody.d.ts +2 -0
- package/dist/serialization/resources/credits/client/requests/UpdateBillingCreditRequestBody.d.ts +2 -0
- package/dist/serialization/resources/credits/client/requests/UpdateCreditBundleDetailsRequestBody.d.ts +2 -0
- package/dist/serialization/resources/credits/types/GetSingleBillingPlanCreditGrantResponse.d.ts +11 -0
- package/dist/serialization/resources/credits/types/index.d.ts +1 -0
- package/dist/serialization/resources/entitlements/client/requests/CreateBillingLinkedPlanEntitlementRequestBody.d.ts +46 -0
- package/dist/serialization/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.d.ts +2 -0
- package/dist/serialization/resources/entitlements/client/requests/UpdatePlanEntitlementRequestBody.d.ts +2 -0
- package/dist/serialization/resources/entitlements/client/requests/index.d.ts +1 -0
- package/dist/serialization/resources/entitlements/types/CreateBillingLinkedPlanEntitlementRequestBodyMetricPeriod.d.ts +7 -0
- package/dist/serialization/resources/entitlements/types/CreateBillingLinkedPlanEntitlementRequestBodyMetricPeriodMonthReset.d.ts +7 -0
- package/dist/serialization/resources/entitlements/types/UpsertPlanEntitlementForBillingProductResponse.d.ts +11 -0
- package/dist/serialization/resources/entitlements/types/index.d.ts +3 -0
- package/dist/serialization/resources/features/client/requests/CreateBillingLinkedFeatureRequestBody.d.ts +25 -0
- package/dist/serialization/resources/features/client/requests/index.d.ts +1 -0
- package/dist/serialization/resources/features/types/UpsertFeatureForBillingProductResponse.d.ts +11 -0
- package/dist/serialization/resources/features/types/index.d.ts +1 -0
- package/dist/serialization/resources/index.d.ts +2 -0
- package/dist/serialization/resources/integrationsapi/index.d.ts +1 -0
- package/dist/serialization/resources/integrationsapi/types/GetIntegrationWebhookUrlResponse.d.ts +11 -0
- package/dist/serialization/resources/integrationsapi/types/index.d.ts +1 -0
- package/dist/serialization/resources/plans/client/requests/CreateBillingLinkedPlanRequestBody.d.ts +17 -0
- package/dist/serialization/resources/plans/client/requests/CreateCustomPlanRequestBody.d.ts +14 -0
- package/dist/serialization/resources/plans/client/requests/PublishPlanVersionRequestBody.d.ts +6 -0
- package/dist/serialization/resources/plans/client/requests/index.d.ts +2 -0
- package/dist/serialization/resources/plans/types/CountBillingProductMatchCompaniesParams.d.ts +12 -0
- package/dist/serialization/resources/plans/types/CountBillingProductMatchCompaniesResponse.d.ts +12 -0
- package/dist/serialization/resources/plans/types/CountPlansParams.d.ts +2 -0
- package/dist/serialization/resources/plans/types/CreateCustomPlanResponse.d.ts +11 -0
- package/dist/serialization/resources/plans/types/DeletePlanVersionParams.d.ts +9 -0
- package/dist/serialization/resources/plans/types/DeletePlanVersionResponse.d.ts +2 -1
- package/dist/serialization/resources/plans/types/ListBillingProductMatchCompaniesParams.d.ts +12 -0
- package/dist/serialization/resources/plans/types/ListBillingProductMatchCompaniesResponse.d.ts +12 -0
- package/dist/serialization/resources/plans/types/ListPlansParams.d.ts +2 -0
- package/dist/serialization/resources/plans/types/UpsertPlanForBillingProductResponse.d.ts +11 -0
- package/dist/serialization/resources/plans/types/index.d.ts +7 -0
- package/dist/serialization/types/AccountMemberPermission.d.ts +7 -0
- package/dist/serialization/types/AccountMemberResponseData.d.ts +18 -0
- package/dist/serialization/types/AccountMemberRole.d.ts +7 -0
- package/dist/serialization/types/BillingCreditBundleResponseData.d.ts +3 -0
- package/dist/serialization/types/BillingCreditBundleView.d.ts +2 -0
- package/dist/serialization/types/BillingCreditGrantReason.d.ts +1 -1
- package/dist/serialization/types/BillingCreditGrantResponseData.d.ts +1 -0
- package/dist/serialization/types/BillingCreditResponseData.d.ts +2 -0
- package/dist/serialization/types/BillingLinkedResourceResponseData.d.ts +12 -0
- package/dist/serialization/types/BillingPlanCreditGrantResponseData.d.ts +1 -0
- package/dist/serialization/types/BillingProductPlanResponseData.d.ts +2 -2
- package/dist/serialization/types/BillingProviderType.d.ts +1 -1
- package/dist/serialization/types/CheckoutSubscription.d.ts +1 -0
- package/dist/serialization/types/CompanyDetailResponseData.d.ts +2 -0
- package/dist/serialization/types/CompanyPlanDetailResponseData.d.ts +10 -3
- package/dist/serialization/types/ConditionGroupResponseData.d.ts +0 -1
- package/dist/serialization/types/ConditionGroupView.d.ts +0 -1
- package/dist/serialization/types/ConditionResponseData.d.ts +0 -1
- package/dist/serialization/types/ConditionView.d.ts +0 -1
- package/dist/serialization/types/CreateBillingPlanCreditGrantRequestBody.d.ts +1 -0
- package/dist/serialization/types/CreateEntitlementInBundleRequestBody.d.ts +2 -0
- package/dist/serialization/types/CreatePlanRequestBody.d.ts +2 -1
- package/dist/serialization/types/CreditBundleCurrencyPrice.d.ts +11 -0
- package/dist/serialization/types/CreditBundleCurrencyPriceRequestBody.d.ts +11 -0
- package/dist/serialization/types/CreditBundleCurrencyPriceResponseData.d.ts +11 -0
- package/dist/serialization/types/CreditCompanyGrantView.d.ts +1 -0
- package/dist/serialization/types/CreditCurrencyPriceRequestBody.d.ts +11 -0
- package/dist/serialization/types/CreditCurrencyPriceResponseData.d.ts +11 -0
- package/dist/serialization/types/CurrencyPriceRequestBody.d.ts +16 -0
- package/dist/serialization/types/CustomPlanActivationStrategy.d.ts +7 -0
- package/dist/serialization/types/CustomPlanBillingResponseData.d.ts +21 -0
- package/dist/serialization/types/CustomPlanBillingStatus.d.ts +7 -0
- package/dist/serialization/types/DatastreamCompanyPlan.d.ts +2 -0
- package/dist/serialization/types/EntitlementCurrencyPricesResponseData.d.ts +12 -0
- package/dist/serialization/types/FeatureDetailResponseData.d.ts +2 -0
- package/dist/serialization/types/FeatureView.d.ts +2 -0
- package/dist/serialization/types/IntegrationType.d.ts +7 -0
- package/dist/serialization/types/IntegrationWebhookUrlResponseData.d.ts +11 -0
- package/dist/serialization/types/ManagePlanRequest.d.ts +1 -0
- package/dist/serialization/types/PlanCreditGrantView.d.ts +1 -0
- package/dist/serialization/types/PlanCurrencyPriceRequestBody.d.ts +12 -0
- package/dist/serialization/types/PlanCurrencyPricesResponseData.d.ts +13 -0
- package/dist/serialization/types/PlanDetailResponseData.d.ts +10 -3
- package/dist/serialization/types/PlanEntitlementResponseData.d.ts +4 -0
- package/dist/serialization/types/PlanGroupPlanDetailResponseData.d.ts +10 -3
- package/dist/serialization/types/PlanIcon.d.ts +7 -0
- package/dist/serialization/types/PlanResponseData.d.ts +4 -1
- package/dist/serialization/types/PlanSelection.d.ts +1 -0
- package/dist/serialization/types/PlanVersionResponseData.d.ts +2 -1
- package/dist/serialization/types/PlanViewPublicResponseData.d.ts +10 -3
- package/dist/serialization/types/RuleView.d.ts +0 -1
- package/dist/serialization/types/RulesEngineSchemaVersion.d.ts +1 -1
- package/dist/serialization/types/TrialStatus.d.ts +7 -0
- package/dist/serialization/types/UpdateBillingPlanCreditGrantRequestBody.d.ts +1 -0
- package/dist/serialization/types/UpdatePlanRequestBody.d.ts +2 -1
- package/dist/serialization/types/UpsertBillingProductRequestBody.d.ts +2 -0
- package/dist/serialization/types/UsageBasedEntitlementRequestBody.d.ts +2 -0
- package/dist/serialization/types/WebScheduledDowngradeWebhookOutput.d.ts +17 -0
- package/dist/serialization/types/WebhookRequestType.d.ts +1 -1
- package/dist/serialization/types/WebhookUrl.d.ts +11 -0
- package/dist/serialization/types/index.d.ts +22 -1
- package/dist/wasm/rulesengine.d.ts +10 -0
- package/dist/wasm/rulesengine.js +193 -0
- package/dist/wasm/rulesengine_bg.wasm +0 -0
- package/dist/wasm/rulesengine_bg.wasm.d.ts +25 -0
- package/package.json +9 -9
- package/dist/api/types/PlanControlledByType.d.ts +0 -5
- package/dist/serialization/types/PlanControlledByType.d.ts +0 -7
|
@@ -2,18 +2,23 @@ import type * as Schematic from "../index";
|
|
|
2
2
|
export interface PlanGroupPlanDetailResponseData {
|
|
3
3
|
activeVersion?: Schematic.PlanVersionResponseData;
|
|
4
4
|
audienceType?: string;
|
|
5
|
+
billingLinkedResource?: Schematic.BillingLinkedResourceResponseData;
|
|
5
6
|
billingProduct?: Schematic.BillingProductDetailResponseData;
|
|
6
7
|
chargeType: Schematic.ChargeType;
|
|
7
8
|
companyCount: number;
|
|
9
|
+
companyId?: string;
|
|
10
|
+
companyName?: string;
|
|
8
11
|
compatiblePlanIds: string[];
|
|
9
|
-
controlledBy:
|
|
12
|
+
controlledBy: string;
|
|
13
|
+
copiedFromPlanId?: string;
|
|
10
14
|
createdAt: Date;
|
|
15
|
+
currencyPrices: Schematic.PlanCurrencyPricesResponseData[];
|
|
11
16
|
customPlanConfig?: Schematic.CustomPlanViewConfigResponseData;
|
|
12
17
|
description: string;
|
|
13
18
|
draftVersion?: Schematic.PlanVersionResponseData;
|
|
14
19
|
entitlements: Schematic.PlanEntitlementResponseData[];
|
|
15
20
|
features: Schematic.FeatureDetailResponseData[];
|
|
16
|
-
icon:
|
|
21
|
+
icon: Schematic.PlanIcon;
|
|
17
22
|
id: string;
|
|
18
23
|
includedCreditGrants?: Schematic.BillingPlanCreditGrantResponseData[];
|
|
19
24
|
isCustom: boolean;
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
export declare const PlanIcon: {
|
|
2
|
+
readonly Amber: "amber";
|
|
3
|
+
readonly Blue: "blue";
|
|
4
|
+
readonly BlueGray: "blueGray";
|
|
5
|
+
readonly BlueGreen: "blueGreen";
|
|
6
|
+
readonly Cyan: "cyan";
|
|
7
|
+
readonly Emerald: "emerald";
|
|
8
|
+
readonly Fuchsia: "fuchsia";
|
|
9
|
+
readonly Gray: "gray";
|
|
10
|
+
readonly Green: "green";
|
|
11
|
+
readonly Indigo: "indigo";
|
|
12
|
+
readonly LightBlue: "lightBlue";
|
|
13
|
+
readonly Lime: "lime";
|
|
14
|
+
readonly Orange: "orange";
|
|
15
|
+
readonly Pink: "pink";
|
|
16
|
+
readonly Purple: "purple";
|
|
17
|
+
readonly Red: "red";
|
|
18
|
+
readonly RedOrange: "redOrange";
|
|
19
|
+
readonly Rose: "rose";
|
|
20
|
+
readonly Sky: "sky";
|
|
21
|
+
readonly Slate: "slate";
|
|
22
|
+
readonly Teal: "teal";
|
|
23
|
+
readonly TrueGray: "trueGray";
|
|
24
|
+
readonly Violet: "violet";
|
|
25
|
+
readonly WarmGray: "warmGray";
|
|
26
|
+
readonly Yellow: "yellow";
|
|
27
|
+
};
|
|
28
|
+
export type PlanIcon = (typeof PlanIcon)[keyof typeof PlanIcon];
|
|
@@ -1,9 +1,11 @@
|
|
|
1
1
|
import type * as Schematic from "../index";
|
|
2
2
|
export interface PlanResponseData {
|
|
3
3
|
audienceType?: string;
|
|
4
|
+
companyId?: string;
|
|
5
|
+
copiedFromPlanId?: string;
|
|
4
6
|
createdAt: Date;
|
|
5
7
|
description: string;
|
|
6
|
-
icon:
|
|
8
|
+
icon: Schematic.PlanIcon;
|
|
7
9
|
id: string;
|
|
8
10
|
name: string;
|
|
9
11
|
planType: Schematic.PlanType;
|
|
@@ -2,19 +2,24 @@ import type * as Schematic from "../index";
|
|
|
2
2
|
export interface PlanViewPublicResponseData {
|
|
3
3
|
activeVersion?: Schematic.PlanVersionResponseData;
|
|
4
4
|
audienceType?: string;
|
|
5
|
+
billingLinkedResource?: Schematic.BillingLinkedResourceResponseData;
|
|
5
6
|
billingProduct?: Schematic.BillingProductDetailResponseData;
|
|
6
7
|
chargeType: Schematic.ChargeType;
|
|
7
8
|
companyCount: number;
|
|
9
|
+
companyId?: string;
|
|
10
|
+
companyName?: string;
|
|
8
11
|
compatiblePlanIds: string[];
|
|
9
|
-
controlledBy:
|
|
12
|
+
controlledBy: string;
|
|
13
|
+
copiedFromPlanId?: string;
|
|
10
14
|
createdAt: Date;
|
|
15
|
+
currencyPrices: Schematic.PlanCurrencyPricesResponseData[];
|
|
11
16
|
custom: boolean;
|
|
12
17
|
customPlanConfig?: Schematic.CustomPlanConfig;
|
|
13
18
|
description: string;
|
|
14
19
|
draftVersion?: Schematic.PlanVersionResponseData;
|
|
15
20
|
entitlements: Schematic.PlanEntitlementResponseData[];
|
|
16
21
|
features: Schematic.FeatureDetailResponseData[];
|
|
17
|
-
icon:
|
|
22
|
+
icon: Schematic.PlanIcon;
|
|
18
23
|
id: string;
|
|
19
24
|
includedCreditGrants: Schematic.PlanCreditGrantView[];
|
|
20
25
|
isCustom: boolean;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/** The current schema version hash for rules engine types. The first enum value is always the current version. */
|
|
2
2
|
export declare const RulesEngineSchemaVersion: {
|
|
3
|
-
readonly
|
|
3
|
+
readonly V313Fa646: "v313fa646";
|
|
4
4
|
readonly PlaceholderForFernCompatibility: "placeholder-for-fern-compatibility";
|
|
5
5
|
};
|
|
6
6
|
export type RulesEngineSchemaVersion = (typeof RulesEngineSchemaVersion)[keyof typeof RulesEngineSchemaVersion];
|
|
@@ -7,6 +7,7 @@ export interface UpdateBillingPlanCreditGrantRequestBody {
|
|
|
7
7
|
autoTopupExpiryType?: Schematic.BillingCreditExpiryType;
|
|
8
8
|
autoTopupExpiryUnit?: Schematic.BillingCreditExpiryUnit;
|
|
9
9
|
autoTopupExpiryUnitCount?: number;
|
|
10
|
+
autoTopupThresholdCredits?: number;
|
|
10
11
|
autoTopupThresholdPercent?: number;
|
|
11
12
|
creditAmount?: number;
|
|
12
13
|
expiryType?: Schematic.BillingCreditExpiryType;
|
|
@@ -3,6 +3,7 @@ export interface UpsertBillingProductRequestBody {
|
|
|
3
3
|
billingProductId?: string;
|
|
4
4
|
chargeType: Schematic.ChargeType;
|
|
5
5
|
currency?: string;
|
|
6
|
+
currencyPrices?: Schematic.PlanCurrencyPriceRequestBody[];
|
|
6
7
|
isTrialable: boolean;
|
|
7
8
|
monthlyPrice?: number;
|
|
8
9
|
monthlyPriceId?: string;
|
|
@@ -3,6 +3,7 @@ export interface UsageBasedEntitlementRequestBody {
|
|
|
3
3
|
billingProductId?: string;
|
|
4
4
|
billingThreshold?: number;
|
|
5
5
|
currency?: string;
|
|
6
|
+
currencyPrices?: Schematic.CurrencyPriceRequestBody[];
|
|
6
7
|
monthlyMeteredPriceId?: string;
|
|
7
8
|
monthlyPriceTiers?: Schematic.CreatePriceTierRequestBody[];
|
|
8
9
|
monthlyUnitPrice?: number;
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type * as Schematic from "../index";
|
|
2
|
+
export interface WebScheduledDowngradeWebhookOutput {
|
|
3
|
+
company?: Schematic.CompanyResponseData;
|
|
4
|
+
executeAfter: Date;
|
|
5
|
+
fromPlan?: Schematic.PlanSnapshotView;
|
|
6
|
+
id: string;
|
|
7
|
+
scheduledInterval?: string;
|
|
8
|
+
scheduledPrice?: number;
|
|
9
|
+
toPlan?: Schematic.PlanSnapshotView;
|
|
10
|
+
}
|
|
@@ -7,6 +7,7 @@ export declare const WebhookRequestType: {
|
|
|
7
7
|
readonly CompanyOverrideExpired: "company.override.expired";
|
|
8
8
|
readonly CompanyOverrideUpdated: "company.override.updated";
|
|
9
9
|
readonly CompanyPlanChanged: "company.plan_changed";
|
|
10
|
+
readonly CompanyScheduledDowngrade: "company.scheduled_downgrade";
|
|
10
11
|
readonly CompanyUpdated: "company.updated";
|
|
11
12
|
readonly CreditLimitReached: "credit.limit.reached";
|
|
12
13
|
readonly CreditLimitWarning: "credit.limit.warning";
|
|
@@ -1,3 +1,6 @@
|
|
|
1
|
+
export * from "./AccountMemberPermission";
|
|
2
|
+
export * from "./AccountMemberResponseData";
|
|
3
|
+
export * from "./AccountMemberRole";
|
|
1
4
|
export * from "./ActorType";
|
|
2
5
|
export * from "./ApiError";
|
|
3
6
|
export * from "./ApiKeyCreateResponseData";
|
|
@@ -23,6 +26,7 @@ export * from "./BillingCreditView";
|
|
|
23
26
|
export * from "./BillingCustomerResponseData";
|
|
24
27
|
export * from "./BillingCustomerSubscription";
|
|
25
28
|
export * from "./BillingCustomerWithSubscriptionsResponseData";
|
|
29
|
+
export * from "./BillingLinkedResourceResponseData";
|
|
26
30
|
export * from "./BillingMeterResponseData";
|
|
27
31
|
export * from "./BillingPlanCreditGrantResetCadence";
|
|
28
32
|
export * from "./BillingPlanCreditGrantResetStart";
|
|
@@ -116,8 +120,13 @@ export * from "./CreateOrUpdateRuleRequestBodyRuleType";
|
|
|
116
120
|
export * from "./CreatePlanRequestBody";
|
|
117
121
|
export * from "./CreatePriceTierRequestBody";
|
|
118
122
|
export * from "./CreditAutoTopupAmountType";
|
|
123
|
+
export * from "./CreditBundleCurrencyPrice";
|
|
124
|
+
export * from "./CreditBundleCurrencyPriceRequestBody";
|
|
125
|
+
export * from "./CreditBundleCurrencyPriceResponseData";
|
|
119
126
|
export * from "./CreditBundlePurchaseResponseData";
|
|
120
127
|
export * from "./CreditCompanyGrantView";
|
|
128
|
+
export * from "./CreditCurrencyPriceRequestBody";
|
|
129
|
+
export * from "./CreditCurrencyPriceResponseData";
|
|
121
130
|
export * from "./CreditEventLedgerResponseData";
|
|
122
131
|
export * from "./CreditEventType";
|
|
123
132
|
export * from "./CreditGrantDetail";
|
|
@@ -134,6 +143,10 @@ export * from "./CreditTransferView";
|
|
|
134
143
|
export * from "./CreditTriggerConfig";
|
|
135
144
|
export * from "./CreditUsage";
|
|
136
145
|
export * from "./CreditUsageAggregation";
|
|
146
|
+
export * from "./CurrencyPriceRequestBody";
|
|
147
|
+
export * from "./CustomPlanActivationStrategy";
|
|
148
|
+
export * from "./CustomPlanBillingResponseData";
|
|
149
|
+
export * from "./CustomPlanBillingStatus";
|
|
137
150
|
export * from "./CustomPlanConfig";
|
|
138
151
|
export * from "./CustomPlanViewConfigResponseData";
|
|
139
152
|
export * from "./DataEventPayload";
|
|
@@ -145,6 +158,7 @@ export * from "./DatastreamCompanyPlan";
|
|
|
145
158
|
export * from "./DeleteBillingPlanCreditGrantRequestBody";
|
|
146
159
|
export * from "./DeleteResponse";
|
|
147
160
|
export * from "./DuplicatePlanEntitlementsResponseResponseData";
|
|
161
|
+
export * from "./EntitlementCurrencyPricesResponseData";
|
|
148
162
|
export * from "./EntitlementPriceBehavior";
|
|
149
163
|
export * from "./EntitlementsInPlan";
|
|
150
164
|
export * from "./EntitlementTriggerConfig";
|
|
@@ -191,6 +205,8 @@ export * from "./FlagResponseData";
|
|
|
191
205
|
export * from "./FlagType";
|
|
192
206
|
export * from "./FlagView";
|
|
193
207
|
export * from "./GenericPreviewObject";
|
|
208
|
+
export * from "./IntegrationType";
|
|
209
|
+
export * from "./IntegrationWebhookUrlResponseData";
|
|
194
210
|
export * from "./InvoiceRequestBody";
|
|
195
211
|
export * from "./InvoiceResponseData";
|
|
196
212
|
export * from "./InvoiceStatus";
|
|
@@ -212,8 +228,9 @@ export * from "./PlanChangeAction";
|
|
|
212
228
|
export * from "./PlanChangeBasePlanAction";
|
|
213
229
|
export * from "./PlanChangeResponseData";
|
|
214
230
|
export * from "./PlanChangeSubscriptionAction";
|
|
215
|
-
export * from "./PlanControlledByType";
|
|
216
231
|
export * from "./PlanCreditGrantView";
|
|
232
|
+
export * from "./PlanCurrencyPriceRequestBody";
|
|
233
|
+
export * from "./PlanCurrencyPricesResponseData";
|
|
217
234
|
export * from "./PlanDetailResponseData";
|
|
218
235
|
export * from "./PlanEntitlementResponseData";
|
|
219
236
|
export * from "./PlanEntitlementsOrder";
|
|
@@ -222,6 +239,7 @@ export * from "./PlanGroupDetailResponseData";
|
|
|
222
239
|
export * from "./PlanGroupPlanDetailResponseData";
|
|
223
240
|
export * from "./PlanGroupPlanEntitlementsOrder";
|
|
224
241
|
export * from "./PlanGroupResponseData";
|
|
242
|
+
export * from "./PlanIcon";
|
|
225
243
|
export * from "./PlanIssueResponseData";
|
|
226
244
|
export * from "./PlanResponseData";
|
|
227
245
|
export * from "./PlanSelection";
|
|
@@ -302,6 +320,7 @@ export * from "./TimeSeriesGranularity";
|
|
|
302
320
|
export * from "./TraitDefinition";
|
|
303
321
|
export * from "./TraitDefinitionComparableType";
|
|
304
322
|
export * from "./TraitType";
|
|
323
|
+
export * from "./TrialStatus";
|
|
305
324
|
export * from "./UpdateAddOnRequestBody";
|
|
306
325
|
export * from "./UpdateBillingPlanCreditGrantRequestBody";
|
|
307
326
|
export * from "./UpdateCreditBundleRequestBody";
|
|
@@ -329,4 +348,6 @@ export * from "./WebhookEventStatus";
|
|
|
329
348
|
export * from "./WebhookRequestType";
|
|
330
349
|
export * from "./WebhookResponseData";
|
|
331
350
|
export * from "./WebhookStatus";
|
|
351
|
+
export * from "./WebhookUrl";
|
|
352
|
+
export * from "./WebScheduledDowngradeWebhookOutput";
|
|
332
353
|
export * from "./WhoAmIResponseData";
|
|
@@ -1,16 +1,20 @@
|
|
|
1
1
|
import * as core from "../core";
|
|
2
|
-
|
|
3
|
-
interface AuthOptions {
|
|
4
|
-
apiKey: core.Supplier<string>;
|
|
5
|
-
}
|
|
6
|
-
interface Options extends AuthOptions {
|
|
7
|
-
}
|
|
8
|
-
}
|
|
2
|
+
declare const PARAM_KEY: "apiKey";
|
|
9
3
|
export declare class HeaderAuthProvider implements core.AuthProvider {
|
|
10
|
-
private readonly
|
|
4
|
+
private readonly options;
|
|
11
5
|
constructor(options: HeaderAuthProvider.Options);
|
|
12
|
-
static canCreate(options: HeaderAuthProvider.Options): boolean;
|
|
13
|
-
getAuthRequest(
|
|
6
|
+
static canCreate(options: Partial<HeaderAuthProvider.Options>): boolean;
|
|
7
|
+
getAuthRequest({ endpointMetadata, }?: {
|
|
14
8
|
endpointMetadata?: core.EndpointMetadata;
|
|
15
9
|
}): Promise<core.AuthRequest>;
|
|
16
10
|
}
|
|
11
|
+
export declare namespace HeaderAuthProvider {
|
|
12
|
+
const AUTH_SCHEME: "ApiKeyAuth";
|
|
13
|
+
const AUTH_CONFIG_ERROR_MESSAGE: string;
|
|
14
|
+
type Options = AuthOptions;
|
|
15
|
+
type AuthOptions = {
|
|
16
|
+
[PARAM_KEY]: core.Supplier<string>;
|
|
17
|
+
};
|
|
18
|
+
function createInstance(options: Options): core.AuthProvider;
|
|
19
|
+
}
|
|
20
|
+
export {};
|
|
@@ -14,6 +14,6 @@ export type BinaryResponse = {
|
|
|
14
14
|
* [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/bytes)
|
|
15
15
|
* Some versions of the Fetch API may not support this method.
|
|
16
16
|
*/
|
|
17
|
-
bytes?():
|
|
17
|
+
bytes?(): Promise<Uint8Array>;
|
|
18
18
|
};
|
|
19
19
|
export declare function getBinaryResponse(response: Response): BinaryResponse;
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
import type { EndpointMetadata } from "./EndpointMetadata";
|
|
2
2
|
import type { Supplier } from "./Supplier";
|
|
3
3
|
type EndpointSupplierFn<T> = (arg: {
|
|
4
|
-
endpointMetadata
|
|
4
|
+
endpointMetadata?: EndpointMetadata;
|
|
5
5
|
}) => T | Promise<T>;
|
|
6
6
|
export type EndpointSupplier<T> = Supplier<T> | EndpointSupplierFn<T>;
|
|
7
7
|
export declare const EndpointSupplier: {
|
|
8
8
|
get: <T>(supplier: EndpointSupplier<T>, arg: {
|
|
9
|
-
endpointMetadata
|
|
9
|
+
endpointMetadata?: EndpointMetadata;
|
|
10
10
|
}) => Promise<T>;
|
|
11
11
|
};
|
|
12
12
|
export {};
|
|
@@ -1,14 +1,13 @@
|
|
|
1
1
|
import { type LogConfig, type Logger } from "../logging/logger";
|
|
2
2
|
import type { APIResponse } from "./APIResponse";
|
|
3
3
|
import type { EndpointMetadata } from "./EndpointMetadata";
|
|
4
|
-
import { EndpointSupplier } from "./EndpointSupplier";
|
|
5
4
|
export type FetchFunction = <R = unknown>(args: Fetcher.Args) => Promise<APIResponse<R, Fetcher.Error>>;
|
|
6
5
|
export declare namespace Fetcher {
|
|
7
6
|
interface Args {
|
|
8
7
|
url: string;
|
|
9
8
|
method: string;
|
|
10
9
|
contentType?: string;
|
|
11
|
-
headers?: Record<string,
|
|
10
|
+
headers?: Record<string, unknown>;
|
|
12
11
|
queryParameters?: Record<string, unknown>;
|
|
13
12
|
body?: unknown;
|
|
14
13
|
timeoutMs?: number;
|
|
@@ -6,6 +6,8 @@ export type { Fetcher, FetchFunction } from "./Fetcher";
|
|
|
6
6
|
export { fetcher } from "./Fetcher";
|
|
7
7
|
export { getHeader } from "./getHeader";
|
|
8
8
|
export { HttpResponsePromise } from "./HttpResponsePromise";
|
|
9
|
+
export type { PassthroughRequest } from "./makePassthroughRequest";
|
|
10
|
+
export { makePassthroughRequest } from "./makePassthroughRequest";
|
|
9
11
|
export type { RawResponse, WithRawResponse } from "./RawResponse";
|
|
10
12
|
export { abortRawResponse, toRawResponse, unknownRawResponse } from "./RawResponse";
|
|
11
13
|
export { Supplier } from "./Supplier";
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
import { type LogConfig, type Logger } from "../logging/logger";
|
|
2
|
+
import { Supplier } from "./Supplier";
|
|
3
|
+
export declare namespace PassthroughRequest {
|
|
4
|
+
/**
|
|
5
|
+
* Per-request options that can override the SDK client defaults.
|
|
6
|
+
*/
|
|
7
|
+
interface RequestOptions {
|
|
8
|
+
/** Override the default timeout for this request (in seconds). */
|
|
9
|
+
timeoutInSeconds?: number;
|
|
10
|
+
/** Override the default number of retries for this request. */
|
|
11
|
+
maxRetries?: number;
|
|
12
|
+
/** Additional headers to include in this request. */
|
|
13
|
+
headers?: Record<string, string>;
|
|
14
|
+
/** Abort signal for this request. */
|
|
15
|
+
abortSignal?: AbortSignal;
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* SDK client configuration used by the passthrough fetch method.
|
|
19
|
+
*/
|
|
20
|
+
interface ClientOptions {
|
|
21
|
+
/** The base URL or environment for the client. */
|
|
22
|
+
environment?: Supplier<string>;
|
|
23
|
+
/** Override the base URL. */
|
|
24
|
+
baseUrl?: Supplier<string>;
|
|
25
|
+
/** Default headers to include in requests. */
|
|
26
|
+
headers?: Record<string, unknown>;
|
|
27
|
+
/** Default maximum time to wait for a response in seconds. */
|
|
28
|
+
timeoutInSeconds?: number;
|
|
29
|
+
/** Default number of times to retry the request. Defaults to 2. */
|
|
30
|
+
maxRetries?: number;
|
|
31
|
+
/** A custom fetch function. */
|
|
32
|
+
fetch?: typeof fetch;
|
|
33
|
+
/** Logging configuration. */
|
|
34
|
+
logging?: LogConfig | Logger;
|
|
35
|
+
/** A function that returns auth headers. */
|
|
36
|
+
getAuthHeaders?: () => Promise<Record<string, string>>;
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
* Makes a passthrough HTTP request using the SDK's configuration (auth, retry, logging, etc.)
|
|
41
|
+
* while mimicking the standard `fetch` API.
|
|
42
|
+
*
|
|
43
|
+
* @param input - The URL, path, or Request object. If a relative path, it will be resolved against the configured base URL.
|
|
44
|
+
* @param init - Standard RequestInit options (method, headers, body, signal, etc.)
|
|
45
|
+
* @param clientOptions - SDK client options (auth, default headers, logging, etc.)
|
|
46
|
+
* @param requestOptions - Per-request overrides (timeout, retries, extra headers, abort signal).
|
|
47
|
+
* @returns A standard Response object.
|
|
48
|
+
*/
|
|
49
|
+
export declare function makePassthroughRequest(input: Request | string | URL, init: RequestInit | undefined, clientOptions: PassthroughRequest.ClientOptions, requestOptions?: PassthroughRequest.RequestOptions): Promise<Response>;
|
|
@@ -1 +1,6 @@
|
|
|
1
|
-
export declare
|
|
1
|
+
export declare function isCacheNoStoreSupported(): boolean;
|
|
2
|
+
/**
|
|
3
|
+
* Reset the cached result of `isCacheNoStoreSupported`. Exposed for testing only.
|
|
4
|
+
*/
|
|
5
|
+
export declare function resetCacheNoStoreSupported(): void;
|
|
6
|
+
export declare const makeRequest: (fetchFn: (url: string, init: RequestInit) => Promise<Response>, url: string, method: string, headers: Headers | Record<string, string>, requestBody: BodyInit | undefined, timeoutMs?: number, abortSignal?: AbortSignal, withCredentials?: boolean, duplex?: "half", disableCache?: boolean) => Promise<Response>;
|
package/dist/core/headers.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare function mergeHeaders
|
|
2
|
-
export declare function mergeOnlyDefinedHeaders
|
|
1
|
+
export declare function mergeHeaders(...headersArray: (Record<string, unknown> | null | undefined)[]): Record<string, unknown>;
|
|
2
|
+
export declare function mergeOnlyDefinedHeaders(...headersArray: (Record<string, unknown> | null | undefined)[]): Record<string, unknown>;
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export { record } from "./record";
|
|
2
|
-
export type { BaseRecordSchema, RecordSchema } from "./types";
|
|
1
|
+
export { partialRecord, record } from "./record";
|
|
2
|
+
export type { BasePartialRecordSchema, BaseRecordSchema, PartialRecordSchema, RecordSchema } from "./types";
|
|
@@ -1,3 +1,4 @@
|
|
|
1
1
|
import { type Schema } from "../../Schema";
|
|
2
|
-
import type { RecordSchema } from "./types";
|
|
2
|
+
import type { PartialRecordSchema, RecordSchema } from "./types";
|
|
3
3
|
export declare function record<RawKey extends string | number, RawValue, ParsedValue, ParsedKey extends string | number>(keySchema: Schema<RawKey, ParsedKey>, valueSchema: Schema<RawValue, ParsedValue>): RecordSchema<RawKey, RawValue, ParsedKey, ParsedValue>;
|
|
4
|
+
export declare function partialRecord<RawKey extends string | number, RawValue, ParsedValue, ParsedKey extends string | number>(keySchema: Schema<RawKey, ParsedKey>, valueSchema: Schema<RawValue, ParsedValue>): PartialRecordSchema<RawKey, RawValue, ParsedKey, ParsedValue>;
|
|
@@ -2,3 +2,5 @@ import type { BaseSchema } from "../../Schema";
|
|
|
2
2
|
import type { SchemaUtils } from "../schema-utils/index";
|
|
3
3
|
export type RecordSchema<RawKey extends string | number, RawValue, ParsedKey extends string | number, ParsedValue> = BaseRecordSchema<RawKey, RawValue, ParsedKey, ParsedValue> & SchemaUtils<Record<RawKey, RawValue>, Record<ParsedKey, ParsedValue>>;
|
|
4
4
|
export type BaseRecordSchema<RawKey extends string | number, RawValue, ParsedKey extends string | number, ParsedValue> = BaseSchema<Record<RawKey, RawValue>, Record<ParsedKey, ParsedValue>>;
|
|
5
|
+
export type PartialRecordSchema<RawKey extends string | number, RawValue, ParsedKey extends string | number, ParsedValue> = BasePartialRecordSchema<RawKey, RawValue, ParsedKey, ParsedValue> & SchemaUtils<Record<RawKey, RawValue>, Partial<Record<ParsedKey, ParsedValue>>>;
|
|
6
|
+
export type BasePartialRecordSchema<RawKey extends string | number, RawValue, ParsedKey extends string | number, ParsedValue> = BaseSchema<Record<RawKey, RawValue>, Partial<Record<ParsedKey, ParsedValue>>>;
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import type * as Schematic from "../api/types";
|
|
2
|
+
/**
|
|
3
|
+
* Creates a complete deep copy of a Company object.
|
|
4
|
+
*/
|
|
5
|
+
export declare function deepCopyCompany(c: Schematic.RulesengineCompany): Schematic.RulesengineCompany;
|
|
6
|
+
/**
|
|
7
|
+
* Creates a complete deep copy of a User object.
|
|
8
|
+
*/
|
|
9
|
+
export declare function deepCopyUser(u: Schematic.RulesengineUser): Schematic.RulesengineUser;
|
|
10
|
+
/**
|
|
11
|
+
* Merges a partial update into an existing Company.
|
|
12
|
+
* Deep-copies the existing company, then applies only the fields
|
|
13
|
+
* present in the partial object.
|
|
14
|
+
*
|
|
15
|
+
* Wire format uses snake_case keys. The existing company from cache
|
|
16
|
+
* may have either camelCase or snake_case keys depending on how it
|
|
17
|
+
* was stored.
|
|
18
|
+
*/
|
|
19
|
+
export declare function partialCompany(existing: Schematic.RulesengineCompany, partial: Record<string, unknown>): Schematic.RulesengineCompany;
|
|
20
|
+
/**
|
|
21
|
+
* Merges a partial update into an existing User.
|
|
22
|
+
* Deep-copies the existing user, then applies only the fields
|
|
23
|
+
* present in the partial object.
|
|
24
|
+
*/
|
|
25
|
+
export declare function partialUser(existing: Schematic.RulesengineUser, partial: Record<string, unknown>): Schematic.RulesengineUser;
|