rcs-js 2.0.7 → 2.0.8

package/dist/cjs/api/types/DlcCampaignWithExtendedBrandAndStatus.js

@@ -1,3 +1,35 @@
 "use strict";
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.DlcCampaignWithExtendedBrandAndStatus = void 0;
+var DlcCampaignWithExtendedBrandAndStatus;
+(function (DlcCampaignWithExtendedBrandAndStatus) {
+    /**
+     * The MNO brand tier for T-Mobile rate limits. Tiers range from `TOP` (highest) to `LOW` (lowest), based on your brand's vetting score.
+     *
+     * See [SMS Rate Limits](/guides/messages/rate-limits) for details.
+     */
+    DlcCampaignWithExtendedBrandAndStatus.MnoBrandTier = {
+        Top: "TOP",
+        HighMid: "HIGH_MID",
+        LowMid: "LOW_MID",
+        Low: "LOW",
+    };
+    /**
+     * The MNO TCR message class for AT&T, Verizon, and other carriers. Classes `A`-`G` are standard (based on vetting score), while `T`, `N`, and `S` are for special use cases.
+     *
+     * See [SMS Rate Limits](/guides/messages/rate-limits) for details.
+     */
+    DlcCampaignWithExtendedBrandAndStatus.MnoTcrTier = {
+        A: "A",
+        B: "B",
+        C: "C",
+        D: "D",
+        E: "E",
+        F: "F",
+        G: "G",
+        N: "N",
+        T: "T",
+        S: "S",
+    };
+})(DlcCampaignWithExtendedBrandAndStatus || (exports.DlcCampaignWithExtendedBrandAndStatus = DlcCampaignWithExtendedBrandAndStatus = {}));

package/dist/cjs/api/types/MessageSchedule.d.ts

@@ -2,22 +2,36 @@
  * Define when and how your message should be sent.
  */
 export interface MessageSchedule {
-    /** Date and time when you want recurring messages to stop in ISO 8601 format. */
-    endDate?: string;
-    /**
-     * Provide an AWS cron expression to control the when messages are sent. <br>
-     *
-     * [Learn more about cron expressions](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-scheduled-rule-pattern.html).
-     */
-    recurrence?: string;
     /**
      * The date and time you want your message to be sent.
-     * - Use [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), for example: `2024-12-17T14:30:00Z`.
+     * - Use [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), for example: `2024-12-17T14:30:00Z`. Format: `YYYY-MM-DDThh:mm` (e.g., `2024-12-25T14:30`).
      * - This time must be at least 5 minutes in the future.
      * - The message will be scheduled based on the `timezone` you provide.
      * - If you set a `recurrence` schedule, this is the start date and time for the recurring schedule.
      */
     sendAt: string;
-    /** Timezone for your scheduled message, using an IANA identifier. */
-    timezone: string;
+    /**
+     * AWS cron expression for recurring schedules (6 fields). <br>
+     *
+     * [Learn more about cron expressions](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-scheduled-rule-pattern.html). <br>
+     *
+     * **Examples:**
+     * - `0 10 * * ? *` - Every day at 10:00 AM
+     * - `0/30 * * * ? *` - Every 30 minutes
+     * - `0 9 ? * MON-FRI *` - Every weekday at 9:00 AM
+     * - `0 12 1 * ? *` - First day of every month at noon
+     */
+    recurrence?: string;
+    /**
+     * IANA timezone identifier (e.g., `America/New_York`, `UTC`). <br>
+     *
+     * Defaults to `UTC` if not specified.
+     */
+    timezone?: string;
+    /**
+     * Date and time when recurring messages should stop. <br>
+     *
+     * Format: `YYYY-MM-DDThh:mm`. Required if `recurrence` is set.
+     */
+    endDate?: string;
 }

package/dist/cjs/api/types/MessageStatusEnum.d.ts

@@ -1,5 +1,6 @@
 /** Current status of the message. */
 export declare const MessageStatusEnum: {
+    readonly Queued: "QUEUED";
     readonly Pending: "PENDING";
     readonly Sent: "SENT";
     readonly SendFailed: "SEND_FAILED";

package/dist/cjs/api/types/MessageStatusEnum.js

@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.MessageStatusEnum = void 0;
 /** Current status of the message. */
 exports.MessageStatusEnum = {
+    Queued: "QUEUED",
     Pending: "PENDING",
     Sent: "SENT",
     SendFailed: "SEND_FAILED",

package/dist/cjs/api/types/ScheduleCancelResult.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Response returned when a scheduled message or blast is cancelled.
+ */
+export interface ScheduleCancelResult {
+    /** Indicates whether the schedule was successfully cancelled. */
+    success: boolean;
+}

package/dist/cjs/api/types/ScheduleCancelResult.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/ScheduledBlastDetails.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Response returned when a blast is scheduled for future delivery.
+ */
+export interface ScheduledBlastDetails {
+    /** Unique identifier for the scheduled blast. This identifier is a string that always begins with the prefix `msg_sched_`, for example: `msg_sched_xxxxx`. */
+    scheduleId: string;
+    /** The schedule configuration for the blast. */
+    config: ScheduledBlastDetails.Config;
+}
+export declare namespace ScheduledBlastDetails {
+    /**
+     * The schedule configuration for the blast.
+     */
+    interface Config {
+        /** When the first message will be sent. */
+        sendAt?: string;
+        /** AWS cron expression for recurring schedules. */
+        recurrence?: string;
+        /** IANA timezone identifier. */
+        timezone?: string;
+        /** When recurring schedules will stop. */
+        endDate?: string;
+    }
+}

package/dist/cjs/api/types/ScheduledBlastDetails.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -8,6 +8,7 @@ export * from "./AutofillDlcCampaignResponse.js";
 export * from "./BadRequestErrorBody.js";
 export * from "./BaseRichMessage.js";
 export * from "./BasicPhoneInformation.js";
+export * from "./BlastDetails.js";
 export * from "./BrandStatus.js";
 export * from "./BrandStatusEnum.js";
 export * from "./ButtonClicked.js";
@@ -16,7 +17,6 @@ export * from "./CampaignEnum.js";
 export * from "./CampaignQuery.js";
 export * from "./CampaignSubmissionResult.js";
 export * from "./CampaignValidationResult.js";
-export * from "./CancelScheduledMessageResponse.js";
 export * from "./CompanyEntityTypeEnum.js";
 export * from "./CompanySectorEnum.js";
 export * from "./CompanyTypeEnum.js";
@@ -109,6 +109,8 @@ export * from "./RichMediaMessage.js";
 export * from "./RichMessage.js";
 export * from "./RichText.js";
 export * from "./RichTextMessage.js";
+export * from "./ScheduleCancelResult.js";
+export * from "./ScheduledBlastDetails.js";
 export * from "./ScheduledMessage.js";
 export * from "./Sender.js";
 export * from "./SendRichMessageOptions.js";

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

@@ -24,6 +24,7 @@ __exportStar(require("./AutofillDlcCampaignResponse.js"), exports);
 __exportStar(require("./BadRequestErrorBody.js"), exports);
 __exportStar(require("./BaseRichMessage.js"), exports);
 __exportStar(require("./BasicPhoneInformation.js"), exports);
+__exportStar(require("./BlastDetails.js"), exports);
 __exportStar(require("./BrandStatus.js"), exports);
 __exportStar(require("./BrandStatusEnum.js"), exports);
 __exportStar(require("./ButtonClicked.js"), exports);
@@ -32,7 +33,6 @@ __exportStar(require("./CampaignEnum.js"), exports);
 __exportStar(require("./CampaignQuery.js"), exports);
 __exportStar(require("./CampaignSubmissionResult.js"), exports);
 __exportStar(require("./CampaignValidationResult.js"), exports);
-__exportStar(require("./CancelScheduledMessageResponse.js"), exports);
 __exportStar(require("./CompanyEntityTypeEnum.js"), exports);
 __exportStar(require("./CompanySectorEnum.js"), exports);
 __exportStar(require("./CompanyTypeEnum.js"), exports);
@@ -125,6 +125,8 @@ __exportStar(require("./RichMediaMessage.js"), exports);
 __exportStar(require("./RichMessage.js"), exports);
 __exportStar(require("./RichText.js"), exports);
 __exportStar(require("./RichTextMessage.js"), exports);
+__exportStar(require("./ScheduleCancelResult.js"), exports);
+__exportStar(require("./ScheduledBlastDetails.js"), exports);
 __exportStar(require("./ScheduledMessage.js"), exports);
 __exportStar(require("./Sender.js"), exports);
 __exportStar(require("./SendRichMessageOptions.js"), exports);

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "2.0.7";
+export declare const SDK_VERSION = "2.0.8";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "2.0.7";
+exports.SDK_VERSION = "2.0.8";

package/dist/esm/Client.mjs

@@ -17,8 +17,8 @@ export class PinnacleClient {
         this._options = Object.assign(Object.assign({}, _options), { logging: core.logging.createLogger(_options === null || _options === void 0 ? void 0 : _options.logging), headers: mergeHeaders({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "rcs-js",
-                "X-Fern-SDK-Version": "2.0.7",
-                "User-Agent": "rcs-js/2.0.7",
+                "X-Fern-SDK-Version": "2.0.8",
+                "User-Agent": "rcs-js/2.0.8",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

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

@@ -1,8 +1,10 @@
 import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
 import * as core from "../../../../core/index.mjs";
 import * as Pinnacle from "../../../index.mjs";
+import { Blast } from "../resources/blast/client/Client.mjs";
 import { Mms } from "../resources/mms/client/Client.mjs";
 import { Rcs } from "../resources/rcs/client/Client.mjs";
+import { Schedule } from "../resources/schedule/client/Client.mjs";
 import { Sms } from "../resources/sms/client/Client.mjs";
 export declare namespace Messages {
     interface Options extends BaseClientOptions {
@@ -15,10 +17,14 @@ export declare class Messages {
     protected _sms: Sms | undefined;
     protected _mms: Mms | undefined;
     protected _rcs: Rcs | undefined;
+    protected _blast: Blast | undefined;
+    protected _schedule: Schedule | undefined;
     constructor(_options?: Messages.Options);
     get sms(): Sms;
     get mms(): Mms;
     get rcs(): Rcs;
+    get blast(): Blast;
+    get schedule(): Schedule;
     /**
      * Retrieve a previously sent message.
      *
@@ -59,26 +65,5 @@ export declare class Messages {
      */
     react(request: Pinnacle.ReactMessageParams, requestOptions?: Messages.RequestOptions): core.HttpResponsePromise<Pinnacle.ReactionResult>;
     private __react;
-    /**
-     * Cancel a previously scheduled message before it is sent.
-     *
-     * Use the `scheduleId` returned from a scheduled send request (SMS, MMS, or RCS) to cancel the message.
-     * Once cancelled, the scheduled message will stop being sent.
-     *
-     * > **Note:** You cannot cancel a message that has already been sent.
-     *
-     * @param {string} id - Unique identifier of the scheduled message. This identifier is a string that always begins with the prefix `msg_sched_`, for example: `msg_sched_1234567890`.
-     * @param {Messages.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Pinnacle.BadRequestError}
-     * @throws {@link Pinnacle.UnauthorizedError}
-     * @throws {@link Pinnacle.NotFoundError}
-     * @throws {@link Pinnacle.InternalServerError}
-     *
-     * @example
-     *     await client.messages.cancel("msg_sched_1234567890")
-     */
-    cancel(id: string, requestOptions?: Messages.RequestOptions): core.HttpResponsePromise<Pinnacle.CancelScheduledMessageResponse>;
-    private __cancel;
     protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | undefined>>;
 }

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

@@ -13,8 +13,10 @@ import * as core from "../../../../core/index.mjs";
 import * as environments from "../../../../environments.mjs";
 import * as errors from "../../../../errors/index.mjs";
 import * as Pinnacle from "../../../index.mjs";
+import { Blast } from "../resources/blast/client/Client.mjs";
 import { Mms } from "../resources/mms/client/Client.mjs";
 import { Rcs } from "../resources/rcs/client/Client.mjs";
+import { Schedule } from "../resources/schedule/client/Client.mjs";
 import { Sms } from "../resources/sms/client/Client.mjs";
 export class Messages {
     constructor(_options = {}) {
@@ -32,6 +34,14 @@ export class Messages {
         var _a;
         return ((_a = this._rcs) !== null && _a !== void 0 ? _a : (this._rcs = new Rcs(this._options)));
     }
+    get blast() {
+        var _a;
+        return ((_a = this._blast) !== null && _a !== void 0 ? _a : (this._blast = new Blast(this._options)));
+    }
+    get schedule() {
+        var _a;
+        return ((_a = this._schedule) !== null && _a !== void 0 ? _a : (this._schedule = new Schedule(this._options)));
+    }
     /**
      * Retrieve a previously sent message.
      *
@@ -187,84 +197,6 @@ export class Messages {
             }
         });
     }
-    /**
-     * Cancel a previously scheduled message before it is sent.
-     *
-     * Use the `scheduleId` returned from a scheduled send request (SMS, MMS, or RCS) to cancel the message.
-     * Once cancelled, the scheduled message will stop being sent.
-     *
-     * > **Note:** You cannot cancel a message that has already been sent.
-     *
-     * @param {string} id - Unique identifier of the scheduled message. This identifier is a string that always begins with the prefix `msg_sched_`, for example: `msg_sched_1234567890`.
-     * @param {Messages.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Pinnacle.BadRequestError}
-     * @throws {@link Pinnacle.UnauthorizedError}
-     * @throws {@link Pinnacle.NotFoundError}
-     * @throws {@link Pinnacle.InternalServerError}
-     *
-     * @example
-     *     await client.messages.cancel("msg_sched_1234567890")
-     */
-    cancel(id, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__cancel(id, requestOptions));
-    }
-    __cancel(id, requestOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            const _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
-            const _response = yield core.fetcher({
-                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PinnacleEnvironment.Default, `messages/send/schedule/${core.url.encodePathParam(id)}`),
-                method: "DELETE",
-                headers: _headers,
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
-                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
-                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
-                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
-                logging: this._options.logging,
-            });
-            if (_response.ok) {
-                return {
-                    data: _response.body,
-                    rawResponse: _response.rawResponse,
-                };
-            }
-            if (_response.error.reason === "status-code") {
-                switch (_response.error.statusCode) {
-                    case 400:
-                        throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
-                    case 401:
-                        throw new Pinnacle.UnauthorizedError(_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);
-                    default:
-                        throw new errors.PinnacleError({
-                            statusCode: _response.error.statusCode,
-                            body: _response.error.body,
-                            rawResponse: _response.rawResponse,
-                        });
-                }
-            }
-            switch (_response.error.reason) {
-                case "non-json":
-                    throw new errors.PinnacleError({
-                        statusCode: _response.error.statusCode,
-                        body: _response.error.rawBody,
-                        rawResponse: _response.rawResponse,
-                    });
-                case "timeout":
-                    throw new errors.PinnacleTimeoutError("Timeout exceeded when calling DELETE /messages/send/schedule/{id}.");
-                case "unknown":
-                    throw new errors.PinnacleError({
-                        message: _response.error.errorMessage,
-                        rawResponse: _response.rawResponse,
-                    });
-            }
-        });
-    }
     _getCustomAuthorizationHeaders() {
         return __awaiter(this, void 0, void 0, function* () {
             const apiKeyValue = yield core.Supplier.get(this._options.apiKey);

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

@@ -0,0 +1,105 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../../../BaseClient.mjs";
+import * as core from "../../../../../../core/index.mjs";
+import * as Pinnacle from "../../../../../index.mjs";
+export declare namespace Blast {
+    interface Options extends BaseClientOptions {
+    }
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class Blast {
+    protected readonly _options: Blast.Options;
+    constructor(_options?: Blast.Options);
+    /**
+     * Send an SMS message to all contacts in an audience. <br>
+     *
+     * Messages are distributed evenly across the provided sender phone numbers. <br>
+     *
+     * Use the optional `schedule` parameter in `options` to schedule the blast for future delivery. When scheduled, the response will contain a `scheduleId` instead of blast details.
+     *
+     * @param {Pinnacle.messages.BlastSms} request
+     * @param {Blast.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.PaymentRequiredError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.messages.blast.sms({
+     *         audienceId: "aud_abc123",
+     *         senders: ["+14155164736", "+14155164737"],
+     *         message: {
+     *             text: "Hello from Pinnacle!"
+     *         }
+     *     })
+     */
+    sms(request: Pinnacle.messages.BlastSms, requestOptions?: Blast.RequestOptions): core.HttpResponsePromise<Pinnacle.messages.BlastSmsResponse>;
+    private __sms;
+    /**
+     * Send an MMS message to all contacts in an audience. <br>
+     *
+     * Messages are distributed evenly across the provided sender phone numbers. <br>
+     *
+     * Use the optional `schedule` parameter in `options` to schedule the blast for future delivery. When scheduled, the response will contain a `scheduleId` instead of blast details.
+     *
+     * @param {Pinnacle.messages.BlastMms} request
+     * @param {Blast.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.PaymentRequiredError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.messages.blast.mms({
+     *         audienceId: "aud_abc123",
+     *         senders: ["+14155164736", "+14155164737"],
+     *         message: {
+     *             mediaUrls: ["https://fastly.picsum.photos/id/941/300/300.jpg"],
+     *             text: "Check out this image!"
+     *         },
+     *         options: {
+     *             validate: true
+     *         }
+     *     })
+     */
+    mms(request: Pinnacle.messages.BlastMms, requestOptions?: Blast.RequestOptions): core.HttpResponsePromise<Pinnacle.messages.BlastMmsResponse>;
+    private __mms;
+    /**
+     * Send an RCS message to all contacts in an audience. <br>
+     *
+     * Messages are distributed evenly across the provided RCS agents for load balancing. Requires active RCS agents and recipient devices that support RCS Business Messaging. <br>
+     *
+     * Use the optional `schedule` parameter in `options` to schedule the blast for future delivery. When scheduled, the response will contain a `scheduleId` instead of blast details.
+     *
+     * @param {Pinnacle.messages.BlastRcs} request
+     * @param {Blast.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.PaymentRequiredError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.messages.blast.rcs({
+     *         audienceId: "aud_abc123",
+     *         senders: ["agent_pinnacle", "agent_pinnacle2"],
+     *         message: {
+     *             quickReplies: [{
+     *                     type: "trigger",
+     *                     payload: "payload",
+     *                     title: "title"
+     *                 }],
+     *             text: "Hello from Pinnacle RCS!"
+     *         },
+     *         options: {
+     *             transcode: true,
+     *             validate: true
+     *         }
+     *     })
+     */
+    rcs(request: Pinnacle.messages.BlastRcs, requestOptions?: Blast.RequestOptions): core.HttpResponsePromise<Pinnacle.messages.BlastRcsResponse>;
+    private __rcs;
+    protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | undefined>>;
+}