feat(api): manual updates

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 119
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gitpod%2Fgitpod-c850a6432597255fc1b788ba21a0494162e639f41dd80c0f9d07def239d31865.yml
-openapi_spec_hash: fba3f62e51d3ba39eea280abe29f39f1
-config_hash: 8e3b8fba844b78950ad4a13b75b7fffc
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gitpod%2Fgitpod-ca9a49ac7fbb63f55611fd7cd48a22a3ff8b38a797125c8513e891d9b7345550.yml
+openapi_spec_hash: fd6ffbdfaefcc555e61ca1c565e05214
+config_hash: bb9d0a0bdadbee0985dd7c1e4f0e9e8a

README.md

@@ -26,13 +26,9 @@ const client = new Gitpod({
   bearerToken: process.env['GITPOD_API_KEY'], // This is the default and can be omitted
 });
 
-async function main() {
-  const response = await client.identity.getAuthenticatedIdentity();
+const response = await client.identity.getAuthenticatedIdentity();
 
-  console.log(response.organizationId);
-}
-
-main();
+console.log(response.organizationId);
 ```
 
 ### Request & Response types
@@ -47,12 +43,8 @@ const client = new Gitpod({
   bearerToken: process.env['GITPOD_API_KEY'], // This is the default and can be omitted
 });
 
-async function main() {
-  const response: Gitpod.IdentityGetAuthenticatedIdentityResponse =
-    await client.identity.getAuthenticatedIdentity();
-}
-
-main();
+const response: Gitpod.IdentityGetAuthenticatedIdentityResponse =
+  await client.identity.getAuthenticatedIdentity();
 ```
 
 Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.
@@ -65,19 +57,15 @@ a subclass of `APIError` will be thrown:
 
 <!-- prettier-ignore -->
 ```ts
-async function main() {
-  const response = await client.identity.getAuthenticatedIdentity().catch(async (err) => {
-    if (err instanceof Gitpod.APIError) {
-      console.log(err.status); // 400
-      console.log(err.name); // BadRequestError
-      console.log(err.headers); // {server: 'nginx', ...}
-    } else {
-      throw err;
-    }
-  });
-}
-
-main();
+const response = await client.identity.getAuthenticatedIdentity().catch(async (err) => {
+  if (err instanceof Gitpod.APIError) {
+    console.log(err.status); // 400
+    console.log(err.name); // BadRequestError
+    console.log(err.headers); // {server: 'nginx', ...}
+  } else {
+    throw err;
+  }
+});
 ```
 
 Error codes are as follows:

scripts/build

@@ -37,8 +37,6 @@ 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/client.ts

@@ -5,8 +5,8 @@ import type { HTTPMethod, PromiseOrValue, MergedRequestInit, FinalizedRequestIni
 import { uuid4 } from './internal/utils/uuid';
 import { validatePositiveInteger, isAbsoluteURL, safeJSON } from './internal/utils/values';
 import { sleep } from './internal/utils/sleep';
-import { type Logger, type LogLevel, parseLogLevel } from './internal/utils/log';
-export type { Logger, LogLevel } from './internal/utils/log';
+import { type Logger, type LogLevel as LogLevelClient, parseLogLevel } from './internal/utils/log';
+export type { Logger, LogLevel as LogLevelClient } from './internal/utils/log';
 import { castToError, isAbortError } from './internal/errors';
 import type { APIResponseProps } from './internal/parse';
 import { getPlatformHeaders } from './internal/detect-platform';
@@ -318,7 +318,7 @@ export interface ClientOptions {
    *
    * Defaults to process.env['GITPOD_LOG'] or 'warn' if it isn't set.
    */
-  logLevel?: LogLevel | undefined;
+  logLevel?: LogLevelClient | undefined;
 
   /**
    * Set the logger.
@@ -338,7 +338,7 @@ export class Gitpod {
   maxRetries: number;
   timeout: number;
   logger: Logger | undefined;
-  logLevel: LogLevel | undefined;
+  logLevel: LogLevelClient | undefined;
   fetchOptions: MergedRequestInit | undefined;
 
   private fetch: Fetch;

src/core/pagination.ts

@@ -99,7 +99,7 @@ export class PagePromise<
    *      console.log(item)
    *    }
    */
-  async *[Symbol.asyncIterator]() {
+  async *[Symbol.asyncIterator](): AsyncGenerator<Item> {
     const page = await this;
     for await (const item of page) {
       yield item;

src/internal/shim-types.d.ts

@@ -0,0 +1,26 @@
+// 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.
+ */
+
+type NeverToAny<T> = T extends never ? any : T;
+
+/** @ts-ignore */
+type _DOMReadableStream<R = any> = globalThis.ReadableStream<R>;
+
+/** @ts-ignore */
+type _NodeReadableStream<R = any> = import('stream/web').ReadableStream<R>;
+
+type _ConditionalNodeReadableStream<R = any> =
+  typeof globalThis extends { ReadableStream: any } ? never : _NodeReadableStream<R>;
+
+type _ReadableStream<R = any> = NeverToAny<
+  | ([0] extends [1 & _DOMReadableStream<R>] ? never : _DOMReadableStream<R>)
+  | ([0] extends [1 & _ConditionalNodeReadableStream<R>] ? never : _ConditionalNodeReadableStream<R>)
+>;
+
+export type { _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

@@ -1474,12 +1474,19 @@ export interface EnvironmentUpdateParams {
    */
   environmentId?: string;
 
-  metadata?: unknown | null;
+  metadata?: EnvironmentUpdateParams.Metadata | null;
 
   spec?: EnvironmentUpdateParams.Spec | null;
 }
 
 export namespace EnvironmentUpdateParams {
+  export interface Metadata {
+    /**
+     * name is the user-defined display name of the environment
+     */
+    name?: string | null;
+  }
+
   export interface Spec {
     /**
      * automations_file is the automations file spec of the environment