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

import { APIResource } from '../../core/resource';
import * as FilingAPI from './filing/filing';
import { EdgarDocument, EdgarFiling, EdgarFilingFull, Filing } from './filing/filing';
import { APIPromise } from '../../core/api-promise';
import { RequestOptions } from '../../internal/request-options';

/**
 * Direct access to SEC EDGAR filings and documents by accession number.
 */
export class Edgar extends APIResource {
  filing: FilingAPI.Filing = new FilingAPI.Filing(this._client);

  /**
   * List all available EDGAR form categories.
   *
   * Each category groups related SEC form types together (e.g. annual reports,
   * quarterly reports, insider transactions).
   */
  listFormCategories(options?: RequestOptions): APIPromise<EdgarListFormCategoriesResponse> {
    return this._client.get('/edgar/form-categories', options);
  }
}

export type EdgarListFormCategoriesResponse =
  Array<EdgarListFormCategoriesResponse.EdgarListFormCategoriesResponseItem>;

export namespace EdgarListFormCategoriesResponse {
  /**
   * An EDGAR form category with its member forms.
   */
  export interface EdgarListFormCategoriesResponseItem {
    /**
     * A description of the form category.
     */
    description: string;

    /**
     * The SEC form types in this category.
     */
    forms: Array<string>;

    /**
     * The unique key for this form category.
     */
    key: string;

    /**
     * The display title of the form category.
     */
    title: string;
  }
}

Edgar.Filing = Filing;

export declare namespace Edgar {
  export { type EdgarListFormCategoriesResponse as EdgarListFormCategoriesResponse };

  export {
    Filing as Filing,
    type EdgarDocument as EdgarDocument,
    type EdgarFiling as EdgarFiling,
    type EdgarFilingFull as EdgarFilingFull,
  };
}