shipmail 0.4.5 → 0.4.8
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 +11 -1
- package/dist/index.cjs +36 -2
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +37 -3
- package/dist/index.d.ts +37 -3
- package/dist/index.js +36 -2
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -55,9 +55,9 @@ type EmailRecipient = {
|
|
|
55
55
|
readonly name?: string | null | undefined;
|
|
56
56
|
};
|
|
57
57
|
type EmailRecipientInput = EmailRecipient | string;
|
|
58
|
-
declare const WEBHOOK_EVENT_TYPES: readonly ["message.received", "message.sent", "message.delivered", "message.bounced", "message.complained", "
|
|
58
|
+
declare const WEBHOOK_EVENT_TYPES: readonly ["message.received", "message.sent", "message.delivered", "message.bounced", "message.complained", "mailbox.rule_matched", "domain.verified", "domain.verification_failed", "domain.degraded", "org.reputation_warning", "org.sending_throttled", "org.sending_suspended", "org.reputation_recovered"];
|
|
59
59
|
type WebhookEventType = (typeof WEBHOOK_EVENT_TYPES)[number];
|
|
60
|
-
declare const WEBHOOK_DELIVERY_EVENT_TYPES: readonly ["webhook.test", "message.received", "message.sent", "message.delivered", "message.bounced", "message.complained", "
|
|
60
|
+
declare const WEBHOOK_DELIVERY_EVENT_TYPES: readonly ["webhook.test", "message.received", "message.sent", "message.delivered", "message.bounced", "message.complained", "mailbox.rule_matched", "domain.verified", "domain.verification_failed", "domain.degraded", "org.reputation_warning", "org.sending_throttled", "org.sending_suspended", "org.reputation_recovered"];
|
|
61
61
|
type WebhookDeliveryEventType = (typeof WEBHOOK_DELIVERY_EVENT_TYPES)[number];
|
|
62
62
|
type StatusResponse = {
|
|
63
63
|
readonly status: string;
|
|
@@ -99,6 +99,21 @@ type Audience = {
|
|
|
99
99
|
readonly created_at: string;
|
|
100
100
|
readonly updated_at: string;
|
|
101
101
|
};
|
|
102
|
+
type AudienceFeed = {
|
|
103
|
+
readonly object: "audience_feed";
|
|
104
|
+
readonly audience_id: string;
|
|
105
|
+
readonly enabled: boolean;
|
|
106
|
+
readonly title: string | null;
|
|
107
|
+
readonly subtitle: string | null;
|
|
108
|
+
readonly site_url: string | null;
|
|
109
|
+
readonly canonical_url: string | null;
|
|
110
|
+
readonly author_name: string | null;
|
|
111
|
+
readonly icon_url: string | null;
|
|
112
|
+
readonly entry_limit: number | null;
|
|
113
|
+
/** Atom feed URL, or null when the feed is disabled. Anyone with this URL can read the feed. */
|
|
114
|
+
readonly url: string | null;
|
|
115
|
+
readonly updated_at: string;
|
|
116
|
+
};
|
|
102
117
|
type Subscriber = {
|
|
103
118
|
readonly object: "subscriber";
|
|
104
119
|
readonly id: string;
|
|
@@ -120,6 +135,16 @@ type UpdateAudienceParams = {
|
|
|
120
135
|
readonly name?: string | undefined;
|
|
121
136
|
readonly description?: string | null | undefined;
|
|
122
137
|
};
|
|
138
|
+
type UpdateAudienceFeedParams = {
|
|
139
|
+
readonly enabled?: boolean | undefined;
|
|
140
|
+
readonly title?: string | null | undefined;
|
|
141
|
+
readonly subtitle?: string | null | undefined;
|
|
142
|
+
readonly site_url?: string | null | undefined;
|
|
143
|
+
readonly canonical_url?: string | null | undefined;
|
|
144
|
+
readonly author_name?: string | null | undefined;
|
|
145
|
+
readonly icon_url?: string | null | undefined;
|
|
146
|
+
readonly entry_limit?: number | null | undefined;
|
|
147
|
+
};
|
|
123
148
|
type ListAudiencesParams = PaginationParams;
|
|
124
149
|
type AddSubscriberParams = {
|
|
125
150
|
readonly email_address: string;
|
|
@@ -150,6 +175,12 @@ type ListSubscribersParams = PaginationParams & {
|
|
|
150
175
|
readonly email?: string | undefined;
|
|
151
176
|
};
|
|
152
177
|
|
|
178
|
+
declare class AudienceFeeds extends ApiResource {
|
|
179
|
+
get(audienceId: string, options?: MethodOptions): Promise<AudienceFeed>;
|
|
180
|
+
update(audienceId: string, params: UpdateAudienceFeedParams, options?: MethodOptions): Promise<AudienceFeed>;
|
|
181
|
+
rotate(audienceId: string, options?: MethodOptions): Promise<AudienceFeed>;
|
|
182
|
+
revoke(audienceId: string, options?: MethodOptions): Promise<AudienceFeed>;
|
|
183
|
+
}
|
|
153
184
|
declare class Subscribers extends ApiResource {
|
|
154
185
|
add(audienceId: string, params: AddSubscriberParams, options?: MethodOptions): Promise<SubscriberResult>;
|
|
155
186
|
addBatch(audienceId: string, params: AddSubscribersBatchParams, options?: MethodOptions): Promise<AddSubscribersBatchResult>;
|
|
@@ -163,6 +194,7 @@ declare class Subscribers extends ApiResource {
|
|
|
163
194
|
remove(audienceId: string, subscriberId: string, options?: MethodOptions): Promise<void>;
|
|
164
195
|
}
|
|
165
196
|
declare class Audiences extends ApiResource {
|
|
197
|
+
readonly feeds: AudienceFeeds;
|
|
166
198
|
readonly subscribers: Subscribers;
|
|
167
199
|
constructor(client: ShipMailClient);
|
|
168
200
|
create(params: CreateAudienceParams, options?: MethodOptions): Promise<Audience>;
|
|
@@ -1346,6 +1378,8 @@ type Newsletter = {
|
|
|
1346
1378
|
readonly scheduled_at: string | null;
|
|
1347
1379
|
readonly approved_at: string | null;
|
|
1348
1380
|
readonly started_at: string | null;
|
|
1381
|
+
readonly published_at: string | null;
|
|
1382
|
+
readonly archive_url: string | null;
|
|
1349
1383
|
readonly completed_at: string | null;
|
|
1350
1384
|
readonly cancelled_at: string | null;
|
|
1351
1385
|
readonly created_at: string;
|
|
@@ -2028,4 +2062,4 @@ declare function verifyWebhook(body: string, headers: WebhookHeaders | Headers,
|
|
|
2028
2062
|
readonly toleranceInSeconds?: number | undefined;
|
|
2029
2063
|
}): Promise<WebhookEvent>;
|
|
2030
2064
|
|
|
2031
|
-
export { type AddSubscriberParams, type AddSubscribersBatchParams, type AddSubscribersBatchResult, type ApiErrorBody, type Audience, AuthenticationError, AuthorizationError, type BookingPage, CONFERENCING_PROVIDER_IDS, type CalendarAvailability, type CalendarAvailabilityParams, type CalendarAvailabilitySlot, type CalendarEvent, type CalendarEventPrivacy, type CalendarEventStatus, type CalendarFreeBusyStatus, type CapabilitiesResponse, type CapabilityResourceConstraints, type ConferencingProviderId, ConflictError, ConnectionError, type ConsumePartnerMailboxCredentialGrantParams, type CreateAudienceParams, type CreateBookingPageParams, type CreateCalendarEventParams, type CreateDomainParams, type CreateInboxReplyDraftParams, type CreateMailboxAppPasswordParams, type CreateMailboxFolderParams, type CreateMailboxParams, type CreateNewsletterFromChangelogParams, type CreateNewsletterParams, type CreatePartnerOrganizationParams, type CreateReplyScanParams, type CreateWebhookParams, type CreatedMailboxAppPassword, type CreatedPartnerOrganization, 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 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 InboxReplyDraft, type InboxReplyDraftSend, type InboxThread, type InboxThreadReplyState, type InboxThreadReplyStateResult, type InboxThreadSummary, type InboxThreads, type InjectSandboxInboundParams, InternalServerError, type ListAudiencesParams, type ListBookingPagesParams, type ListCalendarEventsParams, type ListDeliveriesParams, type ListDomainsParams, type ListInboxMessagesParams, type ListInboxThreadsParams, type ListMailboxesParams, type ListMessagesParams, type ListNewsletterAssetsParams, type ListNewsletterDomainsParams, 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 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 MergeFields, type Message, type MessageMetadata, type MessageRuleDisposition, 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 NewsletterStylingMode, type NewsletterTestSend, type NewsletterTestSendStatus, type NewsletterUrlBreakdown, type NewsletterUrlSource, NotFoundError, type OneTimeSecretMethodOptions, type OutboundHeader, Page, type PaginatedResponse, type PaginationParams, type PartnerDataClassification, type PartnerMailboxCredential, type PartnerMailboxCredentialGrant, type PartnerMailboxCredentialGrantList, type PartnerOrganization, type PartnerOrganizationList, type PartnerOrganizationStatus, type PartnerOwnershipInvitation, type PartnerUsage, type PrepareStagedAttachmentUploadParams, QuotaExceededError, RateLimitError, 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 TransactionalRecipientBudget, type UpdateAudienceParams, type UpdateAutoReplyParams, type UpdateBookingPageParams, type UpdateCalendarEventParams, type UpdateDomainParams, type UpdateInboxMessageParams, type UpdateInboxThreadReplyStateParams, type UpdateMailboxFolderParams, type UpdateMailboxParams, type UpdateMailboxRulesParams, type UpdateNewsletterParams, type UpdatePartnerOrganizationParams, type UpdateScheduledMessageParams, type UpdateSpamFilterParams, 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 };
|
|
2065
|
+
export { type AddSubscriberParams, type AddSubscribersBatchParams, type AddSubscribersBatchResult, type ApiErrorBody, type Audience, type AudienceFeed, AuthenticationError, AuthorizationError, type BookingPage, CONFERENCING_PROVIDER_IDS, type CalendarAvailability, type CalendarAvailabilityParams, type CalendarAvailabilitySlot, type CalendarEvent, type CalendarEventPrivacy, type CalendarEventStatus, type CalendarFreeBusyStatus, type CapabilitiesResponse, type CapabilityResourceConstraints, type ConferencingProviderId, ConflictError, ConnectionError, type ConsumePartnerMailboxCredentialGrantParams, type CreateAudienceParams, type CreateBookingPageParams, type CreateCalendarEventParams, type CreateDomainParams, type CreateInboxReplyDraftParams, type CreateMailboxAppPasswordParams, type CreateMailboxFolderParams, type CreateMailboxParams, type CreateNewsletterFromChangelogParams, type CreateNewsletterParams, type CreatePartnerOrganizationParams, type CreateReplyScanParams, type CreateWebhookParams, type CreatedMailboxAppPassword, type CreatedPartnerOrganization, 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 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 InboxReplyDraft, type InboxReplyDraftSend, type InboxThread, type InboxThreadReplyState, type InboxThreadReplyStateResult, type InboxThreadSummary, type InboxThreads, type InjectSandboxInboundParams, InternalServerError, type ListAudiencesParams, type ListBookingPagesParams, type ListCalendarEventsParams, type ListDeliveriesParams, type ListDomainsParams, type ListInboxMessagesParams, type ListInboxThreadsParams, type ListMailboxesParams, type ListMessagesParams, type ListNewsletterAssetsParams, type ListNewsletterDomainsParams, 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 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 MergeFields, type Message, type MessageMetadata, type MessageRuleDisposition, 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 NewsletterStylingMode, type NewsletterTestSend, type NewsletterTestSendStatus, type NewsletterUrlBreakdown, type NewsletterUrlSource, NotFoundError, type OneTimeSecretMethodOptions, type OutboundHeader, Page, type PaginatedResponse, type PaginationParams, type PartnerDataClassification, type PartnerMailboxCredential, type PartnerMailboxCredentialGrant, type PartnerMailboxCredentialGrantList, type PartnerOrganization, type PartnerOrganizationList, type PartnerOrganizationStatus, type PartnerOwnershipInvitation, type PartnerUsage, type PrepareStagedAttachmentUploadParams, QuotaExceededError, RateLimitError, 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 TransactionalRecipientBudget, type UpdateAudienceFeedParams, type UpdateAudienceParams, type UpdateAutoReplyParams, type UpdateBookingPageParams, type UpdateCalendarEventParams, type UpdateDomainParams, type UpdateInboxMessageParams, type UpdateInboxThreadReplyStateParams, type UpdateMailboxFolderParams, type UpdateMailboxParams, type UpdateMailboxRulesParams, type UpdateNewsletterParams, type UpdatePartnerOrganizationParams, type UpdateScheduledMessageParams, type UpdateSpamFilterParams, 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
|
@@ -55,9 +55,9 @@ type EmailRecipient = {
|
|
|
55
55
|
readonly name?: string | null | undefined;
|
|
56
56
|
};
|
|
57
57
|
type EmailRecipientInput = EmailRecipient | string;
|
|
58
|
-
declare const WEBHOOK_EVENT_TYPES: readonly ["message.received", "message.sent", "message.delivered", "message.bounced", "message.complained", "
|
|
58
|
+
declare const WEBHOOK_EVENT_TYPES: readonly ["message.received", "message.sent", "message.delivered", "message.bounced", "message.complained", "mailbox.rule_matched", "domain.verified", "domain.verification_failed", "domain.degraded", "org.reputation_warning", "org.sending_throttled", "org.sending_suspended", "org.reputation_recovered"];
|
|
59
59
|
type WebhookEventType = (typeof WEBHOOK_EVENT_TYPES)[number];
|
|
60
|
-
declare const WEBHOOK_DELIVERY_EVENT_TYPES: readonly ["webhook.test", "message.received", "message.sent", "message.delivered", "message.bounced", "message.complained", "
|
|
60
|
+
declare const WEBHOOK_DELIVERY_EVENT_TYPES: readonly ["webhook.test", "message.received", "message.sent", "message.delivered", "message.bounced", "message.complained", "mailbox.rule_matched", "domain.verified", "domain.verification_failed", "domain.degraded", "org.reputation_warning", "org.sending_throttled", "org.sending_suspended", "org.reputation_recovered"];
|
|
61
61
|
type WebhookDeliveryEventType = (typeof WEBHOOK_DELIVERY_EVENT_TYPES)[number];
|
|
62
62
|
type StatusResponse = {
|
|
63
63
|
readonly status: string;
|
|
@@ -99,6 +99,21 @@ type Audience = {
|
|
|
99
99
|
readonly created_at: string;
|
|
100
100
|
readonly updated_at: string;
|
|
101
101
|
};
|
|
102
|
+
type AudienceFeed = {
|
|
103
|
+
readonly object: "audience_feed";
|
|
104
|
+
readonly audience_id: string;
|
|
105
|
+
readonly enabled: boolean;
|
|
106
|
+
readonly title: string | null;
|
|
107
|
+
readonly subtitle: string | null;
|
|
108
|
+
readonly site_url: string | null;
|
|
109
|
+
readonly canonical_url: string | null;
|
|
110
|
+
readonly author_name: string | null;
|
|
111
|
+
readonly icon_url: string | null;
|
|
112
|
+
readonly entry_limit: number | null;
|
|
113
|
+
/** Atom feed URL, or null when the feed is disabled. Anyone with this URL can read the feed. */
|
|
114
|
+
readonly url: string | null;
|
|
115
|
+
readonly updated_at: string;
|
|
116
|
+
};
|
|
102
117
|
type Subscriber = {
|
|
103
118
|
readonly object: "subscriber";
|
|
104
119
|
readonly id: string;
|
|
@@ -120,6 +135,16 @@ type UpdateAudienceParams = {
|
|
|
120
135
|
readonly name?: string | undefined;
|
|
121
136
|
readonly description?: string | null | undefined;
|
|
122
137
|
};
|
|
138
|
+
type UpdateAudienceFeedParams = {
|
|
139
|
+
readonly enabled?: boolean | undefined;
|
|
140
|
+
readonly title?: string | null | undefined;
|
|
141
|
+
readonly subtitle?: string | null | undefined;
|
|
142
|
+
readonly site_url?: string | null | undefined;
|
|
143
|
+
readonly canonical_url?: string | null | undefined;
|
|
144
|
+
readonly author_name?: string | null | undefined;
|
|
145
|
+
readonly icon_url?: string | null | undefined;
|
|
146
|
+
readonly entry_limit?: number | null | undefined;
|
|
147
|
+
};
|
|
123
148
|
type ListAudiencesParams = PaginationParams;
|
|
124
149
|
type AddSubscriberParams = {
|
|
125
150
|
readonly email_address: string;
|
|
@@ -150,6 +175,12 @@ type ListSubscribersParams = PaginationParams & {
|
|
|
150
175
|
readonly email?: string | undefined;
|
|
151
176
|
};
|
|
152
177
|
|
|
178
|
+
declare class AudienceFeeds extends ApiResource {
|
|
179
|
+
get(audienceId: string, options?: MethodOptions): Promise<AudienceFeed>;
|
|
180
|
+
update(audienceId: string, params: UpdateAudienceFeedParams, options?: MethodOptions): Promise<AudienceFeed>;
|
|
181
|
+
rotate(audienceId: string, options?: MethodOptions): Promise<AudienceFeed>;
|
|
182
|
+
revoke(audienceId: string, options?: MethodOptions): Promise<AudienceFeed>;
|
|
183
|
+
}
|
|
153
184
|
declare class Subscribers extends ApiResource {
|
|
154
185
|
add(audienceId: string, params: AddSubscriberParams, options?: MethodOptions): Promise<SubscriberResult>;
|
|
155
186
|
addBatch(audienceId: string, params: AddSubscribersBatchParams, options?: MethodOptions): Promise<AddSubscribersBatchResult>;
|
|
@@ -163,6 +194,7 @@ declare class Subscribers extends ApiResource {
|
|
|
163
194
|
remove(audienceId: string, subscriberId: string, options?: MethodOptions): Promise<void>;
|
|
164
195
|
}
|
|
165
196
|
declare class Audiences extends ApiResource {
|
|
197
|
+
readonly feeds: AudienceFeeds;
|
|
166
198
|
readonly subscribers: Subscribers;
|
|
167
199
|
constructor(client: ShipMailClient);
|
|
168
200
|
create(params: CreateAudienceParams, options?: MethodOptions): Promise<Audience>;
|
|
@@ -1346,6 +1378,8 @@ type Newsletter = {
|
|
|
1346
1378
|
readonly scheduled_at: string | null;
|
|
1347
1379
|
readonly approved_at: string | null;
|
|
1348
1380
|
readonly started_at: string | null;
|
|
1381
|
+
readonly published_at: string | null;
|
|
1382
|
+
readonly archive_url: string | null;
|
|
1349
1383
|
readonly completed_at: string | null;
|
|
1350
1384
|
readonly cancelled_at: string | null;
|
|
1351
1385
|
readonly created_at: string;
|
|
@@ -2028,4 +2062,4 @@ declare function verifyWebhook(body: string, headers: WebhookHeaders | Headers,
|
|
|
2028
2062
|
readonly toleranceInSeconds?: number | undefined;
|
|
2029
2063
|
}): Promise<WebhookEvent>;
|
|
2030
2064
|
|
|
2031
|
-
export { type AddSubscriberParams, type AddSubscribersBatchParams, type AddSubscribersBatchResult, type ApiErrorBody, type Audience, AuthenticationError, AuthorizationError, type BookingPage, CONFERENCING_PROVIDER_IDS, type CalendarAvailability, type CalendarAvailabilityParams, type CalendarAvailabilitySlot, type CalendarEvent, type CalendarEventPrivacy, type CalendarEventStatus, type CalendarFreeBusyStatus, type CapabilitiesResponse, type CapabilityResourceConstraints, type ConferencingProviderId, ConflictError, ConnectionError, type ConsumePartnerMailboxCredentialGrantParams, type CreateAudienceParams, type CreateBookingPageParams, type CreateCalendarEventParams, type CreateDomainParams, type CreateInboxReplyDraftParams, type CreateMailboxAppPasswordParams, type CreateMailboxFolderParams, type CreateMailboxParams, type CreateNewsletterFromChangelogParams, type CreateNewsletterParams, type CreatePartnerOrganizationParams, type CreateReplyScanParams, type CreateWebhookParams, type CreatedMailboxAppPassword, type CreatedPartnerOrganization, 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 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 InboxReplyDraft, type InboxReplyDraftSend, type InboxThread, type InboxThreadReplyState, type InboxThreadReplyStateResult, type InboxThreadSummary, type InboxThreads, type InjectSandboxInboundParams, InternalServerError, type ListAudiencesParams, type ListBookingPagesParams, type ListCalendarEventsParams, type ListDeliveriesParams, type ListDomainsParams, type ListInboxMessagesParams, type ListInboxThreadsParams, type ListMailboxesParams, type ListMessagesParams, type ListNewsletterAssetsParams, type ListNewsletterDomainsParams, 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 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 MergeFields, type Message, type MessageMetadata, type MessageRuleDisposition, 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 NewsletterStylingMode, type NewsletterTestSend, type NewsletterTestSendStatus, type NewsletterUrlBreakdown, type NewsletterUrlSource, NotFoundError, type OneTimeSecretMethodOptions, type OutboundHeader, Page, type PaginatedResponse, type PaginationParams, type PartnerDataClassification, type PartnerMailboxCredential, type PartnerMailboxCredentialGrant, type PartnerMailboxCredentialGrantList, type PartnerOrganization, type PartnerOrganizationList, type PartnerOrganizationStatus, type PartnerOwnershipInvitation, type PartnerUsage, type PrepareStagedAttachmentUploadParams, QuotaExceededError, RateLimitError, 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 TransactionalRecipientBudget, type UpdateAudienceParams, type UpdateAutoReplyParams, type UpdateBookingPageParams, type UpdateCalendarEventParams, type UpdateDomainParams, type UpdateInboxMessageParams, type UpdateInboxThreadReplyStateParams, type UpdateMailboxFolderParams, type UpdateMailboxParams, type UpdateMailboxRulesParams, type UpdateNewsletterParams, type UpdatePartnerOrganizationParams, type UpdateScheduledMessageParams, type UpdateSpamFilterParams, 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 };
|
|
2065
|
+
export { type AddSubscriberParams, type AddSubscribersBatchParams, type AddSubscribersBatchResult, type ApiErrorBody, type Audience, type AudienceFeed, AuthenticationError, AuthorizationError, type BookingPage, CONFERENCING_PROVIDER_IDS, type CalendarAvailability, type CalendarAvailabilityParams, type CalendarAvailabilitySlot, type CalendarEvent, type CalendarEventPrivacy, type CalendarEventStatus, type CalendarFreeBusyStatus, type CapabilitiesResponse, type CapabilityResourceConstraints, type ConferencingProviderId, ConflictError, ConnectionError, type ConsumePartnerMailboxCredentialGrantParams, type CreateAudienceParams, type CreateBookingPageParams, type CreateCalendarEventParams, type CreateDomainParams, type CreateInboxReplyDraftParams, type CreateMailboxAppPasswordParams, type CreateMailboxFolderParams, type CreateMailboxParams, type CreateNewsletterFromChangelogParams, type CreateNewsletterParams, type CreatePartnerOrganizationParams, type CreateReplyScanParams, type CreateWebhookParams, type CreatedMailboxAppPassword, type CreatedPartnerOrganization, 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 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 InboxReplyDraft, type InboxReplyDraftSend, type InboxThread, type InboxThreadReplyState, type InboxThreadReplyStateResult, type InboxThreadSummary, type InboxThreads, type InjectSandboxInboundParams, InternalServerError, type ListAudiencesParams, type ListBookingPagesParams, type ListCalendarEventsParams, type ListDeliveriesParams, type ListDomainsParams, type ListInboxMessagesParams, type ListInboxThreadsParams, type ListMailboxesParams, type ListMessagesParams, type ListNewsletterAssetsParams, type ListNewsletterDomainsParams, 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 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 MergeFields, type Message, type MessageMetadata, type MessageRuleDisposition, 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 NewsletterStylingMode, type NewsletterTestSend, type NewsletterTestSendStatus, type NewsletterUrlBreakdown, type NewsletterUrlSource, NotFoundError, type OneTimeSecretMethodOptions, type OutboundHeader, Page, type PaginatedResponse, type PaginationParams, type PartnerDataClassification, type PartnerMailboxCredential, type PartnerMailboxCredentialGrant, type PartnerMailboxCredentialGrantList, type PartnerOrganization, type PartnerOrganizationList, type PartnerOrganizationStatus, type PartnerOwnershipInvitation, type PartnerUsage, type PrepareStagedAttachmentUploadParams, QuotaExceededError, RateLimitError, 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 TransactionalRecipientBudget, type UpdateAudienceFeedParams, type UpdateAudienceParams, type UpdateAutoReplyParams, type UpdateBookingPageParams, type UpdateCalendarEventParams, type UpdateDomainParams, type UpdateInboxMessageParams, type UpdateInboxThreadReplyStateParams, type UpdateMailboxFolderParams, type UpdateMailboxParams, type UpdateMailboxRulesParams, type UpdateNewsletterParams, type UpdatePartnerOrganizationParams, type UpdateScheduledMessageParams, type UpdateSpamFilterParams, 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.js
CHANGED
|
@@ -228,6 +228,40 @@ var ApiResource = class {
|
|
|
228
228
|
function base(audienceId) {
|
|
229
229
|
return `/audiences/${encodeURIComponent(audienceId)}/subscribers`;
|
|
230
230
|
}
|
|
231
|
+
function feedBase(audienceId) {
|
|
232
|
+
return `/audiences/${encodeURIComponent(audienceId)}/feed`;
|
|
233
|
+
}
|
|
234
|
+
var AudienceFeeds = class extends ApiResource {
|
|
235
|
+
get(audienceId, options) {
|
|
236
|
+
return this.client.request({
|
|
237
|
+
method: "GET",
|
|
238
|
+
path: feedBase(audienceId),
|
|
239
|
+
methodOptions: options
|
|
240
|
+
});
|
|
241
|
+
}
|
|
242
|
+
update(audienceId, params, options) {
|
|
243
|
+
return this.client.request({
|
|
244
|
+
method: "PATCH",
|
|
245
|
+
path: feedBase(audienceId),
|
|
246
|
+
body: params,
|
|
247
|
+
methodOptions: options
|
|
248
|
+
});
|
|
249
|
+
}
|
|
250
|
+
rotate(audienceId, options) {
|
|
251
|
+
return this.client.request({
|
|
252
|
+
method: "POST",
|
|
253
|
+
path: `${feedBase(audienceId)}/rotate`,
|
|
254
|
+
methodOptions: options
|
|
255
|
+
});
|
|
256
|
+
}
|
|
257
|
+
revoke(audienceId, options) {
|
|
258
|
+
return this.client.request({
|
|
259
|
+
method: "POST",
|
|
260
|
+
path: `${feedBase(audienceId)}/revoke`,
|
|
261
|
+
methodOptions: options
|
|
262
|
+
});
|
|
263
|
+
}
|
|
264
|
+
};
|
|
231
265
|
var Subscribers = class extends ApiResource {
|
|
232
266
|
add(audienceId, params, options) {
|
|
233
267
|
return this.client.request({
|
|
@@ -313,6 +347,7 @@ var Subscribers = class extends ApiResource {
|
|
|
313
347
|
var Audiences = class extends ApiResource {
|
|
314
348
|
constructor(client) {
|
|
315
349
|
super(client);
|
|
350
|
+
this.feeds = new AudienceFeeds(client);
|
|
316
351
|
this.subscribers = new Subscribers(client);
|
|
317
352
|
}
|
|
318
353
|
create(params, options) {
|
|
@@ -1500,7 +1535,7 @@ var Webhooks = class extends ApiResource {
|
|
|
1500
1535
|
};
|
|
1501
1536
|
|
|
1502
1537
|
// src/version.ts
|
|
1503
|
-
var VERSION = "0.4.
|
|
1538
|
+
var VERSION = "0.4.8";
|
|
1504
1539
|
|
|
1505
1540
|
// src/client.ts
|
|
1506
1541
|
var DEFAULT_BASE_URL = "https://shipmail.to/api/v1";
|
|
@@ -1674,7 +1709,6 @@ var WEBHOOK_EVENT_TYPES = [
|
|
|
1674
1709
|
"message.delivered",
|
|
1675
1710
|
"message.bounced",
|
|
1676
1711
|
"message.complained",
|
|
1677
|
-
"thread.needs_reply",
|
|
1678
1712
|
"mailbox.rule_matched",
|
|
1679
1713
|
"domain.verified",
|
|
1680
1714
|
"domain.verification_failed",
|