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
|
@@ -321,6 +321,76 @@ class PhoneNumbers {
|
|
|
321
321
|
}
|
|
322
322
|
});
|
|
323
323
|
}
|
|
324
|
+
/**
|
|
325
|
+
* List all owned phone numbers with pagination. Results are sorted by creation date, newest first.
|
|
326
|
+
*
|
|
327
|
+
* @param {Pinnacle.ListPhoneNumbersParams} request
|
|
328
|
+
* @param {PhoneNumbers.RequestOptions} requestOptions - Request-specific configuration.
|
|
329
|
+
*
|
|
330
|
+
* @throws {@link Pinnacle.BadRequestError}
|
|
331
|
+
* @throws {@link Pinnacle.UnauthorizedError}
|
|
332
|
+
* @throws {@link Pinnacle.InternalServerError}
|
|
333
|
+
*
|
|
334
|
+
* @example
|
|
335
|
+
* await client.phoneNumbers.list()
|
|
336
|
+
*/
|
|
337
|
+
list(request = {}, requestOptions) {
|
|
338
|
+
return core.HttpResponsePromise.fromPromise(this.__list(request, requestOptions));
|
|
339
|
+
}
|
|
340
|
+
__list() {
|
|
341
|
+
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
342
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
343
|
+
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);
|
|
344
|
+
const _response = yield core.fetcher({
|
|
345
|
+
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, "phone-numbers/list"),
|
|
346
|
+
method: "POST",
|
|
347
|
+
headers: _headers,
|
|
348
|
+
contentType: "application/json",
|
|
349
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
350
|
+
requestType: "json",
|
|
351
|
+
body: request,
|
|
352
|
+
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,
|
|
353
|
+
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,
|
|
354
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
355
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
356
|
+
logging: this._options.logging,
|
|
357
|
+
});
|
|
358
|
+
if (_response.ok) {
|
|
359
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
360
|
+
}
|
|
361
|
+
if (_response.error.reason === "status-code") {
|
|
362
|
+
switch (_response.error.statusCode) {
|
|
363
|
+
case 400:
|
|
364
|
+
throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
|
|
365
|
+
case 401:
|
|
366
|
+
throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
367
|
+
case 500:
|
|
368
|
+
throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
|
|
369
|
+
default:
|
|
370
|
+
throw new errors.PinnacleError({
|
|
371
|
+
statusCode: _response.error.statusCode,
|
|
372
|
+
body: _response.error.body,
|
|
373
|
+
rawResponse: _response.rawResponse,
|
|
374
|
+
});
|
|
375
|
+
}
|
|
376
|
+
}
|
|
377
|
+
switch (_response.error.reason) {
|
|
378
|
+
case "non-json":
|
|
379
|
+
throw new errors.PinnacleError({
|
|
380
|
+
statusCode: _response.error.statusCode,
|
|
381
|
+
body: _response.error.rawBody,
|
|
382
|
+
rawResponse: _response.rawResponse,
|
|
383
|
+
});
|
|
384
|
+
case "timeout":
|
|
385
|
+
throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /phone-numbers/list.");
|
|
386
|
+
case "unknown":
|
|
387
|
+
throw new errors.PinnacleError({
|
|
388
|
+
message: _response.error.errorMessage,
|
|
389
|
+
rawResponse: _response.rawResponse,
|
|
390
|
+
});
|
|
391
|
+
}
|
|
392
|
+
});
|
|
393
|
+
}
|
|
324
394
|
_getCustomAuthorizationHeaders() {
|
|
325
395
|
return __awaiter(this, void 0, void 0, function* () {
|
|
326
396
|
const apiKeyValue = yield core.Supplier.get(this._options.apiKey);
|
|
@@ -1,3 +1,4 @@
|
|
|
1
1
|
export type { BuyPhoneNumberParams } from "./BuyPhoneNumberParams.js";
|
|
2
|
+
export type { ListPhoneNumbersParams } from "./ListPhoneNumbersParams.js";
|
|
2
3
|
export type { RetrievePhoneNumberDetailsParams } from "./RetrievePhoneNumberDetailsParams.js";
|
|
3
4
|
export type { SearchPhoneNumberParams } from "./SearchPhoneNumberParams.js";
|
|
@@ -1,6 +1,9 @@
|
|
|
1
1
|
import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
|
|
2
2
|
import * as core from "../../../../core/index.js";
|
|
3
3
|
import * as Pinnacle from "../../../index.js";
|
|
4
|
+
import { Agents } from "../resources/agents/client/Client.js";
|
|
5
|
+
import { Test } from "../resources/test/client/Client.js";
|
|
6
|
+
import { WhitelistedNumbers } from "../resources/whitelistedNumbers/client/Client.js";
|
|
4
7
|
export declare namespace Rcs {
|
|
5
8
|
interface Options extends BaseClientOptions {
|
|
6
9
|
}
|
|
@@ -9,74 +12,55 @@ export declare namespace Rcs {
|
|
|
9
12
|
}
|
|
10
13
|
export declare class Rcs {
|
|
11
14
|
protected readonly _options: Rcs.Options;
|
|
15
|
+
protected _agents: Agents | undefined;
|
|
16
|
+
protected _whitelistedNumbers: WhitelistedNumbers | undefined;
|
|
17
|
+
protected _test: Test | undefined;
|
|
12
18
|
constructor(_options: Rcs.Options);
|
|
19
|
+
get agents(): Agents;
|
|
20
|
+
get whitelistedNumbers(): WhitelistedNumbers;
|
|
21
|
+
get test(): Test;
|
|
13
22
|
/**
|
|
14
|
-
*
|
|
23
|
+
* Retrieve details of an RCS agent by its ID.
|
|
15
24
|
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
25
|
+
* Returns the agent's configuration including display name, description, logo, hero image,
|
|
26
|
+
* contact information, and other settings.
|
|
18
27
|
*
|
|
19
|
-
* @param {
|
|
28
|
+
* @param {string} agentId - The RCS agent ID (must be prefixed with `agent_`).
|
|
20
29
|
* @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
|
|
21
30
|
*
|
|
22
31
|
* @throws {@link Pinnacle.BadRequestError}
|
|
23
32
|
* @throws {@link Pinnacle.UnauthorizedError}
|
|
24
33
|
* @throws {@link Pinnacle.ForbiddenError}
|
|
34
|
+
* @throws {@link Pinnacle.NotFoundError}
|
|
25
35
|
* @throws {@link Pinnacle.InternalServerError}
|
|
26
|
-
* @throws {@link Pinnacle.NotImplementedError}
|
|
27
36
|
*
|
|
28
37
|
* @example
|
|
29
|
-
* await client.rcs.
|
|
30
|
-
* phoneNumbers: ["+12345678901", "+19876543210"]
|
|
31
|
-
* })
|
|
38
|
+
* await client.rcs.getAgent("agent_abc123def456")
|
|
32
39
|
*/
|
|
33
|
-
|
|
34
|
-
private
|
|
40
|
+
getAgent(agentId: string, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.RcsAgentResponse>;
|
|
41
|
+
private __getAgent;
|
|
35
42
|
/**
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
* ## Overview
|
|
39
|
-
* During development and testing, RCS agents can only send messages to whitelisted phone numbers.
|
|
40
|
-
* Use this endpoint to whitelist specific phone numbers to send and receive messages from the test agent.
|
|
41
|
-
*
|
|
42
|
-
* ## Verification Process
|
|
43
|
-
* After whitelisting a number, you'll need to complete verification:
|
|
44
|
-
*
|
|
45
|
-
* 1. Check the test device for message from "RBM Tester Management"
|
|
46
|
-
* 2. Click the "Make me a tester" button
|
|
47
|
-
* 3. Enter the separate 4-digit verification SMS code in the Pinnacle dashboard at:
|
|
48
|
-
* ```
|
|
49
|
-
* https://app.pinnacle.sh/dashboard/brands/{brandId}?campaignId={campaignId}&campaignType=RCS
|
|
50
|
-
* ```
|
|
51
|
-
*
|
|
52
|
-
* > **⚠️ Important: Re-whitelisting Numbers**
|
|
53
|
-
* >
|
|
54
|
-
* > If you whitelist a number that's already whitelisted, you'll receive a new message from "RBM Tester Management". **You must click the "Make me a tester" button again to continue sending and receiving messages.**
|
|
43
|
+
* Check RCS capabilities for one or more phone numbers.
|
|
55
44
|
*
|
|
56
|
-
*
|
|
57
|
-
*
|
|
58
|
-
* > - **Verification required:** Messages cannot be sent nor received until you have clicked the "Make me a tester" button on the test device.
|
|
59
|
-
* > - **Testing only:** This is only required for test agents. Production agents can message any RCS-enabled number.
|
|
60
|
-
* > - **Network limitations:** Whitelisting may be temporarily unavailable for some carriers but are usually restored shortly.
|
|
45
|
+
* This endpoint allows you to verify which RCS features (cards, buttons, etc.) are supported
|
|
46
|
+
* on specific phone numbers before sending RCS messages to them.
|
|
61
47
|
*
|
|
62
|
-
* @param {Pinnacle.
|
|
48
|
+
* @param {Pinnacle.RcsCapabilitiesQuery} request
|
|
63
49
|
* @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
|
|
64
50
|
*
|
|
65
51
|
* @throws {@link Pinnacle.BadRequestError}
|
|
66
52
|
* @throws {@link Pinnacle.UnauthorizedError}
|
|
67
53
|
* @throws {@link Pinnacle.ForbiddenError}
|
|
68
|
-
* @throws {@link Pinnacle.NotFoundError}
|
|
69
54
|
* @throws {@link Pinnacle.InternalServerError}
|
|
70
55
|
* @throws {@link Pinnacle.NotImplementedError}
|
|
71
56
|
*
|
|
72
57
|
* @example
|
|
73
|
-
* await client.rcs.
|
|
74
|
-
*
|
|
75
|
-
* phoneNumber: "+12345678901"
|
|
58
|
+
* await client.rcs.getCapabilities({
|
|
59
|
+
* phoneNumbers: ["+12345678901", "+19876543210"]
|
|
76
60
|
* })
|
|
77
61
|
*/
|
|
78
|
-
|
|
79
|
-
private
|
|
62
|
+
getCapabilities(request: Pinnacle.RcsCapabilitiesQuery, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.RcsCapabilitiesResult>;
|
|
63
|
+
private __getCapabilities;
|
|
80
64
|
/**
|
|
81
65
|
* Generate a link for initiating an RCS conversation with your agent.
|
|
82
66
|
*
|
|
@@ -96,7 +80,6 @@ export declare class Rcs {
|
|
|
96
80
|
* @example
|
|
97
81
|
* await client.rcs.getLink({
|
|
98
82
|
* agentId: "agent_XXXXXXXXXXXX",
|
|
99
|
-
* testMode: false,
|
|
100
83
|
* phoneNumber: "+12345678901",
|
|
101
84
|
* body: "Hello, I need help with my order"
|
|
102
85
|
* })
|
|
@@ -49,45 +49,55 @@ const core = __importStar(require("../../../../core/index.js"));
|
|
|
49
49
|
const environments = __importStar(require("../../../../environments.js"));
|
|
50
50
|
const errors = __importStar(require("../../../../errors/index.js"));
|
|
51
51
|
const Pinnacle = __importStar(require("../../../index.js"));
|
|
52
|
+
const Client_js_1 = require("../resources/agents/client/Client.js");
|
|
53
|
+
const Client_js_2 = require("../resources/test/client/Client.js");
|
|
54
|
+
const Client_js_3 = require("../resources/whitelistedNumbers/client/Client.js");
|
|
52
55
|
class Rcs {
|
|
53
56
|
constructor(_options) {
|
|
54
57
|
this._options = _options;
|
|
55
58
|
}
|
|
59
|
+
get agents() {
|
|
60
|
+
var _a;
|
|
61
|
+
return ((_a = this._agents) !== null && _a !== void 0 ? _a : (this._agents = new Client_js_1.Agents(this._options)));
|
|
62
|
+
}
|
|
63
|
+
get whitelistedNumbers() {
|
|
64
|
+
var _a;
|
|
65
|
+
return ((_a = this._whitelistedNumbers) !== null && _a !== void 0 ? _a : (this._whitelistedNumbers = new Client_js_3.WhitelistedNumbers(this._options)));
|
|
66
|
+
}
|
|
67
|
+
get test() {
|
|
68
|
+
var _a;
|
|
69
|
+
return ((_a = this._test) !== null && _a !== void 0 ? _a : (this._test = new Client_js_2.Test(this._options)));
|
|
70
|
+
}
|
|
56
71
|
/**
|
|
57
|
-
*
|
|
72
|
+
* Retrieve details of an RCS agent by its ID.
|
|
58
73
|
*
|
|
59
|
-
*
|
|
60
|
-
*
|
|
74
|
+
* Returns the agent's configuration including display name, description, logo, hero image,
|
|
75
|
+
* contact information, and other settings.
|
|
61
76
|
*
|
|
62
|
-
* @param {
|
|
77
|
+
* @param {string} agentId - The RCS agent ID (must be prefixed with `agent_`).
|
|
63
78
|
* @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
|
|
64
79
|
*
|
|
65
80
|
* @throws {@link Pinnacle.BadRequestError}
|
|
66
81
|
* @throws {@link Pinnacle.UnauthorizedError}
|
|
67
82
|
* @throws {@link Pinnacle.ForbiddenError}
|
|
83
|
+
* @throws {@link Pinnacle.NotFoundError}
|
|
68
84
|
* @throws {@link Pinnacle.InternalServerError}
|
|
69
|
-
* @throws {@link Pinnacle.NotImplementedError}
|
|
70
85
|
*
|
|
71
86
|
* @example
|
|
72
|
-
* await client.rcs.
|
|
73
|
-
* phoneNumbers: ["+12345678901", "+19876543210"]
|
|
74
|
-
* })
|
|
87
|
+
* await client.rcs.getAgent("agent_abc123def456")
|
|
75
88
|
*/
|
|
76
|
-
|
|
77
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
89
|
+
getAgent(agentId, requestOptions) {
|
|
90
|
+
return core.HttpResponsePromise.fromPromise(this.__getAgent(agentId, requestOptions));
|
|
78
91
|
}
|
|
79
|
-
|
|
92
|
+
__getAgent(agentId, requestOptions) {
|
|
80
93
|
return __awaiter(this, void 0, void 0, function* () {
|
|
81
94
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
82
95
|
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);
|
|
83
96
|
const _response = yield core.fetcher({
|
|
84
|
-
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,
|
|
85
|
-
method: "
|
|
97
|
+
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, `rcs/${core.url.encodePathParam(agentId)}`),
|
|
98
|
+
method: "GET",
|
|
86
99
|
headers: _headers,
|
|
87
|
-
contentType: "application/json",
|
|
88
100
|
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
89
|
-
requestType: "json",
|
|
90
|
-
body: request,
|
|
91
101
|
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,
|
|
92
102
|
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,
|
|
93
103
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -105,10 +115,10 @@ class Rcs {
|
|
|
105
115
|
throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
106
116
|
case 403:
|
|
107
117
|
throw new Pinnacle.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
118
|
+
case 404:
|
|
119
|
+
throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
|
|
108
120
|
case 500:
|
|
109
121
|
throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
|
|
110
|
-
case 501:
|
|
111
|
-
throw new Pinnacle.NotImplementedError(_response.error.body, _response.rawResponse);
|
|
112
122
|
default:
|
|
113
123
|
throw new errors.PinnacleError({
|
|
114
124
|
statusCode: _response.error.statusCode,
|
|
@@ -125,7 +135,7 @@ class Rcs {
|
|
|
125
135
|
rawResponse: _response.rawResponse,
|
|
126
136
|
});
|
|
127
137
|
case "timeout":
|
|
128
|
-
throw new errors.PinnacleTimeoutError("Timeout exceeded when calling
|
|
138
|
+
throw new errors.PinnacleTimeoutError("Timeout exceeded when calling GET /rcs/{agentId}.");
|
|
129
139
|
case "unknown":
|
|
130
140
|
throw new errors.PinnacleError({
|
|
131
141
|
message: _response.error.errorMessage,
|
|
@@ -135,57 +145,34 @@ class Rcs {
|
|
|
135
145
|
});
|
|
136
146
|
}
|
|
137
147
|
/**
|
|
138
|
-
*
|
|
139
|
-
*
|
|
140
|
-
* ## Overview
|
|
141
|
-
* During development and testing, RCS agents can only send messages to whitelisted phone numbers.
|
|
142
|
-
* Use this endpoint to whitelist specific phone numbers to send and receive messages from the test agent.
|
|
143
|
-
*
|
|
144
|
-
* ## Verification Process
|
|
145
|
-
* After whitelisting a number, you'll need to complete verification:
|
|
146
|
-
*
|
|
147
|
-
* 1. Check the test device for message from "RBM Tester Management"
|
|
148
|
-
* 2. Click the "Make me a tester" button
|
|
149
|
-
* 3. Enter the separate 4-digit verification SMS code in the Pinnacle dashboard at:
|
|
150
|
-
* ```
|
|
151
|
-
* https://app.pinnacle.sh/dashboard/brands/{brandId}?campaignId={campaignId}&campaignType=RCS
|
|
152
|
-
* ```
|
|
153
|
-
*
|
|
154
|
-
* > **⚠️ Important: Re-whitelisting Numbers**
|
|
155
|
-
* >
|
|
156
|
-
* > If you whitelist a number that's already whitelisted, you'll receive a new message from "RBM Tester Management". **You must click the "Make me a tester" button again to continue sending and receiving messages.**
|
|
148
|
+
* Check RCS capabilities for one or more phone numbers.
|
|
157
149
|
*
|
|
158
|
-
*
|
|
159
|
-
*
|
|
160
|
-
* > - **Verification required:** Messages cannot be sent nor received until you have clicked the "Make me a tester" button on the test device.
|
|
161
|
-
* > - **Testing only:** This is only required for test agents. Production agents can message any RCS-enabled number.
|
|
162
|
-
* > - **Network limitations:** Whitelisting may be temporarily unavailable for some carriers but are usually restored shortly.
|
|
150
|
+
* This endpoint allows you to verify which RCS features (cards, buttons, etc.) are supported
|
|
151
|
+
* on specific phone numbers before sending RCS messages to them.
|
|
163
152
|
*
|
|
164
|
-
* @param {Pinnacle.
|
|
153
|
+
* @param {Pinnacle.RcsCapabilitiesQuery} request
|
|
165
154
|
* @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
|
|
166
155
|
*
|
|
167
156
|
* @throws {@link Pinnacle.BadRequestError}
|
|
168
157
|
* @throws {@link Pinnacle.UnauthorizedError}
|
|
169
158
|
* @throws {@link Pinnacle.ForbiddenError}
|
|
170
|
-
* @throws {@link Pinnacle.NotFoundError}
|
|
171
159
|
* @throws {@link Pinnacle.InternalServerError}
|
|
172
160
|
* @throws {@link Pinnacle.NotImplementedError}
|
|
173
161
|
*
|
|
174
162
|
* @example
|
|
175
|
-
* await client.rcs.
|
|
176
|
-
*
|
|
177
|
-
* phoneNumber: "+12345678901"
|
|
163
|
+
* await client.rcs.getCapabilities({
|
|
164
|
+
* phoneNumbers: ["+12345678901", "+19876543210"]
|
|
178
165
|
* })
|
|
179
166
|
*/
|
|
180
|
-
|
|
181
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
167
|
+
getCapabilities(request, requestOptions) {
|
|
168
|
+
return core.HttpResponsePromise.fromPromise(this.__getCapabilities(request, requestOptions));
|
|
182
169
|
}
|
|
183
|
-
|
|
170
|
+
__getCapabilities(request, requestOptions) {
|
|
184
171
|
return __awaiter(this, void 0, void 0, function* () {
|
|
185
172
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
186
173
|
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);
|
|
187
174
|
const _response = yield core.fetcher({
|
|
188
|
-
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, "rcs/
|
|
175
|
+
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, "rcs/capabilities"),
|
|
189
176
|
method: "POST",
|
|
190
177
|
headers: _headers,
|
|
191
178
|
contentType: "application/json",
|
|
@@ -209,8 +196,6 @@ class Rcs {
|
|
|
209
196
|
throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
210
197
|
case 403:
|
|
211
198
|
throw new Pinnacle.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
212
|
-
case 404:
|
|
213
|
-
throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
|
|
214
199
|
case 500:
|
|
215
200
|
throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
|
|
216
201
|
case 501:
|
|
@@ -231,7 +216,7 @@ class Rcs {
|
|
|
231
216
|
rawResponse: _response.rawResponse,
|
|
232
217
|
});
|
|
233
218
|
case "timeout":
|
|
234
|
-
throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /rcs/
|
|
219
|
+
throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /rcs/capabilities.");
|
|
235
220
|
case "unknown":
|
|
236
221
|
throw new errors.PinnacleError({
|
|
237
222
|
message: _response.error.errorMessage,
|
|
@@ -259,7 +244,6 @@ class Rcs {
|
|
|
259
244
|
* @example
|
|
260
245
|
* await client.rcs.getLink({
|
|
261
246
|
* agentId: "agent_XXXXXXXXXXXX",
|
|
262
|
-
* testMode: false,
|
|
263
247
|
* phoneNumber: "+12345678901",
|
|
264
248
|
* body: "Hello, I need help with my order"
|
|
265
249
|
* })
|
|
@@ -2,7 +2,6 @@
|
|
|
2
2
|
* @example
|
|
3
3
|
* {
|
|
4
4
|
* agentId: "agent_XXXXXXXXXXXX",
|
|
5
|
-
* testMode: false,
|
|
6
5
|
* phoneNumber: "+12345678901",
|
|
7
6
|
* body: "Hello, I need help with my order"
|
|
8
7
|
* }
|
|
@@ -10,8 +9,6 @@
|
|
|
10
9
|
export interface RcsLinkRequest {
|
|
11
10
|
/** The RCS agent ID (must be prefixed with 'agent_') */
|
|
12
11
|
agentId: string;
|
|
13
|
-
/** Link to the test agent or the production agent if false */
|
|
14
|
-
testMode?: boolean;
|
|
15
12
|
/** Fallback phone number (E.164 format) to use if the phone number does not support RCS. If not provided, no url will be generated. */
|
|
16
13
|
phoneNumber?: string;
|
|
17
14
|
/** Optional message body to pre-fill after the user clicks the link */
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import type { BaseClientOptions, BaseRequestOptions } from "../../../../../../BaseClient.js";
|
|
2
|
+
import * as core from "../../../../../../core/index.js";
|
|
3
|
+
import * as Pinnacle from "../../../../../index.js";
|
|
4
|
+
export declare namespace Agents {
|
|
5
|
+
interface Options extends BaseClientOptions {
|
|
6
|
+
}
|
|
7
|
+
interface RequestOptions extends BaseRequestOptions {
|
|
8
|
+
}
|
|
9
|
+
}
|
|
10
|
+
export declare class Agents {
|
|
11
|
+
protected readonly _options: Agents.Options;
|
|
12
|
+
constructor(_options: Agents.Options);
|
|
13
|
+
/**
|
|
14
|
+
* List all RCS agents with pagination. Results are sorted by creation date, newest first.
|
|
15
|
+
*
|
|
16
|
+
* @param {Pinnacle.rcs.ListAgentsParams} request
|
|
17
|
+
* @param {Agents.RequestOptions} requestOptions - Request-specific configuration.
|
|
18
|
+
*
|
|
19
|
+
* @throws {@link Pinnacle.BadRequestError}
|
|
20
|
+
* @throws {@link Pinnacle.UnauthorizedError}
|
|
21
|
+
* @throws {@link Pinnacle.InternalServerError}
|
|
22
|
+
*
|
|
23
|
+
* @example
|
|
24
|
+
* await client.rcs.agents.list()
|
|
25
|
+
*/
|
|
26
|
+
list(request?: Pinnacle.rcs.ListAgentsParams, requestOptions?: Agents.RequestOptions): core.HttpResponsePromise<Pinnacle.ListAgentsResponse>;
|
|
27
|
+
private __list;
|
|
28
|
+
protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | undefined>>;
|
|
29
|
+
}
|
|
@@ -0,0 +1,133 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
4
|
+
if (k2 === undefined) k2 = k;
|
|
5
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
6
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
7
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
8
|
+
}
|
|
9
|
+
Object.defineProperty(o, k2, desc);
|
|
10
|
+
}) : (function(o, m, k, k2) {
|
|
11
|
+
if (k2 === undefined) k2 = k;
|
|
12
|
+
o[k2] = m[k];
|
|
13
|
+
}));
|
|
14
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
15
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
16
|
+
}) : function(o, v) {
|
|
17
|
+
o["default"] = v;
|
|
18
|
+
});
|
|
19
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
20
|
+
var ownKeys = function(o) {
|
|
21
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
22
|
+
var ar = [];
|
|
23
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
24
|
+
return ar;
|
|
25
|
+
};
|
|
26
|
+
return ownKeys(o);
|
|
27
|
+
};
|
|
28
|
+
return function (mod) {
|
|
29
|
+
if (mod && mod.__esModule) return mod;
|
|
30
|
+
var result = {};
|
|
31
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
32
|
+
__setModuleDefault(result, mod);
|
|
33
|
+
return result;
|
|
34
|
+
};
|
|
35
|
+
})();
|
|
36
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
37
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
38
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
39
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
40
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
41
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
42
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
43
|
+
});
|
|
44
|
+
};
|
|
45
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
46
|
+
exports.Agents = void 0;
|
|
47
|
+
const headers_js_1 = require("../../../../../../core/headers.js");
|
|
48
|
+
const core = __importStar(require("../../../../../../core/index.js"));
|
|
49
|
+
const environments = __importStar(require("../../../../../../environments.js"));
|
|
50
|
+
const errors = __importStar(require("../../../../../../errors/index.js"));
|
|
51
|
+
const Pinnacle = __importStar(require("../../../../../index.js"));
|
|
52
|
+
class Agents {
|
|
53
|
+
constructor(_options) {
|
|
54
|
+
this._options = _options;
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* List all RCS agents with pagination. Results are sorted by creation date, newest first.
|
|
58
|
+
*
|
|
59
|
+
* @param {Pinnacle.rcs.ListAgentsParams} request
|
|
60
|
+
* @param {Agents.RequestOptions} requestOptions - Request-specific configuration.
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link Pinnacle.BadRequestError}
|
|
63
|
+
* @throws {@link Pinnacle.UnauthorizedError}
|
|
64
|
+
* @throws {@link Pinnacle.InternalServerError}
|
|
65
|
+
*
|
|
66
|
+
* @example
|
|
67
|
+
* await client.rcs.agents.list()
|
|
68
|
+
*/
|
|
69
|
+
list(request = {}, requestOptions) {
|
|
70
|
+
return core.HttpResponsePromise.fromPromise(this.__list(request, requestOptions));
|
|
71
|
+
}
|
|
72
|
+
__list() {
|
|
73
|
+
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
74
|
+
var _a, _b, _c, _d, _e, _f, _g, _h, _j;
|
|
75
|
+
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);
|
|
76
|
+
const _response = yield core.fetcher({
|
|
77
|
+
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, "rcs/agents/list"),
|
|
78
|
+
method: "POST",
|
|
79
|
+
headers: _headers,
|
|
80
|
+
contentType: "application/json",
|
|
81
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
82
|
+
requestType: "json",
|
|
83
|
+
body: request,
|
|
84
|
+
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,
|
|
85
|
+
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,
|
|
86
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
87
|
+
fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
|
|
88
|
+
logging: this._options.logging,
|
|
89
|
+
});
|
|
90
|
+
if (_response.ok) {
|
|
91
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
92
|
+
}
|
|
93
|
+
if (_response.error.reason === "status-code") {
|
|
94
|
+
switch (_response.error.statusCode) {
|
|
95
|
+
case 400:
|
|
96
|
+
throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
|
|
97
|
+
case 401:
|
|
98
|
+
throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
99
|
+
case 500:
|
|
100
|
+
throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
|
|
101
|
+
default:
|
|
102
|
+
throw new errors.PinnacleError({
|
|
103
|
+
statusCode: _response.error.statusCode,
|
|
104
|
+
body: _response.error.body,
|
|
105
|
+
rawResponse: _response.rawResponse,
|
|
106
|
+
});
|
|
107
|
+
}
|
|
108
|
+
}
|
|
109
|
+
switch (_response.error.reason) {
|
|
110
|
+
case "non-json":
|
|
111
|
+
throw new errors.PinnacleError({
|
|
112
|
+
statusCode: _response.error.statusCode,
|
|
113
|
+
body: _response.error.rawBody,
|
|
114
|
+
rawResponse: _response.rawResponse,
|
|
115
|
+
});
|
|
116
|
+
case "timeout":
|
|
117
|
+
throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /rcs/agents/list.");
|
|
118
|
+
case "unknown":
|
|
119
|
+
throw new errors.PinnacleError({
|
|
120
|
+
message: _response.error.errorMessage,
|
|
121
|
+
rawResponse: _response.rawResponse,
|
|
122
|
+
});
|
|
123
|
+
}
|
|
124
|
+
});
|
|
125
|
+
}
|
|
126
|
+
_getCustomAuthorizationHeaders() {
|
|
127
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
128
|
+
const apiKeyValue = yield core.Supplier.get(this._options.apiKey);
|
|
129
|
+
return { "PINNACLE-API-KEY": apiKeyValue };
|
|
130
|
+
});
|
|
131
|
+
}
|
|
132
|
+
}
|
|
133
|
+
exports.Agents = Agents;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./requests/index.js";
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./requests/index.js"), exports);
|