@celigo/api-specs 0.2.195 → 0.2.197

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.
@@ -875,7 +875,9 @@ components:
875
875
  - statusMapping
876
876
  - departmentCodes
877
877
  hardCodedValue:
878
- type: string
878
+ type:
879
+ - string
880
+ - 'null'
879
881
  description: |
880
882
  Constant written to the destination instead of an extracted value. On a primitive
881
883
  array (`stringarray`, `numberarray`, `booleanarray`) the string is split on commas,
@@ -883,6 +885,8 @@ components:
883
885
  On an `object` it must be a JSON object string and on an `objectarray` a JSON array
884
886
  string (an object string becomes one element); the save parses it and refuses non-JSON
885
887
  or the wrong shape with 422, and an array row with a constant needs no `buildArrayHelper`.
888
+ JSON `null` writes the destination field as null; it is what the mapper saves for its
889
+ hard-coded "Use null as default value" choice.
886
890
  examples:
887
891
  - USD
888
892
  - A,B
@@ -1969,7 +1973,9 @@ components:
1969
1973
  - statusMapping
1970
1974
  - departmentCodes
1971
1975
  hardCodedValue:
1972
- type: string
1976
+ type:
1977
+ - string
1978
+ - 'null'
1973
1979
  description: |
1974
1980
  Constant written to the destination instead of an extracted value. On a primitive
1975
1981
  array (`stringarray`, `numberarray`, `booleanarray`) the string is split on commas,
@@ -1977,6 +1983,8 @@ components:
1977
1983
  On an `object` it must be a JSON object string and on an `objectarray` a JSON array
1978
1984
  string (an object string becomes one element); the save parses it and refuses non-JSON
1979
1985
  or the wrong shape with 422, and an array row with a constant needs no `buildArrayHelper`.
1986
+ JSON `null` writes the destination field as null; it is what the mapper saves for its
1987
+ hard-coded "Use null as default value" choice.
1980
1988
  examples:
1981
1989
  - USD
1982
1990
  - A,B
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 — most distributed listeners (NetSuite,
5912
- Salesforce real-time) use no token. Write-only and stored encrypted; treat it as a
5913
- sensitive credential.
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 deployment is inactive and record saves no longer
11319
- trigger the export. Maintained by the platform as the flow is disabled and re-enabled;
11320
- re-enabling the flow re-registers the deployment. A listener is created disabled, and
11321
- a flow created already enabled leaves it that way until a flow update sets
11322
- `disabled: false`, which activates it within seconds.
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, not by setting this field. A listener that has
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: |-
@@ -12936,7 +12961,9 @@ components:
12936
12961
  - statusMapping
12937
12962
  - departmentCodes
12938
12963
  hardCodedValue:
12939
- type: string
12964
+ type:
12965
+ - string
12966
+ - 'null'
12940
12967
  description: |
12941
12968
  Constant written to the destination instead of an extracted value. On a primitive
12942
12969
  array (`stringarray`, `numberarray`, `booleanarray`) the string is split on commas,
@@ -12944,6 +12971,8 @@ components:
12944
12971
  On an `object` it must be a JSON object string and on an `objectarray` a JSON array
12945
12972
  string (an object string becomes one element); the save parses it and refuses non-JSON
12946
12973
  or the wrong shape with 422, and an array row with a constant needs no `buildArrayHelper`.
12974
+ JSON `null` writes the destination field as null; it is what the mapper saves for its
12975
+ hard-coded "Use null as default value" choice.
12947
12976
  examples:
12948
12977
  - USD
12949
12978
  - A,B
@@ -14030,7 +14059,9 @@ components:
14030
14059
  - statusMapping
14031
14060
  - departmentCodes
14032
14061
  hardCodedValue:
14033
- type: string
14062
+ type:
14063
+ - string
14064
+ - 'null'
14034
14065
  description: |
14035
14066
  Constant written to the destination instead of an extracted value. On a primitive
14036
14067
  array (`stringarray`, `numberarray`, `booleanarray`) the string is split on commas,
@@ -14038,6 +14069,8 @@ components:
14038
14069
  On an `object` it must be a JSON object string and on an `objectarray` a JSON array
14039
14070
  string (an object string becomes one element); the save parses it and refuses non-JSON
14040
14071
  or the wrong shape with 422, and an array row with a constant needs no `buildArrayHelper`.
14072
+ JSON `null` writes the destination field as null; it is what the mapper saves for its
14073
+ hard-coded "Use null as default value" choice.
14041
14074
  examples:
14042
14075
  - USD
14043
14076
  - A,B
package/dist/import.yml CHANGED
@@ -13247,7 +13247,9 @@ components:
13247
13247
  - statusMapping
13248
13248
  - departmentCodes
13249
13249
  hardCodedValue:
13250
- type: string
13250
+ type:
13251
+ - string
13252
+ - 'null'
13251
13253
  description: |
13252
13254
  Constant written to the destination instead of an extracted value. On a primitive
13253
13255
  array (`stringarray`, `numberarray`, `booleanarray`) the string is split on commas,
@@ -13255,6 +13257,8 @@ components:
13255
13257
  On an `object` it must be a JSON object string and on an `objectarray` a JSON array
13256
13258
  string (an object string becomes one element); the save parses it and refuses non-JSON
13257
13259
  or the wrong shape with 422, and an array row with a constant needs no `buildArrayHelper`.
13260
+ JSON `null` writes the destination field as null; it is what the mapper saves for its
13261
+ hard-coded "Use null as default value" choice.
13258
13262
  examples:
13259
13263
  - USD
13260
13264
  - A,B
@@ -14341,7 +14345,9 @@ components:
14341
14345
  - statusMapping
14342
14346
  - departmentCodes
14343
14347
  hardCodedValue:
14344
- type: string
14348
+ type:
14349
+ - string
14350
+ - 'null'
14345
14351
  description: |
14346
14352
  Constant written to the destination instead of an extracted value. On a primitive
14347
14353
  array (`stringarray`, `numberarray`, `booleanarray`) the string is split on commas,
@@ -14349,6 +14355,8 @@ components:
14349
14355
  On an `object` it must be a JSON object string and on an `objectarray` a JSON array
14350
14356
  string (an object string becomes one element); the save parses it and refuses non-JSON
14351
14357
  or the wrong shape with 422, and an array row with a constant needs no `buildArrayHelper`.
14358
+ JSON `null` writes the destination field as null; it is what the mapper saves for its
14359
+ hard-coded "Use null as default value" choice.
14352
14360
  examples:
14353
14361
  - USD
14354
14362
  - A,B
package/dist/tool.yml CHANGED
@@ -3919,7 +3919,9 @@ components:
3919
3919
  - statusMapping
3920
3920
  - departmentCodes
3921
3921
  hardCodedValue:
3922
- type: string
3922
+ type:
3923
+ - string
3924
+ - 'null'
3923
3925
  description: |
3924
3926
  Constant written to the destination instead of an extracted value. On a primitive
3925
3927
  array (`stringarray`, `numberarray`, `booleanarray`) the string is split on commas,
@@ -3927,6 +3929,8 @@ components:
3927
3929
  On an `object` it must be a JSON object string and on an `objectarray` a JSON array
3928
3930
  string (an object string becomes one element); the save parses it and refuses non-JSON
3929
3931
  or the wrong shape with 422, and an array row with a constant needs no `buildArrayHelper`.
3932
+ JSON `null` writes the destination field as null; it is what the mapper saves for its
3933
+ hard-coded "Use null as default value" choice.
3930
3934
  examples:
3931
3935
  - USD
3932
3936
  - A,B
@@ -5013,7 +5017,9 @@ components:
5013
5017
  - statusMapping
5014
5018
  - departmentCodes
5015
5019
  hardCodedValue:
5016
- type: string
5020
+ type:
5021
+ - string
5022
+ - 'null'
5017
5023
  description: |
5018
5024
  Constant written to the destination instead of an extracted value. On a primitive
5019
5025
  array (`stringarray`, `numberarray`, `booleanarray`) the string is split on commas,
@@ -5021,6 +5027,8 @@ components:
5021
5027
  On an `object` it must be a JSON object string and on an `objectarray` a JSON array
5022
5028
  string (an object string becomes one element); the save parses it and refuses non-JSON
5023
5029
  or the wrong shape with 422, and an array row with a constant needs no `buildArrayHelper`.
5030
+ JSON `null` writes the destination field as null; it is what the mapper saves for its
5031
+ hard-coded "Use null as default value" choice.
5024
5032
  examples:
5025
5033
  - USD
5026
5034
  - A,B
@@ -31221,9 +31229,13 @@ components:
31221
31229
  type: string
31222
31230
  description: |-
31223
31231
  Bearer token that a system pushing data into this export sends as
31224
- `Authorization: Bearer <token>`. Optional — most distributed listeners (NetSuite,
31225
- Salesforce real-time) use no token. Write-only and stored encrypted; treat it as a
31226
- sensitive credential.
31232
+ `Authorization: Bearer <token>`. Optional — Salesforce real-time listeners use no token.
31233
+ For a NetSuite listener the platform generates it when the export is saved as a listener,
31234
+ writes it to the listener's registration record in NetSuite, and generates a new one only
31235
+ when a save re-creates the listener (a `type` change back to `distributed`) — never on a
31236
+ flow toggle or another `PUT`; a client sets and keeps a value itself only for a system of
31237
+ its own that pushes to the export's data endpoint. Stored encrypted and returned masked;
31238
+ treat it as a sensitive credential.
31227
31239
  format: password
31228
31240
  examples:
31229
31241
  - eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
@@ -36555,6 +36567,16 @@ components:
36555
36567
  `netsuite.type: distributed`. Saving it creates a user event script deployment on the
36556
36568
  record type that runs after submit, so records arrive only when NetSuite saves one and
36557
36569
  `POST /v1/exports/preview` cannot sample it.
36570
+ - |-
36571
+ Saving the listener also registers it in NetSuite (the SuiteApp's record for this export,
36572
+ holding its record type, contexts, types, qualifier, endpoint URL and token); a `PUT` that
36573
+ keeps the export a listener re-pushes those fields, leaves the token as it is, and sets
36574
+ the registration's disabled state from the body's `distributed.disabled` (omitted means
36575
+ inactive). A `PUT` that changes `type` to a scheduled value leaves that
36576
+ registration in place and active — NetSuite keeps queuing qualifying saves for an export
36577
+ that no longer listens — so remove or disable the listener's flow rather than converting
36578
+ the step in place, and never treat the conversion as reversible without re-checking
36579
+ `distributed.disabled` afterwards.
36558
36580
  properties:
36559
36581
  recordType:
36560
36582
  type: string
@@ -36628,15 +36650,26 @@ components:
36628
36650
  disabled:
36629
36651
  type: boolean
36630
36652
  description: |-
36631
- When true, the listener's NetSuite deployment is inactive and record saves no longer
36632
- trigger the export. Maintained by the platform as the flow is disabled and re-enabled;
36633
- re-enabling the flow re-registers the deployment. A listener is created disabled, and
36634
- a flow created already enabled leaves it that way until a flow update sets
36635
- `disabled: false`, which activates it within seconds.
36653
+ When true, the listener's NetSuite registration is inactive and record saves no longer
36654
+ trigger the export. The platform keeps it in step with the flow — enabling the flow sets
36655
+ it false within seconds, disabling or deleting the flow sets it true — and every save
36656
+ that leaves the export a listener (a create, a `PUT` that keeps it a listener, a `PUT`
36657
+ that makes it `distributed` again after another type) applies the body's value, an
36658
+ omitted field meaning true: a listener is created disabled, a flow created already
36659
+ enabled leaves it so until a flow update sets `disabled: false`, and a `PUT` that omits
36660
+ the field inactivates it.
36636
36661
  x-celigo-ai-guidance:
36637
36662
  - |-
36638
- Pause a listener by disabling its flow, not by setting this field. A listener that has
36663
+ Pause or resume a listener by disabling or enabling its flow; the field follows. Every
36664
+ `PUT` of a listener on an enabled flow must carry `disabled: false` — an omitted field or
36665
+ a stale `true` inactivates the NetSuite registration while the flow stays enabled (the
36666
+ UI never hits this because it writes back the document it read). A listener that has
36639
36667
  stopped firing is re-registered by disabling and re-enabling the flow.
36668
+ - |-
36669
+ A `PUT` that changes `type` back to `distributed` after the export was another type
36670
+ re-creates the listener: send `disabled: false` when the flow is enabled, or it comes
36671
+ back inactive until a follow-up `PUT` with `disabled: false` or a disable and re-enable
36672
+ of the flow activates it.
36640
36673
  executionType:
36641
36674
  type: array
36642
36675
  description: |-
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@celigo/api-specs",
3
- "version": "0.2.195",
3
+ "version": "0.2.197",
4
4
  "private": false,
5
5
  "description": "Public OpenAPI bundles (dist/) and the celigo-cli lint schema pack (schemas.json).",
6
6
  "keywords": [