n8n-nodes-sudomock 0.1.5 → 0.3.0

package/README.md

@@ -17,7 +17,28 @@ n8n community node for the SudoMock API. Integrate mockup rendering into your n8
 - **Delete Mockup**: Delete a specific mockup template
 
 ### Rendering
-- **Render Mockup**: Generate mockups by combining templates with your designs
+- **Render Mockup**: Generate mockups by combining templates with your designs. Optionally run asynchronously with the **Run Asynchronously** toggle, which returns a `job_id` to track with **Get Job**.
+- **Render Video**: Turn a mockup (or an existing image URL) into a short product video (always asynchronous). Pick a duration valid for the model, optional audio/motion, an optional one-off webhook, and optionally **Wait for Completion** to return the finished clip.
+
+### Async Jobs
+- **Get Job**: Get the status and result of an async render, upload, or video job by its `job_id`. Terminal statuses are `succeeded`, `failed`, and `cancelled` (pending jobs report `queued`). On success it surfaces `result_url` (render/video) or `mockup_uuid` (upload). Optionally **Wait for Completion** to poll until the job finishes.
+- **List Jobs**: List your async render, upload, and video jobs (keyset paginated, with optional `kind` and Mockup UUID filters).
+
+### Webhooks
+Manage webhook endpoints that receive a signed HTTPS request the moment a job finishes:
+- **Webhook: List Endpoints**
+- **Webhook: Get Endpoint**
+- **Webhook: Create Endpoint** (set an optional description and choose any of the six canonical events, or leave empty for all)
+- **Webhook: Update Endpoint**
+- **Webhook: Delete Endpoint**
+- **Webhook: Rotate Secret**
+- **Webhook: Send Test**
+- **Webhook: List Deliveries**
+- **Webhook: Replay Delivery**
+- **Webhook: Replay Failed Deliveries**
+- **Webhook: Events Feed** (recent deliveries across all of your endpoints)
+
+Canonical events: `render.succeeded`, `render.failed`, `upload.succeeded`, `video.succeeded`, `video.failed`, `webhook.test`. Deliveries are HMAC-signed; see https://sudomock.com/docs/api/webhooks for the current signature header and verification details.
 
 ## Installation
 
@@ -193,7 +214,7 @@ Generate a mockup by filling smart objects with your designs.
 
 - **Export Options** (optional):
   - Image Format: WebP (recommended), PNG, or JPEG
-  - Image Size: Width in pixels (100-8000)
+  - Image Size: Width in pixels (100-10000, default 2048)
   - Quality: 1-100 for JPG/WebP
   - Export Label: Custom label for file naming
 
@@ -246,6 +267,72 @@ Deletion confirmation
 
 ---
 
+### Render Video
+
+Turn a mockup (or an existing image URL) into a short product video. Always asynchronous: returns a `job_id` you can track with **Get Job**.
+
+**Parameters:**
+- **Input Mode**: `Render Mockup` (render a mockup with your designs first) or `Animate Image URL` (animate a public image directly)
+- **Mockup UUID** (required in Render Mockup mode): UUID of the mockup to animate
+- **Smart Objects** (required in Render Mockup mode): one or more smart objects with a Design URL and Fit Mode
+- **Image URL** (required in Animate Image URL mode): public HTTPS image (`.png`, `.jpg`, `.jpeg`, `.webp`, `.gif`, `.avif`)
+- **Webhook URL** (optional): one-off HTTPS URL notified when this job finishes
+- **Video Options**:
+  - **Duration (Seconds)**: clip length (default 4; must be an allowed duration for the chosen model — the default model `veo-3.1-fast` allows 4, 6, or 8; max 15)
+  - **Audio**: include a generated audio track (default false; may cost extra credits depending on model)
+  - **Motion**: `ambient` (default) or `showcase`
+  - **Advanced Model**: optional override pinning a roster model (`veo-3.1-fast`, `kling-v3-pro`, `kling-2.6-pro`, `seedance-2.0`, `wan-2.5`); leave empty to auto-pick by plan tier
+- **Wait for Completion**: poll the job and return the finished clip instead of the queued job
+- **Poll Timeout (Seconds)**: max wait when Wait for Completion is on
+
+**Output:**
+The 202 acknowledgement (`job_id`, `kind`, `status`, `status_url`, `estimated_credits`, ...), or the finished job (with `result_url` / `resultUrl`) when Wait for Completion is on.
+
+---
+
+### Get Job
+
+Track an asynchronous render, upload, or video job by its `job_id`.
+
+**Parameters:**
+- **Job ID** (required): the `job_id` from an async render, upload, or video request
+- **Wait for Completion**: poll until a terminal status (`succeeded`, `failed`, `cancelled`)
+- **Poll Timeout (Seconds)**: max wait when Wait for Completion is on
+
+**Output:**
+The job object. On success it surfaces `result_url` / `resultUrl` (render/video) or `mockup_uuid` / `resultMockupUuid` (upload), plus `credits_charged` and `payg` when applicable.
+
+---
+
+### List Jobs
+
+List your async render, upload, and video jobs (newest first, keyset paginated).
+
+**Parameters (all optional, under Filters):**
+- **Kind**: `render`, `upload`, or `video`
+- **Mockup UUID**: only jobs derived from this source mockup
+- **Limit**: 1-50 (default 20)
+- **Cursor**: opaque `next_cursor` from a previous response for pagination
+
+**Output:**
+`{ jobs: [...], next_cursor }`.
+
+> **Note:** Bulk "delete all mockups" is intentionally not exposed — the BE gates `DELETE /mockups/all` to dashboard (Bearer/JWT) auth only, so it is not callable with an API key. Delete mockups individually with **Delete Mockup**, or use the SudoMock dashboard.
+
+---
+
+### Webhook Operations
+
+Manage webhook endpoints and their deliveries. See the [Webhooks](#webhooks) feature list above for the full operation set and the canonical event types.
+
+**Common parameters:**
+- **Webhook Endpoint ID** (required for get/update/delete/rotate/test/deliveries/replay/replay-failed)
+- **Endpoint URL** + **Description** (create) and **Events** (create/update): leave Events empty to subscribe to all
+- **Delivery ID** (replay)
+- **Webhook: Events Feed** takes no parameters (returns recent deliveries across all your endpoints)
+
+---
+
 ## Example Workflows
 
 Ready-to-use n8n workflows are available in the [`examples/`](./examples) folder:
@@ -253,7 +340,7 @@ Ready-to-use n8n workflows are available in the [`examples/`](./examples) folder
 ### 1. Complete API Test Workflow
 **File**: [`examples/complete-test-workflow.json`](./examples/complete-test-workflow.json)
 
-Tests all 7 operations in sequence:
+Tests the core mockup operations in sequence:
 - Get Account Info → Upload PSD → Get Mockup → List Mockups
 - Render Mockup → Update Name → Verify Update → Delete Mockup