rcs-js 1.0.6 → 1.0.8

package/api/errors/NotFoundError.js

@@ -0,0 +1,41 @@
+"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 (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotFoundError = void 0;
+const errors = __importStar(require("../../errors/index"));
+class NotFoundError extends errors.PinnacleError {
+    constructor(body) {
+        super({
+            message: "NotFoundError",
+            statusCode: 404,
+            body: body,
+        });
+        Object.setPrototypeOf(this, NotFoundError.prototype);
+    }
+}
+exports.NotFoundError = NotFoundError;

package/api/errors/UnauthorizedError.d.ts

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

package/api/errors/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./BadRequestError";
 export * from "./UnauthorizedError";
 export * from "./InternalServerError";
+export * from "./NotFoundError";

package/api/errors/index.js

@@ -17,3 +17,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./BadRequestError"), exports);
 __exportStar(require("./UnauthorizedError"), exports);
 __exportStar(require("./InternalServerError"), exports);
+__exportStar(require("./NotFoundError"), exports);

package/api/types/AdditionalEmail.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface AdditionalEmail {
+    /** Additional email address. */
+    email: string;
+    /** Label for the additional email address. */
+    label: string;
+}

package/api/types/AdditionalPhoneNumber.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface AdditionalPhoneNumber {
+    /** Additional phone number in international format. */
+    phone: string;
+    /** Label for the additional phone number. */
+    label: string;
+}

package/api/types/AdditionalPhoneNumber.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/AdditionalWebsite.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface AdditionalWebsite {
+    /** URL of the additional website. */
+    url: string;
+    /** Label for the additional website. */
+    label: string;
+}

package/api/types/AdditionalWebsite.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/BadRequestErrorBody.d.ts

@@ -1,6 +1,8 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Pinnacle from "../index";
 export interface BadRequestErrorBody {
-    error?: string;
+    error?: Pinnacle.BadRequestErrorBodyError;
+    success?: boolean;
 }

package/api/types/BadRequestErrorBodyError.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface BadRequestErrorBodyError {
+    code?: string;
+    expected?: string;
+    received?: string;
+    path?: string[];
+    message?: string;
+}

package/api/types/BadRequestErrorBodyError.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/Company.d.ts

@@ -0,0 +1,56 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index";
+export interface Company {
+    /** The unique identifier for the company */
+    id?: number;
+    /** The date and time when the company was created */
+    createdAt?: Date;
+    /** The name of the company */
+    name?: string;
+    /** 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;
+    /** A list of test phone numbers */
+    testNumbers?: string[];
+    /** The approval status of the company */
+    status?: string;
+    /** A list of additional websites */
+    additionalWebsites?: Pinnacle.CompanyAdditionalWebsitesItem[];
+    /** A list of additional email addresses */
+    additionalEmails?: Pinnacle.CompanyAdditionalEmailsItem[];
+    /** A list of additional phone numbers */
+    additionalPhoneNumbers?: Pinnacle.CompanyAdditionalPhoneNumbersItem[];
+}

package/api/types/Company.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/CompanyAdditionalEmailsItem.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CompanyAdditionalEmailsItem {
+    /** The additional email address */
+    email?: string;
+    /** The label for the additional email address */
+    label?: string;
+}

package/api/types/CompanyAdditionalEmailsItem.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/CompanyAdditionalPhoneNumbersItem.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CompanyAdditionalPhoneNumbersItem {
+    /** The label for the additional phone number */
+    label?: string;
+    /** The additional phone number */
+    phone?: string;
+}

package/api/types/CompanyAdditionalPhoneNumbersItem.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/CompanyAdditionalWebsitesItem.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CompanyAdditionalWebsitesItem {
+    /** The URL of the additional website */
+    url?: string;
+    /** The label for the additional website */
+    label?: string;
+}

package/api/types/CompanyAdditionalWebsitesItem.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/CompanyContact.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CompanyContact {
+    /** Primary website URL. */
+    primaryWebsiteUrl: string;
+    /** Label for the primary website. */
+    primaryWebsiteLabel: string;
+    /** Primary phone number in international format. */
+    primaryPhone: string;
+    /** Label for the primary phone number. */
+    primaryPhoneLabel: string;
+    /** Primary email address. */
+    primaryEmail: string;
+    /** Label for the primary email address. */
+    primaryEmailLabel: string;
+    /** URL of the privacy policy. */
+    privacyPolicyUrl: string;
+    /** URL of the terms of service. */
+    tosUrl: string;
+}

package/api/types/CompanyContact.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/CompanyDetails.d.ts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CompanyDetails {
+    /** The name of the company. */
+    name: string;
+    /** 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/api/types/CompanyDetails.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/InternalServerErrorBody.d.ts

@@ -2,5 +2,6 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface InternalServerErrorBody {
+    success?: boolean;
     error?: string;
 }

package/api/types/NotFoundErrorBody.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface NotFoundErrorBody {
+    error?: string;
+}

package/api/types/NotFoundErrorBody.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/Optionals.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index";
+export interface Optionals {
+    /** List of additional websites, up to 2. */
+    additionalWebsites?: Pinnacle.AdditionalWebsite[];
+    /** List of additional phone numbers, up to 2. */
+    additionalPhoneNumbers?: Pinnacle.AdditionalPhoneNumber[];
+    /** List of additional email addresses, up to 2. */
+    additionalEmails?: Pinnacle.AdditionalEmail[];
+    testNumbers?: string[];
+}

package/api/types/Optionals.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/PointOfContact.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface PointOfContact {
+    /** Point of contact's name. */
+    pocName: string;
+    /** Point of contact's title. */
+    pocTitle: string;
+    /** Point of contact's email address. */
+    pocEmail: string;
+}

package/api/types/PointOfContact.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/RegisterCompanyResponse.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index";
+export interface RegisterCompanyResponse {
+    success?: boolean;
+    brand?: Pinnacle.RegisterCompanyResponseBrand;
+}

package/api/types/RegisterCompanyResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/RegisterCompanyResponseBrand.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface RegisterCompanyResponseBrand {
+    name?: string;
+    id?: number;
+}

package/api/types/RegisterCompanyResponseBrand.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/SendMessageRequest.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index";
+export declare type SendMessageRequest = Pinnacle.CardRcs | Pinnacle.Sms | Pinnacle.BasicRcs | Pinnacle.MediaRcs | Pinnacle.CarouselRcs;

package/api/types/SendMessageRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/{dist/api/types/SendResponse.d.ts → api/types/SendMessageResponse.d.ts}

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export interface SendResponse {
+export interface SendMessageResponse {
     /** Confirmation message that the message was sent successfully */
     message?: string;
 }

package/api/types/SendMessageResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/UpdateCompanyResponse.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index";
+export interface UpdateCompanyResponse {
+    success?: boolean;
+    brand?: Pinnacle.UpdateCompanyResponseBrand;
+}

package/api/types/UpdateCompanyResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/UpdateCompanyResponseBrand.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface UpdateCompanyResponseBrand {
+    name?: string;
+    id?: number;
+}

package/api/types/UpdateCompanyResponseBrand.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/index.d.ts

@@ -4,8 +4,14 @@ export * from "./UnauthorizedErrorBody";
 export * from "./InternalServerErrorBody";
 export * from "./UpdateSettingsResponse";
 export * from "./GetAccountNumberResponse";
-export * from "./SendRequest";
-export * from "./SendResponse";
+export * from "./SendMessageRequest";
+export * from "./SendMessageResponse";
+export * from "./NotFoundErrorBody";
+export * from "./RegisterCompanyResponseBrand";
+export * from "./RegisterCompanyResponse";
+export * from "./BadRequestErrorBodyError";
+export * from "./UpdateCompanyResponseBrand";
+export * from "./UpdateCompanyResponse";
 export * from "./PhoneNumber";
 export * from "./Url";
 export * from "./Call";
@@ -32,3 +38,14 @@ export * from "./CardRcsMessage";
 export * from "./CardRcs";
 export * from "./CarouselRcsMessage";
 export * from "./CarouselRcs";
+export * from "./CompanyAdditionalWebsitesItem";
+export * from "./CompanyAdditionalEmailsItem";
+export * from "./CompanyAdditionalPhoneNumbersItem";
+export * from "./Company";
+export * from "./CompanyDetails";
+export * from "./CompanyContact";
+export * from "./PointOfContact";
+export * from "./AdditionalWebsite";
+export * from "./AdditionalPhoneNumber";
+export * from "./AdditionalEmail";
+export * from "./Optionals";

package/api/types/index.js

@@ -20,8 +20,14 @@ __exportStar(require("./UnauthorizedErrorBody"), exports);
 __exportStar(require("./InternalServerErrorBody"), exports);
 __exportStar(require("./UpdateSettingsResponse"), exports);
 __exportStar(require("./GetAccountNumberResponse"), exports);
-__exportStar(require("./SendRequest"), exports);
-__exportStar(require("./SendResponse"), exports);
+__exportStar(require("./SendMessageRequest"), exports);
+__exportStar(require("./SendMessageResponse"), exports);
+__exportStar(require("./NotFoundErrorBody"), exports);
+__exportStar(require("./RegisterCompanyResponseBrand"), exports);
+__exportStar(require("./RegisterCompanyResponse"), exports);
+__exportStar(require("./BadRequestErrorBodyError"), exports);
+__exportStar(require("./UpdateCompanyResponseBrand"), exports);
+__exportStar(require("./UpdateCompanyResponse"), exports);
 __exportStar(require("./PhoneNumber"), exports);
 __exportStar(require("./Url"), exports);
 __exportStar(require("./Call"), exports);
@@ -48,3 +54,14 @@ __exportStar(require("./CardRcsMessage"), exports);
 __exportStar(require("./CardRcs"), exports);
 __exportStar(require("./CarouselRcsMessage"), exports);
 __exportStar(require("./CarouselRcs"), exports);
+__exportStar(require("./CompanyAdditionalWebsitesItem"), exports);
+__exportStar(require("./CompanyAdditionalEmailsItem"), exports);
+__exportStar(require("./CompanyAdditionalPhoneNumbersItem"), exports);
+__exportStar(require("./Company"), exports);
+__exportStar(require("./CompanyDetails"), exports);
+__exportStar(require("./CompanyContact"), exports);
+__exportStar(require("./PointOfContact"), exports);
+__exportStar(require("./AdditionalWebsite"), exports);
+__exportStar(require("./AdditionalPhoneNumber"), exports);
+__exportStar(require("./AdditionalEmail"), exports);
+__exportStar(require("./Optionals"), exports);

package/dist/Client.d.ts

@@ -68,7 +68,7 @@ export declare class PinnacleClient {
     /**
      * Send a SMS or RCS message to a phone number
      *
-     * @param {Pinnacle.SendRequest} request
+     * @param {Pinnacle.SendMessageRequest} request
      * @param {PinnacleClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -76,7 +76,7 @@ export declare class PinnacleClient {
      * @throws {@link Pinnacle.InternalServerError}
      *
      * @example
-     *     await client.send({
+     *     await client.sendMessage({
      *         phoneNumber: "phone_number",
      *         messageType: "card",
      *         message: {
@@ -86,7 +86,77 @@ export declare class PinnacleClient {
      *         }
      *     })
      */
-    send(request: Pinnacle.SendRequest, requestOptions?: PinnacleClient.RequestOptions): Promise<Pinnacle.SendResponse>;
+    sendMessage(request: Pinnacle.SendMessageRequest, requestOptions?: PinnacleClient.RequestOptions): Promise<Pinnacle.SendMessageResponse>;
+    /**
+     * Retrieve the company's information (i.e. approval status, company name, etc.). Search by company ID or company name.
+     *
+     * @param {Pinnacle.GetCompanyRequest} request
+     * @param {PinnacleClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.getCompany()
+     */
+    getCompany(request?: Pinnacle.GetCompanyRequest, requestOptions?: PinnacleClient.RequestOptions): Promise<Pinnacle.Company[]>;
+    /**
+     * Register a company for RCS with the Pinnacle platform
+     *
+     * @param {Pinnacle.RegisterCompanyRequest} request
+     * @param {PinnacleClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.registerCompany({
+     *         company: {
+     *             name: "name",
+     *             address: "address",
+     *             ein: "ein",
+     *             description: "description",
+     *             brandColor: "brandColor",
+     *             logoUrl: "logoUrl",
+     *             heroUrl: "heroUrl"
+     *         },
+     *         companyContact: {
+     *             primaryWebsiteUrl: "primaryWebsiteUrl",
+     *             primaryWebsiteLabel: "primaryWebsiteLabel",
+     *             primaryPhone: "primaryPhone",
+     *             primaryPhoneLabel: "primaryPhoneLabel",
+     *             primaryEmail: "primaryEmail",
+     *             primaryEmailLabel: "primaryEmailLabel",
+     *             privacyPolicyUrl: "privacyPolicyUrl",
+     *             tosUrl: "tosUrl"
+     *         },
+     *         pointOfContact: {
+     *             pocName: "pocName",
+     *             pocTitle: "pocTitle",
+     *             pocEmail: "pocEmail"
+     *         }
+     *     })
+     */
+    registerCompany(request: Pinnacle.RegisterCompanyRequest, requestOptions?: PinnacleClient.RequestOptions): Promise<Pinnacle.RegisterCompanyResponse>;
+    /**
+     * Update a company on the Pinnacle platform
+     *
+     * @param {Pinnacle.UpdateCompanyRequest} request
+     * @param {PinnacleClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.updateCompany({
+     *         companyId: "companyId"
+     *     })
+     */
+    updateCompany(request: Pinnacle.UpdateCompanyRequest, requestOptions?: PinnacleClient.RequestOptions): Promise<Pinnacle.UpdateCompanyResponse>;
     protected _getCustomAuthorizationHeaders(): Promise<{
         "PINNACLE-API-Key": string;
     }>;