@signalhousellc/sdk 1.0.31 → 1.0.32

package/src/domains/Campaigns.js

@@ -1,210 +1,210 @@
-/**
- * @typedef {Object} CreateCampaignData
- * @property {string} brandId - The ID of the brand associated with the campaign (required)
- * @property {string} usecase - The use case for the campaign (2FA, ACCOUNT_NOTIFICATION, AGENTS_FRANCHISES, CARRIER_EXEMPT, CHARITY, CUSTOMER_CARE, DELIVERY_NOTIFICATION, EMERGENCY, FRAUD_ALERT, HIGHER_EDUCATION, K12_EDUCATION, LOW_VOLUME, M2M, MARKETING, MIXED, POLITICAL, POLLING_VOTING, PROXY, PUBLIC_SAFETY_RESTRICTED, PUBLIC_SERVICE_ANNOUNCEMENT, SECURITY_ALERT, SOCIAL, SOLE_PROPRIETOR, SWEEPSTAKE, TRIAL, UCAAS_HIGH, UCAAS_LOW)
- * @property {Array<string>} [subUsecases] - An array of sub-use cases for the campaign (2FA, ACCOUNT_NOTIFICATION, AGENTS_FRANCHISES, CARRIER_EXEMPT, CHARITY, CUSTOMER_CARE, DELIVERY_NOTIFICATION, EMERGENCY, FRAUD_ALERT, HIGHER_EDUCATION, K12_EDUCATION, LOW_VOLUME, M2M, MARKETING, MIXED, POLITICAL, POLLING_VOTING, PROXY, PUBLIC_SAFETY_RESTRICTED, PUBLIC_SERVICE_ANNOUNCEMENT, SECURITY_ALERT, SOCIAL, SOLE_PROPRIETOR, SWEEPSTAKE, TRIAL, UCAAS_HIGH, UCAAS_LOW)
- * @property {string} description - A detailed description of the campaign (required, must be between 40 and 4096 characters)
- * @property {boolean} [embeddedLink=true] - Whether the campaign includes an embedded link (optional, defaults to true)
- * @property {boolean} [embeddedPhone=false] - Whether the campaign includes an embedded phone number (optional, defaults to false)
- * @property {boolean} [termsAndConditions=true] - Whether the campaign includes terms and conditions (optional, defaults to true)
- * @property {boolean} [numberPool=false] - Whether the campaign uses a number pool (optional, defaults to false)
- * @property {boolean} [ageGated=false] - Whether the campaign is age-gated (optional, defaults to false)
- * @property {boolean} [directLending=false] - Whether the campaign uses direct lending (optional, defaults to false)
- * @property {boolean} [subscriberOptIn=true] - Whether the campaign requires subscriber opt-in (optional, defaults to true)
- * @property {boolean} [subscriberOptOut=true] - Whether the campaign allows subscriber opt-out (optional, defaults to true)
- * @property {boolean} [subscriberHelp=true] - Whether the campaign provides subscriber help (optional, defaults to true)
- * @property {string} [sample1] - Sample message 1 for the campaign (optional, must be between 20 and 1024 characters if provided)
- * @property {string} [sample2] - Sample message 2 for the campaign (optional, must be between 20 and 1024 characters if provided)
- * @property {string} [sample3] - Sample message 3 for the campaign (optional, must be between 20 and 1024 characters if provided)
- * @property {string} [sample4] - Sample message 4 for the campaign (optional, must be between 20 and 1024 characters if provided)
- * @property {string} [sample5] - Sample message 5 for the campaign (optional, must be between 20 and 1024 characters if provided)
- * @property {string} messageFlow - A detailed description of the message flow for the campaign (required, must be between 40 and 4096 characters)
- * @property {string} [helpMessage] - A message providing help information for the campaign (optional)
- * @property {boolean} [autoRenewal=true] - Whether the campaign should auto-renew (optional, defaults to true)
- * @property {string} [tag] - A tag for the campaign (optional, must be at most 255 characters)
- * @property {string} [optinKeywords="START,SUBSCRIBE"] - A comma-separated list of keywords for opting in to the campaign (optional, defaults to "START,SUBSCRIBE", must be at most 255 characters)
- * @property {string} [optoutKeywords="STOP,UNSUBSCRIBE"] - A comma-separated list of keywords for opting out of the campaign (optional, defaults to "STOP,UNSUBSCRIBE", must be at most 255 characters)
- * @property {string} [helpKeywords="HELP"] - A comma-separated list of keywords for getting help with the campaign (optional, defaults to "HELP", must be at most 255 characters)
- * @property {string} [optinMessage] - A message sent to users when they opt in to the campaign (optional, must be between 20 and 1024 characters if provided)
- * @property {string} [optoutMessage] - A message sent to users when they opt out of the campaign (optional, must be between 20 and 1024 characters if provided)
- * @property {string} privacyPolicyLink - A URL linking to the privacy policy for the campaign (required, must be at most 2048 characters)
- * @property {string} termsAndConditionsLink - A URL linking to the terms and conditions for the campaign (required, must be at most 2048 characters)
- * @property {string} [embeddedLinkSample] - A sample of the embedded link used in the campaign (optional, must be at most 255 characters)
- * @property {Array<string>} phoneNumbers - An array of phone numbers associated with the campaign (required, each number must be at least 10 digits and contain only digits, a maximum of 5000 numbers is allowed)
- */
-
-/**
- * @typedef {Object} UpdateCampaignData
- * @property {string} [usecase] - The use case for the campaign (2FA, ACCOUNT_NOTIFICATION, AGENTS_FRANCHISES, CARRIER_EXEMPT, CHARITY, CUSTOMER_CARE, DELIVERY_NOTIFICATION, EMERGENCY, FRAUD_ALERT, HIGHER_EDUCATION, K12_EDUCATION, LOW_VOLUME, M2M, MARKETING, MIXED, POLITICAL, POLLING_VOTING, PROXY, PUBLIC_SAFETY_RESTRICTED, PUBLIC_SERVICE_ANNOUNCEMENT, SECURITY_ALERT, SOCIAL, SOLE_PROPRIETOR, SWEEPSTAKE, TRIAL, UCAAS_HIGH, UCAAS_LOW)
- * @property {Array<string>} [subUsecases] - An array of sub-use cases for the campaign (2FA, ACCOUNT_NOTIFICATION, AGENTS_FRANCHISES, CARRIER_EXEMPT, CHARITY, CUSTOMER_CARE, DELIVERY_NOTIFICATION, EMERGENCY, FRAUD_ALERT, HIGHER_EDUCATION, K12_EDUCATION, LOW_VOLUME, M2M, MARKETING, MIXED, POLITICAL, POLLING_VOTING, PROXY, PUBLIC_SAFETY_RESTRICTED, PUBLIC_SERVICE_ANNOUNCEMENT, SECURITY_ALERT, SOCIAL, SOLE_PROPRIETOR, SWEEPSTAKE, TRIAL, UCAAS_HIGH, UCAAS_LOW)
- * @property {string} [description] - A detailed description of the campaign (optional, must be between 40 and 4096 characters if provided)
- * @property {boolean} [embeddedLink] - Whether the campaign includes an embedded link (optional)
- * @property {boolean} [embeddedPhone] - Whether the campaign includes an embedded phone number (optional)
- * @property {boolean} [termsAndConditions] - Whether the campaign includes terms and conditions (optional)
- * @property {boolean} [numberPool] - Whether the campaign uses a number pool (optional)
- * @property {boolean} [ageGated] - Whether the campaign is age-gated (optional)
- * @property {boolean} [directLending] - Whether the campaign uses direct lending (optional)
- * @property {boolean} [subscriberOptIn] - Whether the campaign requires subscriber opt-in (optional)
- * @property {boolean} [subscriberOptOut] - Whether the campaign allows subscriber opt-out (optional)
- * @property {boolean} [subscriberHelp] - Whether the campaign provides subscriber help (optional)
- * @property {string} [sample1] - Sample message 1 for the campaign (optional, must be between 20 and 1024 characters if provided)
- * @property {string} [sample2] - Sample message 2 for the campaign (optional, must be between 20 and 1024 characters if provided)
- * @property {string} [sample3] - Sample message 3 for the campaign (optional, must be between 20 and 1024 characters if provided)
- * @property {string} [sample4] - Sample message 4 for the campaign (optional, must be between 20 and 1024 characters if provided)
- * @property {string} [sample5] - Sample message 5 for the campaign (optional, must be between 20 and 1024 characters if provided)
- * @property {string} [messageFlow] - A detailed description of the message flow for the campaign (optional, must be between 40 and 4096 characters if provided)
- * @property {string} [helpMessage] - A message providing help information for the campaign (optional)
- * @property {boolean} [autoRenewal] - Whether the campaign should auto-renew (optional)
- * @property {string} [tag] - A tag for the campaign (optional, must be at most 255 characters)
- * @property {string} [optinKeywords] - A comma-separated list of keywords for opting in to the campaign (optional, must be at most 255 characters)
- * @property {string} [optoutKeywords] - A comma-separated list of keywords for opting out of the campaign (optional, must be at most 255 characters)
- * @property {string} [helpKeywords] - A comma-separated list of keywords for getting help with the campaign (optional, must be at most 255 characters)
- * @property {string} [optinMessage] - A message sent to users when they opt in to the campaign (optional, must be between 20 and 1024 characters if provided)
- * @property {string} [optoutMessage] - A message sent to users when they opt out of the campaign (optional, must be between 20 and 1024 characters if provided)
- * @property {string} [privacyPolicyLink] - A URL linking to the privacy policy for the campaign (optional, must be at most 2048 characters if provided)
- * @property {string} [termsAndConditionsLink] - A URL linking to the terms and conditions for the campaign (optional, must be at most 2048 characters if provided)
- * @property {string} [embeddedLinkSample] - A sample of the embedded link used in the campaign (optional, must be at most 255 characters if provided)
- */
-
-export class Campaigns {
-	constructor(client, enableAdmin) {
-		this.client = client;
-		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
-				 * @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 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 {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
-	 * @returns {Promise<Array>} The response from the server
-	 */
-	async getCampaigns({ id, brandId, subgroupId, groupId, page, limit, status, options = {} }) {
-		const filters = { id, brandId, subgroupId, groupId, page, limit, status };
-		const queryString = this.client._getQueryString(filters);
-		return this.client(`/campaign${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 });
-	}
-
-	/**
-	 * 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 });
-	}
-
-	/**
-	 * 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 });
-	}
-
-	/**
-	 * 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 });
-	}
-}
+/**
+ * @typedef {Object} CreateCampaignData
+ * @property {string} brandId - The ID of the brand associated with the campaign (required)
+ * @property {string} usecase - The use case for the campaign (2FA, ACCOUNT_NOTIFICATION, AGENTS_FRANCHISES, CARRIER_EXEMPT, CHARITY, CUSTOMER_CARE, DELIVERY_NOTIFICATION, EMERGENCY, FRAUD_ALERT, HIGHER_EDUCATION, K12_EDUCATION, LOW_VOLUME, M2M, MARKETING, MIXED, POLITICAL, POLLING_VOTING, PROXY, PUBLIC_SAFETY_RESTRICTED, PUBLIC_SERVICE_ANNOUNCEMENT, SECURITY_ALERT, SOCIAL, SOLE_PROPRIETOR, SWEEPSTAKE, TRIAL, UCAAS_HIGH, UCAAS_LOW)
+ * @property {Array<string>} [subUsecases] - An array of sub-use cases for the campaign (2FA, ACCOUNT_NOTIFICATION, AGENTS_FRANCHISES, CARRIER_EXEMPT, CHARITY, CUSTOMER_CARE, DELIVERY_NOTIFICATION, EMERGENCY, FRAUD_ALERT, HIGHER_EDUCATION, K12_EDUCATION, LOW_VOLUME, M2M, MARKETING, MIXED, POLITICAL, POLLING_VOTING, PROXY, PUBLIC_SAFETY_RESTRICTED, PUBLIC_SERVICE_ANNOUNCEMENT, SECURITY_ALERT, SOCIAL, SOLE_PROPRIETOR, SWEEPSTAKE, TRIAL, UCAAS_HIGH, UCAAS_LOW)
+ * @property {string} description - A detailed description of the campaign (required, must be between 40 and 4096 characters)
+ * @property {boolean} [embeddedLink=true] - Whether the campaign includes an embedded link (optional, defaults to true)
+ * @property {boolean} [embeddedPhone=false] - Whether the campaign includes an embedded phone number (optional, defaults to false)
+ * @property {boolean} [termsAndConditions=true] - Whether the campaign includes terms and conditions (optional, defaults to true)
+ * @property {boolean} [numberPool=false] - Whether the campaign uses a number pool (optional, defaults to false)
+ * @property {boolean} [ageGated=false] - Whether the campaign is age-gated (optional, defaults to false)
+ * @property {boolean} [directLending=false] - Whether the campaign uses direct lending (optional, defaults to false)
+ * @property {boolean} [subscriberOptIn=true] - Whether the campaign requires subscriber opt-in (optional, defaults to true)
+ * @property {boolean} [subscriberOptOut=true] - Whether the campaign allows subscriber opt-out (optional, defaults to true)
+ * @property {boolean} [subscriberHelp=true] - Whether the campaign provides subscriber help (optional, defaults to true)
+ * @property {string} [sample1] - Sample message 1 for the campaign (optional, must be between 20 and 1024 characters if provided)
+ * @property {string} [sample2] - Sample message 2 for the campaign (optional, must be between 20 and 1024 characters if provided)
+ * @property {string} [sample3] - Sample message 3 for the campaign (optional, must be between 20 and 1024 characters if provided)
+ * @property {string} [sample4] - Sample message 4 for the campaign (optional, must be between 20 and 1024 characters if provided)
+ * @property {string} [sample5] - Sample message 5 for the campaign (optional, must be between 20 and 1024 characters if provided)
+ * @property {string} messageFlow - A detailed description of the message flow for the campaign (required, must be between 40 and 4096 characters)
+ * @property {string} [helpMessage] - A message providing help information for the campaign (optional)
+ * @property {boolean} [autoRenewal=true] - Whether the campaign should auto-renew (optional, defaults to true)
+ * @property {string} [tag] - A tag for the campaign (optional, must be at most 255 characters)
+ * @property {string} [optinKeywords="START,SUBSCRIBE"] - A comma-separated list of keywords for opting in to the campaign (optional, defaults to "START,SUBSCRIBE", must be at most 255 characters)
+ * @property {string} [optoutKeywords="STOP,UNSUBSCRIBE"] - A comma-separated list of keywords for opting out of the campaign (optional, defaults to "STOP,UNSUBSCRIBE", must be at most 255 characters)
+ * @property {string} [helpKeywords="HELP"] - A comma-separated list of keywords for getting help with the campaign (optional, defaults to "HELP", must be at most 255 characters)
+ * @property {string} [optinMessage] - A message sent to users when they opt in to the campaign (optional, must be between 20 and 1024 characters if provided)
+ * @property {string} [optoutMessage] - A message sent to users when they opt out of the campaign (optional, must be between 20 and 1024 characters if provided)
+ * @property {string} privacyPolicyLink - A URL linking to the privacy policy for the campaign (required, must be at most 2048 characters)
+ * @property {string} termsAndConditionsLink - A URL linking to the terms and conditions for the campaign (required, must be at most 2048 characters)
+ * @property {string} [embeddedLinkSample] - A sample of the embedded link used in the campaign (optional, must be at most 255 characters)
+ * @property {Array<string>} phoneNumbers - An array of phone numbers associated with the campaign (required, each number must be at least 10 digits and contain only digits, a maximum of 5000 numbers is allowed)
+ */
+
+/**
+ * @typedef {Object} UpdateCampaignData
+ * @property {string} [usecase] - The use case for the campaign (2FA, ACCOUNT_NOTIFICATION, AGENTS_FRANCHISES, CARRIER_EXEMPT, CHARITY, CUSTOMER_CARE, DELIVERY_NOTIFICATION, EMERGENCY, FRAUD_ALERT, HIGHER_EDUCATION, K12_EDUCATION, LOW_VOLUME, M2M, MARKETING, MIXED, POLITICAL, POLLING_VOTING, PROXY, PUBLIC_SAFETY_RESTRICTED, PUBLIC_SERVICE_ANNOUNCEMENT, SECURITY_ALERT, SOCIAL, SOLE_PROPRIETOR, SWEEPSTAKE, TRIAL, UCAAS_HIGH, UCAAS_LOW)
+ * @property {Array<string>} [subUsecases] - An array of sub-use cases for the campaign (2FA, ACCOUNT_NOTIFICATION, AGENTS_FRANCHISES, CARRIER_EXEMPT, CHARITY, CUSTOMER_CARE, DELIVERY_NOTIFICATION, EMERGENCY, FRAUD_ALERT, HIGHER_EDUCATION, K12_EDUCATION, LOW_VOLUME, M2M, MARKETING, MIXED, POLITICAL, POLLING_VOTING, PROXY, PUBLIC_SAFETY_RESTRICTED, PUBLIC_SERVICE_ANNOUNCEMENT, SECURITY_ALERT, SOCIAL, SOLE_PROPRIETOR, SWEEPSTAKE, TRIAL, UCAAS_HIGH, UCAAS_LOW)
+ * @property {string} [description] - A detailed description of the campaign (optional, must be between 40 and 4096 characters if provided)
+ * @property {boolean} [embeddedLink] - Whether the campaign includes an embedded link (optional)
+ * @property {boolean} [embeddedPhone] - Whether the campaign includes an embedded phone number (optional)
+ * @property {boolean} [termsAndConditions] - Whether the campaign includes terms and conditions (optional)
+ * @property {boolean} [numberPool] - Whether the campaign uses a number pool (optional)
+ * @property {boolean} [ageGated] - Whether the campaign is age-gated (optional)
+ * @property {boolean} [directLending] - Whether the campaign uses direct lending (optional)
+ * @property {boolean} [subscriberOptIn] - Whether the campaign requires subscriber opt-in (optional)
+ * @property {boolean} [subscriberOptOut] - Whether the campaign allows subscriber opt-out (optional)
+ * @property {boolean} [subscriberHelp] - Whether the campaign provides subscriber help (optional)
+ * @property {string} [sample1] - Sample message 1 for the campaign (optional, must be between 20 and 1024 characters if provided)
+ * @property {string} [sample2] - Sample message 2 for the campaign (optional, must be between 20 and 1024 characters if provided)
+ * @property {string} [sample3] - Sample message 3 for the campaign (optional, must be between 20 and 1024 characters if provided)
+ * @property {string} [sample4] - Sample message 4 for the campaign (optional, must be between 20 and 1024 characters if provided)
+ * @property {string} [sample5] - Sample message 5 for the campaign (optional, must be between 20 and 1024 characters if provided)
+ * @property {string} [messageFlow] - A detailed description of the message flow for the campaign (optional, must be between 40 and 4096 characters if provided)
+ * @property {string} [helpMessage] - A message providing help information for the campaign (optional)
+ * @property {boolean} [autoRenewal] - Whether the campaign should auto-renew (optional)
+ * @property {string} [tag] - A tag for the campaign (optional, must be at most 255 characters)
+ * @property {string} [optinKeywords] - A comma-separated list of keywords for opting in to the campaign (optional, must be at most 255 characters)
+ * @property {string} [optoutKeywords] - A comma-separated list of keywords for opting out of the campaign (optional, must be at most 255 characters)
+ * @property {string} [helpKeywords] - A comma-separated list of keywords for getting help with the campaign (optional, must be at most 255 characters)
+ * @property {string} [optinMessage] - A message sent to users when they opt in to the campaign (optional, must be between 20 and 1024 characters if provided)
+ * @property {string} [optoutMessage] - A message sent to users when they opt out of the campaign (optional, must be between 20 and 1024 characters if provided)
+ * @property {string} [privacyPolicyLink] - A URL linking to the privacy policy for the campaign (optional, must be at most 2048 characters if provided)
+ * @property {string} [termsAndConditionsLink] - A URL linking to the terms and conditions for the campaign (optional, must be at most 2048 characters if provided)
+ * @property {string} [embeddedLinkSample] - A sample of the embedded link used in the campaign (optional, must be at most 255 characters if provided)
+ */
+
+export class Campaigns {
+	constructor(client, enableAdmin) {
+		this.client = client;
+		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
+				 * @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 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 {import('../SignalHouseSDK').RequestOptions} [params.options] - Additional options for the request
+	 * @returns {Promise<Array>} The response from the server
+	 */
+	async getCampaigns({ id, brandId, subgroupId, groupId, page, limit, status, options = {} }) {
+		const filters = { id, brandId, subgroupId, groupId, page, limit, status };
+		const queryString = this.client._getQueryString(filters);
+		return this.client(`/campaign${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 });
+	}
+
+	/**
+	 * 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 });
+	}
+
+	/**
+	 * 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 });
+	}
+
+	/**
+	 * 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 });
+	}
+}