rcs-js 2.0.1-rc.1 → 2.0.1
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 +2 -1
- 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 +3 -6
- package/dist/cjs/api/resources/campaigns/resources/dlc/client/Client.d.ts +13 -14
- package/dist/cjs/api/resources/campaigns/resources/dlc/client/Client.js +11 -12
- 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 +10 -11
- package/dist/cjs/api/resources/campaigns/resources/rcs/client/Client.js +8 -9
- package/dist/cjs/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.ts +3 -4
- 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 +2 -4
- package/dist/cjs/api/resources/contacts/client/Client.js +3 -5
- package/dist/cjs/api/resources/contacts/client/requests/ContactsGetRequest.d.ts +2 -4
- package/dist/cjs/api/resources/contacts/client/requests/UpdateContactParams.d.ts +3 -3
- package/dist/cjs/api/resources/conversations/client/Client.d.ts +4 -21
- package/dist/cjs/api/resources/conversations/client/Client.js +4 -99
- package/dist/cjs/api/resources/conversations/client/requests/ListConversationsParams.d.ts +6 -11
- package/dist/cjs/api/resources/conversations/client/requests/UpdateConversationParams.d.ts +3 -3
- package/dist/cjs/api/resources/conversations/client/requests/index.d.ts +0 -1
- package/dist/cjs/api/resources/conversations/index.d.ts +0 -1
- package/dist/cjs/api/resources/conversations/index.js +0 -1
- package/dist/cjs/api/resources/index.d.ts +1 -2
- package/dist/cjs/api/resources/index.js +2 -3
- 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 +3 -12
- 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/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 +1 -1
- package/dist/cjs/api/resources/tools/resources/file/client/Client.js +1 -1
- package/dist/cjs/api/resources/tools/resources/file/client/requests/RefreshFileParams.d.ts +11 -3
- 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 +2 -7
- 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 +1 -1
- package/dist/cjs/api/types/CampaignQuery.d.ts +1 -6
- 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 +4 -0
- package/dist/cjs/api/types/Message.d.ts +2 -2
- package/dist/cjs/api/types/MessageEvent.d.ts +4 -10
- 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/ValidateCampaignParams.d.ts +2 -7
- 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 +0 -3
- package/dist/cjs/api/types/index.js +0 -3
- 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 +2 -1
- 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 +3 -6
- package/dist/esm/api/resources/campaigns/resources/dlc/client/Client.d.mts +13 -14
- package/dist/esm/api/resources/campaigns/resources/dlc/client/Client.mjs +11 -12
- 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 +10 -11
- package/dist/esm/api/resources/campaigns/resources/rcs/client/Client.mjs +8 -9
- package/dist/esm/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.mts +3 -4
- 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 +2 -4
- package/dist/esm/api/resources/contacts/client/Client.mjs +3 -5
- package/dist/esm/api/resources/contacts/client/requests/ContactsGetRequest.d.mts +2 -4
- package/dist/esm/api/resources/contacts/client/requests/UpdateContactParams.d.mts +3 -3
- package/dist/esm/api/resources/conversations/client/Client.d.mts +4 -21
- package/dist/esm/api/resources/conversations/client/Client.mjs +4 -99
- package/dist/esm/api/resources/conversations/client/requests/ListConversationsParams.d.mts +6 -11
- package/dist/esm/api/resources/conversations/client/requests/UpdateConversationParams.d.mts +3 -3
- package/dist/esm/api/resources/conversations/client/requests/index.d.mts +0 -1
- package/dist/esm/api/resources/conversations/index.d.mts +0 -1
- package/dist/esm/api/resources/conversations/index.mjs +0 -1
- package/dist/esm/api/resources/index.d.mts +1 -2
- package/dist/esm/api/resources/index.mjs +1 -2
- 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 +3 -12
- 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/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 +1 -1
- package/dist/esm/api/resources/tools/resources/file/client/Client.mjs +1 -1
- package/dist/esm/api/resources/tools/resources/file/client/requests/RefreshFileParams.d.mts +11 -3
- 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 +2 -7
- 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 +1 -1
- package/dist/esm/api/types/CampaignQuery.d.mts +1 -6
- 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 +4 -0
- package/dist/esm/api/types/Message.d.mts +2 -2
- package/dist/esm/api/types/MessageEvent.d.mts +4 -10
- 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/ValidateCampaignParams.d.mts +2 -7
- 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 +0 -3
- package/dist/esm/api/types/index.mjs +0 -3
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +66 -144
- package/dist/cjs/api/resources/conversations/client/requests/ConversationsListMessagesRequest.d.ts +0 -36
- package/dist/cjs/api/resources/conversations/client/requests/ConversationsListMessagesRequest.js +0 -5
- package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestDirection.d.ts +0 -8
- package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestDirection.js +0 -10
- package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestSortOrder.d.ts +0 -8
- package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestSortOrder.js +0 -10
- package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestStatus.d.ts +0 -13
- package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestStatus.js +0 -15
- package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestType.d.ts +0 -9
- package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestType.js +0 -11
- package/dist/cjs/api/resources/conversations/types/index.d.ts +0 -4
- package/dist/cjs/api/resources/conversations/types/index.js +0 -20
- package/dist/cjs/api/types/MessageList.d.ts +0 -15
- package/dist/cjs/api/types/MessageList.js +0 -5
- package/dist/cjs/api/types/MessageWithReaction.d.ts +0 -27
- package/dist/cjs/api/types/MessageWithReaction.js +0 -13
- package/dist/cjs/api/types/NotFoundErrorBody.d.ts +0 -6
- package/dist/cjs/api/types/NotFoundErrorBody.js +0 -5
- package/dist/esm/api/resources/conversations/client/requests/ConversationsListMessagesRequest.d.mts +0 -36
- package/dist/esm/api/resources/conversations/client/requests/ConversationsListMessagesRequest.mjs +0 -4
- package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestDirection.d.mts +0 -8
- package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestDirection.mjs +0 -7
- package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestSortOrder.d.mts +0 -8
- package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestSortOrder.mjs +0 -7
- package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestStatus.d.mts +0 -13
- package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestStatus.mjs +0 -12
- package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestType.d.mts +0 -9
- package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestType.mjs +0 -8
- package/dist/esm/api/resources/conversations/types/index.d.mts +0 -4
- package/dist/esm/api/resources/conversations/types/index.mjs +0 -4
- package/dist/esm/api/types/MessageList.d.mts +0 -15
- package/dist/esm/api/types/MessageList.mjs +0 -4
- package/dist/esm/api/types/MessageWithReaction.d.mts +0 -27
- package/dist/esm/api/types/MessageWithReaction.mjs +0 -10
- package/dist/esm/api/types/NotFoundErrorBody.d.mts +0 -6
- package/dist/esm/api/types/NotFoundErrorBody.mjs +0 -4
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.1",
|
|
58
|
+
"User-Agent": "rcs-js/2.0.1",
|
|
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,7 +2,8 @@
|
|
|
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";
|
|
5
6
|
import * as core from "../../core/index.js";
|
|
6
7
|
export declare class NotFoundError extends errors.PinnacleError {
|
|
7
|
-
constructor(body
|
|
8
|
+
constructor(body: Pinnacle.Error_, rawResponse?: core.RawResponse);
|
|
8
9
|
}
|
|
@@ -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: 1,
|
|
78
78
|
* name: "Pinnacle",
|
|
79
79
|
* sector: "TECHNOLOGY",
|
|
80
80
|
* type: "PRIVATE_PROFIT",
|
|
@@ -86,8 +86,7 @@ export declare class Brands {
|
|
|
86
86
|
/**
|
|
87
87
|
* Retrieve detailed information for a specific brand in your account by ID.
|
|
88
88
|
*
|
|
89
|
-
* @param {
|
|
90
|
-
* <br><br> This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`.
|
|
89
|
+
* @param {number} id - ID of an existing brand in your account that you want to retrieve.
|
|
91
90
|
* @param {Pinnacle.BrandsGetRequest} request
|
|
92
91
|
* @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
|
|
93
92
|
*
|
|
@@ -97,15 +96,16 @@ export declare class Brands {
|
|
|
97
96
|
* @throws {@link Pinnacle.InternalServerError}
|
|
98
97
|
*
|
|
99
98
|
* @example
|
|
100
|
-
* await client.brands.get(
|
|
99
|
+
* await client.brands.get(1)
|
|
101
100
|
*/
|
|
102
|
-
get(id:
|
|
101
|
+
get(id: number, request?: Pinnacle.BrandsGetRequest, requestOptions?: Brands.RequestOptions): core.HttpResponsePromise<Pinnacle.ExtendedBrandWithVetting>;
|
|
103
102
|
private __get;
|
|
104
103
|
/**
|
|
105
104
|
* Submit your brand for review and approval by the compliance team.
|
|
106
105
|
*
|
|
107
|
-
* @param {
|
|
108
|
-
*
|
|
106
|
+
* @param {number} brandId - The unique identifier of the brand you want to submit for review. <br>
|
|
107
|
+
*
|
|
108
|
+
* 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(1)
|
|
120
120
|
*/
|
|
121
|
-
submit(brandId:
|
|
121
|
+
submit(brandId: number, 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 {number} brandId - The unique identifier of the brand to vet. <br>
|
|
158
158
|
*
|
|
159
|
-
*
|
|
159
|
+
* The brand must be already registered before it can be vetted.
|
|
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(1, {})
|
|
172
172
|
*/
|
|
173
|
-
vet(brandId:
|
|
173
|
+
vet(brandId: number, 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: 1,
|
|
157
157
|
* name: "Pinnacle",
|
|
158
158
|
* sector: "TECHNOLOGY",
|
|
159
159
|
* type: "PRIVATE_PROFIT",
|
|
@@ -218,8 +218,7 @@ class Brands {
|
|
|
218
218
|
/**
|
|
219
219
|
* Retrieve detailed information for a specific brand in your account by ID.
|
|
220
220
|
*
|
|
221
|
-
* @param {
|
|
222
|
-
* <br><br> This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`.
|
|
221
|
+
* @param {number} id - ID of an existing brand in your account that you want to retrieve.
|
|
223
222
|
* @param {Pinnacle.BrandsGetRequest} request
|
|
224
223
|
* @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
|
|
225
224
|
*
|
|
@@ -229,7 +228,7 @@ class Brands {
|
|
|
229
228
|
* @throws {@link Pinnacle.InternalServerError}
|
|
230
229
|
*
|
|
231
230
|
* @example
|
|
232
|
-
* await client.brands.get(
|
|
231
|
+
* await client.brands.get(1)
|
|
233
232
|
*/
|
|
234
233
|
get(id, request = {}, requestOptions) {
|
|
235
234
|
return core.HttpResponsePromise.fromPromise(this.__get(id, request, requestOptions));
|
|
@@ -293,8 +292,9 @@ class Brands {
|
|
|
293
292
|
/**
|
|
294
293
|
* Submit your brand for review and approval by the compliance team.
|
|
295
294
|
*
|
|
296
|
-
* @param {
|
|
297
|
-
*
|
|
295
|
+
* @param {number} brandId - The unique identifier of the brand you want to submit for review. <br>
|
|
296
|
+
*
|
|
297
|
+
* 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(1)
|
|
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 {number} brandId - The unique identifier of the brand to vet. <br>
|
|
456
456
|
*
|
|
457
|
-
*
|
|
457
|
+
* The brand must be already registered before it can be vetted.
|
|
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(1, {})
|
|
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: 1,
|
|
20
20
|
* name: "Pinnacle",
|
|
21
21
|
* sector: "TECHNOLOGY",
|
|
22
22
|
* type: "PRIVATE_PROFIT",
|
|
@@ -36,11 +36,8 @@ export interface UpsertBrandParams {
|
|
|
36
36
|
ein?: string | null;
|
|
37
37
|
/** Main contact email address for the brand. */
|
|
38
38
|
email?: string | null;
|
|
39
|
-
/**
|
|
40
|
-
|
|
41
|
-
* <br><br> This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`.
|
|
42
|
-
*/
|
|
43
|
-
id?: string;
|
|
39
|
+
/** Brand ID - include only when updating an existing brand, omit to create a new one. */
|
|
40
|
+
id?: number;
|
|
44
41
|
/** Legal name of the brand as registered. */
|
|
45
42
|
name?: string | null;
|
|
46
43
|
/** 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 campaign fields using my brand profile",
|
|
45
|
-
* campaignId:
|
|
44
|
+
* additionalInfo: "Please autofill missing DLC campaign fields using my brand profile",
|
|
45
|
+
* campaignId: 161
|
|
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 {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}
|
|
@@ -59,15 +59,14 @@ 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(28)
|
|
63
63
|
*/
|
|
64
|
-
get(campaignId:
|
|
64
|
+
get(campaignId: number, 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 {
|
|
70
|
-
* <br><br> This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`.
|
|
69
|
+
* @param {number} campaignId - Unique identifier of the 10DLC campaign to submit.
|
|
71
70
|
* @param {Dlc.RequestOptions} requestOptions - Request-specific configuration.
|
|
72
71
|
*
|
|
73
72
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -76,9 +75,9 @@ export declare class Dlc {
|
|
|
76
75
|
* @throws {@link Pinnacle.InternalServerError}
|
|
77
76
|
*
|
|
78
77
|
* @example
|
|
79
|
-
* await client.campaigns.dlc.submit(
|
|
78
|
+
* await client.campaigns.dlc.submit(161)
|
|
80
79
|
*/
|
|
81
|
-
submit(campaignId:
|
|
80
|
+
submit(campaignId: number, requestOptions?: Dlc.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignSubmissionResult>;
|
|
82
81
|
private __submit;
|
|
83
82
|
/**
|
|
84
83
|
* Create a new 10DLC campaign or updates an existing one. <br>
|
|
@@ -96,19 +95,19 @@ export declare class Dlc {
|
|
|
96
95
|
* @example
|
|
97
96
|
* await client.campaigns.dlc.upsert({
|
|
98
97
|
* autoRenew: true,
|
|
99
|
-
* brand:
|
|
100
|
-
* campaignId:
|
|
98
|
+
* brand: 1,
|
|
99
|
+
* campaignId: 161,
|
|
101
100
|
* keywords: {
|
|
102
101
|
* HELP: {
|
|
103
102
|
* message: "Reply HELP for assistance, STOP to opt-out",
|
|
104
103
|
* values: ["HELP", "INFO", "SUPPORT"]
|
|
105
104
|
* },
|
|
106
105
|
* OPT_IN: {
|
|
107
|
-
* message: "Welcome
|
|
106
|
+
* message: "Welcome! You're now subscribed to Pinnacle.",
|
|
108
107
|
* values: ["JOIN", "START", "SUBSCRIBE"]
|
|
109
108
|
* },
|
|
110
109
|
* OPT_OUT: {
|
|
111
|
-
* message: "You
|
|
110
|
+
* message: "You've been unsubscribed. Reply START to rejoin.",
|
|
112
111
|
* values: ["STOP", "QUIT", "UNSUBSCRIBE"]
|
|
113
112
|
* }
|
|
114
113
|
* },
|
|
@@ -148,7 +147,7 @@ export declare class Dlc {
|
|
|
148
147
|
* @example
|
|
149
148
|
* await client.campaigns.dlc.validate({
|
|
150
149
|
* additionalInfo: "Please validate this DLC campaign for 10DLC compliance",
|
|
151
|
-
* campaignId:
|
|
150
|
+
* campaignId: 161
|
|
152
151
|
* })
|
|
153
152
|
*/
|
|
154
153
|
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 campaign fields using my brand profile",
|
|
71
|
-
* campaignId:
|
|
70
|
+
* additionalInfo: "Please autofill missing DLC campaign fields using my brand profile",
|
|
71
|
+
* campaignId: 161
|
|
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 {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}
|
|
@@ -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(28)
|
|
142
142
|
*/
|
|
143
143
|
get(campaignId, requestOptions) {
|
|
144
144
|
return core.HttpResponsePromise.fromPromise(this.__get(campaignId, requestOptions));
|
|
@@ -200,8 +200,7 @@ class Dlc {
|
|
|
200
200
|
/**
|
|
201
201
|
* Submit your 10DLC campaign for approval and activation with carriers.
|
|
202
202
|
*
|
|
203
|
-
* @param {
|
|
204
|
-
* <br><br> This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`.
|
|
203
|
+
* @param {number} campaignId - Unique identifier of the 10DLC campaign to submit.
|
|
205
204
|
* @param {Dlc.RequestOptions} requestOptions - Request-specific configuration.
|
|
206
205
|
*
|
|
207
206
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -210,7 +209,7 @@ class Dlc {
|
|
|
210
209
|
* @throws {@link Pinnacle.InternalServerError}
|
|
211
210
|
*
|
|
212
211
|
* @example
|
|
213
|
-
* await client.campaigns.dlc.submit(
|
|
212
|
+
* await client.campaigns.dlc.submit(161)
|
|
214
213
|
*/
|
|
215
214
|
submit(campaignId, requestOptions) {
|
|
216
215
|
return core.HttpResponsePromise.fromPromise(this.__submit(campaignId, requestOptions));
|
|
@@ -282,19 +281,19 @@ class Dlc {
|
|
|
282
281
|
* @example
|
|
283
282
|
* await client.campaigns.dlc.upsert({
|
|
284
283
|
* autoRenew: true,
|
|
285
|
-
* brand:
|
|
286
|
-
* campaignId:
|
|
284
|
+
* brand: 1,
|
|
285
|
+
* campaignId: 161,
|
|
287
286
|
* keywords: {
|
|
288
287
|
* HELP: {
|
|
289
288
|
* message: "Reply HELP for assistance, STOP to opt-out",
|
|
290
289
|
* values: ["HELP", "INFO", "SUPPORT"]
|
|
291
290
|
* },
|
|
292
291
|
* OPT_IN: {
|
|
293
|
-
* message: "Welcome
|
|
292
|
+
* message: "Welcome! You're now subscribed to Pinnacle.",
|
|
294
293
|
* values: ["JOIN", "START", "SUBSCRIBE"]
|
|
295
294
|
* },
|
|
296
295
|
* OPT_OUT: {
|
|
297
|
-
* message: "You
|
|
296
|
+
* message: "You've been unsubscribed. Reply START to rejoin.",
|
|
298
297
|
* values: ["STOP", "QUIT", "UNSUBSCRIBE"]
|
|
299
298
|
* }
|
|
300
299
|
* },
|
|
@@ -392,7 +391,7 @@ class Dlc {
|
|
|
392
391
|
* @example
|
|
393
392
|
* await client.campaigns.dlc.validate({
|
|
394
393
|
* additionalInfo: "Please validate this DLC campaign for 10DLC compliance",
|
|
395
|
-
* campaignId:
|
|
394
|
+
* campaignId: 161
|
|
396
395
|
* })
|
|
397
396
|
*/
|
|
398
397
|
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: 1,
|
|
10
|
+
* campaignId: 161,
|
|
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're now subscribed to Pinnacle.",
|
|
18
18
|
* values: ["JOIN", "START", "SUBSCRIBE"]
|
|
19
19
|
* },
|
|
20
20
|
* OPT_OUT: {
|
|
21
|
-
* message: "You
|
|
21
|
+
* message: "You've 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. */
|
|
50
|
+
brand?: number;
|
|
51
|
+
/** Unique identifier for the campaign. */
|
|
52
|
+
campaignId?: number;
|
|
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 campaign fields using my brand profile",
|
|
45
|
-
* campaignId:
|
|
44
|
+
* additionalInfo: "Please autofill missing DLC campaign fields using my brand profile",
|
|
45
|
+
* campaignId: 161
|
|
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 {number} campaignId - Unique identifier of the RCS campaign.
|
|
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(161)
|
|
63
63
|
*/
|
|
64
|
-
get(campaignId:
|
|
64
|
+
get(campaignId: number, 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 {number} campaignId - Unique identifier of the RCS campaign to retrieve.
|
|
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(161)
|
|
80
80
|
*/
|
|
81
|
-
submit(campaignId:
|
|
81
|
+
submit(campaignId: number, 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,8 +115,7 @@ export declare class Rcs {
|
|
|
115
115
|
* }]
|
|
116
116
|
* },
|
|
117
117
|
* brandVerificationUrl: "https://www.pinnacle.sh/articles-of-incorporation.pdf",
|
|
118
|
-
* brand:
|
|
119
|
-
* campaignId: "rcs_1234567890",
|
|
118
|
+
* brand: 2,
|
|
120
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."],
|
|
121
120
|
* links: {
|
|
122
121
|
* privacyPolicy: "https://www.trypinnacle.app/privacy",
|
|
@@ -151,7 +150,7 @@ export declare class Rcs {
|
|
|
151
150
|
* @example
|
|
152
151
|
* await client.campaigns.rcs.validate({
|
|
153
152
|
* additionalInfo: "Please validate this DLC campaign for 10DLC compliance",
|
|
154
|
-
* campaignId:
|
|
153
|
+
* campaignId: 161
|
|
155
154
|
* })
|
|
156
155
|
*/
|
|
157
156
|
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 campaign fields using my brand profile",
|
|
71
|
-
* campaignId:
|
|
70
|
+
* additionalInfo: "Please autofill missing DLC campaign fields using my brand profile",
|
|
71
|
+
* campaignId: 161
|
|
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 {number} campaignId - Unique identifier of the RCS campaign.
|
|
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(161)
|
|
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 {number} campaignId - Unique identifier of the RCS campaign to retrieve.
|
|
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(161)
|
|
214
214
|
*/
|
|
215
215
|
submit(campaignId, requestOptions) {
|
|
216
216
|
return core.HttpResponsePromise.fromPromise(this.__submit(campaignId, requestOptions));
|
|
@@ -303,8 +303,7 @@ class Rcs {
|
|
|
303
303
|
* }]
|
|
304
304
|
* },
|
|
305
305
|
* brandVerificationUrl: "https://www.pinnacle.sh/articles-of-incorporation.pdf",
|
|
306
|
-
* brand:
|
|
307
|
-
* campaignId: "rcs_1234567890",
|
|
306
|
+
* brand: 2,
|
|
308
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."],
|
|
309
308
|
* links: {
|
|
310
309
|
* privacyPolicy: "https://www.trypinnacle.app/privacy",
|
|
@@ -394,7 +393,7 @@ class Rcs {
|
|
|
394
393
|
* @example
|
|
395
394
|
* await client.campaigns.rcs.validate({
|
|
396
395
|
* additionalInfo: "Please validate this DLC campaign for 10DLC compliance",
|
|
397
|
-
* campaignId:
|
|
396
|
+
* campaignId: 161
|
|
398
397
|
* })
|
|
399
398
|
*/
|
|
400
399
|
validate(request, requestOptions) {
|
package/dist/cjs/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.ts
CHANGED
|
@@ -25,8 +25,7 @@ import * as Pinnacle from "../../../../../../index.js";
|
|
|
25
25
|
* }]
|
|
26
26
|
* },
|
|
27
27
|
* brandVerificationUrl: "https://www.pinnacle.sh/articles-of-incorporation.pdf",
|
|
28
|
-
* brand:
|
|
29
|
-
* campaignId: "rcs_1234567890",
|
|
28
|
+
* brand: 2,
|
|
30
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."],
|
|
31
30
|
* links: {
|
|
32
31
|
* privacyPolicy: "https://www.trypinnacle.app/privacy",
|
|
@@ -52,9 +51,9 @@ export interface UpsertRcsCampaignParams {
|
|
|
52
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. */
|
|
53
52
|
brandVerificationUrl?: string;
|
|
54
53
|
/** Unique identifier for the brand. */
|
|
55
|
-
brand?:
|
|
54
|
+
brand?: number;
|
|
56
55
|
/** Unique identifier for the campaign. */
|
|
57
|
-
campaignId?:
|
|
56
|
+
campaignId?: number;
|
|
58
57
|
/** List of what the agent might say to users (1-5 required). */
|
|
59
58
|
expectedAgentResponses?: string[];
|
|
60
59
|
/** 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 campaign fields using my brand profile",
|
|
45
|
-
* campaignId:
|
|
44
|
+
* additionalInfo: "Please autofill missing DLC campaign fields using my brand profile",
|
|
45
|
+
* campaignId: 161
|
|
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 {number} campaignId - Unique identifier of toll-free campaign.
|
|
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(161)
|
|
63
63
|
*/
|
|
64
|
-
get(campaignId:
|
|
64
|
+
get(campaignId: number, 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 {number} campaignId - Unique identifier of the toll-free campaign to submit.
|
|
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(161)
|
|
79
79
|
*/
|
|
80
|
-
submit(campaignId:
|
|
80
|
+
submit(campaignId: number, 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: 2,
|
|
98
|
+
* campaignId: 161,
|
|
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
|
|
106
|
+
* productionMessageContent: "Join Pinnacle's 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: 161
|
|
129
129
|
* })
|
|
130
130
|
*/
|
|
131
131
|
validate(request: Pinnacle.ValidateCampaignParams, requestOptions?: TollFree.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignValidationResult>;
|