rcs-js 2.0.0-rc.9 → 2.0.0

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 (264) hide show
  1. package/dist/cjs/Client.d.ts +5 -2
  2. package/dist/cjs/Client.js +16 -11
  3. package/dist/cjs/api/resources/brands/client/Client.d.ts +6 -4
  4. package/dist/cjs/api/resources/brands/client/Client.js +15 -9
  5. package/dist/cjs/api/resources/brands/client/requests/BrandsGetRequest.d.ts +1 -1
  6. package/dist/cjs/api/resources/brands/client/requests/UpsertBrandParams.d.ts +3 -3
  7. package/dist/cjs/api/resources/campaigns/client/Client.d.ts +2 -2
  8. package/dist/cjs/api/resources/campaigns/client/Client.js +1 -1
  9. package/dist/cjs/api/resources/campaigns/resources/dlc/client/Client.d.ts +9 -9
  10. package/dist/cjs/api/resources/campaigns/resources/dlc/client/Client.js +7 -7
  11. package/dist/cjs/api/resources/campaigns/resources/rcs/client/Client.d.ts +5 -3
  12. package/dist/cjs/api/resources/campaigns/resources/rcs/client/Client.js +5 -1
  13. package/dist/cjs/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.ts +5 -4
  14. package/dist/cjs/api/resources/campaigns/resources/tollFree/client/Client.d.ts +3 -3
  15. package/dist/cjs/api/resources/campaigns/resources/tollFree/client/Client.js +1 -1
  16. package/dist/cjs/api/resources/contacts/client/Client.d.ts +3 -3
  17. package/dist/cjs/api/resources/contacts/client/Client.js +7 -7
  18. package/dist/cjs/api/resources/contacts/client/requests/ContactsGetRequest.d.ts +2 -2
  19. package/dist/cjs/api/resources/conversations/client/Client.d.ts +4 -4
  20. package/dist/cjs/api/resources/conversations/client/Client.js +2 -5
  21. package/dist/cjs/api/resources/index.d.ts +2 -0
  22. package/dist/cjs/api/resources/index.js +3 -1
  23. package/dist/cjs/api/resources/messages/client/Client.d.ts +6 -3
  24. package/dist/cjs/api/resources/messages/client/Client.js +10 -1
  25. package/dist/cjs/api/resources/messages/client/requests/ReactMessageParams.d.ts +1 -1
  26. package/dist/cjs/api/resources/messages/resources/mms/client/Client.d.ts +4 -3
  27. package/dist/cjs/api/resources/messages/resources/mms/client/Client.js +4 -1
  28. package/dist/cjs/api/resources/messages/resources/rcs/client/Client.d.ts +6 -5
  29. package/dist/cjs/api/resources/messages/resources/rcs/client/Client.js +5 -2
  30. package/dist/cjs/api/resources/messages/resources/sms/client/Client.d.ts +4 -3
  31. package/dist/cjs/api/resources/messages/resources/sms/client/Client.js +4 -1
  32. package/dist/cjs/api/resources/phoneNumbers/client/Client.d.ts +3 -3
  33. package/dist/cjs/api/resources/phoneNumbers/client/Client.js +1 -1
  34. package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/Client.d.ts +6 -4
  35. package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/Client.js +8 -2
  36. package/dist/cjs/api/resources/phoneNumbers/resources/webhook/client/Client.d.ts +7 -5
  37. package/dist/cjs/api/resources/phoneNumbers/resources/webhook/client/Client.js +7 -3
  38. package/dist/cjs/api/resources/rcs/client/Client.d.ts +121 -0
  39. package/dist/cjs/api/resources/rcs/client/Client.js +320 -0
  40. package/dist/cjs/api/resources/rcs/client/index.d.ts +2 -0
  41. package/dist/cjs/api/resources/rcs/client/index.js +17 -0
  42. package/dist/cjs/api/resources/rcs/client/requests/RcsCapabilitiesQuery.d.ts +13 -0
  43. package/dist/cjs/api/resources/rcs/client/requests/RcsLinkRequest.d.ts +22 -0
  44. package/dist/cjs/api/resources/rcs/client/requests/RcsWhitelistRequest.d.ts +16 -0
  45. package/dist/cjs/api/resources/rcs/client/requests/index.d.ts +3 -0
  46. package/dist/cjs/api/resources/rcs/client/requests/index.js +2 -0
  47. package/dist/cjs/api/resources/rcs/index.d.ts +1 -0
  48. package/dist/cjs/api/resources/rcs/index.js +17 -0
  49. package/dist/cjs/api/resources/status/client/Client.d.ts +2 -2
  50. package/dist/cjs/api/resources/status/client/Client.js +1 -1
  51. package/dist/cjs/api/resources/status/resources/get/client/Client.d.ts +5 -5
  52. package/dist/cjs/api/resources/status/resources/get/client/Client.js +3 -3
  53. package/dist/cjs/api/resources/tools/client/Client.d.ts +2 -2
  54. package/dist/cjs/api/resources/tools/client/Client.js +1 -1
  55. package/dist/cjs/api/resources/tools/resources/contactCard/client/Client.d.ts +5 -5
  56. package/dist/cjs/api/resources/tools/resources/contactCard/client/Client.js +3 -3
  57. package/dist/cjs/api/resources/tools/resources/file/client/Client.d.ts +24 -3
  58. package/dist/cjs/api/resources/tools/resources/file/client/Client.js +75 -1
  59. package/dist/cjs/api/resources/tools/resources/file/client/requests/RefreshFileParams.d.ts +21 -0
  60. package/dist/cjs/api/resources/tools/resources/file/client/requests/RefreshFileParams.js +5 -0
  61. package/dist/cjs/api/resources/tools/resources/file/client/requests/index.d.ts +1 -0
  62. package/dist/cjs/api/resources/tools/resources/url/client/Client.d.ts +4 -4
  63. package/dist/cjs/api/resources/tools/resources/url/client/Client.js +2 -2
  64. package/dist/cjs/api/resources/webhooks/client/Client.d.ts +3 -3
  65. package/dist/cjs/api/resources/webhooks/client/Client.js +1 -1
  66. package/dist/cjs/api/types/AdvancedPhoneInformation.d.ts +9 -9
  67. package/dist/cjs/api/types/AttachWebhookParams.d.ts +2 -2
  68. package/dist/cjs/api/types/AutofillDlcCampaignResponse.d.ts +11 -11
  69. package/dist/cjs/api/types/ButtonClicked.d.ts +11 -0
  70. package/dist/cjs/api/types/ButtonClicked.js +5 -0
  71. package/dist/cjs/api/types/ButtonClickedData.d.ts +58 -0
  72. package/dist/cjs/api/types/ButtonClickedData.js +16 -0
  73. package/dist/cjs/api/types/Conversation.d.ts +3 -3
  74. package/dist/cjs/api/types/ConversationList.d.ts +4 -4
  75. package/dist/cjs/api/types/CreateUrlOptions.d.ts +1 -1
  76. package/dist/cjs/api/types/DlcCampaignStatus.d.ts +2 -2
  77. package/dist/cjs/api/types/DlcCampaignWithExtendedBrandAndStatus.d.ts +13 -10
  78. package/dist/cjs/api/types/EnhancedContactItem.d.ts +1 -1
  79. package/dist/cjs/api/types/ExtendedBrand.d.ts +12 -5
  80. package/dist/cjs/api/types/ExtendedBrandWithVetting.d.ts +2 -2
  81. package/dist/cjs/api/types/ExtendedRcsCampaign.d.ts +13 -12
  82. package/dist/cjs/api/types/Message.d.ts +4 -4
  83. package/dist/cjs/api/types/MessageContent.d.ts +2 -2
  84. package/dist/cjs/api/types/MessageEvent.d.ts +56 -0
  85. package/dist/cjs/api/types/MessageEvent.js +13 -0
  86. package/dist/cjs/api/types/ProfileStatusEnum.d.ts +7 -4
  87. package/dist/cjs/api/types/RcsBase.d.ts +2 -0
  88. package/dist/cjs/api/types/RcsButtonCall.d.ts +2 -0
  89. package/dist/cjs/api/types/RcsButtonOpenUrl.d.ts +2 -0
  90. package/dist/cjs/api/types/RcsButtonRequestUserLocation.d.ts +2 -0
  91. package/dist/cjs/api/types/RcsButtonScheduleEvent.d.ts +2 -0
  92. package/dist/cjs/api/types/RcsButtonSendLocation.d.ts +2 -0
  93. package/dist/cjs/api/types/RcsButtonTrigger.d.ts +2 -2
  94. package/dist/cjs/api/types/RcsCampaign.d.ts +4 -4
  95. package/dist/cjs/api/types/RcsCapabilitiesResult.d.ts +8 -0
  96. package/dist/cjs/api/types/RcsCapabilitiesResult.js +5 -0
  97. package/dist/cjs/api/types/RcsCapability.d.ts +36 -0
  98. package/dist/cjs/api/types/RcsCapability.js +5 -0
  99. package/dist/cjs/api/types/RcsLinkResult.d.ts +13 -0
  100. package/dist/cjs/api/types/RcsLinkResult.js +5 -0
  101. package/dist/cjs/api/types/RcsValidateContent.d.ts +1 -0
  102. package/dist/cjs/api/types/RcsWhitelistResponse.d.ts +10 -0
  103. package/dist/cjs/api/types/RcsWhitelistResponse.js +5 -0
  104. package/dist/cjs/api/types/RefreshedFile.d.ts +9 -0
  105. package/dist/cjs/api/types/RefreshedFile.js +5 -0
  106. package/dist/cjs/api/types/{Rcs.d.ts → RichMessage.d.ts} +1 -1
  107. package/dist/cjs/api/types/RichMessage.js +5 -0
  108. package/dist/cjs/api/types/ShortenedUrl.d.ts +1 -1
  109. package/dist/cjs/api/types/TollFreeCampaignWithExtendedBrandAndStatus.d.ts +0 -1
  110. package/dist/cjs/api/types/UploadResults.d.ts +1 -1
  111. package/dist/cjs/api/types/VCardData.d.ts +1 -1
  112. package/dist/cjs/api/types/WebhookEventEnum.d.ts +1 -0
  113. package/dist/cjs/api/types/index.d.ts +9 -3
  114. package/dist/cjs/api/types/index.js +9 -3
  115. package/dist/cjs/index.d.ts +1 -1
  116. package/dist/cjs/index.js +2 -2
  117. package/dist/cjs/version.d.ts +1 -1
  118. package/dist/cjs/version.js +1 -1
  119. package/dist/cjs/wrapper/PinnacleClient.d.ts +9 -0
  120. package/dist/cjs/wrapper/PinnacleClient.js +17 -0
  121. package/dist/cjs/wrapper/messages/Client.d.ts +13 -0
  122. package/dist/cjs/wrapper/messages/Client.js +49 -0
  123. package/dist/cjs/wrapper/tools/Client.d.ts +6 -0
  124. package/dist/cjs/wrapper/tools/Client.js +12 -0
  125. package/dist/cjs/wrapper/tools/FileUploader.d.ts +15 -0
  126. package/dist/cjs/wrapper/tools/FileUploader.js +162 -0
  127. package/dist/esm/Client.d.mts +5 -2
  128. package/dist/esm/Client.mjs +8 -3
  129. package/dist/esm/api/resources/brands/client/Client.d.mts +6 -4
  130. package/dist/esm/api/resources/brands/client/Client.mjs +15 -9
  131. package/dist/esm/api/resources/brands/client/requests/BrandsGetRequest.d.mts +1 -1
  132. package/dist/esm/api/resources/brands/client/requests/UpsertBrandParams.d.mts +3 -3
  133. package/dist/esm/api/resources/campaigns/client/Client.d.mts +2 -2
  134. package/dist/esm/api/resources/campaigns/client/Client.mjs +1 -1
  135. package/dist/esm/api/resources/campaigns/resources/dlc/client/Client.d.mts +9 -9
  136. package/dist/esm/api/resources/campaigns/resources/dlc/client/Client.mjs +7 -7
  137. package/dist/esm/api/resources/campaigns/resources/rcs/client/Client.d.mts +5 -3
  138. package/dist/esm/api/resources/campaigns/resources/rcs/client/Client.mjs +5 -1
  139. package/dist/esm/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.mts +5 -4
  140. package/dist/esm/api/resources/campaigns/resources/tollFree/client/Client.d.mts +3 -3
  141. package/dist/esm/api/resources/campaigns/resources/tollFree/client/Client.mjs +1 -1
  142. package/dist/esm/api/resources/contacts/client/Client.d.mts +3 -3
  143. package/dist/esm/api/resources/contacts/client/Client.mjs +7 -7
  144. package/dist/esm/api/resources/contacts/client/requests/ContactsGetRequest.d.mts +2 -2
  145. package/dist/esm/api/resources/conversations/client/Client.d.mts +4 -4
  146. package/dist/esm/api/resources/conversations/client/Client.mjs +2 -5
  147. package/dist/esm/api/resources/index.d.mts +2 -0
  148. package/dist/esm/api/resources/index.mjs +2 -0
  149. package/dist/esm/api/resources/messages/client/Client.d.mts +6 -3
  150. package/dist/esm/api/resources/messages/client/Client.mjs +10 -1
  151. package/dist/esm/api/resources/messages/client/requests/ReactMessageParams.d.mts +1 -1
  152. package/dist/esm/api/resources/messages/resources/mms/client/Client.d.mts +4 -3
  153. package/dist/esm/api/resources/messages/resources/mms/client/Client.mjs +4 -1
  154. package/dist/esm/api/resources/messages/resources/rcs/client/Client.d.mts +6 -5
  155. package/dist/esm/api/resources/messages/resources/rcs/client/Client.mjs +5 -2
  156. package/dist/esm/api/resources/messages/resources/sms/client/Client.d.mts +4 -3
  157. package/dist/esm/api/resources/messages/resources/sms/client/Client.mjs +4 -1
  158. package/dist/esm/api/resources/phoneNumbers/client/Client.d.mts +3 -3
  159. package/dist/esm/api/resources/phoneNumbers/client/Client.mjs +1 -1
  160. package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/Client.d.mts +6 -4
  161. package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/Client.mjs +8 -2
  162. package/dist/esm/api/resources/phoneNumbers/resources/webhook/client/Client.d.mts +7 -5
  163. package/dist/esm/api/resources/phoneNumbers/resources/webhook/client/Client.mjs +7 -3
  164. package/dist/esm/api/resources/rcs/client/Client.d.mts +121 -0
  165. package/dist/esm/api/resources/rcs/client/Client.mjs +283 -0
  166. package/dist/esm/api/resources/rcs/client/index.d.mts +2 -0
  167. package/dist/esm/api/resources/rcs/client/index.mjs +1 -0
  168. package/dist/esm/api/resources/rcs/client/requests/RcsCapabilitiesQuery.d.mts +13 -0
  169. package/dist/esm/api/resources/rcs/client/requests/RcsLinkRequest.d.mts +22 -0
  170. package/dist/esm/api/resources/rcs/client/requests/RcsWhitelistRequest.d.mts +16 -0
  171. package/dist/esm/api/resources/rcs/client/requests/index.d.mts +3 -0
  172. package/dist/esm/api/resources/rcs/client/requests/index.mjs +1 -0
  173. package/dist/esm/api/resources/rcs/index.d.mts +1 -0
  174. package/dist/esm/api/resources/rcs/index.mjs +1 -0
  175. package/dist/esm/api/resources/status/client/Client.d.mts +2 -2
  176. package/dist/esm/api/resources/status/client/Client.mjs +1 -1
  177. package/dist/esm/api/resources/status/resources/get/client/Client.d.mts +5 -5
  178. package/dist/esm/api/resources/status/resources/get/client/Client.mjs +3 -3
  179. package/dist/esm/api/resources/tools/client/Client.d.mts +2 -2
  180. package/dist/esm/api/resources/tools/client/Client.mjs +1 -1
  181. package/dist/esm/api/resources/tools/resources/contactCard/client/Client.d.mts +5 -5
  182. package/dist/esm/api/resources/tools/resources/contactCard/client/Client.mjs +3 -3
  183. package/dist/esm/api/resources/tools/resources/file/client/Client.d.mts +24 -3
  184. package/dist/esm/api/resources/tools/resources/file/client/Client.mjs +75 -1
  185. package/dist/esm/api/resources/tools/resources/file/client/requests/RefreshFileParams.d.mts +21 -0
  186. package/dist/esm/api/resources/tools/resources/file/client/requests/RefreshFileParams.mjs +4 -0
  187. package/dist/esm/api/resources/tools/resources/file/client/requests/index.d.mts +1 -0
  188. package/dist/esm/api/resources/tools/resources/url/client/Client.d.mts +4 -4
  189. package/dist/esm/api/resources/tools/resources/url/client/Client.mjs +2 -2
  190. package/dist/esm/api/resources/webhooks/client/Client.d.mts +3 -3
  191. package/dist/esm/api/resources/webhooks/client/Client.mjs +1 -1
  192. package/dist/esm/api/types/AdvancedPhoneInformation.d.mts +9 -9
  193. package/dist/esm/api/types/AttachWebhookParams.d.mts +2 -2
  194. package/dist/esm/api/types/AutofillDlcCampaignResponse.d.mts +11 -11
  195. package/dist/esm/api/types/ButtonClicked.d.mts +11 -0
  196. package/dist/esm/api/types/ButtonClicked.mjs +4 -0
  197. package/dist/esm/api/types/ButtonClickedData.d.mts +58 -0
  198. package/dist/esm/api/types/ButtonClickedData.mjs +13 -0
  199. package/dist/esm/api/types/Conversation.d.mts +3 -3
  200. package/dist/esm/api/types/ConversationList.d.mts +4 -4
  201. package/dist/esm/api/types/CreateUrlOptions.d.mts +1 -1
  202. package/dist/esm/api/types/DlcCampaignStatus.d.mts +2 -2
  203. package/dist/esm/api/types/DlcCampaignWithExtendedBrandAndStatus.d.mts +13 -10
  204. package/dist/esm/api/types/EnhancedContactItem.d.mts +1 -1
  205. package/dist/esm/api/types/ExtendedBrand.d.mts +12 -5
  206. package/dist/esm/api/types/ExtendedBrandWithVetting.d.mts +2 -2
  207. package/dist/esm/api/types/ExtendedRcsCampaign.d.mts +13 -12
  208. package/dist/esm/api/types/Message.d.mts +4 -4
  209. package/dist/esm/api/types/MessageContent.d.mts +2 -2
  210. package/dist/esm/api/types/MessageEvent.d.mts +56 -0
  211. package/dist/esm/api/types/MessageEvent.mjs +10 -0
  212. package/dist/esm/api/types/ProfileStatusEnum.d.mts +7 -4
  213. package/dist/esm/api/types/RcsBase.d.mts +2 -0
  214. package/dist/esm/api/types/RcsButtonCall.d.mts +2 -0
  215. package/dist/esm/api/types/RcsButtonOpenUrl.d.mts +2 -0
  216. package/dist/esm/api/types/RcsButtonRequestUserLocation.d.mts +2 -0
  217. package/dist/esm/api/types/RcsButtonScheduleEvent.d.mts +2 -0
  218. package/dist/esm/api/types/RcsButtonSendLocation.d.mts +2 -0
  219. package/dist/esm/api/types/RcsButtonTrigger.d.mts +2 -2
  220. package/dist/esm/api/types/RcsCampaign.d.mts +4 -4
  221. package/dist/esm/api/types/RcsCapabilitiesResult.d.mts +8 -0
  222. package/dist/esm/api/types/RcsCapabilitiesResult.mjs +4 -0
  223. package/dist/esm/api/types/RcsCapability.d.mts +36 -0
  224. package/dist/esm/api/types/RcsCapability.mjs +4 -0
  225. package/dist/esm/api/types/RcsLinkResult.d.mts +13 -0
  226. package/dist/esm/api/types/RcsLinkResult.mjs +4 -0
  227. package/dist/esm/api/types/RcsValidateContent.d.mts +1 -0
  228. package/dist/esm/api/types/RcsWhitelistResponse.d.mts +10 -0
  229. package/dist/esm/api/types/RcsWhitelistResponse.mjs +4 -0
  230. package/dist/esm/api/types/RefreshedFile.d.mts +9 -0
  231. package/dist/esm/api/types/RefreshedFile.mjs +4 -0
  232. package/dist/esm/api/types/{Rcs.d.mts → RichMessage.d.mts} +1 -1
  233. package/dist/esm/api/types/RichMessage.mjs +4 -0
  234. package/dist/esm/api/types/ShortenedUrl.d.mts +1 -1
  235. package/dist/esm/api/types/TollFreeCampaignWithExtendedBrandAndStatus.d.mts +0 -1
  236. package/dist/esm/api/types/UploadResults.d.mts +1 -1
  237. package/dist/esm/api/types/VCardData.d.mts +1 -1
  238. package/dist/esm/api/types/WebhookEventEnum.d.mts +1 -0
  239. package/dist/esm/api/types/index.d.mts +9 -3
  240. package/dist/esm/api/types/index.mjs +9 -3
  241. package/dist/esm/index.d.mts +1 -1
  242. package/dist/esm/index.mjs +1 -1
  243. package/dist/esm/version.d.mts +1 -1
  244. package/dist/esm/version.mjs +1 -1
  245. package/dist/esm/wrapper/PinnacleClient.d.mts +9 -0
  246. package/dist/esm/wrapper/PinnacleClient.mjs +13 -0
  247. package/dist/esm/wrapper/messages/Client.d.mts +13 -0
  248. package/dist/esm/wrapper/messages/Client.mjs +45 -0
  249. package/dist/esm/wrapper/tools/Client.d.mts +6 -0
  250. package/dist/esm/wrapper/tools/Client.mjs +8 -0
  251. package/dist/esm/wrapper/tools/FileUploader.d.mts +15 -0
  252. package/dist/esm/wrapper/tools/FileUploader.mjs +125 -0
  253. package/package.json +6 -2
  254. package/reference.md +321 -16
  255. package/dist/cjs/api/types/ClickAction.d.ts +0 -28
  256. package/dist/cjs/api/types/InboundButton.d.ts +0 -11
  257. package/dist/esm/api/types/ClickAction.d.mts +0 -28
  258. package/dist/esm/api/types/InboundButton.d.mts +0 -11
  259. /package/dist/cjs/api/{types/ClickAction.js → resources/rcs/client/requests/RcsCapabilitiesQuery.js} +0 -0
  260. /package/dist/cjs/api/{types/InboundButton.js → resources/rcs/client/requests/RcsLinkRequest.js} +0 -0
  261. /package/dist/cjs/api/{types/Rcs.js → resources/rcs/client/requests/RcsWhitelistRequest.js} +0 -0
  262. /package/dist/esm/api/{types/ClickAction.mjs → resources/rcs/client/requests/RcsCapabilitiesQuery.mjs} +0 -0
  263. /package/dist/esm/api/{types/InboundButton.mjs → resources/rcs/client/requests/RcsLinkRequest.mjs} +0 -0
  264. /package/dist/esm/api/{types/Rcs.mjs → resources/rcs/client/requests/RcsWhitelistRequest.mjs} +0 -0
@@ -9,7 +9,7 @@ export declare namespace ContactCard {
9
9
  environment?: core.Supplier<environments.PinnacleEnvironment | string>;
10
10
  /** Specify a custom URL to connect the client to. */
11
11
  baseUrl?: core.Supplier<string>;
12
- apiKey: core.Supplier<string>;
12
+ apiKey?: core.Supplier<string | undefined>;
13
13
  /** Additional headers to include in requests. */
14
14
  headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
15
15
  }
@@ -28,9 +28,9 @@ export declare namespace ContactCard {
28
28
  }
29
29
  export declare class ContactCard {
30
30
  protected readonly _options: ContactCard.Options;
31
- constructor(_options: ContactCard.Options);
31
+ constructor(_options?: ContactCard.Options);
32
32
  /**
33
- * Retrieve contact information as a vCard and get a presigned URL to download the file.
33
+ * 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.
34
34
  *
35
35
  * @param {Pinnacle.tools.GetVcardParams} request
36
36
  * @param {ContactCard.RequestOptions} requestOptions - Request-specific configuration.
@@ -47,7 +47,7 @@ export declare class ContactCard {
47
47
  get(request: Pinnacle.tools.GetVcardParams, requestOptions?: ContactCard.RequestOptions): core.HttpResponsePromise<Pinnacle.VCardData>;
48
48
  private __get;
49
49
  /**
50
- * Create a new contact card or updates an existing one with full vCard data.
50
+ * 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.
51
51
  *
52
52
  * @param {Pinnacle.tools.UpsertVcardParams} request
53
53
  * @param {ContactCard.RequestOptions} requestOptions - Request-specific configuration.
@@ -107,6 +107,6 @@ export declare class ContactCard {
107
107
  upsert(request?: Pinnacle.tools.UpsertVcardParams, requestOptions?: ContactCard.RequestOptions): core.HttpResponsePromise<Pinnacle.VcardResource>;
108
108
  private __upsert;
109
109
  protected _getCustomAuthorizationHeaders(): Promise<{
110
- "PINNACLE-API-KEY": string;
110
+ "PINNACLE-API-KEY": string | undefined;
111
111
  }>;
112
112
  }
@@ -52,11 +52,11 @@ const Pinnacle = __importStar(require("../../../../../index.js"));
52
52
  const headers_js_1 = require("../../../../../../core/headers.js");
53
53
  const errors = __importStar(require("../../../../../../errors/index.js"));
54
54
  class ContactCard {
55
- constructor(_options) {
55
+ constructor(_options = {}) {
56
56
  this._options = _options;
57
57
  }
58
58
  /**
59
- * Retrieve contact information as a vCard and get a presigned URL to download the file.
59
+ * 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.
60
60
  *
61
61
  * @param {Pinnacle.tools.GetVcardParams} request
62
62
  * @param {ContactCard.RequestOptions} requestOptions - Request-specific configuration.
@@ -126,7 +126,7 @@ class ContactCard {
126
126
  });
127
127
  }
128
128
  /**
129
- * Create a new contact card or updates an existing one with full vCard data.
129
+ * 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.
130
130
  *
131
131
  * @param {Pinnacle.tools.UpsertVcardParams} request
132
132
  * @param {ContactCard.RequestOptions} requestOptions - Request-specific configuration.
@@ -9,7 +9,7 @@ export declare namespace File_ {
9
9
  environment?: core.Supplier<environments.PinnacleEnvironment | string>;
10
10
  /** Specify a custom URL to connect the client to. */
11
11
  baseUrl?: core.Supplier<string>;
12
- apiKey: core.Supplier<string>;
12
+ apiKey?: core.Supplier<string | undefined>;
13
13
  /** Additional headers to include in requests. */
14
14
  headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
15
15
  }
@@ -28,7 +28,7 @@ export declare namespace File_ {
28
28
  }
29
29
  export declare class File_ {
30
30
  protected readonly _options: File_.Options;
31
- constructor(_options: File_.Options);
31
+ constructor(_options?: File_.Options);
32
32
  /**
33
33
  * Generate presigned URLs that let you upload files directly to our storage and allow your users to download them securely.
34
34
  *
@@ -53,7 +53,28 @@ export declare class File_ {
53
53
  */
54
54
  upload(request: Pinnacle.tools.UploadFileParams, requestOptions?: File_.RequestOptions): core.HttpResponsePromise<Pinnacle.UploadResults>;
55
55
  private __upload;
56
+ /**
57
+ * Refresh expiring presigned URLs for Pinnacle-hosted files to extend their access time.
58
+ *
59
+ * <Callout type="info">
60
+ * This only works for presigned download URLs. At this moment, you cannot refresh a presigned upload URL, generate a new one instead.
61
+ * </Callout>
62
+ *
63
+ * @param {Pinnacle.tools.RefreshFileParams} request
64
+ * @param {File_.RequestOptions} requestOptions - Request-specific configuration.
65
+ *
66
+ * @throws {@link Pinnacle.BadRequestError}
67
+ * @throws {@link Pinnacle.UnauthorizedError}
68
+ * @throws {@link Pinnacle.InternalServerError}
69
+ *
70
+ * @example
71
+ * await client.tools.file.refresh({
72
+ * uris: ["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", "icons/3/test.jpg", "invalid/url", "https://google.com"]
73
+ * })
74
+ */
75
+ refresh(request: Pinnacle.tools.RefreshFileParams, requestOptions?: File_.RequestOptions): core.HttpResponsePromise<Pinnacle.RefreshedFile[]>;
76
+ private __refresh;
56
77
  protected _getCustomAuthorizationHeaders(): Promise<{
57
- "PINNACLE-API-KEY": string;
78
+ "PINNACLE-API-KEY": string | undefined;
58
79
  }>;
59
80
  }
@@ -52,7 +52,7 @@ const Pinnacle = __importStar(require("../../../../../index.js"));
52
52
  const headers_js_1 = require("../../../../../../core/headers.js");
53
53
  const errors = __importStar(require("../../../../../../errors/index.js"));
54
54
  class File_ {
55
- constructor(_options) {
55
+ constructor(_options = {}) {
56
56
  this._options = _options;
57
57
  }
58
58
  /**
@@ -132,6 +132,80 @@ class File_ {
132
132
  }
133
133
  });
134
134
  }
135
+ /**
136
+ * Refresh expiring presigned URLs for Pinnacle-hosted files to extend their access time.
137
+ *
138
+ * <Callout type="info">
139
+ * This only works for presigned download URLs. At this moment, you cannot refresh a presigned upload URL, generate a new one instead.
140
+ * </Callout>
141
+ *
142
+ * @param {Pinnacle.tools.RefreshFileParams} request
143
+ * @param {File_.RequestOptions} requestOptions - Request-specific configuration.
144
+ *
145
+ * @throws {@link Pinnacle.BadRequestError}
146
+ * @throws {@link Pinnacle.UnauthorizedError}
147
+ * @throws {@link Pinnacle.InternalServerError}
148
+ *
149
+ * @example
150
+ * await client.tools.file.refresh({
151
+ * uris: ["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", "icons/3/test.jpg", "invalid/url", "https://google.com"]
152
+ * })
153
+ */
154
+ refresh(request, requestOptions) {
155
+ return core.HttpResponsePromise.fromPromise(this.__refresh(request, requestOptions));
156
+ }
157
+ __refresh(request, requestOptions) {
158
+ return __awaiter(this, void 0, void 0, function* () {
159
+ var _a, _b, _c;
160
+ let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
161
+ const _response = yield core.fetcher({
162
+ url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PinnacleEnvironment.Default, "tools/files/refresh"),
163
+ method: "POST",
164
+ headers: _headers,
165
+ contentType: "application/json",
166
+ queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
167
+ requestType: "json",
168
+ body: request,
169
+ timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
170
+ maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
171
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
172
+ });
173
+ if (_response.ok) {
174
+ return { data: _response.body, rawResponse: _response.rawResponse };
175
+ }
176
+ if (_response.error.reason === "status-code") {
177
+ switch (_response.error.statusCode) {
178
+ case 400:
179
+ throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
180
+ case 401:
181
+ throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
182
+ case 500:
183
+ throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
184
+ default:
185
+ throw new errors.PinnacleError({
186
+ statusCode: _response.error.statusCode,
187
+ body: _response.error.body,
188
+ rawResponse: _response.rawResponse,
189
+ });
190
+ }
191
+ }
192
+ switch (_response.error.reason) {
193
+ case "non-json":
194
+ throw new errors.PinnacleError({
195
+ statusCode: _response.error.statusCode,
196
+ body: _response.error.rawBody,
197
+ rawResponse: _response.rawResponse,
198
+ });
199
+ case "timeout":
200
+ throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /tools/files/refresh.");
201
+ case "unknown":
202
+ throw new errors.PinnacleError({
203
+ message: _response.error.errorMessage,
204
+ rawResponse: _response.rawResponse,
205
+ });
206
+ }
207
+ });
208
+ }
135
209
  _getCustomAuthorizationHeaders() {
136
210
  return __awaiter(this, void 0, void 0, function* () {
137
211
  const apiKeyValue = yield core.Supplier.get(this._options.apiKey);
@@ -0,0 +1,21 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ /**
5
+ * @example
6
+ * {
7
+ * uris: ["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", "icons/3/test.jpg", "invalid/url", "https://google.com"]
8
+ * }
9
+ */
10
+ export interface RefreshFileParams {
11
+ /**
12
+ * Array of file URIs to refresh for extended access. <br>
13
+ *
14
+ * Accepted formats:
15
+ * - **Full presigned URLs**: `https://server.trypinnacle.app/storage/v1/object/sign/...`
16
+ * - **Short URIs**: `{BUCKET}/${TEAM_ID}/...` (e.g., `vault/3/document.pdf`)
17
+ *
18
+ * Invalid or external URLs will be returned unchanged in the response.
19
+ */
20
+ uris: string[];
21
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -1 +1,2 @@
1
1
  export { type UploadFileParams } from "./UploadFileParams.js";
2
+ export { type RefreshFileParams } from "./RefreshFileParams.js";
@@ -9,7 +9,7 @@ export declare namespace Url {
9
9
  environment?: core.Supplier<environments.PinnacleEnvironment | string>;
10
10
  /** Specify a custom URL to connect the client to. */
11
11
  baseUrl?: core.Supplier<string>;
12
- apiKey: core.Supplier<string>;
12
+ apiKey?: core.Supplier<string | undefined>;
13
13
  /** Additional headers to include in requests. */
14
14
  headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
15
15
  }
@@ -28,7 +28,7 @@ export declare namespace Url {
28
28
  }
29
29
  export declare class Url {
30
30
  protected readonly _options: Url.Options;
31
- constructor(_options: Url.Options);
31
+ constructor(_options?: Url.Options);
32
32
  /**
33
33
  * Create a shortened URL that redirects visitors to the provided destination URL.
34
34
  *
@@ -67,7 +67,7 @@ export declare class Url {
67
67
  get(linkId: string, requestOptions?: Url.RequestOptions): core.HttpResponsePromise<Pinnacle.ShortenedUrlWithClickData>;
68
68
  private __get;
69
69
  /**
70
- * Update the destination or configuration of an existing shortened URL.
70
+ * Update the destination or expiration date of an existing shortened URL. Expiring links cannot be updated into a permalink.
71
71
  *
72
72
  * @param {string} linkId - Unique identifier from your shortened URL. For example, for `https://pncl.to/ePzVxILF`, the `linkId` is `ePzVxILF`. <br>
73
73
  *
@@ -87,6 +87,6 @@ export declare class Url {
87
87
  update(linkId: string, request?: Pinnacle.tools.UpdateUrlParams, requestOptions?: Url.RequestOptions): core.HttpResponsePromise<Pinnacle.ShortenedUrl>;
88
88
  private __update;
89
89
  protected _getCustomAuthorizationHeaders(): Promise<{
90
- "PINNACLE-API-KEY": string;
90
+ "PINNACLE-API-KEY": string | undefined;
91
91
  }>;
92
92
  }
@@ -52,7 +52,7 @@ const Pinnacle = __importStar(require("../../../../../index.js"));
52
52
  const headers_js_1 = require("../../../../../../core/headers.js");
53
53
  const errors = __importStar(require("../../../../../../errors/index.js"));
54
54
  class Url {
55
- constructor(_options) {
55
+ constructor(_options = {}) {
56
56
  this._options = _options;
57
57
  }
58
58
  /**
@@ -196,7 +196,7 @@ class Url {
196
196
  });
197
197
  }
198
198
  /**
199
- * Update the destination or configuration of an existing shortened URL.
199
+ * Update the destination or expiration date of an existing shortened URL. Expiring links cannot be updated into a permalink.
200
200
  *
201
201
  * @param {string} linkId - Unique identifier from your shortened URL. For example, for `https://pncl.to/ePzVxILF`, the `linkId` is `ePzVxILF`. <br>
202
202
  *
@@ -9,7 +9,7 @@ export declare namespace Webhooks {
9
9
  environment?: core.Supplier<environments.PinnacleEnvironment | string>;
10
10
  /** Specify a custom URL to connect the client to. */
11
11
  baseUrl?: core.Supplier<string>;
12
- apiKey: core.Supplier<string>;
12
+ apiKey?: core.Supplier<string | undefined>;
13
13
  /** Additional headers to include in requests. */
14
14
  headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
15
15
  }
@@ -28,7 +28,7 @@ export declare namespace Webhooks {
28
28
  }
29
29
  export declare class Webhooks {
30
30
  protected readonly _options: Webhooks.Options;
31
- constructor(_options: Webhooks.Options);
31
+ constructor(_options?: Webhooks.Options);
32
32
  /**
33
33
  * Retrieve all webhook that are set up to receive events for specific URLs or phone numbers.
34
34
  *
@@ -47,6 +47,6 @@ export declare class Webhooks {
47
47
  get(request: Pinnacle.GetWebhookParams, requestOptions?: Webhooks.RequestOptions): core.HttpResponsePromise<Pinnacle.WebhookResult>;
48
48
  private __get;
49
49
  protected _getCustomAuthorizationHeaders(): Promise<{
50
- "PINNACLE-API-KEY": string;
50
+ "PINNACLE-API-KEY": string | undefined;
51
51
  }>;
52
52
  }
@@ -52,7 +52,7 @@ const Pinnacle = __importStar(require("../../../index.js"));
52
52
  const headers_js_1 = require("../../../../core/headers.js");
53
53
  const errors = __importStar(require("../../../../errors/index.js"));
54
54
  class Webhooks {
55
- constructor(_options) {
55
+ constructor(_options = {}) {
56
56
  this._options = _options;
57
57
  }
58
58
  /**
@@ -22,7 +22,7 @@ export interface AdvancedPhoneInformation {
22
22
  /** Detailed carrier information. */
23
23
  carrier: AdvancedPhoneInformation.Carrier;
24
24
  /** Enhanced contact information associated with the phone number. */
25
- contact?: AdvancedPhoneInformation.Contact | null;
25
+ contact: AdvancedPhoneInformation.Contact | null;
26
26
  }
27
27
  export declare namespace AdvancedPhoneInformation {
28
28
  /**
@@ -68,25 +68,25 @@ export declare namespace AdvancedPhoneInformation {
68
68
  /** Complete country identification and metadata. */
69
69
  country: Location.Country;
70
70
  /** Primary city or municipality associated with the phone number. */
71
- city?: string | null;
71
+ city: string | null;
72
72
  /**
73
73
  * State, province, or primary administrative division code.
74
74
  * Uses standard 2-letter abbreviations where applicable.
75
75
  */
76
- state?: string | null;
76
+ state: string | null;
77
77
  /** Postal or ZIP code for the phone number's registered location. */
78
- zip?: string | null;
78
+ zip: string | null;
79
79
  /**
80
80
  * Primary Metropolitan Statistical Area (PMSA) code for US numbers.
81
81
  * Used for demographic and market analysis purposes.
82
82
  */
83
- metroCode?: string | null;
83
+ metroCode: string | null;
84
84
  /** County or secondary administrative division name. */
85
- county?: string | null;
85
+ county: string | null;
86
86
  /** Coordinates provide the precise latitude and longitude values for the phone number’s registered location. */
87
87
  coordinates: Location.Coordinates;
88
88
  /** IANA timezone identifier for the number’s location. */
89
- timeZone?: string | null;
89
+ timeZone: string | null;
90
90
  }
91
91
  namespace Location {
92
92
  /**
@@ -105,9 +105,9 @@ export declare namespace AdvancedPhoneInformation {
105
105
  */
106
106
  interface Coordinates {
107
107
  /** Decimal degrees latitude coordinate. */
108
- latitude?: number | null;
108
+ latitude: number | null;
109
109
  /** Decimal degrees longitude coordinate. */
110
- longitude?: number | null;
110
+ longitude: number | null;
111
111
  }
112
112
  }
113
113
  /**
@@ -11,12 +11,12 @@ export type AttachWebhookParams =
11
11
  * Attach a webhook you’ve already created in your account to this phone number. */
12
12
  {
13
13
  webhookId: number;
14
- event?: (Pinnacle.WebhookEventEnum | null) | undefined;
14
+ event: Pinnacle.WebhookEventEnum | null;
15
15
  }
16
16
  /**
17
17
  * Create a new webhook and immediately attach it to your phone number. */
18
18
  | {
19
19
  name: string;
20
20
  url: string;
21
- event?: (Pinnacle.WebhookEventEnum | null) | undefined;
21
+ event: Pinnacle.WebhookEventEnum | null;
22
22
  };
@@ -32,11 +32,11 @@ export declare namespace AutofillDlcCampaignResponse {
32
32
  */
33
33
  interface Keywords {
34
34
  /** Help keyword settings. */
35
- HELP?: Keywords.Help;
35
+ HELP: Keywords.Help;
36
36
  /** Opt-in keyword settings. */
37
- OPT_IN?: Keywords.OptIn;
37
+ OPT_IN: Keywords.OptIn;
38
38
  /** Opt-out keyword settings. */
39
- OPT_OUT?: Keywords.OptOut;
39
+ OPT_OUT: Keywords.OptOut;
40
40
  }
41
41
  namespace Keywords {
42
42
  /**
@@ -46,14 +46,14 @@ export declare namespace AutofillDlcCampaignResponse {
46
46
  /** Response message for help keywords. */
47
47
  message?: string;
48
48
  /** Keywords that trigger help response. */
49
- values?: string[];
49
+ values: string[];
50
50
  }
51
51
  /**
52
52
  * Opt-in keyword settings.
53
53
  */
54
54
  interface OptIn {
55
55
  /** Response message for opt-in keywords. */
56
- message: string;
56
+ message?: string;
57
57
  /** Keywords that trigger opt-in. */
58
58
  values: string[];
59
59
  }
@@ -64,7 +64,7 @@ export declare namespace AutofillDlcCampaignResponse {
64
64
  /** Response message for opt-out keywords. */
65
65
  message?: string;
66
66
  /** Keywords that trigger opt-out. */
67
- values?: string[];
67
+ values: string[];
68
68
  }
69
69
  }
70
70
  /**
@@ -81,17 +81,17 @@ export declare namespace AutofillDlcCampaignResponse {
81
81
  */
82
82
  interface Options {
83
83
  /** Whether the campaign uses affiliate marketing. */
84
- affiliateMarketing?: boolean;
84
+ affiliateMarketing: boolean;
85
85
  /** Whether the campaign is age-gated. */
86
- ageGated?: boolean;
86
+ ageGated: boolean;
87
87
  /** Whether the campaign involves direct lending. */
88
- directLending?: boolean;
88
+ directLending: boolean;
89
89
  /** Link embedded in campaign message. */
90
90
  embeddedLink?: string;
91
91
  /** Whether messages include phone numbers. */
92
- embeddedPhone?: boolean;
92
+ embeddedPhone: boolean;
93
93
  /** Whether the campaign uses number pooling. */
94
- numberPooling?: boolean;
94
+ numberPooling: boolean;
95
95
  }
96
96
  /**
97
97
  * Use case for the campaign.
@@ -0,0 +1,11 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Pinnacle from "../index.js";
5
+ export type ButtonClicked =
6
+ /**
7
+ * Data about a button that was clicked. */
8
+ Pinnacle.ButtonClickedData
9
+ /**
10
+ * User provided location. Occurs when recipient responds to `requestUserLocation` button and shares a location. */
11
+ | Pinnacle.LocationShareAction;
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,58 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Pinnacle from "../index.js";
5
+ /**
6
+ * Unified data structure for button click events.
7
+ */
8
+ export interface ButtonClickedData {
9
+ /** Information about the button that was clicked. */
10
+ button: ButtonClickedData.Button;
11
+ /** ID of the message this button was attached to, or null if not available. To get the message details, use the [GET /messages/{id}](/api-reference/messages/get) endpoint. */
12
+ messageId: number | null;
13
+ }
14
+ export declare namespace ButtonClickedData {
15
+ /**
16
+ * Information about the button that was clicked.
17
+ */
18
+ interface Button {
19
+ /**
20
+ * Type of button clicked.
21
+ * - `CARD` for card buttons,
22
+ * - `QUICK_REPLY` for quick replies.
23
+ * - `null` if we cannot determine the button type. This is a rare edge case and is mainly here for backward compatibility.
24
+ */
25
+ type?: Button.Type | null;
26
+ /** Raw button data. Contains the entire button that was clicked by the user. In rare cases where we cannot determine the exact button, this will return only the button title. */
27
+ raw: Button.Raw;
28
+ /** Extracted payload from the button's `payload` field, if provided. Provides quick access to any payload that was attached to the button. */
29
+ payload?: string | null;
30
+ /** Additional metadata attached to the button's `metadata` field, if provided. */
31
+ metadata?: string | null;
32
+ /** Number of times the button has been clicked. */
33
+ clicks: number;
34
+ }
35
+ namespace Button {
36
+ /**
37
+ * Type of button clicked.
38
+ * - `CARD` for card buttons,
39
+ * - `QUICK_REPLY` for quick replies.
40
+ * - `null` if we cannot determine the button type. This is a rare edge case and is mainly here for backward compatibility.
41
+ */
42
+ type Type = "CARD" | "QUICK_REPLY";
43
+ const Type: {
44
+ readonly Card: "CARD";
45
+ readonly QuickReply: "QUICK_REPLY";
46
+ };
47
+ /**
48
+ * Raw button data. Contains the entire button that was clicked by the user. In rare cases where we cannot determine the exact button, this will return only the button title.
49
+ */
50
+ type Raw =
51
+ /**
52
+ * Full button object if we can determine the exact button. */
53
+ Pinnacle.RichButton
54
+ /**
55
+ * Button title if we cannot determine the exact button. This is a rare edge case and is mainly here for backward compatibility. */
56
+ | string;
57
+ }
58
+ }
@@ -0,0 +1,16 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.ButtonClickedData = void 0;
7
+ var ButtonClickedData;
8
+ (function (ButtonClickedData) {
9
+ let Button;
10
+ (function (Button) {
11
+ Button.Type = {
12
+ Card: "CARD",
13
+ QuickReply: "QUICK_REPLY",
14
+ };
15
+ })(Button = ButtonClickedData.Button || (ButtonClickedData.Button = {}));
16
+ })(ButtonClickedData || (exports.ButtonClickedData = ButtonClickedData = {}));
@@ -7,9 +7,9 @@ import * as Pinnacle from "../index.js";
7
7
  */
8
8
  export interface Conversation {
9
9
  /** Identifier for the brand associated with this conversation. */
10
- brandId?: number | null;
10
+ brandId: number | null;
11
11
  /** Campaign information if this conversation is part of a marketing campaign. */
12
- campaign?: Pinnacle.CampaignQuery | null;
12
+ campaign: Pinnacle.CampaignQuery | null;
13
13
  /** Contact information for the recipient in a conversation. */
14
14
  contact: Conversation.Contact;
15
15
  /** ISO 8601 timestamp when the conversation was created. */
@@ -24,7 +24,7 @@ export interface Conversation {
24
24
  * - An RCS agent with ID and name
25
25
  * - `null` if no sender is associated
26
26
  */
27
- sender?: Conversation.Sender | null;
27
+ sender: Conversation.Sender | null;
28
28
  /** ISO 8601 timestamp when the conversation was last updated. */
29
29
  updatedAt: string;
30
30
  }
@@ -5,10 +5,10 @@ import * as Pinnacle from "../index.js";
5
5
  /**
6
6
  * Response for list conversation.
7
7
  */
8
- export interface ConversationList {
9
- /** Total number of conversations matching the filter. */
8
+ export type ConversationList = {
9
+ error?: string | undefined;
10
+ } | {
10
11
  count: number;
11
12
  conversations: Pinnacle.Conversation[];
12
- /** Indicates if more conversations are available beyond the current page. */
13
13
  hasMore: boolean;
14
- }
14
+ };
@@ -5,7 +5,7 @@ export interface CreateUrlOptions {
5
5
  /**
6
6
  * Expiration date in ISO 8601 format for the shortened URL. <br>
7
7
  *
8
- * If omitted, then a permalink is generated instead.
8
+ * If omitted, then a permalink is generated instead. Short permalinks contain a 30-digit link id. Short links with an expiration date contain a 8-digit link id.
9
9
  */
10
10
  expiresAt?: string | null;
11
11
  }
@@ -24,7 +24,7 @@ export interface DlcCampaignStatus {
24
24
  */
25
25
  status: Pinnacle.ProfileStatusEnum;
26
26
  /**
27
- * Status of toll free numbers that are being attached to this campaign. <br>
27
+ * Status of local long code numbers that are being attached to this campaign. <br>
28
28
  *
29
29
  * Note that phone numbers can only be attached to `VERIFIED` campaigns via the [attach campaign endpoint](../phone-numbers/attach-campaign).
30
30
  */
@@ -32,7 +32,7 @@ export interface DlcCampaignStatus {
32
32
  }
33
33
  export declare namespace DlcCampaignStatus {
34
34
  /**
35
- * Status of toll free numbers that are being attached to this campaign. <br>
35
+ * Status of local long code numbers that are being attached to this campaign. <br>
36
36
  *
37
37
  * Note that phone numbers can only be attached to `VERIFIED` campaigns via the [attach campaign endpoint](../phone-numbers/attach-campaign).
38
38
  */