> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vzaps.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Exemplos

> Exemplos executáveis do SDK TypeScript da VZaps no GitHub

O repositório oficial do SDK TypeScript inclui arquivos `.ts` executáveis que espelham os fluxos documentados neste guia.

## Repositório no GitHub

Todos os exemplos ficam na pasta [`examples/`](https://github.com/VZaps/vzaps-sdk-typescript/tree/main/examples):

**[github.com/VZaps/vzaps-sdk-typescript](https://github.com/VZaps/vzaps-sdk-typescript)**

A pasta inclui um `package.json` pequeno que instala o pacote npm publicado (`@vzaps/sdk`) e o `tsx`.

Veja o [`examples/README.md`](https://github.com/VZaps/vzaps-sdk-typescript/blob/main/examples/README.md) no repositório para a lista completa de arquivos.

## O que está incluído

| Arquivo                                     | Tema                                        |
| ------------------------------------------- | ------------------------------------------- |
| `01-auth-and-list-instances.ts`             | Autenticação e listagem de instâncias       |
| `02-create-instance.ts`                     | Criar instância                             |
| `03-instance-subscription.ts`               | Assinatura e billing                        |
| `04-session-and-pairing.ts`                 | Status da sessão, QR e código de pareamento |
| `05-configure-webhook.ts`                   | Configuração de webhook                     |
| `06-realtime-subscribe.ts`                  | Assinatura realtime via WebSocket           |
| `07-send-text-message.ts`                   | Enviar mensagem de texto                    |
| `08-send-media-and-interactive.ts`          | Mídia, botões e lista                       |
| `09-send-poll-reaction-and-chat-actions.ts` | Enquete, reação e ações de chat             |
| `10-queues.ts`                              | Filas de mensagens e operações              |
| `11-typebot-and-chatwoot.ts`                | TypeBot e Chatwoot                          |

## Opção A — só a pasta examples (recomendado)

Você **não** precisa clonar o repositório inteiro do SDK.

1. Baixe apenas a pasta [`examples/`](https://github.com/VZaps/vzaps-sdk-typescript/tree/main/examples) com **Download ZIP** no GitHub, ou execute:

```bash theme={null}
npx --yes degit VZaps/vzaps-sdk-typescript/examples vzaps-ts-examples
cd vzaps-ts-examples
```

2. Instale as dependências, edite as constantes no arquivo desejado e execute:

```bash theme={null}
npm install
npx tsx 07-send-text-message.ts
```

## Opção B — sparse checkout

```bash theme={null}
git clone --depth 1 --filter=blob:none --sparse https://github.com/VZaps/vzaps-sdk-typescript.git
cd vzaps-sdk-typescript
git sparse-checkout set examples
cd examples
npm install
npx tsx 07-send-text-message.ts
```

## Opção C — clone completo do repositório

```bash theme={null}
git clone https://github.com/VZaps/vzaps-sdk-typescript.git
cd vzaps-sdk-typescript/examples
npm install
npx tsx 07-send-text-message.ts
```

Ao desenvolver o SDK, faça build e link do pacote local primeiro. Veja o README do repositório para setup de contribuidores.

## Próximos passos

* Siga o [Guia inicial](/pt-BR/sdk/typescript/starter-guide) para um passo a passo completo.
* Veja [Mensagens](/pt-BR/sdk/typescript/messages) para todos os tipos de envio.