rcs-js 2.0.5 → 2.0.7
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/README.md +74 -25
- package/dist/cjs/BaseClient.d.ts +30 -0
- package/dist/cjs/{api/types/RcsCards.js → BaseClient.js} +1 -3
- package/dist/cjs/Client.d.ts +8 -25
- package/dist/cjs/Client.js +27 -24
- package/dist/cjs/api/errors/BadRequestError.d.ts +1 -4
- package/dist/cjs/api/errors/BadRequestError.js +1 -3
- package/dist/cjs/api/errors/InternalServerError.d.ts +2 -5
- package/dist/cjs/api/errors/InternalServerError.js +1 -3
- package/dist/cjs/api/errors/NotFoundError.d.ts +1 -4
- package/dist/cjs/api/errors/NotFoundError.js +1 -3
- package/dist/cjs/api/errors/NotImplementedError.d.ts +2 -5
- package/dist/cjs/api/errors/NotImplementedError.js +1 -3
- package/dist/cjs/api/errors/PaymentRequiredError.d.ts +2 -5
- package/dist/cjs/api/errors/PaymentRequiredError.js +1 -3
- package/dist/cjs/api/errors/UnauthorizedError.d.ts +2 -5
- package/dist/cjs/api/errors/UnauthorizedError.js +1 -3
- package/dist/cjs/api/errors/index.d.ts +2 -2
- package/dist/cjs/api/errors/index.js +2 -2
- package/dist/cjs/api/index.d.ts +1 -1
- package/dist/cjs/api/index.js +1 -1
- package/dist/cjs/api/resources/audiences/client/Client.d.ts +108 -0
- package/dist/cjs/api/resources/audiences/client/Client.js +391 -0
- package/dist/cjs/api/resources/audiences/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/audiences/client/index.js +17 -0
- package/dist/cjs/api/resources/audiences/client/requests/AudiencesDeleteRequest.d.ts +10 -0
- package/dist/cjs/api/resources/{messages/resources/rcs/types/RcsSendResponse.js → audiences/client/requests/AudiencesDeleteRequest.js} +1 -3
- package/dist/cjs/api/resources/audiences/client/requests/AudiencesGetRequest.d.ts +19 -0
- package/dist/cjs/api/{types/RcsBase.js → resources/audiences/client/requests/AudiencesGetRequest.js} +1 -3
- package/dist/cjs/api/resources/audiences/client/requests/CreateAudienceParams.d.ts +28 -0
- package/dist/cjs/api/{types/Options.js → resources/audiences/client/requests/CreateAudienceParams.js} +1 -3
- package/dist/cjs/api/resources/audiences/client/requests/UpdateAudienceParams.d.ts +16 -0
- package/dist/cjs/api/resources/audiences/client/requests/UpdateAudienceParams.js +3 -0
- package/dist/cjs/api/resources/audiences/client/requests/index.d.ts +4 -0
- package/dist/cjs/api/resources/audiences/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/audiences/index.d.ts +3 -0
- package/dist/cjs/api/resources/audiences/index.js +19 -0
- package/dist/cjs/api/resources/audiences/resources/contacts/client/Client.d.ts +59 -0
- package/dist/cjs/api/resources/audiences/resources/contacts/client/Client.js +222 -0
- package/dist/cjs/api/resources/audiences/resources/contacts/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/audiences/resources/contacts/client/index.js +17 -0
- package/dist/cjs/api/resources/audiences/resources/contacts/client/requests/AddContactsParams.d.ts +13 -0
- package/dist/cjs/api/resources/audiences/resources/contacts/client/requests/AddContactsParams.js +3 -0
- package/dist/cjs/api/resources/audiences/resources/contacts/client/requests/RemoveContactsParams.d.ts +13 -0
- package/dist/cjs/api/resources/audiences/resources/contacts/client/requests/RemoveContactsParams.js +3 -0
- package/dist/cjs/api/resources/audiences/resources/contacts/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/audiences/resources/contacts/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/audiences/resources/contacts/index.d.ts +1 -0
- package/dist/cjs/api/resources/audiences/resources/contacts/index.js +17 -0
- package/dist/cjs/api/resources/audiences/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/audiences/resources/index.js +41 -0
- package/dist/cjs/api/resources/audiences/types/AudiencesGetResponse.d.ts +8 -0
- package/dist/cjs/api/resources/audiences/types/AudiencesGetResponse.js +3 -0
- package/dist/cjs/api/resources/audiences/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/audiences/types/index.js +17 -0
- package/dist/cjs/api/resources/brands/client/Client.d.ts +6 -25
- package/dist/cjs/api/resources/brands/client/Client.js +46 -34
- package/dist/cjs/api/resources/brands/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/brands/client/requests/AutofillBrandParams.d.ts +0 -3
- package/dist/cjs/api/resources/brands/client/requests/AutofillBrandParams.js +1 -3
- package/dist/cjs/api/resources/brands/client/requests/BrandsGetRequest.d.ts +0 -3
- package/dist/cjs/api/resources/brands/client/requests/BrandsGetRequest.js +1 -3
- package/dist/cjs/api/resources/brands/client/requests/UpsertBrandParams.d.ts +4 -4
- package/dist/cjs/api/resources/brands/client/requests/UpsertBrandParams.js +1 -3
- package/dist/cjs/api/resources/brands/client/requests/ValidateBrandParams.d.ts +4 -4
- package/dist/cjs/api/resources/brands/client/requests/ValidateBrandParams.js +1 -3
- package/dist/cjs/api/resources/brands/client/requests/VetBrandParams.d.ts +1 -5
- package/dist/cjs/api/resources/brands/client/requests/VetBrandParams.js +1 -3
- package/dist/cjs/api/resources/brands/client/requests/index.d.ts +5 -5
- package/dist/cjs/api/resources/campaigns/client/Client.d.ts +3 -13
- package/dist/cjs/api/resources/campaigns/client/Client.js +5 -7
- package/dist/cjs/api/resources/campaigns/index.d.ts +1 -1
- package/dist/cjs/api/resources/campaigns/index.js +1 -1
- package/dist/cjs/api/resources/campaigns/resources/dlc/client/Client.d.ts +4 -25
- package/dist/cjs/api/resources/campaigns/resources/dlc/client/Client.js +36 -28
- package/dist/cjs/api/resources/campaigns/resources/dlc/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/campaigns/resources/dlc/client/requests/UpsertDlcCampaignParams.d.ts +1 -4
- package/dist/cjs/api/resources/campaigns/resources/dlc/client/requests/UpsertDlcCampaignParams.js +1 -3
- package/dist/cjs/api/resources/campaigns/resources/dlc/client/requests/index.d.ts +1 -1
- package/dist/cjs/api/resources/campaigns/resources/index.d.ts +5 -5
- package/dist/cjs/api/resources/campaigns/resources/index.js +9 -9
- package/dist/cjs/api/resources/campaigns/resources/rcs/client/Client.d.ts +36 -40
- package/dist/cjs/api/resources/campaigns/resources/rcs/client/Client.js +68 -43
- package/dist/cjs/api/resources/campaigns/resources/rcs/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.ts +112 -49
- package/dist/cjs/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.js +1 -3
- package/dist/cjs/api/resources/campaigns/resources/rcs/client/requests/index.d.ts +1 -1
- package/dist/cjs/api/resources/campaigns/resources/rcs/index.d.ts +1 -1
- package/dist/cjs/api/resources/campaigns/resources/rcs/index.js +1 -1
- package/dist/cjs/api/resources/campaigns/resources/rcs/types/RcsAutofillResponse.d.ts +1 -4
- package/dist/cjs/api/resources/campaigns/resources/rcs/types/RcsAutofillResponse.js +1 -3
- package/dist/cjs/api/resources/campaigns/resources/tollFree/client/Client.d.ts +20 -25
- package/dist/cjs/api/resources/campaigns/resources/tollFree/client/Client.js +52 -28
- package/dist/cjs/api/resources/campaigns/resources/tollFree/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/campaigns/resources/tollFree/client/requests/UpsertTollFreeCampaignParams.d.ts +66 -4
- package/dist/cjs/api/resources/campaigns/resources/tollFree/client/requests/UpsertTollFreeCampaignParams.js +1 -3
- package/dist/cjs/api/resources/campaigns/resources/tollFree/client/requests/index.d.ts +1 -1
- package/dist/cjs/api/resources/campaigns/resources/tollFree/index.d.ts +1 -1
- package/dist/cjs/api/resources/campaigns/resources/tollFree/index.js +1 -1
- package/dist/cjs/api/resources/campaigns/resources/tollFree/types/TollFreeAutofillResponse.d.ts +1 -4
- package/dist/cjs/api/resources/campaigns/resources/tollFree/types/TollFreeAutofillResponse.js +1 -3
- package/dist/cjs/api/resources/contacts/client/Client.d.ts +4 -25
- package/dist/cjs/api/resources/contacts/client/Client.js +24 -20
- package/dist/cjs/api/resources/contacts/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/contacts/client/requests/ContactsGetRequest.d.ts +0 -3
- package/dist/cjs/api/resources/contacts/client/requests/ContactsGetRequest.js +1 -3
- package/dist/cjs/api/resources/contacts/client/requests/CreateContactParams.d.ts +1 -4
- package/dist/cjs/api/resources/contacts/client/requests/CreateContactParams.js +1 -3
- package/dist/cjs/api/resources/contacts/client/requests/UpdateContactParams.d.ts +1 -4
- package/dist/cjs/api/resources/contacts/client/requests/UpdateContactParams.js +1 -3
- package/dist/cjs/api/resources/contacts/client/requests/index.d.ts +3 -3
- package/dist/cjs/api/resources/conversations/client/Client.d.ts +4 -25
- package/dist/cjs/api/resources/conversations/client/Client.js +37 -31
- package/dist/cjs/api/resources/conversations/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/conversations/client/requests/ConversationsListMessagesRequest.d.ts +1 -4
- package/dist/cjs/api/resources/conversations/client/requests/ConversationsListMessagesRequest.js +1 -3
- package/dist/cjs/api/resources/conversations/client/requests/ListConversationsParams.d.ts +1 -4
- package/dist/cjs/api/resources/conversations/client/requests/ListConversationsParams.js +1 -3
- package/dist/cjs/api/resources/conversations/client/requests/UpdateConversationParams.d.ts +0 -3
- package/dist/cjs/api/resources/conversations/client/requests/UpdateConversationParams.js +1 -3
- package/dist/cjs/api/resources/conversations/client/requests/index.d.ts +3 -3
- package/dist/cjs/api/resources/conversations/index.d.ts +1 -1
- package/dist/cjs/api/resources/conversations/index.js +1 -1
- package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestDirection.d.ts +1 -4
- package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestDirection.js +1 -3
- package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestSortOrder.d.ts +1 -4
- package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestSortOrder.js +1 -3
- package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestStatus.d.ts +1 -4
- package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestStatus.js +1 -3
- package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestType.d.ts +1 -4
- package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestType.js +1 -3
- package/dist/cjs/api/resources/conversations/types/index.d.ts +1 -1
- package/dist/cjs/api/resources/conversations/types/index.js +1 -1
- package/dist/cjs/api/resources/index.d.ts +14 -11
- package/dist/cjs/api/resources/index.js +18 -15
- package/dist/cjs/api/resources/messages/client/Client.d.ts +26 -26
- package/dist/cjs/api/resources/messages/client/Client.js +101 -21
- package/dist/cjs/api/resources/messages/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/messages/client/requests/ReactMessageParams.d.ts +0 -3
- package/dist/cjs/api/resources/messages/client/requests/ReactMessageParams.js +1 -3
- package/dist/cjs/api/resources/messages/client/requests/index.d.ts +1 -1
- package/dist/cjs/api/resources/messages/index.d.ts +1 -1
- package/dist/cjs/api/resources/messages/index.js +1 -1
- package/dist/cjs/api/resources/messages/resources/index.d.ts +4 -4
- package/dist/cjs/api/resources/messages/resources/index.js +8 -8
- package/dist/cjs/api/resources/messages/resources/mms/client/Client.d.ts +4 -25
- package/dist/cjs/api/resources/messages/resources/mms/client/Client.js +16 -14
- package/dist/cjs/api/resources/messages/resources/mms/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/messages/resources/mms/client/requests/Mms.d.ts +1 -4
- package/dist/cjs/api/resources/messages/resources/mms/client/requests/Mms.js +1 -3
- package/dist/cjs/api/resources/messages/resources/mms/client/requests/index.d.ts +1 -1
- package/dist/cjs/api/resources/messages/resources/mms/index.d.ts +1 -1
- package/dist/cjs/api/resources/messages/resources/mms/index.js +1 -1
- package/dist/cjs/api/resources/messages/resources/mms/types/MmsSendResponse.d.ts +2 -5
- package/dist/cjs/api/resources/messages/resources/mms/types/MmsSendResponse.js +1 -3
- package/dist/cjs/api/resources/messages/resources/rcs/client/Client.d.ts +5 -26
- package/dist/cjs/api/resources/messages/resources/rcs/client/Client.js +26 -19
- package/dist/cjs/api/resources/messages/resources/rcs/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/messages/resources/rcs/client/requests/SendTypingIndicatorSchema.d.ts +0 -3
- package/dist/cjs/api/resources/messages/resources/rcs/client/requests/SendTypingIndicatorSchema.js +1 -3
- package/dist/cjs/api/resources/messages/resources/rcs/client/requests/index.d.ts +1 -1
- package/dist/cjs/api/resources/messages/resources/rcs/index.d.ts +1 -1
- package/dist/cjs/api/resources/messages/resources/rcs/index.js +1 -1
- package/dist/cjs/api/resources/messages/resources/rcs/types/SendRichMessageResponse.d.ts +2 -0
- package/dist/cjs/api/resources/messages/resources/rcs/types/SendRichMessageResponse.js +3 -0
- package/dist/cjs/api/resources/messages/resources/rcs/types/index.d.ts +1 -1
- package/dist/cjs/api/resources/messages/resources/rcs/types/index.js +1 -1
- package/dist/cjs/api/resources/messages/resources/sms/client/Client.d.ts +4 -25
- package/dist/cjs/api/resources/messages/resources/sms/client/Client.js +16 -14
- package/dist/cjs/api/resources/messages/resources/sms/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/messages/resources/sms/client/requests/Sms.d.ts +1 -4
- package/dist/cjs/api/resources/messages/resources/sms/client/requests/Sms.js +1 -3
- package/dist/cjs/api/resources/messages/resources/sms/client/requests/index.d.ts +1 -1
- package/dist/cjs/api/resources/messages/resources/sms/index.d.ts +1 -1
- package/dist/cjs/api/resources/messages/resources/sms/index.js +1 -1
- package/dist/cjs/api/resources/messages/resources/sms/types/SmsSendResponse.d.ts +2 -5
- package/dist/cjs/api/resources/messages/resources/sms/types/SmsSendResponse.js +1 -3
- package/dist/cjs/api/resources/phoneNumbers/client/Client.d.ts +5 -26
- package/dist/cjs/api/resources/phoneNumbers/client/Client.js +26 -22
- package/dist/cjs/api/resources/phoneNumbers/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/phoneNumbers/client/requests/BuyPhoneNumberParams.d.ts +0 -3
- package/dist/cjs/api/resources/phoneNumbers/client/requests/BuyPhoneNumberParams.js +1 -3
- package/dist/cjs/api/resources/phoneNumbers/client/requests/RetrievePhoneNumberDetailsParams.d.ts +1 -4
- package/dist/cjs/api/resources/phoneNumbers/client/requests/RetrievePhoneNumberDetailsParams.js +6 -3
- package/dist/cjs/api/resources/phoneNumbers/client/requests/SearchPhoneNumberParams.d.ts +1 -4
- package/dist/cjs/api/resources/phoneNumbers/client/requests/SearchPhoneNumberParams.js +1 -3
- package/dist/cjs/api/resources/phoneNumbers/client/requests/index.d.ts +3 -3
- package/dist/cjs/api/resources/phoneNumbers/index.d.ts +1 -1
- package/dist/cjs/api/resources/phoneNumbers/index.js +1 -1
- package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/Client.d.ts +4 -25
- package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/Client.js +16 -14
- package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/requests/AttachCampaignParams.d.ts +1 -4
- package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/requests/AttachCampaignParams.js +1 -3
- package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/requests/DetachCampaignParams.d.ts +0 -3
- package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/requests/DetachCampaignParams.js +1 -3
- package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/requests/index.d.ts +2 -2
- package/dist/cjs/api/resources/phoneNumbers/resources/index.d.ts +2 -2
- package/dist/cjs/api/resources/phoneNumbers/resources/index.js +6 -6
- package/dist/cjs/api/resources/phoneNumbers/resources/webhook/client/Client.d.ts +4 -25
- package/dist/cjs/api/resources/phoneNumbers/resources/webhook/client/Client.js +18 -16
- package/dist/cjs/api/resources/phoneNumbers/types/PhoneNumbersGetResponse.d.ts +1 -4
- package/dist/cjs/api/resources/phoneNumbers/types/PhoneNumbersGetResponse.js +1 -3
- package/dist/cjs/api/resources/rcs/client/Client.d.ts +4 -25
- package/dist/cjs/api/resources/rcs/client/Client.js +22 -18
- package/dist/cjs/api/resources/rcs/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/rcs/client/requests/RcsCapabilitiesQuery.d.ts +0 -3
- package/dist/cjs/api/resources/rcs/client/requests/RcsCapabilitiesQuery.js +1 -3
- package/dist/cjs/api/resources/rcs/client/requests/RcsLinkRequest.d.ts +0 -3
- package/dist/cjs/api/resources/rcs/client/requests/RcsLinkRequest.js +1 -3
- package/dist/cjs/api/resources/rcs/client/requests/RcsWhitelistRequest.d.ts +0 -3
- package/dist/cjs/api/resources/rcs/client/requests/RcsWhitelistRequest.js +1 -3
- package/dist/cjs/api/resources/rcs/client/requests/index.d.ts +3 -3
- package/dist/cjs/api/resources/status/client/Client.d.ts +2 -12
- package/dist/cjs/api/resources/status/client/Client.js +1 -3
- package/dist/cjs/api/resources/status/resources/get/client/Client.d.ts +4 -25
- package/dist/cjs/api/resources/status/resources/get/client/Client.js +39 -31
- package/dist/cjs/api/resources/tools/client/Client.d.ts +4 -14
- package/dist/cjs/api/resources/tools/client/Client.js +5 -7
- package/dist/cjs/api/resources/tools/resources/contactCard/client/Client.d.ts +4 -25
- package/dist/cjs/api/resources/tools/resources/contactCard/client/Client.js +16 -14
- package/dist/cjs/api/resources/tools/resources/contactCard/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/tools/resources/contactCard/client/requests/GetVcardParams.d.ts +0 -3
- package/dist/cjs/api/resources/tools/resources/contactCard/client/requests/GetVcardParams.js +1 -3
- package/dist/cjs/api/resources/tools/resources/contactCard/client/requests/UpsertVcardParams.d.ts +1 -4
- package/dist/cjs/api/resources/tools/resources/contactCard/client/requests/UpsertVcardParams.js +1 -3
- package/dist/cjs/api/resources/tools/resources/contactCard/client/requests/index.d.ts +2 -2
- package/dist/cjs/api/resources/tools/resources/file/client/Client.d.ts +4 -25
- package/dist/cjs/api/resources/tools/resources/file/client/Client.js +16 -14
- package/dist/cjs/api/resources/tools/resources/file/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/tools/resources/file/client/requests/RefreshFileParams.d.ts +0 -3
- package/dist/cjs/api/resources/tools/resources/file/client/requests/RefreshFileParams.js +1 -3
- package/dist/cjs/api/resources/tools/resources/file/client/requests/UploadFileParams.d.ts +0 -3
- package/dist/cjs/api/resources/tools/resources/file/client/requests/UploadFileParams.js +1 -3
- package/dist/cjs/api/resources/tools/resources/file/client/requests/index.d.ts +2 -2
- package/dist/cjs/api/resources/tools/resources/index.d.ts +4 -4
- package/dist/cjs/api/resources/tools/resources/index.js +8 -8
- package/dist/cjs/api/resources/tools/resources/url/client/Client.d.ts +4 -25
- package/dist/cjs/api/resources/tools/resources/url/client/Client.js +24 -20
- package/dist/cjs/api/resources/tools/resources/url/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/tools/resources/url/client/requests/CreateUrlParams.d.ts +1 -4
- package/dist/cjs/api/resources/tools/resources/url/client/requests/CreateUrlParams.js +1 -3
- package/dist/cjs/api/resources/tools/resources/url/client/requests/UpdateUrlParams.d.ts +1 -4
- package/dist/cjs/api/resources/tools/resources/url/client/requests/UpdateUrlParams.js +1 -3
- package/dist/cjs/api/resources/tools/resources/url/client/requests/index.d.ts +2 -2
- package/dist/cjs/api/resources/webhooks/client/Client.d.ts +4 -25
- package/dist/cjs/api/resources/webhooks/client/Client.js +10 -10
- package/dist/cjs/api/resources/webhooks/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/webhooks/client/requests/GetWebhookParams.d.ts +0 -3
- package/dist/cjs/api/resources/webhooks/client/requests/GetWebhookParams.js +1 -3
- package/dist/cjs/api/resources/webhooks/client/requests/index.d.ts +1 -1
- package/dist/cjs/api/types/AdvancedPhoneInformation.d.ts +2 -5
- package/dist/cjs/api/types/AdvancedPhoneInformation.js +7 -3
- package/dist/cjs/api/types/AttachWebhookParams.d.ts +1 -4
- package/dist/cjs/api/types/AttachWebhookParams.js +1 -3
- package/dist/cjs/api/types/AttachedPhoneNumberResult.d.ts +1 -4
- package/dist/cjs/api/types/AttachedPhoneNumberResult.js +1 -3
- package/dist/cjs/api/types/AudienceCountOnly.d.ts +14 -0
- package/dist/cjs/api/types/AudienceCountOnly.js +3 -0
- package/dist/cjs/api/types/AudienceWithPagination.d.ts +14 -0
- package/dist/cjs/api/types/AudienceWithPagination.js +3 -0
- package/dist/cjs/api/types/AutofillCampaignParams.d.ts +0 -3
- package/dist/cjs/api/types/AutofillCampaignParams.js +1 -3
- package/dist/cjs/api/types/AutofillDlcCampaignResponse.d.ts +1 -4
- package/dist/cjs/api/types/AutofillDlcCampaignResponse.js +1 -3
- package/dist/cjs/api/types/BadRequestErrorBody.d.ts +1 -4
- package/dist/cjs/api/types/BadRequestErrorBody.js +1 -3
- package/dist/cjs/api/types/BaseRichMessage.d.ts +9 -0
- package/dist/cjs/api/types/BaseRichMessage.js +3 -0
- package/dist/cjs/api/types/BasicPhoneInformation.d.ts +1 -4
- package/dist/cjs/api/types/BasicPhoneInformation.js +1 -3
- package/dist/cjs/api/types/BrandStatus.d.ts +1 -4
- package/dist/cjs/api/types/BrandStatus.js +1 -3
- package/dist/cjs/api/types/BrandStatusEnum.d.ts +1 -4
- package/dist/cjs/api/types/BrandStatusEnum.js +10 -3
- package/dist/cjs/api/types/ButtonClicked.d.ts +1 -4
- package/dist/cjs/api/types/ButtonClicked.js +1 -3
- package/dist/cjs/api/types/ButtonClickedData.d.ts +2 -5
- package/dist/cjs/api/types/ButtonClickedData.js +7 -3
- package/dist/cjs/api/types/CampaignEnum.d.ts +1 -4
- package/dist/cjs/api/types/CampaignEnum.js +7 -3
- package/dist/cjs/api/types/CampaignQuery.d.ts +1 -4
- package/dist/cjs/api/types/CampaignQuery.js +1 -3
- package/dist/cjs/api/types/CampaignSubmissionResult.d.ts +0 -3
- package/dist/cjs/api/types/CampaignSubmissionResult.js +1 -3
- package/dist/cjs/api/types/CampaignValidationResult.d.ts +0 -3
- package/dist/cjs/api/types/CampaignValidationResult.js +1 -3
- package/dist/cjs/api/types/CancelScheduledMessageResponse.d.ts +4 -0
- package/dist/cjs/api/types/CancelScheduledMessageResponse.js +3 -0
- package/dist/cjs/api/types/CompanyEntityTypeEnum.d.ts +9 -0
- package/dist/cjs/api/types/CompanyEntityTypeEnum.js +12 -0
- package/dist/cjs/api/types/CompanySectorEnum.d.ts +2 -7
- package/dist/cjs/api/types/CompanySectorEnum.js +2 -3
- package/dist/cjs/api/types/CompanyTypeEnum.d.ts +2 -7
- package/dist/cjs/api/types/CompanyTypeEnum.js +2 -3
- package/dist/cjs/api/types/ConfiguredWebhook.d.ts +1 -4
- package/dist/cjs/api/types/ConfiguredWebhook.js +1 -3
- package/dist/cjs/api/types/Contact.d.ts +0 -3
- package/dist/cjs/api/types/Contact.js +1 -3
- package/dist/cjs/api/types/ContactId.d.ts +0 -3
- package/dist/cjs/api/types/ContactId.js +1 -3
- package/dist/cjs/api/types/Conversation.d.ts +1 -4
- package/dist/cjs/api/types/Conversation.js +1 -3
- package/dist/cjs/api/types/ConversationList.d.ts +1 -4
- package/dist/cjs/api/types/ConversationList.js +1 -3
- package/dist/cjs/api/types/CreateUrlOptions.d.ts +0 -3
- package/dist/cjs/api/types/CreateUrlOptions.js +1 -3
- package/dist/cjs/api/types/DeleteAudienceResponse.d.ts +4 -0
- package/dist/cjs/api/types/DeleteAudienceResponse.js +3 -0
- package/dist/cjs/api/types/DetachedPhoneNumberResult.d.ts +1 -4
- package/dist/cjs/api/types/DetachedPhoneNumberResult.js +1 -3
- package/dist/cjs/api/types/DetachedWebhookInfo.d.ts +0 -3
- package/dist/cjs/api/types/DetachedWebhookInfo.js +1 -3
- package/dist/cjs/api/types/DetailedPhoneNumberEnum.d.ts +1 -4
- package/dist/cjs/api/types/DetailedPhoneNumberEnum.js +7 -3
- package/dist/cjs/api/types/DlcAssignmentStatusEnum.d.ts +1 -4
- package/dist/cjs/api/types/DlcAssignmentStatusEnum.js +10 -3
- package/dist/cjs/api/types/DlcCampaignStatus.d.ts +1 -4
- package/dist/cjs/api/types/DlcCampaignStatus.js +1 -3
- package/dist/cjs/api/types/DlcCampaignUseCaseEnum.d.ts +2 -7
- package/dist/cjs/api/types/DlcCampaignUseCaseEnum.js +2 -3
- package/dist/cjs/api/types/DlcCampaignWithExtendedBrandAndStatus.d.ts +1 -4
- package/dist/cjs/api/types/DlcCampaignWithExtendedBrandAndStatus.js +1 -3
- package/dist/cjs/api/types/EnhancedContact.d.ts +1 -4
- package/dist/cjs/api/types/EnhancedContact.js +1 -3
- package/dist/cjs/api/types/EnhancedContactItem.d.ts +0 -3
- package/dist/cjs/api/types/EnhancedContactItem.js +1 -3
- package/dist/cjs/api/types/Error_.d.ts +0 -3
- package/dist/cjs/api/types/Error_.js +1 -3
- package/dist/cjs/api/types/ExtendedBrand.d.ts +1 -4
- package/dist/cjs/api/types/ExtendedBrand.js +1 -3
- package/dist/cjs/api/types/ExtendedBrandWithVetting.d.ts +1 -4
- package/dist/cjs/api/types/ExtendedBrandWithVetting.js +1 -3
- package/dist/cjs/api/types/ExtendedRcsCampaign.d.ts +55 -30
- package/dist/cjs/api/types/ExtendedRcsCampaign.js +1 -3
- package/dist/cjs/api/types/GetConversationParams.d.ts +0 -3
- package/dist/cjs/api/types/GetConversationParams.js +1 -3
- package/dist/cjs/api/types/LinkClickEvent.d.ts +0 -3
- package/dist/cjs/api/types/LinkClickEvent.js +1 -3
- package/dist/cjs/api/types/LocationShareAction.d.ts +0 -3
- package/dist/cjs/api/types/LocationShareAction.js +1 -3
- package/dist/cjs/api/types/Message.d.ts +1 -4
- package/dist/cjs/api/types/Message.js +1 -3
- package/dist/cjs/api/types/MessageContent.d.ts +1 -4
- package/dist/cjs/api/types/MessageContent.js +1 -3
- package/dist/cjs/api/types/MessageEvent.d.ts +3 -8
- package/dist/cjs/api/types/MessageEvent.js +2 -3
- package/dist/cjs/api/types/MessageEventContent.d.ts +1 -4
- package/dist/cjs/api/types/MessageEventContent.js +1 -3
- package/dist/cjs/api/types/MessageEventMmsContent.d.ts +0 -3
- package/dist/cjs/api/types/MessageEventMmsContent.js +1 -3
- package/dist/cjs/api/types/MessageEventRcsButtonData.d.ts +1 -4
- package/dist/cjs/api/types/MessageEventRcsButtonData.js +1 -3
- package/dist/cjs/api/types/MessageEventRcsCardsContent.d.ts +1 -4
- package/dist/cjs/api/types/MessageEventRcsCardsContent.js +1 -3
- package/dist/cjs/api/types/MessageEventRcsLocationData.d.ts +1 -4
- package/dist/cjs/api/types/MessageEventRcsLocationData.js +1 -3
- package/dist/cjs/api/types/MessageEventRcsMediaContent.d.ts +1 -4
- package/dist/cjs/api/types/MessageEventRcsMediaContent.js +1 -3
- package/dist/cjs/api/types/MessageEventRcsTextContent.d.ts +1 -4
- package/dist/cjs/api/types/MessageEventRcsTextContent.js +1 -3
- package/dist/cjs/api/types/MessageEventSmsContent.d.ts +0 -3
- package/dist/cjs/api/types/MessageEventSmsContent.js +1 -3
- package/dist/cjs/api/types/MessageList.d.ts +1 -4
- package/dist/cjs/api/types/MessageList.js +1 -3
- package/dist/cjs/api/types/MessageMethodEnum.d.ts +2 -7
- package/dist/cjs/api/types/MessageMethodEnum.js +2 -3
- package/dist/cjs/api/types/MessageProtocolEnum.d.ts +2 -7
- package/dist/cjs/api/types/MessageProtocolEnum.js +2 -3
- package/dist/cjs/api/types/MessageSchedule.d.ts +7 -4
- package/dist/cjs/api/types/MessageSchedule.js +1 -3
- package/dist/cjs/api/types/MessageStatusEnum.d.ts +2 -7
- package/dist/cjs/api/types/MessageStatusEnum.js +2 -3
- package/dist/cjs/api/types/MessageVolumeEnum.d.ts +2 -7
- package/dist/cjs/api/types/MessageVolumeEnum.js +2 -3
- package/dist/cjs/api/types/MessageWithReaction.d.ts +3 -8
- package/dist/cjs/api/types/MessageWithReaction.js +2 -3
- package/dist/cjs/api/types/MessagingProfileEnum.d.ts +2 -7
- package/dist/cjs/api/types/MessagingProfileEnum.js +2 -3
- package/dist/cjs/api/types/MmsContent.d.ts +0 -3
- package/dist/cjs/api/types/MmsContent.js +1 -3
- package/dist/cjs/api/types/MmsValidationResult.d.ts +0 -3
- package/dist/cjs/api/types/MmsValidationResult.js +1 -3
- package/dist/cjs/api/types/NotFoundErrorBody.d.ts +0 -3
- package/dist/cjs/api/types/NotFoundErrorBody.js +1 -3
- package/dist/cjs/api/types/NumberFormat.d.ts +0 -3
- package/dist/cjs/api/types/NumberFormat.js +1 -3
- package/dist/cjs/api/types/OptInMethodEnum.d.ts +2 -7
- package/dist/cjs/api/types/OptInMethodEnum.js +2 -3
- package/dist/cjs/api/types/OptionalBrandInfo.d.ts +3 -4
- package/dist/cjs/api/types/OptionalBrandInfo.js +1 -3
- package/dist/cjs/api/types/OptionalContact.d.ts +0 -3
- package/dist/cjs/api/types/OptionalContact.js +1 -3
- package/dist/cjs/api/types/OptionalContacts.d.ts +0 -3
- package/dist/cjs/api/types/OptionalContacts.js +1 -3
- package/dist/cjs/api/types/Pagination.d.ts +10 -0
- package/dist/cjs/api/types/Pagination.js +3 -0
- package/dist/cjs/api/types/PhoneCapabilities.d.ts +0 -3
- package/dist/cjs/api/types/PhoneCapabilities.js +1 -3
- package/dist/cjs/api/types/PhoneEnum.d.ts +1 -4
- package/dist/cjs/api/types/PhoneEnum.js +6 -3
- package/dist/cjs/api/types/PhoneFeatureEnum.d.ts +1 -4
- package/dist/cjs/api/types/PhoneFeatureEnum.js +6 -3
- package/dist/cjs/api/types/PhoneNumberDetails.d.ts +1 -4
- package/dist/cjs/api/types/PhoneNumberDetails.js +1 -3
- package/dist/cjs/api/types/PhoneNumberEnum.d.ts +1 -4
- package/dist/cjs/api/types/PhoneNumberEnum.js +6 -3
- package/dist/cjs/api/types/PhoneNumberStatus.d.ts +1 -4
- package/dist/cjs/api/types/PhoneNumberStatus.js +1 -3
- package/dist/cjs/api/types/PhoneNumberStatusEnum.d.ts +1 -4
- package/dist/cjs/api/types/PhoneNumberStatusEnum.js +8 -3
- package/dist/cjs/api/types/ProfileStatusEnum.d.ts +1 -4
- package/dist/cjs/api/types/ProfileStatusEnum.js +12 -3
- package/dist/cjs/api/types/PurchasedNumber.d.ts +0 -3
- package/dist/cjs/api/types/PurchasedNumber.js +1 -3
- package/dist/cjs/api/types/RcsButtonCall.d.ts +0 -3
- package/dist/cjs/api/types/RcsButtonCall.js +1 -3
- package/dist/cjs/api/types/RcsButtonOpenUrl.d.ts +1 -4
- package/dist/cjs/api/types/RcsButtonOpenUrl.js +11 -3
- package/dist/cjs/api/types/RcsButtonRequestUserLocation.d.ts +0 -3
- package/dist/cjs/api/types/RcsButtonRequestUserLocation.js +1 -3
- package/dist/cjs/api/types/RcsButtonScheduleEvent.d.ts +0 -3
- package/dist/cjs/api/types/RcsButtonScheduleEvent.js +1 -3
- package/dist/cjs/api/types/RcsButtonSendLocation.d.ts +0 -3
- package/dist/cjs/api/types/RcsButtonSendLocation.js +1 -3
- package/dist/cjs/api/types/RcsButtonTrigger.d.ts +0 -3
- package/dist/cjs/api/types/RcsButtonTrigger.js +1 -3
- package/dist/cjs/api/types/RcsCampaign.d.ts +55 -28
- package/dist/cjs/api/types/RcsCampaign.js +1 -3
- package/dist/cjs/api/types/RcsCampaignStatus.d.ts +1 -4
- package/dist/cjs/api/types/RcsCampaignStatus.js +1 -3
- package/dist/cjs/api/types/RcsCampaignUseCaseEnum.d.ts +2 -7
- package/dist/cjs/api/types/RcsCampaignUseCaseEnum.js +2 -3
- package/dist/cjs/api/types/RcsCapabilitiesResult.d.ts +1 -4
- package/dist/cjs/api/types/RcsCapabilitiesResult.js +1 -3
- package/dist/cjs/api/types/RcsCapability.d.ts +0 -3
- package/dist/cjs/api/types/RcsCapability.js +1 -3
- package/dist/cjs/api/types/RcsCardsContent.d.ts +2 -5
- package/dist/cjs/api/types/RcsCardsContent.js +1 -3
- package/dist/cjs/api/types/RcsContent.d.ts +2 -5
- package/dist/cjs/api/types/RcsContent.js +1 -3
- package/dist/cjs/api/types/RcsLinkResult.d.ts +0 -3
- package/dist/cjs/api/types/RcsLinkResult.js +1 -3
- package/dist/cjs/api/types/RcsMediaContent.d.ts +1 -4
- package/dist/cjs/api/types/RcsMediaContent.js +1 -3
- package/dist/cjs/api/types/RcsMediaDetailsContent.d.ts +0 -3
- package/dist/cjs/api/types/RcsMediaDetailsContent.js +1 -3
- package/dist/cjs/api/types/RcsMessagingTypeEnum.d.ts +15 -0
- package/dist/cjs/api/types/RcsMessagingTypeEnum.js +18 -0
- package/dist/cjs/api/types/RcsValidateContent.d.ts +3 -6
- package/dist/cjs/api/types/RcsValidateContent.js +1 -3
- package/dist/cjs/api/types/RcsValidationResult.d.ts +2 -3
- package/dist/cjs/api/types/RcsValidationResult.js +1 -3
- package/dist/cjs/api/types/RcsWhitelistResponse.d.ts +0 -3
- package/dist/cjs/api/types/RcsWhitelistResponse.js +1 -3
- package/dist/cjs/api/types/ReactionResult.d.ts +0 -3
- package/dist/cjs/api/types/ReactionResult.js +1 -3
- package/dist/cjs/api/types/RefreshedFile.d.ts +0 -3
- package/dist/cjs/api/types/RefreshedFile.js +1 -3
- package/dist/cjs/api/types/RichButton.d.ts +1 -4
- package/dist/cjs/api/types/RichButton.js +1 -3
- package/dist/cjs/api/types/{RcsCards.d.ts → RichCards.d.ts} +5 -8
- package/dist/cjs/api/types/RichCards.js +3 -0
- package/dist/cjs/api/types/RichCardsMessage.d.ts +11 -16
- package/dist/cjs/api/types/RichCardsMessage.js +3 -3
- package/dist/cjs/api/types/RichMediaMessage.d.ts +2 -5
- package/dist/cjs/api/types/RichMediaMessage.js +1 -3
- package/dist/cjs/api/types/RichMessage.d.ts +5 -5
- package/dist/cjs/api/types/RichMessage.js +1 -3
- package/dist/cjs/api/types/{RcsTextContent.d.ts → RichText.d.ts} +2 -5
- package/dist/cjs/api/types/RichText.js +3 -0
- package/dist/cjs/api/types/RichTextMessage.d.ts +2 -5
- package/dist/cjs/api/types/RichTextMessage.js +1 -3
- package/dist/{esm/api/types/ScheduledMessaage.d.mts → cjs/api/types/ScheduledMessage.d.ts} +3 -6
- package/dist/cjs/api/types/ScheduledMessage.js +3 -0
- package/dist/cjs/api/types/{Options.d.ts → SendRichMessageOptions.d.ts} +2 -5
- package/dist/cjs/api/types/SendRichMessageOptions.js +3 -0
- package/dist/cjs/api/types/SendTypingIndicatorResponse.d.ts +0 -3
- package/dist/cjs/api/types/SendTypingIndicatorResponse.js +1 -3
- package/dist/cjs/api/types/Sender.d.ts +0 -3
- package/dist/cjs/api/types/Sender.js +1 -3
- package/dist/cjs/api/types/SentMmsDetails.d.ts +5 -4
- package/dist/cjs/api/types/SentMmsDetails.js +1 -3
- package/dist/{esm/api/types/SentRcsDetails.d.mts → cjs/api/types/SentRichMessage.d.ts} +1 -4
- package/dist/cjs/api/types/SentRichMessage.js +3 -0
- package/dist/cjs/api/types/SentSmsDetails.d.ts +2 -7
- package/dist/cjs/api/types/SentSmsDetails.js +2 -3
- package/dist/cjs/api/types/ShortenedUrl.d.ts +0 -3
- package/dist/cjs/api/types/ShortenedUrl.js +1 -3
- package/dist/cjs/api/types/ShortenedUrlWithClickData.d.ts +1 -4
- package/dist/cjs/api/types/ShortenedUrlWithClickData.js +1 -3
- package/dist/cjs/api/types/SmsContent.d.ts +0 -3
- package/dist/cjs/api/types/SmsContent.js +1 -3
- package/dist/cjs/api/types/SmsValidationResult.d.ts +0 -3
- package/dist/cjs/api/types/SmsValidationResult.js +1 -3
- package/dist/cjs/api/types/SubUseCaseEnum.d.ts +2 -7
- package/dist/cjs/api/types/SubUseCaseEnum.js +2 -3
- package/dist/cjs/api/types/SubmissionResults.d.ts +0 -3
- package/dist/cjs/api/types/SubmissionResults.js +1 -3
- package/dist/cjs/api/types/SuccessfulConversationUpdate.d.ts +0 -3
- package/dist/cjs/api/types/SuccessfulConversationUpdate.js +1 -3
- package/dist/cjs/api/types/TollFreeCampaign.d.ts +50 -4
- package/dist/cjs/api/types/TollFreeCampaign.js +1 -3
- package/dist/cjs/api/types/TollFreeCampaignStatus.d.ts +1 -4
- package/dist/cjs/api/types/TollFreeCampaignStatus.js +1 -3
- package/dist/cjs/api/types/TollFreeCampaignUseCaseEnum.d.ts +2 -7
- package/dist/cjs/api/types/TollFreeCampaignUseCaseEnum.js +2 -3
- package/dist/cjs/api/types/TollFreeCampaignWithExtendedBrandAndStatus.d.ts +1 -4
- package/dist/cjs/api/types/TollFreeCampaignWithExtendedBrandAndStatus.js +1 -3
- package/dist/cjs/api/types/TollFreeStatusEnum.d.ts +1 -4
- package/dist/cjs/api/types/TollFreeStatusEnum.js +10 -3
- package/dist/cjs/api/types/Tracking.d.ts +1 -4
- package/dist/cjs/api/types/Tracking.js +8 -3
- package/dist/cjs/api/types/UpdatedContactId.d.ts +0 -3
- package/dist/cjs/api/types/UpdatedContactId.js +1 -3
- package/dist/cjs/api/types/UploadResults.d.ts +0 -3
- package/dist/cjs/api/types/UploadResults.js +1 -3
- package/dist/cjs/api/types/UpsertContact.d.ts +0 -3
- package/dist/cjs/api/types/UpsertContact.js +1 -3
- package/dist/cjs/api/types/UserEvent.d.ts +0 -3
- package/dist/cjs/api/types/UserEvent.js +1 -3
- package/dist/cjs/api/types/VCardData.d.ts +1 -4
- package/dist/cjs/api/types/VCardData.js +1 -3
- package/dist/cjs/api/types/ValidateCampaignParams.d.ts +0 -3
- package/dist/cjs/api/types/ValidateCampaignParams.js +1 -3
- package/dist/cjs/api/types/ValidationErrorDetails.d.ts +0 -3
- package/dist/cjs/api/types/ValidationErrorDetails.js +1 -3
- package/dist/cjs/api/types/ValidationResults.d.ts +1 -4
- package/dist/cjs/api/types/ValidationResults.js +1 -3
- package/dist/cjs/api/types/Vcard.d.ts +1 -4
- package/dist/cjs/api/types/Vcard.js +1 -3
- package/dist/cjs/api/types/VcardAddress.d.ts +1 -4
- package/dist/cjs/api/types/VcardAddress.js +1 -3
- package/dist/cjs/api/types/VcardContent.d.ts +1 -4
- package/dist/cjs/api/types/VcardContent.js +1 -3
- package/dist/cjs/api/types/VcardEmail.d.ts +1 -4
- package/dist/cjs/api/types/VcardEmail.js +1 -3
- package/dist/cjs/api/types/VcardPhone.d.ts +1 -4
- package/dist/cjs/api/types/VcardPhone.js +1 -3
- package/dist/cjs/api/types/VcardResource.d.ts +0 -3
- package/dist/cjs/api/types/VcardResource.js +1 -3
- package/dist/cjs/api/types/VettingFeedback.d.ts +0 -3
- package/dist/cjs/api/types/VettingFeedback.js +1 -3
- package/dist/cjs/api/types/VettingHistory.d.ts +2 -7
- package/dist/cjs/api/types/VettingHistory.js +2 -3
- package/dist/cjs/api/types/VettingResults.d.ts +0 -3
- package/dist/cjs/api/types/VettingResults.js +1 -3
- package/dist/cjs/api/types/WebhookEventEnum.d.ts +1 -4
- package/dist/cjs/api/types/WebhookEventEnum.js +6 -3
- package/dist/cjs/api/types/WebhookResult.d.ts +1 -4
- package/dist/cjs/api/types/WebhookResult.js +1 -3
- package/dist/cjs/api/types/Webhooks.d.ts +0 -3
- package/dist/cjs/api/types/Webhooks.js +1 -3
- package/dist/cjs/api/types/ZodError.d.ts +0 -3
- package/dist/cjs/api/types/ZodError.js +1 -3
- package/dist/cjs/api/types/index.d.ts +125 -119
- package/dist/cjs/api/types/index.js +125 -119
- package/dist/cjs/core/exports.d.ts +1 -0
- package/dist/cjs/core/exports.js +17 -0
- package/dist/cjs/core/fetcher/APIResponse.d.ts +1 -1
- package/dist/cjs/core/fetcher/BinaryResponse.d.ts +1 -1
- package/dist/cjs/core/fetcher/EndpointMetadata.d.ts +13 -0
- package/dist/cjs/core/fetcher/EndpointMetadata.js +2 -0
- package/dist/cjs/core/fetcher/EndpointSupplier.d.ts +12 -0
- package/dist/cjs/core/fetcher/EndpointSupplier.js +22 -0
- package/dist/cjs/core/fetcher/Fetcher.d.ts +9 -4
- package/dist/cjs/core/fetcher/Fetcher.js +205 -10
- package/dist/cjs/core/fetcher/HttpResponsePromise.d.ts +1 -1
- package/dist/cjs/core/fetcher/getErrorResponseBody.js +2 -1
- package/dist/cjs/core/fetcher/getRequestBody.d.ts +1 -1
- package/dist/cjs/core/fetcher/getRequestBody.js +4 -0
- package/dist/cjs/core/fetcher/getResponseBody.js +3 -3
- package/dist/cjs/core/fetcher/index.d.ts +2 -0
- package/dist/cjs/core/fetcher/index.js +3 -1
- package/dist/cjs/core/fetcher/makeRequest.d.ts +1 -1
- package/dist/cjs/core/fetcher/makeRequest.js +2 -4
- package/dist/cjs/core/fetcher/requestWithRetries.js +16 -21
- package/dist/cjs/core/fetcher/signals.d.ts +0 -6
- package/dist/cjs/core/fetcher/signals.js +0 -12
- package/dist/cjs/core/headers.d.ts +2 -3
- package/dist/cjs/core/headers.js +6 -4
- package/dist/cjs/core/index.d.ts +1 -0
- package/dist/cjs/core/index.js +2 -1
- package/dist/cjs/core/logging/exports.d.ts +18 -0
- package/dist/cjs/core/logging/exports.js +45 -0
- package/dist/cjs/core/logging/index.d.ts +1 -0
- package/dist/cjs/core/logging/index.js +17 -0
- package/dist/cjs/core/logging/logger.d.ts +126 -0
- package/dist/cjs/core/logging/logger.js +144 -0
- package/dist/cjs/core/url/encodePathParam.d.ts +1 -0
- package/dist/cjs/core/url/encodePathParam.js +21 -0
- package/dist/cjs/core/url/index.d.ts +1 -0
- package/dist/cjs/core/url/index.js +3 -1
- package/dist/cjs/core/url/join.js +3 -4
- package/dist/cjs/environments.d.ts +0 -3
- package/dist/cjs/environments.js +1 -3
- package/dist/cjs/errors/PinnacleError.d.ts +1 -4
- package/dist/cjs/errors/PinnacleError.js +2 -4
- package/dist/cjs/errors/PinnacleTimeoutError.d.ts +0 -3
- package/dist/cjs/errors/PinnacleTimeoutError.js +1 -3
- package/dist/cjs/exports.d.ts +1 -0
- package/dist/cjs/exports.js +17 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/cjs/wrapper/tools/FileUploader.d.ts +1 -1
- package/dist/esm/BaseClient.d.mts +30 -0
- package/dist/esm/BaseClient.mjs +2 -0
- package/dist/esm/Client.d.mts +8 -25
- package/dist/esm/Client.mjs +13 -10
- package/dist/esm/api/errors/BadRequestError.d.mts +1 -4
- package/dist/esm/api/errors/BadRequestError.mjs +1 -3
- package/dist/esm/api/errors/InternalServerError.d.mts +2 -5
- package/dist/esm/api/errors/InternalServerError.mjs +1 -3
- package/dist/esm/api/errors/NotFoundError.d.mts +1 -4
- package/dist/esm/api/errors/NotFoundError.mjs +1 -3
- package/dist/esm/api/errors/NotImplementedError.d.mts +2 -5
- package/dist/esm/api/errors/NotImplementedError.mjs +1 -3
- package/dist/esm/api/errors/PaymentRequiredError.d.mts +2 -5
- package/dist/esm/api/errors/PaymentRequiredError.mjs +1 -3
- package/dist/esm/api/errors/UnauthorizedError.d.mts +2 -5
- package/dist/esm/api/errors/UnauthorizedError.mjs +1 -3
- package/dist/esm/api/errors/index.d.mts +2 -2
- package/dist/esm/api/errors/index.mjs +2 -2
- package/dist/esm/api/index.d.mts +1 -1
- package/dist/esm/api/index.mjs +1 -1
- package/dist/esm/api/resources/audiences/client/Client.d.mts +108 -0
- package/dist/esm/api/resources/audiences/client/Client.mjs +354 -0
- package/dist/esm/api/resources/audiences/client/index.d.mts +1 -0
- package/dist/esm/api/resources/audiences/client/index.mjs +1 -0
- package/dist/esm/api/resources/audiences/client/requests/AudiencesDeleteRequest.d.mts +10 -0
- package/dist/esm/api/resources/audiences/client/requests/AudiencesDeleteRequest.mjs +2 -0
- package/dist/esm/api/resources/audiences/client/requests/AudiencesGetRequest.d.mts +19 -0
- package/dist/esm/api/resources/audiences/client/requests/AudiencesGetRequest.mjs +2 -0
- package/dist/esm/api/resources/audiences/client/requests/CreateAudienceParams.d.mts +28 -0
- package/dist/esm/api/resources/audiences/client/requests/CreateAudienceParams.mjs +2 -0
- package/dist/esm/api/resources/audiences/client/requests/UpdateAudienceParams.d.mts +16 -0
- package/dist/esm/api/resources/audiences/client/requests/UpdateAudienceParams.mjs +2 -0
- package/dist/esm/api/resources/audiences/client/requests/index.d.mts +4 -0
- package/dist/esm/api/resources/audiences/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/audiences/index.d.mts +3 -0
- package/dist/esm/api/resources/audiences/index.mjs +3 -0
- package/dist/esm/api/resources/audiences/resources/contacts/client/Client.d.mts +59 -0
- package/dist/esm/api/resources/audiences/resources/contacts/client/Client.mjs +185 -0
- package/dist/esm/api/resources/audiences/resources/contacts/client/index.d.mts +1 -0
- package/dist/esm/api/resources/audiences/resources/contacts/client/index.mjs +1 -0
- package/dist/esm/api/resources/audiences/resources/contacts/client/requests/AddContactsParams.d.mts +13 -0
- package/dist/esm/api/resources/audiences/resources/contacts/client/requests/AddContactsParams.mjs +2 -0
- package/dist/esm/api/resources/audiences/resources/contacts/client/requests/RemoveContactsParams.d.mts +13 -0
- package/dist/esm/api/resources/audiences/resources/contacts/client/requests/RemoveContactsParams.mjs +2 -0
- package/dist/esm/api/resources/audiences/resources/contacts/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/audiences/resources/contacts/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/audiences/resources/contacts/index.d.mts +1 -0
- package/dist/esm/api/resources/audiences/resources/contacts/index.mjs +1 -0
- package/dist/esm/api/resources/audiences/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/audiences/resources/index.mjs +2 -0
- package/dist/esm/api/resources/audiences/types/AudiencesGetResponse.d.mts +8 -0
- package/dist/esm/api/resources/audiences/types/AudiencesGetResponse.mjs +2 -0
- package/dist/esm/api/resources/audiences/types/index.d.mts +1 -0
- package/dist/esm/api/resources/audiences/types/index.mjs +1 -0
- package/dist/esm/api/resources/brands/client/Client.d.mts +6 -25
- package/dist/esm/api/resources/brands/client/Client.mjs +46 -34
- package/dist/esm/api/resources/brands/client/index.d.mts +0 -1
- package/dist/esm/api/resources/brands/client/requests/AutofillBrandParams.d.mts +0 -3
- package/dist/esm/api/resources/brands/client/requests/AutofillBrandParams.mjs +1 -3
- package/dist/esm/api/resources/brands/client/requests/BrandsGetRequest.d.mts +0 -3
- package/dist/esm/api/resources/brands/client/requests/BrandsGetRequest.mjs +1 -3
- package/dist/esm/api/resources/brands/client/requests/UpsertBrandParams.d.mts +4 -4
- package/dist/esm/api/resources/brands/client/requests/UpsertBrandParams.mjs +1 -3
- package/dist/esm/api/resources/brands/client/requests/ValidateBrandParams.d.mts +4 -4
- package/dist/esm/api/resources/brands/client/requests/ValidateBrandParams.mjs +1 -3
- package/dist/esm/api/resources/brands/client/requests/VetBrandParams.d.mts +1 -5
- package/dist/esm/api/resources/brands/client/requests/VetBrandParams.mjs +1 -3
- package/dist/esm/api/resources/brands/client/requests/index.d.mts +5 -5
- package/dist/esm/api/resources/campaigns/client/Client.d.mts +3 -13
- package/dist/esm/api/resources/campaigns/client/Client.mjs +2 -4
- package/dist/esm/api/resources/campaigns/index.d.mts +1 -1
- package/dist/esm/api/resources/campaigns/index.mjs +1 -1
- package/dist/esm/api/resources/campaigns/resources/dlc/client/Client.d.mts +4 -25
- package/dist/esm/api/resources/campaigns/resources/dlc/client/Client.mjs +36 -28
- package/dist/esm/api/resources/campaigns/resources/dlc/client/index.d.mts +0 -1
- package/dist/esm/api/resources/campaigns/resources/dlc/client/requests/UpsertDlcCampaignParams.d.mts +1 -4
- package/dist/esm/api/resources/campaigns/resources/dlc/client/requests/UpsertDlcCampaignParams.mjs +1 -3
- package/dist/esm/api/resources/campaigns/resources/dlc/client/requests/index.d.mts +1 -1
- package/dist/esm/api/resources/campaigns/resources/index.d.mts +5 -5
- package/dist/esm/api/resources/campaigns/resources/index.mjs +5 -5
- package/dist/esm/api/resources/campaigns/resources/rcs/client/Client.d.mts +36 -40
- package/dist/esm/api/resources/campaigns/resources/rcs/client/Client.mjs +68 -43
- package/dist/esm/api/resources/campaigns/resources/rcs/client/index.d.mts +0 -1
- package/dist/esm/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.mts +112 -49
- package/dist/esm/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.mjs +1 -3
- package/dist/esm/api/resources/campaigns/resources/rcs/client/requests/index.d.mts +1 -1
- package/dist/esm/api/resources/campaigns/resources/rcs/index.d.mts +1 -1
- package/dist/esm/api/resources/campaigns/resources/rcs/index.mjs +1 -1
- package/dist/esm/api/resources/campaigns/resources/rcs/types/RcsAutofillResponse.d.mts +1 -4
- package/dist/esm/api/resources/campaigns/resources/rcs/types/RcsAutofillResponse.mjs +1 -3
- package/dist/esm/api/resources/campaigns/resources/tollFree/client/Client.d.mts +20 -25
- package/dist/esm/api/resources/campaigns/resources/tollFree/client/Client.mjs +52 -28
- package/dist/esm/api/resources/campaigns/resources/tollFree/client/index.d.mts +0 -1
- package/dist/esm/api/resources/campaigns/resources/tollFree/client/requests/UpsertTollFreeCampaignParams.d.mts +66 -4
- package/dist/esm/api/resources/campaigns/resources/tollFree/client/requests/UpsertTollFreeCampaignParams.mjs +1 -3
- package/dist/esm/api/resources/campaigns/resources/tollFree/client/requests/index.d.mts +1 -1
- package/dist/esm/api/resources/campaigns/resources/tollFree/index.d.mts +1 -1
- package/dist/esm/api/resources/campaigns/resources/tollFree/index.mjs +1 -1
- package/dist/esm/api/resources/campaigns/resources/tollFree/types/TollFreeAutofillResponse.d.mts +1 -4
- package/dist/esm/api/resources/campaigns/resources/tollFree/types/TollFreeAutofillResponse.mjs +1 -3
- package/dist/esm/api/resources/contacts/client/Client.d.mts +4 -25
- package/dist/esm/api/resources/contacts/client/Client.mjs +24 -20
- package/dist/esm/api/resources/contacts/client/index.d.mts +0 -1
- package/dist/esm/api/resources/contacts/client/requests/ContactsGetRequest.d.mts +0 -3
- package/dist/esm/api/resources/contacts/client/requests/ContactsGetRequest.mjs +1 -3
- package/dist/esm/api/resources/contacts/client/requests/CreateContactParams.d.mts +1 -4
- package/dist/esm/api/resources/contacts/client/requests/CreateContactParams.mjs +1 -3
- package/dist/esm/api/resources/contacts/client/requests/UpdateContactParams.d.mts +1 -4
- package/dist/esm/api/resources/contacts/client/requests/UpdateContactParams.mjs +1 -3
- package/dist/esm/api/resources/contacts/client/requests/index.d.mts +3 -3
- package/dist/esm/api/resources/conversations/client/Client.d.mts +4 -25
- package/dist/esm/api/resources/conversations/client/Client.mjs +37 -31
- package/dist/esm/api/resources/conversations/client/index.d.mts +0 -1
- package/dist/esm/api/resources/conversations/client/requests/ConversationsListMessagesRequest.d.mts +1 -4
- package/dist/esm/api/resources/conversations/client/requests/ConversationsListMessagesRequest.mjs +1 -3
- package/dist/esm/api/resources/conversations/client/requests/ListConversationsParams.d.mts +1 -4
- package/dist/esm/api/resources/conversations/client/requests/ListConversationsParams.mjs +1 -3
- package/dist/esm/api/resources/conversations/client/requests/UpdateConversationParams.d.mts +0 -3
- package/dist/esm/api/resources/conversations/client/requests/UpdateConversationParams.mjs +1 -3
- package/dist/esm/api/resources/conversations/client/requests/index.d.mts +3 -3
- package/dist/esm/api/resources/conversations/index.d.mts +1 -1
- package/dist/esm/api/resources/conversations/index.mjs +1 -1
- package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestDirection.d.mts +1 -4
- package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestDirection.mjs +1 -3
- package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestSortOrder.d.mts +1 -4
- package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestSortOrder.mjs +1 -3
- package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestStatus.d.mts +1 -4
- package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestStatus.mjs +1 -3
- package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestType.d.mts +1 -4
- package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestType.mjs +1 -3
- package/dist/esm/api/resources/conversations/types/index.d.mts +1 -1
- package/dist/esm/api/resources/conversations/types/index.mjs +1 -1
- package/dist/esm/api/resources/index.d.mts +14 -11
- package/dist/esm/api/resources/index.mjs +14 -11
- package/dist/esm/api/resources/messages/client/Client.d.mts +26 -26
- package/dist/esm/api/resources/messages/client/Client.mjs +96 -16
- package/dist/esm/api/resources/messages/client/index.d.mts +0 -1
- package/dist/esm/api/resources/messages/client/requests/ReactMessageParams.d.mts +0 -3
- package/dist/esm/api/resources/messages/client/requests/ReactMessageParams.mjs +1 -3
- package/dist/esm/api/resources/messages/client/requests/index.d.mts +1 -1
- package/dist/esm/api/resources/messages/index.d.mts +1 -1
- package/dist/esm/api/resources/messages/index.mjs +1 -1
- package/dist/esm/api/resources/messages/resources/index.d.mts +4 -4
- package/dist/esm/api/resources/messages/resources/index.mjs +4 -4
- package/dist/esm/api/resources/messages/resources/mms/client/Client.d.mts +4 -25
- package/dist/esm/api/resources/messages/resources/mms/client/Client.mjs +16 -14
- package/dist/esm/api/resources/messages/resources/mms/client/index.d.mts +0 -1
- package/dist/esm/api/resources/messages/resources/mms/client/requests/Mms.d.mts +1 -4
- package/dist/esm/api/resources/messages/resources/mms/client/requests/Mms.mjs +1 -3
- package/dist/esm/api/resources/messages/resources/mms/client/requests/index.d.mts +1 -1
- package/dist/esm/api/resources/messages/resources/mms/index.d.mts +1 -1
- package/dist/esm/api/resources/messages/resources/mms/index.mjs +1 -1
- package/dist/esm/api/resources/messages/resources/mms/types/MmsSendResponse.d.mts +2 -5
- package/dist/esm/api/resources/messages/resources/mms/types/MmsSendResponse.mjs +1 -3
- package/dist/esm/api/resources/messages/resources/rcs/client/Client.d.mts +5 -26
- package/dist/esm/api/resources/messages/resources/rcs/client/Client.mjs +26 -19
- package/dist/esm/api/resources/messages/resources/rcs/client/index.d.mts +0 -1
- package/dist/esm/api/resources/messages/resources/rcs/client/requests/SendTypingIndicatorSchema.d.mts +0 -3
- package/dist/esm/api/resources/messages/resources/rcs/client/requests/SendTypingIndicatorSchema.mjs +1 -3
- package/dist/esm/api/resources/messages/resources/rcs/client/requests/index.d.mts +1 -1
- package/dist/esm/api/resources/messages/resources/rcs/index.d.mts +1 -1
- package/dist/esm/api/resources/messages/resources/rcs/index.mjs +1 -1
- package/dist/esm/api/resources/messages/resources/rcs/types/SendRichMessageResponse.d.mts +2 -0
- package/dist/esm/api/resources/messages/resources/rcs/types/SendRichMessageResponse.mjs +2 -0
- package/dist/esm/api/resources/messages/resources/rcs/types/index.d.mts +1 -1
- package/dist/esm/api/resources/messages/resources/rcs/types/index.mjs +1 -1
- package/dist/esm/api/resources/messages/resources/sms/client/Client.d.mts +4 -25
- package/dist/esm/api/resources/messages/resources/sms/client/Client.mjs +16 -14
- package/dist/esm/api/resources/messages/resources/sms/client/index.d.mts +0 -1
- package/dist/esm/api/resources/messages/resources/sms/client/requests/Sms.d.mts +1 -4
- package/dist/esm/api/resources/messages/resources/sms/client/requests/Sms.mjs +1 -3
- package/dist/esm/api/resources/messages/resources/sms/client/requests/index.d.mts +1 -1
- package/dist/esm/api/resources/messages/resources/sms/index.d.mts +1 -1
- package/dist/esm/api/resources/messages/resources/sms/index.mjs +1 -1
- package/dist/esm/api/resources/messages/resources/sms/types/SmsSendResponse.d.mts +2 -5
- package/dist/esm/api/resources/messages/resources/sms/types/SmsSendResponse.mjs +1 -3
- package/dist/esm/api/resources/phoneNumbers/client/Client.d.mts +5 -26
- package/dist/esm/api/resources/phoneNumbers/client/Client.mjs +23 -19
- package/dist/esm/api/resources/phoneNumbers/client/index.d.mts +0 -1
- package/dist/esm/api/resources/phoneNumbers/client/requests/BuyPhoneNumberParams.d.mts +0 -3
- package/dist/esm/api/resources/phoneNumbers/client/requests/BuyPhoneNumberParams.mjs +1 -3
- package/dist/esm/api/resources/phoneNumbers/client/requests/RetrievePhoneNumberDetailsParams.d.mts +1 -4
- package/dist/esm/api/resources/phoneNumbers/client/requests/RetrievePhoneNumberDetailsParams.mjs +6 -3
- package/dist/esm/api/resources/phoneNumbers/client/requests/SearchPhoneNumberParams.d.mts +1 -4
- package/dist/esm/api/resources/phoneNumbers/client/requests/SearchPhoneNumberParams.mjs +1 -3
- package/dist/esm/api/resources/phoneNumbers/client/requests/index.d.mts +3 -3
- package/dist/esm/api/resources/phoneNumbers/index.d.mts +1 -1
- package/dist/esm/api/resources/phoneNumbers/index.mjs +1 -1
- package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/Client.d.mts +4 -25
- package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/Client.mjs +16 -14
- package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/index.d.mts +0 -1
- package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/requests/AttachCampaignParams.d.mts +1 -4
- package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/requests/AttachCampaignParams.mjs +1 -3
- package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/requests/DetachCampaignParams.d.mts +0 -3
- package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/requests/DetachCampaignParams.mjs +1 -3
- package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/requests/index.d.mts +2 -2
- package/dist/esm/api/resources/phoneNumbers/resources/index.d.mts +2 -2
- package/dist/esm/api/resources/phoneNumbers/resources/index.mjs +2 -2
- package/dist/esm/api/resources/phoneNumbers/resources/webhook/client/Client.d.mts +4 -25
- package/dist/esm/api/resources/phoneNumbers/resources/webhook/client/Client.mjs +18 -16
- package/dist/esm/api/resources/phoneNumbers/types/PhoneNumbersGetResponse.d.mts +1 -4
- package/dist/esm/api/resources/phoneNumbers/types/PhoneNumbersGetResponse.mjs +1 -3
- package/dist/esm/api/resources/rcs/client/Client.d.mts +4 -25
- package/dist/esm/api/resources/rcs/client/Client.mjs +22 -18
- package/dist/esm/api/resources/rcs/client/index.d.mts +0 -1
- package/dist/esm/api/resources/rcs/client/requests/RcsCapabilitiesQuery.d.mts +0 -3
- package/dist/esm/api/resources/rcs/client/requests/RcsCapabilitiesQuery.mjs +1 -3
- package/dist/esm/api/resources/rcs/client/requests/RcsLinkRequest.d.mts +0 -3
- package/dist/esm/api/resources/rcs/client/requests/RcsLinkRequest.mjs +1 -3
- package/dist/esm/api/resources/rcs/client/requests/RcsWhitelistRequest.d.mts +0 -3
- package/dist/esm/api/resources/rcs/client/requests/RcsWhitelistRequest.mjs +1 -3
- package/dist/esm/api/resources/rcs/client/requests/index.d.mts +3 -3
- package/dist/esm/api/resources/status/client/Client.d.mts +2 -12
- package/dist/esm/api/resources/status/client/Client.mjs +1 -3
- package/dist/esm/api/resources/status/resources/get/client/Client.d.mts +4 -25
- package/dist/esm/api/resources/status/resources/get/client/Client.mjs +39 -31
- package/dist/esm/api/resources/tools/client/Client.d.mts +4 -14
- package/dist/esm/api/resources/tools/client/Client.mjs +3 -5
- package/dist/esm/api/resources/tools/resources/contactCard/client/Client.d.mts +4 -25
- package/dist/esm/api/resources/tools/resources/contactCard/client/Client.mjs +16 -14
- package/dist/esm/api/resources/tools/resources/contactCard/client/index.d.mts +0 -1
- package/dist/esm/api/resources/tools/resources/contactCard/client/requests/GetVcardParams.d.mts +0 -3
- package/dist/esm/api/resources/tools/resources/contactCard/client/requests/GetVcardParams.mjs +1 -3
- package/dist/esm/api/resources/tools/resources/contactCard/client/requests/UpsertVcardParams.d.mts +1 -4
- package/dist/esm/api/resources/tools/resources/contactCard/client/requests/UpsertVcardParams.mjs +1 -3
- package/dist/esm/api/resources/tools/resources/contactCard/client/requests/index.d.mts +2 -2
- package/dist/esm/api/resources/tools/resources/file/client/Client.d.mts +4 -25
- package/dist/esm/api/resources/tools/resources/file/client/Client.mjs +16 -14
- package/dist/esm/api/resources/tools/resources/file/client/index.d.mts +0 -1
- package/dist/esm/api/resources/tools/resources/file/client/requests/RefreshFileParams.d.mts +0 -3
- package/dist/esm/api/resources/tools/resources/file/client/requests/RefreshFileParams.mjs +1 -3
- package/dist/esm/api/resources/tools/resources/file/client/requests/UploadFileParams.d.mts +0 -3
- package/dist/esm/api/resources/tools/resources/file/client/requests/UploadFileParams.mjs +1 -3
- package/dist/esm/api/resources/tools/resources/file/client/requests/index.d.mts +2 -2
- package/dist/esm/api/resources/tools/resources/index.d.mts +4 -4
- package/dist/esm/api/resources/tools/resources/index.mjs +4 -4
- package/dist/esm/api/resources/tools/resources/url/client/Client.d.mts +4 -25
- package/dist/esm/api/resources/tools/resources/url/client/Client.mjs +24 -20
- package/dist/esm/api/resources/tools/resources/url/client/index.d.mts +0 -1
- package/dist/esm/api/resources/tools/resources/url/client/requests/CreateUrlParams.d.mts +1 -4
- package/dist/esm/api/resources/tools/resources/url/client/requests/CreateUrlParams.mjs +1 -3
- package/dist/esm/api/resources/tools/resources/url/client/requests/UpdateUrlParams.d.mts +1 -4
- package/dist/esm/api/resources/tools/resources/url/client/requests/UpdateUrlParams.mjs +1 -3
- package/dist/esm/api/resources/tools/resources/url/client/requests/index.d.mts +2 -2
- package/dist/esm/api/resources/webhooks/client/Client.d.mts +4 -25
- package/dist/esm/api/resources/webhooks/client/Client.mjs +10 -10
- package/dist/esm/api/resources/webhooks/client/index.d.mts +0 -1
- package/dist/esm/api/resources/webhooks/client/requests/GetWebhookParams.d.mts +0 -3
- package/dist/esm/api/resources/webhooks/client/requests/GetWebhookParams.mjs +1 -3
- package/dist/esm/api/resources/webhooks/client/requests/index.d.mts +1 -1
- package/dist/esm/api/types/AdvancedPhoneInformation.d.mts +2 -5
- package/dist/esm/api/types/AdvancedPhoneInformation.mjs +7 -3
- package/dist/esm/api/types/AttachWebhookParams.d.mts +1 -4
- package/dist/esm/api/types/AttachWebhookParams.mjs +1 -3
- package/dist/esm/api/types/AttachedPhoneNumberResult.d.mts +1 -4
- package/dist/esm/api/types/AttachedPhoneNumberResult.mjs +1 -3
- package/dist/esm/api/types/AudienceCountOnly.d.mts +14 -0
- package/dist/esm/api/types/AudienceCountOnly.mjs +2 -0
- package/dist/esm/api/types/AudienceWithPagination.d.mts +14 -0
- package/dist/esm/api/types/AudienceWithPagination.mjs +2 -0
- package/dist/esm/api/types/AutofillCampaignParams.d.mts +0 -3
- package/dist/esm/api/types/AutofillCampaignParams.mjs +1 -3
- package/dist/esm/api/types/AutofillDlcCampaignResponse.d.mts +1 -4
- package/dist/esm/api/types/AutofillDlcCampaignResponse.mjs +1 -3
- package/dist/esm/api/types/BadRequestErrorBody.d.mts +1 -4
- package/dist/esm/api/types/BadRequestErrorBody.mjs +1 -3
- package/dist/esm/api/types/BaseRichMessage.d.mts +9 -0
- package/dist/esm/api/types/BaseRichMessage.mjs +2 -0
- package/dist/esm/api/types/BasicPhoneInformation.d.mts +1 -4
- package/dist/esm/api/types/BasicPhoneInformation.mjs +1 -3
- package/dist/esm/api/types/BrandStatus.d.mts +1 -4
- package/dist/esm/api/types/BrandStatus.mjs +1 -3
- package/dist/esm/api/types/BrandStatusEnum.d.mts +1 -4
- package/dist/esm/api/types/BrandStatusEnum.mjs +8 -1
- package/dist/esm/api/types/ButtonClicked.d.mts +1 -4
- package/dist/esm/api/types/ButtonClicked.mjs +1 -3
- package/dist/esm/api/types/ButtonClickedData.d.mts +2 -5
- package/dist/esm/api/types/ButtonClickedData.mjs +7 -3
- package/dist/esm/api/types/CampaignEnum.d.mts +1 -4
- package/dist/esm/api/types/CampaignEnum.mjs +5 -1
- package/dist/esm/api/types/CampaignQuery.d.mts +1 -4
- package/dist/esm/api/types/CampaignQuery.mjs +1 -3
- package/dist/esm/api/types/CampaignSubmissionResult.d.mts +0 -3
- package/dist/esm/api/types/CampaignSubmissionResult.mjs +1 -3
- package/dist/esm/api/types/CampaignValidationResult.d.mts +0 -3
- package/dist/esm/api/types/CampaignValidationResult.mjs +1 -3
- package/dist/esm/api/types/CancelScheduledMessageResponse.d.mts +4 -0
- package/dist/esm/api/types/CancelScheduledMessageResponse.mjs +2 -0
- package/dist/esm/api/types/CompanyEntityTypeEnum.d.mts +9 -0
- package/dist/esm/api/types/CompanyEntityTypeEnum.mjs +9 -0
- package/dist/esm/api/types/CompanySectorEnum.d.mts +2 -7
- package/dist/esm/api/types/CompanySectorEnum.mjs +2 -3
- package/dist/esm/api/types/CompanyTypeEnum.d.mts +2 -7
- package/dist/esm/api/types/CompanyTypeEnum.mjs +2 -3
- package/dist/esm/api/types/ConfiguredWebhook.d.mts +1 -4
- package/dist/esm/api/types/ConfiguredWebhook.mjs +1 -3
- package/dist/esm/api/types/Contact.d.mts +0 -3
- package/dist/esm/api/types/Contact.mjs +1 -3
- package/dist/esm/api/types/ContactId.d.mts +0 -3
- package/dist/esm/api/types/ContactId.mjs +1 -3
- package/dist/esm/api/types/Conversation.d.mts +1 -4
- package/dist/esm/api/types/Conversation.mjs +1 -3
- package/dist/esm/api/types/ConversationList.d.mts +1 -4
- package/dist/esm/api/types/ConversationList.mjs +1 -3
- package/dist/esm/api/types/CreateUrlOptions.d.mts +0 -3
- package/dist/esm/api/types/CreateUrlOptions.mjs +1 -3
- package/dist/esm/api/types/DeleteAudienceResponse.d.mts +4 -0
- package/dist/esm/api/types/DeleteAudienceResponse.mjs +2 -0
- package/dist/esm/api/types/DetachedPhoneNumberResult.d.mts +1 -4
- package/dist/esm/api/types/DetachedPhoneNumberResult.mjs +1 -3
- package/dist/esm/api/types/DetachedWebhookInfo.d.mts +0 -3
- package/dist/esm/api/types/DetachedWebhookInfo.mjs +1 -3
- package/dist/esm/api/types/DetailedPhoneNumberEnum.d.mts +1 -4
- package/dist/esm/api/types/DetailedPhoneNumberEnum.mjs +5 -1
- package/dist/esm/api/types/DlcAssignmentStatusEnum.d.mts +1 -4
- package/dist/esm/api/types/DlcAssignmentStatusEnum.mjs +8 -1
- package/dist/esm/api/types/DlcCampaignStatus.d.mts +1 -4
- package/dist/esm/api/types/DlcCampaignStatus.mjs +1 -3
- package/dist/esm/api/types/DlcCampaignUseCaseEnum.d.mts +2 -7
- package/dist/esm/api/types/DlcCampaignUseCaseEnum.mjs +2 -3
- package/dist/esm/api/types/DlcCampaignWithExtendedBrandAndStatus.d.mts +1 -4
- package/dist/esm/api/types/DlcCampaignWithExtendedBrandAndStatus.mjs +1 -3
- package/dist/esm/api/types/EnhancedContact.d.mts +1 -4
- package/dist/esm/api/types/EnhancedContact.mjs +1 -3
- package/dist/esm/api/types/EnhancedContactItem.d.mts +0 -3
- package/dist/esm/api/types/EnhancedContactItem.mjs +1 -3
- package/dist/esm/api/types/Error_.d.mts +0 -3
- package/dist/esm/api/types/Error_.mjs +1 -3
- package/dist/esm/api/types/ExtendedBrand.d.mts +1 -4
- package/dist/esm/api/types/ExtendedBrand.mjs +1 -3
- package/dist/esm/api/types/ExtendedBrandWithVetting.d.mts +1 -4
- package/dist/esm/api/types/ExtendedBrandWithVetting.mjs +1 -3
- package/dist/esm/api/types/ExtendedRcsCampaign.d.mts +55 -30
- package/dist/esm/api/types/ExtendedRcsCampaign.mjs +1 -3
- package/dist/esm/api/types/GetConversationParams.d.mts +0 -3
- package/dist/esm/api/types/GetConversationParams.mjs +1 -3
- package/dist/esm/api/types/LinkClickEvent.d.mts +0 -3
- package/dist/esm/api/types/LinkClickEvent.mjs +1 -3
- package/dist/esm/api/types/LocationShareAction.d.mts +0 -3
- package/dist/esm/api/types/LocationShareAction.mjs +1 -3
- package/dist/esm/api/types/Message.d.mts +1 -4
- package/dist/esm/api/types/Message.mjs +1 -3
- package/dist/esm/api/types/MessageContent.d.mts +1 -4
- package/dist/esm/api/types/MessageContent.mjs +1 -3
- package/dist/esm/api/types/MessageEvent.d.mts +3 -8
- package/dist/esm/api/types/MessageEvent.mjs +2 -3
- package/dist/esm/api/types/MessageEventContent.d.mts +1 -4
- package/dist/esm/api/types/MessageEventContent.mjs +1 -3
- package/dist/esm/api/types/MessageEventMmsContent.d.mts +0 -3
- package/dist/esm/api/types/MessageEventMmsContent.mjs +1 -3
- package/dist/esm/api/types/MessageEventRcsButtonData.d.mts +1 -4
- package/dist/esm/api/types/MessageEventRcsButtonData.mjs +1 -3
- package/dist/esm/api/types/MessageEventRcsCardsContent.d.mts +1 -4
- package/dist/esm/api/types/MessageEventRcsCardsContent.mjs +1 -3
- package/dist/esm/api/types/MessageEventRcsLocationData.d.mts +1 -4
- package/dist/esm/api/types/MessageEventRcsLocationData.mjs +1 -3
- package/dist/esm/api/types/MessageEventRcsMediaContent.d.mts +1 -4
- package/dist/esm/api/types/MessageEventRcsMediaContent.mjs +1 -3
- package/dist/esm/api/types/MessageEventRcsTextContent.d.mts +1 -4
- package/dist/esm/api/types/MessageEventRcsTextContent.mjs +1 -3
- package/dist/esm/api/types/MessageEventSmsContent.d.mts +0 -3
- package/dist/esm/api/types/MessageEventSmsContent.mjs +1 -3
- package/dist/esm/api/types/MessageList.d.mts +1 -4
- package/dist/esm/api/types/MessageList.mjs +1 -3
- package/dist/esm/api/types/MessageMethodEnum.d.mts +2 -7
- package/dist/esm/api/types/MessageMethodEnum.mjs +2 -3
- package/dist/esm/api/types/MessageProtocolEnum.d.mts +2 -7
- package/dist/esm/api/types/MessageProtocolEnum.mjs +2 -3
- package/dist/esm/api/types/MessageSchedule.d.mts +7 -4
- package/dist/esm/api/types/MessageSchedule.mjs +1 -3
- package/dist/esm/api/types/MessageStatusEnum.d.mts +2 -7
- package/dist/esm/api/types/MessageStatusEnum.mjs +2 -3
- package/dist/esm/api/types/MessageVolumeEnum.d.mts +2 -7
- package/dist/esm/api/types/MessageVolumeEnum.mjs +2 -3
- package/dist/esm/api/types/MessageWithReaction.d.mts +3 -8
- package/dist/esm/api/types/MessageWithReaction.mjs +2 -3
- package/dist/esm/api/types/MessagingProfileEnum.d.mts +2 -7
- package/dist/esm/api/types/MessagingProfileEnum.mjs +2 -3
- package/dist/esm/api/types/MmsContent.d.mts +0 -3
- package/dist/esm/api/types/MmsContent.mjs +1 -3
- package/dist/esm/api/types/MmsValidationResult.d.mts +0 -3
- package/dist/esm/api/types/MmsValidationResult.mjs +1 -3
- package/dist/esm/api/types/NotFoundErrorBody.d.mts +0 -3
- package/dist/esm/api/types/NotFoundErrorBody.mjs +1 -3
- package/dist/esm/api/types/NumberFormat.d.mts +0 -3
- package/dist/esm/api/types/NumberFormat.mjs +1 -3
- package/dist/esm/api/types/OptInMethodEnum.d.mts +2 -7
- package/dist/esm/api/types/OptInMethodEnum.mjs +2 -3
- package/dist/esm/api/types/OptionalBrandInfo.d.mts +3 -4
- package/dist/esm/api/types/OptionalBrandInfo.mjs +1 -3
- package/dist/esm/api/types/OptionalContact.d.mts +0 -3
- package/dist/esm/api/types/OptionalContact.mjs +1 -3
- package/dist/esm/api/types/OptionalContacts.d.mts +0 -3
- package/dist/esm/api/types/OptionalContacts.mjs +1 -3
- package/dist/esm/api/types/Pagination.d.mts +10 -0
- package/dist/esm/api/types/Pagination.mjs +2 -0
- package/dist/esm/api/types/PhoneCapabilities.d.mts +0 -3
- package/dist/esm/api/types/PhoneCapabilities.mjs +1 -3
- package/dist/esm/api/types/PhoneEnum.d.mts +1 -4
- package/dist/esm/api/types/PhoneEnum.mjs +4 -1
- package/dist/esm/api/types/PhoneFeatureEnum.d.mts +1 -4
- package/dist/esm/api/types/PhoneFeatureEnum.mjs +4 -1
- package/dist/esm/api/types/PhoneNumberDetails.d.mts +1 -4
- package/dist/esm/api/types/PhoneNumberDetails.mjs +1 -3
- package/dist/esm/api/types/PhoneNumberEnum.d.mts +1 -4
- package/dist/esm/api/types/PhoneNumberEnum.mjs +4 -1
- package/dist/esm/api/types/PhoneNumberStatus.d.mts +1 -4
- package/dist/esm/api/types/PhoneNumberStatus.mjs +1 -3
- package/dist/esm/api/types/PhoneNumberStatusEnum.d.mts +1 -4
- package/dist/esm/api/types/PhoneNumberStatusEnum.mjs +6 -1
- package/dist/esm/api/types/ProfileStatusEnum.d.mts +1 -4
- package/dist/esm/api/types/ProfileStatusEnum.mjs +10 -1
- package/dist/esm/api/types/PurchasedNumber.d.mts +0 -3
- package/dist/esm/api/types/PurchasedNumber.mjs +1 -3
- package/dist/esm/api/types/RcsButtonCall.d.mts +0 -3
- package/dist/esm/api/types/RcsButtonCall.mjs +1 -3
- package/dist/esm/api/types/RcsButtonOpenUrl.d.mts +1 -4
- package/dist/esm/api/types/RcsButtonOpenUrl.mjs +11 -3
- package/dist/esm/api/types/RcsButtonRequestUserLocation.d.mts +0 -3
- package/dist/esm/api/types/RcsButtonRequestUserLocation.mjs +1 -3
- package/dist/esm/api/types/RcsButtonScheduleEvent.d.mts +0 -3
- package/dist/esm/api/types/RcsButtonScheduleEvent.mjs +1 -3
- package/dist/esm/api/types/RcsButtonSendLocation.d.mts +0 -3
- package/dist/esm/api/types/RcsButtonSendLocation.mjs +1 -3
- package/dist/esm/api/types/RcsButtonTrigger.d.mts +0 -3
- package/dist/esm/api/types/RcsButtonTrigger.mjs +1 -3
- package/dist/esm/api/types/RcsCampaign.d.mts +55 -28
- package/dist/esm/api/types/RcsCampaign.mjs +1 -3
- package/dist/esm/api/types/RcsCampaignStatus.d.mts +1 -4
- package/dist/esm/api/types/RcsCampaignStatus.mjs +1 -3
- package/dist/esm/api/types/RcsCampaignUseCaseEnum.d.mts +2 -7
- package/dist/esm/api/types/RcsCampaignUseCaseEnum.mjs +2 -3
- package/dist/esm/api/types/RcsCapabilitiesResult.d.mts +1 -4
- package/dist/esm/api/types/RcsCapabilitiesResult.mjs +1 -3
- package/dist/esm/api/types/RcsCapability.d.mts +0 -3
- package/dist/esm/api/types/RcsCapability.mjs +1 -3
- package/dist/esm/api/types/RcsCardsContent.d.mts +2 -5
- package/dist/esm/api/types/RcsCardsContent.mjs +1 -3
- package/dist/esm/api/types/RcsContent.d.mts +2 -5
- package/dist/esm/api/types/RcsContent.mjs +1 -3
- package/dist/esm/api/types/RcsLinkResult.d.mts +0 -3
- package/dist/esm/api/types/RcsLinkResult.mjs +1 -3
- package/dist/esm/api/types/RcsMediaContent.d.mts +1 -4
- package/dist/esm/api/types/RcsMediaContent.mjs +1 -3
- package/dist/esm/api/types/RcsMediaDetailsContent.d.mts +0 -3
- package/dist/esm/api/types/RcsMediaDetailsContent.mjs +1 -3
- package/dist/esm/api/types/RcsMessagingTypeEnum.d.mts +15 -0
- package/dist/esm/api/types/RcsMessagingTypeEnum.mjs +15 -0
- package/dist/esm/api/types/RcsValidateContent.d.mts +3 -6
- package/dist/esm/api/types/RcsValidateContent.mjs +1 -3
- package/dist/esm/api/types/RcsValidationResult.d.mts +2 -3
- package/dist/esm/api/types/RcsValidationResult.mjs +1 -3
- package/dist/esm/api/types/RcsWhitelistResponse.d.mts +0 -3
- package/dist/esm/api/types/RcsWhitelistResponse.mjs +1 -3
- package/dist/esm/api/types/ReactionResult.d.mts +0 -3
- package/dist/esm/api/types/ReactionResult.mjs +1 -3
- package/dist/esm/api/types/RefreshedFile.d.mts +0 -3
- package/dist/esm/api/types/RefreshedFile.mjs +1 -3
- package/dist/esm/api/types/RichButton.d.mts +1 -4
- package/dist/esm/api/types/RichButton.mjs +1 -3
- package/dist/esm/api/types/{RcsCards.d.mts → RichCards.d.mts} +5 -8
- package/dist/esm/api/types/RichCards.mjs +2 -0
- package/dist/esm/api/types/RichCardsMessage.d.mts +11 -16
- package/dist/esm/api/types/RichCardsMessage.mjs +3 -3
- package/dist/esm/api/types/RichMediaMessage.d.mts +2 -5
- package/dist/esm/api/types/RichMediaMessage.mjs +1 -3
- package/dist/esm/api/types/RichMessage.d.mts +5 -5
- package/dist/esm/api/types/RichMessage.mjs +1 -3
- package/dist/esm/api/types/{RcsTextContent.d.mts → RichText.d.mts} +2 -5
- package/dist/esm/api/types/RichText.mjs +2 -0
- package/dist/esm/api/types/RichTextMessage.d.mts +2 -5
- package/dist/esm/api/types/RichTextMessage.mjs +1 -3
- package/dist/{cjs/api/types/ScheduledMessaage.d.ts → esm/api/types/ScheduledMessage.d.mts} +3 -6
- package/dist/esm/api/types/ScheduledMessage.mjs +2 -0
- package/dist/esm/api/types/{Options.d.mts → SendRichMessageOptions.d.mts} +2 -5
- package/dist/esm/api/types/SendRichMessageOptions.mjs +2 -0
- package/dist/esm/api/types/SendTypingIndicatorResponse.d.mts +0 -3
- package/dist/esm/api/types/SendTypingIndicatorResponse.mjs +1 -3
- package/dist/esm/api/types/Sender.d.mts +0 -3
- package/dist/esm/api/types/Sender.mjs +1 -3
- package/dist/esm/api/types/SentMmsDetails.d.mts +5 -4
- package/dist/esm/api/types/SentMmsDetails.mjs +1 -3
- package/dist/{cjs/api/types/SentRcsDetails.d.ts → esm/api/types/SentRichMessage.d.mts} +1 -4
- package/dist/esm/api/types/SentRichMessage.mjs +2 -0
- package/dist/esm/api/types/SentSmsDetails.d.mts +2 -7
- package/dist/esm/api/types/SentSmsDetails.mjs +2 -3
- package/dist/esm/api/types/ShortenedUrl.d.mts +0 -3
- package/dist/esm/api/types/ShortenedUrl.mjs +1 -3
- package/dist/esm/api/types/ShortenedUrlWithClickData.d.mts +1 -4
- package/dist/esm/api/types/ShortenedUrlWithClickData.mjs +1 -3
- package/dist/esm/api/types/SmsContent.d.mts +0 -3
- package/dist/esm/api/types/SmsContent.mjs +1 -3
- package/dist/esm/api/types/SmsValidationResult.d.mts +0 -3
- package/dist/esm/api/types/SmsValidationResult.mjs +1 -3
- package/dist/esm/api/types/SubUseCaseEnum.d.mts +2 -7
- package/dist/esm/api/types/SubUseCaseEnum.mjs +2 -3
- package/dist/esm/api/types/SubmissionResults.d.mts +0 -3
- package/dist/esm/api/types/SubmissionResults.mjs +1 -3
- package/dist/esm/api/types/SuccessfulConversationUpdate.d.mts +0 -3
- package/dist/esm/api/types/SuccessfulConversationUpdate.mjs +1 -3
- package/dist/esm/api/types/TollFreeCampaign.d.mts +50 -4
- package/dist/esm/api/types/TollFreeCampaign.mjs +1 -3
- package/dist/esm/api/types/TollFreeCampaignStatus.d.mts +1 -4
- package/dist/esm/api/types/TollFreeCampaignStatus.mjs +1 -3
- package/dist/esm/api/types/TollFreeCampaignUseCaseEnum.d.mts +2 -7
- package/dist/esm/api/types/TollFreeCampaignUseCaseEnum.mjs +2 -3
- package/dist/esm/api/types/TollFreeCampaignWithExtendedBrandAndStatus.d.mts +1 -4
- package/dist/esm/api/types/TollFreeCampaignWithExtendedBrandAndStatus.mjs +1 -3
- package/dist/esm/api/types/TollFreeStatusEnum.d.mts +1 -4
- package/dist/esm/api/types/TollFreeStatusEnum.mjs +8 -1
- package/dist/esm/api/types/Tracking.d.mts +1 -4
- package/dist/esm/api/types/Tracking.mjs +6 -1
- package/dist/esm/api/types/UpdatedContactId.d.mts +0 -3
- package/dist/esm/api/types/UpdatedContactId.mjs +1 -3
- package/dist/esm/api/types/UploadResults.d.mts +0 -3
- package/dist/esm/api/types/UploadResults.mjs +1 -3
- package/dist/esm/api/types/UpsertContact.d.mts +0 -3
- package/dist/esm/api/types/UpsertContact.mjs +1 -3
- package/dist/esm/api/types/UserEvent.d.mts +0 -3
- package/dist/esm/api/types/UserEvent.mjs +1 -3
- package/dist/esm/api/types/VCardData.d.mts +1 -4
- package/dist/esm/api/types/VCardData.mjs +1 -3
- package/dist/esm/api/types/ValidateCampaignParams.d.mts +0 -3
- package/dist/esm/api/types/ValidateCampaignParams.mjs +1 -3
- package/dist/esm/api/types/ValidationErrorDetails.d.mts +0 -3
- package/dist/esm/api/types/ValidationErrorDetails.mjs +1 -3
- package/dist/esm/api/types/ValidationResults.d.mts +1 -4
- package/dist/esm/api/types/ValidationResults.mjs +1 -3
- package/dist/esm/api/types/Vcard.d.mts +1 -4
- package/dist/esm/api/types/Vcard.mjs +1 -3
- package/dist/esm/api/types/VcardAddress.d.mts +1 -4
- package/dist/esm/api/types/VcardAddress.mjs +1 -3
- package/dist/esm/api/types/VcardContent.d.mts +1 -4
- package/dist/esm/api/types/VcardContent.mjs +1 -3
- package/dist/esm/api/types/VcardEmail.d.mts +1 -4
- package/dist/esm/api/types/VcardEmail.mjs +1 -3
- package/dist/esm/api/types/VcardPhone.d.mts +1 -4
- package/dist/esm/api/types/VcardPhone.mjs +1 -3
- package/dist/esm/api/types/VcardResource.d.mts +0 -3
- package/dist/esm/api/types/VcardResource.mjs +1 -3
- package/dist/esm/api/types/VettingFeedback.d.mts +0 -3
- package/dist/esm/api/types/VettingFeedback.mjs +1 -3
- package/dist/esm/api/types/VettingHistory.d.mts +2 -7
- package/dist/esm/api/types/VettingHistory.mjs +2 -3
- package/dist/esm/api/types/VettingResults.d.mts +0 -3
- package/dist/esm/api/types/VettingResults.mjs +1 -3
- package/dist/esm/api/types/WebhookEventEnum.d.mts +1 -4
- package/dist/esm/api/types/WebhookEventEnum.mjs +4 -1
- package/dist/esm/api/types/WebhookResult.d.mts +1 -4
- package/dist/esm/api/types/WebhookResult.mjs +1 -3
- package/dist/esm/api/types/Webhooks.d.mts +0 -3
- package/dist/esm/api/types/Webhooks.mjs +1 -3
- package/dist/esm/api/types/ZodError.d.mts +0 -3
- package/dist/esm/api/types/ZodError.mjs +1 -3
- package/dist/esm/api/types/index.d.mts +125 -119
- package/dist/esm/api/types/index.mjs +125 -119
- package/dist/esm/core/exports.d.mts +1 -0
- package/dist/esm/core/exports.mjs +1 -0
- package/dist/esm/core/fetcher/APIResponse.d.mts +1 -1
- package/dist/esm/core/fetcher/BinaryResponse.d.mts +1 -1
- package/dist/esm/core/fetcher/EndpointMetadata.d.mts +13 -0
- package/dist/esm/core/fetcher/EndpointMetadata.mjs +1 -0
- package/dist/esm/core/fetcher/EndpointSupplier.d.mts +12 -0
- package/dist/esm/core/fetcher/EndpointSupplier.mjs +19 -0
- package/dist/esm/core/fetcher/Fetcher.d.mts +9 -4
- package/dist/esm/core/fetcher/Fetcher.mjs +205 -10
- package/dist/esm/core/fetcher/HttpResponsePromise.d.mts +1 -1
- package/dist/esm/core/fetcher/getErrorResponseBody.mjs +2 -1
- package/dist/esm/core/fetcher/getRequestBody.d.mts +1 -1
- package/dist/esm/core/fetcher/getRequestBody.mjs +4 -0
- package/dist/esm/core/fetcher/getResponseBody.mjs +3 -3
- package/dist/esm/core/fetcher/index.d.mts +2 -0
- package/dist/esm/core/fetcher/index.mjs +1 -0
- package/dist/esm/core/fetcher/makeRequest.d.mts +1 -1
- package/dist/esm/core/fetcher/makeRequest.mjs +2 -4
- package/dist/esm/core/fetcher/requestWithRetries.mjs +16 -21
- package/dist/esm/core/fetcher/signals.d.mts +0 -6
- package/dist/esm/core/fetcher/signals.mjs +0 -12
- package/dist/esm/core/headers.d.mts +2 -3
- package/dist/esm/core/headers.mjs +6 -4
- package/dist/esm/core/index.d.mts +1 -0
- package/dist/esm/core/index.mjs +1 -0
- package/dist/esm/core/logging/exports.d.mts +18 -0
- package/dist/esm/core/logging/exports.mjs +9 -0
- package/dist/esm/core/logging/index.d.mts +1 -0
- package/dist/esm/core/logging/index.mjs +1 -0
- package/dist/esm/core/logging/logger.d.mts +126 -0
- package/dist/esm/core/logging/logger.mjs +138 -0
- package/dist/esm/core/url/encodePathParam.d.mts +1 -0
- package/dist/esm/core/url/encodePathParam.mjs +18 -0
- package/dist/esm/core/url/index.d.mts +1 -0
- package/dist/esm/core/url/index.mjs +1 -0
- package/dist/esm/core/url/join.mjs +3 -4
- package/dist/esm/environments.d.mts +0 -3
- package/dist/esm/environments.mjs +1 -3
- package/dist/esm/errors/PinnacleError.d.mts +1 -4
- package/dist/esm/errors/PinnacleError.mjs +2 -4
- package/dist/esm/errors/PinnacleTimeoutError.d.mts +0 -3
- package/dist/esm/errors/PinnacleTimeoutError.mjs +1 -3
- package/dist/esm/exports.d.mts +1 -0
- package/dist/esm/exports.mjs +1 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/dist/esm/wrapper/messages/Client.mjs +1 -0
- package/dist/esm/wrapper/tools/FileUploader.d.mts +1 -1
- package/dist/esm/wrapper/tools/FileUploader.mjs +1 -0
- package/package.json +16 -16
- package/reference.md +1064 -610
- package/dist/cjs/api/resources/messages/resources/rcs/types/RcsSendResponse.d.ts +0 -5
- package/dist/cjs/api/types/RcsBase.d.ts +0 -31
- package/dist/cjs/api/types/RcsCampaignOptInMethodEnum.d.ts +0 -15
- package/dist/cjs/api/types/RcsCampaignOptInMethodEnum.js +0 -14
- package/dist/cjs/api/types/RcsTextContent.js +0 -5
- package/dist/cjs/api/types/ScheduledMessaage.js +0 -5
- package/dist/cjs/api/types/SentRcsDetails.js +0 -5
- package/dist/esm/api/resources/messages/resources/rcs/types/RcsSendResponse.d.mts +0 -5
- package/dist/esm/api/resources/messages/resources/rcs/types/RcsSendResponse.mjs +0 -4
- package/dist/esm/api/types/Options.mjs +0 -4
- package/dist/esm/api/types/RcsBase.d.mts +0 -31
- package/dist/esm/api/types/RcsBase.mjs +0 -4
- package/dist/esm/api/types/RcsCampaignOptInMethodEnum.d.mts +0 -15
- package/dist/esm/api/types/RcsCampaignOptInMethodEnum.mjs +0 -11
- package/dist/esm/api/types/RcsCards.mjs +0 -4
- package/dist/esm/api/types/RcsTextContent.mjs +0 -4
- package/dist/esm/api/types/ScheduledMessaage.mjs +0 -4
- package/dist/esm/api/types/SentRcsDetails.mjs +0 -4
package/reference.md
CHANGED
|
@@ -1,7 +1,5 @@
|
|
|
1
1
|
# Reference
|
|
2
|
-
|
|
3
2
|
## Brands
|
|
4
|
-
|
|
5
3
|
<details><summary><code>client.brands.<a href="/src/api/resources/brands/client/Client.ts">autofill</a>({ ...params }) -> Pinnacle.OptionalBrandInfo</code></summary>
|
|
6
4
|
<dl>
|
|
7
5
|
<dd>
|
|
@@ -15,7 +13,6 @@
|
|
|
15
13
|
<dd>
|
|
16
14
|
|
|
17
15
|
Automatically populate brand information based on partial input data you provide.
|
|
18
|
-
|
|
19
16
|
</dd>
|
|
20
17
|
</dl>
|
|
21
18
|
</dd>
|
|
@@ -34,12 +31,12 @@ await client.brands.autofill({
|
|
|
34
31
|
additional_info: "A developer-friendly, compliant API for SMS, MMS, and RCS, built to scale real conversations.",
|
|
35
32
|
name: "Pinnacle",
|
|
36
33
|
options: {
|
|
37
|
-
forceReload: true
|
|
34
|
+
forceReload: true
|
|
38
35
|
},
|
|
39
|
-
website: "https://www.pinnacle.sh"
|
|
36
|
+
website: "https://www.pinnacle.sh"
|
|
40
37
|
});
|
|
41
|
-
```
|
|
42
38
|
|
|
39
|
+
```
|
|
43
40
|
</dd>
|
|
44
41
|
</dl>
|
|
45
42
|
</dd>
|
|
@@ -53,21 +50,22 @@ await client.brands.autofill({
|
|
|
53
50
|
<dl>
|
|
54
51
|
<dd>
|
|
55
52
|
|
|
56
|
-
**request:** `Pinnacle.AutofillBrandParams`
|
|
57
|
-
|
|
53
|
+
**request:** `Pinnacle.AutofillBrandParams`
|
|
54
|
+
|
|
58
55
|
</dd>
|
|
59
56
|
</dl>
|
|
60
57
|
|
|
61
58
|
<dl>
|
|
62
59
|
<dd>
|
|
63
60
|
|
|
64
|
-
**requestOptions:** `Brands.RequestOptions`
|
|
65
|
-
|
|
61
|
+
**requestOptions:** `Brands.RequestOptions`
|
|
62
|
+
|
|
66
63
|
</dd>
|
|
67
64
|
</dl>
|
|
68
65
|
</dd>
|
|
69
66
|
</dl>
|
|
70
67
|
|
|
68
|
+
|
|
71
69
|
</dd>
|
|
72
70
|
</dl>
|
|
73
71
|
</details>
|
|
@@ -85,7 +83,6 @@ await client.brands.autofill({
|
|
|
85
83
|
<dd>
|
|
86
84
|
|
|
87
85
|
Create a new brand or update an existing brand by with the provided information.
|
|
88
|
-
|
|
89
86
|
</dd>
|
|
90
87
|
</dl>
|
|
91
88
|
</dd>
|
|
@@ -106,7 +103,7 @@ await client.brands.upsert({
|
|
|
106
103
|
email: "michael.chen@trypinnacle.app",
|
|
107
104
|
name: "Michael Chen",
|
|
108
105
|
phone: "+14155551234",
|
|
109
|
-
title: "Customer Support Representative"
|
|
106
|
+
title: "Customer Support Representative"
|
|
110
107
|
},
|
|
111
108
|
dba: "Pinnacle RCS",
|
|
112
109
|
description: "A developer-friendly, compliant API for SMS, MMS, and RCS, built to scale real conversations.",
|
|
@@ -116,10 +113,11 @@ await client.brands.upsert({
|
|
|
116
113
|
name: "Pinnacle",
|
|
117
114
|
sector: "TECHNOLOGY",
|
|
118
115
|
type: "PRIVATE_PROFIT",
|
|
119
|
-
|
|
116
|
+
entityType: "LLC",
|
|
117
|
+
website: "https://www.pinnacle.sh"
|
|
120
118
|
});
|
|
121
|
-
```
|
|
122
119
|
|
|
120
|
+
```
|
|
123
121
|
</dd>
|
|
124
122
|
</dl>
|
|
125
123
|
</dd>
|
|
@@ -133,21 +131,22 @@ await client.brands.upsert({
|
|
|
133
131
|
<dl>
|
|
134
132
|
<dd>
|
|
135
133
|
|
|
136
|
-
**request:** `Pinnacle.UpsertBrandParams`
|
|
137
|
-
|
|
134
|
+
**request:** `Pinnacle.UpsertBrandParams`
|
|
135
|
+
|
|
138
136
|
</dd>
|
|
139
137
|
</dl>
|
|
140
138
|
|
|
141
139
|
<dl>
|
|
142
140
|
<dd>
|
|
143
141
|
|
|
144
|
-
**requestOptions:** `Brands.RequestOptions`
|
|
145
|
-
|
|
142
|
+
**requestOptions:** `Brands.RequestOptions`
|
|
143
|
+
|
|
146
144
|
</dd>
|
|
147
145
|
</dl>
|
|
148
146
|
</dd>
|
|
149
147
|
</dl>
|
|
150
148
|
|
|
149
|
+
|
|
151
150
|
</dd>
|
|
152
151
|
</dl>
|
|
153
152
|
</details>
|
|
@@ -165,7 +164,6 @@ await client.brands.upsert({
|
|
|
165
164
|
<dd>
|
|
166
165
|
|
|
167
166
|
Retrieve detailed information for a specific brand in your account by ID.
|
|
168
|
-
|
|
169
167
|
</dd>
|
|
170
168
|
</dl>
|
|
171
169
|
</dd>
|
|
@@ -181,8 +179,8 @@ Retrieve detailed information for a specific brand in your account by ID.
|
|
|
181
179
|
|
|
182
180
|
```typescript
|
|
183
181
|
await client.brands.get("b_1234567890");
|
|
184
|
-
```
|
|
185
182
|
|
|
183
|
+
```
|
|
186
184
|
</dd>
|
|
187
185
|
</dl>
|
|
188
186
|
</dd>
|
|
@@ -196,32 +194,33 @@ await client.brands.get("b_1234567890");
|
|
|
196
194
|
<dl>
|
|
197
195
|
<dd>
|
|
198
196
|
|
|
199
|
-
**id:** `string`
|
|
197
|
+
**id:** `string`
|
|
200
198
|
|
|
201
199
|
The unique identifier of the brand you want to retrieve from your account.
|
|
202
200
|
<br><br> This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`.
|
|
203
|
-
|
|
201
|
+
|
|
204
202
|
</dd>
|
|
205
203
|
</dl>
|
|
206
204
|
|
|
207
205
|
<dl>
|
|
208
206
|
<dd>
|
|
209
207
|
|
|
210
|
-
**request:** `Pinnacle.BrandsGetRequest`
|
|
211
|
-
|
|
208
|
+
**request:** `Pinnacle.BrandsGetRequest`
|
|
209
|
+
|
|
212
210
|
</dd>
|
|
213
211
|
</dl>
|
|
214
212
|
|
|
215
213
|
<dl>
|
|
216
214
|
<dd>
|
|
217
215
|
|
|
218
|
-
**requestOptions:** `Brands.RequestOptions`
|
|
219
|
-
|
|
216
|
+
**requestOptions:** `Brands.RequestOptions`
|
|
217
|
+
|
|
220
218
|
</dd>
|
|
221
219
|
</dl>
|
|
222
220
|
</dd>
|
|
223
221
|
</dl>
|
|
224
222
|
|
|
223
|
+
|
|
225
224
|
</dd>
|
|
226
225
|
</dl>
|
|
227
226
|
</details>
|
|
@@ -239,7 +238,6 @@ The unique identifier of the brand you want to retrieve from your account.
|
|
|
239
238
|
<dd>
|
|
240
239
|
|
|
241
240
|
Submit your brand for review and approval by the compliance team.
|
|
242
|
-
|
|
243
241
|
</dd>
|
|
244
242
|
</dl>
|
|
245
243
|
</dd>
|
|
@@ -255,8 +253,8 @@ Submit your brand for review and approval by the compliance team.
|
|
|
255
253
|
|
|
256
254
|
```typescript
|
|
257
255
|
await client.brands.submit("b_1234567890");
|
|
258
|
-
```
|
|
259
256
|
|
|
257
|
+
```
|
|
260
258
|
</dd>
|
|
261
259
|
</dl>
|
|
262
260
|
</dd>
|
|
@@ -270,24 +268,25 @@ await client.brands.submit("b_1234567890");
|
|
|
270
268
|
<dl>
|
|
271
269
|
<dd>
|
|
272
270
|
|
|
273
|
-
**brandId:** `string`
|
|
271
|
+
**brandId:** `string`
|
|
274
272
|
|
|
275
273
|
The unique identifier of the brand you want to submit for review. <br><br>
|
|
276
274
|
This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890` and must correspond to an existing brand in your account that is ready for submission.
|
|
277
|
-
|
|
275
|
+
|
|
278
276
|
</dd>
|
|
279
277
|
</dl>
|
|
280
278
|
|
|
281
279
|
<dl>
|
|
282
280
|
<dd>
|
|
283
281
|
|
|
284
|
-
**requestOptions:** `Brands.RequestOptions`
|
|
285
|
-
|
|
282
|
+
**requestOptions:** `Brands.RequestOptions`
|
|
283
|
+
|
|
286
284
|
</dd>
|
|
287
285
|
</dl>
|
|
288
286
|
</dd>
|
|
289
287
|
</dl>
|
|
290
288
|
|
|
289
|
+
|
|
291
290
|
</dd>
|
|
292
291
|
</dl>
|
|
293
292
|
</details>
|
|
@@ -305,7 +304,6 @@ This identifier is a string that always begins with the prefix `b_`, for example
|
|
|
305
304
|
<dd>
|
|
306
305
|
|
|
307
306
|
Validate your brand information for compliance and correctness before submission or storage.
|
|
308
|
-
|
|
309
307
|
</dd>
|
|
310
308
|
</dl>
|
|
311
309
|
</dd>
|
|
@@ -326,7 +324,7 @@ await client.brands.validate({
|
|
|
326
324
|
email: "michael.chen@trypinnacle.app",
|
|
327
325
|
name: "Michael Chen",
|
|
328
326
|
phone: "+14155551234",
|
|
329
|
-
title: "Customer Support Representative"
|
|
327
|
+
title: "Customer Support Representative"
|
|
330
328
|
},
|
|
331
329
|
dba: "Pinnacle Messaging",
|
|
332
330
|
description: "Pinnacle is an SMS, MMS, and RCS API for scaling conversations with customers you value.",
|
|
@@ -335,10 +333,11 @@ await client.brands.validate({
|
|
|
335
333
|
name: "Pinnacle",
|
|
336
334
|
sector: "TECHNOLOGY",
|
|
337
335
|
type: "PRIVATE_PROFIT",
|
|
338
|
-
|
|
336
|
+
entityType: "LLC",
|
|
337
|
+
website: "https://www.pinnacle.sh"
|
|
339
338
|
});
|
|
340
|
-
```
|
|
341
339
|
|
|
340
|
+
```
|
|
342
341
|
</dd>
|
|
343
342
|
</dl>
|
|
344
343
|
</dd>
|
|
@@ -352,21 +351,22 @@ await client.brands.validate({
|
|
|
352
351
|
<dl>
|
|
353
352
|
<dd>
|
|
354
353
|
|
|
355
|
-
**request:** `Pinnacle.ValidateBrandParams`
|
|
356
|
-
|
|
354
|
+
**request:** `Pinnacle.ValidateBrandParams`
|
|
355
|
+
|
|
357
356
|
</dd>
|
|
358
357
|
</dl>
|
|
359
358
|
|
|
360
359
|
<dl>
|
|
361
360
|
<dd>
|
|
362
361
|
|
|
363
|
-
**requestOptions:** `Brands.RequestOptions`
|
|
364
|
-
|
|
362
|
+
**requestOptions:** `Brands.RequestOptions`
|
|
363
|
+
|
|
365
364
|
</dd>
|
|
366
365
|
</dl>
|
|
367
366
|
</dd>
|
|
368
367
|
</dl>
|
|
369
368
|
|
|
369
|
+
|
|
370
370
|
</dd>
|
|
371
371
|
</dl>
|
|
372
372
|
</details>
|
|
@@ -384,7 +384,6 @@ await client.brands.validate({
|
|
|
384
384
|
<dd>
|
|
385
385
|
|
|
386
386
|
Submit a brand for external vetting verification to enhance your brand's trust score and improved message delivery rates.
|
|
387
|
-
|
|
388
387
|
</dd>
|
|
389
388
|
</dl>
|
|
390
389
|
</dd>
|
|
@@ -400,8 +399,8 @@ Submit a brand for external vetting verification to enhance your brand's trust s
|
|
|
400
399
|
|
|
401
400
|
```typescript
|
|
402
401
|
await client.brands.vet("b_1234567890", {});
|
|
403
|
-
```
|
|
404
402
|
|
|
403
|
+
```
|
|
405
404
|
</dd>
|
|
406
405
|
</dl>
|
|
407
406
|
</dd>
|
|
@@ -415,40 +414,40 @@ await client.brands.vet("b_1234567890", {});
|
|
|
415
414
|
<dl>
|
|
416
415
|
<dd>
|
|
417
416
|
|
|
418
|
-
**brandId:** `string`
|
|
417
|
+
**brandId:** `string`
|
|
419
418
|
|
|
420
419
|
The unique identifier of the brand to vet. <br>
|
|
421
420
|
|
|
422
421
|
This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890` and must correspond to an existing brand in your account that is ready for vetting.
|
|
423
|
-
|
|
422
|
+
|
|
424
423
|
</dd>
|
|
425
424
|
</dl>
|
|
426
425
|
|
|
427
426
|
<dl>
|
|
428
427
|
<dd>
|
|
429
428
|
|
|
430
|
-
**request:** `Pinnacle.VetBrandParams`
|
|
431
|
-
|
|
429
|
+
**request:** `Pinnacle.VetBrandParams`
|
|
430
|
+
|
|
432
431
|
</dd>
|
|
433
432
|
</dl>
|
|
434
433
|
|
|
435
434
|
<dl>
|
|
436
435
|
<dd>
|
|
437
436
|
|
|
438
|
-
**requestOptions:** `Brands.RequestOptions`
|
|
439
|
-
|
|
437
|
+
**requestOptions:** `Brands.RequestOptions`
|
|
438
|
+
|
|
440
439
|
</dd>
|
|
441
440
|
</dl>
|
|
442
441
|
</dd>
|
|
443
442
|
</dl>
|
|
444
443
|
|
|
444
|
+
|
|
445
445
|
</dd>
|
|
446
446
|
</dl>
|
|
447
447
|
</details>
|
|
448
448
|
|
|
449
|
-
##
|
|
450
|
-
|
|
451
|
-
<details><summary><code>client.contacts.<a href="/src/api/resources/contacts/client/Client.ts">get</a>({ ...params }) -> Pinnacle.Contact</code></summary>
|
|
449
|
+
## Audiences
|
|
450
|
+
<details><summary><code>client.audiences.<a href="/src/api/resources/audiences/client/Client.ts">get</a>({ ...params }) -> Pinnacle.AudiencesGetResponse</code></summary>
|
|
452
451
|
<dl>
|
|
453
452
|
<dd>
|
|
454
453
|
|
|
@@ -460,8 +459,7 @@ This identifier is a string that always begins with the prefix `b_`, for example
|
|
|
460
459
|
<dl>
|
|
461
460
|
<dd>
|
|
462
461
|
|
|
463
|
-
Retrieve
|
|
464
|
-
|
|
462
|
+
Retrieve an audience by ID with optional pagination.
|
|
465
463
|
</dd>
|
|
466
464
|
</dl>
|
|
467
465
|
</dd>
|
|
@@ -476,11 +474,11 @@ Retrieve contact information for a given number.
|
|
|
476
474
|
<dd>
|
|
477
475
|
|
|
478
476
|
```typescript
|
|
479
|
-
await client.
|
|
480
|
-
id: "
|
|
477
|
+
await client.audiences.get({
|
|
478
|
+
id: "aud_abc123"
|
|
481
479
|
});
|
|
482
|
-
```
|
|
483
480
|
|
|
481
|
+
```
|
|
484
482
|
</dd>
|
|
485
483
|
</dl>
|
|
486
484
|
</dd>
|
|
@@ -494,26 +492,27 @@ await client.contacts.get({
|
|
|
494
492
|
<dl>
|
|
495
493
|
<dd>
|
|
496
494
|
|
|
497
|
-
**request:** `Pinnacle.
|
|
498
|
-
|
|
495
|
+
**request:** `Pinnacle.AudiencesGetRequest`
|
|
496
|
+
|
|
499
497
|
</dd>
|
|
500
498
|
</dl>
|
|
501
499
|
|
|
502
500
|
<dl>
|
|
503
501
|
<dd>
|
|
504
502
|
|
|
505
|
-
**requestOptions:** `
|
|
506
|
-
|
|
503
|
+
**requestOptions:** `Audiences.RequestOptions`
|
|
504
|
+
|
|
507
505
|
</dd>
|
|
508
506
|
</dl>
|
|
509
507
|
</dd>
|
|
510
508
|
</dl>
|
|
511
509
|
|
|
510
|
+
|
|
512
511
|
</dd>
|
|
513
512
|
</dl>
|
|
514
513
|
</details>
|
|
515
514
|
|
|
516
|
-
<details><summary><code>client.
|
|
515
|
+
<details><summary><code>client.audiences.<a href="/src/api/resources/audiences/client/Client.ts">create</a>({ ...params }) -> Pinnacle.AudienceCountOnly</code></summary>
|
|
517
516
|
<dl>
|
|
518
517
|
<dd>
|
|
519
518
|
|
|
@@ -525,8 +524,7 @@ await client.contacts.get({
|
|
|
525
524
|
<dl>
|
|
526
525
|
<dd>
|
|
527
526
|
|
|
528
|
-
Create a new
|
|
529
|
-
|
|
527
|
+
Create a new audience with optional initial contacts. Phone numbers that don't exist will be auto-created as contacts.
|
|
530
528
|
</dd>
|
|
531
529
|
</dl>
|
|
532
530
|
</dd>
|
|
@@ -541,11 +539,12 @@ Create a new contact for a given phone number.
|
|
|
541
539
|
<dd>
|
|
542
540
|
|
|
543
541
|
```typescript
|
|
544
|
-
await client.
|
|
545
|
-
|
|
542
|
+
await client.audiences.create({
|
|
543
|
+
name: "Marketing Campaign Q1",
|
|
544
|
+
description: "Contacts for Q1 marketing push"
|
|
546
545
|
});
|
|
547
|
-
```
|
|
548
546
|
|
|
547
|
+
```
|
|
549
548
|
</dd>
|
|
550
549
|
</dl>
|
|
551
550
|
</dd>
|
|
@@ -559,26 +558,27 @@ await client.contacts.create({
|
|
|
559
558
|
<dl>
|
|
560
559
|
<dd>
|
|
561
560
|
|
|
562
|
-
**request:** `Pinnacle.
|
|
563
|
-
|
|
561
|
+
**request:** `Pinnacle.CreateAudienceParams`
|
|
562
|
+
|
|
564
563
|
</dd>
|
|
565
564
|
</dl>
|
|
566
565
|
|
|
567
566
|
<dl>
|
|
568
567
|
<dd>
|
|
569
568
|
|
|
570
|
-
**requestOptions:** `
|
|
571
|
-
|
|
569
|
+
**requestOptions:** `Audiences.RequestOptions`
|
|
570
|
+
|
|
572
571
|
</dd>
|
|
573
572
|
</dl>
|
|
574
573
|
</dd>
|
|
575
574
|
</dl>
|
|
576
575
|
|
|
576
|
+
|
|
577
577
|
</dd>
|
|
578
578
|
</dl>
|
|
579
579
|
</details>
|
|
580
580
|
|
|
581
|
-
<details><summary><code>client.
|
|
581
|
+
<details><summary><code>client.audiences.<a href="/src/api/resources/audiences/client/Client.ts">delete</a>({ ...params }) -> Pinnacle.DeleteAudienceResponse</code></summary>
|
|
582
582
|
<dl>
|
|
583
583
|
<dd>
|
|
584
584
|
|
|
@@ -590,8 +590,9 @@ await client.contacts.create({
|
|
|
590
590
|
<dl>
|
|
591
591
|
<dd>
|
|
592
592
|
|
|
593
|
-
|
|
593
|
+
Permanently delete an audience and all its contact associations.
|
|
594
594
|
|
|
595
|
+
Note: This will NOT delete the contacts themselves, only the audience and its memberships.
|
|
595
596
|
</dd>
|
|
596
597
|
</dl>
|
|
597
598
|
</dd>
|
|
@@ -606,15 +607,11 @@ Update an existing contact.
|
|
|
606
607
|
<dd>
|
|
607
608
|
|
|
608
609
|
```typescript
|
|
609
|
-
await client.
|
|
610
|
-
|
|
611
|
-
email: "alvaroopedtech@pinnacle.sh",
|
|
612
|
-
name: "Retired Bestie",
|
|
613
|
-
tags: ["friend"],
|
|
614
|
-
id: "co_1234567890",
|
|
610
|
+
await client.audiences.delete({
|
|
611
|
+
id: "aud_abc123"
|
|
615
612
|
});
|
|
616
|
-
```
|
|
617
613
|
|
|
614
|
+
```
|
|
618
615
|
</dd>
|
|
619
616
|
</dl>
|
|
620
617
|
</dd>
|
|
@@ -628,28 +625,27 @@ await client.contacts.update({
|
|
|
628
625
|
<dl>
|
|
629
626
|
<dd>
|
|
630
627
|
|
|
631
|
-
**request:** `Pinnacle.
|
|
632
|
-
|
|
628
|
+
**request:** `Pinnacle.AudiencesDeleteRequest`
|
|
629
|
+
|
|
633
630
|
</dd>
|
|
634
631
|
</dl>
|
|
635
632
|
|
|
636
633
|
<dl>
|
|
637
634
|
<dd>
|
|
638
635
|
|
|
639
|
-
**requestOptions:** `
|
|
640
|
-
|
|
636
|
+
**requestOptions:** `Audiences.RequestOptions`
|
|
637
|
+
|
|
641
638
|
</dd>
|
|
642
639
|
</dl>
|
|
643
640
|
</dd>
|
|
644
641
|
</dl>
|
|
645
642
|
|
|
643
|
+
|
|
646
644
|
</dd>
|
|
647
645
|
</dl>
|
|
648
646
|
</details>
|
|
649
647
|
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
<details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">get</a>({ ...params }) -> Pinnacle.Conversation | null</code></summary>
|
|
648
|
+
<details><summary><code>client.audiences.<a href="/src/api/resources/audiences/client/Client.ts">update</a>({ ...params }) -> Pinnacle.AudienceCountOnly</code></summary>
|
|
653
649
|
<dl>
|
|
654
650
|
<dd>
|
|
655
651
|
|
|
@@ -661,8 +657,9 @@ await client.contacts.update({
|
|
|
661
657
|
<dl>
|
|
662
658
|
<dd>
|
|
663
659
|
|
|
664
|
-
|
|
660
|
+
Update audience metadata. This endpoint does NOT modify contacts.
|
|
665
661
|
|
|
662
|
+
To add or remove contacts, use the [Add Contacts](/api-reference/audiences/add-contacts) or [Remove Contacts](/api-reference/audiences/remove-contacts) endpoints.
|
|
666
663
|
</dd>
|
|
667
664
|
</dl>
|
|
668
665
|
</dd>
|
|
@@ -677,11 +674,13 @@ Fetch a specific conversation using either its unique identifier or by matching
|
|
|
677
674
|
<dd>
|
|
678
675
|
|
|
679
676
|
```typescript
|
|
680
|
-
await client.
|
|
681
|
-
id: "
|
|
677
|
+
await client.audiences.update({
|
|
678
|
+
id: "aud_abc123",
|
|
679
|
+
name: "Updated Audience Name",
|
|
680
|
+
description: "New description"
|
|
682
681
|
});
|
|
683
|
-
```
|
|
684
682
|
|
|
683
|
+
```
|
|
685
684
|
</dd>
|
|
686
685
|
</dl>
|
|
687
686
|
</dd>
|
|
@@ -695,26 +694,28 @@ await client.conversations.get({
|
|
|
695
694
|
<dl>
|
|
696
695
|
<dd>
|
|
697
696
|
|
|
698
|
-
**request:** `Pinnacle.
|
|
699
|
-
|
|
697
|
+
**request:** `Pinnacle.UpdateAudienceParams`
|
|
698
|
+
|
|
700
699
|
</dd>
|
|
701
700
|
</dl>
|
|
702
701
|
|
|
703
702
|
<dl>
|
|
704
703
|
<dd>
|
|
705
704
|
|
|
706
|
-
**requestOptions:** `
|
|
707
|
-
|
|
705
|
+
**requestOptions:** `Audiences.RequestOptions`
|
|
706
|
+
|
|
708
707
|
</dd>
|
|
709
708
|
</dl>
|
|
710
709
|
</dd>
|
|
711
710
|
</dl>
|
|
712
711
|
|
|
712
|
+
|
|
713
713
|
</dd>
|
|
714
714
|
</dl>
|
|
715
715
|
</details>
|
|
716
716
|
|
|
717
|
-
|
|
717
|
+
## Contacts
|
|
718
|
+
<details><summary><code>client.contacts.<a href="/src/api/resources/contacts/client/Client.ts">get</a>({ ...params }) -> Pinnacle.Contact</code></summary>
|
|
718
719
|
<dl>
|
|
719
720
|
<dd>
|
|
720
721
|
|
|
@@ -726,8 +727,7 @@ await client.conversations.get({
|
|
|
726
727
|
<dl>
|
|
727
728
|
<dd>
|
|
728
729
|
|
|
729
|
-
|
|
730
|
-
|
|
730
|
+
Retrieve contact information for a given number.
|
|
731
731
|
</dd>
|
|
732
732
|
</dl>
|
|
733
733
|
</dd>
|
|
@@ -742,17 +742,11 @@ Retrieves conversations by page with optional filtering based off provided param
|
|
|
742
742
|
<dd>
|
|
743
743
|
|
|
744
744
|
```typescript
|
|
745
|
-
await client.
|
|
746
|
-
|
|
747
|
-
campaignId: "tf_1234567890",
|
|
748
|
-
campaignType: "TOLL_FREE",
|
|
749
|
-
pageIndex: 0,
|
|
750
|
-
pageSize: 20,
|
|
751
|
-
receiver: "+16509231662",
|
|
752
|
-
sender: "+18445551234",
|
|
745
|
+
await client.contacts.get({
|
|
746
|
+
id: "co_1234567890"
|
|
753
747
|
});
|
|
754
|
-
```
|
|
755
748
|
|
|
749
|
+
```
|
|
756
750
|
</dd>
|
|
757
751
|
</dl>
|
|
758
752
|
</dd>
|
|
@@ -766,26 +760,27 @@ await client.conversations.list({
|
|
|
766
760
|
<dl>
|
|
767
761
|
<dd>
|
|
768
762
|
|
|
769
|
-
**request:** `Pinnacle.
|
|
770
|
-
|
|
763
|
+
**request:** `Pinnacle.ContactsGetRequest`
|
|
764
|
+
|
|
771
765
|
</dd>
|
|
772
766
|
</dl>
|
|
773
767
|
|
|
774
768
|
<dl>
|
|
775
769
|
<dd>
|
|
776
770
|
|
|
777
|
-
**requestOptions:** `
|
|
778
|
-
|
|
771
|
+
**requestOptions:** `Contacts.RequestOptions`
|
|
772
|
+
|
|
779
773
|
</dd>
|
|
780
774
|
</dl>
|
|
781
775
|
</dd>
|
|
782
776
|
</dl>
|
|
783
777
|
|
|
778
|
+
|
|
784
779
|
</dd>
|
|
785
780
|
</dl>
|
|
786
781
|
</details>
|
|
787
782
|
|
|
788
|
-
<details><summary><code>client.
|
|
783
|
+
<details><summary><code>client.contacts.<a href="/src/api/resources/contacts/client/Client.ts">create</a>({ ...params }) -> Pinnacle.ContactId</code></summary>
|
|
789
784
|
<dl>
|
|
790
785
|
<dd>
|
|
791
786
|
|
|
@@ -797,8 +792,7 @@ await client.conversations.list({
|
|
|
797
792
|
<dl>
|
|
798
793
|
<dd>
|
|
799
794
|
|
|
800
|
-
|
|
801
|
-
|
|
795
|
+
Create a new contact for a given phone number.
|
|
802
796
|
</dd>
|
|
803
797
|
</dl>
|
|
804
798
|
</dd>
|
|
@@ -813,12 +807,11 @@ Update the notes associated with a specific conversation.
|
|
|
813
807
|
<dd>
|
|
814
808
|
|
|
815
809
|
```typescript
|
|
816
|
-
await client.
|
|
817
|
-
|
|
818
|
-
notes: "Follow-up completed. Customer satisfied with resolution.",
|
|
810
|
+
await client.contacts.create({
|
|
811
|
+
phoneNumber: "phoneNumber"
|
|
819
812
|
});
|
|
820
|
-
```
|
|
821
813
|
|
|
814
|
+
```
|
|
822
815
|
</dd>
|
|
823
816
|
</dl>
|
|
824
817
|
</dd>
|
|
@@ -832,26 +825,27 @@ await client.conversations.update({
|
|
|
832
825
|
<dl>
|
|
833
826
|
<dd>
|
|
834
827
|
|
|
835
|
-
**request:** `Pinnacle.
|
|
836
|
-
|
|
828
|
+
**request:** `Pinnacle.CreateContactParams`
|
|
829
|
+
|
|
837
830
|
</dd>
|
|
838
831
|
</dl>
|
|
839
832
|
|
|
840
833
|
<dl>
|
|
841
834
|
<dd>
|
|
842
835
|
|
|
843
|
-
**requestOptions:** `
|
|
844
|
-
|
|
836
|
+
**requestOptions:** `Contacts.RequestOptions`
|
|
837
|
+
|
|
845
838
|
</dd>
|
|
846
839
|
</dl>
|
|
847
840
|
</dd>
|
|
848
841
|
</dl>
|
|
849
842
|
|
|
843
|
+
|
|
850
844
|
</dd>
|
|
851
845
|
</dl>
|
|
852
846
|
</details>
|
|
853
847
|
|
|
854
|
-
<details><summary><code>client.
|
|
848
|
+
<details><summary><code>client.contacts.<a href="/src/api/resources/contacts/client/Client.ts">update</a>({ ...params }) -> Pinnacle.UpdatedContactId</code></summary>
|
|
855
849
|
<dl>
|
|
856
850
|
<dd>
|
|
857
851
|
|
|
@@ -863,8 +857,7 @@ await client.conversations.update({
|
|
|
863
857
|
<dl>
|
|
864
858
|
<dd>
|
|
865
859
|
|
|
866
|
-
|
|
867
|
-
|
|
860
|
+
Update an existing contact.
|
|
868
861
|
</dd>
|
|
869
862
|
</dl>
|
|
870
863
|
</dd>
|
|
@@ -879,9 +872,15 @@ Retrieve a paginated and filtered list of messages for a specific conversation.
|
|
|
879
872
|
<dd>
|
|
880
873
|
|
|
881
874
|
```typescript
|
|
882
|
-
await client.
|
|
883
|
-
|
|
875
|
+
await client.contacts.update({
|
|
876
|
+
description: "Retired",
|
|
877
|
+
email: "alvaroopedtech@pinnacle.sh",
|
|
878
|
+
name: "Retired Bestie",
|
|
879
|
+
tags: ["friend"],
|
|
880
|
+
id: "co_1234567890"
|
|
881
|
+
});
|
|
884
882
|
|
|
883
|
+
```
|
|
885
884
|
</dd>
|
|
886
885
|
</dl>
|
|
887
886
|
</dd>
|
|
@@ -895,36 +894,28 @@ await client.conversations.listMessages("id");
|
|
|
895
894
|
<dl>
|
|
896
895
|
<dd>
|
|
897
896
|
|
|
898
|
-
**
|
|
899
|
-
|
|
900
|
-
</dd>
|
|
901
|
-
</dl>
|
|
902
|
-
|
|
903
|
-
<dl>
|
|
904
|
-
<dd>
|
|
905
|
-
|
|
906
|
-
**request:** `Pinnacle.ConversationsListMessagesRequest`
|
|
907
|
-
|
|
897
|
+
**request:** `Pinnacle.UpdateContactParams`
|
|
898
|
+
|
|
908
899
|
</dd>
|
|
909
900
|
</dl>
|
|
910
901
|
|
|
911
902
|
<dl>
|
|
912
903
|
<dd>
|
|
913
904
|
|
|
914
|
-
**requestOptions:** `
|
|
915
|
-
|
|
905
|
+
**requestOptions:** `Contacts.RequestOptions`
|
|
906
|
+
|
|
916
907
|
</dd>
|
|
917
908
|
</dl>
|
|
918
909
|
</dd>
|
|
919
910
|
</dl>
|
|
920
911
|
|
|
912
|
+
|
|
921
913
|
</dd>
|
|
922
914
|
</dl>
|
|
923
915
|
</details>
|
|
924
916
|
|
|
925
|
-
##
|
|
926
|
-
|
|
927
|
-
<details><summary><code>client.messages.<a href="/src/api/resources/messages/client/Client.ts">get</a>(id) -> Pinnacle.Message</code></summary>
|
|
917
|
+
## Conversations
|
|
918
|
+
<details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">get</a>({ ...params }) -> Pinnacle.Conversation | null</code></summary>
|
|
928
919
|
<dl>
|
|
929
920
|
<dd>
|
|
930
921
|
|
|
@@ -936,8 +927,7 @@ await client.conversations.listMessages("id");
|
|
|
936
927
|
<dl>
|
|
937
928
|
<dd>
|
|
938
929
|
|
|
939
|
-
|
|
940
|
-
|
|
930
|
+
Fetch a specific conversation using either its unique identifier or by matching sender and recipient details.
|
|
941
931
|
</dd>
|
|
942
932
|
</dl>
|
|
943
933
|
</dd>
|
|
@@ -952,9 +942,11 @@ Retrieve a previously sent message.
|
|
|
952
942
|
<dd>
|
|
953
943
|
|
|
954
944
|
```typescript
|
|
955
|
-
await client.
|
|
956
|
-
|
|
945
|
+
await client.conversations.get({
|
|
946
|
+
id: "conv_1234567890"
|
|
947
|
+
});
|
|
957
948
|
|
|
949
|
+
```
|
|
958
950
|
</dd>
|
|
959
951
|
</dl>
|
|
960
952
|
</dd>
|
|
@@ -968,26 +960,27 @@ await client.messages.get("msg_1234567890");
|
|
|
968
960
|
<dl>
|
|
969
961
|
<dd>
|
|
970
962
|
|
|
971
|
-
**
|
|
972
|
-
|
|
963
|
+
**request:** `Pinnacle.GetConversationParams`
|
|
964
|
+
|
|
973
965
|
</dd>
|
|
974
966
|
</dl>
|
|
975
967
|
|
|
976
968
|
<dl>
|
|
977
969
|
<dd>
|
|
978
970
|
|
|
979
|
-
**requestOptions:** `
|
|
980
|
-
|
|
971
|
+
**requestOptions:** `Conversations.RequestOptions`
|
|
972
|
+
|
|
981
973
|
</dd>
|
|
982
974
|
</dl>
|
|
983
975
|
</dd>
|
|
984
976
|
</dl>
|
|
985
977
|
|
|
978
|
+
|
|
986
979
|
</dd>
|
|
987
980
|
</dl>
|
|
988
981
|
</details>
|
|
989
982
|
|
|
990
|
-
<details><summary><code>client.
|
|
983
|
+
<details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">list</a>({ ...params }) -> Pinnacle.ConversationList</code></summary>
|
|
991
984
|
<dl>
|
|
992
985
|
<dd>
|
|
993
986
|
|
|
@@ -999,8 +992,7 @@ await client.messages.get("msg_1234567890");
|
|
|
999
992
|
<dl>
|
|
1000
993
|
<dd>
|
|
1001
994
|
|
|
1002
|
-
|
|
1003
|
-
|
|
995
|
+
Retrieves conversations by page with optional filtering based off provided parameters.
|
|
1004
996
|
</dd>
|
|
1005
997
|
</dl>
|
|
1006
998
|
</dd>
|
|
@@ -1015,15 +1007,17 @@ Add or remove an emoji reaction to a previously sent message.
|
|
|
1015
1007
|
<dd>
|
|
1016
1008
|
|
|
1017
1009
|
```typescript
|
|
1018
|
-
await client.
|
|
1019
|
-
|
|
1020
|
-
|
|
1021
|
-
|
|
1022
|
-
|
|
1023
|
-
|
|
1010
|
+
await client.conversations.list({
|
|
1011
|
+
brandId: "b_1234567890",
|
|
1012
|
+
campaignId: "tf_1234567890",
|
|
1013
|
+
campaignType: "TOLL_FREE",
|
|
1014
|
+
pageIndex: 0,
|
|
1015
|
+
pageSize: 20,
|
|
1016
|
+
receiver: "+16509231662",
|
|
1017
|
+
sender: "+18445551234"
|
|
1024
1018
|
});
|
|
1025
|
-
```
|
|
1026
1019
|
|
|
1020
|
+
```
|
|
1027
1021
|
</dd>
|
|
1028
1022
|
</dl>
|
|
1029
1023
|
</dd>
|
|
@@ -1037,28 +1031,27 @@ await client.messages.react({
|
|
|
1037
1031
|
<dl>
|
|
1038
1032
|
<dd>
|
|
1039
1033
|
|
|
1040
|
-
**request:** `Pinnacle.
|
|
1041
|
-
|
|
1034
|
+
**request:** `Pinnacle.ListConversationsParams`
|
|
1035
|
+
|
|
1042
1036
|
</dd>
|
|
1043
1037
|
</dl>
|
|
1044
1038
|
|
|
1045
1039
|
<dl>
|
|
1046
1040
|
<dd>
|
|
1047
1041
|
|
|
1048
|
-
**requestOptions:** `
|
|
1049
|
-
|
|
1042
|
+
**requestOptions:** `Conversations.RequestOptions`
|
|
1043
|
+
|
|
1050
1044
|
</dd>
|
|
1051
1045
|
</dl>
|
|
1052
1046
|
</dd>
|
|
1053
1047
|
</dl>
|
|
1054
1048
|
|
|
1049
|
+
|
|
1055
1050
|
</dd>
|
|
1056
1051
|
</dl>
|
|
1057
1052
|
</details>
|
|
1058
1053
|
|
|
1059
|
-
|
|
1060
|
-
|
|
1061
|
-
<details><summary><code>client.phoneNumbers.<a href="/src/api/resources/phoneNumbers/client/Client.ts">search</a>({ ...params }) -> Pinnacle.PhoneNumberDetails[]</code></summary>
|
|
1054
|
+
<details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">update</a>({ ...params }) -> Pinnacle.SuccessfulConversationUpdate</code></summary>
|
|
1062
1055
|
<dl>
|
|
1063
1056
|
<dd>
|
|
1064
1057
|
|
|
@@ -1070,8 +1063,7 @@ await client.messages.react({
|
|
|
1070
1063
|
<dl>
|
|
1071
1064
|
<dd>
|
|
1072
1065
|
|
|
1073
|
-
|
|
1074
|
-
|
|
1066
|
+
Update the notes associated with a specific conversation.
|
|
1075
1067
|
</dd>
|
|
1076
1068
|
</dl>
|
|
1077
1069
|
</dd>
|
|
@@ -1086,23 +1078,12 @@ Search for available phone numbers that match your exact criteria.
|
|
|
1086
1078
|
<dd>
|
|
1087
1079
|
|
|
1088
1080
|
```typescript
|
|
1089
|
-
await client.
|
|
1090
|
-
|
|
1091
|
-
|
|
1092
|
-
city: "New York",
|
|
1093
|
-
nationalDestinationCode: "212",
|
|
1094
|
-
},
|
|
1095
|
-
number: {
|
|
1096
|
-
contains: "514",
|
|
1097
|
-
startsWith: "45",
|
|
1098
|
-
},
|
|
1099
|
-
options: {
|
|
1100
|
-
limit: 4,
|
|
1101
|
-
},
|
|
1102
|
-
type: ["LOCAL"],
|
|
1081
|
+
await client.conversations.update({
|
|
1082
|
+
id: "conv_1234567890",
|
|
1083
|
+
notes: "Follow-up completed. Customer satisfied with resolution."
|
|
1103
1084
|
});
|
|
1104
|
-
```
|
|
1105
1085
|
|
|
1086
|
+
```
|
|
1106
1087
|
</dd>
|
|
1107
1088
|
</dl>
|
|
1108
1089
|
</dd>
|
|
@@ -1116,26 +1097,27 @@ await client.phoneNumbers.search({
|
|
|
1116
1097
|
<dl>
|
|
1117
1098
|
<dd>
|
|
1118
1099
|
|
|
1119
|
-
**request:** `Pinnacle.
|
|
1120
|
-
|
|
1100
|
+
**request:** `Pinnacle.UpdateConversationParams`
|
|
1101
|
+
|
|
1121
1102
|
</dd>
|
|
1122
1103
|
</dl>
|
|
1123
1104
|
|
|
1124
1105
|
<dl>
|
|
1125
1106
|
<dd>
|
|
1126
1107
|
|
|
1127
|
-
**requestOptions:** `
|
|
1128
|
-
|
|
1108
|
+
**requestOptions:** `Conversations.RequestOptions`
|
|
1109
|
+
|
|
1129
1110
|
</dd>
|
|
1130
1111
|
</dl>
|
|
1131
1112
|
</dd>
|
|
1132
1113
|
</dl>
|
|
1133
1114
|
|
|
1115
|
+
|
|
1134
1116
|
</dd>
|
|
1135
1117
|
</dl>
|
|
1136
1118
|
</details>
|
|
1137
1119
|
|
|
1138
|
-
<details><summary><code>client.
|
|
1120
|
+
<details><summary><code>client.conversations.<a href="/src/api/resources/conversations/client/Client.ts">listMessages</a>(id, { ...params }) -> Pinnacle.MessageList</code></summary>
|
|
1139
1121
|
<dl>
|
|
1140
1122
|
<dd>
|
|
1141
1123
|
|
|
@@ -1147,10 +1129,7 @@ await client.phoneNumbers.search({
|
|
|
1147
1129
|
<dl>
|
|
1148
1130
|
<dd>
|
|
1149
1131
|
|
|
1150
|
-
|
|
1151
|
-
|
|
1152
|
-
Billing uses your account credits and the numbers are ready for immediate use.
|
|
1153
|
-
|
|
1132
|
+
Retrieve a paginated and filtered list of messages for a specific conversation.
|
|
1154
1133
|
</dd>
|
|
1155
1134
|
</dl>
|
|
1156
1135
|
</dd>
|
|
@@ -1165,11 +1144,9 @@ Billing uses your account credits and the numbers are ready for immediate use.
|
|
|
1165
1144
|
<dd>
|
|
1166
1145
|
|
|
1167
1146
|
```typescript
|
|
1168
|
-
await client.
|
|
1169
|
-
numbers: ["+18559491727"],
|
|
1170
|
-
});
|
|
1171
|
-
```
|
|
1147
|
+
await client.conversations.listMessages("id");
|
|
1172
1148
|
|
|
1149
|
+
```
|
|
1173
1150
|
</dd>
|
|
1174
1151
|
</dl>
|
|
1175
1152
|
</dd>
|
|
@@ -1183,26 +1160,36 @@ await client.phoneNumbers.buy({
|
|
|
1183
1160
|
<dl>
|
|
1184
1161
|
<dd>
|
|
1185
1162
|
|
|
1186
|
-
**
|
|
1187
|
-
|
|
1163
|
+
**id:** `string` — Unique identifier of the conversation. This identifier is a string that always begins with the prefix `conv_`, for example: `conv_1234567890`.
|
|
1164
|
+
|
|
1188
1165
|
</dd>
|
|
1189
1166
|
</dl>
|
|
1190
1167
|
|
|
1191
1168
|
<dl>
|
|
1192
1169
|
<dd>
|
|
1193
1170
|
|
|
1194
|
-
**
|
|
1171
|
+
**request:** `Pinnacle.ConversationsListMessagesRequest`
|
|
1172
|
+
|
|
1173
|
+
</dd>
|
|
1174
|
+
</dl>
|
|
1175
|
+
|
|
1176
|
+
<dl>
|
|
1177
|
+
<dd>
|
|
1195
1178
|
|
|
1179
|
+
**requestOptions:** `Conversations.RequestOptions`
|
|
1180
|
+
|
|
1196
1181
|
</dd>
|
|
1197
1182
|
</dl>
|
|
1198
1183
|
</dd>
|
|
1199
1184
|
</dl>
|
|
1200
1185
|
|
|
1186
|
+
|
|
1201
1187
|
</dd>
|
|
1202
1188
|
</dl>
|
|
1203
1189
|
</details>
|
|
1204
1190
|
|
|
1205
|
-
|
|
1191
|
+
## Messages
|
|
1192
|
+
<details><summary><code>client.messages.<a href="/src/api/resources/messages/client/Client.ts">get</a>(id) -> Pinnacle.Message</code></summary>
|
|
1206
1193
|
<dl>
|
|
1207
1194
|
<dd>
|
|
1208
1195
|
|
|
@@ -1214,8 +1201,7 @@ await client.phoneNumbers.buy({
|
|
|
1214
1201
|
<dl>
|
|
1215
1202
|
<dd>
|
|
1216
1203
|
|
|
1217
|
-
Retrieve
|
|
1218
|
-
|
|
1204
|
+
Retrieve a previously sent message.
|
|
1219
1205
|
</dd>
|
|
1220
1206
|
</dl>
|
|
1221
1207
|
</dd>
|
|
@@ -1230,18 +1216,9 @@ Retrieve information about any phone number.
|
|
|
1230
1216
|
<dd>
|
|
1231
1217
|
|
|
1232
1218
|
```typescript
|
|
1233
|
-
await client.
|
|
1234
|
-
phone: "+11234567890",
|
|
1235
|
-
level: "advanced",
|
|
1236
|
-
options: {
|
|
1237
|
-
risk: true,
|
|
1238
|
-
enhanced_contact_info: {
|
|
1239
|
-
context: "This is my friend from JZ. He has done a lot in the crypto space.",
|
|
1240
|
-
},
|
|
1241
|
-
},
|
|
1242
|
-
});
|
|
1243
|
-
```
|
|
1219
|
+
await client.messages.get("msg_1234567890");
|
|
1244
1220
|
|
|
1221
|
+
```
|
|
1245
1222
|
</dd>
|
|
1246
1223
|
</dl>
|
|
1247
1224
|
</dd>
|
|
@@ -1255,28 +1232,27 @@ await client.phoneNumbers.get({
|
|
|
1255
1232
|
<dl>
|
|
1256
1233
|
<dd>
|
|
1257
1234
|
|
|
1258
|
-
**
|
|
1259
|
-
|
|
1235
|
+
**id:** `string` — Unique identifier of the message. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`.
|
|
1236
|
+
|
|
1260
1237
|
</dd>
|
|
1261
1238
|
</dl>
|
|
1262
1239
|
|
|
1263
1240
|
<dl>
|
|
1264
1241
|
<dd>
|
|
1265
1242
|
|
|
1266
|
-
**requestOptions:** `
|
|
1267
|
-
|
|
1243
|
+
**requestOptions:** `Messages.RequestOptions`
|
|
1244
|
+
|
|
1268
1245
|
</dd>
|
|
1269
1246
|
</dl>
|
|
1270
1247
|
</dd>
|
|
1271
1248
|
</dl>
|
|
1272
1249
|
|
|
1250
|
+
|
|
1273
1251
|
</dd>
|
|
1274
1252
|
</dl>
|
|
1275
1253
|
</details>
|
|
1276
1254
|
|
|
1277
|
-
|
|
1278
|
-
|
|
1279
|
-
<details><summary><code>client.rcs.<a href="/src/api/resources/rcs/client/Client.ts">getCapabilities</a>({ ...params }) -> Pinnacle.RcsCapabilitiesResult</code></summary>
|
|
1255
|
+
<details><summary><code>client.messages.<a href="/src/api/resources/messages/client/Client.ts">react</a>({ ...params }) -> Pinnacle.ReactionResult</code></summary>
|
|
1280
1256
|
<dl>
|
|
1281
1257
|
<dd>
|
|
1282
1258
|
|
|
@@ -1288,11 +1264,7 @@ await client.phoneNumbers.get({
|
|
|
1288
1264
|
<dl>
|
|
1289
1265
|
<dd>
|
|
1290
1266
|
|
|
1291
|
-
|
|
1292
|
-
|
|
1293
|
-
This endpoint allows you to verify which RCS features (cards, buttons, etc.) are supported
|
|
1294
|
-
on specific phone numbers before sending RCS messages to them.
|
|
1295
|
-
|
|
1267
|
+
Add or remove an emoji reaction to a previously sent message.
|
|
1296
1268
|
</dd>
|
|
1297
1269
|
</dl>
|
|
1298
1270
|
</dd>
|
|
@@ -1307,11 +1279,300 @@ on specific phone numbers before sending RCS messages to them.
|
|
|
1307
1279
|
<dd>
|
|
1308
1280
|
|
|
1309
1281
|
```typescript
|
|
1310
|
-
await client.
|
|
1311
|
-
|
|
1312
|
-
|
|
1282
|
+
await client.messages.react({
|
|
1283
|
+
messageId: "msg_1234567890",
|
|
1284
|
+
options: {
|
|
1285
|
+
force: true
|
|
1286
|
+
},
|
|
1287
|
+
reaction: "\uD83D\uDC4D"
|
|
1288
|
+
});
|
|
1289
|
+
|
|
1290
|
+
```
|
|
1291
|
+
</dd>
|
|
1292
|
+
</dl>
|
|
1293
|
+
</dd>
|
|
1294
|
+
</dl>
|
|
1295
|
+
|
|
1296
|
+
#### ⚙️ Parameters
|
|
1297
|
+
|
|
1298
|
+
<dl>
|
|
1299
|
+
<dd>
|
|
1300
|
+
|
|
1301
|
+
<dl>
|
|
1302
|
+
<dd>
|
|
1303
|
+
|
|
1304
|
+
**request:** `Pinnacle.ReactMessageParams`
|
|
1305
|
+
|
|
1306
|
+
</dd>
|
|
1307
|
+
</dl>
|
|
1308
|
+
|
|
1309
|
+
<dl>
|
|
1310
|
+
<dd>
|
|
1311
|
+
|
|
1312
|
+
**requestOptions:** `Messages.RequestOptions`
|
|
1313
|
+
|
|
1314
|
+
</dd>
|
|
1315
|
+
</dl>
|
|
1316
|
+
</dd>
|
|
1317
|
+
</dl>
|
|
1318
|
+
|
|
1319
|
+
|
|
1320
|
+
</dd>
|
|
1321
|
+
</dl>
|
|
1322
|
+
</details>
|
|
1323
|
+
|
|
1324
|
+
<details><summary><code>client.messages.<a href="/src/api/resources/messages/client/Client.ts">cancel</a>(id) -> Pinnacle.CancelScheduledMessageResponse</code></summary>
|
|
1325
|
+
<dl>
|
|
1326
|
+
<dd>
|
|
1327
|
+
|
|
1328
|
+
#### 📝 Description
|
|
1329
|
+
|
|
1330
|
+
<dl>
|
|
1331
|
+
<dd>
|
|
1332
|
+
|
|
1333
|
+
<dl>
|
|
1334
|
+
<dd>
|
|
1335
|
+
|
|
1336
|
+
Cancel a previously scheduled message before it is sent.
|
|
1337
|
+
|
|
1338
|
+
Use the `scheduleId` returned from a scheduled send request (SMS, MMS, or RCS) to cancel the message.
|
|
1339
|
+
Once cancelled, the scheduled message will stop being sent.
|
|
1340
|
+
|
|
1341
|
+
> **Note:** You cannot cancel a message that has already been sent.
|
|
1342
|
+
</dd>
|
|
1343
|
+
</dl>
|
|
1344
|
+
</dd>
|
|
1345
|
+
</dl>
|
|
1346
|
+
|
|
1347
|
+
#### 🔌 Usage
|
|
1348
|
+
|
|
1349
|
+
<dl>
|
|
1350
|
+
<dd>
|
|
1351
|
+
|
|
1352
|
+
<dl>
|
|
1353
|
+
<dd>
|
|
1354
|
+
|
|
1355
|
+
```typescript
|
|
1356
|
+
await client.messages.cancel("msg_sched_1234567890");
|
|
1357
|
+
|
|
1358
|
+
```
|
|
1359
|
+
</dd>
|
|
1360
|
+
</dl>
|
|
1361
|
+
</dd>
|
|
1362
|
+
</dl>
|
|
1363
|
+
|
|
1364
|
+
#### ⚙️ Parameters
|
|
1365
|
+
|
|
1366
|
+
<dl>
|
|
1367
|
+
<dd>
|
|
1368
|
+
|
|
1369
|
+
<dl>
|
|
1370
|
+
<dd>
|
|
1371
|
+
|
|
1372
|
+
**id:** `string` — Unique identifier of the scheduled message. This identifier is a string that always begins with the prefix `msg_sched_`, for example: `msg_sched_1234567890`.
|
|
1373
|
+
|
|
1374
|
+
</dd>
|
|
1375
|
+
</dl>
|
|
1376
|
+
|
|
1377
|
+
<dl>
|
|
1378
|
+
<dd>
|
|
1379
|
+
|
|
1380
|
+
**requestOptions:** `Messages.RequestOptions`
|
|
1381
|
+
|
|
1382
|
+
</dd>
|
|
1383
|
+
</dl>
|
|
1384
|
+
</dd>
|
|
1385
|
+
</dl>
|
|
1386
|
+
|
|
1387
|
+
|
|
1388
|
+
</dd>
|
|
1389
|
+
</dl>
|
|
1390
|
+
</details>
|
|
1391
|
+
|
|
1392
|
+
## PhoneNumbers
|
|
1393
|
+
<details><summary><code>client.phoneNumbers.<a href="/src/api/resources/phoneNumbers/client/Client.ts">search</a>({ ...params }) -> Pinnacle.PhoneNumberDetails[]</code></summary>
|
|
1394
|
+
<dl>
|
|
1395
|
+
<dd>
|
|
1396
|
+
|
|
1397
|
+
#### 📝 Description
|
|
1398
|
+
|
|
1399
|
+
<dl>
|
|
1400
|
+
<dd>
|
|
1401
|
+
|
|
1402
|
+
<dl>
|
|
1403
|
+
<dd>
|
|
1404
|
+
|
|
1405
|
+
Search for available phone numbers that match your exact criteria.
|
|
1406
|
+
</dd>
|
|
1407
|
+
</dl>
|
|
1408
|
+
</dd>
|
|
1409
|
+
</dl>
|
|
1410
|
+
|
|
1411
|
+
#### 🔌 Usage
|
|
1412
|
+
|
|
1413
|
+
<dl>
|
|
1414
|
+
<dd>
|
|
1415
|
+
|
|
1416
|
+
<dl>
|
|
1417
|
+
<dd>
|
|
1418
|
+
|
|
1419
|
+
```typescript
|
|
1420
|
+
await client.phoneNumbers.search({
|
|
1421
|
+
features: ["SMS", "MMS"],
|
|
1422
|
+
location: {
|
|
1423
|
+
city: "New York",
|
|
1424
|
+
nationalDestinationCode: "212"
|
|
1425
|
+
},
|
|
1426
|
+
number: {
|
|
1427
|
+
contains: "514",
|
|
1428
|
+
startsWith: "45"
|
|
1429
|
+
},
|
|
1430
|
+
options: {
|
|
1431
|
+
limit: 4
|
|
1432
|
+
},
|
|
1433
|
+
type: ["LOCAL"]
|
|
1434
|
+
});
|
|
1435
|
+
|
|
1313
1436
|
```
|
|
1437
|
+
</dd>
|
|
1438
|
+
</dl>
|
|
1439
|
+
</dd>
|
|
1440
|
+
</dl>
|
|
1441
|
+
|
|
1442
|
+
#### ⚙️ Parameters
|
|
1443
|
+
|
|
1444
|
+
<dl>
|
|
1445
|
+
<dd>
|
|
1446
|
+
|
|
1447
|
+
<dl>
|
|
1448
|
+
<dd>
|
|
1449
|
+
|
|
1450
|
+
**request:** `Pinnacle.SearchPhoneNumberParams`
|
|
1451
|
+
|
|
1452
|
+
</dd>
|
|
1453
|
+
</dl>
|
|
1454
|
+
|
|
1455
|
+
<dl>
|
|
1456
|
+
<dd>
|
|
1457
|
+
|
|
1458
|
+
**requestOptions:** `PhoneNumbers.RequestOptions`
|
|
1459
|
+
|
|
1460
|
+
</dd>
|
|
1461
|
+
</dl>
|
|
1462
|
+
</dd>
|
|
1463
|
+
</dl>
|
|
1464
|
+
|
|
1465
|
+
|
|
1466
|
+
</dd>
|
|
1467
|
+
</dl>
|
|
1468
|
+
</details>
|
|
1469
|
+
|
|
1470
|
+
<details><summary><code>client.phoneNumbers.<a href="/src/api/resources/phoneNumbers/client/Client.ts">buy</a>({ ...params }) -> Pinnacle.PurchasedNumber[]</code></summary>
|
|
1471
|
+
<dl>
|
|
1472
|
+
<dd>
|
|
1473
|
+
|
|
1474
|
+
#### 📝 Description
|
|
1475
|
+
|
|
1476
|
+
<dl>
|
|
1477
|
+
<dd>
|
|
1478
|
+
|
|
1479
|
+
<dl>
|
|
1480
|
+
<dd>
|
|
1481
|
+
|
|
1482
|
+
Purchase one or more phone numbers found through the [search endpoint](./search). <br>
|
|
1483
|
+
|
|
1484
|
+
Billing uses your account credits and the numbers are ready for immediate use.
|
|
1485
|
+
</dd>
|
|
1486
|
+
</dl>
|
|
1487
|
+
</dd>
|
|
1488
|
+
</dl>
|
|
1489
|
+
|
|
1490
|
+
#### 🔌 Usage
|
|
1491
|
+
|
|
1492
|
+
<dl>
|
|
1493
|
+
<dd>
|
|
1494
|
+
|
|
1495
|
+
<dl>
|
|
1496
|
+
<dd>
|
|
1497
|
+
|
|
1498
|
+
```typescript
|
|
1499
|
+
await client.phoneNumbers.buy({
|
|
1500
|
+
numbers: ["+18559491727"]
|
|
1501
|
+
});
|
|
1502
|
+
|
|
1503
|
+
```
|
|
1504
|
+
</dd>
|
|
1505
|
+
</dl>
|
|
1506
|
+
</dd>
|
|
1507
|
+
</dl>
|
|
1508
|
+
|
|
1509
|
+
#### ⚙️ Parameters
|
|
1510
|
+
|
|
1511
|
+
<dl>
|
|
1512
|
+
<dd>
|
|
1513
|
+
|
|
1514
|
+
<dl>
|
|
1515
|
+
<dd>
|
|
1516
|
+
|
|
1517
|
+
**request:** `Pinnacle.BuyPhoneNumberParams`
|
|
1518
|
+
|
|
1519
|
+
</dd>
|
|
1520
|
+
</dl>
|
|
1521
|
+
|
|
1522
|
+
<dl>
|
|
1523
|
+
<dd>
|
|
1524
|
+
|
|
1525
|
+
**requestOptions:** `PhoneNumbers.RequestOptions`
|
|
1526
|
+
|
|
1527
|
+
</dd>
|
|
1528
|
+
</dl>
|
|
1529
|
+
</dd>
|
|
1530
|
+
</dl>
|
|
1531
|
+
|
|
1532
|
+
|
|
1533
|
+
</dd>
|
|
1534
|
+
</dl>
|
|
1535
|
+
</details>
|
|
1536
|
+
|
|
1537
|
+
<details><summary><code>client.phoneNumbers.<a href="/src/api/resources/phoneNumbers/client/Client.ts">get</a>({ ...params }) -> Pinnacle.PhoneNumbersGetResponse</code></summary>
|
|
1538
|
+
<dl>
|
|
1539
|
+
<dd>
|
|
1540
|
+
|
|
1541
|
+
#### 📝 Description
|
|
1542
|
+
|
|
1543
|
+
<dl>
|
|
1544
|
+
<dd>
|
|
1545
|
+
|
|
1546
|
+
<dl>
|
|
1547
|
+
<dd>
|
|
1548
|
+
|
|
1549
|
+
Retrieve information about any phone number.
|
|
1550
|
+
</dd>
|
|
1551
|
+
</dl>
|
|
1552
|
+
</dd>
|
|
1553
|
+
</dl>
|
|
1314
1554
|
|
|
1555
|
+
#### 🔌 Usage
|
|
1556
|
+
|
|
1557
|
+
<dl>
|
|
1558
|
+
<dd>
|
|
1559
|
+
|
|
1560
|
+
<dl>
|
|
1561
|
+
<dd>
|
|
1562
|
+
|
|
1563
|
+
```typescript
|
|
1564
|
+
await client.phoneNumbers.get({
|
|
1565
|
+
phone: "+11234567890",
|
|
1566
|
+
level: "advanced",
|
|
1567
|
+
options: {
|
|
1568
|
+
risk: true,
|
|
1569
|
+
enhanced_contact_info: {
|
|
1570
|
+
context: "This is my friend from JZ. He has done a lot in the crypto space."
|
|
1571
|
+
}
|
|
1572
|
+
}
|
|
1573
|
+
});
|
|
1574
|
+
|
|
1575
|
+
```
|
|
1315
1576
|
</dd>
|
|
1316
1577
|
</dl>
|
|
1317
1578
|
</dd>
|
|
@@ -1325,21 +1586,91 @@ await client.rcs.getCapabilities({
|
|
|
1325
1586
|
<dl>
|
|
1326
1587
|
<dd>
|
|
1327
1588
|
|
|
1328
|
-
**request:** `Pinnacle.
|
|
1589
|
+
**request:** `Pinnacle.RetrievePhoneNumberDetailsParams`
|
|
1590
|
+
|
|
1591
|
+
</dd>
|
|
1592
|
+
</dl>
|
|
1593
|
+
|
|
1594
|
+
<dl>
|
|
1595
|
+
<dd>
|
|
1329
1596
|
|
|
1597
|
+
**requestOptions:** `PhoneNumbers.RequestOptions`
|
|
1598
|
+
|
|
1330
1599
|
</dd>
|
|
1331
1600
|
</dl>
|
|
1601
|
+
</dd>
|
|
1602
|
+
</dl>
|
|
1603
|
+
|
|
1604
|
+
|
|
1605
|
+
</dd>
|
|
1606
|
+
</dl>
|
|
1607
|
+
</details>
|
|
1608
|
+
|
|
1609
|
+
## RCS
|
|
1610
|
+
<details><summary><code>client.rcs.<a href="/src/api/resources/rcs/client/Client.ts">getCapabilities</a>({ ...params }) -> Pinnacle.RcsCapabilitiesResult</code></summary>
|
|
1611
|
+
<dl>
|
|
1612
|
+
<dd>
|
|
1613
|
+
|
|
1614
|
+
#### 📝 Description
|
|
1332
1615
|
|
|
1333
1616
|
<dl>
|
|
1334
1617
|
<dd>
|
|
1335
1618
|
|
|
1336
|
-
|
|
1619
|
+
<dl>
|
|
1620
|
+
<dd>
|
|
1337
1621
|
|
|
1622
|
+
Check RCS capabilities for one or more phone numbers.
|
|
1623
|
+
|
|
1624
|
+
This endpoint allows you to verify which RCS features (cards, buttons, etc.) are supported
|
|
1625
|
+
on specific phone numbers before sending RCS messages to them.
|
|
1338
1626
|
</dd>
|
|
1339
1627
|
</dl>
|
|
1340
1628
|
</dd>
|
|
1341
1629
|
</dl>
|
|
1342
1630
|
|
|
1631
|
+
#### 🔌 Usage
|
|
1632
|
+
|
|
1633
|
+
<dl>
|
|
1634
|
+
<dd>
|
|
1635
|
+
|
|
1636
|
+
<dl>
|
|
1637
|
+
<dd>
|
|
1638
|
+
|
|
1639
|
+
```typescript
|
|
1640
|
+
await client.rcs.getCapabilities({
|
|
1641
|
+
phoneNumbers: ["+12345678901", "+19876543210"]
|
|
1642
|
+
});
|
|
1643
|
+
|
|
1644
|
+
```
|
|
1645
|
+
</dd>
|
|
1646
|
+
</dl>
|
|
1647
|
+
</dd>
|
|
1648
|
+
</dl>
|
|
1649
|
+
|
|
1650
|
+
#### ⚙️ Parameters
|
|
1651
|
+
|
|
1652
|
+
<dl>
|
|
1653
|
+
<dd>
|
|
1654
|
+
|
|
1655
|
+
<dl>
|
|
1656
|
+
<dd>
|
|
1657
|
+
|
|
1658
|
+
**request:** `Pinnacle.RcsCapabilitiesQuery`
|
|
1659
|
+
|
|
1660
|
+
</dd>
|
|
1661
|
+
</dl>
|
|
1662
|
+
|
|
1663
|
+
<dl>
|
|
1664
|
+
<dd>
|
|
1665
|
+
|
|
1666
|
+
**requestOptions:** `Rcs.RequestOptions`
|
|
1667
|
+
|
|
1668
|
+
</dd>
|
|
1669
|
+
</dl>
|
|
1670
|
+
</dd>
|
|
1671
|
+
</dl>
|
|
1672
|
+
|
|
1673
|
+
|
|
1343
1674
|
</dd>
|
|
1344
1675
|
</dl>
|
|
1345
1676
|
</details>
|
|
@@ -1359,22 +1690,20 @@ await client.rcs.getCapabilities({
|
|
|
1359
1690
|
Whitelist a phone number for testing with your test RCS agent.
|
|
1360
1691
|
|
|
1361
1692
|
## Overview
|
|
1362
|
-
|
|
1363
1693
|
During development and testing, RCS agents can only send messages to whitelisted phone numbers.
|
|
1364
1694
|
Use this endpoint to whitelist specific phone numbers to send and receive messages from the test agent.
|
|
1365
1695
|
|
|
1366
1696
|
## Verification Process
|
|
1367
|
-
|
|
1368
1697
|
After whitelisting a number, you'll need to complete verification:
|
|
1369
1698
|
|
|
1370
1699
|
1. Check the test device for message from "RBM Tester Management"
|
|
1371
1700
|
2. Click the "Make me a tester" button
|
|
1372
1701
|
3. Enter the separate 4-digit verification SMS code in the Pinnacle dashboard at:
|
|
1373
|
-
|
|
1374
|
-
|
|
1375
|
-
|
|
1702
|
+
```
|
|
1703
|
+
https://app.pinnacle.sh/dashboard/brands/{brandId}?campaignId={campaignId}&campaignType=RCS
|
|
1704
|
+
```
|
|
1376
1705
|
|
|
1377
|
-
> **⚠️ Important: Re-whitelisting Numbers**
|
|
1706
|
+
> **⚠️ Important: Re-whitelisting Numbers**
|
|
1378
1707
|
>
|
|
1379
1708
|
> 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.**
|
|
1380
1709
|
|
|
@@ -1383,7 +1712,6 @@ After whitelisting a number, you'll need to complete verification:
|
|
|
1383
1712
|
> - **Verification required:** Messages cannot be sent nor received until you have clicked the "Make me a tester" button on the test device.
|
|
1384
1713
|
> - **Testing only:** This is only required for test agents. Production agents can message any RCS-enabled number.
|
|
1385
1714
|
> - **Network limitations:** Whitelisting may be temporarily unavailable for some carriers but are usually restored shortly.
|
|
1386
|
-
|
|
1387
1715
|
</dd>
|
|
1388
1716
|
</dl>
|
|
1389
1717
|
</dd>
|
|
@@ -1400,10 +1728,10 @@ After whitelisting a number, you'll need to complete verification:
|
|
|
1400
1728
|
```typescript
|
|
1401
1729
|
await client.rcs.whitelist({
|
|
1402
1730
|
agentId: "agent_XXXXXXXXXXXX",
|
|
1403
|
-
phoneNumber: "+12345678901"
|
|
1731
|
+
phoneNumber: "+12345678901"
|
|
1404
1732
|
});
|
|
1405
|
-
```
|
|
1406
1733
|
|
|
1734
|
+
```
|
|
1407
1735
|
</dd>
|
|
1408
1736
|
</dl>
|
|
1409
1737
|
</dd>
|
|
@@ -1417,21 +1745,22 @@ await client.rcs.whitelist({
|
|
|
1417
1745
|
<dl>
|
|
1418
1746
|
<dd>
|
|
1419
1747
|
|
|
1420
|
-
**request:** `Pinnacle.RcsWhitelistRequest`
|
|
1421
|
-
|
|
1748
|
+
**request:** `Pinnacle.RcsWhitelistRequest`
|
|
1749
|
+
|
|
1422
1750
|
</dd>
|
|
1423
1751
|
</dl>
|
|
1424
1752
|
|
|
1425
1753
|
<dl>
|
|
1426
1754
|
<dd>
|
|
1427
1755
|
|
|
1428
|
-
**requestOptions:** `Rcs.RequestOptions`
|
|
1429
|
-
|
|
1756
|
+
**requestOptions:** `Rcs.RequestOptions`
|
|
1757
|
+
|
|
1430
1758
|
</dd>
|
|
1431
1759
|
</dl>
|
|
1432
1760
|
</dd>
|
|
1433
1761
|
</dl>
|
|
1434
1762
|
|
|
1763
|
+
|
|
1435
1764
|
</dd>
|
|
1436
1765
|
</dl>
|
|
1437
1766
|
</details>
|
|
@@ -1448,11 +1777,10 @@ await client.rcs.whitelist({
|
|
|
1448
1777
|
<dl>
|
|
1449
1778
|
<dd>
|
|
1450
1779
|
|
|
1451
|
-
Generate a link for initiating an RCS conversation with your agent.
|
|
1780
|
+
Generate a link for initiating an RCS conversation with your agent.
|
|
1452
1781
|
|
|
1453
1782
|
Users can click these links to start conversations with your RCS agent directly
|
|
1454
1783
|
from websites, emails, or other applications.
|
|
1455
|
-
|
|
1456
1784
|
</dd>
|
|
1457
1785
|
</dl>
|
|
1458
1786
|
</dd>
|
|
@@ -1471,10 +1799,10 @@ await client.rcs.getLink({
|
|
|
1471
1799
|
agentId: "agent_XXXXXXXXXXXX",
|
|
1472
1800
|
testMode: false,
|
|
1473
1801
|
phoneNumber: "+12345678901",
|
|
1474
|
-
body: "Hello, I need help with my order"
|
|
1802
|
+
body: "Hello, I need help with my order"
|
|
1475
1803
|
});
|
|
1476
|
-
```
|
|
1477
1804
|
|
|
1805
|
+
```
|
|
1478
1806
|
</dd>
|
|
1479
1807
|
</dl>
|
|
1480
1808
|
</dd>
|
|
@@ -1488,27 +1816,27 @@ await client.rcs.getLink({
|
|
|
1488
1816
|
<dl>
|
|
1489
1817
|
<dd>
|
|
1490
1818
|
|
|
1491
|
-
**request:** `Pinnacle.RcsLinkRequest`
|
|
1492
|
-
|
|
1819
|
+
**request:** `Pinnacle.RcsLinkRequest`
|
|
1820
|
+
|
|
1493
1821
|
</dd>
|
|
1494
1822
|
</dl>
|
|
1495
1823
|
|
|
1496
1824
|
<dl>
|
|
1497
1825
|
<dd>
|
|
1498
1826
|
|
|
1499
|
-
**requestOptions:** `Rcs.RequestOptions`
|
|
1500
|
-
|
|
1827
|
+
**requestOptions:** `Rcs.RequestOptions`
|
|
1828
|
+
|
|
1501
1829
|
</dd>
|
|
1502
1830
|
</dl>
|
|
1503
1831
|
</dd>
|
|
1504
1832
|
</dl>
|
|
1505
1833
|
|
|
1834
|
+
|
|
1506
1835
|
</dd>
|
|
1507
1836
|
</dl>
|
|
1508
1837
|
</details>
|
|
1509
1838
|
|
|
1510
1839
|
## Webhooks
|
|
1511
|
-
|
|
1512
1840
|
<details><summary><code>client.webhooks.<a href="/src/api/resources/webhooks/client/Client.ts">get</a>({ ...params }) -> Pinnacle.WebhookResult</code></summary>
|
|
1513
1841
|
<dl>
|
|
1514
1842
|
<dd>
|
|
@@ -1522,7 +1850,6 @@ await client.rcs.getLink({
|
|
|
1522
1850
|
<dd>
|
|
1523
1851
|
|
|
1524
1852
|
Retrieve all webhook that are set up to receive events for specific URLs or phone numbers.
|
|
1525
|
-
|
|
1526
1853
|
</dd>
|
|
1527
1854
|
</dl>
|
|
1528
1855
|
</dd>
|
|
@@ -1538,15 +1865,80 @@ Retrieve all webhook that are set up to receive events for specific URLs or phon
|
|
|
1538
1865
|
|
|
1539
1866
|
```typescript
|
|
1540
1867
|
await client.webhooks.get({
|
|
1541
|
-
identifiers: [
|
|
1542
|
-
"https://www.pinnacle.sh/payment",
|
|
1543
|
-
"+14155678901",
|
|
1544
|
-
"https://www.pinnacle.sh/sms-callback",
|
|
1545
|
-
"+14153456659",
|
|
1546
|
-
],
|
|
1868
|
+
identifiers: ["https://www.pinnacle.sh/payment", "+14155678901", "https://www.pinnacle.sh/sms-callback", "+14153456659"]
|
|
1547
1869
|
});
|
|
1870
|
+
|
|
1548
1871
|
```
|
|
1872
|
+
</dd>
|
|
1873
|
+
</dl>
|
|
1874
|
+
</dd>
|
|
1875
|
+
</dl>
|
|
1876
|
+
|
|
1877
|
+
#### ⚙️ Parameters
|
|
1878
|
+
|
|
1879
|
+
<dl>
|
|
1880
|
+
<dd>
|
|
1881
|
+
|
|
1882
|
+
<dl>
|
|
1883
|
+
<dd>
|
|
1884
|
+
|
|
1885
|
+
**request:** `Pinnacle.GetWebhookParams`
|
|
1886
|
+
|
|
1887
|
+
</dd>
|
|
1888
|
+
</dl>
|
|
1889
|
+
|
|
1890
|
+
<dl>
|
|
1891
|
+
<dd>
|
|
1892
|
+
|
|
1893
|
+
**requestOptions:** `Webhooks.RequestOptions`
|
|
1894
|
+
|
|
1895
|
+
</dd>
|
|
1896
|
+
</dl>
|
|
1897
|
+
</dd>
|
|
1898
|
+
</dl>
|
|
1899
|
+
|
|
1549
1900
|
|
|
1901
|
+
</dd>
|
|
1902
|
+
</dl>
|
|
1903
|
+
</details>
|
|
1904
|
+
|
|
1905
|
+
## Audiences Contacts
|
|
1906
|
+
<details><summary><code>client.audiences.contacts.<a href="/src/api/resources/audiences/resources/contacts/client/Client.ts">remove</a>({ ...params }) -> Pinnacle.AudienceCountOnly</code></summary>
|
|
1907
|
+
<dl>
|
|
1908
|
+
<dd>
|
|
1909
|
+
|
|
1910
|
+
#### 📝 Description
|
|
1911
|
+
|
|
1912
|
+
<dl>
|
|
1913
|
+
<dd>
|
|
1914
|
+
|
|
1915
|
+
<dl>
|
|
1916
|
+
<dd>
|
|
1917
|
+
|
|
1918
|
+
Remove contacts from an existing audience. This operation is idempotent.
|
|
1919
|
+
|
|
1920
|
+
- Only removes contacts that exist in the audience
|
|
1921
|
+
- Contacts not in the audience are ignored
|
|
1922
|
+
</dd>
|
|
1923
|
+
</dl>
|
|
1924
|
+
</dd>
|
|
1925
|
+
</dl>
|
|
1926
|
+
|
|
1927
|
+
#### 🔌 Usage
|
|
1928
|
+
|
|
1929
|
+
<dl>
|
|
1930
|
+
<dd>
|
|
1931
|
+
|
|
1932
|
+
<dl>
|
|
1933
|
+
<dd>
|
|
1934
|
+
|
|
1935
|
+
```typescript
|
|
1936
|
+
await client.audiences.contacts.remove({
|
|
1937
|
+
id: "aud_abc123",
|
|
1938
|
+
contacts: ["+12125551234", "co_def456"]
|
|
1939
|
+
});
|
|
1940
|
+
|
|
1941
|
+
```
|
|
1550
1942
|
</dd>
|
|
1551
1943
|
</dl>
|
|
1552
1944
|
</dd>
|
|
@@ -1560,27 +1952,97 @@ await client.webhooks.get({
|
|
|
1560
1952
|
<dl>
|
|
1561
1953
|
<dd>
|
|
1562
1954
|
|
|
1563
|
-
**request:** `Pinnacle.
|
|
1955
|
+
**request:** `Pinnacle.audiences.RemoveContactsParams`
|
|
1956
|
+
|
|
1957
|
+
</dd>
|
|
1958
|
+
</dl>
|
|
1959
|
+
|
|
1960
|
+
<dl>
|
|
1961
|
+
<dd>
|
|
1962
|
+
|
|
1963
|
+
**requestOptions:** `Contacts.RequestOptions`
|
|
1964
|
+
|
|
1965
|
+
</dd>
|
|
1966
|
+
</dl>
|
|
1967
|
+
</dd>
|
|
1968
|
+
</dl>
|
|
1969
|
+
|
|
1564
1970
|
|
|
1565
1971
|
</dd>
|
|
1566
1972
|
</dl>
|
|
1973
|
+
</details>
|
|
1974
|
+
|
|
1975
|
+
<details><summary><code>client.audiences.contacts.<a href="/src/api/resources/audiences/resources/contacts/client/Client.ts">add</a>({ ...params }) -> Pinnacle.AudienceCountOnly</code></summary>
|
|
1976
|
+
<dl>
|
|
1977
|
+
<dd>
|
|
1978
|
+
|
|
1979
|
+
#### 📝 Description
|
|
1567
1980
|
|
|
1568
1981
|
<dl>
|
|
1569
1982
|
<dd>
|
|
1570
1983
|
|
|
1571
|
-
|
|
1984
|
+
<dl>
|
|
1985
|
+
<dd>
|
|
1572
1986
|
|
|
1987
|
+
Add contacts to an existing audience. This operation is additive and idempotent.
|
|
1988
|
+
|
|
1989
|
+
- Phone numbers that don't exist will be auto-created as contacts
|
|
1990
|
+
- Duplicate adds are ignored
|
|
1991
|
+
- Contacts already in the audience are ignored
|
|
1573
1992
|
</dd>
|
|
1574
1993
|
</dl>
|
|
1575
1994
|
</dd>
|
|
1576
1995
|
</dl>
|
|
1577
1996
|
|
|
1997
|
+
#### 🔌 Usage
|
|
1998
|
+
|
|
1999
|
+
<dl>
|
|
2000
|
+
<dd>
|
|
2001
|
+
|
|
2002
|
+
<dl>
|
|
2003
|
+
<dd>
|
|
2004
|
+
|
|
2005
|
+
```typescript
|
|
2006
|
+
await client.audiences.contacts.add({
|
|
2007
|
+
id: "aud_abc123",
|
|
2008
|
+
contacts: ["+12125551234", "co_def456", "+13105551234"]
|
|
2009
|
+
});
|
|
2010
|
+
|
|
2011
|
+
```
|
|
2012
|
+
</dd>
|
|
2013
|
+
</dl>
|
|
2014
|
+
</dd>
|
|
2015
|
+
</dl>
|
|
2016
|
+
|
|
2017
|
+
#### ⚙️ Parameters
|
|
2018
|
+
|
|
2019
|
+
<dl>
|
|
2020
|
+
<dd>
|
|
2021
|
+
|
|
2022
|
+
<dl>
|
|
2023
|
+
<dd>
|
|
2024
|
+
|
|
2025
|
+
**request:** `Pinnacle.audiences.AddContactsParams`
|
|
2026
|
+
|
|
2027
|
+
</dd>
|
|
2028
|
+
</dl>
|
|
2029
|
+
|
|
2030
|
+
<dl>
|
|
2031
|
+
<dd>
|
|
2032
|
+
|
|
2033
|
+
**requestOptions:** `Contacts.RequestOptions`
|
|
2034
|
+
|
|
2035
|
+
</dd>
|
|
2036
|
+
</dl>
|
|
2037
|
+
</dd>
|
|
2038
|
+
</dl>
|
|
2039
|
+
|
|
2040
|
+
|
|
1578
2041
|
</dd>
|
|
1579
2042
|
</dl>
|
|
1580
2043
|
</details>
|
|
1581
2044
|
|
|
1582
2045
|
## Campaigns Dlc
|
|
1583
|
-
|
|
1584
2046
|
<details><summary><code>client.campaigns.dlc.<a href="/src/api/resources/campaigns/resources/dlc/client/Client.ts">autofill</a>({ ...params }) -> Pinnacle.AutofillDlcCampaignResponse</code></summary>
|
|
1585
2047
|
<dl>
|
|
1586
2048
|
<dd>
|
|
@@ -1594,7 +2056,6 @@ await client.webhooks.get({
|
|
|
1594
2056
|
<dd>
|
|
1595
2057
|
|
|
1596
2058
|
Generate campaign details based off existing campaign and the brand it's connected to.
|
|
1597
|
-
|
|
1598
2059
|
</dd>
|
|
1599
2060
|
</dl>
|
|
1600
2061
|
</dd>
|
|
@@ -1611,10 +2072,10 @@ Generate campaign details based off existing campaign and the brand it's connect
|
|
|
1611
2072
|
```typescript
|
|
1612
2073
|
await client.campaigns.dlc.autofill({
|
|
1613
2074
|
additionalInfo: "Please autofill missing campaign fields using my brand profile",
|
|
1614
|
-
campaignId: "dlc_1234567890"
|
|
2075
|
+
campaignId: "dlc_1234567890"
|
|
1615
2076
|
});
|
|
1616
|
-
```
|
|
1617
2077
|
|
|
2078
|
+
```
|
|
1618
2079
|
</dd>
|
|
1619
2080
|
</dl>
|
|
1620
2081
|
</dd>
|
|
@@ -1628,21 +2089,22 @@ await client.campaigns.dlc.autofill({
|
|
|
1628
2089
|
<dl>
|
|
1629
2090
|
<dd>
|
|
1630
2091
|
|
|
1631
|
-
**request:** `Pinnacle.AutofillCampaignParams`
|
|
1632
|
-
|
|
2092
|
+
**request:** `Pinnacle.AutofillCampaignParams`
|
|
2093
|
+
|
|
1633
2094
|
</dd>
|
|
1634
2095
|
</dl>
|
|
1635
2096
|
|
|
1636
2097
|
<dl>
|
|
1637
2098
|
<dd>
|
|
1638
2099
|
|
|
1639
|
-
**requestOptions:** `Dlc.RequestOptions`
|
|
1640
|
-
|
|
2100
|
+
**requestOptions:** `Dlc.RequestOptions`
|
|
2101
|
+
|
|
1641
2102
|
</dd>
|
|
1642
2103
|
</dl>
|
|
1643
2104
|
</dd>
|
|
1644
2105
|
</dl>
|
|
1645
2106
|
|
|
2107
|
+
|
|
1646
2108
|
</dd>
|
|
1647
2109
|
</dl>
|
|
1648
2110
|
</details>
|
|
@@ -1660,7 +2122,6 @@ await client.campaigns.dlc.autofill({
|
|
|
1660
2122
|
<dd>
|
|
1661
2123
|
|
|
1662
2124
|
Retrieve 10DLC campaign.
|
|
1663
|
-
|
|
1664
2125
|
</dd>
|
|
1665
2126
|
</dl>
|
|
1666
2127
|
</dd>
|
|
@@ -1676,8 +2137,8 @@ Retrieve 10DLC campaign.
|
|
|
1676
2137
|
|
|
1677
2138
|
```typescript
|
|
1678
2139
|
await client.campaigns.dlc.get("dlc_1234567890");
|
|
1679
|
-
```
|
|
1680
2140
|
|
|
2141
|
+
```
|
|
1681
2142
|
</dd>
|
|
1682
2143
|
</dl>
|
|
1683
2144
|
</dd>
|
|
@@ -1692,20 +2153,21 @@ await client.campaigns.dlc.get("dlc_1234567890");
|
|
|
1692
2153
|
<dd>
|
|
1693
2154
|
|
|
1694
2155
|
**campaignId:** `string` — Unique identifier of the 10DLC campaign. This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`.
|
|
1695
|
-
|
|
2156
|
+
|
|
1696
2157
|
</dd>
|
|
1697
2158
|
</dl>
|
|
1698
2159
|
|
|
1699
2160
|
<dl>
|
|
1700
2161
|
<dd>
|
|
1701
2162
|
|
|
1702
|
-
**requestOptions:** `Dlc.RequestOptions`
|
|
1703
|
-
|
|
2163
|
+
**requestOptions:** `Dlc.RequestOptions`
|
|
2164
|
+
|
|
1704
2165
|
</dd>
|
|
1705
2166
|
</dl>
|
|
1706
2167
|
</dd>
|
|
1707
2168
|
</dl>
|
|
1708
2169
|
|
|
2170
|
+
|
|
1709
2171
|
</dd>
|
|
1710
2172
|
</dl>
|
|
1711
2173
|
</details>
|
|
@@ -1723,7 +2185,6 @@ await client.campaigns.dlc.get("dlc_1234567890");
|
|
|
1723
2185
|
<dd>
|
|
1724
2186
|
|
|
1725
2187
|
Submit your 10DLC campaign for approval and activation with carriers.
|
|
1726
|
-
|
|
1727
2188
|
</dd>
|
|
1728
2189
|
</dl>
|
|
1729
2190
|
</dd>
|
|
@@ -1739,8 +2200,8 @@ Submit your 10DLC campaign for approval and activation with carriers.
|
|
|
1739
2200
|
|
|
1740
2201
|
```typescript
|
|
1741
2202
|
await client.campaigns.dlc.submit("dlc_1234567890");
|
|
1742
|
-
```
|
|
1743
2203
|
|
|
2204
|
+
```
|
|
1744
2205
|
</dd>
|
|
1745
2206
|
</dl>
|
|
1746
2207
|
</dd>
|
|
@@ -1754,24 +2215,25 @@ await client.campaigns.dlc.submit("dlc_1234567890");
|
|
|
1754
2215
|
<dl>
|
|
1755
2216
|
<dd>
|
|
1756
2217
|
|
|
1757
|
-
**campaignId:** `string`
|
|
2218
|
+
**campaignId:** `string`
|
|
1758
2219
|
|
|
1759
2220
|
Unique identifier of the 10DLC campaign to submit.
|
|
1760
2221
|
<br><br> This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`.
|
|
1761
|
-
|
|
2222
|
+
|
|
1762
2223
|
</dd>
|
|
1763
2224
|
</dl>
|
|
1764
2225
|
|
|
1765
2226
|
<dl>
|
|
1766
2227
|
<dd>
|
|
1767
2228
|
|
|
1768
|
-
**requestOptions:** `Dlc.RequestOptions`
|
|
1769
|
-
|
|
2229
|
+
**requestOptions:** `Dlc.RequestOptions`
|
|
2230
|
+
|
|
1770
2231
|
</dd>
|
|
1771
2232
|
</dl>
|
|
1772
2233
|
</dd>
|
|
1773
2234
|
</dl>
|
|
1774
2235
|
|
|
2236
|
+
|
|
1775
2237
|
</dd>
|
|
1776
2238
|
</dl>
|
|
1777
2239
|
</details>
|
|
@@ -1791,7 +2253,6 @@ Unique identifier of the 10DLC campaign to submit.
|
|
|
1791
2253
|
Create a new 10DLC campaign or updates an existing one. <br>
|
|
1792
2254
|
|
|
1793
2255
|
Omit campaignId to create a campaign.
|
|
1794
|
-
|
|
1795
2256
|
</dd>
|
|
1796
2257
|
</dl>
|
|
1797
2258
|
</dd>
|
|
@@ -1813,20 +2274,20 @@ await client.campaigns.dlc.upsert({
|
|
|
1813
2274
|
keywords: {
|
|
1814
2275
|
HELP: {
|
|
1815
2276
|
message: "Reply HELP for assistance, STOP to opt-out",
|
|
1816
|
-
values: ["HELP", "INFO", "SUPPORT"]
|
|
2277
|
+
values: ["HELP", "INFO", "SUPPORT"]
|
|
1817
2278
|
},
|
|
1818
2279
|
OPT_IN: {
|
|
1819
2280
|
message: "Welcome. You are now subscribed to Pinnacle.",
|
|
1820
|
-
values: ["JOIN", "START", "SUBSCRIBE"]
|
|
2281
|
+
values: ["JOIN", "START", "SUBSCRIBE"]
|
|
1821
2282
|
},
|
|
1822
2283
|
OPT_OUT: {
|
|
1823
2284
|
message: "You have been unsubscribed. Reply START to rejoin.",
|
|
1824
|
-
values: ["STOP", "QUIT", "UNSUBSCRIBE"]
|
|
1825
|
-
}
|
|
2285
|
+
values: ["STOP", "QUIT", "UNSUBSCRIBE"]
|
|
2286
|
+
}
|
|
1826
2287
|
},
|
|
1827
2288
|
links: {
|
|
1828
2289
|
privacyPolicy: "https://www.pinnacle.sh/privacy",
|
|
1829
|
-
termsOfService: "https://www.pinnacle.sh/terms"
|
|
2290
|
+
termsOfService: "https://www.pinnacle.sh/terms"
|
|
1830
2291
|
},
|
|
1831
2292
|
messageFlow: "Customer initiates -> Automated response -> Agent follow-up if needed",
|
|
1832
2293
|
name: "Account Notifications",
|
|
@@ -1836,16 +2297,16 @@ await client.campaigns.dlc.upsert({
|
|
|
1836
2297
|
directLending: false,
|
|
1837
2298
|
embeddedLink: "https://www.pinnacle.sh/example",
|
|
1838
2299
|
embeddedPhone: false,
|
|
1839
|
-
numberPooling: false
|
|
2300
|
+
numberPooling: false
|
|
1840
2301
|
},
|
|
1841
2302
|
sampleMessages: ["Security alert: Unusual login detected from new device."],
|
|
1842
2303
|
useCase: {
|
|
1843
2304
|
sub: ["FRAUD_ALERT"],
|
|
1844
|
-
value: "ACCOUNT_NOTIFICATION"
|
|
1845
|
-
}
|
|
2305
|
+
value: "ACCOUNT_NOTIFICATION"
|
|
2306
|
+
}
|
|
1846
2307
|
});
|
|
1847
|
-
```
|
|
1848
2308
|
|
|
2309
|
+
```
|
|
1849
2310
|
</dd>
|
|
1850
2311
|
</dl>
|
|
1851
2312
|
</dd>
|
|
@@ -1859,21 +2320,22 @@ await client.campaigns.dlc.upsert({
|
|
|
1859
2320
|
<dl>
|
|
1860
2321
|
<dd>
|
|
1861
2322
|
|
|
1862
|
-
**request:** `Pinnacle.campaigns.UpsertDlcCampaignParams`
|
|
1863
|
-
|
|
2323
|
+
**request:** `Pinnacle.campaigns.UpsertDlcCampaignParams`
|
|
2324
|
+
|
|
1864
2325
|
</dd>
|
|
1865
2326
|
</dl>
|
|
1866
2327
|
|
|
1867
2328
|
<dl>
|
|
1868
2329
|
<dd>
|
|
1869
2330
|
|
|
1870
|
-
**requestOptions:** `Dlc.RequestOptions`
|
|
1871
|
-
|
|
2331
|
+
**requestOptions:** `Dlc.RequestOptions`
|
|
2332
|
+
|
|
1872
2333
|
</dd>
|
|
1873
2334
|
</dl>
|
|
1874
2335
|
</dd>
|
|
1875
2336
|
</dl>
|
|
1876
2337
|
|
|
2338
|
+
|
|
1877
2339
|
</dd>
|
|
1878
2340
|
</dl>
|
|
1879
2341
|
</details>
|
|
@@ -1891,7 +2353,6 @@ await client.campaigns.dlc.upsert({
|
|
|
1891
2353
|
<dd>
|
|
1892
2354
|
|
|
1893
2355
|
Validate your 10DLC campaign configuration against carrier requirements and compliance rules.
|
|
1894
|
-
|
|
1895
2356
|
</dd>
|
|
1896
2357
|
</dl>
|
|
1897
2358
|
</dd>
|
|
@@ -1908,10 +2369,10 @@ Validate your 10DLC campaign configuration against carrier requirements and comp
|
|
|
1908
2369
|
```typescript
|
|
1909
2370
|
await client.campaigns.dlc.validate({
|
|
1910
2371
|
additionalInfo: "Please validate this DLC campaign for 10DLC compliance",
|
|
1911
|
-
campaignId: "dlc_1234567890"
|
|
2372
|
+
campaignId: "dlc_1234567890"
|
|
1912
2373
|
});
|
|
1913
|
-
```
|
|
1914
2374
|
|
|
2375
|
+
```
|
|
1915
2376
|
</dd>
|
|
1916
2377
|
</dl>
|
|
1917
2378
|
</dd>
|
|
@@ -1925,27 +2386,27 @@ await client.campaigns.dlc.validate({
|
|
|
1925
2386
|
<dl>
|
|
1926
2387
|
<dd>
|
|
1927
2388
|
|
|
1928
|
-
**request:** `Pinnacle.ValidateCampaignParams`
|
|
1929
|
-
|
|
2389
|
+
**request:** `Pinnacle.ValidateCampaignParams`
|
|
2390
|
+
|
|
1930
2391
|
</dd>
|
|
1931
2392
|
</dl>
|
|
1932
2393
|
|
|
1933
2394
|
<dl>
|
|
1934
2395
|
<dd>
|
|
1935
2396
|
|
|
1936
|
-
**requestOptions:** `Dlc.RequestOptions`
|
|
1937
|
-
|
|
2397
|
+
**requestOptions:** `Dlc.RequestOptions`
|
|
2398
|
+
|
|
1938
2399
|
</dd>
|
|
1939
2400
|
</dl>
|
|
1940
2401
|
</dd>
|
|
1941
2402
|
</dl>
|
|
1942
2403
|
|
|
2404
|
+
|
|
1943
2405
|
</dd>
|
|
1944
2406
|
</dl>
|
|
1945
2407
|
</details>
|
|
1946
2408
|
|
|
1947
2409
|
## Campaigns TollFree
|
|
1948
|
-
|
|
1949
2410
|
<details><summary><code>client.campaigns.tollFree.<a href="/src/api/resources/campaigns/resources/tollFree/client/Client.ts">autofill</a>({ ...params }) -> Pinnacle.TollFreeAutofillResponse</code></summary>
|
|
1950
2411
|
<dl>
|
|
1951
2412
|
<dd>
|
|
@@ -1959,7 +2420,6 @@ await client.campaigns.dlc.validate({
|
|
|
1959
2420
|
<dd>
|
|
1960
2421
|
|
|
1961
2422
|
Generate campaign details based off existing campaign and the brand it's connected to.
|
|
1962
|
-
|
|
1963
2423
|
</dd>
|
|
1964
2424
|
</dl>
|
|
1965
2425
|
</dd>
|
|
@@ -1976,10 +2436,10 @@ Generate campaign details based off existing campaign and the brand it's connect
|
|
|
1976
2436
|
```typescript
|
|
1977
2437
|
await client.campaigns.tollFree.autofill({
|
|
1978
2438
|
additionalInfo: "Please autofill missing campaign fields using my brand profile",
|
|
1979
|
-
campaignId: "dlc_1234567890"
|
|
2439
|
+
campaignId: "dlc_1234567890"
|
|
1980
2440
|
});
|
|
1981
|
-
```
|
|
1982
2441
|
|
|
2442
|
+
```
|
|
1983
2443
|
</dd>
|
|
1984
2444
|
</dl>
|
|
1985
2445
|
</dd>
|
|
@@ -1993,21 +2453,22 @@ await client.campaigns.tollFree.autofill({
|
|
|
1993
2453
|
<dl>
|
|
1994
2454
|
<dd>
|
|
1995
2455
|
|
|
1996
|
-
**request:** `Pinnacle.AutofillCampaignParams`
|
|
1997
|
-
|
|
2456
|
+
**request:** `Pinnacle.AutofillCampaignParams`
|
|
2457
|
+
|
|
1998
2458
|
</dd>
|
|
1999
2459
|
</dl>
|
|
2000
2460
|
|
|
2001
2461
|
<dl>
|
|
2002
2462
|
<dd>
|
|
2003
2463
|
|
|
2004
|
-
**requestOptions:** `TollFree.RequestOptions`
|
|
2005
|
-
|
|
2464
|
+
**requestOptions:** `TollFree.RequestOptions`
|
|
2465
|
+
|
|
2006
2466
|
</dd>
|
|
2007
2467
|
</dl>
|
|
2008
2468
|
</dd>
|
|
2009
2469
|
</dl>
|
|
2010
2470
|
|
|
2471
|
+
|
|
2011
2472
|
</dd>
|
|
2012
2473
|
</dl>
|
|
2013
2474
|
</details>
|
|
@@ -2025,7 +2486,6 @@ await client.campaigns.tollFree.autofill({
|
|
|
2025
2486
|
<dd>
|
|
2026
2487
|
|
|
2027
2488
|
Retrieve Toll-Free campaign.
|
|
2028
|
-
|
|
2029
2489
|
</dd>
|
|
2030
2490
|
</dl>
|
|
2031
2491
|
</dd>
|
|
@@ -2041,8 +2501,8 @@ Retrieve Toll-Free campaign.
|
|
|
2041
2501
|
|
|
2042
2502
|
```typescript
|
|
2043
2503
|
await client.campaigns.tollFree.get("tf_1234567890");
|
|
2044
|
-
```
|
|
2045
2504
|
|
|
2505
|
+
```
|
|
2046
2506
|
</dd>
|
|
2047
2507
|
</dl>
|
|
2048
2508
|
</dd>
|
|
@@ -2057,20 +2517,21 @@ await client.campaigns.tollFree.get("tf_1234567890");
|
|
|
2057
2517
|
<dd>
|
|
2058
2518
|
|
|
2059
2519
|
**campaignId:** `string` — Unique identifier of toll-free campaign. Must begin with the prefix `tf_`.
|
|
2060
|
-
|
|
2520
|
+
|
|
2061
2521
|
</dd>
|
|
2062
2522
|
</dl>
|
|
2063
2523
|
|
|
2064
2524
|
<dl>
|
|
2065
2525
|
<dd>
|
|
2066
2526
|
|
|
2067
|
-
**requestOptions:** `TollFree.RequestOptions`
|
|
2068
|
-
|
|
2527
|
+
**requestOptions:** `TollFree.RequestOptions`
|
|
2528
|
+
|
|
2069
2529
|
</dd>
|
|
2070
2530
|
</dl>
|
|
2071
2531
|
</dd>
|
|
2072
2532
|
</dl>
|
|
2073
2533
|
|
|
2534
|
+
|
|
2074
2535
|
</dd>
|
|
2075
2536
|
</dl>
|
|
2076
2537
|
</details>
|
|
@@ -2088,7 +2549,6 @@ await client.campaigns.tollFree.get("tf_1234567890");
|
|
|
2088
2549
|
<dd>
|
|
2089
2550
|
|
|
2090
2551
|
Submit your toll-free campaign for approval and activation with carriers.
|
|
2091
|
-
|
|
2092
2552
|
</dd>
|
|
2093
2553
|
</dl>
|
|
2094
2554
|
</dd>
|
|
@@ -2104,8 +2564,8 @@ Submit your toll-free campaign for approval and activation with carriers.
|
|
|
2104
2564
|
|
|
2105
2565
|
```typescript
|
|
2106
2566
|
await client.campaigns.tollFree.submit("tf_1234567890");
|
|
2107
|
-
```
|
|
2108
2567
|
|
|
2568
|
+
```
|
|
2109
2569
|
</dd>
|
|
2110
2570
|
</dl>
|
|
2111
2571
|
</dd>
|
|
@@ -2120,20 +2580,21 @@ await client.campaigns.tollFree.submit("tf_1234567890");
|
|
|
2120
2580
|
<dd>
|
|
2121
2581
|
|
|
2122
2582
|
**campaignId:** `string` — Unique identifier of the toll-free campaign to submit. Must begin with the prefix `tf_`.
|
|
2123
|
-
|
|
2583
|
+
|
|
2124
2584
|
</dd>
|
|
2125
2585
|
</dl>
|
|
2126
2586
|
|
|
2127
2587
|
<dl>
|
|
2128
2588
|
<dd>
|
|
2129
2589
|
|
|
2130
|
-
**requestOptions:** `TollFree.RequestOptions`
|
|
2131
|
-
|
|
2590
|
+
**requestOptions:** `TollFree.RequestOptions`
|
|
2591
|
+
|
|
2132
2592
|
</dd>
|
|
2133
2593
|
</dl>
|
|
2134
2594
|
</dd>
|
|
2135
2595
|
</dl>
|
|
2136
2596
|
|
|
2597
|
+
|
|
2137
2598
|
</dd>
|
|
2138
2599
|
</dl>
|
|
2139
2600
|
</details>
|
|
@@ -2153,7 +2614,6 @@ await client.campaigns.tollFree.submit("tf_1234567890");
|
|
|
2153
2614
|
Create a new toll-free campaign or updates an existing one.<br>
|
|
2154
2615
|
|
|
2155
2616
|
Omit campaignId to create a campaign.
|
|
2156
|
-
|
|
2157
2617
|
</dd>
|
|
2158
2618
|
</dl>
|
|
2159
2619
|
</dd>
|
|
@@ -2171,21 +2631,37 @@ Omit campaignId to create a campaign.
|
|
|
2171
2631
|
await client.campaigns.tollFree.upsert({
|
|
2172
2632
|
brand: "b_1234567890",
|
|
2173
2633
|
campaignId: "tf_1234567890",
|
|
2634
|
+
keywords: {
|
|
2635
|
+
HELP: {
|
|
2636
|
+
message: "Email founders@trypinnacle.app for support."
|
|
2637
|
+
},
|
|
2638
|
+
OPT_IN: {
|
|
2639
|
+
message: "Welcome back to Pinnacle!<br>\n\uD83D\uDD14 You're now subscribed to Pinnacle and will continue receiving important updates and news. Feel free to contact this us at any time for help.<br>\n\nReply STOP to opt out and HELP for support. Message & rates may apply.\n",
|
|
2640
|
+
keywords: ["START", "SUBSCRIBE"]
|
|
2641
|
+
}
|
|
2642
|
+
},
|
|
2643
|
+
links: {
|
|
2644
|
+
privacyPolicy: "https://www.pinnacle.sh/privacy",
|
|
2645
|
+
termsOfService: "https://www.pinnacle.sh/terms"
|
|
2646
|
+
},
|
|
2174
2647
|
monthlyVolume: "1,000",
|
|
2175
2648
|
name: "Pinnacle",
|
|
2176
2649
|
optIn: {
|
|
2177
2650
|
method: "DIGITAL",
|
|
2178
2651
|
url: "https://www.pinnacle.sh/",
|
|
2179
|
-
workflowDescription: "Visit https://www.pinnacle.sh/"
|
|
2652
|
+
workflowDescription: "Visit https://www.pinnacle.sh/"
|
|
2653
|
+
},
|
|
2654
|
+
options: {
|
|
2655
|
+
ageGated: false
|
|
2180
2656
|
},
|
|
2181
2657
|
productionMessageContent: "Join the Pinnacle workshop tomorrow and send your first RCS!",
|
|
2182
2658
|
useCase: {
|
|
2183
2659
|
summary: "Alerts clients about any Pinnacle hosted workshops.",
|
|
2184
|
-
value: "WORKSHOP_ALERTS"
|
|
2185
|
-
}
|
|
2660
|
+
value: "WORKSHOP_ALERTS"
|
|
2661
|
+
}
|
|
2186
2662
|
});
|
|
2187
|
-
```
|
|
2188
2663
|
|
|
2664
|
+
```
|
|
2189
2665
|
</dd>
|
|
2190
2666
|
</dl>
|
|
2191
2667
|
</dd>
|
|
@@ -2199,21 +2675,22 @@ await client.campaigns.tollFree.upsert({
|
|
|
2199
2675
|
<dl>
|
|
2200
2676
|
<dd>
|
|
2201
2677
|
|
|
2202
|
-
**request:** `Pinnacle.campaigns.UpsertTollFreeCampaignParams`
|
|
2203
|
-
|
|
2678
|
+
**request:** `Pinnacle.campaigns.UpsertTollFreeCampaignParams`
|
|
2679
|
+
|
|
2204
2680
|
</dd>
|
|
2205
2681
|
</dl>
|
|
2206
2682
|
|
|
2207
2683
|
<dl>
|
|
2208
2684
|
<dd>
|
|
2209
2685
|
|
|
2210
|
-
**requestOptions:** `TollFree.RequestOptions`
|
|
2211
|
-
|
|
2686
|
+
**requestOptions:** `TollFree.RequestOptions`
|
|
2687
|
+
|
|
2212
2688
|
</dd>
|
|
2213
2689
|
</dl>
|
|
2214
2690
|
</dd>
|
|
2215
2691
|
</dl>
|
|
2216
2692
|
|
|
2693
|
+
|
|
2217
2694
|
</dd>
|
|
2218
2695
|
</dl>
|
|
2219
2696
|
</details>
|
|
@@ -2231,7 +2708,6 @@ await client.campaigns.tollFree.upsert({
|
|
|
2231
2708
|
<dd>
|
|
2232
2709
|
|
|
2233
2710
|
Validate your toll-free campaign configuration against carrier requirements and compliance rules.
|
|
2234
|
-
|
|
2235
2711
|
</dd>
|
|
2236
2712
|
</dl>
|
|
2237
2713
|
</dd>
|
|
@@ -2248,10 +2724,10 @@ Validate your toll-free campaign configuration against carrier requirements and
|
|
|
2248
2724
|
```typescript
|
|
2249
2725
|
await client.campaigns.tollFree.validate({
|
|
2250
2726
|
additionalInfo: "Please validate this DLC campaign for 10DLC compliance",
|
|
2251
|
-
campaignId: "dlc_1234567890"
|
|
2727
|
+
campaignId: "dlc_1234567890"
|
|
2252
2728
|
});
|
|
2253
|
-
```
|
|
2254
2729
|
|
|
2730
|
+
```
|
|
2255
2731
|
</dd>
|
|
2256
2732
|
</dl>
|
|
2257
2733
|
</dd>
|
|
@@ -2265,27 +2741,27 @@ await client.campaigns.tollFree.validate({
|
|
|
2265
2741
|
<dl>
|
|
2266
2742
|
<dd>
|
|
2267
2743
|
|
|
2268
|
-
**request:** `Pinnacle.ValidateCampaignParams`
|
|
2269
|
-
|
|
2744
|
+
**request:** `Pinnacle.ValidateCampaignParams`
|
|
2745
|
+
|
|
2270
2746
|
</dd>
|
|
2271
2747
|
</dl>
|
|
2272
2748
|
|
|
2273
2749
|
<dl>
|
|
2274
2750
|
<dd>
|
|
2275
2751
|
|
|
2276
|
-
**requestOptions:** `TollFree.RequestOptions`
|
|
2277
|
-
|
|
2752
|
+
**requestOptions:** `TollFree.RequestOptions`
|
|
2753
|
+
|
|
2278
2754
|
</dd>
|
|
2279
2755
|
</dl>
|
|
2280
2756
|
</dd>
|
|
2281
2757
|
</dl>
|
|
2282
2758
|
|
|
2759
|
+
|
|
2283
2760
|
</dd>
|
|
2284
2761
|
</dl>
|
|
2285
2762
|
</details>
|
|
2286
2763
|
|
|
2287
2764
|
## Campaigns Rcs
|
|
2288
|
-
|
|
2289
2765
|
<details><summary><code>client.campaigns.rcs.<a href="/src/api/resources/campaigns/resources/rcs/client/Client.ts">autofill</a>({ ...params }) -> Pinnacle.RcsAutofillResponse</code></summary>
|
|
2290
2766
|
<dl>
|
|
2291
2767
|
<dd>
|
|
@@ -2299,7 +2775,6 @@ await client.campaigns.tollFree.validate({
|
|
|
2299
2775
|
<dd>
|
|
2300
2776
|
|
|
2301
2777
|
Generate campaign details based off existing campaign and the brand it's connected to.
|
|
2302
|
-
|
|
2303
2778
|
</dd>
|
|
2304
2779
|
</dl>
|
|
2305
2780
|
</dd>
|
|
@@ -2316,10 +2791,10 @@ Generate campaign details based off existing campaign and the brand it's connect
|
|
|
2316
2791
|
```typescript
|
|
2317
2792
|
await client.campaigns.rcs.autofill({
|
|
2318
2793
|
additionalInfo: "Please autofill missing campaign fields using my brand profile",
|
|
2319
|
-
campaignId: "dlc_1234567890"
|
|
2794
|
+
campaignId: "dlc_1234567890"
|
|
2320
2795
|
});
|
|
2321
|
-
```
|
|
2322
2796
|
|
|
2797
|
+
```
|
|
2323
2798
|
</dd>
|
|
2324
2799
|
</dl>
|
|
2325
2800
|
</dd>
|
|
@@ -2333,21 +2808,22 @@ await client.campaigns.rcs.autofill({
|
|
|
2333
2808
|
<dl>
|
|
2334
2809
|
<dd>
|
|
2335
2810
|
|
|
2336
|
-
**request:** `Pinnacle.AutofillCampaignParams`
|
|
2337
|
-
|
|
2811
|
+
**request:** `Pinnacle.AutofillCampaignParams`
|
|
2812
|
+
|
|
2338
2813
|
</dd>
|
|
2339
2814
|
</dl>
|
|
2340
2815
|
|
|
2341
2816
|
<dl>
|
|
2342
2817
|
<dd>
|
|
2343
2818
|
|
|
2344
|
-
**requestOptions:** `Rcs.RequestOptions`
|
|
2345
|
-
|
|
2819
|
+
**requestOptions:** `Rcs.RequestOptions`
|
|
2820
|
+
|
|
2346
2821
|
</dd>
|
|
2347
2822
|
</dl>
|
|
2348
2823
|
</dd>
|
|
2349
2824
|
</dl>
|
|
2350
2825
|
|
|
2826
|
+
|
|
2351
2827
|
</dd>
|
|
2352
2828
|
</dl>
|
|
2353
2829
|
</details>
|
|
@@ -2365,7 +2841,6 @@ await client.campaigns.rcs.autofill({
|
|
|
2365
2841
|
<dd>
|
|
2366
2842
|
|
|
2367
2843
|
Retrieve RCS campaign.
|
|
2368
|
-
|
|
2369
2844
|
</dd>
|
|
2370
2845
|
</dl>
|
|
2371
2846
|
</dd>
|
|
@@ -2381,8 +2856,8 @@ Retrieve RCS campaign.
|
|
|
2381
2856
|
|
|
2382
2857
|
```typescript
|
|
2383
2858
|
await client.campaigns.rcs.get("rcs_1234567890");
|
|
2384
|
-
```
|
|
2385
2859
|
|
|
2860
|
+
```
|
|
2386
2861
|
</dd>
|
|
2387
2862
|
</dl>
|
|
2388
2863
|
</dd>
|
|
@@ -2397,20 +2872,21 @@ await client.campaigns.rcs.get("rcs_1234567890");
|
|
|
2397
2872
|
<dd>
|
|
2398
2873
|
|
|
2399
2874
|
**campaignId:** `string` — Unique identifier of the RCS campaign. Must begin with the prefix `rcs_`.
|
|
2400
|
-
|
|
2875
|
+
|
|
2401
2876
|
</dd>
|
|
2402
2877
|
</dl>
|
|
2403
2878
|
|
|
2404
2879
|
<dl>
|
|
2405
2880
|
<dd>
|
|
2406
2881
|
|
|
2407
|
-
**requestOptions:** `Rcs.RequestOptions`
|
|
2408
|
-
|
|
2882
|
+
**requestOptions:** `Rcs.RequestOptions`
|
|
2883
|
+
|
|
2409
2884
|
</dd>
|
|
2410
2885
|
</dl>
|
|
2411
2886
|
</dd>
|
|
2412
2887
|
</dl>
|
|
2413
2888
|
|
|
2889
|
+
|
|
2414
2890
|
</dd>
|
|
2415
2891
|
</dl>
|
|
2416
2892
|
</details>
|
|
@@ -2428,7 +2904,6 @@ await client.campaigns.rcs.get("rcs_1234567890");
|
|
|
2428
2904
|
<dd>
|
|
2429
2905
|
|
|
2430
2906
|
Submit your RCS campaign for approval and activation with carriers.
|
|
2431
|
-
|
|
2432
2907
|
</dd>
|
|
2433
2908
|
</dl>
|
|
2434
2909
|
</dd>
|
|
@@ -2444,8 +2919,8 @@ Submit your RCS campaign for approval and activation with carriers.
|
|
|
2444
2919
|
|
|
2445
2920
|
```typescript
|
|
2446
2921
|
await client.campaigns.rcs.submit("rcs_1234567890");
|
|
2447
|
-
```
|
|
2448
2922
|
|
|
2923
|
+
```
|
|
2449
2924
|
</dd>
|
|
2450
2925
|
</dl>
|
|
2451
2926
|
</dd>
|
|
@@ -2460,20 +2935,21 @@ await client.campaigns.rcs.submit("rcs_1234567890");
|
|
|
2460
2935
|
<dd>
|
|
2461
2936
|
|
|
2462
2937
|
**campaignId:** `string` — Unique identifier of the RCS campaign to retrieve. Must begin with the prefix `rcs_`.
|
|
2463
|
-
|
|
2938
|
+
|
|
2464
2939
|
</dd>
|
|
2465
2940
|
</dl>
|
|
2466
2941
|
|
|
2467
2942
|
<dl>
|
|
2468
2943
|
<dd>
|
|
2469
2944
|
|
|
2470
|
-
**requestOptions:** `Rcs.RequestOptions`
|
|
2471
|
-
|
|
2945
|
+
**requestOptions:** `Rcs.RequestOptions`
|
|
2946
|
+
|
|
2472
2947
|
</dd>
|
|
2473
2948
|
</dl>
|
|
2474
2949
|
</dd>
|
|
2475
2950
|
</dl>
|
|
2476
2951
|
|
|
2952
|
+
|
|
2477
2953
|
</dd>
|
|
2478
2954
|
</dl>
|
|
2479
2955
|
</details>
|
|
@@ -2493,7 +2969,6 @@ await client.campaigns.rcs.submit("rcs_1234567890");
|
|
|
2493
2969
|
Create a new RCS campaign or updates an existing one. <br>
|
|
2494
2970
|
|
|
2495
2971
|
Omit campaignId to create a campaign.
|
|
2496
|
-
|
|
2497
2972
|
</dd>
|
|
2498
2973
|
</dl>
|
|
2499
2974
|
</dd>
|
|
@@ -2511,58 +2986,63 @@ Omit campaignId to create a campaign.
|
|
|
2511
2986
|
await client.campaigns.rcs.upsert({
|
|
2512
2987
|
agent: {
|
|
2513
2988
|
color: "#000000",
|
|
2514
|
-
description:
|
|
2515
|
-
|
|
2516
|
-
emails: [
|
|
2517
|
-
{
|
|
2989
|
+
description: "Experience the power of RCS messaging with interactive demos. Test rich features like carousels, suggested replies, and media sharing. Get started with our developer-friendly APIs.",
|
|
2990
|
+
emails: [{
|
|
2518
2991
|
email: "founders@trypinnacle.app",
|
|
2519
|
-
label: "Email Us"
|
|
2520
|
-
},
|
|
2521
|
-
|
|
2522
|
-
|
|
2523
|
-
|
|
2524
|
-
|
|
2525
|
-
phones: [
|
|
2526
|
-
{
|
|
2992
|
+
label: "Email Us"
|
|
2993
|
+
}],
|
|
2994
|
+
heroUrl: "https://pncl.to/D6pDSqGxqgfbCfQmw4gXdnlHu4uSB4",
|
|
2995
|
+
iconUrl: "https://pncl.to/mq_tdIDenRb5eYpJiM8-3THCaUBrZP",
|
|
2996
|
+
name: "Pinnacle - RCS Demo",
|
|
2997
|
+
phones: [{
|
|
2527
2998
|
label: "Contact us directly",
|
|
2528
|
-
phone: "+14154467821"
|
|
2529
|
-
},
|
|
2530
|
-
|
|
2531
|
-
websites: [
|
|
2532
|
-
{
|
|
2999
|
+
phone: "+14154467821"
|
|
3000
|
+
}],
|
|
3001
|
+
websites: [{
|
|
2533
3002
|
label: "Get started with Pinnacle",
|
|
2534
|
-
url: "https://www.trypinnacle.app/"
|
|
2535
|
-
}
|
|
2536
|
-
],
|
|
3003
|
+
url: "https://www.trypinnacle.app/"
|
|
3004
|
+
}]
|
|
2537
3005
|
},
|
|
2538
|
-
brandVerificationUrl: "https://www.pinnacle.sh/articles-of-incorporation.pdf",
|
|
2539
3006
|
brand: "b_1234567890",
|
|
2540
3007
|
campaignId: "rcs_1234567890",
|
|
2541
|
-
expectedAgentResponses: [
|
|
2542
|
-
"Here are the things I can help you with.",
|
|
2543
|
-
"I can assist you with booking an appointment, or you may choose to book manually.",
|
|
2544
|
-
"Here are the available times to connect with a representative tomorrow.",
|
|
2545
|
-
"Your appointment has been scheduled.",
|
|
2546
|
-
],
|
|
3008
|
+
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."],
|
|
2547
3009
|
links: {
|
|
2548
3010
|
privacyPolicy: "https://www.trypinnacle.app/privacy",
|
|
2549
|
-
termsOfService: "https://www.trypinnacle.app/terms"
|
|
3011
|
+
termsOfService: "https://www.trypinnacle.app/terms"
|
|
2550
3012
|
},
|
|
2551
|
-
|
|
2552
|
-
|
|
2553
|
-
|
|
3013
|
+
useCase: {
|
|
3014
|
+
behavior: "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",
|
|
3015
|
+
value: "OTHER"
|
|
2554
3016
|
},
|
|
2555
|
-
|
|
2556
|
-
|
|
2557
|
-
|
|
3017
|
+
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",
|
|
3018
|
+
messagingType: "MULTI_USE",
|
|
3019
|
+
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.",
|
|
3020
|
+
keywords: {
|
|
3021
|
+
HELP: {
|
|
3022
|
+
message: "Email founders@trypinnacle.app for support.",
|
|
3023
|
+
keywords: ["HELP", "SUPPORT"]
|
|
3024
|
+
},
|
|
3025
|
+
OPT_IN: {
|
|
3026
|
+
message: "Welcome back to Pinnacle!<br>\n\uD83D\uDD14 You're now subscribed to Pinnacle - RCS Demo and will continue receiving important updates and news. Feel free to contact this us at any time for help.<br>\n\nReply STOP to opt out and HELP for support. Message & rates may apply.\n",
|
|
3027
|
+
keywords: ["START", "SUBSCRIBE"]
|
|
3028
|
+
},
|
|
3029
|
+
OPT_OUT: {
|
|
3030
|
+
message: "You've been unsubscribed from Pinnacle - RCS Demo and will no longer receive notifications. If you ever change your mind, reply START or SUBSCRIBE to rejoin anytime.",
|
|
3031
|
+
keywords: ["STOP", "UNSUBSCRIBE", "END"]
|
|
3032
|
+
}
|
|
2558
3033
|
},
|
|
2559
|
-
|
|
2560
|
-
|
|
2561
|
-
|
|
3034
|
+
traffic: {
|
|
3035
|
+
monthlyWebsite: 10000,
|
|
3036
|
+
monthlyRcsEstimate: 10000
|
|
2562
3037
|
},
|
|
3038
|
+
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.",
|
|
3039
|
+
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.",
|
|
3040
|
+
isConversational: true,
|
|
3041
|
+
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.",
|
|
3042
|
+
demoTrigger: "Text \"START\" to trigger the flow."
|
|
2563
3043
|
});
|
|
2564
|
-
```
|
|
2565
3044
|
|
|
3045
|
+
```
|
|
2566
3046
|
</dd>
|
|
2567
3047
|
</dl>
|
|
2568
3048
|
</dd>
|
|
@@ -2576,21 +3056,22 @@ await client.campaigns.rcs.upsert({
|
|
|
2576
3056
|
<dl>
|
|
2577
3057
|
<dd>
|
|
2578
3058
|
|
|
2579
|
-
**request:** `Pinnacle.campaigns.UpsertRcsCampaignParams`
|
|
2580
|
-
|
|
3059
|
+
**request:** `Pinnacle.campaigns.UpsertRcsCampaignParams`
|
|
3060
|
+
|
|
2581
3061
|
</dd>
|
|
2582
3062
|
</dl>
|
|
2583
3063
|
|
|
2584
3064
|
<dl>
|
|
2585
3065
|
<dd>
|
|
2586
3066
|
|
|
2587
|
-
**requestOptions:** `Rcs.RequestOptions`
|
|
2588
|
-
|
|
3067
|
+
**requestOptions:** `Rcs.RequestOptions`
|
|
3068
|
+
|
|
2589
3069
|
</dd>
|
|
2590
3070
|
</dl>
|
|
2591
3071
|
</dd>
|
|
2592
3072
|
</dl>
|
|
2593
3073
|
|
|
3074
|
+
|
|
2594
3075
|
</dd>
|
|
2595
3076
|
</dl>
|
|
2596
3077
|
</details>
|
|
@@ -2608,7 +3089,6 @@ await client.campaigns.rcs.upsert({
|
|
|
2608
3089
|
<dd>
|
|
2609
3090
|
|
|
2610
3091
|
Validate your RCS campaign configuration against carrier requirements and compliance rules.
|
|
2611
|
-
|
|
2612
3092
|
</dd>
|
|
2613
3093
|
</dl>
|
|
2614
3094
|
</dd>
|
|
@@ -2625,10 +3105,10 @@ Validate your RCS campaign configuration against carrier requirements and compli
|
|
|
2625
3105
|
```typescript
|
|
2626
3106
|
await client.campaigns.rcs.validate({
|
|
2627
3107
|
additionalInfo: "Please validate this DLC campaign for 10DLC compliance",
|
|
2628
|
-
campaignId: "dlc_1234567890"
|
|
3108
|
+
campaignId: "dlc_1234567890"
|
|
2629
3109
|
});
|
|
2630
|
-
```
|
|
2631
3110
|
|
|
3111
|
+
```
|
|
2632
3112
|
</dd>
|
|
2633
3113
|
</dl>
|
|
2634
3114
|
</dd>
|
|
@@ -2642,27 +3122,27 @@ await client.campaigns.rcs.validate({
|
|
|
2642
3122
|
<dl>
|
|
2643
3123
|
<dd>
|
|
2644
3124
|
|
|
2645
|
-
**request:** `Pinnacle.ValidateCampaignParams`
|
|
2646
|
-
|
|
3125
|
+
**request:** `Pinnacle.ValidateCampaignParams`
|
|
3126
|
+
|
|
2647
3127
|
</dd>
|
|
2648
3128
|
</dl>
|
|
2649
3129
|
|
|
2650
3130
|
<dl>
|
|
2651
3131
|
<dd>
|
|
2652
3132
|
|
|
2653
|
-
**requestOptions:** `Rcs.RequestOptions`
|
|
2654
|
-
|
|
3133
|
+
**requestOptions:** `Rcs.RequestOptions`
|
|
3134
|
+
|
|
2655
3135
|
</dd>
|
|
2656
3136
|
</dl>
|
|
2657
3137
|
</dd>
|
|
2658
3138
|
</dl>
|
|
2659
3139
|
|
|
3140
|
+
|
|
2660
3141
|
</dd>
|
|
2661
3142
|
</dl>
|
|
2662
3143
|
</details>
|
|
2663
3144
|
|
|
2664
3145
|
## Messages Sms
|
|
2665
|
-
|
|
2666
3146
|
<details><summary><code>client.messages.sms.<a href="/src/api/resources/messages/resources/sms/client/Client.ts">send</a>({ ...params }) -> Pinnacle.SmsSendResponse</code></summary>
|
|
2667
3147
|
<dl>
|
|
2668
3148
|
<dd>
|
|
@@ -2676,7 +3156,6 @@ await client.campaigns.rcs.validate({
|
|
|
2676
3156
|
<dd>
|
|
2677
3157
|
|
|
2678
3158
|
Send a SMS message immediately or schedule it for future delivery.
|
|
2679
|
-
|
|
2680
3159
|
</dd>
|
|
2681
3160
|
</dl>
|
|
2682
3161
|
</dd>
|
|
@@ -2694,10 +3173,10 @@ Send a SMS message immediately or schedule it for future delivery.
|
|
|
2694
3173
|
await client.messages.sms.send({
|
|
2695
3174
|
from: "+14155164736",
|
|
2696
3175
|
text: "Hey!",
|
|
2697
|
-
to: "+14154746461"
|
|
3176
|
+
to: "+14154746461"
|
|
2698
3177
|
});
|
|
2699
|
-
```
|
|
2700
3178
|
|
|
3179
|
+
```
|
|
2701
3180
|
</dd>
|
|
2702
3181
|
</dl>
|
|
2703
3182
|
</dd>
|
|
@@ -2711,21 +3190,22 @@ await client.messages.sms.send({
|
|
|
2711
3190
|
<dl>
|
|
2712
3191
|
<dd>
|
|
2713
3192
|
|
|
2714
|
-
**request:** `Pinnacle.messages.Sms`
|
|
2715
|
-
|
|
3193
|
+
**request:** `Pinnacle.messages.Sms`
|
|
3194
|
+
|
|
2716
3195
|
</dd>
|
|
2717
3196
|
</dl>
|
|
2718
3197
|
|
|
2719
3198
|
<dl>
|
|
2720
3199
|
<dd>
|
|
2721
3200
|
|
|
2722
|
-
**requestOptions:** `Sms.RequestOptions`
|
|
2723
|
-
|
|
3201
|
+
**requestOptions:** `Sms.RequestOptions`
|
|
3202
|
+
|
|
2724
3203
|
</dd>
|
|
2725
3204
|
</dl>
|
|
2726
3205
|
</dd>
|
|
2727
3206
|
</dl>
|
|
2728
3207
|
|
|
3208
|
+
|
|
2729
3209
|
</dd>
|
|
2730
3210
|
</dl>
|
|
2731
3211
|
</details>
|
|
@@ -2743,7 +3223,6 @@ await client.messages.sms.send({
|
|
|
2743
3223
|
<dd>
|
|
2744
3224
|
|
|
2745
3225
|
Validate SMS message content without sending it.
|
|
2746
|
-
|
|
2747
3226
|
</dd>
|
|
2748
3227
|
</dl>
|
|
2749
3228
|
</dd>
|
|
@@ -2759,10 +3238,10 @@ Validate SMS message content without sending it.
|
|
|
2759
3238
|
|
|
2760
3239
|
```typescript
|
|
2761
3240
|
await client.messages.sms.validate({
|
|
2762
|
-
text: "Hello from Pinnacle"
|
|
3241
|
+
text: "Hello from Pinnacle"
|
|
2763
3242
|
});
|
|
2764
|
-
```
|
|
2765
3243
|
|
|
3244
|
+
```
|
|
2766
3245
|
</dd>
|
|
2767
3246
|
</dl>
|
|
2768
3247
|
</dd>
|
|
@@ -2776,27 +3255,27 @@ await client.messages.sms.validate({
|
|
|
2776
3255
|
<dl>
|
|
2777
3256
|
<dd>
|
|
2778
3257
|
|
|
2779
|
-
**request:** `Pinnacle.SmsContent`
|
|
2780
|
-
|
|
3258
|
+
**request:** `Pinnacle.SmsContent`
|
|
3259
|
+
|
|
2781
3260
|
</dd>
|
|
2782
3261
|
</dl>
|
|
2783
3262
|
|
|
2784
3263
|
<dl>
|
|
2785
3264
|
<dd>
|
|
2786
3265
|
|
|
2787
|
-
**requestOptions:** `Sms.RequestOptions`
|
|
2788
|
-
|
|
3266
|
+
**requestOptions:** `Sms.RequestOptions`
|
|
3267
|
+
|
|
2789
3268
|
</dd>
|
|
2790
3269
|
</dl>
|
|
2791
3270
|
</dd>
|
|
2792
3271
|
</dl>
|
|
2793
3272
|
|
|
3273
|
+
|
|
2794
3274
|
</dd>
|
|
2795
3275
|
</dl>
|
|
2796
3276
|
</details>
|
|
2797
3277
|
|
|
2798
3278
|
## Messages Mms
|
|
2799
|
-
|
|
2800
3279
|
<details><summary><code>client.messages.mms.<a href="/src/api/resources/messages/resources/mms/client/Client.ts">send</a>({ ...params }) -> Pinnacle.MmsSendResponse</code></summary>
|
|
2801
3280
|
<dl>
|
|
2802
3281
|
<dd>
|
|
@@ -2810,7 +3289,6 @@ await client.messages.sms.validate({
|
|
|
2810
3289
|
<dd>
|
|
2811
3290
|
|
|
2812
3291
|
Send a MMS immediately or schedule it for future delivery.
|
|
2813
|
-
|
|
2814
3292
|
</dd>
|
|
2815
3293
|
</dl>
|
|
2816
3294
|
</dd>
|
|
@@ -2830,13 +3308,13 @@ await client.messages.mms.send({
|
|
|
2830
3308
|
mediaUrls: ["https://fastly.picsum.photos/id/941/300/300.jpg?hmac=mDxM9PWSqRDjecwSCEpzU4bj35gqnG7yA25OL29uNv0"],
|
|
2831
3309
|
options: {
|
|
2832
3310
|
multiple_messages: true,
|
|
2833
|
-
validate: true
|
|
3311
|
+
validate: true
|
|
2834
3312
|
},
|
|
2835
3313
|
text: "Check out this image!",
|
|
2836
|
-
to: "+14154746461"
|
|
3314
|
+
to: "+14154746461"
|
|
2837
3315
|
});
|
|
2838
|
-
```
|
|
2839
3316
|
|
|
3317
|
+
```
|
|
2840
3318
|
</dd>
|
|
2841
3319
|
</dl>
|
|
2842
3320
|
</dd>
|
|
@@ -2850,21 +3328,22 @@ await client.messages.mms.send({
|
|
|
2850
3328
|
<dl>
|
|
2851
3329
|
<dd>
|
|
2852
3330
|
|
|
2853
|
-
**request:** `Pinnacle.messages.Mms`
|
|
2854
|
-
|
|
3331
|
+
**request:** `Pinnacle.messages.Mms`
|
|
3332
|
+
|
|
2855
3333
|
</dd>
|
|
2856
3334
|
</dl>
|
|
2857
3335
|
|
|
2858
3336
|
<dl>
|
|
2859
3337
|
<dd>
|
|
2860
3338
|
|
|
2861
|
-
**requestOptions:** `Mms.RequestOptions`
|
|
2862
|
-
|
|
3339
|
+
**requestOptions:** `Mms.RequestOptions`
|
|
3340
|
+
|
|
2863
3341
|
</dd>
|
|
2864
3342
|
</dl>
|
|
2865
3343
|
</dd>
|
|
2866
3344
|
</dl>
|
|
2867
3345
|
|
|
3346
|
+
|
|
2868
3347
|
</dd>
|
|
2869
3348
|
</dl>
|
|
2870
3349
|
</details>
|
|
@@ -2882,7 +3361,6 @@ await client.messages.mms.send({
|
|
|
2882
3361
|
<dd>
|
|
2883
3362
|
|
|
2884
3363
|
Validate MMS message content without sending it.
|
|
2885
|
-
|
|
2886
3364
|
</dd>
|
|
2887
3365
|
</dl>
|
|
2888
3366
|
</dd>
|
|
@@ -2898,15 +3376,11 @@ Validate MMS message content without sending it.
|
|
|
2898
3376
|
|
|
2899
3377
|
```typescript
|
|
2900
3378
|
await client.messages.mms.validate({
|
|
2901
|
-
mediaUrls: [
|
|
2902
|
-
|
|
2903
|
-
"https://fastly.picsum.photos/id/528/1000/1000.jpg?hmac=aTG0xNif9KbNryFN0ZNZ_nFK6aEpZxqUGCZF1KjOT8w",
|
|
2904
|
-
"https://file-examples.com/storage/fefdd7ab126835e7993bb1a/2017/10/file_example_JPG_500kB.jpg",
|
|
2905
|
-
],
|
|
2906
|
-
text: "Check out these images!",
|
|
3379
|
+
mediaUrls: ["https://upload.wikimedia.org/wikipedia/commons/b/b9/Pizigani_1367_Chart_1MB.jpg", "https://fastly.picsum.photos/id/528/1000/1000.jpg?hmac=aTG0xNif9KbNryFN0ZNZ_nFK6aEpZxqUGCZF1KjOT8w", "https://file-examples.com/storage/fefdd7ab126835e7993bb1a/2017/10/file_example_JPG_500kB.jpg"],
|
|
3380
|
+
text: "Check out these images!"
|
|
2907
3381
|
});
|
|
2908
|
-
```
|
|
2909
3382
|
|
|
3383
|
+
```
|
|
2910
3384
|
</dd>
|
|
2911
3385
|
</dl>
|
|
2912
3386
|
</dd>
|
|
@@ -2920,28 +3394,28 @@ await client.messages.mms.validate({
|
|
|
2920
3394
|
<dl>
|
|
2921
3395
|
<dd>
|
|
2922
3396
|
|
|
2923
|
-
**request:** `Pinnacle.MmsContent`
|
|
2924
|
-
|
|
3397
|
+
**request:** `Pinnacle.MmsContent`
|
|
3398
|
+
|
|
2925
3399
|
</dd>
|
|
2926
3400
|
</dl>
|
|
2927
3401
|
|
|
2928
3402
|
<dl>
|
|
2929
3403
|
<dd>
|
|
2930
3404
|
|
|
2931
|
-
**requestOptions:** `Mms.RequestOptions`
|
|
2932
|
-
|
|
3405
|
+
**requestOptions:** `Mms.RequestOptions`
|
|
3406
|
+
|
|
2933
3407
|
</dd>
|
|
2934
3408
|
</dl>
|
|
2935
3409
|
</dd>
|
|
2936
3410
|
</dl>
|
|
2937
3411
|
|
|
3412
|
+
|
|
2938
3413
|
</dd>
|
|
2939
3414
|
</dl>
|
|
2940
3415
|
</details>
|
|
2941
3416
|
|
|
2942
3417
|
## Messages Rcs
|
|
2943
|
-
|
|
2944
|
-
<details><summary><code>client.messages.rcs.<a href="/src/api/resources/messages/resources/rcs/client/Client.ts">send</a>({ ...params }) -> Pinnacle.RcsSendResponse</code></summary>
|
|
3418
|
+
<details><summary><code>client.messages.rcs.<a href="/src/api/resources/messages/resources/rcs/client/Client.ts">send</a>({ ...params }) -> Pinnacle.SendRichMessageResponse</code></summary>
|
|
2945
3419
|
<dl>
|
|
2946
3420
|
<dd>
|
|
2947
3421
|
|
|
@@ -2956,7 +3430,6 @@ await client.messages.mms.validate({
|
|
|
2956
3430
|
Send a RCS message immediately or schedule it for future delivery. <br>
|
|
2957
3431
|
|
|
2958
3432
|
Requires an active RCS agent and recipient devices that support RCS Business Messaging.
|
|
2959
|
-
|
|
2960
3433
|
</dd>
|
|
2961
3434
|
</dl>
|
|
2962
3435
|
</dd>
|
|
@@ -2972,19 +3445,17 @@ Requires an active RCS agent and recipient devices that support RCS Business Mes
|
|
|
2972
3445
|
|
|
2973
3446
|
```typescript
|
|
2974
3447
|
await client.messages.rcs.send({
|
|
2975
|
-
quickReplies: [
|
|
2976
|
-
{
|
|
3448
|
+
quickReplies: [{
|
|
2977
3449
|
type: "openUrl",
|
|
2978
3450
|
payload: "payload",
|
|
2979
|
-
title: "title"
|
|
2980
|
-
},
|
|
2981
|
-
],
|
|
3451
|
+
title: "title"
|
|
3452
|
+
}],
|
|
2982
3453
|
text: "text",
|
|
2983
3454
|
from: "from",
|
|
2984
|
-
to: "to"
|
|
3455
|
+
to: "to"
|
|
2985
3456
|
});
|
|
2986
|
-
```
|
|
2987
3457
|
|
|
3458
|
+
```
|
|
2988
3459
|
</dd>
|
|
2989
3460
|
</dl>
|
|
2990
3461
|
</dd>
|
|
@@ -2998,21 +3469,22 @@ await client.messages.rcs.send({
|
|
|
2998
3469
|
<dl>
|
|
2999
3470
|
<dd>
|
|
3000
3471
|
|
|
3001
|
-
**request:** `Pinnacle.RichMessage`
|
|
3002
|
-
|
|
3472
|
+
**request:** `Pinnacle.RichMessage`
|
|
3473
|
+
|
|
3003
3474
|
</dd>
|
|
3004
3475
|
</dl>
|
|
3005
3476
|
|
|
3006
3477
|
<dl>
|
|
3007
3478
|
<dd>
|
|
3008
3479
|
|
|
3009
|
-
**requestOptions:** `Rcs.RequestOptions`
|
|
3010
|
-
|
|
3480
|
+
**requestOptions:** `Rcs.RequestOptions`
|
|
3481
|
+
|
|
3011
3482
|
</dd>
|
|
3012
3483
|
</dl>
|
|
3013
3484
|
</dd>
|
|
3014
3485
|
</dl>
|
|
3015
3486
|
|
|
3487
|
+
|
|
3016
3488
|
</dd>
|
|
3017
3489
|
</dl>
|
|
3018
3490
|
</details>
|
|
@@ -3040,7 +3512,6 @@ This endpoint allows RCS agents to display a typing indicator to recipients. The
|
|
|
3040
3512
|
**Frequency:** You can send typing indicators as many times as needed, though only one will be displayed at a time. Sending multiple typing indicators will extend the duration of the current indicator.
|
|
3041
3513
|
|
|
3042
3514
|
> **Note:** Typing indicators are best-effort hints, not delivery-guaranteed state. The platform is allowed to coalesce or drop them, and the client UI decides when to show/hide.
|
|
3043
|
-
|
|
3044
3515
|
</dd>
|
|
3045
3516
|
</dl>
|
|
3046
3517
|
</dd>
|
|
@@ -3059,11 +3530,11 @@ await client.messages.rcs.sendTyping({
|
|
|
3059
3530
|
agentId: "agent_pinnacle",
|
|
3060
3531
|
to: "+14154746461",
|
|
3061
3532
|
options: {
|
|
3062
|
-
test_mode: false
|
|
3063
|
-
}
|
|
3533
|
+
test_mode: false
|
|
3534
|
+
}
|
|
3064
3535
|
});
|
|
3065
|
-
```
|
|
3066
3536
|
|
|
3537
|
+
```
|
|
3067
3538
|
</dd>
|
|
3068
3539
|
</dl>
|
|
3069
3540
|
</dd>
|
|
@@ -3077,21 +3548,22 @@ await client.messages.rcs.sendTyping({
|
|
|
3077
3548
|
<dl>
|
|
3078
3549
|
<dd>
|
|
3079
3550
|
|
|
3080
|
-
**request:** `Pinnacle.messages.SendTypingIndicatorSchema`
|
|
3081
|
-
|
|
3551
|
+
**request:** `Pinnacle.messages.SendTypingIndicatorSchema`
|
|
3552
|
+
|
|
3082
3553
|
</dd>
|
|
3083
3554
|
</dl>
|
|
3084
3555
|
|
|
3085
3556
|
<dl>
|
|
3086
3557
|
<dd>
|
|
3087
3558
|
|
|
3088
|
-
**requestOptions:** `Rcs.RequestOptions`
|
|
3089
|
-
|
|
3559
|
+
**requestOptions:** `Rcs.RequestOptions`
|
|
3560
|
+
|
|
3090
3561
|
</dd>
|
|
3091
3562
|
</dl>
|
|
3092
3563
|
</dd>
|
|
3093
3564
|
</dl>
|
|
3094
3565
|
|
|
3566
|
+
|
|
3095
3567
|
</dd>
|
|
3096
3568
|
</dl>
|
|
3097
3569
|
</details>
|
|
@@ -3109,7 +3581,6 @@ await client.messages.rcs.sendTyping({
|
|
|
3109
3581
|
<dd>
|
|
3110
3582
|
|
|
3111
3583
|
Validate RCS message content without sending it.
|
|
3112
|
-
|
|
3113
3584
|
</dd>
|
|
3114
3585
|
</dl>
|
|
3115
3586
|
</dd>
|
|
@@ -3125,17 +3596,15 @@ Validate RCS message content without sending it.
|
|
|
3125
3596
|
|
|
3126
3597
|
```typescript
|
|
3127
3598
|
await client.messages.rcs.validate({
|
|
3128
|
-
quickReplies: [
|
|
3129
|
-
{
|
|
3599
|
+
quickReplies: [{
|
|
3130
3600
|
type: "openUrl",
|
|
3131
3601
|
payload: "payload",
|
|
3132
|
-
title: "title"
|
|
3133
|
-
},
|
|
3134
|
-
|
|
3135
|
-
text: "text",
|
|
3602
|
+
title: "title"
|
|
3603
|
+
}],
|
|
3604
|
+
text: "text"
|
|
3136
3605
|
});
|
|
3137
|
-
```
|
|
3138
3606
|
|
|
3607
|
+
```
|
|
3139
3608
|
</dd>
|
|
3140
3609
|
</dl>
|
|
3141
3610
|
</dd>
|
|
@@ -3149,27 +3618,27 @@ await client.messages.rcs.validate({
|
|
|
3149
3618
|
<dl>
|
|
3150
3619
|
<dd>
|
|
3151
3620
|
|
|
3152
|
-
**request:** `Pinnacle.RcsValidateContent`
|
|
3153
|
-
|
|
3621
|
+
**request:** `Pinnacle.RcsValidateContent`
|
|
3622
|
+
|
|
3154
3623
|
</dd>
|
|
3155
3624
|
</dl>
|
|
3156
3625
|
|
|
3157
3626
|
<dl>
|
|
3158
3627
|
<dd>
|
|
3159
3628
|
|
|
3160
|
-
**requestOptions:** `Rcs.RequestOptions`
|
|
3161
|
-
|
|
3629
|
+
**requestOptions:** `Rcs.RequestOptions`
|
|
3630
|
+
|
|
3162
3631
|
</dd>
|
|
3163
3632
|
</dl>
|
|
3164
3633
|
</dd>
|
|
3165
3634
|
</dl>
|
|
3166
3635
|
|
|
3636
|
+
|
|
3167
3637
|
</dd>
|
|
3168
3638
|
</dl>
|
|
3169
3639
|
</details>
|
|
3170
3640
|
|
|
3171
3641
|
## PhoneNumbers Webhook
|
|
3172
|
-
|
|
3173
3642
|
<details><summary><code>client.phoneNumbers.webhook.<a href="/src/api/resources/phoneNumbers/resources/webhook/client/Client.ts">attach</a>(phone, { ...params }) -> Pinnacle.ConfiguredWebhook</code></summary>
|
|
3174
3643
|
<dl>
|
|
3175
3644
|
<dd>
|
|
@@ -3183,7 +3652,6 @@ await client.messages.rcs.validate({
|
|
|
3183
3652
|
<dd>
|
|
3184
3653
|
|
|
3185
3654
|
Connect a webhook to your phone number to receive real-time notifications for incoming messages, delivery status updates, and other communication events.
|
|
3186
|
-
|
|
3187
3655
|
</dd>
|
|
3188
3656
|
</dl>
|
|
3189
3657
|
</dd>
|
|
@@ -3200,10 +3668,10 @@ Connect a webhook to your phone number to receive real-time notifications for in
|
|
|
3200
3668
|
```typescript
|
|
3201
3669
|
await client.phoneNumbers.webhook.attach("%2B14155551234", {
|
|
3202
3670
|
webhookId: "wh_1234567890",
|
|
3203
|
-
event: "MESSAGE.STATUS"
|
|
3671
|
+
event: "MESSAGE.STATUS"
|
|
3204
3672
|
});
|
|
3205
|
-
```
|
|
3206
3673
|
|
|
3674
|
+
```
|
|
3207
3675
|
</dd>
|
|
3208
3676
|
</dl>
|
|
3209
3677
|
</dd>
|
|
@@ -3217,33 +3685,34 @@ await client.phoneNumbers.webhook.attach("%2B14155551234", {
|
|
|
3217
3685
|
<dl>
|
|
3218
3686
|
<dd>
|
|
3219
3687
|
|
|
3220
|
-
**phone:** `string`
|
|
3688
|
+
**phone:** `string`
|
|
3221
3689
|
|
|
3222
3690
|
The phone number you want to attach the webhook to in E.164 format. Make sure it is url encoded (i.e. replace the leading + with %2B). <br>
|
|
3223
3691
|
|
|
3224
3692
|
Must be a phone number that you own and have already [purchased](./buy) through the API. A phone number can have multiple webhooks attached to it.
|
|
3225
|
-
|
|
3693
|
+
|
|
3226
3694
|
</dd>
|
|
3227
3695
|
</dl>
|
|
3228
3696
|
|
|
3229
3697
|
<dl>
|
|
3230
3698
|
<dd>
|
|
3231
3699
|
|
|
3232
|
-
**request:** `Pinnacle.AttachWebhookParams`
|
|
3233
|
-
|
|
3700
|
+
**request:** `Pinnacle.AttachWebhookParams`
|
|
3701
|
+
|
|
3234
3702
|
</dd>
|
|
3235
3703
|
</dl>
|
|
3236
3704
|
|
|
3237
3705
|
<dl>
|
|
3238
3706
|
<dd>
|
|
3239
3707
|
|
|
3240
|
-
**requestOptions:** `Webhook.RequestOptions`
|
|
3241
|
-
|
|
3708
|
+
**requestOptions:** `Webhook.RequestOptions`
|
|
3709
|
+
|
|
3242
3710
|
</dd>
|
|
3243
3711
|
</dl>
|
|
3244
3712
|
</dd>
|
|
3245
3713
|
</dl>
|
|
3246
3714
|
|
|
3715
|
+
|
|
3247
3716
|
</dd>
|
|
3248
3717
|
</dl>
|
|
3249
3718
|
</details>
|
|
@@ -3263,7 +3732,6 @@ Must be a phone number that you own and have already [purchased](./buy) through
|
|
|
3263
3732
|
Disconnect a webhook from your phone number to stop receiving event notifications for that specific number. <br>
|
|
3264
3733
|
|
|
3265
3734
|
The webhook configuration itself remains intact and available for use with other phone numbers.
|
|
3266
|
-
|
|
3267
3735
|
</dd>
|
|
3268
3736
|
</dl>
|
|
3269
3737
|
</dd>
|
|
@@ -3279,8 +3747,8 @@ The webhook configuration itself remains intact and available for use with other
|
|
|
3279
3747
|
|
|
3280
3748
|
```typescript
|
|
3281
3749
|
await client.phoneNumbers.webhook.detach("+14155551234", "wh_1234567890");
|
|
3282
|
-
```
|
|
3283
3750
|
|
|
3751
|
+
```
|
|
3284
3752
|
</dd>
|
|
3285
3753
|
</dl>
|
|
3286
3754
|
</dd>
|
|
@@ -3294,43 +3762,43 @@ await client.phoneNumbers.webhook.detach("+14155551234", "wh_1234567890");
|
|
|
3294
3762
|
<dl>
|
|
3295
3763
|
<dd>
|
|
3296
3764
|
|
|
3297
|
-
**phone:** `string`
|
|
3765
|
+
**phone:** `string`
|
|
3298
3766
|
|
|
3299
3767
|
The phone number you want to attach the webhook to in E.164 format. Make sure it is url encoded (i.e. replace the leading + with %2B). <br>
|
|
3300
3768
|
|
|
3301
3769
|
Must be a phone number that you own and currently has the specified webhook attached.
|
|
3302
|
-
|
|
3770
|
+
|
|
3303
3771
|
</dd>
|
|
3304
3772
|
</dl>
|
|
3305
3773
|
|
|
3306
3774
|
<dl>
|
|
3307
3775
|
<dd>
|
|
3308
3776
|
|
|
3309
|
-
**webhookId:** `string`
|
|
3777
|
+
**webhookId:** `string`
|
|
3310
3778
|
|
|
3311
3779
|
The unique identifier of the webhook you want to detach from the phone number. <br>
|
|
3312
3780
|
|
|
3313
3781
|
This must be a valid webhook ID that is currently attached to the specified phone number. This identifier is a string that always begins with the prefix `wh_`, for example: `wh_1234567890`.
|
|
3314
|
-
|
|
3782
|
+
|
|
3315
3783
|
</dd>
|
|
3316
3784
|
</dl>
|
|
3317
3785
|
|
|
3318
3786
|
<dl>
|
|
3319
3787
|
<dd>
|
|
3320
3788
|
|
|
3321
|
-
**requestOptions:** `Webhook.RequestOptions`
|
|
3322
|
-
|
|
3789
|
+
**requestOptions:** `Webhook.RequestOptions`
|
|
3790
|
+
|
|
3323
3791
|
</dd>
|
|
3324
3792
|
</dl>
|
|
3325
3793
|
</dd>
|
|
3326
3794
|
</dl>
|
|
3327
3795
|
|
|
3796
|
+
|
|
3328
3797
|
</dd>
|
|
3329
3798
|
</dl>
|
|
3330
3799
|
</details>
|
|
3331
3800
|
|
|
3332
3801
|
## PhoneNumbers Campaign
|
|
3333
|
-
|
|
3334
3802
|
<details><summary><code>client.phoneNumbers.campaign.<a href="/src/api/resources/phoneNumbers/resources/campaign/client/Client.ts">attach</a>({ ...params }) -> Pinnacle.AttachedPhoneNumberResult</code></summary>
|
|
3335
3803
|
<dl>
|
|
3336
3804
|
<dd>
|
|
@@ -3344,7 +3812,6 @@ This must be a valid webhook ID that is currently attached to the specified phon
|
|
|
3344
3812
|
<dd>
|
|
3345
3813
|
|
|
3346
3814
|
Link a phone number to a specific campaign. Phone numbers must be linked to a campaign to send messages.
|
|
3347
|
-
|
|
3348
3815
|
</dd>
|
|
3349
3816
|
</dl>
|
|
3350
3817
|
</dd>
|
|
@@ -3362,10 +3829,10 @@ Link a phone number to a specific campaign. Phone numbers must be linked to a ca
|
|
|
3362
3829
|
await client.phoneNumbers.campaign.attach({
|
|
3363
3830
|
phones: ["+14155550123", "+14155559876", "+14155550111"],
|
|
3364
3831
|
campaignType: "TOLL_FREE",
|
|
3365
|
-
campaignId: "tf_1234567890"
|
|
3832
|
+
campaignId: "tf_1234567890"
|
|
3366
3833
|
});
|
|
3367
|
-
```
|
|
3368
3834
|
|
|
3835
|
+
```
|
|
3369
3836
|
</dd>
|
|
3370
3837
|
</dl>
|
|
3371
3838
|
</dd>
|
|
@@ -3379,21 +3846,22 @@ await client.phoneNumbers.campaign.attach({
|
|
|
3379
3846
|
<dl>
|
|
3380
3847
|
<dd>
|
|
3381
3848
|
|
|
3382
|
-
**request:** `Pinnacle.phoneNumbers.AttachCampaignParams`
|
|
3383
|
-
|
|
3849
|
+
**request:** `Pinnacle.phoneNumbers.AttachCampaignParams`
|
|
3850
|
+
|
|
3384
3851
|
</dd>
|
|
3385
3852
|
</dl>
|
|
3386
3853
|
|
|
3387
3854
|
<dl>
|
|
3388
3855
|
<dd>
|
|
3389
3856
|
|
|
3390
|
-
**requestOptions:** `Campaign.RequestOptions`
|
|
3391
|
-
|
|
3857
|
+
**requestOptions:** `Campaign.RequestOptions`
|
|
3858
|
+
|
|
3392
3859
|
</dd>
|
|
3393
3860
|
</dl>
|
|
3394
3861
|
</dd>
|
|
3395
3862
|
</dl>
|
|
3396
3863
|
|
|
3864
|
+
|
|
3397
3865
|
</dd>
|
|
3398
3866
|
</dl>
|
|
3399
3867
|
</details>
|
|
@@ -3411,7 +3879,6 @@ await client.phoneNumbers.campaign.attach({
|
|
|
3411
3879
|
<dd>
|
|
3412
3880
|
|
|
3413
3881
|
Remove the association between a phone number and its attached campaign.
|
|
3414
|
-
|
|
3415
3882
|
</dd>
|
|
3416
3883
|
</dl>
|
|
3417
3884
|
</dd>
|
|
@@ -3427,10 +3894,10 @@ Remove the association between a phone number and its attached campaign.
|
|
|
3427
3894
|
|
|
3428
3895
|
```typescript
|
|
3429
3896
|
await client.phoneNumbers.campaign.detach({
|
|
3430
|
-
phones: ["+14155559876", "14155550111"]
|
|
3897
|
+
phones: ["+14155559876", "14155550111"]
|
|
3431
3898
|
});
|
|
3432
|
-
```
|
|
3433
3899
|
|
|
3900
|
+
```
|
|
3434
3901
|
</dd>
|
|
3435
3902
|
</dl>
|
|
3436
3903
|
</dd>
|
|
@@ -3444,27 +3911,27 @@ await client.phoneNumbers.campaign.detach({
|
|
|
3444
3911
|
<dl>
|
|
3445
3912
|
<dd>
|
|
3446
3913
|
|
|
3447
|
-
**request:** `Pinnacle.phoneNumbers.DetachCampaignParams`
|
|
3448
|
-
|
|
3914
|
+
**request:** `Pinnacle.phoneNumbers.DetachCampaignParams`
|
|
3915
|
+
|
|
3449
3916
|
</dd>
|
|
3450
3917
|
</dl>
|
|
3451
3918
|
|
|
3452
3919
|
<dl>
|
|
3453
3920
|
<dd>
|
|
3454
3921
|
|
|
3455
|
-
**requestOptions:** `Campaign.RequestOptions`
|
|
3456
|
-
|
|
3922
|
+
**requestOptions:** `Campaign.RequestOptions`
|
|
3923
|
+
|
|
3457
3924
|
</dd>
|
|
3458
3925
|
</dl>
|
|
3459
3926
|
</dd>
|
|
3460
3927
|
</dl>
|
|
3461
3928
|
|
|
3929
|
+
|
|
3462
3930
|
</dd>
|
|
3463
3931
|
</dl>
|
|
3464
3932
|
</details>
|
|
3465
3933
|
|
|
3466
3934
|
## Status Get
|
|
3467
|
-
|
|
3468
3935
|
<details><summary><code>client.status.get.<a href="/src/api/resources/status/resources/get/client/Client.ts">brand</a>(brandId) -> Pinnacle.BrandStatus</code></summary>
|
|
3469
3936
|
<dl>
|
|
3470
3937
|
<dd>
|
|
@@ -3478,7 +3945,6 @@ await client.phoneNumbers.campaign.detach({
|
|
|
3478
3945
|
<dd>
|
|
3479
3946
|
|
|
3480
3947
|
Retrieve a brand's status.
|
|
3481
|
-
|
|
3482
3948
|
</dd>
|
|
3483
3949
|
</dl>
|
|
3484
3950
|
</dd>
|
|
@@ -3494,8 +3960,8 @@ Retrieve a brand's status.
|
|
|
3494
3960
|
|
|
3495
3961
|
```typescript
|
|
3496
3962
|
await client.status.get.brand("b_1234567890");
|
|
3497
|
-
```
|
|
3498
3963
|
|
|
3964
|
+
```
|
|
3499
3965
|
</dd>
|
|
3500
3966
|
</dl>
|
|
3501
3967
|
</dd>
|
|
@@ -3510,20 +3976,21 @@ await client.status.get.brand("b_1234567890");
|
|
|
3510
3976
|
<dd>
|
|
3511
3977
|
|
|
3512
3978
|
**brandId:** `string` — The unique identifier of the brand you want to retrieve the status for. This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`.
|
|
3513
|
-
|
|
3979
|
+
|
|
3514
3980
|
</dd>
|
|
3515
3981
|
</dl>
|
|
3516
3982
|
|
|
3517
3983
|
<dl>
|
|
3518
3984
|
<dd>
|
|
3519
3985
|
|
|
3520
|
-
**requestOptions:** `Get.RequestOptions`
|
|
3521
|
-
|
|
3986
|
+
**requestOptions:** `Get.RequestOptions`
|
|
3987
|
+
|
|
3522
3988
|
</dd>
|
|
3523
3989
|
</dl>
|
|
3524
3990
|
</dd>
|
|
3525
3991
|
</dl>
|
|
3526
3992
|
|
|
3993
|
+
|
|
3527
3994
|
</dd>
|
|
3528
3995
|
</dl>
|
|
3529
3996
|
</details>
|
|
@@ -3541,7 +4008,6 @@ await client.status.get.brand("b_1234567890");
|
|
|
3541
4008
|
<dd>
|
|
3542
4009
|
|
|
3543
4010
|
Retrieve a toll-free campaign's status.
|
|
3544
|
-
|
|
3545
4011
|
</dd>
|
|
3546
4012
|
</dl>
|
|
3547
4013
|
</dd>
|
|
@@ -3557,8 +4023,8 @@ Retrieve a toll-free campaign's status.
|
|
|
3557
4023
|
|
|
3558
4024
|
```typescript
|
|
3559
4025
|
await client.status.get.tollFree("tf_1234567890");
|
|
3560
|
-
```
|
|
3561
4026
|
|
|
4027
|
+
```
|
|
3562
4028
|
</dd>
|
|
3563
4029
|
</dl>
|
|
3564
4030
|
</dd>
|
|
@@ -3573,20 +4039,21 @@ await client.status.get.tollFree("tf_1234567890");
|
|
|
3573
4039
|
<dd>
|
|
3574
4040
|
|
|
3575
4041
|
**campaignId:** `string` — The unique identifier of the toll-free campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `tf_`, for example: `tf_1234567890`.
|
|
3576
|
-
|
|
4042
|
+
|
|
3577
4043
|
</dd>
|
|
3578
4044
|
</dl>
|
|
3579
4045
|
|
|
3580
4046
|
<dl>
|
|
3581
4047
|
<dd>
|
|
3582
4048
|
|
|
3583
|
-
**requestOptions:** `Get.RequestOptions`
|
|
3584
|
-
|
|
4049
|
+
**requestOptions:** `Get.RequestOptions`
|
|
4050
|
+
|
|
3585
4051
|
</dd>
|
|
3586
4052
|
</dl>
|
|
3587
4053
|
</dd>
|
|
3588
4054
|
</dl>
|
|
3589
4055
|
|
|
4056
|
+
|
|
3590
4057
|
</dd>
|
|
3591
4058
|
</dl>
|
|
3592
4059
|
</details>
|
|
@@ -3604,7 +4071,6 @@ await client.status.get.tollFree("tf_1234567890");
|
|
|
3604
4071
|
<dd>
|
|
3605
4072
|
|
|
3606
4073
|
Retrieve a 10DLC campaign's status.
|
|
3607
|
-
|
|
3608
4074
|
</dd>
|
|
3609
4075
|
</dl>
|
|
3610
4076
|
</dd>
|
|
@@ -3620,8 +4086,8 @@ Retrieve a 10DLC campaign's status.
|
|
|
3620
4086
|
|
|
3621
4087
|
```typescript
|
|
3622
4088
|
await client.status.get.dlc("dlc_1234567890");
|
|
3623
|
-
```
|
|
3624
4089
|
|
|
4090
|
+
```
|
|
3625
4091
|
</dd>
|
|
3626
4092
|
</dl>
|
|
3627
4093
|
</dd>
|
|
@@ -3636,20 +4102,21 @@ await client.status.get.dlc("dlc_1234567890");
|
|
|
3636
4102
|
<dd>
|
|
3637
4103
|
|
|
3638
4104
|
**campaignId:** `string` — The unique identifier of the 10DLC campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`.
|
|
3639
|
-
|
|
4105
|
+
|
|
3640
4106
|
</dd>
|
|
3641
4107
|
</dl>
|
|
3642
4108
|
|
|
3643
4109
|
<dl>
|
|
3644
4110
|
<dd>
|
|
3645
4111
|
|
|
3646
|
-
**requestOptions:** `Get.RequestOptions`
|
|
3647
|
-
|
|
4112
|
+
**requestOptions:** `Get.RequestOptions`
|
|
4113
|
+
|
|
3648
4114
|
</dd>
|
|
3649
4115
|
</dl>
|
|
3650
4116
|
</dd>
|
|
3651
4117
|
</dl>
|
|
3652
4118
|
|
|
4119
|
+
|
|
3653
4120
|
</dd>
|
|
3654
4121
|
</dl>
|
|
3655
4122
|
</details>
|
|
@@ -3667,7 +4134,6 @@ await client.status.get.dlc("dlc_1234567890");
|
|
|
3667
4134
|
<dd>
|
|
3668
4135
|
|
|
3669
4136
|
Retrieve a RCS campaign's status.
|
|
3670
|
-
|
|
3671
4137
|
</dd>
|
|
3672
4138
|
</dl>
|
|
3673
4139
|
</dd>
|
|
@@ -3683,8 +4149,8 @@ Retrieve a RCS campaign's status.
|
|
|
3683
4149
|
|
|
3684
4150
|
```typescript
|
|
3685
4151
|
await client.status.get.rcs("rcs_1234567890");
|
|
3686
|
-
```
|
|
3687
4152
|
|
|
4153
|
+
```
|
|
3688
4154
|
</dd>
|
|
3689
4155
|
</dl>
|
|
3690
4156
|
</dd>
|
|
@@ -3699,20 +4165,21 @@ await client.status.get.rcs("rcs_1234567890");
|
|
|
3699
4165
|
<dd>
|
|
3700
4166
|
|
|
3701
4167
|
**campaignId:** `string` — The unique identifier of the RCS campaign you want to retrieve the status for. This identifier is a string that always begins with the prefix `rcs_`, for example: `rcs_1234567890`.
|
|
3702
|
-
|
|
4168
|
+
|
|
3703
4169
|
</dd>
|
|
3704
4170
|
</dl>
|
|
3705
4171
|
|
|
3706
4172
|
<dl>
|
|
3707
4173
|
<dd>
|
|
3708
4174
|
|
|
3709
|
-
**requestOptions:** `Get.RequestOptions`
|
|
3710
|
-
|
|
4175
|
+
**requestOptions:** `Get.RequestOptions`
|
|
4176
|
+
|
|
3711
4177
|
</dd>
|
|
3712
4178
|
</dl>
|
|
3713
4179
|
</dd>
|
|
3714
4180
|
</dl>
|
|
3715
4181
|
|
|
4182
|
+
|
|
3716
4183
|
</dd>
|
|
3717
4184
|
</dl>
|
|
3718
4185
|
</details>
|
|
@@ -3732,7 +4199,6 @@ await client.status.get.rcs("rcs_1234567890");
|
|
|
3732
4199
|
Retrieve a phone number's order status and campaign attachment status. <br>
|
|
3733
4200
|
|
|
3734
4201
|
Check if a number is active and ready to send messages.
|
|
3735
|
-
|
|
3736
4202
|
</dd>
|
|
3737
4203
|
</dl>
|
|
3738
4204
|
</dd>
|
|
@@ -3748,8 +4214,8 @@ Check if a number is active and ready to send messages.
|
|
|
3748
4214
|
|
|
3749
4215
|
```typescript
|
|
3750
4216
|
await client.status.get.phoneNumber("+14151234567");
|
|
3751
|
-
```
|
|
3752
4217
|
|
|
4218
|
+
```
|
|
3753
4219
|
</dd>
|
|
3754
4220
|
</dl>
|
|
3755
4221
|
</dd>
|
|
@@ -3764,26 +4230,26 @@ await client.status.get.phoneNumber("+14151234567");
|
|
|
3764
4230
|
<dd>
|
|
3765
4231
|
|
|
3766
4232
|
**phoneNumber:** `string` — Phone number in E164 format that is in review.
|
|
3767
|
-
|
|
4233
|
+
|
|
3768
4234
|
</dd>
|
|
3769
4235
|
</dl>
|
|
3770
4236
|
|
|
3771
4237
|
<dl>
|
|
3772
4238
|
<dd>
|
|
3773
4239
|
|
|
3774
|
-
**requestOptions:** `Get.RequestOptions`
|
|
3775
|
-
|
|
4240
|
+
**requestOptions:** `Get.RequestOptions`
|
|
4241
|
+
|
|
3776
4242
|
</dd>
|
|
3777
4243
|
</dl>
|
|
3778
4244
|
</dd>
|
|
3779
4245
|
</dl>
|
|
3780
4246
|
|
|
4247
|
+
|
|
3781
4248
|
</dd>
|
|
3782
4249
|
</dl>
|
|
3783
4250
|
</details>
|
|
3784
4251
|
|
|
3785
4252
|
## Tools Url
|
|
3786
|
-
|
|
3787
4253
|
<details><summary><code>client.tools.url.<a href="/src/api/resources/tools/resources/url/client/Client.ts">create</a>({ ...params }) -> Pinnacle.ShortenedUrl</code></summary>
|
|
3788
4254
|
<dl>
|
|
3789
4255
|
<dd>
|
|
@@ -3797,7 +4263,6 @@ await client.status.get.phoneNumber("+14151234567");
|
|
|
3797
4263
|
<dd>
|
|
3798
4264
|
|
|
3799
4265
|
Create a shortened URL that redirects visitors to the provided destination URL.
|
|
3800
|
-
|
|
3801
4266
|
</dd>
|
|
3802
4267
|
</dl>
|
|
3803
4268
|
</dd>
|
|
@@ -3815,11 +4280,11 @@ Create a shortened URL that redirects visitors to the provided destination URL.
|
|
|
3815
4280
|
await client.tools.url.create({
|
|
3816
4281
|
url: "https://www.pinnacle.sh/",
|
|
3817
4282
|
options: {
|
|
3818
|
-
expiresAt: "2025-06-23T16:18:25.000Z"
|
|
3819
|
-
}
|
|
4283
|
+
expiresAt: "2025-06-23T16:18:25.000Z"
|
|
4284
|
+
}
|
|
3820
4285
|
});
|
|
3821
|
-
```
|
|
3822
4286
|
|
|
4287
|
+
```
|
|
3823
4288
|
</dd>
|
|
3824
4289
|
</dl>
|
|
3825
4290
|
</dd>
|
|
@@ -3833,21 +4298,22 @@ await client.tools.url.create({
|
|
|
3833
4298
|
<dl>
|
|
3834
4299
|
<dd>
|
|
3835
4300
|
|
|
3836
|
-
**request:** `Pinnacle.tools.CreateUrlParams`
|
|
3837
|
-
|
|
4301
|
+
**request:** `Pinnacle.tools.CreateUrlParams`
|
|
4302
|
+
|
|
3838
4303
|
</dd>
|
|
3839
4304
|
</dl>
|
|
3840
4305
|
|
|
3841
4306
|
<dl>
|
|
3842
4307
|
<dd>
|
|
3843
4308
|
|
|
3844
|
-
**requestOptions:** `Url.RequestOptions`
|
|
3845
|
-
|
|
4309
|
+
**requestOptions:** `Url.RequestOptions`
|
|
4310
|
+
|
|
3846
4311
|
</dd>
|
|
3847
4312
|
</dl>
|
|
3848
4313
|
</dd>
|
|
3849
4314
|
</dl>
|
|
3850
4315
|
|
|
4316
|
+
|
|
3851
4317
|
</dd>
|
|
3852
4318
|
</dl>
|
|
3853
4319
|
</details>
|
|
@@ -3865,7 +4331,6 @@ await client.tools.url.create({
|
|
|
3865
4331
|
<dd>
|
|
3866
4332
|
|
|
3867
4333
|
Retrieve configuration and details for your shortened URL using its unique identifier.
|
|
3868
|
-
|
|
3869
4334
|
</dd>
|
|
3870
4335
|
</dl>
|
|
3871
4336
|
</dd>
|
|
@@ -3881,8 +4346,8 @@ Retrieve configuration and details for your shortened URL using its unique ident
|
|
|
3881
4346
|
|
|
3882
4347
|
```typescript
|
|
3883
4348
|
await client.tools.url.get("ePzVxILF");
|
|
3884
|
-
```
|
|
3885
4349
|
|
|
4350
|
+
```
|
|
3886
4351
|
</dd>
|
|
3887
4352
|
</dl>
|
|
3888
4353
|
</dd>
|
|
@@ -3896,25 +4361,26 @@ await client.tools.url.get("ePzVxILF");
|
|
|
3896
4361
|
<dl>
|
|
3897
4362
|
<dd>
|
|
3898
4363
|
|
|
3899
|
-
**linkId:** `string`
|
|
4364
|
+
**linkId:** `string`
|
|
3900
4365
|
|
|
3901
4366
|
Unique identifier from your shortened URL. For example, for `https://pncl.to/ePzVxILF`, the `linkId` is `ePzVxILF`. <br>
|
|
3902
4367
|
|
|
3903
4368
|
See the response of [Create Shortened URL](./create-url) for more information.
|
|
3904
|
-
|
|
4369
|
+
|
|
3905
4370
|
</dd>
|
|
3906
4371
|
</dl>
|
|
3907
4372
|
|
|
3908
4373
|
<dl>
|
|
3909
4374
|
<dd>
|
|
3910
4375
|
|
|
3911
|
-
**requestOptions:** `Url.RequestOptions`
|
|
3912
|
-
|
|
4376
|
+
**requestOptions:** `Url.RequestOptions`
|
|
4377
|
+
|
|
3913
4378
|
</dd>
|
|
3914
4379
|
</dl>
|
|
3915
4380
|
</dd>
|
|
3916
4381
|
</dl>
|
|
3917
4382
|
|
|
4383
|
+
|
|
3918
4384
|
</dd>
|
|
3919
4385
|
</dl>
|
|
3920
4386
|
</details>
|
|
@@ -3932,7 +4398,6 @@ See the response of [Create Shortened URL](./create-url) for more information.
|
|
|
3932
4398
|
<dd>
|
|
3933
4399
|
|
|
3934
4400
|
Update the destination or expiration date of an existing shortened URL. Expiring links cannot be updated into a permalink.
|
|
3935
|
-
|
|
3936
4401
|
</dd>
|
|
3937
4402
|
</dl>
|
|
3938
4403
|
</dd>
|
|
@@ -3948,10 +4413,10 @@ Update the destination or expiration date of an existing shortened URL. Expiring
|
|
|
3948
4413
|
|
|
3949
4414
|
```typescript
|
|
3950
4415
|
await client.tools.url.update("ePzVxILF", {
|
|
3951
|
-
url: "https://www.pinnacle.sh/"
|
|
4416
|
+
url: "https://www.pinnacle.sh/"
|
|
3952
4417
|
});
|
|
3953
|
-
```
|
|
3954
4418
|
|
|
4419
|
+
```
|
|
3955
4420
|
</dd>
|
|
3956
4421
|
</dl>
|
|
3957
4422
|
</dd>
|
|
@@ -3965,39 +4430,39 @@ await client.tools.url.update("ePzVxILF", {
|
|
|
3965
4430
|
<dl>
|
|
3966
4431
|
<dd>
|
|
3967
4432
|
|
|
3968
|
-
**linkId:** `string`
|
|
4433
|
+
**linkId:** `string`
|
|
3969
4434
|
|
|
3970
4435
|
Unique identifier from your shortened URL. For example, for `https://pncl.to/ePzVxILF`, the `linkId` is `ePzVxILF`. <br>
|
|
3971
4436
|
|
|
3972
4437
|
See the response of [Create Shortened URL](./create-url) for more information.
|
|
3973
|
-
|
|
4438
|
+
|
|
3974
4439
|
</dd>
|
|
3975
4440
|
</dl>
|
|
3976
4441
|
|
|
3977
4442
|
<dl>
|
|
3978
4443
|
<dd>
|
|
3979
4444
|
|
|
3980
|
-
**request:** `Pinnacle.tools.UpdateUrlParams`
|
|
3981
|
-
|
|
4445
|
+
**request:** `Pinnacle.tools.UpdateUrlParams`
|
|
4446
|
+
|
|
3982
4447
|
</dd>
|
|
3983
4448
|
</dl>
|
|
3984
4449
|
|
|
3985
4450
|
<dl>
|
|
3986
4451
|
<dd>
|
|
3987
4452
|
|
|
3988
|
-
**requestOptions:** `Url.RequestOptions`
|
|
3989
|
-
|
|
4453
|
+
**requestOptions:** `Url.RequestOptions`
|
|
4454
|
+
|
|
3990
4455
|
</dd>
|
|
3991
4456
|
</dl>
|
|
3992
4457
|
</dd>
|
|
3993
4458
|
</dl>
|
|
3994
4459
|
|
|
4460
|
+
|
|
3995
4461
|
</dd>
|
|
3996
4462
|
</dl>
|
|
3997
4463
|
</details>
|
|
3998
4464
|
|
|
3999
4465
|
## Tools File
|
|
4000
|
-
|
|
4001
4466
|
<details><summary><code>client.tools.file.<a href="/src/api/resources/tools/resources/file/client/Client.ts">upload</a>({ ...params }) -> Pinnacle.UploadResults</code></summary>
|
|
4002
4467
|
<dl>
|
|
4003
4468
|
<dd>
|
|
@@ -4011,7 +4476,6 @@ See the response of [Create Shortened URL](./create-url) for more information.
|
|
|
4011
4476
|
<dd>
|
|
4012
4477
|
|
|
4013
4478
|
Generate presigned URLs that let you upload files directly to our storage and allow your users to download them securely.
|
|
4014
|
-
|
|
4015
4479
|
</dd>
|
|
4016
4480
|
</dl>
|
|
4017
4481
|
</dd>
|
|
@@ -4033,12 +4497,12 @@ await client.tools.file.upload({
|
|
|
4033
4497
|
options: {
|
|
4034
4498
|
deleteAt: "2025-12-31T23:59:59Z",
|
|
4035
4499
|
download: {
|
|
4036
|
-
expiresAt: "2025-06-30T12:00:00.000Z"
|
|
4037
|
-
}
|
|
4038
|
-
}
|
|
4500
|
+
expiresAt: "2025-06-30T12:00:00.000Z"
|
|
4501
|
+
}
|
|
4502
|
+
}
|
|
4039
4503
|
});
|
|
4040
|
-
```
|
|
4041
4504
|
|
|
4505
|
+
```
|
|
4042
4506
|
</dd>
|
|
4043
4507
|
</dl>
|
|
4044
4508
|
</dd>
|
|
@@ -4052,21 +4516,22 @@ await client.tools.file.upload({
|
|
|
4052
4516
|
<dl>
|
|
4053
4517
|
<dd>
|
|
4054
4518
|
|
|
4055
|
-
**request:** `Pinnacle.tools.UploadFileParams`
|
|
4056
|
-
|
|
4519
|
+
**request:** `Pinnacle.tools.UploadFileParams`
|
|
4520
|
+
|
|
4057
4521
|
</dd>
|
|
4058
4522
|
</dl>
|
|
4059
4523
|
|
|
4060
4524
|
<dl>
|
|
4061
4525
|
<dd>
|
|
4062
4526
|
|
|
4063
|
-
**requestOptions:** `File_.RequestOptions`
|
|
4064
|
-
|
|
4527
|
+
**requestOptions:** `File_.RequestOptions`
|
|
4528
|
+
|
|
4065
4529
|
</dd>
|
|
4066
4530
|
</dl>
|
|
4067
4531
|
</dd>
|
|
4068
4532
|
</dl>
|
|
4069
4533
|
|
|
4534
|
+
|
|
4070
4535
|
</dd>
|
|
4071
4536
|
</dl>
|
|
4072
4537
|
</details>
|
|
@@ -4103,15 +4568,10 @@ Refresh expiring presigned URLs for Pinnacle-hosted files to extend their access
|
|
|
4103
4568
|
|
|
4104
4569
|
```typescript
|
|
4105
4570
|
await client.tools.file.refresh({
|
|
4106
|
-
urls: [
|
|
4107
|
-
"https://server.trypinnacle.app/storage/v1/object/sign/vault/3/test.jpg?token=oldtoken",
|
|
4108
|
-
"https://server.trypinnacle.app/storage/v1/object/sign/vault/3/document.pdf?token=oldtoken2",
|
|
4109
|
-
"invalid/url",
|
|
4110
|
-
"https://google.com",
|
|
4111
|
-
],
|
|
4571
|
+
urls: ["https://server.trypinnacle.app/storage/v1/object/sign/vault/3/test.jpg?token=oldtoken", "https://server.trypinnacle.app/storage/v1/object/sign/vault/3/document.pdf?token=oldtoken2", "invalid/url", "https://google.com"]
|
|
4112
4572
|
});
|
|
4113
|
-
```
|
|
4114
4573
|
|
|
4574
|
+
```
|
|
4115
4575
|
</dd>
|
|
4116
4576
|
</dl>
|
|
4117
4577
|
</dd>
|
|
@@ -4125,27 +4585,27 @@ await client.tools.file.refresh({
|
|
|
4125
4585
|
<dl>
|
|
4126
4586
|
<dd>
|
|
4127
4587
|
|
|
4128
|
-
**request:** `Pinnacle.tools.RefreshFileParams`
|
|
4129
|
-
|
|
4588
|
+
**request:** `Pinnacle.tools.RefreshFileParams`
|
|
4589
|
+
|
|
4130
4590
|
</dd>
|
|
4131
4591
|
</dl>
|
|
4132
4592
|
|
|
4133
4593
|
<dl>
|
|
4134
4594
|
<dd>
|
|
4135
4595
|
|
|
4136
|
-
**requestOptions:** `File_.RequestOptions`
|
|
4137
|
-
|
|
4596
|
+
**requestOptions:** `File_.RequestOptions`
|
|
4597
|
+
|
|
4138
4598
|
</dd>
|
|
4139
4599
|
</dl>
|
|
4140
4600
|
</dd>
|
|
4141
4601
|
</dl>
|
|
4142
4602
|
|
|
4603
|
+
|
|
4143
4604
|
</dd>
|
|
4144
4605
|
</dl>
|
|
4145
4606
|
</details>
|
|
4146
4607
|
|
|
4147
4608
|
## Tools ContactCard
|
|
4148
|
-
|
|
4149
4609
|
<details><summary><code>client.tools.contactCard.<a href="/src/api/resources/tools/resources/contactCard/client/Client.ts">get</a>({ ...params }) -> Pinnacle.VCardData</code></summary>
|
|
4150
4610
|
<dl>
|
|
4151
4611
|
<dd>
|
|
@@ -4159,7 +4619,6 @@ await client.tools.file.refresh({
|
|
|
4159
4619
|
<dd>
|
|
4160
4620
|
|
|
4161
4621
|
Retrieve contact information as a vCard and get a presigned URL to download the file. Contact cards can be sent [via MMS](/api-reference/messages/send-mms) as a media file.
|
|
4162
|
-
|
|
4163
4622
|
</dd>
|
|
4164
4623
|
</dl>
|
|
4165
4624
|
</dd>
|
|
@@ -4175,10 +4634,10 @@ Retrieve contact information as a vCard and get a presigned URL to download the
|
|
|
4175
4634
|
|
|
4176
4635
|
```typescript
|
|
4177
4636
|
await client.tools.contactCard.get({
|
|
4178
|
-
id: "cc_1234567890"
|
|
4637
|
+
id: "cc_1234567890"
|
|
4179
4638
|
});
|
|
4180
|
-
```
|
|
4181
4639
|
|
|
4640
|
+
```
|
|
4182
4641
|
</dd>
|
|
4183
4642
|
</dl>
|
|
4184
4643
|
</dd>
|
|
@@ -4192,21 +4651,22 @@ await client.tools.contactCard.get({
|
|
|
4192
4651
|
<dl>
|
|
4193
4652
|
<dd>
|
|
4194
4653
|
|
|
4195
|
-
**request:** `Pinnacle.tools.GetVcardParams`
|
|
4196
|
-
|
|
4654
|
+
**request:** `Pinnacle.tools.GetVcardParams`
|
|
4655
|
+
|
|
4197
4656
|
</dd>
|
|
4198
4657
|
</dl>
|
|
4199
4658
|
|
|
4200
4659
|
<dl>
|
|
4201
4660
|
<dd>
|
|
4202
4661
|
|
|
4203
|
-
**requestOptions:** `ContactCard.RequestOptions`
|
|
4204
|
-
|
|
4662
|
+
**requestOptions:** `ContactCard.RequestOptions`
|
|
4663
|
+
|
|
4205
4664
|
</dd>
|
|
4206
4665
|
</dl>
|
|
4207
4666
|
</dd>
|
|
4208
4667
|
</dl>
|
|
4209
4668
|
|
|
4669
|
+
|
|
4210
4670
|
</dd>
|
|
4211
4671
|
</dl>
|
|
4212
4672
|
</details>
|
|
@@ -4224,7 +4684,6 @@ await client.tools.contactCard.get({
|
|
|
4224
4684
|
<dd>
|
|
4225
4685
|
|
|
4226
4686
|
Create a new contact card or updates an existing one with full vCard data. Contact cards can be sent [via MMS](/api-reference/messages/send-mms) as a media file.
|
|
4227
|
-
|
|
4228
4687
|
</dd>
|
|
4229
4688
|
</dl>
|
|
4230
4689
|
</dd>
|
|
@@ -4247,12 +4706,11 @@ await client.tools.contactCard.upsert({
|
|
|
4247
4706
|
givenName: "Jane",
|
|
4248
4707
|
additionalNames: ["A."],
|
|
4249
4708
|
honorificPrefixes: ["Dr."],
|
|
4250
|
-
honorificSuffixes: ["PhD"]
|
|
4709
|
+
honorificSuffixes: ["PhD"]
|
|
4251
4710
|
},
|
|
4252
4711
|
nickname: ["Janie"],
|
|
4253
4712
|
birthday: "1990-02-15",
|
|
4254
|
-
addresses: [
|
|
4255
|
-
{
|
|
4713
|
+
addresses: [{
|
|
4256
4714
|
countryName: "USA",
|
|
4257
4715
|
extendedAddress: "Apt. 4B",
|
|
4258
4716
|
locality: "Anytown",
|
|
@@ -4260,39 +4718,34 @@ await client.tools.contactCard.upsert({
|
|
|
4260
4718
|
postOfficeBox: "PO Box 123",
|
|
4261
4719
|
region: "CA",
|
|
4262
4720
|
streetAddress: "123 Main St",
|
|
4263
|
-
type: ["HOME", "PREF"]
|
|
4264
|
-
},
|
|
4265
|
-
],
|
|
4721
|
+
type: ["HOME", "PREF"]
|
|
4722
|
+
}],
|
|
4266
4723
|
url: "https://app.pinnacle.sh",
|
|
4267
|
-
phones: [
|
|
4268
|
-
{
|
|
4724
|
+
phones: [{
|
|
4269
4725
|
type: ["CELL"],
|
|
4270
|
-
value: "+15551234567"
|
|
4271
|
-
},
|
|
4272
|
-
|
|
4273
|
-
emails: [
|
|
4274
|
-
{
|
|
4726
|
+
value: "+15551234567"
|
|
4727
|
+
}],
|
|
4728
|
+
emails: [{
|
|
4275
4729
|
type: ["INTERNET"],
|
|
4276
|
-
value: "jane.smith@example.com"
|
|
4277
|
-
},
|
|
4278
|
-
],
|
|
4730
|
+
value: "jane.smith@example.com"
|
|
4731
|
+
}],
|
|
4279
4732
|
timezone: "America/Los_Angeles",
|
|
4280
4733
|
geo: {
|
|
4281
4734
|
latitude: 34.0522,
|
|
4282
|
-
longitude: -118.2437
|
|
4735
|
+
longitude: -118.2437
|
|
4283
4736
|
},
|
|
4284
4737
|
title: "Engineer",
|
|
4285
4738
|
role: "Developer",
|
|
4286
4739
|
organization: {
|
|
4287
4740
|
name: "Acme Co",
|
|
4288
|
-
units: ["Engineering", "R&D"]
|
|
4741
|
+
units: ["Engineering", "R&D"]
|
|
4289
4742
|
},
|
|
4290
4743
|
categories: ["Friend", "Colleague"],
|
|
4291
4744
|
note: "Test contact entry",
|
|
4292
|
-
photo: "https://fastly.picsum.photos/id/853/200/200.jpg?hmac=f4LF-tVBBnJb9PQAVEO8GCTGWgLUnxQLw44rUofE6mQ"
|
|
4745
|
+
photo: "https://fastly.picsum.photos/id/853/200/200.jpg?hmac=f4LF-tVBBnJb9PQAVEO8GCTGWgLUnxQLw44rUofE6mQ"
|
|
4293
4746
|
});
|
|
4294
|
-
```
|
|
4295
4747
|
|
|
4748
|
+
```
|
|
4296
4749
|
</dd>
|
|
4297
4750
|
</dl>
|
|
4298
4751
|
</dd>
|
|
@@ -4306,21 +4759,22 @@ await client.tools.contactCard.upsert({
|
|
|
4306
4759
|
<dl>
|
|
4307
4760
|
<dd>
|
|
4308
4761
|
|
|
4309
|
-
**request:** `Pinnacle.tools.UpsertVcardParams`
|
|
4310
|
-
|
|
4762
|
+
**request:** `Pinnacle.tools.UpsertVcardParams`
|
|
4763
|
+
|
|
4311
4764
|
</dd>
|
|
4312
4765
|
</dl>
|
|
4313
4766
|
|
|
4314
4767
|
<dl>
|
|
4315
4768
|
<dd>
|
|
4316
4769
|
|
|
4317
|
-
**requestOptions:** `ContactCard.RequestOptions`
|
|
4318
|
-
|
|
4770
|
+
**requestOptions:** `ContactCard.RequestOptions`
|
|
4771
|
+
|
|
4319
4772
|
</dd>
|
|
4320
4773
|
</dl>
|
|
4321
4774
|
</dd>
|
|
4322
4775
|
</dl>
|
|
4323
4776
|
|
|
4777
|
+
|
|
4324
4778
|
</dd>
|
|
4325
4779
|
</dl>
|
|
4326
4780
|
</details>
|