@deeprelay/sdk 0.1.0 → 0.1.2

package/docs/InferencePreflight.md

@@ -0,0 +1,47 @@
+
+# InferencePreflight
+
+The verdict for one (organization, model) pair: what would happen if the model were invoked right now. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`model` | string
+`verdict` | string
+`reason` | string
+`message` | string
+`planCovered` | boolean
+`subscribed` | boolean
+`funded` | boolean
+
+## Example
+
+```typescript
+import type { InferencePreflight } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "model": null,
+  "verdict": null,
+  "reason": null,
+  "message": null,
+  "planCovered": null,
+  "subscribed": null,
+  "funded": null,
+} satisfies InferencePreflight
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as InferencePreflight
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/RefereeStatus.md

@@ -0,0 +1,47 @@
+
+# RefereeStatus
+
+Present only when the organization signed up through someone else\'s invite link: where that referral sits and how far the organization is from unlocking its own reward. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`status` | string
+`spentCents` | number
+`qualifySpendCents` | number
+`rewardCents` | number
+`qualifiedAt` | Date
+`holdUntil` | Date
+`settledAt` | Date
+
+## Example
+
+```typescript
+import type { RefereeStatus } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "status": null,
+  "spentCents": null,
+  "qualifySpendCents": null,
+  "rewardCents": null,
+  "qualifiedAt": null,
+  "holdUntil": null,
+  "settledAt": null,
+} satisfies RefereeStatus
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as RefereeStatus
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/Referral.md

@@ -0,0 +1,55 @@
+
+# Referral
+
+The organization\'s referral-program view: its invite link, the program terms, its referrer stats, and (only when it was itself referred) its referee progress. Amounts are USD cents. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | string
+`inviteUrl` | string
+`pending` | number
+`qualified` | number
+`settled` | number
+`earnedCents` | number
+`rewardCents` | number
+`refereeRewardCents` | number
+`qualifySpendCents` | number
+`holdDays` | number
+`referred` | [RefereeStatus](RefereeStatus.md)
+
+## Example
+
+```typescript
+import type { Referral } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": GPU-7KQ2-M4XP,
+  "inviteUrl": https://deeprelay.ai/r/GPU-7KQ2-M4XP,
+  "pending": null,
+  "qualified": null,
+  "settled": null,
+  "earnedCents": null,
+  "rewardCents": null,
+  "refereeRewardCents": null,
+  "qualifySpendCents": null,
+  "holdDays": null,
+  "referred": null,
+} satisfies Referral
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as Referral
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SubscriptionCheckoutRequest.md

@@ -0,0 +1,39 @@
+
+# SubscriptionCheckoutRequest
+
+Optional overrides for a checkout mint. Every field has a deployment default, so an empty body is the normal call. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`successUrl` | string
+`cancelUrl` | string
+`planKey` | string
+
+## Example
+
+```typescript
+import type { SubscriptionCheckoutRequest } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "successUrl": null,
+  "cancelUrl": null,
+  "planKey": null,
+} satisfies SubscriptionCheckoutRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SubscriptionCheckoutRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SubscriptionCheckoutSession.md

@@ -0,0 +1,38 @@
+
+# SubscriptionCheckoutSession
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`checkoutUrl` | string
+`sessionId` | string
+`plan` | [SubscriptionPlan](SubscriptionPlan.md)
+
+## Example
+
+```typescript
+import type { SubscriptionCheckoutSession } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "checkoutUrl": null,
+  "sessionId": null,
+  "plan": null,
+} satisfies SubscriptionCheckoutSession
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SubscriptionCheckoutSession
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SubscriptionPortalRequest.md

@@ -0,0 +1,35 @@
+
+# SubscriptionPortalRequest
+
+Optional overrides for a billing-portal mint.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`returnUrl` | string
+
+## Example
+
+```typescript
+import type { SubscriptionPortalRequest } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "returnUrl": null,
+} satisfies SubscriptionPortalRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SubscriptionPortalRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SubscriptionPortalSession.md

@@ -0,0 +1,34 @@
+
+# SubscriptionPortalSession
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`portalUrl` | string
+
+## Example
+
+```typescript
+import type { SubscriptionPortalSession } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "portalUrl": null,
+} satisfies SubscriptionPortalSession
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SubscriptionPortalSession
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/VideoJob.md

@@ -17,6 +17,7 @@ Name | Type
 `completedAt` | number
 `expiresAt` | number
 `error` | string
+`errorMessage` | string
 `costCents` | number
 
 ## Example
@@ -37,6 +38,7 @@ const example = {
   "completedAt": null,
   "expiresAt": null,
   "error": null,
+  "errorMessage": null,
   "costCents": null,
 } satisfies VideoJob
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deeprelay/sdk",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "TypeScript SDK for the deeprelay Public Developer API",
   "author": "deeprelay Support <support@deeprelay.ai>",
   "repository": {

package/src/apis/BillingApi.ts

@@ -38,6 +38,11 @@ import {
     ProblemFromJSON,
     ProblemToJSON,
 } from '../models/Problem';
+import {
+    type Referral,
+    ReferralFromJSON,
+    ReferralToJSON,
+} from '../models/Referral';
 import {
     type SpendingLimit,
     SpendingLimitFromJSON,
@@ -48,6 +53,26 @@ import {
     SubscriptionFromJSON,
     SubscriptionToJSON,
 } from '../models/Subscription';
+import {
+    type SubscriptionCheckoutRequest,
+    SubscriptionCheckoutRequestFromJSON,
+    SubscriptionCheckoutRequestToJSON,
+} from '../models/SubscriptionCheckoutRequest';
+import {
+    type SubscriptionCheckoutSession,
+    SubscriptionCheckoutSessionFromJSON,
+    SubscriptionCheckoutSessionToJSON,
+} from '../models/SubscriptionCheckoutSession';
+import {
+    type SubscriptionPortalRequest,
+    SubscriptionPortalRequestFromJSON,
+    SubscriptionPortalRequestToJSON,
+} from '../models/SubscriptionPortalRequest';
+import {
+    type SubscriptionPortalSession,
+    SubscriptionPortalSessionFromJSON,
+    SubscriptionPortalSessionToJSON,
+} from '../models/SubscriptionPortalSession';
 import {
     type UpdateSpendingLimitRequest,
     UpdateSpendingLimitRequestFromJSON,
@@ -58,6 +83,14 @@ export interface CreateCryptoDepositOperationRequest {
     createCryptoDepositRequest: CreateCryptoDepositRequest;
 }
 
+export interface CreateSubscriptionCheckoutRequest {
+    subscriptionCheckoutRequest?: SubscriptionCheckoutRequest;
+}
+
+export interface CreateSubscriptionPortalRequest {
+    subscriptionPortalRequest?: SubscriptionPortalRequest;
+}
+
 export interface GetDepositRequest {
     id: string;
 }
@@ -128,6 +161,106 @@ export class BillingApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for createSubscriptionCheckout without sending the request
+     */
+    async createSubscriptionCheckoutRequestOpts(requestParameters: CreateSubscriptionCheckoutRequest): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/billing/subscription/checkout`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: SubscriptionCheckoutRequestToJSON(requestParameters['subscriptionCheckoutRequest']),
+        };
+    }
+
+    /**
+     * Opens a hosted checkout session for the flat tier and returns its URL. Requires the `billing:write` scope AND organization-admin privileges — subscribing spends organization money.  This endpoint does NOT subscribe anyone. Checkout is a hosted page that needs a browser and a card, so the caller\'s job is to put the returned URL in front of a human. The subscription becomes active when payment completes, which is not synchronous with this call: poll `/billing/subscription` to confirm.  `success_url` and `cancel_url` are optional and fall back to the deployment\'s configured redirects, which is what lets a command-line client start a purchase without having any URLs of its own. An empty request body is valid and means \"use every default\".  `plan_key`, when sent, pins the plan the client DISPLAYED: an unknown key is a 400 rather than a silent purchase of a different tier. Today there is one tier, so the only accepted value is its key — but sending it is the forward-compatible choice.  One flat tier means at most one subscription per organization: a second checkout while an entitling subscription exists is a 409. 
+     * Start a subscription checkout session
+     */
+    async createSubscriptionCheckoutRaw(requestParameters: CreateSubscriptionCheckoutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SubscriptionCheckoutSession>> {
+        const requestOptions = await this.createSubscriptionCheckoutRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SubscriptionCheckoutSessionFromJSON(jsonValue));
+    }
+
+    /**
+     * Opens a hosted checkout session for the flat tier and returns its URL. Requires the `billing:write` scope AND organization-admin privileges — subscribing spends organization money.  This endpoint does NOT subscribe anyone. Checkout is a hosted page that needs a browser and a card, so the caller\'s job is to put the returned URL in front of a human. The subscription becomes active when payment completes, which is not synchronous with this call: poll `/billing/subscription` to confirm.  `success_url` and `cancel_url` are optional and fall back to the deployment\'s configured redirects, which is what lets a command-line client start a purchase without having any URLs of its own. An empty request body is valid and means \"use every default\".  `plan_key`, when sent, pins the plan the client DISPLAYED: an unknown key is a 400 rather than a silent purchase of a different tier. Today there is one tier, so the only accepted value is its key — but sending it is the forward-compatible choice.  One flat tier means at most one subscription per organization: a second checkout while an entitling subscription exists is a 409. 
+     * Start a subscription checkout session
+     */
+    async createSubscriptionCheckout(requestParameters: CreateSubscriptionCheckoutRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SubscriptionCheckoutSession> {
+        const response = await this.createSubscriptionCheckoutRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for createSubscriptionPortal without sending the request
+     */
+    async createSubscriptionPortalRequestOpts(requestParameters: CreateSubscriptionPortalRequest): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/billing/subscription/portal`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: SubscriptionPortalRequestToJSON(requestParameters['subscriptionPortalRequest']),
+        };
+    }
+
+    /**
+     * Returns a URL for the hosted billing portal: where a customer cancels the subscription, resumes one they cancelled, changes payment method, or downloads invoices. Requires the `billing:write` scope AND organization-admin privileges.  Cancellation lives here rather than on its own endpoint because it is one surface with the rest of the billing lifecycle. The common reason a subscription is about to lapse is a declined card, and the fix for that is a new card, not a cancellation — sending a customer somewhere that can only cancel would lose renewals.  Cancelling in the portal ends the subscription at the close of the current period; coverage continues until then and `/billing/subscription` reports `cancel_at_period_end: true`.  An organization that has never paid for anything gets 404: there is no billing account to manage, and this endpoint deliberately does not create one as a side effect of looking. 
+     * Open the billing portal to cancel or manage the subscription
+     */
+    async createSubscriptionPortalRaw(requestParameters: CreateSubscriptionPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SubscriptionPortalSession>> {
+        const requestOptions = await this.createSubscriptionPortalRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SubscriptionPortalSessionFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns a URL for the hosted billing portal: where a customer cancels the subscription, resumes one they cancelled, changes payment method, or downloads invoices. Requires the `billing:write` scope AND organization-admin privileges.  Cancellation lives here rather than on its own endpoint because it is one surface with the rest of the billing lifecycle. The common reason a subscription is about to lapse is a declined card, and the fix for that is a new card, not a cancellation — sending a customer somewhere that can only cancel would lose renewals.  Cancelling in the portal ends the subscription at the close of the current period; coverage continues until then and `/billing/subscription` reports `cancel_at_period_end: true`.  An organization that has never paid for anything gets 404: there is no billing account to manage, and this endpoint deliberately does not create one as a side effect of looking. 
+     * Open the billing portal to cancel or manage the subscription
+     */
+    async createSubscriptionPortal(requestParameters: CreateSubscriptionPortalRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SubscriptionPortalSession> {
+        const response = await this.createSubscriptionPortalRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for getBalance without sending the request
      */
@@ -230,6 +363,53 @@ export class BillingApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for getReferral without sending the request
+     */
+    async getReferralRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/referrals`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Returns the organization\'s shareable referral code and invite link (minting the code on first read), the program terms, the referrer\'s stats, and — when this organization itself signed up through someone else\'s link — its own progress toward the referee reward. Requires the `billing:read` scope. The organization is taken from the authenticated API key, never from a parameter.  The program: share the invite link; when a friend signs up through it and spends `qualify_spend_cents` on inference, the referrer receives `reward_cents` and the friend receives `referee_reward_cents`, both as non-withdrawable credit, after a `hold_days` chargeback hold. The terms ride on the wire so a client never hard-codes the amounts.  `referred` is ABSENT (not null) for an organization nobody referred — key on its presence. This is the same contract the dashboard\'s referral card reads. 
+     * Get the org referral code, invite link, terms and stats
+     */
+    async getReferralRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Referral>> {
+        const requestOptions = await this.getReferralRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ReferralFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns the organization\'s shareable referral code and invite link (minting the code on first read), the program terms, the referrer\'s stats, and — when this organization itself signed up through someone else\'s link — its own progress toward the referee reward. Requires the `billing:read` scope. The organization is taken from the authenticated API key, never from a parameter.  The program: share the invite link; when a friend signs up through it and spends `qualify_spend_cents` on inference, the referrer receives `reward_cents` and the friend receives `referee_reward_cents`, both as non-withdrawable credit, after a `hold_days` chargeback hold. The terms ride on the wire so a client never hard-codes the amounts.  `referred` is ABSENT (not null) for an organization nobody referred — key on its presence. This is the same contract the dashboard\'s referral card reads. 
+     * Get the org referral code, invite link, terms and stats
+     */
+    async getReferral(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Referral> {
+        const response = await this.getReferralRaw(initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for getSpendingLimit without sending the request
      */

package/src/apis/InferenceApi.ts

@@ -43,6 +43,11 @@ import {
     ImagesResponseFromJSON,
     ImagesResponseToJSON,
 } from '../models/ImagesResponse';
+import {
+    type InferencePreflight,
+    InferencePreflightFromJSON,
+    InferencePreflightToJSON,
+} from '../models/InferencePreflight';
 import {
     type Model,
     ModelFromJSON,
@@ -108,6 +113,10 @@ export interface GetVideoContentRequest {
     id: string;
 }
 
+export interface InferencePreflightRequest {
+    model: string;
+}
+
 export interface ListModelsRequest {
     modality?: ListModelsModalityEnum;
 }
@@ -570,6 +579,64 @@ export class InferenceApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for inferencePreflight without sending the request
+     */
+    async inferencePreflightRequestOpts(requestParameters: InferencePreflightRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['model'] == null) {
+            throw new runtime.RequiredError(
+                'model',
+                'Required parameter "model" was null or undefined when calling inferencePreflight().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['model'] != null) {
+            queryParameters['model'] = requestParameters['model'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/inference/preflight`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Answers \"what happens if I call this model right now?\" before the call is made: whether the plan covers the model, whether the organization is subscribed, and whether there is credit to pay if it is not covered. Requires the `serverless:read` scope.  Nothing is sent, counted, charged, or reserved. The verdict is computed from the state of the SAME gates that judge the real request — plan coverage, subscription entitlement, remaining plan quota, credit balance and self-set spending caps — so the advice cannot drift from enforcement. It is deliberately NOT a dry run: no per-request cost estimate is quoted, because that figure changes with every prompt and quoting it would invite clients to cache it.  The gates consulted depend on the model\'s MODALITY, because the endpoints do not all meet the same ones. Chat, embeddings and image requests meet the full gate (balance, then the organization\'s opt-in daily cap, then its monthly cap). Video creation meets only the balance check, so an organization past its own spending cap but holding credit is reported as fundable for video — which is what the video endpoint will in fact do. Predicting the strictest gate rather than the applicable one would make this endpoint refuse requests the API accepts.  The same is true of the plan: video creation does not run the subscription gate, so `plan_covered` is false for a video model even if an operator has placed it on the plan\'s covered list. That is a deliberate divergence from the same-named field on `/v1/models`, which reports the platform\'s configuration. Here it means \"the plan covers this REQUEST\" — describing what will happen is the entire job of a preflight.  One caveat on \"read-only\": resolving the balance creates the organization\'s balance row if it has never had one (idempotent, org-scoped, and the same row the first real request would create). Nothing else is written.  The case this exists for is `warn` / `not_plan_covered`. A subscriber calling a model outside the plan IS served and IS charged pay-as-you-go, and nothing in the response to that request says so — the first signal used to be the invoice.  `funded` is a boolean and never a figure. This route is on the inference read scope, so it must not disclose the organization\'s balance; use `/billing/balance` for the number.  Failure posture is the opposite of the request gate\'s: any gate that cannot be read degrades the verdict toward `ok`, never toward `block`. A false `block` would stop a customer whose request would have succeeded, while a false `ok` costs them one honest error from the real call. 
+     * Check whether a model request would be served, and at whose expense
+     */
+    async inferencePreflightRaw(requestParameters: InferencePreflightRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InferencePreflight>> {
+        const requestOptions = await this.inferencePreflightRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => InferencePreflightFromJSON(jsonValue));
+    }
+
+    /**
+     * Answers \"what happens if I call this model right now?\" before the call is made: whether the plan covers the model, whether the organization is subscribed, and whether there is credit to pay if it is not covered. Requires the `serverless:read` scope.  Nothing is sent, counted, charged, or reserved. The verdict is computed from the state of the SAME gates that judge the real request — plan coverage, subscription entitlement, remaining plan quota, credit balance and self-set spending caps — so the advice cannot drift from enforcement. It is deliberately NOT a dry run: no per-request cost estimate is quoted, because that figure changes with every prompt and quoting it would invite clients to cache it.  The gates consulted depend on the model\'s MODALITY, because the endpoints do not all meet the same ones. Chat, embeddings and image requests meet the full gate (balance, then the organization\'s opt-in daily cap, then its monthly cap). Video creation meets only the balance check, so an organization past its own spending cap but holding credit is reported as fundable for video — which is what the video endpoint will in fact do. Predicting the strictest gate rather than the applicable one would make this endpoint refuse requests the API accepts.  The same is true of the plan: video creation does not run the subscription gate, so `plan_covered` is false for a video model even if an operator has placed it on the plan\'s covered list. That is a deliberate divergence from the same-named field on `/v1/models`, which reports the platform\'s configuration. Here it means \"the plan covers this REQUEST\" — describing what will happen is the entire job of a preflight.  One caveat on \"read-only\": resolving the balance creates the organization\'s balance row if it has never had one (idempotent, org-scoped, and the same row the first real request would create). Nothing else is written.  The case this exists for is `warn` / `not_plan_covered`. A subscriber calling a model outside the plan IS served and IS charged pay-as-you-go, and nothing in the response to that request says so — the first signal used to be the invoice.  `funded` is a boolean and never a figure. This route is on the inference read scope, so it must not disclose the organization\'s balance; use `/billing/balance` for the number.  Failure posture is the opposite of the request gate\'s: any gate that cannot be read degrades the verdict toward `ok`, never toward `block`. A false `block` would stop a customer whose request would have succeeded, while a false `ok` costs them one honest error from the real call. 
+     * Check whether a model request would be served, and at whose expense
+     */
+    async inferencePreflight(requestParameters: InferencePreflightRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InferencePreflight> {
+        const response = await this.inferencePreflightRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for listModels without sending the request
      */