@celigo/api-specs 0.2.135 → 0.2.137

package/dist/ai-agent.yml

@@ -4329,7 +4329,10 @@ components:
           transformed name: `data[0].name` copies a field of the first result,
           `data` copies the whole result array. A bare result-record field name
           (e.g. `name`) resolves to nothing and merges nothing, and so does the
-          raw response path a transform consumed.
+          raw response path a transform consumed. A lookup that groups its
+          results returns each group as an array inside `data`
+          (`"data": [[<row>, <row>]]`): `data[0][0].name` (or `data.0.0.name`)
+          reads the first row of the first group, and `data[0]` copies the group.
         - **Import steps**: `{"id": "<destination record id>", "statusCode": 200,
           "ignored": false, "errors": [], "_json": <raw destination response>,
           ...<response body fields flattened at the root>}` — use `id` for the

package/dist/ediprofile.yml

@@ -409,13 +409,19 @@ components:
             - edifact
         tpInterchangeId:
           type: string
-          description: Trading partner's interchange identifier (ISA06 for X12, UNB sender/receiver ID for EDIFACT)
+          description: |-
+            Trading partner's interchange identifier: the sender ID on files the partner sends and the
+            receiver ID on files you send (X12 ISA06 and ISA08 respectively; the UNB sender and
+            recipient in EDIFACT).
           examples:
             - ACMECORP
             - '5412345678901'
         myInterchangeId:
           type: string
-          description: Your (sender/receiver) interchange identifier
+          description: |-
+            Your interchange identifier: the receiver ID on files the partner sends and the sender ID
+            on files you send (X12 ISA08 and ISA06 respectively; the UNB recipient and sender in
+            EDIFACT).
           examples:
             - MYCOMPANY
             - '1234567890123'
@@ -453,9 +459,12 @@ components:
             - '00'
         isa02:
           type: string
-          description: X12 ISA02 - Authorization Information (10 characters)
+          description: |-
+            X12 ISA02 — Authorization Information. When parsing, an inbound file's ISA02 must match
+            this value after trimming (`data_mismatch` otherwise), so a blank ISA02 matches `""` and
+            not ten spaces.
           examples:
-            - '          '
+            - ''
         isa03:
           type: string
           enum:
@@ -469,9 +478,12 @@ components:
             - '00'
         isa04:
           type: string
-          description: X12 ISA04 - Security Information (10 characters)
+          description: |-
+            X12 ISA04 — Security Information. When parsing, an inbound file's ISA04 must match this
+            value after trimming (`data_mismatch` otherwise), so a blank ISA04 matches `""` and not
+            ten spaces.
           examples:
-            - '          '
+            - ''
         tpIdQualifier:
           type: string
           description: |
@@ -539,12 +551,16 @@ components:
             - ':'
         tpGroupId:
           type: string
-          description: X12 GS02 - Trading partner's application sender/receiver code
+          description: |-
+            Trading partner's X12 application code: GS02 (sender) on files the partner sends and GS03
+            (receiver) on files you send.
           examples:
             - ACME
         myGroupId:
           type: string
-          description: X12 GS03 - Your application sender/receiver code
+          description: |-
+            Your X12 application code: GS03 (receiver) on files the partner sends and GS02 (sender) on
+            files you send.
           examples:
             - MYAPP
         gs07:

package/dist/editransaction.yml

@@ -209,9 +209,6 @@ paths:
                         fileType: X12
                         documentType: '850'
                         documentNumber: PO03302026A
-                        referenceDocumentNumber:
-                          - PO PO03302026A
-                        lifecycleStatus: PO received
                         direction: Inbound
                         faStatus: inProgress
                         sandbox: false

package/dist/export.yml

@@ -16385,8 +16385,10 @@ components:
           description: |-
             EDI profile this export uses to parse incoming X12 or EDIFACT documents into structured
             JSON — it supplies the envelope qualifiers, delimiters, version, and validation rules.
-            Set it when the export parses or validates EDI files; omit it otherwise. Accepted on the
-            file-reading exports — FTP, AS2, S3 and HTTP file mode (`http.type: "file"`).
+            Set it when the export parses or validates EDI files (a save with a `delimited/x12` file
+            definition at `version` `"2"` and no profile fails with 422 `missing_ediProfile`); omit
+            it otherwise. Accepted on the file-reading exports — FTP, AS2, S3 and HTTP file mode
+            (`http.type: "file"`).
           x-celigo-ai-guidance:
             - '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."'
           examples:

package/dist/filedefinition.yml

@@ -460,9 +460,9 @@ components:
         - **Delimited (CSV / TSV)** — one element per column.  `name` is
           the human label; `value` is the column id used to address the
           field downstream (e.g. `orderId`, `customerName`).
-        - **Fixed-width** — adds `startPosition` + `length` (or the
-          legacy `start` / `end` pair) to describe the column's offset
-          within each row.
+        - **Fixed-width** — one element per column, gaps included, each
+          with a `length`.  Columns are read in element order;
+          `startPosition` doesn't move a column.
         - **EDI X12 / EDIFACT** — element values follow the segmentNN
           convention (`ISA01`, `BEG03`, `UNB02`).  Segment-element
           definitions whose value comes from the trading-partner profile
@@ -489,7 +489,9 @@ components:
             descriptive text such as `Authorization Information
             Qualifier`; for delimited data columns, the output key (the
             parser uses `name` as the field key in each parsed
-            record); for the row-type marker, equals `value`.
+            record); for the row-type marker, equals `value` (in a
+            container's child rule, a marker whose `name` differs from
+            its `value` parses to an empty record without an error).
           examples:
             - Order ID
             - Authorization Information Qualifier
@@ -657,28 +659,30 @@ components:
           type: integer
           minimum: 1
           description: |
-            Fixed-width: 1-based start column (inclusive).  Pair with
-            `length` to describe the column extent.  Mutually exclusive
-            with the legacy `start` / `end` pair — pick one
-            convention per element.
+            Doesn't place the column: fixed-width columns are read in
+            element order, each `length` characters wide, so a definition
+            that skips columns misreads them without an error.  Describe a
+            gap with a placeholder element of the gap's width instead.
         length:
           type: integer
           minimum: 1
           description: |
-            Fixed-width: column width in characters.  Pair with
-            `startPosition`.
+            Fixed-width: column width in characters.  Every fixed-width
+            element needs one; the parser refuses an element without it
+            (`Every fixed width element must provide a "length" property
+            between 1 and 512.`).
         start:
           type: integer
           description: |
-            Legacy fixed-width start offset (kept for backward
-            compatibility).  Pair with `end`.  Prefer
-            `startPosition` + `length` on new definitions.
+            Legacy fixed-width start offset, paired with `end`.  It doesn't
+            replace `length`: an element with `start`/`end` and no
+            `length` is refused.
         end:
           type: integer
           description: |
-            Legacy fixed-width end offset (kept for backward
-            compatibility).  Pair with `start`.  Prefer
-            `startPosition` + `length` on new definitions.
+            Legacy fixed-width end offset, paired with `start`.  It doesn't
+            replace `length`: an element with `start`/`end` and no
+            `length` is refused.
     CompositeValue:
       type: object
       additionalProperties: true
@@ -735,11 +739,11 @@ components:
         - **Branch rule** — has `children` (and optionally `elements`).
           Used to nest loops / sub-segments.  EDI envelopes always nest
           their inner segments under `children`.
-        - **Container rule** — sets `container: true`.  Acts as a loop
-          wrapper without producing an output row of its own.  When
-          `container` is true, `maxOccurrence` MUST be greater than
-          `1` (the parser rejects `container: true` with `maxOccurrence
-          <= 1`).
+        - **Container rule** — sets `container: true`.  A loop wrapper
+          that produces no row of its own: a group `name`, a
+          `maxOccurrence` above `1` and no `elements`, with the repeated
+          row's rule under `children`.  It is the only shape that repeats
+          rows (see `container`).
 
         **Envelopes and `closeRule`**
 
@@ -782,7 +786,9 @@ components:
             `name` and `value` set to the segment id (e.g.
             `{"name": "ISA", "value": "ISA"}`) followed by one element
             per segment-element (`ISA01`, `ISA02`, ...).  Delimited
-            rules use one element per column.
+            rules use one element per column.  Omit the key on a rule
+            with no elements of its own, such as a container wrapper: an
+            empty `elements` array fails the parse.
           items:
             $ref: '#/components/schemas/Element'
         children:
@@ -822,13 +828,16 @@ components:
           type: boolean
           description: |
             Marks this rule as a pure loop wrapper that does not emit a
-            row of its own.  Used on EDI `ST` / `UNH` containers so
-            the parser knows to iterate the inner transaction body up to
-            `maxOccurrence` times without recording the wrapper itself.
+            row of its own, and is the only way rows repeat: give the
+            wrapper a group `name`, a `maxOccurrence` above `1` and no
+            `elements`, and put the repeated row's rule under its
+            `children` (for EDI, the `ST` or `UNH` rule with its elements,
+            children and `closeRule`).  Parsed rows come back as an array
+            under the wrapper's `name`; `container: true` on a rule with
+            its own `elements` isn't honored as a loop.
 
-            When `container: true` is set, `maxOccurrence` MUST be
-            greater than `1`.  The parser rejects
-            `container: true` paired with `maxOccurrence <= 1` with
+            The parser rejects `container: true` paired with
+            `maxOccurrence <= 1` with
             `Invalid rules: maxOccurences should be greater than '1',
             when the container is 'true'`.
           default: false
@@ -840,10 +849,10 @@ components:
           minimum: 1
           description: |
             Upper bound on how many times this rule may repeat at its
-            current position.  EDI envelopes typically use `1` (one
-            ISA per file, one GS per group), while transaction-set
-            loops (`ST` containers, line-item loops) use larger
-            values such as `1000`.
+            current position.  Rows repeat only under a `container`
+            wrapper, so larger values such as `1000` go on the wrapper of
+            an `ST` transaction set or a line-item loop; EDI envelopes use
+            `1` (one ISA per file, one GS per group).
 
             Required to be greater than `1` when `container` is
             `true`.
@@ -972,14 +981,15 @@ components:
           description: EDI document type for acknowledgement documents.
         globalId:
           type: string
-          description: |
-            Global identifier mapping to a known EDI standard document definition.
-
-            Required for EDI formats (`delimited/x12` or `delimited/edifact`) when the
-            account has an EDI license enabled. Must reference a valid entry in the
-            standard file definitions metadata. Immutable after creation.
+          description: |-
+            Entry in the platform's registry of standard EDI document definitions that this
+            definition is built from. On an EDI-licensed account an X12 or EDIFACT create without
+            it fails with 422 `global_id_not_provided`, and one naming an id the registry doesn't
+            have fails with 422 `invalid_global_id`. No public route lists the registry, so copy the
+            `globalId` of an existing definition for the same standard document. Immutable after
+            creation.
           examples:
-            - 3c7a8f2e-1234-5678-9abc-def012345678
+            - Generic-4010-850-PurchaseOrder
         rules:
           type: array
           x-celigo-agent:
@@ -991,12 +1001,14 @@ components:
             `format` (delimited, EDI X12/EDIFACT, and fixed-width): the first
             element is the file's root rule, EDI envelopes nest through
             `Rule.children`, and openers pair with trailers via
-            `Rule.closeRule`. Fixed-width rules carry the column offsets on
-            each element (`startPosition`/`length`).
+            `Rule.closeRule`. Fixed-width rules list every column in order,
+            each element with its `length`.
 
             The cleared / "no rules configured" form is an empty array `[]`.
             The serialized rules tree must not exceed 20 KB once attached to
-            the parent file definition document.
+            the parent file definition document. A save doesn't parse a sample,
+            so a tree that saves can still fail or drop rows when parsed; test
+            it against a sample with `POST /v1/processors/structuredFileParser`.
           items:
             $ref: '#/components/schemas/Rule'
         fixed:
@@ -1101,43 +1113,14 @@ components:
             - ext-filedef-12345
       x-celigo-ai-guidance:
         - |-
-          Delimited / EDI shape: an ordered list of root ``Rule`` nodes.
-          For non-EDI delimited files this is typically a single-element
-          array carrying one rule whose ``elements`` describe the
-          columns.  For EDI (X12 / EDIFACT) the array still has one root
-          rule, but that rule's ``children`` build the
-          envelope → group → transaction → segment hierarchy.
+          `rules` is an ordered array of `Rule` nodes for every `format`, fixed-width included. For
+          EDI (X12 / EDIFACT) the root rule's `children` build the envelope → group → transaction →
+          segment hierarchy.
         - |-
-          The rules tree describes how the structuredFileParser walks a file
-          row-by-row (delimited / EDI) or by fixed offsets (fixed-width) and
-          extracts named fields and nested loops/segments.
-
-          ## SHAPE — VARIES BY ``format``
-
-          Two valid top-level shapes, selected by the parent file definition's
-          ``format``:
-
-          - **Array of ``Rule``** — used by every delimited variant
-            (``delimited``, ``delimited/x12``, ``delimited/edifact``, etc.).
-            The first element is the file's root rule; for EDI, deeper
-            envelopes nest through ``Rule.children``.
-
-          - **Single ``Rule`` object** — used by ``format: "fixed"`` (fixed-
-            width).  The whole file is described by one rule whose
-            ``elements`` enumerate the columns by ``startPosition`` /
-            ``length``.
-
-          The ``oneOf`` below documents both shapes.  Tooling that consumes
-          this spec to drive UI rendering or generation should branch on
-          ``format`` to decide which arm applies — there is no
-          discriminator field on the rules tree itself.
-
-          ## EMPTY / CLEARED FORM
-
-          A cleared rules tree is ``[]`` for delimited / EDI and ``{}`` for
-          fixed-width.  Both empty forms are accepted by the parser as
-          "no rules configured" and round-trip cleanly through the
-          structuredFileParser.
+          Rows repeat only under an elements-less `container: true` rule (a group `name`,
+          `maxOccurrence` above 1, no `elements`) whose child rule carries the row's elements. A
+          row-marker rule with no such container above it matches only the first row, and the parser
+          drops the rest without an error.
     ResourceResponse:
       type: object
       description: Response