rcs-js 2.0.0-rc.9 → 2.0.1-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 (378) hide show
  1. package/dist/cjs/Client.d.ts +5 -2
  2. package/dist/cjs/Client.js +16 -11
  3. package/dist/cjs/api/errors/NotFoundError.d.ts +1 -2
  4. package/dist/cjs/api/resources/brands/client/Client.d.ts +19 -17
  5. package/dist/cjs/api/resources/brands/client/Client.js +25 -19
  6. package/dist/cjs/api/resources/brands/client/requests/BrandsGetRequest.d.ts +1 -1
  7. package/dist/cjs/api/resources/brands/client/requests/UpsertBrandParams.d.ts +9 -6
  8. package/dist/cjs/api/resources/campaigns/client/Client.d.ts +2 -2
  9. package/dist/cjs/api/resources/campaigns/client/Client.js +1 -1
  10. package/dist/cjs/api/resources/campaigns/resources/dlc/client/Client.d.ts +21 -20
  11. package/dist/cjs/api/resources/campaigns/resources/dlc/client/Client.js +17 -16
  12. package/dist/cjs/api/resources/campaigns/resources/dlc/client/requests/UpsertDlcCampaignParams.d.ts +8 -8
  13. package/dist/cjs/api/resources/campaigns/resources/rcs/client/Client.d.ts +16 -13
  14. package/dist/cjs/api/resources/campaigns/resources/rcs/client/Client.js +14 -9
  15. package/dist/cjs/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.ts +9 -7
  16. package/dist/cjs/api/resources/campaigns/resources/rcs/types/RcsAutofillResponse.d.ts +1 -1
  17. package/dist/cjs/api/resources/campaigns/resources/tollFree/client/Client.d.ts +15 -15
  18. package/dist/cjs/api/resources/campaigns/resources/tollFree/client/Client.js +11 -11
  19. package/dist/cjs/api/resources/campaigns/resources/tollFree/client/requests/UpsertTollFreeCampaignParams.d.ts +7 -7
  20. package/dist/cjs/api/resources/campaigns/resources/tollFree/types/TollFreeAutofillResponse.d.ts +1 -1
  21. package/dist/cjs/api/resources/contacts/client/Client.d.ts +7 -5
  22. package/dist/cjs/api/resources/contacts/client/Client.js +11 -9
  23. package/dist/cjs/api/resources/contacts/client/requests/ContactsGetRequest.d.ts +5 -3
  24. package/dist/cjs/api/resources/contacts/client/requests/UpdateContactParams.d.ts +3 -3
  25. package/dist/cjs/api/resources/conversations/client/Client.d.ts +25 -8
  26. package/dist/cjs/api/resources/conversations/client/Client.js +101 -9
  27. package/dist/cjs/api/resources/conversations/client/requests/ConversationsListMessagesRequest.d.ts +36 -0
  28. package/dist/cjs/api/resources/conversations/client/requests/ListConversationsParams.d.ts +11 -6
  29. package/dist/cjs/api/resources/conversations/client/requests/UpdateConversationParams.d.ts +3 -3
  30. package/dist/cjs/api/resources/conversations/client/requests/index.d.ts +1 -0
  31. package/dist/cjs/api/resources/conversations/index.d.ts +1 -0
  32. package/dist/cjs/api/resources/conversations/index.js +1 -0
  33. package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestDirection.d.ts +8 -0
  34. package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestDirection.js +10 -0
  35. package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestSortOrder.d.ts +8 -0
  36. package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestSortOrder.js +10 -0
  37. package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestStatus.d.ts +13 -0
  38. package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestStatus.js +15 -0
  39. package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestType.d.ts +9 -0
  40. package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestType.js +11 -0
  41. package/dist/cjs/api/resources/conversations/types/index.d.ts +4 -0
  42. package/dist/cjs/api/resources/conversations/types/index.js +20 -0
  43. package/dist/cjs/api/resources/index.d.ts +4 -1
  44. package/dist/cjs/api/resources/index.js +5 -2
  45. package/dist/cjs/api/resources/messages/client/Client.d.ts +10 -7
  46. package/dist/cjs/api/resources/messages/client/Client.js +13 -4
  47. package/dist/cjs/api/resources/messages/client/requests/ReactMessageParams.d.ts +4 -4
  48. package/dist/cjs/api/resources/messages/resources/mms/client/Client.d.ts +4 -3
  49. package/dist/cjs/api/resources/messages/resources/mms/client/Client.js +4 -1
  50. package/dist/cjs/api/resources/messages/resources/rcs/client/Client.d.ts +6 -5
  51. package/dist/cjs/api/resources/messages/resources/rcs/client/Client.js +5 -2
  52. package/dist/cjs/api/resources/messages/resources/sms/client/Client.d.ts +4 -3
  53. package/dist/cjs/api/resources/messages/resources/sms/client/Client.js +4 -1
  54. package/dist/cjs/api/resources/phoneNumbers/client/Client.d.ts +3 -3
  55. package/dist/cjs/api/resources/phoneNumbers/client/Client.js +1 -1
  56. package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/Client.d.ts +7 -5
  57. package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/Client.js +9 -3
  58. package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/requests/AttachCampaignParams.d.ts +12 -3
  59. package/dist/cjs/api/resources/phoneNumbers/resources/webhook/client/Client.d.ts +11 -9
  60. package/dist/cjs/api/resources/phoneNumbers/resources/webhook/client/Client.js +10 -6
  61. package/dist/cjs/api/resources/rcs/client/Client.d.ts +121 -0
  62. package/dist/cjs/api/resources/rcs/client/Client.js +320 -0
  63. package/dist/cjs/api/resources/rcs/client/index.d.ts +2 -0
  64. package/dist/cjs/api/resources/rcs/client/index.js +17 -0
  65. package/dist/cjs/api/resources/rcs/client/requests/RcsCapabilitiesQuery.d.ts +13 -0
  66. package/dist/cjs/api/resources/rcs/client/requests/RcsLinkRequest.d.ts +22 -0
  67. package/dist/cjs/api/resources/rcs/client/requests/RcsWhitelistRequest.d.ts +16 -0
  68. package/dist/cjs/api/resources/rcs/client/requests/RcsWhitelistRequest.js +5 -0
  69. package/dist/cjs/api/resources/rcs/client/requests/index.d.ts +3 -0
  70. package/dist/cjs/api/resources/rcs/client/requests/index.js +2 -0
  71. package/dist/cjs/api/resources/rcs/index.d.ts +1 -0
  72. package/dist/cjs/api/resources/rcs/index.js +17 -0
  73. package/dist/cjs/api/resources/status/client/Client.d.ts +2 -2
  74. package/dist/cjs/api/resources/status/client/Client.js +1 -1
  75. package/dist/cjs/api/resources/status/resources/get/client/Client.d.ts +16 -16
  76. package/dist/cjs/api/resources/status/resources/get/client/Client.js +10 -10
  77. package/dist/cjs/api/resources/tools/client/Client.d.ts +2 -2
  78. package/dist/cjs/api/resources/tools/client/Client.js +1 -1
  79. package/dist/cjs/api/resources/tools/resources/contactCard/client/Client.d.ts +7 -7
  80. package/dist/cjs/api/resources/tools/resources/contactCard/client/Client.js +5 -5
  81. package/dist/cjs/api/resources/tools/resources/contactCard/client/requests/GetVcardParams.d.ts +3 -3
  82. package/dist/cjs/api/resources/tools/resources/contactCard/client/requests/UpsertVcardParams.d.ts +1 -1
  83. package/dist/cjs/api/resources/tools/resources/file/client/Client.d.ts +24 -3
  84. package/dist/cjs/api/resources/tools/resources/file/client/Client.js +75 -1
  85. package/dist/cjs/api/resources/tools/resources/file/client/requests/RefreshFileParams.d.ts +13 -0
  86. package/dist/cjs/api/resources/tools/resources/file/client/requests/RefreshFileParams.js +5 -0
  87. package/dist/cjs/api/resources/tools/resources/file/client/requests/index.d.ts +1 -0
  88. package/dist/cjs/api/resources/tools/resources/url/client/Client.d.ts +4 -4
  89. package/dist/cjs/api/resources/tools/resources/url/client/Client.js +2 -2
  90. package/dist/cjs/api/resources/webhooks/client/Client.d.ts +3 -3
  91. package/dist/cjs/api/resources/webhooks/client/Client.js +1 -1
  92. package/dist/cjs/api/types/AdvancedPhoneInformation.d.ts +9 -9
  93. package/dist/cjs/api/types/AttachWebhookParams.d.ts +3 -3
  94. package/dist/cjs/api/types/AttachedPhoneNumberResult.d.ts +2 -2
  95. package/dist/cjs/api/types/AutofillCampaignParams.d.ts +7 -2
  96. package/dist/cjs/api/types/AutofillDlcCampaignResponse.d.ts +15 -15
  97. package/dist/cjs/api/types/BrandStatus.d.ts +2 -2
  98. package/dist/cjs/api/types/ButtonClicked.d.ts +11 -0
  99. package/dist/cjs/api/types/ButtonClicked.js +5 -0
  100. package/dist/cjs/api/types/ButtonClickedData.d.ts +58 -0
  101. package/dist/cjs/api/types/ButtonClickedData.js +16 -0
  102. package/dist/cjs/api/types/CampaignQuery.d.ts +6 -1
  103. package/dist/cjs/api/types/ConfiguredWebhook.d.ts +2 -2
  104. package/dist/cjs/api/types/Contact.d.ts +2 -2
  105. package/dist/cjs/api/types/ContactId.d.ts +2 -2
  106. package/dist/cjs/api/types/Conversation.d.ts +9 -9
  107. package/dist/cjs/api/types/CreateUrlOptions.d.ts +1 -1
  108. package/dist/cjs/api/types/DetachedPhoneNumberResult.d.ts +2 -2
  109. package/dist/cjs/api/types/DetachedWebhookInfo.d.ts +2 -2
  110. package/dist/cjs/api/types/DlcCampaignStatus.d.ts +4 -4
  111. package/dist/cjs/api/types/DlcCampaignWithExtendedBrandAndStatus.d.ts +15 -12
  112. package/dist/cjs/api/types/EnhancedContactItem.d.ts +1 -1
  113. package/dist/cjs/api/types/ExtendedBrand.d.ts +14 -7
  114. package/dist/cjs/api/types/ExtendedBrandWithVetting.d.ts +2 -2
  115. package/dist/cjs/api/types/ExtendedRcsCampaign.d.ts +14 -13
  116. package/dist/cjs/api/types/GetConversationParams.d.ts +1 -1
  117. package/dist/cjs/api/types/LinkClickEvent.d.ts +0 -4
  118. package/dist/cjs/api/types/Message.d.ts +6 -6
  119. package/dist/cjs/api/types/MessageContent.d.ts +2 -2
  120. package/dist/cjs/api/types/MessageEvent.d.ts +62 -0
  121. package/dist/cjs/api/types/MessageEvent.js +13 -0
  122. package/dist/cjs/api/types/MessageList.d.ts +15 -0
  123. package/dist/cjs/api/types/MessageList.js +5 -0
  124. package/dist/cjs/api/types/MessageWithReaction.d.ts +27 -0
  125. package/dist/cjs/api/types/MessageWithReaction.js +13 -0
  126. package/dist/cjs/api/types/NotFoundErrorBody.d.ts +6 -0
  127. package/dist/cjs/api/types/NotFoundErrorBody.js +5 -0
  128. package/dist/cjs/api/types/ProfileStatusEnum.d.ts +7 -4
  129. package/dist/cjs/api/types/RcsBase.d.ts +2 -0
  130. package/dist/cjs/api/types/RcsButtonCall.d.ts +2 -0
  131. package/dist/cjs/api/types/RcsButtonOpenUrl.d.ts +2 -0
  132. package/dist/cjs/api/types/RcsButtonRequestUserLocation.d.ts +2 -0
  133. package/dist/cjs/api/types/RcsButtonScheduleEvent.d.ts +2 -0
  134. package/dist/cjs/api/types/RcsButtonSendLocation.d.ts +2 -0
  135. package/dist/cjs/api/types/RcsButtonTrigger.d.ts +2 -2
  136. package/dist/cjs/api/types/RcsCampaign.d.ts +5 -5
  137. package/dist/cjs/api/types/RcsCampaignStatus.d.ts +2 -2
  138. package/dist/cjs/api/types/RcsCapabilitiesResult.d.ts +8 -0
  139. package/dist/cjs/api/types/RcsCapabilitiesResult.js +5 -0
  140. package/dist/cjs/api/types/RcsCapability.d.ts +36 -0
  141. package/dist/cjs/api/types/RcsCapability.js +5 -0
  142. package/dist/cjs/api/types/RcsLinkResult.d.ts +13 -0
  143. package/dist/cjs/api/types/RcsLinkResult.js +5 -0
  144. package/dist/cjs/api/types/RcsValidateContent.d.ts +1 -0
  145. package/dist/cjs/api/types/RcsWhitelistResponse.d.ts +10 -0
  146. package/dist/cjs/api/types/RcsWhitelistResponse.js +5 -0
  147. package/dist/cjs/api/types/ReactionResult.d.ts +4 -4
  148. package/dist/cjs/api/types/RefreshedFile.d.ts +9 -0
  149. package/dist/cjs/api/types/RefreshedFile.js +5 -0
  150. package/dist/cjs/api/types/{Rcs.d.ts → RichMessage.d.ts} +1 -1
  151. package/dist/cjs/api/types/RichMessage.js +5 -0
  152. package/dist/cjs/api/types/ScheduledMessaage.d.ts +2 -2
  153. package/dist/cjs/api/types/SentMmsDetails.d.ts +2 -2
  154. package/dist/cjs/api/types/SentRcsDetails.d.ts +2 -2
  155. package/dist/cjs/api/types/SentSmsDetails.d.ts +2 -2
  156. package/dist/cjs/api/types/ShortenedUrl.d.ts +1 -1
  157. package/dist/cjs/api/types/TollFreeCampaign.d.ts +2 -2
  158. package/dist/cjs/api/types/TollFreeCampaignStatus.d.ts +2 -2
  159. package/dist/cjs/api/types/TollFreeCampaignWithExtendedBrandAndStatus.d.ts +0 -1
  160. package/dist/cjs/api/types/UpdatedContactId.d.ts +2 -2
  161. package/dist/cjs/api/types/UploadResults.d.ts +1 -1
  162. package/dist/cjs/api/types/UserEvent.d.ts +27 -0
  163. package/dist/cjs/api/types/UserEvent.js +5 -0
  164. package/dist/cjs/api/types/VCardData.d.ts +1 -1
  165. package/dist/cjs/api/types/ValidateCampaignParams.d.ts +7 -2
  166. package/dist/cjs/api/types/Vcard.d.ts +2 -2
  167. package/dist/cjs/api/types/VcardResource.d.ts +2 -2
  168. package/dist/cjs/api/types/WebhookEventEnum.d.ts +1 -0
  169. package/dist/cjs/api/types/Webhooks.d.ts +2 -2
  170. package/dist/cjs/api/types/index.d.ts +13 -3
  171. package/dist/cjs/api/types/index.js +13 -3
  172. package/dist/cjs/index.d.ts +1 -1
  173. package/dist/cjs/index.js +2 -2
  174. package/dist/cjs/version.d.ts +1 -1
  175. package/dist/cjs/version.js +1 -1
  176. package/dist/cjs/wrapper/PinnacleClient.d.ts +9 -0
  177. package/dist/cjs/wrapper/PinnacleClient.js +17 -0
  178. package/dist/cjs/wrapper/messages/Client.d.ts +13 -0
  179. package/dist/cjs/wrapper/messages/Client.js +49 -0
  180. package/dist/cjs/wrapper/tools/Client.d.ts +6 -0
  181. package/dist/cjs/wrapper/tools/Client.js +12 -0
  182. package/dist/cjs/wrapper/tools/FileUploader.d.ts +15 -0
  183. package/dist/cjs/wrapper/tools/FileUploader.js +162 -0
  184. package/dist/esm/Client.d.mts +5 -2
  185. package/dist/esm/Client.mjs +8 -3
  186. package/dist/esm/api/errors/NotFoundError.d.mts +1 -2
  187. package/dist/esm/api/resources/brands/client/Client.d.mts +19 -17
  188. package/dist/esm/api/resources/brands/client/Client.mjs +25 -19
  189. package/dist/esm/api/resources/brands/client/requests/BrandsGetRequest.d.mts +1 -1
  190. package/dist/esm/api/resources/brands/client/requests/UpsertBrandParams.d.mts +9 -6
  191. package/dist/esm/api/resources/campaigns/client/Client.d.mts +2 -2
  192. package/dist/esm/api/resources/campaigns/client/Client.mjs +1 -1
  193. package/dist/esm/api/resources/campaigns/resources/dlc/client/Client.d.mts +21 -20
  194. package/dist/esm/api/resources/campaigns/resources/dlc/client/Client.mjs +17 -16
  195. package/dist/esm/api/resources/campaigns/resources/dlc/client/requests/UpsertDlcCampaignParams.d.mts +8 -8
  196. package/dist/esm/api/resources/campaigns/resources/rcs/client/Client.d.mts +16 -13
  197. package/dist/esm/api/resources/campaigns/resources/rcs/client/Client.mjs +14 -9
  198. package/dist/esm/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.mts +9 -7
  199. package/dist/esm/api/resources/campaigns/resources/rcs/types/RcsAutofillResponse.d.mts +1 -1
  200. package/dist/esm/api/resources/campaigns/resources/tollFree/client/Client.d.mts +15 -15
  201. package/dist/esm/api/resources/campaigns/resources/tollFree/client/Client.mjs +11 -11
  202. package/dist/esm/api/resources/campaigns/resources/tollFree/client/requests/UpsertTollFreeCampaignParams.d.mts +7 -7
  203. package/dist/esm/api/resources/campaigns/resources/tollFree/types/TollFreeAutofillResponse.d.mts +1 -1
  204. package/dist/esm/api/resources/contacts/client/Client.d.mts +7 -5
  205. package/dist/esm/api/resources/contacts/client/Client.mjs +11 -9
  206. package/dist/esm/api/resources/contacts/client/requests/ContactsGetRequest.d.mts +5 -3
  207. package/dist/esm/api/resources/contacts/client/requests/UpdateContactParams.d.mts +3 -3
  208. package/dist/esm/api/resources/conversations/client/Client.d.mts +25 -8
  209. package/dist/esm/api/resources/conversations/client/Client.mjs +101 -9
  210. package/dist/esm/api/resources/conversations/client/requests/ConversationsListMessagesRequest.d.mts +36 -0
  211. package/dist/esm/api/resources/conversations/client/requests/ListConversationsParams.d.mts +11 -6
  212. package/dist/esm/api/resources/conversations/client/requests/UpdateConversationParams.d.mts +3 -3
  213. package/dist/esm/api/resources/conversations/client/requests/index.d.mts +1 -0
  214. package/dist/esm/api/resources/conversations/index.d.mts +1 -0
  215. package/dist/esm/api/resources/conversations/index.mjs +1 -0
  216. package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestDirection.d.mts +8 -0
  217. package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestDirection.mjs +7 -0
  218. package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestSortOrder.d.mts +8 -0
  219. package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestSortOrder.mjs +7 -0
  220. package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestStatus.d.mts +13 -0
  221. package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestStatus.mjs +12 -0
  222. package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestType.d.mts +9 -0
  223. package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestType.mjs +8 -0
  224. package/dist/esm/api/resources/conversations/types/index.d.mts +4 -0
  225. package/dist/esm/api/resources/conversations/types/index.mjs +4 -0
  226. package/dist/esm/api/resources/index.d.mts +4 -1
  227. package/dist/esm/api/resources/index.mjs +4 -1
  228. package/dist/esm/api/resources/messages/client/Client.d.mts +10 -7
  229. package/dist/esm/api/resources/messages/client/Client.mjs +13 -4
  230. package/dist/esm/api/resources/messages/client/requests/ReactMessageParams.d.mts +4 -4
  231. package/dist/esm/api/resources/messages/resources/mms/client/Client.d.mts +4 -3
  232. package/dist/esm/api/resources/messages/resources/mms/client/Client.mjs +4 -1
  233. package/dist/esm/api/resources/messages/resources/rcs/client/Client.d.mts +6 -5
  234. package/dist/esm/api/resources/messages/resources/rcs/client/Client.mjs +5 -2
  235. package/dist/esm/api/resources/messages/resources/sms/client/Client.d.mts +4 -3
  236. package/dist/esm/api/resources/messages/resources/sms/client/Client.mjs +4 -1
  237. package/dist/esm/api/resources/phoneNumbers/client/Client.d.mts +3 -3
  238. package/dist/esm/api/resources/phoneNumbers/client/Client.mjs +1 -1
  239. package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/Client.d.mts +7 -5
  240. package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/Client.mjs +9 -3
  241. package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/requests/AttachCampaignParams.d.mts +12 -3
  242. package/dist/esm/api/resources/phoneNumbers/resources/webhook/client/Client.d.mts +11 -9
  243. package/dist/esm/api/resources/phoneNumbers/resources/webhook/client/Client.mjs +10 -6
  244. package/dist/esm/api/resources/rcs/client/Client.d.mts +121 -0
  245. package/dist/esm/api/resources/rcs/client/Client.mjs +283 -0
  246. package/dist/esm/api/resources/rcs/client/index.d.mts +2 -0
  247. package/dist/esm/api/resources/rcs/client/index.mjs +1 -0
  248. package/dist/esm/api/resources/rcs/client/requests/RcsCapabilitiesQuery.d.mts +13 -0
  249. package/dist/esm/api/resources/rcs/client/requests/RcsLinkRequest.d.mts +22 -0
  250. package/dist/esm/api/resources/rcs/client/requests/RcsWhitelistRequest.d.mts +16 -0
  251. package/dist/esm/api/resources/rcs/client/requests/RcsWhitelistRequest.mjs +4 -0
  252. package/dist/esm/api/resources/rcs/client/requests/index.d.mts +3 -0
  253. package/dist/esm/api/resources/rcs/client/requests/index.mjs +1 -0
  254. package/dist/esm/api/resources/rcs/index.d.mts +1 -0
  255. package/dist/esm/api/resources/rcs/index.mjs +1 -0
  256. package/dist/esm/api/resources/status/client/Client.d.mts +2 -2
  257. package/dist/esm/api/resources/status/client/Client.mjs +1 -1
  258. package/dist/esm/api/resources/status/resources/get/client/Client.d.mts +16 -16
  259. package/dist/esm/api/resources/status/resources/get/client/Client.mjs +10 -10
  260. package/dist/esm/api/resources/tools/client/Client.d.mts +2 -2
  261. package/dist/esm/api/resources/tools/client/Client.mjs +1 -1
  262. package/dist/esm/api/resources/tools/resources/contactCard/client/Client.d.mts +7 -7
  263. package/dist/esm/api/resources/tools/resources/contactCard/client/Client.mjs +5 -5
  264. package/dist/esm/api/resources/tools/resources/contactCard/client/requests/GetVcardParams.d.mts +3 -3
  265. package/dist/esm/api/resources/tools/resources/contactCard/client/requests/UpsertVcardParams.d.mts +1 -1
  266. package/dist/esm/api/resources/tools/resources/file/client/Client.d.mts +24 -3
  267. package/dist/esm/api/resources/tools/resources/file/client/Client.mjs +75 -1
  268. package/dist/esm/api/resources/tools/resources/file/client/requests/RefreshFileParams.d.mts +13 -0
  269. package/dist/esm/api/resources/tools/resources/file/client/requests/RefreshFileParams.mjs +4 -0
  270. package/dist/esm/api/resources/tools/resources/file/client/requests/index.d.mts +1 -0
  271. package/dist/esm/api/resources/tools/resources/url/client/Client.d.mts +4 -4
  272. package/dist/esm/api/resources/tools/resources/url/client/Client.mjs +2 -2
  273. package/dist/esm/api/resources/webhooks/client/Client.d.mts +3 -3
  274. package/dist/esm/api/resources/webhooks/client/Client.mjs +1 -1
  275. package/dist/esm/api/types/AdvancedPhoneInformation.d.mts +9 -9
  276. package/dist/esm/api/types/AttachWebhookParams.d.mts +3 -3
  277. package/dist/esm/api/types/AttachedPhoneNumberResult.d.mts +2 -2
  278. package/dist/esm/api/types/AutofillCampaignParams.d.mts +7 -2
  279. package/dist/esm/api/types/AutofillDlcCampaignResponse.d.mts +15 -15
  280. package/dist/esm/api/types/BrandStatus.d.mts +2 -2
  281. package/dist/esm/api/types/ButtonClicked.d.mts +11 -0
  282. package/dist/esm/api/types/ButtonClicked.mjs +4 -0
  283. package/dist/esm/api/types/ButtonClickedData.d.mts +58 -0
  284. package/dist/esm/api/types/ButtonClickedData.mjs +13 -0
  285. package/dist/esm/api/types/CampaignQuery.d.mts +6 -1
  286. package/dist/esm/api/types/ConfiguredWebhook.d.mts +2 -2
  287. package/dist/esm/api/types/Contact.d.mts +2 -2
  288. package/dist/esm/api/types/ContactId.d.mts +2 -2
  289. package/dist/esm/api/types/Conversation.d.mts +9 -9
  290. package/dist/esm/api/types/CreateUrlOptions.d.mts +1 -1
  291. package/dist/esm/api/types/DetachedPhoneNumberResult.d.mts +2 -2
  292. package/dist/esm/api/types/DetachedWebhookInfo.d.mts +2 -2
  293. package/dist/esm/api/types/DlcCampaignStatus.d.mts +4 -4
  294. package/dist/esm/api/types/DlcCampaignWithExtendedBrandAndStatus.d.mts +15 -12
  295. package/dist/esm/api/types/EnhancedContactItem.d.mts +1 -1
  296. package/dist/esm/api/types/ExtendedBrand.d.mts +14 -7
  297. package/dist/esm/api/types/ExtendedBrandWithVetting.d.mts +2 -2
  298. package/dist/esm/api/types/ExtendedRcsCampaign.d.mts +14 -13
  299. package/dist/esm/api/types/GetConversationParams.d.mts +1 -1
  300. package/dist/esm/api/types/LinkClickEvent.d.mts +0 -4
  301. package/dist/esm/api/types/Message.d.mts +6 -6
  302. package/dist/esm/api/types/MessageContent.d.mts +2 -2
  303. package/dist/esm/api/types/MessageEvent.d.mts +62 -0
  304. package/dist/esm/api/types/MessageEvent.mjs +10 -0
  305. package/dist/esm/api/types/MessageList.d.mts +15 -0
  306. package/dist/esm/api/types/MessageList.mjs +4 -0
  307. package/dist/esm/api/types/MessageWithReaction.d.mts +27 -0
  308. package/dist/esm/api/types/MessageWithReaction.mjs +10 -0
  309. package/dist/esm/api/types/NotFoundErrorBody.d.mts +6 -0
  310. package/dist/esm/api/types/NotFoundErrorBody.mjs +4 -0
  311. package/dist/esm/api/types/ProfileStatusEnum.d.mts +7 -4
  312. package/dist/esm/api/types/RcsBase.d.mts +2 -0
  313. package/dist/esm/api/types/RcsButtonCall.d.mts +2 -0
  314. package/dist/esm/api/types/RcsButtonOpenUrl.d.mts +2 -0
  315. package/dist/esm/api/types/RcsButtonRequestUserLocation.d.mts +2 -0
  316. package/dist/esm/api/types/RcsButtonScheduleEvent.d.mts +2 -0
  317. package/dist/esm/api/types/RcsButtonSendLocation.d.mts +2 -0
  318. package/dist/esm/api/types/RcsButtonTrigger.d.mts +2 -2
  319. package/dist/esm/api/types/RcsCampaign.d.mts +5 -5
  320. package/dist/esm/api/types/RcsCampaignStatus.d.mts +2 -2
  321. package/dist/esm/api/types/RcsCapabilitiesResult.d.mts +8 -0
  322. package/dist/esm/api/types/RcsCapabilitiesResult.mjs +4 -0
  323. package/dist/esm/api/types/RcsCapability.d.mts +36 -0
  324. package/dist/esm/api/types/RcsCapability.mjs +4 -0
  325. package/dist/esm/api/types/RcsLinkResult.d.mts +13 -0
  326. package/dist/esm/api/types/RcsLinkResult.mjs +4 -0
  327. package/dist/esm/api/types/RcsValidateContent.d.mts +1 -0
  328. package/dist/esm/api/types/RcsWhitelistResponse.d.mts +10 -0
  329. package/dist/esm/api/types/RcsWhitelistResponse.mjs +4 -0
  330. package/dist/esm/api/types/ReactionResult.d.mts +4 -4
  331. package/dist/esm/api/types/RefreshedFile.d.mts +9 -0
  332. package/dist/esm/api/types/RefreshedFile.mjs +4 -0
  333. package/dist/esm/api/types/{Rcs.d.mts → RichMessage.d.mts} +1 -1
  334. package/dist/esm/api/types/RichMessage.mjs +4 -0
  335. package/dist/esm/api/types/ScheduledMessaage.d.mts +2 -2
  336. package/dist/esm/api/types/SentMmsDetails.d.mts +2 -2
  337. package/dist/esm/api/types/SentRcsDetails.d.mts +2 -2
  338. package/dist/esm/api/types/SentSmsDetails.d.mts +2 -2
  339. package/dist/esm/api/types/ShortenedUrl.d.mts +1 -1
  340. package/dist/esm/api/types/TollFreeCampaign.d.mts +2 -2
  341. package/dist/esm/api/types/TollFreeCampaignStatus.d.mts +2 -2
  342. package/dist/esm/api/types/TollFreeCampaignWithExtendedBrandAndStatus.d.mts +0 -1
  343. package/dist/esm/api/types/UpdatedContactId.d.mts +2 -2
  344. package/dist/esm/api/types/UploadResults.d.mts +1 -1
  345. package/dist/esm/api/types/UserEvent.d.mts +27 -0
  346. package/dist/esm/api/types/UserEvent.mjs +4 -0
  347. package/dist/esm/api/types/VCardData.d.mts +1 -1
  348. package/dist/esm/api/types/ValidateCampaignParams.d.mts +7 -2
  349. package/dist/esm/api/types/Vcard.d.mts +2 -2
  350. package/dist/esm/api/types/VcardResource.d.mts +2 -2
  351. package/dist/esm/api/types/WebhookEventEnum.d.mts +1 -0
  352. package/dist/esm/api/types/Webhooks.d.mts +2 -2
  353. package/dist/esm/api/types/index.d.mts +13 -3
  354. package/dist/esm/api/types/index.mjs +13 -3
  355. package/dist/esm/index.d.mts +1 -1
  356. package/dist/esm/index.mjs +1 -1
  357. package/dist/esm/version.d.mts +1 -1
  358. package/dist/esm/version.mjs +1 -1
  359. package/dist/esm/wrapper/PinnacleClient.d.mts +9 -0
  360. package/dist/esm/wrapper/PinnacleClient.mjs +13 -0
  361. package/dist/esm/wrapper/messages/Client.d.mts +13 -0
  362. package/dist/esm/wrapper/messages/Client.mjs +45 -0
  363. package/dist/esm/wrapper/tools/Client.d.mts +6 -0
  364. package/dist/esm/wrapper/tools/Client.mjs +8 -0
  365. package/dist/esm/wrapper/tools/FileUploader.d.mts +15 -0
  366. package/dist/esm/wrapper/tools/FileUploader.mjs +125 -0
  367. package/package.json +7 -3
  368. package/reference.md +459 -76
  369. package/dist/cjs/api/types/ClickAction.d.ts +0 -28
  370. package/dist/cjs/api/types/InboundButton.d.ts +0 -11
  371. package/dist/esm/api/types/ClickAction.d.mts +0 -28
  372. package/dist/esm/api/types/InboundButton.d.mts +0 -11
  373. /package/dist/cjs/api/{types/ClickAction.js → resources/conversations/client/requests/ConversationsListMessagesRequest.js} +0 -0
  374. /package/dist/cjs/api/{types/InboundButton.js → resources/rcs/client/requests/RcsCapabilitiesQuery.js} +0 -0
  375. /package/dist/cjs/api/{types/Rcs.js → resources/rcs/client/requests/RcsLinkRequest.js} +0 -0
  376. /package/dist/esm/api/{types/ClickAction.mjs → resources/conversations/client/requests/ConversationsListMessagesRequest.mjs} +0 -0
  377. /package/dist/esm/api/{types/InboundButton.mjs → resources/rcs/client/requests/RcsCapabilitiesQuery.mjs} +0 -0
  378. /package/dist/esm/api/{types/Rcs.mjs → resources/rcs/client/requests/RcsLinkRequest.mjs} +0 -0
@@ -9,7 +9,7 @@ export declare namespace Brands {
9
9
  environment?: core.Supplier<environments.PinnacleEnvironment | string>;
10
10
  /** Specify a custom URL to connect the client to. */
11
11
  baseUrl?: core.Supplier<string>;
12
- apiKey: core.Supplier<string>;
12
+ apiKey?: core.Supplier<string | undefined>;
13
13
  /** Additional headers to include in requests. */
14
14
  headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
15
15
  }
@@ -28,7 +28,7 @@ export declare namespace Brands {
28
28
  }
29
29
  export declare class Brands {
30
30
  protected readonly _options: Brands.Options;
31
- constructor(_options: Brands.Options);
31
+ constructor(_options?: Brands.Options);
32
32
  /**
33
33
  * Automatically populate brand information based on partial input data you provide.
34
34
  *
@@ -74,19 +74,20 @@ 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",
81
81
  * website: "https://www.pinnacle.sh"
82
82
  * })
83
83
  */
84
- upsert(request?: Pinnacle.UpsertBrandParams, requestOptions?: Brands.RequestOptions): core.HttpResponsePromise<Pinnacle.ExtendedBrand>;
84
+ upsert(request: Pinnacle.UpsertBrandParams, requestOptions?: Brands.RequestOptions): core.HttpResponsePromise<Pinnacle.ExtendedBrand>;
85
85
  private __upsert;
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,28 +97,28 @@ 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}
112
112
  * @throws {@link Pinnacle.UnauthorizedError}
113
113
  * @throws {@link Pinnacle.PaymentRequiredError}
114
+ * @throws {@link Pinnacle.NotFoundError}
114
115
  * @throws {@link Pinnacle.InternalServerError}
115
116
  * @throws {@link Pinnacle.NotImplementedError}
116
117
  *
117
118
  * @example
118
- * await client.brands.submit(1)
119
+ * await client.brands.submit("b_1234567890")
119
120
  */
120
- submit(brandId: number, requestOptions?: Brands.RequestOptions): core.HttpResponsePromise<Pinnacle.SubmissionResults>;
121
+ submit(brandId: string, requestOptions?: Brands.RequestOptions): core.HttpResponsePromise<Pinnacle.SubmissionResults>;
121
122
  private __submit;
122
123
  /**
123
124
  * Validate your brand information for compliance and correctness before submission or storage.
@@ -153,24 +154,25 @@ export declare class Brands {
153
154
  /**
154
155
  * Submit a brand for external vetting verification to enhance your brand's trust score and improved message delivery rates.
155
156
  *
156
- * @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>
157
158
  *
158
- * 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.
159
160
  * @param {Pinnacle.VetBrandParams} request
160
161
  * @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
161
162
  *
162
163
  * @throws {@link Pinnacle.BadRequestError}
163
164
  * @throws {@link Pinnacle.UnauthorizedError}
164
165
  * @throws {@link Pinnacle.PaymentRequiredError}
166
+ * @throws {@link Pinnacle.NotFoundError}
165
167
  * @throws {@link Pinnacle.InternalServerError}
166
168
  * @throws {@link Pinnacle.NotImplementedError}
167
169
  *
168
170
  * @example
169
- * await client.brands.vet(1, {})
171
+ * await client.brands.vet("b_1234567890", {})
170
172
  */
171
- 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>;
172
174
  private __vet;
173
175
  protected _getCustomAuthorizationHeaders(): Promise<{
174
- "PINNACLE-API-KEY": string;
176
+ "PINNACLE-API-KEY": string | undefined;
175
177
  }>;
176
178
  }
@@ -16,7 +16,7 @@ import * as Pinnacle from "../../../index.mjs";
16
16
  import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../core/headers.mjs";
17
17
  import * as errors from "../../../../errors/index.mjs";
18
18
  export class Brands {
19
- constructor(_options) {
19
+ constructor(_options = {}) {
20
20
  this._options = _options;
21
21
  }
22
22
  /**
@@ -117,18 +117,18 @@ 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",
124
124
  * website: "https://www.pinnacle.sh"
125
125
  * })
126
126
  */
127
- upsert(request = {}, requestOptions) {
127
+ upsert(request, requestOptions) {
128
128
  return core.HttpResponsePromise.fromPromise(this.__upsert(request, requestOptions));
129
129
  }
130
- __upsert() {
131
- return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
130
+ __upsert(request, requestOptions) {
131
+ return __awaiter(this, void 0, void 0, function* () {
132
132
  var _a, _b, _c;
133
133
  let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
134
134
  const _response = yield core.fetcher({
@@ -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,22 +193,22 @@ 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));
199
200
  }
200
201
  __get(id_1) {
201
202
  return __awaiter(this, arguments, void 0, function* (id, request = {}, requestOptions) {
202
- var _a, _b, _c, _d;
203
+ var _a, _b, _c;
203
204
  const { hideEIN: hideEin } = request;
204
205
  const _queryParams = {};
205
- if (hideEin !== undefined) {
206
- _queryParams["hideEIN"] = (_a = hideEin === null || hideEin === void 0 ? void 0 : hideEin.toString()) !== null && _a !== void 0 ? _a : null;
206
+ if (hideEin != null) {
207
+ _queryParams["hideEIN"] = hideEin.toString();
207
208
  }
208
- let _headers = mergeHeaders((_b = this._options) === null || _b === void 0 ? void 0 : _b.headers, mergeOnlyDefinedHeaders(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
209
+ let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
209
210
  const _response = yield core.fetcher({
210
- url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.PinnacleEnvironment.Default, `brands/${encodeURIComponent(id)}`),
211
+ url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PinnacleEnvironment.Default, `brands/${encodeURIComponent(id)}`),
211
212
  method: "GET",
212
213
  headers: _headers,
213
214
  queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
@@ -256,19 +257,19 @@ 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}
265
265
  * @throws {@link Pinnacle.UnauthorizedError}
266
266
  * @throws {@link Pinnacle.PaymentRequiredError}
267
+ * @throws {@link Pinnacle.NotFoundError}
267
268
  * @throws {@link Pinnacle.InternalServerError}
268
269
  * @throws {@link Pinnacle.NotImplementedError}
269
270
  *
270
271
  * @example
271
- * await client.brands.submit(1)
272
+ * await client.brands.submit("b_1234567890")
272
273
  */
273
274
  submit(brandId, requestOptions) {
274
275
  return core.HttpResponsePromise.fromPromise(this.__submit(brandId, requestOptions));
@@ -297,6 +298,8 @@ export class Brands {
297
298
  throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
298
299
  case 402:
299
300
  throw new Pinnacle.PaymentRequiredError(_response.error.body, _response.rawResponse);
301
+ case 404:
302
+ throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
300
303
  case 500:
301
304
  throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
302
305
  case 501:
@@ -413,20 +416,21 @@ export class Brands {
413
416
  /**
414
417
  * Submit a brand for external vetting verification to enhance your brand's trust score and improved message delivery rates.
415
418
  *
416
- * @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>
417
420
  *
418
- * 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.
419
422
  * @param {Pinnacle.VetBrandParams} request
420
423
  * @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
421
424
  *
422
425
  * @throws {@link Pinnacle.BadRequestError}
423
426
  * @throws {@link Pinnacle.UnauthorizedError}
424
427
  * @throws {@link Pinnacle.PaymentRequiredError}
428
+ * @throws {@link Pinnacle.NotFoundError}
425
429
  * @throws {@link Pinnacle.InternalServerError}
426
430
  * @throws {@link Pinnacle.NotImplementedError}
427
431
  *
428
432
  * @example
429
- * await client.brands.vet(1, {})
433
+ * await client.brands.vet("b_1234567890", {})
430
434
  */
431
435
  vet(brandId, request, requestOptions) {
432
436
  return core.HttpResponsePromise.fromPromise(this.__vet(brandId, request, requestOptions));
@@ -458,6 +462,8 @@ export class Brands {
458
462
  throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
459
463
  case 402:
460
464
  throw new Pinnacle.PaymentRequiredError(_response.error.body, _response.rawResponse);
465
+ case 404:
466
+ throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
461
467
  case 500:
462
468
  throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
463
469
  case 501:
@@ -11,5 +11,5 @@ export interface BrandsGetRequest {
11
11
  *
12
12
  * When you set this to true, the EIN value will be replaced with a masked placeholder instead of the actual number.
13
13
  */
14
- hideEIN?: boolean | null;
14
+ hideEIN?: boolean;
15
15
  }
@@ -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",
@@ -27,7 +27,7 @@ export interface UpsertBrandParams {
27
27
  /** Primary brand address where the company is located. */
28
28
  address?: string | null;
29
29
  /** Contact information for the brand. */
30
- contact?: Pinnacle.UpsertContact | null;
30
+ contact: Pinnacle.UpsertContact | null;
31
31
  /** "Doing Business As" name - the public name the brand operates under. */
32
32
  dba?: string | null;
33
33
  /** Brief description of what the brand does. */
@@ -36,14 +36,17 @@ 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. */
44
- sector?: Pinnacle.CompanySectorEnum | null;
47
+ sector: Pinnacle.CompanySectorEnum | null;
45
48
  /** Legal structure of the brand. */
46
- type?: Pinnacle.CompanyTypeEnum | null;
49
+ type: Pinnacle.CompanyTypeEnum | null;
47
50
  /** Brand website URL. */
48
51
  website?: string | null;
49
52
  }
@@ -11,7 +11,7 @@ export declare namespace Campaigns {
11
11
  environment?: core.Supplier<environments.PinnacleEnvironment | string>;
12
12
  /** Specify a custom URL to connect the client to. */
13
13
  baseUrl?: core.Supplier<string>;
14
- apiKey: core.Supplier<string>;
14
+ apiKey?: core.Supplier<string | undefined>;
15
15
  /** Additional headers to include in requests. */
16
16
  headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
17
17
  }
@@ -21,7 +21,7 @@ export declare class Campaigns {
21
21
  protected _dlc: Dlc | undefined;
22
22
  protected _tollFree: TollFree | undefined;
23
23
  protected _rcs: Rcs | undefined;
24
- constructor(_options: Campaigns.Options);
24
+ constructor(_options?: Campaigns.Options);
25
25
  get dlc(): Dlc;
26
26
  get tollFree(): TollFree;
27
27
  get rcs(): Rcs;
@@ -5,7 +5,7 @@ import { Dlc } from "../resources/dlc/client/Client.mjs";
5
5
  import { TollFree } from "../resources/tollFree/client/Client.mjs";
6
6
  import { Rcs } from "../resources/rcs/client/Client.mjs";
7
7
  export class Campaigns {
8
- constructor(_options) {
8
+ constructor(_options = {}) {
9
9
  this._options = _options;
10
10
  }
11
11
  get dlc() {
@@ -9,7 +9,7 @@ export declare namespace Dlc {
9
9
  environment?: core.Supplier<environments.PinnacleEnvironment | string>;
10
10
  /** Specify a custom URL to connect the client to. */
11
11
  baseUrl?: core.Supplier<string>;
12
- apiKey: core.Supplier<string>;
12
+ apiKey?: core.Supplier<string | undefined>;
13
13
  /** Additional headers to include in requests. */
14
14
  headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
15
15
  }
@@ -28,7 +28,7 @@ export declare namespace Dlc {
28
28
  }
29
29
  export declare class Dlc {
30
30
  protected readonly _options: Dlc.Options;
31
- constructor(_options: Dlc.Options);
31
+ constructor(_options?: Dlc.Options);
32
32
  /**
33
33
  * Generate campaign details based off existing campaign and the brand it's connected to.
34
34
  *
@@ -41,16 +41,16 @@ 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>;
49
49
  private __autofill;
50
50
  /**
51
- * Retrieve DLC campaign.
51
+ * Retrieve 10DLC campaign.
52
52
  *
53
- * @param {number} campaignId - Unique identifier of the DLC 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
- * Submit your DLC campaign for approval and activation with carriers.
67
+ * Submit your 10DLC campaign for approval and activation with carriers.
68
68
  *
69
- * @param {number} campaignId - Unique identifier of the DLC 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,12 +76,12 @@ 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
- * Create a new DLC campaign or updates an existing one. <br>
84
+ * Create a new 10DLC campaign or updates an existing one. <br>
84
85
  *
85
86
  * Omit campaignId to create a campaign.
86
87
  *
@@ -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
  * },
@@ -135,7 +136,7 @@ export declare class Dlc {
135
136
  upsert(request?: Pinnacle.campaigns.UpsertDlcCampaignParams, requestOptions?: Dlc.RequestOptions): core.HttpResponsePromise<Pinnacle.DlcCampaignWithExtendedBrandAndStatus>;
136
137
  private __upsert;
137
138
  /**
138
- * Validate your DLC campaign configuration against carrier requirements and compliance rules.
139
+ * Validate your 10DLC campaign configuration against carrier requirements and compliance rules.
139
140
  *
140
141
  * @param {Pinnacle.ValidateCampaignParams} request
141
142
  * @param {Dlc.RequestOptions} requestOptions - Request-specific configuration.
@@ -147,12 +148,12 @@ 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>;
154
155
  private __validate;
155
156
  protected _getCustomAuthorizationHeaders(): Promise<{
156
- "PINNACLE-API-KEY": string;
157
+ "PINNACLE-API-KEY": string | undefined;
157
158
  }>;
158
159
  }
@@ -16,7 +16,7 @@ import * as Pinnacle from "../../../../../index.mjs";
16
16
  import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../../../core/headers.mjs";
17
17
  import * as errors from "../../../../../../errors/index.mjs";
18
18
  export class Dlc {
19
- constructor(_options) {
19
+ constructor(_options = {}) {
20
20
  this._options = _options;
21
21
  }
22
22
  /**
@@ -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) {
@@ -91,9 +91,9 @@ export class Dlc {
91
91
  });
92
92
  }
93
93
  /**
94
- * Retrieve DLC campaign.
94
+ * Retrieve 10DLC campaign.
95
95
  *
96
- * @param {number} campaignId - Unique identifier of the DLC 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));
@@ -162,9 +162,10 @@ export class Dlc {
162
162
  });
163
163
  }
164
164
  /**
165
- * Submit your DLC campaign for approval and activation with carriers.
165
+ * Submit your 10DLC campaign for approval and activation with carriers.
166
166
  *
167
- * @param {number} campaignId - Unique identifier of the DLC 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));
@@ -230,7 +231,7 @@ export class Dlc {
230
231
  });
231
232
  }
232
233
  /**
233
- * Create a new DLC campaign or updates an existing one. <br>
234
+ * Create a new 10DLC campaign or updates an existing one. <br>
234
235
  *
235
236
  * Omit campaignId to create a campaign.
236
237
  *
@@ -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
  * },
@@ -343,7 +344,7 @@ export class Dlc {
343
344
  });
344
345
  }
345
346
  /**
346
- * Validate your DLC campaign configuration against carrier requirements and compliance rules.
347
+ * Validate your 10DLC campaign configuration against carrier requirements and compliance rules.
347
348
  *
348
349
  * @param {Pinnacle.ValidateCampaignParams} request
349
350
  * @param {Dlc.RequestOptions} requestOptions - Request-specific configuration.
@@ -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. */