@deeprelay/sdk 0.2.0 → 0.3.0

package/src/apis/AlertsApi.ts

@@ -0,0 +1,145 @@
+/* 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 * as runtime from '../runtime';
+import {
+    type AlertSettings,
+    AlertSettingsFromJSON,
+    AlertSettingsToJSON,
+} from '../models/AlertSettings';
+import {
+    type AlertSettingsUpdate,
+    AlertSettingsUpdateFromJSON,
+    AlertSettingsUpdateToJSON,
+} from '../models/AlertSettingsUpdate';
+import {
+    type Problem,
+    ProblemFromJSON,
+    ProblemToJSON,
+} from '../models/Problem';
+
+export interface PutAlertSettingsRequest {
+    alertSettingsUpdate: AlertSettingsUpdate;
+}
+
+/**
+ * 
+ */
+export class AlertsApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for getAlertSettings without sending the request
+     */
+    async getAlertSettingsRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/alerts/settings`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Returns the low-balance threshold and the four org-level alert email toggles. An organization that has never saved settings gets the defaults with `updated_at: null`. Requires the `billing:read` scope. 
+     * Get the organization\'s alert settings
+     */
+    async getAlertSettingsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AlertSettings>> {
+        const requestOptions = await this.getAlertSettingsRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => AlertSettingsFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns the low-balance threshold and the four org-level alert email toggles. An organization that has never saved settings gets the defaults with `updated_at: null`. Requires the `billing:read` scope. 
+     * Get the organization\'s alert settings
+     */
+    async getAlertSettings(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AlertSettings> {
+        const response = await this.getAlertSettingsRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for putAlertSettings without sending the request
+     */
+    async putAlertSettingsRequestOpts(requestParameters: PutAlertSettingsRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['alertSettingsUpdate'] == null) {
+            throw new runtime.RequiredError(
+                'alertSettingsUpdate',
+                'Required parameter "alertSettingsUpdate" was null or undefined when calling putAlertSettings().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/alerts/settings`;
+
+        return {
+            path: urlPath,
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: AlertSettingsUpdateToJSON(requestParameters['alertSettingsUpdate']),
+        };
+    }
+
+    /**
+     * Replaces every setting at once: send `balance_threshold_cents` and all four `email` toggles (a missing field is 422 `validation_failed` naming the `field`). Requires the `billing:write` scope AND an org admin\'s key or a `full_access` key (403 `forbidden` otherwise). The toggles only control the org-level emails; a member always receives their own spend-limit emails. Webhook delivery of the same events is configured on the webhook endpoint, not here. 
+     * Replace the organization\'s alert settings
+     */
+    async putAlertSettingsRaw(requestParameters: PutAlertSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AlertSettings>> {
+        const requestOptions = await this.putAlertSettingsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => AlertSettingsFromJSON(jsonValue));
+    }
+
+    /**
+     * Replaces every setting at once: send `balance_threshold_cents` and all four `email` toggles (a missing field is 422 `validation_failed` naming the `field`). Requires the `billing:write` scope AND an org admin\'s key or a `full_access` key (403 `forbidden` otherwise). The toggles only control the org-level emails; a member always receives their own spend-limit emails. Webhook delivery of the same events is configured on the webhook endpoint, not here. 
+     * Replace the organization\'s alert settings
+     */
+    async putAlertSettings(requestParameters: PutAlertSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AlertSettings> {
+        const response = await this.putAlertSettingsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/ApiKeysApi.ts

@@ -0,0 +1,357 @@
+/* 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 * as runtime from '../runtime';
+import {
+    type ApiKey,
+    ApiKeyFromJSON,
+    ApiKeyToJSON,
+} from '../models/ApiKey';
+import {
+    type ApiKeyCreate,
+    ApiKeyCreateFromJSON,
+    ApiKeyCreateToJSON,
+} from '../models/ApiKeyCreate';
+import {
+    type ApiKeyCreated,
+    ApiKeyCreatedFromJSON,
+    ApiKeyCreatedToJSON,
+} from '../models/ApiKeyCreated';
+import {
+    type ApiKeyList,
+    ApiKeyListFromJSON,
+    ApiKeyListToJSON,
+} from '../models/ApiKeyList';
+import {
+    type ApiKeyUpdate,
+    ApiKeyUpdateFromJSON,
+    ApiKeyUpdateToJSON,
+} from '../models/ApiKeyUpdate';
+import {
+    type Problem,
+    ProblemFromJSON,
+    ProblemToJSON,
+} from '../models/Problem';
+
+export interface CreateApiKeyRequest {
+    apiKeyCreate: ApiKeyCreate;
+}
+
+export interface GetApiKeyRequest {
+    id: string;
+}
+
+export interface RevokeApiKeyRequest {
+    id: string;
+    idempotencyKey?: string;
+}
+
+export interface UpdateApiKeyRequest {
+    id: string;
+    apiKeyUpdate: ApiKeyUpdate;
+    idempotencyKey?: string;
+}
+
+/**
+ * 
+ */
+export class ApiKeysApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for createApiKey without sending the request
+     */
+    async createApiKeyRequestOpts(requestParameters: CreateApiKeyRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['apiKeyCreate'] == null) {
+            throw new runtime.RequiredError(
+                'apiKeyCreate',
+                'Required parameter "apiKeyCreate" was null or undefined when calling createApiKey().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api-keys`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ApiKeyCreateToJSON(requestParameters['apiKeyCreate']),
+        };
+    }
+
+    /**
+     * Mints a key. The response is the only place the secret (`key`) appears; store it then, because it cannot be read again.  Requires the `keys:manage` capability: a `full_access` key, or a key whose scopes grant `{\"keys\": \"write\"}`. Any other key gets 403 `keys_manage_required`. A key can never mint a key stronger than itself: scopes it does not hold answer 403 `scope_exceeds_caller`, and a minting key that has a budget, a model allowlist, a rate limit or an expiry passes each down as an upper bound (422 `validation_failed` naming the `field`). Only an org admin can mint a `full_access` key. 
+     * Create an API key
+     */
+    async createApiKeyRaw(requestParameters: CreateApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiKeyCreated>> {
+        const requestOptions = await this.createApiKeyRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ApiKeyCreatedFromJSON(jsonValue));
+    }
+
+    /**
+     * Mints a key. The response is the only place the secret (`key`) appears; store it then, because it cannot be read again.  Requires the `keys:manage` capability: a `full_access` key, or a key whose scopes grant `{\"keys\": \"write\"}`. Any other key gets 403 `keys_manage_required`. A key can never mint a key stronger than itself: scopes it does not hold answer 403 `scope_exceeds_caller`, and a minting key that has a budget, a model allowlist, a rate limit or an expiry passes each down as an upper bound (422 `validation_failed` naming the `field`). Only an org admin can mint a `full_access` key. 
+     * Create an API key
+     */
+    async createApiKey(requestParameters: CreateApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiKeyCreated> {
+        const response = await this.createApiKeyRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getApiKey without sending the request
+     */
+    async getApiKeyRequestOpts(requestParameters: GetApiKeyRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling getApiKey().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api-keys/{id}`;
+        urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Returns one key. A key the caller cannot see answers 404. Requires the `keys:read` scope. 
+     * Get an API key
+     */
+    async getApiKeyRaw(requestParameters: GetApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiKey>> {
+        const requestOptions = await this.getApiKeyRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ApiKeyFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns one key. A key the caller cannot see answers 404. Requires the `keys:read` scope. 
+     * Get an API key
+     */
+    async getApiKey(requestParameters: GetApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiKey> {
+        const response = await this.getApiKeyRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for listApiKeys without sending the request
+     */
+    async listApiKeysRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api-keys`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Lists the organization\'s API keys with their limits and current budget use. An org admin\'s key and a `full_access` key see every key in the organization; any other key sees only the keys its owner created. The secret is never returned here. Requires the `keys:read` scope. 
+     * List API keys
+     */
+    async listApiKeysRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiKeyList>> {
+        const requestOptions = await this.listApiKeysRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ApiKeyListFromJSON(jsonValue));
+    }
+
+    /**
+     * Lists the organization\'s API keys with their limits and current budget use. An org admin\'s key and a `full_access` key see every key in the organization; any other key sees only the keys its owner created. The secret is never returned here. Requires the `keys:read` scope. 
+     * List API keys
+     */
+    async listApiKeys(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiKeyList> {
+        const response = await this.listApiKeysRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for revokeApiKey without sending the request
+     */
+    async revokeApiKeyRequestOpts(requestParameters: RevokeApiKeyRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling revokeApiKey().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (requestParameters['idempotencyKey'] != null) {
+            headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api-keys/{id}`;
+        urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Revokes the key immediately; it cannot be restored. Requires the `keys:manage` capability (403 `keys_manage_required` otherwise); a member can only revoke keys they created. 
+     * Revoke an API key
+     */
+    async revokeApiKeyRaw(requestParameters: RevokeApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.revokeApiKeyRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Revokes the key immediately; it cannot be restored. Requires the `keys:manage` capability (403 `keys_manage_required` otherwise); a member can only revoke keys they created. 
+     * Revoke an API key
+     */
+    async revokeApiKey(requestParameters: RevokeApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.revokeApiKeyRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for updateApiKey without sending the request
+     */
+    async updateApiKeyRequestOpts(requestParameters: UpdateApiKeyRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling updateApiKey().'
+            );
+        }
+
+        if (requestParameters['apiKeyUpdate'] == null) {
+            throw new runtime.RequiredError(
+                'apiKeyUpdate',
+                'Required parameter "apiKeyUpdate" was null or undefined when calling updateApiKey().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (requestParameters['idempotencyKey'] != null) {
+            headerParameters['Idempotency-Key'] = String(requestParameters['idempotencyKey']);
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api-keys/{id}`;
+        urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ApiKeyUpdateToJSON(requestParameters['apiKeyUpdate']),
+        };
+    }
+
+    /**
+     * Changes a key\'s name, budget, model allowlist, rate limit or expiry. An absent field is left unchanged; an explicit `null` clears `budget_cents`, `allowed_models` or `expires_at`. `scopes` cannot be changed after minting, and unknown fields are refused (422), so a typo never looks like a successful change. Requires the `keys:manage` capability (403 `keys_manage_required` otherwise); a member can only change keys they created. 
+     * Update an API key\'s name or limits
+     */
+    async updateApiKeyRaw(requestParameters: UpdateApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApiKey>> {
+        const requestOptions = await this.updateApiKeyRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ApiKeyFromJSON(jsonValue));
+    }
+
+    /**
+     * Changes a key\'s name, budget, model allowlist, rate limit or expiry. An absent field is left unchanged; an explicit `null` clears `budget_cents`, `allowed_models` or `expires_at`. `scopes` cannot be changed after minting, and unknown fields are refused (422), so a typo never looks like a successful change. Requires the `keys:manage` capability (403 `keys_manage_required` otherwise); a member can only change keys they created. 
+     * Update an API key\'s name or limits
+     */
+    async updateApiKey(requestParameters: UpdateApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApiKey> {
+        const response = await this.updateApiKeyRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}