blueprints.py

# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

from __future__ import annotations

import typing_extensions
from typing import Dict, Iterable, Optional, TypedDict

import httpx

from ..types import (
    blueprint_list_params,
    blueprint_create_params,
    blueprint_preview_params,
    blueprint_list_public_params,
    blueprint_create_from_inspection_params,
)
from .._types import NOT_GIVEN, Body, Omit, Query, Headers, NotGiven, SequenceNotStr, omit, not_given
from .._utils import is_given, path_template, maybe_transform, async_maybe_transform
from .._compat import cached_property
from .._resource import SyncAPIResource, AsyncAPIResource
from .._response import (
    to_raw_response_wrapper,
    to_streamed_response_wrapper,
    async_to_raw_response_wrapper,
    async_to_streamed_response_wrapper,
)
from .._constants import FILE_MOUNT_MAX_SIZE_BYTES, FILE_MOUNT_TOTAL_MAX_SIZE_BYTES
from ..pagination import SyncBlueprintsCursorIDPage, AsyncBlueprintsCursorIDPage
from .._exceptions import RunloopError
from ..lib.polling import PollingConfig, poll_until
from .._base_client import AsyncPaginator, make_request_options
from ..lib.polling_async import async_poll_until
from .._utils._validation import ValidationNotification
from ..types.blueprint_view import BlueprintView
from ..types.blueprint_preview_view import BlueprintPreviewView
from ..types.inspection_source_param import InspectionSourceParam
from ..types.blueprint_build_logs_list_view import BlueprintBuildLogsListView
from ..types.shared_params.launch_parameters import LaunchParameters
from ..types.shared_params.code_mount_parameters import CodeMountParameters


# Type for request arguments that combine polling config with additional request options
class BlueprintRequestArgs(TypedDict, total=False):
    polling_config: PollingConfig | None
    # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
    # The extra values given here take precedence over values defined on the client or passed to this method.
    extra_headers: Headers | None
    extra_query: Query | None
    extra_body: Body | None
    timeout: float | httpx.Timeout | None | NotGiven


__all__ = ["BlueprintsResource", "AsyncBlueprintsResource", "BlueprintRequestArgs"]


def _format_bytes(num_bytes: int) -> str:
    """Format a byte count in a human-friendly way (KB/MB/GB).

    Uses binary units (1024). Avoids decimals when exact.
    """
    if num_bytes < 1024:
        return f"{num_bytes} bytes"
    for factor, unit in ((1 << 30, "GB"), (1 << 20, "MB"), (1 << 10, "KB")):
        if num_bytes >= factor:
            value = num_bytes / factor
            if float(value).is_integer():
                return f"{int(value)} {unit}"
            return f"{value:.1f} {unit}"
    return f"{num_bytes} bytes"


def _validate_file_mounts(file_mounts: Optional[Dict[str, str]] | Omit) -> ValidationNotification:
    """Validate file_mounts are within size constraints: returns validation failures.

    Currently enforces a maximum per-file size to avoid server-side issues with
    large inline file contents. Also enforces a maximum total size across all
    file_mounts.
    """

    note = ValidationNotification()

    if file_mounts is None or not is_given(file_mounts):
        return note

    total_size_bytes = 0
    for mount_path, content in file_mounts.items():
        # Measure size in bytes using UTF-8 encoding since payloads are JSON strings
        size_bytes = len(content.encode("utf-8"))
        if size_bytes > FILE_MOUNT_MAX_SIZE_BYTES:
            over = size_bytes - FILE_MOUNT_MAX_SIZE_BYTES
            note.add_error(
                f"file_mount '{mount_path}' is {_format_bytes(over)} over the limit "
                f"({_format_bytes(size_bytes)} / {_format_bytes(FILE_MOUNT_MAX_SIZE_BYTES)}). Use object_mounts instead."
            )
        total_size_bytes += size_bytes

    if total_size_bytes > FILE_MOUNT_TOTAL_MAX_SIZE_BYTES:
        total_over = total_size_bytes - FILE_MOUNT_TOTAL_MAX_SIZE_BYTES
        note.add_error(
            f"total file_mounts size is {_format_bytes(total_over)} over the limit "
            f"({_format_bytes(total_size_bytes)} / {_format_bytes(FILE_MOUNT_TOTAL_MAX_SIZE_BYTES)}). Use object_mounts instead."
        )

    return note


class BlueprintsResource(SyncAPIResource):
    @cached_property
    def with_raw_response(self) -> BlueprintsResourceWithRawResponse:
        """
        This property can be used as a prefix for any HTTP method call to return
        the raw response object instead of the parsed content.

        For more information, see https://www.github.com/runloopai/api-client-python#accessing-raw-response-data-eg-headers
        """
        return BlueprintsResourceWithRawResponse(self)

    @cached_property
    def with_streaming_response(self) -> BlueprintsResourceWithStreamingResponse:
        """
        An alternative to `.with_raw_response` that doesn't eagerly read the response body.

        For more information, see https://www.github.com/runloopai/api-client-python#with_streaming_response
        """
        return BlueprintsResourceWithStreamingResponse(self)

    def create(
        self,
        *,
        name: str,
        base_blueprint_id: Optional[str] | Omit = omit,
        base_blueprint_name: Optional[str] | Omit = omit,
        build_args: Optional[Dict[str, str]] | Omit = omit,
        build_context: Optional[blueprint_create_params.BuildContext] | Omit = omit,
        code_mounts: Optional[Iterable[CodeMountParameters]] | Omit = omit,
        dockerfile: Optional[str] | Omit = omit,
        file_mounts: Optional[Dict[str, str]] | Omit = omit,
        launch_parameters: Optional[LaunchParameters] | Omit = omit,
        metadata: Optional[Dict[str, str]] | Omit = omit,
        network_policy_id: Optional[str] | Omit = omit,
        secrets: Optional[Dict[str, str]] | Omit = omit,
        services: Optional[Iterable[blueprint_create_params.Service]] | Omit = omit,
        system_setup_commands: Optional[SequenceNotStr[str]] | Omit = omit,
        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
        # The extra values given here take precedence over values defined on the client or passed to this method.
        extra_headers: Headers | None = None,
        extra_query: Query | None = None,
        extra_body: Body | None = None,
        timeout: float | httpx.Timeout | None | NotGiven = not_given,
        idempotency_key: str | None = None,
    ) -> BlueprintView:
        """Starts build of custom defined container Blueprint.

        The Blueprint will begin in
        the 'provisioning' step and transition to the 'building' step once it is
        selected off the build queue., Upon build complete it will transition to
        'building_complete' if the build is successful.

        Args:
          name: Name of the Blueprint.

          base_blueprint_id: (Optional) ID of previously built blueprint to use as a base blueprint for this
              build.

          base_blueprint_name: (Optional) Name of previously built blueprint to use as a base blueprint for
              this build. When set, this will load the latest successfully built Blueprint
              with the given name. Only one of (base_blueprint_id, base_blueprint_name) should
              be specified.

          build_args: (Optional) Arbitrary Docker build args to pass during build.

          build_context: A build context backed by an Object.

          code_mounts: A list of code mounts to be included in the Blueprint.

          dockerfile: Dockerfile contents to be used to build the Blueprint.

          file_mounts: (Optional) Map of paths and file contents to write before setup.

          launch_parameters: LaunchParameters enable you to customize the resources available to your Devbox
              as well as the environment set up that should be completed before the Devbox is
              marked as 'running'.

          metadata: (Optional) User defined metadata for the Blueprint.

          network_policy_id: (Optional) ID of the network policy to apply during blueprint build. This
              restricts network access during the build process. This does not affect devboxes
              created from this blueprint; if you want devboxes created from this blueprint to
              inherit the network policy, set the network_policy_id on the blueprint launch
              parameters.

          secrets: (Optional) Map of mount IDs/environment variable names to secret names. Secrets
              will be available to commands during the build. Secrets are NOT stored in the
              blueprint image. Example: {"DB_PASS": "DATABASE_PASSWORD"} makes the secret
              'DATABASE_PASSWORD' available as environment variable 'DB_PASS'.

          services: (Optional) List of containerized services to include in the Blueprint. These
              services will be pre-pulled during the build phase for optimized startup
              performance.

          system_setup_commands: A list of commands to run to set up your system.

          extra_headers: Send extra headers

          extra_query: Add additional query parameters to the request

          extra_body: Add additional JSON properties to the request

          timeout: Override the client-level default timeout for this request, in seconds

          idempotency_key: Specify a custom idempotency key for this request
        """
        note = _validate_file_mounts(file_mounts)
        if note.has_errors():
            raise ValueError(note.error_message())

        return self._post(
            "/v1/blueprints",
            body=maybe_transform(
                {
                    "name": name,
                    "base_blueprint_id": base_blueprint_id,
                    "base_blueprint_name": base_blueprint_name,
                    "build_args": build_args,
                    "build_context": build_context,
                    "code_mounts": code_mounts,
                    "dockerfile": dockerfile,
                    "file_mounts": file_mounts,
                    "launch_parameters": launch_parameters,
                    "metadata": metadata,
                    "network_policy_id": network_policy_id,
                    "secrets": secrets,
                    "services": services,
                    "system_setup_commands": system_setup_commands,
                },
                blueprint_create_params.BlueprintCreateParams,
            ),
            options=make_request_options(
                extra_headers=extra_headers,
                extra_query=extra_query,
                extra_body=extra_body,
                timeout=timeout,
                idempotency_key=idempotency_key,
            ),
            cast_to=BlueprintView,
        )

    def retrieve(
        self,
        id: str,
        *,
        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
        # The extra values given here take precedence over values defined on the client or passed to this method.
        extra_headers: Headers | None = None,
        extra_query: Query | None = None,
        extra_body: Body | None = None,
        timeout: float | httpx.Timeout | None | NotGiven = not_given,
    ) -> BlueprintView:
        """
        Get the details of a previously created Blueprint including the build status.

        Args:
          extra_headers: Send extra headers

          extra_query: Add additional query parameters to the request

          extra_body: Add additional JSON properties to the request

          timeout: Override the client-level default timeout for this request, in seconds
        """
        if not id:
            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
        return self._get(
            path_template("/v1/blueprints/{id}", id=id),
            options=make_request_options(
                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
            ),
            cast_to=BlueprintView,
        )

    def await_build_complete(
        self,
        id: str,
        *,
        polling_config: PollingConfig | None = None,
        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
        # The extra values given here take precedence over values defined on the client or passed to this method.
        extra_headers: Headers | None = None,
        extra_query: Query | None = None,
        extra_body: Body | None = None,
        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
    ) -> BlueprintView:
        """Wait for a blueprint to finish building.

        Args:
            id: The ID of the blueprint to wait for
            polling_config: Optional polling configuration
            extra_headers: Send extra headers
            extra_query: Add additional query parameters to the request
            extra_body: Add additional JSON properties to the request
            timeout: Override the client-level default timeout for this request, in seconds

        Returns:
            The blueprint in built state

        Raises:
            PollingTimeout: If polling times out before blueprint is built
            RunloopError: If blueprint enters a non-built terminal state
        """

        def retrieve_blueprint() -> BlueprintView:
            return self.retrieve(
                id, extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
            )

        def is_done_building(blueprint: BlueprintView) -> bool:
            return blueprint.status not in ["queued", "building", "provisioning"]

        blueprint = poll_until(retrieve_blueprint, is_done_building, polling_config)

        if blueprint.status != "build_complete":
            raise RunloopError(f"Blueprint entered non-built terminal state: {blueprint.status}")

        return blueprint

    def create_and_await_build_complete(
        self,
        *,
        name: str,
        base_blueprint_id: Optional[str] | Omit = omit,
        base_blueprint_name: Optional[str] | Omit = omit,
        build_args: Optional[Dict[str, str]] | Omit = omit,
        build_context: Optional[blueprint_create_params.BuildContext] | Omit = omit,
        code_mounts: Optional[Iterable[CodeMountParameters]] | Omit = omit,
        dockerfile: Optional[str] | Omit = omit,
        file_mounts: Optional[Dict[str, str]] | Omit = omit,
        launch_parameters: Optional[LaunchParameters] | Omit = omit,
        metadata: Optional[Dict[str, str]] | Omit = omit,
        network_policy_id: Optional[str] | Omit = omit,
        secrets: Optional[Dict[str, str]] | Omit = omit,
        services: Optional[Iterable[blueprint_create_params.Service]] | Omit = omit,
        system_setup_commands: Optional[SequenceNotStr[str]] | Omit = omit,
        polling_config: PollingConfig | None = None,
        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
        # The extra values given here take precedence over values defined on the client or passed to this method.
        extra_headers: Headers | None = None,
        extra_query: Query | None = None,
        extra_body: Body | None = None,
        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
        idempotency_key: str | None = None,
    ) -> BlueprintView:
        """Create a new Blueprint and wait for it to finish building.

        This is a wrapper around the `create` method that waits for the blueprint to finish building.

        Args:
            See the `create` method for detailed documentation.
            polling_config: Optional polling configuration

        Returns:
            The built blueprint

        Raises:
            PollingTimeout: If polling times out before blueprint is built
            RunloopError: If blueprint enters a non-built terminal state
        """
        # Pass all create_args to the underlying create method
        blueprint = self.create(
            name=name,
            base_blueprint_id=base_blueprint_id,
            base_blueprint_name=base_blueprint_name,
            build_args=build_args,
            build_context=build_context,
            code_mounts=code_mounts,
            dockerfile=dockerfile,
            file_mounts=file_mounts,
            launch_parameters=launch_parameters,
            metadata=metadata,
            network_policy_id=network_policy_id,
            secrets=secrets,
            services=services,
            system_setup_commands=system_setup_commands,
            extra_headers=extra_headers,
            extra_query=extra_query,
            extra_body=extra_body,
            timeout=timeout,
            idempotency_key=idempotency_key,
        )

        return self.await_build_complete(
            blueprint.id,
            polling_config=polling_config,
            extra_headers=extra_headers,
            extra_query=extra_query,
            extra_body=extra_body,
            timeout=timeout,
        )

    def list(
        self,
        *,
        include_total_count: bool | Omit = omit,
        limit: int | Omit = omit,
        name: str | Omit = omit,
        starting_after: str | Omit = omit,
        status: str | Omit = omit,
        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
        # The extra values given here take precedence over values defined on the client or passed to this method.
        extra_headers: Headers | None = None,
        extra_query: Query | None = None,
        extra_body: Body | None = None,
        timeout: float | httpx.Timeout | None | NotGiven = not_given,
    ) -> SyncBlueprintsCursorIDPage[BlueprintView]:
        """
        List all Blueprints or filter by name.

        Args:
          include_total_count: If true (default), includes total_count in the response. Set to false to skip
              the count query for better performance on large datasets.

          limit: The limit of items to return. Default is 20. Max is 5000.

          name: Filter by name

          starting_after: Load the next page of data starting after the item with the given ID.

          status: Filter by build status (queued, provisioning, building, failed, build_complete)

          extra_headers: Send extra headers

          extra_query: Add additional query parameters to the request

          extra_body: Add additional JSON properties to the request

          timeout: Override the client-level default timeout for this request, in seconds
        """
        return self._get_api_list(
            "/v1/blueprints",
            page=SyncBlueprintsCursorIDPage[BlueprintView],
            options=make_request_options(
                extra_headers=extra_headers,
                extra_query=extra_query,
                extra_body=extra_body,
                timeout=timeout,
                query=maybe_transform(
                    {
                        "include_total_count": include_total_count,
                        "limit": limit,
                        "name": name,
                        "starting_after": starting_after,
                        "status": status,
                    },
                    blueprint_list_params.BlueprintListParams,
                ),
            ),
            model=BlueprintView,
        )

    def delete(
        self,
        id: str,
        *,
        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
        # The extra values given here take precedence over values defined on the client or passed to this method.
        extra_headers: Headers | None = None,
        extra_query: Query | None = None,
        extra_body: Body | None = None,
        timeout: float | httpx.Timeout | None | NotGiven = not_given,
        idempotency_key: str | None = None,
    ) -> object:
        """Delete a previously created Blueprint.

        If a blueprint has dependent snapshots,
        it cannot be deleted. You can find them by querying: GET
        /v1/devboxes/disk_snapshots?source_blueprint_id={blueprint_id}.

        Args:
          extra_headers: Send extra headers

          extra_query: Add additional query parameters to the request

          extra_body: Add additional JSON properties to the request

          timeout: Override the client-level default timeout for this request, in seconds

          idempotency_key: Specify a custom idempotency key for this request
        """
        if not id:
            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
        return self._post(
            path_template("/v1/blueprints/{id}/delete", id=id),
            options=make_request_options(
                extra_headers=extra_headers,
                extra_query=extra_query,
                extra_body=extra_body,
                timeout=timeout,
                idempotency_key=idempotency_key,
            ),
            cast_to=object,
        )

    def create_from_inspection(
        self,
        *,
        inspection_source: InspectionSourceParam,
        name: str,
        file_mounts: Optional[Dict[str, str]] | Omit = omit,
        launch_parameters: Optional[LaunchParameters] | Omit = omit,
        metadata: Optional[Dict[str, str]] | Omit = omit,
        network_policy_id: Optional[str] | Omit = omit,
        secrets: Optional[Dict[str, str]] | Omit = omit,
        system_setup_commands: Optional[SequenceNotStr[str]] | Omit = omit,
        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
        # The extra values given here take precedence over values defined on the client or passed to this method.
        extra_headers: Headers | None = None,
        extra_query: Query | None = None,
        extra_body: Body | None = None,
        timeout: float | httpx.Timeout | None | NotGiven = not_given,
        idempotency_key: str | None = None,
    ) -> BlueprintView:
        """
        Starts build of custom defined container Blueprint using a RepositoryConnection
        Inspection as a source container specification.

        Args:
          inspection_source: (Optional) Use a RepositoryInspection a source of a Blueprint build. The
              Dockerfile will be automatically created based on the RepositoryInspection
              contents.

          name: Name of the Blueprint.

          file_mounts: (Optional) Map of paths and file contents to write before setup.

          launch_parameters: LaunchParameters enable you to customize the resources available to your Devbox
              as well as the environment set up that should be completed before the Devbox is
              marked as 'running'.

          metadata: (Optional) User defined metadata for the Blueprint.

          network_policy_id: (Optional) ID of the network policy to apply during blueprint build. This
              restricts network access during the build process.

          secrets: (Optional) Map of mount IDs/environment variable names to secret names. Secrets
              can be used as environment variables in system_setup_commands. Example:
              {"GITHUB_TOKEN": "gh_secret"} makes 'gh_secret' available as GITHUB_TOKEN.

          system_setup_commands: A list of commands to run to set up your system.

          extra_headers: Send extra headers

          extra_query: Add additional query parameters to the request

          extra_body: Add additional JSON properties to the request

          timeout: Override the client-level default timeout for this request, in seconds

          idempotency_key: Specify a custom idempotency key for this request
        """
        return self._post(
            "/v1/blueprints/create_from_inspection",
            body=maybe_transform(
                {
                    "inspection_source": inspection_source,
                    "name": name,
                    "file_mounts": file_mounts,
                    "launch_parameters": launch_parameters,
                    "metadata": metadata,
                    "network_policy_id": network_policy_id,
                    "secrets": secrets,
                    "system_setup_commands": system_setup_commands,
                },
                blueprint_create_from_inspection_params.BlueprintCreateFromInspectionParams,
            ),
            options=make_request_options(
                extra_headers=extra_headers,
                extra_query=extra_query,
                extra_body=extra_body,
                timeout=timeout,
                idempotency_key=idempotency_key,
            ),
            cast_to=BlueprintView,
        )

    def list_public(
        self,
        *,
        include_total_count: bool | Omit = omit,
        limit: int | Omit = omit,
        name: str | Omit = omit,
        starting_after: str | Omit = omit,
        status: str | Omit = omit,
        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
        # The extra values given here take precedence over values defined on the client or passed to this method.
        extra_headers: Headers | None = None,
        extra_query: Query | None = None,
        extra_body: Body | None = None,
        timeout: float | httpx.Timeout | None | NotGiven = not_given,
    ) -> SyncBlueprintsCursorIDPage[BlueprintView]:
        """
        List all public Blueprints that are available to all users.

        Args:
          include_total_count: If true (default), includes total_count in the response. Set to false to skip
              the count query for better performance on large datasets.

          limit: The limit of items to return. Default is 20. Max is 5000.

          name: Filter by name

          starting_after: Load the next page of data starting after the item with the given ID.

          status: Filter by build status (queued, provisioning, building, failed, build_complete)

          extra_headers: Send extra headers

          extra_query: Add additional query parameters to the request

          extra_body: Add additional JSON properties to the request

          timeout: Override the client-level default timeout for this request, in seconds
        """
        return self._get_api_list(
            "/v1/blueprints/list_public",
            page=SyncBlueprintsCursorIDPage[BlueprintView],
            options=make_request_options(
                extra_headers=extra_headers,
                extra_query=extra_query,
                extra_body=extra_body,
                timeout=timeout,
                query=maybe_transform(
                    {
                        "include_total_count": include_total_count,
                        "limit": limit,
                        "name": name,
                        "starting_after": starting_after,
                        "status": status,
                    },
                    blueprint_list_public_params.BlueprintListPublicParams,
                ),
            ),
            model=BlueprintView,
        )

    def logs(
        self,
        id: str,
        *,
        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
        # The extra values given here take precedence over values defined on the client or passed to this method.
        extra_headers: Headers | None = None,
        extra_query: Query | None = None,
        extra_body: Body | None = None,
        timeout: float | httpx.Timeout | None | NotGiven = not_given,
    ) -> BlueprintBuildLogsListView:
        """
        Get all logs from the building of a Blueprint.

        Args:
          extra_headers: Send extra headers

          extra_query: Add additional query parameters to the request

          extra_body: Add additional JSON properties to the request

          timeout: Override the client-level default timeout for this request, in seconds
        """
        if not id:
            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
        return self._get(
            path_template("/v1/blueprints/{id}/logs", id=id),
            options=make_request_options(
                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
            ),
            cast_to=BlueprintBuildLogsListView,
        )

    @typing_extensions.deprecated("deprecated")
    def preview(
        self,
        *,
        name: str,
        base_blueprint_id: Optional[str] | Omit = omit,
        base_blueprint_name: Optional[str] | Omit = omit,
        build_args: Optional[Dict[str, str]] | Omit = omit,
        build_context: Optional[blueprint_preview_params.BuildContext] | Omit = omit,
        code_mounts: Optional[Iterable[CodeMountParameters]] | Omit = omit,
        dockerfile: Optional[str] | Omit = omit,
        file_mounts: Optional[Dict[str, str]] | Omit = omit,
        launch_parameters: Optional[LaunchParameters] | Omit = omit,
        metadata: Optional[Dict[str, str]] | Omit = omit,
        network_policy_id: Optional[str] | Omit = omit,
        secrets: Optional[Dict[str, str]] | Omit = omit,
        services: Optional[Iterable[blueprint_preview_params.Service]] | Omit = omit,
        system_setup_commands: Optional[SequenceNotStr[str]] | Omit = omit,
        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
        # The extra values given here take precedence over values defined on the client or passed to this method.
        extra_headers: Headers | None = None,
        extra_query: Query | None = None,
        extra_body: Body | None = None,
        timeout: float | httpx.Timeout | None | NotGiven = not_given,
        idempotency_key: str | None = None,
    ) -> BlueprintPreviewView:
        """Preview building a Blueprint with the specified configuration.

        You can take the
        resulting Dockerfile and test out your build using any local docker tooling.

        Args:
          name: Name of the Blueprint.

          base_blueprint_id: (Optional) ID of previously built blueprint to use as a base blueprint for this
              build.

          base_blueprint_name: (Optional) Name of previously built blueprint to use as a base blueprint for
              this build. When set, this will load the latest successfully built Blueprint
              with the given name. Only one of (base_blueprint_id, base_blueprint_name) should
              be specified.

          build_args: (Optional) Arbitrary Docker build args to pass during build.

          build_context: A build context backed by an Object.

          code_mounts: A list of code mounts to be included in the Blueprint.

          dockerfile: Dockerfile contents to be used to build the Blueprint.

          file_mounts: (Optional) Map of paths and file contents to write before setup.

          launch_parameters: LaunchParameters enable you to customize the resources available to your Devbox
              as well as the environment set up that should be completed before the Devbox is
              marked as 'running'.

          metadata: (Optional) User defined metadata for the Blueprint.

          network_policy_id: (Optional) ID of the network policy to apply during blueprint build. This
              restricts network access during the build process. This does not affect devboxes
              created from this blueprint; if you want devboxes created from this blueprint to
              inherit the network policy, set the network_policy_id on the blueprint launch
              parameters.

          secrets: (Optional) Map of mount IDs/environment variable names to secret names. Secrets
              will be available to commands during the build. Secrets are NOT stored in the
              blueprint image. Example: {"DB_PASS": "DATABASE_PASSWORD"} makes the secret
              'DATABASE_PASSWORD' available as environment variable 'DB_PASS'.

          services: (Optional) List of containerized services to include in the Blueprint. These
              services will be pre-pulled during the build phase for optimized startup
              performance.

          system_setup_commands: A list of commands to run to set up your system.

          extra_headers: Send extra headers

          extra_query: Add additional query parameters to the request

          extra_body: Add additional JSON properties to the request

          timeout: Override the client-level default timeout for this request, in seconds

          idempotency_key: Specify a custom idempotency key for this request
        """
        return self._post(
            "/v1/blueprints/preview",
            body=maybe_transform(
                {
                    "name": name,
                    "base_blueprint_id": base_blueprint_id,
                    "base_blueprint_name": base_blueprint_name,
                    "build_args": build_args,
                    "build_context": build_context,
                    "code_mounts": code_mounts,
                    "dockerfile": dockerfile,
                    "file_mounts": file_mounts,
                    "launch_parameters": launch_parameters,
                    "metadata": metadata,
                    "network_policy_id": network_policy_id,
                    "secrets": secrets,
                    "services": services,
                    "system_setup_commands": system_setup_commands,
                },
                blueprint_preview_params.BlueprintPreviewParams,
            ),
            options=make_request_options(
                extra_headers=extra_headers,
                extra_query=extra_query,
                extra_body=extra_body,
                timeout=timeout,
                idempotency_key=idempotency_key,
            ),
            cast_to=BlueprintPreviewView,
        )


class AsyncBlueprintsResource(AsyncAPIResource):
    @cached_property
    def with_raw_response(self) -> AsyncBlueprintsResourceWithRawResponse:
        """
        This property can be used as a prefix for any HTTP method call to return
        the raw response object instead of the parsed content.

        For more information, see https://www.github.com/runloopai/api-client-python#accessing-raw-response-data-eg-headers
        """
        return AsyncBlueprintsResourceWithRawResponse(self)

    @cached_property
    def with_streaming_response(self) -> AsyncBlueprintsResourceWithStreamingResponse:
        """
        An alternative to `.with_raw_response` that doesn't eagerly read the response body.

        For more information, see https://www.github.com/runloopai/api-client-python#with_streaming_response
        """
        return AsyncBlueprintsResourceWithStreamingResponse(self)

    async def create(
        self,
        *,
        name: str,
        base_blueprint_id: Optional[str] | Omit = omit,
        base_blueprint_name: Optional[str] | Omit = omit,
        build_args: Optional[Dict[str, str]] | Omit = omit,
        build_context: Optional[blueprint_create_params.BuildContext] | Omit = omit,
        code_mounts: Optional[Iterable[CodeMountParameters]] | Omit = omit,
        dockerfile: Optional[str] | Omit = omit,
        file_mounts: Optional[Dict[str, str]] | Omit = omit,
        launch_parameters: Optional[LaunchParameters] | Omit = omit,
        metadata: Optional[Dict[str, str]] | Omit = omit,
        network_policy_id: Optional[str] | Omit = omit,
        secrets: Optional[Dict[str, str]] | Omit = omit,
        services: Optional[Iterable[blueprint_create_params.Service]] | Omit = omit,
        system_setup_commands: Optional[SequenceNotStr[str]] | Omit = omit,
        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
        # The extra values given here take precedence over values defined on the client or passed to this method.
        extra_headers: Headers | None = None,
        extra_query: Query | None = None,
        extra_body: Body | None = None,
        timeout: float | httpx.Timeout | None | NotGiven = not_given,
        idempotency_key: str | None = None,
    ) -> BlueprintView:
        """Starts build of custom defined container Blueprint.

        The Blueprint will begin in
        the 'provisioning' step and transition to the 'building' step once it is
        selected off the build queue., Upon build complete it will transition to
        'building_complete' if the build is successful.

        Args:
          name: Name of the Blueprint.

          base_blueprint_id: (Optional) ID of previously built blueprint to use as a base blueprint for this
              build.

          base_blueprint_name: (Optional) Name of previously built blueprint to use as a base blueprint for
              this build. When set, this will load the latest successfully built Blueprint
              with the given name. Only one of (base_blueprint_id, base_blueprint_name) should
              be specified.

          build_args: (Optional) Arbitrary Docker build args to pass during build.

          build_context: A build context backed by an Object.

          code_mounts: A list of code mounts to be included in the Blueprint.

          dockerfile: Dockerfile contents to be used to build the Blueprint.

          file_mounts: (Optional) Map of paths and file contents to write before setup.

          launch_parameters: LaunchParameters enable you to customize the resources available to your Devbox
              as well as the environment set up that should be completed before the Devbox is
              marked as 'running'.

          metadata: (Optional) User defined metadata for the Blueprint.

          network_policy_id: (Optional) ID of the network policy to apply during blueprint build. This
              restricts network access during the build process. This does not affect devboxes
              created from this blueprint; if you want devboxes created from this blueprint to
              inherit the network policy, set the network_policy_id on the blueprint launch
              parameters.

          secrets: (Optional) Map of mount IDs/environment variable names to secret names. Secrets
              will be available to commands during the build. Secrets are NOT stored in the
              blueprint image. Example: {"DB_PASS": "DATABASE_PASSWORD"} makes the secret
              'DATABASE_PASSWORD' available as environment variable 'DB_PASS'.

          services: (Optional) List of containerized services to include in the Blueprint. These
              services will be pre-pulled during the build phase for optimized startup
              performance.

          system_setup_commands: A list of commands to run to set up your system.

          extra_headers: Send extra headers

          extra_query: Add additional query parameters to the request

          extra_body: Add additional JSON properties to the request

          timeout: Override the client-level default timeout for this request, in seconds

          idempotency_key: Specify a custom idempotency key for this request
        """
        note = _validate_file_mounts(file_mounts)
        if note.has_errors():
            raise ValueError(note.error_message())

        return await self._post(
            "/v1/blueprints",
            body=await async_maybe_transform(
                {
                    "name": name,
                    "base_blueprint_id": base_blueprint_id,
                    "base_blueprint_name": base_blueprint_name,
                    "build_args": build_args,
                    "build_context": build_context,
                    "code_mounts": code_mounts,
                    "dockerfile": dockerfile,
                    "file_mounts": file_mounts,
                    "launch_parameters": launch_parameters,
                    "metadata": metadata,
                    "network_policy_id": network_policy_id,
                    "secrets": secrets,
                    "services": services,
                    "system_setup_commands": system_setup_commands,
                },
                blueprint_create_params.BlueprintCreateParams,
            ),
            options=make_request_options(
                extra_headers=extra_headers,
                extra_query=extra_query,
                extra_body=extra_body,
                timeout=timeout,
                idempotency_key=idempotency_key,
            ),
            cast_to=BlueprintView,
        )

    async def retrieve(
        self,
        id: str,
        *,
        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
        # The extra values given here take precedence over values defined on the client or passed to this method.
        extra_headers: Headers | None = None,
        extra_query: Query | None = None,
        extra_body: Body | None = None,
        timeout: float | httpx.Timeout | None | NotGiven = not_given,
    ) -> BlueprintView:
        """
        Get the details of a previously created Blueprint including the build status.

        Args:
          extra_headers: Send extra headers

          extra_query: Add additional query parameters to the request

          extra_body: Add additional JSON properties to the request

          timeout: Override the client-level default timeout for this request, in seconds
        """
        if not id:
            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
        return await self._get(
            path_template("/v1/blueprints/{id}", id=id),
            options=make_request_options(
                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
            ),
            cast_to=BlueprintView,
        )

    async def await_build_complete(
        self,
        id: str,
        *,
        polling_config: PollingConfig | None = None,
        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
        # The extra values given here take precedence over values defined on the client or passed to this method.
        extra_headers: Headers | None = None,
        extra_query: Query | None = None,
        extra_body: Body | None = None,
        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
    ) -> BlueprintView:
        """Wait for a blueprint to finish building.

        Args:
            id: The ID of the blueprint to wait for
            polling_config: Optional polling configuration
            extra_headers: Send extra headers
            extra_query: Add additional query parameters to the request
            extra_body: Add additional JSON properties to the request
            timeout: Override the client-level default timeout for this request, in seconds

        Returns:
            The blueprint in built state

        Raises:
            PollingTimeout: If polling times out before blueprint is built
            RunloopError: If blueprint enters a non-built terminal state
        """

        async def retrieve_blueprint() -> BlueprintView:
            return await self.retrieve(
                id, extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
            )

        def is_done_building(blueprint: BlueprintView) -> bool:
            return blueprint.status not in ["queued", "building", "provisioning"]

        blueprint = await async_poll_until(retrieve_blueprint, is_done_building, polling_config)

        if blueprint.status != "build_complete":
            raise RunloopError(f"Blueprint entered non-built terminal state: {blueprint.status}")

        return blueprint

    async def create_and_await_build_complete(
        self,
        *,
        name: str,
        base_blueprint_id: Optional[str] | Omit = omit,
        base_blueprint_name: Optional[str] | Omit = omit,
        build_args: Optional[Dict[str, str]] | Omit = omit,
        build_context: Optional[blueprint_create_params.BuildContext] | Omit = omit,
        code_mounts: Optional[Iterable[CodeMountParameters]] | Omit = omit,
        dockerfile: Optional[str] | Omit = omit,
        file_mounts: Optional[Dict[str, str]] | Omit = omit,
        launch_parameters: Optional[LaunchParameters] | Omit = omit,
        metadata: Optional[Dict[str, str]] | Omit = omit,
        network_policy_id: Optional[str] | Omit = omit,
        secrets: Optional[Dict[str, str]] | Omit = omit,
        services: Optional[Iterable[blueprint_create_params.Service]] | Omit = omit,
        system_setup_commands: Optional[SequenceNotStr[str]] | Omit = omit,
        polling_config: PollingConfig | None = None,
        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
        # The extra values given here take precedence over values defined on the client or passed to this method.
        extra_headers: Headers | None = None,
        extra_query: Query | None = None,
        extra_body: Body | None = None,
        timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
        idempotency_key: str | None = None,
    ) -> BlueprintView:
        """Create a new Blueprint and wait for it to finish building.

        This is a wrapper around the `create` method that waits for the blueprint to finish building.

        Args:
            See the `create` method for detailed documentation.
            polling_config: Optional polling configuration

        Returns:
            The built blueprint

        Raises:
            PollingTimeout: If polling times out before blueprint is built
            RunloopError: If blueprint enters a non-built terminal state
        """
        # Pass all create_args to the underlying create method
        blueprint = await self.create(
            name=name,
            base_blueprint_id=base_blueprint_id,
            base_blueprint_name=base_blueprint_name,
            build_args=build_args,
            build_context=build_context,
            code_mounts=code_mounts,
            dockerfile=dockerfile,
            file_mounts=file_mounts,
            launch_parameters=launch_parameters,
            metadata=metadata,
            network_policy_id=network_policy_id,
            secrets=secrets,
            services=services,
            system_setup_commands=system_setup_commands,
            extra_headers=extra_headers,
            extra_query=extra_query,
            extra_body=extra_body,
            timeout=timeout,
            idempotency_key=idempotency_key,
        )

        return await self.await_build_complete(
            blueprint.id,
            polling_config=polling_config,
            extra_headers=extra_headers,
            extra_query=extra_query,
            extra_body=extra_body,
            timeout=timeout,
        )

    def list(
        self,
        *,
        include_total_count: bool | Omit = omit,
        limit: int | Omit = omit,
        name: str | Omit = omit,
        starting_after: str | Omit = omit,
        status: str | Omit = omit,
        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
        # The extra values given here take precedence over values defined on the client or passed to this method.
        extra_headers: Headers | None = None,
        extra_query: Query | None = None,
        extra_body: Body | None = None,
        timeout: float | httpx.Timeout | None | NotGiven = not_given,
    ) -> AsyncPaginator[BlueprintView, AsyncBlueprintsCursorIDPage[BlueprintView]]:
        """
        List all Blueprints or filter by name.

        Args:
          include_total_count: If true (default), includes total_count in the response. Set to false to skip
              the count query for better performance on large datasets.

          limit: The limit of items to return. Default is 20. Max is 5000.

          name: Filter by name

          starting_after: Load the next page of data starting after the item with the given ID.

          status: Filter by build status (queued, provisioning, building, failed, build_complete)

          extra_headers: Send extra headers

          extra_query: Add additional query parameters to the request

          extra_body: Add additional JSON properties to the request

          timeout: Override the client-level default timeout for this request, in seconds
        """
        return self._get_api_list(
            "/v1/blueprints",
            page=AsyncBlueprintsCursorIDPage[BlueprintView],
            options=make_request_options(
                extra_headers=extra_headers,
                extra_query=extra_query,
                extra_body=extra_body,
                timeout=timeout,
                query=maybe_transform(
                    {
                        "include_total_count": include_total_count,
                        "limit": limit,
                        "name": name,
                        "starting_after": starting_after,
                        "status": status,
                    },
                    blueprint_list_params.BlueprintListParams,
                ),
            ),
            model=BlueprintView,
        )

    async def delete(
        self,
        id: str,
        *,
        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
        # The extra values given here take precedence over values defined on the client or passed to this method.
        extra_headers: Headers | None = None,
        extra_query: Query | None = None,
        extra_body: Body | None = None,
        timeout: float | httpx.Timeout | None | NotGiven = not_given,
        idempotency_key: str | None = None,
    ) -> object:
        """Delete a previously created Blueprint.

        If a blueprint has dependent snapshots,
        it cannot be deleted. You can find them by querying: GET
        /v1/devboxes/disk_snapshots?source_blueprint_id={blueprint_id}.

        Args:
          extra_headers: Send extra headers

          extra_query: Add additional query parameters to the request

          extra_body: Add additional JSON properties to the request

          timeout: Override the client-level default timeout for this request, in seconds

          idempotency_key: Specify a custom idempotency key for this request
        """
        if not id:
            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
        return await self._post(
            path_template("/v1/blueprints/{id}/delete", id=id),
            options=make_request_options(
                extra_headers=extra_headers,
                extra_query=extra_query,
                extra_body=extra_body,
                timeout=timeout,
                idempotency_key=idempotency_key,
            ),
            cast_to=object,
        )

    async def create_from_inspection(
        self,
        *,
        inspection_source: InspectionSourceParam,
        name: str,
        file_mounts: Optional[Dict[str, str]] | Omit = omit,
        launch_parameters: Optional[LaunchParameters] | Omit = omit,
        metadata: Optional[Dict[str, str]] | Omit = omit,
        network_policy_id: Optional[str] | Omit = omit,
        secrets: Optional[Dict[str, str]] | Omit = omit,
        system_setup_commands: Optional[SequenceNotStr[str]] | Omit = omit,
        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
        # The extra values given here take precedence over values defined on the client or passed to this method.
        extra_headers: Headers | None = None,
        extra_query: Query | None = None,
        extra_body: Body | None = None,
        timeout: float | httpx.Timeout | None | NotGiven = not_given,
        idempotency_key: str | None = None,
    ) -> BlueprintView:
        """
        Starts build of custom defined container Blueprint using a RepositoryConnection
        Inspection as a source container specification.

        Args:
          inspection_source: (Optional) Use a RepositoryInspection a source of a Blueprint build. The
              Dockerfile will be automatically created based on the RepositoryInspection
              contents.

          name: Name of the Blueprint.

          file_mounts: (Optional) Map of paths and file contents to write before setup.

          launch_parameters: LaunchParameters enable you to customize the resources available to your Devbox
              as well as the environment set up that should be completed before the Devbox is
              marked as 'running'.

          metadata: (Optional) User defined metadata for the Blueprint.

          network_policy_id: (Optional) ID of the network policy to apply during blueprint build. This
              restricts network access during the build process.

          secrets: (Optional) Map of mount IDs/environment variable names to secret names. Secrets
              can be used as environment variables in system_setup_commands. Example:
              {"GITHUB_TOKEN": "gh_secret"} makes 'gh_secret' available as GITHUB_TOKEN.

          system_setup_commands: A list of commands to run to set up your system.

          extra_headers: Send extra headers

          extra_query: Add additional query parameters to the request

          extra_body: Add additional JSON properties to the request

          timeout: Override the client-level default timeout for this request, in seconds

          idempotency_key: Specify a custom idempotency key for this request
        """
        return await self._post(
            "/v1/blueprints/create_from_inspection",
            body=await async_maybe_transform(
                {
                    "inspection_source": inspection_source,
                    "name": name,
                    "file_mounts": file_mounts,
                    "launch_parameters": launch_parameters,
                    "metadata": metadata,
                    "network_policy_id": network_policy_id,
                    "secrets": secrets,
                    "system_setup_commands": system_setup_commands,
                },
                blueprint_create_from_inspection_params.BlueprintCreateFromInspectionParams,
            ),
            options=make_request_options(
                extra_headers=extra_headers,
                extra_query=extra_query,
                extra_body=extra_body,
                timeout=timeout,
                idempotency_key=idempotency_key,
            ),
            cast_to=BlueprintView,
        )

    def list_public(
        self,
        *,
        include_total_count: bool | Omit = omit,
        limit: int | Omit = omit,
        name: str | Omit = omit,
        starting_after: str | Omit = omit,
        status: str | Omit = omit,
        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
        # The extra values given here take precedence over values defined on the client or passed to this method.
        extra_headers: Headers | None = None,
        extra_query: Query | None = None,
        extra_body: Body | None = None,
        timeout: float | httpx.Timeout | None | NotGiven = not_given,
    ) -> AsyncPaginator[BlueprintView, AsyncBlueprintsCursorIDPage[BlueprintView]]:
        """
        List all public Blueprints that are available to all users.

        Args:
          include_total_count: If true (default), includes total_count in the response. Set to false to skip
              the count query for better performance on large datasets.

          limit: The limit of items to return. Default is 20. Max is 5000.

          name: Filter by name

          starting_after: Load the next page of data starting after the item with the given ID.

          status: Filter by build status (queued, provisioning, building, failed, build_complete)

          extra_headers: Send extra headers

          extra_query: Add additional query parameters to the request

          extra_body: Add additional JSON properties to the request

          timeout: Override the client-level default timeout for this request, in seconds
        """
        return self._get_api_list(
            "/v1/blueprints/list_public",
            page=AsyncBlueprintsCursorIDPage[BlueprintView],
            options=make_request_options(
                extra_headers=extra_headers,
                extra_query=extra_query,
                extra_body=extra_body,
                timeout=timeout,
                query=maybe_transform(
                    {
                        "include_total_count": include_total_count,
                        "limit": limit,
                        "name": name,
                        "starting_after": starting_after,
                        "status": status,
                    },
                    blueprint_list_public_params.BlueprintListPublicParams,
                ),
            ),
            model=BlueprintView,
        )

    async def logs(
        self,
        id: str,
        *,
        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
        # The extra values given here take precedence over values defined on the client or passed to this method.
        extra_headers: Headers | None = None,
        extra_query: Query | None = None,
        extra_body: Body | None = None,
        timeout: float | httpx.Timeout | None | NotGiven = not_given,
    ) -> BlueprintBuildLogsListView:
        """
        Get all logs from the building of a Blueprint.

        Args:
          extra_headers: Send extra headers

          extra_query: Add additional query parameters to the request

          extra_body: Add additional JSON properties to the request

          timeout: Override the client-level default timeout for this request, in seconds
        """
        if not id:
            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
        return await self._get(
            path_template("/v1/blueprints/{id}/logs", id=id),
            options=make_request_options(
                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
            ),
            cast_to=BlueprintBuildLogsListView,
        )

    @typing_extensions.deprecated("deprecated")
    async def preview(
        self,
        *,
        name: str,
        base_blueprint_id: Optional[str] | Omit = omit,
        base_blueprint_name: Optional[str] | Omit = omit,
        build_args: Optional[Dict[str, str]] | Omit = omit,
        build_context: Optional[blueprint_preview_params.BuildContext] | Omit = omit,
        code_mounts: Optional[Iterable[CodeMountParameters]] | Omit = omit,
        dockerfile: Optional[str] | Omit = omit,
        file_mounts: Optional[Dict[str, str]] | Omit = omit,
        launch_parameters: Optional[LaunchParameters] | Omit = omit,
        metadata: Optional[Dict[str, str]] | Omit = omit,
        network_policy_id: Optional[str] | Omit = omit,
        secrets: Optional[Dict[str, str]] | Omit = omit,
        services: Optional[Iterable[blueprint_preview_params.Service]] | Omit = omit,
        system_setup_commands: Optional[SequenceNotStr[str]] | Omit = omit,
        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
        # The extra values given here take precedence over values defined on the client or passed to this method.
        extra_headers: Headers | None = None,
        extra_query: Query | None = None,
        extra_body: Body | None = None,
        timeout: float | httpx.Timeout | None | NotGiven = not_given,
        idempotency_key: str | None = None,
    ) -> BlueprintPreviewView:
        """Preview building a Blueprint with the specified configuration.

        You can take the
        resulting Dockerfile and test out your build using any local docker tooling.

        Args:
          name: Name of the Blueprint.

          base_blueprint_id: (Optional) ID of previously built blueprint to use as a base blueprint for this
              build.

          base_blueprint_name: (Optional) Name of previously built blueprint to use as a base blueprint for
              this build. When set, this will load the latest successfully built Blueprint
              with the given name. Only one of (base_blueprint_id, base_blueprint_name) should
              be specified.

          build_args: (Optional) Arbitrary Docker build args to pass during build.

          build_context: A build context backed by an Object.

          code_mounts: A list of code mounts to be included in the Blueprint.

          dockerfile: Dockerfile contents to be used to build the Blueprint.

          file_mounts: (Optional) Map of paths and file contents to write before setup.

          launch_parameters: LaunchParameters enable you to customize the resources available to your Devbox
              as well as the environment set up that should be completed before the Devbox is
              marked as 'running'.

          metadata: (Optional) User defined metadata for the Blueprint.

          network_policy_id: (Optional) ID of the network policy to apply during blueprint build. This
              restricts network access during the build process. This does not affect devboxes
              created from this blueprint; if you want devboxes created from this blueprint to
              inherit the network policy, set the network_policy_id on the blueprint launch
              parameters.

          secrets: (Optional) Map of mount IDs/environment variable names to secret names. Secrets
              will be available to commands during the build. Secrets are NOT stored in the
              blueprint image. Example: {"DB_PASS": "DATABASE_PASSWORD"} makes the secret
              'DATABASE_PASSWORD' available as environment variable 'DB_PASS'.

          services: (Optional) List of containerized services to include in the Blueprint. These
              services will be pre-pulled during the build phase for optimized startup
              performance.

          system_setup_commands: A list of commands to run to set up your system.

          extra_headers: Send extra headers

          extra_query: Add additional query parameters to the request

          extra_body: Add additional JSON properties to the request

          timeout: Override the client-level default timeout for this request, in seconds

          idempotency_key: Specify a custom idempotency key for this request
        """
        return await self._post(
            "/v1/blueprints/preview",
            body=await async_maybe_transform(
                {
                    "name": name,
                    "base_blueprint_id": base_blueprint_id,
                    "base_blueprint_name": base_blueprint_name,
                    "build_args": build_args,
                    "build_context": build_context,
                    "code_mounts": code_mounts,
                    "dockerfile": dockerfile,
                    "file_mounts": file_mounts,
                    "launch_parameters": launch_parameters,
                    "metadata": metadata,
                    "network_policy_id": network_policy_id,
                    "secrets": secrets,
                    "services": services,
                    "system_setup_commands": system_setup_commands,
                },
                blueprint_preview_params.BlueprintPreviewParams,
            ),
            options=make_request_options(
                extra_headers=extra_headers,
                extra_query=extra_query,
                extra_body=extra_body,
                timeout=timeout,
                idempotency_key=idempotency_key,
            ),
            cast_to=BlueprintPreviewView,
        )


class BlueprintsResourceWithRawResponse:
    def __init__(self, blueprints: BlueprintsResource) -> None:
        self._blueprints = blueprints

        self.create = to_raw_response_wrapper(
            blueprints.create,
        )
        self.retrieve = to_raw_response_wrapper(
            blueprints.retrieve,
        )
        self.list = to_raw_response_wrapper(
            blueprints.list,
        )
        self.delete = to_raw_response_wrapper(
            blueprints.delete,
        )
        self.create_from_inspection = to_raw_response_wrapper(
            blueprints.create_from_inspection,
        )
        self.list_public = to_raw_response_wrapper(
            blueprints.list_public,
        )
        self.logs = to_raw_response_wrapper(
            blueprints.logs,
        )
        self.preview = (  # pyright: ignore[reportDeprecated]
            to_raw_response_wrapper(
                blueprints.preview,  # pyright: ignore[reportDeprecated],
            )
        )


class AsyncBlueprintsResourceWithRawResponse:
    def __init__(self, blueprints: AsyncBlueprintsResource) -> None:
        self._blueprints = blueprints

        self.create = async_to_raw_response_wrapper(
            blueprints.create,
        )
        self.retrieve = async_to_raw_response_wrapper(
            blueprints.retrieve,
        )
        self.list = async_to_raw_response_wrapper(
            blueprints.list,
        )
        self.delete = async_to_raw_response_wrapper(
            blueprints.delete,
        )
        self.create_from_inspection = async_to_raw_response_wrapper(
            blueprints.create_from_inspection,
        )
        self.list_public = async_to_raw_response_wrapper(
            blueprints.list_public,
        )
        self.logs = async_to_raw_response_wrapper(
            blueprints.logs,
        )
        self.preview = (  # pyright: ignore[reportDeprecated]
            async_to_raw_response_wrapper(
                blueprints.preview,  # pyright: ignore[reportDeprecated],
            )
        )


class BlueprintsResourceWithStreamingResponse:
    def __init__(self, blueprints: BlueprintsResource) -> None:
        self._blueprints = blueprints

        self.create = to_streamed_response_wrapper(
            blueprints.create,
        )
        self.retrieve = to_streamed_response_wrapper(
            blueprints.retrieve,
        )
        self.list = to_streamed_response_wrapper(
            blueprints.list,
        )
        self.delete = to_streamed_response_wrapper(
            blueprints.delete,
        )
        self.create_from_inspection = to_streamed_response_wrapper(
            blueprints.create_from_inspection,
        )
        self.list_public = to_streamed_response_wrapper(
            blueprints.list_public,
        )
        self.logs = to_streamed_response_wrapper(
            blueprints.logs,
        )
        self.preview = (  # pyright: ignore[reportDeprecated]
            to_streamed_response_wrapper(
                blueprints.preview,  # pyright: ignore[reportDeprecated],
            )
        )


class AsyncBlueprintsResourceWithStreamingResponse:
    def __init__(self, blueprints: AsyncBlueprintsResource) -> None:
        self._blueprints = blueprints

        self.create = async_to_streamed_response_wrapper(
            blueprints.create,
        )
        self.retrieve = async_to_streamed_response_wrapper(
            blueprints.retrieve,
        )
        self.list = async_to_streamed_response_wrapper(
            blueprints.list,
        )
        self.delete = async_to_streamed_response_wrapper(
            blueprints.delete,
        )
        self.create_from_inspection = async_to_streamed_response_wrapper(
            blueprints.create_from_inspection,
        )
        self.list_public = async_to_streamed_response_wrapper(
            blueprints.list_public,
        )
        self.logs = async_to_streamed_response_wrapper(
            blueprints.logs,
        )
        self.preview = (  # pyright: ignore[reportDeprecated]
            async_to_streamed_response_wrapper(
                blueprints.preview,  # pyright: ignore[reportDeprecated],
            )
        )