@deeprelay/sdk 0.1.0 → 0.1.1

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
      */

package/src/models/InferencePreflight.ts

@@ -0,0 +1,147 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * deeprelay Public Developer API
+ * Programmatic API for deeprelay. Authenticate with API keys minted from the dashboard. See https://deeprelay.ai/docs for details. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@deeprelay.ai
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * The verdict for one (organization, model) pair: what would happen if the model were invoked right now.
+ * 
+ * @export
+ * @interface InferencePreflight
+ */
+export interface InferencePreflight {
+    /**
+     * The canonical catalog id the request resolved to.
+     * @type {string}
+     * @memberof InferencePreflight
+     */
+    model: string;
+    /**
+     * `ok` — the request will be served (covered by the plan, or payable). `warn` — it will be served AND charged in a way the caller may not expect. `block` — it will be refused (402 or 429).
+     * @type {InferencePreflightVerdictEnum}
+     * @memberof InferencePreflight
+     */
+    verdict: InferencePreflightVerdictEnum;
+    /**
+     * Stable code explaining the verdict, for clients that need their own wording. Absent on a plain `ok` that needs no explanation.
+     * @type {InferencePreflightReasonEnum}
+     * @memberof InferencePreflight
+     */
+    reason?: InferencePreflightReasonEnum;
+    /**
+     * A ready-to-print sentence, phrased for this exact plan/credit combination. Prefer it over composing one from verdict and reason: it improves without a client release.
+     * @type {string}
+     * @memberof InferencePreflight
+     */
+    message: string;
+    /**
+     * Whether the subscription tier covers this model. A property of the PLATFORM, not of the caller — it stays true for an organization that has no subscription, which is what makes the "this is included in the plan" upsell honest.
+     * @type {boolean}
+     * @memberof InferencePreflight
+     */
+    planCovered: boolean;
+    /**
+     * Whether the organization is entitled to the plan right now.
+     * @type {boolean}
+     * @memberof InferencePreflight
+     */
+    subscribed: boolean;
+    /**
+     * Whether a pay-as-you-go request could be paid for right now: a positive credit balance AND no self-set spending cap already at its limit. A boolean and never a figure — this route is on the inference read scope and must not disclose the balance.
+     * @type {boolean}
+     * @memberof InferencePreflight
+     */
+    funded: boolean;
+}
+
+
+/**
+ * @export
+ */
+export const InferencePreflightVerdictEnum = {
+    Ok: 'ok',
+    Warn: 'warn',
+    Block: 'block'
+} as const;
+export type InferencePreflightVerdictEnum = typeof InferencePreflightVerdictEnum[keyof typeof InferencePreflightVerdictEnum];
+
+/**
+ * @export
+ */
+export const InferencePreflightReasonEnum = {
+    PlanCovered: 'plan_covered',
+    Payg: 'payg',
+    NotPlanCovered: 'not_plan_covered',
+    SubscriptionQuotaExhausted: 'subscription_quota_exhausted',
+    InsufficientBalance: 'insufficient_balance',
+    DailyLimitReached: 'daily_limit_reached',
+    MonthlyLimitReached: 'monthly_limit_reached',
+    PreflightUnavailable: 'preflight_unavailable'
+} as const;
+export type InferencePreflightReasonEnum = typeof InferencePreflightReasonEnum[keyof typeof InferencePreflightReasonEnum];
+
+
+/**
+ * Check if a given object implements the InferencePreflight interface.
+ */
+export function instanceOfInferencePreflight(value: object): value is InferencePreflight {
+    if (!('model' in value) || value['model'] === undefined) return false;
+    if (!('verdict' in value) || value['verdict'] === undefined) return false;
+    if (!('message' in value) || value['message'] === undefined) return false;
+    if ((!('planCovered' in (value as Record<string, any>)) && !('plan_covered' in (value as Record<string, any>))) || ((value as Record<string, any>)['planCovered'] === undefined && (value as Record<string, any>)['plan_covered'] === undefined)) return false;
+    if (!('subscribed' in value) || value['subscribed'] === undefined) return false;
+    if (!('funded' in value) || value['funded'] === undefined) return false;
+    return true;
+}
+
+export function InferencePreflightFromJSON(json: any): InferencePreflight {
+    return InferencePreflightFromJSONTyped(json, false);
+}
+
+export function InferencePreflightFromJSONTyped(json: any, ignoreDiscriminator: boolean): InferencePreflight {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'model': json['model'],
+        'verdict': json['verdict'],
+        'reason': json['reason'] == null ? undefined : json['reason'],
+        'message': json['message'],
+        'planCovered': json['plan_covered'],
+        'subscribed': json['subscribed'],
+        'funded': json['funded'],
+    };
+}
+
+export function InferencePreflightToJSON(json: any): InferencePreflight {
+    return InferencePreflightToJSONTyped(json, false);
+}
+
+export function InferencePreflightToJSONTyped(value?: InferencePreflight | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'model': value['model'],
+        'verdict': value['verdict'],
+        'reason': value['reason'],
+        'message': value['message'],
+        'plan_covered': value['planCovered'],
+        'subscribed': value['subscribed'],
+        'funded': value['funded'],
+    };
+}
+

package/src/models/SubscriptionCheckoutRequest.ts

@@ -0,0 +1,82 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * deeprelay Public Developer API
+ * Programmatic API for deeprelay. Authenticate with API keys minted from the dashboard. See https://deeprelay.ai/docs for details. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@deeprelay.ai
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * Optional overrides for a checkout mint. Every field has a deployment default, so an empty body is the normal call.
+ * 
+ * @export
+ * @interface SubscriptionCheckoutRequest
+ */
+export interface SubscriptionCheckoutRequest {
+    /**
+     * Where the provider returns after a completed payment. Defaults to the deployment's configured URL.
+     * @type {string}
+     * @memberof SubscriptionCheckoutRequest
+     */
+    successUrl?: string;
+    /**
+     * Where the provider returns if checkout is abandoned. Defaults to the deployment's configured URL.
+     * @type {string}
+     * @memberof SubscriptionCheckoutRequest
+     */
+    cancelUrl?: string;
+    /**
+     * Pins the plan the client displayed. An unknown key is a 400 rather than a silent purchase of a different tier.
+     * @type {string}
+     * @memberof SubscriptionCheckoutRequest
+     */
+    planKey?: string;
+}
+
+/**
+ * Check if a given object implements the SubscriptionCheckoutRequest interface.
+ */
+export function instanceOfSubscriptionCheckoutRequest(value: object): value is SubscriptionCheckoutRequest {
+    return true;
+}
+
+export function SubscriptionCheckoutRequestFromJSON(json: any): SubscriptionCheckoutRequest {
+    return SubscriptionCheckoutRequestFromJSONTyped(json, false);
+}
+
+export function SubscriptionCheckoutRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubscriptionCheckoutRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'successUrl': json['success_url'] == null ? undefined : json['success_url'],
+        'cancelUrl': json['cancel_url'] == null ? undefined : json['cancel_url'],
+        'planKey': json['plan_key'] == null ? undefined : json['plan_key'],
+    };
+}
+
+export function SubscriptionCheckoutRequestToJSON(json: any): SubscriptionCheckoutRequest {
+    return SubscriptionCheckoutRequestToJSONTyped(json, false);
+}
+
+export function SubscriptionCheckoutRequestToJSONTyped(value?: SubscriptionCheckoutRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'success_url': value['successUrl'],
+        'cancel_url': value['cancelUrl'],
+        'plan_key': value['planKey'],
+    };
+}
+

package/src/models/SubscriptionCheckoutSession.ts

@@ -0,0 +1,92 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * deeprelay Public Developer API
+ * Programmatic API for deeprelay. Authenticate with API keys minted from the dashboard. See https://deeprelay.ai/docs for details. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@deeprelay.ai
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { SubscriptionPlan } from './SubscriptionPlan';
+import {
+    SubscriptionPlanFromJSON,
+    SubscriptionPlanFromJSONTyped,
+    SubscriptionPlanToJSON,
+    SubscriptionPlanToJSONTyped,
+} from './SubscriptionPlan';
+
+/**
+ * 
+ * @export
+ * @interface SubscriptionCheckoutSession
+ */
+export interface SubscriptionCheckoutSession {
+    /**
+     * The hosted page the customer must open to pay.
+     * @type {string}
+     * @memberof SubscriptionCheckoutSession
+     */
+    checkoutUrl: string;
+    /**
+     * Checkout session id, for support correlation.
+     * @type {string}
+     * @memberof SubscriptionCheckoutSession
+     */
+    sessionId: string;
+    /**
+     * 
+     * @type {SubscriptionPlan}
+     * @memberof SubscriptionCheckoutSession
+     */
+    plan: SubscriptionPlan;
+}
+
+/**
+ * Check if a given object implements the SubscriptionCheckoutSession interface.
+ */
+export function instanceOfSubscriptionCheckoutSession(value: object): value is SubscriptionCheckoutSession {
+    if ((!('checkoutUrl' in (value as Record<string, any>)) && !('checkout_url' in (value as Record<string, any>))) || ((value as Record<string, any>)['checkoutUrl'] === undefined && (value as Record<string, any>)['checkout_url'] === undefined)) return false;
+    if ((!('sessionId' in (value as Record<string, any>)) && !('session_id' in (value as Record<string, any>))) || ((value as Record<string, any>)['sessionId'] === undefined && (value as Record<string, any>)['session_id'] === undefined)) return false;
+    if (!('plan' in value) || value['plan'] === undefined) return false;
+    return true;
+}
+
+export function SubscriptionCheckoutSessionFromJSON(json: any): SubscriptionCheckoutSession {
+    return SubscriptionCheckoutSessionFromJSONTyped(json, false);
+}
+
+export function SubscriptionCheckoutSessionFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubscriptionCheckoutSession {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'checkoutUrl': json['checkout_url'],
+        'sessionId': json['session_id'],
+        'plan': SubscriptionPlanFromJSON(json['plan']),
+    };
+}
+
+export function SubscriptionCheckoutSessionToJSON(json: any): SubscriptionCheckoutSession {
+    return SubscriptionCheckoutSessionToJSONTyped(json, false);
+}
+
+export function SubscriptionCheckoutSessionToJSONTyped(value?: SubscriptionCheckoutSession | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'checkout_url': value['checkoutUrl'],
+        'session_id': value['sessionId'],
+        'plan': SubscriptionPlanToJSON(value['plan']),
+    };
+}
+

package/src/models/SubscriptionPortalRequest.ts

@@ -0,0 +1,65 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * deeprelay Public Developer API
+ * Programmatic API for deeprelay. Authenticate with API keys minted from the dashboard. See https://deeprelay.ai/docs for details. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@deeprelay.ai
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * Optional overrides for a billing-portal mint.
+ * @export
+ * @interface SubscriptionPortalRequest
+ */
+export interface SubscriptionPortalRequest {
+    /**
+     * Where the provider returns when the customer leaves the portal. Defaults to the deployment's configured URL.
+     * @type {string}
+     * @memberof SubscriptionPortalRequest
+     */
+    returnUrl?: string;
+}
+
+/**
+ * Check if a given object implements the SubscriptionPortalRequest interface.
+ */
+export function instanceOfSubscriptionPortalRequest(value: object): value is SubscriptionPortalRequest {
+    return true;
+}
+
+export function SubscriptionPortalRequestFromJSON(json: any): SubscriptionPortalRequest {
+    return SubscriptionPortalRequestFromJSONTyped(json, false);
+}
+
+export function SubscriptionPortalRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubscriptionPortalRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'returnUrl': json['return_url'] == null ? undefined : json['return_url'],
+    };
+}
+
+export function SubscriptionPortalRequestToJSON(json: any): SubscriptionPortalRequest {
+    return SubscriptionPortalRequestToJSONTyped(json, false);
+}
+
+export function SubscriptionPortalRequestToJSONTyped(value?: SubscriptionPortalRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'return_url': value['returnUrl'],
+    };
+}
+

package/src/models/SubscriptionPortalSession.ts

@@ -0,0 +1,66 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * deeprelay Public Developer API
+ * Programmatic API for deeprelay. Authenticate with API keys minted from the dashboard. See https://deeprelay.ai/docs for details. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@deeprelay.ai
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface SubscriptionPortalSession
+ */
+export interface SubscriptionPortalSession {
+    /**
+     * The hosted billing portal — cancel, resume, change payment method, download invoices.
+     * @type {string}
+     * @memberof SubscriptionPortalSession
+     */
+    portalUrl: string;
+}
+
+/**
+ * Check if a given object implements the SubscriptionPortalSession interface.
+ */
+export function instanceOfSubscriptionPortalSession(value: object): value is SubscriptionPortalSession {
+    if ((!('portalUrl' in (value as Record<string, any>)) && !('portal_url' in (value as Record<string, any>))) || ((value as Record<string, any>)['portalUrl'] === undefined && (value as Record<string, any>)['portal_url'] === undefined)) return false;
+    return true;
+}
+
+export function SubscriptionPortalSessionFromJSON(json: any): SubscriptionPortalSession {
+    return SubscriptionPortalSessionFromJSONTyped(json, false);
+}
+
+export function SubscriptionPortalSessionFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubscriptionPortalSession {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'portalUrl': json['portal_url'],
+    };
+}
+
+export function SubscriptionPortalSessionToJSON(json: any): SubscriptionPortalSession {
+    return SubscriptionPortalSessionToJSONTyped(json, false);
+}
+
+export function SubscriptionPortalSessionToJSONTyped(value?: SubscriptionPortalSession | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'portal_url': value['portalUrl'],
+    };
+}
+

package/src/models/index.ts

@@ -18,6 +18,7 @@ export * from './ImagesGenerationsRequest';
 export * from './ImagesResponse';
 export * from './ImagesResponseDataInner';
 export * from './ImagesResponseUsage';
+export * from './InferencePreflight';
 export * from './ListDeposits200Response';
 export * from './Model';
 export * from './ModelList';
@@ -34,7 +35,11 @@ export * from './Problem';
 export * from './SpendingLimit';
 export * from './StreamOptions';
 export * from './Subscription';
+export * from './SubscriptionCheckoutRequest';
+export * from './SubscriptionCheckoutSession';
 export * from './SubscriptionPlan';
+export * from './SubscriptionPortalRequest';
+export * from './SubscriptionPortalSession';
 export * from './SubscriptionPrice';
 export * from './SubscriptionQuota';
 export * from './SubscriptionUsage';

package/src/runtime.ts

@@ -75,7 +75,7 @@ export class Configuration {
     }
 
     get headers(): HTTPHeaders | undefined {
-        return { 'User-Agent': 'deeprelay-sdk-ts/0.1.0', ...this.configuration.headers };
+        return { 'User-Agent': 'deeprelay-sdk-ts/0.1.1', ...this.configuration.headers };
     }
 
     get credentials(): RequestCredentials | undefined {