/** * INM (Inmuebles - Real Estate Sale/Purchase) Clients Resource * * Extends MexClientsResource with INM-specific behavior. * INM clients support Individual, Company, and Trust discriminated union types. * Returns MexINMClient models. */ import type { AtomicBatchResult, ClientRelationshipType, ClientSort, CreateBankAccountInput, CreateClientInput, CreateContactMethodInput, CreateINMClientInput, CreateMexAddressInput, INMClientFilter, INMClientSort, LinkedClient as LinkedClientInput, ListOptions, PaginatedResponse, PartialBatchResult, SyncCreateDocumentInput, SyncItem, SyncResult, SyncUpdateDocumentInput, UpdateBankAccountInput, UpdateClientInput, UpdateContactMethodInput, UpdateINMClientInput, UpdateMexAddressInput, UpsertINMClientInput, UpsertResult } from "@artu-ai/shared"; import { type ClientData, ContactMethod, Document, LinkedClient, MexAddress, MexBankAccount, MexINMClient } from "../../../../models"; import { type ClientIncludeMap } from "../../../clients"; import type { RelatedPartyParent, RelatedPartySubresource } from "../../../related-parties/base"; import { AVClientsResource } from "../clients"; /** * INM (Inmuebles - Real Estate Sale/Purchase) scoped clients resource. * * @example * ```typescript * const inmSdk = new ComplianceSDK({ * apiKey, * environment: "test", * scope: "MX:AV:INM", * }); * * const client = await inmSdk.clients.create({ * type: ClientType.Person, * name: "Juan GarcĂ­a", * rfc: "GAJL850101ABC", * }); * * // Returns MexINMClient * ``` */ export declare class INMClientsResource extends AVClientsResource { readonly legalRepresentatives: RelatedPartySubresource; readonly controllingBeneficiaries: RelatedPartySubresource; protected relatedPartyParent(): RelatedPartyParent; create(data: CreateINMClientInput): Promise; retrieve(id: string, options?: { include?: ClientIncludeMap; crossScope?: boolean; }): Promise; retrieveByExternalId(externalId: string, opts?: { crossScope?: boolean; }): Promise; update(id: string, data: UpdateINMClientInput): Promise; list(options?: ListOptions & { includePrimaryContacts?: boolean; includeNonPrimary?: boolean; crossScope?: boolean; }): Promise>; iterate(options?: { filter?: INMClientFilter; sort?: INMClientSort; pageSize?: number; crossScope?: boolean; }): AsyncGenerator; count(filter?: INMClientFilter, options?: { includeNonPrimary?: boolean; crossScope?: boolean; }): Promise; createMany(clients: CreateINMClientInput[], options?: { atomic?: true; }): Promise>; createMany(clients: CreateINMClientInput[], options: { atomic: false; }): Promise>; updateMany(updates: { id: string; data: UpdateINMClientInput; }[], options?: { atomic?: true; }): Promise>; updateMany(updates: { id: string; data: UpdateINMClientInput; }[], options: { atomic: false; }): Promise>; upsertByExternalId(data: UpsertINMClientInput): Promise>; upsertManyByExternalId(clients: UpsertINMClientInput[], options?: { atomic?: true; }): Promise>>; upsertManyByExternalId(clients: UpsertINMClientInput[], options: { atomic: false; }): Promise>>; linkClient(parentClientId: string, childClientId: string, relationshipType: ClientRelationshipType, metadata?: Record): Promise; unlinkClient(parentClientId: string, childClientId: string, relationshipType: ClientRelationshipType): Promise; listLinkedClients(parentClientId: string, relationshipType?: ClientRelationshipType): Promise; setLinkedClients(parentClientId: string, linkedClients: LinkedClientInput[]): Promise; syncAll(clientId: undefined, data: { client: CreateINMClientInput; addresses?: SyncItem[]; contactMethods?: SyncItem[]; bankAccounts?: SyncItem[]; documents?: SyncItem[]; linkedClients?: LinkedClientInput[]; }, options?: { replaceMode?: boolean; }): Promise<{ client: MexINMClient; addresses: SyncResult; contactMethods: SyncResult; bankAccounts: SyncResult; documents: SyncResult; }>; syncAll(clientId: string, data: { client?: UpdateINMClientInput; addresses?: SyncItem[]; contactMethods?: SyncItem[]; bankAccounts?: SyncItem[]; documents?: SyncItem[]; linkedClients?: LinkedClientInput[]; }, options: { replaceMode: true; }): Promise<{ client: MexINMClient; addresses: SyncResult; contactMethods: SyncResult; bankAccounts: SyncResult; documents: SyncResult; }>; syncAll(clientId: string, data: { client?: UpdateINMClientInput; addresses?: SyncItem[]; contactMethods?: SyncItem[]; bankAccounts?: SyncItem[]; documents?: SyncItem[]; linkedClients?: LinkedClientInput[]; }, options?: { replaceMode?: boolean; }): Promise<{ client: MexINMClient; addresses: SyncResult; contactMethods: SyncResult; bankAccounts: SyncResult; documents: SyncResult; }>; protected transformToNested(data: CreateINMClientInput): CreateClientInput; protected transformUpdateToNested(data: UpdateINMClientInput): UpdateClientInput; protected instantiate(data: ClientData): MexINMClient; /** Materializes a raw payload into a {@link MexINMClient} (return type narrowed via the `instantiate` override). */ materialize(data: ClientData): MexINMClient; protected applyScopeToSort(sort?: INMClientSort): ClientSort | undefined; }