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.
Files changed (210) hide show
  1. package/dist/cjs/Client.js +2 -2
  2. package/dist/cjs/api/errors/NotFoundError.d.ts +2 -1
  3. package/dist/cjs/api/resources/brands/client/Client.d.ts +13 -13
  4. package/dist/cjs/api/resources/brands/client/Client.js +10 -10
  5. package/dist/cjs/api/resources/brands/client/requests/UpsertBrandParams.d.ts +3 -6
  6. package/dist/cjs/api/resources/campaigns/resources/dlc/client/Client.d.ts +13 -14
  7. package/dist/cjs/api/resources/campaigns/resources/dlc/client/Client.js +11 -12
  8. package/dist/cjs/api/resources/campaigns/resources/dlc/client/requests/UpsertDlcCampaignParams.d.ts +8 -8
  9. package/dist/cjs/api/resources/campaigns/resources/rcs/client/Client.d.ts +10 -11
  10. package/dist/cjs/api/resources/campaigns/resources/rcs/client/Client.js +8 -9
  11. package/dist/cjs/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.ts +3 -4
  12. package/dist/cjs/api/resources/campaigns/resources/rcs/types/RcsAutofillResponse.d.ts +1 -1
  13. package/dist/cjs/api/resources/campaigns/resources/tollFree/client/Client.d.ts +12 -12
  14. package/dist/cjs/api/resources/campaigns/resources/tollFree/client/Client.js +10 -10
  15. package/dist/cjs/api/resources/campaigns/resources/tollFree/client/requests/UpsertTollFreeCampaignParams.d.ts +7 -7
  16. package/dist/cjs/api/resources/campaigns/resources/tollFree/types/TollFreeAutofillResponse.d.ts +1 -1
  17. package/dist/cjs/api/resources/contacts/client/Client.d.ts +2 -4
  18. package/dist/cjs/api/resources/contacts/client/Client.js +3 -5
  19. package/dist/cjs/api/resources/contacts/client/requests/ContactsGetRequest.d.ts +2 -4
  20. package/dist/cjs/api/resources/contacts/client/requests/UpdateContactParams.d.ts +3 -3
  21. package/dist/cjs/api/resources/conversations/client/Client.d.ts +4 -21
  22. package/dist/cjs/api/resources/conversations/client/Client.js +4 -99
  23. package/dist/cjs/api/resources/conversations/client/requests/ListConversationsParams.d.ts +6 -11
  24. package/dist/cjs/api/resources/conversations/client/requests/UpdateConversationParams.d.ts +3 -3
  25. package/dist/cjs/api/resources/conversations/client/requests/index.d.ts +0 -1
  26. package/dist/cjs/api/resources/conversations/index.d.ts +0 -1
  27. package/dist/cjs/api/resources/conversations/index.js +0 -1
  28. package/dist/cjs/api/resources/index.d.ts +1 -2
  29. package/dist/cjs/api/resources/index.js +2 -3
  30. package/dist/cjs/api/resources/messages/client/Client.d.ts +4 -4
  31. package/dist/cjs/api/resources/messages/client/Client.js +3 -3
  32. package/dist/cjs/api/resources/messages/client/requests/ReactMessageParams.d.ts +3 -3
  33. package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/Client.d.ts +1 -1
  34. package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/Client.js +1 -1
  35. package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/requests/AttachCampaignParams.d.ts +3 -12
  36. package/dist/cjs/api/resources/phoneNumbers/resources/webhook/client/Client.d.ts +5 -5
  37. package/dist/cjs/api/resources/phoneNumbers/resources/webhook/client/Client.js +4 -4
  38. package/dist/cjs/api/resources/status/resources/get/client/Client.d.ts +12 -12
  39. package/dist/cjs/api/resources/status/resources/get/client/Client.js +8 -8
  40. package/dist/cjs/api/resources/tools/resources/contactCard/client/Client.d.ts +2 -2
  41. package/dist/cjs/api/resources/tools/resources/contactCard/client/Client.js +2 -2
  42. package/dist/cjs/api/resources/tools/resources/contactCard/client/requests/GetVcardParams.d.ts +3 -3
  43. package/dist/cjs/api/resources/tools/resources/contactCard/client/requests/UpsertVcardParams.d.ts +1 -1
  44. package/dist/cjs/api/resources/tools/resources/file/client/Client.d.ts +1 -1
  45. package/dist/cjs/api/resources/tools/resources/file/client/Client.js +1 -1
  46. package/dist/cjs/api/resources/tools/resources/file/client/requests/RefreshFileParams.d.ts +11 -3
  47. package/dist/cjs/api/types/AttachWebhookParams.d.ts +1 -1
  48. package/dist/cjs/api/types/AttachedPhoneNumberResult.d.ts +2 -2
  49. package/dist/cjs/api/types/AutofillCampaignParams.d.ts +2 -7
  50. package/dist/cjs/api/types/AutofillDlcCampaignResponse.d.ts +4 -4
  51. package/dist/cjs/api/types/BrandStatus.d.ts +2 -2
  52. package/dist/cjs/api/types/ButtonClickedData.d.ts +1 -1
  53. package/dist/cjs/api/types/CampaignQuery.d.ts +1 -6
  54. package/dist/cjs/api/types/ConfiguredWebhook.d.ts +2 -2
  55. package/dist/cjs/api/types/Contact.d.ts +2 -2
  56. package/dist/cjs/api/types/ContactId.d.ts +2 -2
  57. package/dist/cjs/api/types/Conversation.d.ts +7 -7
  58. package/dist/cjs/api/types/ConversationList.d.ts +4 -4
  59. package/dist/cjs/api/types/DetachedPhoneNumberResult.d.ts +2 -2
  60. package/dist/cjs/api/types/DetachedWebhookInfo.d.ts +2 -2
  61. package/dist/cjs/api/types/DlcCampaignStatus.d.ts +2 -2
  62. package/dist/cjs/api/types/DlcCampaignWithExtendedBrandAndStatus.d.ts +2 -2
  63. package/dist/cjs/api/types/ExtendedBrand.d.ts +2 -2
  64. package/dist/cjs/api/types/ExtendedRcsCampaign.d.ts +2 -2
  65. package/dist/cjs/api/types/GetConversationParams.d.ts +1 -1
  66. package/dist/cjs/api/types/LinkClickEvent.d.ts +4 -0
  67. package/dist/cjs/api/types/Message.d.ts +2 -2
  68. package/dist/cjs/api/types/MessageEvent.d.ts +4 -10
  69. package/dist/cjs/api/types/RcsCampaign.d.ts +1 -1
  70. package/dist/cjs/api/types/RcsCampaignStatus.d.ts +2 -2
  71. package/dist/cjs/api/types/ReactionResult.d.ts +4 -4
  72. package/dist/cjs/api/types/ScheduledMessaage.d.ts +2 -2
  73. package/dist/cjs/api/types/SentMmsDetails.d.ts +2 -2
  74. package/dist/cjs/api/types/SentRcsDetails.d.ts +2 -2
  75. package/dist/cjs/api/types/SentSmsDetails.d.ts +2 -2
  76. package/dist/cjs/api/types/TollFreeCampaign.d.ts +2 -2
  77. package/dist/cjs/api/types/TollFreeCampaignStatus.d.ts +2 -2
  78. package/dist/cjs/api/types/UpdatedContactId.d.ts +2 -2
  79. package/dist/cjs/api/types/ValidateCampaignParams.d.ts +2 -7
  80. package/dist/cjs/api/types/Vcard.d.ts +2 -2
  81. package/dist/cjs/api/types/VcardResource.d.ts +2 -2
  82. package/dist/cjs/api/types/Webhooks.d.ts +2 -2
  83. package/dist/cjs/api/types/index.d.ts +0 -3
  84. package/dist/cjs/api/types/index.js +0 -3
  85. package/dist/cjs/version.d.ts +1 -1
  86. package/dist/cjs/version.js +1 -1
  87. package/dist/esm/Client.mjs +2 -2
  88. package/dist/esm/api/errors/NotFoundError.d.mts +2 -1
  89. package/dist/esm/api/resources/brands/client/Client.d.mts +13 -13
  90. package/dist/esm/api/resources/brands/client/Client.mjs +10 -10
  91. package/dist/esm/api/resources/brands/client/requests/UpsertBrandParams.d.mts +3 -6
  92. package/dist/esm/api/resources/campaigns/resources/dlc/client/Client.d.mts +13 -14
  93. package/dist/esm/api/resources/campaigns/resources/dlc/client/Client.mjs +11 -12
  94. package/dist/esm/api/resources/campaigns/resources/dlc/client/requests/UpsertDlcCampaignParams.d.mts +8 -8
  95. package/dist/esm/api/resources/campaigns/resources/rcs/client/Client.d.mts +10 -11
  96. package/dist/esm/api/resources/campaigns/resources/rcs/client/Client.mjs +8 -9
  97. package/dist/esm/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.mts +3 -4
  98. package/dist/esm/api/resources/campaigns/resources/rcs/types/RcsAutofillResponse.d.mts +1 -1
  99. package/dist/esm/api/resources/campaigns/resources/tollFree/client/Client.d.mts +12 -12
  100. package/dist/esm/api/resources/campaigns/resources/tollFree/client/Client.mjs +10 -10
  101. package/dist/esm/api/resources/campaigns/resources/tollFree/client/requests/UpsertTollFreeCampaignParams.d.mts +7 -7
  102. package/dist/esm/api/resources/campaigns/resources/tollFree/types/TollFreeAutofillResponse.d.mts +1 -1
  103. package/dist/esm/api/resources/contacts/client/Client.d.mts +2 -4
  104. package/dist/esm/api/resources/contacts/client/Client.mjs +3 -5
  105. package/dist/esm/api/resources/contacts/client/requests/ContactsGetRequest.d.mts +2 -4
  106. package/dist/esm/api/resources/contacts/client/requests/UpdateContactParams.d.mts +3 -3
  107. package/dist/esm/api/resources/conversations/client/Client.d.mts +4 -21
  108. package/dist/esm/api/resources/conversations/client/Client.mjs +4 -99
  109. package/dist/esm/api/resources/conversations/client/requests/ListConversationsParams.d.mts +6 -11
  110. package/dist/esm/api/resources/conversations/client/requests/UpdateConversationParams.d.mts +3 -3
  111. package/dist/esm/api/resources/conversations/client/requests/index.d.mts +0 -1
  112. package/dist/esm/api/resources/conversations/index.d.mts +0 -1
  113. package/dist/esm/api/resources/conversations/index.mjs +0 -1
  114. package/dist/esm/api/resources/index.d.mts +1 -2
  115. package/dist/esm/api/resources/index.mjs +1 -2
  116. package/dist/esm/api/resources/messages/client/Client.d.mts +4 -4
  117. package/dist/esm/api/resources/messages/client/Client.mjs +3 -3
  118. package/dist/esm/api/resources/messages/client/requests/ReactMessageParams.d.mts +3 -3
  119. package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/Client.d.mts +1 -1
  120. package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/Client.mjs +1 -1
  121. package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/requests/AttachCampaignParams.d.mts +3 -12
  122. package/dist/esm/api/resources/phoneNumbers/resources/webhook/client/Client.d.mts +5 -5
  123. package/dist/esm/api/resources/phoneNumbers/resources/webhook/client/Client.mjs +4 -4
  124. package/dist/esm/api/resources/status/resources/get/client/Client.d.mts +12 -12
  125. package/dist/esm/api/resources/status/resources/get/client/Client.mjs +8 -8
  126. package/dist/esm/api/resources/tools/resources/contactCard/client/Client.d.mts +2 -2
  127. package/dist/esm/api/resources/tools/resources/contactCard/client/Client.mjs +2 -2
  128. package/dist/esm/api/resources/tools/resources/contactCard/client/requests/GetVcardParams.d.mts +3 -3
  129. package/dist/esm/api/resources/tools/resources/contactCard/client/requests/UpsertVcardParams.d.mts +1 -1
  130. package/dist/esm/api/resources/tools/resources/file/client/Client.d.mts +1 -1
  131. package/dist/esm/api/resources/tools/resources/file/client/Client.mjs +1 -1
  132. package/dist/esm/api/resources/tools/resources/file/client/requests/RefreshFileParams.d.mts +11 -3
  133. package/dist/esm/api/types/AttachWebhookParams.d.mts +1 -1
  134. package/dist/esm/api/types/AttachedPhoneNumberResult.d.mts +2 -2
  135. package/dist/esm/api/types/AutofillCampaignParams.d.mts +2 -7
  136. package/dist/esm/api/types/AutofillDlcCampaignResponse.d.mts +4 -4
  137. package/dist/esm/api/types/BrandStatus.d.mts +2 -2
  138. package/dist/esm/api/types/ButtonClickedData.d.mts +1 -1
  139. package/dist/esm/api/types/CampaignQuery.d.mts +1 -6
  140. package/dist/esm/api/types/ConfiguredWebhook.d.mts +2 -2
  141. package/dist/esm/api/types/Contact.d.mts +2 -2
  142. package/dist/esm/api/types/ContactId.d.mts +2 -2
  143. package/dist/esm/api/types/Conversation.d.mts +7 -7
  144. package/dist/esm/api/types/ConversationList.d.mts +4 -4
  145. package/dist/esm/api/types/DetachedPhoneNumberResult.d.mts +2 -2
  146. package/dist/esm/api/types/DetachedWebhookInfo.d.mts +2 -2
  147. package/dist/esm/api/types/DlcCampaignStatus.d.mts +2 -2
  148. package/dist/esm/api/types/DlcCampaignWithExtendedBrandAndStatus.d.mts +2 -2
  149. package/dist/esm/api/types/ExtendedBrand.d.mts +2 -2
  150. package/dist/esm/api/types/ExtendedRcsCampaign.d.mts +2 -2
  151. package/dist/esm/api/types/GetConversationParams.d.mts +1 -1
  152. package/dist/esm/api/types/LinkClickEvent.d.mts +4 -0
  153. package/dist/esm/api/types/Message.d.mts +2 -2
  154. package/dist/esm/api/types/MessageEvent.d.mts +4 -10
  155. package/dist/esm/api/types/RcsCampaign.d.mts +1 -1
  156. package/dist/esm/api/types/RcsCampaignStatus.d.mts +2 -2
  157. package/dist/esm/api/types/ReactionResult.d.mts +4 -4
  158. package/dist/esm/api/types/ScheduledMessaage.d.mts +2 -2
  159. package/dist/esm/api/types/SentMmsDetails.d.mts +2 -2
  160. package/dist/esm/api/types/SentRcsDetails.d.mts +2 -2
  161. package/dist/esm/api/types/SentSmsDetails.d.mts +2 -2
  162. package/dist/esm/api/types/TollFreeCampaign.d.mts +2 -2
  163. package/dist/esm/api/types/TollFreeCampaignStatus.d.mts +2 -2
  164. package/dist/esm/api/types/UpdatedContactId.d.mts +2 -2
  165. package/dist/esm/api/types/ValidateCampaignParams.d.mts +2 -7
  166. package/dist/esm/api/types/Vcard.d.mts +2 -2
  167. package/dist/esm/api/types/VcardResource.d.mts +2 -2
  168. package/dist/esm/api/types/Webhooks.d.mts +2 -2
  169. package/dist/esm/api/types/index.d.mts +0 -3
  170. package/dist/esm/api/types/index.mjs +0 -3
  171. package/dist/esm/version.d.mts +1 -1
  172. package/dist/esm/version.mjs +1 -1
  173. package/package.json +1 -1
  174. package/reference.md +66 -144
  175. package/dist/cjs/api/resources/conversations/client/requests/ConversationsListMessagesRequest.d.ts +0 -36
  176. package/dist/cjs/api/resources/conversations/client/requests/ConversationsListMessagesRequest.js +0 -5
  177. package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestDirection.d.ts +0 -8
  178. package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestDirection.js +0 -10
  179. package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestSortOrder.d.ts +0 -8
  180. package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestSortOrder.js +0 -10
  181. package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestStatus.d.ts +0 -13
  182. package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestStatus.js +0 -15
  183. package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestType.d.ts +0 -9
  184. package/dist/cjs/api/resources/conversations/types/ConversationsListMessagesRequestType.js +0 -11
  185. package/dist/cjs/api/resources/conversations/types/index.d.ts +0 -4
  186. package/dist/cjs/api/resources/conversations/types/index.js +0 -20
  187. package/dist/cjs/api/types/MessageList.d.ts +0 -15
  188. package/dist/cjs/api/types/MessageList.js +0 -5
  189. package/dist/cjs/api/types/MessageWithReaction.d.ts +0 -27
  190. package/dist/cjs/api/types/MessageWithReaction.js +0 -13
  191. package/dist/cjs/api/types/NotFoundErrorBody.d.ts +0 -6
  192. package/dist/cjs/api/types/NotFoundErrorBody.js +0 -5
  193. package/dist/esm/api/resources/conversations/client/requests/ConversationsListMessagesRequest.d.mts +0 -36
  194. package/dist/esm/api/resources/conversations/client/requests/ConversationsListMessagesRequest.mjs +0 -4
  195. package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestDirection.d.mts +0 -8
  196. package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestDirection.mjs +0 -7
  197. package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestSortOrder.d.mts +0 -8
  198. package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestSortOrder.mjs +0 -7
  199. package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestStatus.d.mts +0 -13
  200. package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestStatus.mjs +0 -12
  201. package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestType.d.mts +0 -9
  202. package/dist/esm/api/resources/conversations/types/ConversationsListMessagesRequestType.mjs +0 -8
  203. package/dist/esm/api/resources/conversations/types/index.d.mts +0 -4
  204. package/dist/esm/api/resources/conversations/types/index.mjs +0 -4
  205. package/dist/esm/api/types/MessageList.d.mts +0 -15
  206. package/dist/esm/api/types/MessageList.mjs +0 -4
  207. package/dist/esm/api/types/MessageWithReaction.d.mts +0 -27
  208. package/dist/esm/api/types/MessageWithReaction.mjs +0 -10
  209. package/dist/esm/api/types/NotFoundErrorBody.d.mts +0 -6
  210. package/dist/esm/api/types/NotFoundErrorBody.mjs +0 -4
@@ -6,16 +6,16 @@ import * as Pinnacle from "../index.mjs";
6
6
  * Conversation that was found.
7
7
  */
8
8
  export interface Conversation {
9
- /** The unique identifier of the brand associated with this conversation. This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`. */
10
- brandId: string | null;
11
- /** Campaign information if this conversation is part of a marketing campaign. This is an object that contains the campaign ID and type. */
9
+ /** Identifier for the brand associated with this conversation. */
10
+ brandId: number | null;
11
+ /** Campaign information if this conversation is part of a marketing campaign. */
12
12
  campaign: Pinnacle.CampaignQuery | null;
13
13
  /** Contact information for the recipient in a conversation. */
14
14
  contact: Conversation.Contact;
15
15
  /** ISO 8601 timestamp when the conversation was created. */
16
16
  createdAt: string;
17
- /** Unique identifier for the conversation. This identifier is a string that always begins with the prefix `conv_`, for example: `conv_1234567890`. */
18
- id: string;
17
+ /** Unique identifier for the conversation. */
18
+ id: number;
19
19
  /** Free-form notes or comments about the conversation. */
20
20
  notes: string;
21
21
  /**
@@ -33,8 +33,8 @@ export declare namespace Conversation {
33
33
  * Contact information for the recipient in a conversation.
34
34
  */
35
35
  interface Contact {
36
- /** Unique ID of the contact. This identifier is a string that always begins with the prefix `co_`, for example: `co_1234567890`. */
37
- id: string;
36
+ /** Unique identifier for the contact. */
37
+ id: number;
38
38
  /** The contact's phone number in E.164 format. */
39
39
  phoneNumber: string;
40
40
  }
@@ -5,10 +5,10 @@ import * as Pinnacle from "../index.mjs";
5
5
  /**
6
6
  * Response for list conversation.
7
7
  */
8
- export interface ConversationList {
9
- /** Total number of conversations matching the filter. */
8
+ export type ConversationList = {
9
+ error?: string | undefined;
10
+ } | {
10
11
  count: number;
11
12
  conversations: Pinnacle.Conversation[];
12
- /** Indicates if more conversations are available beyond the current page. */
13
13
  hasMore: boolean;
14
- }
14
+ };
@@ -22,8 +22,8 @@ export declare namespace DetachedPhoneNumberResult {
22
22
  * Campaign that the phone is now detached from.
23
23
  */
24
24
  interface Campaign {
25
- /** Id of the campaign. For `TOLL_FREE` campaigns, it will begin with the prefix `tf_`, for example: `tf_1234567890`. For `10DLC` campaigns, it will begin with the prefix `dlc_`, for example: `dlc_1234567890`. */
26
- id: string;
25
+ /** Id of the campaign. */
26
+ id: number;
27
27
  /** Campaign's name. */
28
28
  name: string;
29
29
  type: Pinnacle.MessagingProfileEnum;
@@ -4,8 +4,8 @@
4
4
  export interface DetachedWebhookInfo {
5
5
  /** Confirmation message. */
6
6
  message: string;
7
- /** Unique identifier of the webhook within the account. This identifier is a string that always begins with the prefix `wh_`, for example: `wh_1234567890`. */
8
- webhookId: string;
7
+ /** ID of the detached webhook. */
8
+ webhookId: number;
9
9
  /** Phone number the webhook was detached from in E.164 format. */
10
10
  phoneNumber: string;
11
11
  }
@@ -12,8 +12,8 @@ export interface DlcCampaignStatus {
12
12
  * These errors may request additional information or point out erroneous and/or missing fields.
13
13
  */
14
14
  error: string;
15
- /** The unique identifier of the 10DLC campaign. This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`. */
16
- id: string;
15
+ /** Id of the DLC campaign. */
16
+ id: number;
17
17
  /**
18
18
  * Current review status of the DLC campaign. <br>
19
19
  *
@@ -10,8 +10,8 @@ export interface DlcCampaignWithExtendedBrandAndStatus {
10
10
  autoRenew: boolean;
11
11
  /** Brand associated with this campaign. */
12
12
  brand: Pinnacle.ExtendedBrand;
13
- /** Unique identifier for the campaign. This identifier is a string that always begins with the prefix `dlc_`, for example: `dlc_1234567890`. */
14
- campaignId?: string;
13
+ /** Unique identifier for the campaign. */
14
+ campaignId?: number;
15
15
  /** Description of the campaign. */
16
16
  description?: string;
17
17
  /** Keyword response configuration. */
@@ -5,8 +5,8 @@ import * as Pinnacle from "../index.mjs";
5
5
  export interface ExtendedBrand extends Pinnacle.OptionalBrandInfo {
6
6
  /** ISO 8601 formatted timestamp of when this brand was added to our system. */
7
7
  createdAt: string;
8
- /** The brand's ID. This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`. */
9
- id: string;
8
+ /** The brand's ID. */
9
+ id: number;
10
10
  /** Indicates if this brand is archived. */
11
11
  isArchived: boolean;
12
12
  /**
@@ -13,8 +13,8 @@ export interface ExtendedRcsCampaign {
13
13
  brandVerificationUrl?: string;
14
14
  /** Indicates whether the brand has provided an attestation. */
15
15
  brandAttestation: boolean;
16
- /** Unique identifier for the campaign. This identifier is a string that always begins with the prefix `rcs_`, for example: `rcs_1234567890`. */
17
- campaignId?: string;
16
+ /** Unique identifier for the campaign. */
17
+ campaignId?: number;
18
18
  /** List of what the agent might say to users. */
19
19
  expectedAgentResponses?: string[];
20
20
  /** Legal documentation links. */
@@ -8,7 +8,7 @@ export type GetConversationParams =
8
8
  /**
9
9
  * Retrieve conversation information by ID. */
10
10
  {
11
- id: string;
11
+ id: number;
12
12
  }
13
13
  /**
14
14
  * Retrieve conversation information by sender and recipient. */
@@ -36,6 +36,8 @@ export interface LinkClickEvent {
36
36
  fingerprint_id?: string | null;
37
37
  /** Google Click Identifier. */
38
38
  gclid?: string | null;
39
+ /** Unique identifier for the click event. */
40
+ id: number;
39
41
  /** IP address of the visitor (may be anonymized). */
40
42
  ip_address?: string | null;
41
43
  /** Chain of IP addresses for proxied requests. */
@@ -46,6 +48,8 @@ export interface LinkClickEvent {
46
48
  latency_ms?: number | null;
47
49
  /** Geographic latitude. */
48
50
  latitude?: number | null;
51
+ /** ID of your shortened URL. */
52
+ link_id: number;
49
53
  /** Geographic longitude. */
50
54
  longitude?: number | null;
51
55
  /** Additional metadata as JSON object. */
@@ -22,8 +22,8 @@ export interface Message {
22
22
  * Null indicates no errors.
23
23
  */
24
24
  error: string | null;
25
- /** Unique identifier of the message. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`. */
26
- id: string;
25
+ /** Unique identifier of the message. */
26
+ id: number;
27
27
  method: Pinnacle.MessageMethodEnum;
28
28
  /** Number of segments the message was split into for delivery. */
29
29
  numSegments: number;
@@ -30,11 +30,8 @@ export declare namespace MessageEvent {
30
30
  * Conversation metadata containing the conversation ID, sender, and recipient information.
31
31
  */
32
32
  interface Conversation {
33
- /**
34
- * Unique identifier for the conversation. This identifier is a string that always begins with the prefix `conv_`, for example: `conv_1234567890`. <br><br>
35
- * To get more conversation details, use the [POST /conversations/get](/api-reference/conversations/get) endpoint.
36
- */
37
- id: string;
33
+ /** Unique identifier for the conversation. To get more conversation details, use the [POST /conversations/get](/api-reference/conversations/get) endpoint. */
34
+ id: number;
38
35
  /** Sender's phone number or agent ID. */
39
36
  from: string;
40
37
  /** Recipient's phone number. */
@@ -52,11 +49,8 @@ export declare namespace MessageEvent {
52
49
  * Message details including ID and content.
53
50
  */
54
51
  interface Message {
55
- /**
56
- * Unique identifier of the message. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`. <br><br>
57
- * To get the message details, use the [GET /messages/{id}](/api-reference/messages/get) endpoint.
58
- */
59
- id: string;
52
+ /** Unique identifier of the message. To get the message details, use the [GET /messages/{id}](/api-reference/messages/get) endpoint. */
53
+ id: number;
60
54
  content: Pinnacle.MessageContent;
61
55
  }
62
56
  }
@@ -6,7 +6,7 @@ export interface RcsCampaign {
6
6
  /** Agent configured to the campaign. */
7
7
  agent?: RcsCampaign.Agent;
8
8
  /** Unique identifier for the campaign. */
9
- campaignId?: string;
9
+ campaignId?: number;
10
10
  /** 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. */
11
11
  brandVerificationUrl?: string;
12
12
  /** List of what the agent might say to users. */
@@ -8,8 +8,8 @@ import * as Pinnacle from "../index.mjs";
8
8
  export interface RcsCampaignStatus {
9
9
  /** List of errors that occured. */
10
10
  errors: string[];
11
- /** The unique identifier of the RCS campaign. This identifier is a string that always begins with the prefix `rcs_`, for example: `rcs_1234567890`. */
12
- id: string;
11
+ /** Id of the RCS campaign. */
12
+ id: number;
13
13
  /**
14
14
  * Current review status of the RCS campaign. <br>
15
15
  *
@@ -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
- /** Unique identifier of the message. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`. */
6
- messageId: string;
7
- /** Unique identifier of the message with the reaction. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`. */
8
- reactionMessageId: string;
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. This identifier is a string that always begins with the prefix `msg_sched_`, for example: `msg_sched_1234567890`. */
6
- scheduleId: string;
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. This identifiers are strings that always begin with the prefix `msg_`, for example: `msg_1234567890`. */
6
- messageIds: string[];
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 RCS message. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`. */
6
- messageId: string;
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. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`. */
6
- messageId: string;
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.mjs";
5
5
  export interface TollFreeCampaign {
6
- /** Unique identifier for the campaign. Must begin with the prefix `tf_`. */
7
- campaignId?: string;
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
- /** The unique identifier of the toll-free campaign. This identifier is a string that always begins with the prefix `tf_`, for example: `tf_1234567890`. */
16
- id: string;
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. This identifier is a string that always begins with the prefix `co_`, for example: `co_1234567890`. */
6
- id: string;
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
- * Unique identifier for the campaign.
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.mjs";
5
5
  export interface Vcard {
6
- /** The unique identifier of the contact. This identifier is a string that always begins with the prefix `cc_`, for example: `cc_1234567890`. */
7
- id?: string;
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
- /** The unique identifier of the contact. This identifier is a string that always begins with the prefix `cc_`, for example: `cc_1234567890`. */
6
- id?: string;
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
- /** The unique identifier of the webhook. This identifier is a string that always begins with the prefix `wh_`, for example: `wh_1234567890`. */
11
- id: string;
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.mjs";
2
- export * from "./NotFoundErrorBody.mjs";
3
2
  export * from "./OptionalContacts.mjs";
4
3
  export * from "./CompanySectorEnum.mjs";
5
4
  export * from "./CompanyTypeEnum.mjs";
@@ -68,8 +67,6 @@ export * from "./MessageMethodEnum.mjs";
68
67
  export * from "./MessageStatusEnum.mjs";
69
68
  export * from "./MessageProtocolEnum.mjs";
70
69
  export * from "./Message.mjs";
71
- export * from "./MessageWithReaction.mjs";
72
- export * from "./MessageList.mjs";
73
70
  export * from "./ReactionResult.mjs";
74
71
  export * from "./MessageSchedule.mjs";
75
72
  export * from "./Tracking.mjs";
@@ -1,5 +1,4 @@
1
1
  export * from "./BadRequestErrorBody.mjs";
2
- export * from "./NotFoundErrorBody.mjs";
3
2
  export * from "./OptionalContacts.mjs";
4
3
  export * from "./CompanySectorEnum.mjs";
5
4
  export * from "./CompanyTypeEnum.mjs";
@@ -68,8 +67,6 @@ export * from "./MessageMethodEnum.mjs";
68
67
  export * from "./MessageStatusEnum.mjs";
69
68
  export * from "./MessageProtocolEnum.mjs";
70
69
  export * from "./Message.mjs";
71
- export * from "./MessageWithReaction.mjs";
72
- export * from "./MessageList.mjs";
73
70
  export * from "./ReactionResult.mjs";
74
71
  export * from "./MessageSchedule.mjs";
75
72
  export * from "./Tracking.mjs";
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "2.0.2";
1
+ export declare const SDK_VERSION = "2.0.1";
@@ -1 +1 @@
1
- export const SDK_VERSION = "2.0.2";
1
+ export const SDK_VERSION = "2.0.1";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "rcs-js",
3
- "version": "2.0.1-rc.1",
3
+ "version": "2.0.1",
4
4
  "private": false,
5
5
  "repository": "github:pinnacle-dev/rcs-js",
6
6
  "type": "commonjs",