@opusdns/api 0.8.0 → 0.10.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 +3 -3
- package/src/helpers/constants.ts +1863 -0
- package/src/helpers/index.ts +19 -0
- package/src/helpers/keys.ts +15719 -0
- package/src/helpers/requests.ts +3493 -0
- package/src/helpers/responses.ts +5428 -0
- package/src/helpers/schemas-arrays.ts +543 -0
- package/src/helpers/schemas.ts +2284 -0
- package/src/index.ts +2 -0
- package/src/openapi.yaml +96 -3
- package/src/schema.d.ts +489 -0
- package/src/types/constants.ts +110 -1
- package/src/types/keys.ts +1547 -7
- package/src/types/types.ts +472 -4
|
@@ -0,0 +1,1863 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Auto-generated const objects and arrays from OpenAPI specification
|
|
3
|
+
*
|
|
4
|
+
* This file contains constant objects and arrays derived from OpenAPI schema enums.
|
|
5
|
+
* Each constant provides both an object form (for key-value access) and an array form (for iteration/validation).
|
|
6
|
+
* These constants use existing types from schemas.ts to avoid duplication and ensure type safety.
|
|
7
|
+
*
|
|
8
|
+
* @remarks
|
|
9
|
+
* - String enums generate both objects and arrays with proper type annotations
|
|
10
|
+
* - Integer enums generate typed arrays only
|
|
11
|
+
* - All constants use 'as const' for maximum type safety
|
|
12
|
+
* - Keys follow SCREAMING_SNAKE_CASE convention for consistency
|
|
13
|
+
*
|
|
14
|
+
* @example
|
|
15
|
+
* ```typescript
|
|
16
|
+
* // Using the object form for key-value access
|
|
17
|
+
* const status = BULK_OPERATION_STATUS.SUCCESS;
|
|
18
|
+
*
|
|
19
|
+
* // Using the array form for iteration
|
|
20
|
+
* const allStatuses = BULK_OPERATION_STATUS_VALUES;
|
|
21
|
+
* ```
|
|
22
|
+
*/
|
|
23
|
+
|
|
24
|
+
import { BulkOperationStatus, ContactSortField, Currency, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecRecordType, DnssecStatus, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainSortField, DomainStatus, EmailForwardStatus, EmailVerificationStatus, EventObjectType, EventSubtype, EventType, GrantType, OrganizationCredentialStatus, OrganizationStatus, PatchOp, PeriodUnit, Permission, PlanRelation, Relation, RenewalMode, SortOrder, UserNotificationStatus, UserStatus, VerificationType, ZoneSortField } from './schemas';
|
|
25
|
+
|
|
26
|
+
/**
|
|
27
|
+
* BulkOperationStatus. Auto-generated enum for BulkOperationStatus
|
|
28
|
+
*
|
|
29
|
+
* @remarks
|
|
30
|
+
* This constant provides both object and array forms for the BulkOperationStatus enum.
|
|
31
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
32
|
+
*
|
|
33
|
+
* @example
|
|
34
|
+
* ```typescript
|
|
35
|
+
* // Using the object form for key-value access
|
|
36
|
+
* const status = BULK_OPERATION_STATUS.SUCCESS;
|
|
37
|
+
*
|
|
38
|
+
* // Using the array form for iteration
|
|
39
|
+
* const allStatuses = BULK_OPERATION_STATUS_VALUES;
|
|
40
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
41
|
+
* ```
|
|
42
|
+
*
|
|
43
|
+
* @see {@link BulkOperationStatus} - The TypeScript type definition
|
|
44
|
+
*/
|
|
45
|
+
export const BULK_OPERATION_STATUS = {
|
|
46
|
+
SUCCESS: "success",
|
|
47
|
+
FAILED: "failed",
|
|
48
|
+
} as const satisfies Record<string, BulkOperationStatus>;
|
|
49
|
+
|
|
50
|
+
/**
|
|
51
|
+
* Array of all BulkOperationStatus enum values
|
|
52
|
+
*
|
|
53
|
+
* @remarks
|
|
54
|
+
* This constant provides a array containing all valid BulkOperationStatus enum values.
|
|
55
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
56
|
+
*
|
|
57
|
+
* @example
|
|
58
|
+
* ```typescript
|
|
59
|
+
* // Iterating through all values
|
|
60
|
+
* for (const value of BULK_OPERATION_STATUS_VALUES) {
|
|
61
|
+
* console.log(`Processing: ${value}`);
|
|
62
|
+
* }
|
|
63
|
+
*
|
|
64
|
+
* // Validation
|
|
65
|
+
* const isValid = BULK_OPERATION_STATUS_VALUES.includes(someValue);
|
|
66
|
+
* ```
|
|
67
|
+
*
|
|
68
|
+
* @see {@link BulkOperationStatus} - The TypeScript type definition
|
|
69
|
+
* @see {@link BULK_OPERATION_STATUS} - The object form of this enum
|
|
70
|
+
*/
|
|
71
|
+
export const BULK_OPERATION_STATUS_VALUES = [
|
|
72
|
+
'success',
|
|
73
|
+
'failed'
|
|
74
|
+
] as const satisfies [string, ...string[]] | BulkOperationStatus[];
|
|
75
|
+
|
|
76
|
+
/**
|
|
77
|
+
* ContactSortField. Auto-generated enum for ContactSortField
|
|
78
|
+
*
|
|
79
|
+
* @remarks
|
|
80
|
+
* This constant provides both object and array forms for the ContactSortField enum.
|
|
81
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
82
|
+
*
|
|
83
|
+
* @example
|
|
84
|
+
* ```typescript
|
|
85
|
+
* // Using the object form for key-value access
|
|
86
|
+
* const status = CONTACT_SORT_FIELD.SUCCESS;
|
|
87
|
+
*
|
|
88
|
+
* // Using the array form for iteration
|
|
89
|
+
* const allStatuses = CONTACT_SORT_FIELD_VALUES;
|
|
90
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
91
|
+
* ```
|
|
92
|
+
*
|
|
93
|
+
* @see {@link ContactSortField} - The TypeScript type definition
|
|
94
|
+
*/
|
|
95
|
+
export const CONTACT_SORT_FIELD = {
|
|
96
|
+
FIRST_NAME: "first_name",
|
|
97
|
+
LAST_NAME: "last_name",
|
|
98
|
+
EMAIL: "email",
|
|
99
|
+
CREATED_ON: "created_on",
|
|
100
|
+
} as const satisfies Record<string, ContactSortField>;
|
|
101
|
+
|
|
102
|
+
/**
|
|
103
|
+
* Array of all ContactSortField enum values
|
|
104
|
+
*
|
|
105
|
+
* @remarks
|
|
106
|
+
* This constant provides a array containing all valid ContactSortField enum values.
|
|
107
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
108
|
+
*
|
|
109
|
+
* @example
|
|
110
|
+
* ```typescript
|
|
111
|
+
* // Iterating through all values
|
|
112
|
+
* for (const value of CONTACT_SORT_FIELD_VALUES) {
|
|
113
|
+
* console.log(`Processing: ${value}`);
|
|
114
|
+
* }
|
|
115
|
+
*
|
|
116
|
+
* // Validation
|
|
117
|
+
* const isValid = CONTACT_SORT_FIELD_VALUES.includes(someValue);
|
|
118
|
+
* ```
|
|
119
|
+
*
|
|
120
|
+
* @see {@link ContactSortField} - The TypeScript type definition
|
|
121
|
+
* @see {@link CONTACT_SORT_FIELD} - The object form of this enum
|
|
122
|
+
*/
|
|
123
|
+
export const CONTACT_SORT_FIELD_VALUES = [
|
|
124
|
+
'first_name',
|
|
125
|
+
'last_name',
|
|
126
|
+
'email',
|
|
127
|
+
'created_on'
|
|
128
|
+
] as const satisfies [string, ...string[]] | ContactSortField[];
|
|
129
|
+
|
|
130
|
+
/**
|
|
131
|
+
* Currency. Auto-generated enum for Currency
|
|
132
|
+
*
|
|
133
|
+
* @remarks
|
|
134
|
+
* This constant provides both object and array forms for the Currency enum.
|
|
135
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
136
|
+
*
|
|
137
|
+
* @example
|
|
138
|
+
* ```typescript
|
|
139
|
+
* // Using the object form for key-value access
|
|
140
|
+
* const status = CURRENCY.SUCCESS;
|
|
141
|
+
*
|
|
142
|
+
* // Using the array form for iteration
|
|
143
|
+
* const allStatuses = CURRENCY_VALUES;
|
|
144
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
145
|
+
* ```
|
|
146
|
+
*
|
|
147
|
+
* @see {@link Currency} - The TypeScript type definition
|
|
148
|
+
*/
|
|
149
|
+
export const CURRENCY = {
|
|
150
|
+
USD: "USD",
|
|
151
|
+
EUR: "EUR",
|
|
152
|
+
} as const satisfies Record<string, Currency>;
|
|
153
|
+
|
|
154
|
+
/**
|
|
155
|
+
* Array of all Currency enum values
|
|
156
|
+
*
|
|
157
|
+
* @remarks
|
|
158
|
+
* This constant provides a array containing all valid Currency enum values.
|
|
159
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
160
|
+
*
|
|
161
|
+
* @example
|
|
162
|
+
* ```typescript
|
|
163
|
+
* // Iterating through all values
|
|
164
|
+
* for (const value of CURRENCY_VALUES) {
|
|
165
|
+
* console.log(`Processing: ${value}`);
|
|
166
|
+
* }
|
|
167
|
+
*
|
|
168
|
+
* // Validation
|
|
169
|
+
* const isValid = CURRENCY_VALUES.includes(someValue);
|
|
170
|
+
* ```
|
|
171
|
+
*
|
|
172
|
+
* @see {@link Currency} - The TypeScript type definition
|
|
173
|
+
* @see {@link CURRENCY} - The object form of this enum
|
|
174
|
+
*/
|
|
175
|
+
export const CURRENCY_VALUES = [
|
|
176
|
+
'USD',
|
|
177
|
+
'EUR'
|
|
178
|
+
] as const satisfies [string, ...string[]] | Currency[];
|
|
179
|
+
|
|
180
|
+
/**
|
|
181
|
+
* DnsChangeAction. Auto-generated enum for DnsChangeAction
|
|
182
|
+
*
|
|
183
|
+
* @remarks
|
|
184
|
+
* This constant provides both object and array forms for the DnsChangeAction enum.
|
|
185
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
186
|
+
*
|
|
187
|
+
* @example
|
|
188
|
+
* ```typescript
|
|
189
|
+
* // Using the object form for key-value access
|
|
190
|
+
* const status = DNS_CHANGE_ACTION.SUCCESS;
|
|
191
|
+
*
|
|
192
|
+
* // Using the array form for iteration
|
|
193
|
+
* const allStatuses = DNS_CHANGE_ACTION_VALUES;
|
|
194
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
195
|
+
* ```
|
|
196
|
+
*
|
|
197
|
+
* @see {@link DnsChangeAction} - The TypeScript type definition
|
|
198
|
+
*/
|
|
199
|
+
export const DNS_CHANGE_ACTION = {
|
|
200
|
+
CREATE_ZONE: "create_zone",
|
|
201
|
+
DELETE_ZONE: "delete_zone",
|
|
202
|
+
CREATE_RECORD: "create_record",
|
|
203
|
+
DELETE_RECORD: "delete_record",
|
|
204
|
+
ENABLE_DNSSEC: "enable_dnssec",
|
|
205
|
+
DISABLE_DNSSEC: "disable_dnssec",
|
|
206
|
+
} as const satisfies Record<string, DnsChangeAction>;
|
|
207
|
+
|
|
208
|
+
/**
|
|
209
|
+
* Array of all DnsChangeAction enum values
|
|
210
|
+
*
|
|
211
|
+
* @remarks
|
|
212
|
+
* This constant provides a array containing all valid DnsChangeAction enum values.
|
|
213
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
214
|
+
*
|
|
215
|
+
* @example
|
|
216
|
+
* ```typescript
|
|
217
|
+
* // Iterating through all values
|
|
218
|
+
* for (const value of DNS_CHANGE_ACTION_VALUES) {
|
|
219
|
+
* console.log(`Processing: ${value}`);
|
|
220
|
+
* }
|
|
221
|
+
*
|
|
222
|
+
* // Validation
|
|
223
|
+
* const isValid = DNS_CHANGE_ACTION_VALUES.includes(someValue);
|
|
224
|
+
* ```
|
|
225
|
+
*
|
|
226
|
+
* @see {@link DnsChangeAction} - The TypeScript type definition
|
|
227
|
+
* @see {@link DNS_CHANGE_ACTION} - The object form of this enum
|
|
228
|
+
*/
|
|
229
|
+
export const DNS_CHANGE_ACTION_VALUES = [
|
|
230
|
+
'create_zone',
|
|
231
|
+
'delete_zone',
|
|
232
|
+
'create_record',
|
|
233
|
+
'delete_record',
|
|
234
|
+
'enable_dnssec',
|
|
235
|
+
'disable_dnssec'
|
|
236
|
+
] as const satisfies [string, ...string[]] | DnsChangeAction[];
|
|
237
|
+
|
|
238
|
+
/**
|
|
239
|
+
* DnsRrsetType. Auto-generated enum for DnsRrsetType
|
|
240
|
+
*
|
|
241
|
+
* @remarks
|
|
242
|
+
* This constant provides both object and array forms for the DnsRrsetType enum.
|
|
243
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
244
|
+
*
|
|
245
|
+
* @example
|
|
246
|
+
* ```typescript
|
|
247
|
+
* // Using the object form for key-value access
|
|
248
|
+
* const status = DNS_RRSET_TYPE.SUCCESS;
|
|
249
|
+
*
|
|
250
|
+
* // Using the array form for iteration
|
|
251
|
+
* const allStatuses = DNS_RRSET_TYPE_VALUES;
|
|
252
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
253
|
+
* ```
|
|
254
|
+
*
|
|
255
|
+
* @see {@link DnsRrsetType} - The TypeScript type definition
|
|
256
|
+
*/
|
|
257
|
+
export const DNS_RRSET_TYPE = {
|
|
258
|
+
A: "A",
|
|
259
|
+
AAAA: "AAAA",
|
|
260
|
+
ALIAS: "ALIAS",
|
|
261
|
+
CAA: "CAA",
|
|
262
|
+
CNAME: "CNAME",
|
|
263
|
+
DNSKEY: "DNSKEY",
|
|
264
|
+
DS: "DS",
|
|
265
|
+
MX: "MX",
|
|
266
|
+
NS: "NS",
|
|
267
|
+
PTR: "PTR",
|
|
268
|
+
TXT: "TXT",
|
|
269
|
+
SOA: "SOA",
|
|
270
|
+
SRV: "SRV",
|
|
271
|
+
} as const satisfies Record<string, DnsRrsetType>;
|
|
272
|
+
|
|
273
|
+
/**
|
|
274
|
+
* Array of all DnsRrsetType enum values
|
|
275
|
+
*
|
|
276
|
+
* @remarks
|
|
277
|
+
* This constant provides a array containing all valid DnsRrsetType enum values.
|
|
278
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
279
|
+
*
|
|
280
|
+
* @example
|
|
281
|
+
* ```typescript
|
|
282
|
+
* // Iterating through all values
|
|
283
|
+
* for (const value of DNS_RRSET_TYPE_VALUES) {
|
|
284
|
+
* console.log(`Processing: ${value}`);
|
|
285
|
+
* }
|
|
286
|
+
*
|
|
287
|
+
* // Validation
|
|
288
|
+
* const isValid = DNS_RRSET_TYPE_VALUES.includes(someValue);
|
|
289
|
+
* ```
|
|
290
|
+
*
|
|
291
|
+
* @see {@link DnsRrsetType} - The TypeScript type definition
|
|
292
|
+
* @see {@link DNS_RRSET_TYPE} - The object form of this enum
|
|
293
|
+
*/
|
|
294
|
+
export const DNS_RRSET_TYPE_VALUES = [
|
|
295
|
+
'A',
|
|
296
|
+
'AAAA',
|
|
297
|
+
'ALIAS',
|
|
298
|
+
'CAA',
|
|
299
|
+
'CNAME',
|
|
300
|
+
'DNSKEY',
|
|
301
|
+
'DS',
|
|
302
|
+
'MX',
|
|
303
|
+
'NS',
|
|
304
|
+
'PTR',
|
|
305
|
+
'TXT',
|
|
306
|
+
'SOA',
|
|
307
|
+
'SRV'
|
|
308
|
+
] as const satisfies [string, ...string[]] | DnsRrsetType[];
|
|
309
|
+
|
|
310
|
+
/**
|
|
311
|
+
* DnssecAlgorithm. Auto-generated enum for DnssecAlgorithm
|
|
312
|
+
*
|
|
313
|
+
* @remarks
|
|
314
|
+
* This constant provides an array of integer values for the DnssecAlgorithm enum.
|
|
315
|
+
* Integer enums are represented as typed arrays for efficient iteration and validation.
|
|
316
|
+
*
|
|
317
|
+
* @example
|
|
318
|
+
* ```typescript
|
|
319
|
+
* // Using the array for iteration
|
|
320
|
+
* const algorithms = DNSSEC_ALGORITHM;
|
|
321
|
+
* console.log(`Available algorithms: ${algorithms.join(', ')}`);
|
|
322
|
+
* ```
|
|
323
|
+
*
|
|
324
|
+
* @see {@link DnssecAlgorithm} - The TypeScript type definition
|
|
325
|
+
*/
|
|
326
|
+
export const DNSSEC_ALGORITHM = [
|
|
327
|
+
1,
|
|
328
|
+
2,
|
|
329
|
+
3,
|
|
330
|
+
4,
|
|
331
|
+
5,
|
|
332
|
+
6,
|
|
333
|
+
7,
|
|
334
|
+
8,
|
|
335
|
+
10,
|
|
336
|
+
12,
|
|
337
|
+
13,
|
|
338
|
+
14,
|
|
339
|
+
15,
|
|
340
|
+
16,
|
|
341
|
+
17,
|
|
342
|
+
23
|
|
343
|
+
] as const satisfies DnssecAlgorithm[];
|
|
344
|
+
|
|
345
|
+
/**
|
|
346
|
+
* DnssecDigestType. Auto-generated enum for DnssecDigestType
|
|
347
|
+
*
|
|
348
|
+
* @remarks
|
|
349
|
+
* This constant provides an array of integer values for the DnssecDigestType enum.
|
|
350
|
+
* Integer enums are represented as typed arrays for efficient iteration and validation.
|
|
351
|
+
*
|
|
352
|
+
* @example
|
|
353
|
+
* ```typescript
|
|
354
|
+
* // Using the array for iteration
|
|
355
|
+
* const algorithms = DNSSEC_ALGORITHM;
|
|
356
|
+
* console.log(`Available algorithms: ${algorithms.join(', ')}`);
|
|
357
|
+
* ```
|
|
358
|
+
*
|
|
359
|
+
* @see {@link DnssecDigestType} - The TypeScript type definition
|
|
360
|
+
*/
|
|
361
|
+
export const DNSSEC_DIGEST_TYPE = [
|
|
362
|
+
1,
|
|
363
|
+
2,
|
|
364
|
+
3,
|
|
365
|
+
4,
|
|
366
|
+
5,
|
|
367
|
+
6
|
|
368
|
+
] as const satisfies DnssecDigestType[];
|
|
369
|
+
|
|
370
|
+
/**
|
|
371
|
+
* DnssecRecordType. Auto-generated enum for DnssecRecordType
|
|
372
|
+
*
|
|
373
|
+
* @remarks
|
|
374
|
+
* This constant provides both object and array forms for the DnssecRecordType enum.
|
|
375
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
376
|
+
*
|
|
377
|
+
* @example
|
|
378
|
+
* ```typescript
|
|
379
|
+
* // Using the object form for key-value access
|
|
380
|
+
* const status = DNSSEC_RECORD_TYPE.SUCCESS;
|
|
381
|
+
*
|
|
382
|
+
* // Using the array form for iteration
|
|
383
|
+
* const allStatuses = DNSSEC_RECORD_TYPE_VALUES;
|
|
384
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
385
|
+
* ```
|
|
386
|
+
*
|
|
387
|
+
* @see {@link DnssecRecordType} - The TypeScript type definition
|
|
388
|
+
*/
|
|
389
|
+
export const DNSSEC_RECORD_TYPE = {
|
|
390
|
+
DS_DATA: "ds_data",
|
|
391
|
+
KEY_DATA: "key_data",
|
|
392
|
+
} as const satisfies Record<string, DnssecRecordType>;
|
|
393
|
+
|
|
394
|
+
/**
|
|
395
|
+
* Array of all DnssecRecordType enum values
|
|
396
|
+
*
|
|
397
|
+
* @remarks
|
|
398
|
+
* This constant provides a array containing all valid DnssecRecordType enum values.
|
|
399
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
400
|
+
*
|
|
401
|
+
* @example
|
|
402
|
+
* ```typescript
|
|
403
|
+
* // Iterating through all values
|
|
404
|
+
* for (const value of DNSSEC_RECORD_TYPE_VALUES) {
|
|
405
|
+
* console.log(`Processing: ${value}`);
|
|
406
|
+
* }
|
|
407
|
+
*
|
|
408
|
+
* // Validation
|
|
409
|
+
* const isValid = DNSSEC_RECORD_TYPE_VALUES.includes(someValue);
|
|
410
|
+
* ```
|
|
411
|
+
*
|
|
412
|
+
* @see {@link DnssecRecordType} - The TypeScript type definition
|
|
413
|
+
* @see {@link DNSSEC_RECORD_TYPE} - The object form of this enum
|
|
414
|
+
*/
|
|
415
|
+
export const DNSSEC_RECORD_TYPE_VALUES = [
|
|
416
|
+
'ds_data',
|
|
417
|
+
'key_data'
|
|
418
|
+
] as const satisfies [string, ...string[]] | DnssecRecordType[];
|
|
419
|
+
|
|
420
|
+
/**
|
|
421
|
+
* DnssecStatus. Auto-generated enum for DnssecStatus
|
|
422
|
+
*
|
|
423
|
+
* @remarks
|
|
424
|
+
* This constant provides both object and array forms for the DnssecStatus enum.
|
|
425
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
426
|
+
*
|
|
427
|
+
* @example
|
|
428
|
+
* ```typescript
|
|
429
|
+
* // Using the object form for key-value access
|
|
430
|
+
* const status = DNSSEC_STATUS.SUCCESS;
|
|
431
|
+
*
|
|
432
|
+
* // Using the array form for iteration
|
|
433
|
+
* const allStatuses = DNSSEC_STATUS_VALUES;
|
|
434
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
435
|
+
* ```
|
|
436
|
+
*
|
|
437
|
+
* @see {@link DnssecStatus} - The TypeScript type definition
|
|
438
|
+
*/
|
|
439
|
+
export const DNSSEC_STATUS = {
|
|
440
|
+
ENABLED: "enabled",
|
|
441
|
+
DISABLED: "disabled",
|
|
442
|
+
} as const satisfies Record<string, DnssecStatus>;
|
|
443
|
+
|
|
444
|
+
/**
|
|
445
|
+
* Array of all DnssecStatus enum values
|
|
446
|
+
*
|
|
447
|
+
* @remarks
|
|
448
|
+
* This constant provides a array containing all valid DnssecStatus enum values.
|
|
449
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
450
|
+
*
|
|
451
|
+
* @example
|
|
452
|
+
* ```typescript
|
|
453
|
+
* // Iterating through all values
|
|
454
|
+
* for (const value of DNSSEC_STATUS_VALUES) {
|
|
455
|
+
* console.log(`Processing: ${value}`);
|
|
456
|
+
* }
|
|
457
|
+
*
|
|
458
|
+
* // Validation
|
|
459
|
+
* const isValid = DNSSEC_STATUS_VALUES.includes(someValue);
|
|
460
|
+
* ```
|
|
461
|
+
*
|
|
462
|
+
* @see {@link DnssecStatus} - The TypeScript type definition
|
|
463
|
+
* @see {@link DNSSEC_STATUS} - The object form of this enum
|
|
464
|
+
*/
|
|
465
|
+
export const DNSSEC_STATUS_VALUES = [
|
|
466
|
+
'enabled',
|
|
467
|
+
'disabled'
|
|
468
|
+
] as const satisfies [string, ...string[]] | DnssecStatus[];
|
|
469
|
+
|
|
470
|
+
/**
|
|
471
|
+
* DomainAvailabilityStatus. Auto-generated enum for DomainAvailabilityStatus
|
|
472
|
+
*
|
|
473
|
+
* @remarks
|
|
474
|
+
* This constant provides both object and array forms for the DomainAvailabilityStatus enum.
|
|
475
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
476
|
+
*
|
|
477
|
+
* @example
|
|
478
|
+
* ```typescript
|
|
479
|
+
* // Using the object form for key-value access
|
|
480
|
+
* const status = DOMAIN_AVAILABILITY_STATUS.SUCCESS;
|
|
481
|
+
*
|
|
482
|
+
* // Using the array form for iteration
|
|
483
|
+
* const allStatuses = DOMAIN_AVAILABILITY_STATUS_VALUES;
|
|
484
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
485
|
+
* ```
|
|
486
|
+
*
|
|
487
|
+
* @see {@link DomainAvailabilityStatus} - The TypeScript type definition
|
|
488
|
+
*/
|
|
489
|
+
export const DOMAIN_AVAILABILITY_STATUS = {
|
|
490
|
+
AVAILABLE: "available",
|
|
491
|
+
UNAVAILABLE: "unavailable",
|
|
492
|
+
MARKET_AVAILABLE: "market_available",
|
|
493
|
+
TMCH_CLAIM: "tmch_claim",
|
|
494
|
+
ERROR: "error",
|
|
495
|
+
} as const satisfies Record<string, DomainAvailabilityStatus>;
|
|
496
|
+
|
|
497
|
+
/**
|
|
498
|
+
* Array of all DomainAvailabilityStatus enum values
|
|
499
|
+
*
|
|
500
|
+
* @remarks
|
|
501
|
+
* This constant provides a array containing all valid DomainAvailabilityStatus enum values.
|
|
502
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
503
|
+
*
|
|
504
|
+
* @example
|
|
505
|
+
* ```typescript
|
|
506
|
+
* // Iterating through all values
|
|
507
|
+
* for (const value of DOMAIN_AVAILABILITY_STATUS_VALUES) {
|
|
508
|
+
* console.log(`Processing: ${value}`);
|
|
509
|
+
* }
|
|
510
|
+
*
|
|
511
|
+
* // Validation
|
|
512
|
+
* const isValid = DOMAIN_AVAILABILITY_STATUS_VALUES.includes(someValue);
|
|
513
|
+
* ```
|
|
514
|
+
*
|
|
515
|
+
* @see {@link DomainAvailabilityStatus} - The TypeScript type definition
|
|
516
|
+
* @see {@link DOMAIN_AVAILABILITY_STATUS} - The object form of this enum
|
|
517
|
+
*/
|
|
518
|
+
export const DOMAIN_AVAILABILITY_STATUS_VALUES = [
|
|
519
|
+
'available',
|
|
520
|
+
'unavailable',
|
|
521
|
+
'market_available',
|
|
522
|
+
'tmch_claim',
|
|
523
|
+
'error'
|
|
524
|
+
] as const satisfies [string, ...string[]] | DomainAvailabilityStatus[];
|
|
525
|
+
|
|
526
|
+
/**
|
|
527
|
+
* DomainClientStatus. Auto-generated enum for DomainClientStatus
|
|
528
|
+
*
|
|
529
|
+
* @remarks
|
|
530
|
+
* This constant provides both object and array forms for the DomainClientStatus enum.
|
|
531
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
532
|
+
*
|
|
533
|
+
* @example
|
|
534
|
+
* ```typescript
|
|
535
|
+
* // Using the object form for key-value access
|
|
536
|
+
* const status = DOMAIN_CLIENT_STATUS.SUCCESS;
|
|
537
|
+
*
|
|
538
|
+
* // Using the array form for iteration
|
|
539
|
+
* const allStatuses = DOMAIN_CLIENT_STATUS_VALUES;
|
|
540
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
541
|
+
* ```
|
|
542
|
+
*
|
|
543
|
+
* @see {@link DomainClientStatus} - The TypeScript type definition
|
|
544
|
+
*/
|
|
545
|
+
export const DOMAIN_CLIENT_STATUS = {
|
|
546
|
+
CLIENT_TRANSFER_PROHIBITED: "clientTransferProhibited",
|
|
547
|
+
CLIENT_UPDATE_PROHIBITED: "clientUpdateProhibited",
|
|
548
|
+
CLIENT_DELETE_PROHIBITED: "clientDeleteProhibited",
|
|
549
|
+
CLIENT_RENEW_PROHIBITED: "clientRenewProhibited",
|
|
550
|
+
CLIENT_HOLD: "clientHold",
|
|
551
|
+
} as const satisfies Record<string, DomainClientStatus>;
|
|
552
|
+
|
|
553
|
+
/**
|
|
554
|
+
* Array of all DomainClientStatus enum values
|
|
555
|
+
*
|
|
556
|
+
* @remarks
|
|
557
|
+
* This constant provides a array containing all valid DomainClientStatus enum values.
|
|
558
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
559
|
+
*
|
|
560
|
+
* @example
|
|
561
|
+
* ```typescript
|
|
562
|
+
* // Iterating through all values
|
|
563
|
+
* for (const value of DOMAIN_CLIENT_STATUS_VALUES) {
|
|
564
|
+
* console.log(`Processing: ${value}`);
|
|
565
|
+
* }
|
|
566
|
+
*
|
|
567
|
+
* // Validation
|
|
568
|
+
* const isValid = DOMAIN_CLIENT_STATUS_VALUES.includes(someValue);
|
|
569
|
+
* ```
|
|
570
|
+
*
|
|
571
|
+
* @see {@link DomainClientStatus} - The TypeScript type definition
|
|
572
|
+
* @see {@link DOMAIN_CLIENT_STATUS} - The object form of this enum
|
|
573
|
+
*/
|
|
574
|
+
export const DOMAIN_CLIENT_STATUS_VALUES = [
|
|
575
|
+
'clientTransferProhibited',
|
|
576
|
+
'clientUpdateProhibited',
|
|
577
|
+
'clientDeleteProhibited',
|
|
578
|
+
'clientRenewProhibited',
|
|
579
|
+
'clientHold'
|
|
580
|
+
] as const satisfies [string, ...string[]] | DomainClientStatus[];
|
|
581
|
+
|
|
582
|
+
/**
|
|
583
|
+
* DomainContactType. Auto-generated enum for DomainContactType
|
|
584
|
+
*
|
|
585
|
+
* @remarks
|
|
586
|
+
* This constant provides both object and array forms for the DomainContactType enum.
|
|
587
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
588
|
+
*
|
|
589
|
+
* @example
|
|
590
|
+
* ```typescript
|
|
591
|
+
* // Using the object form for key-value access
|
|
592
|
+
* const status = DOMAIN_CONTACT_TYPE.SUCCESS;
|
|
593
|
+
*
|
|
594
|
+
* // Using the array form for iteration
|
|
595
|
+
* const allStatuses = DOMAIN_CONTACT_TYPE_VALUES;
|
|
596
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
597
|
+
* ```
|
|
598
|
+
*
|
|
599
|
+
* @see {@link DomainContactType} - The TypeScript type definition
|
|
600
|
+
*/
|
|
601
|
+
export const DOMAIN_CONTACT_TYPE = {
|
|
602
|
+
REGISTRANT: "registrant",
|
|
603
|
+
ADMIN: "admin",
|
|
604
|
+
TECH: "tech",
|
|
605
|
+
BILLING: "billing",
|
|
606
|
+
} as const satisfies Record<string, DomainContactType>;
|
|
607
|
+
|
|
608
|
+
/**
|
|
609
|
+
* Array of all DomainContactType enum values
|
|
610
|
+
*
|
|
611
|
+
* @remarks
|
|
612
|
+
* This constant provides a array containing all valid DomainContactType enum values.
|
|
613
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
614
|
+
*
|
|
615
|
+
* @example
|
|
616
|
+
* ```typescript
|
|
617
|
+
* // Iterating through all values
|
|
618
|
+
* for (const value of DOMAIN_CONTACT_TYPE_VALUES) {
|
|
619
|
+
* console.log(`Processing: ${value}`);
|
|
620
|
+
* }
|
|
621
|
+
*
|
|
622
|
+
* // Validation
|
|
623
|
+
* const isValid = DOMAIN_CONTACT_TYPE_VALUES.includes(someValue);
|
|
624
|
+
* ```
|
|
625
|
+
*
|
|
626
|
+
* @see {@link DomainContactType} - The TypeScript type definition
|
|
627
|
+
* @see {@link DOMAIN_CONTACT_TYPE} - The object form of this enum
|
|
628
|
+
*/
|
|
629
|
+
export const DOMAIN_CONTACT_TYPE_VALUES = [
|
|
630
|
+
'registrant',
|
|
631
|
+
'admin',
|
|
632
|
+
'tech',
|
|
633
|
+
'billing'
|
|
634
|
+
] as const satisfies [string, ...string[]] | DomainContactType[];
|
|
635
|
+
|
|
636
|
+
/**
|
|
637
|
+
* DomainSortField. Auto-generated enum for DomainSortField
|
|
638
|
+
*
|
|
639
|
+
* @remarks
|
|
640
|
+
* This constant provides both object and array forms for the DomainSortField enum.
|
|
641
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
642
|
+
*
|
|
643
|
+
* @example
|
|
644
|
+
* ```typescript
|
|
645
|
+
* // Using the object form for key-value access
|
|
646
|
+
* const status = DOMAIN_SORT_FIELD.SUCCESS;
|
|
647
|
+
*
|
|
648
|
+
* // Using the array form for iteration
|
|
649
|
+
* const allStatuses = DOMAIN_SORT_FIELD_VALUES;
|
|
650
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
651
|
+
* ```
|
|
652
|
+
*
|
|
653
|
+
* @see {@link DomainSortField} - The TypeScript type definition
|
|
654
|
+
*/
|
|
655
|
+
export const DOMAIN_SORT_FIELD = {
|
|
656
|
+
NAME: "name",
|
|
657
|
+
CREATED_ON: "created_on",
|
|
658
|
+
UPDATED_ON: "updated_on",
|
|
659
|
+
EXPIRES_ON: "expires_on",
|
|
660
|
+
REGISTERED_ON: "registered_on",
|
|
661
|
+
} as const satisfies Record<string, DomainSortField>;
|
|
662
|
+
|
|
663
|
+
/**
|
|
664
|
+
* Array of all DomainSortField enum values
|
|
665
|
+
*
|
|
666
|
+
* @remarks
|
|
667
|
+
* This constant provides a array containing all valid DomainSortField enum values.
|
|
668
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
669
|
+
*
|
|
670
|
+
* @example
|
|
671
|
+
* ```typescript
|
|
672
|
+
* // Iterating through all values
|
|
673
|
+
* for (const value of DOMAIN_SORT_FIELD_VALUES) {
|
|
674
|
+
* console.log(`Processing: ${value}`);
|
|
675
|
+
* }
|
|
676
|
+
*
|
|
677
|
+
* // Validation
|
|
678
|
+
* const isValid = DOMAIN_SORT_FIELD_VALUES.includes(someValue);
|
|
679
|
+
* ```
|
|
680
|
+
*
|
|
681
|
+
* @see {@link DomainSortField} - The TypeScript type definition
|
|
682
|
+
* @see {@link DOMAIN_SORT_FIELD} - The object form of this enum
|
|
683
|
+
*/
|
|
684
|
+
export const DOMAIN_SORT_FIELD_VALUES = [
|
|
685
|
+
'name',
|
|
686
|
+
'created_on',
|
|
687
|
+
'updated_on',
|
|
688
|
+
'expires_on',
|
|
689
|
+
'registered_on'
|
|
690
|
+
] as const satisfies [string, ...string[]] | DomainSortField[];
|
|
691
|
+
|
|
692
|
+
/**
|
|
693
|
+
* DomainStatus. Auto-generated enum for DomainStatus
|
|
694
|
+
*
|
|
695
|
+
* @remarks
|
|
696
|
+
* This constant provides both object and array forms for the DomainStatus enum.
|
|
697
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
698
|
+
*
|
|
699
|
+
* @example
|
|
700
|
+
* ```typescript
|
|
701
|
+
* // Using the object form for key-value access
|
|
702
|
+
* const status = DOMAIN_STATUS.SUCCESS;
|
|
703
|
+
*
|
|
704
|
+
* // Using the array form for iteration
|
|
705
|
+
* const allStatuses = DOMAIN_STATUS_VALUES;
|
|
706
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
707
|
+
* ```
|
|
708
|
+
*
|
|
709
|
+
* @see {@link DomainStatus} - The TypeScript type definition
|
|
710
|
+
*/
|
|
711
|
+
export const DOMAIN_STATUS = {
|
|
712
|
+
OK: "ok",
|
|
713
|
+
SERVER_TRANSFER_PROHIBITED: "serverTransferProhibited",
|
|
714
|
+
SERVER_UPDATE_PROHIBITED: "serverUpdateProhibited",
|
|
715
|
+
SERVER_DELETE_PROHIBITED: "serverDeleteProhibited",
|
|
716
|
+
SERVER_RENEW_PROHIBITED: "serverRenewProhibited",
|
|
717
|
+
SERVER_HOLD: "serverHold",
|
|
718
|
+
TRANSFER_PERIOD: "transferPeriod",
|
|
719
|
+
RENEW_PERIOD: "renewPeriod",
|
|
720
|
+
REDEMPTION_PERIOD: "redemptionPeriod",
|
|
721
|
+
PENDING_UPDATE: "pendingUpdate",
|
|
722
|
+
PENDING_TRANSFER: "pendingTransfer",
|
|
723
|
+
PENDING_RESTORE: "pendingRestore",
|
|
724
|
+
PENDING_RENEW: "pendingRenew",
|
|
725
|
+
PENDING_DELETE: "pendingDelete",
|
|
726
|
+
PENDING_CREATE: "pendingCreate",
|
|
727
|
+
INACTIVE: "inactive",
|
|
728
|
+
AUTO_RENEW_PERIOD: "autoRenewPeriod",
|
|
729
|
+
ADD_PERIOD: "addPeriod",
|
|
730
|
+
DELETED: "deleted",
|
|
731
|
+
CLIENT_TRANSFER_PROHIBITED: "clientTransferProhibited",
|
|
732
|
+
CLIENT_UPDATE_PROHIBITED: "clientUpdateProhibited",
|
|
733
|
+
CLIENT_DELETE_PROHIBITED: "clientDeleteProhibited",
|
|
734
|
+
CLIENT_RENEW_PROHIBITED: "clientRenewProhibited",
|
|
735
|
+
CLIENT_HOLD: "clientHold",
|
|
736
|
+
} as const satisfies Record<string, DomainStatus>;
|
|
737
|
+
|
|
738
|
+
/**
|
|
739
|
+
* Array of all DomainStatus enum values
|
|
740
|
+
*
|
|
741
|
+
* @remarks
|
|
742
|
+
* This constant provides a array containing all valid DomainStatus enum values.
|
|
743
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
744
|
+
*
|
|
745
|
+
* @example
|
|
746
|
+
* ```typescript
|
|
747
|
+
* // Iterating through all values
|
|
748
|
+
* for (const value of DOMAIN_STATUS_VALUES) {
|
|
749
|
+
* console.log(`Processing: ${value}`);
|
|
750
|
+
* }
|
|
751
|
+
*
|
|
752
|
+
* // Validation
|
|
753
|
+
* const isValid = DOMAIN_STATUS_VALUES.includes(someValue);
|
|
754
|
+
* ```
|
|
755
|
+
*
|
|
756
|
+
* @see {@link DomainStatus} - The TypeScript type definition
|
|
757
|
+
* @see {@link DOMAIN_STATUS} - The object form of this enum
|
|
758
|
+
*/
|
|
759
|
+
export const DOMAIN_STATUS_VALUES = [
|
|
760
|
+
'ok',
|
|
761
|
+
'serverTransferProhibited',
|
|
762
|
+
'serverUpdateProhibited',
|
|
763
|
+
'serverDeleteProhibited',
|
|
764
|
+
'serverRenewProhibited',
|
|
765
|
+
'serverHold',
|
|
766
|
+
'transferPeriod',
|
|
767
|
+
'renewPeriod',
|
|
768
|
+
'redemptionPeriod',
|
|
769
|
+
'pendingUpdate',
|
|
770
|
+
'pendingTransfer',
|
|
771
|
+
'pendingRestore',
|
|
772
|
+
'pendingRenew',
|
|
773
|
+
'pendingDelete',
|
|
774
|
+
'pendingCreate',
|
|
775
|
+
'inactive',
|
|
776
|
+
'autoRenewPeriod',
|
|
777
|
+
'addPeriod',
|
|
778
|
+
'deleted',
|
|
779
|
+
'clientTransferProhibited',
|
|
780
|
+
'clientUpdateProhibited',
|
|
781
|
+
'clientDeleteProhibited',
|
|
782
|
+
'clientRenewProhibited',
|
|
783
|
+
'clientHold'
|
|
784
|
+
] as const satisfies [string, ...string[]] | DomainStatus[];
|
|
785
|
+
|
|
786
|
+
/**
|
|
787
|
+
* EmailForwardStatus. Auto-generated enum for EmailForwardStatus
|
|
788
|
+
*
|
|
789
|
+
* @remarks
|
|
790
|
+
* This constant provides both object and array forms for the EmailForwardStatus enum.
|
|
791
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
792
|
+
*
|
|
793
|
+
* @example
|
|
794
|
+
* ```typescript
|
|
795
|
+
* // Using the object form for key-value access
|
|
796
|
+
* const status = EMAIL_FORWARD_STATUS.SUCCESS;
|
|
797
|
+
*
|
|
798
|
+
* // Using the array form for iteration
|
|
799
|
+
* const allStatuses = EMAIL_FORWARD_STATUS_VALUES;
|
|
800
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
801
|
+
* ```
|
|
802
|
+
*
|
|
803
|
+
* @see {@link EmailForwardStatus} - The TypeScript type definition
|
|
804
|
+
*/
|
|
805
|
+
export const EMAIL_FORWARD_STATUS = {
|
|
806
|
+
ACTIVE: "active",
|
|
807
|
+
INACTIVE: "inactive",
|
|
808
|
+
} as const satisfies Record<string, EmailForwardStatus>;
|
|
809
|
+
|
|
810
|
+
/**
|
|
811
|
+
* Array of all EmailForwardStatus enum values
|
|
812
|
+
*
|
|
813
|
+
* @remarks
|
|
814
|
+
* This constant provides a array containing all valid EmailForwardStatus enum values.
|
|
815
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
816
|
+
*
|
|
817
|
+
* @example
|
|
818
|
+
* ```typescript
|
|
819
|
+
* // Iterating through all values
|
|
820
|
+
* for (const value of EMAIL_FORWARD_STATUS_VALUES) {
|
|
821
|
+
* console.log(`Processing: ${value}`);
|
|
822
|
+
* }
|
|
823
|
+
*
|
|
824
|
+
* // Validation
|
|
825
|
+
* const isValid = EMAIL_FORWARD_STATUS_VALUES.includes(someValue);
|
|
826
|
+
* ```
|
|
827
|
+
*
|
|
828
|
+
* @see {@link EmailForwardStatus} - The TypeScript type definition
|
|
829
|
+
* @see {@link EMAIL_FORWARD_STATUS} - The object form of this enum
|
|
830
|
+
*/
|
|
831
|
+
export const EMAIL_FORWARD_STATUS_VALUES = [
|
|
832
|
+
'active',
|
|
833
|
+
'inactive'
|
|
834
|
+
] as const satisfies [string, ...string[]] | EmailForwardStatus[];
|
|
835
|
+
|
|
836
|
+
/**
|
|
837
|
+
* EmailVerificationStatus. Auto-generated enum for EmailVerificationStatus
|
|
838
|
+
*
|
|
839
|
+
* @remarks
|
|
840
|
+
* This constant provides both object and array forms for the EmailVerificationStatus enum.
|
|
841
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
842
|
+
*
|
|
843
|
+
* @example
|
|
844
|
+
* ```typescript
|
|
845
|
+
* // Using the object form for key-value access
|
|
846
|
+
* const status = EMAIL_VERIFICATION_STATUS.SUCCESS;
|
|
847
|
+
*
|
|
848
|
+
* // Using the array form for iteration
|
|
849
|
+
* const allStatuses = EMAIL_VERIFICATION_STATUS_VALUES;
|
|
850
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
851
|
+
* ```
|
|
852
|
+
*
|
|
853
|
+
* @see {@link EmailVerificationStatus} - The TypeScript type definition
|
|
854
|
+
*/
|
|
855
|
+
export const EMAIL_VERIFICATION_STATUS = {
|
|
856
|
+
VERIFIED: "verified",
|
|
857
|
+
PENDING: "pending",
|
|
858
|
+
CANCELED: "canceled",
|
|
859
|
+
} as const satisfies Record<string, EmailVerificationStatus>;
|
|
860
|
+
|
|
861
|
+
/**
|
|
862
|
+
* Array of all EmailVerificationStatus enum values
|
|
863
|
+
*
|
|
864
|
+
* @remarks
|
|
865
|
+
* This constant provides a array containing all valid EmailVerificationStatus enum values.
|
|
866
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
867
|
+
*
|
|
868
|
+
* @example
|
|
869
|
+
* ```typescript
|
|
870
|
+
* // Iterating through all values
|
|
871
|
+
* for (const value of EMAIL_VERIFICATION_STATUS_VALUES) {
|
|
872
|
+
* console.log(`Processing: ${value}`);
|
|
873
|
+
* }
|
|
874
|
+
*
|
|
875
|
+
* // Validation
|
|
876
|
+
* const isValid = EMAIL_VERIFICATION_STATUS_VALUES.includes(someValue);
|
|
877
|
+
* ```
|
|
878
|
+
*
|
|
879
|
+
* @see {@link EmailVerificationStatus} - The TypeScript type definition
|
|
880
|
+
* @see {@link EMAIL_VERIFICATION_STATUS} - The object form of this enum
|
|
881
|
+
*/
|
|
882
|
+
export const EMAIL_VERIFICATION_STATUS_VALUES = [
|
|
883
|
+
'verified',
|
|
884
|
+
'pending',
|
|
885
|
+
'canceled'
|
|
886
|
+
] as const satisfies [string, ...string[]] | EmailVerificationStatus[];
|
|
887
|
+
|
|
888
|
+
/**
|
|
889
|
+
* EventObjectType. Auto-generated enum for EventObjectType
|
|
890
|
+
*
|
|
891
|
+
* @remarks
|
|
892
|
+
* This constant provides both object and array forms for the EventObjectType enum.
|
|
893
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
894
|
+
*
|
|
895
|
+
* @example
|
|
896
|
+
* ```typescript
|
|
897
|
+
* // Using the object form for key-value access
|
|
898
|
+
* const status = EVENT_OBJECT_TYPE.SUCCESS;
|
|
899
|
+
*
|
|
900
|
+
* // Using the array form for iteration
|
|
901
|
+
* const allStatuses = EVENT_OBJECT_TYPE_VALUES;
|
|
902
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
903
|
+
* ```
|
|
904
|
+
*
|
|
905
|
+
* @see {@link EventObjectType} - The TypeScript type definition
|
|
906
|
+
*/
|
|
907
|
+
export const EVENT_OBJECT_TYPE = {
|
|
908
|
+
DOMAIN: "DOMAIN",
|
|
909
|
+
CONTACT: "CONTACT",
|
|
910
|
+
HOST: "HOST",
|
|
911
|
+
RAW: "RAW",
|
|
912
|
+
UNKNOWN: "UNKNOWN",
|
|
913
|
+
} as const satisfies Record<string, EventObjectType>;
|
|
914
|
+
|
|
915
|
+
/**
|
|
916
|
+
* Array of all EventObjectType enum values
|
|
917
|
+
*
|
|
918
|
+
* @remarks
|
|
919
|
+
* This constant provides a array containing all valid EventObjectType enum values.
|
|
920
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
921
|
+
*
|
|
922
|
+
* @example
|
|
923
|
+
* ```typescript
|
|
924
|
+
* // Iterating through all values
|
|
925
|
+
* for (const value of EVENT_OBJECT_TYPE_VALUES) {
|
|
926
|
+
* console.log(`Processing: ${value}`);
|
|
927
|
+
* }
|
|
928
|
+
*
|
|
929
|
+
* // Validation
|
|
930
|
+
* const isValid = EVENT_OBJECT_TYPE_VALUES.includes(someValue);
|
|
931
|
+
* ```
|
|
932
|
+
*
|
|
933
|
+
* @see {@link EventObjectType} - The TypeScript type definition
|
|
934
|
+
* @see {@link EVENT_OBJECT_TYPE} - The object form of this enum
|
|
935
|
+
*/
|
|
936
|
+
export const EVENT_OBJECT_TYPE_VALUES = [
|
|
937
|
+
'DOMAIN',
|
|
938
|
+
'CONTACT',
|
|
939
|
+
'HOST',
|
|
940
|
+
'RAW',
|
|
941
|
+
'UNKNOWN'
|
|
942
|
+
] as const satisfies [string, ...string[]] | EventObjectType[];
|
|
943
|
+
|
|
944
|
+
/**
|
|
945
|
+
* EventSubtype. Auto-generated enum for EventSubtype
|
|
946
|
+
*
|
|
947
|
+
* @remarks
|
|
948
|
+
* This constant provides both object and array forms for the EventSubtype enum.
|
|
949
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
950
|
+
*
|
|
951
|
+
* @example
|
|
952
|
+
* ```typescript
|
|
953
|
+
* // Using the object form for key-value access
|
|
954
|
+
* const status = EVENT_SUBTYPE.SUCCESS;
|
|
955
|
+
*
|
|
956
|
+
* // Using the array form for iteration
|
|
957
|
+
* const allStatuses = EVENT_SUBTYPE_VALUES;
|
|
958
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
959
|
+
* ```
|
|
960
|
+
*
|
|
961
|
+
* @see {@link EventSubtype} - The TypeScript type definition
|
|
962
|
+
*/
|
|
963
|
+
export const EVENT_SUBTYPE = {
|
|
964
|
+
NOTIFICATION: "NOTIFICATION",
|
|
965
|
+
SUCCESS: "SUCCESS",
|
|
966
|
+
FAILURE: "FAILURE",
|
|
967
|
+
CANCELED: "CANCELED",
|
|
968
|
+
} as const satisfies Record<string, EventSubtype>;
|
|
969
|
+
|
|
970
|
+
/**
|
|
971
|
+
* Array of all EventSubtype enum values
|
|
972
|
+
*
|
|
973
|
+
* @remarks
|
|
974
|
+
* This constant provides a array containing all valid EventSubtype enum values.
|
|
975
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
976
|
+
*
|
|
977
|
+
* @example
|
|
978
|
+
* ```typescript
|
|
979
|
+
* // Iterating through all values
|
|
980
|
+
* for (const value of EVENT_SUBTYPE_VALUES) {
|
|
981
|
+
* console.log(`Processing: ${value}`);
|
|
982
|
+
* }
|
|
983
|
+
*
|
|
984
|
+
* // Validation
|
|
985
|
+
* const isValid = EVENT_SUBTYPE_VALUES.includes(someValue);
|
|
986
|
+
* ```
|
|
987
|
+
*
|
|
988
|
+
* @see {@link EventSubtype} - The TypeScript type definition
|
|
989
|
+
* @see {@link EVENT_SUBTYPE} - The object form of this enum
|
|
990
|
+
*/
|
|
991
|
+
export const EVENT_SUBTYPE_VALUES = [
|
|
992
|
+
'NOTIFICATION',
|
|
993
|
+
'SUCCESS',
|
|
994
|
+
'FAILURE',
|
|
995
|
+
'CANCELED'
|
|
996
|
+
] as const satisfies [string, ...string[]] | EventSubtype[];
|
|
997
|
+
|
|
998
|
+
/**
|
|
999
|
+
* EventType. Auto-generated enum for EventType
|
|
1000
|
+
*
|
|
1001
|
+
* @remarks
|
|
1002
|
+
* This constant provides both object and array forms for the EventType enum.
|
|
1003
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
1004
|
+
*
|
|
1005
|
+
* @example
|
|
1006
|
+
* ```typescript
|
|
1007
|
+
* // Using the object form for key-value access
|
|
1008
|
+
* const status = EVENT_TYPE.SUCCESS;
|
|
1009
|
+
*
|
|
1010
|
+
* // Using the array form for iteration
|
|
1011
|
+
* const allStatuses = EVENT_TYPE_VALUES;
|
|
1012
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
1013
|
+
* ```
|
|
1014
|
+
*
|
|
1015
|
+
* @see {@link EventType} - The TypeScript type definition
|
|
1016
|
+
*/
|
|
1017
|
+
export const EVENT_TYPE = {
|
|
1018
|
+
REGISTRATION: "REGISTRATION",
|
|
1019
|
+
RENEWAL: "RENEWAL",
|
|
1020
|
+
MODIFICATION: "MODIFICATION",
|
|
1021
|
+
DELETION: "DELETION",
|
|
1022
|
+
INBOUND_TRANSFER: "INBOUND_TRANSFER",
|
|
1023
|
+
OUTBOUND_TRANSFER: "OUTBOUND_TRANSFER",
|
|
1024
|
+
} as const satisfies Record<string, EventType>;
|
|
1025
|
+
|
|
1026
|
+
/**
|
|
1027
|
+
* Array of all EventType enum values
|
|
1028
|
+
*
|
|
1029
|
+
* @remarks
|
|
1030
|
+
* This constant provides a array containing all valid EventType enum values.
|
|
1031
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1032
|
+
*
|
|
1033
|
+
* @example
|
|
1034
|
+
* ```typescript
|
|
1035
|
+
* // Iterating through all values
|
|
1036
|
+
* for (const value of EVENT_TYPE_VALUES) {
|
|
1037
|
+
* console.log(`Processing: ${value}`);
|
|
1038
|
+
* }
|
|
1039
|
+
*
|
|
1040
|
+
* // Validation
|
|
1041
|
+
* const isValid = EVENT_TYPE_VALUES.includes(someValue);
|
|
1042
|
+
* ```
|
|
1043
|
+
*
|
|
1044
|
+
* @see {@link EventType} - The TypeScript type definition
|
|
1045
|
+
* @see {@link EVENT_TYPE} - The object form of this enum
|
|
1046
|
+
*/
|
|
1047
|
+
export const EVENT_TYPE_VALUES = [
|
|
1048
|
+
'REGISTRATION',
|
|
1049
|
+
'RENEWAL',
|
|
1050
|
+
'MODIFICATION',
|
|
1051
|
+
'DELETION',
|
|
1052
|
+
'INBOUND_TRANSFER',
|
|
1053
|
+
'OUTBOUND_TRANSFER'
|
|
1054
|
+
] as const satisfies [string, ...string[]] | EventType[];
|
|
1055
|
+
|
|
1056
|
+
/**
|
|
1057
|
+
* GrantType. Auto-generated enum for GrantType
|
|
1058
|
+
*
|
|
1059
|
+
* @remarks
|
|
1060
|
+
* This constant provides both object and array forms for the GrantType enum.
|
|
1061
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
1062
|
+
*
|
|
1063
|
+
* @example
|
|
1064
|
+
* ```typescript
|
|
1065
|
+
* // Using the object form for key-value access
|
|
1066
|
+
* const status = GRANT_TYPE.SUCCESS;
|
|
1067
|
+
*
|
|
1068
|
+
* // Using the array form for iteration
|
|
1069
|
+
* const allStatuses = GRANT_TYPE_VALUES;
|
|
1070
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
1071
|
+
* ```
|
|
1072
|
+
*
|
|
1073
|
+
* @see {@link GrantType} - The TypeScript type definition
|
|
1074
|
+
*/
|
|
1075
|
+
export const GRANT_TYPE = {
|
|
1076
|
+
CLIENT_CREDENTIALS: "client_credentials",
|
|
1077
|
+
PASSWORD: "password",
|
|
1078
|
+
REFRESH_TOKEN: "refresh_token",
|
|
1079
|
+
} as const satisfies Record<string, GrantType>;
|
|
1080
|
+
|
|
1081
|
+
/**
|
|
1082
|
+
* Array of all GrantType enum values
|
|
1083
|
+
*
|
|
1084
|
+
* @remarks
|
|
1085
|
+
* This constant provides a array containing all valid GrantType enum values.
|
|
1086
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1087
|
+
*
|
|
1088
|
+
* @example
|
|
1089
|
+
* ```typescript
|
|
1090
|
+
* // Iterating through all values
|
|
1091
|
+
* for (const value of GRANT_TYPE_VALUES) {
|
|
1092
|
+
* console.log(`Processing: ${value}`);
|
|
1093
|
+
* }
|
|
1094
|
+
*
|
|
1095
|
+
* // Validation
|
|
1096
|
+
* const isValid = GRANT_TYPE_VALUES.includes(someValue);
|
|
1097
|
+
* ```
|
|
1098
|
+
*
|
|
1099
|
+
* @see {@link GrantType} - The TypeScript type definition
|
|
1100
|
+
* @see {@link GRANT_TYPE} - The object form of this enum
|
|
1101
|
+
*/
|
|
1102
|
+
export const GRANT_TYPE_VALUES = [
|
|
1103
|
+
'client_credentials',
|
|
1104
|
+
'password',
|
|
1105
|
+
'refresh_token'
|
|
1106
|
+
] as const satisfies [string, ...string[]] | GrantType[];
|
|
1107
|
+
|
|
1108
|
+
/**
|
|
1109
|
+
* OrganizationCredentialStatus. Auto-generated enum for OrganizationCredentialStatus
|
|
1110
|
+
*
|
|
1111
|
+
* @remarks
|
|
1112
|
+
* This constant provides both object and array forms for the OrganizationCredentialStatus enum.
|
|
1113
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
1114
|
+
*
|
|
1115
|
+
* @example
|
|
1116
|
+
* ```typescript
|
|
1117
|
+
* // Using the object form for key-value access
|
|
1118
|
+
* const status = ORGANIZATION_CREDENTIAL_STATUS.SUCCESS;
|
|
1119
|
+
*
|
|
1120
|
+
* // Using the array form for iteration
|
|
1121
|
+
* const allStatuses = ORGANIZATION_CREDENTIAL_STATUS_VALUES;
|
|
1122
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
1123
|
+
* ```
|
|
1124
|
+
*
|
|
1125
|
+
* @see {@link OrganizationCredentialStatus} - The TypeScript type definition
|
|
1126
|
+
*/
|
|
1127
|
+
export const ORGANIZATION_CREDENTIAL_STATUS = {
|
|
1128
|
+
ACTIVE: "active",
|
|
1129
|
+
REVOKED: "revoked",
|
|
1130
|
+
} as const satisfies Record<string, OrganizationCredentialStatus>;
|
|
1131
|
+
|
|
1132
|
+
/**
|
|
1133
|
+
* Array of all OrganizationCredentialStatus enum values
|
|
1134
|
+
*
|
|
1135
|
+
* @remarks
|
|
1136
|
+
* This constant provides a array containing all valid OrganizationCredentialStatus enum values.
|
|
1137
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1138
|
+
*
|
|
1139
|
+
* @example
|
|
1140
|
+
* ```typescript
|
|
1141
|
+
* // Iterating through all values
|
|
1142
|
+
* for (const value of ORGANIZATION_CREDENTIAL_STATUS_VALUES) {
|
|
1143
|
+
* console.log(`Processing: ${value}`);
|
|
1144
|
+
* }
|
|
1145
|
+
*
|
|
1146
|
+
* // Validation
|
|
1147
|
+
* const isValid = ORGANIZATION_CREDENTIAL_STATUS_VALUES.includes(someValue);
|
|
1148
|
+
* ```
|
|
1149
|
+
*
|
|
1150
|
+
* @see {@link OrganizationCredentialStatus} - The TypeScript type definition
|
|
1151
|
+
* @see {@link ORGANIZATION_CREDENTIAL_STATUS} - The object form of this enum
|
|
1152
|
+
*/
|
|
1153
|
+
export const ORGANIZATION_CREDENTIAL_STATUS_VALUES = [
|
|
1154
|
+
'active',
|
|
1155
|
+
'revoked'
|
|
1156
|
+
] as const satisfies [string, ...string[]] | OrganizationCredentialStatus[];
|
|
1157
|
+
|
|
1158
|
+
/**
|
|
1159
|
+
* OrganizationStatus. Auto-generated enum for OrganizationStatus
|
|
1160
|
+
*
|
|
1161
|
+
* @remarks
|
|
1162
|
+
* This constant provides both object and array forms for the OrganizationStatus enum.
|
|
1163
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
1164
|
+
*
|
|
1165
|
+
* @example
|
|
1166
|
+
* ```typescript
|
|
1167
|
+
* // Using the object form for key-value access
|
|
1168
|
+
* const status = ORGANIZATION_STATUS.SUCCESS;
|
|
1169
|
+
*
|
|
1170
|
+
* // Using the array form for iteration
|
|
1171
|
+
* const allStatuses = ORGANIZATION_STATUS_VALUES;
|
|
1172
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
1173
|
+
* ```
|
|
1174
|
+
*
|
|
1175
|
+
* @see {@link OrganizationStatus} - The TypeScript type definition
|
|
1176
|
+
*/
|
|
1177
|
+
export const ORGANIZATION_STATUS = {
|
|
1178
|
+
ACTIVE: "active",
|
|
1179
|
+
INACTIVE: "inactive",
|
|
1180
|
+
} as const satisfies Record<string, OrganizationStatus>;
|
|
1181
|
+
|
|
1182
|
+
/**
|
|
1183
|
+
* Array of all OrganizationStatus enum values
|
|
1184
|
+
*
|
|
1185
|
+
* @remarks
|
|
1186
|
+
* This constant provides a array containing all valid OrganizationStatus enum values.
|
|
1187
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1188
|
+
*
|
|
1189
|
+
* @example
|
|
1190
|
+
* ```typescript
|
|
1191
|
+
* // Iterating through all values
|
|
1192
|
+
* for (const value of ORGANIZATION_STATUS_VALUES) {
|
|
1193
|
+
* console.log(`Processing: ${value}`);
|
|
1194
|
+
* }
|
|
1195
|
+
*
|
|
1196
|
+
* // Validation
|
|
1197
|
+
* const isValid = ORGANIZATION_STATUS_VALUES.includes(someValue);
|
|
1198
|
+
* ```
|
|
1199
|
+
*
|
|
1200
|
+
* @see {@link OrganizationStatus} - The TypeScript type definition
|
|
1201
|
+
* @see {@link ORGANIZATION_STATUS} - The object form of this enum
|
|
1202
|
+
*/
|
|
1203
|
+
export const ORGANIZATION_STATUS_VALUES = [
|
|
1204
|
+
'active',
|
|
1205
|
+
'inactive'
|
|
1206
|
+
] as const satisfies [string, ...string[]] | OrganizationStatus[];
|
|
1207
|
+
|
|
1208
|
+
/**
|
|
1209
|
+
* PatchOp. Auto-generated enum for PatchOp
|
|
1210
|
+
*
|
|
1211
|
+
* @remarks
|
|
1212
|
+
* This constant provides both object and array forms for the PatchOp enum.
|
|
1213
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
1214
|
+
*
|
|
1215
|
+
* @example
|
|
1216
|
+
* ```typescript
|
|
1217
|
+
* // Using the object form for key-value access
|
|
1218
|
+
* const status = PATCH_OP.SUCCESS;
|
|
1219
|
+
*
|
|
1220
|
+
* // Using the array form for iteration
|
|
1221
|
+
* const allStatuses = PATCH_OP_VALUES;
|
|
1222
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
1223
|
+
* ```
|
|
1224
|
+
*
|
|
1225
|
+
* @see {@link PatchOp} - The TypeScript type definition
|
|
1226
|
+
*/
|
|
1227
|
+
export const PATCH_OP = {
|
|
1228
|
+
UPSERT: "upsert",
|
|
1229
|
+
REMOVE: "remove",
|
|
1230
|
+
} as const satisfies Record<string, PatchOp>;
|
|
1231
|
+
|
|
1232
|
+
/**
|
|
1233
|
+
* Array of all PatchOp enum values
|
|
1234
|
+
*
|
|
1235
|
+
* @remarks
|
|
1236
|
+
* This constant provides a array containing all valid PatchOp enum values.
|
|
1237
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1238
|
+
*
|
|
1239
|
+
* @example
|
|
1240
|
+
* ```typescript
|
|
1241
|
+
* // Iterating through all values
|
|
1242
|
+
* for (const value of PATCH_OP_VALUES) {
|
|
1243
|
+
* console.log(`Processing: ${value}`);
|
|
1244
|
+
* }
|
|
1245
|
+
*
|
|
1246
|
+
* // Validation
|
|
1247
|
+
* const isValid = PATCH_OP_VALUES.includes(someValue);
|
|
1248
|
+
* ```
|
|
1249
|
+
*
|
|
1250
|
+
* @see {@link PatchOp} - The TypeScript type definition
|
|
1251
|
+
* @see {@link PATCH_OP} - The object form of this enum
|
|
1252
|
+
*/
|
|
1253
|
+
export const PATCH_OP_VALUES = [
|
|
1254
|
+
'upsert',
|
|
1255
|
+
'remove'
|
|
1256
|
+
] as const satisfies [string, ...string[]] | PatchOp[];
|
|
1257
|
+
|
|
1258
|
+
/**
|
|
1259
|
+
* PeriodUnit. Auto-generated enum for PeriodUnit
|
|
1260
|
+
*
|
|
1261
|
+
* @remarks
|
|
1262
|
+
* This constant provides both object and array forms for the PeriodUnit enum.
|
|
1263
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
1264
|
+
*
|
|
1265
|
+
* @example
|
|
1266
|
+
* ```typescript
|
|
1267
|
+
* // Using the object form for key-value access
|
|
1268
|
+
* const status = PERIOD_UNIT.SUCCESS;
|
|
1269
|
+
*
|
|
1270
|
+
* // Using the array form for iteration
|
|
1271
|
+
* const allStatuses = PERIOD_UNIT_VALUES;
|
|
1272
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
1273
|
+
* ```
|
|
1274
|
+
*
|
|
1275
|
+
* @see {@link PeriodUnit} - The TypeScript type definition
|
|
1276
|
+
*/
|
|
1277
|
+
export const PERIOD_UNIT = {
|
|
1278
|
+
Y: "y",
|
|
1279
|
+
M: "m",
|
|
1280
|
+
D: "d",
|
|
1281
|
+
} as const satisfies Record<string, PeriodUnit>;
|
|
1282
|
+
|
|
1283
|
+
/**
|
|
1284
|
+
* Array of all PeriodUnit enum values
|
|
1285
|
+
*
|
|
1286
|
+
* @remarks
|
|
1287
|
+
* This constant provides a array containing all valid PeriodUnit enum values.
|
|
1288
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1289
|
+
*
|
|
1290
|
+
* @example
|
|
1291
|
+
* ```typescript
|
|
1292
|
+
* // Iterating through all values
|
|
1293
|
+
* for (const value of PERIOD_UNIT_VALUES) {
|
|
1294
|
+
* console.log(`Processing: ${value}`);
|
|
1295
|
+
* }
|
|
1296
|
+
*
|
|
1297
|
+
* // Validation
|
|
1298
|
+
* const isValid = PERIOD_UNIT_VALUES.includes(someValue);
|
|
1299
|
+
* ```
|
|
1300
|
+
*
|
|
1301
|
+
* @see {@link PeriodUnit} - The TypeScript type definition
|
|
1302
|
+
* @see {@link PERIOD_UNIT} - The object form of this enum
|
|
1303
|
+
*/
|
|
1304
|
+
export const PERIOD_UNIT_VALUES = [
|
|
1305
|
+
'y',
|
|
1306
|
+
'm',
|
|
1307
|
+
'd'
|
|
1308
|
+
] as const satisfies [string, ...string[]] | PeriodUnit[];
|
|
1309
|
+
|
|
1310
|
+
/**
|
|
1311
|
+
* Permission. Auto-generated enum for Permission
|
|
1312
|
+
*
|
|
1313
|
+
* @remarks
|
|
1314
|
+
* This constant provides both object and array forms for the Permission enum.
|
|
1315
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
1316
|
+
*
|
|
1317
|
+
* @example
|
|
1318
|
+
* ```typescript
|
|
1319
|
+
* // Using the object form for key-value access
|
|
1320
|
+
* const status = PERMISSION.SUCCESS;
|
|
1321
|
+
*
|
|
1322
|
+
* // Using the array form for iteration
|
|
1323
|
+
* const allStatuses = PERMISSION_VALUES;
|
|
1324
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
1325
|
+
* ```
|
|
1326
|
+
*
|
|
1327
|
+
* @see {@link Permission} - The TypeScript type definition
|
|
1328
|
+
*/
|
|
1329
|
+
export const PERMISSION = {
|
|
1330
|
+
ACKNOWLEDGE: "acknowledge",
|
|
1331
|
+
BULK_CREATE: "bulk_create",
|
|
1332
|
+
BULK_DELETE: "bulk_delete",
|
|
1333
|
+
BULK_RENEW_EXPIRE: "bulk_renew_expire",
|
|
1334
|
+
BULK_TRANSFER_TRADE: "bulk_transfer_trade",
|
|
1335
|
+
BULK_UPDATE: "bulk_update",
|
|
1336
|
+
CREATE: "create",
|
|
1337
|
+
DELETE: "delete",
|
|
1338
|
+
ENTERPRISE: "enterprise",
|
|
1339
|
+
MANAGE_API_KEYS: "manage_api_keys",
|
|
1340
|
+
MANAGE_BILLING: "manage_billing",
|
|
1341
|
+
MANAGE_CMS_CONTENT: "manage_cms_content",
|
|
1342
|
+
MANAGE_CONTACTS: "manage_contacts",
|
|
1343
|
+
MANAGE_DNS_ZONES: "manage_dns_zones",
|
|
1344
|
+
MANAGE_DOMAINS: "manage_domains",
|
|
1345
|
+
MANAGE_EMAIL_FORWARDS: "manage_email_forwards",
|
|
1346
|
+
MANAGE_OPUSDNS_API_KEYS: "manage_opusdns_api_keys",
|
|
1347
|
+
MANAGE_PRODUCTS: "manage_products",
|
|
1348
|
+
MANAGE_RESELLER: "manage_reseller",
|
|
1349
|
+
MANAGE_USER_RELATIONS: "manage_user_relations",
|
|
1350
|
+
MANAGE_USERS: "manage_users",
|
|
1351
|
+
PLAN_MANAGER: "plan_manager",
|
|
1352
|
+
PREMIUM: "premium",
|
|
1353
|
+
PREMIUM_RESELLER: "premium_reseller",
|
|
1354
|
+
RENEW_EXPIRE: "renew_expire",
|
|
1355
|
+
SIGN_ORG_TOS: "sign_org_tos",
|
|
1356
|
+
STARTER: "starter",
|
|
1357
|
+
TRANSFER_TRADE: "transfer_trade",
|
|
1358
|
+
UPDATE: "update",
|
|
1359
|
+
VERIFY: "verify",
|
|
1360
|
+
VIEW: "view",
|
|
1361
|
+
VIEW_AUDIT_LOGS: "view_audit_logs",
|
|
1362
|
+
} as const satisfies Record<string, Permission>;
|
|
1363
|
+
|
|
1364
|
+
/**
|
|
1365
|
+
* Array of all Permission enum values
|
|
1366
|
+
*
|
|
1367
|
+
* @remarks
|
|
1368
|
+
* This constant provides a array containing all valid Permission enum values.
|
|
1369
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1370
|
+
*
|
|
1371
|
+
* @example
|
|
1372
|
+
* ```typescript
|
|
1373
|
+
* // Iterating through all values
|
|
1374
|
+
* for (const value of PERMISSION_VALUES) {
|
|
1375
|
+
* console.log(`Processing: ${value}`);
|
|
1376
|
+
* }
|
|
1377
|
+
*
|
|
1378
|
+
* // Validation
|
|
1379
|
+
* const isValid = PERMISSION_VALUES.includes(someValue);
|
|
1380
|
+
* ```
|
|
1381
|
+
*
|
|
1382
|
+
* @see {@link Permission} - The TypeScript type definition
|
|
1383
|
+
* @see {@link PERMISSION} - The object form of this enum
|
|
1384
|
+
*/
|
|
1385
|
+
export const PERMISSION_VALUES = [
|
|
1386
|
+
'acknowledge',
|
|
1387
|
+
'bulk_create',
|
|
1388
|
+
'bulk_delete',
|
|
1389
|
+
'bulk_renew_expire',
|
|
1390
|
+
'bulk_transfer_trade',
|
|
1391
|
+
'bulk_update',
|
|
1392
|
+
'create',
|
|
1393
|
+
'delete',
|
|
1394
|
+
'enterprise',
|
|
1395
|
+
'manage_api_keys',
|
|
1396
|
+
'manage_billing',
|
|
1397
|
+
'manage_cms_content',
|
|
1398
|
+
'manage_contacts',
|
|
1399
|
+
'manage_dns_zones',
|
|
1400
|
+
'manage_domains',
|
|
1401
|
+
'manage_email_forwards',
|
|
1402
|
+
'manage_opusdns_api_keys',
|
|
1403
|
+
'manage_products',
|
|
1404
|
+
'manage_reseller',
|
|
1405
|
+
'manage_user_relations',
|
|
1406
|
+
'manage_users',
|
|
1407
|
+
'plan_manager',
|
|
1408
|
+
'premium',
|
|
1409
|
+
'premium_reseller',
|
|
1410
|
+
'renew_expire',
|
|
1411
|
+
'sign_org_tos',
|
|
1412
|
+
'starter',
|
|
1413
|
+
'transfer_trade',
|
|
1414
|
+
'update',
|
|
1415
|
+
'verify',
|
|
1416
|
+
'view',
|
|
1417
|
+
'view_audit_logs'
|
|
1418
|
+
] as const satisfies [string, ...string[]] | Permission[];
|
|
1419
|
+
|
|
1420
|
+
/**
|
|
1421
|
+
* PlanRelation. Auto-generated enum for PlanRelation
|
|
1422
|
+
*
|
|
1423
|
+
* @remarks
|
|
1424
|
+
* This constant provides both object and array forms for the PlanRelation enum.
|
|
1425
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
1426
|
+
*
|
|
1427
|
+
* @example
|
|
1428
|
+
* ```typescript
|
|
1429
|
+
* // Using the object form for key-value access
|
|
1430
|
+
* const status = PLAN_RELATION.SUCCESS;
|
|
1431
|
+
*
|
|
1432
|
+
* // Using the array form for iteration
|
|
1433
|
+
* const allStatuses = PLAN_RELATION_VALUES;
|
|
1434
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
1435
|
+
* ```
|
|
1436
|
+
*
|
|
1437
|
+
* @see {@link PlanRelation} - The TypeScript type definition
|
|
1438
|
+
*/
|
|
1439
|
+
export const PLAN_RELATION = {
|
|
1440
|
+
BASIC_PLAN: "basic_plan",
|
|
1441
|
+
ENTERPRISE_PLAN: "enterprise_plan",
|
|
1442
|
+
PREMIUM_PLAN: "premium_plan",
|
|
1443
|
+
STARTER_PLAN: "starter_plan",
|
|
1444
|
+
} as const satisfies Record<string, PlanRelation>;
|
|
1445
|
+
|
|
1446
|
+
/**
|
|
1447
|
+
* Array of all PlanRelation enum values
|
|
1448
|
+
*
|
|
1449
|
+
* @remarks
|
|
1450
|
+
* This constant provides a array containing all valid PlanRelation enum values.
|
|
1451
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1452
|
+
*
|
|
1453
|
+
* @example
|
|
1454
|
+
* ```typescript
|
|
1455
|
+
* // Iterating through all values
|
|
1456
|
+
* for (const value of PLAN_RELATION_VALUES) {
|
|
1457
|
+
* console.log(`Processing: ${value}`);
|
|
1458
|
+
* }
|
|
1459
|
+
*
|
|
1460
|
+
* // Validation
|
|
1461
|
+
* const isValid = PLAN_RELATION_VALUES.includes(someValue);
|
|
1462
|
+
* ```
|
|
1463
|
+
*
|
|
1464
|
+
* @see {@link PlanRelation} - The TypeScript type definition
|
|
1465
|
+
* @see {@link PLAN_RELATION} - The object form of this enum
|
|
1466
|
+
*/
|
|
1467
|
+
export const PLAN_RELATION_VALUES = [
|
|
1468
|
+
'basic_plan',
|
|
1469
|
+
'enterprise_plan',
|
|
1470
|
+
'premium_plan',
|
|
1471
|
+
'starter_plan'
|
|
1472
|
+
] as const satisfies [string, ...string[]] | PlanRelation[];
|
|
1473
|
+
|
|
1474
|
+
/**
|
|
1475
|
+
* Relation. Auto-generated enum for Relation
|
|
1476
|
+
*
|
|
1477
|
+
* @remarks
|
|
1478
|
+
* This constant provides both object and array forms for the Relation enum.
|
|
1479
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
1480
|
+
*
|
|
1481
|
+
* @example
|
|
1482
|
+
* ```typescript
|
|
1483
|
+
* // Using the object form for key-value access
|
|
1484
|
+
* const status = RELATION.SUCCESS;
|
|
1485
|
+
*
|
|
1486
|
+
* // Using the array form for iteration
|
|
1487
|
+
* const allStatuses = RELATION_VALUES;
|
|
1488
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
1489
|
+
* ```
|
|
1490
|
+
*
|
|
1491
|
+
* @see {@link Relation} - The TypeScript type definition
|
|
1492
|
+
*/
|
|
1493
|
+
export const RELATION = {
|
|
1494
|
+
ACCEPTED_TOS: "accepted_tos",
|
|
1495
|
+
ADMIN: "admin",
|
|
1496
|
+
API_ADMIN: "api_admin",
|
|
1497
|
+
BILLING_MANAGER: "billing_manager",
|
|
1498
|
+
CLIENT_API_KEY: "client_api_key",
|
|
1499
|
+
CMS_CONTENT_EDITOR: "cms_content_editor",
|
|
1500
|
+
CONTACT_MANAGER: "contact_manager",
|
|
1501
|
+
DOMAIN_MANAGER: "domain_manager",
|
|
1502
|
+
EMAIL_FORWARD_MANAGER: "email_forward_manager",
|
|
1503
|
+
MEMBER: "member",
|
|
1504
|
+
OPUSDNS_INTERNAL_API_KEY: "opusdns_internal_api_key",
|
|
1505
|
+
ORGANIZATION_MANAGER: "organization_manager",
|
|
1506
|
+
OWNER: "owner",
|
|
1507
|
+
PARENT: "parent",
|
|
1508
|
+
PRODUCT_MANAGER: "product_manager",
|
|
1509
|
+
RECIPIENT: "recipient",
|
|
1510
|
+
RESELLER_MANAGER: "reseller_manager",
|
|
1511
|
+
ROOT_ADMIN: "root_admin",
|
|
1512
|
+
SELF: "self",
|
|
1513
|
+
} as const satisfies Record<string, Relation>;
|
|
1514
|
+
|
|
1515
|
+
/**
|
|
1516
|
+
* Array of all Relation enum values
|
|
1517
|
+
*
|
|
1518
|
+
* @remarks
|
|
1519
|
+
* This constant provides a array containing all valid Relation enum values.
|
|
1520
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1521
|
+
*
|
|
1522
|
+
* @example
|
|
1523
|
+
* ```typescript
|
|
1524
|
+
* // Iterating through all values
|
|
1525
|
+
* for (const value of RELATION_VALUES) {
|
|
1526
|
+
* console.log(`Processing: ${value}`);
|
|
1527
|
+
* }
|
|
1528
|
+
*
|
|
1529
|
+
* // Validation
|
|
1530
|
+
* const isValid = RELATION_VALUES.includes(someValue);
|
|
1531
|
+
* ```
|
|
1532
|
+
*
|
|
1533
|
+
* @see {@link Relation} - The TypeScript type definition
|
|
1534
|
+
* @see {@link RELATION} - The object form of this enum
|
|
1535
|
+
*/
|
|
1536
|
+
export const RELATION_VALUES = [
|
|
1537
|
+
'accepted_tos',
|
|
1538
|
+
'admin',
|
|
1539
|
+
'api_admin',
|
|
1540
|
+
'billing_manager',
|
|
1541
|
+
'client_api_key',
|
|
1542
|
+
'cms_content_editor',
|
|
1543
|
+
'contact_manager',
|
|
1544
|
+
'domain_manager',
|
|
1545
|
+
'email_forward_manager',
|
|
1546
|
+
'member',
|
|
1547
|
+
'opusdns_internal_api_key',
|
|
1548
|
+
'organization_manager',
|
|
1549
|
+
'owner',
|
|
1550
|
+
'parent',
|
|
1551
|
+
'product_manager',
|
|
1552
|
+
'recipient',
|
|
1553
|
+
'reseller_manager',
|
|
1554
|
+
'root_admin',
|
|
1555
|
+
'self'
|
|
1556
|
+
] as const satisfies [string, ...string[]] | Relation[];
|
|
1557
|
+
|
|
1558
|
+
/**
|
|
1559
|
+
* RenewalMode. Auto-generated enum for RenewalMode
|
|
1560
|
+
*
|
|
1561
|
+
* @remarks
|
|
1562
|
+
* This constant provides both object and array forms for the RenewalMode enum.
|
|
1563
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
1564
|
+
*
|
|
1565
|
+
* @example
|
|
1566
|
+
* ```typescript
|
|
1567
|
+
* // Using the object form for key-value access
|
|
1568
|
+
* const status = RENEWAL_MODE.SUCCESS;
|
|
1569
|
+
*
|
|
1570
|
+
* // Using the array form for iteration
|
|
1571
|
+
* const allStatuses = RENEWAL_MODE_VALUES;
|
|
1572
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
1573
|
+
* ```
|
|
1574
|
+
*
|
|
1575
|
+
* @see {@link RenewalMode} - The TypeScript type definition
|
|
1576
|
+
*/
|
|
1577
|
+
export const RENEWAL_MODE = {
|
|
1578
|
+
RENEW: "renew",
|
|
1579
|
+
EXPIRE: "expire",
|
|
1580
|
+
DELETE: "delete",
|
|
1581
|
+
} as const satisfies Record<string, RenewalMode>;
|
|
1582
|
+
|
|
1583
|
+
/**
|
|
1584
|
+
* Array of all RenewalMode enum values
|
|
1585
|
+
*
|
|
1586
|
+
* @remarks
|
|
1587
|
+
* This constant provides a array containing all valid RenewalMode enum values.
|
|
1588
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1589
|
+
*
|
|
1590
|
+
* @example
|
|
1591
|
+
* ```typescript
|
|
1592
|
+
* // Iterating through all values
|
|
1593
|
+
* for (const value of RENEWAL_MODE_VALUES) {
|
|
1594
|
+
* console.log(`Processing: ${value}`);
|
|
1595
|
+
* }
|
|
1596
|
+
*
|
|
1597
|
+
* // Validation
|
|
1598
|
+
* const isValid = RENEWAL_MODE_VALUES.includes(someValue);
|
|
1599
|
+
* ```
|
|
1600
|
+
*
|
|
1601
|
+
* @see {@link RenewalMode} - The TypeScript type definition
|
|
1602
|
+
* @see {@link RENEWAL_MODE} - The object form of this enum
|
|
1603
|
+
*/
|
|
1604
|
+
export const RENEWAL_MODE_VALUES = [
|
|
1605
|
+
'renew',
|
|
1606
|
+
'expire',
|
|
1607
|
+
'delete'
|
|
1608
|
+
] as const satisfies [string, ...string[]] | RenewalMode[];
|
|
1609
|
+
|
|
1610
|
+
/**
|
|
1611
|
+
* SortOrder. Auto-generated enum for SortOrder
|
|
1612
|
+
*
|
|
1613
|
+
* @remarks
|
|
1614
|
+
* This constant provides both object and array forms for the SortOrder enum.
|
|
1615
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
1616
|
+
*
|
|
1617
|
+
* @example
|
|
1618
|
+
* ```typescript
|
|
1619
|
+
* // Using the object form for key-value access
|
|
1620
|
+
* const status = SORT_ORDER.SUCCESS;
|
|
1621
|
+
*
|
|
1622
|
+
* // Using the array form for iteration
|
|
1623
|
+
* const allStatuses = SORT_ORDER_VALUES;
|
|
1624
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
1625
|
+
* ```
|
|
1626
|
+
*
|
|
1627
|
+
* @see {@link SortOrder} - The TypeScript type definition
|
|
1628
|
+
*/
|
|
1629
|
+
export const SORT_ORDER = {
|
|
1630
|
+
ASC: "asc",
|
|
1631
|
+
DESC: "desc",
|
|
1632
|
+
} as const satisfies Record<string, SortOrder>;
|
|
1633
|
+
|
|
1634
|
+
/**
|
|
1635
|
+
* Array of all SortOrder enum values
|
|
1636
|
+
*
|
|
1637
|
+
* @remarks
|
|
1638
|
+
* This constant provides a array containing all valid SortOrder enum values.
|
|
1639
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1640
|
+
*
|
|
1641
|
+
* @example
|
|
1642
|
+
* ```typescript
|
|
1643
|
+
* // Iterating through all values
|
|
1644
|
+
* for (const value of SORT_ORDER_VALUES) {
|
|
1645
|
+
* console.log(`Processing: ${value}`);
|
|
1646
|
+
* }
|
|
1647
|
+
*
|
|
1648
|
+
* // Validation
|
|
1649
|
+
* const isValid = SORT_ORDER_VALUES.includes(someValue);
|
|
1650
|
+
* ```
|
|
1651
|
+
*
|
|
1652
|
+
* @see {@link SortOrder} - The TypeScript type definition
|
|
1653
|
+
* @see {@link SORT_ORDER} - The object form of this enum
|
|
1654
|
+
*/
|
|
1655
|
+
export const SORT_ORDER_VALUES = [
|
|
1656
|
+
'asc',
|
|
1657
|
+
'desc'
|
|
1658
|
+
] as const satisfies [string, ...string[]] | SortOrder[];
|
|
1659
|
+
|
|
1660
|
+
/**
|
|
1661
|
+
* UserNotificationStatus. Auto-generated enum for UserNotificationStatus
|
|
1662
|
+
*
|
|
1663
|
+
* @remarks
|
|
1664
|
+
* This constant provides both object and array forms for the UserNotificationStatus enum.
|
|
1665
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
1666
|
+
*
|
|
1667
|
+
* @example
|
|
1668
|
+
* ```typescript
|
|
1669
|
+
* // Using the object form for key-value access
|
|
1670
|
+
* const status = USER_NOTIFICATION_STATUS.SUCCESS;
|
|
1671
|
+
*
|
|
1672
|
+
* // Using the array form for iteration
|
|
1673
|
+
* const allStatuses = USER_NOTIFICATION_STATUS_VALUES;
|
|
1674
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
1675
|
+
* ```
|
|
1676
|
+
*
|
|
1677
|
+
* @see {@link UserNotificationStatus} - The TypeScript type definition
|
|
1678
|
+
*/
|
|
1679
|
+
export const USER_NOTIFICATION_STATUS = {
|
|
1680
|
+
READ: "read",
|
|
1681
|
+
UNREAD: "unread",
|
|
1682
|
+
} as const satisfies Record<string, UserNotificationStatus>;
|
|
1683
|
+
|
|
1684
|
+
/**
|
|
1685
|
+
* Array of all UserNotificationStatus enum values
|
|
1686
|
+
*
|
|
1687
|
+
* @remarks
|
|
1688
|
+
* This constant provides a array containing all valid UserNotificationStatus enum values.
|
|
1689
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1690
|
+
*
|
|
1691
|
+
* @example
|
|
1692
|
+
* ```typescript
|
|
1693
|
+
* // Iterating through all values
|
|
1694
|
+
* for (const value of USER_NOTIFICATION_STATUS_VALUES) {
|
|
1695
|
+
* console.log(`Processing: ${value}`);
|
|
1696
|
+
* }
|
|
1697
|
+
*
|
|
1698
|
+
* // Validation
|
|
1699
|
+
* const isValid = USER_NOTIFICATION_STATUS_VALUES.includes(someValue);
|
|
1700
|
+
* ```
|
|
1701
|
+
*
|
|
1702
|
+
* @see {@link UserNotificationStatus} - The TypeScript type definition
|
|
1703
|
+
* @see {@link USER_NOTIFICATION_STATUS} - The object form of this enum
|
|
1704
|
+
*/
|
|
1705
|
+
export const USER_NOTIFICATION_STATUS_VALUES = [
|
|
1706
|
+
'read',
|
|
1707
|
+
'unread'
|
|
1708
|
+
] as const satisfies [string, ...string[]] | UserNotificationStatus[];
|
|
1709
|
+
|
|
1710
|
+
/**
|
|
1711
|
+
* UserStatus. Auto-generated enum for UserStatus
|
|
1712
|
+
*
|
|
1713
|
+
* @remarks
|
|
1714
|
+
* This constant provides both object and array forms for the UserStatus enum.
|
|
1715
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
1716
|
+
*
|
|
1717
|
+
* @example
|
|
1718
|
+
* ```typescript
|
|
1719
|
+
* // Using the object form for key-value access
|
|
1720
|
+
* const status = USER_STATUS.SUCCESS;
|
|
1721
|
+
*
|
|
1722
|
+
* // Using the array form for iteration
|
|
1723
|
+
* const allStatuses = USER_STATUS_VALUES;
|
|
1724
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
1725
|
+
* ```
|
|
1726
|
+
*
|
|
1727
|
+
* @see {@link UserStatus} - The TypeScript type definition
|
|
1728
|
+
*/
|
|
1729
|
+
export const USER_STATUS = {
|
|
1730
|
+
ACTIVE: "active",
|
|
1731
|
+
INACTIVE: "inactive",
|
|
1732
|
+
} as const satisfies Record<string, UserStatus>;
|
|
1733
|
+
|
|
1734
|
+
/**
|
|
1735
|
+
* Array of all UserStatus enum values
|
|
1736
|
+
*
|
|
1737
|
+
* @remarks
|
|
1738
|
+
* This constant provides a array containing all valid UserStatus enum values.
|
|
1739
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1740
|
+
*
|
|
1741
|
+
* @example
|
|
1742
|
+
* ```typescript
|
|
1743
|
+
* // Iterating through all values
|
|
1744
|
+
* for (const value of USER_STATUS_VALUES) {
|
|
1745
|
+
* console.log(`Processing: ${value}`);
|
|
1746
|
+
* }
|
|
1747
|
+
*
|
|
1748
|
+
* // Validation
|
|
1749
|
+
* const isValid = USER_STATUS_VALUES.includes(someValue);
|
|
1750
|
+
* ```
|
|
1751
|
+
*
|
|
1752
|
+
* @see {@link UserStatus} - The TypeScript type definition
|
|
1753
|
+
* @see {@link USER_STATUS} - The object form of this enum
|
|
1754
|
+
*/
|
|
1755
|
+
export const USER_STATUS_VALUES = [
|
|
1756
|
+
'active',
|
|
1757
|
+
'inactive'
|
|
1758
|
+
] as const satisfies [string, ...string[]] | UserStatus[];
|
|
1759
|
+
|
|
1760
|
+
/**
|
|
1761
|
+
* VerificationType. Auto-generated enum for VerificationType
|
|
1762
|
+
*
|
|
1763
|
+
* @remarks
|
|
1764
|
+
* This constant provides both object and array forms for the VerificationType enum.
|
|
1765
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
1766
|
+
*
|
|
1767
|
+
* @example
|
|
1768
|
+
* ```typescript
|
|
1769
|
+
* // Using the object form for key-value access
|
|
1770
|
+
* const status = VERIFICATION_TYPE.SUCCESS;
|
|
1771
|
+
*
|
|
1772
|
+
* // Using the array form for iteration
|
|
1773
|
+
* const allStatuses = VERIFICATION_TYPE_VALUES;
|
|
1774
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
1775
|
+
* ```
|
|
1776
|
+
*
|
|
1777
|
+
* @see {@link VerificationType} - The TypeScript type definition
|
|
1778
|
+
*/
|
|
1779
|
+
export const VERIFICATION_TYPE = {
|
|
1780
|
+
API: "api",
|
|
1781
|
+
EMAIL: "email",
|
|
1782
|
+
} as const satisfies Record<string, VerificationType>;
|
|
1783
|
+
|
|
1784
|
+
/**
|
|
1785
|
+
* Array of all VerificationType enum values
|
|
1786
|
+
*
|
|
1787
|
+
* @remarks
|
|
1788
|
+
* This constant provides a array containing all valid VerificationType enum values.
|
|
1789
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1790
|
+
*
|
|
1791
|
+
* @example
|
|
1792
|
+
* ```typescript
|
|
1793
|
+
* // Iterating through all values
|
|
1794
|
+
* for (const value of VERIFICATION_TYPE_VALUES) {
|
|
1795
|
+
* console.log(`Processing: ${value}`);
|
|
1796
|
+
* }
|
|
1797
|
+
*
|
|
1798
|
+
* // Validation
|
|
1799
|
+
* const isValid = VERIFICATION_TYPE_VALUES.includes(someValue);
|
|
1800
|
+
* ```
|
|
1801
|
+
*
|
|
1802
|
+
* @see {@link VerificationType} - The TypeScript type definition
|
|
1803
|
+
* @see {@link VERIFICATION_TYPE} - The object form of this enum
|
|
1804
|
+
*/
|
|
1805
|
+
export const VERIFICATION_TYPE_VALUES = [
|
|
1806
|
+
'api',
|
|
1807
|
+
'email'
|
|
1808
|
+
] as const satisfies [string, ...string[]] | VerificationType[];
|
|
1809
|
+
|
|
1810
|
+
/**
|
|
1811
|
+
* ZoneSortField. Auto-generated enum for ZoneSortField
|
|
1812
|
+
*
|
|
1813
|
+
* @remarks
|
|
1814
|
+
* This constant provides both object and array forms for the ZoneSortField enum.
|
|
1815
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
1816
|
+
*
|
|
1817
|
+
* @example
|
|
1818
|
+
* ```typescript
|
|
1819
|
+
* // Using the object form for key-value access
|
|
1820
|
+
* const status = ZONE_SORT_FIELD.SUCCESS;
|
|
1821
|
+
*
|
|
1822
|
+
* // Using the array form for iteration
|
|
1823
|
+
* const allStatuses = ZONE_SORT_FIELD_VALUES;
|
|
1824
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
1825
|
+
* ```
|
|
1826
|
+
*
|
|
1827
|
+
* @see {@link ZoneSortField} - The TypeScript type definition
|
|
1828
|
+
*/
|
|
1829
|
+
export const ZONE_SORT_FIELD = {
|
|
1830
|
+
NAME: "name",
|
|
1831
|
+
CREATED_ON: "created_on",
|
|
1832
|
+
UPDATED_ON: "updated_on",
|
|
1833
|
+
DNSSEC_STATUS: "dnssec_status",
|
|
1834
|
+
} as const satisfies Record<string, ZoneSortField>;
|
|
1835
|
+
|
|
1836
|
+
/**
|
|
1837
|
+
* Array of all ZoneSortField enum values
|
|
1838
|
+
*
|
|
1839
|
+
* @remarks
|
|
1840
|
+
* This constant provides a array containing all valid ZoneSortField enum values.
|
|
1841
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1842
|
+
*
|
|
1843
|
+
* @example
|
|
1844
|
+
* ```typescript
|
|
1845
|
+
* // Iterating through all values
|
|
1846
|
+
* for (const value of ZONE_SORT_FIELD_VALUES) {
|
|
1847
|
+
* console.log(`Processing: ${value}`);
|
|
1848
|
+
* }
|
|
1849
|
+
*
|
|
1850
|
+
* // Validation
|
|
1851
|
+
* const isValid = ZONE_SORT_FIELD_VALUES.includes(someValue);
|
|
1852
|
+
* ```
|
|
1853
|
+
*
|
|
1854
|
+
* @see {@link ZoneSortField} - The TypeScript type definition
|
|
1855
|
+
* @see {@link ZONE_SORT_FIELD} - The object form of this enum
|
|
1856
|
+
*/
|
|
1857
|
+
export const ZONE_SORT_FIELD_VALUES = [
|
|
1858
|
+
'name',
|
|
1859
|
+
'created_on',
|
|
1860
|
+
'updated_on',
|
|
1861
|
+
'dnssec_status'
|
|
1862
|
+
] as const satisfies [string, ...string[]] | ZoneSortField[];
|
|
1863
|
+
|