feat(api): api update (#127)

browserbase · Jan 23, 2025 · 6ef46ba · 6ef46ba
1 parent 3535bba
commit 6ef46ba
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 8 deletions.
diff --git a/.stats.yml b/.stats.yml
@@ -1,2 +1,2 @@
 configured_endpoints: 18
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/browserbase%2Fbrowserbase-f1ba1f2c1512973c1640f7e2d27c72c4f5c49ec07e70b026d52818e7f8b1468e.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/browserbase%2Fbrowserbase-6a5cbe2f816042d594335d77f9600cd47cdb9c21d9d60971a2eca87983061c72.yml
diff --git a/src/resources/sessions/sessions.ts b/src/resources/sessions/sessions.ts
@@ -113,9 +113,10 @@ export interface Session {
   memoryUsage?: number;
 
   /**
-   * Arbitrary user metadata to attach to the session.
+   * Arbitrary user metadata to attach to the session. To learn more about user
+   * metadata, see [User Metadata](/features/sessions#user-metadata).
    */
-  userMetadata?: unknown;
+  userMetadata?: Record<string, unknown>;
 }
 
 export interface SessionLiveURLs {
@@ -210,9 +211,10 @@ export interface SessionCreateResponse {
   memoryUsage?: number;
 
   /**
-   * Arbitrary user metadata to attach to the session.
+   * Arbitrary user metadata to attach to the session. To learn more about user
+   * metadata, see [User Metadata](/features/sessions#user-metadata).
    */
-  userMetadata?: unknown;
+  userMetadata?: Record<string, unknown>;
 }
 
 export type SessionListResponse = Array<Session>;
@@ -258,9 +260,10 @@ export interface SessionCreateParams {
   timeout?: number;
 
   /**
-   * Arbitrary user metadata to attach to the session.
+   * Arbitrary user metadata to attach to the session. To learn more about user
+   * metadata, see [User Metadata](/features/sessions#user-metadata).
    */
-  userMetadata?: unknown;
+  userMetadata?: Record<string, unknown>;
 }
 
 export namespace SessionCreateParams {
@@ -450,6 +453,11 @@ export interface SessionUpdateParams {
 }
 
 export interface SessionListParams {
+  /**
+   * Query sessions by user metadata. See
+   * [Querying Sessions by User Metadata](/features/sessions#querying-sessions-by-user-metadata)
+   * for the schema of this query.
+   */
   q?: string;
 
   status?: 'RUNNING' | 'ERROR' | 'TIMED_OUT' | 'COMPLETED';

diff --git a/tests/api-resources/sessions/sessions.test.ts b/tests/api-resources/sessions/sessions.test.ts
@@ -46,7 +46,7 @@ describe('resource sessions', () => {
       proxies: true,
       region: 'us-west-2',
       timeout: 60,
-      userMetadata: {},
+      userMetadata: { foo: 'bar' },
     });
   });