@deeprelay/sdk 0.0.1 → 0.1.1

package/docs/ChatCompletionRequest.md

@@ -0,0 +1,44 @@
+
+# ChatCompletionRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`model` | string
+`messages` | [Array<ChatMessage>](ChatMessage.md)
+`temperature` | number
+`maxTokens` | number
+`stream` | boolean
+`streamOptions` | [StreamOptions](StreamOptions.md)
+
+## Example
+
+```typescript
+import type { ChatCompletionRequest } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "model": null,
+  "messages": null,
+  "temperature": null,
+  "maxTokens": null,
+  "stream": null,
+  "streamOptions": null,
+} satisfies ChatCompletionRequest
+
+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 ChatCompletionRequest
+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/ChatCompletionResponse.md

@@ -0,0 +1,44 @@
+
+# ChatCompletionResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`object` | string
+`created` | number
+`model` | string
+`choices` | [Array<ChatChoice>](ChatChoice.md)
+`usage` | [Usage](Usage.md)
+
+## Example
+
+```typescript
+import type { ChatCompletionResponse } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "object": null,
+  "created": null,
+  "model": null,
+  "choices": null,
+  "usage": null,
+} satisfies ChatCompletionResponse
+
+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 ChatCompletionResponse
+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

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

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

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

@@ -0,0 +1,55 @@
+
+# CryptoDeposit
+
+A stablecoin deposit. Mirrors the Go DTO field for field. Like that struct, this schema deliberately has NO payment-processor property — the processor is an implementation detail and is structurally absent from the customer contract, not merely filtered out. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`depositId` | string
+`status` | string
+`chain` | string
+`asset` | string
+`payAddress` | string
+`payAmount` | string
+`amountUsdCents` | number
+`creditedCents` | number
+`txHash` | string
+`expiresAt` | Date
+`createdAt` | Date
+
+## Example
+
+```typescript
+import type { CryptoDeposit } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "depositId": null,
+  "status": null,
+  "chain": null,
+  "asset": null,
+  "payAddress": null,
+  "payAmount": null,
+  "amountUsdCents": null,
+  "creditedCents": null,
+  "txHash": null,
+  "expiresAt": null,
+  "createdAt": null,
+} satisfies CryptoDeposit
+
+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 CryptoDeposit
+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/Embedding.md

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

@@ -0,0 +1,42 @@
+
+# EmbeddingsRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`model` | string
+`input` | [EmbeddingsRequestInput](EmbeddingsRequestInput.md)
+`encodingFormat` | string
+`dimensions` | number
+`user` | string
+
+## Example
+
+```typescript
+import type { EmbeddingsRequest } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "model": null,
+  "input": null,
+  "encodingFormat": null,
+  "dimensions": null,
+  "user": null,
+} satisfies EmbeddingsRequest
+
+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 EmbeddingsRequest
+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/EmbeddingsRequestInput.md

@@ -0,0 +1,33 @@
+
+# EmbeddingsRequestInput
+
+Text to embed: either a single string or an array of up to 2048 strings. Token-id arrays are not supported. The per-request ceiling is bounded so the response stays under 64 MiB — about 680 inputs at 4096 dimensions, fewer at a larger `dimensions` value; an over-limit batch is rejected with 400 invalid_request_error whose message states the limit, before any processing.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { EmbeddingsRequestInput } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies EmbeddingsRequestInput
+
+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 EmbeddingsRequestInput
+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/EmbeddingsResponse.md

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

@@ -0,0 +1,37 @@
+
+# EmbeddingsUsage
+
+Embeddings are billed on input tokens only, so this block carries no completion_tokens field — an embeddings call emits none, and total_tokens always equals prompt_tokens.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`promptTokens` | number
+`totalTokens` | number
+
+## Example
+
+```typescript
+import type { EmbeddingsUsage } from '@deeprelay/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "promptTokens": null,
+  "totalTokens": null,
+} satisfies EmbeddingsUsage
+
+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 EmbeddingsUsage
+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/GetHealth200Response.md

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

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

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

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

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