rcs-js 2.0.0-rc.9 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/Client.d.ts +5 -2
- package/dist/cjs/Client.js +16 -11
- package/dist/cjs/api/resources/brands/client/Client.d.ts +6 -4
- package/dist/cjs/api/resources/brands/client/Client.js +15 -9
- package/dist/cjs/api/resources/brands/client/requests/BrandsGetRequest.d.ts +1 -1
- package/dist/cjs/api/resources/brands/client/requests/UpsertBrandParams.d.ts +3 -3
- package/dist/cjs/api/resources/campaigns/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/campaigns/client/Client.js +1 -1
- package/dist/cjs/api/resources/campaigns/resources/dlc/client/Client.d.ts +9 -9
- package/dist/cjs/api/resources/campaigns/resources/dlc/client/Client.js +7 -7
- package/dist/cjs/api/resources/campaigns/resources/rcs/client/Client.d.ts +5 -3
- package/dist/cjs/api/resources/campaigns/resources/rcs/client/Client.js +5 -1
- package/dist/cjs/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.ts +5 -4
- package/dist/cjs/api/resources/campaigns/resources/tollFree/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/campaigns/resources/tollFree/client/Client.js +1 -1
- package/dist/cjs/api/resources/contacts/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/contacts/client/Client.js +7 -7
- package/dist/cjs/api/resources/contacts/client/requests/ContactsGetRequest.d.ts +2 -2
- package/dist/cjs/api/resources/conversations/client/Client.d.ts +4 -4
- package/dist/cjs/api/resources/conversations/client/Client.js +2 -5
- package/dist/cjs/api/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/index.js +3 -1
- package/dist/cjs/api/resources/messages/client/Client.d.ts +6 -3
- package/dist/cjs/api/resources/messages/client/Client.js +10 -1
- package/dist/cjs/api/resources/messages/client/requests/ReactMessageParams.d.ts +1 -1
- package/dist/cjs/api/resources/messages/resources/mms/client/Client.d.ts +4 -3
- package/dist/cjs/api/resources/messages/resources/mms/client/Client.js +4 -1
- package/dist/cjs/api/resources/messages/resources/rcs/client/Client.d.ts +6 -5
- package/dist/cjs/api/resources/messages/resources/rcs/client/Client.js +5 -2
- package/dist/cjs/api/resources/messages/resources/sms/client/Client.d.ts +4 -3
- package/dist/cjs/api/resources/messages/resources/sms/client/Client.js +4 -1
- package/dist/cjs/api/resources/phoneNumbers/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/phoneNumbers/client/Client.js +1 -1
- package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/Client.d.ts +6 -4
- package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/Client.js +8 -2
- package/dist/cjs/api/resources/phoneNumbers/resources/webhook/client/Client.d.ts +7 -5
- package/dist/cjs/api/resources/phoneNumbers/resources/webhook/client/Client.js +7 -3
- package/dist/cjs/api/resources/rcs/client/Client.d.ts +121 -0
- package/dist/cjs/api/resources/rcs/client/Client.js +320 -0
- package/dist/cjs/api/resources/rcs/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/rcs/client/index.js +17 -0
- package/dist/cjs/api/resources/rcs/client/requests/RcsCapabilitiesQuery.d.ts +13 -0
- package/dist/cjs/api/resources/rcs/client/requests/RcsLinkRequest.d.ts +22 -0
- package/dist/cjs/api/resources/rcs/client/requests/RcsWhitelistRequest.d.ts +16 -0
- package/dist/cjs/api/resources/rcs/client/requests/index.d.ts +3 -0
- package/dist/cjs/api/resources/rcs/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/rcs/index.d.ts +1 -0
- package/dist/cjs/api/resources/rcs/index.js +17 -0
- package/dist/cjs/api/resources/status/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/status/client/Client.js +1 -1
- package/dist/cjs/api/resources/status/resources/get/client/Client.d.ts +5 -5
- package/dist/cjs/api/resources/status/resources/get/client/Client.js +3 -3
- package/dist/cjs/api/resources/tools/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/tools/client/Client.js +1 -1
- package/dist/cjs/api/resources/tools/resources/contactCard/client/Client.d.ts +5 -5
- package/dist/cjs/api/resources/tools/resources/contactCard/client/Client.js +3 -3
- package/dist/cjs/api/resources/tools/resources/file/client/Client.d.ts +24 -3
- package/dist/cjs/api/resources/tools/resources/file/client/Client.js +75 -1
- package/dist/cjs/api/resources/tools/resources/file/client/requests/RefreshFileParams.d.ts +21 -0
- package/dist/cjs/api/resources/tools/resources/file/client/requests/RefreshFileParams.js +5 -0
- package/dist/cjs/api/resources/tools/resources/file/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/tools/resources/url/client/Client.d.ts +4 -4
- package/dist/cjs/api/resources/tools/resources/url/client/Client.js +2 -2
- package/dist/cjs/api/resources/webhooks/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/webhooks/client/Client.js +1 -1
- package/dist/cjs/api/types/AdvancedPhoneInformation.d.ts +9 -9
- package/dist/cjs/api/types/AttachWebhookParams.d.ts +2 -2
- package/dist/cjs/api/types/AutofillDlcCampaignResponse.d.ts +11 -11
- package/dist/cjs/api/types/ButtonClicked.d.ts +11 -0
- package/dist/cjs/api/types/ButtonClicked.js +5 -0
- package/dist/cjs/api/types/ButtonClickedData.d.ts +58 -0
- package/dist/cjs/api/types/ButtonClickedData.js +16 -0
- package/dist/cjs/api/types/Conversation.d.ts +3 -3
- package/dist/cjs/api/types/ConversationList.d.ts +4 -4
- package/dist/cjs/api/types/CreateUrlOptions.d.ts +1 -1
- package/dist/cjs/api/types/DlcCampaignStatus.d.ts +2 -2
- package/dist/cjs/api/types/DlcCampaignWithExtendedBrandAndStatus.d.ts +13 -10
- package/dist/cjs/api/types/EnhancedContactItem.d.ts +1 -1
- package/dist/cjs/api/types/ExtendedBrand.d.ts +12 -5
- package/dist/cjs/api/types/ExtendedBrandWithVetting.d.ts +2 -2
- package/dist/cjs/api/types/ExtendedRcsCampaign.d.ts +13 -12
- package/dist/cjs/api/types/Message.d.ts +4 -4
- package/dist/cjs/api/types/MessageContent.d.ts +2 -2
- package/dist/cjs/api/types/MessageEvent.d.ts +56 -0
- package/dist/cjs/api/types/MessageEvent.js +13 -0
- package/dist/cjs/api/types/ProfileStatusEnum.d.ts +7 -4
- package/dist/cjs/api/types/RcsBase.d.ts +2 -0
- package/dist/cjs/api/types/RcsButtonCall.d.ts +2 -0
- package/dist/cjs/api/types/RcsButtonOpenUrl.d.ts +2 -0
- package/dist/cjs/api/types/RcsButtonRequestUserLocation.d.ts +2 -0
- package/dist/cjs/api/types/RcsButtonScheduleEvent.d.ts +2 -0
- package/dist/cjs/api/types/RcsButtonSendLocation.d.ts +2 -0
- package/dist/cjs/api/types/RcsButtonTrigger.d.ts +2 -2
- package/dist/cjs/api/types/RcsCampaign.d.ts +4 -4
- package/dist/cjs/api/types/RcsCapabilitiesResult.d.ts +8 -0
- package/dist/cjs/api/types/RcsCapabilitiesResult.js +5 -0
- package/dist/cjs/api/types/RcsCapability.d.ts +36 -0
- package/dist/cjs/api/types/RcsCapability.js +5 -0
- package/dist/cjs/api/types/RcsLinkResult.d.ts +13 -0
- package/dist/cjs/api/types/RcsLinkResult.js +5 -0
- package/dist/cjs/api/types/RcsValidateContent.d.ts +1 -0
- package/dist/cjs/api/types/RcsWhitelistResponse.d.ts +10 -0
- package/dist/cjs/api/types/RcsWhitelistResponse.js +5 -0
- package/dist/cjs/api/types/RefreshedFile.d.ts +9 -0
- package/dist/cjs/api/types/RefreshedFile.js +5 -0
- package/dist/cjs/api/types/{Rcs.d.ts → RichMessage.d.ts} +1 -1
- package/dist/cjs/api/types/RichMessage.js +5 -0
- package/dist/cjs/api/types/ShortenedUrl.d.ts +1 -1
- package/dist/cjs/api/types/TollFreeCampaignWithExtendedBrandAndStatus.d.ts +0 -1
- package/dist/cjs/api/types/UploadResults.d.ts +1 -1
- package/dist/cjs/api/types/VCardData.d.ts +1 -1
- package/dist/cjs/api/types/WebhookEventEnum.d.ts +1 -0
- package/dist/cjs/api/types/index.d.ts +9 -3
- package/dist/cjs/api/types/index.js +9 -3
- package/dist/cjs/index.d.ts +1 -1
- package/dist/cjs/index.js +2 -2
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/cjs/wrapper/PinnacleClient.d.ts +9 -0
- package/dist/cjs/wrapper/PinnacleClient.js +17 -0
- package/dist/cjs/wrapper/messages/Client.d.ts +13 -0
- package/dist/cjs/wrapper/messages/Client.js +49 -0
- package/dist/cjs/wrapper/tools/Client.d.ts +6 -0
- package/dist/cjs/wrapper/tools/Client.js +12 -0
- package/dist/cjs/wrapper/tools/FileUploader.d.ts +15 -0
- package/dist/cjs/wrapper/tools/FileUploader.js +162 -0
- package/dist/esm/Client.d.mts +5 -2
- package/dist/esm/Client.mjs +8 -3
- package/dist/esm/api/resources/brands/client/Client.d.mts +6 -4
- package/dist/esm/api/resources/brands/client/Client.mjs +15 -9
- package/dist/esm/api/resources/brands/client/requests/BrandsGetRequest.d.mts +1 -1
- package/dist/esm/api/resources/brands/client/requests/UpsertBrandParams.d.mts +3 -3
- package/dist/esm/api/resources/campaigns/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/campaigns/client/Client.mjs +1 -1
- package/dist/esm/api/resources/campaigns/resources/dlc/client/Client.d.mts +9 -9
- package/dist/esm/api/resources/campaigns/resources/dlc/client/Client.mjs +7 -7
- package/dist/esm/api/resources/campaigns/resources/rcs/client/Client.d.mts +5 -3
- package/dist/esm/api/resources/campaigns/resources/rcs/client/Client.mjs +5 -1
- package/dist/esm/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.mts +5 -4
- package/dist/esm/api/resources/campaigns/resources/tollFree/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/campaigns/resources/tollFree/client/Client.mjs +1 -1
- package/dist/esm/api/resources/contacts/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/contacts/client/Client.mjs +7 -7
- package/dist/esm/api/resources/contacts/client/requests/ContactsGetRequest.d.mts +2 -2
- package/dist/esm/api/resources/conversations/client/Client.d.mts +4 -4
- package/dist/esm/api/resources/conversations/client/Client.mjs +2 -5
- package/dist/esm/api/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/index.mjs +2 -0
- package/dist/esm/api/resources/messages/client/Client.d.mts +6 -3
- package/dist/esm/api/resources/messages/client/Client.mjs +10 -1
- package/dist/esm/api/resources/messages/client/requests/ReactMessageParams.d.mts +1 -1
- package/dist/esm/api/resources/messages/resources/mms/client/Client.d.mts +4 -3
- package/dist/esm/api/resources/messages/resources/mms/client/Client.mjs +4 -1
- package/dist/esm/api/resources/messages/resources/rcs/client/Client.d.mts +6 -5
- package/dist/esm/api/resources/messages/resources/rcs/client/Client.mjs +5 -2
- package/dist/esm/api/resources/messages/resources/sms/client/Client.d.mts +4 -3
- package/dist/esm/api/resources/messages/resources/sms/client/Client.mjs +4 -1
- package/dist/esm/api/resources/phoneNumbers/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/phoneNumbers/client/Client.mjs +1 -1
- package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/Client.d.mts +6 -4
- package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/Client.mjs +8 -2
- package/dist/esm/api/resources/phoneNumbers/resources/webhook/client/Client.d.mts +7 -5
- package/dist/esm/api/resources/phoneNumbers/resources/webhook/client/Client.mjs +7 -3
- package/dist/esm/api/resources/rcs/client/Client.d.mts +121 -0
- package/dist/esm/api/resources/rcs/client/Client.mjs +283 -0
- package/dist/esm/api/resources/rcs/client/index.d.mts +2 -0
- package/dist/esm/api/resources/rcs/client/index.mjs +1 -0
- package/dist/esm/api/resources/rcs/client/requests/RcsCapabilitiesQuery.d.mts +13 -0
- package/dist/esm/api/resources/rcs/client/requests/RcsLinkRequest.d.mts +22 -0
- package/dist/esm/api/resources/rcs/client/requests/RcsWhitelistRequest.d.mts +16 -0
- package/dist/esm/api/resources/rcs/client/requests/index.d.mts +3 -0
- package/dist/esm/api/resources/rcs/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/rcs/index.d.mts +1 -0
- package/dist/esm/api/resources/rcs/index.mjs +1 -0
- package/dist/esm/api/resources/status/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/status/client/Client.mjs +1 -1
- package/dist/esm/api/resources/status/resources/get/client/Client.d.mts +5 -5
- package/dist/esm/api/resources/status/resources/get/client/Client.mjs +3 -3
- package/dist/esm/api/resources/tools/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/tools/client/Client.mjs +1 -1
- package/dist/esm/api/resources/tools/resources/contactCard/client/Client.d.mts +5 -5
- package/dist/esm/api/resources/tools/resources/contactCard/client/Client.mjs +3 -3
- package/dist/esm/api/resources/tools/resources/file/client/Client.d.mts +24 -3
- package/dist/esm/api/resources/tools/resources/file/client/Client.mjs +75 -1
- package/dist/esm/api/resources/tools/resources/file/client/requests/RefreshFileParams.d.mts +21 -0
- package/dist/esm/api/resources/tools/resources/file/client/requests/RefreshFileParams.mjs +4 -0
- package/dist/esm/api/resources/tools/resources/file/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/tools/resources/url/client/Client.d.mts +4 -4
- package/dist/esm/api/resources/tools/resources/url/client/Client.mjs +2 -2
- package/dist/esm/api/resources/webhooks/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/webhooks/client/Client.mjs +1 -1
- package/dist/esm/api/types/AdvancedPhoneInformation.d.mts +9 -9
- package/dist/esm/api/types/AttachWebhookParams.d.mts +2 -2
- package/dist/esm/api/types/AutofillDlcCampaignResponse.d.mts +11 -11
- package/dist/esm/api/types/ButtonClicked.d.mts +11 -0
- package/dist/esm/api/types/ButtonClicked.mjs +4 -0
- package/dist/esm/api/types/ButtonClickedData.d.mts +58 -0
- package/dist/esm/api/types/ButtonClickedData.mjs +13 -0
- package/dist/esm/api/types/Conversation.d.mts +3 -3
- package/dist/esm/api/types/ConversationList.d.mts +4 -4
- package/dist/esm/api/types/CreateUrlOptions.d.mts +1 -1
- package/dist/esm/api/types/DlcCampaignStatus.d.mts +2 -2
- package/dist/esm/api/types/DlcCampaignWithExtendedBrandAndStatus.d.mts +13 -10
- package/dist/esm/api/types/EnhancedContactItem.d.mts +1 -1
- package/dist/esm/api/types/ExtendedBrand.d.mts +12 -5
- package/dist/esm/api/types/ExtendedBrandWithVetting.d.mts +2 -2
- package/dist/esm/api/types/ExtendedRcsCampaign.d.mts +13 -12
- package/dist/esm/api/types/Message.d.mts +4 -4
- package/dist/esm/api/types/MessageContent.d.mts +2 -2
- package/dist/esm/api/types/MessageEvent.d.mts +56 -0
- package/dist/esm/api/types/MessageEvent.mjs +10 -0
- package/dist/esm/api/types/ProfileStatusEnum.d.mts +7 -4
- package/dist/esm/api/types/RcsBase.d.mts +2 -0
- package/dist/esm/api/types/RcsButtonCall.d.mts +2 -0
- package/dist/esm/api/types/RcsButtonOpenUrl.d.mts +2 -0
- package/dist/esm/api/types/RcsButtonRequestUserLocation.d.mts +2 -0
- package/dist/esm/api/types/RcsButtonScheduleEvent.d.mts +2 -0
- package/dist/esm/api/types/RcsButtonSendLocation.d.mts +2 -0
- package/dist/esm/api/types/RcsButtonTrigger.d.mts +2 -2
- package/dist/esm/api/types/RcsCampaign.d.mts +4 -4
- package/dist/esm/api/types/RcsCapabilitiesResult.d.mts +8 -0
- package/dist/esm/api/types/RcsCapabilitiesResult.mjs +4 -0
- package/dist/esm/api/types/RcsCapability.d.mts +36 -0
- package/dist/esm/api/types/RcsCapability.mjs +4 -0
- package/dist/esm/api/types/RcsLinkResult.d.mts +13 -0
- package/dist/esm/api/types/RcsLinkResult.mjs +4 -0
- package/dist/esm/api/types/RcsValidateContent.d.mts +1 -0
- package/dist/esm/api/types/RcsWhitelistResponse.d.mts +10 -0
- package/dist/esm/api/types/RcsWhitelistResponse.mjs +4 -0
- package/dist/esm/api/types/RefreshedFile.d.mts +9 -0
- package/dist/esm/api/types/RefreshedFile.mjs +4 -0
- package/dist/esm/api/types/{Rcs.d.mts → RichMessage.d.mts} +1 -1
- package/dist/esm/api/types/RichMessage.mjs +4 -0
- package/dist/esm/api/types/ShortenedUrl.d.mts +1 -1
- package/dist/esm/api/types/TollFreeCampaignWithExtendedBrandAndStatus.d.mts +0 -1
- package/dist/esm/api/types/UploadResults.d.mts +1 -1
- package/dist/esm/api/types/VCardData.d.mts +1 -1
- package/dist/esm/api/types/WebhookEventEnum.d.mts +1 -0
- package/dist/esm/api/types/index.d.mts +9 -3
- package/dist/esm/api/types/index.mjs +9 -3
- package/dist/esm/index.d.mts +1 -1
- package/dist/esm/index.mjs +1 -1
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/dist/esm/wrapper/PinnacleClient.d.mts +9 -0
- package/dist/esm/wrapper/PinnacleClient.mjs +13 -0
- package/dist/esm/wrapper/messages/Client.d.mts +13 -0
- package/dist/esm/wrapper/messages/Client.mjs +45 -0
- package/dist/esm/wrapper/tools/Client.d.mts +6 -0
- package/dist/esm/wrapper/tools/Client.mjs +8 -0
- package/dist/esm/wrapper/tools/FileUploader.d.mts +15 -0
- package/dist/esm/wrapper/tools/FileUploader.mjs +125 -0
- package/package.json +6 -2
- package/reference.md +321 -16
- package/dist/cjs/api/types/ClickAction.d.ts +0 -28
- package/dist/cjs/api/types/InboundButton.d.ts +0 -11
- package/dist/esm/api/types/ClickAction.d.mts +0 -28
- package/dist/esm/api/types/InboundButton.d.mts +0 -11
- /package/dist/cjs/api/{types/ClickAction.js → resources/rcs/client/requests/RcsCapabilitiesQuery.js} +0 -0
- /package/dist/cjs/api/{types/InboundButton.js → resources/rcs/client/requests/RcsLinkRequest.js} +0 -0
- /package/dist/cjs/api/{types/Rcs.js → resources/rcs/client/requests/RcsWhitelistRequest.js} +0 -0
- /package/dist/esm/api/{types/ClickAction.mjs → resources/rcs/client/requests/RcsCapabilitiesQuery.mjs} +0 -0
- /package/dist/esm/api/{types/InboundButton.mjs → resources/rcs/client/requests/RcsLinkRequest.mjs} +0 -0
- /package/dist/esm/api/{types/Rcs.mjs → resources/rcs/client/requests/RcsWhitelistRequest.mjs} +0 -0
|
@@ -15,7 +15,7 @@ export interface DlcCampaignWithExtendedBrandAndStatus {
|
|
|
15
15
|
/** Description of the campaign. */
|
|
16
16
|
description?: string;
|
|
17
17
|
/** Keyword response configuration. */
|
|
18
|
-
keywords
|
|
18
|
+
keywords: DlcCampaignWithExtendedBrandAndStatus.Keywords;
|
|
19
19
|
/** Legal documentation links. */
|
|
20
20
|
links?: DlcCampaignWithExtendedBrandAndStatus.Links;
|
|
21
21
|
/** Describe the flow of how users will opt in to this campaign. */
|
|
@@ -23,16 +23,19 @@ export interface DlcCampaignWithExtendedBrandAndStatus {
|
|
|
23
23
|
/** Display name of the campaign. */
|
|
24
24
|
name?: string;
|
|
25
25
|
/** Campaign configuration options. */
|
|
26
|
-
options
|
|
26
|
+
options: DlcCampaignWithExtendedBrandAndStatus.Options;
|
|
27
27
|
/** Example messages for the campaign. */
|
|
28
28
|
sampleMessages?: string[];
|
|
29
29
|
/**
|
|
30
|
-
* Current review status of the campaign
|
|
30
|
+
* Current review status of the campaign. <br>
|
|
31
31
|
*
|
|
32
|
-
* `INCOMPLETE`: Not submitted
|
|
33
|
-
*
|
|
34
|
-
* `
|
|
35
|
-
*
|
|
32
|
+
* `INCOMPLETE`: Not submitted. <br>
|
|
33
|
+
*
|
|
34
|
+
* `IN REVIEW`: Being reviewed by carriers. <br>
|
|
35
|
+
*
|
|
36
|
+
* `VERIFIED`: Approved and ready to send messages. <br>
|
|
37
|
+
*
|
|
38
|
+
* `FAILED`: Issues and errors related to the campaign's details.
|
|
36
39
|
*/
|
|
37
40
|
status: Pinnacle.ProfileStatusEnum;
|
|
38
41
|
/** Use case for the campaign. */
|
|
@@ -58,14 +61,14 @@ export declare namespace DlcCampaignWithExtendedBrandAndStatus {
|
|
|
58
61
|
/** Response message for help keywords. */
|
|
59
62
|
message?: string;
|
|
60
63
|
/** Keywords that trigger help response. */
|
|
61
|
-
values
|
|
64
|
+
values: string[];
|
|
62
65
|
}
|
|
63
66
|
/**
|
|
64
67
|
* Opt-in keyword settings.
|
|
65
68
|
*/
|
|
66
69
|
interface OptIn {
|
|
67
70
|
/** Response message for opt-in keywords. */
|
|
68
|
-
message
|
|
71
|
+
message?: string;
|
|
69
72
|
/** Keywords that trigger opt-in. */
|
|
70
73
|
values: string[];
|
|
71
74
|
}
|
|
@@ -74,7 +77,7 @@ export declare namespace DlcCampaignWithExtendedBrandAndStatus {
|
|
|
74
77
|
*/
|
|
75
78
|
interface OptOut {
|
|
76
79
|
/** Response message for opt-out keywords. */
|
|
77
|
-
message
|
|
80
|
+
message?: string;
|
|
78
81
|
/** Keywords that trigger opt-out. */
|
|
79
82
|
values: string[];
|
|
80
83
|
}
|
|
@@ -18,7 +18,7 @@ export interface EnhancedContactItem {
|
|
|
18
18
|
* LinkedIn profile URL if available and publicly accessible.
|
|
19
19
|
* Null if no LinkedIn profile is found or accessible.
|
|
20
20
|
*/
|
|
21
|
-
linkedin
|
|
21
|
+
linkedin: string | null;
|
|
22
22
|
/** Full name of the contact person associated with this profile. */
|
|
23
23
|
name: string;
|
|
24
24
|
}
|
|
@@ -10,12 +10,19 @@ export interface ExtendedBrand extends Pinnacle.OptionalBrandInfo {
|
|
|
10
10
|
/** Indicates if this brand is archived. */
|
|
11
11
|
isArchived: boolean;
|
|
12
12
|
/**
|
|
13
|
-
* Current review status of the
|
|
13
|
+
* Current review status of the brand. <br>
|
|
14
14
|
*
|
|
15
|
-
* `INCOMPLETE`: Not submitted
|
|
16
|
-
*
|
|
17
|
-
* `
|
|
18
|
-
*
|
|
15
|
+
* `INCOMPLETE`: Not submitted. <br>
|
|
16
|
+
*
|
|
17
|
+
* `IN REVIEW`: Being reviewed by carriers. <br>
|
|
18
|
+
*
|
|
19
|
+
* `VERIFIED`: Approved and ready to send messages. <br>
|
|
20
|
+
*
|
|
21
|
+
* `FAILED`: Issues and errors related to the campaign's details. <br>
|
|
22
|
+
*
|
|
23
|
+
* `VETTED`: Has undergone additional vetting by a third party service post the brand being verified. Your brand will be assigned a trust score, with higher trust scores having higher message volumes. <br>
|
|
24
|
+
*
|
|
25
|
+
* `UNVERIFIED`: Brand details have been updated, and the brand will need to undergo re-verification.
|
|
19
26
|
*/
|
|
20
27
|
status: Pinnacle.BrandStatusEnum;
|
|
21
28
|
/** ISO 8601 formatted timestamp of when this brand was last updated. */
|
|
@@ -4,9 +4,9 @@
|
|
|
4
4
|
import * as Pinnacle from "../index.js";
|
|
5
5
|
export interface ExtendedBrandWithVetting extends Pinnacle.ExtendedBrand {
|
|
6
6
|
/** ISO 8601 formatted timestamp of the last TCR vetting. */
|
|
7
|
-
lastTcrVettingDate
|
|
7
|
+
lastTcrVettingDate: string | null;
|
|
8
8
|
/** Feedback from The Campaign Registry if TCR vetting was performed. */
|
|
9
|
-
tcrFeedback
|
|
9
|
+
tcrFeedback: Pinnacle.VettingFeedback[] | null;
|
|
10
10
|
/** History of all external vetting attempts for this brand. */
|
|
11
11
|
vettingHistory: Pinnacle.VettingHistory[];
|
|
12
12
|
}
|
|
@@ -9,20 +9,23 @@ export interface ExtendedRcsCampaign {
|
|
|
9
9
|
agentId: string;
|
|
10
10
|
/** Brand associated with this campaign. */
|
|
11
11
|
brand: Pinnacle.ExtendedBrand;
|
|
12
|
+
/** Link to document verifying the brand's name. This may be the certificate of incorporation, business license, or other relevant document. You can typically find this on the Secretary of State website. */
|
|
13
|
+
brandVerificationUrl?: string;
|
|
12
14
|
/** Indicates whether the brand has provided an attestation. */
|
|
13
15
|
brandAttestation: boolean;
|
|
14
16
|
/** Unique identifier for the campaign. */
|
|
15
|
-
campaignId
|
|
17
|
+
campaignId?: number;
|
|
16
18
|
/** List of what the agent might say to users. */
|
|
17
19
|
expectedAgentResponses?: string[];
|
|
18
20
|
/** Legal documentation links. */
|
|
19
|
-
links
|
|
21
|
+
links?: ExtendedRcsCampaign.Links;
|
|
22
|
+
status: Pinnacle.ProfileStatusEnum;
|
|
20
23
|
/** Opt-in configuration. */
|
|
21
|
-
optIn
|
|
24
|
+
optIn?: ExtendedRcsCampaign.OptIn;
|
|
22
25
|
/** Opt-out configuration. */
|
|
23
|
-
optOut
|
|
26
|
+
optOut?: ExtendedRcsCampaign.OptOut;
|
|
24
27
|
/** Use case classification for the campaign. */
|
|
25
|
-
useCase
|
|
28
|
+
useCase?: ExtendedRcsCampaign.UseCase;
|
|
26
29
|
}
|
|
27
30
|
export declare namespace ExtendedRcsCampaign {
|
|
28
31
|
/**
|
|
@@ -34,19 +37,17 @@ export declare namespace ExtendedRcsCampaign {
|
|
|
34
37
|
/** Description of the agent. */
|
|
35
38
|
description?: string;
|
|
36
39
|
/** List of emails. */
|
|
37
|
-
emails
|
|
38
|
-
/** Link to
|
|
39
|
-
brandVerificationUrl?: string;
|
|
40
|
-
/** Link to the agent's hero. */
|
|
40
|
+
emails: Agent.Emails.Item[];
|
|
41
|
+
/** Link to the agent's hero. Hero must be an image file with dimensions 1440x448px. */
|
|
41
42
|
heroUrl?: string;
|
|
42
|
-
/** Link to the agent's icon. */
|
|
43
|
+
/** Link to the agent's icon. Icon must be an image file with dimensions 224x224px. */
|
|
43
44
|
iconUrl?: string;
|
|
44
45
|
/** Name of the agent. */
|
|
45
46
|
name?: string;
|
|
46
47
|
/** List of phone numbers. */
|
|
47
|
-
phones
|
|
48
|
+
phones: Agent.Phones.Item[];
|
|
48
49
|
/** List of urls. */
|
|
49
|
-
websites
|
|
50
|
+
websites: Agent.Websites.Item[];
|
|
50
51
|
}
|
|
51
52
|
namespace Agent {
|
|
52
53
|
type Emails = Emails.Item[];
|
|
@@ -9,19 +9,19 @@ export interface Message {
|
|
|
9
9
|
*
|
|
10
10
|
* Null means the message incurred no cost or has not been charged yet.
|
|
11
11
|
*/
|
|
12
|
-
cost
|
|
12
|
+
cost: number | null;
|
|
13
13
|
/**
|
|
14
14
|
* Timestamp indicating when the message was successfully delivered to the recipient. <br>
|
|
15
15
|
*
|
|
16
16
|
* Null indicates the message has not yet been delivered.
|
|
17
17
|
*/
|
|
18
|
-
deliveredAt
|
|
18
|
+
deliveredAt: string | null;
|
|
19
19
|
/**
|
|
20
20
|
* Detailed explanation of any errors that occurred while delivering the message. <br>
|
|
21
21
|
*
|
|
22
22
|
* Null indicates no errors.
|
|
23
23
|
*/
|
|
24
|
-
error
|
|
24
|
+
error: string | null;
|
|
25
25
|
/** Unique identifier of the message. */
|
|
26
26
|
id: number;
|
|
27
27
|
method: Pinnacle.MessageMethodEnum;
|
|
@@ -36,7 +36,7 @@ export interface Message {
|
|
|
36
36
|
*
|
|
37
37
|
* Null indicates the message is still in the queue.
|
|
38
38
|
*/
|
|
39
|
-
sentAt
|
|
39
|
+
sentAt: string | null;
|
|
40
40
|
status: Pinnacle.MessageStatusEnum;
|
|
41
41
|
type: Pinnacle.MessageProtocolEnum;
|
|
42
42
|
}
|
|
@@ -18,5 +18,5 @@ Pinnacle.SmsContent
|
|
|
18
18
|
* Message that contains richer content (longer text, higher quality media, cards, buttons, and quick replies) from an RCS agent. */
|
|
19
19
|
| Pinnacle.RcsContent
|
|
20
20
|
/**
|
|
21
|
-
* Message that represents when a user clicks on a RCS button or quick reply
|
|
22
|
-
| Pinnacle.
|
|
21
|
+
* Message that represents when a user clicks on a RCS button or quick reply. */
|
|
22
|
+
| Pinnacle.ButtonClicked;
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as Pinnacle from "../index.js";
|
|
5
|
+
/**
|
|
6
|
+
* Represents an incoming message or message status update received via webhook.
|
|
7
|
+
*/
|
|
8
|
+
export interface MessageEvent {
|
|
9
|
+
/** Type of webhook event. MESSAGE.STATUS for message status updates or MESSAGE.RECEIVED for inbound messages. */
|
|
10
|
+
type: Pinnacle.WebhookEventEnum;
|
|
11
|
+
/** Conversation metadata containing the conversation ID, sender, and recipient information. */
|
|
12
|
+
conversation: MessageEvent.Conversation;
|
|
13
|
+
status: Pinnacle.MessageStatusEnum;
|
|
14
|
+
/** Direction of the message flow. */
|
|
15
|
+
direction: MessageEvent.Direction;
|
|
16
|
+
/** Number of segments for this message. */
|
|
17
|
+
segments: number;
|
|
18
|
+
/** Timestamp when the message was sent in ISO 8601 format. */
|
|
19
|
+
sentAt: string;
|
|
20
|
+
/**
|
|
21
|
+
* Timestamp when the message was delivered in ISO 8601 format.
|
|
22
|
+
* Null if not yet delivered or for inbound messages.
|
|
23
|
+
*/
|
|
24
|
+
deliveredAt?: string | null;
|
|
25
|
+
/** Message details including ID and content. */
|
|
26
|
+
message: MessageEvent.Message;
|
|
27
|
+
}
|
|
28
|
+
export declare namespace MessageEvent {
|
|
29
|
+
/**
|
|
30
|
+
* Conversation metadata containing the conversation ID, sender, and recipient information.
|
|
31
|
+
*/
|
|
32
|
+
interface Conversation {
|
|
33
|
+
/** Unique identifier for the conversation. To get more conversation details, use the [POST /conversations/get](/api-reference/conversations/get) endpoint. */
|
|
34
|
+
id: number;
|
|
35
|
+
/** Sender's phone number or agent ID. */
|
|
36
|
+
from: string;
|
|
37
|
+
/** Recipient's phone number. */
|
|
38
|
+
to: string;
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* Direction of the message flow.
|
|
42
|
+
*/
|
|
43
|
+
type Direction = "INBOUND" | "OUTBOUND";
|
|
44
|
+
const Direction: {
|
|
45
|
+
readonly Inbound: "INBOUND";
|
|
46
|
+
readonly Outbound: "OUTBOUND";
|
|
47
|
+
};
|
|
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
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
4
|
+
*/
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.MessageEvent = void 0;
|
|
7
|
+
var MessageEvent;
|
|
8
|
+
(function (MessageEvent) {
|
|
9
|
+
MessageEvent.Direction = {
|
|
10
|
+
Inbound: "INBOUND",
|
|
11
|
+
Outbound: "OUTBOUND",
|
|
12
|
+
};
|
|
13
|
+
})(MessageEvent || (exports.MessageEvent = MessageEvent = {}));
|
|
@@ -2,11 +2,14 @@
|
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
4
|
/**
|
|
5
|
-
* Current review status of the campaign.
|
|
5
|
+
* Current review status of the campaign. <br>
|
|
6
|
+
*
|
|
7
|
+
* `INCOMPLETE`: Not submitted. <br>
|
|
8
|
+
*
|
|
9
|
+
* `IN REVIEW`: Being reviewed by carriers. <br>
|
|
10
|
+
*
|
|
11
|
+
* `VERIFIED`: Approved and ready to send messages.<br>
|
|
6
12
|
*
|
|
7
|
-
* `INCOMPLETE`: Not submitted.
|
|
8
|
-
* `IN REVIEW`: Being reviewed by carriers.
|
|
9
|
-
* `VERIFIED`: Approved and ready to send messages.
|
|
10
13
|
* `FAILED`: Issues and errors related to the campaign's details.
|
|
11
14
|
*/
|
|
12
15
|
export type ProfileStatusEnum = "INCOMPLETE" | "IN REVIEW" | "VERIFIED" | "FAILED";
|
|
@@ -19,6 +19,8 @@ export declare namespace RcsBase {
|
|
|
19
19
|
/** Send via the test agent to whitelisted test devices. Useful for development and debugging. */
|
|
20
20
|
test_mode?: boolean;
|
|
21
21
|
tracking?: Pinnacle.Tracking;
|
|
22
|
+
/** Media files and card media will be transcoded to a supported RCS format. This adds a small delay to sending the message. Ignored for rich text messages. */
|
|
23
|
+
transcode?: boolean;
|
|
22
24
|
/**
|
|
23
25
|
* Validate your message for any unsupported files. <br>
|
|
24
26
|
*
|
|
@@ -5,6 +5,8 @@
|
|
|
5
5
|
* Button that initiates a phone call when tapped by the recipient.
|
|
6
6
|
*/
|
|
7
7
|
export interface RcsButtonCall {
|
|
8
|
+
/** Optional additional data to attach to this button. */
|
|
9
|
+
metadata?: string;
|
|
8
10
|
/** Phone number to call in E.164 format */
|
|
9
11
|
payload: string;
|
|
10
12
|
/** Display text for the button. */
|
|
@@ -5,6 +5,8 @@
|
|
|
5
5
|
* Button that opens a URL when tapped by the recipient.
|
|
6
6
|
*/
|
|
7
7
|
export interface RcsButtonOpenUrl {
|
|
8
|
+
/** Optional additional data to attach to this button. */
|
|
9
|
+
metadata?: string;
|
|
8
10
|
/** The URL to open when the button is tapped. Must be a valid HTTP or HTTPS URL. */
|
|
9
11
|
payload: string;
|
|
10
12
|
/** Display text for the button. */
|
|
@@ -5,6 +5,8 @@
|
|
|
5
5
|
* Button that prompts the recipient to share their current location.
|
|
6
6
|
*/
|
|
7
7
|
export interface RcsButtonRequestUserLocation {
|
|
8
|
+
/** Optional additional data to attach to this button. */
|
|
9
|
+
metadata?: string;
|
|
8
10
|
/** Display text for the button. */
|
|
9
11
|
title: string;
|
|
10
12
|
}
|
|
@@ -13,6 +13,8 @@ export interface RcsButtonScheduleEvent {
|
|
|
13
13
|
eventStartTime: string;
|
|
14
14
|
/** Title of the event. */
|
|
15
15
|
eventTitle: string;
|
|
16
|
+
/** Optional additional data to attach to this button. */
|
|
17
|
+
metadata?: string;
|
|
16
18
|
/** Display text for the button. */
|
|
17
19
|
title: string;
|
|
18
20
|
}
|
|
@@ -7,6 +7,8 @@
|
|
|
7
7
|
export interface RcsButtonSendLocation {
|
|
8
8
|
/** Geographic coordinates of the location to share. */
|
|
9
9
|
latLong: RcsButtonSendLocation.LatLong;
|
|
10
|
+
/** Optional additional data to attach to this button. */
|
|
11
|
+
metadata?: string;
|
|
10
12
|
/** Display text for the button. */
|
|
11
13
|
title: string;
|
|
12
14
|
}
|
|
@@ -5,8 +5,8 @@
|
|
|
5
5
|
* Button that sends custom data back to your application when tapped by the recipient.
|
|
6
6
|
*/
|
|
7
7
|
export interface RcsButtonTrigger {
|
|
8
|
-
/**
|
|
9
|
-
metadata
|
|
8
|
+
/** Optional additional data to attach to this button. */
|
|
9
|
+
metadata?: string;
|
|
10
10
|
/** Custom data sent to your webhook when the button is tapped. Use this to identify the user's choice. */
|
|
11
11
|
payload: string;
|
|
12
12
|
/** Display text for the button. */
|
|
@@ -7,6 +7,8 @@ export interface RcsCampaign {
|
|
|
7
7
|
agent?: RcsCampaign.Agent;
|
|
8
8
|
/** Unique identifier for the campaign. */
|
|
9
9
|
campaignId?: number;
|
|
10
|
+
/** Link to document verifying the brand's name. This may be the certificate of incorporation, business license, or other relevant document. You can typically find this on the Secretary of State website. */
|
|
11
|
+
brandVerificationUrl?: string;
|
|
10
12
|
/** List of what the agent might say to users. */
|
|
11
13
|
expectedAgentResponses?: string[];
|
|
12
14
|
/** Legal documentation links. */
|
|
@@ -25,8 +27,6 @@ export declare namespace RcsCampaign {
|
|
|
25
27
|
interface Agent {
|
|
26
28
|
/** Name of the agent. */
|
|
27
29
|
name?: string;
|
|
28
|
-
/** Link to document verifying the brand's name. This may be the certificate of incorporation, business license, or other relevant document. You can typically find this on the Secretary of State website. */
|
|
29
|
-
brandVerificationUrl?: string;
|
|
30
30
|
/** Description of the agent. */
|
|
31
31
|
description?: string;
|
|
32
32
|
/** Color of the agent's buttons. */
|
|
@@ -37,9 +37,9 @@ export declare namespace RcsCampaign {
|
|
|
37
37
|
phones?: Agent.Phones.Item[];
|
|
38
38
|
/** List of urls. */
|
|
39
39
|
websites?: Agent.Websites.Item[];
|
|
40
|
-
/** Link to the agent's hero. */
|
|
40
|
+
/** Link to the agent's hero. Hero must be an image file with dimensions 1440x448px. */
|
|
41
41
|
heroUrl?: string;
|
|
42
|
-
/** Link to the agent's icon. */
|
|
42
|
+
/** Link to the agent's icon. Icon must be an image file with dimensions 224x224px. */
|
|
43
43
|
iconUrl?: string;
|
|
44
44
|
}
|
|
45
45
|
namespace Agent {
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as Pinnacle from "../index.js";
|
|
5
|
+
/**
|
|
6
|
+
* Response containing RCS capabilities for requested phone numbers
|
|
7
|
+
*/
|
|
8
|
+
export type RcsCapabilitiesResult = Record<string, Pinnacle.RcsCapability | null>;
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* RCS capabilities for a phone number
|
|
6
|
+
*/
|
|
7
|
+
export interface RcsCapability {
|
|
8
|
+
cards: RcsCapability.Cards;
|
|
9
|
+
/** Supported button action types inside the rich cards or quick replies. Each key is a button action type that defines a specific button type in the Pinnacle API. */
|
|
10
|
+
actions: RcsCapability.Actions;
|
|
11
|
+
}
|
|
12
|
+
export declare namespace RcsCapability {
|
|
13
|
+
interface Cards {
|
|
14
|
+
/** Whether the phone number supports standalone rich cards (`cards.length == 1`) */
|
|
15
|
+
standalone: boolean;
|
|
16
|
+
/** Whether the phone number supports carousel rich cards */
|
|
17
|
+
carousel: boolean;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* Supported button action types inside the rich cards or quick replies. Each key is a button action type that defines a specific button type in the Pinnacle API.
|
|
21
|
+
*/
|
|
22
|
+
interface Actions {
|
|
23
|
+
/** Buttons that open URLs are supported */
|
|
24
|
+
openUrl: boolean;
|
|
25
|
+
/** Buttons that make phone calls are supported */
|
|
26
|
+
call: boolean;
|
|
27
|
+
/** Buttons that trigger actions are supported */
|
|
28
|
+
trigger: boolean;
|
|
29
|
+
/** Buttons that request user location are supported */
|
|
30
|
+
requestUserLocation: boolean;
|
|
31
|
+
/** Buttons are supported */
|
|
32
|
+
scheduleEvent: boolean;
|
|
33
|
+
/** Buttons that send location are supported */
|
|
34
|
+
sendLocation: boolean;
|
|
35
|
+
}
|
|
36
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* Response containing the generated RCS service id and/or url. You can always create a link with the service id that is returned.
|
|
6
|
+
* To create a link follow the format: sms://{PHONE_NUMBER}?service_id={SERVICE_ID}&body={URL_ENCODED_BODY}
|
|
7
|
+
*/
|
|
8
|
+
export interface RcsLinkResult {
|
|
9
|
+
/** The generated RCS link URL. If no phone number is provided, no url will be generated. */
|
|
10
|
+
url?: string;
|
|
11
|
+
/** The service ID used for the link */
|
|
12
|
+
serviceId: string;
|
|
13
|
+
}
|
|
@@ -12,6 +12,7 @@ Pinnacle.RcsTextContent
|
|
|
12
12
|
* See [supported media types](https://app.pinnacle.sh/supported-file-types?type=RCS-MEDIA). */
|
|
13
13
|
| {
|
|
14
14
|
media: string;
|
|
15
|
+
quickReplies: Pinnacle.RichButton[];
|
|
15
16
|
}
|
|
16
17
|
/**
|
|
17
18
|
* Message containing cards, each with its own title, subtitle, and/or buttons. Quick replies can also be added. <br>
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* Response indicating success of whitelisting operation
|
|
6
|
+
*/
|
|
7
|
+
export interface RcsWhitelistResponse {
|
|
8
|
+
/** Whether the whitelisting operation was successful */
|
|
9
|
+
success: boolean;
|
|
10
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
export interface RefreshedFile {
|
|
5
|
+
/** The original file URI that was provided in the request. */
|
|
6
|
+
original: string;
|
|
7
|
+
/** The new refreshed presigned URL that expires in one hour. */
|
|
8
|
+
refreshed: string;
|
|
9
|
+
}
|
|
@@ -11,6 +11,6 @@ export declare namespace ShortenedUrl {
|
|
|
11
11
|
/** Destination URL that your shortened link redirects to. */
|
|
12
12
|
to: string;
|
|
13
13
|
/** Expiration date for your shortened link in ISO 8601 format, or null if it's permanent. */
|
|
14
|
-
expiresAt
|
|
14
|
+
expiresAt: string | null;
|
|
15
15
|
}
|
|
16
16
|
}
|
|
@@ -11,7 +11,6 @@ export interface TollFreeCampaignWithExtendedBrandAndStatus extends Pinnacle.Tol
|
|
|
11
11
|
* `INCOMPLETE`: Has not been submitted.<br>
|
|
12
12
|
* `PENDING`: Currently being reviewed.<br>
|
|
13
13
|
* `VERIFIED`: Verified and good to go.<br>
|
|
14
|
-
* `UNVERIFIED`: No longer verified due to an update in the brand details.<br>
|
|
15
14
|
* `VETTED`: Brand has been vetted by an external provider and has received vetting scores.
|
|
16
15
|
*/
|
|
17
16
|
status: Pinnacle.ProfileStatusEnum;
|
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
/**
|
|
5
5
|
* Types of events that can trigger webhook notifications for phone numbers.
|
|
6
6
|
* Subscribe to specific events to receive real-time updates about your phone number activity.
|
|
7
|
+
* Use `null` to listen to all events.
|
|
7
8
|
*/
|
|
8
9
|
export type WebhookEventEnum = "MESSAGE.STATUS" | "MESSAGE.RECEIVED";
|
|
9
10
|
export declare const WebhookEventEnum: {
|
|
@@ -59,9 +59,9 @@ export * from "./RcsMediaDetailsContent.js";
|
|
|
59
59
|
export * from "./RcsMediaContent.js";
|
|
60
60
|
export * from "./RcsCardsContent.js";
|
|
61
61
|
export * from "./RcsContent.js";
|
|
62
|
-
export * from "./
|
|
62
|
+
export * from "./ButtonClickedData.js";
|
|
63
63
|
export * from "./LocationShareAction.js";
|
|
64
|
-
export * from "./
|
|
64
|
+
export * from "./ButtonClicked.js";
|
|
65
65
|
export * from "./MessageContent.js";
|
|
66
66
|
export * from "./MessageMethodEnum.js";
|
|
67
67
|
export * from "./MessageStatusEnum.js";
|
|
@@ -78,7 +78,7 @@ export * from "./RichTextMessage.js";
|
|
|
78
78
|
export * from "./RichMediaMessage.js";
|
|
79
79
|
export * from "./RcsCards.js";
|
|
80
80
|
export * from "./RichCardsMessage.js";
|
|
81
|
-
export * from "./
|
|
81
|
+
export * from "./RichMessage.js";
|
|
82
82
|
export * from "./SentRcsDetails.js";
|
|
83
83
|
export * from "./SmsValidationResult.js";
|
|
84
84
|
export * from "./MmsValidationResult.js";
|
|
@@ -102,6 +102,10 @@ export * from "./DetachedWebhookInfo.js";
|
|
|
102
102
|
export * from "./MessagingProfileEnum.js";
|
|
103
103
|
export * from "./AttachedPhoneNumberResult.js";
|
|
104
104
|
export * from "./DetachedPhoneNumberResult.js";
|
|
105
|
+
export * from "./RcsCapability.js";
|
|
106
|
+
export * from "./RcsCapabilitiesResult.js";
|
|
107
|
+
export * from "./RcsWhitelistResponse.js";
|
|
108
|
+
export * from "./RcsLinkResult.js";
|
|
105
109
|
export * from "./BrandStatus.js";
|
|
106
110
|
export * from "./TollFreeStatusEnum.js";
|
|
107
111
|
export * from "./TollFreeCampaignStatus.js";
|
|
@@ -115,6 +119,7 @@ export * from "./ShortenedUrl.js";
|
|
|
115
119
|
export * from "./LinkClickEvent.js";
|
|
116
120
|
export * from "./ShortenedUrlWithClickData.js";
|
|
117
121
|
export * from "./UploadResults.js";
|
|
122
|
+
export * from "./RefreshedFile.js";
|
|
118
123
|
export * from "./VcardAddress.js";
|
|
119
124
|
export * from "./VcardPhone.js";
|
|
120
125
|
export * from "./VcardEmail.js";
|
|
@@ -124,3 +129,4 @@ export * from "./VCardData.js";
|
|
|
124
129
|
export * from "./VcardResource.js";
|
|
125
130
|
export * from "./Webhooks.js";
|
|
126
131
|
export * from "./WebhookResult.js";
|
|
132
|
+
export * from "./MessageEvent.js";
|