Interface Release

The object returned by the Releases API

interface Release {
    entities: BaseCollection<Link<Entity>>;
    metadata?: ReleaseMetadata;
    sys: ReleaseSysProps;
    title: string;
    archive(): Promise<Release>;
    delete(): Promise<void>;
    publish(options?: AsyncActionProcessingOptions): Promise<ReleaseAction<"publish">>;
    toPlainObject(): ReleaseProps;
    unarchive(): Promise<Release>;
    unpublish(options?: AsyncActionProcessingOptions): Promise<ReleaseAction<"unpublish">>;
    update(payload: ReleasePayload): Promise<Release>;
    validate(__namedParameters?: {
        options?: AsyncActionProcessingOptions;
        payload?: ReleaseValidatePayload;
    }): Promise<ReleaseAction<"validate">>;
}

Hierarchy (view full)

Properties

entities metadata? sys title

Methods

archive delete publish toPlainObject unarchive unpublish update validate

Properties

entities

entities: BaseCollection<Link<Entity>>

Optionalmetadata

metadata?: ReleaseMetadata

sys

sys: ReleaseSysProps

title

title: string

Methods

archive

  • archive(): Promise<Release>

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

    Returns Promise<Release>

    Throws

    if the release is already archived

delete

  • delete(): Promise<void>

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

    Returns Promise<void>

publish

  • publish(options?): Promise<ReleaseAction<"publish">>

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

    Parameters

    • Optionaloptions: AsyncActionProcessingOptions

    Returns Promise<ReleaseAction<"publish">>

toPlainObject

unarchive

  • unarchive(): Promise<Release>

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

    Returns Promise<Release>

    Throws

    if the release is not archived

unpublish

  • unpublish(options?): Promise<ReleaseAction<"unpublish">>

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

    Parameters

    • Optionaloptions: AsyncActionProcessingOptions

    Returns Promise<ReleaseAction<"unpublish">>

update

validate

  • validate(__namedParameters?): Promise<ReleaseAction<"validate">>

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

    Parameters

    • Optional__namedParameters: {
          options?: AsyncActionProcessingOptions;
          payload?: ReleaseValidatePayload;
      }
      • Optionaloptions?: AsyncActionProcessingOptions
      • Optionalpayload?: ReleaseValidatePayload

    Returns Promise<ReleaseAction<"validate">>

Settings

Member Visibility

On This Page

Properties
Methods