rcs-js 2.0.7 → 2.0.8

package/dist/cjs/api/resources/messages/resources/blast/client/requests/BlastMms.d.ts

@@ -0,0 +1,61 @@
+import type * as Pinnacle from "../../../../../../index.js";
+/**
+ * @example
+ *     {
+ *         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
+ *         }
+ *     }
+ *
+ * @example
+ *     {
+ *         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
+ *         }
+ *     }
+ */
+export interface BlastMms {
+    /**
+     * The audience ID to send the blast to. This identifier is a string that always begins with the prefix `aud_`, for example: `aud_abc123`. <br>
+     *
+     * You can create an audience via [the dashboard](https://app.pinnacle.sh/dashboard/audiences) or [API](/api-reference/audiences/create).
+     */
+    audienceId: string;
+    /**
+     * Array of phone numbers to send from in E.164 format. <br>
+     *
+     * Messages will be distributed evenly across these senders.
+     *
+     * > **Note:** Sandbox numbers cannot be used for blasts.
+     */
+    senders: string[];
+    message: Pinnacle.MmsContent;
+    /** Additional settings to customize MMS blast delivery. */
+    options?: BlastMms.Options;
+}
+export declare namespace BlastMms {
+    /**
+     * Additional settings to customize MMS blast delivery.
+     */
+    interface Options {
+        /**
+         * Set to true to validate the message before sending. <br>
+         *
+         * If validation fails, the blast is not sent.
+         */
+        validate?: boolean;
+        schedule?: Pinnacle.MessageSchedule;
+    }
+}

package/dist/cjs/api/resources/messages/resources/blast/client/requests/BlastRcs.d.ts

@@ -0,0 +1,110 @@
+import type * as Pinnacle from "../../../../../../index.js";
+/**
+ * @example
+ *     {
+ *         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
+ *         }
+ *     }
+ *
+ * @example
+ *     {
+ *         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
+ *         }
+ *     }
+ */
+export interface BlastRcs {
+    /**
+     * The audience ID to send the blast to. This identifier is a string that always begins with the prefix `aud_`, for example: `aud_abc123`. <br>
+     *
+     * You can create an audience via [the dashboard](https://app.pinnacle.sh/dashboard/audiences) or [API](/api-reference/audiences/create).
+     */
+    audienceId: string;
+    /**
+     * Array of RCS agent IDs to send from. Each must be prefixed with `agent_`. <br>
+     *
+     * Messages will be evenly distributed across these agents.
+     *
+     * > **Note:** Test agents cannot be used for blasts.
+     */
+    senders: string[];
+    message: Pinnacle.RcsValidateContent;
+    /** Configure how your RCS blast is sent and tracked. */
+    options?: BlastRcs.Options;
+}
+export declare namespace BlastRcs {
+    /**
+     * Configure how your RCS blast is sent and tracked.
+     */
+    interface Options {
+        /** Media files and card media will be transcoded to a supported RCS format. This adds a small delay to sending the message. Ignored for rich text messages. */
+        transcode?: boolean;
+        /**
+         * Validate your message for any unsupported files. <br>
+         *
+         * If failed, errors will be thrown and the blast will not be sent.
+         */
+        validate?: boolean;
+        /**
+         * Configure standalone card layout options for enhanced visual presentation.
+         *
+         * > **⚠️ Important Restriction**
+         * >
+         * > This option is **only valid for single card messages**. Using it with multiple cards will cause the request to fail with a validation error.
+         */
+        standalone_card?: Options.StandaloneCard;
+        schedule?: Pinnacle.MessageSchedule;
+    }
+    namespace Options {
+        /**
+         * Configure standalone card layout options for enhanced visual presentation.
+         *
+         * > **⚠️ Important Restriction**
+         * >
+         * > This option is **only valid for single card messages**. Using it with multiple cards will cause the request to fail with a validation error.
+         */
+        interface StandaloneCard {
+            /** The orientation of the standalone card. */
+            orientation?: StandaloneCard.Orientation;
+            /** The alignment of the image in the standalone card. This field is ignored if orientation is VERTICAL. */
+            image_alignment?: StandaloneCard.ImageAlignment;
+        }
+        namespace StandaloneCard {
+            /** The orientation of the standalone card. */
+            const Orientation: {
+                readonly Horizontal: "HORIZONTAL";
+                readonly Vertical: "VERTICAL";
+            };
+            type Orientation = (typeof Orientation)[keyof typeof Orientation];
+            /** The alignment of the image in the standalone card. This field is ignored if orientation is VERTICAL. */
+            const ImageAlignment: {
+                readonly Left: "LEFT";
+                readonly Right: "RIGHT";
+            };
+            type ImageAlignment = (typeof ImageAlignment)[keyof typeof ImageAlignment];
+        }
+    }
+}

package/dist/cjs/api/resources/messages/resources/blast/client/requests/BlastRcs.js

@@ -0,0 +1,23 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BlastRcs = void 0;
+var BlastRcs;
+(function (BlastRcs) {
+    let Options;
+    (function (Options) {
+        let StandaloneCard;
+        (function (StandaloneCard) {
+            /** The orientation of the standalone card. */
+            StandaloneCard.Orientation = {
+                Horizontal: "HORIZONTAL",
+                Vertical: "VERTICAL",
+            };
+            /** The alignment of the image in the standalone card. This field is ignored if orientation is VERTICAL. */
+            StandaloneCard.ImageAlignment = {
+                Left: "LEFT",
+                Right: "RIGHT",
+            };
+        })(StandaloneCard = Options.StandaloneCard || (Options.StandaloneCard = {}));
+    })(Options = BlastRcs.Options || (BlastRcs.Options = {}));
+})(BlastRcs || (exports.BlastRcs = BlastRcs = {}));

package/dist/cjs/api/resources/messages/resources/blast/client/requests/BlastSms.d.ts

@@ -0,0 +1,47 @@
+import type * as Pinnacle from "../../../../../../index.js";
+/**
+ * @example
+ *     {
+ *         audienceId: "aud_abc123",
+ *         senders: ["+14155164736", "+14155164737"],
+ *         message: {
+ *             text: "Hello from Pinnacle!"
+ *         }
+ *     }
+ *
+ * @example
+ *     {
+ *         audienceId: "aud_abc123",
+ *         senders: ["+14155164736", "+14155164737"],
+ *         message: {
+ *             text: "Hello from Pinnacle!"
+ *         }
+ *     }
+ */
+export interface BlastSms {
+    /**
+     * The audience ID to send the blast to. This identifier is a string that always begins with the prefix `aud_`, for example: `aud_abc123`. <br>
+     *
+     * You can create an audience via [the dashboard](https://app.pinnacle.sh/dashboard/audiences) or [API](/api-reference/audiences/create).
+     */
+    audienceId: string;
+    /**
+     * Array of phone numbers to send from in E.164 format. <br>
+     *
+     * Messages will be distributed evenly across these senders.
+     *
+     * > **Note:** Sandbox numbers cannot be used for blasts.
+     */
+    senders: string[];
+    message: Pinnacle.SmsContent;
+    /** Additional settings to customize SMS blast delivery. */
+    options?: BlastSms.Options;
+}
+export declare namespace BlastSms {
+    /**
+     * Additional settings to customize SMS blast delivery.
+     */
+    interface Options {
+        schedule?: Pinnacle.MessageSchedule;
+    }
+}

package/dist/cjs/api/resources/messages/resources/blast/client/requests/BlastSms.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/resources/messages/resources/blast/client/requests/index.d.ts

@@ -0,0 +1,3 @@
+export type { BlastMms } from "./BlastMms.js";
+export type { BlastRcs } from "./BlastRcs.js";
+export type { BlastSms } from "./BlastSms.js";

package/dist/cjs/api/resources/messages/resources/blast/client/requests/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/messages/resources/blast/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./client/index.js";
+export * from "./types/index.js";

package/dist/cjs/api/resources/messages/resources/blast/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./client/index.js"), exports);
+__exportStar(require("./types/index.js"), exports);

package/dist/cjs/api/resources/messages/resources/blast/types/BlastMmsResponse.d.ts

@@ -0,0 +1,2 @@
+import type * as Pinnacle from "../../../../../index.js";
+export type BlastMmsResponse = Pinnacle.BlastDetails | Pinnacle.ScheduledBlastDetails;

package/dist/cjs/api/resources/messages/resources/blast/types/BlastMmsResponse.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/resources/messages/resources/blast/types/BlastRcsResponse.d.ts

@@ -0,0 +1,2 @@
+import type * as Pinnacle from "../../../../../index.js";
+export type BlastRcsResponse = Pinnacle.BlastDetails | Pinnacle.ScheduledBlastDetails;

package/dist/cjs/api/resources/messages/resources/blast/types/BlastRcsResponse.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/resources/messages/resources/blast/types/BlastSmsResponse.d.ts

@@ -0,0 +1,2 @@
+import type * as Pinnacle from "../../../../../index.js";
+export type BlastSmsResponse = Pinnacle.BlastDetails | Pinnacle.ScheduledBlastDetails;

package/dist/cjs/api/resources/messages/resources/blast/types/BlastSmsResponse.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/resources/messages/resources/blast/types/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./BlastMmsResponse.js";
+export * from "./BlastRcsResponse.js";
+export * from "./BlastSmsResponse.js";

package/dist/cjs/api/resources/messages/resources/blast/types/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./BlastMmsResponse.js"), exports);
+__exportStar(require("./BlastRcsResponse.js"), exports);
+__exportStar(require("./BlastSmsResponse.js"), exports);

package/dist/cjs/api/resources/messages/resources/index.d.ts

@@ -1,9 +1,13 @@
+export * from "./blast/client/requests/index.js";
+export * as blast from "./blast/index.js";
+export * from "./blast/types/index.js";
 export * from "./mms/client/requests/index.js";
 export * as mms from "./mms/index.js";
 export * from "./mms/types/index.js";
 export * from "./rcs/client/requests/index.js";
 export * as rcs from "./rcs/index.js";
 export * from "./rcs/types/index.js";
+export * as schedule from "./schedule/index.js";
 export * from "./sms/client/requests/index.js";
 export * as sms from "./sms/index.js";
 export * from "./sms/types/index.js";

package/dist/cjs/api/resources/messages/resources/index.js

@@ -36,13 +36,17 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sms = exports.rcs = exports.mms = void 0;
+exports.sms = exports.schedule = exports.rcs = exports.mms = exports.blast = void 0;
+__exportStar(require("./blast/client/requests/index.js"), exports);
+exports.blast = __importStar(require("./blast/index.js"));
+__exportStar(require("./blast/types/index.js"), exports);
 __exportStar(require("./mms/client/requests/index.js"), exports);
 exports.mms = __importStar(require("./mms/index.js"));
 __exportStar(require("./mms/types/index.js"), exports);
 __exportStar(require("./rcs/client/requests/index.js"), exports);
 exports.rcs = __importStar(require("./rcs/index.js"));
 __exportStar(require("./rcs/types/index.js"), exports);
+exports.schedule = __importStar(require("./schedule/index.js"));
 __exportStar(require("./sms/client/requests/index.js"), exports);
 exports.sms = __importStar(require("./sms/index.js"));
 __exportStar(require("./sms/types/index.js"), exports);

package/dist/cjs/api/resources/messages/resources/schedule/client/Client.d.ts

@@ -0,0 +1,32 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../../../BaseClient.js";
+import * as core from "../../../../../../core/index.js";
+import * as Pinnacle from "../../../../../index.js";
+export declare namespace Schedule {
+    interface Options extends BaseClientOptions {
+    }
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class Schedule {
+    protected readonly _options: Schedule.Options;
+    constructor(_options?: Schedule.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: string, requestOptions?: Schedule.RequestOptions): core.HttpResponsePromise<Pinnacle.ScheduleCancelResult>;
+    private __cancel;
+    protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | undefined>>;
+}

package/dist/cjs/api/resources/messages/resources/schedule/client/Client.js

@@ -0,0 +1,135 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Schedule = void 0;
+const headers_js_1 = require("../../../../../../core/headers.js");
+const core = __importStar(require("../../../../../../core/index.js"));
+const environments = __importStar(require("../../../../../../environments.js"));
+const errors = __importStar(require("../../../../../../errors/index.js"));
+const Pinnacle = __importStar(require("../../../../../index.js"));
+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 = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.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 };
+        });
+    }
+}
+exports.Schedule = Schedule;

package/dist/cjs/api/resources/messages/resources/schedule/client/index.d.ts

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

package/dist/cjs/api/resources/messages/resources/schedule/client/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/messages/resources/schedule/index.d.ts

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

package/dist/cjs/api/resources/messages/resources/schedule/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./client/index.js"), exports);

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

@@ -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/cjs/api/types/BlastDetails.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/DlcCampaignWithExtendedBrandAndStatus.d.ts

@@ -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];
 }