rcs-js 2.0.19 → 2.0.21

package/dist/cjs/Client.d.ts

@@ -3,6 +3,7 @@ import { Brands } from "./api/resources/brands/client/Client.js";
 import { Campaigns } from "./api/resources/campaigns/client/Client.js";
 import { Contacts } from "./api/resources/contacts/client/Client.js";
 import { Conversations } from "./api/resources/conversations/client/Client.js";
+import { Forms } from "./api/resources/forms/client/Client.js";
 import { Messages } from "./api/resources/messages/client/Client.js";
 import { PhoneNumbers } from "./api/resources/phoneNumbers/client/Client.js";
 import { Rcs } from "./api/resources/rcs/client/Client.js";
@@ -26,6 +27,7 @@ export declare class PinnacleClient {
     protected _phoneNumbers: PhoneNumbers | undefined;
     protected _rcs: Rcs | undefined;
     protected _webhooks: Webhooks | undefined;
+    protected _forms: Forms | undefined;
     protected _campaigns: Campaigns | undefined;
     protected _status: Status | undefined;
     protected _tools: Tools | undefined;
@@ -38,6 +40,7 @@ export declare class PinnacleClient {
     get phoneNumbers(): PhoneNumbers;
     get rcs(): Rcs;
     get webhooks(): Webhooks;
+    get forms(): Forms;
     get campaigns(): Campaigns;
     get status(): Status;
     get tools(): Tools;

package/dist/cjs/Client.js

@@ -40,12 +40,13 @@ const Client_js_2 = require("./api/resources/brands/client/Client.js");
 const Client_js_3 = require("./api/resources/campaigns/client/Client.js");
 const Client_js_4 = require("./api/resources/contacts/client/Client.js");
 const Client_js_5 = require("./api/resources/conversations/client/Client.js");
-const Client_js_6 = require("./api/resources/messages/client/Client.js");
-const Client_js_7 = require("./api/resources/phoneNumbers/client/Client.js");
-const Client_js_8 = require("./api/resources/rcs/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_11 = require("./api/resources/webhooks/client/Client.js");
+const Client_js_6 = require("./api/resources/forms/client/Client.js");
+const Client_js_7 = require("./api/resources/messages/client/Client.js");
+const Client_js_8 = require("./api/resources/phoneNumbers/client/Client.js");
+const Client_js_9 = require("./api/resources/rcs/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");
+const Client_js_12 = require("./api/resources/webhooks/client/Client.js");
 const headers_js_1 = require("./core/headers.js");
 const core = __importStar(require("./core/index.js"));
 class PinnacleClient {
@@ -53,8 +54,8 @@ class PinnacleClient {
         this._options = Object.assign(Object.assign({}, _options), { logging: core.logging.createLogger(_options === null || _options === void 0 ? void 0 : _options.logging), headers: (0, headers_js_1.mergeHeaders)({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "rcs-js",
-                "X-Fern-SDK-Version": "2.0.19",
-                "User-Agent": "rcs-js/2.0.19",
+                "X-Fern-SDK-Version": "2.0.21",
+                "User-Agent": "rcs-js/2.0.21",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });
@@ -77,19 +78,23 @@ class PinnacleClient {
     }
     get messages() {
         var _a;
-        return ((_a = this._messages) !== null && _a !== void 0 ? _a : (this._messages = new Client_js_6.Messages(this._options)));
+        return ((_a = this._messages) !== null && _a !== void 0 ? _a : (this._messages = new Client_js_7.Messages(this._options)));
     }
     get phoneNumbers() {
         var _a;
-        return ((_a = this._phoneNumbers) !== null && _a !== void 0 ? _a : (this._phoneNumbers = new Client_js_7.PhoneNumbers(this._options)));
+        return ((_a = this._phoneNumbers) !== null && _a !== void 0 ? _a : (this._phoneNumbers = new Client_js_8.PhoneNumbers(this._options)));
     }
     get rcs() {
         var _a;
-        return ((_a = this._rcs) !== null && _a !== void 0 ? _a : (this._rcs = new Client_js_8.Rcs(this._options)));
+        return ((_a = this._rcs) !== null && _a !== void 0 ? _a : (this._rcs = new Client_js_9.Rcs(this._options)));
     }
     get webhooks() {
         var _a;
-        return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Client_js_11.Webhooks(this._options)));
+        return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Client_js_12.Webhooks(this._options)));
+    }
+    get forms() {
+        var _a;
+        return ((_a = this._forms) !== null && _a !== void 0 ? _a : (this._forms = new Client_js_6.Forms(this._options)));
     }
     get campaigns() {
         var _a;
@@ -97,11 +102,11 @@ class PinnacleClient {
     }
     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/forms/client/Client.d.ts

@@ -0,0 +1,171 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import * as core from "../../../../core/index.js";
+import * as Pinnacle from "../../../index.js";
+import { Submissions } from "../resources/submissions/client/Client.js";
+export declare namespace Forms {
+    interface Options extends BaseClientOptions {
+    }
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class Forms {
+    protected readonly _options: Forms.Options;
+    protected _submissions: Submissions | undefined;
+    constructor(_options: Forms.Options);
+    get submissions(): Submissions;
+    /**
+     * Retrieve a form by id. Includes submission count, last submission timestamp, and archive state.
+     *
+     * @param {string} id - The unique identifier of the form you want to retrieve.
+     *                      <br><br> This identifier is a string that always begins with the prefix `form_`, for example: `form_Oy2n7iUoi9CJwUU6`. It's returned on every form response (`Form.id`) and by [`POST /forms/send`](/api-reference/forms/send-form) (`response.form.id`).
+     * @param {Forms.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.forms.get("form_Oy2n7iUoi9CJwUU6")
+     */
+    get(id: string, requestOptions?: Forms.RequestOptions): core.HttpResponsePromise<Pinnacle.Form>;
+    private __get;
+    /**
+     * Partial update. Only keys present in the body are applied. Archived forms (non-null `archived_at`) cannot be updated — restore the form by setting `archived_at: null` in a PATCH first.
+     *
+     * @param {string} id - The unique identifier of the form you want to update.
+     *                      <br><br> This identifier is a string that always begins with the prefix `form_`, for example: `form_Oy2n7iUoi9CJwUU6`.
+     * @param {Pinnacle.UpdateFormParams} request
+     * @param {Forms.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.forms.update("form_Oy2n7iUoi9CJwUU6", {
+     *         name: "Contact request (v2)",
+     *         can_update: true,
+     *         expires_at: "2026-12-31T23:59:59Z"
+     *     })
+     */
+    update(id: string, request?: Pinnacle.UpdateFormParams, requestOptions?: Forms.RequestOptions): core.HttpResponsePromise<Pinnacle.Form>;
+    private __update;
+    /**
+     * Paginated list of forms on your team, sorted by creation date (newest first). Includes archived forms.
+     *
+     * @param {Pinnacle.ListFormsParams} request
+     * @param {Forms.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.forms.list({
+     *         pageIndex: 0,
+     *         pageSize: 20
+     *     })
+     */
+    list(request?: Pinnacle.ListFormsParams, requestOptions?: Forms.RequestOptions): core.HttpResponsePromise<Pinnacle.ListFormsResponse>;
+    private __list;
+    /**
+     * Create a hosted form without sending it. <br>
+     *
+     * Returns the form object including its public URL — `https://forms.pinnacle.sh/{form_id}`. <br>
+     *
+     * To also deliver the URL to a recipient over SMS or RCS in a single call, use [`POST /forms/send`](/api-reference/forms/send-form).
+     *
+     * @param {Pinnacle.CreateFormRequest} request
+     * @param {Forms.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.forms.create({
+     *         name: "Contact request",
+     *         description: "We'll follow up over SMS or RCS.",
+     *         fields: [{
+     *                 type: "text",
+     *                 key: "full_name",
+     *                 label: "Full name",
+     *                 required: true,
+     *                 placeholder: "Ada Lovelace",
+     *                 min_length: 2,
+     *                 max_length: 60
+     *             }, {
+     *                 type: "email",
+     *                 key: "email",
+     *                 label: "Email",
+     *                 required: true,
+     *                 placeholder: "you@example.com"
+     *             }, {
+     *                 type: "phone",
+     *                 key: "phone",
+     *                 label: "Phone",
+     *                 required: true,
+     *                 placeholder: "(555) 555-1212"
+     *             }, {
+     *                 type: "select",
+     *                 key: "plan",
+     *                 label: "Plan",
+     *                 required: true,
+     *                 options: [{
+     *                         value: "basic",
+     *                         label: "Basic"
+     *                     }, {
+     *                         value: "pro",
+     *                         label: "Pro"
+     *                     }, {
+     *                         value: "enterprise",
+     *                         label: "Enterprise"
+     *                     }]
+     *             }],
+     *         can_update: false
+     *     })
+     */
+    create(request: Pinnacle.CreateFormRequest, requestOptions?: Forms.RequestOptions): core.HttpResponsePromise<Pinnacle.Form>;
+    private __create;
+    /**
+     * Send a form to a recipient over SMS or RCS, or mint a standalone submission URL.
+     *
+     * Pass `form` as either an existing form id (`form_*`) or an inline `{ fields, ... }` definition to mint a new form for this send.
+     *
+     * The delivery channel is inferred from `from`:
+     * - `from: "agent_*"` → RCS (with optional SMS `fallback`)
+     * - `from: "+E.164"` → SMS
+     *
+     * When `to` is provided, Pinnacle dispatches a message whose body contains the submission URL and the recipient is recorded on the response: `submission.to` echoes the same E.164 number and `message_id` is the id of the outbound SMS/RCS.
+     *
+     * When `to` is omitted, no message is sent — `submission.to` and `message_id` are both `null` — which is useful for embedding the URL in your own outreach.
+     *
+     * On completion, a `FORM.SUBMISSION` webhook event is delivered to webhooks subscribed to the sender. See [Receiving Messages and User Events](/guides/messages/receiving).
+     *
+     * @param {Pinnacle.SendFormParams} request
+     * @param {Forms.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Pinnacle.BadRequestError}
+     * @throws {@link Pinnacle.UnauthorizedError}
+     * @throws {@link Pinnacle.NotFoundError}
+     * @throws {@link Pinnacle.InternalServerError}
+     *
+     * @example
+     *     await client.forms.send({
+     *         from: "agent_iM9wQcyBBjYn",
+     *         to: "+14155551234",
+     *         form: "form_Oy2n7iUoi9CJwUU6",
+     *         fallback: {
+     *             from: "+14155550000"
+     *         },
+     *         options: {
+     *             webview_mode: "FULL"
+     *         }
+     *     })
+     */
+    send(request: Pinnacle.SendFormParams, requestOptions?: Forms.RequestOptions): core.HttpResponsePromise<Pinnacle.FormsSendResponse>;
+    private __send;
+    protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | undefined>>;
+}