rcs-js 2.0.19 → 2.0.21

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

@@ -1,3 +1,4 @@
+export * from "./AddressField.js";
 export * from "./AdvancedPhoneInformation.js";
 export * from "./AgentEmailEntry.js";
 export * from "./AgentPhoneEntry.js";
@@ -22,10 +23,17 @@ export * from "./ButtonClicked.js";
 export * from "./ButtonClickedData.js";
 export * from "./CampaignEnum.js";
 export * from "./CampaignQuery.js";
+export * from "./CampaignStatusEvent.js";
+export * from "./CampaignStatusEventAgent.js";
+export * from "./CampaignStatusEventBrand.js";
+export * from "./CampaignStatusEventCampaign.js";
+export * from "./CampaignStatusEventCarrierLaunches.js";
 export * from "./CampaignSubmissionResult.js";
 export * from "./CampaignValidationResult.js";
 export * from "./CarrierLaunches.js";
 export * from "./CarrierLaunchStatus.js";
+export * from "./CheckboxField.js";
+export * from "./ColorField.js";
 export * from "./CompanyEntityTypeEnum.js";
 export * from "./CompanySectorEnum.js";
 export * from "./CompanyTypeEnum.js";
@@ -33,7 +41,10 @@ export * from "./Contact.js";
 export * from "./ContactId.js";
 export * from "./Conversation.js";
 export * from "./ConversationList.js";
+export * from "./CreateFormRequest.js";
 export * from "./CreateUrlOptions.js";
+export * from "./DateField.js";
+export * from "./DatetimeField.js";
 export * from "./DeleteAudienceResponse.js";
 export * from "./DetachedPhoneNumberResult.js";
 export * from "./DetachWebhookResult.js";
@@ -43,6 +54,7 @@ export * from "./DlcCampaignStatus.js";
 export * from "./DlcCampaignSummary.js";
 export * from "./DlcCampaignUseCaseEnum.js";
 export * from "./DlcCampaignWithExtendedBrandAndStatus.js";
+export * from "./EmailField.js";
 export * from "./EnhancedContact.js";
 export * from "./EnhancedContactItem.js";
 export * from "./Error_.js";
@@ -51,6 +63,27 @@ export * from "./ExtendedBrandWithVetting.js";
 export * from "./ExtendedRcsCampaign.js";
 export * from "./FailedSender.js";
 export * from "./FallbackMessage.js";
+export * from "./FieldBase.js";
+export * from "./Form.js";
+export * from "./FormBackground.js";
+export * from "./FormBackgroundGradient.js";
+export * from "./FormBackgroundImage.js";
+export * from "./FormBackgroundPattern.js";
+export * from "./FormBackgroundSolid.js";
+export * from "./FormColorPalette.js";
+export * from "./FormDefinition.js";
+export * from "./FormField.js";
+export * from "./FormFieldOption.js";
+export * from "./FormGradient.js";
+export * from "./FormIdReference.js";
+export * from "./FormSubmission.js";
+export * from "./FormSubmissionAnswer.js";
+export * from "./FormSubmissionEvent.js";
+export * from "./FormSubmissionEventConversation.js";
+export * from "./FormSubmissionEventForm.js";
+export * from "./FormSubmissionEventSubmission.js";
+export * from "./FormSubmittedField.js";
+export * from "./FormThemeOverride.js";
 export * from "./GetConversationParams.js";
 export * from "./LinkClickEvent.js";
 export * from "./LinkSummary.js";
@@ -60,6 +93,8 @@ export * from "./ListBlastsResponse.js";
 export * from "./ListBrandsResponse.js";
 export * from "./ListContactsResponse.js";
 export * from "./ListDlcCampaignsResponse.js";
+export * from "./ListFormSubmissionsResponse.js";
+export * from "./ListFormsResponse.js";
 export * from "./ListLinksResponse.js";
 export * from "./ListMessagesResponse.js";
 export * from "./ListPhoneNumbersResponse.js";
@@ -92,6 +127,7 @@ export * from "./MessagingProfileEnum.js";
 export * from "./MmsContent.js";
 export * from "./MmsValidationResult.js";
 export * from "./NotFoundErrorBody.js";
+export * from "./NumberField.js";
 export * from "./NumberFormat.js";
 export * from "./OptInMethodEnum.js";
 export * from "./OptionalBrandInfo.js";
@@ -102,12 +138,16 @@ export * from "./Pagination.js";
 export * from "./PhoneCapabilities.js";
 export * from "./PhoneEnum.js";
 export * from "./PhoneFeatureEnum.js";
+export * from "./PhoneField.js";
 export * from "./PhoneNumberDetails.js";
 export * from "./PhoneNumberEnum.js";
 export * from "./PhoneNumberStatus.js";
 export * from "./PhoneNumberStatusEnum.js";
 export * from "./ProfileStatusEnum.js";
 export * from "./PurchasedNumber.js";
+export * from "./RadioField.js";
+export * from "./RangeField.js";
+export * from "./RatingField.js";
 export * from "./RcsAgentDetails.js";
 export * from "./RcsAgentResponse.js";
 export * from "./RcsButtonCall.js";
@@ -141,9 +181,16 @@ export * from "./RichText.js";
 export * from "./RichTextMessage.js";
 export * from "./ScheduleCancelResult.js";
 export * from "./ScheduledBlastDetails.js";
+export * from "./ScheduledFormSendResult.js";
 export * from "./ScheduledMessage.js";
 export * from "./ScheduledMessageSummary.js";
+export * from "./SelectField.js";
 export * from "./Sender.js";
+export * from "./SendFormOptions.js";
+export * from "./SendFormParams.js";
+export * from "./SendFormResult.js";
+export * from "./SendFormViaRcsParams.js";
+export * from "./SendFormViaSmsParams.js";
 export * from "./SendRichMessageOptions4.js";
 export * from "./SendTypingIndicatorResponse.js";
 export * from "./SentMmsDetails.js";
@@ -165,6 +212,9 @@ export * from "./SubUseCaseEnum.js";
 export * from "./SuccessfulConversationUpdate.js";
 export * from "./TestAgentResponse.js";
 export * from "./TestAgentWhitelistResponse.js";
+export * from "./TextareaField.js";
+export * from "./TextField.js";
+export * from "./TimeField.js";
 export * from "./TollFreeCampaign.js";
 export * from "./TollFreeCampaignStatus.js";
 export * from "./TollFreeCampaignSummary.js";
@@ -174,6 +224,7 @@ export * from "./TollFreeStatusEnum.js";
 export * from "./Tracking.js";
 export * from "./UpdatedContactId.js";
 export * from "./UploadResults.js";
+export * from "./UrlField.js";
 export * from "./UserButtonPress.js";
 export * from "./UserButtonPressCall.js";
 export * from "./UserButtonPressOpenUrl.js";
@@ -192,6 +243,7 @@ export * from "./VcardContent.js";
 export * from "./VcardEmail.js";
 export * from "./VcardPhone.js";
 export * from "./VcardResource.js";
+export * from "./VerificationStatus.js";
 export * from "./VettingFeedback.js";
 export * from "./VettingHistory.js";
 export * from "./VettingResults.js";

package/dist/cjs/api/types/index.js

@@ -14,6 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./AddressField.js"), exports);
 __exportStar(require("./AdvancedPhoneInformation.js"), exports);
 __exportStar(require("./AgentEmailEntry.js"), exports);
 __exportStar(require("./AgentPhoneEntry.js"), exports);
@@ -38,10 +39,17 @@ __exportStar(require("./ButtonClicked.js"), exports);
 __exportStar(require("./ButtonClickedData.js"), exports);
 __exportStar(require("./CampaignEnum.js"), exports);
 __exportStar(require("./CampaignQuery.js"), exports);
+__exportStar(require("./CampaignStatusEvent.js"), exports);
+__exportStar(require("./CampaignStatusEventAgent.js"), exports);
+__exportStar(require("./CampaignStatusEventBrand.js"), exports);
+__exportStar(require("./CampaignStatusEventCampaign.js"), exports);
+__exportStar(require("./CampaignStatusEventCarrierLaunches.js"), exports);
 __exportStar(require("./CampaignSubmissionResult.js"), exports);
 __exportStar(require("./CampaignValidationResult.js"), exports);
 __exportStar(require("./CarrierLaunches.js"), exports);
 __exportStar(require("./CarrierLaunchStatus.js"), exports);
+__exportStar(require("./CheckboxField.js"), exports);
+__exportStar(require("./ColorField.js"), exports);
 __exportStar(require("./CompanyEntityTypeEnum.js"), exports);
 __exportStar(require("./CompanySectorEnum.js"), exports);
 __exportStar(require("./CompanyTypeEnum.js"), exports);
@@ -49,7 +57,10 @@ __exportStar(require("./Contact.js"), exports);
 __exportStar(require("./ContactId.js"), exports);
 __exportStar(require("./Conversation.js"), exports);
 __exportStar(require("./ConversationList.js"), exports);
+__exportStar(require("./CreateFormRequest.js"), exports);
 __exportStar(require("./CreateUrlOptions.js"), exports);
+__exportStar(require("./DateField.js"), exports);
+__exportStar(require("./DatetimeField.js"), exports);
 __exportStar(require("./DeleteAudienceResponse.js"), exports);
 __exportStar(require("./DetachedPhoneNumberResult.js"), exports);
 __exportStar(require("./DetachWebhookResult.js"), exports);
@@ -59,6 +70,7 @@ __exportStar(require("./DlcCampaignStatus.js"), exports);
 __exportStar(require("./DlcCampaignSummary.js"), exports);
 __exportStar(require("./DlcCampaignUseCaseEnum.js"), exports);
 __exportStar(require("./DlcCampaignWithExtendedBrandAndStatus.js"), exports);
+__exportStar(require("./EmailField.js"), exports);
 __exportStar(require("./EnhancedContact.js"), exports);
 __exportStar(require("./EnhancedContactItem.js"), exports);
 __exportStar(require("./Error_.js"), exports);
@@ -67,6 +79,27 @@ __exportStar(require("./ExtendedBrandWithVetting.js"), exports);
 __exportStar(require("./ExtendedRcsCampaign.js"), exports);
 __exportStar(require("./FailedSender.js"), exports);
 __exportStar(require("./FallbackMessage.js"), exports);
+__exportStar(require("./FieldBase.js"), exports);
+__exportStar(require("./Form.js"), exports);
+__exportStar(require("./FormBackground.js"), exports);
+__exportStar(require("./FormBackgroundGradient.js"), exports);
+__exportStar(require("./FormBackgroundImage.js"), exports);
+__exportStar(require("./FormBackgroundPattern.js"), exports);
+__exportStar(require("./FormBackgroundSolid.js"), exports);
+__exportStar(require("./FormColorPalette.js"), exports);
+__exportStar(require("./FormDefinition.js"), exports);
+__exportStar(require("./FormField.js"), exports);
+__exportStar(require("./FormFieldOption.js"), exports);
+__exportStar(require("./FormGradient.js"), exports);
+__exportStar(require("./FormIdReference.js"), exports);
+__exportStar(require("./FormSubmission.js"), exports);
+__exportStar(require("./FormSubmissionAnswer.js"), exports);
+__exportStar(require("./FormSubmissionEvent.js"), exports);
+__exportStar(require("./FormSubmissionEventConversation.js"), exports);
+__exportStar(require("./FormSubmissionEventForm.js"), exports);
+__exportStar(require("./FormSubmissionEventSubmission.js"), exports);
+__exportStar(require("./FormSubmittedField.js"), exports);
+__exportStar(require("./FormThemeOverride.js"), exports);
 __exportStar(require("./GetConversationParams.js"), exports);
 __exportStar(require("./LinkClickEvent.js"), exports);
 __exportStar(require("./LinkSummary.js"), exports);
@@ -76,6 +109,8 @@ __exportStar(require("./ListBlastsResponse.js"), exports);
 __exportStar(require("./ListBrandsResponse.js"), exports);
 __exportStar(require("./ListContactsResponse.js"), exports);
 __exportStar(require("./ListDlcCampaignsResponse.js"), exports);
+__exportStar(require("./ListFormSubmissionsResponse.js"), exports);
+__exportStar(require("./ListFormsResponse.js"), exports);
 __exportStar(require("./ListLinksResponse.js"), exports);
 __exportStar(require("./ListMessagesResponse.js"), exports);
 __exportStar(require("./ListPhoneNumbersResponse.js"), exports);
@@ -108,6 +143,7 @@ __exportStar(require("./MessagingProfileEnum.js"), exports);
 __exportStar(require("./MmsContent.js"), exports);
 __exportStar(require("./MmsValidationResult.js"), exports);
 __exportStar(require("./NotFoundErrorBody.js"), exports);
+__exportStar(require("./NumberField.js"), exports);
 __exportStar(require("./NumberFormat.js"), exports);
 __exportStar(require("./OptInMethodEnum.js"), exports);
 __exportStar(require("./OptionalBrandInfo.js"), exports);
@@ -118,12 +154,16 @@ __exportStar(require("./Pagination.js"), exports);
 __exportStar(require("./PhoneCapabilities.js"), exports);
 __exportStar(require("./PhoneEnum.js"), exports);
 __exportStar(require("./PhoneFeatureEnum.js"), exports);
+__exportStar(require("./PhoneField.js"), exports);
 __exportStar(require("./PhoneNumberDetails.js"), exports);
 __exportStar(require("./PhoneNumberEnum.js"), exports);
 __exportStar(require("./PhoneNumberStatus.js"), exports);
 __exportStar(require("./PhoneNumberStatusEnum.js"), exports);
 __exportStar(require("./ProfileStatusEnum.js"), exports);
 __exportStar(require("./PurchasedNumber.js"), exports);
+__exportStar(require("./RadioField.js"), exports);
+__exportStar(require("./RangeField.js"), exports);
+__exportStar(require("./RatingField.js"), exports);
 __exportStar(require("./RcsAgentDetails.js"), exports);
 __exportStar(require("./RcsAgentResponse.js"), exports);
 __exportStar(require("./RcsButtonCall.js"), exports);
@@ -157,9 +197,16 @@ __exportStar(require("./RichText.js"), exports);
 __exportStar(require("./RichTextMessage.js"), exports);
 __exportStar(require("./ScheduleCancelResult.js"), exports);
 __exportStar(require("./ScheduledBlastDetails.js"), exports);
+__exportStar(require("./ScheduledFormSendResult.js"), exports);
 __exportStar(require("./ScheduledMessage.js"), exports);
 __exportStar(require("./ScheduledMessageSummary.js"), exports);
+__exportStar(require("./SelectField.js"), exports);
 __exportStar(require("./Sender.js"), exports);
+__exportStar(require("./SendFormOptions.js"), exports);
+__exportStar(require("./SendFormParams.js"), exports);
+__exportStar(require("./SendFormResult.js"), exports);
+__exportStar(require("./SendFormViaRcsParams.js"), exports);
+__exportStar(require("./SendFormViaSmsParams.js"), exports);
 __exportStar(require("./SendRichMessageOptions4.js"), exports);
 __exportStar(require("./SendTypingIndicatorResponse.js"), exports);
 __exportStar(require("./SentMmsDetails.js"), exports);
@@ -181,6 +228,9 @@ __exportStar(require("./SubUseCaseEnum.js"), exports);
 __exportStar(require("./SuccessfulConversationUpdate.js"), exports);
 __exportStar(require("./TestAgentResponse.js"), exports);
 __exportStar(require("./TestAgentWhitelistResponse.js"), exports);
+__exportStar(require("./TextareaField.js"), exports);
+__exportStar(require("./TextField.js"), exports);
+__exportStar(require("./TimeField.js"), exports);
 __exportStar(require("./TollFreeCampaign.js"), exports);
 __exportStar(require("./TollFreeCampaignStatus.js"), exports);
 __exportStar(require("./TollFreeCampaignSummary.js"), exports);
@@ -190,6 +240,7 @@ __exportStar(require("./TollFreeStatusEnum.js"), exports);
 __exportStar(require("./Tracking.js"), exports);
 __exportStar(require("./UpdatedContactId.js"), exports);
 __exportStar(require("./UploadResults.js"), exports);
+__exportStar(require("./UrlField.js"), exports);
 __exportStar(require("./UserButtonPress.js"), exports);
 __exportStar(require("./UserButtonPressCall.js"), exports);
 __exportStar(require("./UserButtonPressOpenUrl.js"), exports);
@@ -208,6 +259,7 @@ __exportStar(require("./VcardContent.js"), exports);
 __exportStar(require("./VcardEmail.js"), exports);
 __exportStar(require("./VcardPhone.js"), exports);
 __exportStar(require("./VcardResource.js"), exports);
+__exportStar(require("./VerificationStatus.js"), exports);
 __exportStar(require("./VettingFeedback.js"), exports);
 __exportStar(require("./VettingHistory.js"), exports);
 __exportStar(require("./VettingResults.js"), exports);

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "2.0.19";
+export declare const SDK_VERSION = "2.0.21";

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.19";
+exports.SDK_VERSION = "2.0.21";

package/dist/cjs/wrapper/messages/Client.d.ts

@@ -8,6 +8,6 @@ interface ExpressLikeRequest {
     originalUrl?: string;
 }
 export declare class EnhancedMessages extends Messages {
-    process(req: Request | ExpressLikeRequest, secret?: string): Promise<Pinnacle.MessageEvent | Pinnacle.UserEvent>;
+    process(req: Request | ExpressLikeRequest, secret?: string): Promise<Pinnacle.MessageEvent | Pinnacle.UserEvent | Pinnacle.FormSubmissionEvent | Pinnacle.CampaignStatusEvent>;
 }
 export {};

package/dist/esm/Client.d.mts

@@ -3,6 +3,7 @@ import { Brands } from "./api/resources/brands/client/Client.mjs";
 import { Campaigns } from "./api/resources/campaigns/client/Client.mjs";
 import { Contacts } from "./api/resources/contacts/client/Client.mjs";
 import { Conversations } from "./api/resources/conversations/client/Client.mjs";
+import { Forms } from "./api/resources/forms/client/Client.mjs";
 import { Messages } from "./api/resources/messages/client/Client.mjs";
 import { PhoneNumbers } from "./api/resources/phoneNumbers/client/Client.mjs";
 import { Rcs } from "./api/resources/rcs/client/Client.mjs";
@@ -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/esm/Client.mjs

@@ -4,6 +4,7 @@ import { Brands } from "./api/resources/brands/client/Client.mjs";
 import { Campaigns } from "./api/resources/campaigns/client/Client.mjs";
 import { Contacts } from "./api/resources/contacts/client/Client.mjs";
 import { Conversations } from "./api/resources/conversations/client/Client.mjs";
+import { Forms } from "./api/resources/forms/client/Client.mjs";
 import { Messages } from "./api/resources/messages/client/Client.mjs";
 import { PhoneNumbers } from "./api/resources/phoneNumbers/client/Client.mjs";
 import { Rcs } from "./api/resources/rcs/client/Client.mjs";
@@ -17,8 +18,8 @@ export class PinnacleClient {
         this._options = Object.assign(Object.assign({}, _options), { logging: core.logging.createLogger(_options === null || _options === void 0 ? void 0 : _options.logging), headers: 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) });
@@ -55,6 +56,10 @@ export class PinnacleClient {
         var _a;
         return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new Webhooks(this._options)));
     }
+    get forms() {
+        var _a;
+        return ((_a = this._forms) !== null && _a !== void 0 ? _a : (this._forms = new Forms(this._options)));
+    }
     get campaigns() {
         var _a;
         return ((_a = this._campaigns) !== null && _a !== void 0 ? _a : (this._campaigns = new Campaigns(this._options)));

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

@@ -0,0 +1,171 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as Pinnacle from "../../../index.mjs";
+import { Submissions } from "../resources/submissions/client/Client.mjs";
+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>>;
+}