/* tslint:disable */ /* eslint-disable */ /** * 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 globalAxios from 'axios'; import { convertToFireblocksResponse } from "../response/fireblocksResponse"; // URLSearchParams not necessarily used // @ts-ignore import { URL, URLSearchParams } from 'url'; // Some imports not used depending on template conditions // @ts-ignore import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common'; import { assertParamExistsAndNotEmpty } from '../utils/validation_utils'; // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base'; // @ts-ignore import { ErrorSchema } from '../models'; // @ts-ignore import { GetAuditLogsResponse } from '../models'; /** * AuditLogsApi - axios parameter creator * @export */ export const AuditLogsApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * 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: async (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 => { const localVarPath = `/management/audit_logs`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options}; // Stamped onto the request config (not the headers, so it never goes on // the wire) so the response interceptor can name the operation in the // lifecycle warning. Key must match OPERATION_ID_CONFIG_KEY in utils/lifecycleWarning. (localVarRequestOptions as any).fireblocksOperationId = 'getAuditLogs'; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; if (startTime !== undefined) { localVarQueryParameter['startTime'] = startTime; } if (endTime !== undefined) { localVarQueryParameter['endTime'] = endTime; } if (timePeriod !== undefined) { localVarQueryParameter['timePeriod'] = timePeriod; } if (category) { localVarQueryParameter['category'] = category; } if (subject) { localVarQueryParameter['subject'] = subject; } if (event) { localVarQueryParameter['event'] = event; } if (user) { localVarQueryParameter['user'] = user; } if (userId) { localVarQueryParameter['userId'] = userId; } if (order !== undefined) { localVarQueryParameter['order'] = order; } if (pageSize !== undefined) { localVarQueryParameter['pageSize'] = pageSize; } if (pageCursor !== undefined) { localVarQueryParameter['pageCursor'] = pageCursor; } if (cursor !== undefined) { localVarQueryParameter['cursor'] = cursor; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, } }; /** * AuditLogsApi - functional programming interface * @export */ export const AuditLogsApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = AuditLogsApiAxiosParamCreator(configuration) return { /** * 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} */ async 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> { const localVarAxiosArgs = await localVarAxiosParamCreator.getAuditLogs(startTime, endTime, timePeriod, category, subject, event, user, userId, order, pageSize, pageCursor, cursor, options); const index = configuration?.serverIndex ?? 0; const operationBasePath = operationServerMap['AuditLogsApi.getAuditLogs']?.[index]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, operationBasePath || basePath); }, } }; /** * AuditLogsApi - factory interface * @export */ export const AuditLogsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = AuditLogsApiFp(configuration) return { /** * 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 { return localVarFp.getAuditLogs(requestParameters.startTime, requestParameters.endTime, requestParameters.timePeriod, requestParameters.category, requestParameters.subject, requestParameters.event, requestParameters.user, requestParameters.userId, requestParameters.order, requestParameters.pageSize, requestParameters.pageCursor, requestParameters.cursor, options).then((request) => request(axios, basePath)); }, }; }; /** * 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 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 */ public getAuditLogs(requestParameters: AuditLogsApiGetAuditLogsRequest = {}) { return AuditLogsApiFp(this.configuration).getAuditLogs(requestParameters.startTime, requestParameters.endTime, requestParameters.timePeriod, requestParameters.category, requestParameters.subject, requestParameters.event, requestParameters.user, requestParameters.userId, requestParameters.order, requestParameters.pageSize, requestParameters.pageCursor, requestParameters.cursor).then((request) => request(this.axios, this.basePath)).then(convertToFireblocksResponse); } } /** * @export */ export const GetAuditLogsTimePeriodEnum = { Day: 'DAY', Week: 'WEEK' } as const; export type GetAuditLogsTimePeriodEnum = typeof GetAuditLogsTimePeriodEnum[keyof typeof GetAuditLogsTimePeriodEnum]; /** * @export */ export const GetAuditLogsOrderEnum = { Asc: 'ASC', Desc: 'DESC' } as const; export type GetAuditLogsOrderEnum = typeof GetAuditLogsOrderEnum[keyof typeof GetAuditLogsOrderEnum];