@celigo/api-specs 0.2.39 → 0.2.41

package/dist/subscription.yml

@@ -38,14 +38,32 @@ paths:
       description: |-
         Returns one account-level license (`type` is `platform`, `integrator`, or
         `endpoint`) plus zero or more `connector`, `integrationApp`, or
-        `integrationAppChild` licenses.
+        `integrationAppChild` licenses, oldest first.
+
+        Pass `type=io` to receive only the account-level license as a single
+        object (not an array) with `_userId` added — use this when you need the
+        subscription plan without filtering the list yourself.
       x-celigo-ai-guidance:
-        - |-
-          AI guidance:
-          - Use this to determine the subscription type (`platform`, `integrator`, `endpoint`, `connector`, etc.) and high-level flags (e.g., sandbox access).
+        - Use this to determine the subscription type (`platform`, `integrator`, `endpoint`, `connector`, etc.) and high-level flags (e.g., sandbox access).
+        - With `?type=io` the response is a single License object, not an array; parse it accordingly.
+      parameters:
+        - name: type
+          in: query
+          required: false
+          description: |-
+            Set to `io` to return only the account-level license as a single object.
+            Any other value is ignored and the full array is returned.
+          schema:
+            type: string
+            enum:
+              - io
+            x-enumDescriptions:
+              io: Return the account-level license (integrator, endpoint, or platform) as one object with `_userId`
+            examples:
+              - io
       responses:
         '200':
-          description: List of licenses
+          description: List of licenses. With `type=io`, a single License object instead of an array.
           content:
             application/json:
               schema:
@@ -67,7 +85,9 @@ paths:
                       disableOverage: false
                       requestUserToMigrateSandbox: false
                       sso: true
+                      scim: false
                       van: true
+                      cdc: true
                       lookupCache: true
                       abstractFlows: true
                       apiManagement: true
@@ -76,7 +96,6 @@ paths:
                       auditLogRetentionYears: 3
                       aiConversationsPrepaidBalance: 47.96
                       aiAgentsPrepaidBalance: 19.62
-                      aiAgentsActions: 10000
                       platform:
                         production:
                           numEndpoints: 600
@@ -108,8 +127,13 @@ paths:
                         numInvocations: 0
                         apimNumInvocations: 0
                         numAddOnInvocations: 0
-                      mcp:
-                        numInvocations: 50000
+                      topics:
+                        enabled: true
+                        topicsAllowed: 20
+                        retentionCeilingDays: 90
+                      lookupCacheUsage:
+                        numUnits: 100000000
+                        numAddOnUnits: 0
                       di:
                         enabled: false
                         volume: 0
@@ -123,6 +147,10 @@ paths:
                       storage:
                         maxAllowedUsage: 200
                         disableOverage: false
+        '204':
+          description: |-
+            The account has no licenses, or `type=io` was requested and the account
+            has no account-level license.
         '401':
           $ref: '#/components/responses/401-unauthorized'
   /v1/licenseEntitlementUsage:
@@ -222,8 +250,8 @@ paths:
                     syncUsage:
                       entitlement: 0
                       volume: 0
-                    mcpUsage:
-                      numInvocations: 340
+                    lookupCacheUsage:
+                      numUnits: 4820
                     aiAgentsActionsUsage: 87
         '401':
           $ref: '#/components/responses/401-unauthorized'
@@ -464,6 +492,16 @@ components:
           x-celigo-refModel: licenses
           description: License identifier.
           example: 624cb0356309dc3a543733a4
+        _userId:
+          type: string
+          format: objectId
+          readOnly: true
+          x-celigo-refModel: users
+          description: |-
+            Account owner the license belongs to. Present only on the single-object
+            response of `GET /v1/licenses?type=io`; absent from the array response.
+          examples:
+            - 624cb0346309dc3a543733a2
         created:
           type: string
           format: date-time
@@ -618,6 +656,14 @@ components:
           type: boolean
           description: When true, the plan entitles the account to use SSO (Single Sign-On).
           example: true
+        scim:
+          type: boolean
+          description: |-
+            When true, the plan entitles the account to provision users through SCIM.
+            Derived from the SCIM add-on together with `sso` — reads false whenever the
+            plan does not also entitle SSO. Present on account-level licenses.
+          examples:
+            - false
         van:
           type: boolean
           description: When true, the plan entitles the account to use VAN (Value Added Network) for EDI.
@@ -661,20 +707,60 @@ components:
             hooks). Customers purchase credits up front and usage costs are
             deducted as AI agents run. This balance is separate from Ora credits.
           example: 19.62
-        aiAgentsActions:
-          type: integer
-          description: Total AI agent action entitlement for the current billing period.
-          example: 10000
-        mcp:
+        topics:
           type: object
-          description: MCP (Model Context Protocol) server entitlements.
+          description: |-
+            Event Streams (topics) entitlements. Present on `endpoint` and `platform`
+            licenses; a plan without Event Streams carries only `enabled: false`, and the
+            two limits appear once `enabled` is true.
           required:
-            - numInvocations
+            - enabled
           properties:
-            numInvocations:
+            enabled:
+              type: boolean
+              description: When true, the plan entitles the account to create topics and use Event Streams.
+              examples:
+                - true
+            topicsAllowed:
               type: integer
-              description: Base number of MCP server invocations per month included with the plan.
-              example: 50000
+              minimum: 0
+              description: |-
+                Maximum number of topics the account may hold. Enforced when a topic is
+                created or restored from the recycle bin.
+              examples:
+                - 20
+            retentionCeilingDays:
+              type: integer
+              minimum: 1
+              maximum: 90
+              description: |-
+                Longest message retention (in days) a topic may be configured with. Trial
+                accounts read a lower ceiling than paid plans.
+              examples:
+                - 90
+        lookupCacheUsage:
+          type: object
+          description: |-
+            Monthly lookup-cache unit entitlement; every read and write against a lookup
+            cache consumes units. Present on `endpoint` and `platform` licenses whose plan
+            includes lookup-cache units. Compare with `lookupCacheUsage.numUnits` on
+            `GET /v1/licenseEntitlementUsage` for consumption.
+          required:
+            - numUnits
+            - numAddOnUnits
+          properties:
+            numUnits:
+              type: integer
+              minimum: 0
+              description: Base number of lookup-cache units per month included with the plan.
+              examples:
+                - 100000000
+            numAddOnUnits:
+              type: integer
+              minimum: 0
+              description: Additional lookup-cache units per month the customer purchased as add-ons.
+              examples:
+                - 0
         di:
           type: object
           description: Data Interchange (DI) entitlements.
@@ -1278,17 +1364,27 @@ components:
               type: integer
               description: Sync volume consumed against the entitlement.
               example: 0
-        mcpUsage:
+        lookupCacheUsage:
           type: object
-          description: MCP server invocation counts.
+          description: |-
+            Lookup-cache consumption for the current calendar month. Present when the
+            plan entitles lookup caches; compare `numUnits` with the license's
+            `lookupCacheUsage.numUnits` plus `numAddOnUnits`.
+          required:
+            - numUnits
           properties:
-            numInvocations:
+            numUnits:
               type: integer
-              description: Number of MCP invocations for the current period.
-              example: 340
+              minimum: 0
+              description: Lookup-cache units consumed this month — every read and write against a lookup cache counts.
+              examples:
+                - 4820
         aiAgentsActionsUsage:
           type: integer
-          description: Number of AI agent actions consumed for the current period.
+          description: |-
+            AI agent actions consumed in the current billing period, including billable
+            MCP server invocations (tool calls and resource reads). Metered on production
+            usage only.
           example: 87
     EDILabelPrintingUsageSummary:
       type: object

package/dist/template.yml

@@ -70,6 +70,7 @@ paths:
                   value:
                     - _id: 67ffe71a4432714ded99e81b
                       name: Salesforce to NetSuite sync
+                      type: integration
                       description: Bi-directional sync of contacts between Salesforce and NetSuite.
                       websiteURL: https://example.com/templates/sf-ns
                       contactEmail: partner@example.com
@@ -176,6 +177,7 @@ paths:
                   value:
                     _id: 67ffe71a4432714ded99e81b
                     name: Salesforce to NetSuite sync
+                    type: integration
                     description: Bi-directional sync of contacts between Salesforce and NetSuite.
                     websiteURL: https://example.com/templates/sf-ns
                     contactEmail: partner@example.com
@@ -252,6 +254,7 @@ paths:
                   value:
                     _id: 67ffe71a4432714ded99e81b
                     name: Salesforce to NetSuite sync
+                    type: integration
                     description: Updated description for the marketplace listing.
                     websiteURL: https://example.com/templates/sf-ns
                     contactEmail: new-contact@example.com
@@ -321,6 +324,11 @@ paths:
         `connectionMap` that maps each template-defined connection ID to an actual
         connection ID in the caller's account. Every template connection must
         appear as a key in `connectionMap`.
+
+        Only templates whose `type` is `integration` install here. A template
+        whose `type` is `mcpserver` is rejected before anything is created —
+        install it with `POST /v1/mcpservers/template/{_templateId}` instead.
+        Check `type` on the `GET /v1/templates/{_id}/preview` response first.
       parameters:
         - name: _id
           in: path
@@ -377,7 +385,10 @@ paths:
                   value:
                     _integrationId: 6405b9d73496e05ff253d587
         '400':
-          description: Missing or empty `connectionMap`.
+          description: |-
+            Missing or empty `connectionMap`, or the template is an MCP server
+            template that must be installed through
+            `POST /v1/mcpservers/template/{_templateId}`.
           content:
             application/json:
               schema:
@@ -388,6 +399,12 @@ paths:
                     errors:
                       - code: invalid_connectionMap
                         message: connectionMap is required.
+                mcpServerTemplate:
+                  summary: Template type is mcpserver
+                  value:
+                    errors:
+                      - code: invalid_template
+                        message: MCP server templates cannot be installed through the Integration template path.
         '401':
           $ref: '#/components/responses/401-unauthorized'
         '403':
@@ -663,6 +680,22 @@ components:
               description: Display name of the template.
               examples:
                 - Salesforce to NetSuite sync
+            type:
+              type: string
+              enum:
+                - integration
+                - mcpserver
+              x-enumDescriptions:
+                integration: Installs an integration with its flows, connections, and supporting resources via `POST /v1/integrations/template/{_id}`
+                mcpserver: Installs an MCP server with its tools via `POST /v1/mcpservers/template/{_templateId}`
+              description: |-
+                Kind of resource the template installs, which decides the install
+                route. Assigned by the server from the uploaded zip (a root
+                `mcpserver.json` makes it `mcpserver`, a root `integration.json`
+                makes it `integration`) and not settable through this API; present
+                once a zip has been uploaded.
+              examples:
+                - integration
             description:
               type: string
               description: Longer description shown in the marketplace.