@celigo/api-specs 0.2.140 → 0.2.141

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 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, date)
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, date)
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
- - - get
3042
- - customerType
3041
+ - - string
3042
+ - - extract
3043
+ - customerType
3043
3044
  - premium
3044
3045
  - - and
3045
- - - exists
3046
- - - get
3047
- - orderId
3048
- - - greaterThan
3049
- - - get
3050
- - amount
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: When true, the connection has been taken offline and is skipped during flow execution.
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
@@ -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, date)
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, date)
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
@@ -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, may not itself borrow,
1023
- and a connection that others borrow from cannot start borrowing.
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: When true, the connection has been taken offline and is skipped during flow execution.
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
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: When true, the connection has been taken offline and is skipped during flow execution.
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
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: '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`.'
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, date)
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, date)
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
- ## CRITICAL REQUIREMENT FOR LOOKUPS
16378
+ ## LOOKUPS
16369
16379
 
16370
- For NetSuite and most other API-based lookups, this field is **ESSENTIAL**. Raw lookup results often come in nested or complex formats that differ from what the flow requires. You **MUST** use a transform to:
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
- Note that transformed results are not automatically merged back into source records - merging is handled separately by the 'response mapping' configuration in your flow definition.
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, date)
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, date)
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 payload used to preview response mappings and test downstream steps
16497
- without calling the destination system.
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
@@ -4063,7 +4063,11 @@ components:
4063
4063
  $ref: '#/components/schemas/AIDescription'
4064
4064
  offline:
4065
4065
  type: boolean
4066
- description: When true, the connection has been taken offline and is skipped during flow execution.
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
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, date)
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, date)
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: When true, the connection has been taken offline and is skipped during flow execution.
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
@@ -25366,8 +25370,9 @@ components:
25366
25370
  - array
25367
25371
  - string
25368
25372
  description: |-
25369
- Sample response payload used to preview response mappings and test downstream steps
25370
- without calling the destination system.
25373
+ Sample destination response kept with the import for authoring its response mapping.
25374
+ Flow test runs and previews don't read it; they substitute `mockResponse`, or a
25375
+ placeholder when none is saved.
25371
25376
  responseTransform:
25372
25377
  x-celigo-agent:
25373
25378
  - transform
@@ -25495,7 +25500,9 @@ components:
25495
25500
  description: |-
25496
25501
  Field mappings that transform incoming records into the destination system's field
25497
25502
  structure — renaming fields, converting types, building nested objects, and applying
25498
- formulas or lookups to derive values.
25503
+ formulas or lookups to derive values. The mapped output builds only the request this
25504
+ import sends: the next step receives the record as it arrived here, plus whatever this
25505
+ step's response mapping merges back.
25499
25506
  x-celigo-ai-guidance:
25500
25507
  - |-
25501
25508
  ## Extract evaluation root
@@ -30523,7 +30530,12 @@ components:
30523
30530
  - The connection is a cloud file provider used in FOLDER mode (Google Drive, Box, Dropbox,
30524
30531
  Azure Blob Storage, Google Cloud Storage, Celigo Storage): the export reads the files
30525
30532
  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
30533
+ parses each one into records — the same file layer as an FTP or S3 export. In folder
30534
+ mode `relativeURI` is a folder path: an API endpoint path there fails the run with
30535
+ "Directory is not found. Please create one and provide the path." To download one
30536
+ file per record through the provider's API instead, leave `http.type` unset, set the
30537
+ export's top-level `type` to `blob` (typically on a lookup) and point `relativeURI`
30538
+ at the file-download endpoint
30527
30539
 
30528
30540
  Examples of when to set type: "file":
30529
30541
  - "Download PDF invoices from the API" → type: "file"
@@ -30658,7 +30670,10 @@ components:
30658
30670
  x-celigo-agent:
30659
30671
  - handlebars
30660
30672
  x-celigo-handlebars-context: pre-mapped
30661
- description: '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`.'
30673
+ description: |-
30674
+ 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`.
30675
+
30676
+ 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
30677
  x-celigo-ai-guidance:
30663
30678
  - The resource path portion of the API endpoint used for this export.
30664
30679
  - |-
@@ -35517,7 +35532,7 @@ components:
35517
35532
  webstore: Triggered by SuiteCommerce web store transactions.
35518
35533
  userevent: Triggered by user event script executions.
35519
35534
  mapreduce: Triggered by Map/Reduce script operations.
35520
- restlet: Triggered by RESTlet API calls.
35535
+ restlet: Triggered by RESTlet API calls, including the records a NetSuite Distributed import writes.
35521
35536
  webapplication: Triggered by web application interactions.
35522
35537
  restwebservices: Triggered by REST web services API calls.
35523
35538
  disabled:
@@ -35525,7 +35540,9 @@ components:
35525
35540
  description: |-
35526
35541
  When true, the listener's NetSuite deployment is inactive and record saves no longer
35527
35542
  trigger the export. Maintained by the platform as the flow is disabled and re-enabled;
35528
- re-enabling the flow re-registers the deployment.
35543
+ re-enabling the flow re-registers the deployment. A listener is created disabled, and
35544
+ a flow created already enabled leaves it that way until a flow update sets
35545
+ `disabled: false`, which activates it within seconds.
35529
35546
  x-celigo-ai-guidance:
35530
35547
  - |-
35531
35548
  Pause a listener by disabling its flow, not by setting this field. A listener that has
@@ -37359,14 +37376,11 @@ components:
37359
37376
 
37360
37377
  **Lookup Exports (isLookup: true)**: Transforms the lookup results returned by the external system.
37361
37378
 
37362
- ## CRITICAL REQUIREMENT FOR LOOKUPS
37379
+ ## LOOKUPS
37363
37380
 
37364
- For NetSuite and most other API-based lookups, this field is **ESSENTIAL**. Raw lookup results often come in nested or complex formats that differ from what the flow requires. You **MUST** use a transform to:
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
37381
+ 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
37382
 
37369
- Note that transformed results are not automatically merged back into source records - merging is handled separately by the 'response mapping' configuration in your flow definition.
37383
+ Transformed results are not merged back into source records automatically; the flow's response mapping does that.
37370
37384
  hooks:
37371
37385
  type: object
37372
37386
  description: |-
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@celigo/api-specs",
3
- "version": "0.2.140",
3
+ "version": "0.2.141",
4
4
  "private": false,
5
5
  "description": "Public OpenAPI bundles (dist/) and the celigo-cli lint schema pack (schemas.json).",
6
6
  "keywords": [
package/schemas.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "provenance": {
3
3
  "repo": "celigo/integrator-api-specs",
4
- "iasCommit": "d5570467",
4
+ "iasCommit": "5ffdbb47",
5
5
  "generatedAt": "2026-10-21"
6
6
  },
7
7
  "roots": {