@signalhousellc/sdk 1.0.31 → 1.0.33

package/src/domains/Messages.js

@@ -1,257 +1,280 @@
-export class Messages {
-	constructor(client, multipartClient, enableAdmin) {
-		this.client = client;
-		this.multipartClient = multipartClient;
-		this.enableAdmin = enableAdmin;
-	}
-
-	/**
-	 * Get a list of messages with optional filters and pagination parameters
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for getting messages
-	 * @param {string} [params.id] - Filter messages by their unique ID
-	 * @param {string} [params.campaignId] - Filter messages by the ID of the associated campaign
-	 * @param {string} [params.brandId] - Filter messages by the ID of the associated brand
-	 * @param {string} [params.subgroupId] - Filter messages by the ID of the associated subgroup
-	 * @param {string} [params.groupId] - Filter messages by the ID of the associated group
-	 * @param {string} [params.status] - Filter messages by their status (ENQUEUED, DEQUEUED, SENT, FAILED, DELIVERED)
-	 * @param {string} [params.direction] - Filter messages by their direction (INBOUND, OUTBOUND)
-	 * @param {string} [params.messageType] - Filter messages by their type (SMS, MMS)
-	 * @param {string} [params.carrier] - Filter messages by the carrier used for sending
-	 * @param {string} [params.startDate] - Filter messages by their start date
-	 * @param {string} [params.endDate] - Filter messages by their end date
-	 * @param {string} [params.sortField] - The field to sort the messages by
-	 * @param {string} [params.sortOrder] - The order to sort the messages (asc, desc)
-	 * @param {number} [params.page] - The page number for pagination
-	 * @param {number} [params.limit] - The number of messages per page
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} - A promise that resolves to the list of messages
-	 */
-	async getMessages({
-		id,
-		campaignId,
-		brandId,
-		subgroupId,
-		groupId,
-		status,
-		direction,
-		messageType,
-		carrier,
-		startDate,
-		endDate,
-		sortField,
-		sortOrder,
-		page,
-		limit,
-		options = {},
-	}) {
-		const filters = { id, campaignId, brandId, subgroupId, groupId, status, direction, messageType, carrier, startDate, endDate, sortField, sortOrder, page, limit };
-		const queryString = this.client._getQueryString(filters);
-		return this.client(`/message${queryString}`, { method: "GET", ...options });
-	}
-
-	/**
-	 * Get aggregated analytics for messages with optional filters
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for getting analytics
-	 * @param {string} [params.groupId] - Filter analytics by the ID of the associated group
-	 * @param {string} [params.subgroupId] - Filter analytics by the ID of the associated subgroup
-	 * @param {string} [params.brandId] - Filter analytics by the ID of the associated brand
-	 * @param {string} [params.campaignId] - Filter analytics by the ID of the associated campaign
-	 * @param {string} [params.phoneNumber] - Filter analytics by the phone number involved in the messages
-	 * @param {string} [params.carrier] - Filter analytics by the carrier used for sending
-	 * @param {string} [params.startDate] - Filter analytics by the start date of the messages
-	 * @param {string} [params.endDate] - Filter analytics by the end date of the messages
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} - A promise that resolves to the analytics data
-	 */
-	async getAnalytics({ groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate, options = {} }) {
-		const filters = { groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate };
-		const queryString = this.client._getQueryString(filters);
-		return this.client(`/message/analytics${queryString}`, { method: "GET", ...options });
-	}
-
-	/**
-	 * Get aggregated DNC (Do Not Contact) opt-out analytics with optional filters
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for getting DNC analytics
-	 * @param {string} [params.groupId] - Filter by the ID of the associated group
-	 * @param {string} [params.subgroupId] - Filter by the ID of the associated subgroup
-	 * @param {string} [params.brandId] - Filter by the ID of the associated brand
-	 * @param {string} [params.campaignId] - Filter by the ID of the associated campaign
-	 * @param {string} [params.phoneNumber] - Filter by the phone number
-	 * @param {string} [params.carrier] - Filter by the carrier
-	 * @param {string} [params.startDate] - Filter by start date
-	 * @param {string} [params.endDate] - Filter by end date
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} - A promise that resolves to the DNC analytics data (totals, byDate, byPhoneNumber, byCarrier)
-	 */
-	async getDncAnalytics({ groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate, options = {} }) {
-		const filters = { groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate };
-		const queryString = this.client._getQueryString(filters);
-		return this.client(`/message/dnc/analytics${queryString}`, { method: "GET", ...options });
-	}
-
-	/**
-	 * Get paginated Do Not Call records with optional filters
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for getting DNC records
-	 * @param {string} [params.groupId] - Filter by the ID of the associated group
-	 * @param {string} [params.subgroupId] - Filter by the ID of the associated subgroup
-	 * @param {string} [params.brandId] - Filter by the ID of the associated brand
-	 * @param {string} [params.campaignId] - Filter by the ID of the associated campaign
-	 * @param {string} [params.phoneNumber] - Filter by the phone number
-	 * @param {string} [params.carrier] - Filter by the carrier
-	 * @param {string} [params.startDate] - Filter by start date
-	 * @param {string} [params.endDate] - Filter by end date
-	 * @param {number} [params.page] - Page number for pagination
-	 * @param {number} [params.limit] - Number of records per page
-	 * @param {string} [params.sortField] - Field to sort by
-	 * @param {string} [params.sortOrder] - Sort direction (asc, desc)
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} - A promise that resolves to the paginated DNC records
-	 */
-	async getDncRecords({ groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate, page, limit, sortField, sortOrder, options = {} }) {
-		const filters = { groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate, page, limit, sortField, sortOrder };
-		const queryString = this.client._getQueryString(filters);
-		return this.client(`/message/dnc${queryString}`, { method: "GET", ...options });
-	}
-
-	/**
-	 * Send an SMS message to one or more recipient phone numbers
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for sending an SMS message
-	 * @param {string} params.senderPhoneNumber - The phone number to send the message from
-	 * @param {string|string[]} params.recipientPhoneNumbers - The phone number(s) to send the message to
-	 * @param {string} params.messageBody - The body of the SMS message
-	 * @param {string} [params.statusCallbackUrl] - The URL to receive status callbacks
-	 * @param {boolean} [params.enableShortlink=false] - Whether to enable shortlink in the message
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} - A promise that resolves to the response data from the server
-	 */
-	async sendSMS({ senderPhoneNumber, recipientPhoneNumbers, messageBody, statusCallbackUrl, enableShortlink = false, options = {} }) {
-		this.client._require({ senderPhoneNumber, recipientPhoneNumbers, messageBody });
-		return this.client(`/message/sms`, {
-			method: "POST",
-			body: { senderPhoneNumber, recipientPhoneNumber: recipientPhoneNumbers, messageBody, statusCallbackUrl, enableShortlink },
-			...options,
-		});
-	}
-
-	/**
-	 * Send an MMS message to one or more recipient phone numbers, with optional media attachments and status callback
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for sending an MMS message
-	 * @param {string} params.senderPhoneNumber - The phone number to send the message from
-	 * @param {string[]} params.recipientPhoneNumbers - The phone number(s) to send the message to
-	 * @param {string} params.messageBody - The body of the MMS message
-	 * @param {string[]} [params.mediaUrls] - The URLs of the media attachments
-	 * @param {string} [params.statusCallbackUrl] - The URL to receive status callbacks
-	 * @param {boolean} [params.enableShortlink=false] - Whether to enable shortlink in the message
-	 * @param {boolean} [params.enableCompression=true] - Whether to enable image compression for the image attachments
-	 * @param {File[]} [params.images] - The images to attach to the MMS message
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} - A promise that resolves to the response data from the server
-	 */
-	async sendMMS({
-		senderPhoneNumber,
-		recipientPhoneNumbers,
-		messageBody,
-		mediaUrls,
-		statusCallbackUrl,
-		enableShortlink = false,
-		enableCompression = true,
-		images,
-		options = {},
-	}) {
-		this.client._require({ senderPhoneNumber, recipientPhoneNumbers, messageBody });
-
-		const formData = new FormData();
-
-		if (images && images.length > 0) {
-			images.forEach((image, index) => {
-				formData.append("images", image);
-			});
-		}
-
-		formData.append("senderPhoneNumber", senderPhoneNumber);
-
-		formData.append("recipientPhoneNumber", Array.isArray(recipientPhoneNumbers) ? JSON.stringify(recipientPhoneNumbers) : recipientPhoneNumbers);
-		formData.append("messageBody", messageBody);
-
-		if (mediaUrls && mediaUrls.length > 0) {
-			formData.append("mediaUrls", JSON.stringify(mediaUrls));
-		}
-
-		if (statusCallbackUrl) {
-			formData.append("statusCallbackUrl", statusCallbackUrl);
-		}
-
-		formData.append("enableShortlink", enableShortlink);
-		formData.append("enableCompression", enableCompression);
-
-		return this.multipartClient(`/message/mms`, { method: "POST", body: formData, ...options });
-	}
-
-	/**
-	 * Send a group MMS message to one or more recipient phone numbers, with optional media attachments and status callback
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for sending an MMS message
-	 * @param {string} params.senderPhoneNumber - The phone number to send the message from
-	 * @param {string[]} params.recipientPhoneNumbers - The phone number(s) to send the message to
-	 * @param {string} params.messageBody - The body of the MMS message
-	 * @param {string[]} [params.mediaUrls] - The URLs of the media attachments
-	 * @param {string} [params.statusCallbackUrl] - The URL to receive status callbacks
-	 * @param {boolean} [params.enableShortlink=false] - Whether to enable shortlink in the message
-	 * @param {boolean} [params.enableCompression=true] - Whether to enable image compression for the image attachments
-	 * @param {File[]} [params.images] - The images to attach to the MMS message
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Object>} - A promise that resolves to the response data from the server
-	 */
-	async sendGroupMessage({
-		senderPhoneNumber,
-		recipientPhoneNumbers,
-		messageBody,
-		mediaUrls,
-		statusCallbackUrl,
-		enableShortlink = false,
-		enableCompression = true,
-		images,
-		options = {},
-	}) {
-		this.client._require({ senderPhoneNumber, recipientPhoneNumbers, messageBody });
-
-		const formData = new FormData();
-
-		if (images && images.length > 0) {
-			images.forEach((image, index) => {
-				formData.append("images", image);
-			});
-		}
-
-		formData.append("senderPhoneNumber", senderPhoneNumber);
-
-		formData.append("recipientPhoneNumber", Array.isArray(recipientPhoneNumbers) ? JSON.stringify(recipientPhoneNumbers) : recipientPhoneNumbers);
-		formData.append("messageBody", messageBody);
-
-		if (mediaUrls && mediaUrls.length > 0) {
-			formData.append("mediaUrls", JSON.stringify(mediaUrls));
-		}
-
-		if (statusCallbackUrl) {
-			formData.append("statusCallbackUrl", statusCallbackUrl);
-		}
-
-		formData.append("enableShortlink", enableShortlink);
-		formData.append("enableCompression", enableCompression);
-
-		return this.multipartClient(`/message/groupMessage`, { method: "POST", body: formData, ...options });
-	}
-}
+export class Messages {
+	constructor(client, multipartClient, enableAdmin) {
+		this.client = client;
+		this.multipartClient = multipartClient;
+		this.enableAdmin = enableAdmin;
+	}
+
+	/**
+	 * Get a list of messages with optional filters and pagination parameters
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for getting messages
+	 * @param {string} [params.id] - Filter messages by their unique ID
+	 * @param {string} [params.campaignId] - Filter messages by the ID of the associated campaign
+	 * @param {string} [params.brandId] - Filter messages by the ID of the associated brand
+	 * @param {string} [params.subgroupId] - Filter messages by the ID of the associated subgroup
+	 * @param {string} [params.groupId] - Filter messages by the ID of the associated group
+	 * @param {string} [params.status] - Filter messages by their status (ENQUEUED, DEQUEUED, SENT, FAILED, DELIVERED)
+	 * @param {string} [params.direction] - Filter messages by their direction (INBOUND, OUTBOUND)
+	 * @param {string} [params.messageType] - Filter messages by their type (SMS, MMS)
+	 * @param {string} [params.carrier] - Filter messages by the carrier used for sending
+	 * @param {string} [params.startDate] - Filter messages by their start date
+	 * @param {string} [params.endDate] - Filter messages by their end date
+	 * @param {string} [params.sortField] - The field to sort the messages by
+	 * @param {string} [params.sortOrder] - The order to sort the messages (asc, desc)
+	 * @param {number} [params.page] - The page number for pagination
+	 * @param {number} [params.limit] - The number of messages per page
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} - A promise that resolves to the list of messages
+	 */
+	async getMessages({
+		id,
+		campaignId,
+		brandId,
+		subgroupId,
+		groupId,
+		phoneNumber,
+		status,
+		direction,
+		messageType,
+		carrier,
+		startDate,
+		endDate,
+		sortField,
+		sortOrder,
+		page,
+		limit,
+		options = {},
+	}) {
+		const filters = { id, campaignId, brandId, subgroupId, groupId, phoneNumber, status, direction, messageType, carrier, startDate, endDate, sortField, sortOrder, page, limit };
+		const queryString = this.client._getQueryString(filters);
+		return this.client(`/message${queryString}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Get aggregated analytics for messages with optional filters
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for getting analytics
+	 * @param {string} [params.groupId] - Filter analytics by the ID of the associated group
+	 * @param {string} [params.subgroupId] - Filter analytics by the ID of the associated subgroup
+	 * @param {string} [params.brandId] - Filter analytics by the ID of the associated brand
+	 * @param {string} [params.campaignId] - Filter analytics by the ID of the associated campaign
+	 * @param {string} [params.phoneNumber] - Filter analytics by the phone number involved in the messages
+	 * @param {string} [params.carrier] - Filter analytics by the carrier used for sending
+	 * @param {string} [params.startDate] - Filter analytics by the start date of the messages
+	 * @param {string} [params.endDate] - Filter analytics by the end date of the messages
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} - A promise that resolves to the analytics data
+	 */
+	async getAnalytics({ groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate, options = {} }) {
+		const filters = { groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate };
+		const queryString = this.client._getQueryString(filters);
+		return this.client(`/message/analytics${queryString}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Get detailed analytics snapshot records for charting and aggregation
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for getting detailed analytics
+	 * @param {string} [params.groupId] - Filter analytics by the ID of the associated group
+	 * @param {string} [params.subgroupId] - Filter analytics by the ID of the associated subgroup
+	 * @param {string} [params.brandId] - Filter analytics by the ID of the associated brand
+	 * @param {string} [params.campaignId] - Filter analytics by the ID of the associated campaign
+	 * @param {string} [params.phoneNumber] - Filter analytics by the phone number involved in the messages
+	 * @param {string} [params.carrier] - Filter analytics by the carrier used for sending
+	 * @param {string} [params.startDate] - Filter analytics by the start date of the messages
+	 * @param {string} [params.endDate] - Filter analytics by the end date of the messages
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Array>} - A promise that resolves to an array of analytics snapshot records
+	 */
+	async getAnalyticsDetail({ groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate, options = {} }) {
+		const filters = { groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate };
+		const queryString = this.client._getQueryString(filters);
+		return this.client(`/message/analytics/detail${queryString}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Get aggregated DNC (Do Not Contact) opt-out analytics with optional filters
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for getting DNC analytics
+	 * @param {string} [params.groupId] - Filter by the ID of the associated group
+	 * @param {string} [params.subgroupId] - Filter by the ID of the associated subgroup
+	 * @param {string} [params.brandId] - Filter by the ID of the associated brand
+	 * @param {string} [params.campaignId] - Filter by the ID of the associated campaign
+	 * @param {string} [params.phoneNumber] - Filter by the phone number
+	 * @param {string} [params.carrier] - Filter by the carrier
+	 * @param {string} [params.startDate] - Filter by start date
+	 * @param {string} [params.endDate] - Filter by end date
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} - A promise that resolves to the DNC analytics data (totals, byDate, byPhoneNumber, byCarrier)
+	 */
+	async getDncAnalytics({ groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate, options = {} }) {
+		const filters = { groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate };
+		const queryString = this.client._getQueryString(filters);
+		return this.client(`/message/dnc/analytics${queryString}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Get paginated Do Not Call records with optional filters
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for getting DNC records
+	 * @param {string} [params.groupId] - Filter by the ID of the associated group
+	 * @param {string} [params.subgroupId] - Filter by the ID of the associated subgroup
+	 * @param {string} [params.brandId] - Filter by the ID of the associated brand
+	 * @param {string} [params.campaignId] - Filter by the ID of the associated campaign
+	 * @param {string} [params.phoneNumber] - Filter by the phone number
+	 * @param {string} [params.carrier] - Filter by the carrier
+	 * @param {string} [params.startDate] - Filter by start date
+	 * @param {string} [params.endDate] - Filter by end date
+	 * @param {number} [params.page] - Page number for pagination
+	 * @param {number} [params.limit] - Number of records per page
+	 * @param {string} [params.sortField] - Field to sort by
+	 * @param {string} [params.sortOrder] - Sort direction (asc, desc)
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} - A promise that resolves to the paginated DNC records
+	 */
+	async getDncRecords({ groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate, page, limit, sortField, sortOrder, options = {} }) {
+		const filters = { groupId, subgroupId, brandId, campaignId, phoneNumber, carrier, startDate, endDate, page, limit, sortField, sortOrder };
+		const queryString = this.client._getQueryString(filters);
+		return this.client(`/message/dnc${queryString}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Send an SMS message to one or more recipient phone numbers
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for sending an SMS message
+	 * @param {string} params.senderPhoneNumber - The phone number to send the message from
+	 * @param {string|string[]} params.recipientPhoneNumbers - The phone number(s) to send the message to
+	 * @param {string} params.messageBody - The body of the SMS message
+	 * @param {string} [params.statusCallbackUrl] - The URL to receive status callbacks
+	 * @param {boolean} [params.enableShortlink=false] - Whether to enable shortlink in the message
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} - A promise that resolves to the response data from the server
+	 */
+	async sendSMS({ senderPhoneNumber, recipientPhoneNumbers, messageBody, statusCallbackUrl, enableShortlink = false, options = {} }) {
+		this.client._require({ senderPhoneNumber, recipientPhoneNumbers, messageBody });
+		return this.client(`/message/sms`, {
+			method: "POST",
+			body: { senderPhoneNumber, recipientPhoneNumber: recipientPhoneNumbers, messageBody, statusCallbackUrl, enableShortlink },
+			...options,
+		});
+	}
+
+	/**
+	 * Send an MMS message to one or more recipient phone numbers, with optional media attachments and status callback
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for sending an MMS message
+	 * @param {string} params.senderPhoneNumber - The phone number to send the message from
+	 * @param {string[]} params.recipientPhoneNumbers - The phone number(s) to send the message to
+	 * @param {string} params.messageBody - The body of the MMS message
+	 * @param {string[]} [params.mediaUrls] - The URLs of the media attachments
+	 * @param {string} [params.statusCallbackUrl] - The URL to receive status callbacks
+	 * @param {boolean} [params.enableShortlink=false] - Whether to enable shortlink in the message
+	 * @param {boolean} [params.enableCompression=true] - Whether to enable image compression for the image attachments
+	 * @param {File[]} [params.images] - The images to attach to the MMS message
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} - A promise that resolves to the response data from the server
+	 */
+	async sendMMS({
+		senderPhoneNumber,
+		recipientPhoneNumbers,
+		messageBody,
+		mediaUrls,
+		statusCallbackUrl,
+		enableShortlink = false,
+		enableCompression = true,
+		images,
+		options = {},
+	}) {
+		this.client._require({ senderPhoneNumber, recipientPhoneNumbers, messageBody });
+
+		const formData = new FormData();
+
+		if (images && images.length > 0) {
+			images.forEach((image, index) => {
+				formData.append("images", image);
+			});
+		}
+
+		formData.append("senderPhoneNumber", senderPhoneNumber);
+
+		formData.append("recipientPhoneNumber", Array.isArray(recipientPhoneNumbers) ? JSON.stringify(recipientPhoneNumbers) : recipientPhoneNumbers);
+		formData.append("messageBody", messageBody);
+
+		if (mediaUrls && mediaUrls.length > 0) {
+			formData.append("mediaUrls", JSON.stringify(mediaUrls));
+		}
+
+		if (statusCallbackUrl) {
+			formData.append("statusCallbackUrl", statusCallbackUrl);
+		}
+
+		formData.append("enableShortlink", enableShortlink);
+		formData.append("enableCompression", enableCompression);
+
+		return this.multipartClient(`/message/mms`, { method: "POST", body: formData, ...options });
+	}
+
+	/**
+	 * Send a group MMS message to one or more recipient phone numbers, with optional media attachments and status callback
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for sending an MMS message
+	 * @param {string} params.senderPhoneNumber - The phone number to send the message from
+	 * @param {string[]} params.recipientPhoneNumbers - The phone number(s) to send the message to
+	 * @param {string} params.messageBody - The body of the MMS message
+	 * @param {string[]} [params.mediaUrls] - The URLs of the media attachments
+	 * @param {string} [params.statusCallbackUrl] - The URL to receive status callbacks
+	 * @param {boolean} [params.enableShortlink=false] - Whether to enable shortlink in the message
+	 * @param {boolean} [params.enableCompression=true] - Whether to enable image compression for the image attachments
+	 * @param {File[]} [params.images] - The images to attach to the MMS message
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} - A promise that resolves to the response data from the server
+	 */
+	async sendGroupMessage({
+		senderPhoneNumber,
+		recipientPhoneNumbers,
+		messageBody,
+		mediaUrls,
+		statusCallbackUrl,
+		enableShortlink = false,
+		enableCompression = true,
+		images,
+		options = {},
+	}) {
+		this.client._require({ senderPhoneNumber, recipientPhoneNumbers, messageBody });
+
+		const formData = new FormData();
+
+		if (images && images.length > 0) {
+			images.forEach((image, index) => {
+				formData.append("images", image);
+			});
+		}
+
+		formData.append("senderPhoneNumber", senderPhoneNumber);
+
+		formData.append("recipientPhoneNumber", Array.isArray(recipientPhoneNumbers) ? JSON.stringify(recipientPhoneNumbers) : recipientPhoneNumbers);
+		formData.append("messageBody", messageBody);
+
+		if (mediaUrls && mediaUrls.length > 0) {
+			formData.append("mediaUrls", JSON.stringify(mediaUrls));
+		}
+
+		if (statusCallbackUrl) {
+			formData.append("statusCallbackUrl", statusCallbackUrl);
+		}
+
+		formData.append("enableShortlink", enableShortlink);
+		formData.append("enableCompression", enableCompression);
+
+		return this.multipartClient(`/message/groupMessage`, { method: "POST", body: formData, ...options });
+	}
+}

package/src/domains/Numbers.js

@@ -323,4 +323,19 @@ export class Numbers {
 	async lookupLocations({ entries, options = {} }) {
 		return this.client("/number/lookup/location", { method: "POST", body: { entries }, ...options });
 	}
+
+	/**
+	 * Migrate a phone number (or all numbers in a campaign/group) from v1 to v2
+	 * @async
+	 * @roles api, admin, developer, billing, user, signalhouse_api, signalhouse_admin, signalhouse_user
+	 * @param {Object} params - The parameters for migration
+	 * @param {string} [params.phoneNumber] - The phone number to migrate
+	 * @param {string} [params.campaignId] - Campaign ID to migrate all numbers for
+	 * @param {string} [params.groupId] - Group ID to migrate all numbers for
+	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Object>} A promise that resolves to a confirmation with count of queued numbers
+	 */
+	async migratePhoneNumberToV2({ phoneNumber, campaignId, groupId, options = {} }) {
+		return this.client(`/number/migrate`, { method: "POST", body: { phoneNumber, campaignId, groupId }, ...options });
+	}
 }