Kalo te dokumentacioni
Ruby

Regjistri i ndryshimeve

Çdo version i gem-it, nga më i riu.

0.0.1

Versioni i parë. Mbulon gjithë SDK-në TypeScript siç ishte kur u përgatit ky version, 0.0.8 plus ndryshimet e radhitura pas tij: 430 metoda në 41 hapësira emrash, secila me emrin TypeScript në snake_case, dhe secila prej tyre dërgon bajt për bajt kërkesën që dërgon binjaku i saj TypeScript.

  • OpenEmail::Client ka një lexues për çdo hapësirë emrash, nga emails, threads dhe templates deri te provider_imports, dns_connections dhe account. listAll është list_all, getActive është get_active, dhe tempMail është temp_mail.
  • Trupi i një kërkese jepet si argumente me fjalë kyçe ose si një Hash i vetëm, dhe çelësat e tij ruajnë emrat camelCase të API-së. Një përgjigje kthehet si Hash me çelësa Symbol.
  • Çdo burim i faqosur ka list, që kthen një OpenEmail::Page, list_all, që kthen çdo element si Array, dhe iterate, që ia jep çdo element një blloku ose kthen një Enumerator që e merr faqen e radhës vetëm kur arrin aty. PeoplePage, TempMessagesPage, AddressBookPage, AddressBook, BatchResult dhe TemplateSends mbartin përgjigjet që mbajnë më shumë se një listë.
  • Një refuzim i API-së ngre OpenEmail::ApiError ose nënklasën e tij për llojin e gabimit, me status, type, code, param, doc_url, request_id, retry_after_seconds, fields dhe body, si dhe predikate si validation? dhe step_up_required?. Mungesa e plotë e përgjigjes ngre OpenEmail::NetworkError, me timeout? kur kaloi afati. Një gabim në vetë thirrjen ngre ArgumentError para se të dërgohet ndonjë gjë.
  • OpenEmail.create_client ndërton një klient nga OPENEMAIL_API_KEY, OPENEMAIL_ACCESS_TOKEN dhe OPENEMAIL_BASE_URL, ndërsa OpenEmail.init, OpenEmail.client dhe OpenEmail.reset_client menaxhojnë një klient të përbashkët përmes të cilit arrijnë OpenEmail.emails dhe çdo hapësirë tjetër emrash. OpenEmail.create_temp_mail hap kuti të përkohshme pa kredencial.
  • access_token: merr një token aksesi OAuth, ose çdo gjë që i përgjigjet call dhe kthen një të tillë, e thirrur para çdo kërkese. Çdo metodë merr api_key: për të vepruar me një çelës tjetër për një thirrje, dhe metodat e temp_mail marrin inbox_token:.
  • OpenEmail.verify_webhook_signature kontrollon një dërgesë në kohë konstante, refuzon një që është më e vjetër se pesë minuta dhe kthen ngjarjen e analizuar. E lexon nënshkrimin nga një Hash me çfarëdo shkronjash, nga një env i Rack ose nga request.headers i Rails.
  • OpenEmail.to_base64, api_key?, access_token?, sealed?, resolve_language, language_by_code dhe rtl_language? janë ndihmësit e SDK-së TypeScript, dhe çdo bashkësi vlerash që eksporton rrënja e paketës së saj është një Hash i ngrirë te OpenEmail.
  • Nuk ka varësi në kohën e ekzekutimit. Kërkesat kalojnë përmes Net::HTTP me një grup lidhjesh të mbajtura gjallë, që një klient i ndan mes fijeve të ekzekutimit dhe i rindërton pas një fork-u, dhe timeout: kufizon një përpjekje të tërë.
  • Leximet, dërgimet dhe çdo shkrim që është i sigurt për t’u përsëritur riprovohen te 408, 500, 502, 503 dhe 504 me pritje gjithnjë e më të gjata, dhe te një 429 vetëm kur Retry-After i tij është një minutë ose më pak. Çdo dërgim mbart një çelës idempotence që e ripërdorin riprovimet e tij.
  • Klienti refuzon të dërgojë një kredencial përmes http: të thjeshtë te çdo gjë tjetër përveç kësaj makine, refuzon një base_url në 0.0.0.0, refuzon një header që do ta ndante një kërkesë, dhe nuk e lë kurrë raw.request të dalë nga origjina e URL-së bazë.