@opusdns/api 0.305.0 → 0.306.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 +255 -1
- package/src/helpers/keys.ts +428 -0
- package/src/helpers/requests.d.ts +54 -1
- package/src/helpers/responses.d.ts +111 -1
- package/src/helpers/schemas-arrays.d.ts +29 -1
- package/src/helpers/schemas.d.ts +128 -0
- package/src/openapi.yaml +268 -4
- package/src/schema.d.ts +155 -0
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
* This file is auto-generated from the OpenAPI specification.
|
|
22
22
|
* Do not edit manually.
|
|
23
23
|
*/
|
|
24
|
-
import { StatusTagType, ContactIncludeField, ZoneIncludeField, DomainIncludeField, DomainDnssecData, DomainDnssecDataCreate, JobStatus, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, ReportType, ReportStatus, TagType, TldResponseShort, TmClaim, ClaimsNotice, AttributeCondition, DomainContactType, ContactCreateBulkInstance, ContactAttributeLinkDetail, StatusTag, TagEnriched, ContactAttributeDefinition, PostalAddressType, ContactConfigBase, Context, Conversation, DuplicateCommand, CommandError, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsZoneCreateBulkInstance, DnsRecordPatchOp, DnsZonePatchRecordsBulkInstance, DnsRrsetPatchOp, DnsZonePatchRrsetsBulkInstance, DnsRrset, DnsZoneUpdateBulkInstance, DomainAvailabilityCheck, ContactHandle, Nameserver, DomainCreateBulkInstance, BrowserStatsBucket, GeoStatsBucket, TimeSeriesBucket, DomainForwardPatchOp, PlatformStatsBucket, HttpRedirectRequest, HttpRedirectList, ReferrerStatsBucket, StatusCodeStatsBucket, UserAgentStatsBucket, VisitsByKeyBucket, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainSearchSuggestionWithPrice, DomainStatus, DomainTransferBulkInstance, DomainClientStatus, DomainUpdateBulkInstance, VerificationRegistrantDetails, VerificationClaimType, VerificationDeadline, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAliasMetrics, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LegalRequirementOperationType, LocalPresenceRequirementType, MemoryFact, Message, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactAttributeSet, Contact, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, JobBatchMetadata, Job, ObjectLog, Organization, Parking, RequestHistory, Tag, UserPublic, ParkingCreateBulkInstance, ParkingDeleteBulkInstance, ParkingDisableBulkInstance, ParkingEnableBulkInstance, Period, Permission, PremiumAffectsType, PremiumPriceEntryRes, PremiumPricingAction, PublicReportRes, Relation, LegalRequirementBase, TldBase, TmClassDesc, TmContact, TmHolder, TmCourt, TmUdrp, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
|
|
24
|
+
import { StatusTagType, ContactIncludeField, ZoneIncludeField, DomainIncludeField, DomainDnssecData, DomainDnssecDataCreate, JobStatus, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, ReportType, ReportStatus, TagType, TldResponseShort, TmClaim, ClaimsNotice, ContactAttestVerificationReq, ContactVerificationStatus, AttributeCondition, DomainContactType, ContactCreateBulkInstance, ContactAttributeLinkDetail, StatusTag, TagEnriched, ContactAttributeDefinition, PostalAddressType, ContactConfigBase, Context, Conversation, DuplicateCommand, CommandError, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsZoneCreateBulkInstance, DnsRecordPatchOp, DnsZonePatchRecordsBulkInstance, DnsRrsetPatchOp, DnsZonePatchRrsetsBulkInstance, DnsRrset, DnsZoneUpdateBulkInstance, DomainAvailabilityCheck, ContactHandle, Nameserver, DomainCreateBulkInstance, BrowserStatsBucket, GeoStatsBucket, TimeSeriesBucket, DomainForwardPatchOp, PlatformStatsBucket, HttpRedirectRequest, HttpRedirectList, ReferrerStatsBucket, StatusCodeStatsBucket, UserAgentStatsBucket, VisitsByKeyBucket, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainSearchSuggestionWithPrice, DomainStatus, DomainTransferBulkInstance, DomainClientStatus, DomainUpdateBulkInstance, VerificationRegistrantDetails, VerificationClaimType, VerificationDeadline, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAliasMetrics, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LegalRequirementOperationType, LocalPresenceRequirementType, MemoryFact, Message, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactAttributeSet, Contact, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, JobBatchMetadata, Job, ObjectLog, Organization, Parking, RequestHistory, Tag, UserPublic, ParkingCreateBulkInstance, ParkingDeleteBulkInstance, ParkingDisableBulkInstance, ParkingEnableBulkInstance, Period, Permission, PremiumAffectsType, PremiumPriceEntryRes, PremiumPricingAction, PublicReportRes, Relation, LegalRequirementBase, TldBase, TmClassDesc, TmContact, TmHolder, TmCourt, TmUdrp, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* StatusTagType
|
|
@@ -247,6 +247,34 @@ export type TmClaimArray = TmClaim[];
|
|
|
247
247
|
* @see {@link ClaimsNotice} - The individual ClaimsNotice type definition
|
|
248
248
|
*/
|
|
249
249
|
export type ClaimsNoticeArray = ClaimsNotice[];
|
|
250
|
+
/**
|
|
251
|
+
* ContactAttestVerificationReq
|
|
252
|
+
*
|
|
253
|
+
* @remarks
|
|
254
|
+
* Array type for ContactAttestVerificationReq objects. Used when the API returns a collection of ContactAttestVerificationReq instances.
|
|
255
|
+
*
|
|
256
|
+
* @example
|
|
257
|
+
* ```typescript
|
|
258
|
+
* const items: ContactAttestVerificationReqArray = await api.getContactAttestVerificationReqs();
|
|
259
|
+
* ```
|
|
260
|
+
*
|
|
261
|
+
* @see {@link ContactAttestVerificationReq} - The individual ContactAttestVerificationReq type definition
|
|
262
|
+
*/
|
|
263
|
+
export type ContactAttestVerificationReqArray = ContactAttestVerificationReq[];
|
|
264
|
+
/**
|
|
265
|
+
* ContactVerificationStatus
|
|
266
|
+
*
|
|
267
|
+
* @remarks
|
|
268
|
+
* Array type for ContactVerificationStatus objects. Used when the API returns a collection of ContactVerificationStatus instances.
|
|
269
|
+
*
|
|
270
|
+
* @example
|
|
271
|
+
* ```typescript
|
|
272
|
+
* const items: ContactVerificationStatusArray = await api.getContactVerificationStatuss();
|
|
273
|
+
* ```
|
|
274
|
+
*
|
|
275
|
+
* @see {@link ContactVerificationStatus} - The individual ContactVerificationStatus type definition
|
|
276
|
+
*/
|
|
277
|
+
export type ContactVerificationStatusArray = ContactVerificationStatus[];
|
|
250
278
|
/**
|
|
251
279
|
* AttributeCondition
|
|
252
280
|
*
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -362,6 +362,54 @@ export type ComplianceStatus = components['schemas']['ComplianceStatus'];
|
|
|
362
362
|
* @see {@link components} - The OpenAPI components schema definition
|
|
363
363
|
*/
|
|
364
364
|
export type ConditionOperator = components['schemas']['ConditionOperator'];
|
|
365
|
+
/**
|
|
366
|
+
* ContactAttestReq
|
|
367
|
+
*
|
|
368
|
+
* @remarks
|
|
369
|
+
* Type alias for the `ContactAttestReq` OpenAPI schema.
|
|
370
|
+
* This type represents contactattestreq data structures used in API requests and responses.
|
|
371
|
+
*
|
|
372
|
+
* @example
|
|
373
|
+
* ```typescript
|
|
374
|
+
* const response = await api.getContactAttestReq();
|
|
375
|
+
* const item: ContactAttestReq = response.results;
|
|
376
|
+
* ```
|
|
377
|
+
*
|
|
378
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
379
|
+
*/
|
|
380
|
+
export type ContactAttestReq = components['schemas']['ContactAttestReq'];
|
|
381
|
+
/**
|
|
382
|
+
* ContactAttestRes
|
|
383
|
+
*
|
|
384
|
+
* @remarks
|
|
385
|
+
* Type alias for the `ContactAttestRes` OpenAPI schema.
|
|
386
|
+
* This type represents contactattestres data structures used in API requests and responses.
|
|
387
|
+
*
|
|
388
|
+
* @example
|
|
389
|
+
* ```typescript
|
|
390
|
+
* const response = await api.getContactAttestRes();
|
|
391
|
+
* const item: ContactAttestRes = response.results;
|
|
392
|
+
* ```
|
|
393
|
+
*
|
|
394
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
395
|
+
*/
|
|
396
|
+
export type ContactAttestRes = components['schemas']['ContactAttestRes'];
|
|
397
|
+
/**
|
|
398
|
+
* ContactAttestVerificationReq
|
|
399
|
+
*
|
|
400
|
+
* @remarks
|
|
401
|
+
* Type alias for the `ContactAttestVerificationReq` OpenAPI schema.
|
|
402
|
+
* This type represents contactattestverificationreq data structures used in API requests and responses.
|
|
403
|
+
*
|
|
404
|
+
* @example
|
|
405
|
+
* ```typescript
|
|
406
|
+
* const response = await api.getContactAttestVerificationReq();
|
|
407
|
+
* const item: ContactAttestVerificationReq = response.results;
|
|
408
|
+
* ```
|
|
409
|
+
*
|
|
410
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
411
|
+
*/
|
|
412
|
+
export type ContactAttestVerificationReq = components['schemas']['ContactAttestVerificationReq'];
|
|
365
413
|
/**
|
|
366
414
|
* ContactAttributeDefinition. Definition of a possible attribute for a TLD.
|
|
367
415
|
*
|
|
@@ -762,6 +810,22 @@ export type ContactType = components['schemas']['ContactType'];
|
|
|
762
810
|
* @see {@link components} - The OpenAPI components schema definition
|
|
763
811
|
*/
|
|
764
812
|
export type ContactVerificationApi = components['schemas']['ContactVerificationApiResponse'];
|
|
813
|
+
/**
|
|
814
|
+
* ContactVerificationClaim
|
|
815
|
+
*
|
|
816
|
+
* @remarks
|
|
817
|
+
* Type alias for the `ContactVerificationClaim` OpenAPI schema.
|
|
818
|
+
* This type represents contactverificationclaim data structures used in API requests and responses.
|
|
819
|
+
*
|
|
820
|
+
* @example
|
|
821
|
+
* ```typescript
|
|
822
|
+
* const response = await api.getContactVerificationClaim();
|
|
823
|
+
* const item: ContactVerificationClaim = response.results;
|
|
824
|
+
* ```
|
|
825
|
+
*
|
|
826
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
827
|
+
*/
|
|
828
|
+
export type ContactVerificationClaim = components['schemas']['ContactVerificationClaim'];
|
|
765
829
|
/**
|
|
766
830
|
* ContactVerificationEmailResponse
|
|
767
831
|
*
|
|
@@ -778,6 +842,38 @@ export type ContactVerificationApi = components['schemas']['ContactVerificationA
|
|
|
778
842
|
* @see {@link components} - The OpenAPI components schema definition
|
|
779
843
|
*/
|
|
780
844
|
export type ContactVerificationEmail = components['schemas']['ContactVerificationEmailResponse'];
|
|
845
|
+
/**
|
|
846
|
+
* ContactVerificationMethod
|
|
847
|
+
*
|
|
848
|
+
* @remarks
|
|
849
|
+
* Type alias for the `ContactVerificationMethod` OpenAPI schema.
|
|
850
|
+
* This type represents contactverificationmethod data structures used in API requests and responses.
|
|
851
|
+
*
|
|
852
|
+
* @example
|
|
853
|
+
* ```typescript
|
|
854
|
+
* const response = await api.getContactVerificationMethod();
|
|
855
|
+
* const item: ContactVerificationMethod = response.results;
|
|
856
|
+
* ```
|
|
857
|
+
*
|
|
858
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
859
|
+
*/
|
|
860
|
+
export type ContactVerificationMethod = components['schemas']['ContactVerificationMethod'];
|
|
861
|
+
/**
|
|
862
|
+
* ContactVerificationProof
|
|
863
|
+
*
|
|
864
|
+
* @remarks
|
|
865
|
+
* Type alias for the `ContactVerificationProof` OpenAPI schema.
|
|
866
|
+
* This type represents contactverificationproof data structures used in API requests and responses.
|
|
867
|
+
*
|
|
868
|
+
* @example
|
|
869
|
+
* ```typescript
|
|
870
|
+
* const response = await api.getContactVerificationProof();
|
|
871
|
+
* const item: ContactVerificationProof = response.results;
|
|
872
|
+
* ```
|
|
873
|
+
*
|
|
874
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
875
|
+
*/
|
|
876
|
+
export type ContactVerificationProof = components['schemas']['ContactVerificationProof'];
|
|
781
877
|
/**
|
|
782
878
|
* ContactVerificationResponse
|
|
783
879
|
*
|
|
@@ -794,6 +890,38 @@ export type ContactVerificationEmail = components['schemas']['ContactVerificatio
|
|
|
794
890
|
* @see {@link components} - The OpenAPI components schema definition
|
|
795
891
|
*/
|
|
796
892
|
export type ContactVerification = components['schemas']['ContactVerificationResponse'];
|
|
893
|
+
/**
|
|
894
|
+
* ContactVerificationState
|
|
895
|
+
*
|
|
896
|
+
* @remarks
|
|
897
|
+
* Type alias for the `ContactVerificationState` OpenAPI schema.
|
|
898
|
+
* This type represents contactverificationstate data structures used in API requests and responses.
|
|
899
|
+
*
|
|
900
|
+
* @example
|
|
901
|
+
* ```typescript
|
|
902
|
+
* const response = await api.getContactVerificationState();
|
|
903
|
+
* const item: ContactVerificationState = response.results;
|
|
904
|
+
* ```
|
|
905
|
+
*
|
|
906
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
907
|
+
*/
|
|
908
|
+
export type ContactVerificationState = components['schemas']['ContactVerificationState'];
|
|
909
|
+
/**
|
|
910
|
+
* ContactVerificationStatus
|
|
911
|
+
*
|
|
912
|
+
* @remarks
|
|
913
|
+
* Type alias for the `ContactVerificationStatus` OpenAPI schema.
|
|
914
|
+
* This type represents contactverificationstatus data structures used in API requests and responses.
|
|
915
|
+
*
|
|
916
|
+
* @example
|
|
917
|
+
* ```typescript
|
|
918
|
+
* const response = await api.getContactVerificationStatus();
|
|
919
|
+
* const item: ContactVerificationStatus = response.results;
|
|
920
|
+
* ```
|
|
921
|
+
*
|
|
922
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
923
|
+
*/
|
|
924
|
+
export type ContactVerificationStatus = components['schemas']['ContactVerificationStatus'];
|
|
797
925
|
/**
|
|
798
926
|
* ContactsBase
|
|
799
927
|
*
|
package/src/openapi.yaml
CHANGED
|
@@ -468,6 +468,50 @@ components:
|
|
|
468
468
|
- not_in
|
|
469
469
|
title: ConditionOperator
|
|
470
470
|
type: string
|
|
471
|
+
ContactAttestReq:
|
|
472
|
+
properties:
|
|
473
|
+
attestations:
|
|
474
|
+
items:
|
|
475
|
+
$ref: '#/components/schemas/ContactAttestVerificationReq'
|
|
476
|
+
maxItems: 50
|
|
477
|
+
minItems: 0
|
|
478
|
+
title: Attestations
|
|
479
|
+
type: array
|
|
480
|
+
required:
|
|
481
|
+
- attestations
|
|
482
|
+
title: ContactAttestReq
|
|
483
|
+
type: object
|
|
484
|
+
ContactAttestRes:
|
|
485
|
+
properties:
|
|
486
|
+
verifications:
|
|
487
|
+
items:
|
|
488
|
+
$ref: '#/components/schemas/ContactVerificationStatus'
|
|
489
|
+
title: Verifications
|
|
490
|
+
type: array
|
|
491
|
+
required:
|
|
492
|
+
- verifications
|
|
493
|
+
title: ContactAttestRes
|
|
494
|
+
type: object
|
|
495
|
+
ContactAttestVerificationReq:
|
|
496
|
+
properties:
|
|
497
|
+
attestation_reference:
|
|
498
|
+
maxLength: 255
|
|
499
|
+
minLength: 0
|
|
500
|
+
title: Attestation Reference
|
|
501
|
+
type: string
|
|
502
|
+
claim:
|
|
503
|
+
$ref: '#/components/schemas/ContactVerificationClaim'
|
|
504
|
+
method:
|
|
505
|
+
$ref: '#/components/schemas/ContactVerificationMethod'
|
|
506
|
+
proof:
|
|
507
|
+
$ref: '#/components/schemas/ContactVerificationProof'
|
|
508
|
+
required:
|
|
509
|
+
- claim
|
|
510
|
+
- method
|
|
511
|
+
- proof
|
|
512
|
+
- attestation_reference
|
|
513
|
+
title: ContactAttestVerificationReq
|
|
514
|
+
type: object
|
|
471
515
|
ContactAttributeDefinition:
|
|
472
516
|
description: Definition of a possible attribute for a TLD.
|
|
473
517
|
properties:
|
|
@@ -1546,6 +1590,15 @@ components:
|
|
|
1546
1590
|
- type
|
|
1547
1591
|
title: ContactVerificationApiResponse
|
|
1548
1592
|
type: object
|
|
1593
|
+
ContactVerificationClaim:
|
|
1594
|
+
enum:
|
|
1595
|
+
- NAME
|
|
1596
|
+
- ADDRESS
|
|
1597
|
+
- EMAIL
|
|
1598
|
+
- PHONE
|
|
1599
|
+
- LEGAL_ENTITY
|
|
1600
|
+
title: ContactVerificationClaim
|
|
1601
|
+
type: string
|
|
1549
1602
|
ContactVerificationEmailResponse:
|
|
1550
1603
|
properties:
|
|
1551
1604
|
canceled_on:
|
|
@@ -1602,6 +1655,40 @@ components:
|
|
|
1602
1655
|
- type
|
|
1603
1656
|
title: ContactVerificationEmailResponse
|
|
1604
1657
|
type: object
|
|
1658
|
+
ContactVerificationMethod:
|
|
1659
|
+
enum:
|
|
1660
|
+
- AUTH
|
|
1661
|
+
- VDIG
|
|
1662
|
+
- ELECTRONIC_DOCUMENT
|
|
1663
|
+
- PHYSICAL_DOCUMENT
|
|
1664
|
+
- BVR
|
|
1665
|
+
- PVR
|
|
1666
|
+
- DATA
|
|
1667
|
+
- REACHABILITY
|
|
1668
|
+
title: ContactVerificationMethod
|
|
1669
|
+
type: string
|
|
1670
|
+
ContactVerificationProof:
|
|
1671
|
+
enum:
|
|
1672
|
+
- IDCARD
|
|
1673
|
+
- PASSPORT
|
|
1674
|
+
- POPULATION_REGISTER
|
|
1675
|
+
- RESIDENCE_PERMIT
|
|
1676
|
+
- PROOF_OF_ARRIVAL
|
|
1677
|
+
- DRIVERS_LICENCE
|
|
1678
|
+
- COMPANY_REGISTER
|
|
1679
|
+
- COMPANY_STATEMENT
|
|
1680
|
+
- BANK_ACCOUNT
|
|
1681
|
+
- ONLINE_PAYMENT_ACCOUNT
|
|
1682
|
+
- UTILITY_ACCOUNT
|
|
1683
|
+
- BANK_STATEMENT
|
|
1684
|
+
- TAX_STATEMENT
|
|
1685
|
+
- WRITTEN_ATTESTATION
|
|
1686
|
+
- DIGITAL_ATTESTATION
|
|
1687
|
+
- POSTAL_VER_TRANSACTION_LOG
|
|
1688
|
+
- EMAIL_VER_TRANSACTION_LOG
|
|
1689
|
+
- ADDRESS_DATABASE
|
|
1690
|
+
title: ContactVerificationProof
|
|
1691
|
+
type: string
|
|
1605
1692
|
ContactVerificationResponse:
|
|
1606
1693
|
properties:
|
|
1607
1694
|
canceled_on:
|
|
@@ -1658,6 +1745,50 @@ components:
|
|
|
1658
1745
|
- type
|
|
1659
1746
|
title: ContactVerificationResponse
|
|
1660
1747
|
type: object
|
|
1748
|
+
ContactVerificationState:
|
|
1749
|
+
enum:
|
|
1750
|
+
- UNVERIFIED
|
|
1751
|
+
- VERIFIED
|
|
1752
|
+
- IN_PROGRESS
|
|
1753
|
+
- EXPIRED
|
|
1754
|
+
title: ContactVerificationState
|
|
1755
|
+
type: string
|
|
1756
|
+
ContactVerificationStatus:
|
|
1757
|
+
properties:
|
|
1758
|
+
attestation_reference:
|
|
1759
|
+
anyOf:
|
|
1760
|
+
- type: string
|
|
1761
|
+
- type: 'null'
|
|
1762
|
+
title: Attestation Reference
|
|
1763
|
+
claim:
|
|
1764
|
+
$ref: '#/components/schemas/ContactVerificationClaim'
|
|
1765
|
+
expires_on:
|
|
1766
|
+
anyOf:
|
|
1767
|
+
- format: date-time
|
|
1768
|
+
type: string
|
|
1769
|
+
- type: 'null'
|
|
1770
|
+
title: Expires On
|
|
1771
|
+
method:
|
|
1772
|
+
anyOf:
|
|
1773
|
+
- $ref: '#/components/schemas/ContactVerificationMethod'
|
|
1774
|
+
- type: 'null'
|
|
1775
|
+
proof:
|
|
1776
|
+
anyOf:
|
|
1777
|
+
- $ref: '#/components/schemas/ContactVerificationProof'
|
|
1778
|
+
- type: 'null'
|
|
1779
|
+
state:
|
|
1780
|
+
$ref: '#/components/schemas/ContactVerificationState'
|
|
1781
|
+
verified_on:
|
|
1782
|
+
anyOf:
|
|
1783
|
+
- format: date-time
|
|
1784
|
+
type: string
|
|
1785
|
+
- type: 'null'
|
|
1786
|
+
title: Verified On
|
|
1787
|
+
required:
|
|
1788
|
+
- claim
|
|
1789
|
+
- state
|
|
1790
|
+
title: ContactVerificationStatus
|
|
1791
|
+
type: object
|
|
1661
1792
|
ContactsBase:
|
|
1662
1793
|
properties:
|
|
1663
1794
|
authinfo_required:
|
|
@@ -11355,7 +11486,7 @@ info:
|
|
|
11355
11486
|
\n\n"
|
|
11356
11487
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
11357
11488
|
title: OpusDNS API
|
|
11358
|
-
version: 2026-05-18-
|
|
11489
|
+
version: 2026-05-18-161414
|
|
11359
11490
|
x-logo:
|
|
11360
11491
|
altText: OpusDNS API Reference
|
|
11361
11492
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -14431,6 +14562,87 @@ paths:
|
|
|
14431
14562
|
summary: Complete contact verification by contact ID
|
|
14432
14563
|
tags:
|
|
14433
14564
|
- contact
|
|
14565
|
+
/v1/contacts/{contact_id}/verifications/attest:
|
|
14566
|
+
post:
|
|
14567
|
+
description: Submit one or more contact-verification attestations. Returns the
|
|
14568
|
+
per-claim verification state.
|
|
14569
|
+
operationId: attest_contact_verification_v1_contacts__contact_id__verifications_attest_post
|
|
14570
|
+
parameters:
|
|
14571
|
+
- in: path
|
|
14572
|
+
name: contact_id
|
|
14573
|
+
required: true
|
|
14574
|
+
schema:
|
|
14575
|
+
examples:
|
|
14576
|
+
- contact_01h45ytscbebyvny4gc8cr8ma2
|
|
14577
|
+
format: typeid
|
|
14578
|
+
pattern: ^contact_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
14579
|
+
title: Contact Id
|
|
14580
|
+
type: string
|
|
14581
|
+
x-typeid-prefix: contact
|
|
14582
|
+
requestBody:
|
|
14583
|
+
content:
|
|
14584
|
+
application/json:
|
|
14585
|
+
schema:
|
|
14586
|
+
$ref: '#/components/schemas/ContactAttestReq'
|
|
14587
|
+
required: true
|
|
14588
|
+
responses:
|
|
14589
|
+
'200':
|
|
14590
|
+
content:
|
|
14591
|
+
application/json:
|
|
14592
|
+
schema:
|
|
14593
|
+
$ref: '#/components/schemas/ContactAttestRes'
|
|
14594
|
+
description: Successful Response
|
|
14595
|
+
'400':
|
|
14596
|
+
content:
|
|
14597
|
+
application/problem+json:
|
|
14598
|
+
example:
|
|
14599
|
+
code: ERROR_DOMAIN_VERIFICATION_INCONSISTENT_METHOD_PROOF
|
|
14600
|
+
detail: All attestations in a single submission must share the same
|
|
14601
|
+
method and proof. Submit separate requests if you used different
|
|
14602
|
+
methods or proofs.
|
|
14603
|
+
domain_name: Additional error context.
|
|
14604
|
+
status: 400
|
|
14605
|
+
title: Domain Verification Inconsistent Method/Proof
|
|
14606
|
+
type: domain-verification-inconsistent-method-proof
|
|
14607
|
+
schema:
|
|
14608
|
+
$ref: '#/components/schemas/Problem'
|
|
14609
|
+
description: Bad Request
|
|
14610
|
+
'401':
|
|
14611
|
+
content:
|
|
14612
|
+
application/problem+json:
|
|
14613
|
+
example:
|
|
14614
|
+
code: ERROR_AUTHENTICATION
|
|
14615
|
+
detail: Additional error context.
|
|
14616
|
+
status: 401
|
|
14617
|
+
title: Authentication Error
|
|
14618
|
+
type: authentication
|
|
14619
|
+
schema:
|
|
14620
|
+
$ref: '#/components/schemas/Problem'
|
|
14621
|
+
description: Unauthorized
|
|
14622
|
+
'422':
|
|
14623
|
+
content:
|
|
14624
|
+
application/problem+json:
|
|
14625
|
+
schema:
|
|
14626
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
14627
|
+
description: Validation Error
|
|
14628
|
+
'502':
|
|
14629
|
+
content:
|
|
14630
|
+
application/problem+json:
|
|
14631
|
+
example:
|
|
14632
|
+
code: ERROR_CONTACT_VERIFICATION_UPSTREAM_ERROR
|
|
14633
|
+
detail: Additional error context.
|
|
14634
|
+
status: 502
|
|
14635
|
+
title: Contact Verification Service Error
|
|
14636
|
+
type: contact-verification-upstream
|
|
14637
|
+
schema:
|
|
14638
|
+
$ref: '#/components/schemas/Problem'
|
|
14639
|
+
description: Bad Gateway
|
|
14640
|
+
security:
|
|
14641
|
+
- OAuth2PasswordBearer: []
|
|
14642
|
+
- APIKeyHeader: []
|
|
14643
|
+
summary: Attest a contact verification
|
|
14644
|
+
tags:
|
|
14645
|
+
- contact
|
|
14434
14646
|
/v1/dns:
|
|
14435
14647
|
get:
|
|
14436
14648
|
operationId: list_zones_v1_dns_get
|
|
@@ -25344,9 +25556,61 @@ tags:
|
|
|
25344
25556
|
\n }\n }\n ]\n }\n ]\n }\n}\n```\n"
|
|
25345
25557
|
name: jobs
|
|
25346
25558
|
x-displayName: Jobs
|
|
25347
|
-
- description:
|
|
25348
|
-
|
|
25349
|
-
|
|
25559
|
+
- description: "Endpoints for creating and managing contacts.\n\n### Contact Verification\
|
|
25560
|
+
\ Attestation\n\n`POST /v1/contacts/{contact_id}/verifications/attest` submits\
|
|
25561
|
+
\ attestations for a contact. The request is forwarded synchronously to the contact-verification\
|
|
25562
|
+
\ service, which is the source of truth for the response. When DENIC is among\
|
|
25563
|
+
\ the registries that flagged the contact for verification, OpusDNS additionally\
|
|
25564
|
+
\ queues a registry-side attest job behind the scenes.\n\n#### Workflow\n\nWhen\
|
|
25565
|
+
\ a registry signals that a contact requires verification (e.g. DENIC's `contactVerificationRequired`\
|
|
25566
|
+
\ notification), OpusDNS marks each affected domain with the `VERIFICATION_REQUIRED`\
|
|
25567
|
+
\ status tag. Submit attestations via this endpoint and the response reports the\
|
|
25568
|
+
\ resulting per-claim verification state.\n\n#### Request format\n\nThe request\
|
|
25569
|
+
\ body wraps the attestations under `attestations`. Fields are snake_case and\
|
|
25570
|
+
\ enum values are UPPERCASE.\n\n```json\n{\n \"attestations\": [\n {\n \
|
|
25571
|
+
\ \"claim\": \"NAME\",\n \"method\": \"AUTH\",\n \"proof\": \"IDCARD\"\
|
|
25572
|
+
,\n \"attestation_reference\": \"ticket-12345\"\n }\n ]\n}\n```\n\n|\
|
|
25573
|
+
\ Field | Type | Notes |\n|-------|------|-------|\n| `claim` | enum | `NAME`,\
|
|
25574
|
+
\ `ADDRESS`, `EMAIL`, `PHONE`, `LEGAL_ENTITY` |\n| `method` | enum | `AUTH`, `VDIG`,\
|
|
25575
|
+
\ `ELECTRONIC_DOCUMENT`, `PHYSICAL_DOCUMENT`, `BVR`, `PVR`, `DATA`, `REACHABILITY`\
|
|
25576
|
+
\ |\n| `proof` | enum | `IDCARD`, `PASSPORT`, `POPULATION_REGISTER`, `RESIDENCE_PERMIT`,\
|
|
25577
|
+
\ `PROOF_OF_ARRIVAL`, `DRIVERS_LICENCE`, `COMPANY_REGISTER`, `COMPANY_STATEMENT`,\
|
|
25578
|
+
\ `BANK_ACCOUNT`, `ONLINE_PAYMENT_ACCOUNT`, `UTILITY_ACCOUNT`, `BANK_STATEMENT`,\
|
|
25579
|
+
\ `TAX_STATEMENT`, `WRITTEN_ATTESTATION`, `DIGITAL_ATTESTATION`, `POSTAL_VER_TRANSACTION_LOG`,\
|
|
25580
|
+
\ `EMAIL_VER_TRANSACTION_LOG`, `ADDRESS_DATABASE` |\n| `attestation_reference`\
|
|
25581
|
+
\ | string | Caller-supplied reference (e.g. internal ticket ID, document hash).\
|
|
25582
|
+
\ Up to 255 chars. |\n\n**DENIC-only constraint:** when the contact has DENIC\
|
|
25583
|
+
\ verification pending, all items in a single request must share the same `method`,\
|
|
25584
|
+
\ `proof`, and `attestation_reference`. DENIC's `contactUPDATE` carries one verification\
|
|
25585
|
+
\ block per call; the API enforces this only when DENIC is in scope so callers\
|
|
25586
|
+
\ see a synchronous 400 instead of a partial-success. Contacts not pending DENIC\
|
|
25587
|
+
\ verification accept heterogeneous batches.\n\n#### Response\n\nThe endpoint\
|
|
25588
|
+
\ returns **HTTP 200 OK** with an object containing the per-claim verification\
|
|
25589
|
+
\ state from the contact-verification service:\n\n```json\n{\n \"verifications\"\
|
|
25590
|
+
: [\n {\n \"claim\": \"NAME\",\n \"state\": \"VERIFIED\",\n \
|
|
25591
|
+
\ \"method\": \"AUTH\",\n \"proof\": \"IDCARD\",\n \"attestation_reference\"\
|
|
25592
|
+
: \"ticket-12345\",\n \"verified_on\": \"2026-05-15T12:00:00Z\",\n \"\
|
|
25593
|
+
expires_on\": null\n }\n ]\n}\n```\n\n| Field | Type | Notes |\n|-------|------|-------|\n\
|
|
25594
|
+
| `claim` | enum | The claim this entry describes. |\n| `state` | enum | `UNVERIFIED`,\
|
|
25595
|
+
\ `VERIFIED`, `IN_PROGRESS`, `EXPIRED`. |\n| `method` | enum or null | The method\
|
|
25596
|
+
\ that produced the current state. |\n| `proof` | enum or null | The proof that\
|
|
25597
|
+
\ produced the current state. |\n| `attestation_reference` | string or null |\
|
|
25598
|
+
\ Reference recorded with the current state. |\n| `verified_on` | RFC3339 datetime\
|
|
25599
|
+
\ or null | When the claim entered the `VERIFIED` state. |\n| `expires_on` | RFC3339\
|
|
25600
|
+
\ datetime or null | When the current verification expires. |\n\nWhen DENIC verification\
|
|
25601
|
+
\ was pending for the contact, the registry-side `contactUPDATE` is queued behind\
|
|
25602
|
+
\ the scenes and emits a `CONTACT/VERIFICATION/SUCCESS` or `CONTACT/VERIFICATION/FAILURE`\
|
|
25603
|
+
\ poll-message event keyed on `contact_id`. The `VERIFICATION_REQUIRED` status\
|
|
25604
|
+
\ tag on the affected domains is cleared on success.\n\n#### Error codes\n\n|\
|
|
25605
|
+
\ Code | Status | Meaning |\n|------|--------|---------|\n| `ERROR_DOMAIN_VERIFICATION_INCONSISTENT_METHOD_PROOF`\
|
|
25606
|
+
\ | 400 | DENIC verification is pending for this contact and items in the request\
|
|
25607
|
+
\ disagree on `method`, `proof`, or `attestation_reference`. |\n| `ERROR_DOMAIN_VERIFICATION_INVALID_COMBINATION`\
|
|
25608
|
+
\ | (async) | The registry rejected the DENIC attestation as an invalid method/proof/reference\
|
|
25609
|
+
\ combination. Surfaces as a `CONTACT/VERIFICATION/FAILURE` poll-message event.\
|
|
25610
|
+
\ |\n| `ERROR_DOMAIN_VERIFICATION_REGISTRY_REJECTED` | (async) | DENIC accepted\
|
|
25611
|
+
\ the submission at the protocol level but indicated the verification attempt\
|
|
25612
|
+
\ itself was not successful. Surfaces as a `CONTACT/VERIFICATION/FAILURE` poll-message\
|
|
25613
|
+
\ event. |\n"
|
|
25350
25614
|
name: contact
|
|
25351
25615
|
x-displayName: Contacts
|
|
25352
25616
|
- description: "Endpoints for managing DNS zones and records.\n\n### Zone, RRset,\
|