@deeprelay/sdk 0.0.1 → 0.1.0

package/docs/ListDeposits200Response.md

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

@@ -0,0 +1,126 @@
+# MetaApi
+
+All URIs are relative to *https://api.deeprelay.ai/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getHealth**](MetaApi.md#gethealth) | **GET** /health | Liveness probe |
+| [**getOpenApiSpec**](MetaApi.md#getopenapispec) | **GET** /openapi.json | OpenAPI 3.1 specification |
+
+
+
+## getHealth
+
+> GetHealth200Response getHealth()
+
+Liveness probe
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MetaApi,
+} from '@deeprelay/sdk';
+import type { GetHealthRequest } from '@deeprelay/sdk';
+
+async function example() {
+  console.log("🚀 Testing @deeprelay/sdk SDK...");
+  const api = new MetaApi();
+
+  try {
+    const data = await api.getHealth();
+    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
+
+[**GetHealth200Response**](GetHealth200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getOpenApiSpec
+
+> object getOpenApiSpec()
+
+OpenAPI 3.1 specification
+
+The machine-readable specification of the PUBLISHED API surface — the same document the client SDKs are generated from. Endpoints marked `x-gpu-supply-paused` in the authoritative spec are absent from it while GPU supply is paused (D-28), so this response and the SDKs always describe the same surface.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MetaApi,
+} from '@deeprelay/sdk';
+import type { GetOpenApiSpecRequest } from '@deeprelay/sdk';
+
+async function example() {
+  console.log("🚀 Testing @deeprelay/sdk SDK...");
+  const api = new MetaApi();
+
+  try {
+    const data = await api.getOpenApiSpec();
+    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
+
+**object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+
+[[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/Model.md

@@ -0,0 +1,64 @@
+
+# Model
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`object` | string
+`created` | number
+`ownedBy` | string
+`author` | string
+`modality` | string
+`category` | string
+`contextLength` | number
+`supportedParameters` | Array<string>
+`parameters` | [Array<ModelParametersInner>](ModelParametersInner.md)
+`pricing` | [ModelPricing](ModelPricing.md)
+`aliases` | Array<string>
+`fineTunable` | boolean
+`fineTuneBaseModel` | string
+`planCovered` | boolean
+`status` | string
+
+## Example
+
+```typescript
+import type { Model } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "object": null,
+  "created": null,
+  "ownedBy": null,
+  "author": null,
+  "modality": null,
+  "category": null,
+  "contextLength": null,
+  "supportedParameters": null,
+  "parameters": null,
+  "pricing": null,
+  "aliases": null,
+  "fineTunable": null,
+  "fineTuneBaseModel": null,
+  "planCovered": null,
+  "status": null,
+} satisfies Model
+
+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 Model
+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/ModelList.md

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

@@ -0,0 +1,44 @@
+
+# ModelParametersInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`type` | string
+`_enum` | Array<string>
+`min` | number
+`max` | number
+`_default` | any
+
+## Example
+
+```typescript
+import type { ModelParametersInner } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "type": null,
+  "_enum": null,
+  "min": null,
+  "max": null,
+  "_default": null,
+} satisfies ModelParametersInner
+
+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 ModelParametersInner
+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/ModelPricing.md

@@ -0,0 +1,62 @@
+
+# ModelPricing
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`currency` | string
+`inputPer1mTokensCents` | number
+`outputPer1mTokensCents` | number
+`cachedInputPer1mTokensMicrocents` | number
+`cachedInputPer1mTokensCents` | number
+`perImageCents` | number
+`perImageMicrocents` | number
+`perMpxlMicrocents` | number
+`perVideoMicrocents` | number
+`perVideoSecondCents` | number
+`perVideoSecondMicrocents` | number
+`period` | string
+`peakWindowsUtc` | [Array<PeakWindow>](PeakWindow.md)
+`peak` | [ModelRate](ModelRate.md)
+`offPeak` | [ModelRate](ModelRate.md)
+
+## Example
+
+```typescript
+import type { ModelPricing } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "currency": null,
+  "inputPer1mTokensCents": null,
+  "outputPer1mTokensCents": null,
+  "cachedInputPer1mTokensMicrocents": null,
+  "cachedInputPer1mTokensCents": null,
+  "perImageCents": null,
+  "perImageMicrocents": null,
+  "perMpxlMicrocents": null,
+  "perVideoMicrocents": null,
+  "perVideoSecondCents": null,
+  "perVideoSecondMicrocents": null,
+  "period": null,
+  "peakWindowsUtc": null,
+  "peak": null,
+  "offPeak": null,
+} satisfies ModelPricing
+
+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 ModelPricing
+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/ModelRate.md

@@ -0,0 +1,45 @@
+
+# ModelRate
+
+One per-1M-token rate triple, in rounded cents and exact micro-cents (1e-6 cent). Prefer the micro-cent fields for arithmetic; cached rates are routinely sub-cent and their cents field is then omitted.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`inputPer1mTokensCents` | number
+`inputPer1mTokensMicrocents` | number
+`cachedInputPer1mTokensCents` | number
+`cachedInputPer1mTokensMicrocents` | number
+`outputPer1mTokensCents` | number
+`outputPer1mTokensMicrocents` | number
+
+## Example
+
+```typescript
+import type { ModelRate } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "inputPer1mTokensCents": null,
+  "inputPer1mTokensMicrocents": null,
+  "cachedInputPer1mTokensCents": null,
+  "cachedInputPer1mTokensMicrocents": null,
+  "outputPer1mTokensCents": null,
+  "outputPer1mTokensMicrocents": null,
+} satisfies ModelRate
+
+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 ModelRate
+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/OpenAIErrorEnvelope.md

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

@@ -0,0 +1,40 @@
+
+# OpenAIErrorEnvelopeError
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+`type` | string
+`param` | string
+`code` | string
+
+## Example
+
+```typescript
+import type { OpenAIErrorEnvelopeError } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": null,
+  "type": null,
+  "param": null,
+  "code": null,
+} satisfies OpenAIErrorEnvelopeError
+
+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 OpenAIErrorEnvelopeError
+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/Operation.md

@@ -0,0 +1,52 @@
+
+# Operation
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`operationId` | string
+`kind` | string
+`state` | string
+`resourceId` | string
+`error` | [OperationError](OperationError.md)
+`result` | [OperationResult](OperationResult.md)
+`createdAt` | Date
+`updatedAt` | Date
+`completedAt` | Date
+`warnings` | Array<string>
+
+## Example
+
+```typescript
+import type { Operation } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "operationId": null,
+  "kind": null,
+  "state": null,
+  "resourceId": null,
+  "error": null,
+  "result": null,
+  "createdAt": null,
+  "updatedAt": null,
+  "completedAt": null,
+  "warnings": null,
+} satisfies Operation
+
+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 Operation
+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/OperationError.md

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

@@ -0,0 +1,39 @@
+
+# OperationResult
+
+Terminal-success payload. Carries the per-instance web-access coordinates — app_url for template deploys, terminal_url for instances provisioned with the browser web console, and the basic-auth username shared by both. The basic-auth PASSWORD is never included here — retrieve it via GET /instances/{id}?include=credentials (connection.app_password).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`appUrl` | string
+`terminalUrl` | string
+`appBasicAuthUser` | string
+
+## Example
+
+```typescript
+import type { OperationResult } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "appUrl": null,
+  "terminalUrl": null,
+  "appBasicAuthUser": null,
+} satisfies OperationResult
+
+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 OperationResult
+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/OperationsApi.md

@@ -0,0 +1,80 @@
+# OperationsApi
+
+All URIs are relative to *https://api.deeprelay.ai/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getOperation**](OperationsApi.md#getoperation) | **GET** /operations/{id} | Get an async operation status |
+
+
+
+## getOperation
+
+> Operation getOperation(id)
+
+Get an async operation status
+
+### Example
+
+```ts
+import {
+  Configuration,
+  OperationsApi,
+} from '@deeprelay/sdk';
+import type { GetOperationRequest } 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 OperationsApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetOperationRequest;
+
+  try {
+    const data = await api.getOperation(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
+
+[**Operation**](Operation.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)
+