@celigo/api-specs 0.2.49 → 0.2.51
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 +19 -46
- package/dist/subscription.yml +19 -7
- package/dist/tool.yml +19 -46
- package/package.json +1 -1
- package/schemas.json +1 -1
package/dist/export.yml
CHANGED
|
@@ -8455,60 +8455,33 @@ components:
|
|
|
8455
8455
|
type:
|
|
8456
8456
|
- string
|
|
8457
8457
|
- 'null'
|
|
8458
|
-
description:
|
|
8458
|
+
description: SOQL WHERE-clause condition that filters which record events the listener processes; when omitted (stored as `null`), every event for the object is processed. The Celigo Salesforce package evaluates it inside Salesforce as `SELECT Id FROM <sObjectType> WHERE (<qualifier>) AND Id IN :ids` before anything is sent, so only fields of the monitored object and SOQL comparison syntax apply — Salesforce formula functions are not part of this grammar. A deleted record is never returned by that query, so a listener with any qualifier receives no delete events; leave it unset when removals must trigger the flow.
|
|
8459
8459
|
x-celigo-ai-guidance:
|
|
8460
8460
|
- |-
|
|
8461
|
-
|
|
8462
|
-
|
|
8463
|
-
|
|
8464
|
-
|
|
8465
|
-
- OPTIONAL: If omitted, all events for the object are processed
|
|
8466
|
-
- Uses Salesforce formula syntax for filtering
|
|
8467
|
-
- Evaluated before events are sent to the integration platform
|
|
8468
|
-
- Can reference any field on the triggering record
|
|
8461
|
+
Write SOQL WHERE syntax only: `field = value`, `!=`, `<`, `>`, `<=`, `>=`, `LIKE`,
|
|
8462
|
+
`IN (...)`, `AND` / `OR`, parentheses for grouping, `NOT ( <comparison> )`, and
|
|
8463
|
+
lowercase `true` / `false` literals.
|
|
8469
8464
|
- |-
|
|
8470
|
-
|
|
8471
|
-
|
|
8472
|
-
|
|
8473
|
-
|
|
8474
|
-
"Status__c = 'Approved'"
|
|
8475
|
-
```
|
|
8476
|
-
- Processes events only when specific field values match
|
|
8477
|
-
- Most efficient filtering approach
|
|
8478
|
-
- Can use =, !=, >, <, >=, <= operators
|
|
8479
|
-
|
|
8480
|
-
### Logical Conditions
|
|
8481
|
-
```
|
|
8482
|
-
"Amount > 1000 AND Status__c = 'New'"
|
|
8483
|
-
```
|
|
8484
|
-
- Combines multiple conditions with AND, OR operators
|
|
8485
|
-
- Can use parentheses for complex grouping
|
|
8486
|
-
- Allows precise control over which events trigger the integration
|
|
8487
|
-
|
|
8488
|
-
### Formula Functions
|
|
8489
|
-
```
|
|
8490
|
-
"CONTAINS(Description, 'Priority') OR ISCHANGED(Status__c)"
|
|
8491
|
-
```
|
|
8492
|
-
- Uses Salesforce formula functions
|
|
8493
|
-
- ISCHANGED detects specific field modifications
|
|
8494
|
-
- ISNEW, ISDELETED detect record lifecycle events
|
|
8465
|
+
Formula syntax is rejected at save with HTTP 422 `Either whereClause expression ...
|
|
8466
|
+
is invalid ... unexpected token` — observed for `AND(a, b)` argument lists,
|
|
8467
|
+
`NOT(field)` on a bare boolean, `NOT(ISNEW())`, `ISDELETED()`, and `ISBLANK(field)`;
|
|
8468
|
+
uppercase `= FALSE` has been rewritten to `NOT(field)` and rejected the same way.
|
|
8495
8469
|
- |-
|
|
8496
|
-
|
|
8497
|
-
|
|
8498
|
-
|
|
8499
|
-
|
|
8500
|
-
|
|
8501
|
-
|
|
8502
|
-
|
|
8503
|
-
|
|
8504
|
-
|
|
8505
|
-
Use valid Salesforce formula syntax and reference only fields that exist
|
|
8506
|
-
on the primary object being monitored.
|
|
8470
|
+
The rejection surfaces on a real save (a create, or the user's Accept of a staged
|
|
8471
|
+
update) — dry-run validation does not run the Salesforce-side check, so a staged
|
|
8472
|
+
card carrying an invalid qualifier passes dry-run and fails at Accept.
|
|
8473
|
+
- |-
|
|
8474
|
+
`IsDeleted = true` in a qualifier admits nothing — the query runs against the live
|
|
8475
|
+
record, which no longer exists after a delete, so any qualified listener stops
|
|
8476
|
+
receiving deletions. To keep deletes flowing, leave the qualifier unset and drop
|
|
8477
|
+
unwanted events with the export's output filter, accepting that those events still
|
|
8478
|
+
start a run.
|
|
8507
8479
|
examples:
|
|
8508
8480
|
- Amount > 1000
|
|
8509
8481
|
- Status__c = 'Approved'
|
|
8510
8482
|
- LeadSource = 'Web' AND Competitor__c = 'Oracle'
|
|
8511
|
-
-
|
|
8483
|
+
- IsDirect = false
|
|
8484
|
+
- StageName = 'Won' AND ( NOT ( Unresolved_Errors__c >= 1 ) )
|
|
8512
8485
|
batchSize:
|
|
8513
8486
|
type:
|
|
8514
8487
|
- integer
|
package/dist/subscription.yml
CHANGED
|
@@ -1062,31 +1062,43 @@ components:
|
|
|
1062
1062
|
example: POC – HubSpot → Snowflake
|
|
1063
1063
|
EndpointUsage:
|
|
1064
1064
|
type: object
|
|
1065
|
-
description:
|
|
1065
|
+
description: |-
|
|
1066
|
+
Endpoint entitlement usage for the requesting environment. An endpoint is a connected
|
|
1067
|
+
application, not a connection record: connections that share a Celigo-managed application
|
|
1068
|
+
profile (`assistant`) are one endpoint, generic HTTP connections without one are grouped by
|
|
1069
|
+
`baseURI`, databases by `rdbms` engine and host, and other adaptor types by their own connection
|
|
1070
|
+
identity (for example host and port). Each `endpoints[]` entry carries the fields it was grouped by.
|
|
1066
1071
|
properties:
|
|
1067
1072
|
numConsumed:
|
|
1068
1073
|
type: integer
|
|
1069
|
-
description:
|
|
1074
|
+
description: |-
|
|
1075
|
+
Endpoints counted against the entitlement in the requesting environment, one per distinct
|
|
1076
|
+
endpoint (see `endpoints`). Which flows bring an endpoint into the count follows the account's
|
|
1077
|
+
pricing model, as for `flowUsage.numEnabled`: flows that are enabled on plans that meter
|
|
1078
|
+
enabled resources, flows that ran in the billing period on plans that meter runs.
|
|
1079
|
+
x-celigo-ai-guidance:
|
|
1080
|
+
- Read the account license before interpreting this number. On run-metered plans an endpoint whose flows are enabled but have not run this period is not counted, and one used by a flow that ran even once counts for the whole period; on enabled-metered plans it is counted while any enabled flow references one of its connections, run or not.
|
|
1081
|
+
- Connections referenced by no flow are never counted, and connections to the platform's own API (`api.integrator.io`) never count. On enabled-metered plans a connection referenced only by disabled flows is not counted; on run-metered plans an endpoint used by a flow that ran this period stays counted for the period even if that flow is disabled afterwards.
|
|
1070
1082
|
example: 8
|
|
1071
1083
|
endpoints:
|
|
1072
1084
|
type: array
|
|
1073
|
-
description:
|
|
1085
|
+
description: The endpoints being counted, each with the connections that roll up into it.
|
|
1086
|
+
x-celigo-ai-guidance:
|
|
1087
|
+
- Two generic HTTP connections to the same application through different base URIs (a second store, a different API version in the path) are two endpoints; to explain an unexpected count, read each entry's `connections` and name the connection that carries the extra endpoint.
|
|
1074
1088
|
items:
|
|
1075
1089
|
type: object
|
|
1076
1090
|
properties:
|
|
1077
1091
|
type:
|
|
1078
1092
|
type: string
|
|
1079
1093
|
description: Endpoint adaptor type (e.g., `http`, `rdbms`, `ftp`).
|
|
1080
|
-
x-celigo-ai-guidance:
|
|
1081
|
-
- Endpoint type/category.
|
|
1082
1094
|
example: http
|
|
1083
1095
|
assistant:
|
|
1084
1096
|
type: string
|
|
1085
|
-
description: Application assistant identifier, if the connection uses a Celigo-managed application profile (e.g., `hubspot`, `netsuite`).
|
|
1097
|
+
description: Application assistant identifier, if the connection uses a Celigo-managed application profile (e.g., `hubspot`, `netsuite`). Connections sharing an assistant are one endpoint.
|
|
1086
1098
|
example: hubspot
|
|
1087
1099
|
baseURI:
|
|
1088
1100
|
type: string
|
|
1089
|
-
description: Base URI
|
|
1101
|
+
description: Base URI that identifies this endpoint for generic HTTP connections (those without an `assistant`); connections whose base URIs differ are separate endpoints.
|
|
1090
1102
|
example: https://api.hubspot.com
|
|
1091
1103
|
rdbms:
|
|
1092
1104
|
type: object
|
package/dist/tool.yml
CHANGED
|
@@ -31411,60 +31411,33 @@ components:
|
|
|
31411
31411
|
type:
|
|
31412
31412
|
- string
|
|
31413
31413
|
- 'null'
|
|
31414
|
-
description:
|
|
31414
|
+
description: SOQL WHERE-clause condition that filters which record events the listener processes; when omitted (stored as `null`), every event for the object is processed. The Celigo Salesforce package evaluates it inside Salesforce as `SELECT Id FROM <sObjectType> WHERE (<qualifier>) AND Id IN :ids` before anything is sent, so only fields of the monitored object and SOQL comparison syntax apply — Salesforce formula functions are not part of this grammar. A deleted record is never returned by that query, so a listener with any qualifier receives no delete events; leave it unset when removals must trigger the flow.
|
|
31415
31415
|
x-celigo-ai-guidance:
|
|
31416
31416
|
- |-
|
|
31417
|
-
|
|
31418
|
-
|
|
31419
|
-
|
|
31420
|
-
|
|
31421
|
-
- OPTIONAL: If omitted, all events for the object are processed
|
|
31422
|
-
- Uses Salesforce formula syntax for filtering
|
|
31423
|
-
- Evaluated before events are sent to the integration platform
|
|
31424
|
-
- Can reference any field on the triggering record
|
|
31417
|
+
Write SOQL WHERE syntax only: `field = value`, `!=`, `<`, `>`, `<=`, `>=`, `LIKE`,
|
|
31418
|
+
`IN (...)`, `AND` / `OR`, parentheses for grouping, `NOT ( <comparison> )`, and
|
|
31419
|
+
lowercase `true` / `false` literals.
|
|
31425
31420
|
- |-
|
|
31426
|
-
|
|
31427
|
-
|
|
31428
|
-
|
|
31429
|
-
|
|
31430
|
-
"Status__c = 'Approved'"
|
|
31431
|
-
```
|
|
31432
|
-
- Processes events only when specific field values match
|
|
31433
|
-
- Most efficient filtering approach
|
|
31434
|
-
- Can use =, !=, >, <, >=, <= operators
|
|
31435
|
-
|
|
31436
|
-
### Logical Conditions
|
|
31437
|
-
```
|
|
31438
|
-
"Amount > 1000 AND Status__c = 'New'"
|
|
31439
|
-
```
|
|
31440
|
-
- Combines multiple conditions with AND, OR operators
|
|
31441
|
-
- Can use parentheses for complex grouping
|
|
31442
|
-
- Allows precise control over which events trigger the integration
|
|
31443
|
-
|
|
31444
|
-
### Formula Functions
|
|
31445
|
-
```
|
|
31446
|
-
"CONTAINS(Description, 'Priority') OR ISCHANGED(Status__c)"
|
|
31447
|
-
```
|
|
31448
|
-
- Uses Salesforce formula functions
|
|
31449
|
-
- ISCHANGED detects specific field modifications
|
|
31450
|
-
- ISNEW, ISDELETED detect record lifecycle events
|
|
31421
|
+
Formula syntax is rejected at save with HTTP 422 `Either whereClause expression ...
|
|
31422
|
+
is invalid ... unexpected token` — observed for `AND(a, b)` argument lists,
|
|
31423
|
+
`NOT(field)` on a bare boolean, `NOT(ISNEW())`, `ISDELETED()`, and `ISBLANK(field)`;
|
|
31424
|
+
uppercase `= FALSE` has been rewritten to `NOT(field)` and rejected the same way.
|
|
31451
31425
|
- |-
|
|
31452
|
-
|
|
31453
|
-
|
|
31454
|
-
|
|
31455
|
-
|
|
31456
|
-
|
|
31457
|
-
|
|
31458
|
-
|
|
31459
|
-
|
|
31460
|
-
|
|
31461
|
-
Use valid Salesforce formula syntax and reference only fields that exist
|
|
31462
|
-
on the primary object being monitored.
|
|
31426
|
+
The rejection surfaces on a real save (a create, or the user's Accept of a staged
|
|
31427
|
+
update) — dry-run validation does not run the Salesforce-side check, so a staged
|
|
31428
|
+
card carrying an invalid qualifier passes dry-run and fails at Accept.
|
|
31429
|
+
- |-
|
|
31430
|
+
`IsDeleted = true` in a qualifier admits nothing — the query runs against the live
|
|
31431
|
+
record, which no longer exists after a delete, so any qualified listener stops
|
|
31432
|
+
receiving deletions. To keep deletes flowing, leave the qualifier unset and drop
|
|
31433
|
+
unwanted events with the export's output filter, accepting that those events still
|
|
31434
|
+
start a run.
|
|
31463
31435
|
examples:
|
|
31464
31436
|
- Amount > 1000
|
|
31465
31437
|
- Status__c = 'Approved'
|
|
31466
31438
|
- LeadSource = 'Web' AND Competitor__c = 'Oracle'
|
|
31467
|
-
-
|
|
31439
|
+
- IsDirect = false
|
|
31440
|
+
- StageName = 'Won' AND ( NOT ( Unresolved_Errors__c >= 1 ) )
|
|
31468
31441
|
batchSize:
|
|
31469
31442
|
type:
|
|
31470
31443
|
- integer
|
package/package.json
CHANGED