/** * 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 { APIHistoryEventFullRead } from '../types'; import { PaginatedResultAPIHistoryEventRead } from '../types'; /** * APIHistoryApi - axios parameter creator * @export */ export declare const APIHistoryApiAxiosParamCreator: (configuration?: Configuration) => { /** * Returns full information, including request and response bodies, for one event. * @summary Get Api Event * @param {string} eventId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getApiEvent: (eventId: string, options?: AxiosRequestConfig) => Promise; /** * * @summary Get Request Body * @param {string} eventId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRequestBody: (eventId: string, options?: AxiosRequestConfig) => Promise; /** * * @summary Get Response Body * @param {string} eventId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getResponseBody: (eventId: string, options?: AxiosRequestConfig) => Promise; /** * Fetches all API History events for given filters. * @summary List Api Events * @param {Array} [method] HTTP methods to include in search * @param {Array} [path] API paths to include in search * @param {boolean} [success] Filter by API request success/failure * @param {Array} [statusCode] HTTP status codes to include in search * @param {Array} [clientIp] IPs of clients to include in search * @param {Array} [actorType] Actor type to search (member, user, api_key) * @param {Array} [actorId] Actor ID to search * @param {string} [actorDisplayName] Actor display name to search * @param {Array} [projectId] Projects to include in search * @param {Array} [envId] Environments to include in search * @param {number} [timestampFrom] Retrieve only events after this timestamp (seconds since epoch) * @param {number} [timestampUntil] Retrieve only events before this timestamp (seconds since epoch) * @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} */ listApiEvents: (method?: Array, path?: Array, success?: boolean, statusCode?: Array, clientIp?: Array, actorType?: Array, actorId?: Array, actorDisplayName?: string, projectId?: Array, envId?: Array, timestampFrom?: number, timestampUntil?: number, page?: number, perPage?: number, options?: AxiosRequestConfig) => Promise; }; /** * APIHistoryApi - functional programming interface * @export */ export declare const APIHistoryApiFp: (configuration?: Configuration) => { /** * Returns full information, including request and response bodies, for one event. * @summary Get Api Event * @param {string} eventId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getApiEvent(eventId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Get Request Body * @param {string} eventId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRequestBody(eventId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Get Response Body * @param {string} eventId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getResponseBody(eventId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetches all API History events for given filters. * @summary List Api Events * @param {Array} [method] HTTP methods to include in search * @param {Array} [path] API paths to include in search * @param {boolean} [success] Filter by API request success/failure * @param {Array} [statusCode] HTTP status codes to include in search * @param {Array} [clientIp] IPs of clients to include in search * @param {Array} [actorType] Actor type to search (member, user, api_key) * @param {Array} [actorId] Actor ID to search * @param {string} [actorDisplayName] Actor display name to search * @param {Array} [projectId] Projects to include in search * @param {Array} [envId] Environments to include in search * @param {number} [timestampFrom] Retrieve only events after this timestamp (seconds since epoch) * @param {number} [timestampUntil] Retrieve only events before this timestamp (seconds since epoch) * @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} */ listApiEvents(method?: Array, path?: Array, success?: boolean, statusCode?: Array, clientIp?: Array, actorType?: Array, actorId?: Array, actorDisplayName?: string, projectId?: Array, envId?: Array, timestampFrom?: number, timestampUntil?: number, page?: number, perPage?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * APIHistoryApi - factory interface * @export */ export declare const APIHistoryApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Returns full information, including request and response bodies, for one event. * @summary Get Api Event * @param {string} eventId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getApiEvent(eventId: string, options?: any): AxiosPromise; /** * * @summary Get Request Body * @param {string} eventId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getRequestBody(eventId: string, options?: any): AxiosPromise; /** * * @summary Get Response Body * @param {string} eventId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getResponseBody(eventId: string, options?: any): AxiosPromise; /** * Fetches all API History events for given filters. * @summary List Api Events * @param {Array} [method] HTTP methods to include in search * @param {Array} [path] API paths to include in search * @param {boolean} [success] Filter by API request success/failure * @param {Array} [statusCode] HTTP status codes to include in search * @param {Array} [clientIp] IPs of clients to include in search * @param {Array} [actorType] Actor type to search (member, user, api_key) * @param {Array} [actorId] Actor ID to search * @param {string} [actorDisplayName] Actor display name to search * @param {Array} [projectId] Projects to include in search * @param {Array} [envId] Environments to include in search * @param {number} [timestampFrom] Retrieve only events after this timestamp (seconds since epoch) * @param {number} [timestampUntil] Retrieve only events before this timestamp (seconds since epoch) * @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} */ listApiEvents(method?: Array, path?: Array, success?: boolean, statusCode?: Array, clientIp?: Array, actorType?: Array, actorId?: Array, actorDisplayName?: string, projectId?: Array, envId?: Array, timestampFrom?: number, timestampUntil?: number, page?: number, perPage?: number, options?: any): AxiosPromise; }; /** * Request parameters for getApiEvent operation in APIHistoryApi. * @export * @interface APIHistoryApiGetApiEventRequest */ export interface APIHistoryApiGetApiEventRequest { /** * * @type {string} * @memberof APIHistoryApiGetApiEvent */ readonly eventId: string; } /** * Request parameters for getRequestBody operation in APIHistoryApi. * @export * @interface APIHistoryApiGetRequestBodyRequest */ export interface APIHistoryApiGetRequestBodyRequest { /** * * @type {string} * @memberof APIHistoryApiGetRequestBody */ readonly eventId: string; } /** * Request parameters for getResponseBody operation in APIHistoryApi. * @export * @interface APIHistoryApiGetResponseBodyRequest */ export interface APIHistoryApiGetResponseBodyRequest { /** * * @type {string} * @memberof APIHistoryApiGetResponseBody */ readonly eventId: string; } /** * Request parameters for listApiEvents operation in APIHistoryApi. * @export * @interface APIHistoryApiListApiEventsRequest */ export interface APIHistoryApiListApiEventsRequest { /** * HTTP methods to include in search * @type {Array} * @memberof APIHistoryApiListApiEvents */ readonly method?: Array; /** * API paths to include in search * @type {Array} * @memberof APIHistoryApiListApiEvents */ readonly path?: Array; /** * Filter by API request success/failure * @type {boolean} * @memberof APIHistoryApiListApiEvents */ readonly success?: boolean; /** * HTTP status codes to include in search * @type {Array} * @memberof APIHistoryApiListApiEvents */ readonly statusCode?: Array; /** * IPs of clients to include in search * @type {Array} * @memberof APIHistoryApiListApiEvents */ readonly clientIp?: Array; /** * Actor type to search (member, user, api_key) * @type {Array} * @memberof APIHistoryApiListApiEvents */ readonly actorType?: Array; /** * Actor ID to search * @type {Array} * @memberof APIHistoryApiListApiEvents */ readonly actorId?: Array; /** * Actor display name to search * @type {string} * @memberof APIHistoryApiListApiEvents */ readonly actorDisplayName?: string; /** * Projects to include in search * @type {Array} * @memberof APIHistoryApiListApiEvents */ readonly projectId?: Array; /** * Environments to include in search * @type {Array} * @memberof APIHistoryApiListApiEvents */ readonly envId?: Array; /** * Retrieve only events after this timestamp (seconds since epoch) * @type {number} * @memberof APIHistoryApiListApiEvents */ readonly timestampFrom?: number; /** * Retrieve only events before this timestamp (seconds since epoch) * @type {number} * @memberof APIHistoryApiListApiEvents */ readonly timestampUntil?: number; /** * Page number of the results to fetch, starting at 1. * @type {number} * @memberof APIHistoryApiListApiEvents */ readonly page?: number; /** * The number of results per page (max 100). * @type {number} * @memberof APIHistoryApiListApiEvents */ readonly perPage?: number; } /** * APIHistoryApi - object-oriented interface * @export * @class APIHistoryApi * @extends {BaseAPI} */ export declare class APIHistoryApi extends BaseAPI { /** * Returns full information, including request and response bodies, for one event. * @summary Get Api Event * @param {APIHistoryApiGetApiEventRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof APIHistoryApi */ getApiEvent(requestParameters: APIHistoryApiGetApiEventRequest, options?: AxiosRequestConfig): Promise>; /** * * @summary Get Request Body * @param {APIHistoryApiGetRequestBodyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof APIHistoryApi */ getRequestBody(requestParameters: APIHistoryApiGetRequestBodyRequest, options?: AxiosRequestConfig): Promise>; /** * * @summary Get Response Body * @param {APIHistoryApiGetResponseBodyRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof APIHistoryApi */ getResponseBody(requestParameters: APIHistoryApiGetResponseBodyRequest, options?: AxiosRequestConfig): Promise>; /** * Fetches all API History events for given filters. * @summary List Api Events * @param {APIHistoryApiListApiEventsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof APIHistoryApi */ listApiEvents(requestParameters?: APIHistoryApiListApiEventsRequest, options?: AxiosRequestConfig): Promise>; }