@propertysimple/client 0.1.0

package/contracts/src/routes.d.ts

@@ -0,0 +1,437 @@
+import type { Operation } from './schemas.js';
+export interface RouteDefinition {
+    method: 'GET' | 'POST';
+    path: string;
+    operation: Operation;
+    scope?: string;
+    status?: number;
+    summary: string;
+    /** POST search requests carry a JSON query but do not mutate or reserve work. */
+    readOnly?: boolean;
+}
+/** Keep HTTP/SDK/OpenAPI paths together so a renamed endpoint cannot strand consumers. */
+export declare const routes: readonly [{
+    readonly method: "GET";
+    readonly path: "/v1/search/features";
+    readonly operation: "searchFeatures";
+    readonly scope: "catalog:read";
+    readonly summary: "Read typed feature definitions and supported search operators.";
+}, {
+    readonly method: "POST";
+    readonly path: "/v1/search/listings";
+    readonly operation: "searchListings";
+    readonly scope: "catalog:read";
+    readonly readOnly: true;
+    readonly summary: "Search current inventory with typed hard constraints and evidence.";
+}, {
+    readonly method: "POST";
+    readonly path: "/v1/search/facets";
+    readonly operation: "searchFacets";
+    readonly scope: "catalog:read";
+    readonly readOnly: true;
+    readonly summary: "Read authorized refinement counts for the same normalized search.";
+}, {
+    readonly method: "POST";
+    readonly path: "/v1/search/map";
+    readonly operation: "searchMap";
+    readonly scope: "catalog:read";
+    readonly readOnly: true;
+    readonly summary: "Read bounded map points and clusters with matching search semantics.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/search/suggest";
+    readonly operation: "searchSuggest";
+    readonly scope: "catalog:read";
+    readonly summary: "Suggest registered features and permitted listing locations.";
+}, {
+    readonly method: "POST";
+    readonly path: "/v1/search/interpret";
+    readonly operation: "searchInterpret";
+    readonly scope: "catalog:read";
+    readonly readOnly: true;
+    readonly summary: "Interpret a bounded search vocabulary into editable filters and unresolved text.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/directory/canonical-identities/{id}";
+    readonly operation: "directoryGetCanonicalIdentity";
+    readonly scope: "directory:read";
+    readonly summary: "Resolve reviewed identity links using only permitted source members.";
+}, {
+    readonly method: "POST";
+    readonly path: "/v1/directory/identity-merges";
+    readonly operation: "directoryMergeIdentities";
+    readonly scope: "directory:identity:write";
+    readonly summary: "Record an audited identity merge with expected source bindings.";
+}, {
+    readonly method: "POST";
+    readonly path: "/v1/directory/identity-splits";
+    readonly operation: "directorySplitIdentity";
+    readonly scope: "directory:identity:write";
+    readonly summary: "Split a reviewed identity without moving account or action history.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/directory/entities/{id}/inventory";
+    readonly operation: "directoryListInventory";
+    readonly scope: "directory:read";
+    readonly summary: "Read represented or current-roster inventory with optional verified corporate rollup.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/directory/sales-candidates";
+    readonly operation: "discoverDirectorySalesCandidates";
+    readonly scope: "directory:sales";
+    readonly summary: "Discover a bounded authorized page of subjects for sales-plan evaluation.";
+}, {
+    readonly method: "POST";
+    readonly path: "/v1/directory/action-claims";
+    readonly operation: "claimDirectoryActions";
+    readonly scope: "directory:execute";
+    readonly summary: "Reserve directory recommendations under a separately reviewed execution policy.";
+}, {
+    readonly method: "POST";
+    readonly path: "/v1/directory/actions/{id}/attempts";
+    readonly operation: "startDirectoryAttempt";
+    readonly scope: "directory:execute";
+    readonly summary: "Recheck authority and start one attempt, or return reconciliation-only replay.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/directory/actions/{id}";
+    readonly operation: "getDirectoryAction";
+    readonly scope: "directory:execute";
+    readonly summary: "Read a product-scoped directory action and its execution state.";
+}, {
+    readonly method: "POST";
+    readonly path: "/v1/directory/action-outcomes";
+    readonly operation: "recordDirectoryActionOutcomes";
+    readonly scope: "directory:execute";
+    readonly summary: "Record authenticated provider receipts without retrying ambiguous effects.";
+}, {
+    readonly method: "POST";
+    readonly path: "/v1/directory/profile-observations";
+    readonly operation: "directoryRecordProfile";
+    readonly scope: "directory:write";
+    readonly summary: "Record a trusted producer’s scoped profile evidence.";
+}, {
+    readonly method: "POST";
+    readonly path: "/v1/directory/relationship-observations";
+    readonly operation: "directoryRecordRelationship";
+    readonly scope: "directory:write";
+    readonly summary: "Record a trusted producer’s evidenced relationship.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/directory/professionals";
+    readonly operation: "directoryListProfessionals";
+    readonly scope: "directory:read";
+    readonly summary: "Read permitted source-backed professionals.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/directory/offices";
+    readonly operation: "directoryListOffices";
+    readonly scope: "directory:read";
+    readonly summary: "Read permitted source offices.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/directory/organizations";
+    readonly operation: "directoryListOrganizations";
+    readonly scope: "directory:read";
+    readonly summary: "Read evidenced business and brand observations.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/directory/teams";
+    readonly operation: "directoryListTeams";
+    readonly scope: "directory:read";
+    readonly summary: "Read evidenced teams.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/directory/entities/{id}";
+    readonly operation: "directoryGetEntity";
+    readonly scope: "directory:read";
+    readonly summary: "Read a scoped professional, office, organization or team.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/directory/legacy-agents/{id}";
+    readonly operation: "directoryResolveAgent";
+    readonly scope: "directory:read";
+    readonly summary: "Resolve a listing agent ID to its permitted public directory identity.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/directory/identities";
+    readonly operation: "directoryResolveIdentity";
+    readonly scope: "directory:read";
+    readonly summary: "Resolve a typed directory source identity.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/directory/relationships";
+    readonly operation: "directoryListRelationships";
+    readonly scope: "directory:read";
+    readonly summary: "Read bounded evidenced relationships.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/directory/entities/{id}/contacts";
+    readonly operation: "directoryGetContacts";
+    readonly scope: "directory:contacts";
+    readonly summary: "Read purpose-permitted directory contact endpoints.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/directory/entities/{id}/metrics";
+    readonly operation: "directoryGetMetrics";
+    readonly scope: "directory:read";
+    readonly summary: "Read authorized observed inventory metrics.";
+}, {
+    readonly method: "POST";
+    readonly path: "/v1/directory/snapshots";
+    readonly operation: "createDirectorySnapshot";
+    readonly scope: "directory:sync";
+    readonly status: 202;
+    readonly summary: "Capture a directory or combined feed boundary.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/directory/snapshots/{id}";
+    readonly operation: "getDirectorySnapshot";
+    readonly scope: "directory:sync";
+    readonly summary: "Read snapshot scope, boundary and expiry.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/directory/snapshots/{id}/items";
+    readonly operation: "listDirectorySnapshotItems";
+    readonly scope: "directory:sync";
+    readonly summary: "Page immutable typed snapshot resources.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/directory/changes";
+    readonly operation: "listDirectoryChanges";
+    readonly scope: "directory:sync";
+    readonly summary: "Replay typed changes with complete commit-group boundaries.";
+}, {
+    readonly method: "POST";
+    readonly path: "/v1/directory/sales-plans";
+    readonly operation: "createDirectorySalesPlan";
+    readonly scope: "directory:sales";
+    readonly summary: "Prepare bounded professional or organization sales recommendations.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/directory/sales-plans/{id}";
+    readonly operation: "getDirectorySalesPlan";
+    readonly scope: "directory:sales";
+    readonly summary: "Read a scoped recommendation-only directory sales plan.";
+}, {
+    readonly method: "POST";
+    readonly path: "/v1/directory/assessments";
+    readonly operation: "requestDirectoryAssessment";
+    readonly scope: "intelligence:judge";
+    readonly status: 202;
+    readonly summary: "Queue a canonical-evidence directory assessment.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/directory/assessments/latest";
+    readonly operation: "latestDirectoryAssessment";
+    readonly scope: "intelligence:read";
+    readonly summary: "Read prepared directory intelligence with current evidence checks.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/directory/assessments/{id}";
+    readonly operation: "getDirectoryAssessment";
+    readonly scope: "intelligence:read";
+    readonly summary: "Read a purpose-scoped directory assessment.";
+}, {
+    readonly method: "POST";
+    readonly path: "/v1/publications";
+    readonly operation: "reportPublication";
+    readonly scope: "publications:write";
+    readonly summary: "Acknowledge this product’s current listing publication.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/listings/{id}/destination";
+    readonly operation: "resolveDestination";
+    readonly scope: "catalog:read";
+    readonly summary: "Resolve a current product-reported destination.";
+}, {
+    readonly method: "POST";
+    readonly path: "/v1/judgments";
+    readonly operation: "evaluateJudgment";
+    readonly scope: "intelligence:judge";
+    readonly summary: "Evaluate a bounded versioned task against caller-supplied evidence.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/judgments/{id}";
+    readonly operation: "getJudgment";
+    readonly scope: "intelligence:read";
+    readonly summary: "Read this credential subject’s durable judgment audit.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/intelligence-capabilities";
+    readonly operation: "intelligenceCapabilities";
+    readonly scope: "intelligence:read";
+    readonly summary: "Read implemented judgment tasks and explicit unsupported capabilities.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/capabilities";
+    readonly operation: "capabilities";
+    readonly summary: "Read this caller’s supported capabilities.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/catalog-health";
+    readonly operation: "getCatalogHealth";
+    readonly scope: "catalog:read";
+    readonly summary: "Read authorized source freshness independently of catalog changes.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/listings";
+    readonly operation: "listListings";
+    readonly scope: "catalog:read";
+    readonly summary: "Search the current authorized catalog.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/listings/map";
+    readonly operation: "listListingMap";
+    readonly scope: "catalog:read";
+    readonly summary: "Read bounded map markers within a required geographic box.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/listings/{id}/similar";
+    readonly operation: "listSimilarListings";
+    readonly scope: "catalog:read";
+    readonly summary: "Rank a bounded local shortlist using transparent fact similarity.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/listings/{id}";
+    readonly operation: "getListing";
+    readonly scope: "catalog:read";
+    readonly summary: "Read a current listing.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/listings/{id}/contacts";
+    readonly operation: "getListingContacts";
+    readonly scope: "contacts:read";
+    readonly summary: "Read protected source contact routing for a current active listing.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/listing-identities";
+    readonly operation: "resolveListingIdentity";
+    readonly scope: "catalog:read";
+    readonly summary: "Resolve a namespaced source alias.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/agent-identities";
+    readonly operation: "resolveAgentIdentity";
+    readonly scope: "agents:read";
+    readonly summary: "Resolve a namespaced agent source alias.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/agents/{id}";
+    readonly operation: "getAgent";
+    readonly scope: "agents:read";
+    readonly summary: "Read permitted agent attribution.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/agents/{id}/listings";
+    readonly operation: "listAgentListings";
+    readonly scope: "catalog:read";
+    readonly summary: "Read an agent’s authorized inventory.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/classification-schema";
+    readonly operation: "classificationSchema";
+    readonly scope: "catalog:read";
+    readonly summary: "Read the current classification vocabulary.";
+}, {
+    readonly method: "POST";
+    readonly path: "/v1/catalog-snapshots";
+    readonly operation: "createSnapshot";
+    readonly scope: "catalog:sync";
+    readonly status: 202;
+    readonly summary: "Create a consistent snapshot with its replay cursor.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/catalog-snapshots/{id}";
+    readonly operation: "getSnapshot";
+    readonly scope: "catalog:sync";
+    readonly summary: "Read snapshot readiness and expiry.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/catalog-snapshots/{id}/items";
+    readonly operation: "listSnapshotItems";
+    readonly scope: "catalog:sync";
+    readonly summary: "Page an immutable snapshot.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/catalog-changes";
+    readonly operation: "listCatalogChanges";
+    readonly scope: "catalog:sync";
+    readonly summary: "Replay authorized projection changes and removals.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/events";
+    readonly operation: "listEvents";
+    readonly scope: "catalog:sync";
+    readonly summary: "Replay committed domain occurrences.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/action-profiles";
+    readonly operation: "listActionProfiles";
+    readonly scope: "opportunities:read";
+    readonly summary: "Read published action profiles.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/opportunities";
+    readonly operation: "listOpportunities";
+    readonly scope: "opportunities:read";
+    readonly summary: "Read current candidates without reserving actions.";
+}, {
+    readonly method: "POST";
+    readonly path: "/v1/opportunity-plans";
+    readonly operation: "createPlan";
+    readonly scope: "plans:create";
+    readonly status: 202;
+    readonly summary: "Create or reuse an actual persisted selection.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/opportunity-plans/{id}";
+    readonly operation: "getPlan";
+    readonly scope: "opportunities:read";
+    readonly summary: "Read plan progress, coverage and execution counts.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/opportunity-plans/{id}/items";
+    readonly operation: "listPlanItems";
+    readonly scope: "opportunities:read";
+    readonly summary: "Read stable selection pages.";
+}, {
+    readonly method: "POST";
+    readonly path: "/v1/dispatch-batches";
+    readonly operation: "claimDispatchBatch";
+    readonly scope: "actions:dispatch";
+    readonly status: 201;
+    readonly summary: "Reserve executable actions after critical revalidation.";
+}, {
+    readonly method: "POST";
+    readonly path: "/v1/actions/{id}/attempts";
+    readonly operation: "startAttempt";
+    readonly scope: "actions:dispatch";
+    readonly status: 201;
+    readonly summary: "Fence and record dispatch before an external effect.";
+}, {
+    readonly method: "POST";
+    readonly path: "/v1/action-outcomes";
+    readonly operation: "recordActionOutcomes";
+    readonly scope: "actions:dispatch";
+    readonly summary: "Record idempotent sender receipts with per-item results.";
+}, {
+    readonly method: "POST";
+    readonly path: "/v1/product-context-events";
+    readonly operation: "recordProductContextEvents";
+    readonly scope: "product-events:write";
+    readonly summary: "Ingest owned product context snapshots and deltas.";
+}, {
+    readonly method: "POST";
+    readonly path: "/v1/webhook-subscriptions";
+    readonly operation: "createWebhookSubscription";
+    readonly scope: "webhooks:manage";
+    readonly status: 201;
+    readonly summary: "Register a subscription only where delivery support is configured.";
+}, {
+    readonly method: "GET";
+    readonly path: "/v1/operations/readiness";
+    readonly operation: "readiness";
+    readonly scope: "operations:read";
+    readonly summary: "Inspect configured operational dependencies.";
+}];