@inklok/api-spec 7.3.0 → 7.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/openapi.yaml +28 -11
  2. package/package.json +1 -1
package/openapi.yaml CHANGED
@@ -8,7 +8,7 @@ info:
8
8
  Authenticate using an API key or bearer token, then use the resources below to manage
9
9
  templates, agreements, documents, and signing. For your first integration, start with
10
10
  the Quick Start guide.
11
- version: "7.3.0"
11
+ version: "7.4.0"
12
12
  contact:
13
13
  name: Inklok API Support
14
14
  email: support@inklok.com
@@ -2208,12 +2208,29 @@ paths:
2208
2208
  sent to recipients. Recipient email address is not used for visibility.
2209
2209
  The endpoint uses an explicit allowlist of agreement lifecycle email event
2210
2210
  types and never returns authentication, identity, invitation, security, or
2211
- generic outbound email history. Each item includes the rendered simulated
2212
- email HTML and plain-text body when the simulated email content is available.
2211
+ generic outbound email history. List items are summary-only and do not
2212
+ include rendered email bodies.
2213
2213
  x-required-roles: [workflow-editor, workflow-operator, agreement-auditor, organization-admin, platform-super-admin]
2214
2214
  x-required-scopes: [agreements:read]
2215
2215
  tags:
2216
2216
  - Me
2217
+ parameters:
2218
+ - name: limit
2219
+ in: query
2220
+ required: false
2221
+ schema:
2222
+ type: integer
2223
+ minimum: 1
2224
+ maximum: 50
2225
+ default: 25
2226
+ description: Maximum number of inbox items to return.
2227
+ - name: cursor
2228
+ in: query
2229
+ required: false
2230
+ schema:
2231
+ type: string
2232
+ nullable: true
2233
+ description: Opaque pagination cursor returned by a previous response.
2217
2234
  responses:
2218
2235
  '200':
2219
2236
  description: Simulated Sandbox agreement emails for the authenticated user
@@ -3307,8 +3324,6 @@ components:
3307
3324
  - sender
3308
3325
  - subject
3309
3326
  - preview
3310
- - htmlBody
3311
- - textBody
3312
3327
  - sentAt
3313
3328
  properties:
3314
3329
  messageId:
@@ -3331,12 +3346,6 @@ components:
3331
3346
  nullable: true
3332
3347
  preview:
3333
3348
  type: string
3334
- htmlBody:
3335
- type: string
3336
- nullable: true
3337
- textBody:
3338
- type: string
3339
- nullable: true
3340
3349
  sentAt:
3341
3350
  type: string
3342
3351
  format: date-time
@@ -3345,6 +3354,8 @@ components:
3345
3354
  type: object
3346
3355
  required:
3347
3356
  - items
3357
+ - nextCursor
3358
+ - hasMore
3348
3359
  - count
3349
3360
  - generatedAt
3350
3361
  properties:
@@ -3352,6 +3363,12 @@ components:
3352
3363
  type: array
3353
3364
  items:
3354
3365
  $ref: '#/components/schemas/SandboxInboxItem'
3366
+ nextCursor:
3367
+ type: string
3368
+ nullable: true
3369
+ description: Opaque cursor for the next page, or null when no next page is available.
3370
+ hasMore:
3371
+ type: boolean
3355
3372
  count:
3356
3373
  type: integer
3357
3374
  generatedAt:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@inklok/api-spec",
3
- "version": "7.3.0",
3
+ "version": "7.4.0",
4
4
  "description": "Canonical OpenAPI specification for the Inklok public API.",
5
5
  "main": "openapi.yaml",
6
6
  "license": "MIT",