@celigo/api-specs 0.2.161 → 0.2.163

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.
package/dist/ai-agent.yml CHANGED
@@ -1299,7 +1299,7 @@ components:
1299
1299
  description: Property names the model must include in the structured output.
1300
1300
  items:
1301
1301
  type: string
1302
- additionalproperties:
1302
+ additionalProperties:
1303
1303
  type: boolean
1304
1304
  description: When true, the structured output may include properties beyond those defined in `properties`.
1305
1305
  schema:
package/dist/alert.yml CHANGED
@@ -176,6 +176,8 @@ paths:
176
176
  Creates a proactive alert. Validates type, flow/integration, and duplicate
177
177
  constraints, then resolves `_recipientEmails` to `_recipientUserIds` and
178
178
  dual-writes the long-runtime threshold onto the related flow document(s).
179
+ A flow read doesn't return that threshold, but the flow's `lastModified`
180
+ moves, and the flow's own audit log gets no entry for it.
179
181
 
180
182
  Requires permission `put:alert:models`. Returns `403` when
181
183
  `ENABLE_PROACTIVE_ALERTS` is off. Response is always unpopulated.
@@ -474,7 +476,9 @@ paths:
474
476
  summary: Delete an alert
475
477
  description: |-
476
478
  Soft-deletes an alert and clears `__longRuntimeThresholdMinutes` on the
477
- related flow document(s). Requires permission `put:alert:models`. Returns
479
+ related flow document(s), which moves each flow's `lastModified`. A
480
+ deleted alert reads 404 and has no recycle-bin entry. Requires permission
481
+ `put:alert:models`. Returns
478
482
  `403` when `ENABLE_PROACTIVE_ALERTS` is off.
479
483
  parameters:
480
484
  - name: _id
package/dist/api.yml CHANGED
@@ -2967,7 +2967,13 @@ components:
2967
2967
  properties:
2968
2968
  id:
2969
2969
  type: string
2970
- description: Unique identifier for this router within the API.
2970
+ maxLength: 36
2971
+ pattern: ^[A-Za-z0-9_-]+$
2972
+ description: |-
2973
+ Unique identifier for this router within the API. Use at most 36 letters, digits,
2974
+ underscores and hyphens: a longer id fails the save with 422 ("Router id is missing or
2975
+ contains more than 36 characters or invalid characters. Please correct the router
2976
+ id."), as on flow routers.
2971
2977
  examples:
2972
2978
  - router_001
2973
2979
  - validation_router
package/dist/export.yml CHANGED
@@ -628,16 +628,19 @@ paths:
628
628
  - Exports
629
629
  summary: Invoke an export and return its data
630
630
  description: |-
631
- Runs an existing export end-to-end and returns the fetched data (or errors)
631
+ Runs an existing export end-to-end and returns its records (or errors)
632
632
  synchronously. Unlike `POST /v1/flows/{_id}/run`, which starts a full flow
633
633
  job, this endpoint invokes a **single export** in isolation and returns the
634
- raw result directly in the response body.
634
+ result directly in the response body.
635
635
 
636
636
  The request body is optional — pass `{}` or omit the body entirely for
637
637
  exports that require no input. Some adaptor types accept a `data` array in
638
638
  the body to supply input records.
639
639
 
640
- On success, the response contains the export's fetched data. On
640
+ On success, the response contains the records as the export hands them
641
+ on: after its transform, output filter and preSavePage hook, so records
642
+ come back in their final shape and records the filter or hook drops aren't
643
+ returned. On
641
644
  application-level failure (e.g. the source system is unreachable), the
642
645
  endpoint still returns a successful HTTP status with the errors in an
643
646
  `errors` array — higher-level error codes are reserved for request-level
@@ -688,7 +691,8 @@ paths:
688
691
  responses:
689
692
  '200':
690
693
  description: |-
691
- Export completed. The response contains either the fetched data or an
694
+ Export completed. The response contains either the export's records
695
+ (after its transform, output filter and preSavePage hook) or an
692
696
  `errors` array if the export encountered application-level failures
693
697
  (connection timeout, file not found, etc.). Always inspect for errors
694
698
  even on 200.
@@ -1340,11 +1344,11 @@ components:
1340
1344
  Once:
1341
1345
  type: object
1342
1346
  description: |-
1343
- Configures flag-based exports that process each record exactly once. Required when the
1344
- export's type is "once"; omit for other export types. Each run retrieves records where the
1345
- tracking boolean field is false, then sets that field to true after successful processing so
1346
- later runs skip them; if a run fails, the flags are left unchanged and the records are
1347
- retried automatically on the next run.
1347
+ Configures flag-based exports that skip records an earlier run already processed. Required
1348
+ when the export's type is "once"; omit for other export types. Each run retrieves records
1349
+ where the tracking boolean field is false, then sets that field to true after successful
1350
+ processing so later runs skip them; if a run fails, the flags are left unchanged and the
1351
+ records are retried automatically on the next run.
1348
1352
  x-celigo-ai-guidance:
1349
1353
  - |-
1350
1354
  This object is REQUIRED when the export's type field is set to "once" and should
@@ -1369,7 +1373,6 @@ components:
1369
1373
  - One-time migrations where data should not be duplicated
1370
1374
  - Processing queues where records are marked as "processed"
1371
1375
  - Compliance scenarios requiring audit trails of exported records
1372
- - Implementing exactly-once delivery semantics
1373
1376
  - |-
1374
1377
  4. Error handling behavior:
1375
1378
  - If the export fails, the boolean fields remain unchanged
@@ -16523,6 +16526,8 @@ components:
16523
16526
  description: |-
16524
16527
  Custom JavaScript hooks that run at fixed points in the export lifecycle for
16525
16528
  transformations, validation, and filtering beyond what configuration alone can express.
16529
+ A hook name not listed here (an import's `preMap`, for example) is dropped on save
16530
+ without an error, so read `hooks` back after saving.
16526
16531
  properties:
16527
16532
  preSavePage:
16528
16533
  type: object
package/dist/flow.yml CHANGED
@@ -4780,11 +4780,17 @@ components:
4780
4780
  properties:
4781
4781
  id:
4782
4782
  type: string
4783
+ maxLength: 36
4784
+ pattern: ^[A-Za-z0-9_-]+$
4783
4785
  description: |
4784
4786
  Unique identifier for this router within the flow.
4785
4787
 
4786
4788
  Used to reference this router from branches (`branches[].nextRouterId`)
4787
4789
  when chaining routers. Must be unique within the flow's router collection.
4790
+ Use at most 36 letters, digits, underscores and hyphens: a longer id, or one
4791
+ with a space or a period, fails the save with 422 ("Router id is missing or
4792
+ contains more than 36 characters or invalid characters. Please correct the
4793
+ router id.").
4788
4794
  examples:
4789
4795
  - router_001
4790
4796
  - customer_type_router
@@ -997,7 +997,7 @@ components:
997
997
  description: Property names the stored JSON Schema marks as required.
998
998
  items:
999
999
  type: string
1000
- additionalproperties:
1000
+ additionalProperties:
1001
1001
  type: boolean
1002
1002
  description: Whether the stored JSON Schema allows properties beyond those in `properties`.
1003
1003
  schema:
package/dist/iclient.yml CHANGED
@@ -318,8 +318,9 @@ paths:
318
318
  x-internal: false
319
319
  summary: Update an iClient
320
320
  description: |-
321
- Replaces an iClient. All mutable fields must be provided — omitted
322
- fields are reset to defaults. Secrets returned as `"******"` can be
321
+ Replaces an existing iClient; create one with `POST /v1/iclients`. All
322
+ mutable fields must be provided — omitted fields are reset to defaults.
323
+ Secrets returned as `"******"` can be
323
324
  sent back as-is to keep the existing value, except a Google service
324
325
  account: every update must include the full JSON key. An Azure
325
326
  service principal keeps its stored `clientSecret` or `certificate`
package/dist/import.yml CHANGED
@@ -9681,7 +9681,7 @@ components:
9681
9681
  description: Property names the model must include in the structured output.
9682
9682
  items:
9683
9683
  type: string
9684
- additionalproperties:
9684
+ additionalProperties:
9685
9685
  type: boolean
9686
9686
  description: When true, the structured output may include properties beyond those defined in `properties`.
9687
9687
  schema:
@@ -11072,7 +11072,7 @@ components:
11072
11072
  description: Property names the stored JSON Schema marks as required.
11073
11073
  items:
11074
11074
  type: string
11075
- additionalproperties:
11075
+ additionalProperties:
11076
11076
  type: boolean
11077
11077
  description: Whether the stored JSON Schema allows properties beyond those in `properties`.
11078
11078
  schema:
@@ -340,8 +340,8 @@ paths:
340
340
  - Integrations
341
341
  description: |-
342
342
  Deletes an integration. The integration is soft-deleted and retained in the
343
- recycle bin for 30 days before permanent removal. Delete the APIs and Tools it
344
- contains, and remove its aliases that point at lookup caches, first.
343
+ recycle bin for 30 days before permanent removal. Delete the flows, syncs, APIs and
344
+ Tools it contains, and remove its aliases that point at lookup caches, first.
345
345
  parameters:
346
346
  - name: _id
347
347
  in: path
@@ -364,12 +364,26 @@ paths:
364
364
  description: |-
365
365
  The integration still contains resources that must be deleted first, APIs and Tools
366
366
  among them (`dependencies_not_deleted`, one entry per blocking resource), or one of its
367
- `aliases[]` still points at a lookup cache.
367
+ `aliases[]` still points at a lookup cache. Flows and syncs block it the same way, with
368
+ one entry per flow or sync still in the integration ("flow <id> must be deleted before
369
+ you can delete integration <id>", "sync <id> must be deleted before you can delete
370
+ integration <id>"), and nothing is deleted.
368
371
  content:
369
372
  application/json:
370
373
  schema:
371
374
  $ref: '#/components/schemas/Error'
372
375
  examples:
376
+ flows_remaining:
377
+ summary: The integration still holds flows
378
+ value:
379
+ errors:
380
+ - message: flow <flowId> must be deleted before you can delete integration <integrationId>
381
+ - message: flow <secondFlowId> must be deleted before you can delete integration <integrationId>
382
+ syncs_remaining:
383
+ summary: The integration still holds a sync
384
+ value:
385
+ errors:
386
+ - message: sync <syncId> must be deleted before you can delete integration <integrationId>
373
387
  lookup_cache_alias:
374
388
  value:
375
389
  errors:
@@ -149,8 +149,9 @@ paths:
149
149
  '200':
150
150
  description: |-
151
151
  Per-item result array (parallel to the request). Each entry is
152
- `{statusCode, errors?}` — `statusCode: 200` on success, or a non-200
153
- status with an `errors[]` array on per-item failures. Overall HTTP is
152
+ `{statusCode, errors?}` — `statusCode` 201 for a created subscription
153
+ and 200 for one that already existed or was removed, or a 4xx status
154
+ with an `errors[]` array on per-item failures. Overall HTTP is
154
155
  still 200 even when individual items fail.
155
156
  content:
156
157
  application/json:
@@ -163,12 +164,13 @@ paths:
163
164
  statusCode:
164
165
  type: integer
165
166
  description: |-
166
- Per-item outcome: 200 when the subscription was created,
167
- updated, or left unchanged; 422 when the referenced
168
- resource doesn't exist (details in `errors[]`).
167
+ Per-item outcome: 201 when the subscription was created;
168
+ 200 when it already existed (subscribing again keeps the one
169
+ record) or was removed; 422 when the referenced resource
170
+ doesn't exist (details in `errors[]`).
169
171
  errors:
170
172
  type: array
171
- description: Per-item error details — present on non-200 results.
173
+ description: Per-item error details — present on 4xx per-item failures, never on a 201 or 200.
172
174
  items:
173
175
  type: object
174
176
  properties:
@@ -186,9 +188,9 @@ paths:
186
188
  - Please ensure that connection with 000000000000000000000001 exists for creating the notification.
187
189
  examples:
188
190
  allSuccess:
189
- summary: All items applied cleanly
191
+ summary: A new subscription and one that already existed
190
192
  value:
191
- - statusCode: 200
193
+ - statusCode: 201
192
194
  - statusCode: 200
193
195
  mixed:
194
196
  summary: One item referenced a non-existent connection
@@ -419,7 +419,9 @@ paths:
419
419
  Resources are auto-purged after 30 days. A purge removes only the
420
420
  named resource: purge the bin entries that still reference it first
421
421
  (a deleted flow references its integration and the exports and imports
422
- it used).
422
+ it used). An integration's Celigo Storage system folder is the
423
+ exception: the folder and everything in it go to the bin with the
424
+ integration and are purged with it.
423
425
  parameters:
424
426
  - $ref: '#/components/parameters/ResourceType'
425
427
  - name: _id
package/dist/tool.yml CHANGED
@@ -6674,10 +6674,15 @@ components:
6674
6674
  properties:
6675
6675
  id:
6676
6676
  type: string
6677
+ maxLength: 36
6678
+ pattern: ^[A-Za-z0-9_-]+$
6677
6679
  description: |
6678
6680
  Unique identifier for this router within the tool.
6679
6681
 
6680
6682
  Used to reference this router from other routers' branch `nextRouterId`.
6683
+ Use at most 36 letters, digits, underscores and hyphens: a longer id fails
6684
+ the save with 422 ("Router id is missing or contains more than 36 characters
6685
+ or invalid characters. Please correct the router id."), as on flow routers.
6681
6686
  examples:
6682
6687
  - router_001
6683
6688
  - validation_router
@@ -21189,7 +21194,7 @@ components:
21189
21194
  description: Property names the model must include in the structured output.
21190
21195
  items:
21191
21196
  type: string
21192
- additionalproperties:
21197
+ additionalProperties:
21193
21198
  type: boolean
21194
21199
  description: When true, the structured output may include properties beyond those defined in `properties`.
21195
21200
  schema:
@@ -22580,7 +22585,7 @@ components:
22580
22585
  description: Property names the stored JSON Schema marks as required.
22581
22586
  items:
22582
22587
  type: string
22583
- additionalproperties:
22588
+ additionalProperties:
22584
22589
  type: boolean
22585
22590
  description: Whether the stored JSON Schema allows properties beyond those in `properties`.
22586
22591
  schema:
@@ -26440,11 +26445,11 @@ components:
26440
26445
  Once:
26441
26446
  type: object
26442
26447
  description: |-
26443
- Configures flag-based exports that process each record exactly once. Required when the
26444
- export's type is "once"; omit for other export types. Each run retrieves records where the
26445
- tracking boolean field is false, then sets that field to true after successful processing so
26446
- later runs skip them; if a run fails, the flags are left unchanged and the records are
26447
- retried automatically on the next run.
26448
+ Configures flag-based exports that skip records an earlier run already processed. Required
26449
+ when the export's type is "once"; omit for other export types. Each run retrieves records
26450
+ where the tracking boolean field is false, then sets that field to true after successful
26451
+ processing so later runs skip them; if a run fails, the flags are left unchanged and the
26452
+ records are retried automatically on the next run.
26448
26453
  x-celigo-ai-guidance:
26449
26454
  - |-
26450
26455
  This object is REQUIRED when the export's type field is set to "once" and should
@@ -26469,7 +26474,6 @@ components:
26469
26474
  - One-time migrations where data should not be duplicated
26470
26475
  - Processing queues where records are marked as "processed"
26471
26476
  - Compliance scenarios requiring audit trails of exported records
26472
- - Implementing exactly-once delivery semantics
26473
26477
  - |-
26474
26478
  4. Error handling behavior:
26475
26479
  - If the export fails, the boolean fields remain unchanged
@@ -37703,6 +37707,8 @@ components:
37703
37707
  description: |-
37704
37708
  Custom JavaScript hooks that run at fixed points in the export lifecycle for
37705
37709
  transformations, validation, and filtering beyond what configuration alone can express.
37710
+ A hook name not listed here (an import's `preMap`, for example) is dropped on save
37711
+ without an error, so read `hooks` back after saving.
37706
37712
  properties:
37707
37713
  preSavePage:
37708
37714
  type: object
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@celigo/api-specs",
3
- "version": "0.2.161",
3
+ "version": "0.2.163",
4
4
  "private": false,
5
5
  "description": "Public OpenAPI bundles (dist/) and the celigo-cli lint schema pack (schemas.json).",
6
6
  "keywords": [