rcs-js 2.0.5-rc.1 → 2.0.6

package/README.md

@@ -1,217 +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
-
-- [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
-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.js

@@ -55,8 +55,8 @@ class PinnacleClient {
         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-rc.1",
-                "User-Agent": "rcs-js/2.0.5-rc.1",
+                "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) });

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

@@ -76,7 +76,7 @@ export declare class Audiences {
      * @example
      *     await client.audiences.create({
      *         name: "Mixed Audience",
-     *         contacts: ["+12125551234", "cont_abc123", "+13105551234"]
+     *         contacts: ["+12125551234", "co_abc123", "+13105551234"]
      *     })
      */
     create(request: Pinnacle.CreateAudienceParams, requestOptions?: Audiences.RequestOptions): core.HttpResponsePromise<Pinnacle.AudienceCountOnly>;

package/dist/cjs/api/resources/audiences/client/Client.js

@@ -165,7 +165,7 @@ class Audiences {
      * @example
      *     await client.audiences.create({
      *         name: "Mixed Audience",
-     *         contacts: ["+12125551234", "cont_abc123", "+13105551234"]
+     *         contacts: ["+12125551234", "co_abc123", "+13105551234"]
      *     })
      */
     create(request, requestOptions) {

package/dist/cjs/api/resources/audiences/client/requests/CreateAudienceParams.d.ts

@@ -18,7 +18,7 @@
  * @example
  *     {
  *         name: "Mixed Audience",
- *         contacts: ["+12125551234", "cont_abc123", "+13105551234"]
+ *         contacts: ["+12125551234", "co_abc123", "+13105551234"]
  *     }
  */
 export interface CreateAudienceParams {

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

@@ -46,7 +46,7 @@ export declare class Contacts {
      * @example
      *     await client.audiences.contacts.remove({
      *         id: "aud_abc123",
-     *         contacts: ["+12125551234", "cont_def456"]
+     *         contacts: ["+12125551234", "co_def456"]
      *     })
      */
     remove(request: Pinnacle.audiences.RemoveContactsParams, requestOptions?: Contacts.RequestOptions): core.HttpResponsePromise<Pinnacle.AudienceCountOnly>;
@@ -69,7 +69,7 @@ export declare class Contacts {
      * @example
      *     await client.audiences.contacts.add({
      *         id: "aud_abc123",
-     *         contacts: ["+12125551234", "cont_def456", "+13105551234"]
+     *         contacts: ["+12125551234", "co_def456", "+13105551234"]
      *     })
      */
     add(request: Pinnacle.audiences.AddContactsParams, requestOptions?: Contacts.RequestOptions): core.HttpResponsePromise<Pinnacle.AudienceCountOnly>;

package/dist/cjs/api/resources/audiences/resources/contacts/client/Client.js

@@ -72,7 +72,7 @@ class Contacts {
      * @example
      *     await client.audiences.contacts.remove({
      *         id: "aud_abc123",
-     *         contacts: ["+12125551234", "cont_def456"]
+     *         contacts: ["+12125551234", "co_def456"]
      *     })
      */
     remove(request, requestOptions) {
@@ -150,7 +150,7 @@ class Contacts {
      * @example
      *     await client.audiences.contacts.add({
      *         id: "aud_abc123",
-     *         contacts: ["+12125551234", "cont_def456", "+13105551234"]
+     *         contacts: ["+12125551234", "co_def456", "+13105551234"]
      *     })
      */
     add(request, requestOptions) {

package/dist/cjs/api/resources/audiences/resources/contacts/client/requests/AddContactsParams.d.ts

@@ -5,7 +5,7 @@
  * @example
  *     {
  *         id: "aud_abc123",
- *         contacts: ["+12125551234", "cont_def456", "+13105551234"]
+ *         contacts: ["+12125551234", "co_def456", "+13105551234"]
  *     }
  */
 export interface AddContactsParams {

package/dist/cjs/api/resources/audiences/resources/contacts/client/requests/RemoveContactsParams.d.ts

@@ -5,7 +5,7 @@
  * @example
  *     {
  *         id: "aud_abc123",
- *         contacts: ["+12125551234", "cont_def456"]
+ *         contacts: ["+12125551234", "co_def456"]
  *     }
  */
 export interface RemoveContactsParams {

package/dist/cjs/api/types/SentMmsDetails.d.ts

@@ -2,7 +2,11 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface SentMmsDetails {
-    /** Array of unique identifiers for the sent MMS messages. This identifiers are strings that always begin with the prefix `msg_`, for example: `msg_1234567890`. */
+    /**
+     * Array of unique message identifiers for an individual MMS send. Each identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`. <br><br>
+     * When media assets are too large to fit in a single MMS and `options.multiple_messages` is set to true, the content is automatically split across multiple messages. Each split message gets its own ID, and all IDs are returned in this array. <br><br>
+     * Note: When sending to audiences, you'll receive multiple response objects (one per recipient), each containing its own messageIds array.
+     */
     messageIds: string[];
     /** Total number of segments used across the message. */
     segments: number;

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "2.0.5-rc.1";
+export declare const SDK_VERSION = "2.0.6";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "2.0.5-rc.1";
+exports.SDK_VERSION = "2.0.6";

package/dist/esm/Client.mjs

@@ -19,8 +19,8 @@ export class PinnacleClient {
         this._options = Object.assign(Object.assign({}, _options), { headers: mergeHeaders({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "rcs-js",
-                "X-Fern-SDK-Version": "2.0.5-rc.1",
-                "User-Agent": "rcs-js/2.0.5-rc.1",
+                "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) });

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

@@ -76,7 +76,7 @@ export declare class Audiences {
      * @example
      *     await client.audiences.create({
      *         name: "Mixed Audience",
-     *         contacts: ["+12125551234", "cont_abc123", "+13105551234"]
+     *         contacts: ["+12125551234", "co_abc123", "+13105551234"]
      *     })
      */
     create(request: Pinnacle.CreateAudienceParams, requestOptions?: Audiences.RequestOptions): core.HttpResponsePromise<Pinnacle.AudienceCountOnly>;

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

@@ -129,7 +129,7 @@ export class Audiences {
      * @example
      *     await client.audiences.create({
      *         name: "Mixed Audience",
-     *         contacts: ["+12125551234", "cont_abc123", "+13105551234"]
+     *         contacts: ["+12125551234", "co_abc123", "+13105551234"]
      *     })
      */
     create(request, requestOptions) {

package/dist/esm/api/resources/audiences/client/requests/CreateAudienceParams.d.mts

@@ -18,7 +18,7 @@
  * @example
  *     {
  *         name: "Mixed Audience",
- *         contacts: ["+12125551234", "cont_abc123", "+13105551234"]
+ *         contacts: ["+12125551234", "co_abc123", "+13105551234"]
  *     }
  */
 export interface CreateAudienceParams {

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

@@ -46,7 +46,7 @@ export declare class Contacts {
      * @example
      *     await client.audiences.contacts.remove({
      *         id: "aud_abc123",
-     *         contacts: ["+12125551234", "cont_def456"]
+     *         contacts: ["+12125551234", "co_def456"]
      *     })
      */
     remove(request: Pinnacle.audiences.RemoveContactsParams, requestOptions?: Contacts.RequestOptions): core.HttpResponsePromise<Pinnacle.AudienceCountOnly>;
@@ -69,7 +69,7 @@ export declare class Contacts {
      * @example
      *     await client.audiences.contacts.add({
      *         id: "aud_abc123",
-     *         contacts: ["+12125551234", "cont_def456", "+13105551234"]
+     *         contacts: ["+12125551234", "co_def456", "+13105551234"]
      *     })
      */
     add(request: Pinnacle.audiences.AddContactsParams, requestOptions?: Contacts.RequestOptions): core.HttpResponsePromise<Pinnacle.AudienceCountOnly>;

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

@@ -36,7 +36,7 @@ export class Contacts {
      * @example
      *     await client.audiences.contacts.remove({
      *         id: "aud_abc123",
-     *         contacts: ["+12125551234", "cont_def456"]
+     *         contacts: ["+12125551234", "co_def456"]
      *     })
      */
     remove(request, requestOptions) {
@@ -114,7 +114,7 @@ export class Contacts {
      * @example
      *     await client.audiences.contacts.add({
      *         id: "aud_abc123",
-     *         contacts: ["+12125551234", "cont_def456", "+13105551234"]
+     *         contacts: ["+12125551234", "co_def456", "+13105551234"]
      *     })
      */
     add(request, requestOptions) {

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

@@ -5,7 +5,7 @@
  * @example
  *     {
  *         id: "aud_abc123",
- *         contacts: ["+12125551234", "cont_def456", "+13105551234"]
+ *         contacts: ["+12125551234", "co_def456", "+13105551234"]
  *     }
  */
 export interface AddContactsParams {

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

@@ -5,7 +5,7 @@
  * @example
  *     {
  *         id: "aud_abc123",
- *         contacts: ["+12125551234", "cont_def456"]
+ *         contacts: ["+12125551234", "co_def456"]
  *     }
  */
 export interface RemoveContactsParams {

package/dist/esm/api/types/SentMmsDetails.d.mts

@@ -2,7 +2,11 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface SentMmsDetails {
-    /** Array of unique identifiers for the sent MMS messages. This identifiers are strings that always begin with the prefix `msg_`, for example: `msg_1234567890`. */
+    /**
+     * Array of unique message identifiers for an individual MMS send. Each identifier is a string that always begins with the prefix `msg_`, for example: `msg_1234567890`. <br><br>
+     * When media assets are too large to fit in a single MMS and `options.multiple_messages` is set to true, the content is automatically split across multiple messages. Each split message gets its own ID, and all IDs are returned in this array. <br><br>
+     * Note: When sending to audiences, you'll receive multiple response objects (one per recipient), each containing its own messageIds array.
+     */
     messageIds: string[];
     /** Total number of segments used across the message. */
     segments: number;

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "2.0.5-rc.1";
+export declare const SDK_VERSION = "2.0.6";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "2.0.5-rc.1";
+export const SDK_VERSION = "2.0.6";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "rcs-js",
-    "version": "2.0.5-rc.1",
+    "version": "2.0.6",
     "private": false,
     "repository": "github:pinnacle-dev/rcs-js",
     "type": "commonjs",
@@ -36,7 +36,7 @@
         "test": "jest --selectProjects unit && NODE_OPTIONS=--experimental-vm-modules jest --selectProjects wire",
         "test:unit": "jest --selectProjects unit",
         "test:browser": "jest --selectProjects browser",
-        "test:wire": "NODE_OPTIONS='--experimental-vm-modules' jest --selectProjects wire"
+        "test:wire": "NODE_OPTIONS=--experimental-vm-modules jest --selectProjects wire"
     },
     "dependencies": {
         "mime-types": "^3.0.1"

package/reference.md

@@ -1882,7 +1882,7 @@ Remove contacts from an existing audience. This operation is idempotent.
 ```typescript
 await client.audiences.contacts.remove({
     id: "aud_abc123",
-    contacts: ["+12125551234", "cont_def456"],
+    contacts: ["+12125551234", "co_def456"],
 });
 ```
 
@@ -1951,7 +1951,7 @@ Add contacts to an existing audience. This operation is additive and idempotent.
 ```typescript
 await client.audiences.contacts.add({
     id: "aud_abc123",
-    contacts: ["+12125551234", "cont_def456", "+13105551234"],
+    contacts: ["+12125551234", "co_def456", "+13105551234"],
 });
 ```