@opusdns/api 0.112.0 → 0.113.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 { Pagination_ObjectLog, HTTPValidationError, Pagination_RequestHistory, Problem, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, Pagination_DomainForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, 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 { Pagination_ObjectLog, HTTPValidationError, Pagination_RequestHistory, Problem, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, EmailForwardZone, Pagination_DomainForwardZone, Pagination_EmailForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, Pagination_EmailForward, EmailForward, 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 GET ArchiveObjectLogs endpoint
@@ -1753,6 +1753,103 @@ export type GET_DnsByZoneNameDomainForwards_Response_403 = Problem
1753
1753
  */
1754
1754
  export type GET_DnsByZoneNameDomainForwards_Response_422 = HTTPValidationError
1755
1755
 
1756
+ /**
1757
+ * Response types for GET DnsByZoneNameEmailForwards endpoint
1758
+ *
1759
+ * List email forwards for a zone
1760
+ * Retrieves all email forwards configured for the specified DNS zone, including subdomains and all aliases.
1761
+ *
1762
+ * @remarks
1763
+ * This type defines all possible response structures for the GET DnsByZoneNameEmailForwards endpoint.
1764
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
1765
+ * Use this type to ensure type safety when handling API responses from this endpoint.
1766
+ *
1767
+
1768
+ *
1769
+ * @path /v1/dns/{zone_name}/email-forwards
1770
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1771
+ *
1772
+ * @see {@link GET_DnsByZoneNameEmailForwards_Response_200} - 200 response type
1773
+ * @see {@link GET_DnsByZoneNameEmailForwards_Response_401} - 401 response type
1774
+ * @see {@link GET_DnsByZoneNameEmailForwards_Response_403} - 403 response type
1775
+ * @see {@link GET_DnsByZoneNameEmailForwards_Response_422} - 422 response type
1776
+ *
1777
+
1778
+ */
1779
+ export type GET_DnsByZoneNameEmailForwards_Response = GET_DnsByZoneNameEmailForwards_Response_200 | GET_DnsByZoneNameEmailForwards_Response_401 | GET_DnsByZoneNameEmailForwards_Response_403 | GET_DnsByZoneNameEmailForwards_Response_422;
1780
+
1781
+ /**
1782
+ * 200 response for GET DnsByZoneNameEmailForwards endpoint
1783
+ *
1784
+ * @remarks
1785
+ * This type defines the response structure for the 200 status code
1786
+ * of the GET DnsByZoneNameEmailForwards endpoint.
1787
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
1788
+ *
1789
+
1790
+ *
1791
+ * @path /v1/dns/{zone_name}/email-forwards
1792
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1793
+ *
1794
+ * @see {@link GET_DnsByZoneNameEmailForwards_Response} - The main response type definition
1795
+ * @see {@link EmailForwardZone} - The actual schema type definition
1796
+ */
1797
+ export type GET_DnsByZoneNameEmailForwards_Response_200 = EmailForwardZone
1798
+
1799
+ /**
1800
+ * 401 response for GET DnsByZoneNameEmailForwards endpoint
1801
+ *
1802
+ * @remarks
1803
+ * This type defines the response structure for the 401 status code
1804
+ * of the GET DnsByZoneNameEmailForwards endpoint.
1805
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
1806
+ *
1807
+
1808
+ *
1809
+ * @path /v1/dns/{zone_name}/email-forwards
1810
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1811
+ *
1812
+ * @see {@link GET_DnsByZoneNameEmailForwards_Response} - The main response type definition
1813
+ * @see {@link Problem} - The actual schema type definition
1814
+ */
1815
+ export type GET_DnsByZoneNameEmailForwards_Response_401 = Problem
1816
+
1817
+ /**
1818
+ * 403 response for GET DnsByZoneNameEmailForwards endpoint
1819
+ *
1820
+ * @remarks
1821
+ * This type defines the response structure for the 403 status code
1822
+ * of the GET DnsByZoneNameEmailForwards endpoint.
1823
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
1824
+ *
1825
+
1826
+ *
1827
+ * @path /v1/dns/{zone_name}/email-forwards
1828
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1829
+ *
1830
+ * @see {@link GET_DnsByZoneNameEmailForwards_Response} - The main response type definition
1831
+ * @see {@link Problem} - The actual schema type definition
1832
+ */
1833
+ export type GET_DnsByZoneNameEmailForwards_Response_403 = Problem
1834
+
1835
+ /**
1836
+ * 422 response for GET DnsByZoneNameEmailForwards endpoint
1837
+ *
1838
+ * @remarks
1839
+ * This type defines the response structure for the 422 status code
1840
+ * of the GET DnsByZoneNameEmailForwards endpoint.
1841
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
1842
+ *
1843
+
1844
+ *
1845
+ * @path /v1/dns/{zone_name}/email-forwards
1846
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1847
+ *
1848
+ * @see {@link GET_DnsByZoneNameEmailForwards_Response} - The main response type definition
1849
+ * @see {@link HTTPValidationError} - The actual schema type definition
1850
+ */
1851
+ export type GET_DnsByZoneNameEmailForwards_Response_422 = HTTPValidationError
1852
+
1756
1853
  /**
1757
1854
  * Response types for PATCH DnsByZoneNameRecords endpoint
1758
1855
  *
@@ -2019,6 +2116,98 @@ export type GET_DnsDomainForwards_Response_403 = Problem
2019
2116
  */
2020
2117
  export type GET_DnsDomainForwards_Response_422 = HTTPValidationError
2021
2118
 
2119
+ /**
2120
+ * Response types for GET DnsEmailForwards endpoint
2121
+ *
2122
+ * List email forwards by zone
2123
+ * Retrieves a paginated list of email forwards grouped by DNS zones.
2124
+ *
2125
+ * @remarks
2126
+ * This type defines all possible response structures for the GET DnsEmailForwards endpoint.
2127
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
2128
+ * Use this type to ensure type safety when handling API responses from this endpoint.
2129
+ *
2130
+
2131
+ *
2132
+ * @path /v1/dns/email-forwards
2133
+ *
2134
+ * @see {@link GET_DnsEmailForwards_Response_200} - 200 response type
2135
+ * @see {@link GET_DnsEmailForwards_Response_401} - 401 response type
2136
+ * @see {@link GET_DnsEmailForwards_Response_403} - 403 response type
2137
+ * @see {@link GET_DnsEmailForwards_Response_422} - 422 response type
2138
+ *
2139
+
2140
+ */
2141
+ export type GET_DnsEmailForwards_Response = GET_DnsEmailForwards_Response_200 | GET_DnsEmailForwards_Response_401 | GET_DnsEmailForwards_Response_403 | GET_DnsEmailForwards_Response_422;
2142
+
2143
+ /**
2144
+ * 200 response for GET DnsEmailForwards endpoint
2145
+ *
2146
+ * @remarks
2147
+ * This type defines the response structure for the 200 status code
2148
+ * of the GET DnsEmailForwards endpoint.
2149
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
2150
+ *
2151
+
2152
+ *
2153
+ * @path /v1/dns/email-forwards
2154
+ *
2155
+ * @see {@link GET_DnsEmailForwards_Response} - The main response type definition
2156
+ * @see {@link Pagination_EmailForwardZone} - The actual schema type definition
2157
+ */
2158
+ export type GET_DnsEmailForwards_Response_200 = Pagination_EmailForwardZone
2159
+
2160
+ /**
2161
+ * 401 response for GET DnsEmailForwards endpoint
2162
+ *
2163
+ * @remarks
2164
+ * This type defines the response structure for the 401 status code
2165
+ * of the GET DnsEmailForwards endpoint.
2166
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
2167
+ *
2168
+
2169
+ *
2170
+ * @path /v1/dns/email-forwards
2171
+ *
2172
+ * @see {@link GET_DnsEmailForwards_Response} - The main response type definition
2173
+ * @see {@link Problem} - The actual schema type definition
2174
+ */
2175
+ export type GET_DnsEmailForwards_Response_401 = Problem
2176
+
2177
+ /**
2178
+ * 403 response for GET DnsEmailForwards endpoint
2179
+ *
2180
+ * @remarks
2181
+ * This type defines the response structure for the 403 status code
2182
+ * of the GET DnsEmailForwards endpoint.
2183
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
2184
+ *
2185
+
2186
+ *
2187
+ * @path /v1/dns/email-forwards
2188
+ *
2189
+ * @see {@link GET_DnsEmailForwards_Response} - The main response type definition
2190
+ * @see {@link Problem} - The actual schema type definition
2191
+ */
2192
+ export type GET_DnsEmailForwards_Response_403 = Problem
2193
+
2194
+ /**
2195
+ * 422 response for GET DnsEmailForwards endpoint
2196
+ *
2197
+ * @remarks
2198
+ * This type defines the response structure for the 422 status code
2199
+ * of the GET DnsEmailForwards endpoint.
2200
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
2201
+ *
2202
+
2203
+ *
2204
+ * @path /v1/dns/email-forwards
2205
+ *
2206
+ * @see {@link GET_DnsEmailForwards_Response} - The main response type definition
2207
+ * @see {@link HTTPValidationError} - The actual schema type definition
2208
+ */
2209
+ export type GET_DnsEmailForwards_Response_422 = HTTPValidationError
2210
+
2022
2211
  /**
2023
2212
  * Response types for GET DnsSummary endpoint
2024
2213
  *
@@ -4690,354 +4879,922 @@ export type POST_DomainsTransfer_Response_409 = Problem
4690
4879
  export type POST_DomainsTransfer_Response_422 = Problem
4691
4880
 
4692
4881
  /**
4693
- * Response types for DELETE EmailForwardsByZoneNameAliases endpoint
4882
+ * Response types for GET EmailForwards endpoint
4694
4883
  *
4695
- * Delete Email Forward Aliases
4884
+ * List all email forwards
4885
+ * Retrieves a paginated list of all email forwards for the organization.
4696
4886
  *
4697
4887
  * @remarks
4698
- * This type defines all possible response structures for the DELETE EmailForwardsByZoneNameAliases endpoint.
4888
+ * This type defines all possible response structures for the GET EmailForwards endpoint.
4699
4889
  * Each response code maps to a specific response type as defined in the OpenAPI specification.
4700
4890
  * Use this type to ensure type safety when handling API responses from this endpoint.
4701
4891
  *
4702
4892
 
4703
4893
  *
4704
- * @path /v1/email-forwards/{zone_name}/aliases
4705
- * @param zone_name (path) - DNS zone name (trailing dot optional)
4894
+ * @path /v1/email-forwards
4706
4895
  *
4707
- * @see {@link DELETE_EmailForwardsByZoneNameAliases_Response_422} - 422 response type
4896
+ * @see {@link GET_EmailForwards_Response_200} - 200 response type
4897
+ * @see {@link GET_EmailForwards_Response_401} - 401 response type
4898
+ * @see {@link GET_EmailForwards_Response_403} - 403 response type
4899
+ * @see {@link GET_EmailForwards_Response_422} - 422 response type
4708
4900
  *
4709
4901
 
4710
4902
  */
4711
- export type DELETE_EmailForwardsByZoneNameAliases_Response = DELETE_EmailForwardsByZoneNameAliases_Response_422;
4903
+ export type GET_EmailForwards_Response = GET_EmailForwards_Response_200 | GET_EmailForwards_Response_401 | GET_EmailForwards_Response_403 | GET_EmailForwards_Response_422;
4712
4904
 
4713
4905
  /**
4714
- * 422 response for DELETE EmailForwardsByZoneNameAliases endpoint
4906
+ * 200 response for GET EmailForwards endpoint
4715
4907
  *
4716
4908
  * @remarks
4717
- * This type defines the response structure for the 422 status code
4718
- * of the DELETE EmailForwardsByZoneNameAliases endpoint.
4909
+ * This type defines the response structure for the 200 status code
4910
+ * of the GET EmailForwards endpoint.
4719
4911
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4720
4912
  *
4721
4913
 
4722
4914
  *
4723
- * @path /v1/email-forwards/{zone_name}/aliases
4724
- * @param zone_name (path) - DNS zone name (trailing dot optional)
4915
+ * @path /v1/email-forwards
4725
4916
  *
4726
- * @see {@link DELETE_EmailForwardsByZoneNameAliases_Response} - The main response type definition
4727
- * @see {@link HTTPValidationError} - The actual schema type definition
4917
+ * @see {@link GET_EmailForwards_Response} - The main response type definition
4918
+ * @see {@link Pagination_EmailForward} - The actual schema type definition
4728
4919
  */
4729
- export type DELETE_EmailForwardsByZoneNameAliases_Response_422 = HTTPValidationError
4920
+ export type GET_EmailForwards_Response_200 = Pagination_EmailForward
4730
4921
 
4731
4922
  /**
4732
- * Response types for GET EmailForwardsByZoneNameAliases endpoint
4733
- *
4734
- * Get Email Forward Aliases
4923
+ * 401 response for GET EmailForwards endpoint
4735
4924
  *
4736
4925
  * @remarks
4737
- * This type defines all possible response structures for the GET EmailForwardsByZoneNameAliases endpoint.
4738
- * Each response code maps to a specific response type as defined in the OpenAPI specification.
4739
- * Use this type to ensure type safety when handling API responses from this endpoint.
4926
+ * This type defines the response structure for the 401 status code
4927
+ * of the GET EmailForwards endpoint.
4928
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4740
4929
  *
4741
4930
 
4742
4931
  *
4743
- * @path /v1/email-forwards/{zone_name}/aliases
4744
- * @param zone_name (path) - DNS zone name (trailing dot optional)
4745
- *
4746
- * @see {@link GET_EmailForwardsByZoneNameAliases_Response_200} - 200 response type
4747
- * @see {@link GET_EmailForwardsByZoneNameAliases_Response_422} - 422 response type
4932
+ * @path /v1/email-forwards
4748
4933
  *
4749
-
4934
+ * @see {@link GET_EmailForwards_Response} - The main response type definition
4935
+ * @see {@link Problem} - The actual schema type definition
4750
4936
  */
4751
- export type GET_EmailForwardsByZoneNameAliases_Response = GET_EmailForwardsByZoneNameAliases_Response_200 | GET_EmailForwardsByZoneNameAliases_Response_422;
4937
+ export type GET_EmailForwards_Response_401 = Problem
4752
4938
 
4753
4939
  /**
4754
- * 200 response for GET EmailForwardsByZoneNameAliases endpoint
4940
+ * 403 response for GET EmailForwards endpoint
4755
4941
  *
4756
4942
  * @remarks
4757
- * This type defines the response structure for the 200 status code
4758
- * of the GET EmailForwardsByZoneNameAliases endpoint.
4943
+ * This type defines the response structure for the 403 status code
4944
+ * of the GET EmailForwards endpoint.
4759
4945
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4760
4946
  *
4761
4947
 
4762
4948
  *
4763
- * @path /v1/email-forwards/{zone_name}/aliases
4764
- * @param zone_name (path) - DNS zone name (trailing dot optional)
4949
+ * @path /v1/email-forwards
4765
4950
  *
4766
- * @see {@link GET_EmailForwardsByZoneNameAliases_Response} - The main response type definition
4767
- * @see {@link Pagination_EmailForwardAlias} - The actual schema type definition
4951
+ * @see {@link GET_EmailForwards_Response} - The main response type definition
4952
+ * @see {@link Problem} - The actual schema type definition
4768
4953
  */
4769
- export type GET_EmailForwardsByZoneNameAliases_Response_200 = Pagination_EmailForwardAlias
4954
+ export type GET_EmailForwards_Response_403 = Problem
4770
4955
 
4771
4956
  /**
4772
- * 422 response for GET EmailForwardsByZoneNameAliases endpoint
4957
+ * 422 response for GET EmailForwards endpoint
4773
4958
  *
4774
4959
  * @remarks
4775
4960
  * This type defines the response structure for the 422 status code
4776
- * of the GET EmailForwardsByZoneNameAliases endpoint.
4961
+ * of the GET EmailForwards endpoint.
4777
4962
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4778
4963
  *
4779
4964
 
4780
4965
  *
4781
- * @path /v1/email-forwards/{zone_name}/aliases
4782
- * @param zone_name (path) - DNS zone name (trailing dot optional)
4966
+ * @path /v1/email-forwards
4783
4967
  *
4784
- * @see {@link GET_EmailForwardsByZoneNameAliases_Response} - The main response type definition
4968
+ * @see {@link GET_EmailForwards_Response} - The main response type definition
4785
4969
  * @see {@link HTTPValidationError} - The actual schema type definition
4786
4970
  */
4787
- export type GET_EmailForwardsByZoneNameAliases_Response_422 = HTTPValidationError
4971
+ export type GET_EmailForwards_Response_422 = HTTPValidationError
4788
4972
 
4789
4973
  /**
4790
- * Response types for POST EmailForwardsByZoneNameAliases endpoint
4974
+ * Response types for POST EmailForwards endpoint
4791
4975
  *
4792
- * Create Email Forward Alias
4976
+ * Create email forward configuration
4977
+ * Creates an email forward configuration with optional aliases. Can be created enabled or disabled (default: disabled). Includes created_on and updated_on timestamps.
4793
4978
  *
4794
4979
  * @remarks
4795
- * This type defines all possible response structures for the POST EmailForwardsByZoneNameAliases endpoint.
4980
+ * This type defines all possible response structures for the POST EmailForwards endpoint.
4796
4981
  * Each response code maps to a specific response type as defined in the OpenAPI specification.
4797
4982
  * Use this type to ensure type safety when handling API responses from this endpoint.
4798
4983
  *
4799
4984
 
4800
4985
  *
4801
- * @path /v1/email-forwards/{zone_name}/aliases
4802
- * @param zone_name (path) - DNS zone name (trailing dot optional)
4986
+ * @path /v1/email-forwards
4803
4987
  *
4804
- * @see {@link POST_EmailForwardsByZoneNameAliases_Response_422} - 422 response type
4988
+ * @see {@link POST_EmailForwards_Response_201} - 201 response type
4989
+ * @see {@link POST_EmailForwards_Response_401} - 401 response type
4990
+ * @see {@link POST_EmailForwards_Response_403} - 403 response type
4991
+ * @see {@link POST_EmailForwards_Response_404} - 404 response type
4992
+ * @see {@link POST_EmailForwards_Response_409} - 409 response type
4993
+ * @see {@link POST_EmailForwards_Response_422} - 422 response type
4805
4994
  *
4806
4995
 
4807
4996
  */
4808
- export type POST_EmailForwardsByZoneNameAliases_Response = POST_EmailForwardsByZoneNameAliases_Response_422;
4997
+ export type POST_EmailForwards_Response = POST_EmailForwards_Response_201 | POST_EmailForwards_Response_401 | POST_EmailForwards_Response_403 | POST_EmailForwards_Response_404 | POST_EmailForwards_Response_409 | POST_EmailForwards_Response_422;
4809
4998
 
4810
4999
  /**
4811
- * 422 response for POST EmailForwardsByZoneNameAliases endpoint
5000
+ * 201 response for POST EmailForwards endpoint
4812
5001
  *
4813
5002
  * @remarks
4814
- * This type defines the response structure for the 422 status code
4815
- * of the POST EmailForwardsByZoneNameAliases endpoint.
5003
+ * This type defines the response structure for the 201 status code
5004
+ * of the POST EmailForwards endpoint.
4816
5005
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4817
5006
  *
4818
5007
 
4819
5008
  *
4820
- * @path /v1/email-forwards/{zone_name}/aliases
4821
- * @param zone_name (path) - DNS zone name (trailing dot optional)
5009
+ * @path /v1/email-forwards
4822
5010
  *
4823
- * @see {@link POST_EmailForwardsByZoneNameAliases_Response} - The main response type definition
4824
- * @see {@link HTTPValidationError} - The actual schema type definition
5011
+ * @see {@link POST_EmailForwards_Response} - The main response type definition
5012
+ * @see {@link EmailForward} - The actual schema type definition
5013
+ */
5014
+ export type POST_EmailForwards_Response_201 = EmailForward
5015
+
5016
+ /**
5017
+ * 401 response for POST EmailForwards endpoint
5018
+ *
5019
+ * @remarks
5020
+ * This type defines the response structure for the 401 status code
5021
+ * of the POST EmailForwards endpoint.
5022
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5023
+ *
5024
+
5025
+ *
5026
+ * @path /v1/email-forwards
5027
+ *
5028
+ * @see {@link POST_EmailForwards_Response} - The main response type definition
5029
+ * @see {@link Problem} - The actual schema type definition
4825
5030
  */
4826
- export type POST_EmailForwardsByZoneNameAliases_Response_422 = HTTPValidationError
5031
+ export type POST_EmailForwards_Response_401 = Problem
4827
5032
 
4828
5033
  /**
4829
- * Response types for DELETE EmailForwardsByZoneNameAliasesByAlias endpoint
5034
+ * 403 response for POST EmailForwards endpoint
5035
+ *
5036
+ * @remarks
5037
+ * This type defines the response structure for the 403 status code
5038
+ * of the POST EmailForwards endpoint.
5039
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5040
+ *
5041
+
5042
+ *
5043
+ * @path /v1/email-forwards
4830
5044
  *
4831
- * Delete Email Forward Alias
5045
+ * @see {@link POST_EmailForwards_Response} - The main response type definition
5046
+ * @see {@link Problem} - The actual schema type definition
5047
+ */
5048
+ export type POST_EmailForwards_Response_403 = Problem
5049
+
5050
+ /**
5051
+ * 404 response for POST EmailForwards endpoint
4832
5052
  *
4833
5053
  * @remarks
4834
- * This type defines all possible response structures for the DELETE EmailForwardsByZoneNameAliasesByAlias endpoint.
4835
- * Each response code maps to a specific response type as defined in the OpenAPI specification.
4836
- * Use this type to ensure type safety when handling API responses from this endpoint.
5054
+ * This type defines the response structure for the 404 status code
5055
+ * of the POST EmailForwards endpoint.
5056
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4837
5057
  *
4838
5058
 
4839
5059
  *
4840
- * @path /v1/email-forwards/{zone_name}/aliases/{alias}
4841
- * @param zone_name (path) - DNS zone name (trailing dot optional)
5060
+ * @path /v1/email-forwards
5061
+ *
5062
+ * @see {@link POST_EmailForwards_Response} - The main response type definition
5063
+ * @see {@link Problem} - The actual schema type definition
5064
+ */
5065
+ export type POST_EmailForwards_Response_404 = Problem
5066
+
5067
+ /**
5068
+ * 409 response for POST EmailForwards endpoint
4842
5069
  *
4843
- * @see {@link DELETE_EmailForwardsByZoneNameAliasesByAlias_Response_422} - 422 response type
5070
+ * @remarks
5071
+ * This type defines the response structure for the 409 status code
5072
+ * of the POST EmailForwards endpoint.
5073
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4844
5074
  *
4845
5075
 
5076
+ *
5077
+ * @path /v1/email-forwards
5078
+ *
5079
+ * @see {@link POST_EmailForwards_Response} - The main response type definition
5080
+ * @see {@link Problem} - The actual schema type definition
4846
5081
  */
4847
- export type DELETE_EmailForwardsByZoneNameAliasesByAlias_Response = DELETE_EmailForwardsByZoneNameAliasesByAlias_Response_422;
5082
+ export type POST_EmailForwards_Response_409 = Problem
4848
5083
 
4849
5084
  /**
4850
- * 422 response for DELETE EmailForwardsByZoneNameAliasesByAlias endpoint
5085
+ * 422 response for POST EmailForwards endpoint
4851
5086
  *
4852
5087
  * @remarks
4853
5088
  * This type defines the response structure for the 422 status code
4854
- * of the DELETE EmailForwardsByZoneNameAliasesByAlias endpoint.
5089
+ * of the POST EmailForwards endpoint.
4855
5090
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4856
5091
  *
4857
5092
 
4858
5093
  *
4859
- * @path /v1/email-forwards/{zone_name}/aliases/{alias}
4860
- * @param zone_name (path) - DNS zone name (trailing dot optional)
5094
+ * @path /v1/email-forwards
4861
5095
  *
4862
- * @see {@link DELETE_EmailForwardsByZoneNameAliasesByAlias_Response} - The main response type definition
5096
+ * @see {@link POST_EmailForwards_Response} - The main response type definition
4863
5097
  * @see {@link HTTPValidationError} - The actual schema type definition
4864
5098
  */
4865
- export type DELETE_EmailForwardsByZoneNameAliasesByAlias_Response_422 = HTTPValidationError
5099
+ export type POST_EmailForwards_Response_422 = HTTPValidationError
4866
5100
 
4867
5101
  /**
4868
- * Response types for GET EmailForwardsByZoneNameAliasesByAlias endpoint
5102
+ * Response types for DELETE EmailForwardsByEmailForwardId endpoint
4869
5103
  *
4870
- * Get Email Forward Alias
5104
+ * Delete email forward configuration
5105
+ * Permanently deletes the email forward configuration including all aliases. If enabled, automatically disables first (removes DNS records and unregisters from ImprovMX).
4871
5106
  *
4872
5107
  * @remarks
4873
- * This type defines all possible response structures for the GET EmailForwardsByZoneNameAliasesByAlias endpoint.
5108
+ * This type defines all possible response structures for the DELETE EmailForwardsByEmailForwardId endpoint.
4874
5109
  * Each response code maps to a specific response type as defined in the OpenAPI specification.
4875
5110
  * Use this type to ensure type safety when handling API responses from this endpoint.
4876
5111
  *
4877
5112
 
4878
5113
  *
4879
- * @path /v1/email-forwards/{zone_name}/aliases/{alias}
4880
- * @param zone_name (path) - DNS zone name (trailing dot optional)
5114
+ * @path /v1/email-forwards/{email_forward_id}
4881
5115
  *
4882
- * @see {@link GET_EmailForwardsByZoneNameAliasesByAlias_Response_200} - 200 response type
4883
- * @see {@link GET_EmailForwardsByZoneNameAliasesByAlias_Response_422} - 422 response type
5116
+ * @see {@link DELETE_EmailForwardsByEmailForwardId_Response_401} - 401 response type
5117
+ * @see {@link DELETE_EmailForwardsByEmailForwardId_Response_403} - 403 response type
5118
+ * @see {@link DELETE_EmailForwardsByEmailForwardId_Response_422} - 422 response type
4884
5119
  *
4885
5120
 
4886
5121
  */
4887
- export type GET_EmailForwardsByZoneNameAliasesByAlias_Response = GET_EmailForwardsByZoneNameAliasesByAlias_Response_200 | GET_EmailForwardsByZoneNameAliasesByAlias_Response_422;
5122
+ export type DELETE_EmailForwardsByEmailForwardId_Response = DELETE_EmailForwardsByEmailForwardId_Response_401 | DELETE_EmailForwardsByEmailForwardId_Response_403 | DELETE_EmailForwardsByEmailForwardId_Response_422;
4888
5123
 
4889
5124
  /**
4890
- * 200 response for GET EmailForwardsByZoneNameAliasesByAlias endpoint
5125
+ * 401 response for DELETE EmailForwardsByEmailForwardId endpoint
4891
5126
  *
4892
5127
  * @remarks
4893
- * This type defines the response structure for the 200 status code
4894
- * of the GET EmailForwardsByZoneNameAliasesByAlias endpoint.
5128
+ * This type defines the response structure for the 401 status code
5129
+ * of the DELETE EmailForwardsByEmailForwardId endpoint.
4895
5130
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4896
5131
  *
4897
5132
 
4898
5133
  *
4899
- * @path /v1/email-forwards/{zone_name}/aliases/{alias}
4900
- * @param zone_name (path) - DNS zone name (trailing dot optional)
5134
+ * @path /v1/email-forwards/{email_forward_id}
4901
5135
  *
4902
- * @see {@link GET_EmailForwardsByZoneNameAliasesByAlias_Response} - The main response type definition
4903
- * @see {@link EmailForwardAlias} - The actual schema type definition
5136
+ * @see {@link DELETE_EmailForwardsByEmailForwardId_Response} - The main response type definition
5137
+ * @see {@link Problem} - The actual schema type definition
5138
+ */
5139
+ export type DELETE_EmailForwardsByEmailForwardId_Response_401 = Problem
5140
+
5141
+ /**
5142
+ * 403 response for DELETE EmailForwardsByEmailForwardId endpoint
5143
+ *
5144
+ * @remarks
5145
+ * This type defines the response structure for the 403 status code
5146
+ * of the DELETE EmailForwardsByEmailForwardId endpoint.
5147
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5148
+ *
5149
+
5150
+ *
5151
+ * @path /v1/email-forwards/{email_forward_id}
5152
+ *
5153
+ * @see {@link DELETE_EmailForwardsByEmailForwardId_Response} - The main response type definition
5154
+ * @see {@link Problem} - The actual schema type definition
4904
5155
  */
4905
- export type GET_EmailForwardsByZoneNameAliasesByAlias_Response_200 = EmailForwardAlias
5156
+ export type DELETE_EmailForwardsByEmailForwardId_Response_403 = Problem
4906
5157
 
4907
5158
  /**
4908
- * 422 response for GET EmailForwardsByZoneNameAliasesByAlias endpoint
5159
+ * 422 response for DELETE EmailForwardsByEmailForwardId endpoint
4909
5160
  *
4910
5161
  * @remarks
4911
5162
  * This type defines the response structure for the 422 status code
4912
- * of the GET EmailForwardsByZoneNameAliasesByAlias endpoint.
5163
+ * of the DELETE EmailForwardsByEmailForwardId endpoint.
4913
5164
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4914
5165
  *
4915
5166
 
4916
5167
  *
4917
- * @path /v1/email-forwards/{zone_name}/aliases/{alias}
4918
- * @param zone_name (path) - DNS zone name (trailing dot optional)
5168
+ * @path /v1/email-forwards/{email_forward_id}
4919
5169
  *
4920
- * @see {@link GET_EmailForwardsByZoneNameAliasesByAlias_Response} - The main response type definition
5170
+ * @see {@link DELETE_EmailForwardsByEmailForwardId_Response} - The main response type definition
4921
5171
  * @see {@link HTTPValidationError} - The actual schema type definition
4922
5172
  */
4923
- export type GET_EmailForwardsByZoneNameAliasesByAlias_Response_422 = HTTPValidationError
5173
+ export type DELETE_EmailForwardsByEmailForwardId_Response_422 = HTTPValidationError
4924
5174
 
4925
5175
  /**
4926
- * Response types for PUT EmailForwardsByZoneNameAliasesByAlias endpoint
5176
+ * Response types for GET EmailForwardsByEmailForwardId endpoint
4927
5177
  *
4928
- * Update Email Forward Alias
5178
+ * Get email forward configuration
5179
+ * Retrieves the email forward configuration for the specified zone including all aliases
4929
5180
  *
4930
5181
  * @remarks
4931
- * This type defines all possible response structures for the PUT EmailForwardsByZoneNameAliasesByAlias endpoint.
5182
+ * This type defines all possible response structures for the GET EmailForwardsByEmailForwardId endpoint.
4932
5183
  * Each response code maps to a specific response type as defined in the OpenAPI specification.
4933
5184
  * Use this type to ensure type safety when handling API responses from this endpoint.
4934
5185
  *
4935
5186
 
4936
5187
  *
4937
- * @path /v1/email-forwards/{zone_name}/aliases/{alias}
4938
- * @param zone_name (path) - DNS zone name (trailing dot optional)
5188
+ * @path /v1/email-forwards/{email_forward_id}
4939
5189
  *
4940
- * @see {@link PUT_EmailForwardsByZoneNameAliasesByAlias_Response_422} - 422 response type
5190
+ * @see {@link GET_EmailForwardsByEmailForwardId_Response_200} - 200 response type
5191
+ * @see {@link GET_EmailForwardsByEmailForwardId_Response_401} - 401 response type
5192
+ * @see {@link GET_EmailForwardsByEmailForwardId_Response_403} - 403 response type
5193
+ * @see {@link GET_EmailForwardsByEmailForwardId_Response_404} - 404 response type
5194
+ * @see {@link GET_EmailForwardsByEmailForwardId_Response_422} - 422 response type
4941
5195
  *
4942
5196
 
4943
5197
  */
4944
- export type PUT_EmailForwardsByZoneNameAliasesByAlias_Response = PUT_EmailForwardsByZoneNameAliasesByAlias_Response_422;
5198
+ export type GET_EmailForwardsByEmailForwardId_Response = GET_EmailForwardsByEmailForwardId_Response_200 | GET_EmailForwardsByEmailForwardId_Response_401 | GET_EmailForwardsByEmailForwardId_Response_403 | GET_EmailForwardsByEmailForwardId_Response_404 | GET_EmailForwardsByEmailForwardId_Response_422;
4945
5199
 
4946
5200
  /**
4947
- * 422 response for PUT EmailForwardsByZoneNameAliasesByAlias endpoint
5201
+ * 200 response for GET EmailForwardsByEmailForwardId endpoint
4948
5202
  *
4949
5203
  * @remarks
4950
- * This type defines the response structure for the 422 status code
4951
- * of the PUT EmailForwardsByZoneNameAliasesByAlias endpoint.
5204
+ * This type defines the response structure for the 200 status code
5205
+ * of the GET EmailForwardsByEmailForwardId endpoint.
4952
5206
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4953
5207
  *
4954
5208
 
4955
5209
  *
4956
- * @path /v1/email-forwards/{zone_name}/aliases/{alias}
4957
- * @param zone_name (path) - DNS zone name (trailing dot optional)
5210
+ * @path /v1/email-forwards/{email_forward_id}
4958
5211
  *
4959
- * @see {@link PUT_EmailForwardsByZoneNameAliasesByAlias_Response} - The main response type definition
4960
- * @see {@link HTTPValidationError} - The actual schema type definition
5212
+ * @see {@link GET_EmailForwardsByEmailForwardId_Response} - The main response type definition
5213
+ * @see {@link EmailForward} - The actual schema type definition
4961
5214
  */
4962
- export type PUT_EmailForwardsByZoneNameAliasesByAlias_Response_422 = HTTPValidationError
5215
+ export type GET_EmailForwardsByEmailForwardId_Response_200 = EmailForward
4963
5216
 
4964
5217
  /**
4965
- * Response types for PATCH EmailForwardsByZoneNameDisable endpoint
5218
+ * 401 response for GET EmailForwardsByEmailForwardId endpoint
5219
+ *
5220
+ * @remarks
5221
+ * This type defines the response structure for the 401 status code
5222
+ * of the GET EmailForwardsByEmailForwardId endpoint.
5223
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5224
+ *
5225
+
5226
+ *
5227
+ * @path /v1/email-forwards/{email_forward_id}
4966
5228
  *
4967
- * Disable Email Forward
5229
+ * @see {@link GET_EmailForwardsByEmailForwardId_Response} - The main response type definition
5230
+ * @see {@link Problem} - The actual schema type definition
5231
+ */
5232
+ export type GET_EmailForwardsByEmailForwardId_Response_401 = Problem
5233
+
5234
+ /**
5235
+ * 403 response for GET EmailForwardsByEmailForwardId endpoint
4968
5236
  *
4969
5237
  * @remarks
4970
- * This type defines all possible response structures for the PATCH EmailForwardsByZoneNameDisable endpoint.
4971
- * Each response code maps to a specific response type as defined in the OpenAPI specification.
4972
- * Use this type to ensure type safety when handling API responses from this endpoint.
5238
+ * This type defines the response structure for the 403 status code
5239
+ * of the GET EmailForwardsByEmailForwardId endpoint.
5240
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4973
5241
  *
4974
5242
 
4975
5243
  *
4976
- * @path /v1/email-forwards/{zone_name}/disable
4977
- * @param zone_name (path) - DNS zone name (trailing dot optional)
5244
+ * @path /v1/email-forwards/{email_forward_id}
5245
+ *
5246
+ * @see {@link GET_EmailForwardsByEmailForwardId_Response} - The main response type definition
5247
+ * @see {@link Problem} - The actual schema type definition
5248
+ */
5249
+ export type GET_EmailForwardsByEmailForwardId_Response_403 = Problem
5250
+
5251
+ /**
5252
+ * 404 response for GET EmailForwardsByEmailForwardId endpoint
4978
5253
  *
4979
- * @see {@link PATCH_EmailForwardsByZoneNameDisable_Response_422} - 422 response type
5254
+ * @remarks
5255
+ * This type defines the response structure for the 404 status code
5256
+ * of the GET EmailForwardsByEmailForwardId endpoint.
5257
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4980
5258
  *
4981
5259
 
5260
+ *
5261
+ * @path /v1/email-forwards/{email_forward_id}
5262
+ *
5263
+ * @see {@link GET_EmailForwardsByEmailForwardId_Response} - The main response type definition
5264
+ * @see {@link Problem} - The actual schema type definition
4982
5265
  */
4983
- export type PATCH_EmailForwardsByZoneNameDisable_Response = PATCH_EmailForwardsByZoneNameDisable_Response_422;
5266
+ export type GET_EmailForwardsByEmailForwardId_Response_404 = Problem
4984
5267
 
4985
5268
  /**
4986
- * 422 response for PATCH EmailForwardsByZoneNameDisable endpoint
5269
+ * 422 response for GET EmailForwardsByEmailForwardId endpoint
4987
5270
  *
4988
5271
  * @remarks
4989
5272
  * This type defines the response structure for the 422 status code
4990
- * of the PATCH EmailForwardsByZoneNameDisable endpoint.
5273
+ * of the GET EmailForwardsByEmailForwardId endpoint.
4991
5274
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4992
5275
  *
4993
5276
 
4994
5277
  *
4995
- * @path /v1/email-forwards/{zone_name}/disable
4996
- * @param zone_name (path) - DNS zone name (trailing dot optional)
5278
+ * @path /v1/email-forwards/{email_forward_id}
4997
5279
  *
4998
- * @see {@link PATCH_EmailForwardsByZoneNameDisable_Response} - The main response type definition
5280
+ * @see {@link GET_EmailForwardsByEmailForwardId_Response} - The main response type definition
4999
5281
  * @see {@link HTTPValidationError} - The actual schema type definition
5000
5282
  */
5001
- export type PATCH_EmailForwardsByZoneNameDisable_Response_422 = HTTPValidationError
5283
+ export type GET_EmailForwardsByEmailForwardId_Response_422 = HTTPValidationError
5002
5284
 
5003
5285
  /**
5004
- * Response types for PATCH EmailForwardsByZoneNameEnable endpoint
5286
+ * Response types for POST EmailForwardsByEmailForwardIdAliases endpoint
5005
5287
  *
5006
- * Enable Email Forward
5288
+ * Create email forward alias
5289
+ * Creates a new email forward alias for the specified hostname.
5007
5290
  *
5008
5291
  * @remarks
5009
- * This type defines all possible response structures for the PATCH EmailForwardsByZoneNameEnable endpoint.
5292
+ * This type defines all possible response structures for the POST EmailForwardsByEmailForwardIdAliases endpoint.
5010
5293
  * Each response code maps to a specific response type as defined in the OpenAPI specification.
5011
5294
  * Use this type to ensure type safety when handling API responses from this endpoint.
5012
5295
  *
5013
5296
 
5014
5297
  *
5015
- * @path /v1/email-forwards/{zone_name}/enable
5016
- * @param zone_name (path) - DNS zone name (trailing dot optional)
5298
+ * @path /v1/email-forwards/{email_forward_id}/aliases
5017
5299
  *
5018
- * @see {@link PATCH_EmailForwardsByZoneNameEnable_Response_422} - 422 response type
5300
+ * @see {@link POST_EmailForwardsByEmailForwardIdAliases_Response_201} - 201 response type
5301
+ * @see {@link POST_EmailForwardsByEmailForwardIdAliases_Response_401} - 401 response type
5302
+ * @see {@link POST_EmailForwardsByEmailForwardIdAliases_Response_403} - 403 response type
5303
+ * @see {@link POST_EmailForwardsByEmailForwardIdAliases_Response_404} - 404 response type
5304
+ * @see {@link POST_EmailForwardsByEmailForwardIdAliases_Response_409} - 409 response type
5305
+ * @see {@link POST_EmailForwardsByEmailForwardIdAliases_Response_422} - 422 response type
5019
5306
  *
5020
5307
 
5021
5308
  */
5022
- export type PATCH_EmailForwardsByZoneNameEnable_Response = PATCH_EmailForwardsByZoneNameEnable_Response_422;
5309
+ export type POST_EmailForwardsByEmailForwardIdAliases_Response = POST_EmailForwardsByEmailForwardIdAliases_Response_201 | POST_EmailForwardsByEmailForwardIdAliases_Response_401 | POST_EmailForwardsByEmailForwardIdAliases_Response_403 | POST_EmailForwardsByEmailForwardIdAliases_Response_404 | POST_EmailForwardsByEmailForwardIdAliases_Response_409 | POST_EmailForwardsByEmailForwardIdAliases_Response_422;
5023
5310
 
5024
5311
  /**
5025
- * 422 response for PATCH EmailForwardsByZoneNameEnable endpoint
5312
+ * 201 response for POST EmailForwardsByEmailForwardIdAliases endpoint
5026
5313
  *
5027
5314
  * @remarks
5028
- * This type defines the response structure for the 422 status code
5029
- * of the PATCH EmailForwardsByZoneNameEnable endpoint.
5315
+ * This type defines the response structure for the 201 status code
5316
+ * of the POST EmailForwardsByEmailForwardIdAliases endpoint.
5030
5317
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5031
5318
  *
5032
5319
 
5033
5320
  *
5034
- * @path /v1/email-forwards/{zone_name}/enable
5035
- * @param zone_name (path) - DNS zone name (trailing dot optional)
5321
+ * @path /v1/email-forwards/{email_forward_id}/aliases
5322
+ *
5323
+ * @see {@link POST_EmailForwardsByEmailForwardIdAliases_Response} - The main response type definition
5324
+ * @see {@link EmailForwardAlias} - The actual schema type definition
5325
+ */
5326
+ export type POST_EmailForwardsByEmailForwardIdAliases_Response_201 = EmailForwardAlias
5327
+
5328
+ /**
5329
+ * 401 response for POST EmailForwardsByEmailForwardIdAliases endpoint
5330
+ *
5331
+ * @remarks
5332
+ * This type defines the response structure for the 401 status code
5333
+ * of the POST EmailForwardsByEmailForwardIdAliases endpoint.
5334
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5335
+ *
5336
+
5337
+ *
5338
+ * @path /v1/email-forwards/{email_forward_id}/aliases
5339
+ *
5340
+ * @see {@link POST_EmailForwardsByEmailForwardIdAliases_Response} - The main response type definition
5341
+ * @see {@link Problem} - The actual schema type definition
5342
+ */
5343
+ export type POST_EmailForwardsByEmailForwardIdAliases_Response_401 = Problem
5344
+
5345
+ /**
5346
+ * 403 response for POST EmailForwardsByEmailForwardIdAliases endpoint
5347
+ *
5348
+ * @remarks
5349
+ * This type defines the response structure for the 403 status code
5350
+ * of the POST EmailForwardsByEmailForwardIdAliases endpoint.
5351
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5352
+ *
5353
+
5354
+ *
5355
+ * @path /v1/email-forwards/{email_forward_id}/aliases
5356
+ *
5357
+ * @see {@link POST_EmailForwardsByEmailForwardIdAliases_Response} - The main response type definition
5358
+ * @see {@link Problem} - The actual schema type definition
5359
+ */
5360
+ export type POST_EmailForwardsByEmailForwardIdAliases_Response_403 = Problem
5361
+
5362
+ /**
5363
+ * 404 response for POST EmailForwardsByEmailForwardIdAliases endpoint
5364
+ *
5365
+ * @remarks
5366
+ * This type defines the response structure for the 404 status code
5367
+ * of the POST EmailForwardsByEmailForwardIdAliases endpoint.
5368
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5369
+ *
5370
+
5371
+ *
5372
+ * @path /v1/email-forwards/{email_forward_id}/aliases
5373
+ *
5374
+ * @see {@link POST_EmailForwardsByEmailForwardIdAliases_Response} - The main response type definition
5375
+ * @see {@link Problem} - The actual schema type definition
5376
+ */
5377
+ export type POST_EmailForwardsByEmailForwardIdAliases_Response_404 = Problem
5378
+
5379
+ /**
5380
+ * 409 response for POST EmailForwardsByEmailForwardIdAliases endpoint
5381
+ *
5382
+ * @remarks
5383
+ * This type defines the response structure for the 409 status code
5384
+ * of the POST EmailForwardsByEmailForwardIdAliases endpoint.
5385
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5386
+ *
5387
+
5388
+ *
5389
+ * @path /v1/email-forwards/{email_forward_id}/aliases
5390
+ *
5391
+ * @see {@link POST_EmailForwardsByEmailForwardIdAliases_Response} - The main response type definition
5392
+ * @see {@link Problem} - The actual schema type definition
5393
+ */
5394
+ export type POST_EmailForwardsByEmailForwardIdAliases_Response_409 = Problem
5395
+
5396
+ /**
5397
+ * 422 response for POST EmailForwardsByEmailForwardIdAliases endpoint
5398
+ *
5399
+ * @remarks
5400
+ * This type defines the response structure for the 422 status code
5401
+ * of the POST EmailForwardsByEmailForwardIdAliases endpoint.
5402
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5403
+ *
5404
+
5405
+ *
5406
+ * @path /v1/email-forwards/{email_forward_id}/aliases
5407
+ *
5408
+ * @see {@link POST_EmailForwardsByEmailForwardIdAliases_Response} - The main response type definition
5409
+ * @see {@link HTTPValidationError} - The actual schema type definition
5410
+ */
5411
+ export type POST_EmailForwardsByEmailForwardIdAliases_Response_422 = HTTPValidationError
5412
+
5413
+ /**
5414
+ * Response types for DELETE EmailForwardsByEmailForwardIdAliasesByAliasId endpoint
5415
+ *
5416
+ * Delete email forward alias
5417
+ * Deletes a specific email forward alias for the specified zone
5418
+ *
5419
+ * @remarks
5420
+ * This type defines all possible response structures for the DELETE EmailForwardsByEmailForwardIdAliasesByAliasId endpoint.
5421
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
5422
+ * Use this type to ensure type safety when handling API responses from this endpoint.
5423
+ *
5424
+
5425
+ *
5426
+ * @path /v1/email-forwards/{email_forward_id}/aliases/{alias_id}
5427
+ *
5428
+ * @see {@link DELETE_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_401} - 401 response type
5429
+ * @see {@link DELETE_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_403} - 403 response type
5430
+ * @see {@link DELETE_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_404} - 404 response type
5431
+ * @see {@link DELETE_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_422} - 422 response type
5432
+ *
5433
+
5434
+ */
5435
+ export type DELETE_EmailForwardsByEmailForwardIdAliasesByAliasId_Response = DELETE_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_401 | DELETE_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_403 | DELETE_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_404 | DELETE_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_422;
5436
+
5437
+ /**
5438
+ * 401 response for DELETE EmailForwardsByEmailForwardIdAliasesByAliasId endpoint
5439
+ *
5440
+ * @remarks
5441
+ * This type defines the response structure for the 401 status code
5442
+ * of the DELETE EmailForwardsByEmailForwardIdAliasesByAliasId endpoint.
5443
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5444
+ *
5445
+
5446
+ *
5447
+ * @path /v1/email-forwards/{email_forward_id}/aliases/{alias_id}
5448
+ *
5449
+ * @see {@link DELETE_EmailForwardsByEmailForwardIdAliasesByAliasId_Response} - The main response type definition
5450
+ * @see {@link Problem} - The actual schema type definition
5451
+ */
5452
+ export type DELETE_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_401 = Problem
5453
+
5454
+ /**
5455
+ * 403 response for DELETE EmailForwardsByEmailForwardIdAliasesByAliasId endpoint
5456
+ *
5457
+ * @remarks
5458
+ * This type defines the response structure for the 403 status code
5459
+ * of the DELETE EmailForwardsByEmailForwardIdAliasesByAliasId endpoint.
5460
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5461
+ *
5462
+
5463
+ *
5464
+ * @path /v1/email-forwards/{email_forward_id}/aliases/{alias_id}
5465
+ *
5466
+ * @see {@link DELETE_EmailForwardsByEmailForwardIdAliasesByAliasId_Response} - The main response type definition
5467
+ * @see {@link Problem} - The actual schema type definition
5468
+ */
5469
+ export type DELETE_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_403 = Problem
5470
+
5471
+ /**
5472
+ * 404 response for DELETE EmailForwardsByEmailForwardIdAliasesByAliasId endpoint
5473
+ *
5474
+ * @remarks
5475
+ * This type defines the response structure for the 404 status code
5476
+ * of the DELETE EmailForwardsByEmailForwardIdAliasesByAliasId endpoint.
5477
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5478
+ *
5479
+
5480
+ *
5481
+ * @path /v1/email-forwards/{email_forward_id}/aliases/{alias_id}
5482
+ *
5483
+ * @see {@link DELETE_EmailForwardsByEmailForwardIdAliasesByAliasId_Response} - The main response type definition
5484
+ * @see {@link Problem} - The actual schema type definition
5485
+ */
5486
+ export type DELETE_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_404 = Problem
5487
+
5488
+ /**
5489
+ * 422 response for DELETE EmailForwardsByEmailForwardIdAliasesByAliasId endpoint
5490
+ *
5491
+ * @remarks
5492
+ * This type defines the response structure for the 422 status code
5493
+ * of the DELETE EmailForwardsByEmailForwardIdAliasesByAliasId endpoint.
5494
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5495
+ *
5496
+
5497
+ *
5498
+ * @path /v1/email-forwards/{email_forward_id}/aliases/{alias_id}
5499
+ *
5500
+ * @see {@link DELETE_EmailForwardsByEmailForwardIdAliasesByAliasId_Response} - The main response type definition
5501
+ * @see {@link HTTPValidationError} - The actual schema type definition
5502
+ */
5503
+ export type DELETE_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_422 = HTTPValidationError
5504
+
5505
+ /**
5506
+ * Response types for PUT EmailForwardsByEmailForwardIdAliasesByAliasId endpoint
5507
+ *
5508
+ * Update email forward alias
5509
+ * Updates the forward_to address for a specific email forward alias
5510
+ *
5511
+ * @remarks
5512
+ * This type defines all possible response structures for the PUT EmailForwardsByEmailForwardIdAliasesByAliasId endpoint.
5513
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
5514
+ * Use this type to ensure type safety when handling API responses from this endpoint.
5515
+ *
5516
+
5517
+ *
5518
+ * @path /v1/email-forwards/{email_forward_id}/aliases/{alias_id}
5519
+ *
5520
+ * @see {@link PUT_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_200} - 200 response type
5521
+ * @see {@link PUT_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_401} - 401 response type
5522
+ * @see {@link PUT_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_403} - 403 response type
5523
+ * @see {@link PUT_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_404} - 404 response type
5524
+ * @see {@link PUT_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_422} - 422 response type
5525
+ *
5526
+
5527
+ */
5528
+ export type PUT_EmailForwardsByEmailForwardIdAliasesByAliasId_Response = PUT_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_200 | PUT_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_401 | PUT_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_403 | PUT_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_404 | PUT_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_422;
5529
+
5530
+ /**
5531
+ * 200 response for PUT EmailForwardsByEmailForwardIdAliasesByAliasId endpoint
5532
+ *
5533
+ * @remarks
5534
+ * This type defines the response structure for the 200 status code
5535
+ * of the PUT EmailForwardsByEmailForwardIdAliasesByAliasId endpoint.
5536
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5537
+ *
5538
+
5539
+ *
5540
+ * @path /v1/email-forwards/{email_forward_id}/aliases/{alias_id}
5541
+ *
5542
+ * @see {@link PUT_EmailForwardsByEmailForwardIdAliasesByAliasId_Response} - The main response type definition
5543
+ * @see {@link EmailForwardAlias} - The actual schema type definition
5544
+ */
5545
+ export type PUT_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_200 = EmailForwardAlias
5546
+
5547
+ /**
5548
+ * 401 response for PUT EmailForwardsByEmailForwardIdAliasesByAliasId endpoint
5549
+ *
5550
+ * @remarks
5551
+ * This type defines the response structure for the 401 status code
5552
+ * of the PUT EmailForwardsByEmailForwardIdAliasesByAliasId endpoint.
5553
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5554
+ *
5555
+
5556
+ *
5557
+ * @path /v1/email-forwards/{email_forward_id}/aliases/{alias_id}
5558
+ *
5559
+ * @see {@link PUT_EmailForwardsByEmailForwardIdAliasesByAliasId_Response} - The main response type definition
5560
+ * @see {@link Problem} - The actual schema type definition
5561
+ */
5562
+ export type PUT_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_401 = Problem
5563
+
5564
+ /**
5565
+ * 403 response for PUT EmailForwardsByEmailForwardIdAliasesByAliasId endpoint
5566
+ *
5567
+ * @remarks
5568
+ * This type defines the response structure for the 403 status code
5569
+ * of the PUT EmailForwardsByEmailForwardIdAliasesByAliasId endpoint.
5570
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5571
+ *
5572
+
5573
+ *
5574
+ * @path /v1/email-forwards/{email_forward_id}/aliases/{alias_id}
5575
+ *
5576
+ * @see {@link PUT_EmailForwardsByEmailForwardIdAliasesByAliasId_Response} - The main response type definition
5577
+ * @see {@link Problem} - The actual schema type definition
5578
+ */
5579
+ export type PUT_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_403 = Problem
5580
+
5581
+ /**
5582
+ * 404 response for PUT EmailForwardsByEmailForwardIdAliasesByAliasId endpoint
5583
+ *
5584
+ * @remarks
5585
+ * This type defines the response structure for the 404 status code
5586
+ * of the PUT EmailForwardsByEmailForwardIdAliasesByAliasId endpoint.
5587
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5588
+ *
5589
+
5590
+ *
5591
+ * @path /v1/email-forwards/{email_forward_id}/aliases/{alias_id}
5592
+ *
5593
+ * @see {@link PUT_EmailForwardsByEmailForwardIdAliasesByAliasId_Response} - The main response type definition
5594
+ * @see {@link Problem} - The actual schema type definition
5595
+ */
5596
+ export type PUT_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_404 = Problem
5597
+
5598
+ /**
5599
+ * 422 response for PUT EmailForwardsByEmailForwardIdAliasesByAliasId endpoint
5600
+ *
5601
+ * @remarks
5602
+ * This type defines the response structure for the 422 status code
5603
+ * of the PUT EmailForwardsByEmailForwardIdAliasesByAliasId endpoint.
5604
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5605
+ *
5606
+
5607
+ *
5608
+ * @path /v1/email-forwards/{email_forward_id}/aliases/{alias_id}
5609
+ *
5610
+ * @see {@link PUT_EmailForwardsByEmailForwardIdAliasesByAliasId_Response} - The main response type definition
5611
+ * @see {@link HTTPValidationError} - The actual schema type definition
5612
+ */
5613
+ export type PUT_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_422 = HTTPValidationError
5614
+
5615
+ /**
5616
+ * Response types for PATCH EmailForwardsByEmailForwardIdDisable endpoint
5617
+ *
5618
+ * Disable email forwarding
5619
+ * Disables email forwarding by removing MX and SPF DNS records and unregistering the domain from the email forward provider. The email forward configuration is preserved but disabled.
5620
+ *
5621
+ * @remarks
5622
+ * This type defines all possible response structures for the PATCH EmailForwardsByEmailForwardIdDisable endpoint.
5623
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
5624
+ * Use this type to ensure type safety when handling API responses from this endpoint.
5625
+ *
5626
+
5627
+ *
5628
+ * @path /v1/email-forwards/{email_forward_id}/disable
5629
+ *
5630
+ * @see {@link PATCH_EmailForwardsByEmailForwardIdDisable_Response_401} - 401 response type
5631
+ * @see {@link PATCH_EmailForwardsByEmailForwardIdDisable_Response_403} - 403 response type
5632
+ * @see {@link PATCH_EmailForwardsByEmailForwardIdDisable_Response_404} - 404 response type
5633
+ * @see {@link PATCH_EmailForwardsByEmailForwardIdDisable_Response_422} - 422 response type
5634
+ *
5635
+
5636
+ */
5637
+ export type PATCH_EmailForwardsByEmailForwardIdDisable_Response = PATCH_EmailForwardsByEmailForwardIdDisable_Response_401 | PATCH_EmailForwardsByEmailForwardIdDisable_Response_403 | PATCH_EmailForwardsByEmailForwardIdDisable_Response_404 | PATCH_EmailForwardsByEmailForwardIdDisable_Response_422;
5638
+
5639
+ /**
5640
+ * 401 response for PATCH EmailForwardsByEmailForwardIdDisable endpoint
5641
+ *
5642
+ * @remarks
5643
+ * This type defines the response structure for the 401 status code
5644
+ * of the PATCH EmailForwardsByEmailForwardIdDisable endpoint.
5645
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5646
+ *
5647
+
5648
+ *
5649
+ * @path /v1/email-forwards/{email_forward_id}/disable
5650
+ *
5651
+ * @see {@link PATCH_EmailForwardsByEmailForwardIdDisable_Response} - The main response type definition
5652
+ * @see {@link Problem} - The actual schema type definition
5653
+ */
5654
+ export type PATCH_EmailForwardsByEmailForwardIdDisable_Response_401 = Problem
5655
+
5656
+ /**
5657
+ * 403 response for PATCH EmailForwardsByEmailForwardIdDisable endpoint
5658
+ *
5659
+ * @remarks
5660
+ * This type defines the response structure for the 403 status code
5661
+ * of the PATCH EmailForwardsByEmailForwardIdDisable endpoint.
5662
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5663
+ *
5664
+
5665
+ *
5666
+ * @path /v1/email-forwards/{email_forward_id}/disable
5667
+ *
5668
+ * @see {@link PATCH_EmailForwardsByEmailForwardIdDisable_Response} - The main response type definition
5669
+ * @see {@link Problem} - The actual schema type definition
5670
+ */
5671
+ export type PATCH_EmailForwardsByEmailForwardIdDisable_Response_403 = Problem
5672
+
5673
+ /**
5674
+ * 404 response for PATCH EmailForwardsByEmailForwardIdDisable endpoint
5675
+ *
5676
+ * @remarks
5677
+ * This type defines the response structure for the 404 status code
5678
+ * of the PATCH EmailForwardsByEmailForwardIdDisable endpoint.
5679
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5680
+ *
5681
+
5682
+ *
5683
+ * @path /v1/email-forwards/{email_forward_id}/disable
5684
+ *
5685
+ * @see {@link PATCH_EmailForwardsByEmailForwardIdDisable_Response} - The main response type definition
5686
+ * @see {@link Problem} - The actual schema type definition
5687
+ */
5688
+ export type PATCH_EmailForwardsByEmailForwardIdDisable_Response_404 = Problem
5689
+
5690
+ /**
5691
+ * 422 response for PATCH EmailForwardsByEmailForwardIdDisable endpoint
5692
+ *
5693
+ * @remarks
5694
+ * This type defines the response structure for the 422 status code
5695
+ * of the PATCH EmailForwardsByEmailForwardIdDisable endpoint.
5696
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5697
+ *
5698
+
5699
+ *
5700
+ * @path /v1/email-forwards/{email_forward_id}/disable
5701
+ *
5702
+ * @see {@link PATCH_EmailForwardsByEmailForwardIdDisable_Response} - The main response type definition
5703
+ * @see {@link HTTPValidationError} - The actual schema type definition
5704
+ */
5705
+ export type PATCH_EmailForwardsByEmailForwardIdDisable_Response_422 = HTTPValidationError
5706
+
5707
+ /**
5708
+ * Response types for PATCH EmailForwardsByEmailForwardIdEnable endpoint
5709
+ *
5710
+ * Enable email forwarding
5711
+ * Enables email forwarding by creating necessary MX and SPF DNS records and registering the domain with the email forward provider.
5712
+ *
5713
+ * @remarks
5714
+ * This type defines all possible response structures for the PATCH EmailForwardsByEmailForwardIdEnable endpoint.
5715
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
5716
+ * Use this type to ensure type safety when handling API responses from this endpoint.
5717
+ *
5718
+
5719
+ *
5720
+ * @path /v1/email-forwards/{email_forward_id}/enable
5721
+ *
5722
+ * @see {@link PATCH_EmailForwardsByEmailForwardIdEnable_Response_401} - 401 response type
5723
+ * @see {@link PATCH_EmailForwardsByEmailForwardIdEnable_Response_403} - 403 response type
5724
+ * @see {@link PATCH_EmailForwardsByEmailForwardIdEnable_Response_404} - 404 response type
5725
+ * @see {@link PATCH_EmailForwardsByEmailForwardIdEnable_Response_422} - 422 response type
5726
+ *
5727
+
5728
+ */
5729
+ export type PATCH_EmailForwardsByEmailForwardIdEnable_Response = PATCH_EmailForwardsByEmailForwardIdEnable_Response_401 | PATCH_EmailForwardsByEmailForwardIdEnable_Response_403 | PATCH_EmailForwardsByEmailForwardIdEnable_Response_404 | PATCH_EmailForwardsByEmailForwardIdEnable_Response_422;
5730
+
5731
+ /**
5732
+ * 401 response for PATCH EmailForwardsByEmailForwardIdEnable endpoint
5733
+ *
5734
+ * @remarks
5735
+ * This type defines the response structure for the 401 status code
5736
+ * of the PATCH EmailForwardsByEmailForwardIdEnable endpoint.
5737
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5738
+ *
5739
+
5740
+ *
5741
+ * @path /v1/email-forwards/{email_forward_id}/enable
5742
+ *
5743
+ * @see {@link PATCH_EmailForwardsByEmailForwardIdEnable_Response} - The main response type definition
5744
+ * @see {@link Problem} - The actual schema type definition
5745
+ */
5746
+ export type PATCH_EmailForwardsByEmailForwardIdEnable_Response_401 = Problem
5747
+
5748
+ /**
5749
+ * 403 response for PATCH EmailForwardsByEmailForwardIdEnable endpoint
5750
+ *
5751
+ * @remarks
5752
+ * This type defines the response structure for the 403 status code
5753
+ * of the PATCH EmailForwardsByEmailForwardIdEnable endpoint.
5754
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5755
+ *
5756
+
5757
+ *
5758
+ * @path /v1/email-forwards/{email_forward_id}/enable
5759
+ *
5760
+ * @see {@link PATCH_EmailForwardsByEmailForwardIdEnable_Response} - The main response type definition
5761
+ * @see {@link Problem} - The actual schema type definition
5762
+ */
5763
+ export type PATCH_EmailForwardsByEmailForwardIdEnable_Response_403 = Problem
5764
+
5765
+ /**
5766
+ * 404 response for PATCH EmailForwardsByEmailForwardIdEnable endpoint
5767
+ *
5768
+ * @remarks
5769
+ * This type defines the response structure for the 404 status code
5770
+ * of the PATCH EmailForwardsByEmailForwardIdEnable endpoint.
5771
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5772
+ *
5773
+
5774
+ *
5775
+ * @path /v1/email-forwards/{email_forward_id}/enable
5776
+ *
5777
+ * @see {@link PATCH_EmailForwardsByEmailForwardIdEnable_Response} - The main response type definition
5778
+ * @see {@link Problem} - The actual schema type definition
5779
+ */
5780
+ export type PATCH_EmailForwardsByEmailForwardIdEnable_Response_404 = Problem
5781
+
5782
+ /**
5783
+ * 422 response for PATCH EmailForwardsByEmailForwardIdEnable endpoint
5784
+ *
5785
+ * @remarks
5786
+ * This type defines the response structure for the 422 status code
5787
+ * of the PATCH EmailForwardsByEmailForwardIdEnable endpoint.
5788
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
5789
+ *
5790
+
5791
+ *
5792
+ * @path /v1/email-forwards/{email_forward_id}/enable
5036
5793
  *
5037
- * @see {@link PATCH_EmailForwardsByZoneNameEnable_Response} - The main response type definition
5794
+ * @see {@link PATCH_EmailForwardsByEmailForwardIdEnable_Response} - The main response type definition
5038
5795
  * @see {@link HTTPValidationError} - The actual schema type definition
5039
5796
  */
5040
- export type PATCH_EmailForwardsByZoneNameEnable_Response_422 = HTTPValidationError
5797
+ export type PATCH_EmailForwardsByEmailForwardIdEnable_Response_422 = HTTPValidationError
5041
5798
 
5042
5799
  /**
5043
5800
  * Response types for GET Events endpoint