From 43699069f7dafe75b7116ae46946eba30fa4b2f9 Mon Sep 17 00:00:00 2001 From: Mish Ushakov <10400064+mishushakov@users.noreply.github.com> Date: Tue, 9 Jun 2026 15:46:17 +0200 Subject: [PATCH] Remove deprecated Sandbox.betaPause / beta_pause Remove the deprecated `betaPause` (JS) and `beta_pause` (Python sync + async) aliases of `pause`, update the CLI pause command, tests and docs to call `pause`, and add a changeset. Co-Authored-By: Claude Opus 4.8 --- .changeset/remove-beta-pause.md | 20 ++++++++++++++++ packages/cli/src/commands/sandbox/pause.ts | 2 +- packages/js-sdk/src/sandbox/index.ts | 9 +------- packages/js-sdk/src/sandbox/sandboxApi.ts | 10 -------- packages/js-sdk/tests/api/list.test.ts | 16 ++++++------- packages/python-sdk/e2b/sandbox_async/main.py | 23 ------------------- packages/python-sdk/e2b/sandbox_sync/main.py | 23 ------------------- .../tests/async/api_async/test_sbx_list.py | 8 +++---- .../tests/sync/api_sync/test_sbx_list.py | 8 +++---- 9 files changed, 38 insertions(+), 81 deletions(-) create mode 100644 .changeset/remove-beta-pause.md diff --git a/.changeset/remove-beta-pause.md b/.changeset/remove-beta-pause.md new file mode 100644 index 0000000000..26d41a6e7c --- /dev/null +++ b/.changeset/remove-beta-pause.md @@ -0,0 +1,20 @@ +--- +'e2b': minor +'@e2b/python-sdk': minor +--- + +Remove `Sandbox.betaPause` (JS) and `Sandbox.beta_pause` (Python). These were deprecated aliases of `pause`. Migrate by calling `pause` instead: + +```ts +// before +await sandbox.betaPause() +// after +await sandbox.pause() +``` + +```python +# before +sandbox.beta_pause() +# after +sandbox.pause() +``` diff --git a/packages/cli/src/commands/sandbox/pause.ts b/packages/cli/src/commands/sandbox/pause.ts index 0c187214a6..e11a11a5c7 100644 --- a/packages/cli/src/commands/sandbox/pause.ts +++ b/packages/cli/src/commands/sandbox/pause.ts @@ -7,7 +7,7 @@ import { NotFoundError } from 'e2b' async function pauseSandbox(sandboxID: string, apiKey: string) { try { - const paused = await e2b.Sandbox.betaPause(sandboxID, { apiKey }) + const paused = await e2b.Sandbox.pause(sandboxID, { apiKey }) if (paused) { console.log(`Sandbox ${asBold(sandboxID)} has been paused`) } else { diff --git a/packages/js-sdk/src/sandbox/index.ts b/packages/js-sdk/src/sandbox/index.ts index 918234176a..b47ee25110 100644 --- a/packages/js-sdk/src/sandbox/index.ts +++ b/packages/js-sdk/src/sandbox/index.ts @@ -383,7 +383,7 @@ export class Sandbox extends SandboxApi { * @example * ```ts * const sandbox = await Sandbox.create() - * await sandbox.betaPause() + * await sandbox.pause() * * // Connect to the same sandbox. * const sameSandbox = await sandbox.connect() @@ -534,13 +534,6 @@ export class Sandbox extends SandboxApi { return await SandboxApi.pause(this.sandboxId, this.resolveApiOpts(opts)) } - /** - * @deprecated Use {@link Sandbox.pause} instead. - */ - async betaPause(opts?: ConnectionOpts): Promise { - return await SandboxApi.betaPause(this.sandboxId, this.resolveApiOpts(opts)) - } - /** * Create a snapshot of the sandbox's current state. * diff --git a/packages/js-sdk/src/sandbox/sandboxApi.ts b/packages/js-sdk/src/sandbox/sandboxApi.ts index d2003e36f5..4c31787c59 100644 --- a/packages/js-sdk/src/sandbox/sandboxApi.ts +++ b/packages/js-sdk/src/sandbox/sandboxApi.ts @@ -922,16 +922,6 @@ export class SandboxApi { return true } - /** - * @deprecated Use {@link SandboxApi.pause} instead. - */ - static async betaPause( - sandboxId: string, - opts?: SandboxApiOpts - ): Promise { - return this.pause(sandboxId, opts) - } - /** * Create a snapshot from a sandbox. * diff --git a/packages/js-sdk/tests/api/list.test.ts b/packages/js-sdk/tests/api/list.test.ts index 3960b9fffd..ae0838d5d4 100644 --- a/packages/js-sdk/tests/api/list.test.ts +++ b/packages/js-sdk/tests/api/list.test.ts @@ -65,7 +65,7 @@ sandboxTest.skipIf(isDebug)( async ({ sandboxTestId }) => { // Create and pause a sandbox const extraSbx = await Sandbox.create({ metadata: { sandboxTestId } }) - await extraSbx.betaPause() + await extraSbx.pause() try { const paginator = Sandbox.list({ @@ -125,11 +125,11 @@ sandboxTest.skipIf(isDebug)( sandboxTest.skipIf(isDebug)( 'paginate paused sandboxes', async ({ sandbox, sandboxTestId }) => { - await sandbox.betaPause() + await sandbox.pause() // Create extra paused sandbox const extraSbx = await Sandbox.create({ metadata: { sandboxTestId } }) - await extraSbx.betaPause() + await extraSbx.pause() try { // Test pagination with limit @@ -168,7 +168,7 @@ sandboxTest.skipIf(isDebug)( const extraSbx = await Sandbox.create({ metadata: { sandboxTestId } }) // Pause the extra sandbox - await extraSbx.betaPause() + await extraSbx.pause() try { // Test pagination with limit @@ -282,7 +282,7 @@ sandboxTest.skipIf(isDebug)( async ({ sandboxTestId }) => { // Create and pause a sandbox const extraSbx = await Sandbox.create({ metadata: { sandboxTestId } }) - await Sandbox.betaPause(extraSbx.sandboxId) + await Sandbox.pause(extraSbx.sandboxId) try { const paginator = Sandbox.list({ @@ -342,11 +342,11 @@ sandboxTest.skipIf(isDebug)( sandboxTest.skipIf(isDebug)( 'paginate paused sandboxes', async ({ sandbox, sandboxTestId }) => { - await Sandbox.betaPause(sandbox.sandboxId) + await Sandbox.pause(sandbox.sandboxId) // Create extra paused sandbox const extraSbx = await Sandbox.create({ metadata: { sandboxTestId } }) - await Sandbox.betaPause(extraSbx.sandboxId) + await Sandbox.pause(extraSbx.sandboxId) try { // Test pagination with limit @@ -385,7 +385,7 @@ sandboxTest.skipIf(isDebug)( const extraSbx = await Sandbox.create({ metadata: { sandboxTestId } }) // Pause the extra sandbox - await Sandbox.betaPause(sandbox.sandboxId) + await Sandbox.pause(sandbox.sandboxId) try { // Test pagination with limit diff --git a/packages/python-sdk/e2b/sandbox_async/main.py b/packages/python-sdk/e2b/sandbox_async/main.py index d0bafd0045..a05c7afe79 100644 --- a/packages/python-sdk/e2b/sandbox_async/main.py +++ b/packages/python-sdk/e2b/sandbox_async/main.py @@ -643,29 +643,6 @@ async def pause( **self.connection_config.get_api_params(**opts), ) - @overload - async def beta_pause( - self, - **opts: Unpack[ApiParams], - ) -> bool: ... - - @overload - @staticmethod - async def beta_pause( - sandbox_id: str, - **opts: Unpack[ApiParams], - ) -> bool: ... - - @class_method_variant("_cls_pause") - async def beta_pause( - self, - **opts: Unpack[ApiParams], - ) -> bool: - """ - :deprecated: Use `pause()` instead. - """ - return await self.pause(**opts) - @overload async def create_snapshot( self, diff --git a/packages/python-sdk/e2b/sandbox_sync/main.py b/packages/python-sdk/e2b/sandbox_sync/main.py index c8d3177c22..7d790a0b77 100644 --- a/packages/python-sdk/e2b/sandbox_sync/main.py +++ b/packages/python-sdk/e2b/sandbox_sync/main.py @@ -645,29 +645,6 @@ def pause( **self.connection_config.get_api_params(**opts), ) - @overload - def beta_pause( - self, - **opts: Unpack[ApiParams], - ) -> bool: ... - - @overload - @staticmethod - def beta_pause( - sandbox_id: str, - **opts: Unpack[ApiParams], - ) -> bool: ... - - @class_method_variant("_cls_pause") - def beta_pause( - self, - **opts: Unpack[ApiParams], - ) -> bool: - """ - :deprecated: Use `pause()` instead. - """ - return self.pause(**opts) - @overload def create_snapshot( self, diff --git a/packages/python-sdk/tests/async/api_async/test_sbx_list.py b/packages/python-sdk/tests/async/api_async/test_sbx_list.py index e902fd9a07..ccd8d6df42 100644 --- a/packages/python-sdk/tests/async/api_async/test_sbx_list.py +++ b/packages/python-sdk/tests/async/api_async/test_sbx_list.py @@ -47,7 +47,7 @@ async def test_list_running_sandboxes( @pytest.mark.skip_debug() async def test_list_paused_sandboxes(async_sandbox: AsyncSandbox, sandbox_test_id: str): - await async_sandbox.beta_pause() + await async_sandbox.pause() paginator = AsyncSandbox.list( query=SandboxQuery( @@ -101,13 +101,13 @@ async def test_paginate_running_sandboxes(sandbox_test_id: str, async_sandbox_fa async def test_paginate_paused_sandboxes( async_sandbox: AsyncSandbox, sandbox_test_id: str, async_sandbox_factory ): - await async_sandbox.beta_pause() + await async_sandbox.pause() # create another paused sandbox extra_sbx = await async_sandbox_factory( metadata={"sandbox_test_id": sandbox_test_id} ) - await extra_sbx.beta_pause() + await extra_sbx.pause() # Test pagination with limit paginator = AsyncSandbox.list( @@ -145,7 +145,7 @@ async def test_paginate_running_and_paused_sandboxes( extra_sbx = await async_sandbox_factory( metadata={"sandbox_test_id": sandbox_test_id} ) - await extra_sbx.beta_pause() + await extra_sbx.pause() # Test pagination with limit paginator = AsyncSandbox.list( diff --git a/packages/python-sdk/tests/sync/api_sync/test_sbx_list.py b/packages/python-sdk/tests/sync/api_sync/test_sbx_list.py index c139ccbd85..71db4ef42f 100644 --- a/packages/python-sdk/tests/sync/api_sync/test_sbx_list.py +++ b/packages/python-sdk/tests/sync/api_sync/test_sbx_list.py @@ -45,7 +45,7 @@ def test_list_running_sandboxes(sandbox: Sandbox, sandbox_test_id: str): @pytest.mark.skip_debug() def test_list_paused_sandboxes(sandbox: Sandbox, sandbox_test_id: str): - sandbox.beta_pause() + sandbox.pause() paginator = Sandbox.list( query=SandboxQuery( @@ -102,11 +102,11 @@ def test_paginate_running_sandboxes( def test_paginate_paused_sandboxes( sandbox: Sandbox, sandbox_factory, sandbox_test_id: str ): - sandbox.beta_pause() + sandbox.pause() # create another paused sandbox extra_sbx = sandbox_factory(metadata={"sandbox_test_id": sandbox_test_id}) - extra_sbx.beta_pause() + extra_sbx.pause() # Test pagination with limit paginator = Sandbox.list( @@ -143,7 +143,7 @@ def test_paginate_running_and_paused_sandboxes( ): # Create extra paused sandbox extra_sbx = sandbox_factory(metadata={"sandbox_test_id": sandbox_test_id}) - extra_sbx.beta_pause() + extra_sbx.pause() # Test pagination with limit paginator = Sandbox.list(