Rename SDK's RequestOptions to BaseRequestOptions (avoid conflict with API's RequestOptions)

Author: sid-rl

docs/sdk/types.rst

@@ -83,7 +83,7 @@ Core Request Options
 
 These TypeDicts define options for timeouts, idempotency, polling, and other low-level request configuration. All other TypeDicts in the SDK extend from one of these core types.
 
-.. autotypeddict:: runloop_api_client.sdk._types.RequestOptions
+.. autotypeddict:: runloop_api_client.sdk._types.BaseRequestOptions
 
 .. autotypeddict:: runloop_api_client.sdk._types.LongRequestOptions
 

src/runloop_api_client/sdk/_types.py

@@ -36,7 +36,7 @@ class ExecuteStreamingCallbacks(TypedDict, total=False):
     """Callback invoked for all log lines (both stdout and stderr)"""
 
 
-class RequestOptions(TypedDict, total=False):
+class BaseRequestOptions(TypedDict, total=False):
     extra_headers: Optional[Headers]
     """Send extra headers"""
 
@@ -50,12 +50,12 @@ class RequestOptions(TypedDict, total=False):
     """Override the client-level default timeout for this request, in seconds"""
 
 
-class LongRequestOptions(RequestOptions, total=False):
+class LongRequestOptions(BaseRequestOptions, total=False):
     idempotency_key: Optional[str]
     """Specify a custom idempotency key for this request"""
 
 
-class PollingRequestOptions(RequestOptions, total=False):
+class PollingRequestOptions(BaseRequestOptions, total=False):
     polling_config: Optional[PollingConfig]
     """Configuration for polling behavior"""
 
@@ -80,7 +80,7 @@ class SDKDevboxExecuteAsyncParams(DevboxExecuteAsyncParams, ExecuteStreamingCall
     pass
 
 
-class SDKDevboxListParams(DevboxListParams, RequestOptions):
+class SDKDevboxListParams(DevboxListParams, BaseRequestOptions):
     pass
 
 
@@ -116,7 +116,7 @@ class SDKDevboxSnapshotDiskParams(DevboxSnapshotDiskParams, LongPollingRequestOp
     pass
 
 
-class SDKDiskSnapshotListParams(DiskSnapshotListParams, RequestOptions):
+class SDKDiskSnapshotListParams(DiskSnapshotListParams, BaseRequestOptions):
     pass
 
 
@@ -128,17 +128,17 @@ class SDKBlueprintCreateParams(BlueprintCreateParams, LongPollingRequestOptions)
     pass
 
 
-class SDKBlueprintListParams(BlueprintListParams, RequestOptions):
+class SDKBlueprintListParams(BlueprintListParams, BaseRequestOptions):
     pass
 
 
-class SDKObjectListParams(ObjectListParams, RequestOptions):
+class SDKObjectListParams(ObjectListParams, BaseRequestOptions):
     pass
 
 
 class SDKObjectCreateParams(ObjectCreateParams, LongRequestOptions):
     pass
 
 
-class SDKObjectDownloadParams(ObjectDownloadParams, RequestOptions):
+class SDKObjectDownloadParams(ObjectDownloadParams, BaseRequestOptions):
     pass

src/runloop_api_client/sdk/async_blueprint.py

@@ -5,7 +5,7 @@
 from typing_extensions import Unpack, override
 
 from ..types import BlueprintView
-from ._types import RequestOptions, LongRequestOptions, SDKDevboxCreateFromImageParams
+from ._types import BaseRequestOptions, LongRequestOptions, SDKDevboxCreateFromImageParams
 from .._client import AsyncRunloop
 from .async_devbox import AsyncDevbox
 from ..types.blueprint_build_logs_list_view import BlueprintBuildLogsListView
@@ -44,7 +44,7 @@ def id(self) -> str:
 
     async def get_info(
         self,
-        **options: Unpack[RequestOptions],
+        **options: Unpack[BaseRequestOptions],
     ) -> BlueprintView:
         """Retrieve the latest blueprint details.
 
@@ -59,7 +59,7 @@ async def get_info(
 
     async def logs(
         self,
-        **options: Unpack[RequestOptions],
+        **options: Unpack[BaseRequestOptions],
     ) -> BlueprintBuildLogsListView:
         """Retrieve build logs for the blueprint.
 

src/runloop_api_client/sdk/async_devbox.py

@@ -15,7 +15,7 @@
 )
 from ._types import (
     LogCallback,
-    RequestOptions,
+    BaseRequestOptions,
     LongRequestOptions,
     PollingRequestOptions,
     SDKDevboxExecuteParams,
@@ -104,7 +104,7 @@ def id(self) -> str:
 
     async def get_info(
         self,
-        **options: Unpack[RequestOptions],
+        **options: Unpack[BaseRequestOptions],
     ) -> DevboxView:
         """Retrieve current devbox status and metadata.
 

src/runloop_api_client/sdk/async_execution.py

@@ -7,7 +7,7 @@
 from typing import Optional, Awaitable, cast
 from typing_extensions import Unpack, override
 
-from ._types import RequestOptions, LongRequestOptions
+from ._types import BaseRequestOptions, LongRequestOptions
 from .._client import AsyncRunloop
 from .async_execution_result import AsyncExecutionResult
 from ..types.devbox_async_execution_detail_view import DevboxAsyncExecutionDetailView
@@ -119,7 +119,7 @@ async def result(self, **options: Unpack[LongRequestOptions]) -> AsyncExecutionR
         final = cast(DevboxAsyncExecutionDetailView, command_result)
         return AsyncExecutionResult(self._client, self._devbox_id, final)
 
-    async def get_state(self, **options: Unpack[RequestOptions]) -> DevboxAsyncExecutionDetailView:
+    async def get_state(self, **options: Unpack[BaseRequestOptions]) -> DevboxAsyncExecutionDetailView:
         """Fetch the latest execution state.
 
         :param options: Optional request configuration

src/runloop_api_client/sdk/async_snapshot.py

@@ -5,7 +5,7 @@
 from typing_extensions import Unpack, override
 
 from ._types import (
-    RequestOptions,
+    BaseRequestOptions,
     LongRequestOptions,
     PollingRequestOptions,
     SDKDiskSnapshotUpdateParams,
@@ -50,7 +50,7 @@ def id(self) -> str:
 
     async def get_info(
         self,
-        **options: Unpack[RequestOptions],
+        **options: Unpack[BaseRequestOptions],
     ) -> DevboxSnapshotAsyncStatusView:
         """Retrieve the latest snapshot status.
 

src/runloop_api_client/sdk/async_storage_object.py

@@ -5,7 +5,7 @@
 from typing import Iterable
 from typing_extensions import Unpack, override
 
-from ._types import RequestOptions, LongRequestOptions, SDKObjectDownloadParams
+from ._types import BaseRequestOptions, LongRequestOptions, SDKObjectDownloadParams
 from .._client import AsyncRunloop
 from ..types.object_view import ObjectView
 from ..types.object_download_url_view import ObjectDownloadURLView
@@ -52,7 +52,7 @@ def upload_url(self) -> str | None:
 
     async def refresh(
         self,
-        **options: Unpack[RequestOptions],
+        **options: Unpack[BaseRequestOptions],
     ) -> ObjectView:
         """Fetch the latest metadata for the object.
 

src/runloop_api_client/sdk/blueprint.py

@@ -5,7 +5,7 @@
 from typing_extensions import Unpack, override
 
 from ..types import BlueprintView
-from ._types import RequestOptions, LongRequestOptions, SDKDevboxCreateFromImageParams
+from ._types import BaseRequestOptions, LongRequestOptions, SDKDevboxCreateFromImageParams
 from .devbox import Devbox
 from .._client import Runloop
 from ..types.blueprint_build_logs_list_view import BlueprintBuildLogsListView
@@ -44,7 +44,7 @@ def id(self) -> str:
 
     def get_info(
         self,
-        **options: Unpack[RequestOptions],
+        **options: Unpack[BaseRequestOptions],
     ) -> BlueprintView:
         """Retrieve the latest blueprint details.
 
@@ -59,7 +59,7 @@ def get_info(
 
     def logs(
         self,
-        **options: Unpack[RequestOptions],
+        **options: Unpack[BaseRequestOptions],
     ) -> BlueprintBuildLogsListView:
         """Retrieve build logs for the blueprint.
 

src/runloop_api_client/sdk/devbox.py

@@ -15,7 +15,7 @@
 )
 from ._types import (
     LogCallback,
-    RequestOptions,
+    BaseRequestOptions,
     LongRequestOptions,
     PollingRequestOptions,
     SDKDevboxExecuteParams,
@@ -103,13 +103,13 @@ def id(self) -> str:
 
     def get_info(
         self,
-        **options: Unpack[RequestOptions],
+        **options: Unpack[BaseRequestOptions],
     ) -> DevboxView:
         """Retrieve current devbox status and metadata.
 
         :param options: Optional request configuration
         :return: Current devbox state info
-        :rtype: DevboxView
+        :rtype: :class:`~runloop_api_client.types.devbox_view.DevboxView`
         """
         return self._client.devboxes.retrieve(
             self._id,
@@ -124,7 +124,7 @@ def await_running(self, *, polling_config: PollingConfig | None = None) -> Devbo
         :param polling_config: Optional configuration for polling behavior (timeout, interval), defaults to None
         :type polling_config: PollingConfig | None, optional
         :return: Devbox state info after it reaches running status
-        :rtype: DevboxView
+        :rtype: :class:`~runloop_api_client.types.devbox_view.DevboxView`
         """
         return self._client.devboxes.await_running(self._id, polling_config=polling_config)
 
@@ -136,7 +136,7 @@ def await_suspended(self, *, polling_config: PollingConfig | None = None) -> Dev
         :param polling_config: Optional configuration for polling behavior (timeout, interval), defaults to None
         :type polling_config: PollingConfig | None, optional
         :return: Devbox state info after it reaches suspended status
-        :rtype: DevboxView
+        :rtype: :class:`~runloop_api_client.types.devbox_view.DevboxView`
         """
         return self._client.devboxes.await_suspended(self._id, polling_config=polling_config)
 
@@ -148,7 +148,7 @@ def shutdown(
 
         :param options: Long-running request configuration (timeouts, retries, etc.)
         :return: Final devbox state info
-        :rtype: DevboxView
+        :rtype: :class:`~runloop_api_client.types.devbox_view.DevboxView`
         """
         return self._client.devboxes.shutdown(
             self._id,
@@ -166,7 +166,7 @@ def suspend(
 
         :param options: Optional long-running request and polling configuration
         :return: Suspended devbox state info
-        :rtype: DevboxView
+        :rtype: :class:`~runloop_api_client.types.devbox_view.DevboxView`
         """
         self._client.devboxes.suspend(
             self._id,
@@ -184,7 +184,7 @@ def resume(
 
         :param options: Optional long-running request and polling configuration
         :return: Resumed devbox state info
-        :rtype: DevboxView
+        :rtype: :class:`~runloop_api_client.types.devbox_view.DevboxView`
         """
         self._client.devboxes.resume(
             self._id,
@@ -504,7 +504,7 @@ def write(
 
         :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKDevboxWriteFileContentsParams` for available parameters
         :return: Execution metadata for the write command
-        :rtype: DevboxExecutionDetailView
+        :rtype: :class:`~runloop_api_client.types.devbox_execution_detail_view.DevboxExecutionDetailView`
 
         Example:
             >>> devbox.file.write(file_path="/home/user/config.json", contents='{"key": "value"}')
@@ -572,7 +572,7 @@ def create_ssh_key(
 
         :param options: Optional long-running request configuration
         :return: Response containing SSH connection info
-        :rtype: DevboxCreateSSHKeyResponse
+        :rtype: :class:`~runloop_api_client.types.devbox_create_ssh_key_response.DevboxCreateSSHKeyResponse`
 
         Example:
             >>> ssh_key = devbox.net.create_ssh_key()
@@ -591,7 +591,7 @@ def create_tunnel(
 
         :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKDevboxCreateTunnelParams` for available parameters
         :return: Details about the public endpoint
-        :rtype: DevboxTunnelView
+        :rtype: :class:`~runloop_api_client.types.devbox_tunnel_view.DevboxTunnelView`
 
         Example:
             >>> tunnel = devbox.net.create_tunnel(port=8080)

src/runloop_api_client/sdk/execution.py

@@ -7,7 +7,7 @@
 from typing import Optional
 from typing_extensions import Unpack, override
 
-from ._types import RequestOptions, LongRequestOptions
+from ._types import BaseRequestOptions, LongRequestOptions
 from .._client import Runloop
 from .execution_result import ExecutionResult
 from ..types.devbox_async_execution_detail_view import DevboxAsyncExecutionDetailView
@@ -107,7 +107,7 @@ def result(self, **options: Unpack[LongRequestOptions]) -> ExecutionResult:
 
         return ExecutionResult(self._client, self._devbox_id, final)
 
-    def get_state(self, **options: Unpack[RequestOptions]) -> DevboxAsyncExecutionDetailView:
+    def get_state(self, **options: Unpack[BaseRequestOptions]) -> DevboxAsyncExecutionDetailView:
         """Fetch the latest execution state.
 
         :param options: Optional request configuration