@schematichq/schematic-typescript-node 1.2.7 → 1.3.1

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Schematic from "../index";
+import type * as Schematic from "../index";
 export interface CreateOrUpdateRuleRequestBody {
     conditionGroups: Schematic.CreateOrUpdateConditionGroupRequestBody[];
     conditions: Schematic.CreateOrUpdateConditionRequestBody[];

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

@@ -1,7 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type CreateOrUpdateRuleRequestBodyRuleType = "global_override" | "company_override" | "plan_entitlement" | "standard" | "default";
 export declare const CreateOrUpdateRuleRequestBodyRuleType: {
     readonly GlobalOverride: "global_override";
     readonly CompanyOverride: "company_override";
@@ -9,3 +5,4 @@ export declare const CreateOrUpdateRuleRequestBodyRuleType: {
     readonly Standard: "standard";
     readonly Default: "default";
 };
+export type CreateOrUpdateRuleRequestBodyRuleType = (typeof CreateOrUpdateRuleRequestBodyRuleType)[keyof typeof CreateOrUpdateRuleRequestBodyRuleType];

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

@@ -0,0 +1,7 @@
+import type * as Schematic from "../index";
+export interface CreatePlanRequestBody {
+    description: string;
+    icon?: string;
+    name: string;
+    planType: Schematic.PlanType;
+}

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

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 export interface CreatePriceTierRequestBody {
     flatAmount?: number;
     perUnitPrice?: number;

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

@@ -1,4 +1 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 export type CreditAutoTopupAmountType = "credit";

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Schematic from "../index";
+import type * as Schematic from "../index";
 export interface CreditBundlePurchaseResponseData {
     bundle?: Schematic.BillingCreditBundleResponseData;
     quantity: number;

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Schematic from "../index";
+import type * as Schematic from "../index";
 export interface CreditCompanyGrantView {
     billingCreditBundleId?: string;
     billingCreditId: string;
@@ -11,6 +8,7 @@ export interface CreditCompanyGrantView {
     creditDescription: string;
     creditIcon?: string;
     creditName: string;
+    exhaustedAt?: Date;
     expiresAt?: Date;
     expiryType?: Schematic.BillingCreditExpiryType;
     expiryUnit?: Schematic.BillingCreditExpiryUnit;
@@ -24,8 +22,11 @@ export interface CreditCompanyGrantView {
     quantity: number;
     quantityRemaining: number;
     quantityUsed: number;
+    renewalEnabled: boolean;
+    renewalPeriod?: Schematic.BillingPlanCreditGrantResetCadence;
     singularName?: string;
     sourceLabel: string;
+    transfers?: Schematic.CreditTransferView[];
     updatedAt: Date;
     validFrom?: Date;
     zeroedOutDate?: Date;

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Schematic from "../index";
+import type * as Schematic from "../index";
 export interface CreditGrantDetail {
     creditTypeIcon?: string;
     expiresAt?: Date;

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Schematic from "../index";
+import type * as Schematic from "../index";
 export interface CreditGrantExpiryRequestBody {
     expiryType?: Schematic.BillingCreditExpiryType;
     expiryUnit?: Schematic.BillingCreditExpiryUnit;

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

@@ -1,10 +1,7 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type CreditGrantSortOrder = "created_at" | "expires_at" | "quantity" | "quantity_remaining";
 export declare const CreditGrantSortOrder: {
     readonly CreatedAt: "created_at";
     readonly ExpiresAt: "expires_at";
     readonly Quantity: "quantity";
     readonly QuantityRemaining: "quantity_remaining";
 };
+export type CreditGrantSortOrder = (typeof CreditGrantSortOrder)[keyof typeof CreditGrantSortOrder];

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Schematic from "../index";
+import type * as Schematic from "../index";
 export interface CreditLedgerEnrichedEntryResponseData {
     billingCreditAutoTopupGrantCount: number;
     billingCreditId: string;

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

@@ -1,10 +1,7 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type CreditLedgerPeriod = "daily" | "monthly" | "raw" | "weekly";
 export declare const CreditLedgerPeriod: {
     readonly Daily: "daily";
     readonly Monthly: "monthly";
     readonly Raw: "raw";
     readonly Weekly: "weekly";
 };
+export type CreditLedgerPeriod = (typeof CreditLedgerPeriod)[keyof typeof CreditLedgerPeriod];

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

@@ -0,0 +1,8 @@
+export interface CreditTransferResponseData {
+    amount: number;
+    createdAt: Date;
+    direction: string;
+    id: string;
+    reason: string;
+    relatedGrantId: string;
+}

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

@@ -0,0 +1,8 @@
+export interface CreditTransferView {
+    amount: number;
+    createdAt: Date;
+    direction: string;
+    id: string;
+    reason: string;
+    relatedGrantId: string;
+}

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

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 export interface CreditTriggerConfig {
     creditId: string;
 }

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Schematic from "../index";
+import type * as Schematic from "../index";
 export interface CreditUsage {
     creditConsumptionRate?: number;
     creditGrantCounts?: Record<string, number>;
@@ -11,4 +8,5 @@ export interface CreditUsage {
     creditTypeIcon?: string;
     creditTypeName?: string;
     creditUsed?: number;
+    usageAggregation?: Schematic.CreditUsageAggregation;
 }

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

@@ -0,0 +1,10 @@
+export interface CreditUsageAggregation {
+    /** Credit usage within the current billing period */
+    usageThisBillingPeriod?: number;
+    /** Credit usage within the current calendar month */
+    usageThisCalendarMonth?: number;
+    /** Credit usage within the current calendar week (Monday to Sunday) */
+    usageThisWeek?: number;
+    /** Credit usage for the current day */
+    usageToday?: number;
+}

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

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

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

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 export interface CustomPlanConfig {
     ctaText: string;
     ctaWebSite: string;

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

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 export interface CustomPlanViewConfigResponseData {
     ctaText: string;
     ctaWebSite: string;

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

@@ -1,4 +1 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 export type DataExportOutputFileType = "csv";

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Schematic from "../index";
+import type * as Schematic from "../index";
 export interface DataExportResponseData {
     accountId: string;
     createdAt: Date;

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

@@ -1,9 +1,6 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type DataExportStatus = "failure" | "pending" | "success";
 export declare const DataExportStatus: {
     readonly Failure: "failure";
     readonly Pending: "pending";
     readonly Success: "success";
 };
+export type DataExportStatus = (typeof DataExportStatus)[keyof typeof DataExportStatus];

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

@@ -1,4 +1 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 export type DataExportType = "company-feature-usage";

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

@@ -0,0 +1,3 @@
+export interface DeleteBillingPlanCreditGrantRequestBody {
+    applyToExisting?: boolean;
+}

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

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 export interface DeleteResponse {
     /** Whether the delete was successful */
     deleted?: boolean;

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Schematic from "../index";
+import type * as Schematic from "../index";
 export interface DuplicatePlanEntitlementsResponseResponseData {
     data: Schematic.PlanEntitlementResponseData[];
     skipped: Schematic.SkippedEntitlementResponseData[];

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

@@ -1,7 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type EntitlementPriceBehavior = "credit_burndown" | "overage" | "pay_as_you_go" | "pay_in_advance" | "tier";
 export declare const EntitlementPriceBehavior: {
     readonly CreditBurndown: "credit_burndown";
     readonly Overage: "overage";
@@ -9,3 +5,4 @@ export declare const EntitlementPriceBehavior: {
     readonly PayInAdvance: "pay_in_advance";
     readonly Tier: "tier";
 };
+export type EntitlementPriceBehavior = (typeof EntitlementPriceBehavior)[keyof typeof EntitlementPriceBehavior];

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

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 export interface EntitlementTriggerConfig {
     featureId: string;
 }

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

@@ -1,9 +1,6 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type EntitlementType = "company_override" | "plan_entitlement" | "unknown";
 export declare const EntitlementType: {
     readonly CompanyOverride: "company_override";
     readonly PlanEntitlement: "plan_entitlement";
     readonly Unknown: "unknown";
 };
+export type EntitlementType = (typeof EntitlementType)[keyof typeof EntitlementType];

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

@@ -1,7 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type EntitlementValueType = "boolean" | "credit" | "numeric" | "trait" | "unknown" | "unlimited";
 export declare const EntitlementValueType: {
     readonly Boolean: "boolean";
     readonly Credit: "credit";
@@ -10,3 +6,4 @@ export declare const EntitlementValueType: {
     readonly Unknown: "unknown";
     readonly Unlimited: "unlimited";
 };
+export type EntitlementValueType = (typeof EntitlementValueType)[keyof typeof EntitlementValueType];

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

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 export interface EntitlementsInPlan {
     entitlementId: string;
     visible?: boolean;

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Schematic from "../index";
+import type * as Schematic from "../index";
 export interface EntityKeyDefinitionResponseData {
     createdAt: Date;
     entityType: Schematic.EntityType;

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Schematic from "../index";
+import type * as Schematic from "../index";
 export interface EntityKeyDetailResponseData {
     createdAt: Date;
     definition?: Schematic.EntityKeyDefinitionResponseData;

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Schematic from "../index";
+import type * as Schematic from "../index";
 export interface EntityKeyResponseData {
     createdAt: Date;
     definitionId: string;

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Schematic from "../index";
+import type * as Schematic from "../index";
 export interface EntityTraitDefinitionResponseData {
     createdAt: Date;
     displayName: string;

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Schematic from "../index";
+import type * as Schematic from "../index";
 export interface EntityTraitDetailResponseData {
     createdAt: Date;
     definition?: Schematic.EntityTraitDefinitionResponseData;

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

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 export interface EntityTraitResponseData {
     createdAt: Date;
     definitionId: string;

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

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 export interface EntityTraitValue {
     definitionId: string;
     value: string;

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

@@ -1,8 +1,5 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type EntityType = "company" | "user";
 export declare const EntityType: {
     readonly Company: "company";
     readonly User: "user";
 };
+export type EntityType = (typeof EntityType)[keyof typeof EntityType];

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Schematic from "../index";
+import type * as Schematic from "../index";
 export interface EnvironmentDetailResponseData {
     apiKeys: Schematic.ApiKeyResponseData[];
     createdAt: Date;

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Schematic from "../index";
+import type * as Schematic from "../index";
 export interface EnvironmentResponseData {
     createdAt: Date;
     environmentType: Schematic.EnvironmentType;

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

@@ -1,9 +1,6 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type EnvironmentType = "development" | "production" | "staging";
 export declare const EnvironmentType: {
     readonly Development: "development";
     readonly Production: "production";
     readonly Staging: "staging";
 };
+export type EnvironmentType = (typeof EnvironmentType)[keyof typeof EnvironmentType];

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

@@ -1,5 +1,2 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Schematic from "../index";
+import type * as Schematic from "../index";
 export type EventBody = Schematic.EventBodyTrack | Schematic.EventBodyFlagCheck | Schematic.EventBodyIdentify;

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

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 export interface EventBodyFlagCheck {
     /** Schematic company ID (starting with 'comp_') of the company evaluated, if any */
     companyId?: string;

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Schematic from "../index";
+import type * as Schematic from "../index";
 export interface EventBodyIdentify {
     /** Information about the company associated with the user; required only if it is a new user */
     company?: Schematic.EventBodyIdentifyCompany;

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

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 /**
  * Information about the company associated with the user; required only if it is a new user
  */

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

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 export interface EventBodyTrack {
     /** Key-value pairs to identify company associated with track event */
     company?: Record<string, string>;

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Schematic from "../index";
+import type * as Schematic from "../index";
 export interface EventDetailResponseData {
     apiKey?: string;
     body: Record<string, unknown>;
@@ -22,7 +19,7 @@ export interface EventDetailResponseData {
     status: Schematic.EventStatus;
     subtype?: string;
     type: Schematic.EventType;
-    updatedAt: Date;
+    updatedAt?: Date;
     user?: Schematic.PreviewObject;
     userId?: string;
 }

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Schematic from "../index";
+import type * as Schematic from "../index";
 export interface EventResponseData {
     apiKey?: string;
     body: Record<string, unknown>;
@@ -20,6 +17,6 @@ export interface EventResponseData {
     status: Schematic.EventStatus;
     subtype?: string;
     type: Schematic.EventType;
-    updatedAt: Date;
+    updatedAt?: Date;
     userId?: string;
 }

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

@@ -1,7 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type EventStatus = "enriched" | "failed" | "pending" | "processed" | "unknown";
 export declare const EventStatus: {
     readonly Enriched: "enriched";
     readonly Failed: "failed";
@@ -9,3 +5,4 @@ export declare const EventStatus: {
     readonly Processed: "processed";
     readonly Unknown: "unknown";
 };
+export type EventStatus = (typeof EventStatus)[keyof typeof EventStatus];

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

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 export interface EventSummaryResponseData {
     companyCount: number;
     environmentId: string;

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

@@ -1,9 +1,6 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type EventType = "flag_check" | "identify" | "track";
 export declare const EventType: {
     readonly FlagCheck: "flag_check";
     readonly Identify: "identify";
     readonly Track: "track";
 };
+export type EventType = (typeof EventType)[keyof typeof EventType];

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

@@ -1,11 +1,8 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Schematic from "../index";
+import type * as Schematic from "../index";
 export interface FeatureCompanyResponseData {
     /** Whether further usage is permitted. */
     access: boolean;
-    /** The maximum amount of usage that is permitted; a null value indicates that unlimited usage is permitted. */
+    /** The maximum amount of usage that is permitted; a null value indicates that unlimited usage is permitted or that this is a credit-based entitlement (use credit_remaining instead). */
     allocation?: number;
     allocationType: Schematic.EntitlementValueType;
     company?: Schematic.CompanyDetailResponseData;
@@ -16,10 +13,12 @@ export interface FeatureCompanyResponseData {
     creditGrantDetails?: Schematic.CreditGrantDetail[];
     creditGrantReason?: Schematic.BillingCreditGrantReason;
     creditRemaining?: number;
+    /** Deprecated: Use credit_remaining instead. */
     creditTotal?: number;
     /** Icon identifier for the credit type */
     creditTypeIcon?: string;
     creditUsage?: Schematic.CreditUsage;
+    creditUsageAggregation?: Schematic.CreditUsageAggregation;
     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;
@@ -51,7 +50,7 @@ export interface FeatureCompanyResponseData {
     priceBehavior?: Schematic.EntitlementPriceBehavior;
     /** 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. */
+    /** The amount of usage that has been consumed; a null value indicates that usage is not being measured or that this is a credit-based entitlement (use credit_used instead). */
     usage?: number;
     yearlyUsageBasedPrice?: Schematic.BillingPriceView;
 }

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Schematic from "../index";
+import type * as Schematic from "../index";
 export interface FeatureCompanyUserResponseData {
     /** Whether further usage is permitted. */
     access: boolean;

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

@@ -1,7 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Schematic from "../index";
+import type * as Schematic from "../index";
 export interface FeatureDetailResponseData {
     createdAt: Date;
     description: string;

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

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