Çelësat API
`keys.list`, `list_all`, `iterate`, `get`, `create`, `update`, `delete`, `rotate` dhe `revoke`, si dhe lexuesit e regjistrit të kërkesave dhe të aktivitetit.
Çdo metodë
key = client.keys.create( name: "Billing sender", scopes: ["emails:send"], domainAllowlist: ["billing.acme.com"], expiresInMinutes: 60 * 24 * 90) File.write(".openemail-billing-key", key[:token]) client.keys.update(key[:id], enabled: false) rotated = client.keys.rotate(key[:id])File.write(".openemail-billing-key", rotated[:token]) client.keys.revoke(key[:id], reason: "Replaced")client.keys.delete(key[:id])create dhe rotate janë të vetmet thirrje që kthejnë një sekret, te token, një herë. Çdo lexim kthen në vend të tij maskedKey. update e fik dhe e ndez një çelës me enabled, që është alternativa e kthyeshme e revoke, dhe delete heq vetëm një çelës që është revokuar: çdo çelës tjetër jep një 409 not_revoked. Leximi kërkon keys:read dhe çdo ndryshim kërkon keys:manage.
Gem-i nuk e riprovon kurrë create ose rotate. Një riprovim pas një përgjigjeje të humbur do të krijonte një çelës të dytë, ose do ta zhvlerësonte sekretin që ktheu përpjekja e parë. update dhe revoke riprovohen pas një dështimi të rrjetit, sepse përsëritja e tyre e lë të njëjtin çelës, ndërsa delete jo.
Kurrë më i gjerë se thirrësi
Një çelës nuk krijon dhe nuk arrin kurrë një çelës më të gjerë se vetja. Fushat, roli, skadimi, modaliteti dhe fusha e dërgimit duhet të qëndrojnë të gjitha brenda çelësit që thërret, përndryshe thirrja ngre OpenEmail::PermissionError me kodin beyond_caller_authority, dhe param emërton boshtin. Një çelës i ngushtuar në disa domene ose adresa sheh vetëm çelësat brenda fushës së vet të dërgimit. rotate mbi çelësin që thërret funksionon edhe me keys:write, si client.me.rotate.
Verifikimi shtesë nuk mund të zbatohet në një thirrje të bërë me çelës, ndaj keys:manage është një kredencial që krijon kredenciale. Jepjani vetëm një automatizimi që lëshon çelësa, jepini atij çelësi një rol, një fushë dërgimi dhe një skadim, dhe ndiqni list_workspace_activity, ku gjithçka që bën regjistrohet në emër të tij.
Regjistri i kërkesave dhe aktiviteti
failures = client.keys.list_requests( "4c1b257a66287fd113bd89d0", failed_only: true, since: Time.now - (24 * 60 * 60))puts failures.items.size client.keys.iterate_workspace_activity do |change| puts [change[:keyName], change[:type], change.dig(:actor, :label)].join(" ")endlist_requests dhe list_activity lexojnë një çelës, ndërsa list_workspace_requests dhe list_workspace_activity lexojnë çdo çelës ose ata që emërton key_ids:. Secila ka pranë një binjak list_all_ dhe një iterate_, si list_all_requests dhe iterate_requests. Marrin since: dhe until: si një Time, një DateTime ose një string ISO 8601, dhe lexuesit e kërkesave marrin edhe failed_only:.
until është fjalë e rezervuar në Ruby, por until: funksionon si argument me fjalë kyçe ashtu siç është shkruar. Duhet të jetë më vonë se since:, përndryshe thirrja ngre OpenEmail::InvalidRequestError me kodin invalid_parameter.