rcs-js 2.0.1 → 2.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/Client.js +2 -2
- package/dist/cjs/api/errors/NotFoundError.d.ts +1 -2
- package/dist/cjs/api/resources/brands/client/Client.d.ts +13 -13
- package/dist/cjs/api/resources/brands/client/Client.js +10 -10
- package/dist/cjs/api/resources/brands/client/requests/UpsertBrandParams.d.ts +6 -3
- package/dist/cjs/api/resources/campaigns/resources/dlc/client/Client.d.ts +14 -13
- package/dist/cjs/api/resources/campaigns/resources/dlc/client/Client.js +12 -11
- package/dist/cjs/api/resources/campaigns/resources/dlc/client/requests/UpsertDlcCampaignParams.d.ts +8 -8
- package/dist/cjs/api/resources/campaigns/resources/rcs/client/Client.d.ts +11 -10
- package/dist/cjs/api/resources/campaigns/resources/rcs/client/Client.js +9 -8
- package/dist/cjs/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.ts +4 -3
- package/dist/cjs/api/resources/campaigns/resources/rcs/types/RcsAutofillResponse.d.ts +1 -1
- package/dist/cjs/api/resources/campaigns/resources/tollFree/client/Client.d.ts +12 -12
- package/dist/cjs/api/resources/campaigns/resources/tollFree/client/Client.js +10 -10
- package/dist/cjs/api/resources/campaigns/resources/tollFree/client/requests/UpsertTollFreeCampaignParams.d.ts +7 -7
- package/dist/cjs/api/resources/campaigns/resources/tollFree/types/TollFreeAutofillResponse.d.ts +1 -1
- package/dist/cjs/api/resources/contacts/client/Client.d.ts +4 -2
- package/dist/cjs/api/resources/contacts/client/Client.js +5 -3
- package/dist/cjs/api/resources/contacts/client/requests/ContactsGetRequest.d.ts +4 -2
- package/dist/cjs/api/resources/contacts/client/requests/UpdateContactParams.d.ts +3 -3
- package/dist/cjs/api/resources/conversations/client/Client.d.ts +21 -4
- package/dist/cjs/api/resources/conversations/client/Client.js +99 -4
- package/dist/cjs/api/resources/conversations/client/requests/ConversationsListMessagesRequest.d.ts +36 -0
- package/dist/cjs/api/resources/conversations/client/requests/ConversationsListMessagesRequest.js +5 -0
- package/dist/cjs/api/resources/conversations/client/requests/ListConversationsParams.d.ts +11 -6
- package/dist/cjs/api/resources/conversations/client/requests/UpdateConversationParams.d.ts +3 -3
- package/dist/cjs/api/resources/conversations/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/conversations/index.d.ts +1 -0
- package/dist/cjs/api/resources/conversations/index.js +1 -0
- package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestDirection.d.ts +8 -0
- package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestDirection.js +10 -0
- package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestSortOrder.d.ts +8 -0
- package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestSortOrder.js +10 -0
- package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestStatus.d.ts +13 -0
- package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestStatus.js +15 -0
- package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestType.d.ts +9 -0
- package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestType.js +11 -0
- package/dist/cjs/api/resources/conversations/types/index.d.ts +4 -0
- package/dist/cjs/api/resources/conversations/types/index.js +20 -0
- package/dist/cjs/api/resources/index.d.ts +2 -1
- package/dist/cjs/api/resources/index.js +3 -2
- package/dist/cjs/api/resources/messages/client/Client.d.ts +4 -4
- package/dist/cjs/api/resources/messages/client/Client.js +3 -3
- package/dist/cjs/api/resources/messages/client/requests/ReactMessageParams.d.ts +3 -3
- package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/Client.js +1 -1
- package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/requests/AttachCampaignParams.d.ts +12 -3
- package/dist/cjs/api/resources/phoneNumbers/resources/webhook/client/Client.d.ts +5 -5
- package/dist/cjs/api/resources/phoneNumbers/resources/webhook/client/Client.js +4 -4
- package/dist/cjs/api/resources/rcs/client/Client.d.ts +11 -7
- package/dist/cjs/api/resources/rcs/client/Client.js +11 -7
- package/dist/cjs/api/resources/status/resources/get/client/Client.d.ts +12 -12
- package/dist/cjs/api/resources/status/resources/get/client/Client.js +8 -8
- package/dist/cjs/api/resources/tools/resources/contactCard/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/tools/resources/contactCard/client/Client.js +2 -2
- package/dist/cjs/api/resources/tools/resources/contactCard/client/requests/GetVcardParams.d.ts +3 -3
- package/dist/cjs/api/resources/tools/resources/contactCard/client/requests/UpsertVcardParams.d.ts +1 -1
- package/dist/cjs/api/resources/tools/resources/file/client/Client.d.ts +2 -1
- package/dist/cjs/api/resources/tools/resources/file/client/Client.js +2 -1
- package/dist/cjs/api/resources/tools/resources/file/client/requests/RefreshFileParams.d.ts +3 -11
- package/dist/cjs/api/resources/tools/resources/file/client/requests/UploadFileParams.d.ts +7 -0
- package/dist/cjs/api/types/AttachWebhookParams.d.ts +1 -1
- package/dist/cjs/api/types/AttachedPhoneNumberResult.d.ts +2 -2
- package/dist/cjs/api/types/AutofillCampaignParams.d.ts +7 -2
- package/dist/cjs/api/types/AutofillDlcCampaignResponse.d.ts +4 -4
- package/dist/cjs/api/types/BrandStatus.d.ts +2 -2
- package/dist/cjs/api/types/ButtonClickedData.d.ts +2 -2
- package/dist/cjs/api/types/CampaignQuery.d.ts +6 -1
- package/dist/cjs/api/types/ConfiguredWebhook.d.ts +2 -2
- package/dist/cjs/api/types/Contact.d.ts +2 -2
- package/dist/cjs/api/types/ContactId.d.ts +2 -2
- package/dist/cjs/api/types/Conversation.d.ts +7 -7
- package/dist/cjs/api/types/ConversationList.d.ts +4 -4
- package/dist/cjs/api/types/DetachedPhoneNumberResult.d.ts +2 -2
- package/dist/cjs/api/types/DetachedWebhookInfo.d.ts +2 -2
- package/dist/cjs/api/types/DlcCampaignStatus.d.ts +2 -2
- package/dist/cjs/api/types/DlcCampaignWithExtendedBrandAndStatus.d.ts +2 -2
- package/dist/cjs/api/types/ExtendedBrand.d.ts +2 -2
- package/dist/cjs/api/types/ExtendedRcsCampaign.d.ts +2 -2
- package/dist/cjs/api/types/GetConversationParams.d.ts +1 -1
- package/dist/cjs/api/types/LinkClickEvent.d.ts +0 -4
- package/dist/cjs/api/types/Message.d.ts +2 -2
- package/dist/cjs/api/types/MessageEvent.d.ts +6 -12
- package/dist/cjs/api/types/MessageEventContent.d.ts +29 -0
- package/dist/cjs/api/types/MessageEventContent.js +5 -0
- package/dist/cjs/api/types/MessageEventMmsContent.d.ts +23 -0
- package/dist/cjs/api/types/MessageEventMmsContent.js +5 -0
- package/dist/cjs/api/types/MessageEventRcsButtonData.d.ts +18 -0
- package/dist/cjs/api/types/MessageEventRcsButtonData.js +5 -0
- package/dist/cjs/api/types/MessageEventRcsCardsContent.d.ts +39 -0
- package/dist/cjs/api/types/MessageEventRcsCardsContent.js +5 -0
- package/dist/cjs/api/types/MessageEventRcsLocationData.d.ts +18 -0
- package/dist/cjs/api/types/MessageEventRcsLocationData.js +5 -0
- package/dist/cjs/api/types/MessageEventRcsMediaContent.d.ts +21 -0
- package/dist/cjs/api/types/MessageEventRcsMediaContent.js +5 -0
- package/dist/cjs/api/types/MessageEventRcsTextContent.d.ts +20 -0
- package/dist/cjs/api/types/MessageEventRcsTextContent.js +5 -0
- package/dist/cjs/api/types/MessageEventSmsContent.d.ts +17 -0
- package/dist/cjs/api/types/MessageEventSmsContent.js +5 -0
- package/dist/cjs/api/types/MessageList.d.ts +15 -0
- package/dist/cjs/api/types/MessageList.js +5 -0
- package/dist/cjs/api/types/MessageWithReaction.d.ts +27 -0
- package/dist/cjs/api/types/MessageWithReaction.js +13 -0
- package/dist/cjs/api/types/NotFoundErrorBody.d.ts +6 -0
- package/dist/cjs/api/types/NotFoundErrorBody.js +5 -0
- package/dist/cjs/api/types/RcsCampaign.d.ts +1 -1
- package/dist/cjs/api/types/RcsCampaignStatus.d.ts +2 -2
- package/dist/cjs/api/types/ReactionResult.d.ts +4 -4
- package/dist/cjs/api/types/ScheduledMessaage.d.ts +2 -2
- package/dist/cjs/api/types/SentMmsDetails.d.ts +2 -2
- package/dist/cjs/api/types/SentRcsDetails.d.ts +2 -2
- package/dist/cjs/api/types/SentSmsDetails.d.ts +2 -2
- package/dist/cjs/api/types/TollFreeCampaign.d.ts +2 -2
- package/dist/cjs/api/types/TollFreeCampaignStatus.d.ts +2 -2
- package/dist/cjs/api/types/UpdatedContactId.d.ts +2 -2
- package/dist/cjs/api/types/UploadResults.d.ts +6 -0
- package/dist/cjs/api/types/ValidateCampaignParams.d.ts +7 -2
- package/dist/cjs/api/types/Vcard.d.ts +2 -2
- package/dist/cjs/api/types/VcardResource.d.ts +2 -2
- package/dist/cjs/api/types/Webhooks.d.ts +2 -2
- package/dist/cjs/api/types/index.d.ts +11 -0
- package/dist/cjs/api/types/index.js +11 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.mjs +2 -2
- package/dist/esm/api/errors/NotFoundError.d.mts +1 -2
- package/dist/esm/api/resources/brands/client/Client.d.mts +13 -13
- package/dist/esm/api/resources/brands/client/Client.mjs +10 -10
- package/dist/esm/api/resources/brands/client/requests/UpsertBrandParams.d.mts +6 -3
- package/dist/esm/api/resources/campaigns/resources/dlc/client/Client.d.mts +14 -13
- package/dist/esm/api/resources/campaigns/resources/dlc/client/Client.mjs +12 -11
- package/dist/esm/api/resources/campaigns/resources/dlc/client/requests/UpsertDlcCampaignParams.d.mts +8 -8
- package/dist/esm/api/resources/campaigns/resources/rcs/client/Client.d.mts +11 -10
- package/dist/esm/api/resources/campaigns/resources/rcs/client/Client.mjs +9 -8
- package/dist/esm/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.mts +4 -3
- package/dist/esm/api/resources/campaigns/resources/rcs/types/RcsAutofillResponse.d.mts +1 -1
- package/dist/esm/api/resources/campaigns/resources/tollFree/client/Client.d.mts +12 -12
- package/dist/esm/api/resources/campaigns/resources/tollFree/client/Client.mjs +10 -10
- package/dist/esm/api/resources/campaigns/resources/tollFree/client/requests/UpsertTollFreeCampaignParams.d.mts +7 -7
- package/dist/esm/api/resources/campaigns/resources/tollFree/types/TollFreeAutofillResponse.d.mts +1 -1
- package/dist/esm/api/resources/contacts/client/Client.d.mts +4 -2
- package/dist/esm/api/resources/contacts/client/Client.mjs +5 -3
- package/dist/esm/api/resources/contacts/client/requests/ContactsGetRequest.d.mts +4 -2
- package/dist/esm/api/resources/contacts/client/requests/UpdateContactParams.d.mts +3 -3
- package/dist/esm/api/resources/conversations/client/Client.d.mts +21 -4
- package/dist/esm/api/resources/conversations/client/Client.mjs +99 -4
- package/dist/esm/api/resources/conversations/client/requests/ConversationsListMessagesRequest.d.mts +36 -0
- package/dist/esm/api/resources/conversations/client/requests/ConversationsListMessagesRequest.mjs +4 -0
- package/dist/esm/api/resources/conversations/client/requests/ListConversationsParams.d.mts +11 -6
- package/dist/esm/api/resources/conversations/client/requests/UpdateConversationParams.d.mts +3 -3
- package/dist/esm/api/resources/conversations/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/conversations/index.d.mts +1 -0
- package/dist/esm/api/resources/conversations/index.mjs +1 -0
- package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestDirection.d.mts +8 -0
- package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestDirection.mjs +7 -0
- package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestSortOrder.d.mts +8 -0
- package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestSortOrder.mjs +7 -0
- package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestStatus.d.mts +13 -0
- package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestStatus.mjs +12 -0
- package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestType.d.mts +9 -0
- package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestType.mjs +8 -0
- package/dist/esm/api/resources/conversations/types/index.d.mts +4 -0
- package/dist/esm/api/resources/conversations/types/index.mjs +4 -0
- package/dist/esm/api/resources/index.d.mts +2 -1
- package/dist/esm/api/resources/index.mjs +2 -1
- package/dist/esm/api/resources/messages/client/Client.d.mts +4 -4
- package/dist/esm/api/resources/messages/client/Client.mjs +3 -3
- package/dist/esm/api/resources/messages/client/requests/ReactMessageParams.d.mts +3 -3
- package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/Client.mjs +1 -1
- package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/requests/AttachCampaignParams.d.mts +12 -3
- package/dist/esm/api/resources/phoneNumbers/resources/webhook/client/Client.d.mts +5 -5
- package/dist/esm/api/resources/phoneNumbers/resources/webhook/client/Client.mjs +4 -4
- package/dist/esm/api/resources/rcs/client/Client.d.mts +11 -7
- package/dist/esm/api/resources/rcs/client/Client.mjs +11 -7
- package/dist/esm/api/resources/status/resources/get/client/Client.d.mts +12 -12
- package/dist/esm/api/resources/status/resources/get/client/Client.mjs +8 -8
- package/dist/esm/api/resources/tools/resources/contactCard/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/tools/resources/contactCard/client/Client.mjs +2 -2
- package/dist/esm/api/resources/tools/resources/contactCard/client/requests/GetVcardParams.d.mts +3 -3
- package/dist/esm/api/resources/tools/resources/contactCard/client/requests/UpsertVcardParams.d.mts +1 -1
- package/dist/esm/api/resources/tools/resources/file/client/Client.d.mts +2 -1
- package/dist/esm/api/resources/tools/resources/file/client/Client.mjs +2 -1
- package/dist/esm/api/resources/tools/resources/file/client/requests/RefreshFileParams.d.mts +3 -11
- package/dist/esm/api/resources/tools/resources/file/client/requests/UploadFileParams.d.mts +7 -0
- package/dist/esm/api/types/AttachWebhookParams.d.mts +1 -1
- package/dist/esm/api/types/AttachedPhoneNumberResult.d.mts +2 -2
- package/dist/esm/api/types/AutofillCampaignParams.d.mts +7 -2
- package/dist/esm/api/types/AutofillDlcCampaignResponse.d.mts +4 -4
- package/dist/esm/api/types/BrandStatus.d.mts +2 -2
- package/dist/esm/api/types/ButtonClickedData.d.mts +2 -2
- package/dist/esm/api/types/CampaignQuery.d.mts +6 -1
- package/dist/esm/api/types/ConfiguredWebhook.d.mts +2 -2
- package/dist/esm/api/types/Contact.d.mts +2 -2
- package/dist/esm/api/types/ContactId.d.mts +2 -2
- package/dist/esm/api/types/Conversation.d.mts +7 -7
- package/dist/esm/api/types/ConversationList.d.mts +4 -4
- package/dist/esm/api/types/DetachedPhoneNumberResult.d.mts +2 -2
- package/dist/esm/api/types/DetachedWebhookInfo.d.mts +2 -2
- package/dist/esm/api/types/DlcCampaignStatus.d.mts +2 -2
- package/dist/esm/api/types/DlcCampaignWithExtendedBrandAndStatus.d.mts +2 -2
- package/dist/esm/api/types/ExtendedBrand.d.mts +2 -2
- package/dist/esm/api/types/ExtendedRcsCampaign.d.mts +2 -2
- package/dist/esm/api/types/GetConversationParams.d.mts +1 -1
- package/dist/esm/api/types/LinkClickEvent.d.mts +0 -4
- package/dist/esm/api/types/Message.d.mts +2 -2
- package/dist/esm/api/types/MessageEvent.d.mts +6 -12
- package/dist/esm/api/types/MessageEventContent.d.mts +29 -0
- package/dist/esm/api/types/MessageEventContent.mjs +4 -0
- package/dist/esm/api/types/MessageEventMmsContent.d.mts +23 -0
- package/dist/esm/api/types/MessageEventMmsContent.mjs +4 -0
- package/dist/esm/api/types/MessageEventRcsButtonData.d.mts +18 -0
- package/dist/esm/api/types/MessageEventRcsButtonData.mjs +4 -0
- package/dist/esm/api/types/MessageEventRcsCardsContent.d.mts +39 -0
- package/dist/esm/api/types/MessageEventRcsCardsContent.mjs +4 -0
- package/dist/esm/api/types/MessageEventRcsLocationData.d.mts +18 -0
- package/dist/esm/api/types/MessageEventRcsLocationData.mjs +4 -0
- package/dist/esm/api/types/MessageEventRcsMediaContent.d.mts +21 -0
- package/dist/esm/api/types/MessageEventRcsMediaContent.mjs +4 -0
- package/dist/esm/api/types/MessageEventRcsTextContent.d.mts +20 -0
- package/dist/esm/api/types/MessageEventRcsTextContent.mjs +4 -0
- package/dist/esm/api/types/MessageEventSmsContent.d.mts +17 -0
- package/dist/esm/api/types/MessageEventSmsContent.mjs +4 -0
- package/dist/esm/api/types/MessageList.d.mts +15 -0
- package/dist/esm/api/types/MessageList.mjs +4 -0
- package/dist/esm/api/types/MessageWithReaction.d.mts +27 -0
- package/dist/esm/api/types/MessageWithReaction.mjs +10 -0
- package/dist/esm/api/types/NotFoundErrorBody.d.mts +6 -0
- package/dist/esm/api/types/NotFoundErrorBody.mjs +4 -0
- package/dist/esm/api/types/RcsCampaign.d.mts +1 -1
- package/dist/esm/api/types/RcsCampaignStatus.d.mts +2 -2
- package/dist/esm/api/types/ReactionResult.d.mts +4 -4
- package/dist/esm/api/types/ScheduledMessaage.d.mts +2 -2
- package/dist/esm/api/types/SentMmsDetails.d.mts +2 -2
- package/dist/esm/api/types/SentRcsDetails.d.mts +2 -2
- package/dist/esm/api/types/SentSmsDetails.d.mts +2 -2
- package/dist/esm/api/types/TollFreeCampaign.d.mts +2 -2
- package/dist/esm/api/types/TollFreeCampaignStatus.d.mts +2 -2
- package/dist/esm/api/types/UpdatedContactId.d.mts +2 -2
- package/dist/esm/api/types/UploadResults.d.mts +6 -0
- package/dist/esm/api/types/ValidateCampaignParams.d.mts +7 -2
- package/dist/esm/api/types/Vcard.d.mts +2 -2
- package/dist/esm/api/types/VcardResource.d.mts +2 -2
- package/dist/esm/api/types/Webhooks.d.mts +2 -2
- package/dist/esm/api/types/index.d.mts +11 -0
- package/dist/esm/api/types/index.mjs +11 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +3 -3
- package/reference.md +156 -73
package/dist/cjs/Client.js
CHANGED
|
@@ -54,8 +54,8 @@ class PinnacleClient {
|
|
|
54
54
|
this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
|
|
55
55
|
"X-Fern-Language": "JavaScript",
|
|
56
56
|
"X-Fern-SDK-Name": "rcs-js",
|
|
57
|
-
"X-Fern-SDK-Version": "2.0.
|
|
58
|
-
"User-Agent": "rcs-js/2.0.
|
|
57
|
+
"X-Fern-SDK-Version": "2.0.2",
|
|
58
|
+
"User-Agent": "rcs-js/2.0.2",
|
|
59
59
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
60
60
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
61
61
|
}, _options === null || _options === void 0 ? void 0 : _options.headers) });
|
|
@@ -2,8 +2,7 @@
|
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
4
|
import * as errors from "../../errors/index.js";
|
|
5
|
-
import * as Pinnacle from "../index.js";
|
|
6
5
|
import * as core from "../../core/index.js";
|
|
7
6
|
export declare class NotFoundError extends errors.PinnacleError {
|
|
8
|
-
constructor(body
|
|
7
|
+
constructor(body?: unknown, rawResponse?: core.RawResponse);
|
|
9
8
|
}
|
|
@@ -74,7 +74,7 @@ export declare class Brands {
|
|
|
74
74
|
* description: "A developer-friendly, compliant API for SMS, MMS, and RCS, built to scale real conversations.",
|
|
75
75
|
* ein: "88-1234567",
|
|
76
76
|
* email: "founders@trypinnacle.app",
|
|
77
|
-
* id:
|
|
77
|
+
* id: "b_1234567890",
|
|
78
78
|
* name: "Pinnacle",
|
|
79
79
|
* sector: "TECHNOLOGY",
|
|
80
80
|
* type: "PRIVATE_PROFIT",
|
|
@@ -86,7 +86,8 @@ export declare class Brands {
|
|
|
86
86
|
/**
|
|
87
87
|
* Retrieve detailed information for a specific brand in your account by ID.
|
|
88
88
|
*
|
|
89
|
-
* @param {
|
|
89
|
+
* @param {string} id - The unique identifier of the brand you want to retrieve from your account.
|
|
90
|
+
* <br><br> This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`.
|
|
90
91
|
* @param {Pinnacle.BrandsGetRequest} request
|
|
91
92
|
* @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
|
|
92
93
|
*
|
|
@@ -96,16 +97,15 @@ export declare class Brands {
|
|
|
96
97
|
* @throws {@link Pinnacle.InternalServerError}
|
|
97
98
|
*
|
|
98
99
|
* @example
|
|
99
|
-
* await client.brands.get(
|
|
100
|
+
* await client.brands.get("b_1234567890")
|
|
100
101
|
*/
|
|
101
|
-
get(id:
|
|
102
|
+
get(id: string, request?: Pinnacle.BrandsGetRequest, requestOptions?: Brands.RequestOptions): core.HttpResponsePromise<Pinnacle.ExtendedBrandWithVetting>;
|
|
102
103
|
private __get;
|
|
103
104
|
/**
|
|
104
105
|
* Submit your brand for review and approval by the compliance team.
|
|
105
106
|
*
|
|
106
|
-
* @param {
|
|
107
|
-
*
|
|
108
|
-
* Must correspond to an existing brand in your account that is ready for submission.
|
|
107
|
+
* @param {string} brandId - The unique identifier of the brand you want to submit for review. <br><br>
|
|
108
|
+
* This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890` and must correspond to an existing brand in your account that is ready for submission.
|
|
109
109
|
* @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
|
|
110
110
|
*
|
|
111
111
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -116,9 +116,9 @@ export declare class Brands {
|
|
|
116
116
|
* @throws {@link Pinnacle.NotImplementedError}
|
|
117
117
|
*
|
|
118
118
|
* @example
|
|
119
|
-
* await client.brands.submit(
|
|
119
|
+
* await client.brands.submit("b_1234567890")
|
|
120
120
|
*/
|
|
121
|
-
submit(brandId:
|
|
121
|
+
submit(brandId: string, requestOptions?: Brands.RequestOptions): core.HttpResponsePromise<Pinnacle.SubmissionResults>;
|
|
122
122
|
private __submit;
|
|
123
123
|
/**
|
|
124
124
|
* Validate your brand information for compliance and correctness before submission or storage.
|
|
@@ -154,9 +154,9 @@ export declare class Brands {
|
|
|
154
154
|
/**
|
|
155
155
|
* Submit a brand for external vetting verification to enhance your brand's trust score and improved message delivery rates.
|
|
156
156
|
*
|
|
157
|
-
* @param {
|
|
157
|
+
* @param {string} brandId - The unique identifier of the brand to vet. <br>
|
|
158
158
|
*
|
|
159
|
-
*
|
|
159
|
+
* This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890` and must correspond to an existing brand in your account that is ready for vetting.
|
|
160
160
|
* @param {Pinnacle.VetBrandParams} request
|
|
161
161
|
* @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
|
|
162
162
|
*
|
|
@@ -168,9 +168,9 @@ export declare class Brands {
|
|
|
168
168
|
* @throws {@link Pinnacle.NotImplementedError}
|
|
169
169
|
*
|
|
170
170
|
* @example
|
|
171
|
-
* await client.brands.vet(
|
|
171
|
+
* await client.brands.vet("b_1234567890", {})
|
|
172
172
|
*/
|
|
173
|
-
vet(brandId:
|
|
173
|
+
vet(brandId: string, request: Pinnacle.VetBrandParams, requestOptions?: Brands.RequestOptions): core.HttpResponsePromise<Pinnacle.VettingResults>;
|
|
174
174
|
private __vet;
|
|
175
175
|
protected _getCustomAuthorizationHeaders(): Promise<{
|
|
176
176
|
"PINNACLE-API-KEY": string | undefined;
|
|
@@ -153,7 +153,7 @@ class Brands {
|
|
|
153
153
|
* description: "A developer-friendly, compliant API for SMS, MMS, and RCS, built to scale real conversations.",
|
|
154
154
|
* ein: "88-1234567",
|
|
155
155
|
* email: "founders@trypinnacle.app",
|
|
156
|
-
* id:
|
|
156
|
+
* id: "b_1234567890",
|
|
157
157
|
* name: "Pinnacle",
|
|
158
158
|
* sector: "TECHNOLOGY",
|
|
159
159
|
* type: "PRIVATE_PROFIT",
|
|
@@ -218,7 +218,8 @@ class Brands {
|
|
|
218
218
|
/**
|
|
219
219
|
* Retrieve detailed information for a specific brand in your account by ID.
|
|
220
220
|
*
|
|
221
|
-
* @param {
|
|
221
|
+
* @param {string} id - The unique identifier of the brand you want to retrieve from your account.
|
|
222
|
+
* <br><br> This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`.
|
|
222
223
|
* @param {Pinnacle.BrandsGetRequest} request
|
|
223
224
|
* @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
|
|
224
225
|
*
|
|
@@ -228,7 +229,7 @@ class Brands {
|
|
|
228
229
|
* @throws {@link Pinnacle.InternalServerError}
|
|
229
230
|
*
|
|
230
231
|
* @example
|
|
231
|
-
* await client.brands.get(
|
|
232
|
+
* await client.brands.get("b_1234567890")
|
|
232
233
|
*/
|
|
233
234
|
get(id, request = {}, requestOptions) {
|
|
234
235
|
return core.HttpResponsePromise.fromPromise(this.__get(id, request, requestOptions));
|
|
@@ -292,9 +293,8 @@ class Brands {
|
|
|
292
293
|
/**
|
|
293
294
|
* Submit your brand for review and approval by the compliance team.
|
|
294
295
|
*
|
|
295
|
-
* @param {
|
|
296
|
-
*
|
|
297
|
-
* Must correspond to an existing brand in your account that is ready for submission.
|
|
296
|
+
* @param {string} brandId - The unique identifier of the brand you want to submit for review. <br><br>
|
|
297
|
+
* This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890` and must correspond to an existing brand in your account that is ready for submission.
|
|
298
298
|
* @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
|
|
299
299
|
*
|
|
300
300
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -305,7 +305,7 @@ class Brands {
|
|
|
305
305
|
* @throws {@link Pinnacle.NotImplementedError}
|
|
306
306
|
*
|
|
307
307
|
* @example
|
|
308
|
-
* await client.brands.submit(
|
|
308
|
+
* await client.brands.submit("b_1234567890")
|
|
309
309
|
*/
|
|
310
310
|
submit(brandId, requestOptions) {
|
|
311
311
|
return core.HttpResponsePromise.fromPromise(this.__submit(brandId, requestOptions));
|
|
@@ -452,9 +452,9 @@ class Brands {
|
|
|
452
452
|
/**
|
|
453
453
|
* Submit a brand for external vetting verification to enhance your brand's trust score and improved message delivery rates.
|
|
454
454
|
*
|
|
455
|
-
* @param {
|
|
455
|
+
* @param {string} brandId - The unique identifier of the brand to vet. <br>
|
|
456
456
|
*
|
|
457
|
-
*
|
|
457
|
+
* This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890` and must correspond to an existing brand in your account that is ready for vetting.
|
|
458
458
|
* @param {Pinnacle.VetBrandParams} request
|
|
459
459
|
* @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
|
|
460
460
|
*
|
|
@@ -466,7 +466,7 @@ class Brands {
|
|
|
466
466
|
* @throws {@link Pinnacle.NotImplementedError}
|
|
467
467
|
*
|
|
468
468
|
* @example
|
|
469
|
-
* await client.brands.vet(
|
|
469
|
+
* await client.brands.vet("b_1234567890", {})
|
|
470
470
|
*/
|
|
471
471
|
vet(brandId, request, requestOptions) {
|
|
472
472
|
return core.HttpResponsePromise.fromPromise(this.__vet(brandId, request, requestOptions));
|
|
@@ -16,7 +16,7 @@ import * as Pinnacle from "../../../../index.js";
|
|
|
16
16
|
* description: "A developer-friendly, compliant API for SMS, MMS, and RCS, built to scale real conversations.",
|
|
17
17
|
* ein: "88-1234567",
|
|
18
18
|
* email: "founders@trypinnacle.app",
|
|
19
|
-
* id:
|
|
19
|
+
* id: "b_1234567890",
|
|
20
20
|
* name: "Pinnacle",
|
|
21
21
|
* sector: "TECHNOLOGY",
|
|
22
22
|
* type: "PRIVATE_PROFIT",
|
|
@@ -36,8 +36,11 @@ export interface UpsertBrandParams {
|
|
|
36
36
|
ein?: string | null;
|
|
37
37
|
/** Main contact email address for the brand. */
|
|
38
38
|
email?: string | null;
|
|
39
|
-
/**
|
|
40
|
-
|
|
39
|
+
/**
|
|
40
|
+
* The unique identifier of the brand you want to update.
|
|
41
|
+
* <br><br> This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`.
|
|
42
|
+
*/
|
|
43
|
+
id?: string;
|
|
41
44
|
/** Legal name of the brand as registered. */
|
|
42
45
|
name?: string | null;
|
|
43
46
|
/** Industry the brand operates in. */
|
|
@@ -41,8 +41,8 @@ export declare class Dlc {
|
|
|
41
41
|
*
|
|
42
42
|
* @example
|
|
43
43
|
* await client.campaigns.dlc.autofill({
|
|
44
|
-
* additionalInfo: "Please autofill missing
|
|
45
|
-
* campaignId:
|
|
44
|
+
* additionalInfo: "Please autofill missing campaign fields using my brand profile",
|
|
45
|
+
* campaignId: "dlc_1234567890"
|
|
46
46
|
* })
|
|
47
47
|
*/
|
|
48
48
|
autofill(request: Pinnacle.AutofillCampaignParams, requestOptions?: Dlc.RequestOptions): core.HttpResponsePromise<Pinnacle.AutofillDlcCampaignResponse>;
|
|
@@ -50,7 +50,7 @@ export declare class Dlc {
|
|
|
50
50
|
/**
|
|
51
51
|
* Retrieve 10DLC campaign.
|
|
52
52
|
*
|
|
53
|
-
* @param {
|
|
53
|
+
* @param {string} campaignId - Unique identifier of the 10DLC campaign. This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`.
|
|
54
54
|
* @param {Dlc.RequestOptions} requestOptions - Request-specific configuration.
|
|
55
55
|
*
|
|
56
56
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -59,14 +59,15 @@ export declare class Dlc {
|
|
|
59
59
|
* @throws {@link Pinnacle.InternalServerError}
|
|
60
60
|
*
|
|
61
61
|
* @example
|
|
62
|
-
* await client.campaigns.dlc.get(
|
|
62
|
+
* await client.campaigns.dlc.get("dlc_1234567890")
|
|
63
63
|
*/
|
|
64
|
-
get(campaignId:
|
|
64
|
+
get(campaignId: string, requestOptions?: Dlc.RequestOptions): core.HttpResponsePromise<Pinnacle.DlcCampaignWithExtendedBrandAndStatus>;
|
|
65
65
|
private __get;
|
|
66
66
|
/**
|
|
67
67
|
* Submit your 10DLC campaign for approval and activation with carriers.
|
|
68
68
|
*
|
|
69
|
-
* @param {
|
|
69
|
+
* @param {string} campaignId - Unique identifier of the 10DLC campaign to submit.
|
|
70
|
+
* <br><br> This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`.
|
|
70
71
|
* @param {Dlc.RequestOptions} requestOptions - Request-specific configuration.
|
|
71
72
|
*
|
|
72
73
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -75,9 +76,9 @@ export declare class Dlc {
|
|
|
75
76
|
* @throws {@link Pinnacle.InternalServerError}
|
|
76
77
|
*
|
|
77
78
|
* @example
|
|
78
|
-
* await client.campaigns.dlc.submit(
|
|
79
|
+
* await client.campaigns.dlc.submit("dlc_1234567890")
|
|
79
80
|
*/
|
|
80
|
-
submit(campaignId:
|
|
81
|
+
submit(campaignId: string, requestOptions?: Dlc.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignSubmissionResult>;
|
|
81
82
|
private __submit;
|
|
82
83
|
/**
|
|
83
84
|
* Create a new 10DLC campaign or updates an existing one. <br>
|
|
@@ -95,19 +96,19 @@ export declare class Dlc {
|
|
|
95
96
|
* @example
|
|
96
97
|
* await client.campaigns.dlc.upsert({
|
|
97
98
|
* autoRenew: true,
|
|
98
|
-
* brand:
|
|
99
|
-
* campaignId:
|
|
99
|
+
* brand: "b_1234567890",
|
|
100
|
+
* campaignId: "dlc_1234567890",
|
|
100
101
|
* keywords: {
|
|
101
102
|
* HELP: {
|
|
102
103
|
* message: "Reply HELP for assistance, STOP to opt-out",
|
|
103
104
|
* values: ["HELP", "INFO", "SUPPORT"]
|
|
104
105
|
* },
|
|
105
106
|
* OPT_IN: {
|
|
106
|
-
* message: "Welcome
|
|
107
|
+
* message: "Welcome. You are now subscribed to Pinnacle.",
|
|
107
108
|
* values: ["JOIN", "START", "SUBSCRIBE"]
|
|
108
109
|
* },
|
|
109
110
|
* OPT_OUT: {
|
|
110
|
-
* message: "You
|
|
111
|
+
* message: "You have been unsubscribed. Reply START to rejoin.",
|
|
111
112
|
* values: ["STOP", "QUIT", "UNSUBSCRIBE"]
|
|
112
113
|
* }
|
|
113
114
|
* },
|
|
@@ -147,7 +148,7 @@ export declare class Dlc {
|
|
|
147
148
|
* @example
|
|
148
149
|
* await client.campaigns.dlc.validate({
|
|
149
150
|
* additionalInfo: "Please validate this DLC campaign for 10DLC compliance",
|
|
150
|
-
* campaignId:
|
|
151
|
+
* campaignId: "dlc_1234567890"
|
|
151
152
|
* })
|
|
152
153
|
*/
|
|
153
154
|
validate(request: Pinnacle.ValidateCampaignParams, requestOptions?: Dlc.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignValidationResult>;
|
|
@@ -67,8 +67,8 @@ class Dlc {
|
|
|
67
67
|
*
|
|
68
68
|
* @example
|
|
69
69
|
* await client.campaigns.dlc.autofill({
|
|
70
|
-
* additionalInfo: "Please autofill missing
|
|
71
|
-
* campaignId:
|
|
70
|
+
* additionalInfo: "Please autofill missing campaign fields using my brand profile",
|
|
71
|
+
* campaignId: "dlc_1234567890"
|
|
72
72
|
* })
|
|
73
73
|
*/
|
|
74
74
|
autofill(request, requestOptions) {
|
|
@@ -129,7 +129,7 @@ class Dlc {
|
|
|
129
129
|
/**
|
|
130
130
|
* Retrieve 10DLC campaign.
|
|
131
131
|
*
|
|
132
|
-
* @param {
|
|
132
|
+
* @param {string} campaignId - Unique identifier of the 10DLC campaign. This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`.
|
|
133
133
|
* @param {Dlc.RequestOptions} requestOptions - Request-specific configuration.
|
|
134
134
|
*
|
|
135
135
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -138,7 +138,7 @@ class Dlc {
|
|
|
138
138
|
* @throws {@link Pinnacle.InternalServerError}
|
|
139
139
|
*
|
|
140
140
|
* @example
|
|
141
|
-
* await client.campaigns.dlc.get(
|
|
141
|
+
* await client.campaigns.dlc.get("dlc_1234567890")
|
|
142
142
|
*/
|
|
143
143
|
get(campaignId, requestOptions) {
|
|
144
144
|
return core.HttpResponsePromise.fromPromise(this.__get(campaignId, requestOptions));
|
|
@@ -200,7 +200,8 @@ class Dlc {
|
|
|
200
200
|
/**
|
|
201
201
|
* Submit your 10DLC campaign for approval and activation with carriers.
|
|
202
202
|
*
|
|
203
|
-
* @param {
|
|
203
|
+
* @param {string} campaignId - Unique identifier of the 10DLC campaign to submit.
|
|
204
|
+
* <br><br> This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`.
|
|
204
205
|
* @param {Dlc.RequestOptions} requestOptions - Request-specific configuration.
|
|
205
206
|
*
|
|
206
207
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -209,7 +210,7 @@ class Dlc {
|
|
|
209
210
|
* @throws {@link Pinnacle.InternalServerError}
|
|
210
211
|
*
|
|
211
212
|
* @example
|
|
212
|
-
* await client.campaigns.dlc.submit(
|
|
213
|
+
* await client.campaigns.dlc.submit("dlc_1234567890")
|
|
213
214
|
*/
|
|
214
215
|
submit(campaignId, requestOptions) {
|
|
215
216
|
return core.HttpResponsePromise.fromPromise(this.__submit(campaignId, requestOptions));
|
|
@@ -281,19 +282,19 @@ class Dlc {
|
|
|
281
282
|
* @example
|
|
282
283
|
* await client.campaigns.dlc.upsert({
|
|
283
284
|
* autoRenew: true,
|
|
284
|
-
* brand:
|
|
285
|
-
* campaignId:
|
|
285
|
+
* brand: "b_1234567890",
|
|
286
|
+
* campaignId: "dlc_1234567890",
|
|
286
287
|
* keywords: {
|
|
287
288
|
* HELP: {
|
|
288
289
|
* message: "Reply HELP for assistance, STOP to opt-out",
|
|
289
290
|
* values: ["HELP", "INFO", "SUPPORT"]
|
|
290
291
|
* },
|
|
291
292
|
* OPT_IN: {
|
|
292
|
-
* message: "Welcome
|
|
293
|
+
* message: "Welcome. You are now subscribed to Pinnacle.",
|
|
293
294
|
* values: ["JOIN", "START", "SUBSCRIBE"]
|
|
294
295
|
* },
|
|
295
296
|
* OPT_OUT: {
|
|
296
|
-
* message: "You
|
|
297
|
+
* message: "You have been unsubscribed. Reply START to rejoin.",
|
|
297
298
|
* values: ["STOP", "QUIT", "UNSUBSCRIBE"]
|
|
298
299
|
* }
|
|
299
300
|
* },
|
|
@@ -391,7 +392,7 @@ class Dlc {
|
|
|
391
392
|
* @example
|
|
392
393
|
* await client.campaigns.dlc.validate({
|
|
393
394
|
* additionalInfo: "Please validate this DLC campaign for 10DLC compliance",
|
|
394
|
-
* campaignId:
|
|
395
|
+
* campaignId: "dlc_1234567890"
|
|
395
396
|
* })
|
|
396
397
|
*/
|
|
397
398
|
validate(request, requestOptions) {
|
package/dist/cjs/api/resources/campaigns/resources/dlc/client/requests/UpsertDlcCampaignParams.d.ts
CHANGED
|
@@ -6,19 +6,19 @@ import * as Pinnacle from "../../../../../../index.js";
|
|
|
6
6
|
* @example
|
|
7
7
|
* {
|
|
8
8
|
* autoRenew: true,
|
|
9
|
-
* brand:
|
|
10
|
-
* campaignId:
|
|
9
|
+
* brand: "b_1234567890",
|
|
10
|
+
* campaignId: "dlc_1234567890",
|
|
11
11
|
* keywords: {
|
|
12
12
|
* HELP: {
|
|
13
13
|
* message: "Reply HELP for assistance, STOP to opt-out",
|
|
14
14
|
* values: ["HELP", "INFO", "SUPPORT"]
|
|
15
15
|
* },
|
|
16
16
|
* OPT_IN: {
|
|
17
|
-
* message: "Welcome
|
|
17
|
+
* message: "Welcome. You are now subscribed to Pinnacle.",
|
|
18
18
|
* values: ["JOIN", "START", "SUBSCRIBE"]
|
|
19
19
|
* },
|
|
20
20
|
* OPT_OUT: {
|
|
21
|
-
* message: "You
|
|
21
|
+
* message: "You have been unsubscribed. Reply START to rejoin.",
|
|
22
22
|
* values: ["STOP", "QUIT", "UNSUBSCRIBE"]
|
|
23
23
|
* }
|
|
24
24
|
* },
|
|
@@ -46,10 +46,10 @@ import * as Pinnacle from "../../../../../../index.js";
|
|
|
46
46
|
export interface UpsertDlcCampaignParams {
|
|
47
47
|
/** Whether the campaign renews automatically. */
|
|
48
48
|
autoRenew?: boolean;
|
|
49
|
-
/** Brand id. */
|
|
50
|
-
brand?:
|
|
51
|
-
/** Unique identifier for the campaign. */
|
|
52
|
-
campaignId?:
|
|
49
|
+
/** Brand id. This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`. */
|
|
50
|
+
brand?: string;
|
|
51
|
+
/** Unique identifier for the campaign. This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`. */
|
|
52
|
+
campaignId?: string;
|
|
53
53
|
/** Description of the campaign. */
|
|
54
54
|
description?: string;
|
|
55
55
|
/** Keyword response configuration. */
|
|
@@ -41,8 +41,8 @@ export declare class Rcs {
|
|
|
41
41
|
*
|
|
42
42
|
* @example
|
|
43
43
|
* await client.campaigns.rcs.autofill({
|
|
44
|
-
* additionalInfo: "Please autofill missing
|
|
45
|
-
* campaignId:
|
|
44
|
+
* additionalInfo: "Please autofill missing campaign fields using my brand profile",
|
|
45
|
+
* campaignId: "dlc_1234567890"
|
|
46
46
|
* })
|
|
47
47
|
*/
|
|
48
48
|
autofill(request: Pinnacle.AutofillCampaignParams, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.campaigns.RcsAutofillResponse>;
|
|
@@ -50,7 +50,7 @@ export declare class Rcs {
|
|
|
50
50
|
/**
|
|
51
51
|
* Retrieve RCS campaign.
|
|
52
52
|
*
|
|
53
|
-
* @param {
|
|
53
|
+
* @param {string} campaignId - Unique identifier of the RCS campaign. Must begin with the prefix `rcs_`.
|
|
54
54
|
* @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
|
|
55
55
|
*
|
|
56
56
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -59,14 +59,14 @@ export declare class Rcs {
|
|
|
59
59
|
* @throws {@link Pinnacle.InternalServerError}
|
|
60
60
|
*
|
|
61
61
|
* @example
|
|
62
|
-
* await client.campaigns.rcs.get(
|
|
62
|
+
* await client.campaigns.rcs.get("rcs_1234567890")
|
|
63
63
|
*/
|
|
64
|
-
get(campaignId:
|
|
64
|
+
get(campaignId: string, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.ExtendedRcsCampaign>;
|
|
65
65
|
private __get;
|
|
66
66
|
/**
|
|
67
67
|
* Submit your RCS campaign for approval and activation with carriers.
|
|
68
68
|
*
|
|
69
|
-
* @param {
|
|
69
|
+
* @param {string} campaignId - Unique identifier of the RCS campaign to retrieve. Must begin with the prefix `rcs_`.
|
|
70
70
|
* @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
|
|
71
71
|
*
|
|
72
72
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -76,9 +76,9 @@ export declare class Rcs {
|
|
|
76
76
|
* @throws {@link Pinnacle.InternalServerError}
|
|
77
77
|
*
|
|
78
78
|
* @example
|
|
79
|
-
* await client.campaigns.rcs.submit(
|
|
79
|
+
* await client.campaigns.rcs.submit("rcs_1234567890")
|
|
80
80
|
*/
|
|
81
|
-
submit(campaignId:
|
|
81
|
+
submit(campaignId: string, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignSubmissionResult>;
|
|
82
82
|
private __submit;
|
|
83
83
|
/**
|
|
84
84
|
* Create a new RCS campaign or updates an existing one. <br>
|
|
@@ -115,7 +115,8 @@ export declare class Rcs {
|
|
|
115
115
|
* }]
|
|
116
116
|
* },
|
|
117
117
|
* brandVerificationUrl: "https://www.pinnacle.sh/articles-of-incorporation.pdf",
|
|
118
|
-
* brand:
|
|
118
|
+
* brand: "b_1234567890",
|
|
119
|
+
* campaignId: "rcs_1234567890",
|
|
119
120
|
* 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."],
|
|
120
121
|
* links: {
|
|
121
122
|
* privacyPolicy: "https://www.trypinnacle.app/privacy",
|
|
@@ -150,7 +151,7 @@ export declare class Rcs {
|
|
|
150
151
|
* @example
|
|
151
152
|
* await client.campaigns.rcs.validate({
|
|
152
153
|
* additionalInfo: "Please validate this DLC campaign for 10DLC compliance",
|
|
153
|
-
* campaignId:
|
|
154
|
+
* campaignId: "dlc_1234567890"
|
|
154
155
|
* })
|
|
155
156
|
*/
|
|
156
157
|
validate(request: Pinnacle.ValidateCampaignParams, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignValidationResult>;
|
|
@@ -67,8 +67,8 @@ class Rcs {
|
|
|
67
67
|
*
|
|
68
68
|
* @example
|
|
69
69
|
* await client.campaigns.rcs.autofill({
|
|
70
|
-
* additionalInfo: "Please autofill missing
|
|
71
|
-
* campaignId:
|
|
70
|
+
* additionalInfo: "Please autofill missing campaign fields using my brand profile",
|
|
71
|
+
* campaignId: "dlc_1234567890"
|
|
72
72
|
* })
|
|
73
73
|
*/
|
|
74
74
|
autofill(request, requestOptions) {
|
|
@@ -132,7 +132,7 @@ class Rcs {
|
|
|
132
132
|
/**
|
|
133
133
|
* Retrieve RCS campaign.
|
|
134
134
|
*
|
|
135
|
-
* @param {
|
|
135
|
+
* @param {string} campaignId - Unique identifier of the RCS campaign. Must begin with the prefix `rcs_`.
|
|
136
136
|
* @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
|
|
137
137
|
*
|
|
138
138
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -141,7 +141,7 @@ class Rcs {
|
|
|
141
141
|
* @throws {@link Pinnacle.InternalServerError}
|
|
142
142
|
*
|
|
143
143
|
* @example
|
|
144
|
-
* await client.campaigns.rcs.get(
|
|
144
|
+
* await client.campaigns.rcs.get("rcs_1234567890")
|
|
145
145
|
*/
|
|
146
146
|
get(campaignId, requestOptions) {
|
|
147
147
|
return core.HttpResponsePromise.fromPromise(this.__get(campaignId, requestOptions));
|
|
@@ -200,7 +200,7 @@ class Rcs {
|
|
|
200
200
|
/**
|
|
201
201
|
* Submit your RCS campaign for approval and activation with carriers.
|
|
202
202
|
*
|
|
203
|
-
* @param {
|
|
203
|
+
* @param {string} campaignId - Unique identifier of the RCS campaign to retrieve. Must begin with the prefix `rcs_`.
|
|
204
204
|
* @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
|
|
205
205
|
*
|
|
206
206
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -210,7 +210,7 @@ class Rcs {
|
|
|
210
210
|
* @throws {@link Pinnacle.InternalServerError}
|
|
211
211
|
*
|
|
212
212
|
* @example
|
|
213
|
-
* await client.campaigns.rcs.submit(
|
|
213
|
+
* await client.campaigns.rcs.submit("rcs_1234567890")
|
|
214
214
|
*/
|
|
215
215
|
submit(campaignId, requestOptions) {
|
|
216
216
|
return core.HttpResponsePromise.fromPromise(this.__submit(campaignId, requestOptions));
|
|
@@ -303,7 +303,8 @@ class Rcs {
|
|
|
303
303
|
* }]
|
|
304
304
|
* },
|
|
305
305
|
* brandVerificationUrl: "https://www.pinnacle.sh/articles-of-incorporation.pdf",
|
|
306
|
-
* brand:
|
|
306
|
+
* brand: "b_1234567890",
|
|
307
|
+
* campaignId: "rcs_1234567890",
|
|
307
308
|
* 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."],
|
|
308
309
|
* links: {
|
|
309
310
|
* privacyPolicy: "https://www.trypinnacle.app/privacy",
|
|
@@ -393,7 +394,7 @@ class Rcs {
|
|
|
393
394
|
* @example
|
|
394
395
|
* await client.campaigns.rcs.validate({
|
|
395
396
|
* additionalInfo: "Please validate this DLC campaign for 10DLC compliance",
|
|
396
|
-
* campaignId:
|
|
397
|
+
* campaignId: "dlc_1234567890"
|
|
397
398
|
* })
|
|
398
399
|
*/
|
|
399
400
|
validate(request, requestOptions) {
|
package/dist/cjs/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.ts
CHANGED
|
@@ -25,7 +25,8 @@ import * as Pinnacle from "../../../../../../index.js";
|
|
|
25
25
|
* }]
|
|
26
26
|
* },
|
|
27
27
|
* brandVerificationUrl: "https://www.pinnacle.sh/articles-of-incorporation.pdf",
|
|
28
|
-
* brand:
|
|
28
|
+
* brand: "b_1234567890",
|
|
29
|
+
* campaignId: "rcs_1234567890",
|
|
29
30
|
* 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."],
|
|
30
31
|
* links: {
|
|
31
32
|
* privacyPolicy: "https://www.trypinnacle.app/privacy",
|
|
@@ -51,9 +52,9 @@ export interface UpsertRcsCampaignParams {
|
|
|
51
52
|
/** 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
53
|
brandVerificationUrl?: string;
|
|
53
54
|
/** Unique identifier for the brand. */
|
|
54
|
-
brand?:
|
|
55
|
+
brand?: string;
|
|
55
56
|
/** Unique identifier for the campaign. */
|
|
56
|
-
campaignId?:
|
|
57
|
+
campaignId?: string;
|
|
57
58
|
/** List of what the agent might say to users (1-5 required). */
|
|
58
59
|
expectedAgentResponses?: string[];
|
|
59
60
|
/** Legal documentation links. */
|
|
@@ -41,8 +41,8 @@ export declare class TollFree {
|
|
|
41
41
|
*
|
|
42
42
|
* @example
|
|
43
43
|
* await client.campaigns.tollFree.autofill({
|
|
44
|
-
* additionalInfo: "Please autofill missing
|
|
45
|
-
* campaignId:
|
|
44
|
+
* additionalInfo: "Please autofill missing campaign fields using my brand profile",
|
|
45
|
+
* campaignId: "dlc_1234567890"
|
|
46
46
|
* })
|
|
47
47
|
*/
|
|
48
48
|
autofill(request: Pinnacle.AutofillCampaignParams, requestOptions?: TollFree.RequestOptions): core.HttpResponsePromise<Pinnacle.campaigns.TollFreeAutofillResponse>;
|
|
@@ -50,7 +50,7 @@ export declare class TollFree {
|
|
|
50
50
|
/**
|
|
51
51
|
* Retrieve Toll-Free campaign.
|
|
52
52
|
*
|
|
53
|
-
* @param {
|
|
53
|
+
* @param {string} campaignId - Unique identifier of toll-free campaign. Must begin with the prefix `tf_`.
|
|
54
54
|
* @param {TollFree.RequestOptions} requestOptions - Request-specific configuration.
|
|
55
55
|
*
|
|
56
56
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -59,14 +59,14 @@ export declare class TollFree {
|
|
|
59
59
|
* @throws {@link Pinnacle.InternalServerError}
|
|
60
60
|
*
|
|
61
61
|
* @example
|
|
62
|
-
* await client.campaigns.tollFree.get(
|
|
62
|
+
* await client.campaigns.tollFree.get("tf_1234567890")
|
|
63
63
|
*/
|
|
64
|
-
get(campaignId:
|
|
64
|
+
get(campaignId: string, requestOptions?: TollFree.RequestOptions): core.HttpResponsePromise<Pinnacle.TollFreeCampaignWithExtendedBrandAndStatus>;
|
|
65
65
|
private __get;
|
|
66
66
|
/**
|
|
67
67
|
* Submit your toll-free campaign for approval and activation with carriers.
|
|
68
68
|
*
|
|
69
|
-
* @param {
|
|
69
|
+
* @param {string} campaignId - Unique identifier of the toll-free campaign to submit. Must begin with the prefix `tf_`.
|
|
70
70
|
* @param {TollFree.RequestOptions} requestOptions - Request-specific configuration.
|
|
71
71
|
*
|
|
72
72
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -75,9 +75,9 @@ export declare class TollFree {
|
|
|
75
75
|
* @throws {@link Pinnacle.InternalServerError}
|
|
76
76
|
*
|
|
77
77
|
* @example
|
|
78
|
-
* await client.campaigns.tollFree.submit(
|
|
78
|
+
* await client.campaigns.tollFree.submit("tf_1234567890")
|
|
79
79
|
*/
|
|
80
|
-
submit(campaignId:
|
|
80
|
+
submit(campaignId: string, requestOptions?: TollFree.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignSubmissionResult>;
|
|
81
81
|
private __submit;
|
|
82
82
|
/**
|
|
83
83
|
* Create a new toll-free campaign or updates an existing one.<br>
|
|
@@ -94,8 +94,8 @@ export declare class TollFree {
|
|
|
94
94
|
*
|
|
95
95
|
* @example
|
|
96
96
|
* await client.campaigns.tollFree.upsert({
|
|
97
|
-
* brand:
|
|
98
|
-
* campaignId:
|
|
97
|
+
* brand: "b_1234567890",
|
|
98
|
+
* campaignId: "tf_1234567890",
|
|
99
99
|
* monthlyVolume: "1,000",
|
|
100
100
|
* name: "Pinnacle",
|
|
101
101
|
* optIn: {
|
|
@@ -103,7 +103,7 @@ export declare class TollFree {
|
|
|
103
103
|
* url: "https://www.pinnacle.sh/",
|
|
104
104
|
* workflowDescription: "Visit https://www.pinnacle.sh/"
|
|
105
105
|
* },
|
|
106
|
-
* productionMessageContent: "Join Pinnacle
|
|
106
|
+
* productionMessageContent: "Join the Pinnacle workshop tomorrow and send your first RCS!",
|
|
107
107
|
* useCase: {
|
|
108
108
|
* summary: "Alerts clients about any Pinnacle hosted workshops.",
|
|
109
109
|
* value: "WORKSHOP_ALERTS"
|
|
@@ -125,7 +125,7 @@ export declare class TollFree {
|
|
|
125
125
|
* @example
|
|
126
126
|
* await client.campaigns.tollFree.validate({
|
|
127
127
|
* additionalInfo: "Please validate this DLC campaign for 10DLC compliance",
|
|
128
|
-
* campaignId:
|
|
128
|
+
* campaignId: "dlc_1234567890"
|
|
129
129
|
* })
|
|
130
130
|
*/
|
|
131
131
|
validate(request: Pinnacle.ValidateCampaignParams, requestOptions?: TollFree.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignValidationResult>;
|