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
@@ -0,0 +1,14 @@
1
+ export interface OwnedPhoneNumber {
2
+ /** Phone number in E.164 format. */
3
+ number: string;
4
+ /** Whether SMS messaging is enabled. */
5
+ sms: boolean;
6
+ /** Whether MMS messaging is enabled. */
7
+ mms: boolean;
8
+ /** Whether voice calling is enabled. */
9
+ voice: boolean;
10
+ /** Whether this is a sandbox phone number. */
11
+ isSandbox: boolean;
12
+ /** ISO 8601 timestamp of when the phone number was added. */
13
+ createdAt: string;
14
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,81 @@
1
+ /**
2
+ * The configuration details of an RCS agent, as returned by the GET endpoint.
3
+ */
4
+ export interface RcsAgentDetails {
5
+ /** Display name of the agent. */
6
+ name?: string;
7
+ /** Description of the agent. */
8
+ description?: string;
9
+ /** URL to the agent's logo image. */
10
+ iconUrl?: string | null;
11
+ /** URL to the agent's hero banner image. */
12
+ heroUrl?: string | null;
13
+ /** The agent's brand color hex code. */
14
+ color?: string;
15
+ /** Contact phone numbers for the agent. */
16
+ phones?: RcsAgentDetails.Phones.Item[];
17
+ /** Contact email addresses for the agent. */
18
+ emails?: RcsAgentDetails.Emails.Item[];
19
+ /** Website links for the agent. */
20
+ websites?: RcsAgentDetails.Websites.Item[];
21
+ /** URL to the agent's privacy policy. */
22
+ privacyUrl?: string | null;
23
+ /** URL to the agent's terms and conditions. */
24
+ termsUrl?: string | null;
25
+ /**
26
+ * Whether the agent supports two-way conversations. `true` for agents that respond
27
+ * to user messages, `false` for send-only agents (e.g., notifications).
28
+ */
29
+ isConversational?: boolean | null;
30
+ /**
31
+ * The primary use case for the RCS agent.
32
+ * - `TRANSACTIONAL` — Order confirmations, shipping updates, appointment reminders.
33
+ * - `PROMOTIONAL` — Marketing messages, offers, discounts.
34
+ * - `OTP` — One-time passwords and verification codes.
35
+ * - `MULTI_USE` — A combination of transactional, promotional, and/or OTP messaging.
36
+ */
37
+ agentUseCase?: RcsAgentDetails.AgentUseCase | null;
38
+ }
39
+ export declare namespace RcsAgentDetails {
40
+ type Phones = Phones.Item[];
41
+ namespace Phones {
42
+ interface Item {
43
+ /** Phone number in E.164 format. */
44
+ phone?: string;
45
+ /** Display label for the phone number. */
46
+ label?: string;
47
+ }
48
+ }
49
+ type Emails = Emails.Item[];
50
+ namespace Emails {
51
+ interface Item {
52
+ /** Email address. */
53
+ email?: string;
54
+ /** Display label for the email. */
55
+ label?: string;
56
+ }
57
+ }
58
+ type Websites = Websites.Item[];
59
+ namespace Websites {
60
+ interface Item {
61
+ /** Website URL. */
62
+ url?: string;
63
+ /** Display label for the website. */
64
+ label?: string;
65
+ }
66
+ }
67
+ /**
68
+ * The primary use case for the RCS agent.
69
+ * - `TRANSACTIONAL` — Order confirmations, shipping updates, appointment reminders.
70
+ * - `PROMOTIONAL` — Marketing messages, offers, discounts.
71
+ * - `OTP` — One-time passwords and verification codes.
72
+ * - `MULTI_USE` — A combination of transactional, promotional, and/or OTP messaging.
73
+ */
74
+ const AgentUseCase: {
75
+ readonly Transactional: "TRANSACTIONAL";
76
+ readonly Promotional: "PROMOTIONAL";
77
+ readonly Otp: "OTP";
78
+ readonly MultiUse: "MULTI_USE";
79
+ };
80
+ type AgentUseCase = (typeof AgentUseCase)[keyof typeof AgentUseCase];
81
+ }
@@ -0,0 +1,17 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export var RcsAgentDetails;
3
+ (function (RcsAgentDetails) {
4
+ /**
5
+ * The primary use case for the RCS agent.
6
+ * - `TRANSACTIONAL` — Order confirmations, shipping updates, appointment reminders.
7
+ * - `PROMOTIONAL` — Marketing messages, offers, discounts.
8
+ * - `OTP` — One-time passwords and verification codes.
9
+ * - `MULTI_USE` — A combination of transactional, promotional, and/or OTP messaging.
10
+ */
11
+ RcsAgentDetails.AgentUseCase = {
12
+ Transactional: "TRANSACTIONAL",
13
+ Promotional: "PROMOTIONAL",
14
+ Otp: "OTP",
15
+ MultiUse: "MULTI_USE",
16
+ };
17
+ })(RcsAgentDetails || (RcsAgentDetails = {}));
@@ -0,0 +1,17 @@
1
+ import type * as Pinnacle from "../index.mjs";
2
+ /**
3
+ * Response containing details of an RCS agent.
4
+ */
5
+ export interface RcsAgentResponse {
6
+ /** The unique agent ID, prefixed with `agent_`. */
7
+ id: string;
8
+ /**
9
+ * The agent type.
10
+ * - `TEST` — A test agent for development and testing with whitelisted numbers only.
11
+ */
12
+ type: "TEST";
13
+ /** The RCS service ID assigned to this agent. */
14
+ serviceId: string;
15
+ carrierLaunches: Pinnacle.CarrierLaunches;
16
+ details: Pinnacle.RcsAgentDetails;
17
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,28 @@
1
+ export interface RcsCampaignSummary {
2
+ /** Unique identifier for the RCS campaign. */
3
+ campaignId: string;
4
+ /** Name of the campaign. */
5
+ name?: string;
6
+ /** Current status of the campaign. */
7
+ status: RcsCampaignSummary.Status;
8
+ /** Brand ID associated with this campaign. */
9
+ brandId?: string;
10
+ /** Primary use case for this campaign. */
11
+ useCase?: string;
12
+ /** RCS agent ID associated with this campaign. */
13
+ agentId?: string;
14
+ /** ISO 8601 timestamp of when the campaign was created. */
15
+ createdAt: string;
16
+ /** ISO 8601 timestamp of when the campaign was last updated. */
17
+ updatedAt: string;
18
+ }
19
+ export declare namespace RcsCampaignSummary {
20
+ /** Current status of the campaign. */
21
+ const Status: {
22
+ readonly Incomplete: "INCOMPLETE";
23
+ readonly InReview: "IN REVIEW";
24
+ readonly Verified: "VERIFIED";
25
+ readonly Failed: "FAILED";
26
+ };
27
+ type Status = (typeof Status)[keyof typeof Status];
28
+ }
@@ -0,0 +1,11 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export var RcsCampaignSummary;
3
+ (function (RcsCampaignSummary) {
4
+ /** Current status of the campaign. */
5
+ RcsCampaignSummary.Status = {
6
+ Incomplete: "INCOMPLETE",
7
+ InReview: "IN REVIEW",
8
+ Verified: "VERIFIED",
9
+ Failed: "FAILED",
10
+ };
11
+ })(RcsCampaignSummary || (RcsCampaignSummary = {}));
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Status of a whitelisted phone number for RCS testing.
3
+ *
4
+ * - `PENDING` — The tester invite has been sent but the recipient has not yet accepted or rejected it.
5
+ * - `ACCEPTED` — The recipient accepted the tester invite and can send/receive messages with the test agent.
6
+ * - `REJECTED` — The recipient rejected the tester invite or the invite could not be delivered.
7
+ */
8
+ export declare const RcsWhitelistStatus: {
9
+ readonly Pending: "PENDING";
10
+ readonly Accepted: "ACCEPTED";
11
+ readonly Rejected: "REJECTED";
12
+ };
13
+ export type RcsWhitelistStatus = (typeof RcsWhitelistStatus)[keyof typeof RcsWhitelistStatus];
@@ -0,0 +1,13 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ /**
3
+ * Status of a whitelisted phone number for RCS testing.
4
+ *
5
+ * - `PENDING` — The tester invite has been sent but the recipient has not yet accepted or rejected it.
6
+ * - `ACCEPTED` — The recipient accepted the tester invite and can send/receive messages with the test agent.
7
+ * - `REJECTED` — The recipient rejected the tester invite or the invite could not be delivered.
8
+ */
9
+ export const RcsWhitelistStatus = {
10
+ Pending: "PENDING",
11
+ Accepted: "ACCEPTED",
12
+ Rejected: "REJECTED",
13
+ };
@@ -0,0 +1,29 @@
1
+ export interface ScheduledMessageSummary {
2
+ /** Unique identifier for the scheduled message. */
3
+ id: string;
4
+ /** ISO 8601 timestamp of when the message is scheduled to be sent. */
5
+ sendAt: string | null;
6
+ /** Current status of the scheduled message. */
7
+ status: ScheduledMessageSummary.Status;
8
+ /** Cron expression for recurring schedules. */
9
+ recurrence: string | null;
10
+ /** Timezone for the schedule (e.g. "America/New_York"). */
11
+ timezone: string | null;
12
+ /** ISO 8601 end date for recurring schedules. */
13
+ endDate: string | null;
14
+ /** The scheduled message payload. */
15
+ payload: Record<string, unknown>;
16
+ /** ISO 8601 timestamp of when the schedule was created. */
17
+ createdAt: string;
18
+ /** ISO 8601 timestamp of when the schedule was last updated. */
19
+ updatedAt: string;
20
+ }
21
+ export declare namespace ScheduledMessageSummary {
22
+ /** Current status of the scheduled message. */
23
+ const Status: {
24
+ readonly Active: "ACTIVE";
25
+ readonly Cancelled: "CANCELLED";
26
+ readonly Failed: "FAILED";
27
+ };
28
+ type Status = (typeof Status)[keyof typeof Status];
29
+ }
@@ -0,0 +1,10 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export var ScheduledMessageSummary;
3
+ (function (ScheduledMessageSummary) {
4
+ /** Current status of the scheduled message. */
5
+ ScheduledMessageSummary.Status = {
6
+ Active: "ACTIVE",
7
+ Cancelled: "CANCELLED",
8
+ Failed: "FAILED",
9
+ };
10
+ })(ScheduledMessageSummary || (ScheduledMessageSummary = {}));
@@ -4,8 +4,6 @@ import type * as Pinnacle from "../index.mjs";
4
4
  */
5
5
  export interface SendRichMessageOptions {
6
6
  schedule?: Pinnacle.MessageSchedule;
7
- /** Send via the test agent to whitelisted test devices. Useful for development and debugging. */
8
- test_mode?: boolean;
9
7
  tracking?: Pinnacle.Tracking;
10
8
  /** Media files and card media will be transcoded to a supported RCS format. This adds a small delay to sending the message. Ignored for rich text messages. */
11
9
  transcode?: boolean;
@@ -0,0 +1,10 @@
1
+ import type * as Pinnacle from "../index.mjs";
2
+ /**
3
+ * Returned when a fallback is configured and the recipient does not support RCS. The API checks RCS capabilities at send time. If the recipient's device doesn't support RCS, the fallback MMS is sent instead. You will also receive a `FALLBACK_SENT` webhook event for the original RCS message.
4
+ */
5
+ export interface SentRichMessageFallbackMms extends Pinnacle.SentMmsDetails {
6
+ /** Indicates that the fallback MMS was sent because the recipient does not support RCS. */
7
+ fallbackSent: boolean;
8
+ /** Unique identifier of the original RCS message that triggered this fallback. Always begins with the prefix `msg_`. This is the RCS message that could not be delivered — the `messageIds` field on this response refers to the actual MMS message(s) that were sent as the fallback. */
9
+ originalMessageId: string;
10
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,10 @@
1
+ import type * as Pinnacle from "../index.mjs";
2
+ /**
3
+ * Returned when a fallback is configured and the recipient does not support RCS. The API checks RCS capabilities at send time. If the recipient's device doesn't support RCS, the fallback SMS is sent instead. You will also receive a `FALLBACK_SENT` webhook event for the original RCS message.
4
+ */
5
+ export interface SentRichMessageFallbackSms extends Pinnacle.SentSmsDetails {
6
+ /** Indicates that the fallback SMS was sent because the recipient does not support RCS. */
7
+ fallbackSent: boolean;
8
+ /** Unique identifier of the original RCS message that triggered this fallback. Always begins with the prefix `msg_`. This is the RCS message that could not be delivered — the `messageId` field on this response refers to the actual SMS that was sent as the fallback. */
9
+ originalMessageId: string;
10
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,19 @@
1
+ import type * as Pinnacle from "../index.mjs";
2
+ /**
3
+ * Response returned after creating or updating a test agent.
4
+ */
5
+ export interface TestAgentResponse {
6
+ /**
7
+ * The unique agent ID. Use this ID when sending messages, whitelisting numbers,
8
+ * and performing other agent operations. Always prefixed with `agent_`.
9
+ */
10
+ id: string;
11
+ /** The type of the agent. Test agents always have type `TEST`. */
12
+ type: "TEST";
13
+ /**
14
+ * The RCS service ID assigned to this agent by the carrier network. Used internally
15
+ * for routing messages. You can use this to construct RCS deep links manually.
16
+ */
17
+ serviceId: string;
18
+ details: Pinnacle.RcsAgentDetails;
19
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,7 @@
1
+ import type * as Pinnacle from "../index.mjs";
2
+ /**
3
+ * Response containing the whitelist status of a phone number.
4
+ */
5
+ export interface TestAgentWhitelistResponse {
6
+ status: Pinnacle.RcsWhitelistStatus;
7
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,26 @@
1
+ export interface TollFreeCampaignSummary {
2
+ /** Unique identifier for the toll-free campaign. */
3
+ campaignId: string;
4
+ /** Name of the campaign. */
5
+ name?: string;
6
+ /** Current status of the campaign. */
7
+ status: TollFreeCampaignSummary.Status;
8
+ /** Brand ID associated with this campaign. */
9
+ brandId?: string;
10
+ /** Primary use case for this campaign. */
11
+ useCase?: string;
12
+ /** ISO 8601 timestamp of when the campaign was created. */
13
+ createdAt: string;
14
+ /** ISO 8601 timestamp of when the campaign was last updated. */
15
+ updatedAt: string;
16
+ }
17
+ export declare namespace TollFreeCampaignSummary {
18
+ /** Current status of the campaign. */
19
+ const Status: {
20
+ readonly Incomplete: "INCOMPLETE";
21
+ readonly InReview: "IN REVIEW";
22
+ readonly Verified: "VERIFIED";
23
+ readonly Failed: "FAILED";
24
+ };
25
+ type Status = (typeof Status)[keyof typeof Status];
26
+ }
@@ -0,0 +1,11 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export var TollFreeCampaignSummary;
3
+ (function (TollFreeCampaignSummary) {
4
+ /** Current status of the campaign. */
5
+ TollFreeCampaignSummary.Status = {
6
+ Incomplete: "INCOMPLETE",
7
+ InReview: "IN REVIEW",
8
+ Verified: "VERIFIED",
9
+ Failed: "FAILED",
10
+ };
11
+ })(TollFreeCampaignSummary || (TollFreeCampaignSummary = {}));
@@ -0,0 +1,23 @@
1
+ export interface WebhookSummary {
2
+ /** Unique identifier of the webhook. This identifier is a string that always begins with the prefix `wh_`, for example: `wh_1234567890`. */
3
+ id: string;
4
+ /** Name of the webhook. */
5
+ name: string;
6
+ /** URL where webhook events are delivered. */
7
+ endpoint: string;
8
+ /** Current status of the webhook. */
9
+ status: WebhookSummary.Status;
10
+ /** ISO 8601 timestamp of when the webhook was created. */
11
+ createdAt: string;
12
+ /** ISO 8601 timestamp of when the webhook was last updated. */
13
+ updatedAt: string;
14
+ }
15
+ export declare namespace WebhookSummary {
16
+ /** Current status of the webhook. */
17
+ const Status: {
18
+ readonly Disabled: "DISABLED";
19
+ readonly Enabled: "ENABLED";
20
+ readonly Deleted: "DELETED";
21
+ };
22
+ type Status = (typeof Status)[keyof typeof Status];
23
+ }
@@ -0,0 +1,10 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export var WebhookSummary;
3
+ (function (WebhookSummary) {
4
+ /** Current status of the webhook. */
5
+ WebhookSummary.Status = {
6
+ Disabled: "DISABLED",
7
+ Enabled: "ENABLED",
8
+ Deleted: "DELETED",
9
+ };
10
+ })(WebhookSummary || (WebhookSummary = {}));
@@ -0,0 +1,19 @@
1
+ export interface WhitelistedNumberSummary {
2
+ /** Whitelisted phone number in E.164 format. */
3
+ number: string;
4
+ /** Current status of the whitelisted number. */
5
+ status: WhitelistedNumberSummary.Status;
6
+ /** Agent ID this number is whitelisted for. */
7
+ agentId: string;
8
+ /** ISO 8601 timestamp of when the number was whitelisted. */
9
+ createdAt: string;
10
+ }
11
+ export declare namespace WhitelistedNumberSummary {
12
+ /** Current status of the whitelisted number. */
13
+ const Status: {
14
+ readonly Accepted: "ACCEPTED";
15
+ readonly Rejected: "REJECTED";
16
+ readonly Pending: "PENDING";
17
+ };
18
+ type Status = (typeof Status)[keyof typeof Status];
19
+ }
@@ -0,0 +1,10 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export var WhitelistedNumberSummary;
3
+ (function (WhitelistedNumberSummary) {
4
+ /** Current status of the whitelisted number. */
5
+ WhitelistedNumberSummary.Status = {
6
+ Accepted: "ACCEPTED",
7
+ Rejected: "REJECTED",
8
+ Pending: "PENDING",
9
+ };
10
+ })(WhitelistedNumberSummary || (WhitelistedNumberSummary = {}));
@@ -1,7 +1,13 @@
1
1
  export * from "./AdvancedPhoneInformation.mjs";
2
+ export * from "./AgentEmailEntry.mjs";
3
+ export * from "./AgentPhoneEntry.mjs";
4
+ export * from "./AgentSummary.mjs";
5
+ export * from "./AgentUseCase.mjs";
6
+ export * from "./AgentWebsiteEntry.mjs";
2
7
  export * from "./AttachedPhoneNumberResult.mjs";
3
8
  export * from "./AttachWebhookParams.mjs";
4
9
  export * from "./AudienceCountOnly.mjs";
10
+ export * from "./AudienceSummary.mjs";
5
11
  export * from "./AudienceWithPagination.mjs";
6
12
  export * from "./AutofillCampaignParams.mjs";
7
13
  export * from "./AutofillDlcCampaignResponse.mjs";
@@ -9,6 +15,7 @@ export * from "./BadRequestErrorBody.mjs";
9
15
  export * from "./BaseRichMessage.mjs";
10
16
  export * from "./BasicPhoneInformation.mjs";
11
17
  export * from "./BlastDetails.mjs";
18
+ export * from "./BlastSummary.mjs";
12
19
  export * from "./BrandStatus.mjs";
13
20
  export * from "./BrandStatusEnum.mjs";
14
21
  export * from "./ButtonClicked.mjs";
@@ -17,6 +24,8 @@ export * from "./CampaignEnum.mjs";
17
24
  export * from "./CampaignQuery.mjs";
18
25
  export * from "./CampaignSubmissionResult.mjs";
19
26
  export * from "./CampaignValidationResult.mjs";
27
+ export * from "./CarrierLaunches.mjs";
28
+ export * from "./CarrierLaunchStatus.mjs";
20
29
  export * from "./CompanyEntityTypeEnum.mjs";
21
30
  export * from "./CompanySectorEnum.mjs";
22
31
  export * from "./CompanyTypeEnum.mjs";
@@ -32,6 +41,7 @@ export * from "./DetachedWebhookInfo.mjs";
32
41
  export * from "./DetailedPhoneNumberEnum.mjs";
33
42
  export * from "./DlcAssignmentStatusEnum.mjs";
34
43
  export * from "./DlcCampaignStatus.mjs";
44
+ export * from "./DlcCampaignSummary.mjs";
35
45
  export * from "./DlcCampaignUseCaseEnum.mjs";
36
46
  export * from "./DlcCampaignWithExtendedBrandAndStatus.mjs";
37
47
  export * from "./EnhancedContact.mjs";
@@ -43,6 +53,21 @@ export * from "./ExtendedRcsCampaign.mjs";
43
53
  export * from "./FallbackMessage.mjs";
44
54
  export * from "./GetConversationParams.mjs";
45
55
  export * from "./LinkClickEvent.mjs";
56
+ export * from "./LinkSummary.mjs";
57
+ export * from "./ListAgentsResponse.mjs";
58
+ export * from "./ListAudiencesResponse.mjs";
59
+ export * from "./ListBlastsResponse.mjs";
60
+ export * from "./ListBrandsResponse.mjs";
61
+ export * from "./ListContactsResponse.mjs";
62
+ export * from "./ListDlcCampaignsResponse.mjs";
63
+ export * from "./ListLinksResponse.mjs";
64
+ export * from "./ListMessagesResponse.mjs";
65
+ export * from "./ListPhoneNumbersResponse.mjs";
66
+ export * from "./ListRcsCampaignsResponse.mjs";
67
+ export * from "./ListScheduledMessagesResponse.mjs";
68
+ export * from "./ListTestNumbersResponse.mjs";
69
+ export * from "./ListTollFreeCampaignsResponse.mjs";
70
+ export * from "./ListWebhooksResponse.mjs";
46
71
  export * from "./LocationShareAction.mjs";
47
72
  export * from "./Message.mjs";
48
73
  export * from "./MessageContent.mjs";
@@ -60,8 +85,9 @@ export * from "./MessageMethodEnum.mjs";
60
85
  export * from "./MessageProtocolEnum.mjs";
61
86
  export * from "./MessageSchedule.mjs";
62
87
  export * from "./MessageStatusEnum.mjs";
88
+ export * from "./MessageSummary.mjs";
63
89
  export * from "./MessageVolumeEnum.mjs";
64
- export * from "./MessageWithReaction.mjs";
90
+ export * from "./MessageWithReactions.mjs";
65
91
  export * from "./MessagingProfileEnum.mjs";
66
92
  export * from "./MmsContent.mjs";
67
93
  export * from "./MmsValidationResult.mjs";
@@ -71,6 +97,7 @@ export * from "./OptInMethodEnum.mjs";
71
97
  export * from "./OptionalBrandInfo.mjs";
72
98
  export * from "./OptionalContact.mjs";
73
99
  export * from "./OptionalContacts.mjs";
100
+ export * from "./OwnedPhoneNumber.mjs";
74
101
  export * from "./Pagination.mjs";
75
102
  export * from "./PhoneCapabilities.mjs";
76
103
  export * from "./PhoneEnum.mjs";
@@ -81,6 +108,8 @@ export * from "./PhoneNumberStatus.mjs";
81
108
  export * from "./PhoneNumberStatusEnum.mjs";
82
109
  export * from "./ProfileStatusEnum.mjs";
83
110
  export * from "./PurchasedNumber.mjs";
111
+ export * from "./RcsAgentDetails.mjs";
112
+ export * from "./RcsAgentResponse.mjs";
84
113
  export * from "./RcsButtonCall.mjs";
85
114
  export * from "./RcsButtonOpenUrl.mjs";
86
115
  export * from "./RcsButtonRequestUserLocation.mjs";
@@ -89,6 +118,7 @@ export * from "./RcsButtonSendLocation.mjs";
89
118
  export * from "./RcsButtonTrigger.mjs";
90
119
  export * from "./RcsCampaign.mjs";
91
120
  export * from "./RcsCampaignStatus.mjs";
121
+ export * from "./RcsCampaignSummary.mjs";
92
122
  export * from "./RcsCampaignUseCaseEnum.mjs";
93
123
  export * from "./RcsCapabilitiesResult.mjs";
94
124
  export * from "./RcsCapability.mjs";
@@ -100,7 +130,7 @@ export * from "./RcsMediaDetailsContent.mjs";
100
130
  export * from "./RcsMessagingTypeEnum.mjs";
101
131
  export * from "./RcsValidateContent.mjs";
102
132
  export * from "./RcsValidationResult.mjs";
103
- export * from "./RcsWhitelistResponse.mjs";
133
+ export * from "./RcsWhitelistStatus.mjs";
104
134
  export * from "./ReactionResult.mjs";
105
135
  export * from "./RefreshedFile.mjs";
106
136
  export * from "./RichButton.mjs";
@@ -113,11 +143,14 @@ export * from "./RichTextMessage.mjs";
113
143
  export * from "./ScheduleCancelResult.mjs";
114
144
  export * from "./ScheduledBlastDetails.mjs";
115
145
  export * from "./ScheduledMessage.mjs";
146
+ export * from "./ScheduledMessageSummary.mjs";
116
147
  export * from "./Sender.mjs";
117
148
  export * from "./SendRichMessageOptions.mjs";
118
149
  export * from "./SendTypingIndicatorResponse.mjs";
119
150
  export * from "./SentMmsDetails.mjs";
120
151
  export * from "./SentRichMessage.mjs";
152
+ export * from "./SentRichMessageFallbackMms.mjs";
153
+ export * from "./SentRichMessageFallbackSms.mjs";
121
154
  export * from "./SentSmsDetails.mjs";
122
155
  export * from "./ShortenedUrl.mjs";
123
156
  export * from "./ShortenedUrlWithClickData.mjs";
@@ -126,8 +159,11 @@ export * from "./SmsValidationResult.mjs";
126
159
  export * from "./SubmissionResults.mjs";
127
160
  export * from "./SubUseCaseEnum.mjs";
128
161
  export * from "./SuccessfulConversationUpdate.mjs";
162
+ export * from "./TestAgentResponse.mjs";
163
+ export * from "./TestAgentWhitelistResponse.mjs";
129
164
  export * from "./TollFreeCampaign.mjs";
130
165
  export * from "./TollFreeCampaignStatus.mjs";
166
+ export * from "./TollFreeCampaignSummary.mjs";
131
167
  export * from "./TollFreeCampaignUseCaseEnum.mjs";
132
168
  export * from "./TollFreeCampaignWithExtendedBrandAndStatus.mjs";
133
169
  export * from "./TollFreeStatusEnum.mjs";
@@ -150,5 +186,7 @@ export * from "./VettingHistory.mjs";
150
186
  export * from "./VettingResults.mjs";
151
187
  export * from "./WebhookEventEnum.mjs";
152
188
  export * from "./WebhookResult.mjs";
189
+ export * from "./WebhookSummary.mjs";
153
190
  export * from "./Webhooks.mjs";
191
+ export * from "./WhitelistedNumberSummary.mjs";
154
192
  export * from "./ZodError.mjs";