import { APIResource } from "../core/resource.js";
import * as LegalEntitiesAPI from "./legal-entities.js";
import * as Shared from "./shared.js";
import { PageCursorURL, PagePromise } from "../core/pagination.js";
import { RequestOptions } from "../internal/request-options.js";
/**
 * Companies on Rippling
 */
export declare class Companies extends APIResource {
    /**
     * A list of companies.
     *
     * - Requires: `API Tier 1`
     * - Expandable fields: `parent_legal_entity`, `legal_entities`
     * - Sortable fields: `id`, `created_at`, `updated_at`
     *
     * @example HTTP
     * Representative request and response shapes.
     * ```
     * GET /companies/?expand=expand&order_by=order_by&limit=50&cursor=cursor HTTP/1.1
     * Host: rest.ripplingapis.com
     * Accept: application/json
     * Rippling-Api-Version: 2024-08-01
     *
     * HTTP/1.1 200 OK
     * Content-Type: application/json
     *
     * {
     *   "__meta": {
     *     "redacted_fields": [
     *       {
     *         "name": "date_of_birth",
     *         "reason": "Insufficient entitlements"
     *       }
     *     ]
     *   },
     *   "results": [
     *     {
     *       "id": "string",
     *       "created_at": "string",
     *       "updated_at": "string",
     *       "parent_legal_entity_id": "string",
     *       "parent_legal_entity": {
     *         "id": "string",
     *         "created_at": "string",
     *         "updated_at": "string",
     *         "tax_identifier": "string",
     *         "country": {},
     *         "legal_name": "string",
     *         "entity_level": "PARENT",
     *         "registration_date": "string",
     *         "mailing_address": {},
     *         "physical_address": {},
     *         "parent_id": "string",
     *         "parent": {},
     *         "management_type": "PEO",
     *         "company_id": "string",
     *         "company": {}
     *       },
     *       "legal_entities_id": [
     *         "string"
     *       ],
     *       "legal_entities": [
     *         {}
     *       ],
     *       "physical_address": {
     *         "type": "HOME",
     *         "formatted": "string",
     *         "street_address": "string",
     *         "locality": "string",
     *         "region": "string",
     *         "postal_code": "string",
     *         "country": "AF"
     *       },
     *       "primary_email": "string",
     *       "legal_name": "string",
     *       "doing_business_as_name": "string",
     *       "phone": "string",
     *       "name": "string"
     *     }
     *   ],
     *   "next_link": "string"
     * }
     * ```
     */
    list(query?: CompanyListParams | null | undefined, options?: RequestOptions): PagePromise<CompaniesPageCursorURL, Company>;
}
export type CompaniesPageCursorURL = PageCursorURL<Company>;
export interface Company {
    /**
     * Identifier field
     */
    id: string;
    /**
     * Record creation date
     */
    created_at: string;
    /**
     * A list of the company's entities.
     *
     * Expandable field
     */
    legal_entities: Array<LegalEntitiesAPI.LegalEntity>;
    /**
     * A list of the company's entities.
     */
    legal_entities_id: Array<string>;
    /**
     * The name of the company.
     */
    name: string;
    /**
     * Record update date
     */
    updated_at: string;
    /**
     * The doing business as name for the company.
     */
    doing_business_as_name?: string;
    /**
     * The legal name of the company.
     */
    legal_name?: string;
    /**
     * The company's ultimate holding entity.
     *
     * Expandable field
     */
    parent_legal_entity?: LegalEntitiesAPI.LegalEntity;
    /**
     * The company's ultimate holding entity.
     */
    parent_legal_entity_id?: string;
    /**
     * The phone number for the company.
     */
    phone?: string;
    /**
     * The physical address of the holding entity.
     */
    physical_address?: Shared.Address;
    /**
     * The email address used when registering this company.
     */
    primary_email?: string;
}
export interface CompanyListParams {
    cursor?: string;
    expand?: string;
    /**
     * The maximum number of results to return. Defaults to 50. Maximum is 100.
     */
    limit?: number;
    order_by?: string;
}
export declare namespace Companies {
    export { type Company as Company, type CompaniesPageCursorURL as CompaniesPageCursorURL, type CompanyListParams as CompanyListParams, };
}
//# sourceMappingURL=companies.d.ts.map