@opusdns/api 0.138.0 → 0.140.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.
- package/package.json +1 -1
- package/src/helpers/keys.ts +666 -450
- package/src/helpers/requests.d.ts +8 -8
- package/src/helpers/responses.d.ts +15 -15
- package/src/helpers/schemas-arrays.d.ts +15 -1
- package/src/helpers/schemas.d.ts +44 -28
- package/src/openapi.yaml +196 -235
- package/src/schema.d.ts +135 -78
package/src/helpers/keys.ts
CHANGED
|
@@ -75,7 +75,7 @@ import { DomainForwardPatchOp } from './schemas';
|
|
|
75
75
|
import { DomainForwardPatchOps } from './schemas';
|
|
76
76
|
import { DomainForwardProtocolSetRequest } from './schemas';
|
|
77
77
|
import { DomainForwardProtocolSet } from './schemas';
|
|
78
|
-
import {
|
|
78
|
+
import { DomainForwardSetCreateRequest } from './schemas';
|
|
79
79
|
import { DomainForwardSetRequest } from './schemas';
|
|
80
80
|
import { DomainForwardSet } from './schemas';
|
|
81
81
|
import { DomainForwardZone } from './schemas';
|
|
@@ -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';
|
|
@@ -6589,31 +6590,6 @@ export const KEY_DOMAIN_FORWARD_HTTPS: keyof DomainForward = 'https';
|
|
|
6589
6590
|
* @see {@link KEYS_DOMAIN_FORWARD} - Array of all keys for this type
|
|
6590
6591
|
*/
|
|
6591
6592
|
export const KEY_DOMAIN_FORWARD_UPDATED_ON: keyof DomainForward = 'updated_on';
|
|
6592
|
-
/**
|
|
6593
|
-
* Wildcard
|
|
6594
|
-
*
|
|
6595
|
-
*
|
|
6596
|
-
* @type {boolean}
|
|
6597
|
-
*
|
|
6598
|
-
*
|
|
6599
|
-
* @remarks
|
|
6600
|
-
* This key constant provides type-safe access to the `wildcard` property of DomainForward objects.
|
|
6601
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
6602
|
-
*
|
|
6603
|
-
* @example
|
|
6604
|
-
* ```typescript
|
|
6605
|
-
* // Direct property access
|
|
6606
|
-
* const value = domainforward[KEY_DOMAIN_FORWARD_WILDCARD];
|
|
6607
|
-
*
|
|
6608
|
-
* // Dynamic property access
|
|
6609
|
-
* const propertyName = KEY_DOMAIN_FORWARD_WILDCARD;
|
|
6610
|
-
* const value = domainforward[propertyName];
|
|
6611
|
-
* ```
|
|
6612
|
-
*
|
|
6613
|
-
* @see {@link DomainForward} - The TypeScript type definition
|
|
6614
|
-
* @see {@link KEYS_DOMAIN_FORWARD} - Array of all keys for this type
|
|
6615
|
-
*/
|
|
6616
|
-
export const KEY_DOMAIN_FORWARD_WILDCARD: keyof DomainForward = 'wildcard';
|
|
6617
6593
|
|
|
6618
6594
|
/**
|
|
6619
6595
|
* Array of all DomainForward property keys
|
|
@@ -6642,7 +6618,6 @@ export const KEYS_DOMAIN_FORWARD = [
|
|
|
6642
6618
|
KEY_DOMAIN_FORWARD_HTTP,
|
|
6643
6619
|
KEY_DOMAIN_FORWARD_HTTPS,
|
|
6644
6620
|
KEY_DOMAIN_FORWARD_UPDATED_ON,
|
|
6645
|
-
KEY_DOMAIN_FORWARD_WILDCARD,
|
|
6646
6621
|
] as const satisfies (keyof DomainForward)[];
|
|
6647
6622
|
|
|
6648
6623
|
/**
|
|
@@ -6920,30 +6895,6 @@ export const KEYS_DOMAIN_FORWARD_PATCH_OPS = [
|
|
|
6920
6895
|
* @see {@link KEYS_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST} - Array of all keys for this type
|
|
6921
6896
|
*/
|
|
6922
6897
|
export const KEY_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST_REDIRECTS: keyof DomainForwardProtocolSetRequest = 'redirects';
|
|
6923
|
-
/**
|
|
6924
|
-
* Wildcard
|
|
6925
|
-
*
|
|
6926
|
-
*
|
|
6927
|
-
*
|
|
6928
|
-
*
|
|
6929
|
-
* @remarks
|
|
6930
|
-
* This key constant provides type-safe access to the `wildcard` property of DomainForwardProtocolSetRequest objects.
|
|
6931
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
6932
|
-
*
|
|
6933
|
-
* @example
|
|
6934
|
-
* ```typescript
|
|
6935
|
-
* // Direct property access
|
|
6936
|
-
* const value = domainforwardprotocolsetrequest[KEY_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST_WILDCARD];
|
|
6937
|
-
*
|
|
6938
|
-
* // Dynamic property access
|
|
6939
|
-
* const propertyName = KEY_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST_WILDCARD;
|
|
6940
|
-
* const value = domainforwardprotocolsetrequest[propertyName];
|
|
6941
|
-
* ```
|
|
6942
|
-
*
|
|
6943
|
-
* @see {@link DomainForwardProtocolSetRequest} - The TypeScript type definition
|
|
6944
|
-
* @see {@link KEYS_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST} - Array of all keys for this type
|
|
6945
|
-
*/
|
|
6946
|
-
export const KEY_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST_WILDCARD: keyof DomainForwardProtocolSetRequest = 'wildcard';
|
|
6947
6898
|
|
|
6948
6899
|
/**
|
|
6949
6900
|
* Array of all DomainForwardProtocolSetRequest property keys
|
|
@@ -6967,7 +6918,6 @@ export const KEY_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST_WILDCARD: keyof DomainForwa
|
|
|
6967
6918
|
*/
|
|
6968
6919
|
export const KEYS_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST = [
|
|
6969
6920
|
KEY_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST_REDIRECTS,
|
|
6970
|
-
KEY_DOMAIN_FORWARD_PROTOCOL_SET_REQUEST_WILDCARD,
|
|
6971
6921
|
] as const satisfies (keyof DomainForwardProtocolSetRequest)[];
|
|
6972
6922
|
|
|
6973
6923
|
/**
|
|
@@ -7045,31 +6995,6 @@ export const KEY_DOMAIN_FORWARD_PROTOCOL_SET_REDIRECTS: keyof DomainForwardProto
|
|
|
7045
6995
|
* @see {@link KEYS_DOMAIN_FORWARD_PROTOCOL_SET} - Array of all keys for this type
|
|
7046
6996
|
*/
|
|
7047
6997
|
export const KEY_DOMAIN_FORWARD_PROTOCOL_SET_UPDATED_ON: keyof DomainForwardProtocolSet = 'updated_on';
|
|
7048
|
-
/**
|
|
7049
|
-
* Wildcard
|
|
7050
|
-
*
|
|
7051
|
-
*
|
|
7052
|
-
* @type {boolean}
|
|
7053
|
-
*
|
|
7054
|
-
*
|
|
7055
|
-
* @remarks
|
|
7056
|
-
* This key constant provides type-safe access to the `wildcard` property of DomainForwardProtocolSet objects.
|
|
7057
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
7058
|
-
*
|
|
7059
|
-
* @example
|
|
7060
|
-
* ```typescript
|
|
7061
|
-
* // Direct property access
|
|
7062
|
-
* const value = domainforwardprotocolset[KEY_DOMAIN_FORWARD_PROTOCOL_SET_WILDCARD];
|
|
7063
|
-
*
|
|
7064
|
-
* // Dynamic property access
|
|
7065
|
-
* const propertyName = KEY_DOMAIN_FORWARD_PROTOCOL_SET_WILDCARD;
|
|
7066
|
-
* const value = domainforwardprotocolset[propertyName];
|
|
7067
|
-
* ```
|
|
7068
|
-
*
|
|
7069
|
-
* @see {@link DomainForwardProtocolSet} - The TypeScript type definition
|
|
7070
|
-
* @see {@link KEYS_DOMAIN_FORWARD_PROTOCOL_SET} - Array of all keys for this type
|
|
7071
|
-
*/
|
|
7072
|
-
export const KEY_DOMAIN_FORWARD_PROTOCOL_SET_WILDCARD: keyof DomainForwardProtocolSet = 'wildcard';
|
|
7073
6998
|
|
|
7074
6999
|
/**
|
|
7075
7000
|
* Array of all DomainForwardProtocolSet property keys
|
|
@@ -7095,133 +7020,82 @@ export const KEYS_DOMAIN_FORWARD_PROTOCOL_SET = [
|
|
|
7095
7020
|
KEY_DOMAIN_FORWARD_PROTOCOL_SET_CREATED_ON,
|
|
7096
7021
|
KEY_DOMAIN_FORWARD_PROTOCOL_SET_REDIRECTS,
|
|
7097
7022
|
KEY_DOMAIN_FORWARD_PROTOCOL_SET_UPDATED_ON,
|
|
7098
|
-
KEY_DOMAIN_FORWARD_PROTOCOL_SET_WILDCARD,
|
|
7099
7023
|
] as const satisfies (keyof DomainForwardProtocolSet)[];
|
|
7100
7024
|
|
|
7101
7025
|
/**
|
|
7102
|
-
*
|
|
7103
|
-
*
|
|
7104
|
-
*
|
|
7105
|
-
* @type {boolean}
|
|
7106
|
-
*
|
|
7107
|
-
*
|
|
7108
|
-
* @remarks
|
|
7109
|
-
* This key constant provides type-safe access to the `enabled` property of DomainForwardRequest objects.
|
|
7110
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
7111
|
-
*
|
|
7112
|
-
* @example
|
|
7113
|
-
* ```typescript
|
|
7114
|
-
* // Direct property access
|
|
7115
|
-
* const value = domainforwardrequest[KEY_DOMAIN_FORWARD_REQUEST_ENABLED];
|
|
7116
|
-
*
|
|
7117
|
-
* // Dynamic property access
|
|
7118
|
-
* const propertyName = KEY_DOMAIN_FORWARD_REQUEST_ENABLED;
|
|
7119
|
-
* const value = domainforwardrequest[propertyName];
|
|
7120
|
-
* ```
|
|
7121
|
-
*
|
|
7122
|
-
* @see {@link DomainForwardRequest} - The TypeScript type definition
|
|
7123
|
-
* @see {@link KEYS_DOMAIN_FORWARD_REQUEST} - Array of all keys for this type
|
|
7124
|
-
*/
|
|
7125
|
-
export const KEY_DOMAIN_FORWARD_REQUEST_ENABLED: keyof DomainForwardRequest = 'enabled';
|
|
7126
|
-
/**
|
|
7127
|
-
* http property
|
|
7128
|
-
*
|
|
7129
|
-
*
|
|
7130
|
-
*
|
|
7131
|
-
*
|
|
7132
|
-
* @remarks
|
|
7133
|
-
* This key constant provides type-safe access to the `http` property of DomainForwardRequest objects.
|
|
7134
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
7135
|
-
*
|
|
7136
|
-
* @example
|
|
7137
|
-
* ```typescript
|
|
7138
|
-
* // Direct property access
|
|
7139
|
-
* const value = domainforwardrequest[KEY_DOMAIN_FORWARD_REQUEST_HTTP];
|
|
7140
|
-
*
|
|
7141
|
-
* // Dynamic property access
|
|
7142
|
-
* const propertyName = KEY_DOMAIN_FORWARD_REQUEST_HTTP;
|
|
7143
|
-
* const value = domainforwardrequest[propertyName];
|
|
7144
|
-
* ```
|
|
7145
|
-
*
|
|
7146
|
-
* @see {@link DomainForwardRequest} - The TypeScript type definition
|
|
7147
|
-
* @see {@link KEYS_DOMAIN_FORWARD_REQUEST} - Array of all keys for this type
|
|
7148
|
-
*/
|
|
7149
|
-
export const KEY_DOMAIN_FORWARD_REQUEST_HTTP: keyof DomainForwardRequest = 'http';
|
|
7150
|
-
/**
|
|
7151
|
-
* https property
|
|
7026
|
+
* protocol property
|
|
7152
7027
|
*
|
|
7153
7028
|
*
|
|
7154
7029
|
*
|
|
7155
7030
|
*
|
|
7156
7031
|
* @remarks
|
|
7157
|
-
* This key constant provides type-safe access to the `
|
|
7032
|
+
* This key constant provides type-safe access to the `protocol` property of DomainForwardSetCreateRequest objects.
|
|
7158
7033
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
7159
7034
|
*
|
|
7160
7035
|
* @example
|
|
7161
7036
|
* ```typescript
|
|
7162
7037
|
* // Direct property access
|
|
7163
|
-
* const value =
|
|
7038
|
+
* const value = domainforwardsetcreaterequest[KEY_DOMAIN_FORWARD_SET_CREATE_REQUEST_PROTOCOL];
|
|
7164
7039
|
*
|
|
7165
7040
|
* // Dynamic property access
|
|
7166
|
-
* const propertyName =
|
|
7167
|
-
* const value =
|
|
7041
|
+
* const propertyName = KEY_DOMAIN_FORWARD_SET_CREATE_REQUEST_PROTOCOL;
|
|
7042
|
+
* const value = domainforwardsetcreaterequest[propertyName];
|
|
7168
7043
|
* ```
|
|
7169
7044
|
*
|
|
7170
|
-
* @see {@link
|
|
7171
|
-
* @see {@link
|
|
7045
|
+
* @see {@link DomainForwardSetCreateRequest} - The TypeScript type definition
|
|
7046
|
+
* @see {@link KEYS_DOMAIN_FORWARD_SET_CREATE_REQUEST} - Array of all keys for this type
|
|
7172
7047
|
*/
|
|
7173
|
-
export const
|
|
7048
|
+
export const KEY_DOMAIN_FORWARD_SET_CREATE_REQUEST_PROTOCOL: keyof DomainForwardSetCreateRequest = 'protocol';
|
|
7174
7049
|
/**
|
|
7175
|
-
*
|
|
7050
|
+
* Redirects
|
|
7176
7051
|
*
|
|
7177
7052
|
*
|
|
7053
|
+
* @type {array}
|
|
7178
7054
|
*
|
|
7179
7055
|
*
|
|
7180
7056
|
* @remarks
|
|
7181
|
-
* This key constant provides type-safe access to the `
|
|
7057
|
+
* This key constant provides type-safe access to the `redirects` property of DomainForwardSetCreateRequest objects.
|
|
7182
7058
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
7183
7059
|
*
|
|
7184
7060
|
* @example
|
|
7185
7061
|
* ```typescript
|
|
7186
7062
|
* // Direct property access
|
|
7187
|
-
* const value =
|
|
7063
|
+
* const value = domainforwardsetcreaterequest[KEY_DOMAIN_FORWARD_SET_CREATE_REQUEST_REDIRECTS];
|
|
7188
7064
|
*
|
|
7189
7065
|
* // Dynamic property access
|
|
7190
|
-
* const propertyName =
|
|
7191
|
-
* const value =
|
|
7066
|
+
* const propertyName = KEY_DOMAIN_FORWARD_SET_CREATE_REQUEST_REDIRECTS;
|
|
7067
|
+
* const value = domainforwardsetcreaterequest[propertyName];
|
|
7192
7068
|
* ```
|
|
7193
7069
|
*
|
|
7194
|
-
* @see {@link
|
|
7195
|
-
* @see {@link
|
|
7070
|
+
* @see {@link DomainForwardSetCreateRequest} - The TypeScript type definition
|
|
7071
|
+
* @see {@link KEYS_DOMAIN_FORWARD_SET_CREATE_REQUEST} - Array of all keys for this type
|
|
7196
7072
|
*/
|
|
7197
|
-
export const
|
|
7073
|
+
export const KEY_DOMAIN_FORWARD_SET_CREATE_REQUEST_REDIRECTS: keyof DomainForwardSetCreateRequest = 'redirects';
|
|
7198
7074
|
|
|
7199
7075
|
/**
|
|
7200
|
-
* Array of all
|
|
7076
|
+
* Array of all DomainForwardSetCreateRequest property keys
|
|
7201
7077
|
*
|
|
7202
7078
|
* @remarks
|
|
7203
|
-
* This constant provides a readonly array containing all valid property keys for
|
|
7079
|
+
* This constant provides a readonly array containing all valid property keys for DomainForwardSetCreateRequest objects.
|
|
7204
7080
|
* Useful for iteration, validation, and generating dynamic UI components.
|
|
7205
7081
|
*
|
|
7206
7082
|
* @example
|
|
7207
7083
|
* ```typescript
|
|
7208
7084
|
* // Iterating through all keys
|
|
7209
|
-
* for (const key of
|
|
7210
|
-
* console.log(`Property: ${key}, Value: ${
|
|
7085
|
+
* for (const key of KEYS_DOMAIN_FORWARD_SET_CREATE_REQUEST) {
|
|
7086
|
+
* console.log(`Property: ${key}, Value: ${domainforwardsetcreaterequest[key]}`);
|
|
7211
7087
|
* }
|
|
7212
7088
|
*
|
|
7213
7089
|
* // Validation
|
|
7214
|
-
* const isValidKey =
|
|
7090
|
+
* const isValidKey = KEYS_DOMAIN_FORWARD_SET_CREATE_REQUEST.includes(someKey);
|
|
7215
7091
|
* ```
|
|
7216
7092
|
*
|
|
7217
|
-
* @see {@link
|
|
7093
|
+
* @see {@link DomainForwardSetCreateRequest} - The TypeScript type definition
|
|
7218
7094
|
*/
|
|
7219
|
-
export const
|
|
7220
|
-
|
|
7221
|
-
|
|
7222
|
-
|
|
7223
|
-
KEY_DOMAIN_FORWARD_REQUEST_WILDCARD,
|
|
7224
|
-
] as const satisfies (keyof DomainForwardRequest)[];
|
|
7095
|
+
export const KEYS_DOMAIN_FORWARD_SET_CREATE_REQUEST = [
|
|
7096
|
+
KEY_DOMAIN_FORWARD_SET_CREATE_REQUEST_PROTOCOL,
|
|
7097
|
+
KEY_DOMAIN_FORWARD_SET_CREATE_REQUEST_REDIRECTS,
|
|
7098
|
+
] as const satisfies (keyof DomainForwardSetCreateRequest)[];
|
|
7225
7099
|
|
|
7226
7100
|
/**
|
|
7227
7101
|
* Redirects
|
|
@@ -7397,31 +7271,6 @@ export const KEY_DOMAIN_FORWARD_SET_REDIRECTS: keyof DomainForwardSet = 'redirec
|
|
|
7397
7271
|
* @see {@link KEYS_DOMAIN_FORWARD_SET} - Array of all keys for this type
|
|
7398
7272
|
*/
|
|
7399
7273
|
export const KEY_DOMAIN_FORWARD_SET_UPDATED_ON: keyof DomainForwardSet = 'updated_on';
|
|
7400
|
-
/**
|
|
7401
|
-
* Wildcard
|
|
7402
|
-
*
|
|
7403
|
-
*
|
|
7404
|
-
* @type {boolean}
|
|
7405
|
-
*
|
|
7406
|
-
*
|
|
7407
|
-
* @remarks
|
|
7408
|
-
* This key constant provides type-safe access to the `wildcard` property of DomainForwardSet objects.
|
|
7409
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
7410
|
-
*
|
|
7411
|
-
* @example
|
|
7412
|
-
* ```typescript
|
|
7413
|
-
* // Direct property access
|
|
7414
|
-
* const value = domainforwardset[KEY_DOMAIN_FORWARD_SET_WILDCARD];
|
|
7415
|
-
*
|
|
7416
|
-
* // Dynamic property access
|
|
7417
|
-
* const propertyName = KEY_DOMAIN_FORWARD_SET_WILDCARD;
|
|
7418
|
-
* const value = domainforwardset[propertyName];
|
|
7419
|
-
* ```
|
|
7420
|
-
*
|
|
7421
|
-
* @see {@link DomainForwardSet} - The TypeScript type definition
|
|
7422
|
-
* @see {@link KEYS_DOMAIN_FORWARD_SET} - Array of all keys for this type
|
|
7423
|
-
*/
|
|
7424
|
-
export const KEY_DOMAIN_FORWARD_SET_WILDCARD: keyof DomainForwardSet = 'wildcard';
|
|
7425
7274
|
|
|
7426
7275
|
/**
|
|
7427
7276
|
* Array of all DomainForwardSet property keys
|
|
@@ -7449,7 +7298,6 @@ export const KEYS_DOMAIN_FORWARD_SET = [
|
|
|
7449
7298
|
KEY_DOMAIN_FORWARD_SET_PROTOCOL,
|
|
7450
7299
|
KEY_DOMAIN_FORWARD_SET_REDIRECTS,
|
|
7451
7300
|
KEY_DOMAIN_FORWARD_SET_UPDATED_ON,
|
|
7452
|
-
KEY_DOMAIN_FORWARD_SET_WILDCARD,
|
|
7453
7301
|
] as const satisfies (keyof DomainForwardSet)[];
|
|
7454
7302
|
|
|
7455
7303
|
/**
|
|
@@ -21165,6 +21013,31 @@ export const KEY_USER_EMAIL: keyof User = 'email';
|
|
|
21165
21013
|
* @see {@link KEYS_USER} - Array of all keys for this type
|
|
21166
21014
|
*/
|
|
21167
21015
|
export const KEY_USER_FIRST_NAME: keyof User = 'first_name';
|
|
21016
|
+
/**
|
|
21017
|
+
* Keycloak User Id
|
|
21018
|
+
*
|
|
21019
|
+
* Keycloak user id
|
|
21020
|
+
*
|
|
21021
|
+
*
|
|
21022
|
+
*
|
|
21023
|
+
* @remarks
|
|
21024
|
+
* This key constant provides type-safe access to the `keycloak_user_id` property of User objects.
|
|
21025
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
21026
|
+
*
|
|
21027
|
+
* @example
|
|
21028
|
+
* ```typescript
|
|
21029
|
+
* // Direct property access
|
|
21030
|
+
* const value = user[KEY_USER_KEYCLOAK_USER_ID];
|
|
21031
|
+
*
|
|
21032
|
+
* // Dynamic property access
|
|
21033
|
+
* const propertyName = KEY_USER_KEYCLOAK_USER_ID;
|
|
21034
|
+
* const value = user[propertyName];
|
|
21035
|
+
* ```
|
|
21036
|
+
*
|
|
21037
|
+
* @see {@link User} - The TypeScript type definition
|
|
21038
|
+
* @see {@link KEYS_USER} - Array of all keys for this type
|
|
21039
|
+
*/
|
|
21040
|
+
export const KEY_USER_KEYCLOAK_USER_ID: keyof User = 'keycloak_user_id';
|
|
21168
21041
|
/**
|
|
21169
21042
|
* Last Name
|
|
21170
21043
|
*
|
|
@@ -21394,6 +21267,7 @@ export const KEYS_USER = [
|
|
|
21394
21267
|
KEY_USER_DELETED_ON,
|
|
21395
21268
|
KEY_USER_EMAIL,
|
|
21396
21269
|
KEY_USER_FIRST_NAME,
|
|
21270
|
+
KEY_USER_KEYCLOAK_USER_ID,
|
|
21397
21271
|
KEY_USER_LAST_NAME,
|
|
21398
21272
|
KEY_USER_LOCALE,
|
|
21399
21273
|
KEY_USER_ORGANIZATION_ID,
|
|
@@ -21796,364 +21670,346 @@ export const KEYS_USER_CREATE = [
|
|
|
21796
21670
|
] as const satisfies (keyof UserCreate)[];
|
|
21797
21671
|
|
|
21798
21672
|
/**
|
|
21799
|
-
*
|
|
21673
|
+
* Created On
|
|
21800
21674
|
*
|
|
21675
|
+
* The date/time the entry was created on
|
|
21801
21676
|
*
|
|
21802
21677
|
* @type {string}
|
|
21803
21678
|
*
|
|
21804
21679
|
*
|
|
21805
21680
|
* @remarks
|
|
21806
|
-
* This key constant provides type-safe access to the `
|
|
21681
|
+
* This key constant provides type-safe access to the `created_on` property of UserPublic objects.
|
|
21807
21682
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
21808
21683
|
*
|
|
21809
21684
|
* @example
|
|
21810
21685
|
* ```typescript
|
|
21811
21686
|
* // Direct property access
|
|
21812
|
-
* const value =
|
|
21687
|
+
* const value = userpublic[KEY_USER_PUBLIC_CREATED_ON];
|
|
21813
21688
|
*
|
|
21814
21689
|
* // Dynamic property access
|
|
21815
|
-
* const propertyName =
|
|
21816
|
-
* const value =
|
|
21690
|
+
* const propertyName = KEY_USER_PUBLIC_CREATED_ON;
|
|
21691
|
+
* const value = userpublic[propertyName];
|
|
21817
21692
|
* ```
|
|
21818
21693
|
*
|
|
21819
|
-
* @see {@link
|
|
21820
|
-
* @see {@link
|
|
21694
|
+
* @see {@link UserPublic} - The TypeScript type definition
|
|
21695
|
+
* @see {@link KEYS_USER_PUBLIC} - Array of all keys for this type
|
|
21821
21696
|
*/
|
|
21822
|
-
export const
|
|
21697
|
+
export const KEY_USER_PUBLIC_CREATED_ON: keyof UserPublic = 'created_on';
|
|
21823
21698
|
/**
|
|
21824
|
-
*
|
|
21699
|
+
* Deleted On
|
|
21825
21700
|
*
|
|
21701
|
+
* The date/time the entry was deleted on
|
|
21826
21702
|
*
|
|
21827
|
-
* @type {integer}
|
|
21828
21703
|
*
|
|
21829
21704
|
*
|
|
21830
21705
|
* @remarks
|
|
21831
|
-
* This key constant provides type-safe access to the `
|
|
21706
|
+
* This key constant provides type-safe access to the `deleted_on` property of UserPublic objects.
|
|
21832
21707
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
21833
21708
|
*
|
|
21834
21709
|
* @example
|
|
21835
21710
|
* ```typescript
|
|
21836
21711
|
* // Direct property access
|
|
21837
|
-
* const value =
|
|
21712
|
+
* const value = userpublic[KEY_USER_PUBLIC_DELETED_ON];
|
|
21838
21713
|
*
|
|
21839
21714
|
* // Dynamic property access
|
|
21840
|
-
* const propertyName =
|
|
21841
|
-
* const value =
|
|
21715
|
+
* const propertyName = KEY_USER_PUBLIC_DELETED_ON;
|
|
21716
|
+
* const value = userpublic[propertyName];
|
|
21842
21717
|
* ```
|
|
21843
21718
|
*
|
|
21844
|
-
* @see {@link
|
|
21845
|
-
* @see {@link
|
|
21719
|
+
* @see {@link UserPublic} - The TypeScript type definition
|
|
21720
|
+
* @see {@link KEYS_USER_PUBLIC} - Array of all keys for this type
|
|
21846
21721
|
*/
|
|
21847
|
-
export const
|
|
21722
|
+
export const KEY_USER_PUBLIC_DELETED_ON: keyof UserPublic = 'deleted_on';
|
|
21848
21723
|
/**
|
|
21849
|
-
*
|
|
21724
|
+
* Email
|
|
21850
21725
|
*
|
|
21726
|
+
* The user's email address
|
|
21851
21727
|
*
|
|
21852
|
-
* @type {
|
|
21728
|
+
* @type {string}
|
|
21853
21729
|
*
|
|
21854
21730
|
*
|
|
21855
21731
|
* @remarks
|
|
21856
|
-
* This key constant provides type-safe access to the `
|
|
21732
|
+
* This key constant provides type-safe access to the `email` property of UserPublic objects.
|
|
21857
21733
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
21858
21734
|
*
|
|
21859
21735
|
* @example
|
|
21860
21736
|
* ```typescript
|
|
21861
21737
|
* // Direct property access
|
|
21862
|
-
* const value =
|
|
21738
|
+
* const value = userpublic[KEY_USER_PUBLIC_EMAIL];
|
|
21863
21739
|
*
|
|
21864
21740
|
* // Dynamic property access
|
|
21865
|
-
* const propertyName =
|
|
21866
|
-
* const value =
|
|
21741
|
+
* const propertyName = KEY_USER_PUBLIC_EMAIL;
|
|
21742
|
+
* const value = userpublic[propertyName];
|
|
21867
21743
|
* ```
|
|
21868
21744
|
*
|
|
21869
|
-
* @see {@link
|
|
21870
|
-
* @see {@link
|
|
21745
|
+
* @see {@link UserPublic} - The TypeScript type definition
|
|
21746
|
+
* @see {@link KEYS_USER_PUBLIC} - Array of all keys for this type
|
|
21871
21747
|
*/
|
|
21872
|
-
export const
|
|
21748
|
+
export const KEY_USER_PUBLIC_EMAIL: keyof UserPublic = 'email';
|
|
21873
21749
|
/**
|
|
21874
|
-
*
|
|
21750
|
+
* First Name
|
|
21875
21751
|
*
|
|
21752
|
+
* The user's first name
|
|
21876
21753
|
*
|
|
21877
21754
|
* @type {string}
|
|
21878
21755
|
*
|
|
21879
21756
|
*
|
|
21880
21757
|
* @remarks
|
|
21881
|
-
* This key constant provides type-safe access to the `
|
|
21758
|
+
* This key constant provides type-safe access to the `first_name` property of UserPublic objects.
|
|
21882
21759
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
21883
21760
|
*
|
|
21884
21761
|
* @example
|
|
21885
21762
|
* ```typescript
|
|
21886
21763
|
* // Direct property access
|
|
21887
|
-
* const value =
|
|
21764
|
+
* const value = userpublic[KEY_USER_PUBLIC_FIRST_NAME];
|
|
21888
21765
|
*
|
|
21889
21766
|
* // Dynamic property access
|
|
21890
|
-
* const propertyName =
|
|
21891
|
-
* const value =
|
|
21767
|
+
* const propertyName = KEY_USER_PUBLIC_FIRST_NAME;
|
|
21768
|
+
* const value = userpublic[propertyName];
|
|
21892
21769
|
* ```
|
|
21893
21770
|
*
|
|
21894
|
-
* @see {@link
|
|
21895
|
-
* @see {@link
|
|
21771
|
+
* @see {@link UserPublic} - The TypeScript type definition
|
|
21772
|
+
* @see {@link KEYS_USER_PUBLIC} - Array of all keys for this type
|
|
21896
21773
|
*/
|
|
21897
|
-
export const
|
|
21774
|
+
export const KEY_USER_PUBLIC_FIRST_NAME: keyof UserPublic = 'first_name';
|
|
21898
21775
|
/**
|
|
21899
|
-
*
|
|
21776
|
+
* Last Name
|
|
21900
21777
|
*
|
|
21778
|
+
* The user's last name
|
|
21901
21779
|
*
|
|
21902
21780
|
* @type {string}
|
|
21903
21781
|
*
|
|
21904
21782
|
*
|
|
21905
21783
|
* @remarks
|
|
21906
|
-
* This key constant provides type-safe access to the `
|
|
21784
|
+
* This key constant provides type-safe access to the `last_name` property of UserPublic objects.
|
|
21907
21785
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
21908
21786
|
*
|
|
21909
21787
|
* @example
|
|
21910
21788
|
* ```typescript
|
|
21911
21789
|
* // Direct property access
|
|
21912
|
-
* const value =
|
|
21790
|
+
* const value = userpublic[KEY_USER_PUBLIC_LAST_NAME];
|
|
21913
21791
|
*
|
|
21914
21792
|
* // Dynamic property access
|
|
21915
|
-
* const propertyName =
|
|
21916
|
-
* const value =
|
|
21793
|
+
* const propertyName = KEY_USER_PUBLIC_LAST_NAME;
|
|
21794
|
+
* const value = userpublic[propertyName];
|
|
21917
21795
|
* ```
|
|
21918
21796
|
*
|
|
21919
|
-
* @see {@link
|
|
21920
|
-
* @see {@link
|
|
21797
|
+
* @see {@link UserPublic} - The TypeScript type definition
|
|
21798
|
+
* @see {@link KEYS_USER_PUBLIC} - Array of all keys for this type
|
|
21921
21799
|
*/
|
|
21922
|
-
export const
|
|
21923
|
-
|
|
21800
|
+
export const KEY_USER_PUBLIC_LAST_NAME: keyof UserPublic = 'last_name';
|
|
21924
21801
|
/**
|
|
21925
|
-
*
|
|
21802
|
+
* Locale
|
|
21803
|
+
*
|
|
21804
|
+
*
|
|
21805
|
+
* @type {string}
|
|
21806
|
+
*
|
|
21926
21807
|
*
|
|
21927
21808
|
* @remarks
|
|
21928
|
-
* This constant provides
|
|
21929
|
-
*
|
|
21809
|
+
* This key constant provides type-safe access to the `locale` property of UserPublic objects.
|
|
21810
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
21930
21811
|
*
|
|
21931
21812
|
* @example
|
|
21932
21813
|
* ```typescript
|
|
21933
|
-
* //
|
|
21934
|
-
*
|
|
21935
|
-
* console.log(`Property: ${key}, Value: ${usertoken[key]}`);
|
|
21936
|
-
* }
|
|
21814
|
+
* // Direct property access
|
|
21815
|
+
* const value = userpublic[KEY_USER_PUBLIC_LOCALE];
|
|
21937
21816
|
*
|
|
21938
|
-
* //
|
|
21939
|
-
* const
|
|
21817
|
+
* // Dynamic property access
|
|
21818
|
+
* const propertyName = KEY_USER_PUBLIC_LOCALE;
|
|
21819
|
+
* const value = userpublic[propertyName];
|
|
21940
21820
|
* ```
|
|
21941
21821
|
*
|
|
21942
|
-
* @see {@link
|
|
21822
|
+
* @see {@link UserPublic} - The TypeScript type definition
|
|
21823
|
+
* @see {@link KEYS_USER_PUBLIC} - Array of all keys for this type
|
|
21943
21824
|
*/
|
|
21944
|
-
export const
|
|
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
|
-
|
|
21825
|
+
export const KEY_USER_PUBLIC_LOCALE: keyof UserPublic = 'locale';
|
|
21952
21826
|
/**
|
|
21953
|
-
*
|
|
21827
|
+
* Organization Id
|
|
21954
21828
|
*
|
|
21955
|
-
* The user's
|
|
21829
|
+
* The user's organization id
|
|
21956
21830
|
*
|
|
21831
|
+
* @type {string}
|
|
21957
21832
|
*
|
|
21958
21833
|
*
|
|
21959
21834
|
* @remarks
|
|
21960
|
-
* This key constant provides type-safe access to the `
|
|
21835
|
+
* This key constant provides type-safe access to the `organization_id` property of UserPublic objects.
|
|
21961
21836
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
21962
21837
|
*
|
|
21963
21838
|
* @example
|
|
21964
21839
|
* ```typescript
|
|
21965
21840
|
* // Direct property access
|
|
21966
|
-
* const value =
|
|
21841
|
+
* const value = userpublic[KEY_USER_PUBLIC_ORGANIZATION_ID];
|
|
21967
21842
|
*
|
|
21968
21843
|
* // Dynamic property access
|
|
21969
|
-
* const propertyName =
|
|
21970
|
-
* const value =
|
|
21844
|
+
* const propertyName = KEY_USER_PUBLIC_ORGANIZATION_ID;
|
|
21845
|
+
* const value = userpublic[propertyName];
|
|
21971
21846
|
* ```
|
|
21972
21847
|
*
|
|
21973
|
-
* @see {@link
|
|
21974
|
-
* @see {@link
|
|
21848
|
+
* @see {@link UserPublic} - The TypeScript type definition
|
|
21849
|
+
* @see {@link KEYS_USER_PUBLIC} - Array of all keys for this type
|
|
21975
21850
|
*/
|
|
21976
|
-
export const
|
|
21851
|
+
export const KEY_USER_PUBLIC_ORGANIZATION_ID: keyof UserPublic = 'organization_id';
|
|
21977
21852
|
/**
|
|
21978
|
-
*
|
|
21853
|
+
* Phone
|
|
21979
21854
|
*
|
|
21980
|
-
* The user's
|
|
21855
|
+
* The user's phone number
|
|
21981
21856
|
*
|
|
21982
21857
|
*
|
|
21983
21858
|
*
|
|
21984
21859
|
* @remarks
|
|
21985
|
-
* This key constant provides type-safe access to the `
|
|
21860
|
+
* This key constant provides type-safe access to the `phone` property of UserPublic objects.
|
|
21986
21861
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
21987
21862
|
*
|
|
21988
21863
|
* @example
|
|
21989
21864
|
* ```typescript
|
|
21990
21865
|
* // Direct property access
|
|
21991
|
-
* const value =
|
|
21866
|
+
* const value = userpublic[KEY_USER_PUBLIC_PHONE];
|
|
21992
21867
|
*
|
|
21993
21868
|
* // Dynamic property access
|
|
21994
|
-
* const propertyName =
|
|
21995
|
-
* const value =
|
|
21869
|
+
* const propertyName = KEY_USER_PUBLIC_PHONE;
|
|
21870
|
+
* const value = userpublic[propertyName];
|
|
21996
21871
|
* ```
|
|
21997
21872
|
*
|
|
21998
|
-
* @see {@link
|
|
21999
|
-
* @see {@link
|
|
21873
|
+
* @see {@link UserPublic} - The TypeScript type definition
|
|
21874
|
+
* @see {@link KEYS_USER_PUBLIC} - Array of all keys for this type
|
|
22000
21875
|
*/
|
|
22001
|
-
export const
|
|
21876
|
+
export const KEY_USER_PUBLIC_PHONE: keyof UserPublic = 'phone';
|
|
22002
21877
|
/**
|
|
22003
|
-
*
|
|
21878
|
+
* status property
|
|
22004
21879
|
*
|
|
22005
|
-
* The user's last name
|
|
22006
21880
|
*
|
|
22007
21881
|
*
|
|
22008
21882
|
*
|
|
22009
21883
|
* @remarks
|
|
22010
|
-
* This key constant provides type-safe access to the `
|
|
21884
|
+
* This key constant provides type-safe access to the `status` property of UserPublic objects.
|
|
22011
21885
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22012
21886
|
*
|
|
22013
21887
|
* @example
|
|
22014
21888
|
* ```typescript
|
|
22015
21889
|
* // Direct property access
|
|
22016
|
-
* const value =
|
|
21890
|
+
* const value = userpublic[KEY_USER_PUBLIC_STATUS];
|
|
22017
21891
|
*
|
|
22018
21892
|
* // Dynamic property access
|
|
22019
|
-
* const propertyName =
|
|
22020
|
-
* const value =
|
|
21893
|
+
* const propertyName = KEY_USER_PUBLIC_STATUS;
|
|
21894
|
+
* const value = userpublic[propertyName];
|
|
22021
21895
|
* ```
|
|
22022
21896
|
*
|
|
22023
|
-
* @see {@link
|
|
22024
|
-
* @see {@link
|
|
21897
|
+
* @see {@link UserPublic} - The TypeScript type definition
|
|
21898
|
+
* @see {@link KEYS_USER_PUBLIC} - Array of all keys for this type
|
|
22025
21899
|
*/
|
|
22026
|
-
export const
|
|
21900
|
+
export const KEY_USER_PUBLIC_STATUS: keyof UserPublic = 'status';
|
|
22027
21901
|
/**
|
|
22028
|
-
*
|
|
21902
|
+
* Updated On
|
|
22029
21903
|
*
|
|
22030
|
-
* The
|
|
21904
|
+
* The date/time the entry was last updated on
|
|
22031
21905
|
*
|
|
21906
|
+
* @type {string}
|
|
22032
21907
|
*
|
|
22033
21908
|
*
|
|
22034
21909
|
* @remarks
|
|
22035
|
-
* This key constant provides type-safe access to the `
|
|
21910
|
+
* This key constant provides type-safe access to the `updated_on` property of UserPublic objects.
|
|
22036
21911
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22037
21912
|
*
|
|
22038
21913
|
* @example
|
|
22039
21914
|
* ```typescript
|
|
22040
21915
|
* // Direct property access
|
|
22041
|
-
* const value =
|
|
21916
|
+
* const value = userpublic[KEY_USER_PUBLIC_UPDATED_ON];
|
|
22042
21917
|
*
|
|
22043
21918
|
* // Dynamic property access
|
|
22044
|
-
* const propertyName =
|
|
22045
|
-
* const value =
|
|
22046
|
-
* ```
|
|
22047
|
-
*
|
|
22048
|
-
* @see {@link UserUpdate} - The TypeScript type definition
|
|
22049
|
-
* @see {@link KEYS_USER_UPDATE} - Array of all keys for this type
|
|
22050
|
-
*/
|
|
22051
|
-
export const KEY_USER_UPDATE_LOCALE: keyof UserUpdate = 'locale';
|
|
22052
|
-
/**
|
|
22053
|
-
* Phone
|
|
22054
|
-
*
|
|
22055
|
-
* The user's phone number
|
|
22056
|
-
*
|
|
22057
|
-
*
|
|
22058
|
-
*
|
|
22059
|
-
* @remarks
|
|
22060
|
-
* This key constant provides type-safe access to the `phone` property of UserUpdate objects.
|
|
22061
|
-
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22062
|
-
*
|
|
22063
|
-
* @example
|
|
22064
|
-
* ```typescript
|
|
22065
|
-
* // Direct property access
|
|
22066
|
-
* const value = userupdate[KEY_USER_UPDATE_PHONE];
|
|
22067
|
-
*
|
|
22068
|
-
* // Dynamic property access
|
|
22069
|
-
* const propertyName = KEY_USER_UPDATE_PHONE;
|
|
22070
|
-
* const value = userupdate[propertyName];
|
|
21919
|
+
* const propertyName = KEY_USER_PUBLIC_UPDATED_ON;
|
|
21920
|
+
* const value = userpublic[propertyName];
|
|
22071
21921
|
* ```
|
|
22072
21922
|
*
|
|
22073
|
-
* @see {@link
|
|
22074
|
-
* @see {@link
|
|
21923
|
+
* @see {@link UserPublic} - The TypeScript type definition
|
|
21924
|
+
* @see {@link KEYS_USER_PUBLIC} - Array of all keys for this type
|
|
22075
21925
|
*/
|
|
22076
|
-
export const
|
|
21926
|
+
export const KEY_USER_PUBLIC_UPDATED_ON: keyof UserPublic = 'updated_on';
|
|
22077
21927
|
/**
|
|
22078
|
-
* User
|
|
21928
|
+
* User Id
|
|
22079
21929
|
*
|
|
22080
|
-
* User attributes
|
|
22081
21930
|
*
|
|
21931
|
+
* @type {string}
|
|
22082
21932
|
*
|
|
22083
21933
|
*
|
|
22084
21934
|
* @remarks
|
|
22085
|
-
* This key constant provides type-safe access to the `
|
|
21935
|
+
* This key constant provides type-safe access to the `user_id` property of UserPublic objects.
|
|
22086
21936
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22087
21937
|
*
|
|
22088
21938
|
* @example
|
|
22089
21939
|
* ```typescript
|
|
22090
21940
|
* // Direct property access
|
|
22091
|
-
* const value =
|
|
21941
|
+
* const value = userpublic[KEY_USER_PUBLIC_USER_ID];
|
|
22092
21942
|
*
|
|
22093
21943
|
* // Dynamic property access
|
|
22094
|
-
* const propertyName =
|
|
22095
|
-
* const value =
|
|
21944
|
+
* const propertyName = KEY_USER_PUBLIC_USER_ID;
|
|
21945
|
+
* const value = userpublic[propertyName];
|
|
22096
21946
|
* ```
|
|
22097
21947
|
*
|
|
22098
|
-
* @see {@link
|
|
22099
|
-
* @see {@link
|
|
21948
|
+
* @see {@link UserPublic} - The TypeScript type definition
|
|
21949
|
+
* @see {@link KEYS_USER_PUBLIC} - Array of all keys for this type
|
|
22100
21950
|
*/
|
|
22101
|
-
export const
|
|
21951
|
+
export const KEY_USER_PUBLIC_USER_ID: keyof UserPublic = 'user_id';
|
|
22102
21952
|
/**
|
|
22103
21953
|
* Username
|
|
22104
21954
|
*
|
|
22105
21955
|
* The user's unique username
|
|
22106
21956
|
*
|
|
21957
|
+
* @type {string}
|
|
22107
21958
|
*
|
|
22108
21959
|
*
|
|
22109
21960
|
* @remarks
|
|
22110
|
-
* This key constant provides type-safe access to the `username` property of
|
|
21961
|
+
* This key constant provides type-safe access to the `username` property of UserPublic objects.
|
|
22111
21962
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22112
21963
|
*
|
|
22113
21964
|
* @example
|
|
22114
21965
|
* ```typescript
|
|
22115
21966
|
* // Direct property access
|
|
22116
|
-
* const value =
|
|
21967
|
+
* const value = userpublic[KEY_USER_PUBLIC_USERNAME];
|
|
22117
21968
|
*
|
|
22118
21969
|
* // Dynamic property access
|
|
22119
|
-
* const propertyName =
|
|
22120
|
-
* const value =
|
|
21970
|
+
* const propertyName = KEY_USER_PUBLIC_USERNAME;
|
|
21971
|
+
* const value = userpublic[propertyName];
|
|
22121
21972
|
* ```
|
|
22122
21973
|
*
|
|
22123
|
-
* @see {@link
|
|
22124
|
-
* @see {@link
|
|
21974
|
+
* @see {@link UserPublic} - The TypeScript type definition
|
|
21975
|
+
* @see {@link KEYS_USER_PUBLIC} - Array of all keys for this type
|
|
22125
21976
|
*/
|
|
22126
|
-
export const
|
|
21977
|
+
export const KEY_USER_PUBLIC_USERNAME: keyof UserPublic = 'username';
|
|
22127
21978
|
|
|
22128
21979
|
/**
|
|
22129
|
-
* Array of all
|
|
21980
|
+
* Array of all UserPublic property keys
|
|
22130
21981
|
*
|
|
22131
21982
|
* @remarks
|
|
22132
|
-
* This constant provides a readonly array containing all valid property keys for
|
|
21983
|
+
* This constant provides a readonly array containing all valid property keys for UserPublic objects.
|
|
22133
21984
|
* Useful for iteration, validation, and generating dynamic UI components.
|
|
22134
21985
|
*
|
|
22135
21986
|
* @example
|
|
22136
21987
|
* ```typescript
|
|
22137
21988
|
* // Iterating through all keys
|
|
22138
|
-
* for (const key of
|
|
22139
|
-
* console.log(`Property: ${key}, Value: ${
|
|
21989
|
+
* for (const key of KEYS_USER_PUBLIC) {
|
|
21990
|
+
* console.log(`Property: ${key}, Value: ${userpublic[key]}`);
|
|
22140
21991
|
* }
|
|
22141
21992
|
*
|
|
22142
21993
|
* // Validation
|
|
22143
|
-
* const isValidKey =
|
|
21994
|
+
* const isValidKey = KEYS_USER_PUBLIC.includes(someKey);
|
|
22144
21995
|
* ```
|
|
22145
21996
|
*
|
|
22146
|
-
* @see {@link
|
|
21997
|
+
* @see {@link UserPublic} - The TypeScript type definition
|
|
22147
21998
|
*/
|
|
22148
|
-
export const
|
|
22149
|
-
|
|
22150
|
-
|
|
22151
|
-
|
|
22152
|
-
|
|
22153
|
-
|
|
22154
|
-
|
|
22155
|
-
|
|
22156
|
-
|
|
21999
|
+
export const KEYS_USER_PUBLIC = [
|
|
22000
|
+
KEY_USER_PUBLIC_CREATED_ON,
|
|
22001
|
+
KEY_USER_PUBLIC_DELETED_ON,
|
|
22002
|
+
KEY_USER_PUBLIC_EMAIL,
|
|
22003
|
+
KEY_USER_PUBLIC_FIRST_NAME,
|
|
22004
|
+
KEY_USER_PUBLIC_LAST_NAME,
|
|
22005
|
+
KEY_USER_PUBLIC_LOCALE,
|
|
22006
|
+
KEY_USER_PUBLIC_ORGANIZATION_ID,
|
|
22007
|
+
KEY_USER_PUBLIC_PHONE,
|
|
22008
|
+
KEY_USER_PUBLIC_STATUS,
|
|
22009
|
+
KEY_USER_PUBLIC_UPDATED_ON,
|
|
22010
|
+
KEY_USER_PUBLIC_USER_ID,
|
|
22011
|
+
KEY_USER_PUBLIC_USERNAME,
|
|
22012
|
+
] as const satisfies (keyof UserPublic)[];
|
|
22157
22013
|
|
|
22158
22014
|
/**
|
|
22159
22015
|
* Created On
|
|
@@ -22164,23 +22020,23 @@ export const KEYS_USER_UPDATE = [
|
|
|
22164
22020
|
*
|
|
22165
22021
|
*
|
|
22166
22022
|
* @remarks
|
|
22167
|
-
* This key constant provides type-safe access to the `created_on` property of
|
|
22023
|
+
* This key constant provides type-safe access to the `created_on` property of UserPublicWithAttributes objects.
|
|
22168
22024
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22169
22025
|
*
|
|
22170
22026
|
* @example
|
|
22171
22027
|
* ```typescript
|
|
22172
22028
|
* // Direct property access
|
|
22173
|
-
* const value =
|
|
22029
|
+
* const value = userpublicwithattributes[KEY_USER_PUBLIC_WITH_ATTRIBUTES_CREATED_ON];
|
|
22174
22030
|
*
|
|
22175
22031
|
* // Dynamic property access
|
|
22176
|
-
* const propertyName =
|
|
22177
|
-
* const value =
|
|
22032
|
+
* const propertyName = KEY_USER_PUBLIC_WITH_ATTRIBUTES_CREATED_ON;
|
|
22033
|
+
* const value = userpublicwithattributes[propertyName];
|
|
22178
22034
|
* ```
|
|
22179
22035
|
*
|
|
22180
|
-
* @see {@link
|
|
22181
|
-
* @see {@link
|
|
22036
|
+
* @see {@link UserPublicWithAttributes} - The TypeScript type definition
|
|
22037
|
+
* @see {@link KEYS_USER_PUBLIC_WITH_ATTRIBUTES} - Array of all keys for this type
|
|
22182
22038
|
*/
|
|
22183
|
-
export const
|
|
22039
|
+
export const KEY_USER_PUBLIC_WITH_ATTRIBUTES_CREATED_ON: keyof UserPublicWithAttributes = 'created_on';
|
|
22184
22040
|
/**
|
|
22185
22041
|
* Deleted On
|
|
22186
22042
|
*
|
|
@@ -22189,23 +22045,23 @@ export const KEY_USER_WITH_ATTRIBUTES_CREATED_ON: keyof UserWithAttributes = 'cr
|
|
|
22189
22045
|
*
|
|
22190
22046
|
*
|
|
22191
22047
|
* @remarks
|
|
22192
|
-
* This key constant provides type-safe access to the `deleted_on` property of
|
|
22048
|
+
* This key constant provides type-safe access to the `deleted_on` property of UserPublicWithAttributes objects.
|
|
22193
22049
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22194
22050
|
*
|
|
22195
22051
|
* @example
|
|
22196
22052
|
* ```typescript
|
|
22197
22053
|
* // Direct property access
|
|
22198
|
-
* const value =
|
|
22054
|
+
* const value = userpublicwithattributes[KEY_USER_PUBLIC_WITH_ATTRIBUTES_DELETED_ON];
|
|
22199
22055
|
*
|
|
22200
22056
|
* // Dynamic property access
|
|
22201
|
-
* const propertyName =
|
|
22202
|
-
* const value =
|
|
22057
|
+
* const propertyName = KEY_USER_PUBLIC_WITH_ATTRIBUTES_DELETED_ON;
|
|
22058
|
+
* const value = userpublicwithattributes[propertyName];
|
|
22203
22059
|
* ```
|
|
22204
22060
|
*
|
|
22205
|
-
* @see {@link
|
|
22206
|
-
* @see {@link
|
|
22061
|
+
* @see {@link UserPublicWithAttributes} - The TypeScript type definition
|
|
22062
|
+
* @see {@link KEYS_USER_PUBLIC_WITH_ATTRIBUTES} - Array of all keys for this type
|
|
22207
22063
|
*/
|
|
22208
|
-
export const
|
|
22064
|
+
export const KEY_USER_PUBLIC_WITH_ATTRIBUTES_DELETED_ON: keyof UserPublicWithAttributes = 'deleted_on';
|
|
22209
22065
|
/**
|
|
22210
22066
|
* Email
|
|
22211
22067
|
*
|
|
@@ -22215,23 +22071,23 @@ export const KEY_USER_WITH_ATTRIBUTES_DELETED_ON: keyof UserWithAttributes = 'de
|
|
|
22215
22071
|
*
|
|
22216
22072
|
*
|
|
22217
22073
|
* @remarks
|
|
22218
|
-
* This key constant provides type-safe access to the `email` property of
|
|
22074
|
+
* This key constant provides type-safe access to the `email` property of UserPublicWithAttributes objects.
|
|
22219
22075
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22220
22076
|
*
|
|
22221
22077
|
* @example
|
|
22222
22078
|
* ```typescript
|
|
22223
22079
|
* // Direct property access
|
|
22224
|
-
* const value =
|
|
22080
|
+
* const value = userpublicwithattributes[KEY_USER_PUBLIC_WITH_ATTRIBUTES_EMAIL];
|
|
22225
22081
|
*
|
|
22226
22082
|
* // Dynamic property access
|
|
22227
|
-
* const propertyName =
|
|
22228
|
-
* const value =
|
|
22083
|
+
* const propertyName = KEY_USER_PUBLIC_WITH_ATTRIBUTES_EMAIL;
|
|
22084
|
+
* const value = userpublicwithattributes[propertyName];
|
|
22229
22085
|
* ```
|
|
22230
22086
|
*
|
|
22231
|
-
* @see {@link
|
|
22232
|
-
* @see {@link
|
|
22087
|
+
* @see {@link UserPublicWithAttributes} - The TypeScript type definition
|
|
22088
|
+
* @see {@link KEYS_USER_PUBLIC_WITH_ATTRIBUTES} - Array of all keys for this type
|
|
22233
22089
|
*/
|
|
22234
|
-
export const
|
|
22090
|
+
export const KEY_USER_PUBLIC_WITH_ATTRIBUTES_EMAIL: keyof UserPublicWithAttributes = 'email';
|
|
22235
22091
|
/**
|
|
22236
22092
|
* First Name
|
|
22237
22093
|
*
|
|
@@ -22241,23 +22097,23 @@ export const KEY_USER_WITH_ATTRIBUTES_EMAIL: keyof UserWithAttributes = 'email';
|
|
|
22241
22097
|
*
|
|
22242
22098
|
*
|
|
22243
22099
|
* @remarks
|
|
22244
|
-
* This key constant provides type-safe access to the `first_name` property of
|
|
22100
|
+
* This key constant provides type-safe access to the `first_name` property of UserPublicWithAttributes objects.
|
|
22245
22101
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22246
22102
|
*
|
|
22247
22103
|
* @example
|
|
22248
22104
|
* ```typescript
|
|
22249
22105
|
* // Direct property access
|
|
22250
|
-
* const value =
|
|
22106
|
+
* const value = userpublicwithattributes[KEY_USER_PUBLIC_WITH_ATTRIBUTES_FIRST_NAME];
|
|
22251
22107
|
*
|
|
22252
22108
|
* // Dynamic property access
|
|
22253
|
-
* const propertyName =
|
|
22254
|
-
* const value =
|
|
22109
|
+
* const propertyName = KEY_USER_PUBLIC_WITH_ATTRIBUTES_FIRST_NAME;
|
|
22110
|
+
* const value = userpublicwithattributes[propertyName];
|
|
22255
22111
|
* ```
|
|
22256
22112
|
*
|
|
22257
|
-
* @see {@link
|
|
22258
|
-
* @see {@link
|
|
22113
|
+
* @see {@link UserPublicWithAttributes} - The TypeScript type definition
|
|
22114
|
+
* @see {@link KEYS_USER_PUBLIC_WITH_ATTRIBUTES} - Array of all keys for this type
|
|
22259
22115
|
*/
|
|
22260
|
-
export const
|
|
22116
|
+
export const KEY_USER_PUBLIC_WITH_ATTRIBUTES_FIRST_NAME: keyof UserPublicWithAttributes = 'first_name';
|
|
22261
22117
|
/**
|
|
22262
22118
|
* Last Name
|
|
22263
22119
|
*
|
|
@@ -22267,23 +22123,23 @@ export const KEY_USER_WITH_ATTRIBUTES_FIRST_NAME: keyof UserWithAttributes = 'fi
|
|
|
22267
22123
|
*
|
|
22268
22124
|
*
|
|
22269
22125
|
* @remarks
|
|
22270
|
-
* This key constant provides type-safe access to the `last_name` property of
|
|
22126
|
+
* This key constant provides type-safe access to the `last_name` property of UserPublicWithAttributes objects.
|
|
22271
22127
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22272
22128
|
*
|
|
22273
22129
|
* @example
|
|
22274
22130
|
* ```typescript
|
|
22275
22131
|
* // Direct property access
|
|
22276
|
-
* const value =
|
|
22132
|
+
* const value = userpublicwithattributes[KEY_USER_PUBLIC_WITH_ATTRIBUTES_LAST_NAME];
|
|
22277
22133
|
*
|
|
22278
22134
|
* // Dynamic property access
|
|
22279
|
-
* const propertyName =
|
|
22280
|
-
* const value =
|
|
22135
|
+
* const propertyName = KEY_USER_PUBLIC_WITH_ATTRIBUTES_LAST_NAME;
|
|
22136
|
+
* const value = userpublicwithattributes[propertyName];
|
|
22281
22137
|
* ```
|
|
22282
22138
|
*
|
|
22283
|
-
* @see {@link
|
|
22284
|
-
* @see {@link
|
|
22139
|
+
* @see {@link UserPublicWithAttributes} - The TypeScript type definition
|
|
22140
|
+
* @see {@link KEYS_USER_PUBLIC_WITH_ATTRIBUTES} - Array of all keys for this type
|
|
22285
22141
|
*/
|
|
22286
|
-
export const
|
|
22142
|
+
export const KEY_USER_PUBLIC_WITH_ATTRIBUTES_LAST_NAME: keyof UserPublicWithAttributes = 'last_name';
|
|
22287
22143
|
/**
|
|
22288
22144
|
* Locale
|
|
22289
22145
|
*
|
|
@@ -22292,23 +22148,23 @@ export const KEY_USER_WITH_ATTRIBUTES_LAST_NAME: keyof UserWithAttributes = 'las
|
|
|
22292
22148
|
*
|
|
22293
22149
|
*
|
|
22294
22150
|
* @remarks
|
|
22295
|
-
* This key constant provides type-safe access to the `locale` property of
|
|
22151
|
+
* This key constant provides type-safe access to the `locale` property of UserPublicWithAttributes objects.
|
|
22296
22152
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22297
22153
|
*
|
|
22298
22154
|
* @example
|
|
22299
22155
|
* ```typescript
|
|
22300
22156
|
* // Direct property access
|
|
22301
|
-
* const value =
|
|
22157
|
+
* const value = userpublicwithattributes[KEY_USER_PUBLIC_WITH_ATTRIBUTES_LOCALE];
|
|
22302
22158
|
*
|
|
22303
22159
|
* // Dynamic property access
|
|
22304
|
-
* const propertyName =
|
|
22305
|
-
* const value =
|
|
22160
|
+
* const propertyName = KEY_USER_PUBLIC_WITH_ATTRIBUTES_LOCALE;
|
|
22161
|
+
* const value = userpublicwithattributes[propertyName];
|
|
22306
22162
|
* ```
|
|
22307
22163
|
*
|
|
22308
|
-
* @see {@link
|
|
22309
|
-
* @see {@link
|
|
22164
|
+
* @see {@link UserPublicWithAttributes} - The TypeScript type definition
|
|
22165
|
+
* @see {@link KEYS_USER_PUBLIC_WITH_ATTRIBUTES} - Array of all keys for this type
|
|
22310
22166
|
*/
|
|
22311
|
-
export const
|
|
22167
|
+
export const KEY_USER_PUBLIC_WITH_ATTRIBUTES_LOCALE: keyof UserPublicWithAttributes = 'locale';
|
|
22312
22168
|
/**
|
|
22313
22169
|
* Organization Id
|
|
22314
22170
|
*
|
|
@@ -22318,23 +22174,23 @@ export const KEY_USER_WITH_ATTRIBUTES_LOCALE: keyof UserWithAttributes = 'locale
|
|
|
22318
22174
|
*
|
|
22319
22175
|
*
|
|
22320
22176
|
* @remarks
|
|
22321
|
-
* This key constant provides type-safe access to the `organization_id` property of
|
|
22177
|
+
* This key constant provides type-safe access to the `organization_id` property of UserPublicWithAttributes objects.
|
|
22322
22178
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22323
22179
|
*
|
|
22324
22180
|
* @example
|
|
22325
22181
|
* ```typescript
|
|
22326
22182
|
* // Direct property access
|
|
22327
|
-
* const value =
|
|
22183
|
+
* const value = userpublicwithattributes[KEY_USER_PUBLIC_WITH_ATTRIBUTES_ORGANIZATION_ID];
|
|
22328
22184
|
*
|
|
22329
22185
|
* // Dynamic property access
|
|
22330
|
-
* const propertyName =
|
|
22331
|
-
* const value =
|
|
22186
|
+
* const propertyName = KEY_USER_PUBLIC_WITH_ATTRIBUTES_ORGANIZATION_ID;
|
|
22187
|
+
* const value = userpublicwithattributes[propertyName];
|
|
22332
22188
|
* ```
|
|
22333
22189
|
*
|
|
22334
|
-
* @see {@link
|
|
22335
|
-
* @see {@link
|
|
22190
|
+
* @see {@link UserPublicWithAttributes} - The TypeScript type definition
|
|
22191
|
+
* @see {@link KEYS_USER_PUBLIC_WITH_ATTRIBUTES} - Array of all keys for this type
|
|
22336
22192
|
*/
|
|
22337
|
-
export const
|
|
22193
|
+
export const KEY_USER_PUBLIC_WITH_ATTRIBUTES_ORGANIZATION_ID: keyof UserPublicWithAttributes = 'organization_id';
|
|
22338
22194
|
/**
|
|
22339
22195
|
* Phone
|
|
22340
22196
|
*
|
|
@@ -22343,23 +22199,23 @@ export const KEY_USER_WITH_ATTRIBUTES_ORGANIZATION_ID: keyof UserWithAttributes
|
|
|
22343
22199
|
*
|
|
22344
22200
|
*
|
|
22345
22201
|
* @remarks
|
|
22346
|
-
* This key constant provides type-safe access to the `phone` property of
|
|
22202
|
+
* This key constant provides type-safe access to the `phone` property of UserPublicWithAttributes objects.
|
|
22347
22203
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22348
22204
|
*
|
|
22349
22205
|
* @example
|
|
22350
22206
|
* ```typescript
|
|
22351
22207
|
* // Direct property access
|
|
22352
|
-
* const value =
|
|
22208
|
+
* const value = userpublicwithattributes[KEY_USER_PUBLIC_WITH_ATTRIBUTES_PHONE];
|
|
22353
22209
|
*
|
|
22354
22210
|
* // Dynamic property access
|
|
22355
|
-
* const propertyName =
|
|
22356
|
-
* const value =
|
|
22211
|
+
* const propertyName = KEY_USER_PUBLIC_WITH_ATTRIBUTES_PHONE;
|
|
22212
|
+
* const value = userpublicwithattributes[propertyName];
|
|
22357
22213
|
* ```
|
|
22358
22214
|
*
|
|
22359
|
-
* @see {@link
|
|
22360
|
-
* @see {@link
|
|
22215
|
+
* @see {@link UserPublicWithAttributes} - The TypeScript type definition
|
|
22216
|
+
* @see {@link KEYS_USER_PUBLIC_WITH_ATTRIBUTES} - Array of all keys for this type
|
|
22361
22217
|
*/
|
|
22362
|
-
export const
|
|
22218
|
+
export const KEY_USER_PUBLIC_WITH_ATTRIBUTES_PHONE: keyof UserPublicWithAttributes = 'phone';
|
|
22363
22219
|
/**
|
|
22364
22220
|
* status property
|
|
22365
22221
|
*
|
|
@@ -22367,23 +22223,23 @@ export const KEY_USER_WITH_ATTRIBUTES_PHONE: keyof UserWithAttributes = 'phone';
|
|
|
22367
22223
|
*
|
|
22368
22224
|
*
|
|
22369
22225
|
* @remarks
|
|
22370
|
-
* This key constant provides type-safe access to the `status` property of
|
|
22226
|
+
* This key constant provides type-safe access to the `status` property of UserPublicWithAttributes objects.
|
|
22371
22227
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22372
22228
|
*
|
|
22373
22229
|
* @example
|
|
22374
22230
|
* ```typescript
|
|
22375
22231
|
* // Direct property access
|
|
22376
|
-
* const value =
|
|
22232
|
+
* const value = userpublicwithattributes[KEY_USER_PUBLIC_WITH_ATTRIBUTES_STATUS];
|
|
22377
22233
|
*
|
|
22378
22234
|
* // Dynamic property access
|
|
22379
|
-
* const propertyName =
|
|
22380
|
-
* const value =
|
|
22235
|
+
* const propertyName = KEY_USER_PUBLIC_WITH_ATTRIBUTES_STATUS;
|
|
22236
|
+
* const value = userpublicwithattributes[propertyName];
|
|
22381
22237
|
* ```
|
|
22382
22238
|
*
|
|
22383
|
-
* @see {@link
|
|
22384
|
-
* @see {@link
|
|
22239
|
+
* @see {@link UserPublicWithAttributes} - The TypeScript type definition
|
|
22240
|
+
* @see {@link KEYS_USER_PUBLIC_WITH_ATTRIBUTES} - Array of all keys for this type
|
|
22385
22241
|
*/
|
|
22386
|
-
export const
|
|
22242
|
+
export const KEY_USER_PUBLIC_WITH_ATTRIBUTES_STATUS: keyof UserPublicWithAttributes = 'status';
|
|
22387
22243
|
/**
|
|
22388
22244
|
* Updated On
|
|
22389
22245
|
*
|
|
@@ -22393,23 +22249,23 @@ export const KEY_USER_WITH_ATTRIBUTES_STATUS: keyof UserWithAttributes = 'status
|
|
|
22393
22249
|
*
|
|
22394
22250
|
*
|
|
22395
22251
|
* @remarks
|
|
22396
|
-
* This key constant provides type-safe access to the `updated_on` property of
|
|
22252
|
+
* This key constant provides type-safe access to the `updated_on` property of UserPublicWithAttributes objects.
|
|
22397
22253
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22398
22254
|
*
|
|
22399
22255
|
* @example
|
|
22400
22256
|
* ```typescript
|
|
22401
22257
|
* // Direct property access
|
|
22402
|
-
* const value =
|
|
22258
|
+
* const value = userpublicwithattributes[KEY_USER_PUBLIC_WITH_ATTRIBUTES_UPDATED_ON];
|
|
22403
22259
|
*
|
|
22404
22260
|
* // Dynamic property access
|
|
22405
|
-
* const propertyName =
|
|
22406
|
-
* const value =
|
|
22261
|
+
* const propertyName = KEY_USER_PUBLIC_WITH_ATTRIBUTES_UPDATED_ON;
|
|
22262
|
+
* const value = userpublicwithattributes[propertyName];
|
|
22407
22263
|
* ```
|
|
22408
22264
|
*
|
|
22409
|
-
* @see {@link
|
|
22410
|
-
* @see {@link
|
|
22265
|
+
* @see {@link UserPublicWithAttributes} - The TypeScript type definition
|
|
22266
|
+
* @see {@link KEYS_USER_PUBLIC_WITH_ATTRIBUTES} - Array of all keys for this type
|
|
22411
22267
|
*/
|
|
22412
|
-
export const
|
|
22268
|
+
export const KEY_USER_PUBLIC_WITH_ATTRIBUTES_UPDATED_ON: keyof UserPublicWithAttributes = 'updated_on';
|
|
22413
22269
|
/**
|
|
22414
22270
|
* User Attributes
|
|
22415
22271
|
*
|
|
@@ -22419,23 +22275,23 @@ export const KEY_USER_WITH_ATTRIBUTES_UPDATED_ON: keyof UserWithAttributes = 'up
|
|
|
22419
22275
|
*
|
|
22420
22276
|
*
|
|
22421
22277
|
* @remarks
|
|
22422
|
-
* This key constant provides type-safe access to the `user_attributes` property of
|
|
22278
|
+
* This key constant provides type-safe access to the `user_attributes` property of UserPublicWithAttributes objects.
|
|
22423
22279
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22424
22280
|
*
|
|
22425
22281
|
* @example
|
|
22426
22282
|
* ```typescript
|
|
22427
22283
|
* // Direct property access
|
|
22428
|
-
* const value =
|
|
22284
|
+
* const value = userpublicwithattributes[KEY_USER_PUBLIC_WITH_ATTRIBUTES_USER_ATTRIBUTES];
|
|
22429
22285
|
*
|
|
22430
22286
|
* // Dynamic property access
|
|
22431
|
-
* const propertyName =
|
|
22432
|
-
* const value =
|
|
22287
|
+
* const propertyName = KEY_USER_PUBLIC_WITH_ATTRIBUTES_USER_ATTRIBUTES;
|
|
22288
|
+
* const value = userpublicwithattributes[propertyName];
|
|
22433
22289
|
* ```
|
|
22434
22290
|
*
|
|
22435
|
-
* @see {@link
|
|
22436
|
-
* @see {@link
|
|
22291
|
+
* @see {@link UserPublicWithAttributes} - The TypeScript type definition
|
|
22292
|
+
* @see {@link KEYS_USER_PUBLIC_WITH_ATTRIBUTES} - Array of all keys for this type
|
|
22437
22293
|
*/
|
|
22438
|
-
export const
|
|
22294
|
+
export const KEY_USER_PUBLIC_WITH_ATTRIBUTES_USER_ATTRIBUTES: keyof UserPublicWithAttributes = 'user_attributes';
|
|
22439
22295
|
/**
|
|
22440
22296
|
* User Id
|
|
22441
22297
|
*
|
|
@@ -22444,23 +22300,23 @@ export const KEY_USER_WITH_ATTRIBUTES_USER_ATTRIBUTES: keyof UserWithAttributes
|
|
|
22444
22300
|
*
|
|
22445
22301
|
*
|
|
22446
22302
|
* @remarks
|
|
22447
|
-
* This key constant provides type-safe access to the `user_id` property of
|
|
22303
|
+
* This key constant provides type-safe access to the `user_id` property of UserPublicWithAttributes objects.
|
|
22448
22304
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22449
22305
|
*
|
|
22450
22306
|
* @example
|
|
22451
22307
|
* ```typescript
|
|
22452
22308
|
* // Direct property access
|
|
22453
|
-
* const value =
|
|
22309
|
+
* const value = userpublicwithattributes[KEY_USER_PUBLIC_WITH_ATTRIBUTES_USER_ID];
|
|
22454
22310
|
*
|
|
22455
22311
|
* // Dynamic property access
|
|
22456
|
-
* const propertyName =
|
|
22457
|
-
* const value =
|
|
22312
|
+
* const propertyName = KEY_USER_PUBLIC_WITH_ATTRIBUTES_USER_ID;
|
|
22313
|
+
* const value = userpublicwithattributes[propertyName];
|
|
22458
22314
|
* ```
|
|
22459
22315
|
*
|
|
22460
|
-
* @see {@link
|
|
22461
|
-
* @see {@link
|
|
22316
|
+
* @see {@link UserPublicWithAttributes} - The TypeScript type definition
|
|
22317
|
+
* @see {@link KEYS_USER_PUBLIC_WITH_ATTRIBUTES} - Array of all keys for this type
|
|
22462
22318
|
*/
|
|
22463
|
-
export const
|
|
22319
|
+
export const KEY_USER_PUBLIC_WITH_ATTRIBUTES_USER_ID: keyof UserPublicWithAttributes = 'user_id';
|
|
22464
22320
|
/**
|
|
22465
22321
|
* Username
|
|
22466
22322
|
*
|
|
@@ -22470,59 +22326,419 @@ export const KEY_USER_WITH_ATTRIBUTES_USER_ID: keyof UserWithAttributes = 'user_
|
|
|
22470
22326
|
*
|
|
22471
22327
|
*
|
|
22472
22328
|
* @remarks
|
|
22473
|
-
* This key constant provides type-safe access to the `username` property of
|
|
22329
|
+
* This key constant provides type-safe access to the `username` property of UserPublicWithAttributes objects.
|
|
22330
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22331
|
+
*
|
|
22332
|
+
* @example
|
|
22333
|
+
* ```typescript
|
|
22334
|
+
* // Direct property access
|
|
22335
|
+
* const value = userpublicwithattributes[KEY_USER_PUBLIC_WITH_ATTRIBUTES_USERNAME];
|
|
22336
|
+
*
|
|
22337
|
+
* // Dynamic property access
|
|
22338
|
+
* const propertyName = KEY_USER_PUBLIC_WITH_ATTRIBUTES_USERNAME;
|
|
22339
|
+
* const value = userpublicwithattributes[propertyName];
|
|
22340
|
+
* ```
|
|
22341
|
+
*
|
|
22342
|
+
* @see {@link UserPublicWithAttributes} - The TypeScript type definition
|
|
22343
|
+
* @see {@link KEYS_USER_PUBLIC_WITH_ATTRIBUTES} - Array of all keys for this type
|
|
22344
|
+
*/
|
|
22345
|
+
export const KEY_USER_PUBLIC_WITH_ATTRIBUTES_USERNAME: keyof UserPublicWithAttributes = 'username';
|
|
22346
|
+
|
|
22347
|
+
/**
|
|
22348
|
+
* Array of all UserPublicWithAttributes property keys
|
|
22349
|
+
*
|
|
22350
|
+
* @remarks
|
|
22351
|
+
* This constant provides a readonly array containing all valid property keys for UserPublicWithAttributes objects.
|
|
22352
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
22353
|
+
*
|
|
22354
|
+
* @example
|
|
22355
|
+
* ```typescript
|
|
22356
|
+
* // Iterating through all keys
|
|
22357
|
+
* for (const key of KEYS_USER_PUBLIC_WITH_ATTRIBUTES) {
|
|
22358
|
+
* console.log(`Property: ${key}, Value: ${userpublicwithattributes[key]}`);
|
|
22359
|
+
* }
|
|
22360
|
+
*
|
|
22361
|
+
* // Validation
|
|
22362
|
+
* const isValidKey = KEYS_USER_PUBLIC_WITH_ATTRIBUTES.includes(someKey);
|
|
22363
|
+
* ```
|
|
22364
|
+
*
|
|
22365
|
+
* @see {@link UserPublicWithAttributes} - The TypeScript type definition
|
|
22366
|
+
*/
|
|
22367
|
+
export const KEYS_USER_PUBLIC_WITH_ATTRIBUTES = [
|
|
22368
|
+
KEY_USER_PUBLIC_WITH_ATTRIBUTES_CREATED_ON,
|
|
22369
|
+
KEY_USER_PUBLIC_WITH_ATTRIBUTES_DELETED_ON,
|
|
22370
|
+
KEY_USER_PUBLIC_WITH_ATTRIBUTES_EMAIL,
|
|
22371
|
+
KEY_USER_PUBLIC_WITH_ATTRIBUTES_FIRST_NAME,
|
|
22372
|
+
KEY_USER_PUBLIC_WITH_ATTRIBUTES_LAST_NAME,
|
|
22373
|
+
KEY_USER_PUBLIC_WITH_ATTRIBUTES_LOCALE,
|
|
22374
|
+
KEY_USER_PUBLIC_WITH_ATTRIBUTES_ORGANIZATION_ID,
|
|
22375
|
+
KEY_USER_PUBLIC_WITH_ATTRIBUTES_PHONE,
|
|
22376
|
+
KEY_USER_PUBLIC_WITH_ATTRIBUTES_STATUS,
|
|
22377
|
+
KEY_USER_PUBLIC_WITH_ATTRIBUTES_UPDATED_ON,
|
|
22378
|
+
KEY_USER_PUBLIC_WITH_ATTRIBUTES_USER_ATTRIBUTES,
|
|
22379
|
+
KEY_USER_PUBLIC_WITH_ATTRIBUTES_USER_ID,
|
|
22380
|
+
KEY_USER_PUBLIC_WITH_ATTRIBUTES_USERNAME,
|
|
22381
|
+
] as const satisfies (keyof UserPublicWithAttributes)[];
|
|
22382
|
+
|
|
22383
|
+
/**
|
|
22384
|
+
* Access Token
|
|
22385
|
+
*
|
|
22386
|
+
*
|
|
22387
|
+
* @type {string}
|
|
22388
|
+
*
|
|
22389
|
+
*
|
|
22390
|
+
* @remarks
|
|
22391
|
+
* This key constant provides type-safe access to the `access_token` property of UserToken objects.
|
|
22392
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22393
|
+
*
|
|
22394
|
+
* @example
|
|
22395
|
+
* ```typescript
|
|
22396
|
+
* // Direct property access
|
|
22397
|
+
* const value = usertoken[KEY_USER_TOKEN_ACCESS_TOKEN];
|
|
22398
|
+
*
|
|
22399
|
+
* // Dynamic property access
|
|
22400
|
+
* const propertyName = KEY_USER_TOKEN_ACCESS_TOKEN;
|
|
22401
|
+
* const value = usertoken[propertyName];
|
|
22402
|
+
* ```
|
|
22403
|
+
*
|
|
22404
|
+
* @see {@link UserToken} - The TypeScript type definition
|
|
22405
|
+
* @see {@link KEYS_USER_TOKEN} - Array of all keys for this type
|
|
22406
|
+
*/
|
|
22407
|
+
export const KEY_USER_TOKEN_ACCESS_TOKEN: keyof UserToken = 'access_token';
|
|
22408
|
+
/**
|
|
22409
|
+
* Expires In
|
|
22410
|
+
*
|
|
22411
|
+
*
|
|
22412
|
+
* @type {integer}
|
|
22413
|
+
*
|
|
22414
|
+
*
|
|
22415
|
+
* @remarks
|
|
22416
|
+
* This key constant provides type-safe access to the `expires_in` property of UserToken objects.
|
|
22417
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22418
|
+
*
|
|
22419
|
+
* @example
|
|
22420
|
+
* ```typescript
|
|
22421
|
+
* // Direct property access
|
|
22422
|
+
* const value = usertoken[KEY_USER_TOKEN_EXPIRES_IN];
|
|
22423
|
+
*
|
|
22424
|
+
* // Dynamic property access
|
|
22425
|
+
* const propertyName = KEY_USER_TOKEN_EXPIRES_IN;
|
|
22426
|
+
* const value = usertoken[propertyName];
|
|
22427
|
+
* ```
|
|
22428
|
+
*
|
|
22429
|
+
* @see {@link UserToken} - The TypeScript type definition
|
|
22430
|
+
* @see {@link KEYS_USER_TOKEN} - Array of all keys for this type
|
|
22431
|
+
*/
|
|
22432
|
+
export const KEY_USER_TOKEN_EXPIRES_IN: keyof UserToken = 'expires_in';
|
|
22433
|
+
/**
|
|
22434
|
+
* Refresh Expires In
|
|
22435
|
+
*
|
|
22436
|
+
*
|
|
22437
|
+
* @type {integer}
|
|
22438
|
+
*
|
|
22439
|
+
*
|
|
22440
|
+
* @remarks
|
|
22441
|
+
* This key constant provides type-safe access to the `refresh_expires_in` property of UserToken objects.
|
|
22442
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22443
|
+
*
|
|
22444
|
+
* @example
|
|
22445
|
+
* ```typescript
|
|
22446
|
+
* // Direct property access
|
|
22447
|
+
* const value = usertoken[KEY_USER_TOKEN_REFRESH_EXPIRES_IN];
|
|
22448
|
+
*
|
|
22449
|
+
* // Dynamic property access
|
|
22450
|
+
* const propertyName = KEY_USER_TOKEN_REFRESH_EXPIRES_IN;
|
|
22451
|
+
* const value = usertoken[propertyName];
|
|
22452
|
+
* ```
|
|
22453
|
+
*
|
|
22454
|
+
* @see {@link UserToken} - The TypeScript type definition
|
|
22455
|
+
* @see {@link KEYS_USER_TOKEN} - Array of all keys for this type
|
|
22456
|
+
*/
|
|
22457
|
+
export const KEY_USER_TOKEN_REFRESH_EXPIRES_IN: keyof UserToken = 'refresh_expires_in';
|
|
22458
|
+
/**
|
|
22459
|
+
* Refresh Token
|
|
22460
|
+
*
|
|
22461
|
+
*
|
|
22462
|
+
* @type {string}
|
|
22463
|
+
*
|
|
22464
|
+
*
|
|
22465
|
+
* @remarks
|
|
22466
|
+
* This key constant provides type-safe access to the `refresh_token` property of UserToken objects.
|
|
22467
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22468
|
+
*
|
|
22469
|
+
* @example
|
|
22470
|
+
* ```typescript
|
|
22471
|
+
* // Direct property access
|
|
22472
|
+
* const value = usertoken[KEY_USER_TOKEN_REFRESH_TOKEN];
|
|
22473
|
+
*
|
|
22474
|
+
* // Dynamic property access
|
|
22475
|
+
* const propertyName = KEY_USER_TOKEN_REFRESH_TOKEN;
|
|
22476
|
+
* const value = usertoken[propertyName];
|
|
22477
|
+
* ```
|
|
22478
|
+
*
|
|
22479
|
+
* @see {@link UserToken} - The TypeScript type definition
|
|
22480
|
+
* @see {@link KEYS_USER_TOKEN} - Array of all keys for this type
|
|
22481
|
+
*/
|
|
22482
|
+
export const KEY_USER_TOKEN_REFRESH_TOKEN: keyof UserToken = 'refresh_token';
|
|
22483
|
+
/**
|
|
22484
|
+
* Token Type
|
|
22485
|
+
*
|
|
22486
|
+
*
|
|
22487
|
+
* @type {string}
|
|
22488
|
+
*
|
|
22489
|
+
*
|
|
22490
|
+
* @remarks
|
|
22491
|
+
* This key constant provides type-safe access to the `token_type` property of UserToken objects.
|
|
22492
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22493
|
+
*
|
|
22494
|
+
* @example
|
|
22495
|
+
* ```typescript
|
|
22496
|
+
* // Direct property access
|
|
22497
|
+
* const value = usertoken[KEY_USER_TOKEN_TOKEN_TYPE];
|
|
22498
|
+
*
|
|
22499
|
+
* // Dynamic property access
|
|
22500
|
+
* const propertyName = KEY_USER_TOKEN_TOKEN_TYPE;
|
|
22501
|
+
* const value = usertoken[propertyName];
|
|
22502
|
+
* ```
|
|
22503
|
+
*
|
|
22504
|
+
* @see {@link UserToken} - The TypeScript type definition
|
|
22505
|
+
* @see {@link KEYS_USER_TOKEN} - Array of all keys for this type
|
|
22506
|
+
*/
|
|
22507
|
+
export const KEY_USER_TOKEN_TOKEN_TYPE: keyof UserToken = 'token_type';
|
|
22508
|
+
|
|
22509
|
+
/**
|
|
22510
|
+
* Array of all UserToken property keys
|
|
22511
|
+
*
|
|
22512
|
+
* @remarks
|
|
22513
|
+
* This constant provides a readonly array containing all valid property keys for UserToken objects.
|
|
22514
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
22515
|
+
*
|
|
22516
|
+
* @example
|
|
22517
|
+
* ```typescript
|
|
22518
|
+
* // Iterating through all keys
|
|
22519
|
+
* for (const key of KEYS_USER_TOKEN) {
|
|
22520
|
+
* console.log(`Property: ${key}, Value: ${usertoken[key]}`);
|
|
22521
|
+
* }
|
|
22522
|
+
*
|
|
22523
|
+
* // Validation
|
|
22524
|
+
* const isValidKey = KEYS_USER_TOKEN.includes(someKey);
|
|
22525
|
+
* ```
|
|
22526
|
+
*
|
|
22527
|
+
* @see {@link UserToken} - The TypeScript type definition
|
|
22528
|
+
*/
|
|
22529
|
+
export const KEYS_USER_TOKEN = [
|
|
22530
|
+
KEY_USER_TOKEN_ACCESS_TOKEN,
|
|
22531
|
+
KEY_USER_TOKEN_EXPIRES_IN,
|
|
22532
|
+
KEY_USER_TOKEN_REFRESH_EXPIRES_IN,
|
|
22533
|
+
KEY_USER_TOKEN_REFRESH_TOKEN,
|
|
22534
|
+
KEY_USER_TOKEN_TOKEN_TYPE,
|
|
22535
|
+
] as const satisfies (keyof UserToken)[];
|
|
22536
|
+
|
|
22537
|
+
/**
|
|
22538
|
+
* Email
|
|
22539
|
+
*
|
|
22540
|
+
* The user's email address
|
|
22541
|
+
*
|
|
22542
|
+
*
|
|
22543
|
+
*
|
|
22544
|
+
* @remarks
|
|
22545
|
+
* This key constant provides type-safe access to the `email` property of UserUpdate objects.
|
|
22546
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22547
|
+
*
|
|
22548
|
+
* @example
|
|
22549
|
+
* ```typescript
|
|
22550
|
+
* // Direct property access
|
|
22551
|
+
* const value = userupdate[KEY_USER_UPDATE_EMAIL];
|
|
22552
|
+
*
|
|
22553
|
+
* // Dynamic property access
|
|
22554
|
+
* const propertyName = KEY_USER_UPDATE_EMAIL;
|
|
22555
|
+
* const value = userupdate[propertyName];
|
|
22556
|
+
* ```
|
|
22557
|
+
*
|
|
22558
|
+
* @see {@link UserUpdate} - The TypeScript type definition
|
|
22559
|
+
* @see {@link KEYS_USER_UPDATE} - Array of all keys for this type
|
|
22560
|
+
*/
|
|
22561
|
+
export const KEY_USER_UPDATE_EMAIL: keyof UserUpdate = 'email';
|
|
22562
|
+
/**
|
|
22563
|
+
* First Name
|
|
22564
|
+
*
|
|
22565
|
+
* The user's first name
|
|
22566
|
+
*
|
|
22567
|
+
*
|
|
22568
|
+
*
|
|
22569
|
+
* @remarks
|
|
22570
|
+
* This key constant provides type-safe access to the `first_name` property of UserUpdate objects.
|
|
22571
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22572
|
+
*
|
|
22573
|
+
* @example
|
|
22574
|
+
* ```typescript
|
|
22575
|
+
* // Direct property access
|
|
22576
|
+
* const value = userupdate[KEY_USER_UPDATE_FIRST_NAME];
|
|
22577
|
+
*
|
|
22578
|
+
* // Dynamic property access
|
|
22579
|
+
* const propertyName = KEY_USER_UPDATE_FIRST_NAME;
|
|
22580
|
+
* const value = userupdate[propertyName];
|
|
22581
|
+
* ```
|
|
22582
|
+
*
|
|
22583
|
+
* @see {@link UserUpdate} - The TypeScript type definition
|
|
22584
|
+
* @see {@link KEYS_USER_UPDATE} - Array of all keys for this type
|
|
22585
|
+
*/
|
|
22586
|
+
export const KEY_USER_UPDATE_FIRST_NAME: keyof UserUpdate = 'first_name';
|
|
22587
|
+
/**
|
|
22588
|
+
* Last Name
|
|
22589
|
+
*
|
|
22590
|
+
* The user's last name
|
|
22591
|
+
*
|
|
22592
|
+
*
|
|
22593
|
+
*
|
|
22594
|
+
* @remarks
|
|
22595
|
+
* This key constant provides type-safe access to the `last_name` property of UserUpdate objects.
|
|
22596
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22597
|
+
*
|
|
22598
|
+
* @example
|
|
22599
|
+
* ```typescript
|
|
22600
|
+
* // Direct property access
|
|
22601
|
+
* const value = userupdate[KEY_USER_UPDATE_LAST_NAME];
|
|
22602
|
+
*
|
|
22603
|
+
* // Dynamic property access
|
|
22604
|
+
* const propertyName = KEY_USER_UPDATE_LAST_NAME;
|
|
22605
|
+
* const value = userupdate[propertyName];
|
|
22606
|
+
* ```
|
|
22607
|
+
*
|
|
22608
|
+
* @see {@link UserUpdate} - The TypeScript type definition
|
|
22609
|
+
* @see {@link KEYS_USER_UPDATE} - Array of all keys for this type
|
|
22610
|
+
*/
|
|
22611
|
+
export const KEY_USER_UPDATE_LAST_NAME: keyof UserUpdate = 'last_name';
|
|
22612
|
+
/**
|
|
22613
|
+
* Locale
|
|
22614
|
+
*
|
|
22615
|
+
* The user's locale
|
|
22616
|
+
*
|
|
22617
|
+
*
|
|
22618
|
+
*
|
|
22619
|
+
* @remarks
|
|
22620
|
+
* This key constant provides type-safe access to the `locale` property of UserUpdate objects.
|
|
22621
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22622
|
+
*
|
|
22623
|
+
* @example
|
|
22624
|
+
* ```typescript
|
|
22625
|
+
* // Direct property access
|
|
22626
|
+
* const value = userupdate[KEY_USER_UPDATE_LOCALE];
|
|
22627
|
+
*
|
|
22628
|
+
* // Dynamic property access
|
|
22629
|
+
* const propertyName = KEY_USER_UPDATE_LOCALE;
|
|
22630
|
+
* const value = userupdate[propertyName];
|
|
22631
|
+
* ```
|
|
22632
|
+
*
|
|
22633
|
+
* @see {@link UserUpdate} - The TypeScript type definition
|
|
22634
|
+
* @see {@link KEYS_USER_UPDATE} - Array of all keys for this type
|
|
22635
|
+
*/
|
|
22636
|
+
export const KEY_USER_UPDATE_LOCALE: keyof UserUpdate = 'locale';
|
|
22637
|
+
/**
|
|
22638
|
+
* Phone
|
|
22639
|
+
*
|
|
22640
|
+
* The user's phone number
|
|
22641
|
+
*
|
|
22642
|
+
*
|
|
22643
|
+
*
|
|
22644
|
+
* @remarks
|
|
22645
|
+
* This key constant provides type-safe access to the `phone` property of UserUpdate objects.
|
|
22474
22646
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22475
22647
|
*
|
|
22476
22648
|
* @example
|
|
22477
22649
|
* ```typescript
|
|
22478
22650
|
* // Direct property access
|
|
22479
|
-
* const value =
|
|
22651
|
+
* const value = userupdate[KEY_USER_UPDATE_PHONE];
|
|
22480
22652
|
*
|
|
22481
22653
|
* // Dynamic property access
|
|
22482
|
-
* const propertyName =
|
|
22483
|
-
* const value =
|
|
22654
|
+
* const propertyName = KEY_USER_UPDATE_PHONE;
|
|
22655
|
+
* const value = userupdate[propertyName];
|
|
22484
22656
|
* ```
|
|
22485
22657
|
*
|
|
22486
|
-
* @see {@link
|
|
22487
|
-
* @see {@link
|
|
22658
|
+
* @see {@link UserUpdate} - The TypeScript type definition
|
|
22659
|
+
* @see {@link KEYS_USER_UPDATE} - Array of all keys for this type
|
|
22488
22660
|
*/
|
|
22489
|
-
export const
|
|
22661
|
+
export const KEY_USER_UPDATE_PHONE: keyof UserUpdate = 'phone';
|
|
22662
|
+
/**
|
|
22663
|
+
* User Attributes
|
|
22664
|
+
*
|
|
22665
|
+
* User attributes
|
|
22666
|
+
*
|
|
22667
|
+
*
|
|
22668
|
+
*
|
|
22669
|
+
* @remarks
|
|
22670
|
+
* This key constant provides type-safe access to the `user_attributes` property of UserUpdate objects.
|
|
22671
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22672
|
+
*
|
|
22673
|
+
* @example
|
|
22674
|
+
* ```typescript
|
|
22675
|
+
* // Direct property access
|
|
22676
|
+
* const value = userupdate[KEY_USER_UPDATE_USER_ATTRIBUTES];
|
|
22677
|
+
*
|
|
22678
|
+
* // Dynamic property access
|
|
22679
|
+
* const propertyName = KEY_USER_UPDATE_USER_ATTRIBUTES;
|
|
22680
|
+
* const value = userupdate[propertyName];
|
|
22681
|
+
* ```
|
|
22682
|
+
*
|
|
22683
|
+
* @see {@link UserUpdate} - The TypeScript type definition
|
|
22684
|
+
* @see {@link KEYS_USER_UPDATE} - Array of all keys for this type
|
|
22685
|
+
*/
|
|
22686
|
+
export const KEY_USER_UPDATE_USER_ATTRIBUTES: keyof UserUpdate = 'user_attributes';
|
|
22687
|
+
/**
|
|
22688
|
+
* Username
|
|
22689
|
+
*
|
|
22690
|
+
* The user's unique username
|
|
22691
|
+
*
|
|
22692
|
+
*
|
|
22693
|
+
*
|
|
22694
|
+
* @remarks
|
|
22695
|
+
* This key constant provides type-safe access to the `username` property of UserUpdate objects.
|
|
22696
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
22697
|
+
*
|
|
22698
|
+
* @example
|
|
22699
|
+
* ```typescript
|
|
22700
|
+
* // Direct property access
|
|
22701
|
+
* const value = userupdate[KEY_USER_UPDATE_USERNAME];
|
|
22702
|
+
*
|
|
22703
|
+
* // Dynamic property access
|
|
22704
|
+
* const propertyName = KEY_USER_UPDATE_USERNAME;
|
|
22705
|
+
* const value = userupdate[propertyName];
|
|
22706
|
+
* ```
|
|
22707
|
+
*
|
|
22708
|
+
* @see {@link UserUpdate} - The TypeScript type definition
|
|
22709
|
+
* @see {@link KEYS_USER_UPDATE} - Array of all keys for this type
|
|
22710
|
+
*/
|
|
22711
|
+
export const KEY_USER_UPDATE_USERNAME: keyof UserUpdate = 'username';
|
|
22490
22712
|
|
|
22491
22713
|
/**
|
|
22492
|
-
* Array of all
|
|
22714
|
+
* Array of all UserUpdate property keys
|
|
22493
22715
|
*
|
|
22494
22716
|
* @remarks
|
|
22495
|
-
* This constant provides a readonly array containing all valid property keys for
|
|
22717
|
+
* This constant provides a readonly array containing all valid property keys for UserUpdate objects.
|
|
22496
22718
|
* Useful for iteration, validation, and generating dynamic UI components.
|
|
22497
22719
|
*
|
|
22498
22720
|
* @example
|
|
22499
22721
|
* ```typescript
|
|
22500
22722
|
* // Iterating through all keys
|
|
22501
|
-
* for (const key of
|
|
22502
|
-
* console.log(`Property: ${key}, Value: ${
|
|
22723
|
+
* for (const key of KEYS_USER_UPDATE) {
|
|
22724
|
+
* console.log(`Property: ${key}, Value: ${userupdate[key]}`);
|
|
22503
22725
|
* }
|
|
22504
22726
|
*
|
|
22505
22727
|
* // Validation
|
|
22506
|
-
* const isValidKey =
|
|
22507
|
-
* ```
|
|
22508
|
-
*
|
|
22509
|
-
* @see {@link
|
|
22510
|
-
*/
|
|
22511
|
-
export const
|
|
22512
|
-
|
|
22513
|
-
|
|
22514
|
-
|
|
22515
|
-
|
|
22516
|
-
|
|
22517
|
-
|
|
22518
|
-
|
|
22519
|
-
|
|
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)[];
|
|
22728
|
+
* const isValidKey = KEYS_USER_UPDATE.includes(someKey);
|
|
22729
|
+
* ```
|
|
22730
|
+
*
|
|
22731
|
+
* @see {@link UserUpdate} - The TypeScript type definition
|
|
22732
|
+
*/
|
|
22733
|
+
export const KEYS_USER_UPDATE = [
|
|
22734
|
+
KEY_USER_UPDATE_EMAIL,
|
|
22735
|
+
KEY_USER_UPDATE_FIRST_NAME,
|
|
22736
|
+
KEY_USER_UPDATE_LAST_NAME,
|
|
22737
|
+
KEY_USER_UPDATE_LOCALE,
|
|
22738
|
+
KEY_USER_UPDATE_PHONE,
|
|
22739
|
+
KEY_USER_UPDATE_USER_ATTRIBUTES,
|
|
22740
|
+
KEY_USER_UPDATE_USERNAME,
|
|
22741
|
+
] as const satisfies (keyof UserUpdate)[];
|
|
22526
22742
|
|
|
22527
22743
|
/**
|
|
22528
22744
|
* Created On
|