@opusdns/api 0.104.0 → 0.105.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 +131 -0
- package/src/helpers/requests.d.ts +53 -1
- package/src/helpers/responses.d.ts +74 -1
- package/src/helpers/schemas.d.ts +32 -0
- package/src/openapi.yaml +82 -1
- package/src/schema.d.ts +90 -0
package/package.json
CHANGED
package/src/helpers/keys.ts
CHANGED
|
@@ -93,6 +93,8 @@ 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';
|
|
97
99
|
import { DomainsExpiringSoon } from './schemas';
|
|
98
100
|
import { EmailForwardAlias } from './schemas';
|
|
@@ -9742,6 +9744,135 @@ export const KEYS_DOMAIN_TRANSFER_IN = [
|
|
|
9742
9744
|
KEY_DOMAIN_TRANSFER_IN_RENEWAL_MODE,
|
|
9743
9745
|
] as const satisfies (keyof DomainTransferIn)[];
|
|
9744
9746
|
|
|
9747
|
+
/**
|
|
9748
|
+
* Disconnect
|
|
9749
|
+
*
|
|
9750
|
+
* Disconnect the domain from current nameserver and update to DENIC nameserver
|
|
9751
|
+
*
|
|
9752
|
+
* @type {boolean}
|
|
9753
|
+
*
|
|
9754
|
+
*
|
|
9755
|
+
* @remarks
|
|
9756
|
+
* This key constant provides type-safe access to the `disconnect` property of DomainTransitRequest objects.
|
|
9757
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
9758
|
+
*
|
|
9759
|
+
* @example
|
|
9760
|
+
* ```typescript
|
|
9761
|
+
* // Direct property access
|
|
9762
|
+
* const value = domaintransitrequest[KEY_DOMAIN_TRANSIT_REQUEST_DISCONNECT];
|
|
9763
|
+
*
|
|
9764
|
+
* // Dynamic property access
|
|
9765
|
+
* const propertyName = KEY_DOMAIN_TRANSIT_REQUEST_DISCONNECT;
|
|
9766
|
+
* const value = domaintransitrequest[propertyName];
|
|
9767
|
+
* ```
|
|
9768
|
+
*
|
|
9769
|
+
* @see {@link DomainTransitRequest} - The TypeScript type definition
|
|
9770
|
+
* @see {@link KEYS_DOMAIN_TRANSIT_REQUEST} - Array of all keys for this type
|
|
9771
|
+
*/
|
|
9772
|
+
export const KEY_DOMAIN_TRANSIT_REQUEST_DISCONNECT = 'disconnect' as keyof DomainTransitRequest;
|
|
9773
|
+
|
|
9774
|
+
/**
|
|
9775
|
+
* Array of all DomainTransitRequest property keys
|
|
9776
|
+
*
|
|
9777
|
+
* @remarks
|
|
9778
|
+
* This constant provides a readonly array containing all valid property keys for DomainTransitRequest objects.
|
|
9779
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
9780
|
+
*
|
|
9781
|
+
* @example
|
|
9782
|
+
* ```typescript
|
|
9783
|
+
* // Iterating through all keys
|
|
9784
|
+
* for (const key of KEYS_DOMAIN_TRANSIT_REQUEST) {
|
|
9785
|
+
* console.log(`Property: ${key}, Value: ${domaintransitrequest[key]}`);
|
|
9786
|
+
* }
|
|
9787
|
+
*
|
|
9788
|
+
* // Validation
|
|
9789
|
+
* const isValidKey = KEYS_DOMAIN_TRANSIT_REQUEST.includes(someKey);
|
|
9790
|
+
* ```
|
|
9791
|
+
*
|
|
9792
|
+
* @see {@link DomainTransitRequest} - The TypeScript type definition
|
|
9793
|
+
*/
|
|
9794
|
+
export const KEYS_DOMAIN_TRANSIT_REQUEST = [
|
|
9795
|
+
KEY_DOMAIN_TRANSIT_REQUEST_DISCONNECT,
|
|
9796
|
+
] as const satisfies (keyof DomainTransitRequest)[];
|
|
9797
|
+
|
|
9798
|
+
/**
|
|
9799
|
+
* Name
|
|
9800
|
+
*
|
|
9801
|
+
* The domain name that was transited
|
|
9802
|
+
*
|
|
9803
|
+
* @type {string}
|
|
9804
|
+
*
|
|
9805
|
+
*
|
|
9806
|
+
* @remarks
|
|
9807
|
+
* This key constant provides type-safe access to the `name` property of DomainTransit objects.
|
|
9808
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
9809
|
+
*
|
|
9810
|
+
* @example
|
|
9811
|
+
* ```typescript
|
|
9812
|
+
* // Direct property access
|
|
9813
|
+
* const value = domaintransit[KEY_DOMAIN_TRANSIT_NAME];
|
|
9814
|
+
*
|
|
9815
|
+
* // Dynamic property access
|
|
9816
|
+
* const propertyName = KEY_DOMAIN_TRANSIT_NAME;
|
|
9817
|
+
* const value = domaintransit[propertyName];
|
|
9818
|
+
* ```
|
|
9819
|
+
*
|
|
9820
|
+
* @see {@link DomainTransit} - The TypeScript type definition
|
|
9821
|
+
* @see {@link KEYS_DOMAIN_TRANSIT} - Array of all keys for this type
|
|
9822
|
+
*/
|
|
9823
|
+
export const KEY_DOMAIN_TRANSIT_NAME = 'name' as keyof DomainTransit;
|
|
9824
|
+
/**
|
|
9825
|
+
* Success
|
|
9826
|
+
*
|
|
9827
|
+
* Whether the transit operation was successful
|
|
9828
|
+
*
|
|
9829
|
+
* @type {boolean}
|
|
9830
|
+
*
|
|
9831
|
+
*
|
|
9832
|
+
* @remarks
|
|
9833
|
+
* This key constant provides type-safe access to the `success` property of DomainTransit objects.
|
|
9834
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
9835
|
+
*
|
|
9836
|
+
* @example
|
|
9837
|
+
* ```typescript
|
|
9838
|
+
* // Direct property access
|
|
9839
|
+
* const value = domaintransit[KEY_DOMAIN_TRANSIT_SUCCESS];
|
|
9840
|
+
*
|
|
9841
|
+
* // Dynamic property access
|
|
9842
|
+
* const propertyName = KEY_DOMAIN_TRANSIT_SUCCESS;
|
|
9843
|
+
* const value = domaintransit[propertyName];
|
|
9844
|
+
* ```
|
|
9845
|
+
*
|
|
9846
|
+
* @see {@link DomainTransit} - The TypeScript type definition
|
|
9847
|
+
* @see {@link KEYS_DOMAIN_TRANSIT} - Array of all keys for this type
|
|
9848
|
+
*/
|
|
9849
|
+
export const KEY_DOMAIN_TRANSIT_SUCCESS = 'success' as keyof DomainTransit;
|
|
9850
|
+
|
|
9851
|
+
/**
|
|
9852
|
+
* Array of all DomainTransit property keys
|
|
9853
|
+
*
|
|
9854
|
+
* @remarks
|
|
9855
|
+
* This constant provides a readonly array containing all valid property keys for DomainTransit objects.
|
|
9856
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
9857
|
+
*
|
|
9858
|
+
* @example
|
|
9859
|
+
* ```typescript
|
|
9860
|
+
* // Iterating through all keys
|
|
9861
|
+
* for (const key of KEYS_DOMAIN_TRANSIT) {
|
|
9862
|
+
* console.log(`Property: ${key}, Value: ${domaintransit[key]}`);
|
|
9863
|
+
* }
|
|
9864
|
+
*
|
|
9865
|
+
* // Validation
|
|
9866
|
+
* const isValidKey = KEYS_DOMAIN_TRANSIT.includes(someKey);
|
|
9867
|
+
* ```
|
|
9868
|
+
*
|
|
9869
|
+
* @see {@link DomainTransit} - The TypeScript type definition
|
|
9870
|
+
*/
|
|
9871
|
+
export const KEYS_DOMAIN_TRANSIT = [
|
|
9872
|
+
KEY_DOMAIN_TRANSIT_NAME,
|
|
9873
|
+
KEY_DOMAIN_TRANSIT_SUCCESS,
|
|
9874
|
+
] as const satisfies (keyof DomainTransit)[];
|
|
9875
|
+
|
|
9745
9876
|
/**
|
|
9746
9877
|
* Auth Code
|
|
9747
9878
|
*
|
|
@@ -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, 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,58 @@ 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 DomainsTldSpecificDeDomainReferenceTransit endpoint
|
|
2411
|
+
*
|
|
2412
|
+
* Transit a DENIC domain
|
|
2413
|
+
*
|
|
2414
|
+
* @remarks
|
|
2415
|
+
* This type defines the complete request structure for the POST DomainsTldSpecificDeDomainReferenceTransit 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/de/{domain_reference}/transit
|
|
2423
|
+
*
|
|
2424
|
+
* @see {@link POST_DomainsTldSpecificDeDomainReferenceTransit_Request_Query} - Query parameters type
|
|
2425
|
+
* @see {@link POST_DomainsTldSpecificDeDomainReferenceTransit_Request_Path} - Path parameters type
|
|
2426
|
+
* @see {@link POST_DomainsTldSpecificDeDomainReferenceTransit_Request_Body} - Request body type
|
|
2427
|
+
*/
|
|
2428
|
+
export type POST_DomainsTldSpecificDeDomainReferenceTransit_Request = {
|
|
2429
|
+
parameters: {
|
|
2430
|
+
path: operations['transit_domain_v1_domains_tld_specific_de__domain_reference__transit_post']['parameters']['path'];
|
|
2431
|
+
};
|
|
2432
|
+
requestBody: DomainTransitRequest;
|
|
2433
|
+
}
|
|
2434
|
+
/**
|
|
2435
|
+
* Path parameters for POST /v1/domains/tld-specific/de/{domain_reference}/transit
|
|
2436
|
+
*
|
|
2437
|
+
* @remarks
|
|
2438
|
+
* This type defines the path parameters for the POST /v1/domains/tld-specific/de/{domain_reference}/transit 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/de/{domain_reference}/transit
|
|
2445
|
+
*/
|
|
2446
|
+
export type POST_DomainsTldSpecificDeDomainReferenceTransit_Request_Path = POST_DomainsTldSpecificDeDomainReferenceTransit_Request['parameters']['path'];
|
|
2447
|
+
/**
|
|
2448
|
+
* Request body for POST /v1/domains/tld-specific/de/{domain_reference}/transit
|
|
2449
|
+
*
|
|
2450
|
+
* @remarks
|
|
2451
|
+
* This type defines the request body structure for the POST /v1/domains/tld-specific/de/{domain_reference}/transit 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/de/{domain_reference}/transit
|
|
2458
|
+
*/
|
|
2459
|
+
export type POST_DomainsTldSpecificDeDomainReferenceTransit_Request_Body = POST_DomainsTldSpecificDeDomainReferenceTransit_Request['requestBody'];
|
|
2460
|
+
|
|
2409
2461
|
/**
|
|
2410
2462
|
* Request type for POST DomainsTransfer endpoint
|
|
2411
2463
|
*
|
|
@@ -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, 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,79 @@ 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 DomainsTldSpecificDeByDomainReferenceTransit endpoint
|
|
4325
|
+
*
|
|
4326
|
+
* Transit a DENIC domain
|
|
4327
|
+
*
|
|
4328
|
+
* @remarks
|
|
4329
|
+
* This type defines all possible response structures for the POST DomainsTldSpecificDeByDomainReferenceTransit 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/de/{domain_reference}/transit
|
|
4336
|
+
*
|
|
4337
|
+
* @see {@link POST_DomainsTldSpecificDeByDomainReferenceTransit_Response_200} - 200 response type
|
|
4338
|
+
* @see {@link POST_DomainsTldSpecificDeByDomainReferenceTransit_Response_404} - 404 response type
|
|
4339
|
+
* @see {@link POST_DomainsTldSpecificDeByDomainReferenceTransit_Response_422} - 422 response type
|
|
4340
|
+
*
|
|
4341
|
+
|
|
4342
|
+
*/
|
|
4343
|
+
export type POST_DomainsTldSpecificDeByDomainReferenceTransit_Response = POST_DomainsTldSpecificDeByDomainReferenceTransit_Response_200 | POST_DomainsTldSpecificDeByDomainReferenceTransit_Response_404 | POST_DomainsTldSpecificDeByDomainReferenceTransit_Response_422;
|
|
4344
|
+
|
|
4345
|
+
/**
|
|
4346
|
+
* 200 response for POST DomainsTldSpecificDeByDomainReferenceTransit endpoint
|
|
4347
|
+
*
|
|
4348
|
+
* @remarks
|
|
4349
|
+
* This type defines the response structure for the 200 status code
|
|
4350
|
+
* of the POST DomainsTldSpecificDeByDomainReferenceTransit 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/de/{domain_reference}/transit
|
|
4356
|
+
*
|
|
4357
|
+
* @see {@link POST_DomainsTldSpecificDeByDomainReferenceTransit_Response} - The main response type definition
|
|
4358
|
+
* @see {@link DomainTransit} - The actual schema type definition
|
|
4359
|
+
*/
|
|
4360
|
+
export type POST_DomainsTldSpecificDeByDomainReferenceTransit_Response_200 = DomainTransit
|
|
4361
|
+
|
|
4362
|
+
/**
|
|
4363
|
+
* 404 response for POST DomainsTldSpecificDeByDomainReferenceTransit endpoint
|
|
4364
|
+
*
|
|
4365
|
+
* @remarks
|
|
4366
|
+
* This type defines the response structure for the 404 status code
|
|
4367
|
+
* of the POST DomainsTldSpecificDeByDomainReferenceTransit 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/de/{domain_reference}/transit
|
|
4373
|
+
*
|
|
4374
|
+
* @see {@link POST_DomainsTldSpecificDeByDomainReferenceTransit_Response} - The main response type definition
|
|
4375
|
+
* @see {@link Problem} - The actual schema type definition
|
|
4376
|
+
*/
|
|
4377
|
+
export type POST_DomainsTldSpecificDeByDomainReferenceTransit_Response_404 = Problem
|
|
4378
|
+
|
|
4379
|
+
/**
|
|
4380
|
+
* 422 response for POST DomainsTldSpecificDeByDomainReferenceTransit endpoint
|
|
4381
|
+
*
|
|
4382
|
+
* @remarks
|
|
4383
|
+
* This type defines the response structure for the 422 status code
|
|
4384
|
+
* of the POST DomainsTldSpecificDeByDomainReferenceTransit 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/de/{domain_reference}/transit
|
|
4390
|
+
*
|
|
4391
|
+
* @see {@link POST_DomainsTldSpecificDeByDomainReferenceTransit_Response} - The main response type definition
|
|
4392
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
4393
|
+
*/
|
|
4394
|
+
export type POST_DomainsTldSpecificDeByDomainReferenceTransit_Response_422 = HTTPValidationError
|
|
4395
|
+
|
|
4323
4396
|
/**
|
|
4324
4397
|
* Response types for POST DomainsTransfer endpoint
|
|
4325
4398
|
*
|
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
|
*
|
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:
|
|
@@ -5548,7 +5574,7 @@ info:
|
|
|
5548
5574
|
'
|
|
5549
5575
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
5550
5576
|
title: OpusDNS API
|
|
5551
|
-
version: 2025-12-02-
|
|
5577
|
+
version: 2025-12-02-150412
|
|
5552
5578
|
x-logo:
|
|
5553
5579
|
altText: OpusDNS API Reference
|
|
5554
5580
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -8891,6 +8917,61 @@ paths:
|
|
|
8891
8917
|
summary: Get domain summary
|
|
8892
8918
|
tags:
|
|
8893
8919
|
- domain
|
|
8920
|
+
/v1/domains/tld-specific/de/{domain_reference}/transit:
|
|
8921
|
+
post:
|
|
8922
|
+
operationId: transit_domain_v1_domains_tld_specific_de__domain_reference__transit_post
|
|
8923
|
+
parameters:
|
|
8924
|
+
- in: path
|
|
8925
|
+
name: domain_reference
|
|
8926
|
+
required: true
|
|
8927
|
+
schema:
|
|
8928
|
+
anyOf:
|
|
8929
|
+
- examples:
|
|
8930
|
+
- domain_01h45ytscbebyvny4gc8cr8ma2
|
|
8931
|
+
format: typeid
|
|
8932
|
+
pattern: ^domain_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
8933
|
+
type: string
|
|
8934
|
+
x-typeid-prefix: domain
|
|
8935
|
+
- type: string
|
|
8936
|
+
title: Domain Reference
|
|
8937
|
+
requestBody:
|
|
8938
|
+
content:
|
|
8939
|
+
application/json:
|
|
8940
|
+
schema:
|
|
8941
|
+
$ref: '#/components/schemas/DomainTransitRequest'
|
|
8942
|
+
required: true
|
|
8943
|
+
responses:
|
|
8944
|
+
'200':
|
|
8945
|
+
content:
|
|
8946
|
+
application/json:
|
|
8947
|
+
schema:
|
|
8948
|
+
$ref: '#/components/schemas/DomainTransitResponse'
|
|
8949
|
+
description: Successful Response
|
|
8950
|
+
'404':
|
|
8951
|
+
content:
|
|
8952
|
+
application/problem+json:
|
|
8953
|
+
example:
|
|
8954
|
+
code: ERROR_DOMAIN_NOT_FOUND
|
|
8955
|
+
detail: Domain not found
|
|
8956
|
+
domain_name: Additional error context.
|
|
8957
|
+
status: 404
|
|
8958
|
+
title: Domain Management Error
|
|
8959
|
+
type: domain-not-found
|
|
8960
|
+
schema:
|
|
8961
|
+
$ref: '#/components/schemas/Problem'
|
|
8962
|
+
description: Not Found
|
|
8963
|
+
'422':
|
|
8964
|
+
content:
|
|
8965
|
+
application/problem+json:
|
|
8966
|
+
schema:
|
|
8967
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
8968
|
+
description: Validation Error
|
|
8969
|
+
security:
|
|
8970
|
+
- OAuth2PasswordBearer: []
|
|
8971
|
+
summary: Transit a DENIC domain
|
|
8972
|
+
tags:
|
|
8973
|
+
- domain
|
|
8974
|
+
- domain
|
|
8894
8975
|
/v1/domains/transfer:
|
|
8895
8976
|
post:
|
|
8896
8977
|
description: 'Start the transfer process for a domain <br>
|
package/src/schema.d.ts
CHANGED
|
@@ -587,6 +587,23 @@ export interface paths {
|
|
|
587
587
|
patch?: never;
|
|
588
588
|
trace?: never;
|
|
589
589
|
};
|
|
590
|
+
"/v1/domains/tld-specific/de/{domain_reference}/transit": {
|
|
591
|
+
parameters: {
|
|
592
|
+
query?: never;
|
|
593
|
+
header?: never;
|
|
594
|
+
path?: never;
|
|
595
|
+
cookie?: never;
|
|
596
|
+
};
|
|
597
|
+
get?: never;
|
|
598
|
+
put?: never;
|
|
599
|
+
/** Transit a DENIC domain */
|
|
600
|
+
post: operations["transit_domain_v1_domains_tld_specific_de__domain_reference__transit_post"];
|
|
601
|
+
delete?: never;
|
|
602
|
+
options?: never;
|
|
603
|
+
head?: never;
|
|
604
|
+
patch?: never;
|
|
605
|
+
trace?: never;
|
|
606
|
+
};
|
|
590
607
|
"/v1/domains/transfer": {
|
|
591
608
|
parameters: {
|
|
592
609
|
query?: never;
|
|
@@ -2947,6 +2964,27 @@ export interface components {
|
|
|
2947
2964
|
/** @description The renewal mode of the domain */
|
|
2948
2965
|
renewal_mode: components["schemas"]["RenewalMode"];
|
|
2949
2966
|
};
|
|
2967
|
+
/** DomainTransitRequest */
|
|
2968
|
+
DomainTransitRequest: {
|
|
2969
|
+
/**
|
|
2970
|
+
* Disconnect
|
|
2971
|
+
* @description Disconnect the domain from current nameserver and update to DENIC nameserver
|
|
2972
|
+
*/
|
|
2973
|
+
disconnect: boolean;
|
|
2974
|
+
};
|
|
2975
|
+
/** DomainTransitResponse */
|
|
2976
|
+
DomainTransitResponse: {
|
|
2977
|
+
/**
|
|
2978
|
+
* Name
|
|
2979
|
+
* @description The domain name that was transited
|
|
2980
|
+
*/
|
|
2981
|
+
name: string;
|
|
2982
|
+
/**
|
|
2983
|
+
* Success
|
|
2984
|
+
* @description Whether the transit operation was successful
|
|
2985
|
+
*/
|
|
2986
|
+
success: boolean;
|
|
2987
|
+
};
|
|
2950
2988
|
/** DomainUpdate */
|
|
2951
2989
|
DomainUpdate: {
|
|
2952
2990
|
/**
|
|
@@ -7671,6 +7709,58 @@ export interface operations {
|
|
|
7671
7709
|
};
|
|
7672
7710
|
};
|
|
7673
7711
|
};
|
|
7712
|
+
transit_domain_v1_domains_tld_specific_de__domain_reference__transit_post: {
|
|
7713
|
+
parameters: {
|
|
7714
|
+
query?: never;
|
|
7715
|
+
header?: never;
|
|
7716
|
+
path: {
|
|
7717
|
+
domain_reference: TypeId<"domain"> | string;
|
|
7718
|
+
};
|
|
7719
|
+
cookie?: never;
|
|
7720
|
+
};
|
|
7721
|
+
requestBody: {
|
|
7722
|
+
content: {
|
|
7723
|
+
"application/json": components["schemas"]["DomainTransitRequest"];
|
|
7724
|
+
};
|
|
7725
|
+
};
|
|
7726
|
+
responses: {
|
|
7727
|
+
/** @description Successful Response */
|
|
7728
|
+
200: {
|
|
7729
|
+
headers: {
|
|
7730
|
+
[name: string]: unknown;
|
|
7731
|
+
};
|
|
7732
|
+
content: {
|
|
7733
|
+
"application/json": components["schemas"]["DomainTransitResponse"];
|
|
7734
|
+
};
|
|
7735
|
+
};
|
|
7736
|
+
/** @description Not Found */
|
|
7737
|
+
404: {
|
|
7738
|
+
headers: {
|
|
7739
|
+
[name: string]: unknown;
|
|
7740
|
+
};
|
|
7741
|
+
content: {
|
|
7742
|
+
/** @example {
|
|
7743
|
+
* "code": "ERROR_DOMAIN_NOT_FOUND",
|
|
7744
|
+
* "detail": "Domain not found",
|
|
7745
|
+
* "domain_name": "Additional error context.",
|
|
7746
|
+
* "status": 404,
|
|
7747
|
+
* "title": "Domain Management Error",
|
|
7748
|
+
* "type": "domain-not-found"
|
|
7749
|
+
* } */
|
|
7750
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
7751
|
+
};
|
|
7752
|
+
};
|
|
7753
|
+
/** @description Validation Error */
|
|
7754
|
+
422: {
|
|
7755
|
+
headers: {
|
|
7756
|
+
[name: string]: unknown;
|
|
7757
|
+
};
|
|
7758
|
+
content: {
|
|
7759
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
7760
|
+
};
|
|
7761
|
+
};
|
|
7762
|
+
};
|
|
7763
|
+
};
|
|
7674
7764
|
transfer_domain_v1_domains_transfer_post: {
|
|
7675
7765
|
parameters: {
|
|
7676
7766
|
query?: never;
|