chore: add missing docstrings

stainless-app[bot] · stainless-app[bot] · commit 8317d2a29f11 · 2025-12-11T00:45:51.000Z
diff --git a/src/runloop_api_client/types/agent_list_view.py b/src/runloop_api_client/types/agent_list_view.py
@@ -9,6 +9,8 @@
 
 
 class AgentListView(BaseModel):
+    """A paginated list of Agents."""
+
     agents: List[AgentView]
     """The list of Agents."""
 
diff --git a/src/runloop_api_client/types/agent_view.py b/src/runloop_api_client/types/agent_view.py
@@ -9,6 +9,8 @@
 
 
 class AgentView(BaseModel):
+    """An Agent represents a registered AI agent entity."""
+
     id: str
     """The unique identifier of the Agent."""
 
diff --git a/src/runloop_api_client/types/benchmark_run_view.py b/src/runloop_api_client/types/benchmark_run_view.py
@@ -9,6 +9,10 @@
 
 
 class BenchmarkRunView(BaseModel):
+    """
+    A BenchmarkRunView represents a run of a complete set of Scenarios, organized under a Benchmark.
+    """
+
     id: str
     """The ID of the BenchmarkRun."""
 
diff --git a/src/runloop_api_client/types/benchmark_view.py b/src/runloop_api_client/types/benchmark_view.py
@@ -10,6 +10,10 @@
 
 
 class BenchmarkView(BaseModel):
+    """
+    A BenchmarkDefinitionView represents a grouped set of Scenarios that together form a Benchmark.
+    """
+
     id: str
     """The ID of the Benchmark."""
 
diff --git a/src/runloop_api_client/types/blueprint_build_parameters.py b/src/runloop_api_client/types/blueprint_build_parameters.py
@@ -11,13 +11,17 @@
 
 
 class BuildContext(BaseModel):
+    """A build context backed by an Object."""
+
     object_id: str
     """The ID of an object, whose contents are to be used as a build context."""
 
     type: Literal["object"]
 
 
 class ServiceCredentials(BaseModel):
+    """The credentials of the container service."""
+
     password: str
     """The password of the container service."""
 
diff --git a/src/runloop_api_client/types/blueprint_create_params.py b/src/runloop_api_client/types/blueprint_create_params.py
@@ -71,13 +71,17 @@ class BlueprintCreateParams(TypedDict, total=False):
 
 
 class BuildContext(TypedDict, total=False):
+    """A build context backed by an Object."""
+
     object_id: Required[str]
     """The ID of an object, whose contents are to be used as a build context."""
 
     type: Required[Literal["object"]]
 
 
 class ServiceCredentials(TypedDict, total=False):
+    """The credentials of the container service."""
+
     password: Required[str]
     """The password of the container service."""
 
diff --git a/src/runloop_api_client/types/blueprint_preview_params.py b/src/runloop_api_client/types/blueprint_preview_params.py
@@ -71,13 +71,17 @@ class BlueprintPreviewParams(TypedDict, total=False):
 
 
 class BuildContext(TypedDict, total=False):
+    """A build context backed by an Object."""
+
     object_id: Required[str]
     """The ID of an object, whose contents are to be used as a build context."""
 
     type: Required[Literal["object"]]
 
 
 class ServiceCredentials(TypedDict, total=False):
+    """The credentials of the container service."""
+
     password: Required[str]
     """The password of the container service."""
 
diff --git a/src/runloop_api_client/types/blueprint_view.py b/src/runloop_api_client/types/blueprint_view.py
@@ -10,6 +10,8 @@
 
 
 class ContainerizedServiceCredentials(BaseModel):
+    """The credentials of the container service."""
+
     password: str
     """The password of the container service."""
 
@@ -41,6 +43,11 @@ class ContainerizedService(BaseModel):
 
 
 class BlueprintView(BaseModel):
+    """Blueprints are ways to create customized starting points for Devboxes.
+
+    They allow you to define custom starting points for Devboxes such that environment set up can be cached to improve Devbox boot times.
+    """
+
     id: str
     """The id of the Blueprint."""
 
diff --git a/src/runloop_api_client/types/devbox_view.py b/src/runloop_api_client/types/devbox_view.py
@@ -31,6 +31,11 @@ class StateTransition(BaseModel):
 
 
 class DevboxView(BaseModel):
+    """A Devbox represents a virtual development environment.
+
+    It is an isolated sandbox that can be given to agents and used to run arbitrary code such as AI generated code.
+    """
+
     id: str
     """The ID of the Devbox."""
 
diff --git a/src/runloop_api_client/types/devboxes/browser_view.py b/src/runloop_api_client/types/devboxes/browser_view.py
@@ -7,6 +7,10 @@
 
 
 class BrowserView(BaseModel):
+    """
+    A Browser represents a managed implementation of a browser like Chromiumon top of Devboxes. It includes the tunnel to the live screen and the underlying DevboxView.
+    """
+
     connection_url: str
     """
     The url to enable remote connection from browser automation tools like
diff --git a/src/runloop_api_client/types/devboxes/computer_create_params.py b/src/runloop_api_client/types/devboxes/computer_create_params.py
@@ -17,6 +17,8 @@ class ComputerCreateParams(TypedDict, total=False):
 
 
 class DisplayDimensions(TypedDict, total=False):
+    """Customize the dimensions of the computer display."""
+
     display_height_px: Required[int]
     """The height of the display being controlled by the model in pixels."""
 
diff --git a/src/runloop_api_client/types/devboxes/computer_mouse_interaction_params.py b/src/runloop_api_client/types/devboxes/computer_mouse_interaction_params.py
@@ -23,6 +23,11 @@ class ComputerMouseInteractionParams(TypedDict, total=False):
 
 
 class Coordinate(TypedDict, total=False):
+    """
+    The x (pixels from the left) and y (pixels from the top) coordinates for the mouse to move or click-drag.  Required only by
+            `action=mouse_move` or `action=left_click_drag`
+    """
+
     x: Required[int]
     """The x coordinate (pixels from the left) for the mouse to move or click-drag."""
 
diff --git a/src/runloop_api_client/types/devboxes/computer_view.py b/src/runloop_api_client/types/devboxes/computer_view.py
@@ -7,6 +7,10 @@
 
 
 class ComputerView(BaseModel):
+    """
+    A Computer represents an implementation of Anthropic Computer usage on top of Devboxes. It includes the tunnel to the live screen and the underlying DevboxView.
+    """
+
     devbox: DevboxView
     """The underlying devbox the computer setup is running on."""
 
diff --git a/src/runloop_api_client/types/input_context.py b/src/runloop_api_client/types/input_context.py
@@ -8,6 +8,10 @@
 
 
 class InputContext(BaseModel):
+    """
+    InputContextView specifies the problem statement along with all additional context for a Scenario.
+    """
+
     problem_statement: str
     """The problem statement for the Scenario."""
 
diff --git a/src/runloop_api_client/types/input_context_param.py b/src/runloop_api_client/types/input_context_param.py
@@ -9,6 +9,10 @@
 
 
 class InputContextParam(TypedDict, total=False):
+    """
+    InputContextView specifies the problem statement along with all additional context for a Scenario.
+    """
+
     problem_statement: Required[str]
     """The problem statement for the Scenario."""
 
diff --git a/src/runloop_api_client/types/inspection_source_param.py b/src/runloop_api_client/types/inspection_source_param.py
@@ -9,6 +9,8 @@
 
 
 class InspectionSourceParam(TypedDict, total=False):
+    """Use a RepositoryInspection a source of a Blueprint build."""
+
     inspection_id: Required[str]
     """The ID of a repository inspection."""
 
diff --git a/src/runloop_api_client/types/object_download_url_view.py b/src/runloop_api_client/types/object_download_url_view.py
@@ -6,5 +6,7 @@
 
 
 class ObjectDownloadURLView(BaseModel):
+    """A response containing a presigned download URL for an Object."""
+
     download_url: str
     """The presigned download URL for the Object."""
diff --git a/src/runloop_api_client/types/object_list_view.py b/src/runloop_api_client/types/object_list_view.py
@@ -9,6 +9,8 @@
 
 
 class ObjectListView(BaseModel):
+    """A paginated list of Objects."""
+
     has_more: bool
     """True if there are more results available beyond this page."""
 
diff --git a/src/runloop_api_client/types/object_view.py b/src/runloop_api_client/types/object_view.py
@@ -9,6 +9,8 @@
 
 
 class ObjectView(BaseModel):
+    """An Object represents a stored data entity with metadata."""
+
     id: str
     """The unique identifier of the Object."""
 
diff --git a/src/runloop_api_client/types/repository_connection_view.py b/src/runloop_api_client/types/repository_connection_view.py
@@ -6,6 +6,8 @@
 
 
 class RepositoryConnectionView(BaseModel):
+    """The ID of the Repository."""
+
     id: str
     """The ID of the Repository."""
 
diff --git a/src/runloop_api_client/types/repository_inspection_details.py b/src/runloop_api_client/types/repository_inspection_details.py
@@ -10,6 +10,8 @@
 
 
 class WorkflowContextsActionsContext(BaseModel):
+    """Details about actions processing for this workflow."""
+
     actions_skipped_unnecessary: List[str]
     """
     Actions that were skipped because they were unnecessary (e.g., upload
@@ -26,6 +28,10 @@ class WorkflowContextsActionsContext(BaseModel):
 
 
 class WorkflowContexts(BaseModel):
+    """
+    Workflow context containing file name and details about actions processing during inspection.
+    """
+
     actions_context: WorkflowContextsActionsContext
     """Details about actions processing for this workflow."""
 
diff --git a/src/runloop_api_client/types/repository_manifest_view.py b/src/runloop_api_client/types/repository_manifest_view.py
@@ -17,6 +17,8 @@
 
 
 class ContainerConfig(BaseModel):
+    """Container configuration specifying the base image and setup commands."""
+
     base_image_name: str
     """The name of the base image.
 
@@ -41,6 +43,10 @@ class Language(BaseModel):
 
 
 class WorkspaceDevCommands(BaseModel):
+    """
+    Extracted common commands important to the developer life cycle like linting, testing, building, etc.
+    """
+
     build: Optional[List[str]] = None
     """Build command (e.g. npm run build)."""
 
@@ -58,6 +64,10 @@ class WorkspaceDevCommands(BaseModel):
 
 
 class Workspace(BaseModel):
+    """
+    A workspace is a buildable unit of code within a repository and often represents a deployable unit of code like a backend service or a frontend app.
+    """
+
     build_tool: List[str]
     """Name of the build tool used (e.g. pip, npm)."""
 
@@ -96,6 +106,8 @@ class Workspace(BaseModel):
 
 
 class ContainerizedServiceCredentials(BaseModel):
+    """The credentials of the container service."""
+
     password: str
     """The password of the container service."""
 
@@ -127,6 +139,10 @@ class ContainerizedService(BaseModel):
 
 
 class RepositoryManifestView(BaseModel):
+    """
+    The repository manifest contains container configuration and workspace definitions for a repository.
+    """
+
     container_config: ContainerConfig
     """Container configuration specifying the base image and setup commands."""
 
diff --git a/src/runloop_api_client/types/scenario_environment.py b/src/runloop_api_client/types/scenario_environment.py
@@ -9,6 +9,10 @@
 
 
 class ScenarioEnvironment(BaseModel):
+    """
+    ScenarioEnvironmentParameters specify the environment in which a Scenario will be run.
+    """
+
     blueprint_id: Optional[str] = None
     """Use the blueprint with matching ID."""
 
diff --git a/src/runloop_api_client/types/scenario_environment_param.py b/src/runloop_api_client/types/scenario_environment_param.py
@@ -11,6 +11,10 @@
 
 
 class ScenarioEnvironmentParam(TypedDict, total=False):
+    """
+    ScenarioEnvironmentParameters specify the environment in which a Scenario will be run.
+    """
+
     blueprint_id: Optional[str]
     """Use the blueprint with matching ID."""
 
diff --git a/src/runloop_api_client/types/scenario_run_view.py b/src/runloop_api_client/types/scenario_run_view.py
@@ -10,6 +10,11 @@
 
 
 class ScenarioRunView(BaseModel):
+    """A ScenarioRunView represents a single run of a Scenario on a Devbox.
+
+    When completed, the ScenarioRun will contain the final score and output of the run.
+    """
+
     id: str
     """ID of the ScenarioRun."""
 
diff --git a/src/runloop_api_client/types/scenario_view.py b/src/runloop_api_client/types/scenario_view.py
@@ -12,6 +12,10 @@
 
 
 class ScenarioView(BaseModel):
+    """
+    A ScenarioDefinitionView represents a repeatable AI coding evaluation test, complete with initial environment and scoring contract.
+    """
+
     id: str
     """The ID of the Scenario."""
 
diff --git a/src/runloop_api_client/types/scenarios/scorer_create_response.py b/src/runloop_api_client/types/scenarios/scorer_create_response.py
@@ -6,6 +6,8 @@
 
 
 class ScorerCreateResponse(BaseModel):
+    """A ScenarioScorerView represents a custom scoring function for a Scenario."""
+
     id: str
     """ID for the scenario scorer."""
 
diff --git a/src/runloop_api_client/types/scenarios/scorer_list_response.py b/src/runloop_api_client/types/scenarios/scorer_list_response.py
@@ -6,6 +6,8 @@
 
 
 class ScorerListResponse(BaseModel):
+    """A ScenarioScorerView represents a custom scoring function for a Scenario."""
+
     id: str
     """ID for the scenario scorer."""
 
diff --git a/src/runloop_api_client/types/scenarios/scorer_retrieve_response.py b/src/runloop_api_client/types/scenarios/scorer_retrieve_response.py
@@ -6,6 +6,8 @@
 
 
 class ScorerRetrieveResponse(BaseModel):
+    """A ScenarioScorerView represents a custom scoring function for a Scenario."""
+
     id: str
     """ID for the scenario scorer."""
 
diff --git a/src/runloop_api_client/types/scenarios/scorer_update_response.py b/src/runloop_api_client/types/scenarios/scorer_update_response.py
@@ -6,6 +6,8 @@
 
 
 class ScorerUpdateResponse(BaseModel):
+    """A ScenarioScorerView represents a custom scoring function for a Scenario."""
+
     id: str
     """ID for the scenario scorer."""
 
diff --git a/src/runloop_api_client/types/scoring_contract.py b/src/runloop_api_client/types/scoring_contract.py
@@ -9,5 +9,9 @@
 
 
 class ScoringContract(BaseModel):
+    """
+    InputContextView specifies the problem statement along with all additional context for a Scenario.
+    """
+
     scoring_function_parameters: List[ScoringFunction]
     """A list of scoring functions used to evaluate the Scenario."""
diff --git a/src/runloop_api_client/types/scoring_contract_param.py b/src/runloop_api_client/types/scoring_contract_param.py
diff --git a/src/runloop_api_client/types/scoring_contract_result_view.py b/src/runloop_api_client/types/scoring_contract_result_view.py
diff --git a/src/runloop_api_client/types/scoring_function.py b/src/runloop_api_client/types/scoring_function.py
diff --git a/src/runloop_api_client/types/scoring_function_param.py b/src/runloop_api_client/types/scoring_function_param.py
diff --git a/src/runloop_api_client/types/scoring_function_result_view.py b/src/runloop_api_client/types/scoring_function_result_view.py
diff --git a/src/runloop_api_client/types/secret_list_view.py b/src/runloop_api_client/types/secret_list_view.py
diff --git a/src/runloop_api_client/types/secret_view.py b/src/runloop_api_client/types/secret_view.py
diff --git a/src/runloop_api_client/types/shared/agent_source.py b/src/runloop_api_client/types/shared/agent_source.py
diff --git a/src/runloop_api_client/types/shared/launch_parameters.py b/src/runloop_api_client/types/shared/launch_parameters.py
diff --git a/src/runloop_api_client/types/shared_params/agent_source.py b/src/runloop_api_client/types/shared_params/agent_source.py
diff --git a/src/runloop_api_client/types/shared_params/launch_parameters.py b/src/runloop_api_client/types/shared_params/launch_parameters.py
