Interface Release

The object returned by the Releases API

Hierarchy

Properties

entities metadata? sys title

Methods

archive delete publish toPlainObject unarchive unpublish update validate

Properties

entities

entities: BaseCollection<Link<Entity>>

Optional metadata

metadata?: ReleaseMetadata

sys

sys: ReleaseSysProps

title

title: string

Methods

archive

  • Archives a release and locks any actions such as adding new entities or publishing/unpublishing. This operation increases the sys.version property

    Throws

    if the release is already archived

    Returns Promise<Release>

delete

  • Deletes a Release and all ReleaseActions linked to it (non-reversible)

    Returns Promise<void>

publish

  • Publishes a Release and waits until the asynchronous action is completed

    Parameters

    • Optional options: AsyncActionProcessingOptions

    Returns Promise<ReleaseAction<"publish">>

toPlainObject

unarchive

  • Unarchives an archived release and unlocks operations on the Release. This operation increases the sys.version property

    Throws

    if the release is not archived

    Returns Promise<Release>

unpublish

  • Unpublishes a Release and waits until the asynchronous action is completed

    Parameters

    • Optional options: AsyncActionProcessingOptions

    Returns Promise<ReleaseAction<"unpublish">>

update

validate

  • Validates a Release and waits until the asynchronous action is completed

    Parameters

    • Optional __namedParameters: {
          options?: AsyncActionProcessingOptions;
          payload?: ReleaseValidatePayload;
      }
      • Optional options?: AsyncActionProcessingOptions
      • Optional payload?: ReleaseValidatePayload

    Returns Promise<ReleaseAction<"validate">>

Settings

Member Visibility

Theme