@gpuai/sdk 0.1.0

package/docs/Instance.md

@@ -0,0 +1,60 @@
+
+# Instance
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`status` | string
+`gpuType` | string
+`gpuCount` | number
+`region` | string
+`tier` | string
+`pricePerHour` | number
+`connection` | [InstanceConnection](InstanceConnection.md)
+`diskGb` | number
+`statusReason` | string
+`createdAt` | Date
+`readyAt` | Date
+`terminatedAt` | Date
+
+## Example
+
+```typescript
+import type { Instance } from '@gpuai/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "status": null,
+  "gpuType": null,
+  "gpuCount": null,
+  "region": null,
+  "tier": null,
+  "pricePerHour": null,
+  "connection": null,
+  "diskGb": null,
+  "statusReason": null,
+  "createdAt": null,
+  "readyAt": null,
+  "terminatedAt": null,
+} satisfies Instance
+
+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 Instance
+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/InstanceConnection.md

@@ -0,0 +1,46 @@
+
+# InstanceConnection
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`hostname` | string
+`port` | number
+`sshCommand` | string
+`appUrl` | string
+`appUser` | string
+`appPassword` | string
+`terminalUrl` | string
+
+## Example
+
+```typescript
+import type { InstanceConnection } from '@gpuai/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "hostname": null,
+  "port": null,
+  "sshCommand": null,
+  "appUrl": null,
+  "appUser": null,
+  "appPassword": null,
+  "terminalUrl": null,
+} satisfies InstanceConnection
+
+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 InstanceConnection
+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/InstancePage.md

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

@@ -0,0 +1,392 @@
+# InstancesApi
+
+All URIs are relative to *https://api.gpu.ai/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createInstance**](InstancesApi.md#createinstanceoperation) | **POST** /instances | Create an instance (async — returns 202 + Operation-Id header) |
+| [**deleteInstance**](InstancesApi.md#deleteinstance) | **DELETE** /instances/{id} | Terminate an instance (idempotent) |
+| [**getInstance**](InstancesApi.md#getinstance) | **GET** /instances/{id} | Get an instance |
+| [**listInstances**](InstancesApi.md#listinstances) | **GET** /instances | List instances |
+| [**updateInstance**](InstancesApi.md#updateinstanceoperation) | **PATCH** /instances/{id} | Update an instance (rename only in v1) |
+
+
+
+## createInstance
+
+> Operation createInstance(createInstanceRequest, idempotencyKey)
+
+Create an instance (async — returns 202 + Operation-Id header)
+
+### Example
+
+```ts
+import {
+  Configuration,
+  InstancesApi,
+} from '@gpuai/sdk';
+import type { CreateInstanceOperationRequest } 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 InstancesApi(config);
+
+  const body = {
+    // CreateInstanceRequest
+    createInstanceRequest: ...,
+    // string (optional)
+    idempotencyKey: idempotencyKey_example,
+  } satisfies CreateInstanceOperationRequest;
+
+  try {
+    const data = await api.createInstance(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createInstanceRequest** | [CreateInstanceRequest](CreateInstanceRequest.md) |  | |
+| **idempotencyKey** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**Operation**](Operation.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`, `application/problem+json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **202** | Accepted; long-running operation |  * Operation-Id - Use GET /operations/{id} to poll <br>  |
+| **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)
+
+
+## deleteInstance
+
+> Operation deleteInstance(id, idempotencyKey)
+
+Terminate an instance (idempotent)
+
+Members can terminate only instances they created; organization admins can terminate any instance in the organization.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  InstancesApi,
+} from '@gpuai/sdk';
+import type { DeleteInstanceRequest } 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 InstancesApi(config);
+
+  const body = {
+    // string
+    id: id_example,
+    // string (optional)
+    idempotencyKey: idempotencyKey_example,
+  } satisfies DeleteInstanceRequest;
+
+  try {
+    const data = await api.deleteInstance(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`] |
+| **idempotencyKey** | `string` |  | [Optional] [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 |
+|-------------|-------------|------------------|
+| **202** | Accepted; termination in progress |  * Operation-Id -  <br>  |
+| **403** | Forbidden — members can only terminate instances they created |  -  |
+| **404** | Already gone — idempotent terminate (D-07) |  -  |
+| **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)
+
+
+## getInstance
+
+> Instance getInstance(id)
+
+Get an instance
+
+### Example
+
+```ts
+import {
+  Configuration,
+  InstancesApi,
+} from '@gpuai/sdk';
+import type { GetInstanceRequest } 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 InstancesApi(config);
+
+  const body = {
+    // string
+    id: id_example,
+  } satisfies GetInstanceRequest;
+
+  try {
+    const data = await api.getInstance(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
+
+[**Instance**](Instance.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)
+
+
+## listInstances
+
+> InstancePage listInstances(cursor, limit, status)
+
+List instances
+
+Lists the organization\&#39;s instances. By default terminated instances are excluded; pass status&#x3D;terminated for the history or status&#x3D;all for everything.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  InstancesApi,
+} from '@gpuai/sdk';
+import type { ListInstancesRequest } 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 InstancesApi(config);
+
+  const body = {
+    // string (optional)
+    cursor: cursor_example,
+    // number (optional)
+    limit: 56,
+    // 'allocating' | 'starting' | 'running' | 'stopping' | 'stopped' | 'terminated' | 'error' | 'all' | Filter by customer-facing status (default = all non-terminated) (optional)
+    status: status_example,
+  } satisfies ListInstancesRequest;
+
+  try {
+    const data = await api.listInstances(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **cursor** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **limit** | `number` |  | [Optional] [Defaults to `50`] |
+| **status** | `allocating`, `starting`, `running`, `stopping`, `stopped`, `terminated`, `error`, `all` | Filter by customer-facing status (default &#x3D; all non-terminated) | [Optional] [Defaults to `undefined`] [Enum: allocating, starting, running, stopping, stopped, terminated, error, all] |
+
+### Return type
+
+[**InstancePage**](InstancePage.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)
+
+
+## updateInstance
+
+> Instance updateInstance(id, updateInstanceRequest, idempotencyKey)
+
+Update an instance (rename only in v1)
+
+### Example
+
+```ts
+import {
+  Configuration,
+  InstancesApi,
+} from '@gpuai/sdk';
+import type { UpdateInstanceOperationRequest } 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 InstancesApi(config);
+
+  const body = {
+    // string
+    id: id_example,
+    // UpdateInstanceRequest
+    updateInstanceRequest: ...,
+    // string (optional)
+    idempotencyKey: idempotencyKey_example,
+  } satisfies UpdateInstanceOperationRequest;
+
+  try {
+    const data = await api.updateInstance(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`] |
+| **updateInstanceRequest** | [UpdateInstanceRequest](UpdateInstanceRequest.md) |  | |
+| **idempotencyKey** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**Instance**](Instance.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **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/ListCommunityMachines200Response.md

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

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