delivrie 0.1.0 → 0.1.1

package/dist/cjs/client.cjs

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Delivrie = exports.VERSION = void 0;
 const webhooks_js_1 = require("./webhooks.cjs");
-exports.VERSION = "0.1.0";
+exports.VERSION = "0.1.1";
 const DEFAULT_BASE_URL = "https://delivrie.io/api";
 const sleep = (ms) => new Promise((r) => setTimeout(r, ms));
 const enc = encodeURIComponent;
@@ -101,6 +101,7 @@ class Delivrie {
             /** Send now, or schedule with `scheduled_at`. */
             send: (id, params = {}) => this.request("POST", `/broadcasts/${enc(id)}/send`, params.scheduled_at === undefined ? {} : { scheduled_at: params.scheduled_at instanceof Date ? params.scheduled_at.toISOString() : params.scheduled_at }),
             cancel: (id) => this.request("POST", `/broadcasts/${enc(id)}/cancel`),
+            /** How many contacts the broadcast will reach. */
             recipients: (id) => this.request("GET", `/broadcasts/${enc(id)}/recipients`),
             remove: (id) => this.request("DELETE", `/broadcasts/${enc(id)}`),
         };

package/dist/cjs/client.d.cts

@@ -1,6 +1,6 @@
-import type { ApiKey, Automation, Broadcast, Contact, CreateApiKeyRequest, CreateApiKeyResponse, CreateBroadcastRequest, CreateContactRequest, CreateDomainRequest, CreateEmailResponse, CreateTemplateRequest, CreateWebhookRequest, CreateWebhookResponse, Domain, Email, EmailSummary, ForwardEmailRequest, InboxThread, List, ListContactsParams, ListEmailsParams, Log, LogSummary, Metrics, Pagination, ReplyToThreadRequest, RequestOptions, Result, Segment, SendEmailRequest, SendEventRequest, Suppression, Template, Topic, UpdateContactRequest, UpdateDomainRequest, Usage, Webhook, WebhookDelivery, Deleted } from "./types.cjs";
+import type { ApiKey, Automation, Broadcast, Contact, CreateApiKeyRequest, CreateApiKeyResponse, CreateBroadcastRequest, CreateContactRequest, CreateDomainRequest, CreateEmailResponse, CreateTemplateRequest, CreateWebhookRequest, CreateWebhookResponse, Domain, Email, EmailSummary, ForwardEmailRequest, InboxThread, List, ListContactsParams, ListEmailsParams, Log, LogSummary, Metrics, Pagination, ReplyToThreadRequest, RequestOptions, Result, Segment, SendEmailRequest, SendEventRequest, Suppression, Template, Topic, UpdateContactRequest, UpdateDomainRequest, Usage, Webhook, WebhookDelivery, Deleted, BroadcastRecipientCount } from "./types.cjs";
 import { type VerifyWebhookOptions } from "./webhooks.cjs";
-export declare const VERSION = "0.1.0";
+export declare const VERSION = "0.1.1";
 export interface DelivrieOptions {
     /** Defaults to `https://delivrie.io/api`. */
     baseUrl?: string;
@@ -94,7 +94,10 @@ export declare class Delivrie {
         }>>;
         /** By id or email address. */
         get: (idOrEmail: string) => Promise<Result<Contact>>;
-        update: (idOrEmail: string, params: UpdateContactRequest) => Promise<Result<Contact>>;
+        update: (idOrEmail: string, params: UpdateContactRequest) => Promise<Result<{
+            object: "contact";
+            id: string;
+        }>>;
         list: (params?: ListContactsParams) => Promise<Result<List<Contact>>>;
         remove: (idOrEmail: string) => Promise<Result<Deleted>>;
     };
@@ -128,7 +131,8 @@ export declare class Delivrie {
             scheduled_at?: string | Date;
         }) => Promise<Result<Broadcast>>;
         cancel: (id: string) => Promise<Result<Broadcast>>;
-        recipients: (id: string) => Promise<Result<List<Record<string, unknown>>>>;
+        /** How many contacts the broadcast will reach. */
+        recipients: (id: string) => Promise<Result<BroadcastRecipientCount>>;
         remove: (id: string) => Promise<Result<Deleted>>;
     };
     readonly templates: {

package/dist/cjs/types.d.cts

@@ -49,8 +49,8 @@ export interface TemplateRef {
     variables?: Record<string, string | number | boolean | null>;
 }
 export interface SendEmailRequest {
-    /** Sender on a verified domain. `"Name <email@domain>"` sets a display name. */
-    from: string;
+    /** Sender on a verified domain. `"Name <email@domain>"` sets a display name. Optional when the template has a default sender. */
+    from?: string;
     /** One address or up to 50. */
     to: string | string[];
     /** Required unless you send a template. */
@@ -380,6 +380,14 @@ export interface ReplyToThreadRequest {
     text?: string;
     html?: string;
 }
+export interface BroadcastRecipientCount {
+    /** Contacts in the segment. */
+    total: number;
+    /** Contacts who opted out of the broadcast's topic. */
+    topic_opt_out: number;
+    /** Contacts it will be sent to, after unsubscribes, topic opt-outs and suppressions. */
+    recipients: number;
+}
 export interface Deleted {
     object: string;
     id: string;

package/dist/esm/client.d.ts

@@ -1,6 +1,6 @@
-import type { ApiKey, Automation, Broadcast, Contact, CreateApiKeyRequest, CreateApiKeyResponse, CreateBroadcastRequest, CreateContactRequest, CreateDomainRequest, CreateEmailResponse, CreateTemplateRequest, CreateWebhookRequest, CreateWebhookResponse, Domain, Email, EmailSummary, ForwardEmailRequest, InboxThread, List, ListContactsParams, ListEmailsParams, Log, LogSummary, Metrics, Pagination, ReplyToThreadRequest, RequestOptions, Result, Segment, SendEmailRequest, SendEventRequest, Suppression, Template, Topic, UpdateContactRequest, UpdateDomainRequest, Usage, Webhook, WebhookDelivery, Deleted } from "./types.js";
+import type { ApiKey, Automation, Broadcast, Contact, CreateApiKeyRequest, CreateApiKeyResponse, CreateBroadcastRequest, CreateContactRequest, CreateDomainRequest, CreateEmailResponse, CreateTemplateRequest, CreateWebhookRequest, CreateWebhookResponse, Domain, Email, EmailSummary, ForwardEmailRequest, InboxThread, List, ListContactsParams, ListEmailsParams, Log, LogSummary, Metrics, Pagination, ReplyToThreadRequest, RequestOptions, Result, Segment, SendEmailRequest, SendEventRequest, Suppression, Template, Topic, UpdateContactRequest, UpdateDomainRequest, Usage, Webhook, WebhookDelivery, Deleted, BroadcastRecipientCount } from "./types.js";
 import { type VerifyWebhookOptions } from "./webhooks.js";
-export declare const VERSION = "0.1.0";
+export declare const VERSION = "0.1.1";
 export interface DelivrieOptions {
     /** Defaults to `https://delivrie.io/api`. */
     baseUrl?: string;
@@ -94,7 +94,10 @@ export declare class Delivrie {
         }>>;
         /** By id or email address. */
         get: (idOrEmail: string) => Promise<Result<Contact>>;
-        update: (idOrEmail: string, params: UpdateContactRequest) => Promise<Result<Contact>>;
+        update: (idOrEmail: string, params: UpdateContactRequest) => Promise<Result<{
+            object: "contact";
+            id: string;
+        }>>;
         list: (params?: ListContactsParams) => Promise<Result<List<Contact>>>;
         remove: (idOrEmail: string) => Promise<Result<Deleted>>;
     };
@@ -128,7 +131,8 @@ export declare class Delivrie {
             scheduled_at?: string | Date;
         }) => Promise<Result<Broadcast>>;
         cancel: (id: string) => Promise<Result<Broadcast>>;
-        recipients: (id: string) => Promise<Result<List<Record<string, unknown>>>>;
+        /** How many contacts the broadcast will reach. */
+        recipients: (id: string) => Promise<Result<BroadcastRecipientCount>>;
         remove: (id: string) => Promise<Result<Deleted>>;
     };
     readonly templates: {

package/dist/esm/client.js

@@ -1,5 +1,5 @@
 import { verifyWebhook } from "./webhooks.js";
-export const VERSION = "0.1.0";
+export const VERSION = "0.1.1";
 const DEFAULT_BASE_URL = "https://delivrie.io/api";
 const sleep = (ms) => new Promise((r) => setTimeout(r, ms));
 const enc = encodeURIComponent;
@@ -98,6 +98,7 @@ export class Delivrie {
             /** Send now, or schedule with `scheduled_at`. */
             send: (id, params = {}) => this.request("POST", `/broadcasts/${enc(id)}/send`, params.scheduled_at === undefined ? {} : { scheduled_at: params.scheduled_at instanceof Date ? params.scheduled_at.toISOString() : params.scheduled_at }),
             cancel: (id) => this.request("POST", `/broadcasts/${enc(id)}/cancel`),
+            /** How many contacts the broadcast will reach. */
             recipients: (id) => this.request("GET", `/broadcasts/${enc(id)}/recipients`),
             remove: (id) => this.request("DELETE", `/broadcasts/${enc(id)}`),
         };

package/dist/esm/types.d.ts

@@ -49,8 +49,8 @@ export interface TemplateRef {
     variables?: Record<string, string | number | boolean | null>;
 }
 export interface SendEmailRequest {
-    /** Sender on a verified domain. `"Name <email@domain>"` sets a display name. */
-    from: string;
+    /** Sender on a verified domain. `"Name <email@domain>"` sets a display name. Optional when the template has a default sender. */
+    from?: string;
     /** One address or up to 50. */
     to: string | string[];
     /** Required unless you send a template. */
@@ -380,6 +380,14 @@ export interface ReplyToThreadRequest {
     text?: string;
     html?: string;
 }
+export interface BroadcastRecipientCount {
+    /** Contacts in the segment. */
+    total: number;
+    /** Contacts who opted out of the broadcast's topic. */
+    topic_opt_out: number;
+    /** Contacts it will be sent to, after unsubscribes, topic opt-outs and suppressions. */
+    recipients: number;
+}
 export interface Deleted {
     object: string;
     id: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "delivrie",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Official Node.js and TypeScript SDK for the Delivrie email API: send transactional email, manage domains, contacts, broadcasts and templates, and verify webhooks.",
   "keywords": ["delivrie", "email", "email-api", "transactional-email", "smtp", "resend-alternative", "webhooks", "nigeria", "naira"],
   "homepage": "https://delivrie.io/docs/sdks",