@opusdns/api 0.93.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 +1 -1
- package/src/helpers/keys.ts +1359 -413
- package/src/helpers/requests.d.ts +335 -108
- package/src/helpers/responses.d.ts +1067 -173
- package/src/helpers/schemas-arrays.d.ts +25 -11
- package/src/helpers/schemas.d.ts +124 -28
- package/src/openapi.yaml +993 -159
- package/src/schema.d.ts +1055 -188
|
@@ -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,
|
|
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
|
*
|
|
@@ -1664,7 +1853,8 @@ export type GET_DnsSummary_Response_200 = DnsZoneSummary
|
|
|
1664
1853
|
/**
|
|
1665
1854
|
* Response types for GET DomainForwards endpoint
|
|
1666
1855
|
*
|
|
1667
|
-
* List
|
|
1856
|
+
* List domain forwards
|
|
1857
|
+
* Retrieves a paginated list of domain forwards for the organization
|
|
1668
1858
|
*
|
|
1669
1859
|
* @remarks
|
|
1670
1860
|
* This type defines all possible response structures for the GET DomainForwards endpoint.
|
|
@@ -1676,11 +1866,13 @@ export type GET_DnsSummary_Response_200 = DnsZoneSummary
|
|
|
1676
1866
|
* @path /v1/domain-forwards
|
|
1677
1867
|
*
|
|
1678
1868
|
* @see {@link GET_DomainForwards_Response_200} - 200 response type
|
|
1869
|
+
* @see {@link GET_DomainForwards_Response_401} - 401 response type
|
|
1870
|
+
* @see {@link GET_DomainForwards_Response_403} - 403 response type
|
|
1679
1871
|
* @see {@link GET_DomainForwards_Response_422} - 422 response type
|
|
1680
1872
|
*
|
|
1681
1873
|
|
|
1682
1874
|
*/
|
|
1683
|
-
export type GET_DomainForwards_Response = GET_DomainForwards_Response_200 | GET_DomainForwards_Response_422;
|
|
1875
|
+
export type GET_DomainForwards_Response = GET_DomainForwards_Response_200 | GET_DomainForwards_Response_401 | GET_DomainForwards_Response_403 | GET_DomainForwards_Response_422;
|
|
1684
1876
|
|
|
1685
1877
|
/**
|
|
1686
1878
|
* 200 response for GET DomainForwards endpoint
|
|
@@ -1695,9 +1887,43 @@ export type GET_DomainForwards_Response = GET_DomainForwards_Response_200 | GET_
|
|
|
1695
1887
|
* @path /v1/domain-forwards
|
|
1696
1888
|
*
|
|
1697
1889
|
* @see {@link GET_DomainForwards_Response} - The main response type definition
|
|
1698
|
-
* @see {@link
|
|
1890
|
+
* @see {@link Pagination_DomainForward} - The actual schema type definition
|
|
1891
|
+
*/
|
|
1892
|
+
export type GET_DomainForwards_Response_200 = Pagination_DomainForward
|
|
1893
|
+
|
|
1894
|
+
/**
|
|
1895
|
+
* 401 response for GET DomainForwards endpoint
|
|
1896
|
+
*
|
|
1897
|
+
* @remarks
|
|
1898
|
+
* This type defines the response structure for the 401 status code
|
|
1899
|
+
* of the GET DomainForwards endpoint.
|
|
1900
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1901
|
+
*
|
|
1902
|
+
|
|
1903
|
+
*
|
|
1904
|
+
* @path /v1/domain-forwards
|
|
1905
|
+
*
|
|
1906
|
+
* @see {@link GET_DomainForwards_Response} - The main response type definition
|
|
1907
|
+
* @see {@link Problem} - The actual schema type definition
|
|
1699
1908
|
*/
|
|
1700
|
-
export type
|
|
1909
|
+
export type GET_DomainForwards_Response_401 = Problem
|
|
1910
|
+
|
|
1911
|
+
/**
|
|
1912
|
+
* 403 response for GET DomainForwards endpoint
|
|
1913
|
+
*
|
|
1914
|
+
* @remarks
|
|
1915
|
+
* This type defines the response structure for the 403 status code
|
|
1916
|
+
* of the GET DomainForwards endpoint.
|
|
1917
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1918
|
+
*
|
|
1919
|
+
|
|
1920
|
+
*
|
|
1921
|
+
* @path /v1/domain-forwards
|
|
1922
|
+
*
|
|
1923
|
+
* @see {@link GET_DomainForwards_Response} - The main response type definition
|
|
1924
|
+
* @see {@link Problem} - The actual schema type definition
|
|
1925
|
+
*/
|
|
1926
|
+
export type GET_DomainForwards_Response_403 = Problem
|
|
1701
1927
|
|
|
1702
1928
|
/**
|
|
1703
1929
|
* 422 response for GET DomainForwards endpoint
|
|
@@ -1719,7 +1945,8 @@ export type GET_DomainForwards_Response_422 = HTTPValidationError
|
|
|
1719
1945
|
/**
|
|
1720
1946
|
* Response types for PATCH DomainForwards endpoint
|
|
1721
1947
|
*
|
|
1722
|
-
* Patch
|
|
1948
|
+
* Patch domain forward redirects
|
|
1949
|
+
* Applies patch operations to update or remove redirects across hostnames and protocols. Raises an error if the domain forward or domain forward set does not exist.
|
|
1723
1950
|
*
|
|
1724
1951
|
* @remarks
|
|
1725
1952
|
* This type defines all possible response structures for the PATCH DomainForwards endpoint.
|
|
@@ -1730,18 +1957,20 @@ export type GET_DomainForwards_Response_422 = HTTPValidationError
|
|
|
1730
1957
|
*
|
|
1731
1958
|
* @path /v1/domain-forwards
|
|
1732
1959
|
*
|
|
1960
|
+
* @see {@link PATCH_DomainForwards_Response_401} - 401 response type
|
|
1961
|
+
* @see {@link PATCH_DomainForwards_Response_403} - 403 response type
|
|
1733
1962
|
* @see {@link PATCH_DomainForwards_Response_404} - 404 response type
|
|
1734
1963
|
* @see {@link PATCH_DomainForwards_Response_422} - 422 response type
|
|
1735
1964
|
*
|
|
1736
1965
|
|
|
1737
1966
|
*/
|
|
1738
|
-
export type PATCH_DomainForwards_Response = PATCH_DomainForwards_Response_404 | PATCH_DomainForwards_Response_422;
|
|
1967
|
+
export type PATCH_DomainForwards_Response = PATCH_DomainForwards_Response_401 | PATCH_DomainForwards_Response_403 | PATCH_DomainForwards_Response_404 | PATCH_DomainForwards_Response_422;
|
|
1739
1968
|
|
|
1740
1969
|
/**
|
|
1741
|
-
*
|
|
1970
|
+
* 401 response for PATCH DomainForwards endpoint
|
|
1742
1971
|
*
|
|
1743
1972
|
* @remarks
|
|
1744
|
-
* This type defines the response structure for the
|
|
1973
|
+
* This type defines the response structure for the 401 status code
|
|
1745
1974
|
* of the PATCH DomainForwards endpoint.
|
|
1746
1975
|
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1747
1976
|
*
|
|
@@ -1752,13 +1981,13 @@ export type PATCH_DomainForwards_Response = PATCH_DomainForwards_Response_404 |
|
|
|
1752
1981
|
* @see {@link PATCH_DomainForwards_Response} - The main response type definition
|
|
1753
1982
|
* @see {@link Problem} - The actual schema type definition
|
|
1754
1983
|
*/
|
|
1755
|
-
export type
|
|
1984
|
+
export type PATCH_DomainForwards_Response_401 = Problem
|
|
1756
1985
|
|
|
1757
1986
|
/**
|
|
1758
|
-
*
|
|
1987
|
+
* 403 response for PATCH DomainForwards endpoint
|
|
1759
1988
|
*
|
|
1760
1989
|
* @remarks
|
|
1761
|
-
* This type defines the response structure for the
|
|
1990
|
+
* This type defines the response structure for the 403 status code
|
|
1762
1991
|
* of the PATCH DomainForwards endpoint.
|
|
1763
1992
|
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1764
1993
|
*
|
|
@@ -1767,361 +1996,1026 @@ export type PATCH_DomainForwards_Response_404 = Problem
|
|
|
1767
1996
|
* @path /v1/domain-forwards
|
|
1768
1997
|
*
|
|
1769
1998
|
* @see {@link PATCH_DomainForwards_Response} - The main response type definition
|
|
1770
|
-
* @see {@link
|
|
1771
|
-
*/
|
|
1772
|
-
export type PATCH_DomainForwards_Response_422 = HTTPValidationError
|
|
1773
|
-
|
|
1774
|
-
/**
|
|
1775
|
-
* Response types for DELETE DomainForwardsByZoneNameByRequestProtocol endpoint
|
|
1776
|
-
*
|
|
1777
|
-
* Delete Domain Forward
|
|
1778
|
-
*
|
|
1779
|
-
* @remarks
|
|
1780
|
-
* This type defines all possible response structures for the DELETE DomainForwardsByZoneNameByRequestProtocol endpoint.
|
|
1781
|
-
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
1782
|
-
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
1783
|
-
*
|
|
1784
|
-
|
|
1785
|
-
*
|
|
1786
|
-
* @path /v1/domain-forwards/{zone_name}/{request_protocol}
|
|
1787
|
-
* @param zone_name (path) - DNS zone name (trailing dot optional)
|
|
1788
|
-
*
|
|
1789
|
-
* @see {@link DELETE_DomainForwardsByZoneNameByRequestProtocol_Response_404} - 404 response type
|
|
1790
|
-
* @see {@link DELETE_DomainForwardsByZoneNameByRequestProtocol_Response_422} - 422 response type
|
|
1791
|
-
*
|
|
1792
|
-
|
|
1999
|
+
* @see {@link Problem} - The actual schema type definition
|
|
1793
2000
|
*/
|
|
1794
|
-
export type
|
|
2001
|
+
export type PATCH_DomainForwards_Response_403 = Problem
|
|
1795
2002
|
|
|
1796
2003
|
/**
|
|
1797
|
-
* 404 response for
|
|
2004
|
+
* 404 response for PATCH DomainForwards endpoint
|
|
1798
2005
|
*
|
|
1799
2006
|
* @remarks
|
|
1800
2007
|
* This type defines the response structure for the 404 status code
|
|
1801
|
-
* of the
|
|
2008
|
+
* of the PATCH DomainForwards endpoint.
|
|
1802
2009
|
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1803
2010
|
*
|
|
1804
2011
|
|
|
1805
2012
|
*
|
|
1806
|
-
* @path /v1/domain-forwards
|
|
1807
|
-
* @param zone_name (path) - DNS zone name (trailing dot optional)
|
|
2013
|
+
* @path /v1/domain-forwards
|
|
1808
2014
|
*
|
|
1809
|
-
* @see {@link
|
|
2015
|
+
* @see {@link PATCH_DomainForwards_Response} - The main response type definition
|
|
1810
2016
|
* @see {@link Problem} - The actual schema type definition
|
|
1811
2017
|
*/
|
|
1812
|
-
export type
|
|
2018
|
+
export type PATCH_DomainForwards_Response_404 = Problem
|
|
1813
2019
|
|
|
1814
2020
|
/**
|
|
1815
|
-
* 422 response for
|
|
2021
|
+
* 422 response for PATCH DomainForwards endpoint
|
|
1816
2022
|
*
|
|
1817
2023
|
* @remarks
|
|
1818
2024
|
* This type defines the response structure for the 422 status code
|
|
1819
|
-
* of the
|
|
2025
|
+
* of the PATCH DomainForwards endpoint.
|
|
1820
2026
|
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1821
2027
|
*
|
|
1822
2028
|
|
|
1823
2029
|
*
|
|
1824
|
-
* @path /v1/domain-forwards
|
|
1825
|
-
* @param zone_name (path) - DNS zone name (trailing dot optional)
|
|
2030
|
+
* @path /v1/domain-forwards
|
|
1826
2031
|
*
|
|
1827
|
-
* @see {@link
|
|
2032
|
+
* @see {@link PATCH_DomainForwards_Response} - The main response type definition
|
|
1828
2033
|
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
1829
2034
|
*/
|
|
1830
|
-
export type
|
|
2035
|
+
export type PATCH_DomainForwards_Response_422 = HTTPValidationError
|
|
1831
2036
|
|
|
1832
2037
|
/**
|
|
1833
|
-
* Response types for
|
|
2038
|
+
* Response types for DELETE DomainForwardsByHostname endpoint
|
|
1834
2039
|
*
|
|
1835
|
-
*
|
|
2040
|
+
* Delete a domain forward
|
|
2041
|
+
* Deletes the domain forward configuration for the specified hostname
|
|
1836
2042
|
*
|
|
1837
2043
|
* @remarks
|
|
1838
|
-
* This type defines all possible response structures for the
|
|
2044
|
+
* This type defines all possible response structures for the DELETE DomainForwardsByHostname endpoint.
|
|
1839
2045
|
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
1840
2046
|
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
1841
2047
|
*
|
|
1842
2048
|
|
|
1843
2049
|
*
|
|
1844
|
-
* @path /v1/domain-forwards/{
|
|
1845
|
-
* @param
|
|
2050
|
+
* @path /v1/domain-forwards/{hostname}
|
|
2051
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
1846
2052
|
*
|
|
1847
|
-
* @see {@link
|
|
1848
|
-
* @see {@link
|
|
2053
|
+
* @see {@link DELETE_DomainForwardsByHostname_Response_401} - 401 response type
|
|
2054
|
+
* @see {@link DELETE_DomainForwardsByHostname_Response_403} - 403 response type
|
|
2055
|
+
* @see {@link DELETE_DomainForwardsByHostname_Response_404} - 404 response type
|
|
2056
|
+
* @see {@link DELETE_DomainForwardsByHostname_Response_422} - 422 response type
|
|
1849
2057
|
*
|
|
1850
2058
|
|
|
1851
2059
|
*/
|
|
1852
|
-
export type
|
|
2060
|
+
export type DELETE_DomainForwardsByHostname_Response = DELETE_DomainForwardsByHostname_Response_401 | DELETE_DomainForwardsByHostname_Response_403 | DELETE_DomainForwardsByHostname_Response_404 | DELETE_DomainForwardsByHostname_Response_422;
|
|
1853
2061
|
|
|
1854
2062
|
/**
|
|
1855
|
-
*
|
|
2063
|
+
* 401 response for DELETE DomainForwardsByHostname endpoint
|
|
1856
2064
|
*
|
|
1857
2065
|
* @remarks
|
|
1858
|
-
* This type defines the response structure for the
|
|
1859
|
-
* of the
|
|
2066
|
+
* This type defines the response structure for the 401 status code
|
|
2067
|
+
* of the DELETE DomainForwardsByHostname endpoint.
|
|
1860
2068
|
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1861
2069
|
*
|
|
1862
2070
|
|
|
1863
2071
|
*
|
|
1864
|
-
* @path /v1/domain-forwards/{
|
|
1865
|
-
* @param
|
|
2072
|
+
* @path /v1/domain-forwards/{hostname}
|
|
2073
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
1866
2074
|
*
|
|
1867
|
-
* @see {@link
|
|
1868
|
-
* @see {@link
|
|
2075
|
+
* @see {@link DELETE_DomainForwardsByHostname_Response} - The main response type definition
|
|
2076
|
+
* @see {@link Problem} - The actual schema type definition
|
|
1869
2077
|
*/
|
|
1870
|
-
export type
|
|
2078
|
+
export type DELETE_DomainForwardsByHostname_Response_401 = Problem
|
|
1871
2079
|
|
|
1872
2080
|
/**
|
|
1873
|
-
*
|
|
2081
|
+
* 403 response for DELETE DomainForwardsByHostname endpoint
|
|
1874
2082
|
*
|
|
1875
2083
|
* @remarks
|
|
1876
|
-
* This type defines the response structure for the
|
|
1877
|
-
* of the
|
|
2084
|
+
* This type defines the response structure for the 403 status code
|
|
2085
|
+
* of the DELETE DomainForwardsByHostname endpoint.
|
|
1878
2086
|
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1879
2087
|
*
|
|
1880
2088
|
|
|
1881
2089
|
*
|
|
1882
|
-
* @path /v1/domain-forwards/{
|
|
1883
|
-
* @param
|
|
2090
|
+
* @path /v1/domain-forwards/{hostname}
|
|
2091
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
1884
2092
|
*
|
|
1885
|
-
* @see {@link
|
|
1886
|
-
* @see {@link
|
|
2093
|
+
* @see {@link DELETE_DomainForwardsByHostname_Response} - The main response type definition
|
|
2094
|
+
* @see {@link Problem} - The actual schema type definition
|
|
1887
2095
|
*/
|
|
1888
|
-
export type
|
|
2096
|
+
export type DELETE_DomainForwardsByHostname_Response_403 = Problem
|
|
1889
2097
|
|
|
1890
2098
|
/**
|
|
1891
|
-
*
|
|
1892
|
-
*
|
|
1893
|
-
* Create Domain Forward
|
|
2099
|
+
* 404 response for DELETE DomainForwardsByHostname endpoint
|
|
1894
2100
|
*
|
|
1895
2101
|
* @remarks
|
|
1896
|
-
* This type defines
|
|
1897
|
-
*
|
|
1898
|
-
*
|
|
2102
|
+
* This type defines the response structure for the 404 status code
|
|
2103
|
+
* of the DELETE DomainForwardsByHostname endpoint.
|
|
2104
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1899
2105
|
*
|
|
1900
2106
|
|
|
1901
2107
|
*
|
|
1902
|
-
* @path /v1/domain-forwards/{
|
|
1903
|
-
* @param
|
|
1904
|
-
*
|
|
1905
|
-
* @see {@link POST_DomainForwardsByZoneNameByRequestProtocol_Response_201} - 201 response type
|
|
1906
|
-
* @see {@link POST_DomainForwardsByZoneNameByRequestProtocol_Response_409} - 409 response type
|
|
1907
|
-
* @see {@link POST_DomainForwardsByZoneNameByRequestProtocol_Response_422} - 422 response type
|
|
2108
|
+
* @path /v1/domain-forwards/{hostname}
|
|
2109
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
1908
2110
|
*
|
|
1909
|
-
|
|
2111
|
+
* @see {@link DELETE_DomainForwardsByHostname_Response} - The main response type definition
|
|
2112
|
+
* @see {@link Problem} - The actual schema type definition
|
|
1910
2113
|
*/
|
|
1911
|
-
export type
|
|
2114
|
+
export type DELETE_DomainForwardsByHostname_Response_404 = Problem
|
|
1912
2115
|
|
|
1913
2116
|
/**
|
|
1914
|
-
*
|
|
2117
|
+
* 422 response for DELETE DomainForwardsByHostname endpoint
|
|
1915
2118
|
*
|
|
1916
2119
|
* @remarks
|
|
1917
|
-
* This type defines the response structure for the
|
|
1918
|
-
* of the
|
|
2120
|
+
* This type defines the response structure for the 422 status code
|
|
2121
|
+
* of the DELETE DomainForwardsByHostname endpoint.
|
|
1919
2122
|
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1920
2123
|
*
|
|
1921
2124
|
|
|
1922
2125
|
*
|
|
1923
|
-
* @path /v1/domain-forwards/{
|
|
1924
|
-
* @param
|
|
2126
|
+
* @path /v1/domain-forwards/{hostname}
|
|
2127
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
1925
2128
|
*
|
|
1926
|
-
* @see {@link
|
|
1927
|
-
* @see {@link
|
|
2129
|
+
* @see {@link DELETE_DomainForwardsByHostname_Response} - The main response type definition
|
|
2130
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
1928
2131
|
*/
|
|
1929
|
-
export type
|
|
2132
|
+
export type DELETE_DomainForwardsByHostname_Response_422 = HTTPValidationError
|
|
1930
2133
|
|
|
1931
2134
|
/**
|
|
1932
|
-
*
|
|
2135
|
+
* Response types for GET DomainForwardsByHostname endpoint
|
|
2136
|
+
*
|
|
2137
|
+
* Get a domain forward
|
|
2138
|
+
* Retrieves the domain forward configuration for the specified hostname
|
|
1933
2139
|
*
|
|
1934
2140
|
* @remarks
|
|
1935
|
-
* This type defines
|
|
1936
|
-
*
|
|
1937
|
-
*
|
|
2141
|
+
* This type defines all possible response structures for the GET DomainForwardsByHostname endpoint.
|
|
2142
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
2143
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
1938
2144
|
*
|
|
1939
2145
|
|
|
1940
2146
|
*
|
|
1941
|
-
* @path /v1/domain-forwards/{
|
|
1942
|
-
* @param
|
|
2147
|
+
* @path /v1/domain-forwards/{hostname}
|
|
2148
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
1943
2149
|
*
|
|
1944
|
-
* @see {@link
|
|
1945
|
-
* @see {@link
|
|
2150
|
+
* @see {@link GET_DomainForwardsByHostname_Response_200} - 200 response type
|
|
2151
|
+
* @see {@link GET_DomainForwardsByHostname_Response_401} - 401 response type
|
|
2152
|
+
* @see {@link GET_DomainForwardsByHostname_Response_403} - 403 response type
|
|
2153
|
+
* @see {@link GET_DomainForwardsByHostname_Response_404} - 404 response type
|
|
2154
|
+
* @see {@link GET_DomainForwardsByHostname_Response_422} - 422 response type
|
|
2155
|
+
*
|
|
2156
|
+
|
|
1946
2157
|
*/
|
|
1947
|
-
export type
|
|
2158
|
+
export type GET_DomainForwardsByHostname_Response = GET_DomainForwardsByHostname_Response_200 | GET_DomainForwardsByHostname_Response_401 | GET_DomainForwardsByHostname_Response_403 | GET_DomainForwardsByHostname_Response_404 | GET_DomainForwardsByHostname_Response_422;
|
|
1948
2159
|
|
|
1949
2160
|
/**
|
|
1950
|
-
*
|
|
2161
|
+
* 200 response for GET DomainForwardsByHostname endpoint
|
|
1951
2162
|
*
|
|
1952
2163
|
* @remarks
|
|
1953
|
-
* This type defines the response structure for the
|
|
1954
|
-
* of the
|
|
2164
|
+
* This type defines the response structure for the 200 status code
|
|
2165
|
+
* of the GET DomainForwardsByHostname endpoint.
|
|
1955
2166
|
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1956
2167
|
*
|
|
1957
2168
|
|
|
1958
2169
|
*
|
|
1959
|
-
* @path /v1/domain-forwards/{
|
|
1960
|
-
* @param
|
|
2170
|
+
* @path /v1/domain-forwards/{hostname}
|
|
2171
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
1961
2172
|
*
|
|
1962
|
-
* @see {@link
|
|
1963
|
-
* @see {@link
|
|
2173
|
+
* @see {@link GET_DomainForwardsByHostname_Response} - The main response type definition
|
|
2174
|
+
* @see {@link DomainForward} - The actual schema type definition
|
|
1964
2175
|
*/
|
|
1965
|
-
export type
|
|
2176
|
+
export type GET_DomainForwardsByHostname_Response_200 = DomainForward
|
|
1966
2177
|
|
|
1967
2178
|
/**
|
|
1968
|
-
*
|
|
1969
|
-
*
|
|
1970
|
-
* Update Domain Forward
|
|
2179
|
+
* 401 response for GET DomainForwardsByHostname endpoint
|
|
1971
2180
|
*
|
|
1972
2181
|
* @remarks
|
|
1973
|
-
* This type defines
|
|
1974
|
-
*
|
|
1975
|
-
*
|
|
2182
|
+
* This type defines the response structure for the 401 status code
|
|
2183
|
+
* of the GET DomainForwardsByHostname endpoint.
|
|
2184
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1976
2185
|
*
|
|
1977
2186
|
|
|
1978
2187
|
*
|
|
1979
|
-
* @path /v1/domain-forwards/{
|
|
1980
|
-
* @param
|
|
1981
|
-
*
|
|
1982
|
-
* @see {@link PUT_DomainForwardsByZoneNameByRequestProtocol_Response_200} - 200 response type
|
|
1983
|
-
* @see {@link PUT_DomainForwardsByZoneNameByRequestProtocol_Response_404} - 404 response type
|
|
1984
|
-
* @see {@link PUT_DomainForwardsByZoneNameByRequestProtocol_Response_422} - 422 response type
|
|
2188
|
+
* @path /v1/domain-forwards/{hostname}
|
|
2189
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
1985
2190
|
*
|
|
1986
|
-
|
|
2191
|
+
* @see {@link GET_DomainForwardsByHostname_Response} - The main response type definition
|
|
2192
|
+
* @see {@link Problem} - The actual schema type definition
|
|
1987
2193
|
*/
|
|
1988
|
-
export type
|
|
2194
|
+
export type GET_DomainForwardsByHostname_Response_401 = Problem
|
|
1989
2195
|
|
|
1990
2196
|
/**
|
|
1991
|
-
*
|
|
2197
|
+
* 403 response for GET DomainForwardsByHostname endpoint
|
|
1992
2198
|
*
|
|
1993
2199
|
* @remarks
|
|
1994
|
-
* This type defines the response structure for the
|
|
1995
|
-
* of the
|
|
2200
|
+
* This type defines the response structure for the 403 status code
|
|
2201
|
+
* of the GET DomainForwardsByHostname endpoint.
|
|
1996
2202
|
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1997
2203
|
*
|
|
1998
2204
|
|
|
1999
2205
|
*
|
|
2000
|
-
* @path /v1/domain-forwards/{
|
|
2001
|
-
* @param
|
|
2206
|
+
* @path /v1/domain-forwards/{hostname}
|
|
2207
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2002
2208
|
*
|
|
2003
|
-
* @see {@link
|
|
2004
|
-
* @see {@link
|
|
2209
|
+
* @see {@link GET_DomainForwardsByHostname_Response} - The main response type definition
|
|
2210
|
+
* @see {@link Problem} - The actual schema type definition
|
|
2005
2211
|
*/
|
|
2006
|
-
export type
|
|
2212
|
+
export type GET_DomainForwardsByHostname_Response_403 = Problem
|
|
2007
2213
|
|
|
2008
2214
|
/**
|
|
2009
|
-
* 404 response for
|
|
2215
|
+
* 404 response for GET DomainForwardsByHostname endpoint
|
|
2010
2216
|
*
|
|
2011
2217
|
* @remarks
|
|
2012
2218
|
* This type defines the response structure for the 404 status code
|
|
2013
|
-
* of the
|
|
2219
|
+
* of the GET DomainForwardsByHostname endpoint.
|
|
2014
2220
|
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2015
2221
|
*
|
|
2016
2222
|
|
|
2017
2223
|
*
|
|
2018
|
-
* @path /v1/domain-forwards/{
|
|
2019
|
-
* @param
|
|
2224
|
+
* @path /v1/domain-forwards/{hostname}
|
|
2225
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2020
2226
|
*
|
|
2021
|
-
* @see {@link
|
|
2227
|
+
* @see {@link GET_DomainForwardsByHostname_Response} - The main response type definition
|
|
2022
2228
|
* @see {@link Problem} - The actual schema type definition
|
|
2023
2229
|
*/
|
|
2024
|
-
export type
|
|
2230
|
+
export type GET_DomainForwardsByHostname_Response_404 = Problem
|
|
2025
2231
|
|
|
2026
2232
|
/**
|
|
2027
|
-
* 422 response for
|
|
2233
|
+
* 422 response for GET DomainForwardsByHostname endpoint
|
|
2028
2234
|
*
|
|
2029
2235
|
* @remarks
|
|
2030
2236
|
* This type defines the response structure for the 422 status code
|
|
2031
|
-
* of the
|
|
2237
|
+
* of the GET DomainForwardsByHostname endpoint.
|
|
2032
2238
|
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2033
2239
|
*
|
|
2034
2240
|
|
|
2035
2241
|
*
|
|
2036
|
-
* @path /v1/domain-forwards/{
|
|
2037
|
-
* @param
|
|
2242
|
+
* @path /v1/domain-forwards/{hostname}
|
|
2243
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2038
2244
|
*
|
|
2039
|
-
* @see {@link
|
|
2245
|
+
* @see {@link GET_DomainForwardsByHostname_Response} - The main response type definition
|
|
2040
2246
|
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
2041
2247
|
*/
|
|
2042
|
-
export type
|
|
2248
|
+
export type GET_DomainForwardsByHostname_Response_422 = HTTPValidationError
|
|
2043
2249
|
|
|
2044
2250
|
/**
|
|
2045
|
-
* Response types for
|
|
2251
|
+
* Response types for POST DomainForwardsByHostname endpoint
|
|
2046
2252
|
*
|
|
2047
|
-
*
|
|
2253
|
+
* Create a domain forward
|
|
2254
|
+
* Creates a new domain forward configuration for the specified hostname
|
|
2048
2255
|
*
|
|
2049
2256
|
* @remarks
|
|
2050
|
-
* This type defines all possible response structures for the
|
|
2257
|
+
* This type defines all possible response structures for the POST DomainForwardsByHostname endpoint.
|
|
2051
2258
|
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
2052
2259
|
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
2053
2260
|
*
|
|
2054
2261
|
|
|
2055
2262
|
*
|
|
2056
|
-
* @path /v1/domain-forwards/{
|
|
2057
|
-
* @param
|
|
2263
|
+
* @path /v1/domain-forwards/{hostname}
|
|
2264
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2058
2265
|
*
|
|
2059
|
-
* @see {@link
|
|
2266
|
+
* @see {@link POST_DomainForwardsByHostname_Response_201} - 201 response type
|
|
2267
|
+
* @see {@link POST_DomainForwardsByHostname_Response_401} - 401 response type
|
|
2268
|
+
* @see {@link POST_DomainForwardsByHostname_Response_403} - 403 response type
|
|
2269
|
+
* @see {@link POST_DomainForwardsByHostname_Response_409} - 409 response type
|
|
2270
|
+
* @see {@link POST_DomainForwardsByHostname_Response_422} - 422 response type
|
|
2060
2271
|
*
|
|
2061
2272
|
|
|
2062
2273
|
*/
|
|
2063
|
-
export type
|
|
2274
|
+
export type POST_DomainForwardsByHostname_Response = POST_DomainForwardsByHostname_Response_201 | POST_DomainForwardsByHostname_Response_401 | POST_DomainForwardsByHostname_Response_403 | POST_DomainForwardsByHostname_Response_409 | POST_DomainForwardsByHostname_Response_422;
|
|
2064
2275
|
|
|
2065
2276
|
/**
|
|
2066
|
-
*
|
|
2277
|
+
* 201 response for POST DomainForwardsByHostname endpoint
|
|
2067
2278
|
*
|
|
2068
2279
|
* @remarks
|
|
2069
|
-
* This type defines the response structure for the
|
|
2070
|
-
* of the
|
|
2280
|
+
* This type defines the response structure for the 201 status code
|
|
2281
|
+
* of the POST DomainForwardsByHostname endpoint.
|
|
2071
2282
|
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2072
2283
|
*
|
|
2073
2284
|
|
|
2074
2285
|
*
|
|
2075
|
-
* @path /v1/domain-forwards/{
|
|
2076
|
-
* @param
|
|
2286
|
+
* @path /v1/domain-forwards/{hostname}
|
|
2287
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2077
2288
|
*
|
|
2078
|
-
* @see {@link
|
|
2079
|
-
* @see {@link
|
|
2289
|
+
* @see {@link POST_DomainForwardsByHostname_Response} - The main response type definition
|
|
2290
|
+
* @see {@link DomainForward} - The actual schema type definition
|
|
2291
|
+
*/
|
|
2292
|
+
export type POST_DomainForwardsByHostname_Response_201 = DomainForward
|
|
2293
|
+
|
|
2294
|
+
/**
|
|
2295
|
+
* 401 response for POST DomainForwardsByHostname endpoint
|
|
2296
|
+
*
|
|
2297
|
+
* @remarks
|
|
2298
|
+
* This type defines the response structure for the 401 status code
|
|
2299
|
+
* of the POST DomainForwardsByHostname endpoint.
|
|
2300
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2301
|
+
*
|
|
2302
|
+
|
|
2303
|
+
*
|
|
2304
|
+
* @path /v1/domain-forwards/{hostname}
|
|
2305
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2306
|
+
*
|
|
2307
|
+
* @see {@link POST_DomainForwardsByHostname_Response} - The main response type definition
|
|
2308
|
+
* @see {@link Problem} - The actual schema type definition
|
|
2080
2309
|
*/
|
|
2081
|
-
export type
|
|
2310
|
+
export type POST_DomainForwardsByHostname_Response_401 = Problem
|
|
2082
2311
|
|
|
2083
2312
|
/**
|
|
2084
|
-
*
|
|
2313
|
+
* 403 response for POST DomainForwardsByHostname endpoint
|
|
2314
|
+
*
|
|
2315
|
+
* @remarks
|
|
2316
|
+
* This type defines the response structure for the 403 status code
|
|
2317
|
+
* of the POST DomainForwardsByHostname endpoint.
|
|
2318
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2085
2319
|
*
|
|
2086
|
-
|
|
2320
|
+
|
|
2321
|
+
*
|
|
2322
|
+
* @path /v1/domain-forwards/{hostname}
|
|
2323
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2324
|
+
*
|
|
2325
|
+
* @see {@link POST_DomainForwardsByHostname_Response} - The main response type definition
|
|
2326
|
+
* @see {@link Problem} - The actual schema type definition
|
|
2327
|
+
*/
|
|
2328
|
+
export type POST_DomainForwardsByHostname_Response_403 = Problem
|
|
2329
|
+
|
|
2330
|
+
/**
|
|
2331
|
+
* 409 response for POST DomainForwardsByHostname endpoint
|
|
2087
2332
|
*
|
|
2088
2333
|
* @remarks
|
|
2089
|
-
* This type defines
|
|
2334
|
+
* This type defines the response structure for the 409 status code
|
|
2335
|
+
* of the POST DomainForwardsByHostname endpoint.
|
|
2336
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2337
|
+
*
|
|
2338
|
+
|
|
2339
|
+
*
|
|
2340
|
+
* @path /v1/domain-forwards/{hostname}
|
|
2341
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2342
|
+
*
|
|
2343
|
+
* @see {@link POST_DomainForwardsByHostname_Response} - The main response type definition
|
|
2344
|
+
* @see {@link Problem} - The actual schema type definition
|
|
2345
|
+
*/
|
|
2346
|
+
export type POST_DomainForwardsByHostname_Response_409 = Problem
|
|
2347
|
+
|
|
2348
|
+
/**
|
|
2349
|
+
* 422 response for POST DomainForwardsByHostname endpoint
|
|
2350
|
+
*
|
|
2351
|
+
* @remarks
|
|
2352
|
+
* This type defines the response structure for the 422 status code
|
|
2353
|
+
* of the POST DomainForwardsByHostname endpoint.
|
|
2354
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2355
|
+
*
|
|
2356
|
+
|
|
2357
|
+
*
|
|
2358
|
+
* @path /v1/domain-forwards/{hostname}
|
|
2359
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2360
|
+
*
|
|
2361
|
+
* @see {@link POST_DomainForwardsByHostname_Response} - The main response type definition
|
|
2362
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
2363
|
+
*/
|
|
2364
|
+
export type POST_DomainForwardsByHostname_Response_422 = HTTPValidationError
|
|
2365
|
+
|
|
2366
|
+
/**
|
|
2367
|
+
* Response types for DELETE DomainForwardsByHostnameByProtocol endpoint
|
|
2368
|
+
*
|
|
2369
|
+
* Delete domain forward set
|
|
2370
|
+
* Deletes a domain forward set for a specific protocol (HTTP or HTTPS).
|
|
2371
|
+
*
|
|
2372
|
+
* @remarks
|
|
2373
|
+
* This type defines all possible response structures for the DELETE DomainForwardsByHostnameByProtocol endpoint.
|
|
2090
2374
|
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
2091
2375
|
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
2092
2376
|
*
|
|
2093
2377
|
|
|
2094
2378
|
*
|
|
2095
|
-
* @path /v1/domain-forwards/{
|
|
2096
|
-
* @param
|
|
2379
|
+
* @path /v1/domain-forwards/{hostname}/{protocol}
|
|
2380
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2381
|
+
*
|
|
2382
|
+
* @see {@link DELETE_DomainForwardsByHostnameByProtocol_Response_401} - 401 response type
|
|
2383
|
+
* @see {@link DELETE_DomainForwardsByHostnameByProtocol_Response_403} - 403 response type
|
|
2384
|
+
* @see {@link DELETE_DomainForwardsByHostnameByProtocol_Response_404} - 404 response type
|
|
2385
|
+
* @see {@link DELETE_DomainForwardsByHostnameByProtocol_Response_422} - 422 response type
|
|
2386
|
+
*
|
|
2387
|
+
|
|
2388
|
+
*/
|
|
2389
|
+
export type DELETE_DomainForwardsByHostnameByProtocol_Response = DELETE_DomainForwardsByHostnameByProtocol_Response_401 | DELETE_DomainForwardsByHostnameByProtocol_Response_403 | DELETE_DomainForwardsByHostnameByProtocol_Response_404 | DELETE_DomainForwardsByHostnameByProtocol_Response_422;
|
|
2390
|
+
|
|
2391
|
+
/**
|
|
2392
|
+
* 401 response for DELETE DomainForwardsByHostnameByProtocol endpoint
|
|
2393
|
+
*
|
|
2394
|
+
* @remarks
|
|
2395
|
+
* This type defines the response structure for the 401 status code
|
|
2396
|
+
* of the DELETE DomainForwardsByHostnameByProtocol endpoint.
|
|
2397
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2398
|
+
*
|
|
2399
|
+
|
|
2400
|
+
*
|
|
2401
|
+
* @path /v1/domain-forwards/{hostname}/{protocol}
|
|
2402
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2403
|
+
*
|
|
2404
|
+
* @see {@link DELETE_DomainForwardsByHostnameByProtocol_Response} - The main response type definition
|
|
2405
|
+
* @see {@link Problem} - The actual schema type definition
|
|
2406
|
+
*/
|
|
2407
|
+
export type DELETE_DomainForwardsByHostnameByProtocol_Response_401 = Problem
|
|
2408
|
+
|
|
2409
|
+
/**
|
|
2410
|
+
* 403 response for DELETE DomainForwardsByHostnameByProtocol endpoint
|
|
2411
|
+
*
|
|
2412
|
+
* @remarks
|
|
2413
|
+
* This type defines the response structure for the 403 status code
|
|
2414
|
+
* of the DELETE DomainForwardsByHostnameByProtocol endpoint.
|
|
2415
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2416
|
+
*
|
|
2417
|
+
|
|
2418
|
+
*
|
|
2419
|
+
* @path /v1/domain-forwards/{hostname}/{protocol}
|
|
2420
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2421
|
+
*
|
|
2422
|
+
* @see {@link DELETE_DomainForwardsByHostnameByProtocol_Response} - The main response type definition
|
|
2423
|
+
* @see {@link Problem} - The actual schema type definition
|
|
2424
|
+
*/
|
|
2425
|
+
export type DELETE_DomainForwardsByHostnameByProtocol_Response_403 = Problem
|
|
2426
|
+
|
|
2427
|
+
/**
|
|
2428
|
+
* 404 response for DELETE DomainForwardsByHostnameByProtocol endpoint
|
|
2429
|
+
*
|
|
2430
|
+
* @remarks
|
|
2431
|
+
* This type defines the response structure for the 404 status code
|
|
2432
|
+
* of the DELETE DomainForwardsByHostnameByProtocol endpoint.
|
|
2433
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2434
|
+
*
|
|
2435
|
+
|
|
2436
|
+
*
|
|
2437
|
+
* @path /v1/domain-forwards/{hostname}/{protocol}
|
|
2438
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2439
|
+
*
|
|
2440
|
+
* @see {@link DELETE_DomainForwardsByHostnameByProtocol_Response} - The main response type definition
|
|
2441
|
+
* @see {@link Problem} - The actual schema type definition
|
|
2442
|
+
*/
|
|
2443
|
+
export type DELETE_DomainForwardsByHostnameByProtocol_Response_404 = Problem
|
|
2444
|
+
|
|
2445
|
+
/**
|
|
2446
|
+
* 422 response for DELETE DomainForwardsByHostnameByProtocol endpoint
|
|
2447
|
+
*
|
|
2448
|
+
* @remarks
|
|
2449
|
+
* This type defines the response structure for the 422 status code
|
|
2450
|
+
* of the DELETE DomainForwardsByHostnameByProtocol endpoint.
|
|
2451
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2452
|
+
*
|
|
2453
|
+
|
|
2454
|
+
*
|
|
2455
|
+
* @path /v1/domain-forwards/{hostname}/{protocol}
|
|
2456
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2457
|
+
*
|
|
2458
|
+
* @see {@link DELETE_DomainForwardsByHostnameByProtocol_Response} - The main response type definition
|
|
2459
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
2460
|
+
*/
|
|
2461
|
+
export type DELETE_DomainForwardsByHostnameByProtocol_Response_422 = HTTPValidationError
|
|
2462
|
+
|
|
2463
|
+
/**
|
|
2464
|
+
* Response types for GET DomainForwardsByHostnameByProtocol endpoint
|
|
2465
|
+
*
|
|
2466
|
+
* Get domain forward set
|
|
2467
|
+
* Retrieves all redirects for a specific protocol (HTTP or HTTPS) for the specified hostname
|
|
2468
|
+
*
|
|
2469
|
+
* @remarks
|
|
2470
|
+
* This type defines all possible response structures for the GET DomainForwardsByHostnameByProtocol endpoint.
|
|
2471
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
2472
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
2473
|
+
*
|
|
2474
|
+
|
|
2475
|
+
*
|
|
2476
|
+
* @path /v1/domain-forwards/{hostname}/{protocol}
|
|
2477
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2478
|
+
*
|
|
2479
|
+
* @see {@link GET_DomainForwardsByHostnameByProtocol_Response_200} - 200 response type
|
|
2480
|
+
* @see {@link GET_DomainForwardsByHostnameByProtocol_Response_401} - 401 response type
|
|
2481
|
+
* @see {@link GET_DomainForwardsByHostnameByProtocol_Response_403} - 403 response type
|
|
2482
|
+
* @see {@link GET_DomainForwardsByHostnameByProtocol_Response_404} - 404 response type
|
|
2483
|
+
* @see {@link GET_DomainForwardsByHostnameByProtocol_Response_422} - 422 response type
|
|
2484
|
+
*
|
|
2485
|
+
|
|
2486
|
+
*/
|
|
2487
|
+
export type GET_DomainForwardsByHostnameByProtocol_Response = GET_DomainForwardsByHostnameByProtocol_Response_200 | GET_DomainForwardsByHostnameByProtocol_Response_401 | GET_DomainForwardsByHostnameByProtocol_Response_403 | GET_DomainForwardsByHostnameByProtocol_Response_404 | GET_DomainForwardsByHostnameByProtocol_Response_422;
|
|
2488
|
+
|
|
2489
|
+
/**
|
|
2490
|
+
* 200 response for GET DomainForwardsByHostnameByProtocol endpoint
|
|
2491
|
+
*
|
|
2492
|
+
* @remarks
|
|
2493
|
+
* This type defines the response structure for the 200 status code
|
|
2494
|
+
* of the GET DomainForwardsByHostnameByProtocol endpoint.
|
|
2495
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2496
|
+
*
|
|
2497
|
+
|
|
2498
|
+
*
|
|
2499
|
+
* @path /v1/domain-forwards/{hostname}/{protocol}
|
|
2500
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2501
|
+
*
|
|
2502
|
+
* @see {@link GET_DomainForwardsByHostnameByProtocol_Response} - The main response type definition
|
|
2503
|
+
* @see {@link DomainForwardSet} - The actual schema type definition
|
|
2504
|
+
*/
|
|
2505
|
+
export type GET_DomainForwardsByHostnameByProtocol_Response_200 = DomainForwardSet
|
|
2506
|
+
|
|
2507
|
+
/**
|
|
2508
|
+
* 401 response for GET DomainForwardsByHostnameByProtocol endpoint
|
|
2509
|
+
*
|
|
2510
|
+
* @remarks
|
|
2511
|
+
* This type defines the response structure for the 401 status code
|
|
2512
|
+
* of the GET DomainForwardsByHostnameByProtocol endpoint.
|
|
2513
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2514
|
+
*
|
|
2515
|
+
|
|
2516
|
+
*
|
|
2517
|
+
* @path /v1/domain-forwards/{hostname}/{protocol}
|
|
2518
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2519
|
+
*
|
|
2520
|
+
* @see {@link GET_DomainForwardsByHostnameByProtocol_Response} - The main response type definition
|
|
2521
|
+
* @see {@link Problem} - The actual schema type definition
|
|
2522
|
+
*/
|
|
2523
|
+
export type GET_DomainForwardsByHostnameByProtocol_Response_401 = Problem
|
|
2524
|
+
|
|
2525
|
+
/**
|
|
2526
|
+
* 403 response for GET DomainForwardsByHostnameByProtocol endpoint
|
|
2527
|
+
*
|
|
2528
|
+
* @remarks
|
|
2529
|
+
* This type defines the response structure for the 403 status code
|
|
2530
|
+
* of the GET DomainForwardsByHostnameByProtocol endpoint.
|
|
2531
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2532
|
+
*
|
|
2533
|
+
|
|
2534
|
+
*
|
|
2535
|
+
* @path /v1/domain-forwards/{hostname}/{protocol}
|
|
2536
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2537
|
+
*
|
|
2538
|
+
* @see {@link GET_DomainForwardsByHostnameByProtocol_Response} - The main response type definition
|
|
2539
|
+
* @see {@link Problem} - The actual schema type definition
|
|
2540
|
+
*/
|
|
2541
|
+
export type GET_DomainForwardsByHostnameByProtocol_Response_403 = Problem
|
|
2542
|
+
|
|
2543
|
+
/**
|
|
2544
|
+
* 404 response for GET DomainForwardsByHostnameByProtocol endpoint
|
|
2545
|
+
*
|
|
2546
|
+
* @remarks
|
|
2547
|
+
* This type defines the response structure for the 404 status code
|
|
2548
|
+
* of the GET DomainForwardsByHostnameByProtocol endpoint.
|
|
2549
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2550
|
+
*
|
|
2551
|
+
|
|
2552
|
+
*
|
|
2553
|
+
* @path /v1/domain-forwards/{hostname}/{protocol}
|
|
2554
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2555
|
+
*
|
|
2556
|
+
* @see {@link GET_DomainForwardsByHostnameByProtocol_Response} - The main response type definition
|
|
2557
|
+
* @see {@link Problem} - The actual schema type definition
|
|
2558
|
+
*/
|
|
2559
|
+
export type GET_DomainForwardsByHostnameByProtocol_Response_404 = Problem
|
|
2560
|
+
|
|
2561
|
+
/**
|
|
2562
|
+
* 422 response for GET DomainForwardsByHostnameByProtocol endpoint
|
|
2563
|
+
*
|
|
2564
|
+
* @remarks
|
|
2565
|
+
* This type defines the response structure for the 422 status code
|
|
2566
|
+
* of the GET DomainForwardsByHostnameByProtocol endpoint.
|
|
2567
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2568
|
+
*
|
|
2569
|
+
|
|
2570
|
+
*
|
|
2571
|
+
* @path /v1/domain-forwards/{hostname}/{protocol}
|
|
2572
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2573
|
+
*
|
|
2574
|
+
* @see {@link GET_DomainForwardsByHostnameByProtocol_Response} - The main response type definition
|
|
2575
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
2576
|
+
*/
|
|
2577
|
+
export type GET_DomainForwardsByHostnameByProtocol_Response_422 = HTTPValidationError
|
|
2578
|
+
|
|
2579
|
+
/**
|
|
2580
|
+
* Response types for POST DomainForwardsByHostnameByProtocol endpoint
|
|
2581
|
+
*
|
|
2582
|
+
* Create domain forward set
|
|
2583
|
+
* Creates a new domain forward set for a specific protocol (HTTP or HTTPS). Raises an error if the set already exists.
|
|
2584
|
+
*
|
|
2585
|
+
* @remarks
|
|
2586
|
+
* This type defines all possible response structures for the POST DomainForwardsByHostnameByProtocol endpoint.
|
|
2587
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
2588
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
2589
|
+
*
|
|
2590
|
+
|
|
2591
|
+
*
|
|
2592
|
+
* @path /v1/domain-forwards/{hostname}/{protocol}
|
|
2593
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2594
|
+
*
|
|
2595
|
+
* @see {@link POST_DomainForwardsByHostnameByProtocol_Response_201} - 201 response type
|
|
2596
|
+
* @see {@link POST_DomainForwardsByHostnameByProtocol_Response_401} - 401 response type
|
|
2597
|
+
* @see {@link POST_DomainForwardsByHostnameByProtocol_Response_403} - 403 response type
|
|
2598
|
+
* @see {@link POST_DomainForwardsByHostnameByProtocol_Response_404} - 404 response type
|
|
2599
|
+
* @see {@link POST_DomainForwardsByHostnameByProtocol_Response_409} - 409 response type
|
|
2600
|
+
* @see {@link POST_DomainForwardsByHostnameByProtocol_Response_422} - 422 response type
|
|
2601
|
+
*
|
|
2602
|
+
|
|
2603
|
+
*/
|
|
2604
|
+
export type POST_DomainForwardsByHostnameByProtocol_Response = POST_DomainForwardsByHostnameByProtocol_Response_201 | POST_DomainForwardsByHostnameByProtocol_Response_401 | POST_DomainForwardsByHostnameByProtocol_Response_403 | POST_DomainForwardsByHostnameByProtocol_Response_404 | POST_DomainForwardsByHostnameByProtocol_Response_409 | POST_DomainForwardsByHostnameByProtocol_Response_422;
|
|
2605
|
+
|
|
2606
|
+
/**
|
|
2607
|
+
* 201 response for POST DomainForwardsByHostnameByProtocol endpoint
|
|
2608
|
+
*
|
|
2609
|
+
* @remarks
|
|
2610
|
+
* This type defines the response structure for the 201 status code
|
|
2611
|
+
* of the POST DomainForwardsByHostnameByProtocol endpoint.
|
|
2612
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2613
|
+
*
|
|
2614
|
+
|
|
2615
|
+
*
|
|
2616
|
+
* @path /v1/domain-forwards/{hostname}/{protocol}
|
|
2617
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2618
|
+
*
|
|
2619
|
+
* @see {@link POST_DomainForwardsByHostnameByProtocol_Response} - The main response type definition
|
|
2620
|
+
* @see {@link DomainForwardSet} - The actual schema type definition
|
|
2621
|
+
*/
|
|
2622
|
+
export type POST_DomainForwardsByHostnameByProtocol_Response_201 = DomainForwardSet
|
|
2623
|
+
|
|
2624
|
+
/**
|
|
2625
|
+
* 401 response for POST DomainForwardsByHostnameByProtocol endpoint
|
|
2626
|
+
*
|
|
2627
|
+
* @remarks
|
|
2628
|
+
* This type defines the response structure for the 401 status code
|
|
2629
|
+
* of the POST DomainForwardsByHostnameByProtocol endpoint.
|
|
2630
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2631
|
+
*
|
|
2632
|
+
|
|
2633
|
+
*
|
|
2634
|
+
* @path /v1/domain-forwards/{hostname}/{protocol}
|
|
2635
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2636
|
+
*
|
|
2637
|
+
* @see {@link POST_DomainForwardsByHostnameByProtocol_Response} - The main response type definition
|
|
2638
|
+
* @see {@link Problem} - The actual schema type definition
|
|
2639
|
+
*/
|
|
2640
|
+
export type POST_DomainForwardsByHostnameByProtocol_Response_401 = Problem
|
|
2641
|
+
|
|
2642
|
+
/**
|
|
2643
|
+
* 403 response for POST DomainForwardsByHostnameByProtocol endpoint
|
|
2644
|
+
*
|
|
2645
|
+
* @remarks
|
|
2646
|
+
* This type defines the response structure for the 403 status code
|
|
2647
|
+
* of the POST DomainForwardsByHostnameByProtocol endpoint.
|
|
2648
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2649
|
+
*
|
|
2650
|
+
|
|
2651
|
+
*
|
|
2652
|
+
* @path /v1/domain-forwards/{hostname}/{protocol}
|
|
2653
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2654
|
+
*
|
|
2655
|
+
* @see {@link POST_DomainForwardsByHostnameByProtocol_Response} - The main response type definition
|
|
2656
|
+
* @see {@link Problem} - The actual schema type definition
|
|
2657
|
+
*/
|
|
2658
|
+
export type POST_DomainForwardsByHostnameByProtocol_Response_403 = Problem
|
|
2659
|
+
|
|
2660
|
+
/**
|
|
2661
|
+
* 404 response for POST DomainForwardsByHostnameByProtocol endpoint
|
|
2662
|
+
*
|
|
2663
|
+
* @remarks
|
|
2664
|
+
* This type defines the response structure for the 404 status code
|
|
2665
|
+
* of the POST DomainForwardsByHostnameByProtocol endpoint.
|
|
2666
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2667
|
+
*
|
|
2668
|
+
|
|
2669
|
+
*
|
|
2670
|
+
* @path /v1/domain-forwards/{hostname}/{protocol}
|
|
2671
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2672
|
+
*
|
|
2673
|
+
* @see {@link POST_DomainForwardsByHostnameByProtocol_Response} - The main response type definition
|
|
2674
|
+
* @see {@link Problem} - The actual schema type definition
|
|
2675
|
+
*/
|
|
2676
|
+
export type POST_DomainForwardsByHostnameByProtocol_Response_404 = Problem
|
|
2677
|
+
|
|
2678
|
+
/**
|
|
2679
|
+
* 409 response for POST DomainForwardsByHostnameByProtocol endpoint
|
|
2680
|
+
*
|
|
2681
|
+
* @remarks
|
|
2682
|
+
* This type defines the response structure for the 409 status code
|
|
2683
|
+
* of the POST DomainForwardsByHostnameByProtocol endpoint.
|
|
2684
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2685
|
+
*
|
|
2686
|
+
|
|
2687
|
+
*
|
|
2688
|
+
* @path /v1/domain-forwards/{hostname}/{protocol}
|
|
2689
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2690
|
+
*
|
|
2691
|
+
* @see {@link POST_DomainForwardsByHostnameByProtocol_Response} - The main response type definition
|
|
2692
|
+
* @see {@link Problem} - The actual schema type definition
|
|
2693
|
+
*/
|
|
2694
|
+
export type POST_DomainForwardsByHostnameByProtocol_Response_409 = Problem
|
|
2695
|
+
|
|
2696
|
+
/**
|
|
2697
|
+
* 422 response for POST DomainForwardsByHostnameByProtocol endpoint
|
|
2698
|
+
*
|
|
2699
|
+
* @remarks
|
|
2700
|
+
* This type defines the response structure for the 422 status code
|
|
2701
|
+
* of the POST DomainForwardsByHostnameByProtocol endpoint.
|
|
2702
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2703
|
+
*
|
|
2704
|
+
|
|
2705
|
+
*
|
|
2706
|
+
* @path /v1/domain-forwards/{hostname}/{protocol}
|
|
2707
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2708
|
+
*
|
|
2709
|
+
* @see {@link POST_DomainForwardsByHostnameByProtocol_Response} - The main response type definition
|
|
2710
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
2711
|
+
*/
|
|
2712
|
+
export type POST_DomainForwardsByHostnameByProtocol_Response_422 = HTTPValidationError
|
|
2713
|
+
|
|
2714
|
+
/**
|
|
2715
|
+
* Response types for PUT DomainForwardsByHostnameByProtocol endpoint
|
|
2716
|
+
*
|
|
2717
|
+
* Update domain forward set
|
|
2718
|
+
* Updates an existing domain forward set for a specific protocol (HTTP or HTTPS). All existing redirects for this protocol are replaced with the provided redirects. Raises an error if the set does not exist.
|
|
2719
|
+
*
|
|
2720
|
+
* @remarks
|
|
2721
|
+
* This type defines all possible response structures for the PUT DomainForwardsByHostnameByProtocol endpoint.
|
|
2722
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
2723
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
2724
|
+
*
|
|
2725
|
+
|
|
2726
|
+
*
|
|
2727
|
+
* @path /v1/domain-forwards/{hostname}/{protocol}
|
|
2728
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2729
|
+
*
|
|
2730
|
+
* @see {@link PUT_DomainForwardsByHostnameByProtocol_Response_200} - 200 response type
|
|
2731
|
+
* @see {@link PUT_DomainForwardsByHostnameByProtocol_Response_401} - 401 response type
|
|
2732
|
+
* @see {@link PUT_DomainForwardsByHostnameByProtocol_Response_403} - 403 response type
|
|
2733
|
+
* @see {@link PUT_DomainForwardsByHostnameByProtocol_Response_404} - 404 response type
|
|
2734
|
+
* @see {@link PUT_DomainForwardsByHostnameByProtocol_Response_422} - 422 response type
|
|
2735
|
+
*
|
|
2736
|
+
|
|
2737
|
+
*/
|
|
2738
|
+
export type PUT_DomainForwardsByHostnameByProtocol_Response = PUT_DomainForwardsByHostnameByProtocol_Response_200 | PUT_DomainForwardsByHostnameByProtocol_Response_401 | PUT_DomainForwardsByHostnameByProtocol_Response_403 | PUT_DomainForwardsByHostnameByProtocol_Response_404 | PUT_DomainForwardsByHostnameByProtocol_Response_422;
|
|
2739
|
+
|
|
2740
|
+
/**
|
|
2741
|
+
* 200 response for PUT DomainForwardsByHostnameByProtocol endpoint
|
|
2742
|
+
*
|
|
2743
|
+
* @remarks
|
|
2744
|
+
* This type defines the response structure for the 200 status code
|
|
2745
|
+
* of the PUT DomainForwardsByHostnameByProtocol endpoint.
|
|
2746
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2747
|
+
*
|
|
2748
|
+
|
|
2749
|
+
*
|
|
2750
|
+
* @path /v1/domain-forwards/{hostname}/{protocol}
|
|
2751
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2752
|
+
*
|
|
2753
|
+
* @see {@link PUT_DomainForwardsByHostnameByProtocol_Response} - The main response type definition
|
|
2754
|
+
* @see {@link DomainForwardSet} - The actual schema type definition
|
|
2755
|
+
*/
|
|
2756
|
+
export type PUT_DomainForwardsByHostnameByProtocol_Response_200 = DomainForwardSet
|
|
2757
|
+
|
|
2758
|
+
/**
|
|
2759
|
+
* 401 response for PUT DomainForwardsByHostnameByProtocol endpoint
|
|
2760
|
+
*
|
|
2761
|
+
* @remarks
|
|
2762
|
+
* This type defines the response structure for the 401 status code
|
|
2763
|
+
* of the PUT DomainForwardsByHostnameByProtocol endpoint.
|
|
2764
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2765
|
+
*
|
|
2766
|
+
|
|
2767
|
+
*
|
|
2768
|
+
* @path /v1/domain-forwards/{hostname}/{protocol}
|
|
2769
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2770
|
+
*
|
|
2771
|
+
* @see {@link PUT_DomainForwardsByHostnameByProtocol_Response} - The main response type definition
|
|
2772
|
+
* @see {@link Problem} - The actual schema type definition
|
|
2773
|
+
*/
|
|
2774
|
+
export type PUT_DomainForwardsByHostnameByProtocol_Response_401 = Problem
|
|
2775
|
+
|
|
2776
|
+
/**
|
|
2777
|
+
* 403 response for PUT DomainForwardsByHostnameByProtocol endpoint
|
|
2778
|
+
*
|
|
2779
|
+
* @remarks
|
|
2780
|
+
* This type defines the response structure for the 403 status code
|
|
2781
|
+
* of the PUT DomainForwardsByHostnameByProtocol endpoint.
|
|
2782
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2783
|
+
*
|
|
2784
|
+
|
|
2785
|
+
*
|
|
2786
|
+
* @path /v1/domain-forwards/{hostname}/{protocol}
|
|
2787
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2788
|
+
*
|
|
2789
|
+
* @see {@link PUT_DomainForwardsByHostnameByProtocol_Response} - The main response type definition
|
|
2790
|
+
* @see {@link Problem} - The actual schema type definition
|
|
2791
|
+
*/
|
|
2792
|
+
export type PUT_DomainForwardsByHostnameByProtocol_Response_403 = Problem
|
|
2793
|
+
|
|
2794
|
+
/**
|
|
2795
|
+
* 404 response for PUT DomainForwardsByHostnameByProtocol endpoint
|
|
2796
|
+
*
|
|
2797
|
+
* @remarks
|
|
2798
|
+
* This type defines the response structure for the 404 status code
|
|
2799
|
+
* of the PUT DomainForwardsByHostnameByProtocol endpoint.
|
|
2800
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2801
|
+
*
|
|
2802
|
+
|
|
2803
|
+
*
|
|
2804
|
+
* @path /v1/domain-forwards/{hostname}/{protocol}
|
|
2805
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2806
|
+
*
|
|
2807
|
+
* @see {@link PUT_DomainForwardsByHostnameByProtocol_Response} - The main response type definition
|
|
2808
|
+
* @see {@link Problem} - The actual schema type definition
|
|
2809
|
+
*/
|
|
2810
|
+
export type PUT_DomainForwardsByHostnameByProtocol_Response_404 = Problem
|
|
2811
|
+
|
|
2812
|
+
/**
|
|
2813
|
+
* 422 response for PUT DomainForwardsByHostnameByProtocol endpoint
|
|
2814
|
+
*
|
|
2815
|
+
* @remarks
|
|
2816
|
+
* This type defines the response structure for the 422 status code
|
|
2817
|
+
* of the PUT DomainForwardsByHostnameByProtocol endpoint.
|
|
2818
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2819
|
+
*
|
|
2820
|
+
|
|
2821
|
+
*
|
|
2822
|
+
* @path /v1/domain-forwards/{hostname}/{protocol}
|
|
2823
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2824
|
+
*
|
|
2825
|
+
* @see {@link PUT_DomainForwardsByHostnameByProtocol_Response} - The main response type definition
|
|
2826
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
2827
|
+
*/
|
|
2828
|
+
export type PUT_DomainForwardsByHostnameByProtocol_Response_422 = HTTPValidationError
|
|
2829
|
+
|
|
2830
|
+
/**
|
|
2831
|
+
* Response types for PATCH DomainForwardsByHostnameDisable endpoint
|
|
2832
|
+
*
|
|
2833
|
+
* Disable domain forward
|
|
2834
|
+
* Disables domain forwarding by removing DNS records. The domain forward configuration is preserved but disabled.
|
|
2835
|
+
*
|
|
2836
|
+
* @remarks
|
|
2837
|
+
* This type defines all possible response structures for the PATCH DomainForwardsByHostnameDisable endpoint.
|
|
2838
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
2839
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
2840
|
+
*
|
|
2841
|
+
|
|
2842
|
+
*
|
|
2843
|
+
* @path /v1/domain-forwards/{hostname}/disable
|
|
2844
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2845
|
+
*
|
|
2846
|
+
* @see {@link PATCH_DomainForwardsByHostnameDisable_Response_401} - 401 response type
|
|
2847
|
+
* @see {@link PATCH_DomainForwardsByHostnameDisable_Response_403} - 403 response type
|
|
2848
|
+
* @see {@link PATCH_DomainForwardsByHostnameDisable_Response_422} - 422 response type
|
|
2849
|
+
*
|
|
2850
|
+
|
|
2851
|
+
*/
|
|
2852
|
+
export type PATCH_DomainForwardsByHostnameDisable_Response = PATCH_DomainForwardsByHostnameDisable_Response_401 | PATCH_DomainForwardsByHostnameDisable_Response_403 | PATCH_DomainForwardsByHostnameDisable_Response_422;
|
|
2853
|
+
|
|
2854
|
+
/**
|
|
2855
|
+
* 401 response for PATCH DomainForwardsByHostnameDisable endpoint
|
|
2856
|
+
*
|
|
2857
|
+
* @remarks
|
|
2858
|
+
* This type defines the response structure for the 401 status code
|
|
2859
|
+
* of the PATCH DomainForwardsByHostnameDisable endpoint.
|
|
2860
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2861
|
+
*
|
|
2862
|
+
|
|
2863
|
+
*
|
|
2864
|
+
* @path /v1/domain-forwards/{hostname}/disable
|
|
2865
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2866
|
+
*
|
|
2867
|
+
* @see {@link PATCH_DomainForwardsByHostnameDisable_Response} - The main response type definition
|
|
2868
|
+
* @see {@link Problem} - The actual schema type definition
|
|
2869
|
+
*/
|
|
2870
|
+
export type PATCH_DomainForwardsByHostnameDisable_Response_401 = Problem
|
|
2871
|
+
|
|
2872
|
+
/**
|
|
2873
|
+
* 403 response for PATCH DomainForwardsByHostnameDisable endpoint
|
|
2874
|
+
*
|
|
2875
|
+
* @remarks
|
|
2876
|
+
* This type defines the response structure for the 403 status code
|
|
2877
|
+
* of the PATCH DomainForwardsByHostnameDisable endpoint.
|
|
2878
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2879
|
+
*
|
|
2880
|
+
|
|
2881
|
+
*
|
|
2882
|
+
* @path /v1/domain-forwards/{hostname}/disable
|
|
2883
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2884
|
+
*
|
|
2885
|
+
* @see {@link PATCH_DomainForwardsByHostnameDisable_Response} - The main response type definition
|
|
2886
|
+
* @see {@link Problem} - The actual schema type definition
|
|
2887
|
+
*/
|
|
2888
|
+
export type PATCH_DomainForwardsByHostnameDisable_Response_403 = Problem
|
|
2889
|
+
|
|
2890
|
+
/**
|
|
2891
|
+
* 422 response for PATCH DomainForwardsByHostnameDisable endpoint
|
|
2892
|
+
*
|
|
2893
|
+
* @remarks
|
|
2894
|
+
* This type defines the response structure for the 422 status code
|
|
2895
|
+
* of the PATCH DomainForwardsByHostnameDisable endpoint.
|
|
2896
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2897
|
+
*
|
|
2898
|
+
|
|
2899
|
+
*
|
|
2900
|
+
* @path /v1/domain-forwards/{hostname}/disable
|
|
2901
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2902
|
+
*
|
|
2903
|
+
* @see {@link PATCH_DomainForwardsByHostnameDisable_Response} - The main response type definition
|
|
2904
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
2905
|
+
*/
|
|
2906
|
+
export type PATCH_DomainForwardsByHostnameDisable_Response_422 = HTTPValidationError
|
|
2907
|
+
|
|
2908
|
+
/**
|
|
2909
|
+
* Response types for PATCH DomainForwardsByHostnameEnable endpoint
|
|
2910
|
+
*
|
|
2911
|
+
* Enable domain forward
|
|
2912
|
+
* Enables domain forwarding by creating necessary DNS records. Optionally auto-creates the zone and domain forward if they don't exist.
|
|
2913
|
+
*
|
|
2914
|
+
* @remarks
|
|
2915
|
+
* This type defines all possible response structures for the PATCH DomainForwardsByHostnameEnable endpoint.
|
|
2916
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
2917
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
2918
|
+
*
|
|
2919
|
+
|
|
2920
|
+
*
|
|
2921
|
+
* @path /v1/domain-forwards/{hostname}/enable
|
|
2922
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2923
|
+
* @param auto_create_zone (query) - Auto create zone if it doesn't exist
|
|
2924
|
+
* @param auto_create_domain_forward (query) - Auto create domain forward if it doesn't exist
|
|
2925
|
+
* @param wildcard (query) - Wildcard domain forwarding
|
|
2926
|
+
*
|
|
2927
|
+
* @see {@link PATCH_DomainForwardsByHostnameEnable_Response_400} - 400 response type
|
|
2928
|
+
* @see {@link PATCH_DomainForwardsByHostnameEnable_Response_401} - 401 response type
|
|
2929
|
+
* @see {@link PATCH_DomainForwardsByHostnameEnable_Response_403} - 403 response type
|
|
2930
|
+
* @see {@link PATCH_DomainForwardsByHostnameEnable_Response_422} - 422 response type
|
|
2931
|
+
*
|
|
2932
|
+
|
|
2933
|
+
*/
|
|
2934
|
+
export type PATCH_DomainForwardsByHostnameEnable_Response = PATCH_DomainForwardsByHostnameEnable_Response_400 | PATCH_DomainForwardsByHostnameEnable_Response_401 | PATCH_DomainForwardsByHostnameEnable_Response_403 | PATCH_DomainForwardsByHostnameEnable_Response_422;
|
|
2935
|
+
|
|
2936
|
+
/**
|
|
2937
|
+
* 400 response for PATCH DomainForwardsByHostnameEnable endpoint
|
|
2938
|
+
*
|
|
2939
|
+
* @remarks
|
|
2940
|
+
* This type defines the response structure for the 400 status code
|
|
2941
|
+
* of the PATCH DomainForwardsByHostnameEnable endpoint.
|
|
2942
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2943
|
+
*
|
|
2944
|
+
|
|
2945
|
+
*
|
|
2946
|
+
* @path /v1/domain-forwards/{hostname}/enable
|
|
2947
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2948
|
+
* @param auto_create_zone (query) - Auto create zone if it doesn't exist
|
|
2949
|
+
* @param auto_create_domain_forward (query) - Auto create domain forward if it doesn't exist
|
|
2950
|
+
* @param wildcard (query) - Wildcard domain forwarding
|
|
2951
|
+
*
|
|
2952
|
+
* @see {@link PATCH_DomainForwardsByHostnameEnable_Response} - The main response type definition
|
|
2953
|
+
* @see {@link Problem} - The actual schema type definition
|
|
2954
|
+
*/
|
|
2955
|
+
export type PATCH_DomainForwardsByHostnameEnable_Response_400 = Problem
|
|
2956
|
+
|
|
2957
|
+
/**
|
|
2958
|
+
* 401 response for PATCH DomainForwardsByHostnameEnable endpoint
|
|
2959
|
+
*
|
|
2960
|
+
* @remarks
|
|
2961
|
+
* This type defines the response structure for the 401 status code
|
|
2962
|
+
* of the PATCH DomainForwardsByHostnameEnable endpoint.
|
|
2963
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2964
|
+
*
|
|
2965
|
+
|
|
2966
|
+
*
|
|
2967
|
+
* @path /v1/domain-forwards/{hostname}/enable
|
|
2968
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2097
2969
|
* @param auto_create_zone (query) - Auto create zone if it doesn't exist
|
|
2970
|
+
* @param auto_create_domain_forward (query) - Auto create domain forward if it doesn't exist
|
|
2098
2971
|
* @param wildcard (query) - Wildcard domain forwarding
|
|
2099
2972
|
*
|
|
2100
|
-
* @see {@link
|
|
2973
|
+
* @see {@link PATCH_DomainForwardsByHostnameEnable_Response} - The main response type definition
|
|
2974
|
+
* @see {@link Problem} - The actual schema type definition
|
|
2975
|
+
*/
|
|
2976
|
+
export type PATCH_DomainForwardsByHostnameEnable_Response_401 = Problem
|
|
2977
|
+
|
|
2978
|
+
/**
|
|
2979
|
+
* 403 response for PATCH DomainForwardsByHostnameEnable endpoint
|
|
2980
|
+
*
|
|
2981
|
+
* @remarks
|
|
2982
|
+
* This type defines the response structure for the 403 status code
|
|
2983
|
+
* of the PATCH DomainForwardsByHostnameEnable endpoint.
|
|
2984
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2101
2985
|
*
|
|
2102
2986
|
|
|
2987
|
+
*
|
|
2988
|
+
* @path /v1/domain-forwards/{hostname}/enable
|
|
2989
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2990
|
+
* @param auto_create_zone (query) - Auto create zone if it doesn't exist
|
|
2991
|
+
* @param auto_create_domain_forward (query) - Auto create domain forward if it doesn't exist
|
|
2992
|
+
* @param wildcard (query) - Wildcard domain forwarding
|
|
2993
|
+
*
|
|
2994
|
+
* @see {@link PATCH_DomainForwardsByHostnameEnable_Response} - The main response type definition
|
|
2995
|
+
* @see {@link Problem} - The actual schema type definition
|
|
2103
2996
|
*/
|
|
2104
|
-
export type
|
|
2997
|
+
export type PATCH_DomainForwardsByHostnameEnable_Response_403 = Problem
|
|
2105
2998
|
|
|
2106
2999
|
/**
|
|
2107
|
-
* 422 response for PATCH
|
|
3000
|
+
* 422 response for PATCH DomainForwardsByHostnameEnable endpoint
|
|
2108
3001
|
*
|
|
2109
3002
|
* @remarks
|
|
2110
3003
|
* This type defines the response structure for the 422 status code
|
|
2111
|
-
* of the PATCH
|
|
3004
|
+
* of the PATCH DomainForwardsByHostnameEnable endpoint.
|
|
2112
3005
|
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2113
3006
|
*
|
|
2114
3007
|
|
|
2115
3008
|
*
|
|
2116
|
-
* @path /v1/domain-forwards/{
|
|
2117
|
-
* @param
|
|
3009
|
+
* @path /v1/domain-forwards/{hostname}/enable
|
|
3010
|
+
* @param hostname (path) - Hostname (trailing dot optional)
|
|
2118
3011
|
* @param auto_create_zone (query) - Auto create zone if it doesn't exist
|
|
3012
|
+
* @param auto_create_domain_forward (query) - Auto create domain forward if it doesn't exist
|
|
2119
3013
|
* @param wildcard (query) - Wildcard domain forwarding
|
|
2120
3014
|
*
|
|
2121
|
-
* @see {@link
|
|
3015
|
+
* @see {@link PATCH_DomainForwardsByHostnameEnable_Response} - The main response type definition
|
|
2122
3016
|
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
2123
3017
|
*/
|
|
2124
|
-
export type
|
|
3018
|
+
export type PATCH_DomainForwardsByHostnameEnable_Response_422 = HTTPValidationError
|
|
2125
3019
|
|
|
2126
3020
|
/**
|
|
2127
3021
|
* Response types for GET DomainSearchSuggest endpoint
|