@deeprelay/sdk 0.2.0 → 0.3.0

package/docs/Subscription.md

@@ -1,7 +1,7 @@
 
 # Subscription
 
-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. 
 
 ## Properties
 
@@ -15,6 +15,7 @@ Name | Type
 `plan` | [SubscriptionPlan](SubscriptionPlan.md)
 `quota` | [SubscriptionQuota](SubscriptionQuota.md)
 `usage` | [SubscriptionUsage](SubscriptionUsage.md)
+`plans` | [Array<SubscriptionTier>](SubscriptionTier.md)
 
 ## Example
 
@@ -31,6 +32,7 @@ const example = {
   "plan": null,
   "quota": null,
   "usage": null,
+  "plans": null,
 } satisfies Subscription
 
 console.log(example)

package/docs/SubscriptionCheckoutRequest.md

@@ -10,6 +10,7 @@ Name | Type
 `successUrl` | string
 `cancelUrl` | string
 `planKey` | string
+`method` | string
 
 ## Example
 
@@ -21,6 +22,7 @@ const example = {
   "successUrl": null,
   "cancelUrl": null,
   "planKey": null,
+  "method": null,
 } satisfies SubscriptionCheckoutRequest
 
 console.log(example)

package/docs/SubscriptionCheckoutSession.md

@@ -9,6 +9,8 @@ Name | Type
 `checkoutUrl` | string
 `sessionId` | string
 `plan` | [SubscriptionPlan](SubscriptionPlan.md)
+`switchTo` | string
+`firstChargeAt` | Date
 
 ## Example
 
@@ -20,6 +22,8 @@ const example = {
   "checkoutUrl": null,
   "sessionId": null,
   "plan": null,
+  "switchTo": null,
+  "firstChargeAt": null,
 } satisfies SubscriptionCheckoutSession
 
 console.log(example)

package/docs/SubscriptionModelUsage.md

@@ -0,0 +1,47 @@
+
+# SubscriptionModelUsage
+
+One model\'s plan-covered usage in a window. Cached input is part of `input_tokens` and counts toward the allowance in full; it is broken out only so you can see how much of your input was cache reads.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`model` | string
+`inputTokens` | number
+`cachedInputTokens` | number
+`outputTokens` | number
+`usageFactorMilli` | number
+`weightedInputTokens` | number
+`weightedOutputTokens` | number
+
+## Example
+
+```typescript
+import type { SubscriptionModelUsage } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "model": null,
+  "inputTokens": null,
+  "cachedInputTokens": null,
+  "outputTokens": null,
+  "usageFactorMilli": null,
+  "weightedInputTokens": null,
+  "weightedOutputTokens": null,
+} satisfies SubscriptionModelUsage
+
+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 SubscriptionModelUsage
+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/SubscriptionPlan.md

@@ -1,7 +1,7 @@
 
 # SubscriptionPlan
 
-What the organization is — or would be — subscribing to. Always present, including for an organization that never subscribed: it is what a point of purchase renders before sending anyone to pay. 
+The plan the organization is on — or, for an organization that never subscribed, the Base plan it would get. Always present: it is what a point of purchase renders before sending anyone to pay. 
 
 ## Properties
 

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/UsageApi.md

@@ -10,10 +10,12 @@ All URIs are relative to *https://api.deeprelay.ai/v1*
 
 ## listUsage
 
-> UsagePage listUsage(bucket, groupBy, start, end, cursor, limit)
+> UsagePage listUsage(bucket, groupBy, start, end, cursor, limit, modality, model)
 
 Time-bucketed usage
 
+Returns spend aggregated into time buckets over `[start, end)` (default: the last 30 days, `bucket=day`), newest bucket first.  The response has one of two row shapes, selected by the query:  - **Inference usage** — set `modality` and/or `model`. Rows aggregate serverless inference calls, one row per (bucket, modality, model), and carry `modality`, `model`, `prompt_tokens`, `completion_tokens` and `image_count`. This is the usage a serverless-inference customer is billed for. - **Instance usage** — neither `modality` nor `model` set. Rows aggregate GPU instance billing sessions, optionally split by `group_by`. With no instance usage this returns an empty `data` array, so to read inference spend always pass `modality` or `model`.  Requires the `billing:read` scope. 
+
 ### Example
 
 ```ts
@@ -32,18 +34,22 @@ async function example() {
   const api = new UsageApi(config);
 
   const body = {
-    // 'hour' | 'day' | 'week' | 'month' (optional)
+    // 'hour' | 'day' | 'week' | 'month' | Bucket width. Defaults to `day`. (optional)
     bucket: bucket_example,
-    // 'instance_id' | 'gpu_type' (optional)
+    // 'instance_id' | 'gpu_type' | Split instance-usage rows by instance or GPU type. Applies only to the instance-usage shape (neither `modality` nor `model` set); ignored when either is set, since inference rows are always split by modality and model.  (optional)
     groupBy: groupBy_example,
-    // Date (optional)
+    // Date | Inclusive RFC 3339 range start. Defaults to 30 days ago. (optional)
     start: 2013-10-20T19:20:30+01:00,
-    // Date (optional)
+    // Date | Exclusive RFC 3339 range end. Defaults to now; must be after `start`. (optional)
     end: 2013-10-20T19:20:30+01:00,
     // string (optional)
     cursor: cursor_example,
     // number (optional)
     limit: 56,
+    // 'chat' | 'image' | 'video' | 'embedding' | Return inference-usage rows for this modality only. Setting `modality` or `model` selects the inference-usage shape; omit both for the instance-usage shape.  (optional)
+    modality: modality_example,
+    // string | Return inference-usage rows for this model only: an exact match on the model `id` as listed by `GET /models`. May be combined with `modality`. Setting `modality` or `model` selects the inference-usage shape.  (optional)
+    model: model_example,
   } satisfies ListUsageRequest;
 
   try {
@@ -63,12 +69,14 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **bucket** | `hour`, `day`, `week`, `month` |  | [Optional] [Defaults to `undefined`] [Enum: hour, day, week, month] |
-| **groupBy** | `instance_id`, `gpu_type` |  | [Optional] [Defaults to `undefined`] [Enum: instance_id, gpu_type] |
-| **start** | `Date` |  | [Optional] [Defaults to `undefined`] |
-| **end** | `Date` |  | [Optional] [Defaults to `undefined`] |
+| **bucket** | `hour`, `day`, `week`, `month` | Bucket width. Defaults to `day`. | [Optional] [Defaults to `undefined`] [Enum: hour, day, week, month] |
+| **groupBy** | `instance_id`, `gpu_type` | Split instance-usage rows by instance or GPU type. Applies only to the instance-usage shape (neither `modality` nor `model` set); ignored when either is set, since inference rows are always split by modality and model.  | [Optional] [Defaults to `undefined`] [Enum: instance_id, gpu_type] |
+| **start** | `Date` | Inclusive RFC 3339 range start. Defaults to 30 days ago. | [Optional] [Defaults to `undefined`] |
+| **end** | `Date` | Exclusive RFC 3339 range end. Defaults to now; must be after `start`. | [Optional] [Defaults to `undefined`] |
 | **cursor** | `string` |  | [Optional] [Defaults to `undefined`] |
 | **limit** | `number` |  | [Optional] [Defaults to `50`] |
+| **modality** | `chat`, `image`, `video`, `embedding` | Return inference-usage rows for this modality only. Setting `modality` or `model` selects the inference-usage shape; omit both for the instance-usage shape.  | [Optional] [Defaults to `undefined`] [Enum: chat, image, video, embedding] |
+| **model** | `string` | Return inference-usage rows for this model only: an exact match on the model `id` as listed by `GET /models`. May be combined with `modality`. Setting `modality` or `model` selects the inference-usage shape.  | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 

package/docs/UsageBucket.md

@@ -1,6 +1,7 @@
 
 # UsageBucket
 
+One `/usage` row. Every row carries `bucket_start`, `gpu_seconds` and `cost_cents`. When the request set `modality` or `model` the row is an inference-usage row: it also carries `modality`, `model`, `prompt_tokens`, `completion_tokens` and `image_count` (aggregating every serverless inference call in the bucket for that modality and model), and `gpu_seconds` is always 0. Otherwise it is an instance-usage row, carrying `instance_id` / `gpu_type` when `group_by` asked for them. 
 
 ## Properties
 
@@ -11,6 +12,11 @@ Name | Type
 `gpuType` | string
 `gpuSeconds` | number
 `costCents` | number
+`modality` | string
+`model` | string
+`promptTokens` | number
+`completionTokens` | number
+`imageCount` | number
 
 ## Example
 
@@ -24,6 +30,11 @@ const example = {
   "gpuType": null,
   "gpuSeconds": null,
   "costCents": null,
+  "modality": null,
+  "model": null,
+  "promptTokens": null,
+  "completionTokens": null,
+  "imageCount": null,
 } satisfies UsageBucket
 
 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.0",
+  "version": "0.3.0",
   "description": "TypeScript SDK for the deeprelay Public Developer API",
   "author": "deeprelay Support <support@deeprelay.ai>",
   "repository": {