@opusdns/api 0.14.1 → 0.16.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -34,7 +34,7 @@
34
34
 
35
35
  import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
36
36
 
37
- import { Pagination_OrganizationCredential, Problem, HTTPValidationError, OrganizationCredentialCreated, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DnsZoneSummary, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainCheck, DomainSummary, Pagination_EmailForward, EmailForward, EmailForwardBulkDeleteResult, EmailForwardBulkUpdateResult, Pagination_Event, EventSchema, Pagination_UserNotificationSummary, Notification, UserNotification, Pagination_Organization, Organization, OrganizationWithPlan, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
37
+ import { Pagination_OrganizationCredential, Problem, HTTPValidationError, OrganizationCredentialCreated, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DnsZoneSummary, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainCheck, DomainSummary, Pagination_EmailForwardAlias, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_UserNotificationSummary, Notification, UserNotification, Pagination_Organization, Organization, OrganizationWithPlan, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
38
38
 
39
39
  /**
40
40
  * Response types for GET AuthClientCredentials endpoint
@@ -3024,380 +3024,354 @@ export type POST_DomainsTransfer_Response_409 = Problem
3024
3024
  export type POST_DomainsTransfer_Response_422 = Problem
3025
3025
 
3026
3026
  /**
3027
- * Response types for GET EmailForwards endpoint
3027
+ * Response types for DELETE EmailForwardsByZoneNameAliases endpoint
3028
3028
  *
3029
- * List Email Forwards
3029
+ * Delete Email Forward Aliases
3030
3030
  *
3031
3031
  * @remarks
3032
- * This type defines all possible response structures for the GET EmailForwards endpoint.
3032
+ * This type defines all possible response structures for the DELETE EmailForwardsByZoneNameAliases endpoint.
3033
3033
  * Each response code maps to a specific response type as defined in the OpenAPI specification.
3034
3034
  * Use this type to ensure type safety when handling API responses from this endpoint.
3035
3035
  *
3036
3036
 
3037
3037
  *
3038
- * @path /v1/email-forwards
3039
- * @param status (query) - Optional status to filter the results
3040
- * @param source_address (query) - Optional source address to filter the results
3041
- * @param target_address (query) - Optional target address to filter the results
3038
+ * @path /v1/email-forwards/{zone_name}/aliases
3039
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
3042
3040
  *
3043
- * @see {@link GET_EmailForwards_Response_200} - 200 response type
3044
- * @see {@link GET_EmailForwards_Response_422} - 422 response type
3041
+ * @see {@link DELETE_EmailForwardsByZoneNameAliases_Response_422} - 422 response type
3045
3042
  *
3046
3043
 
3047
3044
  */
3048
- export type GET_EmailForwards_Response = GET_EmailForwards_Response_200 | GET_EmailForwards_Response_422;
3045
+ export type DELETE_EmailForwardsByZoneNameAliases_Response = DELETE_EmailForwardsByZoneNameAliases_Response_422;
3049
3046
 
3050
3047
  /**
3051
- * 200 response for GET EmailForwards endpoint
3052
- *
3053
- * @remarks
3054
- * This type defines the response structure for the 200 status code
3055
- * of the GET EmailForwards endpoint.
3056
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3057
- *
3058
-
3059
- *
3060
- * @path /v1/email-forwards
3061
- * @param status (query) - Optional status to filter the results
3062
- * @param source_address (query) - Optional source address to filter the results
3063
- * @param target_address (query) - Optional target address to filter the results
3064
- *
3065
- * @see {@link GET_EmailForwards_Response} - The main response type definition
3066
- * @see {@link Pagination_EmailForward} - The actual schema type definition
3067
- */
3068
- export type GET_EmailForwards_Response_200 = Pagination_EmailForward
3069
-
3070
- /**
3071
- * 422 response for GET EmailForwards endpoint
3048
+ * 422 response for DELETE EmailForwardsByZoneNameAliases endpoint
3072
3049
  *
3073
3050
  * @remarks
3074
3051
  * This type defines the response structure for the 422 status code
3075
- * of the GET EmailForwards endpoint.
3052
+ * of the DELETE EmailForwardsByZoneNameAliases endpoint.
3076
3053
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3077
3054
  *
3078
3055
 
3079
3056
  *
3080
- * @path /v1/email-forwards
3081
- * @param status (query) - Optional status to filter the results
3082
- * @param source_address (query) - Optional source address to filter the results
3083
- * @param target_address (query) - Optional target address to filter the results
3057
+ * @path /v1/email-forwards/{zone_name}/aliases
3058
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
3084
3059
  *
3085
- * @see {@link GET_EmailForwards_Response} - The main response type definition
3060
+ * @see {@link DELETE_EmailForwardsByZoneNameAliases_Response} - The main response type definition
3086
3061
  * @see {@link HTTPValidationError} - The actual schema type definition
3087
3062
  */
3088
- export type GET_EmailForwards_Response_422 = HTTPValidationError
3063
+ export type DELETE_EmailForwardsByZoneNameAliases_Response_422 = HTTPValidationError
3089
3064
 
3090
3065
  /**
3091
- * Response types for POST EmailForwards endpoint
3066
+ * Response types for GET EmailForwardsByZoneNameAliases endpoint
3092
3067
  *
3093
- * Create Email Forward
3068
+ * Get Email Forward Aliases
3094
3069
  *
3095
3070
  * @remarks
3096
- * This type defines all possible response structures for the POST EmailForwards endpoint.
3071
+ * This type defines all possible response structures for the GET EmailForwardsByZoneNameAliases endpoint.
3097
3072
  * Each response code maps to a specific response type as defined in the OpenAPI specification.
3098
3073
  * Use this type to ensure type safety when handling API responses from this endpoint.
3099
3074
  *
3100
3075
 
3101
3076
  *
3102
- * @path /v1/email-forwards
3077
+ * @path /v1/email-forwards/{zone_name}/aliases
3078
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
3103
3079
  *
3104
- * @see {@link POST_EmailForwards_Response_201} - 201 response type
3105
- * @see {@link POST_EmailForwards_Response_422} - 422 response type
3080
+ * @see {@link GET_EmailForwardsByZoneNameAliases_Response_200} - 200 response type
3081
+ * @see {@link GET_EmailForwardsByZoneNameAliases_Response_422} - 422 response type
3106
3082
  *
3107
3083
 
3108
3084
  */
3109
- export type POST_EmailForwards_Response = POST_EmailForwards_Response_201 | POST_EmailForwards_Response_422;
3085
+ export type GET_EmailForwardsByZoneNameAliases_Response = GET_EmailForwardsByZoneNameAliases_Response_200 | GET_EmailForwardsByZoneNameAliases_Response_422;
3110
3086
 
3111
3087
  /**
3112
- * 201 response for POST EmailForwards endpoint
3088
+ * 200 response for GET EmailForwardsByZoneNameAliases endpoint
3113
3089
  *
3114
3090
  * @remarks
3115
- * This type defines the response structure for the 201 status code
3116
- * of the POST EmailForwards endpoint.
3091
+ * This type defines the response structure for the 200 status code
3092
+ * of the GET EmailForwardsByZoneNameAliases endpoint.
3117
3093
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3118
3094
  *
3119
3095
 
3120
3096
  *
3121
- * @path /v1/email-forwards
3097
+ * @path /v1/email-forwards/{zone_name}/aliases
3098
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
3122
3099
  *
3123
- * @see {@link POST_EmailForwards_Response} - The main response type definition
3124
- * @see {@link EmailForward} - The actual schema type definition
3100
+ * @see {@link GET_EmailForwardsByZoneNameAliases_Response} - The main response type definition
3101
+ * @see {@link Pagination_EmailForwardAlias} - The actual schema type definition
3125
3102
  */
3126
- export type POST_EmailForwards_Response_201 = EmailForward
3103
+ export type GET_EmailForwardsByZoneNameAliases_Response_200 = Pagination_EmailForwardAlias
3127
3104
 
3128
3105
  /**
3129
- * 422 response for POST EmailForwards endpoint
3106
+ * 422 response for GET EmailForwardsByZoneNameAliases endpoint
3130
3107
  *
3131
3108
  * @remarks
3132
3109
  * This type defines the response structure for the 422 status code
3133
- * of the POST EmailForwards endpoint.
3110
+ * of the GET EmailForwardsByZoneNameAliases endpoint.
3134
3111
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3135
3112
  *
3136
3113
 
3137
3114
  *
3138
- * @path /v1/email-forwards
3115
+ * @path /v1/email-forwards/{zone_name}/aliases
3116
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
3139
3117
  *
3140
- * @see {@link POST_EmailForwards_Response} - The main response type definition
3118
+ * @see {@link GET_EmailForwardsByZoneNameAliases_Response} - The main response type definition
3141
3119
  * @see {@link HTTPValidationError} - The actual schema type definition
3142
3120
  */
3143
- export type POST_EmailForwards_Response_422 = HTTPValidationError
3121
+ export type GET_EmailForwardsByZoneNameAliases_Response_422 = HTTPValidationError
3144
3122
 
3145
3123
  /**
3146
- * Response types for POST EmailForwardsBulkDelete endpoint
3124
+ * Response types for POST EmailForwardsByZoneNameAliases endpoint
3147
3125
  *
3148
- * Bulk Delete Email Forwards
3126
+ * Create Email Forward Alias
3149
3127
  *
3150
3128
  * @remarks
3151
- * This type defines all possible response structures for the POST EmailForwardsBulkDelete endpoint.
3129
+ * This type defines all possible response structures for the POST EmailForwardsByZoneNameAliases endpoint.
3152
3130
  * Each response code maps to a specific response type as defined in the OpenAPI specification.
3153
3131
  * Use this type to ensure type safety when handling API responses from this endpoint.
3154
3132
  *
3155
3133
 
3156
3134
  *
3157
- * @path /v1/email-forwards/bulk-delete
3135
+ * @path /v1/email-forwards/{zone_name}/aliases
3136
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
3158
3137
  *
3159
- * @see {@link POST_EmailForwardsBulkDelete_Response_200} - 200 response type
3160
- * @see {@link POST_EmailForwardsBulkDelete_Response_422} - 422 response type
3138
+ * @see {@link POST_EmailForwardsByZoneNameAliases_Response_422} - 422 response type
3161
3139
  *
3162
3140
 
3163
3141
  */
3164
- export type POST_EmailForwardsBulkDelete_Response = POST_EmailForwardsBulkDelete_Response_200 | POST_EmailForwardsBulkDelete_Response_422;
3142
+ export type POST_EmailForwardsByZoneNameAliases_Response = POST_EmailForwardsByZoneNameAliases_Response_422;
3165
3143
 
3166
3144
  /**
3167
- * 200 response for POST EmailForwardsBulkDelete endpoint
3145
+ * 422 response for POST EmailForwardsByZoneNameAliases endpoint
3168
3146
  *
3169
3147
  * @remarks
3170
- * This type defines the response structure for the 200 status code
3171
- * of the POST EmailForwardsBulkDelete endpoint.
3148
+ * This type defines the response structure for the 422 status code
3149
+ * of the POST EmailForwardsByZoneNameAliases endpoint.
3172
3150
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3173
3151
  *
3174
3152
 
3175
3153
  *
3176
- * @path /v1/email-forwards/bulk-delete
3154
+ * @path /v1/email-forwards/{zone_name}/aliases
3155
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
3177
3156
  *
3178
- * @see {@link POST_EmailForwardsBulkDelete_Response} - The main response type definition
3179
- * @see {@link EmailForwardBulkDeleteResult} - The actual schema type definition
3157
+ * @see {@link POST_EmailForwardsByZoneNameAliases_Response} - The main response type definition
3158
+ * @see {@link HTTPValidationError} - The actual schema type definition
3180
3159
  */
3181
- export type POST_EmailForwardsBulkDelete_Response_200 = EmailForwardBulkDeleteResult
3160
+ export type POST_EmailForwardsByZoneNameAliases_Response_422 = HTTPValidationError
3182
3161
 
3183
3162
  /**
3184
- * 422 response for POST EmailForwardsBulkDelete endpoint
3163
+ * Response types for DELETE EmailForwardsByZoneNameAliasesByAlias endpoint
3164
+ *
3165
+ * Delete Email Forward Alias
3166
+ *
3167
+ * @remarks
3168
+ * This type defines all possible response structures for the DELETE EmailForwardsByZoneNameAliasesByAlias endpoint.
3169
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
3170
+ * Use this type to ensure type safety when handling API responses from this endpoint.
3171
+ *
3172
+
3173
+ *
3174
+ * @path /v1/email-forwards/{zone_name}/aliases/{alias}
3175
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
3176
+ *
3177
+ * @see {@link DELETE_EmailForwardsByZoneNameAliasesByAlias_Response_422} - 422 response type
3178
+ *
3179
+
3180
+ */
3181
+ export type DELETE_EmailForwardsByZoneNameAliasesByAlias_Response = DELETE_EmailForwardsByZoneNameAliasesByAlias_Response_422;
3182
+
3183
+ /**
3184
+ * 422 response for DELETE EmailForwardsByZoneNameAliasesByAlias endpoint
3185
3185
  *
3186
3186
  * @remarks
3187
3187
  * This type defines the response structure for the 422 status code
3188
- * of the POST EmailForwardsBulkDelete endpoint.
3188
+ * of the DELETE EmailForwardsByZoneNameAliasesByAlias endpoint.
3189
3189
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3190
3190
  *
3191
3191
 
3192
3192
  *
3193
- * @path /v1/email-forwards/bulk-delete
3193
+ * @path /v1/email-forwards/{zone_name}/aliases/{alias}
3194
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
3194
3195
  *
3195
- * @see {@link POST_EmailForwardsBulkDelete_Response} - The main response type definition
3196
+ * @see {@link DELETE_EmailForwardsByZoneNameAliasesByAlias_Response} - The main response type definition
3196
3197
  * @see {@link HTTPValidationError} - The actual schema type definition
3197
3198
  */
3198
- export type POST_EmailForwardsBulkDelete_Response_422 = HTTPValidationError
3199
+ export type DELETE_EmailForwardsByZoneNameAliasesByAlias_Response_422 = HTTPValidationError
3199
3200
 
3200
3201
  /**
3201
- * Response types for PATCH EmailForwardsBulkUpdate endpoint
3202
+ * Response types for GET EmailForwardsByZoneNameAliasesByAlias endpoint
3202
3203
  *
3203
- * Bulk Update Email Forwards
3204
+ * Get Email Forward Alias
3204
3205
  *
3205
3206
  * @remarks
3206
- * This type defines all possible response structures for the PATCH EmailForwardsBulkUpdate endpoint.
3207
+ * This type defines all possible response structures for the GET EmailForwardsByZoneNameAliasesByAlias endpoint.
3207
3208
  * Each response code maps to a specific response type as defined in the OpenAPI specification.
3208
3209
  * Use this type to ensure type safety when handling API responses from this endpoint.
3209
3210
  *
3210
3211
 
3211
3212
  *
3212
- * @path /v1/email-forwards/bulk-update
3213
+ * @path /v1/email-forwards/{zone_name}/aliases/{alias}
3214
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
3213
3215
  *
3214
- * @see {@link PATCH_EmailForwardsBulkUpdate_Response_200} - 200 response type
3215
- * @see {@link PATCH_EmailForwardsBulkUpdate_Response_422} - 422 response type
3216
+ * @see {@link GET_EmailForwardsByZoneNameAliasesByAlias_Response_200} - 200 response type
3217
+ * @see {@link GET_EmailForwardsByZoneNameAliasesByAlias_Response_422} - 422 response type
3216
3218
  *
3217
3219
 
3218
3220
  */
3219
- export type PATCH_EmailForwardsBulkUpdate_Response = PATCH_EmailForwardsBulkUpdate_Response_200 | PATCH_EmailForwardsBulkUpdate_Response_422;
3221
+ export type GET_EmailForwardsByZoneNameAliasesByAlias_Response = GET_EmailForwardsByZoneNameAliasesByAlias_Response_200 | GET_EmailForwardsByZoneNameAliasesByAlias_Response_422;
3220
3222
 
3221
3223
  /**
3222
- * 200 response for PATCH EmailForwardsBulkUpdate endpoint
3224
+ * 200 response for GET EmailForwardsByZoneNameAliasesByAlias endpoint
3223
3225
  *
3224
3226
  * @remarks
3225
3227
  * This type defines the response structure for the 200 status code
3226
- * of the PATCH EmailForwardsBulkUpdate endpoint.
3228
+ * of the GET EmailForwardsByZoneNameAliasesByAlias endpoint.
3227
3229
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3228
3230
  *
3229
3231
 
3230
3232
  *
3231
- * @path /v1/email-forwards/bulk-update
3233
+ * @path /v1/email-forwards/{zone_name}/aliases/{alias}
3234
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
3232
3235
  *
3233
- * @see {@link PATCH_EmailForwardsBulkUpdate_Response} - The main response type definition
3234
- * @see {@link EmailForwardBulkUpdateResult} - The actual schema type definition
3236
+ * @see {@link GET_EmailForwardsByZoneNameAliasesByAlias_Response} - The main response type definition
3237
+ * @see {@link EmailForwardAlias} - The actual schema type definition
3235
3238
  */
3236
- export type PATCH_EmailForwardsBulkUpdate_Response_200 = EmailForwardBulkUpdateResult
3239
+ export type GET_EmailForwardsByZoneNameAliasesByAlias_Response_200 = EmailForwardAlias
3237
3240
 
3238
3241
  /**
3239
- * 422 response for PATCH EmailForwardsBulkUpdate endpoint
3242
+ * 422 response for GET EmailForwardsByZoneNameAliasesByAlias endpoint
3240
3243
  *
3241
3244
  * @remarks
3242
3245
  * This type defines the response structure for the 422 status code
3243
- * of the PATCH EmailForwardsBulkUpdate endpoint.
3246
+ * of the GET EmailForwardsByZoneNameAliasesByAlias endpoint.
3244
3247
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3245
3248
  *
3246
3249
 
3247
3250
  *
3248
- * @path /v1/email-forwards/bulk-update
3251
+ * @path /v1/email-forwards/{zone_name}/aliases/{alias}
3252
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
3249
3253
  *
3250
- * @see {@link PATCH_EmailForwardsBulkUpdate_Response} - The main response type definition
3254
+ * @see {@link GET_EmailForwardsByZoneNameAliasesByAlias_Response} - The main response type definition
3251
3255
  * @see {@link HTTPValidationError} - The actual schema type definition
3252
3256
  */
3253
- export type PATCH_EmailForwardsBulkUpdate_Response_422 = HTTPValidationError
3257
+ export type GET_EmailForwardsByZoneNameAliasesByAlias_Response_422 = HTTPValidationError
3254
3258
 
3255
3259
  /**
3256
- * Response types for DELETE EmailForwardsByEmailForwardId endpoint
3260
+ * Response types for PUT EmailForwardsByZoneNameAliasesByAlias endpoint
3257
3261
  *
3258
- * Delete Email Forward
3262
+ * Update Email Forward Alias
3259
3263
  *
3260
3264
  * @remarks
3261
- * This type defines all possible response structures for the DELETE EmailForwardsByEmailForwardId endpoint.
3265
+ * This type defines all possible response structures for the PUT EmailForwardsByZoneNameAliasesByAlias endpoint.
3262
3266
  * Each response code maps to a specific response type as defined in the OpenAPI specification.
3263
3267
  * Use this type to ensure type safety when handling API responses from this endpoint.
3264
3268
  *
3265
3269
 
3266
3270
  *
3267
- * @path /v1/email-forwards/{email_forward_id}
3271
+ * @path /v1/email-forwards/{zone_name}/aliases/{alias}
3272
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
3268
3273
  *
3269
- * @see {@link DELETE_EmailForwardsByEmailForwardId_Response_422} - 422 response type
3274
+ * @see {@link PUT_EmailForwardsByZoneNameAliasesByAlias_Response_422} - 422 response type
3270
3275
  *
3271
3276
 
3272
3277
  */
3273
- export type DELETE_EmailForwardsByEmailForwardId_Response = DELETE_EmailForwardsByEmailForwardId_Response_422;
3278
+ export type PUT_EmailForwardsByZoneNameAliasesByAlias_Response = PUT_EmailForwardsByZoneNameAliasesByAlias_Response_422;
3274
3279
 
3275
3280
  /**
3276
- * 422 response for DELETE EmailForwardsByEmailForwardId endpoint
3281
+ * 422 response for PUT EmailForwardsByZoneNameAliasesByAlias endpoint
3277
3282
  *
3278
3283
  * @remarks
3279
3284
  * This type defines the response structure for the 422 status code
3280
- * of the DELETE EmailForwardsByEmailForwardId endpoint.
3285
+ * of the PUT EmailForwardsByZoneNameAliasesByAlias endpoint.
3281
3286
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3282
3287
  *
3283
3288
 
3284
3289
  *
3285
- * @path /v1/email-forwards/{email_forward_id}
3290
+ * @path /v1/email-forwards/{zone_name}/aliases/{alias}
3291
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
3286
3292
  *
3287
- * @see {@link DELETE_EmailForwardsByEmailForwardId_Response} - The main response type definition
3293
+ * @see {@link PUT_EmailForwardsByZoneNameAliasesByAlias_Response} - The main response type definition
3288
3294
  * @see {@link HTTPValidationError} - The actual schema type definition
3289
3295
  */
3290
- export type DELETE_EmailForwardsByEmailForwardId_Response_422 = HTTPValidationError
3296
+ export type PUT_EmailForwardsByZoneNameAliasesByAlias_Response_422 = HTTPValidationError
3291
3297
 
3292
3298
  /**
3293
- * Response types for GET EmailForwardsByEmailForwardId endpoint
3299
+ * Response types for PATCH EmailForwardsByZoneNameDisable endpoint
3294
3300
  *
3295
- * Get Email Forward
3301
+ * Disable Email Forward
3296
3302
  *
3297
3303
  * @remarks
3298
- * This type defines all possible response structures for the GET EmailForwardsByEmailForwardId endpoint.
3304
+ * This type defines all possible response structures for the PATCH EmailForwardsByZoneNameDisable endpoint.
3299
3305
  * Each response code maps to a specific response type as defined in the OpenAPI specification.
3300
3306
  * Use this type to ensure type safety when handling API responses from this endpoint.
3301
3307
  *
3302
3308
 
3303
3309
  *
3304
- * @path /v1/email-forwards/{email_forward_id}
3305
- *
3306
- * @see {@link GET_EmailForwardsByEmailForwardId_Response_200} - 200 response type
3307
- * @see {@link GET_EmailForwardsByEmailForwardId_Response_422} - 422 response type
3308
- *
3309
-
3310
- */
3311
- export type GET_EmailForwardsByEmailForwardId_Response = GET_EmailForwardsByEmailForwardId_Response_200 | GET_EmailForwardsByEmailForwardId_Response_422;
3312
-
3313
- /**
3314
- * 200 response for GET EmailForwardsByEmailForwardId endpoint
3310
+ * @path /v1/email-forwards/{zone_name}/disable
3311
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
3315
3312
  *
3316
- * @remarks
3317
- * This type defines the response structure for the 200 status code
3318
- * of the GET EmailForwardsByEmailForwardId endpoint.
3319
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3313
+ * @see {@link PATCH_EmailForwardsByZoneNameDisable_Response_422} - 422 response type
3320
3314
  *
3321
3315
 
3322
- *
3323
- * @path /v1/email-forwards/{email_forward_id}
3324
- *
3325
- * @see {@link GET_EmailForwardsByEmailForwardId_Response} - The main response type definition
3326
- * @see {@link EmailForward} - The actual schema type definition
3327
3316
  */
3328
- export type GET_EmailForwardsByEmailForwardId_Response_200 = EmailForward
3317
+ export type PATCH_EmailForwardsByZoneNameDisable_Response = PATCH_EmailForwardsByZoneNameDisable_Response_422;
3329
3318
 
3330
3319
  /**
3331
- * 422 response for GET EmailForwardsByEmailForwardId endpoint
3320
+ * 422 response for PATCH EmailForwardsByZoneNameDisable endpoint
3332
3321
  *
3333
3322
  * @remarks
3334
3323
  * This type defines the response structure for the 422 status code
3335
- * of the GET EmailForwardsByEmailForwardId endpoint.
3324
+ * of the PATCH EmailForwardsByZoneNameDisable endpoint.
3336
3325
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3337
3326
  *
3338
3327
 
3339
3328
  *
3340
- * @path /v1/email-forwards/{email_forward_id}
3329
+ * @path /v1/email-forwards/{zone_name}/disable
3330
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
3341
3331
  *
3342
- * @see {@link GET_EmailForwardsByEmailForwardId_Response} - The main response type definition
3332
+ * @see {@link PATCH_EmailForwardsByZoneNameDisable_Response} - The main response type definition
3343
3333
  * @see {@link HTTPValidationError} - The actual schema type definition
3344
3334
  */
3345
- export type GET_EmailForwardsByEmailForwardId_Response_422 = HTTPValidationError
3335
+ export type PATCH_EmailForwardsByZoneNameDisable_Response_422 = HTTPValidationError
3346
3336
 
3347
3337
  /**
3348
- * Response types for PATCH EmailForwardsByEmailForwardId endpoint
3338
+ * Response types for PATCH EmailForwardsByZoneNameEnable endpoint
3349
3339
  *
3350
- * Update Email Forward
3340
+ * Enable Email Forward
3351
3341
  *
3352
3342
  * @remarks
3353
- * This type defines all possible response structures for the PATCH EmailForwardsByEmailForwardId endpoint.
3343
+ * This type defines all possible response structures for the PATCH EmailForwardsByZoneNameEnable endpoint.
3354
3344
  * Each response code maps to a specific response type as defined in the OpenAPI specification.
3355
3345
  * Use this type to ensure type safety when handling API responses from this endpoint.
3356
3346
  *
3357
3347
 
3358
3348
  *
3359
- * @path /v1/email-forwards/{email_forward_id}
3360
- *
3361
- * @see {@link PATCH_EmailForwardsByEmailForwardId_Response_200} - 200 response type
3362
- * @see {@link PATCH_EmailForwardsByEmailForwardId_Response_422} - 422 response type
3363
- *
3364
-
3365
- */
3366
- export type PATCH_EmailForwardsByEmailForwardId_Response = PATCH_EmailForwardsByEmailForwardId_Response_200 | PATCH_EmailForwardsByEmailForwardId_Response_422;
3367
-
3368
- /**
3369
- * 200 response for PATCH EmailForwardsByEmailForwardId endpoint
3349
+ * @path /v1/email-forwards/{zone_name}/enable
3350
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
3370
3351
  *
3371
- * @remarks
3372
- * This type defines the response structure for the 200 status code
3373
- * of the PATCH EmailForwardsByEmailForwardId endpoint.
3374
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3352
+ * @see {@link PATCH_EmailForwardsByZoneNameEnable_Response_422} - 422 response type
3375
3353
  *
3376
3354
 
3377
- *
3378
- * @path /v1/email-forwards/{email_forward_id}
3379
- *
3380
- * @see {@link PATCH_EmailForwardsByEmailForwardId_Response} - The main response type definition
3381
- * @see {@link EmailForward} - The actual schema type definition
3382
3355
  */
3383
- export type PATCH_EmailForwardsByEmailForwardId_Response_200 = EmailForward
3356
+ export type PATCH_EmailForwardsByZoneNameEnable_Response = PATCH_EmailForwardsByZoneNameEnable_Response_422;
3384
3357
 
3385
3358
  /**
3386
- * 422 response for PATCH EmailForwardsByEmailForwardId endpoint
3359
+ * 422 response for PATCH EmailForwardsByZoneNameEnable endpoint
3387
3360
  *
3388
3361
  * @remarks
3389
3362
  * This type defines the response structure for the 422 status code
3390
- * of the PATCH EmailForwardsByEmailForwardId endpoint.
3363
+ * of the PATCH EmailForwardsByZoneNameEnable endpoint.
3391
3364
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3392
3365
  *
3393
3366
 
3394
3367
  *
3395
- * @path /v1/email-forwards/{email_forward_id}
3368
+ * @path /v1/email-forwards/{zone_name}/enable
3369
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
3396
3370
  *
3397
- * @see {@link PATCH_EmailForwardsByEmailForwardId_Response} - The main response type definition
3371
+ * @see {@link PATCH_EmailForwardsByZoneNameEnable_Response} - The main response type definition
3398
3372
  * @see {@link HTTPValidationError} - The actual schema type definition
3399
3373
  */
3400
- export type PATCH_EmailForwardsByEmailForwardId_Response_422 = HTTPValidationError
3374
+ export type PATCH_EmailForwardsByZoneNameEnable_Response_422 = HTTPValidationError
3401
3375
 
3402
3376
  /**
3403
3377
  * Response types for GET Event endpoint
@@ -21,7 +21,7 @@
21
21
  * This file is auto-generated from the OpenAPI specification.
22
22
  * Do not edit manually.
23
23
  */
24
- import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, BulkOperationResult, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, Nameserver, DeletePolicyType, SyncOperationType, DomainContact, DomainStatus, DomainSearchSuggestion, DomainClientStatus, EmailForwardBulkUpdateItem, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, ContactSchema, DnsZone, Domain, EmailForward, EventResponse, OrganizationCredential, Organization, UserNotificationSummary, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeUpdate, DomainAvailability } from './schemas.d';
24
+ import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, Nameserver, DeletePolicyType, SyncOperationType, DomainContact, DomainStatus, DomainSearchSuggestion, DomainClientStatus, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, ContactSchema, DnsZone, Domain, EmailForwardAlias, EventResponse, OrganizationCredential, Organization, UserNotificationSummary, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, UserAttributeUpdate, DomainAvailability } from './schemas.d';
25
25
 
26
26
  /**
27
27
  * DomainDnssecDataResponse
@@ -107,20 +107,6 @@ export type IpRestrictionArray = IpRestriction[];
107
107
  * @see {@link TldResponseShort} - The individual TldResponseShort type definition
108
108
  */
109
109
  export type TldResponseShortArray = TldResponseShort[];
110
- /**
111
- * BulkOperationResult
112
- *
113
- * @remarks
114
- * Array type for BulkOperationResult objects. Used when the API returns a collection of BulkOperationResult instances.
115
- *
116
- * @example
117
- * ```typescript
118
- * const items: BulkOperationResultArray = await api.getBulkOperationResults();
119
- * ```
120
- *
121
- * @see {@link BulkOperationResult} - The individual BulkOperationResult type definition
122
- */
123
- export type BulkOperationResultArray = BulkOperationResult[];
124
110
  /**
125
111
  * PostalAddressType
126
112
  *
@@ -359,20 +345,6 @@ export type DomainSearchSuggestionArray = DomainSearchSuggestion[];
359
345
  * @see {@link DomainClientStatus} - The individual DomainClientStatus type definition
360
346
  */
361
347
  export type DomainClientStatusArray = DomainClientStatus[];
362
- /**
363
- * EmailForwardBulkUpdateItem
364
- *
365
- * @remarks
366
- * Array type for EmailForwardBulkUpdateItem objects. Used when the API returns a collection of EmailForwardBulkUpdateItem instances.
367
- *
368
- * @example
369
- * ```typescript
370
- * const items: EmailForwardBulkUpdateItemArray = await api.getEmailForwardBulkUpdateItems();
371
- * ```
372
- *
373
- * @see {@link EmailForwardBulkUpdateItem} - The individual EmailForwardBulkUpdateItem type definition
374
- */
375
- export type EmailForwardBulkUpdateItemArray = EmailForwardBulkUpdateItem[];
376
348
  /**
377
349
  * ValidationError
378
350
  *
@@ -528,19 +500,19 @@ export type DnsZoneArray = DnsZone[];
528
500
  */
529
501
  export type DomainArray = Domain[];
530
502
  /**
531
- * EmailForward
503
+ * EmailForwardAlias
532
504
  *
533
505
  * @remarks
534
- * Array type for EmailForward objects. Used when the API returns a collection of EmailForward instances.
506
+ * Array type for EmailForwardAlias objects. Used when the API returns a collection of EmailForwardAlias instances.
535
507
  *
536
508
  * @example
537
509
  * ```typescript
538
- * const items: EmailForwardArray = await api.getEmailForwards();
510
+ * const items: EmailForwardAliasArray = await api.getEmailForwardAliass();
539
511
  * ```
540
512
  *
541
- * @see {@link EmailForward} - The individual EmailForward type definition
513
+ * @see {@link EmailForwardAlias} - The individual EmailForwardAlias type definition
542
514
  */
543
- export type EmailForwardArray = EmailForward[];
515
+ export type EmailForwardAliasArray = EmailForwardAlias[];
544
516
  /**
545
517
  * EventResponse
546
518
  *
@@ -681,6 +653,20 @@ export type TldBaseArray = TldBase[];
681
653
  * @see {@link PostTransferRequirements} - The individual PostTransferRequirements type definition
682
654
  */
683
655
  export type PostTransferRequirementsArray = PostTransferRequirements[];
656
+ /**
657
+ * UserAttributeBase
658
+ *
659
+ * @remarks
660
+ * Array type for UserAttributeBase objects. Used when the API returns a collection of UserAttributeBase instances.
661
+ *
662
+ * @example
663
+ * ```typescript
664
+ * const items: UserAttributeBaseArray = await api.getUserAttributeBases();
665
+ * ```
666
+ *
667
+ * @see {@link UserAttributeBase} - The individual UserAttributeBase type definition
668
+ */
669
+ export type UserAttributeBaseArray = UserAttributeBase[];
684
670
  /**
685
671
  * UserAttributeUpdate
686
672
  *