rcs-js 2.0.9 → 2.0.10
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/audiences/resources/contacts/client/requests/AddContactsParams.d.ts +4 -1
- package/dist/cjs/api/resources/audiences/resources/contacts/client/requests/RemoveContactsParams.d.ts +4 -1
- package/dist/cjs/api/resources/campaigns/resources/dlc/client/requests/UpsertDlcCampaignParams.d.ts +4 -1
- package/dist/cjs/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.ts +16 -4
- package/dist/cjs/api/resources/messages/resources/blast/client/requests/BlastMms.d.ts +2 -0
- package/dist/cjs/api/resources/messages/resources/blast/client/requests/BlastRcs.d.ts +2 -0
- package/dist/cjs/api/resources/messages/resources/blast/client/requests/BlastSms.d.ts +2 -0
- package/dist/cjs/api/resources/messages/resources/rcs/client/Client.js +2 -2
- package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/requests/AttachCampaignParams.d.ts +4 -1
- package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/requests/DetachCampaignParams.d.ts +4 -1
- package/dist/cjs/api/resources/rcs/client/requests/RcsCapabilitiesQuery.d.ts +4 -1
- package/dist/cjs/api/resources/webhooks/client/requests/GetWebhookParams.d.ts +4 -1
- package/dist/cjs/api/types/MessageEventRcsCardsContent.d.ts +12 -3
- package/dist/cjs/api/types/MessageEventRcsMediaContent.d.ts +4 -1
- package/dist/cjs/api/types/MessageEventRcsTextContent.d.ts +4 -1
- package/dist/cjs/api/types/RcsCardsContent.d.ts +12 -3
- package/dist/cjs/api/types/RcsMediaContent.d.ts +4 -1
- package/dist/cjs/api/types/RichCards.d.ts +12 -3
- package/dist/cjs/api/types/RichMediaMessage.d.ts +4 -1
- package/dist/cjs/api/types/RichText.d.ts +4 -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/audiences/resources/contacts/client/requests/AddContactsParams.d.mts +4 -1
- package/dist/esm/api/resources/audiences/resources/contacts/client/requests/RemoveContactsParams.d.mts +4 -1
- package/dist/esm/api/resources/campaigns/resources/dlc/client/requests/UpsertDlcCampaignParams.d.mts +4 -1
- package/dist/esm/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.mts +16 -4
- package/dist/esm/api/resources/messages/resources/blast/client/requests/BlastMms.d.mts +2 -0
- package/dist/esm/api/resources/messages/resources/blast/client/requests/BlastRcs.d.mts +2 -0
- package/dist/esm/api/resources/messages/resources/blast/client/requests/BlastSms.d.mts +2 -0
- package/dist/esm/api/resources/messages/resources/rcs/client/Client.mjs +2 -2
- package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/requests/AttachCampaignParams.d.mts +4 -1
- package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/requests/DetachCampaignParams.d.mts +4 -1
- package/dist/esm/api/resources/rcs/client/requests/RcsCapabilitiesQuery.d.mts +4 -1
- package/dist/esm/api/resources/webhooks/client/requests/GetWebhookParams.d.mts +4 -1
- package/dist/esm/api/types/MessageEventRcsCardsContent.d.mts +12 -3
- package/dist/esm/api/types/MessageEventRcsMediaContent.d.mts +4 -1
- package/dist/esm/api/types/MessageEventRcsTextContent.d.mts +4 -1
- package/dist/esm/api/types/RcsCardsContent.d.mts +12 -3
- package/dist/esm/api/types/RcsMediaContent.d.mts +4 -1
- package/dist/esm/api/types/RichCards.d.mts +12 -3
- package/dist/esm/api/types/RichMediaMessage.d.mts +4 -1
- package/dist/esm/api/types/RichText.d.mts +4 -1
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
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.10",
|
|
57
|
+
"User-Agent": "rcs-js/2.0.10",
|
|
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) });
|
package/dist/cjs/api/resources/audiences/resources/contacts/client/requests/AddContactsParams.d.ts
CHANGED
|
@@ -8,6 +8,9 @@
|
|
|
8
8
|
export interface AddContactsParams {
|
|
9
9
|
/** Audience ID. This identifier is a string that always begins with the prefix `aud_`, for example: `aud_abc123`. */
|
|
10
10
|
id: string;
|
|
11
|
-
/**
|
|
11
|
+
/**
|
|
12
|
+
* Array of phone numbers (E.164 format) or contact IDs. <br><br>
|
|
13
|
+
* **Limit:** 1 min
|
|
14
|
+
*/
|
|
12
15
|
contacts: string[];
|
|
13
16
|
}
|
|
@@ -8,6 +8,9 @@
|
|
|
8
8
|
export interface RemoveContactsParams {
|
|
9
9
|
/** Audience ID. This identifier is a string that always begins with the prefix `aud_`, for example: `aud_abc123`. */
|
|
10
10
|
id: string;
|
|
11
|
-
/**
|
|
11
|
+
/**
|
|
12
|
+
* Array of phone numbers (E.164 format) or contact IDs. <br><br>
|
|
13
|
+
* **Limit:** 1 min
|
|
14
|
+
*/
|
|
12
15
|
contacts: string[];
|
|
13
16
|
}
|
package/dist/cjs/api/resources/campaigns/resources/dlc/client/requests/UpsertDlcCampaignParams.d.ts
CHANGED
|
@@ -59,7 +59,10 @@ export interface UpsertDlcCampaignParams {
|
|
|
59
59
|
name?: string;
|
|
60
60
|
/** Campaign configuration options. */
|
|
61
61
|
options?: UpsertDlcCampaignParams.Options;
|
|
62
|
-
/**
|
|
62
|
+
/**
|
|
63
|
+
* Example messages for the campaign. <br><br>
|
|
64
|
+
* **Limit:** 1 to 5
|
|
65
|
+
*/
|
|
63
66
|
sampleMessages?: string[];
|
|
64
67
|
/** Use case for the campaign. */
|
|
65
68
|
useCase?: UpsertDlcCampaignParams.UseCase;
|
package/dist/cjs/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.ts
CHANGED
|
@@ -67,7 +67,10 @@ export interface UpsertRcsCampaignParams {
|
|
|
67
67
|
brand?: string;
|
|
68
68
|
/** Unique identifier for the campaign. */
|
|
69
69
|
campaignId?: string;
|
|
70
|
-
/**
|
|
70
|
+
/**
|
|
71
|
+
* List of what the agent might say to users. <br><br>
|
|
72
|
+
* **Limit:** 1 to 5
|
|
73
|
+
*/
|
|
71
74
|
expectedAgentResponses?: string[];
|
|
72
75
|
/** Legal documentation links. */
|
|
73
76
|
links?: UpsertRcsCampaignParams.Links;
|
|
@@ -113,7 +116,10 @@ export declare namespace UpsertRcsCampaignParams {
|
|
|
113
116
|
* Be clear, concise, user-focused, and highlight what the agent does and the benefits it provides for the user.
|
|
114
117
|
*/
|
|
115
118
|
description?: string;
|
|
116
|
-
/**
|
|
119
|
+
/**
|
|
120
|
+
* List of emails. <br><br>
|
|
121
|
+
* **Limit:** 1 to 3
|
|
122
|
+
*/
|
|
117
123
|
emails?: Agent.Emails.Item[];
|
|
118
124
|
/** Link to the agent's hero. Hero must be an image file with dimensions 1440x448px. */
|
|
119
125
|
heroUrl?: string;
|
|
@@ -125,9 +131,15 @@ export declare namespace UpsertRcsCampaignParams {
|
|
|
125
131
|
* Recommended format: [Brand Name] - [1-2 word description of purpose]
|
|
126
132
|
*/
|
|
127
133
|
name?: string;
|
|
128
|
-
/**
|
|
134
|
+
/**
|
|
135
|
+
* List of phone numbers. <br><br>
|
|
136
|
+
* **Limit:** 1 to 3
|
|
137
|
+
*/
|
|
129
138
|
phones?: Agent.Phones.Item[];
|
|
130
|
-
/**
|
|
139
|
+
/**
|
|
140
|
+
* List of urls. <br><br>
|
|
141
|
+
* **Limit:** 1 to 3
|
|
142
|
+
*/
|
|
131
143
|
websites?: Agent.Websites.Item[];
|
|
132
144
|
}
|
|
133
145
|
namespace Agent {
|
|
@@ -185,7 +185,7 @@ class Rcs {
|
|
|
185
185
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
186
186
|
const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
187
187
|
const _response = yield core.fetcher({
|
|
188
|
-
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PinnacleEnvironment.Default, "messages/typing"),
|
|
188
|
+
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PinnacleEnvironment.Default, "messages/send/typing"),
|
|
189
189
|
method: "POST",
|
|
190
190
|
headers: _headers,
|
|
191
191
|
contentType: "application/json",
|
|
@@ -229,7 +229,7 @@ class Rcs {
|
|
|
229
229
|
rawResponse: _response.rawResponse,
|
|
230
230
|
});
|
|
231
231
|
case "timeout":
|
|
232
|
-
throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /messages/typing.");
|
|
232
|
+
throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /messages/send/typing.");
|
|
233
233
|
case "unknown":
|
|
234
234
|
throw new errors.PinnacleError({
|
|
235
235
|
message: _response.error.errorMessage,
|
|
@@ -8,7 +8,10 @@ import type * as Pinnacle from "../../../../../../index.js";
|
|
|
8
8
|
* }
|
|
9
9
|
*/
|
|
10
10
|
export interface AttachCampaignParams {
|
|
11
|
-
/**
|
|
11
|
+
/**
|
|
12
|
+
* List of phone number (E.164 format). <br><br>
|
|
13
|
+
* **Limit:** 1 to 10
|
|
14
|
+
*/
|
|
12
15
|
phones: string[];
|
|
13
16
|
campaignType: Pinnacle.MessagingProfileEnum;
|
|
14
17
|
/**
|
|
@@ -5,6 +5,9 @@
|
|
|
5
5
|
* }
|
|
6
6
|
*/
|
|
7
7
|
export interface RcsCapabilitiesQuery {
|
|
8
|
-
/**
|
|
8
|
+
/**
|
|
9
|
+
* List of phone numbers to check RCS capabilities for (E.164 format). <br><br>
|
|
10
|
+
* **Limit:** 1 min
|
|
11
|
+
*/
|
|
9
12
|
phoneNumbers: string[];
|
|
10
13
|
}
|
|
@@ -5,6 +5,9 @@
|
|
|
5
5
|
* }
|
|
6
6
|
*/
|
|
7
7
|
export interface GetWebhookParams {
|
|
8
|
-
/**
|
|
8
|
+
/**
|
|
9
|
+
* List of URLs or phone numbers in E.164 format that the webhook is attached to. <br><br>
|
|
10
|
+
* **Limit:** 1 min
|
|
11
|
+
*/
|
|
9
12
|
identifiers: string[];
|
|
10
13
|
}
|
|
@@ -12,9 +12,15 @@ export interface MessageEventRcsCardsContent {
|
|
|
12
12
|
* To get the message details, use the [GET /messages/{id}](/api-reference/messages/get) endpoint.
|
|
13
13
|
*/
|
|
14
14
|
id: string;
|
|
15
|
-
/**
|
|
15
|
+
/**
|
|
16
|
+
* Collection of cards attached to the message. <br><br>
|
|
17
|
+
* **Limit:** 1 to 10
|
|
18
|
+
*/
|
|
16
19
|
cards: MessageEventRcsCardsContent.Cards.Item[];
|
|
17
|
-
/**
|
|
20
|
+
/**
|
|
21
|
+
* List of interactive quick reply buttons in the message. <br><br>
|
|
22
|
+
* **Limit:** 10 max
|
|
23
|
+
*/
|
|
18
24
|
quickReplies: Pinnacle.RichButton[];
|
|
19
25
|
}
|
|
20
26
|
export declare namespace MessageEventRcsCardsContent {
|
|
@@ -24,7 +30,10 @@ export declare namespace MessageEventRcsCardsContent {
|
|
|
24
30
|
* Individual card containing title, optional media, and action buttons.
|
|
25
31
|
*/
|
|
26
32
|
interface Item {
|
|
27
|
-
/**
|
|
33
|
+
/**
|
|
34
|
+
* Action buttons attached to the card. <br><br>
|
|
35
|
+
* **Limit:** 4 max
|
|
36
|
+
*/
|
|
28
37
|
buttons: Pinnacle.RichButton[];
|
|
29
38
|
media?: Pinnacle.RcsMediaDetailsContent;
|
|
30
39
|
/** Secondary text displayed below the title for additional context. */
|
|
@@ -14,6 +14,9 @@ export interface MessageEventRcsMediaContent {
|
|
|
14
14
|
id: string;
|
|
15
15
|
/** URL of the media file. */
|
|
16
16
|
media: string;
|
|
17
|
-
/**
|
|
17
|
+
/**
|
|
18
|
+
* List of interactive quick reply buttons in the message. <br><br>
|
|
19
|
+
* **Limit:** 10 max
|
|
20
|
+
*/
|
|
18
21
|
quickReplies: Pinnacle.RichButton[];
|
|
19
22
|
}
|
|
@@ -10,7 +10,10 @@ export interface MessageEventRcsTextContent {
|
|
|
10
10
|
* To get the message details, use the [GET /messages/{id}](/api-reference/messages/get) endpoint.
|
|
11
11
|
*/
|
|
12
12
|
id: string;
|
|
13
|
-
/**
|
|
13
|
+
/**
|
|
14
|
+
* List of interactive quick reply buttons in the message. <br><br>
|
|
15
|
+
* **Limit:** 10 max
|
|
16
|
+
*/
|
|
14
17
|
quickReplies: Pinnacle.RichButton[];
|
|
15
18
|
/** Text content of the RCS message. */
|
|
16
19
|
text: string;
|
|
@@ -5,9 +5,15 @@ import type * as Pinnacle from "../index.js";
|
|
|
5
5
|
* See (supported file types)[https://app.pinnacle.sh/supported-file-types?type=RCS-CARD].
|
|
6
6
|
*/
|
|
7
7
|
export interface RcsCardsContent {
|
|
8
|
-
/**
|
|
8
|
+
/**
|
|
9
|
+
* Collection of cards attached to the message. <br><br>
|
|
10
|
+
* **Limit:** 1 to 10
|
|
11
|
+
*/
|
|
9
12
|
cards: RcsCardsContent.Cards.Item[];
|
|
10
|
-
/**
|
|
13
|
+
/**
|
|
14
|
+
* List of interactive quick reply buttons in the message. <br><br>
|
|
15
|
+
* **Limit:** 10 max
|
|
16
|
+
*/
|
|
11
17
|
quickReplies: Pinnacle.RichButton[];
|
|
12
18
|
}
|
|
13
19
|
export declare namespace RcsCardsContent {
|
|
@@ -17,7 +23,10 @@ export declare namespace RcsCardsContent {
|
|
|
17
23
|
* Individual card containing title, optional media, and action buttons.
|
|
18
24
|
*/
|
|
19
25
|
interface Item {
|
|
20
|
-
/**
|
|
26
|
+
/**
|
|
27
|
+
* While buttons resemble quick replies, they remain on screen after being clicked and are card-specific. <br><br>
|
|
28
|
+
* **Limit:** 4 max
|
|
29
|
+
*/
|
|
21
30
|
buttons: Pinnacle.RichButton[];
|
|
22
31
|
media?: Pinnacle.RcsMediaDetailsContent;
|
|
23
32
|
/** Secondary text displayed below the title for additional context. */
|
|
@@ -6,6 +6,9 @@ import type * as Pinnacle from "../index.js";
|
|
|
6
6
|
*/
|
|
7
7
|
export interface RcsMediaContent {
|
|
8
8
|
media: Pinnacle.RcsMediaDetailsContent;
|
|
9
|
-
/**
|
|
9
|
+
/**
|
|
10
|
+
* List of interactive quick reply buttons in the message. <br><br>
|
|
11
|
+
* **Limit:** 10 max
|
|
12
|
+
*/
|
|
10
13
|
quickReplies: Pinnacle.RichButton[];
|
|
11
14
|
}
|
|
@@ -5,9 +5,15 @@ import type * as Pinnacle from "../index.js";
|
|
|
5
5
|
* See (supported file types)[https://app.pinnacle.sh/supported-file-types?type=RCS-CARD].
|
|
6
6
|
*/
|
|
7
7
|
export interface RichCards {
|
|
8
|
-
/**
|
|
8
|
+
/**
|
|
9
|
+
* Collection of cards attached to the message. <br><br>
|
|
10
|
+
* **Limit:** 1 to 10
|
|
11
|
+
*/
|
|
9
12
|
cards: RichCards.Cards.Item[];
|
|
10
|
-
/**
|
|
13
|
+
/**
|
|
14
|
+
* List of interactive quick reply buttons in the message. <br><br>
|
|
15
|
+
* **Limit:** 10 max
|
|
16
|
+
*/
|
|
11
17
|
quickReplies: Pinnacle.RichButton[];
|
|
12
18
|
}
|
|
13
19
|
export declare namespace RichCards {
|
|
@@ -17,7 +23,10 @@ export declare namespace RichCards {
|
|
|
17
23
|
* Individual card containing title, optional media, and action buttons.
|
|
18
24
|
*/
|
|
19
25
|
interface Item {
|
|
20
|
-
/**
|
|
26
|
+
/**
|
|
27
|
+
* While buttons resemble quick replies, they remain on screen after being clicked and are card-specific. <br><br>
|
|
28
|
+
* **Limit:** 4 max
|
|
29
|
+
*/
|
|
21
30
|
buttons: Pinnacle.RichButton[];
|
|
22
31
|
/** Media file URLs to send. */
|
|
23
32
|
media?: string;
|
|
@@ -6,6 +6,9 @@ export interface RichMediaMessage extends Pinnacle.BaseRichMessage {
|
|
|
6
6
|
* See [supported media types](https://app.pinnacle.sh/supported-file-types?type=RCS-MEDIA).
|
|
7
7
|
*/
|
|
8
8
|
media: string;
|
|
9
|
-
/**
|
|
9
|
+
/**
|
|
10
|
+
* List of interactive quick reply buttons in the message. <br>
|
|
11
|
+
* `≤10`
|
|
12
|
+
*/
|
|
10
13
|
quickReplies: Pinnacle.RichButton[];
|
|
11
14
|
}
|
|
@@ -3,7 +3,10 @@ import type * as Pinnacle from "../index.js";
|
|
|
3
3
|
* Message containing longer text content with optional quick reply buttons.
|
|
4
4
|
*/
|
|
5
5
|
export interface RichText {
|
|
6
|
-
/**
|
|
6
|
+
/**
|
|
7
|
+
* List of interactive quick reply buttons in the message. <br><br>
|
|
8
|
+
* **Limit:** 10 max
|
|
9
|
+
*/
|
|
7
10
|
quickReplies: Pinnacle.RichButton[];
|
|
8
11
|
/** Text content of the RCS message. */
|
|
9
12
|
text: string;
|
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.10";
|
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.10",
|
|
21
|
+
"User-Agent": "rcs-js/2.0.10",
|
|
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) });
|
package/dist/esm/api/resources/audiences/resources/contacts/client/requests/AddContactsParams.d.mts
CHANGED
|
@@ -8,6 +8,9 @@
|
|
|
8
8
|
export interface AddContactsParams {
|
|
9
9
|
/** Audience ID. This identifier is a string that always begins with the prefix `aud_`, for example: `aud_abc123`. */
|
|
10
10
|
id: string;
|
|
11
|
-
/**
|
|
11
|
+
/**
|
|
12
|
+
* Array of phone numbers (E.164 format) or contact IDs. <br><br>
|
|
13
|
+
* **Limit:** 1 min
|
|
14
|
+
*/
|
|
12
15
|
contacts: string[];
|
|
13
16
|
}
|
|
@@ -8,6 +8,9 @@
|
|
|
8
8
|
export interface RemoveContactsParams {
|
|
9
9
|
/** Audience ID. This identifier is a string that always begins with the prefix `aud_`, for example: `aud_abc123`. */
|
|
10
10
|
id: string;
|
|
11
|
-
/**
|
|
11
|
+
/**
|
|
12
|
+
* Array of phone numbers (E.164 format) or contact IDs. <br><br>
|
|
13
|
+
* **Limit:** 1 min
|
|
14
|
+
*/
|
|
12
15
|
contacts: string[];
|
|
13
16
|
}
|
package/dist/esm/api/resources/campaigns/resources/dlc/client/requests/UpsertDlcCampaignParams.d.mts
CHANGED
|
@@ -59,7 +59,10 @@ export interface UpsertDlcCampaignParams {
|
|
|
59
59
|
name?: string;
|
|
60
60
|
/** Campaign configuration options. */
|
|
61
61
|
options?: UpsertDlcCampaignParams.Options;
|
|
62
|
-
/**
|
|
62
|
+
/**
|
|
63
|
+
* Example messages for the campaign. <br><br>
|
|
64
|
+
* **Limit:** 1 to 5
|
|
65
|
+
*/
|
|
63
66
|
sampleMessages?: string[];
|
|
64
67
|
/** Use case for the campaign. */
|
|
65
68
|
useCase?: UpsertDlcCampaignParams.UseCase;
|
package/dist/esm/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.mts
CHANGED
|
@@ -67,7 +67,10 @@ export interface UpsertRcsCampaignParams {
|
|
|
67
67
|
brand?: string;
|
|
68
68
|
/** Unique identifier for the campaign. */
|
|
69
69
|
campaignId?: string;
|
|
70
|
-
/**
|
|
70
|
+
/**
|
|
71
|
+
* List of what the agent might say to users. <br><br>
|
|
72
|
+
* **Limit:** 1 to 5
|
|
73
|
+
*/
|
|
71
74
|
expectedAgentResponses?: string[];
|
|
72
75
|
/** Legal documentation links. */
|
|
73
76
|
links?: UpsertRcsCampaignParams.Links;
|
|
@@ -113,7 +116,10 @@ export declare namespace UpsertRcsCampaignParams {
|
|
|
113
116
|
* Be clear, concise, user-focused, and highlight what the agent does and the benefits it provides for the user.
|
|
114
117
|
*/
|
|
115
118
|
description?: string;
|
|
116
|
-
/**
|
|
119
|
+
/**
|
|
120
|
+
* List of emails. <br><br>
|
|
121
|
+
* **Limit:** 1 to 3
|
|
122
|
+
*/
|
|
117
123
|
emails?: Agent.Emails.Item[];
|
|
118
124
|
/** Link to the agent's hero. Hero must be an image file with dimensions 1440x448px. */
|
|
119
125
|
heroUrl?: string;
|
|
@@ -125,9 +131,15 @@ export declare namespace UpsertRcsCampaignParams {
|
|
|
125
131
|
* Recommended format: [Brand Name] - [1-2 word description of purpose]
|
|
126
132
|
*/
|
|
127
133
|
name?: string;
|
|
128
|
-
/**
|
|
134
|
+
/**
|
|
135
|
+
* List of phone numbers. <br><br>
|
|
136
|
+
* **Limit:** 1 to 3
|
|
137
|
+
*/
|
|
129
138
|
phones?: Agent.Phones.Item[];
|
|
130
|
-
/**
|
|
139
|
+
/**
|
|
140
|
+
* List of urls. <br><br>
|
|
141
|
+
* **Limit:** 1 to 3
|
|
142
|
+
*/
|
|
131
143
|
websites?: Agent.Websites.Item[];
|
|
132
144
|
}
|
|
133
145
|
namespace Agent {
|
|
@@ -149,7 +149,7 @@ export class Rcs {
|
|
|
149
149
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
150
150
|
const _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
151
151
|
const _response = yield core.fetcher({
|
|
152
|
-
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PinnacleEnvironment.Default, "messages/typing"),
|
|
152
|
+
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PinnacleEnvironment.Default, "messages/send/typing"),
|
|
153
153
|
method: "POST",
|
|
154
154
|
headers: _headers,
|
|
155
155
|
contentType: "application/json",
|
|
@@ -193,7 +193,7 @@ export class Rcs {
|
|
|
193
193
|
rawResponse: _response.rawResponse,
|
|
194
194
|
});
|
|
195
195
|
case "timeout":
|
|
196
|
-
throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /messages/typing.");
|
|
196
|
+
throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /messages/send/typing.");
|
|
197
197
|
case "unknown":
|
|
198
198
|
throw new errors.PinnacleError({
|
|
199
199
|
message: _response.error.errorMessage,
|
|
@@ -8,7 +8,10 @@ import type * as Pinnacle from "../../../../../../index.mjs";
|
|
|
8
8
|
* }
|
|
9
9
|
*/
|
|
10
10
|
export interface AttachCampaignParams {
|
|
11
|
-
/**
|
|
11
|
+
/**
|
|
12
|
+
* List of phone number (E.164 format). <br><br>
|
|
13
|
+
* **Limit:** 1 to 10
|
|
14
|
+
*/
|
|
12
15
|
phones: string[];
|
|
13
16
|
campaignType: Pinnacle.MessagingProfileEnum;
|
|
14
17
|
/**
|
|
@@ -5,6 +5,9 @@
|
|
|
5
5
|
* }
|
|
6
6
|
*/
|
|
7
7
|
export interface RcsCapabilitiesQuery {
|
|
8
|
-
/**
|
|
8
|
+
/**
|
|
9
|
+
* List of phone numbers to check RCS capabilities for (E.164 format). <br><br>
|
|
10
|
+
* **Limit:** 1 min
|
|
11
|
+
*/
|
|
9
12
|
phoneNumbers: string[];
|
|
10
13
|
}
|
|
@@ -5,6 +5,9 @@
|
|
|
5
5
|
* }
|
|
6
6
|
*/
|
|
7
7
|
export interface GetWebhookParams {
|
|
8
|
-
/**
|
|
8
|
+
/**
|
|
9
|
+
* List of URLs or phone numbers in E.164 format that the webhook is attached to. <br><br>
|
|
10
|
+
* **Limit:** 1 min
|
|
11
|
+
*/
|
|
9
12
|
identifiers: string[];
|
|
10
13
|
}
|
|
@@ -12,9 +12,15 @@ export interface MessageEventRcsCardsContent {
|
|
|
12
12
|
* To get the message details, use the [GET /messages/{id}](/api-reference/messages/get) endpoint.
|
|
13
13
|
*/
|
|
14
14
|
id: string;
|
|
15
|
-
/**
|
|
15
|
+
/**
|
|
16
|
+
* Collection of cards attached to the message. <br><br>
|
|
17
|
+
* **Limit:** 1 to 10
|
|
18
|
+
*/
|
|
16
19
|
cards: MessageEventRcsCardsContent.Cards.Item[];
|
|
17
|
-
/**
|
|
20
|
+
/**
|
|
21
|
+
* List of interactive quick reply buttons in the message. <br><br>
|
|
22
|
+
* **Limit:** 10 max
|
|
23
|
+
*/
|
|
18
24
|
quickReplies: Pinnacle.RichButton[];
|
|
19
25
|
}
|
|
20
26
|
export declare namespace MessageEventRcsCardsContent {
|
|
@@ -24,7 +30,10 @@ export declare namespace MessageEventRcsCardsContent {
|
|
|
24
30
|
* Individual card containing title, optional media, and action buttons.
|
|
25
31
|
*/
|
|
26
32
|
interface Item {
|
|
27
|
-
/**
|
|
33
|
+
/**
|
|
34
|
+
* Action buttons attached to the card. <br><br>
|
|
35
|
+
* **Limit:** 4 max
|
|
36
|
+
*/
|
|
28
37
|
buttons: Pinnacle.RichButton[];
|
|
29
38
|
media?: Pinnacle.RcsMediaDetailsContent;
|
|
30
39
|
/** Secondary text displayed below the title for additional context. */
|
|
@@ -14,6 +14,9 @@ export interface MessageEventRcsMediaContent {
|
|
|
14
14
|
id: string;
|
|
15
15
|
/** URL of the media file. */
|
|
16
16
|
media: string;
|
|
17
|
-
/**
|
|
17
|
+
/**
|
|
18
|
+
* List of interactive quick reply buttons in the message. <br><br>
|
|
19
|
+
* **Limit:** 10 max
|
|
20
|
+
*/
|
|
18
21
|
quickReplies: Pinnacle.RichButton[];
|
|
19
22
|
}
|
|
@@ -10,7 +10,10 @@ export interface MessageEventRcsTextContent {
|
|
|
10
10
|
* To get the message details, use the [GET /messages/{id}](/api-reference/messages/get) endpoint.
|
|
11
11
|
*/
|
|
12
12
|
id: string;
|
|
13
|
-
/**
|
|
13
|
+
/**
|
|
14
|
+
* List of interactive quick reply buttons in the message. <br><br>
|
|
15
|
+
* **Limit:** 10 max
|
|
16
|
+
*/
|
|
14
17
|
quickReplies: Pinnacle.RichButton[];
|
|
15
18
|
/** Text content of the RCS message. */
|
|
16
19
|
text: string;
|
|
@@ -5,9 +5,15 @@ import type * as Pinnacle from "../index.mjs";
|
|
|
5
5
|
* See (supported file types)[https://app.pinnacle.sh/supported-file-types?type=RCS-CARD].
|
|
6
6
|
*/
|
|
7
7
|
export interface RcsCardsContent {
|
|
8
|
-
/**
|
|
8
|
+
/**
|
|
9
|
+
* Collection of cards attached to the message. <br><br>
|
|
10
|
+
* **Limit:** 1 to 10
|
|
11
|
+
*/
|
|
9
12
|
cards: RcsCardsContent.Cards.Item[];
|
|
10
|
-
/**
|
|
13
|
+
/**
|
|
14
|
+
* List of interactive quick reply buttons in the message. <br><br>
|
|
15
|
+
* **Limit:** 10 max
|
|
16
|
+
*/
|
|
11
17
|
quickReplies: Pinnacle.RichButton[];
|
|
12
18
|
}
|
|
13
19
|
export declare namespace RcsCardsContent {
|
|
@@ -17,7 +23,10 @@ export declare namespace RcsCardsContent {
|
|
|
17
23
|
* Individual card containing title, optional media, and action buttons.
|
|
18
24
|
*/
|
|
19
25
|
interface Item {
|
|
20
|
-
/**
|
|
26
|
+
/**
|
|
27
|
+
* While buttons resemble quick replies, they remain on screen after being clicked and are card-specific. <br><br>
|
|
28
|
+
* **Limit:** 4 max
|
|
29
|
+
*/
|
|
21
30
|
buttons: Pinnacle.RichButton[];
|
|
22
31
|
media?: Pinnacle.RcsMediaDetailsContent;
|
|
23
32
|
/** Secondary text displayed below the title for additional context. */
|
|
@@ -6,6 +6,9 @@ import type * as Pinnacle from "../index.mjs";
|
|
|
6
6
|
*/
|
|
7
7
|
export interface RcsMediaContent {
|
|
8
8
|
media: Pinnacle.RcsMediaDetailsContent;
|
|
9
|
-
/**
|
|
9
|
+
/**
|
|
10
|
+
* List of interactive quick reply buttons in the message. <br><br>
|
|
11
|
+
* **Limit:** 10 max
|
|
12
|
+
*/
|
|
10
13
|
quickReplies: Pinnacle.RichButton[];
|
|
11
14
|
}
|
|
@@ -5,9 +5,15 @@ import type * as Pinnacle from "../index.mjs";
|
|
|
5
5
|
* See (supported file types)[https://app.pinnacle.sh/supported-file-types?type=RCS-CARD].
|
|
6
6
|
*/
|
|
7
7
|
export interface RichCards {
|
|
8
|
-
/**
|
|
8
|
+
/**
|
|
9
|
+
* Collection of cards attached to the message. <br><br>
|
|
10
|
+
* **Limit:** 1 to 10
|
|
11
|
+
*/
|
|
9
12
|
cards: RichCards.Cards.Item[];
|
|
10
|
-
/**
|
|
13
|
+
/**
|
|
14
|
+
* List of interactive quick reply buttons in the message. <br><br>
|
|
15
|
+
* **Limit:** 10 max
|
|
16
|
+
*/
|
|
11
17
|
quickReplies: Pinnacle.RichButton[];
|
|
12
18
|
}
|
|
13
19
|
export declare namespace RichCards {
|
|
@@ -17,7 +23,10 @@ export declare namespace RichCards {
|
|
|
17
23
|
* Individual card containing title, optional media, and action buttons.
|
|
18
24
|
*/
|
|
19
25
|
interface Item {
|
|
20
|
-
/**
|
|
26
|
+
/**
|
|
27
|
+
* While buttons resemble quick replies, they remain on screen after being clicked and are card-specific. <br><br>
|
|
28
|
+
* **Limit:** 4 max
|
|
29
|
+
*/
|
|
21
30
|
buttons: Pinnacle.RichButton[];
|
|
22
31
|
/** Media file URLs to send. */
|
|
23
32
|
media?: string;
|
|
@@ -6,6 +6,9 @@ export interface RichMediaMessage extends Pinnacle.BaseRichMessage {
|
|
|
6
6
|
* See [supported media types](https://app.pinnacle.sh/supported-file-types?type=RCS-MEDIA).
|
|
7
7
|
*/
|
|
8
8
|
media: string;
|
|
9
|
-
/**
|
|
9
|
+
/**
|
|
10
|
+
* List of interactive quick reply buttons in the message. <br>
|
|
11
|
+
* `≤10`
|
|
12
|
+
*/
|
|
10
13
|
quickReplies: Pinnacle.RichButton[];
|
|
11
14
|
}
|
|
@@ -3,7 +3,10 @@ import type * as Pinnacle from "../index.mjs";
|
|
|
3
3
|
* Message containing longer text content with optional quick reply buttons.
|
|
4
4
|
*/
|
|
5
5
|
export interface RichText {
|
|
6
|
-
/**
|
|
6
|
+
/**
|
|
7
|
+
* List of interactive quick reply buttons in the message. <br><br>
|
|
8
|
+
* **Limit:** 10 max
|
|
9
|
+
*/
|
|
7
10
|
quickReplies: Pinnacle.RichButton[];
|
|
8
11
|
/** Text content of the RCS message. */
|
|
9
12
|
text: string;
|
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.10";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "2.0.
|
|
1
|
+
export const SDK_VERSION = "2.0.10";
|