rcs-js 2.0.0-rc.10 → 2.0.0-rc.11

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 (110) hide show
  1. package/dist/cjs/Client.d.ts +3 -0
  2. package/dist/cjs/Client.js +15 -10
  3. package/dist/cjs/api/resources/brands/client/Client.d.ts +2 -0
  4. package/dist/cjs/api/resources/brands/client/Client.js +6 -0
  5. package/dist/cjs/api/resources/campaigns/resources/dlc/client/Client.d.ts +6 -6
  6. package/dist/cjs/api/resources/campaigns/resources/dlc/client/Client.js +6 -6
  7. package/dist/cjs/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.ts +2 -2
  8. package/dist/cjs/api/resources/index.d.ts +2 -0
  9. package/dist/cjs/api/resources/index.js +3 -1
  10. package/dist/cjs/api/resources/messages/client/Client.d.ts +3 -0
  11. package/dist/cjs/api/resources/messages/client/Client.js +9 -0
  12. package/dist/cjs/api/resources/messages/resources/mms/client/Client.d.ts +1 -0
  13. package/dist/cjs/api/resources/messages/resources/mms/client/Client.js +3 -0
  14. package/dist/cjs/api/resources/messages/resources/rcs/client/Client.d.ts +1 -0
  15. package/dist/cjs/api/resources/messages/resources/rcs/client/Client.js +3 -0
  16. package/dist/cjs/api/resources/messages/resources/sms/client/Client.d.ts +1 -0
  17. package/dist/cjs/api/resources/messages/resources/sms/client/Client.js +3 -0
  18. package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/Client.d.ts +2 -0
  19. package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/Client.js +6 -0
  20. package/dist/cjs/api/resources/phoneNumbers/resources/webhook/client/Client.d.ts +1 -0
  21. package/dist/cjs/api/resources/phoneNumbers/resources/webhook/client/Client.js +3 -0
  22. package/dist/cjs/api/resources/rcs/client/Client.d.ts +121 -0
  23. package/dist/cjs/api/resources/rcs/client/Client.js +320 -0
  24. package/dist/cjs/api/resources/rcs/client/index.d.ts +2 -0
  25. package/dist/cjs/api/resources/rcs/client/index.js +17 -0
  26. package/dist/cjs/api/resources/rcs/client/requests/RcsCapabilitiesQuery.d.ts +13 -0
  27. package/dist/cjs/api/resources/rcs/client/requests/RcsCapabilitiesQuery.js +5 -0
  28. package/dist/cjs/api/resources/rcs/client/requests/RcsLinkRequest.d.ts +22 -0
  29. package/dist/cjs/api/resources/rcs/client/requests/RcsLinkRequest.js +5 -0
  30. package/dist/cjs/api/resources/rcs/client/requests/RcsWhitelistRequest.d.ts +16 -0
  31. package/dist/cjs/api/resources/rcs/client/requests/RcsWhitelistRequest.js +5 -0
  32. package/dist/cjs/api/resources/rcs/client/requests/index.d.ts +3 -0
  33. package/dist/cjs/api/resources/rcs/client/requests/index.js +2 -0
  34. package/dist/cjs/api/resources/rcs/index.d.ts +1 -0
  35. package/dist/cjs/api/resources/rcs/index.js +17 -0
  36. package/dist/cjs/api/resources/status/resources/get/client/Client.d.ts +2 -2
  37. package/dist/cjs/api/resources/status/resources/get/client/Client.js +2 -2
  38. package/dist/cjs/api/types/ConversationList.d.ts +4 -4
  39. package/dist/cjs/api/types/DlcCampaignStatus.d.ts +2 -2
  40. package/dist/cjs/api/types/ExtendedRcsCampaign.d.ts +2 -2
  41. package/dist/cjs/api/types/RcsCampaign.d.ts +2 -2
  42. package/dist/cjs/api/types/RcsCapabilitiesResult.d.ts +8 -0
  43. package/dist/cjs/api/types/RcsCapabilitiesResult.js +5 -0
  44. package/dist/cjs/api/types/RcsCapability.d.ts +36 -0
  45. package/dist/cjs/api/types/RcsCapability.js +5 -0
  46. package/dist/cjs/api/types/RcsLinkResult.d.ts +13 -0
  47. package/dist/cjs/api/types/RcsLinkResult.js +5 -0
  48. package/dist/cjs/api/types/RcsValidateContent.d.ts +1 -0
  49. package/dist/cjs/api/types/RcsWhitelistResponse.d.ts +10 -0
  50. package/dist/cjs/api/types/RcsWhitelistResponse.js +5 -0
  51. package/dist/cjs/api/types/index.d.ts +4 -0
  52. package/dist/cjs/api/types/index.js +4 -0
  53. package/dist/cjs/version.d.ts +1 -1
  54. package/dist/cjs/version.js +1 -1
  55. package/dist/esm/Client.d.mts +3 -0
  56. package/dist/esm/Client.mjs +7 -2
  57. package/dist/esm/api/resources/brands/client/Client.d.mts +2 -0
  58. package/dist/esm/api/resources/brands/client/Client.mjs +6 -0
  59. package/dist/esm/api/resources/campaigns/resources/dlc/client/Client.d.mts +6 -6
  60. package/dist/esm/api/resources/campaigns/resources/dlc/client/Client.mjs +6 -6
  61. package/dist/esm/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.mts +2 -2
  62. package/dist/esm/api/resources/index.d.mts +2 -0
  63. package/dist/esm/api/resources/index.mjs +2 -0
  64. package/dist/esm/api/resources/messages/client/Client.d.mts +3 -0
  65. package/dist/esm/api/resources/messages/client/Client.mjs +9 -0
  66. package/dist/esm/api/resources/messages/resources/mms/client/Client.d.mts +1 -0
  67. package/dist/esm/api/resources/messages/resources/mms/client/Client.mjs +3 -0
  68. package/dist/esm/api/resources/messages/resources/rcs/client/Client.d.mts +1 -0
  69. package/dist/esm/api/resources/messages/resources/rcs/client/Client.mjs +3 -0
  70. package/dist/esm/api/resources/messages/resources/sms/client/Client.d.mts +1 -0
  71. package/dist/esm/api/resources/messages/resources/sms/client/Client.mjs +3 -0
  72. package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/Client.d.mts +2 -0
  73. package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/Client.mjs +6 -0
  74. package/dist/esm/api/resources/phoneNumbers/resources/webhook/client/Client.d.mts +1 -0
  75. package/dist/esm/api/resources/phoneNumbers/resources/webhook/client/Client.mjs +3 -0
  76. package/dist/esm/api/resources/rcs/client/Client.d.mts +121 -0
  77. package/dist/esm/api/resources/rcs/client/Client.mjs +283 -0
  78. package/dist/esm/api/resources/rcs/client/index.d.mts +2 -0
  79. package/dist/esm/api/resources/rcs/client/index.mjs +1 -0
  80. package/dist/esm/api/resources/rcs/client/requests/RcsCapabilitiesQuery.d.mts +13 -0
  81. package/dist/esm/api/resources/rcs/client/requests/RcsCapabilitiesQuery.mjs +4 -0
  82. package/dist/esm/api/resources/rcs/client/requests/RcsLinkRequest.d.mts +22 -0
  83. package/dist/esm/api/resources/rcs/client/requests/RcsLinkRequest.mjs +4 -0
  84. package/dist/esm/api/resources/rcs/client/requests/RcsWhitelistRequest.d.mts +16 -0
  85. package/dist/esm/api/resources/rcs/client/requests/RcsWhitelistRequest.mjs +4 -0
  86. package/dist/esm/api/resources/rcs/client/requests/index.d.mts +3 -0
  87. package/dist/esm/api/resources/rcs/client/requests/index.mjs +1 -0
  88. package/dist/esm/api/resources/rcs/index.d.mts +1 -0
  89. package/dist/esm/api/resources/rcs/index.mjs +1 -0
  90. package/dist/esm/api/resources/status/resources/get/client/Client.d.mts +2 -2
  91. package/dist/esm/api/resources/status/resources/get/client/Client.mjs +2 -2
  92. package/dist/esm/api/types/ConversationList.d.mts +4 -4
  93. package/dist/esm/api/types/DlcCampaignStatus.d.mts +2 -2
  94. package/dist/esm/api/types/ExtendedRcsCampaign.d.mts +2 -2
  95. package/dist/esm/api/types/RcsCampaign.d.mts +2 -2
  96. package/dist/esm/api/types/RcsCapabilitiesResult.d.mts +8 -0
  97. package/dist/esm/api/types/RcsCapabilitiesResult.mjs +4 -0
  98. package/dist/esm/api/types/RcsCapability.d.mts +36 -0
  99. package/dist/esm/api/types/RcsCapability.mjs +4 -0
  100. package/dist/esm/api/types/RcsLinkResult.d.mts +13 -0
  101. package/dist/esm/api/types/RcsLinkResult.mjs +4 -0
  102. package/dist/esm/api/types/RcsValidateContent.d.mts +1 -0
  103. package/dist/esm/api/types/RcsWhitelistResponse.d.mts +10 -0
  104. package/dist/esm/api/types/RcsWhitelistResponse.mjs +4 -0
  105. package/dist/esm/api/types/index.d.mts +4 -0
  106. package/dist/esm/api/types/index.mjs +4 -0
  107. package/dist/esm/version.d.mts +1 -1
  108. package/dist/esm/version.mjs +1 -1
  109. package/package.json +1 -1
  110. package/reference.md +237 -8
@@ -102,6 +102,10 @@ export * from "./DetachedWebhookInfo.js";
102
102
  export * from "./MessagingProfileEnum.js";
103
103
  export * from "./AttachedPhoneNumberResult.js";
104
104
  export * from "./DetachedPhoneNumberResult.js";
105
+ export * from "./RcsCapability.js";
106
+ export * from "./RcsCapabilitiesResult.js";
107
+ export * from "./RcsWhitelistResponse.js";
108
+ export * from "./RcsLinkResult.js";
105
109
  export * from "./BrandStatus.js";
106
110
  export * from "./TollFreeStatusEnum.js";
107
111
  export * from "./TollFreeCampaignStatus.js";
@@ -118,6 +118,10 @@ __exportStar(require("./DetachedWebhookInfo.js"), exports);
118
118
  __exportStar(require("./MessagingProfileEnum.js"), exports);
119
119
  __exportStar(require("./AttachedPhoneNumberResult.js"), exports);
120
120
  __exportStar(require("./DetachedPhoneNumberResult.js"), exports);
121
+ __exportStar(require("./RcsCapability.js"), exports);
122
+ __exportStar(require("./RcsCapabilitiesResult.js"), exports);
123
+ __exportStar(require("./RcsWhitelistResponse.js"), exports);
124
+ __exportStar(require("./RcsLinkResult.js"), exports);
121
125
  __exportStar(require("./BrandStatus.js"), exports);
122
126
  __exportStar(require("./TollFreeStatusEnum.js"), exports);
123
127
  __exportStar(require("./TollFreeCampaignStatus.js"), exports);
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "2.0.0-rc.10";
1
+ export declare const SDK_VERSION = "2.0.0-rc.11";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "2.0.0-rc.10";
4
+ exports.SDK_VERSION = "2.0.0-rc.11";
@@ -8,6 +8,7 @@ import { Contacts } from "./api/resources/contacts/client/Client.mjs";
8
8
  import { Conversations } from "./api/resources/conversations/client/Client.mjs";
9
9
  import { Messages } from "./api/resources/messages/client/Client.mjs";
10
10
  import { PhoneNumbers } from "./api/resources/phoneNumbers/client/Client.mjs";
11
+ import { Rcs } from "./api/resources/rcs/client/Client.mjs";
11
12
  import { Webhooks } from "./api/resources/webhooks/client/Client.mjs";
12
13
  import { Campaigns } from "./api/resources/campaigns/client/Client.mjs";
13
14
  import { Status } from "./api/resources/status/client/Client.mjs";
@@ -41,6 +42,7 @@ export declare class PinnacleClient {
41
42
  protected _conversations: Conversations | undefined;
42
43
  protected _messages: Messages | undefined;
43
44
  protected _phoneNumbers: PhoneNumbers | undefined;
45
+ protected _rcs: Rcs | undefined;
44
46
  protected _webhooks: Webhooks | undefined;
45
47
  protected _campaigns: Campaigns | undefined;
46
48
  protected _status: Status | undefined;
@@ -51,6 +53,7 @@ export declare class PinnacleClient {
51
53
  get conversations(): Conversations;
52
54
  get messages(): Messages;
53
55
  get phoneNumbers(): PhoneNumbers;
56
+ get rcs(): Rcs;
54
57
  get webhooks(): Webhooks;
55
58
  get campaigns(): Campaigns;
56
59
  get status(): Status;
@@ -8,6 +8,7 @@ import { Contacts } from "./api/resources/contacts/client/Client.mjs";
8
8
  import { Conversations } from "./api/resources/conversations/client/Client.mjs";
9
9
  import { Messages } from "./api/resources/messages/client/Client.mjs";
10
10
  import { PhoneNumbers } from "./api/resources/phoneNumbers/client/Client.mjs";
11
+ import { Rcs } from "./api/resources/rcs/client/Client.mjs";
11
12
  import { Webhooks } from "./api/resources/webhooks/client/Client.mjs";
12
13
  import { Campaigns } from "./api/resources/campaigns/client/Client.mjs";
13
14
  import { Status } from "./api/resources/status/client/Client.mjs";
@@ -17,8 +18,8 @@ export class PinnacleClient {
17
18
  this._options = Object.assign(Object.assign({}, _options), { headers: mergeHeaders({
18
19
  "X-Fern-Language": "JavaScript",
19
20
  "X-Fern-SDK-Name": "rcs-js",
20
- "X-Fern-SDK-Version": "2.0.0-rc.10",
21
- "User-Agent": "rcs-js/2.0.0-rc.10",
21
+ "X-Fern-SDK-Version": "2.0.0-rc.11",
22
+ "User-Agent": "rcs-js/2.0.0-rc.11",
22
23
  "X-Fern-Runtime": core.RUNTIME.type,
23
24
  "X-Fern-Runtime-Version": core.RUNTIME.version,
24
25
  }, _options === null || _options === void 0 ? void 0 : _options.headers) });
@@ -43,6 +44,10 @@ export class PinnacleClient {
43
44
  var _a;
44
45
  return ((_a = this._phoneNumbers) !== null && _a !== void 0 ? _a : (this._phoneNumbers = new PhoneNumbers(this._options)));
45
46
  }
47
+ get rcs() {
48
+ var _a;
49
+ return ((_a = this._rcs) !== null && _a !== void 0 ? _a : (this._rcs = new Rcs(this._options)));
50
+ }
46
51
  get webhooks() {
47
52
  var _a;
48
53
  return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Webhooks(this._options)));
@@ -111,6 +111,7 @@ export declare class Brands {
111
111
  * @throws {@link Pinnacle.BadRequestError}
112
112
  * @throws {@link Pinnacle.UnauthorizedError}
113
113
  * @throws {@link Pinnacle.PaymentRequiredError}
114
+ * @throws {@link Pinnacle.NotFoundError}
114
115
  * @throws {@link Pinnacle.InternalServerError}
115
116
  * @throws {@link Pinnacle.NotImplementedError}
116
117
  *
@@ -162,6 +163,7 @@ export declare class Brands {
162
163
  * @throws {@link Pinnacle.BadRequestError}
163
164
  * @throws {@link Pinnacle.UnauthorizedError}
164
165
  * @throws {@link Pinnacle.PaymentRequiredError}
166
+ * @throws {@link Pinnacle.NotFoundError}
165
167
  * @throws {@link Pinnacle.InternalServerError}
166
168
  * @throws {@link Pinnacle.NotImplementedError}
167
169
  *
@@ -264,6 +264,7 @@ export class Brands {
264
264
  * @throws {@link Pinnacle.BadRequestError}
265
265
  * @throws {@link Pinnacle.UnauthorizedError}
266
266
  * @throws {@link Pinnacle.PaymentRequiredError}
267
+ * @throws {@link Pinnacle.NotFoundError}
267
268
  * @throws {@link Pinnacle.InternalServerError}
268
269
  * @throws {@link Pinnacle.NotImplementedError}
269
270
  *
@@ -297,6 +298,8 @@ export class Brands {
297
298
  throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
298
299
  case 402:
299
300
  throw new Pinnacle.PaymentRequiredError(_response.error.body, _response.rawResponse);
301
+ case 404:
302
+ throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
300
303
  case 500:
301
304
  throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
302
305
  case 501:
@@ -422,6 +425,7 @@ export class Brands {
422
425
  * @throws {@link Pinnacle.BadRequestError}
423
426
  * @throws {@link Pinnacle.UnauthorizedError}
424
427
  * @throws {@link Pinnacle.PaymentRequiredError}
428
+ * @throws {@link Pinnacle.NotFoundError}
425
429
  * @throws {@link Pinnacle.InternalServerError}
426
430
  * @throws {@link Pinnacle.NotImplementedError}
427
431
  *
@@ -458,6 +462,8 @@ export class Brands {
458
462
  throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
459
463
  case 402:
460
464
  throw new Pinnacle.PaymentRequiredError(_response.error.body, _response.rawResponse);
465
+ case 404:
466
+ throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
461
467
  case 500:
462
468
  throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
463
469
  case 501:
@@ -48,9 +48,9 @@ export declare class Dlc {
48
48
  autofill(request: Pinnacle.AutofillCampaignParams, requestOptions?: Dlc.RequestOptions): core.HttpResponsePromise<Pinnacle.AutofillDlcCampaignResponse>;
49
49
  private __autofill;
50
50
  /**
51
- * Retrieve DLC campaign.
51
+ * Retrieve 10DLC campaign.
52
52
  *
53
- * @param {number} campaignId - Unique identifier of the DLC campaign.
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}
@@ -64,9 +64,9 @@ export declare class Dlc {
64
64
  get(campaignId: number, requestOptions?: Dlc.RequestOptions): core.HttpResponsePromise<Pinnacle.DlcCampaignWithExtendedBrandAndStatus>;
65
65
  private __get;
66
66
  /**
67
- * Submit your DLC campaign for approval and activation with carriers.
67
+ * Submit your 10DLC campaign for approval and activation with carriers.
68
68
  *
69
- * @param {number} campaignId - Unique identifier of the DLC campaign to submit.
69
+ * @param {number} campaignId - Unique identifier of the 10DLC campaign to submit.
70
70
  * @param {Dlc.RequestOptions} requestOptions - Request-specific configuration.
71
71
  *
72
72
  * @throws {@link Pinnacle.BadRequestError}
@@ -80,7 +80,7 @@ export declare class Dlc {
80
80
  submit(campaignId: number, requestOptions?: Dlc.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignSubmissionResult>;
81
81
  private __submit;
82
82
  /**
83
- * Create a new DLC campaign or updates an existing one. <br>
83
+ * Create a new 10DLC campaign or updates an existing one. <br>
84
84
  *
85
85
  * Omit campaignId to create a campaign.
86
86
  *
@@ -135,7 +135,7 @@ export declare class Dlc {
135
135
  upsert(request?: Pinnacle.campaigns.UpsertDlcCampaignParams, requestOptions?: Dlc.RequestOptions): core.HttpResponsePromise<Pinnacle.DlcCampaignWithExtendedBrandAndStatus>;
136
136
  private __upsert;
137
137
  /**
138
- * Validate your DLC campaign configuration against carrier requirements and compliance rules.
138
+ * Validate your 10DLC campaign configuration against carrier requirements and compliance rules.
139
139
  *
140
140
  * @param {Pinnacle.ValidateCampaignParams} request
141
141
  * @param {Dlc.RequestOptions} requestOptions - Request-specific configuration.
@@ -91,9 +91,9 @@ export class Dlc {
91
91
  });
92
92
  }
93
93
  /**
94
- * Retrieve DLC campaign.
94
+ * Retrieve 10DLC campaign.
95
95
  *
96
- * @param {number} campaignId - Unique identifier of the DLC campaign.
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}
@@ -162,9 +162,9 @@ export class Dlc {
162
162
  });
163
163
  }
164
164
  /**
165
- * Submit your DLC campaign for approval and activation with carriers.
165
+ * Submit your 10DLC campaign for approval and activation with carriers.
166
166
  *
167
- * @param {number} campaignId - Unique identifier of the DLC campaign to submit.
167
+ * @param {number} campaignId - Unique identifier of the 10DLC campaign to submit.
168
168
  * @param {Dlc.RequestOptions} requestOptions - Request-specific configuration.
169
169
  *
170
170
  * @throws {@link Pinnacle.BadRequestError}
@@ -230,7 +230,7 @@ export class Dlc {
230
230
  });
231
231
  }
232
232
  /**
233
- * Create a new DLC campaign or updates an existing one. <br>
233
+ * Create a new 10DLC campaign or updates an existing one. <br>
234
234
  *
235
235
  * Omit campaignId to create a campaign.
236
236
  *
@@ -343,7 +343,7 @@ export class Dlc {
343
343
  });
344
344
  }
345
345
  /**
346
- * Validate your DLC campaign configuration against carrier requirements and compliance rules.
346
+ * Validate your 10DLC campaign configuration against carrier requirements and compliance rules.
347
347
  *
348
348
  * @param {Pinnacle.ValidateCampaignParams} request
349
349
  * @param {Dlc.RequestOptions} requestOptions - Request-specific configuration.
@@ -80,9 +80,9 @@ export declare namespace UpsertRcsCampaignParams {
80
80
  description?: string;
81
81
  /** List of emails (1-3 required). */
82
82
  emails?: Agent.Emails.Item[];
83
- /** Link to the agent's hero. */
83
+ /** Link to the agent's hero. Hero must be an image file with dimensions 1440x448px. */
84
84
  heroUrl?: string;
85
- /** Link to the agent's icon. */
85
+ /** Link to the agent's icon. Icon must be an image file with dimensions 224x224px. */
86
86
  iconUrl?: string;
87
87
  /** Name of the agent. */
88
88
  name?: string;
@@ -5,6 +5,7 @@ export * as messages from "./messages/index.mjs";
5
5
  export * as brands from "./brands/index.mjs";
6
6
  export * as contacts from "./contacts/index.mjs";
7
7
  export * as conversations from "./conversations/index.mjs";
8
+ export * as rcs from "./rcs/index.mjs";
8
9
  export * as webhooks from "./webhooks/index.mjs";
9
10
  export * as status from "./status/index.mjs";
10
11
  export * as tools from "./tools/index.mjs";
@@ -13,4 +14,5 @@ export * from "./contacts/client/requests/index.mjs";
13
14
  export * from "./conversations/client/requests/index.mjs";
14
15
  export * from "./messages/client/requests/index.mjs";
15
16
  export * from "./phoneNumbers/client/requests/index.mjs";
17
+ export * from "./rcs/client/requests/index.mjs";
16
18
  export * from "./webhooks/client/requests/index.mjs";
@@ -5,6 +5,7 @@ export * as messages from "./messages/index.mjs";
5
5
  export * as brands from "./brands/index.mjs";
6
6
  export * as contacts from "./contacts/index.mjs";
7
7
  export * as conversations from "./conversations/index.mjs";
8
+ export * as rcs from "./rcs/index.mjs";
8
9
  export * as webhooks from "./webhooks/index.mjs";
9
10
  export * as status from "./status/index.mjs";
10
11
  export * as tools from "./tools/index.mjs";
@@ -13,4 +14,5 @@ export * from "./contacts/client/requests/index.mjs";
13
14
  export * from "./conversations/client/requests/index.mjs";
14
15
  export * from "./messages/client/requests/index.mjs";
15
16
  export * from "./phoneNumbers/client/requests/index.mjs";
17
+ export * from "./rcs/client/requests/index.mjs";
16
18
  export * from "./webhooks/client/requests/index.mjs";
@@ -62,7 +62,10 @@ export declare class Messages {
62
62
  *
63
63
  * @throws {@link Pinnacle.BadRequestError}
64
64
  * @throws {@link Pinnacle.UnauthorizedError}
65
+ * @throws {@link Pinnacle.PaymentRequiredError}
65
66
  * @throws {@link Pinnacle.NotFoundError}
67
+ * @throws {@link Pinnacle.InternalServerError}
68
+ * @throws {@link Pinnacle.NotImplementedError}
66
69
  *
67
70
  * @example
68
71
  * await client.messages.react({
@@ -110,7 +110,10 @@ export class Messages {
110
110
  *
111
111
  * @throws {@link Pinnacle.BadRequestError}
112
112
  * @throws {@link Pinnacle.UnauthorizedError}
113
+ * @throws {@link Pinnacle.PaymentRequiredError}
113
114
  * @throws {@link Pinnacle.NotFoundError}
115
+ * @throws {@link Pinnacle.InternalServerError}
116
+ * @throws {@link Pinnacle.NotImplementedError}
114
117
  *
115
118
  * @example
116
119
  * await client.messages.react({
@@ -149,8 +152,14 @@ export class Messages {
149
152
  throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
150
153
  case 401:
151
154
  throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
155
+ case 402:
156
+ throw new Pinnacle.PaymentRequiredError(_response.error.body, _response.rawResponse);
152
157
  case 404:
153
158
  throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
159
+ case 500:
160
+ throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
161
+ case 501:
162
+ throw new Pinnacle.NotImplementedError(_response.error.body, _response.rawResponse);
154
163
  default:
155
164
  throw new errors.PinnacleError({
156
165
  statusCode: _response.error.statusCode,
@@ -40,6 +40,7 @@ export declare class Mms {
40
40
  * @throws {@link Pinnacle.PaymentRequiredError}
41
41
  * @throws {@link Pinnacle.NotFoundError}
42
42
  * @throws {@link Pinnacle.InternalServerError}
43
+ * @throws {@link Pinnacle.NotImplementedError}
43
44
  *
44
45
  * @example
45
46
  * await client.messages.mms.send({
@@ -30,6 +30,7 @@ export class Mms {
30
30
  * @throws {@link Pinnacle.PaymentRequiredError}
31
31
  * @throws {@link Pinnacle.NotFoundError}
32
32
  * @throws {@link Pinnacle.InternalServerError}
33
+ * @throws {@link Pinnacle.NotImplementedError}
33
34
  *
34
35
  * @example
35
36
  * await client.messages.mms.send({
@@ -77,6 +78,8 @@ export class Mms {
77
78
  throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
78
79
  case 500:
79
80
  throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
81
+ case 501:
82
+ throw new Pinnacle.NotImplementedError(_response.error.body, _response.rawResponse);
80
83
  default:
81
84
  throw new errors.PinnacleError({
82
85
  statusCode: _response.error.statusCode,
@@ -42,6 +42,7 @@ export declare class Rcs {
42
42
  * @throws {@link Pinnacle.PaymentRequiredError}
43
43
  * @throws {@link Pinnacle.NotFoundError}
44
44
  * @throws {@link Pinnacle.InternalServerError}
45
+ * @throws {@link Pinnacle.NotImplementedError}
45
46
  *
46
47
  * @example
47
48
  * await client.messages.rcs.send({
@@ -32,6 +32,7 @@ export class Rcs {
32
32
  * @throws {@link Pinnacle.PaymentRequiredError}
33
33
  * @throws {@link Pinnacle.NotFoundError}
34
34
  * @throws {@link Pinnacle.InternalServerError}
35
+ * @throws {@link Pinnacle.NotImplementedError}
35
36
  *
36
37
  * @example
37
38
  * await client.messages.rcs.send({
@@ -79,6 +80,8 @@ export class Rcs {
79
80
  throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
80
81
  case 500:
81
82
  throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
83
+ case 501:
84
+ throw new Pinnacle.NotImplementedError(_response.error.body, _response.rawResponse);
82
85
  default:
83
86
  throw new errors.PinnacleError({
84
87
  statusCode: _response.error.statusCode,
@@ -40,6 +40,7 @@ export declare class Sms {
40
40
  * @throws {@link Pinnacle.PaymentRequiredError}
41
41
  * @throws {@link Pinnacle.NotFoundError}
42
42
  * @throws {@link Pinnacle.InternalServerError}
43
+ * @throws {@link Pinnacle.NotImplementedError}
43
44
  *
44
45
  * @example
45
46
  * await client.messages.sms.send({
@@ -30,6 +30,7 @@ export class Sms {
30
30
  * @throws {@link Pinnacle.PaymentRequiredError}
31
31
  * @throws {@link Pinnacle.NotFoundError}
32
32
  * @throws {@link Pinnacle.InternalServerError}
33
+ * @throws {@link Pinnacle.NotImplementedError}
33
34
  *
34
35
  * @example
35
36
  * await client.messages.sms.send({
@@ -72,6 +73,8 @@ export class Sms {
72
73
  throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
73
74
  case 500:
74
75
  throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
76
+ case 501:
77
+ throw new Pinnacle.NotImplementedError(_response.error.body, _response.rawResponse);
75
78
  default:
76
79
  throw new errors.PinnacleError({
77
80
  statusCode: _response.error.statusCode,
@@ -39,6 +39,7 @@ export declare class Campaign {
39
39
  * @throws {@link Pinnacle.UnauthorizedError}
40
40
  * @throws {@link Pinnacle.NotFoundError}
41
41
  * @throws {@link Pinnacle.InternalServerError}
42
+ * @throws {@link Pinnacle.NotImplementedError}
42
43
  *
43
44
  * @example
44
45
  * await client.phoneNumbers.campaign.attach({
@@ -59,6 +60,7 @@ export declare class Campaign {
59
60
  * @throws {@link Pinnacle.UnauthorizedError}
60
61
  * @throws {@link Pinnacle.NotFoundError}
61
62
  * @throws {@link Pinnacle.InternalServerError}
63
+ * @throws {@link Pinnacle.NotImplementedError}
62
64
  *
63
65
  * @example
64
66
  * await client.phoneNumbers.campaign.detach({
@@ -29,6 +29,7 @@ export class Campaign {
29
29
  * @throws {@link Pinnacle.UnauthorizedError}
30
30
  * @throws {@link Pinnacle.NotFoundError}
31
31
  * @throws {@link Pinnacle.InternalServerError}
32
+ * @throws {@link Pinnacle.NotImplementedError}
32
33
  *
33
34
  * @example
34
35
  * await client.phoneNumbers.campaign.attach({
@@ -69,6 +70,8 @@ export class Campaign {
69
70
  throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
70
71
  case 500:
71
72
  throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
73
+ case 501:
74
+ throw new Pinnacle.NotImplementedError(_response.error.body, _response.rawResponse);
72
75
  default:
73
76
  throw new errors.PinnacleError({
74
77
  statusCode: _response.error.statusCode,
@@ -104,6 +107,7 @@ export class Campaign {
104
107
  * @throws {@link Pinnacle.UnauthorizedError}
105
108
  * @throws {@link Pinnacle.NotFoundError}
106
109
  * @throws {@link Pinnacle.InternalServerError}
110
+ * @throws {@link Pinnacle.NotImplementedError}
107
111
  *
108
112
  * @example
109
113
  * await client.phoneNumbers.campaign.detach({
@@ -142,6 +146,8 @@ export class Campaign {
142
146
  throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
143
147
  case 500:
144
148
  throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
149
+ case 501:
150
+ throw new Pinnacle.NotImplementedError(_response.error.body, _response.rawResponse);
145
151
  default:
146
152
  throw new errors.PinnacleError({
147
153
  statusCode: _response.error.statusCode,
@@ -68,6 +68,7 @@ export declare class Webhook {
68
68
  * @throws {@link Pinnacle.UnauthorizedError}
69
69
  * @throws {@link Pinnacle.NotFoundError}
70
70
  * @throws {@link Pinnacle.InternalServerError}
71
+ * @throws {@link Pinnacle.NotImplementedError}
71
72
  *
72
73
  * @example
73
74
  * await client.phoneNumbers.webhook.detach("+14155551234", 123)
@@ -115,6 +115,7 @@ export class Webhook {
115
115
  * @throws {@link Pinnacle.UnauthorizedError}
116
116
  * @throws {@link Pinnacle.NotFoundError}
117
117
  * @throws {@link Pinnacle.InternalServerError}
118
+ * @throws {@link Pinnacle.NotImplementedError}
118
119
  *
119
120
  * @example
120
121
  * await client.phoneNumbers.webhook.detach("+14155551234", 123)
@@ -148,6 +149,8 @@ export class Webhook {
148
149
  throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
149
150
  case 500:
150
151
  throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
152
+ case 501:
153
+ throw new Pinnacle.NotImplementedError(_response.error.body, _response.rawResponse);
151
154
  default:
152
155
  throw new errors.PinnacleError({
153
156
  statusCode: _response.error.statusCode,
@@ -0,0 +1,121 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as environments from "../../../../environments.mjs";
5
+ import * as core from "../../../../core/index.mjs";
6
+ import * as Pinnacle from "../../../index.mjs";
7
+ export declare namespace Rcs {
8
+ interface Options {
9
+ environment?: core.Supplier<environments.PinnacleEnvironment | string>;
10
+ /** Specify a custom URL to connect the client to. */
11
+ baseUrl?: core.Supplier<string>;
12
+ apiKey: core.Supplier<string>;
13
+ /** Additional headers to include in requests. */
14
+ headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
15
+ }
16
+ interface RequestOptions {
17
+ /** The maximum time to wait for a response in seconds. */
18
+ timeoutInSeconds?: number;
19
+ /** The number of times to retry the request. Defaults to 2. */
20
+ maxRetries?: number;
21
+ /** A hook to abort the request. */
22
+ abortSignal?: AbortSignal;
23
+ /** Additional query string parameters to include in the request. */
24
+ queryParams?: Record<string, unknown>;
25
+ /** Additional headers to include in the request. */
26
+ headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
27
+ }
28
+ }
29
+ export declare class Rcs {
30
+ protected readonly _options: Rcs.Options;
31
+ constructor(_options: Rcs.Options);
32
+ /**
33
+ * Check RCS capabilities for one or more phone numbers.
34
+ *
35
+ * This endpoint allows you to verify which RCS features (cards, buttons, etc.) are supported
36
+ * on specific phone numbers before sending RCS messages to them.
37
+ *
38
+ * @param {Pinnacle.RcsCapabilitiesQuery} request
39
+ * @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
40
+ *
41
+ * @throws {@link Pinnacle.BadRequestError}
42
+ * @throws {@link Pinnacle.UnauthorizedError}
43
+ * @throws {@link Pinnacle.InternalServerError}
44
+ * @throws {@link Pinnacle.NotImplementedError}
45
+ *
46
+ * @example
47
+ * await client.rcs.getCapabilities({
48
+ * phoneNumbers: ["+12345678901", "+19876543210"]
49
+ * })
50
+ */
51
+ getCapabilities(request: Pinnacle.RcsCapabilitiesQuery, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.RcsCapabilitiesResult>;
52
+ private __getCapabilities;
53
+ /**
54
+ * Whitelist a phone number for testing with your test RCS agent.
55
+ *
56
+ * ## Overview
57
+ * During development and testing, RCS agents can only send messages to whitelisted phone numbers.
58
+ * Use this endpoint to add test devices to your agent's whitelist before sending test messages.
59
+ *
60
+ * ## Verification Process
61
+ * After whitelisting a number, you'll need to complete verification:
62
+ *
63
+ * 1. Check the test device for an "RBM Tester Management" request
64
+ * 2. Accept the request on the device
65
+ * 3. Enter the 4-digit verification code in the Pinnacle dashboard at:
66
+ * ```
67
+ * https://app.pinnacle.sh/dashboard/brands/{brandId}?campaignId={campaignId}&campaignType=RCS
68
+ * ```
69
+ *
70
+ * > **Important Notes**
71
+ * >
72
+ * > - **Testing only:** This is only required for test agents. Production agents can message any RCS-enabled number
73
+ * > - **AT&T limitation:** Whitelisting may currently fail for AT&T numbers
74
+ * > - **Verification required:** The whitelist request isn't complete until you verify the device.
75
+ *
76
+ * @param {Pinnacle.RcsWhitelistRequest} request
77
+ * @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
78
+ *
79
+ * @throws {@link Pinnacle.BadRequestError}
80
+ * @throws {@link Pinnacle.UnauthorizedError}
81
+ * @throws {@link Pinnacle.NotFoundError}
82
+ * @throws {@link Pinnacle.InternalServerError}
83
+ * @throws {@link Pinnacle.NotImplementedError}
84
+ *
85
+ * @example
86
+ * await client.rcs.whitelist({
87
+ * agentId: "agent_XXXXXXXXXXXX",
88
+ * phoneNumber: "+12345678901"
89
+ * })
90
+ */
91
+ whitelist(request: Pinnacle.RcsWhitelistRequest, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.RcsWhitelistResponse>;
92
+ private __whitelist;
93
+ /**
94
+ * Generate a link for initiating an RCS conversation with your agent.
95
+ *
96
+ * Users can click these links to start conversations with your RCS agent directly
97
+ * from websites, emails, or other applications.
98
+ *
99
+ * @param {Pinnacle.RcsLinkRequest} request
100
+ * @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
101
+ *
102
+ * @throws {@link Pinnacle.BadRequestError}
103
+ * @throws {@link Pinnacle.UnauthorizedError}
104
+ * @throws {@link Pinnacle.NotFoundError}
105
+ * @throws {@link Pinnacle.InternalServerError}
106
+ * @throws {@link Pinnacle.NotImplementedError}
107
+ *
108
+ * @example
109
+ * await client.rcs.getLink({
110
+ * agentId: "agent_XXXXXXXXXXXX",
111
+ * testMode: false,
112
+ * phoneNumber: "+12345678901",
113
+ * body: "Hello, I need help with my order"
114
+ * })
115
+ */
116
+ getLink(request: Pinnacle.RcsLinkRequest, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.RcsLinkResult>;
117
+ private __getLink;
118
+ protected _getCustomAuthorizationHeaders(): Promise<{
119
+ "PINNACLE-API-KEY": string;
120
+ }>;
121
+ }