@gpuai/sdk 0.2.4 → 0.2.5

package/README.md

@@ -1,4 +1,4 @@
-# @gpuai/sdk@0.2.4
+# @gpuai/sdk@0.2.5
 
 A TypeScript SDK client for the api.gpu.ai API.
 
@@ -191,7 +191,7 @@ and is automatically generated by the
 [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: `1.0.0`
-- Package version: `0.2.4`
+- Package version: `0.2.5`
 - Generator version: `7.24.0`
 - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
 

package/dist/apis/InstancesApi.d.ts

@@ -25,6 +25,7 @@ export interface DeleteInstanceRequest {
 }
 export interface GetInstanceRequest {
     id: string;
+    include?: GetInstanceIncludeEnum;
 }
 export interface ListInstancesRequest {
     cursor?: string;
@@ -105,6 +106,13 @@ export declare class InstancesApi extends runtime.BaseAPI {
      */
     updateInstance(requestParameters: UpdateInstanceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Instance>;
 }
+/**
+ * @export
+ */
+export declare const GetInstanceIncludeEnum: {
+    readonly Credentials: "credentials";
+};
+export type GetInstanceIncludeEnum = typeof GetInstanceIncludeEnum[keyof typeof GetInstanceIncludeEnum];
 /**
  * @export
  */

package/dist/apis/InstancesApi.js

@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ListInstancesStatusEnum = exports.InstancesApi = void 0;
+exports.ListInstancesStatusEnum = exports.GetInstanceIncludeEnum = exports.InstancesApi = void 0;
 const runtime = require("../runtime");
 const CreateInstanceRequest_1 = require("../models/CreateInstanceRequest");
 const Instance_1 = require("../models/Instance");
@@ -143,6 +143,9 @@ class InstancesApi extends runtime.BaseAPI {
                 throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getInstance().');
             }
             const queryParameters = {};
+            if (requestParameters['include'] != null) {
+                queryParameters['include'] = requestParameters['include'];
+            }
             const headerParameters = {};
             if (this.configuration && this.configuration.accessToken) {
                 const token = this.configuration.accessToken;
@@ -289,6 +292,12 @@ class InstancesApi extends runtime.BaseAPI {
     }
 }
 exports.InstancesApi = InstancesApi;
+/**
+ * @export
+ */
+exports.GetInstanceIncludeEnum = {
+    Credentials: 'credentials'
+};
 /**
  * @export
  */

package/dist/esm/apis/InstancesApi.d.ts

@@ -25,6 +25,7 @@ export interface DeleteInstanceRequest {
 }
 export interface GetInstanceRequest {
     id: string;
+    include?: GetInstanceIncludeEnum;
 }
 export interface ListInstancesRequest {
     cursor?: string;
@@ -105,6 +106,13 @@ export declare class InstancesApi extends runtime.BaseAPI {
      */
     updateInstance(requestParameters: UpdateInstanceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Instance>;
 }
+/**
+ * @export
+ */
+export declare const GetInstanceIncludeEnum: {
+    readonly Credentials: "credentials";
+};
+export type GetInstanceIncludeEnum = typeof GetInstanceIncludeEnum[keyof typeof GetInstanceIncludeEnum];
 /**
  * @export
  */

package/dist/esm/apis/InstancesApi.js

@@ -140,6 +140,9 @@ export class InstancesApi extends runtime.BaseAPI {
                 throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getInstance().');
             }
             const queryParameters = {};
+            if (requestParameters['include'] != null) {
+                queryParameters['include'] = requestParameters['include'];
+            }
             const headerParameters = {};
             if (this.configuration && this.configuration.accessToken) {
                 const token = this.configuration.accessToken;
@@ -285,6 +288,12 @@ export class InstancesApi extends runtime.BaseAPI {
         });
     }
 }
+/**
+ * @export
+ */
+export const GetInstanceIncludeEnum = {
+    Credentials: 'credentials'
+};
 /**
  * @export
  */

package/dist/esm/models/InstanceConnection.d.ts

@@ -46,7 +46,7 @@ export interface InstanceConnection {
      */
     appUser?: string;
     /**
-     * HTTP Basic Auth password for app_url and terminal_url. Same availability as app_user. Treat as a secret.
+     * HTTP Basic Auth password for app_url and terminal_url. Treat as a secret. OMITTED by default from all reads — returned only on GET /instances/{id}?include=credentials (same persistence availability as app_user); the list endpoint and operation results never include it.
      * @type {string}
      * @memberof InstanceConnection
      */

package/dist/esm/models/OperationResult.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 /**
- * Terminal-success payload. Carries the per-instance web-access credential — app_url for template deploys, terminal_url for instances provisioned with the browser web console, and the shared basic-auth login for both. The credential is also re-readable via connection.app_user/app_password on the org-scoped instance reads.
+ * Terminal-success payload. Carries the per-instance web-access coordinates — app_url for template deploys, terminal_url for instances provisioned with the browser web console, and the basic-auth username shared by both. The basic-auth PASSWORD is never included here — retrieve it via GET /instances/{id}?include=credentials (connection.app_password).
  * @export
  * @interface OperationResult
  */
@@ -33,12 +33,6 @@ export interface OperationResult {
      * @memberof OperationResult
      */
     appBasicAuthUser?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof OperationResult
-     */
-    appBasicAuthPass?: string;
 }
 /**
  * Check if a given object implements the OperationResult interface.

package/dist/esm/models/OperationResult.js

@@ -28,7 +28,6 @@ export function OperationResultFromJSONTyped(json, ignoreDiscriminator) {
         'appUrl': json['app_url'] == null ? undefined : json['app_url'],
         'terminalUrl': json['terminal_url'] == null ? undefined : json['terminal_url'],
         'appBasicAuthUser': json['app_basic_auth_user'] == null ? undefined : json['app_basic_auth_user'],
-        'appBasicAuthPass': json['app_basic_auth_pass'] == null ? undefined : json['app_basic_auth_pass'],
     };
 }
 export function OperationResultToJSON(json) {
@@ -42,6 +41,5 @@ export function OperationResultToJSONTyped(value, ignoreDiscriminator = false) {
         'app_url': value['appUrl'],
         'terminal_url': value['terminalUrl'],
         'app_basic_auth_user': value['appBasicAuthUser'],
-        'app_basic_auth_pass': value['appBasicAuthPass'],
     };
 }

package/dist/models/InstanceConnection.d.ts

@@ -46,7 +46,7 @@ export interface InstanceConnection {
      */
     appUser?: string;
     /**
-     * HTTP Basic Auth password for app_url and terminal_url. Same availability as app_user. Treat as a secret.
+     * HTTP Basic Auth password for app_url and terminal_url. Treat as a secret. OMITTED by default from all reads — returned only on GET /instances/{id}?include=credentials (same persistence availability as app_user); the list endpoint and operation results never include it.
      * @type {string}
      * @memberof InstanceConnection
      */

package/dist/models/OperationResult.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 /**
- * Terminal-success payload. Carries the per-instance web-access credential — app_url for template deploys, terminal_url for instances provisioned with the browser web console, and the shared basic-auth login for both. The credential is also re-readable via connection.app_user/app_password on the org-scoped instance reads.
+ * Terminal-success payload. Carries the per-instance web-access coordinates — app_url for template deploys, terminal_url for instances provisioned with the browser web console, and the basic-auth username shared by both. The basic-auth PASSWORD is never included here — retrieve it via GET /instances/{id}?include=credentials (connection.app_password).
  * @export
  * @interface OperationResult
  */
@@ -33,12 +33,6 @@ export interface OperationResult {
      * @memberof OperationResult
      */
     appBasicAuthUser?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof OperationResult
-     */
-    appBasicAuthPass?: string;
 }
 /**
  * Check if a given object implements the OperationResult interface.

package/dist/models/OperationResult.js

@@ -35,7 +35,6 @@ function OperationResultFromJSONTyped(json, ignoreDiscriminator) {
         'appUrl': json['app_url'] == null ? undefined : json['app_url'],
         'terminalUrl': json['terminal_url'] == null ? undefined : json['terminal_url'],
         'appBasicAuthUser': json['app_basic_auth_user'] == null ? undefined : json['app_basic_auth_user'],
-        'appBasicAuthPass': json['app_basic_auth_pass'] == null ? undefined : json['app_basic_auth_pass'],
     };
 }
 function OperationResultToJSON(json) {
@@ -49,6 +48,5 @@ function OperationResultToJSONTyped(value, ignoreDiscriminator = false) {
         'app_url': value['appUrl'],
         'terminal_url': value['terminalUrl'],
         'app_basic_auth_user': value['appBasicAuthUser'],
-        'app_basic_auth_pass': value['appBasicAuthPass'],
     };
 }

package/docs/InstancesApi.md

@@ -166,7 +166,7 @@ example().catch(console.error);
 
 ## getInstance
 
-> Instance getInstance(id)
+> Instance getInstance(id, include)
 
 Get an instance
 
@@ -190,6 +190,8 @@ async function example() {
   const body = {
     // string
     id: id_example,
+    // 'credentials' | Opt-in expansion. `credentials` restores connection.app_password on this single-instance read — the only surface that returns the web-console basic-auth password. Omitted by default so bare reads can be logged without leaking the secret. Any other value is a 400 validation_failed. The list endpoint and operation reads never return the password, with or without this parameter. (optional)
+    include: include_example,
   } satisfies GetInstanceRequest;
 
   try {
@@ -210,6 +212,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **id** | `string` |  | [Defaults to `undefined`] |
+| **include** | `credentials` | Opt-in expansion. `credentials` restores connection.app_password on this single-instance read — the only surface that returns the web-console basic-auth password. Omitted by default so bare reads can be logged without leaking the secret. Any other value is a 400 validation_failed. The list endpoint and operation reads never return the password, with or without this parameter. | [Optional] [Defaults to `undefined`] [Enum: credentials] |
 
 ### Return type
 

package/docs/OperationResult.md

@@ -1,7 +1,7 @@
 
 # OperationResult
 
-Terminal-success payload. Carries the per-instance web-access credential — app_url for template deploys, terminal_url for instances provisioned with the browser web console, and the shared basic-auth login for both. The credential is also re-readable via connection.app_user/app_password on the org-scoped instance reads.
+Terminal-success payload. Carries the per-instance web-access coordinates — app_url for template deploys, terminal_url for instances provisioned with the browser web console, and the basic-auth username shared by both. The basic-auth PASSWORD is never included here — retrieve it via GET /instances/{id}?include=credentials (connection.app_password).
 
 ## Properties
 
@@ -10,7 +10,6 @@ Name | Type
 `appUrl` | string
 `terminalUrl` | string
 `appBasicAuthUser` | string
-`appBasicAuthPass` | string
 
 ## Example
 
@@ -22,7 +21,6 @@ const example = {
   "appUrl": null,
   "terminalUrl": null,
   "appBasicAuthUser": null,
-  "appBasicAuthPass": null,
 } satisfies OperationResult
 
 console.log(example)

package/package.json

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

package/src/apis/InstancesApi.ts

@@ -56,6 +56,7 @@ export interface DeleteInstanceRequest {
 
 export interface GetInstanceRequest {
     id: string;
+    include?: GetInstanceIncludeEnum;
 }
 
 export interface ListInstancesRequest {
@@ -206,6 +207,10 @@ export class InstancesApi extends runtime.BaseAPI {
 
         const queryParameters: any = {};
 
+        if (requestParameters['include'] != null) {
+            queryParameters['include'] = requestParameters['include'];
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
         if (this.configuration && this.configuration.accessToken) {
@@ -374,6 +379,13 @@ export class InstancesApi extends runtime.BaseAPI {
 
 }
 
+/**
+ * @export
+ */
+export const GetInstanceIncludeEnum = {
+    Credentials: 'credentials'
+} as const;
+export type GetInstanceIncludeEnum = typeof GetInstanceIncludeEnum[keyof typeof GetInstanceIncludeEnum];
 /**
  * @export
  */

package/src/models/InstanceConnection.ts

@@ -50,7 +50,7 @@ export interface InstanceConnection {
      */
     appUser?: string;
     /**
-     * HTTP Basic Auth password for app_url and terminal_url. Same availability as app_user. Treat as a secret.
+     * HTTP Basic Auth password for app_url and terminal_url. Treat as a secret. OMITTED by default from all reads — returned only on GET /instances/{id}?include=credentials (same persistence availability as app_user); the list endpoint and operation results never include it.
      * @type {string}
      * @memberof InstanceConnection
      */

package/src/models/OperationResult.ts

@@ -14,7 +14,7 @@
 
 import { mapValues } from '../runtime';
 /**
- * Terminal-success payload. Carries the per-instance web-access credential — app_url for template deploys, terminal_url for instances provisioned with the browser web console, and the shared basic-auth login for both. The credential is also re-readable via connection.app_user/app_password on the org-scoped instance reads.
+ * Terminal-success payload. Carries the per-instance web-access coordinates — app_url for template deploys, terminal_url for instances provisioned with the browser web console, and the basic-auth username shared by both. The basic-auth PASSWORD is never included here — retrieve it via GET /instances/{id}?include=credentials (connection.app_password).
  * @export
  * @interface OperationResult
  */
@@ -37,12 +37,6 @@ export interface OperationResult {
      * @memberof OperationResult
      */
     appBasicAuthUser?: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof OperationResult
-     */
-    appBasicAuthPass?: string;
 }
 
 /**
@@ -65,7 +59,6 @@ export function OperationResultFromJSONTyped(json: any, ignoreDiscriminator: boo
         'appUrl': json['app_url'] == null ? undefined : json['app_url'],
         'terminalUrl': json['terminal_url'] == null ? undefined : json['terminal_url'],
         'appBasicAuthUser': json['app_basic_auth_user'] == null ? undefined : json['app_basic_auth_user'],
-        'appBasicAuthPass': json['app_basic_auth_pass'] == null ? undefined : json['app_basic_auth_pass'],
     };
 }
 
@@ -83,7 +76,6 @@ export function OperationResultToJSONTyped(value?: OperationResult | null, ignor
         'app_url': value['appUrl'],
         'terminal_url': value['terminalUrl'],
         'app_basic_auth_user': value['appBasicAuthUser'],
-        'app_basic_auth_pass': value['appBasicAuthPass'],
     };
 }