@opusdns/api 0.290.0 → 0.292.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 +153 -1
- package/src/helpers/keys.ts +565 -291
- package/src/helpers/responses.d.ts +3 -3
- package/src/helpers/schemas-arrays.d.ts +43 -1
- package/src/helpers/schemas.d.ts +144 -16
- package/src/openapi.yaml +147 -102
- package/src/schema.d.ts +85 -65
|
@@ -34,7 +34,7 @@
|
|
|
34
34
|
|
|
35
35
|
import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
|
|
36
36
|
|
|
37
|
-
import { Context, Problem, HTTPValidationError, ConversationList, Conversation, ContextList, MessageList, Message, MemoryFactList, MemoryFact, Pagination_EmailForwardLog, Pagination_ObjectLog, Pagination_RequestHistory, DomainAvailabilityList, Pagination_Contact, ContactSchema, Pagination_ContactAttributeSet, ContactAttributeSet, Contact, ContactAttributeLink, ContactVerification, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, EmailForwardZone, Pagination_DomainForwardZone, Pagination_EmailForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainForwardMetrics, DomainForwardBrowserStats, DomainForwardGeoStats, DomainForwardPlatformStats, DomainForwardReferrerStats, DomainForwardStatusCodeStats, DomainForwardMetricsTimeSeries, DomainForwardUserAgentStats, DomainForwardVisitsByKey, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, ClaimsNotices, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, RequestAuthcode2, Pagination_EmailForward, EmailForward, EmailForwardAlias, EmailForwardMetrics, Pagination_Event,
|
|
37
|
+
import { Context, Problem, HTTPValidationError, ConversationList, Conversation, ContextList, MessageList, Message, MemoryFactList, MemoryFact, Pagination_EmailForwardLog, Pagination_ObjectLog, Pagination_RequestHistory, DomainAvailabilityList, Pagination_Contact, ContactSchema, Pagination_ContactAttributeSet, ContactAttributeSet, Contact, ContactAttributeLink, ContactVerification, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, EmailForwardZone, Pagination_DomainForwardZone, Pagination_EmailForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainForwardMetrics, DomainForwardBrowserStats, DomainForwardGeoStats, DomainForwardPlatformStats, DomainForwardReferrerStats, DomainForwardStatusCodeStats, DomainForwardMetricsTimeSeries, DomainForwardUserAgentStats, DomainForwardVisitsByKey, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, ClaimsNotices, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, RequestAuthcode2, Pagination_EmailForward, EmailForward, EmailForwardAlias, EmailForwardMetrics, Pagination_Event, EventResponse, Job, Pagination_JobBatchMetadata, CreateJobBatch, JobBatchStatus, Pagination_Job, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_UserPublic, Pagination_Parking, ParkingMetrics, ParkingTotalMetrics, ParkingSignup, ParkingSignupStatus, PublicReportListRes, PublicReportRes, Pagination_Tag, Tag, ObjectTagChanges2, TldSpecification, UserPublic, UserPublicWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
40
|
* Response types for GET AiConciergeContextsByContextId endpoint
|
|
@@ -9444,9 +9444,9 @@ export type GET_EventsByEventId_Response = GET_EventsByEventId_Response_200 | GE
|
|
|
9444
9444
|
* @path /v1/events/{event_id}
|
|
9445
9445
|
*
|
|
9446
9446
|
* @see {@link GET_EventsByEventId_Response} - The main response type definition
|
|
9447
|
-
* @see {@link
|
|
9447
|
+
* @see {@link EventResponse} - The actual schema type definition
|
|
9448
9448
|
*/
|
|
9449
|
-
export type GET_EventsByEventId_Response_200 =
|
|
9449
|
+
export type GET_EventsByEventId_Response_200 = EventResponse
|
|
9450
9450
|
|
|
9451
9451
|
/**
|
|
9452
9452
|
* 401 response for GET EventsByEventId endpoint
|
|
@@ -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 { ContactIncludeField, ZoneIncludeField, DomainIncludeField, DomainDnssecData, DomainDnssecDataCreate, JobStatus, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, ReportType, ReportStatus, TagType, TldResponseShort, TmClaim, ClaimsNotice, AttributeCondition, DomainContactType, ContactCreateBulkInstance, ContactAttributeLinkDetail, 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, 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 { ContactIncludeField, ZoneIncludeField, DomainIncludeField, DomainDnssecData, DomainDnssecDataCreate, JobStatus, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, ReportType, ReportStatus, TagType, TldResponseShort, TmClaim, ClaimsNotice, AttributeCondition, DomainContactType, ContactCreateBulkInstance, ContactAttributeLinkDetail, 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
|
* ContactIncludeField
|
|
@@ -905,6 +905,48 @@ export type DomainClientStatusArray = DomainClientStatus[];
|
|
|
905
905
|
* @see {@link DomainUpdateBulkInstance} - The individual DomainUpdateBulkInstance type definition
|
|
906
906
|
*/
|
|
907
907
|
export type DomainUpdateBulkInstanceArray = DomainUpdateBulkInstance[];
|
|
908
|
+
/**
|
|
909
|
+
* VerificationRegistrantDetails
|
|
910
|
+
*
|
|
911
|
+
* @remarks
|
|
912
|
+
* Array type for VerificationRegistrantDetails objects. Used when the API returns a collection of VerificationRegistrantDetails instances.
|
|
913
|
+
*
|
|
914
|
+
* @example
|
|
915
|
+
* ```typescript
|
|
916
|
+
* const items: VerificationRegistrantDetailsArray = await api.getVerificationRegistrantDetailss();
|
|
917
|
+
* ```
|
|
918
|
+
*
|
|
919
|
+
* @see {@link VerificationRegistrantDetails} - The individual VerificationRegistrantDetails type definition
|
|
920
|
+
*/
|
|
921
|
+
export type VerificationRegistrantDetailsArray = VerificationRegistrantDetails[];
|
|
922
|
+
/**
|
|
923
|
+
* VerificationClaimType
|
|
924
|
+
*
|
|
925
|
+
* @remarks
|
|
926
|
+
* Array type for VerificationClaimType objects. Used when the API returns a collection of VerificationClaimType instances.
|
|
927
|
+
*
|
|
928
|
+
* @example
|
|
929
|
+
* ```typescript
|
|
930
|
+
* const items: VerificationClaimTypeArray = await api.getVerificationClaimTypes();
|
|
931
|
+
* ```
|
|
932
|
+
*
|
|
933
|
+
* @see {@link VerificationClaimType} - The individual VerificationClaimType type definition
|
|
934
|
+
*/
|
|
935
|
+
export type VerificationClaimTypeArray = VerificationClaimType[];
|
|
936
|
+
/**
|
|
937
|
+
* VerificationDeadline
|
|
938
|
+
*
|
|
939
|
+
* @remarks
|
|
940
|
+
* Array type for VerificationDeadline objects. Used when the API returns a collection of VerificationDeadline instances.
|
|
941
|
+
*
|
|
942
|
+
* @example
|
|
943
|
+
* ```typescript
|
|
944
|
+
* const items: VerificationDeadlineArray = await api.getVerificationDeadlines();
|
|
945
|
+
* ```
|
|
946
|
+
*
|
|
947
|
+
* @see {@link VerificationDeadline} - The individual VerificationDeadline type definition
|
|
948
|
+
*/
|
|
949
|
+
export type VerificationDeadlineArray = VerificationDeadline[];
|
|
908
950
|
/**
|
|
909
951
|
* EmailForwardAliasCreate
|
|
910
952
|
*
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -2538,6 +2538,22 @@ export type DomainRenewRequest = components['schemas']['DomainRenewRequest'];
|
|
|
2538
2538
|
* @see {@link components} - The OpenAPI components schema definition
|
|
2539
2539
|
*/
|
|
2540
2540
|
export type DomainRenew = components['schemas']['DomainRenewResponse'];
|
|
2541
|
+
/**
|
|
2542
|
+
* DomainRenewalDetails
|
|
2543
|
+
*
|
|
2544
|
+
* @remarks
|
|
2545
|
+
* Type alias for the `DomainRenewalDetails` OpenAPI schema.
|
|
2546
|
+
* This type represents domainrenewaldetails data structures used in API requests and responses.
|
|
2547
|
+
*
|
|
2548
|
+
* @example
|
|
2549
|
+
* ```typescript
|
|
2550
|
+
* const response = await api.getDomainRenewalDetails();
|
|
2551
|
+
* const item: DomainRenewalDetails = response.results;
|
|
2552
|
+
* ```
|
|
2553
|
+
*
|
|
2554
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
2555
|
+
*/
|
|
2556
|
+
export type DomainRenewalDetails = components['schemas']['DomainRenewalDetails'];
|
|
2541
2557
|
/**
|
|
2542
2558
|
* DomainResponse
|
|
2543
2559
|
*
|
|
@@ -3034,6 +3050,22 @@ export type DomainUpdatePayloadData = components['schemas']['DomainUpdatePayload
|
|
|
3034
3050
|
* @see {@link components} - The OpenAPI components schema definition
|
|
3035
3051
|
*/
|
|
3036
3052
|
export type DomainUpdateWorkerPayload = components['schemas']['DomainUpdateWorkerPayload'];
|
|
3053
|
+
/**
|
|
3054
|
+
* DomainVerificationDetails
|
|
3055
|
+
*
|
|
3056
|
+
* @remarks
|
|
3057
|
+
* Type alias for the `DomainVerificationDetails` OpenAPI schema.
|
|
3058
|
+
* This type represents domainverificationdetails data structures used in API requests and responses.
|
|
3059
|
+
*
|
|
3060
|
+
* @example
|
|
3061
|
+
* ```typescript
|
|
3062
|
+
* const response = await api.getDomainVerificationDetails();
|
|
3063
|
+
* const item: DomainVerificationDetails = response.results;
|
|
3064
|
+
* ```
|
|
3065
|
+
*
|
|
3066
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
3067
|
+
*/
|
|
3068
|
+
export type DomainVerificationDetails = components['schemas']['DomainVerificationDetails'];
|
|
3037
3069
|
/**
|
|
3038
3070
|
* DomainWithdrawRequest
|
|
3039
3071
|
*
|
|
@@ -3370,6 +3402,38 @@ export type EmailForwardZoneSortField = components['schemas']['EmailForwardZoneS
|
|
|
3370
3402
|
* @see {@link components} - The OpenAPI components schema definition
|
|
3371
3403
|
*/
|
|
3372
3404
|
export type EmailVerificationStatus = components['schemas']['EmailVerificationStatus'];
|
|
3405
|
+
/**
|
|
3406
|
+
* EventData
|
|
3407
|
+
*
|
|
3408
|
+
* @remarks
|
|
3409
|
+
* Type alias for the `EventData` OpenAPI schema.
|
|
3410
|
+
* This type represents eventdata data structures used in API requests and responses.
|
|
3411
|
+
*
|
|
3412
|
+
* @example
|
|
3413
|
+
* ```typescript
|
|
3414
|
+
* const response = await api.getEventData();
|
|
3415
|
+
* const item: EventData = response.results;
|
|
3416
|
+
* ```
|
|
3417
|
+
*
|
|
3418
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
3419
|
+
*/
|
|
3420
|
+
export type EventData = components['schemas']['EventData'];
|
|
3421
|
+
/**
|
|
3422
|
+
* EventError
|
|
3423
|
+
*
|
|
3424
|
+
* @remarks
|
|
3425
|
+
* Type alias for the `EventError` OpenAPI schema.
|
|
3426
|
+
* This type represents eventerror data structures used in API requests and responses.
|
|
3427
|
+
*
|
|
3428
|
+
* @example
|
|
3429
|
+
* ```typescript
|
|
3430
|
+
* const response = await api.getEventError();
|
|
3431
|
+
* const item: EventError = response.results;
|
|
3432
|
+
* ```
|
|
3433
|
+
*
|
|
3434
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
3435
|
+
*/
|
|
3436
|
+
export type EventError = components['schemas']['EventError'];
|
|
3373
3437
|
/**
|
|
3374
3438
|
* EventObjectType
|
|
3375
3439
|
*
|
|
@@ -3402,22 +3466,6 @@ export type EventObjectType = components['schemas']['EventObjectType'];
|
|
|
3402
3466
|
* @see {@link components} - The OpenAPI components schema definition
|
|
3403
3467
|
*/
|
|
3404
3468
|
export type EventResponse = components['schemas']['EventResponse'];
|
|
3405
|
-
/**
|
|
3406
|
-
* EventSchema
|
|
3407
|
-
*
|
|
3408
|
-
* @remarks
|
|
3409
|
-
* Type alias for the `EventSchema` OpenAPI schema.
|
|
3410
|
-
* This type represents eventschema data structures used in API requests and responses.
|
|
3411
|
-
*
|
|
3412
|
-
* @example
|
|
3413
|
-
* ```typescript
|
|
3414
|
-
* const response = await api.getEventSchema();
|
|
3415
|
-
* const item: EventSchema = response.results;
|
|
3416
|
-
* ```
|
|
3417
|
-
*
|
|
3418
|
-
* @see {@link components} - The OpenAPI components schema definition
|
|
3419
|
-
*/
|
|
3420
|
-
export type EventSchema = components['schemas']['EventSchema'];
|
|
3421
3469
|
/**
|
|
3422
3470
|
* EventSortField
|
|
3423
3471
|
*
|
|
@@ -3466,6 +3514,22 @@ export type EventSubtype = components['schemas']['EventSubtype'];
|
|
|
3466
3514
|
* @see {@link components} - The OpenAPI components schema definition
|
|
3467
3515
|
*/
|
|
3468
3516
|
export type EventType = components['schemas']['EventType'];
|
|
3517
|
+
/**
|
|
3518
|
+
* EventVersion
|
|
3519
|
+
*
|
|
3520
|
+
* @remarks
|
|
3521
|
+
* Type alias for the `EventVersion` OpenAPI schema.
|
|
3522
|
+
* This type represents eventversion data structures used in API requests and responses.
|
|
3523
|
+
*
|
|
3524
|
+
* @example
|
|
3525
|
+
* ```typescript
|
|
3526
|
+
* const response = await api.getEventVersion();
|
|
3527
|
+
* const item: EventVersion = response.results;
|
|
3528
|
+
* ```
|
|
3529
|
+
*
|
|
3530
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
3531
|
+
*/
|
|
3532
|
+
export type EventVersion = components['schemas']['EventVersion'];
|
|
3469
3533
|
/**
|
|
3470
3534
|
* ExecutingEntity
|
|
3471
3535
|
*
|
|
@@ -6724,6 +6788,70 @@ export type UserWithRelationPermissions = components['schemas']['UserWithRelatio
|
|
|
6724
6788
|
* @see {@link components} - The OpenAPI components schema definition
|
|
6725
6789
|
*/
|
|
6726
6790
|
export type ValidationError = components['schemas']['ValidationError'];
|
|
6791
|
+
/**
|
|
6792
|
+
* VerificationClaimType
|
|
6793
|
+
*
|
|
6794
|
+
* @remarks
|
|
6795
|
+
* Type alias for the `VerificationClaimType` OpenAPI schema.
|
|
6796
|
+
* This type represents verificationclaimtype data structures used in API requests and responses.
|
|
6797
|
+
*
|
|
6798
|
+
* @example
|
|
6799
|
+
* ```typescript
|
|
6800
|
+
* const response = await api.getVerificationClaimType();
|
|
6801
|
+
* const item: VerificationClaimType = response.results;
|
|
6802
|
+
* ```
|
|
6803
|
+
*
|
|
6804
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
6805
|
+
*/
|
|
6806
|
+
export type VerificationClaimType = components['schemas']['VerificationClaimType'];
|
|
6807
|
+
/**
|
|
6808
|
+
* VerificationDeadline
|
|
6809
|
+
*
|
|
6810
|
+
* @remarks
|
|
6811
|
+
* Type alias for the `VerificationDeadline` OpenAPI schema.
|
|
6812
|
+
* This type represents verificationdeadline data structures used in API requests and responses.
|
|
6813
|
+
*
|
|
6814
|
+
* @example
|
|
6815
|
+
* ```typescript
|
|
6816
|
+
* const response = await api.getVerificationDeadline();
|
|
6817
|
+
* const item: VerificationDeadline = response.results;
|
|
6818
|
+
* ```
|
|
6819
|
+
*
|
|
6820
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
6821
|
+
*/
|
|
6822
|
+
export type VerificationDeadline = components['schemas']['VerificationDeadline'];
|
|
6823
|
+
/**
|
|
6824
|
+
* VerificationDeadlineType
|
|
6825
|
+
*
|
|
6826
|
+
* @remarks
|
|
6827
|
+
* Type alias for the `VerificationDeadlineType` OpenAPI schema.
|
|
6828
|
+
* This type represents verificationdeadlinetype data structures used in API requests and responses.
|
|
6829
|
+
*
|
|
6830
|
+
* @example
|
|
6831
|
+
* ```typescript
|
|
6832
|
+
* const response = await api.getVerificationDeadlineType();
|
|
6833
|
+
* const item: VerificationDeadlineType = response.results;
|
|
6834
|
+
* ```
|
|
6835
|
+
*
|
|
6836
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
6837
|
+
*/
|
|
6838
|
+
export type VerificationDeadlineType = components['schemas']['VerificationDeadlineType'];
|
|
6839
|
+
/**
|
|
6840
|
+
* VerificationRegistrantDetails
|
|
6841
|
+
*
|
|
6842
|
+
* @remarks
|
|
6843
|
+
* Type alias for the `VerificationRegistrantDetails` OpenAPI schema.
|
|
6844
|
+
* This type represents verificationregistrantdetails data structures used in API requests and responses.
|
|
6845
|
+
*
|
|
6846
|
+
* @example
|
|
6847
|
+
* ```typescript
|
|
6848
|
+
* const response = await api.getVerificationRegistrantDetails();
|
|
6849
|
+
* const item: VerificationRegistrantDetails = response.results;
|
|
6850
|
+
* ```
|
|
6851
|
+
*
|
|
6852
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
6853
|
+
*/
|
|
6854
|
+
export type VerificationRegistrantDetails = components['schemas']['VerificationRegistrantDetails'];
|
|
6727
6855
|
/**
|
|
6728
6856
|
* VerificationType
|
|
6729
6857
|
*
|
package/src/openapi.yaml
CHANGED
|
@@ -3983,6 +3983,21 @@ components:
|
|
|
3983
3983
|
- period_extended
|
|
3984
3984
|
title: DomainRenewResponse
|
|
3985
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
|
|
3986
4001
|
DomainResponse:
|
|
3987
4002
|
properties:
|
|
3988
4003
|
auth_code:
|
|
@@ -5013,6 +5028,35 @@ components:
|
|
|
5013
5028
|
- domain
|
|
5014
5029
|
title: DomainUpdateWorkerPayload
|
|
5015
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
|
|
5016
5060
|
DomainWithdrawRequest:
|
|
5017
5061
|
properties:
|
|
5018
5062
|
zone_delete:
|
|
@@ -5539,6 +5583,47 @@ components:
|
|
|
5539
5583
|
- canceled
|
|
5540
5584
|
title: EmailVerificationStatus
|
|
5541
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
|
|
5542
5627
|
EventObjectType:
|
|
5543
5628
|
enum:
|
|
5544
5629
|
- DOMAIN
|
|
@@ -5563,17 +5648,15 @@ components:
|
|
|
5563
5648
|
title: Created On
|
|
5564
5649
|
type: string
|
|
5565
5650
|
event_data:
|
|
5566
|
-
|
|
5567
|
-
title: Event Data
|
|
5568
|
-
type: object
|
|
5651
|
+
$ref: '#/components/schemas/EventData'
|
|
5569
5652
|
event_id:
|
|
5570
5653
|
examples:
|
|
5571
|
-
-
|
|
5654
|
+
- event_01h45ytscbebyvny4gc8cr8ma2
|
|
5572
5655
|
format: typeid
|
|
5573
|
-
pattern: ^
|
|
5656
|
+
pattern: ^event_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
5574
5657
|
title: Event Id
|
|
5575
5658
|
type: string
|
|
5576
|
-
x-typeid-prefix:
|
|
5659
|
+
x-typeid-prefix: event
|
|
5577
5660
|
object_id:
|
|
5578
5661
|
anyOf:
|
|
5579
5662
|
- type: string
|
|
@@ -5598,97 +5681,10 @@ components:
|
|
|
5598
5681
|
description: The type of the event - indicates the kind of operation occurring
|
|
5599
5682
|
(e.g., 'ACCOUNT_CREATE', 'DOMAIN_MODIFICATION')
|
|
5600
5683
|
required:
|
|
5684
|
+
- event_data
|
|
5601
5685
|
- created_on
|
|
5602
5686
|
title: EventResponse
|
|
5603
5687
|
type: object
|
|
5604
|
-
EventSchema:
|
|
5605
|
-
properties:
|
|
5606
|
-
acknowledged_on:
|
|
5607
|
-
anyOf:
|
|
5608
|
-
- format: date-time
|
|
5609
|
-
type: string
|
|
5610
|
-
- type: 'null'
|
|
5611
|
-
description: The date/time the event was acknowledged
|
|
5612
|
-
title: Acknowledged On
|
|
5613
|
-
created_on:
|
|
5614
|
-
description: The date/time the entry was created on
|
|
5615
|
-
format: date-time
|
|
5616
|
-
title: Created On
|
|
5617
|
-
type: string
|
|
5618
|
-
event_data:
|
|
5619
|
-
$ref: '#/components/schemas/JsonValue'
|
|
5620
|
-
description: Additional details about the action
|
|
5621
|
-
event_id:
|
|
5622
|
-
examples:
|
|
5623
|
-
- epp_event_01h45ytscbebyvny4gc8cr8ma2
|
|
5624
|
-
format: typeid
|
|
5625
|
-
pattern: ^epp_event_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
5626
|
-
title: Event Id
|
|
5627
|
-
type: string
|
|
5628
|
-
x-typeid-prefix: epp_event
|
|
5629
|
-
message_queue_id:
|
|
5630
|
-
anyOf:
|
|
5631
|
-
- type: string
|
|
5632
|
-
- type: 'null'
|
|
5633
|
-
description: A composite key with the registry account + message queue ID
|
|
5634
|
-
from the poll operation.
|
|
5635
|
-
title: Message Queue Id
|
|
5636
|
-
object_id:
|
|
5637
|
-
anyOf:
|
|
5638
|
-
- type: string
|
|
5639
|
-
- type: 'null'
|
|
5640
|
-
description: The id of the object that the event is about
|
|
5641
|
-
title: Object Id
|
|
5642
|
-
object_type:
|
|
5643
|
-
$ref: '#/components/schemas/EventObjectType'
|
|
5644
|
-
default: RAW
|
|
5645
|
-
description: The type of object that the event is about
|
|
5646
|
-
source:
|
|
5647
|
-
description: The source of the event
|
|
5648
|
-
maxLength: 64
|
|
5649
|
-
title: Source
|
|
5650
|
-
type: string
|
|
5651
|
-
source_event_id:
|
|
5652
|
-
anyOf:
|
|
5653
|
-
- examples:
|
|
5654
|
-
- epp_event_01h45ytscbebyvny4gc8cr8ma2
|
|
5655
|
-
format: typeid
|
|
5656
|
-
pattern: ^epp_event_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
5657
|
-
type: string
|
|
5658
|
-
x-typeid-prefix: epp_event
|
|
5659
|
-
- type: 'null'
|
|
5660
|
-
description: The reference of the original registry event (if any) that
|
|
5661
|
-
triggered this customer-facing event
|
|
5662
|
-
title: Source Event Id
|
|
5663
|
-
subtype:
|
|
5664
|
-
anyOf:
|
|
5665
|
-
- $ref: '#/components/schemas/EventSubtype'
|
|
5666
|
-
- type: 'null'
|
|
5667
|
-
description: The specific type/result of operation (considering the type
|
|
5668
|
-
property), more detailed (e.g., 'NOTIFICATION' with the 'DOMAIN_MODIFICATION'
|
|
5669
|
-
class)
|
|
5670
|
-
target:
|
|
5671
|
-
anyOf:
|
|
5672
|
-
- examples:
|
|
5673
|
-
- organization_01h45ytscbebyvny4gc8cr8ma2
|
|
5674
|
-
format: typeid
|
|
5675
|
-
pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
5676
|
-
type: string
|
|
5677
|
-
x-typeid-prefix: organization
|
|
5678
|
-
- type: 'null'
|
|
5679
|
-
description: The target of the event
|
|
5680
|
-
title: Target
|
|
5681
|
-
type:
|
|
5682
|
-
anyOf:
|
|
5683
|
-
- $ref: '#/components/schemas/EventType'
|
|
5684
|
-
- type: 'null'
|
|
5685
|
-
description: The type of the event - indicates the kind of operation occurring
|
|
5686
|
-
(e.g., 'ACCOUNT_CREATE', 'DOMAIN_MODIFICATION')
|
|
5687
|
-
required:
|
|
5688
|
-
- event_data
|
|
5689
|
-
- source
|
|
5690
|
-
title: EventSchema
|
|
5691
|
-
type: object
|
|
5692
5688
|
EventSortField:
|
|
5693
5689
|
enum:
|
|
5694
5690
|
- object_id
|
|
@@ -5716,6 +5712,11 @@ components:
|
|
|
5716
5712
|
- VERIFICATION
|
|
5717
5713
|
title: EventType
|
|
5718
5714
|
type: string
|
|
5715
|
+
EventVersion:
|
|
5716
|
+
enum:
|
|
5717
|
+
- '1.0'
|
|
5718
|
+
title: EventVersion
|
|
5719
|
+
type: string
|
|
5719
5720
|
ExecutingEntity:
|
|
5720
5721
|
enum:
|
|
5721
5722
|
- user
|
|
@@ -10886,6 +10887,50 @@ components:
|
|
|
10886
10887
|
- type
|
|
10887
10888
|
title: ValidationError
|
|
10888
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
|
|
10889
10934
|
VerificationType:
|
|
10890
10935
|
enum:
|
|
10891
10936
|
- api
|
|
@@ -11122,7 +11167,7 @@ info:
|
|
|
11122
11167
|
\n\n"
|
|
11123
11168
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
11124
11169
|
title: OpusDNS API
|
|
11125
|
-
version: 2026-05-08-
|
|
11170
|
+
version: 2026-05-08-130451
|
|
11126
11171
|
x-logo:
|
|
11127
11172
|
altText: OpusDNS API Reference
|
|
11128
11173
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -20568,18 +20613,18 @@ paths:
|
|
|
20568
20613
|
required: true
|
|
20569
20614
|
schema:
|
|
20570
20615
|
examples:
|
|
20571
|
-
-
|
|
20616
|
+
- event_01h45ytscbebyvny4gc8cr8ma2
|
|
20572
20617
|
format: typeid
|
|
20573
|
-
pattern: ^
|
|
20618
|
+
pattern: ^event_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
20574
20619
|
title: Event Id
|
|
20575
20620
|
type: string
|
|
20576
|
-
x-typeid-prefix:
|
|
20621
|
+
x-typeid-prefix: event
|
|
20577
20622
|
responses:
|
|
20578
20623
|
'200':
|
|
20579
20624
|
content:
|
|
20580
20625
|
application/json:
|
|
20581
20626
|
schema:
|
|
20582
|
-
$ref: '#/components/schemas/
|
|
20627
|
+
$ref: '#/components/schemas/EventResponse'
|
|
20583
20628
|
description: Successful Response
|
|
20584
20629
|
'401':
|
|
20585
20630
|
content:
|
|
@@ -20627,12 +20672,12 @@ paths:
|
|
|
20627
20672
|
required: true
|
|
20628
20673
|
schema:
|
|
20629
20674
|
examples:
|
|
20630
|
-
-
|
|
20675
|
+
- event_01h45ytscbebyvny4gc8cr8ma2
|
|
20631
20676
|
format: typeid
|
|
20632
|
-
pattern: ^
|
|
20677
|
+
pattern: ^event_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
20633
20678
|
title: Event Id
|
|
20634
20679
|
type: string
|
|
20635
|
-
x-typeid-prefix:
|
|
20680
|
+
x-typeid-prefix: event
|
|
20636
20681
|
responses:
|
|
20637
20682
|
'204':
|
|
20638
20683
|
description: Successful Response
|