Interface ReleaseApiMethods

Hierarchy

ReleaseApiMethods
- Release

Index

Methods

Methods

delete

delete(): Promise<void>

- Defined in lib/entities/release.ts:76
Deletes a Release and all ReleaseActions linked to it (non-reversible)

Returns Promise<void>

publish

publish(options?: AsyncActionProcessingOptions): Promise<ReleaseActionProps<"publish">>

- Defined in lib/entities/release.ts:78
Publishes a Release and waits until the asynchronous action is completed

Parameters
- Optional options: AsyncActionProcessingOptions
Returns Promise<ReleaseActionProps<"publish">>

unpublish

unpublish(options?: AsyncActionProcessingOptions): Promise<ReleaseActionProps<"unpublish">>

- Defined in lib/entities/release.ts:80
Unpublishes a Release and waits until the asynchronous action is completed

Parameters
- Optional options: AsyncActionProcessingOptions
Returns Promise<ReleaseActionProps<"unpublish">>

update

update(payload: ReleasePayload): Promise<Release>

- Defined in lib/entities/release.ts:74
Updates a Release and returns the updated Release object

Parameters
- payload: ReleasePayload
Returns Promise<Release>

validate

validate(__namedParameters?: { options: undefined | AsyncActionProcessingOptions; payload: undefined | ReleaseValidatePayload }): Promise<ReleaseActionProps<"validate">>

- Defined in lib/entities/release.ts:82
Validates a Release and waits until the asynchronous action is completed

Parameters
- Optional __namedParameters: { options: undefined | AsyncActionProcessingOptions; payload: undefined | ReleaseValidatePayload }
  - options: undefined | AsyncActionProcessingOptions
  - payload: undefined | ReleaseValidatePayload
Returns Promise<ReleaseActionProps<"validate">>