Class CoverPagesApi

Index

Methods

add delete get list

Methods

add

add(data: AddCoverPageRequestData): Promise<CoverPage>
Add cover page Add a cover page to your service
Parameters
- data: AddCoverPageRequestData
  The data to provide to the API call.
Returns Promise<CoverPage>

delete

delete(data: DeleteCoverPageRequestData): Promise<void>
Delete a cover page Remove delete a cover page from a service.
Parameters
- data: DeleteCoverPageRequestData
  The data to provide to the API call.
Returns Promise<void>

get

get(data: GetCoverPageRequestData): Promise<CoverPage>
Get a cover page Get a cover page by ID.
Parameters
- data: GetCoverPageRequestData
  The data to provide to the API call.
Returns Promise<CoverPage>

list

list(data: ListCoverPagesRequestData): ApiListPromise<CoverPageInfo>
List cover pages Lists the cover pages on a service. To retrieve the cover page file, use the get operation to download it.
Parameters
- data: ListCoverPagesRequestData
  The data to provide to the API call.
Returns ApiListPromise<CoverPageInfo>