टाइप और हेल्पर

हर request और response का एक है, और वे पैकेज की जड़ से export होते हैं। कोई deep import नहीं है, इसलिए फ़ाइल का ढाँचा एक कार्यान्वयन विवरण बना रहता है जो major संस्करण बदले बिना हिल सकता है। …Resource वह है जो API लौटाता है, …Create, …Patch, …Input और …Send वे हैं जो आप देते हैं, और …Options में filters तथा प्रति-कॉल विकल्प होते हैं।

• —क्लाइंट: 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।
• —रोल, सदस्य और keys: 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 रिलीज़ को कभी आपके और पहले से काम कर रहे endpoint के बीच नहीं खड़ा होना चाहिए। openemail.raw.request() एक path और विकल्प लेता है और पार्स की गई body में resolve होता है, जिसमें क्लाइंट की key, base URL, timeout और retry नीति लागू होती है।

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

• —यह किसी request body को validate नहीं करता। नियमों की इकलौती प्रति सर्वर का schema है, और यहाँ रखी दूसरी प्रति किसी दिन ऐसा पता अस्वीकार कर देती जिसे नया सर्वर स्वीकार करता है — उस संस्करण में जिसे किसी ने दो साल पहले pin किया था।
• —यह न zod शिप करता है और न कोई रनटाइम dependency।
• —यह रिस्पॉन्स को केवल एक तरह से बदलता है: किसी संग्रह का data array उसके envelope से बाहर उठा लिया जाता है। पेज वाली सूची उसे hasMore और nextCursor के साथ items के रूप में लौटाती है, emails.sendBatch उसे sent और failed के साथ items के रूप में, tempMail.listMessages उसे expiresAt के साथ items के रूप में, और addresses.list उसे unrestricted तथा domains के साथ addresses के रूप में। बाकी हर जगह यह सादा array है। अंदर का हर resource प्रलेखित HTTP आकार बनाए रखता है।