Contract v1 · generated reference

PartnerDataPort.setBlackout

OP-PARTNERDATA-SET-BLACKOUT is a callable operation owned by Partner.

Authority and transport

Actor: active partner member
Authentication: required
Authorization: role and active organization membership
Resource boundary: server-derived organization
Transport: CALLABLE
Deployed export: blackoutSet
App Check: REQUIRED
Canonical source: packages/backend/src/partner.ts

Request schema

Request parameters for PartnerDataPort.setBlackout
Field	Required	Schema
`listingId`	Yes	`string`
`date`	Yes	`string`
`blackout`	Yes	`boolean`
`i`	Yes	`Idempotent`

Response schema

Promise<AvailabilityDay>

States, consistency and recovery

State path: IDLE → VALIDATING → VALIDATION_ERROR → AUTHENTICATION_OR_AUTHORIZATION_REQUIRED → PROCESSING → CONFLICT_OR_EXPIRED → UNAVAILABLE_OR_OFFLINE → RATE_LIMITED → SERVER_ERROR → RETRYING → AUTHORITATIVE_SUCCESS_OR_RECOVERY → NOT_FOUND
Reads: server command preconditions
Writes: Functions handler; server-authoritative mutation
Transaction: deployed Functions handler and its documented persistence boundary
Idempotency: required; reuse the key only for the same intent
Concurrency: idempotency fingerprint and server transaction
Retry/replay: retry with the same key and identical payload
Rate limits: The typed port does not ratify a public numeric quota; enforcement may be stricter. Honor RATE_LIMITED and any retry-after value returned by the server.
Audit: server audit/outbox where the command is consequential

Error contract

BackendErrorCode is the shared adapter envelope; source does not declare that every code is reachable from this method. Never treat an unknown error as success.

UNAUTHENTICATED
PERMISSION_DENIED
NOT_FOUND
CONFLICT
UNAVAILABLE
INVALID_ARGUMENT
NOT_IMPLEMENTED
RATE_LIMITED
EXPIRED
STEP_UP_REQUIRED
COMMERCIAL_AUTHORITY_PENDING

Producer test references

Evidence tier: SEMANTIC_CORE_REFERENCE.

Reviewer-mapped semantic/core references

packages/backend-firebase/test/operation-contracts.test.mjs

Protocol or inventory references

packages/backend-firebase/test/operation-contract-detector.mjs

These references prove export, wrapper or protocol behavior only. They are not counted as complete operation semantics.

Example availability

UNRESOLVED_WIRE_SCHEMA: The typed port signature does not prove the deployed callable's exact req.data wire object; publish an example only after producer schema evidence closes that mapping.

Common integration contract

Sandbox and Production are isolated

Run examples only in a governed sandbox or local emulator. Sandbox identities, App Check tokens, payment fixtures and data do not grant Production access. The typed ports do not ratify a public numeric quota; enforcement may be stricter. Honor RATE_LIMITED and the server's retry-after value.

Authentication and authorization

Firebase Auth proves identity. App Check proves the approved app where a callable requires it. Roles, organization membership, requester identity and resource ownership are derived and rechecked by the server.

Authentication guide

Errors and recovery

Stable error codes distinguish validation, denial, conflict, expiry, authority pending, rate limiting and temporary unavailability. Never infer success from an HTTP redirect or a browser state.

Error catalogue

Idempotency, concurrency and retry

Reuse an idempotency key only for an identical retry. A new intent needs a new key. Preserve version preconditions and reload after a conflict.

Retry guidance

Changes and escalation

Check compatibility before adopting a new contract version. Review the changelog, service status and support guidance before retrying a persistent failure.

Changelog Service status Developer support

Common failure families
Family	Client decision
Authentication / authorization	Refresh or step up only when instructed; do not retry a denial unchanged.
Validation / conflict / expiry	Correct or reload state, then obtain confirmation for a new intent.
Rate limited / unavailable	Honor retry-after and use bounded backoff; inspect service status.
Unknown / server	Fail closed and escalate with a privacy-safe correlation id.

Executable network examples are published only when the exact wire schema is producer-proven. Check the selected operation's example-availability status; an unresolved schema is a release blocker, not permission to guess.

Verified examples and local-only recovery snippets