rcs-js 2.0.6 → 2.0.8

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 (1279) hide show
  1. package/README.md +248 -0
  2. package/dist/cjs/BaseClient.d.ts +30 -0
  3. package/dist/cjs/{api/types/RcsCards.js → BaseClient.js} +1 -3
  4. package/dist/cjs/Client.d.ts +6 -26
  5. package/dist/cjs/Client.js +27 -29
  6. package/dist/cjs/api/errors/BadRequestError.d.ts +1 -4
  7. package/dist/cjs/api/errors/BadRequestError.js +1 -3
  8. package/dist/cjs/api/errors/InternalServerError.d.ts +2 -5
  9. package/dist/cjs/api/errors/InternalServerError.js +1 -3
  10. package/dist/cjs/api/errors/NotFoundError.d.ts +1 -4
  11. package/dist/cjs/api/errors/NotFoundError.js +1 -3
  12. package/dist/cjs/api/errors/NotImplementedError.d.ts +2 -5
  13. package/dist/cjs/api/errors/NotImplementedError.js +1 -3
  14. package/dist/cjs/api/errors/PaymentRequiredError.d.ts +2 -5
  15. package/dist/cjs/api/errors/PaymentRequiredError.js +1 -3
  16. package/dist/cjs/api/errors/UnauthorizedError.d.ts +2 -5
  17. package/dist/cjs/api/errors/UnauthorizedError.js +1 -3
  18. package/dist/cjs/api/errors/index.d.ts +2 -2
  19. package/dist/cjs/api/errors/index.js +2 -2
  20. package/dist/cjs/api/index.d.ts +1 -1
  21. package/dist/cjs/api/index.js +1 -1
  22. package/dist/cjs/api/resources/audiences/client/Client.d.ts +4 -25
  23. package/dist/cjs/api/resources/audiences/client/Client.js +32 -26
  24. package/dist/cjs/api/resources/audiences/client/index.d.ts +0 -1
  25. package/dist/cjs/api/resources/audiences/client/requests/AudiencesDeleteRequest.d.ts +0 -3
  26. package/dist/cjs/api/resources/audiences/client/requests/AudiencesDeleteRequest.js +1 -3
  27. package/dist/cjs/api/resources/audiences/client/requests/AudiencesGetRequest.d.ts +0 -3
  28. package/dist/cjs/api/resources/audiences/client/requests/AudiencesGetRequest.js +1 -3
  29. package/dist/cjs/api/resources/audiences/client/requests/CreateAudienceParams.d.ts +0 -3
  30. package/dist/cjs/api/resources/audiences/client/requests/CreateAudienceParams.js +1 -3
  31. package/dist/cjs/api/resources/audiences/client/requests/UpdateAudienceParams.d.ts +0 -3
  32. package/dist/cjs/api/resources/audiences/client/requests/UpdateAudienceParams.js +1 -3
  33. package/dist/cjs/api/resources/audiences/client/requests/index.d.ts +4 -4
  34. package/dist/cjs/api/resources/audiences/index.d.ts +1 -1
  35. package/dist/cjs/api/resources/audiences/index.js +1 -1
  36. package/dist/cjs/api/resources/audiences/resources/contacts/client/Client.d.ts +4 -25
  37. package/dist/cjs/api/resources/audiences/resources/contacts/client/Client.js +16 -14
  38. package/dist/cjs/api/resources/audiences/resources/contacts/client/index.d.ts +0 -1
  39. package/dist/cjs/api/resources/audiences/resources/contacts/client/requests/AddContactsParams.d.ts +0 -3
  40. package/dist/cjs/api/resources/audiences/resources/contacts/client/requests/AddContactsParams.js +1 -3
  41. package/dist/cjs/api/resources/audiences/resources/contacts/client/requests/RemoveContactsParams.d.ts +0 -3
  42. package/dist/cjs/api/resources/audiences/resources/contacts/client/requests/RemoveContactsParams.js +1 -3
  43. package/dist/cjs/api/resources/audiences/resources/contacts/client/requests/index.d.ts +2 -2
  44. package/dist/cjs/api/resources/audiences/resources/index.d.ts +1 -1
  45. package/dist/cjs/api/resources/audiences/resources/index.js +4 -4
  46. package/dist/cjs/api/resources/audiences/types/AudiencesGetResponse.d.ts +1 -4
  47. package/dist/cjs/api/resources/audiences/types/AudiencesGetResponse.js +1 -3
  48. package/dist/cjs/api/resources/brands/client/Client.d.ts +6 -25
  49. package/dist/cjs/api/resources/brands/client/Client.js +46 -34
  50. package/dist/cjs/api/resources/brands/client/index.d.ts +0 -1
  51. package/dist/cjs/api/resources/brands/client/requests/AutofillBrandParams.d.ts +0 -3
  52. package/dist/cjs/api/resources/brands/client/requests/AutofillBrandParams.js +1 -3
  53. package/dist/cjs/api/resources/brands/client/requests/BrandsGetRequest.d.ts +0 -3
  54. package/dist/cjs/api/resources/brands/client/requests/BrandsGetRequest.js +1 -3
  55. package/dist/cjs/api/resources/brands/client/requests/UpsertBrandParams.d.ts +4 -4
  56. package/dist/cjs/api/resources/brands/client/requests/UpsertBrandParams.js +1 -3
  57. package/dist/cjs/api/resources/brands/client/requests/ValidateBrandParams.d.ts +4 -4
  58. package/dist/cjs/api/resources/brands/client/requests/ValidateBrandParams.js +1 -3
  59. package/dist/cjs/api/resources/brands/client/requests/VetBrandParams.d.ts +1 -5
  60. package/dist/cjs/api/resources/brands/client/requests/VetBrandParams.js +1 -3
  61. package/dist/cjs/api/resources/brands/client/requests/index.d.ts +5 -5
  62. package/dist/cjs/api/resources/campaigns/client/Client.d.ts +3 -13
  63. package/dist/cjs/api/resources/campaigns/client/Client.js +5 -7
  64. package/dist/cjs/api/resources/campaigns/index.d.ts +1 -1
  65. package/dist/cjs/api/resources/campaigns/index.js +1 -1
  66. package/dist/cjs/api/resources/campaigns/resources/dlc/client/Client.d.ts +4 -25
  67. package/dist/cjs/api/resources/campaigns/resources/dlc/client/Client.js +36 -28
  68. package/dist/cjs/api/resources/campaigns/resources/dlc/client/index.d.ts +0 -1
  69. package/dist/cjs/api/resources/campaigns/resources/dlc/client/requests/UpsertDlcCampaignParams.d.ts +1 -4
  70. package/dist/cjs/api/resources/campaigns/resources/dlc/client/requests/UpsertDlcCampaignParams.js +1 -3
  71. package/dist/cjs/api/resources/campaigns/resources/dlc/client/requests/index.d.ts +1 -1
  72. package/dist/cjs/api/resources/campaigns/resources/index.d.ts +5 -5
  73. package/dist/cjs/api/resources/campaigns/resources/index.js +9 -9
  74. package/dist/cjs/api/resources/campaigns/resources/rcs/client/Client.d.ts +36 -40
  75. package/dist/cjs/api/resources/campaigns/resources/rcs/client/Client.js +68 -43
  76. package/dist/cjs/api/resources/campaigns/resources/rcs/client/index.d.ts +0 -1
  77. package/dist/cjs/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.ts +112 -49
  78. package/dist/cjs/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.js +1 -3
  79. package/dist/cjs/api/resources/campaigns/resources/rcs/client/requests/index.d.ts +1 -1
  80. package/dist/cjs/api/resources/campaigns/resources/rcs/index.d.ts +1 -1
  81. package/dist/cjs/api/resources/campaigns/resources/rcs/index.js +1 -1
  82. package/dist/cjs/api/resources/campaigns/resources/rcs/types/RcsAutofillResponse.d.ts +1 -4
  83. package/dist/cjs/api/resources/campaigns/resources/rcs/types/RcsAutofillResponse.js +1 -3
  84. package/dist/cjs/api/resources/campaigns/resources/tollFree/client/Client.d.ts +20 -25
  85. package/dist/cjs/api/resources/campaigns/resources/tollFree/client/Client.js +52 -28
  86. package/dist/cjs/api/resources/campaigns/resources/tollFree/client/index.d.ts +0 -1
  87. package/dist/cjs/api/resources/campaigns/resources/tollFree/client/requests/UpsertTollFreeCampaignParams.d.ts +66 -4
  88. package/dist/cjs/api/resources/campaigns/resources/tollFree/client/requests/UpsertTollFreeCampaignParams.js +1 -3
  89. package/dist/cjs/api/resources/campaigns/resources/tollFree/client/requests/index.d.ts +1 -1
  90. package/dist/cjs/api/resources/campaigns/resources/tollFree/index.d.ts +1 -1
  91. package/dist/cjs/api/resources/campaigns/resources/tollFree/index.js +1 -1
  92. package/dist/cjs/api/resources/campaigns/resources/tollFree/types/TollFreeAutofillResponse.d.ts +1 -4
  93. package/dist/cjs/api/resources/campaigns/resources/tollFree/types/TollFreeAutofillResponse.js +1 -3
  94. package/dist/cjs/api/resources/contacts/client/Client.d.ts +4 -25
  95. package/dist/cjs/api/resources/contacts/client/Client.js +24 -20
  96. package/dist/cjs/api/resources/contacts/client/index.d.ts +0 -1
  97. package/dist/cjs/api/resources/contacts/client/requests/ContactsGetRequest.d.ts +0 -3
  98. package/dist/cjs/api/resources/contacts/client/requests/ContactsGetRequest.js +1 -3
  99. package/dist/cjs/api/resources/contacts/client/requests/CreateContactParams.d.ts +1 -4
  100. package/dist/cjs/api/resources/contacts/client/requests/CreateContactParams.js +1 -3
  101. package/dist/cjs/api/resources/contacts/client/requests/UpdateContactParams.d.ts +1 -4
  102. package/dist/cjs/api/resources/contacts/client/requests/UpdateContactParams.js +1 -3
  103. package/dist/cjs/api/resources/contacts/client/requests/index.d.ts +3 -3
  104. package/dist/cjs/api/resources/conversations/client/Client.d.ts +4 -25
  105. package/dist/cjs/api/resources/conversations/client/Client.js +37 -31
  106. package/dist/cjs/api/resources/conversations/client/index.d.ts +0 -1
  107. package/dist/cjs/api/resources/conversations/client/requests/ConversationsListMessagesRequest.d.ts +1 -4
  108. package/dist/cjs/api/resources/conversations/client/requests/ConversationsListMessagesRequest.js +1 -3
  109. package/dist/cjs/api/resources/conversations/client/requests/ListConversationsParams.d.ts +1 -4
  110. package/dist/cjs/api/resources/conversations/client/requests/ListConversationsParams.js +1 -3
  111. package/dist/cjs/api/resources/conversations/client/requests/UpdateConversationParams.d.ts +0 -3
  112. package/dist/cjs/api/resources/conversations/client/requests/UpdateConversationParams.js +1 -3
  113. package/dist/cjs/api/resources/conversations/client/requests/index.d.ts +3 -3
  114. package/dist/cjs/api/resources/conversations/index.d.ts +1 -1
  115. package/dist/cjs/api/resources/conversations/index.js +1 -1
  116. package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestDirection.d.ts +1 -4
  117. package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestDirection.js +1 -3
  118. package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestSortOrder.d.ts +1 -4
  119. package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestSortOrder.js +1 -3
  120. package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestStatus.d.ts +1 -4
  121. package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestStatus.js +1 -3
  122. package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestType.d.ts +1 -4
  123. package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestType.js +1 -3
  124. package/dist/cjs/api/resources/conversations/types/index.d.ts +1 -1
  125. package/dist/cjs/api/resources/conversations/types/index.js +1 -1
  126. package/dist/cjs/api/resources/index.d.ts +12 -12
  127. package/dist/cjs/api/resources/index.js +16 -16
  128. package/dist/cjs/api/resources/messages/client/Client.d.ts +11 -26
  129. package/dist/cjs/api/resources/messages/client/Client.js +29 -17
  130. package/dist/cjs/api/resources/messages/client/index.d.ts +0 -1
  131. package/dist/cjs/api/resources/messages/client/requests/ReactMessageParams.d.ts +0 -3
  132. package/dist/cjs/api/resources/messages/client/requests/ReactMessageParams.js +1 -3
  133. package/dist/cjs/api/resources/messages/client/requests/index.d.ts +1 -1
  134. package/dist/cjs/api/resources/messages/index.d.ts +1 -1
  135. package/dist/cjs/api/resources/messages/index.js +1 -1
  136. package/dist/cjs/api/resources/messages/resources/blast/client/Client.d.ts +105 -0
  137. package/dist/cjs/api/resources/messages/resources/blast/client/Client.js +325 -0
  138. package/dist/cjs/api/resources/messages/resources/blast/client/index.d.ts +1 -0
  139. package/dist/cjs/api/resources/messages/resources/blast/client/index.js +17 -0
  140. package/dist/cjs/api/resources/messages/resources/blast/client/requests/BlastMms.d.ts +61 -0
  141. package/dist/cjs/api/resources/messages/resources/{rcs/types/RcsSendResponse.js → blast/client/requests/BlastMms.js} +1 -3
  142. package/dist/cjs/api/resources/messages/resources/blast/client/requests/BlastRcs.d.ts +110 -0
  143. package/dist/cjs/api/resources/messages/resources/blast/client/requests/BlastRcs.js +23 -0
  144. package/dist/cjs/api/resources/messages/resources/blast/client/requests/BlastSms.d.ts +47 -0
  145. package/dist/cjs/api/{types/RcsBase.js → resources/messages/resources/blast/client/requests/BlastSms.js} +1 -3
  146. package/dist/cjs/api/resources/messages/resources/blast/client/requests/index.d.ts +3 -0
  147. package/dist/cjs/api/resources/messages/resources/blast/client/requests/index.js +2 -0
  148. package/dist/cjs/api/resources/messages/resources/blast/index.d.ts +2 -0
  149. package/dist/cjs/api/resources/messages/resources/blast/index.js +18 -0
  150. package/dist/cjs/api/resources/messages/resources/blast/types/BlastMmsResponse.d.ts +2 -0
  151. package/dist/cjs/api/{types/Options.js → resources/messages/resources/blast/types/BlastMmsResponse.js} +1 -3
  152. package/dist/cjs/api/resources/messages/resources/blast/types/BlastRcsResponse.d.ts +2 -0
  153. package/dist/cjs/api/resources/messages/resources/blast/types/BlastRcsResponse.js +3 -0
  154. package/dist/cjs/api/resources/messages/resources/blast/types/BlastSmsResponse.d.ts +2 -0
  155. package/dist/cjs/api/resources/messages/resources/blast/types/BlastSmsResponse.js +3 -0
  156. package/dist/cjs/api/resources/messages/resources/blast/types/index.d.ts +3 -0
  157. package/dist/cjs/api/resources/messages/resources/blast/types/index.js +19 -0
  158. package/dist/cjs/api/resources/messages/resources/index.d.ts +8 -4
  159. package/dist/cjs/api/resources/messages/resources/index.js +12 -8
  160. package/dist/cjs/api/resources/messages/resources/mms/client/Client.d.ts +4 -25
  161. package/dist/cjs/api/resources/messages/resources/mms/client/Client.js +16 -14
  162. package/dist/cjs/api/resources/messages/resources/mms/client/index.d.ts +0 -1
  163. package/dist/cjs/api/resources/messages/resources/mms/client/requests/Mms.d.ts +1 -4
  164. package/dist/cjs/api/resources/messages/resources/mms/client/requests/Mms.js +1 -3
  165. package/dist/cjs/api/resources/messages/resources/mms/client/requests/index.d.ts +1 -1
  166. package/dist/cjs/api/resources/messages/resources/mms/index.d.ts +1 -1
  167. package/dist/cjs/api/resources/messages/resources/mms/index.js +1 -1
  168. package/dist/cjs/api/resources/messages/resources/mms/types/MmsSendResponse.d.ts +2 -5
  169. package/dist/cjs/api/resources/messages/resources/mms/types/MmsSendResponse.js +1 -3
  170. package/dist/cjs/api/resources/messages/resources/rcs/client/Client.d.ts +5 -26
  171. package/dist/cjs/api/resources/messages/resources/rcs/client/Client.js +26 -19
  172. package/dist/cjs/api/resources/messages/resources/rcs/client/index.d.ts +0 -1
  173. package/dist/cjs/api/resources/messages/resources/rcs/client/requests/SendTypingIndicatorSchema.d.ts +0 -3
  174. package/dist/cjs/api/resources/messages/resources/rcs/client/requests/SendTypingIndicatorSchema.js +1 -3
  175. package/dist/cjs/api/resources/messages/resources/rcs/client/requests/index.d.ts +1 -1
  176. package/dist/cjs/api/resources/messages/resources/rcs/index.d.ts +1 -1
  177. package/dist/cjs/api/resources/messages/resources/rcs/index.js +1 -1
  178. package/dist/cjs/api/resources/messages/resources/rcs/types/SendRichMessageResponse.d.ts +2 -0
  179. package/dist/cjs/api/resources/messages/resources/rcs/types/SendRichMessageResponse.js +3 -0
  180. package/dist/cjs/api/resources/messages/resources/rcs/types/index.d.ts +1 -1
  181. package/dist/cjs/api/resources/messages/resources/rcs/types/index.js +1 -1
  182. package/dist/cjs/api/resources/messages/resources/schedule/client/Client.d.ts +32 -0
  183. package/dist/cjs/api/resources/messages/resources/schedule/client/Client.js +135 -0
  184. package/dist/cjs/api/resources/messages/resources/schedule/client/index.d.ts +1 -0
  185. package/dist/cjs/api/resources/messages/resources/schedule/client/index.js +2 -0
  186. package/dist/cjs/api/resources/messages/resources/schedule/index.d.ts +1 -0
  187. package/dist/cjs/api/resources/messages/resources/schedule/index.js +17 -0
  188. package/dist/cjs/api/resources/messages/resources/sms/client/Client.d.ts +4 -25
  189. package/dist/cjs/api/resources/messages/resources/sms/client/Client.js +16 -14
  190. package/dist/cjs/api/resources/messages/resources/sms/client/index.d.ts +0 -1
  191. package/dist/cjs/api/resources/messages/resources/sms/client/requests/Sms.d.ts +1 -4
  192. package/dist/cjs/api/resources/messages/resources/sms/client/requests/Sms.js +1 -3
  193. package/dist/cjs/api/resources/messages/resources/sms/client/requests/index.d.ts +1 -1
  194. package/dist/cjs/api/resources/messages/resources/sms/index.d.ts +1 -1
  195. package/dist/cjs/api/resources/messages/resources/sms/index.js +1 -1
  196. package/dist/cjs/api/resources/messages/resources/sms/types/SmsSendResponse.d.ts +2 -5
  197. package/dist/cjs/api/resources/messages/resources/sms/types/SmsSendResponse.js +1 -3
  198. package/dist/cjs/api/resources/phoneNumbers/client/Client.d.ts +5 -26
  199. package/dist/cjs/api/resources/phoneNumbers/client/Client.js +26 -22
  200. package/dist/cjs/api/resources/phoneNumbers/client/index.d.ts +0 -1
  201. package/dist/cjs/api/resources/phoneNumbers/client/requests/BuyPhoneNumberParams.d.ts +0 -3
  202. package/dist/cjs/api/resources/phoneNumbers/client/requests/BuyPhoneNumberParams.js +1 -3
  203. package/dist/cjs/api/resources/phoneNumbers/client/requests/RetrievePhoneNumberDetailsParams.d.ts +1 -4
  204. package/dist/cjs/api/resources/phoneNumbers/client/requests/RetrievePhoneNumberDetailsParams.js +6 -3
  205. package/dist/cjs/api/resources/phoneNumbers/client/requests/SearchPhoneNumberParams.d.ts +1 -4
  206. package/dist/cjs/api/resources/phoneNumbers/client/requests/SearchPhoneNumberParams.js +1 -3
  207. package/dist/cjs/api/resources/phoneNumbers/client/requests/index.d.ts +3 -3
  208. package/dist/cjs/api/resources/phoneNumbers/index.d.ts +1 -1
  209. package/dist/cjs/api/resources/phoneNumbers/index.js +1 -1
  210. package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/Client.d.ts +4 -25
  211. package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/Client.js +16 -14
  212. package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/index.d.ts +0 -1
  213. package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/requests/AttachCampaignParams.d.ts +1 -4
  214. package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/requests/AttachCampaignParams.js +1 -3
  215. package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/requests/DetachCampaignParams.d.ts +0 -3
  216. package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/requests/DetachCampaignParams.js +1 -3
  217. package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/requests/index.d.ts +2 -2
  218. package/dist/cjs/api/resources/phoneNumbers/resources/index.d.ts +2 -2
  219. package/dist/cjs/api/resources/phoneNumbers/resources/index.js +6 -6
  220. package/dist/cjs/api/resources/phoneNumbers/resources/webhook/client/Client.d.ts +4 -25
  221. package/dist/cjs/api/resources/phoneNumbers/resources/webhook/client/Client.js +18 -16
  222. package/dist/cjs/api/resources/phoneNumbers/types/PhoneNumbersGetResponse.d.ts +1 -4
  223. package/dist/cjs/api/resources/phoneNumbers/types/PhoneNumbersGetResponse.js +1 -3
  224. package/dist/cjs/api/resources/rcs/client/Client.d.ts +4 -25
  225. package/dist/cjs/api/resources/rcs/client/Client.js +22 -18
  226. package/dist/cjs/api/resources/rcs/client/index.d.ts +0 -1
  227. package/dist/cjs/api/resources/rcs/client/requests/RcsCapabilitiesQuery.d.ts +0 -3
  228. package/dist/cjs/api/resources/rcs/client/requests/RcsCapabilitiesQuery.js +1 -3
  229. package/dist/cjs/api/resources/rcs/client/requests/RcsLinkRequest.d.ts +0 -3
  230. package/dist/cjs/api/resources/rcs/client/requests/RcsLinkRequest.js +1 -3
  231. package/dist/cjs/api/resources/rcs/client/requests/RcsWhitelistRequest.d.ts +0 -3
  232. package/dist/cjs/api/resources/rcs/client/requests/RcsWhitelistRequest.js +1 -3
  233. package/dist/cjs/api/resources/rcs/client/requests/index.d.ts +3 -3
  234. package/dist/cjs/api/resources/status/client/Client.d.ts +2 -12
  235. package/dist/cjs/api/resources/status/client/Client.js +1 -3
  236. package/dist/cjs/api/resources/status/resources/get/client/Client.d.ts +4 -25
  237. package/dist/cjs/api/resources/status/resources/get/client/Client.js +39 -31
  238. package/dist/cjs/api/resources/tools/client/Client.d.ts +4 -14
  239. package/dist/cjs/api/resources/tools/client/Client.js +5 -7
  240. package/dist/cjs/api/resources/tools/resources/contactCard/client/Client.d.ts +4 -25
  241. package/dist/cjs/api/resources/tools/resources/contactCard/client/Client.js +16 -14
  242. package/dist/cjs/api/resources/tools/resources/contactCard/client/index.d.ts +0 -1
  243. package/dist/cjs/api/resources/tools/resources/contactCard/client/requests/GetVcardParams.d.ts +0 -3
  244. package/dist/cjs/api/resources/tools/resources/contactCard/client/requests/GetVcardParams.js +1 -3
  245. package/dist/cjs/api/resources/tools/resources/contactCard/client/requests/UpsertVcardParams.d.ts +1 -4
  246. package/dist/cjs/api/resources/tools/resources/contactCard/client/requests/UpsertVcardParams.js +1 -3
  247. package/dist/cjs/api/resources/tools/resources/contactCard/client/requests/index.d.ts +2 -2
  248. package/dist/cjs/api/resources/tools/resources/file/client/Client.d.ts +4 -25
  249. package/dist/cjs/api/resources/tools/resources/file/client/Client.js +16 -14
  250. package/dist/cjs/api/resources/tools/resources/file/client/index.d.ts +0 -1
  251. package/dist/cjs/api/resources/tools/resources/file/client/requests/RefreshFileParams.d.ts +0 -3
  252. package/dist/cjs/api/resources/tools/resources/file/client/requests/RefreshFileParams.js +1 -3
  253. package/dist/cjs/api/resources/tools/resources/file/client/requests/UploadFileParams.d.ts +0 -3
  254. package/dist/cjs/api/resources/tools/resources/file/client/requests/UploadFileParams.js +1 -3
  255. package/dist/cjs/api/resources/tools/resources/file/client/requests/index.d.ts +2 -2
  256. package/dist/cjs/api/resources/tools/resources/index.d.ts +4 -4
  257. package/dist/cjs/api/resources/tools/resources/index.js +8 -8
  258. package/dist/cjs/api/resources/tools/resources/url/client/Client.d.ts +4 -25
  259. package/dist/cjs/api/resources/tools/resources/url/client/Client.js +24 -20
  260. package/dist/cjs/api/resources/tools/resources/url/client/index.d.ts +0 -1
  261. package/dist/cjs/api/resources/tools/resources/url/client/requests/CreateUrlParams.d.ts +1 -4
  262. package/dist/cjs/api/resources/tools/resources/url/client/requests/CreateUrlParams.js +1 -3
  263. package/dist/cjs/api/resources/tools/resources/url/client/requests/UpdateUrlParams.d.ts +1 -4
  264. package/dist/cjs/api/resources/tools/resources/url/client/requests/UpdateUrlParams.js +1 -3
  265. package/dist/cjs/api/resources/tools/resources/url/client/requests/index.d.ts +2 -2
  266. package/dist/cjs/api/resources/webhooks/client/Client.d.ts +4 -25
  267. package/dist/cjs/api/resources/webhooks/client/Client.js +10 -10
  268. package/dist/cjs/api/resources/webhooks/client/index.d.ts +0 -1
  269. package/dist/cjs/api/resources/webhooks/client/requests/GetWebhookParams.d.ts +0 -3
  270. package/dist/cjs/api/resources/webhooks/client/requests/GetWebhookParams.js +1 -3
  271. package/dist/cjs/api/resources/webhooks/client/requests/index.d.ts +1 -1
  272. package/dist/cjs/api/types/AdvancedPhoneInformation.d.ts +2 -5
  273. package/dist/cjs/api/types/AdvancedPhoneInformation.js +7 -3
  274. package/dist/cjs/api/types/AttachWebhookParams.d.ts +1 -4
  275. package/dist/cjs/api/types/AttachWebhookParams.js +1 -3
  276. package/dist/cjs/api/types/AttachedPhoneNumberResult.d.ts +1 -4
  277. package/dist/cjs/api/types/AttachedPhoneNumberResult.js +1 -3
  278. package/dist/cjs/api/types/AudienceCountOnly.d.ts +0 -3
  279. package/dist/cjs/api/types/AudienceCountOnly.js +1 -3
  280. package/dist/cjs/api/types/AudienceWithPagination.d.ts +1 -4
  281. package/dist/cjs/api/types/AudienceWithPagination.js +1 -3
  282. package/dist/cjs/api/types/AutofillCampaignParams.d.ts +0 -3
  283. package/dist/cjs/api/types/AutofillCampaignParams.js +1 -3
  284. package/dist/cjs/api/types/AutofillDlcCampaignResponse.d.ts +1 -4
  285. package/dist/cjs/api/types/AutofillDlcCampaignResponse.js +1 -3
  286. package/dist/cjs/api/types/BadRequestErrorBody.d.ts +1 -4
  287. package/dist/cjs/api/types/BadRequestErrorBody.js +1 -3
  288. package/dist/cjs/api/types/BaseRichMessage.d.ts +9 -0
  289. package/dist/cjs/api/types/BaseRichMessage.js +3 -0
  290. package/dist/cjs/api/types/BasicPhoneInformation.d.ts +1 -4
  291. package/dist/cjs/api/types/BasicPhoneInformation.js +1 -3
  292. package/dist/cjs/api/types/BlastDetails.d.ts +17 -0
  293. package/dist/cjs/api/types/BlastDetails.js +3 -0
  294. package/dist/cjs/api/types/BrandStatus.d.ts +1 -4
  295. package/dist/cjs/api/types/BrandStatus.js +1 -3
  296. package/dist/cjs/api/types/BrandStatusEnum.d.ts +1 -4
  297. package/dist/cjs/api/types/BrandStatusEnum.js +10 -3
  298. package/dist/cjs/api/types/ButtonClicked.d.ts +1 -4
  299. package/dist/cjs/api/types/ButtonClicked.js +1 -3
  300. package/dist/cjs/api/types/ButtonClickedData.d.ts +2 -5
  301. package/dist/cjs/api/types/ButtonClickedData.js +7 -3
  302. package/dist/cjs/api/types/CampaignEnum.d.ts +1 -4
  303. package/dist/cjs/api/types/CampaignEnum.js +7 -3
  304. package/dist/cjs/api/types/CampaignQuery.d.ts +1 -4
  305. package/dist/cjs/api/types/CampaignQuery.js +1 -3
  306. package/dist/cjs/api/types/CampaignSubmissionResult.d.ts +0 -3
  307. package/dist/cjs/api/types/CampaignSubmissionResult.js +1 -3
  308. package/dist/cjs/api/types/CampaignValidationResult.d.ts +0 -3
  309. package/dist/cjs/api/types/CampaignValidationResult.js +1 -3
  310. package/dist/cjs/api/types/CompanyEntityTypeEnum.d.ts +9 -0
  311. package/dist/cjs/api/types/CompanyEntityTypeEnum.js +12 -0
  312. package/dist/cjs/api/types/CompanySectorEnum.d.ts +2 -7
  313. package/dist/cjs/api/types/CompanySectorEnum.js +2 -3
  314. package/dist/cjs/api/types/CompanyTypeEnum.d.ts +2 -7
  315. package/dist/cjs/api/types/CompanyTypeEnum.js +2 -3
  316. package/dist/cjs/api/types/ConfiguredWebhook.d.ts +1 -4
  317. package/dist/cjs/api/types/ConfiguredWebhook.js +1 -3
  318. package/dist/cjs/api/types/Contact.d.ts +0 -3
  319. package/dist/cjs/api/types/Contact.js +1 -3
  320. package/dist/cjs/api/types/ContactId.d.ts +0 -3
  321. package/dist/cjs/api/types/ContactId.js +1 -3
  322. package/dist/cjs/api/types/Conversation.d.ts +1 -4
  323. package/dist/cjs/api/types/Conversation.js +1 -3
  324. package/dist/cjs/api/types/ConversationList.d.ts +1 -4
  325. package/dist/cjs/api/types/ConversationList.js +1 -3
  326. package/dist/cjs/api/types/CreateUrlOptions.d.ts +0 -3
  327. package/dist/cjs/api/types/CreateUrlOptions.js +1 -3
  328. package/dist/cjs/api/types/DeleteAudienceResponse.d.ts +0 -3
  329. package/dist/cjs/api/types/DeleteAudienceResponse.js +1 -3
  330. package/dist/cjs/api/types/DetachedPhoneNumberResult.d.ts +1 -4
  331. package/dist/cjs/api/types/DetachedPhoneNumberResult.js +1 -3
  332. package/dist/cjs/api/types/DetachedWebhookInfo.d.ts +0 -3
  333. package/dist/cjs/api/types/DetachedWebhookInfo.js +1 -3
  334. package/dist/cjs/api/types/DetailedPhoneNumberEnum.d.ts +1 -4
  335. package/dist/cjs/api/types/DetailedPhoneNumberEnum.js +7 -3
  336. package/dist/cjs/api/types/DlcAssignmentStatusEnum.d.ts +1 -4
  337. package/dist/cjs/api/types/DlcAssignmentStatusEnum.js +10 -3
  338. package/dist/cjs/api/types/DlcCampaignStatus.d.ts +1 -4
  339. package/dist/cjs/api/types/DlcCampaignStatus.js +1 -3
  340. package/dist/cjs/api/types/DlcCampaignUseCaseEnum.d.ts +2 -7
  341. package/dist/cjs/api/types/DlcCampaignUseCaseEnum.js +2 -3
  342. package/dist/cjs/api/types/DlcCampaignWithExtendedBrandAndStatus.d.ts +43 -4
  343. package/dist/cjs/api/types/DlcCampaignWithExtendedBrandAndStatus.js +33 -3
  344. package/dist/cjs/api/types/EnhancedContact.d.ts +1 -4
  345. package/dist/cjs/api/types/EnhancedContact.js +1 -3
  346. package/dist/cjs/api/types/EnhancedContactItem.d.ts +0 -3
  347. package/dist/cjs/api/types/EnhancedContactItem.js +1 -3
  348. package/dist/cjs/api/types/Error_.d.ts +0 -3
  349. package/dist/cjs/api/types/Error_.js +1 -3
  350. package/dist/cjs/api/types/ExtendedBrand.d.ts +1 -4
  351. package/dist/cjs/api/types/ExtendedBrand.js +1 -3
  352. package/dist/cjs/api/types/ExtendedBrandWithVetting.d.ts +1 -4
  353. package/dist/cjs/api/types/ExtendedBrandWithVetting.js +1 -3
  354. package/dist/cjs/api/types/ExtendedRcsCampaign.d.ts +55 -30
  355. package/dist/cjs/api/types/ExtendedRcsCampaign.js +1 -3
  356. package/dist/cjs/api/types/GetConversationParams.d.ts +0 -3
  357. package/dist/cjs/api/types/GetConversationParams.js +1 -3
  358. package/dist/cjs/api/types/LinkClickEvent.d.ts +0 -3
  359. package/dist/cjs/api/types/LinkClickEvent.js +1 -3
  360. package/dist/cjs/api/types/LocationShareAction.d.ts +0 -3
  361. package/dist/cjs/api/types/LocationShareAction.js +1 -3
  362. package/dist/cjs/api/types/Message.d.ts +1 -4
  363. package/dist/cjs/api/types/Message.js +1 -3
  364. package/dist/cjs/api/types/MessageContent.d.ts +1 -4
  365. package/dist/cjs/api/types/MessageContent.js +1 -3
  366. package/dist/cjs/api/types/MessageEvent.d.ts +3 -8
  367. package/dist/cjs/api/types/MessageEvent.js +2 -3
  368. package/dist/cjs/api/types/MessageEventContent.d.ts +1 -4
  369. package/dist/cjs/api/types/MessageEventContent.js +1 -3
  370. package/dist/cjs/api/types/MessageEventMmsContent.d.ts +0 -3
  371. package/dist/cjs/api/types/MessageEventMmsContent.js +1 -3
  372. package/dist/cjs/api/types/MessageEventRcsButtonData.d.ts +1 -4
  373. package/dist/cjs/api/types/MessageEventRcsButtonData.js +1 -3
  374. package/dist/cjs/api/types/MessageEventRcsCardsContent.d.ts +1 -4
  375. package/dist/cjs/api/types/MessageEventRcsCardsContent.js +1 -3
  376. package/dist/cjs/api/types/MessageEventRcsLocationData.d.ts +1 -4
  377. package/dist/cjs/api/types/MessageEventRcsLocationData.js +1 -3
  378. package/dist/cjs/api/types/MessageEventRcsMediaContent.d.ts +1 -4
  379. package/dist/cjs/api/types/MessageEventRcsMediaContent.js +1 -3
  380. package/dist/cjs/api/types/MessageEventRcsTextContent.d.ts +1 -4
  381. package/dist/cjs/api/types/MessageEventRcsTextContent.js +1 -3
  382. package/dist/cjs/api/types/MessageEventSmsContent.d.ts +0 -3
  383. package/dist/cjs/api/types/MessageEventSmsContent.js +1 -3
  384. package/dist/cjs/api/types/MessageList.d.ts +1 -4
  385. package/dist/cjs/api/types/MessageList.js +1 -3
  386. package/dist/cjs/api/types/MessageMethodEnum.d.ts +2 -7
  387. package/dist/cjs/api/types/MessageMethodEnum.js +2 -3
  388. package/dist/cjs/api/types/MessageProtocolEnum.d.ts +2 -7
  389. package/dist/cjs/api/types/MessageProtocolEnum.js +2 -3
  390. package/dist/cjs/api/types/MessageSchedule.d.ts +28 -11
  391. package/dist/cjs/api/types/MessageSchedule.js +1 -3
  392. package/dist/cjs/api/types/MessageStatusEnum.d.ts +3 -7
  393. package/dist/cjs/api/types/MessageStatusEnum.js +3 -3
  394. package/dist/cjs/api/types/MessageVolumeEnum.d.ts +2 -7
  395. package/dist/cjs/api/types/MessageVolumeEnum.js +2 -3
  396. package/dist/cjs/api/types/MessageWithReaction.d.ts +3 -8
  397. package/dist/cjs/api/types/MessageWithReaction.js +2 -3
  398. package/dist/cjs/api/types/MessagingProfileEnum.d.ts +2 -7
  399. package/dist/cjs/api/types/MessagingProfileEnum.js +2 -3
  400. package/dist/cjs/api/types/MmsContent.d.ts +0 -3
  401. package/dist/cjs/api/types/MmsContent.js +1 -3
  402. package/dist/cjs/api/types/MmsValidationResult.d.ts +0 -3
  403. package/dist/cjs/api/types/MmsValidationResult.js +1 -3
  404. package/dist/cjs/api/types/NotFoundErrorBody.d.ts +0 -3
  405. package/dist/cjs/api/types/NotFoundErrorBody.js +1 -3
  406. package/dist/cjs/api/types/NumberFormat.d.ts +0 -3
  407. package/dist/cjs/api/types/NumberFormat.js +1 -3
  408. package/dist/cjs/api/types/OptInMethodEnum.d.ts +2 -7
  409. package/dist/cjs/api/types/OptInMethodEnum.js +2 -3
  410. package/dist/cjs/api/types/OptionalBrandInfo.d.ts +3 -4
  411. package/dist/cjs/api/types/OptionalBrandInfo.js +1 -3
  412. package/dist/cjs/api/types/OptionalContact.d.ts +0 -3
  413. package/dist/cjs/api/types/OptionalContact.js +1 -3
  414. package/dist/cjs/api/types/OptionalContacts.d.ts +0 -3
  415. package/dist/cjs/api/types/OptionalContacts.js +1 -3
  416. package/dist/cjs/api/types/Pagination.d.ts +0 -3
  417. package/dist/cjs/api/types/Pagination.js +1 -3
  418. package/dist/cjs/api/types/PhoneCapabilities.d.ts +0 -3
  419. package/dist/cjs/api/types/PhoneCapabilities.js +1 -3
  420. package/dist/cjs/api/types/PhoneEnum.d.ts +1 -4
  421. package/dist/cjs/api/types/PhoneEnum.js +6 -3
  422. package/dist/cjs/api/types/PhoneFeatureEnum.d.ts +1 -4
  423. package/dist/cjs/api/types/PhoneFeatureEnum.js +6 -3
  424. package/dist/cjs/api/types/PhoneNumberDetails.d.ts +1 -4
  425. package/dist/cjs/api/types/PhoneNumberDetails.js +1 -3
  426. package/dist/cjs/api/types/PhoneNumberEnum.d.ts +1 -4
  427. package/dist/cjs/api/types/PhoneNumberEnum.js +6 -3
  428. package/dist/cjs/api/types/PhoneNumberStatus.d.ts +1 -4
  429. package/dist/cjs/api/types/PhoneNumberStatus.js +1 -3
  430. package/dist/cjs/api/types/PhoneNumberStatusEnum.d.ts +1 -4
  431. package/dist/cjs/api/types/PhoneNumberStatusEnum.js +8 -3
  432. package/dist/cjs/api/types/ProfileStatusEnum.d.ts +1 -4
  433. package/dist/cjs/api/types/ProfileStatusEnum.js +12 -3
  434. package/dist/cjs/api/types/PurchasedNumber.d.ts +0 -3
  435. package/dist/cjs/api/types/PurchasedNumber.js +1 -3
  436. package/dist/cjs/api/types/RcsButtonCall.d.ts +0 -3
  437. package/dist/cjs/api/types/RcsButtonCall.js +1 -3
  438. package/dist/cjs/api/types/RcsButtonOpenUrl.d.ts +1 -4
  439. package/dist/cjs/api/types/RcsButtonOpenUrl.js +11 -3
  440. package/dist/cjs/api/types/RcsButtonRequestUserLocation.d.ts +0 -3
  441. package/dist/cjs/api/types/RcsButtonRequestUserLocation.js +1 -3
  442. package/dist/cjs/api/types/RcsButtonScheduleEvent.d.ts +0 -3
  443. package/dist/cjs/api/types/RcsButtonScheduleEvent.js +1 -3
  444. package/dist/cjs/api/types/RcsButtonSendLocation.d.ts +0 -3
  445. package/dist/cjs/api/types/RcsButtonSendLocation.js +1 -3
  446. package/dist/cjs/api/types/RcsButtonTrigger.d.ts +0 -3
  447. package/dist/cjs/api/types/RcsButtonTrigger.js +1 -3
  448. package/dist/cjs/api/types/RcsCampaign.d.ts +55 -28
  449. package/dist/cjs/api/types/RcsCampaign.js +1 -3
  450. package/dist/cjs/api/types/RcsCampaignStatus.d.ts +1 -4
  451. package/dist/cjs/api/types/RcsCampaignStatus.js +1 -3
  452. package/dist/cjs/api/types/RcsCampaignUseCaseEnum.d.ts +2 -7
  453. package/dist/cjs/api/types/RcsCampaignUseCaseEnum.js +2 -3
  454. package/dist/cjs/api/types/RcsCapabilitiesResult.d.ts +1 -4
  455. package/dist/cjs/api/types/RcsCapabilitiesResult.js +1 -3
  456. package/dist/cjs/api/types/RcsCapability.d.ts +0 -3
  457. package/dist/cjs/api/types/RcsCapability.js +1 -3
  458. package/dist/cjs/api/types/RcsCardsContent.d.ts +2 -5
  459. package/dist/cjs/api/types/RcsCardsContent.js +1 -3
  460. package/dist/cjs/api/types/RcsContent.d.ts +2 -5
  461. package/dist/cjs/api/types/RcsContent.js +1 -3
  462. package/dist/cjs/api/types/RcsLinkResult.d.ts +0 -3
  463. package/dist/cjs/api/types/RcsLinkResult.js +1 -3
  464. package/dist/cjs/api/types/RcsMediaContent.d.ts +1 -4
  465. package/dist/cjs/api/types/RcsMediaContent.js +1 -3
  466. package/dist/cjs/api/types/RcsMediaDetailsContent.d.ts +0 -3
  467. package/dist/cjs/api/types/RcsMediaDetailsContent.js +1 -3
  468. package/dist/cjs/api/types/RcsMessagingTypeEnum.d.ts +15 -0
  469. package/dist/cjs/api/types/RcsMessagingTypeEnum.js +18 -0
  470. package/dist/cjs/api/types/RcsValidateContent.d.ts +3 -6
  471. package/dist/cjs/api/types/RcsValidateContent.js +1 -3
  472. package/dist/cjs/api/types/RcsValidationResult.d.ts +2 -3
  473. package/dist/cjs/api/types/RcsValidationResult.js +1 -3
  474. package/dist/cjs/api/types/RcsWhitelistResponse.d.ts +0 -3
  475. package/dist/cjs/api/types/RcsWhitelistResponse.js +1 -3
  476. package/dist/cjs/api/types/ReactionResult.d.ts +0 -3
  477. package/dist/cjs/api/types/ReactionResult.js +1 -3
  478. package/dist/cjs/api/types/RefreshedFile.d.ts +0 -3
  479. package/dist/cjs/api/types/RefreshedFile.js +1 -3
  480. package/dist/cjs/api/types/RichButton.d.ts +1 -4
  481. package/dist/cjs/api/types/RichButton.js +1 -3
  482. package/dist/cjs/api/types/{RcsCards.d.ts → RichCards.d.ts} +5 -8
  483. package/dist/cjs/api/types/RichCards.js +3 -0
  484. package/dist/cjs/api/types/RichCardsMessage.d.ts +11 -16
  485. package/dist/cjs/api/types/RichCardsMessage.js +3 -3
  486. package/dist/cjs/api/types/RichMediaMessage.d.ts +2 -5
  487. package/dist/cjs/api/types/RichMediaMessage.js +1 -3
  488. package/dist/cjs/api/types/RichMessage.d.ts +5 -5
  489. package/dist/cjs/api/types/RichMessage.js +1 -3
  490. package/dist/cjs/api/types/{RcsTextContent.d.ts → RichText.d.ts} +2 -5
  491. package/dist/cjs/api/types/RichText.js +3 -0
  492. package/dist/cjs/api/types/RichTextMessage.d.ts +2 -5
  493. package/dist/cjs/api/types/RichTextMessage.js +1 -3
  494. package/dist/cjs/api/types/ScheduleCancelResult.d.ts +7 -0
  495. package/dist/cjs/api/types/ScheduleCancelResult.js +3 -0
  496. package/dist/cjs/api/types/ScheduledBlastDetails.d.ts +24 -0
  497. package/dist/cjs/api/types/ScheduledBlastDetails.js +3 -0
  498. package/dist/{esm/api/types/ScheduledMessaage.d.mts → cjs/api/types/ScheduledMessage.d.ts} +3 -6
  499. package/dist/cjs/api/types/ScheduledMessage.js +3 -0
  500. package/dist/cjs/api/types/{Options.d.ts → SendRichMessageOptions.d.ts} +2 -5
  501. package/dist/cjs/api/types/SendRichMessageOptions.js +3 -0
  502. package/dist/cjs/api/types/SendTypingIndicatorResponse.d.ts +0 -3
  503. package/dist/cjs/api/types/SendTypingIndicatorResponse.js +1 -3
  504. package/dist/cjs/api/types/Sender.d.ts +0 -3
  505. package/dist/cjs/api/types/Sender.js +1 -3
  506. package/dist/cjs/api/types/SentMmsDetails.d.ts +0 -3
  507. package/dist/cjs/api/types/SentMmsDetails.js +1 -3
  508. package/dist/{esm/api/types/SentRcsDetails.d.mts → cjs/api/types/SentRichMessage.d.ts} +1 -4
  509. package/dist/cjs/api/types/SentRichMessage.js +3 -0
  510. package/dist/cjs/api/types/SentSmsDetails.d.ts +2 -7
  511. package/dist/cjs/api/types/SentSmsDetails.js +2 -3
  512. package/dist/cjs/api/types/ShortenedUrl.d.ts +0 -3
  513. package/dist/cjs/api/types/ShortenedUrl.js +1 -3
  514. package/dist/cjs/api/types/ShortenedUrlWithClickData.d.ts +1 -4
  515. package/dist/cjs/api/types/ShortenedUrlWithClickData.js +1 -3
  516. package/dist/cjs/api/types/SmsContent.d.ts +0 -3
  517. package/dist/cjs/api/types/SmsContent.js +1 -3
  518. package/dist/cjs/api/types/SmsValidationResult.d.ts +0 -3
  519. package/dist/cjs/api/types/SmsValidationResult.js +1 -3
  520. package/dist/cjs/api/types/SubUseCaseEnum.d.ts +2 -7
  521. package/dist/cjs/api/types/SubUseCaseEnum.js +2 -3
  522. package/dist/cjs/api/types/SubmissionResults.d.ts +0 -3
  523. package/dist/cjs/api/types/SubmissionResults.js +1 -3
  524. package/dist/cjs/api/types/SuccessfulConversationUpdate.d.ts +0 -3
  525. package/dist/cjs/api/types/SuccessfulConversationUpdate.js +1 -3
  526. package/dist/cjs/api/types/TollFreeCampaign.d.ts +50 -4
  527. package/dist/cjs/api/types/TollFreeCampaign.js +1 -3
  528. package/dist/cjs/api/types/TollFreeCampaignStatus.d.ts +1 -4
  529. package/dist/cjs/api/types/TollFreeCampaignStatus.js +1 -3
  530. package/dist/cjs/api/types/TollFreeCampaignUseCaseEnum.d.ts +2 -7
  531. package/dist/cjs/api/types/TollFreeCampaignUseCaseEnum.js +2 -3
  532. package/dist/cjs/api/types/TollFreeCampaignWithExtendedBrandAndStatus.d.ts +1 -4
  533. package/dist/cjs/api/types/TollFreeCampaignWithExtendedBrandAndStatus.js +1 -3
  534. package/dist/cjs/api/types/TollFreeStatusEnum.d.ts +1 -4
  535. package/dist/cjs/api/types/TollFreeStatusEnum.js +10 -3
  536. package/dist/cjs/api/types/Tracking.d.ts +1 -4
  537. package/dist/cjs/api/types/Tracking.js +8 -3
  538. package/dist/cjs/api/types/UpdatedContactId.d.ts +0 -3
  539. package/dist/cjs/api/types/UpdatedContactId.js +1 -3
  540. package/dist/cjs/api/types/UploadResults.d.ts +0 -3
  541. package/dist/cjs/api/types/UploadResults.js +1 -3
  542. package/dist/cjs/api/types/UpsertContact.d.ts +0 -3
  543. package/dist/cjs/api/types/UpsertContact.js +1 -3
  544. package/dist/cjs/api/types/UserEvent.d.ts +0 -3
  545. package/dist/cjs/api/types/UserEvent.js +1 -3
  546. package/dist/cjs/api/types/VCardData.d.ts +1 -4
  547. package/dist/cjs/api/types/VCardData.js +1 -3
  548. package/dist/cjs/api/types/ValidateCampaignParams.d.ts +0 -3
  549. package/dist/cjs/api/types/ValidateCampaignParams.js +1 -3
  550. package/dist/cjs/api/types/ValidationErrorDetails.d.ts +0 -3
  551. package/dist/cjs/api/types/ValidationErrorDetails.js +1 -3
  552. package/dist/cjs/api/types/ValidationResults.d.ts +1 -4
  553. package/dist/cjs/api/types/ValidationResults.js +1 -3
  554. package/dist/cjs/api/types/Vcard.d.ts +1 -4
  555. package/dist/cjs/api/types/Vcard.js +1 -3
  556. package/dist/cjs/api/types/VcardAddress.d.ts +1 -4
  557. package/dist/cjs/api/types/VcardAddress.js +1 -3
  558. package/dist/cjs/api/types/VcardContent.d.ts +1 -4
  559. package/dist/cjs/api/types/VcardContent.js +1 -3
  560. package/dist/cjs/api/types/VcardEmail.d.ts +1 -4
  561. package/dist/cjs/api/types/VcardEmail.js +1 -3
  562. package/dist/cjs/api/types/VcardPhone.d.ts +1 -4
  563. package/dist/cjs/api/types/VcardPhone.js +1 -3
  564. package/dist/cjs/api/types/VcardResource.d.ts +0 -3
  565. package/dist/cjs/api/types/VcardResource.js +1 -3
  566. package/dist/cjs/api/types/VettingFeedback.d.ts +0 -3
  567. package/dist/cjs/api/types/VettingFeedback.js +1 -3
  568. package/dist/cjs/api/types/VettingHistory.d.ts +2 -7
  569. package/dist/cjs/api/types/VettingHistory.js +2 -3
  570. package/dist/cjs/api/types/VettingResults.d.ts +0 -3
  571. package/dist/cjs/api/types/VettingResults.js +1 -3
  572. package/dist/cjs/api/types/WebhookEventEnum.d.ts +1 -4
  573. package/dist/cjs/api/types/WebhookEventEnum.js +6 -3
  574. package/dist/cjs/api/types/WebhookResult.d.ts +1 -4
  575. package/dist/cjs/api/types/WebhookResult.js +1 -3
  576. package/dist/cjs/api/types/Webhooks.d.ts +0 -3
  577. package/dist/cjs/api/types/Webhooks.js +1 -3
  578. package/dist/cjs/api/types/ZodError.d.ts +0 -3
  579. package/dist/cjs/api/types/ZodError.js +1 -3
  580. package/dist/cjs/api/types/index.d.ts +127 -123
  581. package/dist/cjs/api/types/index.js +127 -123
  582. package/dist/cjs/core/exports.d.ts +1 -0
  583. package/dist/cjs/core/exports.js +17 -0
  584. package/dist/cjs/core/fetcher/APIResponse.d.ts +1 -1
  585. package/dist/cjs/core/fetcher/BinaryResponse.d.ts +1 -1
  586. package/dist/cjs/core/fetcher/EndpointMetadata.d.ts +13 -0
  587. package/dist/cjs/core/fetcher/EndpointMetadata.js +2 -0
  588. package/dist/cjs/core/fetcher/EndpointSupplier.d.ts +12 -0
  589. package/dist/cjs/core/fetcher/EndpointSupplier.js +22 -0
  590. package/dist/cjs/core/fetcher/Fetcher.d.ts +9 -4
  591. package/dist/cjs/core/fetcher/Fetcher.js +205 -10
  592. package/dist/cjs/core/fetcher/HttpResponsePromise.d.ts +1 -1
  593. package/dist/cjs/core/fetcher/getErrorResponseBody.js +2 -1
  594. package/dist/cjs/core/fetcher/getRequestBody.d.ts +1 -1
  595. package/dist/cjs/core/fetcher/getRequestBody.js +4 -0
  596. package/dist/cjs/core/fetcher/getResponseBody.js +3 -3
  597. package/dist/cjs/core/fetcher/index.d.ts +2 -0
  598. package/dist/cjs/core/fetcher/index.js +3 -1
  599. package/dist/cjs/core/fetcher/makeRequest.d.ts +1 -1
  600. package/dist/cjs/core/fetcher/makeRequest.js +2 -4
  601. package/dist/cjs/core/fetcher/requestWithRetries.js +16 -21
  602. package/dist/cjs/core/fetcher/signals.d.ts +0 -6
  603. package/dist/cjs/core/fetcher/signals.js +0 -12
  604. package/dist/cjs/core/headers.d.ts +2 -3
  605. package/dist/cjs/core/headers.js +6 -4
  606. package/dist/cjs/core/index.d.ts +1 -0
  607. package/dist/cjs/core/index.js +2 -1
  608. package/dist/cjs/core/logging/exports.d.ts +18 -0
  609. package/dist/cjs/core/logging/exports.js +45 -0
  610. package/dist/cjs/core/logging/index.d.ts +1 -0
  611. package/dist/cjs/core/logging/index.js +17 -0
  612. package/dist/cjs/core/logging/logger.d.ts +126 -0
  613. package/dist/cjs/core/logging/logger.js +144 -0
  614. package/dist/cjs/core/url/encodePathParam.d.ts +1 -0
  615. package/dist/cjs/core/url/encodePathParam.js +21 -0
  616. package/dist/cjs/core/url/index.d.ts +1 -0
  617. package/dist/cjs/core/url/index.js +3 -1
  618. package/dist/cjs/core/url/join.js +3 -4
  619. package/dist/cjs/environments.d.ts +0 -3
  620. package/dist/cjs/environments.js +1 -3
  621. package/dist/cjs/errors/PinnacleError.d.ts +1 -4
  622. package/dist/cjs/errors/PinnacleError.js +2 -4
  623. package/dist/cjs/errors/PinnacleTimeoutError.d.ts +0 -3
  624. package/dist/cjs/errors/PinnacleTimeoutError.js +1 -3
  625. package/dist/cjs/exports.d.ts +1 -0
  626. package/dist/cjs/exports.js +17 -0
  627. package/dist/cjs/version.d.ts +1 -1
  628. package/dist/cjs/version.js +1 -1
  629. package/dist/cjs/wrapper/tools/FileUploader.d.ts +1 -1
  630. package/dist/esm/BaseClient.d.mts +30 -0
  631. package/dist/esm/BaseClient.mjs +2 -0
  632. package/dist/esm/Client.d.mts +6 -26
  633. package/dist/esm/Client.mjs +9 -11
  634. package/dist/esm/api/errors/BadRequestError.d.mts +1 -4
  635. package/dist/esm/api/errors/BadRequestError.mjs +1 -3
  636. package/dist/esm/api/errors/InternalServerError.d.mts +2 -5
  637. package/dist/esm/api/errors/InternalServerError.mjs +1 -3
  638. package/dist/esm/api/errors/NotFoundError.d.mts +1 -4
  639. package/dist/esm/api/errors/NotFoundError.mjs +1 -3
  640. package/dist/esm/api/errors/NotImplementedError.d.mts +2 -5
  641. package/dist/esm/api/errors/NotImplementedError.mjs +1 -3
  642. package/dist/esm/api/errors/PaymentRequiredError.d.mts +2 -5
  643. package/dist/esm/api/errors/PaymentRequiredError.mjs +1 -3
  644. package/dist/esm/api/errors/UnauthorizedError.d.mts +2 -5
  645. package/dist/esm/api/errors/UnauthorizedError.mjs +1 -3
  646. package/dist/esm/api/errors/index.d.mts +2 -2
  647. package/dist/esm/api/errors/index.mjs +2 -2
  648. package/dist/esm/api/index.d.mts +1 -1
  649. package/dist/esm/api/index.mjs +1 -1
  650. package/dist/esm/api/resources/audiences/client/Client.d.mts +4 -25
  651. package/dist/esm/api/resources/audiences/client/Client.mjs +32 -26
  652. package/dist/esm/api/resources/audiences/client/index.d.mts +0 -1
  653. package/dist/esm/api/resources/audiences/client/requests/AudiencesDeleteRequest.d.mts +0 -3
  654. package/dist/esm/api/resources/audiences/client/requests/AudiencesDeleteRequest.mjs +1 -3
  655. package/dist/esm/api/resources/audiences/client/requests/AudiencesGetRequest.d.mts +0 -3
  656. package/dist/esm/api/resources/audiences/client/requests/AudiencesGetRequest.mjs +1 -3
  657. package/dist/esm/api/resources/audiences/client/requests/CreateAudienceParams.d.mts +0 -3
  658. package/dist/esm/api/resources/audiences/client/requests/CreateAudienceParams.mjs +1 -3
  659. package/dist/esm/api/resources/audiences/client/requests/UpdateAudienceParams.d.mts +0 -3
  660. package/dist/esm/api/resources/audiences/client/requests/UpdateAudienceParams.mjs +1 -3
  661. package/dist/esm/api/resources/audiences/client/requests/index.d.mts +4 -4
  662. package/dist/esm/api/resources/audiences/index.d.mts +1 -1
  663. package/dist/esm/api/resources/audiences/index.mjs +1 -1
  664. package/dist/esm/api/resources/audiences/resources/contacts/client/Client.d.mts +4 -25
  665. package/dist/esm/api/resources/audiences/resources/contacts/client/Client.mjs +16 -14
  666. package/dist/esm/api/resources/audiences/resources/contacts/client/index.d.mts +0 -1
  667. package/dist/esm/api/resources/audiences/resources/contacts/client/requests/AddContactsParams.d.mts +0 -3
  668. package/dist/esm/api/resources/audiences/resources/contacts/client/requests/AddContactsParams.mjs +1 -3
  669. package/dist/esm/api/resources/audiences/resources/contacts/client/requests/RemoveContactsParams.d.mts +0 -3
  670. package/dist/esm/api/resources/audiences/resources/contacts/client/requests/RemoveContactsParams.mjs +1 -3
  671. package/dist/esm/api/resources/audiences/resources/contacts/client/requests/index.d.mts +2 -2
  672. package/dist/esm/api/resources/audiences/resources/index.d.mts +1 -1
  673. package/dist/esm/api/resources/audiences/resources/index.mjs +1 -1
  674. package/dist/esm/api/resources/audiences/types/AudiencesGetResponse.d.mts +1 -4
  675. package/dist/esm/api/resources/audiences/types/AudiencesGetResponse.mjs +1 -3
  676. package/dist/esm/api/resources/brands/client/Client.d.mts +6 -25
  677. package/dist/esm/api/resources/brands/client/Client.mjs +46 -34
  678. package/dist/esm/api/resources/brands/client/index.d.mts +0 -1
  679. package/dist/esm/api/resources/brands/client/requests/AutofillBrandParams.d.mts +0 -3
  680. package/dist/esm/api/resources/brands/client/requests/AutofillBrandParams.mjs +1 -3
  681. package/dist/esm/api/resources/brands/client/requests/BrandsGetRequest.d.mts +0 -3
  682. package/dist/esm/api/resources/brands/client/requests/BrandsGetRequest.mjs +1 -3
  683. package/dist/esm/api/resources/brands/client/requests/UpsertBrandParams.d.mts +4 -4
  684. package/dist/esm/api/resources/brands/client/requests/UpsertBrandParams.mjs +1 -3
  685. package/dist/esm/api/resources/brands/client/requests/ValidateBrandParams.d.mts +4 -4
  686. package/dist/esm/api/resources/brands/client/requests/ValidateBrandParams.mjs +1 -3
  687. package/dist/esm/api/resources/brands/client/requests/VetBrandParams.d.mts +1 -5
  688. package/dist/esm/api/resources/brands/client/requests/VetBrandParams.mjs +1 -3
  689. package/dist/esm/api/resources/brands/client/requests/index.d.mts +5 -5
  690. package/dist/esm/api/resources/campaigns/client/Client.d.mts +3 -13
  691. package/dist/esm/api/resources/campaigns/client/Client.mjs +2 -4
  692. package/dist/esm/api/resources/campaigns/index.d.mts +1 -1
  693. package/dist/esm/api/resources/campaigns/index.mjs +1 -1
  694. package/dist/esm/api/resources/campaigns/resources/dlc/client/Client.d.mts +4 -25
  695. package/dist/esm/api/resources/campaigns/resources/dlc/client/Client.mjs +36 -28
  696. package/dist/esm/api/resources/campaigns/resources/dlc/client/index.d.mts +0 -1
  697. package/dist/esm/api/resources/campaigns/resources/dlc/client/requests/UpsertDlcCampaignParams.d.mts +1 -4
  698. package/dist/esm/api/resources/campaigns/resources/dlc/client/requests/UpsertDlcCampaignParams.mjs +1 -3
  699. package/dist/esm/api/resources/campaigns/resources/dlc/client/requests/index.d.mts +1 -1
  700. package/dist/esm/api/resources/campaigns/resources/index.d.mts +5 -5
  701. package/dist/esm/api/resources/campaigns/resources/index.mjs +5 -5
  702. package/dist/esm/api/resources/campaigns/resources/rcs/client/Client.d.mts +36 -40
  703. package/dist/esm/api/resources/campaigns/resources/rcs/client/Client.mjs +68 -43
  704. package/dist/esm/api/resources/campaigns/resources/rcs/client/index.d.mts +0 -1
  705. package/dist/esm/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.mts +112 -49
  706. package/dist/esm/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.mjs +1 -3
  707. package/dist/esm/api/resources/campaigns/resources/rcs/client/requests/index.d.mts +1 -1
  708. package/dist/esm/api/resources/campaigns/resources/rcs/index.d.mts +1 -1
  709. package/dist/esm/api/resources/campaigns/resources/rcs/index.mjs +1 -1
  710. package/dist/esm/api/resources/campaigns/resources/rcs/types/RcsAutofillResponse.d.mts +1 -4
  711. package/dist/esm/api/resources/campaigns/resources/rcs/types/RcsAutofillResponse.mjs +1 -3
  712. package/dist/esm/api/resources/campaigns/resources/tollFree/client/Client.d.mts +20 -25
  713. package/dist/esm/api/resources/campaigns/resources/tollFree/client/Client.mjs +52 -28
  714. package/dist/esm/api/resources/campaigns/resources/tollFree/client/index.d.mts +0 -1
  715. package/dist/esm/api/resources/campaigns/resources/tollFree/client/requests/UpsertTollFreeCampaignParams.d.mts +66 -4
  716. package/dist/esm/api/resources/campaigns/resources/tollFree/client/requests/UpsertTollFreeCampaignParams.mjs +1 -3
  717. package/dist/esm/api/resources/campaigns/resources/tollFree/client/requests/index.d.mts +1 -1
  718. package/dist/esm/api/resources/campaigns/resources/tollFree/index.d.mts +1 -1
  719. package/dist/esm/api/resources/campaigns/resources/tollFree/index.mjs +1 -1
  720. package/dist/esm/api/resources/campaigns/resources/tollFree/types/TollFreeAutofillResponse.d.mts +1 -4
  721. package/dist/esm/api/resources/campaigns/resources/tollFree/types/TollFreeAutofillResponse.mjs +1 -3
  722. package/dist/esm/api/resources/contacts/client/Client.d.mts +4 -25
  723. package/dist/esm/api/resources/contacts/client/Client.mjs +24 -20
  724. package/dist/esm/api/resources/contacts/client/index.d.mts +0 -1
  725. package/dist/esm/api/resources/contacts/client/requests/ContactsGetRequest.d.mts +0 -3
  726. package/dist/esm/api/resources/contacts/client/requests/ContactsGetRequest.mjs +1 -3
  727. package/dist/esm/api/resources/contacts/client/requests/CreateContactParams.d.mts +1 -4
  728. package/dist/esm/api/resources/contacts/client/requests/CreateContactParams.mjs +1 -3
  729. package/dist/esm/api/resources/contacts/client/requests/UpdateContactParams.d.mts +1 -4
  730. package/dist/esm/api/resources/contacts/client/requests/UpdateContactParams.mjs +1 -3
  731. package/dist/esm/api/resources/contacts/client/requests/index.d.mts +3 -3
  732. package/dist/esm/api/resources/conversations/client/Client.d.mts +4 -25
  733. package/dist/esm/api/resources/conversations/client/Client.mjs +37 -31
  734. package/dist/esm/api/resources/conversations/client/index.d.mts +0 -1
  735. package/dist/esm/api/resources/conversations/client/requests/ConversationsListMessagesRequest.d.mts +1 -4
  736. package/dist/esm/api/resources/conversations/client/requests/ConversationsListMessagesRequest.mjs +1 -3
  737. package/dist/esm/api/resources/conversations/client/requests/ListConversationsParams.d.mts +1 -4
  738. package/dist/esm/api/resources/conversations/client/requests/ListConversationsParams.mjs +1 -3
  739. package/dist/esm/api/resources/conversations/client/requests/UpdateConversationParams.d.mts +0 -3
  740. package/dist/esm/api/resources/conversations/client/requests/UpdateConversationParams.mjs +1 -3
  741. package/dist/esm/api/resources/conversations/client/requests/index.d.mts +3 -3
  742. package/dist/esm/api/resources/conversations/index.d.mts +1 -1
  743. package/dist/esm/api/resources/conversations/index.mjs +1 -1
  744. package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestDirection.d.mts +1 -4
  745. package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestDirection.mjs +1 -3
  746. package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestSortOrder.d.mts +1 -4
  747. package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestSortOrder.mjs +1 -3
  748. package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestStatus.d.mts +1 -4
  749. package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestStatus.mjs +1 -3
  750. package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestType.d.mts +1 -4
  751. package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestType.mjs +1 -3
  752. package/dist/esm/api/resources/conversations/types/index.d.mts +1 -1
  753. package/dist/esm/api/resources/conversations/types/index.mjs +1 -1
  754. package/dist/esm/api/resources/index.d.mts +12 -12
  755. package/dist/esm/api/resources/index.mjs +12 -12
  756. package/dist/esm/api/resources/messages/client/Client.d.mts +11 -26
  757. package/dist/esm/api/resources/messages/client/Client.mjs +28 -16
  758. package/dist/esm/api/resources/messages/client/index.d.mts +0 -1
  759. package/dist/esm/api/resources/messages/client/requests/ReactMessageParams.d.mts +0 -3
  760. package/dist/esm/api/resources/messages/client/requests/ReactMessageParams.mjs +1 -3
  761. package/dist/esm/api/resources/messages/client/requests/index.d.mts +1 -1
  762. package/dist/esm/api/resources/messages/index.d.mts +1 -1
  763. package/dist/esm/api/resources/messages/index.mjs +1 -1
  764. package/dist/esm/api/resources/messages/resources/blast/client/Client.d.mts +105 -0
  765. package/dist/esm/api/resources/messages/resources/blast/client/Client.mjs +288 -0
  766. package/dist/esm/api/resources/messages/resources/blast/client/index.d.mts +1 -0
  767. package/dist/esm/api/resources/messages/resources/blast/client/index.mjs +1 -0
  768. package/dist/esm/api/resources/messages/resources/blast/client/requests/BlastMms.d.mts +61 -0
  769. package/dist/esm/api/resources/messages/resources/blast/client/requests/BlastMms.mjs +2 -0
  770. package/dist/esm/api/resources/messages/resources/blast/client/requests/BlastRcs.d.mts +110 -0
  771. package/dist/esm/api/resources/messages/resources/blast/client/requests/BlastRcs.mjs +20 -0
  772. package/dist/esm/api/resources/messages/resources/blast/client/requests/BlastSms.d.mts +47 -0
  773. package/dist/esm/api/resources/messages/resources/blast/client/requests/BlastSms.mjs +2 -0
  774. package/dist/esm/api/resources/messages/resources/blast/client/requests/index.d.mts +3 -0
  775. package/dist/esm/api/resources/messages/resources/blast/client/requests/index.mjs +1 -0
  776. package/dist/esm/api/resources/messages/resources/blast/index.d.mts +2 -0
  777. package/dist/esm/api/resources/messages/resources/blast/index.mjs +2 -0
  778. package/dist/esm/api/resources/messages/resources/blast/types/BlastMmsResponse.d.mts +2 -0
  779. package/dist/esm/api/resources/messages/resources/blast/types/BlastMmsResponse.mjs +2 -0
  780. package/dist/esm/api/resources/messages/resources/blast/types/BlastRcsResponse.d.mts +2 -0
  781. package/dist/esm/api/resources/messages/resources/blast/types/BlastRcsResponse.mjs +2 -0
  782. package/dist/esm/api/resources/messages/resources/blast/types/BlastSmsResponse.d.mts +2 -0
  783. package/dist/esm/api/resources/messages/resources/blast/types/BlastSmsResponse.mjs +2 -0
  784. package/dist/esm/api/resources/messages/resources/blast/types/index.d.mts +3 -0
  785. package/dist/esm/api/resources/messages/resources/blast/types/index.mjs +3 -0
  786. package/dist/esm/api/resources/messages/resources/index.d.mts +8 -4
  787. package/dist/esm/api/resources/messages/resources/index.mjs +8 -4
  788. package/dist/esm/api/resources/messages/resources/mms/client/Client.d.mts +4 -25
  789. package/dist/esm/api/resources/messages/resources/mms/client/Client.mjs +16 -14
  790. package/dist/esm/api/resources/messages/resources/mms/client/index.d.mts +0 -1
  791. package/dist/esm/api/resources/messages/resources/mms/client/requests/Mms.d.mts +1 -4
  792. package/dist/esm/api/resources/messages/resources/mms/client/requests/Mms.mjs +1 -3
  793. package/dist/esm/api/resources/messages/resources/mms/client/requests/index.d.mts +1 -1
  794. package/dist/esm/api/resources/messages/resources/mms/index.d.mts +1 -1
  795. package/dist/esm/api/resources/messages/resources/mms/index.mjs +1 -1
  796. package/dist/esm/api/resources/messages/resources/mms/types/MmsSendResponse.d.mts +2 -5
  797. package/dist/esm/api/resources/messages/resources/mms/types/MmsSendResponse.mjs +1 -3
  798. package/dist/esm/api/resources/messages/resources/rcs/client/Client.d.mts +5 -26
  799. package/dist/esm/api/resources/messages/resources/rcs/client/Client.mjs +26 -19
  800. package/dist/esm/api/resources/messages/resources/rcs/client/index.d.mts +0 -1
  801. package/dist/esm/api/resources/messages/resources/rcs/client/requests/SendTypingIndicatorSchema.d.mts +0 -3
  802. package/dist/esm/api/resources/messages/resources/rcs/client/requests/SendTypingIndicatorSchema.mjs +1 -3
  803. package/dist/esm/api/resources/messages/resources/rcs/client/requests/index.d.mts +1 -1
  804. package/dist/esm/api/resources/messages/resources/rcs/index.d.mts +1 -1
  805. package/dist/esm/api/resources/messages/resources/rcs/index.mjs +1 -1
  806. package/dist/esm/api/resources/messages/resources/rcs/types/SendRichMessageResponse.d.mts +2 -0
  807. package/dist/esm/api/resources/messages/resources/rcs/types/SendRichMessageResponse.mjs +2 -0
  808. package/dist/esm/api/resources/messages/resources/rcs/types/index.d.mts +1 -1
  809. package/dist/esm/api/resources/messages/resources/rcs/types/index.mjs +1 -1
  810. package/dist/esm/api/resources/messages/resources/schedule/client/Client.d.mts +32 -0
  811. package/dist/esm/api/resources/messages/resources/schedule/client/Client.mjs +98 -0
  812. package/dist/esm/api/resources/messages/resources/schedule/client/index.d.mts +1 -0
  813. package/dist/esm/api/resources/messages/resources/schedule/client/index.mjs +1 -0
  814. package/dist/esm/api/resources/messages/resources/schedule/index.d.mts +1 -0
  815. package/dist/esm/api/resources/messages/resources/schedule/index.mjs +1 -0
  816. package/dist/esm/api/resources/messages/resources/sms/client/Client.d.mts +4 -25
  817. package/dist/esm/api/resources/messages/resources/sms/client/Client.mjs +16 -14
  818. package/dist/esm/api/resources/messages/resources/sms/client/index.d.mts +0 -1
  819. package/dist/esm/api/resources/messages/resources/sms/client/requests/Sms.d.mts +1 -4
  820. package/dist/esm/api/resources/messages/resources/sms/client/requests/Sms.mjs +1 -3
  821. package/dist/esm/api/resources/messages/resources/sms/client/requests/index.d.mts +1 -1
  822. package/dist/esm/api/resources/messages/resources/sms/index.d.mts +1 -1
  823. package/dist/esm/api/resources/messages/resources/sms/index.mjs +1 -1
  824. package/dist/esm/api/resources/messages/resources/sms/types/SmsSendResponse.d.mts +2 -5
  825. package/dist/esm/api/resources/messages/resources/sms/types/SmsSendResponse.mjs +1 -3
  826. package/dist/esm/api/resources/phoneNumbers/client/Client.d.mts +5 -26
  827. package/dist/esm/api/resources/phoneNumbers/client/Client.mjs +23 -19
  828. package/dist/esm/api/resources/phoneNumbers/client/index.d.mts +0 -1
  829. package/dist/esm/api/resources/phoneNumbers/client/requests/BuyPhoneNumberParams.d.mts +0 -3
  830. package/dist/esm/api/resources/phoneNumbers/client/requests/BuyPhoneNumberParams.mjs +1 -3
  831. package/dist/esm/api/resources/phoneNumbers/client/requests/RetrievePhoneNumberDetailsParams.d.mts +1 -4
  832. package/dist/esm/api/resources/phoneNumbers/client/requests/RetrievePhoneNumberDetailsParams.mjs +6 -3
  833. package/dist/esm/api/resources/phoneNumbers/client/requests/SearchPhoneNumberParams.d.mts +1 -4
  834. package/dist/esm/api/resources/phoneNumbers/client/requests/SearchPhoneNumberParams.mjs +1 -3
  835. package/dist/esm/api/resources/phoneNumbers/client/requests/index.d.mts +3 -3
  836. package/dist/esm/api/resources/phoneNumbers/index.d.mts +1 -1
  837. package/dist/esm/api/resources/phoneNumbers/index.mjs +1 -1
  838. package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/Client.d.mts +4 -25
  839. package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/Client.mjs +16 -14
  840. package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/index.d.mts +0 -1
  841. package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/requests/AttachCampaignParams.d.mts +1 -4
  842. package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/requests/AttachCampaignParams.mjs +1 -3
  843. package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/requests/DetachCampaignParams.d.mts +0 -3
  844. package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/requests/DetachCampaignParams.mjs +1 -3
  845. package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/requests/index.d.mts +2 -2
  846. package/dist/esm/api/resources/phoneNumbers/resources/index.d.mts +2 -2
  847. package/dist/esm/api/resources/phoneNumbers/resources/index.mjs +2 -2
  848. package/dist/esm/api/resources/phoneNumbers/resources/webhook/client/Client.d.mts +4 -25
  849. package/dist/esm/api/resources/phoneNumbers/resources/webhook/client/Client.mjs +18 -16
  850. package/dist/esm/api/resources/phoneNumbers/types/PhoneNumbersGetResponse.d.mts +1 -4
  851. package/dist/esm/api/resources/phoneNumbers/types/PhoneNumbersGetResponse.mjs +1 -3
  852. package/dist/esm/api/resources/rcs/client/Client.d.mts +4 -25
  853. package/dist/esm/api/resources/rcs/client/Client.mjs +22 -18
  854. package/dist/esm/api/resources/rcs/client/index.d.mts +0 -1
  855. package/dist/esm/api/resources/rcs/client/requests/RcsCapabilitiesQuery.d.mts +0 -3
  856. package/dist/esm/api/resources/rcs/client/requests/RcsCapabilitiesQuery.mjs +1 -3
  857. package/dist/esm/api/resources/rcs/client/requests/RcsLinkRequest.d.mts +0 -3
  858. package/dist/esm/api/resources/rcs/client/requests/RcsLinkRequest.mjs +1 -3
  859. package/dist/esm/api/resources/rcs/client/requests/RcsWhitelistRequest.d.mts +0 -3
  860. package/dist/esm/api/resources/rcs/client/requests/RcsWhitelistRequest.mjs +1 -3
  861. package/dist/esm/api/resources/rcs/client/requests/index.d.mts +3 -3
  862. package/dist/esm/api/resources/status/client/Client.d.mts +2 -12
  863. package/dist/esm/api/resources/status/client/Client.mjs +1 -3
  864. package/dist/esm/api/resources/status/resources/get/client/Client.d.mts +4 -25
  865. package/dist/esm/api/resources/status/resources/get/client/Client.mjs +39 -31
  866. package/dist/esm/api/resources/tools/client/Client.d.mts +4 -14
  867. package/dist/esm/api/resources/tools/client/Client.mjs +3 -5
  868. package/dist/esm/api/resources/tools/resources/contactCard/client/Client.d.mts +4 -25
  869. package/dist/esm/api/resources/tools/resources/contactCard/client/Client.mjs +16 -14
  870. package/dist/esm/api/resources/tools/resources/contactCard/client/index.d.mts +0 -1
  871. package/dist/esm/api/resources/tools/resources/contactCard/client/requests/GetVcardParams.d.mts +0 -3
  872. package/dist/esm/api/resources/tools/resources/contactCard/client/requests/GetVcardParams.mjs +1 -3
  873. package/dist/esm/api/resources/tools/resources/contactCard/client/requests/UpsertVcardParams.d.mts +1 -4
  874. package/dist/esm/api/resources/tools/resources/contactCard/client/requests/UpsertVcardParams.mjs +1 -3
  875. package/dist/esm/api/resources/tools/resources/contactCard/client/requests/index.d.mts +2 -2
  876. package/dist/esm/api/resources/tools/resources/file/client/Client.d.mts +4 -25
  877. package/dist/esm/api/resources/tools/resources/file/client/Client.mjs +16 -14
  878. package/dist/esm/api/resources/tools/resources/file/client/index.d.mts +0 -1
  879. package/dist/esm/api/resources/tools/resources/file/client/requests/RefreshFileParams.d.mts +0 -3
  880. package/dist/esm/api/resources/tools/resources/file/client/requests/RefreshFileParams.mjs +1 -3
  881. package/dist/esm/api/resources/tools/resources/file/client/requests/UploadFileParams.d.mts +0 -3
  882. package/dist/esm/api/resources/tools/resources/file/client/requests/UploadFileParams.mjs +1 -3
  883. package/dist/esm/api/resources/tools/resources/file/client/requests/index.d.mts +2 -2
  884. package/dist/esm/api/resources/tools/resources/index.d.mts +4 -4
  885. package/dist/esm/api/resources/tools/resources/index.mjs +4 -4
  886. package/dist/esm/api/resources/tools/resources/url/client/Client.d.mts +4 -25
  887. package/dist/esm/api/resources/tools/resources/url/client/Client.mjs +24 -20
  888. package/dist/esm/api/resources/tools/resources/url/client/index.d.mts +0 -1
  889. package/dist/esm/api/resources/tools/resources/url/client/requests/CreateUrlParams.d.mts +1 -4
  890. package/dist/esm/api/resources/tools/resources/url/client/requests/CreateUrlParams.mjs +1 -3
  891. package/dist/esm/api/resources/tools/resources/url/client/requests/UpdateUrlParams.d.mts +1 -4
  892. package/dist/esm/api/resources/tools/resources/url/client/requests/UpdateUrlParams.mjs +1 -3
  893. package/dist/esm/api/resources/tools/resources/url/client/requests/index.d.mts +2 -2
  894. package/dist/esm/api/resources/webhooks/client/Client.d.mts +4 -25
  895. package/dist/esm/api/resources/webhooks/client/Client.mjs +10 -10
  896. package/dist/esm/api/resources/webhooks/client/index.d.mts +0 -1
  897. package/dist/esm/api/resources/webhooks/client/requests/GetWebhookParams.d.mts +0 -3
  898. package/dist/esm/api/resources/webhooks/client/requests/GetWebhookParams.mjs +1 -3
  899. package/dist/esm/api/resources/webhooks/client/requests/index.d.mts +1 -1
  900. package/dist/esm/api/types/AdvancedPhoneInformation.d.mts +2 -5
  901. package/dist/esm/api/types/AdvancedPhoneInformation.mjs +7 -3
  902. package/dist/esm/api/types/AttachWebhookParams.d.mts +1 -4
  903. package/dist/esm/api/types/AttachWebhookParams.mjs +1 -3
  904. package/dist/esm/api/types/AttachedPhoneNumberResult.d.mts +1 -4
  905. package/dist/esm/api/types/AttachedPhoneNumberResult.mjs +1 -3
  906. package/dist/esm/api/types/AudienceCountOnly.d.mts +0 -3
  907. package/dist/esm/api/types/AudienceCountOnly.mjs +1 -3
  908. package/dist/esm/api/types/AudienceWithPagination.d.mts +1 -4
  909. package/dist/esm/api/types/AudienceWithPagination.mjs +1 -3
  910. package/dist/esm/api/types/AutofillCampaignParams.d.mts +0 -3
  911. package/dist/esm/api/types/AutofillCampaignParams.mjs +1 -3
  912. package/dist/esm/api/types/AutofillDlcCampaignResponse.d.mts +1 -4
  913. package/dist/esm/api/types/AutofillDlcCampaignResponse.mjs +1 -3
  914. package/dist/esm/api/types/BadRequestErrorBody.d.mts +1 -4
  915. package/dist/esm/api/types/BadRequestErrorBody.mjs +1 -3
  916. package/dist/esm/api/types/BaseRichMessage.d.mts +9 -0
  917. package/dist/esm/api/types/BaseRichMessage.mjs +2 -0
  918. package/dist/esm/api/types/BasicPhoneInformation.d.mts +1 -4
  919. package/dist/esm/api/types/BasicPhoneInformation.mjs +1 -3
  920. package/dist/esm/api/types/BlastDetails.d.mts +17 -0
  921. package/dist/esm/api/types/BlastDetails.mjs +2 -0
  922. package/dist/esm/api/types/BrandStatus.d.mts +1 -4
  923. package/dist/esm/api/types/BrandStatus.mjs +1 -3
  924. package/dist/esm/api/types/BrandStatusEnum.d.mts +1 -4
  925. package/dist/esm/api/types/BrandStatusEnum.mjs +8 -1
  926. package/dist/esm/api/types/ButtonClicked.d.mts +1 -4
  927. package/dist/esm/api/types/ButtonClicked.mjs +1 -3
  928. package/dist/esm/api/types/ButtonClickedData.d.mts +2 -5
  929. package/dist/esm/api/types/ButtonClickedData.mjs +7 -3
  930. package/dist/esm/api/types/CampaignEnum.d.mts +1 -4
  931. package/dist/esm/api/types/CampaignEnum.mjs +5 -1
  932. package/dist/esm/api/types/CampaignQuery.d.mts +1 -4
  933. package/dist/esm/api/types/CampaignQuery.mjs +1 -3
  934. package/dist/esm/api/types/CampaignSubmissionResult.d.mts +0 -3
  935. package/dist/esm/api/types/CampaignSubmissionResult.mjs +1 -3
  936. package/dist/esm/api/types/CampaignValidationResult.d.mts +0 -3
  937. package/dist/esm/api/types/CampaignValidationResult.mjs +1 -3
  938. package/dist/esm/api/types/CompanyEntityTypeEnum.d.mts +9 -0
  939. package/dist/esm/api/types/CompanyEntityTypeEnum.mjs +9 -0
  940. package/dist/esm/api/types/CompanySectorEnum.d.mts +2 -7
  941. package/dist/esm/api/types/CompanySectorEnum.mjs +2 -3
  942. package/dist/esm/api/types/CompanyTypeEnum.d.mts +2 -7
  943. package/dist/esm/api/types/CompanyTypeEnum.mjs +2 -3
  944. package/dist/esm/api/types/ConfiguredWebhook.d.mts +1 -4
  945. package/dist/esm/api/types/ConfiguredWebhook.mjs +1 -3
  946. package/dist/esm/api/types/Contact.d.mts +0 -3
  947. package/dist/esm/api/types/Contact.mjs +1 -3
  948. package/dist/esm/api/types/ContactId.d.mts +0 -3
  949. package/dist/esm/api/types/ContactId.mjs +1 -3
  950. package/dist/esm/api/types/Conversation.d.mts +1 -4
  951. package/dist/esm/api/types/Conversation.mjs +1 -3
  952. package/dist/esm/api/types/ConversationList.d.mts +1 -4
  953. package/dist/esm/api/types/ConversationList.mjs +1 -3
  954. package/dist/esm/api/types/CreateUrlOptions.d.mts +0 -3
  955. package/dist/esm/api/types/CreateUrlOptions.mjs +1 -3
  956. package/dist/esm/api/types/DeleteAudienceResponse.d.mts +0 -3
  957. package/dist/esm/api/types/DeleteAudienceResponse.mjs +1 -3
  958. package/dist/esm/api/types/DetachedPhoneNumberResult.d.mts +1 -4
  959. package/dist/esm/api/types/DetachedPhoneNumberResult.mjs +1 -3
  960. package/dist/esm/api/types/DetachedWebhookInfo.d.mts +0 -3
  961. package/dist/esm/api/types/DetachedWebhookInfo.mjs +1 -3
  962. package/dist/esm/api/types/DetailedPhoneNumberEnum.d.mts +1 -4
  963. package/dist/esm/api/types/DetailedPhoneNumberEnum.mjs +5 -1
  964. package/dist/esm/api/types/DlcAssignmentStatusEnum.d.mts +1 -4
  965. package/dist/esm/api/types/DlcAssignmentStatusEnum.mjs +8 -1
  966. package/dist/esm/api/types/DlcCampaignStatus.d.mts +1 -4
  967. package/dist/esm/api/types/DlcCampaignStatus.mjs +1 -3
  968. package/dist/esm/api/types/DlcCampaignUseCaseEnum.d.mts +2 -7
  969. package/dist/esm/api/types/DlcCampaignUseCaseEnum.mjs +2 -3
  970. package/dist/esm/api/types/DlcCampaignWithExtendedBrandAndStatus.d.mts +43 -4
  971. package/dist/esm/api/types/DlcCampaignWithExtendedBrandAndStatus.mjs +32 -4
  972. package/dist/esm/api/types/EnhancedContact.d.mts +1 -4
  973. package/dist/esm/api/types/EnhancedContact.mjs +1 -3
  974. package/dist/esm/api/types/EnhancedContactItem.d.mts +0 -3
  975. package/dist/esm/api/types/EnhancedContactItem.mjs +1 -3
  976. package/dist/esm/api/types/Error_.d.mts +0 -3
  977. package/dist/esm/api/types/Error_.mjs +1 -3
  978. package/dist/esm/api/types/ExtendedBrand.d.mts +1 -4
  979. package/dist/esm/api/types/ExtendedBrand.mjs +1 -3
  980. package/dist/esm/api/types/ExtendedBrandWithVetting.d.mts +1 -4
  981. package/dist/esm/api/types/ExtendedBrandWithVetting.mjs +1 -3
  982. package/dist/esm/api/types/ExtendedRcsCampaign.d.mts +55 -30
  983. package/dist/esm/api/types/ExtendedRcsCampaign.mjs +1 -3
  984. package/dist/esm/api/types/GetConversationParams.d.mts +0 -3
  985. package/dist/esm/api/types/GetConversationParams.mjs +1 -3
  986. package/dist/esm/api/types/LinkClickEvent.d.mts +0 -3
  987. package/dist/esm/api/types/LinkClickEvent.mjs +1 -3
  988. package/dist/esm/api/types/LocationShareAction.d.mts +0 -3
  989. package/dist/esm/api/types/LocationShareAction.mjs +1 -3
  990. package/dist/esm/api/types/Message.d.mts +1 -4
  991. package/dist/esm/api/types/Message.mjs +1 -3
  992. package/dist/esm/api/types/MessageContent.d.mts +1 -4
  993. package/dist/esm/api/types/MessageContent.mjs +1 -3
  994. package/dist/esm/api/types/MessageEvent.d.mts +3 -8
  995. package/dist/esm/api/types/MessageEvent.mjs +2 -3
  996. package/dist/esm/api/types/MessageEventContent.d.mts +1 -4
  997. package/dist/esm/api/types/MessageEventContent.mjs +1 -3
  998. package/dist/esm/api/types/MessageEventMmsContent.d.mts +0 -3
  999. package/dist/esm/api/types/MessageEventMmsContent.mjs +1 -3
  1000. package/dist/esm/api/types/MessageEventRcsButtonData.d.mts +1 -4
  1001. package/dist/esm/api/types/MessageEventRcsButtonData.mjs +1 -3
  1002. package/dist/esm/api/types/MessageEventRcsCardsContent.d.mts +1 -4
  1003. package/dist/esm/api/types/MessageEventRcsCardsContent.mjs +1 -3
  1004. package/dist/esm/api/types/MessageEventRcsLocationData.d.mts +1 -4
  1005. package/dist/esm/api/types/MessageEventRcsLocationData.mjs +1 -3
  1006. package/dist/esm/api/types/MessageEventRcsMediaContent.d.mts +1 -4
  1007. package/dist/esm/api/types/MessageEventRcsMediaContent.mjs +1 -3
  1008. package/dist/esm/api/types/MessageEventRcsTextContent.d.mts +1 -4
  1009. package/dist/esm/api/types/MessageEventRcsTextContent.mjs +1 -3
  1010. package/dist/esm/api/types/MessageEventSmsContent.d.mts +0 -3
  1011. package/dist/esm/api/types/MessageEventSmsContent.mjs +1 -3
  1012. package/dist/esm/api/types/MessageList.d.mts +1 -4
  1013. package/dist/esm/api/types/MessageList.mjs +1 -3
  1014. package/dist/esm/api/types/MessageMethodEnum.d.mts +2 -7
  1015. package/dist/esm/api/types/MessageMethodEnum.mjs +2 -3
  1016. package/dist/esm/api/types/MessageProtocolEnum.d.mts +2 -7
  1017. package/dist/esm/api/types/MessageProtocolEnum.mjs +2 -3
  1018. package/dist/esm/api/types/MessageSchedule.d.mts +28 -11
  1019. package/dist/esm/api/types/MessageSchedule.mjs +1 -3
  1020. package/dist/esm/api/types/MessageStatusEnum.d.mts +3 -7
  1021. package/dist/esm/api/types/MessageStatusEnum.mjs +3 -3
  1022. package/dist/esm/api/types/MessageVolumeEnum.d.mts +2 -7
  1023. package/dist/esm/api/types/MessageVolumeEnum.mjs +2 -3
  1024. package/dist/esm/api/types/MessageWithReaction.d.mts +3 -8
  1025. package/dist/esm/api/types/MessageWithReaction.mjs +2 -3
  1026. package/dist/esm/api/types/MessagingProfileEnum.d.mts +2 -7
  1027. package/dist/esm/api/types/MessagingProfileEnum.mjs +2 -3
  1028. package/dist/esm/api/types/MmsContent.d.mts +0 -3
  1029. package/dist/esm/api/types/MmsContent.mjs +1 -3
  1030. package/dist/esm/api/types/MmsValidationResult.d.mts +0 -3
  1031. package/dist/esm/api/types/MmsValidationResult.mjs +1 -3
  1032. package/dist/esm/api/types/NotFoundErrorBody.d.mts +0 -3
  1033. package/dist/esm/api/types/NotFoundErrorBody.mjs +1 -3
  1034. package/dist/esm/api/types/NumberFormat.d.mts +0 -3
  1035. package/dist/esm/api/types/NumberFormat.mjs +1 -3
  1036. package/dist/esm/api/types/OptInMethodEnum.d.mts +2 -7
  1037. package/dist/esm/api/types/OptInMethodEnum.mjs +2 -3
  1038. package/dist/esm/api/types/OptionalBrandInfo.d.mts +3 -4
  1039. package/dist/esm/api/types/OptionalBrandInfo.mjs +1 -3
  1040. package/dist/esm/api/types/OptionalContact.d.mts +0 -3
  1041. package/dist/esm/api/types/OptionalContact.mjs +1 -3
  1042. package/dist/esm/api/types/OptionalContacts.d.mts +0 -3
  1043. package/dist/esm/api/types/OptionalContacts.mjs +1 -3
  1044. package/dist/esm/api/types/Pagination.d.mts +0 -3
  1045. package/dist/esm/api/types/Pagination.mjs +1 -3
  1046. package/dist/esm/api/types/PhoneCapabilities.d.mts +0 -3
  1047. package/dist/esm/api/types/PhoneCapabilities.mjs +1 -3
  1048. package/dist/esm/api/types/PhoneEnum.d.mts +1 -4
  1049. package/dist/esm/api/types/PhoneEnum.mjs +4 -1
  1050. package/dist/esm/api/types/PhoneFeatureEnum.d.mts +1 -4
  1051. package/dist/esm/api/types/PhoneFeatureEnum.mjs +4 -1
  1052. package/dist/esm/api/types/PhoneNumberDetails.d.mts +1 -4
  1053. package/dist/esm/api/types/PhoneNumberDetails.mjs +1 -3
  1054. package/dist/esm/api/types/PhoneNumberEnum.d.mts +1 -4
  1055. package/dist/esm/api/types/PhoneNumberEnum.mjs +4 -1
  1056. package/dist/esm/api/types/PhoneNumberStatus.d.mts +1 -4
  1057. package/dist/esm/api/types/PhoneNumberStatus.mjs +1 -3
  1058. package/dist/esm/api/types/PhoneNumberStatusEnum.d.mts +1 -4
  1059. package/dist/esm/api/types/PhoneNumberStatusEnum.mjs +6 -1
  1060. package/dist/esm/api/types/ProfileStatusEnum.d.mts +1 -4
  1061. package/dist/esm/api/types/ProfileStatusEnum.mjs +10 -1
  1062. package/dist/esm/api/types/PurchasedNumber.d.mts +0 -3
  1063. package/dist/esm/api/types/PurchasedNumber.mjs +1 -3
  1064. package/dist/esm/api/types/RcsButtonCall.d.mts +0 -3
  1065. package/dist/esm/api/types/RcsButtonCall.mjs +1 -3
  1066. package/dist/esm/api/types/RcsButtonOpenUrl.d.mts +1 -4
  1067. package/dist/esm/api/types/RcsButtonOpenUrl.mjs +11 -3
  1068. package/dist/esm/api/types/RcsButtonRequestUserLocation.d.mts +0 -3
  1069. package/dist/esm/api/types/RcsButtonRequestUserLocation.mjs +1 -3
  1070. package/dist/esm/api/types/RcsButtonScheduleEvent.d.mts +0 -3
  1071. package/dist/esm/api/types/RcsButtonScheduleEvent.mjs +1 -3
  1072. package/dist/esm/api/types/RcsButtonSendLocation.d.mts +0 -3
  1073. package/dist/esm/api/types/RcsButtonSendLocation.mjs +1 -3
  1074. package/dist/esm/api/types/RcsButtonTrigger.d.mts +0 -3
  1075. package/dist/esm/api/types/RcsButtonTrigger.mjs +1 -3
  1076. package/dist/esm/api/types/RcsCampaign.d.mts +55 -28
  1077. package/dist/esm/api/types/RcsCampaign.mjs +1 -3
  1078. package/dist/esm/api/types/RcsCampaignStatus.d.mts +1 -4
  1079. package/dist/esm/api/types/RcsCampaignStatus.mjs +1 -3
  1080. package/dist/esm/api/types/RcsCampaignUseCaseEnum.d.mts +2 -7
  1081. package/dist/esm/api/types/RcsCampaignUseCaseEnum.mjs +2 -3
  1082. package/dist/esm/api/types/RcsCapabilitiesResult.d.mts +1 -4
  1083. package/dist/esm/api/types/RcsCapabilitiesResult.mjs +1 -3
  1084. package/dist/esm/api/types/RcsCapability.d.mts +0 -3
  1085. package/dist/esm/api/types/RcsCapability.mjs +1 -3
  1086. package/dist/esm/api/types/RcsCardsContent.d.mts +2 -5
  1087. package/dist/esm/api/types/RcsCardsContent.mjs +1 -3
  1088. package/dist/esm/api/types/RcsContent.d.mts +2 -5
  1089. package/dist/esm/api/types/RcsContent.mjs +1 -3
  1090. package/dist/esm/api/types/RcsLinkResult.d.mts +0 -3
  1091. package/dist/esm/api/types/RcsLinkResult.mjs +1 -3
  1092. package/dist/esm/api/types/RcsMediaContent.d.mts +1 -4
  1093. package/dist/esm/api/types/RcsMediaContent.mjs +1 -3
  1094. package/dist/esm/api/types/RcsMediaDetailsContent.d.mts +0 -3
  1095. package/dist/esm/api/types/RcsMediaDetailsContent.mjs +1 -3
  1096. package/dist/esm/api/types/RcsMessagingTypeEnum.d.mts +15 -0
  1097. package/dist/esm/api/types/RcsMessagingTypeEnum.mjs +15 -0
  1098. package/dist/esm/api/types/RcsValidateContent.d.mts +3 -6
  1099. package/dist/esm/api/types/RcsValidateContent.mjs +1 -3
  1100. package/dist/esm/api/types/RcsValidationResult.d.mts +2 -3
  1101. package/dist/esm/api/types/RcsValidationResult.mjs +1 -3
  1102. package/dist/esm/api/types/RcsWhitelistResponse.d.mts +0 -3
  1103. package/dist/esm/api/types/RcsWhitelistResponse.mjs +1 -3
  1104. package/dist/esm/api/types/ReactionResult.d.mts +0 -3
  1105. package/dist/esm/api/types/ReactionResult.mjs +1 -3
  1106. package/dist/esm/api/types/RefreshedFile.d.mts +0 -3
  1107. package/dist/esm/api/types/RefreshedFile.mjs +1 -3
  1108. package/dist/esm/api/types/RichButton.d.mts +1 -4
  1109. package/dist/esm/api/types/RichButton.mjs +1 -3
  1110. package/dist/esm/api/types/{RcsCards.d.mts → RichCards.d.mts} +5 -8
  1111. package/dist/esm/api/types/RichCards.mjs +2 -0
  1112. package/dist/esm/api/types/RichCardsMessage.d.mts +11 -16
  1113. package/dist/esm/api/types/RichCardsMessage.mjs +3 -3
  1114. package/dist/esm/api/types/RichMediaMessage.d.mts +2 -5
  1115. package/dist/esm/api/types/RichMediaMessage.mjs +1 -3
  1116. package/dist/esm/api/types/RichMessage.d.mts +5 -5
  1117. package/dist/esm/api/types/RichMessage.mjs +1 -3
  1118. package/dist/esm/api/types/{RcsTextContent.d.mts → RichText.d.mts} +2 -5
  1119. package/dist/esm/api/types/RichText.mjs +2 -0
  1120. package/dist/esm/api/types/RichTextMessage.d.mts +2 -5
  1121. package/dist/esm/api/types/RichTextMessage.mjs +1 -3
  1122. package/dist/esm/api/types/ScheduleCancelResult.d.mts +7 -0
  1123. package/dist/esm/api/types/ScheduleCancelResult.mjs +2 -0
  1124. package/dist/esm/api/types/ScheduledBlastDetails.d.mts +24 -0
  1125. package/dist/esm/api/types/ScheduledBlastDetails.mjs +2 -0
  1126. package/dist/{cjs/api/types/ScheduledMessaage.d.ts → esm/api/types/ScheduledMessage.d.mts} +3 -6
  1127. package/dist/esm/api/types/ScheduledMessage.mjs +2 -0
  1128. package/dist/esm/api/types/{Options.d.mts → SendRichMessageOptions.d.mts} +2 -5
  1129. package/dist/esm/api/types/SendRichMessageOptions.mjs +2 -0
  1130. package/dist/esm/api/types/SendTypingIndicatorResponse.d.mts +0 -3
  1131. package/dist/esm/api/types/SendTypingIndicatorResponse.mjs +1 -3
  1132. package/dist/esm/api/types/Sender.d.mts +0 -3
  1133. package/dist/esm/api/types/Sender.mjs +1 -3
  1134. package/dist/esm/api/types/SentMmsDetails.d.mts +0 -3
  1135. package/dist/esm/api/types/SentMmsDetails.mjs +1 -3
  1136. package/dist/{cjs/api/types/SentRcsDetails.d.ts → esm/api/types/SentRichMessage.d.mts} +1 -4
  1137. package/dist/esm/api/types/SentRichMessage.mjs +2 -0
  1138. package/dist/esm/api/types/SentSmsDetails.d.mts +2 -7
  1139. package/dist/esm/api/types/SentSmsDetails.mjs +2 -3
  1140. package/dist/esm/api/types/ShortenedUrl.d.mts +0 -3
  1141. package/dist/esm/api/types/ShortenedUrl.mjs +1 -3
  1142. package/dist/esm/api/types/ShortenedUrlWithClickData.d.mts +1 -4
  1143. package/dist/esm/api/types/ShortenedUrlWithClickData.mjs +1 -3
  1144. package/dist/esm/api/types/SmsContent.d.mts +0 -3
  1145. package/dist/esm/api/types/SmsContent.mjs +1 -3
  1146. package/dist/esm/api/types/SmsValidationResult.d.mts +0 -3
  1147. package/dist/esm/api/types/SmsValidationResult.mjs +1 -3
  1148. package/dist/esm/api/types/SubUseCaseEnum.d.mts +2 -7
  1149. package/dist/esm/api/types/SubUseCaseEnum.mjs +2 -3
  1150. package/dist/esm/api/types/SubmissionResults.d.mts +0 -3
  1151. package/dist/esm/api/types/SubmissionResults.mjs +1 -3
  1152. package/dist/esm/api/types/SuccessfulConversationUpdate.d.mts +0 -3
  1153. package/dist/esm/api/types/SuccessfulConversationUpdate.mjs +1 -3
  1154. package/dist/esm/api/types/TollFreeCampaign.d.mts +50 -4
  1155. package/dist/esm/api/types/TollFreeCampaign.mjs +1 -3
  1156. package/dist/esm/api/types/TollFreeCampaignStatus.d.mts +1 -4
  1157. package/dist/esm/api/types/TollFreeCampaignStatus.mjs +1 -3
  1158. package/dist/esm/api/types/TollFreeCampaignUseCaseEnum.d.mts +2 -7
  1159. package/dist/esm/api/types/TollFreeCampaignUseCaseEnum.mjs +2 -3
  1160. package/dist/esm/api/types/TollFreeCampaignWithExtendedBrandAndStatus.d.mts +1 -4
  1161. package/dist/esm/api/types/TollFreeCampaignWithExtendedBrandAndStatus.mjs +1 -3
  1162. package/dist/esm/api/types/TollFreeStatusEnum.d.mts +1 -4
  1163. package/dist/esm/api/types/TollFreeStatusEnum.mjs +8 -1
  1164. package/dist/esm/api/types/Tracking.d.mts +1 -4
  1165. package/dist/esm/api/types/Tracking.mjs +6 -1
  1166. package/dist/esm/api/types/UpdatedContactId.d.mts +0 -3
  1167. package/dist/esm/api/types/UpdatedContactId.mjs +1 -3
  1168. package/dist/esm/api/types/UploadResults.d.mts +0 -3
  1169. package/dist/esm/api/types/UploadResults.mjs +1 -3
  1170. package/dist/esm/api/types/UpsertContact.d.mts +0 -3
  1171. package/dist/esm/api/types/UpsertContact.mjs +1 -3
  1172. package/dist/esm/api/types/UserEvent.d.mts +0 -3
  1173. package/dist/esm/api/types/UserEvent.mjs +1 -3
  1174. package/dist/esm/api/types/VCardData.d.mts +1 -4
  1175. package/dist/esm/api/types/VCardData.mjs +1 -3
  1176. package/dist/esm/api/types/ValidateCampaignParams.d.mts +0 -3
  1177. package/dist/esm/api/types/ValidateCampaignParams.mjs +1 -3
  1178. package/dist/esm/api/types/ValidationErrorDetails.d.mts +0 -3
  1179. package/dist/esm/api/types/ValidationErrorDetails.mjs +1 -3
  1180. package/dist/esm/api/types/ValidationResults.d.mts +1 -4
  1181. package/dist/esm/api/types/ValidationResults.mjs +1 -3
  1182. package/dist/esm/api/types/Vcard.d.mts +1 -4
  1183. package/dist/esm/api/types/Vcard.mjs +1 -3
  1184. package/dist/esm/api/types/VcardAddress.d.mts +1 -4
  1185. package/dist/esm/api/types/VcardAddress.mjs +1 -3
  1186. package/dist/esm/api/types/VcardContent.d.mts +1 -4
  1187. package/dist/esm/api/types/VcardContent.mjs +1 -3
  1188. package/dist/esm/api/types/VcardEmail.d.mts +1 -4
  1189. package/dist/esm/api/types/VcardEmail.mjs +1 -3
  1190. package/dist/esm/api/types/VcardPhone.d.mts +1 -4
  1191. package/dist/esm/api/types/VcardPhone.mjs +1 -3
  1192. package/dist/esm/api/types/VcardResource.d.mts +0 -3
  1193. package/dist/esm/api/types/VcardResource.mjs +1 -3
  1194. package/dist/esm/api/types/VettingFeedback.d.mts +0 -3
  1195. package/dist/esm/api/types/VettingFeedback.mjs +1 -3
  1196. package/dist/esm/api/types/VettingHistory.d.mts +2 -7
  1197. package/dist/esm/api/types/VettingHistory.mjs +2 -3
  1198. package/dist/esm/api/types/VettingResults.d.mts +0 -3
  1199. package/dist/esm/api/types/VettingResults.mjs +1 -3
  1200. package/dist/esm/api/types/WebhookEventEnum.d.mts +1 -4
  1201. package/dist/esm/api/types/WebhookEventEnum.mjs +4 -1
  1202. package/dist/esm/api/types/WebhookResult.d.mts +1 -4
  1203. package/dist/esm/api/types/WebhookResult.mjs +1 -3
  1204. package/dist/esm/api/types/Webhooks.d.mts +0 -3
  1205. package/dist/esm/api/types/Webhooks.mjs +1 -3
  1206. package/dist/esm/api/types/ZodError.d.mts +0 -3
  1207. package/dist/esm/api/types/ZodError.mjs +1 -3
  1208. package/dist/esm/api/types/index.d.mts +127 -123
  1209. package/dist/esm/api/types/index.mjs +127 -123
  1210. package/dist/esm/core/exports.d.mts +1 -0
  1211. package/dist/esm/core/exports.mjs +1 -0
  1212. package/dist/esm/core/fetcher/APIResponse.d.mts +1 -1
  1213. package/dist/esm/core/fetcher/BinaryResponse.d.mts +1 -1
  1214. package/dist/esm/core/fetcher/EndpointMetadata.d.mts +13 -0
  1215. package/dist/esm/core/fetcher/EndpointMetadata.mjs +1 -0
  1216. package/dist/esm/core/fetcher/EndpointSupplier.d.mts +12 -0
  1217. package/dist/esm/core/fetcher/EndpointSupplier.mjs +19 -0
  1218. package/dist/esm/core/fetcher/Fetcher.d.mts +9 -4
  1219. package/dist/esm/core/fetcher/Fetcher.mjs +205 -10
  1220. package/dist/esm/core/fetcher/HttpResponsePromise.d.mts +1 -1
  1221. package/dist/esm/core/fetcher/getErrorResponseBody.mjs +2 -1
  1222. package/dist/esm/core/fetcher/getRequestBody.d.mts +1 -1
  1223. package/dist/esm/core/fetcher/getRequestBody.mjs +4 -0
  1224. package/dist/esm/core/fetcher/getResponseBody.mjs +3 -3
  1225. package/dist/esm/core/fetcher/index.d.mts +2 -0
  1226. package/dist/esm/core/fetcher/index.mjs +1 -0
  1227. package/dist/esm/core/fetcher/makeRequest.d.mts +1 -1
  1228. package/dist/esm/core/fetcher/makeRequest.mjs +2 -4
  1229. package/dist/esm/core/fetcher/requestWithRetries.mjs +16 -21
  1230. package/dist/esm/core/fetcher/signals.d.mts +0 -6
  1231. package/dist/esm/core/fetcher/signals.mjs +0 -12
  1232. package/dist/esm/core/headers.d.mts +2 -3
  1233. package/dist/esm/core/headers.mjs +6 -4
  1234. package/dist/esm/core/index.d.mts +1 -0
  1235. package/dist/esm/core/index.mjs +1 -0
  1236. package/dist/esm/core/logging/exports.d.mts +18 -0
  1237. package/dist/esm/core/logging/exports.mjs +9 -0
  1238. package/dist/esm/core/logging/index.d.mts +1 -0
  1239. package/dist/esm/core/logging/index.mjs +1 -0
  1240. package/dist/esm/core/logging/logger.d.mts +126 -0
  1241. package/dist/esm/core/logging/logger.mjs +138 -0
  1242. package/dist/esm/core/url/encodePathParam.d.mts +1 -0
  1243. package/dist/esm/core/url/encodePathParam.mjs +18 -0
  1244. package/dist/esm/core/url/index.d.mts +1 -0
  1245. package/dist/esm/core/url/index.mjs +1 -0
  1246. package/dist/esm/core/url/join.mjs +3 -4
  1247. package/dist/esm/environments.d.mts +0 -3
  1248. package/dist/esm/environments.mjs +1 -3
  1249. package/dist/esm/errors/PinnacleError.d.mts +1 -4
  1250. package/dist/esm/errors/PinnacleError.mjs +2 -4
  1251. package/dist/esm/errors/PinnacleTimeoutError.d.mts +0 -3
  1252. package/dist/esm/errors/PinnacleTimeoutError.mjs +1 -3
  1253. package/dist/esm/exports.d.mts +1 -0
  1254. package/dist/esm/exports.mjs +1 -0
  1255. package/dist/esm/version.d.mts +1 -1
  1256. package/dist/esm/version.mjs +1 -1
  1257. package/dist/esm/wrapper/messages/Client.mjs +1 -0
  1258. package/dist/esm/wrapper/tools/FileUploader.d.mts +1 -1
  1259. package/dist/esm/wrapper/tools/FileUploader.mjs +1 -0
  1260. package/package.json +16 -16
  1261. package/reference.md +860 -583
  1262. package/dist/cjs/api/resources/messages/resources/rcs/types/RcsSendResponse.d.ts +0 -5
  1263. package/dist/cjs/api/types/RcsBase.d.ts +0 -31
  1264. package/dist/cjs/api/types/RcsCampaignOptInMethodEnum.d.ts +0 -15
  1265. package/dist/cjs/api/types/RcsCampaignOptInMethodEnum.js +0 -14
  1266. package/dist/cjs/api/types/RcsTextContent.js +0 -5
  1267. package/dist/cjs/api/types/ScheduledMessaage.js +0 -5
  1268. package/dist/cjs/api/types/SentRcsDetails.js +0 -5
  1269. package/dist/esm/api/resources/messages/resources/rcs/types/RcsSendResponse.d.mts +0 -5
  1270. package/dist/esm/api/resources/messages/resources/rcs/types/RcsSendResponse.mjs +0 -4
  1271. package/dist/esm/api/types/Options.mjs +0 -4
  1272. package/dist/esm/api/types/RcsBase.d.mts +0 -31
  1273. package/dist/esm/api/types/RcsBase.mjs +0 -4
  1274. package/dist/esm/api/types/RcsCampaignOptInMethodEnum.d.mts +0 -15
  1275. package/dist/esm/api/types/RcsCampaignOptInMethodEnum.mjs +0 -11
  1276. package/dist/esm/api/types/RcsCards.mjs +0 -4
  1277. package/dist/esm/api/types/RcsTextContent.mjs +0 -4
  1278. package/dist/esm/api/types/ScheduledMessaage.mjs +0 -4
  1279. package/dist/esm/api/types/SentRcsDetails.mjs +0 -4
package/reference.md CHANGED
@@ -1,7 +1,5 @@
1
1
  # Reference
2
-
3
2
  ## Brands
4
-
5
3
  <details><summary><code>client.brands.<a href="/src/api/resources/brands/client/Client.ts">autofill</a>({ ...params }) -> Pinnacle.OptionalBrandInfo</code></summary>
6
4
  <dl>
7
5
  <dd>
@@ -15,7 +13,6 @@
15
13
  <dd>
16
14
 
17
15
  Automatically populate brand information based on partial input data you provide.
18
-
19
16
  </dd>
20
17
  </dl>
21
18
  </dd>
@@ -34,12 +31,12 @@ await client.brands.autofill({
34
31
  additional_info: "A developer-friendly, compliant API for SMS, MMS, and RCS, built to scale real conversations.",
35
32
  name: "Pinnacle",
36
33
  options: {
37
- forceReload: true,
34
+ forceReload: true
38
35
  },
39
- website: "https://www.pinnacle.sh",
36
+ website: "https://www.pinnacle.sh"
40
37
  });
41
- ```
42
38
 
39
+ ```
43
40
  </dd>
44
41
  </dl>
45
42
  </dd>
@@ -53,21 +50,22 @@ await client.brands.autofill({
53
50
  <dl>
54
51
  <dd>
55
52
 
56
- **request:** `Pinnacle.AutofillBrandParams`
57
-
53
+ **request:** `Pinnacle.AutofillBrandParams`
54
+
58
55
  </dd>
59
56
  </dl>
60
57
 
61
58
  <dl>
62
59
  <dd>
63
60
 
64
- **requestOptions:** `Brands.RequestOptions`
65
-
61
+ **requestOptions:** `Brands.RequestOptions`
62
+
66
63
  </dd>
67
64
  </dl>
68
65
  </dd>
69
66
  </dl>
70
67
 
68
+
71
69
  </dd>
72
70
  </dl>
73
71
  </details>
@@ -85,7 +83,6 @@ await client.brands.autofill({
85
83
  <dd>
86
84
 
87
85
  Create a new brand or update an existing brand by with the provided information.
88
-
89
86
  </dd>
90
87
  </dl>
91
88
  </dd>
@@ -106,7 +103,7 @@ await client.brands.upsert({
106
103
  email: "michael.chen@trypinnacle.app",
107
104
  name: "Michael Chen",
108
105
  phone: "+14155551234",
109
- title: "Customer Support Representative",
106
+ title: "Customer Support Representative"
110
107
  },
111
108
  dba: "Pinnacle RCS",
112
109
  description: "A developer-friendly, compliant API for SMS, MMS, and RCS, built to scale real conversations.",
@@ -116,10 +113,11 @@ await client.brands.upsert({
116
113
  name: "Pinnacle",
117
114
  sector: "TECHNOLOGY",
118
115
  type: "PRIVATE_PROFIT",
119
- website: "https://www.pinnacle.sh",
116
+ entityType: "LLC",
117
+ website: "https://www.pinnacle.sh"
120
118
  });
121
- ```
122
119
 
120
+ ```
123
121
  </dd>
124
122
  </dl>
125
123
  </dd>
@@ -133,21 +131,22 @@ await client.brands.upsert({
133
131
  <dl>
134
132
  <dd>
135
133
 
136
- **request:** `Pinnacle.UpsertBrandParams`
137
-
134
+ **request:** `Pinnacle.UpsertBrandParams`
135
+
138
136
  </dd>
139
137
  </dl>
140
138
 
141
139
  <dl>
142
140
  <dd>
143
141
 
144
- **requestOptions:** `Brands.RequestOptions`
145
-
142
+ **requestOptions:** `Brands.RequestOptions`
143
+
146
144
  </dd>
147
145
  </dl>
148
146
  </dd>
149
147
  </dl>
150
148
 
149
+
151
150
  </dd>
152
151
  </dl>
153
152
  </details>
@@ -165,7 +164,6 @@ await client.brands.upsert({
165
164
  <dd>
166
165
 
167
166
  Retrieve detailed information for a specific brand in your account by ID.
168
-
169
167
  </dd>
170
168
  </dl>
171
169
  </dd>
@@ -181,8 +179,8 @@ Retrieve detailed information for a specific brand in your account by ID.
181
179
 
182
180
  ```typescript
183
181
  await client.brands.get("b_1234567890");
184
- ```
185
182
 
183
+ ```
186
184
  </dd>
187
185
  </dl>
188
186
  </dd>
@@ -196,32 +194,33 @@ await client.brands.get("b_1234567890");
196
194
  <dl>
197
195
  <dd>
198
196
 
199
- **id:** `string`
197
+ **id:** `string`
200
198
 
201
199
  The unique identifier of the brand you want to retrieve from your account.
202
200
  <br><br> This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`.
203
-
201
+
204
202
  </dd>
205
203
  </dl>
206
204
 
207
205
  <dl>
208
206
  <dd>
209
207
 
210
- **request:** `Pinnacle.BrandsGetRequest`
211
-
208
+ **request:** `Pinnacle.BrandsGetRequest`
209
+
212
210
  </dd>
213
211
  </dl>
214
212
 
215
213
  <dl>
216
214
  <dd>
217
215
 
218
- **requestOptions:** `Brands.RequestOptions`
219
-
216
+ **requestOptions:** `Brands.RequestOptions`
217
+
220
218
  </dd>
221
219
  </dl>
222
220
  </dd>
223
221
  </dl>
224
222
 
223
+
225
224
  </dd>
226
225
  </dl>
227
226
  </details>
@@ -239,7 +238,6 @@ The unique identifier of the brand you want to retrieve from your account.
239
238
  <dd>
240
239
 
241
240
  Submit your brand for review and approval by the compliance team.
242
-
243
241
  </dd>
244
242
  </dl>
245
243
  </dd>
@@ -255,8 +253,8 @@ Submit your brand for review and approval by the compliance team.
255
253
 
256
254
  ```typescript
257
255
  await client.brands.submit("b_1234567890");
258
- ```
259
256
 
257
+ ```
260
258
  </dd>
261
259
  </dl>
262
260
  </dd>
@@ -270,24 +268,25 @@ await client.brands.submit("b_1234567890");
270
268
  <dl>
271
269
  <dd>
272
270
 
273
- **brandId:** `string`
271
+ **brandId:** `string`
274
272
 
275
273
  The unique identifier of the brand you want to submit for review. <br><br>
276
274
  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.
277
-
275
+
278
276
  </dd>
279
277
  </dl>
280
278
 
281
279
  <dl>
282
280
  <dd>
283
281
 
284
- **requestOptions:** `Brands.RequestOptions`
285
-
282
+ **requestOptions:** `Brands.RequestOptions`
283
+
286
284
  </dd>
287
285
  </dl>
288
286
  </dd>
289
287
  </dl>
290
288
 
289
+
291
290
  </dd>
292
291
  </dl>
293
292
  </details>
@@ -305,7 +304,6 @@ This identifier is a string that always begins with the prefix `b_`, for example
305
304
  <dd>
306
305
 
307
306
  Validate your brand information for compliance and correctness before submission or storage.
308
-
309
307
  </dd>
310
308
  </dl>
311
309
  </dd>
@@ -326,7 +324,7 @@ await client.brands.validate({
326
324
  email: "michael.chen@trypinnacle.app",
327
325
  name: "Michael Chen",
328
326
  phone: "+14155551234",
329
- title: "Customer Support Representative",
327
+ title: "Customer Support Representative"
330
328
  },
331
329
  dba: "Pinnacle Messaging",
332
330
  description: "Pinnacle is an SMS, MMS, and RCS API for scaling conversations with customers you value.",
@@ -335,10 +333,11 @@ await client.brands.validate({
335
333
  name: "Pinnacle",
336
334
  sector: "TECHNOLOGY",
337
335
  type: "PRIVATE_PROFIT",
338
- website: "https://www.pinnacle.sh",
336
+ entityType: "LLC",
337
+ website: "https://www.pinnacle.sh"
339
338
  });
340
- ```
341
339
 
340
+ ```
342
341
  </dd>
343
342
  </dl>
344
343
  </dd>
@@ -352,21 +351,22 @@ await client.brands.validate({
352
351
  <dl>
353
352
  <dd>
354
353
 
355
- **request:** `Pinnacle.ValidateBrandParams`
356
-
354
+ **request:** `Pinnacle.ValidateBrandParams`
355
+
357
356
  </dd>
358
357
  </dl>
359
358
 
360
359
  <dl>
361
360
  <dd>
362
361
 
363
- **requestOptions:** `Brands.RequestOptions`
364
-
362
+ **requestOptions:** `Brands.RequestOptions`
363
+
365
364
  </dd>
366
365
  </dl>
367
366
  </dd>
368
367
  </dl>
369
368
 
369
+
370
370
  </dd>
371
371
  </dl>
372
372
  </details>
@@ -384,7 +384,6 @@ await client.brands.validate({
384
384
  <dd>
385
385
 
386
386
  Submit a brand for external vetting verification to enhance your brand's trust score and improved message delivery rates.
387
-
388
387
  </dd>
389
388
  </dl>
390
389
  </dd>
@@ -400,8 +399,8 @@ Submit a brand for external vetting verification to enhance your brand's trust s
400
399
 
401
400
  ```typescript
402
401
  await client.brands.vet("b_1234567890", {});
403
- ```
404
402
 
403
+ ```
405
404
  </dd>
406
405
  </dl>
407
406
  </dd>
@@ -415,39 +414,39 @@ await client.brands.vet("b_1234567890", {});
415
414
  <dl>
416
415
  <dd>
417
416
 
418
- **brandId:** `string`
417
+ **brandId:** `string`
419
418
 
420
419
  The unique identifier of the brand to vet. <br>
421
420
 
422
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.
423
-
422
+
424
423
  </dd>
425
424
  </dl>
426
425
 
427
426
  <dl>
428
427
  <dd>
429
428
 
430
- **request:** `Pinnacle.VetBrandParams`
431
-
429
+ **request:** `Pinnacle.VetBrandParams`
430
+
432
431
  </dd>
433
432
  </dl>
434
433
 
435
434
  <dl>
436
435
  <dd>
437
436
 
438
- **requestOptions:** `Brands.RequestOptions`
439
-
437
+ **requestOptions:** `Brands.RequestOptions`
438
+
440
439
  </dd>
441
440
  </dl>
442
441
  </dd>
443
442
  </dl>
444
443
 
444
+
445
445
  </dd>
446
446
  </dl>
447
447
  </details>
448
448
 
449
449
  ## Audiences
450
-
451
450
  <details><summary><code>client.audiences.<a href="/src/api/resources/audiences/client/Client.ts">get</a>({ ...params }) -> Pinnacle.AudiencesGetResponse</code></summary>
452
451
  <dl>
453
452
  <dd>
@@ -461,7 +460,6 @@ This identifier is a string that always begins with the prefix `b_`, for example
461
460
  <dd>
462
461
 
463
462
  Retrieve an audience by ID with optional pagination.
464
-
465
463
  </dd>
466
464
  </dl>
467
465
  </dd>
@@ -477,10 +475,10 @@ Retrieve an audience by ID with optional pagination.
477
475
 
478
476
  ```typescript
479
477
  await client.audiences.get({
480
- id: "aud_abc123",
478
+ id: "aud_abc123"
481
479
  });
482
- ```
483
480
 
481
+ ```
484
482
  </dd>
485
483
  </dl>
486
484
  </dd>
@@ -494,21 +492,22 @@ await client.audiences.get({
494
492
  <dl>
495
493
  <dd>
496
494
 
497
- **request:** `Pinnacle.AudiencesGetRequest`
498
-
495
+ **request:** `Pinnacle.AudiencesGetRequest`
496
+
499
497
  </dd>
500
498
  </dl>
501
499
 
502
500
  <dl>
503
501
  <dd>
504
502
 
505
- **requestOptions:** `Audiences.RequestOptions`
506
-
503
+ **requestOptions:** `Audiences.RequestOptions`
504
+
507
505
  </dd>
508
506
  </dl>
509
507
  </dd>
510
508
  </dl>
511
509
 
510
+
512
511
  </dd>
513
512
  </dl>
514
513
  </details>
@@ -526,7 +525,6 @@ await client.audiences.get({
526
525
  <dd>
527
526
 
528
527
  Create a new audience with optional initial contacts. Phone numbers that don't exist will be auto-created as contacts.
529
-
530
528
  </dd>
531
529
  </dl>
532
530
  </dd>
@@ -543,10 +541,10 @@ Create a new audience with optional initial contacts. Phone numbers that don't e
543
541
  ```typescript
544
542
  await client.audiences.create({
545
543
  name: "Marketing Campaign Q1",
546
- description: "Contacts for Q1 marketing push",
544
+ description: "Contacts for Q1 marketing push"
547
545
  });
548
- ```
549
546
 
547
+ ```
550
548
  </dd>
551
549
  </dl>
552
550
  </dd>
@@ -560,21 +558,22 @@ await client.audiences.create({
560
558
  <dl>
561
559
  <dd>
562
560
 
563
- **request:** `Pinnacle.CreateAudienceParams`
564
-
561
+ **request:** `Pinnacle.CreateAudienceParams`
562
+
565
563
  </dd>
566
564
  </dl>
567
565
 
568
566
  <dl>
569
567
  <dd>
570
568
 
571
- **requestOptions:** `Audiences.RequestOptions`
572
-
569
+ **requestOptions:** `Audiences.RequestOptions`
570
+
573
571
  </dd>
574
572
  </dl>
575
573
  </dd>
576
574
  </dl>
577
575
 
576
+
578
577
  </dd>
579
578
  </dl>
580
579
  </details>
@@ -594,7 +593,6 @@ await client.audiences.create({
594
593
  Permanently delete an audience and all its contact associations.
595
594
 
596
595
  Note: This will NOT delete the contacts themselves, only the audience and its memberships.
597
-
598
596
  </dd>
599
597
  </dl>
600
598
  </dd>
@@ -610,10 +608,10 @@ Note: This will NOT delete the contacts themselves, only the audience and its me
610
608
 
611
609
  ```typescript
612
610
  await client.audiences.delete({
613
- id: "aud_abc123",
611
+ id: "aud_abc123"
614
612
  });
615
- ```
616
613
 
614
+ ```
617
615
  </dd>
618
616
  </dl>
619
617
  </dd>
@@ -627,21 +625,22 @@ await client.audiences.delete({
627
625
  <dl>
628
626
  <dd>
629
627
 
630
- **request:** `Pinnacle.AudiencesDeleteRequest`
631
-
628
+ **request:** `Pinnacle.AudiencesDeleteRequest`
629
+
632
630
  </dd>
633
631
  </dl>
634
632
 
635
633
  <dl>
636
634
  <dd>
637
635
 
638
- **requestOptions:** `Audiences.RequestOptions`
639
-
636
+ **requestOptions:** `Audiences.RequestOptions`
637
+
640
638
  </dd>
641
639
  </dl>
642
640
  </dd>
643
641
  </dl>
644
642
 
643
+
645
644
  </dd>
646
645
  </dl>
647
646
  </details>
@@ -661,7 +660,6 @@ await client.audiences.delete({
661
660
  Update audience metadata. This endpoint does NOT modify contacts.
662
661
 
663
662
  To add or remove contacts, use the [Add Contacts](/api-reference/audiences/add-contacts) or [Remove Contacts](/api-reference/audiences/remove-contacts) endpoints.
664
-
665
663
  </dd>
666
664
  </dl>
667
665
  </dd>
@@ -679,10 +677,10 @@ To add or remove contacts, use the [Add Contacts](/api-reference/audiences/add-c
679
677
  await client.audiences.update({
680
678
  id: "aud_abc123",
681
679
  name: "Updated Audience Name",
682
- description: "New description",
680
+ description: "New description"
683
681
  });
684
- ```
685
682
 
683
+ ```
686
684
  </dd>
687
685
  </dl>
688
686
  </dd>
@@ -696,27 +694,27 @@ await client.audiences.update({
696
694
  <dl>
697
695
  <dd>
698
696
 
699
- **request:** `Pinnacle.UpdateAudienceParams`
700
-
697
+ **request:** `Pinnacle.UpdateAudienceParams`
698
+
701
699
  </dd>
702
700
  </dl>
703
701
 
704
702
  <dl>
705
703
  <dd>
706
704
 
707
- **requestOptions:** `Audiences.RequestOptions`
708
-
705
+ **requestOptions:** `Audiences.RequestOptions`
706
+
709
707
  </dd>
710
708
  </dl>
711
709
  </dd>
712
710
  </dl>
713
711
 
712
+
714
713
  </dd>
715
714
  </dl>
716
715
  </details>
717
716
 
718
717
  ## Contacts
719
-
720
718
  <details><summary><code>client.contacts.<a href="/src/api/resources/contacts/client/Client.ts">get</a>({ ...params }) -> Pinnacle.Contact</code></summary>
721
719
  <dl>
722
720
  <dd>
@@ -730,7 +728,6 @@ await client.audiences.update({
730
728
  <dd>
731
729
 
732
730
  Retrieve contact information for a given number.
733
-
734
731
  </dd>
735
732
  </dl>
736
733
  </dd>
@@ -746,10 +743,10 @@ Retrieve contact information for a given number.
746
743
 
747
744
  ```typescript
748
745
  await client.contacts.get({
749
- id: "co_1234567890",
746
+ id: "co_1234567890"
750
747
  });
751
- ```
752
748
 
749
+ ```
753
750
  </dd>
754
751
  </dl>
755
752
  </dd>
@@ -763,21 +760,22 @@ await client.contacts.get({
763
760
  <dl>
764
761
  <dd>
765
762
 
766
- **request:** `Pinnacle.ContactsGetRequest`
767
-
763
+ **request:** `Pinnacle.ContactsGetRequest`
764
+
768
765
  </dd>
769
766
  </dl>
770
767
 
771
768
  <dl>
772
769
  <dd>
773
770
 
774
- **requestOptions:** `Contacts.RequestOptions`
775
-
771
+ **requestOptions:** `Contacts.RequestOptions`
772
+
776
773
  </dd>
777
774
  </dl>
778
775
  </dd>
779
776
  </dl>
780
777
 
778
+
781
779
  </dd>
782
780
  </dl>
783
781
  </details>
@@ -795,7 +793,6 @@ await client.contacts.get({
795
793
  <dd>
796
794
 
797
795
  Create a new contact for a given phone number.
798
-
799
796
  </dd>
800
797
  </dl>
801
798
  </dd>
@@ -811,10 +808,10 @@ Create a new contact for a given phone number.
811
808
 
812
809
  ```typescript
813
810
  await client.contacts.create({
814
- phoneNumber: "phoneNumber",
811
+ phoneNumber: "phoneNumber"
815
812
  });
816
- ```
817
813
 
814
+ ```
818
815
  </dd>
819
816
  </dl>
820
817
  </dd>
@@ -828,21 +825,22 @@ await client.contacts.create({
828
825
  <dl>
829
826
  <dd>
830
827
 
831
- **request:** `Pinnacle.CreateContactParams`
832
-
828
+ **request:** `Pinnacle.CreateContactParams`
829
+
833
830
  </dd>
834
831
  </dl>
835
832
 
836
833
  <dl>
837
834
  <dd>
838
835
 
839
- **requestOptions:** `Contacts.RequestOptions`
840
-
836
+ **requestOptions:** `Contacts.RequestOptions`
837
+
841
838
  </dd>
842
839
  </dl>
843
840
  </dd>
844
841
  </dl>
845
842
 
843
+
846
844
  </dd>
847
845
  </dl>
848
846
  </details>
@@ -860,7 +858,6 @@ await client.contacts.create({
860
858
  <dd>
861
859
 
862
860
  Update an existing contact.
863
-
864
861
  </dd>
865
862
  </dl>
866
863
  </dd>
@@ -880,10 +877,10 @@ await client.contacts.update({
880
877
  email: "alvaroopedtech@pinnacle.sh",
881
878
  name: "Retired Bestie",
882
879
  tags: ["friend"],
883
- id: "co_1234567890",
880
+ id: "co_1234567890"
884
881
  });
885
- ```
886
882
 
883
+ ```
887
884
  </dd>
888
885
  </dl>
889
886
  </dd>
@@ -897,27 +894,27 @@ await client.contacts.update({
897
894
  <dl>
898
895
  <dd>
899
896
 
900
- **request:** `Pinnacle.UpdateContactParams`
901
-
897
+ **request:** `Pinnacle.UpdateContactParams`
898
+
902
899
  </dd>
903
900
  </dl>
904
901
 
905
902
  <dl>
906
903
  <dd>
907
904
 
908
- **requestOptions:** `Contacts.RequestOptions`
909
-
905
+ **requestOptions:** `Contacts.RequestOptions`
906
+
910
907
  </dd>
911
908
  </dl>
912
909
  </dd>
913
910
  </dl>
914
911
 
912
+
915
913
  </dd>
916
914
  </dl>
917
915
  </details>
918
916
 
919
917
  ## Conversations
920
-
921
918
  <details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">get</a>({ ...params }) -> Pinnacle.Conversation | null</code></summary>
922
919
  <dl>
923
920
  <dd>
@@ -931,7 +928,6 @@ await client.contacts.update({
931
928
  <dd>
932
929
 
933
930
  Fetch a specific conversation using either its unique identifier or by matching sender and recipient details.
934
-
935
931
  </dd>
936
932
  </dl>
937
933
  </dd>
@@ -947,10 +943,10 @@ Fetch a specific conversation using either its unique identifier or by matching
947
943
 
948
944
  ```typescript
949
945
  await client.conversations.get({
950
- id: "conv_1234567890",
946
+ id: "conv_1234567890"
951
947
  });
952
- ```
953
948
 
949
+ ```
954
950
  </dd>
955
951
  </dl>
956
952
  </dd>
@@ -964,21 +960,22 @@ await client.conversations.get({
964
960
  <dl>
965
961
  <dd>
966
962
 
967
- **request:** `Pinnacle.GetConversationParams`
968
-
963
+ **request:** `Pinnacle.GetConversationParams`
964
+
969
965
  </dd>
970
966
  </dl>
971
967
 
972
968
  <dl>
973
969
  <dd>
974
970
 
975
- **requestOptions:** `Conversations.RequestOptions`
976
-
971
+ **requestOptions:** `Conversations.RequestOptions`
972
+
977
973
  </dd>
978
974
  </dl>
979
975
  </dd>
980
976
  </dl>
981
977
 
978
+
982
979
  </dd>
983
980
  </dl>
984
981
  </details>
@@ -996,7 +993,6 @@ await client.conversations.get({
996
993
  <dd>
997
994
 
998
995
  Retrieves conversations by page with optional filtering based off provided parameters.
999
-
1000
996
  </dd>
1001
997
  </dl>
1002
998
  </dd>
@@ -1018,10 +1014,10 @@ await client.conversations.list({
1018
1014
  pageIndex: 0,
1019
1015
  pageSize: 20,
1020
1016
  receiver: "+16509231662",
1021
- sender: "+18445551234",
1017
+ sender: "+18445551234"
1022
1018
  });
1023
- ```
1024
1019
 
1020
+ ```
1025
1021
  </dd>
1026
1022
  </dl>
1027
1023
  </dd>
@@ -1035,21 +1031,22 @@ await client.conversations.list({
1035
1031
  <dl>
1036
1032
  <dd>
1037
1033
 
1038
- **request:** `Pinnacle.ListConversationsParams`
1039
-
1034
+ **request:** `Pinnacle.ListConversationsParams`
1035
+
1040
1036
  </dd>
1041
1037
  </dl>
1042
1038
 
1043
1039
  <dl>
1044
1040
  <dd>
1045
1041
 
1046
- **requestOptions:** `Conversations.RequestOptions`
1047
-
1042
+ **requestOptions:** `Conversations.RequestOptions`
1043
+
1048
1044
  </dd>
1049
1045
  </dl>
1050
1046
  </dd>
1051
1047
  </dl>
1052
1048
 
1049
+
1053
1050
  </dd>
1054
1051
  </dl>
1055
1052
  </details>
@@ -1067,7 +1064,6 @@ await client.conversations.list({
1067
1064
  <dd>
1068
1065
 
1069
1066
  Update the notes associated with a specific conversation.
1070
-
1071
1067
  </dd>
1072
1068
  </dl>
1073
1069
  </dd>
@@ -1084,10 +1080,10 @@ Update the notes associated with a specific conversation.
1084
1080
  ```typescript
1085
1081
  await client.conversations.update({
1086
1082
  id: "conv_1234567890",
1087
- notes: "Follow-up completed. Customer satisfied with resolution.",
1083
+ notes: "Follow-up completed. Customer satisfied with resolution."
1088
1084
  });
1089
- ```
1090
1085
 
1086
+ ```
1091
1087
  </dd>
1092
1088
  </dl>
1093
1089
  </dd>
@@ -1101,21 +1097,22 @@ await client.conversations.update({
1101
1097
  <dl>
1102
1098
  <dd>
1103
1099
 
1104
- **request:** `Pinnacle.UpdateConversationParams`
1105
-
1100
+ **request:** `Pinnacle.UpdateConversationParams`
1101
+
1106
1102
  </dd>
1107
1103
  </dl>
1108
1104
 
1109
1105
  <dl>
1110
1106
  <dd>
1111
1107
 
1112
- **requestOptions:** `Conversations.RequestOptions`
1113
-
1108
+ **requestOptions:** `Conversations.RequestOptions`
1109
+
1114
1110
  </dd>
1115
1111
  </dl>
1116
1112
  </dd>
1117
1113
  </dl>
1118
1114
 
1115
+
1119
1116
  </dd>
1120
1117
  </dl>
1121
1118
  </details>
@@ -1133,7 +1130,6 @@ await client.conversations.update({
1133
1130
  <dd>
1134
1131
 
1135
1132
  Retrieve a paginated and filtered list of messages for a specific conversation.
1136
-
1137
1133
  </dd>
1138
1134
  </dl>
1139
1135
  </dd>
@@ -1149,8 +1145,8 @@ Retrieve a paginated and filtered list of messages for a specific conversation.
1149
1145
 
1150
1146
  ```typescript
1151
1147
  await client.conversations.listMessages("id");
1152
- ```
1153
1148
 
1149
+ ```
1154
1150
  </dd>
1155
1151
  </dl>
1156
1152
  </dd>
@@ -1165,34 +1161,34 @@ await client.conversations.listMessages("id");
1165
1161
  <dd>
1166
1162
 
1167
1163
  **id:** `string` — Unique identifier of the conversation. This identifier is a string that always begins with the prefix `conv_`, for example: `conv_1234567890`.
1168
-
1164
+
1169
1165
  </dd>
1170
1166
  </dl>
1171
1167
 
1172
1168
  <dl>
1173
1169
  <dd>
1174
1170
 
1175
- **request:** `Pinnacle.ConversationsListMessagesRequest`
1176
-
1171
+ **request:** `Pinnacle.ConversationsListMessagesRequest`
1172
+
1177
1173
  </dd>
1178
1174
  </dl>
1179
1175
 
1180
1176
  <dl>
1181
1177
  <dd>
1182
1178
 
1183
- **requestOptions:** `Conversations.RequestOptions`
1184
-
1179
+ **requestOptions:** `Conversations.RequestOptions`
1180
+
1185
1181
  </dd>
1186
1182
  </dl>
1187
1183
  </dd>
1188
1184
  </dl>
1189
1185
 
1186
+
1190
1187
  </dd>
1191
1188
  </dl>
1192
1189
  </details>
1193
1190
 
1194
1191
  ## Messages
1195
-
1196
1192
  <details><summary><code>client.messages.<a href="/src/api/resources/messages/client/Client.ts">get</a>(id) -> Pinnacle.Message</code></summary>
1197
1193
  <dl>
1198
1194
  <dd>
@@ -1206,7 +1202,6 @@ await client.conversations.listMessages("id");
1206
1202
  <dd>
1207
1203
 
1208
1204
  Retrieve a previously sent message.
1209
-
1210
1205
  </dd>
1211
1206
  </dl>
1212
1207
  </dd>
@@ -1222,8 +1217,8 @@ Retrieve a previously sent message.
1222
1217
 
1223
1218
  ```typescript
1224
1219
  await client.messages.get("msg_1234567890");
1225
- ```
1226
1220
 
1221
+ ```
1227
1222
  </dd>
1228
1223
  </dl>
1229
1224
  </dd>
@@ -1238,20 +1233,21 @@ await client.messages.get("msg_1234567890");
1238
1233
  <dd>
1239
1234
 
1240
1235
  **id:** `string` — Unique identifier of the message. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`.
1241
-
1236
+
1242
1237
  </dd>
1243
1238
  </dl>
1244
1239
 
1245
1240
  <dl>
1246
1241
  <dd>
1247
1242
 
1248
- **requestOptions:** `Messages.RequestOptions`
1249
-
1243
+ **requestOptions:** `Messages.RequestOptions`
1244
+
1250
1245
  </dd>
1251
1246
  </dl>
1252
1247
  </dd>
1253
1248
  </dl>
1254
1249
 
1250
+
1255
1251
  </dd>
1256
1252
  </dl>
1257
1253
  </details>
@@ -1269,7 +1265,6 @@ await client.messages.get("msg_1234567890");
1269
1265
  <dd>
1270
1266
 
1271
1267
  Add or remove an emoji reaction to a previously sent message.
1272
-
1273
1268
  </dd>
1274
1269
  </dl>
1275
1270
  </dd>
@@ -1287,12 +1282,12 @@ Add or remove an emoji reaction to a previously sent message.
1287
1282
  await client.messages.react({
1288
1283
  messageId: "msg_1234567890",
1289
1284
  options: {
1290
- force: true,
1285
+ force: true
1291
1286
  },
1292
- reaction: "\uD83D\uDC4D",
1287
+ reaction: "\uD83D\uDC4D"
1293
1288
  });
1294
- ```
1295
1289
 
1290
+ ```
1296
1291
  </dd>
1297
1292
  </dl>
1298
1293
  </dd>
@@ -1306,27 +1301,27 @@ await client.messages.react({
1306
1301
  <dl>
1307
1302
  <dd>
1308
1303
 
1309
- **request:** `Pinnacle.ReactMessageParams`
1310
-
1304
+ **request:** `Pinnacle.ReactMessageParams`
1305
+
1311
1306
  </dd>
1312
1307
  </dl>
1313
1308
 
1314
1309
  <dl>
1315
1310
  <dd>
1316
1311
 
1317
- **requestOptions:** `Messages.RequestOptions`
1318
-
1312
+ **requestOptions:** `Messages.RequestOptions`
1313
+
1319
1314
  </dd>
1320
1315
  </dl>
1321
1316
  </dd>
1322
1317
  </dl>
1323
1318
 
1319
+
1324
1320
  </dd>
1325
1321
  </dl>
1326
1322
  </details>
1327
1323
 
1328
1324
  ## PhoneNumbers
1329
-
1330
1325
  <details><summary><code>client.phoneNumbers.<a href="/src/api/resources/phoneNumbers/client/Client.ts">search</a>({ ...params }) -> Pinnacle.PhoneNumberDetails[]</code></summary>
1331
1326
  <dl>
1332
1327
  <dd>
@@ -1340,7 +1335,6 @@ await client.messages.react({
1340
1335
  <dd>
1341
1336
 
1342
1337
  Search for available phone numbers that match your exact criteria.
1343
-
1344
1338
  </dd>
1345
1339
  </dl>
1346
1340
  </dd>
@@ -1359,19 +1353,19 @@ await client.phoneNumbers.search({
1359
1353
  features: ["SMS", "MMS"],
1360
1354
  location: {
1361
1355
  city: "New York",
1362
- nationalDestinationCode: "212",
1356
+ nationalDestinationCode: "212"
1363
1357
  },
1364
1358
  number: {
1365
1359
  contains: "514",
1366
- startsWith: "45",
1360
+ startsWith: "45"
1367
1361
  },
1368
1362
  options: {
1369
- limit: 4,
1363
+ limit: 4
1370
1364
  },
1371
- type: ["LOCAL"],
1365
+ type: ["LOCAL"]
1372
1366
  });
1373
- ```
1374
1367
 
1368
+ ```
1375
1369
  </dd>
1376
1370
  </dl>
1377
1371
  </dd>
@@ -1385,21 +1379,22 @@ await client.phoneNumbers.search({
1385
1379
  <dl>
1386
1380
  <dd>
1387
1381
 
1388
- **request:** `Pinnacle.SearchPhoneNumberParams`
1389
-
1382
+ **request:** `Pinnacle.SearchPhoneNumberParams`
1383
+
1390
1384
  </dd>
1391
1385
  </dl>
1392
1386
 
1393
1387
  <dl>
1394
1388
  <dd>
1395
1389
 
1396
- **requestOptions:** `PhoneNumbers.RequestOptions`
1397
-
1390
+ **requestOptions:** `PhoneNumbers.RequestOptions`
1391
+
1398
1392
  </dd>
1399
1393
  </dl>
1400
1394
  </dd>
1401
1395
  </dl>
1402
1396
 
1397
+
1403
1398
  </dd>
1404
1399
  </dl>
1405
1400
  </details>
@@ -1419,7 +1414,6 @@ await client.phoneNumbers.search({
1419
1414
  Purchase one or more phone numbers found through the [search endpoint](./search). <br>
1420
1415
 
1421
1416
  Billing uses your account credits and the numbers are ready for immediate use.
1422
-
1423
1417
  </dd>
1424
1418
  </dl>
1425
1419
  </dd>
@@ -1435,10 +1429,10 @@ Billing uses your account credits and the numbers are ready for immediate use.
1435
1429
 
1436
1430
  ```typescript
1437
1431
  await client.phoneNumbers.buy({
1438
- numbers: ["+18559491727"],
1432
+ numbers: ["+18559491727"]
1439
1433
  });
1440
- ```
1441
1434
 
1435
+ ```
1442
1436
  </dd>
1443
1437
  </dl>
1444
1438
  </dd>
@@ -1452,21 +1446,22 @@ await client.phoneNumbers.buy({
1452
1446
  <dl>
1453
1447
  <dd>
1454
1448
 
1455
- **request:** `Pinnacle.BuyPhoneNumberParams`
1456
-
1449
+ **request:** `Pinnacle.BuyPhoneNumberParams`
1450
+
1457
1451
  </dd>
1458
1452
  </dl>
1459
1453
 
1460
1454
  <dl>
1461
1455
  <dd>
1462
1456
 
1463
- **requestOptions:** `PhoneNumbers.RequestOptions`
1464
-
1457
+ **requestOptions:** `PhoneNumbers.RequestOptions`
1458
+
1465
1459
  </dd>
1466
1460
  </dl>
1467
1461
  </dd>
1468
1462
  </dl>
1469
1463
 
1464
+
1470
1465
  </dd>
1471
1466
  </dl>
1472
1467
  </details>
@@ -1484,7 +1479,6 @@ await client.phoneNumbers.buy({
1484
1479
  <dd>
1485
1480
 
1486
1481
  Retrieve information about any phone number.
1487
-
1488
1482
  </dd>
1489
1483
  </dl>
1490
1484
  </dd>
@@ -1505,12 +1499,12 @@ await client.phoneNumbers.get({
1505
1499
  options: {
1506
1500
  risk: true,
1507
1501
  enhanced_contact_info: {
1508
- context: "This is my friend from JZ. He has done a lot in the crypto space.",
1509
- },
1510
- },
1502
+ context: "This is my friend from JZ. He has done a lot in the crypto space."
1503
+ }
1504
+ }
1511
1505
  });
1512
- ```
1513
1506
 
1507
+ ```
1514
1508
  </dd>
1515
1509
  </dl>
1516
1510
  </dd>
@@ -1524,27 +1518,27 @@ await client.phoneNumbers.get({
1524
1518
  <dl>
1525
1519
  <dd>
1526
1520
 
1527
- **request:** `Pinnacle.RetrievePhoneNumberDetailsParams`
1528
-
1521
+ **request:** `Pinnacle.RetrievePhoneNumberDetailsParams`
1522
+
1529
1523
  </dd>
1530
1524
  </dl>
1531
1525
 
1532
1526
  <dl>
1533
1527
  <dd>
1534
1528
 
1535
- **requestOptions:** `PhoneNumbers.RequestOptions`
1536
-
1529
+ **requestOptions:** `PhoneNumbers.RequestOptions`
1530
+
1537
1531
  </dd>
1538
1532
  </dl>
1539
1533
  </dd>
1540
1534
  </dl>
1541
1535
 
1536
+
1542
1537
  </dd>
1543
1538
  </dl>
1544
1539
  </details>
1545
1540
 
1546
1541
  ## RCS
1547
-
1548
1542
  <details><summary><code>client.rcs.<a href="/src/api/resources/rcs/client/Client.ts">getCapabilities</a>({ ...params }) -> Pinnacle.RcsCapabilitiesResult</code></summary>
1549
1543
  <dl>
1550
1544
  <dd>
@@ -1561,7 +1555,6 @@ Check RCS capabilities for one or more phone numbers.
1561
1555
 
1562
1556
  This endpoint allows you to verify which RCS features (cards, buttons, etc.) are supported
1563
1557
  on specific phone numbers before sending RCS messages to them.
1564
-
1565
1558
  </dd>
1566
1559
  </dl>
1567
1560
  </dd>
@@ -1577,10 +1570,10 @@ on specific phone numbers before sending RCS messages to them.
1577
1570
 
1578
1571
  ```typescript
1579
1572
  await client.rcs.getCapabilities({
1580
- phoneNumbers: ["+12345678901", "+19876543210"],
1573
+ phoneNumbers: ["+12345678901", "+19876543210"]
1581
1574
  });
1582
- ```
1583
1575
 
1576
+ ```
1584
1577
  </dd>
1585
1578
  </dl>
1586
1579
  </dd>
@@ -1594,21 +1587,22 @@ await client.rcs.getCapabilities({
1594
1587
  <dl>
1595
1588
  <dd>
1596
1589
 
1597
- **request:** `Pinnacle.RcsCapabilitiesQuery`
1598
-
1590
+ **request:** `Pinnacle.RcsCapabilitiesQuery`
1591
+
1599
1592
  </dd>
1600
1593
  </dl>
1601
1594
 
1602
1595
  <dl>
1603
1596
  <dd>
1604
1597
 
1605
- **requestOptions:** `Rcs.RequestOptions`
1606
-
1598
+ **requestOptions:** `Rcs.RequestOptions`
1599
+
1607
1600
  </dd>
1608
1601
  </dl>
1609
1602
  </dd>
1610
1603
  </dl>
1611
1604
 
1605
+
1612
1606
  </dd>
1613
1607
  </dl>
1614
1608
  </details>
@@ -1628,22 +1622,20 @@ await client.rcs.getCapabilities({
1628
1622
  Whitelist a phone number for testing with your test RCS agent.
1629
1623
 
1630
1624
  ## Overview
1631
-
1632
1625
  During development and testing, RCS agents can only send messages to whitelisted phone numbers.
1633
1626
  Use this endpoint to whitelist specific phone numbers to send and receive messages from the test agent.
1634
1627
 
1635
1628
  ## Verification Process
1636
-
1637
1629
  After whitelisting a number, you'll need to complete verification:
1638
1630
 
1639
1631
  1. Check the test device for message from "RBM Tester Management"
1640
1632
  2. Click the "Make me a tester" button
1641
1633
  3. Enter the separate 4-digit verification SMS code in the Pinnacle dashboard at:
1642
- ```
1643
- https://app.pinnacle.sh/dashboard/brands/{brandId}?campaignId={campaignId}&campaignType=RCS
1644
- ```
1634
+ ```
1635
+ https://app.pinnacle.sh/dashboard/brands/{brandId}?campaignId={campaignId}&campaignType=RCS
1636
+ ```
1645
1637
 
1646
- > **⚠️ Important: Re-whitelisting Numbers**
1638
+ > **⚠️ Important: Re-whitelisting Numbers**
1647
1639
  >
1648
1640
  > If you whitelist a number that's already whitelisted, you'll receive a new message from "RBM Tester Management". **You must click the "Make me a tester" button again to continue sending and receiving messages.**
1649
1641
 
@@ -1652,7 +1644,6 @@ After whitelisting a number, you'll need to complete verification:
1652
1644
  > - **Verification required:** Messages cannot be sent nor received until you have clicked the "Make me a tester" button on the test device.
1653
1645
  > - **Testing only:** This is only required for test agents. Production agents can message any RCS-enabled number.
1654
1646
  > - **Network limitations:** Whitelisting may be temporarily unavailable for some carriers but are usually restored shortly.
1655
-
1656
1647
  </dd>
1657
1648
  </dl>
1658
1649
  </dd>
@@ -1669,10 +1660,10 @@ After whitelisting a number, you'll need to complete verification:
1669
1660
  ```typescript
1670
1661
  await client.rcs.whitelist({
1671
1662
  agentId: "agent_XXXXXXXXXXXX",
1672
- phoneNumber: "+12345678901",
1663
+ phoneNumber: "+12345678901"
1673
1664
  });
1674
- ```
1675
1665
 
1666
+ ```
1676
1667
  </dd>
1677
1668
  </dl>
1678
1669
  </dd>
@@ -1686,21 +1677,22 @@ await client.rcs.whitelist({
1686
1677
  <dl>
1687
1678
  <dd>
1688
1679
 
1689
- **request:** `Pinnacle.RcsWhitelistRequest`
1690
-
1680
+ **request:** `Pinnacle.RcsWhitelistRequest`
1681
+
1691
1682
  </dd>
1692
1683
  </dl>
1693
1684
 
1694
1685
  <dl>
1695
1686
  <dd>
1696
1687
 
1697
- **requestOptions:** `Rcs.RequestOptions`
1698
-
1688
+ **requestOptions:** `Rcs.RequestOptions`
1689
+
1699
1690
  </dd>
1700
1691
  </dl>
1701
1692
  </dd>
1702
1693
  </dl>
1703
1694
 
1695
+
1704
1696
  </dd>
1705
1697
  </dl>
1706
1698
  </details>
@@ -1717,11 +1709,10 @@ await client.rcs.whitelist({
1717
1709
  <dl>
1718
1710
  <dd>
1719
1711
 
1720
- Generate a link for initiating an RCS conversation with your agent.
1712
+ Generate a link for initiating an RCS conversation with your agent.
1721
1713
 
1722
1714
  Users can click these links to start conversations with your RCS agent directly
1723
1715
  from websites, emails, or other applications.
1724
-
1725
1716
  </dd>
1726
1717
  </dl>
1727
1718
  </dd>
@@ -1740,10 +1731,10 @@ await client.rcs.getLink({
1740
1731
  agentId: "agent_XXXXXXXXXXXX",
1741
1732
  testMode: false,
1742
1733
  phoneNumber: "+12345678901",
1743
- body: "Hello, I need help with my order",
1734
+ body: "Hello, I need help with my order"
1744
1735
  });
1745
- ```
1746
1736
 
1737
+ ```
1747
1738
  </dd>
1748
1739
  </dl>
1749
1740
  </dd>
@@ -1757,27 +1748,27 @@ await client.rcs.getLink({
1757
1748
  <dl>
1758
1749
  <dd>
1759
1750
 
1760
- **request:** `Pinnacle.RcsLinkRequest`
1761
-
1751
+ **request:** `Pinnacle.RcsLinkRequest`
1752
+
1762
1753
  </dd>
1763
1754
  </dl>
1764
1755
 
1765
1756
  <dl>
1766
1757
  <dd>
1767
1758
 
1768
- **requestOptions:** `Rcs.RequestOptions`
1769
-
1759
+ **requestOptions:** `Rcs.RequestOptions`
1760
+
1770
1761
  </dd>
1771
1762
  </dl>
1772
1763
  </dd>
1773
1764
  </dl>
1774
1765
 
1766
+
1775
1767
  </dd>
1776
1768
  </dl>
1777
1769
  </details>
1778
1770
 
1779
1771
  ## Webhooks
1780
-
1781
1772
  <details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">get</a>({ ...params }) -> Pinnacle.WebhookResult</code></summary>
1782
1773
  <dl>
1783
1774
  <dd>
@@ -1791,7 +1782,6 @@ await client.rcs.getLink({
1791
1782
  <dd>
1792
1783
 
1793
1784
  Retrieve all webhook that are set up to receive events for specific URLs or phone numbers.
1794
-
1795
1785
  </dd>
1796
1786
  </dl>
1797
1787
  </dd>
@@ -1807,15 +1797,10 @@ Retrieve all webhook that are set up to receive events for specific URLs or phon
1807
1797
 
1808
1798
  ```typescript
1809
1799
  await client.webhooks.get({
1810
- identifiers: [
1811
- "https://www.pinnacle.sh/payment",
1812
- "+14155678901",
1813
- "https://www.pinnacle.sh/sms-callback",
1814
- "+14153456659",
1815
- ],
1800
+ identifiers: ["https://www.pinnacle.sh/payment", "+14155678901", "https://www.pinnacle.sh/sms-callback", "+14153456659"]
1816
1801
  });
1817
- ```
1818
1802
 
1803
+ ```
1819
1804
  </dd>
1820
1805
  </dl>
1821
1806
  </dd>
@@ -1829,27 +1814,27 @@ await client.webhooks.get({
1829
1814
  <dl>
1830
1815
  <dd>
1831
1816
 
1832
- **request:** `Pinnacle.GetWebhookParams`
1833
-
1817
+ **request:** `Pinnacle.GetWebhookParams`
1818
+
1834
1819
  </dd>
1835
1820
  </dl>
1836
1821
 
1837
1822
  <dl>
1838
1823
  <dd>
1839
1824
 
1840
- **requestOptions:** `Webhooks.RequestOptions`
1841
-
1825
+ **requestOptions:** `Webhooks.RequestOptions`
1826
+
1842
1827
  </dd>
1843
1828
  </dl>
1844
1829
  </dd>
1845
1830
  </dl>
1846
1831
 
1832
+
1847
1833
  </dd>
1848
1834
  </dl>
1849
1835
  </details>
1850
1836
 
1851
1837
  ## Audiences Contacts
1852
-
1853
1838
  <details><summary><code>client.audiences.contacts.<a href="/src/api/resources/audiences/resources/contacts/client/Client.ts">remove</a>({ ...params }) -> Pinnacle.AudienceCountOnly</code></summary>
1854
1839
  <dl>
1855
1840
  <dd>
@@ -1866,10 +1851,10 @@ Remove contacts from an existing audience. This operation is idempotent.
1866
1851
 
1867
1852
  - Only removes contacts that exist in the audience
1868
1853
  - Contacts not in the audience are ignored
1869
- </dd>
1870
- </dl>
1871
- </dd>
1872
- </dl>
1854
+ </dd>
1855
+ </dl>
1856
+ </dd>
1857
+ </dl>
1873
1858
 
1874
1859
  #### 🔌 Usage
1875
1860
 
@@ -1882,10 +1867,10 @@ Remove contacts from an existing audience. This operation is idempotent.
1882
1867
  ```typescript
1883
1868
  await client.audiences.contacts.remove({
1884
1869
  id: "aud_abc123",
1885
- contacts: ["+12125551234", "co_def456"],
1870
+ contacts: ["+12125551234", "co_def456"]
1886
1871
  });
1887
- ```
1888
1872
 
1873
+ ```
1889
1874
  </dd>
1890
1875
  </dl>
1891
1876
  </dd>
@@ -1899,21 +1884,22 @@ await client.audiences.contacts.remove({
1899
1884
  <dl>
1900
1885
  <dd>
1901
1886
 
1902
- **request:** `Pinnacle.audiences.RemoveContactsParams`
1903
-
1887
+ **request:** `Pinnacle.audiences.RemoveContactsParams`
1888
+
1904
1889
  </dd>
1905
1890
  </dl>
1906
1891
 
1907
1892
  <dl>
1908
1893
  <dd>
1909
1894
 
1910
- **requestOptions:** `Contacts.RequestOptions`
1911
-
1895
+ **requestOptions:** `Contacts.RequestOptions`
1896
+
1912
1897
  </dd>
1913
1898
  </dl>
1914
1899
  </dd>
1915
1900
  </dl>
1916
1901
 
1902
+
1917
1903
  </dd>
1918
1904
  </dl>
1919
1905
  </details>
@@ -1935,10 +1921,10 @@ Add contacts to an existing audience. This operation is additive and idempotent.
1935
1921
  - Phone numbers that don't exist will be auto-created as contacts
1936
1922
  - Duplicate adds are ignored
1937
1923
  - Contacts already in the audience are ignored
1938
- </dd>
1939
- </dl>
1940
- </dd>
1941
- </dl>
1924
+ </dd>
1925
+ </dl>
1926
+ </dd>
1927
+ </dl>
1942
1928
 
1943
1929
  #### 🔌 Usage
1944
1930
 
@@ -1951,10 +1937,10 @@ Add contacts to an existing audience. This operation is additive and idempotent.
1951
1937
  ```typescript
1952
1938
  await client.audiences.contacts.add({
1953
1939
  id: "aud_abc123",
1954
- contacts: ["+12125551234", "co_def456", "+13105551234"],
1940
+ contacts: ["+12125551234", "co_def456", "+13105551234"]
1955
1941
  });
1956
- ```
1957
1942
 
1943
+ ```
1958
1944
  </dd>
1959
1945
  </dl>
1960
1946
  </dd>
@@ -1968,27 +1954,27 @@ await client.audiences.contacts.add({
1968
1954
  <dl>
1969
1955
  <dd>
1970
1956
 
1971
- **request:** `Pinnacle.audiences.AddContactsParams`
1972
-
1957
+ **request:** `Pinnacle.audiences.AddContactsParams`
1958
+
1973
1959
  </dd>
1974
1960
  </dl>
1975
1961
 
1976
1962
  <dl>
1977
1963
  <dd>
1978
1964
 
1979
- **requestOptions:** `Contacts.RequestOptions`
1980
-
1965
+ **requestOptions:** `Contacts.RequestOptions`
1966
+
1981
1967
  </dd>
1982
1968
  </dl>
1983
1969
  </dd>
1984
1970
  </dl>
1985
1971
 
1972
+
1986
1973
  </dd>
1987
1974
  </dl>
1988
1975
  </details>
1989
1976
 
1990
1977
  ## Campaigns Dlc
1991
-
1992
1978
  <details><summary><code>client.campaigns.dlc.<a href="/src/api/resources/campaigns/resources/dlc/client/Client.ts">autofill</a>({ ...params }) -> Pinnacle.AutofillDlcCampaignResponse</code></summary>
1993
1979
  <dl>
1994
1980
  <dd>
@@ -2002,7 +1988,6 @@ await client.audiences.contacts.add({
2002
1988
  <dd>
2003
1989
 
2004
1990
  Generate campaign details based off existing campaign and the brand it's connected to.
2005
-
2006
1991
  </dd>
2007
1992
  </dl>
2008
1993
  </dd>
@@ -2019,10 +2004,10 @@ Generate campaign details based off existing campaign and the brand it's connect
2019
2004
  ```typescript
2020
2005
  await client.campaigns.dlc.autofill({
2021
2006
  additionalInfo: "Please autofill missing campaign fields using my brand profile",
2022
- campaignId: "dlc_1234567890",
2007
+ campaignId: "dlc_1234567890"
2023
2008
  });
2024
- ```
2025
2009
 
2010
+ ```
2026
2011
  </dd>
2027
2012
  </dl>
2028
2013
  </dd>
@@ -2036,21 +2021,22 @@ await client.campaigns.dlc.autofill({
2036
2021
  <dl>
2037
2022
  <dd>
2038
2023
 
2039
- **request:** `Pinnacle.AutofillCampaignParams`
2040
-
2024
+ **request:** `Pinnacle.AutofillCampaignParams`
2025
+
2041
2026
  </dd>
2042
2027
  </dl>
2043
2028
 
2044
2029
  <dl>
2045
2030
  <dd>
2046
2031
 
2047
- **requestOptions:** `Dlc.RequestOptions`
2048
-
2032
+ **requestOptions:** `Dlc.RequestOptions`
2033
+
2049
2034
  </dd>
2050
2035
  </dl>
2051
2036
  </dd>
2052
2037
  </dl>
2053
2038
 
2039
+
2054
2040
  </dd>
2055
2041
  </dl>
2056
2042
  </details>
@@ -2068,7 +2054,6 @@ await client.campaigns.dlc.autofill({
2068
2054
  <dd>
2069
2055
 
2070
2056
  Retrieve 10DLC campaign.
2071
-
2072
2057
  </dd>
2073
2058
  </dl>
2074
2059
  </dd>
@@ -2084,8 +2069,8 @@ Retrieve 10DLC campaign.
2084
2069
 
2085
2070
  ```typescript
2086
2071
  await client.campaigns.dlc.get("dlc_1234567890");
2087
- ```
2088
2072
 
2073
+ ```
2089
2074
  </dd>
2090
2075
  </dl>
2091
2076
  </dd>
@@ -2100,20 +2085,21 @@ await client.campaigns.dlc.get("dlc_1234567890");
2100
2085
  <dd>
2101
2086
 
2102
2087
  **campaignId:** `string` — Unique identifier of the 10DLC campaign. This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`.
2103
-
2088
+
2104
2089
  </dd>
2105
2090
  </dl>
2106
2091
 
2107
2092
  <dl>
2108
2093
  <dd>
2109
2094
 
2110
- **requestOptions:** `Dlc.RequestOptions`
2111
-
2095
+ **requestOptions:** `Dlc.RequestOptions`
2096
+
2112
2097
  </dd>
2113
2098
  </dl>
2114
2099
  </dd>
2115
2100
  </dl>
2116
2101
 
2102
+
2117
2103
  </dd>
2118
2104
  </dl>
2119
2105
  </details>
@@ -2131,7 +2117,6 @@ await client.campaigns.dlc.get("dlc_1234567890");
2131
2117
  <dd>
2132
2118
 
2133
2119
  Submit your 10DLC campaign for approval and activation with carriers.
2134
-
2135
2120
  </dd>
2136
2121
  </dl>
2137
2122
  </dd>
@@ -2147,8 +2132,8 @@ Submit your 10DLC campaign for approval and activation with carriers.
2147
2132
 
2148
2133
  ```typescript
2149
2134
  await client.campaigns.dlc.submit("dlc_1234567890");
2150
- ```
2151
2135
 
2136
+ ```
2152
2137
  </dd>
2153
2138
  </dl>
2154
2139
  </dd>
@@ -2162,24 +2147,25 @@ await client.campaigns.dlc.submit("dlc_1234567890");
2162
2147
  <dl>
2163
2148
  <dd>
2164
2149
 
2165
- **campaignId:** `string`
2150
+ **campaignId:** `string`
2166
2151
 
2167
2152
  Unique identifier of the 10DLC campaign to submit.
2168
2153
  <br><br> This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`.
2169
-
2154
+
2170
2155
  </dd>
2171
2156
  </dl>
2172
2157
 
2173
2158
  <dl>
2174
2159
  <dd>
2175
2160
 
2176
- **requestOptions:** `Dlc.RequestOptions`
2177
-
2161
+ **requestOptions:** `Dlc.RequestOptions`
2162
+
2178
2163
  </dd>
2179
2164
  </dl>
2180
2165
  </dd>
2181
2166
  </dl>
2182
2167
 
2168
+
2183
2169
  </dd>
2184
2170
  </dl>
2185
2171
  </details>
@@ -2199,7 +2185,6 @@ Unique identifier of the 10DLC campaign to submit.
2199
2185
  Create a new 10DLC campaign or updates an existing one. <br>
2200
2186
 
2201
2187
  Omit campaignId to create a campaign.
2202
-
2203
2188
  </dd>
2204
2189
  </dl>
2205
2190
  </dd>
@@ -2221,20 +2206,20 @@ await client.campaigns.dlc.upsert({
2221
2206
  keywords: {
2222
2207
  HELP: {
2223
2208
  message: "Reply HELP for assistance, STOP to opt-out",
2224
- values: ["HELP", "INFO", "SUPPORT"],
2209
+ values: ["HELP", "INFO", "SUPPORT"]
2225
2210
  },
2226
2211
  OPT_IN: {
2227
2212
  message: "Welcome. You are now subscribed to Pinnacle.",
2228
- values: ["JOIN", "START", "SUBSCRIBE"],
2213
+ values: ["JOIN", "START", "SUBSCRIBE"]
2229
2214
  },
2230
2215
  OPT_OUT: {
2231
2216
  message: "You have been unsubscribed. Reply START to rejoin.",
2232
- values: ["STOP", "QUIT", "UNSUBSCRIBE"],
2233
- },
2217
+ values: ["STOP", "QUIT", "UNSUBSCRIBE"]
2218
+ }
2234
2219
  },
2235
2220
  links: {
2236
2221
  privacyPolicy: "https://www.pinnacle.sh/privacy",
2237
- termsOfService: "https://www.pinnacle.sh/terms",
2222
+ termsOfService: "https://www.pinnacle.sh/terms"
2238
2223
  },
2239
2224
  messageFlow: "Customer initiates -> Automated response -> Agent follow-up if needed",
2240
2225
  name: "Account Notifications",
@@ -2244,16 +2229,16 @@ await client.campaigns.dlc.upsert({
2244
2229
  directLending: false,
2245
2230
  embeddedLink: "https://www.pinnacle.sh/example",
2246
2231
  embeddedPhone: false,
2247
- numberPooling: false,
2232
+ numberPooling: false
2248
2233
  },
2249
2234
  sampleMessages: ["Security alert: Unusual login detected from new device."],
2250
2235
  useCase: {
2251
2236
  sub: ["FRAUD_ALERT"],
2252
- value: "ACCOUNT_NOTIFICATION",
2253
- },
2237
+ value: "ACCOUNT_NOTIFICATION"
2238
+ }
2254
2239
  });
2255
- ```
2256
2240
 
2241
+ ```
2257
2242
  </dd>
2258
2243
  </dl>
2259
2244
  </dd>
@@ -2267,21 +2252,22 @@ await client.campaigns.dlc.upsert({
2267
2252
  <dl>
2268
2253
  <dd>
2269
2254
 
2270
- **request:** `Pinnacle.campaigns.UpsertDlcCampaignParams`
2271
-
2255
+ **request:** `Pinnacle.campaigns.UpsertDlcCampaignParams`
2256
+
2272
2257
  </dd>
2273
2258
  </dl>
2274
2259
 
2275
2260
  <dl>
2276
2261
  <dd>
2277
2262
 
2278
- **requestOptions:** `Dlc.RequestOptions`
2279
-
2263
+ **requestOptions:** `Dlc.RequestOptions`
2264
+
2280
2265
  </dd>
2281
2266
  </dl>
2282
2267
  </dd>
2283
2268
  </dl>
2284
2269
 
2270
+
2285
2271
  </dd>
2286
2272
  </dl>
2287
2273
  </details>
@@ -2299,7 +2285,6 @@ await client.campaigns.dlc.upsert({
2299
2285
  <dd>
2300
2286
 
2301
2287
  Validate your 10DLC campaign configuration against carrier requirements and compliance rules.
2302
-
2303
2288
  </dd>
2304
2289
  </dl>
2305
2290
  </dd>
@@ -2316,10 +2301,10 @@ Validate your 10DLC campaign configuration against carrier requirements and comp
2316
2301
  ```typescript
2317
2302
  await client.campaigns.dlc.validate({
2318
2303
  additionalInfo: "Please validate this DLC campaign for 10DLC compliance",
2319
- campaignId: "dlc_1234567890",
2304
+ campaignId: "dlc_1234567890"
2320
2305
  });
2321
- ```
2322
2306
 
2307
+ ```
2323
2308
  </dd>
2324
2309
  </dl>
2325
2310
  </dd>
@@ -2333,27 +2318,27 @@ await client.campaigns.dlc.validate({
2333
2318
  <dl>
2334
2319
  <dd>
2335
2320
 
2336
- **request:** `Pinnacle.ValidateCampaignParams`
2337
-
2321
+ **request:** `Pinnacle.ValidateCampaignParams`
2322
+
2338
2323
  </dd>
2339
2324
  </dl>
2340
2325
 
2341
2326
  <dl>
2342
2327
  <dd>
2343
2328
 
2344
- **requestOptions:** `Dlc.RequestOptions`
2345
-
2329
+ **requestOptions:** `Dlc.RequestOptions`
2330
+
2346
2331
  </dd>
2347
2332
  </dl>
2348
2333
  </dd>
2349
2334
  </dl>
2350
2335
 
2336
+
2351
2337
  </dd>
2352
2338
  </dl>
2353
2339
  </details>
2354
2340
 
2355
2341
  ## Campaigns TollFree
2356
-
2357
2342
  <details><summary><code>client.campaigns.tollFree.<a href="/src/api/resources/campaigns/resources/tollFree/client/Client.ts">autofill</a>({ ...params }) -> Pinnacle.TollFreeAutofillResponse</code></summary>
2358
2343
  <dl>
2359
2344
  <dd>
@@ -2367,7 +2352,6 @@ await client.campaigns.dlc.validate({
2367
2352
  <dd>
2368
2353
 
2369
2354
  Generate campaign details based off existing campaign and the brand it's connected to.
2370
-
2371
2355
  </dd>
2372
2356
  </dl>
2373
2357
  </dd>
@@ -2384,10 +2368,10 @@ Generate campaign details based off existing campaign and the brand it's connect
2384
2368
  ```typescript
2385
2369
  await client.campaigns.tollFree.autofill({
2386
2370
  additionalInfo: "Please autofill missing campaign fields using my brand profile",
2387
- campaignId: "dlc_1234567890",
2371
+ campaignId: "dlc_1234567890"
2388
2372
  });
2389
- ```
2390
2373
 
2374
+ ```
2391
2375
  </dd>
2392
2376
  </dl>
2393
2377
  </dd>
@@ -2401,21 +2385,22 @@ await client.campaigns.tollFree.autofill({
2401
2385
  <dl>
2402
2386
  <dd>
2403
2387
 
2404
- **request:** `Pinnacle.AutofillCampaignParams`
2405
-
2388
+ **request:** `Pinnacle.AutofillCampaignParams`
2389
+
2406
2390
  </dd>
2407
2391
  </dl>
2408
2392
 
2409
2393
  <dl>
2410
2394
  <dd>
2411
2395
 
2412
- **requestOptions:** `TollFree.RequestOptions`
2413
-
2396
+ **requestOptions:** `TollFree.RequestOptions`
2397
+
2414
2398
  </dd>
2415
2399
  </dl>
2416
2400
  </dd>
2417
2401
  </dl>
2418
2402
 
2403
+
2419
2404
  </dd>
2420
2405
  </dl>
2421
2406
  </details>
@@ -2433,7 +2418,6 @@ await client.campaigns.tollFree.autofill({
2433
2418
  <dd>
2434
2419
 
2435
2420
  Retrieve Toll-Free campaign.
2436
-
2437
2421
  </dd>
2438
2422
  </dl>
2439
2423
  </dd>
@@ -2449,8 +2433,8 @@ Retrieve Toll-Free campaign.
2449
2433
 
2450
2434
  ```typescript
2451
2435
  await client.campaigns.tollFree.get("tf_1234567890");
2452
- ```
2453
2436
 
2437
+ ```
2454
2438
  </dd>
2455
2439
  </dl>
2456
2440
  </dd>
@@ -2465,20 +2449,21 @@ await client.campaigns.tollFree.get("tf_1234567890");
2465
2449
  <dd>
2466
2450
 
2467
2451
  **campaignId:** `string` — Unique identifier of toll-free campaign. Must begin with the prefix `tf_`.
2468
-
2452
+
2469
2453
  </dd>
2470
2454
  </dl>
2471
2455
 
2472
2456
  <dl>
2473
2457
  <dd>
2474
2458
 
2475
- **requestOptions:** `TollFree.RequestOptions`
2476
-
2459
+ **requestOptions:** `TollFree.RequestOptions`
2460
+
2477
2461
  </dd>
2478
2462
  </dl>
2479
2463
  </dd>
2480
2464
  </dl>
2481
2465
 
2466
+
2482
2467
  </dd>
2483
2468
  </dl>
2484
2469
  </details>
@@ -2496,7 +2481,6 @@ await client.campaigns.tollFree.get("tf_1234567890");
2496
2481
  <dd>
2497
2482
 
2498
2483
  Submit your toll-free campaign for approval and activation with carriers.
2499
-
2500
2484
  </dd>
2501
2485
  </dl>
2502
2486
  </dd>
@@ -2512,8 +2496,8 @@ Submit your toll-free campaign for approval and activation with carriers.
2512
2496
 
2513
2497
  ```typescript
2514
2498
  await client.campaigns.tollFree.submit("tf_1234567890");
2515
- ```
2516
2499
 
2500
+ ```
2517
2501
  </dd>
2518
2502
  </dl>
2519
2503
  </dd>
@@ -2528,20 +2512,21 @@ await client.campaigns.tollFree.submit("tf_1234567890");
2528
2512
  <dd>
2529
2513
 
2530
2514
  **campaignId:** `string` — Unique identifier of the toll-free campaign to submit. Must begin with the prefix `tf_`.
2531
-
2515
+
2532
2516
  </dd>
2533
2517
  </dl>
2534
2518
 
2535
2519
  <dl>
2536
2520
  <dd>
2537
2521
 
2538
- **requestOptions:** `TollFree.RequestOptions`
2539
-
2522
+ **requestOptions:** `TollFree.RequestOptions`
2523
+
2540
2524
  </dd>
2541
2525
  </dl>
2542
2526
  </dd>
2543
2527
  </dl>
2544
2528
 
2529
+
2545
2530
  </dd>
2546
2531
  </dl>
2547
2532
  </details>
@@ -2561,7 +2546,6 @@ await client.campaigns.tollFree.submit("tf_1234567890");
2561
2546
  Create a new toll-free campaign or updates an existing one.<br>
2562
2547
 
2563
2548
  Omit campaignId to create a campaign.
2564
-
2565
2549
  </dd>
2566
2550
  </dl>
2567
2551
  </dd>
@@ -2579,21 +2563,37 @@ Omit campaignId to create a campaign.
2579
2563
  await client.campaigns.tollFree.upsert({
2580
2564
  brand: "b_1234567890",
2581
2565
  campaignId: "tf_1234567890",
2582
- monthlyVolume: "1,000",
2583
- name: "Pinnacle",
2584
- optIn: {
2585
- method: "DIGITAL",
2586
- url: "https://www.pinnacle.sh/",
2587
- workflowDescription: "Visit https://www.pinnacle.sh/",
2566
+ keywords: {
2567
+ HELP: {
2568
+ message: "Email founders@trypinnacle.app for support."
2569
+ },
2570
+ OPT_IN: {
2571
+ message: "Welcome back to Pinnacle!<br>\n\uD83D\uDD14 You're now subscribed to Pinnacle and will continue receiving important updates and news. Feel free to contact this us at any time for help.<br>\n\nReply STOP to opt out and HELP for support. Message & rates may apply.\n",
2572
+ keywords: ["START", "SUBSCRIBE"]
2573
+ }
2574
+ },
2575
+ links: {
2576
+ privacyPolicy: "https://www.pinnacle.sh/privacy",
2577
+ termsOfService: "https://www.pinnacle.sh/terms"
2578
+ },
2579
+ monthlyVolume: "1,000",
2580
+ name: "Pinnacle",
2581
+ optIn: {
2582
+ method: "DIGITAL",
2583
+ url: "https://www.pinnacle.sh/",
2584
+ workflowDescription: "Visit https://www.pinnacle.sh/"
2585
+ },
2586
+ options: {
2587
+ ageGated: false
2588
2588
  },
2589
2589
  productionMessageContent: "Join the Pinnacle workshop tomorrow and send your first RCS!",
2590
2590
  useCase: {
2591
2591
  summary: "Alerts clients about any Pinnacle hosted workshops.",
2592
- value: "WORKSHOP_ALERTS",
2593
- },
2592
+ value: "WORKSHOP_ALERTS"
2593
+ }
2594
2594
  });
2595
- ```
2596
2595
 
2596
+ ```
2597
2597
  </dd>
2598
2598
  </dl>
2599
2599
  </dd>
@@ -2607,21 +2607,22 @@ await client.campaigns.tollFree.upsert({
2607
2607
  <dl>
2608
2608
  <dd>
2609
2609
 
2610
- **request:** `Pinnacle.campaigns.UpsertTollFreeCampaignParams`
2611
-
2610
+ **request:** `Pinnacle.campaigns.UpsertTollFreeCampaignParams`
2611
+
2612
2612
  </dd>
2613
2613
  </dl>
2614
2614
 
2615
2615
  <dl>
2616
2616
  <dd>
2617
2617
 
2618
- **requestOptions:** `TollFree.RequestOptions`
2619
-
2618
+ **requestOptions:** `TollFree.RequestOptions`
2619
+
2620
2620
  </dd>
2621
2621
  </dl>
2622
2622
  </dd>
2623
2623
  </dl>
2624
2624
 
2625
+
2625
2626
  </dd>
2626
2627
  </dl>
2627
2628
  </details>
@@ -2639,7 +2640,6 @@ await client.campaigns.tollFree.upsert({
2639
2640
  <dd>
2640
2641
 
2641
2642
  Validate your toll-free campaign configuration against carrier requirements and compliance rules.
2642
-
2643
2643
  </dd>
2644
2644
  </dl>
2645
2645
  </dd>
@@ -2656,10 +2656,10 @@ Validate your toll-free campaign configuration against carrier requirements and
2656
2656
  ```typescript
2657
2657
  await client.campaigns.tollFree.validate({
2658
2658
  additionalInfo: "Please validate this DLC campaign for 10DLC compliance",
2659
- campaignId: "dlc_1234567890",
2659
+ campaignId: "dlc_1234567890"
2660
2660
  });
2661
- ```
2662
2661
 
2662
+ ```
2663
2663
  </dd>
2664
2664
  </dl>
2665
2665
  </dd>
@@ -2673,27 +2673,27 @@ await client.campaigns.tollFree.validate({
2673
2673
  <dl>
2674
2674
  <dd>
2675
2675
 
2676
- **request:** `Pinnacle.ValidateCampaignParams`
2677
-
2676
+ **request:** `Pinnacle.ValidateCampaignParams`
2677
+
2678
2678
  </dd>
2679
2679
  </dl>
2680
2680
 
2681
2681
  <dl>
2682
2682
  <dd>
2683
2683
 
2684
- **requestOptions:** `TollFree.RequestOptions`
2685
-
2684
+ **requestOptions:** `TollFree.RequestOptions`
2685
+
2686
2686
  </dd>
2687
2687
  </dl>
2688
2688
  </dd>
2689
2689
  </dl>
2690
2690
 
2691
+
2691
2692
  </dd>
2692
2693
  </dl>
2693
2694
  </details>
2694
2695
 
2695
2696
  ## Campaigns Rcs
2696
-
2697
2697
  <details><summary><code>client.campaigns.rcs.<a href="/src/api/resources/campaigns/resources/rcs/client/Client.ts">autofill</a>({ ...params }) -> Pinnacle.RcsAutofillResponse</code></summary>
2698
2698
  <dl>
2699
2699
  <dd>
@@ -2707,7 +2707,6 @@ await client.campaigns.tollFree.validate({
2707
2707
  <dd>
2708
2708
 
2709
2709
  Generate campaign details based off existing campaign and the brand it's connected to.
2710
-
2711
2710
  </dd>
2712
2711
  </dl>
2713
2712
  </dd>
@@ -2724,10 +2723,10 @@ Generate campaign details based off existing campaign and the brand it's connect
2724
2723
  ```typescript
2725
2724
  await client.campaigns.rcs.autofill({
2726
2725
  additionalInfo: "Please autofill missing campaign fields using my brand profile",
2727
- campaignId: "dlc_1234567890",
2726
+ campaignId: "dlc_1234567890"
2728
2727
  });
2729
- ```
2730
2728
 
2729
+ ```
2731
2730
  </dd>
2732
2731
  </dl>
2733
2732
  </dd>
@@ -2741,21 +2740,22 @@ await client.campaigns.rcs.autofill({
2741
2740
  <dl>
2742
2741
  <dd>
2743
2742
 
2744
- **request:** `Pinnacle.AutofillCampaignParams`
2745
-
2743
+ **request:** `Pinnacle.AutofillCampaignParams`
2744
+
2746
2745
  </dd>
2747
2746
  </dl>
2748
2747
 
2749
2748
  <dl>
2750
2749
  <dd>
2751
2750
 
2752
- **requestOptions:** `Rcs.RequestOptions`
2753
-
2751
+ **requestOptions:** `Rcs.RequestOptions`
2752
+
2754
2753
  </dd>
2755
2754
  </dl>
2756
2755
  </dd>
2757
2756
  </dl>
2758
2757
 
2758
+
2759
2759
  </dd>
2760
2760
  </dl>
2761
2761
  </details>
@@ -2773,7 +2773,6 @@ await client.campaigns.rcs.autofill({
2773
2773
  <dd>
2774
2774
 
2775
2775
  Retrieve RCS campaign.
2776
-
2777
2776
  </dd>
2778
2777
  </dl>
2779
2778
  </dd>
@@ -2789,8 +2788,8 @@ Retrieve RCS campaign.
2789
2788
 
2790
2789
  ```typescript
2791
2790
  await client.campaigns.rcs.get("rcs_1234567890");
2792
- ```
2793
2791
 
2792
+ ```
2794
2793
  </dd>
2795
2794
  </dl>
2796
2795
  </dd>
@@ -2805,20 +2804,21 @@ await client.campaigns.rcs.get("rcs_1234567890");
2805
2804
  <dd>
2806
2805
 
2807
2806
  **campaignId:** `string` — Unique identifier of the RCS campaign. Must begin with the prefix `rcs_`.
2808
-
2807
+
2809
2808
  </dd>
2810
2809
  </dl>
2811
2810
 
2812
2811
  <dl>
2813
2812
  <dd>
2814
2813
 
2815
- **requestOptions:** `Rcs.RequestOptions`
2816
-
2814
+ **requestOptions:** `Rcs.RequestOptions`
2815
+
2817
2816
  </dd>
2818
2817
  </dl>
2819
2818
  </dd>
2820
2819
  </dl>
2821
2820
 
2821
+
2822
2822
  </dd>
2823
2823
  </dl>
2824
2824
  </details>
@@ -2836,7 +2836,6 @@ await client.campaigns.rcs.get("rcs_1234567890");
2836
2836
  <dd>
2837
2837
 
2838
2838
  Submit your RCS campaign for approval and activation with carriers.
2839
-
2840
2839
  </dd>
2841
2840
  </dl>
2842
2841
  </dd>
@@ -2852,8 +2851,8 @@ Submit your RCS campaign for approval and activation with carriers.
2852
2851
 
2853
2852
  ```typescript
2854
2853
  await client.campaigns.rcs.submit("rcs_1234567890");
2855
- ```
2856
2854
 
2855
+ ```
2857
2856
  </dd>
2858
2857
  </dl>
2859
2858
  </dd>
@@ -2868,20 +2867,21 @@ await client.campaigns.rcs.submit("rcs_1234567890");
2868
2867
  <dd>
2869
2868
 
2870
2869
  **campaignId:** `string` — Unique identifier of the RCS campaign to retrieve. Must begin with the prefix `rcs_`.
2871
-
2870
+
2872
2871
  </dd>
2873
2872
  </dl>
2874
2873
 
2875
2874
  <dl>
2876
2875
  <dd>
2877
2876
 
2878
- **requestOptions:** `Rcs.RequestOptions`
2879
-
2877
+ **requestOptions:** `Rcs.RequestOptions`
2878
+
2880
2879
  </dd>
2881
2880
  </dl>
2882
2881
  </dd>
2883
2882
  </dl>
2884
2883
 
2884
+
2885
2885
  </dd>
2886
2886
  </dl>
2887
2887
  </details>
@@ -2901,7 +2901,6 @@ await client.campaigns.rcs.submit("rcs_1234567890");
2901
2901
  Create a new RCS campaign or updates an existing one. <br>
2902
2902
 
2903
2903
  Omit campaignId to create a campaign.
2904
-
2905
2904
  </dd>
2906
2905
  </dl>
2907
2906
  </dd>
@@ -2919,58 +2918,63 @@ Omit campaignId to create a campaign.
2919
2918
  await client.campaigns.rcs.upsert({
2920
2919
  agent: {
2921
2920
  color: "#000000",
2922
- description:
2923
- "Engaging campaigns with RBM \u2013 next-gen SMS marketing with rich content and better analytics.",
2924
- emails: [
2925
- {
2921
+ description: "Experience the power of RCS messaging with interactive demos. Test rich features like carousels, suggested replies, and media sharing. Get started with our developer-friendly APIs.",
2922
+ emails: [{
2926
2923
  email: "founders@trypinnacle.app",
2927
- label: "Email Us",
2928
- },
2929
- ],
2930
- heroUrl: "https://agent-logos.storage.googleapis.com/_/m0bk9mmw7kfynqiKSPfsaoc6",
2931
- iconUrl: "https://agent-logos.storage.googleapis.com/_/m0bk9gvlDunZEw1krfruZmw3",
2932
- name: "Pinnacle Software Development",
2933
- phones: [
2934
- {
2924
+ label: "Email Us"
2925
+ }],
2926
+ heroUrl: "https://pncl.to/D6pDSqGxqgfbCfQmw4gXdnlHu4uSB4",
2927
+ iconUrl: "https://pncl.to/mq_tdIDenRb5eYpJiM8-3THCaUBrZP",
2928
+ name: "Pinnacle - RCS Demo",
2929
+ phones: [{
2935
2930
  label: "Contact us directly",
2936
- phone: "+14154467821",
2937
- },
2938
- ],
2939
- websites: [
2940
- {
2931
+ phone: "+14154467821"
2932
+ }],
2933
+ websites: [{
2941
2934
  label: "Get started with Pinnacle",
2942
- url: "https://www.trypinnacle.app/",
2943
- },
2944
- ],
2935
+ url: "https://www.trypinnacle.app/"
2936
+ }]
2945
2937
  },
2946
- brandVerificationUrl: "https://www.pinnacle.sh/articles-of-incorporation.pdf",
2947
2938
  brand: "b_1234567890",
2948
2939
  campaignId: "rcs_1234567890",
2949
- expectedAgentResponses: [
2950
- "Here are the things I can help you with.",
2951
- "I can assist you with booking an appointment, or you may choose to book manually.",
2952
- "Here are the available times to connect with a representative tomorrow.",
2953
- "Your appointment has been scheduled.",
2954
- ],
2940
+ 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."],
2955
2941
  links: {
2956
2942
  privacyPolicy: "https://www.trypinnacle.app/privacy",
2957
- termsOfService: "https://www.trypinnacle.app/terms",
2943
+ termsOfService: "https://www.trypinnacle.app/terms"
2958
2944
  },
2959
- optIn: {
2960
- method: "WEBSITE",
2961
- termsAndConditions: "Would you like to subscribe to Pinnacle?",
2945
+ useCase: {
2946
+ behavior: "Pinnacle is a developer-focused RCS assistant that helps teams design, test, and optimize rich messaging experiences across SMS, MMS, and RCS. The agent acts as both an \u201Conboarding guide\u201D for new customers and a \u201Cbest-practices coach\u201D for existing teams exploring higher-value RCS workflows like rich cards, carousels, and suggested actions.<br>\nThe agent delivers a mix of operational updates and educational content (2\u20136 messages/month). Content includes important platform notices (e.g., deliverability or throughput changes), implementation tips with sample RCS templates, and personalized recommendations on how to upgrade existing SMS campaigns into richer, higher-converting RCS conversations.\n",
2947
+ value: "OTHER"
2962
2948
  },
2963
- optOut: {
2964
- description: "Reply STOP to opt-out anytime.",
2965
- keywords: ["STOP", "UNSUBSCRIBE", "END"],
2949
+ optInTermsAndConditions: "We ensure consent through an explicit opt-in process that follows 10DLC best practices.Users must agree to receive messages from Pinnacle before the agent sends them any messages.<br>\nUsers agree to these messages by signing an opt-in paper form that they can be found online at https://www.pinnacle.sh/opt-in. We only send messages once users have filled out the form and submitted it to us via email or through the dashboard.\n",
2950
+ messagingType: "MULTI_USE",
2951
+ carrierDescription: "Demonstrate the power of RCS to medium and large companies already sending massive SMS/MMS volumes through our platform. These clients send conversational messages in industries such as commerce, appointments, and customer support.",
2952
+ keywords: {
2953
+ HELP: {
2954
+ message: "Email founders@trypinnacle.app for support.",
2955
+ keywords: ["HELP", "SUPPORT"]
2956
+ },
2957
+ OPT_IN: {
2958
+ message: "Welcome back to Pinnacle!<br>\n\uD83D\uDD14 You're now subscribed to Pinnacle - RCS Demo and will continue receiving important updates and news. Feel free to contact this us at any time for help.<br>\n\nReply STOP to opt out and HELP for support. Message & rates may apply.\n",
2959
+ keywords: ["START", "SUBSCRIBE"]
2960
+ },
2961
+ OPT_OUT: {
2962
+ message: "You've been unsubscribed from Pinnacle - RCS Demo and will no longer receive notifications. If you ever change your mind, reply START or SUBSCRIBE to rejoin anytime.",
2963
+ keywords: ["STOP", "UNSUBSCRIBE", "END"]
2964
+ }
2966
2965
  },
2967
- useCase: {
2968
- behavior: "Acts as a customer service representative.",
2969
- value: "OTHER",
2966
+ traffic: {
2967
+ monthlyWebsite: 10000,
2968
+ monthlyRcsEstimate: 10000
2970
2969
  },
2970
+ agentTriggers: "The agent sends the first message when the user subscribes to Pinnacle. Messages are based on user actions such as pressing suggestion buttons. External triggers such as reminders can be setup by users in advance for a later time.",
2971
+ interactionDescription: "The agent's primary interaction will be customer service \u2014 helping users with questions, troubleshooting issues, and providing quick assistance through chat. Other interactions include appointment management and sending notifications to the user.",
2972
+ isConversational: true,
2973
+ ctaLanguage: "By checking this box and submitting this form, you consent to receive transactional text messages for support, appointment, and reminder messages from Pinnacle Software Development Inc. Reply STOP to opt out. Reply HELP for help. Standard message and data rates may apply. Message frequency may vary. View our Terms and Conditions at https://www.pinnacle.sh/terms. View our Privacy Policy at https://www.pinnacle.sh/privacy.",
2974
+ demoTrigger: "Text \"START\" to trigger the flow."
2971
2975
  });
2972
- ```
2973
2976
 
2977
+ ```
2974
2978
  </dd>
2975
2979
  </dl>
2976
2980
  </dd>
@@ -2984,21 +2988,22 @@ await client.campaigns.rcs.upsert({
2984
2988
  <dl>
2985
2989
  <dd>
2986
2990
 
2987
- **request:** `Pinnacle.campaigns.UpsertRcsCampaignParams`
2988
-
2991
+ **request:** `Pinnacle.campaigns.UpsertRcsCampaignParams`
2992
+
2989
2993
  </dd>
2990
2994
  </dl>
2991
2995
 
2992
2996
  <dl>
2993
2997
  <dd>
2994
2998
 
2995
- **requestOptions:** `Rcs.RequestOptions`
2996
-
2999
+ **requestOptions:** `Rcs.RequestOptions`
3000
+
2997
3001
  </dd>
2998
3002
  </dl>
2999
3003
  </dd>
3000
3004
  </dl>
3001
3005
 
3006
+
3002
3007
  </dd>
3003
3008
  </dl>
3004
3009
  </details>
@@ -3016,7 +3021,6 @@ await client.campaigns.rcs.upsert({
3016
3021
  <dd>
3017
3022
 
3018
3023
  Validate your RCS campaign configuration against carrier requirements and compliance rules.
3019
-
3020
3024
  </dd>
3021
3025
  </dl>
3022
3026
  </dd>
@@ -3033,10 +3037,10 @@ Validate your RCS campaign configuration against carrier requirements and compli
3033
3037
  ```typescript
3034
3038
  await client.campaigns.rcs.validate({
3035
3039
  additionalInfo: "Please validate this DLC campaign for 10DLC compliance",
3036
- campaignId: "dlc_1234567890",
3040
+ campaignId: "dlc_1234567890"
3037
3041
  });
3038
- ```
3039
3042
 
3043
+ ```
3040
3044
  </dd>
3041
3045
  </dl>
3042
3046
  </dd>
@@ -3050,27 +3054,27 @@ await client.campaigns.rcs.validate({
3050
3054
  <dl>
3051
3055
  <dd>
3052
3056
 
3053
- **request:** `Pinnacle.ValidateCampaignParams`
3054
-
3057
+ **request:** `Pinnacle.ValidateCampaignParams`
3058
+
3055
3059
  </dd>
3056
3060
  </dl>
3057
3061
 
3058
3062
  <dl>
3059
3063
  <dd>
3060
3064
 
3061
- **requestOptions:** `Rcs.RequestOptions`
3062
-
3065
+ **requestOptions:** `Rcs.RequestOptions`
3066
+
3063
3067
  </dd>
3064
3068
  </dl>
3065
3069
  </dd>
3066
3070
  </dl>
3067
3071
 
3072
+
3068
3073
  </dd>
3069
3074
  </dl>
3070
3075
  </details>
3071
3076
 
3072
3077
  ## Messages Sms
3073
-
3074
3078
  <details><summary><code>client.messages.sms.<a href="/src/api/resources/messages/resources/sms/client/Client.ts">send</a>({ ...params }) -> Pinnacle.SmsSendResponse</code></summary>
3075
3079
  <dl>
3076
3080
  <dd>
@@ -3084,7 +3088,6 @@ await client.campaigns.rcs.validate({
3084
3088
  <dd>
3085
3089
 
3086
3090
  Send a SMS message immediately or schedule it for future delivery.
3087
-
3088
3091
  </dd>
3089
3092
  </dl>
3090
3093
  </dd>
@@ -3102,10 +3105,10 @@ Send a SMS message immediately or schedule it for future delivery.
3102
3105
  await client.messages.sms.send({
3103
3106
  from: "+14155164736",
3104
3107
  text: "Hey!",
3105
- to: "+14154746461",
3108
+ to: "+14154746461"
3106
3109
  });
3107
- ```
3108
3110
 
3111
+ ```
3109
3112
  </dd>
3110
3113
  </dl>
3111
3114
  </dd>
@@ -3119,21 +3122,22 @@ await client.messages.sms.send({
3119
3122
  <dl>
3120
3123
  <dd>
3121
3124
 
3122
- **request:** `Pinnacle.messages.Sms`
3123
-
3125
+ **request:** `Pinnacle.messages.Sms`
3126
+
3124
3127
  </dd>
3125
3128
  </dl>
3126
3129
 
3127
3130
  <dl>
3128
3131
  <dd>
3129
3132
 
3130
- **requestOptions:** `Sms.RequestOptions`
3131
-
3133
+ **requestOptions:** `Sms.RequestOptions`
3134
+
3132
3135
  </dd>
3133
3136
  </dl>
3134
3137
  </dd>
3135
3138
  </dl>
3136
3139
 
3140
+
3137
3141
  </dd>
3138
3142
  </dl>
3139
3143
  </details>
@@ -3151,7 +3155,6 @@ await client.messages.sms.send({
3151
3155
  <dd>
3152
3156
 
3153
3157
  Validate SMS message content without sending it.
3154
-
3155
3158
  </dd>
3156
3159
  </dl>
3157
3160
  </dd>
@@ -3167,10 +3170,10 @@ Validate SMS message content without sending it.
3167
3170
 
3168
3171
  ```typescript
3169
3172
  await client.messages.sms.validate({
3170
- text: "Hello from Pinnacle",
3173
+ text: "Hello from Pinnacle"
3171
3174
  });
3172
- ```
3173
3175
 
3176
+ ```
3174
3177
  </dd>
3175
3178
  </dl>
3176
3179
  </dd>
@@ -3184,27 +3187,27 @@ await client.messages.sms.validate({
3184
3187
  <dl>
3185
3188
  <dd>
3186
3189
 
3187
- **request:** `Pinnacle.SmsContent`
3188
-
3190
+ **request:** `Pinnacle.SmsContent`
3191
+
3189
3192
  </dd>
3190
3193
  </dl>
3191
3194
 
3192
3195
  <dl>
3193
3196
  <dd>
3194
3197
 
3195
- **requestOptions:** `Sms.RequestOptions`
3196
-
3198
+ **requestOptions:** `Sms.RequestOptions`
3199
+
3197
3200
  </dd>
3198
3201
  </dl>
3199
3202
  </dd>
3200
3203
  </dl>
3201
3204
 
3205
+
3202
3206
  </dd>
3203
3207
  </dl>
3204
3208
  </details>
3205
3209
 
3206
3210
  ## Messages Mms
3207
-
3208
3211
  <details><summary><code>client.messages.mms.<a href="/src/api/resources/messages/resources/mms/client/Client.ts">send</a>({ ...params }) -> Pinnacle.MmsSendResponse</code></summary>
3209
3212
  <dl>
3210
3213
  <dd>
@@ -3218,7 +3221,6 @@ await client.messages.sms.validate({
3218
3221
  <dd>
3219
3222
 
3220
3223
  Send a MMS immediately or schedule it for future delivery.
3221
-
3222
3224
  </dd>
3223
3225
  </dl>
3224
3226
  </dd>
@@ -3238,13 +3240,13 @@ await client.messages.mms.send({
3238
3240
  mediaUrls: ["https://fastly.picsum.photos/id/941/300/300.jpg?hmac=mDxM9PWSqRDjecwSCEpzU4bj35gqnG7yA25OL29uNv0"],
3239
3241
  options: {
3240
3242
  multiple_messages: true,
3241
- validate: true,
3243
+ validate: true
3242
3244
  },
3243
3245
  text: "Check out this image!",
3244
- to: "+14154746461",
3246
+ to: "+14154746461"
3245
3247
  });
3246
- ```
3247
3248
 
3249
+ ```
3248
3250
  </dd>
3249
3251
  </dl>
3250
3252
  </dd>
@@ -3258,21 +3260,22 @@ await client.messages.mms.send({
3258
3260
  <dl>
3259
3261
  <dd>
3260
3262
 
3261
- **request:** `Pinnacle.messages.Mms`
3262
-
3263
+ **request:** `Pinnacle.messages.Mms`
3264
+
3263
3265
  </dd>
3264
3266
  </dl>
3265
3267
 
3266
3268
  <dl>
3267
3269
  <dd>
3268
3270
 
3269
- **requestOptions:** `Mms.RequestOptions`
3270
-
3271
+ **requestOptions:** `Mms.RequestOptions`
3272
+
3271
3273
  </dd>
3272
3274
  </dl>
3273
3275
  </dd>
3274
3276
  </dl>
3275
3277
 
3278
+
3276
3279
  </dd>
3277
3280
  </dl>
3278
3281
  </details>
@@ -3290,7 +3293,6 @@ await client.messages.mms.send({
3290
3293
  <dd>
3291
3294
 
3292
3295
  Validate MMS message content without sending it.
3293
-
3294
3296
  </dd>
3295
3297
  </dl>
3296
3298
  </dd>
@@ -3306,15 +3308,11 @@ Validate MMS message content without sending it.
3306
3308
 
3307
3309
  ```typescript
3308
3310
  await client.messages.mms.validate({
3309
- mediaUrls: [
3310
- "https://upload.wikimedia.org/wikipedia/commons/b/b9/Pizigani_1367_Chart_1MB.jpg",
3311
- "https://fastly.picsum.photos/id/528/1000/1000.jpg?hmac=aTG0xNif9KbNryFN0ZNZ_nFK6aEpZxqUGCZF1KjOT8w",
3312
- "https://file-examples.com/storage/fefdd7ab126835e7993bb1a/2017/10/file_example_JPG_500kB.jpg",
3313
- ],
3314
- text: "Check out these images!",
3311
+ mediaUrls: ["https://upload.wikimedia.org/wikipedia/commons/b/b9/Pizigani_1367_Chart_1MB.jpg", "https://fastly.picsum.photos/id/528/1000/1000.jpg?hmac=aTG0xNif9KbNryFN0ZNZ_nFK6aEpZxqUGCZF1KjOT8w", "https://file-examples.com/storage/fefdd7ab126835e7993bb1a/2017/10/file_example_JPG_500kB.jpg"],
3312
+ text: "Check out these images!"
3315
3313
  });
3316
- ```
3317
3314
 
3315
+ ```
3318
3316
  </dd>
3319
3317
  </dl>
3320
3318
  </dd>
@@ -3328,28 +3326,28 @@ await client.messages.mms.validate({
3328
3326
  <dl>
3329
3327
  <dd>
3330
3328
 
3331
- **request:** `Pinnacle.MmsContent`
3332
-
3329
+ **request:** `Pinnacle.MmsContent`
3330
+
3333
3331
  </dd>
3334
3332
  </dl>
3335
3333
 
3336
3334
  <dl>
3337
3335
  <dd>
3338
3336
 
3339
- **requestOptions:** `Mms.RequestOptions`
3340
-
3337
+ **requestOptions:** `Mms.RequestOptions`
3338
+
3341
3339
  </dd>
3342
3340
  </dl>
3343
3341
  </dd>
3344
3342
  </dl>
3345
3343
 
3344
+
3346
3345
  </dd>
3347
3346
  </dl>
3348
3347
  </details>
3349
3348
 
3350
3349
  ## Messages Rcs
3351
-
3352
- <details><summary><code>client.messages.rcs.<a href="/src/api/resources/messages/resources/rcs/client/Client.ts">send</a>({ ...params }) -> Pinnacle.RcsSendResponse</code></summary>
3350
+ <details><summary><code>client.messages.rcs.<a href="/src/api/resources/messages/resources/rcs/client/Client.ts">send</a>({ ...params }) -> Pinnacle.SendRichMessageResponse</code></summary>
3353
3351
  <dl>
3354
3352
  <dd>
3355
3353
 
@@ -3364,7 +3362,6 @@ await client.messages.mms.validate({
3364
3362
  Send a RCS message immediately or schedule it for future delivery. <br>
3365
3363
 
3366
3364
  Requires an active RCS agent and recipient devices that support RCS Business Messaging.
3367
-
3368
3365
  </dd>
3369
3366
  </dl>
3370
3367
  </dd>
@@ -3380,19 +3377,17 @@ Requires an active RCS agent and recipient devices that support RCS Business Mes
3380
3377
 
3381
3378
  ```typescript
3382
3379
  await client.messages.rcs.send({
3383
- quickReplies: [
3384
- {
3380
+ quickReplies: [{
3385
3381
  type: "openUrl",
3386
3382
  payload: "payload",
3387
- title: "title",
3388
- },
3389
- ],
3383
+ title: "title"
3384
+ }],
3390
3385
  text: "text",
3391
3386
  from: "from",
3392
- to: "to",
3387
+ to: "to"
3393
3388
  });
3394
- ```
3395
3389
 
3390
+ ```
3396
3391
  </dd>
3397
3392
  </dl>
3398
3393
  </dd>
@@ -3406,21 +3401,22 @@ await client.messages.rcs.send({
3406
3401
  <dl>
3407
3402
  <dd>
3408
3403
 
3409
- **request:** `Pinnacle.RichMessage`
3410
-
3404
+ **request:** `Pinnacle.RichMessage`
3405
+
3411
3406
  </dd>
3412
3407
  </dl>
3413
3408
 
3414
3409
  <dl>
3415
3410
  <dd>
3416
3411
 
3417
- **requestOptions:** `Rcs.RequestOptions`
3418
-
3412
+ **requestOptions:** `Rcs.RequestOptions`
3413
+
3419
3414
  </dd>
3420
3415
  </dl>
3421
3416
  </dd>
3422
3417
  </dl>
3423
3418
 
3419
+
3424
3420
  </dd>
3425
3421
  </dl>
3426
3422
  </details>
@@ -3448,7 +3444,6 @@ This endpoint allows RCS agents to display a typing indicator to recipients. The
3448
3444
  **Frequency:** You can send typing indicators as many times as needed, though only one will be displayed at a time. Sending multiple typing indicators will extend the duration of the current indicator.
3449
3445
 
3450
3446
  > **Note:** Typing indicators are best-effort hints, not delivery-guaranteed state. The platform is allowed to coalesce or drop them, and the client UI decides when to show/hide.
3451
-
3452
3447
  </dd>
3453
3448
  </dl>
3454
3449
  </dd>
@@ -3467,11 +3462,11 @@ await client.messages.rcs.sendTyping({
3467
3462
  agentId: "agent_pinnacle",
3468
3463
  to: "+14154746461",
3469
3464
  options: {
3470
- test_mode: false,
3471
- },
3465
+ test_mode: false
3466
+ }
3472
3467
  });
3473
- ```
3474
3468
 
3469
+ ```
3475
3470
  </dd>
3476
3471
  </dl>
3477
3472
  </dd>
@@ -3485,21 +3480,22 @@ await client.messages.rcs.sendTyping({
3485
3480
  <dl>
3486
3481
  <dd>
3487
3482
 
3488
- **request:** `Pinnacle.messages.SendTypingIndicatorSchema`
3489
-
3483
+ **request:** `Pinnacle.messages.SendTypingIndicatorSchema`
3484
+
3490
3485
  </dd>
3491
3486
  </dl>
3492
3487
 
3493
3488
  <dl>
3494
3489
  <dd>
3495
3490
 
3496
- **requestOptions:** `Rcs.RequestOptions`
3497
-
3491
+ **requestOptions:** `Rcs.RequestOptions`
3492
+
3498
3493
  </dd>
3499
3494
  </dl>
3500
3495
  </dd>
3501
3496
  </dl>
3502
3497
 
3498
+
3503
3499
  </dd>
3504
3500
  </dl>
3505
3501
  </details>
@@ -3517,7 +3513,6 @@ await client.messages.rcs.sendTyping({
3517
3513
  <dd>
3518
3514
 
3519
3515
  Validate RCS message content without sending it.
3520
-
3521
3516
  </dd>
3522
3517
  </dl>
3523
3518
  </dd>
@@ -3533,17 +3528,248 @@ Validate RCS message content without sending it.
3533
3528
 
3534
3529
  ```typescript
3535
3530
  await client.messages.rcs.validate({
3536
- quickReplies: [
3537
- {
3531
+ quickReplies: [{
3538
3532
  type: "openUrl",
3539
3533
  payload: "payload",
3540
- title: "title",
3541
- },
3542
- ],
3543
- text: "text",
3534
+ title: "title"
3535
+ }],
3536
+ text: "text"
3537
+ });
3538
+
3539
+ ```
3540
+ </dd>
3541
+ </dl>
3542
+ </dd>
3543
+ </dl>
3544
+
3545
+ #### ⚙️ Parameters
3546
+
3547
+ <dl>
3548
+ <dd>
3549
+
3550
+ <dl>
3551
+ <dd>
3552
+
3553
+ **request:** `Pinnacle.RcsValidateContent`
3554
+
3555
+ </dd>
3556
+ </dl>
3557
+
3558
+ <dl>
3559
+ <dd>
3560
+
3561
+ **requestOptions:** `Rcs.RequestOptions`
3562
+
3563
+ </dd>
3564
+ </dl>
3565
+ </dd>
3566
+ </dl>
3567
+
3568
+
3569
+ </dd>
3570
+ </dl>
3571
+ </details>
3572
+
3573
+ ## Messages Blast
3574
+ <details><summary><code>client.messages.blast.<a href="/src/api/resources/messages/resources/blast/client/Client.ts">sms</a>({ ...params }) -> Pinnacle.BlastSmsResponse</code></summary>
3575
+ <dl>
3576
+ <dd>
3577
+
3578
+ #### 📝 Description
3579
+
3580
+ <dl>
3581
+ <dd>
3582
+
3583
+ <dl>
3584
+ <dd>
3585
+
3586
+ Send an SMS message to all contacts in an audience. <br>
3587
+
3588
+ Messages are distributed evenly across the provided sender phone numbers. <br>
3589
+
3590
+ Use the optional `schedule` parameter in `options` to schedule the blast for future delivery. When scheduled, the response will contain a `scheduleId` instead of blast details.
3591
+ </dd>
3592
+ </dl>
3593
+ </dd>
3594
+ </dl>
3595
+
3596
+ #### 🔌 Usage
3597
+
3598
+ <dl>
3599
+ <dd>
3600
+
3601
+ <dl>
3602
+ <dd>
3603
+
3604
+ ```typescript
3605
+ await client.messages.blast.sms({
3606
+ audienceId: "aud_abc123",
3607
+ senders: ["+14155164736", "+14155164737"],
3608
+ message: {
3609
+ text: "Hello from Pinnacle!"
3610
+ }
3611
+ });
3612
+
3613
+ ```
3614
+ </dd>
3615
+ </dl>
3616
+ </dd>
3617
+ </dl>
3618
+
3619
+ #### ⚙️ Parameters
3620
+
3621
+ <dl>
3622
+ <dd>
3623
+
3624
+ <dl>
3625
+ <dd>
3626
+
3627
+ **request:** `Pinnacle.messages.BlastSms`
3628
+
3629
+ </dd>
3630
+ </dl>
3631
+
3632
+ <dl>
3633
+ <dd>
3634
+
3635
+ **requestOptions:** `Blast.RequestOptions`
3636
+
3637
+ </dd>
3638
+ </dl>
3639
+ </dd>
3640
+ </dl>
3641
+
3642
+
3643
+ </dd>
3644
+ </dl>
3645
+ </details>
3646
+
3647
+ <details><summary><code>client.messages.blast.<a href="/src/api/resources/messages/resources/blast/client/Client.ts">mms</a>({ ...params }) -> Pinnacle.BlastMmsResponse</code></summary>
3648
+ <dl>
3649
+ <dd>
3650
+
3651
+ #### 📝 Description
3652
+
3653
+ <dl>
3654
+ <dd>
3655
+
3656
+ <dl>
3657
+ <dd>
3658
+
3659
+ Send an MMS message to all contacts in an audience. <br>
3660
+
3661
+ Messages are distributed evenly across the provided sender phone numbers. <br>
3662
+
3663
+ Use the optional `schedule` parameter in `options` to schedule the blast for future delivery. When scheduled, the response will contain a `scheduleId` instead of blast details.
3664
+ </dd>
3665
+ </dl>
3666
+ </dd>
3667
+ </dl>
3668
+
3669
+ #### 🔌 Usage
3670
+
3671
+ <dl>
3672
+ <dd>
3673
+
3674
+ <dl>
3675
+ <dd>
3676
+
3677
+ ```typescript
3678
+ await client.messages.blast.mms({
3679
+ audienceId: "aud_abc123",
3680
+ senders: ["+14155164736", "+14155164737"],
3681
+ message: {
3682
+ mediaUrls: ["https://fastly.picsum.photos/id/941/300/300.jpg"],
3683
+ text: "Check out this image!"
3684
+ },
3685
+ options: {
3686
+ validate: true
3687
+ }
3544
3688
  });
3689
+
3545
3690
  ```
3691
+ </dd>
3692
+ </dl>
3693
+ </dd>
3694
+ </dl>
3695
+
3696
+ #### ⚙️ Parameters
3697
+
3698
+ <dl>
3699
+ <dd>
3700
+
3701
+ <dl>
3702
+ <dd>
3703
+
3704
+ **request:** `Pinnacle.messages.BlastMms`
3705
+
3706
+ </dd>
3707
+ </dl>
3546
3708
 
3709
+ <dl>
3710
+ <dd>
3711
+
3712
+ **requestOptions:** `Blast.RequestOptions`
3713
+
3714
+ </dd>
3715
+ </dl>
3716
+ </dd>
3717
+ </dl>
3718
+
3719
+
3720
+ </dd>
3721
+ </dl>
3722
+ </details>
3723
+
3724
+ <details><summary><code>client.messages.blast.<a href="/src/api/resources/messages/resources/blast/client/Client.ts">rcs</a>({ ...params }) -> Pinnacle.BlastRcsResponse</code></summary>
3725
+ <dl>
3726
+ <dd>
3727
+
3728
+ #### 📝 Description
3729
+
3730
+ <dl>
3731
+ <dd>
3732
+
3733
+ <dl>
3734
+ <dd>
3735
+
3736
+ Send an RCS message to all contacts in an audience. <br>
3737
+
3738
+ Messages are distributed evenly across the provided RCS agents for load balancing. Requires active RCS agents and recipient devices that support RCS Business Messaging. <br>
3739
+
3740
+ Use the optional `schedule` parameter in `options` to schedule the blast for future delivery. When scheduled, the response will contain a `scheduleId` instead of blast details.
3741
+ </dd>
3742
+ </dl>
3743
+ </dd>
3744
+ </dl>
3745
+
3746
+ #### 🔌 Usage
3747
+
3748
+ <dl>
3749
+ <dd>
3750
+
3751
+ <dl>
3752
+ <dd>
3753
+
3754
+ ```typescript
3755
+ await client.messages.blast.rcs({
3756
+ audienceId: "aud_abc123",
3757
+ senders: ["agent_pinnacle", "agent_pinnacle2"],
3758
+ message: {
3759
+ quickReplies: [{
3760
+ type: "trigger",
3761
+ payload: "payload",
3762
+ title: "title"
3763
+ }],
3764
+ text: "Hello from Pinnacle RCS!"
3765
+ },
3766
+ options: {
3767
+ transcode: true,
3768
+ validate: true
3769
+ }
3770
+ });
3771
+
3772
+ ```
3547
3773
  </dd>
3548
3774
  </dl>
3549
3775
  </dd>
@@ -3557,27 +3783,93 @@ await client.messages.rcs.validate({
3557
3783
  <dl>
3558
3784
  <dd>
3559
3785
 
3560
- **request:** `Pinnacle.RcsValidateContent`
3786
+ **request:** `Pinnacle.messages.BlastRcs`
3787
+
3788
+ </dd>
3789
+ </dl>
3790
+
3791
+ <dl>
3792
+ <dd>
3793
+
3794
+ **requestOptions:** `Blast.RequestOptions`
3795
+
3796
+ </dd>
3797
+ </dl>
3798
+ </dd>
3799
+ </dl>
3800
+
3801
+
3802
+ </dd>
3803
+ </dl>
3804
+ </details>
3805
+
3806
+ ## Messages Schedule
3807
+ <details><summary><code>client.messages.schedule.<a href="/src/api/resources/messages/resources/schedule/client/Client.ts">cancel</a>(id) -> Pinnacle.ScheduleCancelResult</code></summary>
3808
+ <dl>
3809
+ <dd>
3810
+
3811
+ #### 📝 Description
3812
+
3813
+ <dl>
3814
+ <dd>
3815
+
3816
+ <dl>
3817
+ <dd>
3818
+
3819
+ Cancel a scheduled message or blast. <br>
3561
3820
 
3821
+ Works for both individual scheduled messages and scheduled blasts. Use the `scheduleId` returned when the message or blast was scheduled.
3822
+ </dd>
3823
+ </dl>
3562
3824
  </dd>
3563
3825
  </dl>
3564
3826
 
3827
+ #### 🔌 Usage
3828
+
3565
3829
  <dl>
3566
3830
  <dd>
3567
3831
 
3568
- **requestOptions:** `Rcs.RequestOptions`
3832
+ <dl>
3833
+ <dd>
3834
+
3835
+ ```typescript
3836
+ await client.messages.schedule.cancel("id");
3569
3837
 
3838
+ ```
3570
3839
  </dd>
3571
3840
  </dl>
3572
3841
  </dd>
3573
3842
  </dl>
3574
3843
 
3844
+ #### ⚙️ Parameters
3845
+
3846
+ <dl>
3847
+ <dd>
3848
+
3849
+ <dl>
3850
+ <dd>
3851
+
3852
+ **id:** `string` — Unique identifier of the scheduled message. This identifier is a string that always begins with the prefix `msg_sched_`, for example: `msg_sched_1234567890`.
3853
+
3854
+ </dd>
3855
+ </dl>
3856
+
3857
+ <dl>
3858
+ <dd>
3859
+
3860
+ **requestOptions:** `Schedule.RequestOptions`
3861
+
3862
+ </dd>
3863
+ </dl>
3864
+ </dd>
3865
+ </dl>
3866
+
3867
+
3575
3868
  </dd>
3576
3869
  </dl>
3577
3870
  </details>
3578
3871
 
3579
3872
  ## PhoneNumbers Webhook
3580
-
3581
3873
  <details><summary><code>client.phoneNumbers.webhook.<a href="/src/api/resources/phoneNumbers/resources/webhook/client/Client.ts">attach</a>(phone, { ...params }) -> Pinnacle.ConfiguredWebhook</code></summary>
3582
3874
  <dl>
3583
3875
  <dd>
@@ -3591,7 +3883,6 @@ await client.messages.rcs.validate({
3591
3883
  <dd>
3592
3884
 
3593
3885
  Connect a webhook to your phone number to receive real-time notifications for incoming messages, delivery status updates, and other communication events.
3594
-
3595
3886
  </dd>
3596
3887
  </dl>
3597
3888
  </dd>
@@ -3608,10 +3899,10 @@ Connect a webhook to your phone number to receive real-time notifications for in
3608
3899
  ```typescript
3609
3900
  await client.phoneNumbers.webhook.attach("%2B14155551234", {
3610
3901
  webhookId: "wh_1234567890",
3611
- event: "MESSAGE.STATUS",
3902
+ event: "MESSAGE.STATUS"
3612
3903
  });
3613
- ```
3614
3904
 
3905
+ ```
3615
3906
  </dd>
3616
3907
  </dl>
3617
3908
  </dd>
@@ -3625,33 +3916,34 @@ await client.phoneNumbers.webhook.attach("%2B14155551234", {
3625
3916
  <dl>
3626
3917
  <dd>
3627
3918
 
3628
- **phone:** `string`
3919
+ **phone:** `string`
3629
3920
 
3630
3921
  The phone number you want to attach the webhook to in E.164 format. Make sure it is url encoded (i.e. replace the leading + with %2B). <br>
3631
3922
 
3632
3923
  Must be a phone number that you own and have already [purchased](./buy) through the API. A phone number can have multiple webhooks attached to it.
3633
-
3924
+
3634
3925
  </dd>
3635
3926
  </dl>
3636
3927
 
3637
3928
  <dl>
3638
3929
  <dd>
3639
3930
 
3640
- **request:** `Pinnacle.AttachWebhookParams`
3641
-
3931
+ **request:** `Pinnacle.AttachWebhookParams`
3932
+
3642
3933
  </dd>
3643
3934
  </dl>
3644
3935
 
3645
3936
  <dl>
3646
3937
  <dd>
3647
3938
 
3648
- **requestOptions:** `Webhook.RequestOptions`
3649
-
3939
+ **requestOptions:** `Webhook.RequestOptions`
3940
+
3650
3941
  </dd>
3651
3942
  </dl>
3652
3943
  </dd>
3653
3944
  </dl>
3654
3945
 
3946
+
3655
3947
  </dd>
3656
3948
  </dl>
3657
3949
  </details>
@@ -3671,7 +3963,6 @@ Must be a phone number that you own and have already [purchased](./buy) through
3671
3963
  Disconnect a webhook from your phone number to stop receiving event notifications for that specific number. <br>
3672
3964
 
3673
3965
  The webhook configuration itself remains intact and available for use with other phone numbers.
3674
-
3675
3966
  </dd>
3676
3967
  </dl>
3677
3968
  </dd>
@@ -3687,8 +3978,8 @@ The webhook configuration itself remains intact and available for use with other
3687
3978
 
3688
3979
  ```typescript
3689
3980
  await client.phoneNumbers.webhook.detach("+14155551234", "wh_1234567890");
3690
- ```
3691
3981
 
3982
+ ```
3692
3983
  </dd>
3693
3984
  </dl>
3694
3985
  </dd>
@@ -3702,43 +3993,43 @@ await client.phoneNumbers.webhook.detach("+14155551234", "wh_1234567890");
3702
3993
  <dl>
3703
3994
  <dd>
3704
3995
 
3705
- **phone:** `string`
3996
+ **phone:** `string`
3706
3997
 
3707
3998
  The phone number you want to attach the webhook to in E.164 format. Make sure it is url encoded (i.e. replace the leading + with %2B). <br>
3708
3999
 
3709
4000
  Must be a phone number that you own and currently has the specified webhook attached.
3710
-
4001
+
3711
4002
  </dd>
3712
4003
  </dl>
3713
4004
 
3714
4005
  <dl>
3715
4006
  <dd>
3716
4007
 
3717
- **webhookId:** `string`
4008
+ **webhookId:** `string`
3718
4009
 
3719
4010
  The unique identifier of the webhook you want to detach from the phone number. <br>
3720
4011
 
3721
4012
  This must be a valid webhook ID that is currently attached to the specified phone number. This identifier is a string that always begins with the prefix `wh_`, for example: `wh_1234567890`.
3722
-
4013
+
3723
4014
  </dd>
3724
4015
  </dl>
3725
4016
 
3726
4017
  <dl>
3727
4018
  <dd>
3728
4019
 
3729
- **requestOptions:** `Webhook.RequestOptions`
3730
-
4020
+ **requestOptions:** `Webhook.RequestOptions`
4021
+
3731
4022
  </dd>
3732
4023
  </dl>
3733
4024
  </dd>
3734
4025
  </dl>
3735
4026
 
4027
+
3736
4028
  </dd>
3737
4029
  </dl>
3738
4030
  </details>
3739
4031
 
3740
4032
  ## PhoneNumbers Campaign
3741
-
3742
4033
  <details><summary><code>client.phoneNumbers.campaign.<a href="/src/api/resources/phoneNumbers/resources/campaign/client/Client.ts">attach</a>({ ...params }) -> Pinnacle.AttachedPhoneNumberResult</code></summary>
3743
4034
  <dl>
3744
4035
  <dd>
@@ -3752,7 +4043,6 @@ This must be a valid webhook ID that is currently attached to the specified phon
3752
4043
  <dd>
3753
4044
 
3754
4045
  Link a phone number to a specific campaign. Phone numbers must be linked to a campaign to send messages.
3755
-
3756
4046
  </dd>
3757
4047
  </dl>
3758
4048
  </dd>
@@ -3770,10 +4060,10 @@ Link a phone number to a specific campaign. Phone numbers must be linked to a ca
3770
4060
  await client.phoneNumbers.campaign.attach({
3771
4061
  phones: ["+14155550123", "+14155559876", "+14155550111"],
3772
4062
  campaignType: "TOLL_FREE",
3773
- campaignId: "tf_1234567890",
4063
+ campaignId: "tf_1234567890"
3774
4064
  });
3775
- ```
3776
4065
 
4066
+ ```
3777
4067
  </dd>
3778
4068
  </dl>
3779
4069
  </dd>
@@ -3787,21 +4077,22 @@ await client.phoneNumbers.campaign.attach({
3787
4077
  <dl>
3788
4078
  <dd>
3789
4079
 
3790
- **request:** `Pinnacle.phoneNumbers.AttachCampaignParams`
3791
-
4080
+ **request:** `Pinnacle.phoneNumbers.AttachCampaignParams`
4081
+
3792
4082
  </dd>
3793
4083
  </dl>
3794
4084
 
3795
4085
  <dl>
3796
4086
  <dd>
3797
4087
 
3798
- **requestOptions:** `Campaign.RequestOptions`
3799
-
4088
+ **requestOptions:** `Campaign.RequestOptions`
4089
+
3800
4090
  </dd>
3801
4091
  </dl>
3802
4092
  </dd>
3803
4093
  </dl>
3804
4094
 
4095
+
3805
4096
  </dd>
3806
4097
  </dl>
3807
4098
  </details>
@@ -3819,7 +4110,6 @@ await client.phoneNumbers.campaign.attach({
3819
4110
  <dd>
3820
4111
 
3821
4112
  Remove the association between a phone number and its attached campaign.
3822
-
3823
4113
  </dd>
3824
4114
  </dl>
3825
4115
  </dd>
@@ -3835,10 +4125,10 @@ Remove the association between a phone number and its attached campaign.
3835
4125
 
3836
4126
  ```typescript
3837
4127
  await client.phoneNumbers.campaign.detach({
3838
- phones: ["+14155559876", "14155550111"],
4128
+ phones: ["+14155559876", "14155550111"]
3839
4129
  });
3840
- ```
3841
4130
 
4131
+ ```
3842
4132
  </dd>
3843
4133
  </dl>
3844
4134
  </dd>
@@ -3852,27 +4142,27 @@ await client.phoneNumbers.campaign.detach({
3852
4142
  <dl>
3853
4143
  <dd>
3854
4144
 
3855
- **request:** `Pinnacle.phoneNumbers.DetachCampaignParams`
3856
-
4145
+ **request:** `Pinnacle.phoneNumbers.DetachCampaignParams`
4146
+
3857
4147
  </dd>
3858
4148
  </dl>
3859
4149
 
3860
4150
  <dl>
3861
4151
  <dd>
3862
4152
 
3863
- **requestOptions:** `Campaign.RequestOptions`
3864
-
4153
+ **requestOptions:** `Campaign.RequestOptions`
4154
+
3865
4155
  </dd>
3866
4156
  </dl>
3867
4157
  </dd>
3868
4158
  </dl>
3869
4159
 
4160
+
3870
4161
  </dd>
3871
4162
  </dl>
3872
4163
  </details>
3873
4164
 
3874
4165
  ## Status Get
3875
-
3876
4166
  <details><summary><code>client.status.get.<a href="/src/api/resources/status/resources/get/client/Client.ts">brand</a>(brandId) -> Pinnacle.BrandStatus</code></summary>
3877
4167
  <dl>
3878
4168
  <dd>
@@ -3886,7 +4176,6 @@ await client.phoneNumbers.campaign.detach({
3886
4176
  <dd>
3887
4177
 
3888
4178
  Retrieve a brand's status.
3889
-
3890
4179
  </dd>
3891
4180
  </dl>
3892
4181
  </dd>
@@ -3902,8 +4191,8 @@ Retrieve a brand's status.
3902
4191
 
3903
4192
  ```typescript
3904
4193
  await client.status.get.brand("b_1234567890");
3905
- ```
3906
4194
 
4195
+ ```
3907
4196
  </dd>
3908
4197
  </dl>
3909
4198
  </dd>
@@ -3918,20 +4207,21 @@ await client.status.get.brand("b_1234567890");
3918
4207
  <dd>
3919
4208
 
3920
4209
  **brandId:** `string` — The unique identifier of the brand you want to retrieve the status for. This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`.
3921
-
4210
+
3922
4211
  </dd>
3923
4212
  </dl>
3924
4213
 
3925
4214
  <dl>
3926
4215
  <dd>
3927
4216
 
3928
- **requestOptions:** `Get.RequestOptions`
3929
-
4217
+ **requestOptions:** `Get.RequestOptions`
4218
+
3930
4219
  </dd>
3931
4220
  </dl>
3932
4221
  </dd>
3933
4222
  </dl>
3934
4223
 
4224
+
3935
4225
  </dd>
3936
4226
  </dl>
3937
4227
  </details>
@@ -3949,7 +4239,6 @@ await client.status.get.brand("b_1234567890");
3949
4239
  <dd>
3950
4240
 
3951
4241
  Retrieve a toll-free campaign's status.
3952
-
3953
4242
  </dd>
3954
4243
  </dl>
3955
4244
  </dd>
@@ -3965,8 +4254,8 @@ Retrieve a toll-free campaign's status.
3965
4254
 
3966
4255
  ```typescript
3967
4256
  await client.status.get.tollFree("tf_1234567890");
3968
- ```
3969
4257
 
4258
+ ```
3970
4259
  </dd>
3971
4260
  </dl>
3972
4261
  </dd>
@@ -3981,20 +4270,21 @@ await client.status.get.tollFree("tf_1234567890");
3981
4270
  <dd>
3982
4271
 
3983
4272
  **campaignId:** `string` — The unique identifier of the toll-free campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `tf_`, for example: `tf_1234567890`.
3984
-
4273
+
3985
4274
  </dd>
3986
4275
  </dl>
3987
4276
 
3988
4277
  <dl>
3989
4278
  <dd>
3990
4279
 
3991
- **requestOptions:** `Get.RequestOptions`
3992
-
4280
+ **requestOptions:** `Get.RequestOptions`
4281
+
3993
4282
  </dd>
3994
4283
  </dl>
3995
4284
  </dd>
3996
4285
  </dl>
3997
4286
 
4287
+
3998
4288
  </dd>
3999
4289
  </dl>
4000
4290
  </details>
@@ -4012,7 +4302,6 @@ await client.status.get.tollFree("tf_1234567890");
4012
4302
  <dd>
4013
4303
 
4014
4304
  Retrieve a 10DLC campaign's status.
4015
-
4016
4305
  </dd>
4017
4306
  </dl>
4018
4307
  </dd>
@@ -4028,8 +4317,8 @@ Retrieve a 10DLC campaign's status.
4028
4317
 
4029
4318
  ```typescript
4030
4319
  await client.status.get.dlc("dlc_1234567890");
4031
- ```
4032
4320
 
4321
+ ```
4033
4322
  </dd>
4034
4323
  </dl>
4035
4324
  </dd>
@@ -4044,20 +4333,21 @@ await client.status.get.dlc("dlc_1234567890");
4044
4333
  <dd>
4045
4334
 
4046
4335
  **campaignId:** `string` — The unique identifier of the 10DLC campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`.
4047
-
4336
+
4048
4337
  </dd>
4049
4338
  </dl>
4050
4339
 
4051
4340
  <dl>
4052
4341
  <dd>
4053
4342
 
4054
- **requestOptions:** `Get.RequestOptions`
4055
-
4343
+ **requestOptions:** `Get.RequestOptions`
4344
+
4056
4345
  </dd>
4057
4346
  </dl>
4058
4347
  </dd>
4059
4348
  </dl>
4060
4349
 
4350
+
4061
4351
  </dd>
4062
4352
  </dl>
4063
4353
  </details>
@@ -4075,7 +4365,6 @@ await client.status.get.dlc("dlc_1234567890");
4075
4365
  <dd>
4076
4366
 
4077
4367
  Retrieve a RCS campaign's status.
4078
-
4079
4368
  </dd>
4080
4369
  </dl>
4081
4370
  </dd>
@@ -4091,8 +4380,8 @@ Retrieve a RCS campaign's status.
4091
4380
 
4092
4381
  ```typescript
4093
4382
  await client.status.get.rcs("rcs_1234567890");
4094
- ```
4095
4383
 
4384
+ ```
4096
4385
  </dd>
4097
4386
  </dl>
4098
4387
  </dd>
@@ -4107,20 +4396,21 @@ await client.status.get.rcs("rcs_1234567890");
4107
4396
  <dd>
4108
4397
 
4109
4398
  **campaignId:** `string` — The unique identifier of the RCS campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `rcs_`, for example: `rcs_1234567890`.
4110
-
4399
+
4111
4400
  </dd>
4112
4401
  </dl>
4113
4402
 
4114
4403
  <dl>
4115
4404
  <dd>
4116
4405
 
4117
- **requestOptions:** `Get.RequestOptions`
4118
-
4406
+ **requestOptions:** `Get.RequestOptions`
4407
+
4119
4408
  </dd>
4120
4409
  </dl>
4121
4410
  </dd>
4122
4411
  </dl>
4123
4412
 
4413
+
4124
4414
  </dd>
4125
4415
  </dl>
4126
4416
  </details>
@@ -4140,7 +4430,6 @@ await client.status.get.rcs("rcs_1234567890");
4140
4430
  Retrieve a phone number's order status and campaign attachment status. <br>
4141
4431
 
4142
4432
  Check if a number is active and ready to send messages.
4143
-
4144
4433
  </dd>
4145
4434
  </dl>
4146
4435
  </dd>
@@ -4156,8 +4445,8 @@ Check if a number is active and ready to send messages.
4156
4445
 
4157
4446
  ```typescript
4158
4447
  await client.status.get.phoneNumber("+14151234567");
4159
- ```
4160
4448
 
4449
+ ```
4161
4450
  </dd>
4162
4451
  </dl>
4163
4452
  </dd>
@@ -4172,26 +4461,26 @@ await client.status.get.phoneNumber("+14151234567");
4172
4461
  <dd>
4173
4462
 
4174
4463
  **phoneNumber:** `string` — Phone number in E164 format that is in review.
4175
-
4464
+
4176
4465
  </dd>
4177
4466
  </dl>
4178
4467
 
4179
4468
  <dl>
4180
4469
  <dd>
4181
4470
 
4182
- **requestOptions:** `Get.RequestOptions`
4183
-
4471
+ **requestOptions:** `Get.RequestOptions`
4472
+
4184
4473
  </dd>
4185
4474
  </dl>
4186
4475
  </dd>
4187
4476
  </dl>
4188
4477
 
4478
+
4189
4479
  </dd>
4190
4480
  </dl>
4191
4481
  </details>
4192
4482
 
4193
4483
  ## Tools Url
4194
-
4195
4484
  <details><summary><code>client.tools.url.<a href="/src/api/resources/tools/resources/url/client/Client.ts">create</a>({ ...params }) -> Pinnacle.ShortenedUrl</code></summary>
4196
4485
  <dl>
4197
4486
  <dd>
@@ -4205,7 +4494,6 @@ await client.status.get.phoneNumber("+14151234567");
4205
4494
  <dd>
4206
4495
 
4207
4496
  Create a shortened URL that redirects visitors to the provided destination URL.
4208
-
4209
4497
  </dd>
4210
4498
  </dl>
4211
4499
  </dd>
@@ -4223,11 +4511,11 @@ Create a shortened URL that redirects visitors to the provided destination URL.
4223
4511
  await client.tools.url.create({
4224
4512
  url: "https://www.pinnacle.sh/",
4225
4513
  options: {
4226
- expiresAt: "2025-06-23T16:18:25.000Z",
4227
- },
4514
+ expiresAt: "2025-06-23T16:18:25.000Z"
4515
+ }
4228
4516
  });
4229
- ```
4230
4517
 
4518
+ ```
4231
4519
  </dd>
4232
4520
  </dl>
4233
4521
  </dd>
@@ -4241,21 +4529,22 @@ await client.tools.url.create({
4241
4529
  <dl>
4242
4530
  <dd>
4243
4531
 
4244
- **request:** `Pinnacle.tools.CreateUrlParams`
4245
-
4532
+ **request:** `Pinnacle.tools.CreateUrlParams`
4533
+
4246
4534
  </dd>
4247
4535
  </dl>
4248
4536
 
4249
4537
  <dl>
4250
4538
  <dd>
4251
4539
 
4252
- **requestOptions:** `Url.RequestOptions`
4253
-
4540
+ **requestOptions:** `Url.RequestOptions`
4541
+
4254
4542
  </dd>
4255
4543
  </dl>
4256
4544
  </dd>
4257
4545
  </dl>
4258
4546
 
4547
+
4259
4548
  </dd>
4260
4549
  </dl>
4261
4550
  </details>
@@ -4273,7 +4562,6 @@ await client.tools.url.create({
4273
4562
  <dd>
4274
4563
 
4275
4564
  Retrieve configuration and details for your shortened URL using its unique identifier.
4276
-
4277
4565
  </dd>
4278
4566
  </dl>
4279
4567
  </dd>
@@ -4289,8 +4577,8 @@ Retrieve configuration and details for your shortened URL using its unique ident
4289
4577
 
4290
4578
  ```typescript
4291
4579
  await client.tools.url.get("ePzVxILF");
4292
- ```
4293
4580
 
4581
+ ```
4294
4582
  </dd>
4295
4583
  </dl>
4296
4584
  </dd>
@@ -4304,25 +4592,26 @@ await client.tools.url.get("ePzVxILF");
4304
4592
  <dl>
4305
4593
  <dd>
4306
4594
 
4307
- **linkId:** `string`
4595
+ **linkId:** `string`
4308
4596
 
4309
4597
  Unique identifier from your shortened URL. For example, for `https://pncl.to/ePzVxILF`, the `linkId` is `ePzVxILF`. <br>
4310
4598
 
4311
4599
  See the response of [Create Shortened URL](./create-url) for more information.
4312
-
4600
+
4313
4601
  </dd>
4314
4602
  </dl>
4315
4603
 
4316
4604
  <dl>
4317
4605
  <dd>
4318
4606
 
4319
- **requestOptions:** `Url.RequestOptions`
4320
-
4607
+ **requestOptions:** `Url.RequestOptions`
4608
+
4321
4609
  </dd>
4322
4610
  </dl>
4323
4611
  </dd>
4324
4612
  </dl>
4325
4613
 
4614
+
4326
4615
  </dd>
4327
4616
  </dl>
4328
4617
  </details>
@@ -4340,7 +4629,6 @@ See the response of [Create Shortened URL](./create-url) for more information.
4340
4629
  <dd>
4341
4630
 
4342
4631
  Update the destination or expiration date of an existing shortened URL. Expiring links cannot be updated into a permalink.
4343
-
4344
4632
  </dd>
4345
4633
  </dl>
4346
4634
  </dd>
@@ -4356,10 +4644,10 @@ Update the destination or expiration date of an existing shortened URL. Expiring
4356
4644
 
4357
4645
  ```typescript
4358
4646
  await client.tools.url.update("ePzVxILF", {
4359
- url: "https://www.pinnacle.sh/",
4647
+ url: "https://www.pinnacle.sh/"
4360
4648
  });
4361
- ```
4362
4649
 
4650
+ ```
4363
4651
  </dd>
4364
4652
  </dl>
4365
4653
  </dd>
@@ -4373,39 +4661,39 @@ await client.tools.url.update("ePzVxILF", {
4373
4661
  <dl>
4374
4662
  <dd>
4375
4663
 
4376
- **linkId:** `string`
4664
+ **linkId:** `string`
4377
4665
 
4378
4666
  Unique identifier from your shortened URL. For example, for `https://pncl.to/ePzVxILF`, the `linkId` is `ePzVxILF`. <br>
4379
4667
 
4380
4668
  See the response of [Create Shortened URL](./create-url) for more information.
4381
-
4669
+
4382
4670
  </dd>
4383
4671
  </dl>
4384
4672
 
4385
4673
  <dl>
4386
4674
  <dd>
4387
4675
 
4388
- **request:** `Pinnacle.tools.UpdateUrlParams`
4389
-
4676
+ **request:** `Pinnacle.tools.UpdateUrlParams`
4677
+
4390
4678
  </dd>
4391
4679
  </dl>
4392
4680
 
4393
4681
  <dl>
4394
4682
  <dd>
4395
4683
 
4396
- **requestOptions:** `Url.RequestOptions`
4397
-
4684
+ **requestOptions:** `Url.RequestOptions`
4685
+
4398
4686
  </dd>
4399
4687
  </dl>
4400
4688
  </dd>
4401
4689
  </dl>
4402
4690
 
4691
+
4403
4692
  </dd>
4404
4693
  </dl>
4405
4694
  </details>
4406
4695
 
4407
4696
  ## Tools File
4408
-
4409
4697
  <details><summary><code>client.tools.file.<a href="/src/api/resources/tools/resources/file/client/Client.ts">upload</a>({ ...params }) -> Pinnacle.UploadResults</code></summary>
4410
4698
  <dl>
4411
4699
  <dd>
@@ -4419,7 +4707,6 @@ See the response of [Create Shortened URL](./create-url) for more information.
4419
4707
  <dd>
4420
4708
 
4421
4709
  Generate presigned URLs that let you upload files directly to our storage and allow your users to download them securely.
4422
-
4423
4710
  </dd>
4424
4711
  </dl>
4425
4712
  </dd>
@@ -4441,12 +4728,12 @@ await client.tools.file.upload({
4441
4728
  options: {
4442
4729
  deleteAt: "2025-12-31T23:59:59Z",
4443
4730
  download: {
4444
- expiresAt: "2025-06-30T12:00:00.000Z",
4445
- },
4446
- },
4731
+ expiresAt: "2025-06-30T12:00:00.000Z"
4732
+ }
4733
+ }
4447
4734
  });
4448
- ```
4449
4735
 
4736
+ ```
4450
4737
  </dd>
4451
4738
  </dl>
4452
4739
  </dd>
@@ -4460,21 +4747,22 @@ await client.tools.file.upload({
4460
4747
  <dl>
4461
4748
  <dd>
4462
4749
 
4463
- **request:** `Pinnacle.tools.UploadFileParams`
4464
-
4750
+ **request:** `Pinnacle.tools.UploadFileParams`
4751
+
4465
4752
  </dd>
4466
4753
  </dl>
4467
4754
 
4468
4755
  <dl>
4469
4756
  <dd>
4470
4757
 
4471
- **requestOptions:** `File_.RequestOptions`
4472
-
4758
+ **requestOptions:** `File_.RequestOptions`
4759
+
4473
4760
  </dd>
4474
4761
  </dl>
4475
4762
  </dd>
4476
4763
  </dl>
4477
4764
 
4765
+
4478
4766
  </dd>
4479
4767
  </dl>
4480
4768
  </details>
@@ -4511,15 +4799,10 @@ Refresh expiring presigned URLs for Pinnacle-hosted files to extend their access
4511
4799
 
4512
4800
  ```typescript
4513
4801
  await client.tools.file.refresh({
4514
- urls: [
4515
- "https://server.trypinnacle.app/storage/v1/object/sign/vault/3/test.jpg?token=oldtoken",
4516
- "https://server.trypinnacle.app/storage/v1/object/sign/vault/3/document.pdf?token=oldtoken2",
4517
- "invalid/url",
4518
- "https://google.com",
4519
- ],
4802
+ urls: ["https://server.trypinnacle.app/storage/v1/object/sign/vault/3/test.jpg?token=oldtoken", "https://server.trypinnacle.app/storage/v1/object/sign/vault/3/document.pdf?token=oldtoken2", "invalid/url", "https://google.com"]
4520
4803
  });
4521
- ```
4522
4804
 
4805
+ ```
4523
4806
  </dd>
4524
4807
  </dl>
4525
4808
  </dd>
@@ -4533,27 +4816,27 @@ await client.tools.file.refresh({
4533
4816
  <dl>
4534
4817
  <dd>
4535
4818
 
4536
- **request:** `Pinnacle.tools.RefreshFileParams`
4537
-
4819
+ **request:** `Pinnacle.tools.RefreshFileParams`
4820
+
4538
4821
  </dd>
4539
4822
  </dl>
4540
4823
 
4541
4824
  <dl>
4542
4825
  <dd>
4543
4826
 
4544
- **requestOptions:** `File_.RequestOptions`
4545
-
4827
+ **requestOptions:** `File_.RequestOptions`
4828
+
4546
4829
  </dd>
4547
4830
  </dl>
4548
4831
  </dd>
4549
4832
  </dl>
4550
4833
 
4834
+
4551
4835
  </dd>
4552
4836
  </dl>
4553
4837
  </details>
4554
4838
 
4555
4839
  ## Tools ContactCard
4556
-
4557
4840
  <details><summary><code>client.tools.contactCard.<a href="/src/api/resources/tools/resources/contactCard/client/Client.ts">get</a>({ ...params }) -> Pinnacle.VCardData</code></summary>
4558
4841
  <dl>
4559
4842
  <dd>
@@ -4567,7 +4850,6 @@ await client.tools.file.refresh({
4567
4850
  <dd>
4568
4851
 
4569
4852
  Retrieve contact information as a vCard and get a presigned URL to download the file. Contact cards can be sent [via MMS](/api-reference/messages/send-mms) as a media file.
4570
-
4571
4853
  </dd>
4572
4854
  </dl>
4573
4855
  </dd>
@@ -4583,10 +4865,10 @@ Retrieve contact information as a vCard and get a presigned URL to download the
4583
4865
 
4584
4866
  ```typescript
4585
4867
  await client.tools.contactCard.get({
4586
- id: "cc_1234567890",
4868
+ id: "cc_1234567890"
4587
4869
  });
4588
- ```
4589
4870
 
4871
+ ```
4590
4872
  </dd>
4591
4873
  </dl>
4592
4874
  </dd>
@@ -4600,21 +4882,22 @@ await client.tools.contactCard.get({
4600
4882
  <dl>
4601
4883
  <dd>
4602
4884
 
4603
- **request:** `Pinnacle.tools.GetVcardParams`
4604
-
4885
+ **request:** `Pinnacle.tools.GetVcardParams`
4886
+
4605
4887
  </dd>
4606
4888
  </dl>
4607
4889
 
4608
4890
  <dl>
4609
4891
  <dd>
4610
4892
 
4611
- **requestOptions:** `ContactCard.RequestOptions`
4612
-
4893
+ **requestOptions:** `ContactCard.RequestOptions`
4894
+
4613
4895
  </dd>
4614
4896
  </dl>
4615
4897
  </dd>
4616
4898
  </dl>
4617
4899
 
4900
+
4618
4901
  </dd>
4619
4902
  </dl>
4620
4903
  </details>
@@ -4632,7 +4915,6 @@ await client.tools.contactCard.get({
4632
4915
  <dd>
4633
4916
 
4634
4917
  Create a new contact card or updates an existing one with full vCard data. Contact cards can be sent [via MMS](/api-reference/messages/send-mms) as a media file.
4635
-
4636
4918
  </dd>
4637
4919
  </dl>
4638
4920
  </dd>
@@ -4655,12 +4937,11 @@ await client.tools.contactCard.upsert({
4655
4937
  givenName: "Jane",
4656
4938
  additionalNames: ["A."],
4657
4939
  honorificPrefixes: ["Dr."],
4658
- honorificSuffixes: ["PhD"],
4940
+ honorificSuffixes: ["PhD"]
4659
4941
  },
4660
4942
  nickname: ["Janie"],
4661
4943
  birthday: "1990-02-15",
4662
- addresses: [
4663
- {
4944
+ addresses: [{
4664
4945
  countryName: "USA",
4665
4946
  extendedAddress: "Apt. 4B",
4666
4947
  locality: "Anytown",
@@ -4668,39 +4949,34 @@ await client.tools.contactCard.upsert({
4668
4949
  postOfficeBox: "PO Box 123",
4669
4950
  region: "CA",
4670
4951
  streetAddress: "123 Main St",
4671
- type: ["HOME", "PREF"],
4672
- },
4673
- ],
4952
+ type: ["HOME", "PREF"]
4953
+ }],
4674
4954
  url: "https://app.pinnacle.sh",
4675
- phones: [
4676
- {
4955
+ phones: [{
4677
4956
  type: ["CELL"],
4678
- value: "+15551234567",
4679
- },
4680
- ],
4681
- emails: [
4682
- {
4957
+ value: "+15551234567"
4958
+ }],
4959
+ emails: [{
4683
4960
  type: ["INTERNET"],
4684
- value: "jane.smith@example.com",
4685
- },
4686
- ],
4961
+ value: "jane.smith@example.com"
4962
+ }],
4687
4963
  timezone: "America/Los_Angeles",
4688
4964
  geo: {
4689
4965
  latitude: 34.0522,
4690
- longitude: -118.2437,
4966
+ longitude: -118.2437
4691
4967
  },
4692
4968
  title: "Engineer",
4693
4969
  role: "Developer",
4694
4970
  organization: {
4695
4971
  name: "Acme Co",
4696
- units: ["Engineering", "R&D"],
4972
+ units: ["Engineering", "R&D"]
4697
4973
  },
4698
4974
  categories: ["Friend", "Colleague"],
4699
4975
  note: "Test contact entry",
4700
- photo: "https://fastly.picsum.photos/id/853/200/200.jpg?hmac=f4LF-tVBBnJb9PQAVEO8GCTGWgLUnxQLw44rUofE6mQ",
4976
+ photo: "https://fastly.picsum.photos/id/853/200/200.jpg?hmac=f4LF-tVBBnJb9PQAVEO8GCTGWgLUnxQLw44rUofE6mQ"
4701
4977
  });
4702
- ```
4703
4978
 
4979
+ ```
4704
4980
  </dd>
4705
4981
  </dl>
4706
4982
  </dd>
@@ -4714,21 +4990,22 @@ await client.tools.contactCard.upsert({
4714
4990
  <dl>
4715
4991
  <dd>
4716
4992
 
4717
- **request:** `Pinnacle.tools.UpsertVcardParams`
4718
-
4993
+ **request:** `Pinnacle.tools.UpsertVcardParams`
4994
+
4719
4995
  </dd>
4720
4996
  </dl>
4721
4997
 
4722
4998
  <dl>
4723
4999
  <dd>
4724
5000
 
4725
- **requestOptions:** `ContactCard.RequestOptions`
4726
-
5001
+ **requestOptions:** `ContactCard.RequestOptions`
5002
+
4727
5003
  </dd>
4728
5004
  </dl>
4729
5005
  </dd>
4730
5006
  </dl>
4731
5007
 
5008
+
4732
5009
  </dd>
4733
5010
  </dl>
4734
5011
  </details>