@opusdns/api 0.87.0 → 0.88.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/constants.ts +74 -1
- package/src/helpers/keys.ts +527 -865
- package/src/helpers/requests.d.ts +108 -158
- package/src/helpers/responses.d.ts +101 -100
- package/src/helpers/schemas-arrays.d.ts +15 -43
- package/src/helpers/schemas.d.ts +70 -102
- package/src/openapi.yaml +180 -247
- package/src/schema.d.ts +117 -181
|
@@ -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,
|
|
37
|
+
import { Problem, HTTPValidationError, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DnsZoneSummary, DomainForward, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, Pagination_EmailForwardAlias, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, 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
|
|
@@ -1662,254 +1662,255 @@ export type GET_DnsSummary_Response = GET_DnsSummary_Response_200;
|
|
|
1662
1662
|
export type GET_DnsSummary_Response_200 = DnsZoneSummary
|
|
1663
1663
|
|
|
1664
1664
|
/**
|
|
1665
|
-
* Response types for
|
|
1665
|
+
* Response types for DELETE DomainForwardsByZoneNameByRequestProtocol endpoint
|
|
1666
1666
|
*
|
|
1667
|
-
*
|
|
1667
|
+
* Delete Domain Forward
|
|
1668
1668
|
*
|
|
1669
1669
|
* @remarks
|
|
1670
|
-
* This type defines all possible response structures for the
|
|
1670
|
+
* This type defines all possible response structures for the DELETE DomainForwardsByZoneNameByRequestProtocol endpoint.
|
|
1671
1671
|
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
1672
1672
|
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
1673
1673
|
*
|
|
1674
1674
|
|
|
1675
1675
|
*
|
|
1676
|
-
* @path /v1/domain-forwards
|
|
1676
|
+
* @path /v1/domain-forwards/{zone_name}/{request_protocol}
|
|
1677
|
+
* @param zone_name (path) - DNS zone name (trailing dot optional)
|
|
1677
1678
|
*
|
|
1678
|
-
* @see {@link
|
|
1679
|
+
* @see {@link DELETE_DomainForwardsByZoneNameByRequestProtocol_Response_422} - 422 response type
|
|
1679
1680
|
*
|
|
1680
1681
|
|
|
1681
1682
|
*/
|
|
1682
|
-
export type
|
|
1683
|
+
export type DELETE_DomainForwardsByZoneNameByRequestProtocol_Response = DELETE_DomainForwardsByZoneNameByRequestProtocol_Response_422;
|
|
1683
1684
|
|
|
1684
1685
|
/**
|
|
1685
|
-
* 422 response for
|
|
1686
|
+
* 422 response for DELETE DomainForwardsByZoneNameByRequestProtocol endpoint
|
|
1686
1687
|
*
|
|
1687
1688
|
* @remarks
|
|
1688
1689
|
* This type defines the response structure for the 422 status code
|
|
1689
|
-
* of the
|
|
1690
|
+
* of the DELETE DomainForwardsByZoneNameByRequestProtocol endpoint.
|
|
1690
1691
|
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1691
1692
|
*
|
|
1692
1693
|
|
|
1693
1694
|
*
|
|
1694
|
-
* @path /v1/domain-forwards
|
|
1695
|
+
* @path /v1/domain-forwards/{zone_name}/{request_protocol}
|
|
1696
|
+
* @param zone_name (path) - DNS zone name (trailing dot optional)
|
|
1695
1697
|
*
|
|
1696
|
-
* @see {@link
|
|
1698
|
+
* @see {@link DELETE_DomainForwardsByZoneNameByRequestProtocol_Response} - The main response type definition
|
|
1697
1699
|
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
1698
1700
|
*/
|
|
1699
|
-
export type
|
|
1701
|
+
export type DELETE_DomainForwardsByZoneNameByRequestProtocol_Response_422 = HTTPValidationError
|
|
1700
1702
|
|
|
1701
1703
|
/**
|
|
1702
|
-
* Response types for
|
|
1704
|
+
* Response types for GET DomainForwardsByZoneNameByRequestProtocol endpoint
|
|
1703
1705
|
*
|
|
1704
|
-
*
|
|
1706
|
+
* Get Domain Forward
|
|
1705
1707
|
*
|
|
1706
1708
|
* @remarks
|
|
1707
|
-
* This type defines all possible response structures for the
|
|
1709
|
+
* This type defines all possible response structures for the GET DomainForwardsByZoneNameByRequestProtocol endpoint.
|
|
1708
1710
|
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
1709
1711
|
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
1710
1712
|
*
|
|
1711
1713
|
|
|
1712
1714
|
*
|
|
1713
|
-
* @path /v1/domain-forwards/{zone_name}
|
|
1715
|
+
* @path /v1/domain-forwards/{zone_name}/{request_protocol}
|
|
1714
1716
|
* @param zone_name (path) - DNS zone name (trailing dot optional)
|
|
1715
1717
|
*
|
|
1716
|
-
* @see {@link
|
|
1718
|
+
* @see {@link GET_DomainForwardsByZoneNameByRequestProtocol_Response_200} - 200 response type
|
|
1719
|
+
* @see {@link GET_DomainForwardsByZoneNameByRequestProtocol_Response_422} - 422 response type
|
|
1717
1720
|
*
|
|
1718
1721
|
|
|
1719
1722
|
*/
|
|
1720
|
-
export type
|
|
1723
|
+
export type GET_DomainForwardsByZoneNameByRequestProtocol_Response = GET_DomainForwardsByZoneNameByRequestProtocol_Response_200 | GET_DomainForwardsByZoneNameByRequestProtocol_Response_422;
|
|
1721
1724
|
|
|
1722
1725
|
/**
|
|
1723
|
-
*
|
|
1726
|
+
* 200 response for GET DomainForwardsByZoneNameByRequestProtocol endpoint
|
|
1724
1727
|
*
|
|
1725
1728
|
* @remarks
|
|
1726
|
-
* This type defines the response structure for the
|
|
1727
|
-
* of the
|
|
1729
|
+
* This type defines the response structure for the 200 status code
|
|
1730
|
+
* of the GET DomainForwardsByZoneNameByRequestProtocol endpoint.
|
|
1728
1731
|
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1729
1732
|
*
|
|
1730
1733
|
|
|
1731
1734
|
*
|
|
1732
|
-
* @path /v1/domain-forwards/{zone_name}
|
|
1735
|
+
* @path /v1/domain-forwards/{zone_name}/{request_protocol}
|
|
1733
1736
|
* @param zone_name (path) - DNS zone name (trailing dot optional)
|
|
1734
1737
|
*
|
|
1735
|
-
* @see {@link
|
|
1736
|
-
* @see {@link
|
|
1738
|
+
* @see {@link GET_DomainForwardsByZoneNameByRequestProtocol_Response} - The main response type definition
|
|
1739
|
+
* @see {@link DomainForward} - The actual schema type definition
|
|
1737
1740
|
*/
|
|
1738
|
-
export type
|
|
1741
|
+
export type GET_DomainForwardsByZoneNameByRequestProtocol_Response_200 = DomainForward
|
|
1739
1742
|
|
|
1740
1743
|
/**
|
|
1741
|
-
*
|
|
1742
|
-
*
|
|
1743
|
-
* Get Redirects
|
|
1744
|
+
* 422 response for GET DomainForwardsByZoneNameByRequestProtocol endpoint
|
|
1744
1745
|
*
|
|
1745
1746
|
* @remarks
|
|
1746
|
-
* This type defines
|
|
1747
|
-
*
|
|
1748
|
-
*
|
|
1747
|
+
* This type defines the response structure for the 422 status code
|
|
1748
|
+
* of the GET DomainForwardsByZoneNameByRequestProtocol endpoint.
|
|
1749
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1749
1750
|
*
|
|
1750
1751
|
|
|
1751
1752
|
*
|
|
1752
|
-
* @path /v1/domain-forwards/{zone_name}
|
|
1753
|
+
* @path /v1/domain-forwards/{zone_name}/{request_protocol}
|
|
1753
1754
|
* @param zone_name (path) - DNS zone name (trailing dot optional)
|
|
1754
1755
|
*
|
|
1755
|
-
* @see {@link
|
|
1756
|
-
* @see {@link
|
|
1757
|
-
*
|
|
1758
|
-
|
|
1756
|
+
* @see {@link GET_DomainForwardsByZoneNameByRequestProtocol_Response} - The main response type definition
|
|
1757
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
1759
1758
|
*/
|
|
1760
|
-
export type
|
|
1759
|
+
export type GET_DomainForwardsByZoneNameByRequestProtocol_Response_422 = HTTPValidationError
|
|
1761
1760
|
|
|
1762
1761
|
/**
|
|
1763
|
-
*
|
|
1762
|
+
* Response types for POST DomainForwardsByZoneNameByRequestProtocol endpoint
|
|
1763
|
+
*
|
|
1764
|
+
* Create Domain Forward
|
|
1764
1765
|
*
|
|
1765
1766
|
* @remarks
|
|
1766
|
-
* This type defines
|
|
1767
|
-
*
|
|
1768
|
-
*
|
|
1767
|
+
* This type defines all possible response structures for the POST DomainForwardsByZoneNameByRequestProtocol endpoint.
|
|
1768
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
1769
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
1769
1770
|
*
|
|
1770
1771
|
|
|
1771
1772
|
*
|
|
1772
|
-
* @path /v1/domain-forwards/{zone_name}
|
|
1773
|
+
* @path /v1/domain-forwards/{zone_name}/{request_protocol}
|
|
1773
1774
|
* @param zone_name (path) - DNS zone name (trailing dot optional)
|
|
1774
1775
|
*
|
|
1775
|
-
* @see {@link
|
|
1776
|
-
* @see {@link
|
|
1777
|
-
|
|
1778
|
-
export type GET_DomainForwardsByZoneName_Response_200 = Pagination_Redirect
|
|
1779
|
-
|
|
1780
|
-
/**
|
|
1781
|
-
* 422 response for GET DomainForwardsByZoneName endpoint
|
|
1782
|
-
*
|
|
1783
|
-
* @remarks
|
|
1784
|
-
* This type defines the response structure for the 422 status code
|
|
1785
|
-
* of the GET DomainForwardsByZoneName endpoint.
|
|
1786
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1776
|
+
* @see {@link POST_DomainForwardsByZoneNameByRequestProtocol_Response_201} - 201 response type
|
|
1777
|
+
* @see {@link POST_DomainForwardsByZoneNameByRequestProtocol_Response_409} - 409 response type
|
|
1778
|
+
* @see {@link POST_DomainForwardsByZoneNameByRequestProtocol_Response_422} - 422 response type
|
|
1787
1779
|
*
|
|
1788
1780
|
|
|
1789
|
-
*
|
|
1790
|
-
* @path /v1/domain-forwards/{zone_name}
|
|
1791
|
-
* @param zone_name (path) - DNS zone name (trailing dot optional)
|
|
1792
|
-
*
|
|
1793
|
-
* @see {@link GET_DomainForwardsByZoneName_Response} - The main response type definition
|
|
1794
|
-
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
1795
1781
|
*/
|
|
1796
|
-
export type
|
|
1782
|
+
export type POST_DomainForwardsByZoneNameByRequestProtocol_Response = POST_DomainForwardsByZoneNameByRequestProtocol_Response_201 | POST_DomainForwardsByZoneNameByRequestProtocol_Response_409 | POST_DomainForwardsByZoneNameByRequestProtocol_Response_422;
|
|
1797
1783
|
|
|
1798
1784
|
/**
|
|
1799
|
-
*
|
|
1800
|
-
*
|
|
1801
|
-
* Create Redirects
|
|
1785
|
+
* 201 response for POST DomainForwardsByZoneNameByRequestProtocol endpoint
|
|
1802
1786
|
*
|
|
1803
1787
|
* @remarks
|
|
1804
|
-
* This type defines
|
|
1805
|
-
*
|
|
1806
|
-
*
|
|
1788
|
+
* This type defines the response structure for the 201 status code
|
|
1789
|
+
* of the POST DomainForwardsByZoneNameByRequestProtocol endpoint.
|
|
1790
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1807
1791
|
*
|
|
1808
1792
|
|
|
1809
1793
|
*
|
|
1810
|
-
* @path /v1/domain-forwards/{zone_name}
|
|
1794
|
+
* @path /v1/domain-forwards/{zone_name}/{request_protocol}
|
|
1811
1795
|
* @param zone_name (path) - DNS zone name (trailing dot optional)
|
|
1812
1796
|
*
|
|
1813
|
-
* @see {@link
|
|
1814
|
-
* @see {@link
|
|
1815
|
-
*
|
|
1816
|
-
|
|
1797
|
+
* @see {@link POST_DomainForwardsByZoneNameByRequestProtocol_Response} - The main response type definition
|
|
1798
|
+
* @see {@link DomainForward} - The actual schema type definition
|
|
1817
1799
|
*/
|
|
1818
|
-
export type
|
|
1800
|
+
export type POST_DomainForwardsByZoneNameByRequestProtocol_Response_201 = DomainForward
|
|
1819
1801
|
|
|
1820
1802
|
/**
|
|
1821
|
-
* 409 response for POST
|
|
1803
|
+
* 409 response for POST DomainForwardsByZoneNameByRequestProtocol endpoint
|
|
1822
1804
|
*
|
|
1823
1805
|
* @remarks
|
|
1824
1806
|
* This type defines the response structure for the 409 status code
|
|
1825
|
-
* of the POST
|
|
1807
|
+
* of the POST DomainForwardsByZoneNameByRequestProtocol endpoint.
|
|
1826
1808
|
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1827
1809
|
*
|
|
1828
1810
|
|
|
1829
1811
|
*
|
|
1830
|
-
* @path /v1/domain-forwards/{zone_name}
|
|
1812
|
+
* @path /v1/domain-forwards/{zone_name}/{request_protocol}
|
|
1831
1813
|
* @param zone_name (path) - DNS zone name (trailing dot optional)
|
|
1832
1814
|
*
|
|
1833
|
-
* @see {@link
|
|
1815
|
+
* @see {@link POST_DomainForwardsByZoneNameByRequestProtocol_Response} - The main response type definition
|
|
1834
1816
|
* @see {@link Problem} - The actual schema type definition
|
|
1835
1817
|
*/
|
|
1836
|
-
export type
|
|
1818
|
+
export type POST_DomainForwardsByZoneNameByRequestProtocol_Response_409 = Problem
|
|
1837
1819
|
|
|
1838
1820
|
/**
|
|
1839
|
-
* 422 response for POST
|
|
1821
|
+
* 422 response for POST DomainForwardsByZoneNameByRequestProtocol endpoint
|
|
1840
1822
|
*
|
|
1841
1823
|
* @remarks
|
|
1842
1824
|
* This type defines the response structure for the 422 status code
|
|
1843
|
-
* of the POST
|
|
1825
|
+
* of the POST DomainForwardsByZoneNameByRequestProtocol endpoint.
|
|
1844
1826
|
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1845
1827
|
*
|
|
1846
1828
|
|
|
1847
1829
|
*
|
|
1848
|
-
* @path /v1/domain-forwards/{zone_name}
|
|
1830
|
+
* @path /v1/domain-forwards/{zone_name}/{request_protocol}
|
|
1849
1831
|
* @param zone_name (path) - DNS zone name (trailing dot optional)
|
|
1850
1832
|
*
|
|
1851
|
-
* @see {@link
|
|
1833
|
+
* @see {@link POST_DomainForwardsByZoneNameByRequestProtocol_Response} - The main response type definition
|
|
1852
1834
|
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
1853
1835
|
*/
|
|
1854
|
-
export type
|
|
1836
|
+
export type POST_DomainForwardsByZoneNameByRequestProtocol_Response_422 = HTTPValidationError
|
|
1855
1837
|
|
|
1856
1838
|
/**
|
|
1857
|
-
* Response types for PUT
|
|
1839
|
+
* Response types for PUT DomainForwardsByZoneNameByRequestProtocol endpoint
|
|
1858
1840
|
*
|
|
1859
|
-
* Update
|
|
1841
|
+
* Update Domain Forward
|
|
1860
1842
|
*
|
|
1861
1843
|
* @remarks
|
|
1862
|
-
* This type defines all possible response structures for the PUT
|
|
1844
|
+
* This type defines all possible response structures for the PUT DomainForwardsByZoneNameByRequestProtocol endpoint.
|
|
1863
1845
|
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
1864
1846
|
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
1865
1847
|
*
|
|
1866
1848
|
|
|
1867
1849
|
*
|
|
1868
|
-
* @path /v1/domain-forwards/{zone_name}
|
|
1850
|
+
* @path /v1/domain-forwards/{zone_name}/{request_protocol}
|
|
1869
1851
|
* @param zone_name (path) - DNS zone name (trailing dot optional)
|
|
1870
1852
|
*
|
|
1871
|
-
* @see {@link
|
|
1872
|
-
* @see {@link
|
|
1853
|
+
* @see {@link PUT_DomainForwardsByZoneNameByRequestProtocol_Response_200} - 200 response type
|
|
1854
|
+
* @see {@link PUT_DomainForwardsByZoneNameByRequestProtocol_Response_409} - 409 response type
|
|
1855
|
+
* @see {@link PUT_DomainForwardsByZoneNameByRequestProtocol_Response_422} - 422 response type
|
|
1873
1856
|
*
|
|
1874
1857
|
|
|
1875
1858
|
*/
|
|
1876
|
-
export type
|
|
1859
|
+
export type PUT_DomainForwardsByZoneNameByRequestProtocol_Response = PUT_DomainForwardsByZoneNameByRequestProtocol_Response_200 | PUT_DomainForwardsByZoneNameByRequestProtocol_Response_409 | PUT_DomainForwardsByZoneNameByRequestProtocol_Response_422;
|
|
1860
|
+
|
|
1861
|
+
/**
|
|
1862
|
+
* 200 response for PUT DomainForwardsByZoneNameByRequestProtocol endpoint
|
|
1863
|
+
*
|
|
1864
|
+
* @remarks
|
|
1865
|
+
* This type defines the response structure for the 200 status code
|
|
1866
|
+
* of the PUT DomainForwardsByZoneNameByRequestProtocol endpoint.
|
|
1867
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1868
|
+
*
|
|
1869
|
+
|
|
1870
|
+
*
|
|
1871
|
+
* @path /v1/domain-forwards/{zone_name}/{request_protocol}
|
|
1872
|
+
* @param zone_name (path) - DNS zone name (trailing dot optional)
|
|
1873
|
+
*
|
|
1874
|
+
* @see {@link PUT_DomainForwardsByZoneNameByRequestProtocol_Response} - The main response type definition
|
|
1875
|
+
* @see {@link DomainForward} - The actual schema type definition
|
|
1876
|
+
*/
|
|
1877
|
+
export type PUT_DomainForwardsByZoneNameByRequestProtocol_Response_200 = DomainForward
|
|
1877
1878
|
|
|
1878
1879
|
/**
|
|
1879
|
-
* 409 response for PUT
|
|
1880
|
+
* 409 response for PUT DomainForwardsByZoneNameByRequestProtocol endpoint
|
|
1880
1881
|
*
|
|
1881
1882
|
* @remarks
|
|
1882
1883
|
* This type defines the response structure for the 409 status code
|
|
1883
|
-
* of the PUT
|
|
1884
|
+
* of the PUT DomainForwardsByZoneNameByRequestProtocol endpoint.
|
|
1884
1885
|
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1885
1886
|
*
|
|
1886
1887
|
|
|
1887
1888
|
*
|
|
1888
|
-
* @path /v1/domain-forwards/{zone_name}
|
|
1889
|
+
* @path /v1/domain-forwards/{zone_name}/{request_protocol}
|
|
1889
1890
|
* @param zone_name (path) - DNS zone name (trailing dot optional)
|
|
1890
1891
|
*
|
|
1891
|
-
* @see {@link
|
|
1892
|
+
* @see {@link PUT_DomainForwardsByZoneNameByRequestProtocol_Response} - The main response type definition
|
|
1892
1893
|
* @see {@link Problem} - The actual schema type definition
|
|
1893
1894
|
*/
|
|
1894
|
-
export type
|
|
1895
|
+
export type PUT_DomainForwardsByZoneNameByRequestProtocol_Response_409 = Problem
|
|
1895
1896
|
|
|
1896
1897
|
/**
|
|
1897
|
-
* 422 response for PUT
|
|
1898
|
+
* 422 response for PUT DomainForwardsByZoneNameByRequestProtocol endpoint
|
|
1898
1899
|
*
|
|
1899
1900
|
* @remarks
|
|
1900
1901
|
* This type defines the response structure for the 422 status code
|
|
1901
|
-
* of the PUT
|
|
1902
|
+
* of the PUT DomainForwardsByZoneNameByRequestProtocol endpoint.
|
|
1902
1903
|
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
1903
1904
|
*
|
|
1904
1905
|
|
|
1905
1906
|
*
|
|
1906
|
-
* @path /v1/domain-forwards/{zone_name}
|
|
1907
|
+
* @path /v1/domain-forwards/{zone_name}/{request_protocol}
|
|
1907
1908
|
* @param zone_name (path) - DNS zone name (trailing dot optional)
|
|
1908
1909
|
*
|
|
1909
|
-
* @see {@link
|
|
1910
|
+
* @see {@link PUT_DomainForwardsByZoneNameByRequestProtocol_Response} - The main response type definition
|
|
1910
1911
|
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
1911
1912
|
*/
|
|
1912
|
-
export type
|
|
1913
|
+
export type PUT_DomainForwardsByZoneNameByRequestProtocol_Response_422 = HTTPValidationError
|
|
1913
1914
|
|
|
1914
1915
|
/**
|
|
1915
1916
|
* Response types for PATCH DomainForwardsByZoneNameDisable endpoint
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
* This file is auto-generated from the OpenAPI specification.
|
|
22
22
|
* Do not edit manually.
|
|
23
23
|
*/
|
|
24
|
-
import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, RegistryHandleAttributeType, ContactAttributeDefinition, ContactRoleAttributeRequirement, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, DeletePolicyType, SyncOperationType, DomainContact, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, Domain, EmailForwardAlias, EventResponse, Organization,
|
|
24
|
+
import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, RegistryHandleAttributeType, ContactAttributeDefinition, ContactRoleAttributeRequirement, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, HttpRedirect, DeletePolicyType, SyncOperationType, DomainContact, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, Domain, EmailForwardAlias, EventResponse, Organization, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* DomainDnssecDataResponse
|
|
@@ -317,6 +317,20 @@ export type ContactHandleArray = ContactHandle[];
|
|
|
317
317
|
* @see {@link Nameserver} - The individual Nameserver type definition
|
|
318
318
|
*/
|
|
319
319
|
export type NameserverArray = Nameserver[];
|
|
320
|
+
/**
|
|
321
|
+
* HttpRedirect
|
|
322
|
+
*
|
|
323
|
+
* @remarks
|
|
324
|
+
* Array type for HttpRedirect objects. Used when the API returns a collection of HttpRedirect instances.
|
|
325
|
+
*
|
|
326
|
+
* @example
|
|
327
|
+
* ```typescript
|
|
328
|
+
* const items: HttpRedirectArray = await api.getHttpRedirects();
|
|
329
|
+
* ```
|
|
330
|
+
*
|
|
331
|
+
* @see {@link HttpRedirect} - The individual HttpRedirect type definition
|
|
332
|
+
*/
|
|
333
|
+
export type HttpRedirectArray = HttpRedirect[];
|
|
320
334
|
/**
|
|
321
335
|
* DeletePolicyType
|
|
322
336
|
*
|
|
@@ -625,20 +639,6 @@ export type EventResponseArray = EventResponse[];
|
|
|
625
639
|
* @see {@link Organization} - The individual Organization type definition
|
|
626
640
|
*/
|
|
627
641
|
export type OrganizationArray = Organization[];
|
|
628
|
-
/**
|
|
629
|
-
* Redirect
|
|
630
|
-
*
|
|
631
|
-
* @remarks
|
|
632
|
-
* Array type for Redirect objects. Used when the API returns a collection of Redirect instances.
|
|
633
|
-
*
|
|
634
|
-
* @example
|
|
635
|
-
* ```typescript
|
|
636
|
-
* const items: RedirectArray = await api.getRedirects();
|
|
637
|
-
* ```
|
|
638
|
-
*
|
|
639
|
-
* @see {@link Redirect} - The individual Redirect type definition
|
|
640
|
-
*/
|
|
641
|
-
export type RedirectArray = Redirect[];
|
|
642
642
|
/**
|
|
643
643
|
* Period
|
|
644
644
|
*
|
|
@@ -681,34 +681,6 @@ export type PermissionArray = Permission[];
|
|
|
681
681
|
* @see {@link PremiumAffectsType} - The individual PremiumAffectsType type definition
|
|
682
682
|
*/
|
|
683
683
|
export type PremiumAffectsTypeArray = PremiumAffectsType[];
|
|
684
|
-
/**
|
|
685
|
-
* RedirectPatchOp
|
|
686
|
-
*
|
|
687
|
-
* @remarks
|
|
688
|
-
* Array type for RedirectPatchOp objects. Used when the API returns a collection of RedirectPatchOp instances.
|
|
689
|
-
*
|
|
690
|
-
* @example
|
|
691
|
-
* ```typescript
|
|
692
|
-
* const items: RedirectPatchOpArray = await api.getRedirectPatchOps();
|
|
693
|
-
* ```
|
|
694
|
-
*
|
|
695
|
-
* @see {@link RedirectPatchOp} - The individual RedirectPatchOp type definition
|
|
696
|
-
*/
|
|
697
|
-
export type RedirectPatchOpArray = RedirectPatchOp[];
|
|
698
|
-
/**
|
|
699
|
-
* RedirectUpdate
|
|
700
|
-
*
|
|
701
|
-
* @remarks
|
|
702
|
-
* Array type for RedirectUpdate objects. Used when the API returns a collection of RedirectUpdate instances.
|
|
703
|
-
*
|
|
704
|
-
* @example
|
|
705
|
-
* ```typescript
|
|
706
|
-
* const items: RedirectUpdateArray = await api.getRedirectUpdates();
|
|
707
|
-
* ```
|
|
708
|
-
*
|
|
709
|
-
* @see {@link RedirectUpdate} - The individual RedirectUpdate type definition
|
|
710
|
-
*/
|
|
711
|
-
export type RedirectUpdateArray = RedirectUpdate[];
|
|
712
684
|
/**
|
|
713
685
|
* Relation
|
|
714
686
|
*
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -1018,6 +1018,38 @@ export type DomainDnssecDataCreate = components['schemas']['DomainDnssecDataCrea
|
|
|
1018
1018
|
* @see {@link components} - The OpenAPI components schema definition
|
|
1019
1019
|
*/
|
|
1020
1020
|
export type DomainDnssecData = components['schemas']['DomainDnssecDataResponse'];
|
|
1021
|
+
/**
|
|
1022
|
+
* DomainForward
|
|
1023
|
+
*
|
|
1024
|
+
* @remarks
|
|
1025
|
+
* Type alias for the `DomainForward` OpenAPI schema.
|
|
1026
|
+
* This type represents domainforward data structures used in API requests and responses.
|
|
1027
|
+
*
|
|
1028
|
+
* @example
|
|
1029
|
+
* ```typescript
|
|
1030
|
+
* const response = await api.getDomainForward();
|
|
1031
|
+
* const item: DomainForward = response.results;
|
|
1032
|
+
* ```
|
|
1033
|
+
*
|
|
1034
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1035
|
+
*/
|
|
1036
|
+
export type DomainForward = components['schemas']['DomainForward'];
|
|
1037
|
+
/**
|
|
1038
|
+
* DomainForwardRequest
|
|
1039
|
+
*
|
|
1040
|
+
* @remarks
|
|
1041
|
+
* Type alias for the `DomainForwardRequest` OpenAPI schema.
|
|
1042
|
+
* This type represents domainforwardrequest data structures used in API requests and responses.
|
|
1043
|
+
*
|
|
1044
|
+
* @example
|
|
1045
|
+
* ```typescript
|
|
1046
|
+
* const response = await api.getDomainForwardRequest();
|
|
1047
|
+
* const item: DomainForwardRequest = response.results;
|
|
1048
|
+
* ```
|
|
1049
|
+
*
|
|
1050
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1051
|
+
*/
|
|
1052
|
+
export type DomainForwardRequest = components['schemas']['DomainForwardRequest'];
|
|
1021
1053
|
/**
|
|
1022
1054
|
* DomainLifecycleBase
|
|
1023
1055
|
*
|
|
@@ -1562,6 +1594,38 @@ export type GrantType = components['schemas']['GrantType'];
|
|
|
1562
1594
|
* @see {@link components} - The OpenAPI components schema definition
|
|
1563
1595
|
*/
|
|
1564
1596
|
export type HTTPValidationError = components['schemas']['HTTPValidationError'];
|
|
1597
|
+
/**
|
|
1598
|
+
* HttpProtocol
|
|
1599
|
+
*
|
|
1600
|
+
* @remarks
|
|
1601
|
+
* Type alias for the `HttpProtocol` OpenAPI schema.
|
|
1602
|
+
* This type represents httpprotocol data structures used in API requests and responses.
|
|
1603
|
+
*
|
|
1604
|
+
* @example
|
|
1605
|
+
* ```typescript
|
|
1606
|
+
* const response = await api.getHttpProtocol();
|
|
1607
|
+
* const item: HttpProtocol = response.results;
|
|
1608
|
+
* ```
|
|
1609
|
+
*
|
|
1610
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1611
|
+
*/
|
|
1612
|
+
export type HttpProtocol = components['schemas']['HttpProtocol'];
|
|
1613
|
+
/**
|
|
1614
|
+
* HttpRedirect
|
|
1615
|
+
*
|
|
1616
|
+
* @remarks
|
|
1617
|
+
* Type alias for the `HttpRedirect` OpenAPI schema.
|
|
1618
|
+
* This type represents httpredirect data structures used in API requests and responses.
|
|
1619
|
+
*
|
|
1620
|
+
* @example
|
|
1621
|
+
* ```typescript
|
|
1622
|
+
* const response = await api.getHttpRedirect();
|
|
1623
|
+
* const item: HttpRedirect = response.results;
|
|
1624
|
+
* ```
|
|
1625
|
+
*
|
|
1626
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1627
|
+
*/
|
|
1628
|
+
export type HttpRedirect = components['schemas']['HttpRedirect'];
|
|
1565
1629
|
/**
|
|
1566
1630
|
* IdnBase
|
|
1567
1631
|
*
|
|
@@ -2031,22 +2095,6 @@ export type Pagination_Event = components['schemas']['Pagination_EventResponse_'
|
|
|
2031
2095
|
* @see {@link components} - The OpenAPI components schema definition
|
|
2032
2096
|
*/
|
|
2033
2097
|
export type Pagination_Organization = components['schemas']['Pagination_Organization_'];
|
|
2034
|
-
/**
|
|
2035
|
-
* Pagination[Redirect]
|
|
2036
|
-
*
|
|
2037
|
-
* @remarks
|
|
2038
|
-
* Type alias for the `Pagination_Redirect_` OpenAPI schema.
|
|
2039
|
-
* This type represents pagination[redirect] data structures used in API requests and responses.
|
|
2040
|
-
*
|
|
2041
|
-
* @example
|
|
2042
|
-
* ```typescript
|
|
2043
|
-
* const response = await api.getPagination_Redirect();
|
|
2044
|
-
* const item: Pagination_Redirect = response.results;
|
|
2045
|
-
* ```
|
|
2046
|
-
*
|
|
2047
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
2048
|
-
*/
|
|
2049
|
-
export type Pagination_Redirect = components['schemas']['Pagination_Redirect_'];
|
|
2050
2098
|
/**
|
|
2051
2099
|
* Pagination[User]
|
|
2052
2100
|
*
|
|
@@ -2336,101 +2384,21 @@ export type PublicAuthRequestForm = components['schemas']['PublicAuthRequestForm
|
|
|
2336
2384
|
*/
|
|
2337
2385
|
export type RdapBase = components['schemas']['RdapBase'];
|
|
2338
2386
|
/**
|
|
2339
|
-
*
|
|
2340
|
-
*
|
|
2341
|
-
* @remarks
|
|
2342
|
-
* Type alias for the `Redirect` OpenAPI schema.
|
|
2343
|
-
* This type represents redirect data structures used in API requests and responses.
|
|
2344
|
-
*
|
|
2345
|
-
* @example
|
|
2346
|
-
* ```typescript
|
|
2347
|
-
* const response = await api.getRedirect();
|
|
2348
|
-
* const item: Redirect = response.results;
|
|
2349
|
-
* ```
|
|
2350
|
-
*
|
|
2351
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
2352
|
-
*/
|
|
2353
|
-
export type Redirect = components['schemas']['Redirect'];
|
|
2354
|
-
/**
|
|
2355
|
-
* RedirectPatchOp
|
|
2356
|
-
*
|
|
2357
|
-
* @remarks
|
|
2358
|
-
* Type alias for the `RedirectPatchOp` OpenAPI schema.
|
|
2359
|
-
* This type represents redirectpatchop data structures used in API requests and responses.
|
|
2360
|
-
*
|
|
2361
|
-
* @example
|
|
2362
|
-
* ```typescript
|
|
2363
|
-
* const response = await api.getRedirectPatchOp();
|
|
2364
|
-
* const item: RedirectPatchOp = response.results;
|
|
2365
|
-
* ```
|
|
2366
|
-
*
|
|
2367
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
2368
|
-
*/
|
|
2369
|
-
export type RedirectPatchOp = components['schemas']['RedirectPatchOp'];
|
|
2370
|
-
/**
|
|
2371
|
-
* RedirectPatchOps
|
|
2372
|
-
*
|
|
2373
|
-
* @remarks
|
|
2374
|
-
* Type alias for the `RedirectPatchOps` OpenAPI schema.
|
|
2375
|
-
* This type represents redirectpatchops data structures used in API requests and responses.
|
|
2376
|
-
*
|
|
2377
|
-
* @example
|
|
2378
|
-
* ```typescript
|
|
2379
|
-
* const response = await api.getRedirectPatchOps();
|
|
2380
|
-
* const item: RedirectPatchOps = response.results;
|
|
2381
|
-
* ```
|
|
2382
|
-
*
|
|
2383
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
2384
|
-
*/
|
|
2385
|
-
export type RedirectPatchOps = components['schemas']['RedirectPatchOps'];
|
|
2386
|
-
/**
|
|
2387
|
-
* RedirectRemove
|
|
2388
|
-
*
|
|
2389
|
-
* @remarks
|
|
2390
|
-
* Type alias for the `RedirectRemove` OpenAPI schema.
|
|
2391
|
-
* This type represents redirectremove data structures used in API requests and responses.
|
|
2392
|
-
*
|
|
2393
|
-
* @example
|
|
2394
|
-
* ```typescript
|
|
2395
|
-
* const response = await api.getRedirectRemove();
|
|
2396
|
-
* const item: RedirectRemove = response.results;
|
|
2397
|
-
* ```
|
|
2398
|
-
*
|
|
2399
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
2400
|
-
*/
|
|
2401
|
-
export type RedirectRemove = components['schemas']['RedirectRemove'];
|
|
2402
|
-
/**
|
|
2403
|
-
* RedirectSet
|
|
2404
|
-
*
|
|
2405
|
-
* @remarks
|
|
2406
|
-
* Type alias for the `RedirectSet` OpenAPI schema.
|
|
2407
|
-
* This type represents redirectset data structures used in API requests and responses.
|
|
2408
|
-
*
|
|
2409
|
-
* @example
|
|
2410
|
-
* ```typescript
|
|
2411
|
-
* const response = await api.getRedirectSet();
|
|
2412
|
-
* const item: RedirectSet = response.results;
|
|
2413
|
-
* ```
|
|
2414
|
-
*
|
|
2415
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
2416
|
-
*/
|
|
2417
|
-
export type RedirectSet = components['schemas']['RedirectSet'];
|
|
2418
|
-
/**
|
|
2419
|
-
* RedirectUpdate
|
|
2387
|
+
* RedirectCode
|
|
2420
2388
|
*
|
|
2421
2389
|
* @remarks
|
|
2422
|
-
* Type alias for the `
|
|
2423
|
-
* This type represents
|
|
2390
|
+
* Type alias for the `RedirectCode` OpenAPI schema.
|
|
2391
|
+
* This type represents redirectcode data structures used in API requests and responses.
|
|
2424
2392
|
*
|
|
2425
2393
|
* @example
|
|
2426
2394
|
* ```typescript
|
|
2427
|
-
* const response = await api.
|
|
2428
|
-
* const item:
|
|
2395
|
+
* const response = await api.getRedirectCode();
|
|
2396
|
+
* const item: RedirectCode = response.results;
|
|
2429
2397
|
* ```
|
|
2430
2398
|
*
|
|
2431
2399
|
* @see {@link components} - The OpenAPI components schema definition
|
|
2432
2400
|
*/
|
|
2433
|
-
export type
|
|
2401
|
+
export type RedirectCode = components['schemas']['RedirectCode'];
|
|
2434
2402
|
/**
|
|
2435
2403
|
* RegistrantChangeType
|
|
2436
2404
|
*
|