@radiusplus/api-sdk-v2 0.5.0

package/src/_generated/types/Last24MonthsTimeframe.d.ts

@@ -0,0 +1,24 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+export type Last24MonthsTimeframeRollupEnum = "last24Months";
+/**
+ * @description Last24Months timeframe covering the last 24 complete months, returning single values for that entire frame. The window is anchored to today, so `period` is server-computed and returned only in responses.
+ * @type object
+*/
+export type Last24MonthsTimeframe = {
+    /**
+     * @description Provides data as a Last24Months aggregate (last 24 complete months)
+     * @example last24Months
+     * @type string
+    */
+    rollup: Last24MonthsTimeframeRollupEnum;
+    /**
+     * @description Server-resolved window in YYYY-MM/YYYY-MM format. Present in responses only; clients must not send this.
+     * @pattern ^\d{4}-(?:0[1-9]|1[0-2])/\d{4}-(?:0[1-9]|1[0-2])$
+     * @example 2023-01/2024-12
+     * @type string | undefined
+    */
+    readonly period?: string;
+};

package/src/_generated/types/Last24MonthsTimeframe.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/_generated/types/Last30DaysTimeframe.d.ts

@@ -0,0 +1,24 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+export type Last30DaysTimeframeRollupEnum = "last30Days";
+/**
+ * @description Last30Days timeframe covering the last 30 complete days, returning single values for that entire frame. The window is anchored to today, so `period` is server-computed and returned only in responses.
+ * @type object
+*/
+export type Last30DaysTimeframe = {
+    /**
+     * @description Provides data as a Last30Days aggregate (last 30 complete days)
+     * @example last30Days
+     * @type string
+    */
+    rollup: Last30DaysTimeframeRollupEnum;
+    /**
+     * @description Server-resolved window in YYYY-MM-DD/YYYY-MM-DD format. Present in responses only; clients must not send this.
+     * @pattern ^\d{4}-\d{2}-\d{2}/\d{4}-\d{2}-\d{2}$
+     * @example 2024-12-01/2024-12-30
+     * @type string | undefined
+    */
+    readonly period?: string;
+};

package/src/_generated/types/Last30DaysTimeframe.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/_generated/types/LatLng.d.ts

@@ -0,0 +1,21 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+import type { LatLngCoordinates } from './LatLngCoordinates.js';
+export type LatLngTypeEnum = "latLng";
+/**
+ * @type object
+*/
+export type LatLng = {
+    /**
+     * @description Geography type identifier, must be \"latLng\"
+     * @type string
+    */
+    type: LatLngTypeEnum;
+    /**
+     * @description Geographic coordinates representing a point on Earth
+     * @type object
+    */
+    coordinates: LatLngCoordinates;
+};

package/src/_generated/types/LatLng.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/_generated/types/LatLngCoordinates.d.ts

@@ -0,0 +1,26 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+/**
+ * @description Geographic coordinates representing a point on Earth
+ * @type object
+*/
+export type LatLngCoordinates = {
+    /**
+     * @description Latitude coordinate (-90 to 90)
+     * @minLength -90
+     * @maxLength 90
+     * @example 27.9506
+     * @type number
+    */
+    lat: number;
+    /**
+     * @description Longitude coordinate (-180 to 180)
+     * @minLength -180
+     * @maxLength 180
+     * @example -82.4572
+     * @type number
+    */
+    lng: number;
+};

package/src/_generated/types/LatLngCoordinates.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/_generated/types/LatLngDriveTime.d.ts

@@ -0,0 +1,27 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+import type { Distance } from './Distance.js';
+import type { LatLngCoordinates } from './LatLngCoordinates.js';
+export type LatLngDriveTimeTypeEnum = "latLngDriveTime";
+/**
+ * @type object
+*/
+export type LatLngDriveTime = {
+    /**
+     * @description Geography type identifier, must be \"latLngDriveTime\"
+     * @type string
+    */
+    type: LatLngDriveTimeTypeEnum;
+    /**
+     * @description Geographic coordinates representing a point on Earth
+     * @type object
+    */
+    coordinates: LatLngCoordinates;
+    /**
+     * @description Maximum drive time for the search area
+     * @type object
+    */
+    driveTime: Distance;
+};

package/src/_generated/types/LatLngDriveTime.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/_generated/types/LatLngRadius.d.ts

@@ -0,0 +1,27 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+import type { Distance } from './Distance.js';
+import type { LatLngCoordinates } from './LatLngCoordinates.js';
+export type LatLngRadiusTypeEnum = "latLngRadius";
+/**
+ * @type object
+*/
+export type LatLngRadius = {
+    /**
+     * @description Geography type identifier, must be \"latLngRadius\"
+     * @type string
+    */
+    type: LatLngRadiusTypeEnum;
+    /**
+     * @description Geographic coordinates representing a point on Earth
+     * @type object
+    */
+    coordinates: LatLngCoordinates;
+    /**
+     * @description Distance for the radius search
+     * @type object
+    */
+    distance: Distance;
+};

package/src/_generated/types/LatLngRadius.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/_generated/types/Location.d.ts

@@ -0,0 +1,22 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+import type { LatLngCoordinates } from './LatLngCoordinates.js';
+/**
+ * @description A resolved geographic location — a human-readable address paired with its coordinates.
+ * @type object
+*/
+export type Location = {
+    /**
+     * @description Human-readable address string
+     * @example 234 Main St, Sarasota, FL 34231
+     * @type string
+    */
+    address: string;
+    /**
+     * @description Geographic coordinates representing a point on Earth
+     * @type object
+    */
+    coordinates: LatLngCoordinates;
+};

package/src/_generated/types/Location.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/_generated/types/MarketAggregatePricing.d.ts

@@ -0,0 +1,56 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+import type { AggregatePriceEntry } from './AggregatePriceEntry.js';
+import type { FacilityFeature } from './FacilityFeature.js';
+import type { UnitFeature } from './UnitFeature.js';
+/**
+ * @description Market-level aggregated pricing statistics. Excludes unit-specific identifiers\n(unitId) since market data represents aggregates across multiple\nfacilities and units. All available pricing types are collected in the `prices` array.\n
+ * @type object
+*/
+export type MarketAggregatePricing = {
+    /**
+     * @description ISO-8601 date string, describing a single unit of time. It will match the format of the requested timeframe
+     * @example 2025-Q1
+     * @type string
+    */
+    date: string;
+    /**
+     * @description Size of the storage unit (e.g., \"5x5\", \"10x10\")
+     * @example 5x5
+     * @type string
+    */
+    unitSize: string;
+    /**
+     * @description Array of unit features (e.g., \"climateControlled\", \"firstFloor\")
+     * @example climateControlled,firstFloor
+     * @type array
+    */
+    unitFeatures: UnitFeature[];
+    /**
+     * @description Array of facility-level features (e.g., \"videoMonitoring\", \"electronicGate\")
+     * @example videoMonitoring,electronicGate
+     * @type array
+    */
+    facilityFeatures: FacilityFeature[];
+    /**
+     * @description Fraction of the rollup period the unit was available (0–1)
+     *
+     * Format: `float`
+     * @example 0.85
+     * @type number
+    */
+    unitAvailabilityPct: number;
+    /**
+     * @description Aggregate statistics for each available pricing type
+     * @type array
+    */
+    prices: AggregatePriceEntry[];
+    /**
+     * @description Currency code (e.g., \"USD\")
+     * @example USD
+     * @type string
+    */
+    currency: string;
+};

package/src/_generated/types/MarketAggregatePricing.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/_generated/types/MarketPricingDailyProductConfig.d.ts

@@ -0,0 +1,34 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+import type { DailyTimeframeConfig } from './DailyTimeframeConfig.js';
+import type { MarketPricingGeographyConfig } from './MarketPricingGeographyConfig.js';
+import type { PricingAggregateUnitFiltersConfig } from './PricingAggregateUnitFiltersConfig.js';
+import type { QuotaConfig } from './QuotaConfig.js';
+/**
+ * @description Config for the market daily pricing product.\nDimensions: geography, timeframe (daily only), unitFilters, quota.\n
+ * @type object
+*/
+export type MarketPricingDailyProductConfig = {
+    /**
+     * @description Geography constraints for market pricing products.\nAllowed values restricted to MarketPricingGeographyType.\n
+     * @type object
+    */
+    geography: MarketPricingGeographyConfig;
+    /**
+     * @description Timeframe constraints restricted to daily rollup only.\nUsed by daily pricing product configs where the endpoint\nonly accepts DailyTimeframe. The `rollups` map must contain\nexactly the `daily` key.\n
+     * @type object
+    */
+    timeframe: DailyTimeframeConfig;
+    /**
+     * @description Unit filter constraints for aggregate pricing products.\nAllowed values restricted to PricingAggregateUnitFiltersType.\n
+     * @type object
+    */
+    unitFilters: PricingAggregateUnitFiltersConfig;
+    /**
+     * @description Per-product usage budgets measured in unique cache keys per cycle.\nThe cycle length is defined by `UsageCycle.period` (monthly or yearly).\n`maxResults` caps the number of unique result keys (entity + time-slice combinations).\n`maxQueries` caps the number of unique query keys (distinct requests).\nDuplicate requests within the same cycle do not consume budget.\n
+     * @type object
+    */
+    quota: QuotaConfig;
+};

package/src/_generated/types/MarketPricingDailyProductConfig.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/_generated/types/MarketPricingDailyRequest.d.ts

@@ -0,0 +1,32 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+import type { DailyTimeframe } from './DailyTimeframe.js';
+import type { MarketPricingGeography } from './MarketPricingGeography.js';
+import type { PaginationRequest } from './PaginationRequest.js';
+import type { PricingAggregateUnitFilters } from './PricingAggregateUnitFilters.js';
+/**
+ * @description Used to query aggregated daily pricing statistics across an entire market (geographic region).\nOptional filters allow narrowing results by unit sizes and features.\nReturns market-wide aggregates for each day in the timeframe. All pricing variants\n(web, inStore) are always included in each row.\n
+ * @type object
+*/
+export type MarketPricingDailyRequest = {
+    /**
+     * @description Geography object defining the market area to query
+    */
+    geography: MarketPricingGeography;
+    /**
+     * @description Timeframe defining the time period with daily rollup aggregation
+     * @type object
+    */
+    timeframe: DailyTimeframe;
+    /**
+     * @description Optional filters based on unit characteristics
+    */
+    unitFilters?: PricingAggregateUnitFilters;
+    /**
+     * @description Pagination parameters
+     * @type object | undefined
+    */
+    pagination?: PaginationRequest;
+};

package/src/_generated/types/MarketPricingDailyRequest.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/_generated/types/MarketPricingDailyResponse.d.ts

@@ -0,0 +1,33 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+import type { MarketPricingDailyRequest } from './MarketPricingDailyRequest.js';
+import type { MarketPricingResponseData } from './MarketPricingResponseData.js';
+import type { PaginationResponse } from './PaginationResponse.js';
+import type { WarningResponse } from './WarningResponse.js';
+/**
+ * @description Returns aggregated daily pricing statistics for an entire market, combining data from\nall facilities within the geographic region. Provides market-wide aggregates (high, low, average)\nfor each day in the timeframe.\n
+ * @type object
+*/
+export type MarketPricingDailyResponse = {
+    /**
+     * @description Echo of the original request
+     * @type object
+    */
+    request: MarketPricingDailyRequest;
+    /**
+     * @description Market daily pricing data payload
+     * @type object
+    */
+    data: MarketPricingResponseData;
+    /**
+     * @description Pagination metadata in responses
+     * @type object
+    */
+    pagination: PaginationResponse;
+    /**
+     * @type array | undefined
+    */
+    warnings?: WarningResponse[];
+};

package/src/_generated/types/MarketPricingDailyResponse.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/_generated/types/MarketPricingGeography.d.ts

@@ -0,0 +1,109 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+import type { Country } from './Country.js';
+import type { LatLngDriveTime } from './LatLngDriveTime.js';
+import type { LatLngRadius } from './LatLngRadius.js';
+import type { Polygon } from './Polygon.js';
+import type { UsAddressDriveTime } from './UsAddressDriveTime.js';
+import type { UsAddressRadius } from './UsAddressRadius.js';
+import type { UsCbsa } from './UsCbsa.js';
+import type { UsCensusBlockGroup } from './UsCensusBlockGroup.js';
+import type { UsCensusTract } from './UsCensusTract.js';
+import type { UsCity } from './UsCity.js';
+import type { UsCounty } from './UsCounty.js';
+import type { UsRegion } from './UsRegion.js';
+import type { UsState } from './UsState.js';
+import type { UsStructuredAddressDriveTime } from './UsStructuredAddressDriveTime.js';
+import type { UsStructuredAddressRadius } from './UsStructuredAddressRadius.js';
+import type { UsZipcode } from './UsZipcode.js';
+/**
+ * @description Geography for market pricing queries. Restricted to area geography types\n(excludes point geographies like latLng, usAddress, usStructuredAddress).\n
+*/
+export type MarketPricingGeography = (((Country & {
+    /**
+     * @type string
+    */
+    type: "country";
+}) | (Polygon & {
+    /**
+     * @type string
+    */
+    type: "wkt";
+}) | (LatLngRadius & {
+    /**
+     * @type string
+    */
+    type: "latLngRadius";
+}) | (LatLngDriveTime & {
+    /**
+     * @type string
+    */
+    type: "latLngDriveTime";
+}) | (UsRegion & {
+    /**
+     * @type string
+    */
+    type: "usRegion";
+}) | (UsState & {
+    /**
+     * @type string
+    */
+    type: "usState";
+}) | (UsCounty & {
+    /**
+     * @type string
+    */
+    type: "usCounty";
+}) | (UsCbsa & {
+    /**
+     * @type string
+    */
+    type: "usCbsa";
+}) | (UsCity & {
+    /**
+     * @type string
+    */
+    type: "usCity";
+}) | (UsZipcode & {
+    /**
+     * @type string
+    */
+    type: "usZipcode";
+}) | (UsCensusTract & {
+    /**
+     * @type string
+    */
+    type: "usCensusTract";
+}) | (UsCensusBlockGroup & {
+    /**
+     * @type string
+    */
+    type: "usCensusBlockGroup";
+}) | (UsAddressRadius & {
+    /**
+     * @type string
+    */
+    type: "usAddressRadius";
+}) | (UsAddressDriveTime & {
+    /**
+     * @type string
+    */
+    type: "usAddressDriveTime";
+}) | (UsStructuredAddressRadius & {
+    /**
+     * @type string
+    */
+    type: "usStructuredAddressRadius";
+}) | (UsStructuredAddressDriveTime & {
+    /**
+     * @type string
+    */
+    type: "usStructuredAddressDriveTime";
+})) & {
+    /**
+     * @type string
+    */
+    type: string;
+});

package/src/_generated/types/MarketPricingGeography.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/_generated/types/MarketPricingGeographyConfig.d.ts

@@ -0,0 +1,36 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+import type { MarketPricingGeographyType } from './MarketPricingGeographyType.js';
+/**
+ * @description Geography constraints for market pricing products.\nAllowed values restricted to MarketPricingGeographyType.\n
+ * @type object
+*/
+export type MarketPricingGeographyConfig = {
+    /**
+     * @description Permitted geography types for market pricing.
+     * @type array
+    */
+    allowed: MarketPricingGeographyType[];
+    /**
+     * @description Minimum number of facilities the geography must contain. Omit to leave unconstrained.
+     * @type integer | undefined
+    */
+    minFacilityCount?: number;
+    /**
+     * @description Maximum number of facilities the geography may contain. Omit to leave unconstrained.
+     * @type integer | undefined
+    */
+    maxFacilityCount?: number;
+    /**
+     * @description Maximum radius in miles. Omit to leave unconstrained.
+     * @type number | undefined
+    */
+    maxRadiusMiles?: number;
+    /**
+     * @description Maximum drive time in minutes. Omit to leave unconstrained.
+     * @type number | undefined
+    */
+    maxDriveTimeMinutes?: number;
+};

package/src/_generated/types/MarketPricingGeographyConfig.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/_generated/types/MarketPricingGeographyType.d.ts

@@ -0,0 +1,5 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+export type MarketPricingGeographyType = "country" | "wkt" | "latLngRadius" | "latLngDriveTime" | "usRegion" | "usState" | "usCounty" | "usCbsa" | "usCity" | "usZipcode" | "usCensusTract" | "usCensusBlockGroup" | "usAddressRadius" | "usAddressDriveTime" | "usStructuredAddressRadius" | "usStructuredAddressDriveTime";

package/src/_generated/types/MarketPricingGeographyType.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/_generated/types/MarketPricingHistoricalProductConfig.d.ts

@@ -0,0 +1,34 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+import type { MarketPricingGeographyConfig } from './MarketPricingGeographyConfig.js';
+import type { PricingAggregateUnitFiltersConfig } from './PricingAggregateUnitFiltersConfig.js';
+import type { QuotaConfig } from './QuotaConfig.js';
+import type { TimeframeConfig } from './TimeframeConfig.js';
+/**
+ * @description Config for the market historical pricing product.\nDimensions: geography, timeframe, unitFilters, quota.\n
+ * @type object
+*/
+export type MarketPricingHistoricalProductConfig = {
+    /**
+     * @description Geography constraints for market pricing products.\nAllowed values restricted to MarketPricingGeographyType.\n
+     * @type object
+    */
+    geography: MarketPricingGeographyConfig;
+    /**
+     * @description Timeframe constraints for a product.\nKey presence in `rollups` means the rollup is permitted; the value\nis the maximum range in the rollup\'s natural unit (e.g. 30 days, 12 weeks),\nor the string `\"unlimited\"` for no range cap.\n
+     * @type object
+    */
+    timeframe: TimeframeConfig;
+    /**
+     * @description Unit filter constraints for aggregate pricing products.\nAllowed values restricted to PricingAggregateUnitFiltersType.\n
+     * @type object
+    */
+    unitFilters: PricingAggregateUnitFiltersConfig;
+    /**
+     * @description Per-product usage budgets measured in unique cache keys per cycle.\nThe cycle length is defined by `UsageCycle.period` (monthly or yearly).\n`maxResults` caps the number of unique result keys (entity + time-slice combinations).\n`maxQueries` caps the number of unique query keys (distinct requests).\nDuplicate requests within the same cycle do not consume budget.\n
+     * @type object
+    */
+    quota: QuotaConfig;
+};

package/src/_generated/types/MarketPricingHistoricalProductConfig.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });