@opusdns/api 1.107.0 → 1.109.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": "^1.2.0"
4
4
  },
5
5
  "name": "@opusdns/api",
6
- "version": "1.107.0",
6
+ "version": "1.109.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -440,6 +440,8 @@ import type {
440
440
  RequestAuthcode3,
441
441
  RequestAuthcode4,
442
442
  RequestAuthcode5,
443
+ RequestAuthcode6,
444
+ RequestAuthcode7,
443
445
  DomainAvailabilityList,
444
446
  DomainAvailabilityCheck,
445
447
  } from './schemas';
@@ -5906,29 +5908,27 @@ export const KEYS_REQUEST_AUTHCODE = [
5906
5908
  KEY_REQUEST_AUTHCODE_SUCCESS,
5907
5909
  ] as const satisfies (keyof RequestAuthcode)[];
5908
5910
 
5911
+ export const KEY_REQUEST_AUTHCODE2_AUTH_CODE = 'auth_code' satisfies keyof RequestAuthcode2;
5909
5912
  export const KEY_REQUEST_AUTHCODE2_DETAIL = 'detail' satisfies keyof RequestAuthcode2;
5910
5913
  export const KEY_REQUEST_AUTHCODE2_NAME = 'name' satisfies keyof RequestAuthcode2;
5911
- export const KEY_REQUEST_AUTHCODE2_RECIPIENTS = 'recipients' satisfies keyof RequestAuthcode2;
5912
5914
  export const KEY_REQUEST_AUTHCODE2_SUCCESS = 'success' satisfies keyof RequestAuthcode2;
5913
5915
 
5914
5916
  export const KEYS_REQUEST_AUTHCODE2 = [
5917
+ KEY_REQUEST_AUTHCODE2_AUTH_CODE,
5915
5918
  KEY_REQUEST_AUTHCODE2_DETAIL,
5916
5919
  KEY_REQUEST_AUTHCODE2_NAME,
5917
- KEY_REQUEST_AUTHCODE2_RECIPIENTS,
5918
5920
  KEY_REQUEST_AUTHCODE2_SUCCESS,
5919
5921
  ] as const satisfies (keyof RequestAuthcode2)[];
5920
5922
 
5921
- export const KEY_REQUEST_AUTHCODE3_AUTH_CODE = 'auth_code' satisfies keyof RequestAuthcode3;
5922
- export const KEY_REQUEST_AUTHCODE3_AUTH_CODE_EXPIRES_ON = 'auth_code_expires_on' satisfies keyof RequestAuthcode3;
5923
5923
  export const KEY_REQUEST_AUTHCODE3_DETAIL = 'detail' satisfies keyof RequestAuthcode3;
5924
5924
  export const KEY_REQUEST_AUTHCODE3_NAME = 'name' satisfies keyof RequestAuthcode3;
5925
+ export const KEY_REQUEST_AUTHCODE3_RECIPIENTS = 'recipients' satisfies keyof RequestAuthcode3;
5925
5926
  export const KEY_REQUEST_AUTHCODE3_SUCCESS = 'success' satisfies keyof RequestAuthcode3;
5926
5927
 
5927
5928
  export const KEYS_REQUEST_AUTHCODE3 = [
5928
- KEY_REQUEST_AUTHCODE3_AUTH_CODE,
5929
- KEY_REQUEST_AUTHCODE3_AUTH_CODE_EXPIRES_ON,
5930
5929
  KEY_REQUEST_AUTHCODE3_DETAIL,
5931
5930
  KEY_REQUEST_AUTHCODE3_NAME,
5931
+ KEY_REQUEST_AUTHCODE3_RECIPIENTS,
5932
5932
  KEY_REQUEST_AUTHCODE3_SUCCESS,
5933
5933
  ] as const satisfies (keyof RequestAuthcode3)[];
5934
5934
 
@@ -5947,17 +5947,43 @@ export const KEYS_REQUEST_AUTHCODE4 = [
5947
5947
  ] as const satisfies (keyof RequestAuthcode4)[];
5948
5948
 
5949
5949
  export const KEY_REQUEST_AUTHCODE5_AUTH_CODE = 'auth_code' satisfies keyof RequestAuthcode5;
5950
+ export const KEY_REQUEST_AUTHCODE5_AUTH_CODE_EXPIRES_ON = 'auth_code_expires_on' satisfies keyof RequestAuthcode5;
5950
5951
  export const KEY_REQUEST_AUTHCODE5_DETAIL = 'detail' satisfies keyof RequestAuthcode5;
5951
5952
  export const KEY_REQUEST_AUTHCODE5_NAME = 'name' satisfies keyof RequestAuthcode5;
5952
5953
  export const KEY_REQUEST_AUTHCODE5_SUCCESS = 'success' satisfies keyof RequestAuthcode5;
5953
5954
 
5954
5955
  export const KEYS_REQUEST_AUTHCODE5 = [
5955
5956
  KEY_REQUEST_AUTHCODE5_AUTH_CODE,
5957
+ KEY_REQUEST_AUTHCODE5_AUTH_CODE_EXPIRES_ON,
5956
5958
  KEY_REQUEST_AUTHCODE5_DETAIL,
5957
5959
  KEY_REQUEST_AUTHCODE5_NAME,
5958
5960
  KEY_REQUEST_AUTHCODE5_SUCCESS,
5959
5961
  ] as const satisfies (keyof RequestAuthcode5)[];
5960
5962
 
5963
+ export const KEY_REQUEST_AUTHCODE6_AUTH_CODE = 'auth_code' satisfies keyof RequestAuthcode6;
5964
+ export const KEY_REQUEST_AUTHCODE6_DETAIL = 'detail' satisfies keyof RequestAuthcode6;
5965
+ export const KEY_REQUEST_AUTHCODE6_NAME = 'name' satisfies keyof RequestAuthcode6;
5966
+ export const KEY_REQUEST_AUTHCODE6_SUCCESS = 'success' satisfies keyof RequestAuthcode6;
5967
+
5968
+ export const KEYS_REQUEST_AUTHCODE6 = [
5969
+ KEY_REQUEST_AUTHCODE6_AUTH_CODE,
5970
+ KEY_REQUEST_AUTHCODE6_DETAIL,
5971
+ KEY_REQUEST_AUTHCODE6_NAME,
5972
+ KEY_REQUEST_AUTHCODE6_SUCCESS,
5973
+ ] as const satisfies (keyof RequestAuthcode6)[];
5974
+
5975
+ export const KEY_REQUEST_AUTHCODE7_AUTH_CODE = 'auth_code' satisfies keyof RequestAuthcode7;
5976
+ export const KEY_REQUEST_AUTHCODE7_DETAIL = 'detail' satisfies keyof RequestAuthcode7;
5977
+ export const KEY_REQUEST_AUTHCODE7_NAME = 'name' satisfies keyof RequestAuthcode7;
5978
+ export const KEY_REQUEST_AUTHCODE7_SUCCESS = 'success' satisfies keyof RequestAuthcode7;
5979
+
5980
+ export const KEYS_REQUEST_AUTHCODE7 = [
5981
+ KEY_REQUEST_AUTHCODE7_AUTH_CODE,
5982
+ KEY_REQUEST_AUTHCODE7_DETAIL,
5983
+ KEY_REQUEST_AUTHCODE7_NAME,
5984
+ KEY_REQUEST_AUTHCODE7_SUCCESS,
5985
+ ] as const satisfies (keyof RequestAuthcode7)[];
5986
+
5961
5987
  export const KEY_DOMAIN_AVAILABILITY_LIST_META = 'meta' satisfies keyof DomainAvailabilityList;
5962
5988
  export const KEY_DOMAIN_AVAILABILITY_LIST_RESULTS = 'results' satisfies keyof DomainAvailabilityList;
5963
5989
 
@@ -592,6 +592,11 @@ export type POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Request =
592
592
  };
593
593
  export type POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Request_Path = POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Request['parameters']['path'];
594
594
 
595
+ export type POST_DomainsTldSpecificCymruByDomainReferenceAuthCodeRequest_Request = {
596
+ parameters: operations['request_auth_code_v1_domains_tld_specific_cymru__domain_reference__auth_code_request_post']['parameters'];
597
+ };
598
+ export type POST_DomainsTldSpecificCymruByDomainReferenceAuthCodeRequest_Request_Path = POST_DomainsTldSpecificCymruByDomainReferenceAuthCodeRequest_Request['parameters']['path'];
599
+
595
600
  export type POST_DomainsTldSpecificCzByDomainReferenceAuthCodeRequest_Request = {
596
601
  parameters: operations['request_auth_code_v1_domains_tld_specific_cz__domain_reference__auth_code_request_post']['parameters'];
597
602
  };
@@ -643,6 +648,11 @@ export type POST_DomainsTldSpecificSeByDomainReferenceAuthCodeRequest_Request =
643
648
  };
644
649
  export type POST_DomainsTldSpecificSeByDomainReferenceAuthCodeRequest_Request_Path = POST_DomainsTldSpecificSeByDomainReferenceAuthCodeRequest_Request['parameters']['path'];
645
650
 
651
+ export type POST_DomainsTldSpecificWalesByDomainReferenceAuthCodeRequest_Request = {
652
+ parameters: operations['request_auth_code_v1_domains_tld_specific_wales__domain_reference__auth_code_request_post']['parameters'];
653
+ };
654
+ export type POST_DomainsTldSpecificWalesByDomainReferenceAuthCodeRequest_Request_Path = POST_DomainsTldSpecificWalesByDomainReferenceAuthCodeRequest_Request['parameters']['path'];
655
+
646
656
  export type POST_DomainsTransfer_Request = {
647
657
  requestBody: DomainTransferIn;
648
658
  };
@@ -102,6 +102,8 @@ import type {
102
102
  RequestAuthcode3,
103
103
  RequestAuthcode4,
104
104
  RequestAuthcode5,
105
+ RequestAuthcode6,
106
+ RequestAuthcode7,
105
107
  SetVanityNameserverSetDefaultRes,
106
108
  Tag,
107
109
  TldResponseShort,
@@ -1177,9 +1179,16 @@ export type POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_4
1177
1179
  export type POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_404 = Problem;
1178
1180
  export type POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_422 = HTTPValidationError;
1179
1181
 
1182
+ export type POST_DomainsTldSpecificCymruByDomainReferenceAuthCodeRequest_Response = POST_DomainsTldSpecificCymruByDomainReferenceAuthCodeRequest_Response_200 | POST_DomainsTldSpecificCymruByDomainReferenceAuthCodeRequest_Response_400 | POST_DomainsTldSpecificCymruByDomainReferenceAuthCodeRequest_Response_404 | POST_DomainsTldSpecificCymruByDomainReferenceAuthCodeRequest_Response_422;
1183
+
1184
+ export type POST_DomainsTldSpecificCymruByDomainReferenceAuthCodeRequest_Response_200 = RequestAuthcode2;
1185
+ export type POST_DomainsTldSpecificCymruByDomainReferenceAuthCodeRequest_Response_400 = Problem;
1186
+ export type POST_DomainsTldSpecificCymruByDomainReferenceAuthCodeRequest_Response_404 = Problem;
1187
+ export type POST_DomainsTldSpecificCymruByDomainReferenceAuthCodeRequest_Response_422 = HTTPValidationError;
1188
+
1180
1189
  export type POST_DomainsTldSpecificCzByDomainReferenceAuthCodeRequest_Response = POST_DomainsTldSpecificCzByDomainReferenceAuthCodeRequest_Response_200 | POST_DomainsTldSpecificCzByDomainReferenceAuthCodeRequest_Response_400 | POST_DomainsTldSpecificCzByDomainReferenceAuthCodeRequest_Response_404 | POST_DomainsTldSpecificCzByDomainReferenceAuthCodeRequest_Response_422;
1181
1190
 
1182
- export type POST_DomainsTldSpecificCzByDomainReferenceAuthCodeRequest_Response_200 = RequestAuthcode2;
1191
+ export type POST_DomainsTldSpecificCzByDomainReferenceAuthCodeRequest_Response_200 = RequestAuthcode3;
1183
1192
  export type POST_DomainsTldSpecificCzByDomainReferenceAuthCodeRequest_Response_400 = Problem;
1184
1193
  export type POST_DomainsTldSpecificCzByDomainReferenceAuthCodeRequest_Response_404 = Problem;
1185
1194
  export type POST_DomainsTldSpecificCzByDomainReferenceAuthCodeRequest_Response_422 = HTTPValidationError;
@@ -1192,14 +1201,14 @@ export type POST_DomainsTldSpecificDeByDomainReferenceTransit_Response_422 = HTT
1192
1201
 
1193
1202
  export type POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response = POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response_200 | POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response_400 | POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response_404 | POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response_422;
1194
1203
 
1195
- export type POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response_200 = RequestAuthcode3;
1204
+ export type POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response_200 = RequestAuthcode4;
1196
1205
  export type POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response_400 = Problem;
1197
1206
  export type POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response_404 = Problem;
1198
1207
  export type POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response_422 = HTTPValidationError;
1199
1208
 
1200
1209
  export type POST_DomainsTldSpecificLtByDomainReferenceAuthCodeRequest_Response = POST_DomainsTldSpecificLtByDomainReferenceAuthCodeRequest_Response_200 | POST_DomainsTldSpecificLtByDomainReferenceAuthCodeRequest_Response_400 | POST_DomainsTldSpecificLtByDomainReferenceAuthCodeRequest_Response_404 | POST_DomainsTldSpecificLtByDomainReferenceAuthCodeRequest_Response_422;
1201
1210
 
1202
- export type POST_DomainsTldSpecificLtByDomainReferenceAuthCodeRequest_Response_200 = RequestAuthcode4;
1211
+ export type POST_DomainsTldSpecificLtByDomainReferenceAuthCodeRequest_Response_200 = RequestAuthcode5;
1203
1212
  export type POST_DomainsTldSpecificLtByDomainReferenceAuthCodeRequest_Response_400 = Problem;
1204
1213
  export type POST_DomainsTldSpecificLtByDomainReferenceAuthCodeRequest_Response_404 = Problem;
1205
1214
  export type POST_DomainsTldSpecificLtByDomainReferenceAuthCodeRequest_Response_422 = HTTPValidationError;
@@ -1220,11 +1229,18 @@ export type POST_DomainsTldSpecificNoByDomainReferenceResendDeclarationEmail_Res
1220
1229
 
1221
1230
  export type POST_DomainsTldSpecificSeByDomainReferenceAuthCodeRequest_Response = POST_DomainsTldSpecificSeByDomainReferenceAuthCodeRequest_Response_200 | POST_DomainsTldSpecificSeByDomainReferenceAuthCodeRequest_Response_400 | POST_DomainsTldSpecificSeByDomainReferenceAuthCodeRequest_Response_404 | POST_DomainsTldSpecificSeByDomainReferenceAuthCodeRequest_Response_422;
1222
1231
 
1223
- export type POST_DomainsTldSpecificSeByDomainReferenceAuthCodeRequest_Response_200 = RequestAuthcode5;
1232
+ export type POST_DomainsTldSpecificSeByDomainReferenceAuthCodeRequest_Response_200 = RequestAuthcode6;
1224
1233
  export type POST_DomainsTldSpecificSeByDomainReferenceAuthCodeRequest_Response_400 = Problem;
1225
1234
  export type POST_DomainsTldSpecificSeByDomainReferenceAuthCodeRequest_Response_404 = Problem;
1226
1235
  export type POST_DomainsTldSpecificSeByDomainReferenceAuthCodeRequest_Response_422 = HTTPValidationError;
1227
1236
 
1237
+ export type POST_DomainsTldSpecificWalesByDomainReferenceAuthCodeRequest_Response = POST_DomainsTldSpecificWalesByDomainReferenceAuthCodeRequest_Response_200 | POST_DomainsTldSpecificWalesByDomainReferenceAuthCodeRequest_Response_400 | POST_DomainsTldSpecificWalesByDomainReferenceAuthCodeRequest_Response_404 | POST_DomainsTldSpecificWalesByDomainReferenceAuthCodeRequest_Response_422;
1238
+
1239
+ export type POST_DomainsTldSpecificWalesByDomainReferenceAuthCodeRequest_Response_200 = RequestAuthcode7;
1240
+ export type POST_DomainsTldSpecificWalesByDomainReferenceAuthCodeRequest_Response_400 = Problem;
1241
+ export type POST_DomainsTldSpecificWalesByDomainReferenceAuthCodeRequest_Response_404 = Problem;
1242
+ export type POST_DomainsTldSpecificWalesByDomainReferenceAuthCodeRequest_Response_422 = HTTPValidationError;
1243
+
1228
1244
  export type POST_DomainsTransfer_Response = POST_DomainsTransfer_Response_201 | POST_DomainsTransfer_Response_400 | POST_DomainsTransfer_Response_403 | POST_DomainsTransfer_Response_404 | POST_DomainsTransfer_Response_409 | POST_DomainsTransfer_Response_422;
1229
1245
 
1230
1246
  export type POST_DomainsTransfer_Response_201 = Domain;
@@ -582,9 +582,11 @@ export type ZoneVanitySetUpdate = components['schemas']['ZoneVanitySetUpdate'];
582
582
  export type ZonesContext = components['schemas']['ZonesContext'];
583
583
  export type ZonesContextCreate = components['schemas']['ZonesContextCreate'];
584
584
  export type RequestAuthcode = components['schemas']['api__domain__tld_specific__be__models__RequestAuthcodeResponse'];
585
- export type RequestAuthcode2 = components['schemas']['api__domain__tld_specific__cz__models__RequestAuthcodeResponse'];
586
- export type RequestAuthcode3 = components['schemas']['api__domain__tld_specific__eu__models__RequestAuthcodeResponse'];
587
- export type RequestAuthcode4 = components['schemas']['api__domain__tld_specific__lt__models__RequestAuthcodeResponse'];
588
- export type RequestAuthcode5 = components['schemas']['api__domain__tld_specific__se__models__RequestAuthcodeResponse'];
585
+ export type RequestAuthcode2 = components['schemas']['api__domain__tld_specific__cymru__models__RequestAuthcodeResponse'];
586
+ export type RequestAuthcode3 = components['schemas']['api__domain__tld_specific__cz__models__RequestAuthcodeResponse'];
587
+ export type RequestAuthcode4 = components['schemas']['api__domain__tld_specific__eu__models__RequestAuthcodeResponse'];
588
+ export type RequestAuthcode5 = components['schemas']['api__domain__tld_specific__lt__models__RequestAuthcodeResponse'];
589
+ export type RequestAuthcode6 = components['schemas']['api__domain__tld_specific__se__models__RequestAuthcodeResponse'];
590
+ export type RequestAuthcode7 = components['schemas']['api__domain__tld_specific__wales__models__RequestAuthcodeResponse'];
589
591
  export type DomainAvailabilityList = components['schemas']['common__models__availability__datasource__DomainAvailabilityResponse'];
590
592
  export type DomainAvailabilityCheck = components['schemas']['common__models__domain__domain__DomainAvailabilityResponse'];
package/src/openapi.yaml CHANGED
@@ -5492,8 +5492,8 @@ components:
5492
5492
  $ref: '#/components/schemas/StatusTagResponse'
5493
5493
  type: array
5494
5494
  - type: 'null'
5495
- description: Status tags assigned to this domain. Only included when ?include=tags
5496
- is specified.
5495
+ description: Status tags assigned to this domain. Null unless `include=tags`
5496
+ is requested.
5497
5497
  title: Status Tags
5498
5498
  tags:
5499
5499
  anyOf:
@@ -5501,8 +5501,8 @@ components:
5501
5501
  $ref: '#/components/schemas/TagEnrichedResponse'
5502
5502
  type: array
5503
5503
  - type: 'null'
5504
- description: User tags assigned to this domain. Only included when ?include=tags
5505
- is specified.
5504
+ description: User tags assigned to this domain. Null unless `include=tags`
5505
+ is requested.
5506
5506
  title: Tags
5507
5507
  tld:
5508
5508
  description: The top level domain of the domain
@@ -14857,6 +14857,33 @@ components:
14857
14857
  - success
14858
14858
  title: RequestAuthcodeResponse
14859
14859
  type: object
14860
+ api__domain__tld_specific__cymru__models__RequestAuthcodeResponse:
14861
+ properties:
14862
+ auth_code:
14863
+ anyOf:
14864
+ - type: string
14865
+ - type: 'null'
14866
+ description: The auth code set at Nominet
14867
+ title: Auth Code
14868
+ detail:
14869
+ anyOf:
14870
+ - type: string
14871
+ - type: 'null'
14872
+ description: Additional information about the result in case of failure
14873
+ title: Detail
14874
+ name:
14875
+ description: The domain name that had the auth code requested
14876
+ title: Name
14877
+ type: string
14878
+ success:
14879
+ description: Whether a fresh auth code was set at Nominet
14880
+ title: Success
14881
+ type: boolean
14882
+ required:
14883
+ - name
14884
+ - success
14885
+ title: RequestAuthcodeResponse
14886
+ type: object
14860
14887
  api__domain__tld_specific__cz__models__RequestAuthcodeResponse:
14861
14888
  properties:
14862
14889
  detail:
@@ -14980,6 +15007,33 @@ components:
14980
15007
  - success
14981
15008
  title: RequestAuthcodeResponse
14982
15009
  type: object
15010
+ api__domain__tld_specific__wales__models__RequestAuthcodeResponse:
15011
+ properties:
15012
+ auth_code:
15013
+ anyOf:
15014
+ - type: string
15015
+ - type: 'null'
15016
+ description: The auth code set at Nominet
15017
+ title: Auth Code
15018
+ detail:
15019
+ anyOf:
15020
+ - type: string
15021
+ - type: 'null'
15022
+ description: Additional information about the result in case of failure
15023
+ title: Detail
15024
+ name:
15025
+ description: The domain name that had the auth code requested
15026
+ title: Name
15027
+ type: string
15028
+ success:
15029
+ description: Whether a fresh auth code was set at Nominet
15030
+ title: Success
15031
+ type: boolean
15032
+ required:
15033
+ - name
15034
+ - success
15035
+ title: RequestAuthcodeResponse
15036
+ type: object
14983
15037
  common__models__availability__datasource__DomainAvailabilityResponse:
14984
15038
  properties:
14985
15039
  meta:
@@ -15115,7 +15169,7 @@ info:
15115
15169
  \n\n"
15116
15170
  summary: OpusDNS - your gateway to a seamless domain management experience.
15117
15171
  title: OpusDNS API
15118
- version: 2026-08-10-151407
15172
+ version: 2026-08-12-074946
15119
15173
  x-logo:
15120
15174
  altText: OpusDNS API Reference
15121
15175
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -22779,7 +22833,7 @@ paths:
22779
22833
  - domain_search
22780
22834
  /v1/domains:
22781
22835
  get:
22782
- description: Retrieves a paginated list of all active domains
22836
+ description: Retrieves a paginated list of all active domains.
22783
22837
  operationId: get_domains_v1_domains_get
22784
22838
  parameters:
22785
22839
  - in: query
@@ -23034,8 +23088,9 @@ paths:
23034
23088
  description: Filter domains by registry status. Can be specified multiple
23035
23089
  times (union of all provided values).
23036
23090
  title: Registry Statuses
23037
- - description: Include additional data in the response. Can be specified multiple
23038
- times.
23091
+ - description: Extra data to include in each result. `tags` populates the `tags`
23092
+ (user tags) and `status_tags` fields, which are otherwise null; filtering
23093
+ by `tag_ids` or `status_tags` alone does not populate them.
23039
23094
  in: query
23040
23095
  name: include
23041
23096
  required: false
@@ -23045,8 +23100,9 @@ paths:
23045
23100
  $ref: '#/components/schemas/DomainListIncludeField'
23046
23101
  type: array
23047
23102
  - type: 'null'
23048
- description: Include additional data in the response. Can be specified multiple
23049
- times.
23103
+ description: Extra data to include in each result. `tags` populates the
23104
+ `tags` (user tags) and `status_tags` fields, which are otherwise null;
23105
+ filtering by `tag_ids` or `status_tags` alone does not populate them.
23050
23106
  title: Include
23051
23107
  - $ref: '#/components/parameters/DatetimeFormatHeader'
23052
23108
  responses:
@@ -23498,6 +23554,78 @@ paths:
23498
23554
  - domain_tld_specific
23499
23555
  x-required-permissions:
23500
23556
  - domains:manage
23557
+ /v1/domains/tld-specific/cymru/{domain_reference}/auth_code/request:
23558
+ post:
23559
+ description: Nominet expires a Transfer Authorisation Code after 14 days or
23560
+ on use in a transfer, and enforces complexity requirements on it. This endpoint
23561
+ mints a compliant code, sets it through a `domain:update` and returns it,
23562
+ invalidating any previous one. It is the only way to change a `.cymru` auth
23563
+ code.
23564
+ operationId: request_auth_code_v1_domains_tld_specific_cymru__domain_reference__auth_code_request_post
23565
+ parameters:
23566
+ - in: path
23567
+ name: domain_reference
23568
+ required: true
23569
+ schema:
23570
+ anyOf:
23571
+ - examples:
23572
+ - domain_01h45ytscbebyvny4gc8cr8ma2
23573
+ format: typeid
23574
+ pattern: ^domain_[0-7][0-9a-hjkmnpq-tv-z]{25}$
23575
+ type: string
23576
+ x-typeid-prefix: domain
23577
+ - type: string
23578
+ title: Domain Reference
23579
+ - $ref: '#/components/parameters/DatetimeFormatHeader'
23580
+ responses:
23581
+ '200':
23582
+ content:
23583
+ application/json:
23584
+ schema:
23585
+ $ref: '#/components/schemas/api__domain__tld_specific__cymru__models__RequestAuthcodeResponse'
23586
+ description: Successful Response
23587
+ '400':
23588
+ content:
23589
+ application/problem+json:
23590
+ example:
23591
+ code: ERROR_DOMAIN_TRANSFER
23592
+ detail: There was an error transferring the domain
23593
+ domain_name: Additional error context.
23594
+ reason: An unspecified error occurred
23595
+ status: 400
23596
+ title: Domain Transfer Error
23597
+ type: domain-transfer
23598
+ schema:
23599
+ $ref: '#/components/schemas/Problem'
23600
+ description: Bad Request
23601
+ '404':
23602
+ content:
23603
+ application/problem+json:
23604
+ example:
23605
+ code: ERROR_DOMAIN_NOT_FOUND
23606
+ detail: Domain not found
23607
+ domain_name: Additional error context.
23608
+ status: 404
23609
+ title: Domain Management Error
23610
+ type: domain-not-found
23611
+ schema:
23612
+ $ref: '#/components/schemas/Problem'
23613
+ description: Not Found
23614
+ '422':
23615
+ content:
23616
+ application/problem+json:
23617
+ schema:
23618
+ $ref: '#/components/schemas/HTTPValidationError'
23619
+ description: Validation Error
23620
+ security:
23621
+ - OAuth2PasswordBearer: []
23622
+ - APIKeyHeader: []
23623
+ summary: Generates a fresh auth code at Nominet (.cymru)
23624
+ tags:
23625
+ - domain
23626
+ - domain_tld_specific
23627
+ x-required-permissions:
23628
+ - domains:manage
23501
23629
  /v1/domains/tld-specific/cz/{domain_reference}/auth_code/request:
23502
23630
  post:
23503
23631
  operationId: request_auth_code_v1_domains_tld_specific_cz__domain_reference__auth_code_request_post
@@ -24090,6 +24218,78 @@ paths:
24090
24218
  - domain_tld_specific
24091
24219
  x-required-permissions:
24092
24220
  - domains:manage
24221
+ /v1/domains/tld-specific/wales/{domain_reference}/auth_code/request:
24222
+ post:
24223
+ description: Nominet expires a Transfer Authorisation Code after 14 days or
24224
+ on use in a transfer, and enforces complexity requirements on it. This endpoint
24225
+ mints a compliant code, sets it through a `domain:update` and returns it,
24226
+ invalidating any previous one. It is the only way to change a `.wales` auth
24227
+ code.
24228
+ operationId: request_auth_code_v1_domains_tld_specific_wales__domain_reference__auth_code_request_post
24229
+ parameters:
24230
+ - in: path
24231
+ name: domain_reference
24232
+ required: true
24233
+ schema:
24234
+ anyOf:
24235
+ - examples:
24236
+ - domain_01h45ytscbebyvny4gc8cr8ma2
24237
+ format: typeid
24238
+ pattern: ^domain_[0-7][0-9a-hjkmnpq-tv-z]{25}$
24239
+ type: string
24240
+ x-typeid-prefix: domain
24241
+ - type: string
24242
+ title: Domain Reference
24243
+ - $ref: '#/components/parameters/DatetimeFormatHeader'
24244
+ responses:
24245
+ '200':
24246
+ content:
24247
+ application/json:
24248
+ schema:
24249
+ $ref: '#/components/schemas/api__domain__tld_specific__wales__models__RequestAuthcodeResponse'
24250
+ description: Successful Response
24251
+ '400':
24252
+ content:
24253
+ application/problem+json:
24254
+ example:
24255
+ code: ERROR_DOMAIN_TRANSFER
24256
+ detail: There was an error transferring the domain
24257
+ domain_name: Additional error context.
24258
+ reason: An unspecified error occurred
24259
+ status: 400
24260
+ title: Domain Transfer Error
24261
+ type: domain-transfer
24262
+ schema:
24263
+ $ref: '#/components/schemas/Problem'
24264
+ description: Bad Request
24265
+ '404':
24266
+ content:
24267
+ application/problem+json:
24268
+ example:
24269
+ code: ERROR_DOMAIN_NOT_FOUND
24270
+ detail: Domain not found
24271
+ domain_name: Additional error context.
24272
+ status: 404
24273
+ title: Domain Management Error
24274
+ type: domain-not-found
24275
+ schema:
24276
+ $ref: '#/components/schemas/Problem'
24277
+ description: Not Found
24278
+ '422':
24279
+ content:
24280
+ application/problem+json:
24281
+ schema:
24282
+ $ref: '#/components/schemas/HTTPValidationError'
24283
+ description: Validation Error
24284
+ security:
24285
+ - OAuth2PasswordBearer: []
24286
+ - APIKeyHeader: []
24287
+ summary: Generates a fresh auth code at Nominet (.wales)
24288
+ tags:
24289
+ - domain
24290
+ - domain_tld_specific
24291
+ x-required-permissions:
24292
+ - domains:manage
24093
24293
  /v1/domains/transfer:
24094
24294
  post:
24095
24295
  description: 'Start the transfer process for a domain <br>
@@ -24304,7 +24504,7 @@ paths:
24304
24504
  x-required-permissions:
24305
24505
  - domains:delete
24306
24506
  get:
24307
- description: Retrieves a single active domain by either its name or id
24507
+ description: Retrieves a single active domain by either its name or id.
24308
24508
  operationId: get_domain_v1_domains__domain_reference__get
24309
24509
  parameters:
24310
24510
  - in: path
@@ -24320,7 +24520,9 @@ paths:
24320
24520
  x-typeid-prefix: domain
24321
24521
  - type: string
24322
24522
  title: Domain Reference
24323
- - description: Include additional data in the response.
24523
+ - description: Extra data to include in the response. `tags` populates the `tags`
24524
+ and `status_tags` fields, which are otherwise null. `renewal_price` resolves
24525
+ the domain's renewal price.
24324
24526
  in: query
24325
24527
  name: include
24326
24528
  required: false
@@ -24330,7 +24532,9 @@ paths:
24330
24532
  $ref: '#/components/schemas/DomainIncludeField'
24331
24533
  type: array
24332
24534
  - type: 'null'
24333
- description: Include additional data in the response.
24535
+ description: Extra data to include in the response. `tags` populates the
24536
+ `tags` and `status_tags` fields, which are otherwise null. `renewal_price`
24537
+ resolves the domain's renewal price.
24334
24538
  title: Include
24335
24539
  - $ref: '#/components/parameters/DatetimeFormatHeader'
24336
24540
  responses:
package/src/schema.d.ts CHANGED
@@ -1083,7 +1083,7 @@ export interface paths {
1083
1083
  };
1084
1084
  /**
1085
1085
  * List all domains
1086
- * @description Retrieves a paginated list of all active domains
1086
+ * @description Retrieves a paginated list of all active domains.
1087
1087
  */
1088
1088
  get: operations["get_domains_v1_domains_get"];
1089
1089
  put?: never;
@@ -1202,6 +1202,26 @@ export interface paths {
1202
1202
  patch?: never;
1203
1203
  trace?: never;
1204
1204
  };
1205
+ "/v1/domains/tld-specific/cymru/{domain_reference}/auth_code/request": {
1206
+ parameters: {
1207
+ query?: never;
1208
+ header?: never;
1209
+ path?: never;
1210
+ cookie?: never;
1211
+ };
1212
+ get?: never;
1213
+ put?: never;
1214
+ /**
1215
+ * Generates a fresh auth code at Nominet (.cymru)
1216
+ * @description Nominet expires a Transfer Authorisation Code after 14 days or on use in a transfer, and enforces complexity requirements on it. This endpoint mints a compliant code, sets it through a `domain:update` and returns it, invalidating any previous one. It is the only way to change a `.cymru` auth code.
1217
+ */
1218
+ post: operations["request_auth_code_v1_domains_tld_specific_cymru__domain_reference__auth_code_request_post"];
1219
+ delete?: never;
1220
+ options?: never;
1221
+ head?: never;
1222
+ patch?: never;
1223
+ trace?: never;
1224
+ };
1205
1225
  "/v1/domains/tld-specific/cz/{domain_reference}/auth_code/request": {
1206
1226
  parameters: {
1207
1227
  query?: never;
@@ -1348,6 +1368,26 @@ export interface paths {
1348
1368
  patch?: never;
1349
1369
  trace?: never;
1350
1370
  };
1371
+ "/v1/domains/tld-specific/wales/{domain_reference}/auth_code/request": {
1372
+ parameters: {
1373
+ query?: never;
1374
+ header?: never;
1375
+ path?: never;
1376
+ cookie?: never;
1377
+ };
1378
+ get?: never;
1379
+ put?: never;
1380
+ /**
1381
+ * Generates a fresh auth code at Nominet (.wales)
1382
+ * @description Nominet expires a Transfer Authorisation Code after 14 days or on use in a transfer, and enforces complexity requirements on it. This endpoint mints a compliant code, sets it through a `domain:update` and returns it, invalidating any previous one. It is the only way to change a `.wales` auth code.
1383
+ */
1384
+ post: operations["request_auth_code_v1_domains_tld_specific_wales__domain_reference__auth_code_request_post"];
1385
+ delete?: never;
1386
+ options?: never;
1387
+ head?: never;
1388
+ patch?: never;
1389
+ trace?: never;
1390
+ };
1351
1391
  "/v1/domains/transfer": {
1352
1392
  parameters: {
1353
1393
  query?: never;
@@ -1379,7 +1419,7 @@ export interface paths {
1379
1419
  };
1380
1420
  /**
1381
1421
  * Retrieve a domain
1382
- * @description Retrieves a single active domain by either its name or id
1422
+ * @description Retrieves a single active domain by either its name or id.
1383
1423
  */
1384
1424
  get: operations["get_domain_v1_domains__domain_reference__get"];
1385
1425
  put?: never;
@@ -6499,12 +6539,12 @@ export interface components {
6499
6539
  sld: string;
6500
6540
  /**
6501
6541
  * Status Tags
6502
- * @description Status tags assigned to this domain. Only included when ?include=tags is specified.
6542
+ * @description Status tags assigned to this domain. Null unless `include=tags` is requested.
6503
6543
  */
6504
6544
  status_tags?: components["schemas"]["StatusTagResponse"][] | null;
6505
6545
  /**
6506
6546
  * Tags
6507
- * @description User tags assigned to this domain. Only included when ?include=tags is specified.
6547
+ * @description User tags assigned to this domain. Null unless `include=tags` is requested.
6508
6548
  */
6509
6549
  tags?: components["schemas"]["TagEnrichedResponse"][] | null;
6510
6550
  /**
@@ -12731,6 +12771,29 @@ export interface components {
12731
12771
  success: boolean;
12732
12772
  };
12733
12773
  /** RequestAuthcodeResponse */
12774
+ api__domain__tld_specific__cymru__models__RequestAuthcodeResponse: {
12775
+ /**
12776
+ * Auth Code
12777
+ * @description The auth code set at Nominet
12778
+ */
12779
+ auth_code?: string | null;
12780
+ /**
12781
+ * Detail
12782
+ * @description Additional information about the result in case of failure
12783
+ */
12784
+ detail?: string | null;
12785
+ /**
12786
+ * Name
12787
+ * @description The domain name that had the auth code requested
12788
+ */
12789
+ name: string;
12790
+ /**
12791
+ * Success
12792
+ * @description Whether a fresh auth code was set at Nominet
12793
+ */
12794
+ success: boolean;
12795
+ };
12796
+ /** RequestAuthcodeResponse */
12734
12797
  api__domain__tld_specific__cz__models__RequestAuthcodeResponse: {
12735
12798
  /**
12736
12799
  * Detail
@@ -12832,6 +12895,29 @@ export interface components {
12832
12895
  */
12833
12896
  success: boolean;
12834
12897
  };
12898
+ /** RequestAuthcodeResponse */
12899
+ api__domain__tld_specific__wales__models__RequestAuthcodeResponse: {
12900
+ /**
12901
+ * Auth Code
12902
+ * @description The auth code set at Nominet
12903
+ */
12904
+ auth_code?: string | null;
12905
+ /**
12906
+ * Detail
12907
+ * @description Additional information about the result in case of failure
12908
+ */
12909
+ detail?: string | null;
12910
+ /**
12911
+ * Name
12912
+ * @description The domain name that had the auth code requested
12913
+ */
12914
+ name: string;
12915
+ /**
12916
+ * Success
12917
+ * @description Whether a fresh auth code was set at Nominet
12918
+ */
12919
+ success: boolean;
12920
+ };
12835
12921
  /** DomainAvailabilityResponse */
12836
12922
  common__models__availability__datasource__DomainAvailabilityResponse: {
12837
12923
  meta: components["schemas"]["DomainAvailabilityMeta"];
@@ -18817,7 +18903,7 @@ export interface operations {
18817
18903
  transferred_before?: Date | null;
18818
18904
  /** @description Filter domains by registry status. Can be specified multiple times (union of all provided values). */
18819
18905
  registry_statuses?: string[] | null;
18820
- /** @description Include additional data in the response. Can be specified multiple times. */
18906
+ /** @description Extra data to include in each result. `tags` populates the `tags` (user tags) and `status_tags` fields, which are otherwise null; filtering by `tag_ids` or `status_tags` alone does not populate them. */
18821
18907
  include?: components["schemas"]["DomainListIncludeField"][] | null;
18822
18908
  };
18823
18909
  header?: {
@@ -19222,6 +19308,78 @@ export interface operations {
19222
19308
  };
19223
19309
  };
19224
19310
  };
19311
+ request_auth_code_v1_domains_tld_specific_cymru__domain_reference__auth_code_request_post: {
19312
+ parameters: {
19313
+ query?: never;
19314
+ header?: {
19315
+ /**
19316
+ * @description Opt in to RFC 3339 datetime serialization. When set to `rfc3339`, response datetimes are normalized to UTC and serialized with a `Z` suffix. This is opt-in until the announced default cutover date, after which RFC 3339 becomes the default and this header is accepted as a no-op. Any other value or omission uses the current default serialization.
19317
+ * @example rfc3339
19318
+ */
19319
+ "X-Datetime-Format"?: components["parameters"]["DatetimeFormatHeader"];
19320
+ };
19321
+ path: {
19322
+ domain_reference: TypeId<"domain"> | string;
19323
+ };
19324
+ cookie?: never;
19325
+ };
19326
+ requestBody?: never;
19327
+ responses: {
19328
+ /** @description Successful Response */
19329
+ 200: {
19330
+ headers: {
19331
+ [name: string]: unknown;
19332
+ };
19333
+ content: {
19334
+ "application/json": components["schemas"]["api__domain__tld_specific__cymru__models__RequestAuthcodeResponse"];
19335
+ };
19336
+ };
19337
+ /** @description Bad Request */
19338
+ 400: {
19339
+ headers: {
19340
+ [name: string]: unknown;
19341
+ };
19342
+ content: {
19343
+ /** @example {
19344
+ * "code": "ERROR_DOMAIN_TRANSFER",
19345
+ * "detail": "There was an error transferring the domain",
19346
+ * "domain_name": "Additional error context.",
19347
+ * "reason": "An unspecified error occurred",
19348
+ * "status": 400,
19349
+ * "title": "Domain Transfer Error",
19350
+ * "type": "domain-transfer"
19351
+ * } */
19352
+ "application/problem+json": components["schemas"]["Problem"];
19353
+ };
19354
+ };
19355
+ /** @description Not Found */
19356
+ 404: {
19357
+ headers: {
19358
+ [name: string]: unknown;
19359
+ };
19360
+ content: {
19361
+ /** @example {
19362
+ * "code": "ERROR_DOMAIN_NOT_FOUND",
19363
+ * "detail": "Domain not found",
19364
+ * "domain_name": "Additional error context.",
19365
+ * "status": 404,
19366
+ * "title": "Domain Management Error",
19367
+ * "type": "domain-not-found"
19368
+ * } */
19369
+ "application/problem+json": components["schemas"]["Problem"];
19370
+ };
19371
+ };
19372
+ /** @description Validation Error */
19373
+ 422: {
19374
+ headers: {
19375
+ [name: string]: unknown;
19376
+ };
19377
+ content: {
19378
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
19379
+ };
19380
+ };
19381
+ };
19382
+ };
19225
19383
  request_auth_code_v1_domains_tld_specific_cz__domain_reference__auth_code_request_post: {
19226
19384
  parameters: {
19227
19385
  query?: never;
@@ -19855,6 +20013,78 @@ export interface operations {
19855
20013
  };
19856
20014
  };
19857
20015
  };
20016
+ request_auth_code_v1_domains_tld_specific_wales__domain_reference__auth_code_request_post: {
20017
+ parameters: {
20018
+ query?: never;
20019
+ header?: {
20020
+ /**
20021
+ * @description Opt in to RFC 3339 datetime serialization. When set to `rfc3339`, response datetimes are normalized to UTC and serialized with a `Z` suffix. This is opt-in until the announced default cutover date, after which RFC 3339 becomes the default and this header is accepted as a no-op. Any other value or omission uses the current default serialization.
20022
+ * @example rfc3339
20023
+ */
20024
+ "X-Datetime-Format"?: components["parameters"]["DatetimeFormatHeader"];
20025
+ };
20026
+ path: {
20027
+ domain_reference: TypeId<"domain"> | string;
20028
+ };
20029
+ cookie?: never;
20030
+ };
20031
+ requestBody?: never;
20032
+ responses: {
20033
+ /** @description Successful Response */
20034
+ 200: {
20035
+ headers: {
20036
+ [name: string]: unknown;
20037
+ };
20038
+ content: {
20039
+ "application/json": components["schemas"]["api__domain__tld_specific__wales__models__RequestAuthcodeResponse"];
20040
+ };
20041
+ };
20042
+ /** @description Bad Request */
20043
+ 400: {
20044
+ headers: {
20045
+ [name: string]: unknown;
20046
+ };
20047
+ content: {
20048
+ /** @example {
20049
+ * "code": "ERROR_DOMAIN_TRANSFER",
20050
+ * "detail": "There was an error transferring the domain",
20051
+ * "domain_name": "Additional error context.",
20052
+ * "reason": "An unspecified error occurred",
20053
+ * "status": 400,
20054
+ * "title": "Domain Transfer Error",
20055
+ * "type": "domain-transfer"
20056
+ * } */
20057
+ "application/problem+json": components["schemas"]["Problem"];
20058
+ };
20059
+ };
20060
+ /** @description Not Found */
20061
+ 404: {
20062
+ headers: {
20063
+ [name: string]: unknown;
20064
+ };
20065
+ content: {
20066
+ /** @example {
20067
+ * "code": "ERROR_DOMAIN_NOT_FOUND",
20068
+ * "detail": "Domain not found",
20069
+ * "domain_name": "Additional error context.",
20070
+ * "status": 404,
20071
+ * "title": "Domain Management Error",
20072
+ * "type": "domain-not-found"
20073
+ * } */
20074
+ "application/problem+json": components["schemas"]["Problem"];
20075
+ };
20076
+ };
20077
+ /** @description Validation Error */
20078
+ 422: {
20079
+ headers: {
20080
+ [name: string]: unknown;
20081
+ };
20082
+ content: {
20083
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
20084
+ };
20085
+ };
20086
+ };
20087
+ };
19858
20088
  transfer_domain_v1_domains_transfer_post: {
19859
20089
  parameters: {
19860
20090
  query?: never;
@@ -19957,7 +20187,7 @@ export interface operations {
19957
20187
  get_domain_v1_domains__domain_reference__get: {
19958
20188
  parameters: {
19959
20189
  query?: {
19960
- /** @description Include additional data in the response. */
20190
+ /** @description Extra data to include in the response. `tags` populates the `tags` and `status_tags` fields, which are otherwise null. `renewal_price` resolves the domain's renewal price. */
19961
20191
  include?: components["schemas"]["DomainIncludeField"][] | null;
19962
20192
  };
19963
20193
  header?: {