@celigo/api-specs 0.2.178 → 0.2.180

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/api.yml CHANGED
@@ -6899,10 +6899,34 @@ components:
6899
6899
  - Amazon-Hybrid
6900
6900
  - vendor_central
6901
6901
  x-enumDescriptions:
6902
- Amazon-SP-API: Amazon Selling Partner API connection.
6903
- Amazon-Hybrid: Hybrid Amazon connection supporting both MWS and SP-API.
6904
- vendor_central: Amazon Vendor Central API connection.
6905
- description: Specific API type for Amazon integrations. Only set this for Amazon connections.
6902
+ Amazon-SP-API: Amazon Seller Central over the Selling Partner API, authorized against Celigo's registered application through Login with Amazon
6903
+ Amazon-Hybrid: Amazon Seller Central over both the legacy MWS and the Selling Partner API, for integrations not yet fully on SP-API
6904
+ vendor_central: Amazon Vendor Central over the Selling Partner API, authorized against Celigo's registered application through Login with Amazon
6905
+ description: |-
6906
+ Selects which Amazon selling program and API family a prebuilt Amazon connection talks to.
6907
+ Set by the Amazon Seller Central and Amazon Vendor Central connection forms; a custom
6908
+ Selling Partner API integration built on the customer's own developer application is a
6909
+ plain HTTP connection and does not carry this field.
6910
+ x-celigo-ai-guidance:
6911
+ - |-
6912
+ The prebuilt Amazon connection forms collect the API type, selling region and marketplace
6913
+ and save an OAuth 2.0 authorization-code connection (`http.auth.type` `oauth`,
6914
+ `http.auth.oauth.grantType` `authorizecode`, `useIClientFields` false) whose authorization
6915
+ URI is the Seller Central or Vendor Central `/apps/authorize/consent` page — Amazon's
6916
+ public-application consent, granted by the selling partner to Celigo's registered
6917
+ Selling Partner API application. Celigo's Seller Central documentation states the customer
6918
+ need not register as an Amazon developer (article 360060827012); the Vendor Central form
6919
+ carries no developer credentials either.
6920
+ - |-
6921
+ The prebuilt forms collect no Amazon developer application id, client secret, AWS
6922
+ credentials or iClient — the Vendor Central form has no iClient field, and the Seller
6923
+ Central form sets `http._iClientId` only for its legacy `Amazon-MWS` choice — so creating
6924
+ one of these connections asks the customer for a Seller Central or Vendor Central account
6925
+ for the chosen region and marketplace and a user who can complete Amazon's consent screen,
6926
+ nothing more. A customer who must run on their OWN developer registration builds a
6927
+ token-based or OAuth 2.0 universal HTTP connection to the Selling Partner API base URI
6928
+ instead (articles 6204088366363 and the OAuth 2.0 universal connector) and takes on
6929
+ Amazon's developer agreements themselves.
6906
6930
  examples:
6907
6931
  - Amazon-SP-API
6908
6932
  clientCertificates:
@@ -5756,10 +5756,34 @@ components:
5756
5756
  - Amazon-Hybrid
5757
5757
  - vendor_central
5758
5758
  x-enumDescriptions:
5759
- Amazon-SP-API: Amazon Selling Partner API connection.
5760
- Amazon-Hybrid: Hybrid Amazon connection supporting both MWS and SP-API.
5761
- vendor_central: Amazon Vendor Central API connection.
5762
- description: Specific API type for Amazon integrations. Only set this for Amazon connections.
5759
+ Amazon-SP-API: Amazon Seller Central over the Selling Partner API, authorized against Celigo's registered application through Login with Amazon
5760
+ Amazon-Hybrid: Amazon Seller Central over both the legacy MWS and the Selling Partner API, for integrations not yet fully on SP-API
5761
+ vendor_central: Amazon Vendor Central over the Selling Partner API, authorized against Celigo's registered application through Login with Amazon
5762
+ description: |-
5763
+ Selects which Amazon selling program and API family a prebuilt Amazon connection talks to.
5764
+ Set by the Amazon Seller Central and Amazon Vendor Central connection forms; a custom
5765
+ Selling Partner API integration built on the customer's own developer application is a
5766
+ plain HTTP connection and does not carry this field.
5767
+ x-celigo-ai-guidance:
5768
+ - |-
5769
+ The prebuilt Amazon connection forms collect the API type, selling region and marketplace
5770
+ and save an OAuth 2.0 authorization-code connection (`http.auth.type` `oauth`,
5771
+ `http.auth.oauth.grantType` `authorizecode`, `useIClientFields` false) whose authorization
5772
+ URI is the Seller Central or Vendor Central `/apps/authorize/consent` page — Amazon's
5773
+ public-application consent, granted by the selling partner to Celigo's registered
5774
+ Selling Partner API application. Celigo's Seller Central documentation states the customer
5775
+ need not register as an Amazon developer (article 360060827012); the Vendor Central form
5776
+ carries no developer credentials either.
5777
+ - |-
5778
+ The prebuilt forms collect no Amazon developer application id, client secret, AWS
5779
+ credentials or iClient — the Vendor Central form has no iClient field, and the Seller
5780
+ Central form sets `http._iClientId` only for its legacy `Amazon-MWS` choice — so creating
5781
+ one of these connections asks the customer for a Seller Central or Vendor Central account
5782
+ for the chosen region and marketplace and a user who can complete Amazon's consent screen,
5783
+ nothing more. A customer who must run on their OWN developer registration builds a
5784
+ token-based or OAuth 2.0 universal HTTP connection to the Selling Partner API base URI
5785
+ instead (articles 6204088366363 and the OAuth 2.0 universal connector) and takes on
5786
+ Amazon's developer agreements themselves.
5763
5787
  examples:
5764
5788
  - Amazon-SP-API
5765
5789
  clientCertificates:
package/dist/enduser.yml CHANGED
@@ -3807,10 +3807,34 @@ components:
3807
3807
  - Amazon-Hybrid
3808
3808
  - vendor_central
3809
3809
  x-enumDescriptions:
3810
- Amazon-SP-API: Amazon Selling Partner API connection.
3811
- Amazon-Hybrid: Hybrid Amazon connection supporting both MWS and SP-API.
3812
- vendor_central: Amazon Vendor Central API connection.
3813
- description: Specific API type for Amazon integrations. Only set this for Amazon connections.
3810
+ Amazon-SP-API: Amazon Seller Central over the Selling Partner API, authorized against Celigo's registered application through Login with Amazon
3811
+ Amazon-Hybrid: Amazon Seller Central over both the legacy MWS and the Selling Partner API, for integrations not yet fully on SP-API
3812
+ vendor_central: Amazon Vendor Central over the Selling Partner API, authorized against Celigo's registered application through Login with Amazon
3813
+ description: |-
3814
+ Selects which Amazon selling program and API family a prebuilt Amazon connection talks to.
3815
+ Set by the Amazon Seller Central and Amazon Vendor Central connection forms; a custom
3816
+ Selling Partner API integration built on the customer's own developer application is a
3817
+ plain HTTP connection and does not carry this field.
3818
+ x-celigo-ai-guidance:
3819
+ - |-
3820
+ The prebuilt Amazon connection forms collect the API type, selling region and marketplace
3821
+ and save an OAuth 2.0 authorization-code connection (`http.auth.type` `oauth`,
3822
+ `http.auth.oauth.grantType` `authorizecode`, `useIClientFields` false) whose authorization
3823
+ URI is the Seller Central or Vendor Central `/apps/authorize/consent` page — Amazon's
3824
+ public-application consent, granted by the selling partner to Celigo's registered
3825
+ Selling Partner API application. Celigo's Seller Central documentation states the customer
3826
+ need not register as an Amazon developer (article 360060827012); the Vendor Central form
3827
+ carries no developer credentials either.
3828
+ - |-
3829
+ The prebuilt forms collect no Amazon developer application id, client secret, AWS
3830
+ credentials or iClient — the Vendor Central form has no iClient field, and the Seller
3831
+ Central form sets `http._iClientId` only for its legacy `Amazon-MWS` choice — so creating
3832
+ one of these connections asks the customer for a Seller Central or Vendor Central account
3833
+ for the chosen region and marketplace and a user who can complete Amazon's consent screen,
3834
+ nothing more. A customer who must run on their OWN developer registration builds a
3835
+ token-based or OAuth 2.0 universal HTTP connection to the Selling Partner API base URI
3836
+ instead (articles 6204088366363 and the OAuth 2.0 universal connector) and takes on
3837
+ Amazon's developer agreements themselves.
3814
3838
  examples:
3815
3839
  - Amazon-SP-API
3816
3840
  clientCertificates:
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
- Always set `type` on new Salesforce exports (`soql` or `distributed`) —
8029
- the form always writes it. It is absent only from legacy real-time
8030
- exports created before the field existed, and file/byId retrievals
8031
- (`id` + `sObjectType`, no `soql` object) carry `type: soql` without a
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 (type="distributed"):
8065
- Required fields: type, distributed configuration
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
- - REQUIRED for all Salesforce exports
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; required when `type` is `distributed` and not used otherwise. 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.
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:
@@ -5643,10 +5643,34 @@ components:
5643
5643
  - Amazon-Hybrid
5644
5644
  - vendor_central
5645
5645
  x-enumDescriptions:
5646
- Amazon-SP-API: Amazon Selling Partner API connection.
5647
- Amazon-Hybrid: Hybrid Amazon connection supporting both MWS and SP-API.
5648
- vendor_central: Amazon Vendor Central API connection.
5649
- description: Specific API type for Amazon integrations. Only set this for Amazon connections.
5646
+ Amazon-SP-API: Amazon Seller Central over the Selling Partner API, authorized against Celigo's registered application through Login with Amazon
5647
+ Amazon-Hybrid: Amazon Seller Central over both the legacy MWS and the Selling Partner API, for integrations not yet fully on SP-API
5648
+ vendor_central: Amazon Vendor Central over the Selling Partner API, authorized against Celigo's registered application through Login with Amazon
5649
+ description: |-
5650
+ Selects which Amazon selling program and API family a prebuilt Amazon connection talks to.
5651
+ Set by the Amazon Seller Central and Amazon Vendor Central connection forms; a custom
5652
+ Selling Partner API integration built on the customer's own developer application is a
5653
+ plain HTTP connection and does not carry this field.
5654
+ x-celigo-ai-guidance:
5655
+ - |-
5656
+ The prebuilt Amazon connection forms collect the API type, selling region and marketplace
5657
+ and save an OAuth 2.0 authorization-code connection (`http.auth.type` `oauth`,
5658
+ `http.auth.oauth.grantType` `authorizecode`, `useIClientFields` false) whose authorization
5659
+ URI is the Seller Central or Vendor Central `/apps/authorize/consent` page — Amazon's
5660
+ public-application consent, granted by the selling partner to Celigo's registered
5661
+ Selling Partner API application. Celigo's Seller Central documentation states the customer
5662
+ need not register as an Amazon developer (article 360060827012); the Vendor Central form
5663
+ carries no developer credentials either.
5664
+ - |-
5665
+ The prebuilt forms collect no Amazon developer application id, client secret, AWS
5666
+ credentials or iClient — the Vendor Central form has no iClient field, and the Seller
5667
+ Central form sets `http._iClientId` only for its legacy `Amazon-MWS` choice — so creating
5668
+ one of these connections asks the customer for a Seller Central or Vendor Central account
5669
+ for the chosen region and marketplace and a user who can complete Amazon's consent screen,
5670
+ nothing more. A customer who must run on their OWN developer registration builds a
5671
+ token-based or OAuth 2.0 universal HTTP connection to the Selling Partner API base URI
5672
+ instead (articles 6204088366363 and the OAuth 2.0 universal connector) and takes on
5673
+ Amazon's developer agreements themselves.
5650
5674
  examples:
5651
5675
  - Amazon-SP-API
5652
5676
  clientCertificates:
package/dist/tool.yml CHANGED
@@ -9177,10 +9177,34 @@ components:
9177
9177
  - Amazon-Hybrid
9178
9178
  - vendor_central
9179
9179
  x-enumDescriptions:
9180
- Amazon-SP-API: Amazon Selling Partner API connection.
9181
- Amazon-Hybrid: Hybrid Amazon connection supporting both MWS and SP-API.
9182
- vendor_central: Amazon Vendor Central API connection.
9183
- description: Specific API type for Amazon integrations. Only set this for Amazon connections.
9180
+ Amazon-SP-API: Amazon Seller Central over the Selling Partner API, authorized against Celigo's registered application through Login with Amazon
9181
+ Amazon-Hybrid: Amazon Seller Central over both the legacy MWS and the Selling Partner API, for integrations not yet fully on SP-API
9182
+ vendor_central: Amazon Vendor Central over the Selling Partner API, authorized against Celigo's registered application through Login with Amazon
9183
+ description: |-
9184
+ Selects which Amazon selling program and API family a prebuilt Amazon connection talks to.
9185
+ Set by the Amazon Seller Central and Amazon Vendor Central connection forms; a custom
9186
+ Selling Partner API integration built on the customer's own developer application is a
9187
+ plain HTTP connection and does not carry this field.
9188
+ x-celigo-ai-guidance:
9189
+ - |-
9190
+ The prebuilt Amazon connection forms collect the API type, selling region and marketplace
9191
+ and save an OAuth 2.0 authorization-code connection (`http.auth.type` `oauth`,
9192
+ `http.auth.oauth.grantType` `authorizecode`, `useIClientFields` false) whose authorization
9193
+ URI is the Seller Central or Vendor Central `/apps/authorize/consent` page — Amazon's
9194
+ public-application consent, granted by the selling partner to Celigo's registered
9195
+ Selling Partner API application. Celigo's Seller Central documentation states the customer
9196
+ need not register as an Amazon developer (article 360060827012); the Vendor Central form
9197
+ carries no developer credentials either.
9198
+ - |-
9199
+ The prebuilt forms collect no Amazon developer application id, client secret, AWS
9200
+ credentials or iClient — the Vendor Central form has no iClient field, and the Seller
9201
+ Central form sets `http._iClientId` only for its legacy `Amazon-MWS` choice — so creating
9202
+ one of these connections asks the customer for a Seller Central or Vendor Central account
9203
+ for the chosen region and marketplace and a user who can complete Amazon's consent screen,
9204
+ nothing more. A customer who must run on their OWN developer registration builds a
9205
+ token-based or OAuth 2.0 universal HTTP connection to the Selling Partner API base URI
9206
+ instead (articles 6204088366363 and the OAuth 2.0 universal connector) and takes on
9207
+ Amazon's developer agreements themselves.
9184
9208
  examples:
9185
9209
  - Amazon-SP-API
9186
9210
  clientCertificates:
@@ -33046,11 +33070,13 @@ components:
33046
33070
  It defines how data is extracted from Salesforce,
33047
33071
  either through queries or real-time events.
33048
33072
  - |-
33049
- Always set `type` on new Salesforce exports (`soql` or `distributed`) —
33050
- the form always writes it. It is absent only from legacy real-time
33051
- exports created before the field existed, and file/byId retrievals
33052
- (`id` + `sObjectType`, no `soql` object) carry `type: soql` without a
33053
- `soql` object.
33073
+ Set `type` on every Salesforce export you create (`soql` or `distributed`).
33074
+ Never read its absence on an existing export as a defect: a listener saved
33075
+ from the integrator.io form carries no `salesforce.type` and the platform
33076
+ fires it without the field, and file/byId retrievals (`id` + `sObjectType`,
33077
+ no `soql` object) carry `type: soql` without a `soql` object. A listener
33078
+ that never creates a job is diagnosed from `distributed` (below), not from
33079
+ this field.
33054
33080
  - |-
33055
33081
  ## SALESFORCE EXPORT MODES
33056
33082
 
@@ -33082,8 +33108,10 @@ components:
33082
33108
  Required fields: type, soql.query
33083
33109
  Optional fields: api, includeDeletedRecords, bulk (when api="bulk")
33084
33110
 
33085
- - For Distributed exports (type="distributed"):
33086
- Required fields: type, distributed configuration
33111
+ - For Distributed exports (real-time listeners):
33112
+ Set type="distributed" with the distributed object and sObjectType when creating one.
33113
+ A listener saved from the integrator.io form carries the distributed object and
33114
+ sObjectType with no type, and the platform fires it — a valid listener, not a missing field.
33087
33115
  Optional fields: distributed.referencedFields, distributed.qualifier
33088
33116
 
33089
33117
  - For Blob exports (when export.type="blob"):
@@ -33099,7 +33127,10 @@ components:
33099
33127
 
33100
33128
  This field determines the core operating mode of the Salesforce export:
33101
33129
 
33102
- - REQUIRED for all Salesforce exports
33130
+ - Set it on every Salesforce export you create; a listener saved from the
33131
+ integrator.io form carries none and the platform fires it without the
33132
+ field, so an absent `type` beside a `distributed` object is the normal
33133
+ shape of a form-saved listener, not a missing setting
33103
33134
  - Controls which additional configuration objects must be provided
33104
33135
  - Affects how the export appears and functions in the flow builder UI
33105
33136
  - Cannot be changed after creation without significant reconfiguration
@@ -33594,7 +33625,7 @@ components:
33594
33625
  - SELECT Id, Name, (SELECT Id, FirstName, LastName FROM Contacts) FROM Account
33595
33626
  distributed:
33596
33627
  type: object
33597
- description: Real-time listener configuration; required when `type` is `distributed` and not used otherwise. 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.
33628
+ 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
33629
  x-celigo-ai-guidance:
33599
33630
  - |-
33600
33631
  After creating a listener on a custom flow, relay what the Help Center's "Listen for real-time data
@@ -33609,6 +33640,12 @@ components:
33609
33640
  Help Center's trigger requirement in the connected org: an active Apex trigger on the object whose
33610
33641
  code calls `integrator_da__.RealTimeExporter`, and the Celigo package reachable through the
33611
33642
  connection (`GET /v1/connections/{_id}/distributed`, documented in this spec set).
33643
+ - |-
33644
+ Two things are never why a listener does not fire. The export preview cannot run a listener:
33645
+ it validates the body as a SOQL export and answers 422 `missing_required_field` for
33646
+ `soql.query` (and for `type` when the listener carries none) before the connection is used,
33647
+ so a failed preview is expected, not a configuration defect. And an absent `salesforce.type`
33648
+ is the normal shape of a listener saved from the integrator.io form (see `type`).
33612
33649
  properties:
33613
33650
  referencedFields:
33614
33651
  type:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@celigo/api-specs",
3
- "version": "0.2.178",
3
+ "version": "0.2.180",
4
4
  "private": false,
5
5
  "description": "Public OpenAPI bundles (dist/) and the celigo-cli lint schema pack (schemas.json).",
6
6
  "keywords": [
package/schemas.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "provenance": {
3
3
  "repo": "celigo/integrator-api-specs",
4
- "iasCommit": "d78b4324",
4
+ "iasCommit": "e36986cc",
5
5
  "generatedAt": "2026-10-22"
6
6
  },
7
7
  "roots": {