@opusdns/api 0.15.0 → 0.17.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,617 +3024,591 @@ 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
- * Response types for GET Event endpoint
3377
+ * Response types for GET Events endpoint
3404
3378
  *
3405
3379
  * Get Events
3406
3380
  *
3407
3381
  * @remarks
3408
- * This type defines all possible response structures for the GET Event endpoint.
3382
+ * This type defines all possible response structures for the GET Events endpoint.
3409
3383
  * Each response code maps to a specific response type as defined in the OpenAPI specification.
3410
3384
  * Use this type to ensure type safety when handling API responses from this endpoint.
3411
3385
  *
3412
3386
 
3413
3387
  *
3414
- * @path /v1/event
3388
+ * @path /v1/events
3415
3389
  *
3416
- * @see {@link GET_Event_Response_200} - 200 response type
3417
- * @see {@link GET_Event_Response_401} - 401 response type
3418
- * @see {@link GET_Event_Response_422} - 422 response type
3390
+ * @see {@link GET_Events_Response_200} - 200 response type
3391
+ * @see {@link GET_Events_Response_401} - 401 response type
3392
+ * @see {@link GET_Events_Response_422} - 422 response type
3419
3393
  *
3420
3394
 
3421
3395
  */
3422
- export type GET_Event_Response = GET_Event_Response_200 | GET_Event_Response_401 | GET_Event_Response_422;
3396
+ export type GET_Events_Response = GET_Events_Response_200 | GET_Events_Response_401 | GET_Events_Response_422;
3423
3397
 
3424
3398
  /**
3425
- * 200 response for GET Event endpoint
3399
+ * 200 response for GET Events endpoint
3426
3400
  *
3427
3401
  * @remarks
3428
3402
  * This type defines the response structure for the 200 status code
3429
- * of the GET Event endpoint.
3403
+ * of the GET Events endpoint.
3430
3404
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3431
3405
  *
3432
3406
 
3433
3407
  *
3434
- * @path /v1/event
3408
+ * @path /v1/events
3435
3409
  *
3436
- * @see {@link GET_Event_Response} - The main response type definition
3410
+ * @see {@link GET_Events_Response} - The main response type definition
3437
3411
  * @see {@link Pagination_Event} - The actual schema type definition
3438
3412
  */
3439
- export type GET_Event_Response_200 = Pagination_Event
3413
+ export type GET_Events_Response_200 = Pagination_Event
3440
3414
 
3441
3415
  /**
3442
- * 401 response for GET Event endpoint
3416
+ * 401 response for GET Events endpoint
3443
3417
  *
3444
3418
  * @remarks
3445
3419
  * This type defines the response structure for the 401 status code
3446
- * of the GET Event endpoint.
3420
+ * of the GET Events endpoint.
3447
3421
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3448
3422
  *
3449
3423
 
3450
3424
  *
3451
- * @path /v1/event
3425
+ * @path /v1/events
3452
3426
  *
3453
- * @see {@link GET_Event_Response} - The main response type definition
3427
+ * @see {@link GET_Events_Response} - The main response type definition
3454
3428
  * @see {@link Problem} - The actual schema type definition
3455
3429
  */
3456
- export type GET_Event_Response_401 = Problem
3430
+ export type GET_Events_Response_401 = Problem
3457
3431
 
3458
3432
  /**
3459
- * 422 response for GET Event endpoint
3433
+ * 422 response for GET Events endpoint
3460
3434
  *
3461
3435
  * @remarks
3462
3436
  * This type defines the response structure for the 422 status code
3463
- * of the GET Event endpoint.
3437
+ * of the GET Events endpoint.
3464
3438
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3465
3439
  *
3466
3440
 
3467
3441
  *
3468
- * @path /v1/event
3442
+ * @path /v1/events
3469
3443
  *
3470
- * @see {@link GET_Event_Response} - The main response type definition
3444
+ * @see {@link GET_Events_Response} - The main response type definition
3471
3445
  * @see {@link HTTPValidationError} - The actual schema type definition
3472
3446
  */
3473
- export type GET_Event_Response_422 = HTTPValidationError
3447
+ export type GET_Events_Response_422 = HTTPValidationError
3474
3448
 
3475
3449
  /**
3476
- * Response types for GET EventByEventId endpoint
3450
+ * Response types for GET EventsByEventId endpoint
3477
3451
  *
3478
3452
  * Get Event
3479
3453
  *
3480
3454
  * @remarks
3481
- * This type defines all possible response structures for the GET EventByEventId endpoint.
3455
+ * This type defines all possible response structures for the GET EventsByEventId endpoint.
3482
3456
  * Each response code maps to a specific response type as defined in the OpenAPI specification.
3483
3457
  * Use this type to ensure type safety when handling API responses from this endpoint.
3484
3458
  *
3485
3459
 
3486
3460
  *
3487
- * @path /v1/event/{event_id}
3461
+ * @path /v1/events/{event_id}
3488
3462
  *
3489
- * @see {@link GET_EventByEventId_Response_200} - 200 response type
3490
- * @see {@link GET_EventByEventId_Response_401} - 401 response type
3491
- * @see {@link GET_EventByEventId_Response_404} - 404 response type
3492
- * @see {@link GET_EventByEventId_Response_422} - 422 response type
3463
+ * @see {@link GET_EventsByEventId_Response_200} - 200 response type
3464
+ * @see {@link GET_EventsByEventId_Response_401} - 401 response type
3465
+ * @see {@link GET_EventsByEventId_Response_404} - 404 response type
3466
+ * @see {@link GET_EventsByEventId_Response_422} - 422 response type
3493
3467
  *
3494
3468
 
3495
3469
  */
3496
- export type GET_EventByEventId_Response = GET_EventByEventId_Response_200 | GET_EventByEventId_Response_401 | GET_EventByEventId_Response_404 | GET_EventByEventId_Response_422;
3470
+ export type GET_EventsByEventId_Response = GET_EventsByEventId_Response_200 | GET_EventsByEventId_Response_401 | GET_EventsByEventId_Response_404 | GET_EventsByEventId_Response_422;
3497
3471
 
3498
3472
  /**
3499
- * 200 response for GET EventByEventId endpoint
3473
+ * 200 response for GET EventsByEventId endpoint
3500
3474
  *
3501
3475
  * @remarks
3502
3476
  * This type defines the response structure for the 200 status code
3503
- * of the GET EventByEventId endpoint.
3477
+ * of the GET EventsByEventId endpoint.
3504
3478
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3505
3479
  *
3506
3480
 
3507
3481
  *
3508
- * @path /v1/event/{event_id}
3482
+ * @path /v1/events/{event_id}
3509
3483
  *
3510
- * @see {@link GET_EventByEventId_Response} - The main response type definition
3484
+ * @see {@link GET_EventsByEventId_Response} - The main response type definition
3511
3485
  * @see {@link EventSchema} - The actual schema type definition
3512
3486
  */
3513
- export type GET_EventByEventId_Response_200 = EventSchema
3487
+ export type GET_EventsByEventId_Response_200 = EventSchema
3514
3488
 
3515
3489
  /**
3516
- * 401 response for GET EventByEventId endpoint
3490
+ * 401 response for GET EventsByEventId endpoint
3517
3491
  *
3518
3492
  * @remarks
3519
3493
  * This type defines the response structure for the 401 status code
3520
- * of the GET EventByEventId endpoint.
3494
+ * of the GET EventsByEventId endpoint.
3521
3495
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3522
3496
  *
3523
3497
 
3524
3498
  *
3525
- * @path /v1/event/{event_id}
3499
+ * @path /v1/events/{event_id}
3526
3500
  *
3527
- * @see {@link GET_EventByEventId_Response} - The main response type definition
3501
+ * @see {@link GET_EventsByEventId_Response} - The main response type definition
3528
3502
  * @see {@link Problem} - The actual schema type definition
3529
3503
  */
3530
- export type GET_EventByEventId_Response_401 = Problem
3504
+ export type GET_EventsByEventId_Response_401 = Problem
3531
3505
 
3532
3506
  /**
3533
- * 404 response for GET EventByEventId endpoint
3507
+ * 404 response for GET EventsByEventId endpoint
3534
3508
  *
3535
3509
  * @remarks
3536
3510
  * This type defines the response structure for the 404 status code
3537
- * of the GET EventByEventId endpoint.
3511
+ * of the GET EventsByEventId endpoint.
3538
3512
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3539
3513
  *
3540
3514
 
3541
3515
  *
3542
- * @path /v1/event/{event_id}
3516
+ * @path /v1/events/{event_id}
3543
3517
  *
3544
- * @see {@link GET_EventByEventId_Response} - The main response type definition
3518
+ * @see {@link GET_EventsByEventId_Response} - The main response type definition
3545
3519
  * @see {@link Problem} - The actual schema type definition
3546
3520
  */
3547
- export type GET_EventByEventId_Response_404 = Problem
3521
+ export type GET_EventsByEventId_Response_404 = Problem
3548
3522
 
3549
3523
  /**
3550
- * 422 response for GET EventByEventId endpoint
3524
+ * 422 response for GET EventsByEventId endpoint
3551
3525
  *
3552
3526
  * @remarks
3553
3527
  * This type defines the response structure for the 422 status code
3554
- * of the GET EventByEventId endpoint.
3528
+ * of the GET EventsByEventId endpoint.
3555
3529
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3556
3530
  *
3557
3531
 
3558
3532
  *
3559
- * @path /v1/event/{event_id}
3533
+ * @path /v1/events/{event_id}
3560
3534
  *
3561
- * @see {@link GET_EventByEventId_Response} - The main response type definition
3535
+ * @see {@link GET_EventsByEventId_Response} - The main response type definition
3562
3536
  * @see {@link HTTPValidationError} - The actual schema type definition
3563
3537
  */
3564
- export type GET_EventByEventId_Response_422 = HTTPValidationError
3538
+ export type GET_EventsByEventId_Response_422 = HTTPValidationError
3565
3539
 
3566
3540
  /**
3567
- * Response types for PATCH EventByEventId endpoint
3541
+ * Response types for PATCH EventsByEventId endpoint
3568
3542
  *
3569
3543
  * Acknowledge Event
3570
3544
  *
3571
3545
  * @remarks
3572
- * This type defines all possible response structures for the PATCH EventByEventId endpoint.
3546
+ * This type defines all possible response structures for the PATCH EventsByEventId endpoint.
3573
3547
  * Each response code maps to a specific response type as defined in the OpenAPI specification.
3574
3548
  * Use this type to ensure type safety when handling API responses from this endpoint.
3575
3549
  *
3576
3550
 
3577
3551
  *
3578
- * @path /v1/event/{event_id}
3552
+ * @path /v1/events/{event_id}
3579
3553
  *
3580
- * @see {@link PATCH_EventByEventId_Response_401} - 401 response type
3581
- * @see {@link PATCH_EventByEventId_Response_404} - 404 response type
3582
- * @see {@link PATCH_EventByEventId_Response_422} - 422 response type
3554
+ * @see {@link PATCH_EventsByEventId_Response_401} - 401 response type
3555
+ * @see {@link PATCH_EventsByEventId_Response_404} - 404 response type
3556
+ * @see {@link PATCH_EventsByEventId_Response_422} - 422 response type
3583
3557
  *
3584
3558
 
3585
3559
  */
3586
- export type PATCH_EventByEventId_Response = PATCH_EventByEventId_Response_401 | PATCH_EventByEventId_Response_404 | PATCH_EventByEventId_Response_422;
3560
+ export type PATCH_EventsByEventId_Response = PATCH_EventsByEventId_Response_401 | PATCH_EventsByEventId_Response_404 | PATCH_EventsByEventId_Response_422;
3587
3561
 
3588
3562
  /**
3589
- * 401 response for PATCH EventByEventId endpoint
3563
+ * 401 response for PATCH EventsByEventId endpoint
3590
3564
  *
3591
3565
  * @remarks
3592
3566
  * This type defines the response structure for the 401 status code
3593
- * of the PATCH EventByEventId endpoint.
3567
+ * of the PATCH EventsByEventId endpoint.
3594
3568
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3595
3569
  *
3596
3570
 
3597
3571
  *
3598
- * @path /v1/event/{event_id}
3572
+ * @path /v1/events/{event_id}
3599
3573
  *
3600
- * @see {@link PATCH_EventByEventId_Response} - The main response type definition
3574
+ * @see {@link PATCH_EventsByEventId_Response} - The main response type definition
3601
3575
  * @see {@link Problem} - The actual schema type definition
3602
3576
  */
3603
- export type PATCH_EventByEventId_Response_401 = Problem
3577
+ export type PATCH_EventsByEventId_Response_401 = Problem
3604
3578
 
3605
3579
  /**
3606
- * 404 response for PATCH EventByEventId endpoint
3580
+ * 404 response for PATCH EventsByEventId endpoint
3607
3581
  *
3608
3582
  * @remarks
3609
3583
  * This type defines the response structure for the 404 status code
3610
- * of the PATCH EventByEventId endpoint.
3584
+ * of the PATCH EventsByEventId endpoint.
3611
3585
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3612
3586
  *
3613
3587
 
3614
3588
  *
3615
- * @path /v1/event/{event_id}
3589
+ * @path /v1/events/{event_id}
3616
3590
  *
3617
- * @see {@link PATCH_EventByEventId_Response} - The main response type definition
3591
+ * @see {@link PATCH_EventsByEventId_Response} - The main response type definition
3618
3592
  * @see {@link Problem} - The actual schema type definition
3619
3593
  */
3620
- export type PATCH_EventByEventId_Response_404 = Problem
3594
+ export type PATCH_EventsByEventId_Response_404 = Problem
3621
3595
 
3622
3596
  /**
3623
- * 422 response for PATCH EventByEventId endpoint
3597
+ * 422 response for PATCH EventsByEventId endpoint
3624
3598
  *
3625
3599
  * @remarks
3626
3600
  * This type defines the response structure for the 422 status code
3627
- * of the PATCH EventByEventId endpoint.
3601
+ * of the PATCH EventsByEventId endpoint.
3628
3602
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3629
3603
  *
3630
3604
 
3631
3605
  *
3632
- * @path /v1/event/{event_id}
3606
+ * @path /v1/events/{event_id}
3633
3607
  *
3634
- * @see {@link PATCH_EventByEventId_Response} - The main response type definition
3608
+ * @see {@link PATCH_EventsByEventId_Response} - The main response type definition
3635
3609
  * @see {@link HTTPValidationError} - The actual schema type definition
3636
3610
  */
3637
- export type PATCH_EventByEventId_Response_422 = HTTPValidationError
3611
+ export type PATCH_EventsByEventId_Response_422 = HTTPValidationError
3638
3612
 
3639
3613
  /**
3640
3614
  * Response types for GET Notifications endpoint