Kontaktet
`contacts.list`, `get`, `create`, `update` dhe `delete`.
Të gjitha metodat
const page = await openemail.contacts.list({ limit: 100 }) const contact = await openemail.contacts.get('[email protected]') const saved = await openemail.contacts.create({ email: '[email protected]', name: 'Grace Hopper', notes: 'Met at the compiler workshop', }) await openemail.contacts.update(saved.email, { notes: null }) await openemail.contacts.delete(saved.email) console.log(page.items.length, page.hasMore, contact.source, contact.lastSeenAt)Të parët ata që janë parë së fundmi, kurse kontaktet të cilëve nuk u është dërguar kurrë mail vijnë të fundit. source është auto kur rreshti u shkrua sepse një anëtar i dërgoi asaj adrese një mesazh nga kompozuesi i aplikacionit, që është një pohim thelbësisht i ndryshëm nga fakti se dikush e ka ruajtur. Mail-i që mbërrin nga një adresë nuk shkruan asgjë, e as një dërgim përmes këtij API-je.
Libri i adresave i përket hapësirës së punës dhe jo një personi, pra një kontakt i ruajtur nga cilido anëtar është kontakti që sheh çdo anëtar dhe çdo çelës. create e shkruan source si manual dhe e vendos kontaktin te audienca e parazgjedhur në çastin që shkruhet. Emërtoni listat tuaja te audienceIds për t'i bashkuar në të njëjtën thirrje, gjë që kërkon edhe audiences:write, ose shtojeni kontaktin më vonë me openemail.audiences.addContact.
Adresat ruhen me shkronja të vogla dhe klienti e kodon atë që jepni, kështu që [email protected] arrin te rreshti i duhur. Adresa është identiteti, prandaj update nuk mund ta ndryshojë: zhvendosja e një kontakti është një delete dhe një create.
Parametrat: contacts.list
limitnumber- Sa kontakte të kthehen për faqe: një integer nga 1 deri në 200, me parazgjedhje 50. I nënshtrohet konvertimit, pra `'100'` nga një query string është në rregull, kurse një vlerë jashtë intervalit është një 422 dhe jo një vlerë e shtrënguar brenda tij.
cursorstring- `nextCursor` nga faqja e mëparshme. Mos e ndërtoni kurrë vetë: një cursor që emërton një kontakt që nuk ekziston më është një 400 `invalid_cursor`, që do të thotë se gjendja juaj e faqosjes është e vjetruar dhe ecja duhet të rifillojë pa cursor.
sourceContactSource- `'manual'` për kontaktet që dikush i ruajti me qëllim, `'auto'` për ato që i regjistroi kompozuesi i aplikacionit. Lëreni jashtë për të gjithë librin.
Përgjigjja: ContactResource
contacts.list jep një Page<ContactResource>, pra rreshtat janë te page.items dhe ecja ndjek page.nextCursor përderisa page.hasMore është true. get, create dhe update japin secila një ContactDetailResource, të njëjtin rresht plus audiences. Libri i adresave është i pakufizuar, prandaj kjo rrugë faqoset në vend që të kthejë një array që ndalonte në heshtje te 200.
object'contact'- Gjithmonë stringu `contact`, si te rreshtat e listës ashtu edhe te `get`.
emailstring- Adresa, e ruajtur me shkronja të vogla, kështu që `[email protected]` dhe `[email protected]` janë një kontakt i vetëm, dhe çelësi që merr çdo metodë e contacts, meqë nuk ekspozohet asnjë id kontakti. Rreshtat i përkasin hapësirës së punës dhe jo anëtarit apo çelësit që i shkroi, pra çdo anëtar dhe çdo çelës i hapësirës lexon e shkruan një libër të vetëm adresash.
namestring | null- Emri i shfaqur. Null kur për adresën nuk është regjistruar kurrë ndonjë emër. Një shkrim automatik mban një të tillë vetëm kur header-i dha diçka tjetër nga vetë adresa, dhe ai nuk mund të mbishkruajë kurrë një emër që e shkroi përdoruesi.
source'manual' | 'auto' | (string & {})- `auto` do të thotë se rreshti u shkrua sepse përdoruesi i dërgoi mail asaj adrese; `manual` do të thotë se dikush e futi me dorë, një pohim thelbësisht i ndryshëm, dhe një upsert nuk e ul kurrë `manual` prapë në `auto`. Mail-i që mbërrin nga një adresë nuk shkruan fare rresht, me qëllim, pra dikush që vetëm ju ka shkruar nuk gjendet këtu; bashkimi mbetet i hapur sepse kolona është tekst i lirë me parazgjedhje `manual`.
notesstring | null- Tekst i lirë që dikush e shkroi për këtë person, në aplikacion ose përmes `update`, kurrë i gjeneruar. Null kur askush nuk ka shkruar ndonjë, dhe një null e shprehur te `update` e pastron.
lastSeenAtstring | null- ISO-8601 UTC, rifreskohet sa herë që një anëtar i dërgon asaj adrese nga kompozuesi i aplikacionit, jo kur mbërrin mail prej saj, gjë që nuk shkruan asgjë. Null te një kontakt i ruajtur përmes `create` të cilit nuk i është dërguar kurrë mail, dhe ata renditen të fundit në renditjen zbritëse sipas `lastSeenAt` që kthen kjo rrugë.
audiencesArray<ContactAudienceResource>- Vetëm te `get`, `create` dhe `update`, kurrë te rreshtat e listës. Çdo audiencë në të cilën ndodhet kontakti, si `{ id, name, builtin }`, përfshirë atë të parazgjedhur. `builtin` është `default` te audienca së cilës i përket çdo kontakt dhe null te një audiencë që e krijoi dikush, pra degëzoni mbi të dhe jo mbi emrin, të cilin mund ta ndryshojë kushdo.