Interface downloadProductReportParams

interface downloadProductReportParams {
    outputFilename?: string;
    productId: string;
    reportSubtype: "ALL_FINDINGS";
    reportType: "CSV";
    verbose?: boolean;
}

Properties

outputFilename? productId reportSubtype reportType verbose?

Properties

OptionaloutputFilename

outputFilename?: string

The local filename to save the report to. If not provided, the report will be saved to a file named "report.csv" or "report.pdf" in the current directory based on the report type.

productId

productId: string

The Product ID to download the report for.

reportSubtype

reportSubtype: "ALL_FINDINGS"

The type of report to download. Based on available reports for the reportType specified Valid values for CSV are "ALL_FINDINGS".

reportType

reportType: "CSV"

The file type of the report to download. Valid values are "CSV".

Optionalverbose

verbose?: boolean

If True, will print additional information to the console. Defaults to False.

Settings

Member Visibility

On This Page

Properties