@schematichq/schematic-typescript-node 1.5.12 → 1.6.0

package/dist/api/resources/billing/client/requests/CreateBillingSubscriptionRequestBody.d.ts

@@ -42,6 +42,7 @@ export interface CreateBillingSubscriptionRequestBody {
     periodStart?: number;
     productExternalIds: Schematic.BillingProductPricing[];
     providerType?: Schematic.BillingProviderType;
+    startedAt?: Date;
     status?: string;
     subscriptionExternalId: string;
     totalPrice: number;

package/dist/api/resources/credits/client/Client.d.ts

@@ -447,7 +447,6 @@ export declare class CreditsClient {
     private __extendCreditLease;
     /**
      * @param {string} lease_id - lease_id
-     * @param {Schematic.ReleaseCreditLeaseRequestBody} request
      * @param {CreditsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Schematic.BadRequestError}
@@ -459,11 +458,9 @@ export declare class CreditsClient {
      * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
-     *     await client.credits.releaseCreditLease("lease_id", {
-     *         "key": "value"
-     *     })
+     *     await client.credits.releaseCreditLease("lease_id")
      */
-    releaseCreditLease(lease_id: string, request: Schematic.ReleaseCreditLeaseRequestBody, requestOptions?: CreditsClient.RequestOptions): core.HttpResponsePromise<Schematic.ReleaseCreditLeaseResponse>;
+    releaseCreditLease(lease_id: string, requestOptions?: CreditsClient.RequestOptions): core.HttpResponsePromise<Schematic.ReleaseCreditLeaseResponse>;
     private __releaseCreditLease;
     /**
      * @param {Schematic.ListBillingPlanCreditGrantsRequest} request
@@ -597,6 +594,45 @@ export declare class CreditsClient {
      */
     countBillingPlanCreditGrants(request?: Schematic.CountBillingPlanCreditGrantsRequest, requestOptions?: CreditsClient.RequestOptions): core.HttpResponsePromise<Schematic.CountBillingPlanCreditGrantsResponse>;
     private __countBillingPlanCreditGrants;
+    /**
+     * @param {Schematic.ReserveCreditsRequestBody} request
+     * @param {CreditsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schematic.BadRequestError}
+     * @throws {@link Schematic.UnauthorizedError}
+     * @throws {@link Schematic.PaymentRequiredError}
+     * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
+     * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
+     *
+     * @example
+     *     await client.credits.reserveCredits({
+     *         amount: 1.1,
+     *         companyId: "company_id",
+     *         creditTypeId: "credit_type_id"
+     *     })
+     */
+    reserveCredits(request: Schematic.ReserveCreditsRequestBody, requestOptions?: CreditsClient.RequestOptions): core.HttpResponsePromise<Schematic.ReserveCreditsResponse>;
+    private __reserveCredits;
+    /**
+     * @param {string} reservation_id - reservation_id
+     * @param {CreditsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schematic.BadRequestError}
+     * @throws {@link Schematic.UnauthorizedError}
+     * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
+     * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
+     *
+     * @example
+     *     await client.credits.releaseCreditReservation("reservation_id")
+     */
+    releaseCreditReservation(reservation_id: string, requestOptions?: CreditsClient.RequestOptions): core.HttpResponsePromise<Schematic.ReleaseCreditReservationResponse>;
+    private __releaseCreditReservation;
     /**
      * @param {Schematic.ListCreditSpendPoliciesRequest} request
      * @param {CreditsClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/api/resources/credits/client/requests/CreateCompanyCreditGrant.d.ts

@@ -11,6 +11,7 @@ import type * as Schematic from "../../../../index";
 export interface CreateCompanyCreditGrant {
     billingPeriodsCount?: number;
     companyId: string;
+    creditBundleId?: string;
     creditId: string;
     currency?: string;
     expiresAt?: Date;

package/dist/api/resources/credits/client/requests/ReserveCreditsRequestBody.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @example
+ *     {
+ *         amount: 1.1,
+ *         companyId: "company_id",
+ *         creditTypeId: "credit_type_id"
+ *     }
+ */
+export interface ReserveCreditsRequestBody {
+    /** Credits to hold for the operation. The full amount must be available; a partial hold is never taken */
+    amount: number;
+    companyId: string;
+    creditTypeId: string;
+    /** When the hold lapses if no track event settles it; defaults to one minute from now and may be at most one hour out. The unspent hold is refunded on expiry */
+    expiresAt?: Date;
+    /** A caller-chosen key for safe retries: a second request with the same key returns the original reservation instead of taking another hold */
+    idempotencyKey?: string;
+}

package/dist/api/resources/credits/client/requests/index.d.ts

@@ -20,6 +20,7 @@ export type { ListCreditBundlesRequest } from "./ListCreditBundlesRequest";
 export type { ListCreditEventLedgerRequest } from "./ListCreditEventLedgerRequest";
 export type { ListCreditSpendPoliciesRequest } from "./ListCreditSpendPoliciesRequest";
 export type { ListGrantsForCreditRequest } from "./ListGrantsForCreditRequest";
+export type { ReserveCreditsRequestBody } from "./ReserveCreditsRequestBody";
 export type { UpdateBillingCreditRequestBody } from "./UpdateBillingCreditRequestBody";
 export type { UpdateCreditBundleDetailsRequestBody } from "./UpdateCreditBundleDetailsRequestBody";
 export type { UpdateCreditSpendPolicyRequestBody } from "./UpdateCreditSpendPolicyRequestBody";

package/dist/api/resources/credits/types/ReleaseCreditReservationResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Schematic from "../../../index";
+export interface ReleaseCreditReservationResponse {
+    data: Schematic.CreditReservationResponseData;
+    /** Input parameters */
+    params: Record<string, unknown>;
+}

package/dist/api/resources/credits/types/ReserveCreditsResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Schematic from "../../../index";
+export interface ReserveCreditsResponse {
+    data: Schematic.CreditReservationResponseData;
+    /** Input parameters */
+    params: Record<string, unknown>;
+}

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

@@ -44,6 +44,8 @@ export * from "./ListCreditSpendPoliciesResponse";
 export * from "./ListGrantsForCreditParams";
 export * from "./ListGrantsForCreditResponse";
 export * from "./ReleaseCreditLeaseResponse";
+export * from "./ReleaseCreditReservationResponse";
+export * from "./ReserveCreditsResponse";
 export * from "./SoftDeleteBillingCreditResponse";
 export * from "./UpdateBillingCreditResponse";
 export * from "./UpdateBillingPlanCreditGrantResponse";

package/dist/api/resources/features/client/Client.d.ts

@@ -318,6 +318,24 @@ export declare class FeaturesClient {
      */
     checkFlag(key: string, request: Schematic.CheckFlagRequestBody, requestOptions?: FeaturesClient.RequestOptions): core.HttpResponsePromise<Schematic.CheckFlagResponse>;
     private __checkFlag;
+    /**
+     * @param {string} key - key
+     * @param {Schematic.CheckAndReserveFlagRequestBody} request
+     * @param {FeaturesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Schematic.BadRequestError}
+     * @throws {@link Schematic.UnauthorizedError}
+     * @throws {@link Schematic.ForbiddenError}
+     * @throws {@link Schematic.NotFoundError}
+     * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
+     *
+     * @example
+     *     await client.features.checkAndReserveFlag("key")
+     */
+    checkAndReserveFlag(key: string, request?: Schematic.CheckAndReserveFlagRequestBody, requestOptions?: FeaturesClient.RequestOptions): core.HttpResponsePromise<Schematic.CheckAndReserveFlagResponse>;
+    private __checkAndReserveFlag;
     /**
      * @param {Schematic.CheckFlagRequestBody} request
      * @param {FeaturesClient.RequestOptions} requestOptions - Request-specific configuration.

package/dist/api/resources/features/client/requests/CheckAndReserveFlagRequestBody.d.ts

@@ -0,0 +1,15 @@
+import type * as Schematic from "../../../../index";
+/**
+ * @example
+ *     {}
+ */
+export interface CheckAndReserveFlagRequestBody {
+    company?: Record<string, string>;
+    /** When the hold lapses if no track event settles it; defaults to one minute from now and may be at most one hour out. The unspent hold is refunded on expiry */
+    expiresAt?: Date;
+    /** Hypothetical usage to evaluate the flag against. When credit_cost names the entitlement's credit, that cost is what gets held; otherwise the hold is quantity times the entitlement's consumption rate */
+    preflight?: Schematic.PreflightRequestBody;
+    /** Units of the feature the operation will consume; defaults to 1. Sets the hold size together with the entitlement's consumption rate, and is echoed back on the reservation for the settling track event */
+    quantity?: number;
+    user?: Record<string, string>;
+}

package/dist/api/resources/features/client/requests/index.d.ts

@@ -1,3 +1,4 @@
+export type { CheckAndReserveFlagRequestBody } from "./CheckAndReserveFlagRequestBody";
 export type { CheckFlagsBulkRequestBody } from "./CheckFlagsBulkRequestBody";
 export type { CountFeaturesRequest } from "./CountFeaturesRequest";
 export type { CountFlagsRequest } from "./CountFlagsRequest";

package/dist/api/resources/features/types/CheckAndReserveFlagResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Schematic from "../../../index";
+export interface CheckAndReserveFlagResponse {
+    data: Schematic.CheckAndReserveFlagResponseData;
+    /** Input parameters */
+    params: Record<string, unknown>;
+}

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

@@ -1,3 +1,4 @@
+export * from "./CheckAndReserveFlagResponse";
 export * from "./CheckFlagResponse";
 export * from "./CheckFlagsBulkResponse";
 export * from "./CheckFlagsResponse";

package/dist/api/resources/plangroups/client/requests/CreatePlanGroupRequestBody.d.ts

@@ -67,6 +67,7 @@ export interface CreatePlanGroupRequestBody {
     showZeroPriceAsFree: boolean;
     syncCustomerBillingDetails: boolean;
     trialDays?: number;
+    trialEligibilityPerPlan?: boolean;
     trialExpiryPlanId?: string;
     trialExpiryPlanPriceId?: string;
     trialPaymentMethodRequired?: boolean;

package/dist/api/resources/plangroups/client/requests/UpdatePlanGroupRequestBody.d.ts

@@ -67,6 +67,7 @@ export interface UpdatePlanGroupRequestBody {
     showZeroPriceAsFree: boolean;
     syncCustomerBillingDetails: boolean;
     trialDays?: number;
+    trialEligibilityPerPlan?: boolean;
     trialExpiryPlanId?: string;
     trialExpiryPlanPriceId?: string;
     trialPaymentMethodRequired?: boolean;

package/dist/api/resources/plans/client/Client.d.ts

@@ -132,6 +132,7 @@ export declare class PlansClient {
      *         companyId: "company_id",
      *         companyScopedOnly: true,
      *         excludeCompanyScoped: true,
+     *         excludeUnused: true,
      *         forFallbackPlan: true,
      *         forInitialPlan: true,
      *         forTrialExpiryPlan: true,
@@ -330,6 +331,7 @@ export declare class PlansClient {
      *         companyId: "company_id",
      *         companyScopedOnly: true,
      *         excludeCompanyScoped: true,
+     *         excludeUnused: true,
      *         forFallbackPlan: true,
      *         forInitialPlan: true,
      *         forTrialExpiryPlan: true,

package/dist/api/resources/plans/client/requests/CountPlansRequest.d.ts

@@ -5,6 +5,7 @@ import type * as Schematic from "../../../../index";
  *         companyId: "company_id",
  *         companyScopedOnly: true,
  *         excludeCompanyScoped: true,
+ *         excludeUnused: true,
  *         forFallbackPlan: true,
  *         forInitialPlan: true,
  *         forTrialExpiryPlan: true,
@@ -27,6 +28,8 @@ export interface CountPlansRequest {
     companyScopedOnly?: boolean;
     /** Exclude plans that are scoped to a company (custom plans assigned to a company) */
     excludeCompanyScoped?: boolean;
+    /** Exclude plans that nothing is using: no company is on the plan and it has no draft version */
+    excludeUnused?: boolean;
     /** Filter for plans valid as fallback plans (not linked to billing) */
     forFallbackPlan?: boolean;
     /** Filter for plans valid as initial plans (not linked to billing, free, or auto-cancelling trial) */

package/dist/api/resources/plans/client/requests/ListPlansRequest.d.ts

@@ -5,6 +5,7 @@ import type * as Schematic from "../../../../index";
  *         companyId: "company_id",
  *         companyScopedOnly: true,
  *         excludeCompanyScoped: true,
+ *         excludeUnused: true,
  *         forFallbackPlan: true,
  *         forInitialPlan: true,
  *         forTrialExpiryPlan: true,
@@ -27,6 +28,8 @@ export interface ListPlansRequest {
     companyScopedOnly?: boolean;
     /** Exclude plans that are scoped to a company (custom plans assigned to a company) */
     excludeCompanyScoped?: boolean;
+    /** Exclude plans that nothing is using: no company is on the plan and it has no draft version */
+    excludeUnused?: boolean;
     /** Filter for plans valid as fallback plans (not linked to billing) */
     forFallbackPlan?: boolean;
     /** Filter for plans valid as initial plans (not linked to billing, free, or auto-cancelling trial) */

package/dist/api/resources/plans/types/CountPlansParams.d.ts

@@ -8,6 +8,8 @@ export interface CountPlansParams {
     companyScopedOnly?: boolean;
     /** Exclude plans that are scoped to a company (custom plans assigned to a company) */
     excludeCompanyScoped?: boolean;
+    /** Exclude plans that nothing is using: no company is on the plan and it has no draft version */
+    excludeUnused?: boolean;
     /** Filter for plans valid as fallback plans (not linked to billing) */
     forFallbackPlan?: boolean;
     /** Filter for plans valid as initial plans (not linked to billing, free, or auto-cancelling trial) */

package/dist/api/resources/plans/types/ListPlansParams.d.ts

@@ -8,6 +8,8 @@ export interface ListPlansParams {
     companyScopedOnly?: boolean;
     /** Exclude plans that are scoped to a company (custom plans assigned to a company) */
     excludeCompanyScoped?: boolean;
+    /** Exclude plans that nothing is using: no company is on the plan and it has no draft version */
+    excludeUnused?: boolean;
     /** Filter for plans valid as fallback plans (not linked to billing) */
     forFallbackPlan?: boolean;
     /** Filter for plans valid as initial plans (not linked to billing, free, or auto-cancelling trial) */

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

@@ -0,0 +1,5 @@
+export declare const BillingArrearsAnchor: {
+    readonly BillingPeriodStart: "billing_period_start";
+    readonly MonthEnd: "month_end";
+};
+export type BillingArrearsAnchor = (typeof BillingArrearsAnchor)[keyof typeof BillingArrearsAnchor];

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

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

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

@@ -5,6 +5,8 @@ export interface BillingCreditGrantResponseData {
     companyLicenseId?: string;
     companyName: string;
     createdAt: Date;
+    /** The catalog bundle this grant was issued from, when the company bought one. */
+    creditBundleId?: string;
     creditIcon?: string;
     creditId: string;
     creditName: string;
@@ -16,6 +18,11 @@ export interface BillingCreditGrantResponseData {
     licenseName?: string;
     planId?: string;
     planName?: string;
+    /** What the postpaid charges costs, in the currency's minor unit. */
+    postpaidChargeAmount?: number;
+    postpaidChargeCurrency?: string;
+    /** Credits consumed past a zero balance in the window still open. */
+    postpaidChargedCredits?: number;
     price?: Schematic.BillingPriceResponseData;
     quantity: number;
     quantityRemaining: number;

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

@@ -1,5 +1,9 @@
 import type * as Schematic from "../index";
 export interface BillingPlanCreditGrantResponseData {
+    /** Which boundary closes a monthly arrears window. Only meaningful when arrears_cadence is monthly. */
+    arrearsAnchor?: Schematic.BillingArrearsAnchor;
+    /** How often postpaid charges are closed and invoiced. Defaults to end_of_billing_period. */
+    arrearsCadence?: Schematic.BillingArrearsCadence;
     autoTopupAmount?: number;
     autoTopupAmountType?: string;
     autoTopupAvailability: Schematic.BillingCreditAutoTopupAvailability;
@@ -32,11 +36,19 @@ export interface BillingPlanCreditGrantResponseData {
     id: string;
     /** The license whose quantity scales this grant. Set only when scaling is per_license. */
     licenseId?: string;
+    /** Optional limit on how far the balance may go below zero, in credits. A floor on the balance, not an allowance per invoice window: consumption is denied once the balance would fall below minus this figure, and stays denied until a new grant lands or the negative balance is settled. Absent means no limit. */
+    overdraftLimit?: number;
     plan?: Schematic.PreviewObjectResponseData;
     planId: string;
     /** Use plan.name from the nested plan object instead */
     planName: string;
     planVersionId?: string;
+    /** Whether consumption may continue past a zero balance, accruing at postpaid_rate_per_unit rather than being denied. */
+    postpaidEnabled: boolean;
+    /** Amount charged per credit consumed past zero, in the currency's minor unit. Defaults to the credit's own cost basis when postpaid is enabled without one. */
+    postpaidRatePerUnit?: number;
+    /** Decimal form of postpaid_rate_per_unit, for rates finer than one minor unit. */
+    postpaidRatePerUnitDecimal?: string;
     resetCadence?: Schematic.BillingPlanCreditGrantResetCadence;
     resetStart?: Schematic.BillingPlanCreditGrantResetStart;
     resetType?: Schematic.BillingPlanCreditGrantResetType;

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

@@ -0,0 +1,35 @@
+import type * as Schematic from "../index";
+export interface CheckAndReserveFlagResponseData {
+    /** If company keys were provided and matched a company, its ID */
+    companyId?: string;
+    /** If a feature entitlement rule was matched, its entitlement details */
+    entitlement?: Schematic.FeatureEntitlement;
+    /** If an error occurred while checking the flag, the error message */
+    error?: string;
+    /** Deprecated: Use Entitlement.Allocation instead. */
+    featureAllocation?: number;
+    /** Deprecated: Use Entitlement.Usage instead. */
+    featureUsage?: number;
+    /** Deprecated: Use Entitlement.EventName instead. */
+    featureUsageEvent?: string;
+    /** Deprecated: Use Entitlement.MetricPeriod instead. */
+    featureUsagePeriod?: Schematic.MetricPeriod;
+    /** Deprecated: Use Entitlement.MetricResetAt instead. */
+    featureUsageResetAt?: Date;
+    /** The key used to check the flag */
+    flag: string;
+    /** If a flag was found, its ID */
+    flagId?: string;
+    /** A human-readable explanation of the result */
+    reason: string;
+    /** The hold taken on the company's credit balance for this operation, when the flag allowed it and the feature is credit-metered. Settle it by sending a track event carrying its ID as reservation_id; the unspent hold is refunded at expires_at otherwise */
+    reservation?: Schematic.FlagCheckReservationResponseData;
+    /** If a rule was found, its ID */
+    ruleId?: string;
+    /** If a rule was found, its type */
+    ruleType?: Schematic.RuleType;
+    /** If user keys were provided and matched a user, its ID */
+    userId?: string;
+    /** A boolean flag check result; for feature entitlements, this represents whether further consumption of the feature is permitted */
+    value: boolean;
+}

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

@@ -5,10 +5,12 @@ export interface CheckoutDataResponseData {
     activeUsageBasedEntitlements: Schematic.UsageBasedEntitlementResponseData[];
     availableCreditBundles: Schematic.BillingCreditBundleResponseData[];
     company?: Schematic.CompanyDetailResponseData;
+    companyCanTrialSelectedPlan: boolean;
     customCheckoutFields: Schematic.CheckoutFieldWithValue[];
     featureUsage?: Schematic.FeatureUsageDetailResponseData;
     selectedCreditBundles: Schematic.CreditBundlePurchaseResponseData[];
     selectedPlan?: Schematic.PlanDetailResponseData;
+    selectedPlanAlreadyTrialed: boolean;
     selectedUsageBasedEntitlements: Schematic.UsageBasedEntitlementResponseData[];
     subscription?: Schematic.CompanySubscriptionResponseData;
 }

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

@@ -1,5 +1,7 @@
 import type * as Schematic from "../index";
 export interface CompanyPlanCreditGrantView {
+    billingCreditArrearsAnchor?: Schematic.BillingArrearsAnchor;
+    billingCreditArrearsCadence?: Schematic.BillingArrearsCadence;
     billingCreditAutoTopupAmount?: number;
     billingCreditAutoTopupAmountType?: string;
     billingCreditAutoTopupAvailability?: Schematic.BillingCreditAutoTopupAvailability;
@@ -11,6 +13,10 @@ export interface CompanyPlanCreditGrantView {
     billingCreditAutoTopupThresholdCredits?: number;
     billingCreditAutoTopupThresholdPercent?: number;
     billingCreditCanBuyBundles: boolean;
+    billingCreditOverdraftLimit?: number;
+    billingCreditPostpaidEnabled: boolean;
+    billingCreditPostpaidRatePerUnit?: number;
+    billingCreditPostpaidRatePerUnitDecimal?: string;
     companyAutoTopupAmount?: number;
     companyAutoTopupEnabled?: boolean;
     companyAutoTopupThresholdCredits?: number;

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

@@ -1,6 +1,10 @@
 import type * as Schematic from "../index";
 export interface CreateBillingPlanCreditGrantRequestBody {
     applyToExisting?: boolean;
+    /** Which boundary closes a monthly arrears window: the subscription's own recurrence (billing_period_start) or the calendar month (month_end). Only applies when arrears_cadence is monthly; defaults to billing_period_start. */
+    arrearsAnchor?: Schematic.BillingArrearsAnchor;
+    /** How often postpaid charges are closed and invoiced: end_of_billing_period (the default) or monthly. */
+    arrearsCadence?: Schematic.BillingArrearsCadence;
     autoTopupAmount?: number;
     autoTopupAmountType?: Schematic.CreditAutoTopupAmountType;
     autoTopupAvailability?: Schematic.BillingCreditAutoTopupAvailability;
@@ -22,8 +26,16 @@ export interface CreateBillingPlanCreditGrantRequestBody {
     expiryUnitCount?: number;
     /** The license whose quantity scales this grant. Required when scaling is per_license. */
     licenseId?: string;
+    /** Optional limit on how far the balance may go below zero, in credits. It is a floor on the balance rather than an allowance per invoice window: the balance may run down to minus this figure, and beyond it the flag check denies the same way an exhausted balance does with postpaid off. Nothing resets when an invoice window rolls, so a company that reaches the limit stays denied until a new grant lands or the negative balance is settled. Omit for no limit. */
+    overdraftLimit?: number;
     planId: string;
     planVersionId?: string;
+    /** Whether consumption may continue past a zero balance. When false (the default) the flag check denies once the balance is exhausted, which is the existing behavior. When true, consumption continues and accrues at postpaid_rate_per_unit, settled on arrears_cadence. Intended for invoice-billed customers on net terms, who have no card for auto top-up to charge. */
+    postpaidEnabled?: boolean;
+    /** Amount charged per credit consumed past a zero balance, in the currency's minor unit. Optional: defaults to the credit's own cost basis (price_per_unit) when postpaid_enabled is true. */
+    postpaidRatePerUnit?: number;
+    /** Decimal string form of postpaid_rate_per_unit, for rates finer than one minor unit (for example 0.0002). Takes precedence over postpaid_rate_per_unit when both are set, matching how the credit's own price_per_unit_decimal behaves. */
+    postpaidRatePerUnitDecimal?: string;
     resetCadence: Schematic.BillingPlanCreditGrantResetCadence;
     resetStart: Schematic.BillingPlanCreditGrantResetStart;
     resetType?: Schematic.BillingPlanCreditGrantResetType;

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

@@ -1,5 +1,6 @@
 import type * as Schematic from "../index";
 export interface CreditCompanyGrantView {
+    arrearsCadence?: Schematic.BillingArrearsCadence;
     billingCreditBundleId?: string;
     billingCreditId: string;
     companyId: string;
@@ -21,6 +22,12 @@ export interface CreditCompanyGrantView {
     planId?: string;
     planName?: string;
     pluralName?: string;
+    postpaidChargeAmount?: number;
+    postpaidChargeCurrency?: string;
+    postpaidChargedCredits?: number;
+    postpaidPeriodEnd?: Date;
+    postpaidRate?: number;
+    postpaidRateDecimal?: string;
     price?: Schematic.BillingProductPriceResponseData;
     quantity: number;
     quantityRemaining: number;

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

@@ -0,0 +1,15 @@
+export interface CreditReservationResponseData {
+    companyId: string;
+    createdAt: Date;
+    creditTypeId: string;
+    /** When the unspent hold is refunded if no track event settles it */
+    expiresAt: Date;
+    id: string;
+    /** When the reservation was settled, released, or expired; null while the hold is open */
+    releasedAt?: Date;
+    /** Credits held from the company's balance for the operation */
+    reservedAmount: number;
+    /** Credits the settling track event recorded against the hold; zero until settled. May exceed reserved_amount, in which case the overage was debited from the balance, up to the overdraft limit when one is set */
+    settledAmount: number;
+    updatedAt: Date;
+}

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

@@ -3,6 +3,8 @@ export declare const CreditUsageReason: {
     readonly LeaseRelease: "lease_release";
     readonly ManualAdjustment: "manual_adjustment";
     readonly Reconciliation: "reconciliation";
+    readonly ReservationHold: "reservation_hold";
+    readonly ReservationRelease: "reservation_release";
     readonly Track: "track";
 };
 export type CreditUsageReason = (typeof CreditUsageReason)[keyof typeof CreditUsageReason];

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

@@ -7,6 +7,8 @@ export interface EventBodyTrack {
     leaseId?: string;
     /** Optionally specify the quantity of the event */
     quantity?: number;
+    /** Credit reservation ID this track event settles. lease_id takes precedence when both are set */
+    reservationId?: string;
     /** A map of trait names to trait values */
     traits?: Record<string, unknown>;
     /** Key-value pairs to identify user associated with track event */

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

@@ -18,6 +18,7 @@ export interface EventDetailResponseData {
     loadedAt?: Date;
     processedAt?: Date;
     quantity: number;
+    reservationId?: string;
     sentAt?: Date;
     status: Schematic.EventStatus;
     subtype?: string;

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

@@ -15,6 +15,7 @@ export interface EventResponseData {
     loadedAt?: Date;
     processedAt?: Date;
     quantity: number;
+    reservationId?: string;
     sentAt?: Date;
     status: Schematic.EventStatus;
     subtype?: string;

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

@@ -0,0 +1,15 @@
+export interface FlagCheckReservationResponseData {
+    companyId: string;
+    /** Credits per unit of usage the hold was priced at */
+    consumptionRate: number;
+    creditTypeId: string;
+    /** Credits held from the company's balance */
+    creditsReserved: number;
+    /** The event subtype the settling track event should carry */
+    eventSubtype?: string;
+    /** When the unspent hold is refunded if no track event settles it */
+    expiresAt: Date;
+    id: string;
+    /** Units of usage the hold covers, as requested */
+    quantityReserved: number;
+}

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

@@ -8,6 +8,8 @@ export interface GetOnboardingStateResp {
     path?: Schematic.OnboardingPath;
     pricingPageUrl?: string;
     requirements: Schematic.OnboardingRequirementView[];
+    roadmap?: Schematic.OnboardingRoadmapView;
+    slackConnect?: Schematic.SlackConnectInviteView;
     stripeImport?: Schematic.OnboardingStripeImport;
     suggestedNext: Schematic.OnboardingRequirement[];
     track?: Schematic.OnboardingTrack;

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

@@ -1,10 +1,11 @@
 import type * as Schematic from "../index";
 export interface IssueTemporaryAccessTokenResponseData {
-    apiKeyId: string;
+    apiKeyId?: string;
     createdAt: Date;
     environmentId: string;
     expiredAt: Date;
     id: string;
+    issuerType: Schematic.TemporaryAccessTokenIssuerType;
     resourceType: Schematic.TemporaryAccessTokenResourceType;
     token: string;
     updatedAt: Date;

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

@@ -3,6 +3,7 @@ export declare const OnboardingRequirement: {
     readonly ConnectBilling: "connect_billing";
     readonly CreateApiKey: "create_api_key";
     readonly FirstFlagCheck: "first_flag_check";
+    readonly GenerateRoadmap: "generate_roadmap";
     readonly ImportCompanies: "import_companies";
     readonly ModelPackaging: "model_packaging";
     readonly SendEvents: "send_events";

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

@@ -0,0 +1,4 @@
+export interface OnboardingRoadmapView {
+    publishedAt?: Date;
+    slug: string;
+}

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

@@ -1,5 +1,7 @@
 import type * as Schematic from "../index";
 export interface PlanCreditGrantView {
+    billingCreditArrearsAnchor?: Schematic.BillingArrearsAnchor;
+    billingCreditArrearsCadence?: Schematic.BillingArrearsCadence;
     billingCreditAutoTopupAmount?: number;
     billingCreditAutoTopupAmountType?: string;
     billingCreditAutoTopupAvailability?: Schematic.BillingCreditAutoTopupAvailability;
@@ -11,6 +13,10 @@ export interface PlanCreditGrantView {
     billingCreditAutoTopupThresholdCredits?: number;
     billingCreditAutoTopupThresholdPercent?: number;
     billingCreditCanBuyBundles: boolean;
+    billingCreditOverdraftLimit?: number;
+    billingCreditPostpaidEnabled: boolean;
+    billingCreditPostpaidRatePerUnit?: number;
+    billingCreditPostpaidRatePerUnitDecimal?: string;
     companyCreditAmount: number;
     createdAt: Date;
     credit?: Schematic.BillingCreditView;

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

@@ -33,6 +33,7 @@ export interface PlanGroupDetailResponseData {
     syncCustomerBillingDetails: boolean;
     taxCollectionEnabled: boolean;
     trialDays?: number;
+    trialEligibilityPerPlan: boolean;
     trialExpiryPlan?: Schematic.PlanGroupPlanDetailResponseData;
     trialExpiryPlanId?: string;
     trialExpiryPlanPrice?: Schematic.BillingPriceView;

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

@@ -25,6 +25,7 @@ export interface PlanGroupResponseData {
     syncCustomerBillingDetails: boolean;
     taxCollectionEnabled: boolean;
     trialDays?: number;
+    trialEligibilityPerPlan: boolean;
     trialExpiryPlanId?: string;
     trialExpiryPlanPriceId?: string;
     trialPaymentMethodRequired?: boolean;