SDKsSDK TypeScript

SDK TypeScript

@aivyro/sdk fala só REST pública. Recusa path com graphql.

Conteúdo oficial AivyroAlinhado ao contrato público atual

O cliente oficial vive no monorepo Aivyro como @aivyro/sdk. Use-o no workspace hoje. Publicação no registry npm é um passo separado — este guia não afirma que o pacote já está no 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
  }
}

Superfície	Métodos
aivyro.contacts	list, get, create, update, upsert, sendWhatsappTemplate
aivyro.companies	list, get, create, update, upsert
aivyro.deals / stages / members / tags	CRUD Day-1 + stages.list + members.list + tags.create
aivyro.notes / tasks	list, get, create, update
aivyro.meetings	list, get, transcript
aivyro.conversations	list, get, update, messages, reply, notes, addNote, addTag, removeTag, participants, addParticipant, removeParticipant, sendWhatsappTemplate
aivyro.conversationTags	list
aivyro.sequences	list, get, enroll
aivyro.webhooks	list, get, create, update, delete, listDeliveries, rotateSecret

contacts.update não muda email/phone. notes.create não aceita idempotency key.