@celigo/api-specs 0.2.194 → 0.2.196
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 +34 -9
- package/dist/import.yml +17 -1
- package/dist/tool.yml +51 -10
- package/package.json +1 -1
- package/schemas.json +2 -2
package/dist/export.yml
CHANGED
|
@@ -5908,9 +5908,13 @@ components:
|
|
|
5908
5908
|
type: string
|
|
5909
5909
|
description: |-
|
|
5910
5910
|
Bearer token that a system pushing data into this export sends as
|
|
5911
|
-
`Authorization: Bearer <token>`. Optional —
|
|
5912
|
-
|
|
5913
|
-
|
|
5911
|
+
`Authorization: Bearer <token>`. Optional — Salesforce real-time listeners use no token.
|
|
5912
|
+
For a NetSuite listener the platform generates it when the export is saved as a listener,
|
|
5913
|
+
writes it to the listener's registration record in NetSuite, and generates a new one only
|
|
5914
|
+
when a save re-creates the listener (a `type` change back to `distributed`) — never on a
|
|
5915
|
+
flow toggle or another `PUT`; a client sets and keeps a value itself only for a system of
|
|
5916
|
+
its own that pushes to the export's data endpoint. Stored encrypted and returned masked;
|
|
5917
|
+
treat it as a sensitive credential.
|
|
5914
5918
|
format: password
|
|
5915
5919
|
examples:
|
|
5916
5920
|
- eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
|
|
@@ -11242,6 +11246,16 @@ components:
|
|
|
11242
11246
|
`netsuite.type: distributed`. Saving it creates a user event script deployment on the
|
|
11243
11247
|
record type that runs after submit, so records arrive only when NetSuite saves one and
|
|
11244
11248
|
`POST /v1/exports/preview` cannot sample it.
|
|
11249
|
+
- |-
|
|
11250
|
+
Saving the listener also registers it in NetSuite (the SuiteApp's record for this export,
|
|
11251
|
+
holding its record type, contexts, types, qualifier, endpoint URL and token); a `PUT` that
|
|
11252
|
+
keeps the export a listener re-pushes those fields, leaves the token as it is, and sets
|
|
11253
|
+
the registration's disabled state from the body's `distributed.disabled` (omitted means
|
|
11254
|
+
inactive). A `PUT` that changes `type` to a scheduled value leaves that
|
|
11255
|
+
registration in place and active — NetSuite keeps queuing qualifying saves for an export
|
|
11256
|
+
that no longer listens — so remove or disable the listener's flow rather than converting
|
|
11257
|
+
the step in place, and never treat the conversion as reversible without re-checking
|
|
11258
|
+
`distributed.disabled` afterwards.
|
|
11245
11259
|
properties:
|
|
11246
11260
|
recordType:
|
|
11247
11261
|
type: string
|
|
@@ -11315,15 +11329,26 @@ components:
|
|
|
11315
11329
|
disabled:
|
|
11316
11330
|
type: boolean
|
|
11317
11331
|
description: |-
|
|
11318
|
-
When true, the listener's NetSuite
|
|
11319
|
-
trigger the export.
|
|
11320
|
-
|
|
11321
|
-
a
|
|
11322
|
-
`
|
|
11332
|
+
When true, the listener's NetSuite registration is inactive and record saves no longer
|
|
11333
|
+
trigger the export. The platform keeps it in step with the flow — enabling the flow sets
|
|
11334
|
+
it false within seconds, disabling or deleting the flow sets it true — and every save
|
|
11335
|
+
that leaves the export a listener (a create, a `PUT` that keeps it a listener, a `PUT`
|
|
11336
|
+
that makes it `distributed` again after another type) applies the body's value, an
|
|
11337
|
+
omitted field meaning true: a listener is created disabled, a flow created already
|
|
11338
|
+
enabled leaves it so until a flow update sets `disabled: false`, and a `PUT` that omits
|
|
11339
|
+
the field inactivates it.
|
|
11323
11340
|
x-celigo-ai-guidance:
|
|
11324
11341
|
- |-
|
|
11325
|
-
Pause a listener by disabling its flow
|
|
11342
|
+
Pause or resume a listener by disabling or enabling its flow; the field follows. Every
|
|
11343
|
+
`PUT` of a listener on an enabled flow must carry `disabled: false` — an omitted field or
|
|
11344
|
+
a stale `true` inactivates the NetSuite registration while the flow stays enabled (the
|
|
11345
|
+
UI never hits this because it writes back the document it read). A listener that has
|
|
11326
11346
|
stopped firing is re-registered by disabling and re-enabling the flow.
|
|
11347
|
+
- |-
|
|
11348
|
+
A `PUT` that changes `type` back to `distributed` after the export was another type
|
|
11349
|
+
re-creates the listener: send `disabled: false` when the flow is enabled, or it comes
|
|
11350
|
+
back inactive until a follow-up `PUT` with `disabled: false` or a disable and re-enable
|
|
11351
|
+
of the flow activates it.
|
|
11327
11352
|
executionType:
|
|
11328
11353
|
type: array
|
|
11329
11354
|
description: |-
|
package/dist/import.yml
CHANGED
|
@@ -4145,6 +4145,10 @@ components:
|
|
|
4145
4145
|
- |-
|
|
4146
4146
|
Validated via the dedicated `PUT /v1/netsuiteDA/previewImportMappingFields`
|
|
4147
4147
|
endpoint (NOT `/v1/processors/mapperProcessor`).
|
|
4148
|
+
- |-
|
|
4149
|
+
The preview resolves the mapping without writing to NetSuite: the multiselect row
|
|
4150
|
+
NetSuite rejected at save time (see `fields[].dataType`) rendered exactly like the
|
|
4151
|
+
row it accepted, so a passed preview does not prove the save.
|
|
4148
4152
|
properties:
|
|
4149
4153
|
fields:
|
|
4150
4154
|
type: array
|
|
@@ -4180,9 +4184,21 @@ components:
|
|
|
4180
4184
|
type: string
|
|
4181
4185
|
description: |
|
|
4182
4186
|
Data type hint for the field value (e.g., "string", "number", "date", "boolean").
|
|
4187
|
+
Omit it on a multiselect reference row (`internalId: true`), which takes an array
|
|
4188
|
+
of numeric internal ids.
|
|
4189
|
+
x-celigo-ai-guidance:
|
|
4190
|
+
- |-
|
|
4191
|
+
On a multiselect reference row, `dataType: "stringarray"` with an array of string
|
|
4192
|
+
ids was written as ONE comma-joined text selection and NetSuite rejected the save
|
|
4193
|
+
with `Invalid <field> reference key <id1>,<id2>,…`, leaving the field empty; the
|
|
4194
|
+
same row with no `dataType` and an array of numeric ids saved every id as a
|
|
4195
|
+
selection.
|
|
4183
4196
|
internalId:
|
|
4184
4197
|
type: boolean
|
|
4185
|
-
description:
|
|
4198
|
+
description: |-
|
|
4199
|
+
When true, the value is a NetSuite internal ID reference — the mapper's
|
|
4200
|
+
"(InternalId)" destination row, stored on the base field id in `generate` rather
|
|
4201
|
+
than as a `<field>.internalid` suffix.
|
|
4186
4202
|
immutable:
|
|
4187
4203
|
type: boolean
|
|
4188
4204
|
description: When true, this field is only set on record creation, not on updates.
|
package/dist/tool.yml
CHANGED
|
@@ -16154,6 +16154,10 @@ components:
|
|
|
16154
16154
|
- |-
|
|
16155
16155
|
Validated via the dedicated `PUT /v1/netsuiteDA/previewImportMappingFields`
|
|
16156
16156
|
endpoint (NOT `/v1/processors/mapperProcessor`).
|
|
16157
|
+
- |-
|
|
16158
|
+
The preview resolves the mapping without writing to NetSuite: the multiselect row
|
|
16159
|
+
NetSuite rejected at save time (see `fields[].dataType`) rendered exactly like the
|
|
16160
|
+
row it accepted, so a passed preview does not prove the save.
|
|
16157
16161
|
properties:
|
|
16158
16162
|
fields:
|
|
16159
16163
|
type: array
|
|
@@ -16189,9 +16193,21 @@ components:
|
|
|
16189
16193
|
type: string
|
|
16190
16194
|
description: |
|
|
16191
16195
|
Data type hint for the field value (e.g., "string", "number", "date", "boolean").
|
|
16196
|
+
Omit it on a multiselect reference row (`internalId: true`), which takes an array
|
|
16197
|
+
of numeric internal ids.
|
|
16198
|
+
x-celigo-ai-guidance:
|
|
16199
|
+
- |-
|
|
16200
|
+
On a multiselect reference row, `dataType: "stringarray"` with an array of string
|
|
16201
|
+
ids was written as ONE comma-joined text selection and NetSuite rejected the save
|
|
16202
|
+
with `Invalid <field> reference key <id1>,<id2>,…`, leaving the field empty; the
|
|
16203
|
+
same row with no `dataType` and an array of numeric ids saved every id as a
|
|
16204
|
+
selection.
|
|
16192
16205
|
internalId:
|
|
16193
16206
|
type: boolean
|
|
16194
|
-
description:
|
|
16207
|
+
description: |-
|
|
16208
|
+
When true, the value is a NetSuite internal ID reference — the mapper's
|
|
16209
|
+
"(InternalId)" destination row, stored on the base field id in `generate` rather
|
|
16210
|
+
than as a `<field>.internalid` suffix.
|
|
16195
16211
|
immutable:
|
|
16196
16212
|
type: boolean
|
|
16197
16213
|
description: When true, this field is only set on record creation, not on updates.
|
|
@@ -31205,9 +31221,13 @@ components:
|
|
|
31205
31221
|
type: string
|
|
31206
31222
|
description: |-
|
|
31207
31223
|
Bearer token that a system pushing data into this export sends as
|
|
31208
|
-
`Authorization: Bearer <token>`. Optional —
|
|
31209
|
-
|
|
31210
|
-
|
|
31224
|
+
`Authorization: Bearer <token>`. Optional — Salesforce real-time listeners use no token.
|
|
31225
|
+
For a NetSuite listener the platform generates it when the export is saved as a listener,
|
|
31226
|
+
writes it to the listener's registration record in NetSuite, and generates a new one only
|
|
31227
|
+
when a save re-creates the listener (a `type` change back to `distributed`) — never on a
|
|
31228
|
+
flow toggle or another `PUT`; a client sets and keeps a value itself only for a system of
|
|
31229
|
+
its own that pushes to the export's data endpoint. Stored encrypted and returned masked;
|
|
31230
|
+
treat it as a sensitive credential.
|
|
31211
31231
|
format: password
|
|
31212
31232
|
examples:
|
|
31213
31233
|
- eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
|
|
@@ -36539,6 +36559,16 @@ components:
|
|
|
36539
36559
|
`netsuite.type: distributed`. Saving it creates a user event script deployment on the
|
|
36540
36560
|
record type that runs after submit, so records arrive only when NetSuite saves one and
|
|
36541
36561
|
`POST /v1/exports/preview` cannot sample it.
|
|
36562
|
+
- |-
|
|
36563
|
+
Saving the listener also registers it in NetSuite (the SuiteApp's record for this export,
|
|
36564
|
+
holding its record type, contexts, types, qualifier, endpoint URL and token); a `PUT` that
|
|
36565
|
+
keeps the export a listener re-pushes those fields, leaves the token as it is, and sets
|
|
36566
|
+
the registration's disabled state from the body's `distributed.disabled` (omitted means
|
|
36567
|
+
inactive). A `PUT` that changes `type` to a scheduled value leaves that
|
|
36568
|
+
registration in place and active — NetSuite keeps queuing qualifying saves for an export
|
|
36569
|
+
that no longer listens — so remove or disable the listener's flow rather than converting
|
|
36570
|
+
the step in place, and never treat the conversion as reversible without re-checking
|
|
36571
|
+
`distributed.disabled` afterwards.
|
|
36542
36572
|
properties:
|
|
36543
36573
|
recordType:
|
|
36544
36574
|
type: string
|
|
@@ -36612,15 +36642,26 @@ components:
|
|
|
36612
36642
|
disabled:
|
|
36613
36643
|
type: boolean
|
|
36614
36644
|
description: |-
|
|
36615
|
-
When true, the listener's NetSuite
|
|
36616
|
-
trigger the export.
|
|
36617
|
-
|
|
36618
|
-
a
|
|
36619
|
-
`
|
|
36645
|
+
When true, the listener's NetSuite registration is inactive and record saves no longer
|
|
36646
|
+
trigger the export. The platform keeps it in step with the flow — enabling the flow sets
|
|
36647
|
+
it false within seconds, disabling or deleting the flow sets it true — and every save
|
|
36648
|
+
that leaves the export a listener (a create, a `PUT` that keeps it a listener, a `PUT`
|
|
36649
|
+
that makes it `distributed` again after another type) applies the body's value, an
|
|
36650
|
+
omitted field meaning true: a listener is created disabled, a flow created already
|
|
36651
|
+
enabled leaves it so until a flow update sets `disabled: false`, and a `PUT` that omits
|
|
36652
|
+
the field inactivates it.
|
|
36620
36653
|
x-celigo-ai-guidance:
|
|
36621
36654
|
- |-
|
|
36622
|
-
Pause a listener by disabling its flow
|
|
36655
|
+
Pause or resume a listener by disabling or enabling its flow; the field follows. Every
|
|
36656
|
+
`PUT` of a listener on an enabled flow must carry `disabled: false` — an omitted field or
|
|
36657
|
+
a stale `true` inactivates the NetSuite registration while the flow stays enabled (the
|
|
36658
|
+
UI never hits this because it writes back the document it read). A listener that has
|
|
36623
36659
|
stopped firing is re-registered by disabling and re-enabling the flow.
|
|
36660
|
+
- |-
|
|
36661
|
+
A `PUT` that changes `type` back to `distributed` after the export was another type
|
|
36662
|
+
re-creates the listener: send `disabled: false` when the flow is enabled, or it comes
|
|
36663
|
+
back inactive until a follow-up `PUT` with `disabled: false` or a disable and re-enable
|
|
36664
|
+
of the flow activates it.
|
|
36624
36665
|
executionType:
|
|
36625
36666
|
type: array
|
|
36626
36667
|
description: |-
|
package/package.json
CHANGED