@opusdns/api 0.82.0 → 0.83.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 @@ import { operations } from '../schema';
34
34
 
35
35
  import { DomainDnssecDataCreateArray, OrganizationAttributeUpdateArray } from './schemas-arrays.d';
36
36
 
37
- import { ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainCreate, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainTransferIn, EmailForwardAlias, EmailForwardAliasUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, UserCreate, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
37
+ import { ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, RedirectPatchOps, RedirectSet, DomainCreate, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainTransferIn, EmailForwardAlias, EmailForwardAliasUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, UserCreate, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
38
38
 
39
39
  /**
40
40
  * Request type for POST AuthToken endpoint
@@ -1014,6 +1014,324 @@ export type PUT_DnsZoneNameRrsets_Request_Path = PUT_DnsZoneNameRrsets_Request['
1014
1014
  */
1015
1015
  export type PUT_DnsZoneNameRrsets_Request_Body = PUT_DnsZoneNameRrsets_Request['requestBody'];
1016
1016
 
1017
+ /**
1018
+ * Request type for PATCH DomainForwards endpoint
1019
+ *
1020
+ * Patch Redirects
1021
+ *
1022
+ * @remarks
1023
+ * This type defines the complete request structure for the PATCH DomainForwards endpoint.
1024
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1025
+ * Use this type to ensure type safety when making API requests to this endpoint.
1026
+ *
1027
+ * @example
1028
+ * Use this type to ensure type safety when making API requests to this endpoint.
1029
+ *
1030
+ * @path /v1/domain-forwards
1031
+ *
1032
+ * @see {@link PATCH_DomainForwards_Request_Query} - Query parameters type
1033
+ * @see {@link PATCH_DomainForwards_Request_Path} - Path parameters type
1034
+ * @see {@link PATCH_DomainForwards_Request_Body} - Request body type
1035
+ */
1036
+ export type PATCH_DomainForwards_Request = {
1037
+ requestBody: RedirectPatchOps;
1038
+ }
1039
+ /**
1040
+ * Request body for PATCH /v1/domain-forwards
1041
+ *
1042
+ * @remarks
1043
+ * This type defines the request body structure for the PATCH /v1/domain-forwards endpoint.
1044
+ * It provides type safety for the request body as defined in the OpenAPI specification.
1045
+ *
1046
+ * @example
1047
+ * Use this type to ensure type safety for request body structure.
1048
+ *
1049
+ * @path /v1/domain-forwards
1050
+ */
1051
+ export type PATCH_DomainForwards_Request_Body = PATCH_DomainForwards_Request['requestBody'];
1052
+
1053
+ /**
1054
+ * Request type for DELETE DomainForwardsZoneName endpoint
1055
+ *
1056
+ * Delete Redirects
1057
+ *
1058
+ * @remarks
1059
+ * This type defines the complete request structure for the DELETE DomainForwardsZoneName endpoint.
1060
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1061
+ * Use this type to ensure type safety when making API requests to this endpoint.
1062
+ *
1063
+ * @example
1064
+ * Use this type to ensure type safety when making API requests to this endpoint.
1065
+ *
1066
+ * @path /v1/domain-forwards/{zone_name}
1067
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1068
+ *
1069
+ * @see {@link DELETE_DomainForwardsZoneName_Request_Query} - Query parameters type
1070
+ * @see {@link DELETE_DomainForwardsZoneName_Request_Path} - Path parameters type
1071
+ * @see {@link DELETE_DomainForwardsZoneName_Request_Body} - Request body type
1072
+ */
1073
+ export type DELETE_DomainForwardsZoneName_Request = {
1074
+ parameters: {
1075
+ path: operations['delete_redirects_v1_domain_forwards__zone_name__delete']['parameters']['path'];
1076
+ };
1077
+ }
1078
+ /**
1079
+ * Path parameters for DELETE /v1/domain-forwards/{zone_name}
1080
+ *
1081
+ * @remarks
1082
+ * This type defines the path parameters for the DELETE /v1/domain-forwards/{zone_name} endpoint.
1083
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
1084
+ *
1085
+ * @example
1086
+ * Use this type to ensure type safety for path parameters.
1087
+ *
1088
+ * @path /v1/domain-forwards/{zone_name}
1089
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1090
+ */
1091
+ export type DELETE_DomainForwardsZoneName_Request_Path = DELETE_DomainForwardsZoneName_Request['parameters']['path'];
1092
+
1093
+ /**
1094
+ * Request type for GET DomainForwardsZoneName endpoint
1095
+ *
1096
+ * Get Redirects
1097
+ *
1098
+ * @remarks
1099
+ * This type defines the complete request structure for the GET DomainForwardsZoneName endpoint.
1100
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1101
+ * Use this type to ensure type safety when making API requests to this endpoint.
1102
+ *
1103
+ * @example
1104
+ * Use this type to ensure type safety when making API requests to this endpoint.
1105
+ *
1106
+ * @path /v1/domain-forwards/{zone_name}
1107
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1108
+ *
1109
+ * @see {@link GET_DomainForwardsZoneName_Request_Query} - Query parameters type
1110
+ * @see {@link GET_DomainForwardsZoneName_Request_Path} - Path parameters type
1111
+ * @see {@link GET_DomainForwardsZoneName_Request_Body} - Request body type
1112
+ */
1113
+ export type GET_DomainForwardsZoneName_Request = {
1114
+ parameters: {
1115
+ query: operations['get_redirects_v1_domain_forwards__zone_name__get']['parameters']['query'];
1116
+ path: operations['get_redirects_v1_domain_forwards__zone_name__get']['parameters']['path'];
1117
+ };
1118
+ }
1119
+ /**
1120
+ * Query parameters for GET /v1/domain-forwards/{zone_name}
1121
+ *
1122
+ * @remarks
1123
+ * This type defines the query parameters for the GET /v1/domain-forwards/{zone_name} endpoint.
1124
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
1125
+ *
1126
+ * @example
1127
+ * Use this type to ensure type safety for query parameters.
1128
+ *
1129
+ * @path /v1/domain-forwards/{zone_name}
1130
+ */
1131
+ export type GET_DomainForwardsZoneName_Request_Query = GET_DomainForwardsZoneName_Request['parameters']['query'];
1132
+ /**
1133
+ * Path parameters for GET /v1/domain-forwards/{zone_name}
1134
+ *
1135
+ * @remarks
1136
+ * This type defines the path parameters for the GET /v1/domain-forwards/{zone_name} endpoint.
1137
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
1138
+ *
1139
+ * @example
1140
+ * Use this type to ensure type safety for path parameters.
1141
+ *
1142
+ * @path /v1/domain-forwards/{zone_name}
1143
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1144
+ */
1145
+ export type GET_DomainForwardsZoneName_Request_Path = GET_DomainForwardsZoneName_Request['parameters']['path'];
1146
+
1147
+ /**
1148
+ * Request type for POST DomainForwardsZoneName endpoint
1149
+ *
1150
+ * Create Redirects
1151
+ *
1152
+ * @remarks
1153
+ * This type defines the complete request structure for the POST DomainForwardsZoneName endpoint.
1154
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1155
+ * Use this type to ensure type safety when making API requests to this endpoint.
1156
+ *
1157
+ * @example
1158
+ * Use this type to ensure type safety when making API requests to this endpoint.
1159
+ *
1160
+ * @path /v1/domain-forwards/{zone_name}
1161
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1162
+ *
1163
+ * @see {@link POST_DomainForwardsZoneName_Request_Query} - Query parameters type
1164
+ * @see {@link POST_DomainForwardsZoneName_Request_Path} - Path parameters type
1165
+ * @see {@link POST_DomainForwardsZoneName_Request_Body} - Request body type
1166
+ */
1167
+ export type POST_DomainForwardsZoneName_Request = {
1168
+ parameters: {
1169
+ path: operations['create_redirects_v1_domain_forwards__zone_name__post']['parameters']['path'];
1170
+ };
1171
+ requestBody: RedirectSet;
1172
+ }
1173
+ /**
1174
+ * Path parameters for POST /v1/domain-forwards/{zone_name}
1175
+ *
1176
+ * @remarks
1177
+ * This type defines the path parameters for the POST /v1/domain-forwards/{zone_name} endpoint.
1178
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
1179
+ *
1180
+ * @example
1181
+ * Use this type to ensure type safety for path parameters.
1182
+ *
1183
+ * @path /v1/domain-forwards/{zone_name}
1184
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1185
+ */
1186
+ export type POST_DomainForwardsZoneName_Request_Path = POST_DomainForwardsZoneName_Request['parameters']['path'];
1187
+ /**
1188
+ * Request body for POST /v1/domain-forwards/{zone_name}
1189
+ *
1190
+ * @remarks
1191
+ * This type defines the request body structure for the POST /v1/domain-forwards/{zone_name} endpoint.
1192
+ * It provides type safety for the request body as defined in the OpenAPI specification.
1193
+ *
1194
+ * @example
1195
+ * Use this type to ensure type safety for request body structure.
1196
+ *
1197
+ * @path /v1/domain-forwards/{zone_name}
1198
+ */
1199
+ export type POST_DomainForwardsZoneName_Request_Body = POST_DomainForwardsZoneName_Request['requestBody'];
1200
+
1201
+ /**
1202
+ * Request type for PUT DomainForwardsZoneName endpoint
1203
+ *
1204
+ * Update Redirects
1205
+ *
1206
+ * @remarks
1207
+ * This type defines the complete request structure for the PUT DomainForwardsZoneName endpoint.
1208
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1209
+ * Use this type to ensure type safety when making API requests to this endpoint.
1210
+ *
1211
+ * @example
1212
+ * Use this type to ensure type safety when making API requests to this endpoint.
1213
+ *
1214
+ * @path /v1/domain-forwards/{zone_name}
1215
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1216
+ *
1217
+ * @see {@link PUT_DomainForwardsZoneName_Request_Query} - Query parameters type
1218
+ * @see {@link PUT_DomainForwardsZoneName_Request_Path} - Path parameters type
1219
+ * @see {@link PUT_DomainForwardsZoneName_Request_Body} - Request body type
1220
+ */
1221
+ export type PUT_DomainForwardsZoneName_Request = {
1222
+ parameters: {
1223
+ path: operations['update_redirects_v1_domain_forwards__zone_name__put']['parameters']['path'];
1224
+ };
1225
+ requestBody: RedirectSet;
1226
+ }
1227
+ /**
1228
+ * Path parameters for PUT /v1/domain-forwards/{zone_name}
1229
+ *
1230
+ * @remarks
1231
+ * This type defines the path parameters for the PUT /v1/domain-forwards/{zone_name} endpoint.
1232
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
1233
+ *
1234
+ * @example
1235
+ * Use this type to ensure type safety for path parameters.
1236
+ *
1237
+ * @path /v1/domain-forwards/{zone_name}
1238
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1239
+ */
1240
+ export type PUT_DomainForwardsZoneName_Request_Path = PUT_DomainForwardsZoneName_Request['parameters']['path'];
1241
+ /**
1242
+ * Request body for PUT /v1/domain-forwards/{zone_name}
1243
+ *
1244
+ * @remarks
1245
+ * This type defines the request body structure for the PUT /v1/domain-forwards/{zone_name} endpoint.
1246
+ * It provides type safety for the request body as defined in the OpenAPI specification.
1247
+ *
1248
+ * @example
1249
+ * Use this type to ensure type safety for request body structure.
1250
+ *
1251
+ * @path /v1/domain-forwards/{zone_name}
1252
+ */
1253
+ export type PUT_DomainForwardsZoneName_Request_Body = PUT_DomainForwardsZoneName_Request['requestBody'];
1254
+
1255
+ /**
1256
+ * Request type for PATCH DomainForwardsZoneNameDisable endpoint
1257
+ *
1258
+ * Disable Domain Forward
1259
+ *
1260
+ * @remarks
1261
+ * This type defines the complete request structure for the PATCH DomainForwardsZoneNameDisable endpoint.
1262
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1263
+ * Use this type to ensure type safety when making API requests to this endpoint.
1264
+ *
1265
+ * @example
1266
+ * Use this type to ensure type safety when making API requests to this endpoint.
1267
+ *
1268
+ * @path /v1/domain-forwards/{zone_name}/disable
1269
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1270
+ *
1271
+ * @see {@link PATCH_DomainForwardsZoneNameDisable_Request_Query} - Query parameters type
1272
+ * @see {@link PATCH_DomainForwardsZoneNameDisable_Request_Path} - Path parameters type
1273
+ * @see {@link PATCH_DomainForwardsZoneNameDisable_Request_Body} - Request body type
1274
+ */
1275
+ export type PATCH_DomainForwardsZoneNameDisable_Request = {
1276
+ parameters: {
1277
+ path: operations['disable_domain_forward_v1_domain_forwards__zone_name__disable_patch']['parameters']['path'];
1278
+ };
1279
+ }
1280
+ /**
1281
+ * Path parameters for PATCH /v1/domain-forwards/{zone_name}/disable
1282
+ *
1283
+ * @remarks
1284
+ * This type defines the path parameters for the PATCH /v1/domain-forwards/{zone_name}/disable endpoint.
1285
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
1286
+ *
1287
+ * @example
1288
+ * Use this type to ensure type safety for path parameters.
1289
+ *
1290
+ * @path /v1/domain-forwards/{zone_name}/disable
1291
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1292
+ */
1293
+ export type PATCH_DomainForwardsZoneNameDisable_Request_Path = PATCH_DomainForwardsZoneNameDisable_Request['parameters']['path'];
1294
+
1295
+ /**
1296
+ * Request type for PATCH DomainForwardsZoneNameEnable endpoint
1297
+ *
1298
+ * Enable Domain Forward
1299
+ *
1300
+ * @remarks
1301
+ * This type defines the complete request structure for the PATCH DomainForwardsZoneNameEnable endpoint.
1302
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1303
+ * Use this type to ensure type safety when making API requests to this endpoint.
1304
+ *
1305
+ * @example
1306
+ * Use this type to ensure type safety when making API requests to this endpoint.
1307
+ *
1308
+ * @path /v1/domain-forwards/{zone_name}/enable
1309
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1310
+ *
1311
+ * @see {@link PATCH_DomainForwardsZoneNameEnable_Request_Query} - Query parameters type
1312
+ * @see {@link PATCH_DomainForwardsZoneNameEnable_Request_Path} - Path parameters type
1313
+ * @see {@link PATCH_DomainForwardsZoneNameEnable_Request_Body} - Request body type
1314
+ */
1315
+ export type PATCH_DomainForwardsZoneNameEnable_Request = {
1316
+ parameters: {
1317
+ path: operations['enable_domain_forward_v1_domain_forwards__zone_name__enable_patch']['parameters']['path'];
1318
+ };
1319
+ }
1320
+ /**
1321
+ * Path parameters for PATCH /v1/domain-forwards/{zone_name}/enable
1322
+ *
1323
+ * @remarks
1324
+ * This type defines the path parameters for the PATCH /v1/domain-forwards/{zone_name}/enable endpoint.
1325
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
1326
+ *
1327
+ * @example
1328
+ * Use this type to ensure type safety for path parameters.
1329
+ *
1330
+ * @path /v1/domain-forwards/{zone_name}/enable
1331
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1332
+ */
1333
+ export type PATCH_DomainForwardsZoneNameEnable_Request_Path = PATCH_DomainForwardsZoneNameEnable_Request['parameters']['path'];
1334
+
1017
1335
  /**
1018
1336
  * Request type for GET DomainSearchSuggest endpoint
1019
1337
  *
@@ -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, 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';
37
+ import { Problem, HTTPValidationError, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DnsZoneSummary, Pagination_Redirect, 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
@@ -1661,6 +1661,334 @@ export type GET_DnsSummary_Response = GET_DnsSummary_Response_200;
1661
1661
  */
1662
1662
  export type GET_DnsSummary_Response_200 = DnsZoneSummary
1663
1663
 
1664
+ /**
1665
+ * Response types for PATCH DomainForwards endpoint
1666
+ *
1667
+ * Patch Redirects
1668
+ *
1669
+ * @remarks
1670
+ * This type defines all possible response structures for the PATCH DomainForwards endpoint.
1671
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
1672
+ * Use this type to ensure type safety when handling API responses from this endpoint.
1673
+ *
1674
+
1675
+ *
1676
+ * @path /v1/domain-forwards
1677
+ *
1678
+ * @see {@link PATCH_DomainForwards_Response_422} - 422 response type
1679
+ *
1680
+
1681
+ */
1682
+ export type PATCH_DomainForwards_Response = PATCH_DomainForwards_Response_422;
1683
+
1684
+ /**
1685
+ * 422 response for PATCH DomainForwards endpoint
1686
+ *
1687
+ * @remarks
1688
+ * This type defines the response structure for the 422 status code
1689
+ * of the PATCH DomainForwards endpoint.
1690
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
1691
+ *
1692
+
1693
+ *
1694
+ * @path /v1/domain-forwards
1695
+ *
1696
+ * @see {@link PATCH_DomainForwards_Response} - The main response type definition
1697
+ * @see {@link HTTPValidationError} - The actual schema type definition
1698
+ */
1699
+ export type PATCH_DomainForwards_Response_422 = HTTPValidationError
1700
+
1701
+ /**
1702
+ * Response types for DELETE DomainForwardsByZoneName endpoint
1703
+ *
1704
+ * Delete Redirects
1705
+ *
1706
+ * @remarks
1707
+ * This type defines all possible response structures for the DELETE DomainForwardsByZoneName endpoint.
1708
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
1709
+ * Use this type to ensure type safety when handling API responses from this endpoint.
1710
+ *
1711
+
1712
+ *
1713
+ * @path /v1/domain-forwards/{zone_name}
1714
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1715
+ *
1716
+ * @see {@link DELETE_DomainForwardsByZoneName_Response_422} - 422 response type
1717
+ *
1718
+
1719
+ */
1720
+ export type DELETE_DomainForwardsByZoneName_Response = DELETE_DomainForwardsByZoneName_Response_422;
1721
+
1722
+ /**
1723
+ * 422 response for DELETE DomainForwardsByZoneName endpoint
1724
+ *
1725
+ * @remarks
1726
+ * This type defines the response structure for the 422 status code
1727
+ * of the DELETE DomainForwardsByZoneName endpoint.
1728
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
1729
+ *
1730
+
1731
+ *
1732
+ * @path /v1/domain-forwards/{zone_name}
1733
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1734
+ *
1735
+ * @see {@link DELETE_DomainForwardsByZoneName_Response} - The main response type definition
1736
+ * @see {@link HTTPValidationError} - The actual schema type definition
1737
+ */
1738
+ export type DELETE_DomainForwardsByZoneName_Response_422 = HTTPValidationError
1739
+
1740
+ /**
1741
+ * Response types for GET DomainForwardsByZoneName endpoint
1742
+ *
1743
+ * Get Redirects
1744
+ *
1745
+ * @remarks
1746
+ * This type defines all possible response structures for the GET DomainForwardsByZoneName endpoint.
1747
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
1748
+ * Use this type to ensure type safety when handling API responses from this endpoint.
1749
+ *
1750
+
1751
+ *
1752
+ * @path /v1/domain-forwards/{zone_name}
1753
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1754
+ *
1755
+ * @see {@link GET_DomainForwardsByZoneName_Response_200} - 200 response type
1756
+ * @see {@link GET_DomainForwardsByZoneName_Response_422} - 422 response type
1757
+ *
1758
+
1759
+ */
1760
+ export type GET_DomainForwardsByZoneName_Response = GET_DomainForwardsByZoneName_Response_200 | GET_DomainForwardsByZoneName_Response_422;
1761
+
1762
+ /**
1763
+ * 200 response for GET DomainForwardsByZoneName endpoint
1764
+ *
1765
+ * @remarks
1766
+ * This type defines the response structure for the 200 status code
1767
+ * of the GET DomainForwardsByZoneName endpoint.
1768
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
1769
+ *
1770
+
1771
+ *
1772
+ * @path /v1/domain-forwards/{zone_name}
1773
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1774
+ *
1775
+ * @see {@link GET_DomainForwardsByZoneName_Response} - The main response type definition
1776
+ * @see {@link Pagination_Redirect} - The actual schema type definition
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.
1787
+ *
1788
+
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
+ */
1796
+ export type GET_DomainForwardsByZoneName_Response_422 = HTTPValidationError
1797
+
1798
+ /**
1799
+ * Response types for POST DomainForwardsByZoneName endpoint
1800
+ *
1801
+ * Create Redirects
1802
+ *
1803
+ * @remarks
1804
+ * This type defines all possible response structures for the POST DomainForwardsByZoneName endpoint.
1805
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
1806
+ * Use this type to ensure type safety when handling API responses from this endpoint.
1807
+ *
1808
+
1809
+ *
1810
+ * @path /v1/domain-forwards/{zone_name}
1811
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1812
+ *
1813
+ * @see {@link POST_DomainForwardsByZoneName_Response_409} - 409 response type
1814
+ * @see {@link POST_DomainForwardsByZoneName_Response_422} - 422 response type
1815
+ *
1816
+
1817
+ */
1818
+ export type POST_DomainForwardsByZoneName_Response = POST_DomainForwardsByZoneName_Response_409 | POST_DomainForwardsByZoneName_Response_422;
1819
+
1820
+ /**
1821
+ * 409 response for POST DomainForwardsByZoneName endpoint
1822
+ *
1823
+ * @remarks
1824
+ * This type defines the response structure for the 409 status code
1825
+ * of the POST DomainForwardsByZoneName endpoint.
1826
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
1827
+ *
1828
+
1829
+ *
1830
+ * @path /v1/domain-forwards/{zone_name}
1831
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1832
+ *
1833
+ * @see {@link POST_DomainForwardsByZoneName_Response} - The main response type definition
1834
+ * @see {@link Problem} - The actual schema type definition
1835
+ */
1836
+ export type POST_DomainForwardsByZoneName_Response_409 = Problem
1837
+
1838
+ /**
1839
+ * 422 response for POST DomainForwardsByZoneName endpoint
1840
+ *
1841
+ * @remarks
1842
+ * This type defines the response structure for the 422 status code
1843
+ * of the POST DomainForwardsByZoneName endpoint.
1844
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
1845
+ *
1846
+
1847
+ *
1848
+ * @path /v1/domain-forwards/{zone_name}
1849
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1850
+ *
1851
+ * @see {@link POST_DomainForwardsByZoneName_Response} - The main response type definition
1852
+ * @see {@link HTTPValidationError} - The actual schema type definition
1853
+ */
1854
+ export type POST_DomainForwardsByZoneName_Response_422 = HTTPValidationError
1855
+
1856
+ /**
1857
+ * Response types for PUT DomainForwardsByZoneName endpoint
1858
+ *
1859
+ * Update Redirects
1860
+ *
1861
+ * @remarks
1862
+ * This type defines all possible response structures for the PUT DomainForwardsByZoneName endpoint.
1863
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
1864
+ * Use this type to ensure type safety when handling API responses from this endpoint.
1865
+ *
1866
+
1867
+ *
1868
+ * @path /v1/domain-forwards/{zone_name}
1869
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1870
+ *
1871
+ * @see {@link PUT_DomainForwardsByZoneName_Response_409} - 409 response type
1872
+ * @see {@link PUT_DomainForwardsByZoneName_Response_422} - 422 response type
1873
+ *
1874
+
1875
+ */
1876
+ export type PUT_DomainForwardsByZoneName_Response = PUT_DomainForwardsByZoneName_Response_409 | PUT_DomainForwardsByZoneName_Response_422;
1877
+
1878
+ /**
1879
+ * 409 response for PUT DomainForwardsByZoneName endpoint
1880
+ *
1881
+ * @remarks
1882
+ * This type defines the response structure for the 409 status code
1883
+ * of the PUT DomainForwardsByZoneName endpoint.
1884
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
1885
+ *
1886
+
1887
+ *
1888
+ * @path /v1/domain-forwards/{zone_name}
1889
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1890
+ *
1891
+ * @see {@link PUT_DomainForwardsByZoneName_Response} - The main response type definition
1892
+ * @see {@link Problem} - The actual schema type definition
1893
+ */
1894
+ export type PUT_DomainForwardsByZoneName_Response_409 = Problem
1895
+
1896
+ /**
1897
+ * 422 response for PUT DomainForwardsByZoneName endpoint
1898
+ *
1899
+ * @remarks
1900
+ * This type defines the response structure for the 422 status code
1901
+ * of the PUT DomainForwardsByZoneName endpoint.
1902
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
1903
+ *
1904
+
1905
+ *
1906
+ * @path /v1/domain-forwards/{zone_name}
1907
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1908
+ *
1909
+ * @see {@link PUT_DomainForwardsByZoneName_Response} - The main response type definition
1910
+ * @see {@link HTTPValidationError} - The actual schema type definition
1911
+ */
1912
+ export type PUT_DomainForwardsByZoneName_Response_422 = HTTPValidationError
1913
+
1914
+ /**
1915
+ * Response types for PATCH DomainForwardsByZoneNameDisable endpoint
1916
+ *
1917
+ * Disable Domain Forward
1918
+ *
1919
+ * @remarks
1920
+ * This type defines all possible response structures for the PATCH DomainForwardsByZoneNameDisable endpoint.
1921
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
1922
+ * Use this type to ensure type safety when handling API responses from this endpoint.
1923
+ *
1924
+
1925
+ *
1926
+ * @path /v1/domain-forwards/{zone_name}/disable
1927
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1928
+ *
1929
+ * @see {@link PATCH_DomainForwardsByZoneNameDisable_Response_422} - 422 response type
1930
+ *
1931
+
1932
+ */
1933
+ export type PATCH_DomainForwardsByZoneNameDisable_Response = PATCH_DomainForwardsByZoneNameDisable_Response_422;
1934
+
1935
+ /**
1936
+ * 422 response for PATCH DomainForwardsByZoneNameDisable endpoint
1937
+ *
1938
+ * @remarks
1939
+ * This type defines the response structure for the 422 status code
1940
+ * of the PATCH DomainForwardsByZoneNameDisable endpoint.
1941
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
1942
+ *
1943
+
1944
+ *
1945
+ * @path /v1/domain-forwards/{zone_name}/disable
1946
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1947
+ *
1948
+ * @see {@link PATCH_DomainForwardsByZoneNameDisable_Response} - The main response type definition
1949
+ * @see {@link HTTPValidationError} - The actual schema type definition
1950
+ */
1951
+ export type PATCH_DomainForwardsByZoneNameDisable_Response_422 = HTTPValidationError
1952
+
1953
+ /**
1954
+ * Response types for PATCH DomainForwardsByZoneNameEnable endpoint
1955
+ *
1956
+ * Enable Domain Forward
1957
+ *
1958
+ * @remarks
1959
+ * This type defines all possible response structures for the PATCH DomainForwardsByZoneNameEnable endpoint.
1960
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
1961
+ * Use this type to ensure type safety when handling API responses from this endpoint.
1962
+ *
1963
+
1964
+ *
1965
+ * @path /v1/domain-forwards/{zone_name}/enable
1966
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1967
+ *
1968
+ * @see {@link PATCH_DomainForwardsByZoneNameEnable_Response_422} - 422 response type
1969
+ *
1970
+
1971
+ */
1972
+ export type PATCH_DomainForwardsByZoneNameEnable_Response = PATCH_DomainForwardsByZoneNameEnable_Response_422;
1973
+
1974
+ /**
1975
+ * 422 response for PATCH DomainForwardsByZoneNameEnable endpoint
1976
+ *
1977
+ * @remarks
1978
+ * This type defines the response structure for the 422 status code
1979
+ * of the PATCH DomainForwardsByZoneNameEnable endpoint.
1980
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
1981
+ *
1982
+
1983
+ *
1984
+ * @path /v1/domain-forwards/{zone_name}/enable
1985
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
1986
+ *
1987
+ * @see {@link PATCH_DomainForwardsByZoneNameEnable_Response} - The main response type definition
1988
+ * @see {@link HTTPValidationError} - The actual schema type definition
1989
+ */
1990
+ export type PATCH_DomainForwardsByZoneNameEnable_Response_422 = HTTPValidationError
1991
+
1664
1992
  /**
1665
1993
  * Response types for GET DomainSearchSuggest endpoint
1666
1994
  *