sdx-mailer-sdk 1.0.21 → 1.0.22

package/index.d.ts

@@ -48,16 +48,14 @@ export interface CourierExceptionRequest {
 
 /**
  * Request payload for customer-related emails (register, password update, etc.).
- * Build this object using `createCustomerMailerRequest`, then pass it to the
+ * Build this object using `createCustomerMailPayload`, then pass it to the
  * corresponding `sendMail*` customer function.
  */
-export interface CustomerMailerRequest {
-    /** Username or email of the customer */
-    user: string;
-    /** Customer password (used in registration emails) */
-    password: string;
-    /** Product name shown in the email */
-    product: string;
+export interface CustomerMailPayload {
+    /** Username or email of the customer payload */
+    user: any;
+    /** Optional product payload used for branding */
+    product: any | null;
     /** Verification or action token included in the email */
     token: string;
     /** Reply-to email address */
@@ -66,19 +64,40 @@ export interface CustomerMailerRequest {
     trx?: string;
 }
 
+/**
+ * Request payload for the register-by-owner flow.
+ * Build this object using `createCustomerMailOwnerPayload`, then pass it to `sendMailRegisterByOwner`.
+ */
+export interface CustomerMailOwnerPayload extends CustomerMailPayload {
+    /** Initial password assigned by the owner */
+    password: string;
+}
+
 /**
  * Request payload for payment notification emails.
- * Build this object using `createPaymentsMailerRequest`, then pass it to `sendMailPayment`.
+ * Build this object using `createPaymentMailPayload`, then pass it to `sendMailPayment`.
  */
-export interface PaymentsMailerRequest {
+export interface PaymentMailPayload {
     /** Transaction ID associated with the payment */
     trxId: string;
-    /** Product licence or identifier related to the payment */
-    licence: string;
+    /** Product licence payload related to the payment */
+    licence: any | null;
     /** Transaction/signature identifier — set automatically when the request is signed */
     trx?: string;
 }
 
+/**
+ * Backwards-compatible alias for `CustomerMailOwnerPayload`.
+ * @deprecated Use `CustomerMailPayload` or `CustomerMailOwnerPayload`.
+ */
+export type CustomerMailerRequest = CustomerMailOwnerPayload;
+
+/**
+ * Backwards-compatible alias for `PaymentMailPayload`.
+ * @deprecated Use `PaymentMailPayload`.
+ */
+export type PaymentsMailerRequest = PaymentMailPayload;
+
 // ---------------------------------------------------------------------------
 // COURIER
 // ---------------------------------------------------------------------------
@@ -188,99 +207,126 @@ export function sendExceptionMail(
 // ---------------------------------------------------------------------------
 
 /**
- * Creates a `CustomerMailerRequest` object used for all customer email flows
- * (register, password update, etc.).
+ * Creates a `CustomerMailPayload` object used for customer email flows that
+ * do not include an initial password.
  *
  * @param user - Username or email address of the customer.
- * @param password - Customer's password (included in registration emails).
- * @param product - Product name displayed in the email template.
  * @param token - Verification or action token to embed in the email (e.g. for password reset links).
  * @param reply_mail - Reply-to email address shown in the email.
- * @returns A `CustomerMailerRequest` instance. Sign it (add a `trx` field) before calling any `sendMail*` function.
+ * @param product - Optional product payload used for branding.
+ * @returns A `CustomerMailPayload` instance. Sign it (add a `trx` field) before calling any `sendMail*` function.
  *
  * @example
- * const request = createCustomerMailerRequest(
+ * const request = createCustomerMailPayload(
  *   'usuario@ejemplo.com',
- *   'MiP@ss123',
- *   'MiProducto',
  *   'abc123token',
- *   'soporte@miapp.com'
+ *   'soporte@miapp.com',
+ *   { id: 1, name: 'MiProducto' }
  * );
  */
+export function createCustomerMailPayload(
+    user: any,
+    token: string,
+    reply_mail: string,
+    product?: any | null
+): CustomerMailPayload;
+
+/**
+ * Creates a `CustomerMailOwnerPayload` object for the register-by-owner flow.
+ *
+ * @param user - Username or email address of the customer.
+ * @param password - Initial password assigned by the owner.
+ * @param token - Verification or action token to embed in the email.
+ * @param reply_mail - Reply-to email address shown in the email.
+ * @param product - Optional product payload used for branding.
+ * @returns A `CustomerMailOwnerPayload` instance. Sign it (add a `trx` field) before calling `sendMailRegisterByOwner`.
+ */
+export function createCustomerMailOwnerPayload(
+    user: any,
+    password: string,
+    token: string,
+    reply_mail: string,
+    product?: any | null
+): CustomerMailOwnerPayload;
+
+/**
+ * Backwards-compatible alias for `createCustomerMailOwnerPayload`.
+ * @deprecated Use `createCustomerMailPayload` or `createCustomerMailOwnerPayload`.
+ */
 export function createCustomerMailerRequest(
-    user: string,
+    user: any,
     password: string,
-    product: string,
+    product: any | null,
     token: string,
     reply_mail: string
-): CustomerMailerRequest;
+): CustomerMailOwnerPayload;
 
 /**
  * Sends a "update your password" notification email to the customer.
  *
- * The `tokenRQ` must be a **signed** `CustomerMailerRequest` (i.e. it must have a `trx` field set).
+ * The `tokenRQ` must be a **signed** `CustomerMailPayload` (i.e. it must have a `trx` field set).
  * Throws a `WebServiceException` if the request is not signed or if the API call fails.
  *
  * @param basicAuth - Authorization header value (e.g. `'Basic dXNlcjpwYXNz'`). Pass `null` to send without auth.
  * @param endpoint - Base URL of the SDX Mailer API (e.g. `'https://mailer.miapp.com'`).
- * @param tokenRQ - Signed `CustomerMailerRequest` to send.
+ * @param tokenRQ - Signed `CustomerMailPayload` to send.
  * @returns A promise that resolves with the API response data.
  */
 export function sendMailUpdatePassword(
     basicAuth: string | null,
     endpoint: string,
-    tokenRQ: CustomerMailerRequest
+    tokenRQ: CustomerMailPayload
 ): Promise<any>;
 
 /**
  * Sends a "password updated successfully" confirmation email to the customer.
  *
- * The `tokenRQ` must be a **signed** `CustomerMailerRequest` (i.e. it must have a `trx` field set).
+ * The `tokenRQ` must be a **signed** `CustomerMailPayload` (i.e. it must have a `trx` field set).
  * Throws a `WebServiceException` if the request is not signed or if the API call fails.
  *
  * @param basicAuth - Authorization header value (e.g. `'Basic dXNlcjpwYXNz'`). Pass `null` to send without auth.
  * @param endpoint - Base URL of the SDX Mailer API (e.g. `'https://mailer.miapp.com'`).
- * @param tokenRQ - Signed `CustomerMailerRequest` to send.
+ * @param tokenRQ - Signed `CustomerMailPayload` to send.
  * @returns A promise that resolves with the API response data.
  */
 export function sendMailSuccessUpdatedPassword(
     basicAuth: string | null,
     endpoint: string,
-    tokenRQ: CustomerMailerRequest
+    tokenRQ: CustomerMailPayload
 ): Promise<any>;
 
 /**
  * Sends a customer registration welcome email.
  *
- * The `tokenRQ` must be a **signed** `CustomerMailerRequest` (i.e. it must have a `trx` field set).
+ * The `tokenRQ` must be a **signed** `CustomerMailPayload` (i.e. it must have a `trx` field set).
  * Throws a `WebServiceException` if the request is not signed or if the API call fails.
  *
  * @param basicAuth - Authorization header value (e.g. `'Basic dXNlcjpwYXNz'`). Pass `null` to send without auth.
  * @param endpoint - Base URL of the SDX Mailer API (e.g. `'https://mailer.miapp.com'`).
- * @param tokenRQ - Signed `CustomerMailerRequest` to send.
+ * @param tokenRQ - Signed `CustomerMailPayload` to send.
  * @returns A promise that resolves with the API response data.
  */
 export function sendMailRegister(
     basicAuth: string | null,
     endpoint: string,
-    tokenRQ: CustomerMailerRequest
+    tokenRQ: CustomerMailPayload
 ): Promise<any>;
 
 /**
  * Sends a customer registration email triggered by an owner/admin on behalf of the customer.
  *
- * The `tokenRQ` must be a **signed** `CustomerMailerRequest` (i.e. it must have a `trx` field set).
+ * The `tokenRQ` must be a **signed** `CustomerMailOwnerPayload` (i.e. it must have a `trx` field set).
  * Throws a `WebServiceException` if the request is not signed or if the API call fails.
  *
  * @param basicAuth - Authorization header value (e.g. `'Basic dXNlcjpwYXNz'`). Pass `null` to send without auth.
  * @param endpoint - Base URL of the SDX Mailer API (e.g. `'https://mailer.miapp.com'`).
- * @param tokenRQ - Signed `CustomerMailerRequest` to send.
+ * @param tokenRQ - Signed `CustomerMailOwnerPayload` to send.
  * @returns A promise that resolves with the API response data.
  */
 export function sendMailRegisterByOwner(
     basicAuth: string | null,
     endpoint: string,
-    tokenRQ: CustomerMailerRequest
+    tokenRQ: CustomerMailOwnerPayload
 ): Promise<any>;
 
 // ---------------------------------------------------------------------------
@@ -355,29 +401,38 @@ export function sendCustomMail(
 // ---------------------------------------------------------------------------
 
 /**
- * Creates a `PaymentsMailerRequest` object ready to be sent via `sendMailPayment`.
+ * Creates a `PaymentMailPayload` object ready to be sent via `sendMailPayment`.
  *
  * @param trxId - Transaction ID associated with the payment (e.g. order ID, payment reference).
- * @param product - Product name or licence identifier related to the payment.
- * @returns A `PaymentsMailerRequest` instance. Sign it (add a `trx` field) before calling `sendMailPayment`.
+ * @param licence - Licence payload related to the payment.
+ * @returns A `PaymentMailPayload` instance. Sign it (add a `trx` field) before calling `sendMailPayment`.
  *
  * @example
- * const request = createPaymentsMailerRequest('TRX-00123', 'PlanPro');
+ * const request = createPaymentMailPayload('TRX-00123', { id: 1, code: 'LIC-001' });
+ */
+export function createPaymentMailPayload(
+    trxId: string,
+    licence: any | null
+): PaymentMailPayload;
+
+/**
+ * Backwards-compatible alias for `createPaymentMailPayload`.
+ * @deprecated Use `createPaymentMailPayload`.
  */
 export function createPaymentsMailerRequest(
     trxId: string,
-    product: string
-): PaymentsMailerRequest;
+    licence: any | null
+): PaymentMailPayload;
 
 /**
  * Sends a payment confirmation email via the SDX Mailer API.
  *
- * The `tokenRQ` must be a **signed** `PaymentsMailerRequest` (i.e. it must have a `trx` field set).
+ * The `tokenRQ` must be a **signed** `PaymentMailPayload` (i.e. it must have a `trx` field set).
  * Throws a `WebServiceException` if the request is not signed or if the API call fails.
  *
  * @param basicAuth - Authorization header value (e.g. `'Basic dXNlcjpwYXNz'`). Pass `null` to send without auth.
  * @param endpoint - Base URL of the SDX Mailer API (e.g. `'https://mailer.miapp.com'`).
- * @param tokenRQ - Signed `PaymentsMailerRequest` to send.
+ * @param tokenRQ - Signed `PaymentMailPayload` to send.
  * @returns A promise that resolves with the API response data.
  *
  * @example
@@ -386,5 +441,5 @@ export function createPaymentsMailerRequest(
 export function sendMailPayment(
     basicAuth: string | null,
     endpoint: string,
-    tokenRQ: PaymentsMailerRequest
+    tokenRQ: PaymentMailPayload
 ): Promise<any>;

package/index.js

@@ -62,13 +62,33 @@ async function sendExceptionMail(basicAuth, endpoint, tokenRQ, productId) {
 }
 
 /**
- * Creates a `CustomerMailerRequest` object used for all customer email flows (register, password update, etc.).
+ * Creates a `CustomerMailPayload` object used for customer email flows that do not include an initial password.
  * @param {string} user - Username or email address of the customer.
- * @param {string} password - Customer's password (included in registration emails).
- * @param {string} product - Product name displayed in the email template.
  * @param {string} token - Verification or action token to embed in the email (e.g. for password reset links).
  * @param {string} reply_mail - Reply-to email address shown in the email.
- * @returns {import('./src/entities/CustomerMailerRequest')} A CustomerMailerRequest instance. Sign it before calling any `sendMail*` function.
+ * @param {object|null} [product] - Optional product payload used for branding.
+ * @returns {import('./src/entities/CustomerMailPayload')} A CustomerMailPayload instance. Sign it before calling any `sendMail*` function.
+ */
+function createCustomerMailPayload(user, token, reply_mail, product) {
+    return customerMailInstance.createCustomerMailPayload(user, token, reply_mail, product)
+}
+
+/**
+ * Creates a `CustomerMailOwnerPayload` object for the register-by-owner flow.
+ * @param {string|object} user - Customer user payload.
+ * @param {string} password - Initial password assigned by the owner.
+ * @param {string} token - Verification or action token to embed in the email.
+ * @param {string} reply_mail - Reply-to email address shown in the email.
+ * @param {object|null} [product] - Optional product payload used for branding.
+ * @returns {import('./src/entities/CustomerMailOwnerPayload')} A CustomerMailOwnerPayload instance. Sign it before calling `sendMailRegisterByOwner`.
+ */
+function createCustomerMailOwnerPayload(user, password, token, reply_mail, product) {
+    return customerMailInstance.createCustomerMailOwnerPayload(user, password, token, reply_mail, product)
+}
+
+/**
+ * Backwards-compatible alias for `createCustomerMailOwnerPayload`.
+ * @deprecated Use `createCustomerMailPayload` or `createCustomerMailOwnerPayload`.
  */
 function createCustomerMailerRequest(user, password, product, token, reply_mail) {
     return customerMailInstance.createCustomerMailerRequest(user, password, product, token, reply_mail)
@@ -79,7 +99,7 @@ function createCustomerMailerRequest(user, password, product, token, reply_mail)
  * The `tokenRQ` must be signed (have a `trx` field). Throws if not signed or if the API fails.
  * @param {string|null} basicAuth - Authorization header value (e.g. `'Basic dXNlcjpwYXNz'`). Pass `null` to send without auth.
  * @param {string} endpoint - Base URL of the SDX Mailer API (e.g. `'https://mailer.miapp.com'`).
- * @param {import('./src/entities/CustomerMailerRequest')} tokenRQ - Signed CustomerMailerRequest to send.
+ * @param {import('./src/entities/CustomerMailPayload')} tokenRQ - Signed CustomerMailPayload to send.
  * @returns {Promise<any>} Resolves with the API response data.
  */
 async function sendMailUpdatePassword(basicAuth, endpoint, tokenRQ) {
@@ -91,7 +111,7 @@ async function sendMailUpdatePassword(basicAuth, endpoint, tokenRQ) {
  * The `tokenRQ` must be signed (have a `trx` field). Throws if not signed or if the API fails.
  * @param {string|null} basicAuth - Authorization header value (e.g. `'Basic dXNlcjpwYXNz'`). Pass `null` to send without auth.
  * @param {string} endpoint - Base URL of the SDX Mailer API (e.g. `'https://mailer.miapp.com'`).
- * @param {import('./src/entities/CustomerMailerRequest')} tokenRQ - Signed CustomerMailerRequest to send.
+ * @param {import('./src/entities/CustomerMailPayload')} tokenRQ - Signed CustomerMailPayload to send.
  * @returns {Promise<any>} Resolves with the API response data.
  */
 async function sendMailSuccessUpdatedPassword(basicAuth, endpoint, tokenRQ) {
@@ -103,7 +123,7 @@ async function sendMailSuccessUpdatedPassword(basicAuth, endpoint, tokenRQ) {
  * The `tokenRQ` must be signed (have a `trx` field). Throws if not signed or if the API fails.
  * @param {string|null} basicAuth - Authorization header value (e.g. `'Basic dXNlcjpwYXNz'`). Pass `null` to send without auth.
  * @param {string} endpoint - Base URL of the SDX Mailer API (e.g. `'https://mailer.miapp.com'`).
- * @param {import('./src/entities/CustomerMailerRequest')} tokenRQ - Signed CustomerMailerRequest to send.
+ * @param {import('./src/entities/CustomerMailPayload')} tokenRQ - Signed CustomerMailPayload to send.
  * @returns {Promise<any>} Resolves with the API response data.
  */
 async function sendMailRegister(basicAuth, endpoint, tokenRQ) {
@@ -115,7 +135,7 @@ async function sendMailRegister(basicAuth, endpoint, tokenRQ) {
  * The `tokenRQ` must be signed (have a `trx` field). Throws if not signed or if the API fails.
  * @param {string|null} basicAuth - Authorization header value (e.g. `'Basic dXNlcjpwYXNz'`). Pass `null` to send without auth.
  * @param {string} endpoint - Base URL of the SDX Mailer API (e.g. `'https://mailer.miapp.com'`).
- * @param {import('./src/entities/CustomerMailerRequest')} tokenRQ - Signed CustomerMailerRequest to send.
+ * @param {import('./src/entities/CustomerMailOwnerPayload')} tokenRQ - Signed CustomerMailOwnerPayload to send.
  * @returns {Promise<any>} Resolves with the API response data.
  */
 async function sendMailRegisterByOwner(basicAuth, endpoint, tokenRQ) {
@@ -123,10 +143,18 @@ async function sendMailRegisterByOwner(basicAuth, endpoint, tokenRQ) {
 }
 
 /**
- * Creates a `PaymentsMailerRequest` object ready to be sent via `sendMailPayment`.
+ * Creates a `PaymentMailPayload` object ready to be sent via `sendMailPayment`.
  * @param {string} trxId - Transaction ID associated with the payment (e.g. order ID, payment reference).
- * @param {string} product - Product name or licence identifier related to the payment.
- * @returns {import('./src/entities/PaymentsMailerRequest')} A PaymentsMailerRequest instance. Sign it before calling `sendMailPayment`.
+ * @param {object|null} licence - Licence payload associated with the payment.
+ * @returns {import('./src/entities/PaymentMailPayload')} A PaymentMailPayload instance. Sign it before calling `sendMailPayment`.
+ */
+function createPaymentMailPayload(trxId, licence) {
+    return paymentsMailInstance.createPaymentMailPayload(trxId, licence)
+}
+
+/**
+ * Backwards-compatible alias for `createPaymentMailPayload`.
+ * @deprecated Use `createPaymentMailPayload`.
  */
 function createPaymentsMailerRequest(trxId, product) {
     return paymentsMailInstance.createPaymentsMailerRequest(trxId, product)
@@ -137,7 +165,7 @@ function createPaymentsMailerRequest(trxId, product) {
  * The `tokenRQ` must be signed (have a `trx` field). Throws if not signed or if the API fails.
  * @param {string|null} basicAuth - Authorization header value (e.g. `'Basic dXNlcjpwYXNz'`). Pass `null` to send without auth.
  * @param {string} endpoint - Base URL of the SDX Mailer API (e.g. `'https://mailer.miapp.com'`).
- * @param {import('./src/entities/PaymentsMailerRequest')} tokenRQ - Signed PaymentsMailerRequest to send.
+ * @param {import('./src/entities/PaymentMailPayload')} tokenRQ - Signed PaymentMailPayload to send.
  * @returns {Promise<any>} Resolves with the API response data.
  */
 async function sendMailPayment(basicAuth, endpoint, tokenRQ) {
@@ -178,9 +206,12 @@ module.exports = {
     sendMailSuccessUpdatedPassword,         // CUSTOMER
     sendMailRegister,                       // CUSTOMER
     sendMailRegisterByOwner,                // CUSTOMER
+    createCustomerMailPayload,              // CUSTOMER
+    createCustomerMailOwnerPayload,         // CUSTOMER
     createCustomerMailerRequest,            // CUSTOMER
     sendMailPayment,                        // PAYMENT
+    createPaymentMailPayload,               // PAYMENT
     createPaymentsMailerRequest,            // PAYMENT
     createCustomMailRequest,                // CUSTOM
     sendCustomMail                          // CUSTOM
-};
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sdx-mailer-sdk",
-  "version": "1.0.21",
+  "version": "1.0.22",
   "description": "A api rest sdx-mailer-sender sdk",
   "main": "index.js",
   "types": "index.d.ts",

package/src/CustomerMail.js

@@ -1,4 +1,5 @@
-const CustomerMailerRequest = require("./entities/CustomerMailerRequest");
+const CustomerMailPayload = require("./entities/CustomerMailPayload");
+const CustomerMailOwnerPayload = require("./entities/CustomerMailOwnerPayload");
 const WebServiceException = require("./entities/WebServiceException");
 const CourierService = require("./services/CourierService");
 const Commons = require("./utils/Commons");
@@ -11,16 +12,29 @@ class CustomerMail {
         this.service = new CourierService();
     }
 
-    createCustomerMailerRequest(user, password, product, token, reply_mail) {
-        let request = new CustomerMailerRequest();
+    createCustomerMailPayload(user, token, reply_mail, product) {
+        let request = new CustomerMailPayload();
+        request.user = user;
+        request.token = token;
+        request.reply_mail = reply_mail;
+        request.product = product ?? null;
+        return request;
+    }
+
+    createCustomerMailOwnerPayload(user, password, token, reply_mail, product) {
+        let request = new CustomerMailOwnerPayload();
         request.user = user;
         request.password = password;
-        request.product = product;
         request.token = token;
         request.reply_mail = reply_mail;
+        request.product = product ?? null;
         return request;
     }
 
+    createCustomerMailerRequest(user, password, product, token, reply_mail) {
+        return this.createCustomerMailOwnerPayload(user, password, token, reply_mail, product);
+    }
+
     /**
      * Send Customer update password Mail
      * @param {*} basicAuth 

package/src/PaymentsMail.js

@@ -1,3 +1,4 @@
+const PaymentMailPayload = require("./entities/PaymentMailPayload");
 const PaymentsMailerRequest = require("./entities/PaymentsMailerRequest");
 const WebServiceException = require("./entities/WebServiceException");
 const CourierService = require("./services/CourierService");
@@ -11,10 +12,17 @@ class PaymentsMail {
         this.service = new CourierService();
     }
 
+    createPaymentMailPayload(trxId, licence) {
+        let request = new PaymentMailPayload();
+        request.trxId = trxId;
+        request.licence = licence ?? null;
+        return request;
+    }
+
     createPaymentsMailerRequest(trxId, licence) {
         let request = new PaymentsMailerRequest();
         request.trxId = trxId;
-        request.licence = licence;
+        request.licence = licence ?? null;
         return request;
     }
 

package/src/entities/CustomerMailOwnerPayload.js

@@ -0,0 +1,10 @@
+const CustomerMailPayload = require('./CustomerMailPayload');
+
+class CustomerMailOwnerPayload extends CustomerMailPayload {
+    constructor() {
+        super();
+        this.password = '';
+    }
+}
+
+module.exports = CustomerMailOwnerPayload;

package/src/entities/CustomerMailPayload.js

@@ -0,0 +1,10 @@
+class CustomerMailPayload {
+    constructor() {
+        this.user = null;
+        this.product = null;
+        this.token = '';
+        this.reply_mail = '';
+    }
+}
+
+module.exports = CustomerMailPayload;

package/src/entities/CustomerMailerRequest.js

@@ -1,11 +1 @@
-
-class CustomerMailerRequest {
-    constructor() {
-        this.user = '';
-        this.product = '';
-        this.token = '';
-        this.reply_mail = '';
-    }
-}
-
-module.exports = CustomerMailerRequest;
+module.exports = require('./CustomerMailOwnerPayload');

package/src/entities/PaymentMailPayload.js

@@ -0,0 +1,8 @@
+class PaymentMailPayload {
+    constructor() {
+        this.trxId = '';
+        this.licence = null;
+    }
+}
+
+module.exports = PaymentMailPayload;

package/src/entities/PaymentsMailerRequest.js

@@ -1,9 +1,2 @@
 
-class PaymentsMailerRequest {
-    constructor() {
-        this.trxId = '';
-        this.licence = '';
-    }
-}
-
-module.exports = PaymentsMailerRequest;
+module.exports = require('./PaymentMailPayload');