@celigo/api-specs 0.2.133 → 0.2.134

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
@@ -360,8 +360,9 @@ paths:
360
360
  x-internal: false
361
361
  summary: Clone an export
362
362
  description: |
363
- Creates a copy of an existing export.
364
- Supports optionally remapping referenced connections (via connectionMap).
363
+ Creates a copy of an existing export, remapping its connection through `connectionMap`.
364
+ For an export that uses a connection, omitting the map or sending an empty one fails with
365
+ 400 `invalid_connectionMap`; map the connection to itself to keep it.
365
366
  operationId: cloneExport
366
367
  tags:
367
368
  - Exports
@@ -500,7 +501,11 @@ paths:
500
501
  description: |-
501
502
  Full export document (mirror of `POST /v1/exports` body shape),
502
503
  optionally with `test.limit` to cap preview record count. Omit
503
- `_id` when previewing a not-yet-saved export.
504
+ `_id` when previewing a not-yet-saved export. For an export this
505
+ endpoint previews (an HTTP export, for example), a `mockOutput` in
506
+ the body is returned as a lone `parse` stage instead of a live read,
507
+ so remove it from a document read back with GET to sample the
508
+ source.
504
509
  additionalProperties: true
505
510
  examples:
506
511
  http_preview:
@@ -528,9 +533,9 @@ paths:
528
533
  '400':
529
534
  description: |-
530
535
  The export type does not support preview. Virtual (unsaved) previews
531
- are rejected for `simple` and other virtual export types — only
532
- builder-style exports (e.g. HTTP, RDBMS) can be previewed via this
533
- endpoint.
536
+ are rejected for `simple`, `webhook` and other virtual export types —
537
+ only builder-style exports (e.g. HTTP, RDBMS) can be previewed via
538
+ this endpoint.
534
539
  content:
535
540
  application/json:
536
541
  schema:
@@ -633,8 +638,9 @@ paths:
633
638
  validation (bad ID, missing auth).
634
639
 
635
640
  This endpoint executes the export against the live source system.
636
- `POST /v1/exports/preview` also queries the live source (reads only,
637
- no job) — prefer it when you only need to inspect fetched records.
641
+ `POST /v1/exports/preview` also queries the live source when its body
642
+ carries no `mockOutput` (reads only, no job) — prefer it when you only
643
+ need to inspect fetched records.
638
644
  parameters:
639
645
  - in: path
640
646
  name: _id
@@ -5485,7 +5491,7 @@ components:
5485
5491
  Selects which files are processed: files matching the filter criteria are exported,
5486
5492
  and non-matching files are skipped entirely before processing begins. Filterable
5487
5493
  fields come from each file's metadata — most providers expose filename, filesize,
5488
- and lastmodified (e.g. ["endswith", ["extract", "filename"], ".csv"]).
5494
+ and lastmodified (e.g. ["endswith", ["string", ["extract", "filename"]], ".csv"]).
5489
5495
  allOf:
5490
5496
  - $ref: '#/components/schemas/Filter'
5491
5497
  x-celigo-ai-guidance:
@@ -5500,7 +5506,7 @@ components:
5500
5506
 
5501
5507
  1. **filename**: The name of the file (with extension)
5502
5508
  - Example filter: Match files with specific extensions or naming patterns
5503
- - Usage: `["endswith", ["extract", "filename"], ".csv"]`
5509
+ - Usage: `["endswith", ["string", ["extract", "filename"]], ".csv"]`
5504
5510
 
5505
5511
  2. **filesize**: The size of the file in bytes
5506
5512
  - Example filter: Skip files that are too large or too small
@@ -5508,7 +5514,7 @@ components:
5508
5514
 
5509
5515
  3. **lastmodified**: The last modification timestamp of the file
5510
5516
  - Example filter: Process only files created/modified within a specific date range
5511
- - Usage: `["greaterthan", ["extract", "lastmodified"], "2023-01-01T00:00:00Z"]`
5517
+ - Usage: `["greaterthan", ["epochtime", ["extract", "lastmodified"]], 1672531200000]` (2023-01-01T00:00:00Z in epoch milliseconds)
5512
5518
  backupPath:
5513
5519
  type: string
5514
5520
  description: Path where backup copies of source files are stored before processing.
@@ -5769,38 +5775,10 @@ components:
5769
5775
  bearerToken:
5770
5776
  type: string
5771
5777
  description: |-
5772
- Bearer token used to authenticate inbound distributed export requests. Optional — most
5773
- distributed listeners (NetSuite, Salesforce real-time) use no token. Write-only and stored
5774
- encrypted; treat it as a sensitive credential.
5775
- x-celigo-ai-guidance:
5776
- - |-
5777
- ## FIELD BEHAVIOR
5778
-
5779
- This token provides authentication for the distributed export:
5780
-
5781
- - Required for secure access to distributed endpoints
5782
- - Must be a valid bearer token format
5783
- - Used in Authorization header as "Bearer {token}"
5784
- - Should be kept secure and rotated regularly
5785
- - |-
5786
- ## IMPLEMENTATION GUIDANCE
5787
-
5788
- ### Token management
5789
-
5790
- - Store tokens securely (encrypted at rest)
5791
- - Implement token rotation policies
5792
- - Monitor token expiration dates
5793
- - Use environment variables for token storage
5794
-
5795
- ### Security considerations
5796
-
5797
- - Never log bearer tokens in plain text
5798
- - Implement proper access controls
5799
- - Use HTTPS for all token transmissions
5800
- - Validate tokens on each request
5801
-
5802
- IMPORTANT: Bearer tokens provide full access to the distributed export.
5803
- Treat them as sensitive credentials.
5778
+ Bearer token that a system pushing data into this export sends as
5779
+ `Authorization: Bearer <token>`. Optional — most distributed listeners (NetSuite,
5780
+ Salesforce real-time) use no token. Write-only and stored encrypted; treat it as a
5781
+ sensitive credential.
5804
5782
  format: password
5805
5783
  examples:
5806
5784
  - eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
@@ -15640,9 +15618,10 @@ components:
15640
15618
 
15641
15619
  In a flow test run, and for an upstream lookup during a page-processor preview
15642
15620
  (`previewPageProcessor`), integrator.io substitutes this mock output for the export's live
15643
- response instead of calling the source. It is not substituted anywhere else: a target lookup
15644
- in that preview runs its live query, `POST /v1/exports/preview` calls the source, and real
15645
- runs ignore it. This allows you to:
15621
+ response instead of calling the source. A saved mock is not read anywhere else: a target
15622
+ lookup in that preview runs its live query, invoking the export
15623
+ (`POST /v1/exports/{_id}/invoke`) reads the source, and real runs ignore it. This allows you
15624
+ to:
15646
15625
  - Test mappings with representative data
15647
15626
  - Configure downstream flow steps without waiting for real data
15648
15627
  - Simulate various data scenarios
@@ -15651,6 +15630,11 @@ components:
15651
15630
  `transform` and output `filter` still run on top of them, so downstream steps — and a
15652
15631
  lookup's results mapping — see the transformed, filtered records, not the shape stored here.
15653
15632
 
15633
+ `POST /v1/exports/preview` reads the `mockOutput` in its request body, not the saved one. For
15634
+ an export the preview supports (an HTTP export, for example), a body that carries it (as an
15635
+ export read back with GET does) returns that snapshot as a lone `parse` stage without calling
15636
+ the source; remove `mockOutput` from the body to preview live records.
15637
+
15654
15638
  **Limitations**
15655
15639
 
15656
15640
  - Maximum of 10 records
@@ -15668,8 +15652,8 @@ components:
15668
15652
  the stored shape walks paths that do not exist at runtime.
15669
15653
  - |-
15670
15654
  A saved mockOutput is read in exactly two places — a flow test run, and an upstream lookup
15671
- during a page-processor preview. A target lookup's preview, `POST /v1/exports/preview` and
15672
- every real run call the source and never read it.
15655
+ during a page-processor preview. A target lookup's preview, `POST /v1/exports/{_id}/invoke`
15656
+ and every real run call the source and never read it.
15673
15657
  properties:
15674
15658
  page_of_records:
15675
15659
  type: array
@@ -16181,9 +16165,9 @@ components:
16181
16165
  x-celigo-agent:
16182
16166
  - filter
16183
16167
  description: |-
16184
- Filter applied to records immediately after they are retrieved from the source.
16185
- Records that match continue through the flow; records that don't are silently dropped.
16186
- Filter expressions reference the exported record's own fields.
16168
+ Filter applied to each record after the export's transform and before its preSavePage
16169
+ hook. Records that match continue through the flow; records that don't are silently
16170
+ dropped. Filter expressions reference the transformed record's fields.
16187
16171
  allOf:
16188
16172
  - $ref: '#/components/schemas/Filter'
16189
16173
  x-celigo-ai-guidance:
@@ -16193,13 +16177,13 @@ components:
16193
16177
 
16194
16178
  ## FILTER BEHAVIOR
16195
16179
 
16196
- When configured, the filter is applied immediately after records are retrieved from the source system:
16180
+ When configured, the filter is applied to each record after the export's transform and before the preSavePage hook:
16197
16181
  - Records that match the filter criteria continue through the flow
16198
16182
  - Records that don't match are silently dropped
16199
16183
  - No partial record processing is performed
16200
16184
 
16201
16185
  ## AVAILABLE FILTER FIELDS
16202
- The fields available for filtering are the data fields from each record retrieved by the export.
16186
+ The fields available for filtering are those of each record as the export's transform leaves it (the retrieved record when no transform is set).
16203
16187
  inputFilter:
16204
16188
  x-celigo-agent:
16205
16189
  - filter
@@ -16312,9 +16296,12 @@ components:
16312
16296
  x-celigo-agent:
16313
16297
  - script
16314
16298
  description: |-
16315
- Hook that runs after each page of records is retrieved from the source but before it
16316
- is sent to downstream steps. Commonly used to flatten structures, drop unwanted
16317
- records, or add computed fields.
16299
+ Hook that runs on each page of records after the export's transform and output
16300
+ filter, before the page is sent to downstream steps; commonly used to flatten
16301
+ structures, drop unwanted records, or add computed fields. It receives the page as
16302
+ `options.data` (with `errors`, `pageIndex`, `configuration` and `settings`) and returns
16303
+ `{data, errors, abort, newErrorsAndRetryData}`. An exception thrown here fails every
16304
+ record on that page, each with its own retry data, and later pages still run.
16318
16305
  properties:
16319
16306
  function:
16320
16307
  type: string
@@ -17114,8 +17101,10 @@ components:
17114
17101
  connectionMap:
17115
17102
  type: object
17116
17103
  description: |
17117
- Optional mapping of original connection ids to replacement connection ids.
17104
+ Mapping of original connection ids to replacement connection ids.
17118
17105
  Keys are source connection ids on the original resource; values are target connection ids.
17106
+ For an export that uses a connection, omitting the map or sending an empty one fails
17107
+ with 400 `invalid_connectionMap`; map the connection to itself to reuse it in the clone.
17119
17108
  additionalProperties:
17120
17109
  type: string
17121
17110
  example:
@@ -17155,6 +17144,7 @@ components:
17155
17144
  Final sampled records produced by the preview — the output of the last
17156
17145
  stage. Identical in practice to the last `stages[].data` entry, exposed
17157
17146
  here as a convenience for callers that only care about the end result.
17147
+ Absent from the zero-record answers described under `stages`.
17158
17148
  items: {}
17159
17149
  dataURIs:
17160
17150
  type: array
@@ -17177,10 +17167,15 @@ components:
17177
17167
  runs through parsing only — the export's transform, output filter,
17178
17168
  and preSavePage hook are NOT applied here (they run in flow
17179
17169
  previews, test runs, and real runs). Observed stage names: `parse`
17180
- always; `request` and `raw` for HTTP exports; `group` when the
17181
- export groups records (grouped records are bare arrays of the
17182
- grouped rows). Each stage carries its `data[]` output and any
17183
- `errors[]` raised at that stage.
17170
+ for a live read that returned records, and as the only stage when a
17171
+ `mockOutput` in the request body answers; `request` and `raw` for HTTP
17172
+ exports; `group` when the export groups records (grouped records are
17173
+ bare arrays of the grouped rows). Each stage carries its `data[]`
17174
+ output and any `errors[]` raised at that stage. A live read that
17175
+ selects no records has been observed without a `parse` stage or
17176
+ top-level `data` on two adaptors: an HTTP export returns only `request`
17177
+ and `raw`, and a NetSuite RESTlet search returns an empty object. Treat
17178
+ those as zero records, not as a failed preview.
17184
17179
  items:
17185
17180
  type: object
17186
17181
  description: One pipeline stage's diagnostic and output envelope.
package/dist/flow.yml CHANGED
@@ -8249,6 +8249,7 @@ components:
8249
8249
  Final sampled records produced by the preview — the output of the last
8250
8250
  stage. Identical in practice to the last `stages[].data` entry, exposed
8251
8251
  here as a convenience for callers that only care about the end result.
8252
+ Absent from the zero-record answers described under `stages`.
8252
8253
  items: {}
8253
8254
  dataURIs:
8254
8255
  type: array
@@ -8271,10 +8272,15 @@ components:
8271
8272
  runs through parsing only — the export's transform, output filter,
8272
8273
  and preSavePage hook are NOT applied here (they run in flow
8273
8274
  previews, test runs, and real runs). Observed stage names: `parse`
8274
- always; `request` and `raw` for HTTP exports; `group` when the
8275
- export groups records (grouped records are bare arrays of the
8276
- grouped rows). Each stage carries its `data[]` output and any
8277
- `errors[]` raised at that stage.
8275
+ for a live read that returned records, and as the only stage when a
8276
+ `mockOutput` in the request body answers; `request` and `raw` for HTTP
8277
+ exports; `group` when the export groups records (grouped records are
8278
+ bare arrays of the grouped rows). Each stage carries its `data[]`
8279
+ output and any `errors[]` raised at that stage. A live read that
8280
+ selects no records has been observed without a `parse` stage or
8281
+ top-level `data` on two adaptors: an HTTP export returns only `request`
8282
+ and `raw`, and a NetSuite RESTlet search returns an empty object. Treat
8283
+ those as zero records, not as a failed preview.
8278
8284
  items:
8279
8285
  type: object
8280
8286
  description: One pipeline stage's diagnostic and output envelope.
package/dist/import.yml CHANGED
@@ -372,8 +372,9 @@ paths:
372
372
  x-internal: false
373
373
  summary: Clone an import
374
374
  description: |
375
- Creates a copy of an existing import.
376
- Supports optionally remapping referenced connections (via connectionMap).
375
+ Creates a copy of an existing import, remapping its connection through `connectionMap`.
376
+ For an import that uses a connection, an empty map fails with 400 `invalid_connectionMap`;
377
+ map the connection to itself to keep it.
377
378
  operationId: cloneImport
378
379
  tags:
379
380
  - Imports
@@ -17136,8 +17137,11 @@ components:
17136
17137
  connectionMap:
17137
17138
  type: object
17138
17139
  description: |
17139
- Optional mapping of original connection ids to replacement connection ids.
17140
+ Mapping of original connection ids to replacement connection ids.
17140
17141
  Keys are source connection ids on the original resource; values are target connection ids.
17142
+ For an import that uses a connection, an empty map fails with 400
17143
+ `invalid_connectionMap`, as it does for an export; map the connection to itself to reuse
17144
+ it in the clone.
17141
17145
  additionalProperties:
17142
17146
  type: string
17143
17147
  example:
package/dist/tool.yml CHANGED
@@ -29813,7 +29813,7 @@ components:
29813
29813
  Selects which files are processed: files matching the filter criteria are exported,
29814
29814
  and non-matching files are skipped entirely before processing begins. Filterable
29815
29815
  fields come from each file's metadata — most providers expose filename, filesize,
29816
- and lastmodified (e.g. ["endswith", ["extract", "filename"], ".csv"]).
29816
+ and lastmodified (e.g. ["endswith", ["string", ["extract", "filename"]], ".csv"]).
29817
29817
  allOf:
29818
29818
  - $ref: '#/components/schemas/Filter'
29819
29819
  x-celigo-ai-guidance:
@@ -29828,7 +29828,7 @@ components:
29828
29828
 
29829
29829
  1. **filename**: The name of the file (with extension)
29830
29830
  - Example filter: Match files with specific extensions or naming patterns
29831
- - Usage: `["endswith", ["extract", "filename"], ".csv"]`
29831
+ - Usage: `["endswith", ["string", ["extract", "filename"]], ".csv"]`
29832
29832
 
29833
29833
  2. **filesize**: The size of the file in bytes
29834
29834
  - Example filter: Skip files that are too large or too small
@@ -29836,7 +29836,7 @@ components:
29836
29836
 
29837
29837
  3. **lastmodified**: The last modification timestamp of the file
29838
29838
  - Example filter: Process only files created/modified within a specific date range
29839
- - Usage: `["greaterthan", ["extract", "lastmodified"], "2023-01-01T00:00:00Z"]`
29839
+ - Usage: `["greaterthan", ["epochtime", ["extract", "lastmodified"]], 1672531200000]` (2023-01-01T00:00:00Z in epoch milliseconds)
29840
29840
  backupPath:
29841
29841
  type: string
29842
29842
  description: Path where backup copies of source files are stored before processing.
@@ -30097,38 +30097,10 @@ components:
30097
30097
  bearerToken:
30098
30098
  type: string
30099
30099
  description: |-
30100
- Bearer token used to authenticate inbound distributed export requests. Optional — most
30101
- distributed listeners (NetSuite, Salesforce real-time) use no token. Write-only and stored
30102
- encrypted; treat it as a sensitive credential.
30103
- x-celigo-ai-guidance:
30104
- - |-
30105
- ## FIELD BEHAVIOR
30106
-
30107
- This token provides authentication for the distributed export:
30108
-
30109
- - Required for secure access to distributed endpoints
30110
- - Must be a valid bearer token format
30111
- - Used in Authorization header as "Bearer {token}"
30112
- - Should be kept secure and rotated regularly
30113
- - |-
30114
- ## IMPLEMENTATION GUIDANCE
30115
-
30116
- ### Token management
30117
-
30118
- - Store tokens securely (encrypted at rest)
30119
- - Implement token rotation policies
30120
- - Monitor token expiration dates
30121
- - Use environment variables for token storage
30122
-
30123
- ### Security considerations
30124
-
30125
- - Never log bearer tokens in plain text
30126
- - Implement proper access controls
30127
- - Use HTTPS for all token transmissions
30128
- - Validate tokens on each request
30129
-
30130
- IMPORTANT: Bearer tokens provide full access to the distributed export.
30131
- Treat them as sensitive credentials.
30100
+ Bearer token that a system pushing data into this export sends as
30101
+ `Authorization: Bearer <token>`. Optional — most distributed listeners (NetSuite,
30102
+ Salesforce real-time) use no token. Write-only and stored encrypted; treat it as a
30103
+ sensitive credential.
30132
30104
  format: password
30133
30105
  examples:
30134
30106
  - eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
@@ -36701,9 +36673,10 @@ components:
36701
36673
 
36702
36674
  In a flow test run, and for an upstream lookup during a page-processor preview
36703
36675
  (`previewPageProcessor`), integrator.io substitutes this mock output for the export's live
36704
- response instead of calling the source. It is not substituted anywhere else: a target lookup
36705
- in that preview runs its live query, `POST /v1/exports/preview` calls the source, and real
36706
- runs ignore it. This allows you to:
36676
+ response instead of calling the source. A saved mock is not read anywhere else: a target
36677
+ lookup in that preview runs its live query, invoking the export
36678
+ (`POST /v1/exports/{_id}/invoke`) reads the source, and real runs ignore it. This allows you
36679
+ to:
36707
36680
  - Test mappings with representative data
36708
36681
  - Configure downstream flow steps without waiting for real data
36709
36682
  - Simulate various data scenarios
@@ -36712,6 +36685,11 @@ components:
36712
36685
  `transform` and output `filter` still run on top of them, so downstream steps — and a
36713
36686
  lookup's results mapping — see the transformed, filtered records, not the shape stored here.
36714
36687
 
36688
+ `POST /v1/exports/preview` reads the `mockOutput` in its request body, not the saved one. For
36689
+ an export the preview supports (an HTTP export, for example), a body that carries it (as an
36690
+ export read back with GET does) returns that snapshot as a lone `parse` stage without calling
36691
+ the source; remove `mockOutput` from the body to preview live records.
36692
+
36715
36693
  **Limitations**
36716
36694
 
36717
36695
  - Maximum of 10 records
@@ -36729,8 +36707,8 @@ components:
36729
36707
  the stored shape walks paths that do not exist at runtime.
36730
36708
  - |-
36731
36709
  A saved mockOutput is read in exactly two places — a flow test run, and an upstream lookup
36732
- during a page-processor preview. A target lookup's preview, `POST /v1/exports/preview` and
36733
- every real run call the source and never read it.
36710
+ during a page-processor preview. A target lookup's preview, `POST /v1/exports/{_id}/invoke`
36711
+ and every real run call the source and never read it.
36734
36712
  properties:
36735
36713
  page_of_records:
36736
36714
  type: array
@@ -37172,9 +37150,9 @@ components:
37172
37150
  x-celigo-agent:
37173
37151
  - filter
37174
37152
  description: |-
37175
- Filter applied to records immediately after they are retrieved from the source.
37176
- Records that match continue through the flow; records that don't are silently dropped.
37177
- Filter expressions reference the exported record's own fields.
37153
+ Filter applied to each record after the export's transform and before its preSavePage
37154
+ hook. Records that match continue through the flow; records that don't are silently
37155
+ dropped. Filter expressions reference the transformed record's fields.
37178
37156
  allOf:
37179
37157
  - $ref: '#/components/schemas/Filter'
37180
37158
  x-celigo-ai-guidance:
@@ -37184,13 +37162,13 @@ components:
37184
37162
 
37185
37163
  ## FILTER BEHAVIOR
37186
37164
 
37187
- When configured, the filter is applied immediately after records are retrieved from the source system:
37165
+ When configured, the filter is applied to each record after the export's transform and before the preSavePage hook:
37188
37166
  - Records that match the filter criteria continue through the flow
37189
37167
  - Records that don't match are silently dropped
37190
37168
  - No partial record processing is performed
37191
37169
 
37192
37170
  ## AVAILABLE FILTER FIELDS
37193
- The fields available for filtering are the data fields from each record retrieved by the export.
37171
+ The fields available for filtering are those of each record as the export's transform leaves it (the retrieved record when no transform is set).
37194
37172
  inputFilter:
37195
37173
  x-celigo-agent:
37196
37174
  - filter
@@ -37303,9 +37281,12 @@ components:
37303
37281
  x-celigo-agent:
37304
37282
  - script
37305
37283
  description: |-
37306
- Hook that runs after each page of records is retrieved from the source but before it
37307
- is sent to downstream steps. Commonly used to flatten structures, drop unwanted
37308
- records, or add computed fields.
37284
+ Hook that runs on each page of records after the export's transform and output
37285
+ filter, before the page is sent to downstream steps; commonly used to flatten
37286
+ structures, drop unwanted records, or add computed fields. It receives the page as
37287
+ `options.data` (with `errors`, `pageIndex`, `configuration` and `settings`) and returns
37288
+ `{data, errors, abort, newErrorsAndRetryData}`. An exception thrown here fails every
37289
+ record on that page, each with its own retry data, and later pages still run.
37309
37290
  properties:
37310
37291
  function:
37311
37292
  type: string
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@celigo/api-specs",
3
- "version": "0.2.133",
3
+ "version": "0.2.134",
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,7 +1,7 @@
1
1
  {
2
2
  "provenance": {
3
3
  "repo": "celigo/integrator-api-specs",
4
- "iasCommit": "60c8d128",
4
+ "iasCommit": "86f54b3d",
5
5
  "generatedAt": "2026-10-21"
6
6
  },
7
7
  "roots": {