@opusdns/api 0.93.0 → 0.95.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -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, DomainForwardPatchOps, DomainForwardRequest, 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, DomainForwardPatchOps, DomainForwardRequest, DomainForwardSetRequest, 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
@@ -670,6 +670,45 @@ export type POST_Dns_Request = {
670
670
  */
671
671
  export type POST_Dns_Request_Body = POST_Dns_Request['requestBody'];
672
672
 
673
+ /**
674
+ * Request type for GET DnsDomainForwards endpoint
675
+ *
676
+ * List domain forwards by zone
677
+ * Retrieves a paginated list of domain forwards grouped by DNS zones.
678
+ *
679
+ * @remarks
680
+ * This type defines the complete request structure for the GET DnsDomainForwards endpoint.
681
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
682
+ * Use this type to ensure type safety when making API requests to this endpoint.
683
+ *
684
+ * @example
685
+ * Use this type to ensure type safety when making API requests to this endpoint.
686
+ *
687
+ * @path /v1/dns/domain-forwards
688
+ *
689
+ * @see {@link GET_DnsDomainForwards_Request_Query} - Query parameters type
690
+ * @see {@link GET_DnsDomainForwards_Request_Path} - Path parameters type
691
+ * @see {@link GET_DnsDomainForwards_Request_Body} - Request body type
692
+ */
693
+ export type GET_DnsDomainForwards_Request = {
694
+ parameters: {
695
+ query: operations['list_domain_forwards_by_zone_v1_dns_domain_forwards_get']['parameters']['query'];
696
+ };
697
+ }
698
+ /**
699
+ * Query parameters for GET /v1/dns/domain-forwards
700
+ *
701
+ * @remarks
702
+ * This type defines the query parameters for the GET /v1/dns/domain-forwards endpoint.
703
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
704
+ *
705
+ * @example
706
+ * Use this type to ensure type safety for query parameters.
707
+ *
708
+ * @path /v1/dns/domain-forwards
709
+ */
710
+ export type GET_DnsDomainForwards_Request_Query = GET_DnsDomainForwards_Request['parameters']['query'];
711
+
673
712
  /**
674
713
  * Request type for GET DnsSummary endpoint
675
714
  *
@@ -852,6 +891,47 @@ export type POST_DnsZoneNameDnssecEnable_Request = {
852
891
  */
853
892
  export type POST_DnsZoneNameDnssecEnable_Request_Path = POST_DnsZoneNameDnssecEnable_Request['parameters']['path'];
854
893
 
894
+ /**
895
+ * Request type for GET DnsZoneNameDomainForwards endpoint
896
+ *
897
+ * List domain forwards for a zone
898
+ * Retrieves all domain forwards configured for the specified DNS zone, including subdomains.
899
+ *
900
+ * @remarks
901
+ * This type defines the complete request structure for the GET DnsZoneNameDomainForwards endpoint.
902
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
903
+ * Use this type to ensure type safety when making API requests to this endpoint.
904
+ *
905
+ * @example
906
+ * Use this type to ensure type safety when making API requests to this endpoint.
907
+ *
908
+ * @path /v1/dns/{zone_name}/domain-forwards
909
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
910
+ *
911
+ * @see {@link GET_DnsZoneNameDomainForwards_Request_Query} - Query parameters type
912
+ * @see {@link GET_DnsZoneNameDomainForwards_Request_Path} - Path parameters type
913
+ * @see {@link GET_DnsZoneNameDomainForwards_Request_Body} - Request body type
914
+ */
915
+ export type GET_DnsZoneNameDomainForwards_Request = {
916
+ parameters: {
917
+ path: operations['list_zone_domain_forwards_v1_dns__zone_name__domain_forwards_get']['parameters']['path'];
918
+ };
919
+ }
920
+ /**
921
+ * Path parameters for GET /v1/dns/{zone_name}/domain-forwards
922
+ *
923
+ * @remarks
924
+ * This type defines the path parameters for the GET /v1/dns/{zone_name}/domain-forwards endpoint.
925
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
926
+ *
927
+ * @example
928
+ * Use this type to ensure type safety for path parameters.
929
+ *
930
+ * @path /v1/dns/{zone_name}/domain-forwards
931
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
932
+ */
933
+ export type GET_DnsZoneNameDomainForwards_Request_Path = GET_DnsZoneNameDomainForwards_Request['parameters']['path'];
934
+
855
935
  /**
856
936
  * Request type for PATCH DnsZoneNameRecords endpoint
857
937
  *
@@ -1017,7 +1097,8 @@ export type PUT_DnsZoneNameRrsets_Request_Body = PUT_DnsZoneNameRrsets_Request['
1017
1097
  /**
1018
1098
  * Request type for GET DomainForwards endpoint
1019
1099
  *
1020
- * List Domain Forwards
1100
+ * List domain forwards
1101
+ * Retrieves a paginated list of domain forwards for the organization
1021
1102
  *
1022
1103
  * @remarks
1023
1104
  * This type defines the complete request structure for the GET DomainForwards endpoint.
@@ -1055,7 +1136,8 @@ export type GET_DomainForwards_Request_Query = GET_DomainForwards_Request['param
1055
1136
  /**
1056
1137
  * Request type for PATCH DomainForwards endpoint
1057
1138
  *
1058
- * Patch Redirects
1139
+ * Patch domain forward redirects
1140
+ * Applies patch operations to update or remove redirects across hostnames and protocols. Raises an error if the domain forward or domain forward set does not exist.
1059
1141
  *
1060
1142
  * @remarks
1061
1143
  * This type defines the complete request structure for the PATCH DomainForwards endpoint.
@@ -1089,290 +1171,435 @@ export type PATCH_DomainForwards_Request = {
1089
1171
  export type PATCH_DomainForwards_Request_Body = PATCH_DomainForwards_Request['requestBody'];
1090
1172
 
1091
1173
  /**
1092
- * Request type for PATCH DomainForwardsZoneNameDisable endpoint
1174
+ * Request type for DELETE DomainForwardsHostname endpoint
1093
1175
  *
1094
- * Disable Domain Forward
1176
+ * Delete a domain forward
1177
+ * Deletes the domain forward configuration for the specified hostname
1095
1178
  *
1096
1179
  * @remarks
1097
- * This type defines the complete request structure for the PATCH DomainForwardsZoneNameDisable endpoint.
1180
+ * This type defines the complete request structure for the DELETE DomainForwardsHostname endpoint.
1098
1181
  * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1099
1182
  * Use this type to ensure type safety when making API requests to this endpoint.
1100
1183
  *
1101
1184
  * @example
1102
1185
  * Use this type to ensure type safety when making API requests to this endpoint.
1103
1186
  *
1104
- * @path /v1/domain-forwards/{zone_name}/disable
1105
- * @param zone_name (path) - DNS zone name (trailing dot optional)
1187
+ * @path /v1/domain-forwards/{hostname}
1188
+ * @param hostname (path) - Hostname (trailing dot optional)
1106
1189
  *
1107
- * @see {@link PATCH_DomainForwardsZoneNameDisable_Request_Query} - Query parameters type
1108
- * @see {@link PATCH_DomainForwardsZoneNameDisable_Request_Path} - Path parameters type
1109
- * @see {@link PATCH_DomainForwardsZoneNameDisable_Request_Body} - Request body type
1190
+ * @see {@link DELETE_DomainForwardsHostname_Request_Query} - Query parameters type
1191
+ * @see {@link DELETE_DomainForwardsHostname_Request_Path} - Path parameters type
1192
+ * @see {@link DELETE_DomainForwardsHostname_Request_Body} - Request body type
1110
1193
  */
1111
- export type PATCH_DomainForwardsZoneNameDisable_Request = {
1194
+ export type DELETE_DomainForwardsHostname_Request = {
1112
1195
  parameters: {
1113
- path: operations['disable_domain_forward_v1_domain_forwards__zone_name__disable_patch']['parameters']['path'];
1196
+ path: operations['delete_domain_forward_v1_domain_forwards__hostname__delete']['parameters']['path'];
1114
1197
  };
1115
1198
  }
1116
1199
  /**
1117
- * Path parameters for PATCH /v1/domain-forwards/{zone_name}/disable
1200
+ * Path parameters for DELETE /v1/domain-forwards/{hostname}
1118
1201
  *
1119
1202
  * @remarks
1120
- * This type defines the path parameters for the PATCH /v1/domain-forwards/{zone_name}/disable endpoint.
1203
+ * This type defines the path parameters for the DELETE /v1/domain-forwards/{hostname} endpoint.
1121
1204
  * It provides type safety for all path parameters as defined in the OpenAPI specification.
1122
1205
  *
1123
1206
  * @example
1124
1207
  * Use this type to ensure type safety for path parameters.
1125
1208
  *
1126
- * @path /v1/domain-forwards/{zone_name}/disable
1127
- * @param zone_name (path) - DNS zone name (trailing dot optional)
1209
+ * @path /v1/domain-forwards/{hostname}
1210
+ * @param hostname (path) - Hostname (trailing dot optional)
1128
1211
  */
1129
- export type PATCH_DomainForwardsZoneNameDisable_Request_Path = PATCH_DomainForwardsZoneNameDisable_Request['parameters']['path'];
1212
+ export type DELETE_DomainForwardsHostname_Request_Path = DELETE_DomainForwardsHostname_Request['parameters']['path'];
1130
1213
 
1131
1214
  /**
1132
- * Request type for PATCH DomainForwardsZoneNameEnable endpoint
1215
+ * Request type for GET DomainForwardsHostname endpoint
1133
1216
  *
1134
- * Enable Domain Forward
1217
+ * Get a domain forward
1218
+ * Retrieves the domain forward configuration for the specified hostname
1135
1219
  *
1136
1220
  * @remarks
1137
- * This type defines the complete request structure for the PATCH DomainForwardsZoneNameEnable endpoint.
1221
+ * This type defines the complete request structure for the GET DomainForwardsHostname endpoint.
1138
1222
  * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1139
1223
  * Use this type to ensure type safety when making API requests to this endpoint.
1140
1224
  *
1141
1225
  * @example
1142
1226
  * Use this type to ensure type safety when making API requests to this endpoint.
1143
1227
  *
1144
- * @path /v1/domain-forwards/{zone_name}/enable
1145
- * @param zone_name (path) - DNS zone name (trailing dot optional)
1228
+ * @path /v1/domain-forwards/{hostname}
1229
+ * @param hostname (path) - Hostname (trailing dot optional)
1230
+ *
1231
+ * @see {@link GET_DomainForwardsHostname_Request_Query} - Query parameters type
1232
+ * @see {@link GET_DomainForwardsHostname_Request_Path} - Path parameters type
1233
+ * @see {@link GET_DomainForwardsHostname_Request_Body} - Request body type
1234
+ */
1235
+ export type GET_DomainForwardsHostname_Request = {
1236
+ parameters: {
1237
+ path: operations['get_domain_forward_v1_domain_forwards__hostname__get']['parameters']['path'];
1238
+ };
1239
+ }
1240
+ /**
1241
+ * Path parameters for GET /v1/domain-forwards/{hostname}
1242
+ *
1243
+ * @remarks
1244
+ * This type defines the path parameters for the GET /v1/domain-forwards/{hostname} endpoint.
1245
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
1246
+ *
1247
+ * @example
1248
+ * Use this type to ensure type safety for path parameters.
1249
+ *
1250
+ * @path /v1/domain-forwards/{hostname}
1251
+ * @param hostname (path) - Hostname (trailing dot optional)
1252
+ */
1253
+ export type GET_DomainForwardsHostname_Request_Path = GET_DomainForwardsHostname_Request['parameters']['path'];
1254
+
1255
+ /**
1256
+ * Request type for POST DomainForwardsHostname endpoint
1257
+ *
1258
+ * Create a domain forward
1259
+ * Creates a new domain forward configuration for the specified hostname
1260
+ *
1261
+ * @remarks
1262
+ * This type defines the complete request structure for the POST DomainForwardsHostname endpoint.
1263
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1264
+ * Use this type to ensure type safety when making API requests to this endpoint.
1265
+ *
1266
+ * @example
1267
+ * Use this type to ensure type safety when making API requests to this endpoint.
1268
+ *
1269
+ * @path /v1/domain-forwards/{hostname}
1270
+ * @param hostname (path) - Hostname (trailing dot optional)
1271
+ *
1272
+ * @see {@link POST_DomainForwardsHostname_Request_Query} - Query parameters type
1273
+ * @see {@link POST_DomainForwardsHostname_Request_Path} - Path parameters type
1274
+ * @see {@link POST_DomainForwardsHostname_Request_Body} - Request body type
1275
+ */
1276
+ export type POST_DomainForwardsHostname_Request = {
1277
+ parameters: {
1278
+ path: operations['create_domain_forward_v1_domain_forwards__hostname__post']['parameters']['path'];
1279
+ };
1280
+ requestBody: DomainForwardRequest;
1281
+ }
1282
+ /**
1283
+ * Path parameters for POST /v1/domain-forwards/{hostname}
1284
+ *
1285
+ * @remarks
1286
+ * This type defines the path parameters for the POST /v1/domain-forwards/{hostname} endpoint.
1287
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
1288
+ *
1289
+ * @example
1290
+ * Use this type to ensure type safety for path parameters.
1291
+ *
1292
+ * @path /v1/domain-forwards/{hostname}
1293
+ * @param hostname (path) - Hostname (trailing dot optional)
1294
+ */
1295
+ export type POST_DomainForwardsHostname_Request_Path = POST_DomainForwardsHostname_Request['parameters']['path'];
1296
+ /**
1297
+ * Request body for POST /v1/domain-forwards/{hostname}
1298
+ *
1299
+ * @remarks
1300
+ * This type defines the request body structure for the POST /v1/domain-forwards/{hostname} endpoint.
1301
+ * It provides type safety for the request body as defined in the OpenAPI specification.
1302
+ *
1303
+ * @example
1304
+ * Use this type to ensure type safety for request body structure.
1305
+ *
1306
+ * @path /v1/domain-forwards/{hostname}
1307
+ */
1308
+ export type POST_DomainForwardsHostname_Request_Body = POST_DomainForwardsHostname_Request['requestBody'];
1309
+
1310
+ /**
1311
+ * Request type for PATCH DomainForwardsHostnameDisable endpoint
1312
+ *
1313
+ * Disable domain forward
1314
+ * Disables domain forwarding by removing DNS records. The domain forward configuration is preserved but disabled.
1315
+ *
1316
+ * @remarks
1317
+ * This type defines the complete request structure for the PATCH DomainForwardsHostnameDisable endpoint.
1318
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1319
+ * Use this type to ensure type safety when making API requests to this endpoint.
1320
+ *
1321
+ * @example
1322
+ * Use this type to ensure type safety when making API requests to this endpoint.
1323
+ *
1324
+ * @path /v1/domain-forwards/{hostname}/disable
1325
+ * @param hostname (path) - Hostname (trailing dot optional)
1326
+ *
1327
+ * @see {@link PATCH_DomainForwardsHostnameDisable_Request_Query} - Query parameters type
1328
+ * @see {@link PATCH_DomainForwardsHostnameDisable_Request_Path} - Path parameters type
1329
+ * @see {@link PATCH_DomainForwardsHostnameDisable_Request_Body} - Request body type
1330
+ */
1331
+ export type PATCH_DomainForwardsHostnameDisable_Request = {
1332
+ parameters: {
1333
+ path: operations['disable_domain_forward_v1_domain_forwards__hostname__disable_patch']['parameters']['path'];
1334
+ };
1335
+ }
1336
+ /**
1337
+ * Path parameters for PATCH /v1/domain-forwards/{hostname}/disable
1338
+ *
1339
+ * @remarks
1340
+ * This type defines the path parameters for the PATCH /v1/domain-forwards/{hostname}/disable endpoint.
1341
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
1342
+ *
1343
+ * @example
1344
+ * Use this type to ensure type safety for path parameters.
1345
+ *
1346
+ * @path /v1/domain-forwards/{hostname}/disable
1347
+ * @param hostname (path) - Hostname (trailing dot optional)
1348
+ */
1349
+ export type PATCH_DomainForwardsHostnameDisable_Request_Path = PATCH_DomainForwardsHostnameDisable_Request['parameters']['path'];
1350
+
1351
+ /**
1352
+ * Request type for PATCH DomainForwardsHostnameEnable endpoint
1353
+ *
1354
+ * Enable domain forward
1355
+ * Enables domain forwarding by creating necessary DNS records. Optionally auto-creates the zone and domain forward if they don't exist.
1356
+ *
1357
+ * @remarks
1358
+ * This type defines the complete request structure for the PATCH DomainForwardsHostnameEnable endpoint.
1359
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1360
+ * Use this type to ensure type safety when making API requests to this endpoint.
1361
+ *
1362
+ * @example
1363
+ * Use this type to ensure type safety when making API requests to this endpoint.
1364
+ *
1365
+ * @path /v1/domain-forwards/{hostname}/enable
1366
+ * @param hostname (path) - Hostname (trailing dot optional)
1146
1367
  * @param auto_create_zone (query) - Auto create zone if it doesn't exist
1368
+ * @param auto_create_domain_forward (query) - Auto create domain forward if it doesn't exist
1147
1369
  * @param wildcard (query) - Wildcard domain forwarding
1148
1370
  *
1149
- * @see {@link PATCH_DomainForwardsZoneNameEnable_Request_Query} - Query parameters type
1150
- * @see {@link PATCH_DomainForwardsZoneNameEnable_Request_Path} - Path parameters type
1151
- * @see {@link PATCH_DomainForwardsZoneNameEnable_Request_Body} - Request body type
1371
+ * @see {@link PATCH_DomainForwardsHostnameEnable_Request_Query} - Query parameters type
1372
+ * @see {@link PATCH_DomainForwardsHostnameEnable_Request_Path} - Path parameters type
1373
+ * @see {@link PATCH_DomainForwardsHostnameEnable_Request_Body} - Request body type
1152
1374
  */
1153
- export type PATCH_DomainForwardsZoneNameEnable_Request = {
1375
+ export type PATCH_DomainForwardsHostnameEnable_Request = {
1154
1376
  parameters: {
1155
- query: operations['enable_domain_forward_v1_domain_forwards__zone_name__enable_patch']['parameters']['query'];
1156
- path: operations['enable_domain_forward_v1_domain_forwards__zone_name__enable_patch']['parameters']['path'];
1377
+ query: operations['enable_domain_forward_v1_domain_forwards__hostname__enable_patch']['parameters']['query'];
1378
+ path: operations['enable_domain_forward_v1_domain_forwards__hostname__enable_patch']['parameters']['path'];
1157
1379
  };
1158
1380
  }
1159
1381
  /**
1160
- * Query parameters for PATCH /v1/domain-forwards/{zone_name}/enable
1382
+ * Query parameters for PATCH /v1/domain-forwards/{hostname}/enable
1161
1383
  *
1162
1384
  * @remarks
1163
- * This type defines the query parameters for the PATCH /v1/domain-forwards/{zone_name}/enable endpoint.
1385
+ * This type defines the query parameters for the PATCH /v1/domain-forwards/{hostname}/enable endpoint.
1164
1386
  * It provides type safety for all query parameters as defined in the OpenAPI specification.
1165
1387
  *
1166
1388
  * @example
1167
1389
  * Use this type to ensure type safety for query parameters.
1168
1390
  *
1169
- * @path /v1/domain-forwards/{zone_name}/enable
1391
+ * @path /v1/domain-forwards/{hostname}/enable
1170
1392
  * @param auto_create_zone (query) - Auto create zone if it doesn't exist
1393
+ * @param auto_create_domain_forward (query) - Auto create domain forward if it doesn't exist
1171
1394
  * @param wildcard (query) - Wildcard domain forwarding
1172
1395
  */
1173
- export type PATCH_DomainForwardsZoneNameEnable_Request_Query = PATCH_DomainForwardsZoneNameEnable_Request['parameters']['query'];
1396
+ export type PATCH_DomainForwardsHostnameEnable_Request_Query = PATCH_DomainForwardsHostnameEnable_Request['parameters']['query'];
1174
1397
  /**
1175
- * Path parameters for PATCH /v1/domain-forwards/{zone_name}/enable
1398
+ * Path parameters for PATCH /v1/domain-forwards/{hostname}/enable
1176
1399
  *
1177
1400
  * @remarks
1178
- * This type defines the path parameters for the PATCH /v1/domain-forwards/{zone_name}/enable endpoint.
1401
+ * This type defines the path parameters for the PATCH /v1/domain-forwards/{hostname}/enable endpoint.
1179
1402
  * It provides type safety for all path parameters as defined in the OpenAPI specification.
1180
1403
  *
1181
1404
  * @example
1182
1405
  * Use this type to ensure type safety for path parameters.
1183
1406
  *
1184
- * @path /v1/domain-forwards/{zone_name}/enable
1185
- * @param zone_name (path) - DNS zone name (trailing dot optional)
1407
+ * @path /v1/domain-forwards/{hostname}/enable
1408
+ * @param hostname (path) - Hostname (trailing dot optional)
1186
1409
  */
1187
- export type PATCH_DomainForwardsZoneNameEnable_Request_Path = PATCH_DomainForwardsZoneNameEnable_Request['parameters']['path'];
1410
+ export type PATCH_DomainForwardsHostnameEnable_Request_Path = PATCH_DomainForwardsHostnameEnable_Request['parameters']['path'];
1188
1411
 
1189
1412
  /**
1190
- * Request type for DELETE DomainForwardsZoneNameRequestProtocol endpoint
1413
+ * Request type for DELETE DomainForwardsHostnameProtocol endpoint
1191
1414
  *
1192
- * Delete Domain Forward
1415
+ * Delete domain forward set
1416
+ * Deletes a domain forward set for a specific protocol (HTTP or HTTPS).
1193
1417
  *
1194
1418
  * @remarks
1195
- * This type defines the complete request structure for the DELETE DomainForwardsZoneNameRequestProtocol endpoint.
1419
+ * This type defines the complete request structure for the DELETE DomainForwardsHostnameProtocol endpoint.
1196
1420
  * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1197
1421
  * Use this type to ensure type safety when making API requests to this endpoint.
1198
1422
  *
1199
1423
  * @example
1200
1424
  * Use this type to ensure type safety when making API requests to this endpoint.
1201
1425
  *
1202
- * @path /v1/domain-forwards/{zone_name}/{request_protocol}
1203
- * @param zone_name (path) - DNS zone name (trailing dot optional)
1426
+ * @path /v1/domain-forwards/{hostname}/{protocol}
1427
+ * @param hostname (path) - Hostname (trailing dot optional)
1204
1428
  *
1205
- * @see {@link DELETE_DomainForwardsZoneNameRequestProtocol_Request_Query} - Query parameters type
1206
- * @see {@link DELETE_DomainForwardsZoneNameRequestProtocol_Request_Path} - Path parameters type
1207
- * @see {@link DELETE_DomainForwardsZoneNameRequestProtocol_Request_Body} - Request body type
1429
+ * @see {@link DELETE_DomainForwardsHostnameProtocol_Request_Query} - Query parameters type
1430
+ * @see {@link DELETE_DomainForwardsHostnameProtocol_Request_Path} - Path parameters type
1431
+ * @see {@link DELETE_DomainForwardsHostnameProtocol_Request_Body} - Request body type
1208
1432
  */
1209
- export type DELETE_DomainForwardsZoneNameRequestProtocol_Request = {
1433
+ export type DELETE_DomainForwardsHostnameProtocol_Request = {
1210
1434
  parameters: {
1211
- path: operations['delete_domain_forward_v1_domain_forwards__zone_name___request_protocol__delete']['parameters']['path'];
1435
+ path: operations['delete_domain_forward_set_v1_domain_forwards__hostname___protocol__delete']['parameters']['path'];
1212
1436
  };
1213
1437
  }
1214
1438
  /**
1215
- * Path parameters for DELETE /v1/domain-forwards/{zone_name}/{request_protocol}
1439
+ * Path parameters for DELETE /v1/domain-forwards/{hostname}/{protocol}
1216
1440
  *
1217
1441
  * @remarks
1218
- * This type defines the path parameters for the DELETE /v1/domain-forwards/{zone_name}/{request_protocol} endpoint.
1442
+ * This type defines the path parameters for the DELETE /v1/domain-forwards/{hostname}/{protocol} endpoint.
1219
1443
  * It provides type safety for all path parameters as defined in the OpenAPI specification.
1220
1444
  *
1221
1445
  * @example
1222
1446
  * Use this type to ensure type safety for path parameters.
1223
1447
  *
1224
- * @path /v1/domain-forwards/{zone_name}/{request_protocol}
1225
- * @param zone_name (path) - DNS zone name (trailing dot optional)
1448
+ * @path /v1/domain-forwards/{hostname}/{protocol}
1449
+ * @param hostname (path) - Hostname (trailing dot optional)
1226
1450
  */
1227
- export type DELETE_DomainForwardsZoneNameRequestProtocol_Request_Path = DELETE_DomainForwardsZoneNameRequestProtocol_Request['parameters']['path'];
1451
+ export type DELETE_DomainForwardsHostnameProtocol_Request_Path = DELETE_DomainForwardsHostnameProtocol_Request['parameters']['path'];
1228
1452
 
1229
1453
  /**
1230
- * Request type for GET DomainForwardsZoneNameRequestProtocol endpoint
1454
+ * Request type for GET DomainForwardsHostnameProtocol endpoint
1231
1455
  *
1232
- * Get Domain Forward
1456
+ * Get domain forward set
1457
+ * Retrieves all redirects for a specific protocol (HTTP or HTTPS) for the specified hostname
1233
1458
  *
1234
1459
  * @remarks
1235
- * This type defines the complete request structure for the GET DomainForwardsZoneNameRequestProtocol endpoint.
1460
+ * This type defines the complete request structure for the GET DomainForwardsHostnameProtocol endpoint.
1236
1461
  * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1237
1462
  * Use this type to ensure type safety when making API requests to this endpoint.
1238
1463
  *
1239
1464
  * @example
1240
1465
  * Use this type to ensure type safety when making API requests to this endpoint.
1241
1466
  *
1242
- * @path /v1/domain-forwards/{zone_name}/{request_protocol}
1243
- * @param zone_name (path) - DNS zone name (trailing dot optional)
1467
+ * @path /v1/domain-forwards/{hostname}/{protocol}
1468
+ * @param hostname (path) - Hostname (trailing dot optional)
1244
1469
  *
1245
- * @see {@link GET_DomainForwardsZoneNameRequestProtocol_Request_Query} - Query parameters type
1246
- * @see {@link GET_DomainForwardsZoneNameRequestProtocol_Request_Path} - Path parameters type
1247
- * @see {@link GET_DomainForwardsZoneNameRequestProtocol_Request_Body} - Request body type
1470
+ * @see {@link GET_DomainForwardsHostnameProtocol_Request_Query} - Query parameters type
1471
+ * @see {@link GET_DomainForwardsHostnameProtocol_Request_Path} - Path parameters type
1472
+ * @see {@link GET_DomainForwardsHostnameProtocol_Request_Body} - Request body type
1248
1473
  */
1249
- export type GET_DomainForwardsZoneNameRequestProtocol_Request = {
1474
+ export type GET_DomainForwardsHostnameProtocol_Request = {
1250
1475
  parameters: {
1251
- path: operations['get_domain_forward_v1_domain_forwards__zone_name___request_protocol__get']['parameters']['path'];
1476
+ path: operations['get_domain_forward_set_v1_domain_forwards__hostname___protocol__get']['parameters']['path'];
1252
1477
  };
1253
1478
  }
1254
1479
  /**
1255
- * Path parameters for GET /v1/domain-forwards/{zone_name}/{request_protocol}
1480
+ * Path parameters for GET /v1/domain-forwards/{hostname}/{protocol}
1256
1481
  *
1257
1482
  * @remarks
1258
- * This type defines the path parameters for the GET /v1/domain-forwards/{zone_name}/{request_protocol} endpoint.
1483
+ * This type defines the path parameters for the GET /v1/domain-forwards/{hostname}/{protocol} endpoint.
1259
1484
  * It provides type safety for all path parameters as defined in the OpenAPI specification.
1260
1485
  *
1261
1486
  * @example
1262
1487
  * Use this type to ensure type safety for path parameters.
1263
1488
  *
1264
- * @path /v1/domain-forwards/{zone_name}/{request_protocol}
1265
- * @param zone_name (path) - DNS zone name (trailing dot optional)
1489
+ * @path /v1/domain-forwards/{hostname}/{protocol}
1490
+ * @param hostname (path) - Hostname (trailing dot optional)
1266
1491
  */
1267
- export type GET_DomainForwardsZoneNameRequestProtocol_Request_Path = GET_DomainForwardsZoneNameRequestProtocol_Request['parameters']['path'];
1492
+ export type GET_DomainForwardsHostnameProtocol_Request_Path = GET_DomainForwardsHostnameProtocol_Request['parameters']['path'];
1268
1493
 
1269
1494
  /**
1270
- * Request type for POST DomainForwardsZoneNameRequestProtocol endpoint
1495
+ * Request type for POST DomainForwardsHostnameProtocol endpoint
1271
1496
  *
1272
- * Create Domain Forward
1497
+ * Create domain forward set
1498
+ * Creates a new domain forward set for a specific protocol (HTTP or HTTPS). Raises an error if the set already exists.
1273
1499
  *
1274
1500
  * @remarks
1275
- * This type defines the complete request structure for the POST DomainForwardsZoneNameRequestProtocol endpoint.
1501
+ * This type defines the complete request structure for the POST DomainForwardsHostnameProtocol endpoint.
1276
1502
  * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1277
1503
  * Use this type to ensure type safety when making API requests to this endpoint.
1278
1504
  *
1279
1505
  * @example
1280
1506
  * Use this type to ensure type safety when making API requests to this endpoint.
1281
1507
  *
1282
- * @path /v1/domain-forwards/{zone_name}/{request_protocol}
1283
- * @param zone_name (path) - DNS zone name (trailing dot optional)
1508
+ * @path /v1/domain-forwards/{hostname}/{protocol}
1509
+ * @param hostname (path) - Hostname (trailing dot optional)
1284
1510
  *
1285
- * @see {@link POST_DomainForwardsZoneNameRequestProtocol_Request_Query} - Query parameters type
1286
- * @see {@link POST_DomainForwardsZoneNameRequestProtocol_Request_Path} - Path parameters type
1287
- * @see {@link POST_DomainForwardsZoneNameRequestProtocol_Request_Body} - Request body type
1511
+ * @see {@link POST_DomainForwardsHostnameProtocol_Request_Query} - Query parameters type
1512
+ * @see {@link POST_DomainForwardsHostnameProtocol_Request_Path} - Path parameters type
1513
+ * @see {@link POST_DomainForwardsHostnameProtocol_Request_Body} - Request body type
1288
1514
  */
1289
- export type POST_DomainForwardsZoneNameRequestProtocol_Request = {
1515
+ export type POST_DomainForwardsHostnameProtocol_Request = {
1290
1516
  parameters: {
1291
- path: operations['create_domain_forward_v1_domain_forwards__zone_name___request_protocol__post']['parameters']['path'];
1517
+ path: operations['create_domain_forward_set_v1_domain_forwards__hostname___protocol__post']['parameters']['path'];
1292
1518
  };
1293
- requestBody: DomainForwardRequest;
1519
+ requestBody: DomainForwardSetRequest;
1294
1520
  }
1295
1521
  /**
1296
- * Path parameters for POST /v1/domain-forwards/{zone_name}/{request_protocol}
1522
+ * Path parameters for POST /v1/domain-forwards/{hostname}/{protocol}
1297
1523
  *
1298
1524
  * @remarks
1299
- * This type defines the path parameters for the POST /v1/domain-forwards/{zone_name}/{request_protocol} endpoint.
1525
+ * This type defines the path parameters for the POST /v1/domain-forwards/{hostname}/{protocol} endpoint.
1300
1526
  * It provides type safety for all path parameters as defined in the OpenAPI specification.
1301
1527
  *
1302
1528
  * @example
1303
1529
  * Use this type to ensure type safety for path parameters.
1304
1530
  *
1305
- * @path /v1/domain-forwards/{zone_name}/{request_protocol}
1306
- * @param zone_name (path) - DNS zone name (trailing dot optional)
1531
+ * @path /v1/domain-forwards/{hostname}/{protocol}
1532
+ * @param hostname (path) - Hostname (trailing dot optional)
1307
1533
  */
1308
- export type POST_DomainForwardsZoneNameRequestProtocol_Request_Path = POST_DomainForwardsZoneNameRequestProtocol_Request['parameters']['path'];
1534
+ export type POST_DomainForwardsHostnameProtocol_Request_Path = POST_DomainForwardsHostnameProtocol_Request['parameters']['path'];
1309
1535
  /**
1310
- * Request body for POST /v1/domain-forwards/{zone_name}/{request_protocol}
1536
+ * Request body for POST /v1/domain-forwards/{hostname}/{protocol}
1311
1537
  *
1312
1538
  * @remarks
1313
- * This type defines the request body structure for the POST /v1/domain-forwards/{zone_name}/{request_protocol} endpoint.
1539
+ * This type defines the request body structure for the POST /v1/domain-forwards/{hostname}/{protocol} endpoint.
1314
1540
  * It provides type safety for the request body as defined in the OpenAPI specification.
1315
1541
  *
1316
1542
  * @example
1317
1543
  * Use this type to ensure type safety for request body structure.
1318
1544
  *
1319
- * @path /v1/domain-forwards/{zone_name}/{request_protocol}
1545
+ * @path /v1/domain-forwards/{hostname}/{protocol}
1320
1546
  */
1321
- export type POST_DomainForwardsZoneNameRequestProtocol_Request_Body = POST_DomainForwardsZoneNameRequestProtocol_Request['requestBody'];
1547
+ export type POST_DomainForwardsHostnameProtocol_Request_Body = POST_DomainForwardsHostnameProtocol_Request['requestBody'];
1322
1548
 
1323
1549
  /**
1324
- * Request type for PUT DomainForwardsZoneNameRequestProtocol endpoint
1550
+ * Request type for PUT DomainForwardsHostnameProtocol endpoint
1325
1551
  *
1326
- * Update Domain Forward
1552
+ * Update domain forward set
1553
+ * Updates an existing domain forward set for a specific protocol (HTTP or HTTPS). All existing redirects for this protocol are replaced with the provided redirects. Raises an error if the set does not exist.
1327
1554
  *
1328
1555
  * @remarks
1329
- * This type defines the complete request structure for the PUT DomainForwardsZoneNameRequestProtocol endpoint.
1556
+ * This type defines the complete request structure for the PUT DomainForwardsHostnameProtocol endpoint.
1330
1557
  * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1331
1558
  * Use this type to ensure type safety when making API requests to this endpoint.
1332
1559
  *
1333
1560
  * @example
1334
1561
  * Use this type to ensure type safety when making API requests to this endpoint.
1335
1562
  *
1336
- * @path /v1/domain-forwards/{zone_name}/{request_protocol}
1337
- * @param zone_name (path) - DNS zone name (trailing dot optional)
1563
+ * @path /v1/domain-forwards/{hostname}/{protocol}
1564
+ * @param hostname (path) - Hostname (trailing dot optional)
1338
1565
  *
1339
- * @see {@link PUT_DomainForwardsZoneNameRequestProtocol_Request_Query} - Query parameters type
1340
- * @see {@link PUT_DomainForwardsZoneNameRequestProtocol_Request_Path} - Path parameters type
1341
- * @see {@link PUT_DomainForwardsZoneNameRequestProtocol_Request_Body} - Request body type
1566
+ * @see {@link PUT_DomainForwardsHostnameProtocol_Request_Query} - Query parameters type
1567
+ * @see {@link PUT_DomainForwardsHostnameProtocol_Request_Path} - Path parameters type
1568
+ * @see {@link PUT_DomainForwardsHostnameProtocol_Request_Body} - Request body type
1342
1569
  */
1343
- export type PUT_DomainForwardsZoneNameRequestProtocol_Request = {
1570
+ export type PUT_DomainForwardsHostnameProtocol_Request = {
1344
1571
  parameters: {
1345
- path: operations['update_domain_forward_v1_domain_forwards__zone_name___request_protocol__put']['parameters']['path'];
1572
+ path: operations['update_domain_forward_set_v1_domain_forwards__hostname___protocol__put']['parameters']['path'];
1346
1573
  };
1347
- requestBody: DomainForwardRequest;
1574
+ requestBody: DomainForwardSetRequest;
1348
1575
  }
1349
1576
  /**
1350
- * Path parameters for PUT /v1/domain-forwards/{zone_name}/{request_protocol}
1577
+ * Path parameters for PUT /v1/domain-forwards/{hostname}/{protocol}
1351
1578
  *
1352
1579
  * @remarks
1353
- * This type defines the path parameters for the PUT /v1/domain-forwards/{zone_name}/{request_protocol} endpoint.
1580
+ * This type defines the path parameters for the PUT /v1/domain-forwards/{hostname}/{protocol} endpoint.
1354
1581
  * It provides type safety for all path parameters as defined in the OpenAPI specification.
1355
1582
  *
1356
1583
  * @example
1357
1584
  * Use this type to ensure type safety for path parameters.
1358
1585
  *
1359
- * @path /v1/domain-forwards/{zone_name}/{request_protocol}
1360
- * @param zone_name (path) - DNS zone name (trailing dot optional)
1586
+ * @path /v1/domain-forwards/{hostname}/{protocol}
1587
+ * @param hostname (path) - Hostname (trailing dot optional)
1361
1588
  */
1362
- export type PUT_DomainForwardsZoneNameRequestProtocol_Request_Path = PUT_DomainForwardsZoneNameRequestProtocol_Request['parameters']['path'];
1589
+ export type PUT_DomainForwardsHostnameProtocol_Request_Path = PUT_DomainForwardsHostnameProtocol_Request['parameters']['path'];
1363
1590
  /**
1364
- * Request body for PUT /v1/domain-forwards/{zone_name}/{request_protocol}
1591
+ * Request body for PUT /v1/domain-forwards/{hostname}/{protocol}
1365
1592
  *
1366
1593
  * @remarks
1367
- * This type defines the request body structure for the PUT /v1/domain-forwards/{zone_name}/{request_protocol} endpoint.
1594
+ * This type defines the request body structure for the PUT /v1/domain-forwards/{hostname}/{protocol} endpoint.
1368
1595
  * It provides type safety for the request body as defined in the OpenAPI specification.
1369
1596
  *
1370
1597
  * @example
1371
1598
  * Use this type to ensure type safety for request body structure.
1372
1599
  *
1373
- * @path /v1/domain-forwards/{zone_name}/{request_protocol}
1600
+ * @path /v1/domain-forwards/{hostname}/{protocol}
1374
1601
  */
1375
- export type PUT_DomainForwardsZoneNameRequestProtocol_Request_Body = PUT_DomainForwardsZoneNameRequestProtocol_Request['requestBody'];
1602
+ export type PUT_DomainForwardsHostnameProtocol_Request_Body = PUT_DomainForwardsHostnameProtocol_Request['requestBody'];
1376
1603
 
1377
1604
  /**
1378
1605
  * Request type for GET DomainSearchSuggest endpoint