rcs-js 1.0.22 → 2.0.0-rc.10

package/README.md

@@ -19,8 +19,13 @@ Instantiate and use the client with the following:
 import { PinnacleClient } from "rcs-js";
 
 const client = new PinnacleClient({ apiKey: "YOUR_API_KEY" });
-await client.company.register({
-    companyId: "companyId",
+await client.brands.autofill({
+    additional_info: "A developer-friendly, compliant API for SMS, MMS, and RCS, built to scale real conversations.",
+    name: "Pinnacle",
+    options: {
+        forceReload: true,
+    },
+    website: "https://www.pinnacle.sh",
 });
 ```
 
@@ -32,7 +37,7 @@ following namespace:
 ```typescript
 import { Pinnacle } from "rcs-js";
 
-const request: Pinnacle.CompanyGetRequest = {
+const request: Pinnacle.AutofillBrandParams = {
     ...
 };
 ```
@@ -46,7 +51,7 @@ will be thrown.
 import { PinnacleError } from "rcs-js";
 
 try {
-    await client.company.register(...);
+    await client.brands.autofill(...);
 } catch (err) {
     if (err instanceof PinnacleError) {
         console.log(err.statusCode);
@@ -64,13 +69,25 @@ try {
 If you would like to send additional headers as part of the request, use the `headers` request option.
 
 ```typescript
-const response = await client.company.register(..., {
+const response = await client.brands.autofill(..., {
     headers: {
         'X-Custom-Header': 'custom value'
     }
 });
 ```
 
+### Additional Query String Parameters
+
+If you would like to send additional query string parameters as part of the request, use the `queryParams` request option.
+
+```typescript
+const response = await client.brands.autofill(..., {
+    queryParams: {
+        'customQueryParamKey': 'custom query param value'
+    }
+});
+```
+
 ### Retries
 
 The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
@@ -86,7 +103,7 @@ A request is deemed retryable when any of the following HTTP status codes is ret
 Use the `maxRetries` request option to configure this behavior.
 
 ```typescript
-const response = await client.company.register(..., {
+const response = await client.brands.autofill(..., {
     maxRetries: 0 // override maxRetries at the request level
 });
 ```
@@ -96,7 +113,7 @@ const response = await client.company.register(..., {
 The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
 
 ```typescript
-const response = await client.company.register(..., {
+const response = await client.brands.autofill(..., {
     timeoutInSeconds: 30 // override timeout to 30s
 });
 ```
@@ -107,7 +124,7 @@ The SDK allows users to abort requests at any point by passing in an abort signa
 
 ```typescript
 const controller = new AbortController();
-const response = await client.company.register(..., {
+const response = await client.brands.autofill(..., {
     abortSignal: controller.signal
 });
 controller.abort(); // aborts the request
@@ -119,7 +136,7 @@ The SDK provides access to raw response data, including headers, through the `.w
 The `.withRawResponse()` method returns a promise that results to an object with a `data` and a `rawResponse` property.
 
 ```typescript
-const { data, rawResponse } = await client.company.register(...).withRawResponse();
+const { data, rawResponse } = await client.brands.autofill(...).withRawResponse();
 
 console.log(data);
 console.log(rawResponse.headers['X-My-Header']);
@@ -127,8 +144,7 @@ console.log(rawResponse.headers['X-My-Header']);
 
 ### Runtime Compatibility
 
-The SDK defaults to `node-fetch` but will use the global fetch client if present. The SDK works in the following
-runtimes:
+The SDK works in the following runtimes:
 
 - Node.js 18+
 - Vercel

package/dist/cjs/Client.d.ts

@@ -3,9 +3,14 @@
  */
 import * as environments from "./environments.js";
 import * as core from "./core/index.js";
-import * as Pinnacle from "./api/index.js";
-import { Company } from "./api/resources/company/client/Client.js";
-import { Send } from "./api/resources/send/client/Client.js";
+import { Brands } from "./api/resources/brands/client/Client.js";
+import { Contacts } from "./api/resources/contacts/client/Client.js";
+import { Conversations } from "./api/resources/conversations/client/Client.js";
+import { Messages } from "./api/resources/messages/client/Client.js";
+import { PhoneNumbers } from "./api/resources/phoneNumbers/client/Client.js";
+import { Webhooks } from "./api/resources/webhooks/client/Client.js";
+import { Campaigns } from "./api/resources/campaigns/client/Client.js";
+import { Status } from "./api/resources/status/client/Client.js";
 import { Tools } from "./api/resources/tools/client/Client.js";
 export declare namespace PinnacleClient {
     interface Options {
@@ -14,7 +19,7 @@ export declare namespace PinnacleClient {
         baseUrl?: core.Supplier<string>;
         apiKey: core.Supplier<string>;
         /** Additional headers to include in requests. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
     interface RequestOptions {
         /** The maximum time to wait for a response in seconds. */
@@ -23,35 +28,31 @@ export declare namespace PinnacleClient {
         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 | undefined> | undefined>;
+        headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     }
 }
 export declare class PinnacleClient {
     protected readonly _options: PinnacleClient.Options;
-    protected _company: Company | undefined;
-    protected _send: Send | undefined;
+    protected _brands: Brands | undefined;
+    protected _contacts: Contacts | undefined;
+    protected _conversations: Conversations | undefined;
+    protected _messages: Messages | undefined;
+    protected _phoneNumbers: PhoneNumbers | undefined;
+    protected _webhooks: Webhooks | undefined;
+    protected _campaigns: Campaigns | undefined;
+    protected _status: Status | undefined;
     protected _tools: Tools | undefined;
     constructor(_options: PinnacleClient.Options);
-    get company(): Company;
-    get send(): Send;
+    get brands(): Brands;
+    get contacts(): Contacts;
+    get conversations(): Conversations;
+    get messages(): Messages;
+    get phoneNumbers(): PhoneNumbers;
+    get webhooks(): Webhooks;
+    get campaigns(): Campaigns;
+    get status(): Status;
     get tools(): Tools;
-    /**
-     * 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.GetRcsFunctionalityRequest} request
-     * @param {PinnacleClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Pinnacle.BadRequestError}
-     * @throws {@link Pinnacle.UnauthorizedError}
-     * @throws {@link Pinnacle.InternalServerError}
-     *
-     * @example
-     *     await client.getRcsFunctionality()
-     */
-    getRcsFunctionality(request?: Pinnacle.GetRcsFunctionalityRequest, requestOptions?: PinnacleClient.RequestOptions): core.HttpResponsePromise<Pinnacle.RcsFunctionalities>;
-    private __getRcsFunctionality;
-    protected _getCustomAuthorizationHeaders(): Promise<{
-        "PINNACLE-API-Key": string;
-    }>;
 }

package/dist/cjs/Client.js

@@ -35,122 +35,65 @@ var __importStar = (this && this.__importStar) || (function () {
         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.PinnacleClient = void 0;
-const environments = __importStar(require("./environments.js"));
 const core = __importStar(require("./core/index.js"));
 const headers_js_1 = require("./core/headers.js");
-const Pinnacle = __importStar(require("./api/index.js"));
-const errors = __importStar(require("./errors/index.js"));
-const Client_js_1 = require("./api/resources/company/client/Client.js");
-const Client_js_2 = require("./api/resources/send/client/Client.js");
-const Client_js_3 = require("./api/resources/tools/client/Client.js");
+const Client_js_1 = require("./api/resources/brands/client/Client.js");
+const Client_js_2 = require("./api/resources/contacts/client/Client.js");
+const Client_js_3 = require("./api/resources/conversations/client/Client.js");
+const Client_js_4 = require("./api/resources/messages/client/Client.js");
+const Client_js_5 = require("./api/resources/phoneNumbers/client/Client.js");
+const Client_js_6 = require("./api/resources/webhooks/client/Client.js");
+const Client_js_7 = require("./api/resources/campaigns/client/Client.js");
+const Client_js_8 = require("./api/resources/status/client/Client.js");
+const Client_js_9 = require("./api/resources/tools/client/Client.js");
 class PinnacleClient {
     constructor(_options) {
         this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "rcs-js",
-                "X-Fern-SDK-Version": "1.0.22",
-                "User-Agent": "rcs-js/1.0.22",
+                "X-Fern-SDK-Version": "2.0.0-rc.10",
+                "User-Agent": "rcs-js/2.0.0-rc.10",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });
     }
-    get company() {
+    get brands() {
         var _a;
-        return ((_a = this._company) !== null && _a !== void 0 ? _a : (this._company = new Client_js_1.Company(this._options)));
+        return ((_a = this._brands) !== null && _a !== void 0 ? _a : (this._brands = new Client_js_1.Brands(this._options)));
     }
-    get send() {
+    get contacts() {
         var _a;
-        return ((_a = this._send) !== null && _a !== void 0 ? _a : (this._send = new Client_js_2.Send(this._options)));
+        return ((_a = this._contacts) !== null && _a !== void 0 ? _a : (this._contacts = new Client_js_2.Contacts(this._options)));
     }
-    get tools() {
+    get conversations() {
+        var _a;
+        return ((_a = this._conversations) !== null && _a !== void 0 ? _a : (this._conversations = new Client_js_3.Conversations(this._options)));
+    }
+    get messages() {
         var _a;
-        return ((_a = this._tools) !== null && _a !== void 0 ? _a : (this._tools = new Client_js_3.Tools(this._options)));
+        return ((_a = this._messages) !== null && _a !== void 0 ? _a : (this._messages = new Client_js_4.Messages(this._options)));
     }
-    /**
-     * 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.GetRcsFunctionalityRequest} request
-     * @param {PinnacleClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Pinnacle.BadRequestError}
-     * @throws {@link Pinnacle.UnauthorizedError}
-     * @throws {@link Pinnacle.InternalServerError}
-     *
-     * @example
-     *     await client.getRcsFunctionality()
-     */
-    getRcsFunctionality(request = {}, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__getRcsFunctionality(request, requestOptions));
+    get phoneNumbers() {
+        var _a;
+        return ((_a = this._phoneNumbers) !== null && _a !== void 0 ? _a : (this._phoneNumbers = new Client_js_5.PhoneNumbers(this._options)));
     }
-    __getRcsFunctionality() {
-        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
-            var _a, _b, _c;
-            const { phoneNumber } = request;
-            const _queryParams = {};
-            if (phoneNumber != null) {
-                _queryParams["phoneNumber"] = phoneNumber;
-            }
-            const _response = yield core.fetcher({
-                url: core.url.join((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.PinnacleEnvironment.Default, "rcs_functionality"),
-                method: "GET",
-                headers: (0, headers_js_1.mergeHeaders)((_c = this._options) === null || _c === void 0 ? void 0 : _c.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
-                queryParameters: _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 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 /rcs_functionality.");
-                case "unknown":
-                    throw new errors.PinnacleError({
-                        message: _response.error.errorMessage,
-                        rawResponse: _response.rawResponse,
-                    });
-            }
-        });
+    get webhooks() {
+        var _a;
+        return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Client_js_6.Webhooks(this._options)));
     }
-    _getCustomAuthorizationHeaders() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const apiKeyValue = yield core.Supplier.get(this._options.apiKey);
-            return { "PINNACLE-API-Key": apiKeyValue };
-        });
+    get campaigns() {
+        var _a;
+        return ((_a = this._campaigns) !== null && _a !== void 0 ? _a : (this._campaigns = new Client_js_7.Campaigns(this._options)));
+    }
+    get status() {
+        var _a;
+        return ((_a = this._status) !== null && _a !== void 0 ? _a : (this._status = new Client_js_8.Status(this._options)));
+    }
+    get tools() {
+        var _a;
+        return ((_a = this._tools) !== null && _a !== void 0 ? _a : (this._tools = new Client_js_9.Tools(this._options)));
     }
 }
 exports.PinnacleClient = PinnacleClient;

package/dist/cjs/api/errors/InternalServerError.d.ts

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

package/dist/cjs/api/errors/NotFoundError.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../errors/index.js";
+import * as Pinnacle from "../index.js";
+import * as core from "../../core/index.js";
+export declare class NotFoundError extends errors.PinnacleError {
+    constructor(body: Pinnacle.Error_, rawResponse?: core.RawResponse);
+}

package/dist/cjs/api/errors/NotFoundError.js

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

package/dist/cjs/api/errors/NotImplementedError.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../errors/index.js";
+import * as Pinnacle from "../index.js";
+import * as core from "../../core/index.js";
+export declare class NotImplementedError extends errors.PinnacleError {
+    constructor(body: Pinnacle.Error_, rawResponse?: core.RawResponse);
+}

package/dist/cjs/api/errors/NotImplementedError.js

@@ -0,0 +1,52 @@
+"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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotImplementedError = void 0;
+const errors = __importStar(require("../../errors/index.js"));
+class NotImplementedError extends errors.PinnacleError {
+    constructor(body, rawResponse) {
+        super({
+            message: "NotImplementedError",
+            statusCode: 501,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, NotImplementedError.prototype);
+    }
+}
+exports.NotImplementedError = NotImplementedError;

package/dist/cjs/api/errors/PaymentRequiredError.d.ts

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

package/dist/cjs/api/errors/UnauthorizedError.d.ts

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

package/dist/cjs/api/errors/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./BadRequestError.js";
 export * from "./UnauthorizedError.js";
 export * from "./InternalServerError.js";
+export * from "./NotFoundError.js";
 export * from "./PaymentRequiredError.js";
-export * from "./ForbiddenError.js";
+export * from "./NotImplementedError.js";

package/dist/cjs/api/errors/index.js

@@ -17,5 +17,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./BadRequestError.js"), exports);
 __exportStar(require("./UnauthorizedError.js"), exports);
 __exportStar(require("./InternalServerError.js"), exports);
+__exportStar(require("./NotFoundError.js"), exports);
 __exportStar(require("./PaymentRequiredError.js"), exports);
-__exportStar(require("./ForbiddenError.js"), exports);
+__exportStar(require("./NotImplementedError.js"), exports);

package/dist/cjs/api/index.d.ts

@@ -1,4 +1,3 @@
 export * from "./resources/index.js";
 export * from "./types/index.js";
 export * from "./errors/index.js";
-export * from "./client/index.js";

package/dist/cjs/api/index.js

@@ -17,4 +17,3 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./resources/index.js"), exports);
 __exportStar(require("./types/index.js"), exports);
 __exportStar(require("./errors/index.js"), exports);
-__exportStar(require("./client/index.js"), exports);