@opusdns/api 0.92.0 → 0.94.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/src/schema.d.ts CHANGED
@@ -289,18 +289,52 @@ export interface paths {
289
289
  path?: never;
290
290
  cookie?: never;
291
291
  };
292
- /** List Domain Forwards */
292
+ /**
293
+ * List domain forwards
294
+ * @description Retrieves a paginated list of domain forwards for the organization
295
+ */
293
296
  get: operations["list_domain_forwards_v1_domain_forwards_get"];
294
297
  put?: never;
295
298
  post?: never;
296
299
  delete?: never;
297
300
  options?: never;
298
301
  head?: never;
299
- /** Patch Redirects */
302
+ /**
303
+ * Patch domain forward redirects
304
+ * @description Applies patch operations to update or remove redirects across hostnames and protocols. Raises an error if the domain forward or domain forward set does not exist.
305
+ */
300
306
  patch: operations["patch_redirects_v1_domain_forwards_patch"];
301
307
  trace?: never;
302
308
  };
303
- "/v1/domain-forwards/{zone_name}/disable": {
309
+ "/v1/domain-forwards/{hostname}": {
310
+ parameters: {
311
+ query?: never;
312
+ header?: never;
313
+ path?: never;
314
+ cookie?: never;
315
+ };
316
+ /**
317
+ * Get a domain forward
318
+ * @description Retrieves the domain forward configuration for the specified hostname
319
+ */
320
+ get: operations["get_domain_forward_v1_domain_forwards__hostname__get"];
321
+ put?: never;
322
+ /**
323
+ * Create a domain forward
324
+ * @description Creates a new domain forward configuration for the specified hostname
325
+ */
326
+ post: operations["create_domain_forward_v1_domain_forwards__hostname__post"];
327
+ /**
328
+ * Delete a domain forward
329
+ * @description Deletes the domain forward configuration for the specified hostname
330
+ */
331
+ delete: operations["delete_domain_forward_v1_domain_forwards__hostname__delete"];
332
+ options?: never;
333
+ head?: never;
334
+ patch?: never;
335
+ trace?: never;
336
+ };
337
+ "/v1/domain-forwards/{hostname}/disable": {
304
338
  parameters: {
305
339
  query?: never;
306
340
  header?: never;
@@ -313,11 +347,14 @@ export interface paths {
313
347
  delete?: never;
314
348
  options?: never;
315
349
  head?: never;
316
- /** Disable Domain Forward */
317
- patch: operations["disable_domain_forward_v1_domain_forwards__zone_name__disable_patch"];
350
+ /**
351
+ * Disable domain forward
352
+ * @description Disables domain forwarding by removing DNS records. The domain forward configuration is preserved but disabled.
353
+ */
354
+ patch: operations["disable_domain_forward_v1_domain_forwards__hostname__disable_patch"];
318
355
  trace?: never;
319
356
  };
320
- "/v1/domain-forwards/{zone_name}/enable": {
357
+ "/v1/domain-forwards/{hostname}/enable": {
321
358
  parameters: {
322
359
  query?: never;
323
360
  header?: never;
@@ -330,25 +367,40 @@ export interface paths {
330
367
  delete?: never;
331
368
  options?: never;
332
369
  head?: never;
333
- /** Enable Domain Forward */
334
- patch: operations["enable_domain_forward_v1_domain_forwards__zone_name__enable_patch"];
370
+ /**
371
+ * Enable domain forward
372
+ * @description Enables domain forwarding by creating necessary DNS records. Optionally auto-creates the zone and domain forward if they don't exist.
373
+ */
374
+ patch: operations["enable_domain_forward_v1_domain_forwards__hostname__enable_patch"];
335
375
  trace?: never;
336
376
  };
337
- "/v1/domain-forwards/{zone_name}/{request_protocol}": {
377
+ "/v1/domain-forwards/{hostname}/{protocol}": {
338
378
  parameters: {
339
379
  query?: never;
340
380
  header?: never;
341
381
  path?: never;
342
382
  cookie?: never;
343
383
  };
344
- /** Get Domain Forward */
345
- get: operations["get_domain_forward_v1_domain_forwards__zone_name___request_protocol__get"];
346
- /** Update Domain Forward */
347
- put: operations["update_domain_forward_v1_domain_forwards__zone_name___request_protocol__put"];
348
- /** Create Domain Forward */
349
- post: operations["create_domain_forward_v1_domain_forwards__zone_name___request_protocol__post"];
350
- /** Delete Domain Forward */
351
- delete: operations["delete_domain_forward_v1_domain_forwards__zone_name___request_protocol__delete"];
384
+ /**
385
+ * Get domain forward set
386
+ * @description Retrieves all redirects for a specific protocol (HTTP or HTTPS) for the specified hostname
387
+ */
388
+ get: operations["get_domain_forward_set_v1_domain_forwards__hostname___protocol__get"];
389
+ /**
390
+ * Update domain forward set
391
+ * @description Updates an existing domain forward set for a specific protocol (HTTP or HTTPS). All existing redirects for this protocol are replaced with the provided redirects. Raises an error if the set does not exist.
392
+ */
393
+ put: operations["update_domain_forward_set_v1_domain_forwards__hostname___protocol__put"];
394
+ /**
395
+ * Create domain forward set
396
+ * @description Creates a new domain forward set for a specific protocol (HTTP or HTTPS). Raises an error if the set already exists.
397
+ */
398
+ post: operations["create_domain_forward_set_v1_domain_forwards__hostname___protocol__post"];
399
+ /**
400
+ * Delete domain forward set
401
+ * @description Deletes a domain forward set for a specific protocol (HTTP or HTTPS).
402
+ */
403
+ delete: operations["delete_domain_forward_set_v1_domain_forwards__hostname___protocol__delete"];
352
404
  options?: never;
353
405
  head?: never;
354
406
  patch?: never;
@@ -1273,12 +1325,12 @@ export interface components {
1273
1325
  * BillingTransactionAction
1274
1326
  * @enum {string}
1275
1327
  */
1276
- BillingTransactionAction: "create" | "transfer" | "renew" | "restore" | "trade" | "application";
1328
+ BillingTransactionAction: "create" | "transfer" | "renew" | "restore" | "trade" | "application" | "service_fee" | "wallet_top_up";
1277
1329
  /**
1278
1330
  * BillingTransactionProductType
1279
1331
  * @enum {string}
1280
1332
  */
1281
- BillingTransactionProductType: "domain" | "zones" | "email_forward" | "domain_forward";
1333
+ BillingTransactionProductType: "domain" | "zones" | "email_forward" | "domain_forward" | "account_wallet";
1282
1334
  /** BillingTransactionResponse */
1283
1335
  BillingTransactionResponse: {
1284
1336
  /** @description The action performed in the transaction */
@@ -2276,60 +2328,95 @@ export interface components {
2276
2328
  * Format: date-time
2277
2329
  */
2278
2330
  created_on: Date;
2279
- /** Redirects */
2280
- redirects: components["schemas"]["HttpRedirect"][];
2281
- request_protocol: components["schemas"]["HttpProtocol"];
2331
+ /** Enabled */
2332
+ enabled: boolean;
2333
+ /** Hostname */
2334
+ hostname: string;
2335
+ http?: components["schemas"]["DomainForwardProtocolSetResponse"] | null;
2336
+ https?: components["schemas"]["DomainForwardProtocolSetResponse"] | null;
2282
2337
  /**
2283
2338
  * Updated On
2284
2339
  * Format: date-time
2285
2340
  */
2286
2341
  updated_on: Date;
2287
- /**
2288
- * Wildcard
2289
- * @default false
2290
- */
2342
+ /** Wildcard */
2291
2343
  wildcard: boolean;
2292
- /** Zone Name */
2293
- zone_name: string;
2294
2344
  };
2295
2345
  /** DomainForwardPatchOp */
2296
2346
  DomainForwardPatchOp: {
2297
2347
  op: components["schemas"]["PatchOp"];
2298
2348
  /** Redirect */
2299
- redirect: components["schemas"]["HttpRedirect"] | components["schemas"]["HttpRedirectRemove"];
2300
- request_protocol: components["schemas"]["HttpProtocol"];
2301
- /** Zone Name */
2302
- zone_name: string;
2349
+ redirect: components["schemas"]["HttpRedirectUpsert"] | components["schemas"]["HttpRedirectRemove"];
2303
2350
  };
2304
2351
  /** DomainForwardPatchOps */
2305
2352
  DomainForwardPatchOps: {
2306
2353
  /** Ops */
2307
2354
  ops: components["schemas"]["DomainForwardPatchOp"][];
2308
2355
  };
2309
- /** DomainForwardProtocols */
2310
- DomainForwardProtocols: {
2311
- http?: components["schemas"]["ProtocolRedirects"] | null;
2312
- https?: components["schemas"]["ProtocolRedirects"] | null;
2356
+ /** DomainForwardProtocolSetRequest */
2357
+ DomainForwardProtocolSetRequest: {
2358
+ /** Created On */
2359
+ created_on?: Date | null;
2360
+ /** Redirects */
2361
+ redirects: (components["schemas"]["HttpRedirectRequest"] | components["schemas"]["WildcardHttpRedirectRequest"])[];
2362
+ /** Updated On */
2363
+ updated_on?: Date | null;
2364
+ /** Wildcard */
2365
+ wildcard?: boolean | null;
2313
2366
  };
2314
- /** DomainForwardRequest */
2315
- DomainForwardRequest: {
2367
+ /** DomainForwardProtocolSetResponse */
2368
+ DomainForwardProtocolSetResponse: {
2369
+ /**
2370
+ * Created On
2371
+ * Format: date-time
2372
+ */
2373
+ created_on: Date;
2316
2374
  /** Redirects */
2317
- redirects: components["schemas"]["HttpRedirect"][];
2375
+ redirects: components["schemas"]["HttpRedirectListResponse"][];
2318
2376
  /**
2319
- * Wildcard
2320
- * @default false
2377
+ * Updated On
2378
+ * Format: date-time
2321
2379
  */
2380
+ updated_on: Date;
2381
+ /** Wildcard */
2322
2382
  wildcard: boolean;
2323
2383
  };
2324
- /** DomainForwardZone */
2325
- DomainForwardZone: {
2326
- /** Enabled */
2384
+ /** DomainForwardRequest */
2385
+ DomainForwardRequest: {
2386
+ /**
2387
+ * Enabled
2388
+ * @default false
2389
+ */
2327
2390
  enabled: boolean;
2328
- protocols: components["schemas"]["DomainForwardProtocols"];
2391
+ http?: components["schemas"]["DomainForwardProtocolSetRequest"] | null;
2392
+ https?: components["schemas"]["DomainForwardProtocolSetRequest"] | null;
2393
+ /** Wildcard */
2394
+ wildcard?: boolean | null;
2395
+ };
2396
+ /** DomainForwardSetRequest */
2397
+ DomainForwardSetRequest: {
2398
+ /** Redirects */
2399
+ redirects: (components["schemas"]["HttpRedirectRequest"] | components["schemas"]["WildcardHttpRedirectRequest"])[];
2400
+ };
2401
+ /** DomainForwardSetResponse */
2402
+ DomainForwardSetResponse: {
2403
+ /**
2404
+ * Created On
2405
+ * Format: date-time
2406
+ */
2407
+ created_on: Date;
2408
+ /** Hostname */
2409
+ hostname: string;
2410
+ protocol: components["schemas"]["HttpProtocol"];
2411
+ /** Redirects */
2412
+ redirects: components["schemas"]["HttpRedirectListResponse"][];
2413
+ /**
2414
+ * Updated On
2415
+ * Format: date-time
2416
+ */
2417
+ updated_on: Date;
2329
2418
  /** Wildcard */
2330
2419
  wildcard: boolean;
2331
- /** Zone Name */
2332
- zone_name: string;
2333
2420
  };
2334
2421
  /** DomainLifecycleBase */
2335
2422
  DomainLifecycleBase: {
@@ -2952,27 +3039,58 @@ export interface components {
2952
3039
  * @enum {string}
2953
3040
  */
2954
3041
  HttpProtocol: "http" | "https";
2955
- /** HttpRedirect */
2956
- HttpRedirect: {
3042
+ /** HttpRedirectListResponse */
3043
+ HttpRedirectListResponse: {
2957
3044
  redirect_code: components["schemas"]["RedirectCode"];
3045
+ /** Request Hostname */
3046
+ request_hostname: string;
2958
3047
  /** Request Path */
2959
3048
  request_path: string;
3049
+ request_protocol: components["schemas"]["HttpProtocol"];
2960
3050
  /** Request Subdomain */
2961
3051
  request_subdomain?: string | null;
2962
- /** Target Domain */
2963
- target_domain: string;
3052
+ /** Target Hostname */
3053
+ target_hostname: string;
2964
3054
  /** Target Path */
2965
3055
  target_path: string;
2966
3056
  target_protocol: components["schemas"]["HttpProtocol"];
2967
- /** Target Subdomain */
2968
- target_subdomain?: string | null;
2969
3057
  };
2970
3058
  /** HttpRedirectRemove */
2971
3059
  HttpRedirectRemove: {
3060
+ /** Request Hostname */
3061
+ request_hostname: string;
3062
+ /** Request Path */
3063
+ request_path: string;
3064
+ request_protocol: components["schemas"]["HttpProtocol"];
3065
+ /** Request Subdomain */
3066
+ request_subdomain?: string | null;
3067
+ };
3068
+ /** HttpRedirectRequest */
3069
+ HttpRedirectRequest: {
3070
+ redirect_code: components["schemas"]["RedirectCode"];
3071
+ /** Request Path */
3072
+ request_path: string;
3073
+ /** Target Hostname */
3074
+ target_hostname: string;
3075
+ /** Target Path */
3076
+ target_path: string;
3077
+ target_protocol: components["schemas"]["HttpProtocol"];
3078
+ };
3079
+ /** HttpRedirectUpsert */
3080
+ HttpRedirectUpsert: {
3081
+ redirect_code: components["schemas"]["RedirectCode"];
3082
+ /** Request Hostname */
3083
+ request_hostname: string;
2972
3084
  /** Request Path */
2973
3085
  request_path: string;
3086
+ request_protocol?: components["schemas"]["HttpProtocol"] | null;
2974
3087
  /** Request Subdomain */
2975
3088
  request_subdomain?: string | null;
3089
+ /** Target Hostname */
3090
+ target_hostname: string;
3091
+ /** Target Path */
3092
+ target_path: string;
3093
+ target_protocol: components["schemas"]["HttpProtocol"];
2976
3094
  };
2977
3095
  /** IdnBase */
2978
3096
  IdnBase: {
@@ -3726,11 +3844,11 @@ export interface components {
3726
3844
  /** Results */
3727
3845
  results: components["schemas"]["DnsZoneResponse"][];
3728
3846
  };
3729
- /** Pagination[DomainForwardZone] */
3730
- Pagination_DomainForwardZone_: {
3847
+ /** Pagination[DomainForward] */
3848
+ Pagination_DomainForward_: {
3731
3849
  pagination: components["schemas"]["PaginationMetadata"];
3732
3850
  /** Results */
3733
- results: components["schemas"]["DomainForwardZone"][];
3851
+ results: components["schemas"]["DomainForward"][];
3734
3852
  };
3735
3853
  /** Pagination[DomainResponse] */
3736
3854
  Pagination_DomainResponse_: {
@@ -3878,11 +3996,6 @@ export interface components {
3878
3996
  /** Problem type */
3879
3997
  type: string;
3880
3998
  };
3881
- /** ProtocolRedirects */
3882
- ProtocolRedirects: {
3883
- /** Redirects */
3884
- redirects: components["schemas"]["HttpRedirect"][];
3885
- };
3886
3999
  /** PublicAuthRequestForm */
3887
4000
  PublicAuthRequestForm: {
3888
4001
  /**
@@ -4578,6 +4691,19 @@ export interface components {
4578
4691
  */
4579
4692
  whois_server?: string | null;
4580
4693
  };
4694
+ /** WildcardHttpRedirectRequest */
4695
+ WildcardHttpRedirectRequest: {
4696
+ redirect_code: components["schemas"]["RedirectCode"];
4697
+ /** Request Path */
4698
+ request_path: string;
4699
+ /** Request Subdomain */
4700
+ request_subdomain: string;
4701
+ /** Target Hostname */
4702
+ target_hostname: string;
4703
+ /** Target Path */
4704
+ target_path: string;
4705
+ target_protocol: components["schemas"]["HttpProtocol"];
4706
+ };
4581
4707
  /**
4582
4708
  * ZoneSortField
4583
4709
  * @enum {string}
@@ -5881,7 +6007,39 @@ export interface operations {
5881
6007
  [name: string]: unknown;
5882
6008
  };
5883
6009
  content: {
5884
- "application/json": components["schemas"]["Pagination_DomainForwardZone_"];
6010
+ "application/json": components["schemas"]["Pagination_DomainForward_"];
6011
+ };
6012
+ };
6013
+ /** @description Unauthorized */
6014
+ 401: {
6015
+ headers: {
6016
+ [name: string]: unknown;
6017
+ };
6018
+ content: {
6019
+ /** @example {
6020
+ * "code": "ERROR_AUTHENTICATION",
6021
+ * "detail": "Additional error context.",
6022
+ * "status": 401,
6023
+ * "title": "Authentication Error",
6024
+ * "type": "authentication"
6025
+ * } */
6026
+ "application/problem+json": components["schemas"]["Problem"];
6027
+ };
6028
+ };
6029
+ /** @description Forbidden */
6030
+ 403: {
6031
+ headers: {
6032
+ [name: string]: unknown;
6033
+ };
6034
+ content: {
6035
+ /** @example {
6036
+ * "code": "ERROR_PERMISSION_DENIED",
6037
+ * "detail": "Insufficient permissions to perform this action",
6038
+ * "status": 403,
6039
+ * "title": "Permission Denied",
6040
+ * "type": "permission-denied"
6041
+ * } */
6042
+ "application/problem+json": components["schemas"]["Problem"];
5885
6043
  };
5886
6044
  };
5887
6045
  /** @description Validation Error */
@@ -5915,6 +6073,38 @@ export interface operations {
5915
6073
  };
5916
6074
  content?: never;
5917
6075
  };
6076
+ /** @description Unauthorized */
6077
+ 401: {
6078
+ headers: {
6079
+ [name: string]: unknown;
6080
+ };
6081
+ content: {
6082
+ /** @example {
6083
+ * "code": "ERROR_AUTHENTICATION",
6084
+ * "detail": "Additional error context.",
6085
+ * "status": 401,
6086
+ * "title": "Authentication Error",
6087
+ * "type": "authentication"
6088
+ * } */
6089
+ "application/problem+json": components["schemas"]["Problem"];
6090
+ };
6091
+ };
6092
+ /** @description Forbidden */
6093
+ 403: {
6094
+ headers: {
6095
+ [name: string]: unknown;
6096
+ };
6097
+ content: {
6098
+ /** @example {
6099
+ * "code": "ERROR_PERMISSION_DENIED",
6100
+ * "detail": "Insufficient permissions to perform this action",
6101
+ * "status": 403,
6102
+ * "title": "Permission Denied",
6103
+ * "type": "permission-denied"
6104
+ * } */
6105
+ "application/problem+json": components["schemas"]["Problem"];
6106
+ };
6107
+ };
5918
6108
  /** @description Not Found */
5919
6109
  404: {
5920
6110
  headers: {
@@ -5923,7 +6113,7 @@ export interface operations {
5923
6113
  content: {
5924
6114
  /** @example {
5925
6115
  * "code": "ERROR_DOMAIN_FORWARD_NOT_EXISTS",
5926
- * "detail": "Domain forward not found",
6116
+ * "detail": "Domain forward not found for Additional error context.",
5927
6117
  * "status": 404,
5928
6118
  * "title": "Domain Forward Error",
5929
6119
  * "type": "domain-forward-not-found"
@@ -5942,59 +6132,74 @@ export interface operations {
5942
6132
  };
5943
6133
  };
5944
6134
  };
5945
- disable_domain_forward_v1_domain_forwards__zone_name__disable_patch: {
6135
+ get_domain_forward_v1_domain_forwards__hostname__get: {
5946
6136
  parameters: {
5947
6137
  query?: never;
5948
6138
  header?: never;
5949
6139
  path: {
5950
- /** @description DNS zone name (trailing dot optional) */
5951
- zone_name: string;
6140
+ /** @description Hostname (trailing dot optional) */
6141
+ hostname: string;
5952
6142
  };
5953
6143
  cookie?: never;
5954
6144
  };
5955
6145
  requestBody?: never;
5956
6146
  responses: {
5957
6147
  /** @description Successful Response */
5958
- 204: {
6148
+ 200: {
5959
6149
  headers: {
5960
6150
  [name: string]: unknown;
5961
6151
  };
5962
- content?: never;
6152
+ content: {
6153
+ "application/json": components["schemas"]["DomainForward"];
6154
+ };
5963
6155
  };
5964
- /** @description Validation Error */
5965
- 422: {
6156
+ /** @description Unauthorized */
6157
+ 401: {
5966
6158
  headers: {
5967
6159
  [name: string]: unknown;
5968
6160
  };
5969
6161
  content: {
5970
- "application/problem+json": components["schemas"]["HTTPValidationError"];
6162
+ /** @example {
6163
+ * "code": "ERROR_AUTHENTICATION",
6164
+ * "detail": "Additional error context.",
6165
+ * "status": 401,
6166
+ * "title": "Authentication Error",
6167
+ * "type": "authentication"
6168
+ * } */
6169
+ "application/problem+json": components["schemas"]["Problem"];
5971
6170
  };
5972
6171
  };
5973
- };
5974
- };
5975
- enable_domain_forward_v1_domain_forwards__zone_name__enable_patch: {
5976
- parameters: {
5977
- query?: {
5978
- /** @description Auto create zone if it doesn't exist */
5979
- auto_create_zone?: boolean;
5980
- /** @description Wildcard domain forwarding */
5981
- wildcard?: boolean;
5982
- };
5983
- header?: never;
5984
- path: {
5985
- /** @description DNS zone name (trailing dot optional) */
5986
- zone_name: string;
6172
+ /** @description Forbidden */
6173
+ 403: {
6174
+ headers: {
6175
+ [name: string]: unknown;
6176
+ };
6177
+ content: {
6178
+ /** @example {
6179
+ * "code": "ERROR_PERMISSION_DENIED",
6180
+ * "detail": "Insufficient permissions to perform this action",
6181
+ * "status": 403,
6182
+ * "title": "Permission Denied",
6183
+ * "type": "permission-denied"
6184
+ * } */
6185
+ "application/problem+json": components["schemas"]["Problem"];
6186
+ };
5987
6187
  };
5988
- cookie?: never;
5989
- };
5990
- requestBody?: never;
5991
- responses: {
5992
- /** @description Successful Response */
5993
- 204: {
6188
+ /** @description Not Found */
6189
+ 404: {
5994
6190
  headers: {
5995
6191
  [name: string]: unknown;
5996
6192
  };
5997
- content?: never;
6193
+ content: {
6194
+ /** @example {
6195
+ * "code": "ERROR_DOMAIN_FORWARD_NOT_EXISTS",
6196
+ * "detail": "Domain forward not found for Additional error context.",
6197
+ * "status": 404,
6198
+ * "title": "Domain Forward Error",
6199
+ * "type": "domain-forward-not-found"
6200
+ * } */
6201
+ "application/problem+json": components["schemas"]["Problem"];
6202
+ };
5998
6203
  };
5999
6204
  /** @description Validation Error */
6000
6205
  422: {
@@ -6007,21 +6212,24 @@ export interface operations {
6007
6212
  };
6008
6213
  };
6009
6214
  };
6010
- get_domain_forward_v1_domain_forwards__zone_name___request_protocol__get: {
6215
+ create_domain_forward_v1_domain_forwards__hostname__post: {
6011
6216
  parameters: {
6012
6217
  query?: never;
6013
6218
  header?: never;
6014
6219
  path: {
6015
- request_protocol: components["schemas"]["HttpProtocol"];
6016
- /** @description DNS zone name (trailing dot optional) */
6017
- zone_name: string;
6220
+ /** @description Hostname (trailing dot optional) */
6221
+ hostname: string;
6018
6222
  };
6019
6223
  cookie?: never;
6020
6224
  };
6021
- requestBody?: never;
6225
+ requestBody: {
6226
+ content: {
6227
+ "application/json": components["schemas"]["DomainForwardRequest"];
6228
+ };
6229
+ };
6022
6230
  responses: {
6023
6231
  /** @description Successful Response */
6024
- 200: {
6232
+ 201: {
6025
6233
  headers: {
6026
6234
  [name: string]: unknown;
6027
6235
  };
@@ -6029,7 +6237,55 @@ export interface operations {
6029
6237
  "application/json": components["schemas"]["DomainForward"];
6030
6238
  };
6031
6239
  };
6032
- /** @description Validation Error */
6240
+ /** @description Unauthorized */
6241
+ 401: {
6242
+ headers: {
6243
+ [name: string]: unknown;
6244
+ };
6245
+ content: {
6246
+ /** @example {
6247
+ * "code": "ERROR_AUTHENTICATION",
6248
+ * "detail": "Additional error context.",
6249
+ * "status": 401,
6250
+ * "title": "Authentication Error",
6251
+ * "type": "authentication"
6252
+ * } */
6253
+ "application/problem+json": components["schemas"]["Problem"];
6254
+ };
6255
+ };
6256
+ /** @description Forbidden */
6257
+ 403: {
6258
+ headers: {
6259
+ [name: string]: unknown;
6260
+ };
6261
+ content: {
6262
+ /** @example {
6263
+ * "code": "ERROR_PERMISSION_DENIED",
6264
+ * "detail": "Insufficient permissions to perform this action",
6265
+ * "status": 403,
6266
+ * "title": "Permission Denied",
6267
+ * "type": "permission-denied"
6268
+ * } */
6269
+ "application/problem+json": components["schemas"]["Problem"];
6270
+ };
6271
+ };
6272
+ /** @description Conflict */
6273
+ 409: {
6274
+ headers: {
6275
+ [name: string]: unknown;
6276
+ };
6277
+ content: {
6278
+ /** @example {
6279
+ * "code": "ERROR_DOMAIN_FORWARD_ALREADY_EXISTS",
6280
+ * "detail": "Domain forward already exists for Additional error context.",
6281
+ * "status": 409,
6282
+ * "title": "Domain Forward Error",
6283
+ * "type": "domain-forward-already-exists"
6284
+ * } */
6285
+ "application/problem+json": components["schemas"]["Problem"];
6286
+ };
6287
+ };
6288
+ /** @description Validation Error */
6033
6289
  422: {
6034
6290
  headers: {
6035
6291
  [name: string]: unknown;
@@ -6040,20 +6296,326 @@ export interface operations {
6040
6296
  };
6041
6297
  };
6042
6298
  };
6043
- update_domain_forward_v1_domain_forwards__zone_name___request_protocol__put: {
6299
+ delete_domain_forward_v1_domain_forwards__hostname__delete: {
6044
6300
  parameters: {
6045
6301
  query?: never;
6046
6302
  header?: never;
6047
6303
  path: {
6048
- request_protocol: components["schemas"]["HttpProtocol"];
6049
- /** @description DNS zone name (trailing dot optional) */
6050
- zone_name: string;
6304
+ /** @description Hostname (trailing dot optional) */
6305
+ hostname: string;
6306
+ };
6307
+ cookie?: never;
6308
+ };
6309
+ requestBody?: never;
6310
+ responses: {
6311
+ /** @description Successful Response */
6312
+ 204: {
6313
+ headers: {
6314
+ [name: string]: unknown;
6315
+ };
6316
+ content?: never;
6317
+ };
6318
+ /** @description Unauthorized */
6319
+ 401: {
6320
+ headers: {
6321
+ [name: string]: unknown;
6322
+ };
6323
+ content: {
6324
+ /** @example {
6325
+ * "code": "ERROR_AUTHENTICATION",
6326
+ * "detail": "Additional error context.",
6327
+ * "status": 401,
6328
+ * "title": "Authentication Error",
6329
+ * "type": "authentication"
6330
+ * } */
6331
+ "application/problem+json": components["schemas"]["Problem"];
6332
+ };
6333
+ };
6334
+ /** @description Forbidden */
6335
+ 403: {
6336
+ headers: {
6337
+ [name: string]: unknown;
6338
+ };
6339
+ content: {
6340
+ /** @example {
6341
+ * "code": "ERROR_PERMISSION_DENIED",
6342
+ * "detail": "Insufficient permissions to perform this action",
6343
+ * "status": 403,
6344
+ * "title": "Permission Denied",
6345
+ * "type": "permission-denied"
6346
+ * } */
6347
+ "application/problem+json": components["schemas"]["Problem"];
6348
+ };
6349
+ };
6350
+ /** @description Not Found */
6351
+ 404: {
6352
+ headers: {
6353
+ [name: string]: unknown;
6354
+ };
6355
+ content: {
6356
+ /** @example {
6357
+ * "code": "ERROR_DOMAIN_FORWARD_NOT_EXISTS",
6358
+ * "detail": "Domain forward not found for Additional error context.",
6359
+ * "status": 404,
6360
+ * "title": "Domain Forward Error",
6361
+ * "type": "domain-forward-not-found"
6362
+ * } */
6363
+ "application/problem+json": components["schemas"]["Problem"];
6364
+ };
6365
+ };
6366
+ /** @description Validation Error */
6367
+ 422: {
6368
+ headers: {
6369
+ [name: string]: unknown;
6370
+ };
6371
+ content: {
6372
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
6373
+ };
6374
+ };
6375
+ };
6376
+ };
6377
+ disable_domain_forward_v1_domain_forwards__hostname__disable_patch: {
6378
+ parameters: {
6379
+ query?: never;
6380
+ header?: never;
6381
+ path: {
6382
+ /** @description Hostname (trailing dot optional) */
6383
+ hostname: string;
6384
+ };
6385
+ cookie?: never;
6386
+ };
6387
+ requestBody?: never;
6388
+ responses: {
6389
+ /** @description Successful Response */
6390
+ 204: {
6391
+ headers: {
6392
+ [name: string]: unknown;
6393
+ };
6394
+ content?: never;
6395
+ };
6396
+ /** @description Unauthorized */
6397
+ 401: {
6398
+ headers: {
6399
+ [name: string]: unknown;
6400
+ };
6401
+ content: {
6402
+ /** @example {
6403
+ * "code": "ERROR_AUTHENTICATION",
6404
+ * "detail": "Additional error context.",
6405
+ * "status": 401,
6406
+ * "title": "Authentication Error",
6407
+ * "type": "authentication"
6408
+ * } */
6409
+ "application/problem+json": components["schemas"]["Problem"];
6410
+ };
6411
+ };
6412
+ /** @description Forbidden */
6413
+ 403: {
6414
+ headers: {
6415
+ [name: string]: unknown;
6416
+ };
6417
+ content: {
6418
+ /** @example {
6419
+ * "code": "ERROR_PERMISSION_DENIED",
6420
+ * "detail": "Insufficient permissions to perform this action",
6421
+ * "status": 403,
6422
+ * "title": "Permission Denied",
6423
+ * "type": "permission-denied"
6424
+ * } */
6425
+ "application/problem+json": components["schemas"]["Problem"];
6426
+ };
6427
+ };
6428
+ /** @description Validation Error */
6429
+ 422: {
6430
+ headers: {
6431
+ [name: string]: unknown;
6432
+ };
6433
+ content: {
6434
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
6435
+ };
6436
+ };
6437
+ };
6438
+ };
6439
+ enable_domain_forward_v1_domain_forwards__hostname__enable_patch: {
6440
+ parameters: {
6441
+ query?: {
6442
+ /** @description Auto create zone if it doesn't exist */
6443
+ auto_create_zone?: boolean;
6444
+ /** @description Auto create domain forward if it doesn't exist */
6445
+ auto_create_domain_forward?: boolean;
6446
+ /** @description Wildcard domain forwarding */
6447
+ wildcard?: boolean;
6448
+ };
6449
+ header?: never;
6450
+ path: {
6451
+ /** @description Hostname (trailing dot optional) */
6452
+ hostname: string;
6453
+ };
6454
+ cookie?: never;
6455
+ };
6456
+ requestBody?: never;
6457
+ responses: {
6458
+ /** @description Successful Response */
6459
+ 204: {
6460
+ headers: {
6461
+ [name: string]: unknown;
6462
+ };
6463
+ content?: never;
6464
+ };
6465
+ /** @description Bad Request */
6466
+ 400: {
6467
+ headers: {
6468
+ [name: string]: unknown;
6469
+ };
6470
+ content: {
6471
+ /** @example {
6472
+ * "code": "ERROR_DOMAIN_FORWARD_WILDCARD_NOT_SUPPORTED",
6473
+ * "detail": "Additional error context.",
6474
+ * "status": 400,
6475
+ * "title": "Wildcard Not Supported",
6476
+ * "type": "domain-forward-wildcard-not-supported"
6477
+ * } */
6478
+ "application/problem+json": components["schemas"]["Problem"];
6479
+ };
6480
+ };
6481
+ /** @description Unauthorized */
6482
+ 401: {
6483
+ headers: {
6484
+ [name: string]: unknown;
6485
+ };
6486
+ content: {
6487
+ /** @example {
6488
+ * "code": "ERROR_AUTHENTICATION",
6489
+ * "detail": "Additional error context.",
6490
+ * "status": 401,
6491
+ * "title": "Authentication Error",
6492
+ * "type": "authentication"
6493
+ * } */
6494
+ "application/problem+json": components["schemas"]["Problem"];
6495
+ };
6496
+ };
6497
+ /** @description Forbidden */
6498
+ 403: {
6499
+ headers: {
6500
+ [name: string]: unknown;
6501
+ };
6502
+ content: {
6503
+ /** @example {
6504
+ * "code": "ERROR_PERMISSION_DENIED",
6505
+ * "detail": "Insufficient permissions to perform this action",
6506
+ * "status": 403,
6507
+ * "title": "Permission Denied",
6508
+ * "type": "permission-denied"
6509
+ * } */
6510
+ "application/problem+json": components["schemas"]["Problem"];
6511
+ };
6512
+ };
6513
+ /** @description Validation Error */
6514
+ 422: {
6515
+ headers: {
6516
+ [name: string]: unknown;
6517
+ };
6518
+ content: {
6519
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
6520
+ };
6521
+ };
6522
+ };
6523
+ };
6524
+ get_domain_forward_set_v1_domain_forwards__hostname___protocol__get: {
6525
+ parameters: {
6526
+ query?: never;
6527
+ header?: never;
6528
+ path: {
6529
+ protocol: components["schemas"]["HttpProtocol"];
6530
+ /** @description Hostname (trailing dot optional) */
6531
+ hostname: string;
6532
+ };
6533
+ cookie?: never;
6534
+ };
6535
+ requestBody?: never;
6536
+ responses: {
6537
+ /** @description Successful Response */
6538
+ 200: {
6539
+ headers: {
6540
+ [name: string]: unknown;
6541
+ };
6542
+ content: {
6543
+ "application/json": components["schemas"]["DomainForwardSetResponse"];
6544
+ };
6545
+ };
6546
+ /** @description Unauthorized */
6547
+ 401: {
6548
+ headers: {
6549
+ [name: string]: unknown;
6550
+ };
6551
+ content: {
6552
+ /** @example {
6553
+ * "code": "ERROR_AUTHENTICATION",
6554
+ * "detail": "Additional error context.",
6555
+ * "status": 401,
6556
+ * "title": "Authentication Error",
6557
+ * "type": "authentication"
6558
+ * } */
6559
+ "application/problem+json": components["schemas"]["Problem"];
6560
+ };
6561
+ };
6562
+ /** @description Forbidden */
6563
+ 403: {
6564
+ headers: {
6565
+ [name: string]: unknown;
6566
+ };
6567
+ content: {
6568
+ /** @example {
6569
+ * "code": "ERROR_PERMISSION_DENIED",
6570
+ * "detail": "Insufficient permissions to perform this action",
6571
+ * "status": 403,
6572
+ * "title": "Permission Denied",
6573
+ * "type": "permission-denied"
6574
+ * } */
6575
+ "application/problem+json": components["schemas"]["Problem"];
6576
+ };
6577
+ };
6578
+ /** @description Not Found */
6579
+ 404: {
6580
+ headers: {
6581
+ [name: string]: unknown;
6582
+ };
6583
+ content: {
6584
+ /** @example {
6585
+ * "code": "ERROR_DOMAIN_FORWARD_NOT_EXISTS",
6586
+ * "detail": "Domain forward not found for Additional error context.",
6587
+ * "status": 404,
6588
+ * "title": "Domain Forward Error",
6589
+ * "type": "domain-forward-not-found"
6590
+ * } */
6591
+ "application/problem+json": components["schemas"]["Problem"];
6592
+ };
6593
+ };
6594
+ /** @description Validation Error */
6595
+ 422: {
6596
+ headers: {
6597
+ [name: string]: unknown;
6598
+ };
6599
+ content: {
6600
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
6601
+ };
6602
+ };
6603
+ };
6604
+ };
6605
+ update_domain_forward_set_v1_domain_forwards__hostname___protocol__put: {
6606
+ parameters: {
6607
+ query?: never;
6608
+ header?: never;
6609
+ path: {
6610
+ protocol: components["schemas"]["HttpProtocol"];
6611
+ /** @description Hostname (trailing dot optional) */
6612
+ hostname: string;
6051
6613
  };
6052
6614
  cookie?: never;
6053
6615
  };
6054
6616
  requestBody: {
6055
6617
  content: {
6056
- "application/json": components["schemas"]["DomainForwardRequest"];
6618
+ "application/json": components["schemas"]["DomainForwardSetRequest"];
6057
6619
  };
6058
6620
  };
6059
6621
  responses: {
@@ -6063,7 +6625,39 @@ export interface operations {
6063
6625
  [name: string]: unknown;
6064
6626
  };
6065
6627
  content: {
6066
- "application/json": components["schemas"]["DomainForward"];
6628
+ "application/json": components["schemas"]["DomainForwardSetResponse"];
6629
+ };
6630
+ };
6631
+ /** @description Unauthorized */
6632
+ 401: {
6633
+ headers: {
6634
+ [name: string]: unknown;
6635
+ };
6636
+ content: {
6637
+ /** @example {
6638
+ * "code": "ERROR_AUTHENTICATION",
6639
+ * "detail": "Additional error context.",
6640
+ * "status": 401,
6641
+ * "title": "Authentication Error",
6642
+ * "type": "authentication"
6643
+ * } */
6644
+ "application/problem+json": components["schemas"]["Problem"];
6645
+ };
6646
+ };
6647
+ /** @description Forbidden */
6648
+ 403: {
6649
+ headers: {
6650
+ [name: string]: unknown;
6651
+ };
6652
+ content: {
6653
+ /** @example {
6654
+ * "code": "ERROR_PERMISSION_DENIED",
6655
+ * "detail": "Insufficient permissions to perform this action",
6656
+ * "status": 403,
6657
+ * "title": "Permission Denied",
6658
+ * "type": "permission-denied"
6659
+ * } */
6660
+ "application/problem+json": components["schemas"]["Problem"];
6067
6661
  };
6068
6662
  };
6069
6663
  /** @description Not Found */
@@ -6074,7 +6668,7 @@ export interface operations {
6074
6668
  content: {
6075
6669
  /** @example {
6076
6670
  * "code": "ERROR_DOMAIN_FORWARD_NOT_EXISTS",
6077
- * "detail": "Domain forward not found",
6671
+ * "detail": "Domain forward not found for Additional error context.",
6078
6672
  * "status": 404,
6079
6673
  * "title": "Domain Forward Error",
6080
6674
  * "type": "domain-forward-not-found"
@@ -6093,20 +6687,20 @@ export interface operations {
6093
6687
  };
6094
6688
  };
6095
6689
  };
6096
- create_domain_forward_v1_domain_forwards__zone_name___request_protocol__post: {
6690
+ create_domain_forward_set_v1_domain_forwards__hostname___protocol__post: {
6097
6691
  parameters: {
6098
6692
  query?: never;
6099
6693
  header?: never;
6100
6694
  path: {
6101
- request_protocol: components["schemas"]["HttpProtocol"];
6102
- /** @description DNS zone name (trailing dot optional) */
6103
- zone_name: string;
6695
+ protocol: components["schemas"]["HttpProtocol"];
6696
+ /** @description Hostname (trailing dot optional) */
6697
+ hostname: string;
6104
6698
  };
6105
6699
  cookie?: never;
6106
6700
  };
6107
6701
  requestBody: {
6108
6702
  content: {
6109
- "application/json": components["schemas"]["DomainForwardRequest"];
6703
+ "application/json": components["schemas"]["DomainForwardSetRequest"];
6110
6704
  };
6111
6705
  };
6112
6706
  responses: {
@@ -6116,7 +6710,55 @@ export interface operations {
6116
6710
  [name: string]: unknown;
6117
6711
  };
6118
6712
  content: {
6119
- "application/json": components["schemas"]["DomainForward"];
6713
+ "application/json": components["schemas"]["DomainForwardSetResponse"];
6714
+ };
6715
+ };
6716
+ /** @description Unauthorized */
6717
+ 401: {
6718
+ headers: {
6719
+ [name: string]: unknown;
6720
+ };
6721
+ content: {
6722
+ /** @example {
6723
+ * "code": "ERROR_AUTHENTICATION",
6724
+ * "detail": "Additional error context.",
6725
+ * "status": 401,
6726
+ * "title": "Authentication Error",
6727
+ * "type": "authentication"
6728
+ * } */
6729
+ "application/problem+json": components["schemas"]["Problem"];
6730
+ };
6731
+ };
6732
+ /** @description Forbidden */
6733
+ 403: {
6734
+ headers: {
6735
+ [name: string]: unknown;
6736
+ };
6737
+ content: {
6738
+ /** @example {
6739
+ * "code": "ERROR_PERMISSION_DENIED",
6740
+ * "detail": "Insufficient permissions to perform this action",
6741
+ * "status": 403,
6742
+ * "title": "Permission Denied",
6743
+ * "type": "permission-denied"
6744
+ * } */
6745
+ "application/problem+json": components["schemas"]["Problem"];
6746
+ };
6747
+ };
6748
+ /** @description Not Found */
6749
+ 404: {
6750
+ headers: {
6751
+ [name: string]: unknown;
6752
+ };
6753
+ content: {
6754
+ /** @example {
6755
+ * "code": "ERROR_DOMAIN_FORWARD_NOT_EXISTS",
6756
+ * "detail": "Domain forward not found for Additional error context.",
6757
+ * "status": 404,
6758
+ * "title": "Domain Forward Error",
6759
+ * "type": "domain-forward-not-found"
6760
+ * } */
6761
+ "application/problem+json": components["schemas"]["Problem"];
6120
6762
  };
6121
6763
  };
6122
6764
  /** @description Conflict */
@@ -6127,7 +6769,7 @@ export interface operations {
6127
6769
  content: {
6128
6770
  /** @example {
6129
6771
  * "code": "ERROR_DOMAIN_FORWARD_ALREADY_EXISTS",
6130
- * "detail": "Domain forward already exists",
6772
+ * "detail": "Domain forward already exists for Additional error context.",
6131
6773
  * "status": 409,
6132
6774
  * "title": "Domain Forward Error",
6133
6775
  * "type": "domain-forward-already-exists"
@@ -6146,14 +6788,14 @@ export interface operations {
6146
6788
  };
6147
6789
  };
6148
6790
  };
6149
- delete_domain_forward_v1_domain_forwards__zone_name___request_protocol__delete: {
6791
+ delete_domain_forward_set_v1_domain_forwards__hostname___protocol__delete: {
6150
6792
  parameters: {
6151
6793
  query?: never;
6152
6794
  header?: never;
6153
6795
  path: {
6154
- request_protocol: components["schemas"]["HttpProtocol"];
6155
- /** @description DNS zone name (trailing dot optional) */
6156
- zone_name: string;
6796
+ protocol: components["schemas"]["HttpProtocol"];
6797
+ /** @description Hostname (trailing dot optional) */
6798
+ hostname: string;
6157
6799
  };
6158
6800
  cookie?: never;
6159
6801
  };
@@ -6166,6 +6808,38 @@ export interface operations {
6166
6808
  };
6167
6809
  content?: never;
6168
6810
  };
6811
+ /** @description Unauthorized */
6812
+ 401: {
6813
+ headers: {
6814
+ [name: string]: unknown;
6815
+ };
6816
+ content: {
6817
+ /** @example {
6818
+ * "code": "ERROR_AUTHENTICATION",
6819
+ * "detail": "Additional error context.",
6820
+ * "status": 401,
6821
+ * "title": "Authentication Error",
6822
+ * "type": "authentication"
6823
+ * } */
6824
+ "application/problem+json": components["schemas"]["Problem"];
6825
+ };
6826
+ };
6827
+ /** @description Forbidden */
6828
+ 403: {
6829
+ headers: {
6830
+ [name: string]: unknown;
6831
+ };
6832
+ content: {
6833
+ /** @example {
6834
+ * "code": "ERROR_PERMISSION_DENIED",
6835
+ * "detail": "Insufficient permissions to perform this action",
6836
+ * "status": 403,
6837
+ * "title": "Permission Denied",
6838
+ * "type": "permission-denied"
6839
+ * } */
6840
+ "application/problem+json": components["schemas"]["Problem"];
6841
+ };
6842
+ };
6169
6843
  /** @description Not Found */
6170
6844
  404: {
6171
6845
  headers: {
@@ -6174,7 +6848,7 @@ export interface operations {
6174
6848
  content: {
6175
6849
  /** @example {
6176
6850
  * "code": "ERROR_DOMAIN_FORWARD_NOT_EXISTS",
6177
- * "detail": "Domain forward not found",
6851
+ * "detail": "Domain forward not found for Additional error context.",
6178
6852
  * "status": 404,
6179
6853
  * "title": "Domain Forward Error",
6180
6854
  * "type": "domain-forward-not-found"