rcs-js 1.0.22 → 2.0.0-rc.2

package/dist/esm/api/resources/contacts/client/Client.d.mts

@@ -0,0 +1,90 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as Pinnacle from "../../../index.mjs";
+export declare namespace Contacts {
+    interface Options {
+        environment?: core.Supplier<environments.PinnacleEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        apiKey: core.Supplier<string>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional query string parameters to include in the request. */
+        queryParams?: Record<string, unknown>;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+    }
+}
+export declare class Contacts {
+    protected readonly _options: Contacts.Options;
+    constructor(_options: Contacts.Options);
+    /**
+     * Retrieve contact information for a given number.
+     *
+     * @param {Pinnacle.ContactsGetRequest} request
+     * @param {Contacts.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.contacts.get()
+     */
+    get(request?: Pinnacle.ContactsGetRequest, requestOptions?: Contacts.RequestOptions): core.HttpResponsePromise<Pinnacle.Contact>;
+    private __get;
+    /**
+     * Create a new contact for a given phone number.
+     *
+     * @param {Pinnacle.CreateContactParams} request
+     * @param {Contacts.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.contacts.create({
+     *         phoneNumber: "phoneNumber"
+     *     })
+     */
+    create(request: Pinnacle.CreateContactParams, requestOptions?: Contacts.RequestOptions): core.HttpResponsePromise<Pinnacle.ContactId>;
+    private __create;
+    /**
+     * Update an existing contact.
+     *
+     * @param {Pinnacle.UpdateContactParams} request
+     * @param {Contacts.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.contacts.update({
+     *         description: "Retired",
+     *         email: "alvaroopedtech@pinnacle.sh",
+     *         name: "Retired Bestie",
+     *         tags: ["friend"],
+     *         id: 137
+     *     })
+     */
+    update(request: Pinnacle.UpdateContactParams, requestOptions?: Contacts.RequestOptions): core.HttpResponsePromise<Pinnacle.UpdatedContactId>;
+    private __update;
+    protected _getCustomAuthorizationHeaders(): Promise<{
+        "PINNACLE-API-KEY": string;
+    }>;
+}

package/dist/esm/api/resources/contacts/client/Client.mjs

@@ -0,0 +1,251 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+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());
+    });
+};
+import * as environments from "../../../../environments.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as Pinnacle from "../../../index.mjs";
+import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../core/headers.mjs";
+import * as errors from "../../../../errors/index.mjs";
+export class Contacts {
+    constructor(_options) {
+        this._options = _options;
+    }
+    /**
+     * Retrieve contact information for a given number.
+     *
+     * @param {Pinnacle.ContactsGetRequest} request
+     * @param {Contacts.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.contacts.get()
+     */
+    get(request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__get(request, requestOptions));
+    }
+    __get() {
+        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
+            var _a, _b, _c, _d;
+            const { id, phoneNumber } = request;
+            const _queryParams = {};
+            if (id !== undefined) {
+                _queryParams["id"] = (_a = id === null || id === void 0 ? void 0 : id.toString()) !== null && _a !== void 0 ? _a : null;
+            }
+            if (phoneNumber !== undefined) {
+                _queryParams["phoneNumber"] = phoneNumber;
+            }
+            let _headers = mergeHeaders((_b = this._options) === null || _b === void 0 ? void 0 : _b.headers, mergeOnlyDefinedHeaders(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.PinnacleEnvironment.Default, "contacts"),
+                method: "GET",
+                headers: _headers,
+                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
+                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 404:
+                        throw new Pinnacle.NotFoundError(_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 GET /contacts.");
+                case "unknown":
+                    throw new errors.PinnacleError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    /**
+     * Create a new contact for a given phone number.
+     *
+     * @param {Pinnacle.CreateContactParams} request
+     * @param {Contacts.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.contacts.create({
+     *         phoneNumber: "phoneNumber"
+     *     })
+     */
+    create(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__create(request, requestOptions));
+    }
+    __create(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
+            let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PinnacleEnvironment.Default, "contacts"),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                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 /contacts.");
+                case "unknown":
+                    throw new errors.PinnacleError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    /**
+     * Update an existing contact.
+     *
+     * @param {Pinnacle.UpdateContactParams} request
+     * @param {Contacts.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.contacts.update({
+     *         description: "Retired",
+     *         email: "alvaroopedtech@pinnacle.sh",
+     *         name: "Retired Bestie",
+     *         tags: ["friend"],
+     *         id: 137
+     *     })
+     */
+    update(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__update(request, requestOptions));
+    }
+    __update(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
+            let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PinnacleEnvironment.Default, "contacts"),
+                method: "PUT",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                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 404:
+                        throw new Pinnacle.NotFoundError(_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 PUT /contacts.");
+                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 };
+        });
+    }
+}

package/dist/esm/api/resources/contacts/client/index.d.mts

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

package/dist/esm/api/resources/contacts/client/index.mjs

@@ -0,0 +1 @@
+export * from "./requests/index.mjs";

package/dist/esm/api/resources/contacts/client/requests/ContactsGetRequest.d.mts

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {}
+ */
+export interface ContactsGetRequest {
+    /**
+     * Unique identifier of a specific contact you want to retrieve. <br>
+     *
+     * Either this parameter or `phoneNumber` must be provided, but not both.
+     */
+    id?: number | null;
+    /** Phone number you want to look up contact information for, provided in URL-encoded E.164 format with %2B prefix instead of +. */
+    phoneNumber?: string | null;
+}

package/dist/esm/api/resources/contacts/client/requests/CreateContactParams.d.mts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         phoneNumber: "phoneNumber"
+ *     }
+ */
+export interface CreateContactParams extends Pinnacle.OptionalContact {
+    /** Phone number to save for your contact, in E.164 format. */
+    phoneNumber: string;
+}

package/dist/esm/api/resources/contacts/client/requests/UpdateContactParams.d.mts

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         description: "Retired",
+ *         email: "alvaroopedtech@pinnacle.sh",
+ *         name: "Retired Bestie",
+ *         tags: ["friend"],
+ *         id: 137
+ *     }
+ */
+export interface UpdateContactParams extends Pinnacle.OptionalContact {
+    /** ID of the contact you want to update. */
+    id: number;
+}

package/dist/esm/api/resources/contacts/client/requests/index.d.mts

@@ -0,0 +1,3 @@
+export { type ContactsGetRequest } from "./ContactsGetRequest.mjs";
+export { type CreateContactParams } from "./CreateContactParams.mjs";
+export { type UpdateContactParams } from "./UpdateContactParams.mjs";

package/dist/esm/api/resources/contacts/client/requests/index.mjs

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/resources/contacts/index.d.mts

@@ -0,0 +1 @@
+export * from "./client/index.mjs";

package/dist/esm/api/resources/contacts/index.mjs

@@ -0,0 +1 @@
+export * from "./client/index.mjs";

package/dist/esm/api/resources/conversations/client/Client.d.mts

@@ -0,0 +1,93 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as Pinnacle from "../../../index.mjs";
+export declare namespace Conversations {
+    interface Options {
+        environment?: core.Supplier<environments.PinnacleEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        apiKey: core.Supplier<string>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional query string parameters to include in the request. */
+        queryParams?: Record<string, unknown>;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+    }
+}
+export declare class Conversations {
+    protected readonly _options: Conversations.Options;
+    constructor(_options: Conversations.Options);
+    /**
+     * Fetch a specific conversation using either its unique identifier or by matching sender and recipient details.
+     *
+     * @param {Pinnacle.GetConversationParams} request
+     * @param {Conversations.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.conversations.get({
+     *         id: 1
+     *     })
+     */
+    get(request: Pinnacle.GetConversationParams, requestOptions?: Conversations.RequestOptions): core.HttpResponsePromise<(Pinnacle.Conversation | null) | undefined>;
+    private __get;
+    /**
+     * Retrieves conversations by page with optional filtering based off provided parameters.
+     *
+     * @param {Pinnacle.ListConversationsParams} request
+     * @param {Conversations.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.conversations.list({
+     *         brandId: 101,
+     *         campaignId: 136,
+     *         campaignType: "TOLL_FREE",
+     *         pageIndex: 0,
+     *         pageSize: 20,
+     *         receiver: "+16509231662",
+     *         sender: "+18445551234"
+     *     })
+     */
+    list(request: Pinnacle.ListConversationsParams, requestOptions?: Conversations.RequestOptions): core.HttpResponsePromise<Pinnacle.ConversationList>;
+    private __list;
+    /**
+     * Update the notes associated with a specific conversation.
+     *
+     * @param {Pinnacle.UpdateConversationParams} request
+     * @param {Conversations.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.conversations.update({
+     *         id: 123,
+     *         notes: "Follow-up completed. Customer satisfied with resolution."
+     *     })
+     */
+    update(request: Pinnacle.UpdateConversationParams, requestOptions?: Conversations.RequestOptions): core.HttpResponsePromise<Pinnacle.SuccessfulConversationUpdate>;
+    private __update;
+    protected _getCustomAuthorizationHeaders(): Promise<{
+        "PINNACLE-API-KEY": string;
+    }>;
+}