@opusdns/api 0.10.0 → 0.12.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 +3 -3
- package/src/helpers/constants.ts +771 -1
- package/src/helpers/index.ts +1 -0
- package/src/helpers/keys.ts +8077 -4699
- package/src/helpers/requests.ts +537 -441
- package/src/helpers/responses.ts +440 -547
- package/src/helpers/schemas-arrays.ts +169 -1
- package/src/helpers/schemas.ts +624 -0
- package/src/openapi.yaml +975 -1
- package/src/schema.d.ts +732 -0
- /package/src/{index.ts → index.d.ts} +0 -0
package/src/schema.d.ts
CHANGED
|
@@ -35,6 +35,23 @@ export interface paths {
|
|
|
35
35
|
patch?: never;
|
|
36
36
|
trace?: never;
|
|
37
37
|
};
|
|
38
|
+
"/v1/auth/internal_client_credentials": {
|
|
39
|
+
parameters: {
|
|
40
|
+
query?: never;
|
|
41
|
+
header?: never;
|
|
42
|
+
path?: never;
|
|
43
|
+
cookie?: never;
|
|
44
|
+
};
|
|
45
|
+
get?: never;
|
|
46
|
+
put?: never;
|
|
47
|
+
/** Issue Opusdns Internal Api Key */
|
|
48
|
+
post: operations["issue_opusdns_internal_api_key_v1_auth_internal_client_credentials_post"];
|
|
49
|
+
delete?: never;
|
|
50
|
+
options?: never;
|
|
51
|
+
head?: never;
|
|
52
|
+
patch?: never;
|
|
53
|
+
trace?: never;
|
|
54
|
+
};
|
|
38
55
|
"/v1/auth/logout": {
|
|
39
56
|
parameters: {
|
|
40
57
|
query?: never;
|
|
@@ -888,6 +905,40 @@ export interface paths {
|
|
|
888
905
|
patch: operations["change_plan_v1_organizations__organization_id__plan_patch"];
|
|
889
906
|
trace?: never;
|
|
890
907
|
};
|
|
908
|
+
"/v1/tlds/portfolio": {
|
|
909
|
+
parameters: {
|
|
910
|
+
query?: never;
|
|
911
|
+
header?: never;
|
|
912
|
+
path?: never;
|
|
913
|
+
cookie?: never;
|
|
914
|
+
};
|
|
915
|
+
/** Get Tld Portfolio */
|
|
916
|
+
get: operations["get_tld_portfolio_v1_tlds_portfolio_get"];
|
|
917
|
+
put?: never;
|
|
918
|
+
post?: never;
|
|
919
|
+
delete?: never;
|
|
920
|
+
options?: never;
|
|
921
|
+
head?: never;
|
|
922
|
+
patch?: never;
|
|
923
|
+
trace?: never;
|
|
924
|
+
};
|
|
925
|
+
"/v1/tlds/{tld}": {
|
|
926
|
+
parameters: {
|
|
927
|
+
query?: never;
|
|
928
|
+
header?: never;
|
|
929
|
+
path?: never;
|
|
930
|
+
cookie?: never;
|
|
931
|
+
};
|
|
932
|
+
/** Get Tld Spec */
|
|
933
|
+
get: operations["get_tld_spec_v1_tlds__tld__get"];
|
|
934
|
+
put?: never;
|
|
935
|
+
post?: never;
|
|
936
|
+
delete?: never;
|
|
937
|
+
options?: never;
|
|
938
|
+
head?: never;
|
|
939
|
+
patch?: never;
|
|
940
|
+
trace?: never;
|
|
941
|
+
};
|
|
891
942
|
"/v1/users": {
|
|
892
943
|
parameters: {
|
|
893
944
|
query?: never;
|
|
@@ -997,6 +1048,24 @@ export interface paths {
|
|
|
997
1048
|
export type webhooks = Record<string, never>;
|
|
998
1049
|
export interface components {
|
|
999
1050
|
schemas: {
|
|
1051
|
+
/**
|
|
1052
|
+
* AllocationMethodType
|
|
1053
|
+
* @enum {string}
|
|
1054
|
+
*/
|
|
1055
|
+
AllocationMethodType: "fcfs" | "auction" | "lottery";
|
|
1056
|
+
/** AllowedNumberOfNameserverBase */
|
|
1057
|
+
AllowedNumberOfNameserverBase: {
|
|
1058
|
+
/**
|
|
1059
|
+
* Max
|
|
1060
|
+
* @description Maximum number of nameserver per domain name
|
|
1061
|
+
*/
|
|
1062
|
+
max: number;
|
|
1063
|
+
/**
|
|
1064
|
+
* Min
|
|
1065
|
+
* @description Minimum number of nameserver per domain name
|
|
1066
|
+
*/
|
|
1067
|
+
min: number;
|
|
1068
|
+
};
|
|
1000
1069
|
/** Body_issue_organization_token_v1_auth_token_post */
|
|
1001
1070
|
Body_issue_organization_token_v1_auth_token_post: {
|
|
1002
1071
|
/**
|
|
@@ -1047,6 +1116,21 @@ export interface components {
|
|
|
1047
1116
|
* @enum {string}
|
|
1048
1117
|
*/
|
|
1049
1118
|
BulkOperationStatus: "success" | "failed";
|
|
1119
|
+
/** ContactConfigBase */
|
|
1120
|
+
ContactConfigBase: {
|
|
1121
|
+
/**
|
|
1122
|
+
* Max
|
|
1123
|
+
* @description Maximum contacts per domain name
|
|
1124
|
+
*/
|
|
1125
|
+
max: number;
|
|
1126
|
+
/**
|
|
1127
|
+
* Min
|
|
1128
|
+
* @description Minimum contacts per domain name
|
|
1129
|
+
*/
|
|
1130
|
+
min: number;
|
|
1131
|
+
/** @description The type of contact */
|
|
1132
|
+
type: components["schemas"]["ContactRoleType"];
|
|
1133
|
+
};
|
|
1050
1134
|
/** ContactCreate */
|
|
1051
1135
|
ContactCreate: {
|
|
1052
1136
|
/**
|
|
@@ -1190,6 +1274,11 @@ export interface components {
|
|
|
1190
1274
|
*/
|
|
1191
1275
|
title?: string | null;
|
|
1192
1276
|
};
|
|
1277
|
+
/**
|
|
1278
|
+
* ContactRoleType
|
|
1279
|
+
* @enum {string}
|
|
1280
|
+
*/
|
|
1281
|
+
ContactRoleType: "registrant" | "admin" | "tech" | "billing";
|
|
1193
1282
|
/** ContactSchema */
|
|
1194
1283
|
ContactSchema: {
|
|
1195
1284
|
/**
|
|
@@ -1425,11 +1514,61 @@ export interface components {
|
|
|
1425
1514
|
*/
|
|
1426
1515
|
verified_on?: Date | null;
|
|
1427
1516
|
};
|
|
1517
|
+
/** ContactsBase */
|
|
1518
|
+
ContactsBase: {
|
|
1519
|
+
/**
|
|
1520
|
+
* Authinfo Required
|
|
1521
|
+
* @description Whether the registry requires authinfo for contact creation
|
|
1522
|
+
*/
|
|
1523
|
+
authinfo_required?: boolean | null;
|
|
1524
|
+
/**
|
|
1525
|
+
* Is Thick
|
|
1526
|
+
* @description Whether the registry supports thick contacts
|
|
1527
|
+
*/
|
|
1528
|
+
is_thick?: boolean | null;
|
|
1529
|
+
/**
|
|
1530
|
+
* Privacy Proxy
|
|
1531
|
+
* @description Whether a privacy service is allowed
|
|
1532
|
+
*/
|
|
1533
|
+
privacy_proxy?: boolean | null;
|
|
1534
|
+
/** @description Whether the registrant can change through update or trade */
|
|
1535
|
+
registrant_change?: components["schemas"]["RegistrantChangeType"] | null;
|
|
1536
|
+
/**
|
|
1537
|
+
* Support Check
|
|
1538
|
+
* @description Whether the registry supports contact checks
|
|
1539
|
+
*/
|
|
1540
|
+
support_check?: boolean | null;
|
|
1541
|
+
/**
|
|
1542
|
+
* Support Client Contact Id
|
|
1543
|
+
* @description Whether the registry supports client defined contact ID
|
|
1544
|
+
*/
|
|
1545
|
+
support_client_contact_id?: boolean | null;
|
|
1546
|
+
/**
|
|
1547
|
+
* Support Transfer
|
|
1548
|
+
* @description Whether the registry supports contact transfer
|
|
1549
|
+
*/
|
|
1550
|
+
support_transfer?: boolean | null;
|
|
1551
|
+
/**
|
|
1552
|
+
* Supported Postal Types
|
|
1553
|
+
* @description Supported postal address types
|
|
1554
|
+
*/
|
|
1555
|
+
supported_postal_types?: components["schemas"]["PostalAddressType"][] | null;
|
|
1556
|
+
/**
|
|
1557
|
+
* Supported Roles
|
|
1558
|
+
* @description Supported contact roles
|
|
1559
|
+
*/
|
|
1560
|
+
supported_roles?: components["schemas"]["ContactConfigBase"][] | null;
|
|
1561
|
+
};
|
|
1428
1562
|
/**
|
|
1429
1563
|
* Currency
|
|
1430
1564
|
* @enum {string}
|
|
1431
1565
|
*/
|
|
1432
1566
|
Currency: "USD" | "EUR";
|
|
1567
|
+
/**
|
|
1568
|
+
* DeletePolicyType
|
|
1569
|
+
* @enum {string}
|
|
1570
|
+
*/
|
|
1571
|
+
DeletePolicyType: "immediate" | "expiration";
|
|
1433
1572
|
/** DeletedEvent */
|
|
1434
1573
|
DeletedEvent: {
|
|
1435
1574
|
date: components["schemas"]["EppDateTime"];
|
|
@@ -1461,6 +1600,47 @@ export interface components {
|
|
|
1461
1600
|
/** Zone Name */
|
|
1462
1601
|
zone_name: string;
|
|
1463
1602
|
};
|
|
1603
|
+
/** DnsConfigurationBase */
|
|
1604
|
+
DnsConfigurationBase: {
|
|
1605
|
+
allowed_number_of_nameserver: components["schemas"]["AllowedNumberOfNameserverBase"];
|
|
1606
|
+
/**
|
|
1607
|
+
* Czds Available
|
|
1608
|
+
* @description Whether the zone is available in CZDS
|
|
1609
|
+
*/
|
|
1610
|
+
czds_available?: boolean | null;
|
|
1611
|
+
/**
|
|
1612
|
+
* Dnssec Allowed
|
|
1613
|
+
* @description Whether the registry supports DNSSEC
|
|
1614
|
+
*/
|
|
1615
|
+
dnssec_allowed: boolean;
|
|
1616
|
+
/**
|
|
1617
|
+
* Dnssec Mandatory
|
|
1618
|
+
* @description Whether DNSSEC is mandatory for a domain name
|
|
1619
|
+
*/
|
|
1620
|
+
dnssec_mandatory?: boolean | null;
|
|
1621
|
+
/** @description DNSSEC mode */
|
|
1622
|
+
dnssec_mode?: components["schemas"]["DnssecModeType"] | null;
|
|
1623
|
+
/**
|
|
1624
|
+
* Host Objects
|
|
1625
|
+
* @description Whether the registry supports host objects or use attributes
|
|
1626
|
+
*/
|
|
1627
|
+
host_objects: boolean;
|
|
1628
|
+
/**
|
|
1629
|
+
* Host Parent Check Tlds
|
|
1630
|
+
* @description TLDs that require parent-host checks (ns1.example.com => example.com)
|
|
1631
|
+
*/
|
|
1632
|
+
host_parent_check_tlds?: string[] | null;
|
|
1633
|
+
/**
|
|
1634
|
+
* Registry Nameserver Check
|
|
1635
|
+
* @description Whether the registry checks the nameserver configuration
|
|
1636
|
+
*/
|
|
1637
|
+
registry_nameserver_check: boolean;
|
|
1638
|
+
/**
|
|
1639
|
+
* Registry Root Nameserver Update
|
|
1640
|
+
* @description Number of hours until the root zone is updated, 0 = real-time
|
|
1641
|
+
*/
|
|
1642
|
+
registry_root_nameserver_update: number;
|
|
1643
|
+
};
|
|
1464
1644
|
/** DnsRecordCreate */
|
|
1465
1645
|
DnsRecordCreate: {
|
|
1466
1646
|
/** Rdata */
|
|
@@ -1570,6 +1750,11 @@ export interface components {
|
|
|
1570
1750
|
* @enum {integer}
|
|
1571
1751
|
*/
|
|
1572
1752
|
DnssecDigestType: 1 | 2 | 3 | 4 | 5 | 6;
|
|
1753
|
+
/**
|
|
1754
|
+
* DnssecModeType
|
|
1755
|
+
* @enum {string}
|
|
1756
|
+
*/
|
|
1757
|
+
DnssecModeType: "DS" | "DNSKEY";
|
|
1573
1758
|
/**
|
|
1574
1759
|
* DnssecRecordType
|
|
1575
1760
|
* @enum {string}
|
|
@@ -1740,6 +1925,63 @@ export interface components {
|
|
|
1740
1925
|
*/
|
|
1741
1926
|
updated_on?: Date;
|
|
1742
1927
|
};
|
|
1928
|
+
/** DomainLifecycleBase */
|
|
1929
|
+
DomainLifecycleBase: {
|
|
1930
|
+
/**
|
|
1931
|
+
* Add Grace Period
|
|
1932
|
+
* @description Add grace period in days after registration in ISO 8601 format (e.g., 5D, 3D)
|
|
1933
|
+
*/
|
|
1934
|
+
add_grace_period?: string | null;
|
|
1935
|
+
/**
|
|
1936
|
+
* Auto Renew Before Expiration
|
|
1937
|
+
* @description Time before expiration to auto-renew a domain in ISO 8601 format (e.g., 5D, -7D)
|
|
1938
|
+
*/
|
|
1939
|
+
auto_renew_before_expiration?: string | null;
|
|
1940
|
+
/**
|
|
1941
|
+
* Delete Before Expiration
|
|
1942
|
+
* @description Time before expiration to delete a domain in ISO 8601 format (e.g., 5D, -7D)
|
|
1943
|
+
*/
|
|
1944
|
+
delete_before_expiration?: string | null;
|
|
1945
|
+
/**
|
|
1946
|
+
* Delete Policy
|
|
1947
|
+
* @description How a domain can be deleted
|
|
1948
|
+
*/
|
|
1949
|
+
delete_policy?: components["schemas"]["DeletePolicyType"][] | null;
|
|
1950
|
+
/**
|
|
1951
|
+
* Explicit Renew
|
|
1952
|
+
* @description Whether an explicit renewal is possible
|
|
1953
|
+
*/
|
|
1954
|
+
explicit_renew?: boolean | null;
|
|
1955
|
+
/**
|
|
1956
|
+
* Grace Period
|
|
1957
|
+
* @description Grace period after expiration in ISO 8601 format (e.g., 5D, -7D)
|
|
1958
|
+
*/
|
|
1959
|
+
grace_period?: string | null;
|
|
1960
|
+
/**
|
|
1961
|
+
* Pending Delete
|
|
1962
|
+
* @description Pending delete period in ISO 8601 format (e.g., 5D, 10D) after redemption_period
|
|
1963
|
+
*/
|
|
1964
|
+
pending_delete?: string | null;
|
|
1965
|
+
/**
|
|
1966
|
+
* Redemption Period
|
|
1967
|
+
* @description Redemption period for domain recovery after grace period in ISO 8601 format (e.g., 5D, -7D)
|
|
1968
|
+
*/
|
|
1969
|
+
redemption_period?: string | null;
|
|
1970
|
+
/** @description List of allowed registration periods (e.g., '1y' or ['1y', '2y', '5y']) */
|
|
1971
|
+
registration_periods?: components["schemas"]["PeriodList"];
|
|
1972
|
+
/**
|
|
1973
|
+
* Registry Auto Renew
|
|
1974
|
+
* @description Does the registry enforce auto-renewal
|
|
1975
|
+
*/
|
|
1976
|
+
registry_auto_renew?: boolean | null;
|
|
1977
|
+
/** @description List of allowed renewal periods (e.g., '1y' or ['1y', '2y', '5y']) */
|
|
1978
|
+
renewal_periods?: components["schemas"]["PeriodList"];
|
|
1979
|
+
/**
|
|
1980
|
+
* Sync After Operations
|
|
1981
|
+
* @description Operations that trigger a sync with the registry
|
|
1982
|
+
*/
|
|
1983
|
+
sync_after_operations?: components["schemas"]["SyncOperationType"][] | null;
|
|
1984
|
+
};
|
|
1743
1985
|
/** DomainNameParts */
|
|
1744
1986
|
DomainNameParts: {
|
|
1745
1987
|
/** Domain */
|
|
@@ -1924,6 +2166,19 @@ export interface components {
|
|
|
1924
2166
|
* @enum {string}
|
|
1925
2167
|
*/
|
|
1926
2168
|
DomainStatus: "ok" | "serverTransferProhibited" | "serverUpdateProhibited" | "serverDeleteProhibited" | "serverRenewProhibited" | "serverHold" | "transferPeriod" | "renewPeriod" | "redemptionPeriod" | "pendingUpdate" | "pendingTransfer" | "pendingRestore" | "pendingRenew" | "pendingDelete" | "pendingCreate" | "inactive" | "autoRenewPeriod" | "addPeriod" | "deleted" | "clientTransferProhibited" | "clientUpdateProhibited" | "clientDeleteProhibited" | "clientRenewProhibited" | "clientHold";
|
|
2169
|
+
/** DomainStatusesBase */
|
|
2170
|
+
DomainStatusesBase: {
|
|
2171
|
+
/**
|
|
2172
|
+
* Default
|
|
2173
|
+
* @description The default status for an active domain with no restrictions
|
|
2174
|
+
*/
|
|
2175
|
+
default: string[];
|
|
2176
|
+
/**
|
|
2177
|
+
* Supported Statuses
|
|
2178
|
+
* @description Supported domain statuses
|
|
2179
|
+
*/
|
|
2180
|
+
supported_statuses: components["schemas"]["DomainStatus"][];
|
|
2181
|
+
};
|
|
1927
2182
|
/** DomainSummaryData */
|
|
1928
2183
|
DomainSummaryData: {
|
|
1929
2184
|
/**
|
|
@@ -2239,6 +2494,15 @@ export interface components {
|
|
|
2239
2494
|
* @enum {string}
|
|
2240
2495
|
*/
|
|
2241
2496
|
EventType: "REGISTRATION" | "RENEWAL" | "MODIFICATION" | "DELETION" | "INBOUND_TRANSFER" | "OUTBOUND_TRANSFER";
|
|
2497
|
+
/** GeneralAvailabilityBase */
|
|
2498
|
+
GeneralAvailabilityBase: {
|
|
2499
|
+
/**
|
|
2500
|
+
* Start Date
|
|
2501
|
+
* Format: date-time
|
|
2502
|
+
* @description Start date of general availability
|
|
2503
|
+
*/
|
|
2504
|
+
start_date: Date;
|
|
2505
|
+
};
|
|
2242
2506
|
/**
|
|
2243
2507
|
* GrantType
|
|
2244
2508
|
* @enum {string}
|
|
@@ -2254,6 +2518,19 @@ export interface components {
|
|
|
2254
2518
|
/** Problem type */
|
|
2255
2519
|
type: string;
|
|
2256
2520
|
};
|
|
2521
|
+
/** IdnBase */
|
|
2522
|
+
IdnBase: {
|
|
2523
|
+
/**
|
|
2524
|
+
* Idn Capable
|
|
2525
|
+
* @description IDN allowed
|
|
2526
|
+
*/
|
|
2527
|
+
idn_capable: boolean;
|
|
2528
|
+
/**
|
|
2529
|
+
* Idn Tables
|
|
2530
|
+
* @description Allowed IDN characters, file with the IDN codes
|
|
2531
|
+
*/
|
|
2532
|
+
idn_tables?: string[] | null;
|
|
2533
|
+
};
|
|
2257
2534
|
/** IpRestrictionCreate */
|
|
2258
2535
|
IpRestrictionCreate: {
|
|
2259
2536
|
/**
|
|
@@ -2305,6 +2582,76 @@ export interface components {
|
|
|
2305
2582
|
last_used_on?: Date | null;
|
|
2306
2583
|
};
|
|
2307
2584
|
JsonValue: unknown;
|
|
2585
|
+
/** LaunchPhaseBase */
|
|
2586
|
+
LaunchPhaseBase: {
|
|
2587
|
+
/** @description Allocation method */
|
|
2588
|
+
allocation?: components["schemas"]["AllocationMethodType"] | null;
|
|
2589
|
+
/**
|
|
2590
|
+
* End Date
|
|
2591
|
+
* @description End date of the phase
|
|
2592
|
+
*/
|
|
2593
|
+
end_date?: Date | null;
|
|
2594
|
+
/**
|
|
2595
|
+
* Smd Required
|
|
2596
|
+
* @description Whether an SMD file is required for participation
|
|
2597
|
+
*/
|
|
2598
|
+
smd_required?: boolean | null;
|
|
2599
|
+
/**
|
|
2600
|
+
* Start Date
|
|
2601
|
+
* @description Start date of the phase
|
|
2602
|
+
*/
|
|
2603
|
+
start_date?: Date | null;
|
|
2604
|
+
/**
|
|
2605
|
+
* Supported
|
|
2606
|
+
* @description Whether this phase is supported
|
|
2607
|
+
*/
|
|
2608
|
+
supported: boolean;
|
|
2609
|
+
/** @description Type of launch phase */
|
|
2610
|
+
type: components["schemas"]["LaunchPhaseType"];
|
|
2611
|
+
};
|
|
2612
|
+
/**
|
|
2613
|
+
* LaunchPhaseType
|
|
2614
|
+
* @enum {string}
|
|
2615
|
+
*/
|
|
2616
|
+
LaunchPhaseType: "sunrise" | "landrush" | "eap";
|
|
2617
|
+
/** LaunchPhasesBase */
|
|
2618
|
+
LaunchPhasesBase: {
|
|
2619
|
+
general_availability: components["schemas"]["GeneralAvailabilityBase"];
|
|
2620
|
+
/**
|
|
2621
|
+
* Phases
|
|
2622
|
+
* @default []
|
|
2623
|
+
*/
|
|
2624
|
+
phases: components["schemas"]["LaunchPhaseBase"][];
|
|
2625
|
+
trademark_claims?: components["schemas"]["TrademarkClaimsBase"] | null;
|
|
2626
|
+
};
|
|
2627
|
+
/** LocalPresenceBase */
|
|
2628
|
+
LocalPresenceBase: {
|
|
2629
|
+
/**
|
|
2630
|
+
* Eligible Countries
|
|
2631
|
+
* @description ISO 3166-1 Alpha-2 country code
|
|
2632
|
+
*/
|
|
2633
|
+
eligible_countries?: string[] | null;
|
|
2634
|
+
/**
|
|
2635
|
+
* Required
|
|
2636
|
+
* @description Whether a local presence is required to register and maintain a domain name
|
|
2637
|
+
*/
|
|
2638
|
+
required: boolean;
|
|
2639
|
+
/**
|
|
2640
|
+
* Requirement
|
|
2641
|
+
* @description Type of local presence requirement
|
|
2642
|
+
*/
|
|
2643
|
+
requirement?: components["schemas"]["LocalPresenceRequirementType"][] | null;
|
|
2644
|
+
/**
|
|
2645
|
+
* Type
|
|
2646
|
+
* @description Who must meet the requirement
|
|
2647
|
+
*/
|
|
2648
|
+
type?: components["schemas"]["ContactRoleType"][] | null;
|
|
2649
|
+
};
|
|
2650
|
+
/**
|
|
2651
|
+
* LocalPresenceRequirementType
|
|
2652
|
+
* @enum {string}
|
|
2653
|
+
*/
|
|
2654
|
+
LocalPresenceRequirementType: "physical_address" | "business_entity";
|
|
2308
2655
|
/** Nameserver */
|
|
2309
2656
|
Nameserver: {
|
|
2310
2657
|
/**
|
|
@@ -3145,6 +3492,17 @@ export interface components {
|
|
|
3145
3492
|
* @enum {string}
|
|
3146
3493
|
*/
|
|
3147
3494
|
PatchOp: "upsert" | "remove";
|
|
3495
|
+
/** Period */
|
|
3496
|
+
Period: {
|
|
3497
|
+
/** @description The unit of the period */
|
|
3498
|
+
unit: components["schemas"]["PeriodUnit"];
|
|
3499
|
+
/**
|
|
3500
|
+
* Value
|
|
3501
|
+
* @description Amount of time in the unit
|
|
3502
|
+
*/
|
|
3503
|
+
value: number;
|
|
3504
|
+
};
|
|
3505
|
+
PeriodList: components["schemas"]["Period"][] | null;
|
|
3148
3506
|
/**
|
|
3149
3507
|
* PeriodUnit
|
|
3150
3508
|
* @enum {string}
|
|
@@ -3170,6 +3528,41 @@ export interface components {
|
|
|
3170
3528
|
/** @default basic_plan */
|
|
3171
3529
|
plan: components["schemas"]["PlanRelation"];
|
|
3172
3530
|
};
|
|
3531
|
+
/**
|
|
3532
|
+
* PostTransferRequirements
|
|
3533
|
+
* @enum {string}
|
|
3534
|
+
*/
|
|
3535
|
+
PostTransferRequirements: "update_contacts" | "tld_specific";
|
|
3536
|
+
/**
|
|
3537
|
+
* PostalAddressType
|
|
3538
|
+
* @enum {string}
|
|
3539
|
+
*/
|
|
3540
|
+
PostalAddressType: "loc" | "int";
|
|
3541
|
+
/**
|
|
3542
|
+
* PremiumAffectsType
|
|
3543
|
+
* @enum {string}
|
|
3544
|
+
*/
|
|
3545
|
+
PremiumAffectsType: "registration" | "renewal";
|
|
3546
|
+
/** PremiumDomainsBase */
|
|
3547
|
+
PremiumDomainsBase: {
|
|
3548
|
+
/**
|
|
3549
|
+
* Affects
|
|
3550
|
+
* @description What operations are affected by premium status
|
|
3551
|
+
*/
|
|
3552
|
+
affects?: components["schemas"]["PremiumAffectsType"][] | null;
|
|
3553
|
+
/** @description Source of premium domain information */
|
|
3554
|
+
source?: components["schemas"]["PremiumSourceType"] | null;
|
|
3555
|
+
/**
|
|
3556
|
+
* Supported
|
|
3557
|
+
* @description Whether the registry has premium domains
|
|
3558
|
+
*/
|
|
3559
|
+
supported: boolean;
|
|
3560
|
+
};
|
|
3561
|
+
/**
|
|
3562
|
+
* PremiumSourceType
|
|
3563
|
+
* @enum {string}
|
|
3564
|
+
*/
|
|
3565
|
+
PremiumSourceType: "EPP" | "API" | "CSV" | "manual";
|
|
3173
3566
|
/** Problem */
|
|
3174
3567
|
Problem: {
|
|
3175
3568
|
/** Problem detail */
|
|
@@ -3181,6 +3574,42 @@ export interface components {
|
|
|
3181
3574
|
/** Problem type */
|
|
3182
3575
|
type: string;
|
|
3183
3576
|
};
|
|
3577
|
+
/** RdapBase */
|
|
3578
|
+
RdapBase: {
|
|
3579
|
+
/**
|
|
3580
|
+
* Rdap Server
|
|
3581
|
+
* @description RDAP server URL
|
|
3582
|
+
*/
|
|
3583
|
+
rdap_server?: string | null;
|
|
3584
|
+
};
|
|
3585
|
+
/**
|
|
3586
|
+
* RegistrantChangeType
|
|
3587
|
+
* @enum {string}
|
|
3588
|
+
*/
|
|
3589
|
+
RegistrantChangeType: "update" | "trade";
|
|
3590
|
+
/** RegistryLockBase */
|
|
3591
|
+
RegistryLockBase: {
|
|
3592
|
+
/**
|
|
3593
|
+
* Prevents
|
|
3594
|
+
* @description What operations are prevented by registry lock
|
|
3595
|
+
*/
|
|
3596
|
+
prevents?: string[] | null;
|
|
3597
|
+
/**
|
|
3598
|
+
* Removal Process
|
|
3599
|
+
* @description Process for unlocking the domain
|
|
3600
|
+
*/
|
|
3601
|
+
removal_process?: string | null;
|
|
3602
|
+
/**
|
|
3603
|
+
* Requires Manual Request
|
|
3604
|
+
* @description Whether a manual request is required
|
|
3605
|
+
*/
|
|
3606
|
+
requires_manual_request?: boolean | null;
|
|
3607
|
+
/**
|
|
3608
|
+
* Supported
|
|
3609
|
+
* @description Whether the registry provides a Registry Lock feature
|
|
3610
|
+
*/
|
|
3611
|
+
supported: boolean;
|
|
3612
|
+
};
|
|
3184
3613
|
/**
|
|
3185
3614
|
* Relation
|
|
3186
3615
|
* @enum {string}
|
|
@@ -3196,6 +3625,26 @@ export interface components {
|
|
|
3196
3625
|
* @enum {string}
|
|
3197
3626
|
*/
|
|
3198
3627
|
RenewalMode: "renew" | "expire" | "delete";
|
|
3628
|
+
/** ReservedDomainsBase */
|
|
3629
|
+
ReservedDomainsBase: {
|
|
3630
|
+
/** @description Source of reserved domain information */
|
|
3631
|
+
source?: components["schemas"]["ReservedSourceType"] | null;
|
|
3632
|
+
/**
|
|
3633
|
+
* Supported
|
|
3634
|
+
* @description Registry provides a reserved list
|
|
3635
|
+
*/
|
|
3636
|
+
supported: boolean;
|
|
3637
|
+
/**
|
|
3638
|
+
* Url
|
|
3639
|
+
* @description Link to reserved list
|
|
3640
|
+
*/
|
|
3641
|
+
url?: string | null;
|
|
3642
|
+
};
|
|
3643
|
+
/**
|
|
3644
|
+
* ReservedSourceType
|
|
3645
|
+
* @enum {string}
|
|
3646
|
+
*/
|
|
3647
|
+
ReservedSourceType: "API" | "CSV" | "manual";
|
|
3199
3648
|
/** SignupCreate */
|
|
3200
3649
|
SignupCreate: {
|
|
3201
3650
|
/** @description Organization signup. */
|
|
@@ -3205,6 +3654,19 @@ export interface components {
|
|
|
3205
3654
|
/** @description User signup to platform. */
|
|
3206
3655
|
user: components["schemas"]["UserCreate"];
|
|
3207
3656
|
};
|
|
3657
|
+
/** SldLength */
|
|
3658
|
+
SldLength: {
|
|
3659
|
+
/**
|
|
3660
|
+
* Max
|
|
3661
|
+
* @description Maximum length of a domain name
|
|
3662
|
+
*/
|
|
3663
|
+
max: number;
|
|
3664
|
+
/**
|
|
3665
|
+
* Min
|
|
3666
|
+
* @description Minimum length of a domain name
|
|
3667
|
+
*/
|
|
3668
|
+
min: number;
|
|
3669
|
+
};
|
|
3208
3670
|
/**
|
|
3209
3671
|
* SortOrder
|
|
3210
3672
|
* @enum {string}
|
|
@@ -3217,11 +3679,101 @@ export interface components {
|
|
|
3217
3679
|
/** Remove */
|
|
3218
3680
|
remove?: components["schemas"]["Relation"][] | null;
|
|
3219
3681
|
};
|
|
3682
|
+
/**
|
|
3683
|
+
* SyncOperationType
|
|
3684
|
+
* @enum {string}
|
|
3685
|
+
*/
|
|
3686
|
+
SyncOperationType: "registration" | "renewal" | "transfer";
|
|
3687
|
+
/**
|
|
3688
|
+
* TLDType
|
|
3689
|
+
* @enum {string}
|
|
3690
|
+
*/
|
|
3691
|
+
TLDType: "gTLD" | "ccTLD";
|
|
3220
3692
|
/** TermsOfServiceAccept */
|
|
3221
3693
|
TermsOfServiceAccept: {
|
|
3222
3694
|
/** Accepted */
|
|
3223
3695
|
accepted: boolean;
|
|
3224
3696
|
};
|
|
3697
|
+
/** TldBase */
|
|
3698
|
+
TldBase: {
|
|
3699
|
+
/**
|
|
3700
|
+
* Name
|
|
3701
|
+
* @description The TLD being configured
|
|
3702
|
+
*/
|
|
3703
|
+
name: string;
|
|
3704
|
+
/** @description The type of the TLD (e.g., gTLD, ccTLD) */
|
|
3705
|
+
type: components["schemas"]["TLDType"];
|
|
3706
|
+
};
|
|
3707
|
+
/** TldResponseShort */
|
|
3708
|
+
TldResponseShort: {
|
|
3709
|
+
/** Tld */
|
|
3710
|
+
tld: string;
|
|
3711
|
+
type: components["schemas"]["TLDType"];
|
|
3712
|
+
};
|
|
3713
|
+
/** TldSpecificationResponse */
|
|
3714
|
+
TldSpecificationResponse: {
|
|
3715
|
+
/** @description Character limits for domain names */
|
|
3716
|
+
characters: components["schemas"]["SldLength"];
|
|
3717
|
+
/** @description Contacts configuration */
|
|
3718
|
+
contacts?: components["schemas"]["ContactsBase"] | null;
|
|
3719
|
+
/** @description DNS configuration */
|
|
3720
|
+
dns_configuration: components["schemas"]["DnsConfigurationBase"];
|
|
3721
|
+
/** @description Domain lifecycle configuration */
|
|
3722
|
+
domain_lifecycle: components["schemas"]["DomainLifecycleBase"];
|
|
3723
|
+
/** @description Domain statuses configuration */
|
|
3724
|
+
domain_statuses: components["schemas"]["DomainStatusesBase"];
|
|
3725
|
+
/** @description IDN configuration */
|
|
3726
|
+
idn: components["schemas"]["IdnBase"];
|
|
3727
|
+
/** @description Launch phases configuration */
|
|
3728
|
+
launch_phases?: components["schemas"]["LaunchPhasesBase"] | null;
|
|
3729
|
+
/** @description Local presence requirements */
|
|
3730
|
+
local_presence?: components["schemas"]["LocalPresenceBase"] | null;
|
|
3731
|
+
/** @description Premium domains configuration */
|
|
3732
|
+
premium_domains?: components["schemas"]["PremiumDomainsBase"] | null;
|
|
3733
|
+
/** @description RDAP configuration */
|
|
3734
|
+
rdap?: components["schemas"]["RdapBase"] | null;
|
|
3735
|
+
/** @description Registry lock configuration */
|
|
3736
|
+
registry_lock?: components["schemas"]["RegistryLockBase"] | null;
|
|
3737
|
+
/** @description Reserved domains configuration */
|
|
3738
|
+
reserved_domains?: components["schemas"]["ReservedDomainsBase"] | null;
|
|
3739
|
+
/**
|
|
3740
|
+
* Tlds
|
|
3741
|
+
* @description List of TLDs being configured
|
|
3742
|
+
*/
|
|
3743
|
+
tlds: components["schemas"]["TldBase"][];
|
|
3744
|
+
/** @description Transfer policies configuration */
|
|
3745
|
+
transfer_policies: components["schemas"]["TransferPoliciesBase"];
|
|
3746
|
+
/** @description WHOIS configuration */
|
|
3747
|
+
whois?: components["schemas"]["WhoisBase"] | null;
|
|
3748
|
+
};
|
|
3749
|
+
/** TrademarkClaimsBase */
|
|
3750
|
+
TrademarkClaimsBase: {
|
|
3751
|
+
/**
|
|
3752
|
+
* End Date
|
|
3753
|
+
* @description End date of trademark claims
|
|
3754
|
+
*/
|
|
3755
|
+
end_date?: Date | null;
|
|
3756
|
+
/**
|
|
3757
|
+
* Start Date
|
|
3758
|
+
* @description Start date of trademark claims
|
|
3759
|
+
*/
|
|
3760
|
+
start_date?: Date | null;
|
|
3761
|
+
/**
|
|
3762
|
+
* Supported
|
|
3763
|
+
* @description Whether trademark claims are supported
|
|
3764
|
+
*/
|
|
3765
|
+
supported: boolean;
|
|
3766
|
+
/**
|
|
3767
|
+
* Tmch Required
|
|
3768
|
+
* @description If true, claim notifications are mandatory within the timeframe
|
|
3769
|
+
*/
|
|
3770
|
+
tmch_required?: boolean | null;
|
|
3771
|
+
};
|
|
3772
|
+
/**
|
|
3773
|
+
* TransferAckType
|
|
3774
|
+
* @enum {string}
|
|
3775
|
+
*/
|
|
3776
|
+
TransferAckType: "none" | "registrar" | "registrant" | "both";
|
|
3225
3777
|
/** TransferEvent */
|
|
3226
3778
|
TransferEvent: {
|
|
3227
3779
|
/** Current Registrar */
|
|
@@ -3233,6 +3785,78 @@ export interface components {
|
|
|
3233
3785
|
/** Requesting Registrar */
|
|
3234
3786
|
requesting_registrar: string;
|
|
3235
3787
|
};
|
|
3788
|
+
/** TransferPoliciesBase */
|
|
3789
|
+
TransferPoliciesBase: {
|
|
3790
|
+
/**
|
|
3791
|
+
* Authinfo Max Length
|
|
3792
|
+
* @description Maximum length of the auth info
|
|
3793
|
+
*/
|
|
3794
|
+
authinfo_max_length?: number | null;
|
|
3795
|
+
/**
|
|
3796
|
+
* Authinfo Min Length
|
|
3797
|
+
* @description Minimum length of the auth info
|
|
3798
|
+
*/
|
|
3799
|
+
authinfo_min_length?: number | null;
|
|
3800
|
+
/**
|
|
3801
|
+
* Authinfo Required
|
|
3802
|
+
* @description Whether an auth info is required for transfers
|
|
3803
|
+
*/
|
|
3804
|
+
authinfo_required: boolean;
|
|
3805
|
+
/**
|
|
3806
|
+
* Authinfo Time Limited
|
|
3807
|
+
* @description Whether an auth info has a time limit
|
|
3808
|
+
*/
|
|
3809
|
+
authinfo_time_limited?: boolean | null;
|
|
3810
|
+
/**
|
|
3811
|
+
* Authinfo Validity Period
|
|
3812
|
+
* @description Validity period of the auth info (e.g., '5D' for 5 days)
|
|
3813
|
+
*/
|
|
3814
|
+
authinfo_validity_period?: string | null;
|
|
3815
|
+
/**
|
|
3816
|
+
* Info Contact Authinfo
|
|
3817
|
+
* @description Whether querying a foreign contact with authinfo is possible
|
|
3818
|
+
*/
|
|
3819
|
+
info_contact_authinfo?: boolean | null;
|
|
3820
|
+
/**
|
|
3821
|
+
* Info Domain Authinfo
|
|
3822
|
+
* @description Whether querying a foreign domain with authinfo is possible
|
|
3823
|
+
*/
|
|
3824
|
+
info_domain_authinfo?: boolean | null;
|
|
3825
|
+
/**
|
|
3826
|
+
* Post Transfer Requirements
|
|
3827
|
+
* @description Post-transfer requirements: lists the behaviors, as in ['update_contacts', 'set_transfer_lock'] or [ 'tld_specific' ] for specific behavior
|
|
3828
|
+
*/
|
|
3829
|
+
post_transfer_requirements?: components["schemas"]["PostTransferRequirements"][] | null;
|
|
3830
|
+
/** @description Whether a transfer can be approved */
|
|
3831
|
+
transfer_ack?: components["schemas"]["TransferAckType"] | null;
|
|
3832
|
+
/**
|
|
3833
|
+
* Transfer Email Required
|
|
3834
|
+
* @description Whether an email confirmation is required to perform the transfer
|
|
3835
|
+
*/
|
|
3836
|
+
transfer_email_required?: boolean | null;
|
|
3837
|
+
/**
|
|
3838
|
+
* Transfer Lock Enabled
|
|
3839
|
+
* @description Whether transfers are locked by default in our system
|
|
3840
|
+
*/
|
|
3841
|
+
transfer_lock_enabled: boolean;
|
|
3842
|
+
/** @description Whether a transfer can be denied */
|
|
3843
|
+
transfer_nack?: components["schemas"]["TransferAckType"] | null;
|
|
3844
|
+
/**
|
|
3845
|
+
* Transfer Renewal Period
|
|
3846
|
+
* @description If transfer_renews_domain is true, the renewal period (e.g., '1Y' for 1 year)
|
|
3847
|
+
*/
|
|
3848
|
+
transfer_renewal_period?: string | null;
|
|
3849
|
+
/**
|
|
3850
|
+
* Transfer Renews Domain
|
|
3851
|
+
* @description Whether a transfer triggers a domain renewal
|
|
3852
|
+
*/
|
|
3853
|
+
transfer_renews_domain?: boolean | null;
|
|
3854
|
+
/**
|
|
3855
|
+
* Transfer Time
|
|
3856
|
+
* @description Time duration of transfers in ISO 8601 format (e.g., 5D, -7D) according to the policy, 0 = real-time
|
|
3857
|
+
*/
|
|
3858
|
+
transfer_time?: string | null;
|
|
3859
|
+
};
|
|
3236
3860
|
/** User */
|
|
3237
3861
|
User: {
|
|
3238
3862
|
/**
|
|
@@ -3611,6 +4235,14 @@ export interface components {
|
|
|
3611
4235
|
* @enum {string}
|
|
3612
4236
|
*/
|
|
3613
4237
|
VerificationType: "api" | "email";
|
|
4238
|
+
/** WhoisBase */
|
|
4239
|
+
WhoisBase: {
|
|
4240
|
+
/**
|
|
4241
|
+
* Whois Server
|
|
4242
|
+
* @description WHOIS server
|
|
4243
|
+
*/
|
|
4244
|
+
whois_server?: string | null;
|
|
4245
|
+
};
|
|
3614
4246
|
/**
|
|
3615
4247
|
* ZoneSortField
|
|
3616
4248
|
* @enum {string}
|
|
@@ -3804,6 +4436,39 @@ export interface operations {
|
|
|
3804
4436
|
};
|
|
3805
4437
|
};
|
|
3806
4438
|
};
|
|
4439
|
+
issue_opusdns_internal_api_key_v1_auth_internal_client_credentials_post: {
|
|
4440
|
+
parameters: {
|
|
4441
|
+
query?: never;
|
|
4442
|
+
header?: never;
|
|
4443
|
+
path?: never;
|
|
4444
|
+
cookie?: never;
|
|
4445
|
+
};
|
|
4446
|
+
requestBody: {
|
|
4447
|
+
content: {
|
|
4448
|
+
"application/json": components["schemas"]["OrganizationCredentialExtra"];
|
|
4449
|
+
};
|
|
4450
|
+
};
|
|
4451
|
+
responses: {
|
|
4452
|
+
/** @description Successful Response */
|
|
4453
|
+
200: {
|
|
4454
|
+
headers: {
|
|
4455
|
+
[name: string]: unknown;
|
|
4456
|
+
};
|
|
4457
|
+
content: {
|
|
4458
|
+
"application/json": components["schemas"]["OrganizationCredentialCreated"];
|
|
4459
|
+
};
|
|
4460
|
+
};
|
|
4461
|
+
/** @description Validation Error */
|
|
4462
|
+
422: {
|
|
4463
|
+
headers: {
|
|
4464
|
+
[name: string]: unknown;
|
|
4465
|
+
};
|
|
4466
|
+
content: {
|
|
4467
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
4468
|
+
};
|
|
4469
|
+
};
|
|
4470
|
+
};
|
|
4471
|
+
};
|
|
3807
4472
|
logout_v1_auth_logout_post: {
|
|
3808
4473
|
parameters: {
|
|
3809
4474
|
query?: never;
|
|
@@ -6920,6 +7585,73 @@ export interface operations {
|
|
|
6920
7585
|
};
|
|
6921
7586
|
};
|
|
6922
7587
|
};
|
|
7588
|
+
get_tld_portfolio_v1_tlds_portfolio_get: {
|
|
7589
|
+
parameters: {
|
|
7590
|
+
query?: never;
|
|
7591
|
+
header?: never;
|
|
7592
|
+
path?: never;
|
|
7593
|
+
cookie?: never;
|
|
7594
|
+
};
|
|
7595
|
+
requestBody?: never;
|
|
7596
|
+
responses: {
|
|
7597
|
+
/** @description Successful Response */
|
|
7598
|
+
200: {
|
|
7599
|
+
headers: {
|
|
7600
|
+
[name: string]: unknown;
|
|
7601
|
+
};
|
|
7602
|
+
content: {
|
|
7603
|
+
"application/json": components["schemas"]["TldResponseShort"][];
|
|
7604
|
+
};
|
|
7605
|
+
};
|
|
7606
|
+
};
|
|
7607
|
+
};
|
|
7608
|
+
get_tld_spec_v1_tlds__tld__get: {
|
|
7609
|
+
parameters: {
|
|
7610
|
+
query?: never;
|
|
7611
|
+
header?: never;
|
|
7612
|
+
path: {
|
|
7613
|
+
tld: string;
|
|
7614
|
+
};
|
|
7615
|
+
cookie?: never;
|
|
7616
|
+
};
|
|
7617
|
+
requestBody?: never;
|
|
7618
|
+
responses: {
|
|
7619
|
+
/** @description Successful Response */
|
|
7620
|
+
200: {
|
|
7621
|
+
headers: {
|
|
7622
|
+
[name: string]: unknown;
|
|
7623
|
+
};
|
|
7624
|
+
content: {
|
|
7625
|
+
"application/json": components["schemas"]["TldSpecificationResponse"];
|
|
7626
|
+
};
|
|
7627
|
+
};
|
|
7628
|
+
/** @description Not Found */
|
|
7629
|
+
404: {
|
|
7630
|
+
headers: {
|
|
7631
|
+
[name: string]: unknown;
|
|
7632
|
+
};
|
|
7633
|
+
content: {
|
|
7634
|
+
/** @example {
|
|
7635
|
+
* "code": "ERROR_TLD_NOT_FOUND",
|
|
7636
|
+
* "detail": "Unknown TLD",
|
|
7637
|
+
* "status": 404,
|
|
7638
|
+
* "title": "TLD ERROR",
|
|
7639
|
+
* "type": "tld-not-found"
|
|
7640
|
+
* } */
|
|
7641
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
7642
|
+
};
|
|
7643
|
+
};
|
|
7644
|
+
/** @description Validation Error */
|
|
7645
|
+
422: {
|
|
7646
|
+
headers: {
|
|
7647
|
+
[name: string]: unknown;
|
|
7648
|
+
};
|
|
7649
|
+
content: {
|
|
7650
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
7651
|
+
};
|
|
7652
|
+
};
|
|
7653
|
+
};
|
|
7654
|
+
};
|
|
6923
7655
|
create_user_v1_users_post: {
|
|
6924
7656
|
parameters: {
|
|
6925
7657
|
query?: never;
|