@opusdns/api 0.14.1 → 0.15.0

package/package.json

@@ -8,7 +8,7 @@
     "typescript": "^5.8.2"
   },
   "name": "@opusdns/api",
-  "version": "0.14.1",
+  "version": "0.15.0",
   "description": "TypeScript types for the OpusDNS OpenAPI specification",
   "main": "./src/index.ts",
   "module": "./src/index.ts",

package/src/helpers/keys.ts

@@ -137,6 +137,7 @@ import { TrademarkClaimsBase } from './schemas';
 import { TransferEvent } from './schemas';
 import { TransferPoliciesBase } from './schemas';
 import { User } from './schemas';
+import { UserAttributeBase } from './schemas';
 import { UserAttributeUpdate } from './schemas';
 import { UserCreate } from './schemas';
 import { UserNotification } from './schemas';
@@ -17101,6 +17102,83 @@ export const KEYS_USER = [
   KEY_USER_USERNAME,
 ] as const satisfies (keyof User)[];
 
+/**
+ * Key
+ *
+ * Key of the attribute.
+ *
+ * @type {string}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `key` property of UserAttributeBase objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = userattributebase[KEY_USER_ATTRIBUTE_BASE_KEY];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_USER_ATTRIBUTE_BASE_KEY;
+ * const value = userattributebase[propertyName];
+ * ```
+ *
+ * @see {@link UserAttributeBase} - The TypeScript type definition
+ * @see {@link KEYS_USER_ATTRIBUTE_BASE} - Array of all keys for this type
+ */
+export const KEY_USER_ATTRIBUTE_BASE_KEY = 'key' as keyof UserAttributeBase;
+/**
+ * value property
+ *
+ * Value of the attribute.
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `value` property of UserAttributeBase objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = userattributebase[KEY_USER_ATTRIBUTE_BASE_VALUE];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_USER_ATTRIBUTE_BASE_VALUE;
+ * const value = userattributebase[propertyName];
+ * ```
+ *
+ * @see {@link UserAttributeBase} - The TypeScript type definition
+ * @see {@link KEYS_USER_ATTRIBUTE_BASE} - Array of all keys for this type
+ */
+export const KEY_USER_ATTRIBUTE_BASE_VALUE = 'value' as keyof UserAttributeBase;
+
+/**
+ * Array of all UserAttributeBase property keys
+ *
+ * @remarks
+ * This constant provides a readonly array containing all valid property keys for UserAttributeBase objects.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all keys
+ * for (const key of KEYS_USER_ATTRIBUTE_BASE) {
+ *   console.log(`Property: ${key}, Value: ${userattributebase[key]}`);
+ * }
+ * 
+ * // Validation
+ * const isValidKey = KEYS_USER_ATTRIBUTE_BASE.includes(someKey);
+ * ```
+ *
+ * @see {@link UserAttributeBase} - The TypeScript type definition
+ */
+export const KEYS_USER_ATTRIBUTE_BASE = [
+  KEY_USER_ATTRIBUTE_BASE_KEY,
+  KEY_USER_ATTRIBUTE_BASE_VALUE,
+] as const satisfies (keyof UserAttributeBase)[];
+
 /**
  * Key
  *
@@ -17332,6 +17410,31 @@ export const KEY_USER_CREATE_PASSWORD = 'password' as keyof UserCreate;
  * @see {@link KEYS_USER_CREATE} - Array of all keys for this type
  */
 export const KEY_USER_CREATE_PHONE = 'phone' as keyof UserCreate;
+/**
+ * User Attributes
+ *
+ * User attributes
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `user_attributes` property of UserCreate objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = usercreate[KEY_USER_CREATE_USER_ATTRIBUTES];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_USER_CREATE_USER_ATTRIBUTES;
+ * const value = usercreate[propertyName];
+ * ```
+ *
+ * @see {@link UserCreate} - The TypeScript type definition
+ * @see {@link KEYS_USER_CREATE} - Array of all keys for this type
+ */
+export const KEY_USER_CREATE_USER_ATTRIBUTES = 'user_attributes' as keyof UserCreate;
 /**
  * Username
  *
@@ -17386,6 +17489,7 @@ export const KEYS_USER_CREATE = [
   KEY_USER_CREATE_LOCALE,
   KEY_USER_CREATE_PASSWORD,
   KEY_USER_CREATE_PHONE,
+  KEY_USER_CREATE_USER_ATTRIBUTES,
   KEY_USER_CREATE_USERNAME,
 ] as const satisfies (keyof UserCreate)[];
 

package/src/helpers/schemas-arrays.d.ts

@@ -21,7 +21,7 @@
  * This file is auto-generated from the OpenAPI specification.
  * Do not edit manually.
  */
-import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, BulkOperationResult, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, Nameserver, DeletePolicyType, SyncOperationType, DomainContact, DomainStatus, DomainSearchSuggestion, DomainClientStatus, EmailForwardBulkUpdateItem, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, ContactSchema, DnsZone, Domain, EmailForward, EventResponse, OrganizationCredential, Organization, UserNotificationSummary, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeUpdate, DomainAvailability } from './schemas.d';
+import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, BulkOperationResult, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, Nameserver, DeletePolicyType, SyncOperationType, DomainContact, DomainStatus, DomainSearchSuggestion, DomainClientStatus, EmailForwardBulkUpdateItem, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, ContactSchema, DnsZone, Domain, EmailForward, EventResponse, OrganizationCredential, Organization, UserNotificationSummary, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, UserAttributeUpdate, DomainAvailability } from './schemas.d';
 
 /**
  * DomainDnssecDataResponse
@@ -681,6 +681,20 @@ export type TldBaseArray = TldBase[];
  * @see {@link PostTransferRequirements} - The individual PostTransferRequirements type definition
  */
 export type PostTransferRequirementsArray = PostTransferRequirements[];
+/**
+ * UserAttributeBase
+ *
+ * @remarks
+ * Array type for UserAttributeBase objects. Used when the API returns a collection of UserAttributeBase instances.
+ *
+ * @example
+ * ```typescript
+ * const items: UserAttributeBaseArray = await api.getUserAttributeBases();
+ * ```
+ *
+ * @see {@link UserAttributeBase} - The individual UserAttributeBase type definition
+ */
+export type UserAttributeBaseArray = UserAttributeBase[];
 /**
  * UserAttributeUpdate
  *

package/src/helpers/schemas.d.ts

@@ -2666,6 +2666,22 @@ export type TransferPoliciesBase = components['schemas']['TransferPoliciesBase']
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type User = components['schemas']['User'];
+/**
+ * UserAttributeBase
+ *
+ * @remarks
+ * Type alias for the `UserAttributeBase` OpenAPI schema.
+ * This type represents userattributebase data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getUserAttributeBase();
+ * const item: UserAttributeBase = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type UserAttributeBase = components['schemas']['UserAttributeBase'];
 /**
  * UserAttributeUpdate
  *

package/src/openapi.yaml

@@ -4404,6 +4404,22 @@ components:
       - status
       title: User
       type: object
+    UserAttributeBase:
+      properties:
+        key:
+          description: Key of the attribute.
+          minLength: 1
+          title: Key
+          type: string
+        value:
+          anyOf:
+          - $ref: '#/components/schemas/JsonValue'
+          - type: 'null'
+          description: Value of the attribute.
+      required:
+      - key
+      title: UserAttributeBase
+      type: object
     UserAttributeUpdate:
       properties:
         key:
@@ -4457,6 +4473,14 @@ components:
           examples:
           - '+1.2125552368'
           title: Phone
+        user_attributes:
+          anyOf:
+          - items:
+              $ref: '#/components/schemas/UserAttributeBase'
+            type: array
+          - type: 'null'
+          description: User attributes
+          title: User Attributes
         username:
           description: The user's unique username
           minLength: 1
@@ -4971,7 +4995,7 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2025-08-01-163639
+  version: 2025-08-02-000200
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg

package/src/schema.d.ts

@@ -3950,6 +3950,16 @@ export interface components {
              */
             username: string;
         };
+        /** UserAttributeBase */
+        UserAttributeBase: {
+            /**
+             * Key
+             * @description Key of the attribute.
+             */
+            key: string;
+            /** @description Value of the attribute. */
+            value?: components["schemas"]["JsonValue"] | null;
+        };
         /** UserAttributeUpdate */
         UserAttributeUpdate: {
             /**
@@ -3990,6 +4000,11 @@ export interface components {
              * @description The user's phone number
              */
             phone?: string | null;
+            /**
+             * User Attributes
+             * @description User attributes
+             */
+            user_attributes?: components["schemas"]["UserAttributeBase"][] | null;
             /**
              * Username
              * @description The user's unique username