@opusdns/api 0.138.0 → 0.139.0

package/src/helpers/responses.d.ts

@@ -34,7 +34,7 @@
 
 import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
 
-import { Pagination_EmailForwardLog, HTTPValidationError, Pagination_ObjectLog, Pagination_RequestHistory, Problem, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, EmailForwardZone, Pagination_DomainForwardZone, Pagination_EmailForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, RequestAuthcode2, Pagination_EmailForward, EmailForward, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
+import { Pagination_EmailForwardLog, HTTPValidationError, Pagination_ObjectLog, Pagination_RequestHistory, Problem, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, EmailForwardZone, Pagination_DomainForwardZone, Pagination_EmailForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, RequestAuthcode2, Pagination_EmailForward, EmailForward, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_UserPublic, TldSpecification, UserPublic, UserPublicWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
 
 /**
  * Response types for GET ArchiveEmailForwardLogsAliasesByEmailForwardAliasId endpoint
@@ -8135,9 +8135,9 @@ export type GET_OrganizationsUsers_Response = GET_OrganizationsUsers_Response_20
  * @path /v1/organizations/users
  *
  * @see {@link GET_OrganizationsUsers_Response} - The main response type definition
- * @see {@link Pagination_User} - The actual schema type definition
+ * @see {@link Pagination_UserPublic} - The actual schema type definition
  */
-export type GET_OrganizationsUsers_Response_200 = Pagination_User
+export type GET_OrganizationsUsers_Response_200 = Pagination_UserPublic
 
 /**
  * 401 response for GET OrganizationsUsers endpoint
@@ -8393,9 +8393,9 @@ export type POST_Users_Response = POST_Users_Response_200 | POST_Users_Response_
  * @path /v1/users
  *
  * @see {@link POST_Users_Response} - The main response type definition
- * @see {@link User} - The actual schema type definition
+ * @see {@link UserPublic} - The actual schema type definition
  */
-export type POST_Users_Response_200 = User
+export type POST_Users_Response_200 = UserPublic
 
 /**
  * 422 response for POST Users endpoint
@@ -8505,9 +8505,9 @@ export type GET_UsersByUserId_Response = GET_UsersByUserId_Response_200 | GET_Us
  * @path /v1/users/{user_id}
  *
  * @see {@link GET_UsersByUserId_Response} - The main response type definition
- * @see {@link UserWithAttributes} - The actual schema type definition
+ * @see {@link UserPublicWithAttributes} - The actual schema type definition
  */
-export type GET_UsersByUserId_Response_200 = UserWithAttributes
+export type GET_UsersByUserId_Response_200 = UserPublicWithAttributes
 
 /**
  * 422 response for GET UsersByUserId endpoint
@@ -8561,9 +8561,9 @@ export type PATCH_UsersByUserId_Response = PATCH_UsersByUserId_Response_200 | PA
  * @path /v1/users/{user_id}
  *
  * @see {@link PATCH_UsersByUserId_Response} - The main response type definition
- * @see {@link UserWithAttributes} - The actual schema type definition
+ * @see {@link UserPublicWithAttributes} - The actual schema type definition
  */
-export type PATCH_UsersByUserId_Response_200 = UserWithAttributes
+export type PATCH_UsersByUserId_Response_200 = UserPublicWithAttributes
 
 /**
  * 422 response for PATCH UsersByUserId endpoint

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, RegistryHandleAttributeType, ContactAttributeDefinition, ContactRoleAttributeRequirement, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, DomainForwardPatchOp, HttpRedirectList, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, DomainContactType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, ObjectLog, Organization, RequestHistory, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
+import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, RegistryHandleAttributeType, ContactAttributeDefinition, ContactRoleAttributeRequirement, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, DomainForwardPatchOp, HttpRedirectList, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, DomainContactType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, ObjectLog, Organization, RequestHistory, UserPublic, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
 
 /**
  * DomainDnssecDataResponse
@@ -807,6 +807,20 @@ export type OrganizationArray = Organization[];
  * @see {@link RequestHistory} - The individual RequestHistory type definition
  */
 export type RequestHistoryArray = RequestHistory[];
+/**
+ * UserPublic
+ *
+ * @remarks
+ * Array type for UserPublic objects. Used when the API returns a collection of UserPublic instances.
+ *
+ * @example
+ * ```typescript
+ * const items: UserPublicArray = await api.getUserPublics();
+ * ```
+ *
+ * @see {@link UserPublic} - The individual UserPublic type definition
+ */
+export type UserPublicArray = UserPublic[];
 /**
  * Period
  *

package/src/helpers/schemas.d.ts

@@ -2816,21 +2816,21 @@ export type Pagination_Organization = components['schemas']['Pagination_Organiza
  */
 export type Pagination_RequestHistory = components['schemas']['Pagination_RequestHistory_'];
 /**
- * Pagination[User]
+ * Pagination[UserPublic]
  *
  * @remarks
- * Type alias for the `Pagination_User_` OpenAPI schema.
- * This type represents pagination[user] data structures used in API requests and responses.
+ * Type alias for the `Pagination_UserPublic_` OpenAPI schema.
+ * This type represents pagination[userpublic] data structures used in API requests and responses.
  *
  * @example
  * ```typescript
- * const response = await api.getPagination_User();
- * const item: Pagination_User = response.results;
+ * const response = await api.getPagination_UserPublic();
+ * const item: Pagination_UserPublic = response.results;
  * ```
  *
  * @see {@link components} - The OpenAPI components schema definition
  */
-export type Pagination_User = components['schemas']['Pagination_User_'];
+export type Pagination_UserPublic = components['schemas']['Pagination_UserPublic_'];
 /**
  * PasswordUpdate
  *
@@ -3583,6 +3583,38 @@ export type UserAttribute = components['schemas']['UserAttributeResponse'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type UserCreate = components['schemas']['UserCreate'];
+/**
+ * UserPublic
+ *
+ * @remarks
+ * Type alias for the `UserPublic` OpenAPI schema.
+ * This type represents userpublic data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getUserPublic();
+ * const item: UserPublic = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type UserPublic = components['schemas']['UserPublic'];
+/**
+ * UserPublicWithAttributes
+ *
+ * @remarks
+ * Type alias for the `UserPublicWithAttributes` OpenAPI schema.
+ * This type represents userpublicwithattributes data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getUserPublicWithAttributes();
+ * const item: UserPublicWithAttributes = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type UserPublicWithAttributes = components['schemas']['UserPublicWithAttributes'];
 /**
  * UserStatus
  *
@@ -3631,22 +3663,6 @@ export type UserToken = components['schemas']['UserTokenResponse'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type UserUpdate = components['schemas']['UserUpdate'];
-/**
- * UserWithAttributes
- *
- * @remarks
- * Type alias for the `UserWithAttributes` OpenAPI schema.
- * This type represents userwithattributes data structures used in API requests and responses.
- *
- * @example
- * ```typescript
- * const response = await api.getUserWithAttributes();
- * const item: UserWithAttributes = response.results;
- * ```
- *
- * @see {@link components} - The OpenAPI components schema definition
- */
-export type UserWithAttributes = components['schemas']['UserWithAttributes'];
 /**
  * UserWithRelationPermissions
  *

package/src/openapi.yaml

@@ -4569,19 +4569,19 @@ components:
       - pagination
       title: Pagination[RequestHistory]
       type: object
-    Pagination_User_:
+    Pagination_UserPublic_:
       properties:
         pagination:
           $ref: '#/components/schemas/PaginationMetadata'
         results:
           items:
-            $ref: '#/components/schemas/User'
+            $ref: '#/components/schemas/UserPublic'
           title: Results
           type: array
       required:
       - results
       - pagination
-      title: Pagination[User]
+      title: Pagination[UserPublic]
       type: object
     PasswordUpdate:
       properties:
@@ -5472,6 +5472,12 @@ components:
           minLength: 1
           title: First Name
           type: string
+        keycloak_user_id:
+          anyOf:
+          - type: string
+          - type: 'null'
+          description: Keycloak user id
+          title: Keycloak User Id
         last_name:
           description: The user's last name
           minLength: 1
@@ -5626,93 +5632,92 @@ components:
       - password
       title: UserCreate
       type: object
-    UserStatus:
-      enum:
-      - active
-      - inactive
-      title: UserStatus
-      type: string
-    UserTokenResponse:
+    UserPublic:
       properties:
-        access_token:
-          title: Access Token
-          type: string
-        expires_in:
-          title: Expires In
-          type: integer
-        refresh_expires_in:
-          title: Refresh Expires In
-          type: integer
-        refresh_token:
-          title: Refresh Token
-          type: string
-        token_type:
-          default: Bearer
-          title: Token Type
+        created_on:
+          description: The date/time the entry was created on
+          format: date-time
+          title: Created On
           type: string
-      required:
-      - access_token
-      - expires_in
-      - refresh_token
-      - refresh_expires_in
-      title: UserTokenResponse
-      type: object
-    UserUpdate:
-      properties:
-        email:
+        deleted_on:
           anyOf:
-          - format: email
+          - format: date-time
             type: string
           - type: 'null'
+          description: The date/time the entry was deleted on
+          title: Deleted On
+        email:
           description: The user's email address
+          format: email
           title: Email
+          type: string
         first_name:
-          anyOf:
-          - minLength: 1
-            type: string
-          - type: 'null'
           description: The user's first name
+          minLength: 1
           title: First Name
+          type: string
         last_name:
-          anyOf:
-          - minLength: 1
-            type: string
-          - type: 'null'
           description: The user's last name
+          minLength: 1
           title: Last Name
+          type: string
         locale:
-          anyOf:
-          - examples:
-            - en_US
-            type: string
-          - type: 'null'
-          description: The user's locale
+          examples:
+          - en_US
           title: Locale
+          type: string
+        organization_id:
+          default: None
+          description: The user's organization id
+          examples:
+          - organization_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Organization Id
+          type: string
+          x-typeid-prefix: organization
         phone:
           anyOf:
           - format: phone
             type: string
           - type: 'null'
           description: The user's phone number
+          examples:
+          - '+1.2125552368'
           title: Phone
-        user_attributes:
-          anyOf:
-          - items:
-              $ref: '#/components/schemas/UserAttributeBase'
-            type: array
-          - type: 'null'
-          description: User attributes
-          title: User Attributes
+        status:
+          $ref: '#/components/schemas/UserStatus'
+          readOnly: true
+        updated_on:
+          description: The date/time the entry was last updated on
+          format: date-time
+          title: Updated On
+          type: string
+        user_id:
+          examples:
+          - user_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: User Id
+          type: string
+          x-typeid-prefix: user
         username:
-          anyOf:
-          - minLength: 1
-            type: string
-          - type: 'null'
           description: The user's unique username
+          maxLength: 128
+          minLength: 3
+          pattern: ^[a-zA-Z0-9\-+_@.]+$
           title: Username
-      title: UserUpdate
+          type: string
+      required:
+      - username
+      - first_name
+      - last_name
+      - email
+      - locale
+      - status
+      title: UserPublic
       type: object
-    UserWithAttributes:
+    UserPublicWithAttributes:
       properties:
         created_on:
           description: The date/time the entry was created on
@@ -5809,7 +5814,93 @@ components:
       - email
       - locale
       - status
-      title: UserWithAttributes
+      title: UserPublicWithAttributes
+      type: object
+    UserStatus:
+      enum:
+      - active
+      - inactive
+      title: UserStatus
+      type: string
+    UserTokenResponse:
+      properties:
+        access_token:
+          title: Access Token
+          type: string
+        expires_in:
+          title: Expires In
+          type: integer
+        refresh_expires_in:
+          title: Refresh Expires In
+          type: integer
+        refresh_token:
+          title: Refresh Token
+          type: string
+        token_type:
+          default: Bearer
+          title: Token Type
+          type: string
+      required:
+      - access_token
+      - expires_in
+      - refresh_token
+      - refresh_expires_in
+      title: UserTokenResponse
+      type: object
+    UserUpdate:
+      properties:
+        email:
+          anyOf:
+          - format: email
+            type: string
+          - type: 'null'
+          description: The user's email address
+          title: Email
+        first_name:
+          anyOf:
+          - minLength: 1
+            type: string
+          - type: 'null'
+          description: The user's first name
+          title: First Name
+        last_name:
+          anyOf:
+          - minLength: 1
+            type: string
+          - type: 'null'
+          description: The user's last name
+          title: Last Name
+        locale:
+          anyOf:
+          - examples:
+            - en_US
+            type: string
+          - type: 'null'
+          description: The user's locale
+          title: Locale
+        phone:
+          anyOf:
+          - format: phone
+            type: string
+          - type: 'null'
+          description: The user's phone number
+          title: Phone
+        user_attributes:
+          anyOf:
+          - items:
+              $ref: '#/components/schemas/UserAttributeBase'
+            type: array
+          - type: 'null'
+          description: User attributes
+          title: User Attributes
+        username:
+          anyOf:
+          - minLength: 1
+            type: string
+          - type: 'null'
+          description: The user's unique username
+          title: Username
+      title: UserUpdate
       type: object
     UserWithRelationPermissions:
       properties:
@@ -6162,7 +6253,7 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2025-12-30-174755
+  version: 2025-12-30-205837
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -12962,7 +13053,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/Pagination_User_'
+                $ref: '#/components/schemas/Pagination_UserPublic_'
           description: Successful Response
         '401':
           content:
@@ -13655,7 +13746,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/User'
+                $ref: '#/components/schemas/UserPublic'
           description: Successful Response
         '422':
           content:
@@ -13808,7 +13899,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/UserWithAttributes'
+                $ref: '#/components/schemas/UserPublicWithAttributes'
           description: Successful Response
         '422':
           content:
@@ -13847,7 +13938,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/UserWithAttributes'
+                $ref: '#/components/schemas/UserPublicWithAttributes'
           description: Successful Response
         '422':
           content: