Class ImagesApi

Service that exposes the /images domain.

Represents the ImagesApi class that provides methods for interacting with Situm's images.

Index

Constructors

Methods

Constructors

constructor

new ImagesApi(apiBase: ApiBase): ImagesApi
Parameters
- apiBase: ApiBase
Returns ImagesApi
- Defined in domains/images.ts:23

Methods

uploadImage

uploadImage(
image: Blob,
options?: { filename?: string; rtf?: boolean },
): Promise<ResponseImages>
Uploads a new image to Situm's backend.
Parameters
- image: Blob
  The image to upload.
- options: { filename?: string; rtf?: boolean } = {}
  Optional parameters for the request. Can include rtf and filename.
Returns Promise<ResponseImages>
- Defined in domains/images.ts:33