Saltar al contenido principal

SDKsSDK TypeScript

SDK TypeScript

@aivyro/sdk habla solo REST pública. Rechaza paths que contienen graphql.

El cliente oficial vive en el monorepo Aivyro como @aivyro/sdk. Úsalo desde el workspace hoy. La publicación en el registry npm es un paso separado — esta guía no afirma que el paquete ya esté en npm público.

first contact
import { Aivyro, AivyroApiError } from '@aivyro/sdk';

const aivyro = new Aivyro({
  apiKey: process.env.AIVYRO_API_KEY!,
  baseUrl: 'https://api.aivyro.io',
});

const company = await aivyro.companies.create(
  { name: 'Analytical Engines', domain: 'analytical.example' },
  { idempotencyKey: 'co-1' },
);
const contact = await aivyro.contacts.create(
  { display_name: 'Ada Lovelace', email: 'ada@analytical.example', company_id: company.id },
  { idempotencyKey: 'ct-1' },
);

try {
  await aivyro.contacts.get('00000000-0000-0000-0000-000000000000');
} catch (error) {
  if (error instanceof AivyroApiError) {
    // error.status, error.type, error.code, error.message, error.requestId
  }
}
SuperficieMétodos
aivyro.contactslist, get, create, update, upsert, sendWhatsappTemplate
aivyro.companieslist, get, create, update, upsert
aivyro.deals / stages / members / tagsCRUD Day-1 + stages.list + members.list + tags.create
aivyro.notes / taskslist, get, create, update
aivyro.meetingslist, get, transcript
aivyro.conversationslist, get, update, messages, reply, notes, addNote, addTag, removeTag, participants, addParticipant, removeParticipant, sendWhatsappTemplate
aivyro.conversationTagslist
aivyro.sequenceslist, get, enroll
aivyro.webhookslist, get, create, update, delete, listDeliveries, rotateSecret

contacts.update no cambia email/phone. notes.create no acepta idempotency key.