@opusdns/api 0.104.0 → 0.106.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 +262 -0
- package/src/helpers/requests.d.ts +105 -1
- package/src/helpers/responses.d.ts +147 -1
- package/src/helpers/schemas.d.ts +64 -0
- package/src/openapi.yaml +164 -1
- package/src/schema.d.ts +180 -0
package/package.json
CHANGED
package/src/helpers/keys.ts
CHANGED
|
@@ -93,7 +93,11 @@ import { DomainStatusesBase } from './schemas';
|
|
|
93
93
|
import { DomainSummaryData } from './schemas';
|
|
94
94
|
import { DomainSummary } from './schemas';
|
|
95
95
|
import { DomainTransferIn } from './schemas';
|
|
96
|
+
import { DomainTransitRequest } from './schemas';
|
|
97
|
+
import { DomainTransit } from './schemas';
|
|
96
98
|
import { DomainUpdate } from './schemas';
|
|
99
|
+
import { DomainWithdrawRequest } from './schemas';
|
|
100
|
+
import { DomainWithdraw } from './schemas';
|
|
97
101
|
import { DomainsExpiringSoon } from './schemas';
|
|
98
102
|
import { EmailForwardAlias } from './schemas';
|
|
99
103
|
import { EmailForwardAliasUpdate } from './schemas';
|
|
@@ -9742,6 +9746,135 @@ export const KEYS_DOMAIN_TRANSFER_IN = [
|
|
|
9742
9746
|
KEY_DOMAIN_TRANSFER_IN_RENEWAL_MODE,
|
|
9743
9747
|
] as const satisfies (keyof DomainTransferIn)[];
|
|
9744
9748
|
|
|
9749
|
+
/**
|
|
9750
|
+
* Disconnect
|
|
9751
|
+
*
|
|
9752
|
+
* Disconnect the domain from current nameserver and update to DENIC nameserver
|
|
9753
|
+
*
|
|
9754
|
+
* @type {boolean}
|
|
9755
|
+
*
|
|
9756
|
+
*
|
|
9757
|
+
* @remarks
|
|
9758
|
+
* This key constant provides type-safe access to the `disconnect` property of DomainTransitRequest objects.
|
|
9759
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
9760
|
+
*
|
|
9761
|
+
* @example
|
|
9762
|
+
* ```typescript
|
|
9763
|
+
* // Direct property access
|
|
9764
|
+
* const value = domaintransitrequest[KEY_DOMAIN_TRANSIT_REQUEST_DISCONNECT];
|
|
9765
|
+
*
|
|
9766
|
+
* // Dynamic property access
|
|
9767
|
+
* const propertyName = KEY_DOMAIN_TRANSIT_REQUEST_DISCONNECT;
|
|
9768
|
+
* const value = domaintransitrequest[propertyName];
|
|
9769
|
+
* ```
|
|
9770
|
+
*
|
|
9771
|
+
* @see {@link DomainTransitRequest} - The TypeScript type definition
|
|
9772
|
+
* @see {@link KEYS_DOMAIN_TRANSIT_REQUEST} - Array of all keys for this type
|
|
9773
|
+
*/
|
|
9774
|
+
export const KEY_DOMAIN_TRANSIT_REQUEST_DISCONNECT = 'disconnect' as keyof DomainTransitRequest;
|
|
9775
|
+
|
|
9776
|
+
/**
|
|
9777
|
+
* Array of all DomainTransitRequest property keys
|
|
9778
|
+
*
|
|
9779
|
+
* @remarks
|
|
9780
|
+
* This constant provides a readonly array containing all valid property keys for DomainTransitRequest objects.
|
|
9781
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
9782
|
+
*
|
|
9783
|
+
* @example
|
|
9784
|
+
* ```typescript
|
|
9785
|
+
* // Iterating through all keys
|
|
9786
|
+
* for (const key of KEYS_DOMAIN_TRANSIT_REQUEST) {
|
|
9787
|
+
* console.log(`Property: ${key}, Value: ${domaintransitrequest[key]}`);
|
|
9788
|
+
* }
|
|
9789
|
+
*
|
|
9790
|
+
* // Validation
|
|
9791
|
+
* const isValidKey = KEYS_DOMAIN_TRANSIT_REQUEST.includes(someKey);
|
|
9792
|
+
* ```
|
|
9793
|
+
*
|
|
9794
|
+
* @see {@link DomainTransitRequest} - The TypeScript type definition
|
|
9795
|
+
*/
|
|
9796
|
+
export const KEYS_DOMAIN_TRANSIT_REQUEST = [
|
|
9797
|
+
KEY_DOMAIN_TRANSIT_REQUEST_DISCONNECT,
|
|
9798
|
+
] as const satisfies (keyof DomainTransitRequest)[];
|
|
9799
|
+
|
|
9800
|
+
/**
|
|
9801
|
+
* Name
|
|
9802
|
+
*
|
|
9803
|
+
* The domain name that was transited
|
|
9804
|
+
*
|
|
9805
|
+
* @type {string}
|
|
9806
|
+
*
|
|
9807
|
+
*
|
|
9808
|
+
* @remarks
|
|
9809
|
+
* This key constant provides type-safe access to the `name` property of DomainTransit objects.
|
|
9810
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
9811
|
+
*
|
|
9812
|
+
* @example
|
|
9813
|
+
* ```typescript
|
|
9814
|
+
* // Direct property access
|
|
9815
|
+
* const value = domaintransit[KEY_DOMAIN_TRANSIT_NAME];
|
|
9816
|
+
*
|
|
9817
|
+
* // Dynamic property access
|
|
9818
|
+
* const propertyName = KEY_DOMAIN_TRANSIT_NAME;
|
|
9819
|
+
* const value = domaintransit[propertyName];
|
|
9820
|
+
* ```
|
|
9821
|
+
*
|
|
9822
|
+
* @see {@link DomainTransit} - The TypeScript type definition
|
|
9823
|
+
* @see {@link KEYS_DOMAIN_TRANSIT} - Array of all keys for this type
|
|
9824
|
+
*/
|
|
9825
|
+
export const KEY_DOMAIN_TRANSIT_NAME = 'name' as keyof DomainTransit;
|
|
9826
|
+
/**
|
|
9827
|
+
* Success
|
|
9828
|
+
*
|
|
9829
|
+
* Whether the transit operation was successful
|
|
9830
|
+
*
|
|
9831
|
+
* @type {boolean}
|
|
9832
|
+
*
|
|
9833
|
+
*
|
|
9834
|
+
* @remarks
|
|
9835
|
+
* This key constant provides type-safe access to the `success` property of DomainTransit objects.
|
|
9836
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
9837
|
+
*
|
|
9838
|
+
* @example
|
|
9839
|
+
* ```typescript
|
|
9840
|
+
* // Direct property access
|
|
9841
|
+
* const value = domaintransit[KEY_DOMAIN_TRANSIT_SUCCESS];
|
|
9842
|
+
*
|
|
9843
|
+
* // Dynamic property access
|
|
9844
|
+
* const propertyName = KEY_DOMAIN_TRANSIT_SUCCESS;
|
|
9845
|
+
* const value = domaintransit[propertyName];
|
|
9846
|
+
* ```
|
|
9847
|
+
*
|
|
9848
|
+
* @see {@link DomainTransit} - The TypeScript type definition
|
|
9849
|
+
* @see {@link KEYS_DOMAIN_TRANSIT} - Array of all keys for this type
|
|
9850
|
+
*/
|
|
9851
|
+
export const KEY_DOMAIN_TRANSIT_SUCCESS = 'success' as keyof DomainTransit;
|
|
9852
|
+
|
|
9853
|
+
/**
|
|
9854
|
+
* Array of all DomainTransit property keys
|
|
9855
|
+
*
|
|
9856
|
+
* @remarks
|
|
9857
|
+
* This constant provides a readonly array containing all valid property keys for DomainTransit objects.
|
|
9858
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
9859
|
+
*
|
|
9860
|
+
* @example
|
|
9861
|
+
* ```typescript
|
|
9862
|
+
* // Iterating through all keys
|
|
9863
|
+
* for (const key of KEYS_DOMAIN_TRANSIT) {
|
|
9864
|
+
* console.log(`Property: ${key}, Value: ${domaintransit[key]}`);
|
|
9865
|
+
* }
|
|
9866
|
+
*
|
|
9867
|
+
* // Validation
|
|
9868
|
+
* const isValidKey = KEYS_DOMAIN_TRANSIT.includes(someKey);
|
|
9869
|
+
* ```
|
|
9870
|
+
*
|
|
9871
|
+
* @see {@link DomainTransit} - The TypeScript type definition
|
|
9872
|
+
*/
|
|
9873
|
+
export const KEYS_DOMAIN_TRANSIT = [
|
|
9874
|
+
KEY_DOMAIN_TRANSIT_NAME,
|
|
9875
|
+
KEY_DOMAIN_TRANSIT_SUCCESS,
|
|
9876
|
+
] as const satisfies (keyof DomainTransit)[];
|
|
9877
|
+
|
|
9745
9878
|
/**
|
|
9746
9879
|
* Auth Code
|
|
9747
9880
|
*
|
|
@@ -9896,6 +10029,135 @@ export const KEYS_DOMAIN_UPDATE = [
|
|
|
9896
10029
|
KEY_DOMAIN_UPDATE_STATUSES,
|
|
9897
10030
|
] as const satisfies (keyof DomainUpdate)[];
|
|
9898
10031
|
|
|
10032
|
+
/**
|
|
10033
|
+
* Zone Delete
|
|
10034
|
+
*
|
|
10035
|
+
* Informs the registry whether the zone for that domain has been already deleted - as took from the docs: "(...) the registrar informs the registry that he has stopped the nameservice for the specified domain"
|
|
10036
|
+
*
|
|
10037
|
+
* @type {boolean}
|
|
10038
|
+
*
|
|
10039
|
+
*
|
|
10040
|
+
* @remarks
|
|
10041
|
+
* This key constant provides type-safe access to the `zone_delete` property of DomainWithdrawRequest objects.
|
|
10042
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10043
|
+
*
|
|
10044
|
+
* @example
|
|
10045
|
+
* ```typescript
|
|
10046
|
+
* // Direct property access
|
|
10047
|
+
* const value = domainwithdrawrequest[KEY_DOMAIN_WITHDRAW_REQUEST_ZONE_DELETE];
|
|
10048
|
+
*
|
|
10049
|
+
* // Dynamic property access
|
|
10050
|
+
* const propertyName = KEY_DOMAIN_WITHDRAW_REQUEST_ZONE_DELETE;
|
|
10051
|
+
* const value = domainwithdrawrequest[propertyName];
|
|
10052
|
+
* ```
|
|
10053
|
+
*
|
|
10054
|
+
* @see {@link DomainWithdrawRequest} - The TypeScript type definition
|
|
10055
|
+
* @see {@link KEYS_DOMAIN_WITHDRAW_REQUEST} - Array of all keys for this type
|
|
10056
|
+
*/
|
|
10057
|
+
export const KEY_DOMAIN_WITHDRAW_REQUEST_ZONE_DELETE = 'zone_delete' as keyof DomainWithdrawRequest;
|
|
10058
|
+
|
|
10059
|
+
/**
|
|
10060
|
+
* Array of all DomainWithdrawRequest property keys
|
|
10061
|
+
*
|
|
10062
|
+
* @remarks
|
|
10063
|
+
* This constant provides a readonly array containing all valid property keys for DomainWithdrawRequest objects.
|
|
10064
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
10065
|
+
*
|
|
10066
|
+
* @example
|
|
10067
|
+
* ```typescript
|
|
10068
|
+
* // Iterating through all keys
|
|
10069
|
+
* for (const key of KEYS_DOMAIN_WITHDRAW_REQUEST) {
|
|
10070
|
+
* console.log(`Property: ${key}, Value: ${domainwithdrawrequest[key]}`);
|
|
10071
|
+
* }
|
|
10072
|
+
*
|
|
10073
|
+
* // Validation
|
|
10074
|
+
* const isValidKey = KEYS_DOMAIN_WITHDRAW_REQUEST.includes(someKey);
|
|
10075
|
+
* ```
|
|
10076
|
+
*
|
|
10077
|
+
* @see {@link DomainWithdrawRequest} - The TypeScript type definition
|
|
10078
|
+
*/
|
|
10079
|
+
export const KEYS_DOMAIN_WITHDRAW_REQUEST = [
|
|
10080
|
+
KEY_DOMAIN_WITHDRAW_REQUEST_ZONE_DELETE,
|
|
10081
|
+
] as const satisfies (keyof DomainWithdrawRequest)[];
|
|
10082
|
+
|
|
10083
|
+
/**
|
|
10084
|
+
* Name
|
|
10085
|
+
*
|
|
10086
|
+
* The domain name that was withdrawn
|
|
10087
|
+
*
|
|
10088
|
+
* @type {string}
|
|
10089
|
+
*
|
|
10090
|
+
*
|
|
10091
|
+
* @remarks
|
|
10092
|
+
* This key constant provides type-safe access to the `name` property of DomainWithdraw objects.
|
|
10093
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10094
|
+
*
|
|
10095
|
+
* @example
|
|
10096
|
+
* ```typescript
|
|
10097
|
+
* // Direct property access
|
|
10098
|
+
* const value = domainwithdraw[KEY_DOMAIN_WITHDRAW_NAME];
|
|
10099
|
+
*
|
|
10100
|
+
* // Dynamic property access
|
|
10101
|
+
* const propertyName = KEY_DOMAIN_WITHDRAW_NAME;
|
|
10102
|
+
* const value = domainwithdraw[propertyName];
|
|
10103
|
+
* ```
|
|
10104
|
+
*
|
|
10105
|
+
* @see {@link DomainWithdraw} - The TypeScript type definition
|
|
10106
|
+
* @see {@link KEYS_DOMAIN_WITHDRAW} - Array of all keys for this type
|
|
10107
|
+
*/
|
|
10108
|
+
export const KEY_DOMAIN_WITHDRAW_NAME = 'name' as keyof DomainWithdraw;
|
|
10109
|
+
/**
|
|
10110
|
+
* Success
|
|
10111
|
+
*
|
|
10112
|
+
* Whether the withdraw operation was successful
|
|
10113
|
+
*
|
|
10114
|
+
* @type {boolean}
|
|
10115
|
+
*
|
|
10116
|
+
*
|
|
10117
|
+
* @remarks
|
|
10118
|
+
* This key constant provides type-safe access to the `success` property of DomainWithdraw objects.
|
|
10119
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
10120
|
+
*
|
|
10121
|
+
* @example
|
|
10122
|
+
* ```typescript
|
|
10123
|
+
* // Direct property access
|
|
10124
|
+
* const value = domainwithdraw[KEY_DOMAIN_WITHDRAW_SUCCESS];
|
|
10125
|
+
*
|
|
10126
|
+
* // Dynamic property access
|
|
10127
|
+
* const propertyName = KEY_DOMAIN_WITHDRAW_SUCCESS;
|
|
10128
|
+
* const value = domainwithdraw[propertyName];
|
|
10129
|
+
* ```
|
|
10130
|
+
*
|
|
10131
|
+
* @see {@link DomainWithdraw} - The TypeScript type definition
|
|
10132
|
+
* @see {@link KEYS_DOMAIN_WITHDRAW} - Array of all keys for this type
|
|
10133
|
+
*/
|
|
10134
|
+
export const KEY_DOMAIN_WITHDRAW_SUCCESS = 'success' as keyof DomainWithdraw;
|
|
10135
|
+
|
|
10136
|
+
/**
|
|
10137
|
+
* Array of all DomainWithdraw property keys
|
|
10138
|
+
*
|
|
10139
|
+
* @remarks
|
|
10140
|
+
* This constant provides a readonly array containing all valid property keys for DomainWithdraw objects.
|
|
10141
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
10142
|
+
*
|
|
10143
|
+
* @example
|
|
10144
|
+
* ```typescript
|
|
10145
|
+
* // Iterating through all keys
|
|
10146
|
+
* for (const key of KEYS_DOMAIN_WITHDRAW) {
|
|
10147
|
+
* console.log(`Property: ${key}, Value: ${domainwithdraw[key]}`);
|
|
10148
|
+
* }
|
|
10149
|
+
*
|
|
10150
|
+
* // Validation
|
|
10151
|
+
* const isValidKey = KEYS_DOMAIN_WITHDRAW.includes(someKey);
|
|
10152
|
+
* ```
|
|
10153
|
+
*
|
|
10154
|
+
* @see {@link DomainWithdraw} - The TypeScript type definition
|
|
10155
|
+
*/
|
|
10156
|
+
export const KEYS_DOMAIN_WITHDRAW = [
|
|
10157
|
+
KEY_DOMAIN_WITHDRAW_NAME,
|
|
10158
|
+
KEY_DOMAIN_WITHDRAW_SUCCESS,
|
|
10159
|
+
] as const satisfies (keyof DomainWithdraw)[];
|
|
10160
|
+
|
|
9899
10161
|
/**
|
|
9900
10162
|
* Next 30 Days
|
|
9901
10163
|
*
|
|
@@ -34,7 +34,7 @@ import { operations } from '../schema';
|
|
|
34
34
|
|
|
35
35
|
import { DomainDnssecDataCreateArray, OrganizationAttributeUpdateArray } from './schemas-arrays.d';
|
|
36
36
|
|
|
37
|
-
import { ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainForwardPatchOps, DomainForwardRequest, DomainForwardSetRequest, DomainCreate, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainTransferIn, EmailForwardAlias, EmailForwardAliasUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, UserCreate, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
|
|
37
|
+
import { ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainForwardPatchOps, DomainForwardRequest, DomainForwardSetRequest, DomainCreate, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainWithdrawRequest, DomainTransitRequest, DomainTransferIn, EmailForwardAlias, EmailForwardAliasUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, UserCreate, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
40
|
* Request type for GET ArchiveObjectLogs endpoint
|
|
@@ -2406,6 +2406,110 @@ export type DELETE_DomainsDomainReferenceTransfer_Request_Path = DELETE_DomainsD
|
|
|
2406
2406
|
export type GET_DomainsSummary_Request = {
|
|
2407
2407
|
}
|
|
2408
2408
|
|
|
2409
|
+
/**
|
|
2410
|
+
* Request type for POST DomainsTldSpecificAtDomainReferenceWithdraw endpoint
|
|
2411
|
+
*
|
|
2412
|
+
* Withdraw a nic.at domain
|
|
2413
|
+
*
|
|
2414
|
+
* @remarks
|
|
2415
|
+
* This type defines the complete request structure for the POST DomainsTldSpecificAtDomainReferenceWithdraw endpoint.
|
|
2416
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
2417
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
2418
|
+
*
|
|
2419
|
+
* @example
|
|
2420
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
2421
|
+
*
|
|
2422
|
+
* @path /v1/domains/tld-specific/at/{domain_reference}/withdraw
|
|
2423
|
+
*
|
|
2424
|
+
* @see {@link POST_DomainsTldSpecificAtDomainReferenceWithdraw_Request_Query} - Query parameters type
|
|
2425
|
+
* @see {@link POST_DomainsTldSpecificAtDomainReferenceWithdraw_Request_Path} - Path parameters type
|
|
2426
|
+
* @see {@link POST_DomainsTldSpecificAtDomainReferenceWithdraw_Request_Body} - Request body type
|
|
2427
|
+
*/
|
|
2428
|
+
export type POST_DomainsTldSpecificAtDomainReferenceWithdraw_Request = {
|
|
2429
|
+
parameters: {
|
|
2430
|
+
path: operations['withdraw_domain_v1_domains_tld_specific_at__domain_reference__withdraw_post']['parameters']['path'];
|
|
2431
|
+
};
|
|
2432
|
+
requestBody: DomainWithdrawRequest;
|
|
2433
|
+
}
|
|
2434
|
+
/**
|
|
2435
|
+
* Path parameters for POST /v1/domains/tld-specific/at/{domain_reference}/withdraw
|
|
2436
|
+
*
|
|
2437
|
+
* @remarks
|
|
2438
|
+
* This type defines the path parameters for the POST /v1/domains/tld-specific/at/{domain_reference}/withdraw endpoint.
|
|
2439
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
2440
|
+
*
|
|
2441
|
+
* @example
|
|
2442
|
+
* Use this type to ensure type safety for path parameters.
|
|
2443
|
+
*
|
|
2444
|
+
* @path /v1/domains/tld-specific/at/{domain_reference}/withdraw
|
|
2445
|
+
*/
|
|
2446
|
+
export type POST_DomainsTldSpecificAtDomainReferenceWithdraw_Request_Path = POST_DomainsTldSpecificAtDomainReferenceWithdraw_Request['parameters']['path'];
|
|
2447
|
+
/**
|
|
2448
|
+
* Request body for POST /v1/domains/tld-specific/at/{domain_reference}/withdraw
|
|
2449
|
+
*
|
|
2450
|
+
* @remarks
|
|
2451
|
+
* This type defines the request body structure for the POST /v1/domains/tld-specific/at/{domain_reference}/withdraw endpoint.
|
|
2452
|
+
* It provides type safety for the request body as defined in the OpenAPI specification.
|
|
2453
|
+
*
|
|
2454
|
+
* @example
|
|
2455
|
+
* Use this type to ensure type safety for request body structure.
|
|
2456
|
+
*
|
|
2457
|
+
* @path /v1/domains/tld-specific/at/{domain_reference}/withdraw
|
|
2458
|
+
*/
|
|
2459
|
+
export type POST_DomainsTldSpecificAtDomainReferenceWithdraw_Request_Body = POST_DomainsTldSpecificAtDomainReferenceWithdraw_Request['requestBody'];
|
|
2460
|
+
|
|
2461
|
+
/**
|
|
2462
|
+
* Request type for POST DomainsTldSpecificDeDomainReferenceTransit endpoint
|
|
2463
|
+
*
|
|
2464
|
+
* Transit a DENIC domain
|
|
2465
|
+
*
|
|
2466
|
+
* @remarks
|
|
2467
|
+
* This type defines the complete request structure for the POST DomainsTldSpecificDeDomainReferenceTransit endpoint.
|
|
2468
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
2469
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
2470
|
+
*
|
|
2471
|
+
* @example
|
|
2472
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
2473
|
+
*
|
|
2474
|
+
* @path /v1/domains/tld-specific/de/{domain_reference}/transit
|
|
2475
|
+
*
|
|
2476
|
+
* @see {@link POST_DomainsTldSpecificDeDomainReferenceTransit_Request_Query} - Query parameters type
|
|
2477
|
+
* @see {@link POST_DomainsTldSpecificDeDomainReferenceTransit_Request_Path} - Path parameters type
|
|
2478
|
+
* @see {@link POST_DomainsTldSpecificDeDomainReferenceTransit_Request_Body} - Request body type
|
|
2479
|
+
*/
|
|
2480
|
+
export type POST_DomainsTldSpecificDeDomainReferenceTransit_Request = {
|
|
2481
|
+
parameters: {
|
|
2482
|
+
path: operations['transit_domain_v1_domains_tld_specific_de__domain_reference__transit_post']['parameters']['path'];
|
|
2483
|
+
};
|
|
2484
|
+
requestBody: DomainTransitRequest;
|
|
2485
|
+
}
|
|
2486
|
+
/**
|
|
2487
|
+
* Path parameters for POST /v1/domains/tld-specific/de/{domain_reference}/transit
|
|
2488
|
+
*
|
|
2489
|
+
* @remarks
|
|
2490
|
+
* This type defines the path parameters for the POST /v1/domains/tld-specific/de/{domain_reference}/transit endpoint.
|
|
2491
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
2492
|
+
*
|
|
2493
|
+
* @example
|
|
2494
|
+
* Use this type to ensure type safety for path parameters.
|
|
2495
|
+
*
|
|
2496
|
+
* @path /v1/domains/tld-specific/de/{domain_reference}/transit
|
|
2497
|
+
*/
|
|
2498
|
+
export type POST_DomainsTldSpecificDeDomainReferenceTransit_Request_Path = POST_DomainsTldSpecificDeDomainReferenceTransit_Request['parameters']['path'];
|
|
2499
|
+
/**
|
|
2500
|
+
* Request body for POST /v1/domains/tld-specific/de/{domain_reference}/transit
|
|
2501
|
+
*
|
|
2502
|
+
* @remarks
|
|
2503
|
+
* This type defines the request body structure for the POST /v1/domains/tld-specific/de/{domain_reference}/transit endpoint.
|
|
2504
|
+
* It provides type safety for the request body as defined in the OpenAPI specification.
|
|
2505
|
+
*
|
|
2506
|
+
* @example
|
|
2507
|
+
* Use this type to ensure type safety for request body structure.
|
|
2508
|
+
*
|
|
2509
|
+
* @path /v1/domains/tld-specific/de/{domain_reference}/transit
|
|
2510
|
+
*/
|
|
2511
|
+
export type POST_DomainsTldSpecificDeDomainReferenceTransit_Request_Body = POST_DomainsTldSpecificDeDomainReferenceTransit_Request['requestBody'];
|
|
2512
|
+
|
|
2409
2513
|
/**
|
|
2410
2514
|
* Request type for POST DomainsTransfer endpoint
|
|
2411
2515
|
*
|
|
@@ -34,7 +34,7 @@
|
|
|
34
34
|
|
|
35
35
|
import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
|
|
36
36
|
|
|
37
|
-
import { Pagination_ObjectLog, HTTPValidationError, Pagination_RequestHistory, Problem, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, Pagination_DomainForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, Pagination_EmailForwardAlias, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
|
|
37
|
+
import { Pagination_ObjectLog, HTTPValidationError, Pagination_RequestHistory, Problem, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, Pagination_DomainForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, DomainWithdraw, DomainTransit, Pagination_EmailForwardAlias, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
40
|
* Response types for GET ArchiveObjectLogs endpoint
|
|
@@ -4320,6 +4320,152 @@ export type GET_DomainsSummary_Response = GET_DomainsSummary_Response_200;
|
|
|
4320
4320
|
*/
|
|
4321
4321
|
export type GET_DomainsSummary_Response_200 = DomainSummary
|
|
4322
4322
|
|
|
4323
|
+
/**
|
|
4324
|
+
* Response types for POST DomainsTldSpecificAtByDomainReferenceWithdraw endpoint
|
|
4325
|
+
*
|
|
4326
|
+
* Withdraw a nic.at domain
|
|
4327
|
+
*
|
|
4328
|
+
* @remarks
|
|
4329
|
+
* This type defines all possible response structures for the POST DomainsTldSpecificAtByDomainReferenceWithdraw endpoint.
|
|
4330
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
4331
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
4332
|
+
*
|
|
4333
|
+
|
|
4334
|
+
*
|
|
4335
|
+
* @path /v1/domains/tld-specific/at/{domain_reference}/withdraw
|
|
4336
|
+
*
|
|
4337
|
+
* @see {@link POST_DomainsTldSpecificAtByDomainReferenceWithdraw_Response_200} - 200 response type
|
|
4338
|
+
* @see {@link POST_DomainsTldSpecificAtByDomainReferenceWithdraw_Response_404} - 404 response type
|
|
4339
|
+
* @see {@link POST_DomainsTldSpecificAtByDomainReferenceWithdraw_Response_422} - 422 response type
|
|
4340
|
+
*
|
|
4341
|
+
|
|
4342
|
+
*/
|
|
4343
|
+
export type POST_DomainsTldSpecificAtByDomainReferenceWithdraw_Response = POST_DomainsTldSpecificAtByDomainReferenceWithdraw_Response_200 | POST_DomainsTldSpecificAtByDomainReferenceWithdraw_Response_404 | POST_DomainsTldSpecificAtByDomainReferenceWithdraw_Response_422;
|
|
4344
|
+
|
|
4345
|
+
/**
|
|
4346
|
+
* 200 response for POST DomainsTldSpecificAtByDomainReferenceWithdraw endpoint
|
|
4347
|
+
*
|
|
4348
|
+
* @remarks
|
|
4349
|
+
* This type defines the response structure for the 200 status code
|
|
4350
|
+
* of the POST DomainsTldSpecificAtByDomainReferenceWithdraw endpoint.
|
|
4351
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4352
|
+
*
|
|
4353
|
+
|
|
4354
|
+
*
|
|
4355
|
+
* @path /v1/domains/tld-specific/at/{domain_reference}/withdraw
|
|
4356
|
+
*
|
|
4357
|
+
* @see {@link POST_DomainsTldSpecificAtByDomainReferenceWithdraw_Response} - The main response type definition
|
|
4358
|
+
* @see {@link DomainWithdraw} - The actual schema type definition
|
|
4359
|
+
*/
|
|
4360
|
+
export type POST_DomainsTldSpecificAtByDomainReferenceWithdraw_Response_200 = DomainWithdraw
|
|
4361
|
+
|
|
4362
|
+
/**
|
|
4363
|
+
* 404 response for POST DomainsTldSpecificAtByDomainReferenceWithdraw endpoint
|
|
4364
|
+
*
|
|
4365
|
+
* @remarks
|
|
4366
|
+
* This type defines the response structure for the 404 status code
|
|
4367
|
+
* of the POST DomainsTldSpecificAtByDomainReferenceWithdraw endpoint.
|
|
4368
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4369
|
+
*
|
|
4370
|
+
|
|
4371
|
+
*
|
|
4372
|
+
* @path /v1/domains/tld-specific/at/{domain_reference}/withdraw
|
|
4373
|
+
*
|
|
4374
|
+
* @see {@link POST_DomainsTldSpecificAtByDomainReferenceWithdraw_Response} - The main response type definition
|
|
4375
|
+
* @see {@link Problem} - The actual schema type definition
|
|
4376
|
+
*/
|
|
4377
|
+
export type POST_DomainsTldSpecificAtByDomainReferenceWithdraw_Response_404 = Problem
|
|
4378
|
+
|
|
4379
|
+
/**
|
|
4380
|
+
* 422 response for POST DomainsTldSpecificAtByDomainReferenceWithdraw endpoint
|
|
4381
|
+
*
|
|
4382
|
+
* @remarks
|
|
4383
|
+
* This type defines the response structure for the 422 status code
|
|
4384
|
+
* of the POST DomainsTldSpecificAtByDomainReferenceWithdraw endpoint.
|
|
4385
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4386
|
+
*
|
|
4387
|
+
|
|
4388
|
+
*
|
|
4389
|
+
* @path /v1/domains/tld-specific/at/{domain_reference}/withdraw
|
|
4390
|
+
*
|
|
4391
|
+
* @see {@link POST_DomainsTldSpecificAtByDomainReferenceWithdraw_Response} - The main response type definition
|
|
4392
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
4393
|
+
*/
|
|
4394
|
+
export type POST_DomainsTldSpecificAtByDomainReferenceWithdraw_Response_422 = HTTPValidationError
|
|
4395
|
+
|
|
4396
|
+
/**
|
|
4397
|
+
* Response types for POST DomainsTldSpecificDeByDomainReferenceTransit endpoint
|
|
4398
|
+
*
|
|
4399
|
+
* Transit a DENIC domain
|
|
4400
|
+
*
|
|
4401
|
+
* @remarks
|
|
4402
|
+
* This type defines all possible response structures for the POST DomainsTldSpecificDeByDomainReferenceTransit endpoint.
|
|
4403
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
4404
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
4405
|
+
*
|
|
4406
|
+
|
|
4407
|
+
*
|
|
4408
|
+
* @path /v1/domains/tld-specific/de/{domain_reference}/transit
|
|
4409
|
+
*
|
|
4410
|
+
* @see {@link POST_DomainsTldSpecificDeByDomainReferenceTransit_Response_200} - 200 response type
|
|
4411
|
+
* @see {@link POST_DomainsTldSpecificDeByDomainReferenceTransit_Response_404} - 404 response type
|
|
4412
|
+
* @see {@link POST_DomainsTldSpecificDeByDomainReferenceTransit_Response_422} - 422 response type
|
|
4413
|
+
*
|
|
4414
|
+
|
|
4415
|
+
*/
|
|
4416
|
+
export type POST_DomainsTldSpecificDeByDomainReferenceTransit_Response = POST_DomainsTldSpecificDeByDomainReferenceTransit_Response_200 | POST_DomainsTldSpecificDeByDomainReferenceTransit_Response_404 | POST_DomainsTldSpecificDeByDomainReferenceTransit_Response_422;
|
|
4417
|
+
|
|
4418
|
+
/**
|
|
4419
|
+
* 200 response for POST DomainsTldSpecificDeByDomainReferenceTransit endpoint
|
|
4420
|
+
*
|
|
4421
|
+
* @remarks
|
|
4422
|
+
* This type defines the response structure for the 200 status code
|
|
4423
|
+
* of the POST DomainsTldSpecificDeByDomainReferenceTransit endpoint.
|
|
4424
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4425
|
+
*
|
|
4426
|
+
|
|
4427
|
+
*
|
|
4428
|
+
* @path /v1/domains/tld-specific/de/{domain_reference}/transit
|
|
4429
|
+
*
|
|
4430
|
+
* @see {@link POST_DomainsTldSpecificDeByDomainReferenceTransit_Response} - The main response type definition
|
|
4431
|
+
* @see {@link DomainTransit} - The actual schema type definition
|
|
4432
|
+
*/
|
|
4433
|
+
export type POST_DomainsTldSpecificDeByDomainReferenceTransit_Response_200 = DomainTransit
|
|
4434
|
+
|
|
4435
|
+
/**
|
|
4436
|
+
* 404 response for POST DomainsTldSpecificDeByDomainReferenceTransit endpoint
|
|
4437
|
+
*
|
|
4438
|
+
* @remarks
|
|
4439
|
+
* This type defines the response structure for the 404 status code
|
|
4440
|
+
* of the POST DomainsTldSpecificDeByDomainReferenceTransit endpoint.
|
|
4441
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4442
|
+
*
|
|
4443
|
+
|
|
4444
|
+
*
|
|
4445
|
+
* @path /v1/domains/tld-specific/de/{domain_reference}/transit
|
|
4446
|
+
*
|
|
4447
|
+
* @see {@link POST_DomainsTldSpecificDeByDomainReferenceTransit_Response} - The main response type definition
|
|
4448
|
+
* @see {@link Problem} - The actual schema type definition
|
|
4449
|
+
*/
|
|
4450
|
+
export type POST_DomainsTldSpecificDeByDomainReferenceTransit_Response_404 = Problem
|
|
4451
|
+
|
|
4452
|
+
/**
|
|
4453
|
+
* 422 response for POST DomainsTldSpecificDeByDomainReferenceTransit endpoint
|
|
4454
|
+
*
|
|
4455
|
+
* @remarks
|
|
4456
|
+
* This type defines the response structure for the 422 status code
|
|
4457
|
+
* of the POST DomainsTldSpecificDeByDomainReferenceTransit endpoint.
|
|
4458
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4459
|
+
*
|
|
4460
|
+
|
|
4461
|
+
*
|
|
4462
|
+
* @path /v1/domains/tld-specific/de/{domain_reference}/transit
|
|
4463
|
+
*
|
|
4464
|
+
* @see {@link POST_DomainsTldSpecificDeByDomainReferenceTransit_Response} - The main response type definition
|
|
4465
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
4466
|
+
*/
|
|
4467
|
+
export type POST_DomainsTldSpecificDeByDomainReferenceTransit_Response_422 = HTTPValidationError
|
|
4468
|
+
|
|
4323
4469
|
/**
|
|
4324
4470
|
* Response types for POST DomainsTransfer endpoint
|
|
4325
4471
|
*
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -1482,6 +1482,38 @@ export type DomainSummary = components['schemas']['DomainSummaryResponse'];
|
|
|
1482
1482
|
* @see {@link components} - The OpenAPI components schema definition
|
|
1483
1483
|
*/
|
|
1484
1484
|
export type DomainTransferIn = components['schemas']['DomainTransferIn'];
|
|
1485
|
+
/**
|
|
1486
|
+
* DomainTransitRequest
|
|
1487
|
+
*
|
|
1488
|
+
* @remarks
|
|
1489
|
+
* Type alias for the `DomainTransitRequest` OpenAPI schema.
|
|
1490
|
+
* This type represents domaintransitrequest data structures used in API requests and responses.
|
|
1491
|
+
*
|
|
1492
|
+
* @example
|
|
1493
|
+
* ```typescript
|
|
1494
|
+
* const response = await api.getDomainTransitRequest();
|
|
1495
|
+
* const item: DomainTransitRequest = response.results;
|
|
1496
|
+
* ```
|
|
1497
|
+
*
|
|
1498
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1499
|
+
*/
|
|
1500
|
+
export type DomainTransitRequest = components['schemas']['DomainTransitRequest'];
|
|
1501
|
+
/**
|
|
1502
|
+
* DomainTransitResponse
|
|
1503
|
+
*
|
|
1504
|
+
* @remarks
|
|
1505
|
+
* Type alias for the `DomainTransitResponse` OpenAPI schema.
|
|
1506
|
+
* This type represents domaintransitresponse data structures used in API requests and responses.
|
|
1507
|
+
*
|
|
1508
|
+
* @example
|
|
1509
|
+
* ```typescript
|
|
1510
|
+
* const response = await api.getDomainTransit();
|
|
1511
|
+
* const item: DomainTransit = response.results;
|
|
1512
|
+
* ```
|
|
1513
|
+
*
|
|
1514
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1515
|
+
*/
|
|
1516
|
+
export type DomainTransit = components['schemas']['DomainTransitResponse'];
|
|
1485
1517
|
/**
|
|
1486
1518
|
* DomainUpdate
|
|
1487
1519
|
*
|
|
@@ -1498,6 +1530,38 @@ export type DomainTransferIn = components['schemas']['DomainTransferIn'];
|
|
|
1498
1530
|
* @see {@link components} - The OpenAPI components schema definition
|
|
1499
1531
|
*/
|
|
1500
1532
|
export type DomainUpdate = components['schemas']['DomainUpdate'];
|
|
1533
|
+
/**
|
|
1534
|
+
* DomainWithdrawRequest
|
|
1535
|
+
*
|
|
1536
|
+
* @remarks
|
|
1537
|
+
* Type alias for the `DomainWithdrawRequest` OpenAPI schema.
|
|
1538
|
+
* This type represents domainwithdrawrequest data structures used in API requests and responses.
|
|
1539
|
+
*
|
|
1540
|
+
* @example
|
|
1541
|
+
* ```typescript
|
|
1542
|
+
* const response = await api.getDomainWithdrawRequest();
|
|
1543
|
+
* const item: DomainWithdrawRequest = response.results;
|
|
1544
|
+
* ```
|
|
1545
|
+
*
|
|
1546
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1547
|
+
*/
|
|
1548
|
+
export type DomainWithdrawRequest = components['schemas']['DomainWithdrawRequest'];
|
|
1549
|
+
/**
|
|
1550
|
+
* DomainWithdrawResponse
|
|
1551
|
+
*
|
|
1552
|
+
* @remarks
|
|
1553
|
+
* Type alias for the `DomainWithdrawResponse` OpenAPI schema.
|
|
1554
|
+
* This type represents domainwithdrawresponse data structures used in API requests and responses.
|
|
1555
|
+
*
|
|
1556
|
+
* @example
|
|
1557
|
+
* ```typescript
|
|
1558
|
+
* const response = await api.getDomainWithdraw();
|
|
1559
|
+
* const item: DomainWithdraw = response.results;
|
|
1560
|
+
* ```
|
|
1561
|
+
*
|
|
1562
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1563
|
+
*/
|
|
1564
|
+
export type DomainWithdraw = components['schemas']['DomainWithdrawResponse'];
|
|
1501
1565
|
/**
|
|
1502
1566
|
* DomainsExpiringSoon
|
|
1503
1567
|
*
|
package/src/openapi.yaml
CHANGED
|
@@ -2357,6 +2357,32 @@ components:
|
|
|
2357
2357
|
- auth_code
|
|
2358
2358
|
title: DomainTransferIn
|
|
2359
2359
|
type: object
|
|
2360
|
+
DomainTransitRequest:
|
|
2361
|
+
properties:
|
|
2362
|
+
disconnect:
|
|
2363
|
+
description: Disconnect the domain from current nameserver and update to
|
|
2364
|
+
DENIC nameserver
|
|
2365
|
+
title: Disconnect
|
|
2366
|
+
type: boolean
|
|
2367
|
+
required:
|
|
2368
|
+
- disconnect
|
|
2369
|
+
title: DomainTransitRequest
|
|
2370
|
+
type: object
|
|
2371
|
+
DomainTransitResponse:
|
|
2372
|
+
properties:
|
|
2373
|
+
name:
|
|
2374
|
+
description: The domain name that was transited
|
|
2375
|
+
title: Name
|
|
2376
|
+
type: string
|
|
2377
|
+
success:
|
|
2378
|
+
description: Whether the transit operation was successful
|
|
2379
|
+
title: Success
|
|
2380
|
+
type: boolean
|
|
2381
|
+
required:
|
|
2382
|
+
- name
|
|
2383
|
+
- success
|
|
2384
|
+
title: DomainTransitResponse
|
|
2385
|
+
type: object
|
|
2360
2386
|
DomainUpdate:
|
|
2361
2387
|
properties:
|
|
2362
2388
|
auth_code:
|
|
@@ -2401,6 +2427,33 @@ components:
|
|
|
2401
2427
|
title: Statuses
|
|
2402
2428
|
title: DomainUpdate
|
|
2403
2429
|
type: object
|
|
2430
|
+
DomainWithdrawRequest:
|
|
2431
|
+
properties:
|
|
2432
|
+
zone_delete:
|
|
2433
|
+
description: 'Informs the registry whether the zone for that domain has
|
|
2434
|
+
been already deleted - as took from the docs: "(...) the registrar informs
|
|
2435
|
+
the registry that he has stopped the nameservice for the specified domain"'
|
|
2436
|
+
title: Zone Delete
|
|
2437
|
+
type: boolean
|
|
2438
|
+
required:
|
|
2439
|
+
- zone_delete
|
|
2440
|
+
title: DomainWithdrawRequest
|
|
2441
|
+
type: object
|
|
2442
|
+
DomainWithdrawResponse:
|
|
2443
|
+
properties:
|
|
2444
|
+
name:
|
|
2445
|
+
description: The domain name that was withdrawn
|
|
2446
|
+
title: Name
|
|
2447
|
+
type: string
|
|
2448
|
+
success:
|
|
2449
|
+
description: Whether the withdraw operation was successful
|
|
2450
|
+
title: Success
|
|
2451
|
+
type: boolean
|
|
2452
|
+
required:
|
|
2453
|
+
- name
|
|
2454
|
+
- success
|
|
2455
|
+
title: DomainWithdrawResponse
|
|
2456
|
+
type: object
|
|
2404
2457
|
DomainsExpiringSoon:
|
|
2405
2458
|
properties:
|
|
2406
2459
|
next_30_days:
|
|
@@ -5548,7 +5601,7 @@ info:
|
|
|
5548
5601
|
'
|
|
5549
5602
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
5550
5603
|
title: OpusDNS API
|
|
5551
|
-
version: 2025-12-02-
|
|
5604
|
+
version: 2025-12-02-151638
|
|
5552
5605
|
x-logo:
|
|
5553
5606
|
altText: OpusDNS API Reference
|
|
5554
5607
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -8891,6 +8944,116 @@ paths:
|
|
|
8891
8944
|
summary: Get domain summary
|
|
8892
8945
|
tags:
|
|
8893
8946
|
- domain
|
|
8947
|
+
/v1/domains/tld-specific/at/{domain_reference}/withdraw:
|
|
8948
|
+
post:
|
|
8949
|
+
operationId: withdraw_domain_v1_domains_tld_specific_at__domain_reference__withdraw_post
|
|
8950
|
+
parameters:
|
|
8951
|
+
- in: path
|
|
8952
|
+
name: domain_reference
|
|
8953
|
+
required: true
|
|
8954
|
+
schema:
|
|
8955
|
+
anyOf:
|
|
8956
|
+
- examples:
|
|
8957
|
+
- domain_01h45ytscbebyvny4gc8cr8ma2
|
|
8958
|
+
format: typeid
|
|
8959
|
+
pattern: ^domain_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
8960
|
+
type: string
|
|
8961
|
+
x-typeid-prefix: domain
|
|
8962
|
+
- type: string
|
|
8963
|
+
title: Domain Reference
|
|
8964
|
+
requestBody:
|
|
8965
|
+
content:
|
|
8966
|
+
application/json:
|
|
8967
|
+
schema:
|
|
8968
|
+
$ref: '#/components/schemas/DomainWithdrawRequest'
|
|
8969
|
+
required: true
|
|
8970
|
+
responses:
|
|
8971
|
+
'200':
|
|
8972
|
+
content:
|
|
8973
|
+
application/json:
|
|
8974
|
+
schema:
|
|
8975
|
+
$ref: '#/components/schemas/DomainWithdrawResponse'
|
|
8976
|
+
description: Successful Response
|
|
8977
|
+
'404':
|
|
8978
|
+
content:
|
|
8979
|
+
application/problem+json:
|
|
8980
|
+
example:
|
|
8981
|
+
code: ERROR_DOMAIN_NOT_FOUND
|
|
8982
|
+
detail: Domain not found
|
|
8983
|
+
domain_name: Additional error context.
|
|
8984
|
+
status: 404
|
|
8985
|
+
title: Domain Management Error
|
|
8986
|
+
type: domain-not-found
|
|
8987
|
+
schema:
|
|
8988
|
+
$ref: '#/components/schemas/Problem'
|
|
8989
|
+
description: Not Found
|
|
8990
|
+
'422':
|
|
8991
|
+
content:
|
|
8992
|
+
application/problem+json:
|
|
8993
|
+
schema:
|
|
8994
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
8995
|
+
description: Validation Error
|
|
8996
|
+
security:
|
|
8997
|
+
- OAuth2PasswordBearer: []
|
|
8998
|
+
summary: Withdraw a nic.at domain
|
|
8999
|
+
tags:
|
|
9000
|
+
- domain
|
|
9001
|
+
- domain
|
|
9002
|
+
/v1/domains/tld-specific/de/{domain_reference}/transit:
|
|
9003
|
+
post:
|
|
9004
|
+
operationId: transit_domain_v1_domains_tld_specific_de__domain_reference__transit_post
|
|
9005
|
+
parameters:
|
|
9006
|
+
- in: path
|
|
9007
|
+
name: domain_reference
|
|
9008
|
+
required: true
|
|
9009
|
+
schema:
|
|
9010
|
+
anyOf:
|
|
9011
|
+
- examples:
|
|
9012
|
+
- domain_01h45ytscbebyvny4gc8cr8ma2
|
|
9013
|
+
format: typeid
|
|
9014
|
+
pattern: ^domain_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
9015
|
+
type: string
|
|
9016
|
+
x-typeid-prefix: domain
|
|
9017
|
+
- type: string
|
|
9018
|
+
title: Domain Reference
|
|
9019
|
+
requestBody:
|
|
9020
|
+
content:
|
|
9021
|
+
application/json:
|
|
9022
|
+
schema:
|
|
9023
|
+
$ref: '#/components/schemas/DomainTransitRequest'
|
|
9024
|
+
required: true
|
|
9025
|
+
responses:
|
|
9026
|
+
'200':
|
|
9027
|
+
content:
|
|
9028
|
+
application/json:
|
|
9029
|
+
schema:
|
|
9030
|
+
$ref: '#/components/schemas/DomainTransitResponse'
|
|
9031
|
+
description: Successful Response
|
|
9032
|
+
'404':
|
|
9033
|
+
content:
|
|
9034
|
+
application/problem+json:
|
|
9035
|
+
example:
|
|
9036
|
+
code: ERROR_DOMAIN_NOT_FOUND
|
|
9037
|
+
detail: Domain not found
|
|
9038
|
+
domain_name: Additional error context.
|
|
9039
|
+
status: 404
|
|
9040
|
+
title: Domain Management Error
|
|
9041
|
+
type: domain-not-found
|
|
9042
|
+
schema:
|
|
9043
|
+
$ref: '#/components/schemas/Problem'
|
|
9044
|
+
description: Not Found
|
|
9045
|
+
'422':
|
|
9046
|
+
content:
|
|
9047
|
+
application/problem+json:
|
|
9048
|
+
schema:
|
|
9049
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
9050
|
+
description: Validation Error
|
|
9051
|
+
security:
|
|
9052
|
+
- OAuth2PasswordBearer: []
|
|
9053
|
+
summary: Transit a DENIC domain
|
|
9054
|
+
tags:
|
|
9055
|
+
- domain
|
|
9056
|
+
- domain
|
|
8894
9057
|
/v1/domains/transfer:
|
|
8895
9058
|
post:
|
|
8896
9059
|
description: 'Start the transfer process for a domain <br>
|
package/src/schema.d.ts
CHANGED
|
@@ -587,6 +587,40 @@ export interface paths {
|
|
|
587
587
|
patch?: never;
|
|
588
588
|
trace?: never;
|
|
589
589
|
};
|
|
590
|
+
"/v1/domains/tld-specific/at/{domain_reference}/withdraw": {
|
|
591
|
+
parameters: {
|
|
592
|
+
query?: never;
|
|
593
|
+
header?: never;
|
|
594
|
+
path?: never;
|
|
595
|
+
cookie?: never;
|
|
596
|
+
};
|
|
597
|
+
get?: never;
|
|
598
|
+
put?: never;
|
|
599
|
+
/** Withdraw a nic.at domain */
|
|
600
|
+
post: operations["withdraw_domain_v1_domains_tld_specific_at__domain_reference__withdraw_post"];
|
|
601
|
+
delete?: never;
|
|
602
|
+
options?: never;
|
|
603
|
+
head?: never;
|
|
604
|
+
patch?: never;
|
|
605
|
+
trace?: never;
|
|
606
|
+
};
|
|
607
|
+
"/v1/domains/tld-specific/de/{domain_reference}/transit": {
|
|
608
|
+
parameters: {
|
|
609
|
+
query?: never;
|
|
610
|
+
header?: never;
|
|
611
|
+
path?: never;
|
|
612
|
+
cookie?: never;
|
|
613
|
+
};
|
|
614
|
+
get?: never;
|
|
615
|
+
put?: never;
|
|
616
|
+
/** Transit a DENIC domain */
|
|
617
|
+
post: operations["transit_domain_v1_domains_tld_specific_de__domain_reference__transit_post"];
|
|
618
|
+
delete?: never;
|
|
619
|
+
options?: never;
|
|
620
|
+
head?: never;
|
|
621
|
+
patch?: never;
|
|
622
|
+
trace?: never;
|
|
623
|
+
};
|
|
590
624
|
"/v1/domains/transfer": {
|
|
591
625
|
parameters: {
|
|
592
626
|
query?: never;
|
|
@@ -2947,6 +2981,27 @@ export interface components {
|
|
|
2947
2981
|
/** @description The renewal mode of the domain */
|
|
2948
2982
|
renewal_mode: components["schemas"]["RenewalMode"];
|
|
2949
2983
|
};
|
|
2984
|
+
/** DomainTransitRequest */
|
|
2985
|
+
DomainTransitRequest: {
|
|
2986
|
+
/**
|
|
2987
|
+
* Disconnect
|
|
2988
|
+
* @description Disconnect the domain from current nameserver and update to DENIC nameserver
|
|
2989
|
+
*/
|
|
2990
|
+
disconnect: boolean;
|
|
2991
|
+
};
|
|
2992
|
+
/** DomainTransitResponse */
|
|
2993
|
+
DomainTransitResponse: {
|
|
2994
|
+
/**
|
|
2995
|
+
* Name
|
|
2996
|
+
* @description The domain name that was transited
|
|
2997
|
+
*/
|
|
2998
|
+
name: string;
|
|
2999
|
+
/**
|
|
3000
|
+
* Success
|
|
3001
|
+
* @description Whether the transit operation was successful
|
|
3002
|
+
*/
|
|
3003
|
+
success: boolean;
|
|
3004
|
+
};
|
|
2950
3005
|
/** DomainUpdate */
|
|
2951
3006
|
DomainUpdate: {
|
|
2952
3007
|
/**
|
|
@@ -2978,6 +3033,27 @@ export interface components {
|
|
|
2978
3033
|
*/
|
|
2979
3034
|
statuses?: components["schemas"]["DomainClientStatus"][] | null;
|
|
2980
3035
|
};
|
|
3036
|
+
/** DomainWithdrawRequest */
|
|
3037
|
+
DomainWithdrawRequest: {
|
|
3038
|
+
/**
|
|
3039
|
+
* Zone Delete
|
|
3040
|
+
* @description Informs the registry whether the zone for that domain has been already deleted - as took from the docs: "(...) the registrar informs the registry that he has stopped the nameservice for the specified domain"
|
|
3041
|
+
*/
|
|
3042
|
+
zone_delete: boolean;
|
|
3043
|
+
};
|
|
3044
|
+
/** DomainWithdrawResponse */
|
|
3045
|
+
DomainWithdrawResponse: {
|
|
3046
|
+
/**
|
|
3047
|
+
* Name
|
|
3048
|
+
* @description The domain name that was withdrawn
|
|
3049
|
+
*/
|
|
3050
|
+
name: string;
|
|
3051
|
+
/**
|
|
3052
|
+
* Success
|
|
3053
|
+
* @description Whether the withdraw operation was successful
|
|
3054
|
+
*/
|
|
3055
|
+
success: boolean;
|
|
3056
|
+
};
|
|
2981
3057
|
/** DomainsExpiringSoon */
|
|
2982
3058
|
DomainsExpiringSoon: {
|
|
2983
3059
|
/**
|
|
@@ -7671,6 +7747,110 @@ export interface operations {
|
|
|
7671
7747
|
};
|
|
7672
7748
|
};
|
|
7673
7749
|
};
|
|
7750
|
+
withdraw_domain_v1_domains_tld_specific_at__domain_reference__withdraw_post: {
|
|
7751
|
+
parameters: {
|
|
7752
|
+
query?: never;
|
|
7753
|
+
header?: never;
|
|
7754
|
+
path: {
|
|
7755
|
+
domain_reference: TypeId<"domain"> | string;
|
|
7756
|
+
};
|
|
7757
|
+
cookie?: never;
|
|
7758
|
+
};
|
|
7759
|
+
requestBody: {
|
|
7760
|
+
content: {
|
|
7761
|
+
"application/json": components["schemas"]["DomainWithdrawRequest"];
|
|
7762
|
+
};
|
|
7763
|
+
};
|
|
7764
|
+
responses: {
|
|
7765
|
+
/** @description Successful Response */
|
|
7766
|
+
200: {
|
|
7767
|
+
headers: {
|
|
7768
|
+
[name: string]: unknown;
|
|
7769
|
+
};
|
|
7770
|
+
content: {
|
|
7771
|
+
"application/json": components["schemas"]["DomainWithdrawResponse"];
|
|
7772
|
+
};
|
|
7773
|
+
};
|
|
7774
|
+
/** @description Not Found */
|
|
7775
|
+
404: {
|
|
7776
|
+
headers: {
|
|
7777
|
+
[name: string]: unknown;
|
|
7778
|
+
};
|
|
7779
|
+
content: {
|
|
7780
|
+
/** @example {
|
|
7781
|
+
* "code": "ERROR_DOMAIN_NOT_FOUND",
|
|
7782
|
+
* "detail": "Domain not found",
|
|
7783
|
+
* "domain_name": "Additional error context.",
|
|
7784
|
+
* "status": 404,
|
|
7785
|
+
* "title": "Domain Management Error",
|
|
7786
|
+
* "type": "domain-not-found"
|
|
7787
|
+
* } */
|
|
7788
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
7789
|
+
};
|
|
7790
|
+
};
|
|
7791
|
+
/** @description Validation Error */
|
|
7792
|
+
422: {
|
|
7793
|
+
headers: {
|
|
7794
|
+
[name: string]: unknown;
|
|
7795
|
+
};
|
|
7796
|
+
content: {
|
|
7797
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
7798
|
+
};
|
|
7799
|
+
};
|
|
7800
|
+
};
|
|
7801
|
+
};
|
|
7802
|
+
transit_domain_v1_domains_tld_specific_de__domain_reference__transit_post: {
|
|
7803
|
+
parameters: {
|
|
7804
|
+
query?: never;
|
|
7805
|
+
header?: never;
|
|
7806
|
+
path: {
|
|
7807
|
+
domain_reference: TypeId<"domain"> | string;
|
|
7808
|
+
};
|
|
7809
|
+
cookie?: never;
|
|
7810
|
+
};
|
|
7811
|
+
requestBody: {
|
|
7812
|
+
content: {
|
|
7813
|
+
"application/json": components["schemas"]["DomainTransitRequest"];
|
|
7814
|
+
};
|
|
7815
|
+
};
|
|
7816
|
+
responses: {
|
|
7817
|
+
/** @description Successful Response */
|
|
7818
|
+
200: {
|
|
7819
|
+
headers: {
|
|
7820
|
+
[name: string]: unknown;
|
|
7821
|
+
};
|
|
7822
|
+
content: {
|
|
7823
|
+
"application/json": components["schemas"]["DomainTransitResponse"];
|
|
7824
|
+
};
|
|
7825
|
+
};
|
|
7826
|
+
/** @description Not Found */
|
|
7827
|
+
404: {
|
|
7828
|
+
headers: {
|
|
7829
|
+
[name: string]: unknown;
|
|
7830
|
+
};
|
|
7831
|
+
content: {
|
|
7832
|
+
/** @example {
|
|
7833
|
+
* "code": "ERROR_DOMAIN_NOT_FOUND",
|
|
7834
|
+
* "detail": "Domain not found",
|
|
7835
|
+
* "domain_name": "Additional error context.",
|
|
7836
|
+
* "status": 404,
|
|
7837
|
+
* "title": "Domain Management Error",
|
|
7838
|
+
* "type": "domain-not-found"
|
|
7839
|
+
* } */
|
|
7840
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
7841
|
+
};
|
|
7842
|
+
};
|
|
7843
|
+
/** @description Validation Error */
|
|
7844
|
+
422: {
|
|
7845
|
+
headers: {
|
|
7846
|
+
[name: string]: unknown;
|
|
7847
|
+
};
|
|
7848
|
+
content: {
|
|
7849
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
7850
|
+
};
|
|
7851
|
+
};
|
|
7852
|
+
};
|
|
7853
|
+
};
|
|
7674
7854
|
transfer_domain_v1_domains_transfer_post: {
|
|
7675
7855
|
parameters: {
|
|
7676
7856
|
query?: never;
|