@radiusplus/api-sdk-v2 0.5.0

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

@@ -0,0 +1,57 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+import type { FacilityDetailRoute } from './FacilityDetailRoute.js';
+import type { FacilityFiltersType } from './FacilityFiltersType.js';
+import type { FacilityOverviewType } from './FacilityOverviewType.js';
+import type { GeographyConfig } from './GeographyConfig.js';
+import type { QuotaConfig } from './QuotaConfig.js';
+import type { TimeframeConfig } from './TimeframeConfig.js';
+/**
+ * @description Base configuration with all dimensions optional. Used as the enforce()\nparameter type so that any per-domain config can be passed directly\nvia structural typing.\n
+ * @type object
+*/
+export type ProductConfig = {
+    /**
+     * @description Geography constraints for a product.\n`allowed` lists the permitted geography types.\nFacility-count bounds gate the min/max number of facilities a geography must contain.\nMax radius and drive-time bounds cap centroid-based geography sizes.\nThis is the base schema; domain-specific variants restrict the `allowed` items\nto the domain\'s geography type enum.\n
+     * @type object | undefined
+    */
+    geography?: GeographyConfig;
+    /**
+     * @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 | undefined
+    */
+    timeframe?: TimeframeConfig;
+    /**
+     * @description Unit filter constraints (daily or aggregate config).
+     * @type object | undefined
+    */
+    unitFilters?: {
+        /**
+         * @description Permitted unit filter type values.
+         * @type array | undefined
+        */
+        allowed?: string[];
+    };
+    /**
+     * @description Discriminator for the FacilityFilters union type.
+     * @type string | undefined
+    */
+    facilityFiltersTier?: FacilityFiltersType;
+    /**
+     * @description Allowed facility detail sub-routes (facilityDetails product only).
+     * @type array | undefined
+    */
+    routes?: FacilityDetailRoute[];
+    /**
+     * @description Discriminator for the FacilityOverview union type.
+     * @type string | undefined
+    */
+    overviewType?: FacilityOverviewType;
+    /**
+     * @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/ProductConfig.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/ProductUsage.d.ts

@@ -0,0 +1,32 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+/**
+ * @description Per-product usage counters for the current cycle, paired with the\nconfigured quota for easy client-side comparison. `*Used` are unique\ncache-key counts; `*Limit` mirrors `QuotaConfig.max*` and is\n`null` when the dimension is unconstrained.\n
+ * @type object
+*/
+export type ProductUsage = {
+    /**
+     * @description Unique result keys consumed this cycle.
+     * @minLength 0
+     * @type integer
+    */
+    resultsUsed: number;
+    /**
+     * @description Configured `maxResults`. Null if unconstrained.
+     * @type integer
+    */
+    resultsLimit: number | null;
+    /**
+     * @description Unique query keys consumed this cycle.
+     * @minLength 0
+     * @type integer
+    */
+    queriesUsed: number;
+    /**
+     * @description Configured `maxQueries`. Null if unconstrained.
+     * @type integer
+    */
+    queriesLimit: number | null;
+};

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

@@ -0,0 +1,24 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+export type QuarterlyTimeframeRollupEnum = "quarterly";
+/**
+ * @description Quarterly timeframe with quarterly rollup aggregation
+ * @type object
+*/
+export type QuarterlyTimeframe = {
+    /**
+     * @description Provides data as a quarterly aggregate
+     * @example quarterly
+     * @type string
+    */
+    rollup: QuarterlyTimeframeRollupEnum;
+    /**
+     * @description Format is YYYY-Q[1-4] for single period or YYYY-Q[1-4]/YYYY-Q[1-4] for ranges
+     * @pattern ^\d{4}-Q[1-4](?:/\d{4}-Q[1-4])?$
+     * @example 2025-Q1
+     * @type string
+    */
+    period: string;
+};

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

@@ -0,0 +1,20 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+/**
+ * @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
+*/
+export type QuotaConfig = {
+    /**
+     * @description Maximum unique result keys per cycle. Omit to leave unconstrained.
+     * @type integer | undefined
+    */
+    maxResults?: number;
+    /**
+     * @description Maximum unique query keys per cycle. Omit to leave unconstrained.
+     * @type integer | undefined
+    */
+    maxQueries?: number;
+};

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

@@ -0,0 +1,38 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+import type { ErrorDetailBase } from './ErrorDetailBase.js';
+export type QuotaExceededErrorHttpCodeEnum = 403;
+export type QuotaExceededErrorCodeEnum = "QUOTA_EXCEEDED";
+export type QuotaExceededErrorQuotaTypeEnum = "queries" | "results";
+/**
+ * @description Quota Exceeded error - The subscription\'s usage-cycle quota has been exhausted for this product
+*/
+export type QuotaExceededError = (ErrorDetailBase & {
+    /**
+     * @type number
+    */
+    httpCode: QuotaExceededErrorHttpCodeEnum;
+    /**
+     * @type string
+    */
+    code: QuotaExceededErrorCodeEnum;
+    /**
+     * @description Which quota budget was exhausted - unique query keys or unique result keys
+     * @type string
+    */
+    quotaType: QuotaExceededErrorQuotaTypeEnum;
+    /**
+     * @description Product code whose quota was exhausted (e.g. `marketPricingDaily`)
+     * @type string
+    */
+    product: string;
+    /**
+     * @description ISO-8601 timestamp at which the usage cycle resets and the quota refills
+     *
+     * Format: `date-time`
+     * @type string
+    */
+    resetsAt: string;
+});

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

@@ -0,0 +1,30 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+/**
+ * @description Occupancy data point for a specific period and company.
+ * @type object
+*/
+export type REITOccupancyData = {
+    /**
+     * @description ISO 8601 formatted date (e.g. 2025-Q1)
+     * @example 2025-Q1
+     * @type string
+    */
+    date: string;
+    /**
+     * @description Company name
+     * @example Public Storage
+     * @type string
+    */
+    company: string;
+    /**
+     * @description Occupancy percentage as a decimal (e.g. 0.9013 represents 90.13%)
+     *
+     * Format: `float`
+     * @example 0.9013
+     * @type number
+    */
+    occupancy: number;
+};

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

@@ -0,0 +1,26 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+import type { REITTimeframe } from './REITTimeframe.js';
+import type { USREITGeography } from './USREITGeography.js';
+/**
+ * @description Request body for REIT occupancy endpoints
+ * @type object
+*/
+export type REITOccupancyRequest = {
+    /**
+     * @description Geography object for US REIT endpoints. Limited to Country, UsRegion, and UsCbsa.
+    */
+    geography: USREITGeography;
+    /**
+     * @description Union type for REIT timeframes (restricted to quarterly and yearly only).\nDefines the time period and rollup aggregation level for REIT endpoints.\n
+    */
+    timeframe: REITTimeframe;
+    /**
+     * @description Optional array of company names to filter by
+     * @example Public Storage,Extra Space
+     * @type array | undefined
+    */
+    companies?: string[];
+};

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

@@ -0,0 +1,22 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+import type { REITOccupancyRequest } from './REITOccupancyRequest.js';
+import type { REITOccupancyResponseData } from './REITOccupancyResponseData.js';
+/**
+ * @description Response type for REIT occupancy endpoints
+ * @type object
+*/
+export type REITOccupancyResponse = {
+    /**
+     * @description Echo of the original request
+     * @type object
+    */
+    request: REITOccupancyRequest;
+    /**
+     * @description Occupancy data payload
+     * @type object
+    */
+    data: REITOccupancyResponseData;
+};

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

@@ -0,0 +1,16 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+import type { REITOccupancyData } from './REITOccupancyData.js';
+/**
+ * @description Data payload for REIT occupancy responses.
+ * @type object
+*/
+export type REITOccupancyResponseData = {
+    /**
+     * @description Array of occupancy data points
+     * @type array
+    */
+    occupancy: REITOccupancyData[];
+};

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

@@ -0,0 +1,30 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+import type { QuarterlyTimeframe } from './QuarterlyTimeframe.js';
+import type { YearlyTimeframe } from './YearlyTimeframe.js';
+/**
+ * @description Union type for REIT timeframes (restricted to quarterly and yearly only).\nDefines the time period and rollup aggregation level for REIT endpoints.\n
+*/
+export type REITTimeframe = (((QuarterlyTimeframe & {
+    /**
+     * @type string
+    */
+    rollup: "quarterly";
+}) | (YearlyTimeframe & {
+    /**
+     * @type string
+    */
+    rollup: "yearly";
+})) & {
+    /**
+     * @description ISO-8601 formatted value. Can be a single period or a range (e.g., \"2025-Q1\" or \"2025-Q1/2025-Q2\")
+     * @type string
+    */
+    period: string;
+    /**
+     * @type string
+    */
+    rollup: string;
+});

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

@@ -0,0 +1,26 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+import type { ErrorDetailBase } from './ErrorDetailBase.js';
+export type RateLimitedErrorHttpCodeEnum = 429;
+export type RateLimitedErrorCodeEnum = "RATE_LIMITED";
+/**
+ * @description Rate Limited error - Too many requests, try again later
+*/
+export type RateLimitedError = (ErrorDetailBase & {
+    /**
+     * @type number
+    */
+    httpCode: RateLimitedErrorHttpCodeEnum;
+    /**
+     * @type string
+    */
+    code: RateLimitedErrorCodeEnum;
+    /**
+     * @description Unix timestamp when the rate limit resets
+     * @example 1702857600
+     * @type integer | undefined
+    */
+    retryAfter?: number;
+});

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

@@ -0,0 +1,5 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+export type RollupType = "daily" | "weekly" | "monthly" | "quarterly" | "yearly" | "last12Months" | "last24Months" | "last30Days";

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

@@ -0,0 +1,72 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+import type { ErrorResponse } from './ErrorResponse.js';
+import type { FacilitiesSearchRequest } from './FacilitiesSearchRequest.js';
+import type { FacilitiesSearchResponse } from './FacilitiesSearchResponse.js';
+/**
+ * @description Response from POST /facilities/search.\nReturns a paginated list of facilities matching the search criteria.\n
+ * @type object
+*/
+export type SearchFacilitiesStatus200 = FacilitiesSearchResponse;
+/**
+ * @description Standard error response wrapper for all API errors
+ * @type object
+*/
+export type SearchFacilitiesStatus400 = ErrorResponse;
+/**
+ * @description Standard error response wrapper for all API errors
+ * @type object
+*/
+export type SearchFacilitiesStatus401 = ErrorResponse;
+/**
+ * @description Standard error response wrapper for all API errors
+ * @type object
+*/
+export type SearchFacilitiesStatus403 = ErrorResponse;
+/**
+ * @description Standard error response wrapper for all API errors
+ * @type object
+*/
+export type SearchFacilitiesStatus422 = ErrorResponse;
+/**
+ * @description Standard error response wrapper for all API errors
+ * @type object
+*/
+export type SearchFacilitiesStatus429 = ErrorResponse;
+/**
+ * @description Standard error response wrapper for all API errors
+ * @type object
+*/
+export type SearchFacilitiesStatus500 = ErrorResponse;
+/**
+ * @description Request body for POST /facilities/search.\nSearches for facilities within a geography with optional unit and facility filters.\n
+ * @type object
+*/
+export type SearchFacilitiesData = FacilitiesSearchRequest;
+/**
+ * @type object
+*/
+export type SearchFacilitiesRequestConfig = {
+    body: SearchFacilitiesData;
+    path?: never;
+    query?: never;
+    headers?: never;
+};
+/**
+ * @type object
+*/
+export type SearchFacilitiesResponses = {
+    "200": SearchFacilitiesStatus200;
+    "400": SearchFacilitiesStatus400;
+    "401": SearchFacilitiesStatus401;
+    "403": SearchFacilitiesStatus403;
+    "422": SearchFacilitiesStatus422;
+    "429": SearchFacilitiesStatus429;
+    "500": SearchFacilitiesStatus500;
+};
+/**
+ * @description Union of all possible responses
+*/
+export type SearchFacilitiesResponse = (SearchFacilitiesStatus200 | SearchFacilitiesStatus400 | SearchFacilitiesStatus401 | SearchFacilitiesStatus403 | SearchFacilitiesStatus422 | SearchFacilitiesStatus429 | SearchFacilitiesStatus500);

package/src/_generated/types/SearchFacilities.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/SearchGeography.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 facility search queries. Restricted to area geography types\n(excludes point geographies like latLng, usAddress, usStructuredAddress).\n
+*/
+export type SearchGeography = (((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/SearchGeography.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/SearchGeographyConfig.d.ts

@@ -0,0 +1,36 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+import type { SearchGeographyType } from './SearchGeographyType.js';
+/**
+ * @description Geography constraints for facility search products.\nAllowed values restricted to SearchGeographyType.\n
+ * @type object
+*/
+export type SearchGeographyConfig = {
+    /**
+     * @description Permitted geography types for facility search.
+     * @type array
+    */
+    allowed: SearchGeographyType[];
+    /**
+     * @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;
+};