react-covideo-embed 1.0.90 → 1.0.95

package/README.md

@@ -51,6 +51,22 @@ Explore the capabilities of react-covideo-embed through our [Demo Project](https
 - **Description**: Determines which Covideo environment to target.
 - **Default**: `'sandbox'`
 
+### `leadOpportunityId` (optional)
+
+- **Type**: `string`
+- **Description**: Lead opportunity ID used to load and send quick videos in the Quick Videos Only flow (`flow: 'quickVideosOnly'`). Use when known; otherwise provide `leadDetails`.
+
+### `leadDetails` (optional)
+
+- **Type**: `LeadDetails`
+- **Description**: Lead contact details used when `leadOpportunityId` is not provided (Quick Videos Only flow).
+- **Properties**:
+  - `leadId`: `string` (optional)
+  - `leadName`: `string` (optional)
+  - `leadEmail`: `string` (optional)
+  - `leadPhone`: `string` (optional)
+  - `vin`: `string` (optional) — vehicle VIN
+
 ### `onVideoInsert` (optional)
 
 - **Type**: function
@@ -71,6 +87,23 @@ Explore the capabilities of react-covideo-embed through our [Demo Project](https
 - **Parameters**:
   - `error`: `unknown` - The error occurred during video insert.
 
+### `onQuickVideoSend` (optional)
+
+- **Type**: `function`
+- **Description**: Callback triggered when a quick video is successfully sent. Only used with the Quick Videos Only flow (`flow: 'quickVideosOnly'`).
+- **Parameters**:
+  - `data`: Object containing quick video job identifiers.
+    - `videoId`: `string` - The ID of the video created for the job.
+    - `quickVideoJobId`: `number` - The created quick video job ID.
+    - `leadOpportunityId`: `string` - The lead opportunity the video was sent to.
+
+### `onQuickVideoSendError` (optional)
+
+- **Type**: `function`
+- **Description**: Callback triggered when there is an error sending a quick video in the Quick Videos Only flow.
+- **Parameters**:
+  - `error`: `unknown` - The error occurred during quick video send.
+
 ### `onRecordButtonClick` (optional)
 
 - **Type**: function