@opusdns/api 0.289.0 → 0.291.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "@opusdns/api-spec-ts-generator": "^0.19.0"
4
4
  },
5
5
  "name": "@opusdns/api",
6
- "version": "0.289.0",
6
+ "version": "0.291.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -21,7 +21,7 @@
21
21
  * ```
22
22
  */
23
23
 
24
- import { AllocationMethodType, AttributeType, BatchSortField, BatchStatus, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ComplianceStatus, ConditionOperator, ContactAttributeSetSortField, ContactIncludeField, ContactSortField, 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, ExecutingEntity, HTTPMethod, 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, SyncOperationType, TLDType, TagColor, TagFilterMode, TagSortField, TagType, TimeRange, TransferAckType, UserSortField, UserStatus, VerificationType, ZoneIncludeField, ZoneSortField } from './schemas';
24
+ 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, SyncOperationType, TLDType, TagColor, TagFilterMode, TagSortField, TagType, TimeRange, TransferAckType, UserSortField, UserStatus, VerificationClaimType, VerificationDeadlineType, VerificationType, ZoneIncludeField, ZoneSortField } from './schemas';
25
25
 
26
26
  /**
27
27
  * AllocationMethodType. Auto-generated enum for AllocationMethodType
@@ -729,6 +729,58 @@ export const CONTACT_SORT_FIELD_VALUES = [
729
729
  'created_on'
730
730
  ] as const satisfies [string, ...string[]] | ContactSortField[];
731
731
 
732
+ /**
733
+ * ContactType. Auto-generated enum for ContactType
734
+ *
735
+ * @remarks
736
+ * This constant provides both object and array forms for the ContactType enum.
737
+ * The object form allows key-value access, while the array form enables iteration and validation.
738
+ *
739
+ * @example
740
+ * ```typescript
741
+ * // Using the object form for key-value access
742
+ * const status = CONTACT_TYPE.SUCCESS;
743
+ *
744
+ * // Using the array form for iteration
745
+ * const allStatuses = CONTACT_TYPE_VALUES;
746
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
747
+ * ```
748
+ *
749
+ * @see {@link ContactType} - The TypeScript type definition
750
+ */
751
+ export const CONTACT_TYPE = {
752
+ OWNER: "owner",
753
+ AGENT: "agent",
754
+ THIRD_PARTY: "third party",
755
+ } as const satisfies Record<string, ContactType>;
756
+
757
+ /**
758
+ * Array of all ContactType enum values
759
+ *
760
+ * @remarks
761
+ * This constant provides a array containing all valid ContactType enum values.
762
+ * Useful for iteration, validation, and generating dynamic UI components.
763
+ *
764
+ * @example
765
+ * ```typescript
766
+ * // Iterating through all values
767
+ * for (const value of CONTACT_TYPE_VALUES) {
768
+ * console.log(`Processing: ${value}`);
769
+ * }
770
+ *
771
+ * // Validation
772
+ * const isValid = CONTACT_TYPE_VALUES.includes(someValue);
773
+ * ```
774
+ *
775
+ * @see {@link ContactType} - The TypeScript type definition
776
+ * @see {@link CONTACT_TYPE} - The object form of this enum
777
+ */
778
+ export const CONTACT_TYPE_VALUES = [
779
+ 'owner',
780
+ 'agent',
781
+ 'third party'
782
+ ] as const satisfies [string, ...string[]] | ContactType[];
783
+
732
784
  /**
733
785
  * Currency. Auto-generated enum for Currency
734
786
  *
@@ -2273,6 +2325,54 @@ export const EVENT_TYPE_VALUES = [
2273
2325
  'VERIFICATION'
2274
2326
  ] as const satisfies [string, ...string[]] | EventType[];
2275
2327
 
2328
+ /**
2329
+ * EventVersion. Auto-generated enum for EventVersion
2330
+ *
2331
+ * @remarks
2332
+ * This constant provides both object and array forms for the EventVersion enum.
2333
+ * The object form allows key-value access, while the array form enables iteration and validation.
2334
+ *
2335
+ * @example
2336
+ * ```typescript
2337
+ * // Using the object form for key-value access
2338
+ * const status = EVENT_VERSION.SUCCESS;
2339
+ *
2340
+ * // Using the array form for iteration
2341
+ * const allStatuses = EVENT_VERSION_VALUES;
2342
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
2343
+ * ```
2344
+ *
2345
+ * @see {@link EventVersion} - The TypeScript type definition
2346
+ */
2347
+ export const EVENT_VERSION = {
2348
+ "1_0": "1.0",
2349
+ } as const satisfies Record<string, EventVersion>;
2350
+
2351
+ /**
2352
+ * Array of all EventVersion enum values
2353
+ *
2354
+ * @remarks
2355
+ * This constant provides a array containing all valid EventVersion enum values.
2356
+ * Useful for iteration, validation, and generating dynamic UI components.
2357
+ *
2358
+ * @example
2359
+ * ```typescript
2360
+ * // Iterating through all values
2361
+ * for (const value of EVENT_VERSION_VALUES) {
2362
+ * console.log(`Processing: ${value}`);
2363
+ * }
2364
+ *
2365
+ * // Validation
2366
+ * const isValid = EVENT_VERSION_VALUES.includes(someValue);
2367
+ * ```
2368
+ *
2369
+ * @see {@link EventVersion} - The TypeScript type definition
2370
+ * @see {@link EVENT_VERSION} - The object form of this enum
2371
+ */
2372
+ export const EVENT_VERSION_VALUES = [
2373
+ '1.0'
2374
+ ] as const satisfies [string, ...string[]] | EventVersion[];
2375
+
2276
2376
  /**
2277
2377
  * ExecutingEntity. Auto-generated enum for ExecutingEntity
2278
2378
  *
@@ -2394,6 +2494,58 @@ export const HTTP_METHOD_VALUES = [
2394
2494
  'TRACE'
2395
2495
  ] as const satisfies [string, ...string[]] | HTTPMethod[];
2396
2496
 
2497
+ /**
2498
+ * HolderEntitlement. Auto-generated enum for HolderEntitlement
2499
+ *
2500
+ * @remarks
2501
+ * This constant provides both object and array forms for the HolderEntitlement enum.
2502
+ * The object form allows key-value access, while the array form enables iteration and validation.
2503
+ *
2504
+ * @example
2505
+ * ```typescript
2506
+ * // Using the object form for key-value access
2507
+ * const status = HOLDER_ENTITLEMENT.SUCCESS;
2508
+ *
2509
+ * // Using the array form for iteration
2510
+ * const allStatuses = HOLDER_ENTITLEMENT_VALUES;
2511
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
2512
+ * ```
2513
+ *
2514
+ * @see {@link HolderEntitlement} - The TypeScript type definition
2515
+ */
2516
+ export const HOLDER_ENTITLEMENT = {
2517
+ OWNER: "owner",
2518
+ ASSIGNEE: "assignee",
2519
+ LICENSEE: "licensee",
2520
+ } as const satisfies Record<string, HolderEntitlement>;
2521
+
2522
+ /**
2523
+ * Array of all HolderEntitlement enum values
2524
+ *
2525
+ * @remarks
2526
+ * This constant provides a array containing all valid HolderEntitlement enum values.
2527
+ * Useful for iteration, validation, and generating dynamic UI components.
2528
+ *
2529
+ * @example
2530
+ * ```typescript
2531
+ * // Iterating through all values
2532
+ * for (const value of HOLDER_ENTITLEMENT_VALUES) {
2533
+ * console.log(`Processing: ${value}`);
2534
+ * }
2535
+ *
2536
+ * // Validation
2537
+ * const isValid = HOLDER_ENTITLEMENT_VALUES.includes(someValue);
2538
+ * ```
2539
+ *
2540
+ * @see {@link HolderEntitlement} - The TypeScript type definition
2541
+ * @see {@link HOLDER_ENTITLEMENT} - The object form of this enum
2542
+ */
2543
+ export const HOLDER_ENTITLEMENT_VALUES = [
2544
+ 'owner',
2545
+ 'assignee',
2546
+ 'licensee'
2547
+ ] as const satisfies [string, ...string[]] | HolderEntitlement[];
2548
+
2397
2549
  /**
2398
2550
  * HostStatus. Auto-generated enum for HostStatus
2399
2551
  *
@@ -5143,6 +5295,110 @@ export const USER_STATUS_VALUES = [
5143
5295
  'inactive'
5144
5296
  ] as const satisfies [string, ...string[]] | UserStatus[];
5145
5297
 
5298
+ /**
5299
+ * VerificationClaimType. Auto-generated enum for VerificationClaimType
5300
+ *
5301
+ * @remarks
5302
+ * This constant provides both object and array forms for the VerificationClaimType enum.
5303
+ * The object form allows key-value access, while the array form enables iteration and validation.
5304
+ *
5305
+ * @example
5306
+ * ```typescript
5307
+ * // Using the object form for key-value access
5308
+ * const status = VERIFICATION_CLAIM_TYPE.SUCCESS;
5309
+ *
5310
+ * // Using the array form for iteration
5311
+ * const allStatuses = VERIFICATION_CLAIM_TYPE_VALUES;
5312
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
5313
+ * ```
5314
+ *
5315
+ * @see {@link VerificationClaimType} - The TypeScript type definition
5316
+ */
5317
+ export const VERIFICATION_CLAIM_TYPE = {
5318
+ NAME: "name",
5319
+ ADDRESS: "address",
5320
+ EMAIL: "email",
5321
+ PHONE: "phone",
5322
+ } as const satisfies Record<string, VerificationClaimType>;
5323
+
5324
+ /**
5325
+ * Array of all VerificationClaimType enum values
5326
+ *
5327
+ * @remarks
5328
+ * This constant provides a array containing all valid VerificationClaimType enum values.
5329
+ * Useful for iteration, validation, and generating dynamic UI components.
5330
+ *
5331
+ * @example
5332
+ * ```typescript
5333
+ * // Iterating through all values
5334
+ * for (const value of VERIFICATION_CLAIM_TYPE_VALUES) {
5335
+ * console.log(`Processing: ${value}`);
5336
+ * }
5337
+ *
5338
+ * // Validation
5339
+ * const isValid = VERIFICATION_CLAIM_TYPE_VALUES.includes(someValue);
5340
+ * ```
5341
+ *
5342
+ * @see {@link VerificationClaimType} - The TypeScript type definition
5343
+ * @see {@link VERIFICATION_CLAIM_TYPE} - The object form of this enum
5344
+ */
5345
+ export const VERIFICATION_CLAIM_TYPE_VALUES = [
5346
+ 'name',
5347
+ 'address',
5348
+ 'email',
5349
+ 'phone'
5350
+ ] as const satisfies [string, ...string[]] | VerificationClaimType[];
5351
+
5352
+ /**
5353
+ * VerificationDeadlineType. Auto-generated enum for VerificationDeadlineType
5354
+ *
5355
+ * @remarks
5356
+ * This constant provides both object and array forms for the VerificationDeadlineType enum.
5357
+ * The object form allows key-value access, while the array form enables iteration and validation.
5358
+ *
5359
+ * @example
5360
+ * ```typescript
5361
+ * // Using the object form for key-value access
5362
+ * const status = VERIFICATION_DEADLINE_TYPE.SUCCESS;
5363
+ *
5364
+ * // Using the array form for iteration
5365
+ * const allStatuses = VERIFICATION_DEADLINE_TYPE_VALUES;
5366
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
5367
+ * ```
5368
+ *
5369
+ * @see {@link VerificationDeadlineType} - The TypeScript type definition
5370
+ */
5371
+ export const VERIFICATION_DEADLINE_TYPE = {
5372
+ DEDELEGATION: "dedelegation",
5373
+ DELETION: "deletion",
5374
+ } as const satisfies Record<string, VerificationDeadlineType>;
5375
+
5376
+ /**
5377
+ * Array of all VerificationDeadlineType enum values
5378
+ *
5379
+ * @remarks
5380
+ * This constant provides a array containing all valid VerificationDeadlineType enum values.
5381
+ * Useful for iteration, validation, and generating dynamic UI components.
5382
+ *
5383
+ * @example
5384
+ * ```typescript
5385
+ * // Iterating through all values
5386
+ * for (const value of VERIFICATION_DEADLINE_TYPE_VALUES) {
5387
+ * console.log(`Processing: ${value}`);
5388
+ * }
5389
+ *
5390
+ * // Validation
5391
+ * const isValid = VERIFICATION_DEADLINE_TYPE_VALUES.includes(someValue);
5392
+ * ```
5393
+ *
5394
+ * @see {@link VerificationDeadlineType} - The TypeScript type definition
5395
+ * @see {@link VERIFICATION_DEADLINE_TYPE} - The object form of this enum
5396
+ */
5397
+ export const VERIFICATION_DEADLINE_TYPE_VALUES = [
5398
+ 'dedelegation',
5399
+ 'deletion'
5400
+ ] as const satisfies [string, ...string[]] | VerificationDeadlineType[];
5401
+
5146
5402
  /**
5147
5403
  * VerificationType. Auto-generated enum for VerificationType
5148
5404
  *