@inklok/api-spec 7.6.0 → 7.6.1

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.6.0"
+  version: "7.6.1"
   contact:
     name: Inklok API Support
     email: support@inklok.com
@@ -435,6 +435,19 @@ paths:
           schema:
             type: string
           description: Organization name or identifier search.
+        - in: query
+          name: limit
+          schema:
+            type: integer
+            minimum: 1
+            maximum: 100
+            default: 25
+          description: Maximum number of organizations to return for browse/search results.
+        - in: query
+          name: cursor
+          schema:
+            type: string
+          description: Opaque pagination cursor returned by the previous response.
       responses:
         '200':
           description: Successfully retrieved Platform entitlement information
@@ -4074,6 +4087,7 @@ components:
         - accountId
         - isPersonal
         - createdAt
+        - entitlement
       properties:
         orgId:
           type: string
@@ -4093,6 +4107,52 @@ components:
         createdAt:
           type: string
           format: date-time
+        entitlement:
+          nullable: true
+          allOf:
+            - $ref: '#/components/schemas/PlatformEntitlementOrganizationSummary'
+
+    PlatformEntitlementOrganizationSummary:
+      type: object
+      required:
+        - plan
+        - subscriptionStatus
+        - source
+        - includedSeats
+        - additionalSeats
+        - effectiveSeatLimit
+        - maxApiRequestsPerMinute
+        - hasCustomSeatOverride
+        - hasCustomApiLimit
+      properties:
+        plan:
+          $ref: '#/components/schemas/PlatformPlan'
+        subscriptionStatus:
+          type: string
+        source:
+          type: string
+          enum:
+            - stored
+            - plan-default
+        includedSeats:
+          type: integer
+          nullable: true
+          minimum: 0
+        additionalSeats:
+          type: integer
+          minimum: 0
+        effectiveSeatLimit:
+          type: integer
+          nullable: true
+          minimum: 0
+        maxApiRequestsPerMinute:
+          type: integer
+          nullable: true
+          minimum: 0
+        hasCustomSeatOverride:
+          type: boolean
+        hasCustomApiLimit:
+          type: boolean
 
     PlatformEntitlementSeats:
       type: object
@@ -4225,6 +4285,7 @@ components:
       required:
         - organizations
         - selected
+        - nextCursor
         - generatedAt
       properties:
         organizations:
@@ -4235,6 +4296,9 @@ components:
           nullable: true
           allOf:
             - $ref: '#/components/schemas/PlatformEntitlementDetail'
+        nextCursor:
+          type: string
+          nullable: true
         generatedAt:
           type: string
           format: date-time

package/package.json

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