Audiencat
`audiences.list`, `get`, `create`, `update`, `delete`, `listContacts`, `addContact` dhe `removeContact`.
Çdo metodë
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)Një audiencë është një listë e emërtuar kontaktesh në këtë hapësirë pune. Çdo kontakt është në audiencën e integruar të parazgjedhur që nga çasti që ekziston, dhe builtin është ajo që e emërton atë rresht; të tjerat janë tuajat për t'i krijuar, mbushur dhe fshirë. Degëzoni mbi builtin dhe jo mbi emrin, të cilin mund ta ndryshojë kushdo.
Ky version menaxhon lista dhe nuk u dërgon atyre asgjë. Nuk ka asnjë metodë broadcast për të kërkuar, dhe vendosja e një kontakti në një audiencë është shkrim te audienca dhe jo te kontakti, prandaj audiences:write është i vetmi scope që kontrollohet.
addContact merr një adresë që është tashmë kontakt dhe refuzon një që nuk është, me 422 contact_not_found. Ruajeni atë fillimisht me openemail.contacts.create. Shtimi i dikujt dy herë përgjigjet me anëtarësimin që ekziston tashmë, duke mbartur addedAt-in e tij origjinal, prandaj thirrja është e sigurt për t'u riprovuar.
Audienca e parazgjedhur mund të riemërtohet dhe të përshkruhet si çdo tjetër, por nuk mund të fshihet dhe nuk mund të hollohet. Të dyja refuzohen me 409 audience_immutable. Fshini kontaktin kur doni të ikë kontakti.
Përgjigje: AudienceResource
list zgjidhet në një varg të thjeshtë të këtyre, me audiencën e parazgjedhur të parën dhe të tjerat më të rejat të parat, ndërsa get, create dhe update zgjidhen secila në një të vetme. listContacts zgjidhet në vend të kësaj në një varg ContactResource, pra vetë kontaktet dhe jo regjistrimet e anëtarësimit.
idstring- Identifikuesi i qëndrueshëm, `aud_` i ndjekur nga 24 karaktere hex. Emrat nuk janë unikë, prandaj ky është ai që i përket konfigurimit të ruajtur.
namestring- I pastruar nga hapësirat në shkrim, 1 deri 120 karaktere. Dy audienca mund të ndajnë një emër, sepse një audiencë adresohet me id-në e saj.
descriptionstring | null- Tekst i lirë për këdo që e lexon listën më vonë. Null kur nuk ka shkruar askush, dhe një null i shprehur te `update` e pastron.
builtin'default' | (string & {}) | null- `default` në saktësisht një rresht për hapësirë pune, audienca që mban çdo kontakt, dhe null në çdo audiencë që krijoi dikush. Bashkimi mbetet i hapur që një `builtin` i shtuar më vonë të ngushtohet në një redaktues pa e thyer tipin e publikuar.
contactCountnumber- Sa kontakte ka në audiencë, të numëruara në çastin e leximit dhe jo të ruajtura në cache. Dy lexime në të dyja anët e një `contacts.create` ndryshojnë me një.
createdAtstring- ISO-8601 UTC, kur u krijua audienca. Fikson renditjen e listës pas asaj të parazgjedhurës.
updatedAtstring- ISO-8601 UTC, i përditësuar nga një riemërtim ose një ndryshim përshkrimi. Ndryshimet e anëtarësimit nuk e prekin.