channex.activate
Flips a connection to active. Refuses while room types are unmapped: an active connection with holes pushes a partial rate set, and Channex answers partial payloads with a 200 plus warnings — silent drift. Mutation — changes data.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
connectionId | string | yes |
Output fields
Response shape not declared.
channex.channelManagerOverlap
Channex activation state (global flag + active connection).
Input parameters
Returns object.
Output fields
Response shape not declared.
channex.connect
Creates (or re-points) a connection. Verifies the property is reachable with the stored key before persisting — a connection row that was never confirmed against Channex is worse than no row at all, because the mapping UI would then offer an empty inventory with no explanation. Mutation — changes data.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
propertyId | string | yes | |
environment | enum | no | One of: staging, production — Default: "staging" |
Output fields
Response shape not declared.
channex.deleteMapping
Deletes a Channex mapping (Foyer room type or rate plan to a Channex id) by id and returns the number of deleted rows. Owner only. Changes data in Foyer; nothing is deleted at Channex itself. Mutation — changes data.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes |
Output fields
Response shape not declared.
channex.disable
Pauses without discarding the mapping — the usual rollback. Mutation — changes data.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
connectionId | string | yes |
Output fields
Response shape not declared.
channex.disconnect
Removes the connection and, by cascade, its mappings. Mutation — changes data.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
connectionId | string | yes |
Output fields
Response shape not declared.
channex.fullSync
Runs a full sync now: 500 days of availability, rates and restrictions in two calls (certification test 1). Operator-triggered, so it bypasses the 24h interval that test 13 requires of AUTOMATIC syncs — the point of that rule is to forbid timer-driven full syncs replacing deltas, not to stop a human from repairing drift. The rate-limit throttle still applies. Mutation — changes data.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
connectionId | string | yes |
Output fields
Response shape not declared.
channex.inventory
Live inventory for the mapping UI, alongside Foyer's own room types and rate plans so both sides can be shown next to each other. Read-only query.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
connectionId | string | yes |
Output fields
Response shape not declared.
channex.list
Connections plus the activation state. `globallyEnabled` is surfaced so the UI can explain why an "active" connection is still not pushing anything. Read-only query.
Input parameters
Returns object.
Output fields
Response shape not declared.
channex.listMappings
Lists the Channex mappings (room type or rate plan to Channex id) of a connection (connectionId). Owner only. Read-only.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
connectionId | string | yes |
Output fields
Response shape not declared.
channex.saveMapping
Upserts one mapping row. The kind/ratePlanId shape is validated here as well as by a CHECK constraint — the constraint is the guarantee, this is the readable error. Mutation — changes data.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
connectionId | string | yes | |
kind | enum | yes | One of: room_type, rate_plan |
foyerRoomType | string | yes | |
foyerRatePlanId | string | no | |
channexId | string | yes | |
parentChannexId | string | no |
Output fields
Response shape not declared.