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

package/dist/esm/api/resources/campaigns/resources/rcs/client/requests/UpsertRcsCampaignParams.d.mts

@@ -80,9 +80,9 @@ export declare namespace UpsertRcsCampaignParams {
         description?: string;
         /** List of emails (1-3 required). */
         emails?: Agent.Emails.Item[];
-        /** Link to the agent's hero. */
+        /** Link to the agent's hero. Hero must be an image file with dimensions 1440x448px. */
         heroUrl?: string;
-        /** Link to the agent's icon. */
+        /** Link to the agent's icon. Icon must be an image file with dimensions 224x224px. */
         iconUrl?: string;
         /** Name of the agent. */
         name?: string;

package/dist/esm/api/resources/index.d.mts

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

package/dist/esm/api/resources/index.mjs

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

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

@@ -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({

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

@@ -110,7 +110,10 @@ export 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({
@@ -149,8 +152,14 @@ export 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/esm/api/resources/messages/resources/mms/client/Client.d.mts

@@ -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({

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

@@ -30,6 +30,7 @@ export class Mms {
      * @throws {@link Pinnacle.PaymentRequiredError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
      *
      * @example
      *     await client.messages.mms.send({
@@ -77,6 +78,8 @@ export 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/esm/api/resources/messages/resources/rcs/client/Client.d.mts

@@ -34,7 +34,7 @@ export declare 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}
@@ -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.

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

@@ -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

@@ -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({

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

@@ -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/resources/campaign/client/Client.d.mts

@@ -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({

package/dist/esm/api/resources/phoneNumbers/resources/campaign/client/Client.mjs

@@ -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

@@ -68,6 +68,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)

package/dist/esm/api/resources/phoneNumbers/resources/webhook/client/Client.mjs

@@ -115,6 +115,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 +149,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>;
+        /** 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;
+    }>;
+}