/** * 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 { GetAuditLogsResponse } from '../models'; /** * AuditLogsApi - axios parameter creator * @export */ export declare const AuditLogsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Retrieve audit log events for the workspace with optional filtering, date range, sorting, and cursor-based pagination. Filters within the same field are combined as OR (e.g. category=Administration&category=Security returns events in either category). Filters across different fields are combined as AND. **Deprecated parameters:** `timePeriod` and `cursor` remain functional for backward compatibility but new integrations should use `startTime`/`endTime` and `pageCursor` instead. Endpoint Permission: Admin, Non-Signing Admin, Auditor, Security Admin, Security Auditor. * @summary Get audit logs * @param {number} [startTime] Start of date range as epoch time in milliseconds. Takes precedence over timePeriod when provided. Must be no more than 1 year before the current time. * @param {number} [endTime] End of date range as epoch time in milliseconds. Must be after startTime. Defaults to now when omitted. * @param {GetAuditLogsTimePeriodEnum} [timePeriod] Deprecated. Use startTime/endTime instead. Ignored when startTime is provided. Defaults to DAY when neither timePeriod nor startTime is supplied. * @param {Array} [category] Filter by event category. Repeat the parameter for multiple values (OR logic within field). * @param {Array} [subject] Filter by event subject. Repeat the parameter for multiple values. * @param {Array} [event] Filter by event type. Repeat the parameter for multiple values. * @param {Array} [user] Filter by user name. Repeat the parameter for multiple values. * @param {Array} [userId] Filter by user ID. Repeat the parameter for multiple values. * @param {GetAuditLogsOrderEnum} [order] Sort direction. Defaults to DESC. * @param {number} [pageSize] Number of results per page. Maximum 500. Defaults to 200. * @param {string} [pageCursor] Cursor returned from the previous response to fetch the next page. * @param {string} [cursor] Deprecated. Use pageCursor instead. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAuditLogs: (startTime?: number, endTime?: number, timePeriod?: GetAuditLogsTimePeriodEnum, category?: Array, subject?: Array, event?: Array, user?: Array, userId?: Array, order?: GetAuditLogsOrderEnum, pageSize?: number, pageCursor?: string, cursor?: string, options?: RawAxiosRequestConfig) => Promise; }; /** * AuditLogsApi - functional programming interface * @export */ export declare const AuditLogsApiFp: (configuration?: Configuration) => { /** * Retrieve audit log events for the workspace with optional filtering, date range, sorting, and cursor-based pagination. Filters within the same field are combined as OR (e.g. category=Administration&category=Security returns events in either category). Filters across different fields are combined as AND. **Deprecated parameters:** `timePeriod` and `cursor` remain functional for backward compatibility but new integrations should use `startTime`/`endTime` and `pageCursor` instead. Endpoint Permission: Admin, Non-Signing Admin, Auditor, Security Admin, Security Auditor. * @summary Get audit logs * @param {number} [startTime] Start of date range as epoch time in milliseconds. Takes precedence over timePeriod when provided. Must be no more than 1 year before the current time. * @param {number} [endTime] End of date range as epoch time in milliseconds. Must be after startTime. Defaults to now when omitted. * @param {GetAuditLogsTimePeriodEnum} [timePeriod] Deprecated. Use startTime/endTime instead. Ignored when startTime is provided. Defaults to DAY when neither timePeriod nor startTime is supplied. * @param {Array} [category] Filter by event category. Repeat the parameter for multiple values (OR logic within field). * @param {Array} [subject] Filter by event subject. Repeat the parameter for multiple values. * @param {Array} [event] Filter by event type. Repeat the parameter for multiple values. * @param {Array} [user] Filter by user name. Repeat the parameter for multiple values. * @param {Array} [userId] Filter by user ID. Repeat the parameter for multiple values. * @param {GetAuditLogsOrderEnum} [order] Sort direction. Defaults to DESC. * @param {number} [pageSize] Number of results per page. Maximum 500. Defaults to 200. * @param {string} [pageCursor] Cursor returned from the previous response to fetch the next page. * @param {string} [cursor] Deprecated. Use pageCursor instead. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAuditLogs(startTime?: number, endTime?: number, timePeriod?: GetAuditLogsTimePeriodEnum, category?: Array, subject?: Array, event?: Array, user?: Array, userId?: Array, order?: GetAuditLogsOrderEnum, pageSize?: number, pageCursor?: string, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * AuditLogsApi - factory interface * @export */ export declare const AuditLogsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Retrieve audit log events for the workspace with optional filtering, date range, sorting, and cursor-based pagination. Filters within the same field are combined as OR (e.g. category=Administration&category=Security returns events in either category). Filters across different fields are combined as AND. **Deprecated parameters:** `timePeriod` and `cursor` remain functional for backward compatibility but new integrations should use `startTime`/`endTime` and `pageCursor` instead. Endpoint Permission: Admin, Non-Signing Admin, Auditor, Security Admin, Security Auditor. * @summary Get audit logs * @param {AuditLogsApiGetAuditLogsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAuditLogs(requestParameters?: AuditLogsApiGetAuditLogsRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for getAuditLogs operation in AuditLogsApi. * @export * @interface AuditLogsApiGetAuditLogsRequest */ export interface AuditLogsApiGetAuditLogsRequest { /** * Start of date range as epoch time in milliseconds. Takes precedence over timePeriod when provided. Must be no more than 1 year before the current time. * @type {number} * @memberof AuditLogsApiGetAuditLogs */ readonly startTime?: number; /** * End of date range as epoch time in milliseconds. Must be after startTime. Defaults to now when omitted. * @type {number} * @memberof AuditLogsApiGetAuditLogs */ readonly endTime?: number; /** * Deprecated. Use startTime/endTime instead. Ignored when startTime is provided. Defaults to DAY when neither timePeriod nor startTime is supplied. * @type {'DAY' | 'WEEK'} * @memberof AuditLogsApiGetAuditLogs */ readonly timePeriod?: GetAuditLogsTimePeriodEnum; /** * Filter by event category. Repeat the parameter for multiple values (OR logic within field). * @type {Array} * @memberof AuditLogsApiGetAuditLogs */ readonly category?: Array; /** * Filter by event subject. Repeat the parameter for multiple values. * @type {Array} * @memberof AuditLogsApiGetAuditLogs */ readonly subject?: Array; /** * Filter by event type. Repeat the parameter for multiple values. * @type {Array} * @memberof AuditLogsApiGetAuditLogs */ readonly event?: Array; /** * Filter by user name. Repeat the parameter for multiple values. * @type {Array} * @memberof AuditLogsApiGetAuditLogs */ readonly user?: Array; /** * Filter by user ID. Repeat the parameter for multiple values. * @type {Array} * @memberof AuditLogsApiGetAuditLogs */ readonly userId?: Array; /** * Sort direction. Defaults to DESC. * @type {'ASC' | 'DESC'} * @memberof AuditLogsApiGetAuditLogs */ readonly order?: GetAuditLogsOrderEnum; /** * Number of results per page. Maximum 500. Defaults to 200. * @type {number} * @memberof AuditLogsApiGetAuditLogs */ readonly pageSize?: number; /** * Cursor returned from the previous response to fetch the next page. * @type {string} * @memberof AuditLogsApiGetAuditLogs */ readonly pageCursor?: string; /** * Deprecated. Use pageCursor instead. * @type {string} * @memberof AuditLogsApiGetAuditLogs */ readonly cursor?: string; } /** * AuditLogsApi - object-oriented interface * @export * @class AuditLogsApi * @extends {BaseAPI} */ export declare class AuditLogsApi extends BaseAPI { /** * Retrieve audit log events for the workspace with optional filtering, date range, sorting, and cursor-based pagination. Filters within the same field are combined as OR (e.g. category=Administration&category=Security returns events in either category). Filters across different fields are combined as AND. **Deprecated parameters:** `timePeriod` and `cursor` remain functional for backward compatibility but new integrations should use `startTime`/`endTime` and `pageCursor` instead. Endpoint Permission: Admin, Non-Signing Admin, Auditor, Security Admin, Security Auditor. * @summary Get audit logs * @param {AuditLogsApiGetAuditLogsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuditLogsApi */ getAuditLogs(requestParameters?: AuditLogsApiGetAuditLogsRequest): Promise>; } /** * @export */ export declare const GetAuditLogsTimePeriodEnum: { readonly Day: "DAY"; readonly Week: "WEEK"; }; export type GetAuditLogsTimePeriodEnum = typeof GetAuditLogsTimePeriodEnum[keyof typeof GetAuditLogsTimePeriodEnum]; /** * @export */ export declare const GetAuditLogsOrderEnum: { readonly Asc: "ASC"; readonly Desc: "DESC"; }; export type GetAuditLogsOrderEnum = typeof GetAuditLogsOrderEnum[keyof typeof GetAuditLogsOrderEnum];