@schematichq/schematic-typescript-node 1.3.0 → 1.4.0

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

@@ -14,6 +14,7 @@ export interface InvoiceResponseData {
     id: string;
     paymentMethodExternalId?: string;
     providerType: Schematic.BillingProviderType;
+    status?: Schematic.InvoiceStatus;
     subscriptionExternalId?: string;
     subtotal: number;
     updatedAt: Date;

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

@@ -0,0 +1,8 @@
+export declare const InvoiceStatus: {
+    readonly Draft: "draft";
+    readonly Open: "open";
+    readonly Paid: "paid";
+    readonly Uncollectible: "uncollectible";
+    readonly Void: "void";
+};
+export type InvoiceStatus = (typeof InvoiceStatus)[keyof typeof InvoiceStatus];

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

@@ -0,0 +1,9 @@
+import type * as Schematic from "../index";
+export interface LimitTimeSeriesPointResponseData {
+    effectiveAt: Date;
+    isSoftLimit: boolean;
+    limitSource: Schematic.EntitlementType;
+    limitValue?: number;
+    planId?: string;
+    priceBehavior?: Schematic.EntitlementPriceBehavior;
+}

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

@@ -0,0 +1,6 @@
+export declare const PlanBundleAction: {
+    readonly Create: "create";
+    readonly Update: "update";
+    readonly Delete: "delete";
+};
+export type PlanBundleAction = (typeof PlanBundleAction)[keyof typeof PlanBundleAction];

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

@@ -0,0 +1,8 @@
+import type * as Schematic from "../index";
+export interface PlanBundleCreditGrantRequestBody {
+    action: Schematic.PlanBundleAction;
+    createReq?: Schematic.CreateBillingPlanCreditGrantRequestBody;
+    creditGrantId?: string;
+    deleteReq?: Schematic.DeleteBillingPlanCreditGrantRequestBody;
+    updateReq?: Schematic.UpdateBillingPlanCreditGrantRequestBody;
+}

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

@@ -0,0 +1,6 @@
+import type * as Schematic from "../index";
+export interface PlanBundleEntitlementRequestBody {
+    action: Schematic.PlanBundleAction;
+    entitlementId?: string;
+    req?: Schematic.CreateEntitlementInBundleRequestBody;
+}

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

@@ -0,0 +1,8 @@
+import type * as Schematic from "../index";
+export interface PlanBundleResponseData {
+    billingProduct?: Schematic.BillingProductPlanResponseData;
+    creditGrants?: Schematic.BillingPlanCreditGrantResponseData[];
+    entitlements?: Schematic.PlanEntitlementResponseData[];
+    plan?: Schematic.PlanResponseData;
+    traits?: Schematic.PlanTraitResponseData[];
+}

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

@@ -7,6 +7,7 @@ export declare const PlanChangeAction: {
     readonly PlanBillingProductChanged: "plan_billing_product_changed";
     readonly PlanDeleted: "plan_deleted";
     readonly PlanTraitChange: "plan_trait_change";
+    readonly PlanVersionMigration: "plan_version_migration";
     readonly Quickstart: "quickstart";
     readonly SubscriptionChange: "subscription_change";
 };

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

@@ -1,12 +1,13 @@
 import type * as Schematic from "../index";
 export interface PlanChangeResponseData {
     action: Schematic.PlanChangeAction;
-    actorType: Schematic.PlanChangeActorType;
+    actorType: Schematic.ActorType;
     addOnsAdded: Schematic.PlanSnapshotView[];
     addOnsRemoved: Schematic.PlanSnapshotView[];
     apiKey?: Schematic.ApiKeyResponseData;
-    apiKeyRequest?: Schematic.ApiKeyRequestListResponseData;
+    auditLog?: Schematic.AuditLogListResponseData;
     basePlan?: Schematic.PlanSnapshotView;
+    /** Any special behavior that affected the assignment of the base plan during this change. */
     basePlanAction?: Schematic.PlanChangeBasePlanAction;
     company?: Schematic.CompanyResponseData;
     companyId: string;
@@ -15,6 +16,7 @@ export interface PlanChangeResponseData {
     id: string;
     previousBasePlan?: Schematic.PlanSnapshotView;
     requestId?: string;
+    /** If a subscription was changed as a part of this plan change, indicates the type of change that was made. */
     subscriptionChangeAction?: Schematic.PlanChangeSubscriptionAction;
     /** Any traits were updated as part of this plan change (via pay-in-advance entitlements). */
     traitsUpdated: Schematic.SubscriptionTraitUpdate[];

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

@@ -1,4 +1,5 @@
 export declare const PlanChangeSubscriptionAction: {
+    readonly Adjustment: "adjustment";
     readonly Downgrade: "downgrade";
     readonly Invalid: "invalid";
     readonly Subscribe: "subscribe";

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

@@ -8,21 +8,28 @@ export interface PlanCreditGrantView {
     billingCreditAutoTopupExpiryUnitCount?: number;
     billingCreditAutoTopupThresholdPercent?: number;
     createdAt: Date;
+    credit?: Schematic.BillingCreditView;
     creditAmount: number;
+    /** Deprecated field, will be removed in the future. Use Credit.Description instead. */
     creditDescription: string;
+    /** Deprecated field, will be removed in the future. Use Credit.Icon instead. */
     creditIcon?: string;
     creditId: string;
+    /** Deprecated field, will be removed in the future. Use Credit.Name instead. */
     creditName: string;
     expiryType?: Schematic.BillingCreditExpiryType;
     expiryUnit?: Schematic.BillingCreditExpiryUnit;
     expiryUnitCount?: number;
     id: string;
+    plan?: Schematic.GenericPreviewObject;
     planId: string;
-    planName: string;
+    planVersionId?: string;
+    /** Deprecated field, will be removed in the future. Use Credit.PluralName instead. */
     pluralName?: string;
-    resetCadence: Schematic.BillingPlanCreditGrantResetCadence;
-    resetStart: Schematic.BillingPlanCreditGrantResetStart;
+    resetCadence?: Schematic.BillingPlanCreditGrantResetCadence;
+    resetStart?: Schematic.BillingPlanCreditGrantResetStart;
     resetType: Schematic.BillingPlanCreditGrantResetType;
+    /** Deprecated field, will be removed in the future. Use Credit.SingularName instead. */
     singularName?: string;
     updatedAt: Date;
 }

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

@@ -1,5 +1,6 @@
 import type * as Schematic from "../index";
 export interface PlanDetailResponseData {
+    activeVersion?: Schematic.PlanVersionResponseData;
     audienceType?: string;
     billingProduct?: Schematic.BillingProductDetailResponseData;
     chargeType: Schematic.ChargeType;
@@ -7,6 +8,7 @@ export interface PlanDetailResponseData {
     controlledBy: Schematic.PlanControlledByType;
     createdAt: Date;
     description: string;
+    draftVersion?: Schematic.PlanVersionResponseData;
     features: Schematic.FeatureDetailResponseData[];
     icon: string;
     id: string;
@@ -20,5 +22,6 @@ export interface PlanDetailResponseData {
     planType: Schematic.PlanType;
     trialDays?: number;
     updatedAt: Date;
+    versions: Schematic.PlanVersionResponseData[];
     yearlyPrice?: Schematic.BillingPriceResponseData;
 }

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

@@ -23,6 +23,8 @@ export interface PlanGroupDetailResponseData {
     preventSelfServiceDowngradeButtonText?: string;
     preventSelfServiceDowngradeUrl?: string;
     prorationBehavior: string;
+    scheduledDowngradeBehavior?: string;
+    scheduledDowngradePreventWhenOverLimit?: boolean;
     showAsMonthlyPrices: boolean;
     showCredits: boolean;
     showPeriodToggle: boolean;

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

@@ -1,5 +1,6 @@
 import type * as Schematic from "../index";
 export interface PlanGroupPlanDetailResponseData {
+    activeVersion?: Schematic.PlanVersionResponseData;
     audienceType?: string;
     billingProduct?: Schematic.BillingProductDetailResponseData;
     chargeType: Schematic.ChargeType;
@@ -9,6 +10,7 @@ export interface PlanGroupPlanDetailResponseData {
     createdAt: Date;
     customPlanConfig?: Schematic.CustomPlanViewConfigResponseData;
     description: string;
+    draftVersion?: Schematic.PlanVersionResponseData;
     entitlements: Schematic.PlanEntitlementResponseData[];
     features: Schematic.FeatureDetailResponseData[];
     icon: string;
@@ -24,5 +26,6 @@ export interface PlanGroupPlanDetailResponseData {
     planType: Schematic.PlanType;
     trialDays?: number;
     updatedAt: Date;
+    versions: Schematic.PlanVersionResponseData[];
     yearlyPrice?: Schematic.BillingPriceResponseData;
 }

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

@@ -16,6 +16,8 @@ export interface PlanGroupResponseData {
     preventSelfServiceDowngradeButtonText?: string;
     preventSelfServiceDowngradeUrl?: string;
     prorationBehavior: string;
+    scheduledDowngradeBehavior?: string;
+    scheduledDowngradePreventWhenOverLimit?: boolean;
     showAsMonthlyPrices: boolean;
     showCredits: boolean;
     showPeriodToggle: boolean;

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

@@ -0,0 +1,14 @@
+import type * as Schematic from "../index";
+export interface PlanVersionCompanyMigrationResponseData {
+    companyId: string;
+    companyName: string;
+    completedAt?: Date;
+    createdAt: Date;
+    error?: string;
+    id: string;
+    migrationId: string;
+    planVersionIdFrom?: string;
+    startedAt?: Date;
+    status: Schematic.PlanVersionCompanyMigrationStatus;
+    updatedAt: Date;
+}

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

@@ -0,0 +1,8 @@
+export declare const PlanVersionCompanyMigrationStatus: {
+    readonly Completed: "completed";
+    readonly Failed: "failed";
+    readonly InProgress: "in_progress";
+    readonly Pending: "pending";
+    readonly Skipped: "skipped";
+};
+export type PlanVersionCompanyMigrationStatus = (typeof PlanVersionCompanyMigrationStatus)[keyof typeof PlanVersionCompanyMigrationStatus];

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

@@ -0,0 +1,18 @@
+import type * as Schematic from "../index";
+export interface PlanVersionMigrationResponseData {
+    completedAt?: Date;
+    completedCompanies: number;
+    createdAt: Date;
+    error?: string;
+    failedCompanies: number;
+    id: string;
+    planId: string;
+    planVersionIdFrom?: string;
+    planVersionIdTo: string;
+    skippedCompanies: number;
+    startedAt?: Date;
+    status: Schematic.PlanVersionMigrationStatus;
+    strategy: Schematic.PlanVersionMigrationStrategy;
+    totalCompanies: number;
+    updatedAt: Date;
+}

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

@@ -0,0 +1,7 @@
+export declare const PlanVersionMigrationStatus: {
+    readonly Completed: "completed";
+    readonly Failed: "failed";
+    readonly InProgress: "in_progress";
+    readonly Pending: "pending";
+};
+export type PlanVersionMigrationStatus = (typeof PlanVersionMigrationStatus)[keyof typeof PlanVersionMigrationStatus];

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

@@ -0,0 +1,5 @@
+export declare const PlanVersionMigrationStrategy: {
+    readonly Immediate: "immediate";
+    readonly Leave: "leave";
+};
+export type PlanVersionMigrationStrategy = (typeof PlanVersionMigrationStrategy)[keyof typeof PlanVersionMigrationStrategy];

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

@@ -0,0 +1,14 @@
+import type * as Schematic from "../index";
+export interface PlanVersionResponseData {
+    createdAt: Date;
+    description: string;
+    environmentId: string;
+    icon: string;
+    id: string;
+    name: string;
+    originalPlanId?: string;
+    planType: Schematic.PlanType;
+    status: Schematic.PlanVersionStatus;
+    updatedAt: Date;
+    version: number;
+}

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

@@ -0,0 +1,6 @@
+export declare const PlanVersionStatus: {
+    readonly Published: "published";
+    readonly Draft: "draft";
+    readonly Archived: "archived";
+};
+export type PlanVersionStatus = (typeof PlanVersionStatus)[keyof typeof PlanVersionStatus];

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

@@ -0,0 +1,32 @@
+import type * as Schematic from "../index";
+export interface PlanViewPublicResponseData {
+    activeVersion?: Schematic.PlanVersionResponseData;
+    audienceType?: string;
+    billingProduct?: Schematic.BillingProductDetailResponseData;
+    chargeType: Schematic.ChargeType;
+    companyCount: number;
+    compatiblePlanIds: string[];
+    controlledBy: Schematic.PlanControlledByType;
+    createdAt: Date;
+    custom: boolean;
+    customPlanConfig?: Schematic.CustomPlanConfig;
+    description: string;
+    draftVersion?: Schematic.PlanVersionResponseData;
+    entitlements: Schematic.PlanEntitlementResponseData[];
+    features: Schematic.FeatureDetailResponseData[];
+    icon: string;
+    id: string;
+    includedCreditGrants: Schematic.PlanCreditGrantView[];
+    isCustom: boolean;
+    isDefault: boolean;
+    isFree: boolean;
+    isTrialable: boolean;
+    monthlyPrice?: Schematic.BillingPriceResponseData;
+    name: string;
+    oneTimePrice?: Schematic.BillingPriceResponseData;
+    planType: Schematic.PlanType;
+    trialDays?: number;
+    updatedAt: Date;
+    versions: Schematic.PlanVersionResponseData[];
+    yearlyPrice?: Schematic.BillingPriceResponseData;
+}

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

@@ -3,12 +3,14 @@ export interface PreviewSubscriptionChangeResponseData {
     amountOff: number;
     dueNow: number;
     finance?: Schematic.PreviewSubscriptionFinanceResponseData;
+    isScheduledDowngrade: boolean;
     newCharges: number;
     paymentMethodRequired: boolean;
     percentOff: number;
     periodStart: Date;
     promoCodeApplied: boolean;
     proration: number;
+    scheduledChangeTime?: Date;
     trialEnd?: Date;
     usageViolations: Schematic.FeatureUsageResponseData[];
 }

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

@@ -0,0 +1,12 @@
+import type * as Schematic from "../index";
+export interface PublicPlansResponseData {
+    activeAddOns: Schematic.PlanViewPublicResponseData[];
+    activePlans: Schematic.PlanViewPublicResponseData[];
+    addOnCompatibilities: Schematic.CompatiblePlans[];
+    capabilities?: Schematic.ComponentCapabilities;
+    displaySettings: Schematic.ComponentDisplaySettings;
+    showAsMonthlyPrices: boolean;
+    showCredits: boolean;
+    showPeriodToggle: boolean;
+    showZeroPriceAsFree: boolean;
+}

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

@@ -1,7 +1,7 @@
 export interface RawEventResponseData {
     capturedAt: Date;
     eventId?: string;
-    remoteAddr: string;
+    remoteAddr?: string;
     remoteIp: string;
     userAgent: string;
 }

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

@@ -0,0 +1,16 @@
+import type * as Schematic from "../index";
+export interface RuleView {
+    accountId: string;
+    conditionGroups: Schematic.ConditionGroupView[];
+    conditions: Schematic.ConditionView[];
+    createdAt: Date;
+    environmentId: string;
+    flagId?: string;
+    id: string;
+    name: string;
+    planVersionId?: string;
+    priority: number;
+    ruleType: string;
+    updatedAt: Date;
+    value: boolean;
+}

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

@@ -1,6 +1,6 @@
 /** The current schema version hash for rules engine types. The first enum value is always the current version. */
 export declare const RulesEngineSchemaVersion: {
-    readonly FiveHundredFortyNineE6Fea: "549e6fea";
+    readonly V0F048Dd3: "v0f048dd3";
     readonly PlaceholderForFernCompatibility: "placeholder-for-fern-compatibility";
 };
 export type RulesEngineSchemaVersion = (typeof RulesEngineSchemaVersion)[keyof typeof RulesEngineSchemaVersion];

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

@@ -1,6 +1,7 @@
 import type * as Schematic from "../index";
 export interface RulesengineCheckFlagResult {
     companyId?: string;
+    entitlement?: Schematic.RulesengineFeatureEntitlement;
     err?: string;
     featureAllocation?: number;
     featureUsage?: number;

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

@@ -4,12 +4,13 @@ export interface RulesengineCompany {
     basePlanId?: string;
     billingProductIds: string[];
     creditBalances: Record<string, number>;
-    crmProductIds: string[];
+    entitlements?: Schematic.RulesengineFeatureEntitlement[];
     environmentId: string;
     id: string;
     keys: Record<string, string>;
     metrics: Schematic.RulesengineCompanyMetric[];
     planIds: string[];
+    planVersionIds: string[];
     rules: Schematic.RulesengineRule[];
     subscription?: Schematic.RulesengineSubscription;
     traits: Schematic.RulesengineTrait[];

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

@@ -3,9 +3,9 @@ export declare const RulesengineConditionConditionType: {
     readonly BillingProduct: "billing_product";
     readonly Company: "company";
     readonly Credit: "credit";
-    readonly CrmProduct: "crm_product";
     readonly Metric: "metric";
     readonly Plan: "plan";
+    readonly PlanVersion: "plan_version";
     readonly Trait: "trait";
     readonly User: "user";
 };

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

@@ -0,0 +1,9 @@
+export declare const RulesengineEntitlementValueType: {
+    readonly Boolean: "boolean";
+    readonly Credit: "credit";
+    readonly Numeric: "numeric";
+    readonly Trait: "trait";
+    readonly Unknown: "unknown";
+    readonly Unlimited: "unlimited";
+};
+export type RulesengineEntitlementValueType = (typeof RulesengineEntitlementValueType)[keyof typeof RulesengineEntitlementValueType];

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

@@ -0,0 +1,31 @@
+import type * as Schematic from "../index";
+export interface RulesengineFeatureEntitlement {
+    /** If the company has a numeric entitlement for this feature, the allocated amount */
+    allocation?: number;
+    /** If the company has a credit-based entitlement for this feature, the ID of the credit */
+    creditId?: string;
+    /** If the company has a credit-based entitlement for this feature, the remaining credit amount */
+    creditRemaining?: number;
+    /** If the company has a credit-based entitlement for this feature, the total credit amount */
+    creditTotal?: number;
+    /** If the company has a credit-based entitlement for this feature, the amount of credit used */
+    creditUsed?: number;
+    /** If the feature is event-based, the name of the event tracked for usage */
+    eventName?: string;
+    /** The ID of the feature */
+    featureId: string;
+    /** The key of the flag associated with the feature */
+    featureKey: string;
+    /** For event-based feature entitlements, the period over which usage is tracked */
+    metricPeriod?: Schematic.RulesengineFeatureEntitlementMetricPeriod;
+    /** For event-based feature entitlements, when the usage period will reset */
+    metricResetAt?: Date;
+    /** For event-based feature entitlements that have a monthly period, whether that monthly reset is based on the calendar month or a billing cycle */
+    monthReset?: Schematic.RulesengineFeatureEntitlementMonthReset;
+    /** For usage-based pricing, the soft limit for overage charges or the next tier boundary */
+    softLimit?: number;
+    /** If the company has a numeric entitlement for this feature, the current usage amount */
+    usage?: number;
+    /** The type of the entitlement value */
+    valueType: Schematic.RulesengineEntitlementValueType;
+}

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

@@ -0,0 +1,8 @@
+/** For event-based feature entitlements, the period over which usage is tracked */
+export declare const RulesengineFeatureEntitlementMetricPeriod: {
+    readonly AllTime: "all_time";
+    readonly CurrentDay: "current_day";
+    readonly CurrentMonth: "current_month";
+    readonly CurrentWeek: "current_week";
+};
+export type RulesengineFeatureEntitlementMetricPeriod = (typeof RulesengineFeatureEntitlementMetricPeriod)[keyof typeof RulesengineFeatureEntitlementMetricPeriod];

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

@@ -0,0 +1,6 @@
+/** For event-based feature entitlements that have a monthly period, whether that monthly reset is based on the calendar month or a billing cycle */
+export declare const RulesengineFeatureEntitlementMonthReset: {
+    readonly FirstOfMonth: "first_of_month";
+    readonly BillingCycle: "billing_cycle";
+};
+export type RulesengineFeatureEntitlementMonthReset = (typeof RulesengineFeatureEntitlementMonthReset)[keyof typeof RulesengineFeatureEntitlementMonthReset];

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

@@ -0,0 +1,17 @@
+import type * as Schematic from "../index";
+export interface ScheduledCheckoutResponseData {
+    actorType: string;
+    companyId: string;
+    completedAt?: Date;
+    createdAt: Date;
+    errorMessage?: string;
+    executeAfter: Date;
+    fromPlanId: string;
+    id: string;
+    scheduledInterval?: string;
+    scheduledPrice?: number;
+    startedAt?: Date;
+    status: Schematic.ScheduledCheckoutStatus;
+    toPlanId: string;
+    updatedAt: Date;
+}

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

@@ -0,0 +1,8 @@
+export declare const ScheduledCheckoutStatus: {
+    readonly Cancelled: "cancelled";
+    readonly Error: "error";
+    readonly Executing: "executing";
+    readonly Pending: "pending";
+    readonly Success: "success";
+};
+export type ScheduledCheckoutStatus = (typeof ScheduledCheckoutStatus)[keyof typeof ScheduledCheckoutStatus];

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

@@ -0,0 +1,5 @@
+export declare const ScheduledDowngradeConfigBehavior: {
+    readonly EndOfBillingPeriod: "end_of_billing_period";
+    readonly None: "none";
+};
+export type ScheduledDowngradeConfigBehavior = (typeof ScheduledDowngradeConfigBehavior)[keyof typeof ScheduledDowngradeConfigBehavior];

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

@@ -0,0 +1,13 @@
+export interface ScheduledDowngradeResponseData {
+    currency: string;
+    effectiveAfter: Date;
+    fromPlanId: string;
+    fromPlanName: string;
+    fromSubscriptionPrice: number;
+    id: string;
+    interval: string;
+    scheduledInterval?: string;
+    scheduledPrice?: number;
+    toPlanId: string;
+    toPlanName: string;
+}

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

@@ -0,0 +1,7 @@
+export declare const TimeSeriesGranularity: {
+    readonly Daily: "daily";
+    readonly Hourly: "hourly";
+    readonly Monthly: "monthly";
+    readonly Weekly: "weekly";
+};
+export type TimeSeriesGranularity = (typeof TimeSeriesGranularity)[keyof typeof TimeSeriesGranularity];

package/dist/api/{resources/credits/client/requests → types}/UpdateBillingPlanCreditGrantRequestBody.d.ts

@@ -1,11 +1,4 @@
-import type * as Schematic from "../../../../index";
-/**
- * @example
- *     {
- *         resetCadence: "daily",
- *         resetStart: "billing_period"
- *     }
- */
+import type * as Schematic from "../index";
 export interface UpdateBillingPlanCreditGrantRequestBody {
     applyToExisting?: boolean;
     autoTopupAmount?: number;

package/dist/api/{resources/plans/client/requests → types}/UpdatePlanRequestBody.d.ts

@@ -1,9 +1,3 @@
-/**
- * @example
- *     {
- *         name: "name"
- *     }
- */
 export interface UpdatePlanRequestBody {
     description?: string;
     icon?: string;

package/dist/api/{resources/plans/client/requests → types}/UpsertBillingProductRequestBody.d.ts

@@ -1,11 +1,4 @@
-import type * as Schematic from "../../../../index";
-/**
- * @example
- *     {
- *         chargeType: "free",
- *         isTrialable: true
- *     }
- */
+import type * as Schematic from "../index";
 export interface UpsertBillingProductRequestBody {
     billingProductId?: string;
     chargeType: Schematic.ChargeType;

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

@@ -5,6 +5,7 @@ export interface UpsertCompanyRequestBody {
     keys: Record<string, string>;
     lastSeenAt?: Date;
     name?: string;
+    preventKeyRemap?: boolean;
     /** A map of trait names to trait values */
     traits?: Record<string, unknown>;
     updateOnly?: boolean;

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

@@ -0,0 +1,6 @@
+export interface UsageTimeSeriesPointResponseData {
+    periodEnd?: Date;
+    periodStart?: Date;
+    timestamp: Date;
+    usage: number;
+}

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

@@ -0,0 +1,10 @@
+import type * as Schematic from "../index";
+export interface WebFeatureUsageWebhookOutput {
+    allocation?: number;
+    creditUsage?: Schematic.CreditUsage;
+    entitlement: string;
+    feature?: Schematic.FeatureView;
+    metricResetAt?: Date;
+    usage?: number;
+    company?: Schematic.CompanyDetailResponseData;
+}

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

@@ -29,10 +29,13 @@ export declare const WebhookRequestType: {
     readonly PlanEntitlementDeleted: "plan.entitlement.deleted";
     readonly PlanEntitlementUpdated: "plan.entitlement.updated";
     readonly PlanUpdated: "plan.updated";
+    readonly PlanVersionDeleted: "plan_version.deleted";
     readonly RuleDeleted: "rule.deleted";
     readonly TestSend: "test.send";
     readonly UserCreated: "user.created";
     readonly UserDeleted: "user.deleted";
     readonly UserUpdated: "user.updated";
+    readonly AutoTopupHardFailure: "auto.topup.hard.failure";
+    readonly AutoTopupRetryExceeded: "auto.topup.retry.exceeded";
 };
 export type WebhookRequestType = (typeof WebhookRequestType)[keyof typeof WebhookRequestType];

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

@@ -0,0 +1,12 @@
+import type * as Schematic from "../index";
+export interface WhoAmIResponseData {
+    accountId: string;
+    accountName: string;
+    actorType: string;
+    apiKeyId?: string;
+    environmentId?: string;
+    environments: Schematic.EnvironmentResponseData[];
+    stripeUserId?: string;
+    userId?: string;
+    userName?: string;
+}