@radiusplus/api-sdk-v2 0.5.0

package/src/_generated/types/BasicAggregateUnitFilters.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/BasicDailyUnitFilters.d.ts

@@ -0,0 +1,16 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+import type { DailyUnitFiltersBase } from './DailyUnitFiltersBase.js';
+export type BasicDailyUnitFiltersTypeEnum = "basicDailyUnitFilters";
+/**
+ * @description Basic daily unit filters. Supports unit size and feature filtering only.\nAll filters are optional and combined with AND logic.\n
+*/
+export type BasicDailyUnitFilters = (DailyUnitFiltersBase & {
+    /**
+     * @description Filter type identifier
+     * @type string | undefined
+    */
+    type?: BasicDailyUnitFiltersTypeEnum;
+});

package/src/_generated/types/BasicDailyUnitFilters.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/BasicFacilityFilters.d.ts

@@ -0,0 +1,16 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+import type { FacilityFiltersBase } from './FacilityFiltersBase.js';
+export type BasicFacilityFiltersTypeEnum = "basic";
+/**
+ * @description Basic facility filters. All filters are optional and combined with AND logic.\n
+*/
+export type BasicFacilityFilters = (FacilityFiltersBase & {
+    /**
+     * @description Filter tier identifier, must be \"basic\"
+     * @type string | undefined
+    */
+    type?: BasicFacilityFiltersTypeEnum;
+});

package/src/_generated/types/BasicFacilityFilters.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/BasicSupplyFacilityFilters.d.ts

@@ -0,0 +1,16 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+import type { SupplyFacilityFiltersBase } from './SupplyFacilityFiltersBase.js';
+export type BasicSupplyFacilityFiltersTypeEnum = "basic";
+/**
+ * @description Basic supply facility filters. All filters are optional and combined with AND logic.\n
+*/
+export type BasicSupplyFacilityFilters = (SupplyFacilityFiltersBase & {
+    /**
+     * @description Filter tier identifier, must be \"basic\"
+     * @type string | undefined
+    */
+    type?: BasicSupplyFacilityFiltersTypeEnum;
+});

package/src/_generated/types/BasicSupplyFacilityFilters.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/CentroidGeographyType.d.ts

@@ -0,0 +1,5 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+export type CentroidGeographyType = "latLngRadius" | "latLngDriveTime" | "usAddressRadius" | "usAddressDriveTime" | "usStructuredAddressRadius" | "usStructuredAddressDriveTime";

package/src/_generated/types/CentroidGeographyType.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/ClimateTypeFeature.d.ts

@@ -0,0 +1,5 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+export type ClimateTypeFeature = "climateControlled" | "nonClimateControlled" | "humidityControlled" | "noDistinction";

package/src/_generated/types/ClimateTypeFeature.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/Country.d.ts

@@ -0,0 +1,21 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+export type CountryTypeEnum = "country";
+/**
+ * @type object
+*/
+export type Country = {
+    /**
+     * @description Geography type identifier, must be \"country\"
+     * @type string
+    */
+    type: CountryTypeEnum;
+    /**
+     * @description ISO country code (e.g., \"US\" for United States)
+     * @example US
+     * @type string
+    */
+    country: string;
+};

package/src/_generated/types/Country.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/CurrentUsageResponse.d.ts

@@ -0,0 +1,63 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+import type { CycleWindow } from './CycleWindow.js';
+import type { ProductUsage } from './ProductUsage.js';
+import type { UsageCycle } from './UsageCycle.js';
+/**
+ * @description Response from GET /usage/current.\nEach product key is always present; `null` means no access (mirrors\n`UsagePolicyResponse`). `usageCycle` echoes the subscription policy;\n`cycleWindow` is the resolved window the counters apply to.\n
+ * @type object
+*/
+export type CurrentUsageResponse = {
+    /**
+     * @description Usage cycle definition for the subscription. Determines when per-cycle\nquota budgets (maxQueries, maxResults) reset.\n
+     * @type object
+    */
+    usageCycle: UsageCycle;
+    /**
+     * @description Concrete start/end of the current usage cycle, derived from\n`UsageCycle.period` and `UsageCycle.anchor`. `start` is inclusive,\n`end` is exclusive (the next cycle\'s start).\n
+     * @type object
+    */
+    cycleWindow: CycleWindow;
+    /**
+     * @description Facility daily pricing usage. Null if no access.
+     * @type object
+    */
+    facilityPricingDaily: ProductUsage | null;
+    /**
+     * @description Facility historical pricing usage. Null if no access.
+     * @type object
+    */
+    facilityPricingHistorical: ProductUsage | null;
+    /**
+     * @description Market daily pricing usage. Null if no access.
+     * @type object
+    */
+    marketPricingDaily: ProductUsage | null;
+    /**
+     * @description Market historical pricing usage. Null if no access.
+     * @type object
+    */
+    marketPricingHistorical: ProductUsage | null;
+    /**
+     * @description Facility search usage. Null if no access.
+     * @type object
+    */
+    search: ProductUsage | null;
+    /**
+     * @description Supply metrics usage. Null if no access.
+     * @type object
+    */
+    supply: ProductUsage | null;
+    /**
+     * @description Demographics usage. Null if no access.
+     * @type object
+    */
+    demographics: ProductUsage | null;
+    /**
+     * @description Facility details usage. Null if no access.
+     * @type object
+    */
+    facilityDetails: ProductUsage | null;
+};

package/src/_generated/types/CurrentUsageResponse.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/CursorExpiredError.d.ts

@@ -0,0 +1,20 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+import type { ErrorDetailBase } from './ErrorDetailBase.js';
+export type CursorExpiredErrorHttpCodeEnum = 410;
+export type CursorExpiredErrorCodeEnum = "CURSOR_EXPIRED";
+/**
+ * @description Cursor Expired error - The pagination cursor has expired
+*/
+export type CursorExpiredError = (ErrorDetailBase & {
+    /**
+     * @type number
+    */
+    httpCode: CursorExpiredErrorHttpCodeEnum;
+    /**
+     * @type string
+    */
+    code: CursorExpiredErrorCodeEnum;
+});

package/src/_generated/types/CursorExpiredError.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/CycleWindow.d.ts

@@ -0,0 +1,24 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+/**
+ * @description Concrete start/end of the current usage cycle, derived from\n`UsageCycle.period` and `UsageCycle.anchor`. `start` is inclusive,\n`end` is exclusive (the next cycle\'s start).\n
+ * @type object
+*/
+export type CycleWindow = {
+    /**
+     * @description Inclusive start of the current cycle (ISO 8601 YYYY-MM-DD).
+     *
+     * Format: `date`
+     * @type string
+    */
+    start: string;
+    /**
+     * @description Exclusive end of the current cycle, equal to the next cycle\'s start (ISO 8601 YYYY-MM-DD).
+     *
+     * Format: `date`
+     * @type string
+    */
+    end: string;
+};

package/src/_generated/types/CycleWindow.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/DailyPriceEntry.d.ts

@@ -0,0 +1,25 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+import type { PricingType } from './PricingType.js';
+/**
+ * @description A single price observation for one pricing type on one day.\n
+ * @type object
+*/
+export type DailyPriceEntry = {
+    /**
+     * @description Which pricing channel this observation comes from
+     * @example web
+     * @type string
+    */
+    pricingType: PricingType;
+    /**
+     * @description Daily price for the unit under this pricing type
+     *
+     * Format: `float`
+     * @example 97
+     * @type number
+    */
+    price: number;
+};

package/src/_generated/types/DailyPriceEntry.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/DailyPricing.d.ts

@@ -0,0 +1,70 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+import type { DailyPriceEntry } from './DailyPriceEntry.js';
+import type { UnitFeature } from './UnitFeature.js';
+import type { UnitStatus } from './UnitStatus.js';
+/**
+ * @description Represents pricing data for a specific date and unit. All available pricing\ntypes for this unit on this date are collected in the `prices` array.\npromoText and sourceUrl are unit-level fields (not per-price).\n
+ * @type object
+*/
+export type DailyPricing = {
+    /**
+     * @description ISO-8601 date string
+     *
+     * Format: `date`
+     * @example 2024-01-15
+     * @type string
+    */
+    date: string;
+    /**
+     * @description Unique identifier for the storage unit
+     * @example 12345
+     * @type integer
+    */
+    unitId: number;
+    /**
+     * @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 Availability status of the unit
+     * @example available
+     * @type string
+    */
+    unitStatus: UnitStatus;
+    /**
+     * @description Promotional text or offer for the unit (e.g., \"1st Month Free\")
+     * @example 1st Month Free
+     * @type string
+    */
+    promoText: string;
+    /**
+     * @description URL to the source listing for this unit
+     *
+     * Format: `uri`
+     * @example https://example.com/units/5x5
+     * @type string
+    */
+    sourceUrl: string;
+    /**
+     * @description Price observations for each available pricing type
+     * @type array
+    */
+    prices: DailyPriceEntry[];
+    /**
+     * @description Currency code (e.g., \"USD\")
+     * @example USD
+     * @type string
+    */
+    currency: string;
+};

package/src/_generated/types/DailyPricing.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/DailyTimeframe.d.ts

@@ -0,0 +1,24 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+export type DailyTimeframeRollupEnum = "daily";
+/**
+ * @description Daily timeframe with daily rollup aggregation
+ * @type object
+*/
+export type DailyTimeframe = {
+    /**
+     * @description Provides data as a daily aggregate
+     * @example daily
+     * @type string
+    */
+    rollup: DailyTimeframeRollupEnum;
+    /**
+     * @description Format is YYYY-MM-DD for single period or YYYY-MM-DD/YYYY-MM-DD for ranges
+     * @pattern ^\d{4}-\d{2}-\d{2}(?:/\d{4}-\d{2}-\d{2})?$
+     * @example 2025-10-13
+     * @type string
+    */
+    period: string;
+};

package/src/_generated/types/DailyTimeframe.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/DailyTimeframeConfig.d.ts

@@ -0,0 +1,27 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+export type DailyTimeframeConfigRollupsDaily = "unlimited";
+/**
+ * @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
+*/
+export type DailyTimeframeConfig = {
+    /**
+     * @description Must contain exactly a `daily` key whose value is the maximum\nrange in days, or `\"unlimited\"` for no range cap.\n
+     * @type object
+    */
+    rollups: {
+        /**
+         * @description Maximum range in days for the daily rollup, or\n`\"unlimited\"` for no range cap.\n
+        */
+        daily: (number | DailyTimeframeConfigRollupsDaily);
+    };
+    /**
+     * @description When true, the requested timeframe window must be anchored to today (i.e. the period must include the current date). Lower-tier users are typically restricted to recent data only.\n
+     * @default true
+     * @type boolean
+    */
+    restrictToRecent: boolean;
+};

package/src/_generated/types/DailyTimeframeConfig.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/DailyUnitFilters.d.ts

@@ -0,0 +1,26 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+import type { BasicDailyUnitFilters } from './BasicDailyUnitFilters.js';
+import type { ProDailyUnitFilters } from './ProDailyUnitFilters.js';
+/**
+ * @description Union of daily unit filter variants. Discriminated by the type field.\n
+*/
+export type DailyUnitFilters = (((BasicDailyUnitFilters & {
+    /**
+     * @type string
+    */
+    type: "basicDailyUnitFilters";
+}) | (ProDailyUnitFilters & {
+    /**
+     * @type string
+    */
+    type: "proDailyUnitFilters";
+})) & {
+    /**
+     * @description The type of daily unit filter
+     * @type string
+    */
+    type: string;
+});

package/src/_generated/types/DailyUnitFilters.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/DailyUnitFiltersBase.d.ts

@@ -0,0 +1,19 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+import type { DailyUnitFiltersType } from './DailyUnitFiltersType.js';
+import type { UnitFiltersCommon } from './UnitFiltersCommon.js';
+export type DailyUnitFiltersBase = (UnitFiltersCommon & {
+    /**
+     * @description The type of daily unit filter
+     * @type string
+    */
+    type: DailyUnitFiltersType;
+} & {
+    /**
+     * @description The type of daily unit filter
+     * @type string
+    */
+    type: DailyUnitFiltersType;
+});

package/src/_generated/types/DailyUnitFiltersBase.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/DailyUnitFiltersConfig.d.ts

@@ -0,0 +1,16 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+import type { DailyUnitFiltersType } from './DailyUnitFiltersType.js';
+/**
+ * @description Unit filter constraints for daily endpoints.\n`allowed` lists the permitted DailyUnitFiltersType values.\n
+ * @type object
+*/
+export type DailyUnitFiltersConfig = {
+    /**
+     * @description Permitted daily unit filter types for this product.
+     * @type array
+    */
+    allowed: DailyUnitFiltersType[];
+};

package/src/_generated/types/DailyUnitFiltersConfig.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/DailyUnitFiltersType.d.ts

@@ -0,0 +1,5 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+export type DailyUnitFiltersType = "basicDailyUnitFilters" | "proDailyUnitFilters";

package/src/_generated/types/DailyUnitFiltersType.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/DataSource.d.ts

@@ -0,0 +1,5 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+export type DataSource = "esri" | "census";

package/src/_generated/types/DataSource.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/Demographics.d.ts

@@ -0,0 +1,20 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+import type { UsCensusDemographics } from './UsCensusDemographics.js';
+import type { UsEsriDemographics } from './UsEsriDemographics.js';
+/**
+ * @description Union type for all demographic data variants, discriminated by the type field
+*/
+export type Demographics = ((UsEsriDemographics & {
+    /**
+     * @type string
+    */
+    type: "usEsri";
+}) | (UsCensusDemographics & {
+    /**
+     * @type string
+    */
+    type: "usCensus";
+}));

package/src/_generated/types/Demographics.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/DemographicsAvailability.d.ts

@@ -0,0 +1,23 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+import type { DataSource } from './DataSource.js';
+/**
+ * @description Available demographic reference years for a single data source
+ * @type object
+*/
+export type DemographicsAvailability = {
+    /**
+     * @description Data source the years apply to
+     * @example esri
+     * @type string
+    */
+    dataSource: DataSource;
+    /**
+     * @description Sorted list of available reference years
+     * @example 2021,2022,2023,2024
+     * @type array
+    */
+    years: number[];
+};

package/src/_generated/types/DemographicsAvailability.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/DemographicsAvailabilityRequest.d.ts

@@ -0,0 +1,15 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+import type { DemographicsGeography } from './DemographicsGeography.js';
+/**
+ * @description Request for the demographics/availability endpoint
+ * @type object
+*/
+export type DemographicsAvailabilityRequest = {
+    /**
+     * @description Geography to query available demographic years for
+    */
+    geography: DemographicsGeography;
+};