change params to use :typeddict: tag

Author: sid-rl

src/runloop_api_client/sdk/async_.py

@@ -56,7 +56,7 @@ async def create(
     ) -> AsyncDevbox:
         """Provision a new devbox and wait until it reaches ``running`` state.
 
-        :param params: Keyword arguments forwarded to the devbox creation API
+        :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKDevboxCreateParams` for available parameters
         :return: Wrapper bound to the newly created devbox
         :rtype: AsyncDevbox
         """
@@ -74,7 +74,7 @@ async def create_from_blueprint_id(
 
         :param blueprint_id: Blueprint ID to create from
         :type blueprint_id: str
-        :param params: Additional creation parameters (metadata, launch parameters, etc.)
+        :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKDevboxExtraCreateParams` for available parameters
         :return: Wrapper bound to the newly created devbox
         :rtype: AsyncDevbox
         """
@@ -93,7 +93,7 @@ async def create_from_blueprint_name(
 
         :param blueprint_name: Blueprint name to create from
         :type blueprint_name: str
-        :param params: Additional creation parameters (metadata, launch parameters, etc.)
+        :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKDevboxExtraCreateParams` for available parameters
         :return: Wrapper bound to the newly created devbox
         :rtype: AsyncDevbox
         """
@@ -112,7 +112,7 @@ async def create_from_snapshot(
 
         :param snapshot_id: Snapshot ID to create from
         :type snapshot_id: str
-        :param params: Additional creation parameters (metadata, launch parameters, etc.)
+        :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKDevboxExtraCreateParams` for available parameters
         :return: Wrapper bound to the newly created devbox
         :rtype: AsyncDevbox
         """
@@ -138,7 +138,7 @@ async def list(
     ) -> list[AsyncDevbox]:
         """List devboxes accessible to the caller.
 
-        :param params: Filtering and pagination parameters
+        :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKDevboxListParams` for available parameters
         :return: Collection of devbox wrappers
         :rtype: list[AsyncDevbox]
         """
@@ -174,7 +174,7 @@ async def list(
     ) -> list[AsyncSnapshot]:
         """List snapshots created from devboxes.
 
-        :param params: Filtering and pagination parameters
+        :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKDiskSnapshotListParams` for available parameters
         :return: Snapshot wrappers for each record
         :rtype: list[AsyncSnapshot]
         """
@@ -224,7 +224,7 @@ async def create(
     ) -> AsyncBlueprint:
         """Create a blueprint and wait for the build to finish.
 
-        :param params: Blueprint definition (Dockerfile, metadata, etc.)
+        :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKBlueprintCreateParams` for available parameters
         :return: Wrapper bound to the finished blueprint
         :rtype: AsyncBlueprint
         """
@@ -249,7 +249,7 @@ async def list(
     ) -> list[AsyncBlueprint]:
         """List available blueprints.
 
-        :param params: Filtering and pagination parameters
+        :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKBlueprintListParams` for available parameters
         :return: Blueprint wrappers for each record
         :rtype: list[AsyncBlueprint]
         """
@@ -287,7 +287,7 @@ async def create(
     ) -> AsyncStorageObject:
         """Create a storage object and obtain an upload URL.
 
-        :param params: Object creation parameters (name, content type, metadata)
+        :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKObjectCreateParams` for available parameters
         :return: Wrapper with upload URL set for immediate uploads
         :rtype: AsyncStorageObject
         """
@@ -310,7 +310,7 @@ async def list(
     ) -> list[AsyncStorageObject]:
         """List storage objects owned by the caller.
 
-        :param params: Filtering and pagination parameters
+        :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKObjectListParams` for available parameters
         :return: Storage object wrappers for each record
         :rtype: list[AsyncStorageObject]
         """
@@ -338,7 +338,7 @@ async def upload_from_file(
         :type content_type: ContentType | None, optional
         :param metadata: Optional key-value metadata, defaults to None
         :type metadata: Optional[Dict[str, str]], optional
-        :param options: Additional request configuration
+        :param options: See :typeddict:`~runloop_api_client.sdk._types.LongRequestOptions` for available options
         :return: Wrapper for the uploaded object
         :rtype: AsyncStorageObject
         :raises OSError: If the local file cannot be read
@@ -373,7 +373,7 @@ async def upload_from_text(
         :type name: str
         :param metadata: Optional key-value metadata, defaults to None
         :type metadata: Optional[Dict[str, str]], optional
-        :param options: Additional request configuration
+        :param options: See :typeddict:`~runloop_api_client.sdk._types.LongRequestOptions` for available options
         :return: Wrapper for the uploaded object
         :rtype: AsyncStorageObject
         """
@@ -401,7 +401,7 @@ async def upload_from_bytes(
         :type content_type: ContentType
         :param metadata: Optional key-value metadata, defaults to None
         :type metadata: Optional[Dict[str, str]], optional
-        :param options: Additional request configuration
+        :param options: See :typeddict:`~runloop_api_client.sdk._types.LongRequestOptions` for available options
         :return: Wrapper for the uploaded object
         :rtype: AsyncStorageObject
         """

src/runloop_api_client/sdk/async_blueprint.py

@@ -93,7 +93,7 @@ async def create_devbox(
     ) -> "AsyncDevbox":
         """Create a devbox derived from the blueprint.
 
-        :param params: Creation parameters to forward to the devbox API
+        :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKDevboxExtraCreateParams` for available parameters
         :return: Wrapper bound to the running devbox
         :rtype: AsyncDevbox
         """

src/runloop_api_client/sdk/async_devbox.py

@@ -215,7 +215,7 @@ async def snapshot_disk(
         Captures the current state of the devbox disk, which can be used to create
         new devboxes with the same state.
 
-        :param params: Snapshot metadata, naming, and polling configuration
+        :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKDevboxSnapshotDiskParams` for available parameters
         :return: Wrapper representing the completed snapshot
         :rtype: AsyncSnapshot
         """
@@ -236,7 +236,7 @@ async def snapshot_disk_async(
         Starts the snapshot creation process and returns immediately without waiting
         for completion. Use snapshot.await_completed() to wait for completion.
 
-        :param params: Snapshot metadata and naming options
+        :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKDevboxSnapshotDiskAsyncParams` for available parameters
         :return: Wrapper representing the snapshot request
         :rtype: AsyncSnapshot
         """
@@ -371,7 +371,7 @@ async def exec(
     ) -> AsyncExecutionResult:
         """Execute a command synchronously and wait for completion.
 
-        :param params: Command parameters, streaming callbacks, and polling config
+        :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKDevboxExecuteParams` for available parameters
         :return: Wrapper with exit status and output helpers
         :rtype: AsyncExecutionResult
 
@@ -428,7 +428,7 @@ async def exec_async(
         for process management. Use execution.result() to wait for completion or
         execution.kill() to terminate the process.
 
-        :param params: Command parameters and streaming callbacks
+        :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKDevboxExecuteAsyncParams` for available parameters
         :return: Handle for managing the running process
         :rtype: AsyncExecution
 
@@ -471,7 +471,7 @@ async def read(
     ) -> str:
         """Read a file from the devbox.
 
-        :param params: Parameters such as ``path``
+        :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKDevboxReadFileContentsParams` for available parameters
         :return: File contents
         :rtype: str
 
@@ -492,7 +492,7 @@ async def write(
 
         Creates or overwrites the file at the specified path.
 
-        :param params: Parameters such as ``file_path`` and ``contents``
+        :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKDevboxWriteFileContentsParams` for available parameters
         :return: Execution metadata for the write command
         :rtype: DevboxExecutionDetailView
 
@@ -510,7 +510,7 @@ async def download(
     ) -> bytes:
         """Download a file from the devbox.
 
-        :param params: Parameters such as ``path``
+        :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKDevboxDownloadFileParams` for available parameters
         :return: Raw file contents
         :rtype: bytes
 
@@ -531,7 +531,7 @@ async def upload(
     ) -> object:
         """Upload a file to the devbox.
 
-        :param params: Parameters such as destination ``path`` and local ``file``
+        :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKDevboxUploadFileParams` for available parameters
         :return: API response confirming the upload
         :rtype: object
 
@@ -579,7 +579,7 @@ async def create_tunnel(
     ) -> DevboxTunnelView:
         """Create a network tunnel to expose a devbox port publicly.
 
-        :param params: Parameters such as the devbox ``port`` to expose
+        :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKDevboxCreateTunnelParams` for available parameters
         :return: Details about the public endpoint
         :rtype: DevboxTunnelView
 
@@ -598,7 +598,7 @@ async def remove_tunnel(
     ) -> object:
         """Remove a network tunnel, disabling public access to the port.
 
-        :param params: Parameters such as the ``port`` to close
+        :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKDevboxRemoveTunnelParams` for available parameters
         :return: Response confirming the tunnel removal
         :rtype: object
 

src/runloop_api_client/sdk/async_snapshot.py

@@ -69,7 +69,7 @@ async def update(
     ) -> DevboxSnapshotView:
         """Update snapshot metadata.
 
-        :param params: Fields to update on the snapshot
+        :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKDiskSnapshotUpdateParams` for available parameters
         :return: Updated snapshot details
         :rtype: DevboxSnapshotView
         """
@@ -114,7 +114,7 @@ async def create_devbox(
     ) -> "AsyncDevbox":
         """Create a devbox restored from this snapshot.
 
-        :param params: Creation parameters forwarded to the devbox API
+        :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKDevboxExtraCreateParams` for available parameters
         :return: Wrapper bound to the running devbox
         :rtype: AsyncDevbox
         """

src/runloop_api_client/sdk/async_storage_object.py

@@ -87,7 +87,7 @@ async def get_download_url(
     ) -> ObjectDownloadURLView:
         """Request a signed download URL for the object.
 
-        :param params: Parameters controlling the download URL (e.g., expiry)
+        :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKObjectDownloadParams` for available parameters
         :return: URL + metadata describing the download
         :rtype: ObjectDownloadURLView
         """
@@ -102,7 +102,7 @@ async def download_as_bytes(
     ) -> bytes:
         """Download the object contents as bytes.
 
-        :param params: Parameters forwarded to ``get_download_url``
+        :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKObjectDownloadParams` for available parameters
         :return: Entire object payload
         :rtype: bytes
         """
@@ -119,7 +119,7 @@ async def download_as_text(
     ) -> str:
         """Download the object contents as UTF-8 text.
 
-        :param params: Parameters forwarded to ``get_download_url``
+        :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKObjectDownloadParams` for available parameters
         :return: Entire object payload decoded as UTF-8
         :rtype: str
         """

src/runloop_api_client/sdk/blueprint.py

@@ -93,7 +93,7 @@ def create_devbox(
     ) -> "Devbox":
         """Create a devbox derived from the blueprint.
 
-        :param params: Creation parameters to forward to the devbox API
+        :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKDevboxExtraCreateParams` for available parameters
         :return: Wrapper bound to the running devbox
         :rtype: Devbox
         """

src/runloop_api_client/sdk/devbox.py

@@ -223,7 +223,7 @@ def snapshot_disk(
         Captures the current state of the devbox disk, which can be used to create
         new devboxes with the same state.
 
-        :param params: Snapshot metadata, naming, and polling configuration
+        :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKDevboxSnapshotDiskParams` for available parameters
         :return: Wrapper representing the completed snapshot
         :rtype: Snapshot
         """
@@ -244,7 +244,7 @@ def snapshot_disk_async(
         Starts the snapshot creation process and returns immediately without waiting
         for completion. Use snapshot.await_completed() to wait for completion.
 
-        :param params: Snapshot metadata and naming options
+        :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKDevboxSnapshotDiskAsyncParams` for available parameters
         :return: Wrapper representing the snapshot (may still be processing)
         :rtype: Snapshot
         """
@@ -395,7 +395,7 @@ def exec(
     ) -> ExecutionResult:
         """Execute a command synchronously and wait for completion.
 
-        :param params: Command parameters, streaming callbacks, and polling config
+        :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKDevboxExecuteParams` for available parameters
         :return: Wrapper with exit status and output helpers
         :rtype: ExecutionResult
 
@@ -442,7 +442,7 @@ def exec_async(
         for process management. Use execution.result() to wait for completion or
         execution.kill() to terminate the process.
 
-        :param params: Command parameters and streaming callbacks
+        :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKDevboxExecuteAsyncParams` for available parameters
         :return: Handle for managing the running process
         :rtype: Execution
 
@@ -485,7 +485,7 @@ def read(
     ) -> str:
         """Read a file from the devbox.
 
-        :param params: Parameters such as ``path``
+        :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKDevboxReadFileContentsParams` for available parameters
         :return: File contents
         :rtype: str
 
@@ -506,7 +506,7 @@ def write(
 
         Creates or overwrites the file at the specified path.
 
-        :param params: Parameters such as ``file_path`` and ``contents``
+        :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKDevboxWriteFileContentsParams` for available parameters
         :return: Execution metadata for the write command
         :rtype: DevboxExecutionDetailView
 
@@ -524,7 +524,7 @@ def download(
     ) -> bytes:
         """Download a file from the devbox.
 
-        :param params: Parameters such as ``path``
+        :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKDevboxDownloadFileParams` for available parameters
         :return: Raw file contents
         :rtype: bytes
 
@@ -545,7 +545,7 @@ def upload(
     ) -> object:
         """Upload a file to the devbox.
 
-        :param params: Parameters such as destination ``path`` and local ``file``
+        :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKDevboxUploadFileParams` for available parameters
         :return: API response confirming the upload
         :rtype: object
 
@@ -593,7 +593,7 @@ def create_tunnel(
     ) -> DevboxTunnelView:
         """Create a network tunnel to expose a devbox port publicly.
 
-        :param params: Parameters such as the devbox ``port`` to expose
+        :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKDevboxCreateTunnelParams` for available parameters
         :return: Details about the public endpoint
         :rtype: DevboxTunnelView
 
@@ -612,7 +612,7 @@ def remove_tunnel(
     ) -> object:
         """Remove a network tunnel, disabling public access to the port.
 
-        :param params: Parameters such as the ``port`` to close
+        :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKDevboxRemoveTunnelParams` for available parameters
         :return: Response confirming the tunnel removal
         :rtype: object
 

src/runloop_api_client/sdk/snapshot.py

@@ -69,7 +69,7 @@ def update(
     ) -> DevboxSnapshotView:
         """Update snapshot metadata.
 
-        :param params: Fields to update on the snapshot
+        :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKDiskSnapshotUpdateParams` for available parameters
         :return: Updated snapshot details
         :rtype: DevboxSnapshotView
         """
@@ -114,7 +114,7 @@ def create_devbox(
     ) -> "Devbox":
         """Create a devbox restored from this snapshot.
 
-        :param params: Creation parameters to forward to the devbox API
+        :param params: See :typeddict:`~runloop_api_client.sdk._types.SDKDevboxExtraCreateParams` for available parameters
         :return: Wrapper bound to the running devbox
         :rtype: Devbox
         """