@deeprelay/sdk 0.0.1 → 0.1.1

package/dist/esm/models/ImagesResponseUsage.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface ImagesResponseUsage
+ */
+export interface ImagesResponseUsage {
+    /**
+     * Number of images generated (the billable unit).
+     * @type {number}
+     * @memberof ImagesResponseUsage
+     */
+    imageCount: number;
+}
+/**
+ * Check if a given object implements the ImagesResponseUsage interface.
+ */
+export declare function instanceOfImagesResponseUsage(value: object): value is ImagesResponseUsage;
+export declare function ImagesResponseUsageFromJSON(json: any): ImagesResponseUsage;
+export declare function ImagesResponseUsageFromJSONTyped(json: any, ignoreDiscriminator: boolean): ImagesResponseUsage;
+export declare function ImagesResponseUsageToJSON(json: any): ImagesResponseUsage;
+export declare function ImagesResponseUsageToJSONTyped(value?: ImagesResponseUsage | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ImagesResponseUsage.js

@@ -0,0 +1,43 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the ImagesResponseUsage interface.
+ */
+export function instanceOfImagesResponseUsage(value) {
+    if ((!('imageCount' in value) && !('image_count' in value)) || (value['imageCount'] === undefined && value['image_count'] === undefined))
+        return false;
+    return true;
+}
+export function ImagesResponseUsageFromJSON(json) {
+    return ImagesResponseUsageFromJSONTyped(json, false);
+}
+export function ImagesResponseUsageFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'imageCount': json['image_count'],
+    };
+}
+export function ImagesResponseUsageToJSON(json) {
+    return ImagesResponseUsageToJSONTyped(json, false);
+}
+export function ImagesResponseUsageToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'image_count': value['imageCount'],
+    };
+}

package/dist/esm/models/InferencePreflight.d.ts

@@ -0,0 +1,92 @@
+/**
+ * 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.
+ */
+/**
+ * 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 declare const InferencePreflightVerdictEnum: {
+    readonly Ok: "ok";
+    readonly Warn: "warn";
+    readonly Block: "block";
+};
+export type InferencePreflightVerdictEnum = typeof InferencePreflightVerdictEnum[keyof typeof InferencePreflightVerdictEnum];
+/**
+ * @export
+ */
+export declare const InferencePreflightReasonEnum: {
+    readonly PlanCovered: "plan_covered";
+    readonly Payg: "payg";
+    readonly NotPlanCovered: "not_plan_covered";
+    readonly SubscriptionQuotaExhausted: "subscription_quota_exhausted";
+    readonly InsufficientBalance: "insufficient_balance";
+    readonly DailyLimitReached: "daily_limit_reached";
+    readonly MonthlyLimitReached: "monthly_limit_reached";
+    readonly PreflightUnavailable: "preflight_unavailable";
+};
+export type InferencePreflightReasonEnum = typeof InferencePreflightReasonEnum[keyof typeof InferencePreflightReasonEnum];
+/**
+ * Check if a given object implements the InferencePreflight interface.
+ */
+export declare function instanceOfInferencePreflight(value: object): value is InferencePreflight;
+export declare function InferencePreflightFromJSON(json: any): InferencePreflight;
+export declare function InferencePreflightFromJSONTyped(json: any, ignoreDiscriminator: boolean): InferencePreflight;
+export declare function InferencePreflightToJSON(json: any): InferencePreflight;
+export declare function InferencePreflightToJSONTyped(value?: InferencePreflight | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/InferencePreflight.js

@@ -0,0 +1,86 @@
+/* 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.
+ */
+/**
+ * @export
+ */
+export const InferencePreflightVerdictEnum = {
+    Ok: 'ok',
+    Warn: 'warn',
+    Block: 'block'
+};
+/**
+ * @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'
+};
+/**
+ * Check if a given object implements the InferencePreflight interface.
+ */
+export function instanceOfInferencePreflight(value) {
+    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) && !('plan_covered' in value)) || (value['planCovered'] === undefined && value['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) {
+    return InferencePreflightFromJSONTyped(json, false);
+}
+export function InferencePreflightFromJSONTyped(json, ignoreDiscriminator) {
+    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) {
+    return InferencePreflightToJSONTyped(json, false);
+}
+export function InferencePreflightToJSONTyped(value, ignoreDiscriminator = false) {
+    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/dist/esm/models/ListDeposits200Response.d.ts

@@ -0,0 +1,39 @@
+/**
+ * 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 type { CryptoDeposit } from './CryptoDeposit';
+/**
+ *
+ * @export
+ * @interface ListDeposits200Response
+ */
+export interface ListDeposits200Response {
+    /**
+     *
+     * @type {Array<CryptoDeposit>}
+     * @memberof ListDeposits200Response
+     */
+    deposits: Array<CryptoDeposit>;
+    /**
+     * The effective minimum deposit in USD cents (admin override, else the deployment's configured floor). Validate amounts against this live value rather than hardcoding the default.
+     * @type {number}
+     * @memberof ListDeposits200Response
+     */
+    minDepositCents: number;
+}
+/**
+ * Check if a given object implements the ListDeposits200Response interface.
+ */
+export declare function instanceOfListDeposits200Response(value: object): value is ListDeposits200Response;
+export declare function ListDeposits200ResponseFromJSON(json: any): ListDeposits200Response;
+export declare function ListDeposits200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListDeposits200Response;
+export declare function ListDeposits200ResponseToJSON(json: any): ListDeposits200Response;
+export declare function ListDeposits200ResponseToJSONTyped(value?: ListDeposits200Response | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ListDeposits200Response.js

@@ -0,0 +1,48 @@
+/* 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 { CryptoDepositFromJSON, CryptoDepositToJSON, } from './CryptoDeposit';
+/**
+ * Check if a given object implements the ListDeposits200Response interface.
+ */
+export function instanceOfListDeposits200Response(value) {
+    if (!('deposits' in value) || value['deposits'] === undefined)
+        return false;
+    if ((!('minDepositCents' in value) && !('min_deposit_cents' in value)) || (value['minDepositCents'] === undefined && value['min_deposit_cents'] === undefined))
+        return false;
+    return true;
+}
+export function ListDeposits200ResponseFromJSON(json) {
+    return ListDeposits200ResponseFromJSONTyped(json, false);
+}
+export function ListDeposits200ResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'deposits': (json['deposits'].map(CryptoDepositFromJSON)),
+        'minDepositCents': json['min_deposit_cents'],
+    };
+}
+export function ListDeposits200ResponseToJSON(json) {
+    return ListDeposits200ResponseToJSONTyped(json, false);
+}
+export function ListDeposits200ResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'deposits': (value['deposits'].map(CryptoDepositToJSON)),
+        'min_deposit_cents': value['minDepositCents'],
+    };
+}

package/dist/esm/models/Model.d.ts

@@ -0,0 +1,152 @@
+/**
+ * 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 type { ModelPricing } from './ModelPricing';
+import type { ModelParametersInner } from './ModelParametersInner';
+/**
+ *
+ * @export
+ * @interface Model
+ */
+export interface Model {
+    /**
+     *
+     * @type {string}
+     * @memberof Model
+     */
+    id: string;
+    /**
+     *
+     * @type {ModelObjectEnum}
+     * @memberof Model
+     */
+    object: ModelObjectEnum;
+    /**
+     *
+     * @type {number}
+     * @memberof Model
+     */
+    created?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof Model
+     */
+    ownedBy: string;
+    /**
+     * Model creator/organization (e.g. "Meta", "Qwen", "Black Forest Labs").
+     * @type {string}
+     * @memberof Model
+     */
+    author?: string;
+    /**
+     *
+     * @type {ModelModalityEnum}
+     * @memberof Model
+     */
+    modality: ModelModalityEnum;
+    /**
+     * Browse-facing category; mirrors modality (chat/image/video/embedding).
+     * @type {string}
+     * @memberof Model
+     */
+    category?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof Model
+     */
+    contextLength?: number;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof Model
+     */
+    supportedParameters?: Array<string>;
+    /**
+     * Typed parameter descriptors for media (image/video) models — name, type, enum/bounds/default. Playgrounds render input forms from these.
+     * @type {Array<ModelParametersInner>}
+     * @memberof Model
+     */
+    parameters?: Array<ModelParametersInner>;
+    /**
+     *
+     * @type {ModelPricing}
+     * @memberof Model
+     */
+    pricing: ModelPricing;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof Model
+     */
+    aliases?: Array<string>;
+    /**
+     * Whether this model can be used as the base of a managed fine-tuning job. The tunable allowlist is operator-curated and much narrower than the serving catalog, so this is false for almost every model. Absent means false.
+     * @type {boolean}
+     * @memberof Model
+     */
+    fineTunable?: boolean;
+    /**
+     * The exact id to send as `model` when creating a fine-tuning job for this entry. Present only when `fine_tunable` is true, and deliberately distinct from `id`: the allowlist matches the customer-facing base id (e.g. `qwen2.5-7b-instruct`), which a served model normally carries as an alias rather than as its namespaced catalog id.
+     * @type {string}
+     * @memberof Model
+     */
+    fineTuneBaseModel?: string;
+    /**
+     * Whether the flat subscription tier covers this model. A covered model rides the plan's quota while the subscription is entitled and has quota left; everything else bills pay-as-you-go at list rates, as does a covered model once the quota is spent. Absent means false.
+     *
+     * Coverage is a property of the platform, not of the caller: the flag reads the same for every organization, subscribed or not. Use `/billing/subscription` for what the caller's own plan has left.
+     * @type {boolean}
+     * @memberof Model
+     */
+    planCovered?: boolean;
+    /**
+     *
+     * @type {ModelStatusEnum}
+     * @memberof Model
+     */
+    status: ModelStatusEnum;
+}
+/**
+ * @export
+ */
+export declare const ModelObjectEnum: {
+    readonly Model: "model";
+};
+export type ModelObjectEnum = typeof ModelObjectEnum[keyof typeof ModelObjectEnum];
+/**
+ * @export
+ */
+export declare const ModelModalityEnum: {
+    readonly Chat: "chat";
+    readonly Image: "image";
+    readonly Video: "video";
+    readonly Embedding: "embedding";
+};
+export type ModelModalityEnum = typeof ModelModalityEnum[keyof typeof ModelModalityEnum];
+/**
+ * @export
+ */
+export declare const ModelStatusEnum: {
+    readonly Active: "active";
+    readonly ComingSoon: "coming_soon";
+    readonly Deprecated: "deprecated";
+};
+export type ModelStatusEnum = typeof ModelStatusEnum[keyof typeof ModelStatusEnum];
+/**
+ * Check if a given object implements the Model interface.
+ */
+export declare function instanceOfModel(value: object): value is Model;
+export declare function ModelFromJSON(json: any): Model;
+export declare function ModelFromJSONTyped(json: any, ignoreDiscriminator: boolean): Model;
+export declare function ModelToJSON(json: any): Model;
+export declare function ModelToJSONTyped(value?: Model | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/Model.js

@@ -0,0 +1,110 @@
+/* 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 { ModelPricingFromJSON, ModelPricingToJSON, } from './ModelPricing';
+import { ModelParametersInnerFromJSON, ModelParametersInnerToJSON, } from './ModelParametersInner';
+/**
+ * @export
+ */
+export const ModelObjectEnum = {
+    Model: 'model'
+};
+/**
+ * @export
+ */
+export const ModelModalityEnum = {
+    Chat: 'chat',
+    Image: 'image',
+    Video: 'video',
+    Embedding: 'embedding'
+};
+/**
+ * @export
+ */
+export const ModelStatusEnum = {
+    Active: 'active',
+    ComingSoon: 'coming_soon',
+    Deprecated: 'deprecated'
+};
+/**
+ * Check if a given object implements the Model interface.
+ */
+export function instanceOfModel(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('object' in value) || value['object'] === undefined)
+        return false;
+    if (value['object'] !== 'model')
+        return false;
+    if ((!('ownedBy' in value) && !('owned_by' in value)) || (value['ownedBy'] === undefined && value['owned_by'] === undefined))
+        return false;
+    if (!('modality' in value) || value['modality'] === undefined)
+        return false;
+    if (!('pricing' in value) || value['pricing'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    return true;
+}
+export function ModelFromJSON(json) {
+    return ModelFromJSONTyped(json, false);
+}
+export function ModelFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'object': json['object'],
+        'created': json['created'] == null ? undefined : json['created'],
+        'ownedBy': json['owned_by'],
+        'author': json['author'] == null ? undefined : json['author'],
+        'modality': json['modality'],
+        'category': json['category'] == null ? undefined : json['category'],
+        'contextLength': json['context_length'] == null ? undefined : json['context_length'],
+        'supportedParameters': json['supported_parameters'] == null ? undefined : json['supported_parameters'],
+        'parameters': json['parameters'] == null ? undefined : (json['parameters'].map(ModelParametersInnerFromJSON)),
+        'pricing': ModelPricingFromJSON(json['pricing']),
+        'aliases': json['aliases'] == null ? undefined : json['aliases'],
+        'fineTunable': json['fine_tunable'] == null ? undefined : json['fine_tunable'],
+        'fineTuneBaseModel': json['fine_tune_base_model'] == null ? undefined : json['fine_tune_base_model'],
+        'planCovered': json['plan_covered'] == null ? undefined : json['plan_covered'],
+        'status': json['status'],
+    };
+}
+export function ModelToJSON(json) {
+    return ModelToJSONTyped(json, false);
+}
+export function ModelToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'object': value['object'],
+        'created': value['created'],
+        'owned_by': value['ownedBy'],
+        'author': value['author'],
+        'modality': value['modality'],
+        'category': value['category'],
+        'context_length': value['contextLength'],
+        'supported_parameters': value['supportedParameters'],
+        'parameters': value['parameters'] == null ? undefined : (value['parameters'].map(ModelParametersInnerToJSON)),
+        'pricing': ModelPricingToJSON(value['pricing']),
+        'aliases': value['aliases'],
+        'fine_tunable': value['fineTunable'],
+        'fine_tune_base_model': value['fineTuneBaseModel'],
+        'plan_covered': value['planCovered'],
+        'status': value['status'],
+    };
+}

package/dist/esm/models/ModelList.d.ts

@@ -0,0 +1,46 @@
+/**
+ * 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 type { Model } from './Model';
+/**
+ *
+ * @export
+ * @interface ModelList
+ */
+export interface ModelList {
+    /**
+     *
+     * @type {ModelListObjectEnum}
+     * @memberof ModelList
+     */
+    object: ModelListObjectEnum;
+    /**
+     *
+     * @type {Array<Model>}
+     * @memberof ModelList
+     */
+    data: Array<Model>;
+}
+/**
+ * @export
+ */
+export declare const ModelListObjectEnum: {
+    readonly List: "list";
+};
+export type ModelListObjectEnum = typeof ModelListObjectEnum[keyof typeof ModelListObjectEnum];
+/**
+ * Check if a given object implements the ModelList interface.
+ */
+export declare function instanceOfModelList(value: object): value is ModelList;
+export declare function ModelListFromJSON(json: any): ModelList;
+export declare function ModelListFromJSONTyped(json: any, ignoreDiscriminator: boolean): ModelList;
+export declare function ModelListToJSON(json: any): ModelList;
+export declare function ModelListToJSONTyped(value?: ModelList | null, ignoreDiscriminator?: boolean): any;