Gem Ruby
Le client Ruby officiel de l'API OpenEmail. Aucune dépendance d'exécution, et une méthode pour chaque endpoint.
Ce que c'est
Une gem pour toute l'API (envoi, modèles, suivi, conversations, brouillons, libellés, contacts, audiences, formulaires d'inscription, diffusions, domaines, règles, webhooks, calendrier, paramètres, rôles, membres, suppressions, fichiers et boîtes jetables), avec une méthode pour chaque méthode du SDK TypeScript sous le même nom en snake_case, une classe d'erreur pour chaque type de refus, des réessais qui ne peuvent pas dupliquer un envoi et un vérificateur de signature de webhook. Elle ne demande que Ruby 3.2 ou une version ultérieure, et un même client peut être partagé sans risque entre threads et survit à un fork.
bundle add openemailrequire "openemail" OpenEmail.init(api_key: ENV.fetch("OPENEMAIL_API_KEY")) OpenEmail.emails.send( from: "Acme Billing <[email protected]>", to: "[email protected]", subject: "Your September invoice", html: "<p>Invoice attached.</p>")Où aller
Elle encapsule la même API que tous les autres clients
Tout ce qui figure ici est la surface que documente la référence de l'API et qu'encapsule le SDK TypeScript : lisez donc la référence de l'API pour savoir ce que fait un endpoint, et cette page pour savoir comment l'appeler depuis Ruby. Chaque méthode TypeScript a son jumeau Ruby, et la vérification de parité de la gem exécute les deux avec les mêmes arguments et échoue s'ils n'envoient pas, octet pour octet, la même requête.