@opusdns/api 0.208.0 → 0.210.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 +107 -710
- package/src/helpers/requests.d.ts +0 -55
- package/src/helpers/responses.d.ts +5 -140
- package/src/helpers/schemas-arrays.d.ts +20 -6
- package/src/helpers/schemas.d.ts +6 -38
- package/src/openapi.yaml +38 -285
- package/src/schema.d.ts +32 -232
package/src/schema.d.ts
CHANGED
|
@@ -806,12 +806,7 @@ export interface paths {
|
|
|
806
806
|
* @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.
|
|
807
807
|
*/
|
|
808
808
|
put: operations["update_domain_forward_set_v1_domain_forwards__hostname___protocol__put"];
|
|
809
|
-
|
|
810
|
-
* Create domain forward set (deprecated)
|
|
811
|
-
* @deprecated
|
|
812
|
-
* @description Deprecated: Use POST /{hostname} with protocol in body instead. Creates a new domain forward set for a specific protocol (HTTP or HTTPS).
|
|
813
|
-
*/
|
|
814
|
-
post: operations["create_domain_forward_set_deprecated_v1_domain_forwards__hostname___protocol__post"];
|
|
809
|
+
post?: never;
|
|
815
810
|
/**
|
|
816
811
|
* Delete domain forward set
|
|
817
812
|
* @description Deletes a domain forward set for a specific protocol (HTTP or HTTPS).
|
|
@@ -2356,8 +2351,29 @@ export interface components {
|
|
|
2356
2351
|
*/
|
|
2357
2352
|
title?: string | null;
|
|
2358
2353
|
};
|
|
2359
|
-
/**
|
|
2360
|
-
|
|
2354
|
+
/** ContactHandle */
|
|
2355
|
+
ContactHandle: {
|
|
2356
|
+
/**
|
|
2357
|
+
* Attributes
|
|
2358
|
+
* @description Additional attributes related to the contact
|
|
2359
|
+
*/
|
|
2360
|
+
attributes?: {
|
|
2361
|
+
[key: string]: string;
|
|
2362
|
+
} | null;
|
|
2363
|
+
/**
|
|
2364
|
+
* Contact Id
|
|
2365
|
+
* Format: typeid
|
|
2366
|
+
* @description The contact id of the contact
|
|
2367
|
+
* @example contact_01h45ytscbebyvny4gc8cr8ma2
|
|
2368
|
+
*/
|
|
2369
|
+
contact_id: TypeId<"contact">;
|
|
2370
|
+
};
|
|
2371
|
+
/** @description The contacts of the domain */
|
|
2372
|
+
ContactIdList: {
|
|
2373
|
+
[key: string]: TypeId<"contact">;
|
|
2374
|
+
};
|
|
2375
|
+
/** ContactResponse */
|
|
2376
|
+
ContactResponse: {
|
|
2361
2377
|
/**
|
|
2362
2378
|
* Attribute Sets
|
|
2363
2379
|
* @description Linked attribute sets for this contact
|
|
@@ -2385,11 +2401,6 @@ export interface components {
|
|
|
2385
2401
|
* @description The date/time the entry was created on
|
|
2386
2402
|
*/
|
|
2387
2403
|
created_on?: Date;
|
|
2388
|
-
/**
|
|
2389
|
-
* Deleted On
|
|
2390
|
-
* @description The date/time the entry was deleted on
|
|
2391
|
-
*/
|
|
2392
|
-
deleted_on?: Date | null;
|
|
2393
2404
|
/**
|
|
2394
2405
|
* Disclose
|
|
2395
2406
|
* @description Whether the contact details should be disclosed. The Disclose function may not work with all TLDs. Some registries still display the data in Whois if, for example, the organization field is filled in.
|
|
@@ -2457,98 +2468,6 @@ export interface components {
|
|
|
2457
2468
|
*/
|
|
2458
2469
|
title?: string | null;
|
|
2459
2470
|
};
|
|
2460
|
-
/** ContactHandle */
|
|
2461
|
-
ContactHandle: {
|
|
2462
|
-
/**
|
|
2463
|
-
* Attributes
|
|
2464
|
-
* @description Additional attributes related to the contact
|
|
2465
|
-
*/
|
|
2466
|
-
attributes?: {
|
|
2467
|
-
[key: string]: string;
|
|
2468
|
-
} | null;
|
|
2469
|
-
/**
|
|
2470
|
-
* Contact Id
|
|
2471
|
-
* Format: typeid
|
|
2472
|
-
* @description The contact id of the contact
|
|
2473
|
-
* @example contact_01h45ytscbebyvny4gc8cr8ma2
|
|
2474
|
-
*/
|
|
2475
|
-
contact_id: TypeId<"contact">;
|
|
2476
|
-
};
|
|
2477
|
-
/** @description The contacts of the domain */
|
|
2478
|
-
ContactIdList: {
|
|
2479
|
-
[key: string]: TypeId<"contact">;
|
|
2480
|
-
};
|
|
2481
|
-
/** ContactResponse */
|
|
2482
|
-
ContactResponse: {
|
|
2483
|
-
/**
|
|
2484
|
-
* City
|
|
2485
|
-
* @description The city of the contact
|
|
2486
|
-
*/
|
|
2487
|
-
city: string;
|
|
2488
|
-
/**
|
|
2489
|
-
* Country
|
|
2490
|
-
* @description The country of the contact
|
|
2491
|
-
*/
|
|
2492
|
-
country: string;
|
|
2493
|
-
/**
|
|
2494
|
-
* Disclose
|
|
2495
|
-
* @description Whether the contact details should be disclosed. The Disclose function may not work with all TLDs. Some registries still display the data in Whois if, for example, the organization field is filled in.
|
|
2496
|
-
*/
|
|
2497
|
-
disclose: boolean;
|
|
2498
|
-
/**
|
|
2499
|
-
* Email
|
|
2500
|
-
* Format: email
|
|
2501
|
-
* @description The email of the contact
|
|
2502
|
-
*/
|
|
2503
|
-
email: string;
|
|
2504
|
-
/**
|
|
2505
|
-
* Fax
|
|
2506
|
-
* @description The contacts's fax number
|
|
2507
|
-
*/
|
|
2508
|
-
fax?: string | null;
|
|
2509
|
-
/**
|
|
2510
|
-
* First Name
|
|
2511
|
-
* @description The first name of the contact
|
|
2512
|
-
*/
|
|
2513
|
-
first_name: string;
|
|
2514
|
-
/**
|
|
2515
|
-
* Last Name
|
|
2516
|
-
* @description The last name of the contact
|
|
2517
|
-
*/
|
|
2518
|
-
last_name: string;
|
|
2519
|
-
/**
|
|
2520
|
-
* Org
|
|
2521
|
-
* @description The organization of the contact
|
|
2522
|
-
*/
|
|
2523
|
-
org?: string | null;
|
|
2524
|
-
/**
|
|
2525
|
-
* Phone
|
|
2526
|
-
* Format: phone
|
|
2527
|
-
* @description The contact's phone number
|
|
2528
|
-
* @example +1.2125552368
|
|
2529
|
-
*/
|
|
2530
|
-
phone: string;
|
|
2531
|
-
/**
|
|
2532
|
-
* Postal Code
|
|
2533
|
-
* @description The postal code of the contact
|
|
2534
|
-
*/
|
|
2535
|
-
postal_code: string;
|
|
2536
|
-
/**
|
|
2537
|
-
* State
|
|
2538
|
-
* @description The state of the contact
|
|
2539
|
-
*/
|
|
2540
|
-
state?: string | null;
|
|
2541
|
-
/**
|
|
2542
|
-
* Street
|
|
2543
|
-
* @description The address of the contact
|
|
2544
|
-
*/
|
|
2545
|
-
street: string;
|
|
2546
|
-
/**
|
|
2547
|
-
* Title
|
|
2548
|
-
* @description The title of the contact
|
|
2549
|
-
*/
|
|
2550
|
-
title?: string | null;
|
|
2551
|
-
};
|
|
2552
2471
|
/** ContactSchema */
|
|
2553
2472
|
ContactSchema: {
|
|
2554
2473
|
/**
|
|
@@ -2573,11 +2492,6 @@ export interface components {
|
|
|
2573
2492
|
* @description The date/time the entry was created on
|
|
2574
2493
|
*/
|
|
2575
2494
|
created_on?: Date;
|
|
2576
|
-
/**
|
|
2577
|
-
* Deleted On
|
|
2578
|
-
* @description The date/time the entry was deleted on
|
|
2579
|
-
*/
|
|
2580
|
-
deleted_on?: Date | null;
|
|
2581
2495
|
/**
|
|
2582
2496
|
* Disclose
|
|
2583
2497
|
* @description Whether the contact details should be disclosed. The Disclose function may not work with all TLDs. Some registries still display the data in Whois if, for example, the organization field is filled in.
|
|
@@ -3363,7 +3277,7 @@ export interface components {
|
|
|
3363
3277
|
/** DomainForwardProtocolSetRequest */
|
|
3364
3278
|
DomainForwardProtocolSetRequest: {
|
|
3365
3279
|
/** Redirects */
|
|
3366
|
-
redirects:
|
|
3280
|
+
redirects: components["schemas"]["HttpRedirectRequest"][];
|
|
3367
3281
|
};
|
|
3368
3282
|
/** DomainForwardProtocolSetResponse */
|
|
3369
3283
|
DomainForwardProtocolSetResponse: {
|
|
@@ -3389,12 +3303,12 @@ export interface components {
|
|
|
3389
3303
|
DomainForwardSetCreateRequest: {
|
|
3390
3304
|
protocol: components["schemas"]["HttpProtocol"];
|
|
3391
3305
|
/** Redirects */
|
|
3392
|
-
redirects:
|
|
3306
|
+
redirects: components["schemas"]["HttpRedirectRequest"][];
|
|
3393
3307
|
};
|
|
3394
3308
|
/** DomainForwardSetRequest */
|
|
3395
3309
|
DomainForwardSetRequest: {
|
|
3396
3310
|
/** Redirects */
|
|
3397
|
-
redirects:
|
|
3311
|
+
redirects: components["schemas"]["HttpRedirectRequest"][];
|
|
3398
3312
|
};
|
|
3399
3313
|
/** DomainForwardSetResponse */
|
|
3400
3314
|
DomainForwardSetResponse: {
|
|
@@ -5379,11 +5293,11 @@ export interface components {
|
|
|
5379
5293
|
/** Results */
|
|
5380
5294
|
results: components["schemas"]["ContactAttributeSetResponse"][];
|
|
5381
5295
|
};
|
|
5382
|
-
/** Pagination[
|
|
5383
|
-
|
|
5296
|
+
/** Pagination[ContactResponse] */
|
|
5297
|
+
Pagination_ContactResponse_: {
|
|
5384
5298
|
pagination: components["schemas"]["PaginationMetadata"];
|
|
5385
5299
|
/** Results */
|
|
5386
|
-
results: components["schemas"]["
|
|
5300
|
+
results: components["schemas"]["ContactResponse"][];
|
|
5387
5301
|
};
|
|
5388
5302
|
/** Pagination[DnsZoneResponse] */
|
|
5389
5303
|
Pagination_DnsZoneResponse_: {
|
|
@@ -6708,19 +6622,6 @@ export interface components {
|
|
|
6708
6622
|
*/
|
|
6709
6623
|
whois_server?: string | null;
|
|
6710
6624
|
};
|
|
6711
|
-
/** WildcardHttpRedirectRequest */
|
|
6712
|
-
WildcardHttpRedirectRequest: {
|
|
6713
|
-
redirect_code: components["schemas"]["RedirectCode"];
|
|
6714
|
-
/** Request Path */
|
|
6715
|
-
request_path: string;
|
|
6716
|
-
/** Request Subdomain */
|
|
6717
|
-
request_subdomain: string;
|
|
6718
|
-
/** Target Hostname */
|
|
6719
|
-
target_hostname: string;
|
|
6720
|
-
/** Target Path */
|
|
6721
|
-
target_path: string;
|
|
6722
|
-
target_protocol: components["schemas"]["HttpProtocol"];
|
|
6723
|
-
};
|
|
6724
6625
|
/**
|
|
6725
6626
|
* ZoneSortField
|
|
6726
6627
|
* @enum {string}
|
|
@@ -7221,7 +7122,7 @@ export interface operations {
|
|
|
7221
7122
|
[name: string]: unknown;
|
|
7222
7123
|
};
|
|
7223
7124
|
content: {
|
|
7224
|
-
"application/json": components["schemas"]["
|
|
7125
|
+
"application/json": components["schemas"]["Pagination_ContactResponse_"];
|
|
7225
7126
|
};
|
|
7226
7127
|
};
|
|
7227
7128
|
/** @description Validation Error */
|
|
@@ -7698,7 +7599,7 @@ export interface operations {
|
|
|
7698
7599
|
[name: string]: unknown;
|
|
7699
7600
|
};
|
|
7700
7601
|
content: {
|
|
7701
|
-
"application/json": components["schemas"]["
|
|
7602
|
+
"application/json": components["schemas"]["ContactResponse"];
|
|
7702
7603
|
};
|
|
7703
7604
|
};
|
|
7704
7605
|
/** @description Not Found */
|
|
@@ -10369,107 +10270,6 @@ export interface operations {
|
|
|
10369
10270
|
};
|
|
10370
10271
|
};
|
|
10371
10272
|
};
|
|
10372
|
-
create_domain_forward_set_deprecated_v1_domain_forwards__hostname___protocol__post: {
|
|
10373
|
-
parameters: {
|
|
10374
|
-
query?: never;
|
|
10375
|
-
header?: never;
|
|
10376
|
-
path: {
|
|
10377
|
-
protocol: components["schemas"]["HttpProtocol"];
|
|
10378
|
-
/** @description Hostname */
|
|
10379
|
-
hostname: string;
|
|
10380
|
-
};
|
|
10381
|
-
cookie?: never;
|
|
10382
|
-
};
|
|
10383
|
-
requestBody: {
|
|
10384
|
-
content: {
|
|
10385
|
-
"application/json": components["schemas"]["DomainForwardSetRequest"];
|
|
10386
|
-
};
|
|
10387
|
-
};
|
|
10388
|
-
responses: {
|
|
10389
|
-
/** @description Domain forward protocol set created successfully */
|
|
10390
|
-
201: {
|
|
10391
|
-
headers: {
|
|
10392
|
-
[name: string]: unknown;
|
|
10393
|
-
};
|
|
10394
|
-
content: {
|
|
10395
|
-
"application/json": components["schemas"]["DomainForwardSetResponse"];
|
|
10396
|
-
};
|
|
10397
|
-
};
|
|
10398
|
-
/** @description Unauthorized */
|
|
10399
|
-
401: {
|
|
10400
|
-
headers: {
|
|
10401
|
-
[name: string]: unknown;
|
|
10402
|
-
};
|
|
10403
|
-
content: {
|
|
10404
|
-
/** @example {
|
|
10405
|
-
* "code": "ERROR_AUTHENTICATION",
|
|
10406
|
-
* "detail": "Additional error context.",
|
|
10407
|
-
* "status": 401,
|
|
10408
|
-
* "title": "Authentication Error",
|
|
10409
|
-
* "type": "authentication"
|
|
10410
|
-
* } */
|
|
10411
|
-
"application/problem+json": components["schemas"]["Problem"];
|
|
10412
|
-
};
|
|
10413
|
-
};
|
|
10414
|
-
/** @description Forbidden */
|
|
10415
|
-
403: {
|
|
10416
|
-
headers: {
|
|
10417
|
-
[name: string]: unknown;
|
|
10418
|
-
};
|
|
10419
|
-
content: {
|
|
10420
|
-
/** @example {
|
|
10421
|
-
* "code": "ERROR_PERMISSION_DENIED",
|
|
10422
|
-
* "detail": "Insufficient permissions to perform this action",
|
|
10423
|
-
* "status": 403,
|
|
10424
|
-
* "title": "Permission Denied",
|
|
10425
|
-
* "type": "permission-denied"
|
|
10426
|
-
* } */
|
|
10427
|
-
"application/problem+json": components["schemas"]["Problem"];
|
|
10428
|
-
};
|
|
10429
|
-
};
|
|
10430
|
-
/** @description Not Found */
|
|
10431
|
-
404: {
|
|
10432
|
-
headers: {
|
|
10433
|
-
[name: string]: unknown;
|
|
10434
|
-
};
|
|
10435
|
-
content: {
|
|
10436
|
-
/** @example {
|
|
10437
|
-
* "code": "ERROR_DOMAIN_FORWARD_NOT_EXISTS",
|
|
10438
|
-
* "detail": "Domain forward not found for Additional error context.",
|
|
10439
|
-
* "status": 404,
|
|
10440
|
-
* "title": "Domain Forward Error",
|
|
10441
|
-
* "type": "domain-forward-not-found"
|
|
10442
|
-
* } */
|
|
10443
|
-
"application/problem+json": components["schemas"]["Problem"];
|
|
10444
|
-
};
|
|
10445
|
-
};
|
|
10446
|
-
/** @description Conflict */
|
|
10447
|
-
409: {
|
|
10448
|
-
headers: {
|
|
10449
|
-
[name: string]: unknown;
|
|
10450
|
-
};
|
|
10451
|
-
content: {
|
|
10452
|
-
/** @example {
|
|
10453
|
-
* "code": "ERROR_DOMAIN_FORWARD_ALREADY_EXISTS",
|
|
10454
|
-
* "detail": "Domain forward already exists for Additional error context.",
|
|
10455
|
-
* "status": 409,
|
|
10456
|
-
* "title": "Domain Forward Error",
|
|
10457
|
-
* "type": "domain-forward-already-exists"
|
|
10458
|
-
* } */
|
|
10459
|
-
"application/problem+json": components["schemas"]["Problem"];
|
|
10460
|
-
};
|
|
10461
|
-
};
|
|
10462
|
-
/** @description Validation Error */
|
|
10463
|
-
422: {
|
|
10464
|
-
headers: {
|
|
10465
|
-
[name: string]: unknown;
|
|
10466
|
-
};
|
|
10467
|
-
content: {
|
|
10468
|
-
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
10469
|
-
};
|
|
10470
|
-
};
|
|
10471
|
-
};
|
|
10472
|
-
};
|
|
10473
10273
|
delete_domain_forward_set_v1_domain_forwards__hostname___protocol__delete: {
|
|
10474
10274
|
parameters: {
|
|
10475
10275
|
query?: never;
|