rcs-js 1.0.8 → 1.0.10

package/api/types/Action.d.ts

@@ -2,4 +2,23 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Pinnacle from "../index";
-export declare type Action = Pinnacle.Url | Pinnacle.Call | Pinnacle.Postback | Pinnacle.ShareLocation | Pinnacle.ViewLocation;
+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, 'requestLocation' requests the user's location, 'scheduleEvent' creates a calendar event, 'sendLocation' sends a location. */
+    type?: Pinnacle.ActionType;
+    /** 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. This is sent alongside the payload to the webhook. */
+    metadata?: string;
+    /** Start time for events. Required for 'scheduleEvent'. */
+    eventStartTime?: string;
+    /** End time for events. 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?: Pinnacle.ActionLatLong;
+}

package/api/types/ActionLatLong.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Latitude and longitude coordinates. Required for 'sendLocation'.
+ */
+export interface ActionLatLong {
+    /** Latitude value. */
+    lat?: number;
+    /** Longitude value. */
+    lng?: number;
+}

package/api/types/ActionType.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * 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, 'requestLocation' requests the user's location, 'scheduleEvent' creates a calendar event, 'sendLocation' sends a location.
+ */
+export declare type ActionType = "openUrl" | "call" | "trigger" | "requestLocation" | "scheduleEvent" | "sendLocation";
+export declare const ActionType: {
+    readonly OpenUrl: "openUrl";
+    readonly Call: "call";
+    readonly Trigger: "trigger";
+    readonly RequestLocation: "requestLocation";
+    readonly ScheduleEvent: "scheduleEvent";
+    readonly SendLocation: "sendLocation";
+};

package/api/types/ActionType.js

@@ -0,0 +1,14 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActionType = void 0;
+exports.ActionType = {
+    OpenUrl: "openUrl",
+    Call: "call",
+    Trigger: "trigger",
+    RequestLocation: "requestLocation",
+    ScheduleEvent: "scheduleEvent",
+    SendLocation: "sendLocation",
+};

package/api/types/BadRequestErrorBody.d.ts

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

package/api/types/Card.d.ts

@@ -3,14 +3,12 @@
  */
 import * as Pinnacle from "../index";
 export interface Card {
-    /** The title of the card */
+    /** The title of the card. */
     title: string;
-    /** The subtitle of the card */
+    /** Optional subtitle for the card. */
     subtitle?: string;
-    /** The URL of the image to be displayed on the card */
-    imageUrl?: string;
-    /** Array of buttons attached to the card. Maximum of 4 buttons. */
+    /** Optional media URL displayed with the card. */
+    mediaUrl?: string;
+    /** Optional list of buttons on the card (max 4). */
     buttons?: Pinnacle.Action[];
-    /** The style of the card */
-    cardStyle?: Pinnacle.CardStyle;
 }

package/api/types/{NotFoundErrorBody.d.ts → ForbiddenErrorBody.d.ts}

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

package/api/types/InternalServerErrorBody.d.ts

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

package/api/types/RcsFunctionalities.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface RcsFunctionalities {
+    /** Indicates if RCS is enabled. */
+    isEnabled: boolean;
+    /** Indicates if standalone rich cards are supported. */
+    standaloneRichCard: boolean;
+    /** Indicates if carousel rich cards are supported. */
+    carouselRichCard: boolean;
+    /** Indicates if buttons to create a calendar event are supported. */
+    createCalendarEventAction: boolean;
+    /** Indicates if dial buttons are supported. */
+    dialAction: boolean;
+    /** Indicates if open URL buttons are supported. */
+    openUrlAction: boolean;
+    /** Indicates if share location buttons are supported. */
+    shareLocationAction: boolean;
+    /** Indicates if view location buttons are supported. */
+    viewLocationAction: boolean;
+}

package/api/types/UnauthorizedErrorBody.d.ts

@@ -2,5 +2,5 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface UnauthorizedErrorBody {
-    error?: string;
+    errors?: string[];
 }

package/api/types/index.d.ts

@@ -1,43 +1,8 @@
-export * from "./CheckRcsCapabilityResponse";
 export * from "./BadRequestErrorBody";
 export * from "./UnauthorizedErrorBody";
 export * from "./InternalServerErrorBody";
-export * from "./UpdateSettingsResponse";
-export * from "./GetAccountNumberResponse";
-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";
-export * from "./Postback";
-export * from "./ShareLocation";
-export * from "./LatLng";
-export * from "./ViewLocation";
-export * from "./Event";
-export * from "./Action";
-export * from "./SmsMessage";
-export * from "./Sms";
-export * from "./BasicRcsMessage";
-export * from "./BasicRcs";
-export * from "./MediaType";
-export * from "./MediaRcsMessage";
-export * from "./MediaRcs";
-export * from "./CardStyleImageAlignment";
-export * from "./CardStyleMediaHeight";
-export * from "./CardStyleWidth";
-export * from "./CardStyleOrientation";
-export * from "./CardStyle";
-export * from "./Card";
-export * from "./CardRcsMessage";
-export * from "./CardRcs";
-export * from "./CarouselRcsMessage";
-export * from "./CarouselRcs";
+export * from "./ForbiddenErrorBody";
+export * from "./RcsFunctionalities";
 export * from "./CompanyAdditionalWebsitesItem";
 export * from "./CompanyAdditionalEmailsItem";
 export * from "./CompanyAdditionalPhoneNumbersItem";
@@ -49,3 +14,7 @@ export * from "./AdditionalWebsite";
 export * from "./AdditionalPhoneNumber";
 export * from "./AdditionalEmail";
 export * from "./Optionals";
+export * from "./Card";
+export * from "./ActionType";
+export * from "./ActionLatLong";
+export * from "./Action";

package/api/types/index.js

@@ -14,46 +14,11 @@ 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("./CheckRcsCapabilityResponse"), exports);
 __exportStar(require("./BadRequestErrorBody"), exports);
 __exportStar(require("./UnauthorizedErrorBody"), exports);
 __exportStar(require("./InternalServerErrorBody"), exports);
-__exportStar(require("./UpdateSettingsResponse"), exports);
-__exportStar(require("./GetAccountNumberResponse"), 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);
-__exportStar(require("./Postback"), exports);
-__exportStar(require("./ShareLocation"), exports);
-__exportStar(require("./LatLng"), exports);
-__exportStar(require("./ViewLocation"), exports);
-__exportStar(require("./Event"), exports);
-__exportStar(require("./Action"), exports);
-__exportStar(require("./SmsMessage"), exports);
-__exportStar(require("./Sms"), exports);
-__exportStar(require("./BasicRcsMessage"), exports);
-__exportStar(require("./BasicRcs"), exports);
-__exportStar(require("./MediaType"), exports);
-__exportStar(require("./MediaRcsMessage"), exports);
-__exportStar(require("./MediaRcs"), exports);
-__exportStar(require("./CardStyleImageAlignment"), exports);
-__exportStar(require("./CardStyleMediaHeight"), exports);
-__exportStar(require("./CardStyleWidth"), exports);
-__exportStar(require("./CardStyleOrientation"), exports);
-__exportStar(require("./CardStyle"), exports);
-__exportStar(require("./Card"), exports);
-__exportStar(require("./CardRcsMessage"), exports);
-__exportStar(require("./CardRcs"), exports);
-__exportStar(require("./CarouselRcsMessage"), exports);
-__exportStar(require("./CarouselRcs"), exports);
+__exportStar(require("./ForbiddenErrorBody"), exports);
+__exportStar(require("./RcsFunctionalities"), exports);
 __exportStar(require("./CompanyAdditionalWebsitesItem"), exports);
 __exportStar(require("./CompanyAdditionalEmailsItem"), exports);
 __exportStar(require("./CompanyAdditionalPhoneNumbersItem"), exports);
@@ -65,3 +30,7 @@ __exportStar(require("./AdditionalWebsite"), exports);
 __exportStar(require("./AdditionalPhoneNumber"), exports);
 __exportStar(require("./AdditionalEmail"), exports);
 __exportStar(require("./Optionals"), exports);
+__exportStar(require("./Card"), exports);
+__exportStar(require("./ActionType"), exports);
+__exportStar(require("./ActionLatLong"), exports);
+__exportStar(require("./Action"), exports);

package/dist/Client.d.ts

@@ -4,6 +4,8 @@
 import * as environments from "./environments";
 import * as core from "./core";
 import * as Pinnacle from "./api/index";
+import { Company } from "./api/resources/company/client/Client";
+import { Send } from "./api/resources/send/client/Client";
 export declare namespace PinnacleClient {
     interface Options {
         environment?: core.Supplier<environments.PinnacleEnvironment | string>;
@@ -22,9 +24,9 @@ export declare class PinnacleClient {
     protected readonly _options: PinnacleClient.Options;
     constructor(_options: PinnacleClient.Options);
     /**
-     * Checks if a phone number is able to receive RCS
+     * 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.CheckRcsCapabilityRequest} request
+     * @param {Pinnacle.GetRcsFunctionalityRequest} request
      * @param {PinnacleClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Pinnacle.BadRequestError}
@@ -32,131 +34,13 @@ export declare class PinnacleClient {
      * @throws {@link Pinnacle.InternalServerError}
      *
      * @example
-     *     await client.checkRcsCapability({
-     *         phoneNumber: "phone_number"
-     *     })
+     *     await client.getRcsFunctionality()
      */
-    checkRcsCapability(request: Pinnacle.CheckRcsCapabilityRequest, requestOptions?: PinnacleClient.RequestOptions): Promise<Pinnacle.CheckRcsCapabilityResponse>;
-    /**
-     * Initializes settings related to RCS messaging, including webhook registration.
-     *
-     * @param {Pinnacle.UpdateSettingsRequest} request
-     * @param {PinnacleClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Pinnacle.BadRequestError}
-     * @throws {@link Pinnacle.UnauthorizedError}
-     * @throws {@link Pinnacle.InternalServerError}
-     *
-     * @example
-     *     await client.updateSettings({
-     *         webhookUrl: "webhook_url"
-     *     })
-     */
-    updateSettings(request: Pinnacle.UpdateSettingsRequest, requestOptions?: PinnacleClient.RequestOptions): Promise<Pinnacle.UpdateSettingsResponse>;
-    /**
-     * Retrieve the phone number associated with the account.
-     *
-     * @param {PinnacleClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Pinnacle.UnauthorizedError}
-     * @throws {@link Pinnacle.InternalServerError}
-     *
-     * @example
-     *     await client.getAccountNumber()
-     */
-    getAccountNumber(requestOptions?: PinnacleClient.RequestOptions): Promise<Pinnacle.GetAccountNumberResponse>;
-    /**
-     * Send a SMS or RCS message to a phone number
-     *
-     * @param {Pinnacle.SendMessageRequest} request
-     * @param {PinnacleClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Pinnacle.BadRequestError}
-     * @throws {@link Pinnacle.UnauthorizedError}
-     * @throws {@link Pinnacle.InternalServerError}
-     *
-     * @example
-     *     await client.sendMessage({
-     *         phoneNumber: "phone_number",
-     *         messageType: "card",
-     *         message: {
-     *             cards: [{
-     *                     title: "title"
-     *                 }]
-     *         }
-     *     })
-     */
-    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>;
+    getRcsFunctionality(request?: Pinnacle.GetRcsFunctionalityRequest, requestOptions?: PinnacleClient.RequestOptions): Promise<Pinnacle.RcsFunctionalities>;
+    protected _company: Company | undefined;
+    get company(): Company;
+    protected _send: Send | undefined;
+    get send(): Send;
     protected _getCustomAuthorizationHeaders(): Promise<{
         "PINNACLE-API-Key": string;
     }>;