rcs-js 2.0.13 → 2.0.14-rc.1

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 (444) 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 +21 -12
  17. package/dist/cjs/api/resources/campaigns/resources/rcs/client/Client.js +76 -12
  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/UpsertRcsCampaignParams.d.ts +12 -32
  21. package/dist/cjs/api/resources/campaigns/resources/rcs/client/requests/index.d.ts +1 -0
  22. package/dist/cjs/api/resources/campaigns/resources/tollFree/client/Client.d.ts +15 -0
  23. package/dist/cjs/api/resources/campaigns/resources/tollFree/client/Client.js +73 -0
  24. package/dist/cjs/api/resources/campaigns/resources/tollFree/client/requests/ListTollFreeCampaignsParams.d.ts +21 -0
  25. package/dist/cjs/api/resources/campaigns/resources/tollFree/client/requests/ListTollFreeCampaignsParams.js +13 -0
  26. package/dist/cjs/api/resources/campaigns/resources/tollFree/client/requests/index.d.ts +1 -0
  27. package/dist/cjs/api/resources/contacts/client/Client.d.ts +15 -0
  28. package/dist/cjs/api/resources/contacts/client/Client.js +70 -0
  29. package/dist/cjs/api/resources/contacts/client/requests/ListContactsParams.d.ts +16 -0
  30. package/dist/cjs/api/resources/contacts/client/requests/index.d.ts +1 -0
  31. package/dist/cjs/api/resources/messages/client/Client.d.ts +21 -0
  32. package/dist/cjs/api/resources/messages/client/Client.js +88 -8
  33. package/dist/cjs/api/resources/messages/client/requests/ListMessagesParams.d.ts +55 -0
  34. package/dist/cjs/api/resources/messages/client/requests/ListMessagesParams.js +33 -0
  35. package/dist/cjs/api/resources/messages/client/requests/index.d.ts +1 -0
  36. package/dist/cjs/api/resources/messages/resources/blast/client/requests/BlastRcs.d.ts +0 -2
  37. package/dist/cjs/api/resources/messages/resources/blasts/client/Client.d.ts +29 -0
  38. package/dist/cjs/api/resources/messages/resources/blasts/client/Client.js +133 -0
  39. package/dist/cjs/api/resources/messages/resources/blasts/client/index.d.ts +1 -0
  40. package/dist/cjs/api/resources/messages/resources/blasts/client/index.js +17 -0
  41. package/dist/cjs/api/resources/messages/resources/blasts/client/requests/ListBlastsParams.d.ts +17 -0
  42. package/dist/cjs/api/resources/messages/resources/blasts/client/requests/ListBlastsParams.js +3 -0
  43. package/dist/cjs/api/resources/messages/resources/blasts/client/requests/index.d.ts +1 -0
  44. package/dist/cjs/api/resources/messages/resources/blasts/client/requests/index.js +2 -0
  45. package/dist/cjs/api/resources/messages/resources/blasts/index.d.ts +1 -0
  46. package/dist/cjs/api/resources/messages/resources/blasts/index.js +17 -0
  47. package/dist/cjs/api/resources/messages/resources/index.d.ts +4 -0
  48. package/dist/cjs/api/resources/messages/resources/index.js +5 -1
  49. package/dist/cjs/api/resources/messages/resources/rcs/client/Client.d.ts +1 -4
  50. package/dist/cjs/api/resources/messages/resources/rcs/client/Client.js +1 -4
  51. package/dist/cjs/api/resources/messages/resources/rcs/client/requests/SendTypingIndicatorSchema.d.ts +1 -15
  52. package/dist/cjs/api/resources/messages/resources/rcs/types/SendRichMessageResponse.d.ts +1 -1
  53. package/dist/cjs/api/resources/messages/resources/schedules/client/Client.d.ts +29 -0
  54. package/dist/cjs/api/resources/messages/resources/schedules/client/Client.js +136 -0
  55. package/dist/cjs/api/resources/messages/resources/schedules/client/index.d.ts +1 -0
  56. package/dist/cjs/api/resources/messages/resources/schedules/client/index.js +17 -0
  57. package/dist/cjs/api/resources/messages/resources/schedules/client/requests/ListScheduledMessagesParams.d.ts +27 -0
  58. package/dist/cjs/api/resources/messages/resources/schedules/client/requests/ListScheduledMessagesParams.js +17 -0
  59. package/dist/cjs/api/resources/messages/resources/schedules/client/requests/index.d.ts +1 -0
  60. package/dist/cjs/api/resources/messages/resources/schedules/client/requests/index.js +2 -0
  61. package/dist/cjs/api/resources/messages/resources/schedules/index.d.ts +1 -0
  62. package/dist/cjs/api/resources/messages/resources/schedules/index.js +17 -0
  63. package/dist/cjs/api/resources/phoneNumbers/client/Client.d.ts +15 -0
  64. package/dist/cjs/api/resources/phoneNumbers/client/Client.js +70 -0
  65. package/dist/cjs/api/resources/phoneNumbers/client/requests/ListPhoneNumbersParams.d.ts +8 -0
  66. package/dist/cjs/api/resources/phoneNumbers/client/requests/ListPhoneNumbersParams.js +3 -0
  67. package/dist/cjs/api/resources/phoneNumbers/client/requests/index.d.ts +1 -0
  68. package/dist/cjs/api/resources/rcs/client/Client.d.ts +25 -42
  69. package/dist/cjs/api/resources/rcs/client/Client.js +40 -56
  70. package/dist/cjs/api/resources/rcs/client/requests/RcsCapabilitiesQuery.d.ts +2 -0
  71. package/dist/cjs/api/resources/rcs/client/requests/RcsLinkRequest.d.ts +0 -3
  72. package/dist/cjs/api/resources/rcs/client/requests/index.d.ts +0 -1
  73. package/dist/cjs/api/resources/rcs/index.d.ts +1 -0
  74. package/dist/cjs/api/resources/rcs/index.js +1 -0
  75. package/dist/cjs/api/resources/rcs/resources/agents/client/Client.d.ts +29 -0
  76. package/dist/cjs/api/resources/rcs/resources/agents/client/Client.js +133 -0
  77. package/dist/cjs/api/resources/rcs/resources/agents/client/index.d.ts +1 -0
  78. package/dist/cjs/api/resources/rcs/resources/agents/client/index.js +17 -0
  79. package/dist/cjs/api/resources/rcs/resources/agents/client/requests/ListAgentsParams.d.ts +20 -0
  80. package/dist/cjs/api/resources/rcs/resources/agents/client/requests/ListAgentsParams.js +12 -0
  81. package/dist/cjs/api/resources/rcs/resources/agents/client/requests/index.d.ts +1 -0
  82. package/dist/cjs/api/resources/rcs/resources/agents/client/requests/index.js +2 -0
  83. package/dist/cjs/api/resources/rcs/resources/agents/index.d.ts +1 -0
  84. package/dist/cjs/api/resources/rcs/resources/agents/index.js +17 -0
  85. package/dist/cjs/api/resources/rcs/resources/index.d.ts +6 -0
  86. package/dist/cjs/api/resources/rcs/resources/index.js +45 -0
  87. package/dist/cjs/api/resources/rcs/resources/test/client/Client.d.ts +214 -0
  88. package/dist/cjs/api/resources/rcs/resources/test/client/Client.js +497 -0
  89. package/dist/cjs/api/resources/rcs/resources/test/client/index.d.ts +1 -0
  90. package/dist/cjs/api/resources/rcs/resources/test/client/index.js +17 -0
  91. package/dist/cjs/api/resources/rcs/resources/test/client/requests/CreateTestAgentRequest.d.ts +87 -0
  92. package/dist/cjs/api/resources/rcs/resources/test/client/requests/CreateTestAgentRequest.js +3 -0
  93. package/dist/cjs/api/resources/rcs/resources/test/client/requests/TestAgentWhitelistRequest.d.ts +15 -0
  94. package/dist/cjs/api/resources/rcs/resources/test/client/requests/TestAgentWhitelistRequest.js +3 -0
  95. package/dist/cjs/api/resources/rcs/resources/test/client/requests/TestGetWhitelistStatusRequest.d.ts +20 -0
  96. package/dist/cjs/api/resources/rcs/resources/test/client/requests/TestGetWhitelistStatusRequest.js +3 -0
  97. package/dist/cjs/api/resources/rcs/resources/test/client/requests/UpdateTestAgentRequest.d.ts +59 -0
  98. package/dist/cjs/api/resources/rcs/resources/test/client/requests/UpdateTestAgentRequest.js +3 -0
  99. package/dist/cjs/api/resources/rcs/resources/test/client/requests/index.d.ts +4 -0
  100. package/dist/cjs/api/resources/rcs/resources/test/client/requests/index.js +2 -0
  101. package/dist/cjs/api/resources/rcs/resources/test/index.d.ts +1 -0
  102. package/dist/cjs/api/resources/rcs/resources/test/index.js +17 -0
  103. package/dist/cjs/api/resources/rcs/resources/whitelistedNumbers/client/Client.d.ts +29 -0
  104. package/dist/cjs/api/resources/rcs/resources/whitelistedNumbers/client/Client.js +133 -0
  105. package/dist/cjs/api/resources/rcs/resources/whitelistedNumbers/client/index.d.ts +1 -0
  106. package/dist/cjs/api/resources/rcs/resources/whitelistedNumbers/client/index.js +17 -0
  107. package/dist/cjs/api/resources/rcs/resources/whitelistedNumbers/client/requests/ListTestNumbersParams.d.ts +23 -0
  108. package/dist/cjs/api/resources/rcs/resources/whitelistedNumbers/client/requests/ListTestNumbersParams.js +13 -0
  109. package/dist/cjs/api/resources/rcs/resources/whitelistedNumbers/client/requests/index.d.ts +1 -0
  110. package/dist/cjs/api/resources/rcs/resources/whitelistedNumbers/client/requests/index.js +2 -0
  111. package/dist/cjs/api/resources/rcs/resources/whitelistedNumbers/index.d.ts +1 -0
  112. package/dist/cjs/api/resources/rcs/resources/whitelistedNumbers/index.js +17 -0
  113. package/dist/cjs/api/resources/tools/resources/url/client/Client.d.ts +15 -0
  114. package/dist/cjs/api/resources/tools/resources/url/client/Client.js +70 -0
  115. package/dist/cjs/api/resources/tools/resources/url/client/requests/ListLinksParams.d.ts +10 -0
  116. package/dist/cjs/api/resources/tools/resources/url/client/requests/ListLinksParams.js +3 -0
  117. package/dist/cjs/api/resources/tools/resources/url/client/requests/index.d.ts +1 -0
  118. package/dist/cjs/api/resources/webhooks/client/Client.d.ts +15 -0
  119. package/dist/cjs/api/resources/webhooks/client/Client.js +70 -0
  120. package/dist/cjs/api/resources/webhooks/client/requests/ListWebhooksParams.d.ts +19 -0
  121. package/dist/cjs/api/resources/webhooks/client/requests/ListWebhooksParams.js +12 -0
  122. package/dist/cjs/api/resources/webhooks/client/requests/index.d.ts +1 -0
  123. package/dist/cjs/api/types/AgentEmailEntry.d.ts +9 -0
  124. package/dist/cjs/api/types/AgentEmailEntry.js +3 -0
  125. package/dist/cjs/api/types/AgentPhoneEntry.d.ts +9 -0
  126. package/dist/cjs/api/types/AgentPhoneEntry.js +3 -0
  127. package/dist/cjs/api/types/AgentSummary.d.ts +94 -0
  128. package/dist/cjs/api/types/AgentSummary.js +22 -0
  129. package/dist/cjs/api/types/AgentUseCase.d.ts +15 -0
  130. package/dist/cjs/api/types/AgentUseCase.js +18 -0
  131. package/dist/cjs/api/types/AgentWebsiteEntry.d.ts +9 -0
  132. package/dist/cjs/api/types/AgentWebsiteEntry.js +3 -0
  133. package/dist/cjs/api/types/AudienceSummary.d.ts +12 -0
  134. package/dist/cjs/api/types/AudienceSummary.js +3 -0
  135. package/dist/cjs/api/types/BlastDetails.d.ts +1 -1
  136. package/dist/cjs/api/types/BlastSummary.d.ts +27 -0
  137. package/dist/cjs/api/types/BlastSummary.js +13 -0
  138. package/dist/cjs/api/types/CarrierLaunchStatus.d.ts +12 -0
  139. package/dist/cjs/api/types/CarrierLaunchStatus.js +15 -0
  140. package/dist/cjs/api/types/CarrierLaunches.d.ts +14 -0
  141. package/dist/cjs/api/types/CarrierLaunches.js +3 -0
  142. package/dist/cjs/api/types/DlcCampaignSummary.d.ts +26 -0
  143. package/dist/cjs/api/types/DlcCampaignSummary.js +14 -0
  144. package/dist/cjs/api/types/ExtendedRcsCampaign.d.ts +6 -20
  145. package/dist/cjs/api/types/FallbackMessage.d.ts +6 -5
  146. package/dist/cjs/api/types/LinkSummary.d.ts +10 -0
  147. package/dist/cjs/api/types/LinkSummary.js +3 -0
  148. package/dist/cjs/api/types/ListAgentsResponse.d.ts +6 -0
  149. package/dist/cjs/api/types/ListAgentsResponse.js +3 -0
  150. package/dist/cjs/api/types/ListAudiencesResponse.d.ts +6 -0
  151. package/dist/cjs/api/types/ListAudiencesResponse.js +3 -0
  152. package/dist/cjs/api/types/ListBlastsResponse.d.ts +6 -0
  153. package/dist/cjs/api/types/ListBlastsResponse.js +3 -0
  154. package/dist/cjs/api/types/ListBrandsResponse.d.ts +6 -0
  155. package/dist/cjs/api/types/ListBrandsResponse.js +3 -0
  156. package/dist/cjs/api/types/ListContactsResponse.d.ts +6 -0
  157. package/dist/cjs/api/types/ListContactsResponse.js +3 -0
  158. package/dist/cjs/api/types/ListDlcCampaignsResponse.d.ts +6 -0
  159. package/dist/cjs/api/types/ListDlcCampaignsResponse.js +3 -0
  160. package/dist/cjs/api/types/ListLinksResponse.d.ts +6 -0
  161. package/dist/cjs/api/types/ListLinksResponse.js +3 -0
  162. package/dist/cjs/api/types/ListMessagesResponse.d.ts +6 -0
  163. package/dist/cjs/api/types/ListMessagesResponse.js +3 -0
  164. package/dist/cjs/api/types/ListPhoneNumbersResponse.d.ts +6 -0
  165. package/dist/cjs/api/types/ListPhoneNumbersResponse.js +3 -0
  166. package/dist/cjs/api/types/ListRcsCampaignsResponse.d.ts +6 -0
  167. package/dist/cjs/api/types/ListRcsCampaignsResponse.js +3 -0
  168. package/dist/cjs/api/types/ListScheduledMessagesResponse.d.ts +6 -0
  169. package/dist/cjs/api/types/ListScheduledMessagesResponse.js +3 -0
  170. package/dist/cjs/api/types/ListTestNumbersResponse.d.ts +6 -0
  171. package/dist/cjs/api/types/ListTestNumbersResponse.js +3 -0
  172. package/dist/cjs/api/types/ListTollFreeCampaignsResponse.d.ts +6 -0
  173. package/dist/cjs/api/types/ListTollFreeCampaignsResponse.js +3 -0
  174. package/dist/cjs/api/types/ListWebhooksResponse.d.ts +6 -0
  175. package/dist/cjs/api/types/ListWebhooksResponse.js +3 -0
  176. package/dist/cjs/api/types/Message.d.ts +0 -8
  177. package/dist/cjs/api/types/MessageEvent.d.ts +21 -14
  178. package/dist/cjs/api/types/MessageEvent.js +1 -1
  179. package/dist/cjs/api/types/MessageList.d.ts +1 -1
  180. package/dist/cjs/api/types/MessageSummary.d.ts +71 -0
  181. package/dist/cjs/api/types/MessageSummary.js +36 -0
  182. package/dist/cjs/api/types/{MessageWithReaction.d.ts → MessageWithReactions.d.ts} +7 -7
  183. package/dist/cjs/api/types/{MessageWithReaction.js → MessageWithReactions.js} +5 -5
  184. package/dist/cjs/api/types/OwnedPhoneNumber.d.ts +14 -0
  185. package/dist/cjs/api/types/OwnedPhoneNumber.js +3 -0
  186. package/dist/cjs/api/types/RcsAgentDetails.d.ts +81 -0
  187. package/dist/cjs/api/types/RcsAgentDetails.js +20 -0
  188. package/dist/cjs/api/types/RcsAgentResponse.d.ts +17 -0
  189. package/dist/cjs/api/types/RcsAgentResponse.js +3 -0
  190. package/dist/cjs/api/types/RcsCampaign.d.ts +6 -20
  191. package/dist/cjs/api/types/RcsCampaignSummary.d.ts +26 -0
  192. package/dist/cjs/api/types/RcsCampaignSummary.js +14 -0
  193. package/dist/cjs/api/types/RcsWhitelistStatus.d.ts +13 -0
  194. package/dist/cjs/api/types/RcsWhitelistStatus.js +16 -0
  195. package/dist/cjs/api/types/ScheduledMessageSummary.d.ts +29 -0
  196. package/dist/cjs/api/types/ScheduledMessageSummary.js +13 -0
  197. package/dist/cjs/api/types/SendRichMessageOptions.d.ts +0 -2
  198. package/dist/cjs/api/types/SentRichMessageFallbackMms.d.ts +10 -0
  199. package/dist/cjs/api/types/SentRichMessageFallbackMms.js +3 -0
  200. package/dist/cjs/api/types/SentRichMessageFallbackSms.d.ts +10 -0
  201. package/dist/cjs/api/types/SentRichMessageFallbackSms.js +3 -0
  202. package/dist/cjs/api/types/TestAgentResponse.d.ts +19 -0
  203. package/dist/cjs/api/types/TestAgentResponse.js +3 -0
  204. package/dist/cjs/api/types/TestAgentWhitelistResponse.d.ts +7 -0
  205. package/dist/cjs/api/types/TestAgentWhitelistResponse.js +3 -0
  206. package/dist/cjs/api/types/TollFreeCampaignSummary.d.ts +26 -0
  207. package/dist/cjs/api/types/TollFreeCampaignSummary.js +14 -0
  208. package/dist/cjs/api/types/WebhookSummary.d.ts +23 -0
  209. package/dist/cjs/api/types/WebhookSummary.js +13 -0
  210. package/dist/cjs/api/types/WhitelistedNumberSummary.d.ts +19 -0
  211. package/dist/cjs/api/types/WhitelistedNumberSummary.js +13 -0
  212. package/dist/cjs/api/types/index.d.ts +40 -3
  213. package/dist/cjs/api/types/index.js +40 -3
  214. package/dist/cjs/version.d.ts +1 -1
  215. package/dist/cjs/version.js +1 -1
  216. package/dist/esm/Client.mjs +2 -2
  217. package/dist/esm/api/resources/audiences/client/Client.d.mts +15 -0
  218. package/dist/esm/api/resources/audiences/client/Client.mjs +70 -0
  219. package/dist/esm/api/resources/audiences/client/requests/ListAudiencesParams.d.mts +10 -0
  220. package/dist/esm/api/resources/audiences/client/requests/index.d.mts +1 -0
  221. package/dist/esm/api/resources/brands/client/Client.d.mts +15 -0
  222. package/dist/esm/api/resources/brands/client/Client.mjs +70 -0
  223. package/dist/esm/api/resources/brands/client/requests/ListBrandsParams.d.mts +23 -0
  224. package/dist/esm/api/resources/brands/client/requests/ListBrandsParams.mjs +12 -0
  225. package/dist/esm/api/resources/brands/client/requests/index.d.mts +1 -0
  226. package/dist/esm/api/resources/campaigns/resources/dlc/client/Client.d.mts +15 -0
  227. package/dist/esm/api/resources/campaigns/resources/dlc/client/Client.mjs +70 -0
  228. package/dist/esm/api/resources/campaigns/resources/dlc/client/requests/ListDlcCampaignsParams.d.mts +21 -0
  229. package/dist/esm/api/resources/campaigns/resources/dlc/client/requests/ListDlcCampaignsParams.mjs +10 -0
  230. package/dist/esm/api/resources/campaigns/resources/dlc/client/requests/index.d.mts +1 -0
  231. package/dist/esm/api/resources/campaigns/resources/rcs/client/Client.d.mts +21 -12
  232. package/dist/esm/api/resources/campaigns/resources/rcs/client/Client.mjs +76 -12
  233. package/dist/esm/api/resources/campaigns/resources/rcs/client/requests/ListRcsCampaignsParams.d.mts +21 -0
  234. package/dist/esm/api/resources/campaigns/resources/rcs/client/requests/ListRcsCampaignsParams.mjs +10 -0
  235. package/dist/esm/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.mts +12 -32
  236. package/dist/esm/api/resources/campaigns/resources/rcs/client/requests/index.d.mts +1 -0
  237. package/dist/esm/api/resources/campaigns/resources/tollFree/client/Client.d.mts +15 -0
  238. package/dist/esm/api/resources/campaigns/resources/tollFree/client/Client.mjs +73 -0
  239. package/dist/esm/api/resources/campaigns/resources/tollFree/client/requests/ListTollFreeCampaignsParams.d.mts +21 -0
  240. package/dist/esm/api/resources/campaigns/resources/tollFree/client/requests/ListTollFreeCampaignsParams.mjs +10 -0
  241. package/dist/esm/api/resources/campaigns/resources/tollFree/client/requests/index.d.mts +1 -0
  242. package/dist/esm/api/resources/contacts/client/Client.d.mts +15 -0
  243. package/dist/esm/api/resources/contacts/client/Client.mjs +70 -0
  244. package/dist/esm/api/resources/contacts/client/requests/ListContactsParams.d.mts +16 -0
  245. package/dist/esm/api/resources/contacts/client/requests/index.d.mts +1 -0
  246. package/dist/esm/api/resources/messages/client/Client.d.mts +21 -0
  247. package/dist/esm/api/resources/messages/client/Client.mjs +80 -0
  248. package/dist/esm/api/resources/messages/client/requests/ListMessagesParams.d.mts +55 -0
  249. package/dist/esm/api/resources/messages/client/requests/ListMessagesParams.mjs +30 -0
  250. package/dist/esm/api/resources/messages/client/requests/index.d.mts +1 -0
  251. package/dist/esm/api/resources/messages/resources/blast/client/requests/BlastRcs.d.mts +0 -2
  252. package/dist/esm/api/resources/messages/resources/blasts/client/Client.d.mts +29 -0
  253. package/dist/esm/api/resources/messages/resources/blasts/client/Client.mjs +96 -0
  254. package/dist/esm/api/resources/messages/resources/blasts/client/index.d.mts +1 -0
  255. package/dist/esm/api/resources/messages/resources/blasts/client/index.mjs +1 -0
  256. package/dist/esm/api/resources/messages/resources/blasts/client/requests/ListBlastsParams.d.mts +17 -0
  257. package/dist/esm/api/resources/messages/resources/blasts/client/requests/ListBlastsParams.mjs +2 -0
  258. package/dist/esm/api/resources/messages/resources/blasts/client/requests/index.d.mts +1 -0
  259. package/dist/esm/api/resources/messages/resources/blasts/client/requests/index.mjs +1 -0
  260. package/dist/esm/api/resources/messages/resources/blasts/index.d.mts +1 -0
  261. package/dist/esm/api/resources/messages/resources/blasts/index.mjs +1 -0
  262. package/dist/esm/api/resources/messages/resources/index.d.mts +4 -0
  263. package/dist/esm/api/resources/messages/resources/index.mjs +4 -0
  264. package/dist/esm/api/resources/messages/resources/rcs/client/Client.d.mts +1 -4
  265. package/dist/esm/api/resources/messages/resources/rcs/client/Client.mjs +1 -4
  266. package/dist/esm/api/resources/messages/resources/rcs/client/requests/SendTypingIndicatorSchema.d.mts +1 -15
  267. package/dist/esm/api/resources/messages/resources/rcs/types/SendRichMessageResponse.d.mts +1 -1
  268. package/dist/esm/api/resources/messages/resources/schedules/client/Client.d.mts +29 -0
  269. package/dist/esm/api/resources/messages/resources/schedules/client/Client.mjs +99 -0
  270. package/dist/esm/api/resources/messages/resources/schedules/client/index.d.mts +1 -0
  271. package/dist/esm/api/resources/messages/resources/schedules/client/index.mjs +1 -0
  272. package/dist/esm/api/resources/messages/resources/schedules/client/requests/ListScheduledMessagesParams.d.mts +27 -0
  273. package/dist/esm/api/resources/messages/resources/schedules/client/requests/ListScheduledMessagesParams.mjs +14 -0
  274. package/dist/esm/api/resources/messages/resources/schedules/client/requests/index.d.mts +1 -0
  275. package/dist/esm/api/resources/messages/resources/schedules/client/requests/index.mjs +1 -0
  276. package/dist/esm/api/resources/messages/resources/schedules/index.d.mts +1 -0
  277. package/dist/esm/api/resources/messages/resources/schedules/index.mjs +1 -0
  278. package/dist/esm/api/resources/phoneNumbers/client/Client.d.mts +15 -0
  279. package/dist/esm/api/resources/phoneNumbers/client/Client.mjs +70 -0
  280. package/dist/esm/api/resources/phoneNumbers/client/requests/ListPhoneNumbersParams.d.mts +8 -0
  281. package/dist/esm/api/resources/phoneNumbers/client/requests/ListPhoneNumbersParams.mjs +2 -0
  282. package/dist/esm/api/resources/phoneNumbers/client/requests/index.d.mts +1 -0
  283. package/dist/esm/api/resources/rcs/client/Client.d.mts +25 -42
  284. package/dist/esm/api/resources/rcs/client/Client.mjs +40 -56
  285. package/dist/esm/api/resources/rcs/client/requests/RcsCapabilitiesQuery.d.mts +2 -0
  286. package/dist/esm/api/resources/rcs/client/requests/RcsLinkRequest.d.mts +0 -3
  287. package/dist/esm/api/resources/rcs/client/requests/index.d.mts +0 -1
  288. package/dist/esm/api/resources/rcs/index.d.mts +1 -0
  289. package/dist/esm/api/resources/rcs/index.mjs +1 -0
  290. package/dist/esm/api/resources/rcs/resources/agents/client/Client.d.mts +29 -0
  291. package/dist/esm/api/resources/rcs/resources/agents/client/Client.mjs +96 -0
  292. package/dist/esm/api/resources/rcs/resources/agents/client/index.d.mts +1 -0
  293. package/dist/esm/api/resources/rcs/resources/agents/client/index.mjs +1 -0
  294. package/dist/esm/api/resources/rcs/resources/agents/client/requests/ListAgentsParams.d.mts +20 -0
  295. package/dist/esm/api/resources/rcs/resources/agents/client/requests/ListAgentsParams.mjs +9 -0
  296. package/dist/esm/api/resources/rcs/resources/agents/client/requests/index.d.mts +1 -0
  297. package/dist/esm/api/resources/rcs/resources/agents/client/requests/index.mjs +1 -0
  298. package/dist/esm/api/resources/rcs/resources/agents/index.d.mts +1 -0
  299. package/dist/esm/api/resources/rcs/resources/agents/index.mjs +1 -0
  300. package/dist/esm/api/resources/rcs/resources/index.d.mts +6 -0
  301. package/dist/esm/api/resources/rcs/resources/index.mjs +6 -0
  302. package/dist/esm/api/resources/rcs/resources/test/client/Client.d.mts +214 -0
  303. package/dist/esm/api/resources/rcs/resources/test/client/Client.mjs +460 -0
  304. package/dist/esm/api/resources/rcs/resources/test/client/index.d.mts +1 -0
  305. package/dist/esm/api/resources/rcs/resources/test/client/index.mjs +1 -0
  306. package/dist/esm/api/resources/rcs/resources/test/client/requests/CreateTestAgentRequest.d.mts +87 -0
  307. package/dist/esm/api/resources/rcs/resources/test/client/requests/CreateTestAgentRequest.mjs +2 -0
  308. package/dist/esm/api/resources/rcs/resources/test/client/requests/TestAgentWhitelistRequest.d.mts +15 -0
  309. package/dist/esm/api/resources/rcs/resources/test/client/requests/TestAgentWhitelistRequest.mjs +2 -0
  310. package/dist/esm/api/resources/rcs/resources/test/client/requests/TestGetWhitelistStatusRequest.d.mts +20 -0
  311. package/dist/esm/api/resources/rcs/resources/test/client/requests/TestGetWhitelistStatusRequest.mjs +2 -0
  312. package/dist/esm/api/resources/rcs/resources/test/client/requests/UpdateTestAgentRequest.d.mts +59 -0
  313. package/dist/esm/api/resources/rcs/resources/test/client/requests/UpdateTestAgentRequest.mjs +2 -0
  314. package/dist/esm/api/resources/rcs/resources/test/client/requests/index.d.mts +4 -0
  315. package/dist/esm/api/resources/rcs/resources/test/client/requests/index.mjs +1 -0
  316. package/dist/esm/api/resources/rcs/resources/test/index.d.mts +1 -0
  317. package/dist/esm/api/resources/rcs/resources/test/index.mjs +1 -0
  318. package/dist/esm/api/resources/rcs/resources/whitelistedNumbers/client/Client.d.mts +29 -0
  319. package/dist/esm/api/resources/rcs/resources/whitelistedNumbers/client/Client.mjs +96 -0
  320. package/dist/esm/api/resources/rcs/resources/whitelistedNumbers/client/index.d.mts +1 -0
  321. package/dist/esm/api/resources/rcs/resources/whitelistedNumbers/client/index.mjs +1 -0
  322. package/dist/esm/api/resources/rcs/resources/whitelistedNumbers/client/requests/ListTestNumbersParams.d.mts +23 -0
  323. package/dist/esm/api/resources/rcs/resources/whitelistedNumbers/client/requests/ListTestNumbersParams.mjs +10 -0
  324. package/dist/esm/api/resources/rcs/resources/whitelistedNumbers/client/requests/index.d.mts +1 -0
  325. package/dist/esm/api/resources/rcs/resources/whitelistedNumbers/client/requests/index.mjs +1 -0
  326. package/dist/esm/api/resources/rcs/resources/whitelistedNumbers/index.d.mts +1 -0
  327. package/dist/esm/api/resources/rcs/resources/whitelistedNumbers/index.mjs +1 -0
  328. package/dist/esm/api/resources/tools/resources/url/client/Client.d.mts +15 -0
  329. package/dist/esm/api/resources/tools/resources/url/client/Client.mjs +70 -0
  330. package/dist/esm/api/resources/tools/resources/url/client/requests/ListLinksParams.d.mts +10 -0
  331. package/dist/esm/api/resources/tools/resources/url/client/requests/ListLinksParams.mjs +2 -0
  332. package/dist/esm/api/resources/tools/resources/url/client/requests/index.d.mts +1 -0
  333. package/dist/esm/api/resources/webhooks/client/Client.d.mts +15 -0
  334. package/dist/esm/api/resources/webhooks/client/Client.mjs +70 -0
  335. package/dist/esm/api/resources/webhooks/client/requests/ListWebhooksParams.d.mts +19 -0
  336. package/dist/esm/api/resources/webhooks/client/requests/ListWebhooksParams.mjs +9 -0
  337. package/dist/esm/api/resources/webhooks/client/requests/index.d.mts +1 -0
  338. package/dist/esm/api/types/AgentEmailEntry.d.mts +9 -0
  339. package/dist/esm/api/types/AgentEmailEntry.mjs +2 -0
  340. package/dist/esm/api/types/AgentPhoneEntry.d.mts +9 -0
  341. package/dist/esm/api/types/AgentPhoneEntry.mjs +2 -0
  342. package/dist/esm/api/types/AgentSummary.d.mts +94 -0
  343. package/dist/esm/api/types/AgentSummary.mjs +19 -0
  344. package/dist/esm/api/types/AgentUseCase.d.mts +15 -0
  345. package/dist/esm/api/types/AgentUseCase.mjs +15 -0
  346. package/dist/esm/api/types/AgentWebsiteEntry.d.mts +9 -0
  347. package/dist/esm/api/types/AgentWebsiteEntry.mjs +2 -0
  348. package/dist/esm/api/types/AudienceSummary.d.mts +12 -0
  349. package/dist/esm/api/types/AudienceSummary.mjs +2 -0
  350. package/dist/esm/api/types/BlastDetails.d.mts +1 -1
  351. package/dist/esm/api/types/BlastSummary.d.mts +27 -0
  352. package/dist/esm/api/types/BlastSummary.mjs +10 -0
  353. package/dist/esm/api/types/CarrierLaunchStatus.d.mts +12 -0
  354. package/dist/esm/api/types/CarrierLaunchStatus.mjs +12 -0
  355. package/dist/esm/api/types/CarrierLaunches.d.mts +14 -0
  356. package/dist/esm/api/types/CarrierLaunches.mjs +2 -0
  357. package/dist/esm/api/types/DlcCampaignSummary.d.mts +26 -0
  358. package/dist/esm/api/types/DlcCampaignSummary.mjs +11 -0
  359. package/dist/esm/api/types/ExtendedRcsCampaign.d.mts +6 -20
  360. package/dist/esm/api/types/FallbackMessage.d.mts +6 -5
  361. package/dist/esm/api/types/LinkSummary.d.mts +10 -0
  362. package/dist/esm/api/types/LinkSummary.mjs +2 -0
  363. package/dist/esm/api/types/ListAgentsResponse.d.mts +6 -0
  364. package/dist/esm/api/types/ListAgentsResponse.mjs +2 -0
  365. package/dist/esm/api/types/ListAudiencesResponse.d.mts +6 -0
  366. package/dist/esm/api/types/ListAudiencesResponse.mjs +2 -0
  367. package/dist/esm/api/types/ListBlastsResponse.d.mts +6 -0
  368. package/dist/esm/api/types/ListBlastsResponse.mjs +2 -0
  369. package/dist/esm/api/types/ListBrandsResponse.d.mts +6 -0
  370. package/dist/esm/api/types/ListBrandsResponse.mjs +2 -0
  371. package/dist/esm/api/types/ListContactsResponse.d.mts +6 -0
  372. package/dist/esm/api/types/ListContactsResponse.mjs +2 -0
  373. package/dist/esm/api/types/ListDlcCampaignsResponse.d.mts +6 -0
  374. package/dist/esm/api/types/ListDlcCampaignsResponse.mjs +2 -0
  375. package/dist/esm/api/types/ListLinksResponse.d.mts +6 -0
  376. package/dist/esm/api/types/ListLinksResponse.mjs +2 -0
  377. package/dist/esm/api/types/ListMessagesResponse.d.mts +6 -0
  378. package/dist/esm/api/types/ListMessagesResponse.mjs +2 -0
  379. package/dist/esm/api/types/ListPhoneNumbersResponse.d.mts +6 -0
  380. package/dist/esm/api/types/ListPhoneNumbersResponse.mjs +2 -0
  381. package/dist/esm/api/types/ListRcsCampaignsResponse.d.mts +6 -0
  382. package/dist/esm/api/types/ListRcsCampaignsResponse.mjs +2 -0
  383. package/dist/esm/api/types/ListScheduledMessagesResponse.d.mts +6 -0
  384. package/dist/esm/api/types/ListScheduledMessagesResponse.mjs +2 -0
  385. package/dist/esm/api/types/ListTestNumbersResponse.d.mts +6 -0
  386. package/dist/esm/api/types/ListTestNumbersResponse.mjs +2 -0
  387. package/dist/esm/api/types/ListTollFreeCampaignsResponse.d.mts +6 -0
  388. package/dist/esm/api/types/ListTollFreeCampaignsResponse.mjs +2 -0
  389. package/dist/esm/api/types/ListWebhooksResponse.d.mts +6 -0
  390. package/dist/esm/api/types/ListWebhooksResponse.mjs +2 -0
  391. package/dist/esm/api/types/Message.d.mts +0 -8
  392. package/dist/esm/api/types/MessageEvent.d.mts +21 -14
  393. package/dist/esm/api/types/MessageEvent.mjs +1 -1
  394. package/dist/esm/api/types/MessageList.d.mts +1 -1
  395. package/dist/esm/api/types/MessageSummary.d.mts +71 -0
  396. package/dist/esm/api/types/MessageSummary.mjs +33 -0
  397. package/dist/esm/api/types/{MessageWithReaction.d.mts → MessageWithReactions.d.mts} +7 -7
  398. package/dist/esm/api/types/{MessageWithReaction.mjs → MessageWithReactions.mjs} +4 -4
  399. package/dist/esm/api/types/OwnedPhoneNumber.d.mts +14 -0
  400. package/dist/esm/api/types/OwnedPhoneNumber.mjs +2 -0
  401. package/dist/esm/api/types/RcsAgentDetails.d.mts +81 -0
  402. package/dist/esm/api/types/RcsAgentDetails.mjs +17 -0
  403. package/dist/esm/api/types/RcsAgentResponse.d.mts +17 -0
  404. package/dist/esm/api/types/RcsAgentResponse.mjs +2 -0
  405. package/dist/esm/api/types/RcsCampaign.d.mts +6 -20
  406. package/dist/esm/api/types/RcsCampaignSummary.d.mts +26 -0
  407. package/dist/esm/api/types/RcsCampaignSummary.mjs +11 -0
  408. package/dist/esm/api/types/RcsWhitelistStatus.d.mts +13 -0
  409. package/dist/esm/api/types/RcsWhitelistStatus.mjs +13 -0
  410. package/dist/esm/api/types/ScheduledMessageSummary.d.mts +29 -0
  411. package/dist/esm/api/types/ScheduledMessageSummary.mjs +10 -0
  412. package/dist/esm/api/types/SendRichMessageOptions.d.mts +0 -2
  413. package/dist/esm/api/types/SentRichMessageFallbackMms.d.mts +10 -0
  414. package/dist/esm/api/types/SentRichMessageFallbackMms.mjs +2 -0
  415. package/dist/esm/api/types/SentRichMessageFallbackSms.d.mts +10 -0
  416. package/dist/esm/api/types/SentRichMessageFallbackSms.mjs +2 -0
  417. package/dist/esm/api/types/TestAgentResponse.d.mts +19 -0
  418. package/dist/esm/api/types/TestAgentResponse.mjs +2 -0
  419. package/dist/esm/api/types/TestAgentWhitelistResponse.d.mts +7 -0
  420. package/dist/esm/api/types/TestAgentWhitelistResponse.mjs +2 -0
  421. package/dist/esm/api/types/TollFreeCampaignSummary.d.mts +26 -0
  422. package/dist/esm/api/types/TollFreeCampaignSummary.mjs +11 -0
  423. package/dist/esm/api/types/WebhookSummary.d.mts +23 -0
  424. package/dist/esm/api/types/WebhookSummary.mjs +10 -0
  425. package/dist/esm/api/types/WhitelistedNumberSummary.d.mts +19 -0
  426. package/dist/esm/api/types/WhitelistedNumberSummary.mjs +10 -0
  427. package/dist/esm/api/types/index.d.mts +40 -3
  428. package/dist/esm/api/types/index.mjs +40 -3
  429. package/dist/esm/version.d.mts +1 -1
  430. package/dist/esm/version.mjs +1 -1
  431. package/package.json +2 -2
  432. package/reference.md +1414 -162
  433. package/dist/cjs/api/resources/rcs/client/requests/RcsWhitelistRequest.d.ts +0 -13
  434. package/dist/cjs/api/types/RcsCampaignUseCaseEnum.d.ts +0 -37
  435. package/dist/cjs/api/types/RcsCampaignUseCaseEnum.js +0 -40
  436. package/dist/cjs/api/types/RcsWhitelistResponse.d.ts +0 -7
  437. package/dist/esm/api/resources/rcs/client/requests/RcsWhitelistRequest.d.mts +0 -13
  438. package/dist/esm/api/types/RcsCampaignUseCaseEnum.d.mts +0 -37
  439. package/dist/esm/api/types/RcsCampaignUseCaseEnum.mjs +0 -37
  440. package/dist/esm/api/types/RcsWhitelistResponse.d.mts +0 -7
  441. /package/dist/cjs/api/resources/{rcs/client/requests/RcsWhitelistRequest.js → audiences/client/requests/ListAudiencesParams.js} +0 -0
  442. /package/dist/cjs/api/{types/RcsWhitelistResponse.js → resources/contacts/client/requests/ListContactsParams.js} +0 -0
  443. /package/dist/esm/api/resources/{rcs/client/requests/RcsWhitelistRequest.mjs → audiences/client/requests/ListAudiencesParams.mjs} +0 -0
  444. /package/dist/esm/api/{types/RcsWhitelistResponse.mjs → resources/contacts/client/requests/ListContactsParams.mjs} +0 -0
@@ -25,16 +25,13 @@ import type * as Pinnacle from "../../../../../../index.js";
25
25
  * campaignId: "rcs_1234567890",
26
26
  * expectedAgentResponses: ["Here are the things I can help you with.", "I can assist you with booking an appointment, or you may choose to book manually.", "Here are the available times to connect with a representative tomorrow.", "Your appointment has been scheduled."],
27
27
  * links: {
28
- * privacyPolicy: "https://www.trypinnacle.app/privacy",
29
- * termsOfService: "https://www.trypinnacle.app/terms"
28
+ * privacyPolicy: "\u201Chttps://www.trypinnacle.app/privacy\u201D",
29
+ * termsOfService: "\u201Chttps://www.trypinnacle.app/terms\u201D"
30
30
  * },
31
- * useCase: {
32
- * behavior: "Pinnacle is a developer-focused RCS assistant that helps teams design, test, and optimize rich messaging experiences across SMS, MMS, and RCS. The agent acts as both an \u201Conboarding guide\u201D for new customers and a \u201Cbest-practices coach\u201D for existing teams exploring higher-value RCS workflows like rich cards, carousels, and suggested actions.<br>\nThe agent delivers a mix of operational updates and educational content (2\u20136 messages/month). Content includes important platform notices (e.g., deliverability or throughput changes), implementation tips with sample RCS templates, and personalized recommendations on how to upgrade existing SMS campaigns into richer, higher-converting RCS conversations.\n",
33
- * value: "OTHER"
34
- * },
35
- * optInTermsAndConditions: "We ensure consent through an explicit opt-in process that follows 10DLC best practices.Users must agree to receive messages from Pinnacle before the agent sends them any messages.<br>\nUsers agree to these messages by signing an opt-in paper form that they can be found online at https://www.pinnacle.sh/opt-in. We only send messages once users have filled out the form and submitted it to us via email or through the dashboard.\n",
36
- * messagingType: "MULTI_USE",
37
- * carrierDescription: "Demonstrate the power of RCS to medium and large companies already sending massive SMS/MMS volumes through our platform. These clients send conversational messages in industries such as commerce, appointments, and customer support.",
31
+ * useCaseDescription: "Pinnacle is a developer-focused RCS assistant that helps teams design, test, and optimize rich messaging experiences across SMS, MMS, and RCS. The agent acts as both an \u201Conboarding guide\u201D for new customers and a \u201Cbest-practices coach\u201D for existing teams exploring higher-value RCS workflows like rich cards, carousels, and suggested actions.<br>\nThe agent delivers a mix of operational updates and educational content (2\u20136 messages/month). Content includes important platform notices (e.g., deliverability or throughput changes), implementation tips with sample RCS templates, and personalized recommendations on how to upgrade existing SMS campaigns into richer, higher-converting RCS conversations.\n",
32
+ * messagingType: "OTP",
33
+ * ctaMedia: "\u201Chttps://www.pinnacle.sh/send\u201D",
34
+ * optInMethod: "We ensure consent through an explicit opt-in process that follows 10DLC best practices.Users must agree to receive messages from Pinnacle before the agent sends them any messages.<br>\nUsers agree to these messages by signing an opt-in paper form that they can be found online at https://www.pinnacle.sh/opt-in. We only send messages once users have filled out the form and submitted it to us via email or through the dashboard.\n",
38
35
  * keywords: {
39
36
  * HELP: {
40
37
  * message: "Email founders@trypinnacle.app for support.",
@@ -53,9 +50,6 @@ import type * as Pinnacle from "../../../../../../index.js";
53
50
  * monthlyWebsite: 10000,
54
51
  * monthlyRcsEstimate: 10000
55
52
  * },
56
- * agentTriggers: "The agent sends the first message when the user subscribes to Pinnacle. Messages are based on user actions such as pressing suggestion buttons. External triggers such as reminders can be setup by users in advance for a later time.",
57
- * interactionDescription: "The agent's primary interaction will be customer service \u2014 helping users with questions, troubleshooting issues, and providing quick assistance through chat. Other interactions include appointment management and sending notifications to the user.",
58
- * isConversational: true,
59
53
  * ctaLanguage: "By checking this box and submitting this form, you consent to receive transactional text messages for support, appointment, and reminder messages from Pinnacle Software Development Inc. Reply STOP to opt out. Reply HELP for help. Standard message and data rates may apply. Message frequency may vary. View our Terms and Conditions at https://www.pinnacle.sh/terms. View our Privacy Policy at https://www.pinnacle.sh/privacy.",
60
54
  * demoTrigger: "Text \"START\" to trigger the flow."
61
55
  * }
@@ -74,21 +68,15 @@ export interface UpsertRcsCampaignParams {
74
68
  expectedAgentResponses?: string[];
75
69
  /** Legal documentation links. */
76
70
  links?: UpsertRcsCampaignParams.Links;
77
- /** Use case classification for the campaign. */
78
- useCase?: UpsertRcsCampaignParams.UseCase;
79
- /** Details on how opt-in is acquired. If it is done through a website or app, provide the link. See the [Opt-In Terms and Conditions](/guides/campaigns/rcs-compliance#opt-in-terms-and-conditions) section for requirements. */
80
- optInTermsAndConditions?: string;
71
+ /** Detailed summary of what the brand is and how this agent will be used. See the [Use Case Behavior](/guides/campaigns/rcs-compliance#use-case-behavior) section for requirements. */
72
+ useCaseDescription?: string;
81
73
  messagingType?: Pinnacle.RcsMessagingTypeEnum;
82
- /** Description of the agent's purpose, shown to carriers for approval. See the [Carrier Description](/guides/campaigns/rcs-compliance#carrier-description) section for requirements. */
83
- carrierDescription?: string;
74
+ /** URL to the opt-in form or a URL to a screenshot of the opt-in CTA. */
75
+ ctaMedia?: string;
76
+ /** Details on how opt-in is acquired. If it is done through a website or app, provide the link. See the [Opt-In Method](/guides/campaigns/rcs-compliance#opt-in-method) section for requirements. */
77
+ optInMethod?: string;
84
78
  keywords?: UpsertRcsCampaignParams.Keywords;
85
79
  traffic?: UpsertRcsCampaignParams.Traffic;
86
- /** Explanation of how the agent is triggered. This includes how the first message is delivered, whether messages follow a schedule or triggered by user actions, and any external triggers. See the [Agent Triggers](/guides/campaigns/rcs-compliance#agent-triggers) section for requirements. */
87
- agentTriggers?: string;
88
- /** Description of all agent interactions, including primary and secondary use cases. See the [Interaction Description](/guides/campaigns/rcs-compliance#interaction-description) section for requirements. */
89
- interactionDescription?: string;
90
- /** Whether the agent supports conversational flows or respond to P2A messages from the users. Set to false for one-way messages from agent to user. */
91
- isConversational?: boolean;
92
80
  /** Required text that appears next to the opt-in checkbox for your opt-in form. This checkbox has to be unchecked by default. See the [CTA Language](/guides/campaigns/rcs-compliance#cta-language-opt-in-disclosure) section for requirements. */
93
81
  ctaLanguage?: string;
94
82
  /** Instructions on how an external reviewer can trigger messages and an example flow from the agent. This is usually an inbound text message to the agent that will start a flow of messages between the agent and the user. See the [Demo Trigger](/guides/campaigns/rcs-compliance#demo-trigger) section for requirements. */
@@ -175,14 +163,6 @@ export declare namespace UpsertRcsCampaignParams {
175
163
  /** Terms of service URL. */
176
164
  termsOfService?: string;
177
165
  }
178
- /**
179
- * Use case classification for the campaign.
180
- */
181
- interface UseCase {
182
- /** Detailed summary of what the brand is and how this agent will be used. See the [Use Case Behavior](/guides/campaigns/rcs-compliance#use-case-behavior) section for requirements. */
183
- behavior?: string;
184
- value?: Pinnacle.RcsCampaignUseCaseEnum;
185
- }
186
166
  interface Keywords {
187
167
  HELP?: Keywords.Help;
188
168
  OPT_IN?: Keywords.OptIn;
@@ -1 +1,2 @@
1
+ export type { ListRcsCampaignsParams } from "./ListRcsCampaignsParams.js";
1
2
  export type { UpsertRcsCampaignParams } from "./UpsertRcsCampaignParams.js";
@@ -140,5 +140,20 @@ export declare class TollFree {
140
140
  */
141
141
  validate(request: Pinnacle.ValidateCampaignParams, requestOptions?: TollFree.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignValidationResult>;
142
142
  private __validate;
143
+ /**
144
+ * List all toll-free campaigns with optional filtering and pagination. Results are sorted by creation date, newest first.
145
+ *
146
+ * @param {Pinnacle.campaigns.ListTollFreeCampaignsParams} request
147
+ * @param {TollFree.RequestOptions} requestOptions - Request-specific configuration.
148
+ *
149
+ * @throws {@link Pinnacle.BadRequestError}
150
+ * @throws {@link Pinnacle.UnauthorizedError}
151
+ * @throws {@link Pinnacle.InternalServerError}
152
+ *
153
+ * @example
154
+ * await client.campaigns.tollFree.list()
155
+ */
156
+ list(request?: Pinnacle.campaigns.ListTollFreeCampaignsParams, requestOptions?: TollFree.RequestOptions): core.HttpResponsePromise<Pinnacle.ListTollFreeCampaignsResponse>;
157
+ private __list;
143
158
  protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | undefined>>;
144
159
  }
@@ -477,6 +477,79 @@ class TollFree {
477
477
  }
478
478
  });
479
479
  }
480
+ /**
481
+ * List all toll-free campaigns with optional filtering and pagination. Results are sorted by creation date, newest first.
482
+ *
483
+ * @param {Pinnacle.campaigns.ListTollFreeCampaignsParams} request
484
+ * @param {TollFree.RequestOptions} requestOptions - Request-specific configuration.
485
+ *
486
+ * @throws {@link Pinnacle.BadRequestError}
487
+ * @throws {@link Pinnacle.UnauthorizedError}
488
+ * @throws {@link Pinnacle.InternalServerError}
489
+ *
490
+ * @example
491
+ * await client.campaigns.tollFree.list()
492
+ */
493
+ list(request = {}, requestOptions) {
494
+ return core.HttpResponsePromise.fromPromise(this.__list(request, requestOptions));
495
+ }
496
+ __list() {
497
+ return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
498
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j;
499
+ const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
500
+ const _response = yield core.fetcher({
501
+ url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PinnacleEnvironment.Default, "campaigns/toll-free/list"),
502
+ method: "POST",
503
+ headers: _headers,
504
+ contentType: "application/json",
505
+ queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
506
+ requestType: "json",
507
+ body: request,
508
+ timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
509
+ maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
510
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
511
+ fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
512
+ logging: this._options.logging,
513
+ });
514
+ if (_response.ok) {
515
+ return {
516
+ data: _response.body,
517
+ rawResponse: _response.rawResponse,
518
+ };
519
+ }
520
+ if (_response.error.reason === "status-code") {
521
+ switch (_response.error.statusCode) {
522
+ case 400:
523
+ throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
524
+ case 401:
525
+ throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
526
+ case 500:
527
+ throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
528
+ default:
529
+ throw new errors.PinnacleError({
530
+ statusCode: _response.error.statusCode,
531
+ body: _response.error.body,
532
+ rawResponse: _response.rawResponse,
533
+ });
534
+ }
535
+ }
536
+ switch (_response.error.reason) {
537
+ case "non-json":
538
+ throw new errors.PinnacleError({
539
+ statusCode: _response.error.statusCode,
540
+ body: _response.error.rawBody,
541
+ rawResponse: _response.rawResponse,
542
+ });
543
+ case "timeout":
544
+ throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /campaigns/toll-free/list.");
545
+ case "unknown":
546
+ throw new errors.PinnacleError({
547
+ message: _response.error.errorMessage,
548
+ rawResponse: _response.rawResponse,
549
+ });
550
+ }
551
+ });
552
+ }
480
553
  _getCustomAuthorizationHeaders() {
481
554
  return __awaiter(this, void 0, void 0, function* () {
482
555
  const apiKeyValue = yield core.Supplier.get(this._options.apiKey);
@@ -0,0 +1,21 @@
1
+ /**
2
+ * @example
3
+ * {}
4
+ */
5
+ export interface ListTollFreeCampaignsParams {
6
+ pageIndex?: number;
7
+ pageSize?: number;
8
+ status?: ListTollFreeCampaignsParams.Status;
9
+ brandId?: string;
10
+ /** Filter by campaign name (partial match, case-insensitive). */
11
+ name?: string;
12
+ }
13
+ export declare namespace ListTollFreeCampaignsParams {
14
+ const Status: {
15
+ readonly Incomplete: "INCOMPLETE";
16
+ readonly InReview: "IN REVIEW";
17
+ readonly Verified: "VERIFIED";
18
+ readonly Failed: "FAILED";
19
+ };
20
+ type Status = (typeof Status)[keyof typeof Status];
21
+ }
@@ -0,0 +1,13 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.ListTollFreeCampaignsParams = void 0;
5
+ var ListTollFreeCampaignsParams;
6
+ (function (ListTollFreeCampaignsParams) {
7
+ ListTollFreeCampaignsParams.Status = {
8
+ Incomplete: "INCOMPLETE",
9
+ InReview: "IN REVIEW",
10
+ Verified: "VERIFIED",
11
+ Failed: "FAILED",
12
+ };
13
+ })(ListTollFreeCampaignsParams || (exports.ListTollFreeCampaignsParams = ListTollFreeCampaignsParams = {}));
@@ -1 +1,2 @@
1
+ export type { ListTollFreeCampaignsParams } from "./ListTollFreeCampaignsParams.js";
1
2
  export type { UpsertTollFreeCampaignParams } from "./UpsertTollFreeCampaignParams.js";
@@ -70,5 +70,20 @@ export declare class Contacts {
70
70
  */
71
71
  update(request: Pinnacle.UpdateContactParams, requestOptions?: Contacts.RequestOptions): core.HttpResponsePromise<Pinnacle.UpdatedContactId>;
72
72
  private __update;
73
+ /**
74
+ * List all contacts with optional filtering and pagination. Results are sorted by creation date, newest first.
75
+ *
76
+ * @param {Pinnacle.ListContactsParams} request
77
+ * @param {Contacts.RequestOptions} requestOptions - Request-specific configuration.
78
+ *
79
+ * @throws {@link Pinnacle.BadRequestError}
80
+ * @throws {@link Pinnacle.UnauthorizedError}
81
+ * @throws {@link Pinnacle.InternalServerError}
82
+ *
83
+ * @example
84
+ * await client.contacts.list()
85
+ */
86
+ list(request?: Pinnacle.ListContactsParams, requestOptions?: Contacts.RequestOptions): core.HttpResponsePromise<Pinnacle.ListContactsResponse>;
87
+ private __list;
73
88
  protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | undefined>>;
74
89
  }
@@ -293,6 +293,76 @@ class Contacts {
293
293
  }
294
294
  });
295
295
  }
296
+ /**
297
+ * List all contacts with optional filtering and pagination. Results are sorted by creation date, newest first.
298
+ *
299
+ * @param {Pinnacle.ListContactsParams} request
300
+ * @param {Contacts.RequestOptions} requestOptions - Request-specific configuration.
301
+ *
302
+ * @throws {@link Pinnacle.BadRequestError}
303
+ * @throws {@link Pinnacle.UnauthorizedError}
304
+ * @throws {@link Pinnacle.InternalServerError}
305
+ *
306
+ * @example
307
+ * await client.contacts.list()
308
+ */
309
+ list(request = {}, requestOptions) {
310
+ return core.HttpResponsePromise.fromPromise(this.__list(request, requestOptions));
311
+ }
312
+ __list() {
313
+ return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
314
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j;
315
+ const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
316
+ const _response = yield core.fetcher({
317
+ url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PinnacleEnvironment.Default, "contacts/list"),
318
+ method: "POST",
319
+ headers: _headers,
320
+ contentType: "application/json",
321
+ queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
322
+ requestType: "json",
323
+ body: request,
324
+ timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
325
+ maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
326
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
327
+ fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
328
+ logging: this._options.logging,
329
+ });
330
+ if (_response.ok) {
331
+ return { data: _response.body, rawResponse: _response.rawResponse };
332
+ }
333
+ if (_response.error.reason === "status-code") {
334
+ switch (_response.error.statusCode) {
335
+ case 400:
336
+ throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
337
+ case 401:
338
+ throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
339
+ case 500:
340
+ throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
341
+ default:
342
+ throw new errors.PinnacleError({
343
+ statusCode: _response.error.statusCode,
344
+ body: _response.error.body,
345
+ rawResponse: _response.rawResponse,
346
+ });
347
+ }
348
+ }
349
+ switch (_response.error.reason) {
350
+ case "non-json":
351
+ throw new errors.PinnacleError({
352
+ statusCode: _response.error.statusCode,
353
+ body: _response.error.rawBody,
354
+ rawResponse: _response.rawResponse,
355
+ });
356
+ case "timeout":
357
+ throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /contacts/list.");
358
+ case "unknown":
359
+ throw new errors.PinnacleError({
360
+ message: _response.error.errorMessage,
361
+ rawResponse: _response.rawResponse,
362
+ });
363
+ }
364
+ });
365
+ }
296
366
  _getCustomAuthorizationHeaders() {
297
367
  return __awaiter(this, void 0, void 0, function* () {
298
368
  const apiKeyValue = yield core.Supplier.get(this._options.apiKey);
@@ -0,0 +1,16 @@
1
+ /**
2
+ * @example
3
+ * {}
4
+ */
5
+ export interface ListContactsParams {
6
+ pageIndex?: number;
7
+ pageSize?: number;
8
+ /** Filter contacts by phone number (E.164 format). */
9
+ phoneNumber?: string;
10
+ /** Filter contacts by name (partial match). */
11
+ name?: string;
12
+ /** Filter contacts by tags. */
13
+ tags?: string[];
14
+ /** Filter contacts by archived status. */
15
+ isArchived?: boolean;
16
+ }
@@ -1,3 +1,4 @@
1
1
  export type { ContactsGetRequest } from "./ContactsGetRequest.js";
2
2
  export type { CreateContactParams } from "./CreateContactParams.js";
3
+ export type { ListContactsParams } from "./ListContactsParams.js";
3
4
  export type { UpdateContactParams } from "./UpdateContactParams.js";
@@ -2,9 +2,11 @@ import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClie
2
2
  import * as core from "../../../../core/index.js";
3
3
  import * as Pinnacle from "../../../index.js";
4
4
  import { Blast } from "../resources/blast/client/Client.js";
5
+ import { Blasts } from "../resources/blasts/client/Client.js";
5
6
  import { Mms } from "../resources/mms/client/Client.js";
6
7
  import { Rcs } from "../resources/rcs/client/Client.js";
7
8
  import { Schedule } from "../resources/schedule/client/Client.js";
9
+ import { Schedules } from "../resources/schedules/client/Client.js";
8
10
  import { Sms } from "../resources/sms/client/Client.js";
9
11
  export declare namespace Messages {
10
12
  interface Options extends BaseClientOptions {
@@ -19,12 +21,16 @@ export declare class Messages {
19
21
  protected _rcs: Rcs | undefined;
20
22
  protected _blast: Blast | undefined;
21
23
  protected _schedule: Schedule | undefined;
24
+ protected _schedules: Schedules | undefined;
25
+ protected _blasts: Blasts | undefined;
22
26
  constructor(_options: Messages.Options);
23
27
  get sms(): Sms;
24
28
  get mms(): Mms;
25
29
  get rcs(): Rcs;
26
30
  get blast(): Blast;
27
31
  get schedule(): Schedule;
32
+ get schedules(): Schedules;
33
+ get blasts(): Blasts;
28
34
  /**
29
35
  * Retrieve a previously sent message.
30
36
  *
@@ -67,5 +73,20 @@ export declare class Messages {
67
73
  */
68
74
  react(request: Pinnacle.ReactMessageParams, requestOptions?: Messages.RequestOptions): core.HttpResponsePromise<Pinnacle.ReactionResult>;
69
75
  private __react;
76
+ /**
77
+ * List all messages with optional filtering and pagination. Results are sorted by creation date, newest first.
78
+ *
79
+ * @param {Pinnacle.ListMessagesParams} request
80
+ * @param {Messages.RequestOptions} requestOptions - Request-specific configuration.
81
+ *
82
+ * @throws {@link Pinnacle.BadRequestError}
83
+ * @throws {@link Pinnacle.UnauthorizedError}
84
+ * @throws {@link Pinnacle.InternalServerError}
85
+ *
86
+ * @example
87
+ * await client.messages.list()
88
+ */
89
+ list(request?: Pinnacle.ListMessagesParams, requestOptions?: Messages.RequestOptions): core.HttpResponsePromise<Pinnacle.ListMessagesResponse>;
90
+ private __list;
70
91
  protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | undefined>>;
71
92
  }
@@ -50,25 +50,27 @@ const environments = __importStar(require("../../../../environments.js"));
50
50
  const errors = __importStar(require("../../../../errors/index.js"));
51
51
  const Pinnacle = __importStar(require("../../../index.js"));
52
52
  const Client_js_1 = require("../resources/blast/client/Client.js");
53
- const Client_js_2 = require("../resources/mms/client/Client.js");
54
- const Client_js_3 = require("../resources/rcs/client/Client.js");
55
- const Client_js_4 = require("../resources/schedule/client/Client.js");
56
- const Client_js_5 = require("../resources/sms/client/Client.js");
53
+ const Client_js_2 = require("../resources/blasts/client/Client.js");
54
+ const Client_js_3 = require("../resources/mms/client/Client.js");
55
+ const Client_js_4 = require("../resources/rcs/client/Client.js");
56
+ const Client_js_5 = require("../resources/schedule/client/Client.js");
57
+ const Client_js_6 = require("../resources/schedules/client/Client.js");
58
+ const Client_js_7 = require("../resources/sms/client/Client.js");
57
59
  class Messages {
58
60
  constructor(_options) {
59
61
  this._options = _options;
60
62
  }
61
63
  get sms() {
62
64
  var _a;
63
- return ((_a = this._sms) !== null && _a !== void 0 ? _a : (this._sms = new Client_js_5.Sms(this._options)));
65
+ return ((_a = this._sms) !== null && _a !== void 0 ? _a : (this._sms = new Client_js_7.Sms(this._options)));
64
66
  }
65
67
  get mms() {
66
68
  var _a;
67
- return ((_a = this._mms) !== null && _a !== void 0 ? _a : (this._mms = new Client_js_2.Mms(this._options)));
69
+ return ((_a = this._mms) !== null && _a !== void 0 ? _a : (this._mms = new Client_js_3.Mms(this._options)));
68
70
  }
69
71
  get rcs() {
70
72
  var _a;
71
- return ((_a = this._rcs) !== null && _a !== void 0 ? _a : (this._rcs = new Client_js_3.Rcs(this._options)));
73
+ return ((_a = this._rcs) !== null && _a !== void 0 ? _a : (this._rcs = new Client_js_4.Rcs(this._options)));
72
74
  }
73
75
  get blast() {
74
76
  var _a;
@@ -76,7 +78,15 @@ class Messages {
76
78
  }
77
79
  get schedule() {
78
80
  var _a;
79
- return ((_a = this._schedule) !== null && _a !== void 0 ? _a : (this._schedule = new Client_js_4.Schedule(this._options)));
81
+ return ((_a = this._schedule) !== null && _a !== void 0 ? _a : (this._schedule = new Client_js_5.Schedule(this._options)));
82
+ }
83
+ get schedules() {
84
+ var _a;
85
+ return ((_a = this._schedules) !== null && _a !== void 0 ? _a : (this._schedules = new Client_js_6.Schedules(this._options)));
86
+ }
87
+ get blasts() {
88
+ var _a;
89
+ return ((_a = this._blasts) !== null && _a !== void 0 ? _a : (this._blasts = new Client_js_2.Blasts(this._options)));
80
90
  }
81
91
  /**
82
92
  * Retrieve a previously sent message.
@@ -239,6 +249,76 @@ class Messages {
239
249
  }
240
250
  });
241
251
  }
252
+ /**
253
+ * List all messages with optional filtering and pagination. Results are sorted by creation date, newest first.
254
+ *
255
+ * @param {Pinnacle.ListMessagesParams} request
256
+ * @param {Messages.RequestOptions} requestOptions - Request-specific configuration.
257
+ *
258
+ * @throws {@link Pinnacle.BadRequestError}
259
+ * @throws {@link Pinnacle.UnauthorizedError}
260
+ * @throws {@link Pinnacle.InternalServerError}
261
+ *
262
+ * @example
263
+ * await client.messages.list()
264
+ */
265
+ list(request = {}, requestOptions) {
266
+ return core.HttpResponsePromise.fromPromise(this.__list(request, requestOptions));
267
+ }
268
+ __list() {
269
+ return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
270
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j;
271
+ const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
272
+ const _response = yield core.fetcher({
273
+ url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PinnacleEnvironment.Default, "messages/list"),
274
+ method: "POST",
275
+ headers: _headers,
276
+ contentType: "application/json",
277
+ queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
278
+ requestType: "json",
279
+ body: request,
280
+ timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
281
+ maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
282
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
283
+ fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
284
+ logging: this._options.logging,
285
+ });
286
+ if (_response.ok) {
287
+ return { data: _response.body, rawResponse: _response.rawResponse };
288
+ }
289
+ if (_response.error.reason === "status-code") {
290
+ switch (_response.error.statusCode) {
291
+ case 400:
292
+ throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
293
+ case 401:
294
+ throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
295
+ case 500:
296
+ throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
297
+ default:
298
+ throw new errors.PinnacleError({
299
+ statusCode: _response.error.statusCode,
300
+ body: _response.error.body,
301
+ rawResponse: _response.rawResponse,
302
+ });
303
+ }
304
+ }
305
+ switch (_response.error.reason) {
306
+ case "non-json":
307
+ throw new errors.PinnacleError({
308
+ statusCode: _response.error.statusCode,
309
+ body: _response.error.rawBody,
310
+ rawResponse: _response.rawResponse,
311
+ });
312
+ case "timeout":
313
+ throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /messages/list.");
314
+ case "unknown":
315
+ throw new errors.PinnacleError({
316
+ message: _response.error.errorMessage,
317
+ rawResponse: _response.rawResponse,
318
+ });
319
+ }
320
+ });
321
+ }
242
322
  _getCustomAuthorizationHeaders() {
243
323
  return __awaiter(this, void 0, void 0, function* () {
244
324
  const apiKeyValue = yield core.Supplier.get(this._options.apiKey);
@@ -0,0 +1,55 @@
1
+ /**
2
+ * @example
3
+ * {}
4
+ */
5
+ export interface ListMessagesParams {
6
+ pageIndex?: number;
7
+ pageSize?: number;
8
+ direction?: ListMessagesParams.Direction;
9
+ status?: ListMessagesParams.Status;
10
+ type?: ListMessagesParams.Type;
11
+ /** Filter by the method used to send the message. */
12
+ method?: ListMessagesParams.Method;
13
+ /** Filter by sender phone number (E.164 format) or agent id. */
14
+ from?: string;
15
+ /** Filter by recipient phone number (E.164 format). */
16
+ to?: string;
17
+ /** Search message content (partial match, case-insensitive). */
18
+ content?: string;
19
+ /** Filter messages created on or after this date (ISO 8601 format). */
20
+ dateFrom?: string;
21
+ /** Filter messages created on or before this date (ISO 8601 format). */
22
+ dateTo?: string;
23
+ }
24
+ export declare namespace ListMessagesParams {
25
+ const Direction: {
26
+ readonly Inbound: "INBOUND";
27
+ readonly Outbound: "OUTBOUND";
28
+ };
29
+ type Direction = (typeof Direction)[keyof typeof Direction];
30
+ const Status: {
31
+ readonly Pending: "PENDING";
32
+ readonly Sent: "SENT";
33
+ readonly SendFailed: "SEND_FAILED";
34
+ readonly Delivered: "DELIVERED";
35
+ readonly DeliveryFailed: "DELIVERY_FAILED";
36
+ readonly Received: "RECEIVED";
37
+ readonly Read: "READ";
38
+ readonly Queued: "QUEUED";
39
+ readonly FallbackSent: "FALLBACK_SENT";
40
+ };
41
+ type Status = (typeof Status)[keyof typeof Status];
42
+ const Type: {
43
+ readonly Sms: "SMS";
44
+ readonly Mms: "MMS";
45
+ readonly Rcs: "RCS";
46
+ };
47
+ type Type = (typeof Type)[keyof typeof Type];
48
+ /** Filter by the method used to send the message. */
49
+ const Method: {
50
+ readonly Api: "API";
51
+ readonly Sdk: "SDK";
52
+ readonly Other: "OTHER";
53
+ };
54
+ type Method = (typeof Method)[keyof typeof Method];
55
+ }
@@ -0,0 +1,33 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.ListMessagesParams = void 0;
5
+ var ListMessagesParams;
6
+ (function (ListMessagesParams) {
7
+ ListMessagesParams.Direction = {
8
+ Inbound: "INBOUND",
9
+ Outbound: "OUTBOUND",
10
+ };
11
+ ListMessagesParams.Status = {
12
+ Pending: "PENDING",
13
+ Sent: "SENT",
14
+ SendFailed: "SEND_FAILED",
15
+ Delivered: "DELIVERED",
16
+ DeliveryFailed: "DELIVERY_FAILED",
17
+ Received: "RECEIVED",
18
+ Read: "READ",
19
+ Queued: "QUEUED",
20
+ FallbackSent: "FALLBACK_SENT",
21
+ };
22
+ ListMessagesParams.Type = {
23
+ Sms: "SMS",
24
+ Mms: "MMS",
25
+ Rcs: "RCS",
26
+ };
27
+ /** Filter by the method used to send the message. */
28
+ ListMessagesParams.Method = {
29
+ Api: "API",
30
+ Sdk: "SDK",
31
+ Other: "OTHER",
32
+ };
33
+ })(ListMessagesParams || (exports.ListMessagesParams = ListMessagesParams = {}));
@@ -1 +1,2 @@
1
+ export type { ListMessagesParams } from "./ListMessagesParams.js";
1
2
  export type { ReactMessageParams } from "./ReactMessageParams.js";
@@ -56,8 +56,6 @@ export interface BlastRcs {
56
56
  *
57
57
  * Messages will be evenly distributed across these agents.
58
58
  *
59
- * > **Note:** Test agents cannot be used for blasts.
60
- *
61
59
  * **Limit:** 1 min
62
60
  */
63
61
  senders: string[];