shared.ts

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

/**
 * An error message.
 */
export interface ErrorObject {
  /**
   * Human-readable message.
   */
  message: string;

  /**
   * Reference ID for the error.
   */
  ref_id: string;

  /**
   * Optional detail supporting the error.
   */
  detail?: { [key: string]: unknown } | null;
}

/**
 * Response object used for non-200 status codes.
 */
export interface ErrorResponse {
  /**
   * Error.
   */
  error: ErrorObject;

  /**
   * Always 'error'.
   */
  type: 'error';
}

/**
 * Source policy for web search results.
 *
 * This policy governs which sources are allowed/disallowed in results.
 */
export interface SourcePolicy {
  /**
   * Optional start date for filtering search results. Results will be limited to
   * content published on or after this date. Provided as an RFC 3339 date string
   * (YYYY-MM-DD).
   */
  after_date?: string | null;

  /**
   * List of domains to exclude from results. If specified, sources from these
   * domains will be excluded. Accepts plain domains (e.g., example.com,
   * subdomain.example.gov) or bare domain extension starting with a period (e.g.,
   * .gov, .edu, .co.uk). The combined number of domains in include_domains and
   * exclude_domains cannot exceed 200.
   */
  exclude_domains?: Array<string>;

  /**
   * List of domains to restrict the results to. If specified, only sources from
   * these domains will be included. Accepts plain domains (e.g., example.com,
   * subdomain.example.gov) or bare domain extension starting with a period (e.g.,
   * .gov, .edu, .co.uk). The combined number of domains in include_domains and
   * exclude_domains cannot exceed 200.
   */
  include_domains?: Array<string>;
}

/**
 * Human-readable message for a task.
 */
export interface Warning {
  /**
   * Human-readable message.
   */
  message: string;

  /**
   * Type of warning. Note that adding new warning types is considered a
   * backward-compatible change.
   */
  type: 'spec_validation_warning' | 'input_validation_warning' | 'warning';

  /**
   * Optional detail supporting the warning.
   */
  detail?: { [key: string]: unknown } | null;
}