Kontakti
`contacts.list`, `get`, `create`, `update` un `delete`.
Visas metodes
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)Visnesenāk redzētie vispirms, bet kontakti, kuriem nekad nav sūtīts pasts, — beigās. source ir auto, kad rinda tika ierakstīta tāpēc, ka dalībnieks nosūtīja šai adresei ziņojumu no lietotnes rakstīšanas loga, un tas ir būtiski citāds apgalvojums nekā tas, ka kāds to ir saglabājis. Pasts, kas pienāk no adreses, neraksta neko, un tāpat arī sūtījums caur šo API.
Grāmata pieder darbvietai, nevis vienam cilvēkam, tāpēc kontakts, ko saglabājis jebkurš dalībnieks, ir kontakts, ko redz katrs dalībnieks un katra atslēga. create ieraksta source kā manual un rakstīšanas brīdī ieliek kontaktu noklusējuma auditorijā. Nosauciet savus sarakstus laukā audienceIds, lai pievienotos tiem tajā pašā izsaukumā, kam vajadzīgs arī audiences:write, vai pievienojiet kontaktu vēlāk ar openemail.audiences.addContact.
Adreses tiek glabātas mazajiem burtiem, un klients padoto adresi kodē, tāpēc [email protected] nonāk pareizajā rindā. Adrese ir identitāte, tāpēc update to mainīt nevar: kontakta pārvietošana ir delete un create.
Parametri: contacts.list
limitnumber- Cik kontaktu atgriezt vienā lapā: vesels skaitlis no 1 līdz 200, pēc noklusējuma 50. Tas tiek pārveidots, tāpēc `'100'` no vaicājuma virknes ir pieņemams, bet vērtība ārpus diapazona ir 422, nevis tiek pielāgota robežai.
cursorstring- `nextCursor` no iepriekšējās lapas. Nekad neveidojiet to pats: kursors, kas nosauc vairs neesošu kontaktu, ir 400 `invalid_cursor`, kas nozīmē, ka jūsu lappušošanas stāvoklis ir novecojis un gājiens jāsāk no jauna bez kursora.
sourceContactSource- `'manual'` kontaktiem, ko kāds saglabājis apzināti, `'auto'` tiem, ko ierakstījis lietotnes rakstīšanas logs. Izlaidiet to, lai iegūtu visu grāmatu.
Atbilde: ContactResource
contacts.list atrisinās par Page<ContactResource>, tāpēc rindas ir page.items, un gājiens seko page.nextCursor, kamēr page.hasMore ir true. get, create un update katra atrisinās par vienu ContactDetailResource — to pašu rindu plus audiences. Adrešu grāmata ir neierobežota, un tieši tāpēc šis maršruts lappušo, nevis atgriež masīvu, kas klusi apstājās pie 200.
object'contact'- Vienmēr virkne `contact`, gan saraksta rindās, gan `get` atbildē.
emailstring- Adrese, rakstot pārveidota mazajiem burtiem, tāpēc `[email protected]` un `[email protected]` ir viens kontakts, un tā ir atslēga, ko pieņem katra contacts metode, jo kontakta id netiek atklāts. Rindas pieder darbvietai, nevis dalībniekam vai atslēgai, kas tās ierakstīja, tāpēc katrs dalībnieks un katra darbvietas atslēga lasa un raksta vienu adrešu grāmatu.
namestring | null- Redzamais vārds. Null, kad adresei nekad nav reģistrēts neviens vārds. Automātisks ieraksts to nes tikai tad, ja galvene deva ko citu, nevis pašu adresi, un tas nekad nevar pārrakstīt lietotāja ierakstītu vārdu.
source'manual' | 'auto' | (string & {})- `auto` nozīmē, ka rinda ierakstīta tāpēc, ka lietotājs sūtīja pastu uz šo adresi; `manual` nozīmē, ka kāds to ievadījis ar roku, kas ir būtiski citāds apgalvojums, un upsert nekad nepazemina `manual` atpakaļ uz `auto`. Pasts, kas pienāk no adreses, apzināti neraksta nevienu rindu, tāpēc tas, kurš jums tikai rakstījis, šeit nav; savienība paliek atvērta, jo kolonna ir brīvs teksts ar noklusējumu `manual`.
notesstring | null- Brīvs teksts, ko kāds uzrakstījis par šo cilvēku lietotnē vai caur `update`, nekad nav ģenerēts. Null, kad neviens neko nav rakstījis, un skaidri norādīts null `update` izsaukumā to notīra.
lastSeenAtstring | null- ISO-8601 UTC, atjaunināts katru reizi, kad dalībnieks no lietotnes rakstīšanas loga sūta uz šo adresi, bet ne tad, kad pasts no tās pienāk, kas neraksta neko. Null kontaktam, kas saglabāts ar `create` un kuram nekad nav sūtīts pasts, un šādi kontakti dilstošajā `lastSeenAt` secībā, ko atgriež šis maršruts, ir beigās.
audiencesArray<ContactAudienceResource>- Tikai `get`, `create` un `update` atbildēs, nekad saraksta rindās. Katra auditorija, kurā kontakts ir, formā `{ id, name, builtin }`, ieskaitot noklusējuma. `builtin` ir `default` auditorijai, kurai pieder katrs kontakts, un null kāda izveidotai, tāpēc zarojiet pēc tā, nevis pēc nosaukuma, ko jebkurš var mainīt.