netsparker-cloud/src/model/scanReportApiModel.ts

JavaScript client for consuming the Netsparker Cloud API.

/**
 * Invicti Enterprise API
 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 *
 * The version of the OpenAPI document: v1
 * 
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */

import { RequestFile } from './models';

/**
* Represents a model for carrying scan report parameters.
*/
export class ScanReportApiModel {
    /**
    * Gets or sets the content format. This parameter can only be used for vulnerabilities XML and JSON report.
    */
    'contentFormat'?: ScanReportApiModel.ContentFormatEnum;
    /**
    * If set to true, HTTP response data will be excluded from the vulnerability detail. This parameter can only be  used for vulnerabilities XML report.  Default: false
    */
    'excludeResponseData'?: boolean;
    /**
    * Gets or sets the report format.  Crawled URLs, scanned URLs and vulnerabilities can be exported as XML, CSV or JSON.  Scan detail, SANS Top 25, Owasp Top Ten 2013, WASC Threat Classification, PCI Compliance, HIPAA Compliance, Executive Summary and Knowledge Base reports can be  exported as HTML or PDF.  ModSecurity WAF Rules report can be exported as TXT.
    */
    'format': ScanReportApiModel.FormatEnum;
    /**
    * Gets or sets the scan identifier.
    */
    'id': string;
    /**
    * Gets or sets the report type.  FullScanDetail option corresponds to \"Detailed Scan Report (Including addressed issues)\".  ScanDetail option corresponds to \"Detailed Scan Report (Excluding addressed issues)\".
    */
    'type': ScanReportApiModel.TypeEnum;
    /**
    * If this field set true then only the Confirmed Issues will be included to the report results.  This option not valid for KnowledgeBase, Crawled, Scanned, ModSecurityWafRules, F5BigIpAsmWafRules report types.  Default: null
    */
    'onlyConfirmedIssues'?: boolean;
    /**
    * If this field set true then only the Unconfirmed Issues will be included to the report results.  This option not valid for KnowledgeBase, Crawled, Scanned, ModSecurityWafRules, F5BigIpAsmWafRules report types.  Default: null
    */
    'onlyUnconfirmedIssues'?: boolean;
    /**
    * If this field set true then the Addressed Issues will be excluded from the report results.  FullScanDetail and ScanDetail options override this field.  This option not valid for KnowledgeBase, Crawled, Scanned, ModSecurityWafRules, F5BigIpAsmWafRules report types.  Default: null
    */
    'excludeAddressedIssues'?: boolean;

    static discriminator: string | undefined = undefined;

    static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
        {
            "name": "contentFormat",
            "baseName": "ContentFormat",
            "type": "ScanReportApiModel.ContentFormatEnum"
        },
        {
            "name": "excludeResponseData",
            "baseName": "ExcludeResponseData",
            "type": "boolean"
        },
        {
            "name": "format",
            "baseName": "Format",
            "type": "ScanReportApiModel.FormatEnum"
        },
        {
            "name": "id",
            "baseName": "Id",
            "type": "string"
        },
        {
            "name": "type",
            "baseName": "Type",
            "type": "ScanReportApiModel.TypeEnum"
        },
        {
            "name": "onlyConfirmedIssues",
            "baseName": "OnlyConfirmedIssues",
            "type": "boolean"
        },
        {
            "name": "onlyUnconfirmedIssues",
            "baseName": "OnlyUnconfirmedIssues",
            "type": "boolean"
        },
        {
            "name": "excludeAddressedIssues",
            "baseName": "ExcludeAddressedIssues",
            "type": "boolean"
        }    ];

    static getAttributeTypeMap() {
        return ScanReportApiModel.attributeTypeMap;
    }
}

export namespace ScanReportApiModel {
    export enum ContentFormatEnum {
        Html = <any> 'Html',
        Markdown = <any> 'Markdown'
    }
    export enum FormatEnum {
        Xml = <any> 'Xml',
        Csv = <any> 'Csv',
        Pdf = <any> 'Pdf',
        Html = <any> 'Html',
        Txt = <any> 'Txt',
        Json = <any> 'Json'
    }
    export enum TypeEnum {
        Crawled = <any> 'Crawled',
        Scanned = <any> 'Scanned',
        Vulnerabilities = <any> 'Vulnerabilities',
        ScanDetail = <any> 'ScanDetail',
        ModSecurityWafRules = <any> 'ModSecurityWafRules',
        OwaspTopTen2013 = <any> 'OwaspTopTen2013',
        HipaaCompliance = <any> 'HIPAACompliance',
        PciCompliance = <any> 'PCICompliance',
        KnowledgeBase = <any> 'KnowledgeBase',
        ExecutiveSummary = <any> 'ExecutiveSummary',
        FullScanDetail = <any> 'FullScanDetail',
        OwaspTopTen2017 = <any> 'OwaspTopTen2017',
        CustomReport = <any> 'CustomReport',
        Iso27001Compliance = <any> 'Iso27001Compliance',
        F5BigIpAsmWafRules = <any> 'F5BigIpAsmWafRules',
        Wasc = <any> 'WASC',
        SansTop25 = <any> 'SansTop25',
        Asvs40 = <any> 'Asvs40',
        Nistsp80053 = <any> 'Nistsp80053',
        DisaStig = <any> 'DisaStig',
        OwaspApiTop10 = <any> 'OwaspApiTop10',
        OwaspTopTen2021 = <any> 'OwaspTopTen2021'
    }
}