Audiências
`audiences.list`, `get`, `create`, `update`, `delete`, `listContacts`, `addContact` e `removeContact`.
Todos os métodos
const audiences = await openemail.audiences.list()const everyone = audiences.find((audience) => audience.builtin === 'default') const list = await openemail.audiences.create({ name: 'Product updates', description: 'Customers who asked to hear about releases',}) await openemail.contacts.create({ email: '[email protected]', name: 'Grace Hopper' })await openemail.audiences.addContact(list.id, { email: '[email protected]' }) const members = await openemail.audiences.listContacts(list.id, { limit: 200 }) await openemail.audiences.update(list.id, { name: 'Release notes' })await openemail.audiences.removeContact(list.id, '[email protected]')await openemail.audiences.delete(list.id) console.log(everyone?.contactCount, members.length)Uma audiência é uma lista de contactos com nome neste espaço de trabalho. Todos os contactos estão na audiência predefinida incorporada desde o momento em que existem, e builtin é o que identifica essa linha; as restantes são suas para criar, preencher e apagar. Ramifique com base em builtin e não no nome, que qualquer pessoa pode alterar.
Esta versão gere listas e não lhes envia nada. Não há nenhum método de difusão para procurar, e colocar um contacto numa audiência é uma escrita na audiência e não no contacto, pelo que audiences:write é o único âmbito verificado.
addContact aceita um endereço que já é um contacto e recusa um que não o seja, com 422 contact_not_found. Guarde-o primeiro com openemail.contacts.create. Adicionar alguém duas vezes responde com a associação que já existe, com o seu addedAt original, pelo que é seguro repetir a chamada.
A audiência predefinida pode ser renomeada e descrita como qualquer outra, mas não pode ser eliminada nem perder membros. Ambas as operações são recusadas com 409 audience_immutable. Elimine o contacto quando a intenção é que o contacto desapareça.
Resposta: AudienceResource
list resolve para um array simples destes objetos, com a audiência predefinida primeiro e as restantes da mais recente para a mais antiga, e get, create e update resolvem cada um para um só. listContacts resolve, em vez disso, para um array de ContactResource: os próprios contactos, e não registos de pertença.
idstring- O identificador duradouro: `aud_` seguido de 24 caracteres hexadecimais. Os nomes não são únicos, pelo que é este o valor a guardar na configuração armazenada.
namestring- Os espaços nas extremidades são removidos na escrita; de 1 a 120 caracteres. Duas audiências podem ter o mesmo nome, porque uma audiência é referenciada pelo seu id.
descriptionstring | null- Texto livre para quem ler a lista mais tarde. É null quando ninguém escreveu nada, e um null explícito em `update` limpa-o.
builtin'default' | (string & {}) | null- `default` em exatamente uma linha por espaço de trabalho, a audiência que contém todos os contactos, e null em todas as audiências criadas por alguém. A união permanece aberta para que um valor integrado adicionado mais tarde seja reconhecido num editor sem quebrar o tipo publicado.
contactCountnumber- Quantos contactos existem na audiência, contados no momento da leitura em vez de guardados em cache. Duas leituras, uma antes e outra depois de um `contacts.create`, diferem em um.
createdAtstring- ISO-8601 UTC, quando a audiência foi criada. Determina a ordem da lista a seguir à predefinida.
updatedAtstring- ISO-8601 UTC, atualizado por uma mudança de nome ou de descrição. As alterações de membros não o afetam.