変更履歴

最初のリリースです。0.0.8 時点の TypeScript SDK 全体に加え、その後に予定されていた変更を網羅しています。41 の名前空間にわたる 430 のメソッドが、それぞれ TypeScript の名前を snake_case にした名前で提供されます。パリティチェックが、そのすべてが対応する TypeScript のメソッドとまったく同じリクエストを送ることを、オプションなしで 1 回、すべてのオプションを指定して 1 回確認して証明します。

• —OpenEmail と AsyncOpenEmail には、emails、threads、templates から provider_imports、dns_connections、account まで、すべての名前空間に対応する属性があります。listAll は list_all、getActive は get_active、tempMail は temp_mail になります。
• —リクエストボディはキーが API の camelCase の名前のままの dict で、呼び出しのオプションは idempotency_key= や limit= のような snake_case のキーワード引数であり、レスポンスは dict として返ります。すべてのボディと結果には、TypeScript と同じ名前の TypedDict が openemail.types にあります。
• —AsyncOpenEmail は同じ引数を取る同じメソッドを、await で呼び出す形で備えており、asyncio と trio の両方で動作します。
• —ページングされるすべてのリソースには、1 ページを返す list、すべてのアイテムをリストで返す list_all、そしてアイテムを 1 つずつ返し、次のページはそこに到達したときにだけ取得する iterate があります。
• —API による拒否は OpenEmailApiError を送出します。これは status、type、code、param、request_id と、is_validation、is_not_found、is_rate_limited、is_step_up_required、is_retryable などのチェックを持ちます。応答がまったくない場合は OpenEmailNetworkError を送出し、期限を過ぎた場合は is_timeout が付きます。
• —from openemail import openemail は、最初に触れたときに OPENEMAIL_API_KEY から作られる既製のクライアントで、init は起動時にそれを一度だけ設定します。create_temp_mail と create_async_temp_mail は認証情報なしで使い捨て受信箱を開きます。
• —access_token= は OAuth アクセストークン、またはそれを返す関数を受け取り、関数は毎回のリクエストの前に呼ばれます。verify_webhook_signature は配信を一定時間で検証し、パース済みのイベントを返します。client.raw.request は、まだどのメソッドもラップしていないエンドポイントに届きます。
• —読み取りは 408 と 5xx でリトライされ、429 は Retry-After が付いている場合にのみリトライされます。timeout はレスポンスボディを含む試行全体の上限で、認証情報がこのマシン上のサーバー以外に暗号化されていない HTTP で送られることはありません。
• —Python 3.10 以降が必要で、依存するのは httpx、anyio、typing-extensions だけです。