@opusdns/api 0.97.0 → 0.99.0

package/package.json

@@ -3,7 +3,7 @@
     "@opusdns/api-spec-ts-generator": "^0.9.1"
   },
   "name": "@opusdns/api",
-  "version": "0.97.0",
+  "version": "0.99.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, 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';
+import { AllocationMethodType, AttributeType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ContactRoleType, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, 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
@@ -1125,6 +1125,108 @@ export const DOMAIN_CONTACT_TYPE_VALUES = [
   'billing'
 ] as const satisfies [string, ...string[]] | DomainContactType[];
 
+/**
+ * DomainForwardSortField. Auto-generated enum for DomainForwardSortField
+ *
+ * @remarks
+ * This constant provides both object and array forms for the DomainForwardSortField 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 = DOMAIN_FORWARD_SORT_FIELD.SUCCESS;
+ * 
+ * // Using the array form for iteration
+ * const allStatuses = DOMAIN_FORWARD_SORT_FIELD_VALUES;
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
+ * ```
+ *
+ * @see {@link DomainForwardSortField} - The TypeScript type definition
+ */
+export const DOMAIN_FORWARD_SORT_FIELD = {
+  HOSTNAME: "hostname",
+  ENABLED: "enabled",
+  CREATED_ON: "created_on",
+} as const satisfies Record<string, DomainForwardSortField>;
+
+/**
+ * Array of all DomainForwardSortField enum values
+ *
+ * @remarks
+ * This constant provides a array containing all valid DomainForwardSortField enum values.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all values
+ * for (const value of DOMAIN_FORWARD_SORT_FIELD_VALUES) {
+ *   console.log(`Processing: ${value}`);
+ * }
+ * 
+ * // Validation
+ * const isValid = DOMAIN_FORWARD_SORT_FIELD_VALUES.includes(someValue);
+ * ```
+ *
+ * @see {@link DomainForwardSortField} - The TypeScript type definition
+ * @see {@link DOMAIN_FORWARD_SORT_FIELD} - The object form of this enum
+ */
+export const DOMAIN_FORWARD_SORT_FIELD_VALUES = [
+  'hostname',
+  'enabled',
+  'created_on'
+] as const satisfies [string, ...string[]] | DomainForwardSortField[];
+
+/**
+ * DomainForwardZoneSortField. Auto-generated enum for DomainForwardZoneSortField
+ *
+ * @remarks
+ * This constant provides both object and array forms for the DomainForwardZoneSortField 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 = DOMAIN_FORWARD_ZONE_SORT_FIELD.SUCCESS;
+ * 
+ * // Using the array form for iteration
+ * const allStatuses = DOMAIN_FORWARD_ZONE_SORT_FIELD_VALUES;
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
+ * ```
+ *
+ * @see {@link DomainForwardZoneSortField} - The TypeScript type definition
+ */
+export const DOMAIN_FORWARD_ZONE_SORT_FIELD = {
+  NAME: "name",
+  CREATED_ON: "created_on",
+} as const satisfies Record<string, DomainForwardZoneSortField>;
+
+/**
+ * Array of all DomainForwardZoneSortField enum values
+ *
+ * @remarks
+ * This constant provides a array containing all valid DomainForwardZoneSortField enum values.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all values
+ * for (const value of DOMAIN_FORWARD_ZONE_SORT_FIELD_VALUES) {
+ *   console.log(`Processing: ${value}`);
+ * }
+ * 
+ * // Validation
+ * const isValid = DOMAIN_FORWARD_ZONE_SORT_FIELD_VALUES.includes(someValue);
+ * ```
+ *
+ * @see {@link DomainForwardZoneSortField} - The TypeScript type definition
+ * @see {@link DOMAIN_FORWARD_ZONE_SORT_FIELD} - The object form of this enum
+ */
+export const DOMAIN_FORWARD_ZONE_SORT_FIELD_VALUES = [
+  'name',
+  'created_on'
+] as const satisfies [string, ...string[]] | DomainForwardZoneSortField[];
+
 /**
  * DomainSortField. Auto-generated enum for DomainSortField
  *

package/src/helpers/requests.d.ts

@@ -1098,7 +1098,7 @@ export type PUT_DnsZoneNameRrsets_Request_Body = PUT_DnsZoneNameRrsets_Request['
  * Request type for GET DomainForwards endpoint
  *
  * List domain forwards
- * Retrieves a paginated list of domain forwards for the organization
+ * Retrieves a paginated list of domain forwards by hostname for the organization
  *
  * @remarks
  * This type defines the complete request structure for the GET DomainForwards endpoint.
@@ -1364,8 +1364,6 @@ export type PATCH_DomainForwardsHostnameDisable_Request_Path = PATCH_DomainForwa
  *
  * @path /v1/domain-forwards/{hostname}/enable
  * @param hostname (path) - Hostname
- * @param auto_create_zone (query) - Auto create zone if it doesn't exist
- * @param auto_create_domain_forward (query) - Auto create domain forward if it doesn't exist
  * @param wildcard (query) - Wildcard domain forwarding
  *
  * @see {@link PATCH_DomainForwardsHostnameEnable_Request_Query} - Query parameters type
@@ -1389,8 +1387,6 @@ export type PATCH_DomainForwardsHostnameEnable_Request = {
  * Use this type to ensure type safety for query parameters.
  *
  * @path /v1/domain-forwards/{hostname}/enable
- * @param auto_create_zone (query) - Auto create zone if it doesn't exist
- * @param auto_create_domain_forward (query) - Auto create domain forward if it doesn't exist
  * @param wildcard (query) - Wildcard domain forwarding
  */
 export type PATCH_DomainForwardsHostnameEnable_Request_Query = PATCH_DomainForwardsHostnameEnable_Request['parameters']['query'];

package/src/helpers/responses.d.ts

@@ -1854,7 +1854,7 @@ export type GET_DnsSummary_Response_200 = DnsZoneSummary
  * Response types for GET DomainForwards endpoint
  *
  * List domain forwards
- * Retrieves a paginated list of domain forwards for the organization
+ * Retrieves a paginated list of domain forwards by hostname for the organization
  *
  * @remarks
  * This type defines all possible response structures for the GET DomainForwards endpoint.
@@ -2939,8 +2939,6 @@ export type PATCH_DomainForwardsByHostnameDisable_Response_422 = HTTPValidationE
  *
  * @path /v1/domain-forwards/{hostname}/enable
  * @param hostname (path) - Hostname
- * @param auto_create_zone (query) - Auto create zone if it doesn't exist
- * @param auto_create_domain_forward (query) - Auto create domain forward if it doesn't exist
  * @param wildcard (query) - Wildcard domain forwarding
  *
  * @see {@link PATCH_DomainForwardsByHostnameEnable_Response_400} - 400 response type
@@ -2964,8 +2962,6 @@ export type PATCH_DomainForwardsByHostnameEnable_Response = PATCH_DomainForwards
  *
  * @path /v1/domain-forwards/{hostname}/enable
  * @param hostname (path) - Hostname
- * @param auto_create_zone (query) - Auto create zone if it doesn't exist
- * @param auto_create_domain_forward (query) - Auto create domain forward if it doesn't exist
  * @param wildcard (query) - Wildcard domain forwarding
  *
  * @see {@link PATCH_DomainForwardsByHostnameEnable_Response} - The main response type definition
@@ -2985,8 +2981,6 @@ export type PATCH_DomainForwardsByHostnameEnable_Response_400 = Problem
  *
  * @path /v1/domain-forwards/{hostname}/enable
  * @param hostname (path) - Hostname
- * @param auto_create_zone (query) - Auto create zone if it doesn't exist
- * @param auto_create_domain_forward (query) - Auto create domain forward if it doesn't exist
  * @param wildcard (query) - Wildcard domain forwarding
  *
  * @see {@link PATCH_DomainForwardsByHostnameEnable_Response} - The main response type definition
@@ -3006,8 +3000,6 @@ export type PATCH_DomainForwardsByHostnameEnable_Response_401 = Problem
  *
  * @path /v1/domain-forwards/{hostname}/enable
  * @param hostname (path) - Hostname
- * @param auto_create_zone (query) - Auto create zone if it doesn't exist
- * @param auto_create_domain_forward (query) - Auto create domain forward if it doesn't exist
  * @param wildcard (query) - Wildcard domain forwarding
  *
  * @see {@link PATCH_DomainForwardsByHostnameEnable_Response} - The main response type definition
@@ -3027,8 +3019,6 @@ export type PATCH_DomainForwardsByHostnameEnable_Response_403 = Problem
  *
  * @path /v1/domain-forwards/{hostname}/enable
  * @param hostname (path) - Hostname
- * @param auto_create_zone (query) - Auto create zone if it doesn't exist
- * @param auto_create_domain_forward (query) - Auto create domain forward if it doesn't exist
  * @param wildcard (query) - Wildcard domain forwarding
  *
  * @see {@link PATCH_DomainForwardsByHostnameEnable_Response} - The main response type definition

package/src/helpers/schemas.d.ts

@@ -1146,6 +1146,22 @@ export type DomainForwardSetRequest = components['schemas']['DomainForwardSetReq
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type DomainForwardSet = components['schemas']['DomainForwardSetResponse'];
+/**
+ * DomainForwardSortField
+ *
+ * @remarks
+ * Type alias for the `DomainForwardSortField` OpenAPI schema.
+ * This type represents domainforwardsortfield data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getDomainForwardSortField();
+ * const item: DomainForwardSortField = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type DomainForwardSortField = components['schemas']['DomainForwardSortField'];
 /**
  * DomainForwardZone
  *
@@ -1162,6 +1178,22 @@ export type DomainForwardSet = components['schemas']['DomainForwardSetResponse']
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type DomainForwardZone = components['schemas']['DomainForwardZone'];
+/**
+ * DomainForwardZoneSortField
+ *
+ * @remarks
+ * Type alias for the `DomainForwardZoneSortField` OpenAPI schema.
+ * This type represents domainforwardzonesortfield data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getDomainForwardZoneSortField();
+ * const item: DomainForwardZoneSortField = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type DomainForwardZoneSortField = components['schemas']['DomainForwardZoneSortField'];
 /**
  * DomainLifecycleBase
  *

package/src/openapi.yaml

@@ -1703,6 +1703,13 @@ components:
       - created_on
       title: DomainForwardSetResponse
       type: object
+    DomainForwardSortField:
+      enum:
+      - hostname
+      - enabled
+      - created_on
+      title: DomainForwardSortField
+      type: string
     DomainForwardZone:
       properties:
         domain_forwards:
@@ -1727,6 +1734,12 @@ components:
       - domain_forwards
       title: DomainForwardZone
       type: object
+    DomainForwardZoneSortField:
+      enum:
+      - name
+      - created_on
+      title: DomainForwardZoneSortField
+      type: string
     DomainLifecycleBase:
       properties:
         add_grace_period:
@@ -5318,7 +5331,7 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2025-11-17-131834
+  version: 2025-11-24-120310
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -6540,34 +6553,6 @@ paths:
       description: Retrieves a paginated list of domain forwards grouped by DNS zones.
       operationId: list_domain_forwards_by_zone_v1_dns_domain_forwards_get
       parameters:
-      - in: query
-        name: sort_by
-        required: false
-        schema:
-          $ref: '#/components/schemas/ZoneSortField'
-          default: created_on
-      - in: query
-        name: sort_order
-        required: false
-        schema:
-          $ref: '#/components/schemas/SortOrder'
-          default: desc
-      - in: query
-        name: dnssec_status
-        required: false
-        schema:
-          anyOf:
-          - $ref: '#/components/schemas/DnssecStatus'
-          - type: 'null'
-          title: Dnssec Status
-      - in: query
-        name: name
-        required: false
-        schema:
-          anyOf:
-          - type: string
-          - type: 'null'
-          title: Name
       - in: query
         name: search
         required: false
@@ -6577,49 +6562,17 @@ paths:
           - type: 'null'
           title: Search
       - in: query
-        name: suffix
-        required: false
-        schema:
-          anyOf:
-          - type: string
-          - type: 'null'
-          title: Suffix
-      - in: query
-        name: created_after
-        required: false
-        schema:
-          anyOf:
-          - format: date-time
-            type: string
-          - type: 'null'
-          title: Created After
-      - in: query
-        name: created_before
-        required: false
-        schema:
-          anyOf:
-          - format: date-time
-            type: string
-          - type: 'null'
-          title: Created Before
-      - in: query
-        name: updated_after
+        name: sort_by
         required: false
         schema:
-          anyOf:
-          - format: date-time
-            type: string
-          - type: 'null'
-          title: Updated After
+          $ref: '#/components/schemas/DomainForwardZoneSortField'
+          default: created_on
       - in: query
-        name: updated_before
+        name: sort_order
         required: false
         schema:
-          anyOf:
-          - format: date-time
-            type: string
-          - type: 'null'
-          title: Updated Before
+          $ref: '#/components/schemas/SortOrder'
+          default: desc
       - in: query
         name: page
         required: false
@@ -6998,37 +6951,10 @@ paths:
       - dns
   /v1/domain-forwards:
     get:
-      description: Retrieves a paginated list of domain forwards for the organization
+      description: Retrieves a paginated list of domain forwards by hostname for the
+        organization
       operationId: list_domain_forwards_v1_domain_forwards_get
       parameters:
-      - in: query
-        name: sort_by
-        required: false
-        schema:
-          $ref: '#/components/schemas/ZoneSortField'
-          default: created_on
-      - in: query
-        name: sort_order
-        required: false
-        schema:
-          $ref: '#/components/schemas/SortOrder'
-          default: desc
-      - in: query
-        name: dnssec_status
-        required: false
-        schema:
-          anyOf:
-          - $ref: '#/components/schemas/DnssecStatus'
-          - type: 'null'
-          title: Dnssec Status
-      - in: query
-        name: name
-        required: false
-        schema:
-          anyOf:
-          - type: string
-          - type: 'null'
-          title: Name
       - in: query
         name: search
         required: false
@@ -7038,49 +6964,17 @@ paths:
           - type: 'null'
           title: Search
       - in: query
-        name: suffix
-        required: false
-        schema:
-          anyOf:
-          - type: string
-          - type: 'null'
-          title: Suffix
-      - in: query
-        name: created_after
-        required: false
-        schema:
-          anyOf:
-          - format: date-time
-            type: string
-          - type: 'null'
-          title: Created After
-      - in: query
-        name: created_before
-        required: false
-        schema:
-          anyOf:
-          - format: date-time
-            type: string
-          - type: 'null'
-          title: Created Before
-      - in: query
-        name: updated_after
+        name: sort_by
         required: false
         schema:
-          anyOf:
-          - format: date-time
-            type: string
-          - type: 'null'
-          title: Updated After
+          $ref: '#/components/schemas/DomainForwardSortField'
+          default: created_on
       - in: query
-        name: updated_before
+        name: sort_order
         required: false
         schema:
-          anyOf:
-          - format: date-time
-            type: string
-          - type: 'null'
-          title: Updated Before
+          $ref: '#/components/schemas/SortOrder'
+          default: desc
       - in: query
         name: page
         required: false
@@ -7576,24 +7470,6 @@ paths:
           description: Hostname
           title: Hostname
           type: string
-      - description: Auto create zone if it doesn't exist
-        in: query
-        name: auto_create_zone
-        required: false
-        schema:
-          default: false
-          description: Auto create zone if it doesn't exist
-          title: Auto Create Zone
-          type: boolean
-      - description: Auto create domain forward if it doesn't exist
-        in: query
-        name: auto_create_domain_forward
-        required: false
-        schema:
-          default: false
-          description: Auto create domain forward if it doesn't exist
-          title: Auto Create Domain Forward
-          type: boolean
       - description: Wildcard domain forwarding
         in: query
         name: wildcard

package/src/schema.d.ts

@@ -331,7 +331,7 @@ export interface paths {
         };
         /**
          * List domain forwards
-         * @description Retrieves a paginated list of domain forwards for the organization
+         * @description Retrieves a paginated list of domain forwards by hostname for the organization
          */
         get: operations["list_domain_forwards_v1_domain_forwards_get"];
         put?: never;
@@ -2454,6 +2454,11 @@ export interface components {
             /** Wildcard */
             wildcard: boolean;
         };
+        /**
+         * DomainForwardSortField
+         * @enum {string}
+         */
+        DomainForwardSortField: "hostname" | "enabled" | "created_on";
         /** DomainForwardZone */
         DomainForwardZone: {
             /** Domain Forwards */
@@ -2467,6 +2472,11 @@ export interface components {
             /** Zone Name */
             zone_name: string;
         };
+        /**
+         * DomainForwardZoneSortField
+         * @enum {string}
+         */
+        DomainForwardZoneSortField: "name" | "created_on";
         /** DomainLifecycleBase */
         DomainLifecycleBase: {
             /**
@@ -5741,16 +5751,9 @@ export interface operations {
     list_domain_forwards_by_zone_v1_dns_domain_forwards_get: {
         parameters: {
             query?: {
-                sort_by?: components["schemas"]["ZoneSortField"];
-                sort_order?: components["schemas"]["SortOrder"];
-                dnssec_status?: components["schemas"]["DnssecStatus"] | null;
-                name?: string | null;
                 search?: string | null;
-                suffix?: string | null;
-                created_after?: Date | null;
-                created_before?: Date | null;
-                updated_after?: Date | null;
-                updated_before?: Date | null;
+                sort_by?: components["schemas"]["DomainForwardZoneSortField"];
+                sort_order?: components["schemas"]["SortOrder"];
                 page?: number;
                 page_size?: number;
             };
@@ -6175,16 +6178,9 @@ export interface operations {
     list_domain_forwards_v1_domain_forwards_get: {
         parameters: {
             query?: {
-                sort_by?: components["schemas"]["ZoneSortField"];
-                sort_order?: components["schemas"]["SortOrder"];
-                dnssec_status?: components["schemas"]["DnssecStatus"] | null;
-                name?: string | null;
                 search?: string | null;
-                suffix?: string | null;
-                created_after?: Date | null;
-                created_before?: Date | null;
-                updated_after?: Date | null;
-                updated_before?: Date | null;
+                sort_by?: components["schemas"]["DomainForwardSortField"];
+                sort_order?: components["schemas"]["SortOrder"];
                 page?: number;
                 page_size?: number;
             };
@@ -6649,10 +6645,6 @@ export interface operations {
     enable_domain_forward_v1_domain_forwards__hostname__enable_patch: {
         parameters: {
             query?: {
-                /** @description Auto create zone if it doesn't exist */
-                auto_create_zone?: boolean;
-                /** @description Auto create domain forward if it doesn't exist */
-                auto_create_domain_forward?: boolean;
                 /** @description Wildcard domain forwarding */
                 wildcard?: boolean;
             };