rcs-js 2.0.0-rc.1 → 2.0.0-rc.11
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.d.ts +3 -3
- package/dist/cjs/Client.js +11 -11
- package/dist/cjs/api/resources/brands/client/Client.d.ts +2 -0
- package/dist/cjs/api/resources/brands/client/Client.js +6 -0
- package/dist/cjs/api/resources/brands/client/requests/UpsertBrandParams.d.ts +1 -1
- package/dist/cjs/api/resources/campaigns/resources/dlc/client/Client.d.ts +6 -6
- package/dist/cjs/api/resources/campaigns/resources/dlc/client/Client.js +6 -6
- package/dist/cjs/api/resources/campaigns/resources/rcs/client/Client.d.ts +1 -0
- package/dist/cjs/api/resources/campaigns/resources/rcs/client/Client.js +1 -0
- package/dist/cjs/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.ts +5 -2
- package/dist/cjs/api/resources/index.d.ts +2 -1
- package/dist/cjs/api/resources/index.js +3 -2
- package/dist/cjs/api/resources/messages/client/Client.d.ts +6 -3
- package/dist/cjs/api/resources/messages/client/Client.js +12 -3
- package/dist/cjs/api/resources/messages/resources/index.d.ts +6 -3
- package/dist/cjs/api/resources/messages/resources/index.js +7 -4
- package/dist/cjs/api/resources/messages/resources/mms/client/Client.d.ts +27 -0
- package/dist/cjs/api/resources/messages/resources/mms/client/Client.js +86 -0
- package/dist/cjs/api/resources/messages/resources/mms/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/messages/resources/mms/client/index.js +15 -0
- package/dist/cjs/api/resources/messages/resources/{send → mms}/client/requests/index.d.ts +0 -1
- package/dist/cjs/api/resources/messages/resources/mms/index.d.ts +1 -0
- package/dist/cjs/api/resources/messages/resources/mms/index.js +1 -0
- package/dist/cjs/api/resources/messages/resources/{send/types/SendRcsResponse.d.ts → mms/types/MmsSendResponse.d.ts} +1 -1
- package/dist/cjs/api/resources/messages/resources/mms/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/{message → messages/resources/mms/types}/index.js +1 -2
- package/dist/cjs/api/resources/messages/resources/rcs/client/Client.d.ts +29 -0
- package/dist/cjs/api/resources/messages/resources/rcs/client/Client.js +88 -0
- package/dist/cjs/api/resources/messages/resources/rcs/index.d.ts +1 -0
- package/dist/cjs/api/resources/messages/resources/rcs/index.js +1 -0
- package/dist/cjs/api/resources/messages/resources/{send/types/SendSmsResponse.d.ts → rcs/types/RcsSendResponse.d.ts} +1 -1
- package/dist/cjs/api/resources/messages/resources/rcs/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/messages/resources/rcs/types/index.js +17 -0
- package/dist/cjs/api/resources/{message → messages}/resources/sms/client/Client.d.ts +23 -1
- package/dist/cjs/api/resources/{message → messages}/resources/sms/client/Client.js +82 -1
- package/dist/cjs/api/resources/messages/resources/{send → sms}/client/requests/Sms.d.ts +2 -2
- package/dist/cjs/api/resources/messages/resources/sms/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/messages/resources/{send/types/SendMmsResponse.d.ts → sms/types/SmsSendResponse.d.ts} +1 -1
- package/dist/cjs/api/resources/messages/resources/sms/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/messages/resources/sms/types/index.js +17 -0
- package/dist/cjs/api/resources/phoneNumbers/client/requests/SearchPhoneNumberParams.d.ts +2 -2
- package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/Client.d.ts +2 -0
- package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/Client.js +6 -0
- package/dist/cjs/api/resources/phoneNumbers/resources/webhook/client/Client.d.ts +1 -0
- package/dist/cjs/api/resources/phoneNumbers/resources/webhook/client/Client.js +3 -0
- package/dist/cjs/api/resources/rcs/client/Client.d.ts +121 -0
- package/dist/cjs/api/resources/{messages/resources/send → rcs}/client/Client.js +76 -67
- package/dist/cjs/api/resources/rcs/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/rcs/client/index.js +17 -0
- package/dist/cjs/api/resources/rcs/client/requests/RcsCapabilitiesQuery.d.ts +13 -0
- package/dist/cjs/api/resources/rcs/client/requests/RcsLinkRequest.d.ts +22 -0
- package/dist/cjs/api/resources/rcs/client/requests/RcsWhitelistRequest.d.ts +16 -0
- package/dist/cjs/api/resources/rcs/client/requests/index.d.ts +3 -0
- package/dist/cjs/api/resources/status/resources/get/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/status/resources/get/client/Client.js +2 -2
- package/dist/cjs/api/types/ConversationList.d.ts +4 -4
- package/dist/cjs/api/types/DlcCampaignStatus.d.ts +2 -2
- package/dist/cjs/api/types/ExtendedRcsCampaign.d.ts +4 -2
- package/dist/cjs/api/types/Rcs.d.ts +3 -3
- package/dist/cjs/api/types/RcsCampaign.d.ts +4 -2
- package/dist/cjs/api/types/RcsCapabilitiesResult.d.ts +8 -0
- package/dist/cjs/api/types/RcsCapability.d.ts +36 -0
- package/dist/cjs/api/types/RcsCards.d.ts +2 -2
- package/dist/cjs/api/types/RcsCardsContent.d.ts +2 -2
- package/dist/cjs/api/types/RcsLinkResult.d.ts +13 -0
- package/dist/cjs/api/types/RcsLinkResult.js +5 -0
- package/dist/cjs/api/types/RcsMediaContent.d.ts +1 -1
- package/dist/cjs/api/types/RcsTextContent.d.ts +1 -1
- package/dist/cjs/api/types/RcsValidateContent.d.ts +1 -0
- package/dist/cjs/api/types/RcsWhitelistResponse.d.ts +10 -0
- package/dist/cjs/api/types/RcsWhitelistResponse.js +5 -0
- package/dist/cjs/api/types/{RcsButtonContent.d.ts → RichButton.d.ts} +2 -2
- package/dist/cjs/api/types/RichButton.js +5 -0
- package/dist/cjs/api/types/{RcsCard.d.ts → RichCardsMessage.d.ts} +1 -1
- package/dist/cjs/api/types/RichCardsMessage.js +5 -0
- package/dist/cjs/api/types/{RcsMedia.d.ts → RichMediaMessage.d.ts} +2 -2
- package/dist/cjs/api/types/RichMediaMessage.js +5 -0
- package/dist/cjs/api/types/{RcsText.d.ts → RichTextMessage.d.ts} +1 -1
- package/dist/cjs/api/types/RichTextMessage.js +5 -0
- package/dist/{esm/api/types/NullableContact.d.mts → cjs/api/types/UpsertContact.d.ts} +1 -1
- package/dist/cjs/api/types/UpsertContact.js +5 -0
- package/dist/cjs/api/types/index.d.ts +9 -5
- package/dist/cjs/api/types/index.js +9 -5
- package/dist/cjs/index.d.ts +4 -4
- package/dist/cjs/index.js +8 -8
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.d.mts +3 -3
- package/dist/esm/Client.mjs +7 -7
- package/dist/esm/api/resources/brands/client/Client.d.mts +2 -0
- package/dist/esm/api/resources/brands/client/Client.mjs +6 -0
- package/dist/esm/api/resources/brands/client/requests/UpsertBrandParams.d.mts +1 -1
- package/dist/esm/api/resources/campaigns/resources/dlc/client/Client.d.mts +6 -6
- package/dist/esm/api/resources/campaigns/resources/dlc/client/Client.mjs +6 -6
- package/dist/esm/api/resources/campaigns/resources/rcs/client/Client.d.mts +1 -0
- package/dist/esm/api/resources/campaigns/resources/rcs/client/Client.mjs +1 -0
- package/dist/esm/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.mts +5 -2
- package/dist/esm/api/resources/index.d.mts +2 -1
- package/dist/esm/api/resources/index.mjs +2 -1
- package/dist/esm/api/resources/messages/client/Client.d.mts +6 -3
- package/dist/esm/api/resources/messages/client/Client.mjs +12 -3
- package/dist/esm/api/resources/messages/resources/index.d.mts +6 -3
- package/dist/esm/api/resources/messages/resources/index.mjs +6 -3
- package/dist/esm/api/resources/messages/resources/mms/client/Client.d.mts +27 -0
- package/dist/esm/api/resources/messages/resources/mms/client/Client.mjs +86 -0
- package/dist/esm/api/resources/messages/resources/mms/client/index.d.mts +1 -0
- package/dist/esm/api/resources/messages/resources/mms/client/index.mjs +1 -1
- package/dist/esm/api/resources/messages/resources/{send → mms}/client/requests/index.d.mts +0 -1
- package/dist/esm/api/resources/messages/resources/mms/index.d.mts +1 -0
- package/dist/esm/api/resources/messages/resources/mms/index.mjs +1 -0
- package/dist/esm/api/resources/messages/resources/{send/types/SendRcsResponse.d.mts → mms/types/MmsSendResponse.d.mts} +1 -1
- package/dist/esm/api/resources/messages/resources/mms/types/index.d.mts +1 -0
- package/dist/esm/api/resources/messages/resources/mms/types/index.mjs +1 -0
- package/dist/esm/api/resources/messages/resources/rcs/client/Client.d.mts +29 -0
- package/dist/esm/api/resources/messages/resources/rcs/client/Client.mjs +88 -0
- package/dist/esm/api/resources/messages/resources/rcs/index.d.mts +1 -0
- package/dist/esm/api/resources/messages/resources/rcs/index.mjs +1 -0
- package/dist/esm/api/resources/messages/resources/{send/types/SendSmsResponse.d.mts → rcs/types/RcsSendResponse.d.mts} +1 -1
- package/dist/esm/api/resources/messages/resources/rcs/types/index.d.mts +1 -0
- package/dist/esm/api/resources/messages/resources/rcs/types/index.mjs +1 -0
- package/dist/esm/api/resources/{message → messages}/resources/sms/client/Client.d.mts +23 -1
- package/dist/esm/api/resources/{message → messages}/resources/sms/client/Client.mjs +82 -1
- package/dist/esm/api/resources/messages/resources/{send → sms}/client/requests/Sms.d.mts +2 -2
- package/dist/esm/api/resources/messages/resources/sms/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/messages/resources/{send/types/SendMmsResponse.d.mts → sms/types/SmsSendResponse.d.mts} +1 -1
- package/dist/esm/api/resources/messages/resources/sms/types/index.d.mts +1 -0
- package/dist/esm/api/resources/messages/resources/sms/types/index.mjs +1 -0
- package/dist/esm/api/resources/phoneNumbers/client/requests/SearchPhoneNumberParams.d.mts +2 -2
- package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/Client.d.mts +2 -0
- package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/Client.mjs +6 -0
- package/dist/esm/api/resources/phoneNumbers/resources/webhook/client/Client.d.mts +1 -0
- package/dist/esm/api/resources/phoneNumbers/resources/webhook/client/Client.mjs +3 -0
- package/dist/esm/api/resources/rcs/client/Client.d.mts +121 -0
- package/dist/esm/api/resources/{messages/resources/send → rcs}/client/Client.mjs +74 -65
- package/dist/esm/api/resources/rcs/client/index.d.mts +2 -0
- package/dist/esm/api/resources/rcs/client/index.mjs +1 -0
- package/dist/esm/api/resources/rcs/client/requests/RcsCapabilitiesQuery.d.mts +13 -0
- package/dist/esm/api/resources/rcs/client/requests/RcsLinkRequest.d.mts +22 -0
- package/dist/esm/api/resources/rcs/client/requests/RcsWhitelistRequest.d.mts +16 -0
- package/dist/esm/api/resources/rcs/client/requests/index.d.mts +3 -0
- package/dist/esm/api/resources/status/resources/get/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/status/resources/get/client/Client.mjs +2 -2
- package/dist/esm/api/types/ConversationList.d.mts +4 -4
- package/dist/esm/api/types/DlcCampaignStatus.d.mts +2 -2
- package/dist/esm/api/types/ExtendedRcsCampaign.d.mts +4 -2
- package/dist/esm/api/types/Rcs.d.mts +3 -3
- package/dist/esm/api/types/RcsCampaign.d.mts +4 -2
- package/dist/esm/api/types/RcsCapabilitiesResult.d.mts +8 -0
- package/dist/esm/api/types/RcsCapability.d.mts +36 -0
- package/dist/esm/api/types/RcsCards.d.mts +2 -2
- package/dist/esm/api/types/RcsCardsContent.d.mts +2 -2
- package/dist/esm/api/types/RcsLinkResult.d.mts +13 -0
- package/dist/esm/api/types/RcsLinkResult.mjs +4 -0
- package/dist/esm/api/types/RcsMediaContent.d.mts +1 -1
- package/dist/esm/api/types/RcsTextContent.d.mts +1 -1
- package/dist/esm/api/types/RcsValidateContent.d.mts +1 -0
- package/dist/esm/api/types/RcsWhitelistResponse.d.mts +10 -0
- package/dist/esm/api/types/RcsWhitelistResponse.mjs +4 -0
- package/dist/esm/api/types/{RcsButtonContent.d.mts → RichButton.d.mts} +2 -2
- package/dist/esm/api/types/RichButton.mjs +4 -0
- package/dist/esm/api/types/{RcsCard.d.mts → RichCardsMessage.d.mts} +1 -1
- package/dist/esm/api/types/RichCardsMessage.mjs +4 -0
- package/dist/esm/api/types/{RcsMedia.d.mts → RichMediaMessage.d.mts} +2 -2
- package/dist/esm/api/types/RichMediaMessage.mjs +4 -0
- package/dist/esm/api/types/{RcsText.d.mts → RichTextMessage.d.mts} +1 -1
- package/dist/esm/api/types/RichTextMessage.mjs +4 -0
- package/dist/{cjs/api/types/NullableContact.d.ts → esm/api/types/UpsertContact.d.mts} +1 -1
- package/dist/esm/api/types/UpsertContact.mjs +4 -0
- package/dist/esm/api/types/index.d.mts +9 -5
- package/dist/esm/api/types/index.mjs +9 -5
- package/dist/esm/index.d.mts +4 -4
- package/dist/esm/index.mjs +4 -4
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +284 -56
- package/dist/cjs/api/resources/message/client/Client.d.ts +0 -22
- package/dist/cjs/api/resources/message/client/Client.js +0 -17
- package/dist/cjs/api/resources/message/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/message/index.d.ts +0 -2
- package/dist/cjs/api/resources/message/resources/index.d.ts +0 -1
- package/dist/cjs/api/resources/message/resources/index.js +0 -37
- package/dist/cjs/api/resources/message/resources/sms/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/messages/resources/send/client/Client.d.ts +0 -110
- package/dist/cjs/api/resources/messages/resources/send/types/index.d.ts +0 -3
- package/dist/cjs/api/resources/messages/resources/send/types/index.js +0 -19
- package/dist/esm/api/resources/message/client/Client.d.mts +0 -22
- package/dist/esm/api/resources/message/client/Client.mjs +0 -13
- package/dist/esm/api/resources/message/client/index.d.mts +0 -1
- package/dist/esm/api/resources/message/index.d.mts +0 -2
- package/dist/esm/api/resources/message/index.mjs +0 -2
- package/dist/esm/api/resources/message/resources/index.d.mts +0 -1
- package/dist/esm/api/resources/message/resources/index.mjs +0 -1
- package/dist/esm/api/resources/message/resources/sms/client/index.d.mts +0 -1
- package/dist/esm/api/resources/messages/resources/send/client/Client.d.mts +0 -110
- package/dist/esm/api/resources/messages/resources/send/types/index.d.mts +0 -3
- package/dist/esm/api/resources/messages/resources/send/types/index.mjs +0 -3
- /package/dist/cjs/api/resources/messages/resources/{send → mms}/client/requests/Mms.d.ts +0 -0
- /package/dist/cjs/api/resources/messages/resources/{send → mms}/client/requests/Mms.js +0 -0
- /package/dist/cjs/api/resources/{message/client → messages/resources/mms/client/requests}/index.js +0 -0
- /package/dist/cjs/api/resources/messages/resources/{send/client/requests/Sms.js → mms/types/MmsSendResponse.js} +0 -0
- /package/dist/cjs/api/resources/messages/resources/{send/types/SendMmsResponse.js → rcs/types/RcsSendResponse.js} +0 -0
- /package/dist/cjs/api/resources/messages/resources/{send → sms}/client/index.d.ts +0 -0
- /package/dist/cjs/api/resources/messages/resources/{send → sms}/client/index.js +0 -0
- /package/dist/cjs/api/resources/messages/resources/{send/types/SendRcsResponse.js → sms/client/requests/Sms.js} +0 -0
- /package/dist/cjs/api/resources/{message/resources/sms/client → messages/resources/sms/client/requests}/index.js +0 -0
- /package/dist/cjs/api/resources/messages/resources/{send → sms}/index.d.ts +0 -0
- /package/dist/cjs/api/resources/messages/resources/{send → sms}/index.js +0 -0
- /package/dist/cjs/api/resources/messages/resources/{send/types/SendSmsResponse.js → sms/types/SmsSendResponse.js} +0 -0
- /package/dist/cjs/api/{types/NullableContact.js → resources/rcs/client/requests/RcsCapabilitiesQuery.js} +0 -0
- /package/dist/cjs/api/{types/RcsButtonContent.js → resources/rcs/client/requests/RcsLinkRequest.js} +0 -0
- /package/dist/cjs/api/{types/RcsCard.js → resources/rcs/client/requests/RcsWhitelistRequest.js} +0 -0
- /package/dist/cjs/api/resources/{messages/resources/send → rcs}/client/requests/index.js +0 -0
- /package/dist/cjs/api/resources/{message/resources/sms → rcs}/index.d.ts +0 -0
- /package/dist/cjs/api/resources/{message/resources/sms → rcs}/index.js +0 -0
- /package/dist/cjs/api/types/{RcsMedia.js → RcsCapabilitiesResult.js} +0 -0
- /package/dist/cjs/api/types/{RcsText.js → RcsCapability.js} +0 -0
- /package/dist/esm/api/resources/messages/resources/{send → mms}/client/requests/Mms.d.mts +0 -0
- /package/dist/esm/api/resources/messages/resources/{send → mms}/client/requests/Mms.mjs +0 -0
- /package/dist/esm/api/resources/{message/client → messages/resources/mms/client/requests}/index.mjs +0 -0
- /package/dist/esm/api/resources/messages/resources/{send/client/requests/Sms.mjs → mms/types/MmsSendResponse.mjs} +0 -0
- /package/dist/esm/api/resources/messages/resources/{send/types/SendMmsResponse.mjs → rcs/types/RcsSendResponse.mjs} +0 -0
- /package/dist/esm/api/resources/messages/resources/{send → sms}/client/index.d.mts +0 -0
- /package/dist/esm/api/resources/messages/resources/{send → sms}/client/index.mjs +0 -0
- /package/dist/esm/api/resources/messages/resources/{send/types/SendRcsResponse.mjs → sms/client/requests/Sms.mjs} +0 -0
- /package/dist/esm/api/resources/{message/resources/sms/client → messages/resources/sms/client/requests}/index.mjs +0 -0
- /package/dist/esm/api/resources/messages/resources/{send → sms}/index.d.mts +0 -0
- /package/dist/esm/api/resources/messages/resources/{send → sms}/index.mjs +0 -0
- /package/dist/esm/api/resources/messages/resources/{send/types/SendSmsResponse.mjs → sms/types/SmsSendResponse.mjs} +0 -0
- /package/dist/esm/api/{types/NullableContact.mjs → resources/rcs/client/requests/RcsCapabilitiesQuery.mjs} +0 -0
- /package/dist/esm/api/{types/RcsButtonContent.mjs → resources/rcs/client/requests/RcsLinkRequest.mjs} +0 -0
- /package/dist/esm/api/{types/RcsCard.mjs → resources/rcs/client/requests/RcsWhitelistRequest.mjs} +0 -0
- /package/dist/esm/api/resources/{messages/resources/send → rcs}/client/requests/index.mjs +0 -0
- /package/dist/esm/api/resources/{message/resources/sms → rcs}/index.d.mts +0 -0
- /package/dist/esm/api/resources/{message/resources/sms → rcs}/index.mjs +0 -0
- /package/dist/esm/api/types/{RcsMedia.mjs → RcsCapabilitiesResult.mjs} +0 -0
- /package/dist/esm/api/types/{RcsText.mjs → RcsCapability.mjs} +0 -0
|
@@ -45,44 +45,44 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
45
45
|
});
|
|
46
46
|
};
|
|
47
47
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
48
|
-
exports.
|
|
49
|
-
const environments = __importStar(require("
|
|
50
|
-
const core = __importStar(require("
|
|
51
|
-
const Pinnacle = __importStar(require("
|
|
52
|
-
const headers_js_1 = require("
|
|
53
|
-
const errors = __importStar(require("
|
|
54
|
-
class
|
|
48
|
+
exports.Rcs = void 0;
|
|
49
|
+
const environments = __importStar(require("../../../../environments.js"));
|
|
50
|
+
const core = __importStar(require("../../../../core/index.js"));
|
|
51
|
+
const Pinnacle = __importStar(require("../../../index.js"));
|
|
52
|
+
const headers_js_1 = require("../../../../core/headers.js");
|
|
53
|
+
const errors = __importStar(require("../../../../errors/index.js"));
|
|
54
|
+
class Rcs {
|
|
55
55
|
constructor(_options) {
|
|
56
56
|
this._options = _options;
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
59
|
-
*
|
|
59
|
+
* Check RCS capabilities for one or more phone numbers.
|
|
60
60
|
*
|
|
61
|
-
*
|
|
62
|
-
*
|
|
61
|
+
* This endpoint allows you to verify which RCS features (cards, buttons, etc.) are supported
|
|
62
|
+
* on specific phone numbers before sending RCS messages to them.
|
|
63
|
+
*
|
|
64
|
+
* @param {Pinnacle.RcsCapabilitiesQuery} request
|
|
65
|
+
* @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
|
|
63
66
|
*
|
|
64
67
|
* @throws {@link Pinnacle.BadRequestError}
|
|
65
68
|
* @throws {@link Pinnacle.UnauthorizedError}
|
|
66
|
-
* @throws {@link Pinnacle.PaymentRequiredError}
|
|
67
|
-
* @throws {@link Pinnacle.NotFoundError}
|
|
68
69
|
* @throws {@link Pinnacle.InternalServerError}
|
|
70
|
+
* @throws {@link Pinnacle.NotImplementedError}
|
|
69
71
|
*
|
|
70
72
|
* @example
|
|
71
|
-
* await client.
|
|
72
|
-
*
|
|
73
|
-
* text: "Hey! \uD83D\uDE02",
|
|
74
|
-
* to: "+14154746461"
|
|
73
|
+
* await client.rcs.getCapabilities({
|
|
74
|
+
* phoneNumbers: ["+12345678901", "+19876543210"]
|
|
75
75
|
* })
|
|
76
76
|
*/
|
|
77
|
-
|
|
78
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
77
|
+
getCapabilities(request, requestOptions) {
|
|
78
|
+
return core.HttpResponsePromise.fromPromise(this.__getCapabilities(request, requestOptions));
|
|
79
79
|
}
|
|
80
|
-
|
|
80
|
+
__getCapabilities(request, requestOptions) {
|
|
81
81
|
return __awaiter(this, void 0, void 0, function* () {
|
|
82
82
|
var _a, _b, _c;
|
|
83
83
|
let _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);
|
|
84
84
|
const _response = yield core.fetcher({
|
|
85
|
-
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, "
|
|
85
|
+
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, "rcs/capabilities"),
|
|
86
86
|
method: "POST",
|
|
87
87
|
headers: _headers,
|
|
88
88
|
contentType: "application/json",
|
|
@@ -102,12 +102,10 @@ class Send {
|
|
|
102
102
|
throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
|
|
103
103
|
case 401:
|
|
104
104
|
throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
105
|
-
case 402:
|
|
106
|
-
throw new Pinnacle.PaymentRequiredError(_response.error.body, _response.rawResponse);
|
|
107
|
-
case 404:
|
|
108
|
-
throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
|
|
109
105
|
case 500:
|
|
110
106
|
throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
|
|
107
|
+
case 501:
|
|
108
|
+
throw new Pinnacle.NotImplementedError(_response.error.body, _response.rawResponse);
|
|
111
109
|
default:
|
|
112
110
|
throw new errors.PinnacleError({
|
|
113
111
|
statusCode: _response.error.statusCode,
|
|
@@ -124,7 +122,7 @@ class Send {
|
|
|
124
122
|
rawResponse: _response.rawResponse,
|
|
125
123
|
});
|
|
126
124
|
case "timeout":
|
|
127
|
-
throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /
|
|
125
|
+
throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /rcs/capabilities.");
|
|
128
126
|
case "unknown":
|
|
129
127
|
throw new errors.PinnacleError({
|
|
130
128
|
message: _response.error.errorMessage,
|
|
@@ -134,38 +132,52 @@ class Send {
|
|
|
134
132
|
});
|
|
135
133
|
}
|
|
136
134
|
/**
|
|
137
|
-
*
|
|
135
|
+
* Whitelist a phone number for testing with your test RCS agent.
|
|
136
|
+
*
|
|
137
|
+
* ## Overview
|
|
138
|
+
* During development and testing, RCS agents can only send messages to whitelisted phone numbers.
|
|
139
|
+
* Use this endpoint to add test devices to your agent's whitelist before sending test messages.
|
|
140
|
+
*
|
|
141
|
+
* ## Verification Process
|
|
142
|
+
* After whitelisting a number, you'll need to complete verification:
|
|
143
|
+
*
|
|
144
|
+
* 1. Check the test device for an "RBM Tester Management" request
|
|
145
|
+
* 2. Accept the request on the device
|
|
146
|
+
* 3. Enter the 4-digit verification code in the Pinnacle dashboard at:
|
|
147
|
+
* ```
|
|
148
|
+
* https://app.pinnacle.sh/dashboard/brands/{brandId}?campaignId={campaignId}&campaignType=RCS
|
|
149
|
+
* ```
|
|
150
|
+
*
|
|
151
|
+
* > **Important Notes**
|
|
152
|
+
* >
|
|
153
|
+
* > - **Testing only:** This is only required for test agents. Production agents can message any RCS-enabled number
|
|
154
|
+
* > - **AT&T limitation:** Whitelisting may currently fail for AT&T numbers
|
|
155
|
+
* > - **Verification required:** The whitelist request isn't complete until you verify the device.
|
|
138
156
|
*
|
|
139
|
-
* @param {Pinnacle.
|
|
140
|
-
* @param {
|
|
157
|
+
* @param {Pinnacle.RcsWhitelistRequest} request
|
|
158
|
+
* @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
|
|
141
159
|
*
|
|
142
160
|
* @throws {@link Pinnacle.BadRequestError}
|
|
143
161
|
* @throws {@link Pinnacle.UnauthorizedError}
|
|
144
|
-
* @throws {@link Pinnacle.PaymentRequiredError}
|
|
145
162
|
* @throws {@link Pinnacle.NotFoundError}
|
|
146
163
|
* @throws {@link Pinnacle.InternalServerError}
|
|
164
|
+
* @throws {@link Pinnacle.NotImplementedError}
|
|
147
165
|
*
|
|
148
166
|
* @example
|
|
149
|
-
* await client.
|
|
150
|
-
*
|
|
151
|
-
*
|
|
152
|
-
* options: {
|
|
153
|
-
* multiple_messages: true,
|
|
154
|
-
* validate: true
|
|
155
|
-
* },
|
|
156
|
-
* text: "Check out this image!",
|
|
157
|
-
* to: "+14154746461"
|
|
167
|
+
* await client.rcs.whitelist({
|
|
168
|
+
* agentId: "agent_XXXXXXXXXXXX",
|
|
169
|
+
* phoneNumber: "+12345678901"
|
|
158
170
|
* })
|
|
159
171
|
*/
|
|
160
|
-
|
|
161
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
172
|
+
whitelist(request, requestOptions) {
|
|
173
|
+
return core.HttpResponsePromise.fromPromise(this.__whitelist(request, requestOptions));
|
|
162
174
|
}
|
|
163
|
-
|
|
175
|
+
__whitelist(request, requestOptions) {
|
|
164
176
|
return __awaiter(this, void 0, void 0, function* () {
|
|
165
177
|
var _a, _b, _c;
|
|
166
178
|
let _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);
|
|
167
179
|
const _response = yield core.fetcher({
|
|
168
|
-
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, "
|
|
180
|
+
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, "rcs/whitelist"),
|
|
169
181
|
method: "POST",
|
|
170
182
|
headers: _headers,
|
|
171
183
|
contentType: "application/json",
|
|
@@ -185,12 +197,12 @@ class Send {
|
|
|
185
197
|
throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
|
|
186
198
|
case 401:
|
|
187
199
|
throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
188
|
-
case 402:
|
|
189
|
-
throw new Pinnacle.PaymentRequiredError(_response.error.body, _response.rawResponse);
|
|
190
200
|
case 404:
|
|
191
201
|
throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
|
|
192
202
|
case 500:
|
|
193
203
|
throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
|
|
204
|
+
case 501:
|
|
205
|
+
throw new Pinnacle.NotImplementedError(_response.error.body, _response.rawResponse);
|
|
194
206
|
default:
|
|
195
207
|
throw new errors.PinnacleError({
|
|
196
208
|
statusCode: _response.error.statusCode,
|
|
@@ -207,7 +219,7 @@ class Send {
|
|
|
207
219
|
rawResponse: _response.rawResponse,
|
|
208
220
|
});
|
|
209
221
|
case "timeout":
|
|
210
|
-
throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /
|
|
222
|
+
throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /rcs/whitelist.");
|
|
211
223
|
case "unknown":
|
|
212
224
|
throw new errors.PinnacleError({
|
|
213
225
|
message: _response.error.errorMessage,
|
|
@@ -217,40 +229,37 @@ class Send {
|
|
|
217
229
|
});
|
|
218
230
|
}
|
|
219
231
|
/**
|
|
220
|
-
*
|
|
232
|
+
* Generate a link for initiating an RCS conversation with your agent.
|
|
221
233
|
*
|
|
222
|
-
*
|
|
234
|
+
* Users can click these links to start conversations with your RCS agent directly
|
|
235
|
+
* from websites, emails, or other applications.
|
|
223
236
|
*
|
|
224
|
-
* @param {Pinnacle.
|
|
225
|
-
* @param {
|
|
237
|
+
* @param {Pinnacle.RcsLinkRequest} request
|
|
238
|
+
* @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
|
|
226
239
|
*
|
|
227
240
|
* @throws {@link Pinnacle.BadRequestError}
|
|
228
241
|
* @throws {@link Pinnacle.UnauthorizedError}
|
|
229
|
-
* @throws {@link Pinnacle.PaymentRequiredError}
|
|
230
242
|
* @throws {@link Pinnacle.NotFoundError}
|
|
231
243
|
* @throws {@link Pinnacle.InternalServerError}
|
|
244
|
+
* @throws {@link Pinnacle.NotImplementedError}
|
|
232
245
|
*
|
|
233
246
|
* @example
|
|
234
|
-
* await client.
|
|
235
|
-
*
|
|
236
|
-
*
|
|
237
|
-
*
|
|
238
|
-
*
|
|
239
|
-
* }],
|
|
240
|
-
* text: "text",
|
|
241
|
-
* from: "from",
|
|
242
|
-
* to: "to"
|
|
247
|
+
* await client.rcs.getLink({
|
|
248
|
+
* agentId: "agent_XXXXXXXXXXXX",
|
|
249
|
+
* testMode: false,
|
|
250
|
+
* phoneNumber: "+12345678901",
|
|
251
|
+
* body: "Hello, I need help with my order"
|
|
243
252
|
* })
|
|
244
253
|
*/
|
|
245
|
-
|
|
246
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
254
|
+
getLink(request, requestOptions) {
|
|
255
|
+
return core.HttpResponsePromise.fromPromise(this.__getLink(request, requestOptions));
|
|
247
256
|
}
|
|
248
|
-
|
|
257
|
+
__getLink(request, requestOptions) {
|
|
249
258
|
return __awaiter(this, void 0, void 0, function* () {
|
|
250
259
|
var _a, _b, _c;
|
|
251
260
|
let _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);
|
|
252
261
|
const _response = yield core.fetcher({
|
|
253
|
-
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, "
|
|
262
|
+
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, "rcs/link"),
|
|
254
263
|
method: "POST",
|
|
255
264
|
headers: _headers,
|
|
256
265
|
contentType: "application/json",
|
|
@@ -270,12 +279,12 @@ class Send {
|
|
|
270
279
|
throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
|
|
271
280
|
case 401:
|
|
272
281
|
throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
273
|
-
case 402:
|
|
274
|
-
throw new Pinnacle.PaymentRequiredError(_response.error.body, _response.rawResponse);
|
|
275
282
|
case 404:
|
|
276
283
|
throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
|
|
277
284
|
case 500:
|
|
278
285
|
throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
|
|
286
|
+
case 501:
|
|
287
|
+
throw new Pinnacle.NotImplementedError(_response.error.body, _response.rawResponse);
|
|
279
288
|
default:
|
|
280
289
|
throw new errors.PinnacleError({
|
|
281
290
|
statusCode: _response.error.statusCode,
|
|
@@ -292,7 +301,7 @@ class Send {
|
|
|
292
301
|
rawResponse: _response.rawResponse,
|
|
293
302
|
});
|
|
294
303
|
case "timeout":
|
|
295
|
-
throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /
|
|
304
|
+
throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /rcs/link.");
|
|
296
305
|
case "unknown":
|
|
297
306
|
throw new errors.PinnacleError({
|
|
298
307
|
message: _response.error.errorMessage,
|
|
@@ -308,4 +317,4 @@ class Send {
|
|
|
308
317
|
});
|
|
309
318
|
}
|
|
310
319
|
}
|
|
311
|
-
exports.
|
|
320
|
+
exports.Rcs = Rcs;
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./requests/index.js"), exports);
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* @example
|
|
6
|
+
* {
|
|
7
|
+
* phoneNumbers: ["+12345678901", "+19876543210"]
|
|
8
|
+
* }
|
|
9
|
+
*/
|
|
10
|
+
export interface RcsCapabilitiesQuery {
|
|
11
|
+
/** List of phone numbers to check RCS capabilities for (E.164 format) */
|
|
12
|
+
phoneNumbers: string[];
|
|
13
|
+
}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* @example
|
|
6
|
+
* {
|
|
7
|
+
* agentId: "agent_XXXXXXXXXXXX",
|
|
8
|
+
* testMode: false,
|
|
9
|
+
* phoneNumber: "+12345678901",
|
|
10
|
+
* body: "Hello, I need help with my order"
|
|
11
|
+
* }
|
|
12
|
+
*/
|
|
13
|
+
export interface RcsLinkRequest {
|
|
14
|
+
/** The RCS agent ID (must be prefixed with 'agent_') */
|
|
15
|
+
agentId: string;
|
|
16
|
+
/** Link to the test agent or the production agent if false */
|
|
17
|
+
testMode?: boolean;
|
|
18
|
+
/** Fallback phone number (E.164 format) to use if the phone number does not support RCS. If not provided, no url will be generated. */
|
|
19
|
+
phoneNumber?: string;
|
|
20
|
+
/** Optional message body to pre-fill after the user clicks the link */
|
|
21
|
+
body?: string;
|
|
22
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* @example
|
|
6
|
+
* {
|
|
7
|
+
* agentId: "agent_XXXXXXXXXXXX",
|
|
8
|
+
* phoneNumber: "+12345678901"
|
|
9
|
+
* }
|
|
10
|
+
*/
|
|
11
|
+
export interface RcsWhitelistRequest {
|
|
12
|
+
/** The RCS agent ID (must be prefixed with 'agent_') */
|
|
13
|
+
agentId: string;
|
|
14
|
+
/** Phone number to whitelist for testing (E.164 format) */
|
|
15
|
+
phoneNumber: string;
|
|
16
|
+
}
|
|
@@ -64,9 +64,9 @@ export declare class Get {
|
|
|
64
64
|
tollFree(campaignId: number, requestOptions?: Get.RequestOptions): core.HttpResponsePromise<Pinnacle.TollFreeCampaignStatus>;
|
|
65
65
|
private __tollFree;
|
|
66
66
|
/**
|
|
67
|
-
* Retrieve a
|
|
67
|
+
* Retrieve a 10DLC campaign's status.
|
|
68
68
|
*
|
|
69
|
-
* @param {number} campaignId - ID of the
|
|
69
|
+
* @param {number} campaignId - ID of the 10DLC campaign.
|
|
70
70
|
* @param {Get.RequestOptions} requestOptions - Request-specific configuration.
|
|
71
71
|
*
|
|
72
72
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -198,9 +198,9 @@ class Get {
|
|
|
198
198
|
});
|
|
199
199
|
}
|
|
200
200
|
/**
|
|
201
|
-
* Retrieve a
|
|
201
|
+
* Retrieve a 10DLC campaign's status.
|
|
202
202
|
*
|
|
203
|
-
* @param {number} campaignId - ID of the
|
|
203
|
+
* @param {number} campaignId - ID of the 10DLC campaign.
|
|
204
204
|
* @param {Get.RequestOptions} requestOptions - Request-specific configuration.
|
|
205
205
|
*
|
|
206
206
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -5,10 +5,10 @@ import * as Pinnacle from "../index.js";
|
|
|
5
5
|
/**
|
|
6
6
|
* Response for list conversation.
|
|
7
7
|
*/
|
|
8
|
-
export
|
|
9
|
-
|
|
8
|
+
export type ConversationList = {
|
|
9
|
+
error?: string | undefined;
|
|
10
|
+
} | {
|
|
10
11
|
count: number;
|
|
11
12
|
conversations: Pinnacle.Conversation[];
|
|
12
|
-
/** Indicates if more conversations are available beyond the current page. */
|
|
13
13
|
hasMore: boolean;
|
|
14
|
-
}
|
|
14
|
+
};
|
|
@@ -24,7 +24,7 @@ export interface DlcCampaignStatus {
|
|
|
24
24
|
*/
|
|
25
25
|
status: Pinnacle.ProfileStatusEnum;
|
|
26
26
|
/**
|
|
27
|
-
* Status of
|
|
27
|
+
* Status of local long code numbers that are being attached to this campaign. <br>
|
|
28
28
|
*
|
|
29
29
|
* Note that phone numbers can only be attached to `VERIFIED` campaigns via the [attach campaign endpoint](../phone-numbers/attach-campaign).
|
|
30
30
|
*/
|
|
@@ -32,7 +32,7 @@ export interface DlcCampaignStatus {
|
|
|
32
32
|
}
|
|
33
33
|
export declare namespace DlcCampaignStatus {
|
|
34
34
|
/**
|
|
35
|
-
* Status of
|
|
35
|
+
* Status of local long code numbers that are being attached to this campaign. <br>
|
|
36
36
|
*
|
|
37
37
|
* Note that phone numbers can only be attached to `VERIFIED` campaigns via the [attach campaign endpoint](../phone-numbers/attach-campaign).
|
|
38
38
|
*/
|
|
@@ -9,6 +9,8 @@ export interface ExtendedRcsCampaign {
|
|
|
9
9
|
agentId: string;
|
|
10
10
|
/** Brand associated with this campaign. */
|
|
11
11
|
brand: Pinnacle.ExtendedBrand;
|
|
12
|
+
/** Link to document verifying the brand's name. This may be the certificate of incorporation, business license, or other relevant document. You can typically find this on the Secretary of State website. */
|
|
13
|
+
brandVerificationUrl?: string;
|
|
12
14
|
/** Indicates whether the brand has provided an attestation. */
|
|
13
15
|
brandAttestation: boolean;
|
|
14
16
|
/** Unique identifier for the campaign. */
|
|
@@ -35,9 +37,9 @@ export declare namespace ExtendedRcsCampaign {
|
|
|
35
37
|
description?: string;
|
|
36
38
|
/** List of emails. */
|
|
37
39
|
emails?: Agent.Emails.Item[];
|
|
38
|
-
/** Link to the agent's hero. */
|
|
40
|
+
/** Link to the agent's hero. Hero must be an image file with dimensions 1440x448px. */
|
|
39
41
|
heroUrl?: string;
|
|
40
|
-
/** Link to the agent's icon. */
|
|
42
|
+
/** Link to the agent's icon. Icon must be an image file with dimensions 224x224px. */
|
|
41
43
|
iconUrl?: string;
|
|
42
44
|
/** Name of the agent. */
|
|
43
45
|
name?: string;
|
|
@@ -5,10 +5,10 @@ import * as Pinnacle from "../index.js";
|
|
|
5
5
|
export type Rcs =
|
|
6
6
|
/**
|
|
7
7
|
* Send a text RCS message with optional quick reply buttons. */
|
|
8
|
-
Pinnacle.
|
|
8
|
+
Pinnacle.RichTextMessage
|
|
9
9
|
/**
|
|
10
10
|
* Send a media RCS message with optional quick reply buttons. */
|
|
11
|
-
| Pinnacle.
|
|
11
|
+
| Pinnacle.RichMediaMessage
|
|
12
12
|
/**
|
|
13
13
|
* Send a cards RCS message with optional quick reply buttons. */
|
|
14
|
-
| Pinnacle.
|
|
14
|
+
| Pinnacle.RichCardsMessage;
|
|
@@ -7,6 +7,8 @@ export interface RcsCampaign {
|
|
|
7
7
|
agent?: RcsCampaign.Agent;
|
|
8
8
|
/** Unique identifier for the campaign. */
|
|
9
9
|
campaignId?: number;
|
|
10
|
+
/** Link to document verifying the brand's name. This may be the certificate of incorporation, business license, or other relevant document. You can typically find this on the Secretary of State website. */
|
|
11
|
+
brandVerificationUrl?: string;
|
|
10
12
|
/** List of what the agent might say to users. */
|
|
11
13
|
expectedAgentResponses?: string[];
|
|
12
14
|
/** Legal documentation links. */
|
|
@@ -35,9 +37,9 @@ export declare namespace RcsCampaign {
|
|
|
35
37
|
phones?: Agent.Phones.Item[];
|
|
36
38
|
/** List of urls. */
|
|
37
39
|
websites?: Agent.Websites.Item[];
|
|
38
|
-
/** Link to the agent's hero. */
|
|
40
|
+
/** Link to the agent's hero. Hero must be an image file with dimensions 1440x448px. */
|
|
39
41
|
heroUrl?: string;
|
|
40
|
-
/** Link to the agent's icon. */
|
|
42
|
+
/** Link to the agent's icon. Icon must be an image file with dimensions 224x224px. */
|
|
41
43
|
iconUrl?: string;
|
|
42
44
|
}
|
|
43
45
|
namespace Agent {
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as Pinnacle from "../index.js";
|
|
5
|
+
/**
|
|
6
|
+
* Response containing RCS capabilities for requested phone numbers
|
|
7
|
+
*/
|
|
8
|
+
export type RcsCapabilitiesResult = Record<string, (Pinnacle.RcsCapability | null) | undefined>;
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* RCS capabilities for a phone number
|
|
6
|
+
*/
|
|
7
|
+
export interface RcsCapability {
|
|
8
|
+
cards: RcsCapability.Cards;
|
|
9
|
+
/** Supported button action types inside the rich cards or quick replies. Each key is a button action type that defines a specific button type in the Pinnacle API. */
|
|
10
|
+
actions: RcsCapability.Actions;
|
|
11
|
+
}
|
|
12
|
+
export declare namespace RcsCapability {
|
|
13
|
+
interface Cards {
|
|
14
|
+
/** Whether the phone number supports standalone rich cards (`cards.length == 1`) */
|
|
15
|
+
standalone: boolean;
|
|
16
|
+
/** Whether the phone number supports carousel rich cards */
|
|
17
|
+
carousel: boolean;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* Supported button action types inside the rich cards or quick replies. Each key is a button action type that defines a specific button type in the Pinnacle API.
|
|
21
|
+
*/
|
|
22
|
+
interface Actions {
|
|
23
|
+
/** Buttons that open URLs are supported */
|
|
24
|
+
openUrl: boolean;
|
|
25
|
+
/** Buttons that make phone calls are supported */
|
|
26
|
+
call: boolean;
|
|
27
|
+
/** Buttons that trigger actions are supported */
|
|
28
|
+
trigger: boolean;
|
|
29
|
+
/** Buttons that request user location are supported */
|
|
30
|
+
requestUserLocation: boolean;
|
|
31
|
+
/** Buttons are supported */
|
|
32
|
+
scheduleEvent: boolean;
|
|
33
|
+
/** Buttons that send location are supported */
|
|
34
|
+
sendLocation: boolean;
|
|
35
|
+
}
|
|
36
|
+
}
|
|
@@ -11,7 +11,7 @@ export interface RcsCards {
|
|
|
11
11
|
/** Collection of cards attached to the message. */
|
|
12
12
|
cards: RcsCards.Cards.Item[];
|
|
13
13
|
/** List of interactive quick reply buttons in the message. */
|
|
14
|
-
quickReplies: Pinnacle.
|
|
14
|
+
quickReplies: Pinnacle.RichButton[];
|
|
15
15
|
}
|
|
16
16
|
export declare namespace RcsCards {
|
|
17
17
|
type Cards = Cards.Item[];
|
|
@@ -21,7 +21,7 @@ export declare namespace RcsCards {
|
|
|
21
21
|
*/
|
|
22
22
|
interface Item {
|
|
23
23
|
/** Action buttons attached to the card. */
|
|
24
|
-
buttons: Pinnacle.
|
|
24
|
+
buttons: Pinnacle.RichButton[];
|
|
25
25
|
/** Media file URLs to send. */
|
|
26
26
|
media?: string;
|
|
27
27
|
/** Secondary text displayed below the title for additional context. */
|
|
@@ -11,7 +11,7 @@ export interface RcsCardsContent {
|
|
|
11
11
|
/** Collection of cards attached to the message. */
|
|
12
12
|
cards: RcsCardsContent.Cards.Item[];
|
|
13
13
|
/** List of interactive quick reply buttons in the message. */
|
|
14
|
-
quickReplies: Pinnacle.
|
|
14
|
+
quickReplies: Pinnacle.RichButton[];
|
|
15
15
|
}
|
|
16
16
|
export declare namespace RcsCardsContent {
|
|
17
17
|
type Cards = Cards.Item[];
|
|
@@ -21,7 +21,7 @@ export declare namespace RcsCardsContent {
|
|
|
21
21
|
*/
|
|
22
22
|
interface Item {
|
|
23
23
|
/** Action buttons attached to the card. */
|
|
24
|
-
buttons: Pinnacle.
|
|
24
|
+
buttons: Pinnacle.RichButton[];
|
|
25
25
|
media?: Pinnacle.RcsMediaDetailsContent;
|
|
26
26
|
/** Secondary text displayed below the title for additional context. */
|
|
27
27
|
subtitle?: string;
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* Response containing the generated RCS service id and/or url. You can always create a link with the service id that is returned.
|
|
6
|
+
* To create a link follow the format: sms://{PHONE_NUMBER}?service_id={SERVICE_ID}&body={URL_ENCODED_BODY}
|
|
7
|
+
*/
|
|
8
|
+
export interface RcsLinkResult {
|
|
9
|
+
/** The generated RCS link URL. If no phone number is provided, no url will be generated. */
|
|
10
|
+
url?: string;
|
|
11
|
+
/** The service ID used for the link */
|
|
12
|
+
serviceId: string;
|
|
13
|
+
}
|
|
@@ -10,5 +10,5 @@ import * as Pinnacle from "../index.js";
|
|
|
10
10
|
export interface RcsMediaContent {
|
|
11
11
|
media: Pinnacle.RcsMediaDetailsContent;
|
|
12
12
|
/** List of interactive quick reply buttons in the message. */
|
|
13
|
-
quickReplies: Pinnacle.
|
|
13
|
+
quickReplies: Pinnacle.RichButton[];
|
|
14
14
|
}
|
|
@@ -7,7 +7,7 @@ import * as Pinnacle from "../index.js";
|
|
|
7
7
|
*/
|
|
8
8
|
export interface RcsTextContent {
|
|
9
9
|
/** List of interactive quick reply buttons in the message. */
|
|
10
|
-
quickReplies: Pinnacle.
|
|
10
|
+
quickReplies: Pinnacle.RichButton[];
|
|
11
11
|
/** Text content of the RCS message. */
|
|
12
12
|
text: string;
|
|
13
13
|
}
|
|
@@ -12,6 +12,7 @@ Pinnacle.RcsTextContent
|
|
|
12
12
|
* See [supported media types](https://app.pinnacle.sh/supported-file-types?type=RCS-MEDIA). */
|
|
13
13
|
| {
|
|
14
14
|
media: string;
|
|
15
|
+
quickReplies: Pinnacle.RichButton[];
|
|
15
16
|
}
|
|
16
17
|
/**
|
|
17
18
|
* Message containing cards, each with its own title, subtitle, and/or buttons. Quick replies can also be added. <br>
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* Response indicating success of whitelisting operation
|
|
6
|
+
*/
|
|
7
|
+
export interface RcsWhitelistResponse {
|
|
8
|
+
/** Whether the whitelisting operation was successful */
|
|
9
|
+
success: boolean;
|
|
10
|
+
}
|
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
4
|
import * as Pinnacle from "../index.js";
|
|
5
|
-
export type
|
|
6
|
-
export declare namespace
|
|
5
|
+
export type RichButton = Pinnacle.RichButton.OpenUrl | Pinnacle.RichButton.Call | Pinnacle.RichButton.Trigger | Pinnacle.RichButton.RequestUserLocation | Pinnacle.RichButton.ScheduleEvent | Pinnacle.RichButton.SendLocation;
|
|
6
|
+
export declare namespace RichButton {
|
|
7
7
|
interface OpenUrl extends Pinnacle.RcsButtonOpenUrl {
|
|
8
8
|
type: "openUrl";
|
|
9
9
|
}
|