@celigo/api-specs 0.2.178 → 0.2.179
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 +22 -9
- package/dist/tool.yml +22 -9
- package/package.json +1 -1
- package/schemas.json +1 -1
package/dist/export.yml
CHANGED
|
@@ -8025,11 +8025,13 @@ components:
|
|
|
8025
8025
|
It defines how data is extracted from Salesforce,
|
|
8026
8026
|
either through queries or real-time events.
|
|
8027
8027
|
- |-
|
|
8028
|
-
|
|
8029
|
-
|
|
8030
|
-
|
|
8031
|
-
|
|
8032
|
-
`soql` object.
|
|
8028
|
+
Set `type` on every Salesforce export you create (`soql` or `distributed`).
|
|
8029
|
+
Never read its absence on an existing export as a defect: a listener saved
|
|
8030
|
+
from the integrator.io form carries no `salesforce.type` and the platform
|
|
8031
|
+
fires it without the field, and file/byId retrievals (`id` + `sObjectType`,
|
|
8032
|
+
no `soql` object) carry `type: soql` without a `soql` object. A listener
|
|
8033
|
+
that never creates a job is diagnosed from `distributed` (below), not from
|
|
8034
|
+
this field.
|
|
8033
8035
|
- |-
|
|
8034
8036
|
## SALESFORCE EXPORT MODES
|
|
8035
8037
|
|
|
@@ -8061,8 +8063,10 @@ components:
|
|
|
8061
8063
|
Required fields: type, soql.query
|
|
8062
8064
|
Optional fields: api, includeDeletedRecords, bulk (when api="bulk")
|
|
8063
8065
|
|
|
8064
|
-
- For Distributed exports (
|
|
8065
|
-
|
|
8066
|
+
- For Distributed exports (real-time listeners):
|
|
8067
|
+
Set type="distributed" with the distributed object and sObjectType when creating one.
|
|
8068
|
+
A listener saved from the integrator.io form carries the distributed object and
|
|
8069
|
+
sObjectType with no type, and the platform fires it — a valid listener, not a missing field.
|
|
8066
8070
|
Optional fields: distributed.referencedFields, distributed.qualifier
|
|
8067
8071
|
|
|
8068
8072
|
- For Blob exports (when export.type="blob"):
|
|
@@ -8078,7 +8082,10 @@ components:
|
|
|
8078
8082
|
|
|
8079
8083
|
This field determines the core operating mode of the Salesforce export:
|
|
8080
8084
|
|
|
8081
|
-
-
|
|
8085
|
+
- Set it on every Salesforce export you create; a listener saved from the
|
|
8086
|
+
integrator.io form carries none and the platform fires it without the
|
|
8087
|
+
field, so an absent `type` beside a `distributed` object is the normal
|
|
8088
|
+
shape of a form-saved listener, not a missing setting
|
|
8082
8089
|
- Controls which additional configuration objects must be provided
|
|
8083
8090
|
- Affects how the export appears and functions in the flow builder UI
|
|
8084
8091
|
- Cannot be changed after creation without significant reconfiguration
|
|
@@ -8573,7 +8580,7 @@ components:
|
|
|
8573
8580
|
- SELECT Id, Name, (SELECT Id, FirstName, LastName FROM Contacts) FROM Account
|
|
8574
8581
|
distributed:
|
|
8575
8582
|
type: object
|
|
8576
|
-
description: Real-time listener configuration
|
|
8583
|
+
description: 'Real-time listener configuration — the object that makes an export a listener. Set it, with `type: distributed`, when creating one; a listener saved from the integrator.io form carries it with no `type`, and the platform fires it either way. Not used on SOQL or file exports. Records reach the flow only when an Apex trigger on `sObjectType` in the connected org calls the Celigo package (`integrator_da__.RealTimeExporter.processExport()`) — no scheduling or manual execution is involved. Integration Apps create their triggers at installation; for a custom flow the customer deploys the trigger in Salesforce, starting from the code the export page shows under Required trigger.'
|
|
8577
8584
|
x-celigo-ai-guidance:
|
|
8578
8585
|
- |-
|
|
8579
8586
|
After creating a listener on a custom flow, relay what the Help Center's "Listen for real-time data
|
|
@@ -8588,6 +8595,12 @@ components:
|
|
|
8588
8595
|
Help Center's trigger requirement in the connected org: an active Apex trigger on the object whose
|
|
8589
8596
|
code calls `integrator_da__.RealTimeExporter`, and the Celigo package reachable through the
|
|
8590
8597
|
connection (`GET /v1/connections/{_id}/distributed`, documented in this spec set).
|
|
8598
|
+
- |-
|
|
8599
|
+
Two things are never why a listener does not fire. The export preview cannot run a listener:
|
|
8600
|
+
it validates the body as a SOQL export and answers 422 `missing_required_field` for
|
|
8601
|
+
`soql.query` (and for `type` when the listener carries none) before the connection is used,
|
|
8602
|
+
so a failed preview is expected, not a configuration defect. And an absent `salesforce.type`
|
|
8603
|
+
is the normal shape of a listener saved from the integrator.io form (see `type`).
|
|
8591
8604
|
properties:
|
|
8592
8605
|
referencedFields:
|
|
8593
8606
|
type:
|
package/dist/tool.yml
CHANGED
|
@@ -33046,11 +33046,13 @@ components:
|
|
|
33046
33046
|
It defines how data is extracted from Salesforce,
|
|
33047
33047
|
either through queries or real-time events.
|
|
33048
33048
|
- |-
|
|
33049
|
-
|
|
33050
|
-
|
|
33051
|
-
|
|
33052
|
-
|
|
33053
|
-
`soql` object.
|
|
33049
|
+
Set `type` on every Salesforce export you create (`soql` or `distributed`).
|
|
33050
|
+
Never read its absence on an existing export as a defect: a listener saved
|
|
33051
|
+
from the integrator.io form carries no `salesforce.type` and the platform
|
|
33052
|
+
fires it without the field, and file/byId retrievals (`id` + `sObjectType`,
|
|
33053
|
+
no `soql` object) carry `type: soql` without a `soql` object. A listener
|
|
33054
|
+
that never creates a job is diagnosed from `distributed` (below), not from
|
|
33055
|
+
this field.
|
|
33054
33056
|
- |-
|
|
33055
33057
|
## SALESFORCE EXPORT MODES
|
|
33056
33058
|
|
|
@@ -33082,8 +33084,10 @@ components:
|
|
|
33082
33084
|
Required fields: type, soql.query
|
|
33083
33085
|
Optional fields: api, includeDeletedRecords, bulk (when api="bulk")
|
|
33084
33086
|
|
|
33085
|
-
- For Distributed exports (
|
|
33086
|
-
|
|
33087
|
+
- For Distributed exports (real-time listeners):
|
|
33088
|
+
Set type="distributed" with the distributed object and sObjectType when creating one.
|
|
33089
|
+
A listener saved from the integrator.io form carries the distributed object and
|
|
33090
|
+
sObjectType with no type, and the platform fires it — a valid listener, not a missing field.
|
|
33087
33091
|
Optional fields: distributed.referencedFields, distributed.qualifier
|
|
33088
33092
|
|
|
33089
33093
|
- For Blob exports (when export.type="blob"):
|
|
@@ -33099,7 +33103,10 @@ components:
|
|
|
33099
33103
|
|
|
33100
33104
|
This field determines the core operating mode of the Salesforce export:
|
|
33101
33105
|
|
|
33102
|
-
-
|
|
33106
|
+
- Set it on every Salesforce export you create; a listener saved from the
|
|
33107
|
+
integrator.io form carries none and the platform fires it without the
|
|
33108
|
+
field, so an absent `type` beside a `distributed` object is the normal
|
|
33109
|
+
shape of a form-saved listener, not a missing setting
|
|
33103
33110
|
- Controls which additional configuration objects must be provided
|
|
33104
33111
|
- Affects how the export appears and functions in the flow builder UI
|
|
33105
33112
|
- Cannot be changed after creation without significant reconfiguration
|
|
@@ -33594,7 +33601,7 @@ components:
|
|
|
33594
33601
|
- SELECT Id, Name, (SELECT Id, FirstName, LastName FROM Contacts) FROM Account
|
|
33595
33602
|
distributed:
|
|
33596
33603
|
type: object
|
|
33597
|
-
description: Real-time listener configuration
|
|
33604
|
+
description: 'Real-time listener configuration — the object that makes an export a listener. Set it, with `type: distributed`, when creating one; a listener saved from the integrator.io form carries it with no `type`, and the platform fires it either way. Not used on SOQL or file exports. Records reach the flow only when an Apex trigger on `sObjectType` in the connected org calls the Celigo package (`integrator_da__.RealTimeExporter.processExport()`) — no scheduling or manual execution is involved. Integration Apps create their triggers at installation; for a custom flow the customer deploys the trigger in Salesforce, starting from the code the export page shows under Required trigger.'
|
|
33598
33605
|
x-celigo-ai-guidance:
|
|
33599
33606
|
- |-
|
|
33600
33607
|
After creating a listener on a custom flow, relay what the Help Center's "Listen for real-time data
|
|
@@ -33609,6 +33616,12 @@ components:
|
|
|
33609
33616
|
Help Center's trigger requirement in the connected org: an active Apex trigger on the object whose
|
|
33610
33617
|
code calls `integrator_da__.RealTimeExporter`, and the Celigo package reachable through the
|
|
33611
33618
|
connection (`GET /v1/connections/{_id}/distributed`, documented in this spec set).
|
|
33619
|
+
- |-
|
|
33620
|
+
Two things are never why a listener does not fire. The export preview cannot run a listener:
|
|
33621
|
+
it validates the body as a SOQL export and answers 422 `missing_required_field` for
|
|
33622
|
+
`soql.query` (and for `type` when the listener carries none) before the connection is used,
|
|
33623
|
+
so a failed preview is expected, not a configuration defect. And an absent `salesforce.type`
|
|
33624
|
+
is the normal shape of a listener saved from the integrator.io form (see `type`).
|
|
33612
33625
|
properties:
|
|
33613
33626
|
referencedFields:
|
|
33614
33627
|
type:
|
package/package.json
CHANGED