boat-sdk 1.0.0__py3-none-any.whl

boat_sdk/__init__.py

@@ -0,0 +1,296 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    Boat Public API v1
+
+    Public JSON API for creating, operating, prompting, observing, and exposing sandboxes from backend services, CI jobs, hosted workers, and Boat automation products.  The v1 reference intentionally documents the developer integration surface only. Dashboard billing actions are not part of v1. 
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+__version__ = "1.0.0"
+
+# Define package exports
+__all__ = [
+    "BoatApi",
+    "ApiResponse",
+    "ApiClient",
+    "Configuration",
+    "OpenApiException",
+    "ApiTypeError",
+    "ApiValueError",
+    "ApiKeyError",
+    "ApiAttributeError",
+    "ApiException",
+    "AddEnvironmentRepoRequest",
+    "ApiKey",
+    "ApiKeyCatalog",
+    "ApiKeyCatalogScopeResources",
+    "ApiKeyCreatedResource",
+    "ApiKeyRequestUsage",
+    "ApiKeyResourceTotals",
+    "ApiKeyRevokeResponse",
+    "ApiKeyScope",
+    "ApiKeyScopeResource",
+    "ApiKeyScopeSandboxes",
+    "ApiKeySecretResponse",
+    "ApiKeyUsageResponse",
+    "ApiKeysResponse",
+    "Command200Response",
+    "CommandRequest",
+    "CommandResponse",
+    "CommandStartedResponse",
+    "CommandStatusResponse",
+    "CompletionEvent",
+    "Conversation",
+    "ConversationsResponse",
+    "CreateSandboxEnvironmentRequest",
+    "CreateSandboxRequest",
+    "CreateSandboxResponse",
+    "CreateScopedApiKey503Response",
+    "CreateScopedApiKeyRequest",
+    "DataRetentionPolicyResponse",
+    "DataRetentionUpdateRequest",
+    "DeletionOperation",
+    "DeletionOperationResponse",
+    "DesktopRequest",
+    "DesktopResponse",
+    "EnvironmentItemChangeResponse",
+    "ErrorEnvelope",
+    "ErrorEnvelopeError",
+    "ErrorEvent",
+    "EventsResponse",
+    "FileReadResponse",
+    "FileWriteRequest",
+    "FileWriteResponse",
+    "ForkRequest",
+    "HostPortRequest",
+    "HostPortResponse",
+    "LimitsFields",
+    "LimitsFieldsCurrentLimits",
+    "LimitsFieldsStartLimits",
+    "LimitsFieldsStarts",
+    "LimitsResponse",
+    "MeResponse",
+    "MeResponseAllOfUser",
+    "NamedSnapshot",
+    "NamedSnapshotDeletedResponse",
+    "NamedSnapshotInfoResponse",
+    "NamedSnapshotListResponse",
+    "NamedSnapshotSaveRequest",
+    "NamedSnapshotSavingResponse",
+    "PageInfo",
+    "PromptEvent",
+    "PromptEventData",
+    "PromptRequest",
+    "PromptResponse",
+    "PromptRun",
+    "PromptRunResponse",
+    "RepoSelectionRequest",
+    "RepoSelectionResponse",
+    "ReposResponse",
+    "Repository",
+    "RepositoryInstallation",
+    "ResponseEvent",
+    "ResponseEventData",
+    "ResumeRequest",
+    "RotateApiKey409Response",
+    "Sandbox",
+    "SandboxActionResponse",
+    "SandboxEnvironment",
+    "SandboxEnvironmentListResponse",
+    "SandboxEnvironmentResponse",
+    "SandboxEnvironmentVersionSummary",
+    "SandboxEvent",
+    "SandboxInfoResponse",
+    "SandboxListResponse",
+    "SandboxUsageResponse",
+    "SecretFile",
+    "SecretsResponse",
+    "SecretsUpdateRequest",
+    "SelectedRepository",
+    "SetEnvironmentSecretFileRequest",
+    "SetEnvironmentVarRequest",
+    "SnapshotChunk",
+    "SnapshotDownloadResponse",
+    "SnapshotDownloadResponseAllOfInventory",
+    "SnapshotLatestResponse",
+    "SnapshotListResponse",
+    "SnapshotSummary",
+    "SnapshotTreeEntry",
+    "SnapshotTreeResponse",
+    "SshKeyRequest",
+    "SshKeyResponse",
+    "StartWindowUsage",
+    "SteerEvent",
+    "SteerEventData",
+    "SteerRequest",
+    "SteerResponse",
+    "StopRequest",
+    "SuccessBase",
+    "UnknownEvent",
+    "UpdateSandboxEnvironmentRequest",
+    "UpdateSandboxEnvironmentRequestRepositoriesInner",
+    "UpdateSandboxRequest",
+    "UpgradeSandboxEnvironmentRequest",
+    "UpgradeSandboxEnvironmentResponse",
+    "Webhook",
+    "WebhookCreateRequest",
+    "WebhookDeleteResponse",
+    "WebhookEvent",
+    "WebhookEventData",
+    "WebhookEventDataSandbox",
+    "WebhookEventType",
+    "WebhookListResponse",
+    "WebhookResponse",
+    "WebhookSecretResponse",
+    "WebhookUpdateRequest",
+]
+
+# import apis into sdk package
+from boat_sdk.api.boat_api import BoatApi as BoatApi
+
+# import ApiClient
+from boat_sdk.api_response import ApiResponse as ApiResponse
+from boat_sdk.api_client import ApiClient as ApiClient
+from boat_sdk.configuration import Configuration as Configuration
+from boat_sdk.exceptions import OpenApiException as OpenApiException
+from boat_sdk.exceptions import ApiTypeError as ApiTypeError
+from boat_sdk.exceptions import ApiValueError as ApiValueError
+from boat_sdk.exceptions import ApiKeyError as ApiKeyError
+from boat_sdk.exceptions import ApiAttributeError as ApiAttributeError
+from boat_sdk.exceptions import ApiException as ApiException
+
+# import models into sdk package
+from boat_sdk.models.add_environment_repo_request import AddEnvironmentRepoRequest as AddEnvironmentRepoRequest
+from boat_sdk.models.api_key import ApiKey as ApiKey
+from boat_sdk.models.api_key_catalog import ApiKeyCatalog as ApiKeyCatalog
+from boat_sdk.models.api_key_catalog_scope_resources import ApiKeyCatalogScopeResources as ApiKeyCatalogScopeResources
+from boat_sdk.models.api_key_created_resource import ApiKeyCreatedResource as ApiKeyCreatedResource
+from boat_sdk.models.api_key_request_usage import ApiKeyRequestUsage as ApiKeyRequestUsage
+from boat_sdk.models.api_key_resource_totals import ApiKeyResourceTotals as ApiKeyResourceTotals
+from boat_sdk.models.api_key_revoke_response import ApiKeyRevokeResponse as ApiKeyRevokeResponse
+from boat_sdk.models.api_key_scope import ApiKeyScope as ApiKeyScope
+from boat_sdk.models.api_key_scope_resource import ApiKeyScopeResource as ApiKeyScopeResource
+from boat_sdk.models.api_key_scope_sandboxes import ApiKeyScopeSandboxes as ApiKeyScopeSandboxes
+from boat_sdk.models.api_key_secret_response import ApiKeySecretResponse as ApiKeySecretResponse
+from boat_sdk.models.api_key_usage_response import ApiKeyUsageResponse as ApiKeyUsageResponse
+from boat_sdk.models.api_keys_response import ApiKeysResponse as ApiKeysResponse
+from boat_sdk.models.command200_response import Command200Response as Command200Response
+from boat_sdk.models.command_request import CommandRequest as CommandRequest
+from boat_sdk.models.command_response import CommandResponse as CommandResponse
+from boat_sdk.models.command_started_response import CommandStartedResponse as CommandStartedResponse
+from boat_sdk.models.command_status_response import CommandStatusResponse as CommandStatusResponse
+from boat_sdk.models.completion_event import CompletionEvent as CompletionEvent
+from boat_sdk.models.conversation import Conversation as Conversation
+from boat_sdk.models.conversations_response import ConversationsResponse as ConversationsResponse
+from boat_sdk.models.create_sandbox_environment_request import CreateSandboxEnvironmentRequest as CreateSandboxEnvironmentRequest
+from boat_sdk.models.create_sandbox_request import CreateSandboxRequest as CreateSandboxRequest
+from boat_sdk.models.create_sandbox_response import CreateSandboxResponse as CreateSandboxResponse
+from boat_sdk.models.create_scoped_api_key503_response import CreateScopedApiKey503Response as CreateScopedApiKey503Response
+from boat_sdk.models.create_scoped_api_key_request import CreateScopedApiKeyRequest as CreateScopedApiKeyRequest
+from boat_sdk.models.data_retention_policy_response import DataRetentionPolicyResponse as DataRetentionPolicyResponse
+from boat_sdk.models.data_retention_update_request import DataRetentionUpdateRequest as DataRetentionUpdateRequest
+from boat_sdk.models.deletion_operation import DeletionOperation as DeletionOperation
+from boat_sdk.models.deletion_operation_response import DeletionOperationResponse as DeletionOperationResponse
+from boat_sdk.models.desktop_request import DesktopRequest as DesktopRequest
+from boat_sdk.models.desktop_response import DesktopResponse as DesktopResponse
+from boat_sdk.models.environment_item_change_response import EnvironmentItemChangeResponse as EnvironmentItemChangeResponse
+from boat_sdk.models.error_envelope import ErrorEnvelope as ErrorEnvelope
+from boat_sdk.models.error_envelope_error import ErrorEnvelopeError as ErrorEnvelopeError
+from boat_sdk.models.error_event import ErrorEvent as ErrorEvent
+from boat_sdk.models.events_response import EventsResponse as EventsResponse
+from boat_sdk.models.file_read_response import FileReadResponse as FileReadResponse
+from boat_sdk.models.file_write_request import FileWriteRequest as FileWriteRequest
+from boat_sdk.models.file_write_response import FileWriteResponse as FileWriteResponse
+from boat_sdk.models.fork_request import ForkRequest as ForkRequest
+from boat_sdk.models.host_port_request import HostPortRequest as HostPortRequest
+from boat_sdk.models.host_port_response import HostPortResponse as HostPortResponse
+from boat_sdk.models.limits_fields import LimitsFields as LimitsFields
+from boat_sdk.models.limits_fields_current_limits import LimitsFieldsCurrentLimits as LimitsFieldsCurrentLimits
+from boat_sdk.models.limits_fields_start_limits import LimitsFieldsStartLimits as LimitsFieldsStartLimits
+from boat_sdk.models.limits_fields_starts import LimitsFieldsStarts as LimitsFieldsStarts
+from boat_sdk.models.limits_response import LimitsResponse as LimitsResponse
+from boat_sdk.models.me_response import MeResponse as MeResponse
+from boat_sdk.models.me_response_all_of_user import MeResponseAllOfUser as MeResponseAllOfUser
+from boat_sdk.models.named_snapshot import NamedSnapshot as NamedSnapshot
+from boat_sdk.models.named_snapshot_deleted_response import NamedSnapshotDeletedResponse as NamedSnapshotDeletedResponse
+from boat_sdk.models.named_snapshot_info_response import NamedSnapshotInfoResponse as NamedSnapshotInfoResponse
+from boat_sdk.models.named_snapshot_list_response import NamedSnapshotListResponse as NamedSnapshotListResponse
+from boat_sdk.models.named_snapshot_save_request import NamedSnapshotSaveRequest as NamedSnapshotSaveRequest
+from boat_sdk.models.named_snapshot_saving_response import NamedSnapshotSavingResponse as NamedSnapshotSavingResponse
+from boat_sdk.models.page_info import PageInfo as PageInfo
+from boat_sdk.models.prompt_event import PromptEvent as PromptEvent
+from boat_sdk.models.prompt_event_data import PromptEventData as PromptEventData
+from boat_sdk.models.prompt_request import PromptRequest as PromptRequest
+from boat_sdk.models.prompt_response import PromptResponse as PromptResponse
+from boat_sdk.models.prompt_run import PromptRun as PromptRun
+from boat_sdk.models.prompt_run_response import PromptRunResponse as PromptRunResponse
+from boat_sdk.models.repo_selection_request import RepoSelectionRequest as RepoSelectionRequest
+from boat_sdk.models.repo_selection_response import RepoSelectionResponse as RepoSelectionResponse
+from boat_sdk.models.repos_response import ReposResponse as ReposResponse
+from boat_sdk.models.repository import Repository as Repository
+from boat_sdk.models.repository_installation import RepositoryInstallation as RepositoryInstallation
+from boat_sdk.models.response_event import ResponseEvent as ResponseEvent
+from boat_sdk.models.response_event_data import ResponseEventData as ResponseEventData
+from boat_sdk.models.resume_request import ResumeRequest as ResumeRequest
+from boat_sdk.models.rotate_api_key409_response import RotateApiKey409Response as RotateApiKey409Response
+from boat_sdk.models.sandbox import Sandbox as Sandbox
+from boat_sdk.models.sandbox_action_response import SandboxActionResponse as SandboxActionResponse
+from boat_sdk.models.sandbox_environment import SandboxEnvironment as SandboxEnvironment
+from boat_sdk.models.sandbox_environment_list_response import SandboxEnvironmentListResponse as SandboxEnvironmentListResponse
+from boat_sdk.models.sandbox_environment_response import SandboxEnvironmentResponse as SandboxEnvironmentResponse
+from boat_sdk.models.sandbox_environment_version_summary import SandboxEnvironmentVersionSummary as SandboxEnvironmentVersionSummary
+from boat_sdk.models.sandbox_event import SandboxEvent as SandboxEvent
+from boat_sdk.models.sandbox_info_response import SandboxInfoResponse as SandboxInfoResponse
+from boat_sdk.models.sandbox_list_response import SandboxListResponse as SandboxListResponse
+from boat_sdk.models.sandbox_usage_response import SandboxUsageResponse as SandboxUsageResponse
+from boat_sdk.models.secret_file import SecretFile as SecretFile
+from boat_sdk.models.secrets_response import SecretsResponse as SecretsResponse
+from boat_sdk.models.secrets_update_request import SecretsUpdateRequest as SecretsUpdateRequest
+from boat_sdk.models.selected_repository import SelectedRepository as SelectedRepository
+from boat_sdk.models.set_environment_secret_file_request import SetEnvironmentSecretFileRequest as SetEnvironmentSecretFileRequest
+from boat_sdk.models.set_environment_var_request import SetEnvironmentVarRequest as SetEnvironmentVarRequest
+from boat_sdk.models.snapshot_chunk import SnapshotChunk as SnapshotChunk
+from boat_sdk.models.snapshot_download_response import SnapshotDownloadResponse as SnapshotDownloadResponse
+from boat_sdk.models.snapshot_download_response_all_of_inventory import SnapshotDownloadResponseAllOfInventory as SnapshotDownloadResponseAllOfInventory
+from boat_sdk.models.snapshot_latest_response import SnapshotLatestResponse as SnapshotLatestResponse
+from boat_sdk.models.snapshot_list_response import SnapshotListResponse as SnapshotListResponse
+from boat_sdk.models.snapshot_summary import SnapshotSummary as SnapshotSummary
+from boat_sdk.models.snapshot_tree_entry import SnapshotTreeEntry as SnapshotTreeEntry
+from boat_sdk.models.snapshot_tree_response import SnapshotTreeResponse as SnapshotTreeResponse
+from boat_sdk.models.ssh_key_request import SshKeyRequest as SshKeyRequest
+from boat_sdk.models.ssh_key_response import SshKeyResponse as SshKeyResponse
+from boat_sdk.models.start_window_usage import StartWindowUsage as StartWindowUsage
+from boat_sdk.models.steer_event import SteerEvent as SteerEvent
+from boat_sdk.models.steer_event_data import SteerEventData as SteerEventData
+from boat_sdk.models.steer_request import SteerRequest as SteerRequest
+from boat_sdk.models.steer_response import SteerResponse as SteerResponse
+from boat_sdk.models.stop_request import StopRequest as StopRequest
+from boat_sdk.models.success_base import SuccessBase as SuccessBase
+from boat_sdk.models.unknown_event import UnknownEvent as UnknownEvent
+from boat_sdk.models.update_sandbox_environment_request import UpdateSandboxEnvironmentRequest as UpdateSandboxEnvironmentRequest
+from boat_sdk.models.update_sandbox_environment_request_repositories_inner import UpdateSandboxEnvironmentRequestRepositoriesInner as UpdateSandboxEnvironmentRequestRepositoriesInner
+from boat_sdk.models.update_sandbox_request import UpdateSandboxRequest as UpdateSandboxRequest
+from boat_sdk.models.upgrade_sandbox_environment_request import UpgradeSandboxEnvironmentRequest as UpgradeSandboxEnvironmentRequest
+from boat_sdk.models.upgrade_sandbox_environment_response import UpgradeSandboxEnvironmentResponse as UpgradeSandboxEnvironmentResponse
+from boat_sdk.models.webhook import Webhook as Webhook
+from boat_sdk.models.webhook_create_request import WebhookCreateRequest as WebhookCreateRequest
+from boat_sdk.models.webhook_delete_response import WebhookDeleteResponse as WebhookDeleteResponse
+from boat_sdk.models.webhook_event import WebhookEvent as WebhookEvent
+from boat_sdk.models.webhook_event_data import WebhookEventData as WebhookEventData
+from boat_sdk.models.webhook_event_data_sandbox import WebhookEventDataSandbox as WebhookEventDataSandbox
+from boat_sdk.models.webhook_event_type import WebhookEventType as WebhookEventType
+from boat_sdk.models.webhook_list_response import WebhookListResponse as WebhookListResponse
+from boat_sdk.models.webhook_response import WebhookResponse as WebhookResponse
+from boat_sdk.models.webhook_secret_response import WebhookSecretResponse as WebhookSecretResponse
+from boat_sdk.models.webhook_update_request import WebhookUpdateRequest as WebhookUpdateRequest
+
+
+from boat_sdk.boat_helpers import wait_until_ready, wait_until_idle, wait_for_desktop, wait_for_prompt, wait_for_prompt_done, stream_events, stream_prompt, stop_and_remove, read_text, write_text, exec_command

boat_sdk/api/__init__.py

@@ -0,0 +1,5 @@
+# flake8: noqa
+
+# import apis into api package
+from boat_sdk.api.boat_api import BoatApi
+