rcs-js 1.0.14 → 1.0.16

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 (229) hide show
  1. package/Client.d.ts +3 -0
  2. package/Client.js +6 -1
  3. package/README.md +10 -0
  4. package/api/resources/company/client/Client.d.ts +8 -0
  5. package/api/resources/company/client/Client.js +11 -3
  6. package/api/resources/company/client/requests/CompanyRegisterRequest.d.ts +9 -0
  7. package/api/resources/company/client/requests/CompanyUpdateRequest.d.ts +1 -0
  8. package/api/resources/index.d.ts +3 -0
  9. package/api/resources/index.js +4 -1
  10. package/api/resources/send/client/Client.js +3 -3
  11. package/api/resources/tools/client/Client.d.ts +61 -0
  12. package/api/resources/tools/client/Client.js +195 -0
  13. package/api/resources/tools/client/index.d.ts +1 -0
  14. package/api/resources/tools/client/index.js +17 -0
  15. package/api/resources/tools/client/requests/ToolsShortenUrlRequest.d.ts +15 -0
  16. package/api/resources/tools/client/requests/ToolsShortenUrlRequest.js +5 -0
  17. package/api/resources/tools/client/requests/ToolsUploadUrlRequest.d.ts +24 -0
  18. package/api/resources/tools/client/requests/ToolsUploadUrlRequest.js +5 -0
  19. package/api/resources/tools/client/requests/index.d.ts +2 -0
  20. package/api/resources/tools/client/requests/index.js +2 -0
  21. package/api/resources/tools/index.d.ts +2 -0
  22. package/api/resources/tools/index.js +18 -0
  23. package/api/resources/tools/types/ToolsShortenUrlResponse.d.ts +9 -0
  24. package/api/resources/tools/types/ToolsShortenUrlResponse.js +5 -0
  25. package/api/resources/tools/types/ToolsUploadUrlResponse.d.ts +9 -0
  26. package/api/resources/tools/types/ToolsUploadUrlResponse.js +5 -0
  27. package/api/resources/tools/types/index.d.ts +2 -0
  28. package/api/resources/tools/types/index.js +18 -0
  29. package/api/types/Company.d.ts +12 -0
  30. package/api/types/CompanyCategory.d.ts +20 -0
  31. package/api/types/CompanyCategory.js +22 -0
  32. package/api/types/CompanyDetails.d.ts +3 -0
  33. package/api/types/InboundActionMessage.d.ts +13 -0
  34. package/api/types/InboundActionMessage.js +5 -0
  35. package/api/types/InboundLocationMessage.d.ts +11 -0
  36. package/api/types/InboundLocationMessage.js +5 -0
  37. package/api/types/InboundLocationMessageCoordinates.d.ts +7 -0
  38. package/api/types/InboundLocationMessageCoordinates.js +5 -0
  39. package/api/types/InboundMediaMessage.d.ts +12 -0
  40. package/api/types/InboundMediaMessage.js +5 -0
  41. package/api/types/InboundMessage.d.ts +10 -0
  42. package/api/types/InboundMessage.js +5 -0
  43. package/api/types/InboundMessageMessageType.d.ts +10 -0
  44. package/api/types/InboundMessageMessageType.js +12 -0
  45. package/api/types/InboundMessageMetadata.d.ts +8 -0
  46. package/api/types/InboundMessageMetadata.js +5 -0
  47. package/api/types/InboundTextMessage.d.ts +11 -0
  48. package/api/types/InboundTextMessage.js +5 -0
  49. package/api/types/MediaPayload.d.ts +7 -0
  50. package/api/types/MediaPayload.js +5 -0
  51. package/api/types/MessageMetadata.d.ts +6 -0
  52. package/api/types/MessageMetadata.js +5 -0
  53. package/api/types/Messaging.d.ts +15 -0
  54. package/api/types/Messaging.js +5 -0
  55. package/api/types/SenderMetadata.d.ts +8 -0
  56. package/api/types/SenderMetadata.js +5 -0
  57. package/api/types/index.d.ts +13 -0
  58. package/api/types/index.js +13 -0
  59. package/dist/Client.d.ts +3 -0
  60. package/dist/Client.js +6 -1
  61. package/dist/api/resources/company/client/Client.d.ts +8 -0
  62. package/dist/api/resources/company/client/Client.js +11 -3
  63. package/dist/api/resources/company/client/requests/CompanyRegisterRequest.d.ts +9 -0
  64. package/dist/api/resources/company/client/requests/CompanyUpdateRequest.d.ts +1 -0
  65. package/dist/api/resources/index.d.ts +3 -0
  66. package/dist/api/resources/index.js +4 -1
  67. package/dist/api/resources/send/client/Client.js +3 -3
  68. package/dist/api/resources/tools/client/Client.d.ts +61 -0
  69. package/dist/api/resources/tools/client/Client.js +195 -0
  70. package/dist/api/resources/tools/client/index.d.ts +1 -0
  71. package/dist/api/resources/tools/client/index.js +17 -0
  72. package/dist/api/resources/tools/client/requests/ToolsShortenUrlRequest.d.ts +15 -0
  73. package/dist/api/resources/tools/client/requests/ToolsShortenUrlRequest.js +5 -0
  74. package/dist/api/resources/tools/client/requests/ToolsUploadUrlRequest.d.ts +24 -0
  75. package/dist/api/resources/tools/client/requests/ToolsUploadUrlRequest.js +5 -0
  76. package/dist/api/resources/tools/client/requests/index.d.ts +2 -0
  77. package/dist/api/resources/tools/client/requests/index.js +2 -0
  78. package/dist/api/resources/tools/index.d.ts +2 -0
  79. package/dist/api/resources/tools/index.js +18 -0
  80. package/dist/api/resources/tools/types/ToolsShortenUrlResponse.d.ts +9 -0
  81. package/dist/api/resources/tools/types/ToolsShortenUrlResponse.js +5 -0
  82. package/dist/api/resources/tools/types/ToolsUploadUrlResponse.d.ts +9 -0
  83. package/dist/api/resources/tools/types/ToolsUploadUrlResponse.js +5 -0
  84. package/dist/api/resources/tools/types/index.d.ts +2 -0
  85. package/dist/api/resources/tools/types/index.js +18 -0
  86. package/dist/api/types/Company.d.ts +12 -0
  87. package/dist/api/types/CompanyCategory.d.ts +20 -0
  88. package/dist/api/types/CompanyCategory.js +22 -0
  89. package/dist/api/types/CompanyDetails.d.ts +3 -0
  90. package/dist/api/types/InboundActionMessage.d.ts +13 -0
  91. package/dist/api/types/InboundActionMessage.js +5 -0
  92. package/dist/api/types/InboundLocationMessage.d.ts +11 -0
  93. package/dist/api/types/InboundLocationMessage.js +5 -0
  94. package/dist/api/types/InboundLocationMessageCoordinates.d.ts +7 -0
  95. package/dist/api/types/InboundLocationMessageCoordinates.js +5 -0
  96. package/dist/api/types/InboundMediaMessage.d.ts +12 -0
  97. package/dist/api/types/InboundMediaMessage.js +5 -0
  98. package/dist/api/types/InboundMessage.d.ts +10 -0
  99. package/dist/api/types/InboundMessage.js +5 -0
  100. package/dist/api/types/InboundMessageMessageType.d.ts +10 -0
  101. package/dist/api/types/InboundMessageMessageType.js +12 -0
  102. package/dist/api/types/InboundMessageMetadata.d.ts +8 -0
  103. package/dist/api/types/InboundMessageMetadata.js +5 -0
  104. package/dist/api/types/InboundTextMessage.d.ts +11 -0
  105. package/dist/api/types/InboundTextMessage.js +5 -0
  106. package/dist/api/types/MediaPayload.d.ts +7 -0
  107. package/dist/api/types/MediaPayload.js +5 -0
  108. package/dist/api/types/MessageMetadata.d.ts +6 -0
  109. package/dist/api/types/MessageMetadata.js +5 -0
  110. package/dist/api/types/Messaging.d.ts +15 -0
  111. package/dist/api/types/Messaging.js +5 -0
  112. package/dist/api/types/SenderMetadata.d.ts +8 -0
  113. package/dist/api/types/SenderMetadata.js +5 -0
  114. package/dist/api/types/index.d.ts +13 -0
  115. package/dist/api/types/index.js +13 -0
  116. package/dist/serialization/resources/company/client/requests/CompanyRegisterRequest.d.ts +2 -0
  117. package/dist/serialization/resources/company/client/requests/CompanyRegisterRequest.js +2 -0
  118. package/dist/serialization/resources/company/client/requests/CompanyUpdateRequest.d.ts +2 -0
  119. package/dist/serialization/resources/company/client/requests/CompanyUpdateRequest.js +2 -0
  120. package/dist/serialization/resources/index.d.ts +3 -0
  121. package/dist/serialization/resources/index.js +4 -1
  122. package/dist/serialization/resources/tools/client/index.d.ts +1 -0
  123. package/dist/serialization/resources/tools/client/index.js +17 -0
  124. package/dist/serialization/resources/tools/client/requests/ToolsShortenUrlRequest.d.ts +13 -0
  125. package/dist/serialization/resources/tools/client/requests/ToolsShortenUrlRequest.js +34 -0
  126. package/dist/serialization/resources/tools/client/requests/ToolsUploadUrlRequest.d.ts +14 -0
  127. package/dist/serialization/resources/tools/client/requests/ToolsUploadUrlRequest.js +35 -0
  128. package/dist/serialization/resources/tools/client/requests/index.d.ts +2 -0
  129. package/dist/serialization/resources/tools/client/requests/index.js +7 -0
  130. package/dist/serialization/resources/tools/index.d.ts +2 -0
  131. package/dist/serialization/resources/tools/index.js +18 -0
  132. package/dist/serialization/resources/tools/types/ToolsShortenUrlResponse.d.ts +13 -0
  133. package/dist/serialization/resources/tools/types/ToolsShortenUrlResponse.js +34 -0
  134. package/dist/serialization/resources/tools/types/ToolsUploadUrlResponse.d.ts +13 -0
  135. package/dist/serialization/resources/tools/types/ToolsUploadUrlResponse.js +34 -0
  136. package/dist/serialization/resources/tools/types/index.d.ts +2 -0
  137. package/dist/serialization/resources/tools/types/index.js +18 -0
  138. package/dist/serialization/types/Company.d.ts +7 -0
  139. package/dist/serialization/types/Company.js +7 -0
  140. package/dist/serialization/types/CompanyCategory.d.ts +10 -0
  141. package/dist/serialization/types/CompanyCategory.js +46 -0
  142. package/dist/serialization/types/CompanyDetails.d.ts +2 -0
  143. package/dist/serialization/types/CompanyDetails.js +2 -0
  144. package/dist/serialization/types/InboundActionMessage.d.ts +19 -0
  145. package/dist/serialization/types/InboundActionMessage.js +40 -0
  146. package/dist/serialization/types/InboundLocationMessage.d.ts +18 -0
  147. package/dist/serialization/types/InboundLocationMessage.js +39 -0
  148. package/dist/serialization/types/InboundLocationMessageCoordinates.d.ts +13 -0
  149. package/dist/serialization/types/InboundLocationMessageCoordinates.js +34 -0
  150. package/dist/serialization/types/InboundMediaMessage.d.ts +19 -0
  151. package/dist/serialization/types/InboundMediaMessage.js +40 -0
  152. package/dist/serialization/types/InboundMessage.d.ts +17 -0
  153. package/dist/serialization/types/InboundMessage.js +38 -0
  154. package/dist/serialization/types/InboundMessageMessageType.d.ts +10 -0
  155. package/dist/serialization/types/InboundMessageMessageType.js +31 -0
  156. package/dist/serialization/types/InboundMessageMetadata.d.ts +15 -0
  157. package/dist/serialization/types/InboundMessageMetadata.js +36 -0
  158. package/dist/serialization/types/InboundTextMessage.d.ts +17 -0
  159. package/dist/serialization/types/InboundTextMessage.js +38 -0
  160. package/dist/serialization/types/MediaPayload.d.ts +13 -0
  161. package/dist/serialization/types/MediaPayload.js +34 -0
  162. package/dist/serialization/types/MessageMetadata.d.ts +12 -0
  163. package/dist/serialization/types/MessageMetadata.js +33 -0
  164. package/dist/serialization/types/Messaging.d.ts +16 -0
  165. package/dist/serialization/types/Messaging.js +37 -0
  166. package/dist/serialization/types/SenderMetadata.d.ts +14 -0
  167. package/dist/serialization/types/SenderMetadata.js +35 -0
  168. package/dist/serialization/types/index.d.ts +13 -0
  169. package/dist/serialization/types/index.js +13 -0
  170. package/dist/version.d.ts +1 -1
  171. package/dist/version.js +1 -1
  172. package/package.json +5 -3
  173. package/reference.md +144 -0
  174. package/serialization/resources/company/client/requests/CompanyRegisterRequest.d.ts +2 -0
  175. package/serialization/resources/company/client/requests/CompanyRegisterRequest.js +2 -0
  176. package/serialization/resources/company/client/requests/CompanyUpdateRequest.d.ts +2 -0
  177. package/serialization/resources/company/client/requests/CompanyUpdateRequest.js +2 -0
  178. package/serialization/resources/index.d.ts +3 -0
  179. package/serialization/resources/index.js +4 -1
  180. package/serialization/resources/tools/client/index.d.ts +1 -0
  181. package/serialization/resources/tools/client/index.js +17 -0
  182. package/serialization/resources/tools/client/requests/ToolsShortenUrlRequest.d.ts +13 -0
  183. package/serialization/resources/tools/client/requests/ToolsShortenUrlRequest.js +34 -0
  184. package/serialization/resources/tools/client/requests/ToolsUploadUrlRequest.d.ts +14 -0
  185. package/serialization/resources/tools/client/requests/ToolsUploadUrlRequest.js +35 -0
  186. package/serialization/resources/tools/client/requests/index.d.ts +2 -0
  187. package/serialization/resources/tools/client/requests/index.js +7 -0
  188. package/serialization/resources/tools/index.d.ts +2 -0
  189. package/serialization/resources/tools/index.js +18 -0
  190. package/serialization/resources/tools/types/ToolsShortenUrlResponse.d.ts +13 -0
  191. package/serialization/resources/tools/types/ToolsShortenUrlResponse.js +34 -0
  192. package/serialization/resources/tools/types/ToolsUploadUrlResponse.d.ts +13 -0
  193. package/serialization/resources/tools/types/ToolsUploadUrlResponse.js +34 -0
  194. package/serialization/resources/tools/types/index.d.ts +2 -0
  195. package/serialization/resources/tools/types/index.js +18 -0
  196. package/serialization/types/Company.d.ts +7 -0
  197. package/serialization/types/Company.js +7 -0
  198. package/serialization/types/CompanyCategory.d.ts +10 -0
  199. package/serialization/types/CompanyCategory.js +46 -0
  200. package/serialization/types/CompanyDetails.d.ts +2 -0
  201. package/serialization/types/CompanyDetails.js +2 -0
  202. package/serialization/types/InboundActionMessage.d.ts +19 -0
  203. package/serialization/types/InboundActionMessage.js +40 -0
  204. package/serialization/types/InboundLocationMessage.d.ts +18 -0
  205. package/serialization/types/InboundLocationMessage.js +39 -0
  206. package/serialization/types/InboundLocationMessageCoordinates.d.ts +13 -0
  207. package/serialization/types/InboundLocationMessageCoordinates.js +34 -0
  208. package/serialization/types/InboundMediaMessage.d.ts +19 -0
  209. package/serialization/types/InboundMediaMessage.js +40 -0
  210. package/serialization/types/InboundMessage.d.ts +17 -0
  211. package/serialization/types/InboundMessage.js +38 -0
  212. package/serialization/types/InboundMessageMessageType.d.ts +10 -0
  213. package/serialization/types/InboundMessageMessageType.js +31 -0
  214. package/serialization/types/InboundMessageMetadata.d.ts +15 -0
  215. package/serialization/types/InboundMessageMetadata.js +36 -0
  216. package/serialization/types/InboundTextMessage.d.ts +17 -0
  217. package/serialization/types/InboundTextMessage.js +38 -0
  218. package/serialization/types/MediaPayload.d.ts +13 -0
  219. package/serialization/types/MediaPayload.js +34 -0
  220. package/serialization/types/MessageMetadata.d.ts +12 -0
  221. package/serialization/types/MessageMetadata.js +33 -0
  222. package/serialization/types/Messaging.d.ts +16 -0
  223. package/serialization/types/Messaging.js +37 -0
  224. package/serialization/types/SenderMetadata.d.ts +14 -0
  225. package/serialization/types/SenderMetadata.js +35 -0
  226. package/serialization/types/index.d.ts +13 -0
  227. package/serialization/types/index.js +13 -0
  228. package/version.d.ts +1 -1
  229. package/version.js +1 -1
@@ -0,0 +1,35 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
6
+ if (k2 === undefined) k2 = k;
7
+ var desc = Object.getOwnPropertyDescriptor(m, k);
8
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
9
+ desc = { enumerable: true, get: function() { return m[k]; } };
10
+ }
11
+ Object.defineProperty(o, k2, desc);
12
+ }) : (function(o, m, k, k2) {
13
+ if (k2 === undefined) k2 = k;
14
+ o[k2] = m[k];
15
+ }));
16
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
17
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
18
+ }) : function(o, v) {
19
+ o["default"] = v;
20
+ });
21
+ var __importStar = (this && this.__importStar) || function (mod) {
22
+ if (mod && mod.__esModule) return mod;
23
+ var result = {};
24
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
25
+ __setModuleDefault(result, mod);
26
+ return result;
27
+ };
28
+ Object.defineProperty(exports, "__esModule", { value: true });
29
+ exports.SenderMetadata = void 0;
30
+ const core = __importStar(require("../../core"));
31
+ exports.SenderMetadata = core.serialization.object({
32
+ city: core.serialization.string().optional(),
33
+ state: core.serialization.string().optional(),
34
+ country: core.serialization.string().optional(),
35
+ });
@@ -8,9 +8,11 @@ export * from "./CompanyAdditionalWebsitesItem";
8
8
  export * from "./CompanyAdditionalEmailsItem";
9
9
  export * from "./CompanyAdditionalPhoneNumbersItem";
10
10
  export * from "./Company";
11
+ export * from "./CompanyCategory";
11
12
  export * from "./CompanyDetails";
12
13
  export * from "./CompanyContact";
13
14
  export * from "./PointOfContact";
15
+ export * from "./Messaging";
14
16
  export * from "./AdditionalWebsite";
15
17
  export * from "./AdditionalPhoneNumber";
16
18
  export * from "./AdditionalEmail";
@@ -19,3 +21,14 @@ export * from "./Card";
19
21
  export * from "./ActionType";
20
22
  export * from "./ActionLatLong";
21
23
  export * from "./Action";
24
+ export * from "./InboundMessageMessageType";
25
+ export * from "./InboundMessageMetadata";
26
+ export * from "./InboundMessage";
27
+ export * from "./SenderMetadata";
28
+ export * from "./MessageMetadata";
29
+ export * from "./InboundTextMessage";
30
+ export * from "./MediaPayload";
31
+ export * from "./InboundMediaMessage";
32
+ export * from "./InboundActionMessage";
33
+ export * from "./InboundLocationMessageCoordinates";
34
+ export * from "./InboundLocationMessage";
@@ -24,9 +24,11 @@ __exportStar(require("./CompanyAdditionalWebsitesItem"), exports);
24
24
  __exportStar(require("./CompanyAdditionalEmailsItem"), exports);
25
25
  __exportStar(require("./CompanyAdditionalPhoneNumbersItem"), exports);
26
26
  __exportStar(require("./Company"), exports);
27
+ __exportStar(require("./CompanyCategory"), exports);
27
28
  __exportStar(require("./CompanyDetails"), exports);
28
29
  __exportStar(require("./CompanyContact"), exports);
29
30
  __exportStar(require("./PointOfContact"), exports);
31
+ __exportStar(require("./Messaging"), exports);
30
32
  __exportStar(require("./AdditionalWebsite"), exports);
31
33
  __exportStar(require("./AdditionalPhoneNumber"), exports);
32
34
  __exportStar(require("./AdditionalEmail"), exports);
@@ -35,3 +37,14 @@ __exportStar(require("./Card"), exports);
35
37
  __exportStar(require("./ActionType"), exports);
36
38
  __exportStar(require("./ActionLatLong"), exports);
37
39
  __exportStar(require("./Action"), exports);
40
+ __exportStar(require("./InboundMessageMessageType"), exports);
41
+ __exportStar(require("./InboundMessageMetadata"), exports);
42
+ __exportStar(require("./InboundMessage"), exports);
43
+ __exportStar(require("./SenderMetadata"), exports);
44
+ __exportStar(require("./MessageMetadata"), exports);
45
+ __exportStar(require("./InboundTextMessage"), exports);
46
+ __exportStar(require("./MediaPayload"), exports);
47
+ __exportStar(require("./InboundMediaMessage"), exports);
48
+ __exportStar(require("./InboundActionMessage"), exports);
49
+ __exportStar(require("./InboundLocationMessageCoordinates"), exports);
50
+ __exportStar(require("./InboundLocationMessage"), exports);
package/dist/version.d.ts CHANGED
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "1.0.14";
1
+ export declare const SDK_VERSION = "1.0.16";
package/dist/version.js CHANGED
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "1.0.14";
4
+ exports.SDK_VERSION = "1.0.16";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "rcs-js",
3
- "version": "1.0.14",
3
+ "version": "1.0.16",
4
4
  "private": false,
5
5
  "repository": "https://github.com/pinnacle-dev/rcs-js",
6
6
  "main": "./index.js",
@@ -17,7 +17,8 @@
17
17
  "formdata-node": "^6.0.3",
18
18
  "node-fetch": "2.7.0",
19
19
  "qs": "6.11.2",
20
- "readable-stream": "^4.5.2"
20
+ "readable-stream": "^4.5.2",
21
+ "mime-types": "2.1.35"
21
22
  },
22
23
  "devDependencies": {
23
24
  "@types/url-join": "4.0.1",
@@ -33,7 +34,8 @@
33
34
  "jest-environment-jsdom": "29.7.0",
34
35
  "@types/node": "17.0.33",
35
36
  "prettier": "2.7.1",
36
- "typescript": "4.6.4"
37
+ "typescript": "4.6.4",
38
+ "@types/mime-types": "2.1.4"
37
39
  },
38
40
  "browser": {
39
41
  "fs": false,
package/reference.md CHANGED
@@ -161,6 +161,7 @@ Register a company for RCS with the Pinnacle platform
161
161
  await client.company.register({
162
162
  company: {
163
163
  name: "name",
164
+ category: "Entertainment",
164
165
  address: "address",
165
166
  ein: "ein",
166
167
  description: "description",
@@ -178,6 +179,15 @@ await client.company.register({
178
179
  privacyPolicyUrl: "privacyPolicyUrl",
179
180
  tosUrl: "tosUrl",
180
181
  },
182
+ messaging: {
183
+ optIn: "By opting in, you agree to receive messages from Pinnacle, including updates and promotions. Reply \u201CSTOP\u201D to unsubscribe. Standard message and data rates may apply.",
184
+ optOut: "Reply with keywords like STOP or UNSUBSCRIBE to opt-out. A confirmation message will be sent, and no further messages will be received unless you re-subscribe.",
185
+ optOutKeywords: ["STOP", "UNSUBSCRIBE"],
186
+ agentUseCase:
187
+ "Pinnacle\u2019s agent assists with product updates, promotions, order tracking, and support. It answers FAQs, provides order updates, and helps with opt-in/out processes. Escalates to live support when needed.",
188
+ expectedAgentResponses:
189
+ "General Inquiry: \u201CHow can I assist you today?\u201D\nOrder Status: \u201CProvide your order number.\u201D\nOpt-In: \u201CYou\u2019re now subscribed!\u201D\nOpt-Out: \u201CYou have unsubscribed.\u201D\nEscalation: \u201CConnecting to a live agent.\u201D \n",
190
+ },
181
191
  pointOfContact: {
182
192
  pocName: "pocName",
183
193
  pocTitle: "pocTitle",
@@ -486,3 +496,137 @@ await client.send.mms({
486
496
  </dd>
487
497
  </dl>
488
498
  </details>
499
+
500
+ ## Tools
501
+
502
+ <details><summary><code>client.tools.<a href="/src/api/resources/tools/client/Client.ts">shortenUrl</a>({ ...params }) -> Pinnacle.ToolsShortenUrlResponse</code></summary>
503
+ <dl>
504
+ <dd>
505
+
506
+ #### 📝 Description
507
+
508
+ <dl>
509
+ <dd>
510
+
511
+ <dl>
512
+ <dd>
513
+
514
+ Create a shortened URL with an optional expiration date (default and max expiration is 90 days). The shortened URL will redirect to the original URL and will have the following format https://urls.p1n.io/ABCD5678.
515
+
516
+ </dd>
517
+ </dl>
518
+ </dd>
519
+ </dl>
520
+
521
+ #### 🔌 Usage
522
+
523
+ <dl>
524
+ <dd>
525
+
526
+ <dl>
527
+ <dd>
528
+
529
+ ```typescript
530
+ await client.tools.shortenUrl({
531
+ url: "https://example.com",
532
+ });
533
+ ```
534
+
535
+ </dd>
536
+ </dl>
537
+ </dd>
538
+ </dl>
539
+
540
+ #### ⚙️ Parameters
541
+
542
+ <dl>
543
+ <dd>
544
+
545
+ <dl>
546
+ <dd>
547
+
548
+ **request:** `Pinnacle.ToolsShortenUrlRequest`
549
+
550
+ </dd>
551
+ </dl>
552
+
553
+ <dl>
554
+ <dd>
555
+
556
+ **requestOptions:** `Tools.RequestOptions`
557
+
558
+ </dd>
559
+ </dl>
560
+ </dd>
561
+ </dl>
562
+
563
+ </dd>
564
+ </dl>
565
+ </details>
566
+
567
+ <details><summary><code>client.tools.<a href="/src/api/resources/tools/client/Client.ts">uploadUrl</a>({ ...params }) -> Pinnacle.ToolsUploadUrlResponse</code></summary>
568
+ <dl>
569
+ <dd>
570
+
571
+ #### 📝 Description
572
+
573
+ <dl>
574
+ <dd>
575
+
576
+ <dl>
577
+ <dd>
578
+
579
+ Generate signed upload (expires in 2 hours) and download URLs for a file (expires in 1 hour).
580
+
581
+ </dd>
582
+ </dl>
583
+ </dd>
584
+ </dl>
585
+
586
+ #### 🔌 Usage
587
+
588
+ <dl>
589
+ <dd>
590
+
591
+ <dl>
592
+ <dd>
593
+
594
+ ```typescript
595
+ await client.tools.uploadUrl({
596
+ contentType: "image/png",
597
+ size: 1024,
598
+ name: "example.png",
599
+ });
600
+ ```
601
+
602
+ </dd>
603
+ </dl>
604
+ </dd>
605
+ </dl>
606
+
607
+ #### ⚙️ Parameters
608
+
609
+ <dl>
610
+ <dd>
611
+
612
+ <dl>
613
+ <dd>
614
+
615
+ **request:** `Pinnacle.ToolsUploadUrlRequest`
616
+
617
+ </dd>
618
+ </dl>
619
+
620
+ <dl>
621
+ <dd>
622
+
623
+ **requestOptions:** `Tools.RequestOptions`
624
+
625
+ </dd>
626
+ </dl>
627
+ </dd>
628
+ </dl>
629
+
630
+ </dd>
631
+ </dl>
632
+ </details>
@@ -6,6 +6,7 @@ import * as Pinnacle from "../../../../../api/index";
6
6
  import * as core from "../../../../../core";
7
7
  import { CompanyDetails } from "../../../../types/CompanyDetails";
8
8
  import { CompanyContact } from "../../../../types/CompanyContact";
9
+ import { Messaging } from "../../../../types/Messaging";
9
10
  import { PointOfContact } from "../../../../types/PointOfContact";
10
11
  import { Optionals } from "../../../../types/Optionals";
11
12
  export declare const CompanyRegisterRequest: core.serialization.Schema<serializers.CompanyRegisterRequest.Raw, Pinnacle.CompanyRegisterRequest>;
@@ -13,6 +14,7 @@ export declare namespace CompanyRegisterRequest {
13
14
  interface Raw {
14
15
  company: CompanyDetails.Raw;
15
16
  companyContact: CompanyContact.Raw;
17
+ messaging: Messaging.Raw;
16
18
  pointOfContact: PointOfContact.Raw;
17
19
  optionals?: Optionals.Raw | null;
18
20
  }
@@ -30,11 +30,13 @@ exports.CompanyRegisterRequest = void 0;
30
30
  const core = __importStar(require("../../../../../core"));
31
31
  const CompanyDetails_1 = require("../../../../types/CompanyDetails");
32
32
  const CompanyContact_1 = require("../../../../types/CompanyContact");
33
+ const Messaging_1 = require("../../../../types/Messaging");
33
34
  const PointOfContact_1 = require("../../../../types/PointOfContact");
34
35
  const Optionals_1 = require("../../../../types/Optionals");
35
36
  exports.CompanyRegisterRequest = core.serialization.object({
36
37
  company: CompanyDetails_1.CompanyDetails,
37
38
  companyContact: CompanyContact_1.CompanyContact,
39
+ messaging: Messaging_1.Messaging,
38
40
  pointOfContact: PointOfContact_1.PointOfContact,
39
41
  optionals: Optionals_1.Optionals.optional(),
40
42
  });
@@ -6,6 +6,7 @@ import * as Pinnacle from "../../../../../api/index";
6
6
  import * as core from "../../../../../core";
7
7
  import { Company } from "../../../../types/Company";
8
8
  import { CompanyContact } from "../../../../types/CompanyContact";
9
+ import { Messaging } from "../../../../types/Messaging";
9
10
  import { PointOfContact } from "../../../../types/PointOfContact";
10
11
  import { Optionals } from "../../../../types/Optionals";
11
12
  export declare const CompanyUpdateRequest: core.serialization.Schema<serializers.CompanyUpdateRequest.Raw, Pinnacle.CompanyUpdateRequest>;
@@ -14,6 +15,7 @@ export declare namespace CompanyUpdateRequest {
14
15
  companyId: string;
15
16
  company?: Company.Raw | null;
16
17
  companyContact?: CompanyContact.Raw | null;
18
+ messaging?: Messaging.Raw | null;
17
19
  pointOfContact?: PointOfContact.Raw | null;
18
20
  optionals?: Optionals.Raw | null;
19
21
  }
@@ -30,12 +30,14 @@ exports.CompanyUpdateRequest = void 0;
30
30
  const core = __importStar(require("../../../../../core"));
31
31
  const Company_1 = require("../../../../types/Company");
32
32
  const CompanyContact_1 = require("../../../../types/CompanyContact");
33
+ const Messaging_1 = require("../../../../types/Messaging");
33
34
  const PointOfContact_1 = require("../../../../types/PointOfContact");
34
35
  const Optionals_1 = require("../../../../types/Optionals");
35
36
  exports.CompanyUpdateRequest = core.serialization.object({
36
37
  companyId: core.serialization.string(),
37
38
  company: Company_1.Company.optional(),
38
39
  companyContact: CompanyContact_1.CompanyContact.optional(),
40
+ messaging: Messaging_1.Messaging.optional(),
39
41
  pointOfContact: PointOfContact_1.PointOfContact.optional(),
40
42
  optionals: Optionals_1.Optionals.optional(),
41
43
  });
@@ -2,5 +2,8 @@ export * as company from "./company";
2
2
  export * from "./company/types";
3
3
  export * as send from "./send";
4
4
  export * from "./send/types";
5
+ export * as tools from "./tools";
6
+ export * from "./tools/types";
5
7
  export * from "./company/client/requests";
6
8
  export * from "./send/client/requests";
9
+ export * from "./tools/client/requests";
@@ -26,10 +26,13 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
26
26
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
27
27
  };
28
28
  Object.defineProperty(exports, "__esModule", { value: true });
29
- exports.send = exports.company = void 0;
29
+ exports.tools = exports.send = exports.company = void 0;
30
30
  exports.company = __importStar(require("./company"));
31
31
  __exportStar(require("./company/types"), exports);
32
32
  exports.send = __importStar(require("./send"));
33
33
  __exportStar(require("./send/types"), exports);
34
+ exports.tools = __importStar(require("./tools"));
35
+ __exportStar(require("./tools/types"), exports);
34
36
  __exportStar(require("./company/client/requests"), exports);
35
37
  __exportStar(require("./send/client/requests"), exports);
38
+ __exportStar(require("./tools/client/requests"), exports);
@@ -0,0 +1 @@
1
+ export * from "./requests";
@@ -0,0 +1,17 @@
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("./requests"), exports);
@@ -0,0 +1,13 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as serializers from "../../../../index";
5
+ import * as Pinnacle from "../../../../../api/index";
6
+ import * as core from "../../../../../core";
7
+ export declare const ToolsShortenUrlRequest: core.serialization.Schema<serializers.ToolsShortenUrlRequest.Raw, Pinnacle.ToolsShortenUrlRequest>;
8
+ export declare namespace ToolsShortenUrlRequest {
9
+ interface Raw {
10
+ url: string;
11
+ expiresAt?: string | null;
12
+ }
13
+ }
@@ -0,0 +1,34 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
6
+ if (k2 === undefined) k2 = k;
7
+ var desc = Object.getOwnPropertyDescriptor(m, k);
8
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
9
+ desc = { enumerable: true, get: function() { return m[k]; } };
10
+ }
11
+ Object.defineProperty(o, k2, desc);
12
+ }) : (function(o, m, k, k2) {
13
+ if (k2 === undefined) k2 = k;
14
+ o[k2] = m[k];
15
+ }));
16
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
17
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
18
+ }) : function(o, v) {
19
+ o["default"] = v;
20
+ });
21
+ var __importStar = (this && this.__importStar) || function (mod) {
22
+ if (mod && mod.__esModule) return mod;
23
+ var result = {};
24
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
25
+ __setModuleDefault(result, mod);
26
+ return result;
27
+ };
28
+ Object.defineProperty(exports, "__esModule", { value: true });
29
+ exports.ToolsShortenUrlRequest = void 0;
30
+ const core = __importStar(require("../../../../../core"));
31
+ exports.ToolsShortenUrlRequest = core.serialization.object({
32
+ url: core.serialization.string(),
33
+ expiresAt: core.serialization.date().optional(),
34
+ });
@@ -0,0 +1,14 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as serializers from "../../../../index";
5
+ import * as Pinnacle from "../../../../../api/index";
6
+ import * as core from "../../../../../core";
7
+ export declare const ToolsUploadUrlRequest: core.serialization.Schema<serializers.ToolsUploadUrlRequest.Raw, Pinnacle.ToolsUploadUrlRequest>;
8
+ export declare namespace ToolsUploadUrlRequest {
9
+ interface Raw {
10
+ contentType: string;
11
+ size: number;
12
+ name: string;
13
+ }
14
+ }
@@ -0,0 +1,35 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
6
+ if (k2 === undefined) k2 = k;
7
+ var desc = Object.getOwnPropertyDescriptor(m, k);
8
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
9
+ desc = { enumerable: true, get: function() { return m[k]; } };
10
+ }
11
+ Object.defineProperty(o, k2, desc);
12
+ }) : (function(o, m, k, k2) {
13
+ if (k2 === undefined) k2 = k;
14
+ o[k2] = m[k];
15
+ }));
16
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
17
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
18
+ }) : function(o, v) {
19
+ o["default"] = v;
20
+ });
21
+ var __importStar = (this && this.__importStar) || function (mod) {
22
+ if (mod && mod.__esModule) return mod;
23
+ var result = {};
24
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
25
+ __setModuleDefault(result, mod);
26
+ return result;
27
+ };
28
+ Object.defineProperty(exports, "__esModule", { value: true });
29
+ exports.ToolsUploadUrlRequest = void 0;
30
+ const core = __importStar(require("../../../../../core"));
31
+ exports.ToolsUploadUrlRequest = core.serialization.object({
32
+ contentType: core.serialization.string(),
33
+ size: core.serialization.number(),
34
+ name: core.serialization.string(),
35
+ });
@@ -0,0 +1,2 @@
1
+ export { ToolsShortenUrlRequest } from "./ToolsShortenUrlRequest";
2
+ export { ToolsUploadUrlRequest } from "./ToolsUploadUrlRequest";
@@ -0,0 +1,7 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ToolsUploadUrlRequest = exports.ToolsShortenUrlRequest = void 0;
4
+ var ToolsShortenUrlRequest_1 = require("./ToolsShortenUrlRequest");
5
+ Object.defineProperty(exports, "ToolsShortenUrlRequest", { enumerable: true, get: function () { return ToolsShortenUrlRequest_1.ToolsShortenUrlRequest; } });
6
+ var ToolsUploadUrlRequest_1 = require("./ToolsUploadUrlRequest");
7
+ Object.defineProperty(exports, "ToolsUploadUrlRequest", { enumerable: true, get: function () { return ToolsUploadUrlRequest_1.ToolsUploadUrlRequest; } });
@@ -0,0 +1,2 @@
1
+ export * from "./types";
2
+ export * from "./client";
@@ -0,0 +1,18 @@
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("./types"), exports);
18
+ __exportStar(require("./client"), exports);
@@ -0,0 +1,13 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as serializers from "../../../index";
5
+ import * as Pinnacle from "../../../../api/index";
6
+ import * as core from "../../../../core";
7
+ export declare const ToolsShortenUrlResponse: core.serialization.ObjectSchema<serializers.ToolsShortenUrlResponse.Raw, Pinnacle.ToolsShortenUrlResponse>;
8
+ export declare namespace ToolsShortenUrlResponse {
9
+ interface Raw {
10
+ shortenedUrl?: string | null;
11
+ expiresAt?: string | null;
12
+ }
13
+ }
@@ -0,0 +1,34 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
6
+ if (k2 === undefined) k2 = k;
7
+ var desc = Object.getOwnPropertyDescriptor(m, k);
8
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
9
+ desc = { enumerable: true, get: function() { return m[k]; } };
10
+ }
11
+ Object.defineProperty(o, k2, desc);
12
+ }) : (function(o, m, k, k2) {
13
+ if (k2 === undefined) k2 = k;
14
+ o[k2] = m[k];
15
+ }));
16
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
17
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
18
+ }) : function(o, v) {
19
+ o["default"] = v;
20
+ });
21
+ var __importStar = (this && this.__importStar) || function (mod) {
22
+ if (mod && mod.__esModule) return mod;
23
+ var result = {};
24
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
25
+ __setModuleDefault(result, mod);
26
+ return result;
27
+ };
28
+ Object.defineProperty(exports, "__esModule", { value: true });
29
+ exports.ToolsShortenUrlResponse = void 0;
30
+ const core = __importStar(require("../../../../core"));
31
+ exports.ToolsShortenUrlResponse = core.serialization.object({
32
+ shortenedUrl: core.serialization.string().optional(),
33
+ expiresAt: core.serialization.date().optional(),
34
+ });
@@ -0,0 +1,13 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as serializers from "../../../index";
5
+ import * as Pinnacle from "../../../../api/index";
6
+ import * as core from "../../../../core";
7
+ export declare const ToolsUploadUrlResponse: core.serialization.ObjectSchema<serializers.ToolsUploadUrlResponse.Raw, Pinnacle.ToolsUploadUrlResponse>;
8
+ export declare namespace ToolsUploadUrlResponse {
9
+ interface Raw {
10
+ upload?: string | null;
11
+ download?: string | null;
12
+ }
13
+ }
@@ -0,0 +1,34 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
6
+ if (k2 === undefined) k2 = k;
7
+ var desc = Object.getOwnPropertyDescriptor(m, k);
8
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
9
+ desc = { enumerable: true, get: function() { return m[k]; } };
10
+ }
11
+ Object.defineProperty(o, k2, desc);
12
+ }) : (function(o, m, k, k2) {
13
+ if (k2 === undefined) k2 = k;
14
+ o[k2] = m[k];
15
+ }));
16
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
17
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
18
+ }) : function(o, v) {
19
+ o["default"] = v;
20
+ });
21
+ var __importStar = (this && this.__importStar) || function (mod) {
22
+ if (mod && mod.__esModule) return mod;
23
+ var result = {};
24
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
25
+ __setModuleDefault(result, mod);
26
+ return result;
27
+ };
28
+ Object.defineProperty(exports, "__esModule", { value: true });
29
+ exports.ToolsUploadUrlResponse = void 0;
30
+ const core = __importStar(require("../../../../core"));
31
+ exports.ToolsUploadUrlResponse = core.serialization.object({
32
+ upload: core.serialization.string().optional(),
33
+ download: core.serialization.string().optional(),
34
+ });
@@ -0,0 +1,2 @@
1
+ export * from "./ToolsShortenUrlResponse";
2
+ export * from "./ToolsUploadUrlResponse";