fix: changes har request format for snippets API some more

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 15
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/stainless%2Fstainless-v0-5ca77894755b023e347be818cea03fc11810d3de5df5167772a7ab44111d9413.yml
-openapi_spec_hash: e1df8ec98c9bcc6d93c9bafa8ff79d29
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/stainless%2Fstainless-v0-332dd93ce7473cdf7114d71d7dcaf7a4acc1491717c5cd55fbf984475d92bad7.yml
+openapi_spec_hash: 15cea3398093ddc80c926606aa31d41a
 config_hash: 4cc7a55bc88549c1b7d1e960fa207961

README.md

@@ -30,9 +30,13 @@ const client = new Stainless({
   apiKey: process.env['STAINLESS_V0_API_KEY'], // This is the default and can be omitted
 });
 
-const buildObject = await client.builds.create({ revision: 'string' });
+async function main() {
+  const buildObject = await client.builds.create({ revision: 'string' });
 
-console.log(buildObject.id);
+  console.log(buildObject.id);
+}
+
+main();
 ```
 
 ### Request & Response types
@@ -48,8 +52,12 @@ const client = new Stainless({
   apiKey: process.env['STAINLESS_V0_API_KEY'], // This is the default and can be omitted
 });
 
-const params: Stainless.BuildCreateParams = { revision: 'string' };
-const buildObject: Stainless.BuildObject = await client.builds.create(params);
+async function main() {
+  const params: Stainless.BuildCreateParams = { revision: 'string' };
+  const buildObject: Stainless.BuildObject = await client.builds.create(params);
+}
+
+main();
 ```
 
 Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.
@@ -62,15 +70,19 @@ a subclass of `APIError` will be thrown:
 
 <!-- prettier-ignore -->
 ```ts
-const buildObject = await client.builds.create({ revision: 'string' }).catch(async (err) => {
-  if (err instanceof Stainless.APIError) {
-    console.log(err.status); // 400
-    console.log(err.name); // BadRequestError
-    console.log(err.headers); // {server: 'nginx', ...}
-  } else {
-    throw err;
-  }
-});
+async function main() {
+  const buildObject = await client.builds.create({ revision: 'string' }).catch(async (err) => {
+    if (err instanceof Stainless.APIError) {
+      console.log(err.status); // 400
+      console.log(err.name); // BadRequestError
+      console.log(err.headers); // {server: 'nginx', ...}
+    } else {
+      throw err;
+    }
+  });
+}
+
+main();
 ```
 
 Error codes are as follows:

scripts/build

@@ -37,6 +37,8 @@ npm exec tsc-multi
 # when building .mjs
 node scripts/utils/fix-index-exports.cjs
 cp tsconfig.dist-src.json dist/src/tsconfig.json
+cp src/internal/shim-types.d.ts dist/internal/shim-types.d.ts
+cp src/internal/shim-types.d.ts dist/internal/shim-types.d.mts
 
 node scripts/utils/postprocess-files.cjs
 

src/internal/shim-types.d.ts

@@ -0,0 +1,28 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+/**
+ * Shims for types that we can't always rely on being available globally.
+ *
+ * Note: these only exist at the type-level, there is no corresponding runtime
+ * version for any of these symbols.
+ */
+
+/**
+ * In order to properly access the global `NodeJS` type, if it's available, we
+ * need to make use of declaration shadowing. Without this, any checks for the
+ * presence of `NodeJS.ReadableStream` will fail.
+ */
+declare namespace NodeJS {
+  interface ReadableStream {}
+}
+
+type HasProperties<T> = keyof T extends never ? false : true;
+
+// @ts-ignore
+type _ReadableStream<R = any> =
+  // @ts-ignore
+  HasProperties<NodeJS.ReadableStream> extends true ? NodeJS.ReadableStream<R> : ReadableStream<R>;
+
+// @ts-ignore
+declare const _ReadableStream: unknown extends typeof ReadableStream ? never : typeof ReadableStream;
+export { _ReadableStream as ReadableStream };

src/internal/shim-types.ts

@@ -7,8 +7,8 @@
  * messages in cases where an environment isn't fully supported.
  */
 
-import type { Fetch } from './builtin-types';
-import type { ReadableStream } from './shim-types';
+import { type Fetch } from './builtin-types';
+import { type ReadableStream } from './shim-types';
 
 export function getDefaultFetch(): Fetch {
   if (typeof fetch !== 'undefined') {

src/internal/shims.ts

@@ -19,110 +19,73 @@ export interface SnippetCreateRequestResponse {
   snippet: string;
 }
 
-export type SnippetCreateRequestParams =
-  | SnippetCreateRequestParams.Variant0
-  | SnippetCreateRequestParams.Variant1;
-
-export declare namespace SnippetCreateRequestParams {
-  export interface Variant0 {
-    request: Variant0.Request;
-
-    har?: null;
-
-    language?:
-      | 'node'
-      | 'typescript'
-      | 'python'
-      | 'go'
-      | 'java'
-      | 'kotlin'
-      | 'ruby'
-      | 'terraform'
-      | 'cli'
-      | 'php'
-      | 'csharp';
-
-    version?: 'next' | 'latest_released';
-  }
-
-  export namespace Variant0 {
-    export interface Request {
-      method: string;
-
-      parameters: Array<Request.Parameter>;
+export interface SnippetCreateRequestParams {
+  language:
+    | 'node'
+    | 'typescript'
+    | 'python'
+    | 'go'
+    | 'java'
+    | 'kotlin'
+    | 'ruby'
+    | 'terraform'
+    | 'cli'
+    | 'php'
+    | 'csharp';
+
+  request: SnippetCreateRequestParams.UnionMember0 | SnippetCreateRequestParams.UnionMember1;
+
+  version: 'next' | 'latest_released';
+}
 
-      path: string;
+export namespace SnippetCreateRequestParams {
+  export interface UnionMember0 {
+    method: string;
 
-      body?: Request.Body;
-    }
+    parameters: Array<UnionMember0.Parameter>;
 
-    export namespace Request {
-      export interface Parameter {
-        in: 'path' | 'query' | 'header' | 'cookie';
+    path: string;
 
-        name: string;
+    body?: UnionMember0.Body;
+  }
 
-        value?: unknown;
-      }
+  export namespace UnionMember0 {
+    export interface Parameter {
+      in: 'path' | 'query' | 'header' | 'cookie';
 
-      export interface Body {
-        fileParam?: string;
+      name: string;
 
-        filePath?: string;
-      }
+      value?: unknown;
     }
-  }
 
-  export interface Variant1 {
-    har: Variant1.Har;
-
-    language?:
-      | 'node'
-      | 'typescript'
-      | 'python'
-      | 'go'
-      | 'java'
-      | 'kotlin'
-      | 'ruby'
-      | 'terraform'
-      | 'cli'
-      | 'php'
-      | 'csharp';
-
-    request?: null;
-
-    version?: 'next' | 'latest_released';
-  }
+    export interface Body {
+      fileParam?: string;
 
-  export namespace Variant1 {
-    export interface Har {
-      request: Har.Request;
+      filePath?: string;
     }
+  }
 
-    export namespace Har {
-      export interface Request {
-        method: string;
+  export interface UnionMember1 {
+    method: string;
 
-        queryString: Array<Request.QueryString>;
+    queryString: Array<UnionMember1.QueryString>;
 
-        url: string;
+    url: string;
 
-        postData?: Request.PostData;
-      }
+    postData?: UnionMember1.PostData;
+  }
 
-      export namespace Request {
-        export interface QueryString {
-          name: string;
+  export namespace UnionMember1 {
+    export interface QueryString {
+      name: string;
 
-          value: string;
-        }
+      value: string;
+    }
 
-        export interface PostData {
-          mimeType: string;
+    export interface PostData {
+      mimeType: string;
 
-          text: string;
-        }
-      }
+      text: string;
     }
   }
 }

src/resources/projects/snippets.ts

@@ -12,7 +12,9 @@ describe('resource snippets', () => {
   // skipped: tests are disabled for the time being
   test.skip('createRequest: only required params', async () => {
     const responsePromise = client.projects.snippets.createRequest('projectName', {
+      language: 'node',
       request: { method: 'method', parameters: [{ in: 'path', name: 'name' }], path: 'path' },
+      version: 'next',
     });
     const rawResponse = await responsePromise.asResponse();
     expect(rawResponse).toBeInstanceOf(Response);
@@ -26,14 +28,13 @@ describe('resource snippets', () => {
   // skipped: tests are disabled for the time being
   test.skip('createRequest: required and optional params', async () => {
     const response = await client.projects.snippets.createRequest('projectName', {
+      language: 'node',
       request: {
         method: 'method',
         parameters: [{ in: 'path', name: 'name', value: {} }],
         path: 'path',
         body: { fileParam: 'fileParam', filePath: 'filePath' },
       },
-      har: null,
-      language: 'node',
       version: 'next',
     });
   });