@opusdns/api 0.167.0 → 0.169.0

package/package.json

@@ -3,7 +3,7 @@
     "@opusdns/api-spec-ts-generator": "^0.19.0"
   },
   "name": "@opusdns/api",
-  "version": "0.167.0",
+  "version": "0.169.0",
   "description": "TypeScript types for the OpusDNS OpenAPI specification",
   "main": "./src/index.ts",
   "module": "./src/index.ts",

package/src/helpers/keys.ts

@@ -157,8 +157,8 @@ import { OrganizationUpdate } from './schemas';
 import { OrganizationWithBillingData } from './schemas';
 import { PaginationMetadata } from './schemas';
 import { ParkingMetrics } from './schemas';
-import { Parking } from './schemas';
 import { ParkingStatistics } from './schemas';
+import { ParkingTotalMetrics } from './schemas';
 import { PasswordUpdate } from './schemas';
 import { Period } from './schemas';
 import { PermissionSet } from './schemas';
@@ -19224,344 +19224,108 @@ export const KEYS_PAGINATION_METADATA = [
 ] as const satisfies (keyof PaginationMetadata)[];
 
 /**
- * Parking Id
+ * metrics property
  *
- * Unique identifier for the parking entry
+ * Metrics for the parking entry
  *
- * @type {string}
  *
  *
  * @remarks
- * This key constant provides type-safe access to the `parking_id` property of ParkingMetrics objects.
+ * This key constant provides type-safe access to the `metrics` property of ParkingMetrics objects.
  * Use this constant when you need to access properties dynamically or ensure type safety.
  *
  * @example
  * ```typescript
  * // Direct property access
- * const value = parkingmetrics[KEY_PARKING_METRICS_PARKING_ID];
+ * const value = parkingmetrics[KEY_PARKING_METRICS_METRICS];
  * 
  * // Dynamic property access
- * const propertyName = KEY_PARKING_METRICS_PARKING_ID;
+ * const propertyName = KEY_PARKING_METRICS_METRICS;
  * const value = parkingmetrics[propertyName];
  * ```
  *
  * @see {@link ParkingMetrics} - The TypeScript type definition
  * @see {@link KEYS_PARKING_METRICS} - Array of all keys for this type
  */
-export const KEY_PARKING_METRICS_PARKING_ID: keyof ParkingMetrics = 'parking_id';
+export const KEY_PARKING_METRICS_METRICS: keyof ParkingMetrics = 'metrics';
 /**
- * statistics property
+ * Renewal Cost
  *
- * Statistics for the parking entry
+ * Yearly renewal cost for the parked domain
  *
+ * @type {string}
  *
  *
  * @remarks
- * This key constant provides type-safe access to the `statistics` property of ParkingMetrics objects.
+ * This key constant provides type-safe access to the `renewal_cost` property of ParkingMetrics objects.
  * Use this constant when you need to access properties dynamically or ensure type safety.
  *
  * @example
  * ```typescript
  * // Direct property access
- * const value = parkingmetrics[KEY_PARKING_METRICS_STATISTICS];
+ * const value = parkingmetrics[KEY_PARKING_METRICS_RENEWAL_COST];
  * 
  * // Dynamic property access
- * const propertyName = KEY_PARKING_METRICS_STATISTICS;
+ * const propertyName = KEY_PARKING_METRICS_RENEWAL_COST;
  * const value = parkingmetrics[propertyName];
  * ```
  *
  * @see {@link ParkingMetrics} - The TypeScript type definition
  * @see {@link KEYS_PARKING_METRICS} - Array of all keys for this type
  */
-export const KEY_PARKING_METRICS_STATISTICS: keyof ParkingMetrics = 'statistics';
-
-/**
- * Array of all ParkingMetrics property keys
- *
- * @remarks
- * This constant provides a readonly array containing all valid property keys for ParkingMetrics objects.
- * Useful for iteration, validation, and generating dynamic UI components.
- *
- * @example
- * ```typescript
- * // Iterating through all keys
- * for (const key of KEYS_PARKING_METRICS) {
- *   console.log(`Property: ${key}, Value: ${parkingmetrics[key]}`);
- * }
- * 
- * // Validation
- * const isValidKey = KEYS_PARKING_METRICS.includes(someKey);
- * ```
- *
- * @see {@link ParkingMetrics} - The TypeScript type definition
- */
-export const KEYS_PARKING_METRICS = [
-  KEY_PARKING_METRICS_PARKING_ID,
-  KEY_PARKING_METRICS_STATISTICS,
-] as const satisfies (keyof ParkingMetrics)[];
-
-/**
- * compliance_status property
- *
- * The compliance status of the parking ad
- *
- *
- *
- * @remarks
- * This key constant provides type-safe access to the `compliance_status` property of Parking objects.
- * Use this constant when you need to access properties dynamically or ensure type safety.
- *
- * @example
- * ```typescript
- * // Direct property access
- * const value = parking[KEY_PARKING_COMPLIANCE_STATUS];
- * 
- * // Dynamic property access
- * const propertyName = KEY_PARKING_COMPLIANCE_STATUS;
- * const value = parking[propertyName];
- * ```
- *
- * @see {@link Parking} - The TypeScript type definition
- * @see {@link KEYS_PARKING} - Array of all keys for this type
- */
-export const KEY_PARKING_COMPLIANCE_STATUS: keyof Parking = 'compliance_status';
-/**
- * Content Language
- *
- * The primary language code for the ad content
- *
- *
- *
- * @remarks
- * This key constant provides type-safe access to the `content_language` property of Parking objects.
- * Use this constant when you need to access properties dynamically or ensure type safety.
- *
- * @example
- * ```typescript
- * // Direct property access
- * const value = parking[KEY_PARKING_CONTENT_LANGUAGE];
- * 
- * // Dynamic property access
- * const propertyName = KEY_PARKING_CONTENT_LANGUAGE;
- * const value = parking[propertyName];
- * ```
- *
- * @see {@link Parking} - The TypeScript type definition
- * @see {@link KEYS_PARKING} - Array of all keys for this type
- */
-export const KEY_PARKING_CONTENT_LANGUAGE: keyof Parking = 'content_language';
-/**
- * Content Url
- *
- * The content URL for approved parking ads
- *
- *
- *
- * @remarks
- * This key constant provides type-safe access to the `content_url` property of Parking objects.
- * Use this constant when you need to access properties dynamically or ensure type safety.
- *
- * @example
- * ```typescript
- * // Direct property access
- * const value = parking[KEY_PARKING_CONTENT_URL];
- * 
- * // Dynamic property access
- * const propertyName = KEY_PARKING_CONTENT_URL;
- * const value = parking[propertyName];
- * ```
- *
- * @see {@link Parking} - The TypeScript type definition
- * @see {@link KEYS_PARKING} - Array of all keys for this type
- */
-export const KEY_PARKING_CONTENT_URL: keyof Parking = 'content_url';
+export const KEY_PARKING_METRICS_RENEWAL_COST: keyof ParkingMetrics = 'renewal_cost';
 /**
- * Created On
+ * Revenue Progress
  *
- * When the parking entry was created
+ * Revenue progress percentage towards covering renewal cost
  *
  * @type {string}
  *
  *
  * @remarks
- * This key constant provides type-safe access to the `created_on` property of Parking objects.
+ * This key constant provides type-safe access to the `revenue_progress` property of ParkingMetrics objects.
  * Use this constant when you need to access properties dynamically or ensure type safety.
  *
  * @example
  * ```typescript
  * // Direct property access
- * const value = parking[KEY_PARKING_CREATED_ON];
+ * const value = parkingmetrics[KEY_PARKING_METRICS_REVENUE_PROGRESS];
  * 
  * // Dynamic property access
- * const propertyName = KEY_PARKING_CREATED_ON;
- * const value = parking[propertyName];
- * ```
- *
- * @see {@link Parking} - The TypeScript type definition
- * @see {@link KEYS_PARKING} - Array of all keys for this type
- */
-export const KEY_PARKING_CREATED_ON: keyof Parking = 'created_on';
-/**
- * Domain
- *
- * The domain name for the parking ad
- *
- * @type {string}
- *
- *
- * @remarks
- * This key constant provides type-safe access to the `domain` property of Parking objects.
- * Use this constant when you need to access properties dynamically or ensure type safety.
- *
- * @example
- * ```typescript
- * // Direct property access
- * const value = parking[KEY_PARKING_DOMAIN];
- * 
- * // Dynamic property access
- * const propertyName = KEY_PARKING_DOMAIN;
- * const value = parking[propertyName];
- * ```
- *
- * @see {@link Parking} - The TypeScript type definition
- * @see {@link KEYS_PARKING} - Array of all keys for this type
- */
-export const KEY_PARKING_DOMAIN: keyof Parking = 'domain';
-/**
- * Enabled
- *
- * Whether parking is enabled
- *
- * @type {boolean}
- *
- *
- * @remarks
- * This key constant provides type-safe access to the `enabled` property of Parking objects.
- * Use this constant when you need to access properties dynamically or ensure type safety.
- *
- * @example
- * ```typescript
- * // Direct property access
- * const value = parking[KEY_PARKING_ENABLED];
- * 
- * // Dynamic property access
- * const propertyName = KEY_PARKING_ENABLED;
- * const value = parking[propertyName];
- * ```
- *
- * @see {@link Parking} - The TypeScript type definition
- * @see {@link KEYS_PARKING} - Array of all keys for this type
- */
-export const KEY_PARKING_ENABLED: keyof Parking = 'enabled';
-/**
- * Note
- *
- * Additional notes about the parking ad
- *
- *
- *
- * @remarks
- * This key constant provides type-safe access to the `note` property of Parking objects.
- * Use this constant when you need to access properties dynamically or ensure type safety.
- *
- * @example
- * ```typescript
- * // Direct property access
- * const value = parking[KEY_PARKING_NOTE];
- * 
- * // Dynamic property access
- * const propertyName = KEY_PARKING_NOTE;
- * const value = parking[propertyName];
- * ```
- *
- * @see {@link Parking} - The TypeScript type definition
- * @see {@link KEYS_PARKING} - Array of all keys for this type
- */
-export const KEY_PARKING_NOTE: keyof Parking = 'note';
-/**
- * Parking Id
- *
- * Unique identifier for the parking entry
- *
- * @type {string}
- *
- *
- * @remarks
- * This key constant provides type-safe access to the `parking_id` property of Parking objects.
- * Use this constant when you need to access properties dynamically or ensure type safety.
- *
- * @example
- * ```typescript
- * // Direct property access
- * const value = parking[KEY_PARKING_PARKING_ID];
- * 
- * // Dynamic property access
- * const propertyName = KEY_PARKING_PARKING_ID;
- * const value = parking[propertyName];
- * ```
- *
- * @see {@link Parking} - The TypeScript type definition
- * @see {@link KEYS_PARKING} - Array of all keys for this type
- */
-export const KEY_PARKING_PARKING_ID: keyof Parking = 'parking_id';
-/**
- * Updated On
- *
- * When the parking entry was last updated
- *
- * @type {string}
- *
- *
- * @remarks
- * This key constant provides type-safe access to the `updated_on` property of Parking objects.
- * Use this constant when you need to access properties dynamically or ensure type safety.
- *
- * @example
- * ```typescript
- * // Direct property access
- * const value = parking[KEY_PARKING_UPDATED_ON];
- * 
- * // Dynamic property access
- * const propertyName = KEY_PARKING_UPDATED_ON;
- * const value = parking[propertyName];
+ * const propertyName = KEY_PARKING_METRICS_REVENUE_PROGRESS;
+ * const value = parkingmetrics[propertyName];
  * ```
  *
- * @see {@link Parking} - The TypeScript type definition
- * @see {@link KEYS_PARKING} - Array of all keys for this type
+ * @see {@link ParkingMetrics} - The TypeScript type definition
+ * @see {@link KEYS_PARKING_METRICS} - Array of all keys for this type
  */
-export const KEY_PARKING_UPDATED_ON: keyof Parking = 'updated_on';
+export const KEY_PARKING_METRICS_REVENUE_PROGRESS: keyof ParkingMetrics = 'revenue_progress';
 
 /**
- * Array of all Parking property keys
+ * Array of all ParkingMetrics property keys
  *
  * @remarks
- * This constant provides a readonly array containing all valid property keys for Parking objects.
+ * This constant provides a readonly array containing all valid property keys for ParkingMetrics objects.
  * Useful for iteration, validation, and generating dynamic UI components.
  *
  * @example
  * ```typescript
  * // Iterating through all keys
- * for (const key of KEYS_PARKING) {
- *   console.log(`Property: ${key}, Value: ${parking[key]}`);
+ * for (const key of KEYS_PARKING_METRICS) {
+ *   console.log(`Property: ${key}, Value: ${parkingmetrics[key]}`);
  * }
  * 
  * // Validation
- * const isValidKey = KEYS_PARKING.includes(someKey);
+ * const isValidKey = KEYS_PARKING_METRICS.includes(someKey);
  * ```
  *
- * @see {@link Parking} - The TypeScript type definition
+ * @see {@link ParkingMetrics} - The TypeScript type definition
  */
-export const KEYS_PARKING = [
-  KEY_PARKING_COMPLIANCE_STATUS,
-  KEY_PARKING_CONTENT_LANGUAGE,
-  KEY_PARKING_CONTENT_URL,
-  KEY_PARKING_CREATED_ON,
-  KEY_PARKING_DOMAIN,
-  KEY_PARKING_ENABLED,
-  KEY_PARKING_NOTE,
-  KEY_PARKING_PARKING_ID,
-  KEY_PARKING_UPDATED_ON,
-] as const satisfies (keyof Parking)[];
+export const KEYS_PARKING_METRICS = [
+  KEY_PARKING_METRICS_METRICS,
+  KEY_PARKING_METRICS_RENEWAL_COST,
+  KEY_PARKING_METRICS_REVENUE_PROGRESS,
+] as const satisfies (keyof ParkingMetrics)[];
 
 /**
  * Conversions
@@ -19589,32 +19353,6 @@ export const KEYS_PARKING = [
  * @see {@link KEYS_PARKING_STATISTICS} - Array of all keys for this type
  */
 export const KEY_PARKING_STATISTICS_CONVERSIONS: keyof ParkingStatistics = 'conversions';
-/**
- * Profit
- *
- * Total profit
- *
- * @type {string}
- *
- *
- * @remarks
- * This key constant provides type-safe access to the `profit` property of ParkingStatistics objects.
- * Use this constant when you need to access properties dynamically or ensure type safety.
- *
- * @example
- * ```typescript
- * // Direct property access
- * const value = parkingstatistics[KEY_PARKING_STATISTICS_PROFIT];
- * 
- * // Dynamic property access
- * const propertyName = KEY_PARKING_STATISTICS_PROFIT;
- * const value = parkingstatistics[propertyName];
- * ```
- *
- * @see {@link ParkingStatistics} - The TypeScript type definition
- * @see {@link KEYS_PARKING_STATISTICS} - Array of all keys for this type
- */
-export const KEY_PARKING_STATISTICS_PROFIT: keyof ParkingStatistics = 'profit';
 /**
  * Revenue
  *
@@ -19742,13 +19480,89 @@ export const KEY_PARKING_STATISTICS_VIEWS: keyof ParkingStatistics = 'views';
  */
 export const KEYS_PARKING_STATISTICS = [
   KEY_PARKING_STATISTICS_CONVERSIONS,
-  KEY_PARKING_STATISTICS_PROFIT,
   KEY_PARKING_STATISTICS_REVENUE,
   KEY_PARKING_STATISTICS_RPC,
   KEY_PARKING_STATISTICS_RPM,
   KEY_PARKING_STATISTICS_VIEWS,
 ] as const satisfies (keyof ParkingStatistics)[];
 
+/**
+ * Total Count
+ *
+ * Total number of parking entries
+ *
+ * @type {integer}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `total_count` property of ParkingTotalMetrics objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = parkingtotalmetrics[KEY_PARKING_TOTAL_METRICS_TOTAL_COUNT];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_PARKING_TOTAL_METRICS_TOTAL_COUNT;
+ * const value = parkingtotalmetrics[propertyName];
+ * ```
+ *
+ * @see {@link ParkingTotalMetrics} - The TypeScript type definition
+ * @see {@link KEYS_PARKING_TOTAL_METRICS} - Array of all keys for this type
+ */
+export const KEY_PARKING_TOTAL_METRICS_TOTAL_COUNT: keyof ParkingTotalMetrics = 'total_count';
+/**
+ * total_metrics property
+ *
+ * Aggregated metrics for all parking entries
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `total_metrics` property of ParkingTotalMetrics objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = parkingtotalmetrics[KEY_PARKING_TOTAL_METRICS_TOTAL_METRICS];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_PARKING_TOTAL_METRICS_TOTAL_METRICS;
+ * const value = parkingtotalmetrics[propertyName];
+ * ```
+ *
+ * @see {@link ParkingTotalMetrics} - The TypeScript type definition
+ * @see {@link KEYS_PARKING_TOTAL_METRICS} - Array of all keys for this type
+ */
+export const KEY_PARKING_TOTAL_METRICS_TOTAL_METRICS: keyof ParkingTotalMetrics = 'total_metrics';
+
+/**
+ * Array of all ParkingTotalMetrics property keys
+ *
+ * @remarks
+ * This constant provides a readonly array containing all valid property keys for ParkingTotalMetrics objects.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all keys
+ * for (const key of KEYS_PARKING_TOTAL_METRICS) {
+ *   console.log(`Property: ${key}, Value: ${parkingtotalmetrics[key]}`);
+ * }
+ * 
+ * // Validation
+ * const isValidKey = KEYS_PARKING_TOTAL_METRICS.includes(someKey);
+ * ```
+ *
+ * @see {@link ParkingTotalMetrics} - The TypeScript type definition
+ */
+export const KEYS_PARKING_TOTAL_METRICS = [
+  KEY_PARKING_TOTAL_METRICS_TOTAL_COUNT,
+  KEY_PARKING_TOTAL_METRICS_TOTAL_METRICS,
+] as const satisfies (keyof ParkingTotalMetrics)[];
+
 /**
  * New Password
  *

package/src/helpers/requests.d.ts

@@ -4648,6 +4648,8 @@ export type GET_OrganizationsUsers_Request_Query = GET_OrganizationsUsers_Reques
  * Use this type to ensure type safety when making API requests to this endpoint.
  *
  * @path /v1/parking
+ * @param page (query) - Page number
+ * @param page_size (query) - Page size
  *
  * @see {@link GET_Parking_Request_Query} - Query parameters type
  * @see {@link GET_Parking_Request_Path} - Path parameters type
@@ -4669,14 +4671,55 @@ export type GET_Parking_Request = {
  * Use this type to ensure type safety for query parameters.
  *
  * @path /v1/parking
+ * @param page (query) - Page number
+ * @param page_size (query) - Page size
  */
 export type GET_Parking_Request_Query = GET_Parking_Request['parameters']['query'];
 
+/**
+ * Request type for GET ParkingMetrics endpoint
+ *
+ * Get total metrics for all parking entries
+ * Retrieves aggregated metrics for all parking entries of the organization.
+ *
+ * @remarks
+ * This type defines the complete request structure for the GET ParkingMetrics endpoint.
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @example
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @path /v1/parking/metrics
+ *
+ * @see {@link GET_ParkingMetrics_Request_Query} - Query parameters type
+ * @see {@link GET_ParkingMetrics_Request_Path} - Path parameters type
+ * @see {@link GET_ParkingMetrics_Request_Body} - Request body type
+ */
+export type GET_ParkingMetrics_Request = {
+  parameters: {
+    query: operations['get_total_parking_metrics_v1_parking_metrics_get']['parameters']['query'];
+  };
+}
+/**
+ * Query parameters for GET /v1/parking/metrics
+ *
+ * @remarks
+ * This type defines the query parameters for the GET /v1/parking/metrics endpoint.
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
+ *
+ * @example
+ * Use this type to ensure type safety for query parameters.
+ *
+ * @path /v1/parking/metrics
+ */
+export type GET_ParkingMetrics_Request_Query = GET_ParkingMetrics_Request['parameters']['query'];
+
 /**
  * Request type for GET ParkingParkingIdMetrics endpoint
  *
  * Get metrics for a parking entry
- * Retrieves metrics for a specific parking entry by ID
+ * Retrieves metrics for a specific parking entry by ID.
  *
  * @remarks
  * This type defines the complete request structure for the GET ParkingParkingIdMetrics endpoint.
@@ -4694,9 +4737,23 @@ export type GET_Parking_Request_Query = GET_Parking_Request['parameters']['query
  */
 export type GET_ParkingParkingIdMetrics_Request = {
   parameters: {
+    query: operations['get_parking_metrics_v1_parking__parking_id__metrics_get']['parameters']['query'];
     path: operations['get_parking_metrics_v1_parking__parking_id__metrics_get']['parameters']['path'];
   };
 }
+/**
+ * Query parameters for GET /v1/parking/{parking_id}/metrics
+ *
+ * @remarks
+ * This type defines the query parameters for the GET /v1/parking/{parking_id}/metrics endpoint.
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
+ *
+ * @example
+ * Use this type to ensure type safety for query parameters.
+ *
+ * @path /v1/parking/{parking_id}/metrics
+ */
+export type GET_ParkingParkingIdMetrics_Request_Query = GET_ParkingParkingIdMetrics_Request['parameters']['query'];
 /**
  * Path parameters for GET /v1/parking/{parking_id}/metrics
  *