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
|
@@ -31,7 +31,7 @@ export class Conversations {
|
|
|
31
31
|
*
|
|
32
32
|
* @example
|
|
33
33
|
* await client.conversations.get({
|
|
34
|
-
* id:
|
|
34
|
+
* id: "conv_1234567890"
|
|
35
35
|
* })
|
|
36
36
|
*/
|
|
37
37
|
get(request, requestOptions) {
|
|
@@ -101,8 +101,8 @@ export class Conversations {
|
|
|
101
101
|
*
|
|
102
102
|
* @example
|
|
103
103
|
* await client.conversations.list({
|
|
104
|
-
* brandId:
|
|
105
|
-
* campaignId:
|
|
104
|
+
* brandId: "b_1234567890",
|
|
105
|
+
* campaignId: "tf_1234567890",
|
|
106
106
|
* campaignType: "TOLL_FREE",
|
|
107
107
|
* pageIndex: 0,
|
|
108
108
|
* pageSize: 20,
|
|
@@ -177,7 +177,7 @@ export class Conversations {
|
|
|
177
177
|
*
|
|
178
178
|
* @example
|
|
179
179
|
* await client.conversations.update({
|
|
180
|
-
* id:
|
|
180
|
+
* id: "conv_1234567890",
|
|
181
181
|
* notes: "Follow-up completed. Customer satisfied with resolution."
|
|
182
182
|
* })
|
|
183
183
|
*/
|
|
@@ -239,6 +239,101 @@ export class Conversations {
|
|
|
239
239
|
}
|
|
240
240
|
});
|
|
241
241
|
}
|
|
242
|
+
/**
|
|
243
|
+
* Retrieve a paginated and filtered list of messages for a specific conversation.
|
|
244
|
+
*
|
|
245
|
+
* @param {string} id - Unique identifier of the conversation. This identifier is a string that always begins with the prefix `conv_`, for example: `conv_1234567890`.
|
|
246
|
+
* @param {Pinnacle.ConversationsListMessagesRequest} request
|
|
247
|
+
* @param {Conversations.RequestOptions} requestOptions - Request-specific configuration.
|
|
248
|
+
*
|
|
249
|
+
* @throws {@link Pinnacle.BadRequestError}
|
|
250
|
+
* @throws {@link Pinnacle.UnauthorizedError}
|
|
251
|
+
* @throws {@link Pinnacle.NotFoundError}
|
|
252
|
+
* @throws {@link Pinnacle.InternalServerError}
|
|
253
|
+
*
|
|
254
|
+
* @example
|
|
255
|
+
* await client.conversations.listMessages("id")
|
|
256
|
+
*/
|
|
257
|
+
listMessages(id, request = {}, requestOptions) {
|
|
258
|
+
return core.HttpResponsePromise.fromPromise(this.__listMessages(id, request, requestOptions));
|
|
259
|
+
}
|
|
260
|
+
__listMessages(id_1) {
|
|
261
|
+
return __awaiter(this, arguments, void 0, function* (id, request = {}, requestOptions) {
|
|
262
|
+
var _a, _b, _c;
|
|
263
|
+
const { pageIndex, pageSize, sortOrder, direction, status, type: type_, dateFrom, dateTo } = request;
|
|
264
|
+
const _queryParams = {};
|
|
265
|
+
if (pageIndex != null) {
|
|
266
|
+
_queryParams["pageIndex"] = pageIndex.toString();
|
|
267
|
+
}
|
|
268
|
+
if (pageSize != null) {
|
|
269
|
+
_queryParams["pageSize"] = pageSize.toString();
|
|
270
|
+
}
|
|
271
|
+
if (sortOrder != null) {
|
|
272
|
+
_queryParams["sortOrder"] = sortOrder;
|
|
273
|
+
}
|
|
274
|
+
if (direction != null) {
|
|
275
|
+
_queryParams["direction"] = direction;
|
|
276
|
+
}
|
|
277
|
+
if (status != null) {
|
|
278
|
+
_queryParams["status"] = status;
|
|
279
|
+
}
|
|
280
|
+
if (type_ != null) {
|
|
281
|
+
_queryParams["type"] = type_;
|
|
282
|
+
}
|
|
283
|
+
if (dateFrom != null) {
|
|
284
|
+
_queryParams["dateFrom"] = dateFrom;
|
|
285
|
+
}
|
|
286
|
+
if (dateTo != null) {
|
|
287
|
+
_queryParams["dateTo"] = dateTo;
|
|
288
|
+
}
|
|
289
|
+
let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
290
|
+
const _response = yield core.fetcher({
|
|
291
|
+
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, `conversations/${encodeURIComponent(id)}/messages`),
|
|
292
|
+
method: "POST",
|
|
293
|
+
headers: _headers,
|
|
294
|
+
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
295
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
296
|
+
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
297
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
298
|
+
});
|
|
299
|
+
if (_response.ok) {
|
|
300
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
301
|
+
}
|
|
302
|
+
if (_response.error.reason === "status-code") {
|
|
303
|
+
switch (_response.error.statusCode) {
|
|
304
|
+
case 400:
|
|
305
|
+
throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
|
|
306
|
+
case 401:
|
|
307
|
+
throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
308
|
+
case 404:
|
|
309
|
+
throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
|
|
310
|
+
case 500:
|
|
311
|
+
throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
|
|
312
|
+
default:
|
|
313
|
+
throw new errors.PinnacleError({
|
|
314
|
+
statusCode: _response.error.statusCode,
|
|
315
|
+
body: _response.error.body,
|
|
316
|
+
rawResponse: _response.rawResponse,
|
|
317
|
+
});
|
|
318
|
+
}
|
|
319
|
+
}
|
|
320
|
+
switch (_response.error.reason) {
|
|
321
|
+
case "non-json":
|
|
322
|
+
throw new errors.PinnacleError({
|
|
323
|
+
statusCode: _response.error.statusCode,
|
|
324
|
+
body: _response.error.rawBody,
|
|
325
|
+
rawResponse: _response.rawResponse,
|
|
326
|
+
});
|
|
327
|
+
case "timeout":
|
|
328
|
+
throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /conversations/{id}/messages.");
|
|
329
|
+
case "unknown":
|
|
330
|
+
throw new errors.PinnacleError({
|
|
331
|
+
message: _response.error.errorMessage,
|
|
332
|
+
rawResponse: _response.rawResponse,
|
|
333
|
+
});
|
|
334
|
+
}
|
|
335
|
+
});
|
|
336
|
+
}
|
|
242
337
|
_getCustomAuthorizationHeaders() {
|
|
243
338
|
return __awaiter(this, void 0, void 0, function* () {
|
|
244
339
|
const apiKeyValue = yield core.Supplier.get(this._options.apiKey);
|
package/dist/esm/api/resources/conversations/client/requests/ConversationsListMessagesRequest.d.mts
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as Pinnacle from "../../../../index.mjs";
|
|
5
|
+
/**
|
|
6
|
+
* @example
|
|
7
|
+
* {}
|
|
8
|
+
*/
|
|
9
|
+
export interface ConversationsListMessagesRequest {
|
|
10
|
+
/** Zero-based index for pagination. */
|
|
11
|
+
pageIndex?: number;
|
|
12
|
+
/** Number of messages to return per page. */
|
|
13
|
+
pageSize?: number;
|
|
14
|
+
/**
|
|
15
|
+
* Sort order for messages. <br>
|
|
16
|
+
*
|
|
17
|
+
* - `asc`: Oldest messages first
|
|
18
|
+
* - `desc`: Newest messages first (default)
|
|
19
|
+
*/
|
|
20
|
+
sortOrder?: Pinnacle.ConversationsListMessagesRequestSortOrder;
|
|
21
|
+
/**
|
|
22
|
+
* Filter messages by direction. <br>
|
|
23
|
+
*
|
|
24
|
+
* - `INBOUND`: Messages received from contacts
|
|
25
|
+
* - `OUTBOUND`: Messages sent to contacts
|
|
26
|
+
*/
|
|
27
|
+
direction?: Pinnacle.ConversationsListMessagesRequestDirection;
|
|
28
|
+
/** Filter messages by delivery status. */
|
|
29
|
+
status?: Pinnacle.ConversationsListMessagesRequestStatus;
|
|
30
|
+
/** Filter messages by protocol type. */
|
|
31
|
+
type?: Pinnacle.ConversationsListMessagesRequestType;
|
|
32
|
+
/** Filter messages sent on or after this date (ISO 8601 format). */
|
|
33
|
+
dateFrom?: string;
|
|
34
|
+
/** Filter messages sent on or before this date (ISO 8601 format). */
|
|
35
|
+
dateTo?: string;
|
|
36
|
+
}
|
|
@@ -5,8 +5,8 @@ import * as Pinnacle from "../../../../index.mjs";
|
|
|
5
5
|
/**
|
|
6
6
|
* @example
|
|
7
7
|
* {
|
|
8
|
-
* brandId:
|
|
9
|
-
* campaignId:
|
|
8
|
+
* brandId: "b_1234567890",
|
|
9
|
+
* campaignId: "tf_1234567890",
|
|
10
10
|
* campaignType: "TOLL_FREE",
|
|
11
11
|
* pageIndex: 0,
|
|
12
12
|
* pageSize: 20,
|
|
@@ -15,10 +15,15 @@ import * as Pinnacle from "../../../../index.mjs";
|
|
|
15
15
|
* }
|
|
16
16
|
*/
|
|
17
17
|
export interface ListConversationsParams {
|
|
18
|
-
/** The unique identifier of the brand to filter conversations. */
|
|
19
|
-
brandId?:
|
|
20
|
-
/**
|
|
21
|
-
|
|
18
|
+
/** The unique identifier of the brand to filter conversations. This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`. */
|
|
19
|
+
brandId?: string;
|
|
20
|
+
/**
|
|
21
|
+
* The unique identifier of the campaign to filter conversations. This identifier is a string that begins with the prefix:
|
|
22
|
+
* - TOLL_FREE: `tf_` (e.g., `tf_1234567890`)
|
|
23
|
+
* - 10DLC: `dlc_` (e.g., `dlc_1234567890`)
|
|
24
|
+
* - RCS: `rcs_` (e.g., `rcs_1234567890`)
|
|
25
|
+
*/
|
|
26
|
+
campaignId?: string;
|
|
22
27
|
campaignType?: Pinnacle.CampaignEnum;
|
|
23
28
|
/** Zero-based index for pagination. */
|
|
24
29
|
pageIndex: number;
|
|
@@ -4,13 +4,13 @@
|
|
|
4
4
|
/**
|
|
5
5
|
* @example
|
|
6
6
|
* {
|
|
7
|
-
* id:
|
|
7
|
+
* id: "conv_1234567890",
|
|
8
8
|
* notes: "Follow-up completed. Customer satisfied with resolution."
|
|
9
9
|
* }
|
|
10
10
|
*/
|
|
11
11
|
export interface UpdateConversationParams {
|
|
12
|
-
/** The unique identifier of the conversation to update. */
|
|
13
|
-
id:
|
|
12
|
+
/** The unique identifier of the conversation to update. This identifier is a string that always begins with the prefix `conv_`, for example: `conv_1234567890`. */
|
|
13
|
+
id: string;
|
|
14
14
|
/** New notes or comments for the conversation. */
|
|
15
15
|
notes: string;
|
|
16
16
|
}
|
package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestDirection.d.mts
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
export type ConversationsListMessagesRequestDirection = "INBOUND" | "OUTBOUND";
|
|
5
|
+
export declare const ConversationsListMessagesRequestDirection: {
|
|
6
|
+
readonly Inbound: "INBOUND";
|
|
7
|
+
readonly Outbound: "OUTBOUND";
|
|
8
|
+
};
|
package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestSortOrder.d.mts
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
export type ConversationsListMessagesRequestSortOrder = "asc" | "desc";
|
|
5
|
+
export declare const ConversationsListMessagesRequestSortOrder: {
|
|
6
|
+
readonly Asc: "asc";
|
|
7
|
+
readonly Desc: "desc";
|
|
8
|
+
};
|
package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestStatus.d.mts
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
export type ConversationsListMessagesRequestStatus = "PENDING" | "SENT" | "SEND_FAILED" | "DELIVERED" | "DELIVERY_FAILED" | "RECEIVED" | "READ";
|
|
5
|
+
export declare const ConversationsListMessagesRequestStatus: {
|
|
6
|
+
readonly Pending: "PENDING";
|
|
7
|
+
readonly Sent: "SENT";
|
|
8
|
+
readonly SendFailed: "SEND_FAILED";
|
|
9
|
+
readonly Delivered: "DELIVERED";
|
|
10
|
+
readonly DeliveryFailed: "DELIVERY_FAILED";
|
|
11
|
+
readonly Received: "RECEIVED";
|
|
12
|
+
readonly Read: "READ";
|
|
13
|
+
};
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
export const ConversationsListMessagesRequestStatus = {
|
|
5
|
+
Pending: "PENDING",
|
|
6
|
+
Sent: "SENT",
|
|
7
|
+
SendFailed: "SEND_FAILED",
|
|
8
|
+
Delivered: "DELIVERED",
|
|
9
|
+
DeliveryFailed: "DELIVERY_FAILED",
|
|
10
|
+
Received: "RECEIVED",
|
|
11
|
+
Read: "READ",
|
|
12
|
+
};
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
export type ConversationsListMessagesRequestType = "SMS" | "MMS" | "RCS";
|
|
5
|
+
export declare const ConversationsListMessagesRequestType: {
|
|
6
|
+
readonly Sms: "SMS";
|
|
7
|
+
readonly Mms: "MMS";
|
|
8
|
+
readonly Rcs: "RCS";
|
|
9
|
+
};
|
|
@@ -1,10 +1,11 @@
|
|
|
1
|
+
export * as conversations from "./conversations/index.mjs";
|
|
2
|
+
export * from "./conversations/types/index.mjs";
|
|
1
3
|
export * as phoneNumbers from "./phoneNumbers/index.mjs";
|
|
2
4
|
export * from "./phoneNumbers/types/index.mjs";
|
|
3
5
|
export * as campaigns from "./campaigns/index.mjs";
|
|
4
6
|
export * as messages from "./messages/index.mjs";
|
|
5
7
|
export * as brands from "./brands/index.mjs";
|
|
6
8
|
export * as contacts from "./contacts/index.mjs";
|
|
7
|
-
export * as conversations from "./conversations/index.mjs";
|
|
8
9
|
export * as rcs from "./rcs/index.mjs";
|
|
9
10
|
export * as webhooks from "./webhooks/index.mjs";
|
|
10
11
|
export * as status from "./status/index.mjs";
|
|
@@ -1,10 +1,11 @@
|
|
|
1
|
+
export * as conversations from "./conversations/index.mjs";
|
|
2
|
+
export * from "./conversations/types/index.mjs";
|
|
1
3
|
export * as phoneNumbers from "./phoneNumbers/index.mjs";
|
|
2
4
|
export * from "./phoneNumbers/types/index.mjs";
|
|
3
5
|
export * as campaigns from "./campaigns/index.mjs";
|
|
4
6
|
export * as messages from "./messages/index.mjs";
|
|
5
7
|
export * as brands from "./brands/index.mjs";
|
|
6
8
|
export * as contacts from "./contacts/index.mjs";
|
|
7
|
-
export * as conversations from "./conversations/index.mjs";
|
|
8
9
|
export * as rcs from "./rcs/index.mjs";
|
|
9
10
|
export * as webhooks from "./webhooks/index.mjs";
|
|
10
11
|
export * as status from "./status/index.mjs";
|
|
@@ -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
|
* },
|
|
@@ -37,7 +37,7 @@ export class Messages {
|
|
|
37
37
|
/**
|
|
38
38
|
* Retrieve a previously sent message.
|
|
39
39
|
*
|
|
40
|
-
* @param {
|
|
40
|
+
* @param {string} id - Unique identifier of the message. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`.
|
|
41
41
|
* @param {Messages.RequestOptions} requestOptions - Request-specific configuration.
|
|
42
42
|
*
|
|
43
43
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -46,7 +46,7 @@ export class Messages {
|
|
|
46
46
|
* @throws {@link Pinnacle.InternalServerError}
|
|
47
47
|
*
|
|
48
48
|
* @example
|
|
49
|
-
* await client.messages.get(
|
|
49
|
+
* await client.messages.get("msg_1234567890")
|
|
50
50
|
*/
|
|
51
51
|
get(id, requestOptions) {
|
|
52
52
|
return core.HttpResponsePromise.fromPromise(this.__get(id, requestOptions));
|
|
@@ -117,7 +117,7 @@ export class Messages {
|
|
|
117
117
|
*
|
|
118
118
|
* @example
|
|
119
119
|
* await client.messages.react({
|
|
120
|
-
* messageId:
|
|
120
|
+
* messageId: "msg_1234567890",
|
|
121
121
|
* options: {
|
|
122
122
|
* force: true
|
|
123
123
|
* },
|
|
@@ -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>;
|
|
@@ -35,7 +35,7 @@ export class Campaign {
|
|
|
35
35
|
* await client.phoneNumbers.campaign.attach({
|
|
36
36
|
* phones: ["+14155550123", "+14155559876", "+14155550111"],
|
|
37
37
|
* campaignType: "TOLL_FREE",
|
|
38
|
-
* campaignId:
|
|
38
|
+
* campaignId: "tf_1234567890"
|
|
39
39
|
* })
|
|
40
40
|
*/
|
|
41
41
|
attach(request, requestOptions) {
|
|
@@ -7,13 +7,22 @@ import * as Pinnacle from "../../../../../../index.mjs";
|
|
|
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;
|
|
@@ -36,7 +36,7 @@ export class Webhook {
|
|
|
36
36
|
*
|
|
37
37
|
* @example
|
|
38
38
|
* await client.phoneNumbers.webhook.attach("%2B14155551234", {
|
|
39
|
-
* webhookId:
|
|
39
|
+
* webhookId: "wh_1234567890",
|
|
40
40
|
* event: "MESSAGE.STATUS"
|
|
41
41
|
* })
|
|
42
42
|
*/
|
|
@@ -107,9 +107,9 @@ export class Webhook {
|
|
|
107
107
|
* @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>
|
|
108
108
|
*
|
|
109
109
|
* Must be a phone number that you own and currently has the specified webhook attached.
|
|
110
|
-
* @param {
|
|
110
|
+
* @param {string} webhookId - The unique identifier of the webhook you want to detach from the phone number. <br>
|
|
111
111
|
*
|
|
112
|
-
* This must be a valid webhook ID that is currently attached to the specified phone number.
|
|
112
|
+
* 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`.
|
|
113
113
|
* @param {Webhook.RequestOptions} requestOptions - Request-specific configuration.
|
|
114
114
|
*
|
|
115
115
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -119,7 +119,7 @@ export class Webhook {
|
|
|
119
119
|
* @throws {@link Pinnacle.NotImplementedError}
|
|
120
120
|
*
|
|
121
121
|
* @example
|
|
122
|
-
* await client.phoneNumbers.webhook.detach("+14155551234",
|
|
122
|
+
* await client.phoneNumbers.webhook.detach("+14155551234", "wh_1234567890")
|
|
123
123
|
*/
|
|
124
124
|
detach(phone, webhookId, requestOptions) {
|
|
125
125
|
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.
|
|
@@ -100,23 +100,27 @@ export class Rcs {
|
|
|
100
100
|
*
|
|
101
101
|
* ## Overview
|
|
102
102
|
* During development and testing, RCS agents can only send messages to whitelisted phone numbers.
|
|
103
|
-
* Use this endpoint to
|
|
103
|
+
* Use this endpoint to whitelist specific phone numbers to send and receive messages from the test agent.
|
|
104
104
|
*
|
|
105
105
|
* ## Verification Process
|
|
106
106
|
* After whitelisting a number, you'll need to complete verification:
|
|
107
107
|
*
|
|
108
|
-
* 1. Check the test device for
|
|
109
|
-
* 2.
|
|
110
|
-
* 3. Enter the 4-digit verification code in the Pinnacle dashboard at:
|
|
108
|
+
* 1. Check the test device for message from "RBM Tester Management"
|
|
109
|
+
* 2. Click the "Make me a tester" button
|
|
110
|
+
* 3. Enter the separate 4-digit verification SMS code in the Pinnacle dashboard at:
|
|
111
111
|
* ```
|
|
112
112
|
* https://app.pinnacle.sh/dashboard/brands/{brandId}?campaignId={campaignId}&campaignType=RCS
|
|
113
113
|
* ```
|
|
114
114
|
*
|
|
115
|
+
* > **⚠️ Important: Re-whitelisting Numbers**
|
|
116
|
+
* >
|
|
117
|
+
* > 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.**
|
|
118
|
+
*
|
|
115
119
|
* > **Important Notes**
|
|
116
120
|
* >
|
|
117
|
-
* > - **
|
|
118
|
-
* > - **
|
|
119
|
-
* > - **
|
|
121
|
+
* > - **Verification required:** Messages cannot be sent nor received until you have clicked the "Make me a tester" button on the test device.
|
|
122
|
+
* > - **Testing only:** This is only required for test agents. Production agents can message any RCS-enabled number.
|
|
123
|
+
* > - **Network limitations:** Whitelisting may be temporarily unavailable for some carriers but are usually restored shortly.
|
|
120
124
|
*
|
|
121
125
|
* @param {Pinnacle.RcsWhitelistRequest} request
|
|
122
126
|
* @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
|