@inklok/api-spec 7.2.2 → 7.4.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.2.2"
+  version: "7.4.0"
   contact:
     name: Inklok API Support
     email: support@inklok.com
@@ -2051,9 +2051,10 @@ paths:
       summary: Resolve a party signing session
       x-visibility: internal
       description: >
-        Returns a valid signing URL for the requested execution party when that party
-        is the active signer for the agreement. Creates a new magic link if necessary.
-      x-required-roles: [workflow-editor, workflow-operator, agreement-auditor, organization-admin, platform-super-admin]
+        Returns a short-lived signer session for the requested execution party when
+        the authenticated Cognito user is the active signer for the agreement. This
+        endpoint never creates or returns magic links.
+      x-required-roles: []
       tags:
         - Agreements
       parameters:
@@ -2082,10 +2083,19 @@ paths:
               schema:
                 type: object
                 required:
-                  - signingUrl
+                  - signerToken
                 properties:
-                  signingUrl:
+                  signerToken:
+                    type: string
+                  tokenType:
                     type: string
+                    example: Bearer
+                  expiresIn:
+                    type: integer
+                    minimum: 1
+                  expiresAt:
+                    type: string
+                    format: date-time
         '401':
           $ref: '#/components/responses/Unauthorized'
         '403':
@@ -2188,22 +2198,39 @@ paths:
   /me/sandbox/inbox:
     get:
       operationId: listMeSandboxInbox
-      summary: List simulated agreement emails from the current user's sandbox
+      summary: List simulated agreement emails from Sandbox Inbox
       x-visibility: internal
       description: |
         Returns simulated emails generated by sandbox agreement workflows visible
-        to the authenticated account. When an agreement action would normally send
-        a notification to a party, Inklok creates a simulated email in Sandbox Inbox
-        instead. No emails are 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.
+        to the authenticated account or the caller's sandbox API-key organization.
+        When an agreement action would normally send a notification to a party,
+        Inklok creates a simulated email in Sandbox Inbox instead. No emails are
+        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. 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
@@ -2588,13 +2615,14 @@ paths:
       operationId: signingInitiate
       summary: Create a signing session
       description: >
-        Creates a short-lived signing token for the specified agreement participant.
-        Use the token to let that recipient review and complete their signing step.
+        Creates a short-lived signing token for the specified agreement participant
+        only when the caller is that participant. API-key authentication is not
+        supported for this endpoint.
       tags:
         - Signing
       security:
         - bearerAuth: []
-      x-required-scopes: [agreements:write]
+      x-required-roles: []
       requestBody:
         required: true
         content:
@@ -3296,8 +3324,6 @@ components:
         - sender
         - subject
         - preview
-        - htmlBody
-        - textBody
         - sentAt
       properties:
         messageId:
@@ -3320,12 +3346,6 @@ components:
           nullable: true
         preview:
           type: string
-        htmlBody:
-          type: string
-          nullable: true
-        textBody:
-          type: string
-          nullable: true
         sentAt:
           type: string
           format: date-time
@@ -3334,6 +3354,8 @@ components:
       type: object
       required:
         - items
+        - nextCursor
+        - hasMore
         - count
         - generatedAt
       properties:
@@ -3341,6 +3363,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:

package/package.json

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