@opusdns/api 0.94.0 → 0.95.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.9.1"
4
4
  },
5
5
  "name": "@opusdns/api",
6
- "version": "0.94.0",
6
+ "version": "0.95.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -76,6 +76,7 @@ import { DomainForwardProtocolSet } from './schemas';
76
76
  import { DomainForwardRequest } from './schemas';
77
77
  import { DomainForwardSetRequest } from './schemas';
78
78
  import { DomainForwardSet } from './schemas';
79
+ import { DomainForwardZone } from './schemas';
79
80
  import { DomainLifecycleBase } from './schemas';
80
81
  import { DomainNameParts } from './schemas';
81
82
  import { DomainPeriod } from './schemas';
@@ -6670,30 +6671,6 @@ export const KEYS_DOMAIN_FORWARD_PATCH_OPS = [
6670
6671
  KEY_DOMAIN_FORWARD_PATCH_OPS_OPS,
6671
6672
  ] as const satisfies (keyof DomainForwardPatchOps)[];
6672
6673
 
6673
- /**
6674
- * Created On
6675
- *
6676
- *
6677
- *
6678
- *
6679
- * @remarks
6680
- * This key constant provides type-safe access to the `created_on` property of DomainForwardProtocolSetRequest objects.
6681
- * Use this constant when you need to access properties dynamically or ensure type safety.
6682
- *
6683
- * @example
6684
- * ```typescript
6685
- * // Direct property access
6686
- * const value = domainforwardprotocolsetrequest[KEY_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST_CREATED_ON];
6687
- *
6688
- * // Dynamic property access
6689
- * const propertyName = KEY_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST_CREATED_ON;
6690
- * const value = domainforwardprotocolsetrequest[propertyName];
6691
- * ```
6692
- *
6693
- * @see {@link DomainForwardProtocolSetRequest} - The TypeScript type definition
6694
- * @see {@link KEYS_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST} - Array of all keys for this type
6695
- */
6696
- export const KEY_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST_CREATED_ON = 'created_on' as keyof DomainForwardProtocolSetRequest;
6697
6674
  /**
6698
6675
  * Redirects
6699
6676
  *
@@ -6719,30 +6696,6 @@ export const KEY_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST_CREATED_ON = 'created_on' a
6719
6696
  * @see {@link KEYS_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST} - Array of all keys for this type
6720
6697
  */
6721
6698
  export const KEY_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST_REDIRECTS = 'redirects' as keyof DomainForwardProtocolSetRequest;
6722
- /**
6723
- * Updated On
6724
- *
6725
- *
6726
- *
6727
- *
6728
- * @remarks
6729
- * This key constant provides type-safe access to the `updated_on` property of DomainForwardProtocolSetRequest objects.
6730
- * Use this constant when you need to access properties dynamically or ensure type safety.
6731
- *
6732
- * @example
6733
- * ```typescript
6734
- * // Direct property access
6735
- * const value = domainforwardprotocolsetrequest[KEY_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST_UPDATED_ON];
6736
- *
6737
- * // Dynamic property access
6738
- * const propertyName = KEY_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST_UPDATED_ON;
6739
- * const value = domainforwardprotocolsetrequest[propertyName];
6740
- * ```
6741
- *
6742
- * @see {@link DomainForwardProtocolSetRequest} - The TypeScript type definition
6743
- * @see {@link KEYS_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST} - Array of all keys for this type
6744
- */
6745
- export const KEY_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST_UPDATED_ON = 'updated_on' as keyof DomainForwardProtocolSetRequest;
6746
6699
  /**
6747
6700
  * Wildcard
6748
6701
  *
@@ -6789,9 +6742,7 @@ export const KEY_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST_WILDCARD = 'wildcard' as ke
6789
6742
  * @see {@link DomainForwardProtocolSetRequest} - The TypeScript type definition
6790
6743
  */
6791
6744
  export const KEYS_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST = [
6792
- KEY_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST_CREATED_ON,
6793
6745
  KEY_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST_REDIRECTS,
6794
- KEY_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST_UPDATED_ON,
6795
6746
  KEY_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST_WILDCARD,
6796
6747
  ] as const satisfies (keyof DomainForwardProtocolSetRequest)[];
6797
6748
 
@@ -7277,6 +7228,108 @@ export const KEYS_DOMAIN_FORWARD_SET = [
7277
7228
  KEY_DOMAIN_FORWARD_SET_WILDCARD,
7278
7229
  ] as const satisfies (keyof DomainForwardSet)[];
7279
7230
 
7231
+ /**
7232
+ * Domain Forwards
7233
+ *
7234
+ *
7235
+ * @type {array}
7236
+ *
7237
+ *
7238
+ * @remarks
7239
+ * This key constant provides type-safe access to the `domain_forwards` property of DomainForwardZone objects.
7240
+ * Use this constant when you need to access properties dynamically or ensure type safety.
7241
+ *
7242
+ * @example
7243
+ * ```typescript
7244
+ * // Direct property access
7245
+ * const value = domainforwardzone[KEY_DOMAIN_FORWARD_ZONE_DOMAIN_FORWARDS];
7246
+ *
7247
+ * // Dynamic property access
7248
+ * const propertyName = KEY_DOMAIN_FORWARD_ZONE_DOMAIN_FORWARDS;
7249
+ * const value = domainforwardzone[propertyName];
7250
+ * ```
7251
+ *
7252
+ * @see {@link DomainForwardZone} - The TypeScript type definition
7253
+ * @see {@link KEYS_DOMAIN_FORWARD_ZONE} - Array of all keys for this type
7254
+ */
7255
+ export const KEY_DOMAIN_FORWARD_ZONE_DOMAIN_FORWARDS = 'domain_forwards' as keyof DomainForwardZone;
7256
+ /**
7257
+ * Zone Id
7258
+ *
7259
+ *
7260
+ * @type {string}
7261
+ *
7262
+ *
7263
+ * @remarks
7264
+ * This key constant provides type-safe access to the `zone_id` property of DomainForwardZone objects.
7265
+ * Use this constant when you need to access properties dynamically or ensure type safety.
7266
+ *
7267
+ * @example
7268
+ * ```typescript
7269
+ * // Direct property access
7270
+ * const value = domainforwardzone[KEY_DOMAIN_FORWARD_ZONE_ZONE_ID];
7271
+ *
7272
+ * // Dynamic property access
7273
+ * const propertyName = KEY_DOMAIN_FORWARD_ZONE_ZONE_ID;
7274
+ * const value = domainforwardzone[propertyName];
7275
+ * ```
7276
+ *
7277
+ * @see {@link DomainForwardZone} - The TypeScript type definition
7278
+ * @see {@link KEYS_DOMAIN_FORWARD_ZONE} - Array of all keys for this type
7279
+ */
7280
+ export const KEY_DOMAIN_FORWARD_ZONE_ZONE_ID = 'zone_id' as keyof DomainForwardZone;
7281
+ /**
7282
+ * Zone Name
7283
+ *
7284
+ *
7285
+ * @type {string}
7286
+ *
7287
+ *
7288
+ * @remarks
7289
+ * This key constant provides type-safe access to the `zone_name` property of DomainForwardZone objects.
7290
+ * Use this constant when you need to access properties dynamically or ensure type safety.
7291
+ *
7292
+ * @example
7293
+ * ```typescript
7294
+ * // Direct property access
7295
+ * const value = domainforwardzone[KEY_DOMAIN_FORWARD_ZONE_ZONE_NAME];
7296
+ *
7297
+ * // Dynamic property access
7298
+ * const propertyName = KEY_DOMAIN_FORWARD_ZONE_ZONE_NAME;
7299
+ * const value = domainforwardzone[propertyName];
7300
+ * ```
7301
+ *
7302
+ * @see {@link DomainForwardZone} - The TypeScript type definition
7303
+ * @see {@link KEYS_DOMAIN_FORWARD_ZONE} - Array of all keys for this type
7304
+ */
7305
+ export const KEY_DOMAIN_FORWARD_ZONE_ZONE_NAME = 'zone_name' as keyof DomainForwardZone;
7306
+
7307
+ /**
7308
+ * Array of all DomainForwardZone property keys
7309
+ *
7310
+ * @remarks
7311
+ * This constant provides a readonly array containing all valid property keys for DomainForwardZone objects.
7312
+ * Useful for iteration, validation, and generating dynamic UI components.
7313
+ *
7314
+ * @example
7315
+ * ```typescript
7316
+ * // Iterating through all keys
7317
+ * for (const key of KEYS_DOMAIN_FORWARD_ZONE) {
7318
+ * console.log(`Property: ${key}, Value: ${domainforwardzone[key]}`);
7319
+ * }
7320
+ *
7321
+ * // Validation
7322
+ * const isValidKey = KEYS_DOMAIN_FORWARD_ZONE.includes(someKey);
7323
+ * ```
7324
+ *
7325
+ * @see {@link DomainForwardZone} - The TypeScript type definition
7326
+ */
7327
+ export const KEYS_DOMAIN_FORWARD_ZONE = [
7328
+ KEY_DOMAIN_FORWARD_ZONE_DOMAIN_FORWARDS,
7329
+ KEY_DOMAIN_FORWARD_ZONE_ZONE_ID,
7330
+ KEY_DOMAIN_FORWARD_ZONE_ZONE_NAME,
7331
+ ] as const satisfies (keyof DomainForwardZone)[];
7332
+
7280
7333
  /**
7281
7334
  * Add Grace Period
7282
7335
  *
@@ -670,6 +670,45 @@ export type POST_Dns_Request = {
670
670
  */
671
671
  export type POST_Dns_Request_Body = POST_Dns_Request['requestBody'];
672
672
 
673
+ /**
674
+ * Request type for GET DnsDomainForwards endpoint
675
+ *
676
+ * List domain forwards by zone
677
+ * Retrieves a paginated list of domain forwards grouped by DNS zones.
678
+ *
679
+ * @remarks
680
+ * This type defines the complete request structure for the GET DnsDomainForwards endpoint.
681
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
682
+ * Use this type to ensure type safety when making API requests to this endpoint.
683
+ *
684
+ * @example
685
+ * Use this type to ensure type safety when making API requests to this endpoint.
686
+ *
687
+ * @path /v1/dns/domain-forwards
688
+ *
689
+ * @see {@link GET_DnsDomainForwards_Request_Query} - Query parameters type
690
+ * @see {@link GET_DnsDomainForwards_Request_Path} - Path parameters type
691
+ * @see {@link GET_DnsDomainForwards_Request_Body} - Request body type
692
+ */
693
+ export type GET_DnsDomainForwards_Request = {
694
+ parameters: {
695
+ query: operations['list_domain_forwards_by_zone_v1_dns_domain_forwards_get']['parameters']['query'];
696
+ };
697
+ }
698
+ /**
699
+ * Query parameters for GET /v1/dns/domain-forwards
700
+ *
701
+ * @remarks
702
+ * This type defines the query parameters for the GET /v1/dns/domain-forwards endpoint.
703
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
704
+ *
705
+ * @example
706
+ * Use this type to ensure type safety for query parameters.
707
+ *
708
+ * @path /v1/dns/domain-forwards
709
+ */
710
+ export type GET_DnsDomainForwards_Request_Query = GET_DnsDomainForwards_Request['parameters']['query'];
711
+
673
712
  /**
674
713
  * Request type for GET DnsSummary endpoint
675
714
  *
@@ -852,6 +891,47 @@ export type POST_DnsZoneNameDnssecEnable_Request = {
852
891
  */
853
892
  export type POST_DnsZoneNameDnssecEnable_Request_Path = POST_DnsZoneNameDnssecEnable_Request['parameters']['path'];
854
893
 
894
+ /**
895
+ * Request type for GET DnsZoneNameDomainForwards endpoint
896
+ *
897
+ * List domain forwards for a zone
898
+ * Retrieves all domain forwards configured for the specified DNS zone, including subdomains.
899
+ *
900
+ * @remarks
901
+ * This type defines the complete request structure for the GET DnsZoneNameDomainForwards endpoint.
902
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
903
+ * Use this type to ensure type safety when making API requests to this endpoint.
904
+ *
905
+ * @example
906
+ * Use this type to ensure type safety when making API requests to this endpoint.
907
+ *
908
+ * @path /v1/dns/{zone_name}/domain-forwards
909
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
910
+ *
911
+ * @see {@link GET_DnsZoneNameDomainForwards_Request_Query} - Query parameters type
912
+ * @see {@link GET_DnsZoneNameDomainForwards_Request_Path} - Path parameters type
913
+ * @see {@link GET_DnsZoneNameDomainForwards_Request_Body} - Request body type
914
+ */
915
+ export type GET_DnsZoneNameDomainForwards_Request = {
916
+ parameters: {
917
+ path: operations['list_zone_domain_forwards_v1_dns__zone_name__domain_forwards_get']['parameters']['path'];
918
+ };
919
+ }
920
+ /**
921
+ * Path parameters for GET /v1/dns/{zone_name}/domain-forwards
922
+ *
923
+ * @remarks
924
+ * This type defines the path parameters for the GET /v1/dns/{zone_name}/domain-forwards endpoint.
925
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
926
+ *
927
+ * @example
928
+ * Use this type to ensure type safety for path parameters.
929
+ *
930
+ * @path /v1/dns/{zone_name}/domain-forwards
931
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
932
+ */
933
+ export type GET_DnsZoneNameDomainForwards_Request_Path = GET_DnsZoneNameDomainForwards_Request['parameters']['path'];
934
+
855
935
  /**
856
936
  * Request type for PATCH DnsZoneNameRecords endpoint
857
937
  *
@@ -34,7 +34,7 @@
34
34
 
35
35
  import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
36
36
 
37
- import { Problem, HTTPValidationError, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, Pagination_EmailForwardAlias, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
37
+ import { Problem, HTTPValidationError, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, Pagination_DomainForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, Pagination_EmailForwardAlias, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
38
38
 
39
39
  /**
40
40
  * Response types for POST AuthToken endpoint
@@ -1450,6 +1450,103 @@ export type POST_DnsByZoneNameDnssecEnable_Response_200 = DnsChanges
1450
1450
  */
1451
1451
  export type POST_DnsByZoneNameDnssecEnable_Response_422 = HTTPValidationError
1452
1452
 
1453
+ /**
1454
+ * Response types for GET DnsByZoneNameDomainForwards endpoint
1455
+ *
1456
+ * List domain forwards for a zone
1457
+ * Retrieves all domain forwards configured for the specified DNS zone, including subdomains.
1458
+ *
1459
+ * @remarks
1460
+ * This type defines all possible response structures for the GET DnsByZoneNameDomainForwards endpoint.
1461
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
1462
+ * Use this type to ensure type safety when handling API responses from this endpoint.
1463
+ *
1464
+
1465
+ *
1466
+ * @path /v1/dns/{zone_name}/domain-forwards
1467
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1468
+ *
1469
+ * @see {@link GET_DnsByZoneNameDomainForwards_Response_200} - 200 response type
1470
+ * @see {@link GET_DnsByZoneNameDomainForwards_Response_401} - 401 response type
1471
+ * @see {@link GET_DnsByZoneNameDomainForwards_Response_403} - 403 response type
1472
+ * @see {@link GET_DnsByZoneNameDomainForwards_Response_422} - 422 response type
1473
+ *
1474
+
1475
+ */
1476
+ export type GET_DnsByZoneNameDomainForwards_Response = GET_DnsByZoneNameDomainForwards_Response_200 | GET_DnsByZoneNameDomainForwards_Response_401 | GET_DnsByZoneNameDomainForwards_Response_403 | GET_DnsByZoneNameDomainForwards_Response_422;
1477
+
1478
+ /**
1479
+ * 200 response for GET DnsByZoneNameDomainForwards endpoint
1480
+ *
1481
+ * @remarks
1482
+ * This type defines the response structure for the 200 status code
1483
+ * of the GET DnsByZoneNameDomainForwards endpoint.
1484
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
1485
+ *
1486
+
1487
+ *
1488
+ * @path /v1/dns/{zone_name}/domain-forwards
1489
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1490
+ *
1491
+ * @see {@link GET_DnsByZoneNameDomainForwards_Response} - The main response type definition
1492
+ * @see {@link DomainForwardZone} - The actual schema type definition
1493
+ */
1494
+ export type GET_DnsByZoneNameDomainForwards_Response_200 = DomainForwardZone
1495
+
1496
+ /**
1497
+ * 401 response for GET DnsByZoneNameDomainForwards endpoint
1498
+ *
1499
+ * @remarks
1500
+ * This type defines the response structure for the 401 status code
1501
+ * of the GET DnsByZoneNameDomainForwards endpoint.
1502
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
1503
+ *
1504
+
1505
+ *
1506
+ * @path /v1/dns/{zone_name}/domain-forwards
1507
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1508
+ *
1509
+ * @see {@link GET_DnsByZoneNameDomainForwards_Response} - The main response type definition
1510
+ * @see {@link Problem} - The actual schema type definition
1511
+ */
1512
+ export type GET_DnsByZoneNameDomainForwards_Response_401 = Problem
1513
+
1514
+ /**
1515
+ * 403 response for GET DnsByZoneNameDomainForwards endpoint
1516
+ *
1517
+ * @remarks
1518
+ * This type defines the response structure for the 403 status code
1519
+ * of the GET DnsByZoneNameDomainForwards endpoint.
1520
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
1521
+ *
1522
+
1523
+ *
1524
+ * @path /v1/dns/{zone_name}/domain-forwards
1525
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1526
+ *
1527
+ * @see {@link GET_DnsByZoneNameDomainForwards_Response} - The main response type definition
1528
+ * @see {@link Problem} - The actual schema type definition
1529
+ */
1530
+ export type GET_DnsByZoneNameDomainForwards_Response_403 = Problem
1531
+
1532
+ /**
1533
+ * 422 response for GET DnsByZoneNameDomainForwards endpoint
1534
+ *
1535
+ * @remarks
1536
+ * This type defines the response structure for the 422 status code
1537
+ * of the GET DnsByZoneNameDomainForwards endpoint.
1538
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
1539
+ *
1540
+
1541
+ *
1542
+ * @path /v1/dns/{zone_name}/domain-forwards
1543
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1544
+ *
1545
+ * @see {@link GET_DnsByZoneNameDomainForwards_Response} - The main response type definition
1546
+ * @see {@link HTTPValidationError} - The actual schema type definition
1547
+ */
1548
+ export type GET_DnsByZoneNameDomainForwards_Response_422 = HTTPValidationError
1549
+
1453
1550
  /**
1454
1551
  * Response types for PATCH DnsByZoneNameRecords endpoint
1455
1552
  *
@@ -1624,6 +1721,98 @@ export type PUT_DnsByZoneNameRrsets_Response_400 = Problem
1624
1721
  */
1625
1722
  export type PUT_DnsByZoneNameRrsets_Response_422 = HTTPValidationError
1626
1723
 
1724
+ /**
1725
+ * Response types for GET DnsDomainForwards endpoint
1726
+ *
1727
+ * List domain forwards by zone
1728
+ * Retrieves a paginated list of domain forwards grouped by DNS zones.
1729
+ *
1730
+ * @remarks
1731
+ * This type defines all possible response structures for the GET DnsDomainForwards endpoint.
1732
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
1733
+ * Use this type to ensure type safety when handling API responses from this endpoint.
1734
+ *
1735
+
1736
+ *
1737
+ * @path /v1/dns/domain-forwards
1738
+ *
1739
+ * @see {@link GET_DnsDomainForwards_Response_200} - 200 response type
1740
+ * @see {@link GET_DnsDomainForwards_Response_401} - 401 response type
1741
+ * @see {@link GET_DnsDomainForwards_Response_403} - 403 response type
1742
+ * @see {@link GET_DnsDomainForwards_Response_422} - 422 response type
1743
+ *
1744
+
1745
+ */
1746
+ export type GET_DnsDomainForwards_Response = GET_DnsDomainForwards_Response_200 | GET_DnsDomainForwards_Response_401 | GET_DnsDomainForwards_Response_403 | GET_DnsDomainForwards_Response_422;
1747
+
1748
+ /**
1749
+ * 200 response for GET DnsDomainForwards endpoint
1750
+ *
1751
+ * @remarks
1752
+ * This type defines the response structure for the 200 status code
1753
+ * of the GET DnsDomainForwards endpoint.
1754
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
1755
+ *
1756
+
1757
+ *
1758
+ * @path /v1/dns/domain-forwards
1759
+ *
1760
+ * @see {@link GET_DnsDomainForwards_Response} - The main response type definition
1761
+ * @see {@link Pagination_DomainForwardZone} - The actual schema type definition
1762
+ */
1763
+ export type GET_DnsDomainForwards_Response_200 = Pagination_DomainForwardZone
1764
+
1765
+ /**
1766
+ * 401 response for GET DnsDomainForwards endpoint
1767
+ *
1768
+ * @remarks
1769
+ * This type defines the response structure for the 401 status code
1770
+ * of the GET DnsDomainForwards endpoint.
1771
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
1772
+ *
1773
+
1774
+ *
1775
+ * @path /v1/dns/domain-forwards
1776
+ *
1777
+ * @see {@link GET_DnsDomainForwards_Response} - The main response type definition
1778
+ * @see {@link Problem} - The actual schema type definition
1779
+ */
1780
+ export type GET_DnsDomainForwards_Response_401 = Problem
1781
+
1782
+ /**
1783
+ * 403 response for GET DnsDomainForwards endpoint
1784
+ *
1785
+ * @remarks
1786
+ * This type defines the response structure for the 403 status code
1787
+ * of the GET DnsDomainForwards endpoint.
1788
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
1789
+ *
1790
+
1791
+ *
1792
+ * @path /v1/dns/domain-forwards
1793
+ *
1794
+ * @see {@link GET_DnsDomainForwards_Response} - The main response type definition
1795
+ * @see {@link Problem} - The actual schema type definition
1796
+ */
1797
+ export type GET_DnsDomainForwards_Response_403 = Problem
1798
+
1799
+ /**
1800
+ * 422 response for GET DnsDomainForwards endpoint
1801
+ *
1802
+ * @remarks
1803
+ * This type defines the response structure for the 422 status code
1804
+ * of the GET DnsDomainForwards endpoint.
1805
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
1806
+ *
1807
+
1808
+ *
1809
+ * @path /v1/dns/domain-forwards
1810
+ *
1811
+ * @see {@link GET_DnsDomainForwards_Response} - The main response type definition
1812
+ * @see {@link HTTPValidationError} - The actual schema type definition
1813
+ */
1814
+ export type GET_DnsDomainForwards_Response_422 = HTTPValidationError
1815
+
1627
1816
  /**
1628
1817
  * Response types for GET DnsSummary endpoint
1629
1818
  *
@@ -21,7 +21,7 @@
21
21
  * This file is auto-generated from the OpenAPI specification.
22
22
  * Do not edit manually.
23
23
  */
24
- import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, RegistryHandleAttributeType, ContactAttributeDefinition, ContactRoleAttributeRequirement, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, DomainForwardPatchOp, HttpRedirectList, DeletePolicyType, SyncOperationType, DomainContact, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, DomainForward, Domain, EmailForwardAlias, EventResponse, Invoice, Organization, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
24
+ import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, RegistryHandleAttributeType, ContactAttributeDefinition, ContactRoleAttributeRequirement, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, DomainForwardPatchOp, HttpRedirectList, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, DomainForwardZone, Domain, EmailForwardAlias, EventResponse, Invoice, Organization, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
25
25
 
26
26
  /**
27
27
  * DomainDnssecDataResponse
@@ -345,6 +345,20 @@ export type DomainForwardPatchOpArray = DomainForwardPatchOp[];
345
345
  * @see {@link HttpRedirectList} - The individual HttpRedirectListResponse type definition
346
346
  */
347
347
  export type HttpRedirectListArray = HttpRedirectList[];
348
+ /**
349
+ * DomainForward
350
+ *
351
+ * @remarks
352
+ * Array type for DomainForward objects. Used when the API returns a collection of DomainForward instances.
353
+ *
354
+ * @example
355
+ * ```typescript
356
+ * const items: DomainForwardArray = await api.getDomainForwards();
357
+ * ```
358
+ *
359
+ * @see {@link DomainForward} - The individual DomainForward type definition
360
+ */
361
+ export type DomainForwardArray = DomainForward[];
348
362
  /**
349
363
  * DeletePolicyType
350
364
  *
@@ -598,19 +612,19 @@ export type ContactSchemaArray = ContactSchema[];
598
612
  */
599
613
  export type DnsZoneArray = DnsZone[];
600
614
  /**
601
- * DomainForward
615
+ * DomainForwardZone
602
616
  *
603
617
  * @remarks
604
- * Array type for DomainForward objects. Used when the API returns a collection of DomainForward instances.
618
+ * Array type for DomainForwardZone objects. Used when the API returns a collection of DomainForwardZone instances.
605
619
  *
606
620
  * @example
607
621
  * ```typescript
608
- * const items: DomainForwardArray = await api.getDomainForwards();
622
+ * const items: DomainForwardZoneArray = await api.getDomainForwardZones();
609
623
  * ```
610
624
  *
611
- * @see {@link DomainForward} - The individual DomainForward type definition
625
+ * @see {@link DomainForwardZone} - The individual DomainForwardZone type definition
612
626
  */
613
- export type DomainForwardArray = DomainForward[];
627
+ export type DomainForwardZoneArray = DomainForwardZone[];
614
628
  /**
615
629
  * DomainResponse
616
630
  *
@@ -1146,6 +1146,22 @@ export type DomainForwardSetRequest = components['schemas']['DomainForwardSetReq
1146
1146
  * @see {@link components} - The OpenAPI components schema definition
1147
1147
  */
1148
1148
  export type DomainForwardSet = components['schemas']['DomainForwardSetResponse'];
1149
+ /**
1150
+ * DomainForwardZone
1151
+ *
1152
+ * @remarks
1153
+ * Type alias for the `DomainForwardZone` OpenAPI schema.
1154
+ * This type represents domainforwardzone data structures used in API requests and responses.
1155
+ *
1156
+ * @example
1157
+ * ```typescript
1158
+ * const response = await api.getDomainForwardZone();
1159
+ * const item: DomainForwardZone = response.results;
1160
+ * ```
1161
+ *
1162
+ * @see {@link components} - The OpenAPI components schema definition
1163
+ */
1164
+ export type DomainForwardZone = components['schemas']['DomainForwardZone'];
1149
1165
  /**
1150
1166
  * DomainLifecycleBase
1151
1167
  *
@@ -2239,6 +2255,22 @@ export type Pagination_ContactSchema = components['schemas']['Pagination_Contact
2239
2255
  * @see {@link components} - The OpenAPI components schema definition
2240
2256
  */
2241
2257
  export type Pagination_DnsZone = components['schemas']['Pagination_DnsZoneResponse_'];
2258
+ /**
2259
+ * Pagination[DomainForwardZone]
2260
+ *
2261
+ * @remarks
2262
+ * Type alias for the `Pagination_DomainForwardZone_` OpenAPI schema.
2263
+ * This type represents pagination[domainforwardzone] data structures used in API requests and responses.
2264
+ *
2265
+ * @example
2266
+ * ```typescript
2267
+ * const response = await api.getPagination_DomainForwardZone();
2268
+ * const item: Pagination_DomainForwardZone = response.results;
2269
+ * ```
2270
+ *
2271
+ * @see {@link components} - The OpenAPI components schema definition
2272
+ */
2273
+ export type Pagination_DomainForwardZone = components['schemas']['Pagination_DomainForwardZone_'];
2242
2274
  /**
2243
2275
  * Pagination[DomainForward]
2244
2276
  *
package/src/openapi.yaml CHANGED
@@ -1596,12 +1596,6 @@ components:
1596
1596
  type: object
1597
1597
  DomainForwardProtocolSetRequest:
1598
1598
  properties:
1599
- created_on:
1600
- anyOf:
1601
- - format: date-time
1602
- type: string
1603
- - type: 'null'
1604
- title: Created On
1605
1599
  redirects:
1606
1600
  items:
1607
1601
  anyOf:
@@ -1609,12 +1603,6 @@ components:
1609
1603
  - $ref: '#/components/schemas/WildcardHttpRedirectRequest'
1610
1604
  title: Redirects
1611
1605
  type: array
1612
- updated_on:
1613
- anyOf:
1614
- - format: date-time
1615
- type: string
1616
- - type: 'null'
1617
- title: Updated On
1618
1606
  wildcard:
1619
1607
  anyOf:
1620
1608
  - type: boolean
@@ -1715,6 +1703,30 @@ components:
1715
1703
  - created_on
1716
1704
  title: DomainForwardSetResponse
1717
1705
  type: object
1706
+ DomainForwardZone:
1707
+ properties:
1708
+ domain_forwards:
1709
+ items:
1710
+ $ref: '#/components/schemas/DomainForward'
1711
+ title: Domain Forwards
1712
+ type: array
1713
+ zone_id:
1714
+ examples:
1715
+ - zone_01h45ytscbebyvny4gc8cr8ma2
1716
+ format: typeid
1717
+ pattern: ^zone_[0-7][0-9a-hjkmnpq-tv-z]{25}$
1718
+ title: Zone Id
1719
+ type: string
1720
+ x-typeid-prefix: zone
1721
+ zone_name:
1722
+ title: Zone Name
1723
+ type: string
1724
+ required:
1725
+ - zone_id
1726
+ - zone_name
1727
+ - domain_forwards
1728
+ title: DomainForwardZone
1729
+ type: object
1718
1730
  DomainLifecycleBase:
1719
1731
  properties:
1720
1732
  add_grace_period:
@@ -3847,6 +3859,20 @@ components:
3847
3859
  - pagination
3848
3860
  title: Pagination[DnsZoneResponse]
3849
3861
  type: object
3862
+ Pagination_DomainForwardZone_:
3863
+ properties:
3864
+ pagination:
3865
+ $ref: '#/components/schemas/PaginationMetadata'
3866
+ results:
3867
+ items:
3868
+ $ref: '#/components/schemas/DomainForwardZone'
3869
+ title: Results
3870
+ type: array
3871
+ required:
3872
+ - results
3873
+ - pagination
3874
+ title: Pagination[DomainForwardZone]
3875
+ type: object
3850
3876
  Pagination_DomainForward_:
3851
3877
  properties:
3852
3878
  pagination:
@@ -5265,7 +5291,7 @@ info:
5265
5291
  '
5266
5292
  summary: OpusDNS - your gateway to a seamless domain management experience.
5267
5293
  title: OpusDNS API
5268
- version: 2025-11-13-093836
5294
+ version: 2025-11-13-112957
5269
5295
  x-logo:
5270
5296
  altText: OpusDNS API Reference
5271
5297
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -6482,6 +6508,150 @@ paths:
6482
6508
  summary: Create Zone
6483
6509
  tags:
6484
6510
  - dns
6511
+ /v1/dns/domain-forwards:
6512
+ get:
6513
+ description: Retrieves a paginated list of domain forwards grouped by DNS zones.
6514
+ operationId: list_domain_forwards_by_zone_v1_dns_domain_forwards_get
6515
+ parameters:
6516
+ - in: query
6517
+ name: sort_by
6518
+ required: false
6519
+ schema:
6520
+ $ref: '#/components/schemas/ZoneSortField'
6521
+ default: created_on
6522
+ - in: query
6523
+ name: sort_order
6524
+ required: false
6525
+ schema:
6526
+ $ref: '#/components/schemas/SortOrder'
6527
+ default: desc
6528
+ - in: query
6529
+ name: dnssec_status
6530
+ required: false
6531
+ schema:
6532
+ anyOf:
6533
+ - $ref: '#/components/schemas/DnssecStatus'
6534
+ - type: 'null'
6535
+ title: Dnssec Status
6536
+ - in: query
6537
+ name: name
6538
+ required: false
6539
+ schema:
6540
+ anyOf:
6541
+ - type: string
6542
+ - type: 'null'
6543
+ title: Name
6544
+ - in: query
6545
+ name: search
6546
+ required: false
6547
+ schema:
6548
+ anyOf:
6549
+ - type: string
6550
+ - type: 'null'
6551
+ title: Search
6552
+ - in: query
6553
+ name: suffix
6554
+ required: false
6555
+ schema:
6556
+ anyOf:
6557
+ - type: string
6558
+ - type: 'null'
6559
+ title: Suffix
6560
+ - in: query
6561
+ name: created_after
6562
+ required: false
6563
+ schema:
6564
+ anyOf:
6565
+ - format: date-time
6566
+ type: string
6567
+ - type: 'null'
6568
+ title: Created After
6569
+ - in: query
6570
+ name: created_before
6571
+ required: false
6572
+ schema:
6573
+ anyOf:
6574
+ - format: date-time
6575
+ type: string
6576
+ - type: 'null'
6577
+ title: Created Before
6578
+ - in: query
6579
+ name: updated_after
6580
+ required: false
6581
+ schema:
6582
+ anyOf:
6583
+ - format: date-time
6584
+ type: string
6585
+ - type: 'null'
6586
+ title: Updated After
6587
+ - in: query
6588
+ name: updated_before
6589
+ required: false
6590
+ schema:
6591
+ anyOf:
6592
+ - format: date-time
6593
+ type: string
6594
+ - type: 'null'
6595
+ title: Updated Before
6596
+ - in: query
6597
+ name: page
6598
+ required: false
6599
+ schema:
6600
+ default: 1
6601
+ minimum: 1
6602
+ title: Page
6603
+ type: integer
6604
+ - in: query
6605
+ name: page_size
6606
+ required: false
6607
+ schema:
6608
+ default: 10
6609
+ maximum: 100
6610
+ minimum: 1
6611
+ title: Page Size
6612
+ type: integer
6613
+ responses:
6614
+ '200':
6615
+ content:
6616
+ application/json:
6617
+ schema:
6618
+ $ref: '#/components/schemas/Pagination_DomainForwardZone_'
6619
+ description: Successful Response
6620
+ '401':
6621
+ content:
6622
+ application/problem+json:
6623
+ example:
6624
+ code: ERROR_AUTHENTICATION
6625
+ detail: Additional error context.
6626
+ status: 401
6627
+ title: Authentication Error
6628
+ type: authentication
6629
+ schema:
6630
+ $ref: '#/components/schemas/Problem'
6631
+ description: Unauthorized
6632
+ '403':
6633
+ content:
6634
+ application/problem+json:
6635
+ example:
6636
+ code: ERROR_PERMISSION_DENIED
6637
+ detail: Insufficient permissions to perform this action
6638
+ status: 403
6639
+ title: Permission Denied
6640
+ type: permission-denied
6641
+ schema:
6642
+ $ref: '#/components/schemas/Problem'
6643
+ description: Forbidden
6644
+ '422':
6645
+ content:
6646
+ application/problem+json:
6647
+ schema:
6648
+ $ref: '#/components/schemas/HTTPValidationError'
6649
+ description: Validation Error
6650
+ security:
6651
+ - OAuth2PasswordBearer: []
6652
+ summary: List domain forwards by zone
6653
+ tags:
6654
+ - dns
6485
6655
  /v1/dns/summary:
6486
6656
  get:
6487
6657
  operationId: get_zones_summary_v1_dns_summary_get
@@ -6612,6 +6782,62 @@ paths:
6612
6782
  summary: Enable Dnssec
6613
6783
  tags:
6614
6784
  - dns
6785
+ /v1/dns/{zone_name}/domain-forwards:
6786
+ get:
6787
+ description: Retrieves all domain forwards configured for the specified DNS
6788
+ zone, including subdomains.
6789
+ operationId: list_zone_domain_forwards_v1_dns__zone_name__domain_forwards_get
6790
+ parameters:
6791
+ - description: DNS zone name (trailing dot optional)
6792
+ in: path
6793
+ name: zone_name
6794
+ required: true
6795
+ schema:
6796
+ description: DNS zone name (trailing dot optional)
6797
+ title: Zone Name
6798
+ type: string
6799
+ responses:
6800
+ '200':
6801
+ content:
6802
+ application/json:
6803
+ schema:
6804
+ $ref: '#/components/schemas/DomainForwardZone'
6805
+ description: Successful Response
6806
+ '401':
6807
+ content:
6808
+ application/problem+json:
6809
+ example:
6810
+ code: ERROR_AUTHENTICATION
6811
+ detail: Additional error context.
6812
+ status: 401
6813
+ title: Authentication Error
6814
+ type: authentication
6815
+ schema:
6816
+ $ref: '#/components/schemas/Problem'
6817
+ description: Unauthorized
6818
+ '403':
6819
+ content:
6820
+ application/problem+json:
6821
+ example:
6822
+ code: ERROR_PERMISSION_DENIED
6823
+ detail: Insufficient permissions to perform this action
6824
+ status: 403
6825
+ title: Permission Denied
6826
+ type: permission-denied
6827
+ schema:
6828
+ $ref: '#/components/schemas/Problem'
6829
+ description: Forbidden
6830
+ '422':
6831
+ content:
6832
+ application/problem+json:
6833
+ schema:
6834
+ $ref: '#/components/schemas/HTTPValidationError'
6835
+ description: Validation Error
6836
+ security:
6837
+ - OAuth2PasswordBearer: []
6838
+ summary: List domain forwards for a zone
6839
+ tags:
6840
+ - dns
6615
6841
  /v1/dns/{zone_name}/records:
6616
6842
  patch:
6617
6843
  operationId: patch_zone_records_v1_dns__zone_name__records_patch
package/src/schema.d.ts CHANGED
@@ -178,6 +178,26 @@ export interface paths {
178
178
  patch?: never;
179
179
  trace?: never;
180
180
  };
181
+ "/v1/dns/domain-forwards": {
182
+ parameters: {
183
+ query?: never;
184
+ header?: never;
185
+ path?: never;
186
+ cookie?: never;
187
+ };
188
+ /**
189
+ * List domain forwards by zone
190
+ * @description Retrieves a paginated list of domain forwards grouped by DNS zones.
191
+ */
192
+ get: operations["list_domain_forwards_by_zone_v1_dns_domain_forwards_get"];
193
+ put?: never;
194
+ post?: never;
195
+ delete?: never;
196
+ options?: never;
197
+ head?: never;
198
+ patch?: never;
199
+ trace?: never;
200
+ };
181
201
  "/v1/dns/summary": {
182
202
  parameters: {
183
203
  query?: never;
@@ -247,6 +267,26 @@ export interface paths {
247
267
  patch?: never;
248
268
  trace?: never;
249
269
  };
270
+ "/v1/dns/{zone_name}/domain-forwards": {
271
+ parameters: {
272
+ query?: never;
273
+ header?: never;
274
+ path?: never;
275
+ cookie?: never;
276
+ };
277
+ /**
278
+ * List domain forwards for a zone
279
+ * @description Retrieves all domain forwards configured for the specified DNS zone, including subdomains.
280
+ */
281
+ get: operations["list_zone_domain_forwards_v1_dns__zone_name__domain_forwards_get"];
282
+ put?: never;
283
+ post?: never;
284
+ delete?: never;
285
+ options?: never;
286
+ head?: never;
287
+ patch?: never;
288
+ trace?: never;
289
+ };
250
290
  "/v1/dns/{zone_name}/records": {
251
291
  parameters: {
252
292
  query?: never;
@@ -2355,12 +2395,8 @@ export interface components {
2355
2395
  };
2356
2396
  /** DomainForwardProtocolSetRequest */
2357
2397
  DomainForwardProtocolSetRequest: {
2358
- /** Created On */
2359
- created_on?: Date | null;
2360
2398
  /** Redirects */
2361
2399
  redirects: (components["schemas"]["HttpRedirectRequest"] | components["schemas"]["WildcardHttpRedirectRequest"])[];
2362
- /** Updated On */
2363
- updated_on?: Date | null;
2364
2400
  /** Wildcard */
2365
2401
  wildcard?: boolean | null;
2366
2402
  };
@@ -2418,6 +2454,19 @@ export interface components {
2418
2454
  /** Wildcard */
2419
2455
  wildcard: boolean;
2420
2456
  };
2457
+ /** DomainForwardZone */
2458
+ DomainForwardZone: {
2459
+ /** Domain Forwards */
2460
+ domain_forwards: components["schemas"]["DomainForward"][];
2461
+ /**
2462
+ * Zone Id
2463
+ * Format: typeid
2464
+ * @example zone_01h45ytscbebyvny4gc8cr8ma2
2465
+ */
2466
+ zone_id: TypeId<"zone">;
2467
+ /** Zone Name */
2468
+ zone_name: string;
2469
+ };
2421
2470
  /** DomainLifecycleBase */
2422
2471
  DomainLifecycleBase: {
2423
2472
  /**
@@ -3844,6 +3893,12 @@ export interface components {
3844
3893
  /** Results */
3845
3894
  results: components["schemas"]["DnsZoneResponse"][];
3846
3895
  };
3896
+ /** Pagination[DomainForwardZone] */
3897
+ Pagination_DomainForwardZone_: {
3898
+ pagination: components["schemas"]["PaginationMetadata"];
3899
+ /** Results */
3900
+ results: components["schemas"]["DomainForwardZone"][];
3901
+ };
3847
3902
  /** Pagination[DomainForward] */
3848
3903
  Pagination_DomainForward_: {
3849
3904
  pagination: components["schemas"]["PaginationMetadata"];
@@ -5683,6 +5738,80 @@ export interface operations {
5683
5738
  };
5684
5739
  };
5685
5740
  };
5741
+ list_domain_forwards_by_zone_v1_dns_domain_forwards_get: {
5742
+ parameters: {
5743
+ query?: {
5744
+ sort_by?: components["schemas"]["ZoneSortField"];
5745
+ sort_order?: components["schemas"]["SortOrder"];
5746
+ dnssec_status?: components["schemas"]["DnssecStatus"] | null;
5747
+ name?: string | null;
5748
+ search?: string | null;
5749
+ suffix?: string | null;
5750
+ created_after?: Date | null;
5751
+ created_before?: Date | null;
5752
+ updated_after?: Date | null;
5753
+ updated_before?: Date | null;
5754
+ page?: number;
5755
+ page_size?: number;
5756
+ };
5757
+ header?: never;
5758
+ path?: never;
5759
+ cookie?: never;
5760
+ };
5761
+ requestBody?: never;
5762
+ responses: {
5763
+ /** @description Successful Response */
5764
+ 200: {
5765
+ headers: {
5766
+ [name: string]: unknown;
5767
+ };
5768
+ content: {
5769
+ "application/json": components["schemas"]["Pagination_DomainForwardZone_"];
5770
+ };
5771
+ };
5772
+ /** @description Unauthorized */
5773
+ 401: {
5774
+ headers: {
5775
+ [name: string]: unknown;
5776
+ };
5777
+ content: {
5778
+ /** @example {
5779
+ * "code": "ERROR_AUTHENTICATION",
5780
+ * "detail": "Additional error context.",
5781
+ * "status": 401,
5782
+ * "title": "Authentication Error",
5783
+ * "type": "authentication"
5784
+ * } */
5785
+ "application/problem+json": components["schemas"]["Problem"];
5786
+ };
5787
+ };
5788
+ /** @description Forbidden */
5789
+ 403: {
5790
+ headers: {
5791
+ [name: string]: unknown;
5792
+ };
5793
+ content: {
5794
+ /** @example {
5795
+ * "code": "ERROR_PERMISSION_DENIED",
5796
+ * "detail": "Insufficient permissions to perform this action",
5797
+ * "status": 403,
5798
+ * "title": "Permission Denied",
5799
+ * "type": "permission-denied"
5800
+ * } */
5801
+ "application/problem+json": components["schemas"]["Problem"];
5802
+ };
5803
+ };
5804
+ /** @description Validation Error */
5805
+ 422: {
5806
+ headers: {
5807
+ [name: string]: unknown;
5808
+ };
5809
+ content: {
5810
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
5811
+ };
5812
+ };
5813
+ };
5814
+ };
5686
5815
  get_zones_summary_v1_dns_summary_get: {
5687
5816
  parameters: {
5688
5817
  query?: never;
@@ -5829,6 +5958,70 @@ export interface operations {
5829
5958
  };
5830
5959
  };
5831
5960
  };
5961
+ list_zone_domain_forwards_v1_dns__zone_name__domain_forwards_get: {
5962
+ parameters: {
5963
+ query?: never;
5964
+ header?: never;
5965
+ path: {
5966
+ /** @description DNS zone name (trailing dot optional) */
5967
+ zone_name: string;
5968
+ };
5969
+ cookie?: never;
5970
+ };
5971
+ requestBody?: never;
5972
+ responses: {
5973
+ /** @description Successful Response */
5974
+ 200: {
5975
+ headers: {
5976
+ [name: string]: unknown;
5977
+ };
5978
+ content: {
5979
+ "application/json": components["schemas"]["DomainForwardZone"];
5980
+ };
5981
+ };
5982
+ /** @description Unauthorized */
5983
+ 401: {
5984
+ headers: {
5985
+ [name: string]: unknown;
5986
+ };
5987
+ content: {
5988
+ /** @example {
5989
+ * "code": "ERROR_AUTHENTICATION",
5990
+ * "detail": "Additional error context.",
5991
+ * "status": 401,
5992
+ * "title": "Authentication Error",
5993
+ * "type": "authentication"
5994
+ * } */
5995
+ "application/problem+json": components["schemas"]["Problem"];
5996
+ };
5997
+ };
5998
+ /** @description Forbidden */
5999
+ 403: {
6000
+ headers: {
6001
+ [name: string]: unknown;
6002
+ };
6003
+ content: {
6004
+ /** @example {
6005
+ * "code": "ERROR_PERMISSION_DENIED",
6006
+ * "detail": "Insufficient permissions to perform this action",
6007
+ * "status": 403,
6008
+ * "title": "Permission Denied",
6009
+ * "type": "permission-denied"
6010
+ * } */
6011
+ "application/problem+json": components["schemas"]["Problem"];
6012
+ };
6013
+ };
6014
+ /** @description Validation Error */
6015
+ 422: {
6016
+ headers: {
6017
+ [name: string]: unknown;
6018
+ };
6019
+ content: {
6020
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
6021
+ };
6022
+ };
6023
+ };
6024
+ };
5832
6025
  patch_zone_records_v1_dns__zone_name__records_patch: {
5833
6026
  parameters: {
5834
6027
  query?: never;