rcs-js 2.0.13 → 2.0.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (434) hide show
  1. package/dist/cjs/Client.js +2 -2
  2. package/dist/cjs/api/resources/audiences/client/Client.d.ts +15 -0
  3. package/dist/cjs/api/resources/audiences/client/Client.js +70 -0
  4. package/dist/cjs/api/resources/audiences/client/requests/ListAudiencesParams.d.ts +10 -0
  5. package/dist/cjs/api/resources/audiences/client/requests/index.d.ts +1 -0
  6. package/dist/cjs/api/resources/brands/client/Client.d.ts +15 -0
  7. package/dist/cjs/api/resources/brands/client/Client.js +70 -0
  8. package/dist/cjs/api/resources/brands/client/requests/ListBrandsParams.d.ts +23 -0
  9. package/dist/cjs/api/resources/brands/client/requests/ListBrandsParams.js +15 -0
  10. package/dist/cjs/api/resources/brands/client/requests/index.d.ts +1 -0
  11. package/dist/cjs/api/resources/campaigns/resources/dlc/client/Client.d.ts +15 -0
  12. package/dist/cjs/api/resources/campaigns/resources/dlc/client/Client.js +70 -0
  13. package/dist/cjs/api/resources/campaigns/resources/dlc/client/requests/ListDlcCampaignsParams.d.ts +21 -0
  14. package/dist/cjs/api/resources/campaigns/resources/dlc/client/requests/ListDlcCampaignsParams.js +13 -0
  15. package/dist/cjs/api/resources/campaigns/resources/dlc/client/requests/index.d.ts +1 -0
  16. package/dist/cjs/api/resources/campaigns/resources/rcs/client/Client.d.ts +15 -0
  17. package/dist/cjs/api/resources/campaigns/resources/rcs/client/Client.js +70 -0
  18. package/dist/cjs/api/resources/campaigns/resources/rcs/client/requests/ListRcsCampaignsParams.d.ts +21 -0
  19. package/dist/cjs/api/resources/campaigns/resources/rcs/client/requests/ListRcsCampaignsParams.js +13 -0
  20. package/dist/cjs/api/resources/campaigns/resources/rcs/client/requests/index.d.ts +1 -0
  21. package/dist/cjs/api/resources/campaigns/resources/tollFree/client/Client.d.ts +15 -0
  22. package/dist/cjs/api/resources/campaigns/resources/tollFree/client/Client.js +73 -0
  23. package/dist/cjs/api/resources/campaigns/resources/tollFree/client/requests/ListTollFreeCampaignsParams.d.ts +21 -0
  24. package/dist/cjs/api/resources/campaigns/resources/tollFree/client/requests/ListTollFreeCampaignsParams.js +13 -0
  25. package/dist/cjs/api/resources/campaigns/resources/tollFree/client/requests/index.d.ts +1 -0
  26. package/dist/cjs/api/resources/contacts/client/Client.d.ts +15 -0
  27. package/dist/cjs/api/resources/contacts/client/Client.js +70 -0
  28. package/dist/cjs/api/resources/contacts/client/requests/ListContactsParams.d.ts +16 -0
  29. package/dist/cjs/api/resources/contacts/client/requests/index.d.ts +1 -0
  30. package/dist/cjs/api/resources/messages/client/Client.d.ts +21 -0
  31. package/dist/cjs/api/resources/messages/client/Client.js +88 -8
  32. package/dist/cjs/api/resources/messages/client/requests/ListMessagesParams.d.ts +55 -0
  33. package/dist/cjs/api/resources/messages/client/requests/ListMessagesParams.js +33 -0
  34. package/dist/cjs/api/resources/messages/client/requests/index.d.ts +1 -0
  35. package/dist/cjs/api/resources/messages/resources/blast/client/requests/BlastRcs.d.ts +0 -2
  36. package/dist/cjs/api/resources/messages/resources/blasts/client/Client.d.ts +29 -0
  37. package/dist/cjs/api/resources/messages/resources/blasts/client/Client.js +133 -0
  38. package/dist/cjs/api/resources/messages/resources/blasts/client/index.d.ts +1 -0
  39. package/dist/cjs/api/resources/messages/resources/blasts/client/index.js +17 -0
  40. package/dist/cjs/api/resources/messages/resources/blasts/client/requests/ListBlastsParams.d.ts +17 -0
  41. package/dist/cjs/api/resources/messages/resources/blasts/client/requests/ListBlastsParams.js +3 -0
  42. package/dist/cjs/api/resources/messages/resources/blasts/client/requests/index.d.ts +1 -0
  43. package/dist/cjs/api/resources/messages/resources/blasts/client/requests/index.js +2 -0
  44. package/dist/cjs/api/resources/messages/resources/blasts/index.d.ts +1 -0
  45. package/dist/cjs/api/resources/messages/resources/blasts/index.js +17 -0
  46. package/dist/cjs/api/resources/messages/resources/index.d.ts +4 -0
  47. package/dist/cjs/api/resources/messages/resources/index.js +5 -1
  48. package/dist/cjs/api/resources/messages/resources/rcs/client/Client.d.ts +1 -4
  49. package/dist/cjs/api/resources/messages/resources/rcs/client/Client.js +1 -4
  50. package/dist/cjs/api/resources/messages/resources/rcs/client/requests/SendTypingIndicatorSchema.d.ts +1 -15
  51. package/dist/cjs/api/resources/messages/resources/rcs/types/SendRichMessageResponse.d.ts +1 -1
  52. package/dist/cjs/api/resources/messages/resources/schedules/client/Client.d.ts +29 -0
  53. package/dist/cjs/api/resources/messages/resources/schedules/client/Client.js +136 -0
  54. package/dist/cjs/api/resources/messages/resources/schedules/client/index.d.ts +1 -0
  55. package/dist/cjs/api/resources/messages/resources/schedules/client/index.js +17 -0
  56. package/dist/cjs/api/resources/messages/resources/schedules/client/requests/ListScheduledMessagesParams.d.ts +27 -0
  57. package/dist/cjs/api/resources/messages/resources/schedules/client/requests/ListScheduledMessagesParams.js +17 -0
  58. package/dist/cjs/api/resources/messages/resources/schedules/client/requests/index.d.ts +1 -0
  59. package/dist/cjs/api/resources/messages/resources/schedules/client/requests/index.js +2 -0
  60. package/dist/cjs/api/resources/messages/resources/schedules/index.d.ts +1 -0
  61. package/dist/cjs/api/resources/messages/resources/schedules/index.js +17 -0
  62. package/dist/cjs/api/resources/phoneNumbers/client/Client.d.ts +15 -0
  63. package/dist/cjs/api/resources/phoneNumbers/client/Client.js +70 -0
  64. package/dist/cjs/api/resources/phoneNumbers/client/requests/ListPhoneNumbersParams.d.ts +8 -0
  65. package/dist/cjs/api/resources/phoneNumbers/client/requests/ListPhoneNumbersParams.js +3 -0
  66. package/dist/cjs/api/resources/phoneNumbers/client/requests/index.d.ts +1 -0
  67. package/dist/cjs/api/resources/rcs/client/Client.d.ts +25 -42
  68. package/dist/cjs/api/resources/rcs/client/Client.js +40 -56
  69. package/dist/cjs/api/resources/rcs/client/requests/RcsCapabilitiesQuery.d.ts +2 -0
  70. package/dist/cjs/api/resources/rcs/client/requests/RcsLinkRequest.d.ts +0 -3
  71. package/dist/cjs/api/resources/rcs/client/requests/index.d.ts +0 -1
  72. package/dist/cjs/api/resources/rcs/index.d.ts +1 -0
  73. package/dist/cjs/api/resources/rcs/index.js +1 -0
  74. package/dist/cjs/api/resources/rcs/resources/agents/client/Client.d.ts +29 -0
  75. package/dist/cjs/api/resources/rcs/resources/agents/client/Client.js +133 -0
  76. package/dist/cjs/api/resources/rcs/resources/agents/client/index.d.ts +1 -0
  77. package/dist/cjs/api/resources/rcs/resources/agents/client/index.js +17 -0
  78. package/dist/cjs/api/resources/rcs/resources/agents/client/requests/ListAgentsParams.d.ts +20 -0
  79. package/dist/cjs/api/resources/rcs/resources/agents/client/requests/ListAgentsParams.js +12 -0
  80. package/dist/cjs/api/resources/rcs/resources/agents/client/requests/index.d.ts +1 -0
  81. package/dist/cjs/api/resources/rcs/resources/agents/client/requests/index.js +2 -0
  82. package/dist/cjs/api/resources/rcs/resources/agents/index.d.ts +1 -0
  83. package/dist/cjs/api/resources/rcs/resources/agents/index.js +17 -0
  84. package/dist/cjs/api/resources/rcs/resources/index.d.ts +6 -0
  85. package/dist/cjs/api/resources/rcs/resources/index.js +45 -0
  86. package/dist/cjs/api/resources/rcs/resources/test/client/Client.d.ts +214 -0
  87. package/dist/cjs/api/resources/rcs/resources/test/client/Client.js +497 -0
  88. package/dist/cjs/api/resources/rcs/resources/test/client/index.d.ts +1 -0
  89. package/dist/cjs/api/resources/rcs/resources/test/client/index.js +17 -0
  90. package/dist/cjs/api/resources/rcs/resources/test/client/requests/CreateTestAgentRequest.d.ts +87 -0
  91. package/dist/cjs/api/resources/rcs/resources/test/client/requests/CreateTestAgentRequest.js +3 -0
  92. package/dist/cjs/api/resources/rcs/resources/test/client/requests/TestAgentWhitelistRequest.d.ts +15 -0
  93. package/dist/cjs/api/resources/rcs/resources/test/client/requests/TestAgentWhitelistRequest.js +3 -0
  94. package/dist/cjs/api/resources/rcs/resources/test/client/requests/TestGetWhitelistStatusRequest.d.ts +20 -0
  95. package/dist/cjs/api/resources/rcs/resources/test/client/requests/TestGetWhitelistStatusRequest.js +3 -0
  96. package/dist/cjs/api/resources/rcs/resources/test/client/requests/UpdateTestAgentRequest.d.ts +59 -0
  97. package/dist/cjs/api/resources/rcs/resources/test/client/requests/UpdateTestAgentRequest.js +3 -0
  98. package/dist/cjs/api/resources/rcs/resources/test/client/requests/index.d.ts +4 -0
  99. package/dist/cjs/api/resources/rcs/resources/test/client/requests/index.js +2 -0
  100. package/dist/cjs/api/resources/rcs/resources/test/index.d.ts +1 -0
  101. package/dist/cjs/api/resources/rcs/resources/test/index.js +17 -0
  102. package/dist/cjs/api/resources/rcs/resources/whitelistedNumbers/client/Client.d.ts +29 -0
  103. package/dist/cjs/api/resources/rcs/resources/whitelistedNumbers/client/Client.js +133 -0
  104. package/dist/cjs/api/resources/rcs/resources/whitelistedNumbers/client/index.d.ts +1 -0
  105. package/dist/cjs/api/resources/rcs/resources/whitelistedNumbers/client/index.js +17 -0
  106. package/dist/cjs/api/resources/rcs/resources/whitelistedNumbers/client/requests/ListTestNumbersParams.d.ts +23 -0
  107. package/dist/cjs/api/resources/rcs/resources/whitelistedNumbers/client/requests/ListTestNumbersParams.js +13 -0
  108. package/dist/cjs/api/resources/rcs/resources/whitelistedNumbers/client/requests/index.d.ts +1 -0
  109. package/dist/cjs/api/resources/rcs/resources/whitelistedNumbers/client/requests/index.js +2 -0
  110. package/dist/cjs/api/resources/rcs/resources/whitelistedNumbers/index.d.ts +1 -0
  111. package/dist/cjs/api/resources/rcs/resources/whitelistedNumbers/index.js +17 -0
  112. package/dist/cjs/api/resources/tools/resources/url/client/Client.d.ts +15 -0
  113. package/dist/cjs/api/resources/tools/resources/url/client/Client.js +70 -0
  114. package/dist/cjs/api/resources/tools/resources/url/client/requests/ListLinksParams.d.ts +10 -0
  115. package/dist/cjs/api/resources/tools/resources/url/client/requests/ListLinksParams.js +3 -0
  116. package/dist/cjs/api/resources/tools/resources/url/client/requests/index.d.ts +1 -0
  117. package/dist/cjs/api/resources/webhooks/client/Client.d.ts +15 -0
  118. package/dist/cjs/api/resources/webhooks/client/Client.js +70 -0
  119. package/dist/cjs/api/resources/webhooks/client/requests/ListWebhooksParams.d.ts +19 -0
  120. package/dist/cjs/api/resources/webhooks/client/requests/ListWebhooksParams.js +12 -0
  121. package/dist/cjs/api/resources/webhooks/client/requests/index.d.ts +1 -0
  122. package/dist/cjs/api/types/AgentEmailEntry.d.ts +9 -0
  123. package/dist/cjs/api/types/AgentEmailEntry.js +3 -0
  124. package/dist/cjs/api/types/AgentPhoneEntry.d.ts +9 -0
  125. package/dist/cjs/api/types/AgentPhoneEntry.js +3 -0
  126. package/dist/cjs/api/types/AgentSummary.d.ts +94 -0
  127. package/dist/cjs/api/types/AgentSummary.js +22 -0
  128. package/dist/cjs/api/types/AgentUseCase.d.ts +15 -0
  129. package/dist/cjs/api/types/AgentUseCase.js +18 -0
  130. package/dist/cjs/api/types/AgentWebsiteEntry.d.ts +9 -0
  131. package/dist/cjs/api/types/AgentWebsiteEntry.js +3 -0
  132. package/dist/cjs/api/types/AudienceSummary.d.ts +12 -0
  133. package/dist/cjs/api/types/AudienceSummary.js +3 -0
  134. package/dist/cjs/api/types/BlastDetails.d.ts +1 -1
  135. package/dist/cjs/api/types/BlastSummary.d.ts +27 -0
  136. package/dist/cjs/api/types/BlastSummary.js +13 -0
  137. package/dist/cjs/api/types/CarrierLaunchStatus.d.ts +12 -0
  138. package/dist/cjs/api/types/CarrierLaunchStatus.js +15 -0
  139. package/dist/cjs/api/types/CarrierLaunches.d.ts +14 -0
  140. package/dist/cjs/api/types/CarrierLaunches.js +3 -0
  141. package/dist/cjs/api/types/DlcCampaignSummary.d.ts +26 -0
  142. package/dist/cjs/api/types/DlcCampaignSummary.js +14 -0
  143. package/dist/cjs/api/types/FallbackMessage.d.ts +6 -5
  144. package/dist/cjs/api/types/LinkSummary.d.ts +10 -0
  145. package/dist/cjs/api/types/LinkSummary.js +3 -0
  146. package/dist/cjs/api/types/ListAgentsResponse.d.ts +6 -0
  147. package/dist/cjs/api/types/ListAgentsResponse.js +3 -0
  148. package/dist/cjs/api/types/ListAudiencesResponse.d.ts +6 -0
  149. package/dist/cjs/api/types/ListAudiencesResponse.js +3 -0
  150. package/dist/cjs/api/types/ListBlastsResponse.d.ts +6 -0
  151. package/dist/cjs/api/types/ListBlastsResponse.js +3 -0
  152. package/dist/cjs/api/types/ListBrandsResponse.d.ts +6 -0
  153. package/dist/cjs/api/types/ListBrandsResponse.js +3 -0
  154. package/dist/cjs/api/types/ListContactsResponse.d.ts +6 -0
  155. package/dist/cjs/api/types/ListContactsResponse.js +3 -0
  156. package/dist/cjs/api/types/ListDlcCampaignsResponse.d.ts +6 -0
  157. package/dist/cjs/api/types/ListDlcCampaignsResponse.js +3 -0
  158. package/dist/cjs/api/types/ListLinksResponse.d.ts +6 -0
  159. package/dist/cjs/api/types/ListLinksResponse.js +3 -0
  160. package/dist/cjs/api/types/ListMessagesResponse.d.ts +6 -0
  161. package/dist/cjs/api/types/ListMessagesResponse.js +3 -0
  162. package/dist/cjs/api/types/ListPhoneNumbersResponse.d.ts +6 -0
  163. package/dist/cjs/api/types/ListPhoneNumbersResponse.js +3 -0
  164. package/dist/cjs/api/types/ListRcsCampaignsResponse.d.ts +6 -0
  165. package/dist/cjs/api/types/ListRcsCampaignsResponse.js +3 -0
  166. package/dist/cjs/api/types/ListScheduledMessagesResponse.d.ts +6 -0
  167. package/dist/cjs/api/types/ListScheduledMessagesResponse.js +3 -0
  168. package/dist/cjs/api/types/ListTestNumbersResponse.d.ts +6 -0
  169. package/dist/cjs/api/types/ListTestNumbersResponse.js +3 -0
  170. package/dist/cjs/api/types/ListTollFreeCampaignsResponse.d.ts +6 -0
  171. package/dist/cjs/api/types/ListTollFreeCampaignsResponse.js +3 -0
  172. package/dist/cjs/api/types/ListWebhooksResponse.d.ts +6 -0
  173. package/dist/cjs/api/types/ListWebhooksResponse.js +3 -0
  174. package/dist/cjs/api/types/Message.d.ts +0 -8
  175. package/dist/cjs/api/types/MessageEvent.d.ts +21 -14
  176. package/dist/cjs/api/types/MessageEvent.js +1 -1
  177. package/dist/cjs/api/types/MessageList.d.ts +1 -1
  178. package/dist/cjs/api/types/MessageSummary.d.ts +71 -0
  179. package/dist/cjs/api/types/MessageSummary.js +36 -0
  180. package/dist/cjs/api/types/{MessageWithReaction.d.ts → MessageWithReactions.d.ts} +7 -7
  181. package/dist/cjs/api/types/{MessageWithReaction.js → MessageWithReactions.js} +5 -5
  182. package/dist/cjs/api/types/OwnedPhoneNumber.d.ts +14 -0
  183. package/dist/cjs/api/types/OwnedPhoneNumber.js +3 -0
  184. package/dist/cjs/api/types/RcsAgentDetails.d.ts +81 -0
  185. package/dist/cjs/api/types/RcsAgentDetails.js +20 -0
  186. package/dist/cjs/api/types/RcsAgentResponse.d.ts +17 -0
  187. package/dist/cjs/api/types/RcsAgentResponse.js +3 -0
  188. package/dist/cjs/api/types/RcsCampaignSummary.d.ts +28 -0
  189. package/dist/cjs/api/types/RcsCampaignSummary.js +14 -0
  190. package/dist/cjs/api/types/RcsWhitelistStatus.d.ts +13 -0
  191. package/dist/cjs/api/types/RcsWhitelistStatus.js +16 -0
  192. package/dist/cjs/api/types/ScheduledMessageSummary.d.ts +29 -0
  193. package/dist/cjs/api/types/ScheduledMessageSummary.js +13 -0
  194. package/dist/cjs/api/types/SendRichMessageOptions.d.ts +0 -2
  195. package/dist/cjs/api/types/SentRichMessageFallbackMms.d.ts +10 -0
  196. package/dist/cjs/api/types/SentRichMessageFallbackMms.js +3 -0
  197. package/dist/cjs/api/types/SentRichMessageFallbackSms.d.ts +10 -0
  198. package/dist/cjs/api/types/SentRichMessageFallbackSms.js +3 -0
  199. package/dist/cjs/api/types/TestAgentResponse.d.ts +19 -0
  200. package/dist/cjs/api/types/TestAgentResponse.js +3 -0
  201. package/dist/cjs/api/types/TestAgentWhitelistResponse.d.ts +7 -0
  202. package/dist/cjs/api/types/TestAgentWhitelistResponse.js +3 -0
  203. package/dist/cjs/api/types/TollFreeCampaignSummary.d.ts +26 -0
  204. package/dist/cjs/api/types/TollFreeCampaignSummary.js +14 -0
  205. package/dist/cjs/api/types/WebhookSummary.d.ts +23 -0
  206. package/dist/cjs/api/types/WebhookSummary.js +13 -0
  207. package/dist/cjs/api/types/WhitelistedNumberSummary.d.ts +19 -0
  208. package/dist/cjs/api/types/WhitelistedNumberSummary.js +13 -0
  209. package/dist/cjs/api/types/index.d.ts +40 -2
  210. package/dist/cjs/api/types/index.js +40 -2
  211. package/dist/cjs/version.d.ts +1 -1
  212. package/dist/cjs/version.js +1 -1
  213. package/dist/esm/Client.mjs +2 -2
  214. package/dist/esm/api/resources/audiences/client/Client.d.mts +15 -0
  215. package/dist/esm/api/resources/audiences/client/Client.mjs +70 -0
  216. package/dist/esm/api/resources/audiences/client/requests/ListAudiencesParams.d.mts +10 -0
  217. package/dist/esm/api/resources/audiences/client/requests/index.d.mts +1 -0
  218. package/dist/esm/api/resources/brands/client/Client.d.mts +15 -0
  219. package/dist/esm/api/resources/brands/client/Client.mjs +70 -0
  220. package/dist/esm/api/resources/brands/client/requests/ListBrandsParams.d.mts +23 -0
  221. package/dist/esm/api/resources/brands/client/requests/ListBrandsParams.mjs +12 -0
  222. package/dist/esm/api/resources/brands/client/requests/index.d.mts +1 -0
  223. package/dist/esm/api/resources/campaigns/resources/dlc/client/Client.d.mts +15 -0
  224. package/dist/esm/api/resources/campaigns/resources/dlc/client/Client.mjs +70 -0
  225. package/dist/esm/api/resources/campaigns/resources/dlc/client/requests/ListDlcCampaignsParams.d.mts +21 -0
  226. package/dist/esm/api/resources/campaigns/resources/dlc/client/requests/ListDlcCampaignsParams.mjs +10 -0
  227. package/dist/esm/api/resources/campaigns/resources/dlc/client/requests/index.d.mts +1 -0
  228. package/dist/esm/api/resources/campaigns/resources/rcs/client/Client.d.mts +15 -0
  229. package/dist/esm/api/resources/campaigns/resources/rcs/client/Client.mjs +70 -0
  230. package/dist/esm/api/resources/campaigns/resources/rcs/client/requests/ListRcsCampaignsParams.d.mts +21 -0
  231. package/dist/esm/api/resources/campaigns/resources/rcs/client/requests/ListRcsCampaignsParams.mjs +10 -0
  232. package/dist/esm/api/resources/campaigns/resources/rcs/client/requests/index.d.mts +1 -0
  233. package/dist/esm/api/resources/campaigns/resources/tollFree/client/Client.d.mts +15 -0
  234. package/dist/esm/api/resources/campaigns/resources/tollFree/client/Client.mjs +73 -0
  235. package/dist/esm/api/resources/campaigns/resources/tollFree/client/requests/ListTollFreeCampaignsParams.d.mts +21 -0
  236. package/dist/esm/api/resources/campaigns/resources/tollFree/client/requests/ListTollFreeCampaignsParams.mjs +10 -0
  237. package/dist/esm/api/resources/campaigns/resources/tollFree/client/requests/index.d.mts +1 -0
  238. package/dist/esm/api/resources/contacts/client/Client.d.mts +15 -0
  239. package/dist/esm/api/resources/contacts/client/Client.mjs +70 -0
  240. package/dist/esm/api/resources/contacts/client/requests/ListContactsParams.d.mts +16 -0
  241. package/dist/esm/api/resources/contacts/client/requests/index.d.mts +1 -0
  242. package/dist/esm/api/resources/messages/client/Client.d.mts +21 -0
  243. package/dist/esm/api/resources/messages/client/Client.mjs +80 -0
  244. package/dist/esm/api/resources/messages/client/requests/ListMessagesParams.d.mts +55 -0
  245. package/dist/esm/api/resources/messages/client/requests/ListMessagesParams.mjs +30 -0
  246. package/dist/esm/api/resources/messages/client/requests/index.d.mts +1 -0
  247. package/dist/esm/api/resources/messages/resources/blast/client/requests/BlastRcs.d.mts +0 -2
  248. package/dist/esm/api/resources/messages/resources/blasts/client/Client.d.mts +29 -0
  249. package/dist/esm/api/resources/messages/resources/blasts/client/Client.mjs +96 -0
  250. package/dist/esm/api/resources/messages/resources/blasts/client/index.d.mts +1 -0
  251. package/dist/esm/api/resources/messages/resources/blasts/client/index.mjs +1 -0
  252. package/dist/esm/api/resources/messages/resources/blasts/client/requests/ListBlastsParams.d.mts +17 -0
  253. package/dist/esm/api/resources/messages/resources/blasts/client/requests/ListBlastsParams.mjs +2 -0
  254. package/dist/esm/api/resources/messages/resources/blasts/client/requests/index.d.mts +1 -0
  255. package/dist/esm/api/resources/messages/resources/blasts/client/requests/index.mjs +1 -0
  256. package/dist/esm/api/resources/messages/resources/blasts/index.d.mts +1 -0
  257. package/dist/esm/api/resources/messages/resources/blasts/index.mjs +1 -0
  258. package/dist/esm/api/resources/messages/resources/index.d.mts +4 -0
  259. package/dist/esm/api/resources/messages/resources/index.mjs +4 -0
  260. package/dist/esm/api/resources/messages/resources/rcs/client/Client.d.mts +1 -4
  261. package/dist/esm/api/resources/messages/resources/rcs/client/Client.mjs +1 -4
  262. package/dist/esm/api/resources/messages/resources/rcs/client/requests/SendTypingIndicatorSchema.d.mts +1 -15
  263. package/dist/esm/api/resources/messages/resources/rcs/types/SendRichMessageResponse.d.mts +1 -1
  264. package/dist/esm/api/resources/messages/resources/schedules/client/Client.d.mts +29 -0
  265. package/dist/esm/api/resources/messages/resources/schedules/client/Client.mjs +99 -0
  266. package/dist/esm/api/resources/messages/resources/schedules/client/index.d.mts +1 -0
  267. package/dist/esm/api/resources/messages/resources/schedules/client/index.mjs +1 -0
  268. package/dist/esm/api/resources/messages/resources/schedules/client/requests/ListScheduledMessagesParams.d.mts +27 -0
  269. package/dist/esm/api/resources/messages/resources/schedules/client/requests/ListScheduledMessagesParams.mjs +14 -0
  270. package/dist/esm/api/resources/messages/resources/schedules/client/requests/index.d.mts +1 -0
  271. package/dist/esm/api/resources/messages/resources/schedules/client/requests/index.mjs +1 -0
  272. package/dist/esm/api/resources/messages/resources/schedules/index.d.mts +1 -0
  273. package/dist/esm/api/resources/messages/resources/schedules/index.mjs +1 -0
  274. package/dist/esm/api/resources/phoneNumbers/client/Client.d.mts +15 -0
  275. package/dist/esm/api/resources/phoneNumbers/client/Client.mjs +70 -0
  276. package/dist/esm/api/resources/phoneNumbers/client/requests/ListPhoneNumbersParams.d.mts +8 -0
  277. package/dist/esm/api/resources/phoneNumbers/client/requests/ListPhoneNumbersParams.mjs +2 -0
  278. package/dist/esm/api/resources/phoneNumbers/client/requests/index.d.mts +1 -0
  279. package/dist/esm/api/resources/rcs/client/Client.d.mts +25 -42
  280. package/dist/esm/api/resources/rcs/client/Client.mjs +40 -56
  281. package/dist/esm/api/resources/rcs/client/requests/RcsCapabilitiesQuery.d.mts +2 -0
  282. package/dist/esm/api/resources/rcs/client/requests/RcsLinkRequest.d.mts +0 -3
  283. package/dist/esm/api/resources/rcs/client/requests/index.d.mts +0 -1
  284. package/dist/esm/api/resources/rcs/index.d.mts +1 -0
  285. package/dist/esm/api/resources/rcs/index.mjs +1 -0
  286. package/dist/esm/api/resources/rcs/resources/agents/client/Client.d.mts +29 -0
  287. package/dist/esm/api/resources/rcs/resources/agents/client/Client.mjs +96 -0
  288. package/dist/esm/api/resources/rcs/resources/agents/client/index.d.mts +1 -0
  289. package/dist/esm/api/resources/rcs/resources/agents/client/index.mjs +1 -0
  290. package/dist/esm/api/resources/rcs/resources/agents/client/requests/ListAgentsParams.d.mts +20 -0
  291. package/dist/esm/api/resources/rcs/resources/agents/client/requests/ListAgentsParams.mjs +9 -0
  292. package/dist/esm/api/resources/rcs/resources/agents/client/requests/index.d.mts +1 -0
  293. package/dist/esm/api/resources/rcs/resources/agents/client/requests/index.mjs +1 -0
  294. package/dist/esm/api/resources/rcs/resources/agents/index.d.mts +1 -0
  295. package/dist/esm/api/resources/rcs/resources/agents/index.mjs +1 -0
  296. package/dist/esm/api/resources/rcs/resources/index.d.mts +6 -0
  297. package/dist/esm/api/resources/rcs/resources/index.mjs +6 -0
  298. package/dist/esm/api/resources/rcs/resources/test/client/Client.d.mts +214 -0
  299. package/dist/esm/api/resources/rcs/resources/test/client/Client.mjs +460 -0
  300. package/dist/esm/api/resources/rcs/resources/test/client/index.d.mts +1 -0
  301. package/dist/esm/api/resources/rcs/resources/test/client/index.mjs +1 -0
  302. package/dist/esm/api/resources/rcs/resources/test/client/requests/CreateTestAgentRequest.d.mts +87 -0
  303. package/dist/esm/api/resources/rcs/resources/test/client/requests/CreateTestAgentRequest.mjs +2 -0
  304. package/dist/esm/api/resources/rcs/resources/test/client/requests/TestAgentWhitelistRequest.d.mts +15 -0
  305. package/dist/esm/api/resources/rcs/resources/test/client/requests/TestAgentWhitelistRequest.mjs +2 -0
  306. package/dist/esm/api/resources/rcs/resources/test/client/requests/TestGetWhitelistStatusRequest.d.mts +20 -0
  307. package/dist/esm/api/resources/rcs/resources/test/client/requests/TestGetWhitelistStatusRequest.mjs +2 -0
  308. package/dist/esm/api/resources/rcs/resources/test/client/requests/UpdateTestAgentRequest.d.mts +59 -0
  309. package/dist/esm/api/resources/rcs/resources/test/client/requests/UpdateTestAgentRequest.mjs +2 -0
  310. package/dist/esm/api/resources/rcs/resources/test/client/requests/index.d.mts +4 -0
  311. package/dist/esm/api/resources/rcs/resources/test/client/requests/index.mjs +1 -0
  312. package/dist/esm/api/resources/rcs/resources/test/index.d.mts +1 -0
  313. package/dist/esm/api/resources/rcs/resources/test/index.mjs +1 -0
  314. package/dist/esm/api/resources/rcs/resources/whitelistedNumbers/client/Client.d.mts +29 -0
  315. package/dist/esm/api/resources/rcs/resources/whitelistedNumbers/client/Client.mjs +96 -0
  316. package/dist/esm/api/resources/rcs/resources/whitelistedNumbers/client/index.d.mts +1 -0
  317. package/dist/esm/api/resources/rcs/resources/whitelistedNumbers/client/index.mjs +1 -0
  318. package/dist/esm/api/resources/rcs/resources/whitelistedNumbers/client/requests/ListTestNumbersParams.d.mts +23 -0
  319. package/dist/esm/api/resources/rcs/resources/whitelistedNumbers/client/requests/ListTestNumbersParams.mjs +10 -0
  320. package/dist/esm/api/resources/rcs/resources/whitelistedNumbers/client/requests/index.d.mts +1 -0
  321. package/dist/esm/api/resources/rcs/resources/whitelistedNumbers/client/requests/index.mjs +1 -0
  322. package/dist/esm/api/resources/rcs/resources/whitelistedNumbers/index.d.mts +1 -0
  323. package/dist/esm/api/resources/rcs/resources/whitelistedNumbers/index.mjs +1 -0
  324. package/dist/esm/api/resources/tools/resources/url/client/Client.d.mts +15 -0
  325. package/dist/esm/api/resources/tools/resources/url/client/Client.mjs +70 -0
  326. package/dist/esm/api/resources/tools/resources/url/client/requests/ListLinksParams.d.mts +10 -0
  327. package/dist/esm/api/resources/tools/resources/url/client/requests/ListLinksParams.mjs +2 -0
  328. package/dist/esm/api/resources/tools/resources/url/client/requests/index.d.mts +1 -0
  329. package/dist/esm/api/resources/webhooks/client/Client.d.mts +15 -0
  330. package/dist/esm/api/resources/webhooks/client/Client.mjs +70 -0
  331. package/dist/esm/api/resources/webhooks/client/requests/ListWebhooksParams.d.mts +19 -0
  332. package/dist/esm/api/resources/webhooks/client/requests/ListWebhooksParams.mjs +9 -0
  333. package/dist/esm/api/resources/webhooks/client/requests/index.d.mts +1 -0
  334. package/dist/esm/api/types/AgentEmailEntry.d.mts +9 -0
  335. package/dist/esm/api/types/AgentEmailEntry.mjs +2 -0
  336. package/dist/esm/api/types/AgentPhoneEntry.d.mts +9 -0
  337. package/dist/esm/api/types/AgentPhoneEntry.mjs +2 -0
  338. package/dist/esm/api/types/AgentSummary.d.mts +94 -0
  339. package/dist/esm/api/types/AgentSummary.mjs +19 -0
  340. package/dist/esm/api/types/AgentUseCase.d.mts +15 -0
  341. package/dist/esm/api/types/AgentUseCase.mjs +15 -0
  342. package/dist/esm/api/types/AgentWebsiteEntry.d.mts +9 -0
  343. package/dist/esm/api/types/AgentWebsiteEntry.mjs +2 -0
  344. package/dist/esm/api/types/AudienceSummary.d.mts +12 -0
  345. package/dist/esm/api/types/AudienceSummary.mjs +2 -0
  346. package/dist/esm/api/types/BlastDetails.d.mts +1 -1
  347. package/dist/esm/api/types/BlastSummary.d.mts +27 -0
  348. package/dist/esm/api/types/BlastSummary.mjs +10 -0
  349. package/dist/esm/api/types/CarrierLaunchStatus.d.mts +12 -0
  350. package/dist/esm/api/types/CarrierLaunchStatus.mjs +12 -0
  351. package/dist/esm/api/types/CarrierLaunches.d.mts +14 -0
  352. package/dist/esm/api/types/CarrierLaunches.mjs +2 -0
  353. package/dist/esm/api/types/DlcCampaignSummary.d.mts +26 -0
  354. package/dist/esm/api/types/DlcCampaignSummary.mjs +11 -0
  355. package/dist/esm/api/types/FallbackMessage.d.mts +6 -5
  356. package/dist/esm/api/types/LinkSummary.d.mts +10 -0
  357. package/dist/esm/api/types/LinkSummary.mjs +2 -0
  358. package/dist/esm/api/types/ListAgentsResponse.d.mts +6 -0
  359. package/dist/esm/api/types/ListAgentsResponse.mjs +2 -0
  360. package/dist/esm/api/types/ListAudiencesResponse.d.mts +6 -0
  361. package/dist/esm/api/types/ListAudiencesResponse.mjs +2 -0
  362. package/dist/esm/api/types/ListBlastsResponse.d.mts +6 -0
  363. package/dist/esm/api/types/ListBlastsResponse.mjs +2 -0
  364. package/dist/esm/api/types/ListBrandsResponse.d.mts +6 -0
  365. package/dist/esm/api/types/ListBrandsResponse.mjs +2 -0
  366. package/dist/esm/api/types/ListContactsResponse.d.mts +6 -0
  367. package/dist/esm/api/types/ListContactsResponse.mjs +2 -0
  368. package/dist/esm/api/types/ListDlcCampaignsResponse.d.mts +6 -0
  369. package/dist/esm/api/types/ListDlcCampaignsResponse.mjs +2 -0
  370. package/dist/esm/api/types/ListLinksResponse.d.mts +6 -0
  371. package/dist/esm/api/types/ListLinksResponse.mjs +2 -0
  372. package/dist/esm/api/types/ListMessagesResponse.d.mts +6 -0
  373. package/dist/esm/api/types/ListMessagesResponse.mjs +2 -0
  374. package/dist/esm/api/types/ListPhoneNumbersResponse.d.mts +6 -0
  375. package/dist/esm/api/types/ListPhoneNumbersResponse.mjs +2 -0
  376. package/dist/esm/api/types/ListRcsCampaignsResponse.d.mts +6 -0
  377. package/dist/esm/api/types/ListRcsCampaignsResponse.mjs +2 -0
  378. package/dist/esm/api/types/ListScheduledMessagesResponse.d.mts +6 -0
  379. package/dist/esm/api/types/ListScheduledMessagesResponse.mjs +2 -0
  380. package/dist/esm/api/types/ListTestNumbersResponse.d.mts +6 -0
  381. package/dist/esm/api/types/ListTestNumbersResponse.mjs +2 -0
  382. package/dist/esm/api/types/ListTollFreeCampaignsResponse.d.mts +6 -0
  383. package/dist/esm/api/types/ListTollFreeCampaignsResponse.mjs +2 -0
  384. package/dist/esm/api/types/ListWebhooksResponse.d.mts +6 -0
  385. package/dist/esm/api/types/ListWebhooksResponse.mjs +2 -0
  386. package/dist/esm/api/types/Message.d.mts +0 -8
  387. package/dist/esm/api/types/MessageEvent.d.mts +21 -14
  388. package/dist/esm/api/types/MessageEvent.mjs +1 -1
  389. package/dist/esm/api/types/MessageList.d.mts +1 -1
  390. package/dist/esm/api/types/MessageSummary.d.mts +71 -0
  391. package/dist/esm/api/types/MessageSummary.mjs +33 -0
  392. package/dist/esm/api/types/{MessageWithReaction.d.mts → MessageWithReactions.d.mts} +7 -7
  393. package/dist/esm/api/types/{MessageWithReaction.mjs → MessageWithReactions.mjs} +4 -4
  394. package/dist/esm/api/types/OwnedPhoneNumber.d.mts +14 -0
  395. package/dist/esm/api/types/OwnedPhoneNumber.mjs +2 -0
  396. package/dist/esm/api/types/RcsAgentDetails.d.mts +81 -0
  397. package/dist/esm/api/types/RcsAgentDetails.mjs +17 -0
  398. package/dist/esm/api/types/RcsAgentResponse.d.mts +17 -0
  399. package/dist/esm/api/types/RcsAgentResponse.mjs +2 -0
  400. package/dist/esm/api/types/RcsCampaignSummary.d.mts +28 -0
  401. package/dist/esm/api/types/RcsCampaignSummary.mjs +11 -0
  402. package/dist/esm/api/types/RcsWhitelistStatus.d.mts +13 -0
  403. package/dist/esm/api/types/RcsWhitelistStatus.mjs +13 -0
  404. package/dist/esm/api/types/ScheduledMessageSummary.d.mts +29 -0
  405. package/dist/esm/api/types/ScheduledMessageSummary.mjs +10 -0
  406. package/dist/esm/api/types/SendRichMessageOptions.d.mts +0 -2
  407. package/dist/esm/api/types/SentRichMessageFallbackMms.d.mts +10 -0
  408. package/dist/esm/api/types/SentRichMessageFallbackMms.mjs +2 -0
  409. package/dist/esm/api/types/SentRichMessageFallbackSms.d.mts +10 -0
  410. package/dist/esm/api/types/SentRichMessageFallbackSms.mjs +2 -0
  411. package/dist/esm/api/types/TestAgentResponse.d.mts +19 -0
  412. package/dist/esm/api/types/TestAgentResponse.mjs +2 -0
  413. package/dist/esm/api/types/TestAgentWhitelistResponse.d.mts +7 -0
  414. package/dist/esm/api/types/TestAgentWhitelistResponse.mjs +2 -0
  415. package/dist/esm/api/types/TollFreeCampaignSummary.d.mts +26 -0
  416. package/dist/esm/api/types/TollFreeCampaignSummary.mjs +11 -0
  417. package/dist/esm/api/types/WebhookSummary.d.mts +23 -0
  418. package/dist/esm/api/types/WebhookSummary.mjs +10 -0
  419. package/dist/esm/api/types/WhitelistedNumberSummary.d.mts +19 -0
  420. package/dist/esm/api/types/WhitelistedNumberSummary.mjs +10 -0
  421. package/dist/esm/api/types/index.d.mts +40 -2
  422. package/dist/esm/api/types/index.mjs +40 -2
  423. package/dist/esm/version.d.mts +1 -1
  424. package/dist/esm/version.mjs +1 -1
  425. package/package.json +2 -2
  426. package/reference.md +1413 -155
  427. package/dist/cjs/api/resources/rcs/client/requests/RcsWhitelistRequest.d.ts +0 -13
  428. package/dist/cjs/api/types/RcsWhitelistResponse.d.ts +0 -7
  429. package/dist/esm/api/resources/rcs/client/requests/RcsWhitelistRequest.d.mts +0 -13
  430. package/dist/esm/api/types/RcsWhitelistResponse.d.mts +0 -7
  431. /package/dist/cjs/api/resources/{rcs/client/requests/RcsWhitelistRequest.js → audiences/client/requests/ListAudiencesParams.js} +0 -0
  432. /package/dist/cjs/api/{types/RcsWhitelistResponse.js → resources/contacts/client/requests/ListContactsParams.js} +0 -0
  433. /package/dist/esm/api/resources/{rcs/client/requests/RcsWhitelistRequest.mjs → audiences/client/requests/ListAudiencesParams.mjs} +0 -0
  434. /package/dist/esm/api/{types/RcsWhitelistResponse.mjs → resources/contacts/client/requests/ListContactsParams.mjs} +0 -0
package/reference.md CHANGED
@@ -431,6 +431,69 @@ This identifier is a string that always begins with the prefix `b_`, for example
431
431
  </dl>
432
432
 
433
433
 
434
+ </dd>
435
+ </dl>
436
+ </details>
437
+
438
+ <details><summary><code>client.brands.<a href="/src/api/resources/brands/client/Client.ts">list</a>({ ...params }) -> Pinnacle.ListBrandsResponse</code></summary>
439
+ <dl>
440
+ <dd>
441
+
442
+ #### 📝 Description
443
+
444
+ <dl>
445
+ <dd>
446
+
447
+ <dl>
448
+ <dd>
449
+
450
+ List all brands with optional filtering and pagination. Results are sorted by creation date, newest first.
451
+ </dd>
452
+ </dl>
453
+ </dd>
454
+ </dl>
455
+
456
+ #### 🔌 Usage
457
+
458
+ <dl>
459
+ <dd>
460
+
461
+ <dl>
462
+ <dd>
463
+
464
+ ```typescript
465
+ await client.brands.list();
466
+
467
+ ```
468
+ </dd>
469
+ </dl>
470
+ </dd>
471
+ </dl>
472
+
473
+ #### ⚙️ Parameters
474
+
475
+ <dl>
476
+ <dd>
477
+
478
+ <dl>
479
+ <dd>
480
+
481
+ **request:** `Pinnacle.ListBrandsParams`
482
+
483
+ </dd>
484
+ </dl>
485
+
486
+ <dl>
487
+ <dd>
488
+
489
+ **requestOptions:** `Brands.RequestOptions`
490
+
491
+ </dd>
492
+ </dl>
493
+ </dd>
494
+ </dl>
495
+
496
+
434
497
  </dd>
435
498
  </dl>
436
499
  </details>
@@ -699,6 +762,69 @@ await client.audiences.update({
699
762
  </dl>
700
763
 
701
764
 
765
+ </dd>
766
+ </dl>
767
+ </details>
768
+
769
+ <details><summary><code>client.audiences.<a href="/src/api/resources/audiences/client/Client.ts">list</a>({ ...params }) -> Pinnacle.ListAudiencesResponse</code></summary>
770
+ <dl>
771
+ <dd>
772
+
773
+ #### 📝 Description
774
+
775
+ <dl>
776
+ <dd>
777
+
778
+ <dl>
779
+ <dd>
780
+
781
+ List all audiences with optional filtering and pagination. Results are sorted by creation date, newest first.
782
+ </dd>
783
+ </dl>
784
+ </dd>
785
+ </dl>
786
+
787
+ #### 🔌 Usage
788
+
789
+ <dl>
790
+ <dd>
791
+
792
+ <dl>
793
+ <dd>
794
+
795
+ ```typescript
796
+ await client.audiences.list();
797
+
798
+ ```
799
+ </dd>
800
+ </dl>
801
+ </dd>
802
+ </dl>
803
+
804
+ #### ⚙️ Parameters
805
+
806
+ <dl>
807
+ <dd>
808
+
809
+ <dl>
810
+ <dd>
811
+
812
+ **request:** `Pinnacle.ListAudiencesParams`
813
+
814
+ </dd>
815
+ </dl>
816
+
817
+ <dl>
818
+ <dd>
819
+
820
+ **requestOptions:** `Audiences.RequestOptions`
821
+
822
+ </dd>
823
+ </dl>
824
+ </dd>
825
+ </dl>
826
+
827
+
702
828
  </dd>
703
829
  </dl>
704
830
  </details>
@@ -899,6 +1025,69 @@ await client.contacts.update({
899
1025
  </dl>
900
1026
 
901
1027
 
1028
+ </dd>
1029
+ </dl>
1030
+ </details>
1031
+
1032
+ <details><summary><code>client.contacts.<a href="/src/api/resources/contacts/client/Client.ts">list</a>({ ...params }) -> Pinnacle.ListContactsResponse</code></summary>
1033
+ <dl>
1034
+ <dd>
1035
+
1036
+ #### 📝 Description
1037
+
1038
+ <dl>
1039
+ <dd>
1040
+
1041
+ <dl>
1042
+ <dd>
1043
+
1044
+ List all contacts with optional filtering and pagination. Results are sorted by creation date, newest first.
1045
+ </dd>
1046
+ </dl>
1047
+ </dd>
1048
+ </dl>
1049
+
1050
+ #### 🔌 Usage
1051
+
1052
+ <dl>
1053
+ <dd>
1054
+
1055
+ <dl>
1056
+ <dd>
1057
+
1058
+ ```typescript
1059
+ await client.contacts.list();
1060
+
1061
+ ```
1062
+ </dd>
1063
+ </dl>
1064
+ </dd>
1065
+ </dl>
1066
+
1067
+ #### ⚙️ Parameters
1068
+
1069
+ <dl>
1070
+ <dd>
1071
+
1072
+ <dl>
1073
+ <dd>
1074
+
1075
+ **request:** `Pinnacle.ListContactsParams`
1076
+
1077
+ </dd>
1078
+ </dl>
1079
+
1080
+ <dl>
1081
+ <dd>
1082
+
1083
+ **requestOptions:** `Contacts.RequestOptions`
1084
+
1085
+ </dd>
1086
+ </dl>
1087
+ </dd>
1088
+ </dl>
1089
+
1090
+
902
1091
  </dd>
903
1092
  </dl>
904
1093
  </details>
@@ -1306,6 +1495,69 @@ await client.messages.react({
1306
1495
  </dl>
1307
1496
 
1308
1497
 
1498
+ </dd>
1499
+ </dl>
1500
+ </details>
1501
+
1502
+ <details><summary><code>client.messages.<a href="/src/api/resources/messages/client/Client.ts">list</a>({ ...params }) -> Pinnacle.ListMessagesResponse</code></summary>
1503
+ <dl>
1504
+ <dd>
1505
+
1506
+ #### 📝 Description
1507
+
1508
+ <dl>
1509
+ <dd>
1510
+
1511
+ <dl>
1512
+ <dd>
1513
+
1514
+ List all messages with optional filtering and pagination. Results are sorted by creation date, newest first.
1515
+ </dd>
1516
+ </dl>
1517
+ </dd>
1518
+ </dl>
1519
+
1520
+ #### 🔌 Usage
1521
+
1522
+ <dl>
1523
+ <dd>
1524
+
1525
+ <dl>
1526
+ <dd>
1527
+
1528
+ ```typescript
1529
+ await client.messages.list();
1530
+
1531
+ ```
1532
+ </dd>
1533
+ </dl>
1534
+ </dd>
1535
+ </dl>
1536
+
1537
+ #### ⚙️ Parameters
1538
+
1539
+ <dl>
1540
+ <dd>
1541
+
1542
+ <dl>
1543
+ <dd>
1544
+
1545
+ **request:** `Pinnacle.ListMessagesParams`
1546
+
1547
+ </dd>
1548
+ </dl>
1549
+
1550
+ <dl>
1551
+ <dd>
1552
+
1553
+ **requestOptions:** `Messages.RequestOptions`
1554
+
1555
+ </dd>
1556
+ </dl>
1557
+ </dd>
1558
+ </dl>
1559
+
1560
+
1309
1561
  </dd>
1310
1562
  </dl>
1311
1563
  </details>
@@ -1527,8 +1779,7 @@ await client.phoneNumbers.get({
1527
1779
  </dl>
1528
1780
  </details>
1529
1781
 
1530
- ## RCS
1531
- <details><summary><code>client.rcs.<a href="/src/api/resources/rcs/client/Client.ts">getCapabilities</a>({ ...params }) -> Pinnacle.RcsCapabilitiesResult</code></summary>
1782
+ <details><summary><code>client.phoneNumbers.<a href="/src/api/resources/phoneNumbers/client/Client.ts">list</a>({ ...params }) -> Pinnacle.ListPhoneNumbersResponse</code></summary>
1532
1783
  <dl>
1533
1784
  <dd>
1534
1785
 
@@ -1540,10 +1791,7 @@ await client.phoneNumbers.get({
1540
1791
  <dl>
1541
1792
  <dd>
1542
1793
 
1543
- Check RCS capabilities for one or more phone numbers.
1544
-
1545
- This endpoint allows you to verify which RCS features (cards, buttons, etc.) are supported
1546
- on specific phone numbers before sending RCS messages to them.
1794
+ List all owned phone numbers with pagination. Results are sorted by creation date, newest first.
1547
1795
  </dd>
1548
1796
  </dl>
1549
1797
  </dd>
@@ -1558,9 +1806,7 @@ on specific phone numbers before sending RCS messages to them.
1558
1806
  <dd>
1559
1807
 
1560
1808
  ```typescript
1561
- await client.rcs.getCapabilities({
1562
- phoneNumbers: ["+12345678901", "+19876543210"]
1563
- });
1809
+ await client.phoneNumbers.list();
1564
1810
 
1565
1811
  ```
1566
1812
  </dd>
@@ -1576,7 +1822,7 @@ await client.rcs.getCapabilities({
1576
1822
  <dl>
1577
1823
  <dd>
1578
1824
 
1579
- **request:** `Pinnacle.RcsCapabilitiesQuery`
1825
+ **request:** `Pinnacle.ListPhoneNumbersParams`
1580
1826
 
1581
1827
  </dd>
1582
1828
  </dl>
@@ -1584,7 +1830,7 @@ await client.rcs.getCapabilities({
1584
1830
  <dl>
1585
1831
  <dd>
1586
1832
 
1587
- **requestOptions:** `Rcs.RequestOptions`
1833
+ **requestOptions:** `PhoneNumbers.RequestOptions`
1588
1834
 
1589
1835
  </dd>
1590
1836
  </dl>
@@ -1596,7 +1842,8 @@ await client.rcs.getCapabilities({
1596
1842
  </dl>
1597
1843
  </details>
1598
1844
 
1599
- <details><summary><code>client.rcs.<a href="/src/api/resources/rcs/client/Client.ts">whitelist</a>({ ...params }) -> Pinnacle.RcsWhitelistResponse</code></summary>
1845
+ ## Rcs
1846
+ <details><summary><code>client.rcs.<a href="/src/api/resources/rcs/client/Client.ts">getAgent</a>(agentId) -> Pinnacle.RcsAgentResponse</code></summary>
1600
1847
  <dl>
1601
1848
  <dd>
1602
1849
 
@@ -1608,31 +1855,10 @@ await client.rcs.getCapabilities({
1608
1855
  <dl>
1609
1856
  <dd>
1610
1857
 
1611
- Whitelist a phone number for testing with your test RCS agent.
1612
-
1613
- ## Overview
1614
- During development and testing, RCS agents can only send messages to whitelisted phone numbers.
1615
- Use this endpoint to whitelist specific phone numbers to send and receive messages from the test agent.
1616
-
1617
- ## Verification Process
1618
- After whitelisting a number, you'll need to complete verification:
1858
+ Retrieve details of an RCS agent by its ID.
1619
1859
 
1620
- 1. Check the test device for message from "RBM Tester Management"
1621
- 2. Click the "Make me a tester" button
1622
- 3. Enter the separate 4-digit verification SMS code in the Pinnacle dashboard at:
1623
- ```
1624
- https://app.pinnacle.sh/dashboard/brands/{brandId}?campaignId={campaignId}&campaignType=RCS
1625
- ```
1626
-
1627
- > **⚠️ Important: Re-whitelisting Numbers**
1628
- >
1629
- > If you whitelist a number that's already whitelisted, you'll receive a new message from "RBM Tester Management". **You must click the "Make me a tester" button again to continue sending and receiving messages.**
1630
-
1631
- > **Important Notes**
1632
- >
1633
- > - **Verification required:** Messages cannot be sent nor received until you have clicked the "Make me a tester" button on the test device.
1634
- > - **Testing only:** This is only required for test agents. Production agents can message any RCS-enabled number.
1635
- > - **Network limitations:** Whitelisting may be temporarily unavailable for some carriers but are usually restored shortly.
1860
+ Returns the agent's configuration including display name, description, logo, hero image,
1861
+ contact information, and other settings.
1636
1862
  </dd>
1637
1863
  </dl>
1638
1864
  </dd>
@@ -1647,9 +1873,74 @@ After whitelisting a number, you'll need to complete verification:
1647
1873
  <dd>
1648
1874
 
1649
1875
  ```typescript
1650
- await client.rcs.whitelist({
1651
- agentId: "agent_XXXXXXXXXXXX",
1652
- phoneNumber: "+12345678901"
1876
+ await client.rcs.getAgent("agent_abc123def456");
1877
+
1878
+ ```
1879
+ </dd>
1880
+ </dl>
1881
+ </dd>
1882
+ </dl>
1883
+
1884
+ #### ⚙️ Parameters
1885
+
1886
+ <dl>
1887
+ <dd>
1888
+
1889
+ <dl>
1890
+ <dd>
1891
+
1892
+ **agentId:** `string` — The RCS agent ID (must be prefixed with `agent_`).
1893
+
1894
+ </dd>
1895
+ </dl>
1896
+
1897
+ <dl>
1898
+ <dd>
1899
+
1900
+ **requestOptions:** `Rcs.RequestOptions`
1901
+
1902
+ </dd>
1903
+ </dl>
1904
+ </dd>
1905
+ </dl>
1906
+
1907
+
1908
+ </dd>
1909
+ </dl>
1910
+ </details>
1911
+
1912
+ <details><summary><code>client.rcs.<a href="/src/api/resources/rcs/client/Client.ts">getCapabilities</a>({ ...params }) -> Pinnacle.RcsCapabilitiesResult</code></summary>
1913
+ <dl>
1914
+ <dd>
1915
+
1916
+ #### 📝 Description
1917
+
1918
+ <dl>
1919
+ <dd>
1920
+
1921
+ <dl>
1922
+ <dd>
1923
+
1924
+ Check RCS capabilities for one or more phone numbers.
1925
+
1926
+ This endpoint allows you to verify which RCS features (cards, buttons, etc.) are supported
1927
+ on specific phone numbers before sending RCS messages to them.
1928
+ </dd>
1929
+ </dl>
1930
+ </dd>
1931
+ </dl>
1932
+
1933
+ #### 🔌 Usage
1934
+
1935
+ <dl>
1936
+ <dd>
1937
+
1938
+ <dl>
1939
+ <dd>
1940
+
1941
+ ```typescript
1942
+ await client.rcs.getCapabilities({
1943
+ phoneNumbers: ["+12345678901", "+19876543210"]
1653
1944
  });
1654
1945
 
1655
1946
  ```
@@ -1666,7 +1957,7 @@ await client.rcs.whitelist({
1666
1957
  <dl>
1667
1958
  <dd>
1668
1959
 
1669
- **request:** `Pinnacle.RcsWhitelistRequest`
1960
+ **request:** `Pinnacle.RcsCapabilitiesQuery`
1670
1961
 
1671
1962
  </dd>
1672
1963
  </dl>
@@ -1698,7 +1989,7 @@ await client.rcs.whitelist({
1698
1989
  <dl>
1699
1990
  <dd>
1700
1991
 
1701
- Generate a link for initiating an RCS conversation with your agent.
1992
+ Generate a link for initiating an RCS conversation with your agent.
1702
1993
 
1703
1994
  Users can click these links to start conversations with your RCS agent directly
1704
1995
  from websites, emails, or other applications.
@@ -1718,7 +2009,6 @@ from websites, emails, or other applications.
1718
2009
  ```typescript
1719
2010
  await client.rcs.getLink({
1720
2011
  agentId: "agent_XXXXXXXXXXXX",
1721
- testMode: false,
1722
2012
  phoneNumber: "+12345678901",
1723
2013
  body: "Hello, I need help with my order"
1724
2014
  });
@@ -1819,6 +2109,69 @@ await client.webhooks.get({
1819
2109
  </dl>
1820
2110
 
1821
2111
 
2112
+ </dd>
2113
+ </dl>
2114
+ </details>
2115
+
2116
+ <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">list</a>({ ...params }) -> Pinnacle.ListWebhooksResponse</code></summary>
2117
+ <dl>
2118
+ <dd>
2119
+
2120
+ #### 📝 Description
2121
+
2122
+ <dl>
2123
+ <dd>
2124
+
2125
+ <dl>
2126
+ <dd>
2127
+
2128
+ List all webhooks with optional filtering and pagination. Results are sorted by creation date, newest first.
2129
+ </dd>
2130
+ </dl>
2131
+ </dd>
2132
+ </dl>
2133
+
2134
+ #### 🔌 Usage
2135
+
2136
+ <dl>
2137
+ <dd>
2138
+
2139
+ <dl>
2140
+ <dd>
2141
+
2142
+ ```typescript
2143
+ await client.webhooks.list();
2144
+
2145
+ ```
2146
+ </dd>
2147
+ </dl>
2148
+ </dd>
2149
+ </dl>
2150
+
2151
+ #### ⚙️ Parameters
2152
+
2153
+ <dl>
2154
+ <dd>
2155
+
2156
+ <dl>
2157
+ <dd>
2158
+
2159
+ **request:** `Pinnacle.ListWebhooksParams`
2160
+
2161
+ </dd>
2162
+ </dl>
2163
+
2164
+ <dl>
2165
+ <dd>
2166
+
2167
+ **requestOptions:** `Webhooks.RequestOptions`
2168
+
2169
+ </dd>
2170
+ </dl>
2171
+ </dd>
2172
+ </dl>
2173
+
2174
+
1822
2175
  </dd>
1823
2176
  </dl>
1824
2177
  </details>
@@ -2331,6 +2684,69 @@ await client.campaigns.dlc.validate({
2331
2684
  </dl>
2332
2685
 
2333
2686
 
2687
+ </dd>
2688
+ </dl>
2689
+ </details>
2690
+
2691
+ <details><summary><code>client.campaigns.dlc.<a href="/src/api/resources/campaigns/resources/dlc/client/Client.ts">list</a>({ ...params }) -> Pinnacle.ListDlcCampaignsResponse</code></summary>
2692
+ <dl>
2693
+ <dd>
2694
+
2695
+ #### 📝 Description
2696
+
2697
+ <dl>
2698
+ <dd>
2699
+
2700
+ <dl>
2701
+ <dd>
2702
+
2703
+ List all 10DLC campaigns with optional filtering and pagination. Results are sorted by creation date, newest first.
2704
+ </dd>
2705
+ </dl>
2706
+ </dd>
2707
+ </dl>
2708
+
2709
+ #### 🔌 Usage
2710
+
2711
+ <dl>
2712
+ <dd>
2713
+
2714
+ <dl>
2715
+ <dd>
2716
+
2717
+ ```typescript
2718
+ await client.campaigns.dlc.list();
2719
+
2720
+ ```
2721
+ </dd>
2722
+ </dl>
2723
+ </dd>
2724
+ </dl>
2725
+
2726
+ #### ⚙️ Parameters
2727
+
2728
+ <dl>
2729
+ <dd>
2730
+
2731
+ <dl>
2732
+ <dd>
2733
+
2734
+ **request:** `Pinnacle.campaigns.ListDlcCampaignsParams`
2735
+
2736
+ </dd>
2737
+ </dl>
2738
+
2739
+ <dl>
2740
+ <dd>
2741
+
2742
+ **requestOptions:** `Dlc.RequestOptions`
2743
+
2744
+ </dd>
2745
+ </dl>
2746
+ </dd>
2747
+ </dl>
2748
+
2749
+
2334
2750
  </dd>
2335
2751
  </dl>
2336
2752
  </details>
@@ -2694,6 +3110,69 @@ await client.campaigns.tollFree.validate({
2694
3110
  </dl>
2695
3111
 
2696
3112
 
3113
+ </dd>
3114
+ </dl>
3115
+ </details>
3116
+
3117
+ <details><summary><code>client.campaigns.tollFree.<a href="/src/api/resources/campaigns/resources/tollFree/client/Client.ts">list</a>({ ...params }) -> Pinnacle.ListTollFreeCampaignsResponse</code></summary>
3118
+ <dl>
3119
+ <dd>
3120
+
3121
+ #### 📝 Description
3122
+
3123
+ <dl>
3124
+ <dd>
3125
+
3126
+ <dl>
3127
+ <dd>
3128
+
3129
+ List all toll-free campaigns with optional filtering and pagination. Results are sorted by creation date, newest first.
3130
+ </dd>
3131
+ </dl>
3132
+ </dd>
3133
+ </dl>
3134
+
3135
+ #### 🔌 Usage
3136
+
3137
+ <dl>
3138
+ <dd>
3139
+
3140
+ <dl>
3141
+ <dd>
3142
+
3143
+ ```typescript
3144
+ await client.campaigns.tollFree.list();
3145
+
3146
+ ```
3147
+ </dd>
3148
+ </dl>
3149
+ </dd>
3150
+ </dl>
3151
+
3152
+ #### ⚙️ Parameters
3153
+
3154
+ <dl>
3155
+ <dd>
3156
+
3157
+ <dl>
3158
+ <dd>
3159
+
3160
+ **request:** `Pinnacle.campaigns.ListTollFreeCampaignsParams`
3161
+
3162
+ </dd>
3163
+ </dl>
3164
+
3165
+ <dl>
3166
+ <dd>
3167
+
3168
+ **requestOptions:** `TollFree.RequestOptions`
3169
+
3170
+ </dd>
3171
+ </dl>
3172
+ </dd>
3173
+ </dl>
3174
+
3175
+
2697
3176
  </dd>
2698
3177
  </dl>
2699
3178
  </details>
@@ -3085,8 +3564,7 @@ await client.campaigns.rcs.validate({
3085
3564
  </dl>
3086
3565
  </details>
3087
3566
 
3088
- ## Messages Sms
3089
- <details><summary><code>client.messages.sms.<a href="/src/api/resources/messages/resources/sms/client/Client.ts">send</a>({ ...params }) -> Pinnacle.SmsSendResponse</code></summary>
3567
+ <details><summary><code>client.campaigns.rcs.<a href="/src/api/resources/campaigns/resources/rcs/client/Client.ts">list</a>({ ...params }) -> Pinnacle.ListRcsCampaignsResponse</code></summary>
3090
3568
  <dl>
3091
3569
  <dd>
3092
3570
 
@@ -3098,7 +3576,7 @@ await client.campaigns.rcs.validate({
3098
3576
  <dl>
3099
3577
  <dd>
3100
3578
 
3101
- Send a SMS message immediately or schedule it for future delivery.
3579
+ List all RCS campaigns with optional filtering and pagination. Results are sorted by creation date, newest first.
3102
3580
  </dd>
3103
3581
  </dl>
3104
3582
  </dd>
@@ -3113,11 +3591,7 @@ Send a SMS message immediately or schedule it for future delivery.
3113
3591
  <dd>
3114
3592
 
3115
3593
  ```typescript
3116
- await client.messages.sms.send({
3117
- from: "+14155164736",
3118
- text: "Hey!",
3119
- to: "+14154746461"
3120
- });
3594
+ await client.campaigns.rcs.list();
3121
3595
 
3122
3596
  ```
3123
3597
  </dd>
@@ -3133,7 +3607,7 @@ await client.messages.sms.send({
3133
3607
  <dl>
3134
3608
  <dd>
3135
3609
 
3136
- **request:** `Pinnacle.messages.Sms`
3610
+ **request:** `Pinnacle.campaigns.ListRcsCampaignsParams`
3137
3611
 
3138
3612
  </dd>
3139
3613
  </dl>
@@ -3141,7 +3615,75 @@ await client.messages.sms.send({
3141
3615
  <dl>
3142
3616
  <dd>
3143
3617
 
3144
- **requestOptions:** `Sms.RequestOptions`
3618
+ **requestOptions:** `Rcs.RequestOptions`
3619
+
3620
+ </dd>
3621
+ </dl>
3622
+ </dd>
3623
+ </dl>
3624
+
3625
+
3626
+ </dd>
3627
+ </dl>
3628
+ </details>
3629
+
3630
+ ## Messages Sms
3631
+ <details><summary><code>client.messages.sms.<a href="/src/api/resources/messages/resources/sms/client/Client.ts">send</a>({ ...params }) -> Pinnacle.SmsSendResponse</code></summary>
3632
+ <dl>
3633
+ <dd>
3634
+
3635
+ #### 📝 Description
3636
+
3637
+ <dl>
3638
+ <dd>
3639
+
3640
+ <dl>
3641
+ <dd>
3642
+
3643
+ Send a SMS message immediately or schedule it for future delivery.
3644
+ </dd>
3645
+ </dl>
3646
+ </dd>
3647
+ </dl>
3648
+
3649
+ #### 🔌 Usage
3650
+
3651
+ <dl>
3652
+ <dd>
3653
+
3654
+ <dl>
3655
+ <dd>
3656
+
3657
+ ```typescript
3658
+ await client.messages.sms.send({
3659
+ from: "+14155164736",
3660
+ text: "Hey!",
3661
+ to: "+14154746461"
3662
+ });
3663
+
3664
+ ```
3665
+ </dd>
3666
+ </dl>
3667
+ </dd>
3668
+ </dl>
3669
+
3670
+ #### ⚙️ Parameters
3671
+
3672
+ <dl>
3673
+ <dd>
3674
+
3675
+ <dl>
3676
+ <dd>
3677
+
3678
+ **request:** `Pinnacle.messages.Sms`
3679
+
3680
+ </dd>
3681
+ </dl>
3682
+
3683
+ <dl>
3684
+ <dd>
3685
+
3686
+ **requestOptions:** `Sms.RequestOptions`
3145
3687
 
3146
3688
  </dd>
3147
3689
  </dl>
@@ -3471,10 +4013,7 @@ This endpoint allows RCS agents to display a typing indicator to recipients. The
3471
4013
  ```typescript
3472
4014
  await client.messages.rcs.sendTyping({
3473
4015
  agentId: "agent_pinnacle",
3474
- to: "+14154746461",
3475
- options: {
3476
- test_mode: false
3477
- }
4016
+ to: "+14154746461"
3478
4017
  });
3479
4018
 
3480
4019
  ```
@@ -3884,8 +4423,8 @@ await client.messages.schedule.cancel("id");
3884
4423
  </dl>
3885
4424
  </details>
3886
4425
 
3887
- ## PhoneNumbers Webhook
3888
- <details><summary><code>client.phoneNumbers.webhook.<a href="/src/api/resources/phoneNumbers/resources/webhook/client/Client.ts">attach</a>(phone, { ...params }) -> Pinnacle.ConfiguredWebhook</code></summary>
4426
+ ## Messages Schedules
4427
+ <details><summary><code>client.messages.schedules.<a href="/src/api/resources/messages/resources/schedules/client/Client.ts">list</a>({ ...params }) -> Pinnacle.ListScheduledMessagesResponse</code></summary>
3889
4428
  <dl>
3890
4429
  <dd>
3891
4430
 
@@ -3897,7 +4436,7 @@ await client.messages.schedule.cancel("id");
3897
4436
  <dl>
3898
4437
  <dd>
3899
4438
 
3900
- Connect a webhook to your phone number to receive real-time notifications for incoming messages, delivery status updates, and other communication events.
4439
+ List all scheduled messages with optional filtering and pagination. Results are sorted by creation date, newest first.
3901
4440
  </dd>
3902
4441
  </dl>
3903
4442
  </dd>
@@ -3912,10 +4451,7 @@ Connect a webhook to your phone number to receive real-time notifications for in
3912
4451
  <dd>
3913
4452
 
3914
4453
  ```typescript
3915
- await client.phoneNumbers.webhook.attach("%2B14155551234", {
3916
- webhookId: "wh_1234567890",
3917
- event: "MESSAGE.STATUS"
3918
- });
4454
+ await client.messages.schedules.list();
3919
4455
 
3920
4456
  ```
3921
4457
  </dd>
@@ -3931,19 +4467,7 @@ await client.phoneNumbers.webhook.attach("%2B14155551234", {
3931
4467
  <dl>
3932
4468
  <dd>
3933
4469
 
3934
- **phone:** `string`
3935
-
3936
- The phone number you want to attach the webhook to in E.164 format. Make sure it is url encoded (i.e. replace the leading + with %2B). <br>
3937
-
3938
- Must be a phone number that you own and have already [purchased](./buy) through the API. A phone number can have multiple webhooks attached to it.
3939
-
3940
- </dd>
3941
- </dl>
3942
-
3943
- <dl>
3944
- <dd>
3945
-
3946
- **request:** `Pinnacle.AttachWebhookParams`
4470
+ **request:** `Pinnacle.messages.ListScheduledMessagesParams`
3947
4471
 
3948
4472
  </dd>
3949
4473
  </dl>
@@ -3951,7 +4475,7 @@ Must be a phone number that you own and have already [purchased](./buy) through
3951
4475
  <dl>
3952
4476
  <dd>
3953
4477
 
3954
- **requestOptions:** `Webhook.RequestOptions`
4478
+ **requestOptions:** `Schedules.RequestOptions`
3955
4479
 
3956
4480
  </dd>
3957
4481
  </dl>
@@ -3963,7 +4487,8 @@ Must be a phone number that you own and have already [purchased](./buy) through
3963
4487
  </dl>
3964
4488
  </details>
3965
4489
 
3966
- <details><summary><code>client.phoneNumbers.webhook.<a href="/src/api/resources/phoneNumbers/resources/webhook/client/Client.ts">detach</a>(phone, webhookId) -> Pinnacle.DetachedWebhookInfo</code></summary>
4490
+ ## Messages Blasts
4491
+ <details><summary><code>client.messages.blasts.<a href="/src/api/resources/messages/resources/blasts/client/Client.ts">list</a>({ ...params }) -> Pinnacle.ListBlastsResponse</code></summary>
3967
4492
  <dl>
3968
4493
  <dd>
3969
4494
 
@@ -3975,9 +4500,7 @@ Must be a phone number that you own and have already [purchased](./buy) through
3975
4500
  <dl>
3976
4501
  <dd>
3977
4502
 
3978
- Disconnect a webhook from your phone number to stop receiving event notifications for that specific number. <br>
3979
-
3980
- The webhook configuration itself remains intact and available for use with other phone numbers.
4503
+ List all blasts with optional filtering and pagination. Results are sorted by creation date, newest first.
3981
4504
  </dd>
3982
4505
  </dl>
3983
4506
  </dd>
@@ -3992,7 +4515,7 @@ The webhook configuration itself remains intact and available for use with other
3992
4515
  <dd>
3993
4516
 
3994
4517
  ```typescript
3995
- await client.phoneNumbers.webhook.detach("+14155551234", "wh_1234567890");
4518
+ await client.messages.blasts.list();
3996
4519
 
3997
4520
  ```
3998
4521
  </dd>
@@ -4008,23 +4531,7 @@ await client.phoneNumbers.webhook.detach("+14155551234", "wh_1234567890");
4008
4531
  <dl>
4009
4532
  <dd>
4010
4533
 
4011
- **phone:** `string`
4012
-
4013
- The phone number you want to attach the webhook to in E.164 format. Make sure it is url encoded (i.e. replace the leading + with %2B). <br>
4014
-
4015
- Must be a phone number that you own and currently has the specified webhook attached.
4016
-
4017
- </dd>
4018
- </dl>
4019
-
4020
- <dl>
4021
- <dd>
4022
-
4023
- **webhookId:** `string`
4024
-
4025
- The unique identifier of the webhook you want to detach from the phone number. <br>
4026
-
4027
- This must be a valid webhook ID that is currently attached to the specified phone number. This identifier is a string that always begins with the prefix `wh_`, for example: `wh_1234567890`.
4534
+ **request:** `Pinnacle.messages.ListBlastsParams`
4028
4535
 
4029
4536
  </dd>
4030
4537
  </dl>
@@ -4032,7 +4539,7 @@ This must be a valid webhook ID that is currently attached to the specified phon
4032
4539
  <dl>
4033
4540
  <dd>
4034
4541
 
4035
- **requestOptions:** `Webhook.RequestOptions`
4542
+ **requestOptions:** `Blasts.RequestOptions`
4036
4543
 
4037
4544
  </dd>
4038
4545
  </dl>
@@ -4044,8 +4551,8 @@ This must be a valid webhook ID that is currently attached to the specified phon
4044
4551
  </dl>
4045
4552
  </details>
4046
4553
 
4047
- ## PhoneNumbers Campaign
4048
- <details><summary><code>client.phoneNumbers.campaign.<a href="/src/api/resources/phoneNumbers/resources/campaign/client/Client.ts">attach</a>({ ...params }) -> Pinnacle.AttachedPhoneNumberResult</code></summary>
4554
+ ## PhoneNumbers Webhook
4555
+ <details><summary><code>client.phoneNumbers.webhook.<a href="/src/api/resources/phoneNumbers/resources/webhook/client/Client.ts">attach</a>(phone, { ...params }) -> Pinnacle.ConfiguredWebhook</code></summary>
4049
4556
  <dl>
4050
4557
  <dd>
4051
4558
 
@@ -4057,7 +4564,7 @@ This must be a valid webhook ID that is currently attached to the specified phon
4057
4564
  <dl>
4058
4565
  <dd>
4059
4566
 
4060
- Link a phone number to a specific campaign. Phone numbers must be linked to a campaign to send messages.
4567
+ Connect a webhook to your phone number to receive real-time notifications for incoming messages, delivery status updates, and other communication events.
4061
4568
  </dd>
4062
4569
  </dl>
4063
4570
  </dd>
@@ -4072,10 +4579,9 @@ Link a phone number to a specific campaign. Phone numbers must be linked to a ca
4072
4579
  <dd>
4073
4580
 
4074
4581
  ```typescript
4075
- await client.phoneNumbers.campaign.attach({
4076
- phones: ["+14155550123", "+14155559876", "+14155550111"],
4077
- campaignType: "TOLL_FREE",
4078
- campaignId: "tf_1234567890"
4582
+ await client.phoneNumbers.webhook.attach("%2B14155551234", {
4583
+ webhookId: "wh_1234567890",
4584
+ event: "MESSAGE.STATUS"
4079
4585
  });
4080
4586
 
4081
4587
  ```
@@ -4092,7 +4598,11 @@ await client.phoneNumbers.campaign.attach({
4092
4598
  <dl>
4093
4599
  <dd>
4094
4600
 
4095
- **request:** `Pinnacle.phoneNumbers.AttachCampaignParams`
4601
+ **phone:** `string`
4602
+
4603
+ The phone number you want to attach the webhook to in E.164 format. Make sure it is url encoded (i.e. replace the leading + with %2B). <br>
4604
+
4605
+ Must be a phone number that you own and have already [purchased](./buy) through the API. A phone number can have multiple webhooks attached to it.
4096
4606
 
4097
4607
  </dd>
4098
4608
  </dl>
@@ -4100,7 +4610,15 @@ await client.phoneNumbers.campaign.attach({
4100
4610
  <dl>
4101
4611
  <dd>
4102
4612
 
4103
- **requestOptions:** `Campaign.RequestOptions`
4613
+ **request:** `Pinnacle.AttachWebhookParams`
4614
+
4615
+ </dd>
4616
+ </dl>
4617
+
4618
+ <dl>
4619
+ <dd>
4620
+
4621
+ **requestOptions:** `Webhook.RequestOptions`
4104
4622
 
4105
4623
  </dd>
4106
4624
  </dl>
@@ -4112,7 +4630,7 @@ await client.phoneNumbers.campaign.attach({
4112
4630
  </dl>
4113
4631
  </details>
4114
4632
 
4115
- <details><summary><code>client.phoneNumbers.campaign.<a href="/src/api/resources/phoneNumbers/resources/campaign/client/Client.ts">detach</a>({ ...params }) -> Pinnacle.DetachedPhoneNumberResult</code></summary>
4633
+ <details><summary><code>client.phoneNumbers.webhook.<a href="/src/api/resources/phoneNumbers/resources/webhook/client/Client.ts">detach</a>(phone, webhookId) -> Pinnacle.DetachedWebhookInfo</code></summary>
4116
4634
  <dl>
4117
4635
  <dd>
4118
4636
 
@@ -4124,7 +4642,9 @@ await client.phoneNumbers.campaign.attach({
4124
4642
  <dl>
4125
4643
  <dd>
4126
4644
 
4127
- Remove the association between a phone number and its attached campaign.
4645
+ Disconnect a webhook from your phone number to stop receiving event notifications for that specific number. <br>
4646
+
4647
+ The webhook configuration itself remains intact and available for use with other phone numbers.
4128
4648
  </dd>
4129
4649
  </dl>
4130
4650
  </dd>
@@ -4139,9 +4659,7 @@ Remove the association between a phone number and its attached campaign.
4139
4659
  <dd>
4140
4660
 
4141
4661
  ```typescript
4142
- await client.phoneNumbers.campaign.detach({
4143
- phones: ["+14155559876", "14155550111"]
4144
- });
4662
+ await client.phoneNumbers.webhook.detach("+14155551234", "wh_1234567890");
4145
4663
 
4146
4664
  ```
4147
4665
  </dd>
@@ -4157,7 +4675,11 @@ await client.phoneNumbers.campaign.detach({
4157
4675
  <dl>
4158
4676
  <dd>
4159
4677
 
4160
- **request:** `Pinnacle.phoneNumbers.DetachCampaignParams`
4678
+ **phone:** `string`
4679
+
4680
+ The phone number you want to attach the webhook to in E.164 format. Make sure it is url encoded (i.e. replace the leading + with %2B). <br>
4681
+
4682
+ Must be a phone number that you own and currently has the specified webhook attached.
4161
4683
 
4162
4684
  </dd>
4163
4685
  </dl>
@@ -4165,7 +4687,19 @@ await client.phoneNumbers.campaign.detach({
4165
4687
  <dl>
4166
4688
  <dd>
4167
4689
 
4168
- **requestOptions:** `Campaign.RequestOptions`
4690
+ **webhookId:** `string`
4691
+
4692
+ The unique identifier of the webhook you want to detach from the phone number. <br>
4693
+
4694
+ This must be a valid webhook ID that is currently attached to the specified phone number. This identifier is a string that always begins with the prefix `wh_`, for example: `wh_1234567890`.
4695
+
4696
+ </dd>
4697
+ </dl>
4698
+
4699
+ <dl>
4700
+ <dd>
4701
+
4702
+ **requestOptions:** `Webhook.RequestOptions`
4169
4703
 
4170
4704
  </dd>
4171
4705
  </dl>
@@ -4177,8 +4711,8 @@ await client.phoneNumbers.campaign.detach({
4177
4711
  </dl>
4178
4712
  </details>
4179
4713
 
4180
- ## Status Get
4181
- <details><summary><code>client.status.get.<a href="/src/api/resources/status/resources/get/client/Client.ts">brand</a>(brandId) -> Pinnacle.BrandStatus</code></summary>
4714
+ ## PhoneNumbers Campaign
4715
+ <details><summary><code>client.phoneNumbers.campaign.<a href="/src/api/resources/phoneNumbers/resources/campaign/client/Client.ts">attach</a>({ ...params }) -> Pinnacle.AttachedPhoneNumberResult</code></summary>
4182
4716
  <dl>
4183
4717
  <dd>
4184
4718
 
@@ -4190,7 +4724,7 @@ await client.phoneNumbers.campaign.detach({
4190
4724
  <dl>
4191
4725
  <dd>
4192
4726
 
4193
- Retrieve a brand's status.
4727
+ Link a phone number to a specific campaign. Phone numbers must be linked to a campaign to send messages.
4194
4728
  </dd>
4195
4729
  </dl>
4196
4730
  </dd>
@@ -4205,7 +4739,11 @@ Retrieve a brand's status.
4205
4739
  <dd>
4206
4740
 
4207
4741
  ```typescript
4208
- await client.status.get.brand("b_1234567890");
4742
+ await client.phoneNumbers.campaign.attach({
4743
+ phones: ["+14155550123", "+14155559876", "+14155550111"],
4744
+ campaignType: "TOLL_FREE",
4745
+ campaignId: "tf_1234567890"
4746
+ });
4209
4747
 
4210
4748
  ```
4211
4749
  </dd>
@@ -4221,7 +4759,7 @@ await client.status.get.brand("b_1234567890");
4221
4759
  <dl>
4222
4760
  <dd>
4223
4761
 
4224
- **brandId:** `string` — The unique identifier of the brand you want to retrieve the status for. This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`.
4762
+ **request:** `Pinnacle.phoneNumbers.AttachCampaignParams`
4225
4763
 
4226
4764
  </dd>
4227
4765
  </dl>
@@ -4229,7 +4767,7 @@ await client.status.get.brand("b_1234567890");
4229
4767
  <dl>
4230
4768
  <dd>
4231
4769
 
4232
- **requestOptions:** `Get.RequestOptions`
4770
+ **requestOptions:** `Campaign.RequestOptions`
4233
4771
 
4234
4772
  </dd>
4235
4773
  </dl>
@@ -4241,7 +4779,7 @@ await client.status.get.brand("b_1234567890");
4241
4779
  </dl>
4242
4780
  </details>
4243
4781
 
4244
- <details><summary><code>client.status.get.<a href="/src/api/resources/status/resources/get/client/Client.ts">tollFree</a>(campaignId) -> Pinnacle.TollFreeCampaignStatus</code></summary>
4782
+ <details><summary><code>client.phoneNumbers.campaign.<a href="/src/api/resources/phoneNumbers/resources/campaign/client/Client.ts">detach</a>({ ...params }) -> Pinnacle.DetachedPhoneNumberResult</code></summary>
4245
4783
  <dl>
4246
4784
  <dd>
4247
4785
 
@@ -4253,7 +4791,7 @@ await client.status.get.brand("b_1234567890");
4253
4791
  <dl>
4254
4792
  <dd>
4255
4793
 
4256
- Retrieve a toll-free campaign's status.
4794
+ Remove the association between a phone number and its attached campaign.
4257
4795
  </dd>
4258
4796
  </dl>
4259
4797
  </dd>
@@ -4268,7 +4806,9 @@ Retrieve a toll-free campaign's status.
4268
4806
  <dd>
4269
4807
 
4270
4808
  ```typescript
4271
- await client.status.get.tollFree("tf_1234567890");
4809
+ await client.phoneNumbers.campaign.detach({
4810
+ phones: ["+14155559876", "14155550111"]
4811
+ });
4272
4812
 
4273
4813
  ```
4274
4814
  </dd>
@@ -4284,7 +4824,7 @@ await client.status.get.tollFree("tf_1234567890");
4284
4824
  <dl>
4285
4825
  <dd>
4286
4826
 
4287
- **campaignId:** `string` — The unique identifier of the toll-free campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `tf_`, for example: `tf_1234567890`.
4827
+ **request:** `Pinnacle.phoneNumbers.DetachCampaignParams`
4288
4828
 
4289
4829
  </dd>
4290
4830
  </dl>
@@ -4292,7 +4832,7 @@ await client.status.get.tollFree("tf_1234567890");
4292
4832
  <dl>
4293
4833
  <dd>
4294
4834
 
4295
- **requestOptions:** `Get.RequestOptions`
4835
+ **requestOptions:** `Campaign.RequestOptions`
4296
4836
 
4297
4837
  </dd>
4298
4838
  </dl>
@@ -4304,7 +4844,8 @@ await client.status.get.tollFree("tf_1234567890");
4304
4844
  </dl>
4305
4845
  </details>
4306
4846
 
4307
- <details><summary><code>client.status.get.<a href="/src/api/resources/status/resources/get/client/Client.ts">dlc</a>(campaignId) -> Pinnacle.DlcCampaignStatus</code></summary>
4847
+ ## Rcs Agents
4848
+ <details><summary><code>client.rcs.agents.<a href="/src/api/resources/rcs/resources/agents/client/Client.ts">list</a>({ ...params }) -> Pinnacle.ListAgentsResponse</code></summary>
4308
4849
  <dl>
4309
4850
  <dd>
4310
4851
 
@@ -4316,7 +4857,7 @@ await client.status.get.tollFree("tf_1234567890");
4316
4857
  <dl>
4317
4858
  <dd>
4318
4859
 
4319
- Retrieve a 10DLC campaign's status.
4860
+ List all RCS agents with pagination. Results are sorted by creation date, newest first.
4320
4861
  </dd>
4321
4862
  </dl>
4322
4863
  </dd>
@@ -4331,7 +4872,7 @@ Retrieve a 10DLC campaign's status.
4331
4872
  <dd>
4332
4873
 
4333
4874
  ```typescript
4334
- await client.status.get.dlc("dlc_1234567890");
4875
+ await client.rcs.agents.list();
4335
4876
 
4336
4877
  ```
4337
4878
  </dd>
@@ -4347,7 +4888,7 @@ await client.status.get.dlc("dlc_1234567890");
4347
4888
  <dl>
4348
4889
  <dd>
4349
4890
 
4350
- **campaignId:** `string` — The unique identifier of the 10DLC campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`.
4891
+ **request:** `Pinnacle.rcs.ListAgentsParams`
4351
4892
 
4352
4893
  </dd>
4353
4894
  </dl>
@@ -4355,7 +4896,7 @@ await client.status.get.dlc("dlc_1234567890");
4355
4896
  <dl>
4356
4897
  <dd>
4357
4898
 
4358
- **requestOptions:** `Get.RequestOptions`
4899
+ **requestOptions:** `Agents.RequestOptions`
4359
4900
 
4360
4901
  </dd>
4361
4902
  </dl>
@@ -4367,7 +4908,8 @@ await client.status.get.dlc("dlc_1234567890");
4367
4908
  </dl>
4368
4909
  </details>
4369
4910
 
4370
- <details><summary><code>client.status.get.<a href="/src/api/resources/status/resources/get/client/Client.ts">rcs</a>(campaignId) -> Pinnacle.RcsCampaignStatus</code></summary>
4911
+ ## Rcs WhitelistedNumbers
4912
+ <details><summary><code>client.rcs.whitelistedNumbers.<a href="/src/api/resources/rcs/resources/whitelistedNumbers/client/Client.ts">list</a>({ ...params }) -> Pinnacle.ListTestNumbersResponse</code></summary>
4371
4913
  <dl>
4372
4914
  <dd>
4373
4915
 
@@ -4379,7 +4921,7 @@ await client.status.get.dlc("dlc_1234567890");
4379
4921
  <dl>
4380
4922
  <dd>
4381
4923
 
4382
- Retrieve a RCS campaign's status.
4924
+ List all whitelisted test numbers with optional filtering and pagination. Results are sorted by creation date, newest first.
4383
4925
  </dd>
4384
4926
  </dl>
4385
4927
  </dd>
@@ -4394,7 +4936,7 @@ Retrieve a RCS campaign's status.
4394
4936
  <dd>
4395
4937
 
4396
4938
  ```typescript
4397
- await client.status.get.rcs("rcs_1234567890");
4939
+ await client.rcs.whitelistedNumbers.list();
4398
4940
 
4399
4941
  ```
4400
4942
  </dd>
@@ -4410,7 +4952,7 @@ await client.status.get.rcs("rcs_1234567890");
4410
4952
  <dl>
4411
4953
  <dd>
4412
4954
 
4413
- **campaignId:** `string` — The unique identifier of the RCS campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `rcs_`, for example: `rcs_1234567890`.
4955
+ **request:** `Pinnacle.rcs.ListTestNumbersParams`
4414
4956
 
4415
4957
  </dd>
4416
4958
  </dl>
@@ -4418,7 +4960,7 @@ await client.status.get.rcs("rcs_1234567890");
4418
4960
  <dl>
4419
4961
  <dd>
4420
4962
 
4421
- **requestOptions:** `Get.RequestOptions`
4963
+ **requestOptions:** `WhitelistedNumbers.RequestOptions`
4422
4964
 
4423
4965
  </dd>
4424
4966
  </dl>
@@ -4430,7 +4972,8 @@ await client.status.get.rcs("rcs_1234567890");
4430
4972
  </dl>
4431
4973
  </details>
4432
4974
 
4433
- <details><summary><code>client.status.get.<a href="/src/api/resources/status/resources/get/client/Client.ts">phoneNumber</a>(phoneNumber) -> Pinnacle.PhoneNumberStatus</code></summary>
4975
+ ## Rcs Test
4976
+ <details><summary><code>client.rcs.test.<a href="/src/api/resources/rcs/resources/test/client/Client.ts">createAgent</a>({ ...params }) -> Pinnacle.TestAgentResponse</code></summary>
4434
4977
  <dl>
4435
4978
  <dd>
4436
4979
 
@@ -4442,9 +4985,37 @@ await client.status.get.rcs("rcs_1234567890");
4442
4985
  <dl>
4443
4986
  <dd>
4444
4987
 
4445
- Retrieve a phone number's order status and campaign attachment status. <br>
4988
+ Create a new RCS test agent for development and testing.
4446
4989
 
4447
- Check if a number is active and ready to send messages.
4990
+ ## Overview
4991
+
4992
+ Test agents let you build and test full RCS functionality — rich cards, carousels, buttons,
4993
+ quick replies, and media messages — without going through the full carrier review process.
4994
+ Messages from test agents can only be sent to [whitelisted phone numbers](/api-reference/rcs-agents/test/whitelist-number).
4995
+
4996
+ ## Limits
4997
+
4998
+ - **Maximum 5 test agents per account.**
4999
+
5000
+ ## Image Requirements
5001
+
5002
+ | Image | Format | Max Size |
5003
+ |-------|--------|----------|
5004
+ | Logo | JPEG, PNG | 50 KB |
5005
+ | Hero | JPEG, PNG | 200 KB |
5006
+
5007
+ ## After Creation
5008
+
5009
+ Once your test agent is created, you'll need to:
5010
+
5011
+ 1. **Whitelist test phone numbers** using [`POST /rcs/test/agents/{agentId}/whitelist`](/api-reference/rcs-agents/test/whitelist-number).
5012
+ 2. **Accept the tester invite** on each whitelisted device.
5013
+ 3. **Send messages** using [`POST /messages/send/rcs`](/api-reference/messages/send-rcs) with the returned agent ID as the `from` field.
5014
+
5015
+ > **2-Minute Cooldown**
5016
+ >
5017
+ > After creating a test agent, there is a mandatory 2-minute cooldown before you can whitelist phone numbers.
5018
+ > This is a requirement imposed by Google's RBM platform.
4448
5019
  </dd>
4449
5020
  </dl>
4450
5021
  </dd>
@@ -4459,7 +5030,29 @@ Check if a number is active and ready to send messages.
4459
5030
  <dd>
4460
5031
 
4461
5032
  ```typescript
4462
- await client.status.get.phoneNumber("+14151234567");
5033
+ await client.rcs.test.createAgent({
5034
+ displayName: "Acme Support",
5035
+ description: "Get help with your Acme orders and account",
5036
+ logoUrl: "https://example.com/logo.png",
5037
+ heroUrl: "https://example.com/hero.png",
5038
+ phoneNumbers: [{
5039
+ number: "+14155550123",
5040
+ label: "Support"
5041
+ }],
5042
+ emails: [{
5043
+ address: "support@example.com",
5044
+ label: "Support"
5045
+ }],
5046
+ websites: [{
5047
+ url: "https://example.com",
5048
+ label: "Website"
5049
+ }],
5050
+ privacyUrl: "https://example.com/privacy",
5051
+ termsUrl: "https://example.com/terms",
5052
+ color: "#FF6B00",
5053
+ isConversational: true,
5054
+ agentUseCase: "MULTI_USE"
5055
+ });
4463
5056
 
4464
5057
  ```
4465
5058
  </dd>
@@ -4475,7 +5068,7 @@ await client.status.get.phoneNumber("+14151234567");
4475
5068
  <dl>
4476
5069
  <dd>
4477
5070
 
4478
- **phoneNumber:** `string` — Phone number in E164 format that is in review.
5071
+ **request:** `Pinnacle.rcs.CreateTestAgentRequest`
4479
5072
 
4480
5073
  </dd>
4481
5074
  </dl>
@@ -4483,7 +5076,7 @@ await client.status.get.phoneNumber("+14151234567");
4483
5076
  <dl>
4484
5077
  <dd>
4485
5078
 
4486
- **requestOptions:** `Get.RequestOptions`
5079
+ **requestOptions:** `Test.RequestOptions`
4487
5080
 
4488
5081
  </dd>
4489
5082
  </dl>
@@ -4495,8 +5088,7 @@ await client.status.get.phoneNumber("+14151234567");
4495
5088
  </dl>
4496
5089
  </details>
4497
5090
 
4498
- ## Tools Url
4499
- <details><summary><code>client.tools.url.<a href="/src/api/resources/tools/resources/url/client/Client.ts">create</a>({ ...params }) -> Pinnacle.ShortenedUrl</code></summary>
5091
+ <details><summary><code>client.rcs.test.<a href="/src/api/resources/rcs/resources/test/client/Client.ts">updateAgent</a>(agentId, { ...params }) -> Pinnacle.TestAgentResponse</code></summary>
4500
5092
  <dl>
4501
5093
  <dd>
4502
5094
 
@@ -4508,7 +5100,23 @@ await client.status.get.phoneNumber("+14151234567");
4508
5100
  <dl>
4509
5101
  <dd>
4510
5102
 
4511
- Create a shortened URL that redirects visitors to the provided destination URL.
5103
+ Update an existing RCS test agent's configuration.
5104
+
5105
+ All fields are optional — only include the fields you want to update.
5106
+
5107
+ ## Image Requirements
5108
+
5109
+ If updating images, the same requirements apply as when creating an agent:
5110
+
5111
+ | Image | Format | Max Size |
5112
+ |-------|--------|----------|
5113
+ | Logo | JPEG, PNG | 50 KB |
5114
+ | Hero | JPEG, PNG | 200 KB |
5115
+
5116
+ > **2-Minute Cooldown**
5117
+ >
5118
+ > After updating a test agent, there is a mandatory 2-minute cooldown before you can whitelist phone numbers.
5119
+ > This is a requirement imposed by Google's RBM platform.
4512
5120
  </dd>
4513
5121
  </dl>
4514
5122
  </dd>
@@ -4523,11 +5131,8 @@ Create a shortened URL that redirects visitors to the provided destination URL.
4523
5131
  <dd>
4524
5132
 
4525
5133
  ```typescript
4526
- await client.tools.url.create({
4527
- url: "https://www.pinnacle.sh/",
4528
- options: {
4529
- expiresAt: "2025-06-23T16:18:25.000Z"
4530
- }
5134
+ await client.rcs.test.updateAgent("agent_abc123def456", {
5135
+ displayName: "Acme Premium Support"
4531
5136
  });
4532
5137
 
4533
5138
  ```
@@ -4544,7 +5149,7 @@ await client.tools.url.create({
4544
5149
  <dl>
4545
5150
  <dd>
4546
5151
 
4547
- **request:** `Pinnacle.tools.CreateUrlParams`
5152
+ **agentId:** `string` — The RCS agent ID (must be prefixed with `agent_`).
4548
5153
 
4549
5154
  </dd>
4550
5155
  </dl>
@@ -4552,12 +5157,602 @@ await client.tools.url.create({
4552
5157
  <dl>
4553
5158
  <dd>
4554
5159
 
4555
- **requestOptions:** `Url.RequestOptions`
5160
+ **request:** `Pinnacle.rcs.UpdateTestAgentRequest`
4556
5161
 
4557
5162
  </dd>
4558
5163
  </dl>
4559
- </dd>
4560
- </dl>
5164
+
5165
+ <dl>
5166
+ <dd>
5167
+
5168
+ **requestOptions:** `Test.RequestOptions`
5169
+
5170
+ </dd>
5171
+ </dl>
5172
+ </dd>
5173
+ </dl>
5174
+
5175
+
5176
+ </dd>
5177
+ </dl>
5178
+ </details>
5179
+
5180
+ <details><summary><code>client.rcs.test.<a href="/src/api/resources/rcs/resources/test/client/Client.ts">whitelistNumber</a>(agentId, { ...params }) -> Pinnacle.TestAgentWhitelistResponse</code></summary>
5181
+ <dl>
5182
+ <dd>
5183
+
5184
+ #### 📝 Description
5185
+
5186
+ <dl>
5187
+ <dd>
5188
+
5189
+ <dl>
5190
+ <dd>
5191
+
5192
+ Whitelist a phone number for testing with a specific test agent.
5193
+
5194
+ During development and testing, RCS agents can only send messages to whitelisted phone numbers.
5195
+ Use this endpoint to whitelist specific phone numbers so you can send and receive messages from the test agent.
5196
+
5197
+ ## Verification Process
5198
+
5199
+ After whitelisting, the recipient must accept the tester invite:
5200
+
5201
+ 1. The recipient's device will receive a message from "RBM Tester Management".
5202
+ 2. The recipient must tap "Make me a tester" to accept.
5203
+ 3. Once accepted, the status transitions from `PENDING` to `ACCEPTED`.
5204
+
5205
+ ## Verification
5206
+
5207
+ <div style="display: flex; gap: 16px;">
5208
+ <div style="flex: 1; text-align: center;">
5209
+ <strong>Accepting the invite</strong><br/>
5210
+ <img src="https://pncl.to/f769cAvCbEx-MmezZjR6dz6KVkr5ZO" alt="Accepting the tester invite" style="max-width: 100%;" />
5211
+ </div>
5212
+ <div style="flex: 1; text-align: center;">
5213
+ <strong>Declining the invite</strong><br/>
5214
+ <img src="https://pncl.to/VRere3tEKfx4n0HNaxK-vwl7pbLHTJ" alt="Declining the tester invite" style="max-width: 100%;" />
5215
+ </div>
5216
+ </div>
5217
+
5218
+ ## Cooldown
5219
+
5220
+ There is a **2-minute cooldown** after creating or updating a test agent before you can whitelist numbers.
5221
+ Attempting to whitelist during the cooldown returns a `500` error with the remaining wait time.
5222
+ </dd>
5223
+ </dl>
5224
+ </dd>
5225
+ </dl>
5226
+
5227
+ #### 🔌 Usage
5228
+
5229
+ <dl>
5230
+ <dd>
5231
+
5232
+ <dl>
5233
+ <dd>
5234
+
5235
+ ```typescript
5236
+ await client.rcs.test.whitelistNumber("agent_abc123def456", {
5237
+ phoneNumber: "+12345678901"
5238
+ });
5239
+
5240
+ ```
5241
+ </dd>
5242
+ </dl>
5243
+ </dd>
5244
+ </dl>
5245
+
5246
+ #### ⚙️ Parameters
5247
+
5248
+ <dl>
5249
+ <dd>
5250
+
5251
+ <dl>
5252
+ <dd>
5253
+
5254
+ **agentId:** `string` — The RCS agent ID (must be prefixed with `agent_`).
5255
+
5256
+ </dd>
5257
+ </dl>
5258
+
5259
+ <dl>
5260
+ <dd>
5261
+
5262
+ **request:** `Pinnacle.rcs.TestAgentWhitelistRequest`
5263
+
5264
+ </dd>
5265
+ </dl>
5266
+
5267
+ <dl>
5268
+ <dd>
5269
+
5270
+ **requestOptions:** `Test.RequestOptions`
5271
+
5272
+ </dd>
5273
+ </dl>
5274
+ </dd>
5275
+ </dl>
5276
+
5277
+
5278
+ </dd>
5279
+ </dl>
5280
+ </details>
5281
+
5282
+ <details><summary><code>client.rcs.test.<a href="/src/api/resources/rcs/resources/test/client/Client.ts">getWhitelistStatus</a>(agentId, { ...params }) -> Pinnacle.TestAgentWhitelistResponse</code></summary>
5283
+ <dl>
5284
+ <dd>
5285
+
5286
+ #### 📝 Description
5287
+
5288
+ <dl>
5289
+ <dd>
5290
+
5291
+ <dl>
5292
+ <dd>
5293
+
5294
+ Check the current whitelist status of a phone number for a specific test agent.
5295
+
5296
+ Use this endpoint to poll the status of a previously whitelisted number and determine
5297
+ whether the recipient has accepted or rejected the tester invite.
5298
+
5299
+ ## Status Values
5300
+
5301
+ - **`PENDING`** — The tester invite was sent but the recipient has not yet responded. Ask the recipient to check their messages and accept the invite.
5302
+ - **`ACCEPTED`** — The recipient accepted the invite. Messages can be exchanged.
5303
+ - **`REJECTED`** — The recipient rejected the invite or the invite could not be delivered since the carrier does not support test agents. If the user rejected the invite, they can accept it again by tapping "Make me a tester" in the same message from "RBM Tester Management".
5304
+
5305
+ <div style="display: flex; gap: 16px;">
5306
+ <div style="flex: 1; text-align: center;">
5307
+ <strong>Accepting the invite</strong><br/>
5308
+ <img src="https://pncl.to/f769cAvCbEx-MmezZjR6dz6KVkr5ZO" alt="Accepting the tester invite" style="max-width: 100%;" />
5309
+ </div>
5310
+ <div style="flex: 1; text-align: center;">
5311
+ <strong>Declining the invite</strong><br/>
5312
+ <img src="https://pncl.to/VRere3tEKfx4n0HNaxK-vwl7pbLHTJ" alt="Declining the tester invite" style="max-width: 100%;" />
5313
+ </div>
5314
+ </div>
5315
+ </dd>
5316
+ </dl>
5317
+ </dd>
5318
+ </dl>
5319
+
5320
+ #### 🔌 Usage
5321
+
5322
+ <dl>
5323
+ <dd>
5324
+
5325
+ <dl>
5326
+ <dd>
5327
+
5328
+ ```typescript
5329
+ await client.rcs.test.getWhitelistStatus("agent_abc123def456", {
5330
+ phoneNumber: "+12345678901"
5331
+ });
5332
+
5333
+ ```
5334
+ </dd>
5335
+ </dl>
5336
+ </dd>
5337
+ </dl>
5338
+
5339
+ #### ⚙️ Parameters
5340
+
5341
+ <dl>
5342
+ <dd>
5343
+
5344
+ <dl>
5345
+ <dd>
5346
+
5347
+ **agentId:** `string` — The RCS agent ID (must be prefixed with `agent_`).
5348
+
5349
+ </dd>
5350
+ </dl>
5351
+
5352
+ <dl>
5353
+ <dd>
5354
+
5355
+ **request:** `Pinnacle.rcs.TestGetWhitelistStatusRequest`
5356
+
5357
+ </dd>
5358
+ </dl>
5359
+
5360
+ <dl>
5361
+ <dd>
5362
+
5363
+ **requestOptions:** `Test.RequestOptions`
5364
+
5365
+ </dd>
5366
+ </dl>
5367
+ </dd>
5368
+ </dl>
5369
+
5370
+
5371
+ </dd>
5372
+ </dl>
5373
+ </details>
5374
+
5375
+ ## Status Get
5376
+ <details><summary><code>client.status.get.<a href="/src/api/resources/status/resources/get/client/Client.ts">brand</a>(brandId) -> Pinnacle.BrandStatus</code></summary>
5377
+ <dl>
5378
+ <dd>
5379
+
5380
+ #### 📝 Description
5381
+
5382
+ <dl>
5383
+ <dd>
5384
+
5385
+ <dl>
5386
+ <dd>
5387
+
5388
+ Retrieve a brand's status.
5389
+ </dd>
5390
+ </dl>
5391
+ </dd>
5392
+ </dl>
5393
+
5394
+ #### 🔌 Usage
5395
+
5396
+ <dl>
5397
+ <dd>
5398
+
5399
+ <dl>
5400
+ <dd>
5401
+
5402
+ ```typescript
5403
+ await client.status.get.brand("b_1234567890");
5404
+
5405
+ ```
5406
+ </dd>
5407
+ </dl>
5408
+ </dd>
5409
+ </dl>
5410
+
5411
+ #### ⚙️ Parameters
5412
+
5413
+ <dl>
5414
+ <dd>
5415
+
5416
+ <dl>
5417
+ <dd>
5418
+
5419
+ **brandId:** `string` — The unique identifier of the brand you want to retrieve the status for. This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`.
5420
+
5421
+ </dd>
5422
+ </dl>
5423
+
5424
+ <dl>
5425
+ <dd>
5426
+
5427
+ **requestOptions:** `Get.RequestOptions`
5428
+
5429
+ </dd>
5430
+ </dl>
5431
+ </dd>
5432
+ </dl>
5433
+
5434
+
5435
+ </dd>
5436
+ </dl>
5437
+ </details>
5438
+
5439
+ <details><summary><code>client.status.get.<a href="/src/api/resources/status/resources/get/client/Client.ts">tollFree</a>(campaignId) -> Pinnacle.TollFreeCampaignStatus</code></summary>
5440
+ <dl>
5441
+ <dd>
5442
+
5443
+ #### 📝 Description
5444
+
5445
+ <dl>
5446
+ <dd>
5447
+
5448
+ <dl>
5449
+ <dd>
5450
+
5451
+ Retrieve a toll-free campaign's status.
5452
+ </dd>
5453
+ </dl>
5454
+ </dd>
5455
+ </dl>
5456
+
5457
+ #### 🔌 Usage
5458
+
5459
+ <dl>
5460
+ <dd>
5461
+
5462
+ <dl>
5463
+ <dd>
5464
+
5465
+ ```typescript
5466
+ await client.status.get.tollFree("tf_1234567890");
5467
+
5468
+ ```
5469
+ </dd>
5470
+ </dl>
5471
+ </dd>
5472
+ </dl>
5473
+
5474
+ #### ⚙️ Parameters
5475
+
5476
+ <dl>
5477
+ <dd>
5478
+
5479
+ <dl>
5480
+ <dd>
5481
+
5482
+ **campaignId:** `string` — The unique identifier of the toll-free campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `tf_`, for example: `tf_1234567890`.
5483
+
5484
+ </dd>
5485
+ </dl>
5486
+
5487
+ <dl>
5488
+ <dd>
5489
+
5490
+ **requestOptions:** `Get.RequestOptions`
5491
+
5492
+ </dd>
5493
+ </dl>
5494
+ </dd>
5495
+ </dl>
5496
+
5497
+
5498
+ </dd>
5499
+ </dl>
5500
+ </details>
5501
+
5502
+ <details><summary><code>client.status.get.<a href="/src/api/resources/status/resources/get/client/Client.ts">dlc</a>(campaignId) -> Pinnacle.DlcCampaignStatus</code></summary>
5503
+ <dl>
5504
+ <dd>
5505
+
5506
+ #### 📝 Description
5507
+
5508
+ <dl>
5509
+ <dd>
5510
+
5511
+ <dl>
5512
+ <dd>
5513
+
5514
+ Retrieve a 10DLC campaign's status.
5515
+ </dd>
5516
+ </dl>
5517
+ </dd>
5518
+ </dl>
5519
+
5520
+ #### 🔌 Usage
5521
+
5522
+ <dl>
5523
+ <dd>
5524
+
5525
+ <dl>
5526
+ <dd>
5527
+
5528
+ ```typescript
5529
+ await client.status.get.dlc("dlc_1234567890");
5530
+
5531
+ ```
5532
+ </dd>
5533
+ </dl>
5534
+ </dd>
5535
+ </dl>
5536
+
5537
+ #### ⚙️ Parameters
5538
+
5539
+ <dl>
5540
+ <dd>
5541
+
5542
+ <dl>
5543
+ <dd>
5544
+
5545
+ **campaignId:** `string` — The unique identifier of the 10DLC campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`.
5546
+
5547
+ </dd>
5548
+ </dl>
5549
+
5550
+ <dl>
5551
+ <dd>
5552
+
5553
+ **requestOptions:** `Get.RequestOptions`
5554
+
5555
+ </dd>
5556
+ </dl>
5557
+ </dd>
5558
+ </dl>
5559
+
5560
+
5561
+ </dd>
5562
+ </dl>
5563
+ </details>
5564
+
5565
+ <details><summary><code>client.status.get.<a href="/src/api/resources/status/resources/get/client/Client.ts">rcs</a>(campaignId) -> Pinnacle.RcsCampaignStatus</code></summary>
5566
+ <dl>
5567
+ <dd>
5568
+
5569
+ #### 📝 Description
5570
+
5571
+ <dl>
5572
+ <dd>
5573
+
5574
+ <dl>
5575
+ <dd>
5576
+
5577
+ Retrieve a RCS campaign's status.
5578
+ </dd>
5579
+ </dl>
5580
+ </dd>
5581
+ </dl>
5582
+
5583
+ #### 🔌 Usage
5584
+
5585
+ <dl>
5586
+ <dd>
5587
+
5588
+ <dl>
5589
+ <dd>
5590
+
5591
+ ```typescript
5592
+ await client.status.get.rcs("rcs_1234567890");
5593
+
5594
+ ```
5595
+ </dd>
5596
+ </dl>
5597
+ </dd>
5598
+ </dl>
5599
+
5600
+ #### ⚙️ Parameters
5601
+
5602
+ <dl>
5603
+ <dd>
5604
+
5605
+ <dl>
5606
+ <dd>
5607
+
5608
+ **campaignId:** `string` — The unique identifier of the RCS campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `rcs_`, for example: `rcs_1234567890`.
5609
+
5610
+ </dd>
5611
+ </dl>
5612
+
5613
+ <dl>
5614
+ <dd>
5615
+
5616
+ **requestOptions:** `Get.RequestOptions`
5617
+
5618
+ </dd>
5619
+ </dl>
5620
+ </dd>
5621
+ </dl>
5622
+
5623
+
5624
+ </dd>
5625
+ </dl>
5626
+ </details>
5627
+
5628
+ <details><summary><code>client.status.get.<a href="/src/api/resources/status/resources/get/client/Client.ts">phoneNumber</a>(phoneNumber) -> Pinnacle.PhoneNumberStatus</code></summary>
5629
+ <dl>
5630
+ <dd>
5631
+
5632
+ #### 📝 Description
5633
+
5634
+ <dl>
5635
+ <dd>
5636
+
5637
+ <dl>
5638
+ <dd>
5639
+
5640
+ Retrieve a phone number's order status and campaign attachment status. <br>
5641
+
5642
+ Check if a number is active and ready to send messages.
5643
+ </dd>
5644
+ </dl>
5645
+ </dd>
5646
+ </dl>
5647
+
5648
+ #### 🔌 Usage
5649
+
5650
+ <dl>
5651
+ <dd>
5652
+
5653
+ <dl>
5654
+ <dd>
5655
+
5656
+ ```typescript
5657
+ await client.status.get.phoneNumber("+14151234567");
5658
+
5659
+ ```
5660
+ </dd>
5661
+ </dl>
5662
+ </dd>
5663
+ </dl>
5664
+
5665
+ #### ⚙️ Parameters
5666
+
5667
+ <dl>
5668
+ <dd>
5669
+
5670
+ <dl>
5671
+ <dd>
5672
+
5673
+ **phoneNumber:** `string` — Phone number in E164 format that is in review.
5674
+
5675
+ </dd>
5676
+ </dl>
5677
+
5678
+ <dl>
5679
+ <dd>
5680
+
5681
+ **requestOptions:** `Get.RequestOptions`
5682
+
5683
+ </dd>
5684
+ </dl>
5685
+ </dd>
5686
+ </dl>
5687
+
5688
+
5689
+ </dd>
5690
+ </dl>
5691
+ </details>
5692
+
5693
+ ## Tools Url
5694
+ <details><summary><code>client.tools.url.<a href="/src/api/resources/tools/resources/url/client/Client.ts">create</a>({ ...params }) -> Pinnacle.ShortenedUrl</code></summary>
5695
+ <dl>
5696
+ <dd>
5697
+
5698
+ #### 📝 Description
5699
+
5700
+ <dl>
5701
+ <dd>
5702
+
5703
+ <dl>
5704
+ <dd>
5705
+
5706
+ Create a shortened URL that redirects visitors to the provided destination URL.
5707
+ </dd>
5708
+ </dl>
5709
+ </dd>
5710
+ </dl>
5711
+
5712
+ #### 🔌 Usage
5713
+
5714
+ <dl>
5715
+ <dd>
5716
+
5717
+ <dl>
5718
+ <dd>
5719
+
5720
+ ```typescript
5721
+ await client.tools.url.create({
5722
+ url: "https://www.pinnacle.sh/",
5723
+ options: {
5724
+ expiresAt: "2025-06-23T16:18:25.000Z"
5725
+ }
5726
+ });
5727
+
5728
+ ```
5729
+ </dd>
5730
+ </dl>
5731
+ </dd>
5732
+ </dl>
5733
+
5734
+ #### ⚙️ Parameters
5735
+
5736
+ <dl>
5737
+ <dd>
5738
+
5739
+ <dl>
5740
+ <dd>
5741
+
5742
+ **request:** `Pinnacle.tools.CreateUrlParams`
5743
+
5744
+ </dd>
5745
+ </dl>
5746
+
5747
+ <dl>
5748
+ <dd>
5749
+
5750
+ **requestOptions:** `Url.RequestOptions`
5751
+
5752
+ </dd>
5753
+ </dl>
5754
+ </dd>
5755
+ </dl>
4561
5756
 
4562
5757
 
4563
5758
  </dd>
@@ -4704,6 +5899,69 @@ See the response of [Create Shortened URL](./create-url) for more information.
4704
5899
  </dl>
4705
5900
 
4706
5901
 
5902
+ </dd>
5903
+ </dl>
5904
+ </details>
5905
+
5906
+ <details><summary><code>client.tools.url.<a href="/src/api/resources/tools/resources/url/client/Client.ts">list</a>({ ...params }) -> Pinnacle.ListLinksResponse</code></summary>
5907
+ <dl>
5908
+ <dd>
5909
+
5910
+ #### 📝 Description
5911
+
5912
+ <dl>
5913
+ <dd>
5914
+
5915
+ <dl>
5916
+ <dd>
5917
+
5918
+ List all shortened URLs with pagination. Results are sorted by creation date, newest first.
5919
+ </dd>
5920
+ </dl>
5921
+ </dd>
5922
+ </dl>
5923
+
5924
+ #### 🔌 Usage
5925
+
5926
+ <dl>
5927
+ <dd>
5928
+
5929
+ <dl>
5930
+ <dd>
5931
+
5932
+ ```typescript
5933
+ await client.tools.url.list();
5934
+
5935
+ ```
5936
+ </dd>
5937
+ </dl>
5938
+ </dd>
5939
+ </dl>
5940
+
5941
+ #### ⚙️ Parameters
5942
+
5943
+ <dl>
5944
+ <dd>
5945
+
5946
+ <dl>
5947
+ <dd>
5948
+
5949
+ **request:** `Pinnacle.tools.ListLinksParams`
5950
+
5951
+ </dd>
5952
+ </dl>
5953
+
5954
+ <dl>
5955
+ <dd>
5956
+
5957
+ **requestOptions:** `Url.RequestOptions`
5958
+
5959
+ </dd>
5960
+ </dl>
5961
+ </dd>
5962
+ </dl>
5963
+
5964
+
4707
5965
  </dd>
4708
5966
  </dl>
4709
5967
  </details>