@celigo/api-specs 0.2.171 → 0.2.173

package/dist/export.yml

@@ -2910,15 +2910,30 @@ components:
                 - `"lessthan"`: Value is less than specified value (is less than)
                 - `"lessthanequals"`: Value is less than or equal to specified value (is less than or equals)
                 - `"startswith"`: String starts with specified prefix (starts with)
+                - `"notstartswith"`: String does not start with specified prefix (does not start with)
                 - `"endswith"`: String ends with specified suffix (ends with)
+                - `"notendswith"`: String does not end with specified suffix (does not end with)
                 - `"contains"`: String contains specified substring (contains)
                 - `"doesnotcontain"`: String does not contain specified substring (does not contain)
                 - `"empty"`: Field is missing or empty (is empty)
                 - `"notempty"`: Field contains a value (is not empty)
-                - `"matches"`: Matches a regular expression (matches)
-
-                `isempty`, `isnotempty` and `anyof` are not operators: they are refused with 422
-                "Invalid operation: <name>".
+                - `"matches"`: Matches a regular expression, ignoring case (matches)
+
+                Operator names are case-insensitive: `NOTEMPTY` and `endsWith` work and are stored
+                as sent. `isempty`, `isnotempty`, `anyof`, `notcontains`, `doesnotstartwith`,
+                `doesnotendwith`, `notmatches`, `doesnotmatch` and `notequal` are not operators:
+                they are refused with 422 "Invalid operation: <name>", with the name in lowercase,
+                both when the filter is saved and by `POST /v1/processors/filter`. To negate a
+                condition, wrap it in `not`.
+
+                The string comparisons (`equals`, `contains`, `startswith`, `endswith` and their
+                negations) are case-sensitive; wrap the field in `lowercase` to compare without case.
+                `matches` is not: every pattern is compiled with the flags `gi`, so `^paid$` also
+                matches `PAID` and `[a-z]` matches capital letters. An inline flag such as `(?i)`
+                makes the pattern invalid. The filter still saves, but in a run every record fails
+                with `FILTER_EVALUATION_FAILED` ("Invalid regular expression: /(?i)…/gi: Invalid
+                group"), and `POST /v1/processors/filter` refuses the call with 422 (live-verified
+                2026-10-22).
 
                 **Logical Operators**
                 - `"and"`: All conditions must be true
@@ -3208,7 +3223,9 @@ components:
               x-celigo-refModel: scripts
               description: |
                 Reference to the Script resource that contains the filtering logic. This must be a valid
-                ObjectId of a Script resource that exists in the system.
+                ObjectId of a Script resource in this account: any other id fails the save with 422
+                ("Only a script owned by the user or a script shared by the Integration App can be used
+                at filter.script._scriptId.").
 
                 The referenced script must contain the function specified in the `function` field
                 and must be written to handle filtering specifically. The script receives
@@ -12551,7 +12568,11 @@ components:
 
             **Simple Types (direct value mapping)**
             - `string`: Text values, converts other types to string representation
-            - `number`: Numeric values, attempts conversion from strings
+            - `number`: Numeric values. Converts a numeric string (`"24"` → `24`,
+              `"007"` → `7`) and leaves the field out for an empty string; a value
+              holding letters or a thousands separator (`"1,250.00"`) fails the
+              record with `non_parsable_string` (`<generate>: String contains alpha
+              characters`)
             - `boolean`: True/false values, converts truthy/falsy values
 
             Dates are represented as strings — use `string` for date fields and
@@ -12594,8 +12615,14 @@ components:
             - |-
               Missing `dataType` is rejected at save with validation error
               `[mandatory_destination_datatype] Destination datatype is a
-              required field.` When in doubt, use `"string"` — it accepts
-              any source value and the runtime will coerce it.
+              required field.`
+            - |-
+              Give each row the type the destination field expects; `"string"` is
+              not a safe default. It accepts any source value, but sends a numeric
+              source as text (`"24"`), which a destination that checks JSON types
+              refuses. Map numeric destination fields as `number`, which fails a
+              record (`non_parsable_string`) only when the value holds letters or a
+              thousands separator.
           enum:
             - string
             - number
@@ -12607,7 +12634,7 @@ components:
             - objectarray
           x-enumDescriptions:
             string: Text values; converts other types to their string representation.
-            number: Numeric values; attempts conversion from strings.
+            number: Numeric values; converts numeric strings, and fails the record (`non_parsable_string`) on letters or a thousands separator.
             boolean: True/false values; converts truthy/falsy values.
             object: Nested object built from child `mappings`, or copied whole with `extract` (not both).
             stringarray: Array of string values.
@@ -13635,7 +13662,11 @@ components:
 
               **Simple Types (direct value mapping)**
               - `string`: Text values, converts other types to string representation
-              - `number`: Numeric values, attempts conversion from strings
+              - `number`: Numeric values. Converts a numeric string (`"24"` → `24`,
+                `"007"` → `7`) and leaves the field out for an empty string; a value
+                holding letters or a thousands separator (`"1,250.00"`) fails the
+                record with `non_parsable_string` (`<generate>: String contains alpha
+                characters`)
               - `boolean`: True/false values, converts truthy/falsy values
 
               Dates are represented as strings — use `string` for date fields and
@@ -13678,8 +13709,14 @@ components:
               - |-
                 Missing `dataType` is rejected at save with validation error
                 `[mandatory_destination_datatype] Destination datatype is a
-                required field.` When in doubt, use `"string"` — it accepts
-                any source value and the runtime will coerce it.
+                required field.`
+              - |-
+                Give each row the type the destination field expects; `"string"` is
+                not a safe default. It accepts any source value, but sends a numeric
+                source as text (`"24"`), which a destination that checks JSON types
+                refuses. Map numeric destination fields as `number`, which fails a
+                record (`non_parsable_string`) only when the value holds letters or a
+                thousands separator.
             enum:
               - string
               - number
@@ -13691,7 +13728,7 @@ components:
               - objectarray
             x-enumDescriptions:
               string: Text values; converts other types to their string representation.
-              number: Numeric values; attempts conversion from strings.
+              number: Numeric values; converts numeric strings, and fails the record (`non_parsable_string`) on letters or a thousands separator.
               boolean: True/false values; converts truthy/falsy values.
               object: Nested object built from child `mappings`, or copied whole with `extract` (not both).
               stringarray: Array of string values.
@@ -14833,7 +14870,7 @@ components:
 
               This value is used as a fallback when:
               1. The source value doesn't match any key in the map
-              2. allowFailures is set to true
+              2. allowFailures is true or omitted
 
               Setting an appropriate default helps prevent flow failures due to unexpected
               values and provides predictable behavior for edge cases.
@@ -14843,8 +14880,10 @@ components:
               - Original value indicators: "{Original Value}", "No mapping found"
               - Neutral values: "Other", "N/A", "Miscellaneous"
 
-              If allowFailures is false, a record whose value is unmapped fails and the default
-              is ignored.
+              A save refuses a default together with an explicit `allowFailures: false`
+              (422 `Lookups with default set can not have allowFailures explicitly set to
+              false.`): a lookup either fails a miss (`allowFailures: false`, no default) or
+              falls back to its default.
             examples:
               - Unknown
               - Other
@@ -14852,7 +14891,8 @@ components:
               - Unmapped Value
               - '{Original Value}'
             x-celigo-ai-guidance:
-              - 'Omit this field entirely when no fallback value is intended: a miss the lookup lets through then leaves the mapped field out, and with `allowFailures: false` a miss fails the record whatever the default. An empty string is a value, not "no default" — the save accepts `default: ""`, and an allowed miss writes `""`.'
+              - 'Omit this field entirely when no fallback value is intended: a miss the lookup lets through then leaves the mapped field out, and `allowFailures: false` (which a save refuses alongside a default) fails it. An empty string is a value, not "no default" — the save accepts `default: ""`, and an allowed miss writes `""`.'
+              - A default sends every unmapped value with no error, so add the missing key to the map when the destination needs the real value; keys match the extracted value exactly (case, spacing and suffixes count), and a save replaces the whole map.
           allowFailures:
             type:
               - boolean
@@ -15308,7 +15348,9 @@ components:
                 Reference to a predefined script resource containing the transformation logic.
 
                 The referenced script should contain the function specified in the
-                'function' property.
+                'function' property. It must be a script in this account: any other id fails the save
+                with 422 ("Only a script owned by the user or a script shared by the Integration App can
+                be used at transform.script._scriptId.").
               format: objectid
               x-celigo-refModel: scripts
               examples:
@@ -15378,8 +15420,8 @@ components:
                   id:
                     type: string
                     description: |
-                      Unique identifier for this field within the form.
-                      This value typically matches the key in the fieldMap object.
+                      Unique identifier for this field within the form: layout containers and conditions
+                      refer to the field by it. Use the same string as the field's fieldMap key and its `name`.
                     examples:
                       - url
                       - mode
@@ -15390,8 +15432,9 @@ components:
                   name:
                     type: string
                     description: |
-                      Name of the field, used as the property name when generating the settings object
-                      from the submitted form data.
+                      Key the field's value is saved under: one top-level key of the resource's `settings`,
+                      which the form also reads the value back from when it opens. Nested objects inside
+                      `settings` are written to it directly, not through a form field's `name`.
                     examples:
                       - url
                       - mode
@@ -15466,11 +15509,19 @@ components:
                   required:
                     type: boolean
                     description: |
-                      When true, the field must have a value before the form can be submitted.
+                      When true, the field must have a value before the form can be submitted. Only the form
+                      enforces it: an API write of `settings` is stored without the value.
                     default: false
                     examples:
                       - true
                       - false
+                  defaultValue:
+                    description: |
+                      Value the form shows while the resource's `settings` holds no value under the field's
+                      `name`.
+                    examples:
+                      - us
+                      - true
                   multiline:
                     type: boolean
                     description: |
@@ -15533,15 +15584,187 @@ components:
                   keyName:
                     type: string
                     description: |
-                      For keyvalue fields, specifies the placeholder and field name for the key input.
+                      For keyvalue and staticMap fields, names the first column: each saved row holds that
+                      column's value under this key. A keyvalue field without it uses `key`.
                     examples:
                       - theKey
+                      - source
                   valueName:
                     type: string
                     description: |
-                      For keyvalue fields, specifies the placeholder and field name for the value input.
+                      For keyvalue and staticMap fields, names the second column: each saved row holds that
+                      column's value under this key. A keyvalue field without it uses `value`.
                     examples:
                       - theValue
+                      - target
+                  keyLabel:
+                    type: string
+                    description: |
+                      For staticMap fields, heading of the first column.
+                    examples:
+                      - Source status
+                  valueLabel:
+                    type: string
+                    description: |
+                      For staticMap fields, heading of the second column.
+                    examples:
+                      - Destination status
+                  keyOptions:
+                    type: array
+                    description: |
+                      For staticMap fields, suggestions offered in the first column's cells. A cell still
+                      accepts a typed value.
+                    items:
+                      type: object
+                      properties:
+                        label:
+                          type: string
+                          description: |
+                            Display text for the suggestion.
+                        value:
+                          type: string
+                          description: |
+                            Value saved when the suggestion is chosen.
+                    examples:
+                      - - label: Pending
+                          value: pending
+                        - label: Shipped
+                          value: shipped
+                  valueOptions:
+                    type: array
+                    description: |
+                      For staticMap fields, suggestions offered in the second column's cells. A cell still
+                      accepts a typed value.
+                    items:
+                      type: object
+                      properties:
+                        label:
+                          type: string
+                          description: |
+                            Display text for the suggestion.
+                        value:
+                          type: string
+                          description: |
+                            Value saved when the suggestion is chosen.
+                    examples:
+                      - - label: Open
+                          value: open
+                        - label: Closed
+                          value: closed
+                  keyResource:
+                    type: object
+                    description: |
+                      For staticMap fields, fills the first column's suggestions from an export the form
+                      carries inline in `virtual`, run the way an exportSelect's `resource` is. With
+                      `keyResource` or `valueResource` set, the form requires both columns in every row
+                      unless `keyValueRequired` is false.
+                    properties:
+                      virtual:
+                        type: object
+                        description: |
+                          Export document to run, inline, shaped like an exportSelect's `resource.virtual`.
+                        additionalProperties: true
+                  valueResource:
+                    type: object
+                    description: |
+                      For staticMap fields, fills the second column's suggestions from an export the form
+                      carries inline in `virtual`, run the way an exportSelect's `resource` is.
+                    properties:
+                      virtual:
+                        type: object
+                        description: |
+                          Export document to run, inline, shaped like an exportSelect's `resource.virtual`.
+                        additionalProperties: true
+                  keyValueRequired:
+                    type: boolean
+                    description: |
+                      For staticMap fields with `keyResource` or `valueResource`, when false, saves rows
+                      that fill only one column; by default the form drops them.
+                    default: true
+                    examples:
+                      - false
+                  resource:
+                    type: object
+                    description: |
+                      For exportSelect fields, the export whose records become the options. When the form
+                      opens, the UI previews the export in `virtual` (with `test.limit` 100 unless the export
+                      sets its own) and lists the preview's `data`: each record needs a `label` and a `value`
+                      (a string or number serves as both), so shape them with the export's `transform`. A
+                      saved export can't be referenced, and an HTTP export that finds no records leaves the
+                      field showing an error instead of options.
+                    properties:
+                      virtual:
+                        type: object
+                        description: |
+                          Export document to run, inline: `adaptorType`, its adaptor block, and an optional
+                          `transform`. `_connectionId` defaults to the connection of the export or import the
+                          form belongs to; set it on any other resource's form.
+                        additionalProperties: true
+                    examples:
+                      - virtual:
+                          adaptorType: HTTPExport
+                          http:
+                            relativeURI: /v1/warehouses
+                            method: GET
+                            formType: http
+                            response:
+                              resourcePath: warehouses
+                          transform:
+                            type: expression
+                            expression:
+                              version: '2'
+                              rulesTwoDotZero:
+                                mode: create
+                                mappings:
+                                  - generate: label
+                                    extract: $.name
+                                    dataType: string
+                                    status: Active
+                                  - generate: value
+                                    extract: $.code
+                                    dataType: string
+                                    status: Active
+                  multiselect:
+                    type: boolean
+                    description: |
+                      For exportSelect fields, when true, the user can choose several options and the value
+                      is saved as an array.
+                    default: false
+                    examples:
+                      - true
+                  supportHandlebars:
+                    type: boolean
+                    description: |
+                      For exportSelect fields, when true, renders the `resource.virtual` export as a Handlebars
+                      template before each preview (all but its `transform`, `hooks`, and `filter`). On an
+                      integration, flow group, flow, export, or import form, the form's current values are
+                      under that form's scope name (`integration`, `flowGrouping`, `flow`, `export`, or
+                      `import`), beside the saved settings of the scopes above it, with no `settings.`
+                      prefix; on a connection or iClient form the template has no context. The options then
+                      load through `refreshOptionsOnChangesTo` or `typeAheadSearch`, or when the user
+                      refreshes the field.
+                    default: false
+                    examples:
+                      - true
+                  refreshOptionsOnChangesTo:
+                    type: array
+                    items:
+                      type: string
+                    description: |
+                      For exportSelect fields with `supportHandlebars`, ids of the fields whose values the
+                      templated export uses: the options load once one of them has a value and reload whenever
+                      one changes.
+                    examples:
+                      - - region
+                  typeAheadSearch:
+                    type: boolean
+                    description: |
+                      For exportSelect fields, when true, re-runs the templated export as the user types, with
+                      the typed text as this field's own value; an empty box clears the options, and typed
+                      text is accepted as the value.
+                    default: false
+                    examples:
+                      - true
                   showDelete:
                     type: boolean
                     description: |
@@ -15642,7 +15865,9 @@ components:
                         field:
                           type: string
                           description: |
-                            The ID of another field whose value controls the visibility of this field.
+                            The ID of another field whose value controls the visibility of this field. The
+                            save doesn't check it: a rule naming an ID that isn't in the form counts as met,
+                            so the field stays visible.
                           examples:
                             - mode
                         is:
@@ -15678,7 +15903,7 @@ components:
                     - tabWithoutSave
                     - verticalTabWithoutSave
                   x-enumDescriptions:
-                    column: Arranges form fields in a single vertical column layout.
+                    column: Places the containers side by side, one column each.
                     collapse: Groups fields into collapsible/expandable sections.
                     box: Wraps field groups in bordered boxes with headings.
                     indent: Indents field groups to show hierarchy.
@@ -15687,6 +15912,15 @@ components:
                   examples:
                     - column
                     - collapse
+                fields:
+                  type: array
+                  items:
+                    type: string
+                  description: |
+                    Field IDs shown above the containers, without a heading.
+                  examples:
+                    - - region
+                      - vatNumber
                 containers:
                   type: array
                   description: |
@@ -15726,7 +15960,8 @@ components:
                           type: string
                         description: |
                           Array of field IDs that should be displayed in this container.
-                          Each ID must correspond to a key in the fieldMap object.
+                          Each ID must correspond to a key in the fieldMap object: the save doesn't check it,
+                          and an ID that doesn't renders nothing. A field the layout doesn't list isn't shown.
                         examples:
                           - - A
                             - url
@@ -15803,6 +16038,9 @@ components:
 
             The function must return a valid form object that the UI can render.
             Throwing an exception will signal an error to the user.
+
+            The UI runs the function each time it opens the form and renders the returned form instead of
+            `form`, then fills in the values from `settings`; a thrown error's message replaces the form.
           properties:
             function:
               type: string
@@ -15826,8 +16064,10 @@ components:
                 Reference to a predefined script resource containing the initialization function.
 
                 The referenced script should contain the function specified in the
-                'function' property. This script must be accessible within the user's account
-                and have appropriate permissions.
+                'function' property. On an integration, a flow group, a flow, an export, an import, or a
+                connection, an id that isn't a script in the same account (or, on an Integration App's
+                resources, one the app shares) is refused with 422 `invalid_ref`. An iClient save
+                stores the id without that check.
               examples:
                 - 60a2c4e6f321d800129a1a3c
                 - 5f8d43a1b9e5a80011a35f2c
@@ -16238,8 +16478,11 @@ components:
             (CSV/XML/JSON) into records. Most modes take their matching configuration object (e.g. a
             `webhook` object when `type` is `webhook`); an HTTP or SQL `delta` export saves without a
             `delta` object because its request carries `{{lastExportDateTime}}`, though
-            `delta.startDate` sets its first window. Use `blob` only to transfer raw files without
-            parsing their contents.
+            `delta.startDate` sets its first window. It still needs `type: delta`: on an export
+            with no `type`, `{{lastExportDateTime}}` and `{{currentExportDateTime}}` render
+            empty on every run, so a request that carries them goes out with blank values each time
+            (live-verified 2026-10-22). Use `blob` only to transfer raw files without parsing their
+            contents.
           x-celigo-ai-guidance:
             - |-
               ## HOW TO PICK THE TYPE VALUE
@@ -16626,7 +16869,10 @@ components:
                   type: string
                   format: objectId
                   x-celigo-refModel: scripts
-                  description: Script containing the hook function named in `function`.
+                  description: |-
+                    Script containing the hook function named in `function`. Must be a script in this
+                    account: any other id fails the save with 422 ("Only a script owned by the user or
+                    a script shared by the Integration App can be used at hooks.preSavePage._scriptId.").
                   examples:
                     - 60a2c4e6f321d800129a1a3c
                     - 5f8e7d2c1b54e6003a9c7e12
@@ -16737,7 +16983,10 @@ components:
           type: string
           format: objectId
           x-celigo-refModel: connectors
-          description: Connector this export was created from, set when the export is part of an installed integration app.
+          description: |-
+            Connector this export was created from, set when the export is part of an installed
+            integration app. The app's install sets it: a create that sends it is refused with 403
+            ("Cannot create an Integration App resource").
         unencrypted:
           type: object
           description: Custom configuration values stored without encryption and returned in API responses.