/** * Permit.io API * Authorization as a service * * The version of the OpenAPI document: 2.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; import { Configuration } from '../configuration'; import { RequestArgs, BaseAPI } from '../base'; import { AuditLogSortKey } from '../types'; import { DetailedAuditLog } from '../types'; import { PaginatedResultAuditLog } from '../types'; /** * AuditLogsApi - axios parameter creator * @export */ export declare const AuditLogsApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary Get detailed audit log * @param {string} projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\"). * @param {string} envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\"). * @param {string} logId The unique id of the audit log * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDetailedAuditLog: (projId: string, envId: string, logId: string, options?: AxiosRequestConfig) => Promise; /** * * @summary List Audit Logs * @param {string} projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\"). * @param {string} envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\"). * @param {string} [pdpId] Filter by pdp config id * @param {Array} [users] List of user keys or emails to filter by * @param {boolean} [decision] Filter by decision result * @param {Array} [resources] Filter by resources * @param {string} [tenant] Filter by tenant * @param {string} [action] Filter by action * @param {number} [timestampFrom] Filter by timestamp from * @param {number} [timestampTo] Filter by timestamp to * @param {AuditLogSortKey} [sortBy] Sort by column * @param {number} [page] Page number of the results to fetch, starting at 1. * @param {number} [perPage] The number of results per page (max 100). * @param {*} [options] Override http request option. * @throws {RequiredError} */ listAuditLogs: (projId: string, envId: string, pdpId?: string, users?: Array, decision?: boolean, resources?: Array, tenant?: string, action?: string, timestampFrom?: number, timestampTo?: number, sortBy?: AuditLogSortKey, page?: number, perPage?: number, options?: AxiosRequestConfig) => Promise; }; /** * AuditLogsApi - functional programming interface * @export */ export declare const AuditLogsApiFp: (configuration?: Configuration) => { /** * * @summary Get detailed audit log * @param {string} projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\"). * @param {string} envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\"). * @param {string} logId The unique id of the audit log * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDetailedAuditLog(projId: string, envId: string, logId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary List Audit Logs * @param {string} projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\"). * @param {string} envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\"). * @param {string} [pdpId] Filter by pdp config id * @param {Array} [users] List of user keys or emails to filter by * @param {boolean} [decision] Filter by decision result * @param {Array} [resources] Filter by resources * @param {string} [tenant] Filter by tenant * @param {string} [action] Filter by action * @param {number} [timestampFrom] Filter by timestamp from * @param {number} [timestampTo] Filter by timestamp to * @param {AuditLogSortKey} [sortBy] Sort by column * @param {number} [page] Page number of the results to fetch, starting at 1. * @param {number} [perPage] The number of results per page (max 100). * @param {*} [options] Override http request option. * @throws {RequiredError} */ listAuditLogs(projId: string, envId: string, pdpId?: string, users?: Array, decision?: boolean, resources?: Array, tenant?: string, action?: string, timestampFrom?: number, timestampTo?: number, sortBy?: AuditLogSortKey, page?: number, perPage?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * AuditLogsApi - factory interface * @export */ export declare const AuditLogsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary Get detailed audit log * @param {string} projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\"). * @param {string} envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\"). * @param {string} logId The unique id of the audit log * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDetailedAuditLog(projId: string, envId: string, logId: string, options?: any): AxiosPromise; /** * * @summary List Audit Logs * @param {string} projId Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\"). * @param {string} envId Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\"). * @param {string} [pdpId] Filter by pdp config id * @param {Array} [users] List of user keys or emails to filter by * @param {boolean} [decision] Filter by decision result * @param {Array} [resources] Filter by resources * @param {string} [tenant] Filter by tenant * @param {string} [action] Filter by action * @param {number} [timestampFrom] Filter by timestamp from * @param {number} [timestampTo] Filter by timestamp to * @param {AuditLogSortKey} [sortBy] Sort by column * @param {number} [page] Page number of the results to fetch, starting at 1. * @param {number} [perPage] The number of results per page (max 100). * @param {*} [options] Override http request option. * @throws {RequiredError} */ listAuditLogs(projId: string, envId: string, pdpId?: string, users?: Array, decision?: boolean, resources?: Array, tenant?: string, action?: string, timestampFrom?: number, timestampTo?: number, sortBy?: AuditLogSortKey, page?: number, perPage?: number, options?: any): AxiosPromise; }; /** * Request parameters for getDetailedAuditLog operation in AuditLogsApi. * @export * @interface AuditLogsApiGetDetailedAuditLogRequest */ export interface AuditLogsApiGetDetailedAuditLogRequest { /** * Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\"). * @type {string} * @memberof AuditLogsApiGetDetailedAuditLog */ readonly projId: string; /** * Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\"). * @type {string} * @memberof AuditLogsApiGetDetailedAuditLog */ readonly envId: string; /** * The unique id of the audit log * @type {string} * @memberof AuditLogsApiGetDetailedAuditLog */ readonly logId: string; } /** * Request parameters for listAuditLogs operation in AuditLogsApi. * @export * @interface AuditLogsApiListAuditLogsRequest */ export interface AuditLogsApiListAuditLogsRequest { /** * Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\"). * @type {string} * @memberof AuditLogsApiListAuditLogs */ readonly projId: string; /** * Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\"). * @type {string} * @memberof AuditLogsApiListAuditLogs */ readonly envId: string; /** * Filter by pdp config id * @type {string} * @memberof AuditLogsApiListAuditLogs */ readonly pdpId?: string; /** * List of user keys or emails to filter by * @type {Array} * @memberof AuditLogsApiListAuditLogs */ readonly users?: Array; /** * Filter by decision result * @type {boolean} * @memberof AuditLogsApiListAuditLogs */ readonly decision?: boolean; /** * Filter by resources * @type {Array} * @memberof AuditLogsApiListAuditLogs */ readonly resources?: Array; /** * Filter by tenant * @type {string} * @memberof AuditLogsApiListAuditLogs */ readonly tenant?: string; /** * Filter by action * @type {string} * @memberof AuditLogsApiListAuditLogs */ readonly action?: string; /** * Filter by timestamp from * @type {number} * @memberof AuditLogsApiListAuditLogs */ readonly timestampFrom?: number; /** * Filter by timestamp to * @type {number} * @memberof AuditLogsApiListAuditLogs */ readonly timestampTo?: number; /** * Sort by column * @type {AuditLogSortKey} * @memberof AuditLogsApiListAuditLogs */ readonly sortBy?: AuditLogSortKey; /** * Page number of the results to fetch, starting at 1. * @type {number} * @memberof AuditLogsApiListAuditLogs */ readonly page?: number; /** * The number of results per page (max 100). * @type {number} * @memberof AuditLogsApiListAuditLogs */ readonly perPage?: number; } /** * AuditLogsApi - object-oriented interface * @export * @class AuditLogsApi * @extends {BaseAPI} */ export declare class AuditLogsApi extends BaseAPI { /** * * @summary Get detailed audit log * @param {AuditLogsApiGetDetailedAuditLogRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuditLogsApi */ getDetailedAuditLog(requestParameters: AuditLogsApiGetDetailedAuditLogRequest, options?: AxiosRequestConfig): Promise>; /** * * @summary List Audit Logs * @param {AuditLogsApiListAuditLogsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AuditLogsApi */ listAuditLogs(requestParameters: AuditLogsApiListAuditLogsRequest, options?: AxiosRequestConfig): Promise>; }