Değişiklik günlüğü

İlk sürüm. Bu sürüm çıkarıldığı andaki hâliyle TypeScript SDK'sının tamamını kapsar, yani 0.0.8 ve ondan sonra sıraya alınan değişiklikleri: 41 ad alanında 430 metot; her biri TypeScript adının snake_case biçimini taşır ve her biri TypeScript ikizinin gönderdiği isteğin bayt bayt aynısını gönderir.

• —OpenEmail::Client, emails, threads ve templates ile başlayıp provider_imports, dns_connections ve account ile biten her ad alanı için bir okuyucuya sahiptir. listAll burada list_all, getActive get_active, tempMail ise temp_mail olur.
• —Bir istek gövdesi anahtar kelime argümanları ya da tek bir Hash olarak verilir ve anahtarları API'nin camelCase adlarını korur. Bir yanıt Symbol anahtarlı bir Hash olarak döner.
• —Sayfalanan her kaynağın bir OpenEmail::Page döndüren list, tüm öğeleri bir Array olarak döndüren list_all ve her öğeyi bir bloğa veren ya da bir sonraki sayfayı ancak oraya geldiğinde getiren bir Enumerator döndüren iterate metotları vardır. PeoplePage, TempMessagesPage, AddressBookPage, AddressBook, BatchResult ve TemplateSends, bir listeden fazlasını içeren yanıtları taşır.
• —Bir API reddi, status, type, code, param, doc_url, request_id, retry_after_seconds, fields ve body alanları ile validation? ve step_up_required? gibi yüklemlere sahip OpenEmail::ApiError ya da hata türüne karşılık gelen alt sınıfını fırlatır. Hiç yanıt gelmemesi, süre dolduğunda timeout? ile birlikte OpenEmail::NetworkError fırlatır. Çağrının kendisindeki bir hata, hiçbir şey gönderilmeden önce ArgumentError fırlatır.
• —OpenEmail.create_client, OPENEMAIL_API_KEY, OPENEMAIL_ACCESS_TOKEN ve OPENEMAIL_BASE_URL değerlerinden bir istemci kurar; OpenEmail.init, OpenEmail.client ve OpenEmail.reset_client ise OpenEmail.emails ve diğer tüm ad alanlarının üzerinden ulaştığı tek bir paylaşılan istemciyi yönetir. OpenEmail.create_temp_mail kimlik bilgisi olmadan tek kullanımlık gelen kutuları açar.
• —access_token: bir OAuth erişim tokenı ya da call çağrısına yanıt verip bir token döndüren ve her istekten önce çağrılan herhangi bir nesne alır. Her metot, tek bir çağrı için başka bir anahtarla işlem yapmak üzere api_key: alır; temp_mail metotları ise inbox_token: alır.
• —OpenEmail.verify_webhook_signature bir teslimatı sabit zamanda denetler, beş dakikadan eski bir teslimatı reddeder ve ayrıştırılmış olayı döndürür. İmzayı başlık adı herhangi bir büyük/küçük harf biçiminde olan bir Hash'ten, bir Rack ortamından ya da Rails'in request.headers nesnesinden okur.
• —OpenEmail.to_base64, api_key?, access_token?, sealed?, resolve_language, language_by_code ve rtl_language?, TypeScript SDK'sının yardımcılarıdır; paket kökünün dışa aktardığı her değer kümesi de OpenEmail üzerinde dondurulmuş bir Hash'tir.
• —Çalışma zamanı bağımlılığı yoktur. İstekler, tek bir istemcinin iş parçacıkları arasında paylaştığı ve bir fork'tan sonra yeniden kurduğu, açık tutulan bağlantılardan oluşan bir havuzla Net::HTTP üzerinden gider; timeout: ise bir denemenin tamamını sınırlar.
• —Okumalar, gönderimler ve tekrarlanması güvenli her yazma işlemi 408, 500, 502, 503 ve 504 durumlarında artan beklemeyle, 429 durumunda ise yalnızca Retry-After bir dakika ya da daha azsa yeniden denenir. Her gönderim, yeniden denemelerinin yeniden kullandığı bir idempotency anahtarı taşır.
• —İstemci, düz http: üzerinden bu makine dışındaki herhangi bir yere kimlik bilgisi göndermeyi reddeder, 0.0.0.0 üzerindeki bir base_url değerini reddeder, bir isteği bölecek bir başlığı reddeder ve raw.request çağrısının temel URL'nin kaynağından dışarı çıkmasına asla izin vermez.