@opusdns/api 0.305.0 → 0.306.0

package/package.json

@@ -3,7 +3,7 @@
     "@opusdns/api-spec-ts-generator": "^0.19.0"
   },
   "name": "@opusdns/api",
-  "version": "0.305.0",
+  "version": "0.306.0",
   "description": "TypeScript types for the OpusDNS OpenAPI specification",
   "main": "./src/index.ts",
   "module": "./src/index.ts",

package/src/helpers/constants.ts

@@ -21,7 +21,7 @@
  * ```
  */
 
-import { AllocationMethodType, AttributeType, BatchSortField, BatchStatus, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ComplianceStatus, ConditionOperator, ContactAttributeSetSortField, ContactIncludeField, ContactSortField, ContactType, Currency, DeletePolicyType, DnsChangeAction, DnsProtectedReason, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainIncludeField, DomainSortField, DomainStatus, EmailForwardLogSortField, EmailForwardLogStatus, EmailForwardSortField, EmailForwardZoneSortField, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, EventVersion, ExecutingEntity, HTTPMethod, HolderEntitlement, HostStatus, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, JobStatus, LaunchPhaseType, LegalRequirementOperationType, LegalRequirementType, LocalPresenceRequirementType, MemoryFactKind, MessageContextKind, MessageRole, MetricsGrouping, ObjectEventType, ObjectLogSortField, OrganizationSortField, OrganizationStatus, ParkingSortField, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, Protocol, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, ReportStatus, ReportTriggerType, ReportType, RequestHistorySortField, ReservedSourceType, SortOrder, StatusTagType, SyncOperationType, TLDType, TagColor, TagFilterMode, TagSortField, TagType, TimeRange, TransferAckType, UserSortField, UserStatus, VerificationClaimType, VerificationDeadlineType, VerificationType, ZoneIncludeField, ZoneSortField } from './schemas';
+import { AllocationMethodType, AttributeType, BatchSortField, BatchStatus, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ComplianceStatus, ConditionOperator, ContactAttributeSetSortField, ContactIncludeField, ContactSortField, ContactType, ContactVerificationClaim, ContactVerificationMethod, ContactVerificationProof, ContactVerificationState, Currency, DeletePolicyType, DnsChangeAction, DnsProtectedReason, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainIncludeField, DomainSortField, DomainStatus, EmailForwardLogSortField, EmailForwardLogStatus, EmailForwardSortField, EmailForwardZoneSortField, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, EventVersion, ExecutingEntity, HTTPMethod, HolderEntitlement, HostStatus, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, JobStatus, LaunchPhaseType, LegalRequirementOperationType, LegalRequirementType, LocalPresenceRequirementType, MemoryFactKind, MessageContextKind, MessageRole, MetricsGrouping, ObjectEventType, ObjectLogSortField, OrganizationSortField, OrganizationStatus, ParkingSortField, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, Protocol, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, ReportStatus, ReportTriggerType, ReportType, RequestHistorySortField, ReservedSourceType, SortOrder, StatusTagType, SyncOperationType, TLDType, TagColor, TagFilterMode, TagSortField, TagType, TimeRange, TransferAckType, UserSortField, UserStatus, VerificationClaimType, VerificationDeadlineType, VerificationType, ZoneIncludeField, ZoneSortField } from './schemas';
 
 /**
  * AllocationMethodType. Auto-generated enum for AllocationMethodType
@@ -781,6 +781,260 @@ export const CONTACT_TYPE_VALUES = [
   'third party'
 ] as const satisfies [string, ...string[]] | ContactType[];
 
+/**
+ * ContactVerificationClaim. Auto-generated enum for ContactVerificationClaim
+ *
+ * @remarks
+ * This constant provides both object and array forms for the ContactVerificationClaim enum.
+ * The object form allows key-value access, while the array form enables iteration and validation.
+ *
+ * @example
+ * ```typescript
+ * // Using the object form for key-value access
+ * const status = CONTACT_VERIFICATION_CLAIM.SUCCESS;
+ * 
+ * // Using the array form for iteration
+ * const allStatuses = CONTACT_VERIFICATION_CLAIM_VALUES;
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
+ * ```
+ *
+ * @see {@link ContactVerificationClaim} - The TypeScript type definition
+ */
+export const CONTACT_VERIFICATION_CLAIM = {
+  NAME: "NAME",
+  ADDRESS: "ADDRESS",
+  EMAIL: "EMAIL",
+  PHONE: "PHONE",
+  LEGAL_ENTITY: "LEGAL_ENTITY",
+} as const satisfies Record<string, ContactVerificationClaim>;
+
+/**
+ * Array of all ContactVerificationClaim enum values
+ *
+ * @remarks
+ * This constant provides a array containing all valid ContactVerificationClaim enum values.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all values
+ * for (const value of CONTACT_VERIFICATION_CLAIM_VALUES) {
+ *   console.log(`Processing: ${value}`);
+ * }
+ * 
+ * // Validation
+ * const isValid = CONTACT_VERIFICATION_CLAIM_VALUES.includes(someValue);
+ * ```
+ *
+ * @see {@link ContactVerificationClaim} - The TypeScript type definition
+ * @see {@link CONTACT_VERIFICATION_CLAIM} - The object form of this enum
+ */
+export const CONTACT_VERIFICATION_CLAIM_VALUES = [
+  'NAME',
+  'ADDRESS',
+  'EMAIL',
+  'PHONE',
+  'LEGAL_ENTITY'
+] as const satisfies [string, ...string[]] | ContactVerificationClaim[];
+
+/**
+ * ContactVerificationMethod. Auto-generated enum for ContactVerificationMethod
+ *
+ * @remarks
+ * This constant provides both object and array forms for the ContactVerificationMethod enum.
+ * The object form allows key-value access, while the array form enables iteration and validation.
+ *
+ * @example
+ * ```typescript
+ * // Using the object form for key-value access
+ * const status = CONTACT_VERIFICATION_METHOD.SUCCESS;
+ * 
+ * // Using the array form for iteration
+ * const allStatuses = CONTACT_VERIFICATION_METHOD_VALUES;
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
+ * ```
+ *
+ * @see {@link ContactVerificationMethod} - The TypeScript type definition
+ */
+export const CONTACT_VERIFICATION_METHOD = {
+  AUTH: "AUTH",
+  VDIG: "VDIG",
+  ELECTRONIC_DOCUMENT: "ELECTRONIC_DOCUMENT",
+  PHYSICAL_DOCUMENT: "PHYSICAL_DOCUMENT",
+  BVR: "BVR",
+  PVR: "PVR",
+  DATA: "DATA",
+  REACHABILITY: "REACHABILITY",
+} as const satisfies Record<string, ContactVerificationMethod>;
+
+/**
+ * Array of all ContactVerificationMethod enum values
+ *
+ * @remarks
+ * This constant provides a array containing all valid ContactVerificationMethod enum values.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all values
+ * for (const value of CONTACT_VERIFICATION_METHOD_VALUES) {
+ *   console.log(`Processing: ${value}`);
+ * }
+ * 
+ * // Validation
+ * const isValid = CONTACT_VERIFICATION_METHOD_VALUES.includes(someValue);
+ * ```
+ *
+ * @see {@link ContactVerificationMethod} - The TypeScript type definition
+ * @see {@link CONTACT_VERIFICATION_METHOD} - The object form of this enum
+ */
+export const CONTACT_VERIFICATION_METHOD_VALUES = [
+  'AUTH',
+  'VDIG',
+  'ELECTRONIC_DOCUMENT',
+  'PHYSICAL_DOCUMENT',
+  'BVR',
+  'PVR',
+  'DATA',
+  'REACHABILITY'
+] as const satisfies [string, ...string[]] | ContactVerificationMethod[];
+
+/**
+ * ContactVerificationProof. Auto-generated enum for ContactVerificationProof
+ *
+ * @remarks
+ * This constant provides both object and array forms for the ContactVerificationProof enum.
+ * The object form allows key-value access, while the array form enables iteration and validation.
+ *
+ * @example
+ * ```typescript
+ * // Using the object form for key-value access
+ * const status = CONTACT_VERIFICATION_PROOF.SUCCESS;
+ * 
+ * // Using the array form for iteration
+ * const allStatuses = CONTACT_VERIFICATION_PROOF_VALUES;
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
+ * ```
+ *
+ * @see {@link ContactVerificationProof} - The TypeScript type definition
+ */
+export const CONTACT_VERIFICATION_PROOF = {
+  IDCARD: "IDCARD",
+  PASSPORT: "PASSPORT",
+  POPULATION_REGISTER: "POPULATION_REGISTER",
+  RESIDENCE_PERMIT: "RESIDENCE_PERMIT",
+  PROOF_OF_ARRIVAL: "PROOF_OF_ARRIVAL",
+  DRIVERS_LICENCE: "DRIVERS_LICENCE",
+  COMPANY_REGISTER: "COMPANY_REGISTER",
+  COMPANY_STATEMENT: "COMPANY_STATEMENT",
+  BANK_ACCOUNT: "BANK_ACCOUNT",
+  ONLINE_PAYMENT_ACCOUNT: "ONLINE_PAYMENT_ACCOUNT",
+  UTILITY_ACCOUNT: "UTILITY_ACCOUNT",
+  BANK_STATEMENT: "BANK_STATEMENT",
+  TAX_STATEMENT: "TAX_STATEMENT",
+  WRITTEN_ATTESTATION: "WRITTEN_ATTESTATION",
+  DIGITAL_ATTESTATION: "DIGITAL_ATTESTATION",
+  POSTAL_VER_TRANSACTION_LOG: "POSTAL_VER_TRANSACTION_LOG",
+  EMAIL_VER_TRANSACTION_LOG: "EMAIL_VER_TRANSACTION_LOG",
+  ADDRESS_DATABASE: "ADDRESS_DATABASE",
+} as const satisfies Record<string, ContactVerificationProof>;
+
+/**
+ * Array of all ContactVerificationProof enum values
+ *
+ * @remarks
+ * This constant provides a array containing all valid ContactVerificationProof enum values.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all values
+ * for (const value of CONTACT_VERIFICATION_PROOF_VALUES) {
+ *   console.log(`Processing: ${value}`);
+ * }
+ * 
+ * // Validation
+ * const isValid = CONTACT_VERIFICATION_PROOF_VALUES.includes(someValue);
+ * ```
+ *
+ * @see {@link ContactVerificationProof} - The TypeScript type definition
+ * @see {@link CONTACT_VERIFICATION_PROOF} - The object form of this enum
+ */
+export const CONTACT_VERIFICATION_PROOF_VALUES = [
+  'IDCARD',
+  'PASSPORT',
+  'POPULATION_REGISTER',
+  'RESIDENCE_PERMIT',
+  'PROOF_OF_ARRIVAL',
+  'DRIVERS_LICENCE',
+  'COMPANY_REGISTER',
+  'COMPANY_STATEMENT',
+  'BANK_ACCOUNT',
+  'ONLINE_PAYMENT_ACCOUNT',
+  'UTILITY_ACCOUNT',
+  'BANK_STATEMENT',
+  'TAX_STATEMENT',
+  'WRITTEN_ATTESTATION',
+  'DIGITAL_ATTESTATION',
+  'POSTAL_VER_TRANSACTION_LOG',
+  'EMAIL_VER_TRANSACTION_LOG',
+  'ADDRESS_DATABASE'
+] as const satisfies [string, ...string[]] | ContactVerificationProof[];
+
+/**
+ * ContactVerificationState. Auto-generated enum for ContactVerificationState
+ *
+ * @remarks
+ * This constant provides both object and array forms for the ContactVerificationState enum.
+ * The object form allows key-value access, while the array form enables iteration and validation.
+ *
+ * @example
+ * ```typescript
+ * // Using the object form for key-value access
+ * const status = CONTACT_VERIFICATION_STATE.SUCCESS;
+ * 
+ * // Using the array form for iteration
+ * const allStatuses = CONTACT_VERIFICATION_STATE_VALUES;
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
+ * ```
+ *
+ * @see {@link ContactVerificationState} - The TypeScript type definition
+ */
+export const CONTACT_VERIFICATION_STATE = {
+  UNVERIFIED: "UNVERIFIED",
+  VERIFIED: "VERIFIED",
+  IN_PROGRESS: "IN_PROGRESS",
+  EXPIRED: "EXPIRED",
+} as const satisfies Record<string, ContactVerificationState>;
+
+/**
+ * Array of all ContactVerificationState enum values
+ *
+ * @remarks
+ * This constant provides a array containing all valid ContactVerificationState enum values.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all values
+ * for (const value of CONTACT_VERIFICATION_STATE_VALUES) {
+ *   console.log(`Processing: ${value}`);
+ * }
+ * 
+ * // Validation
+ * const isValid = CONTACT_VERIFICATION_STATE_VALUES.includes(someValue);
+ * ```
+ *
+ * @see {@link ContactVerificationState} - The TypeScript type definition
+ * @see {@link CONTACT_VERIFICATION_STATE} - The object form of this enum
+ */
+export const CONTACT_VERIFICATION_STATE_VALUES = [
+  'UNVERIFIED',
+  'VERIFIED',
+  'IN_PROGRESS',
+  'EXPIRED'
+] as const satisfies [string, ...string[]] | ContactVerificationState[];
+
 /**
  * Currency. Auto-generated enum for Currency
  *