@deeprelay/sdk 0.2.1 → 0.3.0

package/docs/SubscriptionQuota.md

@@ -1,7 +1,7 @@
 
 # SubscriptionQuota
 
-The plan\'s configured allowances — the denominators of the usage meter. Always present, including for an organization that has not subscribed, where it describes what subscribing would provide.  Token figures are WEIGHTED tokens: every model carries a usage factor, so a model at factor 2 spends two of these per token it serves. 
+A plan\'s configured allowances — the denominators of the usage meter. On `/billing/subscription` it is the quota of the plan the organization is on; always present, including for an organization that has not subscribed, where it describes what the Base plan would provide. Each entry of `plans` carries its own.  Token figures are WEIGHTED tokens: every model carries a usage factor, so a model at factor 2 spends two of these per token it serves. 
 
 ## Properties
 
@@ -9,7 +9,8 @@ Name | Type
 ------------ | -------------
 `inputTokensMonthly` | number
 `outputTokensMonthly` | number
-`weeklyTokens` | number
+`weeklyInputTokens` | number
+`weeklyOutputTokens` | number
 `maxUsageMicroCents` | number
 `paygDiscountBp` | number
 
@@ -22,7 +23,8 @@ import type { SubscriptionQuota } from '@deeprelay/sdk'
 const example = {
   "inputTokensMonthly": null,
   "outputTokensMonthly": null,
-  "weeklyTokens": null,
+  "weeklyInputTokens": null,
+  "weeklyOutputTokens": null,
   "maxUsageMicroCents": null,
   "paygDiscountBp": null,
 } satisfies SubscriptionQuota

package/docs/SubscriptionTier.md

@@ -0,0 +1,41 @@
+
+# SubscriptionTier
+
+One plan as the plan catalogue lists it: identity, price and the allowance it buys. Every offered plan covers the same models at the same usage factors — Plus is Base with a larger allowance. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`key` | string
+`name` | string
+`price` | [SubscriptionPrice](SubscriptionPrice.md)
+`quota` | [SubscriptionQuota](SubscriptionQuota.md)
+
+## Example
+
+```typescript
+import type { SubscriptionTier } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "key": null,
+  "name": null,
+  "price": null,
+  "quota": null,
+} satisfies SubscriptionTier
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SubscriptionTier
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SubscriptionUpgradeRequest.md

@@ -0,0 +1,34 @@
+
+# SubscriptionUpgradeRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`planKey` | string
+
+## Example
+
+```typescript
+import type { SubscriptionUpgradeRequest } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "planKey": null,
+} satisfies SubscriptionUpgradeRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SubscriptionUpgradeRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SubscriptionUsage.md

@@ -11,8 +11,12 @@ Name | Type
 `periodEnd` | Date
 `weightedInputTokens` | number
 `weightedOutputTokens` | number
-`weeklyWeightedTokens` | number
+`weeklyWeightedInputTokens` | number
+`weeklyWeightedOutputTokens` | number
 `costMicroCents` | number
+`recentPaygCalls24h` | number
+`byModel` | [Array<SubscriptionModelUsage>](SubscriptionModelUsage.md)
+`weeklyByModel` | [Array<SubscriptionModelUsage>](SubscriptionModelUsage.md)
 
 ## Example
 
@@ -25,8 +29,12 @@ const example = {
   "periodEnd": null,
   "weightedInputTokens": null,
   "weightedOutputTokens": null,
-  "weeklyWeightedTokens": null,
+  "weeklyWeightedInputTokens": null,
+  "weeklyWeightedOutputTokens": null,
   "costMicroCents": null,
+  "recentPaygCalls24h": null,
+  "byModel": null,
+  "weeklyByModel": null,
 } satisfies SubscriptionUsage
 
 console.log(example)

package/docs/Tool.md

@@ -0,0 +1,36 @@
+
+# Tool
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`_function` | [ToolFunction](ToolFunction.md)
+
+## Example
+
+```typescript
+import type { Tool } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "_function": null,
+} satisfies Tool
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as Tool
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ToolCall.md

@@ -0,0 +1,41 @@
+
+# ToolCall
+
+A function call the model emitted.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`index` | number
+`id` | string
+`type` | string
+`_function` | [ToolCallFunction](ToolCallFunction.md)
+
+## Example
+
+```typescript
+import type { ToolCall } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "index": null,
+  "id": null,
+  "type": null,
+  "_function": null,
+} satisfies ToolCall
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ToolCall
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ToolCallFunction.md

@@ -0,0 +1,36 @@
+
+# ToolCallFunction
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`arguments` | string
+
+## Example
+
+```typescript
+import type { ToolCallFunction } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "arguments": null,
+} satisfies ToolCallFunction
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ToolCallFunction
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ToolChoiceFunction.md

@@ -0,0 +1,36 @@
+
+# ToolChoiceFunction
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`_function` | [ToolChoiceFunctionFunction](ToolChoiceFunctionFunction.md)
+
+## Example
+
+```typescript
+import type { ToolChoiceFunction } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "_function": null,
+} satisfies ToolChoiceFunction
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ToolChoiceFunction
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ToolChoiceFunctionFunction.md

@@ -0,0 +1,34 @@
+
+# ToolChoiceFunctionFunction
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+
+## Example
+
+```typescript
+import type { ToolChoiceFunctionFunction } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+} satisfies ToolChoiceFunctionFunction
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ToolChoiceFunctionFunction
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ToolFunction.md

@@ -0,0 +1,38 @@
+
+# ToolFunction
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`description` | string
+`parameters` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { ToolFunction } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "description": null,
+  "parameters": null,
+} satisfies ToolFunction
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ToolFunction
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/Usage.md

@@ -9,6 +9,10 @@ Name | Type
 `promptTokens` | number
 `completionTokens` | number
 `totalTokens` | number
+`promptTokensDetails` | [UsagePromptTokensDetails](UsagePromptTokensDetails.md)
+`completionTokensDetails` | [UsageCompletionTokensDetails](UsageCompletionTokensDetails.md)
+`cost` | number
+`costDetails` | [CostDetails](CostDetails.md)
 
 ## Example
 
@@ -20,6 +24,10 @@ const example = {
   "promptTokens": null,
   "completionTokens": null,
   "totalTokens": null,
+  "promptTokensDetails": null,
+  "completionTokensDetails": null,
+  "cost": null,
+  "costDetails": null,
 } satisfies Usage
 
 console.log(example)

package/docs/UsageCompletionTokensDetails.md

@@ -0,0 +1,34 @@
+
+# UsageCompletionTokensDetails
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`reasoningTokens` | number
+
+## Example
+
+```typescript
+import type { UsageCompletionTokensDetails } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "reasoningTokens": null,
+} satisfies UsageCompletionTokensDetails
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as UsageCompletionTokensDetails
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/UsagePromptTokensDetails.md

@@ -0,0 +1,35 @@
+
+# UsagePromptTokensDetails
+
+Present whenever the upstream reported prompt-cache usage, including a reported 0. Absent means the upstream did not report it. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`cachedTokens` | number
+
+## Example
+
+```typescript
+import type { UsagePromptTokensDetails } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "cachedTokens": null,
+} satisfies UsagePromptTokensDetails
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as UsagePromptTokensDetails
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deeprelay/sdk",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "TypeScript SDK for the deeprelay Public Developer API",
   "author": "deeprelay Support <support@deeprelay.ai>",
   "repository": {

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();
+    }
+
+}