rcs-js 2.0.15 → 2.0.17
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.
- package/dist/cjs/Client.js +2 -2
- package/dist/cjs/api/resources/messages/resources/rcs/client/Client.d.ts +0 -10
- package/dist/cjs/api/resources/messages/resources/rcs/client/Client.js +0 -10
- package/dist/cjs/api/types/BaseRichMessage.d.ts +18 -1
- package/dist/cjs/api/types/ExtendedBrandWithVetting.d.ts +2 -2
- package/dist/cjs/api/types/RcsCardsContent.d.ts +2 -2
- package/dist/cjs/api/types/RcsMediaContent.d.ts +1 -1
- package/dist/cjs/api/types/RcsValidateContent.d.ts +1 -1
- package/dist/cjs/api/types/RichCards.d.ts +2 -2
- package/dist/cjs/api/types/RichCardsMessage.d.ts +15 -1
- package/dist/cjs/api/types/RichMediaMessage.d.ts +1 -1
- package/dist/cjs/api/types/RichText.d.ts +1 -1
- package/dist/cjs/api/types/{SendRichMessageOptions.d.ts → SendRichMessageOptions4.d.ts} +1 -1
- package/dist/cjs/api/types/SentRichMessageFallbackMms.d.ts +1 -1
- package/dist/cjs/api/types/SentRichMessageFallbackSms.d.ts +1 -1
- package/dist/cjs/api/types/SuccessfulConversationUpdate.d.ts +1 -1
- package/dist/cjs/api/types/VcardContent.d.ts +1 -1
- package/dist/cjs/api/types/index.d.ts +1 -1
- package/dist/cjs/api/types/index.js +1 -1
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.mjs +2 -2
- package/dist/esm/api/resources/messages/resources/rcs/client/Client.d.mts +0 -10
- package/dist/esm/api/resources/messages/resources/rcs/client/Client.mjs +0 -10
- package/dist/esm/api/types/BaseRichMessage.d.mts +18 -1
- package/dist/esm/api/types/ExtendedBrandWithVetting.d.mts +2 -2
- package/dist/esm/api/types/RcsCardsContent.d.mts +2 -2
- package/dist/esm/api/types/RcsMediaContent.d.mts +1 -1
- package/dist/esm/api/types/RcsValidateContent.d.mts +1 -1
- package/dist/esm/api/types/RichCards.d.mts +2 -2
- package/dist/esm/api/types/RichCardsMessage.d.mts +15 -1
- package/dist/esm/api/types/RichMediaMessage.d.mts +1 -1
- package/dist/esm/api/types/RichText.d.mts +1 -1
- package/dist/esm/api/types/{SendRichMessageOptions.d.mts → SendRichMessageOptions4.d.mts} +1 -1
- package/dist/esm/api/types/SentRichMessageFallbackMms.d.mts +1 -1
- package/dist/esm/api/types/SentRichMessageFallbackSms.d.mts +1 -1
- package/dist/esm/api/types/SuccessfulConversationUpdate.d.mts +1 -1
- package/dist/esm/api/types/VcardContent.d.mts +1 -1
- package/dist/esm/api/types/index.d.mts +1 -1
- package/dist/esm/api/types/index.mjs +1 -1
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +0 -10
- /package/dist/cjs/api/types/{SendRichMessageOptions.js → SendRichMessageOptions4.js} +0 -0
- /package/dist/esm/api/types/{SendRichMessageOptions.mjs → SendRichMessageOptions4.mjs} +0 -0
package/dist/cjs/Client.js
CHANGED
|
@@ -53,8 +53,8 @@ class PinnacleClient {
|
|
|
53
53
|
this._options = Object.assign(Object.assign({}, _options), { logging: core.logging.createLogger(_options === null || _options === void 0 ? void 0 : _options.logging), headers: (0, headers_js_1.mergeHeaders)({
|
|
54
54
|
"X-Fern-Language": "JavaScript",
|
|
55
55
|
"X-Fern-SDK-Name": "rcs-js",
|
|
56
|
-
"X-Fern-SDK-Version": "2.0.
|
|
57
|
-
"User-Agent": "rcs-js/2.0.
|
|
56
|
+
"X-Fern-SDK-Version": "2.0.17",
|
|
57
|
+
"User-Agent": "rcs-js/2.0.17",
|
|
58
58
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
59
59
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
60
60
|
}, _options === null || _options === void 0 ? void 0 : _options.headers) });
|
|
@@ -28,11 +28,6 @@ export declare class Rcs {
|
|
|
28
28
|
*
|
|
29
29
|
* @example
|
|
30
30
|
* await client.messages.rcs.send({
|
|
31
|
-
* quickReplies: [{
|
|
32
|
-
* type: "openUrl",
|
|
33
|
-
* payload: "payload",
|
|
34
|
-
* title: "title"
|
|
35
|
-
* }],
|
|
36
31
|
* text: "text",
|
|
37
32
|
* from: "from",
|
|
38
33
|
* to: "to"
|
|
@@ -84,11 +79,6 @@ export declare class Rcs {
|
|
|
84
79
|
*
|
|
85
80
|
* @example
|
|
86
81
|
* await client.messages.rcs.validate({
|
|
87
|
-
* quickReplies: [{
|
|
88
|
-
* type: "openUrl",
|
|
89
|
-
* payload: "payload",
|
|
90
|
-
* title: "title"
|
|
91
|
-
* }],
|
|
92
82
|
* text: "text"
|
|
93
83
|
* })
|
|
94
84
|
*/
|
|
@@ -71,11 +71,6 @@ class Rcs {
|
|
|
71
71
|
*
|
|
72
72
|
* @example
|
|
73
73
|
* await client.messages.rcs.send({
|
|
74
|
-
* quickReplies: [{
|
|
75
|
-
* type: "openUrl",
|
|
76
|
-
* payload: "payload",
|
|
77
|
-
* title: "title"
|
|
78
|
-
* }],
|
|
79
74
|
* text: "text",
|
|
80
75
|
* from: "from",
|
|
81
76
|
* to: "to"
|
|
@@ -254,11 +249,6 @@ class Rcs {
|
|
|
254
249
|
*
|
|
255
250
|
* @example
|
|
256
251
|
* await client.messages.rcs.validate({
|
|
257
|
-
* quickReplies: [{
|
|
258
|
-
* type: "openUrl",
|
|
259
|
-
* payload: "payload",
|
|
260
|
-
* title: "title"
|
|
261
|
-
* }],
|
|
262
252
|
* text: "text"
|
|
263
253
|
* })
|
|
264
254
|
*/
|
|
@@ -4,7 +4,24 @@ export interface BaseRichMessage {
|
|
|
4
4
|
from: string;
|
|
5
5
|
fallback?: Pinnacle.FallbackMessage;
|
|
6
6
|
/** Configure how your RCS message is sent and tracked. */
|
|
7
|
-
options?:
|
|
7
|
+
options?: BaseRichMessage.Options;
|
|
8
8
|
/** Recipient's phone number in E.164 format. */
|
|
9
9
|
to: string;
|
|
10
10
|
}
|
|
11
|
+
export declare namespace BaseRichMessage {
|
|
12
|
+
/**
|
|
13
|
+
* Configure how your RCS message is sent and tracked.
|
|
14
|
+
*/
|
|
15
|
+
interface Options {
|
|
16
|
+
schedule?: Pinnacle.MessageSchedule;
|
|
17
|
+
tracking?: Pinnacle.Tracking;
|
|
18
|
+
/** Media files and card media will be transcoded to a supported RCS format. This adds a small delay to sending the message. Ignored for rich text messages. */
|
|
19
|
+
transcode?: boolean;
|
|
20
|
+
/**
|
|
21
|
+
* Validate your message for any unsupported files. <br>
|
|
22
|
+
*
|
|
23
|
+
* If failed, errors will be thrown and the message will not send.
|
|
24
|
+
*/
|
|
25
|
+
validate?: boolean;
|
|
26
|
+
}
|
|
27
|
+
}
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import type * as Pinnacle from "../index.js";
|
|
2
2
|
export interface ExtendedBrandWithVetting extends Pinnacle.ExtendedBrand {
|
|
3
3
|
/** ISO 8601 formatted timestamp of the last TCR vetting. */
|
|
4
|
-
lastTcrVettingDate: string
|
|
4
|
+
lastTcrVettingDate: string;
|
|
5
5
|
/** Feedback from The Campaign Registry if TCR vetting was performed. */
|
|
6
|
-
tcrFeedback: Pinnacle.VettingFeedback[]
|
|
6
|
+
tcrFeedback: Pinnacle.VettingFeedback[];
|
|
7
7
|
/** History of all external vetting attempts for this brand. */
|
|
8
8
|
vettingHistory: Pinnacle.VettingHistory[];
|
|
9
9
|
}
|
|
@@ -14,7 +14,7 @@ export interface RcsCardsContent {
|
|
|
14
14
|
* List of interactive quick reply buttons in the message. <br><br>
|
|
15
15
|
* **Limit:** 10 max
|
|
16
16
|
*/
|
|
17
|
-
quickReplies
|
|
17
|
+
quickReplies?: Pinnacle.RichButton[];
|
|
18
18
|
}
|
|
19
19
|
export declare namespace RcsCardsContent {
|
|
20
20
|
type Cards = Cards.Item[];
|
|
@@ -27,7 +27,7 @@ export declare namespace RcsCardsContent {
|
|
|
27
27
|
* While buttons resemble quick replies, they remain on screen after being clicked and are card-specific. <br><br>
|
|
28
28
|
* **Limit:** 4 max
|
|
29
29
|
*/
|
|
30
|
-
buttons
|
|
30
|
+
buttons?: Pinnacle.RichButton[];
|
|
31
31
|
media?: Pinnacle.RcsMediaDetailsContent;
|
|
32
32
|
/** Secondary text displayed below the title for additional context. */
|
|
33
33
|
subtitle?: string;
|
|
@@ -9,7 +9,7 @@ Pinnacle.RichText
|
|
|
9
9
|
* See [supported media types](https://app.pinnacle.sh/supported-file-types?type=RCS-MEDIA). */
|
|
10
10
|
| {
|
|
11
11
|
media: string;
|
|
12
|
-
quickReplies
|
|
12
|
+
quickReplies?: Pinnacle.RichButton[] | undefined;
|
|
13
13
|
}
|
|
14
14
|
/**
|
|
15
15
|
* Message containing cards, each with its own title, subtitle, and/or buttons. Quick replies can also be added. <br>
|
|
@@ -14,7 +14,7 @@ export interface RichCards {
|
|
|
14
14
|
* List of interactive quick reply buttons in the message. <br><br>
|
|
15
15
|
* **Limit:** 10 max
|
|
16
16
|
*/
|
|
17
|
-
quickReplies
|
|
17
|
+
quickReplies?: Pinnacle.RichButton[];
|
|
18
18
|
}
|
|
19
19
|
export declare namespace RichCards {
|
|
20
20
|
type Cards = Cards.Item[];
|
|
@@ -27,7 +27,7 @@ export declare namespace RichCards {
|
|
|
27
27
|
* While buttons resemble quick replies, they remain on screen after being clicked and are card-specific. <br><br>
|
|
28
28
|
* **Limit:** 4 max
|
|
29
29
|
*/
|
|
30
|
-
buttons
|
|
30
|
+
buttons?: Pinnacle.RichButton[];
|
|
31
31
|
/** Media file URLs to send. */
|
|
32
32
|
media?: string;
|
|
33
33
|
/** Secondary text displayed below the title for additional context. */
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import type * as Pinnacle from "../index.js";
|
|
2
2
|
export interface RichCardsMessage extends Pinnacle.RichCards {
|
|
3
|
+
/** Configure how your RCS message is sent and tracked. */
|
|
3
4
|
options?: RichCardsMessage.Options;
|
|
4
5
|
/** Your RCS agent ID which must be prefixed with 'agent_'. */
|
|
5
6
|
from: string;
|
|
@@ -8,7 +9,20 @@ export interface RichCardsMessage extends Pinnacle.RichCards {
|
|
|
8
9
|
to: string;
|
|
9
10
|
}
|
|
10
11
|
export declare namespace RichCardsMessage {
|
|
11
|
-
|
|
12
|
+
/**
|
|
13
|
+
* Configure how your RCS message is sent and tracked.
|
|
14
|
+
*/
|
|
15
|
+
interface Options {
|
|
16
|
+
schedule?: Pinnacle.MessageSchedule;
|
|
17
|
+
tracking?: Pinnacle.Tracking;
|
|
18
|
+
/** Media files and card media will be transcoded to a supported RCS format. This adds a small delay to sending the message. Ignored for rich text messages. */
|
|
19
|
+
transcode?: boolean;
|
|
20
|
+
/**
|
|
21
|
+
* Validate your message for any unsupported files. <br>
|
|
22
|
+
*
|
|
23
|
+
* If failed, errors will be thrown and the message will not send.
|
|
24
|
+
*/
|
|
25
|
+
validate?: boolean;
|
|
12
26
|
/**
|
|
13
27
|
* Configure standalone card layout options for enhanced visual presentation.
|
|
14
28
|
*
|
|
@@ -7,7 +7,7 @@ export interface RichText {
|
|
|
7
7
|
* List of interactive quick reply buttons in the message. <br><br>
|
|
8
8
|
* **Limit:** 10 max
|
|
9
9
|
*/
|
|
10
|
-
quickReplies
|
|
10
|
+
quickReplies?: Pinnacle.RichButton[];
|
|
11
11
|
/** Text content of the RCS message. */
|
|
12
12
|
text: string;
|
|
13
13
|
}
|
|
@@ -2,7 +2,7 @@ import type * as Pinnacle from "../index.js";
|
|
|
2
2
|
/**
|
|
3
3
|
* Configure how your RCS message is sent and tracked.
|
|
4
4
|
*/
|
|
5
|
-
export interface
|
|
5
|
+
export interface SendRichMessageOptions4 {
|
|
6
6
|
schedule?: Pinnacle.MessageSchedule;
|
|
7
7
|
tracking?: Pinnacle.Tracking;
|
|
8
8
|
/** Media files and card media will be transcoded to a supported RCS format. This adds a small delay to sending the message. Ignored for rich text messages. */
|
|
@@ -4,7 +4,7 @@ import type * as Pinnacle from "../index.js";
|
|
|
4
4
|
*/
|
|
5
5
|
export interface SentRichMessageFallbackMms extends Pinnacle.SentMmsDetails {
|
|
6
6
|
/** Indicates that the fallback MMS was sent because the recipient does not support RCS. */
|
|
7
|
-
fallbackSent:
|
|
7
|
+
fallbackSent: true;
|
|
8
8
|
/** Unique identifier of the original RCS message that triggered this fallback. Always begins with the prefix `msg_`. This is the RCS message that could not be delivered — the `messageIds` field on this response refers to the actual MMS message(s) that were sent as the fallback. */
|
|
9
9
|
originalMessageId: string;
|
|
10
10
|
}
|
|
@@ -4,7 +4,7 @@ import type * as Pinnacle from "../index.js";
|
|
|
4
4
|
*/
|
|
5
5
|
export interface SentRichMessageFallbackSms extends Pinnacle.SentSmsDetails {
|
|
6
6
|
/** Indicates that the fallback SMS was sent because the recipient does not support RCS. */
|
|
7
|
-
fallbackSent:
|
|
7
|
+
fallbackSent: true;
|
|
8
8
|
/** Unique identifier of the original RCS message that triggered this fallback. Always begins with the prefix `msg_`. This is the RCS message that could not be delivered — the `messageId` field on this response refers to the actual SMS that was sent as the fallback. */
|
|
9
9
|
originalMessageId: string;
|
|
10
10
|
}
|
|
@@ -144,7 +144,7 @@ export * from "./ScheduledBlastDetails.js";
|
|
|
144
144
|
export * from "./ScheduledMessage.js";
|
|
145
145
|
export * from "./ScheduledMessageSummary.js";
|
|
146
146
|
export * from "./Sender.js";
|
|
147
|
-
export * from "./
|
|
147
|
+
export * from "./SendRichMessageOptions4.js";
|
|
148
148
|
export * from "./SendTypingIndicatorResponse.js";
|
|
149
149
|
export * from "./SentMmsDetails.js";
|
|
150
150
|
export * from "./SentRichMessage.js";
|
|
@@ -160,7 +160,7 @@ __exportStar(require("./ScheduledBlastDetails.js"), exports);
|
|
|
160
160
|
__exportStar(require("./ScheduledMessage.js"), exports);
|
|
161
161
|
__exportStar(require("./ScheduledMessageSummary.js"), exports);
|
|
162
162
|
__exportStar(require("./Sender.js"), exports);
|
|
163
|
-
__exportStar(require("./
|
|
163
|
+
__exportStar(require("./SendRichMessageOptions4.js"), exports);
|
|
164
164
|
__exportStar(require("./SendTypingIndicatorResponse.js"), exports);
|
|
165
165
|
__exportStar(require("./SentMmsDetails.js"), exports);
|
|
166
166
|
__exportStar(require("./SentRichMessage.js"), exports);
|
package/dist/cjs/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "2.0.
|
|
1
|
+
export declare const SDK_VERSION = "2.0.17";
|
package/dist/cjs/version.js
CHANGED
package/dist/esm/Client.mjs
CHANGED
|
@@ -17,8 +17,8 @@ export class PinnacleClient {
|
|
|
17
17
|
this._options = Object.assign(Object.assign({}, _options), { logging: core.logging.createLogger(_options === null || _options === void 0 ? void 0 : _options.logging), headers: mergeHeaders({
|
|
18
18
|
"X-Fern-Language": "JavaScript",
|
|
19
19
|
"X-Fern-SDK-Name": "rcs-js",
|
|
20
|
-
"X-Fern-SDK-Version": "2.0.
|
|
21
|
-
"User-Agent": "rcs-js/2.0.
|
|
20
|
+
"X-Fern-SDK-Version": "2.0.17",
|
|
21
|
+
"User-Agent": "rcs-js/2.0.17",
|
|
22
22
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
23
23
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
24
24
|
}, _options === null || _options === void 0 ? void 0 : _options.headers) });
|
|
@@ -28,11 +28,6 @@ export declare class Rcs {
|
|
|
28
28
|
*
|
|
29
29
|
* @example
|
|
30
30
|
* await client.messages.rcs.send({
|
|
31
|
-
* quickReplies: [{
|
|
32
|
-
* type: "openUrl",
|
|
33
|
-
* payload: "payload",
|
|
34
|
-
* title: "title"
|
|
35
|
-
* }],
|
|
36
31
|
* text: "text",
|
|
37
32
|
* from: "from",
|
|
38
33
|
* to: "to"
|
|
@@ -84,11 +79,6 @@ export declare class Rcs {
|
|
|
84
79
|
*
|
|
85
80
|
* @example
|
|
86
81
|
* await client.messages.rcs.validate({
|
|
87
|
-
* quickReplies: [{
|
|
88
|
-
* type: "openUrl",
|
|
89
|
-
* payload: "payload",
|
|
90
|
-
* title: "title"
|
|
91
|
-
* }],
|
|
92
82
|
* text: "text"
|
|
93
83
|
* })
|
|
94
84
|
*/
|
|
@@ -35,11 +35,6 @@ export class Rcs {
|
|
|
35
35
|
*
|
|
36
36
|
* @example
|
|
37
37
|
* await client.messages.rcs.send({
|
|
38
|
-
* quickReplies: [{
|
|
39
|
-
* type: "openUrl",
|
|
40
|
-
* payload: "payload",
|
|
41
|
-
* title: "title"
|
|
42
|
-
* }],
|
|
43
38
|
* text: "text",
|
|
44
39
|
* from: "from",
|
|
45
40
|
* to: "to"
|
|
@@ -218,11 +213,6 @@ export class Rcs {
|
|
|
218
213
|
*
|
|
219
214
|
* @example
|
|
220
215
|
* await client.messages.rcs.validate({
|
|
221
|
-
* quickReplies: [{
|
|
222
|
-
* type: "openUrl",
|
|
223
|
-
* payload: "payload",
|
|
224
|
-
* title: "title"
|
|
225
|
-
* }],
|
|
226
216
|
* text: "text"
|
|
227
217
|
* })
|
|
228
218
|
*/
|
|
@@ -4,7 +4,24 @@ export interface BaseRichMessage {
|
|
|
4
4
|
from: string;
|
|
5
5
|
fallback?: Pinnacle.FallbackMessage;
|
|
6
6
|
/** Configure how your RCS message is sent and tracked. */
|
|
7
|
-
options?:
|
|
7
|
+
options?: BaseRichMessage.Options;
|
|
8
8
|
/** Recipient's phone number in E.164 format. */
|
|
9
9
|
to: string;
|
|
10
10
|
}
|
|
11
|
+
export declare namespace BaseRichMessage {
|
|
12
|
+
/**
|
|
13
|
+
* Configure how your RCS message is sent and tracked.
|
|
14
|
+
*/
|
|
15
|
+
interface Options {
|
|
16
|
+
schedule?: Pinnacle.MessageSchedule;
|
|
17
|
+
tracking?: Pinnacle.Tracking;
|
|
18
|
+
/** Media files and card media will be transcoded to a supported RCS format. This adds a small delay to sending the message. Ignored for rich text messages. */
|
|
19
|
+
transcode?: boolean;
|
|
20
|
+
/**
|
|
21
|
+
* Validate your message for any unsupported files. <br>
|
|
22
|
+
*
|
|
23
|
+
* If failed, errors will be thrown and the message will not send.
|
|
24
|
+
*/
|
|
25
|
+
validate?: boolean;
|
|
26
|
+
}
|
|
27
|
+
}
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import type * as Pinnacle from "../index.mjs";
|
|
2
2
|
export interface ExtendedBrandWithVetting extends Pinnacle.ExtendedBrand {
|
|
3
3
|
/** ISO 8601 formatted timestamp of the last TCR vetting. */
|
|
4
|
-
lastTcrVettingDate: string
|
|
4
|
+
lastTcrVettingDate: string;
|
|
5
5
|
/** Feedback from The Campaign Registry if TCR vetting was performed. */
|
|
6
|
-
tcrFeedback: Pinnacle.VettingFeedback[]
|
|
6
|
+
tcrFeedback: Pinnacle.VettingFeedback[];
|
|
7
7
|
/** History of all external vetting attempts for this brand. */
|
|
8
8
|
vettingHistory: Pinnacle.VettingHistory[];
|
|
9
9
|
}
|
|
@@ -14,7 +14,7 @@ export interface RcsCardsContent {
|
|
|
14
14
|
* List of interactive quick reply buttons in the message. <br><br>
|
|
15
15
|
* **Limit:** 10 max
|
|
16
16
|
*/
|
|
17
|
-
quickReplies
|
|
17
|
+
quickReplies?: Pinnacle.RichButton[];
|
|
18
18
|
}
|
|
19
19
|
export declare namespace RcsCardsContent {
|
|
20
20
|
type Cards = Cards.Item[];
|
|
@@ -27,7 +27,7 @@ export declare namespace RcsCardsContent {
|
|
|
27
27
|
* While buttons resemble quick replies, they remain on screen after being clicked and are card-specific. <br><br>
|
|
28
28
|
* **Limit:** 4 max
|
|
29
29
|
*/
|
|
30
|
-
buttons
|
|
30
|
+
buttons?: Pinnacle.RichButton[];
|
|
31
31
|
media?: Pinnacle.RcsMediaDetailsContent;
|
|
32
32
|
/** Secondary text displayed below the title for additional context. */
|
|
33
33
|
subtitle?: string;
|
|
@@ -9,7 +9,7 @@ Pinnacle.RichText
|
|
|
9
9
|
* See [supported media types](https://app.pinnacle.sh/supported-file-types?type=RCS-MEDIA). */
|
|
10
10
|
| {
|
|
11
11
|
media: string;
|
|
12
|
-
quickReplies
|
|
12
|
+
quickReplies?: Pinnacle.RichButton[] | undefined;
|
|
13
13
|
}
|
|
14
14
|
/**
|
|
15
15
|
* Message containing cards, each with its own title, subtitle, and/or buttons. Quick replies can also be added. <br>
|
|
@@ -14,7 +14,7 @@ export interface RichCards {
|
|
|
14
14
|
* List of interactive quick reply buttons in the message. <br><br>
|
|
15
15
|
* **Limit:** 10 max
|
|
16
16
|
*/
|
|
17
|
-
quickReplies
|
|
17
|
+
quickReplies?: Pinnacle.RichButton[];
|
|
18
18
|
}
|
|
19
19
|
export declare namespace RichCards {
|
|
20
20
|
type Cards = Cards.Item[];
|
|
@@ -27,7 +27,7 @@ export declare namespace RichCards {
|
|
|
27
27
|
* While buttons resemble quick replies, they remain on screen after being clicked and are card-specific. <br><br>
|
|
28
28
|
* **Limit:** 4 max
|
|
29
29
|
*/
|
|
30
|
-
buttons
|
|
30
|
+
buttons?: Pinnacle.RichButton[];
|
|
31
31
|
/** Media file URLs to send. */
|
|
32
32
|
media?: string;
|
|
33
33
|
/** Secondary text displayed below the title for additional context. */
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import type * as Pinnacle from "../index.mjs";
|
|
2
2
|
export interface RichCardsMessage extends Pinnacle.RichCards {
|
|
3
|
+
/** Configure how your RCS message is sent and tracked. */
|
|
3
4
|
options?: RichCardsMessage.Options;
|
|
4
5
|
/** Your RCS agent ID which must be prefixed with 'agent_'. */
|
|
5
6
|
from: string;
|
|
@@ -8,7 +9,20 @@ export interface RichCardsMessage extends Pinnacle.RichCards {
|
|
|
8
9
|
to: string;
|
|
9
10
|
}
|
|
10
11
|
export declare namespace RichCardsMessage {
|
|
11
|
-
|
|
12
|
+
/**
|
|
13
|
+
* Configure how your RCS message is sent and tracked.
|
|
14
|
+
*/
|
|
15
|
+
interface Options {
|
|
16
|
+
schedule?: Pinnacle.MessageSchedule;
|
|
17
|
+
tracking?: Pinnacle.Tracking;
|
|
18
|
+
/** Media files and card media will be transcoded to a supported RCS format. This adds a small delay to sending the message. Ignored for rich text messages. */
|
|
19
|
+
transcode?: boolean;
|
|
20
|
+
/**
|
|
21
|
+
* Validate your message for any unsupported files. <br>
|
|
22
|
+
*
|
|
23
|
+
* If failed, errors will be thrown and the message will not send.
|
|
24
|
+
*/
|
|
25
|
+
validate?: boolean;
|
|
12
26
|
/**
|
|
13
27
|
* Configure standalone card layout options for enhanced visual presentation.
|
|
14
28
|
*
|
|
@@ -7,7 +7,7 @@ export interface RichText {
|
|
|
7
7
|
* List of interactive quick reply buttons in the message. <br><br>
|
|
8
8
|
* **Limit:** 10 max
|
|
9
9
|
*/
|
|
10
|
-
quickReplies
|
|
10
|
+
quickReplies?: Pinnacle.RichButton[];
|
|
11
11
|
/** Text content of the RCS message. */
|
|
12
12
|
text: string;
|
|
13
13
|
}
|
|
@@ -2,7 +2,7 @@ import type * as Pinnacle from "../index.mjs";
|
|
|
2
2
|
/**
|
|
3
3
|
* Configure how your RCS message is sent and tracked.
|
|
4
4
|
*/
|
|
5
|
-
export interface
|
|
5
|
+
export interface SendRichMessageOptions4 {
|
|
6
6
|
schedule?: Pinnacle.MessageSchedule;
|
|
7
7
|
tracking?: Pinnacle.Tracking;
|
|
8
8
|
/** Media files and card media will be transcoded to a supported RCS format. This adds a small delay to sending the message. Ignored for rich text messages. */
|
|
@@ -4,7 +4,7 @@ import type * as Pinnacle from "../index.mjs";
|
|
|
4
4
|
*/
|
|
5
5
|
export interface SentRichMessageFallbackMms extends Pinnacle.SentMmsDetails {
|
|
6
6
|
/** Indicates that the fallback MMS was sent because the recipient does not support RCS. */
|
|
7
|
-
fallbackSent:
|
|
7
|
+
fallbackSent: true;
|
|
8
8
|
/** Unique identifier of the original RCS message that triggered this fallback. Always begins with the prefix `msg_`. This is the RCS message that could not be delivered — the `messageIds` field on this response refers to the actual MMS message(s) that were sent as the fallback. */
|
|
9
9
|
originalMessageId: string;
|
|
10
10
|
}
|
|
@@ -4,7 +4,7 @@ import type * as Pinnacle from "../index.mjs";
|
|
|
4
4
|
*/
|
|
5
5
|
export interface SentRichMessageFallbackSms extends Pinnacle.SentSmsDetails {
|
|
6
6
|
/** Indicates that the fallback SMS was sent because the recipient does not support RCS. */
|
|
7
|
-
fallbackSent:
|
|
7
|
+
fallbackSent: true;
|
|
8
8
|
/** Unique identifier of the original RCS message that triggered this fallback. Always begins with the prefix `msg_`. This is the RCS message that could not be delivered — the `messageId` field on this response refers to the actual SMS that was sent as the fallback. */
|
|
9
9
|
originalMessageId: string;
|
|
10
10
|
}
|
|
@@ -144,7 +144,7 @@ export * from "./ScheduledBlastDetails.mjs";
|
|
|
144
144
|
export * from "./ScheduledMessage.mjs";
|
|
145
145
|
export * from "./ScheduledMessageSummary.mjs";
|
|
146
146
|
export * from "./Sender.mjs";
|
|
147
|
-
export * from "./
|
|
147
|
+
export * from "./SendRichMessageOptions4.mjs";
|
|
148
148
|
export * from "./SendTypingIndicatorResponse.mjs";
|
|
149
149
|
export * from "./SentMmsDetails.mjs";
|
|
150
150
|
export * from "./SentRichMessage.mjs";
|
|
@@ -144,7 +144,7 @@ export * from "./ScheduledBlastDetails.mjs";
|
|
|
144
144
|
export * from "./ScheduledMessage.mjs";
|
|
145
145
|
export * from "./ScheduledMessageSummary.mjs";
|
|
146
146
|
export * from "./Sender.mjs";
|
|
147
|
-
export * from "./
|
|
147
|
+
export * from "./SendRichMessageOptions4.mjs";
|
|
148
148
|
export * from "./SendTypingIndicatorResponse.mjs";
|
|
149
149
|
export * from "./SentMmsDetails.mjs";
|
|
150
150
|
export * from "./SentRichMessage.mjs";
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "2.0.
|
|
1
|
+
export declare const SDK_VERSION = "2.0.17";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "2.0.
|
|
1
|
+
export const SDK_VERSION = "2.0.17";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -4061,11 +4061,6 @@ Requires an active RCS agent and recipient devices that support RCS Business Mes
|
|
|
4061
4061
|
|
|
4062
4062
|
```typescript
|
|
4063
4063
|
await client.messages.rcs.send({
|
|
4064
|
-
quickReplies: [{
|
|
4065
|
-
type: "openUrl",
|
|
4066
|
-
payload: "payload",
|
|
4067
|
-
title: "title"
|
|
4068
|
-
}],
|
|
4069
4064
|
text: "text",
|
|
4070
4065
|
from: "from",
|
|
4071
4066
|
to: "to"
|
|
@@ -4209,11 +4204,6 @@ Validate RCS message content without sending it.
|
|
|
4209
4204
|
|
|
4210
4205
|
```typescript
|
|
4211
4206
|
await client.messages.rcs.validate({
|
|
4212
|
-
quickReplies: [{
|
|
4213
|
-
type: "openUrl",
|
|
4214
|
-
payload: "payload",
|
|
4215
|
-
title: "title"
|
|
4216
|
-
}],
|
|
4217
4207
|
text: "text"
|
|
4218
4208
|
});
|
|
4219
4209
|
|
|
File without changes
|
|
File without changes
|