Contract v1 · generated reference
API reference
125 operations across 9 canonical ports and runtime-only handlers.
Transport and deployability are derived independently. A callable is listed only when the Functions barrel exports it; a port method without a callable remains documented as its actual SDK/rules path rather than being promoted to a phantom endpoint.
| Operation | Owner | Transport | Producer proof |
|---|---|---|---|
| AdminDataPort.annotate | Admin | CALLABLE | 1 semantic/core reference(s) |
| AdminDataPort.approvePending | Admin | CALLABLE | 1 semantic/core reference(s) |
| AdminDataPort.decide | Admin | CALLABLE | 1 semantic/core reference(s) |
| AdminDataPort.fulfilPrivacyRequest | Admin | CALLABLE | 1 semantic/core reference(s) |
| AdminDataPort.getCase | Admin | FIRESTORE_RULES_OR_SDK | 1 semantic/core reference(s) |
| AdminDataPort.getCommercialHealth | Admin | CALLABLE | 1 semantic/core reference(s) |
| AdminDataPort.getStaffProfile | Admin | FIRESTORE_RULES_OR_SDK | 1 semantic/core reference(s) |
| AdminDataPort.issueRefund | Admin | CALLABLE | 1 semantic/core reference(s) |
| AdminDataPort.listFailedJobs | Admin | FIRESTORE_RULES_OR_SDK | 1 semantic/core reference(s) |
| AdminDataPort.listIncidents | Admin | FIRESTORE_RULES_OR_SDK | 1 semantic/core reference(s) |
| AdminDataPort.listQueue | Admin | FIRESTORE_RULES_OR_SDK | 1 semantic/core reference(s) |
| AdminDataPort.listReleases | Admin | FIRESTORE_RULES_OR_SDK | 1 semantic/core reference(s) |
| AdminDataPort.listWebhookEvents | Admin | FIRESTORE_RULES_OR_SDK | 1 semantic/core reference(s) |
| AdminDataPort.replayWebhookEvent | Admin | CALLABLE | 1 semantic/core reference(s) |
| AdminDataPort.retryFailedJob | Admin | CALLABLE | 1 semantic/core reference(s) |
| AdminDataPort.retryPayout | Admin | CALLABLE | 1 semantic/core reference(s) |
| AdminDataPort.revealSubject | Admin | CALLABLE | 1 semantic/core reference(s) |
| AdminDataPort.searchAudit | Admin | FIRESTORE_RULES_OR_SDK | 1 semantic/core reference(s) |
| AdminDataPort.setAccountRestriction | Admin | CALLABLE | 1 semantic/core reference(s) |
| AdminDataPort.startStepUp | Admin | CALLABLE | 1 semantic/core reference(s) |
| AuthPort.completeSignIn | Corporate | FIREBASE_AUTH_SDK | 1 semantic/core reference(s) |
| AuthPort.isSignInLink | Corporate | FIREBASE_AUTH_SDK | 1 semantic/core reference(s) |
| AuthPort.onAuthStateChanged | Corporate | FIREBASE_AUTH_SDK | 1 semantic/core reference(s) |
| AuthPort.requestSignInLink | Corporate | FIREBASE_AUTH_SDK | 1 semantic/core reference(s) |
| AuthPort.signOut | Corporate | FIREBASE_AUTH_SDK | 1 semantic/core reference(s) |
| CorporateDataPort.submitIntake | Corporate | CALLABLE | 3 semantic/core reference(s) |
| CorporateDataPort.submitWaitlist | Corporate | CALLABLE | 3 semantic/core reference(s) |
| DataPort.createAccount | Corporate | FIRESTORE_RULES_OR_SDK | 1 semantic/core reference(s) |
| DataPort.getAccount | Corporate | FIRESTORE_RULES_OR_SDK | 1 semantic/core reference(s) |
| DataPort.getMemberProfile | Corporate | FIRESTORE_RULES_OR_SDK | 1 semantic/core reference(s) |
| DataPort.getPartnerProfile | Corporate | FIRESTORE_RULES_OR_SDK | 1 semantic/core reference(s) |
| DataPort.listPartnerDrafts | Corporate | FIRESTORE_RULES_OR_SDK | 1 semantic/core reference(s) |
| DataPort.markOnboardingCompleted | Corporate | FIRESTORE_RULES_OR_SDK | 1 semantic/core reference(s) |
| DataPort.saveMemberProfile | Corporate | FIRESTORE_RULES_OR_SDK | 1 semantic/core reference(s) |
| DataPort.savePartnerDraft | Corporate | FIRESTORE_RULES_OR_SDK | 1 semantic/core reference(s) |
| DataPort.savePartnerProfile | Corporate | FIRESTORE_RULES_OR_SDK | 1 semantic/core reference(s) |
| FederatedAuthPort.availableProviders | Traveler + Partner | FIREBASE_AUTH_SDK | 1 semantic/core reference(s) |
| FederatedAuthPort.completeRedirectSignIn | Traveler + Partner | FIREBASE_AUTH_SDK | 1 semantic/core reference(s) |
| FederatedAuthPort.linkProvider | Traveler + Partner | FIREBASE_AUTH_SDK | 1 semantic/core reference(s) |
| FederatedAuthPort.linkedProviders | Traveler + Partner | FIREBASE_AUTH_SDK | 1 semantic/core reference(s) |
| FederatedAuthPort.signInWithProvider | Traveler + Partner | FIREBASE_AUTH_SDK | 1 semantic/core reference(s) |
| FederatedAuthPort.unlinkProvider | Traveler + Partner | FIREBASE_AUTH_SDK | 1 semantic/core reference(s) |
| PartnerDataPort.createListing | Partner | CALLABLE | 1 semantic/core reference(s) |
| PartnerDataPort.getAvailability | Partner | FIRESTORE_RULES_OR_SDK | 1 semantic/core reference(s) |
| PartnerDataPort.getBooking | Partner | FIRESTORE_RULES_OR_SDK | 1 semantic/core reference(s) |
| PartnerDataPort.getEarnings | Partner | FIRESTORE_RULES_OR_SDK | 1 semantic/core reference(s) |
| PartnerDataPort.getListing | Partner | FIRESTORE_RULES_OR_SDK | 1 semantic/core reference(s) |
| PartnerDataPort.getOnboarding | Partner | FIRESTORE_RULES_OR_SDK | 1 semantic/core reference(s) |
| PartnerDataPort.getOrganization | Partner | FIRESTORE_RULES_OR_SDK | 1 semantic/core reference(s) |
| PartnerDataPort.inviteTeamMember | Partner | CALLABLE | 1 semantic/core reference(s) |
| PartnerDataPort.listBookings | Partner | FIRESTORE_RULES_OR_SDK | 1 semantic/core reference(s) |
| PartnerDataPort.listListings | Partner | FIRESTORE_RULES_OR_SDK | 1 semantic/core reference(s) |
| PartnerDataPort.listPayouts | Partner | FIRESTORE_RULES_OR_SDK | 1 semantic/core reference(s) |
| PartnerDataPort.listQuoteRequests | Partner | FIRESTORE_RULES_OR_SDK | 1 semantic/core reference(s) |
| PartnerDataPort.listTeam | Partner | FIRESTORE_RULES_OR_SDK | 1 semantic/core reference(s) |
| PartnerDataPort.publicationBlockers | Partner | CALLABLE | 1 semantic/core reference(s) |
| PartnerDataPort.publishListing | Partner | CALLABLE | 1 semantic/core reference(s) |
| PartnerDataPort.reportDisruption | Partner | CALLABLE | 1 semantic/core reference(s) |
| PartnerDataPort.setBlackout | Partner | CALLABLE | 1 semantic/core reference(s) |
| PartnerDataPort.setCapacity | Partner | CALLABLE | 1 semantic/core reference(s) |
| PartnerDataPort.startPayoutOnboarding | Partner | CALLABLE | 1 semantic/core reference(s) |
| PartnerDataPort.submitBusinessDetails | Partner | CALLABLE | 1 semantic/core reference(s) |
| PartnerDataPort.updateListing | Partner | CALLABLE | 1 semantic/core reference(s) |
| PasswordAuthPort.applyEmailVerification | Traveler + Partner | FIREBASE_AUTH_SDK | 1 semantic/core reference(s) |
| PasswordAuthPort.assuranceLevel | Traveler + Partner | FIREBASE_AUTH_SDK | 1 semantic/core reference(s) |
| PasswordAuthPort.confirmPasswordReset | Traveler + Partner | FIREBASE_AUTH_SDK | 1 semantic/core reference(s) |
| PasswordAuthPort.isEmailVerified | Traveler + Partner | FIREBASE_AUTH_SDK | 1 semantic/core reference(s) |
| PasswordAuthPort.listSessions | Traveler + Partner | CALLABLE | 1 semantic/core reference(s) |
| PasswordAuthPort.reauthenticate | Traveler + Partner | FIREBASE_AUTH_SDK | 1 semantic/core reference(s) |
| PasswordAuthPort.register | Traveler + Partner | FIREBASE_AUTH_AND_CALLABLE | 1 semantic/core reference(s) |
| PasswordAuthPort.revokeAllSessions | Traveler + Partner | CALLABLE | 1 semantic/core reference(s) |
| PasswordAuthPort.sendEmailVerification | Traveler + Partner | FIREBASE_AUTH_SDK | 1 semantic/core reference(s) |
| PasswordAuthPort.sendPasswordReset | Traveler + Partner | FIREBASE_AUTH_SDK | 1 semantic/core reference(s) |
| PasswordAuthPort.signInWithPassword | Traveler + Partner | FIREBASE_AUTH_AND_CALLABLE | 1 semantic/core reference(s) |
| RuntimeHandler.holdsExpirySweep | Traveler | SCHEDULED | 1 semantic/core reference(s) |
| RuntimeHandler.paymentsExpirySweep | Traveler | SCHEDULED | 1 semantic/core reference(s) |
| RuntimeHandler.paymentsWebhook | Traveler | WEBHOOK | 3 semantic/core reference(s) |
| RuntimeHandler.waitlist | Corporate | HTTP_COMPATIBILITY | 3 semantic/core reference(s) |
| SupportDataPort.getArticle | Support | FIRESTORE_RULES_OR_SDK | 1 semantic/core reference(s) |
| SupportDataPort.getMyRequest | Support | FIRESTORE_RULES_OR_CALLABLE | 2 semantic/core reference(s) |
| SupportDataPort.listArticles | Support | FIRESTORE_RULES_OR_SDK | 1 semantic/core reference(s) |
| SupportDataPort.listMyRequests | Support | FIRESTORE_RULES_OR_SDK | 1 semantic/core reference(s) |
| SupportDataPort.listServiceUpdates | Support | FIRESTORE_RULES_OR_SDK | 1 semantic/core reference(s) |
| SupportDataPort.replyToRequest | Support | CALLABLE | 2 semantic/core reference(s) |
| SupportDataPort.searchArticles | Support | FIRESTORE_RULES_OR_SDK | 1 semantic/core reference(s) |
| SupportDataPort.submitAccountDeletion | Support | CALLABLE | 1 semantic/core reference(s) |
| SupportDataPort.submitPrivacyRequest | Support | CALLABLE | 2 semantic/core reference(s) |
| SupportDataPort.submitRequest | Support | CALLABLE | 2 semantic/core reference(s) |
| TravelerDataPort.acceptGroupInvite | Traveler | CALLABLE | 1 semantic/core reference(s) |
| TravelerDataPort.createGroup | Traveler | CALLABLE | 1 semantic/core reference(s) |
| TravelerDataPort.createGroupPoll | Traveler | CALLABLE | 1 semantic/core reference(s) |
| TravelerDataPort.discover | Traveler | CALLABLE | 1 semantic/core reference(s) |
| TravelerDataPort.getBooking | Traveler | FIRESTORE_RULES_OR_SDK | 1 semantic/core reference(s) |
| TravelerDataPort.getExperience | Traveler | CALLABLE | 1 semantic/core reference(s) |
| TravelerDataPort.getGroup | Traveler | CALLABLE | 1 semantic/core reference(s) |
| TravelerDataPort.getGroupDecision | Traveler | CALLABLE | 1 semantic/core reference(s) |
| TravelerDataPort.getGroupDecisionSummary | Traveler | CALLABLE | 1 semantic/core reference(s) |
| TravelerDataPort.getGroupShare | Traveler | CALLABLE | 1 semantic/core reference(s) |
| TravelerDataPort.getHold | Traveler | FIRESTORE_RULES_OR_SDK | 1 semantic/core reference(s) |
| TravelerDataPort.getQuote | Traveler | FIRESTORE_RULES_OR_SDK | 1 semantic/core reference(s) |
| TravelerDataPort.inviteParticipant | Traveler | CALLABLE | 1 semantic/core reference(s) |
| TravelerDataPort.listBookings | Traveler | FIRESTORE_RULES_OR_SDK | 1 semantic/core reference(s) |
| TravelerDataPort.listGroupInvites | Traveler | CALLABLE | 1 semantic/core reference(s) |
| TravelerDataPort.listGroupMessages | Traveler | CALLABLE | 1 semantic/core reference(s) |
| TravelerDataPort.listGroupPolls | Traveler | CALLABLE | 1 semantic/core reference(s) |
| TravelerDataPort.listGroups | Traveler | CALLABLE | 1 semantic/core reference(s) |
| TravelerDataPort.listNotifications | Traveler | FIRESTORE_RULES_OR_SDK | 1 semantic/core reference(s) |
| TravelerDataPort.listParticipants | Traveler | CALLABLE | 1 semantic/core reference(s) |
| TravelerDataPort.listSaved | Traveler | CALLABLE | 1 semantic/core reference(s) |
| TravelerDataPort.markNotificationRead | Traveler | FIRESTORE_RULES_OR_SDK | 1 semantic/core reference(s) |
| TravelerDataPort.placeHold | Traveler | CALLABLE | 1 semantic/core reference(s) |
| TravelerDataPort.requestCancellation | Traveler | CALLABLE | 1 semantic/core reference(s) |
| TravelerDataPort.requestGroupSharePayment | Traveler | CALLABLE | 1 semantic/core reference(s) |
| TravelerDataPort.requestQuote | Traveler | CALLABLE | 1 semantic/core reference(s) |
| TravelerDataPort.requestRefund | Traveler | CALLABLE | 1 semantic/core reference(s) |
| TravelerDataPort.requestReschedule | Traveler | CALLABLE | 1 semantic/core reference(s) |
| TravelerDataPort.resolveCheckout | Traveler | CALLABLE | 1 semantic/core reference(s) |
| TravelerDataPort.search | Traveler | CALLABLE | 1 semantic/core reference(s) |
| TravelerDataPort.sendGroupMessage | Traveler | CALLABLE | 1 semantic/core reference(s) |
| TravelerDataPort.setGroupDecision | Traveler | CALLABLE | 1 semantic/core reference(s) |
| TravelerDataPort.startCheckout | Traveler | CALLABLE | 1 semantic/core reference(s) |
| TravelerDataPort.submitReview | Traveler | CALLABLE | 1 semantic/core reference(s) |
| TravelerDataPort.submitSafetyReport | Traveler | CALLABLE | 1 semantic/core reference(s) |
| TravelerDataPort.toggleSaved | Traveler | FIRESTORE_RULES_OR_SDK | 1 semantic/core reference(s) |
| TravelerDataPort.voteGroupPoll | Traveler | CALLABLE | 1 semantic/core reference(s) |
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 guideErrors 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 catalogueIdempotency, 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 guidanceChanges and escalation
Check compatibility before adopting a new contract version. Review the changelog, service status and support guidance before retrying a persistent failure.
| 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