@deeprelay/sdk 0.2.0 → 0.3.0

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

@@ -0,0 +1,45 @@
+/**
+ * deeprelay Public Developer API
+ * Programmatic API for deeprelay. Authenticate with API keys minted from the dashboard. See https://deeprelay.ai/docs for details.  Keys minted from the dashboard or `deeprelay login` belong to the Production server, https://api.deeprelay.ai/v1. The Demo server is an internal staging environment with its own key store.  Versioning: `/v1` is the API version. `info.version` is the revision of this `/v1` document, not a separate API.  OpenAI compatibility: chat completions follow the OpenAI request and response shapes, but not every OpenAI parameter is carried. Some are rejected with 400 `unsupported_parameter` and any parameter not declared in this spec is accepted and ignored. The full table is at https://deeprelay.ai/docs/api/inference#openai-compatibility.
+ *
+ * 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 { RequestLogEntry } from './RequestLogEntry';
+/**
+ *
+ * @export
+ * @interface RequestLogPage
+ */
+export interface RequestLogPage {
+    /**
+     *
+     * @type {Array<RequestLogEntry>}
+     * @memberof RequestLogPage
+     */
+    data: Array<RequestLogEntry>;
+    /**
+     * Opaque cursor for the next page, or null when there are no more rows.
+     * @type {string}
+     * @memberof RequestLogPage
+     */
+    nextCursor: string | null;
+    /**
+     * How many days back the request log reaches (90).
+     * @type {number}
+     * @memberof RequestLogPage
+     */
+    windowDays: number;
+}
+/**
+ * Check if a given object implements the RequestLogPage interface.
+ */
+export declare function instanceOfRequestLogPage(value: object): value is RequestLogPage;
+export declare function RequestLogPageFromJSON(json: any): RequestLogPage;
+export declare function RequestLogPageFromJSONTyped(json: any, ignoreDiscriminator: boolean): RequestLogPage;
+export declare function RequestLogPageToJSON(json: any): RequestLogPage;
+export declare function RequestLogPageToJSONTyped(value?: RequestLogPage | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/RequestLogPage.js

@@ -0,0 +1,52 @@
+/* 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.  Keys minted from the dashboard or `deeprelay login` belong to the Production server, https://api.deeprelay.ai/v1. The Demo server is an internal staging environment with its own key store.  Versioning: `/v1` is the API version. `info.version` is the revision of this `/v1` document, not a separate API.  OpenAI compatibility: chat completions follow the OpenAI request and response shapes, but not every OpenAI parameter is carried. Some are rejected with 400 `unsupported_parameter` and any parameter not declared in this spec is accepted and ignored. The full table is at https://deeprelay.ai/docs/api/inference#openai-compatibility.
+ *
+ * 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 { RequestLogEntryFromJSON, RequestLogEntryToJSON, } from './RequestLogEntry';
+/**
+ * Check if a given object implements the RequestLogPage interface.
+ */
+export function instanceOfRequestLogPage(value) {
+    if (!('data' in value) || value['data'] === undefined)
+        return false;
+    if ((!('nextCursor' in value) && !('next_cursor' in value)) || (value['nextCursor'] === undefined && value['next_cursor'] === undefined))
+        return false;
+    if ((!('windowDays' in value) && !('window_days' in value)) || (value['windowDays'] === undefined && value['window_days'] === undefined))
+        return false;
+    return true;
+}
+export function RequestLogPageFromJSON(json) {
+    return RequestLogPageFromJSONTyped(json, false);
+}
+export function RequestLogPageFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'data': (json['data'].map(RequestLogEntryFromJSON)),
+        'nextCursor': json['next_cursor'],
+        'windowDays': json['window_days'],
+    };
+}
+export function RequestLogPageToJSON(json) {
+    return RequestLogPageToJSONTyped(json, false);
+}
+export function RequestLogPageToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'data': (value['data'].map(RequestLogEntryToJSON)),
+        'next_cursor': value['nextCursor'],
+        'window_days': value['windowDays'],
+    };
+}

package/dist/esm/models/ResponseFormatJSONObject.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.  Keys minted from the dashboard or `deeprelay login` belong to the Production server, https://api.deeprelay.ai/v1. The Demo server is an internal staging environment with its own key store.  Versioning: `/v1` is the API version. `info.version` is the revision of this `/v1` document, not a separate API.  OpenAI compatibility: chat completions follow the OpenAI request and response shapes, but not every OpenAI parameter is carried. Some are rejected with 400 `unsupported_parameter` and any parameter not declared in this spec is accepted and ignored. The full table is at https://deeprelay.ai/docs/api/inference#openai-compatibility.
+ *
+ * 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 reply is a single valid JSON object.
+ * @export
+ * @interface ResponseFormatJSONObject
+ */
+export interface ResponseFormatJSONObject {
+    /**
+     *
+     * @type {ResponseFormatJSONObjectTypeEnum}
+     * @memberof ResponseFormatJSONObject
+     */
+    type: ResponseFormatJSONObjectTypeEnum;
+}
+/**
+ * @export
+ */
+export declare const ResponseFormatJSONObjectTypeEnum: {
+    readonly JsonObject: "json_object";
+};
+export type ResponseFormatJSONObjectTypeEnum = typeof ResponseFormatJSONObjectTypeEnum[keyof typeof ResponseFormatJSONObjectTypeEnum];
+/**
+ * Check if a given object implements the ResponseFormatJSONObject interface.
+ */
+export declare function instanceOfResponseFormatJSONObject(value: object): value is ResponseFormatJSONObject;
+export declare function ResponseFormatJSONObjectFromJSON(json: any): ResponseFormatJSONObject;
+export declare function ResponseFormatJSONObjectFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResponseFormatJSONObject;
+export declare function ResponseFormatJSONObjectToJSON(json: any): ResponseFormatJSONObject;
+export declare function ResponseFormatJSONObjectToJSONTyped(value?: ResponseFormatJSONObject | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ResponseFormatJSONObject.js

@@ -0,0 +1,51 @@
+/* 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.  Keys minted from the dashboard or `deeprelay login` belong to the Production server, https://api.deeprelay.ai/v1. The Demo server is an internal staging environment with its own key store.  Versioning: `/v1` is the API version. `info.version` is the revision of this `/v1` document, not a separate API.  OpenAI compatibility: chat completions follow the OpenAI request and response shapes, but not every OpenAI parameter is carried. Some are rejected with 400 `unsupported_parameter` and any parameter not declared in this spec is accepted and ignored. The full table is at https://deeprelay.ai/docs/api/inference#openai-compatibility.
+ *
+ * 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 ResponseFormatJSONObjectTypeEnum = {
+    JsonObject: 'json_object'
+};
+/**
+ * Check if a given object implements the ResponseFormatJSONObject interface.
+ */
+export function instanceOfResponseFormatJSONObject(value) {
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (value['type'] !== 'json_object')
+        return false;
+    return true;
+}
+export function ResponseFormatJSONObjectFromJSON(json) {
+    return ResponseFormatJSONObjectFromJSONTyped(json, false);
+}
+export function ResponseFormatJSONObjectFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'type': json['type'],
+    };
+}
+export function ResponseFormatJSONObjectToJSON(json) {
+    return ResponseFormatJSONObjectToJSONTyped(json, false);
+}
+export function ResponseFormatJSONObjectToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'type': value['type'],
+    };
+}

package/dist/esm/models/ResponseFormatJSONSchema.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.  Keys minted from the dashboard or `deeprelay login` belong to the Production server, https://api.deeprelay.ai/v1. The Demo server is an internal staging environment with its own key store.  Versioning: `/v1` is the API version. `info.version` is the revision of this `/v1` document, not a separate API.  OpenAI compatibility: chat completions follow the OpenAI request and response shapes, but not every OpenAI parameter is carried. Some are rejected with 400 `unsupported_parameter` and any parameter not declared in this spec is accepted and ignored. The full table is at https://deeprelay.ai/docs/api/inference#openai-compatibility.
+ *
+ * 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 { JSONSchemaFormat } from './JSONSchemaFormat';
+/**
+ *
+ * @export
+ * @interface ResponseFormatJSONSchema
+ */
+export interface ResponseFormatJSONSchema {
+    /**
+     *
+     * @type {ResponseFormatJSONSchemaTypeEnum}
+     * @memberof ResponseFormatJSONSchema
+     */
+    type: ResponseFormatJSONSchemaTypeEnum;
+    /**
+     *
+     * @type {JSONSchemaFormat}
+     * @memberof ResponseFormatJSONSchema
+     */
+    jsonSchema: JSONSchemaFormat;
+}
+/**
+ * @export
+ */
+export declare const ResponseFormatJSONSchemaTypeEnum: {
+    readonly JsonSchema: "json_schema";
+};
+export type ResponseFormatJSONSchemaTypeEnum = typeof ResponseFormatJSONSchemaTypeEnum[keyof typeof ResponseFormatJSONSchemaTypeEnum];
+/**
+ * Check if a given object implements the ResponseFormatJSONSchema interface.
+ */
+export declare function instanceOfResponseFormatJSONSchema(value: object): value is ResponseFormatJSONSchema;
+export declare function ResponseFormatJSONSchemaFromJSON(json: any): ResponseFormatJSONSchema;
+export declare function ResponseFormatJSONSchemaFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResponseFormatJSONSchema;
+export declare function ResponseFormatJSONSchemaToJSON(json: any): ResponseFormatJSONSchema;
+export declare function ResponseFormatJSONSchemaToJSONTyped(value?: ResponseFormatJSONSchema | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ResponseFormatJSONSchema.js

@@ -0,0 +1,56 @@
+/* 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.  Keys minted from the dashboard or `deeprelay login` belong to the Production server, https://api.deeprelay.ai/v1. The Demo server is an internal staging environment with its own key store.  Versioning: `/v1` is the API version. `info.version` is the revision of this `/v1` document, not a separate API.  OpenAI compatibility: chat completions follow the OpenAI request and response shapes, but not every OpenAI parameter is carried. Some are rejected with 400 `unsupported_parameter` and any parameter not declared in this spec is accepted and ignored. The full table is at https://deeprelay.ai/docs/api/inference#openai-compatibility.
+ *
+ * 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 { JSONSchemaFormatFromJSON, JSONSchemaFormatToJSON, } from './JSONSchemaFormat';
+/**
+ * @export
+ */
+export const ResponseFormatJSONSchemaTypeEnum = {
+    JsonSchema: 'json_schema'
+};
+/**
+ * Check if a given object implements the ResponseFormatJSONSchema interface.
+ */
+export function instanceOfResponseFormatJSONSchema(value) {
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (value['type'] !== 'json_schema')
+        return false;
+    if ((!('jsonSchema' in value) && !('json_schema' in value)) || (value['jsonSchema'] === undefined && value['json_schema'] === undefined))
+        return false;
+    return true;
+}
+export function ResponseFormatJSONSchemaFromJSON(json) {
+    return ResponseFormatJSONSchemaFromJSONTyped(json, false);
+}
+export function ResponseFormatJSONSchemaFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'type': json['type'],
+        'jsonSchema': JSONSchemaFormatFromJSON(json['json_schema']),
+    };
+}
+export function ResponseFormatJSONSchemaToJSON(json) {
+    return ResponseFormatJSONSchemaToJSONTyped(json, false);
+}
+export function ResponseFormatJSONSchemaToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'type': value['type'],
+        'json_schema': JSONSchemaFormatToJSON(value['jsonSchema']),
+    };
+}

package/dist/esm/models/ResponseFormatText.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.  Keys minted from the dashboard or `deeprelay login` belong to the Production server, https://api.deeprelay.ai/v1. The Demo server is an internal staging environment with its own key store.  Versioning: `/v1` is the API version. `info.version` is the revision of this `/v1` document, not a separate API.  OpenAI compatibility: chat completions follow the OpenAI request and response shapes, but not every OpenAI parameter is carried. Some are rejected with 400 `unsupported_parameter` and any parameter not declared in this spec is accepted and ignored. The full table is at https://deeprelay.ai/docs/api/inference#openai-compatibility.
+ *
+ * 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 ResponseFormatText
+ */
+export interface ResponseFormatText {
+    /**
+     *
+     * @type {ResponseFormatTextTypeEnum}
+     * @memberof ResponseFormatText
+     */
+    type: ResponseFormatTextTypeEnum;
+}
+/**
+ * @export
+ */
+export declare const ResponseFormatTextTypeEnum: {
+    readonly Text: "text";
+};
+export type ResponseFormatTextTypeEnum = typeof ResponseFormatTextTypeEnum[keyof typeof ResponseFormatTextTypeEnum];
+/**
+ * Check if a given object implements the ResponseFormatText interface.
+ */
+export declare function instanceOfResponseFormatText(value: object): value is ResponseFormatText;
+export declare function ResponseFormatTextFromJSON(json: any): ResponseFormatText;
+export declare function ResponseFormatTextFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResponseFormatText;
+export declare function ResponseFormatTextToJSON(json: any): ResponseFormatText;
+export declare function ResponseFormatTextToJSONTyped(value?: ResponseFormatText | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ResponseFormatText.js

@@ -0,0 +1,51 @@
+/* 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.  Keys minted from the dashboard or `deeprelay login` belong to the Production server, https://api.deeprelay.ai/v1. The Demo server is an internal staging environment with its own key store.  Versioning: `/v1` is the API version. `info.version` is the revision of this `/v1` document, not a separate API.  OpenAI compatibility: chat completions follow the OpenAI request and response shapes, but not every OpenAI parameter is carried. Some are rejected with 400 `unsupported_parameter` and any parameter not declared in this spec is accepted and ignored. The full table is at https://deeprelay.ai/docs/api/inference#openai-compatibility.
+ *
+ * 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 ResponseFormatTextTypeEnum = {
+    Text: 'text'
+};
+/**
+ * Check if a given object implements the ResponseFormatText interface.
+ */
+export function instanceOfResponseFormatText(value) {
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (value['type'] !== 'text')
+        return false;
+    return true;
+}
+export function ResponseFormatTextFromJSON(json) {
+    return ResponseFormatTextFromJSONTyped(json, false);
+}
+export function ResponseFormatTextFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'type': json['type'],
+    };
+}
+export function ResponseFormatTextToJSON(json) {
+    return ResponseFormatTextToJSONTyped(json, false);
+}
+export function ResponseFormatTextToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'type': value['type'],
+    };
+}

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

@@ -1,6 +1,6 @@
 /**
  * deeprelay Public Developer API
- * Programmatic API for deeprelay. Authenticate with API keys minted from the dashboard. See https://deeprelay.ai/docs for details.
+ * Programmatic API for deeprelay. Authenticate with API keys minted from the dashboard. See https://deeprelay.ai/docs for details.  Keys minted from the dashboard or `deeprelay login` belong to the Production server, https://api.deeprelay.ai/v1. The Demo server is an internal staging environment with its own key store.  Versioning: `/v1` is the API version. `info.version` is the revision of this `/v1` document, not a separate API.  OpenAI compatibility: chat completions follow the OpenAI request and response shapes, but not every OpenAI parameter is carried. Some are rejected with 400 `unsupported_parameter` and any parameter not declared in this spec is accepted and ignored. The full table is at https://deeprelay.ai/docs/api/inference#openai-compatibility.
  *
  * The version of the OpenAPI document: 1.0.0
  * Contact: support@deeprelay.ai

package/dist/esm/models/SpendingLimit.js

@@ -2,7 +2,7 @@
 /* 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.
+ * Programmatic API for deeprelay. Authenticate with API keys minted from the dashboard. See https://deeprelay.ai/docs for details.  Keys minted from the dashboard or `deeprelay login` belong to the Production server, https://api.deeprelay.ai/v1. The Demo server is an internal staging environment with its own key store.  Versioning: `/v1` is the API version. `info.version` is the revision of this `/v1` document, not a separate API.  OpenAI compatibility: chat completions follow the OpenAI request and response shapes, but not every OpenAI parameter is carried. Some are rejected with 400 `unsupported_parameter` and any parameter not declared in this spec is accepted and ignored. The full table is at https://deeprelay.ai/docs/api/inference#openai-compatibility.
  *
  * The version of the OpenAPI document: 1.0.0
  * Contact: support@deeprelay.ai

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

@@ -1,6 +1,6 @@
 /**
  * deeprelay Public Developer API
- * Programmatic API for deeprelay. Authenticate with API keys minted from the dashboard. See https://deeprelay.ai/docs for details.
+ * Programmatic API for deeprelay. Authenticate with API keys minted from the dashboard. See https://deeprelay.ai/docs for details.  Keys minted from the dashboard or `deeprelay login` belong to the Production server, https://api.deeprelay.ai/v1. The Demo server is an internal staging environment with its own key store.  Versioning: `/v1` is the API version. `info.version` is the revision of this `/v1` document, not a separate API.  OpenAI compatibility: chat completions follow the OpenAI request and response shapes, but not every OpenAI parameter is carried. Some are rejected with 400 `unsupported_parameter` and any parameter not declared in this spec is accepted and ignored. The full table is at https://deeprelay.ai/docs/api/inference#openai-compatibility.
  *
  * The version of the OpenAPI document: 1.0.0
  * Contact: support@deeprelay.ai

package/dist/esm/models/StreamOptions.js

@@ -2,7 +2,7 @@
 /* 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.
+ * Programmatic API for deeprelay. Authenticate with API keys minted from the dashboard. See https://deeprelay.ai/docs for details.  Keys minted from the dashboard or `deeprelay login` belong to the Production server, https://api.deeprelay.ai/v1. The Demo server is an internal staging environment with its own key store.  Versioning: `/v1` is the API version. `info.version` is the revision of this `/v1` document, not a separate API.  OpenAI compatibility: chat completions follow the OpenAI request and response shapes, but not every OpenAI parameter is carried. Some are rejected with 400 `unsupported_parameter` and any parameter not declared in this spec is accepted and ignored. The full table is at https://deeprelay.ai/docs/api/inference#openai-compatibility.
  *
  * The version of the OpenAPI document: 1.0.0
  * Contact: support@deeprelay.ai

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

@@ -1,6 +1,6 @@
 /**
  * deeprelay Public Developer API
- * Programmatic API for deeprelay. Authenticate with API keys minted from the dashboard. See https://deeprelay.ai/docs for details.
+ * Programmatic API for deeprelay. Authenticate with API keys minted from the dashboard. See https://deeprelay.ai/docs for details.  Keys minted from the dashboard or `deeprelay login` belong to the Production server, https://api.deeprelay.ai/v1. The Demo server is an internal staging environment with its own key store.  Versioning: `/v1` is the API version. `info.version` is the revision of this `/v1` document, not a separate API.  OpenAI compatibility: chat completions follow the OpenAI request and response shapes, but not every OpenAI parameter is carried. Some are rejected with 400 `unsupported_parameter` and any parameter not declared in this spec is accepted and ignored. The full table is at https://deeprelay.ai/docs/api/inference#openai-compatibility.
  *
  * The version of the OpenAPI document: 1.0.0
  * Contact: support@deeprelay.ai
@@ -10,10 +10,11 @@
  * Do not edit the class manually.
  */
 import type { SubscriptionPlan } from './SubscriptionPlan';
+import type { SubscriptionTier } from './SubscriptionTier';
 import type { SubscriptionUsage } from './SubscriptionUsage';
 import type { SubscriptionQuota } from './SubscriptionQuota';
 /**
- * The organization's flat subscription tier: entitlement, billing period, the configured quota, and consumption against it. The console and this endpoint assemble it from the same source, so the two surfaces cannot report different numbers.
+ * The organization's subscription: entitlement, billing period, the plan it is on with that plan's configured quota, consumption against it, and the plans this deployment offers. The console and this endpoint assemble it from the same source, so the two surfaces cannot report different numbers.
  *
  * @export
  * @interface Subscription
@@ -67,6 +68,12 @@ export interface Subscription {
      * @memberof Subscription
      */
     usage?: SubscriptionUsage;
+    /**
+     * Every plan this deployment offers, smallest first (Base, then Plus when it is configured), each with its price and quota. The keys are the accepted `plan_key` values for checkout and upgrade. Empty when nothing can be bought here.
+     * @type {Array<SubscriptionTier>}
+     * @memberof Subscription
+     */
+    plans: Array<SubscriptionTier>;
 }
 /**
  * Check if a given object implements the Subscription interface.

package/dist/esm/models/Subscription.js

@@ -2,7 +2,7 @@
 /* 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.
+ * Programmatic API for deeprelay. Authenticate with API keys minted from the dashboard. See https://deeprelay.ai/docs for details.  Keys minted from the dashboard or `deeprelay login` belong to the Production server, https://api.deeprelay.ai/v1. The Demo server is an internal staging environment with its own key store.  Versioning: `/v1` is the API version. `info.version` is the revision of this `/v1` document, not a separate API.  OpenAI compatibility: chat completions follow the OpenAI request and response shapes, but not every OpenAI parameter is carried. Some are rejected with 400 `unsupported_parameter` and any parameter not declared in this spec is accepted and ignored. The full table is at https://deeprelay.ai/docs/api/inference#openai-compatibility.
  *
  * The version of the OpenAPI document: 1.0.0
  * Contact: support@deeprelay.ai
@@ -12,6 +12,7 @@
  * Do not edit the class manually.
  */
 import { SubscriptionPlanFromJSON, SubscriptionPlanToJSON, } from './SubscriptionPlan';
+import { SubscriptionTierFromJSON, SubscriptionTierToJSON, } from './SubscriptionTier';
 import { SubscriptionUsageFromJSON, SubscriptionUsageToJSON, } from './SubscriptionUsage';
 import { SubscriptionQuotaFromJSON, SubscriptionQuotaToJSON, } from './SubscriptionQuota';
 /**
@@ -28,6 +29,8 @@ export function instanceOfSubscription(value) {
         return false;
     if (!('quota' in value) || value['quota'] === undefined)
         return false;
+    if (!('plans' in value) || value['plans'] === undefined)
+        return false;
     return true;
 }
 export function SubscriptionFromJSON(json) {
@@ -46,6 +49,7 @@ export function SubscriptionFromJSONTyped(json, ignoreDiscriminator) {
         'plan': SubscriptionPlanFromJSON(json['plan']),
         'quota': SubscriptionQuotaFromJSON(json['quota']),
         'usage': json['usage'] == null ? undefined : SubscriptionUsageFromJSON(json['usage']),
+        'plans': (json['plans'].map(SubscriptionTierFromJSON)),
     };
 }
 export function SubscriptionToJSON(json) {
@@ -64,5 +68,6 @@ export function SubscriptionToJSONTyped(value, ignoreDiscriminator = false) {
         'plan': SubscriptionPlanToJSON(value['plan']),
         'quota': SubscriptionQuotaToJSON(value['quota']),
         'usage': SubscriptionUsageToJSON(value['usage']),
+        'plans': (value['plans'].map(SubscriptionTierToJSON)),
     };
 }

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

@@ -1,6 +1,6 @@
 /**
  * deeprelay Public Developer API
- * Programmatic API for deeprelay. Authenticate with API keys minted from the dashboard. See https://deeprelay.ai/docs for details.
+ * Programmatic API for deeprelay. Authenticate with API keys minted from the dashboard. See https://deeprelay.ai/docs for details.  Keys minted from the dashboard or `deeprelay login` belong to the Production server, https://api.deeprelay.ai/v1. The Demo server is an internal staging environment with its own key store.  Versioning: `/v1` is the API version. `info.version` is the revision of this `/v1` document, not a separate API.  OpenAI compatibility: chat completions follow the OpenAI request and response shapes, but not every OpenAI parameter is carried. Some are rejected with 400 `unsupported_parameter` and any parameter not declared in this spec is accepted and ignored. The full table is at https://deeprelay.ai/docs/api/inference#openai-compatibility.
  *
  * The version of the OpenAPI document: 1.0.0
  * Contact: support@deeprelay.ai
@@ -17,24 +17,38 @@
  */
 export interface SubscriptionCheckoutRequest {
     /**
-     * Where the provider returns after a completed payment. Defaults to the deployment's configured URL.
+     * Where the provider returns after a completed payment. Defaults to the deployment's configured URL. Must be on the deployment's dashboard origin, else 422 `validation_failed`.
      * @type {string}
      * @memberof SubscriptionCheckoutRequest
      */
     successUrl?: string;
     /**
-     * Where the provider returns if checkout is abandoned. Defaults to the deployment's configured URL.
+     * Where the provider returns if checkout is abandoned. Defaults to the deployment's configured URL. Must be on the deployment's dashboard origin, else 422 `validation_failed`.
      * @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.
+     * The plan to buy — `flat` (Base, the default) or `plus`. Pins the plan the client displayed: an unknown or un-offered key is a 400 rather than a silent purchase of a different tier.
      * @type {string}
      * @memberof SubscriptionCheckoutRequest
      */
     planKey?: string;
+    /**
+     * `card` (dollars, card or Link; the default) or `upi` (rupees, UPI AutoPay). On a subscribed organization, the other currency's method switches the existing plan's billing.
+     * @type {SubscriptionCheckoutRequestMethodEnum}
+     * @memberof SubscriptionCheckoutRequest
+     */
+    method?: SubscriptionCheckoutRequestMethodEnum;
 }
+/**
+ * @export
+ */
+export declare const SubscriptionCheckoutRequestMethodEnum: {
+    readonly Card: "card";
+    readonly Upi: "upi";
+};
+export type SubscriptionCheckoutRequestMethodEnum = typeof SubscriptionCheckoutRequestMethodEnum[keyof typeof SubscriptionCheckoutRequestMethodEnum];
 /**
  * Check if a given object implements the SubscriptionCheckoutRequest interface.
  */

package/dist/esm/models/SubscriptionCheckoutRequest.js

@@ -2,7 +2,7 @@
 /* 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.
+ * Programmatic API for deeprelay. Authenticate with API keys minted from the dashboard. See https://deeprelay.ai/docs for details.  Keys minted from the dashboard or `deeprelay login` belong to the Production server, https://api.deeprelay.ai/v1. The Demo server is an internal staging environment with its own key store.  Versioning: `/v1` is the API version. `info.version` is the revision of this `/v1` document, not a separate API.  OpenAI compatibility: chat completions follow the OpenAI request and response shapes, but not every OpenAI parameter is carried. Some are rejected with 400 `unsupported_parameter` and any parameter not declared in this spec is accepted and ignored. The full table is at https://deeprelay.ai/docs/api/inference#openai-compatibility.
  *
  * The version of the OpenAPI document: 1.0.0
  * Contact: support@deeprelay.ai
@@ -11,6 +11,13 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+/**
+ * @export
+ */
+export const SubscriptionCheckoutRequestMethodEnum = {
+    Card: 'card',
+    Upi: 'upi'
+};
 /**
  * Check if a given object implements the SubscriptionCheckoutRequest interface.
  */
@@ -28,6 +35,7 @@ export function SubscriptionCheckoutRequestFromJSONTyped(json, ignoreDiscriminat
         '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'],
+        'method': json['method'] == null ? undefined : json['method'],
     };
 }
 export function SubscriptionCheckoutRequestToJSON(json) {
@@ -41,5 +49,6 @@ export function SubscriptionCheckoutRequestToJSONTyped(value, ignoreDiscriminato
         'success_url': value['successUrl'],
         'cancel_url': value['cancelUrl'],
         'plan_key': value['planKey'],
+        'method': value['method'],
     };
 }

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

@@ -1,6 +1,6 @@
 /**
  * deeprelay Public Developer API
- * Programmatic API for deeprelay. Authenticate with API keys minted from the dashboard. See https://deeprelay.ai/docs for details.
+ * Programmatic API for deeprelay. Authenticate with API keys minted from the dashboard. See https://deeprelay.ai/docs for details.  Keys minted from the dashboard or `deeprelay login` belong to the Production server, https://api.deeprelay.ai/v1. The Demo server is an internal staging environment with its own key store.  Versioning: `/v1` is the API version. `info.version` is the revision of this `/v1` document, not a separate API.  OpenAI compatibility: chat completions follow the OpenAI request and response shapes, but not every OpenAI parameter is carried. Some are rejected with 400 `unsupported_parameter` and any parameter not declared in this spec is accepted and ignored. The full table is at https://deeprelay.ai/docs/api/inference#openai-compatibility.
  *
  * The version of the OpenAPI document: 1.0.0
  * Contact: support@deeprelay.ai
@@ -34,7 +34,27 @@ export interface SubscriptionCheckoutSession {
      * @memberof SubscriptionCheckoutSession
      */
     plan: SubscriptionPlan;
+    /**
+     * Set when the checkout switches an existing plan's billing currency.
+     * @type {SubscriptionCheckoutSessionSwitchToEnum}
+     * @memberof SubscriptionCheckoutSession
+     */
+    switchTo?: SubscriptionCheckoutSessionSwitchToEnum;
+    /**
+     * For a switch, when the new currency is first charged (the current renewal date).
+     * @type {Date}
+     * @memberof SubscriptionCheckoutSession
+     */
+    firstChargeAt?: Date;
 }
+/**
+ * @export
+ */
+export declare const SubscriptionCheckoutSessionSwitchToEnum: {
+    readonly Card: "card";
+    readonly Upi: "upi";
+};
+export type SubscriptionCheckoutSessionSwitchToEnum = typeof SubscriptionCheckoutSessionSwitchToEnum[keyof typeof SubscriptionCheckoutSessionSwitchToEnum];
 /**
  * Check if a given object implements the SubscriptionCheckoutSession interface.
  */