rcs-js 2.0.19 → 2.0.21

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

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

package/dist/esm/version.d.mts

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

package/dist/esm/version.mjs

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

package/dist/esm/wrapper/messages/Client.d.mts

@@ -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/package.json

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

package/reference.md

@@ -2311,6 +2311,409 @@ await client.webhooks.detach({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+## Forms
+<details><summary><code>client.forms.<a href="/src/api/resources/forms/client/Client.ts">get</a>(id) -> Pinnacle.Form</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieve a form by id. Includes submission count, last submission timestamp, and archive state.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.forms.get("form_Oy2n7iUoi9CJwUU6");
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `string` 
+
+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`).
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Forms.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.forms.<a href="/src/api/resources/forms/client/Client.ts">update</a>(id, { ...params }) -> Pinnacle.Form</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.forms.update("form_Oy2n7iUoi9CJwUU6", {
+    name: "Contact request (v2)",
+    can_update: true,
+    expires_at: "2026-12-31T23:59:59Z"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `string` 
+
+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`.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Pinnacle.UpdateFormParams` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Forms.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.forms.<a href="/src/api/resources/forms/client/Client.ts">list</a>({ ...params }) -> Pinnacle.ListFormsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Paginated list of forms on your team, sorted by creation date (newest first). Includes archived forms.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.forms.list({
+    pageIndex: 0,
+    pageSize: 20
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Pinnacle.ListFormsParams` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Forms.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.forms.<a href="/src/api/resources/forms/client/Client.ts">create</a>({ ...params }) -> Pinnacle.Form</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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).
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+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
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Pinnacle.CreateFormRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Forms.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.forms.<a href="/src/api/resources/forms/client/Client.ts">send</a>({ ...params }) -> Pinnacle.FormsSendResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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).
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.forms.send({
+    from: "agent_iM9wQcyBBjYn",
+    to: "+14155551234",
+    form: "form_Oy2n7iUoi9CJwUU6",
+    fallback: {
+        from: "+14155550000"
+    },
+    options: {
+        webview_mode: "FULL"
+    }
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Pinnacle.SendFormParams` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Forms.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -3756,6 +4159,84 @@ await client.campaigns.rcs.list();
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+## Forms Submissions
+<details><summary><code>client.forms.submissions.<a href="/src/api/resources/forms/resources/submissions/client/Client.ts">list</a>(id, { ...params }) -> Pinnacle.ListFormSubmissionsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Paginated list of completed submissions for a form, newest first. Each row includes the submitted `data` keyed by field `key`, the sender/recipient, IP, user-agent, and timestamps.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.forms.submissions.list("form_Oy2n7iUoi9CJwUU6", {
+    pageIndex: 0,
+    pageSize: 20
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `string` 
+
+The unique identifier of the form whose submissions you want to list.
+<br><br> This identifier is a string that always begins with the prefix `form_`, for example: `form_Oy2n7iUoi9CJwUU6`.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Pinnacle.forms.ListFormSubmissionsParams` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Submissions.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>