@gpuai/sdk 0.1.0

package/docs/CommunityEarnings.md

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

@@ -0,0 +1,44 @@
+
+# CommunityEarningsEntry
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ledgerId` | string
+`machineId` | string
+`instanceId` | string
+`amountCents` | number
+`accruedAt` | Date
+`paid` | boolean
+
+## Example
+
+```typescript
+import type { CommunityEarningsEntry } from '@gpuai/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ledgerId": null,
+  "machineId": null,
+  "instanceId": null,
+  "amountCents": null,
+  "accruedAt": null,
+  "paid": null,
+} satisfies CommunityEarningsEntry
+
+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 CommunityEarningsEntry
+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/CommunityMachine.md

@@ -0,0 +1,57 @@
+
+# CommunityMachine
+
+A self-declared Community Cloud machine. Spec fields are optional and unverified until Phase 57. The enrollment token hash is never serialized.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`machineId` | string
+`supplierId` | string
+`gpuType` | string
+`gpuCount` | number
+`vramPerGpuGb` | number
+`pricePerHour` | number
+`region` | string
+`tier` | string
+`status` | string
+`verificationStatus` | string
+`lastHeartbeatAt` | Date
+`createdAt` | Date
+
+## Example
+
+```typescript
+import type { CommunityMachine } from '@gpuai/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "machineId": null,
+  "supplierId": null,
+  "gpuType": null,
+  "gpuCount": null,
+  "vramPerGpuGb": null,
+  "pricePerHour": null,
+  "region": null,
+  "tier": null,
+  "status": null,
+  "verificationStatus": null,
+  "lastHeartbeatAt": null,
+  "createdAt": null,
+} satisfies CommunityMachine
+
+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 CommunityMachine
+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/CommunityMachineDelistResult.md

@@ -0,0 +1,37 @@
+
+# CommunityMachineDelistResult
+
+The terminal status a machine reached after a delist. `draining` means it was occupied and the existing rental keeps running (never killed); `delisted` means it was idle and left supply immediately.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`machineId` | string
+`status` | string
+
+## Example
+
+```typescript
+import type { CommunityMachineDelistResult } from '@gpuai/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "machineId": null,
+  "status": null,
+} satisfies CommunityMachineDelistResult
+
+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 CommunityMachineDelistResult
+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/CommunityMachineRegistration.md

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

@@ -0,0 +1,43 @@
+
+# CommunitySupplier
+
+One organization\'s Community Cloud supplier profile (ONBD-01).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`supplierId` | string
+`orgId` | string
+`status` | string
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { CommunitySupplier } from '@gpuai/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "supplierId": null,
+  "orgId": null,
+  "status": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies CommunitySupplier
+
+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 CommunitySupplier
+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 '@gpuai/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/CreateFineTuningJobRequest.md

@@ -0,0 +1,45 @@
+
+# CreateFineTuningJobRequest
+
+Request body for POST /fine_tuning/jobs. The `method` object carries the Axolotl LoRA/QLoRA hyperparameters; `gpuai` is a native extension for the optional budget cap and GPU preference. The backing training environment (image, GPU provider) is an internal orchestration detail and is intentionally absent from this schema (privacy-by-omission, D6).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`model` | string
+`trainingFile` | string
+`suffix` | string
+`seed` | number
+`method` | [CreateFineTuningJobRequestMethod](CreateFineTuningJobRequestMethod.md)
+`gpuai` | [CreateFineTuningJobRequestGpuai](CreateFineTuningJobRequestGpuai.md)
+
+## Example
+
+```typescript
+import type { CreateFineTuningJobRequest } from '@gpuai/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "model": null,
+  "trainingFile": null,
+  "suffix": null,
+  "seed": null,
+  "method": null,
+  "gpuai": null,
+} satisfies CreateFineTuningJobRequest
+
+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 CreateFineTuningJobRequest
+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/CreateFineTuningJobRequestGpuai.md

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

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

@@ -0,0 +1,38 @@
+
+# CreateFineTuningJobRequestMethodLora
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`loraR` | number
+`loraAlpha` | number
+`loraDropout` | number
+
+## Example
+
+```typescript
+import type { CreateFineTuningJobRequestMethodLora } from '@gpuai/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "loraR": null,
+  "loraAlpha": null,
+  "loraDropout": null,
+} satisfies CreateFineTuningJobRequestMethodLora
+
+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 CreateFineTuningJobRequestMethodLora
+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/CreateInstanceRequest.md

@@ -0,0 +1,56 @@
+
+# CreateInstanceRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`gpuType` | string
+`gpuCount` | number
+`region` | string
+`tier` | string
+`sshKeyIds` | Array<string>
+`name` | string
+`maxPricePerHour` | number
+`templateId` | string
+`environment` | string
+`offeringId` | string
+`diskGb` | number
+`env` | { [key: string]: string; }
+
+## Example
+
+```typescript
+import type { CreateInstanceRequest } from '@gpuai/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "gpuType": null,
+  "gpuCount": null,
+  "region": null,
+  "tier": null,
+  "sshKeyIds": null,
+  "name": null,
+  "maxPricePerHour": null,
+  "templateId": null,
+  "environment": certified:pytorch@2.13,
+  "offeringId": null,
+  "diskGb": 200,
+  "env": null,
+} satisfies CreateInstanceRequest
+
+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 CreateInstanceRequest
+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/CreateSshKeyRequest.md

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

@@ -0,0 +1,41 @@
+
+# Environments
+
+The launch environment catalog (GET /v1/environments).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`frameworks` | Array<string>
+`versions` | { [key: string]: Array<FrameworkVersion>; }
+`includes` | { [key: string]: { [key: string]: Array<IncludeItem>; }; }
+`vmImages` | [{ [key: string]: VMImage; }](VMImage.md)
+
+## Example
+
+```typescript
+import type { Environments } from '@gpuai/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "frameworks": [pytorch, cuda-devel, jupyter],
+  "versions": null,
+  "includes": null,
+  "vmImages": null,
+} satisfies Environments
+
+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 Environments
+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)
+
+