@voltade/envoy-sdk 1.3.0 → 1.3.2

package/dist/client.js

@@ -1,5 +1,5 @@
 import { HttpClient } from "./http-client.js";
-import { Companies, Contacts, Conversations, Inboxes, Orders, } from "./resources/index.js";
+import { Campaigns, Companies, Contacts, Conversations, Inboxes, Orders, } from "./resources/index.js";
 /**
  * Envoy API Client
  * A comprehensive SDK for interacting with the Envoy API
@@ -35,6 +35,7 @@ export class EnvoyClient {
         };
         this.httpClient = new HttpClient(httpConfig);
         // Initialize resources
+        this.campaigns = new Campaigns(this.httpClient);
         this.companies = new Companies(this.httpClient);
         this.contacts = new Contacts(this.httpClient);
         this.conversations = new Conversations(this.httpClient);

package/dist/client.js.map

@@ -1 +1 @@
-{"version":3,"file":"client.js","sourceRoot":"","sources":["../client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAyB,MAAM,kBAAkB,CAAC;AACrE,OAAO,EACL,SAAS,EACT,QAAQ,EACR,aAAa,EACb,OAAO,EACP,MAAM,GACP,MAAM,sBAAsB,CAAC;AAY9B;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,OAAO,WAAW;IA4BtB,YAAY,MAAyB;QACnC,MAAM,UAAU,GAAqB;YACnC,GAAG,MAAM;SACV,CAAC;QAEF,IAAI,CAAC,UAAU,GAAG,IAAI,UAAU,CAAC,UAAU,CAAC,CAAC;QAE7C,uBAAuB;QACvB,IAAI,CAAC,SAAS,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAChD,IAAI,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC9C,IAAI,CAAC,aAAa,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACxD,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC5C,CAAC;IAED;;;OAGG;IACH,aAAa;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;CACF"}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAyB,MAAM,kBAAkB,CAAC;AACrE,OAAO,EACL,SAAS,EACT,SAAS,EACT,QAAQ,EACR,aAAa,EACb,OAAO,EACP,MAAM,GACP,MAAM,sBAAsB,CAAC;AAY9B;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,OAAO,WAAW;IAiCtB,YAAY,MAAyB;QACnC,MAAM,UAAU,GAAqB;YACnC,GAAG,MAAM;SACV,CAAC;QAEF,IAAI,CAAC,UAAU,GAAG,IAAI,UAAU,CAAC,UAAU,CAAC,CAAC;QAE7C,uBAAuB;QACvB,IAAI,CAAC,SAAS,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAChD,IAAI,CAAC,SAAS,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAChD,IAAI,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC9C,IAAI,CAAC,aAAa,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACxD,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC5C,CAAC;IAED;;;OAGG;IACH,aAAa;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;CACF"}

package/dist/resources/base-resource.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Base resource class that all resource classes extend from
+ */
+import type { HttpClient } from "../http-client.js";
+export declare abstract class BaseResource {
+    protected readonly client: HttpClient;
+    constructor(client: HttpClient);
+}
+//# sourceMappingURL=base-resource.d.ts.map

package/dist/resources/base-resource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-resource.d.ts","sourceRoot":"","sources":["../../resources/base-resource.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAEpD,8BAAsB,YAAY;IACpB,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,UAAU;gBAAlB,MAAM,EAAE,UAAU;CAClD"}

package/dist/resources/base-resource.js

@@ -0,0 +1,9 @@
+/**
+ * Base resource class that all resource classes extend from
+ */
+export class BaseResource {
+    constructor(client) {
+        this.client = client;
+    }
+}
+//# sourceMappingURL=base-resource.js.map

package/dist/resources/base-resource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-resource.js","sourceRoot":"","sources":["../../resources/base-resource.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH,MAAM,OAAgB,YAAY;IAChC,YAA+B,MAAkB;QAAlB,WAAM,GAAN,MAAM,CAAY;IAAG,CAAC;CACtD"}

package/dist/resources/campaigns/index.d.ts

@@ -0,0 +1,123 @@
+/**
+ * Campaigns resource module
+ * Provides functionality for managing campaigns in Envoy
+ */
+import { BaseResource } from "../base-resource.js";
+import type { CampaignResponse, CreateCampaignPayload, CreateWhatsAppCampaignParams } from "./types.js";
+/**
+ * Campaigns resource class for managing campaign-related operations
+ */
+export declare class Campaigns extends BaseResource {
+    /**
+     * Create a campaign
+     * @param payload - Campaign creation parameters
+     * @returns The created campaign
+     *
+     * @example
+     * ```typescript
+     * const campaign = await client.campaigns.create({
+     *   title: "Welcome Campaign",
+     *   message: "Welcome to our service!",
+     *   inbox_id: 12,
+     *   campaign_status: "active"
+     * });
+     * ```
+     *
+     * @example With audience
+     * ```typescript
+     * const campaign = await client.campaigns.create({
+     *   title: "Promo Campaign",
+     *   message: "Check out our new offers!",
+     *   inbox_id: 12,
+     *   campaign_status: "active",
+     *   audience: [
+     *     { type: "Contact", id: 123, name: "John Doe" },
+     *     { type: "PhoneNumber", id: "+6591234567", name: "Jane Doe" }
+     *   ]
+     * });
+     * ```
+     *
+     * @example Scheduled campaign
+     * ```typescript
+     * const campaign = await client.campaigns.create({
+     *   title: "Scheduled Campaign",
+     *   message: "This is a scheduled message",
+     *   inbox_id: 12,
+     *   campaign_status: "scheduled",
+     *   scheduled_at: Math.floor(Date.now() / 1000) + 3600 // 1 hour from now
+     * });
+     * ```
+     *
+     * @example WhatsApp template campaign
+     * ```typescript
+     * const campaign = await client.campaigns.create({
+     *   title: "Balance Reminder",
+     *   message: "Sending WhatsApp template: 1_bal_reminder_2025",
+     *   inbox_id: 12,
+     *   campaign_status: "active",
+     *   audience: [
+     *     {
+     *       type: "PhoneNumber",
+     *       id: "+6591234567",
+     *       name: "John Doe",
+     *       processed_params: { customers_name: "John", balance: "3" }
+     *     }
+     *   ],
+     *   trigger_rules: {
+     *     template_params: {
+     *       category: "MARKETING",
+     *       language: "en",
+     *       name: "1_bal_reminder_2025",
+     *       processed_params: { customers_name: "Customer", balance: "0" },
+     *       media_id: null
+     *     }
+     *   }
+     * });
+     * ```
+     */
+    create(payload: CreateCampaignPayload): Promise<CampaignResponse>;
+    /**
+     * Create a WhatsApp template campaign with a simplified helper
+     * @param params - WhatsApp campaign parameters
+     * @returns The created campaign
+     *
+     * @example
+     * ```typescript
+     * const campaign = await client.campaigns.createWhatsAppCampaign({
+     *   title: "Lesson Balance Reminder",
+     *   inboxId: 12,
+     *   whatsappTemplate: {
+     *     name: "1_bal_reminder_2025",
+     *     category: "MARKETING",
+     *     language: "en",
+     *     defaultParams: {
+     *       customers_name: "Customer",
+     *       child_name: "Student"
+     *     }
+     *   },
+     *   recipients: [
+     *     {
+     *       phoneNumber: "+6591234567",
+     *       name: "John Doe",
+     *       params: {
+     *         customers_name: "John",
+     *         child_name: "Alice"
+     *       }
+     *     },
+     *     {
+     *       phoneNumber: "+6598765432",
+     *       name: "Jane Doe",
+     *       params: {
+     *         customers_name: "Jane",
+     *         child_name: "Bob"
+     *       }
+     *     }
+     *   ]
+     * });
+     * ```
+     */
+    createWhatsAppCampaign(params: CreateWhatsAppCampaignParams): Promise<CampaignResponse>;
+}
+export type { AudienceEntry, AudienceType, CampaignInbox, CampaignResponse, CampaignSender, CampaignStatus, CreateCampaignError, CreateCampaignPayload, CreateWhatsAppCampaignParams, Recipient, SendTimingStrategy, TemplateCategory, TriggerRules, WhatsAppTemplateConfig, WhatsAppTemplateParams, } from "./types.js";
+export { AudienceEntrySchema, AudienceTypeSchema, CampaignInboxSchema, CampaignResponseSchema, CampaignSenderSchema, CampaignStatusSchema, CreateCampaignErrorSchema, CreateCampaignPayloadSchema, CreateWhatsAppCampaignParamsSchema, RecipientSchema, SendTimingStrategySchema, TemplateCategorySchema, TriggerRulesSchema, WhatsAppTemplateConfigSchema, WhatsAppTemplateParamsSchema, } from "./types.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/resources/campaigns/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../resources/campaigns/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,KAAK,EAEV,gBAAgB,EAChB,qBAAqB,EACrB,4BAA4B,EAC7B,MAAM,YAAY,CAAC;AAEpB;;GAEG;AACH,qBAAa,SAAU,SAAQ,YAAY;IACzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkEG;IACG,MAAM,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAkBvE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACG,sBAAsB,CAC1B,MAAM,EAAE,4BAA4B,GACnC,OAAO,CAAC,gBAAgB,CAAC;CAuC7B;AAGD,YAAY,EACV,aAAa,EACb,YAAY,EACZ,aAAa,EACb,gBAAgB,EAChB,cAAc,EACd,cAAc,EACd,mBAAmB,EACnB,qBAAqB,EACrB,4BAA4B,EAC5B,SAAS,EACT,kBAAkB,EAClB,gBAAgB,EAChB,YAAY,EACZ,sBAAsB,EACtB,sBAAsB,GACvB,MAAM,YAAY,CAAC;AAGpB,OAAO,EACL,mBAAmB,EACnB,kBAAkB,EAClB,mBAAmB,EACnB,sBAAsB,EACtB,oBAAoB,EACpB,oBAAoB,EACpB,yBAAyB,EACzB,2BAA2B,EAC3B,kCAAkC,EAClC,eAAe,EACf,wBAAwB,EACxB,sBAAsB,EACtB,kBAAkB,EAClB,4BAA4B,EAC5B,4BAA4B,GAC7B,MAAM,YAAY,CAAC"}

package/dist/resources/campaigns/index.js

@@ -0,0 +1,159 @@
+/**
+ * Campaigns resource module
+ * Provides functionality for managing campaigns in Envoy
+ */
+import { BaseResource } from "../base-resource.js";
+/**
+ * Campaigns resource class for managing campaign-related operations
+ */
+export class Campaigns extends BaseResource {
+    /**
+     * Create a campaign
+     * @param payload - Campaign creation parameters
+     * @returns The created campaign
+     *
+     * @example
+     * ```typescript
+     * const campaign = await client.campaigns.create({
+     *   title: "Welcome Campaign",
+     *   message: "Welcome to our service!",
+     *   inbox_id: 12,
+     *   campaign_status: "active"
+     * });
+     * ```
+     *
+     * @example With audience
+     * ```typescript
+     * const campaign = await client.campaigns.create({
+     *   title: "Promo Campaign",
+     *   message: "Check out our new offers!",
+     *   inbox_id: 12,
+     *   campaign_status: "active",
+     *   audience: [
+     *     { type: "Contact", id: 123, name: "John Doe" },
+     *     { type: "PhoneNumber", id: "+6591234567", name: "Jane Doe" }
+     *   ]
+     * });
+     * ```
+     *
+     * @example Scheduled campaign
+     * ```typescript
+     * const campaign = await client.campaigns.create({
+     *   title: "Scheduled Campaign",
+     *   message: "This is a scheduled message",
+     *   inbox_id: 12,
+     *   campaign_status: "scheduled",
+     *   scheduled_at: Math.floor(Date.now() / 1000) + 3600 // 1 hour from now
+     * });
+     * ```
+     *
+     * @example WhatsApp template campaign
+     * ```typescript
+     * const campaign = await client.campaigns.create({
+     *   title: "Balance Reminder",
+     *   message: "Sending WhatsApp template: 1_bal_reminder_2025",
+     *   inbox_id: 12,
+     *   campaign_status: "active",
+     *   audience: [
+     *     {
+     *       type: "PhoneNumber",
+     *       id: "+6591234567",
+     *       name: "John Doe",
+     *       processed_params: { customers_name: "John", balance: "3" }
+     *     }
+     *   ],
+     *   trigger_rules: {
+     *     template_params: {
+     *       category: "MARKETING",
+     *       language: "en",
+     *       name: "1_bal_reminder_2025",
+     *       processed_params: { customers_name: "Customer", balance: "0" },
+     *       media_id: null
+     *     }
+     *   }
+     * });
+     * ```
+     */
+    async create(payload) {
+        // Validate required fields
+        if (!payload.title || !payload.message || !payload.inbox_id) {
+            throw new Error("Missing required fields: title, message, and inbox_id are required");
+        }
+        // Validate campaign_status and scheduled_at
+        if (payload.campaign_status === "scheduled" && !payload.scheduled_at) {
+            throw new Error('scheduled_at is required when campaign_status is "scheduled"');
+        }
+        return await this.client.post("/campaigns", payload);
+    }
+    /**
+     * Create a WhatsApp template campaign with a simplified helper
+     * @param params - WhatsApp campaign parameters
+     * @returns The created campaign
+     *
+     * @example
+     * ```typescript
+     * const campaign = await client.campaigns.createWhatsAppCampaign({
+     *   title: "Lesson Balance Reminder",
+     *   inboxId: 12,
+     *   whatsappTemplate: {
+     *     name: "1_bal_reminder_2025",
+     *     category: "MARKETING",
+     *     language: "en",
+     *     defaultParams: {
+     *       customers_name: "Customer",
+     *       child_name: "Student"
+     *     }
+     *   },
+     *   recipients: [
+     *     {
+     *       phoneNumber: "+6591234567",
+     *       name: "John Doe",
+     *       params: {
+     *         customers_name: "John",
+     *         child_name: "Alice"
+     *       }
+     *     },
+     *     {
+     *       phoneNumber: "+6598765432",
+     *       name: "Jane Doe",
+     *       params: {
+     *         customers_name: "Jane",
+     *         child_name: "Bob"
+     *       }
+     *     }
+     *   ]
+     * });
+     * ```
+     */
+    async createWhatsAppCampaign(params) {
+        const { title, inboxId, whatsappTemplate, recipients, scheduledAt, campaignStatus = "active", description, } = params;
+        const audience = recipients.map((recipient) => ({
+            type: "PhoneNumber",
+            name: recipient.name,
+            id: recipient.phoneNumber,
+            processed_params: recipient.params,
+        }));
+        const payload = {
+            title,
+            message: `Sending WhatsApp template: ${whatsappTemplate.name}`,
+            inbox_id: inboxId,
+            campaign_status: campaignStatus,
+            scheduled_at: scheduledAt,
+            description,
+            audience,
+            trigger_rules: {
+                template_params: {
+                    category: whatsappTemplate.category ?? "MARKETING",
+                    language: whatsappTemplate.language ?? "en",
+                    name: whatsappTemplate.name,
+                    processed_params: whatsappTemplate.defaultParams,
+                    media_id: whatsappTemplate.mediaId ?? null,
+                },
+            },
+        };
+        return this.create(payload);
+    }
+}
+// Re-export Zod schemas
+export { AudienceEntrySchema, AudienceTypeSchema, CampaignInboxSchema, CampaignResponseSchema, CampaignSenderSchema, CampaignStatusSchema, CreateCampaignErrorSchema, CreateCampaignPayloadSchema, CreateWhatsAppCampaignParamsSchema, RecipientSchema, SendTimingStrategySchema, TemplateCategorySchema, TriggerRulesSchema, WhatsAppTemplateConfigSchema, WhatsAppTemplateParamsSchema, } from "./types.js";
+//# sourceMappingURL=index.js.map

package/dist/resources/campaigns/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../resources/campaigns/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAQnD;;GAEG;AACH,MAAM,OAAO,SAAU,SAAQ,YAAY;IACzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkEG;IACH,KAAK,CAAC,MAAM,CAAC,OAA8B;QACzC,2BAA2B;QAC3B,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC,OAAO,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;YAC5D,MAAM,IAAI,KAAK,CACb,oEAAoE,CACrE,CAAC;QACJ,CAAC;QAED,4CAA4C;QAC5C,IAAI,OAAO,CAAC,eAAe,KAAK,WAAW,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC;YACrE,MAAM,IAAI,KAAK,CACb,8DAA8D,CAC/D,CAAC;QACJ,CAAC;QAED,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAmB,YAAY,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,KAAK,CAAC,sBAAsB,CAC1B,MAAoC;QAEpC,MAAM,EACJ,KAAK,EACL,OAAO,EACP,gBAAgB,EAChB,UAAU,EACV,WAAW,EACX,cAAc,GAAG,QAAQ,EACzB,WAAW,GACZ,GAAG,MAAM,CAAC;QAEX,MAAM,QAAQ,GAAoB,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;YAC/D,IAAI,EAAE,aAAsB;YAC5B,IAAI,EAAE,SAAS,CAAC,IAAI;YACpB,EAAE,EAAE,SAAS,CAAC,WAAW;YACzB,gBAAgB,EAAE,SAAS,CAAC,MAAM;SACnC,CAAC,CAAC,CAAC;QAEJ,MAAM,OAAO,GAA0B;YACrC,KAAK;YACL,OAAO,EAAE,8BAA8B,gBAAgB,CAAC,IAAI,EAAE;YAC9D,QAAQ,EAAE,OAAO;YACjB,eAAe,EAAE,cAAc;YAC/B,YAAY,EAAE,WAAW;YACzB,WAAW;YACX,QAAQ;YACR,aAAa,EAAE;gBACb,eAAe,EAAE;oBACf,QAAQ,EAAE,gBAAgB,CAAC,QAAQ,IAAI,WAAW;oBAClD,QAAQ,EAAE,gBAAgB,CAAC,QAAQ,IAAI,IAAI;oBAC3C,IAAI,EAAE,gBAAgB,CAAC,IAAI;oBAC3B,gBAAgB,EAAE,gBAAgB,CAAC,aAAa;oBAChD,QAAQ,EAAE,gBAAgB,CAAC,OAAO,IAAI,IAAI;iBAC3C;aACF;SACF,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;CACF;AAqBD,wBAAwB;AACxB,OAAO,EACL,mBAAmB,EACnB,kBAAkB,EAClB,mBAAmB,EACnB,sBAAsB,EACtB,oBAAoB,EACpB,oBAAoB,EACpB,yBAAyB,EACzB,2BAA2B,EAC3B,kCAAkC,EAClC,eAAe,EACf,wBAAwB,EACxB,sBAAsB,EACtB,kBAAkB,EAClB,4BAA4B,EAC5B,4BAA4B,GAC7B,MAAM,YAAY,CAAC"}