rcs-js 1.0.18 → 1.0.22

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

@@ -0,0 +1,205 @@
+"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.Tools = 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 Tools {
+    constructor(_options) {
+        this._options = _options;
+    }
+    /**
+     * Create a shortened URL with an optional expiration date (default and max expiration is 90 days). The shortened URL will redirect to the original URL and will have the following format https://urls.p1n.io/ABCD5678.
+     *
+     * @param {Pinnacle.ToolsShortenUrlRequest} request
+     * @param {Tools.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.tools.shortenUrl({
+     *         url: "https://example.com"
+     *     })
+     */
+    shortenUrl(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__shortenUrl(request, requestOptions));
+    }
+    __shortenUrl(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
+            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, "tools/urls/shorten"),
+                method: "POST",
+                headers: (0, headers_js_1.mergeHeaders)((_c = this._options) === null || _c === void 0 ? void 0 : _c.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                contentType: "application/json",
+                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 /tools/urls/shorten.");
+                case "unknown":
+                    throw new errors.PinnacleError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    /**
+     * Generate signed upload (expires in 2 hours) and download URLs for a file (expires in 1 hour).
+     *
+     * See the [Upload](/api-reference/upload) page for native Python and Typescript SDKs.
+     *
+     * @param {Pinnacle.ToolsUploadUrlRequest} request
+     * @param {Tools.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.tools.uploadUrl({
+     *         contentType: "image/png",
+     *         size: 1024,
+     *         name: "example.png"
+     *     })
+     */
+    uploadUrl(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__uploadUrl(request, requestOptions));
+    }
+    __uploadUrl(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
+            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, "tools/uploadUrl"),
+                method: "POST",
+                headers: (0, headers_js_1.mergeHeaders)((_c = this._options) === null || _c === void 0 ? void 0 : _c.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                contentType: "application/json",
+                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 /tools/uploadUrl.");
+                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.Tools = Tools;

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

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

package/dist/cjs/api/resources/tools/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/tools/client/requests/ToolsShortenUrlRequest.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         url: "https://example.com"
+ *     }
+ */
+export interface ToolsShortenUrlRequest {
+    /** The URL to be shortened. Must be a valid URL with either http or https protocol. */
+    url: string;
+    /** Optional expiration date for the shortened URL in ISO 8601 format. Default and max expiration is 90 days. */
+    expiresAt?: string;
+}

package/dist/cjs/api/resources/tools/client/requests/ToolsUploadUrlRequest.d.ts

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         contentType: "image/png",
+ *         size: 1024,
+ *         name: "example.png"
+ *     }
+ */
+export interface ToolsUploadUrlRequest {
+    /**
+     * The MIME type of the file.
+     *
+     * Supported types are audio/basic, audio/L24, audio/mp4, audio/mpeg, audio/mpg, audio/mp3, audio/ogg, audio/aac, audio/vndrn-realaudio, audio/vndwave, audio/3gpp, audio/3gpp2, audio/ac3, audio/webm, audio/amrnb, audio/amr, video/mpeg, video/mp4, video/quicktime, video/webm, video/3gpp, video/3gpp2, video/3gpptt, video/H261, video/H263, video/H2631998, video/H2632000, video/H264, video/m4v, video/mpeg4, video/webm, image/jpeg, image/gif, image/png, image/gif, image/bmp, image/tiff, image/webp, text/vcard, text/xvcard, text/csv, text/rtf, text/richtext, text/calendar, text/directory, application/ogg, application/pdf, application/vcard, application/vndapple.pkpass.
+     */
+    contentType: string;
+    /** The size of the file in bytes. Should be less than 100 MB. */
+    size: number;
+    /** The name of the file. */
+    name: string;
+}

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

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

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

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

package/dist/cjs/api/resources/tools/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("./types/index.js"), exports);
+__exportStar(require("./client/index.js"), exports);

package/dist/cjs/api/resources/tools/types/ToolsShortenUrlResponse.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ToolsShortenUrlResponse {
+    /** The shortened URL. */
+    shortenedUrl?: string;
+    /** The expiration date of the shortened URL, if provided. */
+    expiresAt?: string;
+}

package/dist/cjs/api/resources/tools/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./ToolsShortenUrlResponse.js";
+export * from "./ToolsUploadUrlResponse.js";

package/dist/cjs/api/resources/tools/types/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("./ToolsShortenUrlResponse.js"), exports);
+__exportStar(require("./ToolsUploadUrlResponse.js"), exports);

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

@@ -0,0 +1,46 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface Action {
+    /** Title of the action (must be less than 25 characters). */
+    title?: string;
+    /** Type of action for the button. 'openUrl' opens a URL, 'call' dials a phone number, 'trigger' sends the predefined payload to the webhook when pressed, 'requestUserLocation' requests the user's location, 'scheduleEvent' creates a calendar event, 'sendLocation' sends a location. */
+    type?: Action.Type;
+    /** Optional payload associated with the action. This payload encodes the respective fields for the action type and is required. For 'openUrl', the payload is the URL to open. For 'call', the payload is the phone number to dial. For 'trigger', the payload is the predefined payload to send to the webhook. */
+    payload?: string;
+    /** Optional metadata. Only used for type 'trigger' ignored for other action types. When the user presses the action, the metadata is sent to the webhook alongside the payload. */
+    metadata?: string;
+    /** Start time for events in ISO 8601 format. For example, '2022-01-01T12:00:00Z'. Required for 'scheduleEvent'. */
+    eventStartTime?: string;
+    /** End time for events in ISO 8601 format. For example, '2022-01-01T12:00:00Z'. Required for 'scheduleEvent'. */
+    eventEndTime?: string;
+    /** Event title. Required for 'scheduleEvent'. */
+    eventTitle?: string;
+    /** Optional event description. */
+    eventDescription?: string;
+    /** Latitude and longitude coordinates. Required for 'sendLocation'. */
+    latLong?: Action.LatLong;
+}
+export declare namespace Action {
+    /**
+     * Type of action for the button. 'openUrl' opens a URL, 'call' dials a phone number, 'trigger' sends the predefined payload to the webhook when pressed, 'requestUserLocation' requests the user's location, 'scheduleEvent' creates a calendar event, 'sendLocation' sends a location.
+     */
+    type Type = "openUrl" | "call" | "trigger" | "requestUserLocation" | "scheduleEvent" | "sendLocation";
+    const Type: {
+        readonly OpenUrl: "openUrl";
+        readonly Call: "call";
+        readonly Trigger: "trigger";
+        readonly RequestUserLocation: "requestUserLocation";
+        readonly ScheduleEvent: "scheduleEvent";
+        readonly SendLocation: "sendLocation";
+    };
+    /**
+     * Latitude and longitude coordinates. Required for 'sendLocation'.
+     */
+    interface LatLong {
+        /** Latitude value. */
+        lat?: number;
+        /** Longitude value. */
+        lng?: number;
+    }
+}

package/dist/cjs/api/types/Action.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.Action = void 0;
+var Action;
+(function (Action) {
+    Action.Type = {
+        OpenUrl: "openUrl",
+        Call: "call",
+        Trigger: "trigger",
+        RequestUserLocation: "requestUserLocation",
+        ScheduleEvent: "scheduleEvent",
+        SendLocation: "sendLocation",
+    };
+})(Action || (exports.Action = Action = {}));

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

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+export interface Card {
+    /** The title of the card. */
+    title: string;
+    /** Optional subtitle for the card. */
+    subtitle?: string;
+    /** Optional media URL displayed with the card. */
+    mediaUrl?: string;
+    /** Optional list of buttons on the card (max 4). */
+    buttons?: Pinnacle.Action[];
+}

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

@@ -0,0 +1,97 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+export interface Company {
+    /** The unique identifier for the company */
+    id?: number;
+    /** The date and time when the company was created */
+    createdAt?: string;
+    /** The name of the company */
+    name?: string;
+    /** The category of the company */
+    category?: Pinnacle.CompanyCategory;
+    /** The address of the company */
+    address?: string;
+    /** The Employer Identification Number (EIN) of the company */
+    ein?: string;
+    /** A description of the company */
+    description?: string;
+    /** The brand color of the company */
+    brandColor?: string;
+    /** The URL of the company's logo */
+    logoUrl?: string;
+    /** The URL of the company's hero image */
+    heroUrl?: string;
+    /** The primary website URL of the company */
+    primaryWebsiteUrl?: string;
+    /** The label for the primary website URL */
+    primaryWebsiteLabel?: string;
+    /** The primary phone number of the company */
+    primaryPhone?: string;
+    /** The label for the primary phone number */
+    primaryPhoneLabel?: string;
+    /** The primary email address of the company */
+    primaryEmail?: string;
+    /** The label for the primary email address */
+    primaryEmailLabel?: string;
+    /** The URL of the company's privacy policy */
+    privacyPolicyUrl?: string;
+    /** The URL of the company's terms of service */
+    tosUrl?: string;
+    /** The name of the point of contact */
+    pocName?: string;
+    /** The title of the point of contact */
+    pocTitle?: string;
+    /** The email address of the point of contact */
+    pocEmail?: string;
+    /** Explain how users will opt in to receive messages. */
+    optIn?: string;
+    /** Explain how users will opt out of receiving messages. */
+    optOut?: string;
+    /** Please provide the unique keywords to opt out. Each keyword should not contain spaces. */
+    optOutKeywords?: string[];
+    /** Please define what your agent will do. */
+    agentUseCase?: string;
+    /** Please provide some example messages that your agent will send. */
+    expectedAgentResponses?: string;
+    /** A list of test phone numbers */
+    testNumbers?: string[];
+    /** The approval status of the company */
+    status?: string;
+    /** A list of additional websites */
+    additionalWebsites?: Company.AdditionalWebsites.Item[];
+    /** A list of additional email addresses */
+    additionalEmails?: Company.AdditionalEmails.Item[];
+    /** A list of additional phone numbers */
+    additionalPhoneNumbers?: Company.AdditionalPhoneNumbers.Item[];
+}
+export declare namespace Company {
+    type AdditionalWebsites = AdditionalWebsites.Item[];
+    namespace AdditionalWebsites {
+        interface Item {
+            /** The URL of the additional website */
+            url?: string;
+            /** The label for the additional website */
+            label?: string;
+        }
+    }
+    type AdditionalEmails = AdditionalEmails.Item[];
+    namespace AdditionalEmails {
+        interface Item {
+            /** The additional email address */
+            email?: string;
+            /** The label for the additional email address */
+            label?: string;
+        }
+    }
+    type AdditionalPhoneNumbers = AdditionalPhoneNumbers.Item[];
+    namespace AdditionalPhoneNumbers {
+        interface Item {
+            /** The label for the additional phone number */
+            label?: string;
+            /** The additional phone number */
+            phone?: string;
+        }
+    }
+}

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

@@ -0,0 +1,20 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type CompanyCategory = "Entertainment" | "Finance" | "Food & Beverage" | "Games" | "Health" | "Misc" | "News" | "Other" | "Productivity" | "Shopping & Retail" | "Social" | "Sports" | "Travel" | "Utilities";
+export declare const CompanyCategory: {
+    readonly Entertainment: "Entertainment";
+    readonly Finance: "Finance";
+    readonly FoodBeverage: "Food & Beverage";
+    readonly Games: "Games";
+    readonly Health: "Health";
+    readonly Misc: "Misc";
+    readonly News: "News";
+    readonly Other: "Other";
+    readonly Productivity: "Productivity";
+    readonly ShoppingRetail: "Shopping & Retail";
+    readonly Social: "Social";
+    readonly Sports: "Sports";
+    readonly Travel: "Travel";
+    readonly Utilities: "Utilities";
+};

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

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+export interface CompanyDetails {
+    /** The name of the company. */
+    name: string;
+    /** The category of the company. */
+    category: Pinnacle.CompanyCategory;
+    /** The address of the company. */
+    address: string;
+    /** The EIN (Employer Identification Number) of the company. */
+    ein: string;
+    /** A description of the company. */
+    description: string;
+    /** The brand color in hex format, must pass a contrast ratio of at least 4.5:1 with white. */
+    brandColor: string;
+    /** URL of the company logo. */
+    logoUrl: string;
+    /** URL of the company's hero image. */
+    heroUrl: string;
+}

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

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+export interface InboundActionMessage {
+    messageType?: "action";
+    actionTitle: string;
+    payload?: string;
+    actionMetadata?: string;
+    from: string;
+    to: string;
+    metadata?: InboundActionMessage.Metadata;
+}
+export declare namespace InboundActionMessage {
+    interface Metadata {
+        sender?: Pinnacle.SenderMetadata;
+        message?: Pinnacle.MessageMetadata;
+    }
+}

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

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+export interface InboundLocationMessage {
+    messageType?: "location";
+    coordinates: InboundLocationMessage.Coordinates;
+    from: string;
+    to: string;
+    metadata?: InboundLocationMessage.Metadata;
+}
+export declare namespace InboundLocationMessage {
+    interface Coordinates {
+        lat: number;
+        lng: number;
+    }
+    interface Metadata {
+        sender?: Pinnacle.SenderMetadata;
+        message?: Pinnacle.MessageMetadata;
+    }
+}

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

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+export interface InboundMediaMessage {
+    messageType?: "media";
+    text?: string;
+    mediaUrls: Pinnacle.MediaPayload[];
+    from: string;
+    to: string;
+    metadata?: InboundMediaMessage.Metadata;
+}
+export declare namespace InboundMediaMessage {
+    interface Metadata {
+        sender?: Pinnacle.SenderMetadata;
+        message?: Pinnacle.MessageMetadata;
+    }
+}

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

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.js";
+export interface InboundMessage {
+    from: string;
+    to: string;
+    messageType: InboundMessage.MessageType;
+    metadata?: InboundMessage.Metadata;
+}
+export declare namespace InboundMessage {
+    type MessageType = "text" | "media" | "action" | "location";
+    const MessageType: {
+        readonly Text: "text";
+        readonly Media: "media";
+        readonly Action: "action";
+        readonly Location: "location";
+    };
+    interface Metadata {
+        sender?: Pinnacle.SenderMetadata;
+        message?: Pinnacle.MessageMetadata;
+    }
+}

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

@@ -0,0 +1,15 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InboundMessage = void 0;
+var InboundMessage;
+(function (InboundMessage) {
+    InboundMessage.MessageType = {
+        Text: "text",
+        Media: "media",
+        Action: "action",
+        Location: "location",
+    };
+})(InboundMessage || (exports.InboundMessage = InboundMessage = {}));