/** * Fireblocks API * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) * * The version of the OpenAPI document: 1.6.2 * Contact: developers@fireblocks.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import { RequestArgs, BaseAPI } from '../base'; import { GetFindingsExternalResponse } from '../models'; import { SecurityFindingDetailed } from '../models'; import { UpdateFindingExternalRequest } from '../models'; /** * SecurityPostureManagementApi - axios parameter creator * @export */ export declare const SecurityPostureManagementApiAxiosParamCreator: (configuration?: Configuration) => { /** * Returns a single FSPM security finding for the workspace, redacted to the public field set. Endpoint Roles: Security Admin, Security Auditor. **Note:** This endpoint is available only for the FSPM Pro package. It is not available for FSPM Basic. * @summary Get a FSPM security finding by ID * @param {string} id Unique identifier of the finding * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSecurityFindingById: (id: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns a paginated list of FSPM security findings for the workspace. Endpoint Roles: Security Admin, Security Auditor. **Note:** This endpoint is available only for the FSPM Pro package. It is not available for FSPM Basic. * @summary Get FSPM security findings * @param {string} [pageCursor] Cursor indicating the page position. Omit to fetch the first page. * @param {number} [pageSize] Number of results per page * @param {GetSecurityFindingsSeverityEnum} [severity] Filter by severity level * @param {GetSecurityFindingsCategoryEnum} [category] Filter by finding category * @param {GetSecurityFindingsStatusEnum} [status] Filter by finding status * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSecurityFindings: (pageCursor?: string, pageSize?: number, severity?: GetSecurityFindingsSeverityEnum, category?: GetSecurityFindingsCategoryEnum, status?: GetSecurityFindingsStatusEnum, options?: RawAxiosRequestConfig) => Promise; /** * Accepts or reopens a finding for the workspace. When accepting a finding (`status: \"ACCEPTED\"`), `statusUpdatedReason` is required. Endpoint Roles: Security Admin. **Note:** This endpoint is available only for the FSPM Pro package. It is not available for FSPM Basic. * @summary Update a FSPM security finding by ID * @param {UpdateFindingExternalRequest} updateFindingExternalRequest * @param {string} id Unique identifier of the finding * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSecurityFindingById: (updateFindingExternalRequest: UpdateFindingExternalRequest, id: string, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; }; /** * SecurityPostureManagementApi - functional programming interface * @export */ export declare const SecurityPostureManagementApiFp: (configuration?: Configuration) => { /** * Returns a single FSPM security finding for the workspace, redacted to the public field set. Endpoint Roles: Security Admin, Security Auditor. **Note:** This endpoint is available only for the FSPM Pro package. It is not available for FSPM Basic. * @summary Get a FSPM security finding by ID * @param {string} id Unique identifier of the finding * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSecurityFindingById(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a paginated list of FSPM security findings for the workspace. Endpoint Roles: Security Admin, Security Auditor. **Note:** This endpoint is available only for the FSPM Pro package. It is not available for FSPM Basic. * @summary Get FSPM security findings * @param {string} [pageCursor] Cursor indicating the page position. Omit to fetch the first page. * @param {number} [pageSize] Number of results per page * @param {GetSecurityFindingsSeverityEnum} [severity] Filter by severity level * @param {GetSecurityFindingsCategoryEnum} [category] Filter by finding category * @param {GetSecurityFindingsStatusEnum} [status] Filter by finding status * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSecurityFindings(pageCursor?: string, pageSize?: number, severity?: GetSecurityFindingsSeverityEnum, category?: GetSecurityFindingsCategoryEnum, status?: GetSecurityFindingsStatusEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Accepts or reopens a finding for the workspace. When accepting a finding (`status: \"ACCEPTED\"`), `statusUpdatedReason` is required. Endpoint Roles: Security Admin. **Note:** This endpoint is available only for the FSPM Pro package. It is not available for FSPM Basic. * @summary Update a FSPM security finding by ID * @param {UpdateFindingExternalRequest} updateFindingExternalRequest * @param {string} id Unique identifier of the finding * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSecurityFindingById(updateFindingExternalRequest: UpdateFindingExternalRequest, id: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * SecurityPostureManagementApi - factory interface * @export */ export declare const SecurityPostureManagementApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Returns a single FSPM security finding for the workspace, redacted to the public field set. Endpoint Roles: Security Admin, Security Auditor. **Note:** This endpoint is available only for the FSPM Pro package. It is not available for FSPM Basic. * @summary Get a FSPM security finding by ID * @param {SecurityPostureManagementApiGetSecurityFindingByIdRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSecurityFindingById(requestParameters: SecurityPostureManagementApiGetSecurityFindingByIdRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns a paginated list of FSPM security findings for the workspace. Endpoint Roles: Security Admin, Security Auditor. **Note:** This endpoint is available only for the FSPM Pro package. It is not available for FSPM Basic. * @summary Get FSPM security findings * @param {SecurityPostureManagementApiGetSecurityFindingsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSecurityFindings(requestParameters?: SecurityPostureManagementApiGetSecurityFindingsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Accepts or reopens a finding for the workspace. When accepting a finding (`status: \"ACCEPTED\"`), `statusUpdatedReason` is required. Endpoint Roles: Security Admin. **Note:** This endpoint is available only for the FSPM Pro package. It is not available for FSPM Basic. * @summary Update a FSPM security finding by ID * @param {SecurityPostureManagementApiUpdateSecurityFindingByIdRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateSecurityFindingById(requestParameters: SecurityPostureManagementApiUpdateSecurityFindingByIdRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for getSecurityFindingById operation in SecurityPostureManagementApi. * @export * @interface SecurityPostureManagementApiGetSecurityFindingByIdRequest */ export interface SecurityPostureManagementApiGetSecurityFindingByIdRequest { /** * Unique identifier of the finding * @type {string} * @memberof SecurityPostureManagementApiGetSecurityFindingById */ readonly id: string; } /** * Request parameters for getSecurityFindings operation in SecurityPostureManagementApi. * @export * @interface SecurityPostureManagementApiGetSecurityFindingsRequest */ export interface SecurityPostureManagementApiGetSecurityFindingsRequest { /** * Cursor indicating the page position. Omit to fetch the first page. * @type {string} * @memberof SecurityPostureManagementApiGetSecurityFindings */ readonly pageCursor?: string; /** * Number of results per page * @type {number} * @memberof SecurityPostureManagementApiGetSecurityFindings */ readonly pageSize?: number; /** * Filter by severity level * @type {'INFO' | 'LOW' | 'MEDIUM' | 'HIGH'} * @memberof SecurityPostureManagementApiGetSecurityFindings */ readonly severity?: GetSecurityFindingsSeverityEnum; /** * Filter by finding category * @type {'USER_MANAGEMENT' | 'APPROVAL_GROUP_MANAGEMENT' | 'POLICY_ENGINE_UTILIZATION' | 'WORKSPACE_CONFIGURATION' | 'DEFI_ACCESS' | 'FLEET_MANAGEMENT'} * @memberof SecurityPostureManagementApiGetSecurityFindings */ readonly category?: GetSecurityFindingsCategoryEnum; /** * Filter by finding status * @type {'OPEN' | 'ACCEPTED' | 'RESOLVED'} * @memberof SecurityPostureManagementApiGetSecurityFindings */ readonly status?: GetSecurityFindingsStatusEnum; } /** * Request parameters for updateSecurityFindingById operation in SecurityPostureManagementApi. * @export * @interface SecurityPostureManagementApiUpdateSecurityFindingByIdRequest */ export interface SecurityPostureManagementApiUpdateSecurityFindingByIdRequest { /** * * @type {UpdateFindingExternalRequest} * @memberof SecurityPostureManagementApiUpdateSecurityFindingById */ readonly updateFindingExternalRequest: UpdateFindingExternalRequest; /** * Unique identifier of the finding * @type {string} * @memberof SecurityPostureManagementApiUpdateSecurityFindingById */ readonly id: string; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof SecurityPostureManagementApiUpdateSecurityFindingById */ readonly idempotencyKey?: string; } /** * SecurityPostureManagementApi - object-oriented interface * @export * @class SecurityPostureManagementApi * @extends {BaseAPI} */ export declare class SecurityPostureManagementApi extends BaseAPI { /** * Returns a single FSPM security finding for the workspace, redacted to the public field set. Endpoint Roles: Security Admin, Security Auditor. **Note:** This endpoint is available only for the FSPM Pro package. It is not available for FSPM Basic. * @summary Get a FSPM security finding by ID * @param {SecurityPostureManagementApiGetSecurityFindingByIdRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SecurityPostureManagementApi */ getSecurityFindingById(requestParameters: SecurityPostureManagementApiGetSecurityFindingByIdRequest): Promise>; /** * Returns a paginated list of FSPM security findings for the workspace. Endpoint Roles: Security Admin, Security Auditor. **Note:** This endpoint is available only for the FSPM Pro package. It is not available for FSPM Basic. * @summary Get FSPM security findings * @param {SecurityPostureManagementApiGetSecurityFindingsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SecurityPostureManagementApi */ getSecurityFindings(requestParameters?: SecurityPostureManagementApiGetSecurityFindingsRequest): Promise>; /** * Accepts or reopens a finding for the workspace. When accepting a finding (`status: \"ACCEPTED\"`), `statusUpdatedReason` is required. Endpoint Roles: Security Admin. **Note:** This endpoint is available only for the FSPM Pro package. It is not available for FSPM Basic. * @summary Update a FSPM security finding by ID * @param {SecurityPostureManagementApiUpdateSecurityFindingByIdRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SecurityPostureManagementApi */ updateSecurityFindingById(requestParameters: SecurityPostureManagementApiUpdateSecurityFindingByIdRequest): Promise>; } /** * @export */ export declare const GetSecurityFindingsSeverityEnum: { readonly Info: "INFO"; readonly Low: "LOW"; readonly Medium: "MEDIUM"; readonly High: "HIGH"; }; export type GetSecurityFindingsSeverityEnum = typeof GetSecurityFindingsSeverityEnum[keyof typeof GetSecurityFindingsSeverityEnum]; /** * @export */ export declare const GetSecurityFindingsCategoryEnum: { readonly UserManagement: "USER_MANAGEMENT"; readonly ApprovalGroupManagement: "APPROVAL_GROUP_MANAGEMENT"; readonly PolicyEngineUtilization: "POLICY_ENGINE_UTILIZATION"; readonly WorkspaceConfiguration: "WORKSPACE_CONFIGURATION"; readonly DefiAccess: "DEFI_ACCESS"; readonly FleetManagement: "FLEET_MANAGEMENT"; }; export type GetSecurityFindingsCategoryEnum = typeof GetSecurityFindingsCategoryEnum[keyof typeof GetSecurityFindingsCategoryEnum]; /** * @export */ export declare const GetSecurityFindingsStatusEnum: { readonly Open: "OPEN"; readonly Accepted: "ACCEPTED"; readonly Resolved: "RESOLVED"; }; export type GetSecurityFindingsStatusEnum = typeof GetSecurityFindingsStatusEnum[keyof typeof GetSecurityFindingsStatusEnum];