rcs-js 2.0.10 → 2.0.12

package/dist/cjs/BaseClient.d.ts

@@ -4,7 +4,7 @@ export interface BaseClientOptions {
     environment?: core.Supplier<environments.PinnacleEnvironment | string>;
     /** Specify a custom URL to connect the client to. */
     baseUrl?: core.Supplier<string>;
-    apiKey?: core.Supplier<string | undefined>;
+    apiKey: core.Supplier<string>;
     /** Additional headers to include in requests. */
     headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     /** The default maximum time to wait for a response in seconds. */

package/dist/cjs/Client.d.ts

@@ -29,7 +29,7 @@ export declare class PinnacleClient {
     protected _campaigns: Campaigns | undefined;
     protected _status: Status | undefined;
     protected _tools: Tools | undefined;
-    constructor(_options?: PinnacleClient.Options);
+    constructor(_options: PinnacleClient.Options);
     get brands(): Brands;
     get audiences(): Audiences;
     get contacts(): Contacts;

package/dist/cjs/Client.js

@@ -49,12 +49,12 @@ const Client_js_11 = require("./api/resources/webhooks/client/Client.js");
 const headers_js_1 = require("./core/headers.js");
 const core = __importStar(require("./core/index.js"));
 class PinnacleClient {
-    constructor(_options = {}) {
+    constructor(_options) {
         this._options = Object.assign(Object.assign({}, _options), { logging: core.logging.createLogger(_options === null || _options === void 0 ? void 0 : _options.logging), headers: (0, headers_js_1.mergeHeaders)({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "rcs-js",
-                "X-Fern-SDK-Version": "2.0.10",
-                "User-Agent": "rcs-js/2.0.10",
+                "X-Fern-SDK-Version": "2.0.12",
+                "User-Agent": "rcs-js/2.0.12",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

package/dist/cjs/api/errors/ForbiddenError.d.ts

@@ -0,0 +1,6 @@
+import type * as core from "../../core/index.js";
+import * as errors from "../../errors/index.js";
+import type * as Pinnacle from "../index.js";
+export declare class ForbiddenError extends errors.PinnacleError {
+    constructor(body: Pinnacle.Error_, rawResponse?: core.RawResponse);
+}

package/dist/cjs/api/errors/ForbiddenError.js

@@ -0,0 +1,50 @@
+"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;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ForbiddenError = void 0;
+const errors = __importStar(require("../../errors/index.js"));
+class ForbiddenError extends errors.PinnacleError {
+    constructor(body, rawResponse) {
+        super({
+            message: "ForbiddenError",
+            statusCode: 403,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, ForbiddenError.prototype);
+    }
+}
+exports.ForbiddenError = ForbiddenError;

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

@@ -1,4 +1,5 @@
 export * from "./BadRequestError.js";
+export * from "./ForbiddenError.js";
 export * from "./InternalServerError.js";
 export * from "./NotFoundError.js";
 export * from "./NotImplementedError.js";

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

@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./BadRequestError.js"), exports);
+__exportStar(require("./ForbiddenError.js"), exports);
 __exportStar(require("./InternalServerError.js"), exports);
 __exportStar(require("./NotFoundError.js"), exports);
 __exportStar(require("./NotImplementedError.js"), exports);

package/dist/cjs/api/resources/audiences/client/Client.d.ts

@@ -11,7 +11,7 @@ export declare namespace Audiences {
 export declare class Audiences {
     protected readonly _options: Audiences.Options;
     protected _contacts: Contacts | undefined;
-    constructor(_options?: Audiences.Options);
+    constructor(_options: Audiences.Options);
     get contacts(): Contacts;
     /**
      * Retrieve an audience by ID with optional pagination.
@@ -21,6 +21,7 @@ export declare class Audiences {
      *
      * @throws {@link Pinnacle.BadRequestError}
      * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.ForbiddenError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
      *
@@ -39,6 +40,7 @@ export declare class Audiences {
      *
      * @throws {@link Pinnacle.BadRequestError}
      * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.ForbiddenError}
      * @throws {@link Pinnacle.InternalServerError}
      *
      * @example
@@ -72,6 +74,7 @@ export declare class Audiences {
      *
      * @throws {@link Pinnacle.BadRequestError}
      * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.ForbiddenError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
      *
@@ -92,6 +95,7 @@ export declare class Audiences {
      *
      * @throws {@link Pinnacle.BadRequestError}
      * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.ForbiddenError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
      *

package/dist/cjs/api/resources/audiences/client/Client.js

@@ -51,7 +51,7 @@ const errors = __importStar(require("../../../../errors/index.js"));
 const Pinnacle = __importStar(require("../../../index.js"));
 const Client_js_1 = require("../resources/contacts/client/Client.js");
 class Audiences {
-    constructor(_options = {}) {
+    constructor(_options) {
         this._options = _options;
     }
     get contacts() {
@@ -66,6 +66,7 @@ class Audiences {
      *
      * @throws {@link Pinnacle.BadRequestError}
      * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.ForbiddenError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
      *
@@ -110,6 +111,8 @@ class Audiences {
                         throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
                     case 401:
                         throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Pinnacle.ForbiddenError(_response.error.body, _response.rawResponse);
                     case 404:
                         throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
                     case 500:
@@ -147,6 +150,7 @@ class Audiences {
      *
      * @throws {@link Pinnacle.BadRequestError}
      * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.ForbiddenError}
      * @throws {@link Pinnacle.InternalServerError}
      *
      * @example
@@ -198,6 +202,8 @@ class Audiences {
                         throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
                     case 401:
                         throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Pinnacle.ForbiddenError(_response.error.body, _response.rawResponse);
                     case 500:
                         throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
                     default:
@@ -235,6 +241,7 @@ class Audiences {
      *
      * @throws {@link Pinnacle.BadRequestError}
      * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.ForbiddenError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
      *
@@ -273,6 +280,8 @@ class Audiences {
                         throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
                     case 401:
                         throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Pinnacle.ForbiddenError(_response.error.body, _response.rawResponse);
                     case 404:
                         throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
                     case 500:
@@ -312,6 +321,7 @@ class Audiences {
      *
      * @throws {@link Pinnacle.BadRequestError}
      * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.ForbiddenError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
      *
@@ -352,6 +362,8 @@ class Audiences {
                         throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
                     case 401:
                         throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Pinnacle.ForbiddenError(_response.error.body, _response.rawResponse);
                     case 404:
                         throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
                     case 500:

package/dist/cjs/api/resources/audiences/resources/contacts/client/Client.d.ts

@@ -9,7 +9,7 @@ export declare namespace Contacts {
 }
 export declare class Contacts {
     protected readonly _options: Contacts.Options;
-    constructor(_options?: Contacts.Options);
+    constructor(_options: Contacts.Options);
     /**
      * Remove contacts from an existing audience. This operation is idempotent.
      *
@@ -21,6 +21,7 @@ export declare class Contacts {
      *
      * @throws {@link Pinnacle.BadRequestError}
      * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.ForbiddenError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
      *
@@ -44,6 +45,7 @@ export declare class Contacts {
      *
      * @throws {@link Pinnacle.BadRequestError}
      * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.ForbiddenError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
      *

package/dist/cjs/api/resources/audiences/resources/contacts/client/Client.js

@@ -50,7 +50,7 @@ const environments = __importStar(require("../../../../../../environments.js"));
 const errors = __importStar(require("../../../../../../errors/index.js"));
 const Pinnacle = __importStar(require("../../../../../index.js"));
 class Contacts {
-    constructor(_options = {}) {
+    constructor(_options) {
         this._options = _options;
     }
     /**
@@ -64,6 +64,7 @@ class Contacts {
      *
      * @throws {@link Pinnacle.BadRequestError}
      * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.ForbiddenError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
      *
@@ -103,6 +104,8 @@ class Contacts {
                         throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
                     case 401:
                         throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Pinnacle.ForbiddenError(_response.error.body, _response.rawResponse);
                     case 404:
                         throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
                     case 500:
@@ -144,6 +147,7 @@ class Contacts {
      *
      * @throws {@link Pinnacle.BadRequestError}
      * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.ForbiddenError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
      *
@@ -183,6 +187,8 @@ class Contacts {
                         throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
                     case 401:
                         throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Pinnacle.ForbiddenError(_response.error.body, _response.rawResponse);
                     case 404:
                         throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
                     case 500:

package/dist/cjs/api/resources/brands/client/Client.d.ts

@@ -9,7 +9,7 @@ export declare namespace Brands {
 }
 export declare class Brands {
     protected readonly _options: Brands.Options;
-    constructor(_options?: Brands.Options);
+    constructor(_options: Brands.Options);
     /**
      * Automatically populate brand information based on partial input data you provide.
      *
@@ -18,6 +18,7 @@ export declare class Brands {
      *
      * @throws {@link Pinnacle.BadRequestError}
      * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.ForbiddenError}
      * @throws {@link Pinnacle.InternalServerError}
      *
      * @example
@@ -33,13 +34,20 @@ export declare class Brands {
     autofill(request?: Pinnacle.AutofillBrandParams, requestOptions?: Brands.RequestOptions): core.HttpResponsePromise<Pinnacle.OptionalBrandInfo>;
     private __autofill;
     /**
-     * Create a new brand or update an existing brand by with the provided information.
+     * Create a new brand or update an existing one.
+     *
+     * <Note>
+     * **To create a new brand:** Omit `id` — one will be generated automatically.
+     *
+     * All fields are **required** except `description` and `dba`, and will be validated when [submitted](/api-reference/brands/submit).
+     * </Note>
      *
      * @param {Pinnacle.UpsertBrandParams} request
      * @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
      * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.ForbiddenError}
      * @throws {@link Pinnacle.InternalServerError}
      *
      * @example
@@ -75,6 +83,7 @@ export declare class Brands {
      *
      * @throws {@link Pinnacle.BadRequestError}
      * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.ForbiddenError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
      *
@@ -93,6 +102,7 @@ export declare class Brands {
      * @throws {@link Pinnacle.BadRequestError}
      * @throws {@link Pinnacle.UnauthorizedError}
      * @throws {@link Pinnacle.PaymentRequiredError}
+     * @throws {@link Pinnacle.ForbiddenError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
      * @throws {@link Pinnacle.NotImplementedError}
@@ -110,6 +120,7 @@ export declare class Brands {
      *
      * @throws {@link Pinnacle.BadRequestError}
      * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.ForbiddenError}
      * @throws {@link Pinnacle.InternalServerError}
      *
      * @example
@@ -129,6 +140,7 @@ export declare class Brands {
      * @throws {@link Pinnacle.BadRequestError}
      * @throws {@link Pinnacle.UnauthorizedError}
      * @throws {@link Pinnacle.PaymentRequiredError}
+     * @throws {@link Pinnacle.ForbiddenError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
      * @throws {@link Pinnacle.NotImplementedError}

package/dist/cjs/api/resources/brands/client/Client.js

@@ -50,7 +50,7 @@ const environments = __importStar(require("../../../../environments.js"));
 const errors = __importStar(require("../../../../errors/index.js"));
 const Pinnacle = __importStar(require("../../../index.js"));
 class Brands {
-    constructor(_options = {}) {
+    constructor(_options) {
         this._options = _options;
     }
     /**
@@ -61,6 +61,7 @@ class Brands {
      *
      * @throws {@link Pinnacle.BadRequestError}
      * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.ForbiddenError}
      * @throws {@link Pinnacle.InternalServerError}
      *
      * @example
@@ -103,6 +104,8 @@ class Brands {
                         throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
                     case 401:
                         throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Pinnacle.ForbiddenError(_response.error.body, _response.rawResponse);
                     case 500:
                         throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
                     default:
@@ -131,13 +134,20 @@ class Brands {
         });
     }
     /**
-     * Create a new brand or update an existing brand by with the provided information.
+     * Create a new brand or update an existing one.
+     *
+     * <Note>
+     * **To create a new brand:** Omit `id` — one will be generated automatically.
+     *
+     * All fields are **required** except `description` and `dba`, and will be validated when [submitted](/api-reference/brands/submit).
+     * </Note>
      *
      * @param {Pinnacle.UpsertBrandParams} request
      * @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
      * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.ForbiddenError}
      * @throws {@link Pinnacle.InternalServerError}
      *
      * @example
@@ -191,6 +201,8 @@ class Brands {
                         throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
                     case 401:
                         throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Pinnacle.ForbiddenError(_response.error.body, _response.rawResponse);
                     case 500:
                         throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
                     default:
@@ -228,6 +240,7 @@ class Brands {
      *
      * @throws {@link Pinnacle.BadRequestError}
      * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.ForbiddenError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
      *
@@ -266,6 +279,8 @@ class Brands {
                         throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
                     case 401:
                         throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Pinnacle.ForbiddenError(_response.error.body, _response.rawResponse);
                     case 404:
                         throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
                     case 500:
@@ -305,6 +320,7 @@ class Brands {
      * @throws {@link Pinnacle.BadRequestError}
      * @throws {@link Pinnacle.UnauthorizedError}
      * @throws {@link Pinnacle.PaymentRequiredError}
+     * @throws {@link Pinnacle.ForbiddenError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
      * @throws {@link Pinnacle.NotImplementedError}
@@ -341,6 +357,8 @@ class Brands {
                         throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
                     case 402:
                         throw new Pinnacle.PaymentRequiredError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Pinnacle.ForbiddenError(_response.error.body, _response.rawResponse);
                     case 404:
                         throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
                     case 500:
@@ -380,6 +398,7 @@ class Brands {
      *
      * @throws {@link Pinnacle.BadRequestError}
      * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.ForbiddenError}
      * @throws {@link Pinnacle.InternalServerError}
      *
      * @example
@@ -415,6 +434,8 @@ class Brands {
                         throw new Pinnacle.BadRequestError(_response.error.body, _response.rawResponse);
                     case 401:
                         throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Pinnacle.ForbiddenError(_response.error.body, _response.rawResponse);
                     case 500:
                         throw new Pinnacle.InternalServerError(_response.error.body, _response.rawResponse);
                     default:
@@ -454,6 +475,7 @@ class Brands {
      * @throws {@link Pinnacle.BadRequestError}
      * @throws {@link Pinnacle.UnauthorizedError}
      * @throws {@link Pinnacle.PaymentRequiredError}
+     * @throws {@link Pinnacle.ForbiddenError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
      * @throws {@link Pinnacle.NotImplementedError}
@@ -493,6 +515,8 @@ class Brands {
                         throw new Pinnacle.UnauthorizedError(_response.error.body, _response.rawResponse);
                     case 402:
                         throw new Pinnacle.PaymentRequiredError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Pinnacle.ForbiddenError(_response.error.body, _response.rawResponse);
                     case 404:
                         throw new Pinnacle.NotFoundError(_response.error.body, _response.rawResponse);
                     case 500:

package/dist/cjs/api/resources/campaigns/client/Client.d.ts

@@ -11,7 +11,7 @@ export declare class Campaigns {
     protected _dlc: Dlc | undefined;
     protected _tollFree: TollFree | undefined;
     protected _rcs: Rcs | undefined;
-    constructor(_options?: Campaigns.Options);
+    constructor(_options: Campaigns.Options);
     get dlc(): Dlc;
     get tollFree(): TollFree;
     get rcs(): Rcs;

package/dist/cjs/api/resources/campaigns/client/Client.js

@@ -6,7 +6,7 @@ const Client_js_1 = require("../resources/dlc/client/Client.js");
 const Client_js_2 = require("../resources/rcs/client/Client.js");
 const Client_js_3 = require("../resources/tollFree/client/Client.js");
 class Campaigns {
-    constructor(_options = {}) {
+    constructor(_options) {
         this._options = _options;
     }
     get dlc() {

package/dist/cjs/api/resources/campaigns/resources/dlc/client/Client.d.ts

@@ -9,7 +9,7 @@ export declare namespace Dlc {
 }
 export declare class Dlc {
     protected readonly _options: Dlc.Options;
-    constructor(_options?: Dlc.Options);
+    constructor(_options: Dlc.Options);
     /**
      * Generate campaign details based off existing campaign and the brand it's connected to.
      *
@@ -18,6 +18,7 @@ export declare class Dlc {
      *
      * @throws {@link Pinnacle.BadRequestError}
      * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.ForbiddenError}
      * @throws {@link Pinnacle.InternalServerError}
      *
      * @example
@@ -36,6 +37,7 @@ export declare class Dlc {
      *
      * @throws {@link Pinnacle.BadRequestError}
      * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.ForbiddenError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
      *
@@ -53,6 +55,7 @@ export declare class Dlc {
      *
      * @throws {@link Pinnacle.BadRequestError}
      * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.ForbiddenError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
      *
@@ -62,15 +65,24 @@ export declare class Dlc {
     submit(campaignId: string, requestOptions?: Dlc.RequestOptions): core.HttpResponsePromise<Pinnacle.CampaignSubmissionResult>;
     private __submit;
     /**
-     * Create a new 10DLC campaign or updates an existing one. <br>
+     * Create a new 10DLC campaign or update an existing one.
      *
-     * Omit campaignId to create a campaign.
+     * <Note>
+     * **To create a new campaign:** Omit `campaignId` — one will be generated automatically.
+     *
+     * **Before you start:** Create a [brand](/api-reference/brands/upsert) first — you'll need its `id` for the [`brand`](#request.body.brand) field.
+     *
+     * All fields are **required** unless specified otherwise, and will be validated when [submitted](/api-reference/campaigns/10-dlc/submit).
+     *
+     * **See the response for example values for each field.**
+     * </Note>
      *
      * @param {Pinnacle.campaigns.UpsertDlcCampaignParams} request
      * @param {Dlc.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
      * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.ForbiddenError}
      * @throws {@link Pinnacle.NotFoundError}
      * @throws {@link Pinnacle.InternalServerError}
      *
@@ -78,27 +90,27 @@ export declare class Dlc {
      *     await client.campaigns.dlc.upsert({
      *         autoRenew: true,
      *         brand: "b_1234567890",
-     *         campaignId: "dlc_1234567890",
+     *         description: "This campaign sends transactional SMS messages to customers who have opted in, including account notifications, security alerts, and customer care responses. Messages are sent when triggered by account activity such as login attempts, password changes, order updates, or support inquiries. All messages include required STOP/HELP disclosures and comply with TCPA guidelines.",
      *         keywords: {
      *             HELP: {
-     *                 message: "Reply HELP for assistance, STOP to opt-out",
-     *                 values: ["HELP", "INFO", "SUPPORT"]
+     *                 message: "Pinnacle Software Development Inc.: For assistance, visit https://pinnacle.sh/support or email founders@trypinnacle.app. Msg&data rates may apply. Reply STOP to cancel.",
+     *                 values: ["HELP", "SUPPORT", "INFO"]
      *             },
      *             OPT_IN: {
-     *                 message: "Welcome. You are now subscribed to Pinnacle.",
-     *                 values: ["JOIN", "START", "SUBSCRIBE"]
+     *                 message: "Pinnacle Software Development Inc.: You're enrolled in account & security alerts. Msg&data rates may apply. Message frequency varies. Reply HELP for help, STOP to cancel. Terms: https://pinnacle.sh/terms Privacy: https://pinnacle.sh/privacy",
+     *                 values: ["START", "YES", "SUBSCRIBE"]
      *             },
      *             OPT_OUT: {
-     *                 message: "You have been unsubscribed. Reply START to rejoin.",
-     *                 values: ["STOP", "QUIT", "UNSUBSCRIBE"]
+     *                 message: "Pinnacle Software Development Inc.: You're unsubscribed and will receive no further texts. For assistance, visit https://pinnacle.sh or call 877-389-0460. Reply START to resubscribe.",
+     *                 values: ["STOP", "CANCEL", "UNSUBSCRIBE"]
      *             }
      *         },
      *         links: {
      *             privacyPolicy: "https://www.pinnacle.sh/privacy",
      *             termsOfService: "https://www.pinnacle.sh/terms"
      *         },
-     *         messageFlow: "Customer initiates -> Automated response -> Agent follow-up if needed",
-     *         name: "Account Notifications",
+     *         messageFlow: "The user fills out a paper form during onboarding at [Address] which they learn about at our website (https://pinnacle.sh) in which they provide their phone number and sign their consent. The form includes a disclaimer: \"By signing this form and providing your phone number, you agree to receive SMS Mixed - Account Notification, Customer Care, Security Alert, Delivery Notification from Pinnacle Software Development Inc. Message frequency may vary. Standard Message and Data Rates may apply. Reply STOP to opt out. Reply HELP for help. Consent is not a condition of purchase. Your mobile information will not be sold or shared with third parties for promotional or marketing purposes.\" Once the information is entered into the system, the user receives a confirmation SMS: \"Thank you for signing up for SMS updates from Pinnacle Software Development Inc. Msg freq may vary. Std msg & data rates apply. Reply STOP to opt out, HELP for help.\" Link to paper form: https://www.pinnacle.sh/opt-in",
+     *         name: "Pinnacle's Account Notifications",
      *         options: {
      *             affiliateMarketing: false,
      *             ageGated: false,
@@ -107,10 +119,10 @@ export declare class Dlc {
      *             embeddedPhone: false,
      *             numberPooling: false
      *         },
-     *         sampleMessages: ["Security alert: Unusual login detected from new device."],
+     *         sampleMessages: ["Pinnacle Software Development Inc.: We're here to help. Visit https://pinnacle.sh or call 877-389-0460. Msg&data rates may apply. Reply STOP to cancel.", "Pinnacle Software Development Inc.: You're enrolled in account & security alerts. Msg&data rates may apply. Message frequency varies. Reply HELP for help, STOP to cancel. Terms: https://pinnacle.sh/terms/ Privacy: https://pinnacle.sh/privacy/", "Pinnacle Software Development Inc.: An update has been made to your account. Read it in the portal.", "Pinnacle Software Development Inc.: We received your message. A team member will reply shortly. For immediate help call 877-389-0460. Msg&data rates may apply. Reply STOP to cancel."],
      *         useCase: {
-     *             sub: ["FRAUD_ALERT"],
-     *             value: "ACCOUNT_NOTIFICATION"
+     *             sub: ["ACCOUNT_NOTIFICATION", "CUSTOMER_CARE", "SECURITY_ALERT"],
+     *             value: "MIXED"
      *         }
      *     })
      */
@@ -124,6 +136,7 @@ export declare class Dlc {
      *
      * @throws {@link Pinnacle.BadRequestError}
      * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.ForbiddenError}
      * @throws {@link Pinnacle.InternalServerError}
      *
      * @example