Skip to content

Commit ef5f62b

Browse files
feat(api): api update
1 parent 0a36097 commit ef5f62b

19 files changed

+399
-276
lines changed

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 18
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/browserbase%2Fbrowserbase-e2ed1b5267eeff92982918505349017b9155da2c7ab948787ab11cf9068af1b8.yml
3-
openapi_spec_hash: 77cba4a3c422b7378ecc7d57d84ff0b1
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/browserbase%2Fbrowserbase-fe7af3b907d79ac271560c1d2e887ed741cfcc08cb8b75596094411a2091e223.yml
3+
openapi_spec_hash: 999fb6ba05cd9be138ff94b787957ce9
44
config_hash: b3ca4ec5b02e5333af51ebc2e9fdef1b

api.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,59 +2,60 @@
22

33
Types:
44

5-
- <code><a href="./src/resources/contexts.ts">Context</a></code>
65
- <code><a href="./src/resources/contexts.ts">ContextCreateResponse</a></code>
6+
- <code><a href="./src/resources/contexts.ts">ContextRetrieveResponse</a></code>
77
- <code><a href="./src/resources/contexts.ts">ContextUpdateResponse</a></code>
88

99
Methods:
1010

1111
- <code title="post /v1/contexts">client.contexts.<a href="./src/resources/contexts.ts">create</a>({ ...params }) -> ContextCreateResponse</code>
12-
- <code title="get /v1/contexts/{id}">client.contexts.<a href="./src/resources/contexts.ts">retrieve</a>(id) -> Context</code>
12+
- <code title="get /v1/contexts/{id}">client.contexts.<a href="./src/resources/contexts.ts">retrieve</a>(id) -> ContextRetrieveResponse</code>
1313
- <code title="put /v1/contexts/{id}">client.contexts.<a href="./src/resources/contexts.ts">update</a>(id) -> ContextUpdateResponse</code>
1414

1515
# Extensions
1616

1717
Types:
1818

19-
- <code><a href="./src/resources/extensions.ts">Extension</a></code>
19+
- <code><a href="./src/resources/extensions.ts">ExtensionCreateResponse</a></code>
20+
- <code><a href="./src/resources/extensions.ts">ExtensionRetrieveResponse</a></code>
2021

2122
Methods:
2223

23-
- <code title="post /v1/extensions">client.extensions.<a href="./src/resources/extensions.ts">create</a>({ ...params }) -> Extension</code>
24-
- <code title="get /v1/extensions/{id}">client.extensions.<a href="./src/resources/extensions.ts">retrieve</a>(id) -> Extension</code>
24+
- <code title="post /v1/extensions">client.extensions.<a href="./src/resources/extensions.ts">create</a>({ ...params }) -> ExtensionCreateResponse</code>
25+
- <code title="get /v1/extensions/{id}">client.extensions.<a href="./src/resources/extensions.ts">retrieve</a>(id) -> ExtensionRetrieveResponse</code>
2526
- <code title="delete /v1/extensions/{id}">client.extensions.<a href="./src/resources/extensions.ts">delete</a>(id) -> void</code>
2627

2728
# Projects
2829

2930
Types:
3031

31-
- <code><a href="./src/resources/projects.ts">Project</a></code>
32-
- <code><a href="./src/resources/projects.ts">ProjectUsage</a></code>
32+
- <code><a href="./src/resources/projects.ts">ProjectRetrieveResponse</a></code>
3333
- <code><a href="./src/resources/projects.ts">ProjectListResponse</a></code>
34+
- <code><a href="./src/resources/projects.ts">ProjectUsageResponse</a></code>
3435

3536
Methods:
3637

37-
- <code title="get /v1/projects/{id}">client.projects.<a href="./src/resources/projects.ts">retrieve</a>(id) -> Project</code>
38+
- <code title="get /v1/projects/{id}">client.projects.<a href="./src/resources/projects.ts">retrieve</a>(id) -> ProjectRetrieveResponse</code>
3839
- <code title="get /v1/projects">client.projects.<a href="./src/resources/projects.ts">list</a>() -> ProjectListResponse</code>
39-
- <code title="get /v1/projects/{id}/usage">client.projects.<a href="./src/resources/projects.ts">usage</a>(id) -> ProjectUsage</code>
40+
- <code title="get /v1/projects/{id}/usage">client.projects.<a href="./src/resources/projects.ts">usage</a>(id) -> ProjectUsageResponse</code>
4041

4142
# Sessions
4243

4344
Types:
4445

45-
- <code><a href="./src/resources/sessions/sessions.ts">Session</a></code>
46-
- <code><a href="./src/resources/sessions/sessions.ts">SessionLiveURLs</a></code>
4746
- <code><a href="./src/resources/sessions/sessions.ts">SessionCreateResponse</a></code>
4847
- <code><a href="./src/resources/sessions/sessions.ts">SessionRetrieveResponse</a></code>
48+
- <code><a href="./src/resources/sessions/sessions.ts">SessionUpdateResponse</a></code>
4949
- <code><a href="./src/resources/sessions/sessions.ts">SessionListResponse</a></code>
50+
- <code><a href="./src/resources/sessions/sessions.ts">SessionDebugResponse</a></code>
5051

5152
Methods:
5253

5354
- <code title="post /v1/sessions">client.sessions.<a href="./src/resources/sessions/sessions.ts">create</a>({ ...params }) -> SessionCreateResponse</code>
5455
- <code title="get /v1/sessions/{id}">client.sessions.<a href="./src/resources/sessions/sessions.ts">retrieve</a>(id) -> SessionRetrieveResponse</code>
55-
- <code title="post /v1/sessions/{id}">client.sessions.<a href="./src/resources/sessions/sessions.ts">update</a>(id, { ...params }) -> Session</code>
56+
- <code title="post /v1/sessions/{id}">client.sessions.<a href="./src/resources/sessions/sessions.ts">update</a>(id, { ...params }) -> SessionUpdateResponse</code>
5657
- <code title="get /v1/sessions">client.sessions.<a href="./src/resources/sessions/sessions.ts">list</a>({ ...params }) -> SessionListResponse</code>
57-
- <code title="get /v1/sessions/{id}/debug">client.sessions.<a href="./src/resources/sessions/sessions.ts">debug</a>(id) -> SessionLiveURLs</code>
58+
- <code title="get /v1/sessions/{id}/debug">client.sessions.<a href="./src/resources/sessions/sessions.ts">debug</a>(id) -> SessionDebugResponse</code>
5859

5960
## Downloads
6061

@@ -66,7 +67,6 @@ Methods:
6667

6768
Types:
6869

69-
- <code><a href="./src/resources/sessions/logs.ts">SessionLog</a></code>
7070
- <code><a href="./src/resources/sessions/logs.ts">LogListResponse</a></code>
7171

7272
Methods:
@@ -77,7 +77,6 @@ Methods:
7777

7878
Types:
7979

80-
- <code><a href="./src/resources/sessions/recording.ts">SessionRecording</a></code>
8180
- <code><a href="./src/resources/sessions/recording.ts">RecordingRetrieveResponse</a></code>
8281

8382
Methods:

src/index.ts

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,33 @@ import * as Errors from './error';
66
import * as Uploads from './uploads';
77
import * as API from './resources/index';
88
import {
9-
Context,
109
ContextCreateParams,
1110
ContextCreateResponse,
11+
ContextRetrieveResponse,
1212
ContextUpdateResponse,
1313
Contexts,
1414
} from './resources/contexts';
15-
import { Extension, ExtensionCreateParams, Extensions } from './resources/extensions';
16-
import { Project, ProjectListResponse, ProjectUsage, Projects } from './resources/projects';
1715
import {
18-
Session,
16+
ExtensionCreateParams,
17+
ExtensionCreateResponse,
18+
ExtensionRetrieveResponse,
19+
Extensions,
20+
} from './resources/extensions';
21+
import {
22+
ProjectListResponse,
23+
ProjectRetrieveResponse,
24+
ProjectUsageResponse,
25+
Projects,
26+
} from './resources/projects';
27+
import {
1928
SessionCreateParams,
2029
SessionCreateResponse,
30+
SessionDebugResponse,
2131
SessionListParams,
2232
SessionListResponse,
23-
SessionLiveURLs,
2433
SessionRetrieveResponse,
2534
SessionUpdateParams,
35+
SessionUpdateResponse,
2636
Sessions,
2737
} from './resources/sessions/sessions';
2838

@@ -197,32 +207,33 @@ export declare namespace Browserbase {
197207

198208
export {
199209
Contexts as Contexts,
200-
type Context as Context,
201210
type ContextCreateResponse as ContextCreateResponse,
211+
type ContextRetrieveResponse as ContextRetrieveResponse,
202212
type ContextUpdateResponse as ContextUpdateResponse,
203213
type ContextCreateParams as ContextCreateParams,
204214
};
205215

206216
export {
207217
Extensions as Extensions,
208-
type Extension as Extension,
218+
type ExtensionCreateResponse as ExtensionCreateResponse,
219+
type ExtensionRetrieveResponse as ExtensionRetrieveResponse,
209220
type ExtensionCreateParams as ExtensionCreateParams,
210221
};
211222

212223
export {
213224
Projects as Projects,
214-
type Project as Project,
215-
type ProjectUsage as ProjectUsage,
225+
type ProjectRetrieveResponse as ProjectRetrieveResponse,
216226
type ProjectListResponse as ProjectListResponse,
227+
type ProjectUsageResponse as ProjectUsageResponse,
217228
};
218229

219230
export {
220231
Sessions as Sessions,
221-
type Session as Session,
222-
type SessionLiveURLs as SessionLiveURLs,
223232
type SessionCreateResponse as SessionCreateResponse,
224233
type SessionRetrieveResponse as SessionRetrieveResponse,
234+
type SessionUpdateResponse as SessionUpdateResponse,
225235
type SessionListResponse as SessionListResponse,
236+
type SessionDebugResponse as SessionDebugResponse,
226237
type SessionCreateParams as SessionCreateParams,
227238
type SessionUpdateParams as SessionUpdateParams,
228239
type SessionListParams as SessionListParams,

src/resources/contexts.ts

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -12,33 +12,20 @@ export class Contexts extends APIResource {
1212
}
1313

1414
/**
15-
* Context
15+
* Get a Context
1616
*/
17-
retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<Context> {
17+
retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<ContextRetrieveResponse> {
1818
return this._client.get(`/v1/contexts/${id}`, options);
1919
}
2020

2121
/**
22-
* Update Context
22+
* Update a Context
2323
*/
2424
update(id: string, options?: Core.RequestOptions): Core.APIPromise<ContextUpdateResponse> {
2525
return this._client.put(`/v1/contexts/${id}`, options);
2626
}
2727
}
2828

29-
export interface Context {
30-
id: string;
31-
32-
createdAt: string;
33-
34-
/**
35-
* The Project ID linked to the uploaded Context.
36-
*/
37-
projectId: string;
38-
39-
updatedAt: string;
40-
}
41-
4229
export interface ContextCreateResponse {
4330
id: string;
4431

@@ -65,6 +52,19 @@ export interface ContextCreateResponse {
6552
uploadUrl: string;
6653
}
6754

55+
export interface ContextRetrieveResponse {
56+
id: string;
57+
58+
createdAt: string;
59+
60+
/**
61+
* The Project ID linked to the uploaded Context.
62+
*/
63+
projectId: string;
64+
65+
updatedAt: string;
66+
}
67+
6868
export interface ContextUpdateResponse {
6969
id: string;
7070

@@ -101,8 +101,8 @@ export interface ContextCreateParams {
101101

102102
export declare namespace Contexts {
103103
export {
104-
type Context as Context,
105104
type ContextCreateResponse as ContextCreateResponse,
105+
type ContextRetrieveResponse as ContextRetrieveResponse,
106106
type ContextUpdateResponse as ContextUpdateResponse,
107107
type ContextCreateParams as ContextCreateParams,
108108
};

src/resources/extensions.ts

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,22 @@ export class Extensions extends APIResource {
77
/**
88
* Upload an Extension
99
*/
10-
create(body: ExtensionCreateParams, options?: Core.RequestOptions): Core.APIPromise<Extension> {
10+
create(
11+
body: ExtensionCreateParams,
12+
options?: Core.RequestOptions,
13+
): Core.APIPromise<ExtensionCreateResponse> {
1114
return this._client.post('/v1/extensions', Core.multipartFormRequestOptions({ body, ...options }));
1215
}
1316

1417
/**
15-
* Extension
18+
* Get an Extension
1619
*/
17-
retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<Extension> {
20+
retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<ExtensionRetrieveResponse> {
1821
return this._client.get(`/v1/extensions/${id}`, options);
1922
}
2023

2124
/**
22-
* Delete Extension
25+
* Delete an Extension
2326
*/
2427
delete(id: string, options?: Core.RequestOptions): Core.APIPromise<void> {
2528
return this._client.delete(`/v1/extensions/${id}`, {
@@ -29,7 +32,22 @@ export class Extensions extends APIResource {
2932
}
3033
}
3134

32-
export interface Extension {
35+
export interface ExtensionCreateResponse {
36+
id: string;
37+
38+
createdAt: string;
39+
40+
fileName: string;
41+
42+
/**
43+
* The Project ID linked to the uploaded Extension.
44+
*/
45+
projectId: string;
46+
47+
updatedAt: string;
48+
}
49+
50+
export interface ExtensionRetrieveResponse {
3351
id: string;
3452

3553
createdAt: string;
@@ -49,5 +67,9 @@ export interface ExtensionCreateParams {
4967
}
5068

5169
export declare namespace Extensions {
52-
export { type Extension as Extension, type ExtensionCreateParams as ExtensionCreateParams };
70+
export {
71+
type ExtensionCreateResponse as ExtensionCreateResponse,
72+
type ExtensionRetrieveResponse as ExtensionRetrieveResponse,
73+
type ExtensionCreateParams as ExtensionCreateParams,
74+
};
5375
}

src/resources/index.ts

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,30 @@
22

33
export {
44
Contexts,
5-
type Context,
65
type ContextCreateResponse,
6+
type ContextRetrieveResponse,
77
type ContextUpdateResponse,
88
type ContextCreateParams,
99
} from './contexts';
10-
export { Extensions, type Extension, type ExtensionCreateParams } from './extensions';
11-
export { Projects, type Project, type ProjectUsage, type ProjectListResponse } from './projects';
10+
export {
11+
Extensions,
12+
type ExtensionCreateResponse,
13+
type ExtensionRetrieveResponse,
14+
type ExtensionCreateParams,
15+
} from './extensions';
16+
export {
17+
Projects,
18+
type ProjectRetrieveResponse,
19+
type ProjectListResponse,
20+
type ProjectUsageResponse,
21+
} from './projects';
1222
export {
1323
Sessions,
14-
type Session,
15-
type SessionLiveURLs,
1624
type SessionCreateResponse,
1725
type SessionRetrieveResponse,
26+
type SessionUpdateResponse,
1827
type SessionListResponse,
28+
type SessionDebugResponse,
1929
type SessionCreateParams,
2030
type SessionUpdateParams,
2131
type SessionListParams,

0 commit comments

Comments
 (0)