shipmail 0.1.29 → 0.1.31
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/dist/index.cjs +138 -2
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +217 -5
- package/dist/index.d.ts +217 -5
- package/dist/index.js +138 -2
- package/dist/index.js.map +1 -1
- package/package.json +2 -1
package/dist/index.d.cts
CHANGED
|
@@ -60,9 +60,9 @@ type StatusResponse = {
|
|
|
60
60
|
};
|
|
61
61
|
declare const DOMAIN_STATUSES: readonly ["pending", "verifying", "verified", "degraded", "failed"];
|
|
62
62
|
type DomainStatus = (typeof DOMAIN_STATUSES)[number];
|
|
63
|
-
declare const MESSAGE_STATUSES: readonly ["scheduled", "queued", "sent", "delivered", "bounced", "complained", "failed", "cancelled"];
|
|
63
|
+
declare const MESSAGE_STATUSES: readonly ["scheduled", "queued", "sent", "delivered", "bounced", "complained", "failed", "suppressed", "cancelled"];
|
|
64
64
|
type MessageStatus = (typeof MESSAGE_STATUSES)[number];
|
|
65
|
-
declare const MESSAGE_SOURCES: readonly ["api", "dashboard", "inbound", "smtp"];
|
|
65
|
+
declare const MESSAGE_SOURCES: readonly ["api", "newsletter", "dashboard", "inbound", "smtp"];
|
|
66
66
|
type MessageSource = (typeof MESSAGE_SOURCES)[number];
|
|
67
67
|
declare const WEBHOOK_DELIVERY_STATUSES: readonly ["pending", "delivered", "failed"];
|
|
68
68
|
type WebhookDeliveryStatus = (typeof WEBHOOK_DELIVERY_STATUSES)[number];
|
|
@@ -74,7 +74,7 @@ type MethodOptions = {
|
|
|
74
74
|
};
|
|
75
75
|
|
|
76
76
|
type MergeFields = Record<string, string | number | boolean | null>;
|
|
77
|
-
type SubscriberStatus = "subscribed" | "unsubscribed" | "bounced" | "complained" | "suppressed" | "transactional_only";
|
|
77
|
+
type SubscriberStatus = "subscribed" | "pending" | "unsubscribed" | "bounced" | "complained" | "suppressed" | "transactional_only";
|
|
78
78
|
type SubscriberOutcome = "created" | "updated" | "skipped_not_mailable" | "skipped_invalid" | "skipped_cap" | "skipped_quota";
|
|
79
79
|
type Audience = {
|
|
80
80
|
readonly object: "audience";
|
|
@@ -161,12 +161,221 @@ declare class Audiences extends ApiResource {
|
|
|
161
161
|
delete(id: string, options?: MethodOptions): Promise<void>;
|
|
162
162
|
}
|
|
163
163
|
|
|
164
|
+
type BookingPage = {
|
|
165
|
+
readonly object: "booking_page";
|
|
166
|
+
readonly id: string;
|
|
167
|
+
readonly mailbox: string;
|
|
168
|
+
readonly slug: string;
|
|
169
|
+
readonly url: string | null;
|
|
170
|
+
readonly name: string;
|
|
171
|
+
readonly description: string | null;
|
|
172
|
+
readonly duration_minutes: number;
|
|
173
|
+
readonly availability_days: readonly number[];
|
|
174
|
+
readonly window_start_minutes: number;
|
|
175
|
+
readonly window_end_minutes: number;
|
|
176
|
+
readonly timezone: string;
|
|
177
|
+
readonly buffer_minutes: number;
|
|
178
|
+
readonly minimum_notice_minutes: number;
|
|
179
|
+
readonly max_advance_days: number;
|
|
180
|
+
readonly active: boolean;
|
|
181
|
+
readonly created_at: string;
|
|
182
|
+
readonly updated_at: string;
|
|
183
|
+
};
|
|
184
|
+
type ListBookingPagesParams = PaginationParams;
|
|
185
|
+
type CreateBookingPageParams = {
|
|
186
|
+
readonly name: string;
|
|
187
|
+
readonly mailbox: string;
|
|
188
|
+
readonly slug: string;
|
|
189
|
+
readonly duration_minutes: number;
|
|
190
|
+
readonly availability_days: readonly number[];
|
|
191
|
+
readonly window_start_minutes: number;
|
|
192
|
+
readonly window_end_minutes: number;
|
|
193
|
+
readonly timezone: string;
|
|
194
|
+
readonly description?: string | null | undefined;
|
|
195
|
+
readonly buffer_minutes?: number | undefined;
|
|
196
|
+
readonly minimum_notice_minutes?: number | undefined;
|
|
197
|
+
readonly max_advance_days?: number | undefined;
|
|
198
|
+
readonly active?: boolean | undefined;
|
|
199
|
+
};
|
|
200
|
+
type UpdateBookingPageParams = {
|
|
201
|
+
readonly name?: string | undefined;
|
|
202
|
+
readonly mailbox?: string | undefined;
|
|
203
|
+
readonly slug?: string | undefined;
|
|
204
|
+
readonly duration_minutes?: number | undefined;
|
|
205
|
+
readonly availability_days?: readonly number[] | undefined;
|
|
206
|
+
readonly window_start_minutes?: number | undefined;
|
|
207
|
+
readonly window_end_minutes?: number | undefined;
|
|
208
|
+
readonly timezone?: string | undefined;
|
|
209
|
+
readonly description?: string | null | undefined;
|
|
210
|
+
readonly buffer_minutes?: number | undefined;
|
|
211
|
+
readonly minimum_notice_minutes?: number | undefined;
|
|
212
|
+
readonly max_advance_days?: number | undefined;
|
|
213
|
+
readonly active?: boolean | undefined;
|
|
214
|
+
};
|
|
215
|
+
|
|
216
|
+
declare class BookingPages extends ApiResource {
|
|
217
|
+
create(params: CreateBookingPageParams, options?: MethodOptions): Promise<BookingPage>;
|
|
218
|
+
list(params?: ListBookingPagesParams, options?: MethodOptions): Promise<PaginatedResponse<BookingPage>>;
|
|
219
|
+
listAutoPaginating(params?: Omit<ListBookingPagesParams, "cursor">): Page<BookingPage>;
|
|
220
|
+
get(id: string, options?: MethodOptions): Promise<BookingPage>;
|
|
221
|
+
update(id: string, params: UpdateBookingPageParams, options?: MethodOptions): Promise<BookingPage>;
|
|
222
|
+
delete(id: string, options?: MethodOptions): Promise<void>;
|
|
223
|
+
}
|
|
224
|
+
|
|
225
|
+
type CalendarEventStatus = "confirmed" | "tentative" | "cancelled";
|
|
226
|
+
type CalendarFreeBusyStatus = "free" | "busy";
|
|
227
|
+
type CalendarEventPrivacy = "public" | "private" | "secret";
|
|
228
|
+
type RecurrenceFrequency = "yearly" | "monthly" | "weekly" | "daily" | "hourly" | "minutely" | "secondly";
|
|
229
|
+
type Weekday = "mo" | "tu" | "we" | "th" | "fr" | "sa" | "su";
|
|
230
|
+
type RecurrenceNDay = {
|
|
231
|
+
readonly day: Weekday;
|
|
232
|
+
readonly nth_of_period?: number | undefined;
|
|
233
|
+
};
|
|
234
|
+
type Recurrence = {
|
|
235
|
+
readonly frequency: RecurrenceFrequency;
|
|
236
|
+
readonly interval?: number | undefined;
|
|
237
|
+
readonly count?: number | undefined;
|
|
238
|
+
readonly until?: string | undefined;
|
|
239
|
+
readonly by_day?: readonly RecurrenceNDay[] | undefined;
|
|
240
|
+
};
|
|
241
|
+
type Reminder = {
|
|
242
|
+
readonly minutes_before: number;
|
|
243
|
+
};
|
|
244
|
+
type CalendarAttendeeInput = {
|
|
245
|
+
readonly email: string;
|
|
246
|
+
readonly name?: string | undefined;
|
|
247
|
+
};
|
|
248
|
+
type CalendarPerson = {
|
|
249
|
+
readonly email: string;
|
|
250
|
+
readonly name: string | null;
|
|
251
|
+
};
|
|
252
|
+
type CalendarAttendee = CalendarPerson & {
|
|
253
|
+
readonly status: "needs-action" | "accepted" | "declined" | "tentative";
|
|
254
|
+
};
|
|
255
|
+
type CalendarEvent = {
|
|
256
|
+
readonly object: "calendar_event";
|
|
257
|
+
readonly id: string;
|
|
258
|
+
readonly mailbox: string;
|
|
259
|
+
readonly calendar_id: string | null;
|
|
260
|
+
readonly uid: string | null;
|
|
261
|
+
readonly title: string | null;
|
|
262
|
+
readonly description: string | null;
|
|
263
|
+
readonly location: string | null;
|
|
264
|
+
readonly video_url: string | null;
|
|
265
|
+
readonly all_day: boolean;
|
|
266
|
+
readonly start: string;
|
|
267
|
+
readonly end: string;
|
|
268
|
+
readonly timezone: string | null;
|
|
269
|
+
readonly duration: string | null;
|
|
270
|
+
readonly status: CalendarEventStatus | null;
|
|
271
|
+
readonly free_busy_status: CalendarFreeBusyStatus | null;
|
|
272
|
+
readonly privacy: CalendarEventPrivacy | null;
|
|
273
|
+
readonly color: string | null;
|
|
274
|
+
readonly recurrence: Recurrence | null;
|
|
275
|
+
readonly recurrence_id: string | null;
|
|
276
|
+
readonly reminders: readonly Reminder[];
|
|
277
|
+
readonly organizer: CalendarPerson | null;
|
|
278
|
+
readonly attendees: readonly CalendarAttendee[];
|
|
279
|
+
readonly created_at: string | null;
|
|
280
|
+
readonly updated_at: string | null;
|
|
281
|
+
};
|
|
282
|
+
type ListCalendarEventsParams = PaginationParams & {
|
|
283
|
+
readonly mailbox: string;
|
|
284
|
+
readonly from: string;
|
|
285
|
+
readonly to: string;
|
|
286
|
+
readonly expand?: boolean | undefined;
|
|
287
|
+
readonly calendar_id?: string | undefined;
|
|
288
|
+
};
|
|
289
|
+
type GetCalendarEventParams = {
|
|
290
|
+
readonly mailbox: string;
|
|
291
|
+
};
|
|
292
|
+
type DeleteCalendarEventParams = {
|
|
293
|
+
readonly mailbox: string;
|
|
294
|
+
};
|
|
295
|
+
type CreateCalendarEventParams = {
|
|
296
|
+
readonly mailbox: string;
|
|
297
|
+
readonly calendar_id?: string | undefined;
|
|
298
|
+
readonly title: string;
|
|
299
|
+
readonly start: string;
|
|
300
|
+
readonly description?: string | undefined;
|
|
301
|
+
readonly timezone?: string | undefined;
|
|
302
|
+
readonly duration?: string | undefined;
|
|
303
|
+
readonly all_day?: boolean | undefined;
|
|
304
|
+
readonly location?: string | undefined;
|
|
305
|
+
readonly video_url?: string | undefined;
|
|
306
|
+
readonly color?: string | undefined;
|
|
307
|
+
readonly status?: CalendarEventStatus | undefined;
|
|
308
|
+
readonly free_busy_status?: CalendarFreeBusyStatus | undefined;
|
|
309
|
+
readonly privacy?: CalendarEventPrivacy | undefined;
|
|
310
|
+
readonly recurrence?: Recurrence | undefined;
|
|
311
|
+
readonly reminders?: readonly Reminder[] | undefined;
|
|
312
|
+
readonly attendees?: readonly CalendarAttendeeInput[] | undefined;
|
|
313
|
+
};
|
|
314
|
+
type UpdateCalendarEventParams = {
|
|
315
|
+
readonly mailbox: string;
|
|
316
|
+
readonly title?: string | undefined;
|
|
317
|
+
readonly description?: string | null | undefined;
|
|
318
|
+
readonly start?: string | undefined;
|
|
319
|
+
readonly timezone?: string | null | undefined;
|
|
320
|
+
readonly duration?: string | undefined;
|
|
321
|
+
readonly all_day?: boolean | undefined;
|
|
322
|
+
readonly location?: string | null | undefined;
|
|
323
|
+
readonly video_url?: string | null | undefined;
|
|
324
|
+
readonly color?: string | undefined;
|
|
325
|
+
readonly status?: CalendarEventStatus | undefined;
|
|
326
|
+
readonly free_busy_status?: CalendarFreeBusyStatus | undefined;
|
|
327
|
+
readonly privacy?: CalendarEventPrivacy | undefined;
|
|
328
|
+
readonly recurrence?: Recurrence | null | undefined;
|
|
329
|
+
readonly reminders?: readonly Reminder[] | null | undefined;
|
|
330
|
+
readonly attendees?: readonly CalendarAttendeeInput[] | undefined;
|
|
331
|
+
};
|
|
332
|
+
type CalendarAvailabilitySlot = {
|
|
333
|
+
readonly start: string;
|
|
334
|
+
readonly end: string;
|
|
335
|
+
};
|
|
336
|
+
type CalendarAvailability = {
|
|
337
|
+
readonly object: "calendar_availability";
|
|
338
|
+
readonly mailbox: string;
|
|
339
|
+
readonly from: string;
|
|
340
|
+
readonly to: string;
|
|
341
|
+
readonly duration_minutes: number;
|
|
342
|
+
readonly timezone: string;
|
|
343
|
+
readonly slots: readonly CalendarAvailabilitySlot[];
|
|
344
|
+
};
|
|
345
|
+
type CalendarAvailabilityParams = {
|
|
346
|
+
readonly mailbox: string;
|
|
347
|
+
readonly from: string;
|
|
348
|
+
readonly to: string;
|
|
349
|
+
readonly duration?: number | undefined;
|
|
350
|
+
readonly interval?: number | undefined;
|
|
351
|
+
readonly timezone?: string | undefined;
|
|
352
|
+
readonly days?: readonly number[] | undefined;
|
|
353
|
+
readonly window_start?: number | undefined;
|
|
354
|
+
readonly window_end?: number | undefined;
|
|
355
|
+
readonly buffer?: number | undefined;
|
|
356
|
+
readonly minimum_notice?: number | undefined;
|
|
357
|
+
};
|
|
358
|
+
|
|
359
|
+
declare class CalendarEvents extends ApiResource {
|
|
360
|
+
create(params: CreateCalendarEventParams, options?: MethodOptions): Promise<CalendarEvent>;
|
|
361
|
+
list(params: ListCalendarEventsParams, options?: MethodOptions): Promise<PaginatedResponse<CalendarEvent>>;
|
|
362
|
+
listAutoPaginating(params: Omit<ListCalendarEventsParams, "cursor">): Page<CalendarEvent>;
|
|
363
|
+
get(id: string, params: GetCalendarEventParams, options?: MethodOptions): Promise<CalendarEvent>;
|
|
364
|
+
update(id: string, params: UpdateCalendarEventParams, options?: MethodOptions): Promise<CalendarEvent>;
|
|
365
|
+
delete(id: string, params: DeleteCalendarEventParams, options?: MethodOptions): Promise<void>;
|
|
366
|
+
}
|
|
367
|
+
declare class Calendar extends ApiResource {
|
|
368
|
+
readonly events: CalendarEvents;
|
|
369
|
+
constructor(client: ShipMailClient);
|
|
370
|
+
availability(params: CalendarAvailabilityParams, options?: MethodOptions): Promise<CalendarAvailability>;
|
|
371
|
+
}
|
|
372
|
+
|
|
164
373
|
type Domain = {
|
|
165
374
|
readonly object: "domain";
|
|
166
375
|
readonly id: string;
|
|
167
376
|
readonly name: string;
|
|
168
377
|
readonly status: DomainStatus;
|
|
169
|
-
readonly managed_by: "external" | "
|
|
378
|
+
readonly managed_by: "external" | "shipmail";
|
|
170
379
|
readonly dns_provider: string | null;
|
|
171
380
|
readonly mx_verified: boolean;
|
|
172
381
|
readonly spf_verified: boolean;
|
|
@@ -506,6 +715,7 @@ type MailboxRuleAction = {
|
|
|
506
715
|
readonly type: "ai_draft_reply";
|
|
507
716
|
readonly instructions: string;
|
|
508
717
|
readonly reply_mode: "reply" | "reply_all";
|
|
718
|
+
readonly agent_policy: "observe_only" | "draft_for_review";
|
|
509
719
|
};
|
|
510
720
|
type MailboxRule = {
|
|
511
721
|
readonly id: string;
|
|
@@ -1159,6 +1369,8 @@ declare class ShipMailClient {
|
|
|
1159
1369
|
private readonly fetchFn;
|
|
1160
1370
|
private readonly defaultHeaders;
|
|
1161
1371
|
readonly audiences: Audiences;
|
|
1372
|
+
readonly bookingPages: BookingPages;
|
|
1373
|
+
readonly calendar: Calendar;
|
|
1162
1374
|
readonly domains: Domains;
|
|
1163
1375
|
readonly mailboxes: Mailboxes;
|
|
1164
1376
|
readonly messages: Messages;
|
|
@@ -1251,4 +1463,4 @@ declare function verifyWebhook(body: string, headers: WebhookHeaders | Headers,
|
|
|
1251
1463
|
readonly toleranceInSeconds?: number | undefined;
|
|
1252
1464
|
}): Promise<WebhookEvent>;
|
|
1253
1465
|
|
|
1254
|
-
export { type AddSubscriberParams, type AddSubscribersBatchParams, type AddSubscribersBatchResult, type ApiErrorBody, type Audience, AuthenticationError, AuthorizationError, ConflictError, ConnectionError, type CreateAudienceParams, type CreateDomainParams, type CreateMailboxFolderParams, type CreateMailboxParams, type CreateNewsletterFromChangelogParams, type CreateNewsletterParams, type CreateWebhookParams, DOMAIN_STATUSES, type Domain, type DomainRegistrationInfo, type DomainSearchResult, type DomainStatus, type DomainVerificationResult, type DownloadInboxAttachmentParams, type EmailRecipient, type EmailRecipientInput, type ErrorType, type GetThreadParams, type InboxAttachment, type InboxBodyPart, type InboxBodyValue, type InboxEmailHeader, type InboxFullMessage, type InboxKeyword, type InboxMessage, type InboxMessageAction, type InboxMessages, type InboxThread, InternalServerError, type ListAudiencesParams, type ListDeliveriesParams, type ListDomainsParams, type ListInboxMessagesParams, type ListMailboxesParams, type ListMessagesParams, type ListNewsletterAssetsParams, type ListNewsletterDomainsParams, type ListNewslettersParams, type ListSubscribersParams, type ListSuppressionsParams, type ListThreadsParams, type ListWebhooksParams, MESSAGE_SOURCES, MESSAGE_STATUSES, type Mailbox, type MailboxFolder, type MailboxFolders, type MailboxIdentities, type MailboxIdentity, type MailboxRule, type MailboxRuleAction, type MailboxRuleCondition, type MailboxRuleFolder, type MailboxRuleMatchMode, type MailboxRuleMoveTarget, type MailboxRules, type MergeFields, type Message, type MessageSource, type MessageStatus, type MethodOptions, type MoveInboxMessageParams, type Newsletter, type NewsletterArchiveVisibility, type NewsletterAsset, type NewsletterAssetKind, type NewsletterAssetListResponse, type NewsletterAssetStorageUsage, type NewsletterBlock, type NewsletterButtonAlign, type NewsletterCalloutVariant, type NewsletterChangelogEntry, type NewsletterChangelogMedia, type NewsletterChangelogTone, type NewsletterColumnContent, type NewsletterColumnRatio, type NewsletterCountedUrl, type NewsletterDomain, type NewsletterDomainRecordStatus, type NewsletterDomainStatus, type NewsletterPreflight, type NewsletterPreflightItem, type NewsletterPreflightItemStatus, type NewsletterPreflightStatus, type NewsletterPreview, type NewsletterStatus, type NewsletterTestSend, type NewsletterTestSendStatus, type NewsletterUrlBreakdown, type NewsletterUrlSource, NotFoundError, Page, type PaginatedResponse, type PaginationParams, QuotaExceededError, RateLimitError, type RegisterDomainParams, type RegisterNewsletterAssetFromUrlParams, type RegistrationContact, type ReplyToMessageParams, type ReplyToThreadParams, type RequestOptions, type ResetMailboxPasswordParams, type RotateSecretResponse, type ScheduleNewsletterParams, type SearchDomainsParams, type SendMessageParams, type SendNewsletterTestParams, ShipMailClient, type ShipMailConfig, ShipMailError, type StatusResponse, type Subscriber, type SubscriberOutcome, type SubscriberResult, type SubscriberStatus, type Suppression, type TestWebhookResponse, type Thread, type UpdateAudienceParams, type UpdateAutoReplyParams, type UpdateDomainParams, type UpdateInboxMessageParams, type UpdateMailboxFolderParams, type UpdateMailboxParams, type UpdateMailboxRulesParams, type UpdateNewsletterParams, type UpdateSpamFilterParams, type UpdateSubscriberParams, type UpdateWebhookParams, type UploadNewsletterAssetParams, ValidationError, WEBHOOK_DELIVERY_STATUSES, WEBHOOK_EVENT_TYPES, type Webhook, type WebhookDelivery, type WebhookDeliveryStatus, type WebhookEvent, type WebhookEventType, WebhookVerificationError, type WebhookWithSecret, ShipMailClient as default, verifyWebhook };
|
|
1466
|
+
export { type AddSubscriberParams, type AddSubscribersBatchParams, type AddSubscribersBatchResult, type ApiErrorBody, type Audience, AuthenticationError, AuthorizationError, type BookingPage, type CalendarAvailability, type CalendarAvailabilityParams, type CalendarAvailabilitySlot, type CalendarEvent, type CalendarEventPrivacy, type CalendarEventStatus, type CalendarFreeBusyStatus, ConflictError, ConnectionError, type CreateAudienceParams, type CreateBookingPageParams, type CreateCalendarEventParams, type CreateDomainParams, type CreateMailboxFolderParams, type CreateMailboxParams, type CreateNewsletterFromChangelogParams, type CreateNewsletterParams, type CreateWebhookParams, DOMAIN_STATUSES, type DeleteCalendarEventParams, type Domain, type DomainRegistrationInfo, type DomainSearchResult, type DomainStatus, type DomainVerificationResult, type DownloadInboxAttachmentParams, type EmailRecipient, type EmailRecipientInput, type ErrorType, type GetCalendarEventParams, type GetThreadParams, type InboxAttachment, type InboxBodyPart, type InboxBodyValue, type InboxEmailHeader, type InboxFullMessage, type InboxKeyword, type InboxMessage, type InboxMessageAction, type InboxMessages, type InboxThread, InternalServerError, type ListAudiencesParams, type ListBookingPagesParams, type ListCalendarEventsParams, type ListDeliveriesParams, type ListDomainsParams, type ListInboxMessagesParams, type ListMailboxesParams, type ListMessagesParams, type ListNewsletterAssetsParams, type ListNewsletterDomainsParams, type ListNewslettersParams, type ListSubscribersParams, type ListSuppressionsParams, type ListThreadsParams, type ListWebhooksParams, MESSAGE_SOURCES, MESSAGE_STATUSES, type Mailbox, type MailboxFolder, type MailboxFolders, type MailboxIdentities, type MailboxIdentity, type MailboxRule, type MailboxRuleAction, type MailboxRuleCondition, type MailboxRuleFolder, type MailboxRuleMatchMode, type MailboxRuleMoveTarget, type MailboxRules, type MergeFields, type Message, type MessageSource, type MessageStatus, type MethodOptions, type MoveInboxMessageParams, type Newsletter, type NewsletterArchiveVisibility, type NewsletterAsset, type NewsletterAssetKind, type NewsletterAssetListResponse, type NewsletterAssetStorageUsage, type NewsletterBlock, type NewsletterButtonAlign, type NewsletterCalloutVariant, type NewsletterChangelogEntry, type NewsletterChangelogMedia, type NewsletterChangelogTone, type NewsletterColumnContent, type NewsletterColumnRatio, type NewsletterCountedUrl, type NewsletterDomain, type NewsletterDomainRecordStatus, type NewsletterDomainStatus, type NewsletterPreflight, type NewsletterPreflightItem, type NewsletterPreflightItemStatus, type NewsletterPreflightStatus, type NewsletterPreview, type NewsletterStatus, type NewsletterTestSend, type NewsletterTestSendStatus, type NewsletterUrlBreakdown, type NewsletterUrlSource, NotFoundError, Page, type PaginatedResponse, type PaginationParams, QuotaExceededError, RateLimitError, type Recurrence, type RecurrenceFrequency, type RecurrenceNDay, type RegisterDomainParams, type RegisterNewsletterAssetFromUrlParams, type RegistrationContact, type Reminder, type ReplyToMessageParams, type ReplyToThreadParams, type RequestOptions, type ResetMailboxPasswordParams, type RotateSecretResponse, type ScheduleNewsletterParams, type SearchDomainsParams, type SendMessageParams, type SendNewsletterTestParams, ShipMailClient, type ShipMailConfig, ShipMailError, type StatusResponse, type Subscriber, type SubscriberOutcome, type SubscriberResult, type SubscriberStatus, type Suppression, type TestWebhookResponse, type Thread, type UpdateAudienceParams, type UpdateAutoReplyParams, type UpdateBookingPageParams, type UpdateCalendarEventParams, type UpdateDomainParams, type UpdateInboxMessageParams, type UpdateMailboxFolderParams, type UpdateMailboxParams, type UpdateMailboxRulesParams, type UpdateNewsletterParams, type UpdateSpamFilterParams, type UpdateSubscriberParams, type UpdateWebhookParams, type UploadNewsletterAssetParams, ValidationError, WEBHOOK_DELIVERY_STATUSES, WEBHOOK_EVENT_TYPES, type Webhook, type WebhookDelivery, type WebhookDeliveryStatus, type WebhookEvent, type WebhookEventType, WebhookVerificationError, type WebhookWithSecret, type Weekday, ShipMailClient as default, verifyWebhook };
|
package/dist/index.d.ts
CHANGED
|
@@ -60,9 +60,9 @@ type StatusResponse = {
|
|
|
60
60
|
};
|
|
61
61
|
declare const DOMAIN_STATUSES: readonly ["pending", "verifying", "verified", "degraded", "failed"];
|
|
62
62
|
type DomainStatus = (typeof DOMAIN_STATUSES)[number];
|
|
63
|
-
declare const MESSAGE_STATUSES: readonly ["scheduled", "queued", "sent", "delivered", "bounced", "complained", "failed", "cancelled"];
|
|
63
|
+
declare const MESSAGE_STATUSES: readonly ["scheduled", "queued", "sent", "delivered", "bounced", "complained", "failed", "suppressed", "cancelled"];
|
|
64
64
|
type MessageStatus = (typeof MESSAGE_STATUSES)[number];
|
|
65
|
-
declare const MESSAGE_SOURCES: readonly ["api", "dashboard", "inbound", "smtp"];
|
|
65
|
+
declare const MESSAGE_SOURCES: readonly ["api", "newsletter", "dashboard", "inbound", "smtp"];
|
|
66
66
|
type MessageSource = (typeof MESSAGE_SOURCES)[number];
|
|
67
67
|
declare const WEBHOOK_DELIVERY_STATUSES: readonly ["pending", "delivered", "failed"];
|
|
68
68
|
type WebhookDeliveryStatus = (typeof WEBHOOK_DELIVERY_STATUSES)[number];
|
|
@@ -74,7 +74,7 @@ type MethodOptions = {
|
|
|
74
74
|
};
|
|
75
75
|
|
|
76
76
|
type MergeFields = Record<string, string | number | boolean | null>;
|
|
77
|
-
type SubscriberStatus = "subscribed" | "unsubscribed" | "bounced" | "complained" | "suppressed" | "transactional_only";
|
|
77
|
+
type SubscriberStatus = "subscribed" | "pending" | "unsubscribed" | "bounced" | "complained" | "suppressed" | "transactional_only";
|
|
78
78
|
type SubscriberOutcome = "created" | "updated" | "skipped_not_mailable" | "skipped_invalid" | "skipped_cap" | "skipped_quota";
|
|
79
79
|
type Audience = {
|
|
80
80
|
readonly object: "audience";
|
|
@@ -161,12 +161,221 @@ declare class Audiences extends ApiResource {
|
|
|
161
161
|
delete(id: string, options?: MethodOptions): Promise<void>;
|
|
162
162
|
}
|
|
163
163
|
|
|
164
|
+
type BookingPage = {
|
|
165
|
+
readonly object: "booking_page";
|
|
166
|
+
readonly id: string;
|
|
167
|
+
readonly mailbox: string;
|
|
168
|
+
readonly slug: string;
|
|
169
|
+
readonly url: string | null;
|
|
170
|
+
readonly name: string;
|
|
171
|
+
readonly description: string | null;
|
|
172
|
+
readonly duration_minutes: number;
|
|
173
|
+
readonly availability_days: readonly number[];
|
|
174
|
+
readonly window_start_minutes: number;
|
|
175
|
+
readonly window_end_minutes: number;
|
|
176
|
+
readonly timezone: string;
|
|
177
|
+
readonly buffer_minutes: number;
|
|
178
|
+
readonly minimum_notice_minutes: number;
|
|
179
|
+
readonly max_advance_days: number;
|
|
180
|
+
readonly active: boolean;
|
|
181
|
+
readonly created_at: string;
|
|
182
|
+
readonly updated_at: string;
|
|
183
|
+
};
|
|
184
|
+
type ListBookingPagesParams = PaginationParams;
|
|
185
|
+
type CreateBookingPageParams = {
|
|
186
|
+
readonly name: string;
|
|
187
|
+
readonly mailbox: string;
|
|
188
|
+
readonly slug: string;
|
|
189
|
+
readonly duration_minutes: number;
|
|
190
|
+
readonly availability_days: readonly number[];
|
|
191
|
+
readonly window_start_minutes: number;
|
|
192
|
+
readonly window_end_minutes: number;
|
|
193
|
+
readonly timezone: string;
|
|
194
|
+
readonly description?: string | null | undefined;
|
|
195
|
+
readonly buffer_minutes?: number | undefined;
|
|
196
|
+
readonly minimum_notice_minutes?: number | undefined;
|
|
197
|
+
readonly max_advance_days?: number | undefined;
|
|
198
|
+
readonly active?: boolean | undefined;
|
|
199
|
+
};
|
|
200
|
+
type UpdateBookingPageParams = {
|
|
201
|
+
readonly name?: string | undefined;
|
|
202
|
+
readonly mailbox?: string | undefined;
|
|
203
|
+
readonly slug?: string | undefined;
|
|
204
|
+
readonly duration_minutes?: number | undefined;
|
|
205
|
+
readonly availability_days?: readonly number[] | undefined;
|
|
206
|
+
readonly window_start_minutes?: number | undefined;
|
|
207
|
+
readonly window_end_minutes?: number | undefined;
|
|
208
|
+
readonly timezone?: string | undefined;
|
|
209
|
+
readonly description?: string | null | undefined;
|
|
210
|
+
readonly buffer_minutes?: number | undefined;
|
|
211
|
+
readonly minimum_notice_minutes?: number | undefined;
|
|
212
|
+
readonly max_advance_days?: number | undefined;
|
|
213
|
+
readonly active?: boolean | undefined;
|
|
214
|
+
};
|
|
215
|
+
|
|
216
|
+
declare class BookingPages extends ApiResource {
|
|
217
|
+
create(params: CreateBookingPageParams, options?: MethodOptions): Promise<BookingPage>;
|
|
218
|
+
list(params?: ListBookingPagesParams, options?: MethodOptions): Promise<PaginatedResponse<BookingPage>>;
|
|
219
|
+
listAutoPaginating(params?: Omit<ListBookingPagesParams, "cursor">): Page<BookingPage>;
|
|
220
|
+
get(id: string, options?: MethodOptions): Promise<BookingPage>;
|
|
221
|
+
update(id: string, params: UpdateBookingPageParams, options?: MethodOptions): Promise<BookingPage>;
|
|
222
|
+
delete(id: string, options?: MethodOptions): Promise<void>;
|
|
223
|
+
}
|
|
224
|
+
|
|
225
|
+
type CalendarEventStatus = "confirmed" | "tentative" | "cancelled";
|
|
226
|
+
type CalendarFreeBusyStatus = "free" | "busy";
|
|
227
|
+
type CalendarEventPrivacy = "public" | "private" | "secret";
|
|
228
|
+
type RecurrenceFrequency = "yearly" | "monthly" | "weekly" | "daily" | "hourly" | "minutely" | "secondly";
|
|
229
|
+
type Weekday = "mo" | "tu" | "we" | "th" | "fr" | "sa" | "su";
|
|
230
|
+
type RecurrenceNDay = {
|
|
231
|
+
readonly day: Weekday;
|
|
232
|
+
readonly nth_of_period?: number | undefined;
|
|
233
|
+
};
|
|
234
|
+
type Recurrence = {
|
|
235
|
+
readonly frequency: RecurrenceFrequency;
|
|
236
|
+
readonly interval?: number | undefined;
|
|
237
|
+
readonly count?: number | undefined;
|
|
238
|
+
readonly until?: string | undefined;
|
|
239
|
+
readonly by_day?: readonly RecurrenceNDay[] | undefined;
|
|
240
|
+
};
|
|
241
|
+
type Reminder = {
|
|
242
|
+
readonly minutes_before: number;
|
|
243
|
+
};
|
|
244
|
+
type CalendarAttendeeInput = {
|
|
245
|
+
readonly email: string;
|
|
246
|
+
readonly name?: string | undefined;
|
|
247
|
+
};
|
|
248
|
+
type CalendarPerson = {
|
|
249
|
+
readonly email: string;
|
|
250
|
+
readonly name: string | null;
|
|
251
|
+
};
|
|
252
|
+
type CalendarAttendee = CalendarPerson & {
|
|
253
|
+
readonly status: "needs-action" | "accepted" | "declined" | "tentative";
|
|
254
|
+
};
|
|
255
|
+
type CalendarEvent = {
|
|
256
|
+
readonly object: "calendar_event";
|
|
257
|
+
readonly id: string;
|
|
258
|
+
readonly mailbox: string;
|
|
259
|
+
readonly calendar_id: string | null;
|
|
260
|
+
readonly uid: string | null;
|
|
261
|
+
readonly title: string | null;
|
|
262
|
+
readonly description: string | null;
|
|
263
|
+
readonly location: string | null;
|
|
264
|
+
readonly video_url: string | null;
|
|
265
|
+
readonly all_day: boolean;
|
|
266
|
+
readonly start: string;
|
|
267
|
+
readonly end: string;
|
|
268
|
+
readonly timezone: string | null;
|
|
269
|
+
readonly duration: string | null;
|
|
270
|
+
readonly status: CalendarEventStatus | null;
|
|
271
|
+
readonly free_busy_status: CalendarFreeBusyStatus | null;
|
|
272
|
+
readonly privacy: CalendarEventPrivacy | null;
|
|
273
|
+
readonly color: string | null;
|
|
274
|
+
readonly recurrence: Recurrence | null;
|
|
275
|
+
readonly recurrence_id: string | null;
|
|
276
|
+
readonly reminders: readonly Reminder[];
|
|
277
|
+
readonly organizer: CalendarPerson | null;
|
|
278
|
+
readonly attendees: readonly CalendarAttendee[];
|
|
279
|
+
readonly created_at: string | null;
|
|
280
|
+
readonly updated_at: string | null;
|
|
281
|
+
};
|
|
282
|
+
type ListCalendarEventsParams = PaginationParams & {
|
|
283
|
+
readonly mailbox: string;
|
|
284
|
+
readonly from: string;
|
|
285
|
+
readonly to: string;
|
|
286
|
+
readonly expand?: boolean | undefined;
|
|
287
|
+
readonly calendar_id?: string | undefined;
|
|
288
|
+
};
|
|
289
|
+
type GetCalendarEventParams = {
|
|
290
|
+
readonly mailbox: string;
|
|
291
|
+
};
|
|
292
|
+
type DeleteCalendarEventParams = {
|
|
293
|
+
readonly mailbox: string;
|
|
294
|
+
};
|
|
295
|
+
type CreateCalendarEventParams = {
|
|
296
|
+
readonly mailbox: string;
|
|
297
|
+
readonly calendar_id?: string | undefined;
|
|
298
|
+
readonly title: string;
|
|
299
|
+
readonly start: string;
|
|
300
|
+
readonly description?: string | undefined;
|
|
301
|
+
readonly timezone?: string | undefined;
|
|
302
|
+
readonly duration?: string | undefined;
|
|
303
|
+
readonly all_day?: boolean | undefined;
|
|
304
|
+
readonly location?: string | undefined;
|
|
305
|
+
readonly video_url?: string | undefined;
|
|
306
|
+
readonly color?: string | undefined;
|
|
307
|
+
readonly status?: CalendarEventStatus | undefined;
|
|
308
|
+
readonly free_busy_status?: CalendarFreeBusyStatus | undefined;
|
|
309
|
+
readonly privacy?: CalendarEventPrivacy | undefined;
|
|
310
|
+
readonly recurrence?: Recurrence | undefined;
|
|
311
|
+
readonly reminders?: readonly Reminder[] | undefined;
|
|
312
|
+
readonly attendees?: readonly CalendarAttendeeInput[] | undefined;
|
|
313
|
+
};
|
|
314
|
+
type UpdateCalendarEventParams = {
|
|
315
|
+
readonly mailbox: string;
|
|
316
|
+
readonly title?: string | undefined;
|
|
317
|
+
readonly description?: string | null | undefined;
|
|
318
|
+
readonly start?: string | undefined;
|
|
319
|
+
readonly timezone?: string | null | undefined;
|
|
320
|
+
readonly duration?: string | undefined;
|
|
321
|
+
readonly all_day?: boolean | undefined;
|
|
322
|
+
readonly location?: string | null | undefined;
|
|
323
|
+
readonly video_url?: string | null | undefined;
|
|
324
|
+
readonly color?: string | undefined;
|
|
325
|
+
readonly status?: CalendarEventStatus | undefined;
|
|
326
|
+
readonly free_busy_status?: CalendarFreeBusyStatus | undefined;
|
|
327
|
+
readonly privacy?: CalendarEventPrivacy | undefined;
|
|
328
|
+
readonly recurrence?: Recurrence | null | undefined;
|
|
329
|
+
readonly reminders?: readonly Reminder[] | null | undefined;
|
|
330
|
+
readonly attendees?: readonly CalendarAttendeeInput[] | undefined;
|
|
331
|
+
};
|
|
332
|
+
type CalendarAvailabilitySlot = {
|
|
333
|
+
readonly start: string;
|
|
334
|
+
readonly end: string;
|
|
335
|
+
};
|
|
336
|
+
type CalendarAvailability = {
|
|
337
|
+
readonly object: "calendar_availability";
|
|
338
|
+
readonly mailbox: string;
|
|
339
|
+
readonly from: string;
|
|
340
|
+
readonly to: string;
|
|
341
|
+
readonly duration_minutes: number;
|
|
342
|
+
readonly timezone: string;
|
|
343
|
+
readonly slots: readonly CalendarAvailabilitySlot[];
|
|
344
|
+
};
|
|
345
|
+
type CalendarAvailabilityParams = {
|
|
346
|
+
readonly mailbox: string;
|
|
347
|
+
readonly from: string;
|
|
348
|
+
readonly to: string;
|
|
349
|
+
readonly duration?: number | undefined;
|
|
350
|
+
readonly interval?: number | undefined;
|
|
351
|
+
readonly timezone?: string | undefined;
|
|
352
|
+
readonly days?: readonly number[] | undefined;
|
|
353
|
+
readonly window_start?: number | undefined;
|
|
354
|
+
readonly window_end?: number | undefined;
|
|
355
|
+
readonly buffer?: number | undefined;
|
|
356
|
+
readonly minimum_notice?: number | undefined;
|
|
357
|
+
};
|
|
358
|
+
|
|
359
|
+
declare class CalendarEvents extends ApiResource {
|
|
360
|
+
create(params: CreateCalendarEventParams, options?: MethodOptions): Promise<CalendarEvent>;
|
|
361
|
+
list(params: ListCalendarEventsParams, options?: MethodOptions): Promise<PaginatedResponse<CalendarEvent>>;
|
|
362
|
+
listAutoPaginating(params: Omit<ListCalendarEventsParams, "cursor">): Page<CalendarEvent>;
|
|
363
|
+
get(id: string, params: GetCalendarEventParams, options?: MethodOptions): Promise<CalendarEvent>;
|
|
364
|
+
update(id: string, params: UpdateCalendarEventParams, options?: MethodOptions): Promise<CalendarEvent>;
|
|
365
|
+
delete(id: string, params: DeleteCalendarEventParams, options?: MethodOptions): Promise<void>;
|
|
366
|
+
}
|
|
367
|
+
declare class Calendar extends ApiResource {
|
|
368
|
+
readonly events: CalendarEvents;
|
|
369
|
+
constructor(client: ShipMailClient);
|
|
370
|
+
availability(params: CalendarAvailabilityParams, options?: MethodOptions): Promise<CalendarAvailability>;
|
|
371
|
+
}
|
|
372
|
+
|
|
164
373
|
type Domain = {
|
|
165
374
|
readonly object: "domain";
|
|
166
375
|
readonly id: string;
|
|
167
376
|
readonly name: string;
|
|
168
377
|
readonly status: DomainStatus;
|
|
169
|
-
readonly managed_by: "external" | "
|
|
378
|
+
readonly managed_by: "external" | "shipmail";
|
|
170
379
|
readonly dns_provider: string | null;
|
|
171
380
|
readonly mx_verified: boolean;
|
|
172
381
|
readonly spf_verified: boolean;
|
|
@@ -506,6 +715,7 @@ type MailboxRuleAction = {
|
|
|
506
715
|
readonly type: "ai_draft_reply";
|
|
507
716
|
readonly instructions: string;
|
|
508
717
|
readonly reply_mode: "reply" | "reply_all";
|
|
718
|
+
readonly agent_policy: "observe_only" | "draft_for_review";
|
|
509
719
|
};
|
|
510
720
|
type MailboxRule = {
|
|
511
721
|
readonly id: string;
|
|
@@ -1159,6 +1369,8 @@ declare class ShipMailClient {
|
|
|
1159
1369
|
private readonly fetchFn;
|
|
1160
1370
|
private readonly defaultHeaders;
|
|
1161
1371
|
readonly audiences: Audiences;
|
|
1372
|
+
readonly bookingPages: BookingPages;
|
|
1373
|
+
readonly calendar: Calendar;
|
|
1162
1374
|
readonly domains: Domains;
|
|
1163
1375
|
readonly mailboxes: Mailboxes;
|
|
1164
1376
|
readonly messages: Messages;
|
|
@@ -1251,4 +1463,4 @@ declare function verifyWebhook(body: string, headers: WebhookHeaders | Headers,
|
|
|
1251
1463
|
readonly toleranceInSeconds?: number | undefined;
|
|
1252
1464
|
}): Promise<WebhookEvent>;
|
|
1253
1465
|
|
|
1254
|
-
export { type AddSubscriberParams, type AddSubscribersBatchParams, type AddSubscribersBatchResult, type ApiErrorBody, type Audience, AuthenticationError, AuthorizationError, ConflictError, ConnectionError, type CreateAudienceParams, type CreateDomainParams, type CreateMailboxFolderParams, type CreateMailboxParams, type CreateNewsletterFromChangelogParams, type CreateNewsletterParams, type CreateWebhookParams, DOMAIN_STATUSES, type Domain, type DomainRegistrationInfo, type DomainSearchResult, type DomainStatus, type DomainVerificationResult, type DownloadInboxAttachmentParams, type EmailRecipient, type EmailRecipientInput, type ErrorType, type GetThreadParams, type InboxAttachment, type InboxBodyPart, type InboxBodyValue, type InboxEmailHeader, type InboxFullMessage, type InboxKeyword, type InboxMessage, type InboxMessageAction, type InboxMessages, type InboxThread, InternalServerError, type ListAudiencesParams, type ListDeliveriesParams, type ListDomainsParams, type ListInboxMessagesParams, type ListMailboxesParams, type ListMessagesParams, type ListNewsletterAssetsParams, type ListNewsletterDomainsParams, type ListNewslettersParams, type ListSubscribersParams, type ListSuppressionsParams, type ListThreadsParams, type ListWebhooksParams, MESSAGE_SOURCES, MESSAGE_STATUSES, type Mailbox, type MailboxFolder, type MailboxFolders, type MailboxIdentities, type MailboxIdentity, type MailboxRule, type MailboxRuleAction, type MailboxRuleCondition, type MailboxRuleFolder, type MailboxRuleMatchMode, type MailboxRuleMoveTarget, type MailboxRules, type MergeFields, type Message, type MessageSource, type MessageStatus, type MethodOptions, type MoveInboxMessageParams, type Newsletter, type NewsletterArchiveVisibility, type NewsletterAsset, type NewsletterAssetKind, type NewsletterAssetListResponse, type NewsletterAssetStorageUsage, type NewsletterBlock, type NewsletterButtonAlign, type NewsletterCalloutVariant, type NewsletterChangelogEntry, type NewsletterChangelogMedia, type NewsletterChangelogTone, type NewsletterColumnContent, type NewsletterColumnRatio, type NewsletterCountedUrl, type NewsletterDomain, type NewsletterDomainRecordStatus, type NewsletterDomainStatus, type NewsletterPreflight, type NewsletterPreflightItem, type NewsletterPreflightItemStatus, type NewsletterPreflightStatus, type NewsletterPreview, type NewsletterStatus, type NewsletterTestSend, type NewsletterTestSendStatus, type NewsletterUrlBreakdown, type NewsletterUrlSource, NotFoundError, Page, type PaginatedResponse, type PaginationParams, QuotaExceededError, RateLimitError, type RegisterDomainParams, type RegisterNewsletterAssetFromUrlParams, type RegistrationContact, type ReplyToMessageParams, type ReplyToThreadParams, type RequestOptions, type ResetMailboxPasswordParams, type RotateSecretResponse, type ScheduleNewsletterParams, type SearchDomainsParams, type SendMessageParams, type SendNewsletterTestParams, ShipMailClient, type ShipMailConfig, ShipMailError, type StatusResponse, type Subscriber, type SubscriberOutcome, type SubscriberResult, type SubscriberStatus, type Suppression, type TestWebhookResponse, type Thread, type UpdateAudienceParams, type UpdateAutoReplyParams, type UpdateDomainParams, type UpdateInboxMessageParams, type UpdateMailboxFolderParams, type UpdateMailboxParams, type UpdateMailboxRulesParams, type UpdateNewsletterParams, type UpdateSpamFilterParams, type UpdateSubscriberParams, type UpdateWebhookParams, type UploadNewsletterAssetParams, ValidationError, WEBHOOK_DELIVERY_STATUSES, WEBHOOK_EVENT_TYPES, type Webhook, type WebhookDelivery, type WebhookDeliveryStatus, type WebhookEvent, type WebhookEventType, WebhookVerificationError, type WebhookWithSecret, ShipMailClient as default, verifyWebhook };
|
|
1466
|
+
export { type AddSubscriberParams, type AddSubscribersBatchParams, type AddSubscribersBatchResult, type ApiErrorBody, type Audience, AuthenticationError, AuthorizationError, type BookingPage, type CalendarAvailability, type CalendarAvailabilityParams, type CalendarAvailabilitySlot, type CalendarEvent, type CalendarEventPrivacy, type CalendarEventStatus, type CalendarFreeBusyStatus, ConflictError, ConnectionError, type CreateAudienceParams, type CreateBookingPageParams, type CreateCalendarEventParams, type CreateDomainParams, type CreateMailboxFolderParams, type CreateMailboxParams, type CreateNewsletterFromChangelogParams, type CreateNewsletterParams, type CreateWebhookParams, DOMAIN_STATUSES, type DeleteCalendarEventParams, type Domain, type DomainRegistrationInfo, type DomainSearchResult, type DomainStatus, type DomainVerificationResult, type DownloadInboxAttachmentParams, type EmailRecipient, type EmailRecipientInput, type ErrorType, type GetCalendarEventParams, type GetThreadParams, type InboxAttachment, type InboxBodyPart, type InboxBodyValue, type InboxEmailHeader, type InboxFullMessage, type InboxKeyword, type InboxMessage, type InboxMessageAction, type InboxMessages, type InboxThread, InternalServerError, type ListAudiencesParams, type ListBookingPagesParams, type ListCalendarEventsParams, type ListDeliveriesParams, type ListDomainsParams, type ListInboxMessagesParams, type ListMailboxesParams, type ListMessagesParams, type ListNewsletterAssetsParams, type ListNewsletterDomainsParams, type ListNewslettersParams, type ListSubscribersParams, type ListSuppressionsParams, type ListThreadsParams, type ListWebhooksParams, MESSAGE_SOURCES, MESSAGE_STATUSES, type Mailbox, type MailboxFolder, type MailboxFolders, type MailboxIdentities, type MailboxIdentity, type MailboxRule, type MailboxRuleAction, type MailboxRuleCondition, type MailboxRuleFolder, type MailboxRuleMatchMode, type MailboxRuleMoveTarget, type MailboxRules, type MergeFields, type Message, type MessageSource, type MessageStatus, type MethodOptions, type MoveInboxMessageParams, type Newsletter, type NewsletterArchiveVisibility, type NewsletterAsset, type NewsletterAssetKind, type NewsletterAssetListResponse, type NewsletterAssetStorageUsage, type NewsletterBlock, type NewsletterButtonAlign, type NewsletterCalloutVariant, type NewsletterChangelogEntry, type NewsletterChangelogMedia, type NewsletterChangelogTone, type NewsletterColumnContent, type NewsletterColumnRatio, type NewsletterCountedUrl, type NewsletterDomain, type NewsletterDomainRecordStatus, type NewsletterDomainStatus, type NewsletterPreflight, type NewsletterPreflightItem, type NewsletterPreflightItemStatus, type NewsletterPreflightStatus, type NewsletterPreview, type NewsletterStatus, type NewsletterTestSend, type NewsletterTestSendStatus, type NewsletterUrlBreakdown, type NewsletterUrlSource, NotFoundError, Page, type PaginatedResponse, type PaginationParams, QuotaExceededError, RateLimitError, type Recurrence, type RecurrenceFrequency, type RecurrenceNDay, type RegisterDomainParams, type RegisterNewsletterAssetFromUrlParams, type RegistrationContact, type Reminder, type ReplyToMessageParams, type ReplyToThreadParams, type RequestOptions, type ResetMailboxPasswordParams, type RotateSecretResponse, type ScheduleNewsletterParams, type SearchDomainsParams, type SendMessageParams, type SendNewsletterTestParams, ShipMailClient, type ShipMailConfig, ShipMailError, type StatusResponse, type Subscriber, type SubscriberOutcome, type SubscriberResult, type SubscriberStatus, type Suppression, type TestWebhookResponse, type Thread, type UpdateAudienceParams, type UpdateAutoReplyParams, type UpdateBookingPageParams, type UpdateCalendarEventParams, type UpdateDomainParams, type UpdateInboxMessageParams, type UpdateMailboxFolderParams, type UpdateMailboxParams, type UpdateMailboxRulesParams, type UpdateNewsletterParams, type UpdateSpamFilterParams, type UpdateSubscriberParams, type UpdateWebhookParams, type UploadNewsletterAssetParams, ValidationError, WEBHOOK_DELIVERY_STATUSES, WEBHOOK_EVENT_TYPES, type Webhook, type WebhookDelivery, type WebhookDeliveryStatus, type WebhookEvent, type WebhookEventType, WebhookVerificationError, type WebhookWithSecret, type Weekday, ShipMailClient as default, verifyWebhook };
|