@opusdns/api 0.305.0 → 0.307.0

package/src/helpers/responses.d.ts

@@ -34,7 +34,7 @@
 
 import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
 
-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, JobBatchRetry, 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';
+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, ContactAttestRes, 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, JobBatchRetry, 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';
 
 /**
  * Response types for GET AiConciergeContextsByContextId endpoint
@@ -3257,6 +3257,116 @@ export type PUT_ContactsByContactIdVerification_Response_404 = Problem
  */
 export type PUT_ContactsByContactIdVerification_Response_422 = HTTPValidationError
 
+/**
+ * Response types for POST ContactsByContactIdVerificationsAttest endpoint
+ *
+ * Attest a contact verification
+ * Submit one or more contact-verification attestations. Returns the per-claim verification state.
+ *
+ * @remarks
+ * This type defines all possible response structures for the POST ContactsByContactIdVerificationsAttest endpoint.
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
+ * Use this type to ensure type safety when handling API responses from this endpoint.
+ *
+
+ *
+ * @path /v1/contacts/{contact_id}/verifications/attest
+ *
+ * @see {@link POST_ContactsByContactIdVerificationsAttest_Response_200} - 200 response type
+ * @see {@link POST_ContactsByContactIdVerificationsAttest_Response_400} - 400 response type
+ * @see {@link POST_ContactsByContactIdVerificationsAttest_Response_401} - 401 response type
+ * @see {@link POST_ContactsByContactIdVerificationsAttest_Response_422} - 422 response type
+ * @see {@link POST_ContactsByContactIdVerificationsAttest_Response_502} - 502 response type
+ *
+
+ */
+export type POST_ContactsByContactIdVerificationsAttest_Response = POST_ContactsByContactIdVerificationsAttest_Response_200 | POST_ContactsByContactIdVerificationsAttest_Response_400 | POST_ContactsByContactIdVerificationsAttest_Response_401 | POST_ContactsByContactIdVerificationsAttest_Response_422 | POST_ContactsByContactIdVerificationsAttest_Response_502;
+
+/**
+ * 200 response for POST ContactsByContactIdVerificationsAttest endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 200 status code
+ * of the POST ContactsByContactIdVerificationsAttest endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/contacts/{contact_id}/verifications/attest
+ *
+ * @see {@link POST_ContactsByContactIdVerificationsAttest_Response} - The main response type definition
+ * @see {@link ContactAttestRes} - The actual schema type definition
+ */
+export type POST_ContactsByContactIdVerificationsAttest_Response_200 = ContactAttestRes
+
+/**
+ * 400 response for POST ContactsByContactIdVerificationsAttest endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 400 status code
+ * of the POST ContactsByContactIdVerificationsAttest endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/contacts/{contact_id}/verifications/attest
+ *
+ * @see {@link POST_ContactsByContactIdVerificationsAttest_Response} - The main response type definition
+ * @see {@link Problem} - The actual schema type definition
+ */
+export type POST_ContactsByContactIdVerificationsAttest_Response_400 = Problem
+
+/**
+ * 401 response for POST ContactsByContactIdVerificationsAttest endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 401 status code
+ * of the POST ContactsByContactIdVerificationsAttest endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/contacts/{contact_id}/verifications/attest
+ *
+ * @see {@link POST_ContactsByContactIdVerificationsAttest_Response} - The main response type definition
+ * @see {@link Problem} - The actual schema type definition
+ */
+export type POST_ContactsByContactIdVerificationsAttest_Response_401 = Problem
+
+/**
+ * 422 response for POST ContactsByContactIdVerificationsAttest endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 422 status code
+ * of the POST ContactsByContactIdVerificationsAttest endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/contacts/{contact_id}/verifications/attest
+ *
+ * @see {@link POST_ContactsByContactIdVerificationsAttest_Response} - The main response type definition
+ * @see {@link HTTPValidationError} - The actual schema type definition
+ */
+export type POST_ContactsByContactIdVerificationsAttest_Response_422 = HTTPValidationError
+
+/**
+ * 502 response for POST ContactsByContactIdVerificationsAttest endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 502 status code
+ * of the POST ContactsByContactIdVerificationsAttest endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/contacts/{contact_id}/verifications/attest
+ *
+ * @see {@link POST_ContactsByContactIdVerificationsAttest_Response} - The main response type definition
+ * @see {@link Problem} - The actual schema type definition
+ */
+export type POST_ContactsByContactIdVerificationsAttest_Response_502 = Problem
+
 /**
  * Response types for GET ContactsVerification endpoint
  *

package/src/helpers/schemas-arrays.d.ts

@@ -21,7 +21,7 @@
  * This file is auto-generated from the OpenAPI specification.
  * Do not edit manually.
  */
-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';
+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';
 
 /**
  * StatusTagType
@@ -247,6 +247,34 @@ export type TmClaimArray = TmClaim[];
  * @see {@link ClaimsNotice} - The individual ClaimsNotice type definition
  */
 export type ClaimsNoticeArray = ClaimsNotice[];
+/**
+ * ContactAttestVerificationReq
+ *
+ * @remarks
+ * Array type for ContactAttestVerificationReq objects. Used when the API returns a collection of ContactAttestVerificationReq instances.
+ *
+ * @example
+ * ```typescript
+ * const items: ContactAttestVerificationReqArray = await api.getContactAttestVerificationReqs();
+ * ```
+ *
+ * @see {@link ContactAttestVerificationReq} - The individual ContactAttestVerificationReq type definition
+ */
+export type ContactAttestVerificationReqArray = ContactAttestVerificationReq[];
+/**
+ * ContactVerificationStatus
+ *
+ * @remarks
+ * Array type for ContactVerificationStatus objects. Used when the API returns a collection of ContactVerificationStatus instances.
+ *
+ * @example
+ * ```typescript
+ * const items: ContactVerificationStatusArray = await api.getContactVerificationStatuss();
+ * ```
+ *
+ * @see {@link ContactVerificationStatus} - The individual ContactVerificationStatus type definition
+ */
+export type ContactVerificationStatusArray = ContactVerificationStatus[];
 /**
  * AttributeCondition
  *

package/src/helpers/schemas.d.ts

@@ -362,6 +362,54 @@ export type ComplianceStatus = components['schemas']['ComplianceStatus'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type ConditionOperator = components['schemas']['ConditionOperator'];
+/**
+ * ContactAttestReq
+ *
+ * @remarks
+ * Type alias for the `ContactAttestReq` OpenAPI schema.
+ * This type represents contactattestreq data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getContactAttestReq();
+ * const item: ContactAttestReq = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type ContactAttestReq = components['schemas']['ContactAttestReq'];
+/**
+ * ContactAttestRes
+ *
+ * @remarks
+ * Type alias for the `ContactAttestRes` OpenAPI schema.
+ * This type represents contactattestres data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getContactAttestRes();
+ * const item: ContactAttestRes = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type ContactAttestRes = components['schemas']['ContactAttestRes'];
+/**
+ * ContactAttestVerificationReq
+ *
+ * @remarks
+ * Type alias for the `ContactAttestVerificationReq` OpenAPI schema.
+ * This type represents contactattestverificationreq data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getContactAttestVerificationReq();
+ * const item: ContactAttestVerificationReq = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type ContactAttestVerificationReq = components['schemas']['ContactAttestVerificationReq'];
 /**
  * ContactAttributeDefinition. Definition of a possible attribute for a TLD.
  *
@@ -762,6 +810,22 @@ export type ContactType = components['schemas']['ContactType'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type ContactVerificationApi = components['schemas']['ContactVerificationApiResponse'];
+/**
+ * ContactVerificationClaim
+ *
+ * @remarks
+ * Type alias for the `ContactVerificationClaim` OpenAPI schema.
+ * This type represents contactverificationclaim data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getContactVerificationClaim();
+ * const item: ContactVerificationClaim = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type ContactVerificationClaim = components['schemas']['ContactVerificationClaim'];
 /**
  * ContactVerificationEmailResponse
  *
@@ -778,6 +842,38 @@ export type ContactVerificationApi = components['schemas']['ContactVerificationA
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type ContactVerificationEmail = components['schemas']['ContactVerificationEmailResponse'];
+/**
+ * ContactVerificationMethod
+ *
+ * @remarks
+ * Type alias for the `ContactVerificationMethod` OpenAPI schema.
+ * This type represents contactverificationmethod data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getContactVerificationMethod();
+ * const item: ContactVerificationMethod = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type ContactVerificationMethod = components['schemas']['ContactVerificationMethod'];
+/**
+ * ContactVerificationProof
+ *
+ * @remarks
+ * Type alias for the `ContactVerificationProof` OpenAPI schema.
+ * This type represents contactverificationproof data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getContactVerificationProof();
+ * const item: ContactVerificationProof = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type ContactVerificationProof = components['schemas']['ContactVerificationProof'];
 /**
  * ContactVerificationResponse
  *
@@ -794,6 +890,38 @@ export type ContactVerificationEmail = components['schemas']['ContactVerificatio
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type ContactVerification = components['schemas']['ContactVerificationResponse'];
+/**
+ * ContactVerificationState
+ *
+ * @remarks
+ * Type alias for the `ContactVerificationState` OpenAPI schema.
+ * This type represents contactverificationstate data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getContactVerificationState();
+ * const item: ContactVerificationState = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type ContactVerificationState = components['schemas']['ContactVerificationState'];
+/**
+ * ContactVerificationStatus
+ *
+ * @remarks
+ * Type alias for the `ContactVerificationStatus` OpenAPI schema.
+ * This type represents contactverificationstatus data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getContactVerificationStatus();
+ * const item: ContactVerificationStatus = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type ContactVerificationStatus = components['schemas']['ContactVerificationStatus'];
 /**
  * ContactsBase
  *