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