@schematichq/schematic-typescript-node 1.2.2 → 1.2.3

package/dist/api/resources/webhooks/client/requests/ListWebhooksRequest.d.ts

@@ -3,7 +3,11 @@
  */
 /**
  * @example
- *     {}
+ *     {
+ *         q: "q",
+ *         limit: 1,
+ *         offset: 1
+ *     }
  */
 export interface ListWebhooksRequest {
     q?: string;

package/dist/api/resources/webhooks/types/ListWebhookEventsResponse.d.ts

@@ -3,7 +3,6 @@
  */
 import * as Schematic from "../../../index";
 export interface ListWebhookEventsResponse {
-    /** The returned resources */
     data: Schematic.WebhookEventDetailResponseData[];
     /** Input parameters */
     params: Schematic.ListWebhookEventsParams;

package/dist/api/resources/webhooks/types/ListWebhooksResponse.d.ts

@@ -3,7 +3,6 @@
  */
 import * as Schematic from "../../../index";
 export interface ListWebhooksResponse {
-    /** The returned resources */
     data: Schematic.WebhookResponseData[];
     /** Input parameters */
     params: Schematic.ListWebhooksParams;

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

@@ -1,9 +1,6 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-/**
- * The created resource
- */
 export interface ApiKeyCreateResponseData {
     createdAt: Date;
     description?: string;

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

@@ -1,9 +1,6 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-/**
- * The returned resource
- */
 export interface ApiKeyRequestResponseData {
     apiKeyId: string;
     endedAt?: Date;

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

@@ -1,9 +1,6 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-/**
- * The updated resource
- */
 export interface ApiKeyResponseData {
     createdAt: Date;
     description?: string;

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

@@ -13,6 +13,7 @@ export interface BillingCreditBundleResponseData {
     expiryType: string;
     expiryUnit: string;
     expiryUnitCount?: number;
+    hasGrants: boolean;
     id: string;
     name: string;
     pluralName?: string;

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

@@ -13,6 +13,7 @@ export interface BillingCreditBundleView {
     expiryType: string;
     expiryUnit: string;
     expiryUnitCount?: number;
+    hasGrants: boolean;
     id: string;
     name: string;
     pluralName?: string;

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface BillingCreditLedgerResponseData {
+    description?: string;
+    icon?: string;
+    id: string;
+    name: string;
+    pluralName?: string;
+    singularName?: string;
+}

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

@@ -1,9 +1,6 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-/**
- * The created resource
- */
 export interface BillingCustomerResponseData {
     companyId?: string;
     deletedAt?: Date;

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

@@ -5,10 +5,17 @@ export interface BillingPlanCreditGrantResponseData {
     createdAt: Date;
     creditAmount: number;
     creditId: string;
+    creditName: string;
+    creditPluralName?: string;
+    creditSingularName?: string;
+    expiryType?: string;
+    expiryUnit?: string;
+    expiryUnitCount?: number;
     id: string;
     planId: string;
     planName: string;
     resetCadence: string;
     resetStart: string;
+    resetType?: string;
     updatedAt: Date;
 }

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

@@ -5,7 +5,8 @@ import * as Schematic from "../index";
 export interface BillingProductDetailResponseData {
     accountId: string;
     createdAt: Date;
-    currency: string;
+    /** Deprecated; currencies are associated with prices, not products */
+    currency?: string;
     environmentId: string;
     externalId: string;
     isActive: boolean;

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

@@ -4,6 +4,7 @@
 import * as Schematic from "../index";
 export interface BillingProductForSubscriptionResponseData {
     billingScheme: string;
+    billingThreshold?: number;
     createdAt: Date;
     currency: string;
     environmentId: string;
@@ -20,6 +21,7 @@ export interface BillingProductForSubscriptionResponseData {
     priceTier: Schematic.BillingProductPriceTierResponseData[];
     quantity: number;
     subscriptionId: string;
+    subscriptionItemExternalId?: string;
     updatedAt: Date;
     usageType: string;
 }

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

@@ -1,9 +1,6 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-/**
- * The updated resource
- */
 export interface BillingProductPlanResponseData {
     accountId: string;
     billingProductId: string;

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

@@ -3,6 +3,7 @@
  */
 import * as Schematic from "../index";
 export interface BillingProductPricing {
+    billingThreshold?: number;
     currency: string;
     interval: string;
     meterId?: string;
@@ -12,5 +13,6 @@ export interface BillingProductPricing {
     priceExternalId: string;
     productExternalId: string;
     quantity: number;
+    subscriptionItemExternalId?: string;
     usageType: Schematic.BillingProductPricingUsageType;
 }

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

@@ -4,7 +4,8 @@
 export interface BillingProductResponseData {
     accountId: string;
     createdAt: Date;
-    currency: string;
+    /** Deprecated; currencies are associated with prices, not products */
+    currency?: string;
     environmentId: string;
     externalId: string;
     isActive: boolean;

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

@@ -2,9 +2,6 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Schematic from "../index";
-/**
- * The updated resource
- */
 export interface BillingSubscriptionView {
     cancelAt?: number;
     cancelAtPeriodEnd: boolean;

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

@@ -1,9 +1,6 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-/**
- * The returned resource
- */
 export interface CheckFlagResponseData {
     /** If company keys were provided and matched a company, its ID */
     companyId?: string;

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

@@ -2,9 +2,6 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Schematic from "../index";
-/**
- * The created resource
- */
 export interface CheckFlagsResponseData {
     flags: Schematic.CheckFlagResponseData[];
 }

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

@@ -2,9 +2,6 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Schematic from "../index";
-/**
- * The requested resource
- */
 export interface CheckoutDataResponseData {
     activeAddOns: Schematic.PlanDetailResponseData[];
     activePlan?: Schematic.PlanDetailResponseData;

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CheckoutSettingsResponseData {
+    collectAddress: boolean;
+    collectEmail: boolean;
+    collectPhone: boolean;
+}

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

@@ -0,0 +1,25 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CheckoutSubscription {
+    cancelAt?: number;
+    cancelAtPeriodEnd: boolean;
+    companyId?: string;
+    confirmPaymentIntentClientSecret?: string;
+    confirmPaymentIntentId?: string;
+    createdAt: Date;
+    currency: string;
+    customerExternalId: string;
+    defaultPaymentMethodId?: string;
+    expiredAt?: Date;
+    id: string;
+    interval: string;
+    metadata?: Record<string, unknown>;
+    periodEnd: number;
+    periodStart: number;
+    status: string;
+    subscriptionExternalId: string;
+    totalPrice: number;
+    trialEnd?: number;
+    trialEndSetting?: string;
+}

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

@@ -20,6 +20,7 @@ export interface CompanyDetailResponseData {
     paymentMethods: Schematic.PaymentMethodResponseData[];
     plan?: Schematic.CompanyPlanWithBillingSubView;
     plans: Schematic.GenericPreviewObject[];
+    rules: Schematic.Rule[];
     /** A map of trait names to trait values */
     traits?: Record<string, unknown>;
     updatedAt: Date;

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CompanyLedgerResponseData {
+    id: string;
+    logoUrl?: string;
+    name: string;
+}

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CompanyOverrideNoteResponseData {
+    createdAt: Date;
+    externalUserId: string;
+    externalUserName: string;
+    id: string;
+    note: string;
+    updatedAt: Date;
+}

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

@@ -14,6 +14,7 @@ export interface CompanyOverrideResponseData {
     id: string;
     metricPeriod?: string;
     metricPeriodMonthReset?: string;
+    notes: Schematic.CompanyOverrideNoteResponseData[];
     ruleId?: string;
     ruleIdUsageExceeded?: string;
     updatedAt: Date;

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

@@ -30,6 +30,7 @@ export interface CompanyPlanDetailResponseData {
     planType: string;
     trialDays?: number;
     updatedAt: Date;
+    usageViolations: Schematic.FeatureUsageResponseData[];
     valid: boolean;
     yearlyPrice?: Schematic.BillingPriceResponseData;
 }

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

@@ -21,6 +21,7 @@ export interface CompanyViewWithFeatureUsageResponseData {
     paymentMethods: Schematic.PaymentMethodResponseData[];
     plan?: Schematic.CompanyPlanWithBillingSubView;
     plans: Schematic.GenericPreviewObject[];
+    rules: Schematic.Rule[];
     /** A map of trait names to trait values */
     traits?: Record<string, unknown>;
     updatedAt: Date;

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ComponentCheckoutSettings {
+    collectAddress: boolean;
+    collectEmail: boolean;
+    collectPhone: boolean;
+    taxCollectionEnabled: boolean;
+}

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

@@ -8,13 +8,17 @@ export interface ComponentHydrateResponseData {
     activeUsageBasedEntitlements: Schematic.UsageBasedEntitlementResponseData[];
     addOnCompatibilities: Schematic.CompatiblePlans[];
     capabilities?: Schematic.ComponentCapabilities;
+    checkoutSettings: Schematic.ComponentCheckoutSettings;
     company?: Schematic.CompanyDetailResponseData;
     component?: Schematic.ComponentResponseData;
     creditBundles: Schematic.BillingCreditBundleView[];
     creditGrants: Schematic.CreditCompanyGrantView[];
     defaultPlan?: Schematic.PlanDetailResponseData;
     featureUsage?: Schematic.FeatureUsageDetailResponseData;
+    postTrialPlan?: Schematic.PlanDetailResponseData;
+    showCredits: boolean;
     showPeriodToggle: boolean;
+    showZeroPriceAsFree: boolean;
     stripeEmbed?: Schematic.StripeEmbedInfo;
     subscription?: Schematic.CompanySubscriptionResponseData;
     trialPaymentMethodRequired?: boolean;

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

@@ -2,15 +2,13 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Schematic from "../index";
-/**
- * The returned resource
- */
 export interface ComponentPreviewResponseData {
     activeAddOns: Schematic.CompanyPlanDetailResponseData[];
     activePlans: Schematic.CompanyPlanDetailResponseData[];
     activeUsageBasedEntitlements: Schematic.UsageBasedEntitlementResponseData[];
     addOnCompatibilities: Schematic.CompatiblePlans[];
     capabilities?: Schematic.ComponentCapabilities;
+    checkoutSettings: Schematic.ComponentCheckoutSettings;
     company?: Schematic.CompanyDetailResponseData;
     component?: Schematic.ComponentResponseData;
     creditBundles: Schematic.BillingCreditBundleView[];
@@ -18,7 +16,10 @@ export interface ComponentPreviewResponseData {
     defaultPlan?: Schematic.PlanDetailResponseData;
     featureUsage?: Schematic.FeatureUsageDetailResponseData;
     invoices: Schematic.InvoiceResponseData[];
+    postTrialPlan?: Schematic.PlanDetailResponseData;
+    showCredits: boolean;
     showPeriodToggle: boolean;
+    showZeroPriceAsFree: boolean;
     stripeEmbed?: Schematic.StripeEmbedInfo;
     subscription?: Schematic.CompanySubscriptionResponseData;
     trialPaymentMethodRequired?: boolean;

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

@@ -1,9 +1,6 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-/**
- * The updated resource
- */
 export interface ComponentResponseData {
     ast?: Record<string, number>;
     createdAt: Date;

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

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Schematic from "../index";
+export interface Condition {
+    accountId: string;
+    comparisonTraitDefinition?: Schematic.TraitDefinition;
+    conditionType: string;
+    consumptionRate?: number;
+    creditId?: string;
+    environmentId: string;
+    eventSubtype?: string;
+    id: string;
+    metricPeriod?: string;
+    metricPeriodMonthReset?: string;
+    metricValue?: number;
+    operator: string;
+    resourceIds: string[];
+    traitDefinition?: Schematic.TraitDefinition;
+    traitValue: string;
+}

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

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Schematic from "../index";
+export interface ConditionGroup {
+    conditions: Schematic.Condition[];
+}

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

@@ -1,9 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-/**
- * The created resource
- */
 export interface CountResponse {
-    count: number;
+    /** The number of resources */
+    count?: number;
 }

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

@@ -12,6 +12,9 @@ export interface CreditCompanyGrantView {
     creditIcon?: string;
     creditName: string;
     expiresAt?: Date;
+    expiryType?: string;
+    expiryUnit?: string;
+    expiryUnitCount?: number;
     grantReason: string;
     id: string;
     planId?: string;

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Schematic from "../index";
+export interface CreditGrantDetail {
+    creditTypeIcon?: string;
+    expiresAt?: Date;
+    grantReason: Schematic.CreditGrantDetailGrantReason;
+    quantity: number;
+}

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type CreditGrantDetailGrantReason = "free" | "plan" | "purchased";
+export declare const CreditGrantDetailGrantReason: {
+    readonly Free: "free";
+    readonly Plan: "plan";
+    readonly Purchased: "purchased";
+};

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

@@ -0,0 +1,27 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Schematic from "../index";
+export interface CreditLedgerEnrichedEntryResponseData {
+    billingCreditId: string;
+    company?: Schematic.CompanyLedgerResponseData;
+    companyId: string;
+    credit?: Schematic.BillingCreditLedgerResponseData;
+    expiredGrantCount: number;
+    feature?: Schematic.FeatureLedgerResponseData;
+    featureId?: string;
+    firstTransactionAt: Date;
+    freeGrantCount: number;
+    grantCount: number;
+    lastTransactionAt: Date;
+    manuallyZeroedCount: number;
+    netChange: number;
+    planGrantCount: number;
+    purchasedGrantCount: number;
+    timeBucket: Date;
+    totalConsumed: number;
+    totalGranted: number;
+    transactionCount: number;
+    usageCount: number;
+    zeroedOutCount: number;
+}

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

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Schematic from "../index";
+export interface CreditUsage {
+    creditConsumptionRate?: number;
+    creditGrantCounts?: Record<string, number>;
+    creditGrantDetails?: Schematic.CreditGrantDetail[];
+    creditRemaining?: number;
+    creditTotal?: number;
+    creditTypeIcon?: string;
+    creditTypeName?: string;
+    creditUsed?: number;
+}

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

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Schematic from "../index";
+export interface CreditUsageResponseData {
+    creditConsumptionRate?: number;
+    creditGrantCounts?: Record<string, number>;
+    creditGrantDetails: Schematic.CreditGrantDetail[];
+    creditRemaining?: number;
+    creditTotal?: number;
+    creditTypeIcon?: string;
+    creditTypeName?: string;
+    creditUsed?: number;
+}

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

@@ -1,9 +1,6 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-/**
- * The created resource
- */
 export interface CrmDealResponseData {
     accountId: string;
     arr: string;

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

@@ -1,9 +1,6 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-/**
- * The created resource
- */
 export interface CrmLineItemResponseData {
     accountId: string;
     createdAt: Date;

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

@@ -1,9 +1,6 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-/**
- * The created resource
- */
 export interface CrmProductResponseData {
     accountId: string;
     createdAt: Date;

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

@@ -1,9 +1,6 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-/**
- * The created resource
- */
 export interface DataExportResponseData {
     accountId: string;
     createdAt: Date;

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

@@ -2,9 +2,6 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Schematic from "../index";
-/**
- * The created resource
- */
 export interface EnvironmentDetailResponseData {
     apiKeys: Schematic.ApiKeyResponseData[];
     createdAt: Date;

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

@@ -1,9 +1,6 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-/**
- * The updated resource
- */
 export interface EnvironmentResponseData {
     createdAt: Date;
     environmentType: string;

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

@@ -10,17 +10,50 @@ export interface FeatureCompanyResponseData {
     /** The type of allocation that is being used. */
     allocationType: Schematic.FeatureCompanyResponseDataAllocationType;
     company?: Schematic.CompanyDetailResponseData;
+    companyOverride?: Schematic.CompanyOverrideResponseData;
+    /** The rate at which credits are consumed per unit of usage */
+    creditConsumptionRate?: number;
+    creditGrantCounts?: Record<string, number>;
+    creditGrantDetails?: Schematic.CreditGrantDetail[];
+    /** Reason for the credit grant */
+    creditGrantReason?: Schematic.FeatureCompanyResponseDataCreditGrantReason;
+    creditRemaining?: number;
+    creditTotal?: number;
+    /** Icon identifier for the credit type */
+    creditTypeIcon?: string;
+    creditUsage?: Schematic.CreditUsage;
+    creditUsed?: number;
+    /** Effective limit for usage calculations. For overage pricing, this is the soft limit where overage charges begin. For tiered pricing, this is the first tier boundary. For other pricing models, this is the base allocation. Used to calculate usage percentages and determine access thresholds. */
+    effectiveLimit?: number;
+    /** Per-unit price for current usage scenario */
+    effectivePrice?: number;
     entitlementExpirationDate?: Date;
     entitlementId: string;
+    /** Source of the entitlement (plan or company_override) */
+    entitlementSource?: string;
     entitlementType: string;
     feature?: Schematic.FeatureDetailResponseData;
-    /** The time at which the metric will resets. */
+    /** Whether a valid allocation exists */
+    hasValidAllocation?: boolean;
+    /** Whether this is an unlimited allocation */
+    isUnlimited?: boolean;
+    /** The time at which the metric will reset. */
     metricResetAt?: Date;
     /** If the period is current_month, when the month resets. */
     monthReset?: string;
+    monthlyUsageBasedPrice?: Schematic.BillingPriceView;
+    /** Amount of usage exceeding soft limit (overage pricing only) */
+    overuse?: number;
+    /** Percentage of allocation consumed (0-100+) */
+    percentUsed?: number;
     /** The period over which usage is measured. */
     period?: string;
     plan?: Schematic.PlanResponseData;
+    planEntitlement?: Schematic.PlanEntitlementResponseData;
+    priceBehavior?: string;
+    /** The soft limit for the feature usage. Available only for overage price behavior */
+    softLimit?: number;
     /** The amount of usage that has been consumed; a null value indicates that usage is not being measured. */
     usage?: number;
+    yearlyUsageBasedPrice?: Schematic.BillingPriceView;
 }