@opusdns/api 0.105.0 → 0.107.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 CHANGED
@@ -3,7 +3,7 @@
3
3
  "@opusdns/api-spec-ts-generator": "^0.9.1"
4
4
  },
5
5
  "name": "@opusdns/api",
6
- "version": "0.105.0",
6
+ "version": "0.107.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -2738,6 +2738,7 @@ export const REGISTRANT_CHANGE_TYPE_VALUES = [
2738
2738
  export const REGISTRY_HANDLE_ATTRIBUTE_TYPE = {
2739
2739
  AT_EXT_CONTACT_TYPE: "at-ext-contact:type",
2740
2740
  DE_CONTACT_TYPE: "DE_CONTACT_TYPE",
2741
+ DNSBE_TYPE: "dnsbe:type",
2741
2742
  } as const satisfies Record<string, RegistryHandleAttributeType>;
2742
2743
 
2743
2744
  /**
@@ -2763,7 +2764,8 @@ export const REGISTRY_HANDLE_ATTRIBUTE_TYPE = {
2763
2764
  */
2764
2765
  export const REGISTRY_HANDLE_ATTRIBUTE_TYPE_VALUES = [
2765
2766
  'at-ext-contact:type',
2766
- 'DE_CONTACT_TYPE'
2767
+ 'DE_CONTACT_TYPE',
2768
+ 'dnsbe:type'
2767
2769
  ] as const satisfies [string, ...string[]] | RegistryHandleAttributeType[];
2768
2770
 
2769
2771
  /**
@@ -96,6 +96,8 @@ import { DomainTransferIn } from './schemas';
96
96
  import { DomainTransitRequest } from './schemas';
97
97
  import { DomainTransit } from './schemas';
98
98
  import { DomainUpdate } from './schemas';
99
+ import { DomainWithdrawRequest } from './schemas';
100
+ import { DomainWithdraw } from './schemas';
99
101
  import { DomainsExpiringSoon } from './schemas';
100
102
  import { EmailForwardAlias } from './schemas';
101
103
  import { EmailForwardAliasUpdate } from './schemas';
@@ -10027,6 +10029,135 @@ export const KEYS_DOMAIN_UPDATE = [
10027
10029
  KEY_DOMAIN_UPDATE_STATUSES,
10028
10030
  ] as const satisfies (keyof DomainUpdate)[];
10029
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
+
10030
10161
  /**
10031
10162
  * Next 30 Days
10032
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, DomainTransitRequest, 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,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 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
+
2409
2461
  /**
2410
2462
  * Request type for POST DomainsTldSpecificDeDomainReferenceTransit 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, 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, 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 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
+
4323
4396
  /**
4324
4397
  * Response types for POST DomainsTldSpecificDeByDomainReferenceTransit endpoint
4325
4398
  *
@@ -1530,6 +1530,38 @@ export type DomainTransit = components['schemas']['DomainTransitResponse'];
1530
1530
  * @see {@link components} - The OpenAPI components schema definition
1531
1531
  */
1532
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'];
1533
1565
  /**
1534
1566
  * DomainsExpiringSoon
1535
1567
  *
package/src/openapi.yaml CHANGED
@@ -2427,6 +2427,33 @@ components:
2427
2427
  title: Statuses
2428
2428
  title: DomainUpdate
2429
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
2430
2457
  DomainsExpiringSoon:
2431
2458
  properties:
2432
2459
  next_30_days:
@@ -4396,6 +4423,7 @@ components:
4396
4423
  enum:
4397
4424
  - at-ext-contact:type
4398
4425
  - DE_CONTACT_TYPE
4426
+ - dnsbe:type
4399
4427
  title: RegistryHandleAttributeType
4400
4428
  type: string
4401
4429
  RegistryLockBase:
@@ -5574,7 +5602,7 @@ info:
5574
5602
  '
5575
5603
  summary: OpusDNS - your gateway to a seamless domain management experience.
5576
5604
  title: OpusDNS API
5577
- version: 2025-12-02-150412
5605
+ version: 2025-12-02-180143
5578
5606
  x-logo:
5579
5607
  altText: OpusDNS API Reference
5580
5608
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -8917,6 +8945,61 @@ paths:
8917
8945
  summary: Get domain summary
8918
8946
  tags:
8919
8947
  - domain
8948
+ /v1/domains/tld-specific/at/{domain_reference}/withdraw:
8949
+ post:
8950
+ operationId: withdraw_domain_v1_domains_tld_specific_at__domain_reference__withdraw_post
8951
+ parameters:
8952
+ - in: path
8953
+ name: domain_reference
8954
+ required: true
8955
+ schema:
8956
+ anyOf:
8957
+ - examples:
8958
+ - domain_01h45ytscbebyvny4gc8cr8ma2
8959
+ format: typeid
8960
+ pattern: ^domain_[0-7][0-9a-hjkmnpq-tv-z]{25}$
8961
+ type: string
8962
+ x-typeid-prefix: domain
8963
+ - type: string
8964
+ title: Domain Reference
8965
+ requestBody:
8966
+ content:
8967
+ application/json:
8968
+ schema:
8969
+ $ref: '#/components/schemas/DomainWithdrawRequest'
8970
+ required: true
8971
+ responses:
8972
+ '200':
8973
+ content:
8974
+ application/json:
8975
+ schema:
8976
+ $ref: '#/components/schemas/DomainWithdrawResponse'
8977
+ description: Successful Response
8978
+ '404':
8979
+ content:
8980
+ application/problem+json:
8981
+ example:
8982
+ code: ERROR_DOMAIN_NOT_FOUND
8983
+ detail: Domain not found
8984
+ domain_name: Additional error context.
8985
+ status: 404
8986
+ title: Domain Management Error
8987
+ type: domain-not-found
8988
+ schema:
8989
+ $ref: '#/components/schemas/Problem'
8990
+ description: Not Found
8991
+ '422':
8992
+ content:
8993
+ application/problem+json:
8994
+ schema:
8995
+ $ref: '#/components/schemas/HTTPValidationError'
8996
+ description: Validation Error
8997
+ security:
8998
+ - OAuth2PasswordBearer: []
8999
+ summary: Withdraw a nic.at domain
9000
+ tags:
9001
+ - domain
9002
+ - domain
8920
9003
  /v1/domains/tld-specific/de/{domain_reference}/transit:
8921
9004
  post:
8922
9005
  operationId: transit_domain_v1_domains_tld_specific_de__domain_reference__transit_post
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/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
+ };
590
607
  "/v1/domains/tld-specific/de/{domain_reference}/transit": {
591
608
  parameters: {
592
609
  query?: never;
@@ -3016,6 +3033,27 @@ export interface components {
3016
3033
  */
3017
3034
  statuses?: components["schemas"]["DomainClientStatus"][] | null;
3018
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
+ };
3019
3057
  /** DomainsExpiringSoon */
3020
3058
  DomainsExpiringSoon: {
3021
3059
  /**
@@ -4270,7 +4308,7 @@ export interface components {
4270
4308
  * @description Registry handle attribute types for type-safe attribute key access.
4271
4309
  * @enum {string}
4272
4310
  */
4273
- RegistryHandleAttributeType: "at-ext-contact:type" | "DE_CONTACT_TYPE";
4311
+ RegistryHandleAttributeType: "at-ext-contact:type" | "DE_CONTACT_TYPE" | "dnsbe:type";
4274
4312
  /** RegistryLockBase */
4275
4313
  RegistryLockBase: {
4276
4314
  /**
@@ -7709,6 +7747,58 @@ export interface operations {
7709
7747
  };
7710
7748
  };
7711
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
+ };
7712
7802
  transit_domain_v1_domains_tld_specific_de__domain_reference__transit_post: {
7713
7803
  parameters: {
7714
7804
  query?: never;