@deeprelay/sdk 0.0.1 → 0.1.1

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)
+
+

package/docs/VideoJob.md

@@ -0,0 +1,56 @@
+
+# VideoJob
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`object` | string
+`model` | string
+`status` | string
+`progress` | number
+`size` | string
+`seconds` | number
+`createdAt` | number
+`completedAt` | number
+`expiresAt` | number
+`error` | string
+`costCents` | number
+
+## Example
+
+```typescript
+import type { VideoJob } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "object": null,
+  "model": null,
+  "status": null,
+  "progress": null,
+  "size": null,
+  "seconds": null,
+  "createdAt": null,
+  "completedAt": null,
+  "expiresAt": null,
+  "error": null,
+  "costCents": null,
+} satisfies VideoJob
+
+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 VideoJob
+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/VideoList.md

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

@@ -0,0 +1,44 @@
+
+# WebhookEndpoint
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`url` | string
+`secret` | string
+`eventTypes` | Array<string>
+`enabled` | boolean
+`createdAt` | Date
+
+## Example
+
+```typescript
+import type { WebhookEndpoint } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "url": null,
+  "secret": null,
+  "eventTypes": null,
+  "enabled": null,
+  "createdAt": null,
+} satisfies WebhookEndpoint
+
+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 WebhookEndpoint
+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/WebhookEndpointPage.md

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