@propertysimple/client 0.1.0 → 0.2.0

package/contracts/src/routes.js

@@ -23,6 +23,22 @@ export const routes = [
         readOnly: true,
         summary: 'Read authorized refinement counts for the same normalized search.',
     },
+    {
+        method: 'POST',
+        path: '/v1/search/stats',
+        operation: 'searchStats',
+        scope: 'catalog:read',
+        readOnly: true,
+        summary: 'Read count, price, price per area and days-on-market statistics for a search.',
+    },
+    {
+        method: 'POST',
+        path: '/v1/search/index',
+        operation: 'searchIndex',
+        scope: 'catalog:read',
+        readOnly: true,
+        summary: 'Walk compact entries for every listing a search matches, for sitemaps.',
+    },
     {
         method: 'POST',
         path: '/v1/search/map',
@@ -46,253 +62,6 @@ export const routes = [
         readOnly: true,
         summary: 'Interpret a bounded search vocabulary into editable filters and unresolved text.',
     },
-    {
-        method: 'GET',
-        path: '/v1/directory/canonical-identities/{id}',
-        operation: 'directoryGetCanonicalIdentity',
-        scope: 'directory:read',
-        summary: 'Resolve reviewed identity links using only permitted source members.',
-    },
-    {
-        method: 'POST',
-        path: '/v1/directory/identity-merges',
-        operation: 'directoryMergeIdentities',
-        scope: 'directory:identity:write',
-        summary: 'Record an audited identity merge with expected source bindings.',
-    },
-    {
-        method: 'POST',
-        path: '/v1/directory/identity-splits',
-        operation: 'directorySplitIdentity',
-        scope: 'directory:identity:write',
-        summary: 'Split a reviewed identity without moving account or action history.',
-    },
-    {
-        method: 'GET',
-        path: '/v1/directory/entities/{id}/inventory',
-        operation: 'directoryListInventory',
-        scope: 'directory:read',
-        summary: 'Read represented or current-roster inventory with optional verified corporate rollup.',
-    },
-    {
-        method: 'GET',
-        path: '/v1/directory/sales-candidates',
-        operation: 'discoverDirectorySalesCandidates',
-        scope: 'directory:sales',
-        summary: 'Discover a bounded authorized page of subjects for sales-plan evaluation.',
-    },
-    {
-        method: 'POST',
-        path: '/v1/directory/action-claims',
-        operation: 'claimDirectoryActions',
-        scope: 'directory:execute',
-        summary: 'Reserve directory recommendations under a separately reviewed execution policy.',
-    },
-    {
-        method: 'POST',
-        path: '/v1/directory/actions/{id}/attempts',
-        operation: 'startDirectoryAttempt',
-        scope: 'directory:execute',
-        summary: 'Recheck authority and start one attempt, or return reconciliation-only replay.',
-    },
-    {
-        method: 'GET',
-        path: '/v1/directory/actions/{id}',
-        operation: 'getDirectoryAction',
-        scope: 'directory:execute',
-        summary: 'Read a product-scoped directory action and its execution state.',
-    },
-    {
-        method: 'POST',
-        path: '/v1/directory/action-outcomes',
-        operation: 'recordDirectoryActionOutcomes',
-        scope: 'directory:execute',
-        summary: 'Record authenticated provider receipts without retrying ambiguous effects.',
-    },
-    {
-        method: 'POST',
-        path: '/v1/directory/profile-observations',
-        operation: 'directoryRecordProfile',
-        scope: 'directory:write',
-        summary: 'Record a trusted producer’s scoped profile evidence.',
-    },
-    {
-        method: 'POST',
-        path: '/v1/directory/relationship-observations',
-        operation: 'directoryRecordRelationship',
-        scope: 'directory:write',
-        summary: 'Record a trusted producer’s evidenced relationship.',
-    },
-    {
-        method: 'GET',
-        path: '/v1/directory/professionals',
-        operation: 'directoryListProfessionals',
-        scope: 'directory:read',
-        summary: 'Read permitted source-backed professionals.',
-    },
-    {
-        method: 'GET',
-        path: '/v1/directory/offices',
-        operation: 'directoryListOffices',
-        scope: 'directory:read',
-        summary: 'Read permitted source offices.',
-    },
-    {
-        method: 'GET',
-        path: '/v1/directory/organizations',
-        operation: 'directoryListOrganizations',
-        scope: 'directory:read',
-        summary: 'Read evidenced business and brand observations.',
-    },
-    {
-        method: 'GET',
-        path: '/v1/directory/teams',
-        operation: 'directoryListTeams',
-        scope: 'directory:read',
-        summary: 'Read evidenced teams.',
-    },
-    {
-        method: 'GET',
-        path: '/v1/directory/entities/{id}',
-        operation: 'directoryGetEntity',
-        scope: 'directory:read',
-        summary: 'Read a scoped professional, office, organization or team.',
-    },
-    {
-        method: 'GET',
-        path: '/v1/directory/legacy-agents/{id}',
-        operation: 'directoryResolveAgent',
-        scope: 'directory:read',
-        summary: 'Resolve a listing agent ID to its permitted public directory identity.',
-    },
-    {
-        method: 'GET',
-        path: '/v1/directory/identities',
-        operation: 'directoryResolveIdentity',
-        scope: 'directory:read',
-        summary: 'Resolve a typed directory source identity.',
-    },
-    {
-        method: 'GET',
-        path: '/v1/directory/relationships',
-        operation: 'directoryListRelationships',
-        scope: 'directory:read',
-        summary: 'Read bounded evidenced relationships.',
-    },
-    {
-        method: 'GET',
-        path: '/v1/directory/entities/{id}/contacts',
-        operation: 'directoryGetContacts',
-        scope: 'directory:contacts',
-        summary: 'Read purpose-permitted directory contact endpoints.',
-    },
-    {
-        method: 'GET',
-        path: '/v1/directory/entities/{id}/metrics',
-        operation: 'directoryGetMetrics',
-        scope: 'directory:read',
-        summary: 'Read authorized observed inventory metrics.',
-    },
-    {
-        method: 'POST',
-        path: '/v1/directory/snapshots',
-        operation: 'createDirectorySnapshot',
-        scope: 'directory:sync',
-        status: 202,
-        summary: 'Capture a directory or combined feed boundary.',
-    },
-    {
-        method: 'GET',
-        path: '/v1/directory/snapshots/{id}',
-        operation: 'getDirectorySnapshot',
-        scope: 'directory:sync',
-        summary: 'Read snapshot scope, boundary and expiry.',
-    },
-    {
-        method: 'GET',
-        path: '/v1/directory/snapshots/{id}/items',
-        operation: 'listDirectorySnapshotItems',
-        scope: 'directory:sync',
-        summary: 'Page immutable typed snapshot resources.',
-    },
-    {
-        method: 'GET',
-        path: '/v1/directory/changes',
-        operation: 'listDirectoryChanges',
-        scope: 'directory:sync',
-        summary: 'Replay typed changes with complete commit-group boundaries.',
-    },
-    {
-        method: 'POST',
-        path: '/v1/directory/sales-plans',
-        operation: 'createDirectorySalesPlan',
-        scope: 'directory:sales',
-        summary: 'Prepare bounded professional or organization sales recommendations.',
-    },
-    {
-        method: 'GET',
-        path: '/v1/directory/sales-plans/{id}',
-        operation: 'getDirectorySalesPlan',
-        scope: 'directory:sales',
-        summary: 'Read a scoped recommendation-only directory sales plan.',
-    },
-    {
-        method: 'POST',
-        path: '/v1/directory/assessments',
-        operation: 'requestDirectoryAssessment',
-        scope: 'intelligence:judge',
-        status: 202,
-        summary: 'Queue a canonical-evidence directory assessment.',
-    },
-    {
-        method: 'GET',
-        path: '/v1/directory/assessments/latest',
-        operation: 'latestDirectoryAssessment',
-        scope: 'intelligence:read',
-        summary: 'Read prepared directory intelligence with current evidence checks.',
-    },
-    {
-        method: 'GET',
-        path: '/v1/directory/assessments/{id}',
-        operation: 'getDirectoryAssessment',
-        scope: 'intelligence:read',
-        summary: 'Read a purpose-scoped directory assessment.',
-    },
-    {
-        method: 'POST',
-        path: '/v1/publications',
-        operation: 'reportPublication',
-        scope: 'publications:write',
-        summary: 'Acknowledge this product’s current listing publication.',
-    },
-    {
-        method: 'GET',
-        path: '/v1/listings/{id}/destination',
-        operation: 'resolveDestination',
-        scope: 'catalog:read',
-        summary: 'Resolve a current product-reported destination.',
-    },
-    {
-        method: 'POST',
-        path: '/v1/judgments',
-        operation: 'evaluateJudgment',
-        scope: 'intelligence:judge',
-        summary: 'Evaluate a bounded versioned task against caller-supplied evidence.',
-    },
-    {
-        method: 'GET',
-        path: '/v1/judgments/{id}',
-        operation: 'getJudgment',
-        scope: 'intelligence:read',
-        summary: 'Read this credential subject’s durable judgment audit.',
-    },
-    {
-        method: 'GET',
-        path: '/v1/intelligence-capabilities',
-        operation: 'intelligenceCapabilities',
-        scope: 'intelligence:read',
-        summary: 'Read implemented judgment tasks and explicit unsupported capabilities.',
-    },
     {
         method: 'GET',
         path: '/v1/capabilities',
@@ -355,6 +124,13 @@ export const routes = [
         scope: 'agents:read',
         summary: 'Resolve a namespaced agent source alias.',
     },
+    {
+        method: 'GET',
+        path: '/v1/agent-email-sharing',
+        operation: 'getAgentEmailSharing',
+        scope: 'contacts:read',
+        summary: 'Count known source-agent identities sharing an exact stored email.',
+    },
     {
         method: 'GET',
         path: '/v1/agents/{id}',
@@ -369,42 +145,6 @@ export const routes = [
         scope: 'catalog:read',
         summary: 'Read an agent’s authorized inventory.',
     },
-    {
-        method: 'GET',
-        path: '/v1/classification-schema',
-        operation: 'classificationSchema',
-        scope: 'catalog:read',
-        summary: 'Read the current classification vocabulary.',
-    },
-    {
-        method: 'POST',
-        path: '/v1/catalog-snapshots',
-        operation: 'createSnapshot',
-        scope: 'catalog:sync',
-        status: 202,
-        summary: 'Create a consistent snapshot with its replay cursor.',
-    },
-    {
-        method: 'GET',
-        path: '/v1/catalog-snapshots/{id}',
-        operation: 'getSnapshot',
-        scope: 'catalog:sync',
-        summary: 'Read snapshot readiness and expiry.',
-    },
-    {
-        method: 'GET',
-        path: '/v1/catalog-snapshots/{id}/items',
-        operation: 'listSnapshotItems',
-        scope: 'catalog:sync',
-        summary: 'Page an immutable snapshot.',
-    },
-    {
-        method: 'GET',
-        path: '/v1/catalog-changes',
-        operation: 'listCatalogChanges',
-        scope: 'catalog:sync',
-        summary: 'Replay authorized projection changes and removals.',
-    },
     {
         method: 'GET',
         path: '/v1/events',
@@ -414,77 +154,10 @@ export const routes = [
     },
     {
         method: 'GET',
-        path: '/v1/action-profiles',
-        operation: 'listActionProfiles',
-        scope: 'opportunities:read',
-        summary: 'Read published action profiles.',
-    },
-    {
-        method: 'GET',
-        path: '/v1/opportunities',
-        operation: 'listOpportunities',
-        scope: 'opportunities:read',
-        summary: 'Read current candidates without reserving actions.',
-    },
-    {
-        method: 'POST',
-        path: '/v1/opportunity-plans',
-        operation: 'createPlan',
-        scope: 'plans:create',
-        status: 202,
-        summary: 'Create or reuse an actual persisted selection.',
-    },
-    {
-        method: 'GET',
-        path: '/v1/opportunity-plans/{id}',
-        operation: 'getPlan',
-        scope: 'opportunities:read',
-        summary: 'Read plan progress, coverage and execution counts.',
-    },
-    {
-        method: 'GET',
-        path: '/v1/opportunity-plans/{id}/items',
-        operation: 'listPlanItems',
-        scope: 'opportunities:read',
-        summary: 'Read stable selection pages.',
-    },
-    {
-        method: 'POST',
-        path: '/v1/dispatch-batches',
-        operation: 'claimDispatchBatch',
-        scope: 'actions:dispatch',
-        status: 201,
-        summary: 'Reserve executable actions after critical revalidation.',
-    },
-    {
-        method: 'POST',
-        path: '/v1/actions/{id}/attempts',
-        operation: 'startAttempt',
-        scope: 'actions:dispatch',
-        status: 201,
-        summary: 'Fence and record dispatch before an external effect.',
-    },
-    {
-        method: 'POST',
-        path: '/v1/action-outcomes',
-        operation: 'recordActionOutcomes',
-        scope: 'actions:dispatch',
-        summary: 'Record idempotent sender receipts with per-item results.',
-    },
-    {
-        method: 'POST',
-        path: '/v1/product-context-events',
-        operation: 'recordProductContextEvents',
-        scope: 'product-events:write',
-        summary: 'Ingest owned product context snapshots and deltas.',
-    },
-    {
-        method: 'POST',
-        path: '/v1/webhook-subscriptions',
-        operation: 'createWebhookSubscription',
-        scope: 'webhooks:manage',
-        status: 201,
-        summary: 'Register a subscription only where delivery support is configured.',
+        path: '/v1/listing-changes',
+        operation: 'listListingChanges',
+        scope: 'catalog:sync',
+        summary: 'Follow every listing change, including removals, from a durable cursor.',
     },
     {
         method: 'GET',
@@ -494,3 +167,58 @@ export const routes = [
         summary: 'Inspect configured operational dependencies.',
     },
 ];
+/** Operations retired with the directory, publication feed, snapshots, opportunity
+ * engine and judgments (October 2026). The router answers each with 410 RETIRED
+ * so an old client fails clearly instead of seeing 404. */
+export const retiredRoutes = [
+    ['POST', '/v1/action-outcomes'],
+    ['GET', '/v1/action-profiles'],
+    ['POST', '/v1/actions/{id}/attempts'],
+    ['GET', '/v1/catalog-changes'],
+    ['POST', '/v1/catalog-snapshots'],
+    ['GET', '/v1/catalog-snapshots/{id}'],
+    ['GET', '/v1/catalog-snapshots/{id}/items'],
+    ['GET', '/v1/classification-schema'],
+    ['POST', '/v1/directory/action-claims'],
+    ['POST', '/v1/directory/action-outcomes'],
+    ['GET', '/v1/directory/actions/{id}'],
+    ['POST', '/v1/directory/actions/{id}/attempts'],
+    ['POST', '/v1/directory/assessments'],
+    ['GET', '/v1/directory/assessments/latest'],
+    ['GET', '/v1/directory/assessments/{id}'],
+    ['GET', '/v1/directory/canonical-identities/{id}'],
+    ['GET', '/v1/directory/changes'],
+    ['GET', '/v1/directory/entities/{id}'],
+    ['GET', '/v1/directory/entities/{id}/contacts'],
+    ['GET', '/v1/directory/entities/{id}/inventory'],
+    ['GET', '/v1/directory/entities/{id}/metrics'],
+    ['GET', '/v1/directory/identities'],
+    ['POST', '/v1/directory/identity-merges'],
+    ['POST', '/v1/directory/identity-splits'],
+    ['GET', '/v1/directory/legacy-agents/{id}'],
+    ['GET', '/v1/directory/offices'],
+    ['GET', '/v1/directory/organizations'],
+    ['GET', '/v1/directory/professionals'],
+    ['POST', '/v1/directory/profile-observations'],
+    ['POST', '/v1/directory/relationship-observations'],
+    ['GET', '/v1/directory/relationships'],
+    ['GET', '/v1/directory/sales-candidates'],
+    ['POST', '/v1/directory/sales-plans'],
+    ['GET', '/v1/directory/sales-plans/{id}'],
+    ['POST', '/v1/directory/snapshots'],
+    ['GET', '/v1/directory/snapshots/{id}'],
+    ['GET', '/v1/directory/snapshots/{id}/items'],
+    ['GET', '/v1/directory/teams'],
+    ['POST', '/v1/dispatch-batches'],
+    ['GET', '/v1/intelligence-capabilities'],
+    ['POST', '/v1/judgments'],
+    ['GET', '/v1/judgments/{id}'],
+    ['GET', '/v1/listings/{id}/destination'],
+    ['GET', '/v1/opportunities'],
+    ['POST', '/v1/opportunity-plans'],
+    ['GET', '/v1/opportunity-plans/{id}'],
+    ['GET', '/v1/opportunity-plans/{id}/items'],
+    ['POST', '/v1/product-context-events'],
+    ['POST', '/v1/publications'],
+    ['POST', '/v1/webhook-subscriptions'],
+];