@gpuai/sdk 0.3.13 → 0.3.15

package/docs/AutolaunchApi.md

@@ -0,0 +1,390 @@
+# AutolaunchApi
+
+All URIs are relative to *https://api.gpu.ai/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createAutolaunchRule**](AutolaunchApi.md#createautolaunchrule) | **POST** /autolaunch-rules | Create an auto-launch rule (pre-approves a bounded, unattended spend) |
+| [**deleteAutolaunchRule**](AutolaunchApi.md#deleteautolaunchrule) | **DELETE** /autolaunch-rules/{id} | Cancel an auto-launch rule |
+| [**disarmAutolaunchRule**](AutolaunchApi.md#disarmautolaunchrule) | **PATCH** /autolaunch-rules/{id} | Disarm an auto-launch rule |
+| [**getAutolaunchRule**](AutolaunchApi.md#getautolaunchrule) | **GET** /autolaunch-rules/{id} | Get an auto-launch rule |
+| [**listAutolaunchRules**](AutolaunchApi.md#listautolaunchrules) | **GET** /autolaunch-rules | List auto-launch rules |
+
+
+
+## createAutolaunchRule
+
+> AutolaunchRule createAutolaunchRule(autolaunchRuleCreate, idempotencyKey)
+
+Create an auto-launch rule (pre-approves a bounded, unattended spend)
+
+Creates a standing, pre-approved purchase order. When the condition holds and the live price is at or under `max_price_per_hour`, the platform launches the frozen `spec` with no further confirmation from anyone — the customer is approving NOW for a purchase that happens LATER, while nobody is watching.  SCOPE. Requires the `autolaunch:write` scope, which is granted only EXPLICITLY. It is deliberately NOT covered by `full_access`, `standard` or `read_only`: `instances:write` is real-time authority, exercised with someone present, whereas this is a standing, frozen authorization that fires days later unattended. Treating them as the same authority class would have handed unattended spend authority to every key ever issued, including keys minted long before this resource existed. Most existing keys therefore receive 403 here; the correct response is to mint a key whose scopes map includes `{\"autolaunch\": \"write\"}`, never to retry, to substitute a key, or to fall back to a watch rule.  CONSENT. `acknowledged_max_total_usd` is REQUIRED and must equal `max_price_per_hour × max_runtime_hours` to within one cent. It is the API-level expression of \"a valid confirmation must come AFTER the price\": a caller that never computed the number cannot have shown it to anyone, and a caller that displayed a different number disagrees with what is about to be stored. Show the figure to the person approving the rule, then send it back.  TWO PRICES, TWO UNITS. `threshold` is the TRIGGER, in dollars per GPU-hour — the same unit the market chart and watch rules speak in. `max_price_per_hour` is the CEILING, in dollars per hour for the WHOLE instance. A 4-GPU rule triggering under $4.00/GPU-hr typically carries a $16.00/hr ceiling. Conflating them scales the customer\'s spend authorization by their GPU count.  FROZEN SPEC. `spec` is the full create-instance body the rule replays, validated at creation with the same validation a live create runs, so a spec that could never launch is refused while a human is present rather than at 3 a.m. `spec.offering_id` is REJECTED — offering identity churns between catalog polls, so a pin produces a rule that can never fire, which is the worst outcome here because the customer believes a purchase is armed. `spec.auto_terminate_hours` is overwritten from `max_runtime_hours` and must not be used to widen the bound.  Organizations are limited to 10 active rules; the 422 names the limit. The organization spending limit still applies as a backstop at fire time — a launch must fit both its own ceiling and the org cap. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AutolaunchApi,
+} from '@gpuai/sdk';
+import type { CreateAutolaunchRuleRequest } 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 AutolaunchApi(config);
+
+  const body = {
+    // AutolaunchRuleCreate
+    autolaunchRuleCreate: ...,
+    // string (optional)
+    idempotencyKey: idempotencyKey_example,
+  } satisfies CreateAutolaunchRuleRequest;
+
+  try {
+    const data = await api.createAutolaunchRule(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **autolaunchRuleCreate** | [AutolaunchRuleCreate](AutolaunchRuleCreate.md) |  | |
+| **idempotencyKey** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**AutolaunchRule**](AutolaunchRule.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 |
+|-------------|-------------|------------------|
+| **201** | Created |  -  |
+| **403** | The API key lacks `autolaunch:write`. This scope is explicit-grant only and is NOT covered by `full_access`, `standard` or `read_only`; the problem detail names the scope and the fix.  |  -  |
+| **422** | Validation failed — a missing or mismatched `acknowledged_max_total_usd`, a missing ceiling or runtime bound, an unknown condition kind, a non-canonical region, a missing threshold on a threshold condition, a `spec` that would not launch, a pinned `spec.offering_id`, or the active-rule limit already reached.  |  -  |
+| **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)
+
+
+## deleteAutolaunchRule
+
+> deleteAutolaunchRule(id)
+
+Cancel an auto-launch rule
+
+Deletes the rule and withdraws its pre-approved spend cap immediately. Requires only the &#x60;autolaunch:read&#x60; scope, for the same reason the disarm PATCH does. Deleting an already-deleted rule returns 404. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AutolaunchApi,
+} from '@gpuai/sdk';
+import type { DeleteAutolaunchRuleRequest } 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 AutolaunchApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies DeleteAutolaunchRuleRequest;
+
+  try {
+    const data = await api.deleteAutolaunchRule(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
+
+`void` (Empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/problem+json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Deleted |  -  |
+| **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)
+
+
+## disarmAutolaunchRule
+
+> AutolaunchRule disarmAutolaunchRule(id, autolaunchRuleDisarm)
+
+Disarm an auto-launch rule
+
+Disarms a rule. The body must be exactly &#x60;{\&quot;enabled\&quot;: false}&#x60; and nothing else. Requires only the &#x60;autolaunch:read&#x60; scope — cancelling a standing spend authorization is deliberately never harder than holding one, so a key narrowed since it created a rule can still stop that rule.  This is the entire update surface, and the absence is the design. Changing a ceiling, a runtime bound, the targeting or the frozen spec is a DIFFERENT bounded purchase, so it requires deleting the rule and creating a new one through the consent gate. Re-arming is refused too: a fired rule consumed its one shot, so &#x60;{\&quot;enabled\&quot;: true}&#x60; would resurrect a purchase order that was already consented to and spent. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AutolaunchApi,
+} from '@gpuai/sdk';
+import type { DisarmAutolaunchRuleRequest } 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 AutolaunchApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // AutolaunchRuleDisarm
+    autolaunchRuleDisarm: ...,
+  } satisfies DisarmAutolaunchRuleRequest;
+
+  try {
+    const data = await api.disarmAutolaunchRule(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`] |
+| **autolaunchRuleDisarm** | [AutolaunchRuleDisarm](AutolaunchRuleDisarm.md) |  | |
+
+### Return type
+
+[**AutolaunchRule**](AutolaunchRule.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 |  -  |
+| **422** | The body carried a key other than &#x60;enabled&#x60;, omitted &#x60;enabled&#x60;, or asked to re-arm the rule.  |  -  |
+| **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)
+
+
+## getAutolaunchRule
+
+> AutolaunchRule getAutolaunchRule(id)
+
+Get an auto-launch rule
+
+Fetches one auto-launch rule, including the frozen launch spec. Requires the &#x60;autolaunch:read&#x60; scope. A rule belonging to another organization returns 404 — the same answer as an id that does not exist. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AutolaunchApi,
+} from '@gpuai/sdk';
+import type { GetAutolaunchRuleRequest } 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 AutolaunchApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetAutolaunchRuleRequest;
+
+  try {
+    const data = await api.getAutolaunchRule(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
+
+[**AutolaunchRule**](AutolaunchRule.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)
+
+
+## listAutolaunchRules
+
+> AutolaunchRulePage listAutolaunchRules(cursor, limit)
+
+List auto-launch rules
+
+Lists this organization\&#39;s auto-launch rules. Requires the &#x60;autolaunch:read&#x60; scope, which &#x60;standard&#x60; and &#x60;full_access&#x60; keys carry. Rules belonging to other organizations are never returned, and rules created through the dashboard are included — the list is the organization\&#39;s, not the key\&#39;s. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AutolaunchApi,
+} from '@gpuai/sdk';
+import type { ListAutolaunchRulesRequest } 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 AutolaunchApi(config);
+
+  const body = {
+    // string (optional)
+    cursor: cursor_example,
+    // number (optional)
+    limit: 56,
+  } satisfies ListAutolaunchRulesRequest;
+
+  try {
+    const data = await api.listAutolaunchRules(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`] |
+
+### Return type
+
+[**AutolaunchRulePage**](AutolaunchRulePage.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/AutolaunchRule.md

@@ -0,0 +1,69 @@
+
+# AutolaunchRule
+
+A standing, pre-approved purchase order. It carries no upstream supplier identity, no org id, and no identifier of the API key that consented — the consenting principal is recorded in storage for the fire-time re-check, and a credential identifier has no business in a rule listing. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`gpuModel` | string
+`region` | string
+`capacityClass` | string
+`conditionKind` | string
+`threshold` | number
+`maxPricePerHour` | number
+`maxRuntimeHours` | number
+`maxTotalUsd` | number
+`spec` | { [key: string]: any; }
+`state` | string
+`attemptsThisEdge` | number
+`lastFailureReason` | string
+`launchedInstanceId` | string
+`createdBySurface` | string
+`enabled` | boolean
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { AutolaunchRule } from '@gpuai/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "gpuModel": null,
+  "region": null,
+  "capacityClass": null,
+  "conditionKind": null,
+  "threshold": null,
+  "maxPricePerHour": null,
+  "maxRuntimeHours": null,
+  "maxTotalUsd": null,
+  "spec": null,
+  "state": null,
+  "attemptsThisEdge": null,
+  "lastFailureReason": null,
+  "launchedInstanceId": null,
+  "createdBySurface": null,
+  "enabled": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies AutolaunchRule
+
+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 AutolaunchRule
+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/AutolaunchRuleCreate.md

@@ -0,0 +1,50 @@
+
+# AutolaunchRuleCreate
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`gpuModel` | string
+`region` | string
+`capacityClass` | string
+`conditionKind` | string
+`threshold` | number
+`maxPricePerHour` | number
+`maxRuntimeHours` | number
+`spec` | { [key: string]: any; }
+`acknowledgedMaxTotalUsd` | number
+
+## Example
+
+```typescript
+import type { AutolaunchRuleCreate } from '@gpuai/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "gpuModel": null,
+  "region": null,
+  "capacityClass": null,
+  "conditionKind": null,
+  "threshold": null,
+  "maxPricePerHour": null,
+  "maxRuntimeHours": null,
+  "spec": null,
+  "acknowledgedMaxTotalUsd": null,
+} satisfies AutolaunchRuleCreate
+
+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 AutolaunchRuleCreate
+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/AutolaunchRuleDisarm.md

@@ -0,0 +1,35 @@
+
+# AutolaunchRuleDisarm
+
+The entire PATCH surface. `enabled` must be present and must be false. Any other key is refused rather than accepted-and-ignored, because a PATCH carrying a new ceiling that returned 200 would leave the caller believing the cap had moved. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`enabled` | boolean
+
+## Example
+
+```typescript
+import type { AutolaunchRuleDisarm } from '@gpuai/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "enabled": null,
+} satisfies AutolaunchRuleDisarm
+
+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 AutolaunchRuleDisarm
+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/AutolaunchRulePage.md

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

@@ -0,0 +1,45 @@
+
+# Balance
+
+The organization\'s credit balance with its auto-pay configuration and live burn rate. Mirrors the dashboard\'s balance contract field for field. No payment-instrument detail appears here — saved cards live behind separate admin-only routes. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`balanceCents` | number
+`balanceDollars` | number
+`autoPayEnabled` | boolean
+`autoPayThresholdCents` | number
+`autoPayAmountCents` | number
+`burnCentsPerHour` | number
+
+## Example
+
+```typescript
+import type { Balance } from '@gpuai/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "balanceCents": null,
+  "balanceDollars": null,
+  "autoPayEnabled": null,
+  "autoPayThresholdCents": null,
+  "autoPayAmountCents": null,
+  "burnCentsPerHour": null,
+} satisfies Balance
+
+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 Balance
+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)
+
+