@schematichq/schematic-typescript-node 1.5.3 → 1.5.5

package/dist/api/types/ManagePlanRequest.d.ts

@@ -4,6 +4,8 @@ export interface ManagePlanRequest {
     basePlanId?: string;
     basePlanPriceId?: string;
     basePlanVersionId?: string;
+    /** The company that pays for this subscription. Must already have a Stripe customer. Only honored when starting a new subscription. */
+    billingEntityId?: string;
     /** If false, subscription cancels at period end. Only applies when removing all plans. Defaults to true. */
     cancelImmediately?: boolean;
     companyId: string;

package/dist/api/types/MetronomeIntegrationConfig.d.ts

@@ -1 +1,4 @@
-export type MetronomeIntegrationConfig = {};
+export interface MetronomeIntegrationConfig {
+    /** Schematic company key used to store the Metronome customer's ingest alias; when unset, imported customers carry only metronome_customer_id */
+    externalCustomerIdKey?: string;
+}

package/dist/api/types/PlanBundleResponseData.d.ts

@@ -4,5 +4,4 @@ export interface PlanBundleResponseData {
     creditGrants?: Schematic.BillingPlanCreditGrantResponseData[];
     entitlements?: Schematic.PlanEntitlementResponseData[];
     plan?: Schematic.PlanResponseData;
-    traits?: Schematic.PlanTraitResponseData[];
 }

package/dist/api/types/PlanCatalogMembershipResponseData.d.ts

@@ -0,0 +1,4 @@
+export interface PlanCatalogMembershipResponseData {
+    id: string;
+    name: string;
+}

package/dist/api/types/PlanCreditGrantView.d.ts

@@ -2,6 +2,7 @@ import type * as Schematic from "../index";
 export interface PlanCreditGrantView {
     billingCreditAutoTopupAmount?: number;
     billingCreditAutoTopupAmountType?: string;
+    billingCreditAutoTopupAvailability?: Schematic.BillingCreditAutoTopupAvailability;
     billingCreditAutoTopupEnabled: boolean;
     billingCreditAutoTopupExpiryType?: Schematic.BillingCreditExpiryType;
     billingCreditAutoTopupExpiryUnit?: Schematic.BillingCreditExpiryUnit;
@@ -9,6 +10,7 @@ export interface PlanCreditGrantView {
     billingCreditAutoTopupSelfService: boolean;
     billingCreditAutoTopupThresholdCredits?: number;
     billingCreditAutoTopupThresholdPercent?: number;
+    billingCreditCanBuyBundles: boolean;
     createdAt: Date;
     credit?: Schematic.BillingCreditView;
     creditAmount: number;

package/dist/api/types/PlanDetailResponseData.d.ts

@@ -5,13 +5,16 @@ export interface PlanDetailResponseData {
     billingLinkedResource?: Schematic.BillingLinkedResourceResponseData;
     billingProduct?: Schematic.BillingProductDetailResponseData;
     billingStrategy: Schematic.BillingStrategy;
+    catalogs?: Schematic.PlanCatalogMembershipResponseData[];
     chargeType: Schematic.ChargeType;
     companyCount: number;
     companyId?: string;
+    companyLogoUrl?: string;
     companyName?: string;
     controlledBy: Schematic.BillingProviderType;
     copiedFromPlanId?: string;
     createdAt: Date;
+    credits: Schematic.BillingCreditResponseData[];
     currencyPrices: Schematic.PlanCurrencyPricesResponseData[];
     description: string;
     draftVersion?: Schematic.PlanVersionResponseData;

package/dist/api/types/PlanEntitlementResponseData.d.ts

@@ -30,4 +30,5 @@ export interface PlanEntitlementResponseData {
     valueTrait?: Schematic.EntityTraitDefinitionResponseData;
     valueTraitId?: string;
     valueType: Schematic.EntitlementValueType;
+    warningTiers: Schematic.WarningTierResponseData[];
 }

package/dist/api/types/PlanGroupPlanDetailResponseData.d.ts

@@ -6,14 +6,17 @@ export interface PlanGroupPlanDetailResponseData {
     billingLinkedResource?: Schematic.BillingLinkedResourceResponseData;
     billingProduct?: Schematic.BillingProductDetailResponseData;
     billingStrategy: Schematic.BillingStrategy;
+    catalogs?: Schematic.PlanCatalogMembershipResponseData[];
     chargeType: Schematic.ChargeType;
     companyCount: number;
     companyId?: string;
+    companyLogoUrl?: string;
     companyName?: string;
     compatiblePlanIds: string[];
     controlledBy: Schematic.BillingProviderType;
     copiedFromPlanId?: string;
     createdAt: Date;
+    credits: Schematic.BillingCreditResponseData[];
     currencyPrices: Schematic.PlanCurrencyPricesResponseData[];
     customPlanConfig?: Schematic.CustomPlanViewConfigResponseData;
     description: string;

package/dist/api/types/PlanViewPublicResponseData.d.ts

@@ -6,14 +6,17 @@ export interface PlanViewPublicResponseData {
     billingLinkedResource?: Schematic.BillingLinkedResourceResponseData;
     billingProduct?: Schematic.BillingProductDetailResponseData;
     billingStrategy: Schematic.BillingStrategy;
+    catalogs?: Schematic.PlanCatalogMembershipResponseData[];
     chargeType: Schematic.ChargeType;
     companyCount: number;
     companyId?: string;
+    companyLogoUrl?: string;
     companyName?: string;
     compatiblePlanIds: string[];
     controlledBy: Schematic.BillingProviderType;
     copiedFromPlanId?: string;
     createdAt: Date;
+    credits: Schematic.BillingCreditResponseData[];
     currencyPrices: Schematic.PlanCurrencyPricesResponseData[];
     custom: boolean;
     customPlanConfig?: Schematic.CustomPlanConfig;

package/dist/api/types/PreviewSubscriptionDiscountResponseData.d.ts

@@ -0,0 +1,13 @@
+export interface PreviewSubscriptionDiscountResponseData {
+    amountOff?: number;
+    couponName: string;
+    currency?: string;
+    customerFacingCode?: string;
+    duration: string;
+    durationInMonths?: number;
+    endedAt?: Date;
+    isActive: boolean;
+    percentOff?: number;
+    promoCodeExternalId?: string;
+    startedAt: Date;
+}

package/dist/api/types/PreviewSubscriptionFinanceResponseData.d.ts

@@ -1,9 +1,11 @@
 import type * as Schematic from "../index";
 export interface PreviewSubscriptionFinanceResponseData {
     amountOff: number;
+    discounts: Schematic.PreviewSubscriptionDiscountResponseData[];
     dueNow: number;
     newCharges: number;
     percentOff: number;
+    periodEnd: Date;
     periodStart: Date;
     promoCodeApplied: boolean;
     proration: number;

package/dist/api/types/RulesengineFeatureEntitlement.d.ts

@@ -36,4 +36,6 @@ export interface RulesengineFeatureEntitlement {
     usage?: number;
     /** The type of the entitlement value */
     valueType: Schematic.RulesengineEntitlementValueType;
+    /** Customer-defined usage warning thresholds configured on this entitlement */
+    warningTiers?: Schematic.RulesengineWarningTier[];
 }

package/dist/api/types/RulesengineWarningTier.d.ts

@@ -0,0 +1,6 @@
+export interface RulesengineWarningTier {
+    /** A customer-defined identifier for the warning tier */
+    key: string;
+    /** The warning threshold, in the entitlement's usage units */
+    value: number;
+}

package/dist/api/types/UpdateBillingPlanCreditGrantRequestBody.d.ts

@@ -3,6 +3,7 @@ export interface UpdateBillingPlanCreditGrantRequestBody {
     applyToExisting?: boolean;
     autoTopupAmount?: number;
     autoTopupAmountType?: Schematic.CreditAutoTopupAmountType;
+    autoTopupAvailability?: Schematic.BillingCreditAutoTopupAvailability;
     autoTopupEnabled?: boolean;
     autoTopupExpiryType?: Schematic.BillingCreditExpiryType;
     autoTopupExpiryUnit?: Schematic.BillingCreditExpiryUnit;
@@ -10,6 +11,7 @@ export interface UpdateBillingPlanCreditGrantRequestBody {
     autoTopupSelfService?: boolean;
     autoTopupThresholdCredits?: number;
     autoTopupThresholdPercent?: number;
+    canBuyBundles?: boolean;
     creditAmount?: number;
     expiryType?: Schematic.BillingCreditExpiryType;
     expiryUnit?: Schematic.BillingCreditExpiryUnit;

package/dist/api/types/UpsertCompanyRequestBody.d.ts

@@ -1,4 +1,8 @@
 export interface UpsertCompanyRequestBody {
+    /** Assign this base plan when creating the company (starts with plan_). Takes precedence over the environment's initial plan and must be provisionable without a payment method. */
+    basePlanId?: string;
+    /** The Schematic price to provision for base_plan_id (starts with bilpp_). Required and must be $0 for a billing-linked plan; omit for a plan that is not billing-linked. */
+    basePlanPriceId?: string;
     /** If you know the Schematic ID, you can use that here instead of keys */
     id?: string;
     /** See [Key Management](https://docs.schematichq.com/developer_resources/key_management) for more information */

package/dist/api/types/WarningTier.d.ts

@@ -0,0 +1,6 @@
+export interface WarningTier {
+    /** A customer-defined identifier for the warning tier */
+    key: string;
+    /** The warning threshold, in the entitlement's usage units */
+    value: number;
+}

package/dist/api/types/WarningTierRequestBody.d.ts

@@ -0,0 +1,4 @@
+export interface WarningTierRequestBody {
+    key: string;
+    value: number;
+}

package/dist/api/types/WarningTierResponseData.d.ts

@@ -0,0 +1,5 @@
+export interface WarningTierResponseData {
+    id: string;
+    key: string;
+    value: number;
+}

package/dist/api/types/index.d.ts

@@ -9,9 +9,11 @@ export * from "./ApiKeyCreateResponseData";
 export * from "./ApiKeyIntegrationResponseData";
 export * from "./ApiKeyResponseData";
 export * from "./ApiKeyScope";
+export * from "./AuditLogExportMetadata";
 export * from "./AuditLogListResponseData";
 export * from "./AuditLogResponseData";
 export * from "./BillingCouponResponseData";
+export * from "./BillingCreditAutoTopupAvailability";
 export * from "./BillingCreditBundleResponseData";
 export * from "./BillingCreditBundleStatus";
 export * from "./BillingCreditBundleType";
@@ -58,6 +60,18 @@ export * from "./BillingSubscriptionView";
 export * from "./BillingTiersMode";
 export * from "./CaptureRawEvent";
 export * from "./CaptureRawEventBatch";
+export * from "./CatalogConfigOrderedBundle";
+export * from "./CatalogConfigOrderedBundleResponseData";
+export * from "./CatalogConfigOrderedEntitlement";
+export * from "./CatalogConfigOrderedEntitlementResponseData";
+export * from "./CatalogConfigOrderedPlan";
+export * from "./CatalogConfigOrderedPlanResponseData";
+export * from "./CatalogConfigurationResponseData";
+export * from "./CatalogCreditBundleIDsResponseData";
+export * from "./CatalogDerivedFeatureResponseData";
+export * from "./CatalogDerivedFeaturesResponseData";
+export * from "./CatalogPlanIDsResponseData";
+export * from "./CatalogResponseData";
 export * from "./ChangeSubscriptionInternalRequestBody";
 export * from "./ChangeSubscriptionRequestBody";
 export * from "./ChargeType";
@@ -73,10 +87,13 @@ export * from "./CheckoutFieldWithValue";
 export * from "./CheckoutSettingsResponseData";
 export * from "./CheckoutSubscription";
 export * from "./ClerkIntegrationConfig";
+export * from "./CompanyBillingEntityResponseData";
+export * from "./CompanyBillingEntitySubscriptionResponseData";
 export * from "./CompanyCreditBalance";
 export * from "./CompanyCreditBalanceResponseData";
 export * from "./CompanyDetailResponseData";
 export * from "./CompanyEventPeriodMetricsResponseData";
+export * from "./CompanyFeatureUsageExportMetadata";
 export * from "./CompanyLedgerResponseData";
 export * from "./CompanyMatchingCriteria";
 export * from "./CompanyMembershipDetailResponseData";
@@ -155,6 +172,7 @@ export * from "./CustomPlanBillingStatus";
 export * from "./CustomPlanConfig";
 export * from "./CustomPlanViewConfigResponseData";
 export * from "./DataEventPayload";
+export * from "./DataExportMetadata";
 export * from "./DataExportOutputFileType";
 export * from "./DataExportResponseData";
 export * from "./DataExportStatus";
@@ -187,6 +205,7 @@ export * from "./EventBody";
 export * from "./EventBodyFlagCheck";
 export * from "./EventBodyIdentify";
 export * from "./EventBodyIdentifyCompany";
+export * from "./EventBodyInference";
 export * from "./EventBodyTrack";
 export * from "./EventDetailResponseData";
 export * from "./EventResponseData";
@@ -250,6 +269,7 @@ export * from "./PlanBundleAction";
 export * from "./PlanBundleCreditGrantRequestBody";
 export * from "./PlanBundleEntitlementRequestBody";
 export * from "./PlanBundleResponseData";
+export * from "./PlanCatalogMembershipResponseData";
 export * from "./PlanChangeAction";
 export * from "./PlanChangeBasePlanAction";
 export * from "./PlanChangeResponseData";
@@ -287,6 +307,7 @@ export * from "./PlanViewPublicResponseData";
 export * from "./PreviewObject";
 export * from "./PreviewObjectResponseData";
 export * from "./PreviewSubscriptionChangeResponseData";
+export * from "./PreviewSubscriptionDiscountResponseData";
 export * from "./PreviewSubscriptionFinanceResponseData";
 export * from "./PreviewSubscriptionUpcomingInvoiceLineItems";
 export * from "./ProrationBehavior";
@@ -323,6 +344,7 @@ export * from "./RulesengineTrait";
 export * from "./RulesengineTraitDefinition";
 export * from "./RulesengineTraitDefinitionComparableType";
 export * from "./RulesengineUser";
+export * from "./RulesengineWarningTier";
 export * from "./RuleType";
 export * from "./RuleView";
 export * from "./ScheduledCheckoutResponseData";
@@ -367,6 +389,9 @@ export * from "./UsageBasedEntitlementResponseData";
 export * from "./UsageTimeSeriesPointResponseData";
 export * from "./UserDetailResponseData";
 export * from "./UserResponseData";
+export * from "./WarningTier";
+export * from "./WarningTierRequestBody";
+export * from "./WarningTierResponseData";
 export * from "./WebFeatureUsageWebhookOutput";
 export * from "./WebhookEventDetailResponseData";
 export * from "./WebhookEventResponseData";