netsparker-cloud/dist/api/scanPoliciesApi.d.ts

JavaScript client for consuming the Netsparker Cloud API.

/**
 * Netsparker 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.
 */
/// <reference types="node" />
import http from 'http';
import { NewScanPolicySettingModel } from '../model/newScanPolicySettingModel';
import { ScanPolicyListApiResult } from '../model/scanPolicyListApiResult';
import { ScanPolicySettingApiModel } from '../model/scanPolicySettingApiModel';
import { UpdateScanPolicySettingModel } from '../model/updateScanPolicySettingModel';
import { Authentication, Interceptor } from '../model/models';
export declare enum ScanPoliciesApiApiKeys {
}
export declare class ScanPoliciesApi {
    protected _basePath: string;
    protected _defaultHeaders: any;
    protected _useQuerystring: boolean;
    protected authentications: {
        default: Authentication;
    };
    protected interceptors: Interceptor[];
    constructor(basePath?: string);
    set useQuerystring(value: boolean);
    set basePath(basePath: string);
    set defaultHeaders(defaultHeaders: any);
    get defaultHeaders(): any;
    get basePath(): string;
    setDefaultAuthentication(auth: Authentication): void;
    setApiKey(key: ScanPoliciesApiApiKeys, value: string): void;
    addInterceptor(interceptor: Interceptor): void;
    /**
     *
     * @summary Deletes a scan policy.
     * @param name The scan policy name.
     */
    scanPoliciesDelete(name: string, options?: {
        headers: {
            [name: string]: string;
        };
    }): Promise<{
        response: http.IncomingMessage;
        body?: any;
    }>;
    /**
     *
     * @summary Gets the scan policy by the specified name.
     * @param name The scan policy name.
     */
    scanPoliciesFind(name: string, options?: {
        headers: {
            [name: string]: string;
        };
    }): Promise<{
        response: http.IncomingMessage;
        body: ScanPolicySettingApiModel;
    }>;
    /**
     *
     * @summary Gets the scan policy by the specified id.
     * @param id The identifier of scan policy.
     */
    scanPoliciesGet(id: string, options?: {
        headers: {
            [name: string]: string;
        };
    }): Promise<{
        response: http.IncomingMessage;
        body: ScanPolicySettingApiModel;
    }>;
    /**
     *
     * @summary Gets the list of scan policies.
     * @param page The page index.
     * @param pageSize The page size. Page size can be any value between 1 and 200.
     */
    scanPoliciesList(page?: number, pageSize?: number, options?: {
        headers: {
            [name: string]: string;
        };
    }): Promise<{
        response: http.IncomingMessage;
        body: ScanPolicyListApiResult;
    }>;
    /**
     *
     * @summary Creates a new scan policy.
     * @param model The model.
     */
    scanPoliciesNew(model: NewScanPolicySettingModel, options?: {
        headers: {
            [name: string]: string;
        };
    }): Promise<{
        response: http.IncomingMessage;
        body: ScanPolicySettingApiModel;
    }>;
    /**
     *
     * @summary Updates a scan policy.
     * @param model The model.
     */
    scanPoliciesUpdate(model: UpdateScanPolicySettingModel, options?: {
        headers: {
            [name: string]: string;
        };
    }): Promise<{
        response: http.IncomingMessage;
        body: ScanPolicySettingApiModel;
    }>;
}