@opusdns/api 0.137.0 → 0.139.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -169,9 +169,10 @@ import { User } from './schemas';
169
169
  import { UserAttributeBase } from './schemas';
170
170
  import { UserAttribute } from './schemas';
171
171
  import { UserCreate } from './schemas';
172
+ import { UserPublic } from './schemas';
173
+ import { UserPublicWithAttributes } from './schemas';
172
174
  import { UserToken } from './schemas';
173
175
  import { UserUpdate } from './schemas';
174
- import { UserWithAttributes } from './schemas';
175
176
  import { UserWithRelationPermissions } from './schemas';
176
177
  import { ValidationError } from './schemas';
177
178
  import { WhoisBase } from './schemas';
@@ -21165,6 +21166,31 @@ export const KEY_USER_EMAIL: keyof User = 'email';
21165
21166
  * @see {@link KEYS_USER} - Array of all keys for this type
21166
21167
  */
21167
21168
  export const KEY_USER_FIRST_NAME: keyof User = 'first_name';
21169
+ /**
21170
+ * Keycloak User Id
21171
+ *
21172
+ * Keycloak user id
21173
+ *
21174
+ *
21175
+ *
21176
+ * @remarks
21177
+ * This key constant provides type-safe access to the `keycloak_user_id` property of User objects.
21178
+ * Use this constant when you need to access properties dynamically or ensure type safety.
21179
+ *
21180
+ * @example
21181
+ * ```typescript
21182
+ * // Direct property access
21183
+ * const value = user[KEY_USER_KEYCLOAK_USER_ID];
21184
+ *
21185
+ * // Dynamic property access
21186
+ * const propertyName = KEY_USER_KEYCLOAK_USER_ID;
21187
+ * const value = user[propertyName];
21188
+ * ```
21189
+ *
21190
+ * @see {@link User} - The TypeScript type definition
21191
+ * @see {@link KEYS_USER} - Array of all keys for this type
21192
+ */
21193
+ export const KEY_USER_KEYCLOAK_USER_ID: keyof User = 'keycloak_user_id';
21168
21194
  /**
21169
21195
  * Last Name
21170
21196
  *
@@ -21394,6 +21420,7 @@ export const KEYS_USER = [
21394
21420
  KEY_USER_DELETED_ON,
21395
21421
  KEY_USER_EMAIL,
21396
21422
  KEY_USER_FIRST_NAME,
21423
+ KEY_USER_KEYCLOAK_USER_ID,
21397
21424
  KEY_USER_LAST_NAME,
21398
21425
  KEY_USER_LOCALE,
21399
21426
  KEY_USER_ORGANIZATION_ID,
@@ -21796,364 +21823,346 @@ export const KEYS_USER_CREATE = [
21796
21823
  ] as const satisfies (keyof UserCreate)[];
21797
21824
 
21798
21825
  /**
21799
- * Access Token
21826
+ * Created On
21800
21827
  *
21828
+ * The date/time the entry was created on
21801
21829
  *
21802
21830
  * @type {string}
21803
21831
  *
21804
21832
  *
21805
21833
  * @remarks
21806
- * This key constant provides type-safe access to the `access_token` property of UserToken objects.
21834
+ * This key constant provides type-safe access to the `created_on` property of UserPublic objects.
21807
21835
  * Use this constant when you need to access properties dynamically or ensure type safety.
21808
21836
  *
21809
21837
  * @example
21810
21838
  * ```typescript
21811
21839
  * // Direct property access
21812
- * const value = usertoken[KEY_USER_TOKEN_ACCESS_TOKEN];
21840
+ * const value = userpublic[KEY_USER_PUBLIC_CREATED_ON];
21813
21841
  *
21814
21842
  * // Dynamic property access
21815
- * const propertyName = KEY_USER_TOKEN_ACCESS_TOKEN;
21816
- * const value = usertoken[propertyName];
21843
+ * const propertyName = KEY_USER_PUBLIC_CREATED_ON;
21844
+ * const value = userpublic[propertyName];
21817
21845
  * ```
21818
21846
  *
21819
- * @see {@link UserToken} - The TypeScript type definition
21820
- * @see {@link KEYS_USER_TOKEN} - Array of all keys for this type
21847
+ * @see {@link UserPublic} - The TypeScript type definition
21848
+ * @see {@link KEYS_USER_PUBLIC} - Array of all keys for this type
21821
21849
  */
21822
- export const KEY_USER_TOKEN_ACCESS_TOKEN: keyof UserToken = 'access_token';
21850
+ export const KEY_USER_PUBLIC_CREATED_ON: keyof UserPublic = 'created_on';
21823
21851
  /**
21824
- * Expires In
21852
+ * Deleted On
21825
21853
  *
21854
+ * The date/time the entry was deleted on
21826
21855
  *
21827
- * @type {integer}
21828
21856
  *
21829
21857
  *
21830
21858
  * @remarks
21831
- * This key constant provides type-safe access to the `expires_in` property of UserToken objects.
21859
+ * This key constant provides type-safe access to the `deleted_on` property of UserPublic objects.
21832
21860
  * Use this constant when you need to access properties dynamically or ensure type safety.
21833
21861
  *
21834
21862
  * @example
21835
21863
  * ```typescript
21836
21864
  * // Direct property access
21837
- * const value = usertoken[KEY_USER_TOKEN_EXPIRES_IN];
21865
+ * const value = userpublic[KEY_USER_PUBLIC_DELETED_ON];
21838
21866
  *
21839
21867
  * // Dynamic property access
21840
- * const propertyName = KEY_USER_TOKEN_EXPIRES_IN;
21841
- * const value = usertoken[propertyName];
21868
+ * const propertyName = KEY_USER_PUBLIC_DELETED_ON;
21869
+ * const value = userpublic[propertyName];
21842
21870
  * ```
21843
21871
  *
21844
- * @see {@link UserToken} - The TypeScript type definition
21845
- * @see {@link KEYS_USER_TOKEN} - Array of all keys for this type
21872
+ * @see {@link UserPublic} - The TypeScript type definition
21873
+ * @see {@link KEYS_USER_PUBLIC} - Array of all keys for this type
21846
21874
  */
21847
- export const KEY_USER_TOKEN_EXPIRES_IN: keyof UserToken = 'expires_in';
21875
+ export const KEY_USER_PUBLIC_DELETED_ON: keyof UserPublic = 'deleted_on';
21848
21876
  /**
21849
- * Refresh Expires In
21877
+ * Email
21850
21878
  *
21879
+ * The user's email address
21851
21880
  *
21852
- * @type {integer}
21881
+ * @type {string}
21853
21882
  *
21854
21883
  *
21855
21884
  * @remarks
21856
- * This key constant provides type-safe access to the `refresh_expires_in` property of UserToken objects.
21885
+ * This key constant provides type-safe access to the `email` property of UserPublic objects.
21857
21886
  * Use this constant when you need to access properties dynamically or ensure type safety.
21858
21887
  *
21859
21888
  * @example
21860
21889
  * ```typescript
21861
21890
  * // Direct property access
21862
- * const value = usertoken[KEY_USER_TOKEN_REFRESH_EXPIRES_IN];
21891
+ * const value = userpublic[KEY_USER_PUBLIC_EMAIL];
21863
21892
  *
21864
21893
  * // Dynamic property access
21865
- * const propertyName = KEY_USER_TOKEN_REFRESH_EXPIRES_IN;
21866
- * const value = usertoken[propertyName];
21894
+ * const propertyName = KEY_USER_PUBLIC_EMAIL;
21895
+ * const value = userpublic[propertyName];
21867
21896
  * ```
21868
21897
  *
21869
- * @see {@link UserToken} - The TypeScript type definition
21870
- * @see {@link KEYS_USER_TOKEN} - Array of all keys for this type
21898
+ * @see {@link UserPublic} - The TypeScript type definition
21899
+ * @see {@link KEYS_USER_PUBLIC} - Array of all keys for this type
21871
21900
  */
21872
- export const KEY_USER_TOKEN_REFRESH_EXPIRES_IN: keyof UserToken = 'refresh_expires_in';
21901
+ export const KEY_USER_PUBLIC_EMAIL: keyof UserPublic = 'email';
21873
21902
  /**
21874
- * Refresh Token
21903
+ * First Name
21875
21904
  *
21905
+ * The user's first name
21876
21906
  *
21877
21907
  * @type {string}
21878
21908
  *
21879
21909
  *
21880
21910
  * @remarks
21881
- * This key constant provides type-safe access to the `refresh_token` property of UserToken objects.
21911
+ * This key constant provides type-safe access to the `first_name` property of UserPublic objects.
21882
21912
  * Use this constant when you need to access properties dynamically or ensure type safety.
21883
21913
  *
21884
21914
  * @example
21885
21915
  * ```typescript
21886
21916
  * // Direct property access
21887
- * const value = usertoken[KEY_USER_TOKEN_REFRESH_TOKEN];
21917
+ * const value = userpublic[KEY_USER_PUBLIC_FIRST_NAME];
21888
21918
  *
21889
21919
  * // Dynamic property access
21890
- * const propertyName = KEY_USER_TOKEN_REFRESH_TOKEN;
21891
- * const value = usertoken[propertyName];
21920
+ * const propertyName = KEY_USER_PUBLIC_FIRST_NAME;
21921
+ * const value = userpublic[propertyName];
21892
21922
  * ```
21893
21923
  *
21894
- * @see {@link UserToken} - The TypeScript type definition
21895
- * @see {@link KEYS_USER_TOKEN} - Array of all keys for this type
21924
+ * @see {@link UserPublic} - The TypeScript type definition
21925
+ * @see {@link KEYS_USER_PUBLIC} - Array of all keys for this type
21896
21926
  */
21897
- export const KEY_USER_TOKEN_REFRESH_TOKEN: keyof UserToken = 'refresh_token';
21927
+ export const KEY_USER_PUBLIC_FIRST_NAME: keyof UserPublic = 'first_name';
21898
21928
  /**
21899
- * Token Type
21929
+ * Last Name
21900
21930
  *
21931
+ * The user's last name
21901
21932
  *
21902
21933
  * @type {string}
21903
21934
  *
21904
21935
  *
21905
21936
  * @remarks
21906
- * This key constant provides type-safe access to the `token_type` property of UserToken objects.
21937
+ * This key constant provides type-safe access to the `last_name` property of UserPublic objects.
21907
21938
  * Use this constant when you need to access properties dynamically or ensure type safety.
21908
21939
  *
21909
21940
  * @example
21910
21941
  * ```typescript
21911
21942
  * // Direct property access
21912
- * const value = usertoken[KEY_USER_TOKEN_TOKEN_TYPE];
21943
+ * const value = userpublic[KEY_USER_PUBLIC_LAST_NAME];
21913
21944
  *
21914
21945
  * // Dynamic property access
21915
- * const propertyName = KEY_USER_TOKEN_TOKEN_TYPE;
21916
- * const value = usertoken[propertyName];
21917
- * ```
21918
- *
21919
- * @see {@link UserToken} - The TypeScript type definition
21920
- * @see {@link KEYS_USER_TOKEN} - Array of all keys for this type
21921
- */
21922
- export const KEY_USER_TOKEN_TOKEN_TYPE: keyof UserToken = 'token_type';
21923
-
21924
- /**
21925
- * Array of all UserToken property keys
21926
- *
21927
- * @remarks
21928
- * This constant provides a readonly array containing all valid property keys for UserToken objects.
21929
- * Useful for iteration, validation, and generating dynamic UI components.
21930
- *
21931
- * @example
21932
- * ```typescript
21933
- * // Iterating through all keys
21934
- * for (const key of KEYS_USER_TOKEN) {
21935
- * console.log(`Property: ${key}, Value: ${usertoken[key]}`);
21936
- * }
21937
- *
21938
- * // Validation
21939
- * const isValidKey = KEYS_USER_TOKEN.includes(someKey);
21946
+ * const propertyName = KEY_USER_PUBLIC_LAST_NAME;
21947
+ * const value = userpublic[propertyName];
21940
21948
  * ```
21941
21949
  *
21942
- * @see {@link UserToken} - The TypeScript type definition
21950
+ * @see {@link UserPublic} - The TypeScript type definition
21951
+ * @see {@link KEYS_USER_PUBLIC} - Array of all keys for this type
21943
21952
  */
21944
- export const KEYS_USER_TOKEN = [
21945
- KEY_USER_TOKEN_ACCESS_TOKEN,
21946
- KEY_USER_TOKEN_EXPIRES_IN,
21947
- KEY_USER_TOKEN_REFRESH_EXPIRES_IN,
21948
- KEY_USER_TOKEN_REFRESH_TOKEN,
21949
- KEY_USER_TOKEN_TOKEN_TYPE,
21950
- ] as const satisfies (keyof UserToken)[];
21951
-
21953
+ export const KEY_USER_PUBLIC_LAST_NAME: keyof UserPublic = 'last_name';
21952
21954
  /**
21953
- * Email
21955
+ * Locale
21954
21956
  *
21955
- * The user's email address
21956
21957
  *
21958
+ * @type {string}
21957
21959
  *
21958
21960
  *
21959
21961
  * @remarks
21960
- * This key constant provides type-safe access to the `email` property of UserUpdate objects.
21962
+ * This key constant provides type-safe access to the `locale` property of UserPublic objects.
21961
21963
  * Use this constant when you need to access properties dynamically or ensure type safety.
21962
21964
  *
21963
21965
  * @example
21964
21966
  * ```typescript
21965
21967
  * // Direct property access
21966
- * const value = userupdate[KEY_USER_UPDATE_EMAIL];
21968
+ * const value = userpublic[KEY_USER_PUBLIC_LOCALE];
21967
21969
  *
21968
21970
  * // Dynamic property access
21969
- * const propertyName = KEY_USER_UPDATE_EMAIL;
21970
- * const value = userupdate[propertyName];
21971
+ * const propertyName = KEY_USER_PUBLIC_LOCALE;
21972
+ * const value = userpublic[propertyName];
21971
21973
  * ```
21972
21974
  *
21973
- * @see {@link UserUpdate} - The TypeScript type definition
21974
- * @see {@link KEYS_USER_UPDATE} - Array of all keys for this type
21975
+ * @see {@link UserPublic} - The TypeScript type definition
21976
+ * @see {@link KEYS_USER_PUBLIC} - Array of all keys for this type
21975
21977
  */
21976
- export const KEY_USER_UPDATE_EMAIL: keyof UserUpdate = 'email';
21978
+ export const KEY_USER_PUBLIC_LOCALE: keyof UserPublic = 'locale';
21977
21979
  /**
21978
- * First Name
21980
+ * Organization Id
21979
21981
  *
21980
- * The user's first name
21982
+ * The user's organization id
21981
21983
  *
21984
+ * @type {string}
21982
21985
  *
21983
21986
  *
21984
21987
  * @remarks
21985
- * This key constant provides type-safe access to the `first_name` property of UserUpdate objects.
21988
+ * This key constant provides type-safe access to the `organization_id` property of UserPublic objects.
21986
21989
  * Use this constant when you need to access properties dynamically or ensure type safety.
21987
21990
  *
21988
21991
  * @example
21989
21992
  * ```typescript
21990
21993
  * // Direct property access
21991
- * const value = userupdate[KEY_USER_UPDATE_FIRST_NAME];
21994
+ * const value = userpublic[KEY_USER_PUBLIC_ORGANIZATION_ID];
21992
21995
  *
21993
21996
  * // Dynamic property access
21994
- * const propertyName = KEY_USER_UPDATE_FIRST_NAME;
21995
- * const value = userupdate[propertyName];
21997
+ * const propertyName = KEY_USER_PUBLIC_ORGANIZATION_ID;
21998
+ * const value = userpublic[propertyName];
21996
21999
  * ```
21997
22000
  *
21998
- * @see {@link UserUpdate} - The TypeScript type definition
21999
- * @see {@link KEYS_USER_UPDATE} - Array of all keys for this type
22001
+ * @see {@link UserPublic} - The TypeScript type definition
22002
+ * @see {@link KEYS_USER_PUBLIC} - Array of all keys for this type
22000
22003
  */
22001
- export const KEY_USER_UPDATE_FIRST_NAME: keyof UserUpdate = 'first_name';
22004
+ export const KEY_USER_PUBLIC_ORGANIZATION_ID: keyof UserPublic = 'organization_id';
22002
22005
  /**
22003
- * Last Name
22006
+ * Phone
22004
22007
  *
22005
- * The user's last name
22008
+ * The user's phone number
22006
22009
  *
22007
22010
  *
22008
22011
  *
22009
22012
  * @remarks
22010
- * This key constant provides type-safe access to the `last_name` property of UserUpdate objects.
22013
+ * This key constant provides type-safe access to the `phone` property of UserPublic objects.
22011
22014
  * Use this constant when you need to access properties dynamically or ensure type safety.
22012
22015
  *
22013
22016
  * @example
22014
22017
  * ```typescript
22015
22018
  * // Direct property access
22016
- * const value = userupdate[KEY_USER_UPDATE_LAST_NAME];
22019
+ * const value = userpublic[KEY_USER_PUBLIC_PHONE];
22017
22020
  *
22018
22021
  * // Dynamic property access
22019
- * const propertyName = KEY_USER_UPDATE_LAST_NAME;
22020
- * const value = userupdate[propertyName];
22022
+ * const propertyName = KEY_USER_PUBLIC_PHONE;
22023
+ * const value = userpublic[propertyName];
22021
22024
  * ```
22022
22025
  *
22023
- * @see {@link UserUpdate} - The TypeScript type definition
22024
- * @see {@link KEYS_USER_UPDATE} - Array of all keys for this type
22026
+ * @see {@link UserPublic} - The TypeScript type definition
22027
+ * @see {@link KEYS_USER_PUBLIC} - Array of all keys for this type
22025
22028
  */
22026
- export const KEY_USER_UPDATE_LAST_NAME: keyof UserUpdate = 'last_name';
22029
+ export const KEY_USER_PUBLIC_PHONE: keyof UserPublic = 'phone';
22027
22030
  /**
22028
- * Locale
22031
+ * status property
22029
22032
  *
22030
- * The user's locale
22031
22033
  *
22032
22034
  *
22033
22035
  *
22034
22036
  * @remarks
22035
- * This key constant provides type-safe access to the `locale` property of UserUpdate objects.
22037
+ * This key constant provides type-safe access to the `status` property of UserPublic objects.
22036
22038
  * Use this constant when you need to access properties dynamically or ensure type safety.
22037
22039
  *
22038
22040
  * @example
22039
22041
  * ```typescript
22040
22042
  * // Direct property access
22041
- * const value = userupdate[KEY_USER_UPDATE_LOCALE];
22043
+ * const value = userpublic[KEY_USER_PUBLIC_STATUS];
22042
22044
  *
22043
22045
  * // Dynamic property access
22044
- * const propertyName = KEY_USER_UPDATE_LOCALE;
22045
- * const value = userupdate[propertyName];
22046
+ * const propertyName = KEY_USER_PUBLIC_STATUS;
22047
+ * const value = userpublic[propertyName];
22046
22048
  * ```
22047
22049
  *
22048
- * @see {@link UserUpdate} - The TypeScript type definition
22049
- * @see {@link KEYS_USER_UPDATE} - Array of all keys for this type
22050
+ * @see {@link UserPublic} - The TypeScript type definition
22051
+ * @see {@link KEYS_USER_PUBLIC} - Array of all keys for this type
22050
22052
  */
22051
- export const KEY_USER_UPDATE_LOCALE: keyof UserUpdate = 'locale';
22053
+ export const KEY_USER_PUBLIC_STATUS: keyof UserPublic = 'status';
22052
22054
  /**
22053
- * Phone
22055
+ * Updated On
22054
22056
  *
22055
- * The user's phone number
22057
+ * The date/time the entry was last updated on
22056
22058
  *
22059
+ * @type {string}
22057
22060
  *
22058
22061
  *
22059
22062
  * @remarks
22060
- * This key constant provides type-safe access to the `phone` property of UserUpdate objects.
22063
+ * This key constant provides type-safe access to the `updated_on` property of UserPublic objects.
22061
22064
  * Use this constant when you need to access properties dynamically or ensure type safety.
22062
22065
  *
22063
22066
  * @example
22064
22067
  * ```typescript
22065
22068
  * // Direct property access
22066
- * const value = userupdate[KEY_USER_UPDATE_PHONE];
22069
+ * const value = userpublic[KEY_USER_PUBLIC_UPDATED_ON];
22067
22070
  *
22068
22071
  * // Dynamic property access
22069
- * const propertyName = KEY_USER_UPDATE_PHONE;
22070
- * const value = userupdate[propertyName];
22072
+ * const propertyName = KEY_USER_PUBLIC_UPDATED_ON;
22073
+ * const value = userpublic[propertyName];
22071
22074
  * ```
22072
22075
  *
22073
- * @see {@link UserUpdate} - The TypeScript type definition
22074
- * @see {@link KEYS_USER_UPDATE} - Array of all keys for this type
22076
+ * @see {@link UserPublic} - The TypeScript type definition
22077
+ * @see {@link KEYS_USER_PUBLIC} - Array of all keys for this type
22075
22078
  */
22076
- export const KEY_USER_UPDATE_PHONE: keyof UserUpdate = 'phone';
22079
+ export const KEY_USER_PUBLIC_UPDATED_ON: keyof UserPublic = 'updated_on';
22077
22080
  /**
22078
- * User Attributes
22081
+ * User Id
22079
22082
  *
22080
- * User attributes
22081
22083
  *
22084
+ * @type {string}
22082
22085
  *
22083
22086
  *
22084
22087
  * @remarks
22085
- * This key constant provides type-safe access to the `user_attributes` property of UserUpdate objects.
22088
+ * This key constant provides type-safe access to the `user_id` property of UserPublic objects.
22086
22089
  * Use this constant when you need to access properties dynamically or ensure type safety.
22087
22090
  *
22088
22091
  * @example
22089
22092
  * ```typescript
22090
22093
  * // Direct property access
22091
- * const value = userupdate[KEY_USER_UPDATE_USER_ATTRIBUTES];
22094
+ * const value = userpublic[KEY_USER_PUBLIC_USER_ID];
22092
22095
  *
22093
22096
  * // Dynamic property access
22094
- * const propertyName = KEY_USER_UPDATE_USER_ATTRIBUTES;
22095
- * const value = userupdate[propertyName];
22097
+ * const propertyName = KEY_USER_PUBLIC_USER_ID;
22098
+ * const value = userpublic[propertyName];
22096
22099
  * ```
22097
22100
  *
22098
- * @see {@link UserUpdate} - The TypeScript type definition
22099
- * @see {@link KEYS_USER_UPDATE} - Array of all keys for this type
22101
+ * @see {@link UserPublic} - The TypeScript type definition
22102
+ * @see {@link KEYS_USER_PUBLIC} - Array of all keys for this type
22100
22103
  */
22101
- export const KEY_USER_UPDATE_USER_ATTRIBUTES: keyof UserUpdate = 'user_attributes';
22104
+ export const KEY_USER_PUBLIC_USER_ID: keyof UserPublic = 'user_id';
22102
22105
  /**
22103
22106
  * Username
22104
22107
  *
22105
22108
  * The user's unique username
22106
22109
  *
22110
+ * @type {string}
22107
22111
  *
22108
22112
  *
22109
22113
  * @remarks
22110
- * This key constant provides type-safe access to the `username` property of UserUpdate objects.
22114
+ * This key constant provides type-safe access to the `username` property of UserPublic objects.
22111
22115
  * Use this constant when you need to access properties dynamically or ensure type safety.
22112
22116
  *
22113
22117
  * @example
22114
22118
  * ```typescript
22115
22119
  * // Direct property access
22116
- * const value = userupdate[KEY_USER_UPDATE_USERNAME];
22120
+ * const value = userpublic[KEY_USER_PUBLIC_USERNAME];
22117
22121
  *
22118
22122
  * // Dynamic property access
22119
- * const propertyName = KEY_USER_UPDATE_USERNAME;
22120
- * const value = userupdate[propertyName];
22123
+ * const propertyName = KEY_USER_PUBLIC_USERNAME;
22124
+ * const value = userpublic[propertyName];
22121
22125
  * ```
22122
22126
  *
22123
- * @see {@link UserUpdate} - The TypeScript type definition
22124
- * @see {@link KEYS_USER_UPDATE} - Array of all keys for this type
22127
+ * @see {@link UserPublic} - The TypeScript type definition
22128
+ * @see {@link KEYS_USER_PUBLIC} - Array of all keys for this type
22125
22129
  */
22126
- export const KEY_USER_UPDATE_USERNAME: keyof UserUpdate = 'username';
22130
+ export const KEY_USER_PUBLIC_USERNAME: keyof UserPublic = 'username';
22127
22131
 
22128
22132
  /**
22129
- * Array of all UserUpdate property keys
22133
+ * Array of all UserPublic property keys
22130
22134
  *
22131
22135
  * @remarks
22132
- * This constant provides a readonly array containing all valid property keys for UserUpdate objects.
22136
+ * This constant provides a readonly array containing all valid property keys for UserPublic objects.
22133
22137
  * Useful for iteration, validation, and generating dynamic UI components.
22134
22138
  *
22135
22139
  * @example
22136
22140
  * ```typescript
22137
22141
  * // Iterating through all keys
22138
- * for (const key of KEYS_USER_UPDATE) {
22139
- * console.log(`Property: ${key}, Value: ${userupdate[key]}`);
22142
+ * for (const key of KEYS_USER_PUBLIC) {
22143
+ * console.log(`Property: ${key}, Value: ${userpublic[key]}`);
22140
22144
  * }
22141
22145
  *
22142
22146
  * // Validation
22143
- * const isValidKey = KEYS_USER_UPDATE.includes(someKey);
22147
+ * const isValidKey = KEYS_USER_PUBLIC.includes(someKey);
22144
22148
  * ```
22145
22149
  *
22146
- * @see {@link UserUpdate} - The TypeScript type definition
22150
+ * @see {@link UserPublic} - The TypeScript type definition
22147
22151
  */
22148
- export const KEYS_USER_UPDATE = [
22149
- KEY_USER_UPDATE_EMAIL,
22150
- KEY_USER_UPDATE_FIRST_NAME,
22151
- KEY_USER_UPDATE_LAST_NAME,
22152
- KEY_USER_UPDATE_LOCALE,
22153
- KEY_USER_UPDATE_PHONE,
22154
- KEY_USER_UPDATE_USER_ATTRIBUTES,
22155
- KEY_USER_UPDATE_USERNAME,
22156
- ] as const satisfies (keyof UserUpdate)[];
22152
+ export const KEYS_USER_PUBLIC = [
22153
+ KEY_USER_PUBLIC_CREATED_ON,
22154
+ KEY_USER_PUBLIC_DELETED_ON,
22155
+ KEY_USER_PUBLIC_EMAIL,
22156
+ KEY_USER_PUBLIC_FIRST_NAME,
22157
+ KEY_USER_PUBLIC_LAST_NAME,
22158
+ KEY_USER_PUBLIC_LOCALE,
22159
+ KEY_USER_PUBLIC_ORGANIZATION_ID,
22160
+ KEY_USER_PUBLIC_PHONE,
22161
+ KEY_USER_PUBLIC_STATUS,
22162
+ KEY_USER_PUBLIC_UPDATED_ON,
22163
+ KEY_USER_PUBLIC_USER_ID,
22164
+ KEY_USER_PUBLIC_USERNAME,
22165
+ ] as const satisfies (keyof UserPublic)[];
22157
22166
 
22158
22167
  /**
22159
22168
  * Created On
@@ -22164,23 +22173,23 @@ export const KEYS_USER_UPDATE = [
22164
22173
  *
22165
22174
  *
22166
22175
  * @remarks
22167
- * This key constant provides type-safe access to the `created_on` property of UserWithAttributes objects.
22176
+ * This key constant provides type-safe access to the `created_on` property of UserPublicWithAttributes objects.
22168
22177
  * Use this constant when you need to access properties dynamically or ensure type safety.
22169
22178
  *
22170
22179
  * @example
22171
22180
  * ```typescript
22172
22181
  * // Direct property access
22173
- * const value = userwithattributes[KEY_USER_WITH_ATTRIBUTES_CREATED_ON];
22182
+ * const value = userpublicwithattributes[KEY_USER_PUBLIC_WITH_ATTRIBUTES_CREATED_ON];
22174
22183
  *
22175
22184
  * // Dynamic property access
22176
- * const propertyName = KEY_USER_WITH_ATTRIBUTES_CREATED_ON;
22177
- * const value = userwithattributes[propertyName];
22185
+ * const propertyName = KEY_USER_PUBLIC_WITH_ATTRIBUTES_CREATED_ON;
22186
+ * const value = userpublicwithattributes[propertyName];
22178
22187
  * ```
22179
22188
  *
22180
- * @see {@link UserWithAttributes} - The TypeScript type definition
22181
- * @see {@link KEYS_USER_WITH_ATTRIBUTES} - Array of all keys for this type
22189
+ * @see {@link UserPublicWithAttributes} - The TypeScript type definition
22190
+ * @see {@link KEYS_USER_PUBLIC_WITH_ATTRIBUTES} - Array of all keys for this type
22182
22191
  */
22183
- export const KEY_USER_WITH_ATTRIBUTES_CREATED_ON: keyof UserWithAttributes = 'created_on';
22192
+ export const KEY_USER_PUBLIC_WITH_ATTRIBUTES_CREATED_ON: keyof UserPublicWithAttributes = 'created_on';
22184
22193
  /**
22185
22194
  * Deleted On
22186
22195
  *
@@ -22189,23 +22198,23 @@ export const KEY_USER_WITH_ATTRIBUTES_CREATED_ON: keyof UserWithAttributes = 'cr
22189
22198
  *
22190
22199
  *
22191
22200
  * @remarks
22192
- * This key constant provides type-safe access to the `deleted_on` property of UserWithAttributes objects.
22201
+ * This key constant provides type-safe access to the `deleted_on` property of UserPublicWithAttributes objects.
22193
22202
  * Use this constant when you need to access properties dynamically or ensure type safety.
22194
22203
  *
22195
22204
  * @example
22196
22205
  * ```typescript
22197
22206
  * // Direct property access
22198
- * const value = userwithattributes[KEY_USER_WITH_ATTRIBUTES_DELETED_ON];
22207
+ * const value = userpublicwithattributes[KEY_USER_PUBLIC_WITH_ATTRIBUTES_DELETED_ON];
22199
22208
  *
22200
22209
  * // Dynamic property access
22201
- * const propertyName = KEY_USER_WITH_ATTRIBUTES_DELETED_ON;
22202
- * const value = userwithattributes[propertyName];
22210
+ * const propertyName = KEY_USER_PUBLIC_WITH_ATTRIBUTES_DELETED_ON;
22211
+ * const value = userpublicwithattributes[propertyName];
22203
22212
  * ```
22204
22213
  *
22205
- * @see {@link UserWithAttributes} - The TypeScript type definition
22206
- * @see {@link KEYS_USER_WITH_ATTRIBUTES} - Array of all keys for this type
22214
+ * @see {@link UserPublicWithAttributes} - The TypeScript type definition
22215
+ * @see {@link KEYS_USER_PUBLIC_WITH_ATTRIBUTES} - Array of all keys for this type
22207
22216
  */
22208
- export const KEY_USER_WITH_ATTRIBUTES_DELETED_ON: keyof UserWithAttributes = 'deleted_on';
22217
+ export const KEY_USER_PUBLIC_WITH_ATTRIBUTES_DELETED_ON: keyof UserPublicWithAttributes = 'deleted_on';
22209
22218
  /**
22210
22219
  * Email
22211
22220
  *
@@ -22215,23 +22224,23 @@ export const KEY_USER_WITH_ATTRIBUTES_DELETED_ON: keyof UserWithAttributes = 'de
22215
22224
  *
22216
22225
  *
22217
22226
  * @remarks
22218
- * This key constant provides type-safe access to the `email` property of UserWithAttributes objects.
22227
+ * This key constant provides type-safe access to the `email` property of UserPublicWithAttributes objects.
22219
22228
  * Use this constant when you need to access properties dynamically or ensure type safety.
22220
22229
  *
22221
22230
  * @example
22222
22231
  * ```typescript
22223
22232
  * // Direct property access
22224
- * const value = userwithattributes[KEY_USER_WITH_ATTRIBUTES_EMAIL];
22233
+ * const value = userpublicwithattributes[KEY_USER_PUBLIC_WITH_ATTRIBUTES_EMAIL];
22225
22234
  *
22226
22235
  * // Dynamic property access
22227
- * const propertyName = KEY_USER_WITH_ATTRIBUTES_EMAIL;
22228
- * const value = userwithattributes[propertyName];
22236
+ * const propertyName = KEY_USER_PUBLIC_WITH_ATTRIBUTES_EMAIL;
22237
+ * const value = userpublicwithattributes[propertyName];
22229
22238
  * ```
22230
22239
  *
22231
- * @see {@link UserWithAttributes} - The TypeScript type definition
22232
- * @see {@link KEYS_USER_WITH_ATTRIBUTES} - Array of all keys for this type
22240
+ * @see {@link UserPublicWithAttributes} - The TypeScript type definition
22241
+ * @see {@link KEYS_USER_PUBLIC_WITH_ATTRIBUTES} - Array of all keys for this type
22233
22242
  */
22234
- export const KEY_USER_WITH_ATTRIBUTES_EMAIL: keyof UserWithAttributes = 'email';
22243
+ export const KEY_USER_PUBLIC_WITH_ATTRIBUTES_EMAIL: keyof UserPublicWithAttributes = 'email';
22235
22244
  /**
22236
22245
  * First Name
22237
22246
  *
@@ -22241,23 +22250,23 @@ export const KEY_USER_WITH_ATTRIBUTES_EMAIL: keyof UserWithAttributes = 'email';
22241
22250
  *
22242
22251
  *
22243
22252
  * @remarks
22244
- * This key constant provides type-safe access to the `first_name` property of UserWithAttributes objects.
22253
+ * This key constant provides type-safe access to the `first_name` property of UserPublicWithAttributes objects.
22245
22254
  * Use this constant when you need to access properties dynamically or ensure type safety.
22246
22255
  *
22247
22256
  * @example
22248
22257
  * ```typescript
22249
22258
  * // Direct property access
22250
- * const value = userwithattributes[KEY_USER_WITH_ATTRIBUTES_FIRST_NAME];
22259
+ * const value = userpublicwithattributes[KEY_USER_PUBLIC_WITH_ATTRIBUTES_FIRST_NAME];
22251
22260
  *
22252
22261
  * // Dynamic property access
22253
- * const propertyName = KEY_USER_WITH_ATTRIBUTES_FIRST_NAME;
22254
- * const value = userwithattributes[propertyName];
22262
+ * const propertyName = KEY_USER_PUBLIC_WITH_ATTRIBUTES_FIRST_NAME;
22263
+ * const value = userpublicwithattributes[propertyName];
22255
22264
  * ```
22256
22265
  *
22257
- * @see {@link UserWithAttributes} - The TypeScript type definition
22258
- * @see {@link KEYS_USER_WITH_ATTRIBUTES} - Array of all keys for this type
22266
+ * @see {@link UserPublicWithAttributes} - The TypeScript type definition
22267
+ * @see {@link KEYS_USER_PUBLIC_WITH_ATTRIBUTES} - Array of all keys for this type
22259
22268
  */
22260
- export const KEY_USER_WITH_ATTRIBUTES_FIRST_NAME: keyof UserWithAttributes = 'first_name';
22269
+ export const KEY_USER_PUBLIC_WITH_ATTRIBUTES_FIRST_NAME: keyof UserPublicWithAttributes = 'first_name';
22261
22270
  /**
22262
22271
  * Last Name
22263
22272
  *
@@ -22267,23 +22276,23 @@ export const KEY_USER_WITH_ATTRIBUTES_FIRST_NAME: keyof UserWithAttributes = 'fi
22267
22276
  *
22268
22277
  *
22269
22278
  * @remarks
22270
- * This key constant provides type-safe access to the `last_name` property of UserWithAttributes objects.
22279
+ * This key constant provides type-safe access to the `last_name` property of UserPublicWithAttributes objects.
22271
22280
  * Use this constant when you need to access properties dynamically or ensure type safety.
22272
22281
  *
22273
22282
  * @example
22274
22283
  * ```typescript
22275
22284
  * // Direct property access
22276
- * const value = userwithattributes[KEY_USER_WITH_ATTRIBUTES_LAST_NAME];
22285
+ * const value = userpublicwithattributes[KEY_USER_PUBLIC_WITH_ATTRIBUTES_LAST_NAME];
22277
22286
  *
22278
22287
  * // Dynamic property access
22279
- * const propertyName = KEY_USER_WITH_ATTRIBUTES_LAST_NAME;
22280
- * const value = userwithattributes[propertyName];
22288
+ * const propertyName = KEY_USER_PUBLIC_WITH_ATTRIBUTES_LAST_NAME;
22289
+ * const value = userpublicwithattributes[propertyName];
22281
22290
  * ```
22282
22291
  *
22283
- * @see {@link UserWithAttributes} - The TypeScript type definition
22284
- * @see {@link KEYS_USER_WITH_ATTRIBUTES} - Array of all keys for this type
22292
+ * @see {@link UserPublicWithAttributes} - The TypeScript type definition
22293
+ * @see {@link KEYS_USER_PUBLIC_WITH_ATTRIBUTES} - Array of all keys for this type
22285
22294
  */
22286
- export const KEY_USER_WITH_ATTRIBUTES_LAST_NAME: keyof UserWithAttributes = 'last_name';
22295
+ export const KEY_USER_PUBLIC_WITH_ATTRIBUTES_LAST_NAME: keyof UserPublicWithAttributes = 'last_name';
22287
22296
  /**
22288
22297
  * Locale
22289
22298
  *
@@ -22292,23 +22301,23 @@ export const KEY_USER_WITH_ATTRIBUTES_LAST_NAME: keyof UserWithAttributes = 'las
22292
22301
  *
22293
22302
  *
22294
22303
  * @remarks
22295
- * This key constant provides type-safe access to the `locale` property of UserWithAttributes objects.
22304
+ * This key constant provides type-safe access to the `locale` property of UserPublicWithAttributes objects.
22296
22305
  * Use this constant when you need to access properties dynamically or ensure type safety.
22297
22306
  *
22298
22307
  * @example
22299
22308
  * ```typescript
22300
22309
  * // Direct property access
22301
- * const value = userwithattributes[KEY_USER_WITH_ATTRIBUTES_LOCALE];
22310
+ * const value = userpublicwithattributes[KEY_USER_PUBLIC_WITH_ATTRIBUTES_LOCALE];
22302
22311
  *
22303
22312
  * // Dynamic property access
22304
- * const propertyName = KEY_USER_WITH_ATTRIBUTES_LOCALE;
22305
- * const value = userwithattributes[propertyName];
22313
+ * const propertyName = KEY_USER_PUBLIC_WITH_ATTRIBUTES_LOCALE;
22314
+ * const value = userpublicwithattributes[propertyName];
22306
22315
  * ```
22307
22316
  *
22308
- * @see {@link UserWithAttributes} - The TypeScript type definition
22309
- * @see {@link KEYS_USER_WITH_ATTRIBUTES} - Array of all keys for this type
22317
+ * @see {@link UserPublicWithAttributes} - The TypeScript type definition
22318
+ * @see {@link KEYS_USER_PUBLIC_WITH_ATTRIBUTES} - Array of all keys for this type
22310
22319
  */
22311
- export const KEY_USER_WITH_ATTRIBUTES_LOCALE: keyof UserWithAttributes = 'locale';
22320
+ export const KEY_USER_PUBLIC_WITH_ATTRIBUTES_LOCALE: keyof UserPublicWithAttributes = 'locale';
22312
22321
  /**
22313
22322
  * Organization Id
22314
22323
  *
@@ -22318,23 +22327,23 @@ export const KEY_USER_WITH_ATTRIBUTES_LOCALE: keyof UserWithAttributes = 'locale
22318
22327
  *
22319
22328
  *
22320
22329
  * @remarks
22321
- * This key constant provides type-safe access to the `organization_id` property of UserWithAttributes objects.
22330
+ * This key constant provides type-safe access to the `organization_id` property of UserPublicWithAttributes objects.
22322
22331
  * Use this constant when you need to access properties dynamically or ensure type safety.
22323
22332
  *
22324
22333
  * @example
22325
22334
  * ```typescript
22326
22335
  * // Direct property access
22327
- * const value = userwithattributes[KEY_USER_WITH_ATTRIBUTES_ORGANIZATION_ID];
22336
+ * const value = userpublicwithattributes[KEY_USER_PUBLIC_WITH_ATTRIBUTES_ORGANIZATION_ID];
22328
22337
  *
22329
22338
  * // Dynamic property access
22330
- * const propertyName = KEY_USER_WITH_ATTRIBUTES_ORGANIZATION_ID;
22331
- * const value = userwithattributes[propertyName];
22339
+ * const propertyName = KEY_USER_PUBLIC_WITH_ATTRIBUTES_ORGANIZATION_ID;
22340
+ * const value = userpublicwithattributes[propertyName];
22332
22341
  * ```
22333
22342
  *
22334
- * @see {@link UserWithAttributes} - The TypeScript type definition
22335
- * @see {@link KEYS_USER_WITH_ATTRIBUTES} - Array of all keys for this type
22343
+ * @see {@link UserPublicWithAttributes} - The TypeScript type definition
22344
+ * @see {@link KEYS_USER_PUBLIC_WITH_ATTRIBUTES} - Array of all keys for this type
22336
22345
  */
22337
- export const KEY_USER_WITH_ATTRIBUTES_ORGANIZATION_ID: keyof UserWithAttributes = 'organization_id';
22346
+ export const KEY_USER_PUBLIC_WITH_ATTRIBUTES_ORGANIZATION_ID: keyof UserPublicWithAttributes = 'organization_id';
22338
22347
  /**
22339
22348
  * Phone
22340
22349
  *
@@ -22343,23 +22352,23 @@ export const KEY_USER_WITH_ATTRIBUTES_ORGANIZATION_ID: keyof UserWithAttributes
22343
22352
  *
22344
22353
  *
22345
22354
  * @remarks
22346
- * This key constant provides type-safe access to the `phone` property of UserWithAttributes objects.
22355
+ * This key constant provides type-safe access to the `phone` property of UserPublicWithAttributes objects.
22347
22356
  * Use this constant when you need to access properties dynamically or ensure type safety.
22348
22357
  *
22349
22358
  * @example
22350
22359
  * ```typescript
22351
22360
  * // Direct property access
22352
- * const value = userwithattributes[KEY_USER_WITH_ATTRIBUTES_PHONE];
22361
+ * const value = userpublicwithattributes[KEY_USER_PUBLIC_WITH_ATTRIBUTES_PHONE];
22353
22362
  *
22354
22363
  * // Dynamic property access
22355
- * const propertyName = KEY_USER_WITH_ATTRIBUTES_PHONE;
22356
- * const value = userwithattributes[propertyName];
22364
+ * const propertyName = KEY_USER_PUBLIC_WITH_ATTRIBUTES_PHONE;
22365
+ * const value = userpublicwithattributes[propertyName];
22357
22366
  * ```
22358
22367
  *
22359
- * @see {@link UserWithAttributes} - The TypeScript type definition
22360
- * @see {@link KEYS_USER_WITH_ATTRIBUTES} - Array of all keys for this type
22368
+ * @see {@link UserPublicWithAttributes} - The TypeScript type definition
22369
+ * @see {@link KEYS_USER_PUBLIC_WITH_ATTRIBUTES} - Array of all keys for this type
22361
22370
  */
22362
- export const KEY_USER_WITH_ATTRIBUTES_PHONE: keyof UserWithAttributes = 'phone';
22371
+ export const KEY_USER_PUBLIC_WITH_ATTRIBUTES_PHONE: keyof UserPublicWithAttributes = 'phone';
22363
22372
  /**
22364
22373
  * status property
22365
22374
  *
@@ -22367,23 +22376,23 @@ export const KEY_USER_WITH_ATTRIBUTES_PHONE: keyof UserWithAttributes = 'phone';
22367
22376
  *
22368
22377
  *
22369
22378
  * @remarks
22370
- * This key constant provides type-safe access to the `status` property of UserWithAttributes objects.
22379
+ * This key constant provides type-safe access to the `status` property of UserPublicWithAttributes objects.
22371
22380
  * Use this constant when you need to access properties dynamically or ensure type safety.
22372
22381
  *
22373
22382
  * @example
22374
22383
  * ```typescript
22375
22384
  * // Direct property access
22376
- * const value = userwithattributes[KEY_USER_WITH_ATTRIBUTES_STATUS];
22385
+ * const value = userpublicwithattributes[KEY_USER_PUBLIC_WITH_ATTRIBUTES_STATUS];
22377
22386
  *
22378
22387
  * // Dynamic property access
22379
- * const propertyName = KEY_USER_WITH_ATTRIBUTES_STATUS;
22380
- * const value = userwithattributes[propertyName];
22388
+ * const propertyName = KEY_USER_PUBLIC_WITH_ATTRIBUTES_STATUS;
22389
+ * const value = userpublicwithattributes[propertyName];
22381
22390
  * ```
22382
22391
  *
22383
- * @see {@link UserWithAttributes} - The TypeScript type definition
22384
- * @see {@link KEYS_USER_WITH_ATTRIBUTES} - Array of all keys for this type
22392
+ * @see {@link UserPublicWithAttributes} - The TypeScript type definition
22393
+ * @see {@link KEYS_USER_PUBLIC_WITH_ATTRIBUTES} - Array of all keys for this type
22385
22394
  */
22386
- export const KEY_USER_WITH_ATTRIBUTES_STATUS: keyof UserWithAttributes = 'status';
22395
+ export const KEY_USER_PUBLIC_WITH_ATTRIBUTES_STATUS: keyof UserPublicWithAttributes = 'status';
22387
22396
  /**
22388
22397
  * Updated On
22389
22398
  *
@@ -22393,23 +22402,23 @@ export const KEY_USER_WITH_ATTRIBUTES_STATUS: keyof UserWithAttributes = 'status
22393
22402
  *
22394
22403
  *
22395
22404
  * @remarks
22396
- * This key constant provides type-safe access to the `updated_on` property of UserWithAttributes objects.
22405
+ * This key constant provides type-safe access to the `updated_on` property of UserPublicWithAttributes objects.
22397
22406
  * Use this constant when you need to access properties dynamically or ensure type safety.
22398
22407
  *
22399
22408
  * @example
22400
22409
  * ```typescript
22401
22410
  * // Direct property access
22402
- * const value = userwithattributes[KEY_USER_WITH_ATTRIBUTES_UPDATED_ON];
22411
+ * const value = userpublicwithattributes[KEY_USER_PUBLIC_WITH_ATTRIBUTES_UPDATED_ON];
22403
22412
  *
22404
22413
  * // Dynamic property access
22405
- * const propertyName = KEY_USER_WITH_ATTRIBUTES_UPDATED_ON;
22406
- * const value = userwithattributes[propertyName];
22414
+ * const propertyName = KEY_USER_PUBLIC_WITH_ATTRIBUTES_UPDATED_ON;
22415
+ * const value = userpublicwithattributes[propertyName];
22407
22416
  * ```
22408
22417
  *
22409
- * @see {@link UserWithAttributes} - The TypeScript type definition
22410
- * @see {@link KEYS_USER_WITH_ATTRIBUTES} - Array of all keys for this type
22418
+ * @see {@link UserPublicWithAttributes} - The TypeScript type definition
22419
+ * @see {@link KEYS_USER_PUBLIC_WITH_ATTRIBUTES} - Array of all keys for this type
22411
22420
  */
22412
- export const KEY_USER_WITH_ATTRIBUTES_UPDATED_ON: keyof UserWithAttributes = 'updated_on';
22421
+ export const KEY_USER_PUBLIC_WITH_ATTRIBUTES_UPDATED_ON: keyof UserPublicWithAttributes = 'updated_on';
22413
22422
  /**
22414
22423
  * User Attributes
22415
22424
  *
@@ -22419,23 +22428,23 @@ export const KEY_USER_WITH_ATTRIBUTES_UPDATED_ON: keyof UserWithAttributes = 'up
22419
22428
  *
22420
22429
  *
22421
22430
  * @remarks
22422
- * This key constant provides type-safe access to the `user_attributes` property of UserWithAttributes objects.
22431
+ * This key constant provides type-safe access to the `user_attributes` property of UserPublicWithAttributes objects.
22423
22432
  * Use this constant when you need to access properties dynamically or ensure type safety.
22424
22433
  *
22425
22434
  * @example
22426
22435
  * ```typescript
22427
22436
  * // Direct property access
22428
- * const value = userwithattributes[KEY_USER_WITH_ATTRIBUTES_USER_ATTRIBUTES];
22437
+ * const value = userpublicwithattributes[KEY_USER_PUBLIC_WITH_ATTRIBUTES_USER_ATTRIBUTES];
22429
22438
  *
22430
22439
  * // Dynamic property access
22431
- * const propertyName = KEY_USER_WITH_ATTRIBUTES_USER_ATTRIBUTES;
22432
- * const value = userwithattributes[propertyName];
22440
+ * const propertyName = KEY_USER_PUBLIC_WITH_ATTRIBUTES_USER_ATTRIBUTES;
22441
+ * const value = userpublicwithattributes[propertyName];
22433
22442
  * ```
22434
22443
  *
22435
- * @see {@link UserWithAttributes} - The TypeScript type definition
22436
- * @see {@link KEYS_USER_WITH_ATTRIBUTES} - Array of all keys for this type
22444
+ * @see {@link UserPublicWithAttributes} - The TypeScript type definition
22445
+ * @see {@link KEYS_USER_PUBLIC_WITH_ATTRIBUTES} - Array of all keys for this type
22437
22446
  */
22438
- export const KEY_USER_WITH_ATTRIBUTES_USER_ATTRIBUTES: keyof UserWithAttributes = 'user_attributes';
22447
+ export const KEY_USER_PUBLIC_WITH_ATTRIBUTES_USER_ATTRIBUTES: keyof UserPublicWithAttributes = 'user_attributes';
22439
22448
  /**
22440
22449
  * User Id
22441
22450
  *
@@ -22444,23 +22453,23 @@ export const KEY_USER_WITH_ATTRIBUTES_USER_ATTRIBUTES: keyof UserWithAttributes
22444
22453
  *
22445
22454
  *
22446
22455
  * @remarks
22447
- * This key constant provides type-safe access to the `user_id` property of UserWithAttributes objects.
22456
+ * This key constant provides type-safe access to the `user_id` property of UserPublicWithAttributes objects.
22448
22457
  * Use this constant when you need to access properties dynamically or ensure type safety.
22449
22458
  *
22450
22459
  * @example
22451
22460
  * ```typescript
22452
22461
  * // Direct property access
22453
- * const value = userwithattributes[KEY_USER_WITH_ATTRIBUTES_USER_ID];
22462
+ * const value = userpublicwithattributes[KEY_USER_PUBLIC_WITH_ATTRIBUTES_USER_ID];
22454
22463
  *
22455
22464
  * // Dynamic property access
22456
- * const propertyName = KEY_USER_WITH_ATTRIBUTES_USER_ID;
22457
- * const value = userwithattributes[propertyName];
22465
+ * const propertyName = KEY_USER_PUBLIC_WITH_ATTRIBUTES_USER_ID;
22466
+ * const value = userpublicwithattributes[propertyName];
22458
22467
  * ```
22459
22468
  *
22460
- * @see {@link UserWithAttributes} - The TypeScript type definition
22461
- * @see {@link KEYS_USER_WITH_ATTRIBUTES} - Array of all keys for this type
22469
+ * @see {@link UserPublicWithAttributes} - The TypeScript type definition
22470
+ * @see {@link KEYS_USER_PUBLIC_WITH_ATTRIBUTES} - Array of all keys for this type
22462
22471
  */
22463
- export const KEY_USER_WITH_ATTRIBUTES_USER_ID: keyof UserWithAttributes = 'user_id';
22472
+ export const KEY_USER_PUBLIC_WITH_ATTRIBUTES_USER_ID: keyof UserPublicWithAttributes = 'user_id';
22464
22473
  /**
22465
22474
  * Username
22466
22475
  *
@@ -22470,59 +22479,419 @@ export const KEY_USER_WITH_ATTRIBUTES_USER_ID: keyof UserWithAttributes = 'user_
22470
22479
  *
22471
22480
  *
22472
22481
  * @remarks
22473
- * This key constant provides type-safe access to the `username` property of UserWithAttributes objects.
22482
+ * This key constant provides type-safe access to the `username` property of UserPublicWithAttributes objects.
22474
22483
  * Use this constant when you need to access properties dynamically or ensure type safety.
22475
22484
  *
22476
22485
  * @example
22477
22486
  * ```typescript
22478
22487
  * // Direct property access
22479
- * const value = userwithattributes[KEY_USER_WITH_ATTRIBUTES_USERNAME];
22488
+ * const value = userpublicwithattributes[KEY_USER_PUBLIC_WITH_ATTRIBUTES_USERNAME];
22480
22489
  *
22481
22490
  * // Dynamic property access
22482
- * const propertyName = KEY_USER_WITH_ATTRIBUTES_USERNAME;
22483
- * const value = userwithattributes[propertyName];
22491
+ * const propertyName = KEY_USER_PUBLIC_WITH_ATTRIBUTES_USERNAME;
22492
+ * const value = userpublicwithattributes[propertyName];
22484
22493
  * ```
22485
22494
  *
22486
- * @see {@link UserWithAttributes} - The TypeScript type definition
22487
- * @see {@link KEYS_USER_WITH_ATTRIBUTES} - Array of all keys for this type
22495
+ * @see {@link UserPublicWithAttributes} - The TypeScript type definition
22496
+ * @see {@link KEYS_USER_PUBLIC_WITH_ATTRIBUTES} - Array of all keys for this type
22488
22497
  */
22489
- export const KEY_USER_WITH_ATTRIBUTES_USERNAME: keyof UserWithAttributes = 'username';
22498
+ export const KEY_USER_PUBLIC_WITH_ATTRIBUTES_USERNAME: keyof UserPublicWithAttributes = 'username';
22490
22499
 
22491
22500
  /**
22492
- * Array of all UserWithAttributes property keys
22501
+ * Array of all UserPublicWithAttributes property keys
22493
22502
  *
22494
22503
  * @remarks
22495
- * This constant provides a readonly array containing all valid property keys for UserWithAttributes objects.
22504
+ * This constant provides a readonly array containing all valid property keys for UserPublicWithAttributes objects.
22496
22505
  * Useful for iteration, validation, and generating dynamic UI components.
22497
22506
  *
22498
22507
  * @example
22499
22508
  * ```typescript
22500
22509
  * // Iterating through all keys
22501
- * for (const key of KEYS_USER_WITH_ATTRIBUTES) {
22502
- * console.log(`Property: ${key}, Value: ${userwithattributes[key]}`);
22510
+ * for (const key of KEYS_USER_PUBLIC_WITH_ATTRIBUTES) {
22511
+ * console.log(`Property: ${key}, Value: ${userpublicwithattributes[key]}`);
22503
22512
  * }
22504
22513
  *
22505
22514
  * // Validation
22506
- * const isValidKey = KEYS_USER_WITH_ATTRIBUTES.includes(someKey);
22507
- * ```
22508
- *
22509
- * @see {@link UserWithAttributes} - The TypeScript type definition
22510
- */
22511
- export const KEYS_USER_WITH_ATTRIBUTES = [
22512
- KEY_USER_WITH_ATTRIBUTES_CREATED_ON,
22513
- KEY_USER_WITH_ATTRIBUTES_DELETED_ON,
22514
- KEY_USER_WITH_ATTRIBUTES_EMAIL,
22515
- KEY_USER_WITH_ATTRIBUTES_FIRST_NAME,
22516
- KEY_USER_WITH_ATTRIBUTES_LAST_NAME,
22517
- KEY_USER_WITH_ATTRIBUTES_LOCALE,
22518
- KEY_USER_WITH_ATTRIBUTES_ORGANIZATION_ID,
22519
- KEY_USER_WITH_ATTRIBUTES_PHONE,
22520
- KEY_USER_WITH_ATTRIBUTES_STATUS,
22521
- KEY_USER_WITH_ATTRIBUTES_UPDATED_ON,
22522
- KEY_USER_WITH_ATTRIBUTES_USER_ATTRIBUTES,
22523
- KEY_USER_WITH_ATTRIBUTES_USER_ID,
22524
- KEY_USER_WITH_ATTRIBUTES_USERNAME,
22525
- ] as const satisfies (keyof UserWithAttributes)[];
22515
+ * const isValidKey = KEYS_USER_PUBLIC_WITH_ATTRIBUTES.includes(someKey);
22516
+ * ```
22517
+ *
22518
+ * @see {@link UserPublicWithAttributes} - The TypeScript type definition
22519
+ */
22520
+ export const KEYS_USER_PUBLIC_WITH_ATTRIBUTES = [
22521
+ KEY_USER_PUBLIC_WITH_ATTRIBUTES_CREATED_ON,
22522
+ KEY_USER_PUBLIC_WITH_ATTRIBUTES_DELETED_ON,
22523
+ KEY_USER_PUBLIC_WITH_ATTRIBUTES_EMAIL,
22524
+ KEY_USER_PUBLIC_WITH_ATTRIBUTES_FIRST_NAME,
22525
+ KEY_USER_PUBLIC_WITH_ATTRIBUTES_LAST_NAME,
22526
+ KEY_USER_PUBLIC_WITH_ATTRIBUTES_LOCALE,
22527
+ KEY_USER_PUBLIC_WITH_ATTRIBUTES_ORGANIZATION_ID,
22528
+ KEY_USER_PUBLIC_WITH_ATTRIBUTES_PHONE,
22529
+ KEY_USER_PUBLIC_WITH_ATTRIBUTES_STATUS,
22530
+ KEY_USER_PUBLIC_WITH_ATTRIBUTES_UPDATED_ON,
22531
+ KEY_USER_PUBLIC_WITH_ATTRIBUTES_USER_ATTRIBUTES,
22532
+ KEY_USER_PUBLIC_WITH_ATTRIBUTES_USER_ID,
22533
+ KEY_USER_PUBLIC_WITH_ATTRIBUTES_USERNAME,
22534
+ ] as const satisfies (keyof UserPublicWithAttributes)[];
22535
+
22536
+ /**
22537
+ * Access Token
22538
+ *
22539
+ *
22540
+ * @type {string}
22541
+ *
22542
+ *
22543
+ * @remarks
22544
+ * This key constant provides type-safe access to the `access_token` property of UserToken objects.
22545
+ * Use this constant when you need to access properties dynamically or ensure type safety.
22546
+ *
22547
+ * @example
22548
+ * ```typescript
22549
+ * // Direct property access
22550
+ * const value = usertoken[KEY_USER_TOKEN_ACCESS_TOKEN];
22551
+ *
22552
+ * // Dynamic property access
22553
+ * const propertyName = KEY_USER_TOKEN_ACCESS_TOKEN;
22554
+ * const value = usertoken[propertyName];
22555
+ * ```
22556
+ *
22557
+ * @see {@link UserToken} - The TypeScript type definition
22558
+ * @see {@link KEYS_USER_TOKEN} - Array of all keys for this type
22559
+ */
22560
+ export const KEY_USER_TOKEN_ACCESS_TOKEN: keyof UserToken = 'access_token';
22561
+ /**
22562
+ * Expires In
22563
+ *
22564
+ *
22565
+ * @type {integer}
22566
+ *
22567
+ *
22568
+ * @remarks
22569
+ * This key constant provides type-safe access to the `expires_in` property of UserToken objects.
22570
+ * Use this constant when you need to access properties dynamically or ensure type safety.
22571
+ *
22572
+ * @example
22573
+ * ```typescript
22574
+ * // Direct property access
22575
+ * const value = usertoken[KEY_USER_TOKEN_EXPIRES_IN];
22576
+ *
22577
+ * // Dynamic property access
22578
+ * const propertyName = KEY_USER_TOKEN_EXPIRES_IN;
22579
+ * const value = usertoken[propertyName];
22580
+ * ```
22581
+ *
22582
+ * @see {@link UserToken} - The TypeScript type definition
22583
+ * @see {@link KEYS_USER_TOKEN} - Array of all keys for this type
22584
+ */
22585
+ export const KEY_USER_TOKEN_EXPIRES_IN: keyof UserToken = 'expires_in';
22586
+ /**
22587
+ * Refresh Expires In
22588
+ *
22589
+ *
22590
+ * @type {integer}
22591
+ *
22592
+ *
22593
+ * @remarks
22594
+ * This key constant provides type-safe access to the `refresh_expires_in` property of UserToken objects.
22595
+ * Use this constant when you need to access properties dynamically or ensure type safety.
22596
+ *
22597
+ * @example
22598
+ * ```typescript
22599
+ * // Direct property access
22600
+ * const value = usertoken[KEY_USER_TOKEN_REFRESH_EXPIRES_IN];
22601
+ *
22602
+ * // Dynamic property access
22603
+ * const propertyName = KEY_USER_TOKEN_REFRESH_EXPIRES_IN;
22604
+ * const value = usertoken[propertyName];
22605
+ * ```
22606
+ *
22607
+ * @see {@link UserToken} - The TypeScript type definition
22608
+ * @see {@link KEYS_USER_TOKEN} - Array of all keys for this type
22609
+ */
22610
+ export const KEY_USER_TOKEN_REFRESH_EXPIRES_IN: keyof UserToken = 'refresh_expires_in';
22611
+ /**
22612
+ * Refresh Token
22613
+ *
22614
+ *
22615
+ * @type {string}
22616
+ *
22617
+ *
22618
+ * @remarks
22619
+ * This key constant provides type-safe access to the `refresh_token` property of UserToken objects.
22620
+ * Use this constant when you need to access properties dynamically or ensure type safety.
22621
+ *
22622
+ * @example
22623
+ * ```typescript
22624
+ * // Direct property access
22625
+ * const value = usertoken[KEY_USER_TOKEN_REFRESH_TOKEN];
22626
+ *
22627
+ * // Dynamic property access
22628
+ * const propertyName = KEY_USER_TOKEN_REFRESH_TOKEN;
22629
+ * const value = usertoken[propertyName];
22630
+ * ```
22631
+ *
22632
+ * @see {@link UserToken} - The TypeScript type definition
22633
+ * @see {@link KEYS_USER_TOKEN} - Array of all keys for this type
22634
+ */
22635
+ export const KEY_USER_TOKEN_REFRESH_TOKEN: keyof UserToken = 'refresh_token';
22636
+ /**
22637
+ * Token Type
22638
+ *
22639
+ *
22640
+ * @type {string}
22641
+ *
22642
+ *
22643
+ * @remarks
22644
+ * This key constant provides type-safe access to the `token_type` property of UserToken objects.
22645
+ * Use this constant when you need to access properties dynamically or ensure type safety.
22646
+ *
22647
+ * @example
22648
+ * ```typescript
22649
+ * // Direct property access
22650
+ * const value = usertoken[KEY_USER_TOKEN_TOKEN_TYPE];
22651
+ *
22652
+ * // Dynamic property access
22653
+ * const propertyName = KEY_USER_TOKEN_TOKEN_TYPE;
22654
+ * const value = usertoken[propertyName];
22655
+ * ```
22656
+ *
22657
+ * @see {@link UserToken} - The TypeScript type definition
22658
+ * @see {@link KEYS_USER_TOKEN} - Array of all keys for this type
22659
+ */
22660
+ export const KEY_USER_TOKEN_TOKEN_TYPE: keyof UserToken = 'token_type';
22661
+
22662
+ /**
22663
+ * Array of all UserToken property keys
22664
+ *
22665
+ * @remarks
22666
+ * This constant provides a readonly array containing all valid property keys for UserToken objects.
22667
+ * Useful for iteration, validation, and generating dynamic UI components.
22668
+ *
22669
+ * @example
22670
+ * ```typescript
22671
+ * // Iterating through all keys
22672
+ * for (const key of KEYS_USER_TOKEN) {
22673
+ * console.log(`Property: ${key}, Value: ${usertoken[key]}`);
22674
+ * }
22675
+ *
22676
+ * // Validation
22677
+ * const isValidKey = KEYS_USER_TOKEN.includes(someKey);
22678
+ * ```
22679
+ *
22680
+ * @see {@link UserToken} - The TypeScript type definition
22681
+ */
22682
+ export const KEYS_USER_TOKEN = [
22683
+ KEY_USER_TOKEN_ACCESS_TOKEN,
22684
+ KEY_USER_TOKEN_EXPIRES_IN,
22685
+ KEY_USER_TOKEN_REFRESH_EXPIRES_IN,
22686
+ KEY_USER_TOKEN_REFRESH_TOKEN,
22687
+ KEY_USER_TOKEN_TOKEN_TYPE,
22688
+ ] as const satisfies (keyof UserToken)[];
22689
+
22690
+ /**
22691
+ * Email
22692
+ *
22693
+ * The user's email address
22694
+ *
22695
+ *
22696
+ *
22697
+ * @remarks
22698
+ * This key constant provides type-safe access to the `email` property of UserUpdate objects.
22699
+ * Use this constant when you need to access properties dynamically or ensure type safety.
22700
+ *
22701
+ * @example
22702
+ * ```typescript
22703
+ * // Direct property access
22704
+ * const value = userupdate[KEY_USER_UPDATE_EMAIL];
22705
+ *
22706
+ * // Dynamic property access
22707
+ * const propertyName = KEY_USER_UPDATE_EMAIL;
22708
+ * const value = userupdate[propertyName];
22709
+ * ```
22710
+ *
22711
+ * @see {@link UserUpdate} - The TypeScript type definition
22712
+ * @see {@link KEYS_USER_UPDATE} - Array of all keys for this type
22713
+ */
22714
+ export const KEY_USER_UPDATE_EMAIL: keyof UserUpdate = 'email';
22715
+ /**
22716
+ * First Name
22717
+ *
22718
+ * The user's first name
22719
+ *
22720
+ *
22721
+ *
22722
+ * @remarks
22723
+ * This key constant provides type-safe access to the `first_name` property of UserUpdate objects.
22724
+ * Use this constant when you need to access properties dynamically or ensure type safety.
22725
+ *
22726
+ * @example
22727
+ * ```typescript
22728
+ * // Direct property access
22729
+ * const value = userupdate[KEY_USER_UPDATE_FIRST_NAME];
22730
+ *
22731
+ * // Dynamic property access
22732
+ * const propertyName = KEY_USER_UPDATE_FIRST_NAME;
22733
+ * const value = userupdate[propertyName];
22734
+ * ```
22735
+ *
22736
+ * @see {@link UserUpdate} - The TypeScript type definition
22737
+ * @see {@link KEYS_USER_UPDATE} - Array of all keys for this type
22738
+ */
22739
+ export const KEY_USER_UPDATE_FIRST_NAME: keyof UserUpdate = 'first_name';
22740
+ /**
22741
+ * Last Name
22742
+ *
22743
+ * The user's last name
22744
+ *
22745
+ *
22746
+ *
22747
+ * @remarks
22748
+ * This key constant provides type-safe access to the `last_name` property of UserUpdate objects.
22749
+ * Use this constant when you need to access properties dynamically or ensure type safety.
22750
+ *
22751
+ * @example
22752
+ * ```typescript
22753
+ * // Direct property access
22754
+ * const value = userupdate[KEY_USER_UPDATE_LAST_NAME];
22755
+ *
22756
+ * // Dynamic property access
22757
+ * const propertyName = KEY_USER_UPDATE_LAST_NAME;
22758
+ * const value = userupdate[propertyName];
22759
+ * ```
22760
+ *
22761
+ * @see {@link UserUpdate} - The TypeScript type definition
22762
+ * @see {@link KEYS_USER_UPDATE} - Array of all keys for this type
22763
+ */
22764
+ export const KEY_USER_UPDATE_LAST_NAME: keyof UserUpdate = 'last_name';
22765
+ /**
22766
+ * Locale
22767
+ *
22768
+ * The user's locale
22769
+ *
22770
+ *
22771
+ *
22772
+ * @remarks
22773
+ * This key constant provides type-safe access to the `locale` property of UserUpdate objects.
22774
+ * Use this constant when you need to access properties dynamically or ensure type safety.
22775
+ *
22776
+ * @example
22777
+ * ```typescript
22778
+ * // Direct property access
22779
+ * const value = userupdate[KEY_USER_UPDATE_LOCALE];
22780
+ *
22781
+ * // Dynamic property access
22782
+ * const propertyName = KEY_USER_UPDATE_LOCALE;
22783
+ * const value = userupdate[propertyName];
22784
+ * ```
22785
+ *
22786
+ * @see {@link UserUpdate} - The TypeScript type definition
22787
+ * @see {@link KEYS_USER_UPDATE} - Array of all keys for this type
22788
+ */
22789
+ export const KEY_USER_UPDATE_LOCALE: keyof UserUpdate = 'locale';
22790
+ /**
22791
+ * Phone
22792
+ *
22793
+ * The user's phone number
22794
+ *
22795
+ *
22796
+ *
22797
+ * @remarks
22798
+ * This key constant provides type-safe access to the `phone` property of UserUpdate objects.
22799
+ * Use this constant when you need to access properties dynamically or ensure type safety.
22800
+ *
22801
+ * @example
22802
+ * ```typescript
22803
+ * // Direct property access
22804
+ * const value = userupdate[KEY_USER_UPDATE_PHONE];
22805
+ *
22806
+ * // Dynamic property access
22807
+ * const propertyName = KEY_USER_UPDATE_PHONE;
22808
+ * const value = userupdate[propertyName];
22809
+ * ```
22810
+ *
22811
+ * @see {@link UserUpdate} - The TypeScript type definition
22812
+ * @see {@link KEYS_USER_UPDATE} - Array of all keys for this type
22813
+ */
22814
+ export const KEY_USER_UPDATE_PHONE: keyof UserUpdate = 'phone';
22815
+ /**
22816
+ * User Attributes
22817
+ *
22818
+ * User attributes
22819
+ *
22820
+ *
22821
+ *
22822
+ * @remarks
22823
+ * This key constant provides type-safe access to the `user_attributes` property of UserUpdate objects.
22824
+ * Use this constant when you need to access properties dynamically or ensure type safety.
22825
+ *
22826
+ * @example
22827
+ * ```typescript
22828
+ * // Direct property access
22829
+ * const value = userupdate[KEY_USER_UPDATE_USER_ATTRIBUTES];
22830
+ *
22831
+ * // Dynamic property access
22832
+ * const propertyName = KEY_USER_UPDATE_USER_ATTRIBUTES;
22833
+ * const value = userupdate[propertyName];
22834
+ * ```
22835
+ *
22836
+ * @see {@link UserUpdate} - The TypeScript type definition
22837
+ * @see {@link KEYS_USER_UPDATE} - Array of all keys for this type
22838
+ */
22839
+ export const KEY_USER_UPDATE_USER_ATTRIBUTES: keyof UserUpdate = 'user_attributes';
22840
+ /**
22841
+ * Username
22842
+ *
22843
+ * The user's unique username
22844
+ *
22845
+ *
22846
+ *
22847
+ * @remarks
22848
+ * This key constant provides type-safe access to the `username` property of UserUpdate objects.
22849
+ * Use this constant when you need to access properties dynamically or ensure type safety.
22850
+ *
22851
+ * @example
22852
+ * ```typescript
22853
+ * // Direct property access
22854
+ * const value = userupdate[KEY_USER_UPDATE_USERNAME];
22855
+ *
22856
+ * // Dynamic property access
22857
+ * const propertyName = KEY_USER_UPDATE_USERNAME;
22858
+ * const value = userupdate[propertyName];
22859
+ * ```
22860
+ *
22861
+ * @see {@link UserUpdate} - The TypeScript type definition
22862
+ * @see {@link KEYS_USER_UPDATE} - Array of all keys for this type
22863
+ */
22864
+ export const KEY_USER_UPDATE_USERNAME: keyof UserUpdate = 'username';
22865
+
22866
+ /**
22867
+ * Array of all UserUpdate property keys
22868
+ *
22869
+ * @remarks
22870
+ * This constant provides a readonly array containing all valid property keys for UserUpdate objects.
22871
+ * Useful for iteration, validation, and generating dynamic UI components.
22872
+ *
22873
+ * @example
22874
+ * ```typescript
22875
+ * // Iterating through all keys
22876
+ * for (const key of KEYS_USER_UPDATE) {
22877
+ * console.log(`Property: ${key}, Value: ${userupdate[key]}`);
22878
+ * }
22879
+ *
22880
+ * // Validation
22881
+ * const isValidKey = KEYS_USER_UPDATE.includes(someKey);
22882
+ * ```
22883
+ *
22884
+ * @see {@link UserUpdate} - The TypeScript type definition
22885
+ */
22886
+ export const KEYS_USER_UPDATE = [
22887
+ KEY_USER_UPDATE_EMAIL,
22888
+ KEY_USER_UPDATE_FIRST_NAME,
22889
+ KEY_USER_UPDATE_LAST_NAME,
22890
+ KEY_USER_UPDATE_LOCALE,
22891
+ KEY_USER_UPDATE_PHONE,
22892
+ KEY_USER_UPDATE_USER_ATTRIBUTES,
22893
+ KEY_USER_UPDATE_USERNAME,
22894
+ ] as const satisfies (keyof UserUpdate)[];
22526
22895
 
22527
22896
  /**
22528
22897
  * Created On