@signalhousellc/sdk 1.0.61 → 1.0.62

package/src/domains/Campaigns.js

@@ -101,243 +101,434 @@
  * @property {Array<string>} phoneNumbers - The Toll-Free numbers to assign to the campaign (required, at least 1 and at most 5, each at least 10 digits and digits only). Numbers are locked to the campaign once assigned and cannot be moved or added afterward.
  */
 
+/**
+ * @typedef {Object} ShortCodeDetails
+ * @property {Array<string>} useCases - Selected use cases (required, at least 1; ALERTS, CHAT, DONATION, FRAUD_ALERTS, PROMOTIONAL_MARKETING, PUBLIC_SERVICE_ANNOUNCEMENT, SWEEPSTAKES_CONTEST, TWO_FACTOR_AUTHENTICATION, VOTING_POLLING, POLITICAL, EMERGENCY_NOTIFICATIONS, DELIVERY_NOTIFICATIONS, SECURITY_ALERTS)
+ * @property {Array<string>} optInMethods - Selected opt-in methods (required, at least 1; IVR_POS, WEB, TV, PRINT, KEYWORD, VERBAL, RADIO)
+ * @property {Object<string, string>} optInMethodDescriptions - Generated-but-editable description per selected opt-in method, keyed by the method value (each 20-2048 characters, required for every selected method)
+ * @property {string} messageFrequency - "RECURRING" or "SINGLE" (required)
+ * @property {string} pricingTier - "STANDARD" or "FTEU" (required)
+ * @property {boolean} [adultContent=false] - Whether the campaign contains adult (SHAFT) content
+ * @property {string} [doubleOptInMessage] - Required when adultContent is true (20-1024 characters)
+ * @property {string} programSummary - Generated-but-editable campaign/program summary (required, 40-2048 characters)
+ * @property {string} optInConfirmationMessage - The opt-in confirmation message (required, 20-1024 characters)
+ * @property {string} [optInUrl] - Public HTTPS URL for the live opt-in experience. When omitted, Signal House uses the brand's optInLink before capturing its screenshot asynchronously, retrying up to three times.
+ */
+
+/**
+ * @typedef {Object} CreateShortCodeCampaignData
+ * @property {string} brandId - The ID of the approved (VERIFIED) Short Code brand (required, at least 7 characters)
+ * @property {string} privacyPolicyLink - A URL linking to the privacy policy (required, at most 2048 characters)
+ * @property {string} termsAndConditionsLink - A URL linking to the terms and conditions (required, at most 2048 characters)
+ * @property {string} optinMessage - Opt-in response message (required, 20-1024 characters)
+ * @property {string} optoutMessage - Opt-out response message (required, 20-1024 characters)
+ * @property {string} helpMessage - HELP response message (required, 20-1024 characters)
+ * @property {string} sample1 - Sample message 1 (required, 20-1024 characters)
+ * @property {string} sample2 - Sample message 2 (required, 20-1024 characters)
+ * @property {string} sample3 - Sample message 3 (required, 20-1024 characters)
+ * @property {boolean} [autoRenewal=true] - Whether the campaign should auto-renew (optional, defaults to true)
+ * @property {string} [tag] - A tag for the campaign (optional, at most 255 characters)
+ * @property {ShortCodeDetails} shortCode - The Short Code campaign details (required)
+ */
+
 export class Campaigns {
-	constructor(client, multipartClient, enableAdmin) {
-		this.client = client;
-		this.multipartClient = multipartClient;
-		this.enableAdmin = enableAdmin;
+  constructor(client, multipartClient, enableAdmin) {
+    this.client = client;
+    this.multipartClient = multipartClient;
+    this.enableAdmin = enableAdmin;
+
+    if (enableAdmin) {
+      this.admin = {
+        /**
+         * Approve a campaign that is pending approval
+         * @async
+         * @roles signalhouse
+         * @param {Object} params - The parameters for approving the campaign
+         * @param {string} params.campaignId - The ID of the campaign to approve
+         * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+         * @throws {Error} Throws an error if the campaignId parameter is missing
+         * @returns {Promise<Object>} The response from the server
+         */
+        approveCampaign: async ({ campaignId, options = {} }) => {
+          this.client._require({ campaignId });
+          const safeCampaignId = encodeURIComponent(campaignId);
+          return this.client(`/campaign/approve/${safeCampaignId}`, { method: 'POST', ...options });
+        },
+        /**
+         * Reject a campaign that is pending approval
+         * @async
+         * @roles signalhouse
+         * @param {Object} params - The parameters for rejecting the campaign
+         * @param {string} params.campaignId - The ID of the campaign to reject
+         * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request (body should include { rejectionReason })
+         * @throws {Error} Throws an error if the campaignId parameter is missing
+         * @returns {Promise<Object>} The response from the server
+         */
+        rejectCampaign: async ({ campaignId, options = {} }) => {
+          this.client._require({ campaignId });
+          const safeCampaignId = encodeURIComponent(campaignId);
+          return this.client(`/campaign/reject/${safeCampaignId}`, { method: 'POST', ...options });
+        },
+        /**
+         * Get CNP campaigns shared with Signal House
+         * @async
+         * @roles signalhouse
+         * @param {Object} params - The parameters for retrieving CNP campaigns
+         * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+         * @returns {Promise<Array>} The response from the server
+         */
+        getCNPCampaigns: async ({ options = {} } = {}) => {
+          return this.client(`/campaign/cnp`, { method: 'GET', ...options });
+        },
+        /**
+         * Transition a Short Code campaign's review status (SHGHL-2225). A customer-visible reason is
+         * required for both rejection states ("REJECTED" = Signal House Rejected, "DCA_REJECTED" =
+         * Rejected). Fulfillment and carrier submission are separate staff operations.
+         * @async
+         * @roles signalhouse
+         * @param {Object} params - The parameters for the status transition
+         * @param {string} params.campaignId - The ID of the campaign to transition
+         * @param {string} params.status - The target status: "PENDING_REVIEW", "REJECTED", "PENDING_CREATION", "DCA_REJECTED", or "ACTIVE". Use submitShortCodeCampaignToCarrier for "PENDING_DCA_APPROVAL".
+         * @param {string} [params.rejectionReason] - Required for "REJECTED"/"DCA_REJECTED" (10-1024 characters)
+         * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+         * @throws {Error} Throws an error if the campaignId or status parameter is missing
+         * @returns {Promise<Object>} The updated campaign
+         */
+        updateShortCodeCampaignStatus: async ({ campaignId, status, rejectionReason, options = {} }) => {
+          this.client._require({ campaignId, status });
+          const safeCampaignId = encodeURIComponent(campaignId);
+          return this.client(`/campaign/short-code/${safeCampaignId}/status`, {
+            method: 'PUT',
+            body: { status, rejectionReason },
+            ...options,
+          });
+        },
+        /**
+         * Fulfill a campaign-bound Signal House Short Code request.
+         * @async
+         * @roles signalhouse
+         * @param {Object} params - Fulfillment parameters.
+         * @param {string} params.campaignId - Campaign identifier.
+         * @param {string} params.actualCode - Issued five- or six-digit Short Code.
+         * @param {string} [params.internalNotes] - Staff-only fulfillment notes.
+         * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options.
+         * @returns {Promise<Object>} The updated campaign.
+         */
+        fulfillShortCodeCampaign: async ({ campaignId, actualCode, internalNotes, options = {} }) => {
+          this.client._require({ campaignId, actualCode });
+          const safeCampaignId = encodeURIComponent(campaignId);
+          return this.client(`/campaign/short-code/${safeCampaignId}/fulfill`, {
+            method: 'POST',
+            body: { actualCode, internalNotes },
+            ...options,
+          });
+        },
+        /**
+         * Submit an internally approved Short Code campaign to carrier review.
+         * @async
+         * @roles signalhouse
+         * @param {Object} params - Submission parameters.
+         * @param {string} params.campaignId - Campaign identifier.
+         * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options.
+         * @returns {Promise<Object>} The updated campaign.
+         */
+        submitShortCodeCampaignToCarrier: async ({ campaignId, options = {} }) => {
+          this.client._require({ campaignId });
+          const safeCampaignId = encodeURIComponent(campaignId);
+          return this.client(`/campaign/short-code/${safeCampaignId}/submit-to-carrier`, {
+            method: 'POST',
+            ...options,
+          });
+        },
+      };
+    }
+  }
+
+  /**
+   * Get a list of campaigns with optional filters
+   * @async
+   * @roles api, admin, developer, billing, user
+   * @param {Object} params - The parameters for filtering the campaigns
+   * @param {string} [params.id] - The ID of the campaign to filter by
+   * @param {string} [params.brandId] - The ID of the brand to filter by
+   * @param {string} [params.subgroupId] - The ID of the subgroup to filter by
+   * @param {string} [params.groupId] - The ID of the group to filter by
+   * @param {number} [params.page] - The page number for pagination
+   * @param {number} [params.limit] - The number of items per page
+   * @param {string} [params.status] - The status of the campaign to filter by
+   * @param {string} [params.search] - Search term to filter campaigns by campaignId or brandId
+   * @param {string} [params.sortBy] - Field to sort by (e.g. "createdAt", "campaignId", "brandId", "groupId", "subgroupId", "usecase", "status")
+   * @param {string} [params.sortOrder] - Sort direction ("asc" or "desc")
+   * @param {string} [params.registrationType] - Filter by registration type ("TEN_DLC", "TOLL_FREE", or "SHORT_CODE")
+   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+   * @returns {Promise<Array|Object>} The response from the server - array when unpaginated, or { data, total, page, limit, totalPages } when paginated
+   */
+  async getCampaigns({
+    id,
+    brandId,
+    subgroupId,
+    groupId,
+    page,
+    limit,
+    status,
+    search,
+    sortBy,
+    sortOrder,
+    registrationType,
+    options = {},
+  }) {
+    const filters = {
+      id,
+      brandId,
+      subgroupId,
+      groupId,
+      page,
+      limit,
+      status,
+      search,
+      sortBy,
+      sortOrder,
+      registrationType,
+    };
+    const queryString = this.client._getQueryString(filters);
+    return this.client(`/campaign${queryString}`, { method: 'GET', ...options });
+  }
+
+  /**
+   * Get aggregated campaign health (7-day and 30-day windows) for a campaign.
+   * @async
+   * @roles api, admin, developer, billing, user
+   * @param {Object} params - Parameters for reading campaign health
+   * @param {string} params.campaignId - Campaign identifier
+   * @param {boolean} [params.includeNumbers=false] - When true, include per-number health entries
+   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional request options
+   * @returns {Promise<Object>} A promise that resolves to `{ campaignId, sevenDay, thirtyDay, numbers? }`
+   */
+  async getCampaignHealth({ campaignId, includeNumbers = false, options = {} }) {
+    this.client._require({ campaignId });
+    const queryString = this.client._getQueryString({ campaignId, includeNumbers });
+    return this.client(`/campaign/health${queryString}`, { method: 'GET', ...options });
+  }
+
+  /**
+   * Create a new campaign
+   * @async
+   * @roles api, admin, developer, billing, user
+   * @param {Object} params - The parameters for creating the campaign (see CreateCampaignData typedef for details)
+   * @param {CreateCampaignData} params.campaignData - The data for the campaign to be created (see CreateCampaignData typedef for details)
+   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+   * @throws {Error} Throws an error if the campaignData parameter is missing or if required fields in campaignData are missing
+   * @returns {Promise<Object>} The response from the server
+   */
+  async createCampaign({ campaignData, options = {} }) {
+    this.client._require({ campaignData: campaignData });
+    return this.client(`/campaign`, { method: 'POST', body: campaignData, ...options });
+  }
 
-		if (enableAdmin) {
-			this.admin = {
-				/**
-				 * Approve a campaign that is pending approval
-				 * @async
-				 * @roles signalhouse
-				 * @param {Object} params - The parameters for approving the campaign
-				 * @param {string} params.campaignId - The ID of the campaign to approve
-				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-				 * @throws {Error} Throws an error if the campaignId parameter is missing
-				 * @returns {Promise<Object>} The response from the server
-				 */
-				approveCampaign: async ({ campaignId, options = {} }) => {
-					this.client._require({ campaignId });
-					const safeCampaignId = encodeURIComponent(campaignId);
-					return this.client(`/campaign/approve/${safeCampaignId}`, { method: "POST", ...options });
-				},
-				/**
-				 * Reject a campaign that is pending approval
-				 * @async
-				 * @roles signalhouse
-				 * @param {Object} params - The parameters for rejecting the campaign
-				 * @param {string} params.campaignId - The ID of the campaign to reject
-				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request (body should include { rejectionReason })
-				 * @throws {Error} Throws an error if the campaignId parameter is missing
-				 * @returns {Promise<Object>} The response from the server
-				 */
-				rejectCampaign: async ({ campaignId, options = {} }) => {
-					this.client._require({ campaignId });
-					const safeCampaignId = encodeURIComponent(campaignId);
-					return this.client(`/campaign/reject/${safeCampaignId}`, { method: "POST", ...options });
-				},
-				/**
-				 * Get CNP campaigns shared with Signal House
-				 * @async
-				 * @roles signalhouse
-				 * @param {Object} params - The parameters for retrieving CNP campaigns
-				 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-				 * @returns {Promise<Array>} The response from the server
-				 */
-				getCNPCampaigns: async ({ options = {} } = {}) => {
-					return this.client(`/campaign/cnp`, { method: "GET", ...options });
-				},
-			};
-		}
-	}
+  /**
+   * Create a new Toll-Free (TFN) campaign and submit it for Signal House review
+   * @async
+   * @roles api, admin, developer, user
+   * @param {Object} params - The parameters for creating the toll-free campaign
+   * @param {CreateTollFreeCampaignData} params.campaignData - The data for the toll-free campaign to be created (see CreateTollFreeCampaignData typedef for details)
+   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+   * @throws {Error} Throws an error if the campaignData parameter is missing
+   * @returns {Promise<Object>} The response from the server
+   */
+  async createTollFreeCampaign({ campaignData, options = {} }) {
+    this.client._require({ campaignData });
+    return this.client(`/campaign/toll-free`, { method: 'POST', body: campaignData, ...options });
+  }
 
-	/**
-	 * Get a list of campaigns with optional filters
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for filtering the campaigns
-	 * @param {string} [params.id] - The ID of the campaign to filter by
-	 * @param {string} [params.brandId] - The ID of the brand to filter by
-	 * @param {string} [params.subgroupId] - The ID of the subgroup to filter by
-	 * @param {string} [params.groupId] - The ID of the group to filter by
-	 * @param {number} [params.page] - The page number for pagination
-	 * @param {number} [params.limit] - The number of items per page
-	 * @param {string} [params.status] - The status of the campaign to filter by
-	 * @param {string} [params.search] - Search term to filter campaigns by campaignId or brandId
-	 * @param {string} [params.sortBy] - Field to sort by (e.g. "createdAt", "campaignId", "brandId", "groupId", "subgroupId", "usecase", "status")
-	 * @param {string} [params.sortOrder] - Sort direction ("asc" or "desc")
-	 * @param {string} [params.registrationType] - Filter by registration type ("TEN_DLC" or "TOLL_FREE")
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Array|Object>} The response from the server - array when unpaginated, or { data, total, page, limit, totalPages } when paginated
-	 */
-	async getCampaigns({ id, brandId, subgroupId, groupId, page, limit, status, search, sortBy, sortOrder, registrationType, options = {} }) {
-		const filters = { id, brandId, subgroupId, groupId, page, limit, status, search, sortBy, sortOrder, registrationType };
-		const queryString = this.client._getQueryString(filters);
-		return this.client(`/campaign${queryString}`, { method: "GET", ...options });
-	}
+  /**
+   * Create a new Short Code campaign and submit it for Signal House review (SHGHL-2225). Requires an
+   * approved (VERIFIED) Short Code brand. `campaignData.shortCode.optInUrl` is optional; Signal House
+  * uses the brand's `optInLink` when it is omitted, then captures its screenshot asynchronously, retrying up to three times. Request or register the
+  * campaign's Short Code separately through `numbers.requestShortCodeAcquisition` after creation.
+   * @async
+   * @roles api, admin, developer, user
+   * @param {Object} params - The parameters for creating the Short Code campaign
+   * @param {CreateShortCodeCampaignData} params.campaignData - The Short Code campaign data (see CreateShortCodeCampaignData typedef for details)
+   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+   * @throws {Error} Throws an error if the campaignData parameter is missing
+   * @returns {Promise<Object>} The response from the server
+   */
+  async createShortCodeCampaign({ campaignData, options = {} }) {
+    this.client._require({ campaignData });
+    const formData = new FormData();
+    formData.append('campaignData', JSON.stringify(campaignData));
+    return this.multipartClient(`/campaign/short-code`, { method: 'POST', body: formData, ...options });
+  }
 
-	/**
-	 * Get aggregated campaign health (7-day and 30-day windows) for a campaign.
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - Parameters for reading campaign health
-	 * @param {string} params.campaignId - Campaign identifier
-	 * @param {boolean} [params.includeNumbers=false] - When true, include per-number health entries
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional request options
-	 * @returns {Promise<Object>} A promise that resolves to `{ campaignId, sevenDay, thirtyDay, numbers? }`
-	 */
-	async getCampaignHealth({ campaignId, includeNumbers = false, options = {} }) {
-		this.client._require({ campaignId });
-		const queryString = this.client._getQueryString({ campaignId, includeNumbers });
-		return this.client(`/campaign/health${queryString}`, { method: "GET", ...options });
-	}
+  /**
+   * Update a Short Code campaign's editable fields (SHGHL-2225). Only permitted while the campaign is in
+   * Signal House Review or Signal House Rejected status; the number source cannot be changed once submitted.
+   * @async
+   * @roles api, admin, developer, user
+   * @param {Object} params - The parameters for updating the Short Code campaign
+   * @param {string} params.campaignId - The ID of the campaign to update
+   * @param {Object} params.updateData - The fields to update (top-level campaign fields plus an optional `shortCode` object of editable Short Code fields)
+   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+   * @throws {Error} Throws an error if the campaignId parameter is missing
+   * @returns {Promise<Object>} The updated campaign
+   */
+  async updateShortCodeCampaign({ campaignId, updateData, options = {} }) {
+    this.client._require({ campaignId });
+    const safeCampaignId = encodeURIComponent(campaignId);
+    return this.client(`/campaign/short-code/${safeCampaignId}`, { method: 'PUT', body: updateData, ...options });
+  }
 
-	/**
-	 * Create a new campaign
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for creating the campaign (see CreateCampaignData typedef for details)
-	 * @param {CreateCampaignData} params.campaignData - The data for the campaign to be created (see CreateCampaignData typedef for details)
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @throws {Error} Throws an error if the campaignData parameter is missing or if required fields in campaignData are missing
-	 * @returns {Promise<Object>} The response from the server
-	 */
-	async createCampaign({ campaignData, options = {} }) {
-		this.client._require({ campaignData: campaignData });
-		return this.client(`/campaign`, { method: "POST", body: campaignData, ...options });
-	}
+  /**
+   * Cancel a Short Code campaign (SHGHL-2225). Customers may cancel only while the campaign is in Signal
+   * House Review or Signal House Rejected status; Signal House staff may cancel from any non-terminal
+   * status. Persists as "EXPIRED" (displayed as "Cancelled"). A real Registry lease (external or an
+   * already-fulfilled Signal House request) is never auto-released — see SHGHL-2228 for offboarding.
+   * @async
+   * @roles api, admin, developer, user
+   * @param {Object} params - The parameters for cancelling the campaign
+   * @param {string} params.campaignId - The ID of the campaign to cancel
+   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+   * @throws {Error} Throws an error if the campaignId parameter is missing
+   * @returns {Promise<Object>} The cancelled campaign
+   */
+  async cancelShortCodeCampaign({ campaignId, options = {} }) {
+    this.client._require({ campaignId });
+    const safeCampaignId = encodeURIComponent(campaignId);
+    return this.client(`/campaign/short-code/${safeCampaignId}/cancel`, { method: 'POST', ...options });
+  }
 
-	/**
-	 * Create a new Toll-Free (TFN) campaign and submit it for Signal House review
-	 * @async
-	 * @roles api, admin, developer, user
-	 * @param {Object} params - The parameters for creating the toll-free campaign
-	 * @param {CreateTollFreeCampaignData} params.campaignData - The data for the toll-free campaign to be created (see CreateTollFreeCampaignData typedef for details)
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @throws {Error} Throws an error if the campaignData parameter is missing
-	 * @returns {Promise<Object>} The response from the server
-	 */
-	async createTollFreeCampaign({ campaignData, options = {} }) {
-		this.client._require({ campaignData });
-		return this.client(`/campaign/toll-free`, { method: "POST", body: campaignData, ...options });
-	}
+  /**
+   * Download a private Short Code external lease receipt. Opt-in screenshots are public at the
+   * `shortCode.screenshotUrl` returned on the campaign. Authorized receipt users should pass
+   * `options: { responseType: "blob" }` (browser) or an equivalent binary response type for your HTTP
+   * client to receive the raw file bytes instead of attempting to parse them as JSON.
+   * @async
+   * @roles api, admin, developer, user
+   * @param {Object} params - The parameters for downloading the artifact
+   * @param {string} params.artifactId - The receipt identifier from `numberSource.externalLease.receiptArtifactId`
+   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+   * @throws {Error} Throws an error if the artifactId parameter is missing
+   * @returns {Promise<Object>} The response from the server (raw file bytes as `data` when a binary responseType is used)
+   */
+  async readCampaignArtifact({ artifactId, options = {} }) {
+    this.client._require({ artifactId });
+    const safeArtifactId = encodeURIComponent(artifactId);
+    return this.client(`/campaign/short-code/artifact/${safeArtifactId}`, { method: 'GET', ...options });
+  }
 
-	/**
-	 * Upload an opt-in proof image to be hosted on-platform, returning a publicly-fetchable URL suitable for a
-	 * Toll-Free campaign's optInImageURLs
-	 * @async
-	 * @roles api, admin, developer, user
-	 * @param {Object} params - The parameters for uploading the opt-in image
-	 * @param {Buffer|Blob|File} params.file - The image file to upload, provided as a Buffer/Blob/File
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @throws {Error} Throws an error if the file parameter is missing
-	 * @returns {Promise<Object>} The response from the server containing the hosted image's id and URL
-	 */
-	async uploadOptInImage({ file, options = {} }) {
-		this.client._require({ file });
-		const formData = new FormData();
-		formData.append("file", file);
-		return this.multipartClient(`/campaign/opt-in-image`, { method: "POST", body: formData, ...options });
-	}
+  /**
+   * Upload an opt-in proof image to be hosted on-platform, returning a publicly-fetchable URL suitable for a
+   * Toll-Free campaign's optInImageURLs
+   * @async
+   * @roles api, admin, developer, user
+   * @param {Object} params - The parameters for uploading the opt-in image
+   * @param {Buffer|Blob|File} params.file - The image file to upload, provided as a Buffer/Blob/File
+   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+   * @throws {Error} Throws an error if the file parameter is missing
+   * @returns {Promise<Object>} The response from the server containing the hosted image's id and URL
+   */
+  async uploadOptInImage({ file, options = {} }) {
+    this.client._require({ file });
+    const formData = new FormData();
+    formData.append('file', file);
+    return this.multipartClient(`/campaign/opt-in-image`, { method: 'POST', body: formData, ...options });
+  }
 
-	/**
-	 * Auto-capture an opt-in proof image from a brand's generated landing page and host it on-platform,
-	 * returning a publicly-fetchable URL suitable for a Toll-Free campaign's optInImageURLs
-	 * @async
-	 * @roles api, admin, developer, user
-	 * @param {Object} params - The parameters for capturing the opt-in image
-	 * @param {string} params.brandId - The ID of the brand whose generated landing page should be captured
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @throws {Error} Throws an error if the brandId parameter is missing
-	 * @returns {Promise<Object>} The response from the server containing the hosted image's id and URL
-	 */
-	async captureOptInImageFromLanding({ brandId, options = {} }) {
-		this.client._require({ brandId });
-		return this.client(`/campaign/opt-in-image/from-landing`, { method: "POST", body: { brandId }, ...options });
-	}
+  /**
+   * Auto-capture an opt-in proof image from a brand's generated landing page and host it on-platform,
+   * returning a publicly-fetchable URL suitable for a Toll-Free campaign's optInImageURLs
+   * @async
+   * @roles api, admin, developer, user
+   * @param {Object} params - The parameters for capturing the opt-in image
+   * @param {string} params.brandId - The ID of the brand whose generated landing page should be captured
+   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+   * @throws {Error} Throws an error if the brandId parameter is missing
+   * @returns {Promise<Object>} The response from the server containing the hosted image's id and URL
+   */
+  async captureOptInImageFromLanding({ brandId, options = {} }) {
+    this.client._require({ brandId });
+    return this.client(`/campaign/opt-in-image/from-landing`, { method: 'POST', body: { brandId }, ...options });
+  }
 
-	/**
-	 * Update an existing campaign
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for updating the campaign (see UpdateCampaignData typedef for details)
-	 * @param {string} params.campaignId - The ID of the campaign to update
-	 * @param {UpdateCampaignData} params.campaignData - The data for the campaign to be updated (see UpdateCampaignData typedef for details)
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @throws {Error} Throws an error if the campaignId parameter is missing or if required fields in campaignData are missing
-	 * @returns {Promise<Object>} The response from the server
-	 */
-	async updateCampaign({ campaignId, campaignData, options = {} }) {
-		this.client._require({ campaignId: campaignId });
-		const safeCampaignId = encodeURIComponent(campaignId);
-		return this.client(`/campaign/${safeCampaignId}`, { method: "PUT", body: campaignData, ...options });
-	}
+  /**
+   * Update an existing campaign
+   * @async
+   * @roles api, admin, developer, billing, user
+   * @param {Object} params - The parameters for updating the campaign (see UpdateCampaignData typedef for details)
+   * @param {string} params.campaignId - The ID of the campaign to update
+   * @param {UpdateCampaignData} params.campaignData - The data for the campaign to be updated (see UpdateCampaignData typedef for details)
+   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+   * @throws {Error} Throws an error if the campaignId parameter is missing or if required fields in campaignData are missing
+   * @returns {Promise<Object>} The response from the server
+   */
+  async updateCampaign({ campaignId, campaignData, options = {} }) {
+    this.client._require({ campaignId: campaignId });
+    const safeCampaignId = encodeURIComponent(campaignId);
+    return this.client(`/campaign/${safeCampaignId}`, { method: 'PUT', body: campaignData, ...options });
+  }
 
-	/**
-	 * Add an internal comment/note to a campaign
-	 * @async
-	 * @roles signalhouse_admin, signalhouse_user
-	 * @param {Object} params - The parameters for adding the comment
-	 * @param {string} params.campaignId - The ID of the campaign
-	 * @param {string} params.comment - The comment/note text
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @throws {Error} Throws an error if the campaignId or comment parameter is missing
-	 * @returns {Promise<Object>} The updated campaign object
-	 */
-	async addCampaignComment({ campaignId, comment, options = {} }) {
-		this.client._require({ campaignId, comment });
-		const safeCampaignId = encodeURIComponent(campaignId);
-		return this.client(`/campaign/${safeCampaignId}/comments`, { method: "POST", body: { comment }, ...options });
-	}
+  /**
+   * Add an internal comment/note to a campaign
+   * @async
+   * @roles signalhouse_admin, signalhouse_user
+   * @param {Object} params - The parameters for adding the comment
+   * @param {string} params.campaignId - The ID of the campaign
+   * @param {string} params.comment - The comment/note text
+   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+   * @throws {Error} Throws an error if the campaignId or comment parameter is missing
+   * @returns {Promise<Object>} The updated campaign object
+   */
+  async addCampaignComment({ campaignId, comment, options = {} }) {
+    this.client._require({ campaignId, comment });
+    const safeCampaignId = encodeURIComponent(campaignId);
+    return this.client(`/campaign/${safeCampaignId}/comments`, { method: 'POST', body: { comment }, ...options });
+  }
 
-	/**
-	 * Delete an existing campaign (mark it as EXPIRED). The campaign will still be retrievable
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for deleting the campaign
-	 * @param {string} params.campaignId - The ID of the campaign to delete
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @throws {Error} Throws an error if the campaignId parameter is missing
-	 * @returns {Promise<Object>} The response from the server
-	 */
-	async deleteCampaign({ campaignId, options = {} }) {
-		this.client._require({ campaignId: campaignId });
-		const safeCampaignId = encodeURIComponent(campaignId);
-		return this.client(`/campaign/${safeCampaignId}`, { method: "DELETE", ...options });
-	}
+  /**
+   * Delete an existing campaign (mark it as EXPIRED). The campaign will still be retrievable
+   * @async
+   * @roles api, admin, developer, billing, user
+   * @param {Object} params - The parameters for deleting the campaign
+   * @param {string} params.campaignId - The ID of the campaign to delete
+   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+   * @throws {Error} Throws an error if the campaignId parameter is missing
+   * @returns {Promise<Object>} The response from the server
+   */
+  async deleteCampaign({ campaignId, options = {} }) {
+    this.client._require({ campaignId: campaignId });
+    const safeCampaignId = encodeURIComponent(campaignId);
+    return this.client(`/campaign/${safeCampaignId}`, { method: 'DELETE', ...options });
+  }
 
-	/**
-	 * Appeal a DCA-rejected campaign
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for appealing the campaign rejection
-	 * @param {string} params.campaignId - The ID of the campaign to appeal
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request (body should include { reason })
-	 * @throws {Error} Throws an error if the campaignId parameter is missing
-	 * @returns {Promise<Object>} The response from the server
-	 */
-	async appealDcaRejection({ campaignId, options = {} }) {
-		this.client._require({ campaignId: campaignId });
-		const safeCampaignId = encodeURIComponent(campaignId);
-		return this.client(`/campaign/appealDcaRejection/${safeCampaignId}`, { method: "POST", ...options });
-	}
+  /**
+   * Appeal a DCA-rejected campaign
+   * @async
+   * @roles api, admin, developer, billing, user
+   * @param {Object} params - The parameters for appealing the campaign rejection
+   * @param {string} params.campaignId - The ID of the campaign to appeal
+   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request (body should include { reason })
+   * @throws {Error} Throws an error if the campaignId parameter is missing
+   * @returns {Promise<Object>} The response from the server
+   */
+  async appealDcaRejection({ campaignId, options = {} }) {
+    this.client._require({ campaignId: campaignId });
+    const safeCampaignId = encodeURIComponent(campaignId);
+    return this.client(`/campaign/appealDcaRejection/${safeCampaignId}`, { method: 'POST', ...options });
+  }
 
-	/**
-	 * Nudge a connectivity partner to prioritize review of a campaign in PENDING_DCA_APPROVAL status
-	 * @async
-	 * @roles api, admin, developer, billing, user
-	 * @param {Object} params - The parameters for nudging the campaign
-	 * @param {string} params.campaignId - The ID of the campaign to nudge
-	 * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @throws {Error} Throws an error if the campaignId parameter is missing
-	 * @returns {Promise<Object>} The response from the server
-	 */
-	async nudgeDcaForCampaign({ campaignId, options = {} }) {
-		this.client._require({ campaignId: campaignId });
-		const safeCampaignId = encodeURIComponent(campaignId);
-		return this.client(`/campaign/nudge/${safeCampaignId}`, { method: "POST", ...options });
-	}
+  /**
+   * Nudge a connectivity partner to prioritize review of a campaign in PENDING_DCA_APPROVAL status
+   * @async
+   * @roles api, admin, developer, billing, user
+   * @param {Object} params - The parameters for nudging the campaign
+   * @param {string} params.campaignId - The ID of the campaign to nudge
+   * @param {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+   * @throws {Error} Throws an error if the campaignId parameter is missing
+   * @returns {Promise<Object>} The response from the server
+   */
+  async nudgeDcaForCampaign({ campaignId, options = {} }) {
+    this.client._require({ campaignId: campaignId });
+    const safeCampaignId = encodeURIComponent(campaignId);
+    return this.client(`/campaign/nudge/${safeCampaignId}`, { method: 'POST', ...options });
+  }
 }