# Installs

## Domain Types

### Install

- `class Install: …`

  - `id: str`

  - `created_at: datetime`

  - `package_id: str`

  - `package_slug: str`

  - `status: InstallStatus`

    - `"pending"`

    - `"active"`

    - `"deleting"`

    - `"failed"`

    - `"deleted"`

  - `updated_at: datetime`

  - `inputs: Optional[Dict[str, object]]`

    Install-specific input values that supplement the package's inputs.
    Merged with the package's input values to form the complete
    `entities.inputs` for entity binding evaluation.

  - `links: Optional[List[Link]]`

    - `href: str`

      Target reference.

      Fragment URIs (`#name`) reference other entities in the same graph by
      their local name (the key in the entity map). Absolute paths and URLs reference
      external resources outside the graph.

    - `rel: str`

      Link relation type.

    - `properties: Optional[Dict[str, object]]`

      Additional metadata keyed by property name.

    - `titles: Optional[Dict[str, str]]`

      Human-readable titles keyed by BCP 47 language tag.

    - `type: Optional[str]`

      Media type of the target resource (per RFC 7033 section 4.4.4.3).
      Applies to external `href`s; typically omitted for intra-graph references.

  - `org_id: Optional[str]`

  - `outputs: Optional[Dict[str, object]]`

    Resolved output values produced by the provisioner, conforming to the
    package's `Package.outputs.schema`. Flat — the provisioner evaluates
    `Package.outputs.bindings` against the resolved entity graph.

  - `package_version: Optional[int]`

  - `zone_id: Optional[str]`

### Install List

- `class InstallList: …`

  - `items: List[Install]`

    - `id: str`

    - `created_at: datetime`

    - `package_id: str`

    - `package_slug: str`

    - `status: InstallStatus`

      - `"pending"`

      - `"active"`

      - `"deleting"`

      - `"failed"`

      - `"deleted"`

    - `updated_at: datetime`

    - `inputs: Optional[Dict[str, object]]`

      Install-specific input values that supplement the package's inputs.
      Merged with the package's input values to form the complete
      `entities.inputs` for entity binding evaluation.

    - `links: Optional[List[Link]]`

      - `href: str`

        Target reference.

        Fragment URIs (`#name`) reference other entities in the same graph by
        their local name (the key in the entity map). Absolute paths and URLs reference
        external resources outside the graph.

      - `rel: str`

        Link relation type.

      - `properties: Optional[Dict[str, object]]`

        Additional metadata keyed by property name.

      - `titles: Optional[Dict[str, str]]`

        Human-readable titles keyed by BCP 47 language tag.

      - `type: Optional[str]`

        Media type of the target resource (per RFC 7033 section 4.4.4.3).
        Applies to external `href`s; typically omitted for intra-graph references.

    - `org_id: Optional[str]`

    - `outputs: Optional[Dict[str, object]]`

      Resolved output values produced by the provisioner, conforming to the
      package's `Package.outputs.schema`. Flat — the provisioner evaluates
      `Package.outputs.bindings` against the resolved entity graph.

    - `package_version: Optional[int]`

    - `zone_id: Optional[str]`

  - `pagination: Pagination`

    Cursor-based pagination metadata returned alongside a list of results

    - `after_cursor: Optional[str]`

      An opaque cursor used for paginating through a list of results

    - `before_cursor: Optional[str]`

      An opaque cursor used for paginating through a list of results

    - `total_count: Optional[int]`

      Total number of items across all pages. Only present when the request includes ?expand[]=total_count.

### Install Status

- `Literal["pending", "active", "deleting", 2 more]`

  - `"pending"`

  - `"active"`

  - `"deleting"`

  - `"failed"`

  - `"deleted"`