@schematichq/schematic-typescript-node 1.5.13 → 1.6.0

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/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/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/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/index.d.ts

@@ -79,6 +79,7 @@ export * from "./CatalogResponseData";
 export * from "./ChangeSubscriptionInternalRequestBody";
 export * from "./ChangeSubscriptionRequestBody";
 export * from "./ChargeType";
+export * from "./CheckAndReserveFlagResponseData";
 export * from "./CheckFlagRequestBody";
 export * from "./CheckFlagResponseData";
 export * from "./CheckFlagsBulkResponseData";
@@ -169,6 +170,7 @@ export * from "./CreditGrantDetail";
 export * from "./CreditGrantExpiryRequestBody";
 export * from "./CreditGrantSortOrder";
 export * from "./CreditLeaseResponseData";
+export * from "./CreditReservationResponseData";
 export * from "./CreditSpendPolicyResponseData";
 export * from "./CreditSpendPolicyScope";
 export * from "./CreditsAutoTopupCompanySummary";
@@ -251,6 +253,7 @@ export * from "./FeatureUsageLegacyResponseData";
 export * from "./FeatureUsageResponseData";
 export * from "./FeatureUsageTimeSeriesResponseData";
 export * from "./FeatureView";
+export * from "./FlagCheckReservationResponseData";
 export * from "./FlagDetailResponseData";
 export * from "./FlagInPlanResponseData";
 export * from "./FlagResponseData";
@@ -360,7 +363,6 @@ export * from "./PublicPlansResponseData";
 export * from "./QuickstartResp";
 export * from "./RawEventBatchResponseData";
 export * from "./RawEventResponseData";
-export * from "./ReleaseCreditLeaseRequestBody";
 export * from "./Rule";
 export * from "./RuleConditionDetailResponseData";
 export * from "./RuleConditionGroupDetailResponseData";