@opusdns/api 0.167.0 → 0.168.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "@opusdns/api-spec-ts-generator": "^0.19.0"
4
4
  },
5
5
  "name": "@opusdns/api",
6
- "version": "0.167.0",
6
+ "version": "0.168.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -159,6 +159,7 @@ import { PaginationMetadata } from './schemas';
159
159
  import { ParkingMetrics } from './schemas';
160
160
  import { Parking } from './schemas';
161
161
  import { ParkingStatistics } from './schemas';
162
+ import { ParkingTotalMetrics } from './schemas';
162
163
  import { PasswordUpdate } from './schemas';
163
164
  import { Period } from './schemas';
164
165
  import { PermissionSet } from './schemas';
@@ -19224,56 +19225,82 @@ export const KEYS_PAGINATION_METADATA = [
19224
19225
  ] as const satisfies (keyof PaginationMetadata)[];
19225
19226
 
19226
19227
  /**
19227
- * Parking Id
19228
+ * metrics property
19228
19229
  *
19229
- * Unique identifier for the parking entry
19230
+ * Metrics for the parking entry
19231
+ *
19232
+ *
19233
+ *
19234
+ * @remarks
19235
+ * This key constant provides type-safe access to the `metrics` property of ParkingMetrics objects.
19236
+ * Use this constant when you need to access properties dynamically or ensure type safety.
19237
+ *
19238
+ * @example
19239
+ * ```typescript
19240
+ * // Direct property access
19241
+ * const value = parkingmetrics[KEY_PARKING_METRICS_METRICS];
19242
+ *
19243
+ * // Dynamic property access
19244
+ * const propertyName = KEY_PARKING_METRICS_METRICS;
19245
+ * const value = parkingmetrics[propertyName];
19246
+ * ```
19247
+ *
19248
+ * @see {@link ParkingMetrics} - The TypeScript type definition
19249
+ * @see {@link KEYS_PARKING_METRICS} - Array of all keys for this type
19250
+ */
19251
+ export const KEY_PARKING_METRICS_METRICS: keyof ParkingMetrics = 'metrics';
19252
+ /**
19253
+ * Renewal Cost
19254
+ *
19255
+ * Yearly renewal cost for the parked domain
19230
19256
  *
19231
19257
  * @type {string}
19232
19258
  *
19233
19259
  *
19234
19260
  * @remarks
19235
- * This key constant provides type-safe access to the `parking_id` property of ParkingMetrics objects.
19261
+ * This key constant provides type-safe access to the `renewal_cost` property of ParkingMetrics objects.
19236
19262
  * Use this constant when you need to access properties dynamically or ensure type safety.
19237
19263
  *
19238
19264
  * @example
19239
19265
  * ```typescript
19240
19266
  * // Direct property access
19241
- * const value = parkingmetrics[KEY_PARKING_METRICS_PARKING_ID];
19267
+ * const value = parkingmetrics[KEY_PARKING_METRICS_RENEWAL_COST];
19242
19268
  *
19243
19269
  * // Dynamic property access
19244
- * const propertyName = KEY_PARKING_METRICS_PARKING_ID;
19270
+ * const propertyName = KEY_PARKING_METRICS_RENEWAL_COST;
19245
19271
  * const value = parkingmetrics[propertyName];
19246
19272
  * ```
19247
19273
  *
19248
19274
  * @see {@link ParkingMetrics} - The TypeScript type definition
19249
19275
  * @see {@link KEYS_PARKING_METRICS} - Array of all keys for this type
19250
19276
  */
19251
- export const KEY_PARKING_METRICS_PARKING_ID: keyof ParkingMetrics = 'parking_id';
19277
+ export const KEY_PARKING_METRICS_RENEWAL_COST: keyof ParkingMetrics = 'renewal_cost';
19252
19278
  /**
19253
- * statistics property
19279
+ * Revenue Progress
19254
19280
  *
19255
- * Statistics for the parking entry
19281
+ * Revenue progress percentage towards covering renewal cost
19256
19282
  *
19283
+ * @type {string}
19257
19284
  *
19258
19285
  *
19259
19286
  * @remarks
19260
- * This key constant provides type-safe access to the `statistics` property of ParkingMetrics objects.
19287
+ * This key constant provides type-safe access to the `revenue_progress` property of ParkingMetrics objects.
19261
19288
  * Use this constant when you need to access properties dynamically or ensure type safety.
19262
19289
  *
19263
19290
  * @example
19264
19291
  * ```typescript
19265
19292
  * // Direct property access
19266
- * const value = parkingmetrics[KEY_PARKING_METRICS_STATISTICS];
19293
+ * const value = parkingmetrics[KEY_PARKING_METRICS_REVENUE_PROGRESS];
19267
19294
  *
19268
19295
  * // Dynamic property access
19269
- * const propertyName = KEY_PARKING_METRICS_STATISTICS;
19296
+ * const propertyName = KEY_PARKING_METRICS_REVENUE_PROGRESS;
19270
19297
  * const value = parkingmetrics[propertyName];
19271
19298
  * ```
19272
19299
  *
19273
19300
  * @see {@link ParkingMetrics} - The TypeScript type definition
19274
19301
  * @see {@link KEYS_PARKING_METRICS} - Array of all keys for this type
19275
19302
  */
19276
- export const KEY_PARKING_METRICS_STATISTICS: keyof ParkingMetrics = 'statistics';
19303
+ export const KEY_PARKING_METRICS_REVENUE_PROGRESS: keyof ParkingMetrics = 'revenue_progress';
19277
19304
 
19278
19305
  /**
19279
19306
  * Array of all ParkingMetrics property keys
@@ -19296,8 +19323,9 @@ export const KEY_PARKING_METRICS_STATISTICS: keyof ParkingMetrics = 'statistics'
19296
19323
  * @see {@link ParkingMetrics} - The TypeScript type definition
19297
19324
  */
19298
19325
  export const KEYS_PARKING_METRICS = [
19299
- KEY_PARKING_METRICS_PARKING_ID,
19300
- KEY_PARKING_METRICS_STATISTICS,
19326
+ KEY_PARKING_METRICS_METRICS,
19327
+ KEY_PARKING_METRICS_RENEWAL_COST,
19328
+ KEY_PARKING_METRICS_REVENUE_PROGRESS,
19301
19329
  ] as const satisfies (keyof ParkingMetrics)[];
19302
19330
 
19303
19331
  /**
@@ -19589,32 +19617,6 @@ export const KEYS_PARKING = [
19589
19617
  * @see {@link KEYS_PARKING_STATISTICS} - Array of all keys for this type
19590
19618
  */
19591
19619
  export const KEY_PARKING_STATISTICS_CONVERSIONS: keyof ParkingStatistics = 'conversions';
19592
- /**
19593
- * Profit
19594
- *
19595
- * Total profit
19596
- *
19597
- * @type {string}
19598
- *
19599
- *
19600
- * @remarks
19601
- * This key constant provides type-safe access to the `profit` property of ParkingStatistics objects.
19602
- * Use this constant when you need to access properties dynamically or ensure type safety.
19603
- *
19604
- * @example
19605
- * ```typescript
19606
- * // Direct property access
19607
- * const value = parkingstatistics[KEY_PARKING_STATISTICS_PROFIT];
19608
- *
19609
- * // Dynamic property access
19610
- * const propertyName = KEY_PARKING_STATISTICS_PROFIT;
19611
- * const value = parkingstatistics[propertyName];
19612
- * ```
19613
- *
19614
- * @see {@link ParkingStatistics} - The TypeScript type definition
19615
- * @see {@link KEYS_PARKING_STATISTICS} - Array of all keys for this type
19616
- */
19617
- export const KEY_PARKING_STATISTICS_PROFIT: keyof ParkingStatistics = 'profit';
19618
19620
  /**
19619
19621
  * Revenue
19620
19622
  *
@@ -19742,13 +19744,89 @@ export const KEY_PARKING_STATISTICS_VIEWS: keyof ParkingStatistics = 'views';
19742
19744
  */
19743
19745
  export const KEYS_PARKING_STATISTICS = [
19744
19746
  KEY_PARKING_STATISTICS_CONVERSIONS,
19745
- KEY_PARKING_STATISTICS_PROFIT,
19746
19747
  KEY_PARKING_STATISTICS_REVENUE,
19747
19748
  KEY_PARKING_STATISTICS_RPC,
19748
19749
  KEY_PARKING_STATISTICS_RPM,
19749
19750
  KEY_PARKING_STATISTICS_VIEWS,
19750
19751
  ] as const satisfies (keyof ParkingStatistics)[];
19751
19752
 
19753
+ /**
19754
+ * Total Count
19755
+ *
19756
+ * Total number of parking entries
19757
+ *
19758
+ * @type {integer}
19759
+ *
19760
+ *
19761
+ * @remarks
19762
+ * This key constant provides type-safe access to the `total_count` property of ParkingTotalMetrics objects.
19763
+ * Use this constant when you need to access properties dynamically or ensure type safety.
19764
+ *
19765
+ * @example
19766
+ * ```typescript
19767
+ * // Direct property access
19768
+ * const value = parkingtotalmetrics[KEY_PARKING_TOTAL_METRICS_TOTAL_COUNT];
19769
+ *
19770
+ * // Dynamic property access
19771
+ * const propertyName = KEY_PARKING_TOTAL_METRICS_TOTAL_COUNT;
19772
+ * const value = parkingtotalmetrics[propertyName];
19773
+ * ```
19774
+ *
19775
+ * @see {@link ParkingTotalMetrics} - The TypeScript type definition
19776
+ * @see {@link KEYS_PARKING_TOTAL_METRICS} - Array of all keys for this type
19777
+ */
19778
+ export const KEY_PARKING_TOTAL_METRICS_TOTAL_COUNT: keyof ParkingTotalMetrics = 'total_count';
19779
+ /**
19780
+ * total_metrics property
19781
+ *
19782
+ * Aggregated metrics for all parking entries
19783
+ *
19784
+ *
19785
+ *
19786
+ * @remarks
19787
+ * This key constant provides type-safe access to the `total_metrics` property of ParkingTotalMetrics objects.
19788
+ * Use this constant when you need to access properties dynamically or ensure type safety.
19789
+ *
19790
+ * @example
19791
+ * ```typescript
19792
+ * // Direct property access
19793
+ * const value = parkingtotalmetrics[KEY_PARKING_TOTAL_METRICS_TOTAL_METRICS];
19794
+ *
19795
+ * // Dynamic property access
19796
+ * const propertyName = KEY_PARKING_TOTAL_METRICS_TOTAL_METRICS;
19797
+ * const value = parkingtotalmetrics[propertyName];
19798
+ * ```
19799
+ *
19800
+ * @see {@link ParkingTotalMetrics} - The TypeScript type definition
19801
+ * @see {@link KEYS_PARKING_TOTAL_METRICS} - Array of all keys for this type
19802
+ */
19803
+ export const KEY_PARKING_TOTAL_METRICS_TOTAL_METRICS: keyof ParkingTotalMetrics = 'total_metrics';
19804
+
19805
+ /**
19806
+ * Array of all ParkingTotalMetrics property keys
19807
+ *
19808
+ * @remarks
19809
+ * This constant provides a readonly array containing all valid property keys for ParkingTotalMetrics objects.
19810
+ * Useful for iteration, validation, and generating dynamic UI components.
19811
+ *
19812
+ * @example
19813
+ * ```typescript
19814
+ * // Iterating through all keys
19815
+ * for (const key of KEYS_PARKING_TOTAL_METRICS) {
19816
+ * console.log(`Property: ${key}, Value: ${parkingtotalmetrics[key]}`);
19817
+ * }
19818
+ *
19819
+ * // Validation
19820
+ * const isValidKey = KEYS_PARKING_TOTAL_METRICS.includes(someKey);
19821
+ * ```
19822
+ *
19823
+ * @see {@link ParkingTotalMetrics} - The TypeScript type definition
19824
+ */
19825
+ export const KEYS_PARKING_TOTAL_METRICS = [
19826
+ KEY_PARKING_TOTAL_METRICS_TOTAL_COUNT,
19827
+ KEY_PARKING_TOTAL_METRICS_TOTAL_METRICS,
19828
+ ] as const satisfies (keyof ParkingTotalMetrics)[];
19829
+
19752
19830
  /**
19753
19831
  * New Password
19754
19832
  *
@@ -4672,6 +4672,45 @@ export type GET_Parking_Request = {
4672
4672
  */
4673
4673
  export type GET_Parking_Request_Query = GET_Parking_Request['parameters']['query'];
4674
4674
 
4675
+ /**
4676
+ * Request type for GET ParkingMetrics endpoint
4677
+ *
4678
+ * Get total metrics for all parking entries
4679
+ * Retrieves aggregated metrics for all parking entries of the organization
4680
+ *
4681
+ * @remarks
4682
+ * This type defines the complete request structure for the GET ParkingMetrics endpoint.
4683
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
4684
+ * Use this type to ensure type safety when making API requests to this endpoint.
4685
+ *
4686
+ * @example
4687
+ * Use this type to ensure type safety when making API requests to this endpoint.
4688
+ *
4689
+ * @path /v1/parking/metrics
4690
+ *
4691
+ * @see {@link GET_ParkingMetrics_Request_Query} - Query parameters type
4692
+ * @see {@link GET_ParkingMetrics_Request_Path} - Path parameters type
4693
+ * @see {@link GET_ParkingMetrics_Request_Body} - Request body type
4694
+ */
4695
+ export type GET_ParkingMetrics_Request = {
4696
+ parameters: {
4697
+ query: operations['get_total_parking_metrics_v1_parking_metrics_get']['parameters']['query'];
4698
+ };
4699
+ }
4700
+ /**
4701
+ * Query parameters for GET /v1/parking/metrics
4702
+ *
4703
+ * @remarks
4704
+ * This type defines the query parameters for the GET /v1/parking/metrics endpoint.
4705
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
4706
+ *
4707
+ * @example
4708
+ * Use this type to ensure type safety for query parameters.
4709
+ *
4710
+ * @path /v1/parking/metrics
4711
+ */
4712
+ export type GET_ParkingMetrics_Request_Query = GET_ParkingMetrics_Request['parameters']['query'];
4713
+
4675
4714
  /**
4676
4715
  * Request type for GET ParkingParkingIdMetrics endpoint
4677
4716
  *
@@ -4694,9 +4733,23 @@ export type GET_Parking_Request_Query = GET_Parking_Request['parameters']['query
4694
4733
  */
4695
4734
  export type GET_ParkingParkingIdMetrics_Request = {
4696
4735
  parameters: {
4736
+ query: operations['get_parking_metrics_v1_parking__parking_id__metrics_get']['parameters']['query'];
4697
4737
  path: operations['get_parking_metrics_v1_parking__parking_id__metrics_get']['parameters']['path'];
4698
4738
  };
4699
4739
  }
4740
+ /**
4741
+ * Query parameters for GET /v1/parking/{parking_id}/metrics
4742
+ *
4743
+ * @remarks
4744
+ * This type defines the query parameters for the GET /v1/parking/{parking_id}/metrics endpoint.
4745
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
4746
+ *
4747
+ * @example
4748
+ * Use this type to ensure type safety for query parameters.
4749
+ *
4750
+ * @path /v1/parking/{parking_id}/metrics
4751
+ */
4752
+ export type GET_ParkingParkingIdMetrics_Request_Query = GET_ParkingParkingIdMetrics_Request['parameters']['query'];
4700
4753
  /**
4701
4754
  * Path parameters for GET /v1/parking/{parking_id}/metrics
4702
4755
  *
@@ -34,7 +34,7 @@
34
34
 
35
35
  import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
36
36
 
37
- import { Pagination_EmailForwardLog, HTTPValidationError, Pagination_ObjectLog, Pagination_RequestHistory, Problem, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, EmailForwardZone, Pagination_DomainForwardZone, Pagination_EmailForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainForwardMetrics, DomainForwardBrowserStats, DomainForwardGeoStats, DomainForwardPlatformStats, DomainForwardReferrerStats, DomainForwardStatusCodeStats, DomainForwardMetricsTimeSeries, DomainForwardUserAgentStats, DomainForwardVisitsByKey, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, RequestAuthcode2, Pagination_EmailForward, EmailForward, EmailForwardAlias, EmailForwardMetrics, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_UserPublic, Pagination_Parking, ParkingMetrics, TldSpecification, UserPublic, UserPublicWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
37
+ import { Pagination_EmailForwardLog, HTTPValidationError, Pagination_ObjectLog, Pagination_RequestHistory, Problem, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, EmailForwardZone, Pagination_DomainForwardZone, Pagination_EmailForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainForwardMetrics, DomainForwardBrowserStats, DomainForwardGeoStats, DomainForwardPlatformStats, DomainForwardReferrerStats, DomainForwardStatusCodeStats, DomainForwardMetricsTimeSeries, DomainForwardUserAgentStats, DomainForwardVisitsByKey, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, RequestAuthcode2, Pagination_EmailForward, EmailForward, EmailForwardAlias, EmailForwardMetrics, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_UserPublic, Pagination_Parking, ParkingMetrics, ParkingTotalMetrics, TldSpecification, UserPublic, UserPublicWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
38
38
 
39
39
  /**
40
40
  * Response types for GET ArchiveEmailForwardLogsAliasesByEmailForwardAliasId endpoint
@@ -9054,6 +9054,98 @@ export type GET_ParkingByParkingIdMetrics_Response_404 = Problem
9054
9054
  */
9055
9055
  export type GET_ParkingByParkingIdMetrics_Response_422 = HTTPValidationError
9056
9056
 
9057
+ /**
9058
+ * Response types for GET ParkingMetrics endpoint
9059
+ *
9060
+ * Get total metrics for all parking entries
9061
+ * Retrieves aggregated metrics for all parking entries of the organization
9062
+ *
9063
+ * @remarks
9064
+ * This type defines all possible response structures for the GET ParkingMetrics endpoint.
9065
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
9066
+ * Use this type to ensure type safety when handling API responses from this endpoint.
9067
+ *
9068
+
9069
+ *
9070
+ * @path /v1/parking/metrics
9071
+ *
9072
+ * @see {@link GET_ParkingMetrics_Response_200} - 200 response type
9073
+ * @see {@link GET_ParkingMetrics_Response_401} - 401 response type
9074
+ * @see {@link GET_ParkingMetrics_Response_403} - 403 response type
9075
+ * @see {@link GET_ParkingMetrics_Response_422} - 422 response type
9076
+ *
9077
+
9078
+ */
9079
+ export type GET_ParkingMetrics_Response = GET_ParkingMetrics_Response_200 | GET_ParkingMetrics_Response_401 | GET_ParkingMetrics_Response_403 | GET_ParkingMetrics_Response_422;
9080
+
9081
+ /**
9082
+ * 200 response for GET ParkingMetrics endpoint
9083
+ *
9084
+ * @remarks
9085
+ * This type defines the response structure for the 200 status code
9086
+ * of the GET ParkingMetrics endpoint.
9087
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
9088
+ *
9089
+
9090
+ *
9091
+ * @path /v1/parking/metrics
9092
+ *
9093
+ * @see {@link GET_ParkingMetrics_Response} - The main response type definition
9094
+ * @see {@link ParkingTotalMetrics} - The actual schema type definition
9095
+ */
9096
+ export type GET_ParkingMetrics_Response_200 = ParkingTotalMetrics
9097
+
9098
+ /**
9099
+ * 401 response for GET ParkingMetrics endpoint
9100
+ *
9101
+ * @remarks
9102
+ * This type defines the response structure for the 401 status code
9103
+ * of the GET ParkingMetrics endpoint.
9104
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
9105
+ *
9106
+
9107
+ *
9108
+ * @path /v1/parking/metrics
9109
+ *
9110
+ * @see {@link GET_ParkingMetrics_Response} - The main response type definition
9111
+ * @see {@link Problem} - The actual schema type definition
9112
+ */
9113
+ export type GET_ParkingMetrics_Response_401 = Problem
9114
+
9115
+ /**
9116
+ * 403 response for GET ParkingMetrics endpoint
9117
+ *
9118
+ * @remarks
9119
+ * This type defines the response structure for the 403 status code
9120
+ * of the GET ParkingMetrics endpoint.
9121
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
9122
+ *
9123
+
9124
+ *
9125
+ * @path /v1/parking/metrics
9126
+ *
9127
+ * @see {@link GET_ParkingMetrics_Response} - The main response type definition
9128
+ * @see {@link Problem} - The actual schema type definition
9129
+ */
9130
+ export type GET_ParkingMetrics_Response_403 = Problem
9131
+
9132
+ /**
9133
+ * 422 response for GET ParkingMetrics endpoint
9134
+ *
9135
+ * @remarks
9136
+ * This type defines the response structure for the 422 status code
9137
+ * of the GET ParkingMetrics endpoint.
9138
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
9139
+ *
9140
+
9141
+ *
9142
+ * @path /v1/parking/metrics
9143
+ *
9144
+ * @see {@link GET_ParkingMetrics_Response} - The main response type definition
9145
+ * @see {@link HTTPValidationError} - The actual schema type definition
9146
+ */
9147
+ export type GET_ParkingMetrics_Response_422 = HTTPValidationError
9148
+
9057
9149
  /**
9058
9150
  * Response types for GET Tlds endpoint
9059
9151
  *
@@ -3199,6 +3199,22 @@ export type ParkingSortField = components['schemas']['ParkingSortField'];
3199
3199
  * @see {@link components} - The OpenAPI components schema definition
3200
3200
  */
3201
3201
  export type ParkingStatistics = components['schemas']['ParkingStatistics'];
3202
+ /**
3203
+ * ParkingTotalMetricsResponse
3204
+ *
3205
+ * @remarks
3206
+ * Type alias for the `ParkingTotalMetricsResponse` OpenAPI schema.
3207
+ * This type represents parkingtotalmetricsresponse data structures used in API requests and responses.
3208
+ *
3209
+ * @example
3210
+ * ```typescript
3211
+ * const response = await api.getParkingTotalMetrics();
3212
+ * const item: ParkingTotalMetrics = response.results;
3213
+ * ```
3214
+ *
3215
+ * @see {@link components} - The OpenAPI components schema definition
3216
+ */
3217
+ export type ParkingTotalMetrics = components['schemas']['ParkingTotalMetricsResponse'];
3202
3218
  /**
3203
3219
  * PasswordUpdate
3204
3220
  *
package/src/openapi.yaml CHANGED
@@ -4913,21 +4913,23 @@ components:
4913
4913
  type: object
4914
4914
  ParkingMetricsResponse:
4915
4915
  properties:
4916
- parking_id:
4917
- description: Unique identifier for the parking entry
4918
- examples:
4919
- - parking_01h45ytscbebyvny4gc8cr8ma2
4920
- format: typeid
4921
- pattern: ^parking_[0-7][0-9a-hjkmnpq-tv-z]{25}$
4922
- title: Parking Id
4923
- type: string
4924
- x-typeid-prefix: parking
4925
- statistics:
4916
+ metrics:
4926
4917
  $ref: '#/components/schemas/ParkingStatistics'
4927
- description: Statistics for the parking entry
4918
+ description: Metrics for the parking entry
4919
+ renewal_cost:
4920
+ description: Yearly renewal cost for the parked domain
4921
+ pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
4922
+ title: Renewal Cost
4923
+ type: string
4924
+ revenue_progress:
4925
+ description: Revenue progress percentage towards covering renewal cost
4926
+ pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
4927
+ title: Revenue Progress
4928
+ type: string
4928
4929
  required:
4929
- - parking_id
4930
- - statistics
4930
+ - metrics
4931
+ - renewal_cost
4932
+ - revenue_progress
4931
4933
  title: ParkingMetricsResponse
4932
4934
  type: object
4933
4935
  ParkingResponse:
@@ -5003,11 +5005,6 @@ components:
5003
5005
  description: Number of conversions
5004
5006
  title: Conversions
5005
5007
  type: integer
5006
- profit:
5007
- description: Total profit
5008
- pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
5009
- title: Profit
5010
- type: string
5011
5008
  revenue:
5012
5009
  description: Total revenue
5013
5010
  pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
@@ -5033,9 +5030,22 @@ components:
5033
5030
  - rpc
5034
5031
  - rpm
5035
5032
  - revenue
5036
- - profit
5037
5033
  title: ParkingStatistics
5038
5034
  type: object
5035
+ ParkingTotalMetricsResponse:
5036
+ properties:
5037
+ total_count:
5038
+ description: Total number of parking entries
5039
+ title: Total Count
5040
+ type: integer
5041
+ total_metrics:
5042
+ $ref: '#/components/schemas/ParkingStatistics'
5043
+ description: Aggregated metrics for all parking entries
5044
+ required:
5045
+ - total_count
5046
+ - total_metrics
5047
+ title: ParkingTotalMetricsResponse
5048
+ type: object
5039
5049
  PasswordUpdate:
5040
5050
  properties:
5041
5051
  new_password:
@@ -6824,7 +6834,7 @@ info:
6824
6834
  '
6825
6835
  summary: OpusDNS - your gateway to a seamless domain management experience.
6826
6836
  title: OpusDNS API
6827
- version: 2026-01-22-170829
6837
+ version: 2026-01-23-124110
6828
6838
  x-logo:
6829
6839
  altText: OpusDNS API Reference
6830
6840
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -14831,6 +14841,72 @@ paths:
14831
14841
  summary: List parking entries
14832
14842
  tags:
14833
14843
  - parking
14844
+ /v1/parking/metrics:
14845
+ get:
14846
+ description: Retrieves aggregated metrics for all parking entries of the organization
14847
+ operationId: get_total_parking_metrics_v1_parking_metrics_get
14848
+ parameters:
14849
+ - in: query
14850
+ name: start_time
14851
+ required: false
14852
+ schema:
14853
+ anyOf:
14854
+ - format: date-time
14855
+ type: string
14856
+ - type: 'null'
14857
+ title: Start Time
14858
+ - in: query
14859
+ name: end_time
14860
+ required: false
14861
+ schema:
14862
+ anyOf:
14863
+ - format: date-time
14864
+ type: string
14865
+ - type: 'null'
14866
+ title: End Time
14867
+ responses:
14868
+ '200':
14869
+ content:
14870
+ application/json:
14871
+ schema:
14872
+ $ref: '#/components/schemas/ParkingTotalMetricsResponse'
14873
+ description: Successful Response
14874
+ '401':
14875
+ content:
14876
+ application/problem+json:
14877
+ example:
14878
+ code: ERROR_AUTHENTICATION
14879
+ detail: Additional error context.
14880
+ status: 401
14881
+ title: Authentication Error
14882
+ type: authentication
14883
+ schema:
14884
+ $ref: '#/components/schemas/Problem'
14885
+ description: Unauthorized
14886
+ '403':
14887
+ content:
14888
+ application/problem+json:
14889
+ example:
14890
+ code: ERROR_PERMISSION_DENIED
14891
+ detail: Insufficient permissions to perform this action
14892
+ status: 403
14893
+ title: Permission Denied
14894
+ type: permission-denied
14895
+ schema:
14896
+ $ref: '#/components/schemas/Problem'
14897
+ description: Forbidden
14898
+ '422':
14899
+ content:
14900
+ application/problem+json:
14901
+ schema:
14902
+ $ref: '#/components/schemas/HTTPValidationError'
14903
+ description: Validation Error
14904
+ security:
14905
+ - OAuth2PasswordBearer: []
14906
+ - APIKeyHeader: []
14907
+ summary: Get total metrics for all parking entries
14908
+ tags:
14909
+ - parking
14834
14910
  /v1/parking/{parking_id}/metrics:
14835
14911
  get:
14836
14912
  description: Retrieves metrics for a specific parking entry by ID
@@ -14847,6 +14923,24 @@ paths:
14847
14923
  title: Parking Id
14848
14924
  type: string
14849
14925
  x-typeid-prefix: parking
14926
+ - in: query
14927
+ name: start_time
14928
+ required: false
14929
+ schema:
14930
+ anyOf:
14931
+ - format: date-time
14932
+ type: string
14933
+ - type: 'null'
14934
+ title: Start Time
14935
+ - in: query
14936
+ name: end_time
14937
+ required: false
14938
+ schema:
14939
+ anyOf:
14940
+ - format: date-time
14941
+ type: string
14942
+ - type: 'null'
14943
+ title: End Time
14850
14944
  responses:
14851
14945
  '200':
14852
14946
  content:
package/src/schema.d.ts CHANGED
@@ -1568,6 +1568,26 @@ export interface paths {
1568
1568
  patch?: never;
1569
1569
  trace?: never;
1570
1570
  };
1571
+ "/v1/parking/metrics": {
1572
+ parameters: {
1573
+ query?: never;
1574
+ header?: never;
1575
+ path?: never;
1576
+ cookie?: never;
1577
+ };
1578
+ /**
1579
+ * Get total metrics for all parking entries
1580
+ * @description Retrieves aggregated metrics for all parking entries of the organization
1581
+ */
1582
+ get: operations["get_total_parking_metrics_v1_parking_metrics_get"];
1583
+ put?: never;
1584
+ post?: never;
1585
+ delete?: never;
1586
+ options?: never;
1587
+ head?: never;
1588
+ patch?: never;
1589
+ trace?: never;
1590
+ };
1571
1591
  "/v1/parking/{parking_id}/metrics": {
1572
1592
  parameters: {
1573
1593
  query?: never;
@@ -5041,15 +5061,18 @@ export interface components {
5041
5061
  };
5042
5062
  /** ParkingMetricsResponse */
5043
5063
  ParkingMetricsResponse: {
5064
+ /** @description Metrics for the parking entry */
5065
+ metrics: components["schemas"]["ParkingStatistics"];
5044
5066
  /**
5045
- * Parking Id
5046
- * Format: typeid
5047
- * @description Unique identifier for the parking entry
5048
- * @example parking_01h45ytscbebyvny4gc8cr8ma2
5067
+ * Renewal Cost
5068
+ * @description Yearly renewal cost for the parked domain
5049
5069
  */
5050
- parking_id: TypeId<"parking">;
5051
- /** @description Statistics for the parking entry */
5052
- statistics: components["schemas"]["ParkingStatistics"];
5070
+ renewal_cost: string;
5071
+ /**
5072
+ * Revenue Progress
5073
+ * @description Revenue progress percentage towards covering renewal cost
5074
+ */
5075
+ revenue_progress: string;
5053
5076
  };
5054
5077
  /** ParkingResponse */
5055
5078
  ParkingResponse: {
@@ -5112,11 +5135,6 @@ export interface components {
5112
5135
  * @description Number of conversions
5113
5136
  */
5114
5137
  conversions: number;
5115
- /**
5116
- * Profit
5117
- * @description Total profit
5118
- */
5119
- profit: string;
5120
5138
  /**
5121
5139
  * Revenue
5122
5140
  * @description Total revenue
@@ -5138,6 +5156,16 @@ export interface components {
5138
5156
  */
5139
5157
  views: number;
5140
5158
  };
5159
+ /** ParkingTotalMetricsResponse */
5160
+ ParkingTotalMetricsResponse: {
5161
+ /**
5162
+ * Total Count
5163
+ * @description Total number of parking entries
5164
+ */
5165
+ total_count: number;
5166
+ /** @description Aggregated metrics for all parking entries */
5167
+ total_metrics: components["schemas"]["ParkingStatistics"];
5168
+ };
5141
5169
  /** PasswordUpdate */
5142
5170
  PasswordUpdate: {
5143
5171
  /**
@@ -12796,9 +12824,76 @@ export interface operations {
12796
12824
  };
12797
12825
  };
12798
12826
  };
12827
+ get_total_parking_metrics_v1_parking_metrics_get: {
12828
+ parameters: {
12829
+ query?: {
12830
+ start_time?: Date | null;
12831
+ end_time?: Date | null;
12832
+ };
12833
+ header?: never;
12834
+ path?: never;
12835
+ cookie?: never;
12836
+ };
12837
+ requestBody?: never;
12838
+ responses: {
12839
+ /** @description Successful Response */
12840
+ 200: {
12841
+ headers: {
12842
+ [name: string]: unknown;
12843
+ };
12844
+ content: {
12845
+ "application/json": components["schemas"]["ParkingTotalMetricsResponse"];
12846
+ };
12847
+ };
12848
+ /** @description Unauthorized */
12849
+ 401: {
12850
+ headers: {
12851
+ [name: string]: unknown;
12852
+ };
12853
+ content: {
12854
+ /** @example {
12855
+ * "code": "ERROR_AUTHENTICATION",
12856
+ * "detail": "Additional error context.",
12857
+ * "status": 401,
12858
+ * "title": "Authentication Error",
12859
+ * "type": "authentication"
12860
+ * } */
12861
+ "application/problem+json": components["schemas"]["Problem"];
12862
+ };
12863
+ };
12864
+ /** @description Forbidden */
12865
+ 403: {
12866
+ headers: {
12867
+ [name: string]: unknown;
12868
+ };
12869
+ content: {
12870
+ /** @example {
12871
+ * "code": "ERROR_PERMISSION_DENIED",
12872
+ * "detail": "Insufficient permissions to perform this action",
12873
+ * "status": 403,
12874
+ * "title": "Permission Denied",
12875
+ * "type": "permission-denied"
12876
+ * } */
12877
+ "application/problem+json": components["schemas"]["Problem"];
12878
+ };
12879
+ };
12880
+ /** @description Validation Error */
12881
+ 422: {
12882
+ headers: {
12883
+ [name: string]: unknown;
12884
+ };
12885
+ content: {
12886
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
12887
+ };
12888
+ };
12889
+ };
12890
+ };
12799
12891
  get_parking_metrics_v1_parking__parking_id__metrics_get: {
12800
12892
  parameters: {
12801
- query?: never;
12893
+ query?: {
12894
+ start_time?: Date | null;
12895
+ end_time?: Date | null;
12896
+ };
12802
12897
  header?: never;
12803
12898
  path: {
12804
12899
  parking_id: TypeId<"parking">;