import { ClientSDK, RequestOptions } from "../lib/sdks.js";
import * as operations from "./models/operations/index.js";
import * as shared from "./models/shared/index.js";
export declare class Companies extends ClientSDK {
    /**
     * Create company
     *
     * @remarks
     * Use the *Create company* endpoint to create a new [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) that represents your customer in Codat.
     *
     * A [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) represents a business sharing access to their data.
     * Each company can have multiple [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
     *
     * If forbidden characters (see `name` pattern) are present in the request, a company will be created with the forbidden characters removed. For example, `Company (Codat[1])` with be created as `Company Codat1`.
     */
    create(request?: shared.CompanyRequestBody | undefined, options?: RequestOptions): Promise<shared.Company>;
    /**
     * List companies
     *
     * @remarks
     * The *List companies* endpoint returns a list of [companies](https://docs.codat.io/bank-feeds-api#/schemas/Company) associated to your instances.
     *
     * A [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) represents a business sharing access to their data.
     * Each company can have multiple [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
     *
     * ## Filter by tags
     *
     * The *List companies* endpoint supports the filtering of companies using [tags](https://docs.codat.io/using-the-api/managing-companies#add-metadata-to-a-company). It supports the following operators with [Codat’s query language](https://docs.codat.io/using-the-api/querying):
     *
     * - equals (`=`)
     * - not equals (`!=`)
     * - contains (`~`)
     *
     * For example, you can use the querying to filter companies tagged with a specific foreign key, region, or owning team:
     * - Foreign key: `uid = {yourCustomerId}`
     * - Region: `region != uk`
     * - Owning team and region: `region = uk && owningTeam = invoice-finance`
     */
    list(request?: operations.ListCompaniesRequest | undefined, options?: RequestOptions): Promise<shared.Companies>;
    /**
     * Get company
     *
     * @remarks
     * The *Get company* endpoint returns a single company for a given `companyId`.
     *
     * A [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) represents a business sharing access to their data.
     * Each company can have multiple [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
     */
    get(request: operations.GetCompanyRequest, options?: RequestOptions): Promise<shared.Company>;
    /**
     * Delete a company
     *
     * @remarks
     * The *Delete company* endpoint permanently deletes a [company](https://docs.codat.io/bank-feeds-api#/schemas/Company), its [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) and any cached data. This operation is irreversible.
     *
     * A [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) represents a business sharing access to their data.
     * Each company can have multiple [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
     */
    delete(request: operations.DeleteCompanyRequest, options?: RequestOptions): Promise<void>;
    /**
     * Replace company
     *
     * @remarks
     * Use the *Replace company* endpoint to replace the existing name, description, and tags of the company. Calling the endpoint will replace existing values even if new values haven't been defined in the payload.
     *
     * A [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) represents a business sharing access to their data.
     * Each company can have multiple [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.
     */
    replace(request: operations.ReplaceCompanyRequest, options?: RequestOptions): Promise<shared.Company>;
    /**
     * Update company
     *
     * @remarks
     * Use the *Update company* endpoint to update the name, description, or tags of the company.
     *
     * The *Update company* endpoint doesn't have any required fields. If any of the fields provided are `null` or not provided, they won't be included in the update.
     *
     * A [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) represents a business sharing access to their data.
     */
    update(request: operations.UpdateCompanyRequest, options?: RequestOptions): Promise<shared.Company>;
    /**
     * Get company access token
     *
     * @remarks
     * Use the _Get company access token_ endpoint to return an access token for the specified company ID. The token is valid for one day.
     *
     * The token is required by Codat's embeddable UIs (such as [Connections SDK](https://docs.codat.io/auth-flow/optimize/connection-management) and [Link SDK](https://docs.codat.io/auth-flow/authorize-embedded-link)) to verify the identity of the user and improve the reliability of data provided by them.
     */
    getAccessToken(request: operations.GetCompanyAccessTokenRequest, options?: RequestOptions): Promise<shared.CompanyAccessToken>;
}
//# sourceMappingURL=companies.d.ts.map