@radiusplus/api-sdk-v2 0.5.0

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

@@ -0,0 +1,26 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+import type { UsSupplyMetrics } from './UsSupplyMetrics.js';
+/**
+ * @description The measurement of each metric: its current value, absolute change from the\nprior period, and percentage change from the prior period.\n
+ * @type object
+*/
+export type UsSupplyMeasures = {
+    /**
+     * @description The metric as of the period end
+     * @type object
+    */
+    value: UsSupplyMetrics;
+    /**
+     * @description Absolute difference from the prior period. Omitted when there is no prior period to compare against.
+     * @type object | undefined
+    */
+    change?: UsSupplyMetrics;
+    /**
+     * @description Percentage change as a decimal (e.g. 0.05 = 5%). Omitted when there is no prior period to compare against.
+     * @type object | undefined
+    */
+    changePct?: UsSupplyMetrics;
+};

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

@@ -0,0 +1,65 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+/**
+ * @description The individual metrics tracked for supply data.\nAll area values are in imperial units (square feet).\n
+ * @type object
+*/
+export type UsSupplyMetrics = {
+    /**
+     * @description Number of facilities
+     * @type number
+    */
+    facilityCount: number;
+    /**
+     * @description Total net rentable square footage
+     * @type number
+    */
+    totalNrSqFt: number;
+    /**
+     * @description Total net rentable square footage (climate controlled)
+     * @type number
+    */
+    totalNrSqFtCc: number;
+    /**
+     * @description Total net rentable square footage (non-climate controlled)
+     * @type number
+    */
+    totalNrSqFtNcc: number;
+    /**
+     * @description Number of unique operators
+     * @type number
+    */
+    operatorCount: number;
+    /**
+     * @description Square footage per capita
+     * @type number
+    */
+    sqftPerCapita: number;
+    /**
+     * @description Square footage per household
+     * @type number
+    */
+    sqftPerHousehold: number;
+    /**
+     * @description Climate-controlled square footage per capita
+     * @type number
+    */
+    ccSqftPerCapita: number;
+    /**
+     * @description Non-climate-controlled square footage per capita
+     * @type number
+    */
+    nccSqftPerCapita: number;
+    /**
+     * @description Climate-controlled square footage per household
+     * @type number
+    */
+    ccSqftPerHousehold: number;
+    /**
+     * @description Non-climate-controlled square footage per household
+     * @type number
+    */
+    nccSqftPerHousehold: number;
+};

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

@@ -0,0 +1,21 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+export type UsZipcodeTypeEnum = "usZipcode";
+/**
+ * @type object
+*/
+export type UsZipcode = {
+    /**
+     * @description Geography type identifier, must be \"usZipcode\"
+     * @type string
+    */
+    type: UsZipcodeTypeEnum;
+    /**
+     * @description Five-digit US ZIP code
+     * @example 90210
+     * @type string
+    */
+    zipcode: string;
+};

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

@@ -0,0 +1,23 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+export type UsageCyclePeriodEnum = "monthly" | "yearly";
+/**
+ * @description Usage cycle definition for the subscription. Determines when per-cycle\nquota budgets (maxQueries, maxResults) reset.\n
+ * @type object
+*/
+export type UsageCycle = {
+    /**
+     * @description The time window over which usage is metered.
+     * @type string
+    */
+    period: UsageCyclePeriodEnum;
+    /**
+     * @description Fixed date from which cycle boundaries are derived (ISO 8601 YYYY-MM-DD).
+     *
+     * Format: `date`
+     * @type string
+    */
+    anchor: string;
+};

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

@@ -0,0 +1,70 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+import type { DemographicsProductConfig } from './DemographicsProductConfig.js';
+import type { FacilityDetailsProductConfig } from './FacilityDetailsProductConfig.js';
+import type { FacilityPricingDailyProductConfig } from './FacilityPricingDailyProductConfig.js';
+import type { FacilityPricingHistoricalProductConfig } from './FacilityPricingHistoricalProductConfig.js';
+import type { MarketPricingDailyProductConfig } from './MarketPricingDailyProductConfig.js';
+import type { MarketPricingHistoricalProductConfig } from './MarketPricingHistoricalProductConfig.js';
+import type { SearchProductConfig } from './SearchProductConfig.js';
+import type { SupplyProductConfig } from './SupplyProductConfig.js';
+import type { UsageCycle } from './UsageCycle.js';
+/**
+ * @description Response from GET /usage.\nEach product key is always present; null means no access.\nProducts carry full dimension enforcement (geography, timeframe,\nunit filters) as applicable.\n
+ * @type object
+*/
+export type UsagePolicyResponse = {
+    /**
+     * @description Maximum API requests allowed per minute for this user. Used by the rate limiter.
+     * @example 100
+     * @type integer
+    */
+    requestsPerMinuteLimit: number;
+    /**
+     * @description Usage cycle definition for the subscription. Determines when per-cycle\nquota budgets (maxQueries, maxResults) reset.\n
+     * @type object
+    */
+    usageCycle: UsageCycle;
+    /**
+     * @description Facility daily pricing product config. Null if no access.
+     * @type object
+    */
+    facilityPricingDaily: FacilityPricingDailyProductConfig | null;
+    /**
+     * @description Facility historical pricing product config. Null if no access.
+     * @type object
+    */
+    facilityPricingHistorical: FacilityPricingHistoricalProductConfig | null;
+    /**
+     * @description Market daily pricing product config. Null if no access.
+     * @type object
+    */
+    marketPricingDaily: MarketPricingDailyProductConfig | null;
+    /**
+     * @description Market historical pricing product config. Null if no access.
+     * @type object
+    */
+    marketPricingHistorical: MarketPricingHistoricalProductConfig | null;
+    /**
+     * @description Facility search product config. Null if no access.
+     * @type object
+    */
+    search: SearchProductConfig | null;
+    /**
+     * @description Supply metrics product config. Null if no access.
+     * @type object
+    */
+    supply: SupplyProductConfig | null;
+    /**
+     * @description Demographics product config. Null if no access.
+     * @type object
+    */
+    demographics: DemographicsProductConfig | null;
+    /**
+     * @description Facility details product config. Null if no access.
+     * @type object
+    */
+    facilityDetails: FacilityDetailsProductConfig | null;
+};

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

@@ -0,0 +1,28 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+import type { ErrorDetailBase } from './ErrorDetailBase.js';
+export type ValidationErrorHttpCodeEnum = 422;
+export type ValidationErrorCodeEnum = "VALIDATION_ERROR";
+/**
+ * @description Validation Error - Request validation failed with field-level details
+*/
+export type ValidationError = (ErrorDetailBase & {
+    /**
+     * @type number
+    */
+    httpCode: ValidationErrorHttpCodeEnum;
+    /**
+     * @type string
+    */
+    code: ValidationErrorCodeEnum;
+    /**
+     * @description Field-level error details (field path to error message)
+     * @example [object Object]
+     * @type object | undefined
+    */
+    details?: {
+        [key: string]: string;
+    };
+});

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

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

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

@@ -0,0 +1,21 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+import type { WarningCode } from './WarningCode.js';
+/**
+ * @description A single warning returned inside a success response
+ * @type object
+*/
+export type WarningResponse = {
+    /**
+     * @description Machine-readable warning codes used in success responses
+     * @type string
+    */
+    code: WarningCode;
+    /**
+     * @description Human-readable warning message
+     * @type string
+    */
+    message: string;
+};

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

@@ -0,0 +1,24 @@
+/**
+* Generated by Kubb (https://kubb.dev/).
+* Do not edit manually.
+*/
+export type WeeklyTimeframeRollupEnum = "weekly";
+/**
+ * @description Weekly timeframe with weekly rollup aggregation
+ * @type object
+*/
+export type WeeklyTimeframe = {
+    /**
+     * @description Provides data as a weekly aggregate
+     * @example weekly
+     * @type string
+    */
+    rollup: WeeklyTimeframeRollupEnum;
+    /**
+     * @description Format is YYYY-W## (ISO week format) for single period or YYYY-W##/YYYY-W## for ranges
+     * @pattern ^\d{4}-W(?:0[1-9]|[1-4]\d|5[0-3])(?:/\d{4}-W(?:0[1-9]|[1-4]\d|5[0-3]))?$
+     * @example 2025-W01
+     * @type string
+    */
+    period: string;
+};

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

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

package/src/_generated/types/YearlyTimeframe.js

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