@celigo/api-specs 0.2.27 → 0.2.29
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/bartendertemplate.yml +508 -0
- package/dist/connection.yml +103 -1
- package/dist/export.yml +114 -26
- package/dist/import.yml +59 -5
- package/dist/tool.yml +139 -14
- package/package.json +1 -1
- package/schemas.json +566 -551
package/dist/tool.yml
CHANGED
|
@@ -9948,7 +9948,11 @@ components:
|
|
|
9948
9948
|
suiteAppInstalled:
|
|
9949
9949
|
type: boolean
|
|
9950
9950
|
readOnly: true
|
|
9951
|
-
description:
|
|
9951
|
+
description: |-
|
|
9952
|
+
When true, the Celigo integrator.io SuiteApp (SuiteScript 2.x) was detected in
|
|
9953
|
+
the connected NetSuite account the last time the connection authenticated. It
|
|
9954
|
+
says nothing about the legacy Celigo bundle; for a live check of both, use
|
|
9955
|
+
`GET /v1/connections/{_id}/distributedApps`.
|
|
9952
9956
|
salesforce:
|
|
9953
9957
|
description: Present when `type` is `salesforce`.
|
|
9954
9958
|
allOf:
|
|
@@ -10687,7 +10691,9 @@ components:
|
|
|
10687
10691
|
type: object
|
|
10688
10692
|
description: |-
|
|
10689
10693
|
Configuration for HTTP imports.
|
|
10690
|
-
Required whenever the connection referenced by _connectionId has type http
|
|
10694
|
+
Required whenever the connection referenced by _connectionId has type http, and on
|
|
10695
|
+
`NetSuiteHTTPImport` (NetSuite's REST APIs on a `netsuite` connection, where `nsDomainType`
|
|
10696
|
+
supplies the host).
|
|
10691
10697
|
x-celigo-ai-guidance:
|
|
10692
10698
|
- |-
|
|
10693
10699
|
IMPORTANT:
|
|
@@ -10695,6 +10701,11 @@ components:
|
|
|
10695
10701
|
this object MUST be populated for the import to function properly.
|
|
10696
10702
|
This is a required configuration for all HTTP based imports,
|
|
10697
10703
|
as determined by the connection associated with the import.
|
|
10704
|
+
- |-
|
|
10705
|
+
A `NetSuiteHTTPImport` uses this same object on a netsuite connection: each `relativeURI`
|
|
10706
|
+
entry carries the full path from `/services/rest/record/v1/<type>` (SuiteTalk) or
|
|
10707
|
+
`/app/site/hosting/restlet.nl?script=<id>&deploy=<n>` (custom RESTlet); the host and the
|
|
10708
|
+
token signature come from the connection.
|
|
10698
10709
|
properties:
|
|
10699
10710
|
sendPostMappedData:
|
|
10700
10711
|
type: boolean
|
|
@@ -20776,6 +20787,7 @@ components:
|
|
|
20776
20787
|
description: |-
|
|
20777
20788
|
Connection this import uses to reach the destination system. The connection's type must
|
|
20778
20789
|
be compatible with the import's `adaptorType` (e.g. an `HTTPImport` needs an `http`
|
|
20790
|
+
connection; `NetSuiteDistributedImport` and `NetSuiteHTTPImport` both need a `netsuite`
|
|
20779
20791
|
connection). Server-required — POST without it fails with 422 "Expected field:
|
|
20780
20792
|
_connectionId to be present" — except for the connection-less flavors (`ToolImport`,
|
|
20781
20793
|
`AiAgentImport`, `GuardrailImport`), which the server creates without one.
|
|
@@ -20808,9 +20820,15 @@ components:
|
|
|
20808
20820
|
Use HTTPImport for all REST/SOAP APIs unless a specialized adaptor exists for the
|
|
20809
20821
|
target system; always pair the adaptorType with its matching configuration object.
|
|
20810
20822
|
- |-
|
|
20811
|
-
For NetSuite,
|
|
20812
|
-
|
|
20813
|
-
|
|
20823
|
+
For NetSuite, use NetSuiteDistributedImport (with the netsuite_da object) when the
|
|
20824
|
+
Celigo SuiteApp or bundle is installed in the account — check with
|
|
20825
|
+
`GET /v1/connections/{_id}/distributedApps` (`suiteapp.success` / `bundle.success`).
|
|
20826
|
+
Use NetSuiteHTTPImport (with `nsDomainType` and the http object) when neither is
|
|
20827
|
+
installed or the user asks for NetSuite's REST APIs; the platform's SuiteTalk connector
|
|
20828
|
+
catalogs `POST /services/rest/record/v1/<type>` for inserts and
|
|
20829
|
+
`PATCH /services/rest/record/v1/<type>/{id}` for updates, and saving links the step to
|
|
20830
|
+
them. NetSuiteImport is a legacy adaptor for accounts without the Celigo SuiteApp 2.0 —
|
|
20831
|
+
do not use it unless explicitly requested.
|
|
20814
20832
|
- |-
|
|
20815
20833
|
Use RDBMSImport (with the rdbms object) for built-in database types such as SQL Server,
|
|
20816
20834
|
MySQL, PostgreSQL, Snowflake, Oracle, and MariaDB. Use JDBCImport (with the jdbc
|
|
@@ -20822,6 +20840,7 @@ components:
|
|
|
20822
20840
|
- S3Import
|
|
20823
20841
|
- NetSuiteImport
|
|
20824
20842
|
- NetSuiteDistributedImport
|
|
20843
|
+
- NetSuiteHTTPImport
|
|
20825
20844
|
- SalesforceImport
|
|
20826
20845
|
- JDBCImport
|
|
20827
20846
|
- RDBMSImport
|
|
@@ -20839,7 +20858,8 @@ components:
|
|
|
20839
20858
|
AS2Import: File import via AS2 (Applicability Statement 2) protocol.
|
|
20840
20859
|
S3Import: File import to Amazon S3 storage.
|
|
20841
20860
|
NetSuiteImport: Legacy NetSuite import for accounts without the Celigo SuiteApp 2.0.
|
|
20842
|
-
NetSuiteDistributedImport: NetSuite import using the distributed SuiteApp 2.0 adaptor (default for NetSuite).
|
|
20861
|
+
NetSuiteDistributedImport: NetSuite import using the distributed SuiteApp 2.0 adaptor (default for NetSuite when the SuiteApp or bundle is installed).
|
|
20862
|
+
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.
|
|
20843
20863
|
SalesforceImport: Salesforce-specific import using SOAP, REST, Metadata, or Composite APIs.
|
|
20844
20864
|
JDBCImport: Database import via a generic JDBC connection (not for built-in RDBMS types).
|
|
20845
20865
|
RDBMSImport: Database import for built-in RDBMS types such as SQL Server, MySQL, PostgreSQL, Snowflake, and Oracle.
|
|
@@ -20854,10 +20874,38 @@ components:
|
|
|
20854
20874
|
examples:
|
|
20855
20875
|
- HTTPImport
|
|
20856
20876
|
- NetSuiteDistributedImport
|
|
20877
|
+
- NetSuiteHTTPImport
|
|
20857
20878
|
- SalesforceImport
|
|
20858
20879
|
- FTPImport
|
|
20859
20880
|
- AiAgentImport
|
|
20860
20881
|
- GuardrailImport
|
|
20882
|
+
nsDomainType:
|
|
20883
|
+
type: string
|
|
20884
|
+
enum:
|
|
20885
|
+
- suitetalk
|
|
20886
|
+
- restlet
|
|
20887
|
+
x-lowercase: true
|
|
20888
|
+
x-enumDescriptions:
|
|
20889
|
+
suitetalk: NetSuite SuiteTalk REST web services — record endpoints under /services/rest/record/v1
|
|
20890
|
+
restlet: A custom RESTlet script deployed in the NetSuite account, called at /app/site/hosting/restlet.nl?script=<id>&deploy=<n>
|
|
20891
|
+
description: |-
|
|
20892
|
+
Selects which NetSuite REST host a `NetSuiteHTTPImport` calls. The server derives the
|
|
20893
|
+
full base URL from the connection's NetSuite account
|
|
20894
|
+
(`https://<account>.suitetalk.api.netsuite.com` or `https://<account>.restlets.api.netsuite.com`)
|
|
20895
|
+
and signs each request with the connection's token-based credentials, so each
|
|
20896
|
+
`http.relativeURI` entry carries the complete path starting at `/services/rest/...` or
|
|
20897
|
+
`/app/site/hosting/restlet.nl`. Ignored on other adaptor types.
|
|
20898
|
+
x-celigo-ai-guidance:
|
|
20899
|
+
- |-
|
|
20900
|
+
Required on `NetSuiteHTTPImport`: omitting it fails the save with 422 "Path `nsDomainType`
|
|
20901
|
+
is required." The import's `_connectionId` must be a netsuite connection — an http
|
|
20902
|
+
connection fails with 422 invalid_connection_type.
|
|
20903
|
+
- |-
|
|
20904
|
+
With `suitetalk`, saving links `http._httpConnectorVersionId`, `_httpConnectorResourceId`
|
|
20905
|
+
and `_httpConnectorEndpointIds` to the platform's SuiteTalk connector from each
|
|
20906
|
+
`http.method` + `http.relativeURI` pair (for example `POST /services/rest/record/v1/customer`
|
|
20907
|
+
links to that record type's insert endpoint), so the UI's Simple view renders an
|
|
20908
|
+
API-authored step; `restlet` steps are not linked.
|
|
20861
20909
|
externalId:
|
|
20862
20910
|
type:
|
|
20863
20911
|
- string
|
|
@@ -26309,7 +26357,10 @@ components:
|
|
|
26309
26357
|
- \\NAS\Accounting\AP
|
|
26310
26358
|
Http-2:
|
|
26311
26359
|
type: object
|
|
26312
|
-
description:
|
|
26360
|
+
description: |-
|
|
26361
|
+
Configuration for HTTP exports. Required when the export's `_connectionId` references a
|
|
26362
|
+
connection of type `http`, and on `NetSuiteHTTPExport` (NetSuite's REST APIs on a `netsuite`
|
|
26363
|
+
connection, where `nsDomainType` supplies the host).
|
|
26313
26364
|
x-celigo-ai-guidance:
|
|
26314
26365
|
- |-
|
|
26315
26366
|
IMPORTANT:
|
|
@@ -26317,6 +26368,12 @@ components:
|
|
|
26317
26368
|
this object MUST be populated for the export to function properly.
|
|
26318
26369
|
This is a required configuration for all HTTP based exports,
|
|
26319
26370
|
as determined by the connection associated with the export.
|
|
26371
|
+
- |-
|
|
26372
|
+
A `NetSuiteHTTPExport` uses this same object on a netsuite connection: `relativeURI`
|
|
26373
|
+
carries the full path from `/services/rest/...` (SuiteTalk) or
|
|
26374
|
+
`/app/site/hosting/restlet.nl?script=<id>&deploy=<n>` (custom RESTlet), the host and the
|
|
26375
|
+
token signature come from the connection, and `type` must stay unset (file, blob and
|
|
26376
|
+
csvstream are rejected with 422 unsupported_type).
|
|
26320
26377
|
properties:
|
|
26321
26378
|
type:
|
|
26322
26379
|
type: string
|
|
@@ -26466,7 +26523,7 @@ components:
|
|
|
26466
26523
|
x-celigo-agent:
|
|
26467
26524
|
- handlebars
|
|
26468
26525
|
x-celigo-handlebars-context: pre-mapped
|
|
26469
|
-
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.'
|
|
26526
|
+
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`.'
|
|
26470
26527
|
x-celigo-ai-guidance:
|
|
26471
26528
|
- The resource path portion of the API endpoint used for this export.
|
|
26472
26529
|
- |-
|
|
@@ -33216,7 +33273,8 @@ components:
|
|
|
33216
33273
|
- 'null'
|
|
33217
33274
|
description: |-
|
|
33218
33275
|
Connection this export uses to reach the source system. The connection's type must be
|
|
33219
|
-
compatible with the export's `adaptorType` (e.g. an `HTTPExport` needs an `http` connection
|
|
33276
|
+
compatible with the export's `adaptorType` (e.g. an `HTTPExport` needs an `http` connection;
|
|
33277
|
+
`NetSuiteExport` and `NetSuiteHTTPExport` both need a `netsuite` connection).
|
|
33220
33278
|
Server-required unless `type` is `webhook` or `simple` (those receive data instead of fetching it).
|
|
33221
33279
|
examples:
|
|
33222
33280
|
- 60a2c4e6f321d800129a1a3c
|
|
@@ -33232,6 +33290,7 @@ components:
|
|
|
33232
33290
|
- AS2Export
|
|
33233
33291
|
- S3Export
|
|
33234
33292
|
- NetSuiteExport
|
|
33293
|
+
- NetSuiteHTTPExport
|
|
33235
33294
|
- SalesforceExport
|
|
33236
33295
|
- JDBCExport
|
|
33237
33296
|
- RDBMSExport
|
|
@@ -33247,7 +33306,8 @@ components:
|
|
|
33247
33306
|
FTPExport: Exports files from FTP or SFTP servers.
|
|
33248
33307
|
AS2Export: Exports data using the AS2 (Applicability Statement 2) secure file transfer protocol.
|
|
33249
33308
|
S3Export: Exports files from Amazon S3 cloud storage buckets.
|
|
33250
|
-
NetSuiteExport: Exports data from Oracle NetSuite
|
|
33309
|
+
NetSuiteExport: Exports data from Oracle NetSuite through the Celigo SuiteApp/bundle RESTlets (saved searches or search criteria), SOAP web services, real-time listeners, or the file cabinet.
|
|
33310
|
+
NetSuiteHTTPExport: Exports records from Oracle NetSuite over its REST APIs — SuiteTalk REST record endpoints and SuiteQL, or a custom RESTlet — on a netsuite connection, with no saved search and no Celigo SuiteApp involved.
|
|
33251
33311
|
SalesforceExport: Exports data from Salesforce using SOQL queries or real-time events.
|
|
33252
33312
|
JDBCExport: Exports data from databases using JDBC connections.
|
|
33253
33313
|
RDBMSExport: Exports data from relational databases using SQL queries.
|
|
@@ -33261,7 +33321,71 @@ components:
|
|
|
33261
33321
|
examples:
|
|
33262
33322
|
- HTTPExport
|
|
33263
33323
|
- NetSuiteExport
|
|
33324
|
+
- NetSuiteHTTPExport
|
|
33264
33325
|
- SalesforceExport
|
|
33326
|
+
x-celigo-ai-guidance:
|
|
33327
|
+
- |-
|
|
33328
|
+
On a netsuite connection, default to `NetSuiteHTTPExport` (with `nsDomainType` and an
|
|
33329
|
+
`http` object) for exports and lookups: it reads records over NetSuite's REST APIs with
|
|
33330
|
+
nothing to create in NetSuite first — SuiteQL for filtered or multi-table extracts, the
|
|
33331
|
+
record endpoint `GET /services/rest/record/v1/<type>/{id}` for one record. Choose
|
|
33332
|
+
`NetSuiteExport` when the user names an existing saved search or asks for one, for
|
|
33333
|
+
real-time listeners (`type: distributed`), and for file-cabinet exports; never convert an
|
|
33334
|
+
existing `NetSuiteExport` to `NetSuiteHTTPExport` unless asked.
|
|
33335
|
+
- |-
|
|
33336
|
+
When authoring a NetSuite REST export, send `adaptorType: "NetSuiteHTTPExport"` explicitly:
|
|
33337
|
+
on a netsuite connection the server otherwise infers `NetSuiteExport` and rejects the
|
|
33338
|
+
document with 422 "netsuite subschema not defined", even though `nsDomainType` and `http`
|
|
33339
|
+
are present.
|
|
33340
|
+
nsDomainType:
|
|
33341
|
+
type: string
|
|
33342
|
+
enum:
|
|
33343
|
+
- suitetalk
|
|
33344
|
+
- restlet
|
|
33345
|
+
x-lowercase: true
|
|
33346
|
+
x-enumDescriptions:
|
|
33347
|
+
suitetalk: NetSuite SuiteTalk REST web services — record endpoints under /services/rest/record/v1 and SuiteQL under /services/rest/query/v1
|
|
33348
|
+
restlet: A custom RESTlet script deployed in the NetSuite account, called at /app/site/hosting/restlet.nl?script=<id>&deploy=<n>
|
|
33349
|
+
description: |-
|
|
33350
|
+
Selects which NetSuite REST host a `NetSuiteHTTPExport` calls. The server derives the
|
|
33351
|
+
full base URL from the connection's NetSuite account
|
|
33352
|
+
(`https://<account>.suitetalk.api.netsuite.com` or `https://<account>.restlets.api.netsuite.com`)
|
|
33353
|
+
and signs each request with the connection's token-based credentials, so `http.relativeURI`
|
|
33354
|
+
carries the complete path starting at `/services/rest/...` or `/app/site/hosting/restlet.nl`.
|
|
33355
|
+
Ignored on other adaptor types.
|
|
33356
|
+
x-celigo-ai-guidance:
|
|
33357
|
+
- |-
|
|
33358
|
+
Required on `NetSuiteHTTPExport`: omitting it fails the save with 422 "Path `nsDomainType`
|
|
33359
|
+
is required." and any other value fails with 422 "is not a valid enum value for path
|
|
33360
|
+
`nsDomainType`". The export's `_connectionId` must be a netsuite connection — an http
|
|
33361
|
+
connection fails with 422 invalid_connection_type.
|
|
33362
|
+
- |-
|
|
33363
|
+
With `suitetalk`, saving links `http._httpConnectorVersionId`, `_httpConnectorResourceId`
|
|
33364
|
+
and `_httpConnectorEndpointId` to the platform's SuiteTalk connector from `http.method` +
|
|
33365
|
+
`http.relativeURI`, so the UI's Simple view renders an API-authored step; `restlet` steps
|
|
33366
|
+
are not linked.
|
|
33367
|
+
- |-
|
|
33368
|
+
The record list endpoint (`GET /services/rest/record/v1/<type>?limit=<n>&offset={{{export.http.paging.skip}}}`)
|
|
33369
|
+
returns only `{id, links}` per item, so it yields no business fields on its own. For
|
|
33370
|
+
records with fields use SuiteQL: `POST /services/rest/query/v1/suiteql?limit=<n>&offset={{{export.http.paging.skip}}}`,
|
|
33371
|
+
header `Prefer: transient`, `http.body` `{"q": "<SuiteQL>"}`, `http.paging.method: skip`,
|
|
33372
|
+
`http.response.resourcePath: items`; the response envelope carries `hasMore` and
|
|
33373
|
+
`totalResults`. SuiteQL column names are the Records Catalog names (lowercase, e.g.
|
|
33374
|
+
`entityid`, `lastmodifieddate`), not the REST record field names.
|
|
33375
|
+
- |-
|
|
33376
|
+
For incremental runs set `type: delta`, embed `{{lastExportDateTime}}` in the SuiteQL
|
|
33377
|
+
`WHERE` clause (or the record endpoint's `q` parameter) and set `delta.dateFormat` to the
|
|
33378
|
+
format the query compares against, e.g. `to_char(lastmodifieddate,'YYYY-MM-DD HH24:MI:SS') >= '{{lastExportDateTime}}'`
|
|
33379
|
+
with `delta.dateFormat: "YYYY-MM-DD HH:mm:ss"`. In a preview the placeholder renders
|
|
33380
|
+
empty, so preview results do not reflect the delta window.
|
|
33381
|
+
- |-
|
|
33382
|
+
NetSuite must have the REST Web Services feature enabled (Setup > Company > Enable
|
|
33383
|
+
Features > SuiteCloud); otherwise every SuiteTalk call fails with NetSuite 403
|
|
33384
|
+
FEATURE_DISABLED "The 'REST Web Services' feature is not enabled". Custom RESTlets do
|
|
33385
|
+
not need it.
|
|
33386
|
+
- |-
|
|
33387
|
+
`http.type` file, blob, and csvstream are each rejected with 422 unsupported_type
|
|
33388
|
+
("NetSuiteHTTPExport does not support type: <value>") — REST steps are record-based only.
|
|
33265
33389
|
type:
|
|
33266
33390
|
type:
|
|
33267
33391
|
- string
|
|
@@ -33533,8 +33657,8 @@ components:
|
|
|
33533
33657
|
description: |-
|
|
33534
33658
|
Field mappings applied to each incoming record before a lookup HTTP request is made,
|
|
33535
33659
|
reshaping the upstream record into the structure the lookup target API expects. Only
|
|
33536
|
-
supported when `isLookup` is true and `adaptorType` is `HTTPExport
|
|
33537
|
-
source exports or
|
|
33660
|
+
supported when `isLookup` is true and `adaptorType` is `HTTPExport` or
|
|
33661
|
+
`NetSuiteHTTPExport`; do not set it on source exports or other lookup adaptors.
|
|
33538
33662
|
allOf:
|
|
33539
33663
|
- $ref: '#/components/schemas/Mappings'
|
|
33540
33664
|
x-celigo-ai-guidance:
|
|
@@ -33547,8 +33671,9 @@ components:
|
|
|
33547
33671
|
1. ``isLookup`` is ``true`` (the export is being used as a
|
|
33548
33672
|
lookup step, not a source export), AND
|
|
33549
33673
|
2. ``adaptorType`` is ``"HTTPExport"`` (generic REST/SOAP
|
|
33550
|
-
HTTP lookup
|
|
33551
|
-
|
|
33674
|
+
HTTP lookup) or ``"NetSuiteHTTPExport"`` (NetSuite REST
|
|
33675
|
+
APIs) — not the saved-search NetSuite adaptor, Salesforce,
|
|
33676
|
+
RDBMS, file-based, or any other adaptor.
|
|
33552
33677
|
|
|
33553
33678
|
For any other combination (source exports, non-HTTP lookup
|
|
33554
33679
|
exports), do **not** emit this field. Explain the constraint
|