rcs-js 2.0.3-rc.1 → 2.0.5-rc.1

package/README.md

@@ -5,6 +5,41 @@
 
 The Pinnacle TypeScript library provides convenient access to the Pinnacle APIs from TypeScript.
 
+## Table of Contents
+
+- [Table of Contents](#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)
+
+## 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
@@ -29,7 +64,7 @@ await client.brands.autofill({
 });
 ```
 
-## Request And Response Types
+## Request and Response Types
 
 The SDK exports all request and response types as TypeScript interfaces. Simply import them with the
 following namespace:

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.3-rc.1",
-                "User-Agent": "rcs-js/2.0.3-rc.1",
+                "X-Fern-SDK-Version": "2.0.5-rc.1",
+                "User-Agent": "rcs-js/2.0.5-rc.1",
                 "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", "cont_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;
+    }>;
+}