@deeprelay/sdk 0.2.1 → 0.3.0

package/docs/ApiKeysApi.md

@@ -0,0 +1,389 @@
+# ApiKeysApi
+
+All URIs are relative to *https://api.deeprelay.ai/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createApiKey**](ApiKeysApi.md#createapikey) | **POST** /api-keys | Create an API key |
+| [**getApiKey**](ApiKeysApi.md#getapikey) | **GET** /api-keys/{id} | Get an API key |
+| [**listApiKeys**](ApiKeysApi.md#listapikeys) | **GET** /api-keys | List API keys |
+| [**revokeApiKey**](ApiKeysApi.md#revokeapikey) | **DELETE** /api-keys/{id} | Revoke an API key |
+| [**updateApiKey**](ApiKeysApi.md#updateapikey) | **PATCH** /api-keys/{id} | Update an API key\'s name or limits |
+
+
+
+## createApiKey
+
+> ApiKeyCreated createApiKey(apiKeyCreate)
+
+Create an API key
+
+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. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ApiKeysApi,
+} from '@deeprelay/sdk';
+import type { CreateApiKeyRequest } from '@deeprelay/sdk';
+
+async function example() {
+  console.log("🚀 Testing @deeprelay/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new ApiKeysApi(config);
+
+  const body = {
+    // ApiKeyCreate
+    apiKeyCreate: ...,
+  } satisfies CreateApiKeyRequest;
+
+  try {
+    const data = await api.createApiKey(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **apiKeyCreate** | [ApiKeyCreate](ApiKeyCreate.md) |  | |
+
+### Return type
+
+[**ApiKeyCreated**](ApiKeyCreated.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`, `application/problem+json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Created. The response is sent with `Cache-Control: no-store`. |  -  |
+| **400** | Error response (RFC 7807) |  -  |
+| **403** | `keys_manage_required` (the calling key cannot manage keys), `scope_exceeds_caller` (the requested scopes exceed the calling key\'s own) or `forbidden` (only an org admin can mint a `full_access` key). |  -  |
+| **422** | Error response (RFC 7807) |  -  |
+| **429** | Rate limit exceeded (RFC 7807). Retry-After header indicates seconds to wait. |  * Retry-After - Seconds the client should wait before retrying. <br>  |
+| **0** | Error response (RFC 7807) |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getApiKey
+
+> ApiKey getApiKey(id)
+
+Get an API key
+
+Returns one key. A key the caller cannot see answers 404. Requires the &#x60;keys:read&#x60; scope. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ApiKeysApi,
+} from '@deeprelay/sdk';
+import type { GetApiKeyRequest } from '@deeprelay/sdk';
+
+async function example() {
+  console.log("🚀 Testing @deeprelay/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new ApiKeysApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetApiKeyRequest;
+
+  try {
+    const data = await api.getApiKey(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**ApiKey**](ApiKey.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`, `application/problem+json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **404** | Error response (RFC 7807) |  -  |
+| **429** | Rate limit exceeded (RFC 7807). Retry-After header indicates seconds to wait. |  * Retry-After - Seconds the client should wait before retrying. <br>  |
+| **0** | Error response (RFC 7807) |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listApiKeys
+
+> ApiKeyList listApiKeys()
+
+List API keys
+
+Lists the organization\&#39;s API keys with their limits and current budget use. An org admin\&#39;s key and a &#x60;full_access&#x60; 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 &#x60;keys:read&#x60; scope. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ApiKeysApi,
+} from '@deeprelay/sdk';
+import type { ListApiKeysRequest } from '@deeprelay/sdk';
+
+async function example() {
+  console.log("🚀 Testing @deeprelay/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new ApiKeysApi(config);
+
+  try {
+    const data = await api.listApiKeys();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ApiKeyList**](ApiKeyList.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`, `application/problem+json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **429** | Rate limit exceeded (RFC 7807). Retry-After header indicates seconds to wait. |  * Retry-After - Seconds the client should wait before retrying. <br>  |
+| **0** | Error response (RFC 7807) |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## revokeApiKey
+
+> revokeApiKey(id, idempotencyKey)
+
+Revoke an API key
+
+Revokes the key immediately; it cannot be restored. Requires the &#x60;keys:manage&#x60; capability (403 &#x60;keys_manage_required&#x60; otherwise); a member can only revoke keys they created. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ApiKeysApi,
+} from '@deeprelay/sdk';
+import type { RevokeApiKeyRequest } from '@deeprelay/sdk';
+
+async function example() {
+  console.log("🚀 Testing @deeprelay/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new ApiKeysApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // string (optional)
+    idempotencyKey: idempotencyKey_example,
+  } satisfies RevokeApiKeyRequest;
+
+  try {
+    const data = await api.revokeApiKey(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+| **idempotencyKey** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/problem+json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Revoked |  -  |
+| **403** | Error response (RFC 7807) |  -  |
+| **404** | Error response (RFC 7807) |  -  |
+| **429** | Rate limit exceeded (RFC 7807). Retry-After header indicates seconds to wait. |  * Retry-After - Seconds the client should wait before retrying. <br>  |
+| **0** | Error response (RFC 7807) |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## updateApiKey
+
+> ApiKey updateApiKey(id, apiKeyUpdate, idempotencyKey)
+
+Update an API key\&#39;s name or limits
+
+Changes a key\&#39;s name, budget, model allowlist, rate limit or expiry. An absent field is left unchanged; an explicit &#x60;null&#x60; clears &#x60;budget_cents&#x60;, &#x60;allowed_models&#x60; or &#x60;expires_at&#x60;. &#x60;scopes&#x60; cannot be changed after minting, and unknown fields are refused (422), so a typo never looks like a successful change. Requires the &#x60;keys:manage&#x60; capability (403 &#x60;keys_manage_required&#x60; otherwise); a member can only change keys they created. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ApiKeysApi,
+} from '@deeprelay/sdk';
+import type { UpdateApiKeyRequest } from '@deeprelay/sdk';
+
+async function example() {
+  console.log("🚀 Testing @deeprelay/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new ApiKeysApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // ApiKeyUpdate
+    apiKeyUpdate: ...,
+    // string (optional)
+    idempotencyKey: idempotencyKey_example,
+  } satisfies UpdateApiKeyRequest;
+
+  try {
+    const data = await api.updateApiKey(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+| **apiKeyUpdate** | [ApiKeyUpdate](ApiKeyUpdate.md) |  | |
+| **idempotencyKey** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**ApiKey**](ApiKey.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`, `application/problem+json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **400** | Error response (RFC 7807) |  -  |
+| **403** | Error response (RFC 7807) |  -  |
+| **404** | Error response (RFC 7807) |  -  |
+| **422** | Error response (RFC 7807) |  -  |
+| **429** | Rate limit exceeded (RFC 7807). Retry-After header indicates seconds to wait. |  * Retry-After - Seconds the client should wait before retrying. <br>  |
+| **0** | Error response (RFC 7807) |  -  |
+
+[[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/BillingApi.md

@@ -15,6 +15,7 @@ All URIs are relative to *https://api.deeprelay.ai/v1*
 | [**getSubscription**](BillingApi.md#getsubscription) | **GET** /billing/subscription | Get the org subscription status and quota usage |
 | [**listDeposits**](BillingApi.md#listdeposits) | **GET** /billing/deposits | List stablecoin deposits |
 | [**updateSpendingLimit**](BillingApi.md#updatespendinglimitoperation) | **PUT** /billing/spending-limit | Set the org spending limit |
+| [**upgradeSubscription**](BillingApi.md#upgradesubscription) | **POST** /billing/subscription/upgrade | Upgrade the subscription to a bigger plan |
 
 
 
@@ -101,7 +102,7 @@ example().catch(console.error);
 
 Start a subscription checkout session
 
-Opens a hosted checkout session for the flat tier and returns its URL. Requires the `billing:write` scope AND organization-admin privileges — subscribing spends organization money.  This endpoint does NOT subscribe anyone. Checkout is a hosted page that needs a browser and a card, so the caller\'s job is to put the returned URL in front of a human. The subscription becomes active when payment completes, which is not synchronous with this call: poll `/billing/subscription` to confirm.  `success_url` and `cancel_url` are optional and fall back to the deployment\'s configured redirects, which is what lets a command-line client start a purchase without having any URLs of its own. An empty request body is valid and means \"use every default\".  `plan_key`, when sent, pins the plan the client DISPLAYED: an unknown key is a 400 rather than a silent purchase of a different tier. Today there is one tier, so the only accepted value is its key — but sending it is the forward-compatible choice.  One flat tier means at most one subscription per organization: a second checkout while an entitling subscription exists is a 409. 
+Opens a hosted checkout session for a subscription plan and returns its URL. Requires the `billing:write` scope AND organization-admin privileges — subscribing spends organization money.  This endpoint does NOT subscribe anyone. Checkout is a hosted page that needs a browser and a card, so the caller\'s job is to put the returned URL in front of a human. The subscription becomes active when payment completes, which is not synchronous with this call: poll `/billing/subscription` to confirm.  `success_url` and `cancel_url` are optional and fall back to the deployment\'s configured redirects, which is what lets a command-line client start a purchase without having any URLs of its own. An empty request body is valid and means \"use every default\". When sent, they must be on the deployment\'s dashboard origin, else 422 `validation_failed`.  `plan_key` names the plan to buy: `flat` (Base, the default when the field is omitted) or `plus`. It pins the plan the client DISPLAYED — an unknown key, or a plan this deployment does not offer, is a 400 rather than a silent purchase of a different tier. The `plans` array on `/billing/subscription` lists the accepted keys.  One subscription per organization: a second checkout while an entitling subscription exists is a 409. To move an existing subscription to a bigger plan use `/billing/subscription/upgrade`.  `method` picks how the plan is paid: `card` (dollars, card or Link; the default) or `upi` (rupees, UPI AutoPay, India). On an organization that already subscribes, an explicit `method` in the other currency is a switch, not a second subscription: the link saves the new card or UPI AutoPay mandate (nothing is charged), and once that completes the same plan is moved to the new currency, first charged on the current renewal date (that month is already paid). The answer then carries `switch_to` and `first_charge_at`. A switch is refused (409) within two days of renewal, while the plan is set to cancel, while an upgrade waits on its UPI payment, and in the currency the plan already uses. 
 
 ### Example
 
@@ -459,7 +460,7 @@ example().catch(console.error);
 
 Get the org referral code, invite link, terms and stats
 
-Returns the organization\'s shareable referral code and invite link (minting the code on first read), the program terms, the referrer\'s stats, and — when this organization itself signed up through someone else\'s link — its own progress toward the referee reward. Requires the `billing:read` scope. The organization is taken from the authenticated API key, never from a parameter.  The program: share the invite link; when a friend signs up through it and spends `qualify_spend_cents` on inference, the referrer receives `reward_cents` and the friend receives `referee_reward_cents`, both as non-withdrawable credit, after a `hold_days` chargeback hold. The terms ride on the wire so a client never hard-codes the amounts.  `referred` is ABSENT (not null) for an organization nobody referred — key on its presence. This is the same contract the dashboard\'s referral card reads. 
+Returns the organization\'s shareable referral code and invite link (minting the code on first read), the program terms, the referrer\'s stats, and — when this organization itself signed up through someone else\'s link — its own progress toward the referee reward. Requires the `billing:read` scope. The organization is taken from the authenticated API key, never from a parameter.  The program: share the invite link; when a friend signs up through it and spends `qualify_spend_cents` on inference, the referrer receives `reward_cents` and the friend receives `referee_reward_cents`, both as non-withdrawable credit, after a `hold_days` chargeback hold. The referrer also earns `commission_pct` percent of every real deposit the friend makes, credited as spend-only promotional credit when the deposit clears (`commission_earned_cents`). Program rewards never apply to the subscription. The terms ride on the wire so a client never hard-codes the amounts.  `referred` is ABSENT (not null) for an organization nobody referred — key on its presence. This is the same contract the dashboard\'s referral card reads. 
 
 ### Example
 
@@ -590,7 +591,7 @@ This endpoint does not need any parameter.
 
 Get the org subscription status and quota usage
 
-Returns the organization\'s flat-tier subscription: whether it is entitled, the current billing period, the plan\'s configured quota, and — for an entitled subscription — consumption against the four limits the server enforces on every request. Requires the `billing:read` scope. The organization is taken from the authenticated API key, never from a parameter.  An organization that never subscribed is NOT an error. It gets 200 with `subscribed: false`, `status: \"none\"` and the quota the plan would provide, so a client can answer \"what does the plan include\" without a second endpoint and without an error path.  Read `subscribed`, not `status`, to decide whether the plan applies: `status` carries the billing provider\'s vocabulary, and the two can disagree — an `active` subscription just past its period end still entitles for a short grace window (renewal-webhook lag), while `past_due` and `canceled` never entitle.  `usage` is present only for an entitled subscription whose meter could be read. An absent `usage` NEVER means \"nothing used\" — reading it as zero would report a full quota to an organization that has none left.  This is the plan\'s meter. For pay-as-you-go credit see `/billing/balance`, for spend against a self-set cap see `/billing/spending-limit`, and for past consumption see `/usage`. 
+Returns the organization\'s subscription: whether it is entitled, the current billing period, the plan it is on and that plan\'s configured quota, and — for an entitled subscription — consumption against the limits the server enforces on every request. Requires the `billing:read` scope. The organization is taken from the authenticated API key, never from a parameter.  `plan` and `quota` describe the plan the organization IS on (the Base plan for an organization that never subscribed). `plans` lists every plan this deployment offers — Base, then Plus — each with its price and quota, so a client can render an upgrade offer without a second call.  An organization that never subscribed is NOT an error. It gets 200 with `subscribed: false`, `status: \"none\"` and the quota the Base plan would provide, so a client can answer \"what does the plan include\" without a second endpoint and without an error path.  Read `subscribed`, not `status`, to decide whether the plan applies: `status` carries the billing provider\'s vocabulary, and the two can disagree — an `active` subscription just past its period end still entitles for a short grace window (renewal-webhook lag), while `past_due` and `canceled` never entitle.  `usage` is present only for an entitled subscription whose meter could be read. An absent `usage` NEVER means \"nothing used\" — reading it as zero would report a full quota to an organization that has none left.  This is the plan\'s meter. For pay-as-you-go credit see `/billing/balance`, for spend against a self-set cap see `/billing/spending-limit`, and for past consumption see `/usage`. 
 
 ### Example
 
@@ -789,3 +790,82 @@ example().catch(console.error);
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
+
+## upgradeSubscription
+
+> Subscription upgradeSubscription(subscriptionUpgradeRequest)
+
+Upgrade the subscription to a bigger plan
+
+Moves the organization\'s EXISTING subscription onto a bigger plan. Requires the `billing:write` scope AND organization-admin privileges — an upgrade charges the organization\'s card on file.  Unlike checkout, no hosted page is involved: the subscription\'s price is swapped, the new plan\'s FULL price is charged immediately (whenever in the cycle the upgrade happens), and a new billing period starts now. There is no credit for the unused remainder of the old plan\'s period, and the usage meters start from zero on the new plan because every quota window is summed over the current period. The response is the post-upgrade subscription, in the same shape as `/billing/subscription`.  `plan_key` is required and names the target plan (`plus`). The target must be bigger than the plan the organization is on: upgrading to the current plan or to a smaller one is a 409 `not_an_upgrade` — downgrades go through the billing portal. An organization with no entitling subscription gets 409 `not_subscribed` and should use checkout instead. A subscription already set to end at the period close is refused with 409 `subscription_cancelling` (the upgrade would start a new period and move that end date); resume it in the portal first.  If the charge cannot be collected (card declined, no payment method) the call is a 402 `payment_failed` and NOTHING changes — the organization stays on its current plan. Fix the card in the billing portal and retry. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  BillingApi,
+} from '@deeprelay/sdk';
+import type { UpgradeSubscriptionRequest } from '@deeprelay/sdk';
+
+async function example() {
+  console.log("🚀 Testing @deeprelay/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new BillingApi(config);
+
+  const body = {
+    // SubscriptionUpgradeRequest
+    subscriptionUpgradeRequest: ...,
+  } satisfies UpgradeSubscriptionRequest;
+
+  try {
+    const data = await api.upgradeSubscription(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **subscriptionUpgradeRequest** | [SubscriptionUpgradeRequest](SubscriptionUpgradeRequest.md) |  | |
+
+### Return type
+
+[**Subscription**](Subscription.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`, `application/problem+json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK — the subscription after the upgrade |  -  |
+| **400** | Unknown plan_key, or a plan this deployment does not offer |  -  |
+| **402** | Payment for the new plan failed; the current plan is unchanged |  -  |
+| **403** | Not an organization admin |  -  |
+| **409** | `not_subscribed` — no active subscription to upgrade (use checkout); `not_an_upgrade` — the target is the current plan or a smaller one; `subscription_cancelling` — the subscription is set to end at the period close (resume it in the portal first) |  -  |
+| **422** | plan_key is missing |  -  |
+| **503** | Subscription billing is not configured on this deployment |  -  |
+| **429** | Rate limit exceeded (RFC 7807). Retry-After header indicates seconds to wait. |  * Retry-After - Seconds the client should wait before retrying. <br>  |
+| **0** | Error response (RFC 7807) |  -  |
+
+[[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/ChatChoice.md

@@ -9,6 +9,7 @@ Name | Type
 `index` | number
 `message` | [ChatMessage](ChatMessage.md)
 `finishReason` | string
+`logprobs` | { [key: string]: any; }
 
 ## Example
 
@@ -20,6 +21,7 @@ const example = {
   "index": null,
   "message": null,
   "finishReason": null,
+  "logprobs": null,
 } satisfies ChatChoice
 
 console.log(example)

package/docs/ChatCompletionRequest.md

@@ -10,8 +10,19 @@ Name | Type
 `messages` | [Array<ChatMessage>](ChatMessage.md)
 `temperature` | number
 `maxTokens` | number
+`maxCompletionTokens` | number
 `stream` | boolean
 `streamOptions` | [StreamOptions](StreamOptions.md)
+`tools` | [Array<Tool>](Tool.md)
+`toolChoice` | [ChatCompletionRequestToolChoice](ChatCompletionRequestToolChoice.md)
+`responseFormat` | [ChatCompletionRequestResponseFormat](ChatCompletionRequestResponseFormat.md)
+`reasoningEffort` | string
+`presencePenalty` | number
+`frequencyPenalty` | number
+`seed` | number
+`parallelToolCalls` | boolean
+`logprobs` | boolean
+`topLogprobs` | number
 
 ## Example
 
@@ -24,8 +35,19 @@ const example = {
   "messages": null,
   "temperature": null,
   "maxTokens": null,
+  "maxCompletionTokens": null,
   "stream": null,
   "streamOptions": null,
+  "tools": null,
+  "toolChoice": null,
+  "responseFormat": null,
+  "reasoningEffort": null,
+  "presencePenalty": null,
+  "frequencyPenalty": null,
+  "seed": null,
+  "parallelToolCalls": null,
+  "logprobs": null,
+  "topLogprobs": null,
 } satisfies ChatCompletionRequest
 
 console.log(example)

package/docs/ChatCompletionRequestResponseFormat.md

@@ -0,0 +1,37 @@
+
+# ChatCompletionRequestResponseFormat
+
+Constrain the reply format. Gated per model: `json_object` needs \"response_format\" in the model\'s supported_parameters, and a strict `json_schema` needs \"structured_outputs\". A model without the capability returns 400 unsupported_parameter naming the models that have it. A non-strict json_schema on a model with only \"response_format\" is served as json_object and reported as `response_format:downgraded` in x-deeprelay-ignored-params. The relay never emulates JSON mode by prompting. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`jsonSchema` | [JSONSchemaFormat](JSONSchemaFormat.md)
+
+## Example
+
+```typescript
+import type { ChatCompletionRequestResponseFormat } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "jsonSchema": null,
+} satisfies ChatCompletionRequestResponseFormat
+
+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 ChatCompletionRequestResponseFormat
+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/ChatCompletionRequestToolChoice.md

@@ -0,0 +1,37 @@
+
+# ChatCompletionRequestToolChoice
+
+How the model should pick a tool: the strings \"none\", \"auto\" or \"required\", or an object naming one function. Requires a non-empty tools array unless it is \"none\". 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`_function` | [ToolChoiceFunctionFunction](ToolChoiceFunctionFunction.md)
+
+## Example
+
+```typescript
+import type { ChatCompletionRequestToolChoice } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "_function": null,
+} satisfies ChatCompletionRequestToolChoice
+
+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 ChatCompletionRequestToolChoice
+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/ChatMessage.md

@@ -8,6 +8,8 @@ Name | Type
 ------------ | -------------
 `role` | string
 `content` | string
+`toolCalls` | [Array<ToolCall>](ToolCall.md)
+`toolCallId` | string
 
 ## Example
 
@@ -18,6 +20,8 @@ import type { ChatMessage } from '@deeprelay/sdk'
 const example = {
   "role": null,
   "content": null,
+  "toolCalls": null,
+  "toolCallId": null,
 } satisfies ChatMessage
 
 console.log(example)