@opusdns/api 0.10.0 → 0.11.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 +501 -441
- package/src/helpers/responses.ts +385 -547
- package/src/helpers/schemas-arrays.ts +169 -1
- package/src/helpers/schemas.ts +624 -0
- package/src/openapi.yaml +948 -1
- package/src/schema.d.ts +682 -0
- /package/src/{index.ts → index.d.ts} +0 -0
package/src/schema.d.ts
CHANGED
|
@@ -888,6 +888,40 @@ export interface paths {
|
|
|
888
888
|
patch: operations["change_plan_v1_organizations__organization_id__plan_patch"];
|
|
889
889
|
trace?: never;
|
|
890
890
|
};
|
|
891
|
+
"/v1/tlds/portfolio": {
|
|
892
|
+
parameters: {
|
|
893
|
+
query?: never;
|
|
894
|
+
header?: never;
|
|
895
|
+
path?: never;
|
|
896
|
+
cookie?: never;
|
|
897
|
+
};
|
|
898
|
+
/** Get Tld Portfolio */
|
|
899
|
+
get: operations["get_tld_portfolio_v1_tlds_portfolio_get"];
|
|
900
|
+
put?: never;
|
|
901
|
+
post?: never;
|
|
902
|
+
delete?: never;
|
|
903
|
+
options?: never;
|
|
904
|
+
head?: never;
|
|
905
|
+
patch?: never;
|
|
906
|
+
trace?: never;
|
|
907
|
+
};
|
|
908
|
+
"/v1/tlds/{tld}": {
|
|
909
|
+
parameters: {
|
|
910
|
+
query?: never;
|
|
911
|
+
header?: never;
|
|
912
|
+
path?: never;
|
|
913
|
+
cookie?: never;
|
|
914
|
+
};
|
|
915
|
+
/** Get Tld Spec */
|
|
916
|
+
get: operations["get_tld_spec_v1_tlds__tld__get"];
|
|
917
|
+
put?: never;
|
|
918
|
+
post?: never;
|
|
919
|
+
delete?: never;
|
|
920
|
+
options?: never;
|
|
921
|
+
head?: never;
|
|
922
|
+
patch?: never;
|
|
923
|
+
trace?: never;
|
|
924
|
+
};
|
|
891
925
|
"/v1/users": {
|
|
892
926
|
parameters: {
|
|
893
927
|
query?: never;
|
|
@@ -997,6 +1031,24 @@ export interface paths {
|
|
|
997
1031
|
export type webhooks = Record<string, never>;
|
|
998
1032
|
export interface components {
|
|
999
1033
|
schemas: {
|
|
1034
|
+
/**
|
|
1035
|
+
* AllocationMethodType
|
|
1036
|
+
* @enum {string}
|
|
1037
|
+
*/
|
|
1038
|
+
AllocationMethodType: "fcfs" | "auction" | "lottery";
|
|
1039
|
+
/** AllowedNumberOfNameserverBase */
|
|
1040
|
+
AllowedNumberOfNameserverBase: {
|
|
1041
|
+
/**
|
|
1042
|
+
* Max
|
|
1043
|
+
* @description Maximum number of nameserver per domain name
|
|
1044
|
+
*/
|
|
1045
|
+
max: number;
|
|
1046
|
+
/**
|
|
1047
|
+
* Min
|
|
1048
|
+
* @description Minimum number of nameserver per domain name
|
|
1049
|
+
*/
|
|
1050
|
+
min: number;
|
|
1051
|
+
};
|
|
1000
1052
|
/** Body_issue_organization_token_v1_auth_token_post */
|
|
1001
1053
|
Body_issue_organization_token_v1_auth_token_post: {
|
|
1002
1054
|
/**
|
|
@@ -1047,6 +1099,21 @@ export interface components {
|
|
|
1047
1099
|
* @enum {string}
|
|
1048
1100
|
*/
|
|
1049
1101
|
BulkOperationStatus: "success" | "failed";
|
|
1102
|
+
/** ContactConfigBase */
|
|
1103
|
+
ContactConfigBase: {
|
|
1104
|
+
/**
|
|
1105
|
+
* Max
|
|
1106
|
+
* @description Maximum contacts per domain name
|
|
1107
|
+
*/
|
|
1108
|
+
max: number;
|
|
1109
|
+
/**
|
|
1110
|
+
* Min
|
|
1111
|
+
* @description Minimum contacts per domain name
|
|
1112
|
+
*/
|
|
1113
|
+
min: number;
|
|
1114
|
+
/** @description The type of contact */
|
|
1115
|
+
type: components["schemas"]["ContactRoleType"];
|
|
1116
|
+
};
|
|
1050
1117
|
/** ContactCreate */
|
|
1051
1118
|
ContactCreate: {
|
|
1052
1119
|
/**
|
|
@@ -1190,6 +1257,11 @@ export interface components {
|
|
|
1190
1257
|
*/
|
|
1191
1258
|
title?: string | null;
|
|
1192
1259
|
};
|
|
1260
|
+
/**
|
|
1261
|
+
* ContactRoleType
|
|
1262
|
+
* @enum {string}
|
|
1263
|
+
*/
|
|
1264
|
+
ContactRoleType: "registrant" | "admin" | "tech" | "billing";
|
|
1193
1265
|
/** ContactSchema */
|
|
1194
1266
|
ContactSchema: {
|
|
1195
1267
|
/**
|
|
@@ -1425,11 +1497,61 @@ export interface components {
|
|
|
1425
1497
|
*/
|
|
1426
1498
|
verified_on?: Date | null;
|
|
1427
1499
|
};
|
|
1500
|
+
/** ContactsBase */
|
|
1501
|
+
ContactsBase: {
|
|
1502
|
+
/**
|
|
1503
|
+
* Authinfo Required
|
|
1504
|
+
* @description Whether the registry requires authinfo for contact creation
|
|
1505
|
+
*/
|
|
1506
|
+
authinfo_required?: boolean | null;
|
|
1507
|
+
/**
|
|
1508
|
+
* Is Thick
|
|
1509
|
+
* @description Whether the registry supports thick contacts
|
|
1510
|
+
*/
|
|
1511
|
+
is_thick?: boolean | null;
|
|
1512
|
+
/**
|
|
1513
|
+
* Privacy Proxy
|
|
1514
|
+
* @description Whether a privacy service is allowed
|
|
1515
|
+
*/
|
|
1516
|
+
privacy_proxy?: boolean | null;
|
|
1517
|
+
/** @description Whether the registrant can change through update or trade */
|
|
1518
|
+
registrant_change?: components["schemas"]["RegistrantChangeType"] | null;
|
|
1519
|
+
/**
|
|
1520
|
+
* Support Check
|
|
1521
|
+
* @description Whether the registry supports contact checks
|
|
1522
|
+
*/
|
|
1523
|
+
support_check?: boolean | null;
|
|
1524
|
+
/**
|
|
1525
|
+
* Support Client Contact Id
|
|
1526
|
+
* @description Whether the registry supports client defined contact ID
|
|
1527
|
+
*/
|
|
1528
|
+
support_client_contact_id?: boolean | null;
|
|
1529
|
+
/**
|
|
1530
|
+
* Support Transfer
|
|
1531
|
+
* @description Whether the registry supports contact transfer
|
|
1532
|
+
*/
|
|
1533
|
+
support_transfer?: boolean | null;
|
|
1534
|
+
/**
|
|
1535
|
+
* Supported Postal Types
|
|
1536
|
+
* @description Supported postal address types
|
|
1537
|
+
*/
|
|
1538
|
+
supported_postal_types?: components["schemas"]["PostalAddressType"][] | null;
|
|
1539
|
+
/**
|
|
1540
|
+
* Supported Roles
|
|
1541
|
+
* @description Supported contact roles
|
|
1542
|
+
*/
|
|
1543
|
+
supported_roles?: components["schemas"]["ContactConfigBase"][] | null;
|
|
1544
|
+
};
|
|
1428
1545
|
/**
|
|
1429
1546
|
* Currency
|
|
1430
1547
|
* @enum {string}
|
|
1431
1548
|
*/
|
|
1432
1549
|
Currency: "USD" | "EUR";
|
|
1550
|
+
/**
|
|
1551
|
+
* DeletePolicyType
|
|
1552
|
+
* @enum {string}
|
|
1553
|
+
*/
|
|
1554
|
+
DeletePolicyType: "immediate" | "expiration";
|
|
1433
1555
|
/** DeletedEvent */
|
|
1434
1556
|
DeletedEvent: {
|
|
1435
1557
|
date: components["schemas"]["EppDateTime"];
|
|
@@ -1461,6 +1583,47 @@ export interface components {
|
|
|
1461
1583
|
/** Zone Name */
|
|
1462
1584
|
zone_name: string;
|
|
1463
1585
|
};
|
|
1586
|
+
/** DnsConfigurationBase */
|
|
1587
|
+
DnsConfigurationBase: {
|
|
1588
|
+
allowed_number_of_nameserver: components["schemas"]["AllowedNumberOfNameserverBase"];
|
|
1589
|
+
/**
|
|
1590
|
+
* Czds Available
|
|
1591
|
+
* @description Whether the zone is available in CZDS
|
|
1592
|
+
*/
|
|
1593
|
+
czds_available?: boolean | null;
|
|
1594
|
+
/**
|
|
1595
|
+
* Dnssec Allowed
|
|
1596
|
+
* @description Whether the registry supports DNSSEC
|
|
1597
|
+
*/
|
|
1598
|
+
dnssec_allowed: boolean;
|
|
1599
|
+
/**
|
|
1600
|
+
* Dnssec Mandatory
|
|
1601
|
+
* @description Whether DNSSEC is mandatory for a domain name
|
|
1602
|
+
*/
|
|
1603
|
+
dnssec_mandatory?: boolean | null;
|
|
1604
|
+
/** @description DNSSEC mode */
|
|
1605
|
+
dnssec_mode?: components["schemas"]["DnssecModeType"] | null;
|
|
1606
|
+
/**
|
|
1607
|
+
* Host Objects
|
|
1608
|
+
* @description Whether the registry supports host objects or use attributes
|
|
1609
|
+
*/
|
|
1610
|
+
host_objects: boolean;
|
|
1611
|
+
/**
|
|
1612
|
+
* Host Parent Check Tlds
|
|
1613
|
+
* @description TLDs that require parent-host checks (ns1.example.com => example.com)
|
|
1614
|
+
*/
|
|
1615
|
+
host_parent_check_tlds?: string[] | null;
|
|
1616
|
+
/**
|
|
1617
|
+
* Registry Nameserver Check
|
|
1618
|
+
* @description Whether the registry checks the nameserver configuration
|
|
1619
|
+
*/
|
|
1620
|
+
registry_nameserver_check: boolean;
|
|
1621
|
+
/**
|
|
1622
|
+
* Registry Root Nameserver Update
|
|
1623
|
+
* @description Number of hours until the root zone is updated, 0 = real-time
|
|
1624
|
+
*/
|
|
1625
|
+
registry_root_nameserver_update: number;
|
|
1626
|
+
};
|
|
1464
1627
|
/** DnsRecordCreate */
|
|
1465
1628
|
DnsRecordCreate: {
|
|
1466
1629
|
/** Rdata */
|
|
@@ -1570,6 +1733,11 @@ export interface components {
|
|
|
1570
1733
|
* @enum {integer}
|
|
1571
1734
|
*/
|
|
1572
1735
|
DnssecDigestType: 1 | 2 | 3 | 4 | 5 | 6;
|
|
1736
|
+
/**
|
|
1737
|
+
* DnssecModeType
|
|
1738
|
+
* @enum {string}
|
|
1739
|
+
*/
|
|
1740
|
+
DnssecModeType: "DS" | "DNSKEY";
|
|
1573
1741
|
/**
|
|
1574
1742
|
* DnssecRecordType
|
|
1575
1743
|
* @enum {string}
|
|
@@ -1740,6 +1908,63 @@ export interface components {
|
|
|
1740
1908
|
*/
|
|
1741
1909
|
updated_on?: Date;
|
|
1742
1910
|
};
|
|
1911
|
+
/** DomainLifecycleBase */
|
|
1912
|
+
DomainLifecycleBase: {
|
|
1913
|
+
/**
|
|
1914
|
+
* Add Grace Period
|
|
1915
|
+
* @description Add grace period in days after registration in ISO 8601 format (e.g., 5D, 3D)
|
|
1916
|
+
*/
|
|
1917
|
+
add_grace_period?: string | null;
|
|
1918
|
+
/**
|
|
1919
|
+
* Auto Renew Before Expiration
|
|
1920
|
+
* @description Time before expiration to auto-renew a domain in ISO 8601 format (e.g., 5D, -7D)
|
|
1921
|
+
*/
|
|
1922
|
+
auto_renew_before_expiration?: string | null;
|
|
1923
|
+
/**
|
|
1924
|
+
* Delete Before Expiration
|
|
1925
|
+
* @description Time before expiration to delete a domain in ISO 8601 format (e.g., 5D, -7D)
|
|
1926
|
+
*/
|
|
1927
|
+
delete_before_expiration?: string | null;
|
|
1928
|
+
/**
|
|
1929
|
+
* Delete Policy
|
|
1930
|
+
* @description How a domain can be deleted
|
|
1931
|
+
*/
|
|
1932
|
+
delete_policy?: components["schemas"]["DeletePolicyType"][] | null;
|
|
1933
|
+
/**
|
|
1934
|
+
* Explicit Renew
|
|
1935
|
+
* @description Whether an explicit renewal is possible
|
|
1936
|
+
*/
|
|
1937
|
+
explicit_renew?: boolean | null;
|
|
1938
|
+
/**
|
|
1939
|
+
* Grace Period
|
|
1940
|
+
* @description Grace period after expiration in ISO 8601 format (e.g., 5D, -7D)
|
|
1941
|
+
*/
|
|
1942
|
+
grace_period?: string | null;
|
|
1943
|
+
/**
|
|
1944
|
+
* Pending Delete
|
|
1945
|
+
* @description Pending delete period in ISO 8601 format (e.g., 5D, 10D) after redemption_period
|
|
1946
|
+
*/
|
|
1947
|
+
pending_delete?: string | null;
|
|
1948
|
+
/**
|
|
1949
|
+
* Redemption Period
|
|
1950
|
+
* @description Redemption period for domain recovery after grace period in ISO 8601 format (e.g., 5D, -7D)
|
|
1951
|
+
*/
|
|
1952
|
+
redemption_period?: string | null;
|
|
1953
|
+
/** @description List of allowed registration periods (e.g., '1y' or ['1y', '2y', '5y']) */
|
|
1954
|
+
registration_periods?: components["schemas"]["PeriodList"];
|
|
1955
|
+
/**
|
|
1956
|
+
* Registry Auto Renew
|
|
1957
|
+
* @description Does the registry enforce auto-renewal
|
|
1958
|
+
*/
|
|
1959
|
+
registry_auto_renew?: boolean | null;
|
|
1960
|
+
/** @description List of allowed renewal periods (e.g., '1y' or ['1y', '2y', '5y']) */
|
|
1961
|
+
renewal_periods?: components["schemas"]["PeriodList"];
|
|
1962
|
+
/**
|
|
1963
|
+
* Sync After Operations
|
|
1964
|
+
* @description Operations that trigger a sync with the registry
|
|
1965
|
+
*/
|
|
1966
|
+
sync_after_operations?: components["schemas"]["SyncOperationType"][] | null;
|
|
1967
|
+
};
|
|
1743
1968
|
/** DomainNameParts */
|
|
1744
1969
|
DomainNameParts: {
|
|
1745
1970
|
/** Domain */
|
|
@@ -1924,6 +2149,19 @@ export interface components {
|
|
|
1924
2149
|
* @enum {string}
|
|
1925
2150
|
*/
|
|
1926
2151
|
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";
|
|
2152
|
+
/** DomainStatusesBase */
|
|
2153
|
+
DomainStatusesBase: {
|
|
2154
|
+
/**
|
|
2155
|
+
* Default
|
|
2156
|
+
* @description The default status for an active domain with no restrictions
|
|
2157
|
+
*/
|
|
2158
|
+
default: string[];
|
|
2159
|
+
/**
|
|
2160
|
+
* Supported Statuses
|
|
2161
|
+
* @description Supported domain statuses
|
|
2162
|
+
*/
|
|
2163
|
+
supported_statuses: components["schemas"]["DomainStatus"][];
|
|
2164
|
+
};
|
|
1927
2165
|
/** DomainSummaryData */
|
|
1928
2166
|
DomainSummaryData: {
|
|
1929
2167
|
/**
|
|
@@ -2239,6 +2477,15 @@ export interface components {
|
|
|
2239
2477
|
* @enum {string}
|
|
2240
2478
|
*/
|
|
2241
2479
|
EventType: "REGISTRATION" | "RENEWAL" | "MODIFICATION" | "DELETION" | "INBOUND_TRANSFER" | "OUTBOUND_TRANSFER";
|
|
2480
|
+
/** GeneralAvailabilityBase */
|
|
2481
|
+
GeneralAvailabilityBase: {
|
|
2482
|
+
/**
|
|
2483
|
+
* Start Date
|
|
2484
|
+
* Format: date-time
|
|
2485
|
+
* @description Start date of general availability
|
|
2486
|
+
*/
|
|
2487
|
+
start_date: Date;
|
|
2488
|
+
};
|
|
2242
2489
|
/**
|
|
2243
2490
|
* GrantType
|
|
2244
2491
|
* @enum {string}
|
|
@@ -2254,6 +2501,19 @@ export interface components {
|
|
|
2254
2501
|
/** Problem type */
|
|
2255
2502
|
type: string;
|
|
2256
2503
|
};
|
|
2504
|
+
/** IdnBase */
|
|
2505
|
+
IdnBase: {
|
|
2506
|
+
/**
|
|
2507
|
+
* Idn Capable
|
|
2508
|
+
* @description IDN allowed
|
|
2509
|
+
*/
|
|
2510
|
+
idn_capable: boolean;
|
|
2511
|
+
/**
|
|
2512
|
+
* Idn Tables
|
|
2513
|
+
* @description Allowed IDN characters, file with the IDN codes
|
|
2514
|
+
*/
|
|
2515
|
+
idn_tables?: string[] | null;
|
|
2516
|
+
};
|
|
2257
2517
|
/** IpRestrictionCreate */
|
|
2258
2518
|
IpRestrictionCreate: {
|
|
2259
2519
|
/**
|
|
@@ -2305,6 +2565,76 @@ export interface components {
|
|
|
2305
2565
|
last_used_on?: Date | null;
|
|
2306
2566
|
};
|
|
2307
2567
|
JsonValue: unknown;
|
|
2568
|
+
/** LaunchPhaseBase */
|
|
2569
|
+
LaunchPhaseBase: {
|
|
2570
|
+
/** @description Allocation method */
|
|
2571
|
+
allocation?: components["schemas"]["AllocationMethodType"] | null;
|
|
2572
|
+
/**
|
|
2573
|
+
* End Date
|
|
2574
|
+
* @description End date of the phase
|
|
2575
|
+
*/
|
|
2576
|
+
end_date?: Date | null;
|
|
2577
|
+
/**
|
|
2578
|
+
* Smd Required
|
|
2579
|
+
* @description Whether an SMD file is required for participation
|
|
2580
|
+
*/
|
|
2581
|
+
smd_required?: boolean | null;
|
|
2582
|
+
/**
|
|
2583
|
+
* Start Date
|
|
2584
|
+
* @description Start date of the phase
|
|
2585
|
+
*/
|
|
2586
|
+
start_date?: Date | null;
|
|
2587
|
+
/**
|
|
2588
|
+
* Supported
|
|
2589
|
+
* @description Whether this phase is supported
|
|
2590
|
+
*/
|
|
2591
|
+
supported: boolean;
|
|
2592
|
+
/** @description Type of launch phase */
|
|
2593
|
+
type: components["schemas"]["LaunchPhaseType"];
|
|
2594
|
+
};
|
|
2595
|
+
/**
|
|
2596
|
+
* LaunchPhaseType
|
|
2597
|
+
* @enum {string}
|
|
2598
|
+
*/
|
|
2599
|
+
LaunchPhaseType: "sunrise" | "landrush" | "eap";
|
|
2600
|
+
/** LaunchPhasesBase */
|
|
2601
|
+
LaunchPhasesBase: {
|
|
2602
|
+
general_availability: components["schemas"]["GeneralAvailabilityBase"];
|
|
2603
|
+
/**
|
|
2604
|
+
* Phases
|
|
2605
|
+
* @default []
|
|
2606
|
+
*/
|
|
2607
|
+
phases: components["schemas"]["LaunchPhaseBase"][];
|
|
2608
|
+
trademark_claims?: components["schemas"]["TrademarkClaimsBase"] | null;
|
|
2609
|
+
};
|
|
2610
|
+
/** LocalPresenceBase */
|
|
2611
|
+
LocalPresenceBase: {
|
|
2612
|
+
/**
|
|
2613
|
+
* Eligible Countries
|
|
2614
|
+
* @description ISO 3166-1 Alpha-2 country code
|
|
2615
|
+
*/
|
|
2616
|
+
eligible_countries?: string[] | null;
|
|
2617
|
+
/**
|
|
2618
|
+
* Required
|
|
2619
|
+
* @description Whether a local presence is required to register and maintain a domain name
|
|
2620
|
+
*/
|
|
2621
|
+
required: boolean;
|
|
2622
|
+
/**
|
|
2623
|
+
* Requirement
|
|
2624
|
+
* @description Type of local presence requirement
|
|
2625
|
+
*/
|
|
2626
|
+
requirement?: components["schemas"]["LocalPresenceRequirementType"][] | null;
|
|
2627
|
+
/**
|
|
2628
|
+
* Type
|
|
2629
|
+
* @description Who must meet the requirement
|
|
2630
|
+
*/
|
|
2631
|
+
type?: components["schemas"]["ContactRoleType"][] | null;
|
|
2632
|
+
};
|
|
2633
|
+
/**
|
|
2634
|
+
* LocalPresenceRequirementType
|
|
2635
|
+
* @enum {string}
|
|
2636
|
+
*/
|
|
2637
|
+
LocalPresenceRequirementType: "physical_address" | "business_entity";
|
|
2308
2638
|
/** Nameserver */
|
|
2309
2639
|
Nameserver: {
|
|
2310
2640
|
/**
|
|
@@ -3145,6 +3475,17 @@ export interface components {
|
|
|
3145
3475
|
* @enum {string}
|
|
3146
3476
|
*/
|
|
3147
3477
|
PatchOp: "upsert" | "remove";
|
|
3478
|
+
/** Period */
|
|
3479
|
+
Period: {
|
|
3480
|
+
/** @description The unit of the period */
|
|
3481
|
+
unit: components["schemas"]["PeriodUnit"];
|
|
3482
|
+
/**
|
|
3483
|
+
* Value
|
|
3484
|
+
* @description Amount of time in the unit
|
|
3485
|
+
*/
|
|
3486
|
+
value: number;
|
|
3487
|
+
};
|
|
3488
|
+
PeriodList: components["schemas"]["Period"][] | null;
|
|
3148
3489
|
/**
|
|
3149
3490
|
* PeriodUnit
|
|
3150
3491
|
* @enum {string}
|
|
@@ -3170,6 +3511,41 @@ export interface components {
|
|
|
3170
3511
|
/** @default basic_plan */
|
|
3171
3512
|
plan: components["schemas"]["PlanRelation"];
|
|
3172
3513
|
};
|
|
3514
|
+
/**
|
|
3515
|
+
* PostTransferRequirements
|
|
3516
|
+
* @enum {string}
|
|
3517
|
+
*/
|
|
3518
|
+
PostTransferRequirements: "update_contacts" | "tld_specific";
|
|
3519
|
+
/**
|
|
3520
|
+
* PostalAddressType
|
|
3521
|
+
* @enum {string}
|
|
3522
|
+
*/
|
|
3523
|
+
PostalAddressType: "loc" | "int";
|
|
3524
|
+
/**
|
|
3525
|
+
* PremiumAffectsType
|
|
3526
|
+
* @enum {string}
|
|
3527
|
+
*/
|
|
3528
|
+
PremiumAffectsType: "registration" | "renewal";
|
|
3529
|
+
/** PremiumDomainsBase */
|
|
3530
|
+
PremiumDomainsBase: {
|
|
3531
|
+
/**
|
|
3532
|
+
* Affects
|
|
3533
|
+
* @description What operations are affected by premium status
|
|
3534
|
+
*/
|
|
3535
|
+
affects?: components["schemas"]["PremiumAffectsType"][] | null;
|
|
3536
|
+
/** @description Source of premium domain information */
|
|
3537
|
+
source?: components["schemas"]["PremiumSourceType"] | null;
|
|
3538
|
+
/**
|
|
3539
|
+
* Supported
|
|
3540
|
+
* @description Whether the registry has premium domains
|
|
3541
|
+
*/
|
|
3542
|
+
supported: boolean;
|
|
3543
|
+
};
|
|
3544
|
+
/**
|
|
3545
|
+
* PremiumSourceType
|
|
3546
|
+
* @enum {string}
|
|
3547
|
+
*/
|
|
3548
|
+
PremiumSourceType: "EPP" | "API" | "CSV" | "manual";
|
|
3173
3549
|
/** Problem */
|
|
3174
3550
|
Problem: {
|
|
3175
3551
|
/** Problem detail */
|
|
@@ -3181,6 +3557,42 @@ export interface components {
|
|
|
3181
3557
|
/** Problem type */
|
|
3182
3558
|
type: string;
|
|
3183
3559
|
};
|
|
3560
|
+
/** RdapBase */
|
|
3561
|
+
RdapBase: {
|
|
3562
|
+
/**
|
|
3563
|
+
* Rdap Server
|
|
3564
|
+
* @description RDAP server URL
|
|
3565
|
+
*/
|
|
3566
|
+
rdap_server?: string | null;
|
|
3567
|
+
};
|
|
3568
|
+
/**
|
|
3569
|
+
* RegistrantChangeType
|
|
3570
|
+
* @enum {string}
|
|
3571
|
+
*/
|
|
3572
|
+
RegistrantChangeType: "update" | "trade";
|
|
3573
|
+
/** RegistryLockBase */
|
|
3574
|
+
RegistryLockBase: {
|
|
3575
|
+
/**
|
|
3576
|
+
* Prevents
|
|
3577
|
+
* @description What operations are prevented by registry lock
|
|
3578
|
+
*/
|
|
3579
|
+
prevents?: string[] | null;
|
|
3580
|
+
/**
|
|
3581
|
+
* Removal Process
|
|
3582
|
+
* @description Process for unlocking the domain
|
|
3583
|
+
*/
|
|
3584
|
+
removal_process?: string | null;
|
|
3585
|
+
/**
|
|
3586
|
+
* Requires Manual Request
|
|
3587
|
+
* @description Whether a manual request is required
|
|
3588
|
+
*/
|
|
3589
|
+
requires_manual_request?: boolean | null;
|
|
3590
|
+
/**
|
|
3591
|
+
* Supported
|
|
3592
|
+
* @description Whether the registry provides a Registry Lock feature
|
|
3593
|
+
*/
|
|
3594
|
+
supported: boolean;
|
|
3595
|
+
};
|
|
3184
3596
|
/**
|
|
3185
3597
|
* Relation
|
|
3186
3598
|
* @enum {string}
|
|
@@ -3196,6 +3608,26 @@ export interface components {
|
|
|
3196
3608
|
* @enum {string}
|
|
3197
3609
|
*/
|
|
3198
3610
|
RenewalMode: "renew" | "expire" | "delete";
|
|
3611
|
+
/** ReservedDomainsBase */
|
|
3612
|
+
ReservedDomainsBase: {
|
|
3613
|
+
/** @description Source of reserved domain information */
|
|
3614
|
+
source?: components["schemas"]["ReservedSourceType"] | null;
|
|
3615
|
+
/**
|
|
3616
|
+
* Supported
|
|
3617
|
+
* @description Registry provides a reserved list
|
|
3618
|
+
*/
|
|
3619
|
+
supported: boolean;
|
|
3620
|
+
/**
|
|
3621
|
+
* Url
|
|
3622
|
+
* @description Link to reserved list
|
|
3623
|
+
*/
|
|
3624
|
+
url?: string | null;
|
|
3625
|
+
};
|
|
3626
|
+
/**
|
|
3627
|
+
* ReservedSourceType
|
|
3628
|
+
* @enum {string}
|
|
3629
|
+
*/
|
|
3630
|
+
ReservedSourceType: "API" | "CSV" | "manual";
|
|
3199
3631
|
/** SignupCreate */
|
|
3200
3632
|
SignupCreate: {
|
|
3201
3633
|
/** @description Organization signup. */
|
|
@@ -3205,6 +3637,19 @@ export interface components {
|
|
|
3205
3637
|
/** @description User signup to platform. */
|
|
3206
3638
|
user: components["schemas"]["UserCreate"];
|
|
3207
3639
|
};
|
|
3640
|
+
/** SldLength */
|
|
3641
|
+
SldLength: {
|
|
3642
|
+
/**
|
|
3643
|
+
* Max
|
|
3644
|
+
* @description Maximum length of a domain name
|
|
3645
|
+
*/
|
|
3646
|
+
max: number;
|
|
3647
|
+
/**
|
|
3648
|
+
* Min
|
|
3649
|
+
* @description Minimum length of a domain name
|
|
3650
|
+
*/
|
|
3651
|
+
min: number;
|
|
3652
|
+
};
|
|
3208
3653
|
/**
|
|
3209
3654
|
* SortOrder
|
|
3210
3655
|
* @enum {string}
|
|
@@ -3217,11 +3662,101 @@ export interface components {
|
|
|
3217
3662
|
/** Remove */
|
|
3218
3663
|
remove?: components["schemas"]["Relation"][] | null;
|
|
3219
3664
|
};
|
|
3665
|
+
/**
|
|
3666
|
+
* SyncOperationType
|
|
3667
|
+
* @enum {string}
|
|
3668
|
+
*/
|
|
3669
|
+
SyncOperationType: "registration" | "renewal" | "transfer";
|
|
3670
|
+
/**
|
|
3671
|
+
* TLDType
|
|
3672
|
+
* @enum {string}
|
|
3673
|
+
*/
|
|
3674
|
+
TLDType: "gTLD" | "ccTLD";
|
|
3220
3675
|
/** TermsOfServiceAccept */
|
|
3221
3676
|
TermsOfServiceAccept: {
|
|
3222
3677
|
/** Accepted */
|
|
3223
3678
|
accepted: boolean;
|
|
3224
3679
|
};
|
|
3680
|
+
/** TldBase */
|
|
3681
|
+
TldBase: {
|
|
3682
|
+
/**
|
|
3683
|
+
* Name
|
|
3684
|
+
* @description The TLD being configured
|
|
3685
|
+
*/
|
|
3686
|
+
name: string;
|
|
3687
|
+
/** @description The type of the TLD (e.g., gTLD, ccTLD) */
|
|
3688
|
+
type: components["schemas"]["TLDType"];
|
|
3689
|
+
};
|
|
3690
|
+
/** TldResponseShort */
|
|
3691
|
+
TldResponseShort: {
|
|
3692
|
+
/** Tld */
|
|
3693
|
+
tld: string;
|
|
3694
|
+
type: components["schemas"]["TLDType"];
|
|
3695
|
+
};
|
|
3696
|
+
/** TldSpecificationResponse */
|
|
3697
|
+
TldSpecificationResponse: {
|
|
3698
|
+
/** @description Character limits for domain names */
|
|
3699
|
+
characters: components["schemas"]["SldLength"];
|
|
3700
|
+
/** @description Contacts configuration */
|
|
3701
|
+
contacts?: components["schemas"]["ContactsBase"] | null;
|
|
3702
|
+
/** @description DNS configuration */
|
|
3703
|
+
dns_configuration: components["schemas"]["DnsConfigurationBase"];
|
|
3704
|
+
/** @description Domain lifecycle configuration */
|
|
3705
|
+
domain_lifecycle: components["schemas"]["DomainLifecycleBase"];
|
|
3706
|
+
/** @description Domain statuses configuration */
|
|
3707
|
+
domain_statuses: components["schemas"]["DomainStatusesBase"];
|
|
3708
|
+
/** @description IDN configuration */
|
|
3709
|
+
idn: components["schemas"]["IdnBase"];
|
|
3710
|
+
/** @description Launch phases configuration */
|
|
3711
|
+
launch_phases?: components["schemas"]["LaunchPhasesBase"] | null;
|
|
3712
|
+
/** @description Local presence requirements */
|
|
3713
|
+
local_presence?: components["schemas"]["LocalPresenceBase"] | null;
|
|
3714
|
+
/** @description Premium domains configuration */
|
|
3715
|
+
premium_domains?: components["schemas"]["PremiumDomainsBase"] | null;
|
|
3716
|
+
/** @description RDAP configuration */
|
|
3717
|
+
rdap?: components["schemas"]["RdapBase"] | null;
|
|
3718
|
+
/** @description Registry lock configuration */
|
|
3719
|
+
registry_lock?: components["schemas"]["RegistryLockBase"] | null;
|
|
3720
|
+
/** @description Reserved domains configuration */
|
|
3721
|
+
reserved_domains?: components["schemas"]["ReservedDomainsBase"] | null;
|
|
3722
|
+
/**
|
|
3723
|
+
* Tlds
|
|
3724
|
+
* @description List of TLDs being configured
|
|
3725
|
+
*/
|
|
3726
|
+
tlds: components["schemas"]["TldBase"][];
|
|
3727
|
+
/** @description Transfer policies configuration */
|
|
3728
|
+
transfer_policies: components["schemas"]["TransferPoliciesBase"];
|
|
3729
|
+
/** @description WHOIS configuration */
|
|
3730
|
+
whois?: components["schemas"]["WhoisBase"] | null;
|
|
3731
|
+
};
|
|
3732
|
+
/** TrademarkClaimsBase */
|
|
3733
|
+
TrademarkClaimsBase: {
|
|
3734
|
+
/**
|
|
3735
|
+
* End Date
|
|
3736
|
+
* @description End date of trademark claims
|
|
3737
|
+
*/
|
|
3738
|
+
end_date?: Date | null;
|
|
3739
|
+
/**
|
|
3740
|
+
* Start Date
|
|
3741
|
+
* @description Start date of trademark claims
|
|
3742
|
+
*/
|
|
3743
|
+
start_date?: Date | null;
|
|
3744
|
+
/**
|
|
3745
|
+
* Supported
|
|
3746
|
+
* @description Whether trademark claims are supported
|
|
3747
|
+
*/
|
|
3748
|
+
supported: boolean;
|
|
3749
|
+
/**
|
|
3750
|
+
* Tmch Required
|
|
3751
|
+
* @description If true, claim notifications are mandatory within the timeframe
|
|
3752
|
+
*/
|
|
3753
|
+
tmch_required?: boolean | null;
|
|
3754
|
+
};
|
|
3755
|
+
/**
|
|
3756
|
+
* TransferAckType
|
|
3757
|
+
* @enum {string}
|
|
3758
|
+
*/
|
|
3759
|
+
TransferAckType: "none" | "registrar" | "registrant" | "both";
|
|
3225
3760
|
/** TransferEvent */
|
|
3226
3761
|
TransferEvent: {
|
|
3227
3762
|
/** Current Registrar */
|
|
@@ -3233,6 +3768,78 @@ export interface components {
|
|
|
3233
3768
|
/** Requesting Registrar */
|
|
3234
3769
|
requesting_registrar: string;
|
|
3235
3770
|
};
|
|
3771
|
+
/** TransferPoliciesBase */
|
|
3772
|
+
TransferPoliciesBase: {
|
|
3773
|
+
/**
|
|
3774
|
+
* Authinfo Max Length
|
|
3775
|
+
* @description Maximum length of the auth info
|
|
3776
|
+
*/
|
|
3777
|
+
authinfo_max_length?: number | null;
|
|
3778
|
+
/**
|
|
3779
|
+
* Authinfo Min Length
|
|
3780
|
+
* @description Minimum length of the auth info
|
|
3781
|
+
*/
|
|
3782
|
+
authinfo_min_length?: number | null;
|
|
3783
|
+
/**
|
|
3784
|
+
* Authinfo Required
|
|
3785
|
+
* @description Whether an auth info is required for transfers
|
|
3786
|
+
*/
|
|
3787
|
+
authinfo_required: boolean;
|
|
3788
|
+
/**
|
|
3789
|
+
* Authinfo Time Limited
|
|
3790
|
+
* @description Whether an auth info has a time limit
|
|
3791
|
+
*/
|
|
3792
|
+
authinfo_time_limited?: boolean | null;
|
|
3793
|
+
/**
|
|
3794
|
+
* Authinfo Validity Period
|
|
3795
|
+
* @description Validity period of the auth info (e.g., '5D' for 5 days)
|
|
3796
|
+
*/
|
|
3797
|
+
authinfo_validity_period?: string | null;
|
|
3798
|
+
/**
|
|
3799
|
+
* Info Contact Authinfo
|
|
3800
|
+
* @description Whether querying a foreign contact with authinfo is possible
|
|
3801
|
+
*/
|
|
3802
|
+
info_contact_authinfo?: boolean | null;
|
|
3803
|
+
/**
|
|
3804
|
+
* Info Domain Authinfo
|
|
3805
|
+
* @description Whether querying a foreign domain with authinfo is possible
|
|
3806
|
+
*/
|
|
3807
|
+
info_domain_authinfo?: boolean | null;
|
|
3808
|
+
/**
|
|
3809
|
+
* Post Transfer Requirements
|
|
3810
|
+
* @description Post-transfer requirements: lists the behaviors, as in ['update_contacts', 'set_transfer_lock'] or [ 'tld_specific' ] for specific behavior
|
|
3811
|
+
*/
|
|
3812
|
+
post_transfer_requirements?: components["schemas"]["PostTransferRequirements"][] | null;
|
|
3813
|
+
/** @description Whether a transfer can be approved */
|
|
3814
|
+
transfer_ack?: components["schemas"]["TransferAckType"] | null;
|
|
3815
|
+
/**
|
|
3816
|
+
* Transfer Email Required
|
|
3817
|
+
* @description Whether an email confirmation is required to perform the transfer
|
|
3818
|
+
*/
|
|
3819
|
+
transfer_email_required?: boolean | null;
|
|
3820
|
+
/**
|
|
3821
|
+
* Transfer Lock Enabled
|
|
3822
|
+
* @description Whether transfers are locked by default in our system
|
|
3823
|
+
*/
|
|
3824
|
+
transfer_lock_enabled: boolean;
|
|
3825
|
+
/** @description Whether a transfer can be denied */
|
|
3826
|
+
transfer_nack?: components["schemas"]["TransferAckType"] | null;
|
|
3827
|
+
/**
|
|
3828
|
+
* Transfer Renewal Period
|
|
3829
|
+
* @description If transfer_renews_domain is true, the renewal period (e.g., '1Y' for 1 year)
|
|
3830
|
+
*/
|
|
3831
|
+
transfer_renewal_period?: string | null;
|
|
3832
|
+
/**
|
|
3833
|
+
* Transfer Renews Domain
|
|
3834
|
+
* @description Whether a transfer triggers a domain renewal
|
|
3835
|
+
*/
|
|
3836
|
+
transfer_renews_domain?: boolean | null;
|
|
3837
|
+
/**
|
|
3838
|
+
* Transfer Time
|
|
3839
|
+
* @description Time duration of transfers in ISO 8601 format (e.g., 5D, -7D) according to the policy, 0 = real-time
|
|
3840
|
+
*/
|
|
3841
|
+
transfer_time?: string | null;
|
|
3842
|
+
};
|
|
3236
3843
|
/** User */
|
|
3237
3844
|
User: {
|
|
3238
3845
|
/**
|
|
@@ -3611,6 +4218,14 @@ export interface components {
|
|
|
3611
4218
|
* @enum {string}
|
|
3612
4219
|
*/
|
|
3613
4220
|
VerificationType: "api" | "email";
|
|
4221
|
+
/** WhoisBase */
|
|
4222
|
+
WhoisBase: {
|
|
4223
|
+
/**
|
|
4224
|
+
* Whois Server
|
|
4225
|
+
* @description WHOIS server
|
|
4226
|
+
*/
|
|
4227
|
+
whois_server?: string | null;
|
|
4228
|
+
};
|
|
3614
4229
|
/**
|
|
3615
4230
|
* ZoneSortField
|
|
3616
4231
|
* @enum {string}
|
|
@@ -6920,6 +7535,73 @@ export interface operations {
|
|
|
6920
7535
|
};
|
|
6921
7536
|
};
|
|
6922
7537
|
};
|
|
7538
|
+
get_tld_portfolio_v1_tlds_portfolio_get: {
|
|
7539
|
+
parameters: {
|
|
7540
|
+
query?: never;
|
|
7541
|
+
header?: never;
|
|
7542
|
+
path?: never;
|
|
7543
|
+
cookie?: never;
|
|
7544
|
+
};
|
|
7545
|
+
requestBody?: never;
|
|
7546
|
+
responses: {
|
|
7547
|
+
/** @description Successful Response */
|
|
7548
|
+
200: {
|
|
7549
|
+
headers: {
|
|
7550
|
+
[name: string]: unknown;
|
|
7551
|
+
};
|
|
7552
|
+
content: {
|
|
7553
|
+
"application/json": components["schemas"]["TldResponseShort"][];
|
|
7554
|
+
};
|
|
7555
|
+
};
|
|
7556
|
+
};
|
|
7557
|
+
};
|
|
7558
|
+
get_tld_spec_v1_tlds__tld__get: {
|
|
7559
|
+
parameters: {
|
|
7560
|
+
query?: never;
|
|
7561
|
+
header?: never;
|
|
7562
|
+
path: {
|
|
7563
|
+
tld: string;
|
|
7564
|
+
};
|
|
7565
|
+
cookie?: never;
|
|
7566
|
+
};
|
|
7567
|
+
requestBody?: never;
|
|
7568
|
+
responses: {
|
|
7569
|
+
/** @description Successful Response */
|
|
7570
|
+
200: {
|
|
7571
|
+
headers: {
|
|
7572
|
+
[name: string]: unknown;
|
|
7573
|
+
};
|
|
7574
|
+
content: {
|
|
7575
|
+
"application/json": components["schemas"]["TldSpecificationResponse"];
|
|
7576
|
+
};
|
|
7577
|
+
};
|
|
7578
|
+
/** @description Not Found */
|
|
7579
|
+
404: {
|
|
7580
|
+
headers: {
|
|
7581
|
+
[name: string]: unknown;
|
|
7582
|
+
};
|
|
7583
|
+
content: {
|
|
7584
|
+
/** @example {
|
|
7585
|
+
* "code": "ERROR_TLD_NOT_FOUND",
|
|
7586
|
+
* "detail": "Unknown TLD",
|
|
7587
|
+
* "status": 404,
|
|
7588
|
+
* "title": "TLD ERROR",
|
|
7589
|
+
* "type": "tld-not-found"
|
|
7590
|
+
* } */
|
|
7591
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
7592
|
+
};
|
|
7593
|
+
};
|
|
7594
|
+
/** @description Validation Error */
|
|
7595
|
+
422: {
|
|
7596
|
+
headers: {
|
|
7597
|
+
[name: string]: unknown;
|
|
7598
|
+
};
|
|
7599
|
+
content: {
|
|
7600
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
7601
|
+
};
|
|
7602
|
+
};
|
|
7603
|
+
};
|
|
7604
|
+
};
|
|
6923
7605
|
create_user_v1_users_post: {
|
|
6924
7606
|
parameters: {
|
|
6925
7607
|
query?: never;
|