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
|
@@ -67,8 +67,8 @@ class TollFree {
|
|
|
67
67
|
*
|
|
68
68
|
* @example
|
|
69
69
|
* await client.campaigns.tollFree.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 TollFree {
|
|
|
132
132
|
/**
|
|
133
133
|
* Retrieve Toll-Free campaign.
|
|
134
134
|
*
|
|
135
|
-
* @param {
|
|
135
|
+
* @param {number} campaignId - Unique identifier of toll-free campaign.
|
|
136
136
|
* @param {TollFree.RequestOptions} requestOptions - Request-specific configuration.
|
|
137
137
|
*
|
|
138
138
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -141,7 +141,7 @@ class TollFree {
|
|
|
141
141
|
* @throws {@link Pinnacle.InternalServerError}
|
|
142
142
|
*
|
|
143
143
|
* @example
|
|
144
|
-
* await client.campaigns.tollFree.get(
|
|
144
|
+
* await client.campaigns.tollFree.get(161)
|
|
145
145
|
*/
|
|
146
146
|
get(campaignId, requestOptions) {
|
|
147
147
|
return core.HttpResponsePromise.fromPromise(this.__get(campaignId, requestOptions));
|
|
@@ -203,7 +203,7 @@ class TollFree {
|
|
|
203
203
|
/**
|
|
204
204
|
* Submit your toll-free campaign for approval and activation with carriers.
|
|
205
205
|
*
|
|
206
|
-
* @param {
|
|
206
|
+
* @param {number} campaignId - Unique identifier of the toll-free campaign to submit.
|
|
207
207
|
* @param {TollFree.RequestOptions} requestOptions - Request-specific configuration.
|
|
208
208
|
*
|
|
209
209
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -212,7 +212,7 @@ class TollFree {
|
|
|
212
212
|
* @throws {@link Pinnacle.InternalServerError}
|
|
213
213
|
*
|
|
214
214
|
* @example
|
|
215
|
-
* await client.campaigns.tollFree.submit(
|
|
215
|
+
* await client.campaigns.tollFree.submit(161)
|
|
216
216
|
*/
|
|
217
217
|
submit(campaignId, requestOptions) {
|
|
218
218
|
return core.HttpResponsePromise.fromPromise(this.__submit(campaignId, requestOptions));
|
|
@@ -283,8 +283,8 @@ class TollFree {
|
|
|
283
283
|
*
|
|
284
284
|
* @example
|
|
285
285
|
* await client.campaigns.tollFree.upsert({
|
|
286
|
-
* brand:
|
|
287
|
-
* campaignId:
|
|
286
|
+
* brand: 2,
|
|
287
|
+
* campaignId: 161,
|
|
288
288
|
* monthlyVolume: "1,000",
|
|
289
289
|
* name: "Pinnacle",
|
|
290
290
|
* optIn: {
|
|
@@ -292,7 +292,7 @@ class TollFree {
|
|
|
292
292
|
* url: "https://www.pinnacle.sh/",
|
|
293
293
|
* workflowDescription: "Visit https://www.pinnacle.sh/"
|
|
294
294
|
* },
|
|
295
|
-
* productionMessageContent: "Join
|
|
295
|
+
* productionMessageContent: "Join Pinnacle's workshop tomorrow and send your first RCS!",
|
|
296
296
|
* useCase: {
|
|
297
297
|
* summary: "Alerts clients about any Pinnacle hosted workshops.",
|
|
298
298
|
* value: "WORKSHOP_ALERTS"
|
|
@@ -372,7 +372,7 @@ class TollFree {
|
|
|
372
372
|
* @example
|
|
373
373
|
* await client.campaigns.tollFree.validate({
|
|
374
374
|
* additionalInfo: "Please validate this DLC campaign for 10DLC compliance",
|
|
375
|
-
* campaignId:
|
|
375
|
+
* campaignId: 161
|
|
376
376
|
* })
|
|
377
377
|
*/
|
|
378
378
|
validate(request, requestOptions) {
|
|
@@ -5,8 +5,8 @@ import * as Pinnacle from "../../../../../../index.js";
|
|
|
5
5
|
/**
|
|
6
6
|
* @example
|
|
7
7
|
* {
|
|
8
|
-
* brand:
|
|
9
|
-
* campaignId:
|
|
8
|
+
* brand: 2,
|
|
9
|
+
* campaignId: 161,
|
|
10
10
|
* monthlyVolume: "1,000",
|
|
11
11
|
* name: "Pinnacle",
|
|
12
12
|
* optIn: {
|
|
@@ -14,7 +14,7 @@ import * as Pinnacle from "../../../../../../index.js";
|
|
|
14
14
|
* url: "https://www.pinnacle.sh/",
|
|
15
15
|
* workflowDescription: "Visit https://www.pinnacle.sh/"
|
|
16
16
|
* },
|
|
17
|
-
* productionMessageContent: "Join
|
|
17
|
+
* productionMessageContent: "Join Pinnacle's workshop tomorrow and send your first RCS!",
|
|
18
18
|
* useCase: {
|
|
19
19
|
* summary: "Alerts clients about any Pinnacle hosted workshops.",
|
|
20
20
|
* value: "WORKSHOP_ALERTS"
|
|
@@ -22,10 +22,10 @@ import * as Pinnacle from "../../../../../../index.js";
|
|
|
22
22
|
* }
|
|
23
23
|
*/
|
|
24
24
|
export interface UpsertTollFreeCampaignParams {
|
|
25
|
-
/** Brand id.
|
|
26
|
-
brand?:
|
|
27
|
-
/** Unique identifier for the campaign.
|
|
28
|
-
campaignId?:
|
|
25
|
+
/** Brand id. */
|
|
26
|
+
brand?: number;
|
|
27
|
+
/** Unique identifier for the campaign. */
|
|
28
|
+
campaignId?: number;
|
|
29
29
|
monthlyVolume?: Pinnacle.MessageVolumeEnum;
|
|
30
30
|
/** Display name of the campaign. */
|
|
31
31
|
name?: string;
|
|
@@ -41,9 +41,7 @@ export declare class Contacts {
|
|
|
41
41
|
* @throws {@link Pinnacle.InternalServerError}
|
|
42
42
|
*
|
|
43
43
|
* @example
|
|
44
|
-
* await client.contacts.get(
|
|
45
|
-
* id: "co_1234567890"
|
|
46
|
-
* })
|
|
44
|
+
* await client.contacts.get()
|
|
47
45
|
*/
|
|
48
46
|
get(request?: Pinnacle.ContactsGetRequest, requestOptions?: Contacts.RequestOptions): core.HttpResponsePromise<Pinnacle.Contact>;
|
|
49
47
|
private __get;
|
|
@@ -81,7 +79,7 @@ export declare class Contacts {
|
|
|
81
79
|
* email: "alvaroopedtech@pinnacle.sh",
|
|
82
80
|
* name: "Retired Bestie",
|
|
83
81
|
* tags: ["friend"],
|
|
84
|
-
* id:
|
|
82
|
+
* id: 137
|
|
85
83
|
* })
|
|
86
84
|
*/
|
|
87
85
|
update(request: Pinnacle.UpdateContactParams, requestOptions?: Contacts.RequestOptions): core.HttpResponsePromise<Pinnacle.UpdatedContactId>;
|
|
@@ -67,9 +67,7 @@ class Contacts {
|
|
|
67
67
|
* @throws {@link Pinnacle.InternalServerError}
|
|
68
68
|
*
|
|
69
69
|
* @example
|
|
70
|
-
* await client.contacts.get(
|
|
71
|
-
* id: "co_1234567890"
|
|
72
|
-
* })
|
|
70
|
+
* await client.contacts.get()
|
|
73
71
|
*/
|
|
74
72
|
get(request = {}, requestOptions) {
|
|
75
73
|
return core.HttpResponsePromise.fromPromise(this.__get(request, requestOptions));
|
|
@@ -80,7 +78,7 @@ class Contacts {
|
|
|
80
78
|
const { id, phoneNumber } = request;
|
|
81
79
|
const _queryParams = {};
|
|
82
80
|
if (id != null) {
|
|
83
|
-
_queryParams["id"] = id;
|
|
81
|
+
_queryParams["id"] = id.toString();
|
|
84
82
|
}
|
|
85
83
|
if (phoneNumber != null) {
|
|
86
84
|
_queryParams["phoneNumber"] = phoneNumber;
|
|
@@ -220,7 +218,7 @@ class Contacts {
|
|
|
220
218
|
* email: "alvaroopedtech@pinnacle.sh",
|
|
221
219
|
* name: "Retired Bestie",
|
|
222
220
|
* tags: ["friend"],
|
|
223
|
-
* id:
|
|
221
|
+
* id: 137
|
|
224
222
|
* })
|
|
225
223
|
*/
|
|
226
224
|
update(request, requestOptions) {
|
|
@@ -3,9 +3,7 @@
|
|
|
3
3
|
*/
|
|
4
4
|
/**
|
|
5
5
|
* @example
|
|
6
|
-
* {
|
|
7
|
-
* id: "co_1234567890"
|
|
8
|
-
* }
|
|
6
|
+
* {}
|
|
9
7
|
*/
|
|
10
8
|
export interface ContactsGetRequest {
|
|
11
9
|
/**
|
|
@@ -13,7 +11,7 @@ export interface ContactsGetRequest {
|
|
|
13
11
|
*
|
|
14
12
|
* Either this parameter or `phoneNumber` must be provided, but not both.
|
|
15
13
|
*/
|
|
16
|
-
id?:
|
|
14
|
+
id?: number;
|
|
17
15
|
/** Phone number you want to look up contact information for, provided in URL-encoded E.164 format with %2B prefix instead of +. */
|
|
18
16
|
phoneNumber?: string;
|
|
19
17
|
}
|
|
@@ -9,10 +9,10 @@ import * as Pinnacle from "../../../../index.js";
|
|
|
9
9
|
* email: "alvaroopedtech@pinnacle.sh",
|
|
10
10
|
* name: "Retired Bestie",
|
|
11
11
|
* tags: ["friend"],
|
|
12
|
-
* id:
|
|
12
|
+
* id: 137
|
|
13
13
|
* }
|
|
14
14
|
*/
|
|
15
15
|
export interface UpdateContactParams extends Pinnacle.OptionalContact {
|
|
16
|
-
/** ID of the contact you want to update.
|
|
17
|
-
id:
|
|
16
|
+
/** ID of the contact you want to update. */
|
|
17
|
+
id: number;
|
|
18
18
|
}
|
|
@@ -41,7 +41,7 @@ export declare class Conversations {
|
|
|
41
41
|
*
|
|
42
42
|
* @example
|
|
43
43
|
* await client.conversations.get({
|
|
44
|
-
* id:
|
|
44
|
+
* id: 1
|
|
45
45
|
* })
|
|
46
46
|
*/
|
|
47
47
|
get(request: Pinnacle.GetConversationParams, requestOptions?: Conversations.RequestOptions): core.HttpResponsePromise<Pinnacle.Conversation | null>;
|
|
@@ -58,8 +58,8 @@ export declare class Conversations {
|
|
|
58
58
|
*
|
|
59
59
|
* @example
|
|
60
60
|
* await client.conversations.list({
|
|
61
|
-
* brandId:
|
|
62
|
-
* campaignId:
|
|
61
|
+
* brandId: 101,
|
|
62
|
+
* campaignId: 136,
|
|
63
63
|
* campaignType: "TOLL_FREE",
|
|
64
64
|
* pageIndex: 0,
|
|
65
65
|
* pageSize: 20,
|
|
@@ -81,29 +81,12 @@ export declare class Conversations {
|
|
|
81
81
|
*
|
|
82
82
|
* @example
|
|
83
83
|
* await client.conversations.update({
|
|
84
|
-
* id:
|
|
84
|
+
* id: 123,
|
|
85
85
|
* notes: "Follow-up completed. Customer satisfied with resolution."
|
|
86
86
|
* })
|
|
87
87
|
*/
|
|
88
88
|
update(request: Pinnacle.UpdateConversationParams, requestOptions?: Conversations.RequestOptions): core.HttpResponsePromise<Pinnacle.SuccessfulConversationUpdate>;
|
|
89
89
|
private __update;
|
|
90
|
-
/**
|
|
91
|
-
* Retrieve a paginated and filtered list of messages for a specific conversation.
|
|
92
|
-
*
|
|
93
|
-
* @param {string} id - Unique identifier of the conversation. This identifier is a string that always begins with the prefix `conv_`, for example: `conv_1234567890`.
|
|
94
|
-
* @param {Pinnacle.ConversationsListMessagesRequest} request
|
|
95
|
-
* @param {Conversations.RequestOptions} requestOptions - Request-specific configuration.
|
|
96
|
-
*
|
|
97
|
-
* @throws {@link Pinnacle.BadRequestError}
|
|
98
|
-
* @throws {@link Pinnacle.UnauthorizedError}
|
|
99
|
-
* @throws {@link Pinnacle.NotFoundError}
|
|
100
|
-
* @throws {@link Pinnacle.InternalServerError}
|
|
101
|
-
*
|
|
102
|
-
* @example
|
|
103
|
-
* await client.conversations.listMessages("id")
|
|
104
|
-
*/
|
|
105
|
-
listMessages(id: string, request?: Pinnacle.ConversationsListMessagesRequest, requestOptions?: Conversations.RequestOptions): core.HttpResponsePromise<Pinnacle.MessageList>;
|
|
106
|
-
private __listMessages;
|
|
107
90
|
protected _getCustomAuthorizationHeaders(): Promise<{
|
|
108
91
|
"PINNACLE-API-KEY": string | undefined;
|
|
109
92
|
}>;
|
|
@@ -67,7 +67,7 @@ class Conversations {
|
|
|
67
67
|
*
|
|
68
68
|
* @example
|
|
69
69
|
* await client.conversations.get({
|
|
70
|
-
* id:
|
|
70
|
+
* id: 1
|
|
71
71
|
* })
|
|
72
72
|
*/
|
|
73
73
|
get(request, requestOptions) {
|
|
@@ -137,8 +137,8 @@ class Conversations {
|
|
|
137
137
|
*
|
|
138
138
|
* @example
|
|
139
139
|
* await client.conversations.list({
|
|
140
|
-
* brandId:
|
|
141
|
-
* campaignId:
|
|
140
|
+
* brandId: 101,
|
|
141
|
+
* campaignId: 136,
|
|
142
142
|
* campaignType: "TOLL_FREE",
|
|
143
143
|
* pageIndex: 0,
|
|
144
144
|
* pageSize: 20,
|
|
@@ -213,7 +213,7 @@ class Conversations {
|
|
|
213
213
|
*
|
|
214
214
|
* @example
|
|
215
215
|
* await client.conversations.update({
|
|
216
|
-
* id:
|
|
216
|
+
* id: 123,
|
|
217
217
|
* notes: "Follow-up completed. Customer satisfied with resolution."
|
|
218
218
|
* })
|
|
219
219
|
*/
|
|
@@ -275,101 +275,6 @@ class Conversations {
|
|
|
275
275
|
}
|
|
276
276
|
});
|
|
277
277
|
}
|
|
278
|
-
/**
|
|
279
|
-
* Retrieve a paginated and filtered list of messages for a specific conversation.
|
|
280
|
-
*
|
|
281
|
-
* @param {string} id - Unique identifier of the conversation. This identifier is a string that always begins with the prefix `conv_`, for example: `conv_1234567890`.
|
|
282
|
-
* @param {Pinnacle.ConversationsListMessagesRequest} request
|
|
283
|
-
* @param {Conversations.RequestOptions} requestOptions - Request-specific configuration.
|
|
284
|
-
*
|
|
285
|
-
* @throws {@link Pinnacle.BadRequestError}
|
|
286
|
-
* @throws {@link Pinnacle.UnauthorizedError}
|
|
287
|
-
* @throws {@link Pinnacle.NotFoundError}
|
|
288
|
-
* @throws {@link Pinnacle.InternalServerError}
|
|
289
|
-
*
|
|
290
|
-
* @example
|
|
291
|
-
* await client.conversations.listMessages("id")
|
|
292
|
-
*/
|
|
293
|
-
listMessages(id, request = {}, requestOptions) {
|
|
294
|
-
return core.HttpResponsePromise.fromPromise(this.__listMessages(id, request, requestOptions));
|
|
295
|
-
}
|
|
296
|
-
__listMessages(id_1) {
|
|
297
|
-
return __awaiter(this, arguments, void 0, function* (id, request = {}, requestOptions) {
|
|
298
|
-
var _a, _b, _c;
|
|
299
|
-
const { pageIndex, pageSize, sortOrder, direction, status, type: type_, dateFrom, dateTo } = request;
|
|
300
|
-
const _queryParams = {};
|
|
301
|
-
if (pageIndex != null) {
|
|
302
|
-
_queryParams["pageIndex"] = pageIndex.toString();
|
|
303
|
-
}
|
|
304
|
-
if (pageSize != null) {
|
|
305
|
-
_queryParams["pageSize"] = pageSize.toString();
|
|
306
|
-
}
|
|
307
|
-
if (sortOrder != null) {
|
|
308
|
-
_queryParams["sortOrder"] = sortOrder;
|
|
309
|
-
}
|
|
310
|
-
if (direction != null) {
|
|
311
|
-
_queryParams["direction"] = direction;
|
|
312
|
-
}
|
|
313
|
-
if (status != null) {
|
|
314
|
-
_queryParams["status"] = status;
|
|
315
|
-
}
|
|
316
|
-
if (type_ != null) {
|
|
317
|
-
_queryParams["type"] = type_;
|
|
318
|
-
}
|
|
319
|
-
if (dateFrom != null) {
|
|
320
|
-
_queryParams["dateFrom"] = dateFrom;
|
|
321
|
-
}
|
|
322
|
-
if (dateTo != null) {
|
|
323
|
-
_queryParams["dateTo"] = dateTo;
|
|
324
|
-
}
|
|
325
|
-
let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
326
|
-
const _response = yield core.fetcher({
|
|
327
|
-
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PinnacleEnvironment.Default, `conversations/${encodeURIComponent(id)}/messages`),
|
|
328
|
-
method: "POST",
|
|
329
|
-
headers: _headers,
|
|
330
|
-
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
331
|
-
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
332
|
-
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
333
|
-
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
334
|
-
});
|
|
335
|
-
if (_response.ok) {
|
|
336
|
-
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
337
|
-
}
|
|
338
|
-
if (_response.error.reason === "status-code") {
|
|
339
|
-
switch (_response.error.statusCode) {
|
|
340
|
-
case 400:
|
|
341
|
-
throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
|
|
342
|
-
case 401:
|
|
343
|
-
throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
344
|
-
case 404:
|
|
345
|
-
throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
|
|
346
|
-
case 500:
|
|
347
|
-
throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
|
|
348
|
-
default:
|
|
349
|
-
throw new errors.PinnacleError({
|
|
350
|
-
statusCode: _response.error.statusCode,
|
|
351
|
-
body: _response.error.body,
|
|
352
|
-
rawResponse: _response.rawResponse,
|
|
353
|
-
});
|
|
354
|
-
}
|
|
355
|
-
}
|
|
356
|
-
switch (_response.error.reason) {
|
|
357
|
-
case "non-json":
|
|
358
|
-
throw new errors.PinnacleError({
|
|
359
|
-
statusCode: _response.error.statusCode,
|
|
360
|
-
body: _response.error.rawBody,
|
|
361
|
-
rawResponse: _response.rawResponse,
|
|
362
|
-
});
|
|
363
|
-
case "timeout":
|
|
364
|
-
throw new errors.PinnacleTimeoutError("Timeout exceeded when calling POST /conversations/{id}/messages.");
|
|
365
|
-
case "unknown":
|
|
366
|
-
throw new errors.PinnacleError({
|
|
367
|
-
message: _response.error.errorMessage,
|
|
368
|
-
rawResponse: _response.rawResponse,
|
|
369
|
-
});
|
|
370
|
-
}
|
|
371
|
-
});
|
|
372
|
-
}
|
|
373
278
|
_getCustomAuthorizationHeaders() {
|
|
374
279
|
return __awaiter(this, void 0, void 0, function* () {
|
|
375
280
|
const apiKeyValue = yield core.Supplier.get(this._options.apiKey);
|
|
@@ -5,8 +5,8 @@ import * as Pinnacle from "../../../../index.js";
|
|
|
5
5
|
/**
|
|
6
6
|
* @example
|
|
7
7
|
* {
|
|
8
|
-
* brandId:
|
|
9
|
-
* campaignId:
|
|
8
|
+
* brandId: 101,
|
|
9
|
+
* campaignId: 136,
|
|
10
10
|
* campaignType: "TOLL_FREE",
|
|
11
11
|
* pageIndex: 0,
|
|
12
12
|
* pageSize: 20,
|
|
@@ -15,15 +15,10 @@ import * as Pinnacle from "../../../../index.js";
|
|
|
15
15
|
* }
|
|
16
16
|
*/
|
|
17
17
|
export interface ListConversationsParams {
|
|
18
|
-
/** The unique identifier of the brand to filter conversations.
|
|
19
|
-
brandId?:
|
|
20
|
-
/**
|
|
21
|
-
|
|
22
|
-
* - TOLL_FREE: `tf_` (e.g., `tf_1234567890`)
|
|
23
|
-
* - 10DLC: `dlc_` (e.g., `dlc_1234567890`)
|
|
24
|
-
* - RCS: `rcs_` (e.g., `rcs_1234567890`)
|
|
25
|
-
*/
|
|
26
|
-
campaignId?: string;
|
|
18
|
+
/** The unique identifier of the brand to filter conversations. */
|
|
19
|
+
brandId?: number;
|
|
20
|
+
/** The unique identifier of the campaign to filter conversations. */
|
|
21
|
+
campaignId?: number;
|
|
27
22
|
campaignType?: Pinnacle.CampaignEnum;
|
|
28
23
|
/** Zero-based index for pagination. */
|
|
29
24
|
pageIndex: number;
|
|
@@ -4,13 +4,13 @@
|
|
|
4
4
|
/**
|
|
5
5
|
* @example
|
|
6
6
|
* {
|
|
7
|
-
* id:
|
|
7
|
+
* id: 123,
|
|
8
8
|
* notes: "Follow-up completed. Customer satisfied with resolution."
|
|
9
9
|
* }
|
|
10
10
|
*/
|
|
11
11
|
export interface UpdateConversationParams {
|
|
12
|
-
/** The unique identifier of the conversation to update.
|
|
13
|
-
id:
|
|
12
|
+
/** The unique identifier of the conversation to update. */
|
|
13
|
+
id: number;
|
|
14
14
|
/** New notes or comments for the conversation. */
|
|
15
15
|
notes: string;
|
|
16
16
|
}
|
|
@@ -14,5 +14,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
14
14
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
15
|
};
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
-
__exportStar(require("./types/index.js"), exports);
|
|
18
17
|
__exportStar(require("./client/index.js"), exports);
|
|
@@ -1,11 +1,10 @@
|
|
|
1
|
-
export * as conversations from "./conversations/index.js";
|
|
2
|
-
export * from "./conversations/types/index.js";
|
|
3
1
|
export * as phoneNumbers from "./phoneNumbers/index.js";
|
|
4
2
|
export * from "./phoneNumbers/types/index.js";
|
|
5
3
|
export * as campaigns from "./campaigns/index.js";
|
|
6
4
|
export * as messages from "./messages/index.js";
|
|
7
5
|
export * as brands from "./brands/index.js";
|
|
8
6
|
export * as contacts from "./contacts/index.js";
|
|
7
|
+
export * as conversations from "./conversations/index.js";
|
|
9
8
|
export * as rcs from "./rcs/index.js";
|
|
10
9
|
export * as webhooks from "./webhooks/index.js";
|
|
11
10
|
export * as status from "./status/index.js";
|
|
@@ -36,15 +36,14 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
36
36
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
37
37
|
};
|
|
38
38
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
39
|
-
exports.tools = exports.status = exports.webhooks = exports.rcs = exports.contacts = exports.brands = exports.messages = exports.campaigns = exports.phoneNumbers =
|
|
40
|
-
exports.conversations = __importStar(require("./conversations/index.js"));
|
|
41
|
-
__exportStar(require("./conversations/types/index.js"), exports);
|
|
39
|
+
exports.tools = exports.status = exports.webhooks = exports.rcs = exports.conversations = exports.contacts = exports.brands = exports.messages = exports.campaigns = exports.phoneNumbers = void 0;
|
|
42
40
|
exports.phoneNumbers = __importStar(require("./phoneNumbers/index.js"));
|
|
43
41
|
__exportStar(require("./phoneNumbers/types/index.js"), exports);
|
|
44
42
|
exports.campaigns = __importStar(require("./campaigns/index.js"));
|
|
45
43
|
exports.messages = __importStar(require("./messages/index.js"));
|
|
46
44
|
exports.brands = __importStar(require("./brands/index.js"));
|
|
47
45
|
exports.contacts = __importStar(require("./contacts/index.js"));
|
|
46
|
+
exports.conversations = __importStar(require("./conversations/index.js"));
|
|
48
47
|
exports.rcs = __importStar(require("./rcs/index.js"));
|
|
49
48
|
exports.webhooks = __importStar(require("./webhooks/index.js"));
|
|
50
49
|
exports.status = __importStar(require("./status/index.js"));
|
|
@@ -41,7 +41,7 @@ export declare class Messages {
|
|
|
41
41
|
/**
|
|
42
42
|
* Retrieve a previously sent message.
|
|
43
43
|
*
|
|
44
|
-
* @param {
|
|
44
|
+
* @param {number} id - Unique identifier of the message.
|
|
45
45
|
* @param {Messages.RequestOptions} requestOptions - Request-specific configuration.
|
|
46
46
|
*
|
|
47
47
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -50,9 +50,9 @@ export declare class Messages {
|
|
|
50
50
|
* @throws {@link Pinnacle.InternalServerError}
|
|
51
51
|
*
|
|
52
52
|
* @example
|
|
53
|
-
* await client.messages.get(
|
|
53
|
+
* await client.messages.get(1240)
|
|
54
54
|
*/
|
|
55
|
-
get(id:
|
|
55
|
+
get(id: number, requestOptions?: Messages.RequestOptions): core.HttpResponsePromise<Pinnacle.Message>;
|
|
56
56
|
private __get;
|
|
57
57
|
/**
|
|
58
58
|
* Add or remove an emoji reaction to a previously sent message.
|
|
@@ -69,7 +69,7 @@ export declare class Messages {
|
|
|
69
69
|
*
|
|
70
70
|
* @example
|
|
71
71
|
* await client.messages.react({
|
|
72
|
-
* messageId:
|
|
72
|
+
* messageId: 1410,
|
|
73
73
|
* options: {
|
|
74
74
|
* force: true
|
|
75
75
|
* },
|
|
@@ -73,7 +73,7 @@ class Messages {
|
|
|
73
73
|
/**
|
|
74
74
|
* Retrieve a previously sent message.
|
|
75
75
|
*
|
|
76
|
-
* @param {
|
|
76
|
+
* @param {number} id - Unique identifier of the message.
|
|
77
77
|
* @param {Messages.RequestOptions} requestOptions - Request-specific configuration.
|
|
78
78
|
*
|
|
79
79
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -82,7 +82,7 @@ class Messages {
|
|
|
82
82
|
* @throws {@link Pinnacle.InternalServerError}
|
|
83
83
|
*
|
|
84
84
|
* @example
|
|
85
|
-
* await client.messages.get(
|
|
85
|
+
* await client.messages.get(1240)
|
|
86
86
|
*/
|
|
87
87
|
get(id, requestOptions) {
|
|
88
88
|
return core.HttpResponsePromise.fromPromise(this.__get(id, requestOptions));
|
|
@@ -153,7 +153,7 @@ class Messages {
|
|
|
153
153
|
*
|
|
154
154
|
* @example
|
|
155
155
|
* await client.messages.react({
|
|
156
|
-
* messageId:
|
|
156
|
+
* messageId: 1410,
|
|
157
157
|
* options: {
|
|
158
158
|
* force: true
|
|
159
159
|
* },
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
/**
|
|
5
5
|
* @example
|
|
6
6
|
* {
|
|
7
|
-
* messageId:
|
|
7
|
+
* messageId: 1410,
|
|
8
8
|
* options: {
|
|
9
9
|
* force: true
|
|
10
10
|
* },
|
|
@@ -12,8 +12,8 @@
|
|
|
12
12
|
* }
|
|
13
13
|
*/
|
|
14
14
|
export interface ReactMessageParams {
|
|
15
|
-
/** Unique identifier of the message.
|
|
16
|
-
messageId:
|
|
15
|
+
/** Unique identifier of the message. */
|
|
16
|
+
messageId: number;
|
|
17
17
|
options?: ReactMessageParams.Options;
|
|
18
18
|
/**
|
|
19
19
|
* Unicode emoji to add. <br>
|
|
@@ -45,7 +45,7 @@ export declare class Campaign {
|
|
|
45
45
|
* await client.phoneNumbers.campaign.attach({
|
|
46
46
|
* phones: ["+14155550123", "+14155559876", "+14155550111"],
|
|
47
47
|
* campaignType: "TOLL_FREE",
|
|
48
|
-
* campaignId:
|
|
48
|
+
* campaignId: 101
|
|
49
49
|
* })
|
|
50
50
|
*/
|
|
51
51
|
attach(request: Pinnacle.phoneNumbers.AttachCampaignParams, requestOptions?: Campaign.RequestOptions): core.HttpResponsePromise<Pinnacle.AttachedPhoneNumberResult>;
|
|
@@ -71,7 +71,7 @@ class Campaign {
|
|
|
71
71
|
* await client.phoneNumbers.campaign.attach({
|
|
72
72
|
* phones: ["+14155550123", "+14155559876", "+14155550111"],
|
|
73
73
|
* campaignType: "TOLL_FREE",
|
|
74
|
-
* campaignId:
|
|
74
|
+
* campaignId: 101
|
|
75
75
|
* })
|
|
76
76
|
*/
|
|
77
77
|
attach(request, requestOptions) {
|
|
@@ -7,22 +7,13 @@ import * as Pinnacle from "../../../../../../index.js";
|
|
|
7
7
|
* {
|
|
8
8
|
* phones: ["+14155550123", "+14155559876", "+14155550111"],
|
|
9
9
|
* campaignType: "TOLL_FREE",
|
|
10
|
-
* campaignId:
|
|
10
|
+
* campaignId: 101
|
|
11
11
|
* }
|
|
12
12
|
*/
|
|
13
13
|
export interface AttachCampaignParams {
|
|
14
14
|
/** List of phone number (E.164 format). */
|
|
15
15
|
phones: string[];
|
|
16
16
|
campaignType: Pinnacle.MessagingProfileEnum;
|
|
17
|
-
/**
|
|
18
|
-
|
|
19
|
-
*
|
|
20
|
-
* - **TOLL_FREE** campaigns:
|
|
21
|
-
* - Must begin with the prefix `tf_`
|
|
22
|
-
* - Example: `tf_1234567890`
|
|
23
|
-
* - **10DLC** campaigns:
|
|
24
|
-
* - Must begin with the prefix `dlc_`
|
|
25
|
-
* - Example: `dlc_1234567890`
|
|
26
|
-
*/
|
|
27
|
-
campaignId: string;
|
|
17
|
+
/** Campaign's identifier. */
|
|
18
|
+
campaignId: number;
|
|
28
19
|
}
|
|
@@ -46,7 +46,7 @@ export declare class Webhook {
|
|
|
46
46
|
*
|
|
47
47
|
* @example
|
|
48
48
|
* await client.phoneNumbers.webhook.attach("%2B14155551234", {
|
|
49
|
-
* webhookId:
|
|
49
|
+
* webhookId: 123,
|
|
50
50
|
* event: "MESSAGE.STATUS"
|
|
51
51
|
* })
|
|
52
52
|
*/
|
|
@@ -60,9 +60,9 @@ export declare class Webhook {
|
|
|
60
60
|
* @param {string} phone - The phone number you want to attach the webhook to in E.164 format. Make sure it is url encoded (i.e. replace the leading + with %2B). <br>
|
|
61
61
|
*
|
|
62
62
|
* Must be a phone number that you own and currently has the specified webhook attached.
|
|
63
|
-
* @param {
|
|
63
|
+
* @param {number} webhookId - The unique identifier of the webhook you want to detach from the phone number. <br>
|
|
64
64
|
*
|
|
65
|
-
* This must be a valid webhook ID that is currently attached to the specified phone number.
|
|
65
|
+
* This must be a valid webhook ID that is currently attached to the specified phone number.
|
|
66
66
|
* @param {Webhook.RequestOptions} requestOptions - Request-specific configuration.
|
|
67
67
|
*
|
|
68
68
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -72,9 +72,9 @@ export declare class Webhook {
|
|
|
72
72
|
* @throws {@link Pinnacle.NotImplementedError}
|
|
73
73
|
*
|
|
74
74
|
* @example
|
|
75
|
-
* await client.phoneNumbers.webhook.detach("+14155551234",
|
|
75
|
+
* await client.phoneNumbers.webhook.detach("+14155551234", 123)
|
|
76
76
|
*/
|
|
77
|
-
detach(phone: string, webhookId:
|
|
77
|
+
detach(phone: string, webhookId: number, requestOptions?: Webhook.RequestOptions): core.HttpResponsePromise<Pinnacle.DetachedWebhookInfo>;
|
|
78
78
|
private __detach;
|
|
79
79
|
protected _getCustomAuthorizationHeaders(): Promise<{
|
|
80
80
|
"PINNACLE-API-KEY": string | undefined;
|