@unboundcx/sdk 2.6.8 → 2.6.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unboundcx/sdk",
-  "version": "2.6.8",
+  "version": "2.6.10",
   "description": "Official JavaScript SDK for the Unbound API - A comprehensive toolkit for integrating with Unbound's communication, AI, and data management services",
   "main": "index.js",
   "type": "module",

package/services/messaging.js

@@ -626,20 +626,6 @@ export class TollFreeCampaignsService {
     return result;
   }
 
-  async get(campaignId) {
-    this.sdk.validateParams(
-      { campaignId },
-      {
-        campaignId: { type: 'string', required: true },
-      },
-    );
-
-    const result = await this.sdk._fetch(
-      `/messaging/campaigns/tollfree/${campaignId}`,
-      'GET',
-    );
-    return result;
-  }
 
   async list() {
     const result = await this.sdk._fetch(
@@ -658,13 +644,13 @@ export class TollFreeCampaignsService {
     );
 
     const result = await this.sdk._fetch(
-      `/messaging/campaigns/tollfree/${campaignId}/refresh`,
-      'POST',
+      `/messaging/campaigns/tollfree/refresh/${campaignId}`,
+      'GET',
     );
     return result;
   }
 
-  async getPhoneNumberStatus(phoneNumber) {
+  async getPhoneNumberCampaignStatus(phoneNumber) {
     this.sdk.validateParams(
       { phoneNumber },
       {
@@ -672,14 +658,9 @@ export class TollFreeCampaignsService {
       },
     );
 
-    const options = {
-      query: { phoneNumber },
-    };
-
     const result = await this.sdk._fetch(
-      '/messaging/campaigns/tollfree/phone-number-status',
+      `/messaging/campaigns/tollfree/phoneNumber/${encodeURIComponent(phoneNumber)}/campaignStatus`,
       'GET',
-      options,
     );
     return result;
   }
@@ -688,9 +669,51 @@ export class TollFreeCampaignsService {
 export class TenDlcCampaignsService {
   constructor(sdk) {
     this.sdk = sdk;
+    this.brands = new TenDlcBrandsService(sdk);
+    this.campaigns = new TenDlcCampaignManagementService(sdk);
+  }
+
+  /**
+   * Get phone number campaign status for 10DLC
+   * @param {string} phoneNumber - Phone number to check
+   * @returns {Promise<Object>} Campaign status information
+   */
+  async getPhoneNumberCampaignStatus(phoneNumber) {
+    this.sdk.validateParams(
+      { phoneNumber },
+      {
+        phoneNumber: { type: 'string', required: true },
+      },
+    );
+
+    const result = await this.sdk._fetch(
+      `/messaging/campaigns/10dlc/phoneNumber/${encodeURIComponent(phoneNumber)}/campaignStatus`,
+      'GET',
+    );
+    return result;
   }
+}
 
-  async createBrand({
+export class TenDlcBrandsService {
+  constructor(sdk) {
+    this.sdk = sdk;
+  }
+
+  /**
+   * List all 10DLC brands
+   */
+  async list() {
+    const result = await this.sdk._fetch(
+      '/messaging/campaigns/10dlc/brand',
+      'GET',
+    );
+    return result;
+  }
+
+  /**
+   * Create a new 10DLC brand
+   */
+  async create({
     companyName,
     ein,
     website,
@@ -747,7 +770,28 @@ export class TenDlcCampaignsService {
     return result;
   }
 
-  async updateBrand(brandId, { companyName, website }) {
+  /**
+   * Get a 10DLC brand by ID
+   */
+  async get(brandId) {
+    this.sdk.validateParams(
+      { brandId },
+      {
+        brandId: { type: 'string', required: true },
+      },
+    );
+
+    const result = await this.sdk._fetch(
+      `/messaging/campaigns/10dlc/brand/${brandId}`,
+      'GET',
+    );
+    return result;
+  }
+
+  /**
+   * Update a 10DLC brand
+   */
+  async update(brandId, { companyName, website }) {
     this.sdk.validateParams(
       { brandId },
       {
@@ -772,4 +816,319 @@ export class TenDlcCampaignsService {
     );
     return result;
   }
+
+  /**
+   * Delete a 10DLC brand
+   */
+  async delete(brandId) {
+    this.sdk.validateParams(
+      { brandId },
+      {
+        brandId: { type: 'string', required: true },
+      },
+    );
+
+    const result = await this.sdk._fetch(
+      `/messaging/campaigns/10dlc/brand/${brandId}`,
+      'DELETE',
+    );
+    return result;
+  }
+
+  /**
+   * Revet a 10DLC brand
+   */
+  async revet(brandId) {
+    this.sdk.validateParams(
+      { brandId },
+      {
+        brandId: { type: 'string', required: true },
+      },
+    );
+
+    const result = await this.sdk._fetch(
+      `/messaging/campaigns/10dlc/brand/${brandId}/revet`,
+      'PUT',
+    );
+    return result;
+  }
+
+  /**
+   * Get brand feedback
+   */
+  async getFeedback(brandId) {
+    this.sdk.validateParams(
+      { brandId },
+      {
+        brandId: { type: 'string', required: true },
+      },
+    );
+
+    const result = await this.sdk._fetch(
+      `/messaging/campaigns/10dlc/brand/${brandId}/feedback`,
+      'GET',
+    );
+    return result;
+  }
+
+  /**
+   * Create external brand vetting
+   */
+  async createExternalVetting(brandId, vettingData) {
+    this.sdk.validateParams(
+      { brandId },
+      {
+        brandId: { type: 'string', required: true },
+        vettingData: { type: 'object', required: false },
+      },
+    );
+
+    const options = {
+      body: vettingData || {},
+    };
+
+    const result = await this.sdk._fetch(
+      `/messaging/campaigns/10dlc/brand/${brandId}/externalVetting`,
+      'POST',
+      options,
+    );
+    return result;
+  }
+
+  /**
+   * Get brand external vetting responses
+   */
+  async getExternalVettingResponses(brandId) {
+    this.sdk.validateParams(
+      { brandId },
+      {
+        brandId: { type: 'string', required: true },
+      },
+    );
+
+    const result = await this.sdk._fetch(
+      `/messaging/campaigns/10dlc/brand/${brandId}/externalvetting/responses`,
+      'GET',
+    );
+    return result;
+  }
+}
+
+export class TenDlcCampaignManagementService {
+  constructor(sdk) {
+    this.sdk = sdk;
+  }
+
+  /**
+   * List all 10DLC campaigns
+   */
+  async list() {
+    const result = await this.sdk._fetch(
+      '/messaging/campaigns/10dlc/campaign',
+      'GET',
+    );
+    return result;
+  }
+
+  /**
+   * Create a new 10DLC campaign
+   */
+  async create(campaignData) {
+    this.sdk.validateParams(
+      campaignData,
+      {
+        brandId: { type: 'string', required: true },
+        description: { type: 'string', required: true },
+        messageFlow: { type: 'string', required: true },
+        helpMessage: { type: 'string', required: false },
+        optInMessage: { type: 'string', required: false },
+        optOutMessage: { type: 'string', required: false },
+        useCase: { type: 'string', required: false },
+        vertical: { type: 'string', required: false },
+      },
+    );
+
+    const options = {
+      body: campaignData,
+    };
+
+    const result = await this.sdk._fetch(
+      '/messaging/campaigns/10dlc/campaign',
+      'POST',
+      options,
+    );
+    return result;
+  }
+
+  /**
+   * Get a 10DLC campaign by ID
+   */
+  async get(campaignId) {
+    this.sdk.validateParams(
+      { campaignId },
+      {
+        campaignId: { type: 'string', required: true },
+      },
+    );
+
+    const result = await this.sdk._fetch(
+      `/messaging/campaigns/10dlc/campaign/${campaignId}`,
+      'GET',
+    );
+    return result;
+  }
+
+  /**
+   * Update a 10DLC campaign
+   */
+  async update(campaignId, updateData) {
+    this.sdk.validateParams(
+      { campaignId },
+      {
+        campaignId: { type: 'string', required: true },
+        description: { type: 'string', required: false },
+        messageFlow: { type: 'string', required: false },
+        helpMessage: { type: 'string', required: false },
+        optInMessage: { type: 'string', required: false },
+        optOutMessage: { type: 'string', required: false },
+      },
+    );
+
+    const options = {
+      body: updateData,
+    };
+
+    const result = await this.sdk._fetch(
+      `/messaging/campaigns/10dlc/campaign/${campaignId}`,
+      'PUT',
+      options,
+    );
+    return result;
+  }
+
+  /**
+   * Delete a 10DLC campaign
+   */
+  async delete(campaignId) {
+    this.sdk.validateParams(
+      { campaignId },
+      {
+        campaignId: { type: 'string', required: true },
+      },
+    );
+
+    const result = await this.sdk._fetch(
+      `/messaging/campaigns/10dlc/campaign/${campaignId}`,
+      'DELETE',
+    );
+    return result;
+  }
+
+  /**
+   * Get campaign operation status
+   */
+  async getOperationStatus(campaignId) {
+    this.sdk.validateParams(
+      { campaignId },
+      {
+        campaignId: { type: 'string', required: true },
+      },
+    );
+
+    const result = await this.sdk._fetch(
+      `/messaging/campaigns/10dlc/campaign/${campaignId}/operationStatus`,
+      'GET',
+    );
+    return result;
+  }
+
+  /**
+   * Get MNO campaign metadata
+   */
+  async getMnoMetaData(campaignId) {
+    this.sdk.validateParams(
+      { campaignId },
+      {
+        campaignId: { type: 'string', required: true },
+      },
+    );
+
+    const result = await this.sdk._fetch(
+      `/messaging/campaigns/10dlc/campaign/${campaignId}/mnoMetaData`,
+      'GET',
+    );
+    return result;
+  }
+
+  /**
+   * Add phone number to campaign
+   */
+  async addPhoneNumber(campaignId, phoneNumberData) {
+    this.sdk.validateParams(
+      { campaignId, phoneNumberData },
+      {
+        campaignId: { type: 'string', required: true },
+        phoneNumberData: { type: 'object', required: true },
+      },
+    );
+
+    const options = {
+      body: phoneNumberData,
+    };
+
+    const result = await this.sdk._fetch(
+      `/messaging/campaigns/10dlc/campaign/${campaignId}/phoneNumber`,
+      'POST',
+      options,
+    );
+    return result;
+  }
+
+  /**
+   * Update phone number in campaign
+   */
+  async updatePhoneNumber(campaignId, phoneNumberData) {
+    this.sdk.validateParams(
+      { campaignId, phoneNumberData },
+      {
+        campaignId: { type: 'string', required: true },
+        phoneNumberData: { type: 'object', required: true },
+      },
+    );
+
+    const options = {
+      body: phoneNumberData,
+    };
+
+    const result = await this.sdk._fetch(
+      `/messaging/campaigns/10dlc/campaign/${campaignId}/phoneNumber`,
+      'PUT',
+      options,
+    );
+    return result;
+  }
+
+  /**
+   * Remove phone number from campaign
+   */
+  async removePhoneNumber(campaignId, phoneNumberData) {
+    this.sdk.validateParams(
+      { campaignId, phoneNumberData },
+      {
+        campaignId: { type: 'string', required: true },
+        phoneNumberData: { type: 'object', required: true },
+      },
+    );
+
+    const options = {
+      body: phoneNumberData,
+    };
+
+    const result = await this.sdk._fetch(
+      `/messaging/campaigns/10dlc/campaign/${campaignId}/phoneNumber`,
+      'DELETE',
+      options,
+    );
+    return result;
+  }
 }

package/services/phoneNumbers.js

@@ -321,29 +321,30 @@ export class PhoneNumbersService {
 
   async getPortingOrders({
     page,
-    includePhoneNumbers = true,
     status,
     customerReference,
     sort,
     limit,
+    id,
+    operatorType = 'contains',
   } = {}) {
-    const params = new URLSearchParams();
+    const query = {
+      page,
+      status,
+      customerReference,
+      id,
+      operatorType,
+      sort,
+      limit,
+    };
 
-    if (page) params.append('page', page);
-    if (includePhoneNumbers !== undefined)
-      params.append('includePhoneNumbers', includePhoneNumbers);
-    if (status) params.append('status', status);
-    if (customerReference)
-      params.append('customerReference', customerReference);
-    if (sort) params.append('sort', sort);
-    if (limit) params.append('limit', limit);
+    const url = '/phoneNumbers/porting/orders';
 
-    const queryString = params.toString();
-    const url = queryString
-      ? `/phoneNumbers/porting/orders?${queryString}`
-      : '/phoneNumbers/porting/orders';
+    const params = {
+      query,
+    };
 
-    const result = await this.sdk._fetch(url, 'GET');
+    const result = await this.sdk._fetch(url, 'GET', params);
     return result;
   }
 
@@ -695,10 +696,10 @@ export class PhoneNumbersService {
    * @example
    * // Get all comments
    * const allComments = await sdk.phoneNumbers.getPortingComments("port_123...");
-   * 
+   *
    * // Get only public comments
    * const publicComments = await sdk.phoneNumbers.getPortingComments("port_123...", { includeInternal: 'false' });
-   * 
+   *
    * // Get only internal comments
    * const internalComments = await sdk.phoneNumbers.getPortingComments("port_123...", { includeInternal: 'only' });
    */
@@ -716,7 +717,9 @@ export class PhoneNumbersService {
     }
 
     const queryString = params.toString();
-    const url = `/phoneNumbers/porting/orders/${id}/comments${queryString ? '?' + queryString : ''}`;
+    const url = `/phoneNumbers/porting/orders/${id}/comments${
+      queryString ? '?' + queryString : ''
+    }`;
 
     const result = await this.sdk._fetch(url, 'GET');
     return result;
@@ -735,7 +738,7 @@ export class PhoneNumbersService {
    *   comment: "Please expedite this port request",
    *   isInternal: false
    * });
-   * 
+   *
    * // Post an internal comment (team use only)
    * const internalComment = await sdk.phoneNumbers.postPortingComment("port_123...", {
    *   comment: "Customer called - they need this ASAP",
@@ -764,11 +767,11 @@ export class PhoneNumbersService {
 
   /**
    * Auto-create porting orders by grouping phone numbers by carrier
-   * 
+   *
    * Analyzes phone numbers using internal LRN lookup, groups them by carrier,
-   * and either previews the groupings (dry run) or creates separate porting 
+   * and either previews the groupings (dry run) or creates separate porting
    * orders for each carrier group.
-   * 
+   *
    * @param {Object} params
    * @param {string[]} params.phoneNumbers - Array of +E.164 formatted phone numbers (max 100)
    * @param {string} params.name - Base name for orders (will be appended with carrier names)
@@ -782,7 +785,7 @@ export class PhoneNumbersService {
    *   dryRun: true
    * });
    * // Returns carrier groups with proposed order names
-   * 
+   *
    * // Create orders for each carrier
    * const result = await sdk.phoneNumbers.autoCreateOrders({
    *   phoneNumbers: ['+15551234567', '+15551234568', '+15551234569'],