@opusdns/api 0.92.0 → 0.94.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -34,7 +34,7 @@ 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
@@ -1017,7 +1017,8 @@ export type PUT_DnsZoneNameRrsets_Request_Body = PUT_DnsZoneNameRrsets_Request['
1017
1017
  /**
1018
1018
  * Request type for GET DomainForwards endpoint
1019
1019
  *
1020
- * List Domain Forwards
1020
+ * List domain forwards
1021
+ * Retrieves a paginated list of domain forwards for the organization
1021
1022
  *
1022
1023
  * @remarks
1023
1024
  * This type defines the complete request structure for the GET DomainForwards endpoint.
@@ -1055,7 +1056,8 @@ export type GET_DomainForwards_Request_Query = GET_DomainForwards_Request['param
1055
1056
  /**
1056
1057
  * Request type for PATCH DomainForwards endpoint
1057
1058
  *
1058
- * Patch Redirects
1059
+ * Patch domain forward redirects
1060
+ * 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
1061
  *
1060
1062
  * @remarks
1061
1063
  * This type defines the complete request structure for the PATCH DomainForwards endpoint.
@@ -1089,290 +1091,435 @@ export type PATCH_DomainForwards_Request = {
1089
1091
  export type PATCH_DomainForwards_Request_Body = PATCH_DomainForwards_Request['requestBody'];
1090
1092
 
1091
1093
  /**
1092
- * Request type for PATCH DomainForwardsZoneNameDisable endpoint
1094
+ * Request type for DELETE DomainForwardsHostname endpoint
1093
1095
  *
1094
- * Disable Domain Forward
1096
+ * Delete a domain forward
1097
+ * Deletes the domain forward configuration for the specified hostname
1095
1098
  *
1096
1099
  * @remarks
1097
- * This type defines the complete request structure for the PATCH DomainForwardsZoneNameDisable endpoint.
1100
+ * This type defines the complete request structure for the DELETE DomainForwardsHostname endpoint.
1098
1101
  * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1099
1102
  * Use this type to ensure type safety when making API requests to this endpoint.
1100
1103
  *
1101
1104
  * @example
1102
1105
  * Use this type to ensure type safety when making API requests to this endpoint.
1103
1106
  *
1104
- * @path /v1/domain-forwards/{zone_name}/disable
1105
- * @param zone_name (path) - DNS zone name (trailing dot optional)
1107
+ * @path /v1/domain-forwards/{hostname}
1108
+ * @param hostname (path) - Hostname (trailing dot optional)
1106
1109
  *
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
1110
+ * @see {@link DELETE_DomainForwardsHostname_Request_Query} - Query parameters type
1111
+ * @see {@link DELETE_DomainForwardsHostname_Request_Path} - Path parameters type
1112
+ * @see {@link DELETE_DomainForwardsHostname_Request_Body} - Request body type
1110
1113
  */
1111
- export type PATCH_DomainForwardsZoneNameDisable_Request = {
1114
+ export type DELETE_DomainForwardsHostname_Request = {
1112
1115
  parameters: {
1113
- path: operations['disable_domain_forward_v1_domain_forwards__zone_name__disable_patch']['parameters']['path'];
1116
+ path: operations['delete_domain_forward_v1_domain_forwards__hostname__delete']['parameters']['path'];
1114
1117
  };
1115
1118
  }
1116
1119
  /**
1117
- * Path parameters for PATCH /v1/domain-forwards/{zone_name}/disable
1120
+ * Path parameters for DELETE /v1/domain-forwards/{hostname}
1118
1121
  *
1119
1122
  * @remarks
1120
- * This type defines the path parameters for the PATCH /v1/domain-forwards/{zone_name}/disable endpoint.
1123
+ * This type defines the path parameters for the DELETE /v1/domain-forwards/{hostname} endpoint.
1121
1124
  * It provides type safety for all path parameters as defined in the OpenAPI specification.
1122
1125
  *
1123
1126
  * @example
1124
1127
  * Use this type to ensure type safety for path parameters.
1125
1128
  *
1126
- * @path /v1/domain-forwards/{zone_name}/disable
1127
- * @param zone_name (path) - DNS zone name (trailing dot optional)
1129
+ * @path /v1/domain-forwards/{hostname}
1130
+ * @param hostname (path) - Hostname (trailing dot optional)
1128
1131
  */
1129
- export type PATCH_DomainForwardsZoneNameDisable_Request_Path = PATCH_DomainForwardsZoneNameDisable_Request['parameters']['path'];
1132
+ export type DELETE_DomainForwardsHostname_Request_Path = DELETE_DomainForwardsHostname_Request['parameters']['path'];
1130
1133
 
1131
1134
  /**
1132
- * Request type for PATCH DomainForwardsZoneNameEnable endpoint
1135
+ * Request type for GET DomainForwardsHostname endpoint
1133
1136
  *
1134
- * Enable Domain Forward
1137
+ * Get a domain forward
1138
+ * Retrieves the domain forward configuration for the specified hostname
1135
1139
  *
1136
1140
  * @remarks
1137
- * This type defines the complete request structure for the PATCH DomainForwardsZoneNameEnable endpoint.
1141
+ * This type defines the complete request structure for the GET DomainForwardsHostname endpoint.
1138
1142
  * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1139
1143
  * Use this type to ensure type safety when making API requests to this endpoint.
1140
1144
  *
1141
1145
  * @example
1142
1146
  * Use this type to ensure type safety when making API requests to this endpoint.
1143
1147
  *
1144
- * @path /v1/domain-forwards/{zone_name}/enable
1145
- * @param zone_name (path) - DNS zone name (trailing dot optional)
1148
+ * @path /v1/domain-forwards/{hostname}
1149
+ * @param hostname (path) - Hostname (trailing dot optional)
1150
+ *
1151
+ * @see {@link GET_DomainForwardsHostname_Request_Query} - Query parameters type
1152
+ * @see {@link GET_DomainForwardsHostname_Request_Path} - Path parameters type
1153
+ * @see {@link GET_DomainForwardsHostname_Request_Body} - Request body type
1154
+ */
1155
+ export type GET_DomainForwardsHostname_Request = {
1156
+ parameters: {
1157
+ path: operations['get_domain_forward_v1_domain_forwards__hostname__get']['parameters']['path'];
1158
+ };
1159
+ }
1160
+ /**
1161
+ * Path parameters for GET /v1/domain-forwards/{hostname}
1162
+ *
1163
+ * @remarks
1164
+ * This type defines the path parameters for the GET /v1/domain-forwards/{hostname} endpoint.
1165
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
1166
+ *
1167
+ * @example
1168
+ * Use this type to ensure type safety for path parameters.
1169
+ *
1170
+ * @path /v1/domain-forwards/{hostname}
1171
+ * @param hostname (path) - Hostname (trailing dot optional)
1172
+ */
1173
+ export type GET_DomainForwardsHostname_Request_Path = GET_DomainForwardsHostname_Request['parameters']['path'];
1174
+
1175
+ /**
1176
+ * Request type for POST DomainForwardsHostname endpoint
1177
+ *
1178
+ * Create a domain forward
1179
+ * Creates a new domain forward configuration for the specified hostname
1180
+ *
1181
+ * @remarks
1182
+ * This type defines the complete request structure for the POST DomainForwardsHostname endpoint.
1183
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1184
+ * Use this type to ensure type safety when making API requests to this endpoint.
1185
+ *
1186
+ * @example
1187
+ * Use this type to ensure type safety when making API requests to this endpoint.
1188
+ *
1189
+ * @path /v1/domain-forwards/{hostname}
1190
+ * @param hostname (path) - Hostname (trailing dot optional)
1191
+ *
1192
+ * @see {@link POST_DomainForwardsHostname_Request_Query} - Query parameters type
1193
+ * @see {@link POST_DomainForwardsHostname_Request_Path} - Path parameters type
1194
+ * @see {@link POST_DomainForwardsHostname_Request_Body} - Request body type
1195
+ */
1196
+ export type POST_DomainForwardsHostname_Request = {
1197
+ parameters: {
1198
+ path: operations['create_domain_forward_v1_domain_forwards__hostname__post']['parameters']['path'];
1199
+ };
1200
+ requestBody: DomainForwardRequest;
1201
+ }
1202
+ /**
1203
+ * Path parameters for POST /v1/domain-forwards/{hostname}
1204
+ *
1205
+ * @remarks
1206
+ * This type defines the path parameters for the POST /v1/domain-forwards/{hostname} endpoint.
1207
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
1208
+ *
1209
+ * @example
1210
+ * Use this type to ensure type safety for path parameters.
1211
+ *
1212
+ * @path /v1/domain-forwards/{hostname}
1213
+ * @param hostname (path) - Hostname (trailing dot optional)
1214
+ */
1215
+ export type POST_DomainForwardsHostname_Request_Path = POST_DomainForwardsHostname_Request['parameters']['path'];
1216
+ /**
1217
+ * Request body for POST /v1/domain-forwards/{hostname}
1218
+ *
1219
+ * @remarks
1220
+ * This type defines the request body structure for the POST /v1/domain-forwards/{hostname} endpoint.
1221
+ * It provides type safety for the request body as defined in the OpenAPI specification.
1222
+ *
1223
+ * @example
1224
+ * Use this type to ensure type safety for request body structure.
1225
+ *
1226
+ * @path /v1/domain-forwards/{hostname}
1227
+ */
1228
+ export type POST_DomainForwardsHostname_Request_Body = POST_DomainForwardsHostname_Request['requestBody'];
1229
+
1230
+ /**
1231
+ * Request type for PATCH DomainForwardsHostnameDisable endpoint
1232
+ *
1233
+ * Disable domain forward
1234
+ * Disables domain forwarding by removing DNS records. The domain forward configuration is preserved but disabled.
1235
+ *
1236
+ * @remarks
1237
+ * This type defines the complete request structure for the PATCH DomainForwardsHostnameDisable endpoint.
1238
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1239
+ * Use this type to ensure type safety when making API requests to this endpoint.
1240
+ *
1241
+ * @example
1242
+ * Use this type to ensure type safety when making API requests to this endpoint.
1243
+ *
1244
+ * @path /v1/domain-forwards/{hostname}/disable
1245
+ * @param hostname (path) - Hostname (trailing dot optional)
1246
+ *
1247
+ * @see {@link PATCH_DomainForwardsHostnameDisable_Request_Query} - Query parameters type
1248
+ * @see {@link PATCH_DomainForwardsHostnameDisable_Request_Path} - Path parameters type
1249
+ * @see {@link PATCH_DomainForwardsHostnameDisable_Request_Body} - Request body type
1250
+ */
1251
+ export type PATCH_DomainForwardsHostnameDisable_Request = {
1252
+ parameters: {
1253
+ path: operations['disable_domain_forward_v1_domain_forwards__hostname__disable_patch']['parameters']['path'];
1254
+ };
1255
+ }
1256
+ /**
1257
+ * Path parameters for PATCH /v1/domain-forwards/{hostname}/disable
1258
+ *
1259
+ * @remarks
1260
+ * This type defines the path parameters for the PATCH /v1/domain-forwards/{hostname}/disable endpoint.
1261
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
1262
+ *
1263
+ * @example
1264
+ * Use this type to ensure type safety for path parameters.
1265
+ *
1266
+ * @path /v1/domain-forwards/{hostname}/disable
1267
+ * @param hostname (path) - Hostname (trailing dot optional)
1268
+ */
1269
+ export type PATCH_DomainForwardsHostnameDisable_Request_Path = PATCH_DomainForwardsHostnameDisable_Request['parameters']['path'];
1270
+
1271
+ /**
1272
+ * Request type for PATCH DomainForwardsHostnameEnable endpoint
1273
+ *
1274
+ * Enable domain forward
1275
+ * Enables domain forwarding by creating necessary DNS records. Optionally auto-creates the zone and domain forward if they don't exist.
1276
+ *
1277
+ * @remarks
1278
+ * This type defines the complete request structure for the PATCH DomainForwardsHostnameEnable endpoint.
1279
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1280
+ * Use this type to ensure type safety when making API requests to this endpoint.
1281
+ *
1282
+ * @example
1283
+ * Use this type to ensure type safety when making API requests to this endpoint.
1284
+ *
1285
+ * @path /v1/domain-forwards/{hostname}/enable
1286
+ * @param hostname (path) - Hostname (trailing dot optional)
1146
1287
  * @param auto_create_zone (query) - Auto create zone if it doesn't exist
1288
+ * @param auto_create_domain_forward (query) - Auto create domain forward if it doesn't exist
1147
1289
  * @param wildcard (query) - Wildcard domain forwarding
1148
1290
  *
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
1291
+ * @see {@link PATCH_DomainForwardsHostnameEnable_Request_Query} - Query parameters type
1292
+ * @see {@link PATCH_DomainForwardsHostnameEnable_Request_Path} - Path parameters type
1293
+ * @see {@link PATCH_DomainForwardsHostnameEnable_Request_Body} - Request body type
1152
1294
  */
1153
- export type PATCH_DomainForwardsZoneNameEnable_Request = {
1295
+ export type PATCH_DomainForwardsHostnameEnable_Request = {
1154
1296
  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'];
1297
+ query: operations['enable_domain_forward_v1_domain_forwards__hostname__enable_patch']['parameters']['query'];
1298
+ path: operations['enable_domain_forward_v1_domain_forwards__hostname__enable_patch']['parameters']['path'];
1157
1299
  };
1158
1300
  }
1159
1301
  /**
1160
- * Query parameters for PATCH /v1/domain-forwards/{zone_name}/enable
1302
+ * Query parameters for PATCH /v1/domain-forwards/{hostname}/enable
1161
1303
  *
1162
1304
  * @remarks
1163
- * This type defines the query parameters for the PATCH /v1/domain-forwards/{zone_name}/enable endpoint.
1305
+ * This type defines the query parameters for the PATCH /v1/domain-forwards/{hostname}/enable endpoint.
1164
1306
  * It provides type safety for all query parameters as defined in the OpenAPI specification.
1165
1307
  *
1166
1308
  * @example
1167
1309
  * Use this type to ensure type safety for query parameters.
1168
1310
  *
1169
- * @path /v1/domain-forwards/{zone_name}/enable
1311
+ * @path /v1/domain-forwards/{hostname}/enable
1170
1312
  * @param auto_create_zone (query) - Auto create zone if it doesn't exist
1313
+ * @param auto_create_domain_forward (query) - Auto create domain forward if it doesn't exist
1171
1314
  * @param wildcard (query) - Wildcard domain forwarding
1172
1315
  */
1173
- export type PATCH_DomainForwardsZoneNameEnable_Request_Query = PATCH_DomainForwardsZoneNameEnable_Request['parameters']['query'];
1316
+ export type PATCH_DomainForwardsHostnameEnable_Request_Query = PATCH_DomainForwardsHostnameEnable_Request['parameters']['query'];
1174
1317
  /**
1175
- * Path parameters for PATCH /v1/domain-forwards/{zone_name}/enable
1318
+ * Path parameters for PATCH /v1/domain-forwards/{hostname}/enable
1176
1319
  *
1177
1320
  * @remarks
1178
- * This type defines the path parameters for the PATCH /v1/domain-forwards/{zone_name}/enable endpoint.
1321
+ * This type defines the path parameters for the PATCH /v1/domain-forwards/{hostname}/enable endpoint.
1179
1322
  * It provides type safety for all path parameters as defined in the OpenAPI specification.
1180
1323
  *
1181
1324
  * @example
1182
1325
  * Use this type to ensure type safety for path parameters.
1183
1326
  *
1184
- * @path /v1/domain-forwards/{zone_name}/enable
1185
- * @param zone_name (path) - DNS zone name (trailing dot optional)
1327
+ * @path /v1/domain-forwards/{hostname}/enable
1328
+ * @param hostname (path) - Hostname (trailing dot optional)
1186
1329
  */
1187
- export type PATCH_DomainForwardsZoneNameEnable_Request_Path = PATCH_DomainForwardsZoneNameEnable_Request['parameters']['path'];
1330
+ export type PATCH_DomainForwardsHostnameEnable_Request_Path = PATCH_DomainForwardsHostnameEnable_Request['parameters']['path'];
1188
1331
 
1189
1332
  /**
1190
- * Request type for DELETE DomainForwardsZoneNameRequestProtocol endpoint
1333
+ * Request type for DELETE DomainForwardsHostnameProtocol endpoint
1191
1334
  *
1192
- * Delete Domain Forward
1335
+ * Delete domain forward set
1336
+ * Deletes a domain forward set for a specific protocol (HTTP or HTTPS).
1193
1337
  *
1194
1338
  * @remarks
1195
- * This type defines the complete request structure for the DELETE DomainForwardsZoneNameRequestProtocol endpoint.
1339
+ * This type defines the complete request structure for the DELETE DomainForwardsHostnameProtocol endpoint.
1196
1340
  * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1197
1341
  * Use this type to ensure type safety when making API requests to this endpoint.
1198
1342
  *
1199
1343
  * @example
1200
1344
  * Use this type to ensure type safety when making API requests to this endpoint.
1201
1345
  *
1202
- * @path /v1/domain-forwards/{zone_name}/{request_protocol}
1203
- * @param zone_name (path) - DNS zone name (trailing dot optional)
1346
+ * @path /v1/domain-forwards/{hostname}/{protocol}
1347
+ * @param hostname (path) - Hostname (trailing dot optional)
1204
1348
  *
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
1349
+ * @see {@link DELETE_DomainForwardsHostnameProtocol_Request_Query} - Query parameters type
1350
+ * @see {@link DELETE_DomainForwardsHostnameProtocol_Request_Path} - Path parameters type
1351
+ * @see {@link DELETE_DomainForwardsHostnameProtocol_Request_Body} - Request body type
1208
1352
  */
1209
- export type DELETE_DomainForwardsZoneNameRequestProtocol_Request = {
1353
+ export type DELETE_DomainForwardsHostnameProtocol_Request = {
1210
1354
  parameters: {
1211
- path: operations['delete_domain_forward_v1_domain_forwards__zone_name___request_protocol__delete']['parameters']['path'];
1355
+ path: operations['delete_domain_forward_set_v1_domain_forwards__hostname___protocol__delete']['parameters']['path'];
1212
1356
  };
1213
1357
  }
1214
1358
  /**
1215
- * Path parameters for DELETE /v1/domain-forwards/{zone_name}/{request_protocol}
1359
+ * Path parameters for DELETE /v1/domain-forwards/{hostname}/{protocol}
1216
1360
  *
1217
1361
  * @remarks
1218
- * This type defines the path parameters for the DELETE /v1/domain-forwards/{zone_name}/{request_protocol} endpoint.
1362
+ * This type defines the path parameters for the DELETE /v1/domain-forwards/{hostname}/{protocol} endpoint.
1219
1363
  * It provides type safety for all path parameters as defined in the OpenAPI specification.
1220
1364
  *
1221
1365
  * @example
1222
1366
  * Use this type to ensure type safety for path parameters.
1223
1367
  *
1224
- * @path /v1/domain-forwards/{zone_name}/{request_protocol}
1225
- * @param zone_name (path) - DNS zone name (trailing dot optional)
1368
+ * @path /v1/domain-forwards/{hostname}/{protocol}
1369
+ * @param hostname (path) - Hostname (trailing dot optional)
1226
1370
  */
1227
- export type DELETE_DomainForwardsZoneNameRequestProtocol_Request_Path = DELETE_DomainForwardsZoneNameRequestProtocol_Request['parameters']['path'];
1371
+ export type DELETE_DomainForwardsHostnameProtocol_Request_Path = DELETE_DomainForwardsHostnameProtocol_Request['parameters']['path'];
1228
1372
 
1229
1373
  /**
1230
- * Request type for GET DomainForwardsZoneNameRequestProtocol endpoint
1374
+ * Request type for GET DomainForwardsHostnameProtocol endpoint
1231
1375
  *
1232
- * Get Domain Forward
1376
+ * Get domain forward set
1377
+ * Retrieves all redirects for a specific protocol (HTTP or HTTPS) for the specified hostname
1233
1378
  *
1234
1379
  * @remarks
1235
- * This type defines the complete request structure for the GET DomainForwardsZoneNameRequestProtocol endpoint.
1380
+ * This type defines the complete request structure for the GET DomainForwardsHostnameProtocol endpoint.
1236
1381
  * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1237
1382
  * Use this type to ensure type safety when making API requests to this endpoint.
1238
1383
  *
1239
1384
  * @example
1240
1385
  * Use this type to ensure type safety when making API requests to this endpoint.
1241
1386
  *
1242
- * @path /v1/domain-forwards/{zone_name}/{request_protocol}
1243
- * @param zone_name (path) - DNS zone name (trailing dot optional)
1387
+ * @path /v1/domain-forwards/{hostname}/{protocol}
1388
+ * @param hostname (path) - Hostname (trailing dot optional)
1244
1389
  *
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
1390
+ * @see {@link GET_DomainForwardsHostnameProtocol_Request_Query} - Query parameters type
1391
+ * @see {@link GET_DomainForwardsHostnameProtocol_Request_Path} - Path parameters type
1392
+ * @see {@link GET_DomainForwardsHostnameProtocol_Request_Body} - Request body type
1248
1393
  */
1249
- export type GET_DomainForwardsZoneNameRequestProtocol_Request = {
1394
+ export type GET_DomainForwardsHostnameProtocol_Request = {
1250
1395
  parameters: {
1251
- path: operations['get_domain_forward_v1_domain_forwards__zone_name___request_protocol__get']['parameters']['path'];
1396
+ path: operations['get_domain_forward_set_v1_domain_forwards__hostname___protocol__get']['parameters']['path'];
1252
1397
  };
1253
1398
  }
1254
1399
  /**
1255
- * Path parameters for GET /v1/domain-forwards/{zone_name}/{request_protocol}
1400
+ * Path parameters for GET /v1/domain-forwards/{hostname}/{protocol}
1256
1401
  *
1257
1402
  * @remarks
1258
- * This type defines the path parameters for the GET /v1/domain-forwards/{zone_name}/{request_protocol} endpoint.
1403
+ * This type defines the path parameters for the GET /v1/domain-forwards/{hostname}/{protocol} endpoint.
1259
1404
  * It provides type safety for all path parameters as defined in the OpenAPI specification.
1260
1405
  *
1261
1406
  * @example
1262
1407
  * Use this type to ensure type safety for path parameters.
1263
1408
  *
1264
- * @path /v1/domain-forwards/{zone_name}/{request_protocol}
1265
- * @param zone_name (path) - DNS zone name (trailing dot optional)
1409
+ * @path /v1/domain-forwards/{hostname}/{protocol}
1410
+ * @param hostname (path) - Hostname (trailing dot optional)
1266
1411
  */
1267
- export type GET_DomainForwardsZoneNameRequestProtocol_Request_Path = GET_DomainForwardsZoneNameRequestProtocol_Request['parameters']['path'];
1412
+ export type GET_DomainForwardsHostnameProtocol_Request_Path = GET_DomainForwardsHostnameProtocol_Request['parameters']['path'];
1268
1413
 
1269
1414
  /**
1270
- * Request type for POST DomainForwardsZoneNameRequestProtocol endpoint
1415
+ * Request type for POST DomainForwardsHostnameProtocol endpoint
1271
1416
  *
1272
- * Create Domain Forward
1417
+ * Create domain forward set
1418
+ * Creates a new domain forward set for a specific protocol (HTTP or HTTPS). Raises an error if the set already exists.
1273
1419
  *
1274
1420
  * @remarks
1275
- * This type defines the complete request structure for the POST DomainForwardsZoneNameRequestProtocol endpoint.
1421
+ * This type defines the complete request structure for the POST DomainForwardsHostnameProtocol endpoint.
1276
1422
  * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1277
1423
  * Use this type to ensure type safety when making API requests to this endpoint.
1278
1424
  *
1279
1425
  * @example
1280
1426
  * Use this type to ensure type safety when making API requests to this endpoint.
1281
1427
  *
1282
- * @path /v1/domain-forwards/{zone_name}/{request_protocol}
1283
- * @param zone_name (path) - DNS zone name (trailing dot optional)
1428
+ * @path /v1/domain-forwards/{hostname}/{protocol}
1429
+ * @param hostname (path) - Hostname (trailing dot optional)
1284
1430
  *
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
1431
+ * @see {@link POST_DomainForwardsHostnameProtocol_Request_Query} - Query parameters type
1432
+ * @see {@link POST_DomainForwardsHostnameProtocol_Request_Path} - Path parameters type
1433
+ * @see {@link POST_DomainForwardsHostnameProtocol_Request_Body} - Request body type
1288
1434
  */
1289
- export type POST_DomainForwardsZoneNameRequestProtocol_Request = {
1435
+ export type POST_DomainForwardsHostnameProtocol_Request = {
1290
1436
  parameters: {
1291
- path: operations['create_domain_forward_v1_domain_forwards__zone_name___request_protocol__post']['parameters']['path'];
1437
+ path: operations['create_domain_forward_set_v1_domain_forwards__hostname___protocol__post']['parameters']['path'];
1292
1438
  };
1293
- requestBody: DomainForwardRequest;
1439
+ requestBody: DomainForwardSetRequest;
1294
1440
  }
1295
1441
  /**
1296
- * Path parameters for POST /v1/domain-forwards/{zone_name}/{request_protocol}
1442
+ * Path parameters for POST /v1/domain-forwards/{hostname}/{protocol}
1297
1443
  *
1298
1444
  * @remarks
1299
- * This type defines the path parameters for the POST /v1/domain-forwards/{zone_name}/{request_protocol} endpoint.
1445
+ * This type defines the path parameters for the POST /v1/domain-forwards/{hostname}/{protocol} endpoint.
1300
1446
  * It provides type safety for all path parameters as defined in the OpenAPI specification.
1301
1447
  *
1302
1448
  * @example
1303
1449
  * Use this type to ensure type safety for path parameters.
1304
1450
  *
1305
- * @path /v1/domain-forwards/{zone_name}/{request_protocol}
1306
- * @param zone_name (path) - DNS zone name (trailing dot optional)
1451
+ * @path /v1/domain-forwards/{hostname}/{protocol}
1452
+ * @param hostname (path) - Hostname (trailing dot optional)
1307
1453
  */
1308
- export type POST_DomainForwardsZoneNameRequestProtocol_Request_Path = POST_DomainForwardsZoneNameRequestProtocol_Request['parameters']['path'];
1454
+ export type POST_DomainForwardsHostnameProtocol_Request_Path = POST_DomainForwardsHostnameProtocol_Request['parameters']['path'];
1309
1455
  /**
1310
- * Request body for POST /v1/domain-forwards/{zone_name}/{request_protocol}
1456
+ * Request body for POST /v1/domain-forwards/{hostname}/{protocol}
1311
1457
  *
1312
1458
  * @remarks
1313
- * This type defines the request body structure for the POST /v1/domain-forwards/{zone_name}/{request_protocol} endpoint.
1459
+ * This type defines the request body structure for the POST /v1/domain-forwards/{hostname}/{protocol} endpoint.
1314
1460
  * It provides type safety for the request body as defined in the OpenAPI specification.
1315
1461
  *
1316
1462
  * @example
1317
1463
  * Use this type to ensure type safety for request body structure.
1318
1464
  *
1319
- * @path /v1/domain-forwards/{zone_name}/{request_protocol}
1465
+ * @path /v1/domain-forwards/{hostname}/{protocol}
1320
1466
  */
1321
- export type POST_DomainForwardsZoneNameRequestProtocol_Request_Body = POST_DomainForwardsZoneNameRequestProtocol_Request['requestBody'];
1467
+ export type POST_DomainForwardsHostnameProtocol_Request_Body = POST_DomainForwardsHostnameProtocol_Request['requestBody'];
1322
1468
 
1323
1469
  /**
1324
- * Request type for PUT DomainForwardsZoneNameRequestProtocol endpoint
1470
+ * Request type for PUT DomainForwardsHostnameProtocol endpoint
1325
1471
  *
1326
- * Update Domain Forward
1472
+ * Update domain forward set
1473
+ * 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
1474
  *
1328
1475
  * @remarks
1329
- * This type defines the complete request structure for the PUT DomainForwardsZoneNameRequestProtocol endpoint.
1476
+ * This type defines the complete request structure for the PUT DomainForwardsHostnameProtocol endpoint.
1330
1477
  * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
1331
1478
  * Use this type to ensure type safety when making API requests to this endpoint.
1332
1479
  *
1333
1480
  * @example
1334
1481
  * Use this type to ensure type safety when making API requests to this endpoint.
1335
1482
  *
1336
- * @path /v1/domain-forwards/{zone_name}/{request_protocol}
1337
- * @param zone_name (path) - DNS zone name (trailing dot optional)
1483
+ * @path /v1/domain-forwards/{hostname}/{protocol}
1484
+ * @param hostname (path) - Hostname (trailing dot optional)
1338
1485
  *
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
1486
+ * @see {@link PUT_DomainForwardsHostnameProtocol_Request_Query} - Query parameters type
1487
+ * @see {@link PUT_DomainForwardsHostnameProtocol_Request_Path} - Path parameters type
1488
+ * @see {@link PUT_DomainForwardsHostnameProtocol_Request_Body} - Request body type
1342
1489
  */
1343
- export type PUT_DomainForwardsZoneNameRequestProtocol_Request = {
1490
+ export type PUT_DomainForwardsHostnameProtocol_Request = {
1344
1491
  parameters: {
1345
- path: operations['update_domain_forward_v1_domain_forwards__zone_name___request_protocol__put']['parameters']['path'];
1492
+ path: operations['update_domain_forward_set_v1_domain_forwards__hostname___protocol__put']['parameters']['path'];
1346
1493
  };
1347
- requestBody: DomainForwardRequest;
1494
+ requestBody: DomainForwardSetRequest;
1348
1495
  }
1349
1496
  /**
1350
- * Path parameters for PUT /v1/domain-forwards/{zone_name}/{request_protocol}
1497
+ * Path parameters for PUT /v1/domain-forwards/{hostname}/{protocol}
1351
1498
  *
1352
1499
  * @remarks
1353
- * This type defines the path parameters for the PUT /v1/domain-forwards/{zone_name}/{request_protocol} endpoint.
1500
+ * This type defines the path parameters for the PUT /v1/domain-forwards/{hostname}/{protocol} endpoint.
1354
1501
  * It provides type safety for all path parameters as defined in the OpenAPI specification.
1355
1502
  *
1356
1503
  * @example
1357
1504
  * Use this type to ensure type safety for path parameters.
1358
1505
  *
1359
- * @path /v1/domain-forwards/{zone_name}/{request_protocol}
1360
- * @param zone_name (path) - DNS zone name (trailing dot optional)
1506
+ * @path /v1/domain-forwards/{hostname}/{protocol}
1507
+ * @param hostname (path) - Hostname (trailing dot optional)
1361
1508
  */
1362
- export type PUT_DomainForwardsZoneNameRequestProtocol_Request_Path = PUT_DomainForwardsZoneNameRequestProtocol_Request['parameters']['path'];
1509
+ export type PUT_DomainForwardsHostnameProtocol_Request_Path = PUT_DomainForwardsHostnameProtocol_Request['parameters']['path'];
1363
1510
  /**
1364
- * Request body for PUT /v1/domain-forwards/{zone_name}/{request_protocol}
1511
+ * Request body for PUT /v1/domain-forwards/{hostname}/{protocol}
1365
1512
  *
1366
1513
  * @remarks
1367
- * This type defines the request body structure for the PUT /v1/domain-forwards/{zone_name}/{request_protocol} endpoint.
1514
+ * This type defines the request body structure for the PUT /v1/domain-forwards/{hostname}/{protocol} endpoint.
1368
1515
  * It provides type safety for the request body as defined in the OpenAPI specification.
1369
1516
  *
1370
1517
  * @example
1371
1518
  * Use this type to ensure type safety for request body structure.
1372
1519
  *
1373
- * @path /v1/domain-forwards/{zone_name}/{request_protocol}
1520
+ * @path /v1/domain-forwards/{hostname}/{protocol}
1374
1521
  */
1375
- export type PUT_DomainForwardsZoneNameRequestProtocol_Request_Body = PUT_DomainForwardsZoneNameRequestProtocol_Request['requestBody'];
1522
+ export type PUT_DomainForwardsHostnameProtocol_Request_Body = PUT_DomainForwardsHostnameProtocol_Request['requestBody'];
1376
1523
 
1377
1524
  /**
1378
1525
  * Request type for GET DomainSearchSuggest endpoint