@celigo/api-specs 0.2.140 → 0.2.142
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/ai-agent.yml +2 -2
- package/dist/api.yml +20 -14
- package/dist/asynchelper.yml +2 -2
- package/dist/connection.yml +14 -8
- package/dist/enduser.yml +9 -6
- package/dist/export.yml +19 -12
- package/dist/import.yml +8 -5
- package/dist/mcp-server.yml +9 -6
- package/dist/tool.yml +34 -21
- package/package.json +1 -1
- package/schemas.json +1 -1
package/dist/ai-agent.yml
CHANGED
|
@@ -2699,7 +2699,7 @@ components:
|
|
|
2699
2699
|
**When to Use**
|
|
2700
2700
|
- REQUIRED when dataType = "object" (unless you are copying an entire object from the input record)
|
|
2701
2701
|
- REQUIRED in buildArrayHelper.mappings when defining complex object array elements
|
|
2702
|
-
- NEVER used with simple types (string, number, boolean
|
|
2702
|
+
- NEVER used with simple types (string, number, boolean)
|
|
2703
2703
|
|
|
2704
2704
|
**Behavior**
|
|
2705
2705
|
- Each mapping in this array becomes a property of the parent object
|
|
@@ -3765,7 +3765,7 @@ components:
|
|
|
3765
3765
|
**When to Use**
|
|
3766
3766
|
- REQUIRED when dataType = "object" (unless you are copying an entire object from the input record)
|
|
3767
3767
|
- REQUIRED in buildArrayHelper.mappings when defining complex object array elements
|
|
3768
|
-
- NEVER used with simple types (string, number, boolean
|
|
3768
|
+
- NEVER used with simple types (string, number, boolean)
|
|
3769
3769
|
|
|
3770
3770
|
**Behavior**
|
|
3771
3771
|
- Each mapping in this array becomes a property of the parent object
|
package/dist/api.yml
CHANGED
|
@@ -3038,16 +3038,19 @@ components:
|
|
|
3038
3038
|
items: {}
|
|
3039
3039
|
examples:
|
|
3040
3040
|
- - equals
|
|
3041
|
-
- -
|
|
3042
|
-
-
|
|
3041
|
+
- - string
|
|
3042
|
+
- - extract
|
|
3043
|
+
- customerType
|
|
3043
3044
|
- premium
|
|
3044
3045
|
- - and
|
|
3045
|
-
- -
|
|
3046
|
-
- -
|
|
3047
|
-
-
|
|
3048
|
-
|
|
3049
|
-
|
|
3050
|
-
|
|
3046
|
+
- - notempty
|
|
3047
|
+
- - string
|
|
3048
|
+
- - extract
|
|
3049
|
+
- orderId
|
|
3050
|
+
- - greaterthan
|
|
3051
|
+
- - number
|
|
3052
|
+
- - extract
|
|
3053
|
+
- amount
|
|
3051
3054
|
- 1000
|
|
3052
3055
|
x-celigo-ai-guidance:
|
|
3053
3056
|
- |-
|
|
@@ -5260,7 +5263,11 @@ components:
|
|
|
5260
5263
|
$ref: '#/components/schemas/AIDescription'
|
|
5261
5264
|
offline:
|
|
5262
5265
|
type: boolean
|
|
5263
|
-
description:
|
|
5266
|
+
description: |-
|
|
5267
|
+
When true, the connection has been taken offline and is skipped during flow execution.
|
|
5268
|
+
The platform tests the connection after a create or `PUT` and updates this shortly
|
|
5269
|
+
afterwards (the audit log records a `system` change; `lastModified` doesn't move), so
|
|
5270
|
+
read it again a few seconds after the write.
|
|
5264
5271
|
readOnly: true
|
|
5265
5272
|
needsAuthorization:
|
|
5266
5273
|
type: boolean
|
|
@@ -7765,9 +7772,8 @@ components:
|
|
|
7765
7772
|
## REQUIRED FIELDS
|
|
7766
7773
|
|
|
7767
7774
|
The Celigo backend rejects the connection POST with HTTP 422 if these
|
|
7768
|
-
type-specific required fields are missing.
|
|
7769
|
-
|
|
7770
|
-
`integrator-models/src/models/connection.js`.
|
|
7775
|
+
type-specific required fields are missing. The rules are enforced by
|
|
7776
|
+
server-side validation when the connection is saved.
|
|
7771
7777
|
|
|
7772
7778
|
- `type` — always required; selects the database system.
|
|
7773
7779
|
- `host` — required for every type EXCEPT `bigquery` and `redshift`.
|
|
@@ -8643,7 +8649,7 @@ components:
|
|
|
8643
8649
|
properties:
|
|
8644
8650
|
function:
|
|
8645
8651
|
type: string
|
|
8646
|
-
description:
|
|
8652
|
+
description: Function in the routing script that returns the target flow.
|
|
8647
8653
|
examples:
|
|
8648
8654
|
- routeByDocType
|
|
8649
8655
|
_scriptId:
|
|
@@ -10006,7 +10012,7 @@ components:
|
|
|
10006
10012
|
properties:
|
|
10007
10013
|
function:
|
|
10008
10014
|
type: string
|
|
10009
|
-
description:
|
|
10015
|
+
description: Function in the referenced script that returns the target flow for each inbound document.
|
|
10010
10016
|
examples:
|
|
10011
10017
|
- contentBasedFlowRouter
|
|
10012
10018
|
_scriptId:
|
package/dist/asynchelper.yml
CHANGED
|
@@ -908,7 +908,7 @@ components:
|
|
|
908
908
|
**When to Use**
|
|
909
909
|
- REQUIRED when dataType = "object" (unless you are copying an entire object from the input record)
|
|
910
910
|
- REQUIRED in buildArrayHelper.mappings when defining complex object array elements
|
|
911
|
-
- NEVER used with simple types (string, number, boolean
|
|
911
|
+
- NEVER used with simple types (string, number, boolean)
|
|
912
912
|
|
|
913
913
|
**Behavior**
|
|
914
914
|
- Each mapping in this array becomes a property of the parent object
|
|
@@ -1974,7 +1974,7 @@ components:
|
|
|
1974
1974
|
**When to Use**
|
|
1975
1975
|
- REQUIRED when dataType = "object" (unless you are copying an entire object from the input record)
|
|
1976
1976
|
- REQUIRED in buildArrayHelper.mappings when defining complex object array elements
|
|
1977
|
-
- NEVER used with simple types (string, number, boolean
|
|
1977
|
+
- NEVER used with simple types (string, number, boolean)
|
|
1978
1978
|
|
|
1979
1979
|
**Behavior**
|
|
1980
1980
|
- Each mapping in this array becomes a property of the parent object
|
package/dist/connection.yml
CHANGED
|
@@ -1002,6 +1002,7 @@ paths:
|
|
|
1002
1002
|
| Path | Description |
|
|
1003
1003
|
|------|-------------|
|
|
1004
1004
|
| `/name` | Connection display name |
|
|
1005
|
+
| `/aiDescription` | AI-generated description of the connection |
|
|
1005
1006
|
| `/debugDate` | Debug logging expiry (ISO-8601, max 1 hour from now) |
|
|
1006
1007
|
| `/debugUntil` | Alias for `/debugDate` |
|
|
1007
1008
|
| `/<adaptor>/concurrencyLevel` | Concurrent requests allowed. Platform-managed while `autoRecoverRateLimitErrors` is true — the recovery machinery moves it toward the target, so set `targetConcurrencyLevel` instead |
|
|
@@ -1019,8 +1020,10 @@ paths:
|
|
|
1019
1020
|
`invalid_field_value`); out-of-range integers are clamped into the account's
|
|
1020
1021
|
licensed range rather than rejected. A whitelisted path under an adaptor
|
|
1021
1022
|
block the connection does not use is accepted but never read. The
|
|
1022
|
-
borrowed-from connection must exist in the account
|
|
1023
|
-
and a connection that others borrow
|
|
1023
|
+
borrowed-from connection must exist in the account and may not itself borrow
|
|
1024
|
+
(422 `connection_borrows_from_another`), and a connection that others borrow
|
|
1025
|
+
from cannot start borrowing (422 `connection_borrowed_by_another`). A
|
|
1026
|
+
connection naming itself is accepted, so check the id before sending it.
|
|
1024
1027
|
Settings-only changes are recorded in the connection's audit log.
|
|
1025
1028
|
operationId: patchConnection
|
|
1026
1029
|
tags:
|
|
@@ -4115,7 +4118,11 @@ components:
|
|
|
4115
4118
|
$ref: '#/components/schemas/AIDescription'
|
|
4116
4119
|
offline:
|
|
4117
4120
|
type: boolean
|
|
4118
|
-
description:
|
|
4121
|
+
description: |-
|
|
4122
|
+
When true, the connection has been taken offline and is skipped during flow execution.
|
|
4123
|
+
The platform tests the connection after a create or `PUT` and updates this shortly
|
|
4124
|
+
afterwards (the audit log records a `system` change; `lastModified` doesn't move), so
|
|
4125
|
+
read it again a few seconds after the write.
|
|
4119
4126
|
readOnly: true
|
|
4120
4127
|
needsAuthorization:
|
|
4121
4128
|
type: boolean
|
|
@@ -6620,9 +6627,8 @@ components:
|
|
|
6620
6627
|
## REQUIRED FIELDS
|
|
6621
6628
|
|
|
6622
6629
|
The Celigo backend rejects the connection POST with HTTP 422 if these
|
|
6623
|
-
type-specific required fields are missing.
|
|
6624
|
-
|
|
6625
|
-
`integrator-models/src/models/connection.js`.
|
|
6630
|
+
type-specific required fields are missing. The rules are enforced by
|
|
6631
|
+
server-side validation when the connection is saved.
|
|
6626
6632
|
|
|
6627
6633
|
- `type` — always required; selects the database system.
|
|
6628
6634
|
- `host` — required for every type EXCEPT `bigquery` and `redshift`.
|
|
@@ -7498,7 +7504,7 @@ components:
|
|
|
7498
7504
|
properties:
|
|
7499
7505
|
function:
|
|
7500
7506
|
type: string
|
|
7501
|
-
description:
|
|
7507
|
+
description: Function in the routing script that returns the target flow.
|
|
7502
7508
|
examples:
|
|
7503
7509
|
- routeByDocType
|
|
7504
7510
|
_scriptId:
|
|
@@ -8861,7 +8867,7 @@ components:
|
|
|
8861
8867
|
properties:
|
|
8862
8868
|
function:
|
|
8863
8869
|
type: string
|
|
8864
|
-
description:
|
|
8870
|
+
description: Function in the referenced script that returns the target flow for each inbound document.
|
|
8865
8871
|
examples:
|
|
8866
8872
|
- contentBasedFlowRouter
|
|
8867
8873
|
_scriptId:
|
package/dist/enduser.yml
CHANGED
|
@@ -2215,7 +2215,11 @@ components:
|
|
|
2215
2215
|
$ref: '#/components/schemas/AIDescription'
|
|
2216
2216
|
offline:
|
|
2217
2217
|
type: boolean
|
|
2218
|
-
description:
|
|
2218
|
+
description: |-
|
|
2219
|
+
When true, the connection has been taken offline and is skipped during flow execution.
|
|
2220
|
+
The platform tests the connection after a create or `PUT` and updates this shortly
|
|
2221
|
+
afterwards (the audit log records a `system` change; `lastModified` doesn't move), so
|
|
2222
|
+
read it again a few seconds after the write.
|
|
2219
2223
|
readOnly: true
|
|
2220
2224
|
needsAuthorization:
|
|
2221
2225
|
type: boolean
|
|
@@ -4720,9 +4724,8 @@ components:
|
|
|
4720
4724
|
## REQUIRED FIELDS
|
|
4721
4725
|
|
|
4722
4726
|
The Celigo backend rejects the connection POST with HTTP 422 if these
|
|
4723
|
-
type-specific required fields are missing.
|
|
4724
|
-
|
|
4725
|
-
`integrator-models/src/models/connection.js`.
|
|
4727
|
+
type-specific required fields are missing. The rules are enforced by
|
|
4728
|
+
server-side validation when the connection is saved.
|
|
4726
4729
|
|
|
4727
4730
|
- `type` — always required; selects the database system.
|
|
4728
4731
|
- `host` — required for every type EXCEPT `bigquery` and `redshift`.
|
|
@@ -5598,7 +5601,7 @@ components:
|
|
|
5598
5601
|
properties:
|
|
5599
5602
|
function:
|
|
5600
5603
|
type: string
|
|
5601
|
-
description:
|
|
5604
|
+
description: Function in the routing script that returns the target flow.
|
|
5602
5605
|
examples:
|
|
5603
5606
|
- routeByDocType
|
|
5604
5607
|
_scriptId:
|
|
@@ -6961,7 +6964,7 @@ components:
|
|
|
6961
6964
|
properties:
|
|
6962
6965
|
function:
|
|
6963
6966
|
type: string
|
|
6964
|
-
description:
|
|
6967
|
+
description: Function in the referenced script that returns the target flow for each inbound document.
|
|
6965
6968
|
examples:
|
|
6966
6969
|
- contentBasedFlowRouter
|
|
6967
6970
|
_scriptId:
|
package/dist/export.yml
CHANGED
|
@@ -6127,7 +6127,12 @@ components:
|
|
|
6127
6127
|
- The connection is a cloud file provider used in FOLDER mode (Google Drive, Box, Dropbox,
|
|
6128
6128
|
Azure Blob Storage, Google Cloud Storage, Celigo Storage): the export reads the files
|
|
6129
6129
|
in a folder and the 'file' object's `type` (csv, json, xml, xlsx, filedefinition)
|
|
6130
|
-
parses each one into records — the same file layer as an FTP or S3 export
|
|
6130
|
+
parses each one into records — the same file layer as an FTP or S3 export. In folder
|
|
6131
|
+
mode `relativeURI` is a folder path: an API endpoint path there fails the run with
|
|
6132
|
+
"Directory is not found. Please create one and provide the path." To download one
|
|
6133
|
+
file per record through the provider's API instead, leave `http.type` unset, set the
|
|
6134
|
+
export's top-level `type` to `blob` (typically on a lookup) and point `relativeURI`
|
|
6135
|
+
at the file-download endpoint
|
|
6131
6136
|
|
|
6132
6137
|
Examples of when to set type: "file":
|
|
6133
6138
|
- "Download PDF invoices from the API" → type: "file"
|
|
@@ -6262,7 +6267,10 @@ components:
|
|
|
6262
6267
|
x-celigo-agent:
|
|
6263
6268
|
- handlebars
|
|
6264
6269
|
x-celigo-handlebars-context: pre-mapped
|
|
6265
|
-
description:
|
|
6270
|
+
description: |-
|
|
6271
|
+
Resource path appended to the connection's `baseURI` to form the complete request URL. Path segments, query parameters, or the entire value can be built with handlebars expressions for endpoints determined at runtime. For lookup exports (`isLookup: true`) with mappings configured, handlebars always render against the original pre-mapped input record, so fields removed or renamed by mappings remain available for URI construction. On `NetSuiteHTTPExport` the base URL is derived from the NetSuite connection and `nsDomainType`, so the path starts at `/services/rest/...` or `/app/site/hosting/restlet.nl`.
|
|
6272
|
+
|
|
6273
|
+
Leave it empty to call the connection's `baseURI` exactly; `/` appends a trailing slash, which is a different URL. An export saved with an empty relative URI and no `http.body` comes back from reads without its `http` block, so a PUT built from such a read loses the stored settings: send the complete `http` block with every PUT.
|
|
6266
6274
|
x-celigo-ai-guidance:
|
|
6267
6275
|
- The resource path portion of the API endpoint used for this export.
|
|
6268
6276
|
- |-
|
|
@@ -11121,7 +11129,7 @@ components:
|
|
|
11121
11129
|
webstore: Triggered by SuiteCommerce web store transactions.
|
|
11122
11130
|
userevent: Triggered by user event script executions.
|
|
11123
11131
|
mapreduce: Triggered by Map/Reduce script operations.
|
|
11124
|
-
restlet: Triggered by RESTlet API calls.
|
|
11132
|
+
restlet: Triggered by RESTlet API calls, including the records a NetSuite Distributed import writes.
|
|
11125
11133
|
webapplication: Triggered by web application interactions.
|
|
11126
11134
|
restwebservices: Triggered by REST web services API calls.
|
|
11127
11135
|
disabled:
|
|
@@ -11129,7 +11137,9 @@ components:
|
|
|
11129
11137
|
description: |-
|
|
11130
11138
|
When true, the listener's NetSuite deployment is inactive and record saves no longer
|
|
11131
11139
|
trigger the export. Maintained by the platform as the flow is disabled and re-enabled;
|
|
11132
|
-
re-enabling the flow re-registers the deployment.
|
|
11140
|
+
re-enabling the flow re-registers the deployment. A listener is created disabled, and
|
|
11141
|
+
a flow created already enabled leaves it that way until a flow update sets
|
|
11142
|
+
`disabled: false`, which activates it within seconds.
|
|
11133
11143
|
x-celigo-ai-guidance:
|
|
11134
11144
|
- |-
|
|
11135
11145
|
Pause a listener by disabling its flow, not by setting this field. A listener that has
|
|
@@ -12752,7 +12762,7 @@ components:
|
|
|
12752
12762
|
**When to Use**
|
|
12753
12763
|
- REQUIRED when dataType = "object" (unless you are copying an entire object from the input record)
|
|
12754
12764
|
- REQUIRED in buildArrayHelper.mappings when defining complex object array elements
|
|
12755
|
-
- NEVER used with simple types (string, number, boolean
|
|
12765
|
+
- NEVER used with simple types (string, number, boolean)
|
|
12756
12766
|
|
|
12757
12767
|
**Behavior**
|
|
12758
12768
|
- Each mapping in this array becomes a property of the parent object
|
|
@@ -13818,7 +13828,7 @@ components:
|
|
|
13818
13828
|
**When to Use**
|
|
13819
13829
|
- REQUIRED when dataType = "object" (unless you are copying an entire object from the input record)
|
|
13820
13830
|
- REQUIRED in buildArrayHelper.mappings when defining complex object array elements
|
|
13821
|
-
- NEVER used with simple types (string, number, boolean
|
|
13831
|
+
- NEVER used with simple types (string, number, boolean)
|
|
13822
13832
|
|
|
13823
13833
|
**Behavior**
|
|
13824
13834
|
- Each mapping in this array becomes a property of the parent object
|
|
@@ -16365,14 +16375,11 @@ components:
|
|
|
16365
16375
|
|
|
16366
16376
|
**Lookup Exports (isLookup: true)**: Transforms the lookup results returned by the external system.
|
|
16367
16377
|
|
|
16368
|
-
##
|
|
16378
|
+
## LOOKUPS
|
|
16369
16379
|
|
|
16370
|
-
|
|
16371
|
-
1. Flatten nested structures (e.g., `results[0].id` -> `id`)
|
|
16372
|
-
2. Map specific fields to the top level
|
|
16373
|
-
3. Handle empty results gracefully
|
|
16380
|
+
Optional on lookups; use one to flatten nested results (e.g., `results[0].id` -> `id`). A lookup's response mapping reads the transformed records, so its extracts name the transformed fields (`data[0].id`), not the raw response paths.
|
|
16374
16381
|
|
|
16375
|
-
|
|
16382
|
+
Transformed results are not merged back into source records automatically; the flow's response mapping does that.
|
|
16376
16383
|
hooks:
|
|
16377
16384
|
type: object
|
|
16378
16385
|
description: |-
|
package/dist/import.yml
CHANGED
|
@@ -12929,7 +12929,7 @@ components:
|
|
|
12929
12929
|
**When to Use**
|
|
12930
12930
|
- REQUIRED when dataType = "object" (unless you are copying an entire object from the input record)
|
|
12931
12931
|
- REQUIRED in buildArrayHelper.mappings when defining complex object array elements
|
|
12932
|
-
- NEVER used with simple types (string, number, boolean
|
|
12932
|
+
- NEVER used with simple types (string, number, boolean)
|
|
12933
12933
|
|
|
12934
12934
|
**Behavior**
|
|
12935
12935
|
- Each mapping in this array becomes a property of the parent object
|
|
@@ -13995,7 +13995,7 @@ components:
|
|
|
13995
13995
|
**When to Use**
|
|
13996
13996
|
- REQUIRED when dataType = "object" (unless you are copying an entire object from the input record)
|
|
13997
13997
|
- REQUIRED in buildArrayHelper.mappings when defining complex object array elements
|
|
13998
|
-
- NEVER used with simple types (string, number, boolean
|
|
13998
|
+
- NEVER used with simple types (string, number, boolean)
|
|
13999
13999
|
|
|
14000
14000
|
**Behavior**
|
|
14001
14001
|
- Each mapping in this array becomes a property of the parent object
|
|
@@ -16493,8 +16493,9 @@ components:
|
|
|
16493
16493
|
- array
|
|
16494
16494
|
- string
|
|
16495
16495
|
description: |-
|
|
16496
|
-
Sample response
|
|
16497
|
-
|
|
16496
|
+
Sample destination response kept with the import for authoring its response mapping.
|
|
16497
|
+
Flow test runs and previews don't read it; they substitute `mockResponse`, or a
|
|
16498
|
+
placeholder when none is saved.
|
|
16498
16499
|
responseTransform:
|
|
16499
16500
|
x-celigo-agent:
|
|
16500
16501
|
- transform
|
|
@@ -16622,7 +16623,9 @@ components:
|
|
|
16622
16623
|
description: |-
|
|
16623
16624
|
Field mappings that transform incoming records into the destination system's field
|
|
16624
16625
|
structure — renaming fields, converting types, building nested objects, and applying
|
|
16625
|
-
formulas or lookups to derive values.
|
|
16626
|
+
formulas or lookups to derive values. The mapped output builds only the request this
|
|
16627
|
+
import sends: the next step receives the record as it arrived here, plus whatever this
|
|
16628
|
+
step's response mapping merges back.
|
|
16626
16629
|
x-celigo-ai-guidance:
|
|
16627
16630
|
- |-
|
|
16628
16631
|
## Extract evaluation root
|
package/dist/mcp-server.yml
CHANGED
|
@@ -4063,7 +4063,11 @@ components:
|
|
|
4063
4063
|
$ref: '#/components/schemas/AIDescription'
|
|
4064
4064
|
offline:
|
|
4065
4065
|
type: boolean
|
|
4066
|
-
description:
|
|
4066
|
+
description: |-
|
|
4067
|
+
When true, the connection has been taken offline and is skipped during flow execution.
|
|
4068
|
+
The platform tests the connection after a create or `PUT` and updates this shortly
|
|
4069
|
+
afterwards (the audit log records a `system` change; `lastModified` doesn't move), so
|
|
4070
|
+
read it again a few seconds after the write.
|
|
4067
4071
|
readOnly: true
|
|
4068
4072
|
needsAuthorization:
|
|
4069
4073
|
type: boolean
|
|
@@ -6568,9 +6572,8 @@ components:
|
|
|
6568
6572
|
## REQUIRED FIELDS
|
|
6569
6573
|
|
|
6570
6574
|
The Celigo backend rejects the connection POST with HTTP 422 if these
|
|
6571
|
-
type-specific required fields are missing.
|
|
6572
|
-
|
|
6573
|
-
`integrator-models/src/models/connection.js`.
|
|
6575
|
+
type-specific required fields are missing. The rules are enforced by
|
|
6576
|
+
server-side validation when the connection is saved.
|
|
6574
6577
|
|
|
6575
6578
|
- `type` — always required; selects the database system.
|
|
6576
6579
|
- `host` — required for every type EXCEPT `bigquery` and `redshift`.
|
|
@@ -7446,7 +7449,7 @@ components:
|
|
|
7446
7449
|
properties:
|
|
7447
7450
|
function:
|
|
7448
7451
|
type: string
|
|
7449
|
-
description:
|
|
7452
|
+
description: Function in the routing script that returns the target flow.
|
|
7450
7453
|
examples:
|
|
7451
7454
|
- routeByDocType
|
|
7452
7455
|
_scriptId:
|
|
@@ -8809,7 +8812,7 @@ components:
|
|
|
8809
8812
|
properties:
|
|
8810
8813
|
function:
|
|
8811
8814
|
type: string
|
|
8812
|
-
description:
|
|
8815
|
+
description: Function in the referenced script that returns the target flow for each inbound document.
|
|
8813
8816
|
examples:
|
|
8814
8817
|
- contentBasedFlowRouter
|
|
8815
8818
|
_scriptId:
|
package/dist/tool.yml
CHANGED
|
@@ -3907,7 +3907,7 @@ components:
|
|
|
3907
3907
|
**When to Use**
|
|
3908
3908
|
- REQUIRED when dataType = "object" (unless you are copying an entire object from the input record)
|
|
3909
3909
|
- REQUIRED in buildArrayHelper.mappings when defining complex object array elements
|
|
3910
|
-
- NEVER used with simple types (string, number, boolean
|
|
3910
|
+
- NEVER used with simple types (string, number, boolean)
|
|
3911
3911
|
|
|
3912
3912
|
**Behavior**
|
|
3913
3913
|
- Each mapping in this array becomes a property of the parent object
|
|
@@ -4973,7 +4973,7 @@ components:
|
|
|
4973
4973
|
**When to Use**
|
|
4974
4974
|
- REQUIRED when dataType = "object" (unless you are copying an entire object from the input record)
|
|
4975
4975
|
- REQUIRED in buildArrayHelper.mappings when defining complex object array elements
|
|
4976
|
-
- NEVER used with simple types (string, number, boolean
|
|
4976
|
+
- NEVER used with simple types (string, number, boolean)
|
|
4977
4977
|
|
|
4978
4978
|
**Behavior**
|
|
4979
4979
|
- Each mapping in this array becomes a property of the parent object
|
|
@@ -7446,7 +7446,11 @@ components:
|
|
|
7446
7446
|
$ref: '#/components/schemas/AIDescription'
|
|
7447
7447
|
offline:
|
|
7448
7448
|
type: boolean
|
|
7449
|
-
description:
|
|
7449
|
+
description: |-
|
|
7450
|
+
When true, the connection has been taken offline and is skipped during flow execution.
|
|
7451
|
+
The platform tests the connection after a create or `PUT` and updates this shortly
|
|
7452
|
+
afterwards (the audit log records a `system` change; `lastModified` doesn't move), so
|
|
7453
|
+
read it again a few seconds after the write.
|
|
7450
7454
|
readOnly: true
|
|
7451
7455
|
needsAuthorization:
|
|
7452
7456
|
type: boolean
|
|
@@ -9951,9 +9955,8 @@ components:
|
|
|
9951
9955
|
## REQUIRED FIELDS
|
|
9952
9956
|
|
|
9953
9957
|
The Celigo backend rejects the connection POST with HTTP 422 if these
|
|
9954
|
-
type-specific required fields are missing.
|
|
9955
|
-
|
|
9956
|
-
`integrator-models/src/models/connection.js`.
|
|
9958
|
+
type-specific required fields are missing. The rules are enforced by
|
|
9959
|
+
server-side validation when the connection is saved.
|
|
9957
9960
|
|
|
9958
9961
|
- `type` — always required; selects the database system.
|
|
9959
9962
|
- `host` — required for every type EXCEPT `bigquery` and `redshift`.
|
|
@@ -10829,7 +10832,7 @@ components:
|
|
|
10829
10832
|
properties:
|
|
10830
10833
|
function:
|
|
10831
10834
|
type: string
|
|
10832
|
-
description:
|
|
10835
|
+
description: Function in the routing script that returns the target flow.
|
|
10833
10836
|
examples:
|
|
10834
10837
|
- routeByDocType
|
|
10835
10838
|
_scriptId:
|
|
@@ -12192,7 +12195,7 @@ components:
|
|
|
12192
12195
|
properties:
|
|
12193
12196
|
function:
|
|
12194
12197
|
type: string
|
|
12195
|
-
description:
|
|
12198
|
+
description: Function in the referenced script that returns the target flow for each inbound document.
|
|
12196
12199
|
examples:
|
|
12197
12200
|
- contentBasedFlowRouter
|
|
12198
12201
|
_scriptId:
|
|
@@ -25366,8 +25369,9 @@ components:
|
|
|
25366
25369
|
- array
|
|
25367
25370
|
- string
|
|
25368
25371
|
description: |-
|
|
25369
|
-
Sample response
|
|
25370
|
-
|
|
25372
|
+
Sample destination response kept with the import for authoring its response mapping.
|
|
25373
|
+
Flow test runs and previews don't read it; they substitute `mockResponse`, or a
|
|
25374
|
+
placeholder when none is saved.
|
|
25371
25375
|
responseTransform:
|
|
25372
25376
|
x-celigo-agent:
|
|
25373
25377
|
- transform
|
|
@@ -25495,7 +25499,9 @@ components:
|
|
|
25495
25499
|
description: |-
|
|
25496
25500
|
Field mappings that transform incoming records into the destination system's field
|
|
25497
25501
|
structure — renaming fields, converting types, building nested objects, and applying
|
|
25498
|
-
formulas or lookups to derive values.
|
|
25502
|
+
formulas or lookups to derive values. The mapped output builds only the request this
|
|
25503
|
+
import sends: the next step receives the record as it arrived here, plus whatever this
|
|
25504
|
+
step's response mapping merges back.
|
|
25499
25505
|
x-celigo-ai-guidance:
|
|
25500
25506
|
- |-
|
|
25501
25507
|
## Extract evaluation root
|
|
@@ -30523,7 +30529,12 @@ components:
|
|
|
30523
30529
|
- The connection is a cloud file provider used in FOLDER mode (Google Drive, Box, Dropbox,
|
|
30524
30530
|
Azure Blob Storage, Google Cloud Storage, Celigo Storage): the export reads the files
|
|
30525
30531
|
in a folder and the 'file' object's `type` (csv, json, xml, xlsx, filedefinition)
|
|
30526
|
-
parses each one into records — the same file layer as an FTP or S3 export
|
|
30532
|
+
parses each one into records — the same file layer as an FTP or S3 export. In folder
|
|
30533
|
+
mode `relativeURI` is a folder path: an API endpoint path there fails the run with
|
|
30534
|
+
"Directory is not found. Please create one and provide the path." To download one
|
|
30535
|
+
file per record through the provider's API instead, leave `http.type` unset, set the
|
|
30536
|
+
export's top-level `type` to `blob` (typically on a lookup) and point `relativeURI`
|
|
30537
|
+
at the file-download endpoint
|
|
30527
30538
|
|
|
30528
30539
|
Examples of when to set type: "file":
|
|
30529
30540
|
- "Download PDF invoices from the API" → type: "file"
|
|
@@ -30658,7 +30669,10 @@ components:
|
|
|
30658
30669
|
x-celigo-agent:
|
|
30659
30670
|
- handlebars
|
|
30660
30671
|
x-celigo-handlebars-context: pre-mapped
|
|
30661
|
-
description:
|
|
30672
|
+
description: |-
|
|
30673
|
+
Resource path appended to the connection's `baseURI` to form the complete request URL. Path segments, query parameters, or the entire value can be built with handlebars expressions for endpoints determined at runtime. For lookup exports (`isLookup: true`) with mappings configured, handlebars always render against the original pre-mapped input record, so fields removed or renamed by mappings remain available for URI construction. On `NetSuiteHTTPExport` the base URL is derived from the NetSuite connection and `nsDomainType`, so the path starts at `/services/rest/...` or `/app/site/hosting/restlet.nl`.
|
|
30674
|
+
|
|
30675
|
+
Leave it empty to call the connection's `baseURI` exactly; `/` appends a trailing slash, which is a different URL. An export saved with an empty relative URI and no `http.body` comes back from reads without its `http` block, so a PUT built from such a read loses the stored settings: send the complete `http` block with every PUT.
|
|
30662
30676
|
x-celigo-ai-guidance:
|
|
30663
30677
|
- The resource path portion of the API endpoint used for this export.
|
|
30664
30678
|
- |-
|
|
@@ -35517,7 +35531,7 @@ components:
|
|
|
35517
35531
|
webstore: Triggered by SuiteCommerce web store transactions.
|
|
35518
35532
|
userevent: Triggered by user event script executions.
|
|
35519
35533
|
mapreduce: Triggered by Map/Reduce script operations.
|
|
35520
|
-
restlet: Triggered by RESTlet API calls.
|
|
35534
|
+
restlet: Triggered by RESTlet API calls, including the records a NetSuite Distributed import writes.
|
|
35521
35535
|
webapplication: Triggered by web application interactions.
|
|
35522
35536
|
restwebservices: Triggered by REST web services API calls.
|
|
35523
35537
|
disabled:
|
|
@@ -35525,7 +35539,9 @@ components:
|
|
|
35525
35539
|
description: |-
|
|
35526
35540
|
When true, the listener's NetSuite deployment is inactive and record saves no longer
|
|
35527
35541
|
trigger the export. Maintained by the platform as the flow is disabled and re-enabled;
|
|
35528
|
-
re-enabling the flow re-registers the deployment.
|
|
35542
|
+
re-enabling the flow re-registers the deployment. A listener is created disabled, and
|
|
35543
|
+
a flow created already enabled leaves it that way until a flow update sets
|
|
35544
|
+
`disabled: false`, which activates it within seconds.
|
|
35529
35545
|
x-celigo-ai-guidance:
|
|
35530
35546
|
- |-
|
|
35531
35547
|
Pause a listener by disabling its flow, not by setting this field. A listener that has
|
|
@@ -37359,14 +37375,11 @@ components:
|
|
|
37359
37375
|
|
|
37360
37376
|
**Lookup Exports (isLookup: true)**: Transforms the lookup results returned by the external system.
|
|
37361
37377
|
|
|
37362
|
-
##
|
|
37378
|
+
## LOOKUPS
|
|
37363
37379
|
|
|
37364
|
-
|
|
37365
|
-
1. Flatten nested structures (e.g., `results[0].id` -> `id`)
|
|
37366
|
-
2. Map specific fields to the top level
|
|
37367
|
-
3. Handle empty results gracefully
|
|
37380
|
+
Optional on lookups; use one to flatten nested results (e.g., `results[0].id` -> `id`). A lookup's response mapping reads the transformed records, so its extracts name the transformed fields (`data[0].id`), not the raw response paths.
|
|
37368
37381
|
|
|
37369
|
-
|
|
37382
|
+
Transformed results are not merged back into source records automatically; the flow's response mapping does that.
|
|
37370
37383
|
hooks:
|
|
37371
37384
|
type: object
|
|
37372
37385
|
description: |-
|
package/package.json
CHANGED