@opusdns/api 0.180.0 → 0.182.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.180.0",
6
+ "version": "0.182.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -6677,6 +6677,31 @@ export const KEYS_DOMAIN_DNSSEC_DATA = [
6677
6677
  * @see {@link KEYS_DOMAIN_FORWARD} - Array of all keys for this type
6678
6678
  */
6679
6679
  export const KEY_DOMAIN_FORWARD_CREATED_ON: keyof DomainForward = 'created_on';
6680
+ /**
6681
+ * Domain Forward Id
6682
+ *
6683
+ *
6684
+ * @type {string}
6685
+ *
6686
+ *
6687
+ * @remarks
6688
+ * This key constant provides type-safe access to the `domain_forward_id` property of DomainForward objects.
6689
+ * Use this constant when you need to access properties dynamically or ensure type safety.
6690
+ *
6691
+ * @example
6692
+ * ```typescript
6693
+ * // Direct property access
6694
+ * const value = domainforward[KEY_DOMAIN_FORWARD_DOMAIN_FORWARD_ID];
6695
+ *
6696
+ * // Dynamic property access
6697
+ * const propertyName = KEY_DOMAIN_FORWARD_DOMAIN_FORWARD_ID;
6698
+ * const value = domainforward[propertyName];
6699
+ * ```
6700
+ *
6701
+ * @see {@link DomainForward} - The TypeScript type definition
6702
+ * @see {@link KEYS_DOMAIN_FORWARD} - Array of all keys for this type
6703
+ */
6704
+ export const KEY_DOMAIN_FORWARD_DOMAIN_FORWARD_ID: keyof DomainForward = 'domain_forward_id';
6680
6705
  /**
6681
6706
  * Enabled
6682
6707
  *
@@ -6847,6 +6872,7 @@ export const KEY_DOMAIN_FORWARD_UPDATED_ON: keyof DomainForward = 'updated_on';
6847
6872
  */
6848
6873
  export const KEYS_DOMAIN_FORWARD = [
6849
6874
  KEY_DOMAIN_FORWARD_CREATED_ON,
6875
+ KEY_DOMAIN_FORWARD_DOMAIN_FORWARD_ID,
6850
6876
  KEY_DOMAIN_FORWARD_ENABLED,
6851
6877
  KEY_DOMAIN_FORWARD_HOSTNAME,
6852
6878
  KEY_DOMAIN_FORWARD_HTTP,
@@ -19435,6 +19461,31 @@ export const KEY_PARKING_METRICS_METRICS: keyof ParkingMetrics = 'metrics';
19435
19461
  * @see {@link KEYS_PARKING_METRICS} - Array of all keys for this type
19436
19462
  */
19437
19463
  export const KEY_PARKING_METRICS_RENEWAL_COST: keyof ParkingMetrics = 'renewal_cost';
19464
+ /**
19465
+ * renewal_cost_currency property
19466
+ *
19467
+ * Currency code for renewal cost (e.g., USD, EUR)
19468
+ *
19469
+ *
19470
+ *
19471
+ * @remarks
19472
+ * This key constant provides type-safe access to the `renewal_cost_currency` property of ParkingMetrics objects.
19473
+ * Use this constant when you need to access properties dynamically or ensure type safety.
19474
+ *
19475
+ * @example
19476
+ * ```typescript
19477
+ * // Direct property access
19478
+ * const value = parkingmetrics[KEY_PARKING_METRICS_RENEWAL_COST_CURRENCY];
19479
+ *
19480
+ * // Dynamic property access
19481
+ * const propertyName = KEY_PARKING_METRICS_RENEWAL_COST_CURRENCY;
19482
+ * const value = parkingmetrics[propertyName];
19483
+ * ```
19484
+ *
19485
+ * @see {@link ParkingMetrics} - The TypeScript type definition
19486
+ * @see {@link KEYS_PARKING_METRICS} - Array of all keys for this type
19487
+ */
19488
+ export const KEY_PARKING_METRICS_RENEWAL_COST_CURRENCY: keyof ParkingMetrics = 'renewal_cost_currency';
19438
19489
  /**
19439
19490
  * Revenue Progress
19440
19491
  *
@@ -19485,6 +19536,7 @@ export const KEY_PARKING_METRICS_REVENUE_PROGRESS: keyof ParkingMetrics = 'reven
19485
19536
  export const KEYS_PARKING_METRICS = [
19486
19537
  KEY_PARKING_METRICS_METRICS,
19487
19538
  KEY_PARKING_METRICS_RENEWAL_COST,
19539
+ KEY_PARKING_METRICS_RENEWAL_COST_CURRENCY,
19488
19540
  KEY_PARKING_METRICS_REVENUE_PROGRESS,
19489
19541
  ] as const satisfies (keyof ParkingMetrics)[];
19490
19542
 
@@ -20034,6 +20086,31 @@ export const KEY_PARKING_STATISTICS_CONVERSIONS: keyof ParkingStatistics = 'conv
20034
20086
  * @see {@link KEYS_PARKING_STATISTICS} - Array of all keys for this type
20035
20087
  */
20036
20088
  export const KEY_PARKING_STATISTICS_REVENUE: keyof ParkingStatistics = 'revenue';
20089
+ /**
20090
+ * revenue_currency property
20091
+ *
20092
+ * Currency code for revenue (e.g., USD, EUR)
20093
+ *
20094
+ *
20095
+ *
20096
+ * @remarks
20097
+ * This key constant provides type-safe access to the `revenue_currency` property of ParkingStatistics objects.
20098
+ * Use this constant when you need to access properties dynamically or ensure type safety.
20099
+ *
20100
+ * @example
20101
+ * ```typescript
20102
+ * // Direct property access
20103
+ * const value = parkingstatistics[KEY_PARKING_STATISTICS_REVENUE_CURRENCY];
20104
+ *
20105
+ * // Dynamic property access
20106
+ * const propertyName = KEY_PARKING_STATISTICS_REVENUE_CURRENCY;
20107
+ * const value = parkingstatistics[propertyName];
20108
+ * ```
20109
+ *
20110
+ * @see {@link ParkingStatistics} - The TypeScript type definition
20111
+ * @see {@link KEYS_PARKING_STATISTICS} - Array of all keys for this type
20112
+ */
20113
+ export const KEY_PARKING_STATISTICS_REVENUE_CURRENCY: keyof ParkingStatistics = 'revenue_currency';
20037
20114
  /**
20038
20115
  * Rpc
20039
20116
  *
@@ -20136,6 +20213,7 @@ export const KEY_PARKING_STATISTICS_VIEWS: keyof ParkingStatistics = 'views';
20136
20213
  export const KEYS_PARKING_STATISTICS = [
20137
20214
  KEY_PARKING_STATISTICS_CONVERSIONS,
20138
20215
  KEY_PARKING_STATISTICS_REVENUE,
20216
+ KEY_PARKING_STATISTICS_REVENUE_CURRENCY,
20139
20217
  KEY_PARKING_STATISTICS_RPC,
20140
20218
  KEY_PARKING_STATISTICS_RPM,
20141
20219
  KEY_PARKING_STATISTICS_VIEWS,
package/src/openapi.yaml CHANGED
@@ -1607,6 +1607,14 @@ components:
1607
1607
  format: date-time
1608
1608
  title: Created On
1609
1609
  type: string
1610
+ domain_forward_id:
1611
+ examples:
1612
+ - domain_forward_01h45ytscbebyvny4gc8cr8ma2
1613
+ format: typeid
1614
+ pattern: ^domain_forward_[0-7][0-9a-hjkmnpq-tv-z]{25}$
1615
+ title: Domain Forward Id
1616
+ type: string
1617
+ x-typeid-prefix: domain_forward
1610
1618
  enabled:
1611
1619
  title: Enabled
1612
1620
  type: boolean
@@ -1636,6 +1644,7 @@ components:
1636
1644
  title: Updated On
1637
1645
  type: string
1638
1646
  required:
1647
+ - domain_forward_id
1639
1648
  - hostname
1640
1649
  - enabled
1641
1650
  - updated_on
@@ -4984,6 +4993,9 @@ components:
4984
4993
  pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
4985
4994
  title: Renewal Cost
4986
4995
  type: string
4996
+ renewal_cost_currency:
4997
+ $ref: '#/components/schemas/Currency'
4998
+ description: Currency code for renewal cost (e.g., USD, EUR)
4987
4999
  revenue_progress:
4988
5000
  description: Revenue progress percentage towards covering renewal cost
4989
5001
  pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
@@ -4992,6 +5004,7 @@ components:
4992
5004
  required:
4993
5005
  - metrics
4994
5006
  - renewal_cost
5007
+ - renewal_cost_currency
4995
5008
  - revenue_progress
4996
5009
  title: ParkingMetricsResponse
4997
5010
  type: object
@@ -5123,6 +5136,9 @@ components:
5123
5136
  pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
5124
5137
  title: Revenue
5125
5138
  type: string
5139
+ revenue_currency:
5140
+ $ref: '#/components/schemas/Currency'
5141
+ description: Currency code for revenue (e.g., USD, EUR)
5126
5142
  rpc:
5127
5143
  description: Revenue per click
5128
5144
  pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
@@ -5143,6 +5159,7 @@ components:
5143
5159
  - rpc
5144
5160
  - rpm
5145
5161
  - revenue
5162
+ - revenue_currency
5146
5163
  title: ParkingStatistics
5147
5164
  type: object
5148
5165
  ParkingTotalMetricsResponse:
@@ -6960,7 +6977,7 @@ info:
6960
6977
  '
6961
6978
  summary: OpusDNS - your gateway to a seamless domain management experience.
6962
6979
  title: OpusDNS API
6963
- version: 2026-01-30-115347
6980
+ version: 2026-01-31-195140
6964
6981
  x-logo:
6965
6982
  altText: OpusDNS API Reference
6966
6983
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -8895,6 +8912,7 @@ paths:
8895
8912
  results:
8896
8913
  - domain_forwards:
8897
8914
  - created_on: '2025-11-18T12:59:57Z'
8915
+ domain_forward_id: domain_forward_01jx0000000000000000000001
8898
8916
  enabled: false
8899
8917
  hostname: example.com.
8900
8918
  https:
@@ -9321,6 +9339,7 @@ paths:
9321
9339
  value:
9322
9340
  domain_forwards:
9323
9341
  - created_on: '2025-11-18T12:59:57Z'
9342
+ domain_forward_id: domain_forward_01jx0000000000000000000001
9324
9343
  enabled: false
9325
9344
  hostname: example.com.
9326
9345
  https:
@@ -9942,6 +9961,7 @@ paths:
9942
9961
  summary: Response for HTTP domain forward
9943
9962
  value:
9944
9963
  created_on: '2025-11-14T09:01:38'
9964
+ domain_forward_id: domain_forward_01jx0000000000000000000001
9945
9965
  enabled: false
9946
9966
  hostname: example.com.
9947
9967
  http:
@@ -9972,6 +9992,7 @@ paths:
9972
9992
  summary: Response for HTTP to HTTPS
9973
9993
  value:
9974
9994
  created_on: '2025-11-14T09:01:38'
9995
+ domain_forward_id: domain_forward_01jx0000000000000000000002
9975
9996
  enabled: false
9976
9997
  hostname: example.com.
9977
9998
  http:
package/src/schema.d.ts CHANGED
@@ -2950,6 +2950,12 @@ export interface components {
2950
2950
  * Format: date-time
2951
2951
  */
2952
2952
  created_on: Date;
2953
+ /**
2954
+ * Domain Forward Id
2955
+ * Format: typeid
2956
+ * @example domain_forward_01h45ytscbebyvny4gc8cr8ma2
2957
+ */
2958
+ domain_forward_id: TypeId<"domain_forward">;
2953
2959
  /** Enabled */
2954
2960
  enabled: boolean;
2955
2961
  /** Hostname */
@@ -5147,6 +5153,8 @@ export interface components {
5147
5153
  * @description Yearly renewal cost for the parked domain
5148
5154
  */
5149
5155
  renewal_cost: string;
5156
+ /** @description Currency code for renewal cost (e.g., USD, EUR) */
5157
+ renewal_cost_currency: components["schemas"]["Currency"];
5150
5158
  /**
5151
5159
  * Revenue Progress
5152
5160
  * @description Revenue progress percentage towards covering renewal cost
@@ -5264,6 +5272,8 @@ export interface components {
5264
5272
  * @description Total revenue
5265
5273
  */
5266
5274
  revenue: string;
5275
+ /** @description Currency code for revenue (e.g., USD, EUR) */
5276
+ revenue_currency: components["schemas"]["Currency"];
5267
5277
  /**
5268
5278
  * Rpc
5269
5279
  * @description Revenue per click