@celigo/api-specs 0.2.63 → 0.2.64

package/dist/subscription.yml

@@ -812,29 +812,71 @@ components:
                 - true
         di:
           type: object
-          description: Data Interchange (DI) entitlements.
+          description: |-
+            Data Ingestion (Celigo Sync) entitlements. Every paid edition includes a base
+            allowance — one enabled sync per environment and a monthly loaded-row volume —
+            and a Data Ingestion volume pack adds capacity on top of it. A free trial
+            carries the Enterprise-equivalent allowance for its duration; the free plan
+            after the trial has no Data Ingestion.
           required:
             - enabled
             - volume
             - volumeAddOn
             - disableOverage
+          x-celigo-ai-guidance:
+            - |-
+              Read the entitlement from this block, never from a tier table: `volume` is
+              the edition's included monthly loaded rows and `volumeAddOn` the purchased
+              capacity. A trial's allowance is computed by the platform and is reported
+              here while the trial is active.
+            - |-
+              The entitlement is enforced when a sync is enabled, not when it is created.
+              Saving a sync with `disabled: false` returns `422 di_subscription_required`
+              ("Your license does not support Data Ingestion") when the account has no
+              entitlement, `di_sync_limit_exceeded` when the environment already has an
+              enabled sync and `volumeAddOn` is 0, and `di_usage_limit_exceeded` on volume
+              in two cases: while `histLoadEndDate` is in the future (with `volumeAddOn`
+              above 0), when the month's loaded rows have reached the historical-load cap —
+              regardless of `disableOverage`; otherwise, only when `disableOverage` is in
+              force and the month's loaded rows already exceed the allowance.
           properties:
             enabled:
               type: boolean
-              description: When true, the plan entitles the account to use Data Interchange.
+              description: When true, the plan entitles the account to enable and run Data Ingestion syncs.
               example: false
             volume:
               type: integer
-              description: Base DI volume included with the plan.
+              description: |-
+                Monthly loaded-row allowance included with the edition. Without the add-on,
+                crossing it lets the running job finish and disables the sync from its next
+                run until the next month.
               example: 0
             volumeAddOn:
               type: integer
-              description: Additional DI volume the customer purchased as add-ons.
+              description: |-
+                Additional monthly loaded rows purchased as a Data Ingestion volume pack. With
+                a pack the account is no longer limited to one enabled sync per environment;
+                when the pack lapses, each environment is trimmed back to its most recently
+                run sync.
               example: 0
             disableOverage:
               type: boolean
-              description: When true, Data Interchange overage charges are disabled.
+              description: |-
+                When true, monthly overage is not permitted: once the month's loaded rows
+                reach the allowance, syncs cannot be enabled until the next month. Trial
+                licenses enforce this unless the field is explicitly false. Not consulted
+                while a historical-load window (`histLoadEndDate`) is active.
               example: false
+            histLoadEndDate:
+              type: string
+              format: date-time
+              description: |-
+                End of the historical-load window granted with a volume pack. While this date
+                is in the future and `volumeAddOn` is above 0, the monthly cap is raised to a
+                platform-configured multiple (50 by default) of `volume` plus `volumeAddOn` —
+                still checked per calendar month — and `disableOverage` is not consulted.
+                Absent when no window is active.
+              example: '2026-10-29T00:00:00.000Z'
         api:
           type: object
           description: API Builder plan entitlements and invocation limits.
@@ -1522,7 +1564,7 @@ components:
               example: 0
             diVolume:
               type: integer
-              description: Data Interchange volume consumed during the month.
+              description: Data Ingestion (Celigo Sync) rows loaded during the month.
               example: 0
         allocated:
           type: object

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@celigo/api-specs",
-  "version": "0.2.63",
+  "version": "0.2.64",
   "private": false,
   "description": "Public OpenAPI bundles (dist/) and the celigo-cli lint schema pack (schemas.json).",
   "keywords": [

package/schemas.json

@@ -1,7 +1,7 @@
 {
 	"provenance": {
 		"repo": "celigo/integrator-api-specs",
-		"iasCommit": "27222ec",
+		"iasCommit": "98fb2b4",
 		"generatedAt": "2026-09-29"
 	},
 	"roots": {