تایپ‌ها و کمک‌کننده‌ها

هر درخواست و پاسخی یکی دارد و همگی از ریشهٔ پکیج export می‌شوند. هیچ 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.
• —وب‌هوک‌ها: 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() یک مسیر و مجموعه‌ای از گزینه‌ها می‌گیرد و به بدنهٔ تجزیه‌شده resolve می‌شود، با اعمال کلید، base URL، تایم‌اوت و سیاست تلاش مجدد کلاینت.

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

• —هیچ بدنهٔ درخواستی را اعتبارسنجی نمی‌کند. اسکیمای سرور تنها نسخهٔ قواعد است، و نسخهٔ دومی اینجا سرانجام آدرسی را رد می‌کرد که سروری تازه‌تر می‌پذیرد، آن هم در نسخه‌ای که کسی دو سال پیش pin کرده است.
• —نه zod عرضه می‌کند و نه اصلاً وابستگی زمان اجرا.
• —پاسخ را تنها به یک شکل بازآرایی می‌کند: آرایهٔ data در یک مجموعه از پاکتش بیرون کشیده می‌شود. یک فهرست صفحه‌بندی‌شده آن را به‌صورت items کنار hasMore و nextCursor بازمی‌گرداند، emails.sendBatch به‌صورت items کنار sent و failed، tempMail.listMessages به‌صورت items کنار expiresAt، و addresses.list به‌صورت addresses کنار unrestricted و domains. در همه‌جای دیگر یک آرایهٔ ساده است. هر منبعی درون آن شکل مستندشدهٔ HTTP خود را نگه می‌دارد.