rcs-js 2.0.0-rc.1 → 2.0.0-rc.11

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 (237) hide show
  1. package/dist/cjs/Client.d.ts +3 -3
  2. package/dist/cjs/Client.js +11 -11
  3. package/dist/cjs/api/resources/brands/client/Client.d.ts +2 -0
  4. package/dist/cjs/api/resources/brands/client/Client.js +6 -0
  5. package/dist/cjs/api/resources/brands/client/requests/UpsertBrandParams.d.ts +1 -1
  6. package/dist/cjs/api/resources/campaigns/resources/dlc/client/Client.d.ts +6 -6
  7. package/dist/cjs/api/resources/campaigns/resources/dlc/client/Client.js +6 -6
  8. package/dist/cjs/api/resources/campaigns/resources/rcs/client/Client.d.ts +1 -0
  9. package/dist/cjs/api/resources/campaigns/resources/rcs/client/Client.js +1 -0
  10. package/dist/cjs/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.ts +5 -2
  11. package/dist/cjs/api/resources/index.d.ts +2 -1
  12. package/dist/cjs/api/resources/index.js +3 -2
  13. package/dist/cjs/api/resources/messages/client/Client.d.ts +6 -3
  14. package/dist/cjs/api/resources/messages/client/Client.js +12 -3
  15. package/dist/cjs/api/resources/messages/resources/index.d.ts +6 -3
  16. package/dist/cjs/api/resources/messages/resources/index.js +7 -4
  17. package/dist/cjs/api/resources/messages/resources/mms/client/Client.d.ts +27 -0
  18. package/dist/cjs/api/resources/messages/resources/mms/client/Client.js +86 -0
  19. package/dist/cjs/api/resources/messages/resources/mms/client/index.d.ts +1 -0
  20. package/dist/cjs/api/resources/messages/resources/mms/client/index.js +15 -0
  21. package/dist/cjs/api/resources/messages/resources/{send → mms}/client/requests/index.d.ts +0 -1
  22. package/dist/cjs/api/resources/messages/resources/mms/index.d.ts +1 -0
  23. package/dist/cjs/api/resources/messages/resources/mms/index.js +1 -0
  24. package/dist/cjs/api/resources/messages/resources/{send/types/SendRcsResponse.d.ts → mms/types/MmsSendResponse.d.ts} +1 -1
  25. package/dist/cjs/api/resources/messages/resources/mms/types/index.d.ts +1 -0
  26. package/dist/cjs/api/resources/{message → messages/resources/mms/types}/index.js +1 -2
  27. package/dist/cjs/api/resources/messages/resources/rcs/client/Client.d.ts +29 -0
  28. package/dist/cjs/api/resources/messages/resources/rcs/client/Client.js +88 -0
  29. package/dist/cjs/api/resources/messages/resources/rcs/index.d.ts +1 -0
  30. package/dist/cjs/api/resources/messages/resources/rcs/index.js +1 -0
  31. package/dist/cjs/api/resources/messages/resources/{send/types/SendSmsResponse.d.ts → rcs/types/RcsSendResponse.d.ts} +1 -1
  32. package/dist/cjs/api/resources/messages/resources/rcs/types/index.d.ts +1 -0
  33. package/dist/cjs/api/resources/messages/resources/rcs/types/index.js +17 -0
  34. package/dist/cjs/api/resources/{message → messages}/resources/sms/client/Client.d.ts +23 -1
  35. package/dist/cjs/api/resources/{message → messages}/resources/sms/client/Client.js +82 -1
  36. package/dist/cjs/api/resources/messages/resources/{send → sms}/client/requests/Sms.d.ts +2 -2
  37. package/dist/cjs/api/resources/messages/resources/sms/client/requests/index.d.ts +1 -0
  38. package/dist/cjs/api/resources/messages/resources/{send/types/SendMmsResponse.d.ts → sms/types/SmsSendResponse.d.ts} +1 -1
  39. package/dist/cjs/api/resources/messages/resources/sms/types/index.d.ts +1 -0
  40. package/dist/cjs/api/resources/messages/resources/sms/types/index.js +17 -0
  41. package/dist/cjs/api/resources/phoneNumbers/client/requests/SearchPhoneNumberParams.d.ts +2 -2
  42. package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/Client.d.ts +2 -0
  43. package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/Client.js +6 -0
  44. package/dist/cjs/api/resources/phoneNumbers/resources/webhook/client/Client.d.ts +1 -0
  45. package/dist/cjs/api/resources/phoneNumbers/resources/webhook/client/Client.js +3 -0
  46. package/dist/cjs/api/resources/rcs/client/Client.d.ts +121 -0
  47. package/dist/cjs/api/resources/{messages/resources/send → rcs}/client/Client.js +76 -67
  48. package/dist/cjs/api/resources/rcs/client/index.d.ts +2 -0
  49. package/dist/cjs/api/resources/rcs/client/index.js +17 -0
  50. package/dist/cjs/api/resources/rcs/client/requests/RcsCapabilitiesQuery.d.ts +13 -0
  51. package/dist/cjs/api/resources/rcs/client/requests/RcsLinkRequest.d.ts +22 -0
  52. package/dist/cjs/api/resources/rcs/client/requests/RcsWhitelistRequest.d.ts +16 -0
  53. package/dist/cjs/api/resources/rcs/client/requests/index.d.ts +3 -0
  54. package/dist/cjs/api/resources/status/resources/get/client/Client.d.ts +2 -2
  55. package/dist/cjs/api/resources/status/resources/get/client/Client.js +2 -2
  56. package/dist/cjs/api/types/ConversationList.d.ts +4 -4
  57. package/dist/cjs/api/types/DlcCampaignStatus.d.ts +2 -2
  58. package/dist/cjs/api/types/ExtendedRcsCampaign.d.ts +4 -2
  59. package/dist/cjs/api/types/Rcs.d.ts +3 -3
  60. package/dist/cjs/api/types/RcsCampaign.d.ts +4 -2
  61. package/dist/cjs/api/types/RcsCapabilitiesResult.d.ts +8 -0
  62. package/dist/cjs/api/types/RcsCapability.d.ts +36 -0
  63. package/dist/cjs/api/types/RcsCards.d.ts +2 -2
  64. package/dist/cjs/api/types/RcsCardsContent.d.ts +2 -2
  65. package/dist/cjs/api/types/RcsLinkResult.d.ts +13 -0
  66. package/dist/cjs/api/types/RcsLinkResult.js +5 -0
  67. package/dist/cjs/api/types/RcsMediaContent.d.ts +1 -1
  68. package/dist/cjs/api/types/RcsTextContent.d.ts +1 -1
  69. package/dist/cjs/api/types/RcsValidateContent.d.ts +1 -0
  70. package/dist/cjs/api/types/RcsWhitelistResponse.d.ts +10 -0
  71. package/dist/cjs/api/types/RcsWhitelistResponse.js +5 -0
  72. package/dist/cjs/api/types/{RcsButtonContent.d.ts → RichButton.d.ts} +2 -2
  73. package/dist/cjs/api/types/RichButton.js +5 -0
  74. package/dist/cjs/api/types/{RcsCard.d.ts → RichCardsMessage.d.ts} +1 -1
  75. package/dist/cjs/api/types/RichCardsMessage.js +5 -0
  76. package/dist/cjs/api/types/{RcsMedia.d.ts → RichMediaMessage.d.ts} +2 -2
  77. package/dist/cjs/api/types/RichMediaMessage.js +5 -0
  78. package/dist/cjs/api/types/{RcsText.d.ts → RichTextMessage.d.ts} +1 -1
  79. package/dist/cjs/api/types/RichTextMessage.js +5 -0
  80. package/dist/{esm/api/types/NullableContact.d.mts → cjs/api/types/UpsertContact.d.ts} +1 -1
  81. package/dist/cjs/api/types/UpsertContact.js +5 -0
  82. package/dist/cjs/api/types/index.d.ts +9 -5
  83. package/dist/cjs/api/types/index.js +9 -5
  84. package/dist/cjs/index.d.ts +4 -4
  85. package/dist/cjs/index.js +8 -8
  86. package/dist/cjs/version.d.ts +1 -1
  87. package/dist/cjs/version.js +1 -1
  88. package/dist/esm/Client.d.mts +3 -3
  89. package/dist/esm/Client.mjs +7 -7
  90. package/dist/esm/api/resources/brands/client/Client.d.mts +2 -0
  91. package/dist/esm/api/resources/brands/client/Client.mjs +6 -0
  92. package/dist/esm/api/resources/brands/client/requests/UpsertBrandParams.d.mts +1 -1
  93. package/dist/esm/api/resources/campaigns/resources/dlc/client/Client.d.mts +6 -6
  94. package/dist/esm/api/resources/campaigns/resources/dlc/client/Client.mjs +6 -6
  95. package/dist/esm/api/resources/campaigns/resources/rcs/client/Client.d.mts +1 -0
  96. package/dist/esm/api/resources/campaigns/resources/rcs/client/Client.mjs +1 -0
  97. package/dist/esm/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.mts +5 -2
  98. package/dist/esm/api/resources/index.d.mts +2 -1
  99. package/dist/esm/api/resources/index.mjs +2 -1
  100. package/dist/esm/api/resources/messages/client/Client.d.mts +6 -3
  101. package/dist/esm/api/resources/messages/client/Client.mjs +12 -3
  102. package/dist/esm/api/resources/messages/resources/index.d.mts +6 -3
  103. package/dist/esm/api/resources/messages/resources/index.mjs +6 -3
  104. package/dist/esm/api/resources/messages/resources/mms/client/Client.d.mts +27 -0
  105. package/dist/esm/api/resources/messages/resources/mms/client/Client.mjs +86 -0
  106. package/dist/esm/api/resources/messages/resources/mms/client/index.d.mts +1 -0
  107. package/dist/esm/api/resources/messages/resources/mms/client/index.mjs +1 -1
  108. package/dist/esm/api/resources/messages/resources/{send → mms}/client/requests/index.d.mts +0 -1
  109. package/dist/esm/api/resources/messages/resources/mms/index.d.mts +1 -0
  110. package/dist/esm/api/resources/messages/resources/mms/index.mjs +1 -0
  111. package/dist/esm/api/resources/messages/resources/{send/types/SendRcsResponse.d.mts → mms/types/MmsSendResponse.d.mts} +1 -1
  112. package/dist/esm/api/resources/messages/resources/mms/types/index.d.mts +1 -0
  113. package/dist/esm/api/resources/messages/resources/mms/types/index.mjs +1 -0
  114. package/dist/esm/api/resources/messages/resources/rcs/client/Client.d.mts +29 -0
  115. package/dist/esm/api/resources/messages/resources/rcs/client/Client.mjs +88 -0
  116. package/dist/esm/api/resources/messages/resources/rcs/index.d.mts +1 -0
  117. package/dist/esm/api/resources/messages/resources/rcs/index.mjs +1 -0
  118. package/dist/esm/api/resources/messages/resources/{send/types/SendSmsResponse.d.mts → rcs/types/RcsSendResponse.d.mts} +1 -1
  119. package/dist/esm/api/resources/messages/resources/rcs/types/index.d.mts +1 -0
  120. package/dist/esm/api/resources/messages/resources/rcs/types/index.mjs +1 -0
  121. package/dist/esm/api/resources/{message → messages}/resources/sms/client/Client.d.mts +23 -1
  122. package/dist/esm/api/resources/{message → messages}/resources/sms/client/Client.mjs +82 -1
  123. package/dist/esm/api/resources/messages/resources/{send → sms}/client/requests/Sms.d.mts +2 -2
  124. package/dist/esm/api/resources/messages/resources/sms/client/requests/index.d.mts +1 -0
  125. package/dist/esm/api/resources/messages/resources/{send/types/SendMmsResponse.d.mts → sms/types/SmsSendResponse.d.mts} +1 -1
  126. package/dist/esm/api/resources/messages/resources/sms/types/index.d.mts +1 -0
  127. package/dist/esm/api/resources/messages/resources/sms/types/index.mjs +1 -0
  128. package/dist/esm/api/resources/phoneNumbers/client/requests/SearchPhoneNumberParams.d.mts +2 -2
  129. package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/Client.d.mts +2 -0
  130. package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/Client.mjs +6 -0
  131. package/dist/esm/api/resources/phoneNumbers/resources/webhook/client/Client.d.mts +1 -0
  132. package/dist/esm/api/resources/phoneNumbers/resources/webhook/client/Client.mjs +3 -0
  133. package/dist/esm/api/resources/rcs/client/Client.d.mts +121 -0
  134. package/dist/esm/api/resources/{messages/resources/send → rcs}/client/Client.mjs +74 -65
  135. package/dist/esm/api/resources/rcs/client/index.d.mts +2 -0
  136. package/dist/esm/api/resources/rcs/client/index.mjs +1 -0
  137. package/dist/esm/api/resources/rcs/client/requests/RcsCapabilitiesQuery.d.mts +13 -0
  138. package/dist/esm/api/resources/rcs/client/requests/RcsLinkRequest.d.mts +22 -0
  139. package/dist/esm/api/resources/rcs/client/requests/RcsWhitelistRequest.d.mts +16 -0
  140. package/dist/esm/api/resources/rcs/client/requests/index.d.mts +3 -0
  141. package/dist/esm/api/resources/status/resources/get/client/Client.d.mts +2 -2
  142. package/dist/esm/api/resources/status/resources/get/client/Client.mjs +2 -2
  143. package/dist/esm/api/types/ConversationList.d.mts +4 -4
  144. package/dist/esm/api/types/DlcCampaignStatus.d.mts +2 -2
  145. package/dist/esm/api/types/ExtendedRcsCampaign.d.mts +4 -2
  146. package/dist/esm/api/types/Rcs.d.mts +3 -3
  147. package/dist/esm/api/types/RcsCampaign.d.mts +4 -2
  148. package/dist/esm/api/types/RcsCapabilitiesResult.d.mts +8 -0
  149. package/dist/esm/api/types/RcsCapability.d.mts +36 -0
  150. package/dist/esm/api/types/RcsCards.d.mts +2 -2
  151. package/dist/esm/api/types/RcsCardsContent.d.mts +2 -2
  152. package/dist/esm/api/types/RcsLinkResult.d.mts +13 -0
  153. package/dist/esm/api/types/RcsLinkResult.mjs +4 -0
  154. package/dist/esm/api/types/RcsMediaContent.d.mts +1 -1
  155. package/dist/esm/api/types/RcsTextContent.d.mts +1 -1
  156. package/dist/esm/api/types/RcsValidateContent.d.mts +1 -0
  157. package/dist/esm/api/types/RcsWhitelistResponse.d.mts +10 -0
  158. package/dist/esm/api/types/RcsWhitelistResponse.mjs +4 -0
  159. package/dist/esm/api/types/{RcsButtonContent.d.mts → RichButton.d.mts} +2 -2
  160. package/dist/esm/api/types/RichButton.mjs +4 -0
  161. package/dist/esm/api/types/{RcsCard.d.mts → RichCardsMessage.d.mts} +1 -1
  162. package/dist/esm/api/types/RichCardsMessage.mjs +4 -0
  163. package/dist/esm/api/types/{RcsMedia.d.mts → RichMediaMessage.d.mts} +2 -2
  164. package/dist/esm/api/types/RichMediaMessage.mjs +4 -0
  165. package/dist/esm/api/types/{RcsText.d.mts → RichTextMessage.d.mts} +1 -1
  166. package/dist/esm/api/types/RichTextMessage.mjs +4 -0
  167. package/dist/{cjs/api/types/NullableContact.d.ts → esm/api/types/UpsertContact.d.mts} +1 -1
  168. package/dist/esm/api/types/UpsertContact.mjs +4 -0
  169. package/dist/esm/api/types/index.d.mts +9 -5
  170. package/dist/esm/api/types/index.mjs +9 -5
  171. package/dist/esm/index.d.mts +4 -4
  172. package/dist/esm/index.mjs +4 -4
  173. package/dist/esm/version.d.mts +1 -1
  174. package/dist/esm/version.mjs +1 -1
  175. package/package.json +1 -1
  176. package/reference.md +284 -56
  177. package/dist/cjs/api/resources/message/client/Client.d.ts +0 -22
  178. package/dist/cjs/api/resources/message/client/Client.js +0 -17
  179. package/dist/cjs/api/resources/message/client/index.d.ts +0 -1
  180. package/dist/cjs/api/resources/message/index.d.ts +0 -2
  181. package/dist/cjs/api/resources/message/resources/index.d.ts +0 -1
  182. package/dist/cjs/api/resources/message/resources/index.js +0 -37
  183. package/dist/cjs/api/resources/message/resources/sms/client/index.d.ts +0 -1
  184. package/dist/cjs/api/resources/messages/resources/send/client/Client.d.ts +0 -110
  185. package/dist/cjs/api/resources/messages/resources/send/types/index.d.ts +0 -3
  186. package/dist/cjs/api/resources/messages/resources/send/types/index.js +0 -19
  187. package/dist/esm/api/resources/message/client/Client.d.mts +0 -22
  188. package/dist/esm/api/resources/message/client/Client.mjs +0 -13
  189. package/dist/esm/api/resources/message/client/index.d.mts +0 -1
  190. package/dist/esm/api/resources/message/index.d.mts +0 -2
  191. package/dist/esm/api/resources/message/index.mjs +0 -2
  192. package/dist/esm/api/resources/message/resources/index.d.mts +0 -1
  193. package/dist/esm/api/resources/message/resources/index.mjs +0 -1
  194. package/dist/esm/api/resources/message/resources/sms/client/index.d.mts +0 -1
  195. package/dist/esm/api/resources/messages/resources/send/client/Client.d.mts +0 -110
  196. package/dist/esm/api/resources/messages/resources/send/types/index.d.mts +0 -3
  197. package/dist/esm/api/resources/messages/resources/send/types/index.mjs +0 -3
  198. /package/dist/cjs/api/resources/messages/resources/{send → mms}/client/requests/Mms.d.ts +0 -0
  199. /package/dist/cjs/api/resources/messages/resources/{send → mms}/client/requests/Mms.js +0 -0
  200. /package/dist/cjs/api/resources/{message/client → messages/resources/mms/client/requests}/index.js +0 -0
  201. /package/dist/cjs/api/resources/messages/resources/{send/client/requests/Sms.js → mms/types/MmsSendResponse.js} +0 -0
  202. /package/dist/cjs/api/resources/messages/resources/{send/types/SendMmsResponse.js → rcs/types/RcsSendResponse.js} +0 -0
  203. /package/dist/cjs/api/resources/messages/resources/{send → sms}/client/index.d.ts +0 -0
  204. /package/dist/cjs/api/resources/messages/resources/{send → sms}/client/index.js +0 -0
  205. /package/dist/cjs/api/resources/messages/resources/{send/types/SendRcsResponse.js → sms/client/requests/Sms.js} +0 -0
  206. /package/dist/cjs/api/resources/{message/resources/sms/client → messages/resources/sms/client/requests}/index.js +0 -0
  207. /package/dist/cjs/api/resources/messages/resources/{send → sms}/index.d.ts +0 -0
  208. /package/dist/cjs/api/resources/messages/resources/{send → sms}/index.js +0 -0
  209. /package/dist/cjs/api/resources/messages/resources/{send/types/SendSmsResponse.js → sms/types/SmsSendResponse.js} +0 -0
  210. /package/dist/cjs/api/{types/NullableContact.js → resources/rcs/client/requests/RcsCapabilitiesQuery.js} +0 -0
  211. /package/dist/cjs/api/{types/RcsButtonContent.js → resources/rcs/client/requests/RcsLinkRequest.js} +0 -0
  212. /package/dist/cjs/api/{types/RcsCard.js → resources/rcs/client/requests/RcsWhitelistRequest.js} +0 -0
  213. /package/dist/cjs/api/resources/{messages/resources/send → rcs}/client/requests/index.js +0 -0
  214. /package/dist/cjs/api/resources/{message/resources/sms → rcs}/index.d.ts +0 -0
  215. /package/dist/cjs/api/resources/{message/resources/sms → rcs}/index.js +0 -0
  216. /package/dist/cjs/api/types/{RcsMedia.js → RcsCapabilitiesResult.js} +0 -0
  217. /package/dist/cjs/api/types/{RcsText.js → RcsCapability.js} +0 -0
  218. /package/dist/esm/api/resources/messages/resources/{send → mms}/client/requests/Mms.d.mts +0 -0
  219. /package/dist/esm/api/resources/messages/resources/{send → mms}/client/requests/Mms.mjs +0 -0
  220. /package/dist/esm/api/resources/{message/client → messages/resources/mms/client/requests}/index.mjs +0 -0
  221. /package/dist/esm/api/resources/messages/resources/{send/client/requests/Sms.mjs → mms/types/MmsSendResponse.mjs} +0 -0
  222. /package/dist/esm/api/resources/messages/resources/{send/types/SendMmsResponse.mjs → rcs/types/RcsSendResponse.mjs} +0 -0
  223. /package/dist/esm/api/resources/messages/resources/{send → sms}/client/index.d.mts +0 -0
  224. /package/dist/esm/api/resources/messages/resources/{send → sms}/client/index.mjs +0 -0
  225. /package/dist/esm/api/resources/messages/resources/{send/types/SendRcsResponse.mjs → sms/client/requests/Sms.mjs} +0 -0
  226. /package/dist/esm/api/resources/{message/resources/sms/client → messages/resources/sms/client/requests}/index.mjs +0 -0
  227. /package/dist/esm/api/resources/messages/resources/{send → sms}/index.d.mts +0 -0
  228. /package/dist/esm/api/resources/messages/resources/{send → sms}/index.mjs +0 -0
  229. /package/dist/esm/api/resources/messages/resources/{send/types/SendSmsResponse.mjs → sms/types/SmsSendResponse.mjs} +0 -0
  230. /package/dist/esm/api/{types/NullableContact.mjs → resources/rcs/client/requests/RcsCapabilitiesQuery.mjs} +0 -0
  231. /package/dist/esm/api/{types/RcsButtonContent.mjs → resources/rcs/client/requests/RcsLinkRequest.mjs} +0 -0
  232. /package/dist/esm/api/{types/RcsCard.mjs → resources/rcs/client/requests/RcsWhitelistRequest.mjs} +0 -0
  233. /package/dist/esm/api/resources/{messages/resources/send → rcs}/client/requests/index.mjs +0 -0
  234. /package/dist/esm/api/resources/{message/resources/sms → rcs}/index.d.mts +0 -0
  235. /package/dist/esm/api/resources/{message/resources/sms → rcs}/index.mjs +0 -0
  236. /package/dist/esm/api/types/{RcsMedia.mjs → RcsCapabilitiesResult.mjs} +0 -0
  237. /package/dist/esm/api/types/{RcsText.mjs → RcsCapability.mjs} +0 -0
@@ -1,110 +0,0 @@
1
- /**
2
- * This file was auto-generated by Fern from our API Definition.
3
- */
4
- import * as environments from "../../../../../../environments.js";
5
- import * as core from "../../../../../../core/index.js";
6
- import * as Pinnacle from "../../../../../index.js";
7
- export declare namespace Send {
8
- interface Options {
9
- environment?: core.Supplier<environments.PinnacleEnvironment | string>;
10
- /** Specify a custom URL to connect the client to. */
11
- baseUrl?: core.Supplier<string>;
12
- apiKey: core.Supplier<string>;
13
- /** Additional headers to include in requests. */
14
- headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
15
- }
16
- interface RequestOptions {
17
- /** The maximum time to wait for a response in seconds. */
18
- timeoutInSeconds?: number;
19
- /** The number of times to retry the request. Defaults to 2. */
20
- maxRetries?: number;
21
- /** A hook to abort the request. */
22
- abortSignal?: AbortSignal;
23
- /** Additional query string parameters to include in the request. */
24
- queryParams?: Record<string, unknown>;
25
- /** Additional headers to include in the request. */
26
- headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
27
- }
28
- }
29
- export declare class Send {
30
- protected readonly _options: Send.Options;
31
- constructor(_options: Send.Options);
32
- /**
33
- * Send a SMS message immediately or schedule it for future delivery.
34
- *
35
- * @param {Pinnacle.messages.Sms} request
36
- * @param {Send.RequestOptions} requestOptions - Request-specific configuration.
37
- *
38
- * @throws {@link Pinnacle.BadRequestError}
39
- * @throws {@link Pinnacle.UnauthorizedError}
40
- * @throws {@link Pinnacle.PaymentRequiredError}
41
- * @throws {@link Pinnacle.NotFoundError}
42
- * @throws {@link Pinnacle.InternalServerError}
43
- *
44
- * @example
45
- * await client.messages.send.sms({
46
- * from: "+14155164736",
47
- * text: "Hey! \uD83D\uDE02",
48
- * to: "+14154746461"
49
- * })
50
- */
51
- sms(request: Pinnacle.messages.Sms, requestOptions?: Send.RequestOptions): core.HttpResponsePromise<Pinnacle.messages.SendSmsResponse>;
52
- private __sms;
53
- /**
54
- * Send a MMS immediately or schedule it for future delivery.
55
- *
56
- * @param {Pinnacle.messages.Mms} request
57
- * @param {Send.RequestOptions} requestOptions - Request-specific configuration.
58
- *
59
- * @throws {@link Pinnacle.BadRequestError}
60
- * @throws {@link Pinnacle.UnauthorizedError}
61
- * @throws {@link Pinnacle.PaymentRequiredError}
62
- * @throws {@link Pinnacle.NotFoundError}
63
- * @throws {@link Pinnacle.InternalServerError}
64
- *
65
- * @example
66
- * await client.messages.send.mms({
67
- * from: "+14155164736",
68
- * mediaUrls: ["https://fastly.picsum.photos/id/941/300/300.jpg?hmac=mDxM9PWSqRDjecwSCEpzU4bj35gqnG7yA25OL29uNv0"],
69
- * options: {
70
- * multiple_messages: true,
71
- * validate: true
72
- * },
73
- * text: "Check out this image!",
74
- * to: "+14154746461"
75
- * })
76
- */
77
- mms(request: Pinnacle.messages.Mms, requestOptions?: Send.RequestOptions): core.HttpResponsePromise<Pinnacle.messages.SendMmsResponse>;
78
- private __mms;
79
- /**
80
- * Send a RCS message immediately or schedule it for future delivery. <br>
81
- *
82
- * Requires an active RCS agent and recipient devices that support RCS Business Messaging.
83
- *
84
- * @param {Pinnacle.Rcs} request
85
- * @param {Send.RequestOptions} requestOptions - Request-specific configuration.
86
- *
87
- * @throws {@link Pinnacle.BadRequestError}
88
- * @throws {@link Pinnacle.UnauthorizedError}
89
- * @throws {@link Pinnacle.PaymentRequiredError}
90
- * @throws {@link Pinnacle.NotFoundError}
91
- * @throws {@link Pinnacle.InternalServerError}
92
- *
93
- * @example
94
- * await client.messages.send.rcs({
95
- * quickReplies: [{
96
- * type: "openUrl",
97
- * payload: "payload",
98
- * title: "title"
99
- * }],
100
- * text: "text",
101
- * from: "from",
102
- * to: "to"
103
- * })
104
- */
105
- rcs(request: Pinnacle.Rcs, requestOptions?: Send.RequestOptions): core.HttpResponsePromise<Pinnacle.messages.SendRcsResponse>;
106
- private __rcs;
107
- protected _getCustomAuthorizationHeaders(): Promise<{
108
- "PINNACLE-API-KEY": string;
109
- }>;
110
- }
@@ -1,3 +0,0 @@
1
- export * from "./SendSmsResponse.js";
2
- export * from "./SendMmsResponse.js";
3
- export * from "./SendRcsResponse.js";
@@ -1,19 +0,0 @@
1
- "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
- };
16
- Object.defineProperty(exports, "__esModule", { value: true });
17
- __exportStar(require("./SendSmsResponse.js"), exports);
18
- __exportStar(require("./SendMmsResponse.js"), exports);
19
- __exportStar(require("./SendRcsResponse.js"), exports);
@@ -1,22 +0,0 @@
1
- /**
2
- * This file was auto-generated by Fern from our API Definition.
3
- */
4
- import * as environments from "../../../../environments.mjs";
5
- import * as core from "../../../../core/index.mjs";
6
- import { Sms } from "../resources/sms/client/Client.mjs";
7
- export declare namespace Message {
8
- interface Options {
9
- environment?: core.Supplier<environments.PinnacleEnvironment | string>;
10
- /** Specify a custom URL to connect the client to. */
11
- baseUrl?: core.Supplier<string>;
12
- apiKey: core.Supplier<string>;
13
- /** Additional headers to include in requests. */
14
- headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
15
- }
16
- }
17
- export declare class Message {
18
- protected readonly _options: Message.Options;
19
- protected _sms: Sms | undefined;
20
- constructor(_options: Message.Options);
21
- get sms(): Sms;
22
- }
@@ -1,13 +0,0 @@
1
- /**
2
- * This file was auto-generated by Fern from our API Definition.
3
- */
4
- import { Sms } from "../resources/sms/client/Client.mjs";
5
- export class Message {
6
- constructor(_options) {
7
- this._options = _options;
8
- }
9
- get sms() {
10
- var _a;
11
- return ((_a = this._sms) !== null && _a !== void 0 ? _a : (this._sms = new Sms(this._options)));
12
- }
13
- }
@@ -1 +0,0 @@
1
- export {};
@@ -1,2 +0,0 @@
1
- export * from "./client/index.mjs";
2
- export * from "./resources/index.mjs";
@@ -1,2 +0,0 @@
1
- export * from "./client/index.mjs";
2
- export * from "./resources/index.mjs";
@@ -1 +0,0 @@
1
- export * as sms from "./sms/index.mjs";
@@ -1 +0,0 @@
1
- export * as sms from "./sms/index.mjs";
@@ -1,110 +0,0 @@
1
- /**
2
- * This file was auto-generated by Fern from our API Definition.
3
- */
4
- import * as environments from "../../../../../../environments.mjs";
5
- import * as core from "../../../../../../core/index.mjs";
6
- import * as Pinnacle from "../../../../../index.mjs";
7
- export declare namespace Send {
8
- interface Options {
9
- environment?: core.Supplier<environments.PinnacleEnvironment | string>;
10
- /** Specify a custom URL to connect the client to. */
11
- baseUrl?: core.Supplier<string>;
12
- apiKey: core.Supplier<string>;
13
- /** Additional headers to include in requests. */
14
- headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
15
- }
16
- interface RequestOptions {
17
- /** The maximum time to wait for a response in seconds. */
18
- timeoutInSeconds?: number;
19
- /** The number of times to retry the request. Defaults to 2. */
20
- maxRetries?: number;
21
- /** A hook to abort the request. */
22
- abortSignal?: AbortSignal;
23
- /** Additional query string parameters to include in the request. */
24
- queryParams?: Record<string, unknown>;
25
- /** Additional headers to include in the request. */
26
- headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
27
- }
28
- }
29
- export declare class Send {
30
- protected readonly _options: Send.Options;
31
- constructor(_options: Send.Options);
32
- /**
33
- * Send a SMS message immediately or schedule it for future delivery.
34
- *
35
- * @param {Pinnacle.messages.Sms} request
36
- * @param {Send.RequestOptions} requestOptions - Request-specific configuration.
37
- *
38
- * @throws {@link Pinnacle.BadRequestError}
39
- * @throws {@link Pinnacle.UnauthorizedError}
40
- * @throws {@link Pinnacle.PaymentRequiredError}
41
- * @throws {@link Pinnacle.NotFoundError}
42
- * @throws {@link Pinnacle.InternalServerError}
43
- *
44
- * @example
45
- * await client.messages.send.sms({
46
- * from: "+14155164736",
47
- * text: "Hey! \uD83D\uDE02",
48
- * to: "+14154746461"
49
- * })
50
- */
51
- sms(request: Pinnacle.messages.Sms, requestOptions?: Send.RequestOptions): core.HttpResponsePromise<Pinnacle.messages.SendSmsResponse>;
52
- private __sms;
53
- /**
54
- * Send a MMS immediately or schedule it for future delivery.
55
- *
56
- * @param {Pinnacle.messages.Mms} request
57
- * @param {Send.RequestOptions} requestOptions - Request-specific configuration.
58
- *
59
- * @throws {@link Pinnacle.BadRequestError}
60
- * @throws {@link Pinnacle.UnauthorizedError}
61
- * @throws {@link Pinnacle.PaymentRequiredError}
62
- * @throws {@link Pinnacle.NotFoundError}
63
- * @throws {@link Pinnacle.InternalServerError}
64
- *
65
- * @example
66
- * await client.messages.send.mms({
67
- * from: "+14155164736",
68
- * mediaUrls: ["https://fastly.picsum.photos/id/941/300/300.jpg?hmac=mDxM9PWSqRDjecwSCEpzU4bj35gqnG7yA25OL29uNv0"],
69
- * options: {
70
- * multiple_messages: true,
71
- * validate: true
72
- * },
73
- * text: "Check out this image!",
74
- * to: "+14154746461"
75
- * })
76
- */
77
- mms(request: Pinnacle.messages.Mms, requestOptions?: Send.RequestOptions): core.HttpResponsePromise<Pinnacle.messages.SendMmsResponse>;
78
- private __mms;
79
- /**
80
- * Send a RCS message immediately or schedule it for future delivery. <br>
81
- *
82
- * Requires an active RCS agent and recipient devices that support RCS Business Messaging.
83
- *
84
- * @param {Pinnacle.Rcs} request
85
- * @param {Send.RequestOptions} requestOptions - Request-specific configuration.
86
- *
87
- * @throws {@link Pinnacle.BadRequestError}
88
- * @throws {@link Pinnacle.UnauthorizedError}
89
- * @throws {@link Pinnacle.PaymentRequiredError}
90
- * @throws {@link Pinnacle.NotFoundError}
91
- * @throws {@link Pinnacle.InternalServerError}
92
- *
93
- * @example
94
- * await client.messages.send.rcs({
95
- * quickReplies: [{
96
- * type: "openUrl",
97
- * payload: "payload",
98
- * title: "title"
99
- * }],
100
- * text: "text",
101
- * from: "from",
102
- * to: "to"
103
- * })
104
- */
105
- rcs(request: Pinnacle.Rcs, requestOptions?: Send.RequestOptions): core.HttpResponsePromise<Pinnacle.messages.SendRcsResponse>;
106
- private __rcs;
107
- protected _getCustomAuthorizationHeaders(): Promise<{
108
- "PINNACLE-API-KEY": string;
109
- }>;
110
- }
@@ -1,3 +0,0 @@
1
- export * from "./SendSmsResponse.mjs";
2
- export * from "./SendMmsResponse.mjs";
3
- export * from "./SendRcsResponse.mjs";
@@ -1,3 +0,0 @@
1
- export * from "./SendSmsResponse.mjs";
2
- export * from "./SendMmsResponse.mjs";
3
- export * from "./SendRcsResponse.mjs";