rcs-js 2.0.7 → 2.0.8

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

@@ -0,0 +1,98 @@
+// This file was auto-generated by Fern from our API Definition.
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../../../core/headers.mjs";
+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";
+export class Schedule {
+    constructor(_options = {}) {
+        this._options = _options;
+    }
+    /**
+     * Cancel a scheduled message or blast. <br>
+     *
+     * Works for both individual scheduled messages and scheduled blasts. Use the `scheduleId` returned when the message or blast was scheduled.
+     *
+     * @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 {Schedule.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.schedule.cancel("id")
+     */
+    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/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/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);
+            return { "PINNACLE-API-KEY": apiKeyValue };
+        });
+    }
+}

package/dist/esm/api/resources/messages/resources/schedule/client/index.d.mts

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/resources/messages/resources/schedule/client/index.mjs

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1 @@
+export * from "./client/index.mjs";

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

@@ -0,0 +1 @@
+export * from "./client/index.mjs";

package/dist/esm/api/types/BlastDetails.d.mts

@@ -0,0 +1,17 @@
+/**
+ * Response containing details about the scheduled blast.
+ */
+export interface BlastDetails {
+    /** Unique identifier for the blast. This identifier is a string that always begins with the prefix `blast_`, for example: `blast_1234567890`. */
+    blastId: string;
+    /** The audience ID the blast was sent to. This identifier is a string that always begins with the prefix `aud_`, for example: `aud_abc123`. */
+    audienceId: string;
+    /** Total number of recipients in the audience. */
+    totalRecipients: number;
+    /** Total number of messages to be sent. */
+    totalMessages: number;
+    /** Total number of message segments across all messages. */
+    totalSegments: number;
+    /** Total estimated cost of the blast. Calculated by multiplying the number of segments by the number of messages by the unit cost. */
+    totalCost: number;
+}

package/dist/esm/api/types/BlastDetails.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/DlcCampaignWithExtendedBrandAndStatus.d.mts

@@ -37,6 +37,18 @@ export interface DlcCampaignWithExtendedBrandAndStatus {
     status: Pinnacle.ProfileStatusEnum;
     /** Use case for the campaign. */
     useCase?: DlcCampaignWithExtendedBrandAndStatus.UseCase;
+    /**
+     * 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.
+     */
+    mnoBrandTier?: DlcCampaignWithExtendedBrandAndStatus.MnoBrandTier;
+    /**
+     * 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.
+     */
+    mnoTcrTier?: DlcCampaignWithExtendedBrandAndStatus.MnoTcrTier;
 }
 export declare namespace DlcCampaignWithExtendedBrandAndStatus {
     /**
@@ -113,4 +125,34 @@ export declare namespace DlcCampaignWithExtendedBrandAndStatus {
         sub?: Pinnacle.SubUseCaseEnum[];
         value?: Pinnacle.DlcCampaignUseCaseEnum;
     }
+    /**
+     * 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.
+     */
+    const MnoBrandTier: {
+        readonly Top: "TOP";
+        readonly HighMid: "HIGH_MID";
+        readonly LowMid: "LOW_MID";
+        readonly Low: "LOW";
+    };
+    type MnoBrandTier = (typeof MnoBrandTier)[keyof typeof MnoBrandTier];
+    /**
+     * 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.
+     */
+    const MnoTcrTier: {
+        readonly A: "A";
+        readonly B: "B";
+        readonly C: "C";
+        readonly D: "D";
+        readonly E: "E";
+        readonly F: "F";
+        readonly G: "G";
+        readonly N: "N";
+        readonly T: "T";
+        readonly S: "S";
+    };
+    type MnoTcrTier = (typeof MnoTcrTier)[keyof typeof MnoTcrTier];
 }

package/dist/esm/api/types/DlcCampaignWithExtendedBrandAndStatus.mjs

@@ -1,2 +1,32 @@
 // This file was auto-generated by Fern from our API Definition.
-export {};
+export 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 || (DlcCampaignWithExtendedBrandAndStatus = {}));

package/dist/esm/api/types/MessageSchedule.d.mts

@@ -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/esm/api/types/MessageStatusEnum.d.mts

@@ -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/esm/api/types/MessageStatusEnum.mjs

@@ -1,6 +1,7 @@
 // This file was auto-generated by Fern from our API Definition.
 /** Current status of the message. */
 export const MessageStatusEnum = {
+    Queued: "QUEUED",
     Pending: "PENDING",
     Sent: "SENT",
     SendFailed: "SEND_FAILED",

package/dist/esm/api/types/ScheduleCancelResult.d.mts

@@ -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/esm/api/types/ScheduleCancelResult.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/ScheduledBlastDetails.d.mts

@@ -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/esm/api/types/ScheduledBlastDetails.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

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

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

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

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

package/dist/esm/version.d.mts

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

package/dist/esm/version.mjs

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "rcs-js",
-    "version": "2.0.7",
+    "version": "2.0.8",
     "private": false,
     "repository": "github:pinnacle-dev/rcs-js",
     "type": "commonjs",