@deeprelay/sdk 0.0.1 → 0.1.0

package/src/models/Model.ts

@@ -0,0 +1,241 @@
+/* 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 { ModelPricing } from './ModelPricing';
+import {
+    ModelPricingFromJSON,
+    ModelPricingFromJSONTyped,
+    ModelPricingToJSON,
+    ModelPricingToJSONTyped,
+} from './ModelPricing';
+import type { ModelParametersInner } from './ModelParametersInner';
+import {
+    ModelParametersInnerFromJSON,
+    ModelParametersInnerFromJSONTyped,
+    ModelParametersInnerToJSON,
+    ModelParametersInnerToJSONTyped,
+} 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 const ModelObjectEnum = {
+    Model: 'model'
+} as const;
+export type ModelObjectEnum = typeof ModelObjectEnum[keyof typeof ModelObjectEnum];
+
+/**
+ * @export
+ */
+export const ModelModalityEnum = {
+    Chat: 'chat',
+    Image: 'image',
+    Video: 'video',
+    Embedding: 'embedding'
+} as const;
+export type ModelModalityEnum = typeof ModelModalityEnum[keyof typeof ModelModalityEnum];
+
+/**
+ * @export
+ */
+export const ModelStatusEnum = {
+    Active: 'active',
+    ComingSoon: 'coming_soon',
+    Deprecated: 'deprecated'
+} as const;
+export type ModelStatusEnum = typeof ModelStatusEnum[keyof typeof ModelStatusEnum];
+
+
+/**
+ * Check if a given object implements the Model interface.
+ */
+export function instanceOfModel(value: object): value is Model {
+    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 as Record<string, any>)) && !('owned_by' in (value as Record<string, any>))) || ((value as Record<string, any>)['ownedBy'] === undefined && (value as Record<string, any>)['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: any): Model {
+    return ModelFromJSONTyped(json, false);
+}
+
+export function ModelFromJSONTyped(json: any, ignoreDiscriminator: boolean): Model {
+    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'] as Array<any>).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: any): Model {
+    return ModelToJSONTyped(json, false);
+}
+
+export function ModelToJSONTyped(value?: Model | null, ignoreDiscriminator: boolean = false): any {
+    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'] as Array<any>).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/src/models/ModelList.ts

@@ -0,0 +1,95 @@
+/* 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 { Model } from './Model';
+import {
+    ModelFromJSON,
+    ModelFromJSONTyped,
+    ModelToJSON,
+    ModelToJSONTyped,
+} from './Model';
+
+/**
+ * 
+ * @export
+ * @interface ModelList
+ */
+export interface ModelList {
+    /**
+     * 
+     * @type {ModelListObjectEnum}
+     * @memberof ModelList
+     */
+    object: ModelListObjectEnum;
+    /**
+     * 
+     * @type {Array<Model>}
+     * @memberof ModelList
+     */
+    data: Array<Model>;
+}
+
+
+/**
+ * @export
+ */
+export const ModelListObjectEnum = {
+    List: 'list'
+} as const;
+export type ModelListObjectEnum = typeof ModelListObjectEnum[keyof typeof ModelListObjectEnum];
+
+
+/**
+ * Check if a given object implements the ModelList interface.
+ */
+export function instanceOfModelList(value: object): value is ModelList {
+    if (!('object' in value) || value['object'] === undefined) return false;
+    if (value['object'] !== 'list') return false;
+    
+    if (!('data' in value) || value['data'] === undefined) return false;
+    return true;
+}
+
+export function ModelListFromJSON(json: any): ModelList {
+    return ModelListFromJSONTyped(json, false);
+}
+
+export function ModelListFromJSONTyped(json: any, ignoreDiscriminator: boolean): ModelList {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'object': json['object'],
+        'data': ((json['data'] as Array<any>).map(ModelFromJSON)),
+    };
+}
+
+export function ModelListToJSON(json: any): ModelList {
+    return ModelListToJSONTyped(json, false);
+}
+
+export function ModelListToJSONTyped(value?: ModelList | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'object': value['object'],
+        'data': ((value['data'] as Array<any>).map(ModelToJSON)),
+    };
+}
+

package/src/models/ModelParametersInner.ts

@@ -0,0 +1,120 @@
+/* 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 ModelParametersInner
+ */
+export interface ModelParametersInner {
+    /**
+     * 
+     * @type {string}
+     * @memberof ModelParametersInner
+     */
+    name: string;
+    /**
+     * 
+     * @type {ModelParametersInnerTypeEnum}
+     * @memberof ModelParametersInner
+     */
+    type: ModelParametersInnerTypeEnum;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof ModelParametersInner
+     */
+    _enum?: Array<string>;
+    /**
+     * 
+     * @type {number}
+     * @memberof ModelParametersInner
+     */
+    min?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ModelParametersInner
+     */
+    max?: number;
+    /**
+     * 
+     * @type {any}
+     * @memberof ModelParametersInner
+     */
+    _default?: any | null;
+}
+
+
+/**
+ * @export
+ */
+export const ModelParametersInnerTypeEnum = {
+    Enum: 'enum',
+    Int: 'int',
+    String: 'string',
+    Bool: 'bool'
+} as const;
+export type ModelParametersInnerTypeEnum = typeof ModelParametersInnerTypeEnum[keyof typeof ModelParametersInnerTypeEnum];
+
+
+/**
+ * Check if a given object implements the ModelParametersInner interface.
+ */
+export function instanceOfModelParametersInner(value: object): value is ModelParametersInner {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    return true;
+}
+
+export function ModelParametersInnerFromJSON(json: any): ModelParametersInner {
+    return ModelParametersInnerFromJSONTyped(json, false);
+}
+
+export function ModelParametersInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): ModelParametersInner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'type': json['type'],
+        '_enum': json['enum'] == null ? undefined : json['enum'],
+        'min': json['min'] == null ? undefined : json['min'],
+        'max': json['max'] == null ? undefined : json['max'],
+        '_default': json['default'] === undefined ? undefined : json['default'] === null ? null : json['default'],
+    };
+}
+
+export function ModelParametersInnerToJSON(json: any): ModelParametersInner {
+    return ModelParametersInnerToJSONTyped(json, false);
+}
+
+export function ModelParametersInnerToJSONTyped(value?: ModelParametersInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'type': value['type'],
+        'enum': value['_enum'],
+        'min': value['min'],
+        'max': value['max'],
+        'default': value['_default'],
+    };
+}
+

package/src/models/ModelPricing.ts

@@ -0,0 +1,203 @@
+/* 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 { ModelRate } from './ModelRate';
+import {
+    ModelRateFromJSON,
+    ModelRateFromJSONTyped,
+    ModelRateToJSON,
+    ModelRateToJSONTyped,
+} from './ModelRate';
+import type { PeakWindow } from './PeakWindow';
+import {
+    PeakWindowFromJSON,
+    PeakWindowFromJSONTyped,
+    PeakWindowToJSON,
+    PeakWindowToJSONTyped,
+} from './PeakWindow';
+
+/**
+ * 
+ * @export
+ * @interface ModelPricing
+ */
+export interface ModelPricing {
+    /**
+     * 
+     * @type {string}
+     * @memberof ModelPricing
+     */
+    currency?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof ModelPricing
+     */
+    inputPer1mTokensCents?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ModelPricing
+     */
+    outputPer1mTokensCents?: number;
+    /**
+     * Exact per-1M-token rate in micro-cents (1e-6 cent) for the cache-HIT part of a chat prompt (usage.prompt_tokens_details.cached_tokens). Present only on models with a published cached-input rate; absent means no discount — every prompt token bills at input_per_1m_tokens_cents. Treat this field as the presence signal: cached rates are routinely sub-cent, so the rounded cents field below is often omitted.
+     * @type {number}
+     * @memberof ModelPricing
+     */
+    cachedInputPer1mTokensMicrocents?: number;
+    /**
+     * cached_input_per_1m_tokens_microcents rounded to whole cents; omitted when the exact rate rounds below half a cent.
+     * @type {number}
+     * @memberof ModelPricing
+     */
+    cachedInputPer1mTokensCents?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ModelPricing
+     */
+    perImageCents?: number;
+    /**
+     * Exact per-image rate in micro-cents (1e-6 cent). Prefer this for image models — per_image_cents rounds sub-cent prices to 0.
+     * @type {number}
+     * @memberof ModelPricing
+     */
+    perImageMicrocents?: number;
+    /**
+     * Price per output megapixel in micro-cents (1e-6 cent) for image models metered per megapixel. Mutually exclusive with the per-image fields.
+     * @type {number}
+     * @memberof ModelPricing
+     */
+    perMpxlMicrocents?: number;
+    /**
+     * Representative per-clip price in micro-cents (1e-6 cent) for video models — a "from" price taken from the provider's published example rate.
+     * @type {number}
+     * @memberof ModelPricing
+     */
+    perVideoMicrocents?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ModelPricing
+     */
+    perVideoSecondCents?: number;
+    /**
+     * Exact per-second-of-output-video rate in micro-cents (1e-6 cent). Prefer this for video models.
+     * @type {number}
+     * @memberof ModelPricing
+     */
+    perVideoSecondMicrocents?: number;
+    /**
+     * Present only on a model priced by time of day. Which side of the peak schedule the instant this response was rendered falls on; the flat rate fields above are the rates in effect at that instant. A request is billed at the rate in effect when it ARRIVES (UTC), so a caller planning a call for later should price it from `peak` / `off_peak` and `peak_windows_utc`.
+     * @type {ModelPricingPeriodEnum}
+     * @memberof ModelPricing
+     */
+    period?: ModelPricingPeriodEnum;
+    /**
+     * The daily UTC ranges during which the `peak` rates apply, start inclusive and end exclusive ("24:00" is a valid end; a range whose end sorts before its start wraps midnight). Present only on a model priced by time of day.
+     * @type {Array<PeakWindow>}
+     * @memberof ModelPricing
+     */
+    peakWindowsUtc?: Array<PeakWindow>;
+    /**
+     * 
+     * @type {ModelRate}
+     * @memberof ModelPricing
+     */
+    peak?: ModelRate;
+    /**
+     * 
+     * @type {ModelRate}
+     * @memberof ModelPricing
+     */
+    offPeak?: ModelRate;
+}
+
+
+/**
+ * @export
+ */
+export const ModelPricingPeriodEnum = {
+    Peak: 'peak',
+    OffPeak: 'off_peak'
+} as const;
+export type ModelPricingPeriodEnum = typeof ModelPricingPeriodEnum[keyof typeof ModelPricingPeriodEnum];
+
+
+/**
+ * Check if a given object implements the ModelPricing interface.
+ */
+export function instanceOfModelPricing(value: object): value is ModelPricing {
+    return true;
+}
+
+export function ModelPricingFromJSON(json: any): ModelPricing {
+    return ModelPricingFromJSONTyped(json, false);
+}
+
+export function ModelPricingFromJSONTyped(json: any, ignoreDiscriminator: boolean): ModelPricing {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'currency': json['currency'] == null ? undefined : json['currency'],
+        'inputPer1mTokensCents': json['input_per_1m_tokens_cents'] == null ? undefined : json['input_per_1m_tokens_cents'],
+        'outputPer1mTokensCents': json['output_per_1m_tokens_cents'] == null ? undefined : json['output_per_1m_tokens_cents'],
+        'cachedInputPer1mTokensMicrocents': json['cached_input_per_1m_tokens_microcents'] == null ? undefined : json['cached_input_per_1m_tokens_microcents'],
+        'cachedInputPer1mTokensCents': json['cached_input_per_1m_tokens_cents'] == null ? undefined : json['cached_input_per_1m_tokens_cents'],
+        'perImageCents': json['per_image_cents'] == null ? undefined : json['per_image_cents'],
+        'perImageMicrocents': json['per_image_microcents'] == null ? undefined : json['per_image_microcents'],
+        'perMpxlMicrocents': json['per_mpxl_microcents'] == null ? undefined : json['per_mpxl_microcents'],
+        'perVideoMicrocents': json['per_video_microcents'] == null ? undefined : json['per_video_microcents'],
+        'perVideoSecondCents': json['per_video_second_cents'] == null ? undefined : json['per_video_second_cents'],
+        'perVideoSecondMicrocents': json['per_video_second_microcents'] == null ? undefined : json['per_video_second_microcents'],
+        'period': json['period'] == null ? undefined : json['period'],
+        'peakWindowsUtc': json['peak_windows_utc'] == null ? undefined : ((json['peak_windows_utc'] as Array<any>).map(PeakWindowFromJSON)),
+        'peak': json['peak'] == null ? undefined : ModelRateFromJSON(json['peak']),
+        'offPeak': json['off_peak'] == null ? undefined : ModelRateFromJSON(json['off_peak']),
+    };
+}
+
+export function ModelPricingToJSON(json: any): ModelPricing {
+    return ModelPricingToJSONTyped(json, false);
+}
+
+export function ModelPricingToJSONTyped(value?: ModelPricing | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'currency': value['currency'],
+        'input_per_1m_tokens_cents': value['inputPer1mTokensCents'],
+        'output_per_1m_tokens_cents': value['outputPer1mTokensCents'],
+        'cached_input_per_1m_tokens_microcents': value['cachedInputPer1mTokensMicrocents'],
+        'cached_input_per_1m_tokens_cents': value['cachedInputPer1mTokensCents'],
+        'per_image_cents': value['perImageCents'],
+        'per_image_microcents': value['perImageMicrocents'],
+        'per_mpxl_microcents': value['perMpxlMicrocents'],
+        'per_video_microcents': value['perVideoMicrocents'],
+        'per_video_second_cents': value['perVideoSecondCents'],
+        'per_video_second_microcents': value['perVideoSecondMicrocents'],
+        'period': value['period'],
+        'peak_windows_utc': value['peakWindowsUtc'] == null ? undefined : ((value['peakWindowsUtc'] as Array<any>).map(PeakWindowToJSON)),
+        'peak': ModelRateToJSON(value['peak']),
+        'off_peak': ModelRateToJSON(value['offPeak']),
+    };
+}
+