@schematichq/schematic-typescript-node 1.2.1 → 1.2.3

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;
 }

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

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

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

@@ -4,10 +4,11 @@
 /**
  * The type of allocation that is being used.
  */
-export type FeatureCompanyUserResponseDataAllocationType = "boolean" | "numeric" | "trait" | "unlimited";
+export type FeatureCompanyUserResponseDataAllocationType = "boolean" | "numeric" | "trait" | "unlimited" | "unknown";
 export declare const FeatureCompanyUserResponseDataAllocationType: {
     readonly Boolean: "boolean";
     readonly Numeric: "numeric";
     readonly Trait: "trait";
     readonly Unlimited: "unlimited";
+    readonly Unknown: "unknown";
 };

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

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

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

@@ -1,7 +1,10 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Schematic from "../index";
 export interface FeatureUsageDataResponseData {
+    creditTypeId?: string;
+    creditUsage?: Schematic.CreditUsageResponseData;
     entitlementSource: string;
     entitlementValueType: string;
     featureId: string;
@@ -9,6 +12,11 @@ export interface FeatureUsageDataResponseData {
     featureType: string;
     hardLimit: string;
     hasAccess: boolean;
+    metricResetAt?: Date;
+    monthlyUsageBasedPrice?: Schematic.BillingPriceView;
+    priceBehavior?: string;
     softLimit: string;
     usage: string;
+    valueNumeric?: number;
+    yearlyUsageBasedPrice?: Schematic.BillingPriceView;
 }

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

@@ -10,15 +10,40 @@ export interface FeatureUsageResponseData {
     /** The type of allocation that is being used. */
     allocationType: Schematic.FeatureUsageResponseDataAllocationType;
     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.FeatureUsageResponseDataCreditGrantReason;
+    creditRemaining?: number;
+    creditTotal?: number;
+    /** Icon identifier for the credit type */
+    creditTypeIcon?: string;
+    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;
+    /** 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;

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

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

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

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

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

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Schematic from "../index";
+export interface ManagePlanPreviewResponseResponseData {
+    subscriptionChangePreview?: Schematic.PreviewSubscriptionChangeResponseData;
+}

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

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Schematic from "../index";
+export interface ManagePlanRequest {
+    addOnSelections: Schematic.PlanSelection[];
+    basePlanId?: string;
+    basePlanPriceId?: string;
+    companyId: string;
+    couponExternalId?: string;
+    creditBundles: Schematic.UpdateCreditBundleRequestBody[];
+    payInAdvanceEntitlements: Schematic.UpdatePayInAdvanceRequestBody[];
+    paymentMethodExternalId?: string;
+    promoCode?: string;
+}

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Schematic from "../index";
+export interface ManagePlanResponseResponseData {
+    company?: Schematic.CompanyDetailResponseData;
+    success: boolean;
+}

package/dist/api/types/PlanAudienceDetailResponseData.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 PlanAudienceDetailResponseData {
     conditionGroups: Schematic.RuleConditionGroupDetailResponseData[];
     conditions: Schematic.RuleConditionDetailResponseData[];

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

@@ -8,12 +8,16 @@ export interface PlanCreditGrantView {
     creditIcon?: string;
     creditId: string;
     creditName: string;
+    expiryType?: string;
+    expiryUnit?: string;
+    expiryUnitCount?: number;
     id: string;
     planId: string;
     planName: string;
     pluralName?: string;
     resetCadence: string;
     resetStart: string;
+    resetType: string;
     singularName?: string;
     updatedAt: Date;
 }

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

@@ -13,6 +13,7 @@ export interface PlanDetailResponseData {
     features: Schematic.FeatureDetailResponseData[];
     icon: string;
     id: string;
+    includedCreditGrants?: Schematic.BillingPlanCreditGrantResponseData[];
     isDefault: boolean;
     isFree: boolean;
     isTrialable: boolean;

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

@@ -3,6 +3,7 @@
  */
 import * as Schematic from "../index";
 export interface PlanEntitlementResponseData {
+    billingThreshold?: number;
     consumptionRate?: number;
     createdAt: Date;
     environmentId: string;

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

@@ -2,21 +2,34 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Schematic from "../index";
-/**
- * The returned resource
- */
 export interface PlanGroupDetailResponseData {
     addOns: Schematic.PlanGroupPlanDetailResponseData[];
+    checkoutSettings: Schematic.CheckoutSettingsResponseData;
     customPlanConfig?: Schematic.CustomPlanViewConfigResponseData;
     customPlanId?: string;
     defaultPlan?: Schematic.PlanGroupPlanDetailResponseData;
     defaultPlanId?: string;
+    fallbackPlan?: Schematic.PlanGroupPlanDetailResponseData;
+    fallbackPlanId?: string;
     id: string;
+    initialPlan?: Schematic.PlanGroupPlanDetailResponseData;
+    initialPlanId?: string;
+    initialPlanPrice?: Schematic.BillingPriceResponseData;
+    initialPlanPriceId?: string;
     orderedAddOnList: Schematic.PlanGroupPlanEntitlementsOrder[];
     orderedBundleList: Schematic.PlanGroupBundleOrder[];
     orderedPlanList: Schematic.PlanGroupPlanEntitlementsOrder[];
     plans: Schematic.PlanGroupPlanDetailResponseData[];
+    preventDowngradesWhenOverLimit: boolean;
+    showCredits: boolean;
     showPeriodToggle: boolean;
+    showZeroPriceAsFree: boolean;
+    syncCustomerBillingDetailsForTax: boolean;
+    taxCollectionEnabled: boolean;
     trialDays?: number;
+    trialExpiryPlan?: Schematic.PlanGroupPlanDetailResponseData;
+    trialExpiryPlanId?: string;
+    trialExpiryPlanPrice?: Schematic.BillingPriceResponseData;
+    trialExpiryPlanPriceId?: string;
     trialPaymentMethodRequired?: boolean;
 }

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

@@ -16,6 +16,7 @@ export interface PlanGroupPlanDetailResponseData {
     features: Schematic.FeatureDetailResponseData[];
     icon: string;
     id: string;
+    includedCreditGrants?: Schematic.BillingPlanCreditGrantResponseData[];
     isCustom: boolean;
     isDefault: boolean;
     isFree: boolean;

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

@@ -2,17 +2,25 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Schematic from "../index";
-/**
- * The updated resource
- */
 export interface PlanGroupResponseData {
     addOnCompatibilities: Schematic.CompatiblePlansResponseData[];
     addOnIds: string[];
+    checkoutSettings: Schematic.CheckoutSettingsResponseData;
     defaultPlanId?: string;
+    fallbackPlanId?: string;
     id: string;
+    initialPlanId?: string;
+    initialPlanPriceId?: string;
     orderedAddOnIds: Schematic.OrderedPlansInGroup[];
     planIds: Schematic.OrderedPlansInGroup[];
+    preventDowngradesWhenOverLimit: boolean;
+    showCredits: boolean;
     showPeriodToggle: boolean;
+    showZeroPriceAsFree: boolean;
+    syncCustomerBillingDetailsForTax: boolean;
+    taxCollectionEnabled: boolean;
     trialDays?: number;
+    trialExpiryPlanId?: string;
+    trialExpiryPlanPriceId?: string;
     trialPaymentMethodRequired?: boolean;
 }

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface PlanIssueResponseData {
+    code: string;
+    description: string;
+    detail?: string;
+    id?: string;
+}

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

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface PlanSelection {
+    planId: string;
+    priceId?: string;
+}

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

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

package/dist/api/types/PreviewSubscriptionChangeResponseData.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 PreviewSubscriptionChangeResponseData {
     amountOff: number;
     dueNow: number;

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

@@ -10,6 +10,9 @@ export interface PreviewSubscriptionFinanceResponseData {
     periodStart: Date;
     promoCodeApplied: boolean;
     proration: number;
+    taxAmount?: number;
+    taxDisplayName?: string;
+    taxRequireBillingDetails: boolean;
     trialEnd?: Date;
     upcomingInvoiceLineItems: Schematic.PreviewSubscriptionUpcomingInvoiceLineItems[];
 }

package/dist/api/types/RawEventBatchResponseData.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 RawEventBatchResponseData {
     events: Schematic.RawEventResponseData[];
 }

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

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Schematic from "../index";
+export interface Rule {
+    accountId: string;
+    conditionGroups: Schematic.ConditionGroup[];
+    conditions: Schematic.Condition[];
+    environmentId: string;
+    flagId?: string;
+    id: string;
+    name: string;
+    priority: number;
+    ruleType: string;
+    value: boolean;
+}

package/dist/api/types/RulesDetailResponseData.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 RulesDetailResponseData {
     flag?: Schematic.FlagResponseData;
     rules: Schematic.RuleDetailResponseData[];

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

@@ -1,9 +1,6 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-/**
- * The returned resource
- */
 export interface SegmentStatusResp {
     connected: boolean;
     environmentId: string;

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

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