@fluentcommerce/fc-connect-sdk 0.1.52 → 0.1.53
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/CHANGELOG.md +514 -506
- package/README.md +13 -3
- package/dist/cjs/types/index.d.ts +1 -1
- package/dist/esm/types/index.d.ts +1 -1
- package/dist/tsconfig.esm.tsbuildinfo +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/dist/tsconfig.types.tsbuildinfo +1 -1
- package/dist/types/types/index.d.ts +1 -1
- package/docs/02-CORE-GUIDES/api-reference/event-api-input-output-reference.md +9 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1309,7 +1309,17 @@ if (logs.results[0]?.id) {
|
|
|
1309
1309
|
|
|
1310
1310
|
#### Query Parameters
|
|
1311
1311
|
|
|
1312
|
-
All parameters are optional. Context filters use
|
|
1312
|
+
All parameters are optional. Context filters use **dot-notation keys** which require quotes in JavaScript/TypeScript:
|
|
1313
|
+
|
|
1314
|
+
```typescript
|
|
1315
|
+
// ⚠️ Dot-notation keys MUST be quoted (JavaScript syntax requirement)
|
|
1316
|
+
await client.getEvents({
|
|
1317
|
+
'context.rootEntityType': 'ORDER', // ✅ Quotes required (has dot)
|
|
1318
|
+
'context.entityRef': 'ORD-123', // ✅ Quotes required (has dot)
|
|
1319
|
+
eventType: 'ORCHESTRATION_AUDIT', // ✅ No quotes needed (simple key)
|
|
1320
|
+
count: 100, // ✅ No quotes needed (simple key)
|
|
1321
|
+
});
|
|
1322
|
+
```
|
|
1313
1323
|
|
|
1314
1324
|
| Parameter | Type | Description | Example |
|
|
1315
1325
|
|-----------|------|-------------|---------|
|
|
@@ -1325,7 +1335,7 @@ All parameters are optional. Context filters use flat dot-notation keys:
|
|
|
1325
1335
|
| `category` | string | Category filter | `'ruleSet'`, `'ACTION'` |
|
|
1326
1336
|
| `from` | string | Start date (UTC ISO 8601) | `'2026-02-01T00:00:00.000Z'` |
|
|
1327
1337
|
| `to` | string | End date (UTC ISO 8601) | `'2026-02-15T23:59:59.999Z'` |
|
|
1328
|
-
| `retailerId` | string/number | Retailer filter (
|
|
1338
|
+
| `retailerId` | string/number | Retailer filter (pass explicitly; no auto-fallback) | `'5'` |
|
|
1329
1339
|
| `start` | number | Pagination offset (default: `0`) | `0` |
|
|
1330
1340
|
| `count` | number | Results per page (default: `100`, max: `5000`) | `1000` |
|
|
1331
1341
|
|
|
@@ -1418,7 +1428,7 @@ const orderEvents = await client.getEvents({
|
|
|
1418
1428
|
| **Time range (to)** | 1 month forward max | API rejects future dates beyond ~1 month |
|
|
1419
1429
|
| **Default time window** | Past 30 days | Applied when `from` is omitted |
|
|
1420
1430
|
| **Date format** | UTC ISO 8601 | `YYYY-MM-DDTHH:mm:ss.SSSZ` |
|
|
1421
|
-
| **retailerId
|
|
1431
|
+
| **retailerId** | Pass explicitly | Unlike `sendEvent()`, no auto-fallback to client config — pass in params if needed |
|
|
1422
1432
|
| **attributes field** | Nullable | Can be `null` (not empty array) — always check before iterating |
|
|
1423
1433
|
| **name field** | Nullable | Can be `null` for some system events |
|
|
1424
1434
|
| **GraphQL** | Not available | Event queries use REST only — no GraphQL `events` root field exists |
|