rcs-js 2.0.1 → 2.0.3

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 (252) hide show
  1. package/dist/cjs/Client.js +2 -2
  2. package/dist/cjs/api/errors/NotFoundError.d.ts +1 -2
  3. package/dist/cjs/api/resources/brands/client/Client.d.ts +13 -13
  4. package/dist/cjs/api/resources/brands/client/Client.js +10 -10
  5. package/dist/cjs/api/resources/brands/client/requests/UpsertBrandParams.d.ts +6 -3
  6. package/dist/cjs/api/resources/campaigns/resources/dlc/client/Client.d.ts +14 -13
  7. package/dist/cjs/api/resources/campaigns/resources/dlc/client/Client.js +12 -11
  8. package/dist/cjs/api/resources/campaigns/resources/dlc/client/requests/UpsertDlcCampaignParams.d.ts +8 -8
  9. package/dist/cjs/api/resources/campaigns/resources/rcs/client/Client.d.ts +11 -10
  10. package/dist/cjs/api/resources/campaigns/resources/rcs/client/Client.js +9 -8
  11. package/dist/cjs/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.ts +4 -3
  12. package/dist/cjs/api/resources/campaigns/resources/rcs/types/RcsAutofillResponse.d.ts +1 -1
  13. package/dist/cjs/api/resources/campaigns/resources/tollFree/client/Client.d.ts +12 -12
  14. package/dist/cjs/api/resources/campaigns/resources/tollFree/client/Client.js +10 -10
  15. package/dist/cjs/api/resources/campaigns/resources/tollFree/client/requests/UpsertTollFreeCampaignParams.d.ts +7 -7
  16. package/dist/cjs/api/resources/campaigns/resources/tollFree/types/TollFreeAutofillResponse.d.ts +1 -1
  17. package/dist/cjs/api/resources/contacts/client/Client.d.ts +4 -2
  18. package/dist/cjs/api/resources/contacts/client/Client.js +5 -3
  19. package/dist/cjs/api/resources/contacts/client/requests/ContactsGetRequest.d.ts +4 -2
  20. package/dist/cjs/api/resources/contacts/client/requests/UpdateContactParams.d.ts +3 -3
  21. package/dist/cjs/api/resources/conversations/client/Client.d.ts +21 -4
  22. package/dist/cjs/api/resources/conversations/client/Client.js +99 -4
  23. package/dist/cjs/api/resources/conversations/client/requests/ConversationsListMessagesRequest.d.ts +36 -0
  24. package/dist/cjs/api/resources/conversations/client/requests/ConversationsListMessagesRequest.js +5 -0
  25. package/dist/cjs/api/resources/conversations/client/requests/ListConversationsParams.d.ts +11 -6
  26. package/dist/cjs/api/resources/conversations/client/requests/UpdateConversationParams.d.ts +3 -3
  27. package/dist/cjs/api/resources/conversations/client/requests/index.d.ts +1 -0
  28. package/dist/cjs/api/resources/conversations/index.d.ts +1 -0
  29. package/dist/cjs/api/resources/conversations/index.js +1 -0
  30. package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestDirection.d.ts +8 -0
  31. package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestDirection.js +10 -0
  32. package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestSortOrder.d.ts +8 -0
  33. package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestSortOrder.js +10 -0
  34. package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestStatus.d.ts +13 -0
  35. package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestStatus.js +15 -0
  36. package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestType.d.ts +9 -0
  37. package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestType.js +11 -0
  38. package/dist/cjs/api/resources/conversations/types/index.d.ts +4 -0
  39. package/dist/cjs/api/resources/conversations/types/index.js +20 -0
  40. package/dist/cjs/api/resources/index.d.ts +2 -1
  41. package/dist/cjs/api/resources/index.js +3 -2
  42. package/dist/cjs/api/resources/messages/client/Client.d.ts +4 -4
  43. package/dist/cjs/api/resources/messages/client/Client.js +3 -3
  44. package/dist/cjs/api/resources/messages/client/requests/ReactMessageParams.d.ts +3 -3
  45. package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/Client.d.ts +1 -1
  46. package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/Client.js +1 -1
  47. package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/requests/AttachCampaignParams.d.ts +12 -3
  48. package/dist/cjs/api/resources/phoneNumbers/resources/webhook/client/Client.d.ts +5 -5
  49. package/dist/cjs/api/resources/phoneNumbers/resources/webhook/client/Client.js +4 -4
  50. package/dist/cjs/api/resources/rcs/client/Client.d.ts +11 -7
  51. package/dist/cjs/api/resources/rcs/client/Client.js +11 -7
  52. package/dist/cjs/api/resources/status/resources/get/client/Client.d.ts +12 -12
  53. package/dist/cjs/api/resources/status/resources/get/client/Client.js +8 -8
  54. package/dist/cjs/api/resources/tools/resources/contactCard/client/Client.d.ts +2 -2
  55. package/dist/cjs/api/resources/tools/resources/contactCard/client/Client.js +2 -2
  56. package/dist/cjs/api/resources/tools/resources/contactCard/client/requests/GetVcardParams.d.ts +3 -3
  57. package/dist/cjs/api/resources/tools/resources/contactCard/client/requests/UpsertVcardParams.d.ts +1 -1
  58. package/dist/cjs/api/resources/tools/resources/file/client/Client.d.ts +2 -1
  59. package/dist/cjs/api/resources/tools/resources/file/client/Client.js +2 -1
  60. package/dist/cjs/api/resources/tools/resources/file/client/requests/RefreshFileParams.d.ts +3 -11
  61. package/dist/cjs/api/resources/tools/resources/file/client/requests/UploadFileParams.d.ts +7 -0
  62. package/dist/cjs/api/types/AttachWebhookParams.d.ts +1 -1
  63. package/dist/cjs/api/types/AttachedPhoneNumberResult.d.ts +2 -2
  64. package/dist/cjs/api/types/AutofillCampaignParams.d.ts +7 -2
  65. package/dist/cjs/api/types/AutofillDlcCampaignResponse.d.ts +4 -4
  66. package/dist/cjs/api/types/BrandStatus.d.ts +2 -2
  67. package/dist/cjs/api/types/ButtonClickedData.d.ts +2 -2
  68. package/dist/cjs/api/types/CampaignQuery.d.ts +6 -1
  69. package/dist/cjs/api/types/ConfiguredWebhook.d.ts +2 -2
  70. package/dist/cjs/api/types/Contact.d.ts +2 -2
  71. package/dist/cjs/api/types/ContactId.d.ts +2 -2
  72. package/dist/cjs/api/types/Conversation.d.ts +7 -7
  73. package/dist/cjs/api/types/ConversationList.d.ts +4 -4
  74. package/dist/cjs/api/types/DetachedPhoneNumberResult.d.ts +2 -2
  75. package/dist/cjs/api/types/DetachedWebhookInfo.d.ts +2 -2
  76. package/dist/cjs/api/types/DlcCampaignStatus.d.ts +2 -2
  77. package/dist/cjs/api/types/DlcCampaignWithExtendedBrandAndStatus.d.ts +2 -2
  78. package/dist/cjs/api/types/ExtendedBrand.d.ts +2 -2
  79. package/dist/cjs/api/types/ExtendedRcsCampaign.d.ts +2 -2
  80. package/dist/cjs/api/types/GetConversationParams.d.ts +1 -1
  81. package/dist/cjs/api/types/LinkClickEvent.d.ts +0 -4
  82. package/dist/cjs/api/types/Message.d.ts +2 -2
  83. package/dist/cjs/api/types/MessageEvent.d.ts +6 -12
  84. package/dist/cjs/api/types/MessageEventContent.d.ts +29 -0
  85. package/dist/cjs/api/types/MessageEventContent.js +5 -0
  86. package/dist/cjs/api/types/MessageEventMmsContent.d.ts +23 -0
  87. package/dist/cjs/api/types/MessageEventMmsContent.js +5 -0
  88. package/dist/cjs/api/types/MessageEventRcsButtonData.d.ts +18 -0
  89. package/dist/cjs/api/types/MessageEventRcsButtonData.js +5 -0
  90. package/dist/cjs/api/types/MessageEventRcsCardsContent.d.ts +39 -0
  91. package/dist/cjs/api/types/MessageEventRcsCardsContent.js +5 -0
  92. package/dist/cjs/api/types/MessageEventRcsLocationData.d.ts +18 -0
  93. package/dist/cjs/api/types/MessageEventRcsLocationData.js +5 -0
  94. package/dist/cjs/api/types/MessageEventRcsMediaContent.d.ts +22 -0
  95. package/dist/cjs/api/types/MessageEventRcsMediaContent.js +5 -0
  96. package/dist/cjs/api/types/MessageEventRcsTextContent.d.ts +20 -0
  97. package/dist/cjs/api/types/MessageEventRcsTextContent.js +5 -0
  98. package/dist/cjs/api/types/MessageEventSmsContent.d.ts +17 -0
  99. package/dist/cjs/api/types/MessageEventSmsContent.js +5 -0
  100. package/dist/cjs/api/types/MessageList.d.ts +15 -0
  101. package/dist/cjs/api/types/MessageList.js +5 -0
  102. package/dist/cjs/api/types/MessageWithReaction.d.ts +27 -0
  103. package/dist/cjs/api/types/MessageWithReaction.js +13 -0
  104. package/dist/cjs/api/types/NotFoundErrorBody.d.ts +6 -0
  105. package/dist/cjs/api/types/NotFoundErrorBody.js +5 -0
  106. package/dist/cjs/api/types/RcsCampaign.d.ts +1 -1
  107. package/dist/cjs/api/types/RcsCampaignStatus.d.ts +2 -2
  108. package/dist/cjs/api/types/ReactionResult.d.ts +4 -4
  109. package/dist/cjs/api/types/ScheduledMessaage.d.ts +2 -2
  110. package/dist/cjs/api/types/SentMmsDetails.d.ts +2 -2
  111. package/dist/cjs/api/types/SentRcsDetails.d.ts +2 -2
  112. package/dist/cjs/api/types/SentSmsDetails.d.ts +2 -2
  113. package/dist/cjs/api/types/TollFreeCampaign.d.ts +2 -2
  114. package/dist/cjs/api/types/TollFreeCampaignStatus.d.ts +2 -2
  115. package/dist/cjs/api/types/UpdatedContactId.d.ts +2 -2
  116. package/dist/cjs/api/types/UploadResults.d.ts +6 -0
  117. package/dist/cjs/api/types/ValidateCampaignParams.d.ts +7 -2
  118. package/dist/cjs/api/types/Vcard.d.ts +2 -2
  119. package/dist/cjs/api/types/VcardResource.d.ts +2 -2
  120. package/dist/cjs/api/types/Webhooks.d.ts +2 -2
  121. package/dist/cjs/api/types/index.d.ts +11 -0
  122. package/dist/cjs/api/types/index.js +11 -0
  123. package/dist/cjs/version.d.ts +1 -1
  124. package/dist/cjs/version.js +1 -1
  125. package/dist/cjs/wrapper/messages/Client.js +8 -3
  126. package/dist/esm/Client.mjs +2 -2
  127. package/dist/esm/api/errors/NotFoundError.d.mts +1 -2
  128. package/dist/esm/api/resources/brands/client/Client.d.mts +13 -13
  129. package/dist/esm/api/resources/brands/client/Client.mjs +10 -10
  130. package/dist/esm/api/resources/brands/client/requests/UpsertBrandParams.d.mts +6 -3
  131. package/dist/esm/api/resources/campaigns/resources/dlc/client/Client.d.mts +14 -13
  132. package/dist/esm/api/resources/campaigns/resources/dlc/client/Client.mjs +12 -11
  133. package/dist/esm/api/resources/campaigns/resources/dlc/client/requests/UpsertDlcCampaignParams.d.mts +8 -8
  134. package/dist/esm/api/resources/campaigns/resources/rcs/client/Client.d.mts +11 -10
  135. package/dist/esm/api/resources/campaigns/resources/rcs/client/Client.mjs +9 -8
  136. package/dist/esm/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.mts +4 -3
  137. package/dist/esm/api/resources/campaigns/resources/rcs/types/RcsAutofillResponse.d.mts +1 -1
  138. package/dist/esm/api/resources/campaigns/resources/tollFree/client/Client.d.mts +12 -12
  139. package/dist/esm/api/resources/campaigns/resources/tollFree/client/Client.mjs +10 -10
  140. package/dist/esm/api/resources/campaigns/resources/tollFree/client/requests/UpsertTollFreeCampaignParams.d.mts +7 -7
  141. package/dist/esm/api/resources/campaigns/resources/tollFree/types/TollFreeAutofillResponse.d.mts +1 -1
  142. package/dist/esm/api/resources/contacts/client/Client.d.mts +4 -2
  143. package/dist/esm/api/resources/contacts/client/Client.mjs +5 -3
  144. package/dist/esm/api/resources/contacts/client/requests/ContactsGetRequest.d.mts +4 -2
  145. package/dist/esm/api/resources/contacts/client/requests/UpdateContactParams.d.mts +3 -3
  146. package/dist/esm/api/resources/conversations/client/Client.d.mts +21 -4
  147. package/dist/esm/api/resources/conversations/client/Client.mjs +99 -4
  148. package/dist/esm/api/resources/conversations/client/requests/ConversationsListMessagesRequest.d.mts +36 -0
  149. package/dist/esm/api/resources/conversations/client/requests/ConversationsListMessagesRequest.mjs +4 -0
  150. package/dist/esm/api/resources/conversations/client/requests/ListConversationsParams.d.mts +11 -6
  151. package/dist/esm/api/resources/conversations/client/requests/UpdateConversationParams.d.mts +3 -3
  152. package/dist/esm/api/resources/conversations/client/requests/index.d.mts +1 -0
  153. package/dist/esm/api/resources/conversations/index.d.mts +1 -0
  154. package/dist/esm/api/resources/conversations/index.mjs +1 -0
  155. package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestDirection.d.mts +8 -0
  156. package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestDirection.mjs +7 -0
  157. package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestSortOrder.d.mts +8 -0
  158. package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestSortOrder.mjs +7 -0
  159. package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestStatus.d.mts +13 -0
  160. package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestStatus.mjs +12 -0
  161. package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestType.d.mts +9 -0
  162. package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestType.mjs +8 -0
  163. package/dist/esm/api/resources/conversations/types/index.d.mts +4 -0
  164. package/dist/esm/api/resources/conversations/types/index.mjs +4 -0
  165. package/dist/esm/api/resources/index.d.mts +2 -1
  166. package/dist/esm/api/resources/index.mjs +2 -1
  167. package/dist/esm/api/resources/messages/client/Client.d.mts +4 -4
  168. package/dist/esm/api/resources/messages/client/Client.mjs +3 -3
  169. package/dist/esm/api/resources/messages/client/requests/ReactMessageParams.d.mts +3 -3
  170. package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/Client.d.mts +1 -1
  171. package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/Client.mjs +1 -1
  172. package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/requests/AttachCampaignParams.d.mts +12 -3
  173. package/dist/esm/api/resources/phoneNumbers/resources/webhook/client/Client.d.mts +5 -5
  174. package/dist/esm/api/resources/phoneNumbers/resources/webhook/client/Client.mjs +4 -4
  175. package/dist/esm/api/resources/rcs/client/Client.d.mts +11 -7
  176. package/dist/esm/api/resources/rcs/client/Client.mjs +11 -7
  177. package/dist/esm/api/resources/status/resources/get/client/Client.d.mts +12 -12
  178. package/dist/esm/api/resources/status/resources/get/client/Client.mjs +8 -8
  179. package/dist/esm/api/resources/tools/resources/contactCard/client/Client.d.mts +2 -2
  180. package/dist/esm/api/resources/tools/resources/contactCard/client/Client.mjs +2 -2
  181. package/dist/esm/api/resources/tools/resources/contactCard/client/requests/GetVcardParams.d.mts +3 -3
  182. package/dist/esm/api/resources/tools/resources/contactCard/client/requests/UpsertVcardParams.d.mts +1 -1
  183. package/dist/esm/api/resources/tools/resources/file/client/Client.d.mts +2 -1
  184. package/dist/esm/api/resources/tools/resources/file/client/Client.mjs +2 -1
  185. package/dist/esm/api/resources/tools/resources/file/client/requests/RefreshFileParams.d.mts +3 -11
  186. package/dist/esm/api/resources/tools/resources/file/client/requests/UploadFileParams.d.mts +7 -0
  187. package/dist/esm/api/types/AttachWebhookParams.d.mts +1 -1
  188. package/dist/esm/api/types/AttachedPhoneNumberResult.d.mts +2 -2
  189. package/dist/esm/api/types/AutofillCampaignParams.d.mts +7 -2
  190. package/dist/esm/api/types/AutofillDlcCampaignResponse.d.mts +4 -4
  191. package/dist/esm/api/types/BrandStatus.d.mts +2 -2
  192. package/dist/esm/api/types/ButtonClickedData.d.mts +2 -2
  193. package/dist/esm/api/types/CampaignQuery.d.mts +6 -1
  194. package/dist/esm/api/types/ConfiguredWebhook.d.mts +2 -2
  195. package/dist/esm/api/types/Contact.d.mts +2 -2
  196. package/dist/esm/api/types/ContactId.d.mts +2 -2
  197. package/dist/esm/api/types/Conversation.d.mts +7 -7
  198. package/dist/esm/api/types/ConversationList.d.mts +4 -4
  199. package/dist/esm/api/types/DetachedPhoneNumberResult.d.mts +2 -2
  200. package/dist/esm/api/types/DetachedWebhookInfo.d.mts +2 -2
  201. package/dist/esm/api/types/DlcCampaignStatus.d.mts +2 -2
  202. package/dist/esm/api/types/DlcCampaignWithExtendedBrandAndStatus.d.mts +2 -2
  203. package/dist/esm/api/types/ExtendedBrand.d.mts +2 -2
  204. package/dist/esm/api/types/ExtendedRcsCampaign.d.mts +2 -2
  205. package/dist/esm/api/types/GetConversationParams.d.mts +1 -1
  206. package/dist/esm/api/types/LinkClickEvent.d.mts +0 -4
  207. package/dist/esm/api/types/Message.d.mts +2 -2
  208. package/dist/esm/api/types/MessageEvent.d.mts +6 -12
  209. package/dist/esm/api/types/MessageEventContent.d.mts +29 -0
  210. package/dist/esm/api/types/MessageEventContent.mjs +4 -0
  211. package/dist/esm/api/types/MessageEventMmsContent.d.mts +23 -0
  212. package/dist/esm/api/types/MessageEventMmsContent.mjs +4 -0
  213. package/dist/esm/api/types/MessageEventRcsButtonData.d.mts +18 -0
  214. package/dist/esm/api/types/MessageEventRcsButtonData.mjs +4 -0
  215. package/dist/esm/api/types/MessageEventRcsCardsContent.d.mts +39 -0
  216. package/dist/esm/api/types/MessageEventRcsCardsContent.mjs +4 -0
  217. package/dist/esm/api/types/MessageEventRcsLocationData.d.mts +18 -0
  218. package/dist/esm/api/types/MessageEventRcsLocationData.mjs +4 -0
  219. package/dist/esm/api/types/MessageEventRcsMediaContent.d.mts +22 -0
  220. package/dist/esm/api/types/MessageEventRcsMediaContent.mjs +4 -0
  221. package/dist/esm/api/types/MessageEventRcsTextContent.d.mts +20 -0
  222. package/dist/esm/api/types/MessageEventRcsTextContent.mjs +4 -0
  223. package/dist/esm/api/types/MessageEventSmsContent.d.mts +17 -0
  224. package/dist/esm/api/types/MessageEventSmsContent.mjs +4 -0
  225. package/dist/esm/api/types/MessageList.d.mts +15 -0
  226. package/dist/esm/api/types/MessageList.mjs +4 -0
  227. package/dist/esm/api/types/MessageWithReaction.d.mts +27 -0
  228. package/dist/esm/api/types/MessageWithReaction.mjs +10 -0
  229. package/dist/esm/api/types/NotFoundErrorBody.d.mts +6 -0
  230. package/dist/esm/api/types/NotFoundErrorBody.mjs +4 -0
  231. package/dist/esm/api/types/RcsCampaign.d.mts +1 -1
  232. package/dist/esm/api/types/RcsCampaignStatus.d.mts +2 -2
  233. package/dist/esm/api/types/ReactionResult.d.mts +4 -4
  234. package/dist/esm/api/types/ScheduledMessaage.d.mts +2 -2
  235. package/dist/esm/api/types/SentMmsDetails.d.mts +2 -2
  236. package/dist/esm/api/types/SentRcsDetails.d.mts +2 -2
  237. package/dist/esm/api/types/SentSmsDetails.d.mts +2 -2
  238. package/dist/esm/api/types/TollFreeCampaign.d.mts +2 -2
  239. package/dist/esm/api/types/TollFreeCampaignStatus.d.mts +2 -2
  240. package/dist/esm/api/types/UpdatedContactId.d.mts +2 -2
  241. package/dist/esm/api/types/UploadResults.d.mts +6 -0
  242. package/dist/esm/api/types/ValidateCampaignParams.d.mts +7 -2
  243. package/dist/esm/api/types/Vcard.d.mts +2 -2
  244. package/dist/esm/api/types/VcardResource.d.mts +2 -2
  245. package/dist/esm/api/types/Webhooks.d.mts +2 -2
  246. package/dist/esm/api/types/index.d.mts +11 -0
  247. package/dist/esm/api/types/index.mjs +11 -0
  248. package/dist/esm/version.d.mts +1 -1
  249. package/dist/esm/version.mjs +1 -1
  250. package/dist/esm/wrapper/messages/Client.mjs +8 -3
  251. package/package.json +3 -3
  252. package/reference.md +156 -73
@@ -6,19 +6,19 @@ import * as Pinnacle from "../../../../../../index.mjs";
6
6
  * @example
7
7
  * {
8
8
  * autoRenew: true,
9
- * brand: 1,
10
- * campaignId: 161,
9
+ * brand: "b_1234567890",
10
+ * campaignId: "dlc_1234567890",
11
11
  * keywords: {
12
12
  * HELP: {
13
13
  * message: "Reply HELP for assistance, STOP to opt-out",
14
14
  * values: ["HELP", "INFO", "SUPPORT"]
15
15
  * },
16
16
  * OPT_IN: {
17
- * message: "Welcome! You're now subscribed to Pinnacle.",
17
+ * message: "Welcome. You are now subscribed to Pinnacle.",
18
18
  * values: ["JOIN", "START", "SUBSCRIBE"]
19
19
  * },
20
20
  * OPT_OUT: {
21
- * message: "You've been unsubscribed. Reply START to rejoin.",
21
+ * message: "You have been unsubscribed. Reply START to rejoin.",
22
22
  * values: ["STOP", "QUIT", "UNSUBSCRIBE"]
23
23
  * }
24
24
  * },
@@ -46,10 +46,10 @@ import * as Pinnacle from "../../../../../../index.mjs";
46
46
  export interface UpsertDlcCampaignParams {
47
47
  /** Whether the campaign renews automatically. */
48
48
  autoRenew?: boolean;
49
- /** Brand id. */
50
- brand?: number;
51
- /** Unique identifier for the campaign. */
52
- campaignId?: number;
49
+ /** Brand id. This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`. */
50
+ brand?: string;
51
+ /** Unique identifier for the campaign. This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`. */
52
+ campaignId?: string;
53
53
  /** Description of the campaign. */
54
54
  description?: string;
55
55
  /** Keyword response configuration. */
@@ -41,8 +41,8 @@ export declare class Rcs {
41
41
  *
42
42
  * @example
43
43
  * await client.campaigns.rcs.autofill({
44
- * additionalInfo: "Please autofill missing DLC campaign fields using my brand profile",
45
- * campaignId: 161
44
+ * additionalInfo: "Please autofill missing campaign fields using my brand profile",
45
+ * campaignId: "dlc_1234567890"
46
46
  * })
47
47
  */
48
48
  autofill(request: Pinnacle.AutofillCampaignParams, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.campaigns.RcsAutofillResponse>;
@@ -50,7 +50,7 @@ export declare class Rcs {
50
50
  /**
51
51
  * Retrieve RCS campaign.
52
52
  *
53
- * @param {number} campaignId - Unique identifier of the RCS campaign.
53
+ * @param {string} campaignId - Unique identifier of the RCS campaign. Must begin with the prefix `rcs_`.
54
54
  * @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
55
55
  *
56
56
  * @throws {@link Pinnacle.BadRequestError}
@@ -59,14 +59,14 @@ export declare class Rcs {
59
59
  * @throws {@link Pinnacle.InternalServerError}
60
60
  *
61
61
  * @example
62
- * await client.campaigns.rcs.get(161)
62
+ * await client.campaigns.rcs.get("rcs_1234567890")
63
63
  */
64
- get(campaignId: number, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.ExtendedRcsCampaign>;
64
+ get(campaignId: string, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.ExtendedRcsCampaign>;
65
65
  private __get;
66
66
  /**
67
67
  * Submit your RCS campaign for approval and activation with carriers.
68
68
  *
69
- * @param {number} campaignId - Unique identifier of the RCS campaign to retrieve.
69
+ * @param {string} campaignId - Unique identifier of the RCS campaign to retrieve. Must begin with the prefix `rcs_`.
70
70
  * @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
71
71
  *
72
72
  * @throws {@link Pinnacle.BadRequestError}
@@ -76,9 +76,9 @@ export declare class Rcs {
76
76
  * @throws {@link Pinnacle.InternalServerError}
77
77
  *
78
78
  * @example
79
- * await client.campaigns.rcs.submit(161)
79
+ * await client.campaigns.rcs.submit("rcs_1234567890")
80
80
  */
81
- submit(campaignId: number, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignSubmissionResult>;
81
+ submit(campaignId: string, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignSubmissionResult>;
82
82
  private __submit;
83
83
  /**
84
84
  * Create a new RCS campaign or updates an existing one. <br>
@@ -115,7 +115,8 @@ export declare class Rcs {
115
115
  * }]
116
116
  * },
117
117
  * brandVerificationUrl: "https://www.pinnacle.sh/articles-of-incorporation.pdf",
118
- * brand: 2,
118
+ * brand: "b_1234567890",
119
+ * campaignId: "rcs_1234567890",
119
120
  * expectedAgentResponses: ["Here are the things I can help you with.", "I can assist you with booking an appointment, or you may choose to book manually.", "Here are the available times to connect with a representative tomorrow.", "Your appointment has been scheduled."],
120
121
  * links: {
121
122
  * privacyPolicy: "https://www.trypinnacle.app/privacy",
@@ -150,7 +151,7 @@ export declare class Rcs {
150
151
  * @example
151
152
  * await client.campaigns.rcs.validate({
152
153
  * additionalInfo: "Please validate this DLC campaign for 10DLC compliance",
153
- * campaignId: 161
154
+ * campaignId: "dlc_1234567890"
154
155
  * })
155
156
  */
156
157
  validate(request: Pinnacle.ValidateCampaignParams, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignValidationResult>;
@@ -31,8 +31,8 @@ export class Rcs {
31
31
  *
32
32
  * @example
33
33
  * await client.campaigns.rcs.autofill({
34
- * additionalInfo: "Please autofill missing DLC campaign fields using my brand profile",
35
- * campaignId: 161
34
+ * additionalInfo: "Please autofill missing campaign fields using my brand profile",
35
+ * campaignId: "dlc_1234567890"
36
36
  * })
37
37
  */
38
38
  autofill(request, requestOptions) {
@@ -96,7 +96,7 @@ export class Rcs {
96
96
  /**
97
97
  * Retrieve RCS campaign.
98
98
  *
99
- * @param {number} campaignId - Unique identifier of the RCS campaign.
99
+ * @param {string} campaignId - Unique identifier of the RCS campaign. Must begin with the prefix `rcs_`.
100
100
  * @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
101
101
  *
102
102
  * @throws {@link Pinnacle.BadRequestError}
@@ -105,7 +105,7 @@ export class Rcs {
105
105
  * @throws {@link Pinnacle.InternalServerError}
106
106
  *
107
107
  * @example
108
- * await client.campaigns.rcs.get(161)
108
+ * await client.campaigns.rcs.get("rcs_1234567890")
109
109
  */
110
110
  get(campaignId, requestOptions) {
111
111
  return core.HttpResponsePromise.fromPromise(this.__get(campaignId, requestOptions));
@@ -164,7 +164,7 @@ export class Rcs {
164
164
  /**
165
165
  * Submit your RCS campaign for approval and activation with carriers.
166
166
  *
167
- * @param {number} campaignId - Unique identifier of the RCS campaign to retrieve.
167
+ * @param {string} campaignId - Unique identifier of the RCS campaign to retrieve. Must begin with the prefix `rcs_`.
168
168
  * @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
169
169
  *
170
170
  * @throws {@link Pinnacle.BadRequestError}
@@ -174,7 +174,7 @@ export class Rcs {
174
174
  * @throws {@link Pinnacle.InternalServerError}
175
175
  *
176
176
  * @example
177
- * await client.campaigns.rcs.submit(161)
177
+ * await client.campaigns.rcs.submit("rcs_1234567890")
178
178
  */
179
179
  submit(campaignId, requestOptions) {
180
180
  return core.HttpResponsePromise.fromPromise(this.__submit(campaignId, requestOptions));
@@ -267,7 +267,8 @@ export class Rcs {
267
267
  * }]
268
268
  * },
269
269
  * brandVerificationUrl: "https://www.pinnacle.sh/articles-of-incorporation.pdf",
270
- * brand: 2,
270
+ * brand: "b_1234567890",
271
+ * campaignId: "rcs_1234567890",
271
272
  * 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."],
272
273
  * links: {
273
274
  * privacyPolicy: "https://www.trypinnacle.app/privacy",
@@ -357,7 +358,7 @@ export class Rcs {
357
358
  * @example
358
359
  * await client.campaigns.rcs.validate({
359
360
  * additionalInfo: "Please validate this DLC campaign for 10DLC compliance",
360
- * campaignId: 161
361
+ * campaignId: "dlc_1234567890"
361
362
  * })
362
363
  */
363
364
  validate(request, requestOptions) {
@@ -25,7 +25,8 @@ import * as Pinnacle from "../../../../../../index.mjs";
25
25
  * }]
26
26
  * },
27
27
  * brandVerificationUrl: "https://www.pinnacle.sh/articles-of-incorporation.pdf",
28
- * brand: 2,
28
+ * brand: "b_1234567890",
29
+ * campaignId: "rcs_1234567890",
29
30
  * 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."],
30
31
  * links: {
31
32
  * privacyPolicy: "https://www.trypinnacle.app/privacy",
@@ -51,9 +52,9 @@ export interface UpsertRcsCampaignParams {
51
52
  /** Link to document verifying the brand's name. This may be the certificate of incorporation, business license, or other relevant document. You can typically find this on the Secretary of State website. */
52
53
  brandVerificationUrl?: string;
53
54
  /** Unique identifier for the brand. */
54
- brand?: number;
55
+ brand?: string;
55
56
  /** Unique identifier for the campaign. */
56
- campaignId?: number;
57
+ campaignId?: string;
57
58
  /** List of what the agent might say to users (1-5 required). */
58
59
  expectedAgentResponses?: string[];
59
60
  /** Legal documentation links. */
@@ -3,5 +3,5 @@
3
3
  */
4
4
  import * as Pinnacle from "../../../../../index.mjs";
5
5
  export interface RcsAutofillResponse extends Pinnacle.RcsCampaign {
6
- brand?: number;
6
+ brand?: string;
7
7
  }
@@ -41,8 +41,8 @@ export declare class TollFree {
41
41
  *
42
42
  * @example
43
43
  * await client.campaigns.tollFree.autofill({
44
- * additionalInfo: "Please autofill missing DLC campaign fields using my brand profile",
45
- * campaignId: 161
44
+ * additionalInfo: "Please autofill missing campaign fields using my brand profile",
45
+ * campaignId: "dlc_1234567890"
46
46
  * })
47
47
  */
48
48
  autofill(request: Pinnacle.AutofillCampaignParams, requestOptions?: TollFree.RequestOptions): core.HttpResponsePromise<Pinnacle.campaigns.TollFreeAutofillResponse>;
@@ -50,7 +50,7 @@ export declare class TollFree {
50
50
  /**
51
51
  * Retrieve Toll-Free campaign.
52
52
  *
53
- * @param {number} campaignId - Unique identifier of toll-free campaign.
53
+ * @param {string} campaignId - Unique identifier of toll-free campaign. Must begin with the prefix `tf_`.
54
54
  * @param {TollFree.RequestOptions} requestOptions - Request-specific configuration.
55
55
  *
56
56
  * @throws {@link Pinnacle.BadRequestError}
@@ -59,14 +59,14 @@ export declare class TollFree {
59
59
  * @throws {@link Pinnacle.InternalServerError}
60
60
  *
61
61
  * @example
62
- * await client.campaigns.tollFree.get(161)
62
+ * await client.campaigns.tollFree.get("tf_1234567890")
63
63
  */
64
- get(campaignId: number, requestOptions?: TollFree.RequestOptions): core.HttpResponsePromise<Pinnacle.TollFreeCampaignWithExtendedBrandAndStatus>;
64
+ get(campaignId: string, requestOptions?: TollFree.RequestOptions): core.HttpResponsePromise<Pinnacle.TollFreeCampaignWithExtendedBrandAndStatus>;
65
65
  private __get;
66
66
  /**
67
67
  * Submit your toll-free campaign for approval and activation with carriers.
68
68
  *
69
- * @param {number} campaignId - Unique identifier of the toll-free campaign to submit.
69
+ * @param {string} campaignId - Unique identifier of the toll-free campaign to submit. Must begin with the prefix `tf_`.
70
70
  * @param {TollFree.RequestOptions} requestOptions - Request-specific configuration.
71
71
  *
72
72
  * @throws {@link Pinnacle.BadRequestError}
@@ -75,9 +75,9 @@ export declare class TollFree {
75
75
  * @throws {@link Pinnacle.InternalServerError}
76
76
  *
77
77
  * @example
78
- * await client.campaigns.tollFree.submit(161)
78
+ * await client.campaigns.tollFree.submit("tf_1234567890")
79
79
  */
80
- submit(campaignId: number, requestOptions?: TollFree.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignSubmissionResult>;
80
+ submit(campaignId: string, requestOptions?: TollFree.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignSubmissionResult>;
81
81
  private __submit;
82
82
  /**
83
83
  * Create a new toll-free campaign or updates an existing one.<br>
@@ -94,8 +94,8 @@ export declare class TollFree {
94
94
  *
95
95
  * @example
96
96
  * await client.campaigns.tollFree.upsert({
97
- * brand: 2,
98
- * campaignId: 161,
97
+ * brand: "b_1234567890",
98
+ * campaignId: "tf_1234567890",
99
99
  * monthlyVolume: "1,000",
100
100
  * name: "Pinnacle",
101
101
  * optIn: {
@@ -103,7 +103,7 @@ export declare class TollFree {
103
103
  * url: "https://www.pinnacle.sh/",
104
104
  * workflowDescription: "Visit https://www.pinnacle.sh/"
105
105
  * },
106
- * productionMessageContent: "Join Pinnacle's workshop tomorrow and send your first RCS!",
106
+ * productionMessageContent: "Join the Pinnacle workshop tomorrow and send your first RCS!",
107
107
  * useCase: {
108
108
  * summary: "Alerts clients about any Pinnacle hosted workshops.",
109
109
  * value: "WORKSHOP_ALERTS"
@@ -125,7 +125,7 @@ export declare class TollFree {
125
125
  * @example
126
126
  * await client.campaigns.tollFree.validate({
127
127
  * additionalInfo: "Please validate this DLC campaign for 10DLC compliance",
128
- * campaignId: 161
128
+ * campaignId: "dlc_1234567890"
129
129
  * })
130
130
  */
131
131
  validate(request: Pinnacle.ValidateCampaignParams, requestOptions?: TollFree.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignValidationResult>;
@@ -31,8 +31,8 @@ export class TollFree {
31
31
  *
32
32
  * @example
33
33
  * await client.campaigns.tollFree.autofill({
34
- * additionalInfo: "Please autofill missing DLC campaign fields using my brand profile",
35
- * campaignId: 161
34
+ * additionalInfo: "Please autofill missing campaign fields using my brand profile",
35
+ * campaignId: "dlc_1234567890"
36
36
  * })
37
37
  */
38
38
  autofill(request, requestOptions) {
@@ -96,7 +96,7 @@ export class TollFree {
96
96
  /**
97
97
  * Retrieve Toll-Free campaign.
98
98
  *
99
- * @param {number} campaignId - Unique identifier of toll-free campaign.
99
+ * @param {string} campaignId - Unique identifier of toll-free campaign. Must begin with the prefix `tf_`.
100
100
  * @param {TollFree.RequestOptions} requestOptions - Request-specific configuration.
101
101
  *
102
102
  * @throws {@link Pinnacle.BadRequestError}
@@ -105,7 +105,7 @@ export class TollFree {
105
105
  * @throws {@link Pinnacle.InternalServerError}
106
106
  *
107
107
  * @example
108
- * await client.campaigns.tollFree.get(161)
108
+ * await client.campaigns.tollFree.get("tf_1234567890")
109
109
  */
110
110
  get(campaignId, requestOptions) {
111
111
  return core.HttpResponsePromise.fromPromise(this.__get(campaignId, requestOptions));
@@ -167,7 +167,7 @@ export class TollFree {
167
167
  /**
168
168
  * Submit your toll-free campaign for approval and activation with carriers.
169
169
  *
170
- * @param {number} campaignId - Unique identifier of the toll-free campaign to submit.
170
+ * @param {string} campaignId - Unique identifier of the toll-free campaign to submit. Must begin with the prefix `tf_`.
171
171
  * @param {TollFree.RequestOptions} requestOptions - Request-specific configuration.
172
172
  *
173
173
  * @throws {@link Pinnacle.BadRequestError}
@@ -176,7 +176,7 @@ export class TollFree {
176
176
  * @throws {@link Pinnacle.InternalServerError}
177
177
  *
178
178
  * @example
179
- * await client.campaigns.tollFree.submit(161)
179
+ * await client.campaigns.tollFree.submit("tf_1234567890")
180
180
  */
181
181
  submit(campaignId, requestOptions) {
182
182
  return core.HttpResponsePromise.fromPromise(this.__submit(campaignId, requestOptions));
@@ -247,8 +247,8 @@ export class TollFree {
247
247
  *
248
248
  * @example
249
249
  * await client.campaigns.tollFree.upsert({
250
- * brand: 2,
251
- * campaignId: 161,
250
+ * brand: "b_1234567890",
251
+ * campaignId: "tf_1234567890",
252
252
  * monthlyVolume: "1,000",
253
253
  * name: "Pinnacle",
254
254
  * optIn: {
@@ -256,7 +256,7 @@ export class TollFree {
256
256
  * url: "https://www.pinnacle.sh/",
257
257
  * workflowDescription: "Visit https://www.pinnacle.sh/"
258
258
  * },
259
- * productionMessageContent: "Join Pinnacle's workshop tomorrow and send your first RCS!",
259
+ * productionMessageContent: "Join the Pinnacle workshop tomorrow and send your first RCS!",
260
260
  * useCase: {
261
261
  * summary: "Alerts clients about any Pinnacle hosted workshops.",
262
262
  * value: "WORKSHOP_ALERTS"
@@ -336,7 +336,7 @@ export class TollFree {
336
336
  * @example
337
337
  * await client.campaigns.tollFree.validate({
338
338
  * additionalInfo: "Please validate this DLC campaign for 10DLC compliance",
339
- * campaignId: 161
339
+ * campaignId: "dlc_1234567890"
340
340
  * })
341
341
  */
342
342
  validate(request, requestOptions) {
@@ -5,8 +5,8 @@ import * as Pinnacle from "../../../../../../index.mjs";
5
5
  /**
6
6
  * @example
7
7
  * {
8
- * brand: 2,
9
- * campaignId: 161,
8
+ * brand: "b_1234567890",
9
+ * campaignId: "tf_1234567890",
10
10
  * monthlyVolume: "1,000",
11
11
  * name: "Pinnacle",
12
12
  * optIn: {
@@ -14,7 +14,7 @@ import * as Pinnacle from "../../../../../../index.mjs";
14
14
  * url: "https://www.pinnacle.sh/",
15
15
  * workflowDescription: "Visit https://www.pinnacle.sh/"
16
16
  * },
17
- * productionMessageContent: "Join Pinnacle's workshop tomorrow and send your first RCS!",
17
+ * productionMessageContent: "Join the Pinnacle workshop tomorrow and send your first RCS!",
18
18
  * useCase: {
19
19
  * summary: "Alerts clients about any Pinnacle hosted workshops.",
20
20
  * value: "WORKSHOP_ALERTS"
@@ -22,10 +22,10 @@ import * as Pinnacle from "../../../../../../index.mjs";
22
22
  * }
23
23
  */
24
24
  export interface UpsertTollFreeCampaignParams {
25
- /** Brand id. */
26
- brand?: number;
27
- /** Unique identifier for the campaign. */
28
- campaignId?: number;
25
+ /** Brand id. This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`. */
26
+ brand?: string;
27
+ /** Unique identifier for the campaign. This identifier is a string that always begins with the prefix `tf_`, for example: `tf_1234567890`. */
28
+ campaignId?: string;
29
29
  monthlyVolume?: Pinnacle.MessageVolumeEnum;
30
30
  /** Display name of the campaign. */
31
31
  name?: string;
@@ -3,5 +3,5 @@
3
3
  */
4
4
  import * as Pinnacle from "../../../../../index.mjs";
5
5
  export interface TollFreeAutofillResponse extends Pinnacle.TollFreeCampaign {
6
- brand?: number;
6
+ brand?: string;
7
7
  }
@@ -41,7 +41,9 @@ export declare class Contacts {
41
41
  * @throws {@link Pinnacle.InternalServerError}
42
42
  *
43
43
  * @example
44
- * await client.contacts.get()
44
+ * await client.contacts.get({
45
+ * id: "co_1234567890"
46
+ * })
45
47
  */
46
48
  get(request?: Pinnacle.ContactsGetRequest, requestOptions?: Contacts.RequestOptions): core.HttpResponsePromise<Pinnacle.Contact>;
47
49
  private __get;
@@ -79,7 +81,7 @@ export declare class Contacts {
79
81
  * email: "alvaroopedtech@pinnacle.sh",
80
82
  * name: "Retired Bestie",
81
83
  * tags: ["friend"],
82
- * id: 137
84
+ * id: "co_1234567890"
83
85
  * })
84
86
  */
85
87
  update(request: Pinnacle.UpdateContactParams, requestOptions?: Contacts.RequestOptions): core.HttpResponsePromise<Pinnacle.UpdatedContactId>;
@@ -31,7 +31,9 @@ export class Contacts {
31
31
  * @throws {@link Pinnacle.InternalServerError}
32
32
  *
33
33
  * @example
34
- * await client.contacts.get()
34
+ * await client.contacts.get({
35
+ * id: "co_1234567890"
36
+ * })
35
37
  */
36
38
  get(request = {}, requestOptions) {
37
39
  return core.HttpResponsePromise.fromPromise(this.__get(request, requestOptions));
@@ -42,7 +44,7 @@ export class Contacts {
42
44
  const { id, phoneNumber } = request;
43
45
  const _queryParams = {};
44
46
  if (id != null) {
45
- _queryParams["id"] = id.toString();
47
+ _queryParams["id"] = id;
46
48
  }
47
49
  if (phoneNumber != null) {
48
50
  _queryParams["phoneNumber"] = phoneNumber;
@@ -182,7 +184,7 @@ export class Contacts {
182
184
  * email: "alvaroopedtech@pinnacle.sh",
183
185
  * name: "Retired Bestie",
184
186
  * tags: ["friend"],
185
- * id: 137
187
+ * id: "co_1234567890"
186
188
  * })
187
189
  */
188
190
  update(request, requestOptions) {
@@ -3,7 +3,9 @@
3
3
  */
4
4
  /**
5
5
  * @example
6
- * {}
6
+ * {
7
+ * id: "co_1234567890"
8
+ * }
7
9
  */
8
10
  export interface ContactsGetRequest {
9
11
  /**
@@ -11,7 +13,7 @@ export interface ContactsGetRequest {
11
13
  *
12
14
  * Either this parameter or `phoneNumber` must be provided, but not both.
13
15
  */
14
- id?: number;
16
+ id?: string;
15
17
  /** Phone number you want to look up contact information for, provided in URL-encoded E.164 format with %2B prefix instead of +. */
16
18
  phoneNumber?: string;
17
19
  }
@@ -9,10 +9,10 @@ import * as Pinnacle from "../../../../index.mjs";
9
9
  * email: "alvaroopedtech@pinnacle.sh",
10
10
  * name: "Retired Bestie",
11
11
  * tags: ["friend"],
12
- * id: 137
12
+ * id: "co_1234567890"
13
13
  * }
14
14
  */
15
15
  export interface UpdateContactParams extends Pinnacle.OptionalContact {
16
- /** ID of the contact you want to update. */
17
- id: number;
16
+ /** ID of the contact you want to update. This identifier is a string that always begins with the prefix `co_`, for example: `co_1234567890`. */
17
+ id: string;
18
18
  }
@@ -41,7 +41,7 @@ export declare class Conversations {
41
41
  *
42
42
  * @example
43
43
  * await client.conversations.get({
44
- * id: 1
44
+ * id: "conv_1234567890"
45
45
  * })
46
46
  */
47
47
  get(request: Pinnacle.GetConversationParams, requestOptions?: Conversations.RequestOptions): core.HttpResponsePromise<Pinnacle.Conversation | null>;
@@ -58,8 +58,8 @@ export declare class Conversations {
58
58
  *
59
59
  * @example
60
60
  * await client.conversations.list({
61
- * brandId: 101,
62
- * campaignId: 136,
61
+ * brandId: "b_1234567890",
62
+ * campaignId: "tf_1234567890",
63
63
  * campaignType: "TOLL_FREE",
64
64
  * pageIndex: 0,
65
65
  * pageSize: 20,
@@ -81,12 +81,29 @@ export declare class Conversations {
81
81
  *
82
82
  * @example
83
83
  * await client.conversations.update({
84
- * id: 123,
84
+ * id: "conv_1234567890",
85
85
  * notes: "Follow-up completed. Customer satisfied with resolution."
86
86
  * })
87
87
  */
88
88
  update(request: Pinnacle.UpdateConversationParams, requestOptions?: Conversations.RequestOptions): core.HttpResponsePromise<Pinnacle.SuccessfulConversationUpdate>;
89
89
  private __update;
90
+ /**
91
+ * Retrieve a paginated and filtered list of messages for a specific conversation.
92
+ *
93
+ * @param {string} id - Unique identifier of the conversation. This identifier is a string that always begins with the prefix `conv_`, for example: `conv_1234567890`.
94
+ * @param {Pinnacle.ConversationsListMessagesRequest} request
95
+ * @param {Conversations.RequestOptions} requestOptions - Request-specific configuration.
96
+ *
97
+ * @throws {@link Pinnacle.BadRequestError}
98
+ * @throws {@link Pinnacle.UnauthorizedError}
99
+ * @throws {@link Pinnacle.NotFoundError}
100
+ * @throws {@link Pinnacle.InternalServerError}
101
+ *
102
+ * @example
103
+ * await client.conversations.listMessages("id")
104
+ */
105
+ listMessages(id: string, request?: Pinnacle.ConversationsListMessagesRequest, requestOptions?: Conversations.RequestOptions): core.HttpResponsePromise<Pinnacle.MessageList>;
106
+ private __listMessages;
90
107
  protected _getCustomAuthorizationHeaders(): Promise<{
91
108
  "PINNACLE-API-KEY": string | undefined;
92
109
  }>;