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
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
4
|
export interface ReactionResult {
|
|
5
|
-
/**
|
|
6
|
-
messageId:
|
|
7
|
-
/** Unique identifier
|
|
8
|
-
reactionMessageId:
|
|
5
|
+
/** ID of the message. */
|
|
6
|
+
messageId: number;
|
|
7
|
+
/** Unique identifier for the reaction. */
|
|
8
|
+
reactionMessageId: number;
|
|
9
9
|
}
|
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
4
|
export interface ScheduledMessaage {
|
|
5
|
-
/** Unique identifier for the scheduled send.
|
|
6
|
-
scheduleId:
|
|
5
|
+
/** Unique identifier for the scheduled send. */
|
|
6
|
+
scheduleId: number;
|
|
7
7
|
/** Configuration for the scheduled message. */
|
|
8
8
|
config: ScheduledMessaage.Config;
|
|
9
9
|
}
|
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
4
|
export interface SentMmsDetails {
|
|
5
|
-
/** Array of unique identifiers for the sent MMS messages.
|
|
6
|
-
messageIds:
|
|
5
|
+
/** Array of unique identifiers for the sent MMS messages. */
|
|
6
|
+
messageIds: number[];
|
|
7
7
|
/** Total number of segments used across the message. */
|
|
8
8
|
segments: number;
|
|
9
9
|
/** Total cost of sending the message. */
|
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
4
|
export interface SentRcsDetails {
|
|
5
|
-
/** Unique identifier for the sent
|
|
6
|
-
|
|
5
|
+
/** Unique identifier for the sent MMS messages. */
|
|
6
|
+
messageIds?: number;
|
|
7
7
|
/** Total number of segments used across the message. */
|
|
8
8
|
segments: number;
|
|
9
9
|
/** Total cost of sending the message. */
|
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
4
|
export interface SentSmsDetails {
|
|
5
|
-
/** Unique identifier for the sent message.
|
|
6
|
-
messageId:
|
|
5
|
+
/** Unique identifier for the sent message. */
|
|
6
|
+
messageId: number;
|
|
7
7
|
/** Details about how the message was segmented for sending. */
|
|
8
8
|
segments: SentSmsDetails.Segments;
|
|
9
9
|
/** Total cost of sending the message. */
|
|
@@ -3,8 +3,8 @@
|
|
|
3
3
|
*/
|
|
4
4
|
import * as Pinnacle from "../index.js";
|
|
5
5
|
export interface TollFreeCampaign {
|
|
6
|
-
/** Unique identifier for the campaign.
|
|
7
|
-
campaignId?:
|
|
6
|
+
/** Unique identifier for the campaign. */
|
|
7
|
+
campaignId?: number;
|
|
8
8
|
monthlyVolume?: Pinnacle.MessageVolumeEnum;
|
|
9
9
|
/** Display name of the campaign. */
|
|
10
10
|
name?: string;
|
|
@@ -12,8 +12,8 @@ export interface TollFreeCampaignStatus {
|
|
|
12
12
|
* These errors may request additional information or point out erroneous and/or missing fields.
|
|
13
13
|
*/
|
|
14
14
|
error?: string;
|
|
15
|
-
/**
|
|
16
|
-
id:
|
|
15
|
+
/** Id of the toll-free campaign. */
|
|
16
|
+
id: number;
|
|
17
17
|
/**
|
|
18
18
|
* Status of phone numbers that are being attached to this campaign. <br>
|
|
19
19
|
*
|
|
@@ -2,6 +2,6 @@
|
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
4
|
export interface UpdatedContactId {
|
|
5
|
-
/** Unique ID of the updated contact.
|
|
6
|
-
id:
|
|
5
|
+
/** Unique ID of the updated contact. */
|
|
6
|
+
id: number;
|
|
7
7
|
}
|
|
@@ -4,11 +4,6 @@
|
|
|
4
4
|
export interface ValidateCampaignParams {
|
|
5
5
|
/** Any additional information you want to provide. */
|
|
6
6
|
additionalInfo?: string;
|
|
7
|
-
/**
|
|
8
|
-
|
|
9
|
-
* - When validating 10DLC campaigns, it must begin with the prefix `dlc_` (e.g., `dlc_1234567890`)
|
|
10
|
-
* - When validating toll-free campaigns, it must begin with the prefix `tf_` (e.g., `tf_1234567890`)
|
|
11
|
-
* - When validating RCS campaigns, it must begin with the prefix `rcs_` (e.g., `rcs_1234567890`)
|
|
12
|
-
*/
|
|
13
|
-
campaignId: string;
|
|
7
|
+
/** Campaign ID. */
|
|
8
|
+
campaignId: number;
|
|
14
9
|
}
|
|
@@ -3,8 +3,8 @@
|
|
|
3
3
|
*/
|
|
4
4
|
import * as Pinnacle from "../index.js";
|
|
5
5
|
export interface Vcard {
|
|
6
|
-
/**
|
|
7
|
-
id?:
|
|
6
|
+
/** Unique identifier for the contact. */
|
|
7
|
+
id?: number;
|
|
8
8
|
/** Full display name for the vCard. */
|
|
9
9
|
formattedName?: string;
|
|
10
10
|
/** Structured name components. */
|
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
4
|
export interface VcardResource {
|
|
5
|
-
/**
|
|
6
|
-
id?:
|
|
5
|
+
/** Contact's id */
|
|
6
|
+
id?: number;
|
|
7
7
|
/**
|
|
8
8
|
* Presigned download url to download vCard data. <br>
|
|
9
9
|
*
|
|
@@ -7,8 +7,8 @@
|
|
|
7
7
|
export interface Webhooks {
|
|
8
8
|
/** URL where webhook events are delivered. */
|
|
9
9
|
endpoint: string;
|
|
10
|
-
/**
|
|
11
|
-
id:
|
|
10
|
+
/** Unique identifier for the webhook. */
|
|
11
|
+
id: number;
|
|
12
12
|
/** Name of the webhook. */
|
|
13
13
|
name: string;
|
|
14
14
|
}
|
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
export * from "./BadRequestErrorBody.js";
|
|
2
|
-
export * from "./NotFoundErrorBody.js";
|
|
3
2
|
export * from "./OptionalContacts.js";
|
|
4
3
|
export * from "./CompanySectorEnum.js";
|
|
5
4
|
export * from "./CompanyTypeEnum.js";
|
|
@@ -68,8 +67,6 @@ export * from "./MessageMethodEnum.js";
|
|
|
68
67
|
export * from "./MessageStatusEnum.js";
|
|
69
68
|
export * from "./MessageProtocolEnum.js";
|
|
70
69
|
export * from "./Message.js";
|
|
71
|
-
export * from "./MessageWithReaction.js";
|
|
72
|
-
export * from "./MessageList.js";
|
|
73
70
|
export * from "./ReactionResult.js";
|
|
74
71
|
export * from "./MessageSchedule.js";
|
|
75
72
|
export * from "./Tracking.js";
|
|
@@ -15,7 +15,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
15
15
|
};
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
17
|
__exportStar(require("./BadRequestErrorBody.js"), exports);
|
|
18
|
-
__exportStar(require("./NotFoundErrorBody.js"), exports);
|
|
19
18
|
__exportStar(require("./OptionalContacts.js"), exports);
|
|
20
19
|
__exportStar(require("./CompanySectorEnum.js"), exports);
|
|
21
20
|
__exportStar(require("./CompanyTypeEnum.js"), exports);
|
|
@@ -84,8 +83,6 @@ __exportStar(require("./MessageMethodEnum.js"), exports);
|
|
|
84
83
|
__exportStar(require("./MessageStatusEnum.js"), exports);
|
|
85
84
|
__exportStar(require("./MessageProtocolEnum.js"), exports);
|
|
86
85
|
__exportStar(require("./Message.js"), exports);
|
|
87
|
-
__exportStar(require("./MessageWithReaction.js"), exports);
|
|
88
|
-
__exportStar(require("./MessageList.js"), exports);
|
|
89
86
|
__exportStar(require("./ReactionResult.js"), exports);
|
|
90
87
|
__exportStar(require("./MessageSchedule.js"), exports);
|
|
91
88
|
__exportStar(require("./Tracking.js"), exports);
|
package/dist/cjs/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "2.0.
|
|
1
|
+
export declare const SDK_VERSION = "2.0.1";
|
package/dist/cjs/version.js
CHANGED
package/dist/esm/Client.mjs
CHANGED
|
@@ -18,8 +18,8 @@ export class PinnacleClient {
|
|
|
18
18
|
this._options = Object.assign(Object.assign({}, _options), { headers: mergeHeaders({
|
|
19
19
|
"X-Fern-Language": "JavaScript",
|
|
20
20
|
"X-Fern-SDK-Name": "rcs-js",
|
|
21
|
-
"X-Fern-SDK-Version": "2.0.
|
|
22
|
-
"User-Agent": "rcs-js/2.0.
|
|
21
|
+
"X-Fern-SDK-Version": "2.0.1",
|
|
22
|
+
"User-Agent": "rcs-js/2.0.1",
|
|
23
23
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
24
24
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
25
25
|
}, _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.mjs";
|
|
5
|
+
import * as Pinnacle from "../index.mjs";
|
|
5
6
|
import * as core from "../../core/index.mjs";
|
|
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;
|
|
@@ -117,7 +117,7 @@ export class Brands {
|
|
|
117
117
|
* description: "A developer-friendly, compliant API for SMS, MMS, and RCS, built to scale real conversations.",
|
|
118
118
|
* ein: "88-1234567",
|
|
119
119
|
* email: "founders@trypinnacle.app",
|
|
120
|
-
* id:
|
|
120
|
+
* id: 1,
|
|
121
121
|
* name: "Pinnacle",
|
|
122
122
|
* sector: "TECHNOLOGY",
|
|
123
123
|
* type: "PRIVATE_PROFIT",
|
|
@@ -182,8 +182,7 @@ export class Brands {
|
|
|
182
182
|
/**
|
|
183
183
|
* Retrieve detailed information for a specific brand in your account by ID.
|
|
184
184
|
*
|
|
185
|
-
* @param {
|
|
186
|
-
* <br><br> This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`.
|
|
185
|
+
* @param {number} id - ID of an existing brand in your account that you want to retrieve.
|
|
187
186
|
* @param {Pinnacle.BrandsGetRequest} request
|
|
188
187
|
* @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
|
|
189
188
|
*
|
|
@@ -193,7 +192,7 @@ export class Brands {
|
|
|
193
192
|
* @throws {@link Pinnacle.InternalServerError}
|
|
194
193
|
*
|
|
195
194
|
* @example
|
|
196
|
-
* await client.brands.get(
|
|
195
|
+
* await client.brands.get(1)
|
|
197
196
|
*/
|
|
198
197
|
get(id, request = {}, requestOptions) {
|
|
199
198
|
return core.HttpResponsePromise.fromPromise(this.__get(id, request, requestOptions));
|
|
@@ -257,8 +256,9 @@ export class Brands {
|
|
|
257
256
|
/**
|
|
258
257
|
* Submit your brand for review and approval by the compliance team.
|
|
259
258
|
*
|
|
260
|
-
* @param {
|
|
261
|
-
*
|
|
259
|
+
* @param {number} brandId - The unique identifier of the brand you want to submit for review. <br>
|
|
260
|
+
*
|
|
261
|
+
* Must correspond to an existing brand in your account that is ready for submission.
|
|
262
262
|
* @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
|
|
263
263
|
*
|
|
264
264
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -269,7 +269,7 @@ export class Brands {
|
|
|
269
269
|
* @throws {@link Pinnacle.NotImplementedError}
|
|
270
270
|
*
|
|
271
271
|
* @example
|
|
272
|
-
* await client.brands.submit(
|
|
272
|
+
* await client.brands.submit(1)
|
|
273
273
|
*/
|
|
274
274
|
submit(brandId, requestOptions) {
|
|
275
275
|
return core.HttpResponsePromise.fromPromise(this.__submit(brandId, requestOptions));
|
|
@@ -416,9 +416,9 @@ export class Brands {
|
|
|
416
416
|
/**
|
|
417
417
|
* Submit a brand for external vetting verification to enhance your brand's trust score and improved message delivery rates.
|
|
418
418
|
*
|
|
419
|
-
* @param {
|
|
419
|
+
* @param {number} brandId - The unique identifier of the brand to vet. <br>
|
|
420
420
|
*
|
|
421
|
-
*
|
|
421
|
+
* The brand must be already registered before it can be vetted.
|
|
422
422
|
* @param {Pinnacle.VetBrandParams} request
|
|
423
423
|
* @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
|
|
424
424
|
*
|
|
@@ -430,7 +430,7 @@ export class Brands {
|
|
|
430
430
|
* @throws {@link Pinnacle.NotImplementedError}
|
|
431
431
|
*
|
|
432
432
|
* @example
|
|
433
|
-
* await client.brands.vet(
|
|
433
|
+
* await client.brands.vet(1, {})
|
|
434
434
|
*/
|
|
435
435
|
vet(brandId, request, requestOptions) {
|
|
436
436
|
return core.HttpResponsePromise.fromPromise(this.__vet(brandId, request, requestOptions));
|
|
@@ -16,7 +16,7 @@ import * as Pinnacle from "../../../../index.mjs";
|
|
|
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>;
|
|
@@ -31,8 +31,8 @@ export class Dlc {
|
|
|
31
31
|
*
|
|
32
32
|
* @example
|
|
33
33
|
* await client.campaigns.dlc.autofill({
|
|
34
|
-
* additionalInfo: "Please autofill missing campaign fields using my brand profile",
|
|
35
|
-
* campaignId:
|
|
34
|
+
* additionalInfo: "Please autofill missing DLC campaign fields using my brand profile",
|
|
35
|
+
* campaignId: 161
|
|
36
36
|
* })
|
|
37
37
|
*/
|
|
38
38
|
autofill(request, requestOptions) {
|
|
@@ -93,7 +93,7 @@ export class Dlc {
|
|
|
93
93
|
/**
|
|
94
94
|
* Retrieve 10DLC campaign.
|
|
95
95
|
*
|
|
96
|
-
* @param {
|
|
96
|
+
* @param {number} campaignId - Unique identifier of the 10DLC campaign.
|
|
97
97
|
* @param {Dlc.RequestOptions} requestOptions - Request-specific configuration.
|
|
98
98
|
*
|
|
99
99
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -102,7 +102,7 @@ export class Dlc {
|
|
|
102
102
|
* @throws {@link Pinnacle.InternalServerError}
|
|
103
103
|
*
|
|
104
104
|
* @example
|
|
105
|
-
* await client.campaigns.dlc.get(
|
|
105
|
+
* await client.campaigns.dlc.get(28)
|
|
106
106
|
*/
|
|
107
107
|
get(campaignId, requestOptions) {
|
|
108
108
|
return core.HttpResponsePromise.fromPromise(this.__get(campaignId, requestOptions));
|
|
@@ -164,8 +164,7 @@ export class Dlc {
|
|
|
164
164
|
/**
|
|
165
165
|
* Submit your 10DLC campaign for approval and activation with carriers.
|
|
166
166
|
*
|
|
167
|
-
* @param {
|
|
168
|
-
* <br><br> This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`.
|
|
167
|
+
* @param {number} campaignId - Unique identifier of the 10DLC campaign to submit.
|
|
169
168
|
* @param {Dlc.RequestOptions} requestOptions - Request-specific configuration.
|
|
170
169
|
*
|
|
171
170
|
* @throws {@link Pinnacle.BadRequestError}
|
|
@@ -174,7 +173,7 @@ export class Dlc {
|
|
|
174
173
|
* @throws {@link Pinnacle.InternalServerError}
|
|
175
174
|
*
|
|
176
175
|
* @example
|
|
177
|
-
* await client.campaigns.dlc.submit(
|
|
176
|
+
* await client.campaigns.dlc.submit(161)
|
|
178
177
|
*/
|
|
179
178
|
submit(campaignId, requestOptions) {
|
|
180
179
|
return core.HttpResponsePromise.fromPromise(this.__submit(campaignId, requestOptions));
|
|
@@ -246,19 +245,19 @@ export class Dlc {
|
|
|
246
245
|
* @example
|
|
247
246
|
* await client.campaigns.dlc.upsert({
|
|
248
247
|
* autoRenew: true,
|
|
249
|
-
* brand:
|
|
250
|
-
* campaignId:
|
|
248
|
+
* brand: 1,
|
|
249
|
+
* campaignId: 161,
|
|
251
250
|
* keywords: {
|
|
252
251
|
* HELP: {
|
|
253
252
|
* message: "Reply HELP for assistance, STOP to opt-out",
|
|
254
253
|
* values: ["HELP", "INFO", "SUPPORT"]
|
|
255
254
|
* },
|
|
256
255
|
* OPT_IN: {
|
|
257
|
-
* message: "Welcome
|
|
256
|
+
* message: "Welcome! You're now subscribed to Pinnacle.",
|
|
258
257
|
* values: ["JOIN", "START", "SUBSCRIBE"]
|
|
259
258
|
* },
|
|
260
259
|
* OPT_OUT: {
|
|
261
|
-
* message: "You
|
|
260
|
+
* message: "You've been unsubscribed. Reply START to rejoin.",
|
|
262
261
|
* values: ["STOP", "QUIT", "UNSUBSCRIBE"]
|
|
263
262
|
* }
|
|
264
263
|
* },
|
|
@@ -356,7 +355,7 @@ export class Dlc {
|
|
|
356
355
|
* @example
|
|
357
356
|
* await client.campaigns.dlc.validate({
|
|
358
357
|
* additionalInfo: "Please validate this DLC campaign for 10DLC compliance",
|
|
359
|
-
* campaignId:
|
|
358
|
+
* campaignId: 161
|
|
360
359
|
* })
|
|
361
360
|
*/
|
|
362
361
|
validate(request, requestOptions) {
|
package/dist/esm/api/resources/campaigns/resources/dlc/client/requests/UpsertDlcCampaignParams.d.mts
CHANGED
|
@@ -6,19 +6,19 @@ import * as Pinnacle from "../../../../../../index.mjs";
|
|
|
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.mjs";
|
|
|
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. */
|