@inklok/api-spec 7.3.0 → 7.5.0

package/openapi.yaml

@@ -8,7 +8,7 @@ info:
     Authenticate using an API key or bearer token, then use the resources below to manage
     templates, agreements, documents, and signing. For your first integration, start with
     the Quick Start guide.
-  version: "7.3.0"
+  version: "7.5.0"
   contact:
     name: Inklok API Support
     email: support@inklok.com
@@ -2208,12 +2208,29 @@ paths:
         sent to recipients. Recipient email address is not used for visibility.
         The endpoint uses an explicit allowlist of agreement lifecycle email event
         types and never returns authentication, identity, invitation, security, or
-        generic outbound email history. Each item includes the rendered simulated
-        email HTML and plain-text body when the simulated email content is available.
+        generic outbound email history. List items are summary-only and do not
+        include rendered email bodies.
       x-required-roles: [workflow-editor, workflow-operator, agreement-auditor, organization-admin, platform-super-admin]
       x-required-scopes: [agreements:read]
       tags:
         - Me
+      parameters:
+        - name: limit
+          in: query
+          required: false
+          schema:
+            type: integer
+            minimum: 1
+            maximum: 50
+            default: 25
+          description: Maximum number of inbox items to return.
+        - name: cursor
+          in: query
+          required: false
+          schema:
+            type: string
+            nullable: true
+          description: Opaque pagination cursor returned by a previous response.
       responses:
         '200':
           description: Simulated Sandbox agreement emails for the authenticated user
@@ -2562,10 +2579,13 @@ paths:
                     type: array
                     items:
                       type: object
-                      required: [field_id, page, x, y, type, party_id]
+                      required: [field_id, label, page, x, y, type, party_id]
                       properties:
                         field_id:
                           type: string
+                        label:
+                          type: string
+                          description: Display label copied from the source template placeholder, when provided.
                         order:
                           type: integer
                         page:
@@ -3307,8 +3327,6 @@ components:
         - sender
         - subject
         - preview
-        - htmlBody
-        - textBody
         - sentAt
       properties:
         messageId:
@@ -3331,12 +3349,6 @@ components:
           nullable: true
         preview:
           type: string
-        htmlBody:
-          type: string
-          nullable: true
-        textBody:
-          type: string
-          nullable: true
         sentAt:
           type: string
           format: date-time
@@ -3345,6 +3357,8 @@ components:
       type: object
       required:
         - items
+        - nextCursor
+        - hasMore
         - count
         - generatedAt
       properties:
@@ -3352,6 +3366,12 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/SandboxInboxItem'
+        nextCursor:
+          type: string
+          nullable: true
+          description: Opaque cursor for the next page, or null when no next page is available.
+        hasMore:
+          type: boolean
         count:
           type: integer
         generatedAt:
@@ -4946,7 +4966,7 @@ components:
       description: |
         Field placed on a template for a participant to complete.
         Coordinates are normalized to the document page.
-      required: [id, type, role, page, x_norm, y_norm, width_norm, height_norm]
+      required: [id, type, role, label, page, x_norm, y_norm, width_norm, height_norm]
       properties:
         id:
           type: string
@@ -4974,6 +4994,10 @@ components:
         height_norm:
           type: number
           description: Normalized height (0–1)
+        label:
+          type: string
+          minLength: 1
+          description: Display label for the placeholder
         required:
           type: boolean
           description: Whether the placeholder must be completed by the assigned role
@@ -5345,10 +5369,13 @@ components:
 
     ExecutionPlaceholderValue:
       type: object
-      required: [placeholderId, participantId, value, signedAt]
+      required: [placeholderId, label, participantId, value, signedAt]
       properties:
         placeholderId:
           type: string
+        label:
+          type: string
+          description: Display label copied from the source template placeholder, when provided.
         participantId:
           type: string
         value:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inklok/api-spec",
-  "version": "7.3.0",
+  "version": "7.5.0",
   "description": "Canonical OpenAPI specification for the Inklok public API.",
   "main": "openapi.yaml",
   "license": "MIT",