@opusdns/api 0.289.0 → 0.291.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 +257 -1
- package/src/helpers/keys.ts +2206 -291
- package/src/helpers/requests.d.ts +45 -5
- package/src/helpers/responses.d.ts +123 -10
- package/src/helpers/schemas-arrays.d.ts +141 -1
- package/src/helpers/schemas.d.ts +368 -16
- package/src/openapi.yaml +644 -132
- package/src/schema.d.ts +458 -88
package/src/openapi.yaml
CHANGED
|
@@ -323,6 +323,88 @@ components:
|
|
|
323
323
|
- objects
|
|
324
324
|
title: BulkObjectTagChanges
|
|
325
325
|
type: object
|
|
326
|
+
ClaimsNotice:
|
|
327
|
+
properties:
|
|
328
|
+
claims:
|
|
329
|
+
description: List of trademark claims
|
|
330
|
+
items:
|
|
331
|
+
$ref: '#/components/schemas/TmClaim'
|
|
332
|
+
title: Claims
|
|
333
|
+
type: array
|
|
334
|
+
claims_key:
|
|
335
|
+
description: The claims key used to retrieve this claims notice
|
|
336
|
+
title: Claims Key
|
|
337
|
+
type: string
|
|
338
|
+
claims_notice_acceptance_hash:
|
|
339
|
+
description: Hash to accept the claims notice
|
|
340
|
+
title: Claims Notice Acceptance Hash
|
|
341
|
+
type: string
|
|
342
|
+
label:
|
|
343
|
+
description: Domain name label covered by this claims notice
|
|
344
|
+
title: Label
|
|
345
|
+
type: string
|
|
346
|
+
notice_footer:
|
|
347
|
+
default: ''
|
|
348
|
+
description: Claims notice form footer text
|
|
349
|
+
title: Notice Footer
|
|
350
|
+
type: string
|
|
351
|
+
notice_footer_url:
|
|
352
|
+
default: ''
|
|
353
|
+
description: Claims notice form footer URL
|
|
354
|
+
title: Notice Footer Url
|
|
355
|
+
type: string
|
|
356
|
+
notice_intro:
|
|
357
|
+
default: ''
|
|
358
|
+
description: Introductory text for the claims notice
|
|
359
|
+
title: Notice Intro
|
|
360
|
+
type: string
|
|
361
|
+
notice_not_exact_match_intro:
|
|
362
|
+
default: ''
|
|
363
|
+
description: Introductory text for the non-exact match section
|
|
364
|
+
title: Notice Not Exact Match Intro
|
|
365
|
+
type: string
|
|
366
|
+
notice_title:
|
|
367
|
+
default: ''
|
|
368
|
+
description: Title for the claims notice
|
|
369
|
+
title: Notice Title
|
|
370
|
+
type: string
|
|
371
|
+
rendered_html:
|
|
372
|
+
default: ''
|
|
373
|
+
description: The rendered trademark claims notice HTML
|
|
374
|
+
title: Rendered Html
|
|
375
|
+
type: string
|
|
376
|
+
required:
|
|
377
|
+
- claims_key
|
|
378
|
+
- claims_notice_acceptance_hash
|
|
379
|
+
- label
|
|
380
|
+
title: ClaimsNotice
|
|
381
|
+
type: object
|
|
382
|
+
ClaimsNoticesRequest:
|
|
383
|
+
properties:
|
|
384
|
+
claims_keys:
|
|
385
|
+
description: List of claims keys to retrieve claims notices for, for the
|
|
386
|
+
time being limited to one claims key
|
|
387
|
+
items:
|
|
388
|
+
type: string
|
|
389
|
+
maxItems: 1
|
|
390
|
+
minItems: 1
|
|
391
|
+
title: Claims Keys
|
|
392
|
+
type: array
|
|
393
|
+
required:
|
|
394
|
+
- claims_keys
|
|
395
|
+
title: ClaimsNoticesRequest
|
|
396
|
+
type: object
|
|
397
|
+
ClaimsNoticesResponse:
|
|
398
|
+
properties:
|
|
399
|
+
claims_notices:
|
|
400
|
+
items:
|
|
401
|
+
$ref: '#/components/schemas/ClaimsNotice'
|
|
402
|
+
title: Claims Notices
|
|
403
|
+
type: array
|
|
404
|
+
required:
|
|
405
|
+
- claims_notices
|
|
406
|
+
title: ClaimsNoticesResponse
|
|
407
|
+
type: object
|
|
326
408
|
CommandError:
|
|
327
409
|
properties:
|
|
328
410
|
code:
|
|
@@ -1341,6 +1423,13 @@ components:
|
|
|
1341
1423
|
- created_on
|
|
1342
1424
|
title: ContactSortField
|
|
1343
1425
|
type: string
|
|
1426
|
+
ContactType:
|
|
1427
|
+
enum:
|
|
1428
|
+
- owner
|
|
1429
|
+
- agent
|
|
1430
|
+
- third party
|
|
1431
|
+
title: ContactType
|
|
1432
|
+
type: string
|
|
1344
1433
|
ContactVerificationApiResponse:
|
|
1345
1434
|
properties:
|
|
1346
1435
|
canceled_on:
|
|
@@ -3894,6 +3983,21 @@ components:
|
|
|
3894
3983
|
- period_extended
|
|
3895
3984
|
title: DomainRenewResponse
|
|
3896
3985
|
type: object
|
|
3986
|
+
DomainRenewalDetails:
|
|
3987
|
+
properties:
|
|
3988
|
+
detail_type:
|
|
3989
|
+
const: domain_renewal
|
|
3990
|
+
default: domain_renewal
|
|
3991
|
+
title: Detail Type
|
|
3992
|
+
type: string
|
|
3993
|
+
expires_on:
|
|
3994
|
+
format: date-time
|
|
3995
|
+
title: Expires On
|
|
3996
|
+
type: string
|
|
3997
|
+
required:
|
|
3998
|
+
- expires_on
|
|
3999
|
+
title: DomainRenewalDetails
|
|
4000
|
+
type: object
|
|
3897
4001
|
DomainResponse:
|
|
3898
4002
|
properties:
|
|
3899
4003
|
auth_code:
|
|
@@ -4924,6 +5028,35 @@ components:
|
|
|
4924
5028
|
- domain
|
|
4925
5029
|
title: DomainUpdateWorkerPayload
|
|
4926
5030
|
type: object
|
|
5031
|
+
DomainVerificationDetails:
|
|
5032
|
+
properties:
|
|
5033
|
+
detail_type:
|
|
5034
|
+
const: domain_verification
|
|
5035
|
+
default: domain_verification
|
|
5036
|
+
title: Detail Type
|
|
5037
|
+
type: string
|
|
5038
|
+
domain_id:
|
|
5039
|
+
title: Domain Id
|
|
5040
|
+
type: string
|
|
5041
|
+
registrants:
|
|
5042
|
+
items:
|
|
5043
|
+
$ref: '#/components/schemas/VerificationRegistrantDetails'
|
|
5044
|
+
title: Registrants
|
|
5045
|
+
type: array
|
|
5046
|
+
verification_claims:
|
|
5047
|
+
items:
|
|
5048
|
+
$ref: '#/components/schemas/VerificationClaimType'
|
|
5049
|
+
title: Verification Claims
|
|
5050
|
+
type: array
|
|
5051
|
+
verification_deadlines:
|
|
5052
|
+
items:
|
|
5053
|
+
$ref: '#/components/schemas/VerificationDeadline'
|
|
5054
|
+
title: Verification Deadlines
|
|
5055
|
+
type: array
|
|
5056
|
+
required:
|
|
5057
|
+
- domain_id
|
|
5058
|
+
title: DomainVerificationDetails
|
|
5059
|
+
type: object
|
|
4927
5060
|
DomainWithdrawRequest:
|
|
4928
5061
|
properties:
|
|
4929
5062
|
zone_delete:
|
|
@@ -5450,6 +5583,47 @@ components:
|
|
|
5450
5583
|
- canceled
|
|
5451
5584
|
title: EmailVerificationStatus
|
|
5452
5585
|
type: string
|
|
5586
|
+
EventData:
|
|
5587
|
+
properties:
|
|
5588
|
+
details:
|
|
5589
|
+
anyOf:
|
|
5590
|
+
- discriminator:
|
|
5591
|
+
mapping:
|
|
5592
|
+
domain_renewal: '#/components/schemas/DomainRenewalDetails'
|
|
5593
|
+
domain_verification: '#/components/schemas/DomainVerificationDetails'
|
|
5594
|
+
propertyName: detail_type
|
|
5595
|
+
oneOf:
|
|
5596
|
+
- $ref: '#/components/schemas/DomainRenewalDetails'
|
|
5597
|
+
- $ref: '#/components/schemas/DomainVerificationDetails'
|
|
5598
|
+
- type: 'null'
|
|
5599
|
+
title: Details
|
|
5600
|
+
error:
|
|
5601
|
+
anyOf:
|
|
5602
|
+
- $ref: '#/components/schemas/EventError'
|
|
5603
|
+
- type: 'null'
|
|
5604
|
+
message:
|
|
5605
|
+
title: Message
|
|
5606
|
+
type: string
|
|
5607
|
+
version:
|
|
5608
|
+
$ref: '#/components/schemas/EventVersion'
|
|
5609
|
+
default: '1.0'
|
|
5610
|
+
required:
|
|
5611
|
+
- message
|
|
5612
|
+
title: EventData
|
|
5613
|
+
type: object
|
|
5614
|
+
EventError:
|
|
5615
|
+
properties:
|
|
5616
|
+
code:
|
|
5617
|
+
title: Code
|
|
5618
|
+
type: string
|
|
5619
|
+
detail:
|
|
5620
|
+
title: Detail
|
|
5621
|
+
type: string
|
|
5622
|
+
required:
|
|
5623
|
+
- code
|
|
5624
|
+
- detail
|
|
5625
|
+
title: EventError
|
|
5626
|
+
type: object
|
|
5453
5627
|
EventObjectType:
|
|
5454
5628
|
enum:
|
|
5455
5629
|
- DOMAIN
|
|
@@ -5474,9 +5648,7 @@ components:
|
|
|
5474
5648
|
title: Created On
|
|
5475
5649
|
type: string
|
|
5476
5650
|
event_data:
|
|
5477
|
-
|
|
5478
|
-
title: Event Data
|
|
5479
|
-
type: object
|
|
5651
|
+
$ref: '#/components/schemas/EventData'
|
|
5480
5652
|
event_id:
|
|
5481
5653
|
examples:
|
|
5482
5654
|
- epp_event_01h45ytscbebyvny4gc8cr8ma2
|
|
@@ -5509,97 +5681,10 @@ components:
|
|
|
5509
5681
|
description: The type of the event - indicates the kind of operation occurring
|
|
5510
5682
|
(e.g., 'ACCOUNT_CREATE', 'DOMAIN_MODIFICATION')
|
|
5511
5683
|
required:
|
|
5684
|
+
- event_data
|
|
5512
5685
|
- created_on
|
|
5513
5686
|
title: EventResponse
|
|
5514
5687
|
type: object
|
|
5515
|
-
EventSchema:
|
|
5516
|
-
properties:
|
|
5517
|
-
acknowledged_on:
|
|
5518
|
-
anyOf:
|
|
5519
|
-
- format: date-time
|
|
5520
|
-
type: string
|
|
5521
|
-
- type: 'null'
|
|
5522
|
-
description: The date/time the event was acknowledged
|
|
5523
|
-
title: Acknowledged On
|
|
5524
|
-
created_on:
|
|
5525
|
-
description: The date/time the entry was created on
|
|
5526
|
-
format: date-time
|
|
5527
|
-
title: Created On
|
|
5528
|
-
type: string
|
|
5529
|
-
event_data:
|
|
5530
|
-
$ref: '#/components/schemas/JsonValue'
|
|
5531
|
-
description: Additional details about the action
|
|
5532
|
-
event_id:
|
|
5533
|
-
examples:
|
|
5534
|
-
- epp_event_01h45ytscbebyvny4gc8cr8ma2
|
|
5535
|
-
format: typeid
|
|
5536
|
-
pattern: ^epp_event_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
5537
|
-
title: Event Id
|
|
5538
|
-
type: string
|
|
5539
|
-
x-typeid-prefix: epp_event
|
|
5540
|
-
message_queue_id:
|
|
5541
|
-
anyOf:
|
|
5542
|
-
- type: string
|
|
5543
|
-
- type: 'null'
|
|
5544
|
-
description: A composite key with the registry account + message queue ID
|
|
5545
|
-
from the poll operation.
|
|
5546
|
-
title: Message Queue Id
|
|
5547
|
-
object_id:
|
|
5548
|
-
anyOf:
|
|
5549
|
-
- type: string
|
|
5550
|
-
- type: 'null'
|
|
5551
|
-
description: The id of the object that the event is about
|
|
5552
|
-
title: Object Id
|
|
5553
|
-
object_type:
|
|
5554
|
-
$ref: '#/components/schemas/EventObjectType'
|
|
5555
|
-
default: RAW
|
|
5556
|
-
description: The type of object that the event is about
|
|
5557
|
-
source:
|
|
5558
|
-
description: The source of the event
|
|
5559
|
-
maxLength: 64
|
|
5560
|
-
title: Source
|
|
5561
|
-
type: string
|
|
5562
|
-
source_event_id:
|
|
5563
|
-
anyOf:
|
|
5564
|
-
- examples:
|
|
5565
|
-
- epp_event_01h45ytscbebyvny4gc8cr8ma2
|
|
5566
|
-
format: typeid
|
|
5567
|
-
pattern: ^epp_event_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
5568
|
-
type: string
|
|
5569
|
-
x-typeid-prefix: epp_event
|
|
5570
|
-
- type: 'null'
|
|
5571
|
-
description: The reference of the original registry event (if any) that
|
|
5572
|
-
triggered this customer-facing event
|
|
5573
|
-
title: Source Event Id
|
|
5574
|
-
subtype:
|
|
5575
|
-
anyOf:
|
|
5576
|
-
- $ref: '#/components/schemas/EventSubtype'
|
|
5577
|
-
- type: 'null'
|
|
5578
|
-
description: The specific type/result of operation (considering the type
|
|
5579
|
-
property), more detailed (e.g., 'NOTIFICATION' with the 'DOMAIN_MODIFICATION'
|
|
5580
|
-
class)
|
|
5581
|
-
target:
|
|
5582
|
-
anyOf:
|
|
5583
|
-
- examples:
|
|
5584
|
-
- organization_01h45ytscbebyvny4gc8cr8ma2
|
|
5585
|
-
format: typeid
|
|
5586
|
-
pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
5587
|
-
type: string
|
|
5588
|
-
x-typeid-prefix: organization
|
|
5589
|
-
- type: 'null'
|
|
5590
|
-
description: The target of the event
|
|
5591
|
-
title: Target
|
|
5592
|
-
type:
|
|
5593
|
-
anyOf:
|
|
5594
|
-
- $ref: '#/components/schemas/EventType'
|
|
5595
|
-
- type: 'null'
|
|
5596
|
-
description: The type of the event - indicates the kind of operation occurring
|
|
5597
|
-
(e.g., 'ACCOUNT_CREATE', 'DOMAIN_MODIFICATION')
|
|
5598
|
-
required:
|
|
5599
|
-
- event_data
|
|
5600
|
-
- source
|
|
5601
|
-
title: EventSchema
|
|
5602
|
-
type: object
|
|
5603
5688
|
EventSortField:
|
|
5604
5689
|
enum:
|
|
5605
5690
|
- object_id
|
|
@@ -5627,6 +5712,11 @@ components:
|
|
|
5627
5712
|
- VERIFICATION
|
|
5628
5713
|
title: EventType
|
|
5629
5714
|
type: string
|
|
5715
|
+
EventVersion:
|
|
5716
|
+
enum:
|
|
5717
|
+
- '1.0'
|
|
5718
|
+
title: EventVersion
|
|
5719
|
+
type: string
|
|
5630
5720
|
ExecutingEntity:
|
|
5631
5721
|
enum:
|
|
5632
5722
|
- user
|
|
@@ -5708,6 +5798,13 @@ components:
|
|
|
5708
5798
|
- errors
|
|
5709
5799
|
title: RequestValidationError
|
|
5710
5800
|
type: object
|
|
5801
|
+
HolderEntitlement:
|
|
5802
|
+
enum:
|
|
5803
|
+
- owner
|
|
5804
|
+
- assignee
|
|
5805
|
+
- licensee
|
|
5806
|
+
title: HolderEntitlement
|
|
5807
|
+
type: string
|
|
5711
5808
|
HostSchema:
|
|
5712
5809
|
properties:
|
|
5713
5810
|
created_on:
|
|
@@ -9739,6 +9836,260 @@ components:
|
|
|
9739
9836
|
- transfer_policies
|
|
9740
9837
|
title: TldSpecificationResponse
|
|
9741
9838
|
type: object
|
|
9839
|
+
TmAddr:
|
|
9840
|
+
description: Address information (addrType in RFC 9361)
|
|
9841
|
+
properties:
|
|
9842
|
+
cc:
|
|
9843
|
+
description: ISO 3166-2 two-character country code
|
|
9844
|
+
maxLength: 2
|
|
9845
|
+
minLength: 2
|
|
9846
|
+
title: Cc
|
|
9847
|
+
type: string
|
|
9848
|
+
city:
|
|
9849
|
+
title: City
|
|
9850
|
+
type: string
|
|
9851
|
+
pc:
|
|
9852
|
+
anyOf:
|
|
9853
|
+
- type: string
|
|
9854
|
+
- type: 'null'
|
|
9855
|
+
title: Pc
|
|
9856
|
+
sp:
|
|
9857
|
+
anyOf:
|
|
9858
|
+
- type: string
|
|
9859
|
+
- type: 'null'
|
|
9860
|
+
title: Sp
|
|
9861
|
+
street:
|
|
9862
|
+
items:
|
|
9863
|
+
type: string
|
|
9864
|
+
maxItems: 3
|
|
9865
|
+
minItems: 1
|
|
9866
|
+
title: Street
|
|
9867
|
+
type: array
|
|
9868
|
+
required:
|
|
9869
|
+
- street
|
|
9870
|
+
- city
|
|
9871
|
+
- cc
|
|
9872
|
+
title: TmAddr
|
|
9873
|
+
type: object
|
|
9874
|
+
TmClaim:
|
|
9875
|
+
description: A single trademark claim within a notice (claimType in RFC 9361)
|
|
9876
|
+
properties:
|
|
9877
|
+
class_descs:
|
|
9878
|
+
description: Nice Classification descriptions
|
|
9879
|
+
items:
|
|
9880
|
+
$ref: '#/components/schemas/TmClassDesc'
|
|
9881
|
+
title: Class Descs
|
|
9882
|
+
type: array
|
|
9883
|
+
contacts:
|
|
9884
|
+
description: Zero or more contacts/representatives
|
|
9885
|
+
items:
|
|
9886
|
+
$ref: '#/components/schemas/TmContact'
|
|
9887
|
+
title: Contacts
|
|
9888
|
+
type: array
|
|
9889
|
+
goods_and_services:
|
|
9890
|
+
description: Full description of goods and services
|
|
9891
|
+
title: Goods And Services
|
|
9892
|
+
type: string
|
|
9893
|
+
holders:
|
|
9894
|
+
description: One or more holders of the mark
|
|
9895
|
+
items:
|
|
9896
|
+
$ref: '#/components/schemas/TmHolder'
|
|
9897
|
+
minItems: 1
|
|
9898
|
+
title: Holders
|
|
9899
|
+
type: array
|
|
9900
|
+
jur_desc:
|
|
9901
|
+
$ref: '#/components/schemas/TmJurDesc'
|
|
9902
|
+
description: Jurisdiction where the mark is protected
|
|
9903
|
+
mark_name:
|
|
9904
|
+
description: Mark text string
|
|
9905
|
+
title: Mark Name
|
|
9906
|
+
type: string
|
|
9907
|
+
not_exact_match:
|
|
9908
|
+
anyOf:
|
|
9909
|
+
- $ref: '#/components/schemas/TmNotExactMatch'
|
|
9910
|
+
- type: 'null'
|
|
9911
|
+
description: Present if claim added by non-exact match rule
|
|
9912
|
+
required:
|
|
9913
|
+
- mark_name
|
|
9914
|
+
- holders
|
|
9915
|
+
- jur_desc
|
|
9916
|
+
- goods_and_services
|
|
9917
|
+
title: TmClaim
|
|
9918
|
+
type: object
|
|
9919
|
+
TmClassDesc:
|
|
9920
|
+
description: Nice Classification description (classDescType in RFC 9361)
|
|
9921
|
+
properties:
|
|
9922
|
+
class_num:
|
|
9923
|
+
description: Nice Classification class number
|
|
9924
|
+
title: Class Num
|
|
9925
|
+
type: integer
|
|
9926
|
+
description:
|
|
9927
|
+
description: Description of the class in English
|
|
9928
|
+
title: Description
|
|
9929
|
+
type: string
|
|
9930
|
+
required:
|
|
9931
|
+
- class_num
|
|
9932
|
+
- description
|
|
9933
|
+
title: TmClassDesc
|
|
9934
|
+
type: object
|
|
9935
|
+
TmContact:
|
|
9936
|
+
description: Contact / representative of the mark (contactType in RFC 9361)
|
|
9937
|
+
properties:
|
|
9938
|
+
addr:
|
|
9939
|
+
$ref: '#/components/schemas/TmAddr'
|
|
9940
|
+
email:
|
|
9941
|
+
title: Email
|
|
9942
|
+
type: string
|
|
9943
|
+
fax:
|
|
9944
|
+
anyOf:
|
|
9945
|
+
- type: string
|
|
9946
|
+
- type: 'null'
|
|
9947
|
+
title: Fax
|
|
9948
|
+
name:
|
|
9949
|
+
title: Name
|
|
9950
|
+
type: string
|
|
9951
|
+
org:
|
|
9952
|
+
anyOf:
|
|
9953
|
+
- type: string
|
|
9954
|
+
- type: 'null'
|
|
9955
|
+
title: Org
|
|
9956
|
+
type:
|
|
9957
|
+
$ref: '#/components/schemas/ContactType'
|
|
9958
|
+
voice:
|
|
9959
|
+
title: Voice
|
|
9960
|
+
type: string
|
|
9961
|
+
required:
|
|
9962
|
+
- type
|
|
9963
|
+
- name
|
|
9964
|
+
- addr
|
|
9965
|
+
- voice
|
|
9966
|
+
- email
|
|
9967
|
+
title: TmContact
|
|
9968
|
+
type: object
|
|
9969
|
+
TmCourt:
|
|
9970
|
+
description: Court resolution reference (courtType in RFC 9361)
|
|
9971
|
+
properties:
|
|
9972
|
+
cc:
|
|
9973
|
+
description: ISO 3166-2 jurisdiction country code
|
|
9974
|
+
maxLength: 2
|
|
9975
|
+
minLength: 2
|
|
9976
|
+
title: Cc
|
|
9977
|
+
type: string
|
|
9978
|
+
court_name:
|
|
9979
|
+
description: Name of the court
|
|
9980
|
+
title: Court Name
|
|
9981
|
+
type: string
|
|
9982
|
+
ref_num:
|
|
9983
|
+
description: Reference number of the court resolution
|
|
9984
|
+
title: Ref Num
|
|
9985
|
+
type: string
|
|
9986
|
+
region:
|
|
9987
|
+
description: Region(s) within the jurisdiction
|
|
9988
|
+
items:
|
|
9989
|
+
type: string
|
|
9990
|
+
title: Region
|
|
9991
|
+
type: array
|
|
9992
|
+
required:
|
|
9993
|
+
- ref_num
|
|
9994
|
+
- cc
|
|
9995
|
+
- court_name
|
|
9996
|
+
title: TmCourt
|
|
9997
|
+
type: object
|
|
9998
|
+
TmHolder:
|
|
9999
|
+
description: Holder of the mark (holderType in RFC 9361). name or org must be
|
|
10000
|
+
set.
|
|
10001
|
+
properties:
|
|
10002
|
+
addr:
|
|
10003
|
+
$ref: '#/components/schemas/TmAddr'
|
|
10004
|
+
email:
|
|
10005
|
+
anyOf:
|
|
10006
|
+
- type: string
|
|
10007
|
+
- type: 'null'
|
|
10008
|
+
title: Email
|
|
10009
|
+
entitlement:
|
|
10010
|
+
$ref: '#/components/schemas/HolderEntitlement'
|
|
10011
|
+
fax:
|
|
10012
|
+
anyOf:
|
|
10013
|
+
- type: string
|
|
10014
|
+
- type: 'null'
|
|
10015
|
+
title: Fax
|
|
10016
|
+
name:
|
|
10017
|
+
anyOf:
|
|
10018
|
+
- type: string
|
|
10019
|
+
- type: 'null'
|
|
10020
|
+
title: Name
|
|
10021
|
+
org:
|
|
10022
|
+
anyOf:
|
|
10023
|
+
- type: string
|
|
10024
|
+
- type: 'null'
|
|
10025
|
+
title: Org
|
|
10026
|
+
voice:
|
|
10027
|
+
anyOf:
|
|
10028
|
+
- type: string
|
|
10029
|
+
- type: 'null'
|
|
10030
|
+
title: Voice
|
|
10031
|
+
required:
|
|
10032
|
+
- entitlement
|
|
10033
|
+
- addr
|
|
10034
|
+
title: TmHolder
|
|
10035
|
+
type: object
|
|
10036
|
+
TmJurDesc:
|
|
10037
|
+
description: Jurisdiction description (jurDescType in RFC 9361)
|
|
10038
|
+
properties:
|
|
10039
|
+
description:
|
|
10040
|
+
description: Name of jurisdiction in English
|
|
10041
|
+
title: Description
|
|
10042
|
+
type: string
|
|
10043
|
+
jur_cc:
|
|
10044
|
+
description: WIPO ST.3 two-character jurisdiction code
|
|
10045
|
+
maxLength: 2
|
|
10046
|
+
minLength: 2
|
|
10047
|
+
title: Jur Cc
|
|
10048
|
+
type: string
|
|
10049
|
+
required:
|
|
10050
|
+
- jur_cc
|
|
10051
|
+
- description
|
|
10052
|
+
title: TmJurDesc
|
|
10053
|
+
type: object
|
|
10054
|
+
TmNotExactMatch:
|
|
10055
|
+
description: Signals claim was added by non-exact match rules (noExactMatchType
|
|
10056
|
+
in RFC 9361)
|
|
10057
|
+
properties:
|
|
10058
|
+
court:
|
|
10059
|
+
items:
|
|
10060
|
+
$ref: '#/components/schemas/TmCourt'
|
|
10061
|
+
title: Court
|
|
10062
|
+
type: array
|
|
10063
|
+
intro:
|
|
10064
|
+
default: 'This domain name label has previously been found to be used or
|
|
10065
|
+
registered abusively against the following trademarks according to the
|
|
10066
|
+
referenced decisions:'
|
|
10067
|
+
description: Introductory text for the non-exact match section
|
|
10068
|
+
title: Intro
|
|
10069
|
+
type: string
|
|
10070
|
+
udrp:
|
|
10071
|
+
items:
|
|
10072
|
+
$ref: '#/components/schemas/TmUdrp'
|
|
10073
|
+
title: Udrp
|
|
10074
|
+
type: array
|
|
10075
|
+
title: TmNotExactMatch
|
|
10076
|
+
type: object
|
|
10077
|
+
TmUdrp:
|
|
10078
|
+
description: UDRP case reference (udrpType in RFC 9361)
|
|
10079
|
+
properties:
|
|
10080
|
+
case_no:
|
|
10081
|
+
description: UDRP case number
|
|
10082
|
+
title: Case No
|
|
10083
|
+
type: string
|
|
10084
|
+
udrp_provider:
|
|
10085
|
+
description: Name of the UDRP provider
|
|
10086
|
+
title: Udrp Provider
|
|
10087
|
+
type: string
|
|
10088
|
+
required:
|
|
10089
|
+
- case_no
|
|
10090
|
+
- udrp_provider
|
|
10091
|
+
title: TmUdrp
|
|
10092
|
+
type: object
|
|
9742
10093
|
TrademarkClaimsBase:
|
|
9743
10094
|
properties:
|
|
9744
10095
|
end_date:
|
|
@@ -10536,6 +10887,50 @@ components:
|
|
|
10536
10887
|
- type
|
|
10537
10888
|
title: ValidationError
|
|
10538
10889
|
type: object
|
|
10890
|
+
VerificationClaimType:
|
|
10891
|
+
enum:
|
|
10892
|
+
- name
|
|
10893
|
+
- address
|
|
10894
|
+
- email
|
|
10895
|
+
- phone
|
|
10896
|
+
title: VerificationClaimType
|
|
10897
|
+
type: string
|
|
10898
|
+
VerificationDeadline:
|
|
10899
|
+
properties:
|
|
10900
|
+
date:
|
|
10901
|
+
format: date-time
|
|
10902
|
+
title: Date
|
|
10903
|
+
type: string
|
|
10904
|
+
type:
|
|
10905
|
+
$ref: '#/components/schemas/VerificationDeadlineType'
|
|
10906
|
+
required:
|
|
10907
|
+
- type
|
|
10908
|
+
- date
|
|
10909
|
+
title: VerificationDeadline
|
|
10910
|
+
type: object
|
|
10911
|
+
VerificationDeadlineType:
|
|
10912
|
+
enum:
|
|
10913
|
+
- dedelegation
|
|
10914
|
+
- deletion
|
|
10915
|
+
title: VerificationDeadlineType
|
|
10916
|
+
type: string
|
|
10917
|
+
VerificationRegistrantDetails:
|
|
10918
|
+
properties:
|
|
10919
|
+
contact_id:
|
|
10920
|
+
title: Contact Id
|
|
10921
|
+
type: string
|
|
10922
|
+
email:
|
|
10923
|
+
title: Email
|
|
10924
|
+
type: string
|
|
10925
|
+
name:
|
|
10926
|
+
title: Name
|
|
10927
|
+
type: string
|
|
10928
|
+
required:
|
|
10929
|
+
- contact_id
|
|
10930
|
+
- name
|
|
10931
|
+
- email
|
|
10932
|
+
title: VerificationRegistrantDetails
|
|
10933
|
+
type: object
|
|
10539
10934
|
VerificationType:
|
|
10540
10935
|
enum:
|
|
10541
10936
|
- api
|
|
@@ -10772,7 +11167,7 @@ info:
|
|
|
10772
11167
|
\n\n"
|
|
10773
11168
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
10774
11169
|
title: OpusDNS API
|
|
10775
|
-
version: 2026-05-
|
|
11170
|
+
version: 2026-05-08-122221
|
|
10776
11171
|
x-logo:
|
|
10777
11172
|
altText: OpusDNS API Reference
|
|
10778
11173
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -17951,7 +18346,18 @@ paths:
|
|
|
17951
18346
|
tags:
|
|
17952
18347
|
- domain
|
|
17953
18348
|
post:
|
|
17954
|
-
description: Registers a new domain
|
|
18349
|
+
description: 'Registers a new domain.
|
|
18350
|
+
|
|
18351
|
+
|
|
18352
|
+
- **Premium domains** - when the registry classifies the domain as premium,
|
|
18353
|
+
an `expected_price` must be supplied to confirm the non-standard price returned
|
|
18354
|
+
by the availability check. See the [Premium domains](/products/domains/premium)
|
|
18355
|
+
guide for background on how premium domains are priced and registered.
|
|
18356
|
+
|
|
18357
|
+
- **Trademark claims (TMCH)** - when the TLD is in its claims phase and the
|
|
18358
|
+
domain matches a trademark in the Trademark Clearinghouse, a `claims_notice_acceptance_hash`
|
|
18359
|
+
must be supplied to acknowledge the corresponding claims notice. See the [Trademarked
|
|
18360
|
+
domains](/products/domains/trademarked-domains) guide for the full workflow.'
|
|
17955
18361
|
operationId: create_domain_v1_domains_post
|
|
17956
18362
|
requestBody:
|
|
17957
18363
|
content:
|
|
@@ -17969,48 +18375,87 @@ paths:
|
|
|
17969
18375
|
'400':
|
|
17970
18376
|
content:
|
|
17971
18377
|
application/problem+json:
|
|
17972
|
-
|
|
17973
|
-
|
|
17974
|
-
|
|
17975
|
-
|
|
17976
|
-
|
|
17977
|
-
|
|
17978
|
-
|
|
18378
|
+
examples:
|
|
18379
|
+
Domain Management Error:
|
|
18380
|
+
value:
|
|
18381
|
+
code: ERROR_PREMIUM_PRICE_NOT_APPLICABLE
|
|
18382
|
+
detail: 'Domain is not premium-priced; expected_price must not
|
|
18383
|
+
be supplied. Provided price: 100.00.'
|
|
18384
|
+
domain_name: example.com
|
|
18385
|
+
expected_price: '100.00'
|
|
18386
|
+
status: 400
|
|
18387
|
+
title: Domain Management Error
|
|
18388
|
+
type: premium-price-not-applicable
|
|
17979
18389
|
schema:
|
|
17980
18390
|
$ref: '#/components/schemas/Problem'
|
|
17981
18391
|
description: Bad Request
|
|
17982
18392
|
'404':
|
|
17983
18393
|
content:
|
|
17984
18394
|
application/problem+json:
|
|
17985
|
-
|
|
17986
|
-
|
|
17987
|
-
|
|
17988
|
-
|
|
17989
|
-
|
|
17990
|
-
|
|
17991
|
-
|
|
18395
|
+
examples:
|
|
18396
|
+
Claims Error:
|
|
18397
|
+
value:
|
|
18398
|
+
code: ERROR_CLAIMS_NOTICE_NOT_FOUND
|
|
18399
|
+
detail: 'Claims notice not found for claims key: Additional error
|
|
18400
|
+
context.'
|
|
18401
|
+
status: 404
|
|
18402
|
+
title: Claims Error
|
|
18403
|
+
type: claims-notice-not-found
|
|
18404
|
+
Contact Management Error:
|
|
18405
|
+
value:
|
|
18406
|
+
code: ERROR_CONTACT_NOT_FOUND
|
|
18407
|
+
contact_id: Additional error context.
|
|
18408
|
+
detail: Contact not found
|
|
18409
|
+
status: 404
|
|
18410
|
+
title: Contact Management Error
|
|
18411
|
+
type: contact-not-found
|
|
17992
18412
|
schema:
|
|
17993
18413
|
$ref: '#/components/schemas/Problem'
|
|
17994
18414
|
description: Not Found
|
|
17995
18415
|
'409':
|
|
18416
|
+
content:
|
|
18417
|
+
application/problem+json:
|
|
18418
|
+
examples:
|
|
18419
|
+
Domain Management Error:
|
|
18420
|
+
value:
|
|
18421
|
+
actual_price: '125.00'
|
|
18422
|
+
code: ERROR_PREMIUM_PRICE_MISMATCH
|
|
18423
|
+
detail: 'Premium domain requires price confirmation. Provided
|
|
18424
|
+
price: 100.00, correct price: 125.00. Use the domain check endpoint
|
|
18425
|
+
to get current premium pricing.'
|
|
18426
|
+
domain_name: premium.domain
|
|
18427
|
+
expected_price: '100.00'
|
|
18428
|
+
status: 409
|
|
18429
|
+
title: Domain Management Error
|
|
18430
|
+
type: premium-price-mismatch
|
|
18431
|
+
schema:
|
|
18432
|
+
$ref: '#/components/schemas/Problem'
|
|
18433
|
+
description: Conflict
|
|
18434
|
+
'422':
|
|
17996
18435
|
content:
|
|
17997
18436
|
application/problem+json:
|
|
17998
18437
|
example:
|
|
17999
|
-
code:
|
|
18000
|
-
detail:
|
|
18438
|
+
code: ERROR_CLAIMS_NOTICE_HASH_MISMATCH
|
|
18439
|
+
detail: The provided claims notice acceptance hash does not match
|
|
18001
18440
|
domain_name: Additional error context.
|
|
18002
|
-
status:
|
|
18441
|
+
status: 422
|
|
18003
18442
|
title: Domain Management Error
|
|
18004
|
-
type:
|
|
18443
|
+
type: claims-notice-hash-mismatch
|
|
18005
18444
|
schema:
|
|
18006
18445
|
$ref: '#/components/schemas/Problem'
|
|
18007
|
-
description:
|
|
18008
|
-
'
|
|
18446
|
+
description: Unprocessable Content
|
|
18447
|
+
'503':
|
|
18009
18448
|
content:
|
|
18010
18449
|
application/problem+json:
|
|
18450
|
+
example:
|
|
18451
|
+
code: ERROR_CLAIMS_SERVICE_ERROR
|
|
18452
|
+
detail: Additional error context.
|
|
18453
|
+
status: 503
|
|
18454
|
+
title: Claims Error
|
|
18455
|
+
type: claims-service
|
|
18011
18456
|
schema:
|
|
18012
|
-
$ref: '#/components/schemas/
|
|
18013
|
-
description:
|
|
18457
|
+
$ref: '#/components/schemas/Problem'
|
|
18458
|
+
description: Service Unavailable
|
|
18014
18459
|
security:
|
|
18015
18460
|
- OAuth2PasswordBearer: []
|
|
18016
18461
|
- APIKeyHeader: []
|
|
@@ -18019,22 +18464,30 @@ paths:
|
|
|
18019
18464
|
- domain
|
|
18020
18465
|
/v1/domains/check:
|
|
18021
18466
|
get:
|
|
18022
|
-
description:
|
|
18023
|
-
|
|
18024
|
-
|
|
18025
|
-
|
|
18026
|
-
|
|
18027
|
-
|
|
18028
|
-
|
|
18029
|
-
|
|
18030
|
-
|
|
18031
|
-
|
|
18032
|
-
|
|
18033
|
-
|
|
18034
|
-
|
|
18035
|
-
|
|
18036
|
-
|
|
18037
|
-
|
|
18467
|
+
description: 'Performs a real-time check against the authoritative registry
|
|
18468
|
+
for each domain and returns availability plus any registry-specific metadata
|
|
18469
|
+
needed to register it.
|
|
18470
|
+
|
|
18471
|
+
|
|
18472
|
+
For each domain the response includes:
|
|
18473
|
+
|
|
18474
|
+
- **Availability** - whether the domain can be registered, and the registry''s
|
|
18475
|
+
reason if not.
|
|
18476
|
+
|
|
18477
|
+
- **Premium status and pricing** - whether the domain is classified as premium
|
|
18478
|
+
by the registry, and if so, the price per action (create / renew / transfer
|
|
18479
|
+
/ restore). See the [Premium domains](/products/domains/premium) guide for
|
|
18480
|
+
background on how premium domains are priced and registered.
|
|
18481
|
+
|
|
18482
|
+
- **Trademark claims (TMCH)** - when the TLD is in its claims phase and the
|
|
18483
|
+
domain matches a trademark in the Trademark Clearinghouse, a `claims_key`
|
|
18484
|
+
is returned. See the [Trademarked domains](/products/domains/trademarked-domains)
|
|
18485
|
+
guide for the full workflow.
|
|
18486
|
+
|
|
18487
|
+
|
|
18488
|
+
Domains are queried in parallel, grouped by registry connection. Availability
|
|
18489
|
+
and metadata reflect the registry''s state at the moment of the call and are
|
|
18490
|
+
not cached.'
|
|
18038
18491
|
operationId: epp_check_domain_v1_domains_check_get
|
|
18039
18492
|
parameters:
|
|
18040
18493
|
- description: '
|
|
@@ -18096,6 +18549,65 @@ paths:
|
|
|
18096
18549
|
summary: Check domain availability and registration metadata
|
|
18097
18550
|
tags:
|
|
18098
18551
|
- domain
|
|
18552
|
+
/v1/domains/claims-notices:
|
|
18553
|
+
post:
|
|
18554
|
+
description: Retrieves the trademark claims notice for a `claims_key` returned
|
|
18555
|
+
during a domain availability check. The response contains a `claims_notice_acceptance_hash`
|
|
18556
|
+
to acknowledge the notice when registering the domain, a ready-to-display
|
|
18557
|
+
`rendered_html`, and the structured fields needed to render a custom notice.
|
|
18558
|
+
See the [Trademarked domains](/products/domains/trademarked-domains) guide
|
|
18559
|
+
for the full workflow.
|
|
18560
|
+
operationId: get_claims_notices_v1_domains_claims_notices_post
|
|
18561
|
+
requestBody:
|
|
18562
|
+
content:
|
|
18563
|
+
application/json:
|
|
18564
|
+
schema:
|
|
18565
|
+
$ref: '#/components/schemas/ClaimsNoticesRequest'
|
|
18566
|
+
required: true
|
|
18567
|
+
responses:
|
|
18568
|
+
'200':
|
|
18569
|
+
content:
|
|
18570
|
+
application/json:
|
|
18571
|
+
schema:
|
|
18572
|
+
$ref: '#/components/schemas/ClaimsNoticesResponse'
|
|
18573
|
+
description: Successful Response
|
|
18574
|
+
'404':
|
|
18575
|
+
content:
|
|
18576
|
+
application/problem+json:
|
|
18577
|
+
example:
|
|
18578
|
+
code: ERROR_CLAIMS_NOTICE_NOT_FOUND
|
|
18579
|
+
detail: 'Claims notice not found for claims key: Additional error
|
|
18580
|
+
context.'
|
|
18581
|
+
status: 404
|
|
18582
|
+
title: Claims Error
|
|
18583
|
+
type: claims-notice-not-found
|
|
18584
|
+
schema:
|
|
18585
|
+
$ref: '#/components/schemas/Problem'
|
|
18586
|
+
description: Not Found
|
|
18587
|
+
'422':
|
|
18588
|
+
content:
|
|
18589
|
+
application/problem+json:
|
|
18590
|
+
schema:
|
|
18591
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
18592
|
+
description: Validation Error
|
|
18593
|
+
'503':
|
|
18594
|
+
content:
|
|
18595
|
+
application/problem+json:
|
|
18596
|
+
example:
|
|
18597
|
+
code: ERROR_CLAIMS_SERVICE_ERROR
|
|
18598
|
+
detail: Additional error context.
|
|
18599
|
+
status: 503
|
|
18600
|
+
title: Claims Error
|
|
18601
|
+
type: claims-service
|
|
18602
|
+
schema:
|
|
18603
|
+
$ref: '#/components/schemas/Problem'
|
|
18604
|
+
description: Service Unavailable
|
|
18605
|
+
security:
|
|
18606
|
+
- OAuth2PasswordBearer: []
|
|
18607
|
+
- APIKeyHeader: []
|
|
18608
|
+
summary: Retrieve claims notices from claim keys
|
|
18609
|
+
tags:
|
|
18610
|
+
- domain
|
|
18099
18611
|
/v1/domains/summary:
|
|
18100
18612
|
get:
|
|
18101
18613
|
description: Retrieves a summary of domains including counts by status, TLD,
|
|
@@ -20112,7 +20624,7 @@ paths:
|
|
|
20112
20624
|
content:
|
|
20113
20625
|
application/json:
|
|
20114
20626
|
schema:
|
|
20115
|
-
$ref: '#/components/schemas/
|
|
20627
|
+
$ref: '#/components/schemas/EventResponse'
|
|
20116
20628
|
description: Successful Response
|
|
20117
20629
|
'401':
|
|
20118
20630
|
content:
|