rcs-js 2.0.5 → 2.0.6

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

@@ -0,0 +1,80 @@
+/**
+ * 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 | 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 Contacts {
+    protected readonly _options: Contacts.Options;
+    constructor(_options?: Contacts.Options);
+    /**
+     * Remove contacts from an existing audience. This operation is idempotent.
+     *
+     * - Only removes contacts that exist in the audience
+     * - Contacts not in the audience are ignored
+     *
+     * @param {Pinnacle.audiences.RemoveContactsParams} 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.audiences.contacts.remove({
+     *         id: "aud_abc123",
+     *         contacts: ["+12125551234", "co_def456"]
+     *     })
+     */
+    remove(request: Pinnacle.audiences.RemoveContactsParams, requestOptions?: Contacts.RequestOptions): core.HttpResponsePromise<Pinnacle.AudienceCountOnly>;
+    private __remove;
+    /**
+     * Add contacts to an existing audience. This operation is additive and idempotent.
+     *
+     * - Phone numbers that don't exist will be auto-created as contacts
+     * - Duplicate adds are ignored
+     * - Contacts already in the audience are ignored
+     *
+     * @param {Pinnacle.audiences.AddContactsParams} 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.audiences.contacts.add({
+     *         id: "aud_abc123",
+     *         contacts: ["+12125551234", "co_def456", "+13105551234"]
+     *     })
+     */
+    add(request: Pinnacle.audiences.AddContactsParams, requestOptions?: Contacts.RequestOptions): core.HttpResponsePromise<Pinnacle.AudienceCountOnly>;
+    private __add;
+    protected _getCustomAuthorizationHeaders(): Promise<{
+        "PINNACLE-API-KEY": string | undefined;
+    }>;
+}

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

@@ -0,0 +1,183 @@
+/**
+ * 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;
+    }
+    /**
+     * Remove contacts from an existing audience. This operation is idempotent.
+     *
+     * - Only removes contacts that exist in the audience
+     * - Contacts not in the audience are ignored
+     *
+     * @param {Pinnacle.audiences.RemoveContactsParams} 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.audiences.contacts.remove({
+     *         id: "aud_abc123",
+     *         contacts: ["+12125551234", "co_def456"]
+     *     })
+     */
+    remove(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__remove(request, requestOptions));
+    }
+    __remove(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, "audiences/contacts"),
+                method: "DELETE",
+                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 DELETE /audiences/contacts.");
+                case "unknown":
+                    throw new errors.PinnacleError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    /**
+     * Add contacts to an existing audience. This operation is additive and idempotent.
+     *
+     * - Phone numbers that don't exist will be auto-created as contacts
+     * - Duplicate adds are ignored
+     * - Contacts already in the audience are ignored
+     *
+     * @param {Pinnacle.audiences.AddContactsParams} 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.audiences.contacts.add({
+     *         id: "aud_abc123",
+     *         contacts: ["+12125551234", "co_def456", "+13105551234"]
+     *     })
+     */
+    add(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__add(request, requestOptions));
+    }
+    __add(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, "audiences/contacts"),
+                method: "PATCH",
+                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 PATCH /audiences/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/audiences/resources/contacts/client/index.d.mts

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

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

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

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

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         id: "aud_abc123",
+ *         contacts: ["+12125551234", "co_def456", "+13105551234"]
+ *     }
+ */
+export interface AddContactsParams {
+    /** Audience ID. This identifier is a string that always begins with the prefix `aud_`, for example: `aud_abc123`. */
+    id: string;
+    /** Array of phone numbers (E.164 format) or contact IDs (minimum 1 item). */
+    contacts: string[];
+}

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

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         id: "aud_abc123",
+ *         contacts: ["+12125551234", "co_def456"]
+ *     }
+ */
+export interface RemoveContactsParams {
+    /** Audience ID. This identifier is a string that always begins with the prefix `aud_`, for example: `aud_abc123`. */
+    id: string;
+    /** Array of phone numbers (E.164 format) or contact IDs (minimum 1 item). */
+    contacts: string[];
+}

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

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

@@ -0,0 +1,2 @@
+export { type RemoveContactsParams } from "./RemoveContactsParams.mjs";
+export { type AddContactsParams } from "./AddContactsParams.mjs";

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

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

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

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

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

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

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

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

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

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

package/dist/esm/api/resources/audiences/types/AudiencesGetResponse.d.mts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../../../index.mjs";
+export type AudiencesGetResponse = 
+/**
+ * Returned when page and/or limit parameters are provided. */
+Pinnacle.AudienceWithPagination
+/**
+ * Returned when no pagination parameters are provided. */
+ | Pinnacle.AudienceCountOnly;

package/dist/esm/api/resources/audiences/types/AudiencesGetResponse.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/resources/audiences/types/index.d.mts

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

package/dist/esm/api/resources/audiences/types/index.mjs

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

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

@@ -1,3 +1,5 @@
+export * as audiences from "./audiences/index.mjs";
+export * from "./audiences/types/index.mjs";
 export * as conversations from "./conversations/index.mjs";
 export * from "./conversations/types/index.mjs";
 export * as phoneNumbers from "./phoneNumbers/index.mjs";
@@ -11,6 +13,7 @@ export * as webhooks from "./webhooks/index.mjs";
 export * as status from "./status/index.mjs";
 export * as tools from "./tools/index.mjs";
 export * from "./brands/client/requests/index.mjs";
+export * from "./audiences/client/requests/index.mjs";
 export * from "./contacts/client/requests/index.mjs";
 export * from "./conversations/client/requests/index.mjs";
 export * from "./messages/client/requests/index.mjs";

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

@@ -1,3 +1,5 @@
+export * as audiences from "./audiences/index.mjs";
+export * from "./audiences/types/index.mjs";
 export * as conversations from "./conversations/index.mjs";
 export * from "./conversations/types/index.mjs";
 export * as phoneNumbers from "./phoneNumbers/index.mjs";
@@ -11,6 +13,7 @@ export * as webhooks from "./webhooks/index.mjs";
 export * as status from "./status/index.mjs";
 export * as tools from "./tools/index.mjs";
 export * from "./brands/client/requests/index.mjs";
+export * from "./audiences/client/requests/index.mjs";
 export * from "./contacts/client/requests/index.mjs";
 export * from "./conversations/client/requests/index.mjs";
 export * from "./messages/client/requests/index.mjs";

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

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface AudienceCountOnly {
+    /** Audience public ID. This identifier is a string that always begins with the prefix `aud_`, for example: `aud_abc123`. */
+    id: string;
+    /** Audience name. */
+    name: string;
+    /** Audience description. */
+    description: string;
+    /**
+     * Total number of contacts in audience.
+     *
+     * Use the [Get Audience](/api-reference/audiences/get) endpoint with the pagination parameters to get the audience with its contacts.
+     */
+    contactCount: number;
+}

package/dist/esm/api/types/AudienceCountOnly.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Pinnacle from "../index.mjs";
+export interface AudienceWithPagination {
+    /** Audience public ID. This identifier is a string that always begins with the prefix `aud_`, for example: `aud_abc123`. */
+    id: string;
+    /** Audience name. */
+    name: string;
+    /** Audience description. */
+    description: string;
+    /** Array of contact objects (paginated). */
+    contacts: Pinnacle.Contact[];
+    /** Total number of contacts in audience. */
+    contactCount: number;
+    pagination: Pinnacle.Pagination;
+}

package/dist/esm/api/types/AudienceWithPagination.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface DeleteAudienceResponse {
+    /** Indicates successful deletion. */
+    success: boolean;
+}

package/dist/esm/api/types/DeleteAudienceResponse.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface Pagination {
+    /** Current page number (1-indexed). */
+    page: number;
+    /** Items per page (max 100, default 50). */
+    limit: number;
+    /** Total number of contacts in the audience. */
+    total: number;
+    /** Whether more pages exist. */
+    hasMore: boolean;
+}

package/dist/esm/api/types/Pagination.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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/api/types/index.d.mts

@@ -35,6 +35,10 @@ export * from "./RcsCampaignUseCaseEnum.mjs";
 export * from "./RcsCampaign.mjs";
 export * from "./ExtendedRcsCampaign.mjs";
 export * from "./Contact.mjs";
+export * from "./Pagination.mjs";
+export * from "./AudienceWithPagination.mjs";
+export * from "./AudienceCountOnly.mjs";
+export * from "./DeleteAudienceResponse.mjs";
 export * from "./OptionalContact.mjs";
 export * from "./UpdatedContactId.mjs";
 export * from "./ContactId.mjs";

package/dist/esm/api/types/index.mjs

@@ -35,6 +35,10 @@ export * from "./RcsCampaignUseCaseEnum.mjs";
 export * from "./RcsCampaign.mjs";
 export * from "./ExtendedRcsCampaign.mjs";
 export * from "./Contact.mjs";
+export * from "./Pagination.mjs";
+export * from "./AudienceWithPagination.mjs";
+export * from "./AudienceCountOnly.mjs";
+export * from "./DeleteAudienceResponse.mjs";
 export * from "./OptionalContact.mjs";
 export * from "./UpdatedContactId.mjs";
 export * from "./ContactId.mjs";

package/dist/esm/version.d.mts

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

package/dist/esm/version.mjs

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "rcs-js",
-    "version": "2.0.5",
+    "version": "2.0.6",
     "private": false,
     "repository": "github:pinnacle-dev/rcs-js",
     "type": "commonjs",