@opusdns/api 0.86.0 → 0.88.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/src/helpers/constants.ts +74 -1
- package/src/helpers/keys.ts +527 -865
- package/src/helpers/requests.d.ts +147 -158
- package/src/helpers/responses.d.ts +139 -100
- package/src/helpers/schemas-arrays.d.ts +15 -43
- package/src/helpers/schemas.d.ts +70 -102
- package/src/openapi.yaml +224 -247
- package/src/schema.d.ts +171 -181
|
@@ -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,
|
|
37
|
+
import { ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainForwardRequest, 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
|
|
@@ -1015,336 +1015,286 @@ export type PUT_DnsZoneNameRrsets_Request_Path = PUT_DnsZoneNameRrsets_Request['
|
|
|
1015
1015
|
export type PUT_DnsZoneNameRrsets_Request_Body = PUT_DnsZoneNameRrsets_Request['requestBody'];
|
|
1016
1016
|
|
|
1017
1017
|
/**
|
|
1018
|
-
* Request type for PATCH
|
|
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
|
|
1018
|
+
* Request type for PATCH DomainForwardsZoneNameDisable endpoint
|
|
1055
1019
|
*
|
|
1056
|
-
*
|
|
1020
|
+
* Disable Domain Forward
|
|
1057
1021
|
*
|
|
1058
1022
|
* @remarks
|
|
1059
|
-
* This type defines the complete request structure for the
|
|
1023
|
+
* This type defines the complete request structure for the PATCH DomainForwardsZoneNameDisable endpoint.
|
|
1060
1024
|
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
1061
1025
|
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
1062
1026
|
*
|
|
1063
1027
|
* @example
|
|
1064
1028
|
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
1065
1029
|
*
|
|
1066
|
-
* @path /v1/domain-forwards/{zone_name}
|
|
1030
|
+
* @path /v1/domain-forwards/{zone_name}/disable
|
|
1067
1031
|
* @param zone_name (path) - DNS zone name (trailing dot optional)
|
|
1068
1032
|
*
|
|
1069
|
-
* @see {@link
|
|
1070
|
-
* @see {@link
|
|
1071
|
-
* @see {@link
|
|
1033
|
+
* @see {@link PATCH_DomainForwardsZoneNameDisable_Request_Query} - Query parameters type
|
|
1034
|
+
* @see {@link PATCH_DomainForwardsZoneNameDisable_Request_Path} - Path parameters type
|
|
1035
|
+
* @see {@link PATCH_DomainForwardsZoneNameDisable_Request_Body} - Request body type
|
|
1072
1036
|
*/
|
|
1073
|
-
export type
|
|
1037
|
+
export type PATCH_DomainForwardsZoneNameDisable_Request = {
|
|
1074
1038
|
parameters: {
|
|
1075
|
-
path: operations['
|
|
1039
|
+
path: operations['disable_domain_forward_v1_domain_forwards__zone_name__disable_patch']['parameters']['path'];
|
|
1076
1040
|
};
|
|
1077
1041
|
}
|
|
1078
1042
|
/**
|
|
1079
|
-
* Path parameters for
|
|
1043
|
+
* Path parameters for PATCH /v1/domain-forwards/{zone_name}/disable
|
|
1080
1044
|
*
|
|
1081
1045
|
* @remarks
|
|
1082
|
-
* This type defines the path parameters for the
|
|
1046
|
+
* This type defines the path parameters for the PATCH /v1/domain-forwards/{zone_name}/disable endpoint.
|
|
1083
1047
|
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
1084
1048
|
*
|
|
1085
1049
|
* @example
|
|
1086
1050
|
* Use this type to ensure type safety for path parameters.
|
|
1087
1051
|
*
|
|
1088
|
-
* @path /v1/domain-forwards/{zone_name}
|
|
1052
|
+
* @path /v1/domain-forwards/{zone_name}/disable
|
|
1089
1053
|
* @param zone_name (path) - DNS zone name (trailing dot optional)
|
|
1090
1054
|
*/
|
|
1091
|
-
export type
|
|
1055
|
+
export type PATCH_DomainForwardsZoneNameDisable_Request_Path = PATCH_DomainForwardsZoneNameDisable_Request['parameters']['path'];
|
|
1092
1056
|
|
|
1093
1057
|
/**
|
|
1094
|
-
* Request type for
|
|
1058
|
+
* Request type for PATCH DomainForwardsZoneNameEnable endpoint
|
|
1095
1059
|
*
|
|
1096
|
-
*
|
|
1060
|
+
* Enable Domain Forward
|
|
1097
1061
|
*
|
|
1098
1062
|
* @remarks
|
|
1099
|
-
* This type defines the complete request structure for the
|
|
1063
|
+
* This type defines the complete request structure for the PATCH DomainForwardsZoneNameEnable endpoint.
|
|
1100
1064
|
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
1101
1065
|
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
1102
1066
|
*
|
|
1103
1067
|
* @example
|
|
1104
1068
|
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
1105
1069
|
*
|
|
1106
|
-
* @path /v1/domain-forwards/{zone_name}
|
|
1070
|
+
* @path /v1/domain-forwards/{zone_name}/enable
|
|
1107
1071
|
* @param zone_name (path) - DNS zone name (trailing dot optional)
|
|
1108
1072
|
*
|
|
1109
|
-
* @see {@link
|
|
1110
|
-
* @see {@link
|
|
1111
|
-
* @see {@link
|
|
1073
|
+
* @see {@link PATCH_DomainForwardsZoneNameEnable_Request_Query} - Query parameters type
|
|
1074
|
+
* @see {@link PATCH_DomainForwardsZoneNameEnable_Request_Path} - Path parameters type
|
|
1075
|
+
* @see {@link PATCH_DomainForwardsZoneNameEnable_Request_Body} - Request body type
|
|
1112
1076
|
*/
|
|
1113
|
-
export type
|
|
1077
|
+
export type PATCH_DomainForwardsZoneNameEnable_Request = {
|
|
1114
1078
|
parameters: {
|
|
1115
|
-
query: operations['
|
|
1116
|
-
path: operations['
|
|
1079
|
+
query: operations['enable_domain_forward_v1_domain_forwards__zone_name__enable_patch']['parameters']['query'];
|
|
1080
|
+
path: operations['enable_domain_forward_v1_domain_forwards__zone_name__enable_patch']['parameters']['path'];
|
|
1117
1081
|
};
|
|
1118
1082
|
}
|
|
1119
1083
|
/**
|
|
1120
|
-
* Query parameters for
|
|
1084
|
+
* Query parameters for PATCH /v1/domain-forwards/{zone_name}/enable
|
|
1121
1085
|
*
|
|
1122
1086
|
* @remarks
|
|
1123
|
-
* This type defines the query parameters for the
|
|
1087
|
+
* This type defines the query parameters for the PATCH /v1/domain-forwards/{zone_name}/enable endpoint.
|
|
1124
1088
|
* It provides type safety for all query parameters as defined in the OpenAPI specification.
|
|
1125
1089
|
*
|
|
1126
1090
|
* @example
|
|
1127
1091
|
* Use this type to ensure type safety for query parameters.
|
|
1128
1092
|
*
|
|
1129
|
-
* @path /v1/domain-forwards/{zone_name}
|
|
1093
|
+
* @path /v1/domain-forwards/{zone_name}/enable
|
|
1130
1094
|
*/
|
|
1131
|
-
export type
|
|
1095
|
+
export type PATCH_DomainForwardsZoneNameEnable_Request_Query = PATCH_DomainForwardsZoneNameEnable_Request['parameters']['query'];
|
|
1132
1096
|
/**
|
|
1133
|
-
* Path parameters for
|
|
1097
|
+
* Path parameters for PATCH /v1/domain-forwards/{zone_name}/enable
|
|
1134
1098
|
*
|
|
1135
1099
|
* @remarks
|
|
1136
|
-
* This type defines the path parameters for the
|
|
1100
|
+
* This type defines the path parameters for the PATCH /v1/domain-forwards/{zone_name}/enable endpoint.
|
|
1137
1101
|
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
1138
1102
|
*
|
|
1139
1103
|
* @example
|
|
1140
1104
|
* Use this type to ensure type safety for path parameters.
|
|
1141
1105
|
*
|
|
1142
|
-
* @path /v1/domain-forwards/{zone_name}
|
|
1106
|
+
* @path /v1/domain-forwards/{zone_name}/enable
|
|
1143
1107
|
* @param zone_name (path) - DNS zone name (trailing dot optional)
|
|
1144
1108
|
*/
|
|
1145
|
-
export type
|
|
1109
|
+
export type PATCH_DomainForwardsZoneNameEnable_Request_Path = PATCH_DomainForwardsZoneNameEnable_Request['parameters']['path'];
|
|
1146
1110
|
|
|
1147
1111
|
/**
|
|
1148
|
-
* Request type for
|
|
1112
|
+
* Request type for DELETE DomainForwardsZoneNameRequestProtocol endpoint
|
|
1149
1113
|
*
|
|
1150
|
-
*
|
|
1114
|
+
* Delete Domain Forward
|
|
1151
1115
|
*
|
|
1152
1116
|
* @remarks
|
|
1153
|
-
* This type defines the complete request structure for the
|
|
1117
|
+
* This type defines the complete request structure for the DELETE DomainForwardsZoneNameRequestProtocol endpoint.
|
|
1154
1118
|
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
1155
1119
|
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
1156
1120
|
*
|
|
1157
1121
|
* @example
|
|
1158
1122
|
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
1159
1123
|
*
|
|
1160
|
-
* @path /v1/domain-forwards/{zone_name}
|
|
1124
|
+
* @path /v1/domain-forwards/{zone_name}/{request_protocol}
|
|
1161
1125
|
* @param zone_name (path) - DNS zone name (trailing dot optional)
|
|
1162
1126
|
*
|
|
1163
|
-
* @see {@link
|
|
1164
|
-
* @see {@link
|
|
1165
|
-
* @see {@link
|
|
1127
|
+
* @see {@link DELETE_DomainForwardsZoneNameRequestProtocol_Request_Query} - Query parameters type
|
|
1128
|
+
* @see {@link DELETE_DomainForwardsZoneNameRequestProtocol_Request_Path} - Path parameters type
|
|
1129
|
+
* @see {@link DELETE_DomainForwardsZoneNameRequestProtocol_Request_Body} - Request body type
|
|
1166
1130
|
*/
|
|
1167
|
-
export type
|
|
1131
|
+
export type DELETE_DomainForwardsZoneNameRequestProtocol_Request = {
|
|
1168
1132
|
parameters: {
|
|
1169
|
-
path: operations['
|
|
1133
|
+
path: operations['delete_domain_forward_v1_domain_forwards__zone_name___request_protocol__delete']['parameters']['path'];
|
|
1170
1134
|
};
|
|
1171
|
-
requestBody: RedirectSet;
|
|
1172
1135
|
}
|
|
1173
1136
|
/**
|
|
1174
|
-
* Path parameters for
|
|
1137
|
+
* Path parameters for DELETE /v1/domain-forwards/{zone_name}/{request_protocol}
|
|
1175
1138
|
*
|
|
1176
1139
|
* @remarks
|
|
1177
|
-
* This type defines the path parameters for the
|
|
1140
|
+
* This type defines the path parameters for the DELETE /v1/domain-forwards/{zone_name}/{request_protocol} endpoint.
|
|
1178
1141
|
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
1179
1142
|
*
|
|
1180
1143
|
* @example
|
|
1181
1144
|
* Use this type to ensure type safety for path parameters.
|
|
1182
1145
|
*
|
|
1183
|
-
* @path /v1/domain-forwards/{zone_name}
|
|
1146
|
+
* @path /v1/domain-forwards/{zone_name}/{request_protocol}
|
|
1184
1147
|
* @param zone_name (path) - DNS zone name (trailing dot optional)
|
|
1185
1148
|
*/
|
|
1186
|
-
export type
|
|
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'];
|
|
1149
|
+
export type DELETE_DomainForwardsZoneNameRequestProtocol_Request_Path = DELETE_DomainForwardsZoneNameRequestProtocol_Request['parameters']['path'];
|
|
1200
1150
|
|
|
1201
1151
|
/**
|
|
1202
|
-
* Request type for
|
|
1152
|
+
* Request type for GET DomainForwardsZoneNameRequestProtocol endpoint
|
|
1203
1153
|
*
|
|
1204
|
-
*
|
|
1154
|
+
* Get Domain Forward
|
|
1205
1155
|
*
|
|
1206
1156
|
* @remarks
|
|
1207
|
-
* This type defines the complete request structure for the
|
|
1157
|
+
* This type defines the complete request structure for the GET DomainForwardsZoneNameRequestProtocol endpoint.
|
|
1208
1158
|
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
1209
1159
|
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
1210
1160
|
*
|
|
1211
1161
|
* @example
|
|
1212
1162
|
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
1213
1163
|
*
|
|
1214
|
-
* @path /v1/domain-forwards/{zone_name}
|
|
1164
|
+
* @path /v1/domain-forwards/{zone_name}/{request_protocol}
|
|
1215
1165
|
* @param zone_name (path) - DNS zone name (trailing dot optional)
|
|
1216
1166
|
*
|
|
1217
|
-
* @see {@link
|
|
1218
|
-
* @see {@link
|
|
1219
|
-
* @see {@link
|
|
1167
|
+
* @see {@link GET_DomainForwardsZoneNameRequestProtocol_Request_Query} - Query parameters type
|
|
1168
|
+
* @see {@link GET_DomainForwardsZoneNameRequestProtocol_Request_Path} - Path parameters type
|
|
1169
|
+
* @see {@link GET_DomainForwardsZoneNameRequestProtocol_Request_Body} - Request body type
|
|
1220
1170
|
*/
|
|
1221
|
-
export type
|
|
1171
|
+
export type GET_DomainForwardsZoneNameRequestProtocol_Request = {
|
|
1222
1172
|
parameters: {
|
|
1223
|
-
path: operations['
|
|
1173
|
+
path: operations['get_domain_forward_v1_domain_forwards__zone_name___request_protocol__get']['parameters']['path'];
|
|
1224
1174
|
};
|
|
1225
|
-
requestBody: RedirectSet;
|
|
1226
1175
|
}
|
|
1227
1176
|
/**
|
|
1228
|
-
* Path parameters for
|
|
1177
|
+
* Path parameters for GET /v1/domain-forwards/{zone_name}/{request_protocol}
|
|
1229
1178
|
*
|
|
1230
1179
|
* @remarks
|
|
1231
|
-
* This type defines the path parameters for the
|
|
1180
|
+
* This type defines the path parameters for the GET /v1/domain-forwards/{zone_name}/{request_protocol} endpoint.
|
|
1232
1181
|
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
1233
1182
|
*
|
|
1234
1183
|
* @example
|
|
1235
1184
|
* Use this type to ensure type safety for path parameters.
|
|
1236
1185
|
*
|
|
1237
|
-
* @path /v1/domain-forwards/{zone_name}
|
|
1186
|
+
* @path /v1/domain-forwards/{zone_name}/{request_protocol}
|
|
1238
1187
|
* @param zone_name (path) - DNS zone name (trailing dot optional)
|
|
1239
1188
|
*/
|
|
1240
|
-
export type
|
|
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'];
|
|
1189
|
+
export type GET_DomainForwardsZoneNameRequestProtocol_Request_Path = GET_DomainForwardsZoneNameRequestProtocol_Request['parameters']['path'];
|
|
1254
1190
|
|
|
1255
1191
|
/**
|
|
1256
|
-
* Request type for
|
|
1192
|
+
* Request type for POST DomainForwardsZoneNameRequestProtocol endpoint
|
|
1257
1193
|
*
|
|
1258
|
-
*
|
|
1194
|
+
* Create Domain Forward
|
|
1259
1195
|
*
|
|
1260
1196
|
* @remarks
|
|
1261
|
-
* This type defines the complete request structure for the
|
|
1197
|
+
* This type defines the complete request structure for the POST DomainForwardsZoneNameRequestProtocol endpoint.
|
|
1262
1198
|
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
1263
1199
|
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
1264
1200
|
*
|
|
1265
1201
|
* @example
|
|
1266
1202
|
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
1267
1203
|
*
|
|
1268
|
-
* @path /v1/domain-forwards/{zone_name}/
|
|
1204
|
+
* @path /v1/domain-forwards/{zone_name}/{request_protocol}
|
|
1269
1205
|
* @param zone_name (path) - DNS zone name (trailing dot optional)
|
|
1270
1206
|
*
|
|
1271
|
-
* @see {@link
|
|
1272
|
-
* @see {@link
|
|
1273
|
-
* @see {@link
|
|
1207
|
+
* @see {@link POST_DomainForwardsZoneNameRequestProtocol_Request_Query} - Query parameters type
|
|
1208
|
+
* @see {@link POST_DomainForwardsZoneNameRequestProtocol_Request_Path} - Path parameters type
|
|
1209
|
+
* @see {@link POST_DomainForwardsZoneNameRequestProtocol_Request_Body} - Request body type
|
|
1274
1210
|
*/
|
|
1275
|
-
export type
|
|
1211
|
+
export type POST_DomainForwardsZoneNameRequestProtocol_Request = {
|
|
1276
1212
|
parameters: {
|
|
1277
|
-
path: operations['
|
|
1213
|
+
path: operations['create_domain_forward_v1_domain_forwards__zone_name___request_protocol__post']['parameters']['path'];
|
|
1278
1214
|
};
|
|
1215
|
+
requestBody: DomainForwardRequest;
|
|
1279
1216
|
}
|
|
1280
1217
|
/**
|
|
1281
|
-
* Path parameters for
|
|
1218
|
+
* Path parameters for POST /v1/domain-forwards/{zone_name}/{request_protocol}
|
|
1282
1219
|
*
|
|
1283
1220
|
* @remarks
|
|
1284
|
-
* This type defines the path parameters for the
|
|
1221
|
+
* This type defines the path parameters for the POST /v1/domain-forwards/{zone_name}/{request_protocol} endpoint.
|
|
1285
1222
|
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
1286
1223
|
*
|
|
1287
1224
|
* @example
|
|
1288
1225
|
* Use this type to ensure type safety for path parameters.
|
|
1289
1226
|
*
|
|
1290
|
-
* @path /v1/domain-forwards/{zone_name}/
|
|
1227
|
+
* @path /v1/domain-forwards/{zone_name}/{request_protocol}
|
|
1291
1228
|
* @param zone_name (path) - DNS zone name (trailing dot optional)
|
|
1292
1229
|
*/
|
|
1293
|
-
export type
|
|
1230
|
+
export type POST_DomainForwardsZoneNameRequestProtocol_Request_Path = POST_DomainForwardsZoneNameRequestProtocol_Request['parameters']['path'];
|
|
1231
|
+
/**
|
|
1232
|
+
* Request body for POST /v1/domain-forwards/{zone_name}/{request_protocol}
|
|
1233
|
+
*
|
|
1234
|
+
* @remarks
|
|
1235
|
+
* This type defines the request body structure for the POST /v1/domain-forwards/{zone_name}/{request_protocol} endpoint.
|
|
1236
|
+
* It provides type safety for the request body as defined in the OpenAPI specification.
|
|
1237
|
+
*
|
|
1238
|
+
* @example
|
|
1239
|
+
* Use this type to ensure type safety for request body structure.
|
|
1240
|
+
*
|
|
1241
|
+
* @path /v1/domain-forwards/{zone_name}/{request_protocol}
|
|
1242
|
+
*/
|
|
1243
|
+
export type POST_DomainForwardsZoneNameRequestProtocol_Request_Body = POST_DomainForwardsZoneNameRequestProtocol_Request['requestBody'];
|
|
1294
1244
|
|
|
1295
1245
|
/**
|
|
1296
|
-
* Request type for
|
|
1246
|
+
* Request type for PUT DomainForwardsZoneNameRequestProtocol endpoint
|
|
1297
1247
|
*
|
|
1298
|
-
*
|
|
1248
|
+
* Update Domain Forward
|
|
1299
1249
|
*
|
|
1300
1250
|
* @remarks
|
|
1301
|
-
* This type defines the complete request structure for the
|
|
1251
|
+
* This type defines the complete request structure for the PUT DomainForwardsZoneNameRequestProtocol endpoint.
|
|
1302
1252
|
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
1303
1253
|
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
1304
1254
|
*
|
|
1305
1255
|
* @example
|
|
1306
1256
|
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
1307
1257
|
*
|
|
1308
|
-
* @path /v1/domain-forwards/{zone_name}/
|
|
1258
|
+
* @path /v1/domain-forwards/{zone_name}/{request_protocol}
|
|
1309
1259
|
* @param zone_name (path) - DNS zone name (trailing dot optional)
|
|
1310
1260
|
*
|
|
1311
|
-
* @see {@link
|
|
1312
|
-
* @see {@link
|
|
1313
|
-
* @see {@link
|
|
1261
|
+
* @see {@link PUT_DomainForwardsZoneNameRequestProtocol_Request_Query} - Query parameters type
|
|
1262
|
+
* @see {@link PUT_DomainForwardsZoneNameRequestProtocol_Request_Path} - Path parameters type
|
|
1263
|
+
* @see {@link PUT_DomainForwardsZoneNameRequestProtocol_Request_Body} - Request body type
|
|
1314
1264
|
*/
|
|
1315
|
-
export type
|
|
1265
|
+
export type PUT_DomainForwardsZoneNameRequestProtocol_Request = {
|
|
1316
1266
|
parameters: {
|
|
1317
|
-
|
|
1318
|
-
path: operations['enable_domain_forward_v1_domain_forwards__zone_name__enable_patch']['parameters']['path'];
|
|
1267
|
+
path: operations['update_domain_forward_v1_domain_forwards__zone_name___request_protocol__put']['parameters']['path'];
|
|
1319
1268
|
};
|
|
1269
|
+
requestBody: DomainForwardRequest;
|
|
1320
1270
|
}
|
|
1321
1271
|
/**
|
|
1322
|
-
*
|
|
1272
|
+
* Path parameters for PUT /v1/domain-forwards/{zone_name}/{request_protocol}
|
|
1323
1273
|
*
|
|
1324
1274
|
* @remarks
|
|
1325
|
-
* This type defines the
|
|
1326
|
-
* It provides type safety for all
|
|
1275
|
+
* This type defines the path parameters for the PUT /v1/domain-forwards/{zone_name}/{request_protocol} endpoint.
|
|
1276
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
1327
1277
|
*
|
|
1328
1278
|
* @example
|
|
1329
|
-
* Use this type to ensure type safety for
|
|
1279
|
+
* Use this type to ensure type safety for path parameters.
|
|
1330
1280
|
*
|
|
1331
|
-
* @path /v1/domain-forwards/{zone_name}/
|
|
1281
|
+
* @path /v1/domain-forwards/{zone_name}/{request_protocol}
|
|
1282
|
+
* @param zone_name (path) - DNS zone name (trailing dot optional)
|
|
1332
1283
|
*/
|
|
1333
|
-
export type
|
|
1284
|
+
export type PUT_DomainForwardsZoneNameRequestProtocol_Request_Path = PUT_DomainForwardsZoneNameRequestProtocol_Request['parameters']['path'];
|
|
1334
1285
|
/**
|
|
1335
|
-
*
|
|
1286
|
+
* Request body for PUT /v1/domain-forwards/{zone_name}/{request_protocol}
|
|
1336
1287
|
*
|
|
1337
1288
|
* @remarks
|
|
1338
|
-
* This type defines the
|
|
1339
|
-
* It provides type safety for
|
|
1289
|
+
* This type defines the request body structure for the PUT /v1/domain-forwards/{zone_name}/{request_protocol} endpoint.
|
|
1290
|
+
* It provides type safety for the request body as defined in the OpenAPI specification.
|
|
1340
1291
|
*
|
|
1341
1292
|
* @example
|
|
1342
|
-
* Use this type to ensure type safety for
|
|
1293
|
+
* Use this type to ensure type safety for request body structure.
|
|
1343
1294
|
*
|
|
1344
|
-
* @path /v1/domain-forwards/{zone_name}/
|
|
1345
|
-
* @param zone_name (path) - DNS zone name (trailing dot optional)
|
|
1295
|
+
* @path /v1/domain-forwards/{zone_name}/{request_protocol}
|
|
1346
1296
|
*/
|
|
1347
|
-
export type
|
|
1297
|
+
export type PUT_DomainForwardsZoneNameRequestProtocol_Request_Body = PUT_DomainForwardsZoneNameRequestProtocol_Request['requestBody'];
|
|
1348
1298
|
|
|
1349
1299
|
/**
|
|
1350
1300
|
* Request type for GET DomainSearchSuggest endpoint
|
|
@@ -3377,6 +3327,45 @@ export type GET_OrganizationsUsers_Request = {
|
|
|
3377
3327
|
*/
|
|
3378
3328
|
export type GET_OrganizationsUsers_Request_Query = GET_OrganizationsUsers_Request['parameters']['query'];
|
|
3379
3329
|
|
|
3330
|
+
/**
|
|
3331
|
+
* Request type for GET Tlds endpoint
|
|
3332
|
+
*
|
|
3333
|
+
* Get list of Specifications for all TLDs we support
|
|
3334
|
+
* Retrieves a list of TLD Specifications we have support for
|
|
3335
|
+
*
|
|
3336
|
+
* @remarks
|
|
3337
|
+
* This type defines the complete request structure for the GET Tlds endpoint.
|
|
3338
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
3339
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
3340
|
+
*
|
|
3341
|
+
* @example
|
|
3342
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
3343
|
+
*
|
|
3344
|
+
* @path /v1/tlds/
|
|
3345
|
+
*
|
|
3346
|
+
* @see {@link GET_Tlds_Request_Query} - Query parameters type
|
|
3347
|
+
* @see {@link GET_Tlds_Request_Path} - Path parameters type
|
|
3348
|
+
* @see {@link GET_Tlds_Request_Body} - Request body type
|
|
3349
|
+
*/
|
|
3350
|
+
export type GET_Tlds_Request = {
|
|
3351
|
+
parameters: {
|
|
3352
|
+
query: operations['get_tld_specifications_v1_tlds__get']['parameters']['query'];
|
|
3353
|
+
};
|
|
3354
|
+
}
|
|
3355
|
+
/**
|
|
3356
|
+
* Query parameters for GET /v1/tlds/
|
|
3357
|
+
*
|
|
3358
|
+
* @remarks
|
|
3359
|
+
* This type defines the query parameters for the GET /v1/tlds/ endpoint.
|
|
3360
|
+
* It provides type safety for all query parameters as defined in the OpenAPI specification.
|
|
3361
|
+
*
|
|
3362
|
+
* @example
|
|
3363
|
+
* Use this type to ensure type safety for query parameters.
|
|
3364
|
+
*
|
|
3365
|
+
* @path /v1/tlds/
|
|
3366
|
+
*/
|
|
3367
|
+
export type GET_Tlds_Request_Query = GET_Tlds_Request['parameters']['query'];
|
|
3368
|
+
|
|
3380
3369
|
/**
|
|
3381
3370
|
* Request type for GET TldsPortfolio endpoint
|
|
3382
3371
|
*
|