rcs-js 2.0.13 → 2.0.14
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/resources/audiences/client/Client.d.ts +15 -0
- package/dist/cjs/api/resources/audiences/client/Client.js +70 -0
- package/dist/cjs/api/resources/audiences/client/requests/ListAudiencesParams.d.ts +10 -0
- package/dist/cjs/api/resources/audiences/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/brands/client/Client.d.ts +15 -0
- package/dist/cjs/api/resources/brands/client/Client.js +70 -0
- package/dist/cjs/api/resources/brands/client/requests/ListBrandsParams.d.ts +23 -0
- package/dist/cjs/api/resources/brands/client/requests/ListBrandsParams.js +15 -0
- package/dist/cjs/api/resources/brands/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/campaigns/resources/dlc/client/Client.d.ts +15 -0
- package/dist/cjs/api/resources/campaigns/resources/dlc/client/Client.js +70 -0
- package/dist/cjs/api/resources/campaigns/resources/dlc/client/requests/ListDlcCampaignsParams.d.ts +21 -0
- package/dist/cjs/api/resources/campaigns/resources/dlc/client/requests/ListDlcCampaignsParams.js +13 -0
- package/dist/cjs/api/resources/campaigns/resources/dlc/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/campaigns/resources/rcs/client/Client.d.ts +15 -0
- package/dist/cjs/api/resources/campaigns/resources/rcs/client/Client.js +70 -0
- package/dist/cjs/api/resources/campaigns/resources/rcs/client/requests/ListRcsCampaignsParams.d.ts +21 -0
- package/dist/cjs/api/resources/campaigns/resources/rcs/client/requests/ListRcsCampaignsParams.js +13 -0
- package/dist/cjs/api/resources/campaigns/resources/rcs/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/campaigns/resources/tollFree/client/Client.d.ts +15 -0
- package/dist/cjs/api/resources/campaigns/resources/tollFree/client/Client.js +73 -0
- package/dist/cjs/api/resources/campaigns/resources/tollFree/client/requests/ListTollFreeCampaignsParams.d.ts +21 -0
- package/dist/cjs/api/resources/campaigns/resources/tollFree/client/requests/ListTollFreeCampaignsParams.js +13 -0
- package/dist/cjs/api/resources/campaigns/resources/tollFree/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/contacts/client/Client.d.ts +15 -0
- package/dist/cjs/api/resources/contacts/client/Client.js +70 -0
- package/dist/cjs/api/resources/contacts/client/requests/ListContactsParams.d.ts +16 -0
- package/dist/cjs/api/resources/contacts/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/messages/client/Client.d.ts +21 -0
- package/dist/cjs/api/resources/messages/client/Client.js +88 -8
- package/dist/cjs/api/resources/messages/client/requests/ListMessagesParams.d.ts +55 -0
- package/dist/cjs/api/resources/messages/client/requests/ListMessagesParams.js +33 -0
- package/dist/cjs/api/resources/messages/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/messages/resources/blast/client/requests/BlastRcs.d.ts +0 -2
- package/dist/cjs/api/resources/messages/resources/blasts/client/Client.d.ts +29 -0
- package/dist/cjs/api/resources/messages/resources/blasts/client/Client.js +133 -0
- package/dist/cjs/api/resources/messages/resources/blasts/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/messages/resources/blasts/client/index.js +17 -0
- package/dist/cjs/api/resources/messages/resources/blasts/client/requests/ListBlastsParams.d.ts +17 -0
- package/dist/cjs/api/resources/messages/resources/blasts/client/requests/ListBlastsParams.js +3 -0
- package/dist/cjs/api/resources/messages/resources/blasts/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/messages/resources/blasts/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/messages/resources/blasts/index.d.ts +1 -0
- package/dist/cjs/api/resources/messages/resources/blasts/index.js +17 -0
- package/dist/cjs/api/resources/messages/resources/index.d.ts +4 -0
- package/dist/cjs/api/resources/messages/resources/index.js +5 -1
- package/dist/cjs/api/resources/messages/resources/rcs/client/Client.d.ts +1 -4
- package/dist/cjs/api/resources/messages/resources/rcs/client/Client.js +1 -4
- package/dist/cjs/api/resources/messages/resources/rcs/client/requests/SendTypingIndicatorSchema.d.ts +1 -15
- package/dist/cjs/api/resources/messages/resources/rcs/types/SendRichMessageResponse.d.ts +1 -1
- package/dist/cjs/api/resources/messages/resources/schedules/client/Client.d.ts +29 -0
- package/dist/cjs/api/resources/messages/resources/schedules/client/Client.js +136 -0
- package/dist/cjs/api/resources/messages/resources/schedules/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/messages/resources/schedules/client/index.js +17 -0
- package/dist/cjs/api/resources/messages/resources/schedules/client/requests/ListScheduledMessagesParams.d.ts +27 -0
- package/dist/cjs/api/resources/messages/resources/schedules/client/requests/ListScheduledMessagesParams.js +17 -0
- package/dist/cjs/api/resources/messages/resources/schedules/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/messages/resources/schedules/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/messages/resources/schedules/index.d.ts +1 -0
- package/dist/cjs/api/resources/messages/resources/schedules/index.js +17 -0
- package/dist/cjs/api/resources/phoneNumbers/client/Client.d.ts +15 -0
- package/dist/cjs/api/resources/phoneNumbers/client/Client.js +70 -0
- package/dist/cjs/api/resources/phoneNumbers/client/requests/ListPhoneNumbersParams.d.ts +8 -0
- package/dist/cjs/api/resources/phoneNumbers/client/requests/ListPhoneNumbersParams.js +3 -0
- package/dist/cjs/api/resources/phoneNumbers/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/rcs/client/Client.d.ts +25 -42
- package/dist/cjs/api/resources/rcs/client/Client.js +40 -56
- package/dist/cjs/api/resources/rcs/client/requests/RcsCapabilitiesQuery.d.ts +2 -0
- package/dist/cjs/api/resources/rcs/client/requests/RcsLinkRequest.d.ts +0 -3
- package/dist/cjs/api/resources/rcs/client/requests/index.d.ts +0 -1
- package/dist/cjs/api/resources/rcs/index.d.ts +1 -0
- package/dist/cjs/api/resources/rcs/index.js +1 -0
- package/dist/cjs/api/resources/rcs/resources/agents/client/Client.d.ts +29 -0
- package/dist/cjs/api/resources/rcs/resources/agents/client/Client.js +133 -0
- package/dist/cjs/api/resources/rcs/resources/agents/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/rcs/resources/agents/client/index.js +17 -0
- package/dist/cjs/api/resources/rcs/resources/agents/client/requests/ListAgentsParams.d.ts +20 -0
- package/dist/cjs/api/resources/rcs/resources/agents/client/requests/ListAgentsParams.js +12 -0
- package/dist/cjs/api/resources/rcs/resources/agents/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/rcs/resources/agents/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/rcs/resources/agents/index.d.ts +1 -0
- package/dist/cjs/api/resources/rcs/resources/agents/index.js +17 -0
- package/dist/cjs/api/resources/rcs/resources/index.d.ts +6 -0
- package/dist/cjs/api/resources/rcs/resources/index.js +45 -0
- package/dist/cjs/api/resources/rcs/resources/test/client/Client.d.ts +214 -0
- package/dist/cjs/api/resources/rcs/resources/test/client/Client.js +497 -0
- package/dist/cjs/api/resources/rcs/resources/test/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/rcs/resources/test/client/index.js +17 -0
- package/dist/cjs/api/resources/rcs/resources/test/client/requests/CreateTestAgentRequest.d.ts +87 -0
- package/dist/cjs/api/resources/rcs/resources/test/client/requests/CreateTestAgentRequest.js +3 -0
- package/dist/cjs/api/resources/rcs/resources/test/client/requests/TestAgentWhitelistRequest.d.ts +15 -0
- package/dist/cjs/api/resources/rcs/resources/test/client/requests/TestAgentWhitelistRequest.js +3 -0
- package/dist/cjs/api/resources/rcs/resources/test/client/requests/TestGetWhitelistStatusRequest.d.ts +20 -0
- package/dist/cjs/api/resources/rcs/resources/test/client/requests/TestGetWhitelistStatusRequest.js +3 -0
- package/dist/cjs/api/resources/rcs/resources/test/client/requests/UpdateTestAgentRequest.d.ts +59 -0
- package/dist/cjs/api/resources/rcs/resources/test/client/requests/UpdateTestAgentRequest.js +3 -0
- package/dist/cjs/api/resources/rcs/resources/test/client/requests/index.d.ts +4 -0
- package/dist/cjs/api/resources/rcs/resources/test/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/rcs/resources/test/index.d.ts +1 -0
- package/dist/cjs/api/resources/rcs/resources/test/index.js +17 -0
- package/dist/cjs/api/resources/rcs/resources/whitelistedNumbers/client/Client.d.ts +29 -0
- package/dist/cjs/api/resources/rcs/resources/whitelistedNumbers/client/Client.js +133 -0
- package/dist/cjs/api/resources/rcs/resources/whitelistedNumbers/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/rcs/resources/whitelistedNumbers/client/index.js +17 -0
- package/dist/cjs/api/resources/rcs/resources/whitelistedNumbers/client/requests/ListTestNumbersParams.d.ts +23 -0
- package/dist/cjs/api/resources/rcs/resources/whitelistedNumbers/client/requests/ListTestNumbersParams.js +13 -0
- package/dist/cjs/api/resources/rcs/resources/whitelistedNumbers/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/rcs/resources/whitelistedNumbers/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/rcs/resources/whitelistedNumbers/index.d.ts +1 -0
- package/dist/cjs/api/resources/rcs/resources/whitelistedNumbers/index.js +17 -0
- package/dist/cjs/api/resources/tools/resources/url/client/Client.d.ts +15 -0
- package/dist/cjs/api/resources/tools/resources/url/client/Client.js +70 -0
- package/dist/cjs/api/resources/tools/resources/url/client/requests/ListLinksParams.d.ts +10 -0
- package/dist/cjs/api/resources/tools/resources/url/client/requests/ListLinksParams.js +3 -0
- package/dist/cjs/api/resources/tools/resources/url/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/webhooks/client/Client.d.ts +15 -0
- package/dist/cjs/api/resources/webhooks/client/Client.js +70 -0
- package/dist/cjs/api/resources/webhooks/client/requests/ListWebhooksParams.d.ts +19 -0
- package/dist/cjs/api/resources/webhooks/client/requests/ListWebhooksParams.js +12 -0
- package/dist/cjs/api/resources/webhooks/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/types/AgentEmailEntry.d.ts +9 -0
- package/dist/cjs/api/types/AgentEmailEntry.js +3 -0
- package/dist/cjs/api/types/AgentPhoneEntry.d.ts +9 -0
- package/dist/cjs/api/types/AgentPhoneEntry.js +3 -0
- package/dist/cjs/api/types/AgentSummary.d.ts +94 -0
- package/dist/cjs/api/types/AgentSummary.js +22 -0
- package/dist/cjs/api/types/AgentUseCase.d.ts +15 -0
- package/dist/cjs/api/types/AgentUseCase.js +18 -0
- package/dist/cjs/api/types/AgentWebsiteEntry.d.ts +9 -0
- package/dist/cjs/api/types/AgentWebsiteEntry.js +3 -0
- package/dist/cjs/api/types/AudienceSummary.d.ts +12 -0
- package/dist/cjs/api/types/AudienceSummary.js +3 -0
- package/dist/cjs/api/types/BlastDetails.d.ts +1 -1
- package/dist/cjs/api/types/BlastSummary.d.ts +27 -0
- package/dist/cjs/api/types/BlastSummary.js +13 -0
- package/dist/cjs/api/types/CarrierLaunchStatus.d.ts +12 -0
- package/dist/cjs/api/types/CarrierLaunchStatus.js +15 -0
- package/dist/cjs/api/types/CarrierLaunches.d.ts +14 -0
- package/dist/cjs/api/types/CarrierLaunches.js +3 -0
- package/dist/cjs/api/types/DlcCampaignSummary.d.ts +26 -0
- package/dist/cjs/api/types/DlcCampaignSummary.js +14 -0
- package/dist/cjs/api/types/FallbackMessage.d.ts +6 -5
- package/dist/cjs/api/types/LinkSummary.d.ts +10 -0
- package/dist/cjs/api/types/LinkSummary.js +3 -0
- package/dist/cjs/api/types/ListAgentsResponse.d.ts +6 -0
- package/dist/cjs/api/types/ListAgentsResponse.js +3 -0
- package/dist/cjs/api/types/ListAudiencesResponse.d.ts +6 -0
- package/dist/cjs/api/types/ListAudiencesResponse.js +3 -0
- package/dist/cjs/api/types/ListBlastsResponse.d.ts +6 -0
- package/dist/cjs/api/types/ListBlastsResponse.js +3 -0
- package/dist/cjs/api/types/ListBrandsResponse.d.ts +6 -0
- package/dist/cjs/api/types/ListBrandsResponse.js +3 -0
- package/dist/cjs/api/types/ListContactsResponse.d.ts +6 -0
- package/dist/cjs/api/types/ListContactsResponse.js +3 -0
- package/dist/cjs/api/types/ListDlcCampaignsResponse.d.ts +6 -0
- package/dist/cjs/api/types/ListDlcCampaignsResponse.js +3 -0
- package/dist/cjs/api/types/ListLinksResponse.d.ts +6 -0
- package/dist/cjs/api/types/ListLinksResponse.js +3 -0
- package/dist/cjs/api/types/ListMessagesResponse.d.ts +6 -0
- package/dist/cjs/api/types/ListMessagesResponse.js +3 -0
- package/dist/cjs/api/types/ListPhoneNumbersResponse.d.ts +6 -0
- package/dist/cjs/api/types/ListPhoneNumbersResponse.js +3 -0
- package/dist/cjs/api/types/ListRcsCampaignsResponse.d.ts +6 -0
- package/dist/cjs/api/types/ListRcsCampaignsResponse.js +3 -0
- package/dist/cjs/api/types/ListScheduledMessagesResponse.d.ts +6 -0
- package/dist/cjs/api/types/ListScheduledMessagesResponse.js +3 -0
- package/dist/cjs/api/types/ListTestNumbersResponse.d.ts +6 -0
- package/dist/cjs/api/types/ListTestNumbersResponse.js +3 -0
- package/dist/cjs/api/types/ListTollFreeCampaignsResponse.d.ts +6 -0
- package/dist/cjs/api/types/ListTollFreeCampaignsResponse.js +3 -0
- package/dist/cjs/api/types/ListWebhooksResponse.d.ts +6 -0
- package/dist/cjs/api/types/ListWebhooksResponse.js +3 -0
- package/dist/cjs/api/types/Message.d.ts +0 -8
- package/dist/cjs/api/types/MessageEvent.d.ts +21 -14
- package/dist/cjs/api/types/MessageEvent.js +1 -1
- package/dist/cjs/api/types/MessageList.d.ts +1 -1
- package/dist/cjs/api/types/MessageSummary.d.ts +71 -0
- package/dist/cjs/api/types/MessageSummary.js +36 -0
- package/dist/cjs/api/types/{MessageWithReaction.d.ts → MessageWithReactions.d.ts} +7 -7
- package/dist/cjs/api/types/{MessageWithReaction.js → MessageWithReactions.js} +5 -5
- package/dist/cjs/api/types/OwnedPhoneNumber.d.ts +14 -0
- package/dist/cjs/api/types/OwnedPhoneNumber.js +3 -0
- package/dist/cjs/api/types/RcsAgentDetails.d.ts +81 -0
- package/dist/cjs/api/types/RcsAgentDetails.js +20 -0
- package/dist/cjs/api/types/RcsAgentResponse.d.ts +17 -0
- package/dist/cjs/api/types/RcsAgentResponse.js +3 -0
- package/dist/cjs/api/types/RcsCampaignSummary.d.ts +28 -0
- package/dist/cjs/api/types/RcsCampaignSummary.js +14 -0
- package/dist/cjs/api/types/RcsWhitelistStatus.d.ts +13 -0
- package/dist/cjs/api/types/RcsWhitelistStatus.js +16 -0
- package/dist/cjs/api/types/ScheduledMessageSummary.d.ts +29 -0
- package/dist/cjs/api/types/ScheduledMessageSummary.js +13 -0
- package/dist/cjs/api/types/SendRichMessageOptions.d.ts +0 -2
- package/dist/cjs/api/types/SentRichMessageFallbackMms.d.ts +10 -0
- package/dist/cjs/api/types/SentRichMessageFallbackMms.js +3 -0
- package/dist/cjs/api/types/SentRichMessageFallbackSms.d.ts +10 -0
- package/dist/cjs/api/types/SentRichMessageFallbackSms.js +3 -0
- package/dist/cjs/api/types/TestAgentResponse.d.ts +19 -0
- package/dist/cjs/api/types/TestAgentResponse.js +3 -0
- package/dist/cjs/api/types/TestAgentWhitelistResponse.d.ts +7 -0
- package/dist/cjs/api/types/TestAgentWhitelistResponse.js +3 -0
- package/dist/cjs/api/types/TollFreeCampaignSummary.d.ts +26 -0
- package/dist/cjs/api/types/TollFreeCampaignSummary.js +14 -0
- package/dist/cjs/api/types/WebhookSummary.d.ts +23 -0
- package/dist/cjs/api/types/WebhookSummary.js +13 -0
- package/dist/cjs/api/types/WhitelistedNumberSummary.d.ts +19 -0
- package/dist/cjs/api/types/WhitelistedNumberSummary.js +13 -0
- package/dist/cjs/api/types/index.d.ts +40 -2
- package/dist/cjs/api/types/index.js +40 -2
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.mjs +2 -2
- package/dist/esm/api/resources/audiences/client/Client.d.mts +15 -0
- package/dist/esm/api/resources/audiences/client/Client.mjs +70 -0
- package/dist/esm/api/resources/audiences/client/requests/ListAudiencesParams.d.mts +10 -0
- package/dist/esm/api/resources/audiences/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/brands/client/Client.d.mts +15 -0
- package/dist/esm/api/resources/brands/client/Client.mjs +70 -0
- package/dist/esm/api/resources/brands/client/requests/ListBrandsParams.d.mts +23 -0
- package/dist/esm/api/resources/brands/client/requests/ListBrandsParams.mjs +12 -0
- package/dist/esm/api/resources/brands/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/campaigns/resources/dlc/client/Client.d.mts +15 -0
- package/dist/esm/api/resources/campaigns/resources/dlc/client/Client.mjs +70 -0
- package/dist/esm/api/resources/campaigns/resources/dlc/client/requests/ListDlcCampaignsParams.d.mts +21 -0
- package/dist/esm/api/resources/campaigns/resources/dlc/client/requests/ListDlcCampaignsParams.mjs +10 -0
- package/dist/esm/api/resources/campaigns/resources/dlc/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/campaigns/resources/rcs/client/Client.d.mts +15 -0
- package/dist/esm/api/resources/campaigns/resources/rcs/client/Client.mjs +70 -0
- package/dist/esm/api/resources/campaigns/resources/rcs/client/requests/ListRcsCampaignsParams.d.mts +21 -0
- package/dist/esm/api/resources/campaigns/resources/rcs/client/requests/ListRcsCampaignsParams.mjs +10 -0
- package/dist/esm/api/resources/campaigns/resources/rcs/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/campaigns/resources/tollFree/client/Client.d.mts +15 -0
- package/dist/esm/api/resources/campaigns/resources/tollFree/client/Client.mjs +73 -0
- package/dist/esm/api/resources/campaigns/resources/tollFree/client/requests/ListTollFreeCampaignsParams.d.mts +21 -0
- package/dist/esm/api/resources/campaigns/resources/tollFree/client/requests/ListTollFreeCampaignsParams.mjs +10 -0
- package/dist/esm/api/resources/campaigns/resources/tollFree/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/contacts/client/Client.d.mts +15 -0
- package/dist/esm/api/resources/contacts/client/Client.mjs +70 -0
- package/dist/esm/api/resources/contacts/client/requests/ListContactsParams.d.mts +16 -0
- package/dist/esm/api/resources/contacts/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/messages/client/Client.d.mts +21 -0
- package/dist/esm/api/resources/messages/client/Client.mjs +80 -0
- package/dist/esm/api/resources/messages/client/requests/ListMessagesParams.d.mts +55 -0
- package/dist/esm/api/resources/messages/client/requests/ListMessagesParams.mjs +30 -0
- package/dist/esm/api/resources/messages/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/messages/resources/blast/client/requests/BlastRcs.d.mts +0 -2
- package/dist/esm/api/resources/messages/resources/blasts/client/Client.d.mts +29 -0
- package/dist/esm/api/resources/messages/resources/blasts/client/Client.mjs +96 -0
- package/dist/esm/api/resources/messages/resources/blasts/client/index.d.mts +1 -0
- package/dist/esm/api/resources/messages/resources/blasts/client/index.mjs +1 -0
- package/dist/esm/api/resources/messages/resources/blasts/client/requests/ListBlastsParams.d.mts +17 -0
- package/dist/esm/api/resources/messages/resources/blasts/client/requests/ListBlastsParams.mjs +2 -0
- package/dist/esm/api/resources/messages/resources/blasts/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/messages/resources/blasts/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/messages/resources/blasts/index.d.mts +1 -0
- package/dist/esm/api/resources/messages/resources/blasts/index.mjs +1 -0
- package/dist/esm/api/resources/messages/resources/index.d.mts +4 -0
- package/dist/esm/api/resources/messages/resources/index.mjs +4 -0
- package/dist/esm/api/resources/messages/resources/rcs/client/Client.d.mts +1 -4
- package/dist/esm/api/resources/messages/resources/rcs/client/Client.mjs +1 -4
- package/dist/esm/api/resources/messages/resources/rcs/client/requests/SendTypingIndicatorSchema.d.mts +1 -15
- package/dist/esm/api/resources/messages/resources/rcs/types/SendRichMessageResponse.d.mts +1 -1
- package/dist/esm/api/resources/messages/resources/schedules/client/Client.d.mts +29 -0
- package/dist/esm/api/resources/messages/resources/schedules/client/Client.mjs +99 -0
- package/dist/esm/api/resources/messages/resources/schedules/client/index.d.mts +1 -0
- package/dist/esm/api/resources/messages/resources/schedules/client/index.mjs +1 -0
- package/dist/esm/api/resources/messages/resources/schedules/client/requests/ListScheduledMessagesParams.d.mts +27 -0
- package/dist/esm/api/resources/messages/resources/schedules/client/requests/ListScheduledMessagesParams.mjs +14 -0
- package/dist/esm/api/resources/messages/resources/schedules/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/messages/resources/schedules/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/messages/resources/schedules/index.d.mts +1 -0
- package/dist/esm/api/resources/messages/resources/schedules/index.mjs +1 -0
- package/dist/esm/api/resources/phoneNumbers/client/Client.d.mts +15 -0
- package/dist/esm/api/resources/phoneNumbers/client/Client.mjs +70 -0
- package/dist/esm/api/resources/phoneNumbers/client/requests/ListPhoneNumbersParams.d.mts +8 -0
- package/dist/esm/api/resources/phoneNumbers/client/requests/ListPhoneNumbersParams.mjs +2 -0
- package/dist/esm/api/resources/phoneNumbers/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/rcs/client/Client.d.mts +25 -42
- package/dist/esm/api/resources/rcs/client/Client.mjs +40 -56
- package/dist/esm/api/resources/rcs/client/requests/RcsCapabilitiesQuery.d.mts +2 -0
- package/dist/esm/api/resources/rcs/client/requests/RcsLinkRequest.d.mts +0 -3
- package/dist/esm/api/resources/rcs/client/requests/index.d.mts +0 -1
- 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/rcs/resources/agents/client/Client.d.mts +29 -0
- package/dist/esm/api/resources/rcs/resources/agents/client/Client.mjs +96 -0
- package/dist/esm/api/resources/rcs/resources/agents/client/index.d.mts +1 -0
- package/dist/esm/api/resources/rcs/resources/agents/client/index.mjs +1 -0
- package/dist/esm/api/resources/rcs/resources/agents/client/requests/ListAgentsParams.d.mts +20 -0
- package/dist/esm/api/resources/rcs/resources/agents/client/requests/ListAgentsParams.mjs +9 -0
- package/dist/esm/api/resources/rcs/resources/agents/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/rcs/resources/agents/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/rcs/resources/agents/index.d.mts +1 -0
- package/dist/esm/api/resources/rcs/resources/agents/index.mjs +1 -0
- package/dist/esm/api/resources/rcs/resources/index.d.mts +6 -0
- package/dist/esm/api/resources/rcs/resources/index.mjs +6 -0
- package/dist/esm/api/resources/rcs/resources/test/client/Client.d.mts +214 -0
- package/dist/esm/api/resources/rcs/resources/test/client/Client.mjs +460 -0
- package/dist/esm/api/resources/rcs/resources/test/client/index.d.mts +1 -0
- package/dist/esm/api/resources/rcs/resources/test/client/index.mjs +1 -0
- package/dist/esm/api/resources/rcs/resources/test/client/requests/CreateTestAgentRequest.d.mts +87 -0
- package/dist/esm/api/resources/rcs/resources/test/client/requests/CreateTestAgentRequest.mjs +2 -0
- package/dist/esm/api/resources/rcs/resources/test/client/requests/TestAgentWhitelistRequest.d.mts +15 -0
- package/dist/esm/api/resources/rcs/resources/test/client/requests/TestAgentWhitelistRequest.mjs +2 -0
- package/dist/esm/api/resources/rcs/resources/test/client/requests/TestGetWhitelistStatusRequest.d.mts +20 -0
- package/dist/esm/api/resources/rcs/resources/test/client/requests/TestGetWhitelistStatusRequest.mjs +2 -0
- package/dist/esm/api/resources/rcs/resources/test/client/requests/UpdateTestAgentRequest.d.mts +59 -0
- package/dist/esm/api/resources/rcs/resources/test/client/requests/UpdateTestAgentRequest.mjs +2 -0
- package/dist/esm/api/resources/rcs/resources/test/client/requests/index.d.mts +4 -0
- package/dist/esm/api/resources/rcs/resources/test/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/rcs/resources/test/index.d.mts +1 -0
- package/dist/esm/api/resources/rcs/resources/test/index.mjs +1 -0
- package/dist/esm/api/resources/rcs/resources/whitelistedNumbers/client/Client.d.mts +29 -0
- package/dist/esm/api/resources/rcs/resources/whitelistedNumbers/client/Client.mjs +96 -0
- package/dist/esm/api/resources/rcs/resources/whitelistedNumbers/client/index.d.mts +1 -0
- package/dist/esm/api/resources/rcs/resources/whitelistedNumbers/client/index.mjs +1 -0
- package/dist/esm/api/resources/rcs/resources/whitelistedNumbers/client/requests/ListTestNumbersParams.d.mts +23 -0
- package/dist/esm/api/resources/rcs/resources/whitelistedNumbers/client/requests/ListTestNumbersParams.mjs +10 -0
- package/dist/esm/api/resources/rcs/resources/whitelistedNumbers/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/rcs/resources/whitelistedNumbers/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/rcs/resources/whitelistedNumbers/index.d.mts +1 -0
- package/dist/esm/api/resources/rcs/resources/whitelistedNumbers/index.mjs +1 -0
- package/dist/esm/api/resources/tools/resources/url/client/Client.d.mts +15 -0
- package/dist/esm/api/resources/tools/resources/url/client/Client.mjs +70 -0
- package/dist/esm/api/resources/tools/resources/url/client/requests/ListLinksParams.d.mts +10 -0
- package/dist/esm/api/resources/tools/resources/url/client/requests/ListLinksParams.mjs +2 -0
- package/dist/esm/api/resources/tools/resources/url/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/webhooks/client/Client.d.mts +15 -0
- package/dist/esm/api/resources/webhooks/client/Client.mjs +70 -0
- package/dist/esm/api/resources/webhooks/client/requests/ListWebhooksParams.d.mts +19 -0
- package/dist/esm/api/resources/webhooks/client/requests/ListWebhooksParams.mjs +9 -0
- package/dist/esm/api/resources/webhooks/client/requests/index.d.mts +1 -0
- package/dist/esm/api/types/AgentEmailEntry.d.mts +9 -0
- package/dist/esm/api/types/AgentEmailEntry.mjs +2 -0
- package/dist/esm/api/types/AgentPhoneEntry.d.mts +9 -0
- package/dist/esm/api/types/AgentPhoneEntry.mjs +2 -0
- package/dist/esm/api/types/AgentSummary.d.mts +94 -0
- package/dist/esm/api/types/AgentSummary.mjs +19 -0
- package/dist/esm/api/types/AgentUseCase.d.mts +15 -0
- package/dist/esm/api/types/AgentUseCase.mjs +15 -0
- package/dist/esm/api/types/AgentWebsiteEntry.d.mts +9 -0
- package/dist/esm/api/types/AgentWebsiteEntry.mjs +2 -0
- package/dist/esm/api/types/AudienceSummary.d.mts +12 -0
- package/dist/esm/api/types/AudienceSummary.mjs +2 -0
- package/dist/esm/api/types/BlastDetails.d.mts +1 -1
- package/dist/esm/api/types/BlastSummary.d.mts +27 -0
- package/dist/esm/api/types/BlastSummary.mjs +10 -0
- package/dist/esm/api/types/CarrierLaunchStatus.d.mts +12 -0
- package/dist/esm/api/types/CarrierLaunchStatus.mjs +12 -0
- package/dist/esm/api/types/CarrierLaunches.d.mts +14 -0
- package/dist/esm/api/types/CarrierLaunches.mjs +2 -0
- package/dist/esm/api/types/DlcCampaignSummary.d.mts +26 -0
- package/dist/esm/api/types/DlcCampaignSummary.mjs +11 -0
- package/dist/esm/api/types/FallbackMessage.d.mts +6 -5
- package/dist/esm/api/types/LinkSummary.d.mts +10 -0
- package/dist/esm/api/types/LinkSummary.mjs +2 -0
- package/dist/esm/api/types/ListAgentsResponse.d.mts +6 -0
- package/dist/esm/api/types/ListAgentsResponse.mjs +2 -0
- package/dist/esm/api/types/ListAudiencesResponse.d.mts +6 -0
- package/dist/esm/api/types/ListAudiencesResponse.mjs +2 -0
- package/dist/esm/api/types/ListBlastsResponse.d.mts +6 -0
- package/dist/esm/api/types/ListBlastsResponse.mjs +2 -0
- package/dist/esm/api/types/ListBrandsResponse.d.mts +6 -0
- package/dist/esm/api/types/ListBrandsResponse.mjs +2 -0
- package/dist/esm/api/types/ListContactsResponse.d.mts +6 -0
- package/dist/esm/api/types/ListContactsResponse.mjs +2 -0
- package/dist/esm/api/types/ListDlcCampaignsResponse.d.mts +6 -0
- package/dist/esm/api/types/ListDlcCampaignsResponse.mjs +2 -0
- package/dist/esm/api/types/ListLinksResponse.d.mts +6 -0
- package/dist/esm/api/types/ListLinksResponse.mjs +2 -0
- package/dist/esm/api/types/ListMessagesResponse.d.mts +6 -0
- package/dist/esm/api/types/ListMessagesResponse.mjs +2 -0
- package/dist/esm/api/types/ListPhoneNumbersResponse.d.mts +6 -0
- package/dist/esm/api/types/ListPhoneNumbersResponse.mjs +2 -0
- package/dist/esm/api/types/ListRcsCampaignsResponse.d.mts +6 -0
- package/dist/esm/api/types/ListRcsCampaignsResponse.mjs +2 -0
- package/dist/esm/api/types/ListScheduledMessagesResponse.d.mts +6 -0
- package/dist/esm/api/types/ListScheduledMessagesResponse.mjs +2 -0
- package/dist/esm/api/types/ListTestNumbersResponse.d.mts +6 -0
- package/dist/esm/api/types/ListTestNumbersResponse.mjs +2 -0
- package/dist/esm/api/types/ListTollFreeCampaignsResponse.d.mts +6 -0
- package/dist/esm/api/types/ListTollFreeCampaignsResponse.mjs +2 -0
- package/dist/esm/api/types/ListWebhooksResponse.d.mts +6 -0
- package/dist/esm/api/types/ListWebhooksResponse.mjs +2 -0
- package/dist/esm/api/types/Message.d.mts +0 -8
- package/dist/esm/api/types/MessageEvent.d.mts +21 -14
- package/dist/esm/api/types/MessageEvent.mjs +1 -1
- package/dist/esm/api/types/MessageList.d.mts +1 -1
- package/dist/esm/api/types/MessageSummary.d.mts +71 -0
- package/dist/esm/api/types/MessageSummary.mjs +33 -0
- package/dist/esm/api/types/{MessageWithReaction.d.mts → MessageWithReactions.d.mts} +7 -7
- package/dist/esm/api/types/{MessageWithReaction.mjs → MessageWithReactions.mjs} +4 -4
- package/dist/esm/api/types/OwnedPhoneNumber.d.mts +14 -0
- package/dist/esm/api/types/OwnedPhoneNumber.mjs +2 -0
- package/dist/esm/api/types/RcsAgentDetails.d.mts +81 -0
- package/dist/esm/api/types/RcsAgentDetails.mjs +17 -0
- package/dist/esm/api/types/RcsAgentResponse.d.mts +17 -0
- package/dist/esm/api/types/RcsAgentResponse.mjs +2 -0
- package/dist/esm/api/types/RcsCampaignSummary.d.mts +28 -0
- package/dist/esm/api/types/RcsCampaignSummary.mjs +11 -0
- package/dist/esm/api/types/RcsWhitelistStatus.d.mts +13 -0
- package/dist/esm/api/types/RcsWhitelistStatus.mjs +13 -0
- package/dist/esm/api/types/ScheduledMessageSummary.d.mts +29 -0
- package/dist/esm/api/types/ScheduledMessageSummary.mjs +10 -0
- package/dist/esm/api/types/SendRichMessageOptions.d.mts +0 -2
- package/dist/esm/api/types/SentRichMessageFallbackMms.d.mts +10 -0
- package/dist/esm/api/types/SentRichMessageFallbackMms.mjs +2 -0
- package/dist/esm/api/types/SentRichMessageFallbackSms.d.mts +10 -0
- package/dist/esm/api/types/SentRichMessageFallbackSms.mjs +2 -0
- package/dist/esm/api/types/TestAgentResponse.d.mts +19 -0
- package/dist/esm/api/types/TestAgentResponse.mjs +2 -0
- package/dist/esm/api/types/TestAgentWhitelistResponse.d.mts +7 -0
- package/dist/esm/api/types/TestAgentWhitelistResponse.mjs +2 -0
- package/dist/esm/api/types/TollFreeCampaignSummary.d.mts +26 -0
- package/dist/esm/api/types/TollFreeCampaignSummary.mjs +11 -0
- package/dist/esm/api/types/WebhookSummary.d.mts +23 -0
- package/dist/esm/api/types/WebhookSummary.mjs +10 -0
- package/dist/esm/api/types/WhitelistedNumberSummary.d.mts +19 -0
- package/dist/esm/api/types/WhitelistedNumberSummary.mjs +10 -0
- package/dist/esm/api/types/index.d.mts +40 -2
- package/dist/esm/api/types/index.mjs +40 -2
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +2 -2
- package/reference.md +1413 -155
- package/dist/cjs/api/resources/rcs/client/requests/RcsWhitelistRequest.d.ts +0 -13
- package/dist/cjs/api/types/RcsWhitelistResponse.d.ts +0 -7
- package/dist/esm/api/resources/rcs/client/requests/RcsWhitelistRequest.d.mts +0 -13
- package/dist/esm/api/types/RcsWhitelistResponse.d.mts +0 -7
- /package/dist/cjs/api/resources/{rcs/client/requests/RcsWhitelistRequest.js → audiences/client/requests/ListAudiencesParams.js} +0 -0
- /package/dist/cjs/api/{types/RcsWhitelistResponse.js → resources/contacts/client/requests/ListContactsParams.js} +0 -0
- /package/dist/esm/api/resources/{rcs/client/requests/RcsWhitelistRequest.mjs → audiences/client/requests/ListAudiencesParams.mjs} +0 -0
- /package/dist/esm/api/{types/RcsWhitelistResponse.mjs → resources/contacts/client/requests/ListContactsParams.mjs} +0 -0
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
export interface AudienceSummary {
|
|
2
|
+
/** Audience public ID. This identifier is a string that always begins with the prefix `aud_`, for example: `aud_abc123`. */
|
|
3
|
+
id: string;
|
|
4
|
+
/** Audience name. */
|
|
5
|
+
name: string;
|
|
6
|
+
/** Audience description. */
|
|
7
|
+
description: string;
|
|
8
|
+
/** ISO 8601 timestamp of when the audience was created. */
|
|
9
|
+
createdAt: string;
|
|
10
|
+
/** ISO 8601 timestamp of when the audience was last updated. */
|
|
11
|
+
updatedAt: string;
|
|
12
|
+
}
|
|
@@ -12,6 +12,6 @@ export interface BlastDetails {
|
|
|
12
12
|
totalMessages: number;
|
|
13
13
|
/** Total number of message segments across all messages. */
|
|
14
14
|
totalSegments: number;
|
|
15
|
-
/** Total
|
|
15
|
+
/** Total cost of the blast. For RCS blasts with a fallback configured, this reflects the actual mix of RCS and SMS/MMS pricing based on each recipient's RCS capability. For more details check the [Transactions page](https://app.pinnacle.sh/dashboard/settings/billing/transactions) and the [Audiences page](https://app.pinnacle.sh/dashboard/audiences) to see blasts. */
|
|
16
16
|
totalCost: number;
|
|
17
17
|
}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
export interface BlastSummary {
|
|
2
|
+
/** Unique identifier for the blast. */
|
|
3
|
+
id: string;
|
|
4
|
+
/** Audience ID associated with this blast. */
|
|
5
|
+
audienceId: string;
|
|
6
|
+
/** Type of the blast message. */
|
|
7
|
+
type: BlastSummary.Type;
|
|
8
|
+
/** Sender identifiers (phone numbers or agent IDs) used for the blast. */
|
|
9
|
+
senders: string[];
|
|
10
|
+
/** Message content sent in the blast. */
|
|
11
|
+
content: Record<string, unknown>;
|
|
12
|
+
/** Blast options configuration. */
|
|
13
|
+
options: Record<string, unknown> | null;
|
|
14
|
+
/** Fallback message configuration, if any. */
|
|
15
|
+
fallback: Record<string, unknown> | null;
|
|
16
|
+
/** ISO 8601 timestamp of when the blast was created. */
|
|
17
|
+
createdAt: string;
|
|
18
|
+
}
|
|
19
|
+
export declare namespace BlastSummary {
|
|
20
|
+
/** Type of the blast message. */
|
|
21
|
+
const Type: {
|
|
22
|
+
readonly Sms: "SMS";
|
|
23
|
+
readonly Mms: "MMS";
|
|
24
|
+
readonly Rcs: "RCS";
|
|
25
|
+
};
|
|
26
|
+
type Type = (typeof Type)[keyof typeof Type];
|
|
27
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
export var BlastSummary;
|
|
3
|
+
(function (BlastSummary) {
|
|
4
|
+
/** Type of the blast message. */
|
|
5
|
+
BlastSummary.Type = {
|
|
6
|
+
Sms: "SMS",
|
|
7
|
+
Mms: "MMS",
|
|
8
|
+
Rcs: "RCS",
|
|
9
|
+
};
|
|
10
|
+
})(BlastSummary || (BlastSummary = {}));
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Launch status for a carrier.
|
|
3
|
+
* - `NOT_LAUNCHED` — No launch requested.
|
|
4
|
+
* - `PENDING` — Launch pending.
|
|
5
|
+
* - `LAUNCHED` — Launched.
|
|
6
|
+
*/
|
|
7
|
+
export declare const CarrierLaunchStatus: {
|
|
8
|
+
readonly NotLaunched: "NOT_LAUNCHED";
|
|
9
|
+
readonly Pending: "PENDING";
|
|
10
|
+
readonly Launched: "LAUNCHED";
|
|
11
|
+
};
|
|
12
|
+
export type CarrierLaunchStatus = (typeof CarrierLaunchStatus)[keyof typeof CarrierLaunchStatus];
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
/**
|
|
3
|
+
* Launch status for a carrier.
|
|
4
|
+
* - `NOT_LAUNCHED` — No launch requested.
|
|
5
|
+
* - `PENDING` — Launch pending.
|
|
6
|
+
* - `LAUNCHED` — Launched.
|
|
7
|
+
*/
|
|
8
|
+
export const CarrierLaunchStatus = {
|
|
9
|
+
NotLaunched: "NOT_LAUNCHED",
|
|
10
|
+
Pending: "PENDING",
|
|
11
|
+
Launched: "LAUNCHED",
|
|
12
|
+
};
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import type * as Pinnacle from "../index.mjs";
|
|
2
|
+
/**
|
|
3
|
+
* Per-carrier launch status.
|
|
4
|
+
*/
|
|
5
|
+
export interface CarrierLaunches {
|
|
6
|
+
/** AT&T launch status. */
|
|
7
|
+
ATT: Pinnacle.CarrierLaunchStatus;
|
|
8
|
+
/** T-Mobile launch status. */
|
|
9
|
+
TMOBILE: Pinnacle.CarrierLaunchStatus;
|
|
10
|
+
/** Verizon launch status. */
|
|
11
|
+
VERIZON: Pinnacle.CarrierLaunchStatus;
|
|
12
|
+
/** Other carriers launch status. */
|
|
13
|
+
OTHERS: Pinnacle.CarrierLaunchStatus;
|
|
14
|
+
}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
export interface DlcCampaignSummary {
|
|
2
|
+
/** Unique identifier for the 10DLC campaign. */
|
|
3
|
+
campaignId: string;
|
|
4
|
+
/** Name of the campaign. */
|
|
5
|
+
name?: string;
|
|
6
|
+
/** Current status of the campaign. */
|
|
7
|
+
status: DlcCampaignSummary.Status;
|
|
8
|
+
/** Brand ID associated with this campaign. */
|
|
9
|
+
brandId?: string;
|
|
10
|
+
/** Primary use case for this campaign. */
|
|
11
|
+
useCase?: string;
|
|
12
|
+
/** ISO 8601 timestamp of when the campaign was created. */
|
|
13
|
+
createdAt: string;
|
|
14
|
+
/** ISO 8601 timestamp of when the campaign was last updated. */
|
|
15
|
+
updatedAt: string;
|
|
16
|
+
}
|
|
17
|
+
export declare namespace DlcCampaignSummary {
|
|
18
|
+
/** Current status of the campaign. */
|
|
19
|
+
const Status: {
|
|
20
|
+
readonly Incomplete: "INCOMPLETE";
|
|
21
|
+
readonly InReview: "IN REVIEW";
|
|
22
|
+
readonly Verified: "VERIFIED";
|
|
23
|
+
readonly Failed: "FAILED";
|
|
24
|
+
};
|
|
25
|
+
type Status = (typeof Status)[keyof typeof Status];
|
|
26
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
export var DlcCampaignSummary;
|
|
3
|
+
(function (DlcCampaignSummary) {
|
|
4
|
+
/** Current status of the campaign. */
|
|
5
|
+
DlcCampaignSummary.Status = {
|
|
6
|
+
Incomplete: "INCOMPLETE",
|
|
7
|
+
InReview: "IN REVIEW",
|
|
8
|
+
Verified: "VERIFIED",
|
|
9
|
+
Failed: "FAILED",
|
|
10
|
+
};
|
|
11
|
+
})(DlcCampaignSummary || (DlcCampaignSummary = {}));
|
|
@@ -1,16 +1,17 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* SMS/MMS fallback message to send if the RCS message fails to deliver.
|
|
3
3
|
*
|
|
4
|
-
* When a recipient's device doesn't support RCS
|
|
4
|
+
* When a recipient's device doesn't support RCS, this fallback message will be sent as SMS or MMS instead. The fallback is sent from the specified phone number.
|
|
5
5
|
*
|
|
6
6
|
* > **Note:** At least one of `text` or `mediaUrls` must be provided. Fallback messages require a verified `from` phone number with SMS/MMS sending capabilities.
|
|
7
|
-
*
|
|
7
|
+
*
|
|
8
|
+
* > **Billing:** You will be charged the standard SMS or MMS rate for the fallback message. The original RCS message will not be charged if the fallback is sent instead.
|
|
8
9
|
*/
|
|
9
10
|
export interface FallbackMessage {
|
|
10
11
|
/**
|
|
11
12
|
* Phone number to send the fallback message from in E.164 format.
|
|
12
13
|
*
|
|
13
|
-
* Must be a verified phone number with SMS/MMS sending capabilities. Sandbox numbers cannot be used for fallbacks. The phone number must be connected an active toll-free or 10DLC campaign.
|
|
14
|
+
* Must be a verified phone number with SMS/MMS sending capabilities. Sandbox numbers cannot be used for fallbacks. The phone number must be connected to an active toll-free or 10DLC campaign.
|
|
14
15
|
*/
|
|
15
16
|
from: string;
|
|
16
17
|
/**
|
|
@@ -18,7 +19,7 @@ export interface FallbackMessage {
|
|
|
18
19
|
*
|
|
19
20
|
* At least one of `text` or `mediaUrls` must be provided.
|
|
20
21
|
*
|
|
21
|
-
*
|
|
22
|
+
* If `mediaUrls` is empty and the text fits within SMS segment limits, the fallback will be sent as SMS. Otherwise, it will be sent as MMS. You will only be billed for the message sent.
|
|
22
23
|
*/
|
|
23
24
|
text?: string;
|
|
24
25
|
/**
|
|
@@ -26,7 +27,7 @@ export interface FallbackMessage {
|
|
|
26
27
|
*
|
|
27
28
|
* See [supported media types](https://app.pinnacle.sh/supported-file-types?type=MMS).
|
|
28
29
|
*
|
|
29
|
-
* If provided, the fallback will be sent as MMS. Otherwise, it will be sent as SMS (
|
|
30
|
+
* If provided, the fallback will be sent as MMS. Otherwise, it will be sent as SMS (if text fits within segment limits). At least one of `text` or `mediaUrls` must be provided.
|
|
30
31
|
*/
|
|
31
32
|
mediaUrls?: string[];
|
|
32
33
|
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
export interface LinkSummary {
|
|
2
|
+
/** The full shortened URL (e.g. https://pncl.to/abc123). */
|
|
3
|
+
from: string;
|
|
4
|
+
/** Destination URL that the shortened link redirects to. */
|
|
5
|
+
to: string;
|
|
6
|
+
/** Expiration date in ISO 8601 format, or null if permanent. */
|
|
7
|
+
expiresAt?: string | null;
|
|
8
|
+
/** ISO 8601 timestamp of when the link was created. */
|
|
9
|
+
createdAt: string;
|
|
10
|
+
}
|
|
@@ -19,14 +19,6 @@ export interface Message {
|
|
|
19
19
|
* Null indicates no errors.
|
|
20
20
|
*/
|
|
21
21
|
error: string | null;
|
|
22
|
-
/**
|
|
23
|
-
* The fallback SMS/MMS message configuration for this RCS message.
|
|
24
|
-
*
|
|
25
|
-
* Null indicates no fallback was configured for this message. Only applicable for RCS messages.
|
|
26
|
-
*
|
|
27
|
-
* The original RCS message with have status `FALLBACK_SENT` when the fallback message was sent instead.
|
|
28
|
-
*/
|
|
29
|
-
fallback?: Pinnacle.FallbackMessage | null;
|
|
30
22
|
/** Unique identifier of the message. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`. */
|
|
31
23
|
id: string;
|
|
32
24
|
method: Pinnacle.MessageMethodEnum;
|
|
@@ -12,8 +12,11 @@ export interface MessageEvent {
|
|
|
12
12
|
direction: MessageEvent.Direction;
|
|
13
13
|
/** Number of segments for this message. */
|
|
14
14
|
segments: number;
|
|
15
|
-
/**
|
|
16
|
-
|
|
15
|
+
/**
|
|
16
|
+
* Timestamp when the message was sent in ISO 8601 format.
|
|
17
|
+
* Null if the message has not been sent yet.
|
|
18
|
+
*/
|
|
19
|
+
sentAt: string | null;
|
|
17
20
|
/**
|
|
18
21
|
* Timestamp when the message was delivered in ISO 8601 format.
|
|
19
22
|
* Null if not yet delivered or for inbound messages.
|
|
@@ -21,11 +24,17 @@ export interface MessageEvent {
|
|
|
21
24
|
deliveredAt?: string | null;
|
|
22
25
|
message: Pinnacle.MessageEventContent;
|
|
23
26
|
/**
|
|
24
|
-
*
|
|
27
|
+
* The unique identifier of the original RCS message that this fallback SMS/MMS was sent on behalf of. Always begins with the prefix `msg_`.
|
|
25
28
|
*
|
|
26
|
-
*
|
|
29
|
+
* Only present on webhook events for fallback SMS/MMS messages. Use this to link the fallback back to the RCS message that could not be delivered. The `message.id` field on this event refers to the actual SMS/MMS that was sent — `originalMessageId` refers to the RCS message it replaced.
|
|
27
30
|
*
|
|
28
|
-
*
|
|
31
|
+
* Null when the message is not a fallback.
|
|
32
|
+
*/
|
|
33
|
+
originalMessageId?: string | null;
|
|
34
|
+
/**
|
|
35
|
+
* Details of the fallback SMS/MMS message(s) that were actually sent to the recipient instead of the original RCS message.
|
|
36
|
+
*
|
|
37
|
+
* Only present when the message `status` is `FALLBACK_SENT`. The `message.id` on this event refers to the original RCS message that could not be delivered. The `fallbackMessage.ids` contain the identifiers of the actual SMS/MMS messages that were sent.
|
|
29
38
|
*/
|
|
30
39
|
fallbackMessage?: MessageEvent.FallbackMessage | null;
|
|
31
40
|
}
|
|
@@ -51,19 +60,17 @@ export declare namespace MessageEvent {
|
|
|
51
60
|
};
|
|
52
61
|
type Direction = (typeof Direction)[keyof typeof Direction];
|
|
53
62
|
/**
|
|
54
|
-
* Details of the fallback SMS/MMS message that
|
|
55
|
-
*
|
|
56
|
-
* This field is only present when the message `status` is `FALLBACK_SENT`, indicating the original RCS message could not be delivered and a fallback message was sent instead.
|
|
63
|
+
* Details of the fallback SMS/MMS message(s) that were actually sent to the recipient instead of the original RCS message.
|
|
57
64
|
*
|
|
58
|
-
*
|
|
65
|
+
* Only present when the message `status` is `FALLBACK_SENT`. The `message.id` on this event refers to the original RCS message that could not be delivered. The `fallbackMessage.ids` contain the identifiers of the actual SMS/MMS messages that were sent.
|
|
59
66
|
*/
|
|
60
67
|
interface FallbackMessage {
|
|
61
68
|
/**
|
|
62
|
-
* Unique
|
|
63
|
-
* To get
|
|
69
|
+
* Unique identifiers of the actual SMS/MMS message(s) that were sent as the fallback. Each identifier always begins with the prefix `msg_`. Multiple IDs indicate the fallback was split into multiple SMS/MMS messages. <br><br>
|
|
70
|
+
* These are the messages that were actually delivered to the recipient. To get their full details, use the [GET /messages/{id}](/api-reference/messages/get) endpoint.
|
|
64
71
|
*/
|
|
65
|
-
|
|
66
|
-
/**
|
|
72
|
+
ids: string[];
|
|
73
|
+
/** Delivery protocol of the fallback message that was sent. */
|
|
67
74
|
type: FallbackMessage.Type;
|
|
68
75
|
/** Phone number the fallback message was sent from in E.164 format. */
|
|
69
76
|
from: string;
|
|
@@ -75,7 +82,7 @@ export declare namespace MessageEvent {
|
|
|
75
82
|
mediaUrls?: string[];
|
|
76
83
|
}
|
|
77
84
|
namespace FallbackMessage {
|
|
78
|
-
/**
|
|
85
|
+
/** Delivery protocol of the fallback message that was sent. */
|
|
79
86
|
const Type: {
|
|
80
87
|
readonly Sms: "SMS";
|
|
81
88
|
readonly Mms: "MMS";
|
|
@@ -4,7 +4,7 @@ import type * as Pinnacle from "../index.mjs";
|
|
|
4
4
|
*/
|
|
5
5
|
export interface MessageList {
|
|
6
6
|
/** Array of messages in the conversation. */
|
|
7
|
-
messages: Pinnacle.
|
|
7
|
+
messages: Pinnacle.MessageWithReactions[];
|
|
8
8
|
/** Indicates if more messages are available beyond the current page. */
|
|
9
9
|
hasMore: boolean;
|
|
10
10
|
/** Total number of messages in the conversation. */
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
export interface MessageSummary {
|
|
2
|
+
/** Unique identifier for the message. */
|
|
3
|
+
id: string;
|
|
4
|
+
/** Current status of the message. */
|
|
5
|
+
status: MessageSummary.Status;
|
|
6
|
+
/** Direction of the message. */
|
|
7
|
+
direction: MessageSummary.Direction;
|
|
8
|
+
/** Protocol type of the message. */
|
|
9
|
+
type: MessageSummary.Type;
|
|
10
|
+
/** Method used to send the message. */
|
|
11
|
+
method: MessageSummary.Method;
|
|
12
|
+
/** Number of segments in the message. */
|
|
13
|
+
numSegments: number;
|
|
14
|
+
/** Cost of the message. */
|
|
15
|
+
cost: number | null;
|
|
16
|
+
/** Sender phone number (E.164) or RCS agent ID. */
|
|
17
|
+
from: string | null;
|
|
18
|
+
/** Recipient phone number in E.164 format. */
|
|
19
|
+
to: string | null;
|
|
20
|
+
/** Message content (SMS text, MMS media, or RCS rich content). */
|
|
21
|
+
content: Record<string, unknown>;
|
|
22
|
+
/** Error details if the message failed. */
|
|
23
|
+
error: Record<string, unknown> | null;
|
|
24
|
+
/** Whether this is a test message. */
|
|
25
|
+
isTest: boolean;
|
|
26
|
+
/** ID of the blast this message belongs to, if any. */
|
|
27
|
+
blastId: string | null;
|
|
28
|
+
/** ISO 8601 timestamp of when the message was sent. */
|
|
29
|
+
sentAt: string | null;
|
|
30
|
+
/** ISO 8601 timestamp of when the message was delivered. */
|
|
31
|
+
deliveredAt: string | null;
|
|
32
|
+
/** ISO 8601 timestamp of when the message was created. */
|
|
33
|
+
createdAt: string;
|
|
34
|
+
/** ISO 8601 timestamp of when the message was last updated. */
|
|
35
|
+
updatedAt: string;
|
|
36
|
+
}
|
|
37
|
+
export declare namespace MessageSummary {
|
|
38
|
+
/** Current status of the message. */
|
|
39
|
+
const Status: {
|
|
40
|
+
readonly Pending: "PENDING";
|
|
41
|
+
readonly Sent: "SENT";
|
|
42
|
+
readonly SendFailed: "SEND_FAILED";
|
|
43
|
+
readonly Delivered: "DELIVERED";
|
|
44
|
+
readonly DeliveryFailed: "DELIVERY_FAILED";
|
|
45
|
+
readonly Received: "RECEIVED";
|
|
46
|
+
readonly Read: "READ";
|
|
47
|
+
readonly Queued: "QUEUED";
|
|
48
|
+
readonly FallbackSent: "FALLBACK_SENT";
|
|
49
|
+
};
|
|
50
|
+
type Status = (typeof Status)[keyof typeof Status];
|
|
51
|
+
/** Direction of the message. */
|
|
52
|
+
const Direction: {
|
|
53
|
+
readonly Inbound: "INBOUND";
|
|
54
|
+
readonly Outbound: "OUTBOUND";
|
|
55
|
+
};
|
|
56
|
+
type Direction = (typeof Direction)[keyof typeof Direction];
|
|
57
|
+
/** Protocol type of the message. */
|
|
58
|
+
const Type: {
|
|
59
|
+
readonly Sms: "SMS";
|
|
60
|
+
readonly Mms: "MMS";
|
|
61
|
+
readonly Rcs: "RCS";
|
|
62
|
+
};
|
|
63
|
+
type Type = (typeof Type)[keyof typeof Type];
|
|
64
|
+
/** Method used to send the message. */
|
|
65
|
+
const Method: {
|
|
66
|
+
readonly Api: "API";
|
|
67
|
+
readonly Sdk: "SDK";
|
|
68
|
+
readonly Other: "OTHER";
|
|
69
|
+
};
|
|
70
|
+
type Method = (typeof Method)[keyof typeof Method];
|
|
71
|
+
}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
export var MessageSummary;
|
|
3
|
+
(function (MessageSummary) {
|
|
4
|
+
/** Current status of the message. */
|
|
5
|
+
MessageSummary.Status = {
|
|
6
|
+
Pending: "PENDING",
|
|
7
|
+
Sent: "SENT",
|
|
8
|
+
SendFailed: "SEND_FAILED",
|
|
9
|
+
Delivered: "DELIVERED",
|
|
10
|
+
DeliveryFailed: "DELIVERY_FAILED",
|
|
11
|
+
Received: "RECEIVED",
|
|
12
|
+
Read: "READ",
|
|
13
|
+
Queued: "QUEUED",
|
|
14
|
+
FallbackSent: "FALLBACK_SENT",
|
|
15
|
+
};
|
|
16
|
+
/** Direction of the message. */
|
|
17
|
+
MessageSummary.Direction = {
|
|
18
|
+
Inbound: "INBOUND",
|
|
19
|
+
Outbound: "OUTBOUND",
|
|
20
|
+
};
|
|
21
|
+
/** Protocol type of the message. */
|
|
22
|
+
MessageSummary.Type = {
|
|
23
|
+
Sms: "SMS",
|
|
24
|
+
Mms: "MMS",
|
|
25
|
+
Rcs: "RCS",
|
|
26
|
+
};
|
|
27
|
+
/** Method used to send the message. */
|
|
28
|
+
MessageSummary.Method = {
|
|
29
|
+
Api: "API",
|
|
30
|
+
Sdk: "SDK",
|
|
31
|
+
Other: "OTHER",
|
|
32
|
+
};
|
|
33
|
+
})(MessageSummary || (MessageSummary = {}));
|
|
@@ -1,18 +1,18 @@
|
|
|
1
1
|
import type * as Pinnacle from "../index.mjs";
|
|
2
2
|
/**
|
|
3
|
-
* Message with additional conversation-specific fields including direction and
|
|
3
|
+
* Message with additional conversation-specific fields including direction and reactions.
|
|
4
4
|
*/
|
|
5
|
-
export interface
|
|
5
|
+
export interface MessageWithReactions extends Pinnacle.Message {
|
|
6
6
|
/** Direction of the message flow. */
|
|
7
|
-
direction:
|
|
7
|
+
direction: MessageWithReactions.Direction;
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
9
|
+
* Array of unicode emoji reactions attached to this message. <br>
|
|
10
10
|
*
|
|
11
|
-
*
|
|
11
|
+
* Empty array indicates no reactions have been added.
|
|
12
12
|
*/
|
|
13
|
-
|
|
13
|
+
reactions: string[];
|
|
14
14
|
}
|
|
15
|
-
export declare namespace
|
|
15
|
+
export declare namespace MessageWithReactions {
|
|
16
16
|
/** Direction of the message flow. */
|
|
17
17
|
const Direction: {
|
|
18
18
|
readonly Inbound: "INBOUND";
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
-
export var
|
|
3
|
-
(function (
|
|
2
|
+
export var MessageWithReactions;
|
|
3
|
+
(function (MessageWithReactions) {
|
|
4
4
|
/** Direction of the message flow. */
|
|
5
|
-
|
|
5
|
+
MessageWithReactions.Direction = {
|
|
6
6
|
Inbound: "INBOUND",
|
|
7
7
|
Outbound: "OUTBOUND",
|
|
8
8
|
};
|
|
9
|
-
})(
|
|
9
|
+
})(MessageWithReactions || (MessageWithReactions = {}));
|