@opusdns/api 0.110.0 → 0.112.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/constants.ts +2 -0
- package/src/helpers/keys.ts +105 -0
- package/src/helpers/requests.d.ts +38 -0
- package/src/helpers/responses.d.ts +74 -1
- package/src/helpers/schemas.d.ts +16 -0
- package/src/openapi.yaml +72 -1
- package/src/schema.d.ts +84 -1
package/package.json
CHANGED
package/src/helpers/constants.ts
CHANGED
|
@@ -2361,6 +2361,7 @@ export const PERMISSION = {
|
|
|
2361
2361
|
MANAGE_OPUSDNS_API_KEYS: "manage_opusdns_api_keys",
|
|
2362
2362
|
MANAGE_PRODUCTS: "manage_products",
|
|
2363
2363
|
MANAGE_RESELLER: "manage_reseller",
|
|
2364
|
+
MANAGE_SUB_ZONES: "manage_sub_zones",
|
|
2364
2365
|
MANAGE_USERS: "manage_users",
|
|
2365
2366
|
MANAGE_USER_RELATIONS: "manage_user_relations",
|
|
2366
2367
|
PLAN_MANAGER: "plan_manager",
|
|
@@ -2423,6 +2424,7 @@ export const PERMISSION_VALUES = [
|
|
|
2423
2424
|
'manage_opusdns_api_keys',
|
|
2424
2425
|
'manage_products',
|
|
2425
2426
|
'manage_reseller',
|
|
2427
|
+
'manage_sub_zones',
|
|
2426
2428
|
'manage_users',
|
|
2427
2429
|
'manage_user_relations',
|
|
2428
2430
|
'plan_manager',
|
package/src/helpers/keys.ts
CHANGED
|
@@ -141,6 +141,7 @@ import { PublicAuthRequestForm } from './schemas';
|
|
|
141
141
|
import { RdapBase } from './schemas';
|
|
142
142
|
import { RegistryLockBase } from './schemas';
|
|
143
143
|
import { RelationSet } from './schemas';
|
|
144
|
+
import { RequestAuthcode } from './schemas';
|
|
144
145
|
import { RequestHistory } from './schemas';
|
|
145
146
|
import { ReservedDomainsBase } from './schemas';
|
|
146
147
|
import { RgpOperations } from './schemas';
|
|
@@ -17284,6 +17285,110 @@ export const KEYS_RELATION_SET = [
|
|
|
17284
17285
|
KEY_RELATION_SET_RELATIONS,
|
|
17285
17286
|
] as const satisfies (keyof RelationSet)[];
|
|
17286
17287
|
|
|
17288
|
+
/**
|
|
17289
|
+
* Detail
|
|
17290
|
+
*
|
|
17291
|
+
* Additional information about the result in case of failure
|
|
17292
|
+
*
|
|
17293
|
+
*
|
|
17294
|
+
*
|
|
17295
|
+
* @remarks
|
|
17296
|
+
* This key constant provides type-safe access to the `detail` property of RequestAuthcode objects.
|
|
17297
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
17298
|
+
*
|
|
17299
|
+
* @example
|
|
17300
|
+
* ```typescript
|
|
17301
|
+
* // Direct property access
|
|
17302
|
+
* const value = requestauthcode[KEY_REQUEST_AUTHCODE_DETAIL];
|
|
17303
|
+
*
|
|
17304
|
+
* // Dynamic property access
|
|
17305
|
+
* const propertyName = KEY_REQUEST_AUTHCODE_DETAIL;
|
|
17306
|
+
* const value = requestauthcode[propertyName];
|
|
17307
|
+
* ```
|
|
17308
|
+
*
|
|
17309
|
+
* @see {@link RequestAuthcode} - The TypeScript type definition
|
|
17310
|
+
* @see {@link KEYS_REQUEST_AUTHCODE} - Array of all keys for this type
|
|
17311
|
+
*/
|
|
17312
|
+
export const KEY_REQUEST_AUTHCODE_DETAIL = 'detail' as keyof RequestAuthcode;
|
|
17313
|
+
/**
|
|
17314
|
+
* Name
|
|
17315
|
+
*
|
|
17316
|
+
* The domain name that had the auth code requested
|
|
17317
|
+
*
|
|
17318
|
+
* @type {string}
|
|
17319
|
+
*
|
|
17320
|
+
*
|
|
17321
|
+
* @remarks
|
|
17322
|
+
* This key constant provides type-safe access to the `name` property of RequestAuthcode objects.
|
|
17323
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
17324
|
+
*
|
|
17325
|
+
* @example
|
|
17326
|
+
* ```typescript
|
|
17327
|
+
* // Direct property access
|
|
17328
|
+
* const value = requestauthcode[KEY_REQUEST_AUTHCODE_NAME];
|
|
17329
|
+
*
|
|
17330
|
+
* // Dynamic property access
|
|
17331
|
+
* const propertyName = KEY_REQUEST_AUTHCODE_NAME;
|
|
17332
|
+
* const value = requestauthcode[propertyName];
|
|
17333
|
+
* ```
|
|
17334
|
+
*
|
|
17335
|
+
* @see {@link RequestAuthcode} - The TypeScript type definition
|
|
17336
|
+
* @see {@link KEYS_REQUEST_AUTHCODE} - Array of all keys for this type
|
|
17337
|
+
*/
|
|
17338
|
+
export const KEY_REQUEST_AUTHCODE_NAME = 'name' as keyof RequestAuthcode;
|
|
17339
|
+
/**
|
|
17340
|
+
* Success
|
|
17341
|
+
*
|
|
17342
|
+
* Whether the request had a successful result from DNS Belgium
|
|
17343
|
+
*
|
|
17344
|
+
* @type {boolean}
|
|
17345
|
+
*
|
|
17346
|
+
*
|
|
17347
|
+
* @remarks
|
|
17348
|
+
* This key constant provides type-safe access to the `success` property of RequestAuthcode objects.
|
|
17349
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
17350
|
+
*
|
|
17351
|
+
* @example
|
|
17352
|
+
* ```typescript
|
|
17353
|
+
* // Direct property access
|
|
17354
|
+
* const value = requestauthcode[KEY_REQUEST_AUTHCODE_SUCCESS];
|
|
17355
|
+
*
|
|
17356
|
+
* // Dynamic property access
|
|
17357
|
+
* const propertyName = KEY_REQUEST_AUTHCODE_SUCCESS;
|
|
17358
|
+
* const value = requestauthcode[propertyName];
|
|
17359
|
+
* ```
|
|
17360
|
+
*
|
|
17361
|
+
* @see {@link RequestAuthcode} - The TypeScript type definition
|
|
17362
|
+
* @see {@link KEYS_REQUEST_AUTHCODE} - Array of all keys for this type
|
|
17363
|
+
*/
|
|
17364
|
+
export const KEY_REQUEST_AUTHCODE_SUCCESS = 'success' as keyof RequestAuthcode;
|
|
17365
|
+
|
|
17366
|
+
/**
|
|
17367
|
+
* Array of all RequestAuthcode property keys
|
|
17368
|
+
*
|
|
17369
|
+
* @remarks
|
|
17370
|
+
* This constant provides a readonly array containing all valid property keys for RequestAuthcode objects.
|
|
17371
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
17372
|
+
*
|
|
17373
|
+
* @example
|
|
17374
|
+
* ```typescript
|
|
17375
|
+
* // Iterating through all keys
|
|
17376
|
+
* for (const key of KEYS_REQUEST_AUTHCODE) {
|
|
17377
|
+
* console.log(`Property: ${key}, Value: ${requestauthcode[key]}`);
|
|
17378
|
+
* }
|
|
17379
|
+
*
|
|
17380
|
+
* // Validation
|
|
17381
|
+
* const isValidKey = KEYS_REQUEST_AUTHCODE.includes(someKey);
|
|
17382
|
+
* ```
|
|
17383
|
+
*
|
|
17384
|
+
* @see {@link RequestAuthcode} - The TypeScript type definition
|
|
17385
|
+
*/
|
|
17386
|
+
export const KEYS_REQUEST_AUTHCODE = [
|
|
17387
|
+
KEY_REQUEST_AUTHCODE_DETAIL,
|
|
17388
|
+
KEY_REQUEST_AUTHCODE_NAME,
|
|
17389
|
+
KEY_REQUEST_AUTHCODE_SUCCESS,
|
|
17390
|
+
] as const satisfies (keyof RequestAuthcode)[];
|
|
17391
|
+
|
|
17287
17392
|
/**
|
|
17288
17393
|
* Client Ip
|
|
17289
17394
|
*
|
|
@@ -2458,6 +2458,44 @@ export type POST_DomainsTldSpecificAtDomainReferenceWithdraw_Request_Path = POST
|
|
|
2458
2458
|
*/
|
|
2459
2459
|
export type POST_DomainsTldSpecificAtDomainReferenceWithdraw_Request_Body = POST_DomainsTldSpecificAtDomainReferenceWithdraw_Request['requestBody'];
|
|
2460
2460
|
|
|
2461
|
+
/**
|
|
2462
|
+
* Request type for POST DomainsTldSpecificBeDomainReferenceAuthCodeRequest endpoint
|
|
2463
|
+
*
|
|
2464
|
+
* Requests your auth code directly from DNS Belgium (registry)
|
|
2465
|
+
*
|
|
2466
|
+
* @remarks
|
|
2467
|
+
* This type defines the complete request structure for the POST DomainsTldSpecificBeDomainReferenceAuthCodeRequest 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/be/{domain_reference}/auth_code/request
|
|
2475
|
+
*
|
|
2476
|
+
* @see {@link POST_DomainsTldSpecificBeDomainReferenceAuthCodeRequest_Request_Query} - Query parameters type
|
|
2477
|
+
* @see {@link POST_DomainsTldSpecificBeDomainReferenceAuthCodeRequest_Request_Path} - Path parameters type
|
|
2478
|
+
* @see {@link POST_DomainsTldSpecificBeDomainReferenceAuthCodeRequest_Request_Body} - Request body type
|
|
2479
|
+
*/
|
|
2480
|
+
export type POST_DomainsTldSpecificBeDomainReferenceAuthCodeRequest_Request = {
|
|
2481
|
+
parameters: {
|
|
2482
|
+
path: operations['request_auth_code_v1_domains_tld_specific_be__domain_reference__auth_code_request_post']['parameters']['path'];
|
|
2483
|
+
};
|
|
2484
|
+
}
|
|
2485
|
+
/**
|
|
2486
|
+
* Path parameters for POST /v1/domains/tld-specific/be/{domain_reference}/auth_code/request
|
|
2487
|
+
*
|
|
2488
|
+
* @remarks
|
|
2489
|
+
* This type defines the path parameters for the POST /v1/domains/tld-specific/be/{domain_reference}/auth_code/request endpoint.
|
|
2490
|
+
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
2491
|
+
*
|
|
2492
|
+
* @example
|
|
2493
|
+
* Use this type to ensure type safety for path parameters.
|
|
2494
|
+
*
|
|
2495
|
+
* @path /v1/domains/tld-specific/be/{domain_reference}/auth_code/request
|
|
2496
|
+
*/
|
|
2497
|
+
export type POST_DomainsTldSpecificBeDomainReferenceAuthCodeRequest_Request_Path = POST_DomainsTldSpecificBeDomainReferenceAuthCodeRequest_Request['parameters']['path'];
|
|
2498
|
+
|
|
2461
2499
|
/**
|
|
2462
2500
|
* Request type for POST DomainsTldSpecificDeDomainReferenceTransit endpoint
|
|
2463
2501
|
*
|
|
@@ -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, 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';
|
|
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, RequestAuthcode, 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
|
|
@@ -4431,6 +4431,79 @@ export type POST_DomainsTldSpecificAtByDomainReferenceWithdraw_Response_404 = Pr
|
|
|
4431
4431
|
*/
|
|
4432
4432
|
export type POST_DomainsTldSpecificAtByDomainReferenceWithdraw_Response_422 = HTTPValidationError
|
|
4433
4433
|
|
|
4434
|
+
/**
|
|
4435
|
+
* Response types for POST DomainsTldSpecificBeByDomainReferenceAuthCodeRequest endpoint
|
|
4436
|
+
*
|
|
4437
|
+
* Requests your auth code directly from DNS Belgium (registry)
|
|
4438
|
+
*
|
|
4439
|
+
* @remarks
|
|
4440
|
+
* This type defines all possible response structures for the POST DomainsTldSpecificBeByDomainReferenceAuthCodeRequest endpoint.
|
|
4441
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
4442
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
4443
|
+
*
|
|
4444
|
+
|
|
4445
|
+
*
|
|
4446
|
+
* @path /v1/domains/tld-specific/be/{domain_reference}/auth_code/request
|
|
4447
|
+
*
|
|
4448
|
+
* @see {@link POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_200} - 200 response type
|
|
4449
|
+
* @see {@link POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_404} - 404 response type
|
|
4450
|
+
* @see {@link POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_422} - 422 response type
|
|
4451
|
+
*
|
|
4452
|
+
|
|
4453
|
+
*/
|
|
4454
|
+
export type POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response = POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_200 | POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_404 | POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_422;
|
|
4455
|
+
|
|
4456
|
+
/**
|
|
4457
|
+
* 200 response for POST DomainsTldSpecificBeByDomainReferenceAuthCodeRequest endpoint
|
|
4458
|
+
*
|
|
4459
|
+
* @remarks
|
|
4460
|
+
* This type defines the response structure for the 200 status code
|
|
4461
|
+
* of the POST DomainsTldSpecificBeByDomainReferenceAuthCodeRequest endpoint.
|
|
4462
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4463
|
+
*
|
|
4464
|
+
|
|
4465
|
+
*
|
|
4466
|
+
* @path /v1/domains/tld-specific/be/{domain_reference}/auth_code/request
|
|
4467
|
+
*
|
|
4468
|
+
* @see {@link POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response} - The main response type definition
|
|
4469
|
+
* @see {@link RequestAuthcode} - The actual schema type definition
|
|
4470
|
+
*/
|
|
4471
|
+
export type POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_200 = RequestAuthcode
|
|
4472
|
+
|
|
4473
|
+
/**
|
|
4474
|
+
* 404 response for POST DomainsTldSpecificBeByDomainReferenceAuthCodeRequest endpoint
|
|
4475
|
+
*
|
|
4476
|
+
* @remarks
|
|
4477
|
+
* This type defines the response structure for the 404 status code
|
|
4478
|
+
* of the POST DomainsTldSpecificBeByDomainReferenceAuthCodeRequest endpoint.
|
|
4479
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4480
|
+
*
|
|
4481
|
+
|
|
4482
|
+
*
|
|
4483
|
+
* @path /v1/domains/tld-specific/be/{domain_reference}/auth_code/request
|
|
4484
|
+
*
|
|
4485
|
+
* @see {@link POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response} - The main response type definition
|
|
4486
|
+
* @see {@link Problem} - The actual schema type definition
|
|
4487
|
+
*/
|
|
4488
|
+
export type POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_404 = Problem
|
|
4489
|
+
|
|
4490
|
+
/**
|
|
4491
|
+
* 422 response for POST DomainsTldSpecificBeByDomainReferenceAuthCodeRequest endpoint
|
|
4492
|
+
*
|
|
4493
|
+
* @remarks
|
|
4494
|
+
* This type defines the response structure for the 422 status code
|
|
4495
|
+
* of the POST DomainsTldSpecificBeByDomainReferenceAuthCodeRequest endpoint.
|
|
4496
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4497
|
+
*
|
|
4498
|
+
|
|
4499
|
+
*
|
|
4500
|
+
* @path /v1/domains/tld-specific/be/{domain_reference}/auth_code/request
|
|
4501
|
+
*
|
|
4502
|
+
* @see {@link POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response} - The main response type definition
|
|
4503
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
4504
|
+
*/
|
|
4505
|
+
export type POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_422 = HTTPValidationError
|
|
4506
|
+
|
|
4434
4507
|
/**
|
|
4435
4508
|
* Response types for POST DomainsTldSpecificDeByDomainReferenceTransit endpoint
|
|
4436
4509
|
*
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -2943,6 +2943,22 @@ export type RelationSet = components['schemas']['RelationSet'];
|
|
|
2943
2943
|
* @see {@link components} - The OpenAPI components schema definition
|
|
2944
2944
|
*/
|
|
2945
2945
|
export type RenewalMode = components['schemas']['RenewalMode'];
|
|
2946
|
+
/**
|
|
2947
|
+
* RequestAuthcodeResponse
|
|
2948
|
+
*
|
|
2949
|
+
* @remarks
|
|
2950
|
+
* Type alias for the `RequestAuthcodeResponse` OpenAPI schema.
|
|
2951
|
+
* This type represents requestauthcoderesponse data structures used in API requests and responses.
|
|
2952
|
+
*
|
|
2953
|
+
* @example
|
|
2954
|
+
* ```typescript
|
|
2955
|
+
* const response = await api.getRequestAuthcode();
|
|
2956
|
+
* const item: RequestAuthcode = response.results;
|
|
2957
|
+
* ```
|
|
2958
|
+
*
|
|
2959
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2960
|
+
*/
|
|
2961
|
+
export type RequestAuthcode = components['schemas']['RequestAuthcodeResponse'];
|
|
2946
2962
|
/**
|
|
2947
2963
|
* RequestHistory
|
|
2948
2964
|
*
|
package/src/openapi.yaml
CHANGED
|
@@ -4227,6 +4227,7 @@ components:
|
|
|
4227
4227
|
- manage_opusdns_api_keys
|
|
4228
4228
|
- manage_products
|
|
4229
4229
|
- manage_reseller
|
|
4230
|
+
- manage_sub_zones
|
|
4230
4231
|
- manage_users
|
|
4231
4232
|
- manage_user_relations
|
|
4232
4233
|
- plan_manager
|
|
@@ -4503,6 +4504,27 @@ components:
|
|
|
4503
4504
|
- delete
|
|
4504
4505
|
title: RenewalMode
|
|
4505
4506
|
type: string
|
|
4507
|
+
RequestAuthcodeResponse:
|
|
4508
|
+
properties:
|
|
4509
|
+
detail:
|
|
4510
|
+
anyOf:
|
|
4511
|
+
- type: string
|
|
4512
|
+
- type: 'null'
|
|
4513
|
+
description: Additional information about the result in case of failure
|
|
4514
|
+
title: Detail
|
|
4515
|
+
name:
|
|
4516
|
+
description: The domain name that had the auth code requested
|
|
4517
|
+
title: Name
|
|
4518
|
+
type: string
|
|
4519
|
+
success:
|
|
4520
|
+
description: Whether the request had a successful result from DNS Belgium
|
|
4521
|
+
title: Success
|
|
4522
|
+
type: boolean
|
|
4523
|
+
required:
|
|
4524
|
+
- name
|
|
4525
|
+
- success
|
|
4526
|
+
title: RequestAuthcodeResponse
|
|
4527
|
+
type: object
|
|
4506
4528
|
RequestHistory:
|
|
4507
4529
|
properties:
|
|
4508
4530
|
client_ip:
|
|
@@ -5608,7 +5630,7 @@ info:
|
|
|
5608
5630
|
'
|
|
5609
5631
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
5610
5632
|
title: OpusDNS API
|
|
5611
|
-
version: 2025-12-04-
|
|
5633
|
+
version: 2025-12-04-181757
|
|
5612
5634
|
x-logo:
|
|
5613
5635
|
altText: OpusDNS API Reference
|
|
5614
5636
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -9468,6 +9490,55 @@ paths:
|
|
|
9468
9490
|
tags:
|
|
9469
9491
|
- domain
|
|
9470
9492
|
- domain_tld_specific
|
|
9493
|
+
/v1/domains/tld-specific/be/{domain_reference}/auth_code/request:
|
|
9494
|
+
post:
|
|
9495
|
+
operationId: request_auth_code_v1_domains_tld_specific_be__domain_reference__auth_code_request_post
|
|
9496
|
+
parameters:
|
|
9497
|
+
- in: path
|
|
9498
|
+
name: domain_reference
|
|
9499
|
+
required: true
|
|
9500
|
+
schema:
|
|
9501
|
+
anyOf:
|
|
9502
|
+
- examples:
|
|
9503
|
+
- domain_01h45ytscbebyvny4gc8cr8ma2
|
|
9504
|
+
format: typeid
|
|
9505
|
+
pattern: ^domain_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
9506
|
+
type: string
|
|
9507
|
+
x-typeid-prefix: domain
|
|
9508
|
+
- type: string
|
|
9509
|
+
title: Domain Reference
|
|
9510
|
+
responses:
|
|
9511
|
+
'200':
|
|
9512
|
+
content:
|
|
9513
|
+
application/json:
|
|
9514
|
+
schema:
|
|
9515
|
+
$ref: '#/components/schemas/RequestAuthcodeResponse'
|
|
9516
|
+
description: Successful Response
|
|
9517
|
+
'404':
|
|
9518
|
+
content:
|
|
9519
|
+
application/problem+json:
|
|
9520
|
+
example:
|
|
9521
|
+
code: ERROR_DOMAIN_NOT_FOUND
|
|
9522
|
+
detail: Domain not found
|
|
9523
|
+
domain_name: Additional error context.
|
|
9524
|
+
status: 404
|
|
9525
|
+
title: Domain Management Error
|
|
9526
|
+
type: domain-not-found
|
|
9527
|
+
schema:
|
|
9528
|
+
$ref: '#/components/schemas/Problem'
|
|
9529
|
+
description: Not Found
|
|
9530
|
+
'422':
|
|
9531
|
+
content:
|
|
9532
|
+
application/problem+json:
|
|
9533
|
+
schema:
|
|
9534
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
9535
|
+
description: Validation Error
|
|
9536
|
+
security:
|
|
9537
|
+
- OAuth2PasswordBearer: []
|
|
9538
|
+
summary: Requests your auth code directly from DNS Belgium (registry)
|
|
9539
|
+
tags:
|
|
9540
|
+
- domain
|
|
9541
|
+
- domain_tld_specific
|
|
9471
9542
|
/v1/domains/tld-specific/de/{domain_reference}/transit:
|
|
9472
9543
|
post:
|
|
9473
9544
|
operationId: transit_domain_v1_domains_tld_specific_de__domain_reference__transit_post
|
package/src/schema.d.ts
CHANGED
|
@@ -604,6 +604,23 @@ export interface paths {
|
|
|
604
604
|
patch?: never;
|
|
605
605
|
trace?: never;
|
|
606
606
|
};
|
|
607
|
+
"/v1/domains/tld-specific/be/{domain_reference}/auth_code/request": {
|
|
608
|
+
parameters: {
|
|
609
|
+
query?: never;
|
|
610
|
+
header?: never;
|
|
611
|
+
path?: never;
|
|
612
|
+
cookie?: never;
|
|
613
|
+
};
|
|
614
|
+
get?: never;
|
|
615
|
+
put?: never;
|
|
616
|
+
/** Requests your auth code directly from DNS Belgium (registry) */
|
|
617
|
+
post: operations["request_auth_code_v1_domains_tld_specific_be__domain_reference__auth_code_request_post"];
|
|
618
|
+
delete?: never;
|
|
619
|
+
options?: never;
|
|
620
|
+
head?: never;
|
|
621
|
+
patch?: never;
|
|
622
|
+
trace?: never;
|
|
623
|
+
};
|
|
607
624
|
"/v1/domains/tld-specific/de/{domain_reference}/transit": {
|
|
608
625
|
parameters: {
|
|
609
626
|
query?: never;
|
|
@@ -4193,7 +4210,7 @@ export interface components {
|
|
|
4193
4210
|
* Permission
|
|
4194
4211
|
* @enum {string}
|
|
4195
4212
|
*/
|
|
4196
|
-
Permission: "bulk_create" | "bulk_delete" | "bulk_renew_expire" | "bulk_transfer_trade" | "bulk_update" | "corporate_plan" | "create" | "delete" | "delete_domain_forwards" | "enterprise_plan" | "has_accepted_tos" | "manage_api_keys" | "manage_billing" | "manage_cms_content" | "manage_contacts" | "manage_dns_zones" | "manage_domains" | "manage_domain_forwards" | "manage_email_forwards" | "manage_events" | "manage_hosts" | "manage_opusdns_api_keys" | "manage_products" | "manage_reseller" | "manage_users" | "manage_user_relations" | "plan_manager" | "premium_plan" | "renew_expire" | "starter_plan" | "transfer_trade" | "update" | "update_domain_forwards" | "verify" | "view" | "view_audit_logs" | "view_domain_forwards" | "view_events";
|
|
4213
|
+
Permission: "bulk_create" | "bulk_delete" | "bulk_renew_expire" | "bulk_transfer_trade" | "bulk_update" | "corporate_plan" | "create" | "delete" | "delete_domain_forwards" | "enterprise_plan" | "has_accepted_tos" | "manage_api_keys" | "manage_billing" | "manage_cms_content" | "manage_contacts" | "manage_dns_zones" | "manage_domains" | "manage_domain_forwards" | "manage_email_forwards" | "manage_events" | "manage_hosts" | "manage_opusdns_api_keys" | "manage_products" | "manage_reseller" | "manage_sub_zones" | "manage_users" | "manage_user_relations" | "plan_manager" | "premium_plan" | "renew_expire" | "starter_plan" | "transfer_trade" | "update" | "update_domain_forwards" | "verify" | "view" | "view_audit_logs" | "view_domain_forwards" | "view_events";
|
|
4197
4214
|
/** PermissionSet */
|
|
4198
4215
|
PermissionSet: {
|
|
4199
4216
|
/** Permissions */
|
|
@@ -4352,6 +4369,24 @@ export interface components {
|
|
|
4352
4369
|
* @enum {string}
|
|
4353
4370
|
*/
|
|
4354
4371
|
RenewalMode: "renew" | "expire" | "delete";
|
|
4372
|
+
/** RequestAuthcodeResponse */
|
|
4373
|
+
RequestAuthcodeResponse: {
|
|
4374
|
+
/**
|
|
4375
|
+
* Detail
|
|
4376
|
+
* @description Additional information about the result in case of failure
|
|
4377
|
+
*/
|
|
4378
|
+
detail?: string | null;
|
|
4379
|
+
/**
|
|
4380
|
+
* Name
|
|
4381
|
+
* @description The domain name that had the auth code requested
|
|
4382
|
+
*/
|
|
4383
|
+
name: string;
|
|
4384
|
+
/**
|
|
4385
|
+
* Success
|
|
4386
|
+
* @description Whether the request had a successful result from DNS Belgium
|
|
4387
|
+
*/
|
|
4388
|
+
success: boolean;
|
|
4389
|
+
};
|
|
4355
4390
|
/** RequestHistory */
|
|
4356
4391
|
RequestHistory: {
|
|
4357
4392
|
/**
|
|
@@ -7836,6 +7871,54 @@ export interface operations {
|
|
|
7836
7871
|
};
|
|
7837
7872
|
};
|
|
7838
7873
|
};
|
|
7874
|
+
request_auth_code_v1_domains_tld_specific_be__domain_reference__auth_code_request_post: {
|
|
7875
|
+
parameters: {
|
|
7876
|
+
query?: never;
|
|
7877
|
+
header?: never;
|
|
7878
|
+
path: {
|
|
7879
|
+
domain_reference: TypeId<"domain"> | string;
|
|
7880
|
+
};
|
|
7881
|
+
cookie?: never;
|
|
7882
|
+
};
|
|
7883
|
+
requestBody?: never;
|
|
7884
|
+
responses: {
|
|
7885
|
+
/** @description Successful Response */
|
|
7886
|
+
200: {
|
|
7887
|
+
headers: {
|
|
7888
|
+
[name: string]: unknown;
|
|
7889
|
+
};
|
|
7890
|
+
content: {
|
|
7891
|
+
"application/json": components["schemas"]["RequestAuthcodeResponse"];
|
|
7892
|
+
};
|
|
7893
|
+
};
|
|
7894
|
+
/** @description Not Found */
|
|
7895
|
+
404: {
|
|
7896
|
+
headers: {
|
|
7897
|
+
[name: string]: unknown;
|
|
7898
|
+
};
|
|
7899
|
+
content: {
|
|
7900
|
+
/** @example {
|
|
7901
|
+
* "code": "ERROR_DOMAIN_NOT_FOUND",
|
|
7902
|
+
* "detail": "Domain not found",
|
|
7903
|
+
* "domain_name": "Additional error context.",
|
|
7904
|
+
* "status": 404,
|
|
7905
|
+
* "title": "Domain Management Error",
|
|
7906
|
+
* "type": "domain-not-found"
|
|
7907
|
+
* } */
|
|
7908
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
7909
|
+
};
|
|
7910
|
+
};
|
|
7911
|
+
/** @description Validation Error */
|
|
7912
|
+
422: {
|
|
7913
|
+
headers: {
|
|
7914
|
+
[name: string]: unknown;
|
|
7915
|
+
};
|
|
7916
|
+
content: {
|
|
7917
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
7918
|
+
};
|
|
7919
|
+
};
|
|
7920
|
+
};
|
|
7921
|
+
};
|
|
7839
7922
|
transit_domain_v1_domains_tld_specific_de__domain_reference__transit_post: {
|
|
7840
7923
|
parameters: {
|
|
7841
7924
|
query?: never;
|