@opusdns/api 0.87.0 → 0.89.0

package/package.json

@@ -3,7 +3,7 @@
     "@opusdns/api-spec-ts-generator": "^0.9.1"
   },
   "name": "@opusdns/api",
-  "version": "0.87.0",
+  "version": "0.89.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, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ContactRoleType, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainSortField, DomainStatus, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, GrantType, LaunchPhaseType, LocalPresenceRequirementType, OrganizationStatus, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TransferAckType, UserStatus, VerificationType, ZoneSortField } from './schemas';
+import { AllocationMethodType, AttributeType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ContactRoleType, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainSortField, DomainStatus, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, GrantType, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, LaunchPhaseType, LocalPresenceRequirementType, OrganizationStatus, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TransferAckType, UserStatus, VerificationType, ZoneSortField } from './schemas';
 
 /**
  * AllocationMethodType. Auto-generated enum for AllocationMethodType
@@ -1601,6 +1601,222 @@ export const GRANT_TYPE_VALUES = [
   'refresh_token'
 ] as const satisfies [string, ...string[]] | GrantType[];
 
+/**
+ * HttpProtocol. Auto-generated enum for HttpProtocol
+ *
+ * @remarks
+ * This constant provides both object and array forms for the HttpProtocol 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 = HTTP_PROTOCOL.SUCCESS;
+ * 
+ * // Using the array form for iteration
+ * const allStatuses = HTTP_PROTOCOL_VALUES;
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
+ * ```
+ *
+ * @see {@link HttpProtocol} - The TypeScript type definition
+ */
+export const HTTP_PROTOCOL = {
+  HTTP: "http",
+  HTTPS: "https",
+} as const satisfies Record<string, HttpProtocol>;
+
+/**
+ * Array of all HttpProtocol enum values
+ *
+ * @remarks
+ * This constant provides a array containing all valid HttpProtocol enum values.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all values
+ * for (const value of HTTP_PROTOCOL_VALUES) {
+ *   console.log(`Processing: ${value}`);
+ * }
+ * 
+ * // Validation
+ * const isValid = HTTP_PROTOCOL_VALUES.includes(someValue);
+ * ```
+ *
+ * @see {@link HttpProtocol} - The TypeScript type definition
+ * @see {@link HTTP_PROTOCOL} - The object form of this enum
+ */
+export const HTTP_PROTOCOL_VALUES = [
+  'http',
+  'https'
+] as const satisfies [string, ...string[]] | HttpProtocol[];
+
+/**
+ * InvoiceResponsePaymentStatus. Auto-generated enum for InvoiceResponsePaymentStatus
+ *
+ * @remarks
+ * This constant provides both object and array forms for the InvoiceResponsePaymentStatus 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 = INVOICE_RESPONSE_PAYMENT_STATUS.SUCCESS;
+ * 
+ * // Using the array form for iteration
+ * const allStatuses = INVOICE_RESPONSE_PAYMENT_STATUS_VALUES;
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
+ * ```
+ *
+ * @see {@link InvoiceResponsePaymentStatus} - The TypeScript type definition
+ */
+export const INVOICE_RESPONSE_PAYMENT_STATUS = {
+  PENDING: "pending",
+  FAILED: "failed",
+  SUCCEEDED: "succeeded",
+} as const satisfies Record<string, InvoiceResponsePaymentStatus>;
+
+/**
+ * Array of all InvoiceResponsePaymentStatus enum values
+ *
+ * @remarks
+ * This constant provides a array containing all valid InvoiceResponsePaymentStatus enum values.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all values
+ * for (const value of INVOICE_RESPONSE_PAYMENT_STATUS_VALUES) {
+ *   console.log(`Processing: ${value}`);
+ * }
+ * 
+ * // Validation
+ * const isValid = INVOICE_RESPONSE_PAYMENT_STATUS_VALUES.includes(someValue);
+ * ```
+ *
+ * @see {@link InvoiceResponsePaymentStatus} - The TypeScript type definition
+ * @see {@link INVOICE_RESPONSE_PAYMENT_STATUS} - The object form of this enum
+ */
+export const INVOICE_RESPONSE_PAYMENT_STATUS_VALUES = [
+  'pending',
+  'failed',
+  'succeeded'
+] as const satisfies [string, ...string[]] | InvoiceResponsePaymentStatus[];
+
+/**
+ * InvoiceResponseStatus. Auto-generated enum for InvoiceResponseStatus
+ *
+ * @remarks
+ * This constant provides both object and array forms for the InvoiceResponseStatus 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 = INVOICE_RESPONSE_STATUS.SUCCESS;
+ * 
+ * // Using the array form for iteration
+ * const allStatuses = INVOICE_RESPONSE_STATUS_VALUES;
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
+ * ```
+ *
+ * @see {@link InvoiceResponseStatus} - The TypeScript type definition
+ */
+export const INVOICE_RESPONSE_STATUS = {
+  DRAFT: "draft",
+  FINALIZED: "finalized",
+  FAILED: "failed",
+  PENDING: "pending",
+  VOIDED: "voided",
+} as const satisfies Record<string, InvoiceResponseStatus>;
+
+/**
+ * Array of all InvoiceResponseStatus enum values
+ *
+ * @remarks
+ * This constant provides a array containing all valid InvoiceResponseStatus enum values.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all values
+ * for (const value of INVOICE_RESPONSE_STATUS_VALUES) {
+ *   console.log(`Processing: ${value}`);
+ * }
+ * 
+ * // Validation
+ * const isValid = INVOICE_RESPONSE_STATUS_VALUES.includes(someValue);
+ * ```
+ *
+ * @see {@link InvoiceResponseStatus} - The TypeScript type definition
+ * @see {@link INVOICE_RESPONSE_STATUS} - The object form of this enum
+ */
+export const INVOICE_RESPONSE_STATUS_VALUES = [
+  'draft',
+  'finalized',
+  'failed',
+  'pending',
+  'voided'
+] as const satisfies [string, ...string[]] | InvoiceResponseStatus[];
+
+/**
+ * InvoiceResponseType. Auto-generated enum for InvoiceResponseType
+ *
+ * @remarks
+ * This constant provides both object and array forms for the InvoiceResponseType 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 = INVOICE_RESPONSE_TYPE.SUCCESS;
+ * 
+ * // Using the array form for iteration
+ * const allStatuses = INVOICE_RESPONSE_TYPE_VALUES;
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
+ * ```
+ *
+ * @see {@link InvoiceResponseType} - The TypeScript type definition
+ */
+export const INVOICE_RESPONSE_TYPE = {
+  SUBSCRIPTION: "subscription",
+  ADD_ON: "add_on",
+  CREDIT: "credit",
+  ONE_OFF: "one_off",
+  ADVANCE_CHARGES: "advance_charges",
+  PROGRESSIVE_BILLING: "progressive_billing",
+} as const satisfies Record<string, InvoiceResponseType>;
+
+/**
+ * Array of all InvoiceResponseType enum values
+ *
+ * @remarks
+ * This constant provides a array containing all valid InvoiceResponseType enum values.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all values
+ * for (const value of INVOICE_RESPONSE_TYPE_VALUES) {
+ *   console.log(`Processing: ${value}`);
+ * }
+ * 
+ * // Validation
+ * const isValid = INVOICE_RESPONSE_TYPE_VALUES.includes(someValue);
+ * ```
+ *
+ * @see {@link InvoiceResponseType} - The TypeScript type definition
+ * @see {@link INVOICE_RESPONSE_TYPE} - The object form of this enum
+ */
+export const INVOICE_RESPONSE_TYPE_VALUES = [
+  'subscription',
+  'add_on',
+  'credit',
+  'one_off',
+  'advance_charges',
+  'progressive_billing'
+] as const satisfies [string, ...string[]] | InvoiceResponseType[];
+
 /**
  * LaunchPhaseType. Auto-generated enum for LaunchPhaseType
  *
@@ -2171,6 +2387,29 @@ export const PREMIUM_SOURCE_TYPE_VALUES = [
   'manual'
 ] as const satisfies [string, ...string[]] | PremiumSourceType[];
 
+/**
+ * RedirectCode. Auto-generated enum for RedirectCode
+ *
+ * @remarks
+ * This constant provides an array of integer values for the RedirectCode enum.
+ * Integer enums are represented as typed arrays for efficient iteration and validation.
+ *
+ * @example
+ * ```typescript
+ * // Using the array for iteration
+ * const algorithms = DNSSEC_ALGORITHM;
+ * console.log(`Available algorithms: ${algorithms.join(', ')}`);
+ * ```
+ *
+ * @see {@link RedirectCode} - The TypeScript type definition
+ */
+export const REDIRECT_CODE = [
+  301,
+  302,
+  307,
+  308
+] as const satisfies RedirectCode[];
+
 /**
  * RegistrantChangeType. Auto-generated enum for RegistrantChangeType
  *