@opusdns/api 0.121.0 → 0.123.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/src/helpers/keys.ts +389 -105
- package/src/helpers/requests.d.ts +78 -19
- package/src/helpers/responses.d.ts +222 -8
- package/src/helpers/schemas.d.ts +48 -16
- package/src/openapi.yaml +318 -35
- package/src/schema.d.ts +250 -27
package/src/schema.d.ts
CHANGED
|
@@ -475,7 +475,11 @@ export interface paths {
|
|
|
475
475
|
*/
|
|
476
476
|
get: operations["list_domain_forwards_v1_domain_forwards_get"];
|
|
477
477
|
put?: never;
|
|
478
|
-
|
|
478
|
+
/**
|
|
479
|
+
* Create a domain forward
|
|
480
|
+
* @description Creates a new domain forward configuration. Wildcard forwards can be created by using *.hostname (e.g., *.example.com).
|
|
481
|
+
*/
|
|
482
|
+
post: operations["create_domain_forward_v2_v1_domain_forwards_post"];
|
|
479
483
|
delete?: never;
|
|
480
484
|
options?: never;
|
|
481
485
|
head?: never;
|
|
@@ -500,8 +504,9 @@ export interface paths {
|
|
|
500
504
|
get: operations["get_domain_forward_v1_domain_forwards__hostname__get"];
|
|
501
505
|
put?: never;
|
|
502
506
|
/**
|
|
503
|
-
* Create a domain forward
|
|
504
|
-
* @
|
|
507
|
+
* Create a domain forward (deprecated)
|
|
508
|
+
* @deprecated
|
|
509
|
+
* @description **DEPRECATED**: Use POST /v1/domain-forwards instead. Creates a new domain forward configuration for the specified hostname.
|
|
505
510
|
*/
|
|
506
511
|
post: operations["create_domain_forward_v1_domain_forwards__hostname__post"];
|
|
507
512
|
/**
|
|
@@ -718,6 +723,23 @@ export interface paths {
|
|
|
718
723
|
patch?: never;
|
|
719
724
|
trace?: never;
|
|
720
725
|
};
|
|
726
|
+
"/v1/domains/tld-specific/eu/{domain_reference}/auth_code/request": {
|
|
727
|
+
parameters: {
|
|
728
|
+
query?: never;
|
|
729
|
+
header?: never;
|
|
730
|
+
path?: never;
|
|
731
|
+
cookie?: never;
|
|
732
|
+
};
|
|
733
|
+
get?: never;
|
|
734
|
+
put?: never;
|
|
735
|
+
/** Requests your auth code directly from EURid (registry) */
|
|
736
|
+
post: operations["request_auth_code_v1_domains_tld_specific_eu__domain_reference__auth_code_request_post"];
|
|
737
|
+
delete?: never;
|
|
738
|
+
options?: never;
|
|
739
|
+
head?: never;
|
|
740
|
+
patch?: never;
|
|
741
|
+
trace?: never;
|
|
742
|
+
};
|
|
721
743
|
"/v1/domains/transfer": {
|
|
722
744
|
parameters: {
|
|
723
745
|
query?: never;
|
|
@@ -2638,6 +2660,18 @@ export interface components {
|
|
|
2638
2660
|
/** Wildcard */
|
|
2639
2661
|
wildcard: boolean;
|
|
2640
2662
|
};
|
|
2663
|
+
/** DomainForwardCreateRequest */
|
|
2664
|
+
DomainForwardCreateRequest: {
|
|
2665
|
+
/**
|
|
2666
|
+
* Enabled
|
|
2667
|
+
* @default false
|
|
2668
|
+
*/
|
|
2669
|
+
enabled: boolean;
|
|
2670
|
+
/** Hostname */
|
|
2671
|
+
hostname: string;
|
|
2672
|
+
http?: components["schemas"]["DomainForwardProtocolSetRequest"] | null;
|
|
2673
|
+
https?: components["schemas"]["DomainForwardProtocolSetRequest"] | null;
|
|
2674
|
+
};
|
|
2641
2675
|
/** DomainForwardPatchOp */
|
|
2642
2676
|
DomainForwardPatchOp: {
|
|
2643
2677
|
op: components["schemas"]["PatchOp"];
|
|
@@ -4729,24 +4763,6 @@ export interface components {
|
|
|
4729
4763
|
* @enum {string}
|
|
4730
4764
|
*/
|
|
4731
4765
|
RenewalMode: "renew" | "expire" | "delete";
|
|
4732
|
-
/** RequestAuthcodeResponse */
|
|
4733
|
-
RequestAuthcodeResponse: {
|
|
4734
|
-
/**
|
|
4735
|
-
* Detail
|
|
4736
|
-
* @description Additional information about the result in case of failure
|
|
4737
|
-
*/
|
|
4738
|
-
detail?: string | null;
|
|
4739
|
-
/**
|
|
4740
|
-
* Name
|
|
4741
|
-
* @description The domain name that had the auth code requested
|
|
4742
|
-
*/
|
|
4743
|
-
name: string;
|
|
4744
|
-
/**
|
|
4745
|
-
* Success
|
|
4746
|
-
* @description Whether the request had a successful result from DNS Belgium
|
|
4747
|
-
*/
|
|
4748
|
-
success: boolean;
|
|
4749
|
-
};
|
|
4750
4766
|
/** RequestHistory */
|
|
4751
4767
|
RequestHistory: {
|
|
4752
4768
|
/**
|
|
@@ -5458,6 +5474,52 @@ export interface components {
|
|
|
5458
5474
|
* @enum {string}
|
|
5459
5475
|
*/
|
|
5460
5476
|
ZoneSortField: "name" | "created_on" | "updated_on" | "dnssec_status";
|
|
5477
|
+
/** RequestAuthcodeResponse */
|
|
5478
|
+
api__domain__tld_specific__be__models__RequestAuthcodeResponse: {
|
|
5479
|
+
/**
|
|
5480
|
+
* Detail
|
|
5481
|
+
* @description Additional information about the result in case of failure
|
|
5482
|
+
*/
|
|
5483
|
+
detail?: string | null;
|
|
5484
|
+
/**
|
|
5485
|
+
* Name
|
|
5486
|
+
* @description The domain name that had the auth code requested
|
|
5487
|
+
*/
|
|
5488
|
+
name: string;
|
|
5489
|
+
/**
|
|
5490
|
+
* Success
|
|
5491
|
+
* @description Whether the request had a successful result from DNS Belgium
|
|
5492
|
+
*/
|
|
5493
|
+
success: boolean;
|
|
5494
|
+
};
|
|
5495
|
+
/** RequestAuthcodeResponse */
|
|
5496
|
+
api__domain__tld_specific__eu__models__RequestAuthcodeResponse: {
|
|
5497
|
+
/**
|
|
5498
|
+
* Auth Code
|
|
5499
|
+
* @description The auth code returned by EURid
|
|
5500
|
+
*/
|
|
5501
|
+
auth_code?: string | null;
|
|
5502
|
+
/**
|
|
5503
|
+
* Auth Code Expires On
|
|
5504
|
+
* @description The expiry date of the auth code
|
|
5505
|
+
*/
|
|
5506
|
+
auth_code_expires_on?: Date | null;
|
|
5507
|
+
/**
|
|
5508
|
+
* Detail
|
|
5509
|
+
* @description Additional information about the result in case of failure
|
|
5510
|
+
*/
|
|
5511
|
+
detail?: string | null;
|
|
5512
|
+
/**
|
|
5513
|
+
* Name
|
|
5514
|
+
* @description The domain name that had the auth code requested
|
|
5515
|
+
*/
|
|
5516
|
+
name: string;
|
|
5517
|
+
/**
|
|
5518
|
+
* Success
|
|
5519
|
+
* @description Whether the request had a successful result from EURid
|
|
5520
|
+
*/
|
|
5521
|
+
success: boolean;
|
|
5522
|
+
};
|
|
5461
5523
|
/** DomainAvailabilityResponse */
|
|
5462
5524
|
common__models__availability__datasource__DomainAvailabilityResponse: {
|
|
5463
5525
|
meta: components["schemas"]["DomainAvailabilityMeta"];
|
|
@@ -7301,6 +7363,104 @@ export interface operations {
|
|
|
7301
7363
|
};
|
|
7302
7364
|
};
|
|
7303
7365
|
};
|
|
7366
|
+
create_domain_forward_v2_v1_domain_forwards_post: {
|
|
7367
|
+
parameters: {
|
|
7368
|
+
query?: never;
|
|
7369
|
+
header?: never;
|
|
7370
|
+
path?: never;
|
|
7371
|
+
cookie?: never;
|
|
7372
|
+
};
|
|
7373
|
+
requestBody: {
|
|
7374
|
+
content: {
|
|
7375
|
+
"application/json": components["schemas"]["DomainForwardCreateRequest"];
|
|
7376
|
+
};
|
|
7377
|
+
};
|
|
7378
|
+
responses: {
|
|
7379
|
+
/** @description Domain forward created successfully */
|
|
7380
|
+
201: {
|
|
7381
|
+
headers: {
|
|
7382
|
+
[name: string]: unknown;
|
|
7383
|
+
};
|
|
7384
|
+
content: {
|
|
7385
|
+
"application/json": components["schemas"]["DomainForward"];
|
|
7386
|
+
};
|
|
7387
|
+
};
|
|
7388
|
+
/** @description Unauthorized */
|
|
7389
|
+
401: {
|
|
7390
|
+
headers: {
|
|
7391
|
+
[name: string]: unknown;
|
|
7392
|
+
};
|
|
7393
|
+
content: {
|
|
7394
|
+
/** @example {
|
|
7395
|
+
* "code": "ERROR_AUTHENTICATION",
|
|
7396
|
+
* "detail": "Additional error context.",
|
|
7397
|
+
* "status": 401,
|
|
7398
|
+
* "title": "Authentication Error",
|
|
7399
|
+
* "type": "authentication"
|
|
7400
|
+
* } */
|
|
7401
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
7402
|
+
};
|
|
7403
|
+
};
|
|
7404
|
+
/** @description Forbidden */
|
|
7405
|
+
403: {
|
|
7406
|
+
headers: {
|
|
7407
|
+
[name: string]: unknown;
|
|
7408
|
+
};
|
|
7409
|
+
content: {
|
|
7410
|
+
/** @example {
|
|
7411
|
+
* "code": "ERROR_PERMISSION_DENIED",
|
|
7412
|
+
* "detail": "Insufficient permissions to perform this action",
|
|
7413
|
+
* "status": 403,
|
|
7414
|
+
* "title": "Permission Denied",
|
|
7415
|
+
* "type": "permission-denied"
|
|
7416
|
+
* } */
|
|
7417
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
7418
|
+
};
|
|
7419
|
+
};
|
|
7420
|
+
/** @description DNS zone was not found */
|
|
7421
|
+
404: {
|
|
7422
|
+
headers: {
|
|
7423
|
+
[name: string]: unknown;
|
|
7424
|
+
};
|
|
7425
|
+
content: {
|
|
7426
|
+
/** @example {
|
|
7427
|
+
* "code": "ERROR_ZONE_NOT_FOUND",
|
|
7428
|
+
* "detail": "Zone not found",
|
|
7429
|
+
* "status": 404,
|
|
7430
|
+
* "title": "DNS Error",
|
|
7431
|
+
* "type": "dns-zone-not-found",
|
|
7432
|
+
* "zone_name": "Zone example.com. not found"
|
|
7433
|
+
* } */
|
|
7434
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
7435
|
+
};
|
|
7436
|
+
};
|
|
7437
|
+
/** @description Domain forward already exists */
|
|
7438
|
+
409: {
|
|
7439
|
+
headers: {
|
|
7440
|
+
[name: string]: unknown;
|
|
7441
|
+
};
|
|
7442
|
+
content: {
|
|
7443
|
+
/** @example {
|
|
7444
|
+
* "code": "ERROR_DOMAIN_FORWARD_ALREADY_EXISTS",
|
|
7445
|
+
* "detail": "Domain forward already exists for example.com.",
|
|
7446
|
+
* "status": 409,
|
|
7447
|
+
* "title": "Domain Forward Error",
|
|
7448
|
+
* "type": "domain-forward-already-exists"
|
|
7449
|
+
* } */
|
|
7450
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
7451
|
+
};
|
|
7452
|
+
};
|
|
7453
|
+
/** @description Validation Error */
|
|
7454
|
+
422: {
|
|
7455
|
+
headers: {
|
|
7456
|
+
[name: string]: unknown;
|
|
7457
|
+
};
|
|
7458
|
+
content: {
|
|
7459
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
7460
|
+
};
|
|
7461
|
+
};
|
|
7462
|
+
};
|
|
7463
|
+
};
|
|
7304
7464
|
patch_redirects_v1_domain_forwards_patch: {
|
|
7305
7465
|
parameters: {
|
|
7306
7466
|
query?: never;
|
|
@@ -7703,10 +7863,7 @@ export interface operations {
|
|
|
7703
7863
|
};
|
|
7704
7864
|
enable_domain_forward_v1_domain_forwards__hostname__enable_patch: {
|
|
7705
7865
|
parameters: {
|
|
7706
|
-
query?:
|
|
7707
|
-
/** @description Wildcard domain forwarding */
|
|
7708
|
-
wildcard?: boolean;
|
|
7709
|
-
};
|
|
7866
|
+
query?: never;
|
|
7710
7867
|
header?: never;
|
|
7711
7868
|
path: {
|
|
7712
7869
|
/** @description Hostname */
|
|
@@ -7733,7 +7890,7 @@ export interface operations {
|
|
|
7733
7890
|
* "code": "ERROR_DOMAIN_FORWARD_WILDCARD_NOT_SUPPORTED",
|
|
7734
7891
|
* "detail": "Additional error context.",
|
|
7735
7892
|
* "status": 400,
|
|
7736
|
-
* "title": "Wildcard Not Supported",
|
|
7893
|
+
* "title": "HTTPS Wildcard Not Supported",
|
|
7737
7894
|
* "type": "domain-forward-wildcard-not-supported"
|
|
7738
7895
|
* } */
|
|
7739
7896
|
"application/problem+json": components["schemas"]["Problem"];
|
|
@@ -8457,7 +8614,7 @@ export interface operations {
|
|
|
8457
8614
|
[name: string]: unknown;
|
|
8458
8615
|
};
|
|
8459
8616
|
content: {
|
|
8460
|
-
"application/json": components["schemas"]["
|
|
8617
|
+
"application/json": components["schemas"]["api__domain__tld_specific__be__models__RequestAuthcodeResponse"];
|
|
8461
8618
|
};
|
|
8462
8619
|
};
|
|
8463
8620
|
/** @description Bad Request */
|
|
@@ -8558,6 +8715,72 @@ export interface operations {
|
|
|
8558
8715
|
};
|
|
8559
8716
|
};
|
|
8560
8717
|
};
|
|
8718
|
+
request_auth_code_v1_domains_tld_specific_eu__domain_reference__auth_code_request_post: {
|
|
8719
|
+
parameters: {
|
|
8720
|
+
query?: never;
|
|
8721
|
+
header?: never;
|
|
8722
|
+
path: {
|
|
8723
|
+
domain_reference: TypeId<"domain"> | string;
|
|
8724
|
+
};
|
|
8725
|
+
cookie?: never;
|
|
8726
|
+
};
|
|
8727
|
+
requestBody?: never;
|
|
8728
|
+
responses: {
|
|
8729
|
+
/** @description Successful Response */
|
|
8730
|
+
200: {
|
|
8731
|
+
headers: {
|
|
8732
|
+
[name: string]: unknown;
|
|
8733
|
+
};
|
|
8734
|
+
content: {
|
|
8735
|
+
"application/json": components["schemas"]["api__domain__tld_specific__eu__models__RequestAuthcodeResponse"];
|
|
8736
|
+
};
|
|
8737
|
+
};
|
|
8738
|
+
/** @description Bad Request */
|
|
8739
|
+
400: {
|
|
8740
|
+
headers: {
|
|
8741
|
+
[name: string]: unknown;
|
|
8742
|
+
};
|
|
8743
|
+
content: {
|
|
8744
|
+
/** @example {
|
|
8745
|
+
* "code": "ERROR_DOMAIN_TRANSFER",
|
|
8746
|
+
* "detail": "There was an error transferring the domain",
|
|
8747
|
+
* "domain_name": "Additional error context.",
|
|
8748
|
+
* "reason": "An unspecified error occurred",
|
|
8749
|
+
* "status": 400,
|
|
8750
|
+
* "title": "Domain Transfer Error",
|
|
8751
|
+
* "type": "domain-transfer"
|
|
8752
|
+
* } */
|
|
8753
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
8754
|
+
};
|
|
8755
|
+
};
|
|
8756
|
+
/** @description Not Found */
|
|
8757
|
+
404: {
|
|
8758
|
+
headers: {
|
|
8759
|
+
[name: string]: unknown;
|
|
8760
|
+
};
|
|
8761
|
+
content: {
|
|
8762
|
+
/** @example {
|
|
8763
|
+
* "code": "ERROR_DOMAIN_NOT_FOUND",
|
|
8764
|
+
* "detail": "Domain not found",
|
|
8765
|
+
* "domain_name": "Additional error context.",
|
|
8766
|
+
* "status": 404,
|
|
8767
|
+
* "title": "Domain Management Error",
|
|
8768
|
+
* "type": "domain-not-found"
|
|
8769
|
+
* } */
|
|
8770
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
8771
|
+
};
|
|
8772
|
+
};
|
|
8773
|
+
/** @description Validation Error */
|
|
8774
|
+
422: {
|
|
8775
|
+
headers: {
|
|
8776
|
+
[name: string]: unknown;
|
|
8777
|
+
};
|
|
8778
|
+
content: {
|
|
8779
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
8780
|
+
};
|
|
8781
|
+
};
|
|
8782
|
+
};
|
|
8783
|
+
};
|
|
8561
8784
|
transfer_domain_v1_domains_transfer_post: {
|
|
8562
8785
|
parameters: {
|
|
8563
8786
|
query?: never;
|