@schematichq/schematic-typescript-node 1.5.4 → 1.5.6

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

@@ -0,0 +1,36 @@
+export interface CompanyFeatureUsageExportMetadata {
+    /** Restrict the export to these Schematic company IDs (starting with 'comp_') */
+    companyIds?: string[];
+    /** Restrict the export to companies with these billing credit type IDs */
+    creditTypeIds?: string[];
+    /** Schematic feature IDs (starting with 'feat_') to include as usage columns; at least one is required */
+    featureIds: string[];
+    /** Restrict the export to companies that do (or do not) have a scheduled downgrade */
+    hasScheduledDowngrade?: boolean;
+    /** Restrict the export to companies with (or without) a monetized subscription */
+    monetizedSubscriptions?: boolean;
+    /** Account member emails to notify when the export completes; empty means the artifact is only retrievable via the API */
+    notificationEmailRecipientEmailAddresses?: string[];
+    /** Restrict the export to companies on this plan ID (starting with 'plan_') */
+    planId?: string;
+    /** Restrict the export to companies on any of these plan IDs */
+    planIds?: string[];
+    /** Restrict the export to companies on this plan version ID */
+    planVersionId?: string;
+    /** Free-text search over company name and keys */
+    q?: string;
+    /** Restrict the export to companies whose subscription has one of these statuses */
+    subscriptionStatuses?: string[];
+    /** Restrict the export to companies whose subscription has one of these types */
+    subscriptionTypes?: string[];
+    /** Restrict the export to companies that have an entitlement for this feature ID */
+    withEntitlementFor?: string;
+    /** Restrict the export to companies with a subscription */
+    withSubscription?: boolean;
+    /** Restrict the export to companies without a company-level override for this feature ID */
+    withoutFeatureOverrideFor?: string;
+    /** Restrict the export to companies without a plan */
+    withoutPlan?: boolean;
+    /** Restrict the export to companies without a subscription */
+    withoutSubscription?: boolean;
+}

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

@@ -6,6 +6,7 @@ export interface CompanyPlanDetailResponseData {
     billingLinkedResource?: Schematic.BillingLinkedResourceResponseData;
     billingProduct?: Schematic.BillingProductDetailResponseData;
     billingStrategy: Schematic.BillingStrategy;
+    catalogs?: Schematic.PlanCatalogMembershipResponseData[];
     chargeType: Schematic.ChargeType;
     companyCanTrial: boolean;
     companyCount: number;

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

@@ -1,6 +1,7 @@
 import type * as Schematic from "../index";
 export interface ComponentResponseData {
     ast?: Record<string, number>;
+    catalogId?: string;
     createdAt: Date;
     id: string;
     name: string;

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

@@ -31,6 +31,7 @@ export interface CreateEntitlementInBundleRequestBody {
     valueNumeric?: number;
     valueTraitId?: string;
     valueType: Schematic.EntitlementValueType;
+    warningTiers?: Schematic.WarningTierRequestBody[];
     yearlyMeteredPriceId?: string;
     yearlyPriceTiers?: Schematic.CreatePriceTierRequestBody[];
     yearlyUnitPrice?: number;

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

@@ -0,0 +1,7 @@
+import type * as Schematic from "../index";
+export interface CreditsAutoTopupSuccess {
+    company?: Schematic.CreditsAutoTopupCompanySummary;
+    credit?: Schematic.CreditsAutoTopupCreditSummary;
+    grantId: string;
+    quantity: number;
+}

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

@@ -0,0 +1,9 @@
+import type * as Schematic from "../index";
+export interface CreditsCreditPurchaseSuccess {
+    bundleId: string;
+    bundleName: string;
+    company?: Schematic.CreditsWebhookCompanySummary;
+    credit?: Schematic.CreditsWebhookCreditSummary;
+    grantIds: string[];
+    quantity: number;
+}

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

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

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

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

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

@@ -0,0 +1,8 @@
+export interface CustomerBillingAddress {
+    city: string;
+    country: string;
+    line1: string;
+    line2: string;
+    postalCode: string;
+    state: string;
+}

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

@@ -0,0 +1,10 @@
+import type * as Schematic from "../index";
+export type DataExportMetadata = Schematic.DataExportMetadata.AuditLog | Schematic.DataExportMetadata.CompanyFeatureUsage;
+export declare namespace DataExportMetadata {
+    interface AuditLog extends Schematic.AuditLogExportMetadata {
+        exportType: "audit-log";
+    }
+    interface CompanyFeatureUsage extends Schematic.CompanyFeatureUsageExportMetadata {
+        exportType: "company-feature-usage";
+    }
+}

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

@@ -1 +1,5 @@
-export type DataExportOutputFileType = "csv";
+export declare const DataExportOutputFileType: {
+    readonly Csv: "csv";
+    readonly CsvGz: "csv.gz";
+};
+export type DataExportOutputFileType = (typeof DataExportOutputFileType)[keyof typeof DataExportOutputFileType];

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

@@ -5,7 +5,7 @@ export interface DataExportResponseData {
     environmentId: string;
     exportType: Schematic.DataExportType;
     id: string;
-    metadata: string;
+    metadata?: Schematic.DataExportMetadata;
     outputFileType: Schematic.DataExportOutputFileType;
     status: Schematic.DataExportStatus;
     updatedAt: Date;

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

@@ -1 +1,5 @@
-export type DataExportType = "company-feature-usage";
+export declare const DataExportType: {
+    readonly AuditLog: "audit-log";
+    readonly CompanyFeatureUsage: "company-feature-usage";
+};
+export type DataExportType = (typeof DataExportType)[keyof typeof DataExportType];

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

@@ -1,6 +1,8 @@
 import type * as Schematic from "../index";
 export interface FeatureDetailResponseData {
     billingLinkedResource?: Schematic.BillingLinkedResourceResponseData;
+    /** The billing provider product that sells this feature in the current environment. Set for license features once they have been priced in a plan; a feature priced in several environments has a different product in each. */
+    billingProduct?: Schematic.BillingProductResponseData;
     createdAt: Date;
     description: string;
     eventSubtype?: string;
@@ -9,6 +11,8 @@ export interface FeatureDetailResponseData {
     flags: Schematic.FlagDetailResponseData[];
     icon: string;
     id: string;
+    /** The license sold through this feature. Set only on features of type license, and created automatically with them. */
+    licenseId?: string;
     lifecyclePhase?: Schematic.FeatureLifecyclePhase;
     maintainer?: Schematic.AccountMemberResponseData;
     maintainerAccountMemberId?: string;
@@ -19,4 +23,6 @@ export interface FeatureDetailResponseData {
     trait?: Schematic.EntityTraitDefinitionResponseData;
     traitId?: string;
     updatedAt: Date;
+    /** Set when the feature carries a pay-in-advance quantity. Provisioned lazily for other feature types, and at creation for license features. */
+    usageLimitTraitId?: string;
 }

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

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

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

@@ -9,6 +9,8 @@ export interface FeatureInPlanResponseData {
     flags: Schematic.FlagInPlanResponseData[];
     icon: string;
     id: string;
+    /** The license sold through this feature. Set only on features of type license, and created automatically with them. */
+    licenseId?: string;
     lifecyclePhase?: Schematic.FeatureLifecyclePhase;
     maintainerAccountMemberId?: string;
     name: string;
@@ -18,4 +20,6 @@ export interface FeatureInPlanResponseData {
     trait?: Schematic.EntityTraitDefinitionResponseData;
     traitId?: string;
     updatedAt: Date;
+    /** Set when the feature carries a pay-in-advance quantity. Provisioned lazily for other feature types, and at creation for license features. */
+    usageLimitTraitId?: string;
 }

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

@@ -6,6 +6,8 @@ export interface FeatureResponseData {
     featureType: Schematic.FeatureType;
     icon: string;
     id: string;
+    /** The license sold through this feature. Set only on features of type license, and created automatically with them. */
+    licenseId?: string;
     lifecyclePhase?: Schematic.FeatureLifecyclePhase;
     maintainerAccountMemberId?: string;
     name: string;
@@ -13,4 +15,6 @@ export interface FeatureResponseData {
     singularName?: string;
     traitId?: string;
     updatedAt: Date;
+    /** Set when the feature carries a pay-in-advance quantity. Provisioned lazily for other feature types, and at creation for license features. */
+    usageLimitTraitId?: string;
 }

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

@@ -1,6 +1,7 @@
 export declare const FeatureType: {
     readonly Boolean: "boolean";
     readonly Event: "event";
+    readonly License: "license";
     readonly Trait: "trait";
 };
 export type FeatureType = (typeof FeatureType)[keyof typeof FeatureType];

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

@@ -2,6 +2,7 @@ import type * as Schematic from "../index";
 export interface FeatureView {
     accountId: string;
     billingLinkedResource?: Schematic.BillingLinkedResourceResponseData;
+    billingProduct?: Schematic.BillingProductResponseData;
     createdAt: Date;
     description: string;
     eventSubtype?: string;
@@ -10,6 +11,7 @@ export interface FeatureView {
     flags: Schematic.FlagView[];
     icon: string;
     id: string;
+    licenseId?: string;
     lifecyclePhase?: Schematic.FeatureLifecyclePhase;
     name: string;
     plans: Schematic.PreviewObject[];

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

@@ -0,0 +1,6 @@
+export interface LicenseResponseData {
+    createdAt: Date;
+    id: string;
+    name: string;
+    updatedAt: Date;
+}

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

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

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

@@ -5,6 +5,7 @@ export interface PlanDetailResponseData {
     billingLinkedResource?: Schematic.BillingLinkedResourceResponseData;
     billingProduct?: Schematic.BillingProductDetailResponseData;
     billingStrategy: Schematic.BillingStrategy;
+    catalogs?: Schematic.PlanCatalogMembershipResponseData[];
     chargeType: Schematic.ChargeType;
     companyCount: number;
     companyId?: string;

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

@@ -6,6 +6,7 @@ export interface PlanGroupPlanDetailResponseData {
     billingLinkedResource?: Schematic.BillingLinkedResourceResponseData;
     billingProduct?: Schematic.BillingProductDetailResponseData;
     billingStrategy: Schematic.BillingStrategy;
+    catalogs?: Schematic.PlanCatalogMembershipResponseData[];
     chargeType: Schematic.ChargeType;
     companyCount: number;
     companyId?: string;

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

@@ -0,0 +1,8 @@
+export interface PlanVersionMigrationPreviewCompanyResponseData {
+    companyId: string;
+    hasBillingChanges: boolean;
+    hasCustomPricing: boolean;
+    note?: string;
+    planVersionIdFrom?: string;
+    willUpdateSubscription: boolean;
+}

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

@@ -0,0 +1,4 @@
+import type * as Schematic from "../index";
+export interface PlanVersionMigrationPreviewResponseData {
+    companies: Schematic.PlanVersionMigrationPreviewCompanyResponseData[];
+}

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

@@ -6,6 +6,7 @@ export interface PlanViewPublicResponseData {
     billingLinkedResource?: Schematic.BillingLinkedResourceResponseData;
     billingProduct?: Schematic.BillingProductDetailResponseData;
     billingStrategy: Schematic.BillingStrategy;
+    catalogs?: Schematic.PlanCatalogMembershipResponseData[];
     chargeType: Schematic.ChargeType;
     companyCount: number;
     companyId?: string;

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/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/WebhookRequestType.d.ts

@@ -11,6 +11,7 @@ export declare const WebhookRequestType: {
     readonly CompanyUpdated: "company.updated";
     readonly CreditLimitReached: "credit.limit.reached";
     readonly CreditLimitWarning: "credit.limit.warning";
+    readonly CreditPurchaseSuccess: "credit.purchase.success";
     readonly EntitlementLimitReached: "entitlement.limit.reached";
     readonly EntitlementLimitWarning: "entitlement.limit.warning";
     readonly EntitlementSoftLimitReached: "entitlement.soft_limit.reached";
@@ -38,5 +39,6 @@ export declare const WebhookRequestType: {
     readonly UserUpdated: "user.updated";
     readonly AutoTopupHardFailure: "auto.topup.hard.failure";
     readonly AutoTopupRetryExceeded: "auto.topup.retry.exceeded";
+    readonly AutoTopupSuccess: "auto.topup.success";
 };
 export type WebhookRequestType = (typeof WebhookRequestType)[keyof typeof WebhookRequestType];

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

@@ -9,6 +9,7 @@ export * from "./ApiKeyCreateResponseData";
 export * from "./ApiKeyIntegrationResponseData";
 export * from "./ApiKeyResponseData";
 export * from "./ApiKeyScope";
+export * from "./AuditLogExportMetadata";
 export * from "./AuditLogListResponseData";
 export * from "./AuditLogResponseData";
 export * from "./BillingCouponResponseData";
@@ -59,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";
@@ -74,12 +87,17 @@ export * from "./CheckoutFieldWithValue";
 export * from "./CheckoutSettingsResponseData";
 export * from "./CheckoutSubscription";
 export * from "./ClerkIntegrationConfig";
+export * from "./CompanyBillingAddressView";
+export * from "./CompanyBillingCheckoutSettings";
+export * from "./CompanyBillingDetailsResponseData";
+export * from "./CompanyBillingDetailsView";
 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";
@@ -145,6 +163,10 @@ export * from "./CreditsAutoTopupCompanySummary";
 export * from "./CreditsAutoTopupCreditSummary";
 export * from "./CreditsAutoTopupHardFailure";
 export * from "./CreditsAutoTopupRetryFailure";
+export * from "./CreditsAutoTopupSuccess";
+export * from "./CreditsCreditPurchaseSuccess";
+export * from "./CreditsWebhookCompanySummary";
+export * from "./CreditsWebhookCreditSummary";
 export * from "./CreditTransferResponseData";
 export * from "./CreditTransferView";
 export * from "./CreditTriggerConfig";
@@ -152,12 +174,14 @@ export * from "./CreditUsage";
 export * from "./CreditUsageAggregation";
 export * from "./CreditUsageReason";
 export * from "./CurrencyPriceRequestBody";
+export * from "./CustomerBillingAddress";
 export * from "./CustomPlanActivationStrategy";
 export * from "./CustomPlanBillingResponseData";
 export * from "./CustomPlanBillingStatus";
 export * from "./CustomPlanConfig";
 export * from "./CustomPlanViewConfigResponseData";
 export * from "./DataEventPayload";
+export * from "./DataExportMetadata";
 export * from "./DataExportOutputFileType";
 export * from "./DataExportResponseData";
 export * from "./DataExportStatus";
@@ -235,6 +259,7 @@ export * from "./InvoiceResponseData";
 export * from "./InvoiceStatus";
 export * from "./IssueTemporaryAccessTokenResponseData";
 export * from "./KeysRequestBody";
+export * from "./LicenseResponseData";
 export * from "./LimitTimeSeriesPointResponseData";
 export * from "./ManagePlanPreviewResponseResponseData";
 export * from "./ManagePlanRequest";
@@ -254,6 +279,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";
@@ -281,6 +307,8 @@ export * from "./PlanTraitResponseData";
 export * from "./PlanType";
 export * from "./PlanVersionCompanyMigrationResponseData";
 export * from "./PlanVersionCompanyMigrationStatus";
+export * from "./PlanVersionMigrationPreviewCompanyResponseData";
+export * from "./PlanVersionMigrationPreviewResponseData";
 export * from "./PlanVersionMigrationResponseData";
 export * from "./PlanVersionMigrationStatus";
 export * from "./PlanVersionMigrationStrategy";
@@ -291,6 +319,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";
@@ -327,6 +356,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";
@@ -371,6 +401,7 @@ export * from "./UsageBasedEntitlementResponseData";
 export * from "./UsageTimeSeriesPointResponseData";
 export * from "./UserDetailResponseData";
 export * from "./UserResponseData";
+export * from "./WarningTier";
 export * from "./WarningTierRequestBody";
 export * from "./WarningTierResponseData";
 export * from "./WebFeatureUsageWebhookOutput";