@gpuai/sdk 0.1.0

package/docs/SupplierMachineView.md

@@ -0,0 +1,69 @@
+
+# SupplierMachineView
+
+The supplier-facing projection of a community machine. `occupied` replaces the renting customer\'s instance id (never exposed to the supplier); `online` is the server-derived 60s-heartbeat liveness.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`machineId` | string
+`gpuType` | string
+`gpuCount` | number
+`vramPerGpuGb` | number
+`pricePerHour` | number
+`region` | string
+`tier` | string
+`status` | string
+`verificationStatus` | string
+`online` | boolean
+`lastHeartbeatAt` | Date
+`firstHeartbeatAt` | Date
+`occupied` | boolean
+`reliabilityScore` | number
+`delistReason` | string
+`suspendReason` | string
+`agentVersion` | string
+`createdAt` | Date
+
+## Example
+
+```typescript
+import type { SupplierMachineView } from '@gpuai/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "machineId": null,
+  "gpuType": null,
+  "gpuCount": null,
+  "vramPerGpuGb": null,
+  "pricePerHour": null,
+  "region": null,
+  "tier": null,
+  "status": null,
+  "verificationStatus": null,
+  "online": null,
+  "lastHeartbeatAt": null,
+  "firstHeartbeatAt": null,
+  "occupied": null,
+  "reliabilityScore": null,
+  "delistReason": null,
+  "suspendReason": null,
+  "agentVersion": null,
+  "createdAt": null,
+} satisfies SupplierMachineView
+
+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 SupplierMachineView
+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/Template.md

@@ -0,0 +1,59 @@
+
+# Template
+
+A deployable application template. The container image (registry path) and start command are internal orchestration details and are intentionally absent from this schema (TMPL-13 defense-by-omission).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`displayName` | string
+`category` | string
+`kind` | string
+`status` | string
+`containerDiskGb` | number
+`minVramGb` | number
+`minGpuCount` | number
+`ports` | [Array<TemplatePortsInner>](TemplatePortsInner.md)
+`env` | [Array<TemplateEnvInner>](TemplateEnvInner.md)
+`docsUrl` | string
+`description` | string
+`includes` | Array<string>
+
+## Example
+
+```typescript
+import type { Template } from '@gpuai/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "displayName": null,
+  "category": null,
+  "kind": null,
+  "status": null,
+  "containerDiskGb": null,
+  "minVramGb": null,
+  "minGpuCount": null,
+  "ports": null,
+  "env": null,
+  "docsUrl": null,
+  "description": null,
+  "includes": null,
+} satisfies Template
+
+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 Template
+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/TemplateEnvInner.md

@@ -0,0 +1,40 @@
+
+# TemplateEnvInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`key` | string
+`_default` | string
+`userOverridable` | boolean
+`secret` | boolean
+
+## Example
+
+```typescript
+import type { TemplateEnvInner } from '@gpuai/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "key": null,
+  "_default": null,
+  "userOverridable": null,
+  "secret": null,
+} satisfies TemplateEnvInner
+
+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 TemplateEnvInner
+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/TemplateList.md

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

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

@@ -0,0 +1,145 @@
+# TemplatesApi
+
+All URIs are relative to *https://api.gpu.ai/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getTemplate**](TemplatesApi.md#gettemplate) | **GET** /templates/{id} | Get one deployable application template |
+| [**listTemplates**](TemplatesApi.md#listtemplates) | **GET** /templates | List deployable application templates |
+
+
+
+## getTemplate
+
+> Template getTemplate(id)
+
+Get one deployable application template
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TemplatesApi,
+} from '@gpuai/sdk';
+import type { GetTemplateRequest } from '@gpuai/sdk';
+
+async function example() {
+  console.log("🚀 Testing @gpuai/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new TemplatesApi(config);
+
+  const body = {
+    // string
+    id: id_example,
+  } satisfies GetTemplateRequest;
+
+  try {
+    const data = await api.getTemplate(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
+
+[**Template**](Template.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 |  -  |
+| **404** | Error response (RFC 7807) |  -  |
+| **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)
+
+
+## listTemplates
+
+> TemplateList listTemplates()
+
+List deployable application templates
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TemplatesApi,
+} from '@gpuai/sdk';
+import type { ListTemplatesRequest } from '@gpuai/sdk';
+
+async function example() {
+  console.log("🚀 Testing @gpuai/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new TemplatesApi(config);
+
+  try {
+    const data = await api.listTemplates();
+    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
+
+[**TemplateList**](TemplateList.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/UpdateCommunityMachineRequest.md

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

@@ -0,0 +1,34 @@
+
+# UpdateInstanceRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+
+## Example
+
+```typescript
+import type { UpdateInstanceRequest } from '@gpuai/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+} satisfies UpdateInstanceRequest
+
+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 UpdateInstanceRequest
+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 '@gpuai/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 '@gpuai/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.gpu.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 '@gpuai/sdk';
+import type { ListUsageRequest } from '@gpuai/sdk';
+
+async function example() {
+  console.log("🚀 Testing @gpuai/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 '@gpuai/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)
+
+