rcs-js 2.0.0-rc.9 → 2.0.0

package/dist/esm/api/resources/messages/resources/rcs/client/Client.mjs

@@ -16,7 +16,7 @@ import * as Pinnacle from "../../../../../index.mjs";
 import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../../../core/headers.mjs";
 import * as errors from "../../../../../../errors/index.mjs";
 export class Rcs {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
@@ -24,7 +24,7 @@ export 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}
@@ -32,6 +32,7 @@ export class Rcs {
      * @throws {@link Pinnacle.PaymentRequiredError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
      *     await client.messages.rcs.send({
@@ -79,6 +80,8 @@ export 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/esm/api/resources/messages/resources/sms/client/Client.d.mts

@@ -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/esm/api/resources/messages/resources/sms/client/Client.mjs

@@ -16,7 +16,7 @@ import * as Pinnacle from "../../../../../index.mjs";
 import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../../../core/headers.mjs";
 import * as errors from "../../../../../../errors/index.mjs";
 export class Sms {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
@@ -30,6 +30,7 @@ export class Sms {
      * @throws {@link Pinnacle.PaymentRequiredError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
      *     await client.messages.sms.send({
@@ -72,6 +73,8 @@ export 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/esm/api/resources/phoneNumbers/client/Client.d.mts

@@ -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/esm/api/resources/phoneNumbers/client/Client.mjs

@@ -18,7 +18,7 @@ import * as errors from "../../../../errors/index.mjs";
 import { Webhook } from "../resources/webhook/client/Client.mjs";
 import { Campaign } from "../resources/campaign/client/Client.mjs";
 export class PhoneNumbers {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     get webhook() {

package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/Client.d.mts

@@ -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/esm/api/resources/phoneNumbers/resources/campaign/client/Client.mjs

@@ -16,11 +16,11 @@ import * as Pinnacle from "../../../../../index.mjs";
 import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../../../core/headers.mjs";
 import * as errors from "../../../../../../errors/index.mjs";
 export 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.
@@ -29,6 +29,7 @@ export class Campaign {
      * @throws {@link Pinnacle.UnauthorizedError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
      *     await client.phoneNumbers.campaign.attach({
@@ -69,6 +70,8 @@ export 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,
@@ -104,6 +107,7 @@ export class Campaign {
      * @throws {@link Pinnacle.UnauthorizedError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
      *     await client.phoneNumbers.campaign.detach({
@@ -142,6 +146,8 @@ export 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/esm/api/resources/phoneNumbers/resources/webhook/client/Client.d.mts

@@ -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/esm/api/resources/phoneNumbers/resources/webhook/client/Client.mjs

@@ -16,7 +16,7 @@ import * as Pinnacle from "../../../../../index.mjs";
 import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../../../core/headers.mjs";
 import * as errors from "../../../../../../errors/index.mjs";
 export class Webhook {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
@@ -24,7 +24,7 @@ export 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.
      *
@@ -36,7 +36,8 @@ export class Webhook {
      *
      * @example
      *     await client.phoneNumbers.webhook.attach("%2B14155551234", {
-     *         webhookId: 1
+     *         webhookId: 123,
+     *         event: "MESSAGE.STATUS"
      *     })
      */
     attach(phone, request, requestOptions) {
@@ -115,6 +116,7 @@ export 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)
@@ -148,6 +150,8 @@ export 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,

package/dist/esm/api/resources/rcs/client/Client.d.mts

@@ -0,0 +1,121 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as Pinnacle from "../../../index.mjs";
+export declare namespace Rcs {
+    interface Options {
+        environment?: core.Supplier<environments.PinnacleEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: 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>;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional query string parameters to include in the request. */
+        queryParams?: Record<string, unknown>;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+    }
+}
+export declare class Rcs {
+    protected readonly _options: Rcs.Options;
+    constructor(_options?: Rcs.Options);
+    /**
+     * Check RCS capabilities for one or more phone numbers.
+     *
+     * This endpoint allows you to verify which RCS features (cards, buttons, etc.) are supported
+     * on specific phone numbers before sending RCS messages to them.
+     *
+     * @param {Pinnacle.RcsCapabilitiesQuery} request
+     * @param {Rcs.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
+     *
+     * @example
+     *     await client.rcs.getCapabilities({
+     *         phoneNumbers: ["+12345678901", "+19876543210"]
+     *     })
+     */
+    getCapabilities(request: Pinnacle.RcsCapabilitiesQuery, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.RcsCapabilitiesResult>;
+    private __getCapabilities;
+    /**
+     * Whitelist a phone number for testing with your test RCS agent.
+     *
+     * ## Overview
+     * During development and testing, RCS agents can only send messages to whitelisted phone numbers.
+     * Use this endpoint to add test devices to your agent's whitelist before sending test messages.
+     *
+     * ## Verification Process
+     * After whitelisting a number, you'll need to complete verification:
+     *
+     * 1. Check the test device for an "RBM Tester Management" request
+     * 2. Accept the request on the device
+     * 3. Enter the 4-digit verification code in the Pinnacle dashboard at:
+     *    ```
+     *    https://app.pinnacle.sh/dashboard/brands/{brandId}?campaignId={campaignId}&campaignType=RCS
+     *    ```
+     *
+     * > **Important Notes**
+     * >
+     * > - **Testing only:** This is only required for test agents. Production agents can message any RCS-enabled number
+     * > - **AT&T limitation:** Whitelisting may currently fail for AT&T numbers
+     * > - **Verification required:** The whitelist request isn't complete until you verify the device.
+     *
+     * @param {Pinnacle.RcsWhitelistRequest} request
+     * @param {Rcs.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.rcs.whitelist({
+     *         agentId: "agent_XXXXXXXXXXXX",
+     *         phoneNumber: "+12345678901"
+     *     })
+     */
+    whitelist(request: Pinnacle.RcsWhitelistRequest, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.RcsWhitelistResponse>;
+    private __whitelist;
+    /**
+     * Generate a link for initiating an RCS conversation with your agent.
+     *
+     * Users can click these links to start conversations with your RCS agent directly
+     * from websites, emails, or other applications.
+     *
+     * @param {Pinnacle.RcsLinkRequest} request
+     * @param {Rcs.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.rcs.getLink({
+     *         agentId: "agent_XXXXXXXXXXXX",
+     *         testMode: false,
+     *         phoneNumber: "+12345678901",
+     *         body: "Hello, I need help with my order"
+     *     })
+     */
+    getLink(request: Pinnacle.RcsLinkRequest, requestOptions?: Rcs.RequestOptions): core.HttpResponsePromise<Pinnacle.RcsLinkResult>;
+    private __getLink;
+    protected _getCustomAuthorizationHeaders(): Promise<{
+        "PINNACLE-API-KEY": string | undefined;
+    }>;
+}