@signalhouse-sms/sdk 1.5.1 → 1.6.0

package/README.md

@@ -51,7 +51,7 @@ Integrated Axios with standardized returns
 Lightweight and tree-shakeable
 
 Documentation
-For full API reference and advanced usage, visit https://v2.signalhouse.io
+For full API reference and advanced usage, visit https://app2.signalhouse.io/docs
 
 License
 ISC © Signal House

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signalhouse-sms/sdk",
-  "version": "1.5.1",
+  "version": "1.6.0",
   "description": "Signal House SDK for use with the Signal House platform",
   "type": "module",
   "main": "src/SignalHouseSDK.js",

package/src/domains/Agents.js

@@ -91,6 +91,22 @@
  * @property {string} updatedAt - Last-update timestamp.
  */
 
+/**
+ * A paused agent conversation: a person took over the conversation between an agent's number and
+ * one contact, so the agent does not answer that contact on that number until someone resumes it. As returned
+ * by the server.
+ * @typedef {Object} AgentContactPause
+ * @property {string} groupId - The group that owns the agent's number.
+ * @property {string|null} subgroupId - The number's subgroup.
+ * @property {string} channel - The channel; "sms".
+ * @property {string} endpointValue - The agent's number: digits only, country code included, no "+".
+ * @property {string} contactIdentifier - The contact's number: digits only, country code included, no "+".
+ * @property {string} reason - Why it was paused: "human_reply" (a person replied by hand), "escalation" (the agent asked for a person) or "manual".
+ * @property {string|null} pausedBy - The user who paused it, when known.
+ * @property {string} createdAt - When the conversation was paused.
+ * @property {string} updatedAt - Last-update timestamp.
+ */
+
 /**
  * A reply an SMS agent wrote but did not send, held for a person to approve or reject (the
  * Pending Replies queue), as returned by the server.
@@ -106,7 +122,7 @@
  * @property {string} inboundText - The contact message the agent was answering.
  * @property {string} draftText - The reply as the agent wrote it.
  * @property {string|null} sentText - The text actually sent; differs from draftText when edited.
- * @property {string} reason - Why it was held: "review_mode", "escalation", "fallback" or "guardrail".
+ * @property {string} reason - Why it was held: "review_mode", "escalation", "fallback" or "guardrail", or "autopilot" for a confident auto-pilot reply that its channel delivers without a person.
  * @property {string} status - "pending", "sending", "sent", "rejected" or "failed" (the send path accepted nothing, e.g. the contact opted out).
  * @property {string|null} decidedBy - The user who approved or rejected it.
  * @property {string|null} decidedAt - When it was approved or rejected.
@@ -586,6 +602,70 @@ export class Agents {
 		return this.client(`/agent/endpoints/${safeChannel}/${safeEndpointValue}`, { method: "DELETE", ...options });
 	}
 
+	/**
+	 * List paused agent conversations in a group, newest first. A paused conversation is one a person took
+	 * over; the agent stays out of it until it is resumed.
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for listing paused conversations.
+	 * @param {string} params.groupId - The group whose paused conversations to list (required).
+	 * @param {string} [params.subgroupId] - Narrow to one subgroup.
+	 * @param {string} [params.channel] - Narrow to one channel ("sms").
+	 * @param {string} [params.endpointValue] - Narrow to one agent number (digits only, no "+").
+	 * @param {string} [params.contactIdentifier] - Narrow to one contact number (digits only, no "+").
+	 * @param {RequestOptions} [params.options] - Additional options for the request.
+	 * @throws {Error} Throws an error if the groupId parameter is missing.
+	 * @returns {Promise<SdkResponse<AgentContactPause[]>>} - The paused conversations returned from the server.
+	 */
+	async getAgentContactPauses({ groupId, subgroupId, channel, endpointValue, contactIdentifier, options = {} }) {
+		this.client._require({ groupId });
+		const queryString = this.client._getQueryString({ groupId, subgroupId, channel, endpointValue, contactIdentifier });
+		return this.client(`/agent/pauses${queryString}`, { method: "GET", ...options });
+	}
+
+	/**
+	 * Pause an agent on one conversation (its number + one contact). The agent stops answering that contact
+	 * on that number until the conversation is resumed; there is no timer. The conversation's pending
+	 * replies are rejected. Pausing a paused conversation keeps the original pause.
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for the pause.
+	 * @param {string} params.channel - The channel; must be "sms".
+	 * @param {string} params.endpointValue - The agent's number: 10 to 15 digits, country code included, no "+".
+	 * @param {string} params.contactIdentifier - The contact's number: 10 to 15 digits, country code included, no "+".
+	 * @param {Object} [params.pauseData] - `{ reason? }`: "human_reply" or "manual" (the default).
+	 * @param {RequestOptions} [params.options] - Additional options for the request.
+	 * @throws {Error} Throws an error if channel, endpointValue, or contactIdentifier is missing.
+	 * @returns {Promise<SdkResponse<AgentContactPause>>} - The pause returned from the server.
+	 */
+	async pauseAgentConversation({ channel, endpointValue, contactIdentifier, pauseData = {}, options = {} }) {
+		this.client._require({ channel, endpointValue, contactIdentifier });
+		const safeChannel = encodeURIComponent(channel);
+		const safeEndpointValue = encodeURIComponent(endpointValue);
+		const safeContactIdentifier = encodeURIComponent(contactIdentifier);
+		return this.client(`/agent/pauses/${safeChannel}/${safeEndpointValue}/${safeContactIdentifier}`, { method: "PUT", body: pauseData, ...options });
+	}
+
+	/**
+	 * Resume an agent on a paused conversation, so it answers the contact's next text again.
+	 * @async
+	 * @roles api, admin, developer, billing, user
+	 * @param {Object} params - The parameters for the resume.
+	 * @param {string} params.channel - The channel; must be "sms".
+	 * @param {string} params.endpointValue - The agent's number: 10 to 15 digits, country code included, no "+".
+	 * @param {string} params.contactIdentifier - The contact's number: 10 to 15 digits, country code included, no "+".
+	 * @param {RequestOptions} [params.options] - Additional options for the request.
+	 * @throws {Error} Throws an error if channel, endpointValue, or contactIdentifier is missing.
+	 * @returns {Promise<SdkResponse<AgentContactPause>>} - The removed pause returned from the server.
+	 */
+	async resumeAgentConversation({ channel, endpointValue, contactIdentifier, options = {} }) {
+		this.client._require({ channel, endpointValue, contactIdentifier });
+		const safeChannel = encodeURIComponent(channel);
+		const safeEndpointValue = encodeURIComponent(endpointValue);
+		const safeContactIdentifier = encodeURIComponent(contactIdentifier);
+		return this.client(`/agent/pauses/${safeChannel}/${safeEndpointValue}/${safeContactIdentifier}`, { method: "DELETE", ...options });
+	}
+
 	/**
 	 * List held agent replies (the Pending Replies queue) in a group, newest first.
 	 * @async

package/src/domains/Brands.js

@@ -70,14 +70,15 @@
 
 /**
  * @typedef {Object} TollFreeBrandDetails
- * @property {string} businessRegistrationType - The business registration type (required, one of EIN, CBN, NEQ, PROVINCIAL_NUMBER, CRN, VAT, ACN, ABN, BRN, SIREN, SIRET, NZBN, UST_IDNR, CIF, NIF, CNPJ, UID, OTHER)
+ * @property {string} [businessRegistrationType] - The business registration type (required unless businessVerificationId is sent, one of EIN, CBN, NEQ, PROVINCIAL_NUMBER, CRN, VAT, ACN, ABN, BRN, SIREN, SIRET, NZBN, UST_IDNR, CIF, NIF, CNPJ, UID, OTHER)
  * @property {string} legalEntityType - The legal entity type (required, one of PRIVATE_COMPANY, PUBLIC_COMPANY, NON_PROFIT, GOVERNMENT, SOLE_PROPRIETOR)
- * @property {string} taxId - The business tax identifier (required, at most 50 characters)
- * @property {string} countryCode - The business country code (required, 2-letter ISO code)
+ * @property {string} [taxId] - The business tax identifier (required unless businessVerificationId is sent, at most 50 characters)
+ * @property {string} [countryCode] - The business country code (required unless businessVerificationId is sent, 2-letter ISO code)
  * @property {string} supportPhone - The customer-support phone number (required, E.164 with an optional leading "+" and no spaces, parentheses or hyphens, e.g. "17025550100")
  * @property {string} [taxIdIssuingCountry] - The country that issued the tax ID (optional, 2-letter ISO code)
  * @property {string} [businessDBA] - The business "doing business as" name (optional, at most 255 characters)
  * @property {string} [businessWebsite] - The customer's real website, sent to Infobip for brand verification (optional, valid URL, at most 255 characters; distinct from the top-level website / landing URL)
+ * @property {string} [businessVerificationId] - The ID of the business verification the brand uses (starts with BV). Required for a group whose toll-free brands need a business verification, and must name a VERIFIED one of the brand's group (in a group that verifies each subgroup's business separately, of the brand's subgroup); refused (400) for any other group. Set at creation only: it can't be changed
  */
 
 /**
@@ -103,6 +104,18 @@
  * @property {string} representative.jobLevel - The representative's job level (required, one of DIRECTOR, GM, VP, CEO, CFO, GENERAL_COUNSEL, OTHER)
  */
 
+/**
+ * @typedef {Object} BusinessVerification
+ * @property {string} businessVerificationId - The business verification's ID (starts with BV)
+ * @property {string} groupId - The group it belongs to
+ * @property {string} [subgroupId] - The subgroup whose business it verifies; present only in a group that verifies each subgroup's business separately
+ * @property {string} status - SUBMITTING, IN_REVIEW, VERIFIED or NEEDS_CHANGES
+ * @property {BusinessVerificationDetails} details - The submitted details
+ * @property {string} submittedAt - When it was last submitted (ISO date)
+ * @property {string|null} reviewedAt - When it was last reviewed (ISO date), or null
+ * @property {string|null} rejectionReason - Why it needs changes, or null
+ */
+
 /**
  * @typedef {Object} TollFreeIsvAccount
  * @property {string} groupId - The group the account is registered to
@@ -114,17 +127,20 @@
  */
 
 /**
+ * Toll-free brand data. When tollFree.businessVerificationId is sent, the legal fields (companyName, street, city, state,
+ * postalCode, country, firstName, lastName and tollFree's businessRegistrationType, taxId, countryCode and
+ * taxIdIssuingCountry) are optional: the business verification's values replace any that are sent.
  * @typedef {Object} CreateTollFreeBrandData
  * @property {string} subgroupId - The ID of the subgroup to create the brand under (required, exactly 8 characters)
  * @property {string} displayName - The display name for the brand (required, at most 255 characters)
- * @property {string} companyName - The company name for the brand (required, at most 255 characters)
- * @property {string} street - The street address of the primary contact for the brand (required, at most 255 characters)
- * @property {string} city - The city of the primary contact for the brand (required, at most 100 characters)
- * @property {string} state - The state of the primary contact for the brand (required, at most 20 characters; must be a valid 2-letter US state code when country is "US")
- * @property {string} postalCode - The postal code of the primary contact for the brand (required, at most 10 characters)
+ * @property {string} [companyName] - The company name for the brand (required unless tollFree.businessVerificationId is sent, at most 255 characters)
+ * @property {string} [street] - The street address of the primary contact for the brand (required unless tollFree.businessVerificationId is sent, at most 255 characters)
+ * @property {string} [city] - The city of the primary contact for the brand (required unless tollFree.businessVerificationId is sent, at most 100 characters)
+ * @property {string} [state] - The state of the primary contact for the brand (required unless tollFree.businessVerificationId is sent, at most 20 characters; must be a valid 2-letter US state code when country is "US")
+ * @property {string} [postalCode] - The postal code of the primary contact for the brand (required unless tollFree.businessVerificationId is sent, at most 10 characters)
  * @property {string} email - The email address of the primary contact for the brand (required, valid email, at most 100 characters)
- * @property {string} firstName - The first name of the primary contact for the brand (required, at most 100 characters)
- * @property {string} lastName - The last name of the primary contact for the brand (required, at most 100 characters)
+ * @property {string} [firstName] - The first name of the primary contact for the brand (required unless tollFree.businessVerificationId is sent, at most 100 characters)
+ * @property {string} [lastName] - The last name of the primary contact for the brand (required unless tollFree.businessVerificationId is sent, at most 100 characters)
  * @property {string} website - The website URL for the brand (required, valid URL, at most 255 characters)
  * @property {TollFreeBrandDetails} tollFree - The Toll-Free brand details (required)
  * @property {string} [referenceId] - A unique reference for the brand (optional, at most 50 characters)
@@ -187,7 +203,7 @@ export class Brands {
    * @param {boolean} [params.excludeDeleted] - Staff-only: hide DELETED brands when no status is given
    * @param {boolean} [params.includeTotal] - Staff-only: with page and limit, return `{ data, total, page, limit, totalPages }` instead of the array
    * @param {RequestOptions} [params.options] - Additional options for the request
-   * @returns {Promise<SdkResponse<Array<{ _id: string, brandId: string|null, status: string, registrationType: string, tollFree?: { isBrandReady?: boolean, maxNumbersPerCampaign?: number, maxOptInMethods?: number, requiresPrivacyPolicy?: boolean, requiresTermsAndConditions?: boolean, maxAppealReasonLength?: number, labelsSamples?: boolean, supportsMms?: boolean, usesBusinessVerification?: boolean, [key: string]: any }, [key: string]: any }>|{ data: Array<Object>, total: number, page: number, limit: number, totalPages: number }>>} Brand records. For 10DLC brands in PENDING_CREATION (or rejected before carrier assignment), brandId is null — poll by _id until status advances and brandId is assigned. Toll-free brands carry `tollFree.isBrandReady` (whether the brand can host campaigns), `tollFree.maxNumbersPerCampaign` (the most numbers one of its campaigns can hold), `tollFree.maxOptInMethods` (the most opt-in methods one of its campaigns can declare), `tollFree.requiresPrivacyPolicy` (whether its campaigns need a privacy policy URL), `tollFree.requiresTermsAndConditions` (whether its campaigns need a terms and conditions URL), `tollFree.maxAppealReasonLength` (the longest appeal reason its campaigns may give), `tollFree.labelsSamples` (whether its campaigns' sample messages each start with their use case's name), `tollFree.supportsMms` (whether its numbers can send MMS and group messages) and `tollFree.usesBusinessVerification` (whether it waits on the business verification that applies to its subgroup). The staff-only list (no id/subgroupId/groupId) returns the `{ data, total, page, limit, totalPages }` envelope only when includeTotal is sent with page and limit.
+   * @returns {Promise<SdkResponse<Array<{ _id: string, brandId: string|null, status: string, registrationType: string, tollFree?: { isBrandReady?: boolean, maxNumbersPerCampaign?: number, maxOptInMethods?: number, requiresPrivacyPolicy?: boolean, requiresTermsAndConditions?: boolean, maxAppealReasonLength?: number, labelsSamples?: boolean, supportsMms?: boolean, usesBusinessVerification?: boolean, businessVerificationId?: string|null, [key: string]: any }, [key: string]: any }>|{ data: Array<Object>, total: number, page: number, limit: number, totalPages: number }>>} Brand records. For 10DLC brands in PENDING_CREATION (or rejected before carrier assignment), brandId is null — poll by _id until status advances and brandId is assigned. Toll-free brands carry `tollFree.isBrandReady` (whether the brand can host campaigns), `tollFree.maxNumbersPerCampaign` (the most numbers one of its campaigns can hold), `tollFree.maxOptInMethods` (the most opt-in methods one of its campaigns can declare), `tollFree.requiresPrivacyPolicy` (whether its campaigns need a privacy policy URL), `tollFree.requiresTermsAndConditions` (whether its campaigns need a terms and conditions URL), `tollFree.maxAppealReasonLength` (the longest appeal reason its campaigns may give), `tollFree.labelsSamples` (whether its campaigns' sample messages each start with their use case's name), `tollFree.supportsMms` (whether its numbers can send MMS and group messages), `tollFree.usesBusinessVerification` (whether it waits on its own business verification) and `tollFree.businessVerificationId` (the ID of the business verification it uses, or null when it uses none). The staff-only list (no id/subgroupId/groupId) returns the `{ data, total, page, limit, totalPages }` envelope only when includeTotal is sent with page and limit. Each brand carries `carrierSuspensions` (carrier brand suspension rules; active while liftedAt is null).
    */
   async getBrands({
     id,
@@ -285,47 +301,81 @@ export class Brands {
   }
 
   /**
-   * Get a group's business verification: whether its toll-free brands need one, its status and the submitted details.
-   * Some groups verify each subgroup's business separately: a platform whose subgroups are separate businesses, set up by
-   * Signal House. For those groups pass the subgroup whose business verification to get.
+   * List a group's business verifications, newest first, and whether its toll-free brands need one. Some groups verify
+   * each subgroup's business separately: a platform whose subgroups are separate businesses, set up by Signal House. For
+   * those groups pass the subgroup whose business verifications to list.
    * @async
    * @roles api, admin, developer, billing, user
-   * @param {Object} params - The parameters for getting the business verification
-   * @param {string} params.groupId - The ID of the group whose business verification to get
-   * @param {string} [params.subgroupId] - The subgroup whose business verification to get, sent as a query parameter only when given. Required for a group that verifies each subgroup's business separately; for any other group it must be one of the group's subgroups and is otherwise ignored
+   * @param {Object} params - The parameters for listing the business verifications
+   * @param {string} params.groupId - The ID of the group whose business verifications to list
+   * @param {string} [params.subgroupId] - The subgroup whose business verifications to list, sent as a query parameter only when given. Required for a group that verifies each subgroup's business separately; for any other group it must be one of the group's subgroups and is otherwise ignored
    * @param {RequestOptions} [params.options] - Additional options for the request
    * @throws {Error} Throws an error if the groupId parameter is missing
-   * @returns {Promise<SdkResponse<{ groupId: string, subgroupId?: string, required: boolean, status: string, details: BusinessVerificationDetails|null, submittedAt: string|null, reviewedAt: string|null, rejectionReason: string|null }>>} The business verification. `subgroupId` is present only when it belongs to one subgroup: the subgroup whose business it describes. `required` says whether the group's new toll-free brands need one; `status` is NOT_STARTED, SUBMITTING, IN_REVIEW, VERIFIED or NEEDS_CHANGES; `rejectionReason` says why it needs changes, or is null. When `required` is true and `status` is NOT_STARTED, submit it before creating the first toll-free brand it covers. The API returns 400 when the group verifies each subgroup's business separately and no subgroupId is given, and 404 when the subgroup is not in the group.
+   * @returns {Promise<SdkResponse<{ groupId: string, subgroupId?: string, required: boolean, businessVerifications: Array<BusinessVerification> }>>} The business verifications, newest first. `subgroupId` is present only when they belong to one subgroup. `required` says whether the group's new toll-free brands need a business verification: each one names a VERIFIED business verification as `tollFree.businessVerificationId`. The API returns 400 when the group verifies each subgroup's business separately and no subgroupId is given, and 404 when the subgroup is not in the group.
    */
-  async getBusinessVerification({ groupId, subgroupId, options = {} }) {
+  async getBusinessVerifications({ groupId, subgroupId, options = {} }) {
     this.client._require({ groupId });
     const queryString = this.client._getQueryString({ subgroupId });
     return this.client(`/brand/business-verification/${encodeURIComponent(groupId)}${queryString}`, { method: 'GET', ...options });
   }
 
   /**
-   * Submit or update a group's business verification, or one subgroup's in a group that verifies each subgroup's business
-   * separately. Allowed when it is not started or needs changes. Review usually takes 1–2 business days; the toll-free
-   * brands it covers stay pending until it is verified.
+   * Get one of a group's business verifications by its ID.
    * @async
    * @roles api, admin, developer, billing, user
-   * @param {Object} params - The parameters for submitting the business verification
-   * @param {string} params.groupId - The ID of the group whose business verification to submit (must be the caller's active group)
-   * @param {string} [params.subgroupId] - The subgroup whose business verification to submit, sent as a query parameter only when given. Required for a group that verifies each subgroup's business separately; for any other group it must be one of the group's subgroups and is otherwise ignored. The subgroup must be active
+   * @param {Object} params - The parameters for getting the business verification
+   * @param {string} params.groupId - The ID of the group the business verification belongs to
+   * @param {string} params.businessVerificationId - The ID of the business verification to get (starts with BV)
+   * @param {RequestOptions} [params.options] - Additional options for the request
+   * @throws {Error} Throws an error if the groupId or businessVerificationId parameter is missing
+   * @returns {Promise<SdkResponse<BusinessVerification & { required: boolean }>>} The business verification, plus `required` (whether the group's new toll-free brands need one). The API returns 404 when it isn't one of the group's.
+   */
+  async getBusinessVerification({ groupId, businessVerificationId, options = {} }) {
+    this.client._require({ groupId, businessVerificationId });
+    return this.client(`/brand/business-verification/${encodeURIComponent(groupId)}/${encodeURIComponent(businessVerificationId)}`, { method: 'GET', ...options });
+  }
+
+  /**
+   * Create and submit a new business verification for a group, or for one subgroup in a group that verifies each
+   * subgroup's business separately. Review usually takes 1–2 business days; once it is VERIFIED, new toll-free brands
+   * can use it by naming it as `tollFree.businessVerificationId`.
+   * @async
+   * @roles api, admin, developer, billing, user
+   * @param {Object} params - The parameters for creating the business verification
+   * @param {string} params.groupId - The ID of the group the business verification is for (must be the caller's active group)
+   * @param {string} [params.subgroupId] - The subgroup whose business it verifies, sent as a query parameter only when given. Required for a group that verifies each subgroup's business separately; for any other group it must be one of the group's subgroups and is otherwise ignored. The subgroup must be active
    * @param {BusinessVerificationDetails} params.details - The business verification details (see BusinessVerificationDetails typedef for details)
    * @param {RequestOptions} [params.options] - Additional options for the request
    * @throws {Error} Throws an error if the groupId or details parameter is missing
-   * @returns {Promise<SdkResponse<{ groupId: string, subgroupId?: string, required: boolean, status: string, details: BusinessVerificationDetails|null, submittedAt: string|null, reviewedAt: string|null, rejectionReason: string|null }>>} A 202 with the business verification, now SUBMITTING (the same shape as getBusinessVerification, with `subgroupId` only when it belongs to one subgroup). The API returns 400 when the group verifies each subgroup's business separately and no subgroupId is given, or when the subgroup is inactive, and 404 when the subgroup is not in the group.
+   * @returns {Promise<SdkResponse<BusinessVerification>>} A 202 with the new business verification, now SUBMITTING. The API returns 400 when the group's toll-free brands don't need a business verification, when the group verifies each subgroup's business separately and no subgroupId is given, or when the subgroup is inactive, and 404 when the subgroup is not in the group.
    */
-  async submitBusinessVerification({ groupId, subgroupId, details, options = {} }) {
+  async createBusinessVerification({ groupId, subgroupId, details, options = {} }) {
     this.client._require({ groupId, details });
     const queryString = this.client._getQueryString({ subgroupId });
-    return this.client(`/brand/business-verification/${encodeURIComponent(groupId)}${queryString}`, { method: 'PUT', body: details, ...options });
+    return this.client(`/brand/business-verification/${encodeURIComponent(groupId)}${queryString}`, { method: 'POST', body: details, ...options });
+  }
+
+  /**
+   * Correct and resubmit a business verification that needs changes. Allowed only while its status is NEEDS_CHANGES.
+   * Review usually takes 1–2 business days; the toll-free brands that use it stay pending until it is verified.
+   * @async
+   * @roles api, admin, developer, billing, user
+   * @param {Object} params - The parameters for updating the business verification
+   * @param {string} params.groupId - The ID of the group the business verification belongs to (must be the caller's active group)
+   * @param {string} params.businessVerificationId - The ID of the business verification to update (starts with BV)
+   * @param {BusinessVerificationDetails} params.details - The corrected business verification details (see BusinessVerificationDetails typedef for details)
+   * @param {RequestOptions} [params.options] - Additional options for the request
+   * @throws {Error} Throws an error if the groupId, businessVerificationId or details parameter is missing
+   * @returns {Promise<SdkResponse<BusinessVerification>>} A 202 with the business verification, now SUBMITTING. The API returns 400 when it doesn't need changes, and 404 when it isn't one of the group's.
+   */
+  async updateBusinessVerification({ groupId, businessVerificationId, details, options = {} }) {
+    this.client._require({ groupId, businessVerificationId, details });
+    return this.client(`/brand/business-verification/${encodeURIComponent(groupId)}/${encodeURIComponent(businessVerificationId)}`, { method: 'PUT', body: details, ...options });
   }
 
   /**
    * Get a group's toll-free ISV account: the group's own top-level account at the toll-free provider, used when its
-   * subgroups are separate businesses. Each subgroup gets an account and a business verification of its own under it.
+   * subgroups are separate businesses. Each subgroup gets an account and business verifications of its own under it.
    * Staff only.
    * @async
    * @roles signalhouse_api, signalhouse_admin, signalhouse_user

package/src/domains/Campaigns.js

@@ -358,6 +358,13 @@ export class Campaigns {
    * in the window; the volumes say how much traffic sits behind it. A campaign's figure is scored from the
    * campaign's own summed counters, never averaged from its numbers. For a live figure use GET /number/health
    * or GET /campaign/health.
+   *
+   * Every record also carries a `carrierSuspensions` array -- one entry per carrier suspension of the
+   * campaign: `{ mnoId, mnoName, source, suspensionCategory, reason, tcrEventType, suspendedAt, liftedAt }`.
+   * An entry is active while `liftedAt` is null. `mnoId` is the TCR carrier network id (same ids as `mnoIds`);
+   * `source` is CARRIER, UPSTREAM or BRAND (the carrier suspended the whole brand). A suspension applies to one
+   * carrier, so `status` stays ACTIVE. Subscribe to the CAMPAIGN_SUSPENDED / CAMPAIGN_UNSUSPENDED webhook events
+   * to be told when an entry opens or is lifted.
    * @returns {Promise<SdkResponse<Array|Object>>} The response from the server - array when unpaginated, or { data, total, page, limit, totalPages } when paginated
    */
   async getCampaigns({

package/src/domains/Numbers.js

@@ -41,14 +41,17 @@ export class Numbers {
          * @roles signalhouse
          * @param {Object} params - The parameters for approving the request
          * @param {string} params.portingId - The _id of the port-in request
+         * @param {string} [params.subGroupId] - Subgroup to assign when the request has none yet.
+         *   Ignored if the request already has a subGroupId -- an existing assignment is never overwritten.
          * @param {RequestOptions} [params.options] - Additional options for the request
          * @returns {Promise<SdkResponse<any>>} A promise that resolves to the updated port-in request
          */
-        approvePortRequest: async ({ portingId, options = {} }) => {
+        approvePortRequest: async ({ portingId, subGroupId, options = {} }) => {
           this.client._require({ portingId });
           const safeId = encodeURIComponent(portingId);
           return this.client(`/number/portin/${safeId}/approve`, {
             method: 'POST',
+            body: { subGroupId },
             ...options,
           });
         },

package/types/domains/Agents.d.ts

@@ -83,6 +83,21 @@
  * @property {string} createdAt - Creation timestamp.
  * @property {string} updatedAt - Last-update timestamp.
  */
+/**
+ * A paused agent conversation: a person took over the conversation between an agent's number and
+ * one contact, so the agent does not answer that contact on that number until someone resumes it. As returned
+ * by the server.
+ * @typedef {Object} AgentContactPause
+ * @property {string} groupId - The group that owns the agent's number.
+ * @property {string|null} subgroupId - The number's subgroup.
+ * @property {string} channel - The channel; "sms".
+ * @property {string} endpointValue - The agent's number: digits only, country code included, no "+".
+ * @property {string} contactIdentifier - The contact's number: digits only, country code included, no "+".
+ * @property {string} reason - Why it was paused: "human_reply" (a person replied by hand), "escalation" (the agent asked for a person) or "manual".
+ * @property {string|null} pausedBy - The user who paused it, when known.
+ * @property {string} createdAt - When the conversation was paused.
+ * @property {string} updatedAt - Last-update timestamp.
+ */
 /**
  * A reply an SMS agent wrote but did not send, held for a person to approve or reject (the
  * Pending Replies queue), as returned by the server.
@@ -98,7 +113,7 @@
  * @property {string} inboundText - The contact message the agent was answering.
  * @property {string} draftText - The reply as the agent wrote it.
  * @property {string|null} sentText - The text actually sent; differs from draftText when edited.
- * @property {string} reason - Why it was held: "review_mode", "escalation", "fallback" or "guardrail".
+ * @property {string} reason - Why it was held: "review_mode", "escalation", "fallback" or "guardrail", or "autopilot" for a confident auto-pilot reply that its channel delivers without a person.
  * @property {string} status - "pending", "sending", "sent", "rejected" or "failed" (the send path accepted nothing, e.g. the contact opted out).
  * @property {string|null} decidedBy - The user who approved or rejected it.
  * @property {string|null} decidedAt - When it was approved or rejected.
@@ -546,6 +561,69 @@ export class Agents {
         endpointValue: string;
         options?: RequestOptions;
     }): Promise<SdkResponse<AgentEndpoint>>;
+    /**
+     * List paused agent conversations in a group, newest first. A paused conversation is one a person took
+     * over; the agent stays out of it until it is resumed.
+     * @async
+     * @roles api, admin, developer, billing, user
+     * @param {Object} params - The parameters for listing paused conversations.
+     * @param {string} params.groupId - The group whose paused conversations to list (required).
+     * @param {string} [params.subgroupId] - Narrow to one subgroup.
+     * @param {string} [params.channel] - Narrow to one channel ("sms").
+     * @param {string} [params.endpointValue] - Narrow to one agent number (digits only, no "+").
+     * @param {string} [params.contactIdentifier] - Narrow to one contact number (digits only, no "+").
+     * @param {RequestOptions} [params.options] - Additional options for the request.
+     * @throws {Error} Throws an error if the groupId parameter is missing.
+     * @returns {Promise<SdkResponse<AgentContactPause[]>>} - The paused conversations returned from the server.
+     */
+    getAgentContactPauses({ groupId, subgroupId, channel, endpointValue, contactIdentifier, options }: {
+        groupId: string;
+        subgroupId?: string;
+        channel?: string;
+        endpointValue?: string;
+        contactIdentifier?: string;
+        options?: RequestOptions;
+    }): Promise<SdkResponse<AgentContactPause[]>>;
+    /**
+     * Pause an agent on one conversation (its number + one contact). The agent stops answering that contact
+     * on that number until the conversation is resumed; there is no timer. The conversation's pending
+     * replies are rejected. Pausing a paused conversation keeps the original pause.
+     * @async
+     * @roles api, admin, developer, billing, user
+     * @param {Object} params - The parameters for the pause.
+     * @param {string} params.channel - The channel; must be "sms".
+     * @param {string} params.endpointValue - The agent's number: 10 to 15 digits, country code included, no "+".
+     * @param {string} params.contactIdentifier - The contact's number: 10 to 15 digits, country code included, no "+".
+     * @param {Object} [params.pauseData] - `{ reason? }`: "human_reply" or "manual" (the default).
+     * @param {RequestOptions} [params.options] - Additional options for the request.
+     * @throws {Error} Throws an error if channel, endpointValue, or contactIdentifier is missing.
+     * @returns {Promise<SdkResponse<AgentContactPause>>} - The pause returned from the server.
+     */
+    pauseAgentConversation({ channel, endpointValue, contactIdentifier, pauseData, options }: {
+        channel: string;
+        endpointValue: string;
+        contactIdentifier: string;
+        pauseData?: any;
+        options?: RequestOptions;
+    }): Promise<SdkResponse<AgentContactPause>>;
+    /**
+     * Resume an agent on a paused conversation, so it answers the contact's next text again.
+     * @async
+     * @roles api, admin, developer, billing, user
+     * @param {Object} params - The parameters for the resume.
+     * @param {string} params.channel - The channel; must be "sms".
+     * @param {string} params.endpointValue - The agent's number: 10 to 15 digits, country code included, no "+".
+     * @param {string} params.contactIdentifier - The contact's number: 10 to 15 digits, country code included, no "+".
+     * @param {RequestOptions} [params.options] - Additional options for the request.
+     * @throws {Error} Throws an error if channel, endpointValue, or contactIdentifier is missing.
+     * @returns {Promise<SdkResponse<AgentContactPause>>} - The removed pause returned from the server.
+     */
+    resumeAgentConversation({ channel, endpointValue, contactIdentifier, options }: {
+        channel: string;
+        endpointValue: string;
+        contactIdentifier: string;
+        options?: RequestOptions;
+    }): Promise<SdkResponse<AgentContactPause>>;
     /**
      * List held agent replies (the Pending Replies queue) in a group, newest first.
      * @async
@@ -1172,6 +1250,49 @@ export type AgentEndpoint = {
      */
     updatedAt: string;
 };
+/**
+ * A paused agent conversation: a person took over the conversation between an agent's number and
+ * one contact, so the agent does not answer that contact on that number until someone resumes it. As returned
+ * by the server.
+ */
+export type AgentContactPause = {
+    /**
+     * - The group that owns the agent's number.
+     */
+    groupId: string;
+    /**
+     * - The number's subgroup.
+     */
+    subgroupId: string | null;
+    /**
+     * - The channel; "sms".
+     */
+    channel: string;
+    /**
+     * - The agent's number: digits only, country code included, no "+".
+     */
+    endpointValue: string;
+    /**
+     * - The contact's number: digits only, country code included, no "+".
+     */
+    contactIdentifier: string;
+    /**
+     * - Why it was paused: "human_reply" (a person replied by hand), "escalation" (the agent asked for a person) or "manual".
+     */
+    reason: string;
+    /**
+     * - The user who paused it, when known.
+     */
+    pausedBy: string | null;
+    /**
+     * - When the conversation was paused.
+     */
+    createdAt: string;
+    /**
+     * - Last-update timestamp.
+     */
+    updatedAt: string;
+};
 /**
  * A reply an SMS agent wrote but did not send, held for a person to approve or reject (the
  * Pending Replies queue), as returned by the server.
@@ -1222,7 +1343,7 @@ export type AgentReplyDraft = {
      */
     sentText: string | null;
     /**
-     * - Why it was held: "review_mode", "escalation", "fallback" or "guardrail".
+     * - Why it was held: "review_mode", "escalation", "fallback" or "guardrail", or "autopilot" for a confident auto-pilot reply that its channel delivers without a person.
      */
     reason: string;
     /**

package/types/domains/Brands.d.ts

@@ -66,14 +66,15 @@
  */
 /**
  * @typedef {Object} TollFreeBrandDetails
- * @property {string} businessRegistrationType - The business registration type (required, one of EIN, CBN, NEQ, PROVINCIAL_NUMBER, CRN, VAT, ACN, ABN, BRN, SIREN, SIRET, NZBN, UST_IDNR, CIF, NIF, CNPJ, UID, OTHER)
+ * @property {string} [businessRegistrationType] - The business registration type (required unless businessVerificationId is sent, one of EIN, CBN, NEQ, PROVINCIAL_NUMBER, CRN, VAT, ACN, ABN, BRN, SIREN, SIRET, NZBN, UST_IDNR, CIF, NIF, CNPJ, UID, OTHER)
  * @property {string} legalEntityType - The legal entity type (required, one of PRIVATE_COMPANY, PUBLIC_COMPANY, NON_PROFIT, GOVERNMENT, SOLE_PROPRIETOR)
- * @property {string} taxId - The business tax identifier (required, at most 50 characters)
- * @property {string} countryCode - The business country code (required, 2-letter ISO code)
+ * @property {string} [taxId] - The business tax identifier (required unless businessVerificationId is sent, at most 50 characters)
+ * @property {string} [countryCode] - The business country code (required unless businessVerificationId is sent, 2-letter ISO code)
  * @property {string} supportPhone - The customer-support phone number (required, E.164 with an optional leading "+" and no spaces, parentheses or hyphens, e.g. "17025550100")
  * @property {string} [taxIdIssuingCountry] - The country that issued the tax ID (optional, 2-letter ISO code)
  * @property {string} [businessDBA] - The business "doing business as" name (optional, at most 255 characters)
  * @property {string} [businessWebsite] - The customer's real website, sent to Infobip for brand verification (optional, valid URL, at most 255 characters; distinct from the top-level website / landing URL)
+ * @property {string} [businessVerificationId] - The ID of the business verification the brand uses (starts with BV). Required for a group whose toll-free brands need a business verification, and must name a VERIFIED one of the brand's group (in a group that verifies each subgroup's business separately, of the brand's subgroup); refused (400) for any other group. Set at creation only: it can't be changed
  */
 /**
  * @typedef {Object} BusinessVerificationDetails
@@ -97,6 +98,17 @@
  * @property {string} representative.jobTitle - The representative's job title (required, at most 100 characters)
  * @property {string} representative.jobLevel - The representative's job level (required, one of DIRECTOR, GM, VP, CEO, CFO, GENERAL_COUNSEL, OTHER)
  */
+/**
+ * @typedef {Object} BusinessVerification
+ * @property {string} businessVerificationId - The business verification's ID (starts with BV)
+ * @property {string} groupId - The group it belongs to
+ * @property {string} [subgroupId] - The subgroup whose business it verifies; present only in a group that verifies each subgroup's business separately
+ * @property {string} status - SUBMITTING, IN_REVIEW, VERIFIED or NEEDS_CHANGES
+ * @property {BusinessVerificationDetails} details - The submitted details
+ * @property {string} submittedAt - When it was last submitted (ISO date)
+ * @property {string|null} reviewedAt - When it was last reviewed (ISO date), or null
+ * @property {string|null} rejectionReason - Why it needs changes, or null
+ */
 /**
  * @typedef {Object} TollFreeIsvAccount
  * @property {string} groupId - The group the account is registered to
@@ -107,17 +119,20 @@
  * @property {string} updatedAt - When the account or its API key was last saved (ISO date)
  */
 /**
+ * Toll-free brand data. When tollFree.businessVerificationId is sent, the legal fields (companyName, street, city, state,
+ * postalCode, country, firstName, lastName and tollFree's businessRegistrationType, taxId, countryCode and
+ * taxIdIssuingCountry) are optional: the business verification's values replace any that are sent.
  * @typedef {Object} CreateTollFreeBrandData
  * @property {string} subgroupId - The ID of the subgroup to create the brand under (required, exactly 8 characters)
  * @property {string} displayName - The display name for the brand (required, at most 255 characters)
- * @property {string} companyName - The company name for the brand (required, at most 255 characters)
- * @property {string} street - The street address of the primary contact for the brand (required, at most 255 characters)
- * @property {string} city - The city of the primary contact for the brand (required, at most 100 characters)
- * @property {string} state - The state of the primary contact for the brand (required, at most 20 characters; must be a valid 2-letter US state code when country is "US")
- * @property {string} postalCode - The postal code of the primary contact for the brand (required, at most 10 characters)
+ * @property {string} [companyName] - The company name for the brand (required unless tollFree.businessVerificationId is sent, at most 255 characters)
+ * @property {string} [street] - The street address of the primary contact for the brand (required unless tollFree.businessVerificationId is sent, at most 255 characters)
+ * @property {string} [city] - The city of the primary contact for the brand (required unless tollFree.businessVerificationId is sent, at most 100 characters)
+ * @property {string} [state] - The state of the primary contact for the brand (required unless tollFree.businessVerificationId is sent, at most 20 characters; must be a valid 2-letter US state code when country is "US")
+ * @property {string} [postalCode] - The postal code of the primary contact for the brand (required unless tollFree.businessVerificationId is sent, at most 10 characters)
  * @property {string} email - The email address of the primary contact for the brand (required, valid email, at most 100 characters)
- * @property {string} firstName - The first name of the primary contact for the brand (required, at most 100 characters)
- * @property {string} lastName - The last name of the primary contact for the brand (required, at most 100 characters)
+ * @property {string} [firstName] - The first name of the primary contact for the brand (required unless tollFree.businessVerificationId is sent, at most 100 characters)
+ * @property {string} [lastName] - The last name of the primary contact for the brand (required unless tollFree.businessVerificationId is sent, at most 100 characters)
  * @property {string} website - The website URL for the brand (required, valid URL, at most 255 characters)
  * @property {TollFreeBrandDetails} tollFree - The Toll-Free brand details (required)
  * @property {string} [referenceId] - A unique reference for the brand (optional, at most 50 characters)
@@ -176,7 +191,7 @@ export class Brands {
      * @param {boolean} [params.excludeDeleted] - Staff-only: hide DELETED brands when no status is given
      * @param {boolean} [params.includeTotal] - Staff-only: with page and limit, return `{ data, total, page, limit, totalPages }` instead of the array
      * @param {RequestOptions} [params.options] - Additional options for the request
-     * @returns {Promise<SdkResponse<Array<{ _id: string, brandId: string|null, status: string, registrationType: string, tollFree?: { isBrandReady?: boolean, maxNumbersPerCampaign?: number, maxOptInMethods?: number, requiresPrivacyPolicy?: boolean, requiresTermsAndConditions?: boolean, maxAppealReasonLength?: number, labelsSamples?: boolean, supportsMms?: boolean, usesBusinessVerification?: boolean, [key: string]: any }, [key: string]: any }>|{ data: Array<Object>, total: number, page: number, limit: number, totalPages: number }>>} Brand records. For 10DLC brands in PENDING_CREATION (or rejected before carrier assignment), brandId is null — poll by _id until status advances and brandId is assigned. Toll-free brands carry `tollFree.isBrandReady` (whether the brand can host campaigns), `tollFree.maxNumbersPerCampaign` (the most numbers one of its campaigns can hold), `tollFree.maxOptInMethods` (the most opt-in methods one of its campaigns can declare), `tollFree.requiresPrivacyPolicy` (whether its campaigns need a privacy policy URL), `tollFree.requiresTermsAndConditions` (whether its campaigns need a terms and conditions URL), `tollFree.maxAppealReasonLength` (the longest appeal reason its campaigns may give), `tollFree.labelsSamples` (whether its campaigns' sample messages each start with their use case's name), `tollFree.supportsMms` (whether its numbers can send MMS and group messages) and `tollFree.usesBusinessVerification` (whether it waits on the business verification that applies to its subgroup). The staff-only list (no id/subgroupId/groupId) returns the `{ data, total, page, limit, totalPages }` envelope only when includeTotal is sent with page and limit.
+     * @returns {Promise<SdkResponse<Array<{ _id: string, brandId: string|null, status: string, registrationType: string, tollFree?: { isBrandReady?: boolean, maxNumbersPerCampaign?: number, maxOptInMethods?: number, requiresPrivacyPolicy?: boolean, requiresTermsAndConditions?: boolean, maxAppealReasonLength?: number, labelsSamples?: boolean, supportsMms?: boolean, usesBusinessVerification?: boolean, businessVerificationId?: string|null, [key: string]: any }, [key: string]: any }>|{ data: Array<Object>, total: number, page: number, limit: number, totalPages: number }>>} Brand records. For 10DLC brands in PENDING_CREATION (or rejected before carrier assignment), brandId is null — poll by _id until status advances and brandId is assigned. Toll-free brands carry `tollFree.isBrandReady` (whether the brand can host campaigns), `tollFree.maxNumbersPerCampaign` (the most numbers one of its campaigns can hold), `tollFree.maxOptInMethods` (the most opt-in methods one of its campaigns can declare), `tollFree.requiresPrivacyPolicy` (whether its campaigns need a privacy policy URL), `tollFree.requiresTermsAndConditions` (whether its campaigns need a terms and conditions URL), `tollFree.maxAppealReasonLength` (the longest appeal reason its campaigns may give), `tollFree.labelsSamples` (whether its campaigns' sample messages each start with their use case's name), `tollFree.supportsMms` (whether its numbers can send MMS and group messages), `tollFree.usesBusinessVerification` (whether it waits on its own business verification) and `tollFree.businessVerificationId` (the ID of the business verification it uses, or null when it uses none). The staff-only list (no id/subgroupId/groupId) returns the `{ data, total, page, limit, totalPages }` envelope only when includeTotal is sent with page and limit. Each brand carries `carrierSuspensions` (carrier brand suspension rules; active while liftedAt is null).
      */
     getBrands({ id, subgroupId, groupId, page, limit, status, registrationType, currentTollFreeCarrier, search, sortBy, sortOrder, entityType, ein, email, referenceId, groupIds, createdFrom, createdTo, excludeDeleted, includeTotal, options, }: {
         id?: string;
@@ -215,6 +230,7 @@ export class Brands {
             labelsSamples?: boolean;
             supportsMms?: boolean;
             usesBusinessVerification?: boolean;
+            businessVerificationId?: string | null;
             [key: string]: any;
         };
         [key: string]: any;
@@ -268,19 +284,19 @@ export class Brands {
         options?: RequestOptions;
     }): Promise<SdkResponse<any>>;
     /**
-     * Get a group's business verification: whether its toll-free brands need one, its status and the submitted details.
-     * Some groups verify each subgroup's business separately: a platform whose subgroups are separate businesses, set up by
-     * Signal House. For those groups pass the subgroup whose business verification to get.
+     * List a group's business verifications, newest first, and whether its toll-free brands need one. Some groups verify
+     * each subgroup's business separately: a platform whose subgroups are separate businesses, set up by Signal House. For
+     * those groups pass the subgroup whose business verifications to list.
      * @async
      * @roles api, admin, developer, billing, user
-     * @param {Object} params - The parameters for getting the business verification
-     * @param {string} params.groupId - The ID of the group whose business verification to get
-     * @param {string} [params.subgroupId] - The subgroup whose business verification to get, sent as a query parameter only when given. Required for a group that verifies each subgroup's business separately; for any other group it must be one of the group's subgroups and is otherwise ignored
+     * @param {Object} params - The parameters for listing the business verifications
+     * @param {string} params.groupId - The ID of the group whose business verifications to list
+     * @param {string} [params.subgroupId] - The subgroup whose business verifications to list, sent as a query parameter only when given. Required for a group that verifies each subgroup's business separately; for any other group it must be one of the group's subgroups and is otherwise ignored
      * @param {RequestOptions} [params.options] - Additional options for the request
      * @throws {Error} Throws an error if the groupId parameter is missing
-     * @returns {Promise<SdkResponse<{ groupId: string, subgroupId?: string, required: boolean, status: string, details: BusinessVerificationDetails|null, submittedAt: string|null, reviewedAt: string|null, rejectionReason: string|null }>>} The business verification. `subgroupId` is present only when it belongs to one subgroup: the subgroup whose business it describes. `required` says whether the group's new toll-free brands need one; `status` is NOT_STARTED, SUBMITTING, IN_REVIEW, VERIFIED or NEEDS_CHANGES; `rejectionReason` says why it needs changes, or is null. When `required` is true and `status` is NOT_STARTED, submit it before creating the first toll-free brand it covers. The API returns 400 when the group verifies each subgroup's business separately and no subgroupId is given, and 404 when the subgroup is not in the group.
+     * @returns {Promise<SdkResponse<{ groupId: string, subgroupId?: string, required: boolean, businessVerifications: Array<BusinessVerification> }>>} The business verifications, newest first. `subgroupId` is present only when they belong to one subgroup. `required` says whether the group's new toll-free brands need a business verification: each one names a VERIFIED business verification as `tollFree.businessVerificationId`. The API returns 400 when the group verifies each subgroup's business separately and no subgroupId is given, and 404 when the subgroup is not in the group.
      */
-    getBusinessVerification({ groupId, subgroupId, options }: {
+    getBusinessVerifications({ groupId, subgroupId, options }: {
         groupId: string;
         subgroupId?: string;
         options?: RequestOptions;
@@ -288,44 +304,68 @@ export class Brands {
         groupId: string;
         subgroupId?: string;
         required: boolean;
-        status: string;
-        details: BusinessVerificationDetails | null;
-        submittedAt: string | null;
-        reviewedAt: string | null;
-        rejectionReason: string | null;
+        businessVerifications: Array<BusinessVerification>;
+    }>>;
+    /**
+     * Get one of a group's business verifications by its ID.
+     * @async
+     * @roles api, admin, developer, billing, user
+     * @param {Object} params - The parameters for getting the business verification
+     * @param {string} params.groupId - The ID of the group the business verification belongs to
+     * @param {string} params.businessVerificationId - The ID of the business verification to get (starts with BV)
+     * @param {RequestOptions} [params.options] - Additional options for the request
+     * @throws {Error} Throws an error if the groupId or businessVerificationId parameter is missing
+     * @returns {Promise<SdkResponse<BusinessVerification & { required: boolean }>>} The business verification, plus `required` (whether the group's new toll-free brands need one). The API returns 404 when it isn't one of the group's.
+     */
+    getBusinessVerification({ groupId, businessVerificationId, options }: {
+        groupId: string;
+        businessVerificationId: string;
+        options?: RequestOptions;
+    }): Promise<SdkResponse<BusinessVerification & {
+        required: boolean;
     }>>;
     /**
-     * Submit or update a group's business verification, or one subgroup's in a group that verifies each subgroup's business
-     * separately. Allowed when it is not started or needs changes. Review usually takes 1–2 business days; the toll-free
-     * brands it covers stay pending until it is verified.
+     * Create and submit a new business verification for a group, or for one subgroup in a group that verifies each
+     * subgroup's business separately. Review usually takes 1–2 business days; once it is VERIFIED, new toll-free brands
+     * can use it by naming it as `tollFree.businessVerificationId`.
      * @async
      * @roles api, admin, developer, billing, user
-     * @param {Object} params - The parameters for submitting the business verification
-     * @param {string} params.groupId - The ID of the group whose business verification to submit (must be the caller's active group)
-     * @param {string} [params.subgroupId] - The subgroup whose business verification to submit, sent as a query parameter only when given. Required for a group that verifies each subgroup's business separately; for any other group it must be one of the group's subgroups and is otherwise ignored. The subgroup must be active
+     * @param {Object} params - The parameters for creating the business verification
+     * @param {string} params.groupId - The ID of the group the business verification is for (must be the caller's active group)
+     * @param {string} [params.subgroupId] - The subgroup whose business it verifies, sent as a query parameter only when given. Required for a group that verifies each subgroup's business separately; for any other group it must be one of the group's subgroups and is otherwise ignored. The subgroup must be active
      * @param {BusinessVerificationDetails} params.details - The business verification details (see BusinessVerificationDetails typedef for details)
      * @param {RequestOptions} [params.options] - Additional options for the request
      * @throws {Error} Throws an error if the groupId or details parameter is missing
-     * @returns {Promise<SdkResponse<{ groupId: string, subgroupId?: string, required: boolean, status: string, details: BusinessVerificationDetails|null, submittedAt: string|null, reviewedAt: string|null, rejectionReason: string|null }>>} A 202 with the business verification, now SUBMITTING (the same shape as getBusinessVerification, with `subgroupId` only when it belongs to one subgroup). The API returns 400 when the group verifies each subgroup's business separately and no subgroupId is given, or when the subgroup is inactive, and 404 when the subgroup is not in the group.
+     * @returns {Promise<SdkResponse<BusinessVerification>>} A 202 with the new business verification, now SUBMITTING. The API returns 400 when the group's toll-free brands don't need a business verification, when the group verifies each subgroup's business separately and no subgroupId is given, or when the subgroup is inactive, and 404 when the subgroup is not in the group.
      */
-    submitBusinessVerification({ groupId, subgroupId, details, options }: {
+    createBusinessVerification({ groupId, subgroupId, details, options }: {
         groupId: string;
         subgroupId?: string;
         details: BusinessVerificationDetails;
         options?: RequestOptions;
-    }): Promise<SdkResponse<{
+    }): Promise<SdkResponse<BusinessVerification>>;
+    /**
+     * Correct and resubmit a business verification that needs changes. Allowed only while its status is NEEDS_CHANGES.
+     * Review usually takes 1–2 business days; the toll-free brands that use it stay pending until it is verified.
+     * @async
+     * @roles api, admin, developer, billing, user
+     * @param {Object} params - The parameters for updating the business verification
+     * @param {string} params.groupId - The ID of the group the business verification belongs to (must be the caller's active group)
+     * @param {string} params.businessVerificationId - The ID of the business verification to update (starts with BV)
+     * @param {BusinessVerificationDetails} params.details - The corrected business verification details (see BusinessVerificationDetails typedef for details)
+     * @param {RequestOptions} [params.options] - Additional options for the request
+     * @throws {Error} Throws an error if the groupId, businessVerificationId or details parameter is missing
+     * @returns {Promise<SdkResponse<BusinessVerification>>} A 202 with the business verification, now SUBMITTING. The API returns 400 when it doesn't need changes, and 404 when it isn't one of the group's.
+     */
+    updateBusinessVerification({ groupId, businessVerificationId, details, options }: {
         groupId: string;
-        subgroupId?: string;
-        required: boolean;
-        status: string;
-        details: BusinessVerificationDetails | null;
-        submittedAt: string | null;
-        reviewedAt: string | null;
-        rejectionReason: string | null;
-    }>>;
+        businessVerificationId: string;
+        details: BusinessVerificationDetails;
+        options?: RequestOptions;
+    }): Promise<SdkResponse<BusinessVerification>>;
     /**
      * Get a group's toll-free ISV account: the group's own top-level account at the toll-free provider, used when its
-     * subgroups are separate businesses. Each subgroup gets an account and a business verification of its own under it.
+     * subgroups are separate businesses. Each subgroup gets an account and business verifications of its own under it.
      * Staff only.
      * @async
      * @roles signalhouse_api, signalhouse_admin, signalhouse_user
@@ -755,21 +795,21 @@ export type UpdateBrandData = {
 };
 export type TollFreeBrandDetails = {
     /**
-     * - The business registration type (required, one of EIN, CBN, NEQ, PROVINCIAL_NUMBER, CRN, VAT, ACN, ABN, BRN, SIREN, SIRET, NZBN, UST_IDNR, CIF, NIF, CNPJ, UID, OTHER)
+     * - The business registration type (required unless businessVerificationId is sent, one of EIN, CBN, NEQ, PROVINCIAL_NUMBER, CRN, VAT, ACN, ABN, BRN, SIREN, SIRET, NZBN, UST_IDNR, CIF, NIF, CNPJ, UID, OTHER)
      */
-    businessRegistrationType: string;
+    businessRegistrationType?: string;
     /**
      * - The legal entity type (required, one of PRIVATE_COMPANY, PUBLIC_COMPANY, NON_PROFIT, GOVERNMENT, SOLE_PROPRIETOR)
      */
     legalEntityType: string;
     /**
-     * - The business tax identifier (required, at most 50 characters)
+     * - The business tax identifier (required unless businessVerificationId is sent, at most 50 characters)
      */
-    taxId: string;
+    taxId?: string;
     /**
-     * - The business country code (required, 2-letter ISO code)
+     * - The business country code (required unless businessVerificationId is sent, 2-letter ISO code)
      */
-    countryCode: string;
+    countryCode?: string;
     /**
      * - The customer-support phone number (required, E.164 with an optional leading "+" and no spaces, parentheses or hyphens, e.g. "17025550100")
      */
@@ -786,6 +826,10 @@ export type TollFreeBrandDetails = {
      * - The customer's real website, sent to Infobip for brand verification (optional, valid URL, at most 255 characters; distinct from the top-level website / landing URL)
      */
     businessWebsite?: string;
+    /**
+     * - The ID of the business verification the brand uses (starts with BV). Required for a group whose toll-free brands need a business verification, and must name a VERIFIED one of the brand's group (in a group that verifies each subgroup's business separately, of the brand's subgroup); refused (400) for any other group. Set at creation only: it can't be changed
+     */
+    businessVerificationId?: string;
 };
 export type BusinessVerificationDetails = {
     /**
@@ -848,6 +892,40 @@ export type BusinessVerificationDetails = {
         jobLevel: string;
     };
 };
+export type BusinessVerification = {
+    /**
+     * - The business verification's ID (starts with BV)
+     */
+    businessVerificationId: string;
+    /**
+     * - The group it belongs to
+     */
+    groupId: string;
+    /**
+     * - The subgroup whose business it verifies; present only in a group that verifies each subgroup's business separately
+     */
+    subgroupId?: string;
+    /**
+     * - SUBMITTING, IN_REVIEW, VERIFIED or NEEDS_CHANGES
+     */
+    status: string;
+    /**
+     * - The submitted details
+     */
+    details: BusinessVerificationDetails;
+    /**
+     * - When it was last submitted (ISO date)
+     */
+    submittedAt: string;
+    /**
+     * - When it was last reviewed (ISO date), or null
+     */
+    reviewedAt: string | null;
+    /**
+     * - Why it needs changes, or null
+     */
+    rejectionReason: string | null;
+};
 export type TollFreeIsvAccount = {
     /**
      * - The group the account is registered to
@@ -874,6 +952,11 @@ export type TollFreeIsvAccount = {
      */
     updatedAt: string;
 };
+/**
+ * Toll-free brand data. When tollFree.businessVerificationId is sent, the legal fields (companyName, street, city, state,
+ * postalCode, country, firstName, lastName and tollFree's businessRegistrationType, taxId, countryCode and
+ * taxIdIssuingCountry) are optional: the business verification's values replace any that are sent.
+ */
 export type CreateTollFreeBrandData = {
     /**
      * - The ID of the subgroup to create the brand under (required, exactly 8 characters)
@@ -884,37 +967,37 @@ export type CreateTollFreeBrandData = {
      */
     displayName: string;
     /**
-     * - The company name for the brand (required, at most 255 characters)
+     * - The company name for the brand (required unless tollFree.businessVerificationId is sent, at most 255 characters)
      */
-    companyName: string;
+    companyName?: string;
     /**
-     * - The street address of the primary contact for the brand (required, at most 255 characters)
+     * - The street address of the primary contact for the brand (required unless tollFree.businessVerificationId is sent, at most 255 characters)
      */
-    street: string;
+    street?: string;
     /**
-     * - The city of the primary contact for the brand (required, at most 100 characters)
+     * - The city of the primary contact for the brand (required unless tollFree.businessVerificationId is sent, at most 100 characters)
      */
-    city: string;
+    city?: string;
     /**
-     * - The state of the primary contact for the brand (required, at most 20 characters; must be a valid 2-letter US state code when country is "US")
+     * - The state of the primary contact for the brand (required unless tollFree.businessVerificationId is sent, at most 20 characters; must be a valid 2-letter US state code when country is "US")
      */
-    state: string;
+    state?: string;
     /**
-     * - The postal code of the primary contact for the brand (required, at most 10 characters)
+     * - The postal code of the primary contact for the brand (required unless tollFree.businessVerificationId is sent, at most 10 characters)
      */
-    postalCode: string;
+    postalCode?: string;
     /**
      * - The email address of the primary contact for the brand (required, valid email, at most 100 characters)
      */
     email: string;
     /**
-     * - The first name of the primary contact for the brand (required, at most 100 characters)
+     * - The first name of the primary contact for the brand (required unless tollFree.businessVerificationId is sent, at most 100 characters)
      */
-    firstName: string;
+    firstName?: string;
     /**
-     * - The last name of the primary contact for the brand (required, at most 100 characters)
+     * - The last name of the primary contact for the brand (required unless tollFree.businessVerificationId is sent, at most 100 characters)
      */
-    lastName: string;
+    lastName?: string;
     /**
      * - The website URL for the brand (required, valid URL, at most 255 characters)
      */

package/types/domains/Campaigns.d.ts

@@ -327,6 +327,13 @@ export class Campaigns {
      * in the window; the volumes say how much traffic sits behind it. A campaign's figure is scored from the
      * campaign's own summed counters, never averaged from its numbers. For a live figure use GET /number/health
      * or GET /campaign/health.
+     *
+     * Every record also carries a `carrierSuspensions` array -- one entry per carrier suspension of the
+     * campaign: `{ mnoId, mnoName, source, suspensionCategory, reason, tcrEventType, suspendedAt, liftedAt }`.
+     * An entry is active while `liftedAt` is null. `mnoId` is the TCR carrier network id (same ids as `mnoIds`);
+     * `source` is CARRIER, UPSTREAM or BRAND (the carrier suspended the whole brand). A suspension applies to one
+     * carrier, so `status` stays ACTIVE. Subscribe to the CAMPAIGN_SUSPENDED / CAMPAIGN_UNSUSPENDED webhook events
+     * to be told when an entry opens or is lifted.
      * @returns {Promise<SdkResponse<Array|Object>>} The response from the server - array when unpaginated, or { data, total, page, limit, totalPages } when paginated
      */
     getCampaigns({ id, brandId, subgroupId, groupId, page, limit, status, search, sortBy, sortOrder, registrationType, options, }: {

package/types/domains/Numbers.d.ts

@@ -35,11 +35,14 @@ export class Numbers {
          * @roles signalhouse
          * @param {Object} params - The parameters for approving the request
          * @param {string} params.portingId - The _id of the port-in request
+         * @param {string} [params.subGroupId] - Subgroup to assign when the request has none yet.
+         *   Ignored if the request already has a subGroupId -- an existing assignment is never overwritten.
          * @param {RequestOptions} [params.options] - Additional options for the request
          * @returns {Promise<SdkResponse<any>>} A promise that resolves to the updated port-in request
          */
-        approvePortRequest: ({ portingId, options }: {
+        approvePortRequest: ({ portingId, subGroupId, options }: {
             portingId: string;
+            subGroupId?: string;
             options?: RequestOptions;
         }) => Promise<SdkResponse<any>>;
         /**