Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

entities

entities: BaseCollection<Link<Entity>>

sys

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

    {BadRequest} if the release is already archived

    Returns Promise<Release>

delete

  • delete(): Promise<void>
  • Deletes a Release and all ReleaseActions linked to it (non-reversible)

    Returns Promise<void>

publish

  • publish(options?: AsyncActionProcessingOptions): Promise<ReleaseAction<"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

    {BadRequest} if the release is not archived

    Returns Promise<Release>

unpublish

  • unpublish(options?: AsyncActionProcessingOptions): Promise<ReleaseAction<"unpublish">>
  • Unpublishes a Release and waits until the asynchronous action is completed

    Parameters

    • Optional options: AsyncActionProcessingOptions

    Returns Promise<ReleaseAction<"unpublish">>

update

validate

  • validate(__namedParameters?: { options?: AsyncActionProcessingOptions; payload?: ReleaseValidatePayload }): Promise<ReleaseAction<"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">>