@celigo/api-specs 0.2.28 → 0.2.30

package/dist/import.yml

@@ -1560,7 +1560,9 @@ components:
       type: object
       description: |-
         Configuration for HTTP imports.
-        Required whenever the connection referenced by _connectionId has type http.
+        Required whenever the connection referenced by _connectionId has type http, and on
+        `NetSuiteHTTPImport` (NetSuite's REST APIs on a `netsuite` connection, where `nsDomainType`
+        supplies the host).
       x-celigo-ai-guidance:
         - |-
           IMPORTANT:
@@ -1568,6 +1570,11 @@ components:
           this object MUST be populated for the import to function properly.
           This is a required configuration for all HTTP based imports,
           as determined by the connection associated with the import.
+        - |-
+          A `NetSuiteHTTPImport` uses this same object on a netsuite connection: each `relativeURI`
+          entry carries the full path from `/services/rest/record/v1/<type>` (SuiteTalk) or
+          `/app/site/hosting/restlet.nl?script=<id>&deploy=<n>` (custom RESTlet); the host and the
+          token signature come from the connection.
       properties:
         sendPostMappedData:
           type: boolean
@@ -11225,9 +11232,11 @@ components:
             This field supports THREE DISTINCT PATTERNS that are easily distinguished:
 
             **1. json Path Syntax**
-            - MUST start with '$.' prefix
+            - MUST start with '$' — the record root. An object record is addressed as
+              '$.field'; a grouped (array) record as '$[0].field' / '$[*].field'
             - Used for precisely targeting data in structured JSON objects
-            - Examples: '$.customer.firstName', '$.items[0].price', '$.addresses[*].street'
+            - Examples: '$.customer.firstName', '$.items[0].price', '$.addresses[*].street',
+              '$[*].Tax' (every row of a grouped record)
             - Wildcards like [*] extract multiple values/objects
 
             ```json
@@ -11238,7 +11247,8 @@ components:
             - Contains '{{' and '}}' pattern
             - Evaluated by the AFE 2.0 handlebars template engine
             - Can include logic, formatting, and computation
-            - Access input record fields with {{record.fieldName}} notation
+            - Access input record fields with {{record.fieldName}} notation; a grouped
+              (array) record binds as `rows` instead — {{rows.0.fieldName}} / {{#each rows}}
             - Examples: "{{record.firstName}} {{record.lastName}}", "{{#if record.isActive}}Active{{else}}Inactive{{/if}}"
             - Valid on `object`, `objectarray`, and primitive-array dataTypes as
               well as scalars — the rendered template output must parse into the
@@ -11249,7 +11259,7 @@ components:
             ```
 
             **3. Hard-Coded Value (literal string)**
-            - Does NOT start with '$.'
+            - Does NOT start with '$'
             - Does NOT contain handlebars '{{' syntax
             - System treats it as a literal string value
             - VERY COMMON for setting static/constant values
@@ -11271,10 +11281,38 @@ components:
             - The system maintains this context even in deeply nested mappings
             - For object mappings without child mappings, extract should return a complete object
             - When both extract and mappings are defined for objects, extract is applied first
+            - The root is the record as it arrives: an object record roots at `$.field`; a
+              grouped record (an array of rows — grouped exports, file key columns, NetSuite
+              grouped saved searches) roots at the array, so its rows are addressed as
+              `$[0].field` (one row) or `$[*].field` (every row). A root that contradicts the
+              record's shape resolves to nothing without an error.
 
             For most simple field-to-field mappings, prefer JSON path syntax for its clarity and performance.
             For hard-coded values, simply use the literal string as the extract value.
           x-celigo-ai-guidance:
+            - |-
+              ## GROUPED (ARRAY) RECORDS
+              Decide the JSONPath root from the record's shape before writing
+              any extract. When the record is an array of rows, `$.field`,
+              `$.properties.field` and `$.rows[*].field` all resolve to
+              nothing — the processor still reports success and the request
+              body ships as `{}`. Address rows as `$[0].field` (that row's
+              value, typed) or `$[*].field` (every row: joined with commas
+              into a `string` destination; rejected with
+              `incompatible_destination_conversion` into a `number`
+              destination). Column labels with spaces work as
+              `$[*][Order Number]`, `$[*].[Order Number]`, or
+              `$[*]['Order Number']`. For one destination element per row
+              the two array kinds take different helper forms: a primitive
+              array (`stringarray` / `numberarray`) uses `buildArrayHelper:
+              [{"extract": "$[*].field"}]`; an `objectarray` uses
+              `buildArrayHelper: [{"extract": "$[*]", "mappings": [...]}]`
+              with the children addressing the row relatively (`$.field`,
+              `{{rows.field}}`). An `extract` placed directly on the
+              array-typed field yields nothing. Handlebars
+              extracts bind the array record as `rows` (`{{rows.0.field}}`),
+              an object record as `record`. The reverse holds too: `$[*]` on
+              an object record iterates the object's values, not rows.
             - |-
               ## SIZE LIMIT
               The platform's import save validator caps this field at **1024
@@ -11532,7 +11570,11 @@ components:
               (`$.items[*]`), `"$"` (the record root), or omission — a
               constructed entry (child `mappings` with the extract omitted or
               `"$"`; the two spellings are equivalent) contributes exactly one
-              element, and entries append in order. Indexed or comma-joined
+              element, and entries append in order. On a grouped (array)
+              record the record itself is the array to iterate: `"$[*]"`
+              yields one `objectarray` element per row (children address the
+              row as `$.field`), and `"$[*].field"` yields one primitive-array
+              value per row. Indexed or comma-joined
               entry extracts (`"$[0]"`, `"$[0],$[0]"`) are not valid: the
               processor renders the entire destination array as null with no
               validation error. To emit a fixed number of static elements, add
@@ -11553,7 +11595,9 @@ components:
 
             **For Simple Arrays (stringarray, numberarray, booleanarray)**
             - Only the 'extract' field is used to pull values
-            - JSON path with wildcards (e.g., $.items[*].name) returns multiple values
+            - JSON path with wildcards (e.g., $.items[*].name) returns multiple values;
+              on a grouped (array) record the record itself is the array, so the
+              path roots at it ($[*].name — one value per row)
             - Each result is converted to the appropriate primitive type
             ```json
             {
@@ -11655,11 +11699,13 @@ components:
             - When both extract and mappings are provided, the system creates special composite objects
               that maintain hierarchical context during processing
             - This enables accessing both the current array element AND its parent context
-            - An ITERATING entry's extract MUST use JSON path syntax starting with '$.'
-              (e.g. '$.items[*]'). A CONSTRUCTED entry (child mappings building one element)
-              instead omits extract or sets it to exactly "$" — never rewrite "$" into a
-              '$.'-prefixed, indexed, or comma-joined form ('$[0]', '$[0],$[0]'): those render
-              the entire destination array as null without raising a validation error
+            - An ITERATING entry's extract MUST be a JSON path that iterates an array:
+              '$.items[*]' when the array is a field of an object record, or '$[*]'
+              (objectarray) / '$[*].field' (primitive arrays) when the record itself is a
+              grouped array of rows. A CONSTRUCTED entry (child mappings building one
+              element) instead omits extract or sets it to exactly "$" — never rewrite "$"
+              into an indexed or comma-joined form ('$[0]', '$[0],$[0]'): those render the
+              entire destination array as null without raising a validation error
             - Each array helper entry acts independently, potentially adding multiple elements
 
             The buildArrayHelper is the most complex part of the mappings system - always analyze the
@@ -12073,9 +12119,11 @@ components:
               This field supports THREE DISTINCT PATTERNS that are easily distinguished:
 
               **1. json Path Syntax**
-              - MUST start with '$.' prefix
+              - MUST start with '$' — the record root. An object record is addressed as
+                '$.field'; a grouped (array) record as '$[0].field' / '$[*].field'
               - Used for precisely targeting data in structured JSON objects
-              - Examples: '$.customer.firstName', '$.items[0].price', '$.addresses[*].street'
+              - Examples: '$.customer.firstName', '$.items[0].price', '$.addresses[*].street',
+                '$[*].Tax' (every row of a grouped record)
               - Wildcards like [*] extract multiple values/objects
 
               ```json
@@ -12086,7 +12134,8 @@ components:
               - Contains '{{' and '}}' pattern
               - Evaluated by the AFE 2.0 handlebars template engine
               - Can include logic, formatting, and computation
-              - Access input record fields with {{record.fieldName}} notation
+              - Access input record fields with {{record.fieldName}} notation; a grouped
+                (array) record binds as `rows` instead — {{rows.0.fieldName}} / {{#each rows}}
               - Examples: "{{record.firstName}} {{record.lastName}}", "{{#if record.isActive}}Active{{else}}Inactive{{/if}}"
               - Valid on `object`, `objectarray`, and primitive-array dataTypes as
                 well as scalars — the rendered template output must parse into the
@@ -12097,7 +12146,7 @@ components:
               ```
 
               **3. Hard-Coded Value (literal string)**
-              - Does NOT start with '$.'
+              - Does NOT start with '$'
               - Does NOT contain handlebars '{{' syntax
               - System treats it as a literal string value
               - VERY COMMON for setting static/constant values
@@ -12119,10 +12168,38 @@ components:
               - The system maintains this context even in deeply nested mappings
               - For object mappings without child mappings, extract should return a complete object
               - When both extract and mappings are defined for objects, extract is applied first
+              - The root is the record as it arrives: an object record roots at `$.field`; a
+                grouped record (an array of rows — grouped exports, file key columns, NetSuite
+                grouped saved searches) roots at the array, so its rows are addressed as
+                `$[0].field` (one row) or `$[*].field` (every row). A root that contradicts the
+                record's shape resolves to nothing without an error.
 
               For most simple field-to-field mappings, prefer JSON path syntax for its clarity and performance.
               For hard-coded values, simply use the literal string as the extract value.
             x-celigo-ai-guidance:
+              - |-
+                ## GROUPED (ARRAY) RECORDS
+                Decide the JSONPath root from the record's shape before writing
+                any extract. When the record is an array of rows, `$.field`,
+                `$.properties.field` and `$.rows[*].field` all resolve to
+                nothing — the processor still reports success and the request
+                body ships as `{}`. Address rows as `$[0].field` (that row's
+                value, typed) or `$[*].field` (every row: joined with commas
+                into a `string` destination; rejected with
+                `incompatible_destination_conversion` into a `number`
+                destination). Column labels with spaces work as
+                `$[*][Order Number]`, `$[*].[Order Number]`, or
+                `$[*]['Order Number']`. For one destination element per row
+                the two array kinds take different helper forms: a primitive
+                array (`stringarray` / `numberarray`) uses `buildArrayHelper:
+                [{"extract": "$[*].field"}]`; an `objectarray` uses
+                `buildArrayHelper: [{"extract": "$[*]", "mappings": [...]}]`
+                with the children addressing the row relatively (`$.field`,
+                `{{rows.field}}`). An `extract` placed directly on the
+                array-typed field yields nothing. Handlebars
+                extracts bind the array record as `rows` (`{{rows.0.field}}`),
+                an object record as `record`. The reverse holds too: `$[*]` on
+                an object record iterates the object's values, not rows.
               - |-
                 ## SIZE LIMIT
                 The platform's import save validator caps this field at **1024
@@ -12380,7 +12457,11 @@ components:
                 (`$.items[*]`), `"$"` (the record root), or omission — a
                 constructed entry (child `mappings` with the extract omitted or
                 `"$"`; the two spellings are equivalent) contributes exactly one
-                element, and entries append in order. Indexed or comma-joined
+                element, and entries append in order. On a grouped (array)
+                record the record itself is the array to iterate: `"$[*]"`
+                yields one `objectarray` element per row (children address the
+                row as `$.field`), and `"$[*].field"` yields one primitive-array
+                value per row. Indexed or comma-joined
                 entry extracts (`"$[0]"`, `"$[0],$[0]"`) are not valid: the
                 processor renders the entire destination array as null with no
                 validation error. To emit a fixed number of static elements, add
@@ -12401,7 +12482,9 @@ components:
 
               **For Simple Arrays (stringarray, numberarray, booleanarray)**
               - Only the 'extract' field is used to pull values
-              - JSON path with wildcards (e.g., $.items[*].name) returns multiple values
+              - JSON path with wildcards (e.g., $.items[*].name) returns multiple values;
+                on a grouped (array) record the record itself is the array, so the
+                path roots at it ($[*].name — one value per row)
               - Each result is converted to the appropriate primitive type
               ```json
               {
@@ -12503,11 +12586,13 @@ components:
               - When both extract and mappings are provided, the system creates special composite objects
                 that maintain hierarchical context during processing
               - This enables accessing both the current array element AND its parent context
-              - An ITERATING entry's extract MUST use JSON path syntax starting with '$.'
-                (e.g. '$.items[*]'). A CONSTRUCTED entry (child mappings building one element)
-                instead omits extract or sets it to exactly "$" — never rewrite "$" into a
-                '$.'-prefixed, indexed, or comma-joined form ('$[0]', '$[0],$[0]'): those render
-                the entire destination array as null without raising a validation error
+              - An ITERATING entry's extract MUST be a JSON path that iterates an array:
+                '$.items[*]' when the array is a field of an object record, or '$[*]'
+                (objectarray) / '$[*].field' (primitive arrays) when the record itself is a
+                grouped array of rows. A CONSTRUCTED entry (child mappings building one
+                element) instead omits extract or sets it to exactly "$" — never rewrite "$"
+                into an indexed or comma-joined form ('$[0]', '$[0],$[0]'): those render the
+                entire destination array as null without raising a validation error
               - Each array helper entry acts independently, potentially adding multiple elements
 
               The buildArrayHelper is the most complex part of the mappings system - always analyze the
@@ -12964,6 +13049,16 @@ components:
                   x-enumDescriptions:
                     create: Builds entirely new output records from inputs, ignoring unmapped fields.
                     modify: Makes targeted edits to existing records, preserving unmapped fields.
+                  x-celigo-ai-guidance:
+                    - |-
+                      On a grouped record (the export groups rows, so the record is an
+                      array) only `create` can author output — build it from the rows with
+                      `$[0].field`, `$[*].field`, or a `buildArrayHelper` over `$[*]`.
+                      `modify` has no object to overlay onto an array: the record passes
+                      through untouched and the processor reports success. Either mode
+                      reshapes the inside of one record; neither changes how many records
+                      the page carries (that is the export's `preSavePage` hook) or whether
+                      the export groups at all (that is its grouping setting).
                   examples:
                     - create
                     - modify
@@ -13997,6 +14092,7 @@ components:
           description: |-
             Connection this import uses to reach the destination system. The connection's type must
             be compatible with the import's `adaptorType` (e.g. an `HTTPImport` needs an `http`
+            connection; `NetSuiteDistributedImport` and `NetSuiteHTTPImport` both need a `netsuite`
             connection). Server-required — POST without it fails with 422 "Expected field:
             _connectionId to be present" — except for the connection-less flavors (`ToolImport`,
             `AiAgentImport`, `GuardrailImport`), which the server creates without one.
@@ -14029,9 +14125,15 @@ components:
               Use HTTPImport for all REST/SOAP APIs unless a specialized adaptor exists for the
               target system; always pair the adaptorType with its matching configuration object.
             - |-
-              For NetSuite, always use NetSuiteDistributedImport (with the netsuite_da object).
-              NetSuiteImport is a legacy adaptor for accounts without the Celigo SuiteApp 2.0 — do
-              not use it unless explicitly requested.
+              For NetSuite, use NetSuiteDistributedImport (with the netsuite_da object) when the
+              Celigo SuiteApp or bundle is installed in the account — check with
+              `GET /v1/connections/{_id}/distributedApps` (`suiteapp.success` / `bundle.success`).
+              Use NetSuiteHTTPImport (with `nsDomainType` and the http object) when neither is
+              installed or the user asks for NetSuite's REST APIs; the platform's SuiteTalk connector
+              catalogs `POST /services/rest/record/v1/<type>` for inserts and
+              `PATCH /services/rest/record/v1/<type>/{id}` for updates, and saving links the step to
+              them. NetSuiteImport is a legacy adaptor for accounts without the Celigo SuiteApp 2.0 —
+              do not use it unless explicitly requested.
             - |-
               Use RDBMSImport (with the rdbms object) for built-in database types such as SQL Server,
               MySQL, PostgreSQL, Snowflake, Oracle, and MariaDB. Use JDBCImport (with the jdbc
@@ -14043,6 +14145,7 @@ components:
             - S3Import
             - NetSuiteImport
             - NetSuiteDistributedImport
+            - NetSuiteHTTPImport
             - SalesforceImport
             - JDBCImport
             - RDBMSImport
@@ -14060,7 +14163,8 @@ components:
             AS2Import: File import via AS2 (Applicability Statement 2) protocol.
             S3Import: File import to Amazon S3 storage.
             NetSuiteImport: Legacy NetSuite import for accounts without the Celigo SuiteApp 2.0.
-            NetSuiteDistributedImport: NetSuite import using the distributed SuiteApp 2.0 adaptor (default for NetSuite).
+            NetSuiteDistributedImport: NetSuite import using the distributed SuiteApp 2.0 adaptor (default for NetSuite when the SuiteApp or bundle is installed).
+            NetSuiteHTTPImport: NetSuite import over its REST APIs — SuiteTalk REST record endpoints or a custom RESTlet — on a netsuite connection, without the Celigo SuiteApp or bundle.
             SalesforceImport: Salesforce-specific import using SOAP, REST, Metadata, or Composite APIs.
             JDBCImport: Database import via a generic JDBC connection (not for built-in RDBMS types).
             RDBMSImport: Database import for built-in RDBMS types such as SQL Server, MySQL, PostgreSQL, Snowflake, and Oracle.
@@ -14075,10 +14179,38 @@ components:
           examples:
             - HTTPImport
             - NetSuiteDistributedImport
+            - NetSuiteHTTPImport
             - SalesforceImport
             - FTPImport
             - AiAgentImport
             - GuardrailImport
+        nsDomainType:
+          type: string
+          enum:
+            - suitetalk
+            - restlet
+          x-lowercase: true
+          x-enumDescriptions:
+            suitetalk: NetSuite SuiteTalk REST web services — record endpoints under /services/rest/record/v1
+            restlet: A custom RESTlet script deployed in the NetSuite account, called at /app/site/hosting/restlet.nl?script=<id>&deploy=<n>
+          description: |-
+            Selects which NetSuite REST host a `NetSuiteHTTPImport` calls. The server derives the
+            full base URL from the connection's NetSuite account
+            (`https://<account>.suitetalk.api.netsuite.com` or `https://<account>.restlets.api.netsuite.com`)
+            and signs each request with the connection's token-based credentials, so each
+            `http.relativeURI` entry carries the complete path starting at `/services/rest/...` or
+            `/app/site/hosting/restlet.nl`. Ignored on other adaptor types.
+          x-celigo-ai-guidance:
+            - |-
+              Required on `NetSuiteHTTPImport`: omitting it fails the save with 422 "Path `nsDomainType`
+              is required." The import's `_connectionId` must be a netsuite connection — an http
+              connection fails with 422 invalid_connection_type.
+            - |-
+              With `suitetalk`, saving links `http._httpConnectorVersionId`, `_httpConnectorResourceId`
+              and `_httpConnectorEndpointIds` to the platform's SuiteTalk connector from each
+              `http.method` + `http.relativeURI` pair (for example `POST /services/rest/record/v1/customer`
+              links to that record type's insert endpoint), so the UI's Simple view renders an
+              API-authored step; `restlet` steps are not linked.
         externalId:
           type:
             - string
@@ -15111,6 +15243,16 @@ components:
       else:
         required:
           - _connectionId
+        if:
+          properties:
+            adaptorType:
+              const: NetSuiteHTTPImport
+          required:
+            - adaptorType
+        then:
+          required:
+            - http
+            - nsDomainType
     Error:
       type: object
       description: Standard error response envelope returned by integrator.io APIs.