rcs-js 1.0.22 → 2.0.0-rc.2

package/dist/cjs/api/resources/webhooks/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.Webhooks = void 0;
+const environments = __importStar(require("../../../../environments.js"));
+const core = __importStar(require("../../../../core/index.js"));
+const Pinnacle = __importStar(require("../../../index.js"));
+const headers_js_1 = require("../../../../core/headers.js");
+const errors = __importStar(require("../../../../errors/index.js"));
+class Webhooks {
+    constructor(_options) {
+        this._options = _options;
+    }
+    /**
+     * Retrieve all webhook that are set up to receive events for specific URLs or phone numbers.
+     *
+     * @param {Pinnacle.GetWebhookParams} request
+     * @param {Webhooks.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.webhooks.get({
+     *         identifiers: ["https://www.pinnacle.sh/payment", "+14155678901", "https://www.pinnacle.sh/sms-callback", "+14153456659"]
+     *     })
+     */
+    get(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__get(request, requestOptions));
+    }
+    __get(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
+            let _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, "webhooks"),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: request,
+                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 POST /webhooks.");
+                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.Webhooks = Webhooks;

package/dist/cjs/api/resources/webhooks/client/index.d.ts

@@ -0,0 +1,2 @@
+export {};
+export * from "./requests/index.js";

package/dist/cjs/api/resources/webhooks/client/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("./requests/index.js"), exports);

package/dist/cjs/api/resources/webhooks/client/requests/GetWebhookParams.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         identifiers: ["https://www.pinnacle.sh/payment", "+14155678901", "https://www.pinnacle.sh/sms-callback", "+14153456659"]
+ *     }
+ */
+export interface GetWebhookParams {
+    /** List of URLs or phone numbers in E.164 format that the webhook is attached to. */
+    identifiers: string[];
+}

package/dist/cjs/api/resources/webhooks/client/requests/index.d.ts

@@ -0,0 +1 @@
+export { type GetWebhookParams } from "./GetWebhookParams.js";

package/dist/cjs/api/resources/webhooks/client/requests/index.js

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

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

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

package/dist/cjs/api/resources/webhooks/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/AdvancedPhoneInformation.d.ts

@@ -0,0 +1,161 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+/**
+ * Detailed phone number analysis including validation status, classification with fraud risk,
+ * precise geographic data, carrier intelligence, and enhanced contact information.
+ * Provides comprehensive insights for risk assessment, compliance, and advanced usage scenarios.
+ */
+export interface AdvancedPhoneInformation {
+    /** Indicates whether the phone number is valid and capable of receiving communications. */
+    isValid: boolean;
+    /** Detailed classification including fraud risk and security recommendations. */
+    type: AdvancedPhoneInformation.Type;
+    /** Different standardized ways the phone number can be formatted for display or dialing. */
+    formats: Pinnacle.NumberFormat;
+    /**
+     * Comprehensive geographic and administrative location data with precise coordinates
+     * and timezone information for accurate localization.
+     */
+    location: AdvancedPhoneInformation.Location;
+    /** Detailed carrier information. */
+    carrier: AdvancedPhoneInformation.Carrier;
+    /** Enhanced contact information associated with the phone number. */
+    contact?: AdvancedPhoneInformation.Contact | null;
+}
+export declare namespace AdvancedPhoneInformation {
+    /**
+     * Detailed classification including fraud risk and security recommendations.
+     */
+    interface Type {
+        /** Technical classification derived from carrier intelligence systems. */
+        value: Pinnacle.DetailedPhoneNumberEnum;
+        /** Explanation of the phone number type and service */
+        description: string;
+        /**
+         * Additional technical details about the service type, billing model,
+         * and typical usage patterns for this number classification.
+         */
+        details: string;
+        /**
+         * Security recommendation based on fraud risk analysis:
+         * - `ALLOW`: Low risk, safe for normal use.
+         * - `BLOCK`: High risk, block or require additional verification.
+         * - `FLAG`: Medium risk, recommend further scrutiny or monitoring.
+         */
+        recommendation: Type.Recommendation;
+    }
+    namespace Type {
+        /**
+         * Security recommendation based on fraud risk analysis:
+         * - `ALLOW`: Low risk, safe for normal use.
+         * - `BLOCK`: High risk, block or require additional verification.
+         * - `FLAG`: Medium risk, recommend further scrutiny or monitoring.
+         */
+        type Recommendation = "ALLOW" | "BLOCK" | "FLAG";
+        const Recommendation: {
+            readonly Allow: "ALLOW";
+            readonly Block: "BLOCK";
+            readonly Flag: "FLAG";
+        };
+    }
+    /**
+     * Comprehensive geographic and administrative location data with precise coordinates
+     * and timezone information for accurate localization.
+     */
+    interface Location {
+        /** Complete country identification and metadata. */
+        country: Location.Country;
+        /** Primary city or municipality associated with the phone number. */
+        city?: string | null;
+        /**
+         * State, province, or primary administrative division code.
+         * Uses standard 2-letter abbreviations where applicable.
+         */
+        state?: string | null;
+        /** Postal or ZIP code for the phone number's registered location. */
+        zip?: string | null;
+        /**
+         * Primary Metropolitan Statistical Area (PMSA) code for US numbers.
+         * Used for demographic and market analysis purposes.
+         */
+        metroCode?: string | null;
+        /** County or secondary administrative division name. */
+        county?: string | null;
+        /** Coordinates provide the precise latitude and longitude values for the phone number’s registered location. */
+        coordinates: Location.Coordinates;
+        /** IANA timezone identifier for the number’s location. */
+        timeZone?: string | null;
+    }
+    namespace Location {
+        /**
+         * Complete country identification and metadata.
+         */
+        interface Country {
+            /** Name of the country. */
+            name: string;
+            /** Two-letter country code where the number is registered. */
+            code: string;
+            /** Three-letter country code where the number is registered. */
+            code3: string;
+        }
+        /**
+         * Coordinates provide the precise latitude and longitude values for the phone number’s registered location.
+         */
+        interface Coordinates {
+            /** Decimal degrees latitude coordinate. */
+            latitude?: number | null;
+            /** Decimal degrees longitude coordinate. */
+            longitude?: number | null;
+        }
+    }
+    /**
+     * Detailed carrier information.
+     */
+    interface Carrier {
+        /** Carrier or service provider name as registered with telecom authorities. */
+        name: string;
+        /** Standardized carrier name used across data sources. */
+        normalizedCarrier: string;
+        /**
+         * Mobile Country Code - 3-digit identifier assigned by ITU-T for the country.
+         * Used in GSM, UMTS, and LTE networks for international roaming and identification.
+         */
+        mcc: string;
+        /**
+         * Mobile Network Code - 2 or 3-digit identifier for the specific carrier within the country.
+         * Combined with MCC provides unique global identification of the mobile network.
+         */
+        mnc: string;
+    }
+    /**
+     * Enhanced contact information associated with the phone number.
+     */
+    interface Contact {
+        /** Given name of the primary contact. */
+        firstName?: string;
+        /** Family name of the primary contact. */
+        lastName?: string;
+        /** Primary email associated with the number’s registration. */
+        emailAddress?: string;
+        /** Street address including number and street name. */
+        street?: string;
+        /** Secondary address info like suite or apartment number. */
+        unit?: string;
+        /** Combined city, state, and postal info in a human-readable format. */
+        place?: string;
+        /** Postal or ZIP code of the contact’s address. */
+        zip?: string;
+        /** Full state or province name of the contact’s address. */
+        state?: string;
+        /** Full country name of the contact’s registered address. */
+        country?: string;
+        /**
+         * Collection of online profiles and social media accounts associated with the contact. <br>
+         *
+         * These are potential candidates and may be inaccurate. Always double check.
+         */
+        profiles?: Pinnacle.EnhancedContact;
+    }
+}

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

@@ -0,0 +1,17 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AdvancedPhoneInformation = void 0;
+var AdvancedPhoneInformation;
+(function (AdvancedPhoneInformation) {
+    let Type;
+    (function (Type) {
+        Type.Recommendation = {
+            Allow: "ALLOW",
+            Block: "BLOCK",
+            Flag: "FLAG",
+        };
+    })(Type = AdvancedPhoneInformation.Type || (AdvancedPhoneInformation.Type = {}));
+})(AdvancedPhoneInformation || (exports.AdvancedPhoneInformation = AdvancedPhoneInformation = {}));

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

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+/**
+ * Use this request to connect a webhook to your phone number and receive real-time event notifications.
+ * You can either attach one of your existing webhooks by providing its ID or create a new webhook by specifying its name, URL, and event type.
+ */
+export type AttachWebhookParams = 
+/**
+ * Attach a webhook you’ve already created in your account to this phone number. */
+{
+    webhookId: number;
+    event?: (Pinnacle.WebhookEventEnum | null) | undefined;
+}
+/**
+ * Create a new webhook and immediately attach it to your phone number. */
+ | {
+    name: string;
+    url: string;
+    event?: (Pinnacle.WebhookEventEnum | null) | undefined;
+};

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

@@ -0,0 +1,42 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+export interface AttachedPhoneNumberResult {
+    /** List of phone numbers. */
+    phoneNumbers: AttachedPhoneNumberResult.PhoneNumbers.Item[];
+    /** List of numbers that were not failed to be attached. */
+    failed: AttachedPhoneNumberResult.Failed.Item[];
+}
+export declare namespace AttachedPhoneNumberResult {
+    type PhoneNumbers = PhoneNumbers.Item[];
+    namespace PhoneNumbers {
+        interface Item {
+            /** Phone number (E.164 format). */
+            phoneNumber: string;
+            /** Campaign that the phone is now attached to. */
+            campaign: Item.Campaign;
+        }
+        namespace Item {
+            /**
+             * Campaign that the phone is now attached to.
+             */
+            interface Campaign {
+                /** Id of the campaign. */
+                id: number;
+                /** Campaign's name. */
+                name: string;
+                type: Pinnacle.MessagingProfileEnum;
+            }
+        }
+    }
+    type Failed = Failed.Item[];
+    namespace Failed {
+        interface Item {
+            /** Phone number (E.164 format). */
+            number: string;
+            /** Error related to why the number was not attached. */
+            error: string;
+        }
+    }
+}

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface AutofillCampaignParams {
+    /** Any additional information you want to provide. */
+    additionalInfo?: string;
+    /** Campaign ID. */
+    campaignId?: number;
+}

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

@@ -0,0 +1,104 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+export interface AutofillDlcCampaignResponse {
+    /** Whether the campaign renews automatically. */
+    autoRenew: boolean;
+    /** Brand id. */
+    brand?: number;
+    /** Unique identifier for the campaign. */
+    campaignId?: number;
+    /** Description of the campaign. */
+    description?: string;
+    /** Keyword response configuration. */
+    keywords?: AutofillDlcCampaignResponse.Keywords;
+    /** Legal documentation links. */
+    links?: AutofillDlcCampaignResponse.Links;
+    /** Describe the flow of how users will opt in to this campaign. */
+    messageFlow?: string;
+    /** Display name of the campaign. */
+    name?: string;
+    /** Campaign configuration options. */
+    options?: AutofillDlcCampaignResponse.Options;
+    /** Example messages for the campaign. */
+    sampleMessages?: string[];
+    /** Use case for the campaign. */
+    useCase?: AutofillDlcCampaignResponse.UseCase;
+}
+export declare namespace AutofillDlcCampaignResponse {
+    /**
+     * Keyword response configuration.
+     */
+    interface Keywords {
+        /** Help keyword settings. */
+        HELP?: Keywords.Help;
+        /** Opt-in keyword settings. */
+        OPT_IN?: Keywords.OptIn;
+        /** Opt-out keyword settings. */
+        OPT_OUT?: Keywords.OptOut;
+    }
+    namespace Keywords {
+        /**
+         * Help keyword settings.
+         */
+        interface Help {
+            /** Response message for help keywords. */
+            message?: string;
+            /** Keywords that trigger help response. */
+            values?: string[];
+        }
+        /**
+         * Opt-in keyword settings.
+         */
+        interface OptIn {
+            /** Response message for opt-in keywords. */
+            message: string;
+            /** Keywords that trigger opt-in. */
+            values: string[];
+        }
+        /**
+         * Opt-out keyword settings.
+         */
+        interface OptOut {
+            /** Response message for opt-out keywords. */
+            message?: string;
+            /** Keywords that trigger opt-out. */
+            values?: string[];
+        }
+    }
+    /**
+     * Legal documentation links.
+     */
+    interface Links {
+        /** Privacy policy URL. */
+        privacyPolicy?: string;
+        /** Terms of service URL. */
+        termsOfService?: string;
+    }
+    /**
+     * Campaign configuration options.
+     */
+    interface Options {
+        /** Whether the campaign uses affiliate marketing. */
+        affiliateMarketing?: boolean;
+        /** Whether the campaign is age-gated. */
+        ageGated?: boolean;
+        /** Whether the campaign involves direct lending. */
+        directLending?: boolean;
+        /** Link embedded in campaign message. */
+        embeddedLink?: string;
+        /** Whether messages include phone numbers. */
+        embeddedPhone?: boolean;
+        /** Whether the campaign uses number pooling. */
+        numberPooling?: boolean;
+    }
+    /**
+     * Use case for the campaign.
+     */
+    interface UseCase {
+        /** Sub-use case categories. */
+        sub?: Pinnacle.SubUseCaseEnum[];
+        value?: Pinnacle.DlcCampaignUseCaseEnum;
+    }
+}

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

@@ -1,6 +1,8 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export interface BadRequestErrorBody {
-    errors?: string[];
-}
+import * as Pinnacle from "../index.js";
+export type BadRequestErrorBody = 
+/**
+ * See https://zod.dev/error-formatting for more information. */
+Pinnacle.ZodError | Pinnacle.Error_;

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

@@ -0,0 +1,53 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+/**
+ * Key details about a phone number, including its validity, type, location, carrier, and contact information.
+ * Provides the essential data required for verification, display, and basic analysis.
+ */
+export interface BasicPhoneInformation {
+    /** Indicates whether the phone number is valid and capable of receiving communications. */
+    isValid: boolean;
+    /** Classification of the phone number. */
+    type: Pinnacle.PhoneNumberEnum;
+    /** Different standardized ways the phone number can be formatted for display. */
+    formats: Pinnacle.NumberFormat;
+    /** Geographic and political details where the phone number is registered. */
+    location: BasicPhoneInformation.Location;
+    /** The telecommunications carrier or service provider for the number. */
+    carrier: string;
+    /** Contact information linked to the phone number registration, if available. */
+    contact: BasicPhoneInformation.Contact;
+}
+export declare namespace BasicPhoneInformation {
+    /**
+     * Geographic and political details where the phone number is registered.
+     */
+    interface Location {
+        /** Information about the country of registration. */
+        country: Location.Country;
+        /** Location description including region, state/province, and city. */
+        place: string;
+    }
+    namespace Location {
+        /**
+         * Information about the country of registration.
+         */
+        interface Country {
+            /** Two-letter country code where the number is registered. */
+            code: string;
+            /** Full name of the country. */
+            name: string;
+            /** International dialing prefix for the country. */
+            prefix: string;
+        }
+    }
+    /**
+     * Contact information linked to the phone number registration, if available.
+     */
+    interface Contact {
+        /** Registered name associated with the phone number. */
+        name: string;
+    }
+}

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

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+/**
+ * Response for get brand status.
+ */
+export interface BrandStatus {
+    /** List of errors that occurred. */
+    errors: string[];
+    /** Id of the brand. */
+    id: number;
+    /**
+     * Current review status of the brand. <br>
+     *
+     * `INCOMPLETE`: Has not been submitted. Use the [submit endpoint](../brands/submit). <br>
+     * `PENDING`: Currently being reviewed. <br>
+     * `VERIFIED`: Verified and good to go. <br>
+     * `UNVERIFIED`: No longer verified due to an update in the brand details. Requires vetting to be reverified. <br>
+     * `VETTED`: Brand has been vetted by an external provider and has received vetting scores. <br>
+     */
+    status: Pinnacle.BrandStatusEnum;
+}