# Installs

## Domain Types

### Install

- `type Install struct{…}`

  - `ID string`

  - `CreatedAt Time`

  - `PackageID string`

  - `PackageSlug string`

  - `Status InstallStatus`

    - `const InstallStatusPending InstallStatus = "pending"`

    - `const InstallStatusActive InstallStatus = "active"`

    - `const InstallStatusDeleting InstallStatus = "deleting"`

    - `const InstallStatusFailed InstallStatus = "failed"`

    - `const InstallStatusDeleted InstallStatus = "deleted"`

  - `UpdatedAt Time`

  - `Inputs map[string, any]`

    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 []InstallLink`

    - `Href string`

      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 string`

      Link relation type.

    - `Properties map[string, any]`

      Additional metadata keyed by property name.

    - `Titles map[string, string]`

      Human-readable titles keyed by BCP 47 language tag.

    - `Type string`

      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.

  - `OrgID string`

  - `Outputs map[string, any]`

    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.

  - `PackageVersion int64`

  - `ZoneID string`

### Install List

- `type InstallList struct{…}`

  - `Items []Install`

    - `ID string`

    - `CreatedAt Time`

    - `PackageID string`

    - `PackageSlug string`

    - `Status InstallStatus`

      - `const InstallStatusPending InstallStatus = "pending"`

      - `const InstallStatusActive InstallStatus = "active"`

      - `const InstallStatusDeleting InstallStatus = "deleting"`

      - `const InstallStatusFailed InstallStatus = "failed"`

      - `const InstallStatusDeleted InstallStatus = "deleted"`

    - `UpdatedAt Time`

    - `Inputs map[string, any]`

      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 []InstallLink`

      - `Href string`

        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 string`

        Link relation type.

      - `Properties map[string, any]`

        Additional metadata keyed by property name.

      - `Titles map[string, string]`

        Human-readable titles keyed by BCP 47 language tag.

      - `Type string`

        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.

    - `OrgID string`

    - `Outputs map[string, any]`

      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.

    - `PackageVersion int64`

    - `ZoneID string`

  - `Pagination InstallListPagination`

    Cursor-based pagination metadata returned alongside a list of results

    - `AfterCursor string`

      An opaque cursor used for paginating through a list of results

    - `BeforeCursor string`

      An opaque cursor used for paginating through a list of results

    - `TotalCount int64`

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

### Install Status

- `type InstallStatus string`

  - `const InstallStatusPending InstallStatus = "pending"`

  - `const InstallStatusActive InstallStatus = "active"`

  - `const InstallStatusDeleting InstallStatus = "deleting"`

  - `const InstallStatusFailed InstallStatus = "failed"`

  - `const InstallStatusDeleted InstallStatus = "deleted"`