@opusdns/api 1.7.0 → 1.8.0

package/package.json

@@ -3,7 +3,7 @@
     "@opusdns/api-spec-ts-generator": "^1.2.0"
   },
   "name": "@opusdns/api",
-  "version": "1.7.0",
+  "version": "1.8.0",
   "description": "TypeScript types for the OpusDNS OpenAPI specification",
   "main": "./src/index.ts",
   "module": "./src/index.ts",

package/src/helpers/keys.ts

@@ -303,9 +303,10 @@ import type {
   UserCreate,
   UserPublic,
   UserPublicWithAttributes,
+  UserPublicWithRole,
   UserToken,
   UserUpdate,
-  UserWithPermissions,
+  UserWithAuthorization,
   ValidationError,
   VerificationDeadline,
   VerificationRegistrantDetails,
@@ -4264,6 +4265,36 @@ export const KEYS_USER_PUBLIC_WITH_ATTRIBUTES = [
   KEY_USER_PUBLIC_WITH_ATTRIBUTES_USERNAME,
 ] as const satisfies (keyof UserPublicWithAttributes)[];
 
+export const KEY_USER_PUBLIC_WITH_ROLE_CREATED_ON = 'created_on' satisfies keyof UserPublicWithRole;
+export const KEY_USER_PUBLIC_WITH_ROLE_DELETED_ON = 'deleted_on' satisfies keyof UserPublicWithRole;
+export const KEY_USER_PUBLIC_WITH_ROLE_EMAIL = 'email' satisfies keyof UserPublicWithRole;
+export const KEY_USER_PUBLIC_WITH_ROLE_FIRST_NAME = 'first_name' satisfies keyof UserPublicWithRole;
+export const KEY_USER_PUBLIC_WITH_ROLE_LAST_NAME = 'last_name' satisfies keyof UserPublicWithRole;
+export const KEY_USER_PUBLIC_WITH_ROLE_LOCALE = 'locale' satisfies keyof UserPublicWithRole;
+export const KEY_USER_PUBLIC_WITH_ROLE_ORGANIZATION_ID = 'organization_id' satisfies keyof UserPublicWithRole;
+export const KEY_USER_PUBLIC_WITH_ROLE_PHONE = 'phone' satisfies keyof UserPublicWithRole;
+export const KEY_USER_PUBLIC_WITH_ROLE_ROLE = 'role' satisfies keyof UserPublicWithRole;
+export const KEY_USER_PUBLIC_WITH_ROLE_STATUS = 'status' satisfies keyof UserPublicWithRole;
+export const KEY_USER_PUBLIC_WITH_ROLE_UPDATED_ON = 'updated_on' satisfies keyof UserPublicWithRole;
+export const KEY_USER_PUBLIC_WITH_ROLE_USER_ID = 'user_id' satisfies keyof UserPublicWithRole;
+export const KEY_USER_PUBLIC_WITH_ROLE_USERNAME = 'username' satisfies keyof UserPublicWithRole;
+
+export const KEYS_USER_PUBLIC_WITH_ROLE = [
+  KEY_USER_PUBLIC_WITH_ROLE_CREATED_ON,
+  KEY_USER_PUBLIC_WITH_ROLE_DELETED_ON,
+  KEY_USER_PUBLIC_WITH_ROLE_EMAIL,
+  KEY_USER_PUBLIC_WITH_ROLE_FIRST_NAME,
+  KEY_USER_PUBLIC_WITH_ROLE_LAST_NAME,
+  KEY_USER_PUBLIC_WITH_ROLE_LOCALE,
+  KEY_USER_PUBLIC_WITH_ROLE_ORGANIZATION_ID,
+  KEY_USER_PUBLIC_WITH_ROLE_PHONE,
+  KEY_USER_PUBLIC_WITH_ROLE_ROLE,
+  KEY_USER_PUBLIC_WITH_ROLE_STATUS,
+  KEY_USER_PUBLIC_WITH_ROLE_UPDATED_ON,
+  KEY_USER_PUBLIC_WITH_ROLE_USER_ID,
+  KEY_USER_PUBLIC_WITH_ROLE_USERNAME,
+] as const satisfies (keyof UserPublicWithRole)[];
+
 export const KEY_USER_TOKEN_ACCESS_TOKEN = 'access_token' satisfies keyof UserToken;
 export const KEY_USER_TOKEN_EXPIRES_IN = 'expires_in' satisfies keyof UserToken;
 export const KEY_USER_TOKEN_REFRESH_EXPIRES_IN = 'refresh_expires_in' satisfies keyof UserToken;
@@ -4296,37 +4327,39 @@ export const KEYS_USER_UPDATE = [
   KEY_USER_UPDATE_USERNAME,
 ] as const satisfies (keyof UserUpdate)[];
 
-export const KEY_USER_WITH_PERMISSIONS_CREATED_ON = 'created_on' satisfies keyof UserWithPermissions;
-export const KEY_USER_WITH_PERMISSIONS_DELETED_ON = 'deleted_on' satisfies keyof UserWithPermissions;
-export const KEY_USER_WITH_PERMISSIONS_EMAIL = 'email' satisfies keyof UserWithPermissions;
-export const KEY_USER_WITH_PERMISSIONS_FIRST_NAME = 'first_name' satisfies keyof UserWithPermissions;
-export const KEY_USER_WITH_PERMISSIONS_LAST_NAME = 'last_name' satisfies keyof UserWithPermissions;
-export const KEY_USER_WITH_PERMISSIONS_LOCALE = 'locale' satisfies keyof UserWithPermissions;
-export const KEY_USER_WITH_PERMISSIONS_ORGANIZATION_ID = 'organization_id' satisfies keyof UserWithPermissions;
-export const KEY_USER_WITH_PERMISSIONS_PERMISSIONS = 'permissions' satisfies keyof UserWithPermissions;
-export const KEY_USER_WITH_PERMISSIONS_PHONE = 'phone' satisfies keyof UserWithPermissions;
-export const KEY_USER_WITH_PERMISSIONS_STATUS = 'status' satisfies keyof UserWithPermissions;
-export const KEY_USER_WITH_PERMISSIONS_UPDATED_ON = 'updated_on' satisfies keyof UserWithPermissions;
-export const KEY_USER_WITH_PERMISSIONS_USER_ATTRIBUTES = 'user_attributes' satisfies keyof UserWithPermissions;
-export const KEY_USER_WITH_PERMISSIONS_USER_ID = 'user_id' satisfies keyof UserWithPermissions;
-export const KEY_USER_WITH_PERMISSIONS_USERNAME = 'username' satisfies keyof UserWithPermissions;
-
-export const KEYS_USER_WITH_PERMISSIONS = [
-  KEY_USER_WITH_PERMISSIONS_CREATED_ON,
-  KEY_USER_WITH_PERMISSIONS_DELETED_ON,
-  KEY_USER_WITH_PERMISSIONS_EMAIL,
-  KEY_USER_WITH_PERMISSIONS_FIRST_NAME,
-  KEY_USER_WITH_PERMISSIONS_LAST_NAME,
-  KEY_USER_WITH_PERMISSIONS_LOCALE,
-  KEY_USER_WITH_PERMISSIONS_ORGANIZATION_ID,
-  KEY_USER_WITH_PERMISSIONS_PERMISSIONS,
-  KEY_USER_WITH_PERMISSIONS_PHONE,
-  KEY_USER_WITH_PERMISSIONS_STATUS,
-  KEY_USER_WITH_PERMISSIONS_UPDATED_ON,
-  KEY_USER_WITH_PERMISSIONS_USER_ATTRIBUTES,
-  KEY_USER_WITH_PERMISSIONS_USER_ID,
-  KEY_USER_WITH_PERMISSIONS_USERNAME,
-] as const satisfies (keyof UserWithPermissions)[];
+export const KEY_USER_WITH_AUTHORIZATION_CREATED_ON = 'created_on' satisfies keyof UserWithAuthorization;
+export const KEY_USER_WITH_AUTHORIZATION_DELETED_ON = 'deleted_on' satisfies keyof UserWithAuthorization;
+export const KEY_USER_WITH_AUTHORIZATION_EMAIL = 'email' satisfies keyof UserWithAuthorization;
+export const KEY_USER_WITH_AUTHORIZATION_FIRST_NAME = 'first_name' satisfies keyof UserWithAuthorization;
+export const KEY_USER_WITH_AUTHORIZATION_LAST_NAME = 'last_name' satisfies keyof UserWithAuthorization;
+export const KEY_USER_WITH_AUTHORIZATION_LOCALE = 'locale' satisfies keyof UserWithAuthorization;
+export const KEY_USER_WITH_AUTHORIZATION_ORGANIZATION_ID = 'organization_id' satisfies keyof UserWithAuthorization;
+export const KEY_USER_WITH_AUTHORIZATION_PERMISSIONS = 'permissions' satisfies keyof UserWithAuthorization;
+export const KEY_USER_WITH_AUTHORIZATION_PHONE = 'phone' satisfies keyof UserWithAuthorization;
+export const KEY_USER_WITH_AUTHORIZATION_ROLE = 'role' satisfies keyof UserWithAuthorization;
+export const KEY_USER_WITH_AUTHORIZATION_STATUS = 'status' satisfies keyof UserWithAuthorization;
+export const KEY_USER_WITH_AUTHORIZATION_UPDATED_ON = 'updated_on' satisfies keyof UserWithAuthorization;
+export const KEY_USER_WITH_AUTHORIZATION_USER_ATTRIBUTES = 'user_attributes' satisfies keyof UserWithAuthorization;
+export const KEY_USER_WITH_AUTHORIZATION_USER_ID = 'user_id' satisfies keyof UserWithAuthorization;
+export const KEY_USER_WITH_AUTHORIZATION_USERNAME = 'username' satisfies keyof UserWithAuthorization;
+
+export const KEYS_USER_WITH_AUTHORIZATION = [
+  KEY_USER_WITH_AUTHORIZATION_CREATED_ON,
+  KEY_USER_WITH_AUTHORIZATION_DELETED_ON,
+  KEY_USER_WITH_AUTHORIZATION_EMAIL,
+  KEY_USER_WITH_AUTHORIZATION_FIRST_NAME,
+  KEY_USER_WITH_AUTHORIZATION_LAST_NAME,
+  KEY_USER_WITH_AUTHORIZATION_LOCALE,
+  KEY_USER_WITH_AUTHORIZATION_ORGANIZATION_ID,
+  KEY_USER_WITH_AUTHORIZATION_PERMISSIONS,
+  KEY_USER_WITH_AUTHORIZATION_PHONE,
+  KEY_USER_WITH_AUTHORIZATION_ROLE,
+  KEY_USER_WITH_AUTHORIZATION_STATUS,
+  KEY_USER_WITH_AUTHORIZATION_UPDATED_ON,
+  KEY_USER_WITH_AUTHORIZATION_USER_ATTRIBUTES,
+  KEY_USER_WITH_AUTHORIZATION_USER_ID,
+  KEY_USER_WITH_AUTHORIZATION_USERNAME,
+] as const satisfies (keyof UserWithAuthorization)[];
 
 export const KEY_VALIDATION_ERROR_CTX = 'ctx' satisfies keyof ValidationError;
 export const KEY_VALIDATION_ERROR_INPUT = 'input' satisfies keyof ValidationError;

package/src/helpers/responses.d.ts

@@ -75,7 +75,7 @@ import type {
   Pagination_Parking,
   Pagination_RequestHistory,
   Pagination_Tag,
-  Pagination_UserPublic,
+  Pagination_UserPublicWithRole,
   ParkingMetrics,
   ParkingSignup,
   ParkingSignupStatus,
@@ -92,7 +92,7 @@ import type {
   TldSpecification,
   UserPublic,
   UserPublicWithAttributes,
-  UserWithPermissions,
+  UserWithAuthorization,
 } from './schemas';
 
 export type DELETE_AiConciergeConversationsByConversationId_Response = DELETE_AiConciergeConversationsByConversationId_Response_401 | DELETE_AiConciergeConversationsByConversationId_Response_404 | DELETE_AiConciergeConversationsByConversationId_Response_422 | DELETE_AiConciergeConversationsByConversationId_Response_502;
@@ -642,7 +642,7 @@ export type GET_OrganizationsIpRestrictionsByIpRestrictionId_Response_422 = HTTP
 
 export type GET_OrganizationsUsers_Response = GET_OrganizationsUsers_Response_200 | GET_OrganizationsUsers_Response_401 | GET_OrganizationsUsers_Response_403 | GET_OrganizationsUsers_Response_422;
 
-export type GET_OrganizationsUsers_Response_200 = Pagination_UserPublic;
+export type GET_OrganizationsUsers_Response_200 = Pagination_UserPublicWithRole;
 export type GET_OrganizationsUsers_Response_401 = Problem;
 export type GET_OrganizationsUsers_Response_403 = Problem;
 export type GET_OrganizationsUsers_Response_422 = HTTPValidationError;
@@ -735,7 +735,7 @@ export type GET_UsersByUserIdRole_Response_422 = HTTPValidationError;
 
 export type GET_UsersMe_Response = GET_UsersMe_Response_200 | GET_UsersMe_Response_422;
 
-export type GET_UsersMe_Response_200 = UserWithPermissions;
+export type GET_UsersMe_Response_200 = UserWithAuthorization;
 export type GET_UsersMe_Response_422 = HTTPValidationError;
 
 export type PATCH_AiConciergeConversationsByConversationId_Response = PATCH_AiConciergeConversationsByConversationId_Response_200 | PATCH_AiConciergeConversationsByConversationId_Response_401 | PATCH_AiConciergeConversationsByConversationId_Response_404 | PATCH_AiConciergeConversationsByConversationId_Response_422 | PATCH_AiConciergeConversationsByConversationId_Response_502;

package/src/helpers/schemas.d.ts

@@ -314,7 +314,7 @@ export type Pagination_Organization = components['schemas']['Pagination_Organiza
 export type Pagination_Parking = components['schemas']['Pagination_ParkingResponse_'];
 export type Pagination_RequestHistory = components['schemas']['Pagination_RequestHistory_'];
 export type Pagination_Tag = components['schemas']['Pagination_TagResponse_'];
-export type Pagination_UserPublic = components['schemas']['Pagination_UserPublic_'];
+export type Pagination_UserPublicWithRole = components['schemas']['Pagination_UserPublicWithRole_'];
 export type ParkingActionPayloadData = components['schemas']['ParkingActionPayloadData'];
 export type ParkingAgreementAcceptance = components['schemas']['ParkingAgreementAcceptance'];
 export type ParkingCreateBulkCommand = components['schemas']['ParkingCreateBulkCommand'];
@@ -430,11 +430,12 @@ export type UserAttribute = components['schemas']['UserAttributeResponse'];
 export type UserCreate = components['schemas']['UserCreate'];
 export type UserPublic = components['schemas']['UserPublic'];
 export type UserPublicWithAttributes = components['schemas']['UserPublicWithAttributes'];
+export type UserPublicWithRole = components['schemas']['UserPublicWithRole'];
 export type UserSortField = components['schemas']['UserSortField'];
 export type UserStatus = components['schemas']['UserStatus'];
 export type UserToken = components['schemas']['UserTokenResponse'];
 export type UserUpdate = components['schemas']['UserUpdate'];
-export type UserWithPermissions = components['schemas']['UserWithPermissions'];
+export type UserWithAuthorization = components['schemas']['UserWithAuthorization'];
 export type ValidationError = components['schemas']['ValidationError'];
 export type VerificationClaimType = components['schemas']['VerificationClaimType'];
 export type VerificationDeadline = components['schemas']['VerificationDeadline'];

package/src/openapi.yaml

@@ -8493,19 +8493,19 @@ components:
       - pagination
       title: Pagination[TagResponse]
       type: object
-    Pagination_UserPublic_:
+    Pagination_UserPublicWithRole_:
       properties:
         pagination:
           $ref: '#/components/schemas/PaginationMetadata'
         results:
           items:
-            $ref: '#/components/schemas/UserPublic'
+            $ref: '#/components/schemas/UserPublicWithRole'
           title: Results
           type: array
       required:
       - results
       - pagination
-      title: Pagination[UserPublic]
+      title: Pagination[UserPublicWithRole]
       type: object
     ParkingActionPayloadData:
       properties:
@@ -11017,6 +11017,97 @@ components:
       - status
       title: UserPublicWithAttributes
       type: object
+    UserPublicWithRole:
+      properties:
+        created_on:
+          description: The date/time the entry was created on
+          format: date-time
+          title: Created On
+          type: string
+        deleted_on:
+          anyOf:
+          - 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:
+          description: The user's first name
+          maxLength: 255
+          minLength: 1
+          title: First Name
+          type: string
+        last_name:
+          description: The user's last name
+          maxLength: 255
+          minLength: 1
+          title: Last Name
+          type: string
+        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
+        role:
+          anyOf:
+          - $ref: '#/components/schemas/PublicRole'
+          - type: 'null'
+        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:
+          description: The user's unique username
+          maxLength: 128
+          minLength: 3
+          pattern: ^[a-zA-Z0-9\-+_@.]+$
+          title: Username
+          type: string
+      required:
+      - username
+      - first_name
+      - last_name
+      - email
+      - locale
+      - status
+      title: UserPublicWithRole
+      type: object
     UserSortField:
       enum:
       - created_on
@@ -11123,7 +11214,7 @@ components:
           title: Username
       title: UserUpdate
       type: object
-    UserWithPermissions:
+    UserWithAuthorization:
       properties:
         created_on:
           description: The date/time the entry was created on
@@ -11185,6 +11276,10 @@ components:
           examples:
           - '+1.2125552368'
           title: Phone
+        role:
+          anyOf:
+          - $ref: '#/components/schemas/PublicRole'
+          - type: 'null'
         status:
           $ref: '#/components/schemas/UserStatus'
           readOnly: true
@@ -11229,7 +11324,7 @@ components:
       - email
       - locale
       - status
-      title: UserWithPermissions
+      title: UserWithAuthorization
       type: object
     ValidationError:
       properties:
@@ -11555,7 +11650,7 @@ info:
     \n\n"
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-06-10-102008
+  version: 2026-06-11-084702
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -23515,7 +23610,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/Pagination_UserPublic_'
+                $ref: '#/components/schemas/Pagination_UserPublicWithRole_'
           description: Successful Response
         '401':
           content:
@@ -25424,7 +25519,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/UserWithPermissions'
+                $ref: '#/components/schemas/UserWithAuthorization'
           description: Successful Response
         '422':
           content:

package/src/schema.d.ts

@@ -8013,11 +8013,11 @@ export interface components {
             /** Results */
             results: components["schemas"]["TagResponse"][];
         };
-        /** Pagination[UserPublic] */
-        Pagination_UserPublic_: {
+        /** Pagination[UserPublicWithRole] */
+        Pagination_UserPublicWithRole_: {
             pagination: components["schemas"]["PaginationMetadata"];
             /** Results */
-            results: components["schemas"]["UserPublic"][];
+            results: components["schemas"]["UserPublicWithRole"][];
         };
         /** ParkingActionPayloadData */
         ParkingActionPayloadData: {
@@ -9749,6 +9749,74 @@ export interface components {
              */
             username: string;
         };
+        /** UserPublicWithRole */
+        UserPublicWithRole: {
+            /**
+             * Created On
+             * Format: date-time
+             * @description The date/time the entry was created on
+             */
+            created_on?: Date;
+            /**
+             * Deleted On
+             * @description The date/time the entry was deleted on
+             */
+            deleted_on?: Date | null;
+            /**
+             * Email
+             * Format: email
+             * @description The user's email address
+             */
+            email: string;
+            /**
+             * First Name
+             * @description The user's first name
+             */
+            first_name: string;
+            /**
+             * Last Name
+             * @description The user's last name
+             */
+            last_name: string;
+            /**
+             * Locale
+             * @example en_US
+             */
+            locale: string;
+            /**
+             * Organization Id
+             * Format: typeid
+             * @description The user's organization id
+             * @default None
+             * @example organization_01h45ytscbebyvny4gc8cr8ma2
+             */
+            organization_id: TypeId<"organization">;
+            /**
+             * Phone
+             * @description The user's phone number
+             * @example +1.2125552368
+             */
+            phone?: string | null;
+            role?: components["schemas"]["PublicRole"] | null;
+            readonly status: components["schemas"]["UserStatus"];
+            /**
+             * Updated On
+             * Format: date-time
+             * @description The date/time the entry was last updated on
+             */
+            updated_on?: Date;
+            /**
+             * User Id
+             * Format: typeid
+             * @example user_01h45ytscbebyvny4gc8cr8ma2
+             */
+            user_id?: TypeId<"user">;
+            /**
+             * Username
+             * @description The user's unique username
+             */
+            username: string;
+        };
         /**
          * UserSortField
          * @enum {string}
@@ -9826,8 +9894,8 @@ export interface components {
              */
             username?: string | null;
         };
-        /** UserWithPermissions */
-        UserWithPermissions: {
+        /** UserWithAuthorization */
+        UserWithAuthorization: {
             /**
              * Created On
              * Format: date-time
@@ -9876,6 +9944,7 @@ export interface components {
              * @example +1.2125552368
              */
             phone?: string | null;
+            role?: components["schemas"]["PublicRole"] | null;
             readonly status: components["schemas"]["UserStatus"];
             /**
              * Updated On
@@ -18668,7 +18737,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["Pagination_UserPublic_"];
+                    "application/json": components["schemas"]["Pagination_UserPublicWithRole_"];
                 };
             };
             /** @description Unauthorized */
@@ -20395,7 +20464,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["UserWithPermissions"];
+                    "application/json": components["schemas"]["UserWithAuthorization"];
                 };
             };
             /** @description Validation Error */