rcs-js 1.0.22 → 2.0.0-rc.2

package/dist/cjs/index.js

@@ -35,8 +35,8 @@ var __importStar = (this && this.__importStar) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PinnacleTimeoutError = exports.PinnacleError = exports.PinnacleEnvironment = exports.PinnacleClient = exports.Pinnacle = void 0;
 exports.Pinnacle = __importStar(require("./api"));
-var PinnacleClient_1 = require("./wrapper/PinnacleClient");
-Object.defineProperty(exports, "PinnacleClient", { enumerable: true, get: function () { return PinnacleClient_1.PinnacleClient; } });
+var Client_1 = require("./Client");
+Object.defineProperty(exports, "PinnacleClient", { enumerable: true, get: function () { return Client_1.PinnacleClient; } });
 var environments_1 = require("./environments");
 Object.defineProperty(exports, "PinnacleEnvironment", { enumerable: true, get: function () { return environments_1.PinnacleEnvironment; } });
 var errors_1 = require("./errors");

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.0.22";
+export declare const SDK_VERSION = "2.0.0-rc.2";

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 = "1.0.22";
+exports.SDK_VERSION = "2.0.0-rc.2";

package/dist/esm/Client.d.mts

@@ -3,9 +3,15 @@
  */
 import * as environments from "./environments.mjs";
 import * as core from "./core/index.mjs";
-import * as Pinnacle from "./api/index.mjs";
-import { Company } from "./api/resources/company/client/Client.mjs";
-import { Send } from "./api/resources/send/client/Client.mjs";
+import { Brands } from "./api/resources/brands/client/Client.mjs";
+import { Contacts } from "./api/resources/contacts/client/Client.mjs";
+import { Conversations } from "./api/resources/conversations/client/Client.mjs";
+import { Messages } from "./api/resources/messages/client/Client.mjs";
+import { PhoneNumbers } from "./api/resources/phoneNumbers/client/Client.mjs";
+import { Webhooks } from "./api/resources/webhooks/client/Client.mjs";
+import { Campaigns } from "./api/resources/campaigns/client/Client.mjs";
+import { Message } from "./api/resources/message/client/Client.mjs";
+import { Status } from "./api/resources/status/client/Client.mjs";
 import { Tools } from "./api/resources/tools/client/Client.mjs";
 export declare namespace PinnacleClient {
     interface Options {
@@ -14,7 +20,7 @@ export declare namespace PinnacleClient {
         baseUrl?: core.Supplier<string>;
         apiKey: core.Supplier<string>;
         /** Additional headers to include in requests. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
     interface RequestOptions {
         /** The maximum time to wait for a response in seconds. */
@@ -23,35 +29,33 @@ export declare namespace PinnacleClient {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
+        /** Additional query string parameters to include in the request. */
+        queryParams?: Record<string, unknown>;
         /** Additional headers to include in the request. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
 }
 export declare class PinnacleClient {
     protected readonly _options: PinnacleClient.Options;
-    protected _company: Company | undefined;
-    protected _send: Send | undefined;
+    protected _brands: Brands | undefined;
+    protected _contacts: Contacts | undefined;
+    protected _conversations: Conversations | undefined;
+    protected _messages: Messages | undefined;
+    protected _phoneNumbers: PhoneNumbers | undefined;
+    protected _webhooks: Webhooks | undefined;
+    protected _campaigns: Campaigns | undefined;
+    protected _message: Message | undefined;
+    protected _status: Status | undefined;
     protected _tools: Tools | undefined;
     constructor(_options: PinnacleClient.Options);
-    get company(): Company;
-    get send(): Send;
+    get brands(): Brands;
+    get contacts(): Contacts;
+    get conversations(): Conversations;
+    get messages(): Messages;
+    get phoneNumbers(): PhoneNumbers;
+    get webhooks(): Webhooks;
+    get campaigns(): Campaigns;
+    get message(): Message;
+    get status(): Status;
     get tools(): Tools;
-    /**
-     * Retrieve the RCS functionality of a phone number. For example checks if a phone number can receive RCS message and if it can receive RCS carousels.
-     *
-     * @param {Pinnacle.GetRcsFunctionalityRequest} request
-     * @param {PinnacleClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Pinnacle.BadRequestError}
-     * @throws {@link Pinnacle.UnauthorizedError}
-     * @throws {@link Pinnacle.InternalServerError}
-     *
-     * @example
-     *     await client.getRcsFunctionality()
-     */
-    getRcsFunctionality(request?: Pinnacle.GetRcsFunctionalityRequest, requestOptions?: PinnacleClient.RequestOptions): core.HttpResponsePromise<Pinnacle.RcsFunctionalities>;
-    private __getRcsFunctionality;
-    protected _getCustomAuthorizationHeaders(): Promise<{
-        "PINNACLE-API-Key": string;
-    }>;
 }

package/dist/esm/Client.mjs

@@ -1,119 +1,67 @@
 /**
  * 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 * as environments from "./environments.mjs";
 import * as core from "./core/index.mjs";
-import { mergeHeaders, mergeOnlyDefinedHeaders } from "./core/headers.mjs";
-import * as Pinnacle from "./api/index.mjs";
-import * as errors from "./errors/index.mjs";
-import { Company } from "./api/resources/company/client/Client.mjs";
-import { Send } from "./api/resources/send/client/Client.mjs";
+import { mergeHeaders } from "./core/headers.mjs";
+import { Brands } from "./api/resources/brands/client/Client.mjs";
+import { Contacts } from "./api/resources/contacts/client/Client.mjs";
+import { Conversations } from "./api/resources/conversations/client/Client.mjs";
+import { Messages } from "./api/resources/messages/client/Client.mjs";
+import { PhoneNumbers } from "./api/resources/phoneNumbers/client/Client.mjs";
+import { Webhooks } from "./api/resources/webhooks/client/Client.mjs";
+import { Campaigns } from "./api/resources/campaigns/client/Client.mjs";
+import { Message } from "./api/resources/message/client/Client.mjs";
+import { Status } from "./api/resources/status/client/Client.mjs";
 import { Tools } from "./api/resources/tools/client/Client.mjs";
 export class PinnacleClient {
     constructor(_options) {
         this._options = Object.assign(Object.assign({}, _options), { headers: mergeHeaders({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "rcs-js",
-                "X-Fern-SDK-Version": "1.0.22",
-                "User-Agent": "rcs-js/1.0.22",
+                "X-Fern-SDK-Version": "2.0.0-rc.2",
+                "User-Agent": "rcs-js/2.0.0-rc.2",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });
     }
-    get company() {
+    get brands() {
         var _a;
-        return ((_a = this._company) !== null && _a !== void 0 ? _a : (this._company = new Company(this._options)));
+        return ((_a = this._brands) !== null && _a !== void 0 ? _a : (this._brands = new Brands(this._options)));
     }
-    get send() {
+    get contacts() {
         var _a;
-        return ((_a = this._send) !== null && _a !== void 0 ? _a : (this._send = new Send(this._options)));
+        return ((_a = this._contacts) !== null && _a !== void 0 ? _a : (this._contacts = new Contacts(this._options)));
     }
-    get tools() {
+    get conversations() {
         var _a;
-        return ((_a = this._tools) !== null && _a !== void 0 ? _a : (this._tools = new Tools(this._options)));
+        return ((_a = this._conversations) !== null && _a !== void 0 ? _a : (this._conversations = new Conversations(this._options)));
+    }
+    get messages() {
+        var _a;
+        return ((_a = this._messages) !== null && _a !== void 0 ? _a : (this._messages = new Messages(this._options)));
     }
-    /**
-     * Retrieve the RCS functionality of a phone number. For example checks if a phone number can receive RCS message and if it can receive RCS carousels.
-     *
-     * @param {Pinnacle.GetRcsFunctionalityRequest} request
-     * @param {PinnacleClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Pinnacle.BadRequestError}
-     * @throws {@link Pinnacle.UnauthorizedError}
-     * @throws {@link Pinnacle.InternalServerError}
-     *
-     * @example
-     *     await client.getRcsFunctionality()
-     */
-    getRcsFunctionality(request = {}, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__getRcsFunctionality(request, requestOptions));
+    get phoneNumbers() {
+        var _a;
+        return ((_a = this._phoneNumbers) !== null && _a !== void 0 ? _a : (this._phoneNumbers = new PhoneNumbers(this._options)));
+    }
+    get webhooks() {
+        var _a;
+        return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Webhooks(this._options)));
     }
-    __getRcsFunctionality() {
-        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
-            var _a, _b, _c;
-            const { phoneNumber } = request;
-            const _queryParams = {};
-            if (phoneNumber != null) {
-                _queryParams["phoneNumber"] = phoneNumber;
-            }
-            const _response = yield core.fetcher({
-                url: core.url.join((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.PinnacleEnvironment.Default, "rcs_functionality"),
-                method: "GET",
-                headers: mergeHeaders((_c = this._options) === null || _c === void 0 ? void 0 : _c.headers, mergeOnlyDefinedHeaders(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
-                queryParameters: _queryParams,
-                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
-                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
-                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-            });
-            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 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 GET /rcs_functionality.");
-                case "unknown":
-                    throw new errors.PinnacleError({
-                        message: _response.error.errorMessage,
-                        rawResponse: _response.rawResponse,
-                    });
-            }
-        });
+    get campaigns() {
+        var _a;
+        return ((_a = this._campaigns) !== null && _a !== void 0 ? _a : (this._campaigns = new Campaigns(this._options)));
     }
-    _getCustomAuthorizationHeaders() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const apiKeyValue = yield core.Supplier.get(this._options.apiKey);
-            return { "PINNACLE-API-Key": apiKeyValue };
-        });
+    get message() {
+        var _a;
+        return ((_a = this._message) !== null && _a !== void 0 ? _a : (this._message = new Message(this._options)));
+    }
+    get status() {
+        var _a;
+        return ((_a = this._status) !== null && _a !== void 0 ? _a : (this._status = new Status(this._options)));
+    }
+    get tools() {
+        var _a;
+        return ((_a = this._tools) !== null && _a !== void 0 ? _a : (this._tools = new Tools(this._options)));
     }
 }

package/dist/esm/api/errors/InternalServerError.d.mts

@@ -2,7 +2,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as errors from "../../errors/index.mjs";
+import * as Pinnacle from "../index.mjs";
 import * as core from "../../core/index.mjs";
 export declare class InternalServerError extends errors.PinnacleError {
-    constructor(body?: unknown, rawResponse?: core.RawResponse);
+    constructor(body: Pinnacle.Error_, rawResponse?: core.RawResponse);
 }

package/dist/esm/api/errors/NotFoundError.d.mts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../errors/index.mjs";
+import * as Pinnacle from "../index.mjs";
+import * as core from "../../core/index.mjs";
+export declare class NotFoundError extends errors.PinnacleError {
+    constructor(body: Pinnacle.Error_, rawResponse?: core.RawResponse);
+}

package/dist/esm/api/errors/NotFoundError.mjs

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../errors/index.mjs";
+export class NotFoundError extends errors.PinnacleError {
+    constructor(body, rawResponse) {
+        super({
+            message: "NotFoundError",
+            statusCode: 404,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, NotFoundError.prototype);
+    }
+}

package/dist/esm/api/errors/NotImplementedError.d.mts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../errors/index.mjs";
+import * as Pinnacle from "../index.mjs";
+import * as core from "../../core/index.mjs";
+export declare class NotImplementedError extends errors.PinnacleError {
+    constructor(body: Pinnacle.Error_, rawResponse?: core.RawResponse);
+}

package/dist/esm/api/errors/NotImplementedError.mjs

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../errors/index.mjs";
+export class NotImplementedError extends errors.PinnacleError {
+    constructor(body, rawResponse) {
+        super({
+            message: "NotImplementedError",
+            statusCode: 501,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, NotImplementedError.prototype);
+    }
+}

package/dist/esm/api/errors/PaymentRequiredError.d.mts

@@ -2,7 +2,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as errors from "../../errors/index.mjs";
+import * as Pinnacle from "../index.mjs";
 import * as core from "../../core/index.mjs";
 export declare class PaymentRequiredError extends errors.PinnacleError {
-    constructor(body?: unknown, rawResponse?: core.RawResponse);
+    constructor(body: Pinnacle.Error_, rawResponse?: core.RawResponse);
 }

package/dist/esm/api/errors/UnauthorizedError.d.mts

@@ -2,7 +2,8 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as errors from "../../errors/index.mjs";
+import * as Pinnacle from "../index.mjs";
 import * as core from "../../core/index.mjs";
 export declare class UnauthorizedError extends errors.PinnacleError {
-    constructor(body?: unknown, rawResponse?: core.RawResponse);
+    constructor(body: Pinnacle.Error_, rawResponse?: core.RawResponse);
 }

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

@@ -1,5 +1,6 @@
 export * from "./BadRequestError.mjs";
 export * from "./UnauthorizedError.mjs";
 export * from "./InternalServerError.mjs";
+export * from "./NotFoundError.mjs";
 export * from "./PaymentRequiredError.mjs";
-export * from "./ForbiddenError.mjs";
+export * from "./NotImplementedError.mjs";

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

@@ -1,5 +1,6 @@
 export * from "./BadRequestError.mjs";
 export * from "./UnauthorizedError.mjs";
 export * from "./InternalServerError.mjs";
+export * from "./NotFoundError.mjs";
 export * from "./PaymentRequiredError.mjs";
-export * from "./ForbiddenError.mjs";
+export * from "./NotImplementedError.mjs";

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

@@ -1,4 +1,3 @@
 export * from "./resources/index.mjs";
 export * from "./types/index.mjs";
 export * from "./errors/index.mjs";
-export * from "./client/index.mjs";

package/dist/esm/api/index.mjs

@@ -1,4 +1,3 @@
 export * from "./resources/index.mjs";
 export * from "./types/index.mjs";
 export * from "./errors/index.mjs";
-export * from "./client/index.mjs";

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

@@ -0,0 +1,176 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as Pinnacle from "../../../index.mjs";
+export declare namespace Brands {
+    interface Options {
+        environment?: core.Supplier<environments.PinnacleEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        apiKey: core.Supplier<string>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional query string parameters to include in the request. */
+        queryParams?: Record<string, unknown>;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+    }
+}
+export declare class Brands {
+    protected readonly _options: Brands.Options;
+    constructor(_options: Brands.Options);
+    /**
+     * Automatically populate brand information based on partial input data you provide.
+     *
+     * @param {Pinnacle.AutofillBrandParams} request
+     * @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.brands.autofill({
+     *         additional_info: "A developer-friendly, compliant API for SMS, MMS, and RCS, built to scale real conversations.",
+     *         name: "Pinnacle",
+     *         options: {
+     *             forceReload: true
+     *         },
+     *         website: "https://www.pinnacle.sh"
+     *     })
+     */
+    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.
+     *
+     * @param {Pinnacle.UpsertBrandParams} request
+     * @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.brands.upsert({
+     *         address: "500 Folsom St, San Francisco, CA 94105",
+     *         contact: {
+     *             email: "michael.chen@trypinnacle.app",
+     *             name: "Michael Chen",
+     *             phone: "+14155551234",
+     *             title: "Customer Support Representative"
+     *         },
+     *         dba: "Pinnacle RCS",
+     *         description: "A developer-friendly, compliant API for SMS, MMS, and RCS, built to scale real conversations.",
+     *         ein: "88-1234567",
+     *         email: "founders@trypinnacle.app",
+     *         id: 1,
+     *         name: "Pinnacle",
+     *         sector: "TECHNOLOGY",
+     *         type: "PRIVATE_PROFIT",
+     *         website: "https://www.pinnacle.sh"
+     *     })
+     */
+    upsert(request?: Pinnacle.UpsertBrandParams, requestOptions?: Brands.RequestOptions): core.HttpResponsePromise<Pinnacle.ExtendedBrand>;
+    private __upsert;
+    /**
+     * Retrieve detailed information for a specific brand in your account by ID.
+     *
+     * @param {number} id - ID of an existing brand in your account that you want to retrieve.
+     * @param {Pinnacle.BrandsGetRequest} request
+     * @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.brands.get(1)
+     */
+    get(id: number, request?: Pinnacle.BrandsGetRequest, requestOptions?: Brands.RequestOptions): core.HttpResponsePromise<Pinnacle.ExtendedBrandWithVetting>;
+    private __get;
+    /**
+     * Submit your brand for review and approval by the compliance team.
+     *
+     * @param {number} brandId - The unique identifier of the brand you want to submit for review. <br>
+     *
+     *                           Must correspond to an existing brand in your account that is ready for submission.
+     * @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.PaymentRequiredError}
+     * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
+     *
+     * @example
+     *     await client.brands.submit(1)
+     */
+    submit(brandId: number, requestOptions?: Brands.RequestOptions): core.HttpResponsePromise<Pinnacle.SubmissionResults>;
+    private __submit;
+    /**
+     * Validate your brand information for compliance and correctness before submission or storage.
+     *
+     * @param {Pinnacle.ValidateBrandParams} request
+     * @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.brands.validate({
+     *         address: "500 Folsom St, San Francisco, CA 94105",
+     *         contact: {
+     *             email: "michael.chen@trypinnacle.app",
+     *             name: "Michael Chen",
+     *             phone: "+14155551234",
+     *             title: "Customer Support Representative"
+     *         },
+     *         dba: "Pinnacle Messaging",
+     *         description: "Pinnacle is an SMS, MMS, and RCS API for scaling conversations with customers you value.",
+     *         ein: "88-1234567",
+     *         email: "founders@trypinnacle.app",
+     *         name: "Pinnacle",
+     *         sector: "TECHNOLOGY",
+     *         type: "PRIVATE_PROFIT",
+     *         website: "https://www.pinnacle.sh"
+     *     })
+     */
+    validate(request: Pinnacle.ValidateBrandParams, requestOptions?: Brands.RequestOptions): core.HttpResponsePromise<Pinnacle.ValidationResults>;
+    private __validate;
+    /**
+     * Submit a brand for external vetting verification to enhance your brand's trust score and improved message delivery rates.
+     *
+     * @param {number} brandId - The unique identifier of the brand to vet. <br>
+     *
+     *                           The brand must be already registered before it can be vetted.
+     * @param {Pinnacle.VetBrandParams} request
+     * @param {Brands.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.PaymentRequiredError}
+     * @throws {@link Pinnacle.InternalServerError}
+     * @throws {@link Pinnacle.NotImplementedError}
+     *
+     * @example
+     *     await client.brands.vet(1, {})
+     */
+    vet(brandId: number, request: Pinnacle.VetBrandParams, requestOptions?: Brands.RequestOptions): core.HttpResponsePromise<Pinnacle.VettingResults>;
+    private __vet;
+    protected _getCustomAuthorizationHeaders(): Promise<{
+        "PINNACLE-API-KEY": string;
+    }>;
+}