rcs-js 2.0.1 → 2.0.3-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 (290) hide show
  1. package/dist/cjs/Client.js +2 -2
  2. package/dist/cjs/api/errors/NotFoundError.d.ts +1 -2
  3. package/dist/cjs/api/resources/brands/client/Client.d.ts +13 -13
  4. package/dist/cjs/api/resources/brands/client/Client.js +10 -10
  5. package/dist/cjs/api/resources/brands/client/requests/UpsertBrandParams.d.ts +6 -3
  6. package/dist/cjs/api/resources/campaigns/resources/dlc/client/Client.d.ts +14 -13
  7. package/dist/cjs/api/resources/campaigns/resources/dlc/client/Client.js +12 -11
  8. package/dist/cjs/api/resources/campaigns/resources/dlc/client/requests/UpsertDlcCampaignParams.d.ts +8 -8
  9. package/dist/cjs/api/resources/campaigns/resources/rcs/client/Client.d.ts +11 -10
  10. package/dist/cjs/api/resources/campaigns/resources/rcs/client/Client.js +9 -8
  11. package/dist/cjs/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.ts +4 -3
  12. package/dist/cjs/api/resources/campaigns/resources/rcs/types/RcsAutofillResponse.d.ts +1 -1
  13. package/dist/cjs/api/resources/campaigns/resources/tollFree/client/Client.d.ts +12 -12
  14. package/dist/cjs/api/resources/campaigns/resources/tollFree/client/Client.js +10 -10
  15. package/dist/cjs/api/resources/campaigns/resources/tollFree/client/requests/UpsertTollFreeCampaignParams.d.ts +7 -7
  16. package/dist/cjs/api/resources/campaigns/resources/tollFree/types/TollFreeAutofillResponse.d.ts +1 -1
  17. package/dist/cjs/api/resources/contacts/client/Client.d.ts +4 -2
  18. package/dist/cjs/api/resources/contacts/client/Client.js +5 -3
  19. package/dist/cjs/api/resources/contacts/client/requests/ContactsGetRequest.d.ts +4 -2
  20. package/dist/cjs/api/resources/contacts/client/requests/UpdateContactParams.d.ts +3 -3
  21. package/dist/cjs/api/resources/conversations/client/Client.d.ts +21 -4
  22. package/dist/cjs/api/resources/conversations/client/Client.js +99 -4
  23. package/dist/cjs/api/resources/conversations/client/requests/ConversationsListMessagesRequest.d.ts +36 -0
  24. package/dist/cjs/api/resources/conversations/client/requests/ConversationsListMessagesRequest.js +5 -0
  25. package/dist/cjs/api/resources/conversations/client/requests/ListConversationsParams.d.ts +11 -6
  26. package/dist/cjs/api/resources/conversations/client/requests/UpdateConversationParams.d.ts +3 -3
  27. package/dist/cjs/api/resources/conversations/client/requests/index.d.ts +1 -0
  28. package/dist/cjs/api/resources/conversations/index.d.ts +1 -0
  29. package/dist/cjs/api/resources/conversations/index.js +1 -0
  30. package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestDirection.d.ts +8 -0
  31. package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestDirection.js +10 -0
  32. package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestSortOrder.d.ts +8 -0
  33. package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestSortOrder.js +10 -0
  34. package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestStatus.d.ts +13 -0
  35. package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestStatus.js +15 -0
  36. package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestType.d.ts +9 -0
  37. package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestType.js +11 -0
  38. package/dist/cjs/api/resources/conversations/types/index.d.ts +4 -0
  39. package/dist/cjs/api/resources/conversations/types/index.js +20 -0
  40. package/dist/cjs/api/resources/index.d.ts +2 -1
  41. package/dist/cjs/api/resources/index.js +3 -2
  42. package/dist/cjs/api/resources/messages/client/Client.d.ts +4 -4
  43. package/dist/cjs/api/resources/messages/client/Client.js +3 -3
  44. package/dist/cjs/api/resources/messages/client/requests/ReactMessageParams.d.ts +3 -3
  45. package/dist/cjs/api/resources/messages/resources/index.d.ts +1 -0
  46. package/dist/cjs/api/resources/messages/resources/index.js +1 -0
  47. package/dist/cjs/api/resources/messages/resources/rcs/client/Client.d.ts +33 -0
  48. package/dist/cjs/api/resources/messages/resources/rcs/client/Client.js +90 -0
  49. package/dist/cjs/api/resources/messages/resources/rcs/client/index.d.ts +1 -0
  50. package/dist/cjs/api/resources/messages/resources/rcs/client/index.js +15 -0
  51. package/dist/cjs/api/resources/messages/resources/rcs/client/requests/SendTypingIndicatorSchema.d.ts +38 -0
  52. package/dist/cjs/api/resources/messages/resources/rcs/client/requests/SendTypingIndicatorSchema.js +5 -0
  53. package/dist/cjs/api/resources/messages/resources/rcs/client/requests/index.d.ts +1 -0
  54. package/dist/cjs/api/resources/messages/resources/rcs/client/requests/index.js +2 -0
  55. package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/Client.d.ts +1 -1
  56. package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/Client.js +1 -1
  57. package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/requests/AttachCampaignParams.d.ts +12 -3
  58. package/dist/cjs/api/resources/phoneNumbers/resources/webhook/client/Client.d.ts +5 -5
  59. package/dist/cjs/api/resources/phoneNumbers/resources/webhook/client/Client.js +4 -4
  60. package/dist/cjs/api/resources/rcs/client/Client.d.ts +11 -7
  61. package/dist/cjs/api/resources/rcs/client/Client.js +11 -7
  62. package/dist/cjs/api/resources/status/resources/get/client/Client.d.ts +12 -12
  63. package/dist/cjs/api/resources/status/resources/get/client/Client.js +8 -8
  64. package/dist/cjs/api/resources/tools/resources/contactCard/client/Client.d.ts +2 -2
  65. package/dist/cjs/api/resources/tools/resources/contactCard/client/Client.js +2 -2
  66. package/dist/cjs/api/resources/tools/resources/contactCard/client/requests/GetVcardParams.d.ts +3 -3
  67. package/dist/cjs/api/resources/tools/resources/contactCard/client/requests/UpsertVcardParams.d.ts +1 -1
  68. package/dist/cjs/api/resources/tools/resources/file/client/Client.d.ts +2 -1
  69. package/dist/cjs/api/resources/tools/resources/file/client/Client.js +2 -1
  70. package/dist/cjs/api/resources/tools/resources/file/client/requests/RefreshFileParams.d.ts +3 -11
  71. package/dist/cjs/api/resources/tools/resources/file/client/requests/UploadFileParams.d.ts +7 -0
  72. package/dist/cjs/api/types/AttachWebhookParams.d.ts +1 -1
  73. package/dist/cjs/api/types/AttachedPhoneNumberResult.d.ts +2 -2
  74. package/dist/cjs/api/types/AutofillCampaignParams.d.ts +7 -2
  75. package/dist/cjs/api/types/AutofillDlcCampaignResponse.d.ts +4 -4
  76. package/dist/cjs/api/types/BrandStatus.d.ts +2 -2
  77. package/dist/cjs/api/types/ButtonClickedData.d.ts +2 -2
  78. package/dist/cjs/api/types/CampaignQuery.d.ts +6 -1
  79. package/dist/cjs/api/types/ConfiguredWebhook.d.ts +2 -2
  80. package/dist/cjs/api/types/Contact.d.ts +2 -2
  81. package/dist/cjs/api/types/ContactId.d.ts +2 -2
  82. package/dist/cjs/api/types/Conversation.d.ts +7 -7
  83. package/dist/cjs/api/types/ConversationList.d.ts +4 -4
  84. package/dist/cjs/api/types/DetachedPhoneNumberResult.d.ts +2 -2
  85. package/dist/cjs/api/types/DetachedWebhookInfo.d.ts +2 -2
  86. package/dist/cjs/api/types/DlcCampaignStatus.d.ts +2 -2
  87. package/dist/cjs/api/types/DlcCampaignWithExtendedBrandAndStatus.d.ts +2 -2
  88. package/dist/cjs/api/types/ExtendedBrand.d.ts +2 -2
  89. package/dist/cjs/api/types/ExtendedRcsCampaign.d.ts +2 -2
  90. package/dist/cjs/api/types/GetConversationParams.d.ts +1 -1
  91. package/dist/cjs/api/types/LinkClickEvent.d.ts +0 -4
  92. package/dist/cjs/api/types/Message.d.ts +2 -2
  93. package/dist/cjs/api/types/MessageEvent.d.ts +6 -12
  94. package/dist/cjs/api/types/MessageEventContent.d.ts +29 -0
  95. package/dist/cjs/api/types/MessageEventContent.js +5 -0
  96. package/dist/cjs/api/types/MessageEventMmsContent.d.ts +23 -0
  97. package/dist/cjs/api/types/MessageEventMmsContent.js +5 -0
  98. package/dist/cjs/api/types/MessageEventRcsButtonData.d.ts +18 -0
  99. package/dist/cjs/api/types/MessageEventRcsButtonData.js +5 -0
  100. package/dist/cjs/api/types/MessageEventRcsCardsContent.d.ts +39 -0
  101. package/dist/cjs/api/types/MessageEventRcsCardsContent.js +5 -0
  102. package/dist/cjs/api/types/MessageEventRcsLocationData.d.ts +18 -0
  103. package/dist/cjs/api/types/MessageEventRcsLocationData.js +5 -0
  104. package/dist/cjs/api/types/MessageEventRcsMediaContent.d.ts +22 -0
  105. package/dist/cjs/api/types/MessageEventRcsMediaContent.js +5 -0
  106. package/dist/cjs/api/types/MessageEventRcsTextContent.d.ts +20 -0
  107. package/dist/cjs/api/types/MessageEventRcsTextContent.js +5 -0
  108. package/dist/cjs/api/types/MessageEventSmsContent.d.ts +17 -0
  109. package/dist/cjs/api/types/MessageEventSmsContent.js +5 -0
  110. package/dist/cjs/api/types/MessageList.d.ts +15 -0
  111. package/dist/cjs/api/types/MessageList.js +5 -0
  112. package/dist/cjs/api/types/MessageWithReaction.d.ts +27 -0
  113. package/dist/cjs/api/types/MessageWithReaction.js +13 -0
  114. package/dist/cjs/api/types/NotFoundErrorBody.d.ts +6 -0
  115. package/dist/cjs/api/types/NotFoundErrorBody.js +5 -0
  116. package/dist/cjs/api/types/Options.d.ts +21 -0
  117. package/dist/cjs/api/types/Options.js +5 -0
  118. package/dist/cjs/api/types/RcsButtonOpenUrl.d.ts +31 -2
  119. package/dist/cjs/api/types/RcsButtonOpenUrl.js +9 -0
  120. package/dist/cjs/api/types/RcsButtonSendLocation.d.ts +8 -2
  121. package/dist/cjs/api/types/RcsCampaign.d.ts +1 -1
  122. package/dist/cjs/api/types/RcsCampaignStatus.d.ts +2 -2
  123. package/dist/cjs/api/types/ReactionResult.d.ts +4 -4
  124. package/dist/cjs/api/types/RichCardsMessage.d.ts +51 -1
  125. package/dist/cjs/api/types/RichCardsMessage.js +18 -0
  126. package/dist/cjs/api/types/ScheduledMessaage.d.ts +2 -2
  127. package/dist/cjs/api/types/SendTypingIndicatorResponse.d.ts +22 -0
  128. package/dist/cjs/api/types/SendTypingIndicatorResponse.js +5 -0
  129. package/dist/cjs/api/types/SentMmsDetails.d.ts +2 -2
  130. package/dist/cjs/api/types/SentRcsDetails.d.ts +2 -2
  131. package/dist/cjs/api/types/SentSmsDetails.d.ts +2 -2
  132. package/dist/cjs/api/types/TollFreeCampaign.d.ts +2 -2
  133. package/dist/cjs/api/types/TollFreeCampaignStatus.d.ts +2 -2
  134. package/dist/cjs/api/types/UpdatedContactId.d.ts +2 -2
  135. package/dist/cjs/api/types/UploadResults.d.ts +6 -0
  136. package/dist/cjs/api/types/ValidateCampaignParams.d.ts +7 -2
  137. package/dist/cjs/api/types/Vcard.d.ts +2 -2
  138. package/dist/cjs/api/types/VcardResource.d.ts +2 -2
  139. package/dist/cjs/api/types/Webhooks.d.ts +2 -2
  140. package/dist/cjs/api/types/index.d.ts +13 -0
  141. package/dist/cjs/api/types/index.js +13 -0
  142. package/dist/cjs/version.d.ts +1 -1
  143. package/dist/cjs/version.js +1 -1
  144. package/dist/cjs/wrapper/messages/Client.js +8 -3
  145. package/dist/esm/Client.mjs +2 -2
  146. package/dist/esm/api/errors/NotFoundError.d.mts +1 -2
  147. package/dist/esm/api/resources/brands/client/Client.d.mts +13 -13
  148. package/dist/esm/api/resources/brands/client/Client.mjs +10 -10
  149. package/dist/esm/api/resources/brands/client/requests/UpsertBrandParams.d.mts +6 -3
  150. package/dist/esm/api/resources/campaigns/resources/dlc/client/Client.d.mts +14 -13
  151. package/dist/esm/api/resources/campaigns/resources/dlc/client/Client.mjs +12 -11
  152. package/dist/esm/api/resources/campaigns/resources/dlc/client/requests/UpsertDlcCampaignParams.d.mts +8 -8
  153. package/dist/esm/api/resources/campaigns/resources/rcs/client/Client.d.mts +11 -10
  154. package/dist/esm/api/resources/campaigns/resources/rcs/client/Client.mjs +9 -8
  155. package/dist/esm/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.mts +4 -3
  156. package/dist/esm/api/resources/campaigns/resources/rcs/types/RcsAutofillResponse.d.mts +1 -1
  157. package/dist/esm/api/resources/campaigns/resources/tollFree/client/Client.d.mts +12 -12
  158. package/dist/esm/api/resources/campaigns/resources/tollFree/client/Client.mjs +10 -10
  159. package/dist/esm/api/resources/campaigns/resources/tollFree/client/requests/UpsertTollFreeCampaignParams.d.mts +7 -7
  160. package/dist/esm/api/resources/campaigns/resources/tollFree/types/TollFreeAutofillResponse.d.mts +1 -1
  161. package/dist/esm/api/resources/contacts/client/Client.d.mts +4 -2
  162. package/dist/esm/api/resources/contacts/client/Client.mjs +5 -3
  163. package/dist/esm/api/resources/contacts/client/requests/ContactsGetRequest.d.mts +4 -2
  164. package/dist/esm/api/resources/contacts/client/requests/UpdateContactParams.d.mts +3 -3
  165. package/dist/esm/api/resources/conversations/client/Client.d.mts +21 -4
  166. package/dist/esm/api/resources/conversations/client/Client.mjs +99 -4
  167. package/dist/esm/api/resources/conversations/client/requests/ConversationsListMessagesRequest.d.mts +36 -0
  168. package/dist/esm/api/resources/conversations/client/requests/ConversationsListMessagesRequest.mjs +4 -0
  169. package/dist/esm/api/resources/conversations/client/requests/ListConversationsParams.d.mts +11 -6
  170. package/dist/esm/api/resources/conversations/client/requests/UpdateConversationParams.d.mts +3 -3
  171. package/dist/esm/api/resources/conversations/client/requests/index.d.mts +1 -0
  172. package/dist/esm/api/resources/conversations/index.d.mts +1 -0
  173. package/dist/esm/api/resources/conversations/index.mjs +1 -0
  174. package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestDirection.d.mts +8 -0
  175. package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestDirection.mjs +7 -0
  176. package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestSortOrder.d.mts +8 -0
  177. package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestSortOrder.mjs +7 -0
  178. package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestStatus.d.mts +13 -0
  179. package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestStatus.mjs +12 -0
  180. package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestType.d.mts +9 -0
  181. package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestType.mjs +8 -0
  182. package/dist/esm/api/resources/conversations/types/index.d.mts +4 -0
  183. package/dist/esm/api/resources/conversations/types/index.mjs +4 -0
  184. package/dist/esm/api/resources/index.d.mts +2 -1
  185. package/dist/esm/api/resources/index.mjs +2 -1
  186. package/dist/esm/api/resources/messages/client/Client.d.mts +4 -4
  187. package/dist/esm/api/resources/messages/client/Client.mjs +3 -3
  188. package/dist/esm/api/resources/messages/client/requests/ReactMessageParams.d.mts +3 -3
  189. package/dist/esm/api/resources/messages/resources/index.d.mts +1 -0
  190. package/dist/esm/api/resources/messages/resources/index.mjs +1 -0
  191. package/dist/esm/api/resources/messages/resources/rcs/client/Client.d.mts +33 -0
  192. package/dist/esm/api/resources/messages/resources/rcs/client/Client.mjs +90 -0
  193. package/dist/esm/api/resources/messages/resources/rcs/client/index.d.mts +1 -0
  194. package/dist/esm/api/resources/messages/resources/rcs/client/index.mjs +1 -1
  195. package/dist/esm/api/resources/messages/resources/rcs/client/requests/SendTypingIndicatorSchema.d.mts +38 -0
  196. package/dist/esm/api/resources/messages/resources/rcs/client/requests/SendTypingIndicatorSchema.mjs +4 -0
  197. package/dist/esm/api/resources/messages/resources/rcs/client/requests/index.d.mts +1 -0
  198. package/dist/esm/api/resources/messages/resources/rcs/client/requests/index.mjs +1 -0
  199. package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/Client.d.mts +1 -1
  200. package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/Client.mjs +1 -1
  201. package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/requests/AttachCampaignParams.d.mts +12 -3
  202. package/dist/esm/api/resources/phoneNumbers/resources/webhook/client/Client.d.mts +5 -5
  203. package/dist/esm/api/resources/phoneNumbers/resources/webhook/client/Client.mjs +4 -4
  204. package/dist/esm/api/resources/rcs/client/Client.d.mts +11 -7
  205. package/dist/esm/api/resources/rcs/client/Client.mjs +11 -7
  206. package/dist/esm/api/resources/status/resources/get/client/Client.d.mts +12 -12
  207. package/dist/esm/api/resources/status/resources/get/client/Client.mjs +8 -8
  208. package/dist/esm/api/resources/tools/resources/contactCard/client/Client.d.mts +2 -2
  209. package/dist/esm/api/resources/tools/resources/contactCard/client/Client.mjs +2 -2
  210. package/dist/esm/api/resources/tools/resources/contactCard/client/requests/GetVcardParams.d.mts +3 -3
  211. package/dist/esm/api/resources/tools/resources/contactCard/client/requests/UpsertVcardParams.d.mts +1 -1
  212. package/dist/esm/api/resources/tools/resources/file/client/Client.d.mts +2 -1
  213. package/dist/esm/api/resources/tools/resources/file/client/Client.mjs +2 -1
  214. package/dist/esm/api/resources/tools/resources/file/client/requests/RefreshFileParams.d.mts +3 -11
  215. package/dist/esm/api/resources/tools/resources/file/client/requests/UploadFileParams.d.mts +7 -0
  216. package/dist/esm/api/types/AttachWebhookParams.d.mts +1 -1
  217. package/dist/esm/api/types/AttachedPhoneNumberResult.d.mts +2 -2
  218. package/dist/esm/api/types/AutofillCampaignParams.d.mts +7 -2
  219. package/dist/esm/api/types/AutofillDlcCampaignResponse.d.mts +4 -4
  220. package/dist/esm/api/types/BrandStatus.d.mts +2 -2
  221. package/dist/esm/api/types/ButtonClickedData.d.mts +2 -2
  222. package/dist/esm/api/types/CampaignQuery.d.mts +6 -1
  223. package/dist/esm/api/types/ConfiguredWebhook.d.mts +2 -2
  224. package/dist/esm/api/types/Contact.d.mts +2 -2
  225. package/dist/esm/api/types/ContactId.d.mts +2 -2
  226. package/dist/esm/api/types/Conversation.d.mts +7 -7
  227. package/dist/esm/api/types/ConversationList.d.mts +4 -4
  228. package/dist/esm/api/types/DetachedPhoneNumberResult.d.mts +2 -2
  229. package/dist/esm/api/types/DetachedWebhookInfo.d.mts +2 -2
  230. package/dist/esm/api/types/DlcCampaignStatus.d.mts +2 -2
  231. package/dist/esm/api/types/DlcCampaignWithExtendedBrandAndStatus.d.mts +2 -2
  232. package/dist/esm/api/types/ExtendedBrand.d.mts +2 -2
  233. package/dist/esm/api/types/ExtendedRcsCampaign.d.mts +2 -2
  234. package/dist/esm/api/types/GetConversationParams.d.mts +1 -1
  235. package/dist/esm/api/types/LinkClickEvent.d.mts +0 -4
  236. package/dist/esm/api/types/Message.d.mts +2 -2
  237. package/dist/esm/api/types/MessageEvent.d.mts +6 -12
  238. package/dist/esm/api/types/MessageEventContent.d.mts +29 -0
  239. package/dist/esm/api/types/MessageEventContent.mjs +4 -0
  240. package/dist/esm/api/types/MessageEventMmsContent.d.mts +23 -0
  241. package/dist/esm/api/types/MessageEventMmsContent.mjs +4 -0
  242. package/dist/esm/api/types/MessageEventRcsButtonData.d.mts +18 -0
  243. package/dist/esm/api/types/MessageEventRcsButtonData.mjs +4 -0
  244. package/dist/esm/api/types/MessageEventRcsCardsContent.d.mts +39 -0
  245. package/dist/esm/api/types/MessageEventRcsCardsContent.mjs +4 -0
  246. package/dist/esm/api/types/MessageEventRcsLocationData.d.mts +18 -0
  247. package/dist/esm/api/types/MessageEventRcsLocationData.mjs +4 -0
  248. package/dist/esm/api/types/MessageEventRcsMediaContent.d.mts +22 -0
  249. package/dist/esm/api/types/MessageEventRcsMediaContent.mjs +4 -0
  250. package/dist/esm/api/types/MessageEventRcsTextContent.d.mts +20 -0
  251. package/dist/esm/api/types/MessageEventRcsTextContent.mjs +4 -0
  252. package/dist/esm/api/types/MessageEventSmsContent.d.mts +17 -0
  253. package/dist/esm/api/types/MessageEventSmsContent.mjs +4 -0
  254. package/dist/esm/api/types/MessageList.d.mts +15 -0
  255. package/dist/esm/api/types/MessageList.mjs +4 -0
  256. package/dist/esm/api/types/MessageWithReaction.d.mts +27 -0
  257. package/dist/esm/api/types/MessageWithReaction.mjs +10 -0
  258. package/dist/esm/api/types/NotFoundErrorBody.d.mts +6 -0
  259. package/dist/esm/api/types/NotFoundErrorBody.mjs +4 -0
  260. package/dist/esm/api/types/Options.d.mts +21 -0
  261. package/dist/esm/api/types/Options.mjs +4 -0
  262. package/dist/esm/api/types/RcsButtonOpenUrl.d.mts +31 -2
  263. package/dist/esm/api/types/RcsButtonOpenUrl.mjs +8 -1
  264. package/dist/esm/api/types/RcsButtonSendLocation.d.mts +8 -2
  265. package/dist/esm/api/types/RcsCampaign.d.mts +1 -1
  266. package/dist/esm/api/types/RcsCampaignStatus.d.mts +2 -2
  267. package/dist/esm/api/types/ReactionResult.d.mts +4 -4
  268. package/dist/esm/api/types/RichCardsMessage.d.mts +51 -1
  269. package/dist/esm/api/types/RichCardsMessage.mjs +17 -1
  270. package/dist/esm/api/types/ScheduledMessaage.d.mts +2 -2
  271. package/dist/esm/api/types/SendTypingIndicatorResponse.d.mts +22 -0
  272. package/dist/esm/api/types/SendTypingIndicatorResponse.mjs +4 -0
  273. package/dist/esm/api/types/SentMmsDetails.d.mts +2 -2
  274. package/dist/esm/api/types/SentRcsDetails.d.mts +2 -2
  275. package/dist/esm/api/types/SentSmsDetails.d.mts +2 -2
  276. package/dist/esm/api/types/TollFreeCampaign.d.mts +2 -2
  277. package/dist/esm/api/types/TollFreeCampaignStatus.d.mts +2 -2
  278. package/dist/esm/api/types/UpdatedContactId.d.mts +2 -2
  279. package/dist/esm/api/types/UploadResults.d.mts +6 -0
  280. package/dist/esm/api/types/ValidateCampaignParams.d.mts +7 -2
  281. package/dist/esm/api/types/Vcard.d.mts +2 -2
  282. package/dist/esm/api/types/VcardResource.d.mts +2 -2
  283. package/dist/esm/api/types/Webhooks.d.mts +2 -2
  284. package/dist/esm/api/types/index.d.mts +13 -0
  285. package/dist/esm/api/types/index.mjs +13 -0
  286. package/dist/esm/version.d.mts +1 -1
  287. package/dist/esm/version.mjs +1 -1
  288. package/dist/esm/wrapper/messages/Client.mjs +8 -3
  289. package/package.json +3 -3
  290. package/reference.md +235 -73
@@ -7,8 +7,8 @@
7
7
  export interface Webhooks {
8
8
  /** URL where webhook events are delivered. */
9
9
  endpoint: string;
10
- /** Unique identifier for the webhook. */
11
- id: number;
10
+ /** The unique identifier of the webhook. This identifier is a string that always begins with the prefix `wh_`, for example: `wh_1234567890`. */
11
+ id: string;
12
12
  /** Name of the webhook. */
13
13
  name: string;
14
14
  }
@@ -1,4 +1,5 @@
1
1
  export * from "./BadRequestErrorBody.js";
2
+ export * from "./NotFoundErrorBody.js";
2
3
  export * from "./OptionalContacts.js";
3
4
  export * from "./CompanySectorEnum.js";
4
5
  export * from "./CompanyTypeEnum.js";
@@ -67,6 +68,8 @@ export * from "./MessageMethodEnum.js";
67
68
  export * from "./MessageStatusEnum.js";
68
69
  export * from "./MessageProtocolEnum.js";
69
70
  export * from "./Message.js";
71
+ export * from "./MessageWithReaction.js";
72
+ export * from "./MessageList.js";
70
73
  export * from "./ReactionResult.js";
71
74
  export * from "./MessageSchedule.js";
72
75
  export * from "./Tracking.js";
@@ -77,9 +80,11 @@ export * from "./RcsBase.js";
77
80
  export * from "./RichTextMessage.js";
78
81
  export * from "./RichMediaMessage.js";
79
82
  export * from "./RcsCards.js";
83
+ export * from "./Options.js";
80
84
  export * from "./RichCardsMessage.js";
81
85
  export * from "./RichMessage.js";
82
86
  export * from "./SentRcsDetails.js";
87
+ export * from "./SendTypingIndicatorResponse.js";
83
88
  export * from "./SmsValidationResult.js";
84
89
  export * from "./MmsValidationResult.js";
85
90
  export * from "./RcsValidateContent.js";
@@ -129,5 +134,13 @@ export * from "./VCardData.js";
129
134
  export * from "./VcardResource.js";
130
135
  export * from "./Webhooks.js";
131
136
  export * from "./WebhookResult.js";
137
+ export * from "./MessageEventSmsContent.js";
138
+ export * from "./MessageEventMmsContent.js";
139
+ export * from "./MessageEventRcsTextContent.js";
140
+ export * from "./MessageEventRcsMediaContent.js";
141
+ export * from "./MessageEventRcsCardsContent.js";
142
+ export * from "./MessageEventRcsButtonData.js";
143
+ export * from "./MessageEventRcsLocationData.js";
144
+ export * from "./MessageEventContent.js";
132
145
  export * from "./MessageEvent.js";
133
146
  export * from "./UserEvent.js";
@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
17
  __exportStar(require("./BadRequestErrorBody.js"), exports);
18
+ __exportStar(require("./NotFoundErrorBody.js"), exports);
18
19
  __exportStar(require("./OptionalContacts.js"), exports);
19
20
  __exportStar(require("./CompanySectorEnum.js"), exports);
20
21
  __exportStar(require("./CompanyTypeEnum.js"), exports);
@@ -83,6 +84,8 @@ __exportStar(require("./MessageMethodEnum.js"), exports);
83
84
  __exportStar(require("./MessageStatusEnum.js"), exports);
84
85
  __exportStar(require("./MessageProtocolEnum.js"), exports);
85
86
  __exportStar(require("./Message.js"), exports);
87
+ __exportStar(require("./MessageWithReaction.js"), exports);
88
+ __exportStar(require("./MessageList.js"), exports);
86
89
  __exportStar(require("./ReactionResult.js"), exports);
87
90
  __exportStar(require("./MessageSchedule.js"), exports);
88
91
  __exportStar(require("./Tracking.js"), exports);
@@ -93,9 +96,11 @@ __exportStar(require("./RcsBase.js"), exports);
93
96
  __exportStar(require("./RichTextMessage.js"), exports);
94
97
  __exportStar(require("./RichMediaMessage.js"), exports);
95
98
  __exportStar(require("./RcsCards.js"), exports);
99
+ __exportStar(require("./Options.js"), exports);
96
100
  __exportStar(require("./RichCardsMessage.js"), exports);
97
101
  __exportStar(require("./RichMessage.js"), exports);
98
102
  __exportStar(require("./SentRcsDetails.js"), exports);
103
+ __exportStar(require("./SendTypingIndicatorResponse.js"), exports);
99
104
  __exportStar(require("./SmsValidationResult.js"), exports);
100
105
  __exportStar(require("./MmsValidationResult.js"), exports);
101
106
  __exportStar(require("./RcsValidateContent.js"), exports);
@@ -145,5 +150,13 @@ __exportStar(require("./VCardData.js"), exports);
145
150
  __exportStar(require("./VcardResource.js"), exports);
146
151
  __exportStar(require("./Webhooks.js"), exports);
147
152
  __exportStar(require("./WebhookResult.js"), exports);
153
+ __exportStar(require("./MessageEventSmsContent.js"), exports);
154
+ __exportStar(require("./MessageEventMmsContent.js"), exports);
155
+ __exportStar(require("./MessageEventRcsTextContent.js"), exports);
156
+ __exportStar(require("./MessageEventRcsMediaContent.js"), exports);
157
+ __exportStar(require("./MessageEventRcsCardsContent.js"), exports);
158
+ __exportStar(require("./MessageEventRcsButtonData.js"), exports);
159
+ __exportStar(require("./MessageEventRcsLocationData.js"), exports);
160
+ __exportStar(require("./MessageEventContent.js"), exports);
148
161
  __exportStar(require("./MessageEvent.js"), exports);
149
162
  __exportStar(require("./UserEvent.js"), exports);
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "2.0.1";
1
+ export declare const SDK_VERSION = "2.0.3-rc.1";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "2.0.1";
4
+ exports.SDK_VERSION = "2.0.3-rc.1";
@@ -15,18 +15,23 @@ const index_js_1 = require("../../api/errors/index.js");
15
15
  class EnhancedMessages extends Client_js_1.Messages {
16
16
  process(req, secret) {
17
17
  return __awaiter(this, void 0, void 0, function* () {
18
- var _a, _b;
18
+ var _a, _b, _c;
19
19
  const signingSecret = secret || process.env.PINNACLE_SIGNING_SECRET;
20
20
  let headerSecret;
21
21
  let body;
22
22
  if (req instanceof Request) {
23
23
  headerSecret =
24
- ((_a = req.headers) === null || _a === void 0 ? void 0 : _a.get("PINNACLE-SIGNING-SECRET")) || ((_b = req.headers) === null || _b === void 0 ? void 0 : _b.get("pinnacle-signing-secret")) || undefined;
24
+ ((_a = req.headers) === null || _a === void 0 ? void 0 : _a.get("PINNACLE-SIGNING-SECRET")) ||
25
+ ((_b = req.headers) === null || _b === void 0 ? void 0 : _b.get("pinnacle-signing-secret")) ||
26
+ ((_c = req.headers) === null || _c === void 0 ? void 0 : _c.get("Pinnacle-Signing-Secret")) ||
27
+ undefined;
25
28
  body = yield req.json();
26
29
  }
27
30
  else {
28
31
  const headers = req.headers;
29
- headerSecret = headers["pinnacle-signing-secret"];
32
+ headerSecret = (headers["PINNACLE-SIGNING-SECRET"] ||
33
+ headers["pinnacle-signing-secret"] ||
34
+ headers["Pinnacle-Signing-Secret"]);
30
35
  body = req.body;
31
36
  }
32
37
  if (!signingSecret) {
@@ -18,8 +18,8 @@ export class PinnacleClient {
18
18
  this._options = Object.assign(Object.assign({}, _options), { headers: mergeHeaders({
19
19
  "X-Fern-Language": "JavaScript",
20
20
  "X-Fern-SDK-Name": "rcs-js",
21
- "X-Fern-SDK-Version": "2.0.1",
22
- "User-Agent": "rcs-js/2.0.1",
21
+ "X-Fern-SDK-Version": "2.0.3-rc.1",
22
+ "User-Agent": "rcs-js/2.0.3-rc.1",
23
23
  "X-Fern-Runtime": core.RUNTIME.type,
24
24
  "X-Fern-Runtime-Version": core.RUNTIME.version,
25
25
  }, _options === null || _options === void 0 ? void 0 : _options.headers) });
@@ -2,8 +2,7 @@
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
4
  import * as errors from "../../errors/index.mjs";
5
- import * as Pinnacle from "../index.mjs";
6
5
  import * as core from "../../core/index.mjs";
7
6
  export declare class NotFoundError extends errors.PinnacleError {
8
- constructor(body: Pinnacle.Error_, rawResponse?: core.RawResponse);
7
+ constructor(body?: unknown, rawResponse?: core.RawResponse);
9
8
  }
@@ -74,7 +74,7 @@ export declare class Brands {
74
74
  * description: "A developer-friendly, compliant API for SMS, MMS, and RCS, built to scale real conversations.",
75
75
  * ein: "88-1234567",
76
76
  * email: "founders@trypinnacle.app",
77
- * id: 1,
77
+ * id: "b_1234567890",
78
78
  * name: "Pinnacle",
79
79
  * sector: "TECHNOLOGY",
80
80
  * type: "PRIVATE_PROFIT",
@@ -86,7 +86,8 @@ export declare class Brands {
86
86
  /**
87
87
  * Retrieve detailed information for a specific brand in your account by ID.
88
88
  *
89
- * @param {number} id - ID of an existing brand in your account that you want to retrieve.
89
+ * @param {string} id - The unique identifier of the brand you want to retrieve from your account.
90
+ * <br><br> This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`.
90
91
  * @param {Pinnacle.BrandsGetRequest} request
91
92
  * @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
92
93
  *
@@ -96,16 +97,15 @@ export declare class Brands {
96
97
  * @throws {@link Pinnacle.InternalServerError}
97
98
  *
98
99
  * @example
99
- * await client.brands.get(1)
100
+ * await client.brands.get("b_1234567890")
100
101
  */
101
- get(id: number, request?: Pinnacle.BrandsGetRequest, requestOptions?: Brands.RequestOptions): core.HttpResponsePromise<Pinnacle.ExtendedBrandWithVetting>;
102
+ get(id: string, request?: Pinnacle.BrandsGetRequest, requestOptions?: Brands.RequestOptions): core.HttpResponsePromise<Pinnacle.ExtendedBrandWithVetting>;
102
103
  private __get;
103
104
  /**
104
105
  * Submit your brand for review and approval by the compliance team.
105
106
  *
106
- * @param {number} brandId - The unique identifier of the brand you want to submit for review. <br>
107
- *
108
- * Must correspond to an existing brand in your account that is ready for submission.
107
+ * @param {string} brandId - The unique identifier of the brand you want to submit for review. <br><br>
108
+ * This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890` and must correspond to an existing brand in your account that is ready for submission.
109
109
  * @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
110
110
  *
111
111
  * @throws {@link Pinnacle.BadRequestError}
@@ -116,9 +116,9 @@ export declare class Brands {
116
116
  * @throws {@link Pinnacle.NotImplementedError}
117
117
  *
118
118
  * @example
119
- * await client.brands.submit(1)
119
+ * await client.brands.submit("b_1234567890")
120
120
  */
121
- submit(brandId: number, requestOptions?: Brands.RequestOptions): core.HttpResponsePromise<Pinnacle.SubmissionResults>;
121
+ submit(brandId: string, requestOptions?: Brands.RequestOptions): core.HttpResponsePromise<Pinnacle.SubmissionResults>;
122
122
  private __submit;
123
123
  /**
124
124
  * Validate your brand information for compliance and correctness before submission or storage.
@@ -154,9 +154,9 @@ export declare class Brands {
154
154
  /**
155
155
  * Submit a brand for external vetting verification to enhance your brand's trust score and improved message delivery rates.
156
156
  *
157
- * @param {number} brandId - The unique identifier of the brand to vet. <br>
157
+ * @param {string} brandId - The unique identifier of the brand to vet. <br>
158
158
  *
159
- * The brand must be already registered before it can be vetted.
159
+ * This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890` and must correspond to an existing brand in your account that is ready for vetting.
160
160
  * @param {Pinnacle.VetBrandParams} request
161
161
  * @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
162
162
  *
@@ -168,9 +168,9 @@ export declare class Brands {
168
168
  * @throws {@link Pinnacle.NotImplementedError}
169
169
  *
170
170
  * @example
171
- * await client.brands.vet(1, {})
171
+ * await client.brands.vet("b_1234567890", {})
172
172
  */
173
- vet(brandId: number, request: Pinnacle.VetBrandParams, requestOptions?: Brands.RequestOptions): core.HttpResponsePromise<Pinnacle.VettingResults>;
173
+ vet(brandId: string, request: Pinnacle.VetBrandParams, requestOptions?: Brands.RequestOptions): core.HttpResponsePromise<Pinnacle.VettingResults>;
174
174
  private __vet;
175
175
  protected _getCustomAuthorizationHeaders(): Promise<{
176
176
  "PINNACLE-API-KEY": string | undefined;
@@ -117,7 +117,7 @@ export class Brands {
117
117
  * description: "A developer-friendly, compliant API for SMS, MMS, and RCS, built to scale real conversations.",
118
118
  * ein: "88-1234567",
119
119
  * email: "founders@trypinnacle.app",
120
- * id: 1,
120
+ * id: "b_1234567890",
121
121
  * name: "Pinnacle",
122
122
  * sector: "TECHNOLOGY",
123
123
  * type: "PRIVATE_PROFIT",
@@ -182,7 +182,8 @@ export class Brands {
182
182
  /**
183
183
  * Retrieve detailed information for a specific brand in your account by ID.
184
184
  *
185
- * @param {number} id - ID of an existing brand in your account that you want to retrieve.
185
+ * @param {string} id - The unique identifier of the brand you want to retrieve from your account.
186
+ * <br><br> This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`.
186
187
  * @param {Pinnacle.BrandsGetRequest} request
187
188
  * @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
188
189
  *
@@ -192,7 +193,7 @@ export class Brands {
192
193
  * @throws {@link Pinnacle.InternalServerError}
193
194
  *
194
195
  * @example
195
- * await client.brands.get(1)
196
+ * await client.brands.get("b_1234567890")
196
197
  */
197
198
  get(id, request = {}, requestOptions) {
198
199
  return core.HttpResponsePromise.fromPromise(this.__get(id, request, requestOptions));
@@ -256,9 +257,8 @@ export class Brands {
256
257
  /**
257
258
  * Submit your brand for review and approval by the compliance team.
258
259
  *
259
- * @param {number} brandId - The unique identifier of the brand you want to submit for review. <br>
260
- *
261
- * Must correspond to an existing brand in your account that is ready for submission.
260
+ * @param {string} brandId - The unique identifier of the brand you want to submit for review. <br><br>
261
+ * This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890` and must correspond to an existing brand in your account that is ready for submission.
262
262
  * @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
263
263
  *
264
264
  * @throws {@link Pinnacle.BadRequestError}
@@ -269,7 +269,7 @@ export class Brands {
269
269
  * @throws {@link Pinnacle.NotImplementedError}
270
270
  *
271
271
  * @example
272
- * await client.brands.submit(1)
272
+ * await client.brands.submit("b_1234567890")
273
273
  */
274
274
  submit(brandId, requestOptions) {
275
275
  return core.HttpResponsePromise.fromPromise(this.__submit(brandId, requestOptions));
@@ -416,9 +416,9 @@ export class Brands {
416
416
  /**
417
417
  * Submit a brand for external vetting verification to enhance your brand's trust score and improved message delivery rates.
418
418
  *
419
- * @param {number} brandId - The unique identifier of the brand to vet. <br>
419
+ * @param {string} brandId - The unique identifier of the brand to vet. <br>
420
420
  *
421
- * The brand must be already registered before it can be vetted.
421
+ * This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890` and must correspond to an existing brand in your account that is ready for vetting.
422
422
  * @param {Pinnacle.VetBrandParams} request
423
423
  * @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
424
424
  *
@@ -430,7 +430,7 @@ export class Brands {
430
430
  * @throws {@link Pinnacle.NotImplementedError}
431
431
  *
432
432
  * @example
433
- * await client.brands.vet(1, {})
433
+ * await client.brands.vet("b_1234567890", {})
434
434
  */
435
435
  vet(brandId, request, requestOptions) {
436
436
  return core.HttpResponsePromise.fromPromise(this.__vet(brandId, request, requestOptions));
@@ -16,7 +16,7 @@ import * as Pinnacle from "../../../../index.mjs";
16
16
  * description: "A developer-friendly, compliant API for SMS, MMS, and RCS, built to scale real conversations.",
17
17
  * ein: "88-1234567",
18
18
  * email: "founders@trypinnacle.app",
19
- * id: 1,
19
+ * id: "b_1234567890",
20
20
  * name: "Pinnacle",
21
21
  * sector: "TECHNOLOGY",
22
22
  * type: "PRIVATE_PROFIT",
@@ -36,8 +36,11 @@ export interface UpsertBrandParams {
36
36
  ein?: string | null;
37
37
  /** Main contact email address for the brand. */
38
38
  email?: string | null;
39
- /** Brand ID - include only when updating an existing brand, omit to create a new one. */
40
- id?: number;
39
+ /**
40
+ * The unique identifier of the brand you want to update.
41
+ * <br><br> This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`.
42
+ */
43
+ id?: string;
41
44
  /** Legal name of the brand as registered. */
42
45
  name?: string | null;
43
46
  /** Industry the brand operates in. */
@@ -41,8 +41,8 @@ export declare class Dlc {
41
41
  *
42
42
  * @example
43
43
  * await client.campaigns.dlc.autofill({
44
- * additionalInfo: "Please autofill missing DLC campaign fields using my brand profile",
45
- * campaignId: 161
44
+ * additionalInfo: "Please autofill missing campaign fields using my brand profile",
45
+ * campaignId: "dlc_1234567890"
46
46
  * })
47
47
  */
48
48
  autofill(request: Pinnacle.AutofillCampaignParams, requestOptions?: Dlc.RequestOptions): core.HttpResponsePromise<Pinnacle.AutofillDlcCampaignResponse>;
@@ -50,7 +50,7 @@ export declare class Dlc {
50
50
  /**
51
51
  * Retrieve 10DLC campaign.
52
52
  *
53
- * @param {number} campaignId - Unique identifier of the 10DLC campaign.
53
+ * @param {string} campaignId - Unique identifier of the 10DLC campaign. This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`.
54
54
  * @param {Dlc.RequestOptions} requestOptions - Request-specific configuration.
55
55
  *
56
56
  * @throws {@link Pinnacle.BadRequestError}
@@ -59,14 +59,15 @@ export declare class Dlc {
59
59
  * @throws {@link Pinnacle.InternalServerError}
60
60
  *
61
61
  * @example
62
- * await client.campaigns.dlc.get(28)
62
+ * await client.campaigns.dlc.get("dlc_1234567890")
63
63
  */
64
- get(campaignId: number, requestOptions?: Dlc.RequestOptions): core.HttpResponsePromise<Pinnacle.DlcCampaignWithExtendedBrandAndStatus>;
64
+ get(campaignId: string, requestOptions?: Dlc.RequestOptions): core.HttpResponsePromise<Pinnacle.DlcCampaignWithExtendedBrandAndStatus>;
65
65
  private __get;
66
66
  /**
67
67
  * Submit your 10DLC campaign for approval and activation with carriers.
68
68
  *
69
- * @param {number} campaignId - Unique identifier of the 10DLC campaign to submit.
69
+ * @param {string} campaignId - Unique identifier of the 10DLC campaign to submit.
70
+ * <br><br> This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`.
70
71
  * @param {Dlc.RequestOptions} requestOptions - Request-specific configuration.
71
72
  *
72
73
  * @throws {@link Pinnacle.BadRequestError}
@@ -75,9 +76,9 @@ export declare class Dlc {
75
76
  * @throws {@link Pinnacle.InternalServerError}
76
77
  *
77
78
  * @example
78
- * await client.campaigns.dlc.submit(161)
79
+ * await client.campaigns.dlc.submit("dlc_1234567890")
79
80
  */
80
- submit(campaignId: number, requestOptions?: Dlc.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignSubmissionResult>;
81
+ submit(campaignId: string, requestOptions?: Dlc.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignSubmissionResult>;
81
82
  private __submit;
82
83
  /**
83
84
  * Create a new 10DLC campaign or updates an existing one. <br>
@@ -95,19 +96,19 @@ export declare class Dlc {
95
96
  * @example
96
97
  * await client.campaigns.dlc.upsert({
97
98
  * autoRenew: true,
98
- * brand: 1,
99
- * campaignId: 161,
99
+ * brand: "b_1234567890",
100
+ * campaignId: "dlc_1234567890",
100
101
  * keywords: {
101
102
  * HELP: {
102
103
  * message: "Reply HELP for assistance, STOP to opt-out",
103
104
  * values: ["HELP", "INFO", "SUPPORT"]
104
105
  * },
105
106
  * OPT_IN: {
106
- * message: "Welcome! You're now subscribed to Pinnacle.",
107
+ * message: "Welcome. You are now subscribed to Pinnacle.",
107
108
  * values: ["JOIN", "START", "SUBSCRIBE"]
108
109
  * },
109
110
  * OPT_OUT: {
110
- * message: "You've been unsubscribed. Reply START to rejoin.",
111
+ * message: "You have been unsubscribed. Reply START to rejoin.",
111
112
  * values: ["STOP", "QUIT", "UNSUBSCRIBE"]
112
113
  * }
113
114
  * },
@@ -147,7 +148,7 @@ export declare class Dlc {
147
148
  * @example
148
149
  * await client.campaigns.dlc.validate({
149
150
  * additionalInfo: "Please validate this DLC campaign for 10DLC compliance",
150
- * campaignId: 161
151
+ * campaignId: "dlc_1234567890"
151
152
  * })
152
153
  */
153
154
  validate(request: Pinnacle.ValidateCampaignParams, requestOptions?: Dlc.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignValidationResult>;
@@ -31,8 +31,8 @@ export class Dlc {
31
31
  *
32
32
  * @example
33
33
  * await client.campaigns.dlc.autofill({
34
- * additionalInfo: "Please autofill missing DLC campaign fields using my brand profile",
35
- * campaignId: 161
34
+ * additionalInfo: "Please autofill missing campaign fields using my brand profile",
35
+ * campaignId: "dlc_1234567890"
36
36
  * })
37
37
  */
38
38
  autofill(request, requestOptions) {
@@ -93,7 +93,7 @@ export class Dlc {
93
93
  /**
94
94
  * Retrieve 10DLC campaign.
95
95
  *
96
- * @param {number} campaignId - Unique identifier of the 10DLC campaign.
96
+ * @param {string} campaignId - Unique identifier of the 10DLC campaign. This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`.
97
97
  * @param {Dlc.RequestOptions} requestOptions - Request-specific configuration.
98
98
  *
99
99
  * @throws {@link Pinnacle.BadRequestError}
@@ -102,7 +102,7 @@ export class Dlc {
102
102
  * @throws {@link Pinnacle.InternalServerError}
103
103
  *
104
104
  * @example
105
- * await client.campaigns.dlc.get(28)
105
+ * await client.campaigns.dlc.get("dlc_1234567890")
106
106
  */
107
107
  get(campaignId, requestOptions) {
108
108
  return core.HttpResponsePromise.fromPromise(this.__get(campaignId, requestOptions));
@@ -164,7 +164,8 @@ export class Dlc {
164
164
  /**
165
165
  * Submit your 10DLC campaign for approval and activation with carriers.
166
166
  *
167
- * @param {number} campaignId - Unique identifier of the 10DLC campaign to submit.
167
+ * @param {string} campaignId - Unique identifier of the 10DLC campaign to submit.
168
+ * <br><br> This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`.
168
169
  * @param {Dlc.RequestOptions} requestOptions - Request-specific configuration.
169
170
  *
170
171
  * @throws {@link Pinnacle.BadRequestError}
@@ -173,7 +174,7 @@ export class Dlc {
173
174
  * @throws {@link Pinnacle.InternalServerError}
174
175
  *
175
176
  * @example
176
- * await client.campaigns.dlc.submit(161)
177
+ * await client.campaigns.dlc.submit("dlc_1234567890")
177
178
  */
178
179
  submit(campaignId, requestOptions) {
179
180
  return core.HttpResponsePromise.fromPromise(this.__submit(campaignId, requestOptions));
@@ -245,19 +246,19 @@ export class Dlc {
245
246
  * @example
246
247
  * await client.campaigns.dlc.upsert({
247
248
  * autoRenew: true,
248
- * brand: 1,
249
- * campaignId: 161,
249
+ * brand: "b_1234567890",
250
+ * campaignId: "dlc_1234567890",
250
251
  * keywords: {
251
252
  * HELP: {
252
253
  * message: "Reply HELP for assistance, STOP to opt-out",
253
254
  * values: ["HELP", "INFO", "SUPPORT"]
254
255
  * },
255
256
  * OPT_IN: {
256
- * message: "Welcome! You're now subscribed to Pinnacle.",
257
+ * message: "Welcome. You are now subscribed to Pinnacle.",
257
258
  * values: ["JOIN", "START", "SUBSCRIBE"]
258
259
  * },
259
260
  * OPT_OUT: {
260
- * message: "You've been unsubscribed. Reply START to rejoin.",
261
+ * message: "You have been unsubscribed. Reply START to rejoin.",
261
262
  * values: ["STOP", "QUIT", "UNSUBSCRIBE"]
262
263
  * }
263
264
  * },
@@ -355,7 +356,7 @@ export class Dlc {
355
356
  * @example
356
357
  * await client.campaigns.dlc.validate({
357
358
  * additionalInfo: "Please validate this DLC campaign for 10DLC compliance",
358
- * campaignId: 161
359
+ * campaignId: "dlc_1234567890"
359
360
  * })
360
361
  */
361
362
  validate(request, requestOptions) {
@@ -6,19 +6,19 @@ import * as Pinnacle from "../../../../../../index.mjs";
6
6
  * @example
7
7
  * {
8
8
  * autoRenew: true,
9
- * brand: 1,
10
- * campaignId: 161,
9
+ * brand: "b_1234567890",
10
+ * campaignId: "dlc_1234567890",
11
11
  * keywords: {
12
12
  * HELP: {
13
13
  * message: "Reply HELP for assistance, STOP to opt-out",
14
14
  * values: ["HELP", "INFO", "SUPPORT"]
15
15
  * },
16
16
  * OPT_IN: {
17
- * message: "Welcome! You're now subscribed to Pinnacle.",
17
+ * message: "Welcome. You are now subscribed to Pinnacle.",
18
18
  * values: ["JOIN", "START", "SUBSCRIBE"]
19
19
  * },
20
20
  * OPT_OUT: {
21
- * message: "You've been unsubscribed. Reply START to rejoin.",
21
+ * message: "You have been unsubscribed. Reply START to rejoin.",
22
22
  * values: ["STOP", "QUIT", "UNSUBSCRIBE"]
23
23
  * }
24
24
  * },
@@ -46,10 +46,10 @@ import * as Pinnacle from "../../../../../../index.mjs";
46
46
  export interface UpsertDlcCampaignParams {
47
47
  /** Whether the campaign renews automatically. */
48
48
  autoRenew?: boolean;
49
- /** Brand id. */
50
- brand?: number;
51
- /** Unique identifier for the campaign. */
52
- campaignId?: number;
49
+ /** Brand id. This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`. */
50
+ brand?: string;
51
+ /** Unique identifier for the campaign. This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`. */
52
+ campaignId?: string;
53
53
  /** Description of the campaign. */
54
54
  description?: string;
55
55
  /** Keyword response configuration. */
@@ -41,8 +41,8 @@ export declare class Rcs {
41
41
  *
42
42
  * @example
43
43
  * await client.campaigns.rcs.autofill({
44
- * additionalInfo: "Please autofill missing DLC campaign fields using my brand profile",
45
- * campaignId: 161
44
+ * additionalInfo: "Please autofill missing campaign fields using my brand profile",
45
+ * campaignId: "dlc_1234567890"
46
46
  * })
47
47
  */
48
48
  autofill(request: Pinnacle.AutofillCampaignParams, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.campaigns.RcsAutofillResponse>;
@@ -50,7 +50,7 @@ export declare class Rcs {
50
50
  /**
51
51
  * Retrieve RCS campaign.
52
52
  *
53
- * @param {number} campaignId - Unique identifier of the RCS campaign.
53
+ * @param {string} campaignId - Unique identifier of the RCS campaign. Must begin with the prefix `rcs_`.
54
54
  * @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
55
55
  *
56
56
  * @throws {@link Pinnacle.BadRequestError}
@@ -59,14 +59,14 @@ export declare class Rcs {
59
59
  * @throws {@link Pinnacle.InternalServerError}
60
60
  *
61
61
  * @example
62
- * await client.campaigns.rcs.get(161)
62
+ * await client.campaigns.rcs.get("rcs_1234567890")
63
63
  */
64
- get(campaignId: number, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.ExtendedRcsCampaign>;
64
+ get(campaignId: string, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.ExtendedRcsCampaign>;
65
65
  private __get;
66
66
  /**
67
67
  * Submit your RCS campaign for approval and activation with carriers.
68
68
  *
69
- * @param {number} campaignId - Unique identifier of the RCS campaign to retrieve.
69
+ * @param {string} campaignId - Unique identifier of the RCS campaign to retrieve. Must begin with the prefix `rcs_`.
70
70
  * @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
71
71
  *
72
72
  * @throws {@link Pinnacle.BadRequestError}
@@ -76,9 +76,9 @@ export declare class Rcs {
76
76
  * @throws {@link Pinnacle.InternalServerError}
77
77
  *
78
78
  * @example
79
- * await client.campaigns.rcs.submit(161)
79
+ * await client.campaigns.rcs.submit("rcs_1234567890")
80
80
  */
81
- submit(campaignId: number, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignSubmissionResult>;
81
+ submit(campaignId: string, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignSubmissionResult>;
82
82
  private __submit;
83
83
  /**
84
84
  * Create a new RCS campaign or updates an existing one. <br>
@@ -115,7 +115,8 @@ export declare class Rcs {
115
115
  * }]
116
116
  * },
117
117
  * brandVerificationUrl: "https://www.pinnacle.sh/articles-of-incorporation.pdf",
118
- * brand: 2,
118
+ * brand: "b_1234567890",
119
+ * campaignId: "rcs_1234567890",
119
120
  * 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."],
120
121
  * links: {
121
122
  * privacyPolicy: "https://www.trypinnacle.app/privacy",
@@ -150,7 +151,7 @@ export declare class Rcs {
150
151
  * @example
151
152
  * await client.campaigns.rcs.validate({
152
153
  * additionalInfo: "Please validate this DLC campaign for 10DLC compliance",
153
- * campaignId: 161
154
+ * campaignId: "dlc_1234567890"
154
155
  * })
155
156
  */
156
157
  validate(request: Pinnacle.ValidateCampaignParams, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignValidationResult>;