Kiểu dữ liệu và tiện ích

Mọi yêu cầu và phản hồi đều có một kiểu, và chúng được export từ gốc của gói. Không có deep import, nên bố cục tệp vẫn là chi tiết cài đặt có thể thay đổi mà không cần một phiên bản major. …Resource là thứ API trả về, …Create, …Patch, …Input và …Send là thứ bạn truyền vào, còn …Options chứa bộ lọc và các tuỳ chọn theo từng lời gọi.

• —Client: ClientOptions, TempMailOptions, TransportOptions, RequestOptions, RequestScope, SendScope, InboxScope, ListOptions, Page, ApiKeyMode, FetchLike.
• —Lỗi: ErrorType, ApiErrorPayload, ApiErrorProps.
• —Email: EmailSend, EmailListOptions, EmailTranslate, EmailResource, SentEmailResource, EmailRecipientResource, EmailEventResource, EmailStatus, EmailSource, EmailTransport, EmailTrackingSummary, EmailTranslationResource, TranslationResource, RecipientStatus, BatchItemResource, BatchResultResource.
• —Mẫu: TemplateCreate, TemplatePatch, TemplateContent, TemplateListOptions, TemplatePreviewInput, TemplateSend, TemplateResource, TemplateDetailResource, TemplateVersionResource, TemplatePreviewResource, SentTemplateEmailResource, DeletedTemplateResource, TemplateEngine, TemplateProp, TemplateSlot, TemplateStatus, TemplateValueKind.
• —Theo dõi: TrackingListOptions, TrackingStatsOptions, TrackingHitOptions, TrackingResource, TrackingSummary, TrackingRecipientResource, TrackingLinkResource, TrackingOpenResource, TrackingClickResource, TrackingStatsResource, TrackingGrain.
• —Luồng thư và bản nháp: ThreadListOptions, ThreadPatch, ThreadResource, ThreadSummaryResource, UpdatedThreadResource, TrashedThreadResource, SnoozedThreadResource, DraftInput, DraftListOptions, DraftResource, DraftSummaryResource, SavedDraftResource, DeletedDraftResource.
• —Nhãn, danh bạ, tên miền và địa chỉ: LabelInput, LabelColor, LabelResource, SavedLabelResource, DeletedLabelResource, ContactCreate, ContactPatch, ContactListOptions, ContactSource, ContactResource, ContactDetailResource, ContactAudienceResource, DeletedContactResource, DomainPatch, DomainResource, DomainDetailResource, DomainSendingState, DomainTracking, DomainTrackingState, AddressBookResource, AddressResource, SendableDomainResource.
• —Quy tắc: 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.
• —Lịch và thiết lập: CalendarRangeOptions, CalendarOccurrenceResource, CalendarEventResource, CalendarAttendeeResource, SettingsPatch, SettingsResource.
• —Vai trò, thành viên và khoá: RoleCreate, RolePatch, RoleDeleteOptions, RoleResource, DeletedRoleResource, PermissionResource, MemberAdd, MemberPatch, MemberAddressGrant, MemberResource, MemberAddressResource, RemovedMemberResource, MemberAccess, KeyResource, PingResource.
• —Hộp thư dùng một lần: TempInboxCreate, TempMessageListOptions, TempInboxResource, CreatedTempInboxResource, DeletedTempInboxResource, TempDomainResource, TempMessageResource, TempMessagesResource, TempMessageDetailResource, DeletedTempMessageResource.
• —Dùng chung: RecipientInput, AttachmentInput, AttachmentResource, MessageResource, MessageEncryption, MessageEncryptionFormat, TrackingRequest, TranslateOptions, SendTranslateOptions, LanguageResource, ApiScope, Permission, BuiltinRole, HitKind.

Một bản phát hành SDK không bao giờ nên là thứ chắn giữa bạn và một endpoint vốn đã hoạt động. openemail.raw.request() nhận một đường dẫn cùng các tuỳ chọn và trả về body đã phân tích, với khoá, base URL, thời gian chờ và chính sách thử lại của client được áp dụng.

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

• —Nó không kiểm tra body của yêu cầu. Schema của máy chủ là bản sao duy nhất của các quy tắc, và một bản sao thứ hai ở đây rồi sẽ từ chối một địa chỉ mà máy chủ mới hơn chấp nhận, trong một phiên bản mà ai đó đã ghim từ hai năm trước.
• —Nó không kèm zod và hoàn toàn không có phụ thuộc runtime nào.
• —Nó chỉ biến đổi hình dạng phản hồi theo đúng một cách: mảng data của một tập hợp được nhấc ra khỏi phong bì của nó. Một danh sách phân trang trả nó về dưới tên items bên cạnh hasMore và nextCursor, emails.sendBatch trả về items bên cạnh sent và failed, tempMail.listMessages trả về items bên cạnh expiresAt, còn addresses.list trả về addresses bên cạnh unrestricted và domains. Ở mọi nơi khác nó là một mảng thuần. Mọi tài nguyên bên trong vẫn giữ đúng hình dạng HTTP như tài liệu mô tả.