@deeprelay/sdk 0.0.1 → 0.1.0

package/docs/PeakWindow.md

@@ -0,0 +1,37 @@
+
+# PeakWindow
+
+One daily UTC time range during which a model\'s peak rates apply.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`start` | string
+`end` | string
+
+## Example
+
+```typescript
+import type { PeakWindow } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "start": null,
+  "end": null,
+} satisfies PeakWindow
+
+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 PeakWindow
+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/Problem.md

@@ -0,0 +1,44 @@
+
+# Problem
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`title` | string
+`status` | number
+`detail` | string
+`code` | string
+`requestId` | string
+
+## Example
+
+```typescript
+import type { Problem } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "title": null,
+  "status": null,
+  "detail": null,
+  "code": null,
+  "requestId": null,
+} satisfies Problem
+
+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 Problem
+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/SpendingLimit.md

@@ -0,0 +1,54 @@
+
+# SpendingLimit
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`monthlyLimitCents` | number
+`monthlyLimitDollars` | number
+`currentMonthSpendCents` | number
+`currentMonthSpendDollars` | number
+`percentUsed` | number
+`billingCycleStart` | Date
+`enforcement` | string
+`autoTerminateHours` | number
+`dailyLimitCents` | number
+`dailyLimitDollars` | number
+`currentDaySpendCents` | number
+
+## Example
+
+```typescript
+import type { SpendingLimit } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "monthlyLimitCents": null,
+  "monthlyLimitDollars": null,
+  "currentMonthSpendCents": null,
+  "currentMonthSpendDollars": null,
+  "percentUsed": null,
+  "billingCycleStart": null,
+  "enforcement": null,
+  "autoTerminateHours": null,
+  "dailyLimitCents": null,
+  "dailyLimitDollars": null,
+  "currentDaySpendCents": null,
+} satisfies SpendingLimit
+
+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 SpendingLimit
+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/StreamOptions.md

@@ -0,0 +1,34 @@
+
+# StreamOptions
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`includeUsage` | boolean
+
+## Example
+
+```typescript
+import type { StreamOptions } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "includeUsage": null,
+} satisfies StreamOptions
+
+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 StreamOptions
+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/Subscription.md

@@ -0,0 +1,49 @@
+
+# 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. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`subscribed` | boolean
+`status` | string
+`cancelAtPeriodEnd` | boolean
+`currentPeriodStart` | Date
+`currentPeriodEnd` | Date
+`plan` | [SubscriptionPlan](SubscriptionPlan.md)
+`quota` | [SubscriptionQuota](SubscriptionQuota.md)
+`usage` | [SubscriptionUsage](SubscriptionUsage.md)
+
+## Example
+
+```typescript
+import type { Subscription } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "subscribed": null,
+  "status": null,
+  "cancelAtPeriodEnd": null,
+  "currentPeriodStart": null,
+  "currentPeriodEnd": null,
+  "plan": null,
+  "quota": null,
+  "usage": null,
+} satisfies Subscription
+
+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 Subscription
+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

@@ -0,0 +1,39 @@
+
+# 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. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`key` | string
+`name` | string
+`price` | [SubscriptionPrice](SubscriptionPrice.md)
+
+## Example
+
+```typescript
+import type { SubscriptionPlan } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "key": null,
+  "name": null,
+  "price": null,
+} satisfies SubscriptionPlan
+
+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 SubscriptionPlan
+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/SubscriptionPrice.md

@@ -0,0 +1,41 @@
+
+# SubscriptionPrice
+
+The plan\'s recurring charge, read live from the billing provider — the single source of truth, never a number embedded in code.  ABSENT means \"price unavailable right now\" (billing unconfigured, or the provider could not be reached). It NEVER means free. Render the plan without a figure rather than substituting one; the hosted checkout page always shows the real amount. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`amountCents` | number
+`currency` | string
+`interval` | string
+`intervalCount` | number
+
+## Example
+
+```typescript
+import type { SubscriptionPrice } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "amountCents": null,
+  "currency": null,
+  "interval": null,
+  "intervalCount": null,
+} satisfies SubscriptionPrice
+
+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 SubscriptionPrice
+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/SubscriptionQuota.md

@@ -0,0 +1,43 @@
+
+# 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. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`inputTokensMonthly` | number
+`outputTokensMonthly` | number
+`weeklyTokens` | number
+`maxUsageMicroCents` | number
+`paygDiscountBp` | number
+
+## Example
+
+```typescript
+import type { SubscriptionQuota } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "inputTokensMonthly": null,
+  "outputTokensMonthly": null,
+  "weeklyTokens": null,
+  "maxUsageMicroCents": null,
+  "paygDiscountBp": null,
+} satisfies SubscriptionQuota
+
+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 SubscriptionQuota
+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

@@ -0,0 +1,45 @@
+
+# SubscriptionUsage
+
+Consumption against the quota, from the same factor-weighted read the request-time gate evaluates — so this meter and enforcement cannot disagree.  Present only for an entitled subscription whose meter could be read. Its absence is never a statement that nothing was used. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`periodStart` | Date
+`periodEnd` | Date
+`weightedInputTokens` | number
+`weightedOutputTokens` | number
+`weeklyWeightedTokens` | number
+`costMicroCents` | number
+
+## Example
+
+```typescript
+import type { SubscriptionUsage } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "periodStart": null,
+  "periodEnd": null,
+  "weightedInputTokens": null,
+  "weightedOutputTokens": null,
+  "weeklyWeightedTokens": null,
+  "costMicroCents": null,
+} satisfies SubscriptionUsage
+
+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 SubscriptionUsage
+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/UpdateSpendingLimitRequest.md

@@ -0,0 +1,40 @@
+
+# UpdateSpendingLimitRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`monthlyLimitDollars` | number
+`enforcement` | string
+`autoTerminateHours` | number
+`dailyLimitDollars` | number
+
+## Example
+
+```typescript
+import type { UpdateSpendingLimitRequest } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "monthlyLimitDollars": null,
+  "enforcement": null,
+  "autoTerminateHours": null,
+  "dailyLimitDollars": null,
+} satisfies UpdateSpendingLimitRequest
+
+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 UpdateSpendingLimitRequest
+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

@@ -0,0 +1,38 @@
+
+# Usage
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`promptTokens` | number
+`completionTokens` | number
+`totalTokens` | number
+
+## Example
+
+```typescript
+import type { Usage } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "promptTokens": null,
+  "completionTokens": null,
+  "totalTokens": null,
+} satisfies Usage
+
+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 Usage
+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/UsageApi.md

@@ -0,0 +1,95 @@
+# UsageApi
+
+All URIs are relative to *https://api.deeprelay.ai/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**listUsage**](UsageApi.md#listusage) | **GET** /usage | Time-bucketed usage |
+
+
+
+## listUsage
+
+> UsagePage listUsage(bucket, groupBy, start, end, cursor, limit)
+
+Time-bucketed usage
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UsageApi,
+} from '@deeprelay/sdk';
+import type { ListUsageRequest } 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 UsageApi(config);
+
+  const body = {
+    // 'hour' | 'day' | 'week' | 'month' (optional)
+    bucket: bucket_example,
+    // 'instance_id' | 'gpu_type' (optional)
+    groupBy: groupBy_example,
+    // Date (optional)
+    start: 2013-10-20T19:20:30+01:00,
+    // Date (optional)
+    end: 2013-10-20T19:20:30+01:00,
+    // string (optional)
+    cursor: cursor_example,
+    // number (optional)
+    limit: 56,
+  } satisfies ListUsageRequest;
+
+  try {
+    const data = await api.listUsage(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| 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`] |
+| **cursor** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **limit** | `number` |  | [Optional] [Defaults to `50`] |
+
+### Return type
+
+[**UsagePage**](UsagePage.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)
+

package/docs/UsageBucket.md

@@ -0,0 +1,42 @@
+
+# UsageBucket
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`bucketStart` | Date
+`instanceId` | string
+`gpuType` | string
+`gpuSeconds` | number
+`costCents` | number
+
+## Example
+
+```typescript
+import type { UsageBucket } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "bucketStart": null,
+  "instanceId": null,
+  "gpuType": null,
+  "gpuSeconds": null,
+  "costCents": null,
+} satisfies UsageBucket
+
+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 UsageBucket
+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/UsagePage.md

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

@@ -0,0 +1,40 @@
+
+# VideoCreateRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`model` | string
+`prompt` | string
+`size` | string
+`seconds` | number
+
+## Example
+
+```typescript
+import type { VideoCreateRequest } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "model": null,
+  "prompt": null,
+  "size": null,
+  "seconds": null,
+} satisfies VideoCreateRequest
+
+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 VideoCreateRequest
+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)
+
+