rcs-js 2.0.5 → 2.0.6

package/README.md

@@ -1,199 +0,0 @@
-# Pinnacle TypeScript Library
-
-[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fpinnacle-dev%2Frcs-js)
-[![npm shield](https://img.shields.io/npm/v/rcs-js)](https://www.npmjs.com/package/rcs-js)
-
-The Pinnacle TypeScript library provides convenient access to the Pinnacle APIs from TypeScript.
-
-## Table of Contents
-
-- [Installation](#installation)
-- [Usage](#usage)
-- [Request and Response Types](#request-and-response-types)
-- [Exception Handling](#exception-handling)
-- [Advanced](#advanced)
-    - [Additional Headers](#additional-headers)
-    - [Additional Query String Parameters](#additional-query-string-parameters)
-    - [Retries](#retries)
-    - [Timeouts](#timeouts)
-    - [Aborting Requests](#aborting-requests)
-    - [Access Raw Response Data](#access-raw-response-data)
-    - [Runtime Compatibility](#runtime-compatibility)
-- [Contributing](#contributing)
-- [Reference](#reference)
-
-## Installation
-
-```sh
-npm i -s rcs-js
-```
-
-## Usage
-
-Instantiate and use the client with the following:
-
-```typescript
-import { PinnacleClient } from "rcs-js";
-
-const client = new PinnacleClient({ apiKey: "YOUR_API_KEY" });
-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",
-});
-```
-
-## Request and Response Types
-
-The SDK exports all request and response types as TypeScript interfaces. Simply import them with the
-following namespace:
-
-```typescript
-import { Pinnacle } from "rcs-js";
-
-const request: Pinnacle.AutofillBrandParams = {
-    ...
-};
-```
-
-## Exception Handling
-
-When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
-will be thrown.
-
-```typescript
-import { PinnacleError } from "rcs-js";
-
-try {
-    await client.brands.autofill(...);
-} catch (err) {
-    if (err instanceof PinnacleError) {
-        console.log(err.statusCode);
-        console.log(err.message);
-        console.log(err.body);
-        console.log(err.rawResponse);
-    }
-}
-```
-
-## Advanced
-
-### Additional Headers
-
-If you would like to send additional headers as part of the request, use the `headers` request option.
-
-```typescript
-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
-as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
-retry limit (default: 2).
-
-A request is deemed retryable when any of the following HTTP status codes is returned:
-
-- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
-- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
-- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
-
-Use the `maxRetries` request option to configure this behavior.
-
-```typescript
-const response = await client.brands.autofill(..., {
-    maxRetries: 0 // override maxRetries at the request level
-});
-```
-
-### Timeouts
-
-The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
-
-```typescript
-const response = await client.brands.autofill(..., {
-    timeoutInSeconds: 30 // override timeout to 30s
-});
-```
-
-### Aborting Requests
-
-The SDK allows users to abort requests at any point by passing in an abort signal.
-
-```typescript
-const controller = new AbortController();
-const response = await client.brands.autofill(..., {
-    abortSignal: controller.signal
-});
-controller.abort(); // aborts the request
-```
-
-### Access Raw Response Data
-
-The SDK provides access to raw response data, including headers, through the `.withRawResponse()` method.
-The `.withRawResponse()` method returns a promise that results to an object with a `data` and a `rawResponse` property.
-
-```typescript
-const { data, rawResponse } = await client.brands.autofill(...).withRawResponse();
-
-console.log(data);
-console.log(rawResponse.headers['X-My-Header']);
-```
-
-### Runtime Compatibility
-
-The SDK works in the following runtimes:
-
-- Node.js 18+
-- Vercel
-- Cloudflare Workers
-- Deno v1.25+
-- Bun 1.0+
-- React Native
-
-### Customizing Fetch Client
-
-The SDK provides a way for you to customize the underlying HTTP client / Fetch function. If you're running in an
-unsupported environment, this provides a way for you to break glass and ensure the SDK works.
-
-```typescript
-import { PinnacleClient } from "rcs-js";
-
-const client = new PinnacleClient({
-    ...
-    fetcher: // provide your implementation here
-});
-```
-
-## Contributing
-
-While we value open-source contributions to this SDK, this library is generated programmatically.
-Additions made directly to this library would have to be moved over to our generation code,
-otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
-a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
-an issue first to discuss with us!
-
-On the other hand, contributions to the README are always very welcome!
-
-## Reference
-
-A full reference for this library is available [here](https://github.com/pinnacle-dev/rcs-js/blob/HEAD/./reference.md).

package/dist/cjs/Client.d.ts

@@ -4,6 +4,7 @@
 import * as environments from "./environments.js";
 import * as core from "./core/index.js";
 import { Brands } from "./api/resources/brands/client/Client.js";
+import { Audiences } from "./api/resources/audiences/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";
@@ -38,6 +39,7 @@ export declare namespace PinnacleClient {
 export declare class PinnacleClient {
     protected readonly _options: PinnacleClient.Options;
     protected _brands: Brands | undefined;
+    protected _audiences: Audiences | undefined;
     protected _contacts: Contacts | undefined;
     protected _conversations: Conversations | undefined;
     protected _messages: Messages | undefined;
@@ -49,6 +51,7 @@ export declare class PinnacleClient {
     protected _tools: Tools | undefined;
     constructor(_options?: PinnacleClient.Options);
     get brands(): Brands;
+    get audiences(): Audiences;
     get contacts(): Contacts;
     get conversations(): Conversations;
     get messages(): Messages;

package/dist/cjs/Client.js

@@ -40,22 +40,23 @@ exports.PinnacleClient = void 0;
 const core = __importStar(require("./core/index.js"));
 const headers_js_1 = require("./core/headers.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/rcs/client/Client.js");
-const Client_js_7 = require("./api/resources/webhooks/client/Client.js");
-const Client_js_8 = require("./api/resources/campaigns/client/Client.js");
-const Client_js_9 = require("./api/resources/status/client/Client.js");
-const Client_js_10 = require("./api/resources/tools/client/Client.js");
+const Client_js_2 = require("./api/resources/audiences/client/Client.js");
+const Client_js_3 = require("./api/resources/contacts/client/Client.js");
+const Client_js_4 = require("./api/resources/conversations/client/Client.js");
+const Client_js_5 = require("./api/resources/messages/client/Client.js");
+const Client_js_6 = require("./api/resources/phoneNumbers/client/Client.js");
+const Client_js_7 = require("./api/resources/rcs/client/Client.js");
+const Client_js_8 = require("./api/resources/webhooks/client/Client.js");
+const Client_js_9 = require("./api/resources/campaigns/client/Client.js");
+const Client_js_10 = require("./api/resources/status/client/Client.js");
+const Client_js_11 = 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": "2.0.5",
-                "User-Agent": "rcs-js/2.0.5",
+                "X-Fern-SDK-Version": "2.0.6",
+                "User-Agent": "rcs-js/2.0.6",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });
@@ -64,41 +65,45 @@ class PinnacleClient {
         var _a;
         return ((_a = this._brands) !== null && _a !== void 0 ? _a : (this._brands = new Client_js_1.Brands(this._options)));
     }
+    get audiences() {
+        var _a;
+        return ((_a = this._audiences) !== null && _a !== void 0 ? _a : (this._audiences = new Client_js_2.Audiences(this._options)));
+    }
     get contacts() {
         var _a;
-        return ((_a = this._contacts) !== null && _a !== void 0 ? _a : (this._contacts = new Client_js_2.Contacts(this._options)));
+        return ((_a = this._contacts) !== null && _a !== void 0 ? _a : (this._contacts = new Client_js_3.Contacts(this._options)));
     }
     get conversations() {
         var _a;
-        return ((_a = this._conversations) !== null && _a !== void 0 ? _a : (this._conversations = new Client_js_3.Conversations(this._options)));
+        return ((_a = this._conversations) !== null && _a !== void 0 ? _a : (this._conversations = new Client_js_4.Conversations(this._options)));
     }
     get messages() {
         var _a;
-        return ((_a = this._messages) !== null && _a !== void 0 ? _a : (this._messages = new Client_js_4.Messages(this._options)));
+        return ((_a = this._messages) !== null && _a !== void 0 ? _a : (this._messages = new Client_js_5.Messages(this._options)));
     }
     get phoneNumbers() {
         var _a;
-        return ((_a = this._phoneNumbers) !== null && _a !== void 0 ? _a : (this._phoneNumbers = new Client_js_5.PhoneNumbers(this._options)));
+        return ((_a = this._phoneNumbers) !== null && _a !== void 0 ? _a : (this._phoneNumbers = new Client_js_6.PhoneNumbers(this._options)));
     }
     get rcs() {
         var _a;
-        return ((_a = this._rcs) !== null && _a !== void 0 ? _a : (this._rcs = new Client_js_6.Rcs(this._options)));
+        return ((_a = this._rcs) !== null && _a !== void 0 ? _a : (this._rcs = new Client_js_7.Rcs(this._options)));
     }
     get webhooks() {
         var _a;
-        return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Client_js_7.Webhooks(this._options)));
+        return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Client_js_8.Webhooks(this._options)));
     }
     get campaigns() {
         var _a;
-        return ((_a = this._campaigns) !== null && _a !== void 0 ? _a : (this._campaigns = new Client_js_8.Campaigns(this._options)));
+        return ((_a = this._campaigns) !== null && _a !== void 0 ? _a : (this._campaigns = new Client_js_9.Campaigns(this._options)));
     }
     get status() {
         var _a;
-        return ((_a = this._status) !== null && _a !== void 0 ? _a : (this._status = new Client_js_9.Status(this._options)));
+        return ((_a = this._status) !== null && _a !== void 0 ? _a : (this._status = new Client_js_10.Status(this._options)));
     }
     get tools() {
         var _a;
-        return ((_a = this._tools) !== null && _a !== void 0 ? _a : (this._tools = new Client_js_10.Tools(this._options)));
+        return ((_a = this._tools) !== null && _a !== void 0 ? _a : (this._tools = new Client_js_11.Tools(this._options)));
     }
 }
 exports.PinnacleClient = PinnacleClient;

package/dist/cjs/api/resources/audiences/client/Client.d.ts

@@ -0,0 +1,129 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments.js";
+import * as core from "../../../../core/index.js";
+import * as Pinnacle from "../../../index.js";
+import { Contacts } from "../resources/contacts/client/Client.js";
+export declare namespace Audiences {
+    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 | undefined>;
+        /** 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 Audiences {
+    protected readonly _options: Audiences.Options;
+    protected _contacts: Contacts | undefined;
+    constructor(_options?: Audiences.Options);
+    get contacts(): Contacts;
+    /**
+     * Retrieve an audience by ID with optional pagination.
+     *
+     * @param {Pinnacle.AudiencesGetRequest} request
+     * @param {Audiences.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.audiences.get({
+     *         id: "aud_abc123"
+     *     })
+     */
+    get(request: Pinnacle.AudiencesGetRequest, requestOptions?: Audiences.RequestOptions): core.HttpResponsePromise<Pinnacle.AudiencesGetResponse>;
+    private __get;
+    /**
+     * Create a new audience with optional initial contacts. Phone numbers that don't exist will be auto-created as contacts.
+     *
+     * @param {Pinnacle.CreateAudienceParams} request
+     * @param {Audiences.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.audiences.create({
+     *         name: "Marketing Campaign Q1",
+     *         description: "Contacts for Q1 marketing push"
+     *     })
+     *
+     * @example
+     *     await client.audiences.create({
+     *         name: "VIP Customers",
+     *         description: "Our best customers",
+     *         contacts: ["+12125551234", "+13105551234"]
+     *     })
+     *
+     * @example
+     *     await client.audiences.create({
+     *         name: "Mixed Audience",
+     *         contacts: ["+12125551234", "co_abc123", "+13105551234"]
+     *     })
+     */
+    create(request: Pinnacle.CreateAudienceParams, requestOptions?: Audiences.RequestOptions): core.HttpResponsePromise<Pinnacle.AudienceCountOnly>;
+    private __create;
+    /**
+     * Permanently delete an audience and all its contact associations.
+     *
+     * Note: This will NOT delete the contacts themselves, only the audience and its memberships.
+     *
+     * @param {Pinnacle.AudiencesDeleteRequest} request
+     * @param {Audiences.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.audiences.delete({
+     *         id: "aud_abc123"
+     *     })
+     */
+    delete(request: Pinnacle.AudiencesDeleteRequest, requestOptions?: Audiences.RequestOptions): core.HttpResponsePromise<Pinnacle.DeleteAudienceResponse>;
+    private __delete;
+    /**
+     * Update audience metadata. This endpoint does NOT modify contacts.
+     *
+     * To add or remove contacts, use the [Add Contacts](/api-reference/audiences/add-contacts) or [Remove Contacts](/api-reference/audiences/remove-contacts) endpoints.
+     *
+     * @param {Pinnacle.UpdateAudienceParams} request
+     * @param {Audiences.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.audiences.update({
+     *         id: "aud_abc123",
+     *         name: "Updated Audience Name",
+     *         description: "New description"
+     *     })
+     */
+    update(request: Pinnacle.UpdateAudienceParams, requestOptions?: Audiences.RequestOptions): core.HttpResponsePromise<Pinnacle.AudienceCountOnly>;
+    private __update;
+    protected _getCustomAuthorizationHeaders(): Promise<{
+        "PINNACLE-API-KEY": string | undefined;
+    }>;
+}