@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/export.yml CHANGED
@@ -5906,7 +5906,10 @@ components:
5906
5906
  - \\NAS\Accounting\AP
5907
5907
  Http:
5908
5908
  type: object
5909
- description: Configuration for HTTP exports. Required when the export's `_connectionId` references a connection of type `http`.
5909
+ description: |-
5910
+ Configuration for HTTP exports. Required when the export's `_connectionId` references a
5911
+ connection of type `http`, and on `NetSuiteHTTPExport` (NetSuite's REST APIs on a `netsuite`
5912
+ connection, where `nsDomainType` supplies the host).
5910
5913
  x-celigo-ai-guidance:
5911
5914
  - |-
5912
5915
  IMPORTANT:
@@ -5914,6 +5917,12 @@ components:
5914
5917
  this object MUST be populated for the export to function properly.
5915
5918
  This is a required configuration for all HTTP based exports,
5916
5919
  as determined by the connection associated with the export.
5920
+ - |-
5921
+ A `NetSuiteHTTPExport` uses this same object on a netsuite connection: `relativeURI`
5922
+ carries the full path from `/services/rest/...` (SuiteTalk) or
5923
+ `/app/site/hosting/restlet.nl?script=<id>&deploy=<n>` (custom RESTlet), the host and the
5924
+ token signature come from the connection, and `type` must stay unset (file, blob and
5925
+ csvstream are rejected with 422 unsupported_type).
5917
5926
  properties:
5918
5927
  type:
5919
5928
  type: string
@@ -6063,7 +6072,7 @@ components:
6063
6072
  x-celigo-agent:
6064
6073
  - handlebars
6065
6074
  x-celigo-handlebars-context: pre-mapped
6066
- 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.'
6075
+ 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`.'
6067
6076
  x-celigo-ai-guidance:
6068
6077
  - The resource path portion of the API endpoint used for this export.
6069
6078
  - |-
@@ -15787,7 +15796,8 @@ components:
15787
15796
  - 'null'
15788
15797
  description: |-
15789
15798
  Connection this export uses to reach the source system. The connection's type must be
15790
- compatible with the export's `adaptorType` (e.g. an `HTTPExport` needs an `http` connection).
15799
+ compatible with the export's `adaptorType` (e.g. an `HTTPExport` needs an `http` connection;
15800
+ `NetSuiteExport` and `NetSuiteHTTPExport` both need a `netsuite` connection).
15791
15801
  Server-required unless `type` is `webhook` or `simple` (those receive data instead of fetching it).
15792
15802
  examples:
15793
15803
  - 60a2c4e6f321d800129a1a3c
@@ -15803,6 +15813,7 @@ components:
15803
15813
  - AS2Export
15804
15814
  - S3Export
15805
15815
  - NetSuiteExport
15816
+ - NetSuiteHTTPExport
15806
15817
  - SalesforceExport
15807
15818
  - JDBCExport
15808
15819
  - RDBMSExport
@@ -15818,7 +15829,8 @@ components:
15818
15829
  FTPExport: Exports files from FTP or SFTP servers.
15819
15830
  AS2Export: Exports data using the AS2 (Applicability Statement 2) secure file transfer protocol.
15820
15831
  S3Export: Exports files from Amazon S3 cloud storage buckets.
15821
- NetSuiteExport: Exports data from Oracle NetSuite using saved searches, RESTlets, or SuiteApp.
15832
+ 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.
15833
+ 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.
15822
15834
  SalesforceExport: Exports data from Salesforce using SOQL queries or real-time events.
15823
15835
  JDBCExport: Exports data from databases using JDBC connections.
15824
15836
  RDBMSExport: Exports data from relational databases using SQL queries.
@@ -15832,7 +15844,71 @@ components:
15832
15844
  examples:
15833
15845
  - HTTPExport
15834
15846
  - NetSuiteExport
15847
+ - NetSuiteHTTPExport
15835
15848
  - SalesforceExport
15849
+ x-celigo-ai-guidance:
15850
+ - |-
15851
+ On a netsuite connection, default to `NetSuiteHTTPExport` (with `nsDomainType` and an
15852
+ `http` object) for exports and lookups: it reads records over NetSuite's REST APIs with
15853
+ nothing to create in NetSuite first — SuiteQL for filtered or multi-table extracts, the
15854
+ record endpoint `GET /services/rest/record/v1/<type>/{id}` for one record. Choose
15855
+ `NetSuiteExport` when the user names an existing saved search or asks for one, for
15856
+ real-time listeners (`type: distributed`), and for file-cabinet exports; never convert an
15857
+ existing `NetSuiteExport` to `NetSuiteHTTPExport` unless asked.
15858
+ - |-
15859
+ When authoring a NetSuite REST export, send `adaptorType: "NetSuiteHTTPExport"` explicitly:
15860
+ on a netsuite connection the server otherwise infers `NetSuiteExport` and rejects the
15861
+ document with 422 "netsuite subschema not defined", even though `nsDomainType` and `http`
15862
+ are present.
15863
+ nsDomainType:
15864
+ type: string
15865
+ enum:
15866
+ - suitetalk
15867
+ - restlet
15868
+ x-lowercase: true
15869
+ x-enumDescriptions:
15870
+ suitetalk: NetSuite SuiteTalk REST web services — record endpoints under /services/rest/record/v1 and SuiteQL under /services/rest/query/v1
15871
+ restlet: A custom RESTlet script deployed in the NetSuite account, called at /app/site/hosting/restlet.nl?script=<id>&deploy=<n>
15872
+ description: |-
15873
+ Selects which NetSuite REST host a `NetSuiteHTTPExport` calls. The server derives the
15874
+ full base URL from the connection's NetSuite account
15875
+ (`https://<account>.suitetalk.api.netsuite.com` or `https://<account>.restlets.api.netsuite.com`)
15876
+ and signs each request with the connection's token-based credentials, so `http.relativeURI`
15877
+ carries the complete path starting at `/services/rest/...` or `/app/site/hosting/restlet.nl`.
15878
+ Ignored on other adaptor types.
15879
+ x-celigo-ai-guidance:
15880
+ - |-
15881
+ Required on `NetSuiteHTTPExport`: omitting it fails the save with 422 "Path `nsDomainType`
15882
+ is required." and any other value fails with 422 "is not a valid enum value for path
15883
+ `nsDomainType`". The export's `_connectionId` must be a netsuite connection — an http
15884
+ connection fails with 422 invalid_connection_type.
15885
+ - |-
15886
+ With `suitetalk`, saving links `http._httpConnectorVersionId`, `_httpConnectorResourceId`
15887
+ and `_httpConnectorEndpointId` to the platform's SuiteTalk connector from `http.method` +
15888
+ `http.relativeURI`, so the UI's Simple view renders an API-authored step; `restlet` steps
15889
+ are not linked.
15890
+ - |-
15891
+ The record list endpoint (`GET /services/rest/record/v1/<type>?limit=<n>&offset={{{export.http.paging.skip}}}`)
15892
+ returns only `{id, links}` per item, so it yields no business fields on its own. For
15893
+ records with fields use SuiteQL: `POST /services/rest/query/v1/suiteql?limit=<n>&offset={{{export.http.paging.skip}}}`,
15894
+ header `Prefer: transient`, `http.body` `{"q": "<SuiteQL>"}`, `http.paging.method: skip`,
15895
+ `http.response.resourcePath: items`; the response envelope carries `hasMore` and
15896
+ `totalResults`. SuiteQL column names are the Records Catalog names (lowercase, e.g.
15897
+ `entityid`, `lastmodifieddate`), not the REST record field names.
15898
+ - |-
15899
+ For incremental runs set `type: delta`, embed `{{lastExportDateTime}}` in the SuiteQL
15900
+ `WHERE` clause (or the record endpoint's `q` parameter) and set `delta.dateFormat` to the
15901
+ format the query compares against, e.g. `to_char(lastmodifieddate,'YYYY-MM-DD HH24:MI:SS') >= '{{lastExportDateTime}}'`
15902
+ with `delta.dateFormat: "YYYY-MM-DD HH:mm:ss"`. In a preview the placeholder renders
15903
+ empty, so preview results do not reflect the delta window.
15904
+ - |-
15905
+ NetSuite must have the REST Web Services feature enabled (Setup > Company > Enable
15906
+ Features > SuiteCloud); otherwise every SuiteTalk call fails with NetSuite 403
15907
+ FEATURE_DISABLED "The 'REST Web Services' feature is not enabled". Custom RESTlets do
15908
+ not need it.
15909
+ - |-
15910
+ `http.type` file, blob, and csvstream are each rejected with 422 unsupported_type
15911
+ ("NetSuiteHTTPExport does not support type: <value>") — REST steps are record-based only.
15836
15912
  type:
15837
15913
  type:
15838
15914
  - string
@@ -16104,8 +16180,8 @@ components:
16104
16180
  description: |-
16105
16181
  Field mappings applied to each incoming record before a lookup HTTP request is made,
16106
16182
  reshaping the upstream record into the structure the lookup target API expects. Only
16107
- supported when `isLookup` is true and `adaptorType` is `HTTPExport`; do not set it on
16108
- source exports or non-HTTP lookups.
16183
+ supported when `isLookup` is true and `adaptorType` is `HTTPExport` or
16184
+ `NetSuiteHTTPExport`; do not set it on source exports or other lookup adaptors.
16109
16185
  allOf:
16110
16186
  - $ref: '#/components/schemas/Mappings'
16111
16187
  x-celigo-ai-guidance:
@@ -16118,8 +16194,9 @@ components:
16118
16194
  1. ``isLookup`` is ``true`` (the export is being used as a
16119
16195
  lookup step, not a source export), AND
16120
16196
  2. ``adaptorType`` is ``"HTTPExport"`` (generic REST/SOAP
16121
- HTTP lookup — not NetSuite, Salesforce, RDBMS, file-based,
16122
- or any other adaptor).
16197
+ HTTP lookup) or ``"NetSuiteHTTPExport"`` (NetSuite REST
16198
+ APIs) — not the saved-search NetSuite adaptor, Salesforce,
16199
+ RDBMS, file-based, or any other adaptor.
16123
16200
 
16124
16201
  For any other combination (source exports, non-HTTP lookup
16125
16202
  exports), do **not** emit this field. Explain the constraint
@@ -16643,92 +16720,103 @@ components:
16643
16720
  if:
16644
16721
  properties:
16645
16722
  adaptorType:
16646
- const: SalesforceExport
16723
+ const: NetSuiteHTTPExport
16647
16724
  required:
16648
16725
  - adaptorType
16649
16726
  then:
16650
16727
  required:
16651
- - salesforce
16728
+ - http
16729
+ - nsDomainType
16652
16730
  else:
16653
16731
  if:
16654
16732
  properties:
16655
16733
  adaptorType:
16656
- const: JDBCExport
16734
+ const: SalesforceExport
16657
16735
  required:
16658
16736
  - adaptorType
16659
16737
  then:
16660
16738
  required:
16661
- - jdbc
16739
+ - salesforce
16662
16740
  else:
16663
16741
  if:
16664
16742
  properties:
16665
16743
  adaptorType:
16666
- const: RDBMSExport
16744
+ const: JDBCExport
16667
16745
  required:
16668
16746
  - adaptorType
16669
16747
  then:
16670
16748
  required:
16671
- - rdbms
16749
+ - jdbc
16672
16750
  else:
16673
16751
  if:
16674
16752
  properties:
16675
16753
  adaptorType:
16676
- const: MongodbExport
16754
+ const: RDBMSExport
16677
16755
  required:
16678
16756
  - adaptorType
16679
16757
  then:
16680
16758
  required:
16681
- - mongodb
16759
+ - rdbms
16682
16760
  else:
16683
16761
  if:
16684
16762
  properties:
16685
16763
  adaptorType:
16686
- const: DynamodbExport
16764
+ const: MongodbExport
16687
16765
  required:
16688
16766
  - adaptorType
16689
16767
  then:
16690
16768
  required:
16691
- - dynamodb
16769
+ - mongodb
16692
16770
  else:
16693
16771
  if:
16694
16772
  properties:
16695
16773
  adaptorType:
16696
- const: WrapperExport
16774
+ const: DynamodbExport
16697
16775
  required:
16698
16776
  - adaptorType
16699
16777
  then:
16700
16778
  required:
16701
- - wrapper
16779
+ - dynamodb
16702
16780
  else:
16703
16781
  if:
16704
16782
  properties:
16705
16783
  adaptorType:
16706
- const: WebhookExport
16784
+ const: WrapperExport
16707
16785
  required:
16708
16786
  - adaptorType
16709
16787
  then:
16710
16788
  required:
16711
- - webhook
16789
+ - wrapper
16712
16790
  else:
16713
16791
  if:
16714
16792
  properties:
16715
16793
  adaptorType:
16716
- const: FileSystemExport
16794
+ const: WebhookExport
16717
16795
  required:
16718
16796
  - adaptorType
16719
16797
  then:
16720
16798
  required:
16721
- - filesystem
16799
+ - webhook
16722
16800
  else:
16723
16801
  if:
16724
16802
  properties:
16725
16803
  adaptorType:
16726
- const: RESTExport
16804
+ const: FileSystemExport
16727
16805
  required:
16728
16806
  - adaptorType
16729
16807
  then:
16730
16808
  required:
16731
- - http
16809
+ - filesystem
16810
+ else:
16811
+ if:
16812
+ properties:
16813
+ adaptorType:
16814
+ const: RESTExport
16815
+ required:
16816
+ - adaptorType
16817
+ then:
16818
+ required:
16819
+ - http
16732
16820
  Error:
16733
16821
  type: object
16734
16822
  description: Standard error response envelope returned by integrator.io APIs.
package/dist/import.yml CHANGED
@@ -1560,7 +1560,9 @@ components:
1560
1560
  type: object
1561
1561
  description: |-
1562
1562
  Configuration for HTTP imports.
1563
- Required whenever the connection referenced by _connectionId has type http.
1563
+ Required whenever the connection referenced by _connectionId has type http, and on
1564
+ `NetSuiteHTTPImport` (NetSuite's REST APIs on a `netsuite` connection, where `nsDomainType`
1565
+ supplies the host).
1564
1566
  x-celigo-ai-guidance:
1565
1567
  - |-
1566
1568
  IMPORTANT:
@@ -1568,6 +1570,11 @@ components:
1568
1570
  this object MUST be populated for the import to function properly.
1569
1571
  This is a required configuration for all HTTP based imports,
1570
1572
  as determined by the connection associated with the import.
1573
+ - |-
1574
+ A `NetSuiteHTTPImport` uses this same object on a netsuite connection: each `relativeURI`
1575
+ entry carries the full path from `/services/rest/record/v1/<type>` (SuiteTalk) or
1576
+ `/app/site/hosting/restlet.nl?script=<id>&deploy=<n>` (custom RESTlet); the host and the
1577
+ token signature come from the connection.
1571
1578
  properties:
1572
1579
  sendPostMappedData:
1573
1580
  type: boolean
@@ -13997,6 +14004,7 @@ components:
13997
14004
  description: |-
13998
14005
  Connection this import uses to reach the destination system. The connection's type must
13999
14006
  be compatible with the import's `adaptorType` (e.g. an `HTTPImport` needs an `http`
14007
+ connection; `NetSuiteDistributedImport` and `NetSuiteHTTPImport` both need a `netsuite`
14000
14008
  connection). Server-required — POST without it fails with 422 "Expected field:
14001
14009
  _connectionId to be present" — except for the connection-less flavors (`ToolImport`,
14002
14010
  `AiAgentImport`, `GuardrailImport`), which the server creates without one.
@@ -14029,9 +14037,15 @@ components:
14029
14037
  Use HTTPImport for all REST/SOAP APIs unless a specialized adaptor exists for the
14030
14038
  target system; always pair the adaptorType with its matching configuration object.
14031
14039
  - |-
14032
- For NetSuite, always use NetSuiteDistributedImport (with the netsuite_da object).
14033
- NetSuiteImport is a legacy adaptor for accounts without the Celigo SuiteApp 2.0 — do
14034
- not use it unless explicitly requested.
14040
+ For NetSuite, use NetSuiteDistributedImport (with the netsuite_da object) when the
14041
+ Celigo SuiteApp or bundle is installed in the account — check with
14042
+ `GET /v1/connections/{_id}/distributedApps` (`suiteapp.success` / `bundle.success`).
14043
+ Use NetSuiteHTTPImport (with `nsDomainType` and the http object) when neither is
14044
+ installed or the user asks for NetSuite's REST APIs; the platform's SuiteTalk connector
14045
+ catalogs `POST /services/rest/record/v1/<type>` for inserts and
14046
+ `PATCH /services/rest/record/v1/<type>/{id}` for updates, and saving links the step to
14047
+ them. NetSuiteImport is a legacy adaptor for accounts without the Celigo SuiteApp 2.0 —
14048
+ do not use it unless explicitly requested.
14035
14049
  - |-
14036
14050
  Use RDBMSImport (with the rdbms object) for built-in database types such as SQL Server,
14037
14051
  MySQL, PostgreSQL, Snowflake, Oracle, and MariaDB. Use JDBCImport (with the jdbc
@@ -14043,6 +14057,7 @@ components:
14043
14057
  - S3Import
14044
14058
  - NetSuiteImport
14045
14059
  - NetSuiteDistributedImport
14060
+ - NetSuiteHTTPImport
14046
14061
  - SalesforceImport
14047
14062
  - JDBCImport
14048
14063
  - RDBMSImport
@@ -14060,7 +14075,8 @@ components:
14060
14075
  AS2Import: File import via AS2 (Applicability Statement 2) protocol.
14061
14076
  S3Import: File import to Amazon S3 storage.
14062
14077
  NetSuiteImport: Legacy NetSuite import for accounts without the Celigo SuiteApp 2.0.
14063
- NetSuiteDistributedImport: NetSuite import using the distributed SuiteApp 2.0 adaptor (default for NetSuite).
14078
+ NetSuiteDistributedImport: NetSuite import using the distributed SuiteApp 2.0 adaptor (default for NetSuite when the SuiteApp or bundle is installed).
14079
+ 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.
14064
14080
  SalesforceImport: Salesforce-specific import using SOAP, REST, Metadata, or Composite APIs.
14065
14081
  JDBCImport: Database import via a generic JDBC connection (not for built-in RDBMS types).
14066
14082
  RDBMSImport: Database import for built-in RDBMS types such as SQL Server, MySQL, PostgreSQL, Snowflake, and Oracle.
@@ -14075,10 +14091,38 @@ components:
14075
14091
  examples:
14076
14092
  - HTTPImport
14077
14093
  - NetSuiteDistributedImport
14094
+ - NetSuiteHTTPImport
14078
14095
  - SalesforceImport
14079
14096
  - FTPImport
14080
14097
  - AiAgentImport
14081
14098
  - GuardrailImport
14099
+ nsDomainType:
14100
+ type: string
14101
+ enum:
14102
+ - suitetalk
14103
+ - restlet
14104
+ x-lowercase: true
14105
+ x-enumDescriptions:
14106
+ suitetalk: NetSuite SuiteTalk REST web services — record endpoints under /services/rest/record/v1
14107
+ restlet: A custom RESTlet script deployed in the NetSuite account, called at /app/site/hosting/restlet.nl?script=<id>&deploy=<n>
14108
+ description: |-
14109
+ Selects which NetSuite REST host a `NetSuiteHTTPImport` calls. The server derives the
14110
+ full base URL from the connection's NetSuite account
14111
+ (`https://<account>.suitetalk.api.netsuite.com` or `https://<account>.restlets.api.netsuite.com`)
14112
+ and signs each request with the connection's token-based credentials, so each
14113
+ `http.relativeURI` entry carries the complete path starting at `/services/rest/...` or
14114
+ `/app/site/hosting/restlet.nl`. Ignored on other adaptor types.
14115
+ x-celigo-ai-guidance:
14116
+ - |-
14117
+ Required on `NetSuiteHTTPImport`: omitting it fails the save with 422 "Path `nsDomainType`
14118
+ is required." The import's `_connectionId` must be a netsuite connection — an http
14119
+ connection fails with 422 invalid_connection_type.
14120
+ - |-
14121
+ With `suitetalk`, saving links `http._httpConnectorVersionId`, `_httpConnectorResourceId`
14122
+ and `_httpConnectorEndpointIds` to the platform's SuiteTalk connector from each
14123
+ `http.method` + `http.relativeURI` pair (for example `POST /services/rest/record/v1/customer`
14124
+ links to that record type's insert endpoint), so the UI's Simple view renders an
14125
+ API-authored step; `restlet` steps are not linked.
14082
14126
  externalId:
14083
14127
  type:
14084
14128
  - string
@@ -15111,6 +15155,16 @@ components:
15111
15155
  else:
15112
15156
  required:
15113
15157
  - _connectionId
15158
+ if:
15159
+ properties:
15160
+ adaptorType:
15161
+ const: NetSuiteHTTPImport
15162
+ required:
15163
+ - adaptorType
15164
+ then:
15165
+ required:
15166
+ - http
15167
+ - nsDomainType
15114
15168
  Error:
15115
15169
  type: object
15116
15170
  description: Standard error response envelope returned by integrator.io APIs.