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
package/dist/cjs/Client.d.ts
CHANGED
|
@@ -8,6 +8,7 @@ import { Contacts } from "./api/resources/contacts/client/Client.js";
|
|
|
8
8
|
import { Conversations } from "./api/resources/conversations/client/Client.js";
|
|
9
9
|
import { Messages } from "./api/resources/messages/client/Client.js";
|
|
10
10
|
import { PhoneNumbers } from "./api/resources/phoneNumbers/client/Client.js";
|
|
11
|
+
import { Rcs } from "./api/resources/rcs/client/Client.js";
|
|
11
12
|
import { Webhooks } from "./api/resources/webhooks/client/Client.js";
|
|
12
13
|
import { Campaigns } from "./api/resources/campaigns/client/Client.js";
|
|
13
14
|
import { Status } from "./api/resources/status/client/Client.js";
|
|
@@ -17,7 +18,7 @@ export declare namespace PinnacleClient {
|
|
|
17
18
|
environment?: core.Supplier<environments.PinnacleEnvironment | string>;
|
|
18
19
|
/** Specify a custom URL to connect the client to. */
|
|
19
20
|
baseUrl?: core.Supplier<string>;
|
|
20
|
-
apiKey
|
|
21
|
+
apiKey?: core.Supplier<string | undefined>;
|
|
21
22
|
/** Additional headers to include in requests. */
|
|
22
23
|
headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
|
|
23
24
|
}
|
|
@@ -41,16 +42,18 @@ export declare class PinnacleClient {
|
|
|
41
42
|
protected _conversations: Conversations | undefined;
|
|
42
43
|
protected _messages: Messages | undefined;
|
|
43
44
|
protected _phoneNumbers: PhoneNumbers | undefined;
|
|
45
|
+
protected _rcs: Rcs | undefined;
|
|
44
46
|
protected _webhooks: Webhooks | undefined;
|
|
45
47
|
protected _campaigns: Campaigns | undefined;
|
|
46
48
|
protected _status: Status | undefined;
|
|
47
49
|
protected _tools: Tools | undefined;
|
|
48
|
-
constructor(_options
|
|
50
|
+
constructor(_options?: PinnacleClient.Options);
|
|
49
51
|
get brands(): Brands;
|
|
50
52
|
get contacts(): Contacts;
|
|
51
53
|
get conversations(): Conversations;
|
|
52
54
|
get messages(): Messages;
|
|
53
55
|
get phoneNumbers(): PhoneNumbers;
|
|
56
|
+
get rcs(): Rcs;
|
|
54
57
|
get webhooks(): Webhooks;
|
|
55
58
|
get campaigns(): Campaigns;
|
|
56
59
|
get status(): Status;
|
package/dist/cjs/Client.js
CHANGED
|
@@ -44,17 +44,18 @@ const Client_js_2 = require("./api/resources/contacts/client/Client.js");
|
|
|
44
44
|
const Client_js_3 = require("./api/resources/conversations/client/Client.js");
|
|
45
45
|
const Client_js_4 = require("./api/resources/messages/client/Client.js");
|
|
46
46
|
const Client_js_5 = require("./api/resources/phoneNumbers/client/Client.js");
|
|
47
|
-
const Client_js_6 = require("./api/resources/
|
|
48
|
-
const Client_js_7 = require("./api/resources/
|
|
49
|
-
const Client_js_8 = require("./api/resources/
|
|
50
|
-
const Client_js_9 = require("./api/resources/
|
|
47
|
+
const Client_js_6 = require("./api/resources/rcs/client/Client.js");
|
|
48
|
+
const Client_js_7 = require("./api/resources/webhooks/client/Client.js");
|
|
49
|
+
const Client_js_8 = require("./api/resources/campaigns/client/Client.js");
|
|
50
|
+
const Client_js_9 = require("./api/resources/status/client/Client.js");
|
|
51
|
+
const Client_js_10 = require("./api/resources/tools/client/Client.js");
|
|
51
52
|
class PinnacleClient {
|
|
52
|
-
constructor(_options) {
|
|
53
|
+
constructor(_options = {}) {
|
|
53
54
|
this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
|
|
54
55
|
"X-Fern-Language": "JavaScript",
|
|
55
56
|
"X-Fern-SDK-Name": "rcs-js",
|
|
56
|
-
"X-Fern-SDK-Version": "2.0.0
|
|
57
|
-
"User-Agent": "rcs-js/2.0.0
|
|
57
|
+
"X-Fern-SDK-Version": "2.0.0",
|
|
58
|
+
"User-Agent": "rcs-js/2.0.0",
|
|
58
59
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
59
60
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
60
61
|
}, _options === null || _options === void 0 ? void 0 : _options.headers) });
|
|
@@ -79,21 +80,25 @@ class PinnacleClient {
|
|
|
79
80
|
var _a;
|
|
80
81
|
return ((_a = this._phoneNumbers) !== null && _a !== void 0 ? _a : (this._phoneNumbers = new Client_js_5.PhoneNumbers(this._options)));
|
|
81
82
|
}
|
|
83
|
+
get rcs() {
|
|
84
|
+
var _a;
|
|
85
|
+
return ((_a = this._rcs) !== null && _a !== void 0 ? _a : (this._rcs = new Client_js_6.Rcs(this._options)));
|
|
86
|
+
}
|
|
82
87
|
get webhooks() {
|
|
83
88
|
var _a;
|
|
84
|
-
return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new
|
|
89
|
+
return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Client_js_7.Webhooks(this._options)));
|
|
85
90
|
}
|
|
86
91
|
get campaigns() {
|
|
87
92
|
var _a;
|
|
88
|
-
return ((_a = this._campaigns) !== null && _a !== void 0 ? _a : (this._campaigns = new
|
|
93
|
+
return ((_a = this._campaigns) !== null && _a !== void 0 ? _a : (this._campaigns = new Client_js_8.Campaigns(this._options)));
|
|
89
94
|
}
|
|
90
95
|
get status() {
|
|
91
96
|
var _a;
|
|
92
|
-
return ((_a = this._status) !== null && _a !== void 0 ? _a : (this._status = new
|
|
97
|
+
return ((_a = this._status) !== null && _a !== void 0 ? _a : (this._status = new Client_js_9.Status(this._options)));
|
|
93
98
|
}
|
|
94
99
|
get tools() {
|
|
95
100
|
var _a;
|
|
96
|
-
return ((_a = this._tools) !== null && _a !== void 0 ? _a : (this._tools = new
|
|
101
|
+
return ((_a = this._tools) !== null && _a !== void 0 ? _a : (this._tools = new Client_js_10.Tools(this._options)));
|
|
97
102
|
}
|
|
98
103
|
}
|
|
99
104
|
exports.PinnacleClient = PinnacleClient;
|
|
@@ -9,7 +9,7 @@ export declare namespace Brands {
|
|
|
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 Brands {
|
|
|
28
28
|
}
|
|
29
29
|
export declare class Brands {
|
|
30
30
|
protected readonly _options: Brands.Options;
|
|
31
|
-
constructor(_options
|
|
31
|
+
constructor(_options?: Brands.Options);
|
|
32
32
|
/**
|
|
33
33
|
* Automatically populate brand information based on partial input data you provide.
|
|
34
34
|
*
|
|
@@ -81,7 +81,7 @@ export declare class Brands {
|
|
|
81
81
|
* website: "https://www.pinnacle.sh"
|
|
82
82
|
* })
|
|
83
83
|
*/
|
|
84
|
-
upsert(request
|
|
84
|
+
upsert(request: Pinnacle.UpsertBrandParams, requestOptions?: Brands.RequestOptions): core.HttpResponsePromise<Pinnacle.ExtendedBrand>;
|
|
85
85
|
private __upsert;
|
|
86
86
|
/**
|
|
87
87
|
* Retrieve detailed information for a specific brand in your account by ID.
|
|
@@ -111,6 +111,7 @@ export declare class Brands {
|
|
|
111
111
|
* @throws {@link Pinnacle.BadRequestError}
|
|
112
112
|
* @throws {@link Pinnacle.UnauthorizedError}
|
|
113
113
|
* @throws {@link Pinnacle.PaymentRequiredError}
|
|
114
|
+
* @throws {@link Pinnacle.NotFoundError}
|
|
114
115
|
* @throws {@link Pinnacle.InternalServerError}
|
|
115
116
|
* @throws {@link Pinnacle.NotImplementedError}
|
|
116
117
|
*
|
|
@@ -162,6 +163,7 @@ export declare class Brands {
|
|
|
162
163
|
* @throws {@link Pinnacle.BadRequestError}
|
|
163
164
|
* @throws {@link Pinnacle.UnauthorizedError}
|
|
164
165
|
* @throws {@link Pinnacle.PaymentRequiredError}
|
|
166
|
+
* @throws {@link Pinnacle.NotFoundError}
|
|
165
167
|
* @throws {@link Pinnacle.InternalServerError}
|
|
166
168
|
* @throws {@link Pinnacle.NotImplementedError}
|
|
167
169
|
*
|
|
@@ -171,6 +173,6 @@ export declare class Brands {
|
|
|
171
173
|
vet(brandId: number, request: Pinnacle.VetBrandParams, requestOptions?: Brands.RequestOptions): core.HttpResponsePromise<Pinnacle.VettingResults>;
|
|
172
174
|
private __vet;
|
|
173
175
|
protected _getCustomAuthorizationHeaders(): Promise<{
|
|
174
|
-
"PINNACLE-API-KEY": string;
|
|
176
|
+
"PINNACLE-API-KEY": string | undefined;
|
|
175
177
|
}>;
|
|
176
178
|
}
|
|
@@ -52,7 +52,7 @@ const Pinnacle = __importStar(require("../../../index.js"));
|
|
|
52
52
|
const headers_js_1 = require("../../../../core/headers.js");
|
|
53
53
|
const errors = __importStar(require("../../../../errors/index.js"));
|
|
54
54
|
class Brands {
|
|
55
|
-
constructor(_options) {
|
|
55
|
+
constructor(_options = {}) {
|
|
56
56
|
this._options = _options;
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
@@ -160,11 +160,11 @@ class Brands {
|
|
|
160
160
|
* website: "https://www.pinnacle.sh"
|
|
161
161
|
* })
|
|
162
162
|
*/
|
|
163
|
-
upsert(request
|
|
163
|
+
upsert(request, requestOptions) {
|
|
164
164
|
return core.HttpResponsePromise.fromPromise(this.__upsert(request, requestOptions));
|
|
165
165
|
}
|
|
166
|
-
__upsert() {
|
|
167
|
-
return __awaiter(this,
|
|
166
|
+
__upsert(request, requestOptions) {
|
|
167
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
168
168
|
var _a, _b, _c;
|
|
169
169
|
let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
170
170
|
const _response = yield core.fetcher({
|
|
@@ -235,15 +235,15 @@ class Brands {
|
|
|
235
235
|
}
|
|
236
236
|
__get(id_1) {
|
|
237
237
|
return __awaiter(this, arguments, void 0, function* (id, request = {}, requestOptions) {
|
|
238
|
-
var _a, _b, _c
|
|
238
|
+
var _a, _b, _c;
|
|
239
239
|
const { hideEIN: hideEin } = request;
|
|
240
240
|
const _queryParams = {};
|
|
241
|
-
if (hideEin
|
|
242
|
-
_queryParams["hideEIN"] =
|
|
241
|
+
if (hideEin != null) {
|
|
242
|
+
_queryParams["hideEIN"] = hideEin.toString();
|
|
243
243
|
}
|
|
244
|
-
let _headers = (0, headers_js_1.mergeHeaders)((
|
|
244
|
+
let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
245
245
|
const _response = yield core.fetcher({
|
|
246
|
-
url: core.url.join((
|
|
246
|
+
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PinnacleEnvironment.Default, `brands/${encodeURIComponent(id)}`),
|
|
247
247
|
method: "GET",
|
|
248
248
|
headers: _headers,
|
|
249
249
|
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
@@ -300,6 +300,7 @@ class Brands {
|
|
|
300
300
|
* @throws {@link Pinnacle.BadRequestError}
|
|
301
301
|
* @throws {@link Pinnacle.UnauthorizedError}
|
|
302
302
|
* @throws {@link Pinnacle.PaymentRequiredError}
|
|
303
|
+
* @throws {@link Pinnacle.NotFoundError}
|
|
303
304
|
* @throws {@link Pinnacle.InternalServerError}
|
|
304
305
|
* @throws {@link Pinnacle.NotImplementedError}
|
|
305
306
|
*
|
|
@@ -333,6 +334,8 @@ class Brands {
|
|
|
333
334
|
throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
334
335
|
case 402:
|
|
335
336
|
throw new Pinnacle.PaymentRequiredError(_response.error.body, _response.rawResponse);
|
|
337
|
+
case 404:
|
|
338
|
+
throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
|
|
336
339
|
case 500:
|
|
337
340
|
throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
|
|
338
341
|
case 501:
|
|
@@ -458,6 +461,7 @@ class Brands {
|
|
|
458
461
|
* @throws {@link Pinnacle.BadRequestError}
|
|
459
462
|
* @throws {@link Pinnacle.UnauthorizedError}
|
|
460
463
|
* @throws {@link Pinnacle.PaymentRequiredError}
|
|
464
|
+
* @throws {@link Pinnacle.NotFoundError}
|
|
461
465
|
* @throws {@link Pinnacle.InternalServerError}
|
|
462
466
|
* @throws {@link Pinnacle.NotImplementedError}
|
|
463
467
|
*
|
|
@@ -494,6 +498,8 @@ class Brands {
|
|
|
494
498
|
throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
495
499
|
case 402:
|
|
496
500
|
throw new Pinnacle.PaymentRequiredError(_response.error.body, _response.rawResponse);
|
|
501
|
+
case 404:
|
|
502
|
+
throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
|
|
497
503
|
case 500:
|
|
498
504
|
throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
|
|
499
505
|
case 501:
|
|
@@ -27,7 +27,7 @@ export interface UpsertBrandParams {
|
|
|
27
27
|
/** Primary brand address where the company is located. */
|
|
28
28
|
address?: string | null;
|
|
29
29
|
/** Contact information for the brand. */
|
|
30
|
-
contact
|
|
30
|
+
contact: Pinnacle.UpsertContact | null;
|
|
31
31
|
/** "Doing Business As" name - the public name the brand operates under. */
|
|
32
32
|
dba?: string | null;
|
|
33
33
|
/** Brief description of what the brand does. */
|
|
@@ -41,9 +41,9 @@ export interface UpsertBrandParams {
|
|
|
41
41
|
/** Legal name of the brand as registered. */
|
|
42
42
|
name?: string | null;
|
|
43
43
|
/** Industry the brand operates in. */
|
|
44
|
-
sector
|
|
44
|
+
sector: Pinnacle.CompanySectorEnum | null;
|
|
45
45
|
/** Legal structure of the brand. */
|
|
46
|
-
type
|
|
46
|
+
type: Pinnacle.CompanyTypeEnum | null;
|
|
47
47
|
/** Brand website URL. */
|
|
48
48
|
website?: string | null;
|
|
49
49
|
}
|
|
@@ -11,7 +11,7 @@ export declare namespace Campaigns {
|
|
|
11
11
|
environment?: core.Supplier<environments.PinnacleEnvironment | string>;
|
|
12
12
|
/** Specify a custom URL to connect the client to. */
|
|
13
13
|
baseUrl?: core.Supplier<string>;
|
|
14
|
-
apiKey
|
|
14
|
+
apiKey?: core.Supplier<string | undefined>;
|
|
15
15
|
/** Additional headers to include in requests. */
|
|
16
16
|
headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
|
|
17
17
|
}
|
|
@@ -21,7 +21,7 @@ export declare class Campaigns {
|
|
|
21
21
|
protected _dlc: Dlc | undefined;
|
|
22
22
|
protected _tollFree: TollFree | undefined;
|
|
23
23
|
protected _rcs: Rcs | undefined;
|
|
24
|
-
constructor(_options
|
|
24
|
+
constructor(_options?: Campaigns.Options);
|
|
25
25
|
get dlc(): Dlc;
|
|
26
26
|
get tollFree(): TollFree;
|
|
27
27
|
get rcs(): Rcs;
|
|
@@ -8,7 +8,7 @@ const Client_js_1 = require("../resources/dlc/client/Client.js");
|
|
|
8
8
|
const Client_js_2 = require("../resources/tollFree/client/Client.js");
|
|
9
9
|
const Client_js_3 = require("../resources/rcs/client/Client.js");
|
|
10
10
|
class Campaigns {
|
|
11
|
-
constructor(_options) {
|
|
11
|
+
constructor(_options = {}) {
|
|
12
12
|
this._options = _options;
|
|
13
13
|
}
|
|
14
14
|
get dlc() {
|
|
@@ -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
|
}
|
|
@@ -52,7 +52,7 @@ const Pinnacle = __importStar(require("../../../../../index.js"));
|
|
|
52
52
|
const headers_js_1 = require("../../../../../../core/headers.js");
|
|
53
53
|
const errors = __importStar(require("../../../../../../errors/index.js"));
|
|
54
54
|
class Dlc {
|
|
55
|
-
constructor(_options) {
|
|
55
|
+
constructor(_options = {}) {
|
|
56
56
|
this._options = _options;
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
@@ -127,9 +127,9 @@ class Dlc {
|
|
|
127
127
|
});
|
|
128
128
|
}
|
|
129
129
|
/**
|
|
130
|
-
* Retrieve
|
|
130
|
+
* Retrieve 10DLC campaign.
|
|
131
131
|
*
|
|
132
|
-
* @param {number} campaignId - Unique identifier of the
|
|
132
|
+
* @param {number} campaignId - Unique identifier of the 10DLC campaign.
|
|
133
133
|
* @param {Dlc.RequestOptions} requestOptions - Request-specific configuration.
|
|
134
134
|
*
|
|
135
135
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -198,9 +198,9 @@ class Dlc {
|
|
|
198
198
|
});
|
|
199
199
|
}
|
|
200
200
|
/**
|
|
201
|
-
* Submit your
|
|
201
|
+
* Submit your 10DLC campaign for approval and activation with carriers.
|
|
202
202
|
*
|
|
203
|
-
* @param {number} campaignId - Unique identifier of the
|
|
203
|
+
* @param {number} campaignId - Unique identifier of the 10DLC campaign to submit.
|
|
204
204
|
* @param {Dlc.RequestOptions} requestOptions - Request-specific configuration.
|
|
205
205
|
*
|
|
206
206
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -266,7 +266,7 @@ class Dlc {
|
|
|
266
266
|
});
|
|
267
267
|
}
|
|
268
268
|
/**
|
|
269
|
-
* Create a new
|
|
269
|
+
* Create a new 10DLC campaign or updates an existing one. <br>
|
|
270
270
|
*
|
|
271
271
|
* Omit campaignId to create a campaign.
|
|
272
272
|
*
|
|
@@ -379,7 +379,7 @@ class Dlc {
|
|
|
379
379
|
});
|
|
380
380
|
}
|
|
381
381
|
/**
|
|
382
|
-
* Validate your
|
|
382
|
+
* Validate your 10DLC campaign configuration against carrier requirements and compliance rules.
|
|
383
383
|
*
|
|
384
384
|
* @param {Pinnacle.ValidateCampaignParams} request
|
|
385
385
|
* @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
|
}
|
|
@@ -52,7 +52,7 @@ const Pinnacle = __importStar(require("../../../../../index.js"));
|
|
|
52
52
|
const headers_js_1 = require("../../../../../../core/headers.js");
|
|
53
53
|
const errors = __importStar(require("../../../../../../errors/index.js"));
|
|
54
54
|
class Rcs {
|
|
55
|
-
constructor(_options) {
|
|
55
|
+
constructor(_options = {}) {
|
|
56
56
|
this._options = _options;
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
@@ -205,6 +205,7 @@ class Rcs {
|
|
|
205
205
|
*
|
|
206
206
|
* @throws {@link Pinnacle.BadRequestError}
|
|
207
207
|
* @throws {@link Pinnacle.UnauthorizedError}
|
|
208
|
+
* @throws {@link Pinnacle.PaymentRequiredError}
|
|
208
209
|
* @throws {@link Pinnacle.NotFoundError}
|
|
209
210
|
* @throws {@link Pinnacle.InternalServerError}
|
|
210
211
|
*
|
|
@@ -236,6 +237,8 @@ class Rcs {
|
|
|
236
237
|
throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
|
|
237
238
|
case 401:
|
|
238
239
|
throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
240
|
+
case 402:
|
|
241
|
+
throw new Pinnacle.PaymentRequiredError(_response.error.body, _response.rawResponse);
|
|
239
242
|
case 404:
|
|
240
243
|
throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
|
|
241
244
|
case 500:
|
|
@@ -299,6 +302,7 @@ class Rcs {
|
|
|
299
302
|
* url: "https://www.trypinnacle.app/"
|
|
300
303
|
* }]
|
|
301
304
|
* },
|
|
305
|
+
* brandVerificationUrl: "https://www.pinnacle.sh/articles-of-incorporation.pdf",
|
|
302
306
|
* brand: 2,
|
|
303
307
|
* 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."],
|
|
304
308
|
* links: {
|
package/dist/cjs/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.ts
CHANGED
|
@@ -24,6 +24,7 @@ import * as Pinnacle from "../../../../../../index.js";
|
|
|
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.js";
|
|
|
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
|
}
|
|
@@ -52,7 +52,7 @@ const Pinnacle = __importStar(require("../../../../../index.js"));
|
|
|
52
52
|
const headers_js_1 = require("../../../../../../core/headers.js");
|
|
53
53
|
const errors = __importStar(require("../../../../../../errors/index.js"));
|
|
54
54
|
class TollFree {
|
|
55
|
-
constructor(_options) {
|
|
55
|
+
constructor(_options = {}) {
|
|
56
56
|
this._options = _options;
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
@@ -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
|
}
|
|
@@ -52,7 +52,7 @@ const Pinnacle = __importStar(require("../../../index.js"));
|
|
|
52
52
|
const headers_js_1 = require("../../../../core/headers.js");
|
|
53
53
|
const errors = __importStar(require("../../../../errors/index.js"));
|
|
54
54
|
class Contacts {
|
|
55
|
-
constructor(_options) {
|
|
55
|
+
constructor(_options = {}) {
|
|
56
56
|
this._options = _options;
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
@@ -74,18 +74,18 @@ class Contacts {
|
|
|
74
74
|
}
|
|
75
75
|
__get() {
|
|
76
76
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
77
|
-
var _a, _b, _c
|
|
77
|
+
var _a, _b, _c;
|
|
78
78
|
const { id, phoneNumber } = request;
|
|
79
79
|
const _queryParams = {};
|
|
80
|
-
if (id
|
|
81
|
-
_queryParams["id"] =
|
|
80
|
+
if (id != null) {
|
|
81
|
+
_queryParams["id"] = id.toString();
|
|
82
82
|
}
|
|
83
|
-
if (phoneNumber
|
|
83
|
+
if (phoneNumber != null) {
|
|
84
84
|
_queryParams["phoneNumber"] = phoneNumber;
|
|
85
85
|
}
|
|
86
|
-
let _headers = (0, headers_js_1.mergeHeaders)((
|
|
86
|
+
let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
87
87
|
const _response = yield core.fetcher({
|
|
88
|
-
url: core.url.join((
|
|
88
|
+
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"),
|
|
89
89
|
method: "GET",
|
|
90
90
|
headers: _headers,
|
|
91
91
|
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
|
}
|