@gpuai/sdk 0.3.12 → 0.3.14

package/docs/WatchApi.md

@@ -0,0 +1,389 @@
+# WatchApi
+
+All URIs are relative to *https://api.gpu.ai/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createWatchRule**](WatchApi.md#createwatchrule) | **POST** /watch-rules | Create a watch rule |
+| [**deleteWatchRule**](WatchApi.md#deletewatchrule) | **DELETE** /watch-rules/{id} | Delete a watch rule |
+| [**getWatchRule**](WatchApi.md#getwatchrule) | **GET** /watch-rules/{id} | Get a watch rule |
+| [**listWatchRules**](WatchApi.md#listwatchrules) | **GET** /watch-rules | List watch rules |
+| [**updateWatchRule**](WatchApi.md#updatewatchrule) | **PATCH** /watch-rules/{id} | Update a watch rule |
+
+
+
+## createWatchRule
+
+> WatchRule createWatchRule(watchRuleCreate, idempotencyKey)
+
+Create a watch rule
+
+Creates a rule that notifies you when the market moves on a GPU model. Requires the `watch:write` scope (or `full_access`).  A watch rule ONLY notifies. It cannot launch capacity and cannot spend money: there is no field on this resource that provisions anything. Automatic launching is a separate resource with its own spend-consent gate.  Targeting is dimensional — a GPU model plus optional canonical region and capacity class. It is deliberately NOT possible to pin a rule to a specific catalog listing: listing identity is unstable, so a pinned rule can silently match nothing and never fire.  Delivery is to the organization\'s registered webhook endpoints, plus an email to the rule\'s creator. `webhook_endpoint_override_id` routes one rule to one specific endpoint and is the id of an endpoint already registered via `/webhook-endpoints` — the resource accepts no URL of any kind.  Organizations are limited to 50 ENABLED rules; the 422 names the limit. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WatchApi,
+} from '@gpuai/sdk';
+import type { CreateWatchRuleRequest } 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 WatchApi(config);
+
+  const body = {
+    // WatchRuleCreate
+    watchRuleCreate: ...,
+    // string (optional)
+    idempotencyKey: idempotencyKey_example,
+  } satisfies CreateWatchRuleRequest;
+
+  try {
+    const data = await api.createWatchRule(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **watchRuleCreate** | [WatchRuleCreate](WatchRuleCreate.md) |  | |
+| **idempotencyKey** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**WatchRule**](WatchRule.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 |  -  |
+| **422** | Validation failed — an unknown condition kind, a non-canonical region, a missing threshold on a threshold condition, an override id that is not an endpoint registered by this organization, a field naming a catalog listing or a delivery address, or the enabled-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)
+
+
+## deleteWatchRule
+
+> deleteWatchRule(id)
+
+Delete a watch rule
+
+Deletes a watch rule. Requires the &#x60;watch:write&#x60; scope (or &#x60;full_access&#x60;). Deleting an already-deleted rule returns 404. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WatchApi,
+} from '@gpuai/sdk';
+import type { DeleteWatchRuleRequest } 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 WatchApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies DeleteWatchRuleRequest;
+
+  try {
+    const data = await api.deleteWatchRule(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)
+
+
+## getWatchRule
+
+> WatchRule getWatchRule(id)
+
+Get a watch rule
+
+Fetches one watch rule. Requires the &#x60;watch:read&#x60; scope (or &#x60;full_access&#x60;). A rule belonging to another organization returns 404 — the same answer as an id that does not exist. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WatchApi,
+} from '@gpuai/sdk';
+import type { GetWatchRuleRequest } 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 WatchApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetWatchRuleRequest;
+
+  try {
+    const data = await api.getWatchRule(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
+
+[**WatchRule**](WatchRule.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)
+
+
+## listWatchRules
+
+> WatchRulePage listWatchRules(cursor, limit)
+
+List watch rules
+
+Lists this organization\&#39;s watch rules. Requires the &#x60;watch:read&#x60; scope (or &#x60;full_access&#x60;). Rules belonging to other organizations are never returned. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WatchApi,
+} from '@gpuai/sdk';
+import type { ListWatchRulesRequest } 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 WatchApi(config);
+
+  const body = {
+    // string (optional)
+    cursor: cursor_example,
+    // number (optional)
+    limit: 56,
+  } satisfies ListWatchRulesRequest;
+
+  try {
+    const data = await api.listWatchRules(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
+
+[**WatchRulePage**](WatchRulePage.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)
+
+
+## updateWatchRule
+
+> WatchRule updateWatchRule(id, watchRuleUpdate)
+
+Update a watch rule
+
+Partially updates a watch rule. Requires the &#x60;watch:write&#x60; scope (or &#x60;full_access&#x60;).  An ABSENT key keeps the stored value; an explicit &#x60;null&#x60; on &#x60;region&#x60;, &#x60;capacity_class&#x60; or &#x60;webhook_endpoint_override_id&#x60; CLEARS it back to \&quot;any\&quot; / \&quot;organization default\&quot;. The two are distinguished by which keys the body carries, so send only the keys you mean to change.  Editing a rule RE-ARMS it: the fired latch describes the condition that was replaced, so carrying it across an edit would suppress the first alert on the new one. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WatchApi,
+} from '@gpuai/sdk';
+import type { UpdateWatchRuleRequest } 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 WatchApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // WatchRuleUpdate
+    watchRuleUpdate: ...,
+  } satisfies UpdateWatchRuleRequest;
+
+  try {
+    const data = await api.updateWatchRule(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`] |
+| **watchRuleUpdate** | [WatchRuleUpdate](WatchRuleUpdate.md) |  | |
+
+### Return type
+
+[**WatchRule**](WatchRule.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** | Validation failed against the MERGED rule — for example switching to a threshold condition on a rule that has no stored threshold.  |  -  |
+| **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/WatchRule.md

@@ -0,0 +1,61 @@
+
+# WatchRule
+
+A rule that notifies when the market moves on a GPU model. It carries no upstream supplier identity of any kind, and no delivery address — those are properties of the resource, not of a particular response. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`gpuModel` | string
+`region` | string
+`capacityClass` | string
+`conditionKind` | string
+`threshold` | number
+`state` | string
+`lastFiredAt` | Date
+`quietUntil` | Date
+`webhookEndpointOverrideId` | string
+`enabled` | boolean
+`deactivatedReason` | string
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { WatchRule } 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,
+  "state": null,
+  "lastFiredAt": null,
+  "quietUntil": null,
+  "webhookEndpointOverrideId": null,
+  "enabled": null,
+  "deactivatedReason": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies WatchRule
+
+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 WatchRule
+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/WatchRuleCreate.md

@@ -0,0 +1,46 @@
+
+# WatchRuleCreate
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`gpuModel` | string
+`region` | string
+`capacityClass` | string
+`conditionKind` | string
+`threshold` | number
+`webhookEndpointOverrideId` | string
+`enabled` | boolean
+
+## Example
+
+```typescript
+import type { WatchRuleCreate } from '@gpuai/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "gpuModel": null,
+  "region": null,
+  "capacityClass": null,
+  "conditionKind": null,
+  "threshold": null,
+  "webhookEndpointOverrideId": null,
+  "enabled": null,
+} satisfies WatchRuleCreate
+
+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 WatchRuleCreate
+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/WatchRulePage.md

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

@@ -0,0 +1,47 @@
+
+# WatchRuleUpdate
+
+Partial update. An absent key keeps the stored value; an explicit null on region, capacity_class or webhook_endpoint_override_id clears it. The merged rule is re-validated as a whole. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`gpuModel` | string
+`region` | string
+`capacityClass` | string
+`conditionKind` | string
+`threshold` | number
+`webhookEndpointOverrideId` | string
+`enabled` | boolean
+
+## Example
+
+```typescript
+import type { WatchRuleUpdate } from '@gpuai/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "gpuModel": null,
+  "region": null,
+  "capacityClass": null,
+  "conditionKind": null,
+  "threshold": null,
+  "webhookEndpointOverrideId": null,
+  "enabled": null,
+} satisfies WatchRuleUpdate
+
+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 WatchRuleUpdate
+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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gpuai/sdk",
-  "version": "0.3.12",
+  "version": "0.3.14",
   "description": "TypeScript SDK for the GPU.ai Public Developer API",
   "author": "GPU.ai Support <support@gpu.ai>",
   "repository": {