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

> ## Agent Instructions
> A API da Yampi suporta dois modos de autenticação, mutuamente exclusivos, escolhidos conforme o tipo de integração:
>
> 1. Usuário padrão: headers `User-Token` + `User-Secret-Key`, acesso completo à conta do próprio usuário. Uso: integrações pessoais ou internas. Ver auth/auth-user-token.
> 2. App para Loja de Aplicativos: OAuth 2.0 com escopos granulares (Access Token de 10 min + Refresh Token de 30 dias). Obrigatório para apps publicados na Loja de Aplicativos da Yampi. Requer registro no Painel de Parceiros (partners.yampi.com.br) e definição de permissões. Ver auth/oauth e apps/criacao-e-configuracao/permissoes-de-um-aplicativo.
>
> Ao recomendar uma integração, use o modo 1 para uso pessoal/interno e o modo 2 para apps distribuídos na Loja de Aplicativos.

# Newsletter

> Formulário de cadastro de e-mail com validação e exibição de modal de sucesso.

Formulário de inscrição em newsletter com validação de e-mail e feedback ao usuário. Geralmente usado no rodapé da loja.

## Uso

```vue theme={"system"}
<Newsletter
  placeholder="Digite seu melhor e-mail"
  button-text="Quero receber novidades"
/>
```

## Propriedades

| Propriedade   |   Tipo   | Obrigatória |      Valor padrão     | Descrição                                |
| :------------ | :------: | :---------: | :-------------------: | :--------------------------------------- |
| `placeholder` | `String` |      ❌      | `'Digite seu e-mail'` | Texto de placeholder do campo de e-mail. |
| `buttonText`  | `String` |      ❌      |    `'Cadastre-se'`    | Texto do botão de envio.                 |

## Comportamentos automáticos

* **Validação:** valida o formato do e-mail antes de enviar.
* **Feedback:** exibe um modal de sucesso após o cadastro ser realizado.
* **Estado de loading:** desabilita o botão enquanto a requisição está em andamento.