@deeprelay/sdk 0.2.1 → 0.3.0

package/docs/AlertsApi.md

@@ -0,0 +1,151 @@
+# AlertsApi
+
+All URIs are relative to *https://api.deeprelay.ai/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getAlertSettings**](AlertsApi.md#getalertsettings) | **GET** /alerts/settings | Get the organization\'s alert settings |
+| [**putAlertSettings**](AlertsApi.md#putalertsettings) | **PUT** /alerts/settings | Replace the organization\'s alert settings |
+
+
+
+## getAlertSettings
+
+> AlertSettings getAlertSettings()
+
+Get the organization\'s alert settings
+
+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. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AlertsApi,
+} from '@deeprelay/sdk';
+import type { GetAlertSettingsRequest } 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 AlertsApi(config);
+
+  try {
+    const data = await api.getAlertSettings();
+    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
+
+[**AlertSettings**](AlertSettings.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)
+
+
+## putAlertSettings
+
+> AlertSettings putAlertSettings(alertSettingsUpdate)
+
+Replace the organization\&#39;s alert settings
+
+Replaces every setting at once: send &#x60;balance_threshold_cents&#x60; and all four &#x60;email&#x60; toggles (a missing field is 422 &#x60;validation_failed&#x60; naming the &#x60;field&#x60;). Requires the &#x60;billing:write&#x60; scope AND an org admin\&#39;s key or a &#x60;full_access&#x60; key (403 &#x60;forbidden&#x60; 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. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AlertsApi,
+} from '@deeprelay/sdk';
+import type { PutAlertSettingsRequest } 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 AlertsApi(config);
+
+  const body = {
+    // AlertSettingsUpdate
+    alertSettingsUpdate: ...,
+  } satisfies PutAlertSettingsRequest;
+
+  try {
+    const data = await api.putAlertSettings(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **alertSettingsUpdate** | [AlertSettingsUpdate](AlertSettingsUpdate.md) |  | |
+
+### Return type
+
+[**AlertSettings**](AlertSettings.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) |  -  |
+| **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/ApiKey.md

@@ -0,0 +1,65 @@
+
+# ApiKey
+
+An API key\'s metadata and limits. Never carries the secret.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`apiKeyId` | string
+`name` | string
+`keyPrefix` | string
+`last4` | string
+`scopes` | [ApiKeyScopes](ApiKeyScopes.md)
+`budgetCents` | number
+`budgetUsedMicroCents` | number
+`budgetResetsAt` | Date
+`allowedModels` | Array<string>
+`staleModels` | Array<string>
+`rateLimitRps` | number
+`rateLimitBurst` | number
+`expiresAt` | Date
+`createdAt` | Date
+`lastUsedAt` | Date
+`revokedAt` | Date
+
+## Example
+
+```typescript
+import type { ApiKey } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "apiKeyId": null,
+  "name": null,
+  "keyPrefix": null,
+  "last4": null,
+  "scopes": null,
+  "budgetCents": null,
+  "budgetUsedMicroCents": null,
+  "budgetResetsAt": null,
+  "allowedModels": null,
+  "staleModels": null,
+  "rateLimitRps": null,
+  "rateLimitBurst": null,
+  "expiresAt": null,
+  "createdAt": null,
+  "lastUsedAt": null,
+  "revokedAt": null,
+} satisfies ApiKey
+
+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 ApiKey
+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/ApiKeyCreate.md

@@ -0,0 +1,46 @@
+
+# ApiKeyCreate
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`scopes` | { [key: string]: any; }
+`budgetCents` | number
+`allowedModels` | Array<string>
+`rateLimitRps` | number
+`rateLimitBurst` | number
+`expiresAt` | Date
+
+## Example
+
+```typescript
+import type { ApiKeyCreate } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "scopes": null,
+  "budgetCents": null,
+  "allowedModels": null,
+  "rateLimitRps": null,
+  "rateLimitBurst": null,
+  "expiresAt": null,
+} satisfies ApiKeyCreate
+
+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 ApiKeyCreate
+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/ApiKeyCreated.md

@@ -0,0 +1,67 @@
+
+# ApiKeyCreated
+
+The new key\'s metadata plus its secret (`key`), returned exactly once. The same fields as `ApiKey`, plus `key`.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`apiKeyId` | string
+`name` | string
+`keyPrefix` | string
+`last4` | string
+`scopes` | [ApiKeyScopes](ApiKeyScopes.md)
+`budgetCents` | number
+`budgetUsedMicroCents` | number
+`budgetResetsAt` | Date
+`allowedModels` | Array<string>
+`staleModels` | Array<string>
+`rateLimitRps` | number
+`rateLimitBurst` | number
+`expiresAt` | Date
+`createdAt` | Date
+`lastUsedAt` | Date
+`revokedAt` | Date
+`key` | string
+
+## Example
+
+```typescript
+import type { ApiKeyCreated } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "apiKeyId": null,
+  "name": null,
+  "keyPrefix": null,
+  "last4": null,
+  "scopes": null,
+  "budgetCents": null,
+  "budgetUsedMicroCents": null,
+  "budgetResetsAt": null,
+  "allowedModels": null,
+  "staleModels": null,
+  "rateLimitRps": null,
+  "rateLimitBurst": null,
+  "expiresAt": null,
+  "createdAt": null,
+  "lastUsedAt": null,
+  "revokedAt": null,
+  "key": null,
+} satisfies ApiKeyCreated
+
+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 ApiKeyCreated
+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/ApiKeyList.md

@@ -0,0 +1,34 @@
+
+# ApiKeyList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [Array<ApiKey>](ApiKey.md)
+
+## Example
+
+```typescript
+import type { ApiKeyList } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+} satisfies ApiKeyList
+
+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 ApiKeyList
+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/ApiKeyScopes.md

@@ -0,0 +1,38 @@
+
+# ApiKeyScopes
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`shape` | string
+`keysManage` | boolean
+`resources` | { [key: string]: string; }
+
+## Example
+
+```typescript
+import type { ApiKeyScopes } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "shape": null,
+  "keysManage": null,
+  "resources": null,
+} satisfies ApiKeyScopes
+
+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 ApiKeyScopes
+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/ApiKeyUpdate.md

@@ -0,0 +1,45 @@
+
+# ApiKeyUpdate
+
+Send only the fields to change. `null` clears `budget_cents`, `allowed_models` or `expires_at`. `scopes` cannot be changed.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`budgetCents` | number
+`allowedModels` | Array<string>
+`rateLimitRps` | number
+`rateLimitBurst` | number
+`expiresAt` | Date
+
+## Example
+
+```typescript
+import type { ApiKeyUpdate } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "budgetCents": null,
+  "allowedModels": null,
+  "rateLimitRps": null,
+  "rateLimitBurst": null,
+  "expiresAt": null,
+} satisfies ApiKeyUpdate
+
+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 ApiKeyUpdate
+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)
+
+