// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

import { APIResource } from '../../core/resource';
import * as Shared from '../shared';
import { AuditLogsV4PagePaginationArray } from '../shared';
import { PagePromise, V4PagePaginationArray, type V4PagePaginationArrayParams } from '../../core/pagination';
import { RequestOptions } from '../../internal/request-options';

export class BaseAuditLogs extends APIResource {
  static override readonly _key: readonly ['user', 'auditLogs'] = Object.freeze([
    'user',
    'auditLogs',
  ] as const);

  /**
   * Gets a list of audit logs for a user account. Can be filtered by who made the
   * change, on which zone, and the timeframe of the change.
   *
   * @example
   * ```ts
   * // Automatically fetches more pages as needed.
   * for await (const auditLog of client.user.auditLogs.list()) {
   *   // ...
   * }
   * ```
   */
  list(
    query: AuditLogListParams | null | undefined = {},
    options?: RequestOptions,
  ): PagePromise<AuditLogsV4PagePaginationArray, Shared.AuditLog> {
    return this._client.getAPIList('/user/audit_logs', V4PagePaginationArray<Shared.AuditLog>, {
      query,
      ...options,
    });
  }
}
export class AuditLogs extends BaseAuditLogs {}

export interface AuditLogListParams extends V4PagePaginationArrayParams {
  /**
   * Finds a specific log by its ID.
   */
  id?: string;

  action?: AuditLogListParams.Action;

  actor?: AuditLogListParams.Actor;

  /**
   * Limits the returned results to logs older than the specified date. A `full-date`
   * that conforms to RFC3339.
   */
  before?: (string & {}) | (string & {});

  /**
   * Changes the direction of the chronological sorting.
   */
  direction?: 'desc' | 'asc';

  /**
   * Indicates that this request is an export of logs in CSV format.
   */
  export?: boolean;

  /**
   * Indicates whether or not to hide user level audit logs.
   */
  hide_user_logs?: boolean;

  /**
   * Limits the returned results to logs newer than the specified date. A `full-date`
   * that conforms to RFC3339.
   */
  since?: (string & {}) | (string & {});

  zone?: AuditLogListParams.Zone;
}

export namespace AuditLogListParams {
  export interface Action {
    /**
     * Filters by the action type.
     */
    type?: string;
  }

  export interface Actor {
    /**
     * Filters by the email address of the actor that made the change.
     */
    email?: string;

    /**
     * Filters by the IP address of the request that made the change by specific IP
     * address or valid CIDR Range.
     */
    ip?: string;
  }

  export interface Zone {
    /**
     * Filters by the name of the zone associated to the change.
     */
    name?: string;
  }
}

export declare namespace AuditLogs {
  export { type AuditLogListParams as AuditLogListParams };
}

export { type AuditLogsV4PagePaginationArray };