rcs-js 2.0.1 → 2.0.3-rc.1
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/messages/resources/index.d.ts +1 -0
- package/dist/cjs/api/resources/messages/resources/index.js +1 -0
- package/dist/cjs/api/resources/messages/resources/rcs/client/Client.d.ts +33 -0
- package/dist/cjs/api/resources/messages/resources/rcs/client/Client.js +90 -0
- package/dist/cjs/api/resources/messages/resources/rcs/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/messages/resources/rcs/client/index.js +15 -0
- package/dist/cjs/api/resources/messages/resources/rcs/client/requests/SendTypingIndicatorSchema.d.ts +38 -0
- package/dist/cjs/api/resources/messages/resources/rcs/client/requests/SendTypingIndicatorSchema.js +5 -0
- package/dist/cjs/api/resources/messages/resources/rcs/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/messages/resources/rcs/client/requests/index.js +2 -0
- 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/Options.d.ts +21 -0
- package/dist/cjs/api/types/Options.js +5 -0
- package/dist/cjs/api/types/RcsButtonOpenUrl.d.ts +31 -2
- package/dist/cjs/api/types/RcsButtonOpenUrl.js +9 -0
- package/dist/cjs/api/types/RcsButtonSendLocation.d.ts +8 -2
- 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/RichCardsMessage.d.ts +51 -1
- package/dist/cjs/api/types/RichCardsMessage.js +18 -0
- package/dist/cjs/api/types/ScheduledMessaage.d.ts +2 -2
- package/dist/cjs/api/types/SendTypingIndicatorResponse.d.ts +22 -0
- package/dist/cjs/api/types/SendTypingIndicatorResponse.js +5 -0
- 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 +13 -0
- package/dist/cjs/api/types/index.js +13 -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/messages/resources/index.d.mts +1 -0
- package/dist/esm/api/resources/messages/resources/index.mjs +1 -0
- package/dist/esm/api/resources/messages/resources/rcs/client/Client.d.mts +33 -0
- package/dist/esm/api/resources/messages/resources/rcs/client/Client.mjs +90 -0
- package/dist/esm/api/resources/messages/resources/rcs/client/index.d.mts +1 -0
- package/dist/esm/api/resources/messages/resources/rcs/client/index.mjs +1 -1
- package/dist/esm/api/resources/messages/resources/rcs/client/requests/SendTypingIndicatorSchema.d.mts +38 -0
- package/dist/esm/api/resources/messages/resources/rcs/client/requests/SendTypingIndicatorSchema.mjs +4 -0
- package/dist/esm/api/resources/messages/resources/rcs/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/messages/resources/rcs/client/requests/index.mjs +1 -0
- 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/Options.d.mts +21 -0
- package/dist/esm/api/types/Options.mjs +4 -0
- package/dist/esm/api/types/RcsButtonOpenUrl.d.mts +31 -2
- package/dist/esm/api/types/RcsButtonOpenUrl.mjs +8 -1
- package/dist/esm/api/types/RcsButtonSendLocation.d.mts +8 -2
- 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/RichCardsMessage.d.mts +51 -1
- package/dist/esm/api/types/RichCardsMessage.mjs +17 -1
- package/dist/esm/api/types/ScheduledMessaage.d.mts +2 -2
- package/dist/esm/api/types/SendTypingIndicatorResponse.d.mts +22 -0
- package/dist/esm/api/types/SendTypingIndicatorResponse.mjs +4 -0
- 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 +13 -0
- package/dist/esm/api/types/index.mjs +13 -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 +235 -73
|
@@ -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. */
|
|
@@ -8,8 +8,8 @@ import * as Pinnacle from "../index.js";
|
|
|
8
8
|
export interface BrandStatus {
|
|
9
9
|
/** List of errors that occurred. */
|
|
10
10
|
errors: string[];
|
|
11
|
-
/**
|
|
12
|
-
id:
|
|
11
|
+
/** The unique identifier of the brand. This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`. */
|
|
12
|
+
id: string;
|
|
13
13
|
/**
|
|
14
14
|
* Current review status of the brand. <br>
|
|
15
15
|
*
|
|
@@ -8,8 +8,8 @@ import * as Pinnacle from "../index.js";
|
|
|
8
8
|
export interface ButtonClickedData {
|
|
9
9
|
/** Information about the button that was clicked. */
|
|
10
10
|
button: ButtonClickedData.Button;
|
|
11
|
-
/** ID of the message this button was
|
|
12
|
-
messageId:
|
|
11
|
+
/** ID of the message this button was sent in, or null if not available. To get the message details, use the [GET /messages/{id}](/api-reference/messages/get) endpoint. */
|
|
12
|
+
messageId: string | null;
|
|
13
13
|
}
|
|
14
14
|
export declare namespace ButtonClickedData {
|
|
15
15
|
/**
|
|
@@ -6,7 +6,12 @@ import * as Pinnacle from "../index.js";
|
|
|
6
6
|
* Information about the campaign associated with a conversation
|
|
7
7
|
*/
|
|
8
8
|
export interface CampaignQuery {
|
|
9
|
-
/**
|
|
9
|
+
/**
|
|
10
|
+
* Unique identifier for the campaign. This identifier is a string that begins with the prefix:
|
|
11
|
+
* - TOLL_FREE: `tf_` (e.g., `tf_1234567890`)
|
|
12
|
+
* - 10DLC: `dlc_` (e.g., `dlc_1234567890`)
|
|
13
|
+
* - RCS: `rcs_` (e.g., `rcs_1234567890`)
|
|
14
|
+
*/
|
|
10
15
|
id: string;
|
|
11
16
|
type: Pinnacle.CampaignEnum;
|
|
12
17
|
}
|
|
@@ -19,8 +19,8 @@ export declare namespace ConfiguredWebhook {
|
|
|
19
19
|
* Detailed information about the attached webhook.
|
|
20
20
|
*/
|
|
21
21
|
interface Webhook {
|
|
22
|
-
/** Unique identifier of the webhook within the account. */
|
|
23
|
-
id:
|
|
22
|
+
/** Unique identifier of the webhook within the account. This identifier is a string that always begins with the prefix `wh_`, for example: `wh_1234567890`. */
|
|
23
|
+
id: string;
|
|
24
24
|
/** Name of the webhook. */
|
|
25
25
|
name: string;
|
|
26
26
|
/** The HTTPS endpoint URL where webhook events will be sent as HTTP POST requests. */
|
|
@@ -6,8 +6,8 @@ export interface Contact {
|
|
|
6
6
|
description?: string;
|
|
7
7
|
/** Contact's email address, if available. */
|
|
8
8
|
email?: string;
|
|
9
|
-
/** Unique ID of the contact. */
|
|
10
|
-
id:
|
|
9
|
+
/** Unique ID of the contact. This identifier is a string that always begins with the prefix `co_`, for example: `co_1234567890`. */
|
|
10
|
+
id: string;
|
|
11
11
|
/** Full name of the contact, if available. */
|
|
12
12
|
name?: string;
|
|
13
13
|
/** Contact's phone number in E.164 format. */
|
|
@@ -2,6 +2,6 @@
|
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
4
|
export interface ContactId {
|
|
5
|
-
/** Unique ID of the created contact. */
|
|
6
|
-
id:
|
|
5
|
+
/** Unique ID of the created contact. This identifier is a string that always begins with the prefix `co_`, for example: `co_1234567890`. */
|
|
6
|
+
id: string;
|
|
7
7
|
}
|
|
@@ -6,16 +6,16 @@ import * as Pinnacle from "../index.js";
|
|
|
6
6
|
* Conversation that was found.
|
|
7
7
|
*/
|
|
8
8
|
export interface Conversation {
|
|
9
|
-
/**
|
|
10
|
-
brandId:
|
|
11
|
-
/** Campaign information if this conversation is part of a marketing campaign. */
|
|
9
|
+
/** The unique identifier of the brand associated with this conversation. This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`. */
|
|
10
|
+
brandId: string | null;
|
|
11
|
+
/** Campaign information if this conversation is part of a marketing campaign. This is an object that contains the campaign ID and type. */
|
|
12
12
|
campaign: Pinnacle.CampaignQuery | null;
|
|
13
13
|
/** Contact information for the recipient in a conversation. */
|
|
14
14
|
contact: Conversation.Contact;
|
|
15
15
|
/** ISO 8601 timestamp when the conversation was created. */
|
|
16
16
|
createdAt: string;
|
|
17
|
-
/** Unique identifier for the conversation. */
|
|
18
|
-
id:
|
|
17
|
+
/** Unique identifier for the conversation. This identifier is a string that always begins with the prefix `conv_`, for example: `conv_1234567890`. */
|
|
18
|
+
id: string;
|
|
19
19
|
/** Free-form notes or comments about the conversation. */
|
|
20
20
|
notes: string;
|
|
21
21
|
/**
|
|
@@ -33,8 +33,8 @@ export declare namespace Conversation {
|
|
|
33
33
|
* Contact information for the recipient in a conversation.
|
|
34
34
|
*/
|
|
35
35
|
interface Contact {
|
|
36
|
-
/** Unique
|
|
37
|
-
id:
|
|
36
|
+
/** Unique ID of the contact. This identifier is a string that always begins with the prefix `co_`, for example: `co_1234567890`. */
|
|
37
|
+
id: string;
|
|
38
38
|
/** The contact's phone number in E.164 format. */
|
|
39
39
|
phoneNumber: string;
|
|
40
40
|
}
|
|
@@ -5,10 +5,10 @@ import * as Pinnacle from "../index.js";
|
|
|
5
5
|
/**
|
|
6
6
|
* Response for list conversation.
|
|
7
7
|
*/
|
|
8
|
-
export
|
|
9
|
-
|
|
10
|
-
} | {
|
|
8
|
+
export interface ConversationList {
|
|
9
|
+
/** Total number of conversations matching the filter. */
|
|
11
10
|
count: number;
|
|
12
11
|
conversations: Pinnacle.Conversation[];
|
|
12
|
+
/** Indicates if more conversations are available beyond the current page. */
|
|
13
13
|
hasMore: boolean;
|
|
14
|
-
}
|
|
14
|
+
}
|
|
@@ -22,8 +22,8 @@ export declare namespace DetachedPhoneNumberResult {
|
|
|
22
22
|
* Campaign that the phone is now detached from.
|
|
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,8 +4,8 @@
|
|
|
4
4
|
export interface DetachedWebhookInfo {
|
|
5
5
|
/** Confirmation message. */
|
|
6
6
|
message: string;
|
|
7
|
-
/**
|
|
8
|
-
webhookId:
|
|
7
|
+
/** Unique identifier of the webhook within the account. This identifier is a string that always begins with the prefix `wh_`, for example: `wh_1234567890`. */
|
|
8
|
+
webhookId: string;
|
|
9
9
|
/** Phone number the webhook was detached from in E.164 format. */
|
|
10
10
|
phoneNumber: string;
|
|
11
11
|
}
|
|
@@ -12,8 +12,8 @@ export interface DlcCampaignStatus {
|
|
|
12
12
|
* These errors may request additional information or point out erroneous and/or missing fields.
|
|
13
13
|
*/
|
|
14
14
|
error: string;
|
|
15
|
-
/**
|
|
16
|
-
id:
|
|
15
|
+
/** The unique identifier of the 10DLC campaign. This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`. */
|
|
16
|
+
id: string;
|
|
17
17
|
/**
|
|
18
18
|
* Current review status of the DLC campaign. <br>
|
|
19
19
|
*
|
|
@@ -10,8 +10,8 @@ export interface DlcCampaignWithExtendedBrandAndStatus {
|
|
|
10
10
|
autoRenew: boolean;
|
|
11
11
|
/** Brand associated with this campaign. */
|
|
12
12
|
brand: Pinnacle.ExtendedBrand;
|
|
13
|
-
/** Unique identifier for the campaign. */
|
|
14
|
-
campaignId?:
|
|
13
|
+
/** Unique identifier for the campaign. This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`. */
|
|
14
|
+
campaignId?: string;
|
|
15
15
|
/** Description of the campaign. */
|
|
16
16
|
description?: string;
|
|
17
17
|
/** Keyword response configuration. */
|
|
@@ -5,8 +5,8 @@ import * as Pinnacle from "../index.js";
|
|
|
5
5
|
export interface ExtendedBrand extends Pinnacle.OptionalBrandInfo {
|
|
6
6
|
/** ISO 8601 formatted timestamp of when this brand was added to our system. */
|
|
7
7
|
createdAt: string;
|
|
8
|
-
/** The brand's ID. */
|
|
9
|
-
id:
|
|
8
|
+
/** The brand's ID. This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`. */
|
|
9
|
+
id: string;
|
|
10
10
|
/** Indicates if this brand is archived. */
|
|
11
11
|
isArchived: boolean;
|
|
12
12
|
/**
|
|
@@ -13,8 +13,8 @@ export interface ExtendedRcsCampaign {
|
|
|
13
13
|
brandVerificationUrl?: string;
|
|
14
14
|
/** Indicates whether the brand has provided an attestation. */
|
|
15
15
|
brandAttestation: boolean;
|
|
16
|
-
/** Unique identifier for the campaign. */
|
|
17
|
-
campaignId?:
|
|
16
|
+
/** Unique identifier for the campaign. This identifier is a string that always begins with the prefix `rcs_`, for example: `rcs_1234567890`. */
|
|
17
|
+
campaignId?: string;
|
|
18
18
|
/** List of what the agent might say to users. */
|
|
19
19
|
expectedAgentResponses?: string[];
|
|
20
20
|
/** Legal documentation links. */
|
|
@@ -36,8 +36,6 @@ export interface LinkClickEvent {
|
|
|
36
36
|
fingerprint_id?: string | null;
|
|
37
37
|
/** Google Click Identifier. */
|
|
38
38
|
gclid?: string | null;
|
|
39
|
-
/** Unique identifier for the click event. */
|
|
40
|
-
id: number;
|
|
41
39
|
/** IP address of the visitor (may be anonymized). */
|
|
42
40
|
ip_address?: string | null;
|
|
43
41
|
/** Chain of IP addresses for proxied requests. */
|
|
@@ -48,8 +46,6 @@ export interface LinkClickEvent {
|
|
|
48
46
|
latency_ms?: number | null;
|
|
49
47
|
/** Geographic latitude. */
|
|
50
48
|
latitude?: number | null;
|
|
51
|
-
/** ID of your shortened URL. */
|
|
52
|
-
link_id: number;
|
|
53
49
|
/** Geographic longitude. */
|
|
54
50
|
longitude?: number | null;
|
|
55
51
|
/** Additional metadata as JSON object. */
|
|
@@ -22,8 +22,8 @@ export interface Message {
|
|
|
22
22
|
* Null indicates no errors.
|
|
23
23
|
*/
|
|
24
24
|
error: string | null;
|
|
25
|
-
/** Unique identifier of the message. */
|
|
26
|
-
id:
|
|
25
|
+
/** Unique identifier of the message. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`. */
|
|
26
|
+
id: string;
|
|
27
27
|
method: Pinnacle.MessageMethodEnum;
|
|
28
28
|
/** Number of segments the message was split into for delivery. */
|
|
29
29
|
numSegments: number;
|
|
@@ -22,16 +22,18 @@ export interface MessageEvent {
|
|
|
22
22
|
* Null if not yet delivered or for inbound messages.
|
|
23
23
|
*/
|
|
24
24
|
deliveredAt?: string | null;
|
|
25
|
-
|
|
26
|
-
message: MessageEvent.Message;
|
|
25
|
+
message: Pinnacle.MessageEventContent;
|
|
27
26
|
}
|
|
28
27
|
export declare namespace MessageEvent {
|
|
29
28
|
/**
|
|
30
29
|
* Conversation metadata containing the conversation ID, sender, and recipient information.
|
|
31
30
|
*/
|
|
32
31
|
interface Conversation {
|
|
33
|
-
/**
|
|
34
|
-
|
|
32
|
+
/**
|
|
33
|
+
* Unique identifier for the conversation. This identifier is a string that always begins with the prefix `conv_`, for example: `conv_1234567890`. <br><br>
|
|
34
|
+
* To get more conversation details, use the [POST /conversations/get](/api-reference/conversations/get) endpoint.
|
|
35
|
+
*/
|
|
36
|
+
id: string;
|
|
35
37
|
/** Sender's phone number or agent ID. */
|
|
36
38
|
from: string;
|
|
37
39
|
/** Recipient's phone number. */
|
|
@@ -45,12 +47,4 @@ export declare namespace MessageEvent {
|
|
|
45
47
|
readonly Inbound: "INBOUND";
|
|
46
48
|
readonly Outbound: "OUTBOUND";
|
|
47
49
|
};
|
|
48
|
-
/**
|
|
49
|
-
* Message details including ID and content.
|
|
50
|
-
*/
|
|
51
|
-
interface Message {
|
|
52
|
-
/** Unique identifier of the message. To get the message details, use the [GET /messages/{id}](/api-reference/messages/get) endpoint. */
|
|
53
|
-
id: number;
|
|
54
|
-
content: Pinnacle.MessageContent;
|
|
55
|
-
}
|
|
56
50
|
}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as Pinnacle from "../index.js";
|
|
5
|
+
/**
|
|
6
|
+
* Content of an incoming or outgoing message. Discriminated by the `type` field.
|
|
7
|
+
*/
|
|
8
|
+
export type MessageEventContent =
|
|
9
|
+
/**
|
|
10
|
+
* SMS message containing plain text only. Has type `SMS`. */
|
|
11
|
+
Pinnacle.MessageEventSmsContent
|
|
12
|
+
/**
|
|
13
|
+
* MMS message with text and/or media files from a phone number. Has type `MMS`. */
|
|
14
|
+
| Pinnacle.MessageEventMmsContent
|
|
15
|
+
/**
|
|
16
|
+
* RCS message containing longer text content with optional quick reply buttons. Has type `RCS_TEXT`. */
|
|
17
|
+
| Pinnacle.MessageEventRcsTextContent
|
|
18
|
+
/**
|
|
19
|
+
* RCS message containing media file with optional quick reply buttons. Has type `RCS_MEDIA`. */
|
|
20
|
+
| Pinnacle.MessageEventRcsMediaContent
|
|
21
|
+
/**
|
|
22
|
+
* RCS message containing cards with titles, subtitles, and buttons. Has type `RCS_CARDS`. */
|
|
23
|
+
| Pinnacle.MessageEventRcsCardsContent
|
|
24
|
+
/**
|
|
25
|
+
* RCS button click data. Sent when user clicks any button. Has type `RCS_BUTTON_DATA`. */
|
|
26
|
+
| Pinnacle.MessageEventRcsButtonData
|
|
27
|
+
/**
|
|
28
|
+
* RCS location sharing data. Sent when user shares their location via a `requestUserLocation` button. Has type `RCS_LOCATION_DATA`. */
|
|
29
|
+
| Pinnacle.MessageEventRcsLocationData;
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* MMS message with text and/or media files from a phone number.
|
|
6
|
+
*/
|
|
7
|
+
export interface MessageEventMmsContent {
|
|
8
|
+
/** Message type identifier. */
|
|
9
|
+
type: "MMS";
|
|
10
|
+
/**
|
|
11
|
+
* Unique identifier of the message. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`. <br><br>
|
|
12
|
+
* To get the message details, use the [GET /messages/{id}](/api-reference/messages/get) endpoint.
|
|
13
|
+
*/
|
|
14
|
+
id: string;
|
|
15
|
+
/**
|
|
16
|
+
* URLs of media files in this message. <br>
|
|
17
|
+
*
|
|
18
|
+
* See [supported media types](https://app.pinnacle.sh/supported-file-types?type=MMS).
|
|
19
|
+
*/
|
|
20
|
+
mediaUrls: string[];
|
|
21
|
+
/** Text content that may accompany the media files. */
|
|
22
|
+
text?: string;
|
|
23
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as Pinnacle from "../index.js";
|
|
5
|
+
/**
|
|
6
|
+
* Button click event data received when a user clicks on an RCS button or quick reply (excluding `requestUserLocation` buttons).
|
|
7
|
+
*
|
|
8
|
+
* This event contains information about which button was clicked, how many times it's been clicked, and any payload or metadata attached to the button. Use this data to handle user interactions with your RCS messages.
|
|
9
|
+
*/
|
|
10
|
+
export interface MessageEventRcsButtonData extends Pinnacle.ButtonClickedData {
|
|
11
|
+
/** Message type identifier. */
|
|
12
|
+
type: "RCS_BUTTON_DATA";
|
|
13
|
+
/**
|
|
14
|
+
* Unique identifier of the message. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`. <br><br>
|
|
15
|
+
* To get the message details, use the [GET /messages/{id}](/api-reference/messages/get) endpoint.
|
|
16
|
+
*/
|
|
17
|
+
id: string;
|
|
18
|
+
}
|