rcs-js 2.0.13 → 2.0.14-rc.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/Client.js +2 -2
- package/dist/cjs/api/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 +21 -12
- package/dist/cjs/api/resources/campaigns/resources/rcs/client/Client.js +76 -12
- 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/UpsertRcsCampaignParams.d.ts +12 -32
- 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/ExtendedRcsCampaign.d.ts +6 -20
- 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/RcsCampaign.d.ts +6 -20
- package/dist/cjs/api/types/RcsCampaignSummary.d.ts +26 -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 -3
- package/dist/cjs/api/types/index.js +40 -3
- 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 +21 -12
- package/dist/esm/api/resources/campaigns/resources/rcs/client/Client.mjs +76 -12
- 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/UpsertRcsCampaignParams.d.mts +12 -32
- 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/ExtendedRcsCampaign.d.mts +6 -20
- 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/RcsCampaign.d.mts +6 -20
- package/dist/esm/api/types/RcsCampaignSummary.d.mts +26 -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 -3
- package/dist/esm/api/types/index.mjs +40 -3
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +2 -2
- package/reference.md +1414 -162
- package/dist/cjs/api/resources/rcs/client/requests/RcsWhitelistRequest.d.ts +0 -13
- package/dist/cjs/api/types/RcsCampaignUseCaseEnum.d.ts +0 -37
- package/dist/cjs/api/types/RcsCampaignUseCaseEnum.js +0 -40
- 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/RcsCampaignUseCaseEnum.d.mts +0 -37
- package/dist/esm/api/types/RcsCampaignUseCaseEnum.mjs +0 -37
- 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
package/dist/cjs/Client.js
CHANGED
|
@@ -53,8 +53,8 @@ class PinnacleClient {
|
|
|
53
53
|
this._options = Object.assign(Object.assign({}, _options), { logging: core.logging.createLogger(_options === null || _options === void 0 ? void 0 : _options.logging), headers: (0, headers_js_1.mergeHeaders)({
|
|
54
54
|
"X-Fern-Language": "JavaScript",
|
|
55
55
|
"X-Fern-SDK-Name": "rcs-js",
|
|
56
|
-
"X-Fern-SDK-Version": "2.0.
|
|
57
|
-
"User-Agent": "rcs-js/2.0.
|
|
56
|
+
"X-Fern-SDK-Version": "2.0.14-rc.1",
|
|
57
|
+
"User-Agent": "rcs-js/2.0.14-rc.1",
|
|
58
58
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
59
59
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
60
60
|
}, _options === null || _options === void 0 ? void 0 : _options.headers) });
|
|
@@ -108,5 +108,20 @@ export declare class Audiences {
|
|
|
108
108
|
*/
|
|
109
109
|
update(request: Pinnacle.UpdateAudienceParams, requestOptions?: Audiences.RequestOptions): core.HttpResponsePromise<Pinnacle.AudienceCountOnly>;
|
|
110
110
|
private __update;
|
|
111
|
+
/**
|
|
112
|
+
* List all audiences with optional filtering and pagination. Results are sorted by creation date, newest first.
|
|
113
|
+
*
|
|
114
|
+
* @param {Pinnacle.ListAudiencesParams} request
|
|
115
|
+
* @param {Audiences.RequestOptions} requestOptions - Request-specific configuration.
|
|
116
|
+
*
|
|
117
|
+
* @throws {@link Pinnacle.BadRequestError}
|
|
118
|
+
* @throws {@link Pinnacle.UnauthorizedError}
|
|
119
|
+
* @throws {@link Pinnacle.InternalServerError}
|
|
120
|
+
*
|
|
121
|
+
* @example
|
|
122
|
+
* await client.audiences.list()
|
|
123
|
+
*/
|
|
124
|
+
list(request?: Pinnacle.ListAudiencesParams, requestOptions?: Audiences.RequestOptions): core.HttpResponsePromise<Pinnacle.ListAudiencesResponse>;
|
|
125
|
+
private __list;
|
|
111
126
|
protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | undefined>>;
|
|
112
127
|
}
|
|
@@ -393,6 +393,76 @@ class Audiences {
|
|
|
393
393
|
}
|
|
394
394
|
});
|
|
395
395
|
}
|
|
396
|
+
/**
|
|
397
|
+
* List all audiences with optional filtering and pagination. Results are sorted by creation date, newest first.
|
|
398
|
+
*
|
|
399
|
+
* @param {Pinnacle.ListAudiencesParams} request
|
|
400
|
+
* @param {Audiences.RequestOptions} requestOptions - Request-specific configuration.
|
|
401
|
+
*
|
|
402
|
+
* @throws {@link Pinnacle.BadRequestError}
|
|
403
|
+
* @throws {@link Pinnacle.UnauthorizedError}
|
|
404
|
+
* @throws {@link Pinnacle.InternalServerError}
|
|
405
|
+
*
|
|
406
|
+
* @example
|
|
407
|
+
* await client.audiences.list()
|
|
408
|
+
*/
|
|
409
|
+
list(request = {}, requestOptions) {
|
|
410
|
+
return core.HttpResponsePromise.fromPromise(this.__list(request, requestOptions));
|
|
411
|
+
}
|
|
412
|
+
__list() {
|
|
413
|
+
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
414
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
415
|
+
const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
416
|
+
const _response = yield core.fetcher({
|
|
417
|
+
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PinnacleEnvironment.Default, "audiences/list"),
|
|
418
|
+
method: "POST",
|
|
419
|
+
headers: _headers,
|
|
420
|
+
contentType: "application/json",
|
|
421
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
422
|
+
requestType: "json",
|
|
423
|
+
body: request,
|
|
424
|
+
timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
|
|
425
|
+
maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
|
|
426
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
427
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
428
|
+
logging: this._options.logging,
|
|
429
|
+
});
|
|
430
|
+
if (_response.ok) {
|
|
431
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
432
|
+
}
|
|
433
|
+
if (_response.error.reason === "status-code") {
|
|
434
|
+
switch (_response.error.statusCode) {
|
|
435
|
+
case 400:
|
|
436
|
+
throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
|
|
437
|
+
case 401:
|
|
438
|
+
throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
439
|
+
case 500:
|
|
440
|
+
throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
|
|
441
|
+
default:
|
|
442
|
+
throw new errors.PinnacleError({
|
|
443
|
+
statusCode: _response.error.statusCode,
|
|
444
|
+
body: _response.error.body,
|
|
445
|
+
rawResponse: _response.rawResponse,
|
|
446
|
+
});
|
|
447
|
+
}
|
|
448
|
+
}
|
|
449
|
+
switch (_response.error.reason) {
|
|
450
|
+
case "non-json":
|
|
451
|
+
throw new errors.PinnacleError({
|
|
452
|
+
statusCode: _response.error.statusCode,
|
|
453
|
+
body: _response.error.rawBody,
|
|
454
|
+
rawResponse: _response.rawResponse,
|
|
455
|
+
});
|
|
456
|
+
case "timeout":
|
|
457
|
+
throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /audiences/list.");
|
|
458
|
+
case "unknown":
|
|
459
|
+
throw new errors.PinnacleError({
|
|
460
|
+
message: _response.error.errorMessage,
|
|
461
|
+
rawResponse: _response.rawResponse,
|
|
462
|
+
});
|
|
463
|
+
}
|
|
464
|
+
});
|
|
465
|
+
}
|
|
396
466
|
_getCustomAuthorizationHeaders() {
|
|
397
467
|
return __awaiter(this, void 0, void 0, function* () {
|
|
398
468
|
const apiKeyValue = yield core.Supplier.get(this._options.apiKey);
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
export type { AudiencesDeleteRequest } from "./AudiencesDeleteRequest.js";
|
|
2
2
|
export type { AudiencesGetRequest } from "./AudiencesGetRequest.js";
|
|
3
3
|
export type { CreateAudienceParams } from "./CreateAudienceParams.js";
|
|
4
|
+
export type { ListAudiencesParams } from "./ListAudiencesParams.js";
|
|
4
5
|
export type { UpdateAudienceParams } from "./UpdateAudienceParams.js";
|
|
@@ -150,5 +150,20 @@ export declare class Brands {
|
|
|
150
150
|
*/
|
|
151
151
|
vet(brandId: string, request: Pinnacle.VetBrandParams, requestOptions?: Brands.RequestOptions): core.HttpResponsePromise<Pinnacle.VettingResults>;
|
|
152
152
|
private __vet;
|
|
153
|
+
/**
|
|
154
|
+
* List all brands with optional filtering and pagination. Results are sorted by creation date, newest first.
|
|
155
|
+
*
|
|
156
|
+
* @param {Pinnacle.ListBrandsParams} request
|
|
157
|
+
* @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
|
|
158
|
+
*
|
|
159
|
+
* @throws {@link Pinnacle.BadRequestError}
|
|
160
|
+
* @throws {@link Pinnacle.UnauthorizedError}
|
|
161
|
+
* @throws {@link Pinnacle.InternalServerError}
|
|
162
|
+
*
|
|
163
|
+
* @example
|
|
164
|
+
* await client.brands.list()
|
|
165
|
+
*/
|
|
166
|
+
list(request?: Pinnacle.ListBrandsParams, requestOptions?: Brands.RequestOptions): core.HttpResponsePromise<Pinnacle.ListBrandsResponse>;
|
|
167
|
+
private __list;
|
|
153
168
|
protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | undefined>>;
|
|
154
169
|
}
|
|
@@ -548,6 +548,76 @@ class Brands {
|
|
|
548
548
|
}
|
|
549
549
|
});
|
|
550
550
|
}
|
|
551
|
+
/**
|
|
552
|
+
* List all brands with optional filtering and pagination. Results are sorted by creation date, newest first.
|
|
553
|
+
*
|
|
554
|
+
* @param {Pinnacle.ListBrandsParams} request
|
|
555
|
+
* @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
|
|
556
|
+
*
|
|
557
|
+
* @throws {@link Pinnacle.BadRequestError}
|
|
558
|
+
* @throws {@link Pinnacle.UnauthorizedError}
|
|
559
|
+
* @throws {@link Pinnacle.InternalServerError}
|
|
560
|
+
*
|
|
561
|
+
* @example
|
|
562
|
+
* await client.brands.list()
|
|
563
|
+
*/
|
|
564
|
+
list(request = {}, requestOptions) {
|
|
565
|
+
return core.HttpResponsePromise.fromPromise(this.__list(request, requestOptions));
|
|
566
|
+
}
|
|
567
|
+
__list() {
|
|
568
|
+
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
569
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
570
|
+
const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
571
|
+
const _response = yield core.fetcher({
|
|
572
|
+
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PinnacleEnvironment.Default, "brands/list"),
|
|
573
|
+
method: "POST",
|
|
574
|
+
headers: _headers,
|
|
575
|
+
contentType: "application/json",
|
|
576
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
577
|
+
requestType: "json",
|
|
578
|
+
body: request,
|
|
579
|
+
timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
|
|
580
|
+
maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
|
|
581
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
582
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
583
|
+
logging: this._options.logging,
|
|
584
|
+
});
|
|
585
|
+
if (_response.ok) {
|
|
586
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
587
|
+
}
|
|
588
|
+
if (_response.error.reason === "status-code") {
|
|
589
|
+
switch (_response.error.statusCode) {
|
|
590
|
+
case 400:
|
|
591
|
+
throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
|
|
592
|
+
case 401:
|
|
593
|
+
throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
594
|
+
case 500:
|
|
595
|
+
throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
|
|
596
|
+
default:
|
|
597
|
+
throw new errors.PinnacleError({
|
|
598
|
+
statusCode: _response.error.statusCode,
|
|
599
|
+
body: _response.error.body,
|
|
600
|
+
rawResponse: _response.rawResponse,
|
|
601
|
+
});
|
|
602
|
+
}
|
|
603
|
+
}
|
|
604
|
+
switch (_response.error.reason) {
|
|
605
|
+
case "non-json":
|
|
606
|
+
throw new errors.PinnacleError({
|
|
607
|
+
statusCode: _response.error.statusCode,
|
|
608
|
+
body: _response.error.rawBody,
|
|
609
|
+
rawResponse: _response.rawResponse,
|
|
610
|
+
});
|
|
611
|
+
case "timeout":
|
|
612
|
+
throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /brands/list.");
|
|
613
|
+
case "unknown":
|
|
614
|
+
throw new errors.PinnacleError({
|
|
615
|
+
message: _response.error.errorMessage,
|
|
616
|
+
rawResponse: _response.rawResponse,
|
|
617
|
+
});
|
|
618
|
+
}
|
|
619
|
+
});
|
|
620
|
+
}
|
|
551
621
|
_getCustomAuthorizationHeaders() {
|
|
552
622
|
return __awaiter(this, void 0, void 0, function* () {
|
|
553
623
|
const apiKeyValue = yield core.Supplier.get(this._options.apiKey);
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {}
|
|
4
|
+
*/
|
|
5
|
+
export interface ListBrandsParams {
|
|
6
|
+
pageIndex?: number;
|
|
7
|
+
pageSize?: number;
|
|
8
|
+
status?: ListBrandsParams.Status;
|
|
9
|
+
isArchived?: boolean;
|
|
10
|
+
/** Case-insensitive substring search on brand name. */
|
|
11
|
+
name?: string;
|
|
12
|
+
}
|
|
13
|
+
export declare namespace ListBrandsParams {
|
|
14
|
+
const Status: {
|
|
15
|
+
readonly Pending: "PENDING";
|
|
16
|
+
readonly Unverified: "UNVERIFIED";
|
|
17
|
+
readonly Verified: "VERIFIED";
|
|
18
|
+
readonly Vetted: "VETTED";
|
|
19
|
+
readonly Failed: "FAILED";
|
|
20
|
+
readonly Incomplete: "INCOMPLETE";
|
|
21
|
+
};
|
|
22
|
+
type Status = (typeof Status)[keyof typeof Status];
|
|
23
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.ListBrandsParams = void 0;
|
|
5
|
+
var ListBrandsParams;
|
|
6
|
+
(function (ListBrandsParams) {
|
|
7
|
+
ListBrandsParams.Status = {
|
|
8
|
+
Pending: "PENDING",
|
|
9
|
+
Unverified: "UNVERIFIED",
|
|
10
|
+
Verified: "VERIFIED",
|
|
11
|
+
Vetted: "VETTED",
|
|
12
|
+
Failed: "FAILED",
|
|
13
|
+
Incomplete: "INCOMPLETE",
|
|
14
|
+
};
|
|
15
|
+
})(ListBrandsParams || (exports.ListBrandsParams = ListBrandsParams = {}));
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
export type { AutofillBrandParams } from "./AutofillBrandParams.js";
|
|
2
2
|
export type { BrandsGetRequest } from "./BrandsGetRequest.js";
|
|
3
|
+
export type { ListBrandsParams } from "./ListBrandsParams.js";
|
|
3
4
|
export type { UpsertBrandParams } from "./UpsertBrandParams.js";
|
|
4
5
|
export type { VetBrandParams } from "./VetBrandParams.js";
|
|
@@ -147,5 +147,20 @@ export declare class Dlc {
|
|
|
147
147
|
*/
|
|
148
148
|
validate(request: Pinnacle.ValidateCampaignParams, requestOptions?: Dlc.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignValidationResult>;
|
|
149
149
|
private __validate;
|
|
150
|
+
/**
|
|
151
|
+
* List all 10DLC campaigns with optional filtering and pagination. Results are sorted by creation date, newest first.
|
|
152
|
+
*
|
|
153
|
+
* @param {Pinnacle.campaigns.ListDlcCampaignsParams} request
|
|
154
|
+
* @param {Dlc.RequestOptions} requestOptions - Request-specific configuration.
|
|
155
|
+
*
|
|
156
|
+
* @throws {@link Pinnacle.BadRequestError}
|
|
157
|
+
* @throws {@link Pinnacle.UnauthorizedError}
|
|
158
|
+
* @throws {@link Pinnacle.InternalServerError}
|
|
159
|
+
*
|
|
160
|
+
* @example
|
|
161
|
+
* await client.campaigns.dlc.list()
|
|
162
|
+
*/
|
|
163
|
+
list(request?: Pinnacle.campaigns.ListDlcCampaignsParams, requestOptions?: Dlc.RequestOptions): core.HttpResponsePromise<Pinnacle.ListDlcCampaignsResponse>;
|
|
164
|
+
private __list;
|
|
150
165
|
protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | undefined>>;
|
|
151
166
|
}
|
|
@@ -481,6 +481,76 @@ class Dlc {
|
|
|
481
481
|
}
|
|
482
482
|
});
|
|
483
483
|
}
|
|
484
|
+
/**
|
|
485
|
+
* List all 10DLC campaigns with optional filtering and pagination. Results are sorted by creation date, newest first.
|
|
486
|
+
*
|
|
487
|
+
* @param {Pinnacle.campaigns.ListDlcCampaignsParams} request
|
|
488
|
+
* @param {Dlc.RequestOptions} requestOptions - Request-specific configuration.
|
|
489
|
+
*
|
|
490
|
+
* @throws {@link Pinnacle.BadRequestError}
|
|
491
|
+
* @throws {@link Pinnacle.UnauthorizedError}
|
|
492
|
+
* @throws {@link Pinnacle.InternalServerError}
|
|
493
|
+
*
|
|
494
|
+
* @example
|
|
495
|
+
* await client.campaigns.dlc.list()
|
|
496
|
+
*/
|
|
497
|
+
list(request = {}, requestOptions) {
|
|
498
|
+
return core.HttpResponsePromise.fromPromise(this.__list(request, requestOptions));
|
|
499
|
+
}
|
|
500
|
+
__list() {
|
|
501
|
+
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
502
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
503
|
+
const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
504
|
+
const _response = yield core.fetcher({
|
|
505
|
+
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PinnacleEnvironment.Default, "campaigns/dlc/list"),
|
|
506
|
+
method: "POST",
|
|
507
|
+
headers: _headers,
|
|
508
|
+
contentType: "application/json",
|
|
509
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
510
|
+
requestType: "json",
|
|
511
|
+
body: request,
|
|
512
|
+
timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
|
|
513
|
+
maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
|
|
514
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
515
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
516
|
+
logging: this._options.logging,
|
|
517
|
+
});
|
|
518
|
+
if (_response.ok) {
|
|
519
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
520
|
+
}
|
|
521
|
+
if (_response.error.reason === "status-code") {
|
|
522
|
+
switch (_response.error.statusCode) {
|
|
523
|
+
case 400:
|
|
524
|
+
throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
|
|
525
|
+
case 401:
|
|
526
|
+
throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
527
|
+
case 500:
|
|
528
|
+
throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
|
|
529
|
+
default:
|
|
530
|
+
throw new errors.PinnacleError({
|
|
531
|
+
statusCode: _response.error.statusCode,
|
|
532
|
+
body: _response.error.body,
|
|
533
|
+
rawResponse: _response.rawResponse,
|
|
534
|
+
});
|
|
535
|
+
}
|
|
536
|
+
}
|
|
537
|
+
switch (_response.error.reason) {
|
|
538
|
+
case "non-json":
|
|
539
|
+
throw new errors.PinnacleError({
|
|
540
|
+
statusCode: _response.error.statusCode,
|
|
541
|
+
body: _response.error.rawBody,
|
|
542
|
+
rawResponse: _response.rawResponse,
|
|
543
|
+
});
|
|
544
|
+
case "timeout":
|
|
545
|
+
throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /campaigns/dlc/list.");
|
|
546
|
+
case "unknown":
|
|
547
|
+
throw new errors.PinnacleError({
|
|
548
|
+
message: _response.error.errorMessage,
|
|
549
|
+
rawResponse: _response.rawResponse,
|
|
550
|
+
});
|
|
551
|
+
}
|
|
552
|
+
});
|
|
553
|
+
}
|
|
484
554
|
_getCustomAuthorizationHeaders() {
|
|
485
555
|
return __awaiter(this, void 0, void 0, function* () {
|
|
486
556
|
const apiKeyValue = yield core.Supplier.get(this._options.apiKey);
|
package/dist/cjs/api/resources/campaigns/resources/dlc/client/requests/ListDlcCampaignsParams.d.ts
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {}
|
|
4
|
+
*/
|
|
5
|
+
export interface ListDlcCampaignsParams {
|
|
6
|
+
pageIndex?: number;
|
|
7
|
+
pageSize?: number;
|
|
8
|
+
status?: ListDlcCampaignsParams.Status;
|
|
9
|
+
brandId?: string;
|
|
10
|
+
/** Filter by campaign name (partial match, case-insensitive). */
|
|
11
|
+
name?: string;
|
|
12
|
+
}
|
|
13
|
+
export declare namespace ListDlcCampaignsParams {
|
|
14
|
+
const Status: {
|
|
15
|
+
readonly Incomplete: "INCOMPLETE";
|
|
16
|
+
readonly InReview: "IN REVIEW";
|
|
17
|
+
readonly Verified: "VERIFIED";
|
|
18
|
+
readonly Failed: "FAILED";
|
|
19
|
+
};
|
|
20
|
+
type Status = (typeof Status)[keyof typeof Status];
|
|
21
|
+
}
|
package/dist/cjs/api/resources/campaigns/resources/dlc/client/requests/ListDlcCampaignsParams.js
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.ListDlcCampaignsParams = void 0;
|
|
5
|
+
var ListDlcCampaignsParams;
|
|
6
|
+
(function (ListDlcCampaignsParams) {
|
|
7
|
+
ListDlcCampaignsParams.Status = {
|
|
8
|
+
Incomplete: "INCOMPLETE",
|
|
9
|
+
InReview: "IN REVIEW",
|
|
10
|
+
Verified: "VERIFIED",
|
|
11
|
+
Failed: "FAILED",
|
|
12
|
+
};
|
|
13
|
+
})(ListDlcCampaignsParams || (exports.ListDlcCampaignsParams = ListDlcCampaignsParams = {}));
|
|
@@ -109,16 +109,13 @@ export declare class Rcs {
|
|
|
109
109
|
* campaignId: "rcs_1234567890",
|
|
110
110
|
* expectedAgentResponses: ["Here are the things I can help you with.", "I can assist you with booking an appointment, or you may choose to book manually.", "Here are the available times to connect with a representative tomorrow.", "Your appointment has been scheduled."],
|
|
111
111
|
* links: {
|
|
112
|
-
* privacyPolicy: "
|
|
113
|
-
* termsOfService: "
|
|
112
|
+
* privacyPolicy: "\u201Chttps://www.trypinnacle.app/privacy\u201D",
|
|
113
|
+
* termsOfService: "\u201Chttps://www.trypinnacle.app/terms\u201D"
|
|
114
114
|
* },
|
|
115
|
-
*
|
|
116
|
-
*
|
|
117
|
-
*
|
|
118
|
-
*
|
|
119
|
-
* optInTermsAndConditions: "We ensure consent through an explicit opt-in process that follows 10DLC best practices.Users must agree to receive messages from Pinnacle before the agent sends them any messages.<br>\nUsers agree to these messages by signing an opt-in paper form that they can be found online at https://www.pinnacle.sh/opt-in. We only send messages once users have filled out the form and submitted it to us via email or through the dashboard.\n",
|
|
120
|
-
* messagingType: "MULTI_USE",
|
|
121
|
-
* carrierDescription: "Demonstrate the power of RCS to medium and large companies already sending massive SMS/MMS volumes through our platform. These clients send conversational messages in industries such as commerce, appointments, and customer support.",
|
|
115
|
+
* useCaseDescription: "Pinnacle is a developer-focused RCS assistant that helps teams design, test, and optimize rich messaging experiences across SMS, MMS, and RCS. The agent acts as both an \u201Conboarding guide\u201D for new customers and a \u201Cbest-practices coach\u201D for existing teams exploring higher-value RCS workflows like rich cards, carousels, and suggested actions.<br>\nThe agent delivers a mix of operational updates and educational content (2\u20136 messages/month). Content includes important platform notices (e.g., deliverability or throughput changes), implementation tips with sample RCS templates, and personalized recommendations on how to upgrade existing SMS campaigns into richer, higher-converting RCS conversations.\n",
|
|
116
|
+
* messagingType: "OTP",
|
|
117
|
+
* ctaMedia: "\u201Chttps://www.pinnacle.sh/send\u201D",
|
|
118
|
+
* optInMethod: "We ensure consent through an explicit opt-in process that follows 10DLC best practices.Users must agree to receive messages from Pinnacle before the agent sends them any messages.<br>\nUsers agree to these messages by signing an opt-in paper form that they can be found online at https://www.pinnacle.sh/opt-in. We only send messages once users have filled out the form and submitted it to us via email or through the dashboard.\n",
|
|
122
119
|
* keywords: {
|
|
123
120
|
* HELP: {
|
|
124
121
|
* message: "Email founders@trypinnacle.app for support.",
|
|
@@ -137,9 +134,6 @@ export declare class Rcs {
|
|
|
137
134
|
* monthlyWebsite: 10000,
|
|
138
135
|
* monthlyRcsEstimate: 10000
|
|
139
136
|
* },
|
|
140
|
-
* agentTriggers: "The agent sends the first message when the user subscribes to Pinnacle. Messages are based on user actions such as pressing suggestion buttons. External triggers such as reminders can be setup by users in advance for a later time.",
|
|
141
|
-
* interactionDescription: "The agent's primary interaction will be customer service \u2014 helping users with questions, troubleshooting issues, and providing quick assistance through chat. Other interactions include appointment management and sending notifications to the user.",
|
|
142
|
-
* isConversational: true,
|
|
143
137
|
* ctaLanguage: "By checking this box and submitting this form, you consent to receive transactional text messages for support, appointment, and reminder messages from Pinnacle Software Development Inc. Reply STOP to opt out. Reply HELP for help. Standard message and data rates may apply. Message frequency may vary. View our Terms and Conditions at https://www.pinnacle.sh/terms. View our Privacy Policy at https://www.pinnacle.sh/privacy.",
|
|
144
138
|
* demoTrigger: "Text \"START\" to trigger the flow."
|
|
145
139
|
* })
|
|
@@ -165,5 +159,20 @@ export declare class Rcs {
|
|
|
165
159
|
*/
|
|
166
160
|
validate(request: Pinnacle.ValidateCampaignParams, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignValidationResult>;
|
|
167
161
|
private __validate;
|
|
162
|
+
/**
|
|
163
|
+
* List all RCS campaigns with optional filtering and pagination. Results are sorted by creation date, newest first.
|
|
164
|
+
*
|
|
165
|
+
* @param {Pinnacle.campaigns.ListRcsCampaignsParams} request
|
|
166
|
+
* @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
|
|
167
|
+
*
|
|
168
|
+
* @throws {@link Pinnacle.BadRequestError}
|
|
169
|
+
* @throws {@link Pinnacle.UnauthorizedError}
|
|
170
|
+
* @throws {@link Pinnacle.InternalServerError}
|
|
171
|
+
*
|
|
172
|
+
* @example
|
|
173
|
+
* await client.campaigns.rcs.list()
|
|
174
|
+
*/
|
|
175
|
+
list(request?: Pinnacle.campaigns.ListRcsCampaignsParams, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.ListRcsCampaignsResponse>;
|
|
176
|
+
private __list;
|
|
168
177
|
protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | undefined>>;
|
|
169
178
|
}
|
|
@@ -326,16 +326,13 @@ class Rcs {
|
|
|
326
326
|
* campaignId: "rcs_1234567890",
|
|
327
327
|
* expectedAgentResponses: ["Here are the things I can help you with.", "I can assist you with booking an appointment, or you may choose to book manually.", "Here are the available times to connect with a representative tomorrow.", "Your appointment has been scheduled."],
|
|
328
328
|
* links: {
|
|
329
|
-
* privacyPolicy: "
|
|
330
|
-
* termsOfService: "
|
|
329
|
+
* privacyPolicy: "\u201Chttps://www.trypinnacle.app/privacy\u201D",
|
|
330
|
+
* termsOfService: "\u201Chttps://www.trypinnacle.app/terms\u201D"
|
|
331
331
|
* },
|
|
332
|
-
*
|
|
333
|
-
*
|
|
334
|
-
*
|
|
335
|
-
*
|
|
336
|
-
* optInTermsAndConditions: "We ensure consent through an explicit opt-in process that follows 10DLC best practices.Users must agree to receive messages from Pinnacle before the agent sends them any messages.<br>\nUsers agree to these messages by signing an opt-in paper form that they can be found online at https://www.pinnacle.sh/opt-in. We only send messages once users have filled out the form and submitted it to us via email or through the dashboard.\n",
|
|
337
|
-
* messagingType: "MULTI_USE",
|
|
338
|
-
* carrierDescription: "Demonstrate the power of RCS to medium and large companies already sending massive SMS/MMS volumes through our platform. These clients send conversational messages in industries such as commerce, appointments, and customer support.",
|
|
332
|
+
* useCaseDescription: "Pinnacle is a developer-focused RCS assistant that helps teams design, test, and optimize rich messaging experiences across SMS, MMS, and RCS. The agent acts as both an \u201Conboarding guide\u201D for new customers and a \u201Cbest-practices coach\u201D for existing teams exploring higher-value RCS workflows like rich cards, carousels, and suggested actions.<br>\nThe agent delivers a mix of operational updates and educational content (2\u20136 messages/month). Content includes important platform notices (e.g., deliverability or throughput changes), implementation tips with sample RCS templates, and personalized recommendations on how to upgrade existing SMS campaigns into richer, higher-converting RCS conversations.\n",
|
|
333
|
+
* messagingType: "OTP",
|
|
334
|
+
* ctaMedia: "\u201Chttps://www.pinnacle.sh/send\u201D",
|
|
335
|
+
* optInMethod: "We ensure consent through an explicit opt-in process that follows 10DLC best practices.Users must agree to receive messages from Pinnacle before the agent sends them any messages.<br>\nUsers agree to these messages by signing an opt-in paper form that they can be found online at https://www.pinnacle.sh/opt-in. We only send messages once users have filled out the form and submitted it to us via email or through the dashboard.\n",
|
|
339
336
|
* keywords: {
|
|
340
337
|
* HELP: {
|
|
341
338
|
* message: "Email founders@trypinnacle.app for support.",
|
|
@@ -354,9 +351,6 @@ class Rcs {
|
|
|
354
351
|
* monthlyWebsite: 10000,
|
|
355
352
|
* monthlyRcsEstimate: 10000
|
|
356
353
|
* },
|
|
357
|
-
* agentTriggers: "The agent sends the first message when the user subscribes to Pinnacle. Messages are based on user actions such as pressing suggestion buttons. External triggers such as reminders can be setup by users in advance for a later time.",
|
|
358
|
-
* interactionDescription: "The agent's primary interaction will be customer service \u2014 helping users with questions, troubleshooting issues, and providing quick assistance through chat. Other interactions include appointment management and sending notifications to the user.",
|
|
359
|
-
* isConversational: true,
|
|
360
354
|
* ctaLanguage: "By checking this box and submitting this form, you consent to receive transactional text messages for support, appointment, and reminder messages from Pinnacle Software Development Inc. Reply STOP to opt out. Reply HELP for help. Standard message and data rates may apply. Message frequency may vary. View our Terms and Conditions at https://www.pinnacle.sh/terms. View our Privacy Policy at https://www.pinnacle.sh/privacy.",
|
|
361
355
|
* demoTrigger: "Text \"START\" to trigger the flow."
|
|
362
356
|
* })
|
|
@@ -498,6 +492,76 @@ class Rcs {
|
|
|
498
492
|
}
|
|
499
493
|
});
|
|
500
494
|
}
|
|
495
|
+
/**
|
|
496
|
+
* List all RCS campaigns with optional filtering and pagination. Results are sorted by creation date, newest first.
|
|
497
|
+
*
|
|
498
|
+
* @param {Pinnacle.campaigns.ListRcsCampaignsParams} request
|
|
499
|
+
* @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
|
|
500
|
+
*
|
|
501
|
+
* @throws {@link Pinnacle.BadRequestError}
|
|
502
|
+
* @throws {@link Pinnacle.UnauthorizedError}
|
|
503
|
+
* @throws {@link Pinnacle.InternalServerError}
|
|
504
|
+
*
|
|
505
|
+
* @example
|
|
506
|
+
* await client.campaigns.rcs.list()
|
|
507
|
+
*/
|
|
508
|
+
list(request = {}, requestOptions) {
|
|
509
|
+
return core.HttpResponsePromise.fromPromise(this.__list(request, requestOptions));
|
|
510
|
+
}
|
|
511
|
+
__list() {
|
|
512
|
+
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
513
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
514
|
+
const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
515
|
+
const _response = yield core.fetcher({
|
|
516
|
+
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PinnacleEnvironment.Default, "campaigns/rcs/list"),
|
|
517
|
+
method: "POST",
|
|
518
|
+
headers: _headers,
|
|
519
|
+
contentType: "application/json",
|
|
520
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
521
|
+
requestType: "json",
|
|
522
|
+
body: request,
|
|
523
|
+
timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
|
|
524
|
+
maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
|
|
525
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
526
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
527
|
+
logging: this._options.logging,
|
|
528
|
+
});
|
|
529
|
+
if (_response.ok) {
|
|
530
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
531
|
+
}
|
|
532
|
+
if (_response.error.reason === "status-code") {
|
|
533
|
+
switch (_response.error.statusCode) {
|
|
534
|
+
case 400:
|
|
535
|
+
throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
|
|
536
|
+
case 401:
|
|
537
|
+
throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
538
|
+
case 500:
|
|
539
|
+
throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
|
|
540
|
+
default:
|
|
541
|
+
throw new errors.PinnacleError({
|
|
542
|
+
statusCode: _response.error.statusCode,
|
|
543
|
+
body: _response.error.body,
|
|
544
|
+
rawResponse: _response.rawResponse,
|
|
545
|
+
});
|
|
546
|
+
}
|
|
547
|
+
}
|
|
548
|
+
switch (_response.error.reason) {
|
|
549
|
+
case "non-json":
|
|
550
|
+
throw new errors.PinnacleError({
|
|
551
|
+
statusCode: _response.error.statusCode,
|
|
552
|
+
body: _response.error.rawBody,
|
|
553
|
+
rawResponse: _response.rawResponse,
|
|
554
|
+
});
|
|
555
|
+
case "timeout":
|
|
556
|
+
throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /campaigns/rcs/list.");
|
|
557
|
+
case "unknown":
|
|
558
|
+
throw new errors.PinnacleError({
|
|
559
|
+
message: _response.error.errorMessage,
|
|
560
|
+
rawResponse: _response.rawResponse,
|
|
561
|
+
});
|
|
562
|
+
}
|
|
563
|
+
});
|
|
564
|
+
}
|
|
501
565
|
_getCustomAuthorizationHeaders() {
|
|
502
566
|
return __awaiter(this, void 0, void 0, function* () {
|
|
503
567
|
const apiKeyValue = yield core.Supplier.get(this._options.apiKey);
|
package/dist/cjs/api/resources/campaigns/resources/rcs/client/requests/ListRcsCampaignsParams.d.ts
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {}
|
|
4
|
+
*/
|
|
5
|
+
export interface ListRcsCampaignsParams {
|
|
6
|
+
pageIndex?: number;
|
|
7
|
+
pageSize?: number;
|
|
8
|
+
status?: ListRcsCampaignsParams.Status;
|
|
9
|
+
brandId?: string;
|
|
10
|
+
/** Filter by campaign name (partial match, case-insensitive). */
|
|
11
|
+
name?: string;
|
|
12
|
+
}
|
|
13
|
+
export declare namespace ListRcsCampaignsParams {
|
|
14
|
+
const Status: {
|
|
15
|
+
readonly Incomplete: "INCOMPLETE";
|
|
16
|
+
readonly InReview: "IN REVIEW";
|
|
17
|
+
readonly Verified: "VERIFIED";
|
|
18
|
+
readonly Failed: "FAILED";
|
|
19
|
+
};
|
|
20
|
+
type Status = (typeof Status)[keyof typeof Status];
|
|
21
|
+
}
|
package/dist/cjs/api/resources/campaigns/resources/rcs/client/requests/ListRcsCampaignsParams.js
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.ListRcsCampaignsParams = void 0;
|
|
5
|
+
var ListRcsCampaignsParams;
|
|
6
|
+
(function (ListRcsCampaignsParams) {
|
|
7
|
+
ListRcsCampaignsParams.Status = {
|
|
8
|
+
Incomplete: "INCOMPLETE",
|
|
9
|
+
InReview: "IN REVIEW",
|
|
10
|
+
Verified: "VERIFIED",
|
|
11
|
+
Failed: "FAILED",
|
|
12
|
+
};
|
|
13
|
+
})(ListRcsCampaignsParams || (exports.ListRcsCampaignsParams = ListRcsCampaignsParams = {}));
|