@schematichq/schematic-typescript-node 1.5.1 → 1.5.2

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

@@ -54,6 +54,36 @@ export declare class BillingClient {
      */
     upsertBillingCoupon(request: Schematic.CreateCouponRequestBody, requestOptions?: BillingClient.RequestOptions): core.HttpResponsePromise<Schematic.UpsertBillingCouponResponse>;
     private __upsertBillingCoupon;
+    /**
+     * @param {string} billing_id - billing_id
+     * @param {BillingClient.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}
+     *
+     * @example
+     *     await client.billing.deleteBillingCoupon("billing_id")
+     */
+    deleteBillingCoupon(billing_id: string, requestOptions?: BillingClient.RequestOptions): core.HttpResponsePromise<Schematic.DeleteBillingCouponResponse>;
+    private __deleteBillingCoupon;
+    /**
+     * @param {string} billing_id - billing_id
+     * @param {BillingClient.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}
+     *
+     * @example
+     *     await client.billing.deleteBillingCustomer("billing_id")
+     */
+    deleteBillingCustomer(billing_id: string, requestOptions?: BillingClient.RequestOptions): core.HttpResponsePromise<Schematic.DeleteBillingCustomerResponse>;
+    private __deleteBillingCustomer;
     /**
      * @param {Schematic.CreateBillingCustomerRequestBody} request
      * @param {BillingClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -164,6 +194,21 @@ export declare class BillingClient {
      */
     upsertInvoice(request: Schematic.CreateInvoiceRequestBody, requestOptions?: BillingClient.RequestOptions): core.HttpResponsePromise<Schematic.UpsertInvoiceResponse>;
     private __upsertInvoice;
+    /**
+     * @param {string} billing_id - billing_id
+     * @param {BillingClient.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}
+     *
+     * @example
+     *     await client.billing.deleteBillingInvoice("billing_id")
+     */
+    deleteBillingInvoice(billing_id: string, requestOptions?: BillingClient.RequestOptions): core.HttpResponsePromise<Schematic.DeleteBillingInvoiceResponse>;
+    private __deleteBillingInvoice;
     /**
      * @param {Schematic.ListMetersRequest} request
      * @param {BillingClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -275,6 +320,7 @@ export declare class BillingClient {
      *         ids: ["ids"],
      *         interval: "interval",
      *         isActive: true,
+     *         planVersionId: "plan_version_id",
      *         price: 1000000,
      *         productId: "product_id",
      *         productIds: ["product_ids"],
@@ -350,6 +396,7 @@ export declare class BillingClient {
      *         ids: ["ids"],
      *         interval: "interval",
      *         isActive: true,
+     *         planVersionId: "plan_version_id",
      *         price: 1000000,
      *         productId: "product_id",
      *         productIds: ["product_ids"],

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

@@ -8,6 +8,7 @@ import type * as Schematic from "../../../../index";
  *         ids: ["ids"],
  *         interval: "interval",
  *         isActive: true,
+ *         planVersionId: "plan_version_id",
  *         price: 1000000,
  *         productId: "product_id",
  *         productIds: ["product_ids"],
@@ -31,6 +32,8 @@ export interface ListBillingPricesRequest {
     interval?: string;
     /** Filter for active prices on active products (defaults to true if not specified) */
     isActive?: boolean;
+    /** Filter for prices belonging to a specific plan version (e.g. the latest published version) */
+    planVersionId?: string;
     price?: number;
     productId?: string;
     productIds?: string | string[];

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

@@ -8,6 +8,7 @@ import type * as Schematic from "../../../../index";
  *         ids: ["ids"],
  *         interval: "interval",
  *         isActive: true,
+ *         planVersionId: "plan_version_id",
  *         price: 1000000,
  *         productId: "product_id",
  *         productIds: ["product_ids"],
@@ -31,6 +32,8 @@ export interface ListBillingProductPricesRequest {
     interval?: string;
     /** Filter for active prices on active products (defaults to true if not specified) */
     isActive?: boolean;
+    /** Filter for prices belonging to a specific plan version (e.g. the latest published version) */
+    planVersionId?: string;
     price?: number;
     productId?: string;
     productIds?: string | string[];

package/dist/api/resources/billing/types/DeleteBillingCouponResponse.d.ts

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

package/dist/api/resources/billing/types/DeleteBillingCustomerResponse.d.ts

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

package/dist/api/resources/billing/types/DeleteBillingInvoiceResponse.d.ts

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

package/dist/api/resources/billing/types/ListBillingPricesParams.d.ts

@@ -17,6 +17,8 @@ export interface ListBillingPricesParams {
     limit?: number;
     /** Page offset (default 0) */
     offset?: number;
+    /** Filter for prices belonging to a specific plan version (e.g. the latest published version) */
+    planVersionId?: string;
     price?: number;
     productId?: string;
     productIds?: string[];

package/dist/api/resources/billing/types/ListBillingProductPricesParams.d.ts

@@ -17,6 +17,8 @@ export interface ListBillingProductPricesParams {
     limit?: number;
     /** Page offset (default 0) */
     offset?: number;
+    /** Filter for prices belonging to a specific plan version (e.g. the latest published version) */
+    planVersionId?: string;
     price?: number;
     productId?: string;
     productIds?: string[];

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

@@ -2,6 +2,9 @@ export * from "./CountBillingProductsParams";
 export * from "./CountBillingProductsResponse";
 export * from "./CountCustomersParams";
 export * from "./CountCustomersResponse";
+export * from "./DeleteBillingCouponResponse";
+export * from "./DeleteBillingCustomerResponse";
+export * from "./DeleteBillingInvoiceResponse";
 export * from "./DeleteBillingProductResponse";
 export * from "./DeletePaymentMethodByExternalIdResponse";
 export * from "./DeleteProductPriceResponse";

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

@@ -370,11 +370,7 @@ export declare class PlansClient {
      * @example
      *     await client.plans.publishPlanVersion("plan_id", {
      *         excludedCompanyIds: ["excluded_company_ids"],
-     *         migrationStrategy: "immediate",
-     *         payInAdvance: [{
-     *                 priceId: "price_id",
-     *                 quantity: 1000000
-     *             }]
+     *         migrationStrategy: "immediate"
      *     })
      */
     publishPlanVersion(plan_id: string, request: Schematic.PublishPlanVersionRequestBody, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.PublishPlanVersionResponse>;

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

@@ -3,11 +3,7 @@ import type * as Schematic from "../../../../index";
  * @example
  *     {
  *         excludedCompanyIds: ["excluded_company_ids"],
- *         migrationStrategy: "immediate",
- *         payInAdvance: [{
- *                 priceId: "price_id",
- *                 quantity: 1000000
- *             }]
+ *         migrationStrategy: "immediate"
  *     }
  */
 export interface PublishPlanVersionRequestBody {
@@ -16,5 +12,4 @@ export interface PublishPlanVersionRequestBody {
     daysUntilDue?: number;
     excludedCompanyIds: string[];
     migrationStrategy: Schematic.PlanVersionMigrationStrategy;
-    payInAdvance: Schematic.UpdatePayInAdvanceRequestBody[];
 }

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

@@ -149,6 +149,24 @@ export declare class WebhooksClient {
      */
     deleteWebhook(webhook_id: string, requestOptions?: WebhooksClient.RequestOptions): core.HttpResponsePromise<Schematic.DeleteWebhookResponse>;
     private __deleteWebhook;
+    /**
+     * @param {string} webhook_id - webhook_id
+     * @param {Schematic.TestWebhookRequestBody} request
+     * @param {WebhooksClient.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}
+     *
+     * @example
+     *     await client.webhooks.sendTestWebhookAction("webhook_id", {
+     *         requestType: "subscription.trial.ended"
+     *     })
+     */
+    sendTestWebhookAction(webhook_id: string, request: Schematic.TestWebhookRequestBody, requestOptions?: WebhooksClient.RequestOptions): core.HttpResponsePromise<Schematic.SendTestWebhookActionResponse>;
+    private __sendTestWebhookAction;
     /**
      * @param {Schematic.CountWebhooksRequest} request
      * @param {WebhooksClient.RequestOptions} requestOptions - Request-specific configuration.

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

@@ -0,0 +1,10 @@
+import type * as Schematic from "../../../../index";
+/**
+ * @example
+ *     {
+ *         requestType: "subscription.trial.ended"
+ *     }
+ */
+export interface TestWebhookRequestBody {
+    requestType: Schematic.WebhookRequestType;
+}

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

@@ -3,4 +3,5 @@ export type { CountWebhooksRequest } from "./CountWebhooksRequest";
 export type { CreateWebhookRequestBody } from "./CreateWebhookRequestBody";
 export type { ListWebhookEventsRequest } from "./ListWebhookEventsRequest";
 export type { ListWebhooksRequest } from "./ListWebhooksRequest";
+export type { TestWebhookRequestBody } from "./TestWebhookRequestBody";
 export type { UpdateWebhookRequestBody } from "./UpdateWebhookRequestBody";

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

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

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

@@ -10,4 +10,5 @@ export * from "./ListWebhookEventsParams";
 export * from "./ListWebhookEventsResponse";
 export * from "./ListWebhooksParams";
 export * from "./ListWebhooksResponse";
+export * from "./SendTestWebhookActionResponse";
 export * from "./UpdateWebhookResponse";

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

@@ -1,5 +1,4 @@
 export declare const AccountMemberPermission: {
-    readonly BillingCreditsEdit: "billing_credits_edit";
     readonly CompaniesEdit: "companies_edit";
     readonly CompanyUsersEdit: "company_users_edit";
     readonly ComponentsEdit: "components_edit";

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

@@ -1,5 +1,7 @@
 import type * as Schematic from "../index";
 export interface CheckFlagsResponseData {
+    /** Lease-aware credit balances keyed by credit ID, covering every credit type the company holds a balance in */
+    creditBalances?: Record<string, Schematic.CompanyCreditBalance>;
     flags: Schematic.CheckFlagResponseData[];
     plan?: Schematic.DatastreamCompanyPlan;
 }

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

@@ -0,0 +1,8 @@
+export interface CompanyCreditBalance {
+    /** Remaining credit, excluding any open lease hold (the value SDKs gate on) */
+    remaining: number;
+    /** Amount held by the company's open credit lease, 0 when none is open */
+    reserved: number;
+    /** Spendable balance including the open lease hold (remaining + reserved) */
+    settled: number;
+}

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

@@ -7,6 +7,7 @@ export interface CompanySubscriptionResponseData {
     discounts: Schematic.BillingSubscriptionDiscountView[];
     expiredAt?: Date;
     interval: string;
+    isInitial: boolean;
     latestInvoice?: Schematic.InvoiceResponseData;
     paymentMethod?: Schematic.PaymentMethodResponseData;
     products: Schematic.BillingProductForSubscriptionResponseData[];

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

@@ -2,6 +2,8 @@ import type * as Schematic from "../index";
 export interface FeatureEntitlement {
     /** 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 credit cost per unit of usage */
+    consumptionRate?: 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 credit available to fund new consumption or a new lease hold — open lease holds are excluded. Clients that hold a lease should gate on this plus their own unspent hold; clients with no lease awareness should use credit_settled instead */
@@ -16,6 +18,8 @@ export interface FeatureEntitlement {
     creditUsed?: number;
     /** If the feature is event-based, the name of the event tracked for usage */
     eventName?: string;
+    /** For event-based or credit-metered feature entitlements, the event subtype whose usage is tracked */
+    eventSubtype?: string;
     /** The ID of the feature */
     featureId: string;
     /** The key of the flag associated with the feature */

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

@@ -2,6 +2,8 @@ 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 credit cost per unit of usage */
+    consumptionRate?: 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 credit available to fund new consumption or a new lease hold — open lease holds are excluded. Clients that hold a lease should gate on this plus their own unspent hold; clients with no lease awareness should use credit_settled instead */
@@ -16,6 +18,8 @@ export interface RulesengineFeatureEntitlement {
     creditUsed?: number;
     /** If the feature is event-based, the name of the event tracked for usage */
     eventName?: string;
+    /** For event-based or credit-metered feature entitlements, the event subtype whose usage is tracked */
+    eventSubtype?: string;
     /** The ID of the feature */
     featureId: string;
     /** The key of the flag associated with the feature */

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

@@ -0,0 +1,4 @@
+export interface TestWebhookResponseData {
+    responseCode: number;
+    success: boolean;
+}

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

@@ -73,6 +73,7 @@ export * from "./CheckoutFieldWithValue";
 export * from "./CheckoutSettingsResponseData";
 export * from "./CheckoutSubscription";
 export * from "./ClerkIntegrationConfig";
+export * from "./CompanyCreditBalance";
 export * from "./CompanyCreditBalanceResponseData";
 export * from "./CompanyDetailResponseData";
 export * from "./CompanyEventPeriodMetricsResponseData";
@@ -339,6 +340,7 @@ export * from "./SubscriptionTraitUpdate";
 export * from "./SubscriptionType";
 export * from "./TemporaryAccessTokenResourceType";
 export * from "./TemporaryAccessTokenResponseData";
+export * from "./TestWebhookResponseData";
 export * from "./TimeSeriesGranularity";
 export * from "./TopFeatureByUsageResponseData";
 export * from "./TopFeaturesByUsageResponseData";

package/dist/credits/check.d.ts

@@ -26,15 +26,19 @@ export interface CreditCheckDeps {
  * Drives a single `client.check` with `usage` set.
  *
  * Steps:
- *   1. Resolve the matching credit-balance condition on the flag to get
- *      `creditId` + `consumptionRate`.
+ *   1. Probe the engine once (real balance, no preflight, no substitution) and
+ *      read the matched plan entitlement. If it isn't credit-metered
+ *      (`valueType != credit` — boolean/override grant, numeric allocation,
+ *      unlimited, or not entitled) there's nothing to lease: defer to the plain
+ *      check. Otherwise `creditId` + `consumptionRate` + `eventSubtype` come
+ *      straight off the entitlement — no structural flag scan.
  *   2. Acquire (or reuse) a lease for `(company, creditId)`.
  *   3. Try to reserve `quantity × consumptionRate` from the lease.
  *   4. Run the WASM rules engine against a substituted company snapshot
  *      (`credit_balances[creditId] = lease.localRemaining` *before* the
- *      reservation we just made was debited), plus `event_usage` options so
- *      the engine evaluates the post-call balance. The reservation we made
- *      in step 3 only sticks if the engine says allowed.
+ *      reservation we just made was debited), gating with `credit_cost` so the
+ *      engine evaluates the post-call balance. The reservation we made in step 3
+ *      only sticks if the engine says allowed.
  */
 export declare function checkWithLease(deps: CreditCheckDeps, key: string, evalCtx: api.CheckFlagRequestBody, options: CheckOptions, fallback: () => Promise<CheckResult>): Promise<CheckResult>;
 /**

package/dist/credits/types.d.ts

@@ -150,15 +150,17 @@ export interface CheckResult {
     /**
      * Entitlement payload from the check.
      *
-     * NOTE: `entitlement.creditRemaining` (and `creditTotal` / `creditUsed`) is
-     * NOT lease-aware and must not be used as a user-facing balance when credit
-     * leases are enabled. The WASM derives those fields from the company's
-     * server `creditBalances`, which a lease distorts: a plain `checkFlag` sees
-     * the balance net of the whole lease tranche (reads low/~0), and a
-     * lease-bearing `check()` sees the substituted *tranche-local* balance, not
-     * the company total. For any "credits remaining" display use
-     * `client.getCreditBalance(...).settled` (`B − spent`), which speaks the
-     * server's `remaining`/`reserved`/`settled` vocabulary.
+     * For a credit-metered feature the entitlement carries the lease-aware
+     * three-way split the server computes: `creditRemaining` (drawable now, open
+     * lease holds excluded), `creditReserved` (the open lease's unspent hold),
+     * and `creditSettled` (`creditRemaining + creditReserved` = the balance net
+     * of actual consumption). Bind a user-facing "credits remaining" counter to
+     * `creditSettled` — it's invariant to in-flight lease holds, so it doesn't
+     * dip mid-call the way the raw server balance does.
+     *
+     * These come from the company's resolved entitlement, so the lease-balance
+     * substitution a lease-bearing `check()` applies for gating does NOT distort
+     * them — the same values surface whether or not `usage` was passed.
      */
     entitlement?: api.RulesengineFeatureEntitlement;
     /** Flag key checked. */

package/dist/datastream/merge.d.ts

@@ -11,7 +11,7 @@ export declare function deepCopyUser(u: Schematic.RulesengineUser): Schematic.Ru
  * Partials don't carry refreshed entitlements, so when their derived fields
  * change in another part of the company we sync them here to match server
  * behavior:
- *   - creditRemaining ← credit_balances[credit_id]
+ *   - creditRemaining ← credit_balances[credit_id] (or credit_lease_balance[credit_id].remaining)
  *   - usage ← metric value matching (eventName, metricPeriod, monthReset)
  * Both are skipped when the partial also sends entitlements wholesale.
  *