@opusdns/api 0.157.0 → 0.159.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/constants.ts +55 -55
- package/src/helpers/keys.ts +553 -2
- package/src/helpers/requests.d.ts +53 -0
- package/src/helpers/responses.d.ts +111 -1
- package/src/helpers/schemas-arrays.d.ts +15 -1
- package/src/helpers/schemas.d.ts +76 -12
- package/src/openapi.yaml +221 -14
- package/src/schema.d.ts +205 -11
package/package.json
CHANGED
package/src/helpers/constants.ts
CHANGED
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
* ```
|
|
22
22
|
*/
|
|
23
23
|
|
|
24
|
-
import { AllocationMethodType, AttributeType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainSortField, DomainStatus,
|
|
24
|
+
import { AllocationMethodType, AttributeType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainSortField, DomainStatus, EmailForwardLogSortField, EmailForwardLogStatus, EmailForwardSortField, EmailForwardZoneSortField, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, GrantType, HostStatus, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, LaunchPhaseType, LocalPresenceRequirementType, MetricsGrouping, ObjectEventType, ObjectLogSortField, OrganizationStatus, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, Protocol, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, RequestHistorySortField, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TimeRange, TransferAckType, UserStatus, VerificationType, ZoneSortField } from './schemas';
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* AllocationMethodType. Auto-generated enum for AllocationMethodType
|
|
@@ -1340,120 +1340,120 @@ export const DOMAIN_STATUS_VALUES = [
|
|
|
1340
1340
|
] as const satisfies [string, ...string[]] | DomainStatus[];
|
|
1341
1341
|
|
|
1342
1342
|
/**
|
|
1343
|
-
*
|
|
1343
|
+
* EmailForwardLogSortField. Auto-generated enum for EmailForwardLogSortField
|
|
1344
1344
|
*
|
|
1345
1345
|
* @remarks
|
|
1346
|
-
* This constant provides both object and array forms for the
|
|
1346
|
+
* This constant provides both object and array forms for the EmailForwardLogSortField enum.
|
|
1347
1347
|
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
1348
1348
|
*
|
|
1349
1349
|
* @example
|
|
1350
1350
|
* ```typescript
|
|
1351
1351
|
* // Using the object form for key-value access
|
|
1352
|
-
* const status =
|
|
1352
|
+
* const status = EMAIL_FORWARD_LOG_SORT_FIELD.SUCCESS;
|
|
1353
1353
|
*
|
|
1354
1354
|
* // Using the array form for iteration
|
|
1355
|
-
* const allStatuses =
|
|
1355
|
+
* const allStatuses = EMAIL_FORWARD_LOG_SORT_FIELD_VALUES;
|
|
1356
1356
|
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
1357
1357
|
* ```
|
|
1358
1358
|
*
|
|
1359
|
-
* @see {@link
|
|
1359
|
+
* @see {@link EmailForwardLogSortField} - The TypeScript type definition
|
|
1360
1360
|
*/
|
|
1361
|
-
export const
|
|
1362
|
-
|
|
1363
|
-
|
|
1364
|
-
|
|
1365
|
-
|
|
1366
|
-
|
|
1367
|
-
|
|
1361
|
+
export const EMAIL_FORWARD_LOG_SORT_FIELD = {
|
|
1362
|
+
LOG_ID: "log_id",
|
|
1363
|
+
SENDER_EMAIL: "sender_email",
|
|
1364
|
+
RECIPIENT_EMAIL: "recipient_email",
|
|
1365
|
+
FORWARD_EMAIL: "forward_email",
|
|
1366
|
+
FINAL_STATUS: "final_status",
|
|
1367
|
+
CREATED_ON: "created_on",
|
|
1368
|
+
SYNCED_ON: "synced_on",
|
|
1369
|
+
} as const satisfies Record<string, EmailForwardLogSortField>;
|
|
1368
1370
|
|
|
1369
1371
|
/**
|
|
1370
|
-
* Array of all
|
|
1372
|
+
* Array of all EmailForwardLogSortField enum values
|
|
1371
1373
|
*
|
|
1372
1374
|
* @remarks
|
|
1373
|
-
* This constant provides a array containing all valid
|
|
1375
|
+
* This constant provides a array containing all valid EmailForwardLogSortField enum values.
|
|
1374
1376
|
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1375
1377
|
*
|
|
1376
1378
|
* @example
|
|
1377
1379
|
* ```typescript
|
|
1378
1380
|
* // Iterating through all values
|
|
1379
|
-
* for (const value of
|
|
1381
|
+
* for (const value of EMAIL_FORWARD_LOG_SORT_FIELD_VALUES) {
|
|
1380
1382
|
* console.log(`Processing: ${value}`);
|
|
1381
1383
|
* }
|
|
1382
1384
|
*
|
|
1383
1385
|
* // Validation
|
|
1384
|
-
* const isValid =
|
|
1386
|
+
* const isValid = EMAIL_FORWARD_LOG_SORT_FIELD_VALUES.includes(someValue);
|
|
1385
1387
|
* ```
|
|
1386
1388
|
*
|
|
1387
|
-
* @see {@link
|
|
1388
|
-
* @see {@link
|
|
1389
|
+
* @see {@link EmailForwardLogSortField} - The TypeScript type definition
|
|
1390
|
+
* @see {@link EMAIL_FORWARD_LOG_SORT_FIELD} - The object form of this enum
|
|
1389
1391
|
*/
|
|
1390
|
-
export const
|
|
1391
|
-
'
|
|
1392
|
-
'
|
|
1393
|
-
'
|
|
1394
|
-
'
|
|
1395
|
-
'
|
|
1396
|
-
|
|
1392
|
+
export const EMAIL_FORWARD_LOG_SORT_FIELD_VALUES = [
|
|
1393
|
+
'log_id',
|
|
1394
|
+
'sender_email',
|
|
1395
|
+
'recipient_email',
|
|
1396
|
+
'forward_email',
|
|
1397
|
+
'final_status',
|
|
1398
|
+
'created_on',
|
|
1399
|
+
'synced_on'
|
|
1400
|
+
] as const satisfies [string, ...string[]] | EmailForwardLogSortField[];
|
|
1397
1401
|
|
|
1398
1402
|
/**
|
|
1399
|
-
*
|
|
1403
|
+
* EmailForwardLogStatus. Auto-generated enum for EmailForwardLogStatus
|
|
1400
1404
|
*
|
|
1401
1405
|
* @remarks
|
|
1402
|
-
* This constant provides both object and array forms for the
|
|
1406
|
+
* This constant provides both object and array forms for the EmailForwardLogStatus enum.
|
|
1403
1407
|
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
1404
1408
|
*
|
|
1405
1409
|
* @example
|
|
1406
1410
|
* ```typescript
|
|
1407
1411
|
* // Using the object form for key-value access
|
|
1408
|
-
* const status =
|
|
1412
|
+
* const status = EMAIL_FORWARD_LOG_STATUS.SUCCESS;
|
|
1409
1413
|
*
|
|
1410
1414
|
* // Using the array form for iteration
|
|
1411
|
-
* const allStatuses =
|
|
1415
|
+
* const allStatuses = EMAIL_FORWARD_LOG_STATUS_VALUES;
|
|
1412
1416
|
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
1413
1417
|
* ```
|
|
1414
1418
|
*
|
|
1415
|
-
* @see {@link
|
|
1419
|
+
* @see {@link EmailForwardLogStatus} - The TypeScript type definition
|
|
1416
1420
|
*/
|
|
1417
|
-
export const
|
|
1418
|
-
|
|
1419
|
-
|
|
1420
|
-
|
|
1421
|
-
|
|
1422
|
-
|
|
1423
|
-
|
|
1424
|
-
SYNCED_ON: "synced_on",
|
|
1425
|
-
} as const satisfies Record<string, EmailForwardLogSortField>;
|
|
1421
|
+
export const EMAIL_FORWARD_LOG_STATUS = {
|
|
1422
|
+
QUEUED: "QUEUED",
|
|
1423
|
+
DELIVERED: "DELIVERED",
|
|
1424
|
+
REFUSED: "REFUSED",
|
|
1425
|
+
SOFT_BOUNCE: "SOFT-BOUNCE",
|
|
1426
|
+
HARD_BOUNCE: "HARD-BOUNCE",
|
|
1427
|
+
} as const satisfies Record<string, EmailForwardLogStatus>;
|
|
1426
1428
|
|
|
1427
1429
|
/**
|
|
1428
|
-
* Array of all
|
|
1430
|
+
* Array of all EmailForwardLogStatus enum values
|
|
1429
1431
|
*
|
|
1430
1432
|
* @remarks
|
|
1431
|
-
* This constant provides a array containing all valid
|
|
1433
|
+
* This constant provides a array containing all valid EmailForwardLogStatus enum values.
|
|
1432
1434
|
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1433
1435
|
*
|
|
1434
1436
|
* @example
|
|
1435
1437
|
* ```typescript
|
|
1436
1438
|
* // Iterating through all values
|
|
1437
|
-
* for (const value of
|
|
1439
|
+
* for (const value of EMAIL_FORWARD_LOG_STATUS_VALUES) {
|
|
1438
1440
|
* console.log(`Processing: ${value}`);
|
|
1439
1441
|
* }
|
|
1440
1442
|
*
|
|
1441
1443
|
* // Validation
|
|
1442
|
-
* const isValid =
|
|
1444
|
+
* const isValid = EMAIL_FORWARD_LOG_STATUS_VALUES.includes(someValue);
|
|
1443
1445
|
* ```
|
|
1444
1446
|
*
|
|
1445
|
-
* @see {@link
|
|
1446
|
-
* @see {@link
|
|
1447
|
+
* @see {@link EmailForwardLogStatus} - The TypeScript type definition
|
|
1448
|
+
* @see {@link EMAIL_FORWARD_LOG_STATUS} - The object form of this enum
|
|
1447
1449
|
*/
|
|
1448
|
-
export const
|
|
1449
|
-
'
|
|
1450
|
-
'
|
|
1451
|
-
'
|
|
1452
|
-
'
|
|
1453
|
-
'
|
|
1454
|
-
|
|
1455
|
-
'synced_on'
|
|
1456
|
-
] as const satisfies [string, ...string[]] | EmailForwardLogSortField[];
|
|
1450
|
+
export const EMAIL_FORWARD_LOG_STATUS_VALUES = [
|
|
1451
|
+
'QUEUED',
|
|
1452
|
+
'DELIVERED',
|
|
1453
|
+
'REFUSED',
|
|
1454
|
+
'SOFT-BOUNCE',
|
|
1455
|
+
'HARD-BOUNCE'
|
|
1456
|
+
] as const satisfies [string, ...string[]] | EmailForwardLogStatus[];
|
|
1457
1457
|
|
|
1458
1458
|
/**
|
|
1459
1459
|
* EmailForwardSortField. Auto-generated enum for EmailForwardSortField
|