rcs-js 2.0.1 → 2.0.3
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/errors/NotFoundError.d.ts +1 -2
- package/dist/cjs/api/resources/brands/client/Client.d.ts +13 -13
- package/dist/cjs/api/resources/brands/client/Client.js +10 -10
- package/dist/cjs/api/resources/brands/client/requests/UpsertBrandParams.d.ts +6 -3
- package/dist/cjs/api/resources/campaigns/resources/dlc/client/Client.d.ts +14 -13
- package/dist/cjs/api/resources/campaigns/resources/dlc/client/Client.js +12 -11
- package/dist/cjs/api/resources/campaigns/resources/dlc/client/requests/UpsertDlcCampaignParams.d.ts +8 -8
- package/dist/cjs/api/resources/campaigns/resources/rcs/client/Client.d.ts +11 -10
- package/dist/cjs/api/resources/campaigns/resources/rcs/client/Client.js +9 -8
- package/dist/cjs/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.ts +4 -3
- package/dist/cjs/api/resources/campaigns/resources/rcs/types/RcsAutofillResponse.d.ts +1 -1
- package/dist/cjs/api/resources/campaigns/resources/tollFree/client/Client.d.ts +12 -12
- package/dist/cjs/api/resources/campaigns/resources/tollFree/client/Client.js +10 -10
- package/dist/cjs/api/resources/campaigns/resources/tollFree/client/requests/UpsertTollFreeCampaignParams.d.ts +7 -7
- package/dist/cjs/api/resources/campaigns/resources/tollFree/types/TollFreeAutofillResponse.d.ts +1 -1
- package/dist/cjs/api/resources/contacts/client/Client.d.ts +4 -2
- package/dist/cjs/api/resources/contacts/client/Client.js +5 -3
- package/dist/cjs/api/resources/contacts/client/requests/ContactsGetRequest.d.ts +4 -2
- package/dist/cjs/api/resources/contacts/client/requests/UpdateContactParams.d.ts +3 -3
- package/dist/cjs/api/resources/conversations/client/Client.d.ts +21 -4
- package/dist/cjs/api/resources/conversations/client/Client.js +99 -4
- package/dist/cjs/api/resources/conversations/client/requests/ConversationsListMessagesRequest.d.ts +36 -0
- package/dist/cjs/api/resources/conversations/client/requests/ConversationsListMessagesRequest.js +5 -0
- package/dist/cjs/api/resources/conversations/client/requests/ListConversationsParams.d.ts +11 -6
- package/dist/cjs/api/resources/conversations/client/requests/UpdateConversationParams.d.ts +3 -3
- package/dist/cjs/api/resources/conversations/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/conversations/index.d.ts +1 -0
- package/dist/cjs/api/resources/conversations/index.js +1 -0
- package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestDirection.d.ts +8 -0
- package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestDirection.js +10 -0
- package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestSortOrder.d.ts +8 -0
- package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestSortOrder.js +10 -0
- package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestStatus.d.ts +13 -0
- package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestStatus.js +15 -0
- package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestType.d.ts +9 -0
- package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestType.js +11 -0
- package/dist/cjs/api/resources/conversations/types/index.d.ts +4 -0
- package/dist/cjs/api/resources/conversations/types/index.js +20 -0
- 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 +4 -4
- package/dist/cjs/api/resources/messages/client/Client.js +3 -3
- package/dist/cjs/api/resources/messages/client/requests/ReactMessageParams.d.ts +3 -3
- package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/Client.js +1 -1
- package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/requests/AttachCampaignParams.d.ts +12 -3
- package/dist/cjs/api/resources/phoneNumbers/resources/webhook/client/Client.d.ts +5 -5
- package/dist/cjs/api/resources/phoneNumbers/resources/webhook/client/Client.js +4 -4
- package/dist/cjs/api/resources/rcs/client/Client.d.ts +11 -7
- package/dist/cjs/api/resources/rcs/client/Client.js +11 -7
- package/dist/cjs/api/resources/status/resources/get/client/Client.d.ts +12 -12
- package/dist/cjs/api/resources/status/resources/get/client/Client.js +8 -8
- package/dist/cjs/api/resources/tools/resources/contactCard/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/tools/resources/contactCard/client/Client.js +2 -2
- package/dist/cjs/api/resources/tools/resources/contactCard/client/requests/GetVcardParams.d.ts +3 -3
- package/dist/cjs/api/resources/tools/resources/contactCard/client/requests/UpsertVcardParams.d.ts +1 -1
- package/dist/cjs/api/resources/tools/resources/file/client/Client.d.ts +2 -1
- package/dist/cjs/api/resources/tools/resources/file/client/Client.js +2 -1
- package/dist/cjs/api/resources/tools/resources/file/client/requests/RefreshFileParams.d.ts +3 -11
- package/dist/cjs/api/resources/tools/resources/file/client/requests/UploadFileParams.d.ts +7 -0
- package/dist/cjs/api/types/AttachWebhookParams.d.ts +1 -1
- package/dist/cjs/api/types/AttachedPhoneNumberResult.d.ts +2 -2
- package/dist/cjs/api/types/AutofillCampaignParams.d.ts +7 -2
- package/dist/cjs/api/types/AutofillDlcCampaignResponse.d.ts +4 -4
- package/dist/cjs/api/types/BrandStatus.d.ts +2 -2
- package/dist/cjs/api/types/ButtonClickedData.d.ts +2 -2
- package/dist/cjs/api/types/CampaignQuery.d.ts +6 -1
- package/dist/cjs/api/types/ConfiguredWebhook.d.ts +2 -2
- package/dist/cjs/api/types/Contact.d.ts +2 -2
- package/dist/cjs/api/types/ContactId.d.ts +2 -2
- package/dist/cjs/api/types/Conversation.d.ts +7 -7
- package/dist/cjs/api/types/ConversationList.d.ts +4 -4
- package/dist/cjs/api/types/DetachedPhoneNumberResult.d.ts +2 -2
- package/dist/cjs/api/types/DetachedWebhookInfo.d.ts +2 -2
- package/dist/cjs/api/types/DlcCampaignStatus.d.ts +2 -2
- package/dist/cjs/api/types/DlcCampaignWithExtendedBrandAndStatus.d.ts +2 -2
- package/dist/cjs/api/types/ExtendedBrand.d.ts +2 -2
- package/dist/cjs/api/types/ExtendedRcsCampaign.d.ts +2 -2
- package/dist/cjs/api/types/GetConversationParams.d.ts +1 -1
- package/dist/cjs/api/types/LinkClickEvent.d.ts +0 -4
- package/dist/cjs/api/types/Message.d.ts +2 -2
- package/dist/cjs/api/types/MessageEvent.d.ts +6 -12
- package/dist/cjs/api/types/MessageEventContent.d.ts +29 -0
- package/dist/cjs/api/types/MessageEventContent.js +5 -0
- package/dist/cjs/api/types/MessageEventMmsContent.d.ts +23 -0
- package/dist/cjs/api/types/MessageEventMmsContent.js +5 -0
- package/dist/cjs/api/types/MessageEventRcsButtonData.d.ts +18 -0
- package/dist/cjs/api/types/MessageEventRcsButtonData.js +5 -0
- package/dist/cjs/api/types/MessageEventRcsCardsContent.d.ts +39 -0
- package/dist/cjs/api/types/MessageEventRcsCardsContent.js +5 -0
- package/dist/cjs/api/types/MessageEventRcsLocationData.d.ts +18 -0
- package/dist/cjs/api/types/MessageEventRcsLocationData.js +5 -0
- package/dist/cjs/api/types/MessageEventRcsMediaContent.d.ts +22 -0
- package/dist/cjs/api/types/MessageEventRcsMediaContent.js +5 -0
- package/dist/cjs/api/types/MessageEventRcsTextContent.d.ts +20 -0
- package/dist/cjs/api/types/MessageEventRcsTextContent.js +5 -0
- package/dist/cjs/api/types/MessageEventSmsContent.d.ts +17 -0
- package/dist/cjs/api/types/MessageEventSmsContent.js +5 -0
- package/dist/cjs/api/types/MessageList.d.ts +15 -0
- package/dist/cjs/api/types/MessageList.js +5 -0
- package/dist/cjs/api/types/MessageWithReaction.d.ts +27 -0
- package/dist/cjs/api/types/MessageWithReaction.js +13 -0
- package/dist/cjs/api/types/NotFoundErrorBody.d.ts +6 -0
- package/dist/cjs/api/types/NotFoundErrorBody.js +5 -0
- package/dist/cjs/api/types/RcsCampaign.d.ts +1 -1
- package/dist/cjs/api/types/RcsCampaignStatus.d.ts +2 -2
- package/dist/cjs/api/types/ReactionResult.d.ts +4 -4
- package/dist/cjs/api/types/ScheduledMessaage.d.ts +2 -2
- package/dist/cjs/api/types/SentMmsDetails.d.ts +2 -2
- package/dist/cjs/api/types/SentRcsDetails.d.ts +2 -2
- package/dist/cjs/api/types/SentSmsDetails.d.ts +2 -2
- package/dist/cjs/api/types/TollFreeCampaign.d.ts +2 -2
- package/dist/cjs/api/types/TollFreeCampaignStatus.d.ts +2 -2
- package/dist/cjs/api/types/UpdatedContactId.d.ts +2 -2
- package/dist/cjs/api/types/UploadResults.d.ts +6 -0
- package/dist/cjs/api/types/ValidateCampaignParams.d.ts +7 -2
- package/dist/cjs/api/types/Vcard.d.ts +2 -2
- package/dist/cjs/api/types/VcardResource.d.ts +2 -2
- package/dist/cjs/api/types/Webhooks.d.ts +2 -2
- package/dist/cjs/api/types/index.d.ts +11 -0
- package/dist/cjs/api/types/index.js +11 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/cjs/wrapper/messages/Client.js +8 -3
- package/dist/esm/Client.mjs +2 -2
- package/dist/esm/api/errors/NotFoundError.d.mts +1 -2
- package/dist/esm/api/resources/brands/client/Client.d.mts +13 -13
- package/dist/esm/api/resources/brands/client/Client.mjs +10 -10
- package/dist/esm/api/resources/brands/client/requests/UpsertBrandParams.d.mts +6 -3
- package/dist/esm/api/resources/campaigns/resources/dlc/client/Client.d.mts +14 -13
- package/dist/esm/api/resources/campaigns/resources/dlc/client/Client.mjs +12 -11
- package/dist/esm/api/resources/campaigns/resources/dlc/client/requests/UpsertDlcCampaignParams.d.mts +8 -8
- package/dist/esm/api/resources/campaigns/resources/rcs/client/Client.d.mts +11 -10
- package/dist/esm/api/resources/campaigns/resources/rcs/client/Client.mjs +9 -8
- package/dist/esm/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.mts +4 -3
- package/dist/esm/api/resources/campaigns/resources/rcs/types/RcsAutofillResponse.d.mts +1 -1
- package/dist/esm/api/resources/campaigns/resources/tollFree/client/Client.d.mts +12 -12
- package/dist/esm/api/resources/campaigns/resources/tollFree/client/Client.mjs +10 -10
- package/dist/esm/api/resources/campaigns/resources/tollFree/client/requests/UpsertTollFreeCampaignParams.d.mts +7 -7
- package/dist/esm/api/resources/campaigns/resources/tollFree/types/TollFreeAutofillResponse.d.mts +1 -1
- package/dist/esm/api/resources/contacts/client/Client.d.mts +4 -2
- package/dist/esm/api/resources/contacts/client/Client.mjs +5 -3
- package/dist/esm/api/resources/contacts/client/requests/ContactsGetRequest.d.mts +4 -2
- package/dist/esm/api/resources/contacts/client/requests/UpdateContactParams.d.mts +3 -3
- package/dist/esm/api/resources/conversations/client/Client.d.mts +21 -4
- package/dist/esm/api/resources/conversations/client/Client.mjs +99 -4
- package/dist/esm/api/resources/conversations/client/requests/ConversationsListMessagesRequest.d.mts +36 -0
- package/dist/esm/api/resources/conversations/client/requests/ConversationsListMessagesRequest.mjs +4 -0
- package/dist/esm/api/resources/conversations/client/requests/ListConversationsParams.d.mts +11 -6
- package/dist/esm/api/resources/conversations/client/requests/UpdateConversationParams.d.mts +3 -3
- package/dist/esm/api/resources/conversations/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/conversations/index.d.mts +1 -0
- package/dist/esm/api/resources/conversations/index.mjs +1 -0
- package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestDirection.d.mts +8 -0
- package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestDirection.mjs +7 -0
- package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestSortOrder.d.mts +8 -0
- package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestSortOrder.mjs +7 -0
- package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestStatus.d.mts +13 -0
- package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestStatus.mjs +12 -0
- package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestType.d.mts +9 -0
- package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestType.mjs +8 -0
- package/dist/esm/api/resources/conversations/types/index.d.mts +4 -0
- package/dist/esm/api/resources/conversations/types/index.mjs +4 -0
- 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 +4 -4
- package/dist/esm/api/resources/messages/client/Client.mjs +3 -3
- package/dist/esm/api/resources/messages/client/requests/ReactMessageParams.d.mts +3 -3
- package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/Client.mjs +1 -1
- package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/requests/AttachCampaignParams.d.mts +12 -3
- package/dist/esm/api/resources/phoneNumbers/resources/webhook/client/Client.d.mts +5 -5
- package/dist/esm/api/resources/phoneNumbers/resources/webhook/client/Client.mjs +4 -4
- package/dist/esm/api/resources/rcs/client/Client.d.mts +11 -7
- package/dist/esm/api/resources/rcs/client/Client.mjs +11 -7
- package/dist/esm/api/resources/status/resources/get/client/Client.d.mts +12 -12
- package/dist/esm/api/resources/status/resources/get/client/Client.mjs +8 -8
- package/dist/esm/api/resources/tools/resources/contactCard/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/tools/resources/contactCard/client/Client.mjs +2 -2
- package/dist/esm/api/resources/tools/resources/contactCard/client/requests/GetVcardParams.d.mts +3 -3
- package/dist/esm/api/resources/tools/resources/contactCard/client/requests/UpsertVcardParams.d.mts +1 -1
- package/dist/esm/api/resources/tools/resources/file/client/Client.d.mts +2 -1
- package/dist/esm/api/resources/tools/resources/file/client/Client.mjs +2 -1
- package/dist/esm/api/resources/tools/resources/file/client/requests/RefreshFileParams.d.mts +3 -11
- package/dist/esm/api/resources/tools/resources/file/client/requests/UploadFileParams.d.mts +7 -0
- package/dist/esm/api/types/AttachWebhookParams.d.mts +1 -1
- package/dist/esm/api/types/AttachedPhoneNumberResult.d.mts +2 -2
- package/dist/esm/api/types/AutofillCampaignParams.d.mts +7 -2
- package/dist/esm/api/types/AutofillDlcCampaignResponse.d.mts +4 -4
- package/dist/esm/api/types/BrandStatus.d.mts +2 -2
- package/dist/esm/api/types/ButtonClickedData.d.mts +2 -2
- package/dist/esm/api/types/CampaignQuery.d.mts +6 -1
- package/dist/esm/api/types/ConfiguredWebhook.d.mts +2 -2
- package/dist/esm/api/types/Contact.d.mts +2 -2
- package/dist/esm/api/types/ContactId.d.mts +2 -2
- package/dist/esm/api/types/Conversation.d.mts +7 -7
- package/dist/esm/api/types/ConversationList.d.mts +4 -4
- package/dist/esm/api/types/DetachedPhoneNumberResult.d.mts +2 -2
- package/dist/esm/api/types/DetachedWebhookInfo.d.mts +2 -2
- package/dist/esm/api/types/DlcCampaignStatus.d.mts +2 -2
- package/dist/esm/api/types/DlcCampaignWithExtendedBrandAndStatus.d.mts +2 -2
- package/dist/esm/api/types/ExtendedBrand.d.mts +2 -2
- package/dist/esm/api/types/ExtendedRcsCampaign.d.mts +2 -2
- package/dist/esm/api/types/GetConversationParams.d.mts +1 -1
- package/dist/esm/api/types/LinkClickEvent.d.mts +0 -4
- package/dist/esm/api/types/Message.d.mts +2 -2
- package/dist/esm/api/types/MessageEvent.d.mts +6 -12
- package/dist/esm/api/types/MessageEventContent.d.mts +29 -0
- package/dist/esm/api/types/MessageEventContent.mjs +4 -0
- package/dist/esm/api/types/MessageEventMmsContent.d.mts +23 -0
- package/dist/esm/api/types/MessageEventMmsContent.mjs +4 -0
- package/dist/esm/api/types/MessageEventRcsButtonData.d.mts +18 -0
- package/dist/esm/api/types/MessageEventRcsButtonData.mjs +4 -0
- package/dist/esm/api/types/MessageEventRcsCardsContent.d.mts +39 -0
- package/dist/esm/api/types/MessageEventRcsCardsContent.mjs +4 -0
- package/dist/esm/api/types/MessageEventRcsLocationData.d.mts +18 -0
- package/dist/esm/api/types/MessageEventRcsLocationData.mjs +4 -0
- package/dist/esm/api/types/MessageEventRcsMediaContent.d.mts +22 -0
- package/dist/esm/api/types/MessageEventRcsMediaContent.mjs +4 -0
- package/dist/esm/api/types/MessageEventRcsTextContent.d.mts +20 -0
- package/dist/esm/api/types/MessageEventRcsTextContent.mjs +4 -0
- package/dist/esm/api/types/MessageEventSmsContent.d.mts +17 -0
- package/dist/esm/api/types/MessageEventSmsContent.mjs +4 -0
- package/dist/esm/api/types/MessageList.d.mts +15 -0
- package/dist/esm/api/types/MessageList.mjs +4 -0
- package/dist/esm/api/types/MessageWithReaction.d.mts +27 -0
- package/dist/esm/api/types/MessageWithReaction.mjs +10 -0
- package/dist/esm/api/types/NotFoundErrorBody.d.mts +6 -0
- package/dist/esm/api/types/NotFoundErrorBody.mjs +4 -0
- package/dist/esm/api/types/RcsCampaign.d.mts +1 -1
- package/dist/esm/api/types/RcsCampaignStatus.d.mts +2 -2
- package/dist/esm/api/types/ReactionResult.d.mts +4 -4
- package/dist/esm/api/types/ScheduledMessaage.d.mts +2 -2
- package/dist/esm/api/types/SentMmsDetails.d.mts +2 -2
- package/dist/esm/api/types/SentRcsDetails.d.mts +2 -2
- package/dist/esm/api/types/SentSmsDetails.d.mts +2 -2
- package/dist/esm/api/types/TollFreeCampaign.d.mts +2 -2
- package/dist/esm/api/types/TollFreeCampaignStatus.d.mts +2 -2
- package/dist/esm/api/types/UpdatedContactId.d.mts +2 -2
- package/dist/esm/api/types/UploadResults.d.mts +6 -0
- package/dist/esm/api/types/ValidateCampaignParams.d.mts +7 -2
- package/dist/esm/api/types/Vcard.d.mts +2 -2
- package/dist/esm/api/types/VcardResource.d.mts +2 -2
- package/dist/esm/api/types/Webhooks.d.mts +2 -2
- package/dist/esm/api/types/index.d.mts +11 -0
- package/dist/esm/api/types/index.mjs +11 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/dist/esm/wrapper/messages/Client.mjs +8 -3
- package/package.json +3 -3
- package/reference.md +156 -73
|
@@ -36,14 +36,15 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
36
36
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
37
37
|
};
|
|
38
38
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
39
|
-
exports.tools = exports.status = exports.webhooks = exports.rcs = exports.
|
|
39
|
+
exports.tools = exports.status = exports.webhooks = exports.rcs = exports.contacts = exports.brands = exports.messages = exports.campaigns = exports.phoneNumbers = exports.conversations = void 0;
|
|
40
|
+
exports.conversations = __importStar(require("./conversations/index.js"));
|
|
41
|
+
__exportStar(require("./conversations/types/index.js"), exports);
|
|
40
42
|
exports.phoneNumbers = __importStar(require("./phoneNumbers/index.js"));
|
|
41
43
|
__exportStar(require("./phoneNumbers/types/index.js"), exports);
|
|
42
44
|
exports.campaigns = __importStar(require("./campaigns/index.js"));
|
|
43
45
|
exports.messages = __importStar(require("./messages/index.js"));
|
|
44
46
|
exports.brands = __importStar(require("./brands/index.js"));
|
|
45
47
|
exports.contacts = __importStar(require("./contacts/index.js"));
|
|
46
|
-
exports.conversations = __importStar(require("./conversations/index.js"));
|
|
47
48
|
exports.rcs = __importStar(require("./rcs/index.js"));
|
|
48
49
|
exports.webhooks = __importStar(require("./webhooks/index.js"));
|
|
49
50
|
exports.status = __importStar(require("./status/index.js"));
|
|
@@ -41,7 +41,7 @@ export declare class Messages {
|
|
|
41
41
|
/**
|
|
42
42
|
* Retrieve a previously sent message.
|
|
43
43
|
*
|
|
44
|
-
* @param {
|
|
44
|
+
* @param {string} id - Unique identifier of the message. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`.
|
|
45
45
|
* @param {Messages.RequestOptions} requestOptions - Request-specific configuration.
|
|
46
46
|
*
|
|
47
47
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -50,9 +50,9 @@ export declare class Messages {
|
|
|
50
50
|
* @throws {@link Pinnacle.InternalServerError}
|
|
51
51
|
*
|
|
52
52
|
* @example
|
|
53
|
-
* await client.messages.get(
|
|
53
|
+
* await client.messages.get("msg_1234567890")
|
|
54
54
|
*/
|
|
55
|
-
get(id:
|
|
55
|
+
get(id: string, requestOptions?: Messages.RequestOptions): core.HttpResponsePromise<Pinnacle.Message>;
|
|
56
56
|
private __get;
|
|
57
57
|
/**
|
|
58
58
|
* Add or remove an emoji reaction to a previously sent message.
|
|
@@ -69,7 +69,7 @@ export declare class Messages {
|
|
|
69
69
|
*
|
|
70
70
|
* @example
|
|
71
71
|
* await client.messages.react({
|
|
72
|
-
* messageId:
|
|
72
|
+
* messageId: "msg_1234567890",
|
|
73
73
|
* options: {
|
|
74
74
|
* force: true
|
|
75
75
|
* },
|
|
@@ -73,7 +73,7 @@ class Messages {
|
|
|
73
73
|
/**
|
|
74
74
|
* Retrieve a previously sent message.
|
|
75
75
|
*
|
|
76
|
-
* @param {
|
|
76
|
+
* @param {string} id - Unique identifier of the message. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`.
|
|
77
77
|
* @param {Messages.RequestOptions} requestOptions - Request-specific configuration.
|
|
78
78
|
*
|
|
79
79
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -82,7 +82,7 @@ class Messages {
|
|
|
82
82
|
* @throws {@link Pinnacle.InternalServerError}
|
|
83
83
|
*
|
|
84
84
|
* @example
|
|
85
|
-
* await client.messages.get(
|
|
85
|
+
* await client.messages.get("msg_1234567890")
|
|
86
86
|
*/
|
|
87
87
|
get(id, requestOptions) {
|
|
88
88
|
return core.HttpResponsePromise.fromPromise(this.__get(id, requestOptions));
|
|
@@ -153,7 +153,7 @@ class Messages {
|
|
|
153
153
|
*
|
|
154
154
|
* @example
|
|
155
155
|
* await client.messages.react({
|
|
156
|
-
* messageId:
|
|
156
|
+
* messageId: "msg_1234567890",
|
|
157
157
|
* options: {
|
|
158
158
|
* force: true
|
|
159
159
|
* },
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
/**
|
|
5
5
|
* @example
|
|
6
6
|
* {
|
|
7
|
-
* messageId:
|
|
7
|
+
* messageId: "msg_1234567890",
|
|
8
8
|
* options: {
|
|
9
9
|
* force: true
|
|
10
10
|
* },
|
|
@@ -12,8 +12,8 @@
|
|
|
12
12
|
* }
|
|
13
13
|
*/
|
|
14
14
|
export interface ReactMessageParams {
|
|
15
|
-
/** Unique identifier of the message. */
|
|
16
|
-
messageId:
|
|
15
|
+
/** Unique identifier of the message. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`. */
|
|
16
|
+
messageId: string;
|
|
17
17
|
options?: ReactMessageParams.Options;
|
|
18
18
|
/**
|
|
19
19
|
* Unicode emoji to add. <br>
|
|
@@ -45,7 +45,7 @@ export declare class Campaign {
|
|
|
45
45
|
* await client.phoneNumbers.campaign.attach({
|
|
46
46
|
* phones: ["+14155550123", "+14155559876", "+14155550111"],
|
|
47
47
|
* campaignType: "TOLL_FREE",
|
|
48
|
-
* campaignId:
|
|
48
|
+
* campaignId: "tf_1234567890"
|
|
49
49
|
* })
|
|
50
50
|
*/
|
|
51
51
|
attach(request: Pinnacle.phoneNumbers.AttachCampaignParams, requestOptions?: Campaign.RequestOptions): core.HttpResponsePromise<Pinnacle.AttachedPhoneNumberResult>;
|
|
@@ -71,7 +71,7 @@ class Campaign {
|
|
|
71
71
|
* await client.phoneNumbers.campaign.attach({
|
|
72
72
|
* phones: ["+14155550123", "+14155559876", "+14155550111"],
|
|
73
73
|
* campaignType: "TOLL_FREE",
|
|
74
|
-
* campaignId:
|
|
74
|
+
* campaignId: "tf_1234567890"
|
|
75
75
|
* })
|
|
76
76
|
*/
|
|
77
77
|
attach(request, requestOptions) {
|
|
@@ -7,13 +7,22 @@ import * as Pinnacle from "../../../../../../index.js";
|
|
|
7
7
|
* {
|
|
8
8
|
* phones: ["+14155550123", "+14155559876", "+14155550111"],
|
|
9
9
|
* campaignType: "TOLL_FREE",
|
|
10
|
-
* campaignId:
|
|
10
|
+
* campaignId: "tf_1234567890"
|
|
11
11
|
* }
|
|
12
12
|
*/
|
|
13
13
|
export interface AttachCampaignParams {
|
|
14
14
|
/** List of phone number (E.164 format). */
|
|
15
15
|
phones: string[];
|
|
16
16
|
campaignType: Pinnacle.MessagingProfileEnum;
|
|
17
|
-
/**
|
|
18
|
-
|
|
17
|
+
/**
|
|
18
|
+
* Unique identifier for the campaign. <br>
|
|
19
|
+
*
|
|
20
|
+
* - **TOLL_FREE** campaigns:
|
|
21
|
+
* - Must begin with the prefix `tf_`
|
|
22
|
+
* - Example: `tf_1234567890`
|
|
23
|
+
* - **10DLC** campaigns:
|
|
24
|
+
* - Must begin with the prefix `dlc_`
|
|
25
|
+
* - Example: `dlc_1234567890`
|
|
26
|
+
*/
|
|
27
|
+
campaignId: string;
|
|
19
28
|
}
|
|
@@ -46,7 +46,7 @@ export declare class Webhook {
|
|
|
46
46
|
*
|
|
47
47
|
* @example
|
|
48
48
|
* await client.phoneNumbers.webhook.attach("%2B14155551234", {
|
|
49
|
-
* webhookId:
|
|
49
|
+
* webhookId: "wh_1234567890",
|
|
50
50
|
* event: "MESSAGE.STATUS"
|
|
51
51
|
* })
|
|
52
52
|
*/
|
|
@@ -60,9 +60,9 @@ export declare class Webhook {
|
|
|
60
60
|
* @param {string} phone - The phone number you want to attach the webhook to in E.164 format. Make sure it is url encoded (i.e. replace the leading + with %2B). <br>
|
|
61
61
|
*
|
|
62
62
|
* Must be a phone number that you own and currently has the specified webhook attached.
|
|
63
|
-
* @param {
|
|
63
|
+
* @param {string} webhookId - The unique identifier of the webhook you want to detach from the phone number. <br>
|
|
64
64
|
*
|
|
65
|
-
* This must be a valid webhook ID that is currently attached to the specified phone number.
|
|
65
|
+
* This must be a valid webhook ID that is currently attached to the specified phone number. This identifier is a string that always begins with the prefix `wh_`, for example: `wh_1234567890`.
|
|
66
66
|
* @param {Webhook.RequestOptions} requestOptions - Request-specific configuration.
|
|
67
67
|
*
|
|
68
68
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -72,9 +72,9 @@ export declare class Webhook {
|
|
|
72
72
|
* @throws {@link Pinnacle.NotImplementedError}
|
|
73
73
|
*
|
|
74
74
|
* @example
|
|
75
|
-
* await client.phoneNumbers.webhook.detach("+14155551234",
|
|
75
|
+
* await client.phoneNumbers.webhook.detach("+14155551234", "wh_1234567890")
|
|
76
76
|
*/
|
|
77
|
-
detach(phone: string, webhookId:
|
|
77
|
+
detach(phone: string, webhookId: string, requestOptions?: Webhook.RequestOptions): core.HttpResponsePromise<Pinnacle.DetachedWebhookInfo>;
|
|
78
78
|
private __detach;
|
|
79
79
|
protected _getCustomAuthorizationHeaders(): Promise<{
|
|
80
80
|
"PINNACLE-API-KEY": string | undefined;
|
|
@@ -72,7 +72,7 @@ class Webhook {
|
|
|
72
72
|
*
|
|
73
73
|
* @example
|
|
74
74
|
* await client.phoneNumbers.webhook.attach("%2B14155551234", {
|
|
75
|
-
* webhookId:
|
|
75
|
+
* webhookId: "wh_1234567890",
|
|
76
76
|
* event: "MESSAGE.STATUS"
|
|
77
77
|
* })
|
|
78
78
|
*/
|
|
@@ -143,9 +143,9 @@ class Webhook {
|
|
|
143
143
|
* @param {string} phone - The phone number you want to attach the webhook to in E.164 format. Make sure it is url encoded (i.e. replace the leading + with %2B). <br>
|
|
144
144
|
*
|
|
145
145
|
* Must be a phone number that you own and currently has the specified webhook attached.
|
|
146
|
-
* @param {
|
|
146
|
+
* @param {string} webhookId - The unique identifier of the webhook you want to detach from the phone number. <br>
|
|
147
147
|
*
|
|
148
|
-
* This must be a valid webhook ID that is currently attached to the specified phone number.
|
|
148
|
+
* This must be a valid webhook ID that is currently attached to the specified phone number. This identifier is a string that always begins with the prefix `wh_`, for example: `wh_1234567890`.
|
|
149
149
|
* @param {Webhook.RequestOptions} requestOptions - Request-specific configuration.
|
|
150
150
|
*
|
|
151
151
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -155,7 +155,7 @@ class Webhook {
|
|
|
155
155
|
* @throws {@link Pinnacle.NotImplementedError}
|
|
156
156
|
*
|
|
157
157
|
* @example
|
|
158
|
-
* await client.phoneNumbers.webhook.detach("+14155551234",
|
|
158
|
+
* await client.phoneNumbers.webhook.detach("+14155551234", "wh_1234567890")
|
|
159
159
|
*/
|
|
160
160
|
detach(phone, webhookId, requestOptions) {
|
|
161
161
|
return core.HttpResponsePromise.fromPromise(this.__detach(phone, webhookId, requestOptions));
|
|
@@ -55,23 +55,27 @@ export declare class Rcs {
|
|
|
55
55
|
*
|
|
56
56
|
* ## Overview
|
|
57
57
|
* During development and testing, RCS agents can only send messages to whitelisted phone numbers.
|
|
58
|
-
* Use this endpoint to
|
|
58
|
+
* Use this endpoint to whitelist specific phone numbers to send and receive messages from the test agent.
|
|
59
59
|
*
|
|
60
60
|
* ## Verification Process
|
|
61
61
|
* After whitelisting a number, you'll need to complete verification:
|
|
62
62
|
*
|
|
63
|
-
* 1. Check the test device for
|
|
64
|
-
* 2.
|
|
65
|
-
* 3. Enter the 4-digit verification code in the Pinnacle dashboard at:
|
|
63
|
+
* 1. Check the test device for message from "RBM Tester Management"
|
|
64
|
+
* 2. Click the "Make me a tester" button
|
|
65
|
+
* 3. Enter the separate 4-digit verification SMS code in the Pinnacle dashboard at:
|
|
66
66
|
* ```
|
|
67
67
|
* https://app.pinnacle.sh/dashboard/brands/{brandId}?campaignId={campaignId}&campaignType=RCS
|
|
68
68
|
* ```
|
|
69
69
|
*
|
|
70
|
+
* > **⚠️ Important: Re-whitelisting Numbers**
|
|
71
|
+
* >
|
|
72
|
+
* > If you whitelist a number that's already whitelisted, you'll receive a new message from "RBM Tester Management". **You must click the "Make me a tester" button again to continue sending and receiving messages.**
|
|
73
|
+
*
|
|
70
74
|
* > **Important Notes**
|
|
71
75
|
* >
|
|
72
|
-
* > - **
|
|
73
|
-
* > - **
|
|
74
|
-
* > - **
|
|
76
|
+
* > - **Verification required:** Messages cannot be sent nor received until you have clicked the "Make me a tester" button on the test device.
|
|
77
|
+
* > - **Testing only:** This is only required for test agents. Production agents can message any RCS-enabled number.
|
|
78
|
+
* > - **Network limitations:** Whitelisting may be temporarily unavailable for some carriers but are usually restored shortly.
|
|
75
79
|
*
|
|
76
80
|
* @param {Pinnacle.RcsWhitelistRequest} request
|
|
77
81
|
* @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -136,23 +136,27 @@ class Rcs {
|
|
|
136
136
|
*
|
|
137
137
|
* ## Overview
|
|
138
138
|
* During development and testing, RCS agents can only send messages to whitelisted phone numbers.
|
|
139
|
-
* Use this endpoint to
|
|
139
|
+
* Use this endpoint to whitelist specific phone numbers to send and receive messages from the test agent.
|
|
140
140
|
*
|
|
141
141
|
* ## Verification Process
|
|
142
142
|
* After whitelisting a number, you'll need to complete verification:
|
|
143
143
|
*
|
|
144
|
-
* 1. Check the test device for
|
|
145
|
-
* 2.
|
|
146
|
-
* 3. Enter the 4-digit verification code in the Pinnacle dashboard at:
|
|
144
|
+
* 1. Check the test device for message from "RBM Tester Management"
|
|
145
|
+
* 2. Click the "Make me a tester" button
|
|
146
|
+
* 3. Enter the separate 4-digit verification SMS code in the Pinnacle dashboard at:
|
|
147
147
|
* ```
|
|
148
148
|
* https://app.pinnacle.sh/dashboard/brands/{brandId}?campaignId={campaignId}&campaignType=RCS
|
|
149
149
|
* ```
|
|
150
150
|
*
|
|
151
|
+
* > **⚠️ Important: Re-whitelisting Numbers**
|
|
152
|
+
* >
|
|
153
|
+
* > If you whitelist a number that's already whitelisted, you'll receive a new message from "RBM Tester Management". **You must click the "Make me a tester" button again to continue sending and receiving messages.**
|
|
154
|
+
*
|
|
151
155
|
* > **Important Notes**
|
|
152
156
|
* >
|
|
153
|
-
* > - **
|
|
154
|
-
* > - **
|
|
155
|
-
* > - **
|
|
157
|
+
* > - **Verification required:** Messages cannot be sent nor received until you have clicked the "Make me a tester" button on the test device.
|
|
158
|
+
* > - **Testing only:** This is only required for test agents. Production agents can message any RCS-enabled number.
|
|
159
|
+
* > - **Network limitations:** Whitelisting may be temporarily unavailable for some carriers but are usually restored shortly.
|
|
156
160
|
*
|
|
157
161
|
* @param {Pinnacle.RcsWhitelistRequest} request
|
|
158
162
|
* @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -32,7 +32,7 @@ export declare class Get {
|
|
|
32
32
|
/**
|
|
33
33
|
* Retrieve a brand's status.
|
|
34
34
|
*
|
|
35
|
-
* @param {
|
|
35
|
+
* @param {string} brandId - The unique identifier of the brand you want to retrieve the status for. This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`.
|
|
36
36
|
* @param {Get.RequestOptions} requestOptions - Request-specific configuration.
|
|
37
37
|
*
|
|
38
38
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -42,14 +42,14 @@ export declare class Get {
|
|
|
42
42
|
* @throws {@link Pinnacle.NotImplementedError}
|
|
43
43
|
*
|
|
44
44
|
* @example
|
|
45
|
-
* await client.status.get.brand(
|
|
45
|
+
* await client.status.get.brand("b_1234567890")
|
|
46
46
|
*/
|
|
47
|
-
brand(brandId:
|
|
47
|
+
brand(brandId: string, requestOptions?: Get.RequestOptions): core.HttpResponsePromise<Pinnacle.BrandStatus>;
|
|
48
48
|
private __brand;
|
|
49
49
|
/**
|
|
50
50
|
* Retrieve a toll-free campaign's status.
|
|
51
51
|
*
|
|
52
|
-
* @param {
|
|
52
|
+
* @param {string} campaignId - The unique identifier of the toll-free campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `tf_`, for example: `tf_1234567890`.
|
|
53
53
|
* @param {Get.RequestOptions} requestOptions - Request-specific configuration.
|
|
54
54
|
*
|
|
55
55
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -59,14 +59,14 @@ export declare class Get {
|
|
|
59
59
|
* @throws {@link Pinnacle.NotImplementedError}
|
|
60
60
|
*
|
|
61
61
|
* @example
|
|
62
|
-
* await client.status.get.tollFree(
|
|
62
|
+
* await client.status.get.tollFree("tf_1234567890")
|
|
63
63
|
*/
|
|
64
|
-
tollFree(campaignId:
|
|
64
|
+
tollFree(campaignId: string, requestOptions?: Get.RequestOptions): core.HttpResponsePromise<Pinnacle.TollFreeCampaignStatus>;
|
|
65
65
|
private __tollFree;
|
|
66
66
|
/**
|
|
67
67
|
* Retrieve a 10DLC campaign's status.
|
|
68
68
|
*
|
|
69
|
-
* @param {
|
|
69
|
+
* @param {string} campaignId - The unique identifier of the 10DLC campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`.
|
|
70
70
|
* @param {Get.RequestOptions} requestOptions - Request-specific configuration.
|
|
71
71
|
*
|
|
72
72
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -76,14 +76,14 @@ export declare class Get {
|
|
|
76
76
|
* @throws {@link Pinnacle.NotImplementedError}
|
|
77
77
|
*
|
|
78
78
|
* @example
|
|
79
|
-
* await client.status.get.dlc(
|
|
79
|
+
* await client.status.get.dlc("dlc_1234567890")
|
|
80
80
|
*/
|
|
81
|
-
dlc(campaignId:
|
|
81
|
+
dlc(campaignId: string, requestOptions?: Get.RequestOptions): core.HttpResponsePromise<Pinnacle.DlcCampaignStatus>;
|
|
82
82
|
private __dlc;
|
|
83
83
|
/**
|
|
84
84
|
* Retrieve a RCS campaign's status.
|
|
85
85
|
*
|
|
86
|
-
* @param {
|
|
86
|
+
* @param {string} campaignId - The unique identifier of the RCS campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `rcs_`, for example: `rcs_1234567890`.
|
|
87
87
|
* @param {Get.RequestOptions} requestOptions - Request-specific configuration.
|
|
88
88
|
*
|
|
89
89
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -93,9 +93,9 @@ export declare class Get {
|
|
|
93
93
|
* @throws {@link Pinnacle.NotImplementedError}
|
|
94
94
|
*
|
|
95
95
|
* @example
|
|
96
|
-
* await client.status.get.rcs(
|
|
96
|
+
* await client.status.get.rcs("rcs_1234567890")
|
|
97
97
|
*/
|
|
98
|
-
rcs(campaignId:
|
|
98
|
+
rcs(campaignId: string, requestOptions?: Get.RequestOptions): core.HttpResponsePromise<Pinnacle.RcsCampaignStatus>;
|
|
99
99
|
private __rcs;
|
|
100
100
|
/**
|
|
101
101
|
* Retrieve a phone number's order status and campaign attachment status. <br>
|
|
@@ -58,7 +58,7 @@ class Get {
|
|
|
58
58
|
/**
|
|
59
59
|
* Retrieve a brand's status.
|
|
60
60
|
*
|
|
61
|
-
* @param {
|
|
61
|
+
* @param {string} brandId - The unique identifier of the brand you want to retrieve the status for. This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`.
|
|
62
62
|
* @param {Get.RequestOptions} requestOptions - Request-specific configuration.
|
|
63
63
|
*
|
|
64
64
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -68,7 +68,7 @@ class Get {
|
|
|
68
68
|
* @throws {@link Pinnacle.NotImplementedError}
|
|
69
69
|
*
|
|
70
70
|
* @example
|
|
71
|
-
* await client.status.get.brand(
|
|
71
|
+
* await client.status.get.brand("b_1234567890")
|
|
72
72
|
*/
|
|
73
73
|
brand(brandId, requestOptions) {
|
|
74
74
|
return core.HttpResponsePromise.fromPromise(this.__brand(brandId, requestOptions));
|
|
@@ -129,7 +129,7 @@ class Get {
|
|
|
129
129
|
/**
|
|
130
130
|
* Retrieve a toll-free campaign's status.
|
|
131
131
|
*
|
|
132
|
-
* @param {
|
|
132
|
+
* @param {string} campaignId - The unique identifier of the toll-free campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `tf_`, for example: `tf_1234567890`.
|
|
133
133
|
* @param {Get.RequestOptions} requestOptions - Request-specific configuration.
|
|
134
134
|
*
|
|
135
135
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -139,7 +139,7 @@ class Get {
|
|
|
139
139
|
* @throws {@link Pinnacle.NotImplementedError}
|
|
140
140
|
*
|
|
141
141
|
* @example
|
|
142
|
-
* await client.status.get.tollFree(
|
|
142
|
+
* await client.status.get.tollFree("tf_1234567890")
|
|
143
143
|
*/
|
|
144
144
|
tollFree(campaignId, requestOptions) {
|
|
145
145
|
return core.HttpResponsePromise.fromPromise(this.__tollFree(campaignId, requestOptions));
|
|
@@ -200,7 +200,7 @@ class Get {
|
|
|
200
200
|
/**
|
|
201
201
|
* Retrieve a 10DLC campaign's status.
|
|
202
202
|
*
|
|
203
|
-
* @param {
|
|
203
|
+
* @param {string} campaignId - The unique identifier of the 10DLC campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`.
|
|
204
204
|
* @param {Get.RequestOptions} requestOptions - Request-specific configuration.
|
|
205
205
|
*
|
|
206
206
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -210,7 +210,7 @@ class Get {
|
|
|
210
210
|
* @throws {@link Pinnacle.NotImplementedError}
|
|
211
211
|
*
|
|
212
212
|
* @example
|
|
213
|
-
* await client.status.get.dlc(
|
|
213
|
+
* await client.status.get.dlc("dlc_1234567890")
|
|
214
214
|
*/
|
|
215
215
|
dlc(campaignId, requestOptions) {
|
|
216
216
|
return core.HttpResponsePromise.fromPromise(this.__dlc(campaignId, requestOptions));
|
|
@@ -271,7 +271,7 @@ class Get {
|
|
|
271
271
|
/**
|
|
272
272
|
* Retrieve a RCS campaign's status.
|
|
273
273
|
*
|
|
274
|
-
* @param {
|
|
274
|
+
* @param {string} campaignId - The unique identifier of the RCS campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `rcs_`, for example: `rcs_1234567890`.
|
|
275
275
|
* @param {Get.RequestOptions} requestOptions - Request-specific configuration.
|
|
276
276
|
*
|
|
277
277
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -281,7 +281,7 @@ class Get {
|
|
|
281
281
|
* @throws {@link Pinnacle.NotImplementedError}
|
|
282
282
|
*
|
|
283
283
|
* @example
|
|
284
|
-
* await client.status.get.rcs(
|
|
284
|
+
* await client.status.get.rcs("rcs_1234567890")
|
|
285
285
|
*/
|
|
286
286
|
rcs(campaignId, requestOptions) {
|
|
287
287
|
return core.HttpResponsePromise.fromPromise(this.__rcs(campaignId, requestOptions));
|
|
@@ -41,7 +41,7 @@ export declare class ContactCard {
|
|
|
41
41
|
*
|
|
42
42
|
* @example
|
|
43
43
|
* await client.tools.contactCard.get({
|
|
44
|
-
* id:
|
|
44
|
+
* id: "cc_1234567890"
|
|
45
45
|
* })
|
|
46
46
|
*/
|
|
47
47
|
get(request: Pinnacle.tools.GetVcardParams, requestOptions?: ContactCard.RequestOptions): core.HttpResponsePromise<Pinnacle.VCardData>;
|
|
@@ -58,7 +58,7 @@ export declare class ContactCard {
|
|
|
58
58
|
*
|
|
59
59
|
* @example
|
|
60
60
|
* await client.tools.contactCard.upsert({
|
|
61
|
-
* id:
|
|
61
|
+
* id: "cc_1234567890",
|
|
62
62
|
* formattedName: "Jane Smith",
|
|
63
63
|
* name: {
|
|
64
64
|
* familyName: "Smith",
|
|
@@ -67,7 +67,7 @@ class ContactCard {
|
|
|
67
67
|
*
|
|
68
68
|
* @example
|
|
69
69
|
* await client.tools.contactCard.get({
|
|
70
|
-
* id:
|
|
70
|
+
* id: "cc_1234567890"
|
|
71
71
|
* })
|
|
72
72
|
*/
|
|
73
73
|
get(request, requestOptions) {
|
|
@@ -137,7 +137,7 @@ class ContactCard {
|
|
|
137
137
|
*
|
|
138
138
|
* @example
|
|
139
139
|
* await client.tools.contactCard.upsert({
|
|
140
|
-
* id:
|
|
140
|
+
* id: "cc_1234567890",
|
|
141
141
|
* formattedName: "Jane Smith",
|
|
142
142
|
* name: {
|
|
143
143
|
* familyName: "Smith",
|
package/dist/cjs/api/resources/tools/resources/contactCard/client/requests/GetVcardParams.d.ts
CHANGED
|
@@ -4,12 +4,12 @@
|
|
|
4
4
|
/**
|
|
5
5
|
* @example
|
|
6
6
|
* {
|
|
7
|
-
* id:
|
|
7
|
+
* id: "cc_1234567890"
|
|
8
8
|
* }
|
|
9
9
|
*/
|
|
10
10
|
export interface GetVcardParams {
|
|
11
|
-
/**
|
|
12
|
-
id:
|
|
11
|
+
/** The unique identifier of the contact. This identifier is a string that always begins with the prefix `cc_`, for example: `cc_1234567890`. */
|
|
12
|
+
id: string;
|
|
13
13
|
options?: GetVcardParams.Options;
|
|
14
14
|
}
|
|
15
15
|
export declare namespace GetVcardParams {
|
|
@@ -45,6 +45,7 @@ export declare class File_ {
|
|
|
45
45
|
* size: 1024,
|
|
46
46
|
* name: "test.jpg",
|
|
47
47
|
* options: {
|
|
48
|
+
* deleteAt: "2025-12-31T23:59:59Z",
|
|
48
49
|
* download: {
|
|
49
50
|
* expiresAt: "2025-06-30T12:00:00.000Z"
|
|
50
51
|
* }
|
|
@@ -69,7 +70,7 @@ export declare class File_ {
|
|
|
69
70
|
*
|
|
70
71
|
* @example
|
|
71
72
|
* await client.tools.file.refresh({
|
|
72
|
-
*
|
|
73
|
+
* urls: ["https://server.trypinnacle.app/storage/v1/object/sign/vault/3/test.jpg?token=oldtoken", "https://server.trypinnacle.app/storage/v1/object/sign/vault/3/document.pdf?token=oldtoken2", "invalid/url", "https://google.com"]
|
|
73
74
|
* })
|
|
74
75
|
*/
|
|
75
76
|
refresh(request: Pinnacle.tools.RefreshFileParams, requestOptions?: File_.RequestOptions): core.HttpResponsePromise<Pinnacle.RefreshedFile[]>;
|
|
@@ -71,6 +71,7 @@ class File_ {
|
|
|
71
71
|
* size: 1024,
|
|
72
72
|
* name: "test.jpg",
|
|
73
73
|
* options: {
|
|
74
|
+
* deleteAt: "2025-12-31T23:59:59Z",
|
|
74
75
|
* download: {
|
|
75
76
|
* expiresAt: "2025-06-30T12:00:00.000Z"
|
|
76
77
|
* }
|
|
@@ -148,7 +149,7 @@ class File_ {
|
|
|
148
149
|
*
|
|
149
150
|
* @example
|
|
150
151
|
* await client.tools.file.refresh({
|
|
151
|
-
*
|
|
152
|
+
* urls: ["https://server.trypinnacle.app/storage/v1/object/sign/vault/3/test.jpg?token=oldtoken", "https://server.trypinnacle.app/storage/v1/object/sign/vault/3/document.pdf?token=oldtoken2", "invalid/url", "https://google.com"]
|
|
152
153
|
* })
|
|
153
154
|
*/
|
|
154
155
|
refresh(request, requestOptions) {
|
|
@@ -4,18 +4,10 @@
|
|
|
4
4
|
/**
|
|
5
5
|
* @example
|
|
6
6
|
* {
|
|
7
|
-
*
|
|
7
|
+
* urls: ["https://server.trypinnacle.app/storage/v1/object/sign/vault/3/test.jpg?token=oldtoken", "https://server.trypinnacle.app/storage/v1/object/sign/vault/3/document.pdf?token=oldtoken2", "invalid/url", "https://google.com"]
|
|
8
8
|
* }
|
|
9
9
|
*/
|
|
10
10
|
export interface RefreshFileParams {
|
|
11
|
-
/**
|
|
12
|
-
|
|
13
|
-
*
|
|
14
|
-
* Accepted formats:
|
|
15
|
-
* - **Full presigned URLs**: `https://server.trypinnacle.app/storage/v1/object/sign/...`
|
|
16
|
-
* - **Short URIs**: `{BUCKET}/${TEAM_ID}/...` (e.g., `vault/3/document.pdf`)
|
|
17
|
-
*
|
|
18
|
-
* Invalid or external URLs will be returned unchanged in the response.
|
|
19
|
-
*/
|
|
20
|
-
uris: string[];
|
|
11
|
+
/** Array of file URLs to refresh for extended access. Provided URLs must be presigned URLs (i.e. `https://server.trypinnacle.app/storage/v1/object/sign/...`). Invalid or external URLs will be returned unchanged in the response. */
|
|
12
|
+
urls: string[];
|
|
21
13
|
}
|
|
@@ -8,6 +8,7 @@
|
|
|
8
8
|
* size: 1024,
|
|
9
9
|
* name: "test.jpg",
|
|
10
10
|
* options: {
|
|
11
|
+
* deleteAt: "2025-12-31T23:59:59Z",
|
|
11
12
|
* download: {
|
|
12
13
|
* expiresAt: "2025-06-30T12:00:00.000Z"
|
|
13
14
|
* }
|
|
@@ -37,6 +38,12 @@ export declare namespace UploadFileParams {
|
|
|
37
38
|
* Additional configurations for your file.
|
|
38
39
|
*/
|
|
39
40
|
interface Options {
|
|
41
|
+
/**
|
|
42
|
+
* Set a deletion date for your file in ISO 8601 format. After this date, the file will be automatically deleted from our storage.<br>
|
|
43
|
+
*
|
|
44
|
+
* If this field is not provided, the file will not be deleted. You can still schedule deletion or delete the file manually in the Storage page in the dashboard.
|
|
45
|
+
*/
|
|
46
|
+
deleteAt?: string;
|
|
40
47
|
/** Configure download settings for your uploaded file. */
|
|
41
48
|
download?: Options.Download;
|
|
42
49
|
}
|
|
@@ -22,8 +22,8 @@ export declare namespace AttachedPhoneNumberResult {
|
|
|
22
22
|
* Campaign that the phone is now attached to.
|
|
23
23
|
*/
|
|
24
24
|
interface Campaign {
|
|
25
|
-
/** Id of the campaign. */
|
|
26
|
-
id:
|
|
25
|
+
/** Id of the campaign. For `TOLL_FREE` campaigns, it will begin with the prefix `tf_`, for example: `tf_1234567890`. For `10DLC` campaigns, it will begin with the prefix `dlc_`, for example: `dlc_1234567890`. */
|
|
26
|
+
id: string;
|
|
27
27
|
/** Campaign's name. */
|
|
28
28
|
name: string;
|
|
29
29
|
type: Pinnacle.MessagingProfileEnum;
|
|
@@ -4,6 +4,11 @@
|
|
|
4
4
|
export interface AutofillCampaignParams {
|
|
5
5
|
/** Any additional information you want to provide. */
|
|
6
6
|
additionalInfo?: string;
|
|
7
|
-
/**
|
|
8
|
-
|
|
7
|
+
/**
|
|
8
|
+
* Unique identifier for the campaign.
|
|
9
|
+
* - When autofilling 10DLC campaigns, it must begin with the prefix `dlc_` (e.g., `dlc_1234567890`)
|
|
10
|
+
* - When autofilling Toll-Free campaigns, it must begin with the prefix `tf_` (e.g., `tf_1234567890`)
|
|
11
|
+
* - When autofilling RCS campaigns, it must begin with the prefix `rcs_` (e.g., `rcs_1234567890`)
|
|
12
|
+
*/
|
|
13
|
+
campaignId?: string;
|
|
9
14
|
}
|
|
@@ -5,10 +5,10 @@ import * as Pinnacle from "../index.js";
|
|
|
5
5
|
export interface AutofillDlcCampaignResponse {
|
|
6
6
|
/** Whether the campaign renews automatically. */
|
|
7
7
|
autoRenew: boolean;
|
|
8
|
-
/** Brand id. */
|
|
9
|
-
brand?:
|
|
10
|
-
/** Unique identifier for the campaign. */
|
|
11
|
-
campaignId?:
|
|
8
|
+
/** Brand id. This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`. */
|
|
9
|
+
brand?: string;
|
|
10
|
+
/** Unique identifier for the campaign. This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`. */
|
|
11
|
+
campaignId?: string;
|
|
12
12
|
/** Description of the campaign. */
|
|
13
13
|
description?: string;
|
|
14
14
|
/** Keyword response configuration. */
|