Interface ReportsAPI

interface ReportsAPI {
    clearCache: () => void;
    createReport: (
        body: ReportRequest,
        options?: ApiCallOptions,
    ) => Promise<CreateReportHttpResponse>;
    getReportStatus: (
        id: string,
        options?: ApiCallOptions,
    ) => Promise<GetReportStatusHttpResponse>;
}

Index

Properties

clearCache createReport getReportStatus

Properties

clearCache

clearCache: () => void

Clears the cache for reports api requests.

Type declaration

- (): void
- Clears the cache for reports api requests.
  
  Returns void

createReport

createReport: (
body: ReportRequest,
options?: ApiCallOptions,
) => Promise<CreateReportHttpResponse>

Queue a new report request generation.

Type declaration

- (
  body: ReportRequest,
  options?: ApiCallOptions,
  ): Promise<CreateReportHttpResponse>
- Queue a new report request generation.
  Parameters
  - body: ReportRequest
    an object with the body content
  - Optionaloptions: ApiCallOptions
  Returns Promise<CreateReportHttpResponse>
  Throws
  CreateReportHttpError

Param: body

an object with the body content

Throws

CreateReportHttpError

getReportStatus

getReportStatus: (
id: string,
options?: ApiCallOptions,
) => Promise<GetReportStatusHttpResponse>

Get report request processing status.

Type declaration

- (id: string, options?: ApiCallOptions): Promise<GetReportStatusHttpResponse>
- Get report request processing status.
  Parameters
  - id: string
    Identifier of the request.
  - Optionaloptions: ApiCallOptions
  Returns Promise<GetReportStatusHttpResponse>
  Throws
  GetReportStatusHttpError

Param: id

Identifier of the request.

Throws

GetReportStatusHttpError