rcs-js 2.0.0-rc.10 → 2.0.0-rc.12

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 (198) hide show
  1. package/dist/cjs/Client.d.ts +3 -0
  2. package/dist/cjs/Client.js +15 -10
  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/campaigns/resources/dlc/client/Client.d.ts +6 -6
  6. package/dist/cjs/api/resources/campaigns/resources/dlc/client/Client.js +6 -6
  7. package/dist/cjs/api/resources/campaigns/resources/rcs/client/Client.d.ts +1 -0
  8. package/dist/cjs/api/resources/campaigns/resources/rcs/client/Client.js +3 -0
  9. package/dist/cjs/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.ts +2 -2
  10. package/dist/cjs/api/resources/index.d.ts +2 -0
  11. package/dist/cjs/api/resources/index.js +3 -1
  12. package/dist/cjs/api/resources/messages/client/Client.d.ts +3 -0
  13. package/dist/cjs/api/resources/messages/client/Client.js +9 -0
  14. package/dist/cjs/api/resources/messages/resources/mms/client/Client.d.ts +1 -0
  15. package/dist/cjs/api/resources/messages/resources/mms/client/Client.js +3 -0
  16. package/dist/cjs/api/resources/messages/resources/rcs/client/Client.d.ts +3 -2
  17. package/dist/cjs/api/resources/messages/resources/rcs/client/Client.js +4 -1
  18. package/dist/cjs/api/resources/messages/resources/sms/client/Client.d.ts +1 -0
  19. package/dist/cjs/api/resources/messages/resources/sms/client/Client.js +3 -0
  20. package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/Client.d.ts +2 -0
  21. package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/Client.js +6 -0
  22. package/dist/cjs/api/resources/phoneNumbers/resources/webhook/client/Client.d.ts +1 -0
  23. package/dist/cjs/api/resources/phoneNumbers/resources/webhook/client/Client.js +3 -0
  24. package/dist/cjs/api/resources/rcs/client/Client.d.ts +121 -0
  25. package/dist/cjs/api/resources/rcs/client/Client.js +320 -0
  26. package/dist/cjs/api/resources/rcs/client/index.d.ts +2 -0
  27. package/dist/cjs/api/resources/rcs/client/index.js +17 -0
  28. package/dist/cjs/api/resources/rcs/client/requests/RcsCapabilitiesQuery.d.ts +13 -0
  29. package/dist/cjs/api/resources/rcs/client/requests/RcsLinkRequest.d.ts +22 -0
  30. package/dist/cjs/api/resources/rcs/client/requests/RcsWhitelistRequest.d.ts +16 -0
  31. package/dist/cjs/api/resources/rcs/client/requests/index.d.ts +3 -0
  32. package/dist/cjs/api/resources/rcs/client/requests/index.js +2 -0
  33. package/dist/cjs/api/resources/rcs/index.d.ts +1 -0
  34. package/dist/cjs/api/resources/rcs/index.js +17 -0
  35. package/dist/cjs/api/resources/status/resources/get/client/Client.d.ts +2 -2
  36. package/dist/cjs/api/resources/status/resources/get/client/Client.js +2 -2
  37. package/dist/cjs/api/resources/tools/resources/file/client/Client.d.ts +21 -0
  38. package/dist/cjs/api/resources/tools/resources/file/client/Client.js +74 -0
  39. package/dist/cjs/api/resources/tools/resources/file/client/requests/RefreshFileParams.d.ts +21 -0
  40. package/dist/cjs/api/resources/tools/resources/file/client/requests/RefreshFileParams.js +5 -0
  41. package/dist/cjs/api/resources/tools/resources/file/client/requests/index.d.ts +1 -0
  42. package/dist/cjs/api/resources/tools/resources/url/client/Client.d.ts +1 -1
  43. package/dist/cjs/api/resources/tools/resources/url/client/Client.js +1 -1
  44. package/dist/cjs/api/types/AutofillDlcCampaignResponse.d.ts +11 -11
  45. package/dist/cjs/api/types/ButtonClicked.d.ts +11 -0
  46. package/dist/cjs/api/types/ButtonClicked.js +5 -0
  47. package/dist/cjs/api/types/ButtonClickedData.d.ts +56 -0
  48. package/dist/cjs/api/types/ButtonClickedData.js +16 -0
  49. package/dist/cjs/api/types/ConversationList.d.ts +4 -4
  50. package/dist/cjs/api/types/CreateUrlOptions.d.ts +1 -1
  51. package/dist/cjs/api/types/DlcCampaignStatus.d.ts +2 -2
  52. package/dist/cjs/api/types/DlcCampaignWithExtendedBrandAndStatus.d.ts +13 -10
  53. package/dist/cjs/api/types/ExtendedBrand.d.ts +7 -4
  54. package/dist/cjs/api/types/ExtendedRcsCampaign.d.ts +11 -10
  55. package/dist/cjs/api/types/MessageContent.d.ts +2 -2
  56. package/dist/cjs/api/types/MessageEvent.d.ts +56 -0
  57. package/dist/cjs/api/types/MessageEvent.js +13 -0
  58. package/dist/cjs/api/types/ProfileStatusEnum.d.ts +7 -4
  59. package/dist/cjs/api/types/RcsBase.d.ts +2 -0
  60. package/dist/cjs/api/types/RcsButtonCall.d.ts +2 -0
  61. package/dist/cjs/api/types/RcsButtonOpenUrl.d.ts +2 -0
  62. package/dist/cjs/api/types/RcsButtonRequestUserLocation.d.ts +2 -0
  63. package/dist/cjs/api/types/RcsButtonScheduleEvent.d.ts +2 -0
  64. package/dist/cjs/api/types/RcsButtonSendLocation.d.ts +2 -0
  65. package/dist/cjs/api/types/RcsButtonTrigger.d.ts +2 -2
  66. package/dist/cjs/api/types/RcsCampaign.d.ts +2 -2
  67. package/dist/cjs/api/types/RcsCapabilitiesResult.d.ts +8 -0
  68. package/dist/cjs/api/types/RcsCapabilitiesResult.js +5 -0
  69. package/dist/cjs/api/types/RcsCapability.d.ts +36 -0
  70. package/dist/cjs/api/types/RcsCapability.js +5 -0
  71. package/dist/cjs/api/types/RcsLinkResult.d.ts +13 -0
  72. package/dist/cjs/api/types/RcsLinkResult.js +5 -0
  73. package/dist/cjs/api/types/RcsValidateContent.d.ts +1 -0
  74. package/dist/cjs/api/types/RcsWhitelistResponse.d.ts +10 -0
  75. package/dist/cjs/api/types/RcsWhitelistResponse.js +5 -0
  76. package/dist/cjs/api/types/RefreshedFile.d.ts +9 -0
  77. package/dist/cjs/api/types/RefreshedFile.js +5 -0
  78. package/dist/cjs/api/types/{Rcs.d.ts → RichMessage.d.ts} +1 -1
  79. package/dist/cjs/api/types/RichMessage.js +5 -0
  80. package/dist/cjs/api/types/index.d.ts +9 -3
  81. package/dist/cjs/api/types/index.js +9 -3
  82. package/dist/cjs/index.d.ts +1 -1
  83. package/dist/cjs/index.js +2 -2
  84. package/dist/cjs/version.d.ts +1 -1
  85. package/dist/cjs/version.js +1 -1
  86. package/dist/cjs/wrapper/PinnacleClient.d.ts +9 -0
  87. package/dist/cjs/wrapper/PinnacleClient.js +17 -0
  88. package/dist/cjs/wrapper/messages/Client.d.ts +13 -0
  89. package/dist/cjs/wrapper/messages/Client.js +49 -0
  90. package/dist/cjs/wrapper/tools/Client.d.ts +6 -0
  91. package/dist/cjs/wrapper/tools/Client.js +12 -0
  92. package/dist/cjs/wrapper/tools/FileUploader.d.ts +15 -0
  93. package/dist/cjs/wrapper/tools/FileUploader.js +162 -0
  94. package/dist/esm/Client.d.mts +3 -0
  95. package/dist/esm/Client.mjs +7 -2
  96. package/dist/esm/api/resources/brands/client/Client.d.mts +2 -0
  97. package/dist/esm/api/resources/brands/client/Client.mjs +6 -0
  98. package/dist/esm/api/resources/campaigns/resources/dlc/client/Client.d.mts +6 -6
  99. package/dist/esm/api/resources/campaigns/resources/dlc/client/Client.mjs +6 -6
  100. package/dist/esm/api/resources/campaigns/resources/rcs/client/Client.d.mts +1 -0
  101. package/dist/esm/api/resources/campaigns/resources/rcs/client/Client.mjs +3 -0
  102. package/dist/esm/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.mts +2 -2
  103. package/dist/esm/api/resources/index.d.mts +2 -0
  104. package/dist/esm/api/resources/index.mjs +2 -0
  105. package/dist/esm/api/resources/messages/client/Client.d.mts +3 -0
  106. package/dist/esm/api/resources/messages/client/Client.mjs +9 -0
  107. package/dist/esm/api/resources/messages/resources/mms/client/Client.d.mts +1 -0
  108. package/dist/esm/api/resources/messages/resources/mms/client/Client.mjs +3 -0
  109. package/dist/esm/api/resources/messages/resources/rcs/client/Client.d.mts +3 -2
  110. package/dist/esm/api/resources/messages/resources/rcs/client/Client.mjs +4 -1
  111. package/dist/esm/api/resources/messages/resources/sms/client/Client.d.mts +1 -0
  112. package/dist/esm/api/resources/messages/resources/sms/client/Client.mjs +3 -0
  113. package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/Client.d.mts +2 -0
  114. package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/Client.mjs +6 -0
  115. package/dist/esm/api/resources/phoneNumbers/resources/webhook/client/Client.d.mts +1 -0
  116. package/dist/esm/api/resources/phoneNumbers/resources/webhook/client/Client.mjs +3 -0
  117. package/dist/esm/api/resources/rcs/client/Client.d.mts +121 -0
  118. package/dist/esm/api/resources/rcs/client/Client.mjs +283 -0
  119. package/dist/esm/api/resources/rcs/client/index.d.mts +2 -0
  120. package/dist/esm/api/resources/rcs/client/index.mjs +1 -0
  121. package/dist/esm/api/resources/rcs/client/requests/RcsCapabilitiesQuery.d.mts +13 -0
  122. package/dist/esm/api/resources/rcs/client/requests/RcsLinkRequest.d.mts +22 -0
  123. package/dist/esm/api/resources/rcs/client/requests/RcsWhitelistRequest.d.mts +16 -0
  124. package/dist/esm/api/resources/rcs/client/requests/index.d.mts +3 -0
  125. package/dist/esm/api/resources/rcs/client/requests/index.mjs +1 -0
  126. package/dist/esm/api/resources/rcs/index.d.mts +1 -0
  127. package/dist/esm/api/resources/rcs/index.mjs +1 -0
  128. package/dist/esm/api/resources/status/resources/get/client/Client.d.mts +2 -2
  129. package/dist/esm/api/resources/status/resources/get/client/Client.mjs +2 -2
  130. package/dist/esm/api/resources/tools/resources/file/client/Client.d.mts +21 -0
  131. package/dist/esm/api/resources/tools/resources/file/client/Client.mjs +74 -0
  132. package/dist/esm/api/resources/tools/resources/file/client/requests/RefreshFileParams.d.mts +21 -0
  133. package/dist/esm/api/resources/tools/resources/file/client/requests/RefreshFileParams.mjs +4 -0
  134. package/dist/esm/api/resources/tools/resources/file/client/requests/index.d.mts +1 -0
  135. package/dist/esm/api/resources/tools/resources/url/client/Client.d.mts +1 -1
  136. package/dist/esm/api/resources/tools/resources/url/client/Client.mjs +1 -1
  137. package/dist/esm/api/types/AutofillDlcCampaignResponse.d.mts +11 -11
  138. package/dist/esm/api/types/ButtonClicked.d.mts +11 -0
  139. package/dist/esm/api/types/ButtonClicked.mjs +4 -0
  140. package/dist/esm/api/types/ButtonClickedData.d.mts +56 -0
  141. package/dist/esm/api/types/ButtonClickedData.mjs +13 -0
  142. package/dist/esm/api/types/ConversationList.d.mts +4 -4
  143. package/dist/esm/api/types/CreateUrlOptions.d.mts +1 -1
  144. package/dist/esm/api/types/DlcCampaignStatus.d.mts +2 -2
  145. package/dist/esm/api/types/DlcCampaignWithExtendedBrandAndStatus.d.mts +13 -10
  146. package/dist/esm/api/types/ExtendedBrand.d.mts +7 -4
  147. package/dist/esm/api/types/ExtendedRcsCampaign.d.mts +11 -10
  148. package/dist/esm/api/types/MessageContent.d.mts +2 -2
  149. package/dist/esm/api/types/MessageEvent.d.mts +56 -0
  150. package/dist/esm/api/types/MessageEvent.mjs +10 -0
  151. package/dist/esm/api/types/ProfileStatusEnum.d.mts +7 -4
  152. package/dist/esm/api/types/RcsBase.d.mts +2 -0
  153. package/dist/esm/api/types/RcsButtonCall.d.mts +2 -0
  154. package/dist/esm/api/types/RcsButtonOpenUrl.d.mts +2 -0
  155. package/dist/esm/api/types/RcsButtonRequestUserLocation.d.mts +2 -0
  156. package/dist/esm/api/types/RcsButtonScheduleEvent.d.mts +2 -0
  157. package/dist/esm/api/types/RcsButtonSendLocation.d.mts +2 -0
  158. package/dist/esm/api/types/RcsButtonTrigger.d.mts +2 -2
  159. package/dist/esm/api/types/RcsCampaign.d.mts +2 -2
  160. package/dist/esm/api/types/RcsCapabilitiesResult.d.mts +8 -0
  161. package/dist/esm/api/types/RcsCapabilitiesResult.mjs +4 -0
  162. package/dist/esm/api/types/RcsCapability.d.mts +36 -0
  163. package/dist/esm/api/types/RcsCapability.mjs +4 -0
  164. package/dist/esm/api/types/RcsLinkResult.d.mts +13 -0
  165. package/dist/esm/api/types/RcsLinkResult.mjs +4 -0
  166. package/dist/esm/api/types/RcsValidateContent.d.mts +1 -0
  167. package/dist/esm/api/types/RcsWhitelistResponse.d.mts +10 -0
  168. package/dist/esm/api/types/RcsWhitelistResponse.mjs +4 -0
  169. package/dist/esm/api/types/RefreshedFile.d.mts +9 -0
  170. package/dist/esm/api/types/RefreshedFile.mjs +4 -0
  171. package/dist/esm/api/types/{Rcs.d.mts → RichMessage.d.mts} +1 -1
  172. package/dist/esm/api/types/RichMessage.mjs +4 -0
  173. package/dist/esm/api/types/index.d.mts +9 -3
  174. package/dist/esm/api/types/index.mjs +9 -3
  175. package/dist/esm/index.d.mts +1 -1
  176. package/dist/esm/index.mjs +1 -1
  177. package/dist/esm/version.d.mts +1 -1
  178. package/dist/esm/version.mjs +1 -1
  179. package/dist/esm/wrapper/PinnacleClient.d.mts +9 -0
  180. package/dist/esm/wrapper/PinnacleClient.mjs +13 -0
  181. package/dist/esm/wrapper/messages/Client.d.mts +13 -0
  182. package/dist/esm/wrapper/messages/Client.mjs +45 -0
  183. package/dist/esm/wrapper/tools/Client.d.mts +6 -0
  184. package/dist/esm/wrapper/tools/Client.mjs +8 -0
  185. package/dist/esm/wrapper/tools/FileUploader.d.mts +15 -0
  186. package/dist/esm/wrapper/tools/FileUploader.mjs +125 -0
  187. package/package.json +7 -3
  188. package/reference.md +313 -10
  189. package/dist/cjs/api/types/ClickAction.d.ts +0 -28
  190. package/dist/cjs/api/types/InboundButton.d.ts +0 -11
  191. package/dist/esm/api/types/ClickAction.d.mts +0 -28
  192. package/dist/esm/api/types/InboundButton.d.mts +0 -11
  193. /package/dist/cjs/api/{types/ClickAction.js → resources/rcs/client/requests/RcsCapabilitiesQuery.js} +0 -0
  194. /package/dist/cjs/api/{types/InboundButton.js → resources/rcs/client/requests/RcsLinkRequest.js} +0 -0
  195. /package/dist/cjs/api/{types/Rcs.js → resources/rcs/client/requests/RcsWhitelistRequest.js} +0 -0
  196. /package/dist/esm/api/{types/ClickAction.mjs → resources/rcs/client/requests/RcsCapabilitiesQuery.mjs} +0 -0
  197. /package/dist/esm/api/{types/InboundButton.mjs → resources/rcs/client/requests/RcsLinkRequest.mjs} +0 -0
  198. /package/dist/esm/api/{types/Rcs.mjs → resources/rcs/client/requests/RcsWhitelistRequest.mjs} +0 -0
@@ -8,6 +8,7 @@ import { Contacts } from "./api/resources/contacts/client/Client.js";
8
8
  import { Conversations } from "./api/resources/conversations/client/Client.js";
9
9
  import { Messages } from "./api/resources/messages/client/Client.js";
10
10
  import { PhoneNumbers } from "./api/resources/phoneNumbers/client/Client.js";
11
+ import { Rcs } from "./api/resources/rcs/client/Client.js";
11
12
  import { Webhooks } from "./api/resources/webhooks/client/Client.js";
12
13
  import { Campaigns } from "./api/resources/campaigns/client/Client.js";
13
14
  import { Status } from "./api/resources/status/client/Client.js";
@@ -41,6 +42,7 @@ export declare class PinnacleClient {
41
42
  protected _conversations: Conversations | undefined;
42
43
  protected _messages: Messages | undefined;
43
44
  protected _phoneNumbers: PhoneNumbers | undefined;
45
+ protected _rcs: Rcs | undefined;
44
46
  protected _webhooks: Webhooks | undefined;
45
47
  protected _campaigns: Campaigns | undefined;
46
48
  protected _status: Status | undefined;
@@ -51,6 +53,7 @@ export declare class PinnacleClient {
51
53
  get conversations(): Conversations;
52
54
  get messages(): Messages;
53
55
  get phoneNumbers(): PhoneNumbers;
56
+ get rcs(): Rcs;
54
57
  get webhooks(): Webhooks;
55
58
  get campaigns(): Campaigns;
56
59
  get status(): Status;
@@ -44,17 +44,18 @@ const Client_js_2 = require("./api/resources/contacts/client/Client.js");
44
44
  const Client_js_3 = require("./api/resources/conversations/client/Client.js");
45
45
  const Client_js_4 = require("./api/resources/messages/client/Client.js");
46
46
  const Client_js_5 = require("./api/resources/phoneNumbers/client/Client.js");
47
- const Client_js_6 = require("./api/resources/webhooks/client/Client.js");
48
- const Client_js_7 = require("./api/resources/campaigns/client/Client.js");
49
- const Client_js_8 = require("./api/resources/status/client/Client.js");
50
- const Client_js_9 = require("./api/resources/tools/client/Client.js");
47
+ const Client_js_6 = require("./api/resources/rcs/client/Client.js");
48
+ const Client_js_7 = require("./api/resources/webhooks/client/Client.js");
49
+ const Client_js_8 = require("./api/resources/campaigns/client/Client.js");
50
+ const Client_js_9 = require("./api/resources/status/client/Client.js");
51
+ const Client_js_10 = require("./api/resources/tools/client/Client.js");
51
52
  class PinnacleClient {
52
53
  constructor(_options) {
53
54
  this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
54
55
  "X-Fern-Language": "JavaScript",
55
56
  "X-Fern-SDK-Name": "rcs-js",
56
- "X-Fern-SDK-Version": "2.0.0-rc.10",
57
- "User-Agent": "rcs-js/2.0.0-rc.10",
57
+ "X-Fern-SDK-Version": "2.0.0-rc.12",
58
+ "User-Agent": "rcs-js/2.0.0-rc.12",
58
59
  "X-Fern-Runtime": core.RUNTIME.type,
59
60
  "X-Fern-Runtime-Version": core.RUNTIME.version,
60
61
  }, _options === null || _options === void 0 ? void 0 : _options.headers) });
@@ -79,21 +80,25 @@ class PinnacleClient {
79
80
  var _a;
80
81
  return ((_a = this._phoneNumbers) !== null && _a !== void 0 ? _a : (this._phoneNumbers = new Client_js_5.PhoneNumbers(this._options)));
81
82
  }
83
+ get rcs() {
84
+ var _a;
85
+ return ((_a = this._rcs) !== null && _a !== void 0 ? _a : (this._rcs = new Client_js_6.Rcs(this._options)));
86
+ }
82
87
  get webhooks() {
83
88
  var _a;
84
- return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Client_js_6.Webhooks(this._options)));
89
+ return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Client_js_7.Webhooks(this._options)));
85
90
  }
86
91
  get campaigns() {
87
92
  var _a;
88
- return ((_a = this._campaigns) !== null && _a !== void 0 ? _a : (this._campaigns = new Client_js_7.Campaigns(this._options)));
93
+ return ((_a = this._campaigns) !== null && _a !== void 0 ? _a : (this._campaigns = new Client_js_8.Campaigns(this._options)));
89
94
  }
90
95
  get status() {
91
96
  var _a;
92
- return ((_a = this._status) !== null && _a !== void 0 ? _a : (this._status = new Client_js_8.Status(this._options)));
97
+ return ((_a = this._status) !== null && _a !== void 0 ? _a : (this._status = new Client_js_9.Status(this._options)));
93
98
  }
94
99
  get tools() {
95
100
  var _a;
96
- return ((_a = this._tools) !== null && _a !== void 0 ? _a : (this._tools = new Client_js_9.Tools(this._options)));
101
+ return ((_a = this._tools) !== null && _a !== void 0 ? _a : (this._tools = new Client_js_10.Tools(this._options)));
97
102
  }
98
103
  }
99
104
  exports.PinnacleClient = PinnacleClient;
@@ -111,6 +111,7 @@ export declare class Brands {
111
111
  * @throws {@link Pinnacle.BadRequestError}
112
112
  * @throws {@link Pinnacle.UnauthorizedError}
113
113
  * @throws {@link Pinnacle.PaymentRequiredError}
114
+ * @throws {@link Pinnacle.NotFoundError}
114
115
  * @throws {@link Pinnacle.InternalServerError}
115
116
  * @throws {@link Pinnacle.NotImplementedError}
116
117
  *
@@ -162,6 +163,7 @@ export declare class Brands {
162
163
  * @throws {@link Pinnacle.BadRequestError}
163
164
  * @throws {@link Pinnacle.UnauthorizedError}
164
165
  * @throws {@link Pinnacle.PaymentRequiredError}
166
+ * @throws {@link Pinnacle.NotFoundError}
165
167
  * @throws {@link Pinnacle.InternalServerError}
166
168
  * @throws {@link Pinnacle.NotImplementedError}
167
169
  *
@@ -300,6 +300,7 @@ class Brands {
300
300
  * @throws {@link Pinnacle.BadRequestError}
301
301
  * @throws {@link Pinnacle.UnauthorizedError}
302
302
  * @throws {@link Pinnacle.PaymentRequiredError}
303
+ * @throws {@link Pinnacle.NotFoundError}
303
304
  * @throws {@link Pinnacle.InternalServerError}
304
305
  * @throws {@link Pinnacle.NotImplementedError}
305
306
  *
@@ -333,6 +334,8 @@ class Brands {
333
334
  throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
334
335
  case 402:
335
336
  throw new Pinnacle.PaymentRequiredError(_response.error.body, _response.rawResponse);
337
+ case 404:
338
+ throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
336
339
  case 500:
337
340
  throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
338
341
  case 501:
@@ -458,6 +461,7 @@ class Brands {
458
461
  * @throws {@link Pinnacle.BadRequestError}
459
462
  * @throws {@link Pinnacle.UnauthorizedError}
460
463
  * @throws {@link Pinnacle.PaymentRequiredError}
464
+ * @throws {@link Pinnacle.NotFoundError}
461
465
  * @throws {@link Pinnacle.InternalServerError}
462
466
  * @throws {@link Pinnacle.NotImplementedError}
463
467
  *
@@ -494,6 +498,8 @@ class Brands {
494
498
  throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
495
499
  case 402:
496
500
  throw new Pinnacle.PaymentRequiredError(_response.error.body, _response.rawResponse);
501
+ case 404:
502
+ throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
497
503
  case 500:
498
504
  throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
499
505
  case 501:
@@ -48,9 +48,9 @@ export declare class Dlc {
48
48
  autofill(request: Pinnacle.AutofillCampaignParams, requestOptions?: Dlc.RequestOptions): core.HttpResponsePromise<Pinnacle.AutofillDlcCampaignResponse>;
49
49
  private __autofill;
50
50
  /**
51
- * Retrieve DLC campaign.
51
+ * Retrieve 10DLC campaign.
52
52
  *
53
- * @param {number} campaignId - Unique identifier of the DLC campaign.
53
+ * @param {number} campaignId - Unique identifier of the 10DLC campaign.
54
54
  * @param {Dlc.RequestOptions} requestOptions - Request-specific configuration.
55
55
  *
56
56
  * @throws {@link Pinnacle.BadRequestError}
@@ -64,9 +64,9 @@ export declare class Dlc {
64
64
  get(campaignId: number, requestOptions?: Dlc.RequestOptions): core.HttpResponsePromise<Pinnacle.DlcCampaignWithExtendedBrandAndStatus>;
65
65
  private __get;
66
66
  /**
67
- * Submit your DLC campaign for approval and activation with carriers.
67
+ * Submit your 10DLC campaign for approval and activation with carriers.
68
68
  *
69
- * @param {number} campaignId - Unique identifier of the DLC campaign to submit.
69
+ * @param {number} campaignId - Unique identifier of the 10DLC campaign to submit.
70
70
  * @param {Dlc.RequestOptions} requestOptions - Request-specific configuration.
71
71
  *
72
72
  * @throws {@link Pinnacle.BadRequestError}
@@ -80,7 +80,7 @@ export declare class Dlc {
80
80
  submit(campaignId: number, requestOptions?: Dlc.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignSubmissionResult>;
81
81
  private __submit;
82
82
  /**
83
- * Create a new DLC campaign or updates an existing one. <br>
83
+ * Create a new 10DLC campaign or updates an existing one. <br>
84
84
  *
85
85
  * Omit campaignId to create a campaign.
86
86
  *
@@ -135,7 +135,7 @@ export declare class Dlc {
135
135
  upsert(request?: Pinnacle.campaigns.UpsertDlcCampaignParams, requestOptions?: Dlc.RequestOptions): core.HttpResponsePromise<Pinnacle.DlcCampaignWithExtendedBrandAndStatus>;
136
136
  private __upsert;
137
137
  /**
138
- * Validate your DLC campaign configuration against carrier requirements and compliance rules.
138
+ * Validate your 10DLC campaign configuration against carrier requirements and compliance rules.
139
139
  *
140
140
  * @param {Pinnacle.ValidateCampaignParams} request
141
141
  * @param {Dlc.RequestOptions} requestOptions - Request-specific configuration.
@@ -127,9 +127,9 @@ class Dlc {
127
127
  });
128
128
  }
129
129
  /**
130
- * Retrieve DLC campaign.
130
+ * Retrieve 10DLC campaign.
131
131
  *
132
- * @param {number} campaignId - Unique identifier of the DLC campaign.
132
+ * @param {number} campaignId - Unique identifier of the 10DLC campaign.
133
133
  * @param {Dlc.RequestOptions} requestOptions - Request-specific configuration.
134
134
  *
135
135
  * @throws {@link Pinnacle.BadRequestError}
@@ -198,9 +198,9 @@ class Dlc {
198
198
  });
199
199
  }
200
200
  /**
201
- * Submit your DLC campaign for approval and activation with carriers.
201
+ * Submit your 10DLC campaign for approval and activation with carriers.
202
202
  *
203
- * @param {number} campaignId - Unique identifier of the DLC campaign to submit.
203
+ * @param {number} campaignId - Unique identifier of the 10DLC campaign to submit.
204
204
  * @param {Dlc.RequestOptions} requestOptions - Request-specific configuration.
205
205
  *
206
206
  * @throws {@link Pinnacle.BadRequestError}
@@ -266,7 +266,7 @@ class Dlc {
266
266
  });
267
267
  }
268
268
  /**
269
- * Create a new DLC campaign or updates an existing one. <br>
269
+ * Create a new 10DLC campaign or updates an existing one. <br>
270
270
  *
271
271
  * Omit campaignId to create a campaign.
272
272
  *
@@ -379,7 +379,7 @@ class Dlc {
379
379
  });
380
380
  }
381
381
  /**
382
- * Validate your DLC campaign configuration against carrier requirements and compliance rules.
382
+ * Validate your 10DLC campaign configuration against carrier requirements and compliance rules.
383
383
  *
384
384
  * @param {Pinnacle.ValidateCampaignParams} request
385
385
  * @param {Dlc.RequestOptions} requestOptions - Request-specific configuration.
@@ -71,6 +71,7 @@ export declare class Rcs {
71
71
  *
72
72
  * @throws {@link Pinnacle.BadRequestError}
73
73
  * @throws {@link Pinnacle.UnauthorizedError}
74
+ * @throws {@link Pinnacle.PaymentRequiredError}
74
75
  * @throws {@link Pinnacle.NotFoundError}
75
76
  * @throws {@link Pinnacle.InternalServerError}
76
77
  *
@@ -205,6 +205,7 @@ class Rcs {
205
205
  *
206
206
  * @throws {@link Pinnacle.BadRequestError}
207
207
  * @throws {@link Pinnacle.UnauthorizedError}
208
+ * @throws {@link Pinnacle.PaymentRequiredError}
208
209
  * @throws {@link Pinnacle.NotFoundError}
209
210
  * @throws {@link Pinnacle.InternalServerError}
210
211
  *
@@ -236,6 +237,8 @@ class Rcs {
236
237
  throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
237
238
  case 401:
238
239
  throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
240
+ case 402:
241
+ throw new Pinnacle.PaymentRequiredError(_response.error.body, _response.rawResponse);
239
242
  case 404:
240
243
  throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
241
244
  case 500:
@@ -80,9 +80,9 @@ export declare namespace UpsertRcsCampaignParams {
80
80
  description?: string;
81
81
  /** List of emails (1-3 required). */
82
82
  emails?: Agent.Emails.Item[];
83
- /** Link to the agent's hero. */
83
+ /** Link to the agent's hero. Hero must be an image file with dimensions 1440x448px. */
84
84
  heroUrl?: string;
85
- /** Link to the agent's icon. */
85
+ /** Link to the agent's icon. Icon must be an image file with dimensions 224x224px. */
86
86
  iconUrl?: string;
87
87
  /** Name of the agent. */
88
88
  name?: string;
@@ -5,6 +5,7 @@ export * as messages from "./messages/index.js";
5
5
  export * as brands from "./brands/index.js";
6
6
  export * as contacts from "./contacts/index.js";
7
7
  export * as conversations from "./conversations/index.js";
8
+ export * as rcs from "./rcs/index.js";
8
9
  export * as webhooks from "./webhooks/index.js";
9
10
  export * as status from "./status/index.js";
10
11
  export * as tools from "./tools/index.js";
@@ -13,4 +14,5 @@ export * from "./contacts/client/requests/index.js";
13
14
  export * from "./conversations/client/requests/index.js";
14
15
  export * from "./messages/client/requests/index.js";
15
16
  export * from "./phoneNumbers/client/requests/index.js";
17
+ export * from "./rcs/client/requests/index.js";
16
18
  export * from "./webhooks/client/requests/index.js";
@@ -36,7 +36,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
36
36
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
37
37
  };
38
38
  Object.defineProperty(exports, "__esModule", { value: true });
39
- exports.tools = exports.status = exports.webhooks = exports.conversations = exports.contacts = exports.brands = exports.messages = exports.campaigns = exports.phoneNumbers = void 0;
39
+ exports.tools = exports.status = exports.webhooks = exports.rcs = exports.conversations = exports.contacts = exports.brands = exports.messages = exports.campaigns = exports.phoneNumbers = void 0;
40
40
  exports.phoneNumbers = __importStar(require("./phoneNumbers/index.js"));
41
41
  __exportStar(require("./phoneNumbers/types/index.js"), exports);
42
42
  exports.campaigns = __importStar(require("./campaigns/index.js"));
@@ -44,6 +44,7 @@ exports.messages = __importStar(require("./messages/index.js"));
44
44
  exports.brands = __importStar(require("./brands/index.js"));
45
45
  exports.contacts = __importStar(require("./contacts/index.js"));
46
46
  exports.conversations = __importStar(require("./conversations/index.js"));
47
+ exports.rcs = __importStar(require("./rcs/index.js"));
47
48
  exports.webhooks = __importStar(require("./webhooks/index.js"));
48
49
  exports.status = __importStar(require("./status/index.js"));
49
50
  exports.tools = __importStar(require("./tools/index.js"));
@@ -52,4 +53,5 @@ __exportStar(require("./contacts/client/requests/index.js"), exports);
52
53
  __exportStar(require("./conversations/client/requests/index.js"), exports);
53
54
  __exportStar(require("./messages/client/requests/index.js"), exports);
54
55
  __exportStar(require("./phoneNumbers/client/requests/index.js"), exports);
56
+ __exportStar(require("./rcs/client/requests/index.js"), exports);
55
57
  __exportStar(require("./webhooks/client/requests/index.js"), exports);
@@ -62,7 +62,10 @@ export declare class Messages {
62
62
  *
63
63
  * @throws {@link Pinnacle.BadRequestError}
64
64
  * @throws {@link Pinnacle.UnauthorizedError}
65
+ * @throws {@link Pinnacle.PaymentRequiredError}
65
66
  * @throws {@link Pinnacle.NotFoundError}
67
+ * @throws {@link Pinnacle.InternalServerError}
68
+ * @throws {@link Pinnacle.NotImplementedError}
66
69
  *
67
70
  * @example
68
71
  * await client.messages.react({
@@ -146,7 +146,10 @@ class Messages {
146
146
  *
147
147
  * @throws {@link Pinnacle.BadRequestError}
148
148
  * @throws {@link Pinnacle.UnauthorizedError}
149
+ * @throws {@link Pinnacle.PaymentRequiredError}
149
150
  * @throws {@link Pinnacle.NotFoundError}
151
+ * @throws {@link Pinnacle.InternalServerError}
152
+ * @throws {@link Pinnacle.NotImplementedError}
150
153
  *
151
154
  * @example
152
155
  * await client.messages.react({
@@ -185,8 +188,14 @@ class Messages {
185
188
  throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
186
189
  case 401:
187
190
  throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
191
+ case 402:
192
+ throw new Pinnacle.PaymentRequiredError(_response.error.body, _response.rawResponse);
188
193
  case 404:
189
194
  throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
195
+ case 500:
196
+ throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
197
+ case 501:
198
+ throw new Pinnacle.NotImplementedError(_response.error.body, _response.rawResponse);
190
199
  default:
191
200
  throw new errors.PinnacleError({
192
201
  statusCode: _response.error.statusCode,
@@ -40,6 +40,7 @@ export declare class Mms {
40
40
  * @throws {@link Pinnacle.PaymentRequiredError}
41
41
  * @throws {@link Pinnacle.NotFoundError}
42
42
  * @throws {@link Pinnacle.InternalServerError}
43
+ * @throws {@link Pinnacle.NotImplementedError}
43
44
  *
44
45
  * @example
45
46
  * await client.messages.mms.send({
@@ -66,6 +66,7 @@ class Mms {
66
66
  * @throws {@link Pinnacle.PaymentRequiredError}
67
67
  * @throws {@link Pinnacle.NotFoundError}
68
68
  * @throws {@link Pinnacle.InternalServerError}
69
+ * @throws {@link Pinnacle.NotImplementedError}
69
70
  *
70
71
  * @example
71
72
  * await client.messages.mms.send({
@@ -113,6 +114,8 @@ class Mms {
113
114
  throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
114
115
  case 500:
115
116
  throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
117
+ case 501:
118
+ throw new Pinnacle.NotImplementedError(_response.error.body, _response.rawResponse);
116
119
  default:
117
120
  throw new errors.PinnacleError({
118
121
  statusCode: _response.error.statusCode,
@@ -34,7 +34,7 @@ export declare class Rcs {
34
34
  *
35
35
  * Requires an active RCS agent and recipient devices that support RCS Business Messaging.
36
36
  *
37
- * @param {Pinnacle.Rcs} request
37
+ * @param {Pinnacle.RichMessage} request
38
38
  * @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
39
39
  *
40
40
  * @throws {@link Pinnacle.BadRequestError}
@@ -42,6 +42,7 @@ export declare class Rcs {
42
42
  * @throws {@link Pinnacle.PaymentRequiredError}
43
43
  * @throws {@link Pinnacle.NotFoundError}
44
44
  * @throws {@link Pinnacle.InternalServerError}
45
+ * @throws {@link Pinnacle.NotImplementedError}
45
46
  *
46
47
  * @example
47
48
  * await client.messages.rcs.send({
@@ -55,7 +56,7 @@ export declare class Rcs {
55
56
  * to: "to"
56
57
  * })
57
58
  */
58
- send(request: Pinnacle.Rcs, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.messages.RcsSendResponse>;
59
+ send(request: Pinnacle.RichMessage, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.messages.RcsSendResponse>;
59
60
  private __send;
60
61
  /**
61
62
  * Validate RCS message content without sending it.
@@ -60,7 +60,7 @@ class Rcs {
60
60
  *
61
61
  * Requires an active RCS agent and recipient devices that support RCS Business Messaging.
62
62
  *
63
- * @param {Pinnacle.Rcs} request
63
+ * @param {Pinnacle.RichMessage} request
64
64
  * @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
65
65
  *
66
66
  * @throws {@link Pinnacle.BadRequestError}
@@ -68,6 +68,7 @@ class Rcs {
68
68
  * @throws {@link Pinnacle.PaymentRequiredError}
69
69
  * @throws {@link Pinnacle.NotFoundError}
70
70
  * @throws {@link Pinnacle.InternalServerError}
71
+ * @throws {@link Pinnacle.NotImplementedError}
71
72
  *
72
73
  * @example
73
74
  * await client.messages.rcs.send({
@@ -115,6 +116,8 @@ class Rcs {
115
116
  throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
116
117
  case 500:
117
118
  throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
119
+ case 501:
120
+ throw new Pinnacle.NotImplementedError(_response.error.body, _response.rawResponse);
118
121
  default:
119
122
  throw new errors.PinnacleError({
120
123
  statusCode: _response.error.statusCode,
@@ -40,6 +40,7 @@ export declare class Sms {
40
40
  * @throws {@link Pinnacle.PaymentRequiredError}
41
41
  * @throws {@link Pinnacle.NotFoundError}
42
42
  * @throws {@link Pinnacle.InternalServerError}
43
+ * @throws {@link Pinnacle.NotImplementedError}
43
44
  *
44
45
  * @example
45
46
  * await client.messages.sms.send({
@@ -66,6 +66,7 @@ class Sms {
66
66
  * @throws {@link Pinnacle.PaymentRequiredError}
67
67
  * @throws {@link Pinnacle.NotFoundError}
68
68
  * @throws {@link Pinnacle.InternalServerError}
69
+ * @throws {@link Pinnacle.NotImplementedError}
69
70
  *
70
71
  * @example
71
72
  * await client.messages.sms.send({
@@ -108,6 +109,8 @@ class Sms {
108
109
  throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
109
110
  case 500:
110
111
  throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
112
+ case 501:
113
+ throw new Pinnacle.NotImplementedError(_response.error.body, _response.rawResponse);
111
114
  default:
112
115
  throw new errors.PinnacleError({
113
116
  statusCode: _response.error.statusCode,
@@ -39,6 +39,7 @@ export declare class Campaign {
39
39
  * @throws {@link Pinnacle.UnauthorizedError}
40
40
  * @throws {@link Pinnacle.NotFoundError}
41
41
  * @throws {@link Pinnacle.InternalServerError}
42
+ * @throws {@link Pinnacle.NotImplementedError}
42
43
  *
43
44
  * @example
44
45
  * await client.phoneNumbers.campaign.attach({
@@ -59,6 +60,7 @@ export declare class Campaign {
59
60
  * @throws {@link Pinnacle.UnauthorizedError}
60
61
  * @throws {@link Pinnacle.NotFoundError}
61
62
  * @throws {@link Pinnacle.InternalServerError}
63
+ * @throws {@link Pinnacle.NotImplementedError}
62
64
  *
63
65
  * @example
64
66
  * await client.phoneNumbers.campaign.detach({
@@ -65,6 +65,7 @@ class Campaign {
65
65
  * @throws {@link Pinnacle.UnauthorizedError}
66
66
  * @throws {@link Pinnacle.NotFoundError}
67
67
  * @throws {@link Pinnacle.InternalServerError}
68
+ * @throws {@link Pinnacle.NotImplementedError}
68
69
  *
69
70
  * @example
70
71
  * await client.phoneNumbers.campaign.attach({
@@ -105,6 +106,8 @@ class Campaign {
105
106
  throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
106
107
  case 500:
107
108
  throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
109
+ case 501:
110
+ throw new Pinnacle.NotImplementedError(_response.error.body, _response.rawResponse);
108
111
  default:
109
112
  throw new errors.PinnacleError({
110
113
  statusCode: _response.error.statusCode,
@@ -140,6 +143,7 @@ class Campaign {
140
143
  * @throws {@link Pinnacle.UnauthorizedError}
141
144
  * @throws {@link Pinnacle.NotFoundError}
142
145
  * @throws {@link Pinnacle.InternalServerError}
146
+ * @throws {@link Pinnacle.NotImplementedError}
143
147
  *
144
148
  * @example
145
149
  * await client.phoneNumbers.campaign.detach({
@@ -178,6 +182,8 @@ class Campaign {
178
182
  throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
179
183
  case 500:
180
184
  throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
185
+ case 501:
186
+ throw new Pinnacle.NotImplementedError(_response.error.body, _response.rawResponse);
181
187
  default:
182
188
  throw new errors.PinnacleError({
183
189
  statusCode: _response.error.statusCode,
@@ -68,6 +68,7 @@ export declare class Webhook {
68
68
  * @throws {@link Pinnacle.UnauthorizedError}
69
69
  * @throws {@link Pinnacle.NotFoundError}
70
70
  * @throws {@link Pinnacle.InternalServerError}
71
+ * @throws {@link Pinnacle.NotImplementedError}
71
72
  *
72
73
  * @example
73
74
  * await client.phoneNumbers.webhook.detach("+14155551234", 123)
@@ -151,6 +151,7 @@ class Webhook {
151
151
  * @throws {@link Pinnacle.UnauthorizedError}
152
152
  * @throws {@link Pinnacle.NotFoundError}
153
153
  * @throws {@link Pinnacle.InternalServerError}
154
+ * @throws {@link Pinnacle.NotImplementedError}
154
155
  *
155
156
  * @example
156
157
  * await client.phoneNumbers.webhook.detach("+14155551234", 123)
@@ -184,6 +185,8 @@ class Webhook {
184
185
  throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
185
186
  case 500:
186
187
  throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
188
+ case 501:
189
+ throw new Pinnacle.NotImplementedError(_response.error.body, _response.rawResponse);
187
190
  default:
188
191
  throw new errors.PinnacleError({
189
192
  statusCode: _response.error.statusCode,
@@ -0,0 +1,121 @@
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 Rcs {
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 Rcs {
30
+ protected readonly _options: Rcs.Options;
31
+ constructor(_options: Rcs.Options);
32
+ /**
33
+ * Check RCS capabilities for one or more phone numbers.
34
+ *
35
+ * This endpoint allows you to verify which RCS features (cards, buttons, etc.) are supported
36
+ * on specific phone numbers before sending RCS messages to them.
37
+ *
38
+ * @param {Pinnacle.RcsCapabilitiesQuery} request
39
+ * @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
40
+ *
41
+ * @throws {@link Pinnacle.BadRequestError}
42
+ * @throws {@link Pinnacle.UnauthorizedError}
43
+ * @throws {@link Pinnacle.InternalServerError}
44
+ * @throws {@link Pinnacle.NotImplementedError}
45
+ *
46
+ * @example
47
+ * await client.rcs.getCapabilities({
48
+ * phoneNumbers: ["+12345678901", "+19876543210"]
49
+ * })
50
+ */
51
+ getCapabilities(request: Pinnacle.RcsCapabilitiesQuery, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.RcsCapabilitiesResult>;
52
+ private __getCapabilities;
53
+ /**
54
+ * Whitelist a phone number for testing with your test RCS agent.
55
+ *
56
+ * ## Overview
57
+ * During development and testing, RCS agents can only send messages to whitelisted phone numbers.
58
+ * Use this endpoint to add test devices to your agent's whitelist before sending test messages.
59
+ *
60
+ * ## Verification Process
61
+ * After whitelisting a number, you'll need to complete verification:
62
+ *
63
+ * 1. Check the test device for an "RBM Tester Management" request
64
+ * 2. Accept the request on the device
65
+ * 3. Enter the 4-digit verification code in the Pinnacle dashboard at:
66
+ * ```
67
+ * https://app.pinnacle.sh/dashboard/brands/{brandId}?campaignId={campaignId}&campaignType=RCS
68
+ * ```
69
+ *
70
+ * > **Important Notes**
71
+ * >
72
+ * > - **Testing only:** This is only required for test agents. Production agents can message any RCS-enabled number
73
+ * > - **AT&T limitation:** Whitelisting may currently fail for AT&T numbers
74
+ * > - **Verification required:** The whitelist request isn't complete until you verify the device.
75
+ *
76
+ * @param {Pinnacle.RcsWhitelistRequest} request
77
+ * @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
78
+ *
79
+ * @throws {@link Pinnacle.BadRequestError}
80
+ * @throws {@link Pinnacle.UnauthorizedError}
81
+ * @throws {@link Pinnacle.NotFoundError}
82
+ * @throws {@link Pinnacle.InternalServerError}
83
+ * @throws {@link Pinnacle.NotImplementedError}
84
+ *
85
+ * @example
86
+ * await client.rcs.whitelist({
87
+ * agentId: "agent_XXXXXXXXXXXX",
88
+ * phoneNumber: "+12345678901"
89
+ * })
90
+ */
91
+ whitelist(request: Pinnacle.RcsWhitelistRequest, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.RcsWhitelistResponse>;
92
+ private __whitelist;
93
+ /**
94
+ * Generate a link for initiating an RCS conversation with your agent.
95
+ *
96
+ * Users can click these links to start conversations with your RCS agent directly
97
+ * from websites, emails, or other applications.
98
+ *
99
+ * @param {Pinnacle.RcsLinkRequest} request
100
+ * @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
101
+ *
102
+ * @throws {@link Pinnacle.BadRequestError}
103
+ * @throws {@link Pinnacle.UnauthorizedError}
104
+ * @throws {@link Pinnacle.NotFoundError}
105
+ * @throws {@link Pinnacle.InternalServerError}
106
+ * @throws {@link Pinnacle.NotImplementedError}
107
+ *
108
+ * @example
109
+ * await client.rcs.getLink({
110
+ * agentId: "agent_XXXXXXXXXXXX",
111
+ * testMode: false,
112
+ * phoneNumber: "+12345678901",
113
+ * body: "Hello, I need help with my order"
114
+ * })
115
+ */
116
+ getLink(request: Pinnacle.RcsLinkRequest, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.RcsLinkResult>;
117
+ private __getLink;
118
+ protected _getCustomAuthorizationHeaders(): Promise<{
119
+ "PINNACLE-API-KEY": string;
120
+ }>;
121
+ }