rcs-js 1.0.13 → 1.0.15

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 (161) hide show
  1. package/Client.js +1 -1
  2. package/README.md +10 -0
  3. package/api/resources/company/client/Client.d.ts +8 -0
  4. package/api/resources/company/client/Client.js +11 -3
  5. package/api/resources/company/client/requests/CompanyRegisterRequest.d.ts +9 -0
  6. package/api/resources/company/client/requests/CompanyUpdateRequest.d.ts +1 -0
  7. package/api/resources/send/client/Client.js +3 -3
  8. package/api/types/Action.d.ts +1 -1
  9. package/api/types/ActionType.d.ts +3 -3
  10. package/api/types/ActionType.js +1 -1
  11. package/api/types/Company.d.ts +12 -0
  12. package/api/types/CompanyCategory.d.ts +20 -0
  13. package/api/types/CompanyCategory.js +22 -0
  14. package/api/types/CompanyDetails.d.ts +3 -0
  15. package/api/types/InboundActionMessage.d.ts +13 -0
  16. package/api/types/InboundActionMessage.js +5 -0
  17. package/api/types/InboundLocationMessage.d.ts +11 -0
  18. package/api/types/InboundLocationMessage.js +5 -0
  19. package/api/types/InboundLocationMessageCoordinates.d.ts +7 -0
  20. package/api/types/InboundLocationMessageCoordinates.js +5 -0
  21. package/api/types/InboundMediaMessage.d.ts +12 -0
  22. package/api/types/InboundMediaMessage.js +5 -0
  23. package/api/types/InboundMessage.d.ts +10 -0
  24. package/api/types/InboundMessage.js +5 -0
  25. package/api/types/InboundMessageMessageType.d.ts +10 -0
  26. package/api/types/InboundMessageMessageType.js +12 -0
  27. package/api/types/InboundMessageMetadata.d.ts +8 -0
  28. package/api/types/InboundMessageMetadata.js +5 -0
  29. package/api/types/InboundTextMessage.d.ts +11 -0
  30. package/api/types/InboundTextMessage.js +5 -0
  31. package/api/types/MediaPayload.d.ts +7 -0
  32. package/api/types/MediaPayload.js +5 -0
  33. package/api/types/MessageMetadata.d.ts +6 -0
  34. package/api/types/MessageMetadata.js +5 -0
  35. package/api/types/Messaging.d.ts +15 -0
  36. package/api/types/Messaging.js +5 -0
  37. package/api/types/SenderMetadata.d.ts +8 -0
  38. package/api/types/SenderMetadata.js +5 -0
  39. package/api/types/index.d.ts +13 -0
  40. package/api/types/index.js +13 -0
  41. package/dist/Client.js +1 -1
  42. package/dist/api/resources/company/client/Client.d.ts +8 -0
  43. package/dist/api/resources/company/client/Client.js +11 -3
  44. package/dist/api/resources/company/client/requests/CompanyRegisterRequest.d.ts +9 -0
  45. package/dist/api/resources/company/client/requests/CompanyUpdateRequest.d.ts +1 -0
  46. package/dist/api/resources/send/client/Client.js +3 -3
  47. package/dist/api/types/Action.d.ts +1 -1
  48. package/dist/api/types/ActionType.d.ts +3 -3
  49. package/dist/api/types/ActionType.js +1 -1
  50. package/dist/api/types/Company.d.ts +12 -0
  51. package/dist/api/types/CompanyCategory.d.ts +20 -0
  52. package/dist/api/types/CompanyCategory.js +22 -0
  53. package/dist/api/types/CompanyDetails.d.ts +3 -0
  54. package/dist/api/types/InboundActionMessage.d.ts +13 -0
  55. package/dist/api/types/InboundActionMessage.js +5 -0
  56. package/dist/api/types/InboundLocationMessage.d.ts +11 -0
  57. package/dist/api/types/InboundLocationMessage.js +5 -0
  58. package/dist/api/types/InboundLocationMessageCoordinates.d.ts +7 -0
  59. package/dist/api/types/InboundLocationMessageCoordinates.js +5 -0
  60. package/dist/api/types/InboundMediaMessage.d.ts +12 -0
  61. package/dist/api/types/InboundMediaMessage.js +5 -0
  62. package/dist/api/types/InboundMessage.d.ts +10 -0
  63. package/dist/api/types/InboundMessage.js +5 -0
  64. package/dist/api/types/InboundMessageMessageType.d.ts +10 -0
  65. package/dist/api/types/InboundMessageMessageType.js +12 -0
  66. package/dist/api/types/InboundMessageMetadata.d.ts +8 -0
  67. package/dist/api/types/InboundMessageMetadata.js +5 -0
  68. package/dist/api/types/InboundTextMessage.d.ts +11 -0
  69. package/dist/api/types/InboundTextMessage.js +5 -0
  70. package/dist/api/types/MediaPayload.d.ts +7 -0
  71. package/dist/api/types/MediaPayload.js +5 -0
  72. package/dist/api/types/MessageMetadata.d.ts +6 -0
  73. package/dist/api/types/MessageMetadata.js +5 -0
  74. package/dist/api/types/Messaging.d.ts +15 -0
  75. package/dist/api/types/Messaging.js +5 -0
  76. package/dist/api/types/SenderMetadata.d.ts +8 -0
  77. package/dist/api/types/SenderMetadata.js +5 -0
  78. package/dist/api/types/index.d.ts +13 -0
  79. package/dist/api/types/index.js +13 -0
  80. package/dist/serialization/resources/company/client/requests/CompanyRegisterRequest.d.ts +2 -0
  81. package/dist/serialization/resources/company/client/requests/CompanyRegisterRequest.js +2 -0
  82. package/dist/serialization/resources/company/client/requests/CompanyUpdateRequest.d.ts +2 -0
  83. package/dist/serialization/resources/company/client/requests/CompanyUpdateRequest.js +2 -0
  84. package/dist/serialization/types/ActionType.d.ts +1 -1
  85. package/dist/serialization/types/ActionType.js +1 -1
  86. package/dist/serialization/types/Company.d.ts +7 -0
  87. package/dist/serialization/types/Company.js +7 -0
  88. package/dist/serialization/types/CompanyCategory.d.ts +10 -0
  89. package/dist/serialization/types/CompanyCategory.js +46 -0
  90. package/dist/serialization/types/CompanyDetails.d.ts +2 -0
  91. package/dist/serialization/types/CompanyDetails.js +2 -0
  92. package/dist/serialization/types/InboundActionMessage.d.ts +19 -0
  93. package/dist/serialization/types/InboundActionMessage.js +40 -0
  94. package/dist/serialization/types/InboundLocationMessage.d.ts +18 -0
  95. package/dist/serialization/types/InboundLocationMessage.js +39 -0
  96. package/dist/serialization/types/InboundLocationMessageCoordinates.d.ts +13 -0
  97. package/dist/serialization/types/InboundLocationMessageCoordinates.js +34 -0
  98. package/dist/serialization/types/InboundMediaMessage.d.ts +19 -0
  99. package/dist/serialization/types/InboundMediaMessage.js +40 -0
  100. package/dist/serialization/types/InboundMessage.d.ts +17 -0
  101. package/dist/serialization/types/InboundMessage.js +38 -0
  102. package/dist/serialization/types/InboundMessageMessageType.d.ts +10 -0
  103. package/dist/serialization/types/InboundMessageMessageType.js +31 -0
  104. package/dist/serialization/types/InboundMessageMetadata.d.ts +15 -0
  105. package/dist/serialization/types/InboundMessageMetadata.js +36 -0
  106. package/dist/serialization/types/InboundTextMessage.d.ts +17 -0
  107. package/dist/serialization/types/InboundTextMessage.js +38 -0
  108. package/dist/serialization/types/MediaPayload.d.ts +13 -0
  109. package/dist/serialization/types/MediaPayload.js +34 -0
  110. package/dist/serialization/types/MessageMetadata.d.ts +12 -0
  111. package/dist/serialization/types/MessageMetadata.js +33 -0
  112. package/dist/serialization/types/Messaging.d.ts +16 -0
  113. package/dist/serialization/types/Messaging.js +37 -0
  114. package/dist/serialization/types/SenderMetadata.d.ts +14 -0
  115. package/dist/serialization/types/SenderMetadata.js +35 -0
  116. package/dist/serialization/types/index.d.ts +13 -0
  117. package/dist/serialization/types/index.js +13 -0
  118. package/dist/version.d.ts +1 -1
  119. package/dist/version.js +1 -1
  120. package/package.json +1 -1
  121. package/reference.md +10 -0
  122. package/serialization/resources/company/client/requests/CompanyRegisterRequest.d.ts +2 -0
  123. package/serialization/resources/company/client/requests/CompanyRegisterRequest.js +2 -0
  124. package/serialization/resources/company/client/requests/CompanyUpdateRequest.d.ts +2 -0
  125. package/serialization/resources/company/client/requests/CompanyUpdateRequest.js +2 -0
  126. package/serialization/types/ActionType.d.ts +1 -1
  127. package/serialization/types/ActionType.js +1 -1
  128. package/serialization/types/Company.d.ts +7 -0
  129. package/serialization/types/Company.js +7 -0
  130. package/serialization/types/CompanyCategory.d.ts +10 -0
  131. package/serialization/types/CompanyCategory.js +46 -0
  132. package/serialization/types/CompanyDetails.d.ts +2 -0
  133. package/serialization/types/CompanyDetails.js +2 -0
  134. package/serialization/types/InboundActionMessage.d.ts +19 -0
  135. package/serialization/types/InboundActionMessage.js +40 -0
  136. package/serialization/types/InboundLocationMessage.d.ts +18 -0
  137. package/serialization/types/InboundLocationMessage.js +39 -0
  138. package/serialization/types/InboundLocationMessageCoordinates.d.ts +13 -0
  139. package/serialization/types/InboundLocationMessageCoordinates.js +34 -0
  140. package/serialization/types/InboundMediaMessage.d.ts +19 -0
  141. package/serialization/types/InboundMediaMessage.js +40 -0
  142. package/serialization/types/InboundMessage.d.ts +17 -0
  143. package/serialization/types/InboundMessage.js +38 -0
  144. package/serialization/types/InboundMessageMessageType.d.ts +10 -0
  145. package/serialization/types/InboundMessageMessageType.js +31 -0
  146. package/serialization/types/InboundMessageMetadata.d.ts +15 -0
  147. package/serialization/types/InboundMessageMetadata.js +36 -0
  148. package/serialization/types/InboundTextMessage.d.ts +17 -0
  149. package/serialization/types/InboundTextMessage.js +38 -0
  150. package/serialization/types/MediaPayload.d.ts +13 -0
  151. package/serialization/types/MediaPayload.js +34 -0
  152. package/serialization/types/MessageMetadata.d.ts +12 -0
  153. package/serialization/types/MessageMetadata.js +33 -0
  154. package/serialization/types/Messaging.d.ts +16 -0
  155. package/serialization/types/Messaging.js +37 -0
  156. package/serialization/types/SenderMetadata.d.ts +14 -0
  157. package/serialization/types/SenderMetadata.js +35 -0
  158. package/serialization/types/index.d.ts +13 -0
  159. package/serialization/types/index.js +13 -0
  160. package/version.d.ts +1 -1
  161. package/version.js +1 -1
package/Client.js CHANGED
@@ -75,7 +75,7 @@ class PinnacleClient {
75
75
  const _response = yield core.fetcher({
76
76
  url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.PinnacleEnvironment.Default, "rcs_functionality"),
77
77
  method: "GET",
78
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.13", "User-Agent": "rcs-js/1.0.13", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
78
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.15", "User-Agent": "rcs-js/1.0.15", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
79
79
  contentType: "application/json",
80
80
  queryParameters: _queryParams,
81
81
  requestType: "json",
package/README.md CHANGED
@@ -22,6 +22,7 @@ const client = new PinnacleClient({ apiKey: "YOUR_API_KEY" });
22
22
  await client.company.register({
23
23
  company: {
24
24
  name: "name",
25
+ category: "Entertainment",
25
26
  address: "address",
26
27
  ein: "ein",
27
28
  description: "description",
@@ -39,6 +40,15 @@ await client.company.register({
39
40
  privacyPolicyUrl: "privacyPolicyUrl",
40
41
  tosUrl: "tosUrl",
41
42
  },
43
+ messaging: {
44
+ 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.",
45
+ 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.",
46
+ optOutKeywords: ["STOP", "UNSUBSCRIBE"],
47
+ agentUseCase:
48
+ "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.",
49
+ expectedAgentResponses:
50
+ "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",
51
+ },
42
52
  pointOfContact: {
43
53
  pocName: "pocName",
44
54
  pocTitle: "pocTitle",
@@ -50,6 +50,7 @@ export declare class Company {
50
50
  * await client.company.register({
51
51
  * company: {
52
52
  * name: "name",
53
+ * category: "Entertainment",
53
54
  * address: "address",
54
55
  * ein: "ein",
55
56
  * description: "description",
@@ -67,6 +68,13 @@ export declare class Company {
67
68
  * privacyPolicyUrl: "privacyPolicyUrl",
68
69
  * tosUrl: "tosUrl"
69
70
  * },
71
+ * messaging: {
72
+ * 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.",
73
+ * 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.",
74
+ * optOutKeywords: ["STOP", "UNSUBSCRIBE"],
75
+ * agentUseCase: "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.",
76
+ * expectedAgentResponses: "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"
77
+ * },
70
78
  * pointOfContact: {
71
79
  * pocName: "pocName",
72
80
  * pocTitle: "pocTitle",
@@ -76,7 +76,7 @@ class Company {
76
76
  const _response = yield core.fetcher({
77
77
  url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.PinnacleEnvironment.Default, "company"),
78
78
  method: "GET",
79
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.13", "User-Agent": "rcs-js/1.0.13", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
79
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.15", "User-Agent": "rcs-js/1.0.15", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
80
80
  contentType: "application/json",
81
81
  queryParameters: _queryParams,
82
82
  requestType: "json",
@@ -137,6 +137,7 @@ class Company {
137
137
  * await client.company.register({
138
138
  * company: {
139
139
  * name: "name",
140
+ * category: "Entertainment",
140
141
  * address: "address",
141
142
  * ein: "ein",
142
143
  * description: "description",
@@ -154,6 +155,13 @@ class Company {
154
155
  * privacyPolicyUrl: "privacyPolicyUrl",
155
156
  * tosUrl: "tosUrl"
156
157
  * },
158
+ * messaging: {
159
+ * 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.",
160
+ * 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.",
161
+ * optOutKeywords: ["STOP", "UNSUBSCRIBE"],
162
+ * agentUseCase: "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.",
163
+ * expectedAgentResponses: "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"
164
+ * },
157
165
  * pointOfContact: {
158
166
  * pocName: "pocName",
159
167
  * pocTitle: "pocTitle",
@@ -167,7 +175,7 @@ class Company {
167
175
  const _response = yield core.fetcher({
168
176
  url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.PinnacleEnvironment.Default, "company/register"),
169
177
  method: "POST",
170
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.13", "User-Agent": "rcs-js/1.0.13", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
178
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.15", "User-Agent": "rcs-js/1.0.15", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
171
179
  contentType: "application/json",
172
180
  requestType: "json",
173
181
  body: serializers.CompanyRegisterRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -236,7 +244,7 @@ class Company {
236
244
  const _response = yield core.fetcher({
237
245
  url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.PinnacleEnvironment.Default, "company/update"),
238
246
  method: "POST",
239
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.13", "User-Agent": "rcs-js/1.0.13", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
247
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.15", "User-Agent": "rcs-js/1.0.15", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
240
248
  contentType: "application/json",
241
249
  requestType: "json",
242
250
  body: serializers.CompanyUpdateRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -7,6 +7,7 @@ import * as Pinnacle from "../../../../index";
7
7
  * {
8
8
  * company: {
9
9
  * name: "name",
10
+ * category: "Entertainment",
10
11
  * address: "address",
11
12
  * ein: "ein",
12
13
  * description: "description",
@@ -24,6 +25,13 @@ import * as Pinnacle from "../../../../index";
24
25
  * privacyPolicyUrl: "privacyPolicyUrl",
25
26
  * tosUrl: "tosUrl"
26
27
  * },
28
+ * messaging: {
29
+ * 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.",
30
+ * 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.",
31
+ * optOutKeywords: ["STOP", "UNSUBSCRIBE"],
32
+ * agentUseCase: "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.",
33
+ * expectedAgentResponses: "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"
34
+ * },
27
35
  * pointOfContact: {
28
36
  * pocName: "pocName",
29
37
  * pocTitle: "pocTitle",
@@ -34,6 +42,7 @@ import * as Pinnacle from "../../../../index";
34
42
  export interface CompanyRegisterRequest {
35
43
  company: Pinnacle.CompanyDetails;
36
44
  companyContact: Pinnacle.CompanyContact;
45
+ messaging: Pinnacle.Messaging;
37
46
  pointOfContact: Pinnacle.PointOfContact;
38
47
  optionals?: Pinnacle.Optionals;
39
48
  }
@@ -12,6 +12,7 @@ export interface CompanyUpdateRequest {
12
12
  companyId: string;
13
13
  company?: Pinnacle.Company;
14
14
  companyContact?: Pinnacle.CompanyContact;
15
+ messaging?: Pinnacle.Messaging;
15
16
  pointOfContact?: Pinnacle.PointOfContact;
16
17
  optionals?: Pinnacle.Optionals;
17
18
  }
@@ -75,7 +75,7 @@ class Send {
75
75
  const _response = yield core.fetcher({
76
76
  url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.PinnacleEnvironment.Default, "send/rcs"),
77
77
  method: "POST",
78
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.13", "User-Agent": "rcs-js/1.0.13", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
78
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.15", "User-Agent": "rcs-js/1.0.15", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
79
79
  contentType: "application/json",
80
80
  requestType: "json",
81
81
  body: serializers.Rcs.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -150,7 +150,7 @@ class Send {
150
150
  const _response = yield core.fetcher({
151
151
  url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.PinnacleEnvironment.Default, "send/sms"),
152
152
  method: "POST",
153
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.13", "User-Agent": "rcs-js/1.0.13", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
153
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.15", "User-Agent": "rcs-js/1.0.15", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
154
154
  contentType: "application/json",
155
155
  requestType: "json",
156
156
  body: serializers.SendSmsRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -225,7 +225,7 @@ class Send {
225
225
  const _response = yield core.fetcher({
226
226
  url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.PinnacleEnvironment.Default, "send/mms"),
227
227
  method: "POST",
228
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.13", "User-Agent": "rcs-js/1.0.13", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
228
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.15", "User-Agent": "rcs-js/1.0.15", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
229
229
  contentType: "application/json",
230
230
  requestType: "json",
231
231
  body: serializers.SendMmsRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -5,7 +5,7 @@ import * as Pinnacle from "../index";
5
5
  export interface Action {
6
6
  /** Title of the action (must be less than 25 characters). */
7
7
  title?: string;
8
- /** Type of action for the button. 'openUrl' opens a URL, 'call' dials a phone number, 'trigger' sends the predefined payload to the webhook when pressed, 'requestLocation' requests the user's location, 'scheduleEvent' creates a calendar event, 'sendLocation' sends a location. */
8
+ /** Type of action for the button. 'openUrl' opens a URL, 'call' dials a phone number, 'trigger' sends the predefined payload to the webhook when pressed, 'requestUserLocation' requests the user's location, 'scheduleEvent' creates a calendar event, 'sendLocation' sends a location. */
9
9
  type?: Pinnacle.ActionType;
10
10
  /** Optional payload associated with the action. This payload encodes the respective fields for the action type and is required. For 'openUrl', the payload is the URL to open. For 'call', the payload is the phone number to dial. For 'trigger', the payload is the predefined payload to send to the webhook. */
11
11
  payload?: string;
@@ -2,14 +2,14 @@
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
4
  /**
5
- * Type of action for the button. 'openUrl' opens a URL, 'call' dials a phone number, 'trigger' sends the predefined payload to the webhook when pressed, 'requestLocation' requests the user's location, 'scheduleEvent' creates a calendar event, 'sendLocation' sends a location.
5
+ * Type of action for the button. 'openUrl' opens a URL, 'call' dials a phone number, 'trigger' sends the predefined payload to the webhook when pressed, 'requestUserLocation' requests the user's location, 'scheduleEvent' creates a calendar event, 'sendLocation' sends a location.
6
6
  */
7
- export declare type ActionType = "openUrl" | "call" | "trigger" | "requestLocation" | "scheduleEvent" | "sendLocation";
7
+ export declare type ActionType = "openUrl" | "call" | "trigger" | "requestUserLocation" | "scheduleEvent" | "sendLocation";
8
8
  export declare const ActionType: {
9
9
  readonly OpenUrl: "openUrl";
10
10
  readonly Call: "call";
11
11
  readonly Trigger: "trigger";
12
- readonly RequestLocation: "requestLocation";
12
+ readonly RequestUserLocation: "requestUserLocation";
13
13
  readonly ScheduleEvent: "scheduleEvent";
14
14
  readonly SendLocation: "sendLocation";
15
15
  };
@@ -8,7 +8,7 @@ exports.ActionType = {
8
8
  OpenUrl: "openUrl",
9
9
  Call: "call",
10
10
  Trigger: "trigger",
11
- RequestLocation: "requestLocation",
11
+ RequestUserLocation: "requestUserLocation",
12
12
  ScheduleEvent: "scheduleEvent",
13
13
  SendLocation: "sendLocation",
14
14
  };
@@ -9,6 +9,8 @@ export interface Company {
9
9
  createdAt?: Date;
10
10
  /** The name of the company */
11
11
  name?: string;
12
+ /** The category of the company */
13
+ category?: Pinnacle.CompanyCategory;
12
14
  /** The address of the company */
13
15
  address?: string;
14
16
  /** The Employer Identification Number (EIN) of the company */
@@ -43,6 +45,16 @@ export interface Company {
43
45
  pocTitle?: string;
44
46
  /** The email address of the point of contact */
45
47
  pocEmail?: string;
48
+ /** Explain how users will opt in to receive messages. */
49
+ optIn?: string;
50
+ /** Explain how users will opt out of receiving messages. */
51
+ optOut?: string;
52
+ /** Please provide the unique keywords to opt out. Each keyword should not contain spaces. */
53
+ optOutKeywords?: string[];
54
+ /** Please define what your agent will do. */
55
+ agentUseCase?: string;
56
+ /** Please provide some example messages that your agent will send. */
57
+ expectedAgentResponses?: string;
46
58
  /** A list of test phone numbers */
47
59
  testNumbers?: string[];
48
60
  /** The approval status of the company */
@@ -0,0 +1,20 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export declare type CompanyCategory = "Entertainment" | "Finance" | "Food & Beverage" | "Games" | "Health" | "Misc" | "News" | "Other" | "Productivity" | "Shopping & Retail" | "Social" | "Sports" | "Travel" | "Utilities";
5
+ export declare const CompanyCategory: {
6
+ readonly Entertainment: "Entertainment";
7
+ readonly Finance: "Finance";
8
+ readonly FoodBeverage: "Food & Beverage";
9
+ readonly Games: "Games";
10
+ readonly Health: "Health";
11
+ readonly Misc: "Misc";
12
+ readonly News: "News";
13
+ readonly Other: "Other";
14
+ readonly Productivity: "Productivity";
15
+ readonly ShoppingRetail: "Shopping & Retail";
16
+ readonly Social: "Social";
17
+ readonly Sports: "Sports";
18
+ readonly Travel: "Travel";
19
+ readonly Utilities: "Utilities";
20
+ };
@@ -0,0 +1,22 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.CompanyCategory = void 0;
7
+ exports.CompanyCategory = {
8
+ Entertainment: "Entertainment",
9
+ Finance: "Finance",
10
+ FoodBeverage: "Food & Beverage",
11
+ Games: "Games",
12
+ Health: "Health",
13
+ Misc: "Misc",
14
+ News: "News",
15
+ Other: "Other",
16
+ Productivity: "Productivity",
17
+ ShoppingRetail: "Shopping & Retail",
18
+ Social: "Social",
19
+ Sports: "Sports",
20
+ Travel: "Travel",
21
+ Utilities: "Utilities",
22
+ };
@@ -1,9 +1,12 @@
1
1
  /**
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
+ import * as Pinnacle from "../index";
4
5
  export interface CompanyDetails {
5
6
  /** The name of the company. */
6
7
  name: string;
8
+ /** The category of the company. */
9
+ category: Pinnacle.CompanyCategory;
7
10
  /** The address of the company. */
8
11
  address: string;
9
12
  /** The EIN (Employer Identification Number) of the company. */
@@ -0,0 +1,13 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Pinnacle from "../index";
5
+ export interface InboundActionMessage {
6
+ messageType?: "action";
7
+ actionTitle: string;
8
+ payload?: string;
9
+ actionMetadata?: string;
10
+ from: string;
11
+ to: string;
12
+ metadata?: Pinnacle.InboundMessageMetadata;
13
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,11 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Pinnacle from "../index";
5
+ export interface InboundLocationMessage {
6
+ messageType?: "location";
7
+ coordinates: Pinnacle.InboundLocationMessageCoordinates;
8
+ from: string;
9
+ to: string;
10
+ metadata?: Pinnacle.InboundMessageMetadata;
11
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,7 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export interface InboundLocationMessageCoordinates {
5
+ lat: number;
6
+ lng: number;
7
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,12 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Pinnacle from "../index";
5
+ export interface InboundMediaMessage {
6
+ messageType?: "media";
7
+ text?: string;
8
+ mediaUrls: Pinnacle.MediaPayload[];
9
+ from: string;
10
+ to: string;
11
+ metadata?: Pinnacle.InboundMessageMetadata;
12
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,10 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Pinnacle from "../index";
5
+ export interface InboundMessage {
6
+ from: string;
7
+ to: string;
8
+ messageType: Pinnacle.InboundMessageMessageType;
9
+ metadata?: Pinnacle.InboundMessageMetadata;
10
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,10 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export declare type InboundMessageMessageType = "text" | "media" | "action" | "location";
5
+ export declare const InboundMessageMessageType: {
6
+ readonly Text: "text";
7
+ readonly Media: "media";
8
+ readonly Action: "action";
9
+ readonly Location: "location";
10
+ };
@@ -0,0 +1,12 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.InboundMessageMessageType = void 0;
7
+ exports.InboundMessageMessageType = {
8
+ Text: "text",
9
+ Media: "media",
10
+ Action: "action",
11
+ Location: "location",
12
+ };
@@ -0,0 +1,8 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Pinnacle from "../index";
5
+ export interface InboundMessageMetadata {
6
+ sender?: Pinnacle.SenderMetadata;
7
+ message?: Pinnacle.MessageMetadata;
8
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,11 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as Pinnacle from "../index";
5
+ export interface InboundTextMessage {
6
+ messageType?: "text";
7
+ text: string;
8
+ from: string;
9
+ to: string;
10
+ metadata?: Pinnacle.InboundMessageMetadata;
11
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,7 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export interface MediaPayload {
5
+ type: string;
6
+ url: string;
7
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,6 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export interface MessageMetadata {
5
+ timestamp: Date;
6
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,15 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export interface Messaging {
5
+ /** Explain how users will opt in to receive messages. */
6
+ optIn: string;
7
+ /** Explain how users will opt out of receiving messages. */
8
+ optOut: string;
9
+ /** Please provide the unique keywords to opt out. Each keyword should not contain spaces. */
10
+ optOutKeywords: string[];
11
+ /** Please define what your agent will do. */
12
+ agentUseCase: string;
13
+ /** Please provide some example messages that your agent will send. */
14
+ expectedAgentResponses: string;
15
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,8 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export interface SenderMetadata {
5
+ city?: string;
6
+ state?: string;
7
+ country?: string;
8
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -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/Client.js CHANGED
@@ -75,7 +75,7 @@ class PinnacleClient {
75
75
  const _response = yield core.fetcher({
76
76
  url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.PinnacleEnvironment.Default, "rcs_functionality"),
77
77
  method: "GET",
78
- headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.13", "User-Agent": "rcs-js/1.0.13", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
78
+ headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "rcs-js", "X-Fern-SDK-Version": "1.0.15", "User-Agent": "rcs-js/1.0.15", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
79
79
  contentType: "application/json",
80
80
  queryParameters: _queryParams,
81
81
  requestType: "json",
@@ -50,6 +50,7 @@ export declare class Company {
50
50
  * await client.company.register({
51
51
  * company: {
52
52
  * name: "name",
53
+ * category: "Entertainment",
53
54
  * address: "address",
54
55
  * ein: "ein",
55
56
  * description: "description",
@@ -67,6 +68,13 @@ export declare class Company {
67
68
  * privacyPolicyUrl: "privacyPolicyUrl",
68
69
  * tosUrl: "tosUrl"
69
70
  * },
71
+ * messaging: {
72
+ * 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.",
73
+ * 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.",
74
+ * optOutKeywords: ["STOP", "UNSUBSCRIBE"],
75
+ * agentUseCase: "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.",
76
+ * expectedAgentResponses: "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"
77
+ * },
70
78
  * pointOfContact: {
71
79
  * pocName: "pocName",
72
80
  * pocTitle: "pocTitle",