import { APIResource } from "../core/resource.js";
import { APIPromise } from "../core/api-promise.js";
import { RequestOptions } from "../internal/request-options.js";
export declare class Industry extends APIResource {
    /**
     * Classify any brand into 2022 NAICS industry codes from its domain or name.
     */
    retrieveNaics(query: IndustryRetrieveNaicsParams, options?: RequestOptions): APIPromise<IndustryRetrieveNaicsResponse>;
    /**
     * Classify any brand into Standard Industrial Classification (SIC) codes from its
     * domain or name. Choose between the original SIC system (`original_sic`) or the
     * latest SIC list maintained by the SEC (`latest_sec`).
     */
    retrieveSic(query: IndustryRetrieveSicParams, options?: RequestOptions): APIPromise<IndustryRetrieveSicResponse>;
}
export interface IndustryRetrieveNaicsResponse {
    /**
     * Array of NAICS codes and titles.
     */
    codes?: Array<IndustryRetrieveNaicsResponse.Code>;
    /**
     * Domain found for the brand
     */
    domain?: string;
    /**
     * Metadata about the API key used for the request. Included in every response
     * whenever a valid API key is provided, even when the response status is not 200.
     */
    key_metadata?: IndustryRetrieveNaicsResponse.KeyMetadata;
    /**
     * Status of the response, e.g., 'ok'
     */
    status?: string;
    /**
     * Industry classification type, for naics api it will be `naics`
     */
    type?: string;
}
export declare namespace IndustryRetrieveNaicsResponse {
    interface Code {
        /**
         * NAICS code
         */
        code: string;
        /**
         * Confidence level for how well this NAICS code matches the company description
         */
        confidence: 'high' | 'medium' | 'low';
        /**
         * NAICS title
         */
        name: string;
    }
    /**
     * Metadata about the API key used for the request. Included in every response
     * whenever a valid API key is provided, even when the response status is not 200.
     */
    interface KeyMetadata {
        /**
         * The number of credits consumed by this request.
         */
        credits_consumed: number;
        /**
         * The number of credits remaining for your organization after this request.
         */
        credits_remaining: number;
    }
}
export interface IndustryRetrieveSicResponse {
    /**
     * Echoes back which SIC dataset was used to classify the brand.
     */
    classification?: 'original_sic' | 'latest_sec';
    /**
     * Array of SIC codes with confidence scores. Extra fields depend on the requested
     * classification: `original_sic` results include `majorGroup` and
     * `majorGroupName`; `latest_sec` results include `office`.
     */
    codes?: Array<IndustryRetrieveSicResponse.Code>;
    /**
     * Domain found for the brand
     */
    domain?: string;
    /**
     * Metadata about the API key used for the request. Included in every response
     * whenever a valid API key is provided, even when the response status is not 200.
     */
    key_metadata?: IndustryRetrieveSicResponse.KeyMetadata;
    /**
     * Status of the response, e.g., 'ok'
     */
    status?: string;
    /**
     * Industry classification type, for sic api it will be `sic`
     */
    type?: string;
}
export declare namespace IndustryRetrieveSicResponse {
    interface Code {
        /**
         * SIC code (4-digit).
         */
        code: string;
        /**
         * Confidence level for how well this SIC code matches the company description.
         */
        confidence: 'high' | 'medium' | 'low';
        /**
         * SIC industry title.
         */
        name: string;
        /**
         * 2-digit major group identifier (the leading two digits of the code). Only
         * present when `classification` is `original_sic`.
         */
        majorGroup?: string;
        /**
         * Description of the 2-digit major group. Only present when `classification` is
         * `original_sic`.
         */
        majorGroupName?: string;
        /**
         * SEC review office responsible for filings under this code. Only present when
         * `classification` is `latest_sec`.
         */
        office?: string;
    }
    /**
     * Metadata about the API key used for the request. Included in every response
     * whenever a valid API key is provided, even when the response status is not 200.
     */
    interface KeyMetadata {
        /**
         * The number of credits consumed by this request.
         */
        credits_consumed: number;
        /**
         * The number of credits remaining for your organization after this request.
         */
        credits_remaining: number;
    }
}
export interface IndustryRetrieveNaicsParams {
    /**
     * Brand domain or title to retrieve NAICS code for. If a valid domain is provided,
     * it will be used for classification, otherwise, we will search for the brand
     * using the provided title.
     */
    input: string;
    /**
     * Maximum number of NAICS codes to return. Must be between 1 and 10. Defaults
     * to 5.
     */
    maxResults?: number;
    /**
     * Minimum number of NAICS codes to return. Must be at least 1. Defaults to 1.
     */
    minResults?: number;
    /**
     * Optional comma-separated caller-defined tags for tracking this request. Tags are
     * recorded on the request's usage log and can be used to filter usage on the
     * dashboard usage page. Up to 20 tags, each 1-50 characters.
     */
    tags?: Array<string>;
    /**
     * Optional timeout in milliseconds for the request. If the request takes longer
     * than this value, it will be aborted with a 408 status code. Maximum allowed
     * value is 300000ms (5 minutes).
     */
    timeoutMS?: number;
}
export interface IndustryRetrieveSicParams {
    /**
     * Brand domain or title to retrieve SIC code for. If a valid domain is provided,
     * it will be used for classification, otherwise, we will search for the brand
     * using the provided title.
     */
    input: string;
    /**
     * Maximum number of SIC codes to return. Must be between 1 and 10. Defaults to 5.
     */
    maxResults?: number;
    /**
     * Minimum number of SIC codes to return. Must be at least 1. Defaults to 1.
     */
    minResults?: number;
    /**
     * Optional comma-separated caller-defined tags for tracking this request. Tags are
     * recorded on the request's usage log and can be used to filter usage on the
     * dashboard usage page. Up to 20 tags, each 1-50 characters.
     */
    tags?: Array<string>;
    /**
     * Optional timeout in milliseconds for the request. If the request takes longer
     * than this value, it will be aborted with a 408 status code. Maximum allowed
     * value is 300000ms (5 minutes).
     */
    timeoutMS?: number;
    /**
     * Which SIC dataset to classify against. `original_sic` uses the 1987 Standard
     * Industrial Classification system; `latest_sec` uses the current SIC list as
     * published by the SEC. Defaults to `original_sic`.
     */
    type?: 'original_sic' | 'latest_sec';
}
export declare namespace Industry {
    export { type IndustryRetrieveNaicsResponse as IndustryRetrieveNaicsResponse, type IndustryRetrieveSicResponse as IndustryRetrieveSicResponse, type IndustryRetrieveNaicsParams as IndustryRetrieveNaicsParams, type IndustryRetrieveSicParams as IndustryRetrieveSicParams, };
}
//# sourceMappingURL=industry.d.ts.map