feat(api): update via SDK Studio

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 10
+configured_endpoints: 8
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/the-san-francisco-compute-company%2Fsfc-nodes-b800806859333bacc88fa4236eae35c8cdbec62970b7fb9ad440a330f24a1622.yml
 openapi_spec_hash: fa672b6ca8953a8059961a7559a607a9
-config_hash: 499c74ded37140a0ec9c4acdafb8e634
+config_hash: e089259785c0c81187a2b25ae04b8459

README.md

@@ -26,7 +26,7 @@ The full API of this library can be found in [api.md](api.md).
 import SFCNodes from 'sfc-nodes';
 
 const client = new SFCNodes({
-  bearerToken: process.env['SFC_BEARER_TOKEN'], // This is the default and can be omitted
+  apiKey: process.env['SFC_API_KEY'], // This is the default and can be omitted
 });
 
 const nodes = await client.nodes.list();
@@ -41,7 +41,7 @@ This library includes TypeScript definitions for all request params and response
 import SFCNodes from 'sfc-nodes';
 
 const client = new SFCNodes({
-  bearerToken: process.env['SFC_BEARER_TOKEN'], // This is the default and can be omitted
+  apiKey: process.env['SFC_API_KEY'], // This is the default and can be omitted
 });
 
 const nodes: SFCNodes.NodeListResponse = await client.nodes.list();

api.md

@@ -2,16 +2,12 @@
 
 Types:
 
-- <code><a href="./src/resources/vms/vms.ts">VmListResponse</a></code>
 - <code><a href="./src/resources/vms/vms.ts">VmLogsResponse</a></code>
-- <code><a href="./src/resources/vms/vms.ts">VmReplaceResponse</a></code>
 - <code><a href="./src/resources/vms/vms.ts">VmSSHResponse</a></code>
 
 Methods:
 
-- <code title="get /v0/vms/instances">client.vms.<a href="./src/resources/vms/vms.ts">list</a>() -> VmListResponse</code>
 - <code title="get /v0/vms/logs2">client.vms.<a href="./src/resources/vms/vms.ts">logs</a>({ ...params }) -> VmLogsResponse</code>
-- <code title="post /v0/vms/replace">client.vms.<a href="./src/resources/vms/vms.ts">replace</a>({ ...params }) -> VmReplaceResponse</code>
 - <code title="get /v0/vms/ssh">client.vms.<a href="./src/resources/vms/vms.ts">ssh</a>({ ...params }) -> VmSSHResponse</code>
 
 ## Script

src/client.ts

@@ -27,16 +27,7 @@ import {
   Nodes,
   UpdateNode,
 } from './resources/nodes';
-import {
-  VmListResponse,
-  VmLogsParams,
-  VmLogsResponse,
-  VmReplaceParams,
-  VmReplaceResponse,
-  VmSSHParams,
-  VmSSHResponse,
-  Vms,
-} from './resources/vms/vms';
+import { VmLogsParams, VmLogsResponse, VmSSHParams, VmSSHResponse, Vms } from './resources/vms/vms';
 import { type Fetch } from './internal/builtin-types';
 import { HeadersLike, NullableHeaders, buildHeaders } from './internal/headers';
 import { FinalRequestOptions, RequestOptions } from './internal/request-options';
@@ -52,9 +43,9 @@ import { isEmptyObj } from './internal/utils/values';
 
 export interface ClientOptions {
   /**
-   * Defaults to process.env['SFC_BEARER_TOKEN'].
+   * Defaults to process.env['SFC_API_KEY'].
    */
-  bearerToken?: string | null | undefined;
+  apiKey?: string | null | undefined;
 
   /**
    * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
@@ -129,7 +120,7 @@ export interface ClientOptions {
  * API Client for interfacing with the SFC Nodes API.
  */
 export class SFCNodes {
-  bearerToken: string | null;
+  apiKey: string | null;
 
   baseURL: string;
   maxRetries: number;
@@ -146,7 +137,7 @@ export class SFCNodes {
   /**
    * API Client for interfacing with the SFC Nodes API.
    *
-   * @param {string | null | undefined} [opts.bearerToken=process.env['SFC_BEARER_TOKEN'] ?? null]
+   * @param {string | null | undefined} [opts.apiKey=process.env['SFC_API_KEY'] ?? null]
    * @param {string} [opts.baseURL=process.env['SFC_NODES_BASE_URL'] ?? https://api.sfcompute.com] - Override the default base URL for the API.
    * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
    * @param {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls.
@@ -157,11 +148,11 @@ export class SFCNodes {
    */
   constructor({
     baseURL = readEnv('SFC_NODES_BASE_URL'),
-    bearerToken = readEnv('SFC_BEARER_TOKEN') ?? null,
+    apiKey = readEnv('SFC_API_KEY') ?? null,
     ...opts
   }: ClientOptions = {}) {
     const options: ClientOptions = {
-      bearerToken,
+      apiKey,
       ...opts,
       baseURL: baseURL || `https://api.sfcompute.com`,
     };
@@ -183,7 +174,7 @@ export class SFCNodes {
 
     this._options = options;
 
-    this.bearerToken = bearerToken;
+    this.apiKey = apiKey;
   }
 
   /**
@@ -199,7 +190,7 @@ export class SFCNodes {
       logLevel: this.logLevel,
       fetch: this.fetch,
       fetchOptions: this.fetchOptions,
-      bearerToken: this.bearerToken,
+      apiKey: this.apiKey,
       ...options,
     });
     return client;
@@ -217,23 +208,23 @@ export class SFCNodes {
   }
 
   protected validateHeaders({ values, nulls }: NullableHeaders) {
-    if (this.bearerToken && values.get('authorization')) {
+    if (this.apiKey && values.get('authorization')) {
       return;
     }
     if (nulls.has('authorization')) {
       return;
     }
 
     throw new Error(
-      'Could not resolve authentication method. Expected the bearerToken to be set. Or for the "Authorization" headers to be explicitly omitted',
+      'Could not resolve authentication method. Expected the apiKey to be set. Or for the "Authorization" headers to be explicitly omitted',
     );
   }
 
   protected async authHeaders(opts: FinalRequestOptions): Promise<NullableHeaders | undefined> {
-    if (this.bearerToken == null) {
+    if (this.apiKey == null) {
       return undefined;
     }
-    return buildHeaders([{ Authorization: `Bearer ${this.bearerToken}` }]);
+    return buildHeaders([{ Authorization: `Bearer ${this.apiKey}` }]);
   }
 
   /**
@@ -750,12 +741,9 @@ export declare namespace SFCNodes {
 
   export {
     Vms as Vms,
-    type VmListResponse as VmListResponse,
     type VmLogsResponse as VmLogsResponse,
-    type VmReplaceResponse as VmReplaceResponse,
     type VmSSHResponse as VmSSHResponse,
     type VmLogsParams as VmLogsParams,
-    type VmReplaceParams as VmReplaceParams,
     type VmSSHParams as VmSSHParams,
   };
 

src/resources/index.ts

@@ -11,13 +11,4 @@ export {
   type NodeExtendParams,
   type NodeReleaseParams,
 } from './nodes';
-export {
-  Vms,
-  type VmListResponse,
-  type VmLogsResponse,
-  type VmReplaceResponse,
-  type VmSSHResponse,
-  type VmLogsParams,
-  type VmReplaceParams,
-  type VmSSHParams,
-} from './vms/vms';
+export { Vms, type VmLogsResponse, type VmSSHResponse, type VmLogsParams, type VmSSHParams } from './vms/vms';

src/resources/vms/index.ts

@@ -7,13 +7,4 @@ export {
   type ScriptRetrieveResponse,
   type ScriptCreateParams,
 } from './script';
-export {
-  Vms,
-  type VmListResponse,
-  type VmLogsResponse,
-  type VmReplaceResponse,
-  type VmSSHResponse,
-  type VmLogsParams,
-  type VmReplaceParams,
-  type VmSSHParams,
-} from './vms';
+export { Vms, type VmLogsResponse, type VmSSHResponse, type VmLogsParams, type VmSSHParams } from './vms';

src/resources/vms/vms.ts

@@ -9,41 +9,15 @@ import { RequestOptions } from '../../internal/request-options';
 export class Vms extends APIResource {
   script: ScriptAPI.Script = new ScriptAPI.Script(this._client);
 
-  list(options?: RequestOptions): APIPromise<VmListResponse> {
-    return this._client.get('/v0/vms/instances', options);
-  }
-
   logs(query: VmLogsParams, options?: RequestOptions): APIPromise<VmLogsResponse> {
     return this._client.get('/v0/vms/logs2', { query, ...options });
   }
 
-  replace(body: VmReplaceParams, options?: RequestOptions): APIPromise<VmReplaceResponse> {
-    return this._client.post('/v0/vms/replace', { body, ...options });
-  }
-
   ssh(query: VmSSHParams, options?: RequestOptions): APIPromise<VmSSHResponse> {
     return this._client.get('/v0/vms/ssh', { query, ...options });
   }
 }
 
-export interface VmListResponse {
-  data: Array<VmListResponse.Data>;
-}
-
-export namespace VmListResponse {
-  export interface Data {
-    id: string;
-
-    cluster_id: string;
-
-    current_status: string;
-
-    instance_group_id: string;
-
-    last_updated_at: string;
-  }
-}
-
 export interface VmLogsResponse {
   data: Array<VmLogsResponse.Data>;
 }
@@ -67,12 +41,6 @@ export namespace VmLogsResponse {
   }
 }
 
-export interface VmReplaceResponse {
-  replaced: string;
-
-  replaced_by: string;
-}
-
 export interface VmSSHResponse {
   ssh_hostname: string;
 
@@ -105,10 +73,6 @@ export interface VmLogsParams {
   since_seqnum?: number;
 }
 
-export interface VmReplaceParams {
-  vm_id: string;
-}
-
 export interface VmSSHParams {
   vm_id: string;
 }
@@ -117,12 +81,9 @@ Vms.Script = Script;
 
 export declare namespace Vms {
   export {
-    type VmListResponse as VmListResponse,
     type VmLogsResponse as VmLogsResponse,
-    type VmReplaceResponse as VmReplaceResponse,
     type VmSSHResponse as VmSSHResponse,
     type VmLogsParams as VmLogsParams,
-    type VmReplaceParams as VmReplaceParams,
     type VmSSHParams as VmSSHParams,
   };
 

tests/api-resources/nodes.test.ts

@@ -3,7 +3,7 @@
 import SFCNodes from 'sfc-nodes';
 
 const client = new SFCNodes({
-  bearerToken: 'My Bearer Token',
+  apiKey: 'My API Key',
   baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
 });
 

tests/api-resources/vms/script.test.ts

@@ -3,7 +3,7 @@
 import SFCNodes from 'sfc-nodes';
 
 const client = new SFCNodes({
-  bearerToken: 'My Bearer Token',
+  apiKey: 'My API Key',
   baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
 });
 

tests/api-resources/vms/vms.test.ts

@@ -3,23 +3,11 @@
 import SFCNodes from 'sfc-nodes';
 
 const client = new SFCNodes({
-  bearerToken: 'My Bearer Token',
+  apiKey: 'My API Key',
   baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
 });
 
 describe('resource vms', () => {
-  // skipped: tests are disabled for the time being
-  test.skip('list', async () => {
-    const responsePromise = client.vms.list();
-    const rawResponse = await responsePromise.asResponse();
-    expect(rawResponse).toBeInstanceOf(Response);
-    const response = await responsePromise;
-    expect(response).not.toBeInstanceOf(Response);
-    const dataAndResponse = await responsePromise.withResponse();
-    expect(dataAndResponse.data).toBe(response);
-    expect(dataAndResponse.response).toBe(rawResponse);
-  });
-
   // skipped: tests are disabled for the time being
   test.skip('logs: only required params', async () => {
     const responsePromise = client.vms.logs({ instance_id: 'instance_id', order_by: 'seqnum_asc' });
@@ -45,23 +33,6 @@ describe('resource vms', () => {
     });
   });
 
-  // skipped: tests are disabled for the time being
-  test.skip('replace: only required params', async () => {
-    const responsePromise = client.vms.replace({ vm_id: 'vm_id' });
-    const rawResponse = await responsePromise.asResponse();
-    expect(rawResponse).toBeInstanceOf(Response);
-    const response = await responsePromise;
-    expect(response).not.toBeInstanceOf(Response);
-    const dataAndResponse = await responsePromise.withResponse();
-    expect(dataAndResponse.data).toBe(response);
-    expect(dataAndResponse.response).toBe(rawResponse);
-  });
-
-  // skipped: tests are disabled for the time being
-  test.skip('replace: required and optional params', async () => {
-    const response = await client.vms.replace({ vm_id: 'vm_id' });
-  });
-
   // skipped: tests are disabled for the time being
   test.skip('ssh: only required params', async () => {
     const responsePromise = client.vms.ssh({ vm_id: 'vm_id' });