@celigo/api-specs 0.2.22 → 0.2.23

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
@@ -5921,10 +5921,10 @@ components:
5921
5921
  - blob
5922
5922
  - csvstream
5923
5923
  x-enumDescriptions:
5924
- file: Treats the HTTP response as raw file content (PDFs, images, binary data) rather than structured data records.
5924
+ file: Works with files instead of a record endpoint — a raw file download (PDFs, images, binary data), or a file-provider folder whose files the file object parses into records (csv, json, xml, xlsx, filedefinition incl. EDI)
5925
5925
  blob: Transfers the raw response body downstream as a blob without parsing it into records.
5926
5926
  csvstream: Streams a large CSV response, parsing it row-by-row instead of loading the whole body into memory.
5927
- description: Set to `file` only when the endpoint returns raw file content (PDFs, images, binary data) to be saved as a file rather than parsed as records; the `file` object must also be configured. Leave undefined for standard data exports that return structured records (JSON, XML, GraphQL, SOAP responses) — the response is then parsed into records for downstream steps. When set to `file` or `blob`, the export appears as a "Transfer" step in Flow Builder instead of a standard "Export" step.
5927
+ description: 'Set to `file` when the export works with files rather than a record-returning endpoint: raw file downloads (PDFs, images, binary data) and the folder mode of the cloud file providers (Google Drive, Box, Dropbox, Azure Blob, Google Cloud Storage, Celigo Storage), where each file in the folder is parsed by the `file` object''s `type` (csv, json, xml, xlsx, filedefinition — including EDI) into records; the `file` object must also be configured. Leave undefined for standard data exports that return structured records (JSON, XML, GraphQL, SOAP responses) — the response is then parsed into records for downstream steps. When set to `file` or `blob`, the export appears as a "Transfer" step in Flow Builder instead of a standard "Export" step.'
5928
5928
  x-celigo-ai-guidance:
5929
5929
  - |-
5930
5930
  ## IMPORTANT: This field should be LEFT UNDEFINED for the vast majority of HTTP exports.
@@ -5946,18 +5946,24 @@ components:
5946
5946
  - "Export all Shopify Customers" → undefined (returns JSON customer records)
5947
5947
  - "Retrieve orders from custom REST API" → undefined (returns JSON order records)
5948
5948
  - |-
5949
- ## WHEN TO SET THIS FIELD TO 'file' (RARE USE CASE):
5949
+ ## WHEN TO SET THIS FIELD TO 'file' (the export works with FILES, not a record endpoint):
5950
5950
 
5951
- Set this field to 'file' ONLY when the HTTP endpoint is specifically designed to download files:
5952
- - The endpoint returns raw binary file content (PDFs, images, ZIP files, etc.)
5953
- - The endpoint is a file download service (e.g., downloading invoices, reports, attachments)
5954
- - The response body contains file data that needs to be saved as a file, not parsed as records
5955
- - You need to download and process files from a remote server
5951
+ Set this field to 'file' in two situations:
5952
+ - The HTTP endpoint is specifically designed to download files — it returns raw binary
5953
+ file content (PDFs, images, ZIP files) or is a file download service (invoices,
5954
+ reports, attachments) whose body is saved as a file rather than parsed as records
5955
+ - The connection is a cloud file provider used in FOLDER mode (Google Drive, Box, Dropbox,
5956
+ Azure Blob Storage, Google Cloud Storage, Celigo Storage): the export reads the files
5957
+ in a folder and the 'file' object's `type` (csv, json, xml, xlsx, filedefinition)
5958
+ parses each one into records — the same file layer as an FTP or S3 export
5956
5959
 
5957
5960
  Examples of when to set type: "file":
5958
5961
  - "Download PDF invoices from the API" → type: "file"
5959
5962
  - "Retrieve image files from a file server" → type: "file"
5960
- - "Download CSV files from an FTP server via HTTP" → type: "file"
5963
+ - "Read the CSV files dropped in our Google Drive folder" → type: "file", with file.type "csv"
5964
+ - "Parse EDI X12 850 files from a Google Drive / Celigo Storage folder" → type: "file",
5965
+ with file.type "filedefinition" and a top-level _ediProfileId (EDI fields are
5966
+ accepted on HTTP exports only in file mode)
5961
5967
  - |-
5962
5968
  ## IMPLEMENTATION DETAILS
5963
5969
 
@@ -5965,7 +5971,9 @@ components:
5965
5971
  - The 'file' object property MUST also be configured
5966
5972
  - The export appears as a "Transfer" step in the Flow Builder UI
5967
5973
  - The system applies file-specific processing to the HTTP response
5968
- - Downstream steps receive file content rather than record data
5974
+ - Downstream steps receive records when the 'file' object's `type` parses the files
5975
+ (csv, json, xml, xlsx, filedefinition with `file.output: "records"`), or the file
5976
+ content itself when `file.output` is "blobKeys"
5969
5977
 
5970
5978
  When this field is undefined (default for most exports):
5971
5979
  - The export appears as a standard "Export" step in the Flow Builder UI
@@ -5980,6 +5988,9 @@ components:
5980
5988
  → YES: Leave this field undefined
5981
5989
  3. Does the API endpoint return raw file content (PDFs, images, binary data)?
5982
5990
  → YES: Set this field to "file" (and configure the 'file' property)
5991
+ 4. Is the connection a cloud file provider and the export reads a FOLDER of files
5992
+ (CSV, JSON, XML, XLSX, or EDI via a file definition)?
5993
+ → YES: Set this field to "file" (and configure the 'file' property with the parsing type)
5983
5994
 
5984
5995
  Remember: When in doubt, leave this field undefined. Most HTTP exports are standard data exports.
5985
5996
  examples:
@@ -16204,9 +16215,12 @@ components:
16204
16215
  format: objectId
16205
16216
  x-celigo-refModel: ediprofiles
16206
16217
  description: |-
16207
- EDI profile this export uses to parse incoming X12 EDI documents into structured JSON —
16208
- it supplies the envelope qualifiers, delimiters, version, and validation rules. Set it
16209
- when the export parses or validates EDI files; omit it otherwise.
16218
+ EDI profile this export uses to parse incoming X12 or EDIFACT documents into structured
16219
+ JSON — it supplies the envelope qualifiers, delimiters, version, and validation rules.
16220
+ Set it when the export parses or validates EDI files; omit it otherwise. Accepted on the
16221
+ file-reading exports — FTP, AS2, S3 and HTTP file mode (`http.type: "file"`).
16222
+ x-celigo-ai-guidance:
16223
+ - 'An HTTP export accepts this field only in file mode (`http.type: "file"`, the folder mode of file-provider connectors such as Google Drive, Box, Dropbox, Azure Blob, Google Cloud Storage and Celigo Storage). On a REST/records HTTP export the save is rejected with `not_supported`: "EDIProfile can only be associated with the export of type FTP, AS2, S3 or HTTP file."'
16210
16224
  examples:
16211
16225
  - 60a2c4e6f321d800129a1a3c
16212
16226
  _postParseListenerId:
@@ -16216,8 +16230,10 @@ components:
16216
16230
  description: |-
16217
16231
  Webhook export invoked once per file after EDI parsing, on both success and failure
16218
16232
  (errors are included in the payload when parsing fails). Primarily used to send
16219
- functional acknowledgements (997/999) to trading partners. Only supported for
16220
- `AS2Export` and `FTPExport` parsing EDI files.
16233
+ functional acknowledgements (997/999) to trading partners. Accepted on the file-reading
16234
+ exports that parse EDI — FTP, AS2, S3 and HTTP file mode (`http.type: "file"`).
16235
+ x-celigo-ai-guidance:
16236
+ - 'The listener must be an export with `type: "webhook"` and `webhook.provider: "integrator-extension"`; any other export id is rejected with `invalid_post_parse_listener`. On an HTTP export outside file mode the save is rejected with `post_parse_listener_not_supported`: "Listener for functional acknowledgment is only supported for AS2, FTP, S3 and HTTP file export."'
16221
16237
  examples:
16222
16238
  - 60a2c4e6f321d800129a1a3c
16223
16239
  externalId:
package/dist/import.yml CHANGED
@@ -8247,11 +8247,15 @@ components:
8247
8247
  - `S3Import`
8248
8248
  - `FTPImport`
8249
8249
  - `AS2Import`
8250
+ - `HTTPImport` in file mode (`http.type: "file"` — the folder mode of the cloud file
8251
+ providers such as Google Drive, Box, Dropbox, Azure Blob, Google Cloud Storage and Celigo
8252
+ Storage); the same `file` object, including `type: filedefinition` with `_ediProfileId`
8253
+ for EDI, applies as on S3 / FTP
8250
8254
 
8251
8255
  ❌ **DO NOT SET** for non-file-based imports like:
8252
8256
  - `SalesforceImport`
8253
8257
  - `NetSuiteImport`
8254
- - `HTTPImport`
8258
+ - `HTTPImport` in records mode (`http.type` unset — a REST endpoint receiving records)
8255
8259
  - `MongodbImport`
8256
8260
  - `RDBMSImport`
8257
8261
 
@@ -14412,9 +14416,12 @@ components:
14412
14416
  format: objectId
14413
14417
  x-celigo-refModel: ediprofiles
14414
14418
  description: |-
14415
- EDI profile this import uses to generate outbound X12 EDI documents — it supplies the
14416
- envelope qualifiers, delimiters, version, and validation rules. Set it when the import
14417
- produces EDI output; omit it otherwise.
14419
+ EDI profile this import uses to generate outbound X12 or EDIFACT documents — it supplies
14420
+ the envelope qualifiers, delimiters, version, and validation rules. Set it when the
14421
+ import produces EDI output; omit it otherwise. Accepted on the file-writing imports —
14422
+ FTP, AS2, S3 and HTTP file mode (`http.type: "file"`).
14423
+ x-celigo-ai-guidance:
14424
+ - 'On an HTTP import set `http.type: "file"` (the folder mode of file-provider connectors) and pair this field with `file.type: "filedefinition"` and `file.skipAggregation: true` or `file.aggregation.type: "key"` — the platform saves EDI files per page or per key, never aggregated per run.'
14418
14425
  parsers:
14419
14426
  type: array
14420
14427
  description: |-
package/dist/tool.yml CHANGED
@@ -17105,11 +17105,15 @@ components:
17105
17105
  - `S3Import`
17106
17106
  - `FTPImport`
17107
17107
  - `AS2Import`
17108
+ - `HTTPImport` in file mode (`http.type: "file"` — the folder mode of the cloud file
17109
+ providers such as Google Drive, Box, Dropbox, Azure Blob, Google Cloud Storage and Celigo
17110
+ Storage); the same `file` object, including `type: filedefinition` with `_ediProfileId`
17111
+ for EDI, applies as on S3 / FTP
17108
17112
 
17109
17113
  ❌ **DO NOT SET** for non-file-based imports like:
17110
17114
  - `SalesforceImport`
17111
17115
  - `NetSuiteImport`
17112
- - `HTTPImport`
17116
+ - `HTTPImport` in records mode (`http.type` unset — a REST endpoint receiving records)
17113
17117
  - `MongodbImport`
17114
17118
  - `RDBMSImport`
17115
17119
 
@@ -21191,9 +21195,12 @@ components:
21191
21195
  format: objectId
21192
21196
  x-celigo-refModel: ediprofiles
21193
21197
  description: |-
21194
- EDI profile this import uses to generate outbound X12 EDI documents — it supplies the
21195
- envelope qualifiers, delimiters, version, and validation rules. Set it when the import
21196
- produces EDI output; omit it otherwise.
21198
+ EDI profile this import uses to generate outbound X12 or EDIFACT documents — it supplies
21199
+ the envelope qualifiers, delimiters, version, and validation rules. Set it when the
21200
+ import produces EDI output; omit it otherwise. Accepted on the file-writing imports —
21201
+ FTP, AS2, S3 and HTTP file mode (`http.type: "file"`).
21202
+ x-celigo-ai-guidance:
21203
+ - 'On an HTTP import set `http.type: "file"` (the folder mode of file-provider connectors) and pair this field with `file.type: "filedefinition"` and `file.skipAggregation: true` or `file.aggregation.type: "key"` — the platform saves EDI files per page or per key, never aggregated per run.'
21197
21204
  parsers:
21198
21205
  type: array
21199
21206
  description: |-
@@ -26313,10 +26320,10 @@ components:
26313
26320
  - blob
26314
26321
  - csvstream
26315
26322
  x-enumDescriptions:
26316
- file: Treats the HTTP response as raw file content (PDFs, images, binary data) rather than structured data records.
26323
+ file: Works with files instead of a record endpoint — a raw file download (PDFs, images, binary data), or a file-provider folder whose files the file object parses into records (csv, json, xml, xlsx, filedefinition incl. EDI)
26317
26324
  blob: Transfers the raw response body downstream as a blob without parsing it into records.
26318
26325
  csvstream: Streams a large CSV response, parsing it row-by-row instead of loading the whole body into memory.
26319
- description: Set to `file` only when the endpoint returns raw file content (PDFs, images, binary data) to be saved as a file rather than parsed as records; the `file` object must also be configured. Leave undefined for standard data exports that return structured records (JSON, XML, GraphQL, SOAP responses) — the response is then parsed into records for downstream steps. When set to `file` or `blob`, the export appears as a "Transfer" step in Flow Builder instead of a standard "Export" step.
26326
+ description: 'Set to `file` when the export works with files rather than a record-returning endpoint: raw file downloads (PDFs, images, binary data) and the folder mode of the cloud file providers (Google Drive, Box, Dropbox, Azure Blob, Google Cloud Storage, Celigo Storage), where each file in the folder is parsed by the `file` object''s `type` (csv, json, xml, xlsx, filedefinition — including EDI) into records; the `file` object must also be configured. Leave undefined for standard data exports that return structured records (JSON, XML, GraphQL, SOAP responses) — the response is then parsed into records for downstream steps. When set to `file` or `blob`, the export appears as a "Transfer" step in Flow Builder instead of a standard "Export" step.'
26320
26327
  x-celigo-ai-guidance:
26321
26328
  - |-
26322
26329
  ## IMPORTANT: This field should be LEFT UNDEFINED for the vast majority of HTTP exports.
@@ -26338,18 +26345,24 @@ components:
26338
26345
  - "Export all Shopify Customers" → undefined (returns JSON customer records)
26339
26346
  - "Retrieve orders from custom REST API" → undefined (returns JSON order records)
26340
26347
  - |-
26341
- ## WHEN TO SET THIS FIELD TO 'file' (RARE USE CASE):
26348
+ ## WHEN TO SET THIS FIELD TO 'file' (the export works with FILES, not a record endpoint):
26342
26349
 
26343
- Set this field to 'file' ONLY when the HTTP endpoint is specifically designed to download files:
26344
- - The endpoint returns raw binary file content (PDFs, images, ZIP files, etc.)
26345
- - The endpoint is a file download service (e.g., downloading invoices, reports, attachments)
26346
- - The response body contains file data that needs to be saved as a file, not parsed as records
26347
- - You need to download and process files from a remote server
26350
+ Set this field to 'file' in two situations:
26351
+ - The HTTP endpoint is specifically designed to download files — it returns raw binary
26352
+ file content (PDFs, images, ZIP files) or is a file download service (invoices,
26353
+ reports, attachments) whose body is saved as a file rather than parsed as records
26354
+ - The connection is a cloud file provider used in FOLDER mode (Google Drive, Box, Dropbox,
26355
+ Azure Blob Storage, Google Cloud Storage, Celigo Storage): the export reads the files
26356
+ in a folder and the 'file' object's `type` (csv, json, xml, xlsx, filedefinition)
26357
+ parses each one into records — the same file layer as an FTP or S3 export
26348
26358
 
26349
26359
  Examples of when to set type: "file":
26350
26360
  - "Download PDF invoices from the API" → type: "file"
26351
26361
  - "Retrieve image files from a file server" → type: "file"
26352
- - "Download CSV files from an FTP server via HTTP" → type: "file"
26362
+ - "Read the CSV files dropped in our Google Drive folder" → type: "file", with file.type "csv"
26363
+ - "Parse EDI X12 850 files from a Google Drive / Celigo Storage folder" → type: "file",
26364
+ with file.type "filedefinition" and a top-level _ediProfileId (EDI fields are
26365
+ accepted on HTTP exports only in file mode)
26353
26366
  - |-
26354
26367
  ## IMPLEMENTATION DETAILS
26355
26368
 
@@ -26357,7 +26370,9 @@ components:
26357
26370
  - The 'file' object property MUST also be configured
26358
26371
  - The export appears as a "Transfer" step in the Flow Builder UI
26359
26372
  - The system applies file-specific processing to the HTTP response
26360
- - Downstream steps receive file content rather than record data
26373
+ - Downstream steps receive records when the 'file' object's `type` parses the files
26374
+ (csv, json, xml, xlsx, filedefinition with `file.output: "records"`), or the file
26375
+ content itself when `file.output` is "blobKeys"
26361
26376
 
26362
26377
  When this field is undefined (default for most exports):
26363
26378
  - The export appears as a standard "Export" step in the Flow Builder UI
@@ -26372,6 +26387,9 @@ components:
26372
26387
  → YES: Leave this field undefined
26373
26388
  3. Does the API endpoint return raw file content (PDFs, images, binary data)?
26374
26389
  → YES: Set this field to "file" (and configure the 'file' property)
26390
+ 4. Is the connection a cloud file provider and the export reads a FOLDER of files
26391
+ (CSV, JSON, XML, XLSX, or EDI via a file definition)?
26392
+ → YES: Set this field to "file" (and configure the 'file' property with the parsing type)
26375
26393
 
26376
26394
  Remember: When in doubt, leave this field undefined. Most HTTP exports are standard data exports.
26377
26395
  examples:
@@ -33626,9 +33644,12 @@ components:
33626
33644
  format: objectId
33627
33645
  x-celigo-refModel: ediprofiles
33628
33646
  description: |-
33629
- EDI profile this export uses to parse incoming X12 EDI documents into structured JSON —
33630
- it supplies the envelope qualifiers, delimiters, version, and validation rules. Set it
33631
- when the export parses or validates EDI files; omit it otherwise.
33647
+ EDI profile this export uses to parse incoming X12 or EDIFACT documents into structured
33648
+ JSON — it supplies the envelope qualifiers, delimiters, version, and validation rules.
33649
+ Set it when the export parses or validates EDI files; omit it otherwise. Accepted on the
33650
+ file-reading exports — FTP, AS2, S3 and HTTP file mode (`http.type: "file"`).
33651
+ x-celigo-ai-guidance:
33652
+ - 'An HTTP export accepts this field only in file mode (`http.type: "file"`, the folder mode of file-provider connectors such as Google Drive, Box, Dropbox, Azure Blob, Google Cloud Storage and Celigo Storage). On a REST/records HTTP export the save is rejected with `not_supported`: "EDIProfile can only be associated with the export of type FTP, AS2, S3 or HTTP file."'
33632
33653
  examples:
33633
33654
  - 60a2c4e6f321d800129a1a3c
33634
33655
  _postParseListenerId:
@@ -33638,8 +33659,10 @@ components:
33638
33659
  description: |-
33639
33660
  Webhook export invoked once per file after EDI parsing, on both success and failure
33640
33661
  (errors are included in the payload when parsing fails). Primarily used to send
33641
- functional acknowledgements (997/999) to trading partners. Only supported for
33642
- `AS2Export` and `FTPExport` parsing EDI files.
33662
+ functional acknowledgements (997/999) to trading partners. Accepted on the file-reading
33663
+ exports that parse EDI — FTP, AS2, S3 and HTTP file mode (`http.type: "file"`).
33664
+ x-celigo-ai-guidance:
33665
+ - 'The listener must be an export with `type: "webhook"` and `webhook.provider: "integrator-extension"`; any other export id is rejected with `invalid_post_parse_listener`. On an HTTP export outside file mode the save is rejected with `post_parse_listener_not_supported`: "Listener for functional acknowledgment is only supported for AS2, FTP, S3 and HTTP file export."'
33643
33666
  examples:
33644
33667
  - 60a2c4e6f321d800129a1a3c
33645
33668
  externalId:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@celigo/api-specs",
3
- "version": "0.2.22",
3
+ "version": "0.2.23",
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": "c51aefb",
4
+ "iasCommit": "ed5e198",
5
5
  "generatedAt": "2026-09-18"
6
6
  },
7
7
  "roots": {