rcs-js 0.0.1 → 1.0.2

package/dist/api/index.js

@@ -0,0 +1,19 @@
+"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"), exports);
+__exportStar(require("./errors"), exports);
+__exportStar(require("./client"), exports);

package/dist/api/types/Action.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 Action = Pinnacle.Url | Pinnacle.Call | Pinnacle.Postback | Pinnacle.ShareLocation | Pinnacle.ViewLocation;

package/dist/api/types/Action.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/BadRequestErrorBody.d.ts

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

package/dist/api/types/BadRequestErrorBody.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/BasicRcs.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index";
+export interface BasicRcs {
+    /** Phone number to send the SMS message to */
+    phoneNumber?: Pinnacle.PhoneNumber;
+    /** The type of message being sent */
+    messageType: "basic-rcs";
+    /** The content of the message */
+    message: Pinnacle.BasicRcsMessage;
+    quickReplies?: Pinnacle.Action[];
+}

package/dist/api/types/BasicRcs.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/BasicRcsMessage.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The content of the message
+ */
+export interface BasicRcsMessage {
+    /** The text content of the RCS message */
+    text: string;
+}

package/dist/api/types/BasicRcsMessage.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/Call.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface Call {
+    /** The type of action being sent */
+    actionType: "call";
+    /** The number to call in E. 164 format. Maximum length is 1000 characters. */
+    payload: string;
+}

package/dist/api/types/Call.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/Card.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index";
+export interface Card {
+    /** The title of the card */
+    title: string;
+    /** The subtitle of 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. */
+    buttons?: Pinnacle.Action[];
+    /** The style of the card */
+    cardStyle?: Pinnacle.CardStyle;
+}

package/dist/api/types/Card.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/CardRcs.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index";
+export interface CardRcs {
+    /** Phone number to send the SMS message to */
+    phoneNumber?: Pinnacle.PhoneNumber;
+    /** The type of message being sent */
+    messageType: "card";
+    /** The content of the message */
+    message: Pinnacle.CardRcsMessage;
+}

package/dist/api/types/CardRcs.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/CardRcsMessage.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index";
+/**
+ * The content of the message
+ */
+export interface CardRcsMessage {
+    /** Array of one containing the card to be sent */
+    cards: Pinnacle.Card[];
+    /** Array of quick replies attached to the card. Maximum of 11 quick replies. */
+    quickReplies?: Pinnacle.Action[];
+}

package/dist/api/types/CardRcsMessage.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/CardStyle.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index";
+export interface CardStyle {
+    /** Alignment of the image in the card. Only available for horizontal cards. */
+    imageAlignment?: Pinnacle.CardStyleImageAlignment;
+    /** Height of the media in the card. Only available for vertical cards. */
+    mediaHeight?: Pinnacle.CardStyleMediaHeight;
+    /** URL of the thumbnail image */
+    thumbnailUrl?: string;
+    /** Width of the card */
+    width?: Pinnacle.CardStyleWidth;
+    /** Orientation of the card */
+    orientation?: Pinnacle.CardStyleOrientation;
+}

package/dist/api/types/CardStyle.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/CardStyleImageAlignment.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Alignment of the image in the card. Only available for horizontal cards.
+ */
+export declare type CardStyleImageAlignment = "right" | "left";
+export declare const CardStyleImageAlignment: {
+    readonly Right: "right";
+    readonly Left: "left";
+};

package/dist/api/types/CardStyleImageAlignment.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CardStyleImageAlignment = void 0;
+exports.CardStyleImageAlignment = {
+    Right: "right",
+    Left: "left",
+};

package/dist/api/types/CardStyleMediaHeight.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Height of the media in the card. Only available for vertical cards.
+ */
+export declare type CardStyleMediaHeight = "medium" | "small" | "tall";
+export declare const CardStyleMediaHeight: {
+    readonly Medium: "medium";
+    readonly Small: "small";
+    readonly Tall: "tall";
+};

package/dist/api/types/CardStyleMediaHeight.js

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CardStyleMediaHeight = void 0;
+exports.CardStyleMediaHeight = {
+    Medium: "medium",
+    Small: "small",
+    Tall: "tall",
+};

package/dist/api/types/CardStyleOrientation.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Orientation of the card
+ */
+export declare type CardStyleOrientation = "horizontal" | "vertical";
+export declare const CardStyleOrientation: {
+    readonly Horizontal: "horizontal";
+    readonly Vertical: "vertical";
+};

package/dist/api/types/CardStyleOrientation.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CardStyleOrientation = void 0;
+exports.CardStyleOrientation = {
+    Horizontal: "horizontal",
+    Vertical: "vertical",
+};

package/dist/api/types/CardStyleWidth.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Width of the card
+ */
+export declare type CardStyleWidth = "small" | "medium";
+export declare const CardStyleWidth: {
+    readonly Small: "small";
+    readonly Medium: "medium";
+};

package/dist/api/types/CardStyleWidth.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CardStyleWidth = void 0;
+exports.CardStyleWidth = {
+    Small: "small",
+    Medium: "medium",
+};

package/dist/api/types/CarouselRcs.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index";
+export interface CarouselRcs {
+    /** Phone number to send the SMS message to */
+    phoneNumber?: Pinnacle.PhoneNumber;
+    /** The type of message being sent */
+    messageType: "carousel";
+    /** The content of the message */
+    message: Pinnacle.CarouselRcsMessage;
+}

package/dist/api/types/CarouselRcs.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/CarouselRcsMessage.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index";
+/**
+ * The content of the message
+ */
+export interface CarouselRcsMessage {
+    /** Array of cards to be sent */
+    cards: Pinnacle.Card[];
+    /** Array of quick replies attached to the card. Maximum of 11 quick replies. */
+    quickReplies?: Pinnacle.Action[];
+}

package/dist/api/types/CarouselRcsMessage.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/CheckRcsCapabilityResponse.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CheckRcsCapabilityResponse {
+    success?: boolean;
+    rcsEnabled?: boolean;
+}

package/dist/api/types/CheckRcsCapabilityResponse.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/Event.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface Event {
+    /** The type of message being sent */
+    actionType: "calendar";
+    /** The start time for the event. */
+    startTime: Date;
+    /** The end time for the event. */
+    endTime: Date;
+    /** The title of the event. */
+    eventTitle: string;
+    /** The description of the event */
+    eventDescription?: string;
+}

package/dist/api/types/Event.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/GetAccountNumberResponse.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface GetAccountNumberResponse {
+    /** The phone number associated with the account in E.164 format */
+    accountNumber?: string;
+}

package/dist/api/types/GetAccountNumberResponse.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/InternalServerErrorBody.d.ts

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

package/dist/api/types/InternalServerErrorBody.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/LatLng.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The latitude and longitude of the location to share with the user
+ */
+export interface LatLng {
+    /** The latitude of the location */
+    lat: number;
+    /** The longitude of the location */
+    lng: number;
+}

package/dist/api/types/LatLng.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/MediaRcs.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index";
+export interface MediaRcs {
+    /** Phone number to send the SMS message to */
+    phoneNumber?: Pinnacle.PhoneNumber;
+    /** The type of message being sent */
+    messageType: "media";
+    /** The content of the message */
+    message: Pinnacle.MediaRcsMessage;
+}

package/dist/api/types/MediaRcs.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/MediaRcsMessage.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index";
+/**
+ * The content of the message
+ */
+export interface MediaRcsMessage {
+    mediaType: Pinnacle.MediaType;
+    /** The URL of the media being sent */
+    mediaUrl: string;
+    /** Array of quick replies attached to the media. Maximum of 11 quick replies. */
+    quickReplies?: Pinnacle.Action[];
+}

package/dist/api/types/MediaRcsMessage.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/MediaType.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The type of media being sent
+ */
+export declare type MediaType = "text" | "image" | "video" | "audio" | "file";
+export declare const MediaType: {
+    readonly Text: "text";
+    readonly Image: "image";
+    readonly Video: "video";
+    readonly Audio: "audio";
+    readonly File: "file";
+};

package/dist/api/types/MediaType.js

@@ -0,0 +1,13 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MediaType = void 0;
+exports.MediaType = {
+    Text: "text",
+    Image: "image",
+    Video: "video",
+    Audio: "audio",
+    File: "file",
+};

package/dist/api/types/PhoneNumber.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Phone number in E.164 format: [+][country code][subscriber number including area code]
+ */
+export declare type PhoneNumber = string;

package/dist/api/types/PhoneNumber.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/Postback.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface Postback {
+    /** The type of action being sent */
+    actionType: "postback";
+    /** The postback payload. Maximum length is 1000 characters. */
+    payload: string;
+    /** The action to execute. Optional additional data sent when the button is tapped. */
+    execute?: string;
+}

package/dist/api/types/Postback.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/SendRequest.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 SendRequest = Pinnacle.CardRcs | Pinnacle.Sms | Pinnacle.BasicRcs | Pinnacle.MediaRcs | Pinnacle.CarouselRcs;

package/dist/api/types/SendRequest.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

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

package/dist/api/types/SendResponse.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/ShareLocation.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ShareLocation {
+    /** The type of action being sent */
+    actionType: "share_location";
+}

package/dist/api/types/ShareLocation.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/Sms.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index";
+export interface Sms {
+    /** Phone number to send the SMS message to */
+    phoneNumber?: Pinnacle.PhoneNumber;
+    /** The type of message being sent */
+    messageType: "sms";
+    /** The content of the message */
+    message: Pinnacle.SmsMessage;
+}

package/dist/api/types/Sms.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/SmsMessage.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The content of the message
+ */
+export interface SmsMessage {
+    /** The body of the SMS message */
+    body: string;
+    /** Optional media URL for the SMS message */
+    mediaUrl?: string;
+}

package/dist/api/types/SmsMessage.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/UnauthorizedErrorBody.d.ts

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