shipmail 0.6.1 → 0.6.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -0
- package/dist/index.cjs +59 -10
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +102 -6
- package/dist/index.d.ts +102 -6
- package/dist/index.js +59 -11
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -52,6 +52,14 @@ type ApiErrorBody = {
|
|
|
52
52
|
* the interrupted send attempt left behind.
|
|
53
53
|
*/
|
|
54
54
|
readonly message_id?: string | undefined;
|
|
55
|
+
/**
|
|
56
|
+
* Present only on a refusal an organization owner can lift in Shipmail. One of
|
|
57
|
+
* `owner_confirmation_required`, `subscription_required`, `trial_capacity` or
|
|
58
|
+
* `purchased_capacity`; later servers may add values.
|
|
59
|
+
*/
|
|
60
|
+
readonly reason?: string | undefined;
|
|
61
|
+
/** Present with `reason`: the Shipmail page where the owner reviews and confirms. */
|
|
62
|
+
readonly action_url?: string | undefined;
|
|
55
63
|
};
|
|
56
64
|
};
|
|
57
65
|
type EmailRecipient = {
|
|
@@ -420,9 +428,15 @@ type CalendarPerson = {
|
|
|
420
428
|
type CalendarAttendee = CalendarPerson & {
|
|
421
429
|
readonly status: "needs-action" | "accepted" | "declined" | "tentative";
|
|
422
430
|
};
|
|
431
|
+
type CalendarInvitationOutcome = {
|
|
432
|
+
readonly recipient: string;
|
|
433
|
+
readonly status: "sent" | "failed" | "unknown";
|
|
434
|
+
};
|
|
423
435
|
type CalendarEvent = {
|
|
424
436
|
readonly object: "calendar_event";
|
|
425
437
|
readonly id: string;
|
|
438
|
+
/** Content revision used as expected_revision for safe updates. */
|
|
439
|
+
readonly revision: string;
|
|
426
440
|
readonly mailbox: string;
|
|
427
441
|
readonly calendar_id: string | null;
|
|
428
442
|
readonly uid: string | null;
|
|
@@ -448,6 +462,11 @@ type CalendarEvent = {
|
|
|
448
462
|
readonly created_at: string | null;
|
|
449
463
|
readonly updated_at: string | null;
|
|
450
464
|
};
|
|
465
|
+
type CalendarEventMutationResult = CalendarEvent & {
|
|
466
|
+
readonly invitation_outcomes: readonly CalendarInvitationOutcome[];
|
|
467
|
+
/** Compatibility list containing failed and unknown recipients. */
|
|
468
|
+
readonly invitation_failures: readonly string[];
|
|
469
|
+
};
|
|
451
470
|
type ListCalendarEventsParams = PaginationParams & {
|
|
452
471
|
readonly mailbox: string;
|
|
453
472
|
readonly from: string;
|
|
@@ -463,6 +482,10 @@ type DeleteCalendarEventParams = {
|
|
|
463
482
|
};
|
|
464
483
|
type CreateCalendarEventParams = {
|
|
465
484
|
readonly mailbox: string;
|
|
485
|
+
/** Stable retry identity for this exact create payload. */
|
|
486
|
+
readonly operation_key?: string | undefined;
|
|
487
|
+
/** Whether attendees should receive invitations. Defaults to true. */
|
|
488
|
+
readonly send_invitations?: boolean | undefined;
|
|
466
489
|
readonly calendar_id?: string | undefined;
|
|
467
490
|
readonly title: string;
|
|
468
491
|
readonly invitation_language?: CalendarInvitationLanguage | undefined;
|
|
@@ -483,6 +506,12 @@ type CreateCalendarEventParams = {
|
|
|
483
506
|
};
|
|
484
507
|
type UpdateCalendarEventParams = {
|
|
485
508
|
readonly mailbox: string;
|
|
509
|
+
/** Stable retry identity for this exact update payload. */
|
|
510
|
+
readonly operation_key?: string | undefined;
|
|
511
|
+
/** Revision originally read by the editor; rejects stale guest-visible writes. */
|
|
512
|
+
readonly expected_revision?: string | undefined;
|
|
513
|
+
/** Whether attendees should receive scheduling updates. Defaults to true. */
|
|
514
|
+
readonly send_guest_updates?: boolean | undefined;
|
|
486
515
|
readonly title?: string | undefined;
|
|
487
516
|
readonly invitation_language?: CalendarInvitationLanguage | undefined;
|
|
488
517
|
readonly description?: string | null | undefined;
|
|
@@ -528,11 +557,11 @@ type CalendarAvailabilityParams = {
|
|
|
528
557
|
};
|
|
529
558
|
|
|
530
559
|
declare class CalendarEvents extends ApiResource {
|
|
531
|
-
create(params: CreateCalendarEventParams, options?: MethodOptions): Promise<
|
|
560
|
+
create(params: CreateCalendarEventParams, options?: MethodOptions): Promise<CalendarEventMutationResult>;
|
|
532
561
|
list(params: ListCalendarEventsParams, options?: MethodOptions): Promise<PaginatedResponse<CalendarEvent>>;
|
|
533
562
|
listAutoPaginating(params: Omit<ListCalendarEventsParams, "cursor">): Page<CalendarEvent>;
|
|
534
563
|
get(id: string, params: GetCalendarEventParams, options?: MethodOptions): Promise<CalendarEvent>;
|
|
535
|
-
update(id: string, params: UpdateCalendarEventParams, options?: MethodOptions): Promise<
|
|
564
|
+
update(id: string, params: UpdateCalendarEventParams, options?: MethodOptions): Promise<CalendarEventMutationResult>;
|
|
536
565
|
delete(id: string, params: DeleteCalendarEventParams, options?: MethodOptions): Promise<void>;
|
|
537
566
|
}
|
|
538
567
|
declare class Calendar extends ApiResource {
|
|
@@ -1385,6 +1414,7 @@ type MailboxForwarding = {
|
|
|
1385
1414
|
readonly mailbox_id: string;
|
|
1386
1415
|
readonly destination: string;
|
|
1387
1416
|
readonly sender: string | null;
|
|
1417
|
+
readonly recipient: string | null;
|
|
1388
1418
|
readonly status: "pending" | "active";
|
|
1389
1419
|
readonly verification_sent_at: string | null;
|
|
1390
1420
|
readonly verified_at: string | null;
|
|
@@ -1399,6 +1429,7 @@ type MailboxForwardingList = {
|
|
|
1399
1429
|
type CreateMailboxForwardingParams = {
|
|
1400
1430
|
readonly destination: string;
|
|
1401
1431
|
readonly sender?: string | null | undefined;
|
|
1432
|
+
readonly recipient?: string | null | undefined;
|
|
1402
1433
|
};
|
|
1403
1434
|
type CreateMailboxBaseParams = {
|
|
1404
1435
|
readonly domain_id: string;
|
|
@@ -1589,13 +1620,23 @@ declare class Mailboxes extends ApiResource {
|
|
|
1589
1620
|
abortImportUpload(id: string, fileId: string, options?: MethodOptions): Promise<void>;
|
|
1590
1621
|
}
|
|
1591
1622
|
|
|
1592
|
-
type MemberRole = "owner" | "
|
|
1623
|
+
type MemberRole = "owner" | "admin" | "member";
|
|
1624
|
+
type MemberMailboxAccessScope = "all" | "selected";
|
|
1625
|
+
type MemberMailboxAccess = {
|
|
1626
|
+
readonly scope: MemberMailboxAccessScope;
|
|
1627
|
+
/**
|
|
1628
|
+
* Empty when `scope` is `all`. For `selected`, API-key responses may include only the mailbox
|
|
1629
|
+
* IDs that the key can reach.
|
|
1630
|
+
*/
|
|
1631
|
+
readonly mailbox_ids: readonly string[];
|
|
1632
|
+
};
|
|
1593
1633
|
type Member = {
|
|
1594
1634
|
readonly object: "member";
|
|
1595
1635
|
readonly id: string;
|
|
1596
1636
|
readonly email: string;
|
|
1597
1637
|
readonly name: string;
|
|
1598
1638
|
readonly role: MemberRole;
|
|
1639
|
+
readonly mailbox_access: MemberMailboxAccess;
|
|
1599
1640
|
readonly created_at: string;
|
|
1600
1641
|
};
|
|
1601
1642
|
type ListMembersParams = PaginationParams;
|
|
@@ -1682,6 +1723,9 @@ type Newsletter = {
|
|
|
1682
1723
|
readonly archive_visibility: NewsletterArchiveVisibility;
|
|
1683
1724
|
readonly feed_entry_url: string | null;
|
|
1684
1725
|
readonly styling_mode: NewsletterStylingMode;
|
|
1726
|
+
readonly track_engagement: boolean;
|
|
1727
|
+
readonly opened_count: number | null;
|
|
1728
|
+
readonly clicked_count: number | null;
|
|
1685
1729
|
readonly preflight_status: NewsletterPreflightStatus;
|
|
1686
1730
|
readonly preflight_results: Record<string, unknown>;
|
|
1687
1731
|
readonly send_window_hours: number;
|
|
@@ -1770,6 +1814,7 @@ type CreateNewsletterParams = {
|
|
|
1770
1814
|
readonly archive_visibility?: NewsletterArchiveVisibility | undefined;
|
|
1771
1815
|
readonly feed_entry_url?: string | null | undefined;
|
|
1772
1816
|
readonly styling_mode?: NewsletterStylingMode | undefined;
|
|
1817
|
+
readonly track_engagement?: boolean | undefined;
|
|
1773
1818
|
};
|
|
1774
1819
|
type UpdateNewsletterParams = Partial<CreateNewsletterParams>;
|
|
1775
1820
|
type NewsletterChangelogMedia = {
|
|
@@ -2016,6 +2061,38 @@ declare class Newsletters extends ApiResource {
|
|
|
2016
2061
|
resume(id: string, options?: MethodOptions): Promise<Newsletter>;
|
|
2017
2062
|
}
|
|
2018
2063
|
|
|
2064
|
+
type OrganizationAccess = {
|
|
2065
|
+
readonly object: "organization_access";
|
|
2066
|
+
readonly organization: {
|
|
2067
|
+
readonly id: string;
|
|
2068
|
+
readonly name: string;
|
|
2069
|
+
};
|
|
2070
|
+
readonly plan: "free" | "solo" | "pro" | "team" | "scale";
|
|
2071
|
+
/** Mailboxes can be created now, by the same rule mailbox creation applies. */
|
|
2072
|
+
readonly has_access: boolean;
|
|
2073
|
+
readonly trial: {
|
|
2074
|
+
readonly active: boolean;
|
|
2075
|
+
readonly ends_at: string | null;
|
|
2076
|
+
/** No subscription yet and the owner never had a trial. Checkout still confirms it. */
|
|
2077
|
+
readonly eligible: boolean;
|
|
2078
|
+
};
|
|
2079
|
+
readonly mailboxes: {
|
|
2080
|
+
readonly limit: number;
|
|
2081
|
+
readonly used: number;
|
|
2082
|
+
};
|
|
2083
|
+
/** Newsletter sending is available. It is not during a trial. */
|
|
2084
|
+
readonly newsletters_allowed: boolean;
|
|
2085
|
+
};
|
|
2086
|
+
|
|
2087
|
+
declare class Organization extends ApiResource {
|
|
2088
|
+
/**
|
|
2089
|
+
* Whether the credential's organization can create mailboxes now, with its plan, trial and
|
|
2090
|
+
* mailbox capacity. Poll it after the owner pays: access appears once Shipmail has recorded the
|
|
2091
|
+
* payment.
|
|
2092
|
+
*/
|
|
2093
|
+
access(options?: MethodOptions): Promise<OrganizationAccess>;
|
|
2094
|
+
}
|
|
2095
|
+
|
|
2019
2096
|
type ReplyScanStatus = "completed";
|
|
2020
2097
|
type ReplyScan = {
|
|
2021
2098
|
readonly object: "reply_scan";
|
|
@@ -2250,6 +2327,7 @@ declare class ShipmailClient {
|
|
|
2250
2327
|
readonly members: Members;
|
|
2251
2328
|
readonly messages: Messages;
|
|
2252
2329
|
readonly newsletters: Newsletters;
|
|
2330
|
+
readonly organization: Organization;
|
|
2253
2331
|
readonly replyScans: ReplyScans;
|
|
2254
2332
|
readonly scheduledMessages: ScheduledMessages;
|
|
2255
2333
|
readonly suppressions: Suppressions;
|
|
@@ -2267,23 +2345,39 @@ declare class ShipmailClient {
|
|
|
2267
2345
|
private buildUrl;
|
|
2268
2346
|
}
|
|
2269
2347
|
|
|
2348
|
+
/** The `reason` values this SDK knows. A newer server may send others; they pass through. */
|
|
2349
|
+
declare const ERROR_RECOVERY_REASONS: readonly ["owner_confirmation_required", "subscription_required", "trial_capacity", "purchased_capacity"];
|
|
2350
|
+
/** What an organization owner can do in Shipmail to lift a refusal. */
|
|
2351
|
+
type ErrorRecovery = {
|
|
2352
|
+
readonly reason?: string | undefined;
|
|
2353
|
+
readonly actionUrl?: string | undefined;
|
|
2354
|
+
};
|
|
2270
2355
|
declare class ShipmailError extends Error {
|
|
2271
2356
|
readonly status: number | undefined;
|
|
2272
2357
|
readonly type: ErrorType | undefined;
|
|
2273
2358
|
readonly requestId: string | undefined;
|
|
2274
2359
|
readonly retryable: boolean;
|
|
2360
|
+
/**
|
|
2361
|
+
* Why an organization owner must act, when they can lift this refusal in Shipmail. The error's
|
|
2362
|
+
* type and status stay what they were. See ERROR_RECOVERY_REASONS.
|
|
2363
|
+
*/
|
|
2364
|
+
readonly reason: string | undefined;
|
|
2365
|
+
/** The Shipmail page to send the owner to. Retry with a new idempotency key afterwards. */
|
|
2366
|
+
readonly actionUrl: string | undefined;
|
|
2275
2367
|
constructor(message: string, options?: {
|
|
2276
2368
|
readonly status?: number | undefined;
|
|
2277
2369
|
readonly type?: ErrorType | undefined;
|
|
2278
2370
|
readonly requestId?: string | undefined;
|
|
2279
2371
|
readonly retryable?: boolean | undefined;
|
|
2372
|
+
readonly reason?: string | undefined;
|
|
2373
|
+
readonly actionUrl?: string | undefined;
|
|
2280
2374
|
});
|
|
2281
2375
|
}
|
|
2282
2376
|
declare class AuthenticationError extends ShipmailError {
|
|
2283
2377
|
constructor(message: string, requestId?: string);
|
|
2284
2378
|
}
|
|
2285
2379
|
declare class AuthorizationError extends ShipmailError {
|
|
2286
|
-
constructor(message: string, requestId?: string);
|
|
2380
|
+
constructor(message: string, requestId?: string, recovery?: ErrorRecovery);
|
|
2287
2381
|
}
|
|
2288
2382
|
declare class ValidationError extends ShipmailError {
|
|
2289
2383
|
readonly details: readonly {
|
|
@@ -2298,10 +2392,12 @@ declare class ValidationError extends ShipmailError {
|
|
|
2298
2392
|
readonly message: string;
|
|
2299
2393
|
readonly code?: string | undefined;
|
|
2300
2394
|
}[] | undefined;
|
|
2395
|
+
readonly reason?: string | undefined;
|
|
2396
|
+
readonly actionUrl?: string | undefined;
|
|
2301
2397
|
});
|
|
2302
2398
|
}
|
|
2303
2399
|
declare class QuotaExceededError extends ShipmailError {
|
|
2304
|
-
constructor(message: string, requestId?: string);
|
|
2400
|
+
constructor(message: string, requestId?: string, recovery?: ErrorRecovery);
|
|
2305
2401
|
}
|
|
2306
2402
|
declare class NotFoundError extends ShipmailError {
|
|
2307
2403
|
constructor(message: string, requestId?: string);
|
|
@@ -2351,4 +2447,4 @@ declare function verifyWebhook(body: string, headers: WebhookHeaders | Headers,
|
|
|
2351
2447
|
readonly toleranceInSeconds?: number | undefined;
|
|
2352
2448
|
}): Promise<WebhookEvent>;
|
|
2353
2449
|
|
|
2354
|
-
export { type AddSubscriberParams, type AddSubscribersBatchParams, type AddSubscribersBatchResult, type ApiErrorBody, type Audience, type AudienceFeed, AuthenticationError, AuthorizationError, type Automation, type AutomationAction, type AutomationCondition, type AutomationDefinition, type AutomationRun, type AutomationRunStatus, type AutomationRunSummary, type AutomationStatus, type AutomationTrigger, type BookingPage, CONFERENCING_PROVIDER_IDS, type CalendarAvailability, type CalendarAvailabilityParams, type CalendarAvailabilitySlot, type CalendarEvent, type CalendarEventPrivacy, type CalendarEventStatus, type CalendarFreeBusyStatus, type CalendarInvitationLanguage, type CapabilitiesResponse, type CapabilityResourceConstraints, type ConferencingProviderId, ConflictError, ConnectionError, type CreateAudienceParams, type CreateAutomationParams, type CreateBookingPageParams, type CreateCalendarEventParams, type CreateDomainParams, type CreateInboxDraftParams, type CreateInboxReplyDraftParams, type CreateMailboxAppPasswordParams, type CreateMailboxFolderParams, type CreateMailboxParams, type CreateNewsletterFromChangelogParams, type CreateNewsletterParams, type CreateReplyScanParams, type CreateWebhookParams, type CreatedMailboxAppPassword, DOMAIN_STATUSES, type DataMode, type DeleteCalendarEventParams, type Domain, type DomainDnsRecord, type DomainDnsRecordKey, type DomainDnsRecordSet, type DomainDnsRecordStatus, type DomainRegistrationInfo, type DomainSearchResult, type DomainStatus, type DomainVerificationResult, type DownloadInboxAttachmentParams, type EmailAuthVerdict, type EmailAuthenticationResults, type EmailRecipient, type EmailRecipientInput, type ErrorType, type GetCalendarEventParams, type GetThreadParams, type InboxAttachment, type InboxBodyPart, type InboxBodyValue, type InboxDraft, type InboxDraftRecipient, type InboxEmailHeader, type InboxFullMessage, type InboxKeyword, type InboxMessage, type InboxMessageAction, type InboxMessages, type InboxReplyDraft, type InboxReplyDraftSend, type InboxThread, type InboxThreadAttentionResult, type InboxThreadAttentionState, type InboxThreadSummary, type InboxThreads, type InjectSandboxInboundParams, InternalServerError, type ListAudiencesParams, type ListAutomationsResponse, type ListBookingPagesParams, type ListCalendarEventsParams, type ListDeliveriesParams, type ListDomainsParams, type ListInboxMessagesParams, type ListInboxThreadsParams, type ListMailboxesParams, type ListMembersParams, type ListMessageAnalyticsParams, type ListMessagesParams, type ListNewsletterAssetsParams, type ListNewsletterDomainsParams, type ListNewsletterSenderIdentitiesParams, type ListNewslettersParams, type ListReplyScanResultsParams, type ListScheduledMessagesParams, type ListSubscribersParams, type ListSuppressionsParams, type ListThreadsParams, type ListWebhooksParams, MESSAGE_SOURCES, MESSAGE_STATUSES, type Mailbox, type MailboxAppPassword, type MailboxAppPasswordList, type MailboxAppPasswordPurpose, type MailboxAppPasswordState, type MailboxDeliveryDestination, type MailboxDeliveryRouting, type MailboxExport, type MailboxExportErrorCode, type MailboxExportStatus, type MailboxFolder, type MailboxFolders, type MailboxIdentities, type MailboxIdentity, type MailboxRule, type MailboxRuleAction, type MailboxRuleCondition, type MailboxRuleFolder, type MailboxRuleMatchMode, type MailboxRuleMoveTarget, type MailboxRules, type Member, type MemberRole, type MergeFields, type Message, type MessageAnalytics, type MessageAnalyticsPage, type MessageMetadata, type MessageRuleDisposition, type MessageSource, type MessageStatus, type MethodOptions, type MoveInboxMessageParams, type Newsletter, type NewsletterArchiveVisibility, type NewsletterAsset, type NewsletterAssetContentType, type NewsletterAssetKind, type NewsletterAssetListResponse, type NewsletterAssetStorageUsage, type NewsletterAssetUpload, type NewsletterBlock, type NewsletterButtonAlign, type NewsletterCalloutVariant, type NewsletterChangelogEntry, type NewsletterChangelogMedia, type NewsletterChangelogTone, type NewsletterColumnContent, type NewsletterColumnImageFit, type NewsletterColumnRatio, type NewsletterCountedUrl, type NewsletterDomain, type NewsletterDomainRecordStatus, type NewsletterDomainStatus, type NewsletterPreflight, type NewsletterPreflightItem, type NewsletterPreflightItemStatus, type NewsletterPreflightStatus, type NewsletterPreview, type NewsletterSenderIdentity, type NewsletterStatus, type NewsletterStylingMode, type NewsletterTestSend, type NewsletterTestSendStatus, type NewsletterUrlBreakdown, type NewsletterUrlSource, NotFoundError, type OneTimeSecretMethodOptions, type OutboundHeader, Page, type PaginatedResponse, type PaginationParams, type PrepareNewsletterAssetUploadParams, type PrepareStagedAttachmentUploadParams, QuotaExceededError, RateLimitError, ReconciliationRequiredError, type Recurrence, type RecurrenceFrequency, type RecurrenceNDay, type RegisterDomainParams, type RegisterNewsletterAssetFromUrlParams, type RegistrationContact, type Reminder, type ReplyScan, type ReplyScanCandidate, type ReplyScanResults, type ReplyScanStatus, type ReplyToMessageParams, type ReplyToThreadParams, type RequestOptions, type ResetMailboxPasswordParams, type RotateSecretResponse, type SandboxOutcome, type ScheduleNewsletterParams, type ScheduledMessage, type ScheduledMessageAttachment, type ScheduledMessageList, type ScheduledMessageRecipient, type ScheduledMessageUploadedAttachment, type SearchDomainsParams, type SendMessageParams, type SendNewsletterTestParams, ShipmailClient, type ShipmailConfig, ShipmailError, type StageAttachmentParams, type StagedAttachment, type StagedAttachmentUpload, type StatusResponse, type Subscriber, type SubscriberOutcome, type SubscriberResult, type SubscriberStatus, type Suppression, type TestWebhookResponse, type Thread, type UpdateAudienceFeedParams, type UpdateAudienceParams, type UpdateAutoReplyParams, type UpdateAutomationParams, type UpdateBookingPageParams, type UpdateCalendarEventParams, type UpdateDomainParams, type UpdateInboxMessageParams, type UpdateInboxThreadAttentionParams, type UpdateMailboxDeliveryRoutingParams, type UpdateMailboxFolderParams, type UpdateMailboxParams, type UpdateMailboxRulesParams, type UpdateNewsletterParams, type UpdateScheduledMessageParams, type UpdateSubscriberParams, type UpdateWebhookParams, type UploadNewsletterAssetParams, ValidationError, WEBHOOK_DELIVERY_EVENT_TYPES, WEBHOOK_DELIVERY_STATUSES, WEBHOOK_EVENT_TYPES, type Webhook, type WebhookDelivery, type WebhookDeliveryDetail, type WebhookDeliveryEventType, type WebhookDeliveryStatus, type WebhookEvent, type WebhookEventType, WebhookVerificationError, type WebhookWithSecret, type Weekday, ShipmailClient as default, verifyWebhook };
|
|
2450
|
+
export { type AddSubscriberParams, type AddSubscribersBatchParams, type AddSubscribersBatchResult, type ApiErrorBody, type Audience, type AudienceFeed, AuthenticationError, AuthorizationError, type Automation, type AutomationAction, type AutomationCondition, type AutomationDefinition, type AutomationRun, type AutomationRunStatus, type AutomationRunSummary, type AutomationStatus, type AutomationTrigger, type BookingPage, CONFERENCING_PROVIDER_IDS, type CalendarAvailability, type CalendarAvailabilityParams, type CalendarAvailabilitySlot, type CalendarEvent, type CalendarEventMutationResult, type CalendarEventPrivacy, type CalendarEventStatus, type CalendarFreeBusyStatus, type CalendarInvitationLanguage, type CalendarInvitationOutcome, type CapabilitiesResponse, type CapabilityResourceConstraints, type ConferencingProviderId, ConflictError, ConnectionError, type CreateAudienceParams, type CreateAutomationParams, type CreateBookingPageParams, type CreateCalendarEventParams, type CreateDomainParams, type CreateInboxDraftParams, type CreateInboxReplyDraftParams, type CreateMailboxAppPasswordParams, type CreateMailboxFolderParams, type CreateMailboxForwardingParams, type CreateMailboxParams, type CreateNewsletterFromChangelogParams, type CreateNewsletterParams, type CreateReplyScanParams, type CreateWebhookParams, type CreatedMailboxAppPassword, DOMAIN_STATUSES, type DataMode, type DeleteCalendarEventParams, type Domain, type DomainDnsRecord, type DomainDnsRecordKey, type DomainDnsRecordSet, type DomainDnsRecordStatus, type DomainRegistrationInfo, type DomainSearchResult, type DomainStatus, type DomainVerificationResult, type DownloadInboxAttachmentParams, ERROR_RECOVERY_REASONS, type EmailAuthVerdict, type EmailAuthenticationResults, type EmailRecipient, type EmailRecipientInput, type ErrorRecovery, type ErrorType, type GetCalendarEventParams, type GetThreadParams, type InboxAttachment, type InboxBodyPart, type InboxBodyValue, type InboxDraft, type InboxDraftRecipient, type InboxEmailHeader, type InboxFullMessage, type InboxKeyword, type InboxMessage, type InboxMessageAction, type InboxMessages, type InboxReplyDraft, type InboxReplyDraftSend, type InboxThread, type InboxThreadAttentionResult, type InboxThreadAttentionState, type InboxThreadSummary, type InboxThreads, type InjectSandboxInboundParams, InternalServerError, type ListAudiencesParams, type ListAutomationsResponse, type ListBookingPagesParams, type ListCalendarEventsParams, type ListDeliveriesParams, type ListDomainsParams, type ListInboxMessagesParams, type ListInboxThreadsParams, type ListMailboxesParams, type ListMembersParams, type ListMessageAnalyticsParams, type ListMessagesParams, type ListNewsletterAssetsParams, type ListNewsletterDomainsParams, type ListNewsletterSenderIdentitiesParams, type ListNewslettersParams, type ListReplyScanResultsParams, type ListScheduledMessagesParams, type ListSubscribersParams, type ListSuppressionsParams, type ListThreadsParams, type ListWebhooksParams, MESSAGE_SOURCES, MESSAGE_STATUSES, type Mailbox, type MailboxAppPassword, type MailboxAppPasswordList, type MailboxAppPasswordPurpose, type MailboxAppPasswordState, type MailboxDeliveryDestination, type MailboxDeliveryRouting, type MailboxExport, type MailboxExportErrorCode, type MailboxExportStatus, type MailboxFolder, type MailboxFolders, type MailboxForwarding, type MailboxForwardingList, type MailboxIdentities, type MailboxIdentity, type MailboxRule, type MailboxRuleAction, type MailboxRuleCondition, type MailboxRuleFolder, type MailboxRuleMatchMode, type MailboxRuleMoveTarget, type MailboxRules, type Member, type MemberMailboxAccess, type MemberMailboxAccessScope, type MemberRole, type MergeFields, type Message, type MessageAnalytics, type MessageAnalyticsPage, type MessageMetadata, type MessageRuleDisposition, type MessageSource, type MessageStatus, type MethodOptions, type MoveInboxMessageParams, type Newsletter, type NewsletterArchiveVisibility, type NewsletterAsset, type NewsletterAssetContentType, type NewsletterAssetKind, type NewsletterAssetListResponse, type NewsletterAssetStorageUsage, type NewsletterAssetUpload, type NewsletterBlock, type NewsletterButtonAlign, type NewsletterCalloutVariant, type NewsletterChangelogEntry, type NewsletterChangelogMedia, type NewsletterChangelogTone, type NewsletterColumnContent, type NewsletterColumnImageFit, type NewsletterColumnRatio, type NewsletterCountedUrl, type NewsletterDomain, type NewsletterDomainRecordStatus, type NewsletterDomainStatus, type NewsletterPreflight, type NewsletterPreflightItem, type NewsletterPreflightItemStatus, type NewsletterPreflightStatus, type NewsletterPreview, type NewsletterSenderIdentity, type NewsletterStatus, type NewsletterStylingMode, type NewsletterTestSend, type NewsletterTestSendStatus, type NewsletterUrlBreakdown, type NewsletterUrlSource, NotFoundError, type OneTimeSecretMethodOptions, type OrganizationAccess, type OutboundHeader, Page, type PaginatedResponse, type PaginationParams, type PrepareNewsletterAssetUploadParams, type PrepareStagedAttachmentUploadParams, QuotaExceededError, RateLimitError, ReconciliationRequiredError, type Recurrence, type RecurrenceFrequency, type RecurrenceNDay, type RegisterDomainParams, type RegisterNewsletterAssetFromUrlParams, type RegistrationContact, type Reminder, type ReplyScan, type ReplyScanCandidate, type ReplyScanResults, type ReplyScanStatus, type ReplyToMessageParams, type ReplyToThreadParams, type RequestOptions, type ResetMailboxPasswordParams, type RotateSecretResponse, type SandboxOutcome, type ScheduleNewsletterParams, type ScheduledMessage, type ScheduledMessageAttachment, type ScheduledMessageList, type ScheduledMessageRecipient, type ScheduledMessageUploadedAttachment, type SearchDomainsParams, type SendMessageParams, type SendNewsletterTestParams, ShipmailClient, type ShipmailConfig, ShipmailError, type StageAttachmentParams, type StagedAttachment, type StagedAttachmentUpload, type StatusResponse, type Subscriber, type SubscriberOutcome, type SubscriberResult, type SubscriberStatus, type Suppression, type TestWebhookResponse, type Thread, type UpdateAudienceFeedParams, type UpdateAudienceParams, type UpdateAutoReplyParams, type UpdateAutomationParams, type UpdateBookingPageParams, type UpdateCalendarEventParams, type UpdateDomainParams, type UpdateInboxMessageParams, type UpdateInboxThreadAttentionParams, type UpdateMailboxDeliveryRoutingParams, type UpdateMailboxFolderParams, type UpdateMailboxParams, type UpdateMailboxRulesParams, type UpdateNewsletterParams, type UpdateScheduledMessageParams, type UpdateSubscriberParams, type UpdateWebhookParams, type UploadNewsletterAssetParams, ValidationError, WEBHOOK_DELIVERY_EVENT_TYPES, WEBHOOK_DELIVERY_STATUSES, WEBHOOK_EVENT_TYPES, type Webhook, type WebhookDelivery, type WebhookDeliveryDetail, type WebhookDeliveryEventType, type WebhookDeliveryStatus, type WebhookEvent, type WebhookEventType, WebhookVerificationError, type WebhookWithSecret, type Weekday, ShipmailClient as default, verifyWebhook };
|
package/dist/index.d.ts
CHANGED
|
@@ -52,6 +52,14 @@ type ApiErrorBody = {
|
|
|
52
52
|
* the interrupted send attempt left behind.
|
|
53
53
|
*/
|
|
54
54
|
readonly message_id?: string | undefined;
|
|
55
|
+
/**
|
|
56
|
+
* Present only on a refusal an organization owner can lift in Shipmail. One of
|
|
57
|
+
* `owner_confirmation_required`, `subscription_required`, `trial_capacity` or
|
|
58
|
+
* `purchased_capacity`; later servers may add values.
|
|
59
|
+
*/
|
|
60
|
+
readonly reason?: string | undefined;
|
|
61
|
+
/** Present with `reason`: the Shipmail page where the owner reviews and confirms. */
|
|
62
|
+
readonly action_url?: string | undefined;
|
|
55
63
|
};
|
|
56
64
|
};
|
|
57
65
|
type EmailRecipient = {
|
|
@@ -420,9 +428,15 @@ type CalendarPerson = {
|
|
|
420
428
|
type CalendarAttendee = CalendarPerson & {
|
|
421
429
|
readonly status: "needs-action" | "accepted" | "declined" | "tentative";
|
|
422
430
|
};
|
|
431
|
+
type CalendarInvitationOutcome = {
|
|
432
|
+
readonly recipient: string;
|
|
433
|
+
readonly status: "sent" | "failed" | "unknown";
|
|
434
|
+
};
|
|
423
435
|
type CalendarEvent = {
|
|
424
436
|
readonly object: "calendar_event";
|
|
425
437
|
readonly id: string;
|
|
438
|
+
/** Content revision used as expected_revision for safe updates. */
|
|
439
|
+
readonly revision: string;
|
|
426
440
|
readonly mailbox: string;
|
|
427
441
|
readonly calendar_id: string | null;
|
|
428
442
|
readonly uid: string | null;
|
|
@@ -448,6 +462,11 @@ type CalendarEvent = {
|
|
|
448
462
|
readonly created_at: string | null;
|
|
449
463
|
readonly updated_at: string | null;
|
|
450
464
|
};
|
|
465
|
+
type CalendarEventMutationResult = CalendarEvent & {
|
|
466
|
+
readonly invitation_outcomes: readonly CalendarInvitationOutcome[];
|
|
467
|
+
/** Compatibility list containing failed and unknown recipients. */
|
|
468
|
+
readonly invitation_failures: readonly string[];
|
|
469
|
+
};
|
|
451
470
|
type ListCalendarEventsParams = PaginationParams & {
|
|
452
471
|
readonly mailbox: string;
|
|
453
472
|
readonly from: string;
|
|
@@ -463,6 +482,10 @@ type DeleteCalendarEventParams = {
|
|
|
463
482
|
};
|
|
464
483
|
type CreateCalendarEventParams = {
|
|
465
484
|
readonly mailbox: string;
|
|
485
|
+
/** Stable retry identity for this exact create payload. */
|
|
486
|
+
readonly operation_key?: string | undefined;
|
|
487
|
+
/** Whether attendees should receive invitations. Defaults to true. */
|
|
488
|
+
readonly send_invitations?: boolean | undefined;
|
|
466
489
|
readonly calendar_id?: string | undefined;
|
|
467
490
|
readonly title: string;
|
|
468
491
|
readonly invitation_language?: CalendarInvitationLanguage | undefined;
|
|
@@ -483,6 +506,12 @@ type CreateCalendarEventParams = {
|
|
|
483
506
|
};
|
|
484
507
|
type UpdateCalendarEventParams = {
|
|
485
508
|
readonly mailbox: string;
|
|
509
|
+
/** Stable retry identity for this exact update payload. */
|
|
510
|
+
readonly operation_key?: string | undefined;
|
|
511
|
+
/** Revision originally read by the editor; rejects stale guest-visible writes. */
|
|
512
|
+
readonly expected_revision?: string | undefined;
|
|
513
|
+
/** Whether attendees should receive scheduling updates. Defaults to true. */
|
|
514
|
+
readonly send_guest_updates?: boolean | undefined;
|
|
486
515
|
readonly title?: string | undefined;
|
|
487
516
|
readonly invitation_language?: CalendarInvitationLanguage | undefined;
|
|
488
517
|
readonly description?: string | null | undefined;
|
|
@@ -528,11 +557,11 @@ type CalendarAvailabilityParams = {
|
|
|
528
557
|
};
|
|
529
558
|
|
|
530
559
|
declare class CalendarEvents extends ApiResource {
|
|
531
|
-
create(params: CreateCalendarEventParams, options?: MethodOptions): Promise<
|
|
560
|
+
create(params: CreateCalendarEventParams, options?: MethodOptions): Promise<CalendarEventMutationResult>;
|
|
532
561
|
list(params: ListCalendarEventsParams, options?: MethodOptions): Promise<PaginatedResponse<CalendarEvent>>;
|
|
533
562
|
listAutoPaginating(params: Omit<ListCalendarEventsParams, "cursor">): Page<CalendarEvent>;
|
|
534
563
|
get(id: string, params: GetCalendarEventParams, options?: MethodOptions): Promise<CalendarEvent>;
|
|
535
|
-
update(id: string, params: UpdateCalendarEventParams, options?: MethodOptions): Promise<
|
|
564
|
+
update(id: string, params: UpdateCalendarEventParams, options?: MethodOptions): Promise<CalendarEventMutationResult>;
|
|
536
565
|
delete(id: string, params: DeleteCalendarEventParams, options?: MethodOptions): Promise<void>;
|
|
537
566
|
}
|
|
538
567
|
declare class Calendar extends ApiResource {
|
|
@@ -1385,6 +1414,7 @@ type MailboxForwarding = {
|
|
|
1385
1414
|
readonly mailbox_id: string;
|
|
1386
1415
|
readonly destination: string;
|
|
1387
1416
|
readonly sender: string | null;
|
|
1417
|
+
readonly recipient: string | null;
|
|
1388
1418
|
readonly status: "pending" | "active";
|
|
1389
1419
|
readonly verification_sent_at: string | null;
|
|
1390
1420
|
readonly verified_at: string | null;
|
|
@@ -1399,6 +1429,7 @@ type MailboxForwardingList = {
|
|
|
1399
1429
|
type CreateMailboxForwardingParams = {
|
|
1400
1430
|
readonly destination: string;
|
|
1401
1431
|
readonly sender?: string | null | undefined;
|
|
1432
|
+
readonly recipient?: string | null | undefined;
|
|
1402
1433
|
};
|
|
1403
1434
|
type CreateMailboxBaseParams = {
|
|
1404
1435
|
readonly domain_id: string;
|
|
@@ -1589,13 +1620,23 @@ declare class Mailboxes extends ApiResource {
|
|
|
1589
1620
|
abortImportUpload(id: string, fileId: string, options?: MethodOptions): Promise<void>;
|
|
1590
1621
|
}
|
|
1591
1622
|
|
|
1592
|
-
type MemberRole = "owner" | "
|
|
1623
|
+
type MemberRole = "owner" | "admin" | "member";
|
|
1624
|
+
type MemberMailboxAccessScope = "all" | "selected";
|
|
1625
|
+
type MemberMailboxAccess = {
|
|
1626
|
+
readonly scope: MemberMailboxAccessScope;
|
|
1627
|
+
/**
|
|
1628
|
+
* Empty when `scope` is `all`. For `selected`, API-key responses may include only the mailbox
|
|
1629
|
+
* IDs that the key can reach.
|
|
1630
|
+
*/
|
|
1631
|
+
readonly mailbox_ids: readonly string[];
|
|
1632
|
+
};
|
|
1593
1633
|
type Member = {
|
|
1594
1634
|
readonly object: "member";
|
|
1595
1635
|
readonly id: string;
|
|
1596
1636
|
readonly email: string;
|
|
1597
1637
|
readonly name: string;
|
|
1598
1638
|
readonly role: MemberRole;
|
|
1639
|
+
readonly mailbox_access: MemberMailboxAccess;
|
|
1599
1640
|
readonly created_at: string;
|
|
1600
1641
|
};
|
|
1601
1642
|
type ListMembersParams = PaginationParams;
|
|
@@ -1682,6 +1723,9 @@ type Newsletter = {
|
|
|
1682
1723
|
readonly archive_visibility: NewsletterArchiveVisibility;
|
|
1683
1724
|
readonly feed_entry_url: string | null;
|
|
1684
1725
|
readonly styling_mode: NewsletterStylingMode;
|
|
1726
|
+
readonly track_engagement: boolean;
|
|
1727
|
+
readonly opened_count: number | null;
|
|
1728
|
+
readonly clicked_count: number | null;
|
|
1685
1729
|
readonly preflight_status: NewsletterPreflightStatus;
|
|
1686
1730
|
readonly preflight_results: Record<string, unknown>;
|
|
1687
1731
|
readonly send_window_hours: number;
|
|
@@ -1770,6 +1814,7 @@ type CreateNewsletterParams = {
|
|
|
1770
1814
|
readonly archive_visibility?: NewsletterArchiveVisibility | undefined;
|
|
1771
1815
|
readonly feed_entry_url?: string | null | undefined;
|
|
1772
1816
|
readonly styling_mode?: NewsletterStylingMode | undefined;
|
|
1817
|
+
readonly track_engagement?: boolean | undefined;
|
|
1773
1818
|
};
|
|
1774
1819
|
type UpdateNewsletterParams = Partial<CreateNewsletterParams>;
|
|
1775
1820
|
type NewsletterChangelogMedia = {
|
|
@@ -2016,6 +2061,38 @@ declare class Newsletters extends ApiResource {
|
|
|
2016
2061
|
resume(id: string, options?: MethodOptions): Promise<Newsletter>;
|
|
2017
2062
|
}
|
|
2018
2063
|
|
|
2064
|
+
type OrganizationAccess = {
|
|
2065
|
+
readonly object: "organization_access";
|
|
2066
|
+
readonly organization: {
|
|
2067
|
+
readonly id: string;
|
|
2068
|
+
readonly name: string;
|
|
2069
|
+
};
|
|
2070
|
+
readonly plan: "free" | "solo" | "pro" | "team" | "scale";
|
|
2071
|
+
/** Mailboxes can be created now, by the same rule mailbox creation applies. */
|
|
2072
|
+
readonly has_access: boolean;
|
|
2073
|
+
readonly trial: {
|
|
2074
|
+
readonly active: boolean;
|
|
2075
|
+
readonly ends_at: string | null;
|
|
2076
|
+
/** No subscription yet and the owner never had a trial. Checkout still confirms it. */
|
|
2077
|
+
readonly eligible: boolean;
|
|
2078
|
+
};
|
|
2079
|
+
readonly mailboxes: {
|
|
2080
|
+
readonly limit: number;
|
|
2081
|
+
readonly used: number;
|
|
2082
|
+
};
|
|
2083
|
+
/** Newsletter sending is available. It is not during a trial. */
|
|
2084
|
+
readonly newsletters_allowed: boolean;
|
|
2085
|
+
};
|
|
2086
|
+
|
|
2087
|
+
declare class Organization extends ApiResource {
|
|
2088
|
+
/**
|
|
2089
|
+
* Whether the credential's organization can create mailboxes now, with its plan, trial and
|
|
2090
|
+
* mailbox capacity. Poll it after the owner pays: access appears once Shipmail has recorded the
|
|
2091
|
+
* payment.
|
|
2092
|
+
*/
|
|
2093
|
+
access(options?: MethodOptions): Promise<OrganizationAccess>;
|
|
2094
|
+
}
|
|
2095
|
+
|
|
2019
2096
|
type ReplyScanStatus = "completed";
|
|
2020
2097
|
type ReplyScan = {
|
|
2021
2098
|
readonly object: "reply_scan";
|
|
@@ -2250,6 +2327,7 @@ declare class ShipmailClient {
|
|
|
2250
2327
|
readonly members: Members;
|
|
2251
2328
|
readonly messages: Messages;
|
|
2252
2329
|
readonly newsletters: Newsletters;
|
|
2330
|
+
readonly organization: Organization;
|
|
2253
2331
|
readonly replyScans: ReplyScans;
|
|
2254
2332
|
readonly scheduledMessages: ScheduledMessages;
|
|
2255
2333
|
readonly suppressions: Suppressions;
|
|
@@ -2267,23 +2345,39 @@ declare class ShipmailClient {
|
|
|
2267
2345
|
private buildUrl;
|
|
2268
2346
|
}
|
|
2269
2347
|
|
|
2348
|
+
/** The `reason` values this SDK knows. A newer server may send others; they pass through. */
|
|
2349
|
+
declare const ERROR_RECOVERY_REASONS: readonly ["owner_confirmation_required", "subscription_required", "trial_capacity", "purchased_capacity"];
|
|
2350
|
+
/** What an organization owner can do in Shipmail to lift a refusal. */
|
|
2351
|
+
type ErrorRecovery = {
|
|
2352
|
+
readonly reason?: string | undefined;
|
|
2353
|
+
readonly actionUrl?: string | undefined;
|
|
2354
|
+
};
|
|
2270
2355
|
declare class ShipmailError extends Error {
|
|
2271
2356
|
readonly status: number | undefined;
|
|
2272
2357
|
readonly type: ErrorType | undefined;
|
|
2273
2358
|
readonly requestId: string | undefined;
|
|
2274
2359
|
readonly retryable: boolean;
|
|
2360
|
+
/**
|
|
2361
|
+
* Why an organization owner must act, when they can lift this refusal in Shipmail. The error's
|
|
2362
|
+
* type and status stay what they were. See ERROR_RECOVERY_REASONS.
|
|
2363
|
+
*/
|
|
2364
|
+
readonly reason: string | undefined;
|
|
2365
|
+
/** The Shipmail page to send the owner to. Retry with a new idempotency key afterwards. */
|
|
2366
|
+
readonly actionUrl: string | undefined;
|
|
2275
2367
|
constructor(message: string, options?: {
|
|
2276
2368
|
readonly status?: number | undefined;
|
|
2277
2369
|
readonly type?: ErrorType | undefined;
|
|
2278
2370
|
readonly requestId?: string | undefined;
|
|
2279
2371
|
readonly retryable?: boolean | undefined;
|
|
2372
|
+
readonly reason?: string | undefined;
|
|
2373
|
+
readonly actionUrl?: string | undefined;
|
|
2280
2374
|
});
|
|
2281
2375
|
}
|
|
2282
2376
|
declare class AuthenticationError extends ShipmailError {
|
|
2283
2377
|
constructor(message: string, requestId?: string);
|
|
2284
2378
|
}
|
|
2285
2379
|
declare class AuthorizationError extends ShipmailError {
|
|
2286
|
-
constructor(message: string, requestId?: string);
|
|
2380
|
+
constructor(message: string, requestId?: string, recovery?: ErrorRecovery);
|
|
2287
2381
|
}
|
|
2288
2382
|
declare class ValidationError extends ShipmailError {
|
|
2289
2383
|
readonly details: readonly {
|
|
@@ -2298,10 +2392,12 @@ declare class ValidationError extends ShipmailError {
|
|
|
2298
2392
|
readonly message: string;
|
|
2299
2393
|
readonly code?: string | undefined;
|
|
2300
2394
|
}[] | undefined;
|
|
2395
|
+
readonly reason?: string | undefined;
|
|
2396
|
+
readonly actionUrl?: string | undefined;
|
|
2301
2397
|
});
|
|
2302
2398
|
}
|
|
2303
2399
|
declare class QuotaExceededError extends ShipmailError {
|
|
2304
|
-
constructor(message: string, requestId?: string);
|
|
2400
|
+
constructor(message: string, requestId?: string, recovery?: ErrorRecovery);
|
|
2305
2401
|
}
|
|
2306
2402
|
declare class NotFoundError extends ShipmailError {
|
|
2307
2403
|
constructor(message: string, requestId?: string);
|
|
@@ -2351,4 +2447,4 @@ declare function verifyWebhook(body: string, headers: WebhookHeaders | Headers,
|
|
|
2351
2447
|
readonly toleranceInSeconds?: number | undefined;
|
|
2352
2448
|
}): Promise<WebhookEvent>;
|
|
2353
2449
|
|
|
2354
|
-
export { type AddSubscriberParams, type AddSubscribersBatchParams, type AddSubscribersBatchResult, type ApiErrorBody, type Audience, type AudienceFeed, AuthenticationError, AuthorizationError, type Automation, type AutomationAction, type AutomationCondition, type AutomationDefinition, type AutomationRun, type AutomationRunStatus, type AutomationRunSummary, type AutomationStatus, type AutomationTrigger, type BookingPage, CONFERENCING_PROVIDER_IDS, type CalendarAvailability, type CalendarAvailabilityParams, type CalendarAvailabilitySlot, type CalendarEvent, type CalendarEventPrivacy, type CalendarEventStatus, type CalendarFreeBusyStatus, type CalendarInvitationLanguage, type CapabilitiesResponse, type CapabilityResourceConstraints, type ConferencingProviderId, ConflictError, ConnectionError, type CreateAudienceParams, type CreateAutomationParams, type CreateBookingPageParams, type CreateCalendarEventParams, type CreateDomainParams, type CreateInboxDraftParams, type CreateInboxReplyDraftParams, type CreateMailboxAppPasswordParams, type CreateMailboxFolderParams, type CreateMailboxParams, type CreateNewsletterFromChangelogParams, type CreateNewsletterParams, type CreateReplyScanParams, type CreateWebhookParams, type CreatedMailboxAppPassword, DOMAIN_STATUSES, type DataMode, type DeleteCalendarEventParams, type Domain, type DomainDnsRecord, type DomainDnsRecordKey, type DomainDnsRecordSet, type DomainDnsRecordStatus, type DomainRegistrationInfo, type DomainSearchResult, type DomainStatus, type DomainVerificationResult, type DownloadInboxAttachmentParams, type EmailAuthVerdict, type EmailAuthenticationResults, type EmailRecipient, type EmailRecipientInput, type ErrorType, type GetCalendarEventParams, type GetThreadParams, type InboxAttachment, type InboxBodyPart, type InboxBodyValue, type InboxDraft, type InboxDraftRecipient, type InboxEmailHeader, type InboxFullMessage, type InboxKeyword, type InboxMessage, type InboxMessageAction, type InboxMessages, type InboxReplyDraft, type InboxReplyDraftSend, type InboxThread, type InboxThreadAttentionResult, type InboxThreadAttentionState, type InboxThreadSummary, type InboxThreads, type InjectSandboxInboundParams, InternalServerError, type ListAudiencesParams, type ListAutomationsResponse, type ListBookingPagesParams, type ListCalendarEventsParams, type ListDeliveriesParams, type ListDomainsParams, type ListInboxMessagesParams, type ListInboxThreadsParams, type ListMailboxesParams, type ListMembersParams, type ListMessageAnalyticsParams, type ListMessagesParams, type ListNewsletterAssetsParams, type ListNewsletterDomainsParams, type ListNewsletterSenderIdentitiesParams, type ListNewslettersParams, type ListReplyScanResultsParams, type ListScheduledMessagesParams, type ListSubscribersParams, type ListSuppressionsParams, type ListThreadsParams, type ListWebhooksParams, MESSAGE_SOURCES, MESSAGE_STATUSES, type Mailbox, type MailboxAppPassword, type MailboxAppPasswordList, type MailboxAppPasswordPurpose, type MailboxAppPasswordState, type MailboxDeliveryDestination, type MailboxDeliveryRouting, type MailboxExport, type MailboxExportErrorCode, type MailboxExportStatus, type MailboxFolder, type MailboxFolders, type MailboxIdentities, type MailboxIdentity, type MailboxRule, type MailboxRuleAction, type MailboxRuleCondition, type MailboxRuleFolder, type MailboxRuleMatchMode, type MailboxRuleMoveTarget, type MailboxRules, type Member, type MemberRole, type MergeFields, type Message, type MessageAnalytics, type MessageAnalyticsPage, type MessageMetadata, type MessageRuleDisposition, type MessageSource, type MessageStatus, type MethodOptions, type MoveInboxMessageParams, type Newsletter, type NewsletterArchiveVisibility, type NewsletterAsset, type NewsletterAssetContentType, type NewsletterAssetKind, type NewsletterAssetListResponse, type NewsletterAssetStorageUsage, type NewsletterAssetUpload, type NewsletterBlock, type NewsletterButtonAlign, type NewsletterCalloutVariant, type NewsletterChangelogEntry, type NewsletterChangelogMedia, type NewsletterChangelogTone, type NewsletterColumnContent, type NewsletterColumnImageFit, type NewsletterColumnRatio, type NewsletterCountedUrl, type NewsletterDomain, type NewsletterDomainRecordStatus, type NewsletterDomainStatus, type NewsletterPreflight, type NewsletterPreflightItem, type NewsletterPreflightItemStatus, type NewsletterPreflightStatus, type NewsletterPreview, type NewsletterSenderIdentity, type NewsletterStatus, type NewsletterStylingMode, type NewsletterTestSend, type NewsletterTestSendStatus, type NewsletterUrlBreakdown, type NewsletterUrlSource, NotFoundError, type OneTimeSecretMethodOptions, type OutboundHeader, Page, type PaginatedResponse, type PaginationParams, type PrepareNewsletterAssetUploadParams, type PrepareStagedAttachmentUploadParams, QuotaExceededError, RateLimitError, ReconciliationRequiredError, type Recurrence, type RecurrenceFrequency, type RecurrenceNDay, type RegisterDomainParams, type RegisterNewsletterAssetFromUrlParams, type RegistrationContact, type Reminder, type ReplyScan, type ReplyScanCandidate, type ReplyScanResults, type ReplyScanStatus, type ReplyToMessageParams, type ReplyToThreadParams, type RequestOptions, type ResetMailboxPasswordParams, type RotateSecretResponse, type SandboxOutcome, type ScheduleNewsletterParams, type ScheduledMessage, type ScheduledMessageAttachment, type ScheduledMessageList, type ScheduledMessageRecipient, type ScheduledMessageUploadedAttachment, type SearchDomainsParams, type SendMessageParams, type SendNewsletterTestParams, ShipmailClient, type ShipmailConfig, ShipmailError, type StageAttachmentParams, type StagedAttachment, type StagedAttachmentUpload, type StatusResponse, type Subscriber, type SubscriberOutcome, type SubscriberResult, type SubscriberStatus, type Suppression, type TestWebhookResponse, type Thread, type UpdateAudienceFeedParams, type UpdateAudienceParams, type UpdateAutoReplyParams, type UpdateAutomationParams, type UpdateBookingPageParams, type UpdateCalendarEventParams, type UpdateDomainParams, type UpdateInboxMessageParams, type UpdateInboxThreadAttentionParams, type UpdateMailboxDeliveryRoutingParams, type UpdateMailboxFolderParams, type UpdateMailboxParams, type UpdateMailboxRulesParams, type UpdateNewsletterParams, type UpdateScheduledMessageParams, type UpdateSubscriberParams, type UpdateWebhookParams, type UploadNewsletterAssetParams, ValidationError, WEBHOOK_DELIVERY_EVENT_TYPES, WEBHOOK_DELIVERY_STATUSES, WEBHOOK_EVENT_TYPES, type Webhook, type WebhookDelivery, type WebhookDeliveryDetail, type WebhookDeliveryEventType, type WebhookDeliveryStatus, type WebhookEvent, type WebhookEventType, WebhookVerificationError, type WebhookWithSecret, type Weekday, ShipmailClient as default, verifyWebhook };
|
|
2450
|
+
export { type AddSubscriberParams, type AddSubscribersBatchParams, type AddSubscribersBatchResult, type ApiErrorBody, type Audience, type AudienceFeed, AuthenticationError, AuthorizationError, type Automation, type AutomationAction, type AutomationCondition, type AutomationDefinition, type AutomationRun, type AutomationRunStatus, type AutomationRunSummary, type AutomationStatus, type AutomationTrigger, type BookingPage, CONFERENCING_PROVIDER_IDS, type CalendarAvailability, type CalendarAvailabilityParams, type CalendarAvailabilitySlot, type CalendarEvent, type CalendarEventMutationResult, type CalendarEventPrivacy, type CalendarEventStatus, type CalendarFreeBusyStatus, type CalendarInvitationLanguage, type CalendarInvitationOutcome, type CapabilitiesResponse, type CapabilityResourceConstraints, type ConferencingProviderId, ConflictError, ConnectionError, type CreateAudienceParams, type CreateAutomationParams, type CreateBookingPageParams, type CreateCalendarEventParams, type CreateDomainParams, type CreateInboxDraftParams, type CreateInboxReplyDraftParams, type CreateMailboxAppPasswordParams, type CreateMailboxFolderParams, type CreateMailboxForwardingParams, type CreateMailboxParams, type CreateNewsletterFromChangelogParams, type CreateNewsletterParams, type CreateReplyScanParams, type CreateWebhookParams, type CreatedMailboxAppPassword, DOMAIN_STATUSES, type DataMode, type DeleteCalendarEventParams, type Domain, type DomainDnsRecord, type DomainDnsRecordKey, type DomainDnsRecordSet, type DomainDnsRecordStatus, type DomainRegistrationInfo, type DomainSearchResult, type DomainStatus, type DomainVerificationResult, type DownloadInboxAttachmentParams, ERROR_RECOVERY_REASONS, type EmailAuthVerdict, type EmailAuthenticationResults, type EmailRecipient, type EmailRecipientInput, type ErrorRecovery, type ErrorType, type GetCalendarEventParams, type GetThreadParams, type InboxAttachment, type InboxBodyPart, type InboxBodyValue, type InboxDraft, type InboxDraftRecipient, type InboxEmailHeader, type InboxFullMessage, type InboxKeyword, type InboxMessage, type InboxMessageAction, type InboxMessages, type InboxReplyDraft, type InboxReplyDraftSend, type InboxThread, type InboxThreadAttentionResult, type InboxThreadAttentionState, type InboxThreadSummary, type InboxThreads, type InjectSandboxInboundParams, InternalServerError, type ListAudiencesParams, type ListAutomationsResponse, type ListBookingPagesParams, type ListCalendarEventsParams, type ListDeliveriesParams, type ListDomainsParams, type ListInboxMessagesParams, type ListInboxThreadsParams, type ListMailboxesParams, type ListMembersParams, type ListMessageAnalyticsParams, type ListMessagesParams, type ListNewsletterAssetsParams, type ListNewsletterDomainsParams, type ListNewsletterSenderIdentitiesParams, type ListNewslettersParams, type ListReplyScanResultsParams, type ListScheduledMessagesParams, type ListSubscribersParams, type ListSuppressionsParams, type ListThreadsParams, type ListWebhooksParams, MESSAGE_SOURCES, MESSAGE_STATUSES, type Mailbox, type MailboxAppPassword, type MailboxAppPasswordList, type MailboxAppPasswordPurpose, type MailboxAppPasswordState, type MailboxDeliveryDestination, type MailboxDeliveryRouting, type MailboxExport, type MailboxExportErrorCode, type MailboxExportStatus, type MailboxFolder, type MailboxFolders, type MailboxForwarding, type MailboxForwardingList, type MailboxIdentities, type MailboxIdentity, type MailboxRule, type MailboxRuleAction, type MailboxRuleCondition, type MailboxRuleFolder, type MailboxRuleMatchMode, type MailboxRuleMoveTarget, type MailboxRules, type Member, type MemberMailboxAccess, type MemberMailboxAccessScope, type MemberRole, type MergeFields, type Message, type MessageAnalytics, type MessageAnalyticsPage, type MessageMetadata, type MessageRuleDisposition, type MessageSource, type MessageStatus, type MethodOptions, type MoveInboxMessageParams, type Newsletter, type NewsletterArchiveVisibility, type NewsletterAsset, type NewsletterAssetContentType, type NewsletterAssetKind, type NewsletterAssetListResponse, type NewsletterAssetStorageUsage, type NewsletterAssetUpload, type NewsletterBlock, type NewsletterButtonAlign, type NewsletterCalloutVariant, type NewsletterChangelogEntry, type NewsletterChangelogMedia, type NewsletterChangelogTone, type NewsletterColumnContent, type NewsletterColumnImageFit, type NewsletterColumnRatio, type NewsletterCountedUrl, type NewsletterDomain, type NewsletterDomainRecordStatus, type NewsletterDomainStatus, type NewsletterPreflight, type NewsletterPreflightItem, type NewsletterPreflightItemStatus, type NewsletterPreflightStatus, type NewsletterPreview, type NewsletterSenderIdentity, type NewsletterStatus, type NewsletterStylingMode, type NewsletterTestSend, type NewsletterTestSendStatus, type NewsletterUrlBreakdown, type NewsletterUrlSource, NotFoundError, type OneTimeSecretMethodOptions, type OrganizationAccess, type OutboundHeader, Page, type PaginatedResponse, type PaginationParams, type PrepareNewsletterAssetUploadParams, type PrepareStagedAttachmentUploadParams, QuotaExceededError, RateLimitError, ReconciliationRequiredError, type Recurrence, type RecurrenceFrequency, type RecurrenceNDay, type RegisterDomainParams, type RegisterNewsletterAssetFromUrlParams, type RegistrationContact, type Reminder, type ReplyScan, type ReplyScanCandidate, type ReplyScanResults, type ReplyScanStatus, type ReplyToMessageParams, type ReplyToThreadParams, type RequestOptions, type ResetMailboxPasswordParams, type RotateSecretResponse, type SandboxOutcome, type ScheduleNewsletterParams, type ScheduledMessage, type ScheduledMessageAttachment, type ScheduledMessageList, type ScheduledMessageRecipient, type ScheduledMessageUploadedAttachment, type SearchDomainsParams, type SendMessageParams, type SendNewsletterTestParams, ShipmailClient, type ShipmailConfig, ShipmailError, type StageAttachmentParams, type StagedAttachment, type StagedAttachmentUpload, type StatusResponse, type Subscriber, type SubscriberOutcome, type SubscriberResult, type SubscriberStatus, type Suppression, type TestWebhookResponse, type Thread, type UpdateAudienceFeedParams, type UpdateAudienceParams, type UpdateAutoReplyParams, type UpdateAutomationParams, type UpdateBookingPageParams, type UpdateCalendarEventParams, type UpdateDomainParams, type UpdateInboxMessageParams, type UpdateInboxThreadAttentionParams, type UpdateMailboxDeliveryRoutingParams, type UpdateMailboxFolderParams, type UpdateMailboxParams, type UpdateMailboxRulesParams, type UpdateNewsletterParams, type UpdateScheduledMessageParams, type UpdateSubscriberParams, type UpdateWebhookParams, type UploadNewsletterAssetParams, ValidationError, WEBHOOK_DELIVERY_EVENT_TYPES, WEBHOOK_DELIVERY_STATUSES, WEBHOOK_EVENT_TYPES, type Webhook, type WebhookDelivery, type WebhookDeliveryDetail, type WebhookDeliveryEventType, type WebhookDeliveryStatus, type WebhookEvent, type WebhookEventType, WebhookVerificationError, type WebhookWithSecret, type Weekday, ShipmailClient as default, verifyWebhook };
|