rcs-js 2.0.18 → 2.0.19

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

@@ -0,0 +1,11 @@
+/**
+ * Simulates when a user presses a `call` button.
+ */
+export interface UserButtonPressCall {
+    /** Name of the button that you want to press. */
+    title: string;
+    /** Metadata attached to the button. */
+    metadata?: string;
+    /** Destination phone number in E.164 format. */
+    payload?: string;
+}

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

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

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

@@ -0,0 +1,11 @@
+/**
+ * Simulates when a user presses an `openUrl` button.
+ */
+export interface UserButtonPressOpenUrl {
+    /** Name of the button that you want to press. */
+    title: string;
+    /** Metadata attached to the button. */
+    metadata?: string;
+    /** Destination URL of the tapped button. */
+    payload?: string;
+}

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

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

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

@@ -0,0 +1,22 @@
+/**
+ * Simulates when a user presses a `requestUserLocation` button.
+ */
+export interface UserButtonPressRequestUserLocation {
+    /** Name of the button that you want to press. */
+    title: string;
+    /** Metadata attached to the button. */
+    metadata?: string;
+    /** Location the simulated user responded with. */
+    location?: UserButtonPressRequestUserLocation.Location;
+}
+export declare namespace UserButtonPressRequestUserLocation {
+    /**
+     * Location the simulated user responded with.
+     */
+    interface Location {
+        text?: string;
+        latitude?: number;
+        longitude?: number;
+        address?: string;
+    }
+}

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

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

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

@@ -0,0 +1,15 @@
+/**
+ * Simulates when a user presses a `scheduleEvent` button.
+ */
+export interface UserButtonPressScheduleEvent {
+    /** Name of the button that you want to press. */
+    title: string;
+    /** Metadata attached to the button. */
+    metadata?: string;
+    /** ISO 8601 start time. Defaults to the current time. */
+    eventStartTime?: string;
+    /** ISO 8601 end time. Defaults to one hour after `eventStartTime`. */
+    eventEndTime?: string;
+    eventTitle?: string;
+    eventDescription?: string;
+}

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

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

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

@@ -0,0 +1,24 @@
+/**
+ * Simulates when a user presses a `sendLocation` button.
+ */
+export interface UserButtonPressSendLocation {
+    /** Name of the button that you want to press. */
+    title: string;
+    /** Metadata attached to the button. */
+    metadata?: string;
+    /** Name of the location shared. */
+    name?: string;
+    /** Shared coordinates. */
+    latLong?: UserButtonPressSendLocation.LatLong;
+}
+export declare namespace UserButtonPressSendLocation {
+    /**
+     * Shared coordinates.
+     */
+    interface LatLong {
+        /** Latitude of the shared location. */
+        lat?: number;
+        /** Longitude of the shared location. */
+        lng?: number;
+    }
+}

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

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

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

@@ -0,0 +1,11 @@
+/**
+ * Simulates when a user presses a `trigger` button.
+ */
+export interface UserButtonPressTrigger {
+    /** Name of the button that you want to press. */
+    title: string;
+    /** Metadata attached to the button. */
+    metadata?: string;
+    /** Button's postback payload. */
+    payload?: string;
+}

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

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

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

@@ -153,6 +153,11 @@ export * from "./SentRichMessageFallbackSms.mjs";
 export * from "./SentSmsDetails.mjs";
 export * from "./ShortenedUrl.mjs";
 export * from "./ShortenedUrlWithClickData.mjs";
+export * from "./SimulateMessageInput.mjs";
+export * from "./SimulateUserButton.mjs";
+export * from "./SimulateUserMessage.mjs";
+export * from "./SimulateUserParams.mjs";
+export * from "./SimulateUserResponse.mjs";
 export * from "./SmsContent.mjs";
 export * from "./SmsValidationResult.mjs";
 export * from "./SubmissionResults.mjs";
@@ -169,6 +174,13 @@ export * from "./TollFreeStatusEnum.mjs";
 export * from "./Tracking.mjs";
 export * from "./UpdatedContactId.mjs";
 export * from "./UploadResults.mjs";
+export * from "./UserButtonPress.mjs";
+export * from "./UserButtonPressCall.mjs";
+export * from "./UserButtonPressOpenUrl.mjs";
+export * from "./UserButtonPressRequestUserLocation.mjs";
+export * from "./UserButtonPressScheduleEvent.mjs";
+export * from "./UserButtonPressSendLocation.mjs";
+export * from "./UserButtonPressTrigger.mjs";
 export * from "./UserEvent.mjs";
 export * from "./ValidateCampaignParams.mjs";
 export * from "./ValidationErrorDetails.mjs";

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

@@ -153,6 +153,11 @@ export * from "./SentRichMessageFallbackSms.mjs";
 export * from "./SentSmsDetails.mjs";
 export * from "./ShortenedUrl.mjs";
 export * from "./ShortenedUrlWithClickData.mjs";
+export * from "./SimulateMessageInput.mjs";
+export * from "./SimulateUserButton.mjs";
+export * from "./SimulateUserMessage.mjs";
+export * from "./SimulateUserParams.mjs";
+export * from "./SimulateUserResponse.mjs";
 export * from "./SmsContent.mjs";
 export * from "./SmsValidationResult.mjs";
 export * from "./SubmissionResults.mjs";
@@ -169,6 +174,13 @@ export * from "./TollFreeStatusEnum.mjs";
 export * from "./Tracking.mjs";
 export * from "./UpdatedContactId.mjs";
 export * from "./UploadResults.mjs";
+export * from "./UserButtonPress.mjs";
+export * from "./UserButtonPressCall.mjs";
+export * from "./UserButtonPressOpenUrl.mjs";
+export * from "./UserButtonPressRequestUserLocation.mjs";
+export * from "./UserButtonPressScheduleEvent.mjs";
+export * from "./UserButtonPressSendLocation.mjs";
+export * from "./UserButtonPressTrigger.mjs";
 export * from "./UserEvent.mjs";
 export * from "./ValidateCampaignParams.mjs";
 export * from "./ValidationErrorDetails.mjs";

package/dist/esm/version.d.mts

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

package/dist/esm/version.mjs

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

package/package.json

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

package/reference.md

@@ -4670,6 +4670,76 @@ await client.messages.blasts.list();
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+## Messages Simulate
+<details><summary><code>client.messages.simulate.<a href="/src/api/resources/messages/resources/simulate/client/Client.ts">user</a>({ ...params }) -> Pinnacle.SimulateUserResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Simulate inbound messages and button presses from a user.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.messages.simulate.user({
+    from: "+14155551234",
+    to: "+14155555678",
+    message: {
+        text: "Hello from the test user!"
+    }
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Pinnacle.SimulateUserParams` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Simulate.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>