@celigo/api-specs 0.2.14 → 0.2.16

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/export.yml CHANGED
@@ -10298,8 +10298,11 @@ components:
10298
10298
  batchSize:
10299
10299
  type: number
10300
10300
  description: |-
10301
- Number of records the RESTlet returns per page. Larger pages reduce round-trips but
10302
- raise NetSuite governance and memory use per call; tune to the record's size.
10301
+ Number of records the RESTlet returns per request (default 1000). This, not the
10302
+ export's `pageSize`, sizes each NetSuite call; the export keeps requesting until the
10303
+ search is exhausted. Larger batches reduce round-trips but raise NetSuite governance
10304
+ and memory use per call; tune to the record's size. In a test run or preview the
10305
+ request is capped at the export's `pageSize` (default 20) instead.
10303
10306
  examples:
10304
10307
  - 100
10305
10308
  - 200
@@ -15886,9 +15889,13 @@ components:
15886
15889
  - integer
15887
15890
  - 'null'
15888
15891
  description: |-
15889
- Number of records per page streamed to downstream flow steps. Pages are additionally
15890
- capped at 5 MB regardless of record count, so very large records may produce smaller
15891
- pages. The server does not validate the value.
15892
+ Number of records per page streamed to downstream flow steps when the export is the
15893
+ flow's source step. Pages are additionally capped at 5 MB regardless of record count, so
15894
+ very large records may produce smaller pages. The server does not validate the value.
15895
+ A lookup (`isLookup: true`) runs to completion and hands every result to the incoming
15896
+ record as one response, capped at 5 MB in total, so the value does not change how many
15897
+ results a lookup returns; a result set larger than that belongs in a standalone export
15898
+ step. In a test run or preview the value also caps the records fetched (default 20).
15892
15899
  default: 20
15893
15900
  examples:
15894
15901
  - 100
@@ -15943,7 +15950,11 @@ components:
15943
15950
  description: |-
15944
15951
  When true, the export runs as a mid-flow lookup: it executes once per incoming record,
15945
15952
  using the input record's fields to parameterize the request, and passes the results to
15946
- subsequent steps. When false, the export runs as a standalone data source.
15953
+ subsequent steps. When false, the export runs as a standalone data source. A lookup's
15954
+ results are not paged through the flow: every page the adaptor fetches is merged into one
15955
+ response for the record, up to 5 MB, so `pageSize` does not limit or extend what a lookup
15956
+ returns. A lookup that must return more than that is better modeled as a standalone
15957
+ export step.
15947
15958
  examples:
15948
15959
  - true
15949
15960
  - false
package/dist/flow.yml CHANGED
@@ -6737,6 +6737,7 @@ components:
6737
6737
  description: |
6738
6738
  Total number of errors produced by the job (including resolved ones).
6739
6739
  Use `numOpenError` for the count of currently unresolved errors.
6740
+ On a parent flow job this is the sum across every step; on a child job it is that step's count.
6740
6741
  examples:
6741
6742
  - 10
6742
6743
  numOpenError:
@@ -6762,13 +6763,20 @@ components:
6762
6763
  numSuccess:
6763
6764
  type: integer
6764
6765
  readOnly: true
6765
- description: Number of successful records/pages.
6766
+ description: |-
6767
+ Number of records processed successfully. On a parent flow job (`type: flow`) this is the
6768
+ sum across every step in the run, so one record that passes through an export and an import
6769
+ counts twice. On a child job (`type: export` or `import`) it is that step's count alone.
6770
+ For per-step counts, read the run with `GET /v1/jobs/{_id}/family` or list its children with
6771
+ `GET /v1/jobs?_flowJobId={_id}&type=import`.
6766
6772
  examples:
6767
6773
  - 10
6768
6774
  numIgnore:
6769
6775
  type: integer
6770
6776
  readOnly: true
6771
- description: Number of ignored records/pages.
6777
+ description: |-
6778
+ Number of records skipped, for example by an import's ignore-existing or ignore-missing rule.
6779
+ Summed across steps on a parent flow job; per step on a child job.
6772
6780
  examples:
6773
6781
  - 0
6774
6782
  numExport:
package/dist/import.yml CHANGED
@@ -1918,7 +1918,9 @@ components:
1918
1918
  description: |-
1919
1919
  Request body template for the import — an array of Handlebars template strings
1920
1920
  positionally aligned with the `method` array (e.g. `["{{{record}}}"]`). A `null`
1921
- entry means no template for the method at that position.
1921
+ entry means no template for the method at that position. Each entry is a string:
1922
+ write a JSON body as a template string (`["{\"id\": \"{{record.id}}\"}"]`), not as
1923
+ a JSON object, because an object entry does not render as JSON at runtime.
1922
1924
  Leave undefined for standard imports — the Import's mapping step transforms the source record and the mapped data is sent as the request body automatically.
1923
1925
  Set it only when the target API requires XML, SOAP, or a custom structure that mappings cannot produce, or when the user explicitly specifies a request body.
1924
1926
  When set, the mapping step still runs first and the template renders against the post-mapped record — use `{{record.<mappedField>}}` to reference mapping outputs.
@@ -1475,13 +1475,15 @@ paths:
1475
1475
  Removes a connection's registration from the integration. This does not delete the connection
1476
1476
  itself -- it only removes it from the integration's registered-connections list.
1477
1477
 
1478
- Fails while any resource in the integration still uses the connection -- a step
1479
- (export, import, or lookup) in one of its flows, Tools, or APIs bound to it through
1480
- `_connectionId`, or an alias on the integration or one of its flows whose
1481
- `_connectionId` points at it. Move the steps to another connection first (a whole flow
1482
- at once with `PUT /v1/flows/{_id}/replaceConnection`; Tool and API steps through their
1483
- own step-level `replaceConnection`), remove any alias that still points at it, then
1484
- unregister.
1478
+ Fails while any resource in the integration still uses the connection. Two references
1479
+ are known to count: any step in one of its flows, Tools, or APIs whose `_connectionId`
1480
+ is this connection -- every step is an export or import document, whatever its kind
1481
+ (lookup, listener, AI agent, guardrail, Tool wrapper, transfer) -- and an alias on the
1482
+ integration or one of its flows whose `_connectionId` points at it. Move the steps to
1483
+ another connection first (a whole flow at once with
1484
+ `PUT /v1/flows/{_id}/replaceConnection`; Tool and API steps through their own
1485
+ step-level `replaceConnection`), remove or retarget any alias that still points at it,
1486
+ then unregister.
1485
1487
  x-celigo-ai-guidance:
1486
1488
  - |-
1487
1489
  Before calling, list what the integration still binds to this connection: the
package/dist/job.yml CHANGED
@@ -333,7 +333,9 @@ paths:
333
333
  `canceled`, `retried`) are not returned; use `POST /v1/flows/runs/stats` for run history.
334
334
 
335
335
  The request body contains all filters -- there are no query-string parameters. Narrow to a specific flow or
336
- integration with `_flowIds` / `_integrationIds` (AND-combined).
336
+ integration with `_flowIds` / `_integrationIds` (AND-combined). The time bounds `time_gt` and `time_lte`
337
+ are accepted but do not narrow this list; to find long-running jobs, compare each job's `createdAt` or
338
+ `startedAt` on the client.
337
339
  requestBody:
338
340
  required: true
339
341
  content:
@@ -387,6 +389,11 @@ paths:
387
389
  The request body supports filtering by integration, flow, status, and
388
390
  application. The platform requires ``sandbox`` in the body; Ora is
389
391
  production-only so it always sends ``false``.
392
+ - |-
393
+ time_gt and time_lte are accepted but do not narrow this endpoint: a time_lte a week
394
+ in the past still returns jobs created seconds ago. To find jobs stuck for longer than
395
+ a threshold, compare each job's createdAt or startedAt yourself, and never describe the
396
+ result as bounded by a time filter you sent.
390
397
  /v1/flows/runs/stats:
391
398
  post:
392
399
  x-internal: false
@@ -1457,6 +1464,7 @@ components:
1457
1464
  description: |
1458
1465
  Total number of errors produced by the job (including resolved ones).
1459
1466
  Use `numOpenError` for the count of currently unresolved errors.
1467
+ On a parent flow job this is the sum across every step; on a child job it is that step's count.
1460
1468
  examples:
1461
1469
  - 10
1462
1470
  numOpenError:
@@ -1482,13 +1490,20 @@ components:
1482
1490
  numSuccess:
1483
1491
  type: integer
1484
1492
  readOnly: true
1485
- description: Number of successful records/pages.
1493
+ description: |-
1494
+ Number of records processed successfully. On a parent flow job (`type: flow`) this is the
1495
+ sum across every step in the run, so one record that passes through an export and an import
1496
+ counts twice. On a child job (`type: export` or `import`) it is that step's count alone.
1497
+ For per-step counts, read the run with `GET /v1/jobs/{_id}/family` or list its children with
1498
+ `GET /v1/jobs?_flowJobId={_id}&type=import`.
1486
1499
  examples:
1487
1500
  - 10
1488
1501
  numIgnore:
1489
1502
  type: integer
1490
1503
  readOnly: true
1491
- description: Number of ignored records/pages.
1504
+ description: |-
1505
+ Number of records skipped, for example by an import's ignore-existing or ignore-missing rule.
1506
+ Summed across steps on a parent flow job; per step on a child job.
1492
1507
  examples:
1493
1508
  - 0
1494
1509
  numExport:
@@ -1649,13 +1664,20 @@ components:
1649
1664
  time_gt:
1650
1665
  type: integer
1651
1666
  format: int64
1652
- description: Optional filter for jobs with `createdAt`/time greater than this epoch milliseconds.
1667
+ description: |-
1668
+ Start of the time window, in epoch milliseconds (exclusive). `POST /v1/flows/runs/stats`
1669
+ aggregates only runs inside the window. `POST /v1/jobs/current` accepts the field but does
1670
+ not apply it: in-progress jobs are returned regardless of when they were created.
1653
1671
  examples:
1654
1672
  - 1745366400000
1655
1673
  time_lte:
1656
1674
  type: integer
1657
1675
  format: int64
1658
- description: Optional filter for jobs with `createdAt`/time less than or equal to this epoch milliseconds.
1676
+ description: |-
1677
+ End of the time window, in epoch milliseconds (inclusive). `POST /v1/flows/runs/stats`
1678
+ aggregates only runs inside the window. `POST /v1/jobs/current` accepts the field but does
1679
+ not apply it. To find jobs that have been queued or running longer than a threshold, compare
1680
+ each returned job's `createdAt` (queued) or `startedAt` (running) on the client.
1659
1681
  examples:
1660
1682
  - 1746147600000
1661
1683
  required: []
package/dist/template.yml CHANGED
@@ -507,6 +507,11 @@ paths:
507
507
  Installs a template from a previously uploaded zip file. The `runKey`
508
508
  in the request body ties this request to the zip upload (obtained from
509
509
  `GET /v1/s3SignedURL`).
510
+
511
+ The zip carries connection definitions without credentials, and the
512
+ installed integration receives new connection `_id`s. Configure each
513
+ connection in the new integration before running its flows; connection
514
+ `_id`s that existed only in the zip are not preserved.
510
515
  requestBody:
511
516
  required: true
512
517
  content:
package/dist/tool.yml CHANGED
@@ -10529,7 +10529,9 @@ components:
10529
10529
  description: |-
10530
10530
  Request body template for the import — an array of Handlebars template strings
10531
10531
  positionally aligned with the `method` array (e.g. `["{{{record}}}"]`). A `null`
10532
- entry means no template for the method at that position.
10532
+ entry means no template for the method at that position. Each entry is a string:
10533
+ write a JSON body as a template string (`["{\"id\": \"{{record.id}}\"}"]`), not as
10534
+ a JSON object, because an object entry does not render as JSON at runtime.
10533
10535
  Leave undefined for standard imports — the Import's mapping step transforms the source record and the mapped data is sent as the request body automatically.
10534
10536
  Set it only when the target API requires XML, SOAP, or a custom structure that mappings cannot produce, or when the user explicitly specifies a request body.
10535
10537
  When set, the mapping step still runs first and the template renders against the post-mapped record — use `{{record.<mappedField>}}` to reference mapping outputs.
@@ -29898,8 +29900,11 @@ components:
29898
29900
  batchSize:
29899
29901
  type: number
29900
29902
  description: |-
29901
- Number of records the RESTlet returns per page. Larger pages reduce round-trips but
29902
- raise NetSuite governance and memory use per call; tune to the record's size.
29903
+ Number of records the RESTlet returns per request (default 1000). This, not the
29904
+ export's `pageSize`, sizes each NetSuite call; the export keeps requesting until the
29905
+ search is exhausted. Larger batches reduce round-trips but raise NetSuite governance
29906
+ and memory use per call; tune to the record's size. In a test run or preview the
29907
+ request is capped at the export's `pageSize` (default 20) instead.
29903
29908
  examples:
29904
29909
  - 100
29905
29910
  - 200
@@ -32516,9 +32521,13 @@ components:
32516
32521
  - integer
32517
32522
  - 'null'
32518
32523
  description: |-
32519
- Number of records per page streamed to downstream flow steps. Pages are additionally
32520
- capped at 5 MB regardless of record count, so very large records may produce smaller
32521
- pages. The server does not validate the value.
32524
+ Number of records per page streamed to downstream flow steps when the export is the
32525
+ flow's source step. Pages are additionally capped at 5 MB regardless of record count, so
32526
+ very large records may produce smaller pages. The server does not validate the value.
32527
+ A lookup (`isLookup: true`) runs to completion and hands every result to the incoming
32528
+ record as one response, capped at 5 MB in total, so the value does not change how many
32529
+ results a lookup returns; a result set larger than that belongs in a standalone export
32530
+ step. In a test run or preview the value also caps the records fetched (default 20).
32522
32531
  default: 20
32523
32532
  examples:
32524
32533
  - 100
@@ -32573,7 +32582,11 @@ components:
32573
32582
  description: |-
32574
32583
  When true, the export runs as a mid-flow lookup: it executes once per incoming record,
32575
32584
  using the input record's fields to parameterize the request, and passes the results to
32576
- subsequent steps. When false, the export runs as a standalone data source.
32585
+ subsequent steps. When false, the export runs as a standalone data source. A lookup's
32586
+ results are not paged through the flow: every page the adaptor fetches is merged into one
32587
+ response for the record, up to 5 MB, so `pageSize` does not limit or extend what a lookup
32588
+ returns. A lookup that must return more than that is better modeled as a standalone
32589
+ export step.
32577
32590
  examples:
32578
32591
  - true
32579
32592
  - false
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@celigo/api-specs",
3
- "version": "0.2.14",
3
+ "version": "0.2.16",
4
4
  "private": false,
5
5
  "description": "Public OpenAPI bundles (dist/) and the celigo-cli lint schema pack (schemas.json).",
6
6
  "keywords": [
package/schemas.json CHANGED
@@ -1,8 +1,8 @@
1
1
  {
2
2
  "provenance": {
3
3
  "repo": "celigo/integrator-api-specs",
4
- "iasCommit": "62a17aa",
5
- "generatedAt": "2026-09-12"
4
+ "iasCommit": "aad3947",
5
+ "generatedAt": "2026-09-13"
6
6
  },
7
7
  "roots": {
8
8
  "aiagent": 121,