@unboundcx/sdk 2.8.6 → 2.8.8

package/services/messaging/TollFreeCampaignsService.js

@@ -6,60 +6,133 @@ export class TollFreeCampaignsService {
   /**
    * Create toll-free campaign
    * @param {Object} params - Campaign parameters
-   * @param {string} params.companyName - Company name (required)
-   * @param {string} params.phoneNumber - Phone number (required)
-   * @param {string} params.description - Campaign description (required)
-   * @param {string} params.messageFlow - Message flow description (required)
-   * @param {string} [params.helpMessage] - Help message
-   * @param {Array<string>} [params.optInKeywords] - Opt-in keywords
-   * @param {Array<string>} [params.optOutKeywords] - Opt-out keywords
+   * @param {string} params.name - Campaign name (required)
+   * @param {string} [params.campaignDescription] - Campaign description
+   * @param {string} [params.address1] - Business address line 1
+   * @param {string} [params.address2] - Business address line 2
+   * @param {string} [params.city] - Business city
+   * @param {string} [params.state] - Business state
+   * @param {string} [params.zip] - Business zip code
+   * @param {string} [params.pocFirstName] - Point of contact first name
+   * @param {string} [params.pocLastName] - Point of contact last name
+   * @param {string} [params.pocPhoneNumber] - Point of contact phone
+   * @param {string} [params.pocEmail] - Point of contact email
+   * @param {string} [params.businessName] - Business name
    * @param {string} [params.website] - Business website
+   * @param {string} [params.messageVolume] - Expected message volume
+   * @param {string} [params.optInWorkflow] - Opt-in workflow description
+   * @param {Array<string>} [params.optInWorkflowUrls] - Opt-in workflow image URLs
+   * @param {Array<string>} [params.phoneNumbers] - Phone numbers for campaign
+   * @param {string} [params.productionMessageExample] - Production message example
+   * @param {string} [params.useCase] - Use case category
+   * @param {string} [params.useCaseDescription] - Use case description
+   * @param {string} [params.webhookUrl] - Webhook URL
+   * @param {string} [params.businessRegistrationNumber] - Business registration number
+   * @param {string} [params.businessRegistrationType] - Business registration type
+   * @param {string} [params.businessRegistrationCountry] - Business registration country (ISO 3166-1 alpha-2)
+   * @param {string} [params.doingBusinessAs] - Doing business as name
+   * @param {string} [params.entityType] - Entity type
+   * @param {string} [params.optInConfirmationResponse] - Opt-in confirmation response
+   * @param {string} [params.helpMessageResponse] - Help message response
+   * @param {string} [params.privacyPolicyURL] - Privacy policy URL
+   * @param {string} [params.termsAndConditionURL] - Terms and conditions URL
+   * @param {boolean} [params.ageGatedContent] - Age gated content flag
+   * @param {string} [params.optInKeywords] - Opt-in keywords
    * @returns {Promise<Object>} Created campaign details
    */
   async create({
-    companyName,
-    phoneNumber,
-    description,
-    messageFlow,
-    helpMessage,
-    optInKeywords,
-    optOutKeywords,
+    name,
+    campaignDescription,
+    address1,
+    address2,
+    city,
+    state,
+    zip,
+    pocFirstName,
+    pocLastName,
+    pocPhoneNumber,
+    pocEmail,
+    businessName,
     website,
+    messageVolume,
+    optInWorkflow,
+    optInWorkflowUrls,
+    phoneNumbers,
+    productionMessageExample,
+    useCase,
+    useCaseDescription,
+    webhookUrl,
+    businessRegistrationNumber,
+    businessRegistrationType,
+    businessRegistrationCountry,
+    doingBusinessAs,
+    entityType,
+    optInConfirmationResponse,
+    helpMessageResponse,
+    privacyPolicyURL,
+    termsAndConditionURL,
+    ageGatedContent,
+    optInKeywords,
   }) {
     this.sdk.validateParams(
-      { companyName, phoneNumber, description, messageFlow },
+      { name },
       {
-        companyName: { type: 'string', required: true },
-        phoneNumber: { type: 'string', required: true },
-        description: { type: 'string', required: true },
-        messageFlow: { type: 'string', required: true },
-        helpMessage: { type: 'string', required: false },
-        optInKeywords: { type: 'array', required: false },
-        optOutKeywords: { type: 'array', required: false },
-        website: { type: 'string', required: false },
+        name: { type: 'string', required: true },
       },
     );
 
-    const campaignData = {
-      companyName,
-      phoneNumber,
-      description,
-      messageFlow,
-    };
-
-    if (helpMessage) campaignData.helpMessage = helpMessage;
-    if (optInKeywords) campaignData.optInKeywords = optInKeywords;
-    if (optOutKeywords) campaignData.optOutKeywords = optOutKeywords;
-    if (website) campaignData.website = website;
+    const campaignData = { name };
 
-    const options = {
-      body: campaignData,
-    };
+    if (campaignDescription !== undefined)
+      campaignData.campaignDescription = campaignDescription;
+    if (address1 !== undefined) campaignData.address1 = address1;
+    if (address2 !== undefined) campaignData.address2 = address2;
+    if (city !== undefined) campaignData.city = city;
+    if (state !== undefined) campaignData.state = state;
+    if (zip !== undefined) campaignData.zip = zip;
+    if (pocFirstName !== undefined) campaignData.pocFirstName = pocFirstName;
+    if (pocLastName !== undefined) campaignData.pocLastName = pocLastName;
+    if (pocPhoneNumber !== undefined)
+      campaignData.pocPhoneNumber = pocPhoneNumber;
+    if (pocEmail !== undefined) campaignData.pocEmail = pocEmail;
+    if (businessName !== undefined) campaignData.businessName = businessName;
+    if (website !== undefined) campaignData.website = website;
+    if (messageVolume !== undefined) campaignData.messageVolume = messageVolume;
+    if (optInWorkflow !== undefined) campaignData.optInWorkflow = optInWorkflow;
+    if (optInWorkflowUrls !== undefined)
+      campaignData.optInWorkflowUrls = optInWorkflowUrls;
+    if (phoneNumbers !== undefined) campaignData.phoneNumbers = phoneNumbers;
+    if (productionMessageExample !== undefined)
+      campaignData.productionMessageExample = productionMessageExample;
+    if (useCase !== undefined) campaignData.useCase = useCase;
+    if (useCaseDescription !== undefined)
+      campaignData.useCaseDescription = useCaseDescription;
+    if (webhookUrl !== undefined) campaignData.webhookUrl = webhookUrl;
+    if (businessRegistrationNumber !== undefined)
+      campaignData.businessRegistrationNumber = businessRegistrationNumber;
+    if (businessRegistrationType !== undefined)
+      campaignData.businessRegistrationType = businessRegistrationType;
+    if (businessRegistrationCountry !== undefined)
+      campaignData.businessRegistrationCountry = businessRegistrationCountry;
+    if (doingBusinessAs !== undefined)
+      campaignData.doingBusinessAs = doingBusinessAs;
+    if (entityType !== undefined) campaignData.entityType = entityType;
+    if (optInConfirmationResponse !== undefined)
+      campaignData.optInConfirmationResponse = optInConfirmationResponse;
+    if (helpMessageResponse !== undefined)
+      campaignData.helpMessageResponse = helpMessageResponse;
+    if (privacyPolicyURL !== undefined)
+      campaignData.privacyPolicyURL = privacyPolicyURL;
+    if (termsAndConditionURL !== undefined)
+      campaignData.termsAndConditionURL = termsAndConditionURL;
+    if (ageGatedContent !== undefined)
+      campaignData.ageGatedContent = ageGatedContent;
+    if (optInKeywords !== undefined) campaignData.optInKeywords = optInKeywords;
 
     const result = await this.sdk._fetch(
       '/messaging/campaigns/tollfree',
       'POST',
-      options,
+      { body: campaignData },
     );
     return result;
   }
@@ -88,27 +161,6 @@ export class TollFreeCampaignsService {
    * Update toll-free campaign
    * @param {string} campaignId - Campaign ID to update
    * @param {Object} params - Update parameters
-   * @param {string} [params.name] - Campaign name
-   * @param {string} [params.campaignDescription] - Campaign description
-   * @param {string} [params.address1] - Business address line 1
-   * @param {string} [params.address2] - Business address line 2
-   * @param {string} [params.city] - Business city
-   * @param {string} [params.state] - Business state
-   * @param {string} [params.zip] - Business zip code
-   * @param {string} [params.pocFirstName] - Point of contact first name
-   * @param {string} [params.pocLastName] - Point of contact last name
-   * @param {string} [params.pocPhoneNumber] - Point of contact phone
-   * @param {string} [params.pocEmail] - Point of contact email
-   * @param {string} [params.businessName] - Business name
-   * @param {string} [params.website] - Business website
-   * @param {string} [params.messageVolume] - Expected message volume
-   * @param {string} [params.optInWorkflow] - Opt-in workflow description
-   * @param {Array<string>} [params.optInWorkflowUrls] - Opt-in workflow image URLs
-   * @param {Array<string>} [params.phoneNumbers] - Phone numbers for campaign
-   * @param {string} [params.productionMessageExample] - Production message example
-   * @param {string} [params.useCase] - Use case category
-   * @param {string} [params.useCaseDescription] - Use case description
-   * @param {string} [params.webhookUrl] - Webhook URL
    * @returns {Promise<Object>} Updated campaign information
    */
   async update(
@@ -135,56 +187,23 @@ export class TollFreeCampaignsService {
       useCase,
       useCaseDescription,
       webhookUrl,
+      businessRegistrationNumber,
+      businessRegistrationType,
+      businessRegistrationCountry,
+      doingBusinessAs,
+      entityType,
+      optInConfirmationResponse,
+      helpMessageResponse,
+      privacyPolicyURL,
+      termsAndConditionURL,
+      ageGatedContent,
+      optInKeywords,
     } = {},
   ) {
     this.sdk.validateParams(
-      {
-        campaignId,
-        name,
-        campaignDescription,
-        address1,
-        address2,
-        city,
-        state,
-        zip,
-        pocFirstName,
-        pocLastName,
-        pocPhoneNumber,
-        pocEmail,
-        businessName,
-        website,
-        messageVolume,
-        optInWorkflow,
-        optInWorkflowUrls,
-        phoneNumbers,
-        productionMessageExample,
-        useCase,
-        useCaseDescription,
-        webhookUrl,
-      },
+      { campaignId },
       {
         campaignId: { type: 'string', required: true },
-        name: { type: 'string', required: false },
-        campaignDescription: { type: 'string', required: false },
-        address1: { type: 'string', required: false },
-        address2: { type: 'string', required: false },
-        city: { type: 'string', required: false },
-        state: { type: 'string', required: false },
-        zip: { type: 'string', required: false },
-        pocFirstName: { type: 'string', required: false },
-        pocLastName: { type: 'string', required: false },
-        pocPhoneNumber: { type: 'string', required: false },
-        pocEmail: { type: 'string', required: false },
-        businessName: { type: 'string', required: false },
-        website: { type: 'string', required: false },
-        messageVolume: { type: 'string', required: false },
-        optInWorkflow: { type: 'string', required: false },
-        optInWorkflowUrls: { type: 'array', required: false },
-        phoneNumbers: { type: 'array', required: false },
-        productionMessageExample: { type: 'string', required: false },
-        useCase: { type: 'string', required: false },
-        useCaseDescription: { type: 'string', required: false },
-        webhookUrl: { type: 'string', required: false },
       },
     );
 
@@ -215,15 +234,31 @@ export class TollFreeCampaignsService {
     if (useCaseDescription !== undefined)
       updateData.useCaseDescription = useCaseDescription;
     if (webhookUrl !== undefined) updateData.webhookUrl = webhookUrl;
-
-    const options = {
-      body: updateData,
-    };
+    if (businessRegistrationNumber !== undefined)
+      updateData.businessRegistrationNumber = businessRegistrationNumber;
+    if (businessRegistrationType !== undefined)
+      updateData.businessRegistrationType = businessRegistrationType;
+    if (businessRegistrationCountry !== undefined)
+      updateData.businessRegistrationCountry = businessRegistrationCountry;
+    if (doingBusinessAs !== undefined)
+      updateData.doingBusinessAs = doingBusinessAs;
+    if (entityType !== undefined) updateData.entityType = entityType;
+    if (optInConfirmationResponse !== undefined)
+      updateData.optInConfirmationResponse = optInConfirmationResponse;
+    if (helpMessageResponse !== undefined)
+      updateData.helpMessageResponse = helpMessageResponse;
+    if (privacyPolicyURL !== undefined)
+      updateData.privacyPolicyURL = privacyPolicyURL;
+    if (termsAndConditionURL !== undefined)
+      updateData.termsAndConditionURL = termsAndConditionURL;
+    if (ageGatedContent !== undefined)
+      updateData.ageGatedContent = ageGatedContent;
+    if (optInKeywords !== undefined) updateData.optInKeywords = optInKeywords;
 
     const result = await this.sdk._fetch(
       `/messaging/campaigns/tollfree/${campaignId}`,
       'PUT',
-      options,
+      { body: updateData },
     );
     return result;
   }
@@ -250,7 +285,7 @@ export class TollFreeCampaignsService {
    * @param {number} [params.limit=50] - Items per page
    * @param {string} [params.name] - Filter by campaign name
    * @param {string} [params.status] - Filter by status
-   * @param {string} [params.operatorType='contains'] - Filter operator: contains, equals, startsWith, endsWith
+   * @param {string} [params.operatorType='contains'] - Filter operator
    * @returns {Promise<Array>} List of campaigns
    */
   async list({ page, limit, name, status, operatorType } = {}) {
@@ -285,6 +320,124 @@ export class TollFreeCampaignsService {
     return result;
   }
 
+  /**
+   * Submit a draft toll-free campaign for verification
+   * @param {string} campaignId - Campaign ID to submit
+   * @param {Object} params - Submit parameters
+   * @param {boolean} params.termsAndConditions - Must be true to accept T&C
+   * @returns {Promise<Object>} Submission result
+   */
+  async submit(campaignId, { termsAndConditions } = {}) {
+    this.sdk.validateParams(
+      { campaignId, termsAndConditions },
+      {
+        campaignId: { type: 'string', required: true },
+        termsAndConditions: { type: 'boolean', required: true },
+      },
+    );
+
+    const result = await this.sdk._fetch(
+      `/messaging/campaigns/tollfree/${campaignId}/submit`,
+      'POST',
+      { body: { termsAndConditions } },
+    );
+    return result;
+  }
+
+  /**
+   * Duplicate an existing campaign as a new Draft
+   * @param {string} campaignId - Source campaign ID
+   * @param {Object} [params] - Optional parameters
+   * @param {string} [params.name] - Name for the new campaign
+   * @returns {Promise<Object>} New draft campaign details
+   */
+  async duplicate(campaignId, { name } = {}) {
+    this.sdk.validateParams(
+      { campaignId },
+      {
+        campaignId: { type: 'string', required: true },
+      },
+    );
+
+    const body = {};
+    if (name !== undefined) body.name = name;
+
+    const result = await this.sdk._fetch(
+      `/messaging/campaigns/tollfree/${campaignId}/duplicate`,
+      'POST',
+      { body },
+    );
+    return result;
+  }
+
+  /**
+   * List phone numbers assigned to a campaign
+   * @param {string} campaignId - Campaign ID
+   * @returns {Promise<Array>} List of phone numbers
+   */
+  async listPhoneNumbers(campaignId) {
+    this.sdk.validateParams(
+      { campaignId },
+      {
+        campaignId: { type: 'string', required: true },
+      },
+    );
+
+    const result = await this.sdk._fetch(
+      `/messaging/campaigns/tollfree/${campaignId}/phoneNumbers`,
+      'GET',
+    );
+    return result;
+  }
+
+  /**
+   * Add phone number to campaign
+   * @param {string} campaignId - Campaign ID
+   * @param {Object} params - Phone number data
+   * @param {string} params.phoneNumber - Phone number to add
+   * @returns {Promise<Object>} Result
+   */
+  async addPhoneNumber(campaignId, { phoneNumber }) {
+    this.sdk.validateParams(
+      { campaignId, phoneNumber },
+      {
+        campaignId: { type: 'string', required: true },
+        phoneNumber: { type: 'string', required: true },
+      },
+    );
+
+    const result = await this.sdk._fetch(
+      `/messaging/campaigns/tollfree/${campaignId}/phoneNumber`,
+      'POST',
+      { body: { phoneNumber } },
+    );
+    return result;
+  }
+
+  /**
+   * Remove phone number from campaign
+   * @param {string} campaignId - Campaign ID
+   * @param {Object} params - Phone number data
+   * @param {string} params.phoneNumber - Phone number to remove
+   * @returns {Promise<Object>} Result
+   */
+  async removePhoneNumber(campaignId, { phoneNumber }) {
+    this.sdk.validateParams(
+      { campaignId, phoneNumber },
+      {
+        campaignId: { type: 'string', required: true },
+        phoneNumber: { type: 'string', required: true },
+      },
+    );
+
+    const result = await this.sdk._fetch(
+      `/messaging/campaigns/tollfree/${campaignId}/phoneNumber`,
+      'DELETE',
+      { body: { phoneNumber } },
+    );
+    return result;
+  }
+
   async getPhoneNumberCampaignStatus(phoneNumber) {
     this.sdk.validateParams(
       { phoneNumber },

package/services/notes.js

@@ -37,6 +37,7 @@ export class NotesService {
     content_binary,
     content_json,
     version,
+    isPublic,
   }) {
     this.sdk.validateParams(
       {
@@ -47,6 +48,7 @@ export class NotesService {
         content_binary,
         content_json,
         version,
+        isPublic,
       },
       {
         title: { type: 'string', required: false },
@@ -56,6 +58,7 @@ export class NotesService {
         content_binary: { type: 'array', required: false },
         content_json: { type: 'object', required: false },
         version: { type: 'number', required: false },
+        isPublic: { type: 'boolean', required: false },
       },
     );
 
@@ -68,6 +71,7 @@ export class NotesService {
         content_binary,
         content_json,
         version,
+        isPublic,
       },
     };
 
@@ -77,10 +81,10 @@ export class NotesService {
 
   async update(
     noteId,
-    { title, content_html, content_binary, content_json, version },
+    { title, content_html, content_binary, content_json, version, isPublic },
   ) {
     this.sdk.validateParams(
-      { noteId, title, content_html, content_binary, content_json, version },
+      { noteId, title, content_html, content_binary, content_json, version, isPublic },
       {
         noteId: { type: 'string', required: true },
         title: { type: 'string', required: false },
@@ -88,6 +92,7 @@ export class NotesService {
         content_binary: { type: 'array', required: false },
         content_json: { type: 'object', required: false },
         version: { type: 'number', required: false },
+        isPublic: { type: 'boolean', required: false },
       },
     );
 
@@ -98,6 +103,7 @@ export class NotesService {
         content_binary,
         content_json,
         version,
+        isPublic,
       },
     };
 
@@ -128,4 +134,23 @@ export class NotesService {
     const result = await this.sdk._fetch(`/notes/${noteId}`, 'GET');
     return result;
   }
+
+  async search({ query, relatedId, limit, isPublic }) {
+    this.sdk.validateParams(
+      { query, relatedId, limit, isPublic },
+      {
+        query: { type: 'string', required: true },
+        relatedId: { type: 'string', required: false },
+        limit: { type: 'number', required: false },
+        isPublic: { type: 'boolean', required: false },
+      },
+    );
+
+    const params = {
+      body: { query, relatedId, limit, isPublic },
+    };
+
+    const result = await this.sdk._fetch('/notes/search', 'POST', params);
+    return result;
+  }
 }

package/services/objects.js

@@ -45,9 +45,13 @@ export class ObjectsService {
       }
     } else if (typeof arg1 === 'object') {
       id = arg1.id;
-      query = { ...arg1 };
-      if (query.id) {
-        delete query.id;
+      if (arg1.query) {
+        query = { ...arg1.query };
+      } else {
+        query = { ...arg1 };
+        if (query.id) {
+          delete query.id;
+        }
       }
     }
 
@@ -63,7 +67,9 @@ export class ObjectsService {
     );
 
     const params = { query };
+
     const result = await this.sdk._fetch(`/object/${id}`, 'GET', params);
+    // console.log(`sdk.objects.byId :: params :: `, params, result);
     return result;
   }
 
@@ -97,6 +103,7 @@ export class ObjectsService {
         previousId = null,
         orderByDirection = 'DESC',
         expandDetails = false,
+        meta = {},
       } = args[0];
 
       this.sdk.validateParams(
@@ -109,6 +116,7 @@ export class ObjectsService {
           previousId,
           orderByDirection,
           expandDetails,
+          meta,
         },
         {
           object: { type: 'string', required: true },
@@ -119,6 +127,7 @@ export class ObjectsService {
           previousId: { type: 'string', required: false },
           orderByDirection: { type: 'string', required: false },
           expandDetails: { type: 'boolean', required: false },
+          meta: { type: 'object', required: false },
         },
       );
 
@@ -157,6 +166,31 @@ export class ObjectsService {
     throw new Error('Invalid arguments for query method');
   }
 
+  /**
+   * Query objects using UOQL v2 (SQL-like syntax).
+   *
+   * Usage:
+   * sdk.objects.queryV2({ query: "SELECT firstName, lastName FROM people WHERE companyId = '123' LIMIT 10" })
+   *
+   * @param {object} args
+   * @param {string} args.query - UOQL query string
+   * @param {boolean} [args.expandDetails=false] - Whether to expand related details
+   * @returns {Promise} Query results with pagination
+   */
+  async queryV2({ query, expandDetails = false, isPublic = false }) {
+    this.sdk.validateParams(
+      { query },
+      {
+        query: { type: 'string', required: true },
+      },
+    );
+
+    const body = { query, expandDetails };
+    if (isPublic) body.isPublic = isPublic;
+    const params = { body };
+    return await this.sdk._fetch('/object/query/v2', 'POST', params);
+  }
+
   /**
    * Update an object record by ID
    *
@@ -328,6 +362,14 @@ export class ObjectsService {
     return result;
   }
 
+  async botSchema() {
+    const result = await this.sdk._fetch(
+      '/object/manage/bot-schema',
+      'GET',
+    );
+    return result;
+  }
+
   async describe(object) {
     this.sdk.validateParams(
       { object },
@@ -775,6 +817,37 @@ export class ObjectsService {
     return result;
   }
 
+  async modifyObject({
+    objectName,
+    isBotAccessible = null,
+    isPublicBot = null,
+    description = null,
+  }) {
+    this.sdk.validateParams(
+      { objectName, isBotAccessible, isPublicBot, description },
+      {
+        objectName: { type: 'string', required: true },
+        isBotAccessible: { type: 'boolean', required: false },
+        isPublicBot: { type: 'boolean', required: false },
+        description: { type: 'string', required: false },
+      },
+    );
+
+    const body = {};
+    if (isBotAccessible !== null) body.isBotAccessible = isBotAccessible;
+    if (isPublicBot !== null) body.isPublicBot = isPublicBot;
+    if (description !== null) body.description = description;
+
+    const params = { body };
+
+    const result = await this.sdk._fetch(
+      `/object/manage/${objectName}`,
+      'PUT',
+      params,
+    );
+    return result;
+  }
+
   async modifyColumn({
     objectName,
     columnName,
@@ -783,6 +856,10 @@ export class ObjectsService {
     defaultValue = null,
     isEncrypted = null,
     isRequired = null,
+    isBotAccessible = null,
+    isPublicBot = null,
+    isStandard = null,
+    description = null,
   }) {
     this.sdk.validateParams(
       {
@@ -793,6 +870,10 @@ export class ObjectsService {
         defaultValue,
         isEncrypted,
         isRequired,
+        isBotAccessible,
+        isPublicBot,
+        isStandard,
+        description,
       },
       {
         objectName: { type: 'string', required: true },
@@ -802,6 +883,10 @@ export class ObjectsService {
         defaultValue: { type: 'string', required: false },
         isEncrypted: { type: 'boolean', required: false },
         isRequired: { type: 'boolean', required: false },
+        isBotAccessible: { type: 'boolean', required: false },
+        isPublicBot: { type: 'boolean', required: false },
+        isStandard: { type: 'boolean', required: false },
+        description: { type: 'string', required: false },
       },
     );
 
@@ -811,6 +896,10 @@ export class ObjectsService {
     if (defaultValue !== null) body.defaultValue = defaultValue;
     if (isEncrypted !== null) body.isEncrypted = isEncrypted;
     if (isRequired !== null) body.isRequired = isRequired;
+    if (isBotAccessible !== null) body.isBotAccessible = isBotAccessible;
+    if (isPublicBot !== null) body.isPublicBot = isPublicBot;
+    if (isStandard !== null) body.isStandard = isStandard;
+    if (description !== null) body.description = description;
 
     const params = { body };