Interfazhost
ContactsService
Contactos del usuario (CONTACTS_READ / CONTACTS_WRITE).
Firma
export interface ContactsService {
search(args: { q: string; limit?: number; }): Promise<any>;
get(args: { contactId: string; } | { email: string; }): Promise<any>;
list(args?: { limit?: number; offset?: number; }): Promise<any>;
suggestMerges(args?: { limit?: number; }): Promise<any>;
create(args: { email: string; name?: string; notes?: string; }): Promise<any>;
update(args: { contactId: string; email?: string; name?: string; notes?: string; }): Promise<any>;
merge(args: { keepId: string; mergeIds: string[]; }): Promise<any>;
}Miembros (7)
| Nombre | Tipo | Descripción |
|---|---|---|
| search | search(args: { q: string; limit?: number; }): Promise<any> | CONTACTS_READ. q 1..100; limit 1..50 (def. 20). |
| get | get(args: { contactId: string; } | { email: string; }): Promise<any> | CONTACTS_READ. Exactamente uno de contactId o email. |
| list | list(args?: { limit?: number; offset?: number; }): Promise<any> | CONTACTS_READ. limit 1..100 (def. 50), offset >= 0. |
| suggestMerges | suggestMerges(args?: { limit?: number; }): Promise<any> | CONTACTS_READ. limit 1..50 (def. 20). |
| create | create(args: { email: string; name?: string; notes?: string; }): Promise<any> | CONTACTS_WRITE |
| update | update(args: { contactId: string; email?: string; name?: string; notes?: string; }): Promise<any> | CONTACTS_WRITE. Al menos un campo ademas de contactId. |
| merge | merge(args: { keepId: string; mergeIds: string[]; }): Promise<any> | CONTACTS_WRITE. mergeIds 1..10 (sin keepId). |
Ejemplos
const found = await ctx.services.contacts.search({ q: "ana", limit: 5 });Usado en / Referenciado por
Fuente: bloomx-extensions/_shared/sdk/ctx.d.ts:413 · ctx.d.ts