import type { api_CompanyItem } from '../models/api_CompanyItem'; import type { api_CreateCompanyInput } from '../models/api_CreateCompanyInput'; import type { api_ItemFields } from '../models/api_ItemFields'; import type { api_List } from '../models/api_List'; import type { api_UpdateCompanyInput } from '../models/api_UpdateCompanyInput'; import type { company_addClientToCompanyRequest } from '../models/company_addClientToCompanyRequest'; import type { company_addClientToCompanyResponse } from '../models/company_addClientToCompanyResponse'; import type { CancelablePromise } from '../core/CancelablePromise'; export declare class CompaniesService { /** * List companies * * Lists the companies within the portal, paginated. Supports filtering by * name (case-insensitive substring) and placeholder status. * * @param limit Maximum number of companies to return * @param nextToken Pagination cursor returned by a previous call * @param name Case-insensitive substring filter on company name * @param isPlaceholder Filter by placeholder status * * @example * await assembly.listCompanies(); */ static listCompanies({ limit, nextToken, name, isPlaceholder, }: { /** * Maximum number of companies to return */ limit?: number; /** * Pagination cursor returned by a previous call */ nextToken?: string; /** * Case-insensitive substring filter on company name */ name?: string; /** * Filter by placeholder status */ isPlaceholder?: boolean; }): CancelablePromise<(api_List & { data?: Array; })>; /** * Create a company * * Creates a company. Requires a name; fallbackColor, iconImageUrl, and * customFields are optional. * * @example * await assembly.createCompany({ requestBody: ... }); */ static createCompany({ requestBody, }: { /** * Company to create */ requestBody: api_CreateCompanyInput; }): CancelablePromise; /** * Delete a company * * Deletes a company by its ID. Returns the deleted object marker. * * @param id Company ID * * @example * await assembly.deleteCompany({ id: ... }); */ static deleteCompany({ id, }: { /** * Company ID */ id: string; }): CancelablePromise; /** * Retrieve a company * * Retrieves a single company by its ID. * * @param id Company ID * * @example * await assembly.retrieveCompany({ id: ... }); */ static retrieveCompany({ id, }: { /** * Company ID */ id: string; }): CancelablePromise; /** * Update a company * * Updates a company's name and/or custom field values. A non-empty name is * required. * * @param id Company ID * * @example * await assembly.updateCompany({ id: ..., requestBody: ... }); */ static updateCompany({ id, requestBody, }: { /** * Company ID */ id: string; /** * Fields to update */ requestBody: api_UpdateCompanyInput; }): CancelablePromise; /** * Add clients to a company * * Associates one or more existing clients with a company. Set * `confirmPromotePlaceholder=true` to promote a placeholder company when * adding clients. * * @param id Company ID * @param confirmPromotePlaceholder Promote a placeholder company when adding clients * * @example * await assembly.addClientsToCompany({ id: ..., requestBody: ... }); */ static addClientsToCompany({ id, requestBody, confirmPromotePlaceholder, }: { /** * Company ID */ id: string; /** * Clients to add */ requestBody: company_addClientToCompanyRequest; /** * Promote a placeholder company when adding clients */ confirmPromotePlaceholder?: boolean; }): CancelablePromise; }