rcs-js 2.0.0-rc.9 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/Client.d.ts +5 -2
- package/dist/cjs/Client.js +16 -11
- package/dist/cjs/api/resources/brands/client/Client.d.ts +6 -4
- package/dist/cjs/api/resources/brands/client/Client.js +15 -9
- package/dist/cjs/api/resources/brands/client/requests/BrandsGetRequest.d.ts +1 -1
- package/dist/cjs/api/resources/brands/client/requests/UpsertBrandParams.d.ts +3 -3
- package/dist/cjs/api/resources/campaigns/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/campaigns/client/Client.js +1 -1
- package/dist/cjs/api/resources/campaigns/resources/dlc/client/Client.d.ts +9 -9
- package/dist/cjs/api/resources/campaigns/resources/dlc/client/Client.js +7 -7
- package/dist/cjs/api/resources/campaigns/resources/rcs/client/Client.d.ts +5 -3
- package/dist/cjs/api/resources/campaigns/resources/rcs/client/Client.js +5 -1
- package/dist/cjs/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.ts +5 -4
- package/dist/cjs/api/resources/campaigns/resources/tollFree/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/campaigns/resources/tollFree/client/Client.js +1 -1
- package/dist/cjs/api/resources/contacts/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/contacts/client/Client.js +7 -7
- package/dist/cjs/api/resources/contacts/client/requests/ContactsGetRequest.d.ts +2 -2
- package/dist/cjs/api/resources/conversations/client/Client.d.ts +4 -4
- package/dist/cjs/api/resources/conversations/client/Client.js +2 -5
- package/dist/cjs/api/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/index.js +3 -1
- package/dist/cjs/api/resources/messages/client/Client.d.ts +6 -3
- package/dist/cjs/api/resources/messages/client/Client.js +10 -1
- package/dist/cjs/api/resources/messages/client/requests/ReactMessageParams.d.ts +1 -1
- package/dist/cjs/api/resources/messages/resources/mms/client/Client.d.ts +4 -3
- package/dist/cjs/api/resources/messages/resources/mms/client/Client.js +4 -1
- package/dist/cjs/api/resources/messages/resources/rcs/client/Client.d.ts +6 -5
- package/dist/cjs/api/resources/messages/resources/rcs/client/Client.js +5 -2
- package/dist/cjs/api/resources/messages/resources/sms/client/Client.d.ts +4 -3
- package/dist/cjs/api/resources/messages/resources/sms/client/Client.js +4 -1
- package/dist/cjs/api/resources/phoneNumbers/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/phoneNumbers/client/Client.js +1 -1
- package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/Client.d.ts +6 -4
- package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/Client.js +8 -2
- package/dist/cjs/api/resources/phoneNumbers/resources/webhook/client/Client.d.ts +7 -5
- package/dist/cjs/api/resources/phoneNumbers/resources/webhook/client/Client.js +7 -3
- package/dist/cjs/api/resources/rcs/client/Client.d.ts +121 -0
- package/dist/cjs/api/resources/rcs/client/Client.js +320 -0
- package/dist/cjs/api/resources/rcs/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/rcs/client/index.js +17 -0
- package/dist/cjs/api/resources/rcs/client/requests/RcsCapabilitiesQuery.d.ts +13 -0
- package/dist/cjs/api/resources/rcs/client/requests/RcsLinkRequest.d.ts +22 -0
- package/dist/cjs/api/resources/rcs/client/requests/RcsWhitelistRequest.d.ts +16 -0
- package/dist/cjs/api/resources/rcs/client/requests/index.d.ts +3 -0
- package/dist/cjs/api/resources/rcs/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/rcs/index.d.ts +1 -0
- package/dist/cjs/api/resources/rcs/index.js +17 -0
- package/dist/cjs/api/resources/status/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/status/client/Client.js +1 -1
- package/dist/cjs/api/resources/status/resources/get/client/Client.d.ts +5 -5
- package/dist/cjs/api/resources/status/resources/get/client/Client.js +3 -3
- package/dist/cjs/api/resources/tools/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/tools/client/Client.js +1 -1
- package/dist/cjs/api/resources/tools/resources/contactCard/client/Client.d.ts +5 -5
- package/dist/cjs/api/resources/tools/resources/contactCard/client/Client.js +3 -3
- package/dist/cjs/api/resources/tools/resources/file/client/Client.d.ts +24 -3
- package/dist/cjs/api/resources/tools/resources/file/client/Client.js +75 -1
- package/dist/cjs/api/resources/tools/resources/file/client/requests/RefreshFileParams.d.ts +21 -0
- package/dist/cjs/api/resources/tools/resources/file/client/requests/RefreshFileParams.js +5 -0
- package/dist/cjs/api/resources/tools/resources/file/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/tools/resources/url/client/Client.d.ts +4 -4
- package/dist/cjs/api/resources/tools/resources/url/client/Client.js +2 -2
- package/dist/cjs/api/resources/webhooks/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/webhooks/client/Client.js +1 -1
- package/dist/cjs/api/types/AdvancedPhoneInformation.d.ts +9 -9
- package/dist/cjs/api/types/AttachWebhookParams.d.ts +2 -2
- package/dist/cjs/api/types/AutofillDlcCampaignResponse.d.ts +11 -11
- package/dist/cjs/api/types/ButtonClicked.d.ts +11 -0
- package/dist/cjs/api/types/ButtonClicked.js +5 -0
- package/dist/cjs/api/types/ButtonClickedData.d.ts +58 -0
- package/dist/cjs/api/types/ButtonClickedData.js +16 -0
- package/dist/cjs/api/types/Conversation.d.ts +3 -3
- package/dist/cjs/api/types/ConversationList.d.ts +4 -4
- package/dist/cjs/api/types/CreateUrlOptions.d.ts +1 -1
- package/dist/cjs/api/types/DlcCampaignStatus.d.ts +2 -2
- package/dist/cjs/api/types/DlcCampaignWithExtendedBrandAndStatus.d.ts +13 -10
- package/dist/cjs/api/types/EnhancedContactItem.d.ts +1 -1
- package/dist/cjs/api/types/ExtendedBrand.d.ts +12 -5
- package/dist/cjs/api/types/ExtendedBrandWithVetting.d.ts +2 -2
- package/dist/cjs/api/types/ExtendedRcsCampaign.d.ts +13 -12
- package/dist/cjs/api/types/Message.d.ts +4 -4
- package/dist/cjs/api/types/MessageContent.d.ts +2 -2
- package/dist/cjs/api/types/MessageEvent.d.ts +56 -0
- package/dist/cjs/api/types/MessageEvent.js +13 -0
- package/dist/cjs/api/types/ProfileStatusEnum.d.ts +7 -4
- package/dist/cjs/api/types/RcsBase.d.ts +2 -0
- package/dist/cjs/api/types/RcsButtonCall.d.ts +2 -0
- package/dist/cjs/api/types/RcsButtonOpenUrl.d.ts +2 -0
- package/dist/cjs/api/types/RcsButtonRequestUserLocation.d.ts +2 -0
- package/dist/cjs/api/types/RcsButtonScheduleEvent.d.ts +2 -0
- package/dist/cjs/api/types/RcsButtonSendLocation.d.ts +2 -0
- package/dist/cjs/api/types/RcsButtonTrigger.d.ts +2 -2
- package/dist/cjs/api/types/RcsCampaign.d.ts +4 -4
- package/dist/cjs/api/types/RcsCapabilitiesResult.d.ts +8 -0
- package/dist/cjs/api/types/RcsCapabilitiesResult.js +5 -0
- package/dist/cjs/api/types/RcsCapability.d.ts +36 -0
- package/dist/cjs/api/types/RcsCapability.js +5 -0
- package/dist/cjs/api/types/RcsLinkResult.d.ts +13 -0
- package/dist/cjs/api/types/RcsLinkResult.js +5 -0
- package/dist/cjs/api/types/RcsValidateContent.d.ts +1 -0
- package/dist/cjs/api/types/RcsWhitelistResponse.d.ts +10 -0
- package/dist/cjs/api/types/RcsWhitelistResponse.js +5 -0
- package/dist/cjs/api/types/RefreshedFile.d.ts +9 -0
- package/dist/cjs/api/types/RefreshedFile.js +5 -0
- package/dist/cjs/api/types/{Rcs.d.ts → RichMessage.d.ts} +1 -1
- package/dist/cjs/api/types/RichMessage.js +5 -0
- package/dist/cjs/api/types/ShortenedUrl.d.ts +1 -1
- package/dist/cjs/api/types/TollFreeCampaignWithExtendedBrandAndStatus.d.ts +0 -1
- package/dist/cjs/api/types/UploadResults.d.ts +1 -1
- package/dist/cjs/api/types/VCardData.d.ts +1 -1
- package/dist/cjs/api/types/WebhookEventEnum.d.ts +1 -0
- package/dist/cjs/api/types/index.d.ts +9 -3
- package/dist/cjs/api/types/index.js +9 -3
- package/dist/cjs/index.d.ts +1 -1
- package/dist/cjs/index.js +2 -2
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/cjs/wrapper/PinnacleClient.d.ts +9 -0
- package/dist/cjs/wrapper/PinnacleClient.js +17 -0
- package/dist/cjs/wrapper/messages/Client.d.ts +13 -0
- package/dist/cjs/wrapper/messages/Client.js +49 -0
- package/dist/cjs/wrapper/tools/Client.d.ts +6 -0
- package/dist/cjs/wrapper/tools/Client.js +12 -0
- package/dist/cjs/wrapper/tools/FileUploader.d.ts +15 -0
- package/dist/cjs/wrapper/tools/FileUploader.js +162 -0
- package/dist/esm/Client.d.mts +5 -2
- package/dist/esm/Client.mjs +8 -3
- package/dist/esm/api/resources/brands/client/Client.d.mts +6 -4
- package/dist/esm/api/resources/brands/client/Client.mjs +15 -9
- package/dist/esm/api/resources/brands/client/requests/BrandsGetRequest.d.mts +1 -1
- package/dist/esm/api/resources/brands/client/requests/UpsertBrandParams.d.mts +3 -3
- package/dist/esm/api/resources/campaigns/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/campaigns/client/Client.mjs +1 -1
- package/dist/esm/api/resources/campaigns/resources/dlc/client/Client.d.mts +9 -9
- package/dist/esm/api/resources/campaigns/resources/dlc/client/Client.mjs +7 -7
- package/dist/esm/api/resources/campaigns/resources/rcs/client/Client.d.mts +5 -3
- package/dist/esm/api/resources/campaigns/resources/rcs/client/Client.mjs +5 -1
- package/dist/esm/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.mts +5 -4
- package/dist/esm/api/resources/campaigns/resources/tollFree/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/campaigns/resources/tollFree/client/Client.mjs +1 -1
- package/dist/esm/api/resources/contacts/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/contacts/client/Client.mjs +7 -7
- package/dist/esm/api/resources/contacts/client/requests/ContactsGetRequest.d.mts +2 -2
- package/dist/esm/api/resources/conversations/client/Client.d.mts +4 -4
- package/dist/esm/api/resources/conversations/client/Client.mjs +2 -5
- package/dist/esm/api/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/index.mjs +2 -0
- package/dist/esm/api/resources/messages/client/Client.d.mts +6 -3
- package/dist/esm/api/resources/messages/client/Client.mjs +10 -1
- package/dist/esm/api/resources/messages/client/requests/ReactMessageParams.d.mts +1 -1
- package/dist/esm/api/resources/messages/resources/mms/client/Client.d.mts +4 -3
- package/dist/esm/api/resources/messages/resources/mms/client/Client.mjs +4 -1
- package/dist/esm/api/resources/messages/resources/rcs/client/Client.d.mts +6 -5
- package/dist/esm/api/resources/messages/resources/rcs/client/Client.mjs +5 -2
- package/dist/esm/api/resources/messages/resources/sms/client/Client.d.mts +4 -3
- package/dist/esm/api/resources/messages/resources/sms/client/Client.mjs +4 -1
- package/dist/esm/api/resources/phoneNumbers/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/phoneNumbers/client/Client.mjs +1 -1
- package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/Client.d.mts +6 -4
- package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/Client.mjs +8 -2
- package/dist/esm/api/resources/phoneNumbers/resources/webhook/client/Client.d.mts +7 -5
- package/dist/esm/api/resources/phoneNumbers/resources/webhook/client/Client.mjs +7 -3
- package/dist/esm/api/resources/rcs/client/Client.d.mts +121 -0
- package/dist/esm/api/resources/rcs/client/Client.mjs +283 -0
- package/dist/esm/api/resources/rcs/client/index.d.mts +2 -0
- package/dist/esm/api/resources/rcs/client/index.mjs +1 -0
- package/dist/esm/api/resources/rcs/client/requests/RcsCapabilitiesQuery.d.mts +13 -0
- package/dist/esm/api/resources/rcs/client/requests/RcsLinkRequest.d.mts +22 -0
- package/dist/esm/api/resources/rcs/client/requests/RcsWhitelistRequest.d.mts +16 -0
- package/dist/esm/api/resources/rcs/client/requests/index.d.mts +3 -0
- package/dist/esm/api/resources/rcs/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/rcs/index.d.mts +1 -0
- package/dist/esm/api/resources/rcs/index.mjs +1 -0
- package/dist/esm/api/resources/status/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/status/client/Client.mjs +1 -1
- package/dist/esm/api/resources/status/resources/get/client/Client.d.mts +5 -5
- package/dist/esm/api/resources/status/resources/get/client/Client.mjs +3 -3
- package/dist/esm/api/resources/tools/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/tools/client/Client.mjs +1 -1
- package/dist/esm/api/resources/tools/resources/contactCard/client/Client.d.mts +5 -5
- package/dist/esm/api/resources/tools/resources/contactCard/client/Client.mjs +3 -3
- package/dist/esm/api/resources/tools/resources/file/client/Client.d.mts +24 -3
- package/dist/esm/api/resources/tools/resources/file/client/Client.mjs +75 -1
- package/dist/esm/api/resources/tools/resources/file/client/requests/RefreshFileParams.d.mts +21 -0
- package/dist/esm/api/resources/tools/resources/file/client/requests/RefreshFileParams.mjs +4 -0
- package/dist/esm/api/resources/tools/resources/file/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/tools/resources/url/client/Client.d.mts +4 -4
- package/dist/esm/api/resources/tools/resources/url/client/Client.mjs +2 -2
- package/dist/esm/api/resources/webhooks/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/webhooks/client/Client.mjs +1 -1
- package/dist/esm/api/types/AdvancedPhoneInformation.d.mts +9 -9
- package/dist/esm/api/types/AttachWebhookParams.d.mts +2 -2
- package/dist/esm/api/types/AutofillDlcCampaignResponse.d.mts +11 -11
- package/dist/esm/api/types/ButtonClicked.d.mts +11 -0
- package/dist/esm/api/types/ButtonClicked.mjs +4 -0
- package/dist/esm/api/types/ButtonClickedData.d.mts +58 -0
- package/dist/esm/api/types/ButtonClickedData.mjs +13 -0
- package/dist/esm/api/types/Conversation.d.mts +3 -3
- package/dist/esm/api/types/ConversationList.d.mts +4 -4
- package/dist/esm/api/types/CreateUrlOptions.d.mts +1 -1
- package/dist/esm/api/types/DlcCampaignStatus.d.mts +2 -2
- package/dist/esm/api/types/DlcCampaignWithExtendedBrandAndStatus.d.mts +13 -10
- package/dist/esm/api/types/EnhancedContactItem.d.mts +1 -1
- package/dist/esm/api/types/ExtendedBrand.d.mts +12 -5
- package/dist/esm/api/types/ExtendedBrandWithVetting.d.mts +2 -2
- package/dist/esm/api/types/ExtendedRcsCampaign.d.mts +13 -12
- package/dist/esm/api/types/Message.d.mts +4 -4
- package/dist/esm/api/types/MessageContent.d.mts +2 -2
- package/dist/esm/api/types/MessageEvent.d.mts +56 -0
- package/dist/esm/api/types/MessageEvent.mjs +10 -0
- package/dist/esm/api/types/ProfileStatusEnum.d.mts +7 -4
- package/dist/esm/api/types/RcsBase.d.mts +2 -0
- package/dist/esm/api/types/RcsButtonCall.d.mts +2 -0
- package/dist/esm/api/types/RcsButtonOpenUrl.d.mts +2 -0
- package/dist/esm/api/types/RcsButtonRequestUserLocation.d.mts +2 -0
- package/dist/esm/api/types/RcsButtonScheduleEvent.d.mts +2 -0
- package/dist/esm/api/types/RcsButtonSendLocation.d.mts +2 -0
- package/dist/esm/api/types/RcsButtonTrigger.d.mts +2 -2
- package/dist/esm/api/types/RcsCampaign.d.mts +4 -4
- package/dist/esm/api/types/RcsCapabilitiesResult.d.mts +8 -0
- package/dist/esm/api/types/RcsCapabilitiesResult.mjs +4 -0
- package/dist/esm/api/types/RcsCapability.d.mts +36 -0
- package/dist/esm/api/types/RcsCapability.mjs +4 -0
- package/dist/esm/api/types/RcsLinkResult.d.mts +13 -0
- package/dist/esm/api/types/RcsLinkResult.mjs +4 -0
- package/dist/esm/api/types/RcsValidateContent.d.mts +1 -0
- package/dist/esm/api/types/RcsWhitelistResponse.d.mts +10 -0
- package/dist/esm/api/types/RcsWhitelistResponse.mjs +4 -0
- package/dist/esm/api/types/RefreshedFile.d.mts +9 -0
- package/dist/esm/api/types/RefreshedFile.mjs +4 -0
- package/dist/esm/api/types/{Rcs.d.mts → RichMessage.d.mts} +1 -1
- package/dist/esm/api/types/RichMessage.mjs +4 -0
- package/dist/esm/api/types/ShortenedUrl.d.mts +1 -1
- package/dist/esm/api/types/TollFreeCampaignWithExtendedBrandAndStatus.d.mts +0 -1
- package/dist/esm/api/types/UploadResults.d.mts +1 -1
- package/dist/esm/api/types/VCardData.d.mts +1 -1
- package/dist/esm/api/types/WebhookEventEnum.d.mts +1 -0
- package/dist/esm/api/types/index.d.mts +9 -3
- package/dist/esm/api/types/index.mjs +9 -3
- package/dist/esm/index.d.mts +1 -1
- package/dist/esm/index.mjs +1 -1
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/dist/esm/wrapper/PinnacleClient.d.mts +9 -0
- package/dist/esm/wrapper/PinnacleClient.mjs +13 -0
- package/dist/esm/wrapper/messages/Client.d.mts +13 -0
- package/dist/esm/wrapper/messages/Client.mjs +45 -0
- package/dist/esm/wrapper/tools/Client.d.mts +6 -0
- package/dist/esm/wrapper/tools/Client.mjs +8 -0
- package/dist/esm/wrapper/tools/FileUploader.d.mts +15 -0
- package/dist/esm/wrapper/tools/FileUploader.mjs +125 -0
- package/package.json +6 -2
- package/reference.md +321 -16
- package/dist/cjs/api/types/ClickAction.d.ts +0 -28
- package/dist/cjs/api/types/InboundButton.d.ts +0 -11
- package/dist/esm/api/types/ClickAction.d.mts +0 -28
- package/dist/esm/api/types/InboundButton.d.mts +0 -11
- /package/dist/cjs/api/{types/ClickAction.js → resources/rcs/client/requests/RcsCapabilitiesQuery.js} +0 -0
- /package/dist/cjs/api/{types/InboundButton.js → resources/rcs/client/requests/RcsLinkRequest.js} +0 -0
- /package/dist/cjs/api/{types/Rcs.js → resources/rcs/client/requests/RcsWhitelistRequest.js} +0 -0
- /package/dist/esm/api/{types/ClickAction.mjs → resources/rcs/client/requests/RcsCapabilitiesQuery.mjs} +0 -0
- /package/dist/esm/api/{types/InboundButton.mjs → resources/rcs/client/requests/RcsLinkRequest.mjs} +0 -0
- /package/dist/esm/api/{types/Rcs.mjs → resources/rcs/client/requests/RcsWhitelistRequest.mjs} +0 -0
|
@@ -9,7 +9,7 @@ export declare namespace Dlc {
|
|
|
9
9
|
environment?: core.Supplier<environments.PinnacleEnvironment | string>;
|
|
10
10
|
/** Specify a custom URL to connect the client to. */
|
|
11
11
|
baseUrl?: core.Supplier<string>;
|
|
12
|
-
apiKey
|
|
12
|
+
apiKey?: core.Supplier<string | undefined>;
|
|
13
13
|
/** Additional headers to include in requests. */
|
|
14
14
|
headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
|
|
15
15
|
}
|
|
@@ -28,7 +28,7 @@ export declare namespace Dlc {
|
|
|
28
28
|
}
|
|
29
29
|
export declare class Dlc {
|
|
30
30
|
protected readonly _options: Dlc.Options;
|
|
31
|
-
constructor(_options
|
|
31
|
+
constructor(_options?: Dlc.Options);
|
|
32
32
|
/**
|
|
33
33
|
* Generate campaign details based off existing campaign and the brand it's connected to.
|
|
34
34
|
*
|
|
@@ -48,9 +48,9 @@ export declare class Dlc {
|
|
|
48
48
|
autofill(request: Pinnacle.AutofillCampaignParams, requestOptions?: Dlc.RequestOptions): core.HttpResponsePromise<Pinnacle.AutofillDlcCampaignResponse>;
|
|
49
49
|
private __autofill;
|
|
50
50
|
/**
|
|
51
|
-
* Retrieve
|
|
51
|
+
* Retrieve 10DLC campaign.
|
|
52
52
|
*
|
|
53
|
-
* @param {number} campaignId - Unique identifier of the
|
|
53
|
+
* @param {number} campaignId - Unique identifier of the 10DLC campaign.
|
|
54
54
|
* @param {Dlc.RequestOptions} requestOptions - Request-specific configuration.
|
|
55
55
|
*
|
|
56
56
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -64,9 +64,9 @@ export declare class Dlc {
|
|
|
64
64
|
get(campaignId: number, requestOptions?: Dlc.RequestOptions): core.HttpResponsePromise<Pinnacle.DlcCampaignWithExtendedBrandAndStatus>;
|
|
65
65
|
private __get;
|
|
66
66
|
/**
|
|
67
|
-
* Submit your
|
|
67
|
+
* Submit your 10DLC campaign for approval and activation with carriers.
|
|
68
68
|
*
|
|
69
|
-
* @param {number} campaignId - Unique identifier of the
|
|
69
|
+
* @param {number} campaignId - Unique identifier of the 10DLC campaign to submit.
|
|
70
70
|
* @param {Dlc.RequestOptions} requestOptions - Request-specific configuration.
|
|
71
71
|
*
|
|
72
72
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -80,7 +80,7 @@ export declare class Dlc {
|
|
|
80
80
|
submit(campaignId: number, requestOptions?: Dlc.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignSubmissionResult>;
|
|
81
81
|
private __submit;
|
|
82
82
|
/**
|
|
83
|
-
* Create a new
|
|
83
|
+
* Create a new 10DLC campaign or updates an existing one. <br>
|
|
84
84
|
*
|
|
85
85
|
* Omit campaignId to create a campaign.
|
|
86
86
|
*
|
|
@@ -135,7 +135,7 @@ export declare class Dlc {
|
|
|
135
135
|
upsert(request?: Pinnacle.campaigns.UpsertDlcCampaignParams, requestOptions?: Dlc.RequestOptions): core.HttpResponsePromise<Pinnacle.DlcCampaignWithExtendedBrandAndStatus>;
|
|
136
136
|
private __upsert;
|
|
137
137
|
/**
|
|
138
|
-
* Validate your
|
|
138
|
+
* Validate your 10DLC campaign configuration against carrier requirements and compliance rules.
|
|
139
139
|
*
|
|
140
140
|
* @param {Pinnacle.ValidateCampaignParams} request
|
|
141
141
|
* @param {Dlc.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -153,6 +153,6 @@ export declare class Dlc {
|
|
|
153
153
|
validate(request: Pinnacle.ValidateCampaignParams, requestOptions?: Dlc.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignValidationResult>;
|
|
154
154
|
private __validate;
|
|
155
155
|
protected _getCustomAuthorizationHeaders(): Promise<{
|
|
156
|
-
"PINNACLE-API-KEY": string;
|
|
156
|
+
"PINNACLE-API-KEY": string | undefined;
|
|
157
157
|
}>;
|
|
158
158
|
}
|
|
@@ -16,7 +16,7 @@ import * as Pinnacle from "../../../../../index.mjs";
|
|
|
16
16
|
import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../../../core/headers.mjs";
|
|
17
17
|
import * as errors from "../../../../../../errors/index.mjs";
|
|
18
18
|
export class Dlc {
|
|
19
|
-
constructor(_options) {
|
|
19
|
+
constructor(_options = {}) {
|
|
20
20
|
this._options = _options;
|
|
21
21
|
}
|
|
22
22
|
/**
|
|
@@ -91,9 +91,9 @@ export class Dlc {
|
|
|
91
91
|
});
|
|
92
92
|
}
|
|
93
93
|
/**
|
|
94
|
-
* Retrieve
|
|
94
|
+
* Retrieve 10DLC campaign.
|
|
95
95
|
*
|
|
96
|
-
* @param {number} campaignId - Unique identifier of the
|
|
96
|
+
* @param {number} campaignId - Unique identifier of the 10DLC campaign.
|
|
97
97
|
* @param {Dlc.RequestOptions} requestOptions - Request-specific configuration.
|
|
98
98
|
*
|
|
99
99
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -162,9 +162,9 @@ export class Dlc {
|
|
|
162
162
|
});
|
|
163
163
|
}
|
|
164
164
|
/**
|
|
165
|
-
* Submit your
|
|
165
|
+
* Submit your 10DLC campaign for approval and activation with carriers.
|
|
166
166
|
*
|
|
167
|
-
* @param {number} campaignId - Unique identifier of the
|
|
167
|
+
* @param {number} campaignId - Unique identifier of the 10DLC campaign to submit.
|
|
168
168
|
* @param {Dlc.RequestOptions} requestOptions - Request-specific configuration.
|
|
169
169
|
*
|
|
170
170
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -230,7 +230,7 @@ export class Dlc {
|
|
|
230
230
|
});
|
|
231
231
|
}
|
|
232
232
|
/**
|
|
233
|
-
* Create a new
|
|
233
|
+
* Create a new 10DLC campaign or updates an existing one. <br>
|
|
234
234
|
*
|
|
235
235
|
* Omit campaignId to create a campaign.
|
|
236
236
|
*
|
|
@@ -343,7 +343,7 @@ export class Dlc {
|
|
|
343
343
|
});
|
|
344
344
|
}
|
|
345
345
|
/**
|
|
346
|
-
* Validate your
|
|
346
|
+
* Validate your 10DLC campaign configuration against carrier requirements and compliance rules.
|
|
347
347
|
*
|
|
348
348
|
* @param {Pinnacle.ValidateCampaignParams} request
|
|
349
349
|
* @param {Dlc.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -9,7 +9,7 @@ export declare namespace Rcs {
|
|
|
9
9
|
environment?: core.Supplier<environments.PinnacleEnvironment | string>;
|
|
10
10
|
/** Specify a custom URL to connect the client to. */
|
|
11
11
|
baseUrl?: core.Supplier<string>;
|
|
12
|
-
apiKey
|
|
12
|
+
apiKey?: core.Supplier<string | undefined>;
|
|
13
13
|
/** Additional headers to include in requests. */
|
|
14
14
|
headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
|
|
15
15
|
}
|
|
@@ -28,7 +28,7 @@ export declare namespace Rcs {
|
|
|
28
28
|
}
|
|
29
29
|
export declare class Rcs {
|
|
30
30
|
protected readonly _options: Rcs.Options;
|
|
31
|
-
constructor(_options
|
|
31
|
+
constructor(_options?: Rcs.Options);
|
|
32
32
|
/**
|
|
33
33
|
* Generate campaign details based off existing campaign and the brand it's connected to.
|
|
34
34
|
*
|
|
@@ -71,6 +71,7 @@ export declare class Rcs {
|
|
|
71
71
|
*
|
|
72
72
|
* @throws {@link Pinnacle.BadRequestError}
|
|
73
73
|
* @throws {@link Pinnacle.UnauthorizedError}
|
|
74
|
+
* @throws {@link Pinnacle.PaymentRequiredError}
|
|
74
75
|
* @throws {@link Pinnacle.NotFoundError}
|
|
75
76
|
* @throws {@link Pinnacle.InternalServerError}
|
|
76
77
|
*
|
|
@@ -113,6 +114,7 @@ export declare class Rcs {
|
|
|
113
114
|
* url: "https://www.trypinnacle.app/"
|
|
114
115
|
* }]
|
|
115
116
|
* },
|
|
117
|
+
* brandVerificationUrl: "https://www.pinnacle.sh/articles-of-incorporation.pdf",
|
|
116
118
|
* brand: 2,
|
|
117
119
|
* 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."],
|
|
118
120
|
* links: {
|
|
@@ -154,6 +156,6 @@ export declare class Rcs {
|
|
|
154
156
|
validate(request: Pinnacle.ValidateCampaignParams, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignValidationResult>;
|
|
155
157
|
private __validate;
|
|
156
158
|
protected _getCustomAuthorizationHeaders(): Promise<{
|
|
157
|
-
"PINNACLE-API-KEY": string;
|
|
159
|
+
"PINNACLE-API-KEY": string | undefined;
|
|
158
160
|
}>;
|
|
159
161
|
}
|
|
@@ -16,7 +16,7 @@ import * as Pinnacle from "../../../../../index.mjs";
|
|
|
16
16
|
import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../../../core/headers.mjs";
|
|
17
17
|
import * as errors from "../../../../../../errors/index.mjs";
|
|
18
18
|
export class Rcs {
|
|
19
|
-
constructor(_options) {
|
|
19
|
+
constructor(_options = {}) {
|
|
20
20
|
this._options = _options;
|
|
21
21
|
}
|
|
22
22
|
/**
|
|
@@ -169,6 +169,7 @@ export class Rcs {
|
|
|
169
169
|
*
|
|
170
170
|
* @throws {@link Pinnacle.BadRequestError}
|
|
171
171
|
* @throws {@link Pinnacle.UnauthorizedError}
|
|
172
|
+
* @throws {@link Pinnacle.PaymentRequiredError}
|
|
172
173
|
* @throws {@link Pinnacle.NotFoundError}
|
|
173
174
|
* @throws {@link Pinnacle.InternalServerError}
|
|
174
175
|
*
|
|
@@ -200,6 +201,8 @@ export class Rcs {
|
|
|
200
201
|
throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
|
|
201
202
|
case 401:
|
|
202
203
|
throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
204
|
+
case 402:
|
|
205
|
+
throw new Pinnacle.PaymentRequiredError(_response.error.body, _response.rawResponse);
|
|
203
206
|
case 404:
|
|
204
207
|
throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
|
|
205
208
|
case 500:
|
|
@@ -263,6 +266,7 @@ export class Rcs {
|
|
|
263
266
|
* url: "https://www.trypinnacle.app/"
|
|
264
267
|
* }]
|
|
265
268
|
* },
|
|
269
|
+
* brandVerificationUrl: "https://www.pinnacle.sh/articles-of-incorporation.pdf",
|
|
266
270
|
* brand: 2,
|
|
267
271
|
* 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."],
|
|
268
272
|
* links: {
|
package/dist/esm/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.mts
CHANGED
|
@@ -24,6 +24,7 @@ import * as Pinnacle from "../../../../../../index.mjs";
|
|
|
24
24
|
* url: "https://www.trypinnacle.app/"
|
|
25
25
|
* }]
|
|
26
26
|
* },
|
|
27
|
+
* brandVerificationUrl: "https://www.pinnacle.sh/articles-of-incorporation.pdf",
|
|
27
28
|
* brand: 2,
|
|
28
29
|
* 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."],
|
|
29
30
|
* links: {
|
|
@@ -47,6 +48,8 @@ import * as Pinnacle from "../../../../../../index.mjs";
|
|
|
47
48
|
export interface UpsertRcsCampaignParams {
|
|
48
49
|
/** Create an agent for the campaign. */
|
|
49
50
|
agent?: UpsertRcsCampaignParams.Agent;
|
|
51
|
+
/** Link to document verifying the brand's name. This may be the certificate of incorporation, business license, or other relevant document. You can typically find this on the Secretary of State website. */
|
|
52
|
+
brandVerificationUrl?: string;
|
|
50
53
|
/** Unique identifier for the brand. */
|
|
51
54
|
brand?: number;
|
|
52
55
|
/** Unique identifier for the campaign. */
|
|
@@ -67,8 +70,6 @@ export declare namespace UpsertRcsCampaignParams {
|
|
|
67
70
|
* Create an agent for the campaign.
|
|
68
71
|
*/
|
|
69
72
|
interface Agent {
|
|
70
|
-
/** Link to document verifying the brand's name. This may be the certificate of incorporation, business license, or other relevant document. You can typically find this on the Secretary of State website. */
|
|
71
|
-
brandVerificationUrl?: string;
|
|
72
73
|
/**
|
|
73
74
|
* Color of the agent's buttons. <br>
|
|
74
75
|
*
|
|
@@ -79,9 +80,9 @@ export declare namespace UpsertRcsCampaignParams {
|
|
|
79
80
|
description?: string;
|
|
80
81
|
/** List of emails (1-3 required). */
|
|
81
82
|
emails?: Agent.Emails.Item[];
|
|
82
|
-
/** Link to the agent's hero. */
|
|
83
|
+
/** Link to the agent's hero. Hero must be an image file with dimensions 1440x448px. */
|
|
83
84
|
heroUrl?: string;
|
|
84
|
-
/** Link to the agent's icon. */
|
|
85
|
+
/** Link to the agent's icon. Icon must be an image file with dimensions 224x224px. */
|
|
85
86
|
iconUrl?: string;
|
|
86
87
|
/** Name of the agent. */
|
|
87
88
|
name?: string;
|
|
@@ -9,7 +9,7 @@ export declare namespace TollFree {
|
|
|
9
9
|
environment?: core.Supplier<environments.PinnacleEnvironment | string>;
|
|
10
10
|
/** Specify a custom URL to connect the client to. */
|
|
11
11
|
baseUrl?: core.Supplier<string>;
|
|
12
|
-
apiKey
|
|
12
|
+
apiKey?: core.Supplier<string | undefined>;
|
|
13
13
|
/** Additional headers to include in requests. */
|
|
14
14
|
headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
|
|
15
15
|
}
|
|
@@ -28,7 +28,7 @@ export declare namespace TollFree {
|
|
|
28
28
|
}
|
|
29
29
|
export declare class TollFree {
|
|
30
30
|
protected readonly _options: TollFree.Options;
|
|
31
|
-
constructor(_options
|
|
31
|
+
constructor(_options?: TollFree.Options);
|
|
32
32
|
/**
|
|
33
33
|
* Generate campaign details based off existing campaign and the brand it's connected to.
|
|
34
34
|
*
|
|
@@ -131,6 +131,6 @@ export declare class TollFree {
|
|
|
131
131
|
validate(request: Pinnacle.ValidateCampaignParams, requestOptions?: TollFree.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignValidationResult>;
|
|
132
132
|
private __validate;
|
|
133
133
|
protected _getCustomAuthorizationHeaders(): Promise<{
|
|
134
|
-
"PINNACLE-API-KEY": string;
|
|
134
|
+
"PINNACLE-API-KEY": string | undefined;
|
|
135
135
|
}>;
|
|
136
136
|
}
|
|
@@ -16,7 +16,7 @@ import * as Pinnacle from "../../../../../index.mjs";
|
|
|
16
16
|
import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../../../core/headers.mjs";
|
|
17
17
|
import * as errors from "../../../../../../errors/index.mjs";
|
|
18
18
|
export class TollFree {
|
|
19
|
-
constructor(_options) {
|
|
19
|
+
constructor(_options = {}) {
|
|
20
20
|
this._options = _options;
|
|
21
21
|
}
|
|
22
22
|
/**
|
|
@@ -9,7 +9,7 @@ export declare namespace Contacts {
|
|
|
9
9
|
environment?: core.Supplier<environments.PinnacleEnvironment | string>;
|
|
10
10
|
/** Specify a custom URL to connect the client to. */
|
|
11
11
|
baseUrl?: core.Supplier<string>;
|
|
12
|
-
apiKey
|
|
12
|
+
apiKey?: core.Supplier<string | undefined>;
|
|
13
13
|
/** Additional headers to include in requests. */
|
|
14
14
|
headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
|
|
15
15
|
}
|
|
@@ -28,7 +28,7 @@ export declare namespace Contacts {
|
|
|
28
28
|
}
|
|
29
29
|
export declare class Contacts {
|
|
30
30
|
protected readonly _options: Contacts.Options;
|
|
31
|
-
constructor(_options
|
|
31
|
+
constructor(_options?: Contacts.Options);
|
|
32
32
|
/**
|
|
33
33
|
* Retrieve contact information for a given number.
|
|
34
34
|
*
|
|
@@ -85,6 +85,6 @@ export declare class Contacts {
|
|
|
85
85
|
update(request: Pinnacle.UpdateContactParams, requestOptions?: Contacts.RequestOptions): core.HttpResponsePromise<Pinnacle.UpdatedContactId>;
|
|
86
86
|
private __update;
|
|
87
87
|
protected _getCustomAuthorizationHeaders(): Promise<{
|
|
88
|
-
"PINNACLE-API-KEY": string;
|
|
88
|
+
"PINNACLE-API-KEY": string | undefined;
|
|
89
89
|
}>;
|
|
90
90
|
}
|
|
@@ -16,7 +16,7 @@ import * as Pinnacle from "../../../index.mjs";
|
|
|
16
16
|
import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../core/headers.mjs";
|
|
17
17
|
import * as errors from "../../../../errors/index.mjs";
|
|
18
18
|
export class Contacts {
|
|
19
|
-
constructor(_options) {
|
|
19
|
+
constructor(_options = {}) {
|
|
20
20
|
this._options = _options;
|
|
21
21
|
}
|
|
22
22
|
/**
|
|
@@ -38,18 +38,18 @@ export class Contacts {
|
|
|
38
38
|
}
|
|
39
39
|
__get() {
|
|
40
40
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
41
|
-
var _a, _b, _c
|
|
41
|
+
var _a, _b, _c;
|
|
42
42
|
const { id, phoneNumber } = request;
|
|
43
43
|
const _queryParams = {};
|
|
44
|
-
if (id
|
|
45
|
-
_queryParams["id"] =
|
|
44
|
+
if (id != null) {
|
|
45
|
+
_queryParams["id"] = id.toString();
|
|
46
46
|
}
|
|
47
|
-
if (phoneNumber
|
|
47
|
+
if (phoneNumber != null) {
|
|
48
48
|
_queryParams["phoneNumber"] = phoneNumber;
|
|
49
49
|
}
|
|
50
|
-
let _headers = mergeHeaders((
|
|
50
|
+
let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
51
51
|
const _response = yield core.fetcher({
|
|
52
|
-
url: core.url.join((
|
|
52
|
+
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PinnacleEnvironment.Default, "contacts"),
|
|
53
53
|
method: "GET",
|
|
54
54
|
headers: _headers,
|
|
55
55
|
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
@@ -11,7 +11,7 @@ export interface ContactsGetRequest {
|
|
|
11
11
|
*
|
|
12
12
|
* Either this parameter or `phoneNumber` must be provided, but not both.
|
|
13
13
|
*/
|
|
14
|
-
id?: number
|
|
14
|
+
id?: number;
|
|
15
15
|
/** Phone number you want to look up contact information for, provided in URL-encoded E.164 format with %2B prefix instead of +. */
|
|
16
|
-
phoneNumber?: string
|
|
16
|
+
phoneNumber?: string;
|
|
17
17
|
}
|
|
@@ -9,7 +9,7 @@ export declare namespace Conversations {
|
|
|
9
9
|
environment?: core.Supplier<environments.PinnacleEnvironment | string>;
|
|
10
10
|
/** Specify a custom URL to connect the client to. */
|
|
11
11
|
baseUrl?: core.Supplier<string>;
|
|
12
|
-
apiKey
|
|
12
|
+
apiKey?: core.Supplier<string | undefined>;
|
|
13
13
|
/** Additional headers to include in requests. */
|
|
14
14
|
headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
|
|
15
15
|
}
|
|
@@ -28,7 +28,7 @@ export declare namespace Conversations {
|
|
|
28
28
|
}
|
|
29
29
|
export declare class Conversations {
|
|
30
30
|
protected readonly _options: Conversations.Options;
|
|
31
|
-
constructor(_options
|
|
31
|
+
constructor(_options?: Conversations.Options);
|
|
32
32
|
/**
|
|
33
33
|
* Fetch a specific conversation using either its unique identifier or by matching sender and recipient details.
|
|
34
34
|
*
|
|
@@ -44,7 +44,7 @@ export declare class Conversations {
|
|
|
44
44
|
* id: 1
|
|
45
45
|
* })
|
|
46
46
|
*/
|
|
47
|
-
get(request: Pinnacle.GetConversationParams, requestOptions?: Conversations.RequestOptions): core.HttpResponsePromise<
|
|
47
|
+
get(request: Pinnacle.GetConversationParams, requestOptions?: Conversations.RequestOptions): core.HttpResponsePromise<Pinnacle.Conversation | null>;
|
|
48
48
|
private __get;
|
|
49
49
|
/**
|
|
50
50
|
* Retrieves conversations by page with optional filtering based off provided parameters.
|
|
@@ -88,6 +88,6 @@ export declare class Conversations {
|
|
|
88
88
|
update(request: Pinnacle.UpdateConversationParams, requestOptions?: Conversations.RequestOptions): core.HttpResponsePromise<Pinnacle.SuccessfulConversationUpdate>;
|
|
89
89
|
private __update;
|
|
90
90
|
protected _getCustomAuthorizationHeaders(): Promise<{
|
|
91
|
-
"PINNACLE-API-KEY": string;
|
|
91
|
+
"PINNACLE-API-KEY": string | undefined;
|
|
92
92
|
}>;
|
|
93
93
|
}
|
|
@@ -16,7 +16,7 @@ import * as Pinnacle from "../../../index.mjs";
|
|
|
16
16
|
import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../core/headers.mjs";
|
|
17
17
|
import * as errors from "../../../../errors/index.mjs";
|
|
18
18
|
export class Conversations {
|
|
19
|
-
constructor(_options) {
|
|
19
|
+
constructor(_options = {}) {
|
|
20
20
|
this._options = _options;
|
|
21
21
|
}
|
|
22
22
|
/**
|
|
@@ -54,10 +54,7 @@ export class Conversations {
|
|
|
54
54
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
55
55
|
});
|
|
56
56
|
if (_response.ok) {
|
|
57
|
-
return {
|
|
58
|
-
data: _response.body,
|
|
59
|
-
rawResponse: _response.rawResponse,
|
|
60
|
-
};
|
|
57
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
61
58
|
}
|
|
62
59
|
if (_response.error.reason === "status-code") {
|
|
63
60
|
switch (_response.error.statusCode) {
|
|
@@ -5,6 +5,7 @@ export * as messages from "./messages/index.mjs";
|
|
|
5
5
|
export * as brands from "./brands/index.mjs";
|
|
6
6
|
export * as contacts from "./contacts/index.mjs";
|
|
7
7
|
export * as conversations from "./conversations/index.mjs";
|
|
8
|
+
export * as rcs from "./rcs/index.mjs";
|
|
8
9
|
export * as webhooks from "./webhooks/index.mjs";
|
|
9
10
|
export * as status from "./status/index.mjs";
|
|
10
11
|
export * as tools from "./tools/index.mjs";
|
|
@@ -13,4 +14,5 @@ export * from "./contacts/client/requests/index.mjs";
|
|
|
13
14
|
export * from "./conversations/client/requests/index.mjs";
|
|
14
15
|
export * from "./messages/client/requests/index.mjs";
|
|
15
16
|
export * from "./phoneNumbers/client/requests/index.mjs";
|
|
17
|
+
export * from "./rcs/client/requests/index.mjs";
|
|
16
18
|
export * from "./webhooks/client/requests/index.mjs";
|
|
@@ -5,6 +5,7 @@ export * as messages from "./messages/index.mjs";
|
|
|
5
5
|
export * as brands from "./brands/index.mjs";
|
|
6
6
|
export * as contacts from "./contacts/index.mjs";
|
|
7
7
|
export * as conversations from "./conversations/index.mjs";
|
|
8
|
+
export * as rcs from "./rcs/index.mjs";
|
|
8
9
|
export * as webhooks from "./webhooks/index.mjs";
|
|
9
10
|
export * as status from "./status/index.mjs";
|
|
10
11
|
export * as tools from "./tools/index.mjs";
|
|
@@ -13,4 +14,5 @@ export * from "./contacts/client/requests/index.mjs";
|
|
|
13
14
|
export * from "./conversations/client/requests/index.mjs";
|
|
14
15
|
export * from "./messages/client/requests/index.mjs";
|
|
15
16
|
export * from "./phoneNumbers/client/requests/index.mjs";
|
|
17
|
+
export * from "./rcs/client/requests/index.mjs";
|
|
16
18
|
export * from "./webhooks/client/requests/index.mjs";
|
|
@@ -12,7 +12,7 @@ export declare namespace Messages {
|
|
|
12
12
|
environment?: core.Supplier<environments.PinnacleEnvironment | string>;
|
|
13
13
|
/** Specify a custom URL to connect the client to. */
|
|
14
14
|
baseUrl?: core.Supplier<string>;
|
|
15
|
-
apiKey
|
|
15
|
+
apiKey?: core.Supplier<string | undefined>;
|
|
16
16
|
/** Additional headers to include in requests. */
|
|
17
17
|
headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
|
|
18
18
|
}
|
|
@@ -34,7 +34,7 @@ export declare class Messages {
|
|
|
34
34
|
protected _sms: Sms | undefined;
|
|
35
35
|
protected _mms: Mms | undefined;
|
|
36
36
|
protected _rcs: Rcs | undefined;
|
|
37
|
-
constructor(_options
|
|
37
|
+
constructor(_options?: Messages.Options);
|
|
38
38
|
get sms(): Sms;
|
|
39
39
|
get mms(): Mms;
|
|
40
40
|
get rcs(): Rcs;
|
|
@@ -62,7 +62,10 @@ export declare class Messages {
|
|
|
62
62
|
*
|
|
63
63
|
* @throws {@link Pinnacle.BadRequestError}
|
|
64
64
|
* @throws {@link Pinnacle.UnauthorizedError}
|
|
65
|
+
* @throws {@link Pinnacle.PaymentRequiredError}
|
|
65
66
|
* @throws {@link Pinnacle.NotFoundError}
|
|
67
|
+
* @throws {@link Pinnacle.InternalServerError}
|
|
68
|
+
* @throws {@link Pinnacle.NotImplementedError}
|
|
66
69
|
*
|
|
67
70
|
* @example
|
|
68
71
|
* await client.messages.react({
|
|
@@ -76,6 +79,6 @@ export declare class Messages {
|
|
|
76
79
|
react(request: Pinnacle.ReactMessageParams, requestOptions?: Messages.RequestOptions): core.HttpResponsePromise<Pinnacle.ReactionResult>;
|
|
77
80
|
private __react;
|
|
78
81
|
protected _getCustomAuthorizationHeaders(): Promise<{
|
|
79
|
-
"PINNACLE-API-KEY": string;
|
|
82
|
+
"PINNACLE-API-KEY": string | undefined;
|
|
80
83
|
}>;
|
|
81
84
|
}
|
|
@@ -19,7 +19,7 @@ import { Sms } from "../resources/sms/client/Client.mjs";
|
|
|
19
19
|
import { Mms } from "../resources/mms/client/Client.mjs";
|
|
20
20
|
import { Rcs } from "../resources/rcs/client/Client.mjs";
|
|
21
21
|
export class Messages {
|
|
22
|
-
constructor(_options) {
|
|
22
|
+
constructor(_options = {}) {
|
|
23
23
|
this._options = _options;
|
|
24
24
|
}
|
|
25
25
|
get sms() {
|
|
@@ -110,7 +110,10 @@ export class Messages {
|
|
|
110
110
|
*
|
|
111
111
|
* @throws {@link Pinnacle.BadRequestError}
|
|
112
112
|
* @throws {@link Pinnacle.UnauthorizedError}
|
|
113
|
+
* @throws {@link Pinnacle.PaymentRequiredError}
|
|
113
114
|
* @throws {@link Pinnacle.NotFoundError}
|
|
115
|
+
* @throws {@link Pinnacle.InternalServerError}
|
|
116
|
+
* @throws {@link Pinnacle.NotImplementedError}
|
|
114
117
|
*
|
|
115
118
|
* @example
|
|
116
119
|
* await client.messages.react({
|
|
@@ -149,8 +152,14 @@ export class Messages {
|
|
|
149
152
|
throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
|
|
150
153
|
case 401:
|
|
151
154
|
throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
155
|
+
case 402:
|
|
156
|
+
throw new Pinnacle.PaymentRequiredError(_response.error.body, _response.rawResponse);
|
|
152
157
|
case 404:
|
|
153
158
|
throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
|
|
159
|
+
case 500:
|
|
160
|
+
throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
|
|
161
|
+
case 501:
|
|
162
|
+
throw new Pinnacle.NotImplementedError(_response.error.body, _response.rawResponse);
|
|
154
163
|
default:
|
|
155
164
|
throw new errors.PinnacleError({
|
|
156
165
|
statusCode: _response.error.statusCode,
|
|
@@ -9,7 +9,7 @@ export declare namespace Mms {
|
|
|
9
9
|
environment?: core.Supplier<environments.PinnacleEnvironment | string>;
|
|
10
10
|
/** Specify a custom URL to connect the client to. */
|
|
11
11
|
baseUrl?: core.Supplier<string>;
|
|
12
|
-
apiKey
|
|
12
|
+
apiKey?: core.Supplier<string | undefined>;
|
|
13
13
|
/** Additional headers to include in requests. */
|
|
14
14
|
headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
|
|
15
15
|
}
|
|
@@ -28,7 +28,7 @@ export declare namespace Mms {
|
|
|
28
28
|
}
|
|
29
29
|
export declare class Mms {
|
|
30
30
|
protected readonly _options: Mms.Options;
|
|
31
|
-
constructor(_options
|
|
31
|
+
constructor(_options?: Mms.Options);
|
|
32
32
|
/**
|
|
33
33
|
* Send a MMS immediately or schedule it for future delivery.
|
|
34
34
|
*
|
|
@@ -40,6 +40,7 @@ export declare class Mms {
|
|
|
40
40
|
* @throws {@link Pinnacle.PaymentRequiredError}
|
|
41
41
|
* @throws {@link Pinnacle.NotFoundError}
|
|
42
42
|
* @throws {@link Pinnacle.InternalServerError}
|
|
43
|
+
* @throws {@link Pinnacle.NotImplementedError}
|
|
43
44
|
*
|
|
44
45
|
* @example
|
|
45
46
|
* await client.messages.mms.send({
|
|
@@ -74,6 +75,6 @@ export declare class Mms {
|
|
|
74
75
|
validate(request: Pinnacle.MmsContent, requestOptions?: Mms.RequestOptions): core.HttpResponsePromise<Pinnacle.MmsValidationResult>;
|
|
75
76
|
private __validate;
|
|
76
77
|
protected _getCustomAuthorizationHeaders(): Promise<{
|
|
77
|
-
"PINNACLE-API-KEY": string;
|
|
78
|
+
"PINNACLE-API-KEY": string | undefined;
|
|
78
79
|
}>;
|
|
79
80
|
}
|
|
@@ -16,7 +16,7 @@ import * as Pinnacle from "../../../../../index.mjs";
|
|
|
16
16
|
import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../../../core/headers.mjs";
|
|
17
17
|
import * as errors from "../../../../../../errors/index.mjs";
|
|
18
18
|
export class Mms {
|
|
19
|
-
constructor(_options) {
|
|
19
|
+
constructor(_options = {}) {
|
|
20
20
|
this._options = _options;
|
|
21
21
|
}
|
|
22
22
|
/**
|
|
@@ -30,6 +30,7 @@ export class Mms {
|
|
|
30
30
|
* @throws {@link Pinnacle.PaymentRequiredError}
|
|
31
31
|
* @throws {@link Pinnacle.NotFoundError}
|
|
32
32
|
* @throws {@link Pinnacle.InternalServerError}
|
|
33
|
+
* @throws {@link Pinnacle.NotImplementedError}
|
|
33
34
|
*
|
|
34
35
|
* @example
|
|
35
36
|
* await client.messages.mms.send({
|
|
@@ -77,6 +78,8 @@ export class Mms {
|
|
|
77
78
|
throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
|
|
78
79
|
case 500:
|
|
79
80
|
throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
|
|
81
|
+
case 501:
|
|
82
|
+
throw new Pinnacle.NotImplementedError(_response.error.body, _response.rawResponse);
|
|
80
83
|
default:
|
|
81
84
|
throw new errors.PinnacleError({
|
|
82
85
|
statusCode: _response.error.statusCode,
|
|
@@ -9,7 +9,7 @@ export declare namespace Rcs {
|
|
|
9
9
|
environment?: core.Supplier<environments.PinnacleEnvironment | string>;
|
|
10
10
|
/** Specify a custom URL to connect the client to. */
|
|
11
11
|
baseUrl?: core.Supplier<string>;
|
|
12
|
-
apiKey
|
|
12
|
+
apiKey?: core.Supplier<string | undefined>;
|
|
13
13
|
/** Additional headers to include in requests. */
|
|
14
14
|
headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
|
|
15
15
|
}
|
|
@@ -28,13 +28,13 @@ export declare namespace Rcs {
|
|
|
28
28
|
}
|
|
29
29
|
export declare class Rcs {
|
|
30
30
|
protected readonly _options: Rcs.Options;
|
|
31
|
-
constructor(_options
|
|
31
|
+
constructor(_options?: Rcs.Options);
|
|
32
32
|
/**
|
|
33
33
|
* Send a RCS message immediately or schedule it for future delivery. <br>
|
|
34
34
|
*
|
|
35
35
|
* Requires an active RCS agent and recipient devices that support RCS Business Messaging.
|
|
36
36
|
*
|
|
37
|
-
* @param {Pinnacle.
|
|
37
|
+
* @param {Pinnacle.RichMessage} request
|
|
38
38
|
* @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
|
|
39
39
|
*
|
|
40
40
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -42,6 +42,7 @@ export declare class Rcs {
|
|
|
42
42
|
* @throws {@link Pinnacle.PaymentRequiredError}
|
|
43
43
|
* @throws {@link Pinnacle.NotFoundError}
|
|
44
44
|
* @throws {@link Pinnacle.InternalServerError}
|
|
45
|
+
* @throws {@link Pinnacle.NotImplementedError}
|
|
45
46
|
*
|
|
46
47
|
* @example
|
|
47
48
|
* await client.messages.rcs.send({
|
|
@@ -55,7 +56,7 @@ export declare class Rcs {
|
|
|
55
56
|
* to: "to"
|
|
56
57
|
* })
|
|
57
58
|
*/
|
|
58
|
-
send(request: Pinnacle.
|
|
59
|
+
send(request: Pinnacle.RichMessage, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.messages.RcsSendResponse>;
|
|
59
60
|
private __send;
|
|
60
61
|
/**
|
|
61
62
|
* Validate RCS message content without sending it.
|
|
@@ -80,6 +81,6 @@ export declare class Rcs {
|
|
|
80
81
|
validate(request: Pinnacle.RcsValidateContent, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.RcsValidationResult>;
|
|
81
82
|
private __validate;
|
|
82
83
|
protected _getCustomAuthorizationHeaders(): Promise<{
|
|
83
|
-
"PINNACLE-API-KEY": string;
|
|
84
|
+
"PINNACLE-API-KEY": string | undefined;
|
|
84
85
|
}>;
|
|
85
86
|
}
|