htag-sdk 0.9.1 → 1.0.0

package/dist/index.cjs

@@ -23,9 +23,12 @@ __export(index_exports, {
   AddressClient: () => AddressClient,
   AgentsClient: () => AgentsClient,
   AuthenticationError: () => AuthenticationError,
+  DemographicsClient: () => DemographicsClient,
+  EconomicsClient: () => EconomicsClient,
   HtAgApiClient: () => HtAgApiClient,
   HtAgError: () => HtAgError,
   IntentHubClient: () => IntentHubClient,
+  InternalNamespace: () => InternalNamespace,
   MarketsClient: () => MarketsClient,
   PropertyClient: () => PropertyClient,
   RateLimitError: () => RateLimitError,
@@ -327,26 +330,6 @@ var AddressClient = class {
   constructor(http) {
     this.http = http;
   }
-  /**
-   * Search for addresses matching a free-text query.
-   *
-   * `GET /internal-api/v1/address/search`
-   */
-  async search(params) {
-    const { signal, ...query } = params;
-    const qs = buildQueryString(query);
-    return this.http.internalGet(`/internal-api/v1/address/search${qs}`, { signal });
-  }
-  /**
-   * Retrieve detailed insights for one or more addresses.
-   *
-   * `GET /internal-api/v1/address/insights`
-   */
-  async insights(params) {
-    const { signal, ...query } = params;
-    const qs = buildQueryString(query);
-    return this.http.internalGet(`/internal-api/v1/address/insights${qs}`, { signal });
-  }
   /**
    * Standardise a batch of raw address strings into structured records.
    *
@@ -390,6 +373,16 @@ var AddressClient = class {
     const qs = buildQueryString(query);
     return this.http.get(`/v1/address/demographics${qs}`, { signal });
   }
+  /**
+   * Retrieve schools relevant to an address.
+   *
+   * `GET /v1/address/schools`
+   */
+  async schools(params) {
+    const { signal, ...query } = params;
+    const qs = buildQueryString(query);
+    return this.http.get(`/v1/address/schools${qs}`, { signal });
+  }
 };
 
 // src/agents/client.ts
@@ -444,6 +437,95 @@ var AgentsClient = class {
   }
 };
 
+// src/demographics/client.ts
+var DemographicsClient = class {
+  constructor(http) {
+    this.http = http;
+  }
+  async censusMedians(params) {
+    const { signal, ...query } = params;
+    const qs = buildQueryString(query);
+    return this.http.get(`/v1/demographics/census-medians${qs}`, { signal });
+  }
+  async businessActivity(params) {
+    const { signal, ...query } = params;
+    const qs = buildQueryString(query);
+    return this.http.get(`/v1/demographics/business-activity${qs}`, { signal });
+  }
+  async healthcare(params) {
+    const { signal, ...query } = params;
+    const qs = buildQueryString(query);
+    return this.http.get(`/v1/demographics/healthcare${qs}`, { signal });
+  }
+};
+
+// src/economics/client.ts
+var EconomicsClient = class {
+  /** @internal */
+  constructor(http) {
+    this.http = http;
+  }
+  /**
+   * Get CPI adjustment factor between two periods.
+   *
+   * `GET /v1/economics/cpi/factor`
+   */
+  async cpiFactor(params) {
+    const { signal, ...query } = params;
+    const qs = buildQueryString(query);
+    return this.http.get(`/v1/economics/cpi/factor${qs}`, { signal });
+  }
+  /**
+   * Adjust a dollar value for CPI inflation.
+   *
+   * `GET /v1/economics/cpi/adjust`
+   */
+  async cpiAdjust(params) {
+    const { signal, ...query } = params;
+    const qs = buildQueryString(query);
+    return this.http.get(`/v1/economics/cpi/adjust${qs}`, { signal });
+  }
+  /**
+   * Get CPI index time series for a region.
+   *
+   * `GET /v1/economics/cpi/series`
+   */
+  async cpiSeries(params) {
+    const { signal, ...query } = params ?? {};
+    const qs = buildQueryString(query);
+    return this.http.get(`/v1/economics/cpi/series${qs}`, { signal });
+  }
+  /**
+   * Get latest CPI index values for all regions.
+   *
+   * `GET /v1/economics/cpi/latest`
+   */
+  async cpiLatest(options) {
+    return this.http.get("/v1/economics/cpi/latest", options);
+  }
+  /**
+   * Get current RBA cash rate.
+   *
+   * `GET /v1/economics/cash-rate`
+   */
+  async cashRate(options) {
+    return this.http.get("/v1/economics/cash-rate", options);
+  }
+  /**
+   * Get RBA cash rate time series.
+   *
+   * `GET /v1/economics/cash-rate/series`
+   */
+  async cashRateSeries(params) {
+    const { signal, ...query } = params ?? {};
+    const qs = buildQueryString(query);
+    return this.http.get(
+      `/v1/economics/cash-rate/series${qs}`,
+      { signal }
+    );
+  }
+};
+
 // src/property/client.ts
 var PropertyClient = class {
   /** @internal */
@@ -460,6 +542,36 @@ var PropertyClient = class {
     const qs = buildQueryString(query);
     return this.http.get(`/v1/property/sold/search${qs}`, { signal });
   }
+  /**
+   * Retrieve physical property attributes for an address.
+   *
+   * `GET /v1/property/summary`
+   */
+  async summary(params) {
+    const { signal, ...query } = params;
+    const qs = buildQueryString(query);
+    return this.http.get(`/v1/property/summary${qs}`, { signal });
+  }
+  /**
+   * Retrieve valuation estimates and transaction history for an address.
+   *
+   * `GET /v1/property/estimates`
+   */
+  async estimates(params) {
+    const { signal, ...query } = params;
+    const qs = buildQueryString(query);
+    return this.http.get(`/v1/property/estimates${qs}`, { signal });
+  }
+  /**
+   * Retrieve market position indicators for an address.
+   *
+   * `GET /v1/property/market`
+   */
+  async market(params) {
+    const { signal, ...query } = params;
+    const qs = buildQueryString(query);
+    return this.http.get(`/v1/property/market${qs}`, { signal });
+  }
 };
 
 // src/markets/trends.ts
@@ -471,10 +583,10 @@ var TrendsClient = class {
   /**
    * Price history trends.
    *
-   * `GET /internal-api/v1/markets/trends/price`
+   * `GET /v1/markets/trends/price`
    */
   async price(params) {
-    return this.trend("price", params);
+    return this.publicTrend("price", params);
   }
   /**
    * Rent history trends.
@@ -492,37 +604,21 @@ var TrendsClient = class {
   async yieldHistory(params) {
     return this.publicTrend("yield", params);
   }
-  /**
-   * Supply and demand (monthly frequency).
-   *
-   * `GET /internal-api/v1/markets/trends/supply-demand`
-   */
-  async supplyDemand(params) {
-    return this.trend("supply-demand", params);
-  }
   /**
    * Search interest index (quarterly frequency).
    *
-   * `GET /internal-api/v1/markets/trends/search-index`
+   * `GET /v1/markets/trends/search-index`
    */
   async searchIndex(params) {
-    return this.trend("search-index", params);
+    return this.publicTrend("search-index", params);
   }
   /**
    * Hold period (yearly frequency).
    *
-   * `GET /internal-api/v1/markets/trends/hold-period`
+   * `GET /v1/markets/trends/hold-period`
    */
   async holdPeriod(params) {
-    return this.trend("hold-period", params);
-  }
-  /**
-   * Performance essentials.
-   *
-   * `GET /internal-api/v1/markets/trends/performance`
-   */
-  async performance(params) {
-    return this.trend("performance", params);
+    return this.publicTrend("hold-period", params);
   }
   /**
    * Growth rate cycle.
@@ -583,14 +679,6 @@ var TrendsClient = class {
   // -----------------------------------------------------------------------
   // Shared implementation
   // -----------------------------------------------------------------------
-  async trend(metric, params) {
-    const { signal, ...query } = params;
-    const qs = buildQueryString(query);
-    return this.http.internalGet(
-      `/internal-api/v1/markets/trends/${metric}${qs}`,
-      { signal }
-    );
-  }
   async publicTrend(metric, params) {
     const { signal, ...query } = params;
     const qs = buildQueryString(query);
@@ -611,33 +699,15 @@ var MarketsClient = class {
   /** Sub-client for time-series trend endpoints. */
   trends;
   /**
-   * Retrieve market snapshot data with optional filters.
+   * Core market headline metrics.
    *
-   * `GET /internal-api/v1/markets/snapshots`
+   * `GET /v1/markets/summary`
    */
-  async snapshots(params) {
+  async summary(params) {
     const { signal, ...query } = params;
     const qs = buildQueryString(query);
-    return this.http.internalGet(
-      `/internal-api/v1/markets/snapshots${qs}`,
-      { signal }
-    );
-  }
-  /**
-   * Advanced market query with logical filter expressions.
-   *
-   * `POST /internal-api/v1/markets/query`
-   */
-  async query(body, options) {
-    return this.http.internalPost(
-      "/internal-api/v1/markets/query",
-      body,
-      options
-    );
+    return this.http.get(`/v1/markets/summary${qs}`, { signal });
   }
-  // -------------------------------------------------------------------------
-  // Public market snapshot endpoints (/v1/markets/*)
-  // -------------------------------------------------------------------------
   /**
    * Cumulative growth metrics.
    *
@@ -1020,6 +1090,169 @@ var ReferenceClient = class {
     const qs = buildQueryString(query);
     return this.http.get(`/v1/reference/lga${qs}`, { signal });
   }
+  // -- Concordance endpoints --
+  async concordanceSa2ToLocality(params) {
+    const { signal, ...query } = params;
+    const qs = buildQueryString(query);
+    return this.http.get(`/v1/reference/concordance/sa2-to-locality${qs}`, { signal });
+  }
+  async concordanceLocalityToSa2(params) {
+    const { signal, ...query } = params;
+    const qs = buildQueryString(query);
+    return this.http.get(`/v1/reference/concordance/locality-to-sa2${qs}`, { signal });
+  }
+  async concordanceLgaCodeToLga(params) {
+    const { signal, ...query } = params;
+    const qs = buildQueryString(query);
+    return this.http.get(`/v1/reference/concordance/lga-code-to-lga${qs}`, { signal });
+  }
+  async concordancePostcodeToLocality(params) {
+    const { signal, ...query } = params;
+    const qs = buildQueryString(query);
+    return this.http.get(`/v1/reference/concordance/postcode-to-locality${qs}`, { signal });
+  }
+  async concordanceLocalityToLga(params) {
+    const { signal, ...query } = params;
+    const qs = buildQueryString(query);
+    return this.http.get(`/v1/reference/concordance/locality-to-lga${qs}`, { signal });
+  }
+  async concordanceLgaToLocalities(params) {
+    const { signal, ...query } = params;
+    const qs = buildQueryString(query);
+    return this.http.get(`/v1/reference/concordance/lga-to-localities${qs}`, { signal });
+  }
+  async concordanceSalToLocality(params) {
+    const { signal, ...query } = params;
+    const qs = buildQueryString(query);
+    return this.http.get(`/v1/reference/concordance/sal-to-locality${qs}`, { signal });
+  }
+};
+
+// src/internal.ts
+var InternalAddressClient = class {
+  /** @internal */
+  constructor(http) {
+    this.http = http;
+  }
+  /**
+   * Search for addresses matching a free-text query.
+   *
+   * `GET /internal-api/v1/address/search`
+   */
+  async search(params) {
+    const { signal, ...query } = params;
+    const qs = buildQueryString(query);
+    return this.http.internalGet(`/internal-api/v1/address/search${qs}`, { signal });
+  }
+  /**
+   * Retrieve detailed insights for one or more addresses.
+   *
+   * `GET /internal-api/v1/address/insights`
+   */
+  async insights(params) {
+    const { signal, ...query } = params;
+    const qs = buildQueryString(query);
+    return this.http.internalGet(`/internal-api/v1/address/insights${qs}`, { signal });
+  }
+};
+var InternalPropertyClient = class {
+  /** @internal */
+  constructor(http) {
+    this.http = http;
+  }
+  /**
+   * Retrieve automated property valuations (AVM).
+   *
+   * `GET /internal-api/v1/property/avm`
+   */
+  async avm(params) {
+    const { signal, ...rest } = params;
+    const q = {};
+    if (rest.addressKey?.length) q.address_key = rest.addressKey.join(",");
+    if (rest.address?.length) q.address = rest.address.join(",");
+    const qs = buildQueryString(q);
+    return this.http.internalGet(`/internal-api/v1/property/avm${qs}`, { signal });
+  }
+};
+var InternalTrendsClient = class {
+  /** @internal */
+  constructor(http) {
+    this.http = http;
+  }
+  /**
+   * Supply and demand (monthly frequency).
+   *
+   * `GET /internal-api/v1/markets/trends/supply-demand`
+   */
+  async supplyDemand(params) {
+    const { signal, ...query } = params;
+    const qs = buildQueryString(query);
+    return this.http.internalGet(
+      `/internal-api/v1/markets/trends/supply-demand${qs}`,
+      { signal }
+    );
+  }
+  /**
+   * Performance essentials.
+   *
+   * `GET /internal-api/v1/markets/trends/performance`
+   */
+  async performance(params) {
+    const { signal, ...query } = params;
+    const qs = buildQueryString(query);
+    return this.http.internalGet(
+      `/internal-api/v1/markets/trends/performance${qs}`,
+      { signal }
+    );
+  }
+};
+var InternalMarketsClient = class {
+  /** @internal */
+  constructor(http) {
+    this.http = http;
+    this.trends = new InternalTrendsClient(http);
+  }
+  /** Sub-client for internal trend endpoints. */
+  trends;
+  /**
+   * Retrieve market snapshot data with optional filters.
+   *
+   * `GET /internal-api/v1/markets/snapshots`
+   */
+  async snapshots(params) {
+    const { signal, ...query } = params;
+    const qs = buildQueryString(query);
+    return this.http.internalGet(
+      `/internal-api/v1/markets/snapshots${qs}`,
+      { signal }
+    );
+  }
+  /**
+   * Advanced market query with logical filter expressions.
+   *
+   * `POST /internal-api/v1/markets/query`
+   */
+  async query(body, options) {
+    return this.http.internalPost(
+      "/internal-api/v1/markets/query",
+      body,
+      options
+    );
+  }
+};
+var InternalNamespace = class {
+  /** Internal address endpoints (search, insights). */
+  address;
+  /** Internal property endpoints (AVM). */
+  property;
+  /** Internal market endpoints (snapshots, query, trends). */
+  markets;
+  /** @internal */
+  constructor(http) {
+    this.address = new InternalAddressClient(http);
+    this.property = new InternalPropertyClient(http);
+    this.markets = new InternalMarketsClient(http);
+  }
 };
 
 // src/client.ts
@@ -1045,6 +1278,10 @@ var HtAgApiClient = class {
   address;
   /** AI-powered property investment agents. */
   agents;
+  /** Demographics: census medians, business activity, healthcare. */
+  demographics;
+  /** CPI adjustment utilities and RBA cash rate data. */
+  economics;
   /** Sold property search. */
   property;
   /** Market snapshots, advanced queries and time-series trends. */
@@ -1053,6 +1290,8 @@ var HtAgApiClient = class {
   intentHub;
   /** Reference data: localities and LGAs. */
   reference;
+  /** Internal API methods (requires `internal_api` scope). */
+  internal;
   constructor(options) {
     if (!options.apiKey) {
       throw new Error(
@@ -1073,10 +1312,13 @@ var HtAgApiClient = class {
     const http = new HttpClient(config);
     this.address = new AddressClient(http);
     this.agents = new AgentsClient(http);
+    this.demographics = new DemographicsClient(http);
+    this.economics = new EconomicsClient(http);
     this.property = new PropertyClient(http);
     this.markets = new MarketsClient(http);
     this.intentHub = new IntentHubClient(http);
     this.reference = new ReferenceClient(http);
+    this.internal = new InternalNamespace(http);
   }
 };
 // Annotate the CommonJS export names for ESM import in node:
@@ -1084,9 +1326,12 @@ var HtAgApiClient = class {
   AddressClient,
   AgentsClient,
   AuthenticationError,
+  DemographicsClient,
+  EconomicsClient,
   HtAgApiClient,
   HtAgError,
   IntentHubClient,
+  InternalNamespace,
   MarketsClient,
   PropertyClient,
   RateLimitError,