@opusdns/api 0.214.0 → 0.216.0

package/package.json

@@ -3,7 +3,7 @@
     "@opusdns/api-spec-ts-generator": "^0.19.0"
   },
   "name": "@opusdns/api",
-  "version": "0.214.0",
+  "version": "0.216.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, ComplianceStatus, ConditionOperator, ContactAttributeSetSortField, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainSortField, DomainStatus, EmailForwardLogSortField, EmailForwardLogStatus, EmailForwardSortField, EmailForwardZoneSortField, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, ExecutingEntity, GrantType, HTTPMethod, HostStatus, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, LaunchPhaseType, LegalRequirementOperationType, LegalRequirementType, LocalPresenceRequirementType, MetricsGrouping, ObjectEventType, ObjectLogSortField, OrganizationStatus, ParkingSortField, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, Protocol, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, RequestHistorySortField, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TimeRange, TransferAckType, UserStatus, VerificationType, ZoneSortField } from './schemas';
+import { AllocationMethodType, AttributeType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ComplianceStatus, ConditionOperator, ContactAttributeSetSortField, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsProtectedReason, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainSortField, DomainStatus, EmailForwardLogSortField, EmailForwardLogStatus, EmailForwardSortField, EmailForwardZoneSortField, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, ExecutingEntity, GrantType, HTTPMethod, HostStatus, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, LaunchPhaseType, LegalRequirementOperationType, LegalRequirementType, LocalPresenceRequirementType, MetricsGrouping, ObjectEventType, ObjectLogSortField, OrganizationSortField, OrganizationStatus, ParkingSortField, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, Protocol, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, RequestHistorySortField, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TimeRange, TransferAckType, UserSortField, UserStatus, VerificationType, ZoneSortField } from './schemas';
 
 /**
  * AllocationMethodType. Auto-generated enum for AllocationMethodType
@@ -733,6 +733,62 @@ export const DNS_CHANGE_ACTION_VALUES = [
   'disable_dnssec'
 ] as const satisfies [string, ...string[]] | DnsChangeAction[];
 
+/**
+ * DnsProtectedReason. Auto-generated enum for DnsProtectedReason
+ *
+ * @remarks
+ * This constant provides both object and array forms for the DnsProtectedReason 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 = DNS_PROTECTED_REASON.SUCCESS;
+ * 
+ * // Using the array form for iteration
+ * const allStatuses = DNS_PROTECTED_REASON_VALUES;
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
+ * ```
+ *
+ * @see {@link DnsProtectedReason} - The TypeScript type definition
+ */
+export const DNS_PROTECTED_REASON = {
+  SYSTEM_MANAGED_SOA: "SYSTEM_MANAGED_SOA",
+  SYSTEM_MANAGED_NS: "SYSTEM_MANAGED_NS",
+  EMAIL_FORWARD: "EMAIL_FORWARD",
+  DOMAIN_FORWARD: "DOMAIN_FORWARD",
+  GENERIC: "GENERIC",
+} as const satisfies Record<string, DnsProtectedReason>;
+
+/**
+ * Array of all DnsProtectedReason enum values
+ *
+ * @remarks
+ * This constant provides a array containing all valid DnsProtectedReason enum values.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all values
+ * for (const value of DNS_PROTECTED_REASON_VALUES) {
+ *   console.log(`Processing: ${value}`);
+ * }
+ * 
+ * // Validation
+ * const isValid = DNS_PROTECTED_REASON_VALUES.includes(someValue);
+ * ```
+ *
+ * @see {@link DnsProtectedReason} - The TypeScript type definition
+ * @see {@link DNS_PROTECTED_REASON} - The object form of this enum
+ */
+export const DNS_PROTECTED_REASON_VALUES = [
+  'SYSTEM_MANAGED_SOA',
+  'SYSTEM_MANAGED_NS',
+  'EMAIL_FORWARD',
+  'DOMAIN_FORWARD',
+  'GENERIC'
+] as const satisfies [string, ...string[]] | DnsProtectedReason[];
+
 /**
  * DnsRrsetType. Auto-generated enum for DnsRrsetType
  *
@@ -2836,6 +2892,58 @@ export const OBJECT_LOG_SORT_FIELD_VALUES = [
   'performed_by_id'
 ] as const satisfies [string, ...string[]] | ObjectLogSortField[];
 
+/**
+ * OrganizationSortField. Auto-generated enum for OrganizationSortField
+ *
+ * @remarks
+ * This constant provides both object and array forms for the OrganizationSortField 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 = ORGANIZATION_SORT_FIELD.SUCCESS;
+ * 
+ * // Using the array form for iteration
+ * const allStatuses = ORGANIZATION_SORT_FIELD_VALUES;
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
+ * ```
+ *
+ * @see {@link OrganizationSortField} - The TypeScript type definition
+ */
+export const ORGANIZATION_SORT_FIELD = {
+  CREATED_ON: "created_on",
+  NAME: "name",
+  COUNTRY_CODE: "country_code",
+} as const satisfies Record<string, OrganizationSortField>;
+
+/**
+ * Array of all OrganizationSortField enum values
+ *
+ * @remarks
+ * This constant provides a array containing all valid OrganizationSortField enum values.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all values
+ * for (const value of ORGANIZATION_SORT_FIELD_VALUES) {
+ *   console.log(`Processing: ${value}`);
+ * }
+ * 
+ * // Validation
+ * const isValid = ORGANIZATION_SORT_FIELD_VALUES.includes(someValue);
+ * ```
+ *
+ * @see {@link OrganizationSortField} - The TypeScript type definition
+ * @see {@link ORGANIZATION_SORT_FIELD} - The object form of this enum
+ */
+export const ORGANIZATION_SORT_FIELD_VALUES = [
+  'created_on',
+  'name',
+  'country_code'
+] as const satisfies [string, ...string[]] | OrganizationSortField[];
+
 /**
  * OrganizationStatus. Auto-generated enum for OrganizationStatus
  *
@@ -4121,6 +4229,58 @@ export const TRANSFER_ACK_TYPE_VALUES = [
   'both'
 ] as const satisfies [string, ...string[]] | TransferAckType[];
 
+/**
+ * UserSortField. Auto-generated enum for UserSortField
+ *
+ * @remarks
+ * This constant provides both object and array forms for the UserSortField 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 = USER_SORT_FIELD.SUCCESS;
+ * 
+ * // Using the array form for iteration
+ * const allStatuses = USER_SORT_FIELD_VALUES;
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
+ * ```
+ *
+ * @see {@link UserSortField} - The TypeScript type definition
+ */
+export const USER_SORT_FIELD = {
+  CREATED_ON: "created_on",
+  USERNAME: "username",
+  EMAIL: "email",
+} as const satisfies Record<string, UserSortField>;
+
+/**
+ * Array of all UserSortField enum values
+ *
+ * @remarks
+ * This constant provides a array containing all valid UserSortField enum values.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all values
+ * for (const value of USER_SORT_FIELD_VALUES) {
+ *   console.log(`Processing: ${value}`);
+ * }
+ * 
+ * // Validation
+ * const isValid = USER_SORT_FIELD_VALUES.includes(someValue);
+ * ```
+ *
+ * @see {@link UserSortField} - The TypeScript type definition
+ * @see {@link USER_SORT_FIELD} - The object form of this enum
+ */
+export const USER_SORT_FIELD_VALUES = [
+  'created_on',
+  'username',
+  'email'
+] as const satisfies [string, ...string[]] | UserSortField[];
+
 /**
  * UserStatus. Auto-generated enum for UserStatus
  *

package/src/helpers/keys.ts

@@ -5302,6 +5302,31 @@ export const KEYS_DNS_RECORD_PATCH_OP = [
  * @see {@link KEYS_DNS_RECORD} - Array of all keys for this type
  */
 export const KEY_DNS_RECORD_PROTECTED: keyof DnsRecord = 'protected';
+/**
+ * protected_reason property
+ *
+ * Reason why the record is protected
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `protected_reason` property of DnsRecord objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = dnsrecord[KEY_DNS_RECORD_PROTECTED_REASON];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DNS_RECORD_PROTECTED_REASON;
+ * const value = dnsrecord[propertyName];
+ * ```
+ *
+ * @see {@link DnsRecord} - The TypeScript type definition
+ * @see {@link KEYS_DNS_RECORD} - Array of all keys for this type
+ */
+export const KEY_DNS_RECORD_PROTECTED_REASON: keyof DnsRecord = 'protected_reason';
 /**
  * Rdata
  *
@@ -5350,6 +5375,7 @@ export const KEY_DNS_RECORD_RDATA: keyof DnsRecord = 'rdata';
  */
 export const KEYS_DNS_RECORD = [
   KEY_DNS_RECORD_PROTECTED,
+  KEY_DNS_RECORD_PROTECTED_REASON,
   KEY_DNS_RECORD_RDATA,
 ] as const satisfies (keyof DnsRecord)[];
 
@@ -5732,6 +5758,31 @@ export const KEY_DNS_RRSET_NAME: keyof DnsRrset = 'name';
  * @see {@link KEYS_DNS_RRSET} - Array of all keys for this type
  */
 export const KEY_DNS_RRSET_PROTECTED: keyof DnsRrset = 'protected';
+/**
+ * protected_reason property
+ *
+ * Reason why the RRset is protected
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `protected_reason` property of DnsRrset objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = dnsrrset[KEY_DNS_RRSET_PROTECTED_REASON];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DNS_RRSET_PROTECTED_REASON;
+ * const value = dnsrrset[propertyName];
+ * ```
+ *
+ * @see {@link DnsRrset} - The TypeScript type definition
+ * @see {@link KEYS_DNS_RRSET} - Array of all keys for this type
+ */
+export const KEY_DNS_RRSET_PROTECTED_REASON: keyof DnsRrset = 'protected_reason';
 /**
  * Records
  *
@@ -5830,6 +5881,7 @@ export const KEY_DNS_RRSET_TYPE: keyof DnsRrset = 'type';
 export const KEYS_DNS_RRSET = [
   KEY_DNS_RRSET_NAME,
   KEY_DNS_RRSET_PROTECTED,
+  KEY_DNS_RRSET_PROTECTED_REASON,
   KEY_DNS_RRSET_RECORDS,
   KEY_DNS_RRSET_TTL,
   KEY_DNS_RRSET_TYPE,

package/src/helpers/schemas.d.ts

@@ -650,6 +650,22 @@ export type DnsChanges = components['schemas']['DnsChangesResponse'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type DnsConfigurationBase = components['schemas']['DnsConfigurationBase'];
+/**
+ * DnsProtectedReason
+ *
+ * @remarks
+ * Type alias for the `DnsProtectedReason` OpenAPI schema.
+ * This type represents dnsprotectedreason data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getDnsProtectedReason();
+ * const item: DnsProtectedReason = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type DnsProtectedReason = components['schemas']['DnsProtectedReason'];
 /**
  * DnsRecordCreate
  *
@@ -2996,6 +3012,22 @@ export type OrganizationAttributeUpdate = components['schemas']['OrganizationAtt
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type OrganizationCreate = components['schemas']['OrganizationCreate'];
+/**
+ * OrganizationSortField
+ *
+ * @remarks
+ * Type alias for the `OrganizationSortField` OpenAPI schema.
+ * This type represents organizationsortfield data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getOrganizationSortField();
+ * const item: OrganizationSortField = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type OrganizationSortField = components['schemas']['OrganizationSortField'];
 /**
  * OrganizationStatus
  *
@@ -4404,6 +4436,22 @@ export type UserPublic = components['schemas']['UserPublic'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type UserPublicWithAttributes = components['schemas']['UserPublicWithAttributes'];
+/**
+ * UserSortField
+ *
+ * @remarks
+ * Type alias for the `UserSortField` OpenAPI schema.
+ * This type represents usersortfield data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getUserSortField();
+ * const item: UserSortField = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type UserSortField = components['schemas']['UserSortField'];
 /**
  * UserStatus
  *

package/src/openapi.yaml

@@ -1287,6 +1287,15 @@ components:
       - host_objects
       title: DnsConfigurationBase
       type: object
+    DnsProtectedReason:
+      enum:
+      - SYSTEM_MANAGED_SOA
+      - SYSTEM_MANAGED_NS
+      - EMAIL_FORWARD
+      - DOMAIN_FORWARD
+      - GENERIC
+      title: DnsProtectedReason
+      type: string
     DnsRecordCreate:
       properties:
         rdata:
@@ -1314,6 +1323,11 @@ components:
           description: Whether the record is protected
           title: Protected
           type: boolean
+        protected_reason:
+          anyOf:
+          - $ref: '#/components/schemas/DnsProtectedReason'
+          - type: 'null'
+          description: Reason why the record is protected
         rdata:
           title: Rdata
           type: string
@@ -1386,6 +1400,11 @@ components:
           description: Whether the RRset is protected
           title: Protected
           type: boolean
+        protected_reason:
+          anyOf:
+          - $ref: '#/components/schemas/DnsProtectedReason'
+          - type: 'null'
+          description: Reason why the RRset is protected
         records:
           items:
             $ref: '#/components/schemas/DnsRecordResponse'
@@ -4725,6 +4744,13 @@ components:
       - name
       title: OrganizationCreate
       type: object
+    OrganizationSortField:
+      enum:
+      - created_on
+      - name
+      - country_code
+      title: OrganizationSortField
+      type: string
     OrganizationStatus:
       enum:
       - active
@@ -6843,6 +6869,13 @@ components:
       - status
       title: UserPublicWithAttributes
       type: object
+    UserSortField:
+      enum:
+      - created_on
+      - username
+      - email
+      title: UserSortField
+      type: string
     UserStatus:
       enum:
       - active
@@ -7277,7 +7310,7 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-03-06-182612
+  version: 2026-03-09-181800
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -15185,6 +15218,36 @@ paths:
       description: Retrieves a paginated list of organizations under the current organization
       operationId: list_organizations_v1_organizations_get
       parameters:
+      - in: query
+        name: sort_by
+        required: false
+        schema:
+          $ref: '#/components/schemas/OrganizationSortField'
+          default: created_on
+      - in: query
+        name: sort_order
+        required: false
+        schema:
+          $ref: '#/components/schemas/SortOrder'
+          default: desc
+      - in: query
+        name: q
+        required: false
+        schema:
+          anyOf:
+          - maxLength: 200
+            type: string
+          - type: 'null'
+          title: Q
+      - in: query
+        name: country_code
+        required: false
+        schema:
+          anyOf:
+          - pattern: ^\w{2}$
+            type: string
+          - type: 'null'
+          title: Country Code
       - in: query
         name: page
         required: false
@@ -15939,6 +16002,27 @@ paths:
       description: Retrieves a paginated list of users under the current organization
       operationId: list_users_v1_organizations_users_get
       parameters:
+      - in: query
+        name: sort_by
+        required: false
+        schema:
+          $ref: '#/components/schemas/UserSortField'
+          default: created_on
+      - in: query
+        name: sort_order
+        required: false
+        schema:
+          $ref: '#/components/schemas/SortOrder'
+          default: desc
+      - in: query
+        name: q
+        required: false
+        schema:
+          anyOf:
+          - maxLength: 200
+            type: string
+          - type: 'null'
+          title: Q
       - in: query
         name: page
         required: false

package/src/schema.d.ts

@@ -2860,6 +2860,11 @@ export interface components {
              */
             registry_root_nameserver_update: number;
         };
+        /**
+         * DnsProtectedReason
+         * @enum {string}
+         */
+        DnsProtectedReason: "SYSTEM_MANAGED_SOA" | "SYSTEM_MANAGED_NS" | "EMAIL_FORWARD" | "DOMAIN_FORWARD" | "GENERIC";
         /** DnsRecordCreate */
         DnsRecordCreate: {
             /** Rdata */
@@ -2878,6 +2883,8 @@ export interface components {
              * @default false
              */
             protected: boolean;
+            /** @description Reason why the record is protected */
+            protected_reason?: components["schemas"]["DnsProtectedReason"] | null;
             /** Rdata */
             rdata: string;
         };
@@ -2916,6 +2923,8 @@ export interface components {
              * @default false
              */
             protected: boolean;
+            /** @description Reason why the RRset is protected */
+            protected_reason?: components["schemas"]["DnsProtectedReason"] | null;
             /** Records */
             records?: components["schemas"]["DnsRecordResponse"][];
             /** Ttl */
@@ -5129,6 +5138,11 @@ export interface components {
              */
             users?: components["schemas"]["UserCreate"][];
         };
+        /**
+         * OrganizationSortField
+         * @enum {string}
+         */
+        OrganizationSortField: "created_on" | "name" | "country_code";
         /**
          * OrganizationStatus
          * @enum {string}
@@ -6490,6 +6504,11 @@ export interface components {
              */
             username: string;
         };
+        /**
+         * UserSortField
+         * @enum {string}
+         */
+        UserSortField: "created_on" | "username" | "email";
         /**
          * UserStatus
          * @enum {string}
@@ -12509,6 +12528,10 @@ export interface operations {
     list_organizations_v1_organizations_get: {
         parameters: {
             query?: {
+                sort_by?: components["schemas"]["OrganizationSortField"];
+                sort_order?: components["schemas"]["SortOrder"];
+                q?: string | null;
+                country_code?: string | null;
                 page?: number;
                 page_size?: number;
             };
@@ -13281,6 +13304,9 @@ export interface operations {
     list_users_v1_organizations_users_get: {
         parameters: {
             query?: {
+                sort_by?: components["schemas"]["UserSortField"];
+                sort_order?: components["schemas"]["SortOrder"];
+                q?: string | null;
                 page?: number;
                 page_size?: number;
             };