@opusdns/api 0.164.0 → 0.165.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.164.0",
6
+ "version": "0.165.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -156,7 +156,9 @@ import { OrganizationToken } from './schemas';
156
156
  import { OrganizationUpdate } from './schemas';
157
157
  import { OrganizationWithBillingData } from './schemas';
158
158
  import { PaginationMetadata } from './schemas';
159
+ import { ParkingMetrics } from './schemas';
159
160
  import { Parking } from './schemas';
161
+ import { ParkingStatistics } from './schemas';
160
162
  import { PasswordUpdate } from './schemas';
161
163
  import { Period } from './schemas';
162
164
  import { PermissionSet } from './schemas';
@@ -19221,6 +19223,83 @@ export const KEYS_PAGINATION_METADATA = [
19221
19223
  KEY_PAGINATION_METADATA_TOTAL_PAGES,
19222
19224
  ] as const satisfies (keyof PaginationMetadata)[];
19223
19225
 
19226
+ /**
19227
+ * Parking Id
19228
+ *
19229
+ * Unique identifier for the parking entry
19230
+ *
19231
+ * @type {string}
19232
+ *
19233
+ *
19234
+ * @remarks
19235
+ * This key constant provides type-safe access to the `parking_id` 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_PARKING_ID];
19242
+ *
19243
+ * // Dynamic property access
19244
+ * const propertyName = KEY_PARKING_METRICS_PARKING_ID;
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_PARKING_ID: keyof ParkingMetrics = 'parking_id';
19252
+ /**
19253
+ * statistics property
19254
+ *
19255
+ * Statistics for the parking entry
19256
+ *
19257
+ *
19258
+ *
19259
+ * @remarks
19260
+ * This key constant provides type-safe access to the `statistics` property of ParkingMetrics objects.
19261
+ * Use this constant when you need to access properties dynamically or ensure type safety.
19262
+ *
19263
+ * @example
19264
+ * ```typescript
19265
+ * // Direct property access
19266
+ * const value = parkingmetrics[KEY_PARKING_METRICS_STATISTICS];
19267
+ *
19268
+ * // Dynamic property access
19269
+ * const propertyName = KEY_PARKING_METRICS_STATISTICS;
19270
+ * const value = parkingmetrics[propertyName];
19271
+ * ```
19272
+ *
19273
+ * @see {@link ParkingMetrics} - The TypeScript type definition
19274
+ * @see {@link KEYS_PARKING_METRICS} - Array of all keys for this type
19275
+ */
19276
+ export const KEY_PARKING_METRICS_STATISTICS: keyof ParkingMetrics = 'statistics';
19277
+
19278
+ /**
19279
+ * Array of all ParkingMetrics property keys
19280
+ *
19281
+ * @remarks
19282
+ * This constant provides a readonly array containing all valid property keys for ParkingMetrics objects.
19283
+ * Useful for iteration, validation, and generating dynamic UI components.
19284
+ *
19285
+ * @example
19286
+ * ```typescript
19287
+ * // Iterating through all keys
19288
+ * for (const key of KEYS_PARKING_METRICS) {
19289
+ * console.log(`Property: ${key}, Value: ${parkingmetrics[key]}`);
19290
+ * }
19291
+ *
19292
+ * // Validation
19293
+ * const isValidKey = KEYS_PARKING_METRICS.includes(someKey);
19294
+ * ```
19295
+ *
19296
+ * @see {@link ParkingMetrics} - The TypeScript type definition
19297
+ */
19298
+ export const KEYS_PARKING_METRICS = [
19299
+ KEY_PARKING_METRICS_PARKING_ID,
19300
+ KEY_PARKING_METRICS_STATISTICS,
19301
+ ] as const satisfies (keyof ParkingMetrics)[];
19302
+
19224
19303
  /**
19225
19304
  * compliance_status property
19226
19305
  *
@@ -19484,6 +19563,192 @@ export const KEYS_PARKING = [
19484
19563
  KEY_PARKING_UPDATED_ON,
19485
19564
  ] as const satisfies (keyof Parking)[];
19486
19565
 
19566
+ /**
19567
+ * Conversions
19568
+ *
19569
+ * Number of conversions
19570
+ *
19571
+ * @type {integer}
19572
+ *
19573
+ *
19574
+ * @remarks
19575
+ * This key constant provides type-safe access to the `conversions` property of ParkingStatistics objects.
19576
+ * Use this constant when you need to access properties dynamically or ensure type safety.
19577
+ *
19578
+ * @example
19579
+ * ```typescript
19580
+ * // Direct property access
19581
+ * const value = parkingstatistics[KEY_PARKING_STATISTICS_CONVERSIONS];
19582
+ *
19583
+ * // Dynamic property access
19584
+ * const propertyName = KEY_PARKING_STATISTICS_CONVERSIONS;
19585
+ * const value = parkingstatistics[propertyName];
19586
+ * ```
19587
+ *
19588
+ * @see {@link ParkingStatistics} - The TypeScript type definition
19589
+ * @see {@link KEYS_PARKING_STATISTICS} - Array of all keys for this type
19590
+ */
19591
+ 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
+ /**
19619
+ * Revenue
19620
+ *
19621
+ * Total revenue
19622
+ *
19623
+ * @type {string}
19624
+ *
19625
+ *
19626
+ * @remarks
19627
+ * This key constant provides type-safe access to the `revenue` property of ParkingStatistics objects.
19628
+ * Use this constant when you need to access properties dynamically or ensure type safety.
19629
+ *
19630
+ * @example
19631
+ * ```typescript
19632
+ * // Direct property access
19633
+ * const value = parkingstatistics[KEY_PARKING_STATISTICS_REVENUE];
19634
+ *
19635
+ * // Dynamic property access
19636
+ * const propertyName = KEY_PARKING_STATISTICS_REVENUE;
19637
+ * const value = parkingstatistics[propertyName];
19638
+ * ```
19639
+ *
19640
+ * @see {@link ParkingStatistics} - The TypeScript type definition
19641
+ * @see {@link KEYS_PARKING_STATISTICS} - Array of all keys for this type
19642
+ */
19643
+ export const KEY_PARKING_STATISTICS_REVENUE: keyof ParkingStatistics = 'revenue';
19644
+ /**
19645
+ * Rpc
19646
+ *
19647
+ * Revenue per click
19648
+ *
19649
+ * @type {string}
19650
+ *
19651
+ *
19652
+ * @remarks
19653
+ * This key constant provides type-safe access to the `rpc` property of ParkingStatistics objects.
19654
+ * Use this constant when you need to access properties dynamically or ensure type safety.
19655
+ *
19656
+ * @example
19657
+ * ```typescript
19658
+ * // Direct property access
19659
+ * const value = parkingstatistics[KEY_PARKING_STATISTICS_RPC];
19660
+ *
19661
+ * // Dynamic property access
19662
+ * const propertyName = KEY_PARKING_STATISTICS_RPC;
19663
+ * const value = parkingstatistics[propertyName];
19664
+ * ```
19665
+ *
19666
+ * @see {@link ParkingStatistics} - The TypeScript type definition
19667
+ * @see {@link KEYS_PARKING_STATISTICS} - Array of all keys for this type
19668
+ */
19669
+ export const KEY_PARKING_STATISTICS_RPC: keyof ParkingStatistics = 'rpc';
19670
+ /**
19671
+ * Rpm
19672
+ *
19673
+ * Revenue per mille (thousand views)
19674
+ *
19675
+ * @type {string}
19676
+ *
19677
+ *
19678
+ * @remarks
19679
+ * This key constant provides type-safe access to the `rpm` property of ParkingStatistics objects.
19680
+ * Use this constant when you need to access properties dynamically or ensure type safety.
19681
+ *
19682
+ * @example
19683
+ * ```typescript
19684
+ * // Direct property access
19685
+ * const value = parkingstatistics[KEY_PARKING_STATISTICS_RPM];
19686
+ *
19687
+ * // Dynamic property access
19688
+ * const propertyName = KEY_PARKING_STATISTICS_RPM;
19689
+ * const value = parkingstatistics[propertyName];
19690
+ * ```
19691
+ *
19692
+ * @see {@link ParkingStatistics} - The TypeScript type definition
19693
+ * @see {@link KEYS_PARKING_STATISTICS} - Array of all keys for this type
19694
+ */
19695
+ export const KEY_PARKING_STATISTICS_RPM: keyof ParkingStatistics = 'rpm';
19696
+ /**
19697
+ * Views
19698
+ *
19699
+ * Number of views
19700
+ *
19701
+ * @type {integer}
19702
+ *
19703
+ *
19704
+ * @remarks
19705
+ * This key constant provides type-safe access to the `views` property of ParkingStatistics objects.
19706
+ * Use this constant when you need to access properties dynamically or ensure type safety.
19707
+ *
19708
+ * @example
19709
+ * ```typescript
19710
+ * // Direct property access
19711
+ * const value = parkingstatistics[KEY_PARKING_STATISTICS_VIEWS];
19712
+ *
19713
+ * // Dynamic property access
19714
+ * const propertyName = KEY_PARKING_STATISTICS_VIEWS;
19715
+ * const value = parkingstatistics[propertyName];
19716
+ * ```
19717
+ *
19718
+ * @see {@link ParkingStatistics} - The TypeScript type definition
19719
+ * @see {@link KEYS_PARKING_STATISTICS} - Array of all keys for this type
19720
+ */
19721
+ export const KEY_PARKING_STATISTICS_VIEWS: keyof ParkingStatistics = 'views';
19722
+
19723
+ /**
19724
+ * Array of all ParkingStatistics property keys
19725
+ *
19726
+ * @remarks
19727
+ * This constant provides a readonly array containing all valid property keys for ParkingStatistics objects.
19728
+ * Useful for iteration, validation, and generating dynamic UI components.
19729
+ *
19730
+ * @example
19731
+ * ```typescript
19732
+ * // Iterating through all keys
19733
+ * for (const key of KEYS_PARKING_STATISTICS) {
19734
+ * console.log(`Property: ${key}, Value: ${parkingstatistics[key]}`);
19735
+ * }
19736
+ *
19737
+ * // Validation
19738
+ * const isValidKey = KEYS_PARKING_STATISTICS.includes(someKey);
19739
+ * ```
19740
+ *
19741
+ * @see {@link ParkingStatistics} - The TypeScript type definition
19742
+ */
19743
+ export const KEYS_PARKING_STATISTICS = [
19744
+ KEY_PARKING_STATISTICS_CONVERSIONS,
19745
+ KEY_PARKING_STATISTICS_PROFIT,
19746
+ KEY_PARKING_STATISTICS_REVENUE,
19747
+ KEY_PARKING_STATISTICS_RPC,
19748
+ KEY_PARKING_STATISTICS_RPM,
19749
+ KEY_PARKING_STATISTICS_VIEWS,
19750
+ ] as const satisfies (keyof ParkingStatistics)[];
19751
+
19487
19752
  /**
19488
19753
  * New Password
19489
19754
  *
@@ -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 ParkingParkingIdMetrics endpoint
4677
+ *
4678
+ * Get metrics for a parking entry
4679
+ * Retrieves metrics for a specific parking entry by ID
4680
+ *
4681
+ * @remarks
4682
+ * This type defines the complete request structure for the GET ParkingParkingIdMetrics 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/{parking_id}/metrics
4690
+ *
4691
+ * @see {@link GET_ParkingParkingIdMetrics_Request_Query} - Query parameters type
4692
+ * @see {@link GET_ParkingParkingIdMetrics_Request_Path} - Path parameters type
4693
+ * @see {@link GET_ParkingParkingIdMetrics_Request_Body} - Request body type
4694
+ */
4695
+ export type GET_ParkingParkingIdMetrics_Request = {
4696
+ parameters: {
4697
+ path: operations['get_parking_metrics_v1_parking__parking_id__metrics_get']['parameters']['path'];
4698
+ };
4699
+ }
4700
+ /**
4701
+ * Path parameters for GET /v1/parking/{parking_id}/metrics
4702
+ *
4703
+ * @remarks
4704
+ * This type defines the path parameters for the GET /v1/parking/{parking_id}/metrics endpoint.
4705
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
4706
+ *
4707
+ * @example
4708
+ * Use this type to ensure type safety for path parameters.
4709
+ *
4710
+ * @path /v1/parking/{parking_id}/metrics
4711
+ */
4712
+ export type GET_ParkingParkingIdMetrics_Request_Path = GET_ParkingParkingIdMetrics_Request['parameters']['path'];
4713
+
4675
4714
  /**
4676
4715
  * Request type for GET Tlds endpoint
4677
4716
  *
@@ -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, 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, TldSpecification, UserPublic, UserPublicWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
38
38
 
39
39
  /**
40
40
  * Response types for GET ArchiveEmailForwardLogsAliasesByEmailForwardAliasId endpoint
@@ -8944,6 +8944,116 @@ export type GET_Parking_Response_403 = Problem
8944
8944
  */
8945
8945
  export type GET_Parking_Response_422 = HTTPValidationError
8946
8946
 
8947
+ /**
8948
+ * Response types for GET ParkingByParkingIdMetrics endpoint
8949
+ *
8950
+ * Get metrics for a parking entry
8951
+ * Retrieves metrics for a specific parking entry by ID
8952
+ *
8953
+ * @remarks
8954
+ * This type defines all possible response structures for the GET ParkingByParkingIdMetrics endpoint.
8955
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
8956
+ * Use this type to ensure type safety when handling API responses from this endpoint.
8957
+ *
8958
+
8959
+ *
8960
+ * @path /v1/parking/{parking_id}/metrics
8961
+ *
8962
+ * @see {@link GET_ParkingByParkingIdMetrics_Response_200} - 200 response type
8963
+ * @see {@link GET_ParkingByParkingIdMetrics_Response_401} - 401 response type
8964
+ * @see {@link GET_ParkingByParkingIdMetrics_Response_403} - 403 response type
8965
+ * @see {@link GET_ParkingByParkingIdMetrics_Response_404} - 404 response type
8966
+ * @see {@link GET_ParkingByParkingIdMetrics_Response_422} - 422 response type
8967
+ *
8968
+
8969
+ */
8970
+ export type GET_ParkingByParkingIdMetrics_Response = GET_ParkingByParkingIdMetrics_Response_200 | GET_ParkingByParkingIdMetrics_Response_401 | GET_ParkingByParkingIdMetrics_Response_403 | GET_ParkingByParkingIdMetrics_Response_404 | GET_ParkingByParkingIdMetrics_Response_422;
8971
+
8972
+ /**
8973
+ * 200 response for GET ParkingByParkingIdMetrics endpoint
8974
+ *
8975
+ * @remarks
8976
+ * This type defines the response structure for the 200 status code
8977
+ * of the GET ParkingByParkingIdMetrics endpoint.
8978
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
8979
+ *
8980
+
8981
+ *
8982
+ * @path /v1/parking/{parking_id}/metrics
8983
+ *
8984
+ * @see {@link GET_ParkingByParkingIdMetrics_Response} - The main response type definition
8985
+ * @see {@link ParkingMetrics} - The actual schema type definition
8986
+ */
8987
+ export type GET_ParkingByParkingIdMetrics_Response_200 = ParkingMetrics
8988
+
8989
+ /**
8990
+ * 401 response for GET ParkingByParkingIdMetrics endpoint
8991
+ *
8992
+ * @remarks
8993
+ * This type defines the response structure for the 401 status code
8994
+ * of the GET ParkingByParkingIdMetrics endpoint.
8995
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
8996
+ *
8997
+
8998
+ *
8999
+ * @path /v1/parking/{parking_id}/metrics
9000
+ *
9001
+ * @see {@link GET_ParkingByParkingIdMetrics_Response} - The main response type definition
9002
+ * @see {@link Problem} - The actual schema type definition
9003
+ */
9004
+ export type GET_ParkingByParkingIdMetrics_Response_401 = Problem
9005
+
9006
+ /**
9007
+ * 403 response for GET ParkingByParkingIdMetrics endpoint
9008
+ *
9009
+ * @remarks
9010
+ * This type defines the response structure for the 403 status code
9011
+ * of the GET ParkingByParkingIdMetrics endpoint.
9012
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
9013
+ *
9014
+
9015
+ *
9016
+ * @path /v1/parking/{parking_id}/metrics
9017
+ *
9018
+ * @see {@link GET_ParkingByParkingIdMetrics_Response} - The main response type definition
9019
+ * @see {@link Problem} - The actual schema type definition
9020
+ */
9021
+ export type GET_ParkingByParkingIdMetrics_Response_403 = Problem
9022
+
9023
+ /**
9024
+ * 404 response for GET ParkingByParkingIdMetrics endpoint
9025
+ *
9026
+ * @remarks
9027
+ * This type defines the response structure for the 404 status code
9028
+ * of the GET ParkingByParkingIdMetrics endpoint.
9029
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
9030
+ *
9031
+
9032
+ *
9033
+ * @path /v1/parking/{parking_id}/metrics
9034
+ *
9035
+ * @see {@link GET_ParkingByParkingIdMetrics_Response} - The main response type definition
9036
+ * @see {@link Problem} - The actual schema type definition
9037
+ */
9038
+ export type GET_ParkingByParkingIdMetrics_Response_404 = Problem
9039
+
9040
+ /**
9041
+ * 422 response for GET ParkingByParkingIdMetrics endpoint
9042
+ *
9043
+ * @remarks
9044
+ * This type defines the response structure for the 422 status code
9045
+ * of the GET ParkingByParkingIdMetrics endpoint.
9046
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
9047
+ *
9048
+
9049
+ *
9050
+ * @path /v1/parking/{parking_id}/metrics
9051
+ *
9052
+ * @see {@link GET_ParkingByParkingIdMetrics_Response} - The main response type definition
9053
+ * @see {@link HTTPValidationError} - The actual schema type definition
9054
+ */
9055
+ export type GET_ParkingByParkingIdMetrics_Response_422 = HTTPValidationError
9056
+
8947
9057
  /**
8948
9058
  * Response types for GET Tlds endpoint
8949
9059
  *
@@ -3135,6 +3135,22 @@ export type Pagination_RequestHistory = components['schemas']['Pagination_Reques
3135
3135
  * @see {@link components} - The OpenAPI components schema definition
3136
3136
  */
3137
3137
  export type Pagination_UserPublic = components['schemas']['Pagination_UserPublic_'];
3138
+ /**
3139
+ * ParkingMetricsResponse
3140
+ *
3141
+ * @remarks
3142
+ * Type alias for the `ParkingMetricsResponse` OpenAPI schema.
3143
+ * This type represents parkingmetricsresponse data structures used in API requests and responses.
3144
+ *
3145
+ * @example
3146
+ * ```typescript
3147
+ * const response = await api.getParkingMetrics();
3148
+ * const item: ParkingMetrics = response.results;
3149
+ * ```
3150
+ *
3151
+ * @see {@link components} - The OpenAPI components schema definition
3152
+ */
3153
+ export type ParkingMetrics = components['schemas']['ParkingMetricsResponse'];
3138
3154
  /**
3139
3155
  * ParkingResponse
3140
3156
  *
@@ -3167,6 +3183,22 @@ export type Parking = components['schemas']['ParkingResponse'];
3167
3183
  * @see {@link components} - The OpenAPI components schema definition
3168
3184
  */
3169
3185
  export type ParkingSortField = components['schemas']['ParkingSortField'];
3186
+ /**
3187
+ * ParkingStatistics
3188
+ *
3189
+ * @remarks
3190
+ * Type alias for the `ParkingStatistics` OpenAPI schema.
3191
+ * This type represents parkingstatistics data structures used in API requests and responses.
3192
+ *
3193
+ * @example
3194
+ * ```typescript
3195
+ * const response = await api.getParkingStatistics();
3196
+ * const item: ParkingStatistics = response.results;
3197
+ * ```
3198
+ *
3199
+ * @see {@link components} - The OpenAPI components schema definition
3200
+ */
3201
+ export type ParkingStatistics = components['schemas']['ParkingStatistics'];
3170
3202
  /**
3171
3203
  * PasswordUpdate
3172
3204
  *
package/src/openapi.yaml CHANGED
@@ -4905,6 +4905,25 @@ components:
4905
4905
  - pagination
4906
4906
  title: Pagination[UserPublic]
4907
4907
  type: object
4908
+ ParkingMetricsResponse:
4909
+ properties:
4910
+ parking_id:
4911
+ description: Unique identifier for the parking entry
4912
+ examples:
4913
+ - parking_01h45ytscbebyvny4gc8cr8ma2
4914
+ format: typeid
4915
+ pattern: ^parking_[0-7][0-9a-hjkmnpq-tv-z]{25}$
4916
+ title: Parking Id
4917
+ type: string
4918
+ x-typeid-prefix: parking
4919
+ statistics:
4920
+ $ref: '#/components/schemas/ParkingStatistics'
4921
+ description: Statistics for the parking entry
4922
+ required:
4923
+ - parking_id
4924
+ - statistics
4925
+ title: ParkingMetricsResponse
4926
+ type: object
4908
4927
  ParkingResponse:
4909
4928
  properties:
4910
4929
  compliance_status:
@@ -4972,6 +4991,45 @@ components:
4972
4991
  - updated_on
4973
4992
  title: ParkingSortField
4974
4993
  type: string
4994
+ ParkingStatistics:
4995
+ properties:
4996
+ conversions:
4997
+ description: Number of conversions
4998
+ title: Conversions
4999
+ type: integer
5000
+ profit:
5001
+ description: Total profit
5002
+ pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
5003
+ title: Profit
5004
+ type: string
5005
+ revenue:
5006
+ description: Total revenue
5007
+ pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
5008
+ title: Revenue
5009
+ type: string
5010
+ rpc:
5011
+ description: Revenue per click
5012
+ pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
5013
+ title: Rpc
5014
+ type: string
5015
+ rpm:
5016
+ description: Revenue per mille (thousand views)
5017
+ pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
5018
+ title: Rpm
5019
+ type: string
5020
+ views:
5021
+ description: Number of views
5022
+ title: Views
5023
+ type: integer
5024
+ required:
5025
+ - views
5026
+ - conversions
5027
+ - rpc
5028
+ - rpm
5029
+ - revenue
5030
+ - profit
5031
+ title: ParkingStatistics
5032
+ type: object
4975
5033
  PasswordUpdate:
4976
5034
  properties:
4977
5035
  new_password:
@@ -6755,7 +6813,7 @@ info:
6755
6813
  '
6756
6814
  summary: OpusDNS - your gateway to a seamless domain management experience.
6757
6815
  title: OpusDNS API
6758
- version: 2026-01-21-134818
6816
+ version: 2026-01-21-160000
6759
6817
  x-logo:
6760
6818
  altText: OpusDNS API Reference
6761
6819
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -14762,6 +14820,77 @@ paths:
14762
14820
  summary: List parking entries
14763
14821
  tags:
14764
14822
  - parking
14823
+ /v1/parking/{parking_id}/metrics:
14824
+ get:
14825
+ description: Retrieves metrics for a specific parking entry by ID
14826
+ operationId: get_parking_metrics_v1_parking__parking_id__metrics_get
14827
+ parameters:
14828
+ - in: path
14829
+ name: parking_id
14830
+ required: true
14831
+ schema:
14832
+ examples:
14833
+ - parking_01h45ytscbebyvny4gc8cr8ma2
14834
+ format: typeid
14835
+ pattern: ^parking_[0-7][0-9a-hjkmnpq-tv-z]{25}$
14836
+ title: Parking Id
14837
+ type: string
14838
+ x-typeid-prefix: parking
14839
+ responses:
14840
+ '200':
14841
+ content:
14842
+ application/json:
14843
+ schema:
14844
+ $ref: '#/components/schemas/ParkingMetricsResponse'
14845
+ description: Successful Response
14846
+ '401':
14847
+ content:
14848
+ application/problem+json:
14849
+ example:
14850
+ code: ERROR_AUTHENTICATION
14851
+ detail: Additional error context.
14852
+ status: 401
14853
+ title: Authentication Error
14854
+ type: authentication
14855
+ schema:
14856
+ $ref: '#/components/schemas/Problem'
14857
+ description: Unauthorized
14858
+ '403':
14859
+ content:
14860
+ application/problem+json:
14861
+ example:
14862
+ code: ERROR_PERMISSION_DENIED
14863
+ detail: Insufficient permissions to perform this action
14864
+ status: 403
14865
+ title: Permission Denied
14866
+ type: permission-denied
14867
+ schema:
14868
+ $ref: '#/components/schemas/Problem'
14869
+ description: Forbidden
14870
+ '404':
14871
+ content:
14872
+ application/problem+json:
14873
+ example:
14874
+ code: ERROR_PARKING_NOT_FOUND
14875
+ detail: 'Parking not found for domain: parking_abc123'
14876
+ status: 404
14877
+ title: Parking Error
14878
+ type: parking-not-found
14879
+ schema:
14880
+ $ref: '#/components/schemas/Problem'
14881
+ description: Not Found
14882
+ '422':
14883
+ content:
14884
+ application/problem+json:
14885
+ schema:
14886
+ $ref: '#/components/schemas/HTTPValidationError'
14887
+ description: Validation Error
14888
+ security:
14889
+ - OAuth2PasswordBearer: []
14890
+ - APIKeyHeader: []
14891
+ summary: Get metrics for a parking entry
14892
+ tags:
14893
+ - parking
14765
14894
  /v1/tlds/:
14766
14895
  get:
14767
14896
  description: Retrieves a list of TLD Specifications we have support for
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/{parking_id}/metrics": {
1572
+ parameters: {
1573
+ query?: never;
1574
+ header?: never;
1575
+ path?: never;
1576
+ cookie?: never;
1577
+ };
1578
+ /**
1579
+ * Get metrics for a parking entry
1580
+ * @description Retrieves metrics for a specific parking entry by ID
1581
+ */
1582
+ get: operations["get_parking_metrics_v1_parking__parking_id__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/tlds/": {
1572
1592
  parameters: {
1573
1593
  query?: never;
@@ -5019,6 +5039,18 @@ export interface components {
5019
5039
  /** Results */
5020
5040
  results: components["schemas"]["UserPublic"][];
5021
5041
  };
5042
+ /** ParkingMetricsResponse */
5043
+ ParkingMetricsResponse: {
5044
+ /**
5045
+ * Parking Id
5046
+ * Format: typeid
5047
+ * @description Unique identifier for the parking entry
5048
+ * @example parking_01h45ytscbebyvny4gc8cr8ma2
5049
+ */
5050
+ parking_id: TypeId<"parking">;
5051
+ /** @description Statistics for the parking entry */
5052
+ statistics: components["schemas"]["ParkingStatistics"];
5053
+ };
5022
5054
  /** ParkingResponse */
5023
5055
  ParkingResponse: {
5024
5056
  /** @description The compliance status of the parking ad */
@@ -5073,6 +5105,39 @@ export interface components {
5073
5105
  * @enum {string}
5074
5106
  */
5075
5107
  ParkingSortField: "domain" | "created_on" | "updated_on";
5108
+ /** ParkingStatistics */
5109
+ ParkingStatistics: {
5110
+ /**
5111
+ * Conversions
5112
+ * @description Number of conversions
5113
+ */
5114
+ conversions: number;
5115
+ /**
5116
+ * Profit
5117
+ * @description Total profit
5118
+ */
5119
+ profit: string;
5120
+ /**
5121
+ * Revenue
5122
+ * @description Total revenue
5123
+ */
5124
+ revenue: string;
5125
+ /**
5126
+ * Rpc
5127
+ * @description Revenue per click
5128
+ */
5129
+ rpc: string;
5130
+ /**
5131
+ * Rpm
5132
+ * @description Revenue per mille (thousand views)
5133
+ */
5134
+ rpm: string;
5135
+ /**
5136
+ * Views
5137
+ * @description Number of views
5138
+ */
5139
+ views: number;
5140
+ };
5076
5141
  /** PasswordUpdate */
5077
5142
  PasswordUpdate: {
5078
5143
  /**
@@ -12725,6 +12790,85 @@ export interface operations {
12725
12790
  };
12726
12791
  };
12727
12792
  };
12793
+ get_parking_metrics_v1_parking__parking_id__metrics_get: {
12794
+ parameters: {
12795
+ query?: never;
12796
+ header?: never;
12797
+ path: {
12798
+ parking_id: TypeId<"parking">;
12799
+ };
12800
+ cookie?: never;
12801
+ };
12802
+ requestBody?: never;
12803
+ responses: {
12804
+ /** @description Successful Response */
12805
+ 200: {
12806
+ headers: {
12807
+ [name: string]: unknown;
12808
+ };
12809
+ content: {
12810
+ "application/json": components["schemas"]["ParkingMetricsResponse"];
12811
+ };
12812
+ };
12813
+ /** @description Unauthorized */
12814
+ 401: {
12815
+ headers: {
12816
+ [name: string]: unknown;
12817
+ };
12818
+ content: {
12819
+ /** @example {
12820
+ * "code": "ERROR_AUTHENTICATION",
12821
+ * "detail": "Additional error context.",
12822
+ * "status": 401,
12823
+ * "title": "Authentication Error",
12824
+ * "type": "authentication"
12825
+ * } */
12826
+ "application/problem+json": components["schemas"]["Problem"];
12827
+ };
12828
+ };
12829
+ /** @description Forbidden */
12830
+ 403: {
12831
+ headers: {
12832
+ [name: string]: unknown;
12833
+ };
12834
+ content: {
12835
+ /** @example {
12836
+ * "code": "ERROR_PERMISSION_DENIED",
12837
+ * "detail": "Insufficient permissions to perform this action",
12838
+ * "status": 403,
12839
+ * "title": "Permission Denied",
12840
+ * "type": "permission-denied"
12841
+ * } */
12842
+ "application/problem+json": components["schemas"]["Problem"];
12843
+ };
12844
+ };
12845
+ /** @description Not Found */
12846
+ 404: {
12847
+ headers: {
12848
+ [name: string]: unknown;
12849
+ };
12850
+ content: {
12851
+ /** @example {
12852
+ * "code": "ERROR_PARKING_NOT_FOUND",
12853
+ * "detail": "Parking not found for domain: parking_abc123",
12854
+ * "status": 404,
12855
+ * "title": "Parking Error",
12856
+ * "type": "parking-not-found"
12857
+ * } */
12858
+ "application/problem+json": components["schemas"]["Problem"];
12859
+ };
12860
+ };
12861
+ /** @description Validation Error */
12862
+ 422: {
12863
+ headers: {
12864
+ [name: string]: unknown;
12865
+ };
12866
+ content: {
12867
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
12868
+ };
12869
+ };
12870
+ };
12871
+ };
12728
12872
  get_tld_specifications_v1_tlds__get: {
12729
12873
  parameters: {
12730
12874
  query?: {