shipmail 0.6.3 → 0.6.4
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 +10 -0
- package/dist/index.cjs +2 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +13 -3
- package/dist/index.d.ts +13 -3
- package/dist/index.js +2 -1
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -67,9 +67,9 @@ type EmailRecipient = {
|
|
|
67
67
|
readonly name?: string | null | undefined;
|
|
68
68
|
};
|
|
69
69
|
type EmailRecipientInput = EmailRecipient | string;
|
|
70
|
-
declare const WEBHOOK_EVENT_TYPES: readonly ["message.received", "message.sent", "message.delivered", "message.bounced", "message.complained", "mailbox.rule_matched", "mailbox.export.completed", "mailbox.export.failed", "domain.verified", "domain.verification_failed", "domain.degraded", "org.reputation_warning", "org.sending_throttled", "org.sending_suspended", "org.reputation_recovered", "reply.overdue", "conversation.needs_action", "calendar.event_starting", "booking.created", "subscriber.added", "newsletter.sent"];
|
|
70
|
+
declare const WEBHOOK_EVENT_TYPES: readonly ["message.received", "message.sent", "message.delayed", "message.delivered", "message.bounced", "message.complained", "mailbox.rule_matched", "mailbox.export.completed", "mailbox.export.failed", "domain.verified", "domain.verification_failed", "domain.degraded", "org.reputation_warning", "org.sending_throttled", "org.sending_suspended", "org.reputation_recovered", "reply.overdue", "conversation.needs_action", "calendar.event_starting", "booking.created", "subscriber.added", "newsletter.sent"];
|
|
71
71
|
type WebhookEventType = (typeof WEBHOOK_EVENT_TYPES)[number];
|
|
72
|
-
declare const WEBHOOK_DELIVERY_EVENT_TYPES: readonly ["webhook.test", "message.received", "message.sent", "message.delivered", "message.bounced", "message.complained", "mailbox.rule_matched", "mailbox.export.completed", "mailbox.export.failed", "domain.verified", "domain.verification_failed", "domain.degraded", "org.reputation_warning", "org.sending_throttled", "org.sending_suspended", "org.reputation_recovered", "reply.overdue", "conversation.needs_action", "calendar.event_starting", "booking.created", "subscriber.added", "newsletter.sent"];
|
|
72
|
+
declare const WEBHOOK_DELIVERY_EVENT_TYPES: readonly ["webhook.test", "message.received", "message.sent", "message.delayed", "message.delivered", "message.bounced", "message.complained", "mailbox.rule_matched", "mailbox.export.completed", "mailbox.export.failed", "domain.verified", "domain.verification_failed", "domain.degraded", "org.reputation_warning", "org.sending_throttled", "org.sending_suspended", "org.reputation_recovered", "reply.overdue", "conversation.needs_action", "calendar.event_starting", "booking.created", "subscriber.added", "newsletter.sent"];
|
|
73
73
|
type WebhookDeliveryEventType = (typeof WEBHOOK_DELIVERY_EVENT_TYPES)[number];
|
|
74
74
|
type StatusResponse = {
|
|
75
75
|
readonly status: string;
|
|
@@ -1358,7 +1358,7 @@ type InboxMessageAction = {
|
|
|
1358
1358
|
};
|
|
1359
1359
|
type MailboxRuleMatchMode = "all" | "any";
|
|
1360
1360
|
type MailboxRuleCondition = {
|
|
1361
|
-
readonly type: "from_is" | "from_contains" | "recipient_is" | "plus_tag_is" | "subject_contains";
|
|
1361
|
+
readonly type: "from_is" | "from_contains" | "recipient_is" | "recipient_contains" | "plus_tag_is" | "subject_contains";
|
|
1362
1362
|
readonly value: string;
|
|
1363
1363
|
} | {
|
|
1364
1364
|
readonly type: "has_attachment" | "list_unsubscribe_exists";
|
|
@@ -2223,6 +2223,8 @@ type Webhook = {
|
|
|
2223
2223
|
readonly description: string | null;
|
|
2224
2224
|
readonly mailbox_ids: readonly string[] | null;
|
|
2225
2225
|
readonly domain_ids: readonly string[] | null;
|
|
2226
|
+
readonly has_authorization: boolean;
|
|
2227
|
+
readonly has_standard_webhooks_secret: boolean;
|
|
2226
2228
|
readonly created_at: string;
|
|
2227
2229
|
readonly updated_at: string;
|
|
2228
2230
|
};
|
|
@@ -2235,6 +2237,10 @@ type CreateWebhookParams = {
|
|
|
2235
2237
|
readonly description?: string | undefined;
|
|
2236
2238
|
readonly mailbox_ids?: readonly string[] | null | undefined;
|
|
2237
2239
|
readonly domain_ids?: readonly string[] | null | undefined;
|
|
2240
|
+
/** Sent verbatim as the `Authorization` header of every delivery. Write-only. */
|
|
2241
|
+
readonly authorization?: string | null | undefined;
|
|
2242
|
+
/** A `whsec_` secret from the receiving service. Deliveries then carry Standard Webhooks signatures. Write-only. */
|
|
2243
|
+
readonly standard_webhooks_secret?: string | null | undefined;
|
|
2238
2244
|
};
|
|
2239
2245
|
type UpdateWebhookParams = {
|
|
2240
2246
|
readonly url?: string | undefined;
|
|
@@ -2243,6 +2249,10 @@ type UpdateWebhookParams = {
|
|
|
2243
2249
|
readonly active?: boolean | undefined;
|
|
2244
2250
|
readonly mailbox_ids?: readonly string[] | null | undefined;
|
|
2245
2251
|
readonly domain_ids?: readonly string[] | null | undefined;
|
|
2252
|
+
/** A string replaces the delivery `Authorization` header, `null` removes it. */
|
|
2253
|
+
readonly authorization?: string | null | undefined;
|
|
2254
|
+
/** A string replaces the Standard Webhooks signing secret, `null` removes it. */
|
|
2255
|
+
readonly standard_webhooks_secret?: string | null | undefined;
|
|
2246
2256
|
};
|
|
2247
2257
|
type ListWebhooksParams = PaginationParams;
|
|
2248
2258
|
type RotateSecretResponse = {
|
package/dist/index.d.ts
CHANGED
|
@@ -67,9 +67,9 @@ type EmailRecipient = {
|
|
|
67
67
|
readonly name?: string | null | undefined;
|
|
68
68
|
};
|
|
69
69
|
type EmailRecipientInput = EmailRecipient | string;
|
|
70
|
-
declare const WEBHOOK_EVENT_TYPES: readonly ["message.received", "message.sent", "message.delivered", "message.bounced", "message.complained", "mailbox.rule_matched", "mailbox.export.completed", "mailbox.export.failed", "domain.verified", "domain.verification_failed", "domain.degraded", "org.reputation_warning", "org.sending_throttled", "org.sending_suspended", "org.reputation_recovered", "reply.overdue", "conversation.needs_action", "calendar.event_starting", "booking.created", "subscriber.added", "newsletter.sent"];
|
|
70
|
+
declare const WEBHOOK_EVENT_TYPES: readonly ["message.received", "message.sent", "message.delayed", "message.delivered", "message.bounced", "message.complained", "mailbox.rule_matched", "mailbox.export.completed", "mailbox.export.failed", "domain.verified", "domain.verification_failed", "domain.degraded", "org.reputation_warning", "org.sending_throttled", "org.sending_suspended", "org.reputation_recovered", "reply.overdue", "conversation.needs_action", "calendar.event_starting", "booking.created", "subscriber.added", "newsletter.sent"];
|
|
71
71
|
type WebhookEventType = (typeof WEBHOOK_EVENT_TYPES)[number];
|
|
72
|
-
declare const WEBHOOK_DELIVERY_EVENT_TYPES: readonly ["webhook.test", "message.received", "message.sent", "message.delivered", "message.bounced", "message.complained", "mailbox.rule_matched", "mailbox.export.completed", "mailbox.export.failed", "domain.verified", "domain.verification_failed", "domain.degraded", "org.reputation_warning", "org.sending_throttled", "org.sending_suspended", "org.reputation_recovered", "reply.overdue", "conversation.needs_action", "calendar.event_starting", "booking.created", "subscriber.added", "newsletter.sent"];
|
|
72
|
+
declare const WEBHOOK_DELIVERY_EVENT_TYPES: readonly ["webhook.test", "message.received", "message.sent", "message.delayed", "message.delivered", "message.bounced", "message.complained", "mailbox.rule_matched", "mailbox.export.completed", "mailbox.export.failed", "domain.verified", "domain.verification_failed", "domain.degraded", "org.reputation_warning", "org.sending_throttled", "org.sending_suspended", "org.reputation_recovered", "reply.overdue", "conversation.needs_action", "calendar.event_starting", "booking.created", "subscriber.added", "newsletter.sent"];
|
|
73
73
|
type WebhookDeliveryEventType = (typeof WEBHOOK_DELIVERY_EVENT_TYPES)[number];
|
|
74
74
|
type StatusResponse = {
|
|
75
75
|
readonly status: string;
|
|
@@ -1358,7 +1358,7 @@ type InboxMessageAction = {
|
|
|
1358
1358
|
};
|
|
1359
1359
|
type MailboxRuleMatchMode = "all" | "any";
|
|
1360
1360
|
type MailboxRuleCondition = {
|
|
1361
|
-
readonly type: "from_is" | "from_contains" | "recipient_is" | "plus_tag_is" | "subject_contains";
|
|
1361
|
+
readonly type: "from_is" | "from_contains" | "recipient_is" | "recipient_contains" | "plus_tag_is" | "subject_contains";
|
|
1362
1362
|
readonly value: string;
|
|
1363
1363
|
} | {
|
|
1364
1364
|
readonly type: "has_attachment" | "list_unsubscribe_exists";
|
|
@@ -2223,6 +2223,8 @@ type Webhook = {
|
|
|
2223
2223
|
readonly description: string | null;
|
|
2224
2224
|
readonly mailbox_ids: readonly string[] | null;
|
|
2225
2225
|
readonly domain_ids: readonly string[] | null;
|
|
2226
|
+
readonly has_authorization: boolean;
|
|
2227
|
+
readonly has_standard_webhooks_secret: boolean;
|
|
2226
2228
|
readonly created_at: string;
|
|
2227
2229
|
readonly updated_at: string;
|
|
2228
2230
|
};
|
|
@@ -2235,6 +2237,10 @@ type CreateWebhookParams = {
|
|
|
2235
2237
|
readonly description?: string | undefined;
|
|
2236
2238
|
readonly mailbox_ids?: readonly string[] | null | undefined;
|
|
2237
2239
|
readonly domain_ids?: readonly string[] | null | undefined;
|
|
2240
|
+
/** Sent verbatim as the `Authorization` header of every delivery. Write-only. */
|
|
2241
|
+
readonly authorization?: string | null | undefined;
|
|
2242
|
+
/** A `whsec_` secret from the receiving service. Deliveries then carry Standard Webhooks signatures. Write-only. */
|
|
2243
|
+
readonly standard_webhooks_secret?: string | null | undefined;
|
|
2238
2244
|
};
|
|
2239
2245
|
type UpdateWebhookParams = {
|
|
2240
2246
|
readonly url?: string | undefined;
|
|
@@ -2243,6 +2249,10 @@ type UpdateWebhookParams = {
|
|
|
2243
2249
|
readonly active?: boolean | undefined;
|
|
2244
2250
|
readonly mailbox_ids?: readonly string[] | null | undefined;
|
|
2245
2251
|
readonly domain_ids?: readonly string[] | null | undefined;
|
|
2252
|
+
/** A string replaces the delivery `Authorization` header, `null` removes it. */
|
|
2253
|
+
readonly authorization?: string | null | undefined;
|
|
2254
|
+
/** A string replaces the Standard Webhooks signing secret, `null` removes it. */
|
|
2255
|
+
readonly standard_webhooks_secret?: string | null | undefined;
|
|
2246
2256
|
};
|
|
2247
2257
|
type ListWebhooksParams = PaginationParams;
|
|
2248
2258
|
type RotateSecretResponse = {
|
package/dist/index.js
CHANGED
|
@@ -1661,7 +1661,7 @@ var Webhooks = class extends ApiResource {
|
|
|
1661
1661
|
};
|
|
1662
1662
|
|
|
1663
1663
|
// src/version.ts
|
|
1664
|
-
var VERSION = "0.6.
|
|
1664
|
+
var VERSION = "0.6.4";
|
|
1665
1665
|
|
|
1666
1666
|
// src/client.ts
|
|
1667
1667
|
var DEFAULT_BASE_URL = "https://shipmail.to/api/v1";
|
|
@@ -1854,6 +1854,7 @@ var CONFERENCING_PROVIDER_IDS = ["zoom", "google_meet"];
|
|
|
1854
1854
|
var WEBHOOK_EVENT_TYPES = [
|
|
1855
1855
|
"message.received",
|
|
1856
1856
|
"message.sent",
|
|
1857
|
+
"message.delayed",
|
|
1857
1858
|
"message.delivered",
|
|
1858
1859
|
"message.bounced",
|
|
1859
1860
|
"message.complained",
|