型とヘルパー

すべてのリクエストとレスポンスに型があり、いずれもパッケージのルートからエクスポートされる。深い import は存在しないため、ファイル構成はメジャーバージョンを上げずに変更できる実装の詳細のままでいられる。…Resource は API が返すもの、…Create、…Patch、…Input、…Send は渡すもの、…Options はフィルターと呼び出しごとのオプションを保持する。

• —クライアント: ClientOptions、TempMailOptions、TransportOptions、RequestOptions、RequestScope、SendScope、InboxScope、ListOptions、Page、ApiKeyMode、FetchLike。
• —エラー: ErrorType、ApiErrorPayload、ApiErrorProps。
• —メール: EmailSend、EmailListOptions、EmailTranslate、EmailResource、SentEmailResource、EmailRecipientResource、EmailEventResource、EmailStatus、EmailSource、EmailTransport、EmailTrackingSummary、EmailTranslationResource、TranslationResource、RecipientStatus、BatchItemResource、BatchResultResource。
• —テンプレート: TemplateCreate、TemplatePatch、TemplateContent、TemplateListOptions、TemplatePreviewInput、TemplateSend、TemplateResource、TemplateDetailResource、TemplateVersionResource、TemplatePreviewResource、SentTemplateEmailResource、DeletedTemplateResource、TemplateEngine、TemplateProp、TemplateSlot、TemplateStatus、TemplateValueKind。
• —トラッキング: TrackingListOptions、TrackingStatsOptions、TrackingHitOptions、TrackingResource、TrackingSummary、TrackingRecipientResource、TrackingLinkResource、TrackingOpenResource、TrackingClickResource、TrackingStatsResource、TrackingGrain。
• —スレッドと下書き: ThreadListOptions、ThreadPatch、ThreadResource、ThreadSummaryResource、UpdatedThreadResource、TrashedThreadResource、SnoozedThreadResource、DraftInput、DraftListOptions、DraftResource、DraftSummaryResource、SavedDraftResource、DeletedDraftResource。
• —ラベル、連絡先、ドメイン、アドレス: LabelInput、LabelColor、LabelResource、SavedLabelResource、DeletedLabelResource、ContactCreate、ContactPatch、ContactListOptions、ContactSource、ContactResource、ContactDetailResource、ContactAudienceResource、DeletedContactResource、DomainPatch、DomainResource、DomainDetailResource、DomainSendingState、DomainTracking、DomainTrackingState、AddressBookResource、AddressResource、SendableDomainResource。
• —ルール: RuleCreate、RulePatch、RuleListOptions、RuleRunListOptions、RuleTestInput、RuleResource、RuleRunResource、RuleTestResource、DeletedRuleResource、RuleCondition、RuleConditionInput、RuleAction、RuleActionType、RuleField、RuleOperator。
• —Webhook: WebhookCreate、WebhookPatch、WebhookResource、CreatedWebhookResource、DeletedWebhookResource、WebhookDeliveryResource、WebhookTestResource、WebhookEvent、WebhookPayload、EmailOpenedData、EmailClickedData、EmailDownloadedData、VerifyWebhookProps、WebhookSignatureHeaders。
• —カレンダーと設定: CalendarRangeOptions、CalendarOccurrenceResource、CalendarEventResource、CalendarAttendeeResource、SettingsPatch、SettingsResource。
• —ロール、メンバー、キー: RoleCreate、RolePatch、RoleDeleteOptions、RoleResource、DeletedRoleResource、PermissionResource、MemberAdd、MemberPatch、MemberAddressGrant、MemberResource、MemberAddressResource、RemovedMemberResource、MemberAccess、KeyResource、PingResource。
• —使い捨て受信箱: TempInboxCreate、TempMessageListOptions、TempInboxResource、CreatedTempInboxResource、DeletedTempInboxResource、TempDomainResource、TempMessageResource、TempMessagesResource、TempMessageDetailResource、DeletedTempMessageResource。
• —共通: RecipientInput、AttachmentInput、AttachmentResource、MessageResource、MessageEncryption、MessageEncryptionFormat、TrackingRequest、TranslateOptions、SendTranslateOptions、LanguageResource、ApiScope、Permission、BuiltinRole、HitKind。

SDK のリリースが、すでに動作しているエンドポイントとの間に立ちはだかってはならない。openemail.raw.request() はパスとオプションを受け取り、クライアントのキー、ベース URL、タイムアウト、リトライポリシーを適用したうえで、パース済みのボディに解決する。

const result = await openemail.raw.request<Whatever>('/something-new', {  method: 'POST',  query: { dryRun: true },  body: { name: 'Invoices' },  repeatable: true,})

• —リクエストボディの検証は行わない。ルールの唯一の写しはサーバーのスキーマであり、ここに 2 つ目の写しを置けば、いずれ 2 年前に誰かが固定したバージョンが、新しいサーバーなら受け入れるアドレスを拒否することになる。
• —zod も、その他のランタイム依存もいっさい同梱しない。
• —レスポンスの整形は 1 点だけである。コレクションの data 配列をエンベロープから取り出す。ページングされる一覧では hasMore と nextCursor と並んで items として返し、emails.sendBatch では sent と failed と並んで items、tempMail.listMessages では expiresAt と並んで items、addresses.list では unrestricted と domains と並んで addresses として返す。それ以外の場所では素の配列になる。中に含まれる各リソースは、ドキュメントに記載された HTTP 上の形をそのまま保つ。