rcs-js 2.0.0-rc.9 → 2.0.1-rc.1

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,14 +34,14 @@ 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;
     /**
      * Retrieve a previously sent message.
      *
-     * @param {number} id - Unique identifier of the message.
+     * @param {string} id - Unique identifier of the message. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`.
      * @param {Messages.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -50,9 +50,9 @@ export declare class Messages {
      * @throws {@link Pinnacle.InternalServerError}
      *
      * @example
-     *     await client.messages.get(1240)
+     *     await client.messages.get("msg_1234567890")
      */
-    get(id: number, requestOptions?: Messages.RequestOptions): core.HttpResponsePromise<Pinnacle.Message>;
+    get(id: string, requestOptions?: Messages.RequestOptions): core.HttpResponsePromise<Pinnacle.Message>;
     private __get;
     /**
      * Add or remove an emoji reaction to a previously sent message.
@@ -62,11 +62,14 @@ 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({
-     *         messageId: 1410,
+     *         messageId: "msg_1234567890",
      *         options: {
      *             force: true
      *         },
@@ -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() {
@@ -73,7 +73,7 @@ class Messages {
     /**
      * Retrieve a previously sent message.
      *
-     * @param {number} id - Unique identifier of the message.
+     * @param {string} id - Unique identifier of the message. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`.
      * @param {Messages.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -82,7 +82,7 @@ class Messages {
      * @throws {@link Pinnacle.InternalServerError}
      *
      * @example
-     *     await client.messages.get(1240)
+     *     await client.messages.get("msg_1234567890")
      */
     get(id, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__get(id, requestOptions));
@@ -146,11 +146,14 @@ 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({
-     *         messageId: 1410,
+     *         messageId: "msg_1234567890",
      *         options: {
      *             force: true
      *         },
@@ -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

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         messageId: 1410,
+ *         messageId: "msg_1234567890",
  *         options: {
  *             force: true
  *         },
@@ -12,15 +12,15 @@
  *     }
  */
 export interface ReactMessageParams {
-    /** Unique identifier of the message. */
-    messageId: number;
+    /** Unique identifier of the message. This identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`. */
+    messageId: string;
     options?: ReactMessageParams.Options;
     /**
      * Unicode emoji to add. <br>
      *
      * 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,12 +39,13 @@ 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({
      *         phones: ["+14155550123", "+14155559876", "+14155550111"],
      *         campaignType: "TOLL_FREE",
-     *         campaignId: 101
+     *         campaignId: "tf_1234567890"
      *     })
      */
     attach(request: Pinnacle.phoneNumbers.AttachCampaignParams, requestOptions?: Campaign.RequestOptions): core.HttpResponsePromise<Pinnacle.AttachedPhoneNumberResult>;
@@ -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,12 +65,13 @@ class Campaign {
      * @throws {@link Pinnacle.UnauthorizedError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
      *     await client.phoneNumbers.campaign.attach({
      *         phones: ["+14155550123", "+14155559876", "+14155550111"],
      *         campaignType: "TOLL_FREE",
-     *         campaignId: 101
+     *         campaignId: "tf_1234567890"
      *     })
      */
     attach(request, requestOptions) {
@@ -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/campaign/client/requests/AttachCampaignParams.d.ts

@@ -7,13 +7,22 @@ import * as Pinnacle from "../../../../../../index.js";
  *     {
  *         phones: ["+14155550123", "+14155559876", "+14155550111"],
  *         campaignType: "TOLL_FREE",
- *         campaignId: 101
+ *         campaignId: "tf_1234567890"
  *     }
  */
 export interface AttachCampaignParams {
     /** List of phone number (E.164 format). */
     phones: string[];
     campaignType: Pinnacle.MessagingProfileEnum;
-    /** Campaign's identifier. */
-    campaignId: number;
+    /**
+     * Unique identifier for the campaign. <br>
+     *
+     *  - **TOLL_FREE** campaigns:
+     *    - Must begin with the prefix `tf_`
+     *    - Example: `tf_1234567890`
+     *  - **10DLC** campaigns:
+     *    - Must begin with the prefix `dlc_`
+     *    - Example: `dlc_1234567890`
+     */
+    campaignId: string;
 }

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: "wh_1234567890",
+     *         event: "MESSAGE.STATUS"
      *     })
      */
     attach(phone: string, request: Pinnacle.AttachWebhookParams, requestOptions?: Webhook.RequestOptions): core.HttpResponsePromise<Pinnacle.ConfiguredWebhook>;
@@ -59,22 +60,23 @@ export declare 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 currently has the specified webhook attached.
-     * @param {number} webhookId - The unique identifier of the webhook you want to detach from the phone number. <br>
+     * @param {string} webhookId - The unique identifier of the webhook you want to detach from the phone number. <br>
      *
-     *                             This must be a valid webhook ID that is currently attached to the specified phone number.
+     *                             This must be a valid webhook ID that is currently attached to the specified phone number. This identifier is a string that always begins with the prefix `wh_`, for example: `wh_1234567890`.
      * @param {Webhook.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
      * @throws {@link Pinnacle.UnauthorizedError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
-     *     await client.phoneNumbers.webhook.detach("+14155551234", 123)
+     *     await client.phoneNumbers.webhook.detach("+14155551234", "wh_1234567890")
      */
-    detach(phone: string, webhookId: number, requestOptions?: Webhook.RequestOptions): core.HttpResponsePromise<Pinnacle.DetachedWebhookInfo>;
+    detach(phone: string, webhookId: string, 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: "wh_1234567890",
+     *         event: "MESSAGE.STATUS"
      *     })
      */
     attach(phone, request, requestOptions) {
@@ -142,18 +143,19 @@ 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 currently has the specified webhook attached.
-     * @param {number} webhookId - The unique identifier of the webhook you want to detach from the phone number. <br>
+     * @param {string} webhookId - The unique identifier of the webhook you want to detach from the phone number. <br>
      *
-     *                             This must be a valid webhook ID that is currently attached to the specified phone number.
+     *                             This must be a valid webhook ID that is currently attached to the specified phone number. This identifier is a string that always begins with the prefix `wh_`, for example: `wh_1234567890`.
      * @param {Webhook.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
      * @throws {@link Pinnacle.UnauthorizedError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
-     *     await client.phoneNumbers.webhook.detach("+14155551234", 123)
+     *     await client.phoneNumbers.webhook.detach("+14155551234", "wh_1234567890")
      */
     detach(phone, webhookId, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__detach(phone, webhookId, requestOptions));
@@ -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,