rcs-js 0.0.1 → 1.0.2

package/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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;
+}

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

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

package/api/types/UpdateSettingsResponse.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/Url.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface Url {
+    /** The type of action being sent */
+    actionType: "weburl";
+    /** The url to open. Maximum length is 1000 characters. */
+    payload: string;
+}

package/api/types/Url.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/ViewLocation.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index";
+export interface ViewLocation {
+    /** The type of action being sent */
+    actionType: "view_location";
+    latLng: Pinnacle.LatLng;
+    /** The name of the location */
+    label?: string;
+}

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

@@ -0,0 +1,34 @@
+export * from "./CheckRcsCapabilityResponse";
+export * from "./BadRequestErrorBody";
+export * from "./UnauthorizedErrorBody";
+export * from "./InternalServerErrorBody";
+export * from "./UpdateSettingsResponse";
+export * from "./GetAccountNumberResponse";
+export * from "./SendRequest";
+export * from "./SendResponse";
+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";

package/api/types/index.js

@@ -0,0 +1,50 @@
+"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("./CheckRcsCapabilityResponse"), exports);
+__exportStar(require("./BadRequestErrorBody"), exports);
+__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("./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);

package/core/fetcher/APIResponse.d.ts

@@ -0,0 +1,10 @@
+export declare type APIResponse<Success, Failure> = SuccessfulResponse<Success> | FailedResponse<Failure>;
+export interface SuccessfulResponse<T> {
+    ok: true;
+    body: T;
+    headers?: Record<string, any>;
+}
+export interface FailedResponse<T> {
+    ok: false;
+    error: T;
+}

package/core/fetcher/APIResponse.js

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

package/core/fetcher/Fetcher.d.ts

@@ -0,0 +1,39 @@
+import { APIResponse } from "./APIResponse";
+export declare type FetchFunction = <R = unknown>(args: Fetcher.Args) => Promise<APIResponse<R, Fetcher.Error>>;
+export declare namespace Fetcher {
+    interface Args {
+        url: string;
+        method: string;
+        contentType?: string;
+        headers?: Record<string, string | undefined>;
+        queryParameters?: Record<string, string | string[] | object | object[]>;
+        body?: unknown;
+        timeoutMs?: number;
+        maxRetries?: number;
+        withCredentials?: boolean;
+        abortSignal?: AbortSignal;
+        requestType?: "json" | "file" | "bytes";
+        responseType?: "json" | "blob" | "sse" | "streaming" | "text";
+        duplex?: "half";
+    }
+    type Error = FailedStatusCodeError | NonJsonError | TimeoutError | UnknownError;
+    interface FailedStatusCodeError {
+        reason: "status-code";
+        statusCode: number;
+        body: unknown;
+    }
+    interface NonJsonError {
+        reason: "non-json";
+        statusCode: number;
+        rawBody: string;
+    }
+    interface TimeoutError {
+        reason: "timeout";
+    }
+    interface UnknownError {
+        reason: "unknown";
+        errorMessage: string;
+    }
+}
+export declare function fetcherImpl<R = unknown>(args: Fetcher.Args): Promise<APIResponse<R, Fetcher.Error>>;
+export declare const fetcher: FetchFunction;

package/core/fetcher/Fetcher.js

@@ -0,0 +1,99 @@
+"use strict";
+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.fetcher = exports.fetcherImpl = void 0;
+const createRequestUrl_1 = require("./createRequestUrl");
+const getFetchFn_1 = require("./getFetchFn");
+const getRequestBody_1 = require("./getRequestBody");
+const getResponseBody_1 = require("./getResponseBody");
+const makeRequest_1 = require("./makeRequest");
+const requestWithRetries_1 = require("./requestWithRetries");
+function fetcherImpl(args) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const headers = {};
+        if (args.body !== undefined && args.contentType != null) {
+            headers["Content-Type"] = args.contentType;
+        }
+        if (args.headers != null) {
+            for (const [key, value] of Object.entries(args.headers)) {
+                if (value != null) {
+                    headers[key] = value;
+                }
+            }
+        }
+        const url = (0, createRequestUrl_1.createRequestUrl)(args.url, args.queryParameters);
+        let requestBody = yield (0, getRequestBody_1.getRequestBody)({
+            body: args.body,
+            type: args.requestType === "json" ? "json" : "other",
+        });
+        const fetchFn = yield (0, getFetchFn_1.getFetchFn)();
+        try {
+            const response = yield (0, requestWithRetries_1.requestWithRetries)(() => __awaiter(this, void 0, void 0, function* () {
+                return (0, makeRequest_1.makeRequest)(fetchFn, url, args.method, headers, requestBody, args.timeoutMs, args.abortSignal, args.withCredentials, args.duplex);
+            }), args.maxRetries);
+            let responseBody = yield (0, getResponseBody_1.getResponseBody)(response, args.responseType);
+            if (response.status >= 200 && response.status < 400) {
+                return {
+                    ok: true,
+                    body: responseBody,
+                    headers: response.headers,
+                };
+            }
+            else {
+                return {
+                    ok: false,
+                    error: {
+                        reason: "status-code",
+                        statusCode: response.status,
+                        body: responseBody,
+                    },
+                };
+            }
+        }
+        catch (error) {
+            if (args.abortSignal != null && args.abortSignal.aborted) {
+                return {
+                    ok: false,
+                    error: {
+                        reason: "unknown",
+                        errorMessage: "The user aborted a request",
+                    },
+                };
+            }
+            else if (error instanceof Error && error.name === "AbortError") {
+                return {
+                    ok: false,
+                    error: {
+                        reason: "timeout",
+                    },
+                };
+            }
+            else if (error instanceof Error) {
+                return {
+                    ok: false,
+                    error: {
+                        reason: "unknown",
+                        errorMessage: error.message,
+                    },
+                };
+            }
+            return {
+                ok: false,
+                error: {
+                    reason: "unknown",
+                    errorMessage: JSON.stringify(error),
+                },
+            };
+        }
+    });
+}
+exports.fetcherImpl = fetcherImpl;
+exports.fetcher = fetcherImpl;

package/core/fetcher/Supplier.d.ts

@@ -0,0 +1,4 @@
+export declare type Supplier<T> = T | Promise<T> | (() => T | Promise<T>);
+export declare const Supplier: {
+    get: <T>(supplier: Supplier<T>) => Promise<T>;
+};

package/core/fetcher/Supplier.js

@@ -0,0 +1,22 @@
+"use strict";
+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.Supplier = void 0;
+exports.Supplier = {
+    get: (supplier) => __awaiter(void 0, void 0, void 0, function* () {
+        if (typeof supplier === "function") {
+            return supplier();
+        }
+        else {
+            return supplier;
+        }
+    }),
+};

package/core/fetcher/createRequestUrl.d.ts

@@ -0,0 +1 @@
+export declare function createRequestUrl(baseUrl: string, queryParameters?: Record<string, string | string[] | object | object[]>): string;

package/core/fetcher/createRequestUrl.js

@@ -0,0 +1,13 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createRequestUrl = void 0;
+const qs_1 = __importDefault(require("qs"));
+function createRequestUrl(baseUrl, queryParameters) {
+    return Object.keys(queryParameters !== null && queryParameters !== void 0 ? queryParameters : {}).length > 0
+        ? `${baseUrl}?${qs_1.default.stringify(queryParameters, { arrayFormat: "repeat" })}`
+        : baseUrl;
+}
+exports.createRequestUrl = createRequestUrl;

package/core/fetcher/getFetchFn.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Returns a fetch function based on the runtime
+ */
+export declare function getFetchFn(): Promise<any>;

package/core/fetcher/getFetchFn.js

@@ -0,0 +1,59 @@
+"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 __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;
+};
+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.getFetchFn = void 0;
+const runtime_1 = require("../runtime");
+/**
+ * Returns a fetch function based on the runtime
+ */
+function getFetchFn() {
+    return __awaiter(this, void 0, void 0, function* () {
+        // In Node.js 18+ environments, use native fetch
+        if (runtime_1.RUNTIME.type === "node" && runtime_1.RUNTIME.parsedVersion != null && runtime_1.RUNTIME.parsedVersion >= 18) {
+            return fetch;
+        }
+        // In Node.js 18 or lower environments, the SDK always uses`node-fetch`.
+        if (runtime_1.RUNTIME.type === "node") {
+            return (yield Promise.resolve().then(() => __importStar(require("node-fetch")))).default;
+        }
+        // Otherwise the SDK uses global fetch if available,
+        // and falls back to node-fetch.
+        if (typeof fetch == "function") {
+            return fetch;
+        }
+        // Defaults to node `node-fetch` if global fetch isn't available
+        return (yield Promise.resolve().then(() => __importStar(require("node-fetch")))).default;
+    });
+}
+exports.getFetchFn = getFetchFn;

package/core/fetcher/getHeader.d.ts

@@ -0,0 +1 @@
+export declare function getHeader(headers: Record<string, any>, header: string): string | undefined;

package/core/fetcher/getHeader.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getHeader = void 0;
+function getHeader(headers, header) {
+    for (const [headerKey, headerValue] of Object.entries(headers)) {
+        if (headerKey.toLowerCase() === header.toLowerCase()) {
+            return headerValue;
+        }
+    }
+    return undefined;
+}
+exports.getHeader = getHeader;

package/core/fetcher/getRequestBody.d.ts

@@ -0,0 +1,7 @@
+export declare namespace GetRequestBody {
+    interface Args {
+        body: unknown;
+        type: "json" | "file" | "bytes" | "other";
+    }
+}
+export declare function getRequestBody({ body, type }: GetRequestBody.Args): Promise<BodyInit | undefined>;