rcs-js 2.0.0-rc.8 → 2.0.0

package/dist/cjs/api/resources/conversations/client/Client.d.ts

@@ -9,7 +9,7 @@ export declare namespace Conversations {
         environment?: core.Supplier<environments.PinnacleEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        apiKey: core.Supplier<string>;
+        apiKey?: core.Supplier<string | undefined>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
@@ -28,7 +28,7 @@ export declare namespace Conversations {
 }
 export declare class Conversations {
     protected readonly _options: Conversations.Options;
-    constructor(_options: Conversations.Options);
+    constructor(_options?: Conversations.Options);
     /**
      * Fetch a specific conversation using either its unique identifier or by matching sender and recipient details.
      *
@@ -44,7 +44,7 @@ export declare class Conversations {
      *         id: 1
      *     })
      */
-    get(request: Pinnacle.GetConversationParams, requestOptions?: Conversations.RequestOptions): core.HttpResponsePromise<(Pinnacle.Conversation | null) | undefined>;
+    get(request: Pinnacle.GetConversationParams, requestOptions?: Conversations.RequestOptions): core.HttpResponsePromise<Pinnacle.Conversation | null>;
     private __get;
     /**
      * Retrieves conversations by page with optional filtering based off provided parameters.
@@ -88,6 +88,6 @@ export declare class Conversations {
     update(request: Pinnacle.UpdateConversationParams, requestOptions?: Conversations.RequestOptions): core.HttpResponsePromise<Pinnacle.SuccessfulConversationUpdate>;
     private __update;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        "PINNACLE-API-KEY": string;
+        "PINNACLE-API-KEY": string | undefined;
     }>;
 }

package/dist/cjs/api/resources/conversations/client/Client.js

@@ -52,7 +52,7 @@ const Pinnacle = __importStar(require("../../../index.js"));
 const headers_js_1 = require("../../../../core/headers.js");
 const errors = __importStar(require("../../../../errors/index.js"));
 class Conversations {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
@@ -90,10 +90,7 @@ class Conversations {
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
-                return {
-                    data: _response.body,
-                    rawResponse: _response.rawResponse,
-                };
+                return { data: _response.body, rawResponse: _response.rawResponse };
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {

package/dist/cjs/api/resources/index.d.ts

@@ -5,6 +5,7 @@ export * as messages from "./messages/index.js";
 export * as brands from "./brands/index.js";
 export * as contacts from "./contacts/index.js";
 export * as conversations from "./conversations/index.js";
+export * as rcs from "./rcs/index.js";
 export * as webhooks from "./webhooks/index.js";
 export * as status from "./status/index.js";
 export * as tools from "./tools/index.js";
@@ -13,4 +14,5 @@ export * from "./contacts/client/requests/index.js";
 export * from "./conversations/client/requests/index.js";
 export * from "./messages/client/requests/index.js";
 export * from "./phoneNumbers/client/requests/index.js";
+export * from "./rcs/client/requests/index.js";
 export * from "./webhooks/client/requests/index.js";

package/dist/cjs/api/resources/index.js

@@ -36,7 +36,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.tools = exports.status = exports.webhooks = exports.conversations = exports.contacts = exports.brands = exports.messages = exports.campaigns = exports.phoneNumbers = void 0;
+exports.tools = exports.status = exports.webhooks = exports.rcs = exports.conversations = exports.contacts = exports.brands = exports.messages = exports.campaigns = exports.phoneNumbers = void 0;
 exports.phoneNumbers = __importStar(require("./phoneNumbers/index.js"));
 __exportStar(require("./phoneNumbers/types/index.js"), exports);
 exports.campaigns = __importStar(require("./campaigns/index.js"));
@@ -44,6 +44,7 @@ exports.messages = __importStar(require("./messages/index.js"));
 exports.brands = __importStar(require("./brands/index.js"));
 exports.contacts = __importStar(require("./contacts/index.js"));
 exports.conversations = __importStar(require("./conversations/index.js"));
+exports.rcs = __importStar(require("./rcs/index.js"));
 exports.webhooks = __importStar(require("./webhooks/index.js"));
 exports.status = __importStar(require("./status/index.js"));
 exports.tools = __importStar(require("./tools/index.js"));
@@ -52,4 +53,5 @@ __exportStar(require("./contacts/client/requests/index.js"), exports);
 __exportStar(require("./conversations/client/requests/index.js"), exports);
 __exportStar(require("./messages/client/requests/index.js"), exports);
 __exportStar(require("./phoneNumbers/client/requests/index.js"), exports);
+__exportStar(require("./rcs/client/requests/index.js"), exports);
 __exportStar(require("./webhooks/client/requests/index.js"), exports);

package/dist/cjs/api/resources/messages/client/Client.d.ts

@@ -12,7 +12,7 @@ export declare namespace Messages {
         environment?: core.Supplier<environments.PinnacleEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        apiKey: core.Supplier<string>;
+        apiKey?: core.Supplier<string | undefined>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
@@ -34,7 +34,7 @@ export declare class Messages {
     protected _sms: Sms | undefined;
     protected _mms: Mms | undefined;
     protected _rcs: Rcs | undefined;
-    constructor(_options: Messages.Options);
+    constructor(_options?: Messages.Options);
     get sms(): Sms;
     get mms(): Mms;
     get rcs(): Rcs;
@@ -62,7 +62,10 @@ export declare class Messages {
      *
      * @throws {@link Pinnacle.BadRequestError}
      * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.PaymentRequiredError}
      * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
      *     await client.messages.react({
@@ -76,6 +79,6 @@ export declare class Messages {
     react(request: Pinnacle.ReactMessageParams, requestOptions?: Messages.RequestOptions): core.HttpResponsePromise<Pinnacle.ReactionResult>;
     private __react;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        "PINNACLE-API-KEY": string;
+        "PINNACLE-API-KEY": string | undefined;
     }>;
 }

package/dist/cjs/api/resources/messages/client/Client.js

@@ -55,7 +55,7 @@ const Client_js_1 = require("../resources/sms/client/Client.js");
 const Client_js_2 = require("../resources/mms/client/Client.js");
 const Client_js_3 = require("../resources/rcs/client/Client.js");
 class Messages {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     get sms() {
@@ -146,7 +146,10 @@ class Messages {
      *
      * @throws {@link Pinnacle.BadRequestError}
      * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.PaymentRequiredError}
      * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
      *     await client.messages.react({
@@ -185,8 +188,14 @@ class Messages {
                         throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
                     case 401:
                         throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 402:
+                        throw new Pinnacle.PaymentRequiredError(_response.error.body, _response.rawResponse);
                     case 404:
                         throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
+                    case 501:
+                        throw new Pinnacle.NotImplementedError(_response.error.body, _response.rawResponse);
                     default:
                         throw new errors.PinnacleError({
                             statusCode: _response.error.statusCode,

package/dist/cjs/api/resources/messages/client/requests/ReactMessageParams.d.ts

@@ -20,7 +20,7 @@ export interface ReactMessageParams {
      *
      * Use `null` to remove existing reaction.
      */
-    reaction?: string | null;
+    reaction: string | null;
 }
 export declare namespace ReactMessageParams {
     interface Options {

package/dist/cjs/api/resources/messages/resources/mms/client/Client.d.ts

@@ -9,7 +9,7 @@ export declare namespace Mms {
         environment?: core.Supplier<environments.PinnacleEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        apiKey: core.Supplier<string>;
+        apiKey?: core.Supplier<string | undefined>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
@@ -28,7 +28,7 @@ export declare namespace Mms {
 }
 export declare class Mms {
     protected readonly _options: Mms.Options;
-    constructor(_options: Mms.Options);
+    constructor(_options?: Mms.Options);
     /**
      * Send a MMS immediately or schedule it for future delivery.
      *
@@ -40,6 +40,7 @@ export declare class Mms {
      * @throws {@link Pinnacle.PaymentRequiredError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
      *     await client.messages.mms.send({
@@ -74,6 +75,6 @@ export declare class Mms {
     validate(request: Pinnacle.MmsContent, requestOptions?: Mms.RequestOptions): core.HttpResponsePromise<Pinnacle.MmsValidationResult>;
     private __validate;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        "PINNACLE-API-KEY": string;
+        "PINNACLE-API-KEY": string | undefined;
     }>;
 }

package/dist/cjs/api/resources/messages/resources/mms/client/Client.js

@@ -52,7 +52,7 @@ const Pinnacle = __importStar(require("../../../../../index.js"));
 const headers_js_1 = require("../../../../../../core/headers.js");
 const errors = __importStar(require("../../../../../../errors/index.js"));
 class Mms {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
@@ -66,6 +66,7 @@ class Mms {
      * @throws {@link Pinnacle.PaymentRequiredError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
      *     await client.messages.mms.send({
@@ -113,6 +114,8 @@ class Mms {
                         throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
                     case 500:
                         throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
+                    case 501:
+                        throw new Pinnacle.NotImplementedError(_response.error.body, _response.rawResponse);
                     default:
                         throw new errors.PinnacleError({
                             statusCode: _response.error.statusCode,

package/dist/cjs/api/resources/messages/resources/rcs/client/Client.d.ts

@@ -9,7 +9,7 @@ export declare namespace Rcs {
         environment?: core.Supplier<environments.PinnacleEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        apiKey: core.Supplier<string>;
+        apiKey?: core.Supplier<string | undefined>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
@@ -28,13 +28,13 @@ export declare namespace Rcs {
 }
 export declare class Rcs {
     protected readonly _options: Rcs.Options;
-    constructor(_options: Rcs.Options);
+    constructor(_options?: Rcs.Options);
     /**
      * Send a RCS message immediately or schedule it for future delivery. <br>
      *
      * Requires an active RCS agent and recipient devices that support RCS Business Messaging.
      *
-     * @param {Pinnacle.Rcs} request
+     * @param {Pinnacle.RichMessage} request
      * @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -42,6 +42,7 @@ export declare class Rcs {
      * @throws {@link Pinnacle.PaymentRequiredError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
      *     await client.messages.rcs.send({
@@ -55,7 +56,7 @@ export declare class Rcs {
      *         to: "to"
      *     })
      */
-    send(request: Pinnacle.Rcs, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.messages.RcsSendResponse>;
+    send(request: Pinnacle.RichMessage, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.messages.RcsSendResponse>;
     private __send;
     /**
      * Validate RCS message content without sending it.
@@ -80,6 +81,6 @@ export declare class Rcs {
     validate(request: Pinnacle.RcsValidateContent, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.RcsValidationResult>;
     private __validate;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        "PINNACLE-API-KEY": string;
+        "PINNACLE-API-KEY": string | undefined;
     }>;
 }

package/dist/cjs/api/resources/messages/resources/rcs/client/Client.js

@@ -52,7 +52,7 @@ const Pinnacle = __importStar(require("../../../../../index.js"));
 const headers_js_1 = require("../../../../../../core/headers.js");
 const errors = __importStar(require("../../../../../../errors/index.js"));
 class Rcs {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
@@ -60,7 +60,7 @@ class Rcs {
      *
      * Requires an active RCS agent and recipient devices that support RCS Business Messaging.
      *
-     * @param {Pinnacle.Rcs} request
+     * @param {Pinnacle.RichMessage} request
      * @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -68,6 +68,7 @@ class Rcs {
      * @throws {@link Pinnacle.PaymentRequiredError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
      *     await client.messages.rcs.send({
@@ -115,6 +116,8 @@ class Rcs {
                         throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
                     case 500:
                         throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
+                    case 501:
+                        throw new Pinnacle.NotImplementedError(_response.error.body, _response.rawResponse);
                     default:
                         throw new errors.PinnacleError({
                             statusCode: _response.error.statusCode,

package/dist/cjs/api/resources/messages/resources/sms/client/Client.d.ts

@@ -9,7 +9,7 @@ export declare namespace Sms {
         environment?: core.Supplier<environments.PinnacleEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        apiKey: core.Supplier<string>;
+        apiKey?: core.Supplier<string | undefined>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
@@ -28,7 +28,7 @@ export declare namespace Sms {
 }
 export declare class Sms {
     protected readonly _options: Sms.Options;
-    constructor(_options: Sms.Options);
+    constructor(_options?: Sms.Options);
     /**
      * Send a SMS message immediately or schedule it for future delivery.
      *
@@ -40,6 +40,7 @@ export declare class Sms {
      * @throws {@link Pinnacle.PaymentRequiredError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
      *     await client.messages.sms.send({
@@ -68,6 +69,6 @@ export declare class Sms {
     validate(request: Pinnacle.SmsContent, requestOptions?: Sms.RequestOptions): core.HttpResponsePromise<Pinnacle.SmsValidationResult>;
     private __validate;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        "PINNACLE-API-KEY": string;
+        "PINNACLE-API-KEY": string | undefined;
     }>;
 }

package/dist/cjs/api/resources/messages/resources/sms/client/Client.js

@@ -52,7 +52,7 @@ const Pinnacle = __importStar(require("../../../../../index.js"));
 const headers_js_1 = require("../../../../../../core/headers.js");
 const errors = __importStar(require("../../../../../../errors/index.js"));
 class Sms {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
@@ -66,6 +66,7 @@ class Sms {
      * @throws {@link Pinnacle.PaymentRequiredError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
      *     await client.messages.sms.send({
@@ -108,6 +109,8 @@ class Sms {
                         throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
                     case 500:
                         throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
+                    case 501:
+                        throw new Pinnacle.NotImplementedError(_response.error.body, _response.rawResponse);
                     default:
                         throw new errors.PinnacleError({
                             statusCode: _response.error.statusCode,

package/dist/cjs/api/resources/phoneNumbers/client/Client.d.ts

@@ -11,7 +11,7 @@ export declare namespace PhoneNumbers {
         environment?: core.Supplier<environments.PinnacleEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        apiKey: core.Supplier<string>;
+        apiKey?: core.Supplier<string | undefined>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
@@ -32,7 +32,7 @@ export declare class PhoneNumbers {
     protected readonly _options: PhoneNumbers.Options;
     protected _webhook: Webhook | undefined;
     protected _campaign: Campaign | undefined;
-    constructor(_options: PhoneNumbers.Options);
+    constructor(_options?: PhoneNumbers.Options);
     get webhook(): Webhook;
     get campaign(): Campaign;
     /**
@@ -112,6 +112,6 @@ export declare class PhoneNumbers {
     get(request: Pinnacle.RetrievePhoneNumberDetailsParams, requestOptions?: PhoneNumbers.RequestOptions): core.HttpResponsePromise<Pinnacle.PhoneNumbersGetResponse>;
     private __get;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        "PINNACLE-API-KEY": string;
+        "PINNACLE-API-KEY": string | undefined;
     }>;
 }

package/dist/cjs/api/resources/phoneNumbers/client/Client.js

@@ -54,7 +54,7 @@ const errors = __importStar(require("../../../../errors/index.js"));
 const Client_js_1 = require("../resources/webhook/client/Client.js");
 const Client_js_2 = require("../resources/campaign/client/Client.js");
 class PhoneNumbers {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     get webhook() {

package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/Client.d.ts

@@ -9,7 +9,7 @@ export declare namespace Campaign {
         environment?: core.Supplier<environments.PinnacleEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        apiKey: core.Supplier<string>;
+        apiKey?: core.Supplier<string | undefined>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
@@ -28,9 +28,9 @@ export declare namespace Campaign {
 }
 export declare class Campaign {
     protected readonly _options: Campaign.Options;
-    constructor(_options: Campaign.Options);
+    constructor(_options?: Campaign.Options);
     /**
-     * Link a phone number to a specific campaign.
+     * Link a phone number to a specific campaign. Phone numbers must be linked to a campaign to send messages.
      *
      * @param {Pinnacle.phoneNumbers.AttachCampaignParams} request
      * @param {Campaign.RequestOptions} requestOptions - Request-specific configuration.
@@ -39,6 +39,7 @@ export declare class Campaign {
      * @throws {@link Pinnacle.UnauthorizedError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
      *     await client.phoneNumbers.campaign.attach({
@@ -59,6 +60,7 @@ export declare class Campaign {
      * @throws {@link Pinnacle.UnauthorizedError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
      *     await client.phoneNumbers.campaign.detach({
@@ -68,6 +70,6 @@ export declare class Campaign {
     detach(request: Pinnacle.phoneNumbers.DetachCampaignParams, requestOptions?: Campaign.RequestOptions): core.HttpResponsePromise<Pinnacle.DetachedPhoneNumberResult>;
     private __detach;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        "PINNACLE-API-KEY": string;
+        "PINNACLE-API-KEY": string | undefined;
     }>;
 }

package/dist/cjs/api/resources/phoneNumbers/resources/campaign/client/Client.js

@@ -52,11 +52,11 @@ const Pinnacle = __importStar(require("../../../../../index.js"));
 const headers_js_1 = require("../../../../../../core/headers.js");
 const errors = __importStar(require("../../../../../../errors/index.js"));
 class Campaign {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
-     * Link a phone number to a specific campaign.
+     * Link a phone number to a specific campaign. Phone numbers must be linked to a campaign to send messages.
      *
      * @param {Pinnacle.phoneNumbers.AttachCampaignParams} request
      * @param {Campaign.RequestOptions} requestOptions - Request-specific configuration.
@@ -65,6 +65,7 @@ class Campaign {
      * @throws {@link Pinnacle.UnauthorizedError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
      *     await client.phoneNumbers.campaign.attach({
@@ -105,6 +106,8 @@ class Campaign {
                         throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
                     case 500:
                         throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
+                    case 501:
+                        throw new Pinnacle.NotImplementedError(_response.error.body, _response.rawResponse);
                     default:
                         throw new errors.PinnacleError({
                             statusCode: _response.error.statusCode,
@@ -140,6 +143,7 @@ class Campaign {
      * @throws {@link Pinnacle.UnauthorizedError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
      *     await client.phoneNumbers.campaign.detach({
@@ -178,6 +182,8 @@ class Campaign {
                         throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
                     case 500:
                         throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
+                    case 501:
+                        throw new Pinnacle.NotImplementedError(_response.error.body, _response.rawResponse);
                     default:
                         throw new errors.PinnacleError({
                             statusCode: _response.error.statusCode,

package/dist/cjs/api/resources/phoneNumbers/resources/webhook/client/Client.d.ts

@@ -9,7 +9,7 @@ export declare namespace Webhook {
         environment?: core.Supplier<environments.PinnacleEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        apiKey: core.Supplier<string>;
+        apiKey?: core.Supplier<string | undefined>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
@@ -28,13 +28,13 @@ export declare namespace Webhook {
 }
 export declare class Webhook {
     protected readonly _options: Webhook.Options;
-    constructor(_options: Webhook.Options);
+    constructor(_options?: Webhook.Options);
     /**
      * Connect a webhook to your phone number to receive real-time notifications for incoming messages, delivery status updates, and other communication events.
      *
      * @param {string} phone - The phone number you want to attach the webhook to in E.164 format. Make sure it is url encoded (i.e. replace the leading + with %2B). <br>
      *
-     *                         Must be a phone number that you own and have already [purchased](./buy) through the API.
+     *                         Must be a phone number that you own and have already [purchased](./buy) through the API. A phone number can have multiple webhooks attached to it.
      * @param {Pinnacle.AttachWebhookParams} request
      * @param {Webhook.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -46,7 +46,8 @@ export declare class Webhook {
      *
      * @example
      *     await client.phoneNumbers.webhook.attach("%2B14155551234", {
-     *         webhookId: 1
+     *         webhookId: 123,
+     *         event: "MESSAGE.STATUS"
      *     })
      */
     attach(phone: string, request: Pinnacle.AttachWebhookParams, requestOptions?: Webhook.RequestOptions): core.HttpResponsePromise<Pinnacle.ConfiguredWebhook>;
@@ -68,6 +69,7 @@ export declare class Webhook {
      * @throws {@link Pinnacle.UnauthorizedError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
      *     await client.phoneNumbers.webhook.detach("+14155551234", 123)
@@ -75,6 +77,6 @@ export declare class Webhook {
     detach(phone: string, webhookId: number, requestOptions?: Webhook.RequestOptions): core.HttpResponsePromise<Pinnacle.DetachedWebhookInfo>;
     private __detach;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        "PINNACLE-API-KEY": string;
+        "PINNACLE-API-KEY": string | undefined;
     }>;
 }

package/dist/cjs/api/resources/phoneNumbers/resources/webhook/client/Client.js

@@ -52,7 +52,7 @@ const Pinnacle = __importStar(require("../../../../../index.js"));
 const headers_js_1 = require("../../../../../../core/headers.js");
 const errors = __importStar(require("../../../../../../errors/index.js"));
 class Webhook {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
@@ -60,7 +60,7 @@ class Webhook {
      *
      * @param {string} phone - The phone number you want to attach the webhook to in E.164 format. Make sure it is url encoded (i.e. replace the leading + with %2B). <br>
      *
-     *                         Must be a phone number that you own and have already [purchased](./buy) through the API.
+     *                         Must be a phone number that you own and have already [purchased](./buy) through the API. A phone number can have multiple webhooks attached to it.
      * @param {Pinnacle.AttachWebhookParams} request
      * @param {Webhook.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -72,7 +72,8 @@ class Webhook {
      *
      * @example
      *     await client.phoneNumbers.webhook.attach("%2B14155551234", {
-     *         webhookId: 1
+     *         webhookId: 123,
+     *         event: "MESSAGE.STATUS"
      *     })
      */
     attach(phone, request, requestOptions) {
@@ -151,6 +152,7 @@ class Webhook {
      * @throws {@link Pinnacle.UnauthorizedError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
      *     await client.phoneNumbers.webhook.detach("+14155551234", 123)
@@ -184,6 +186,8 @@ class Webhook {
                         throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
                     case 500:
                         throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
+                    case 501:
+                        throw new Pinnacle.NotImplementedError(_response.error.body, _response.rawResponse);
                     default:
                         throw new errors.PinnacleError({
                             statusCode: _response.error.statusCode,