@gpuai/sdk 0.3.4 → 0.3.6

package/docs/RegistryCredentialsApi.md

@@ -0,0 +1,220 @@
+# RegistryCredentialsApi
+
+All URIs are relative to *https://api.gpu.ai/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createRegistryCredential**](RegistryCredentialsApi.md#createregistrycredentialoperation) | **POST** /registry-credentials | Store a registry credential |
+| [**deleteRegistryCredential**](RegistryCredentialsApi.md#deleteregistrycredential) | **DELETE** /registry-credentials/{id} | Delete a registry credential |
+| [**listRegistryCredentials**](RegistryCredentialsApi.md#listregistrycredentials) | **GET** /registry-credentials | List registry credentials |
+
+
+
+## createRegistryCredential
+
+> RegistryCredential createRegistryCredential(createRegistryCredentialRequest)
+
+Store a registry credential
+
+Stores a private-registry login for pulling private custom images. The password crosses the wire exactly once — here — and is encrypted at rest; no read ever returns it. Reference the returned id from `registry_credential_id` on instance creation. The credential\'s registry host must obey the same rules as image references (no localhost/private addresses); username and password must not contain whitespace. Duplicate names return 409 `name_taken`.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RegistryCredentialsApi,
+} from '@gpuai/sdk';
+import type { CreateRegistryCredentialOperationRequest } 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 RegistryCredentialsApi(config);
+
+  const body = {
+    // CreateRegistryCredentialRequest
+    createRegistryCredentialRequest: ...,
+  } satisfies CreateRegistryCredentialOperationRequest;
+
+  try {
+    const data = await api.createRegistryCredential(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createRegistryCredentialRequest** | [CreateRegistryCredentialRequest](CreateRegistryCredentialRequest.md) |  | |
+
+### Return type
+
+[**RegistryCredential**](RegistryCredential.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** | Credential stored (metadata only; no password) |  -  |
+| **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)
+
+
+## deleteRegistryCredential
+
+> deleteRegistryCredential(id)
+
+Delete a registry credential
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RegistryCredentialsApi,
+} from '@gpuai/sdk';
+import type { DeleteRegistryCredentialRequest } 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 RegistryCredentialsApi(config);
+
+  const body = {
+    // string
+    id: id_example,
+  } satisfies DeleteRegistryCredentialRequest;
+
+  try {
+    const data = await api.deleteRegistryCredential(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)
+
+
+## listRegistryCredentials
+
+> ListRegistryCredentials200Response listRegistryCredentials()
+
+List registry credentials
+
+Lists the organization\&#39;s stored private-registry logins for custom-image launches. Passwords are never returned by any read. 503 when the feature is not enabled on this environment.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  RegistryCredentialsApi,
+} from '@gpuai/sdk';
+import type { ListRegistryCredentialsRequest } 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 RegistryCredentialsApi(config);
+
+  try {
+    const data = await api.listRegistryCredentials();
+    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
+
+[**ListRegistryCredentials200Response**](ListRegistryCredentials200Response.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** | Credential list |  -  |
+| **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/package.json

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

package/src/apis/RegistryCredentialsApi.ts

@@ -0,0 +1,206 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * GPU.ai Public Developer API
+ * Programmatic API for GPU.ai. Authenticate with API keys minted from the dashboard. See https://gpu.ai/docs for details. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@gpu.ai
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import * as runtime from '../runtime';
+import {
+    type CreateRegistryCredentialRequest,
+    CreateRegistryCredentialRequestFromJSON,
+    CreateRegistryCredentialRequestToJSON,
+} from '../models/CreateRegistryCredentialRequest';
+import {
+    type ListRegistryCredentials200Response,
+    ListRegistryCredentials200ResponseFromJSON,
+    ListRegistryCredentials200ResponseToJSON,
+} from '../models/ListRegistryCredentials200Response';
+import {
+    type Problem,
+    ProblemFromJSON,
+    ProblemToJSON,
+} from '../models/Problem';
+import {
+    type RegistryCredential,
+    RegistryCredentialFromJSON,
+    RegistryCredentialToJSON,
+} from '../models/RegistryCredential';
+
+export interface CreateRegistryCredentialOperationRequest {
+    createRegistryCredentialRequest: CreateRegistryCredentialRequest;
+}
+
+export interface DeleteRegistryCredentialRequest {
+    id: string;
+}
+
+/**
+ * 
+ */
+export class RegistryCredentialsApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for createRegistryCredential without sending the request
+     */
+    async createRegistryCredentialRequestOpts(requestParameters: CreateRegistryCredentialOperationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['createRegistryCredentialRequest'] == null) {
+            throw new runtime.RequiredError(
+                'createRegistryCredentialRequest',
+                'Required parameter "createRegistryCredentialRequest" was null or undefined when calling createRegistryCredential().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/registry-credentials`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CreateRegistryCredentialRequestToJSON(requestParameters['createRegistryCredentialRequest']),
+        };
+    }
+
+    /**
+     * Stores a private-registry login for pulling private custom images. The password crosses the wire exactly once — here — and is encrypted at rest; no read ever returns it. Reference the returned id from `registry_credential_id` on instance creation. The credential\'s registry host must obey the same rules as image references (no localhost/private addresses); username and password must not contain whitespace. Duplicate names return 409 `name_taken`.
+     * Store a registry credential
+     */
+    async createRegistryCredentialRaw(requestParameters: CreateRegistryCredentialOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RegistryCredential>> {
+        const requestOptions = await this.createRegistryCredentialRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => RegistryCredentialFromJSON(jsonValue));
+    }
+
+    /**
+     * Stores a private-registry login for pulling private custom images. The password crosses the wire exactly once — here — and is encrypted at rest; no read ever returns it. Reference the returned id from `registry_credential_id` on instance creation. The credential\'s registry host must obey the same rules as image references (no localhost/private addresses); username and password must not contain whitespace. Duplicate names return 409 `name_taken`.
+     * Store a registry credential
+     */
+    async createRegistryCredential(requestParameters: CreateRegistryCredentialOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RegistryCredential> {
+        const response = await this.createRegistryCredentialRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for deleteRegistryCredential without sending the request
+     */
+    async deleteRegistryCredentialRequestOpts(requestParameters: DeleteRegistryCredentialRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling deleteRegistryCredential().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/registry-credentials/{id}`;
+        urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Delete a registry credential
+     */
+    async deleteRegistryCredentialRaw(requestParameters: DeleteRegistryCredentialRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deleteRegistryCredentialRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Delete a registry credential
+     */
+    async deleteRegistryCredential(requestParameters: DeleteRegistryCredentialRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deleteRegistryCredentialRaw(requestParameters, initOverrides);
+    }
+
+    /**
+     * Creates request options for listRegistryCredentials without sending the request
+     */
+    async listRegistryCredentialsRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/registry-credentials`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Lists the organization\'s stored private-registry logins for custom-image launches. Passwords are never returned by any read. 503 when the feature is not enabled on this environment.
+     * List registry credentials
+     */
+    async listRegistryCredentialsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListRegistryCredentials200Response>> {
+        const requestOptions = await this.listRegistryCredentialsRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ListRegistryCredentials200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Lists the organization\'s stored private-registry logins for custom-image launches. Passwords are never returned by any read. 503 when the feature is not enabled on this environment.
+     * List registry credentials
+     */
+    async listRegistryCredentials(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListRegistryCredentials200Response> {
+        const response = await this.listRegistryCredentialsRaw(initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/index.ts

@@ -10,6 +10,7 @@ export * from './InstancesApi';
 export * from './MetaApi';
 export * from './OperationsApi';
 export * from './PricingApi';
+export * from './RegistryCredentialsApi';
 export * from './SshKeysApi';
 export * from './TemplatesApi';
 export * from './UsageApi';

package/src/models/CreateInstanceRequest.ts

@@ -13,6 +13,14 @@
  */
 
 import { mapValues } from '../runtime';
+import type { CreateInstanceRequestPortsInner } from './CreateInstanceRequestPortsInner';
+import {
+    CreateInstanceRequestPortsInnerFromJSON,
+    CreateInstanceRequestPortsInnerFromJSONTyped,
+    CreateInstanceRequestPortsInnerToJSON,
+    CreateInstanceRequestPortsInnerToJSONTyped,
+} from './CreateInstanceRequestPortsInner';
+
 /**
  * 
  * @export
@@ -98,11 +106,35 @@ export interface CreateInstanceRequest {
      */
     env?: { [key: string]: string; };
     /**
-     * Launch from your own container image, e.g. `pytorch/pytorch:2.4.1-cuda12.4-cudnn9-devel` or `ghcr.io/acme/trainer:v1`. The image must be publicly pullable (private registries are not yet supported) and provide linux/amd64 — both are verified synchronously before anything is provisioned: an unknown image returns 422 `image_unavailable` and a registry outage 502 `registry_unreachable`, with no operation created and nothing billed. The launch is pinned to the exact manifest digest verified, so a tag re-push cannot change what boots. After SSH/tunnel setup the image's own ENTRYPOINT/CMD is started (its output is in /var/log/gpuai-entrypoint.log on the instance); an image with neither is a plain SSH environment. Placement narrows to container-native capacity — a gpu_type only available on VM capacity returns 422 `image_unavailable`. Mutually exclusive with `template_id` and `environment` (422). A malformed reference (bad charset, localhost/private-IP registry) returns 400.
+     * Launch from your own container image, e.g. `pytorch/pytorch:2.4.1-cuda12.4-cudnn9-devel` or `ghcr.io/acme/trainer:v1`. The image must be publicly pullable (private registries are not yet supported) and provide linux/amd64 — both are verified synchronously before anything is provisioned: an unknown image returns 422 `image_unavailable` and a registry outage 502 `registry_unreachable`, with no operation created and nothing billed. The launch is pinned to the exact manifest digest verified, so a tag re-push cannot change what boots. After SSH/tunnel setup the image's own ENTRYPOINT/CMD is started (its output is in /var/log/gpuai-entrypoint.log on the instance); an image with neither is a plain SSH environment. Placement prefers container-native capacity (the image runs natively; SSH lands inside it) and falls back to VM capacity (the image runs as a container beside the host's SSH — inspect with `docker logs gpuai-workload`); private images stay container-native. A gpu_type with no capable capacity returns 422 `image_unavailable`. Mutually exclusive with `template_id` and `environment` (422). A malformed reference (bad charset, localhost/private-IP registry) returns 400.
      * @type {string}
      * @memberof CreateInstanceRequest
      */
     image?: string;
+    /**
+     * Stored registry-credential id (POST /v1/registry-credentials) for pulling a PRIVATE `image`. The credential's registry must match the image's registry (422 otherwise); wrong logins fail the pre-flight with 422 `image_unavailable` before anything is provisioned. Requires `image`.
+     * @type {string}
+     * @memberof CreateInstanceRequest
+     */
+    registryCredentialId?: string;
+    /**
+     * Override the image's ENTRYPOINT (docker semantics — also drops the image CMD unless `cmd` is given). Omit to use the image's own. At most 32 arguments / 4KB. Requires `image`.
+     * @type {Array<string>}
+     * @memberof CreateInstanceRequest
+     */
+    entrypoint?: Array<string>;
+    /**
+     * Override the image's CMD. Omit to use the image's own (or none, when `entrypoint` is overridden). Requires `image`.
+     * @type {Array<string>}
+     * @memberof CreateInstanceRequest
+     */
+    cmd?: Array<string>;
+    /**
+     * Container ports to expose on a custom-image launch (at most 10; port 22 is reserved). At most one entry may be `primary` — it must be http and is served at the instance's app URL (`https://<id>.apps.gpu.ai`) behind the per-instance basic-auth login. Requires `image`.
+     * @type {Array<CreateInstanceRequestPortsInner>}
+     * @memberof CreateInstanceRequest
+     */
+    ports?: Array<CreateInstanceRequestPortsInner>;
 }
 
 
@@ -150,6 +182,10 @@ export function CreateInstanceRequestFromJSONTyped(json: any, ignoreDiscriminato
         'diskGb': json['disk_gb'] == null ? undefined : json['disk_gb'],
         'env': json['env'] == null ? undefined : json['env'],
         'image': json['image'] == null ? undefined : json['image'],
+        'registryCredentialId': json['registry_credential_id'] == null ? undefined : json['registry_credential_id'],
+        'entrypoint': json['entrypoint'] == null ? undefined : json['entrypoint'],
+        'cmd': json['cmd'] == null ? undefined : json['cmd'],
+        'ports': json['ports'] == null ? undefined : ((json['ports'] as Array<any>).map(CreateInstanceRequestPortsInnerFromJSON)),
     };
 }
 
@@ -178,6 +214,10 @@ export function CreateInstanceRequestToJSONTyped(value?: CreateInstanceRequest |
         'disk_gb': value['diskGb'],
         'env': value['env'],
         'image': value['image'],
+        'registry_credential_id': value['registryCredentialId'],
+        'entrypoint': value['entrypoint'],
+        'cmd': value['cmd'],
+        'ports': value['ports'] == null ? undefined : ((value['ports'] as Array<any>).map(CreateInstanceRequestPortsInnerToJSON)),
     };
 }
 

package/src/models/CreateInstanceRequestPortsInner.ts

@@ -0,0 +1,94 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * GPU.ai Public Developer API
+ * Programmatic API for GPU.ai. Authenticate with API keys minted from the dashboard. See https://gpu.ai/docs for details. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@gpu.ai
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface CreateInstanceRequestPortsInner
+ */
+export interface CreateInstanceRequestPortsInner {
+    /**
+     * 
+     * @type {number}
+     * @memberof CreateInstanceRequestPortsInner
+     */
+    port: number;
+    /**
+     * 
+     * @type {CreateInstanceRequestPortsInnerProtocolEnum}
+     * @memberof CreateInstanceRequestPortsInner
+     */
+    protocol: CreateInstanceRequestPortsInnerProtocolEnum;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof CreateInstanceRequestPortsInner
+     */
+    primary?: boolean;
+}
+
+
+/**
+ * @export
+ */
+export const CreateInstanceRequestPortsInnerProtocolEnum = {
+    Http: 'http',
+    Tcp: 'tcp'
+} as const;
+export type CreateInstanceRequestPortsInnerProtocolEnum = typeof CreateInstanceRequestPortsInnerProtocolEnum[keyof typeof CreateInstanceRequestPortsInnerProtocolEnum];
+
+
+/**
+ * Check if a given object implements the CreateInstanceRequestPortsInner interface.
+ */
+export function instanceOfCreateInstanceRequestPortsInner(value: object): value is CreateInstanceRequestPortsInner {
+    if (!('port' in value) || value['port'] === undefined) return false;
+    if (!('protocol' in value) || value['protocol'] === undefined) return false;
+    return true;
+}
+
+export function CreateInstanceRequestPortsInnerFromJSON(json: any): CreateInstanceRequestPortsInner {
+    return CreateInstanceRequestPortsInnerFromJSONTyped(json, false);
+}
+
+export function CreateInstanceRequestPortsInnerFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateInstanceRequestPortsInner {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'port': json['port'],
+        'protocol': json['protocol'],
+        'primary': json['primary'] == null ? undefined : json['primary'],
+    };
+}
+
+export function CreateInstanceRequestPortsInnerToJSON(json: any): CreateInstanceRequestPortsInner {
+    return CreateInstanceRequestPortsInnerToJSONTyped(json, false);
+}
+
+export function CreateInstanceRequestPortsInnerToJSONTyped(value?: CreateInstanceRequestPortsInner | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'port': value['port'],
+        'protocol': value['protocol'],
+        'primary': value['primary'],
+    };
+}
+