@opusdns/api 0.146.0 → 0.148.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 +57 -1
- package/src/helpers/schemas.d.ts +16 -0
- package/src/openapi.yaml +12 -5
- package/src/schema.d.ts +8 -3
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, EmailForwardLogSortField, 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';
|
|
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, EmailForwardLogFinalStatus, EmailForwardLogSortField, 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
|
|
@@ -1339,6 +1339,62 @@ export const DOMAIN_STATUS_VALUES = [
|
|
|
1339
1339
|
'invalid'
|
|
1340
1340
|
] as const satisfies [string, ...string[]] | DomainStatus[];
|
|
1341
1341
|
|
|
1342
|
+
/**
|
|
1343
|
+
* EmailForwardLogFinalStatus. Auto-generated enum for EmailForwardLogFinalStatus
|
|
1344
|
+
*
|
|
1345
|
+
* @remarks
|
|
1346
|
+
* This constant provides both object and array forms for the EmailForwardLogFinalStatus enum.
|
|
1347
|
+
* The object form allows key-value access, while the array form enables iteration and validation.
|
|
1348
|
+
*
|
|
1349
|
+
* @example
|
|
1350
|
+
* ```typescript
|
|
1351
|
+
* // Using the object form for key-value access
|
|
1352
|
+
* const status = EMAIL_FORWARD_LOG_FINAL_STATUS.SUCCESS;
|
|
1353
|
+
*
|
|
1354
|
+
* // Using the array form for iteration
|
|
1355
|
+
* const allStatuses = EMAIL_FORWARD_LOG_FINAL_STATUS_VALUES;
|
|
1356
|
+
* console.log(`Available statuses: ${allStatuses.join(', ')}`);
|
|
1357
|
+
* ```
|
|
1358
|
+
*
|
|
1359
|
+
* @see {@link EmailForwardLogFinalStatus} - The TypeScript type definition
|
|
1360
|
+
*/
|
|
1361
|
+
export const EMAIL_FORWARD_LOG_FINAL_STATUS = {
|
|
1362
|
+
QUEUED: "QUEUED",
|
|
1363
|
+
DELIVERED: "DELIVERED",
|
|
1364
|
+
REFUSED: "REFUSED",
|
|
1365
|
+
SOFT_BOUNCE: "SOFT-BOUNCE",
|
|
1366
|
+
HARD_BOUNCE: "HARD-BOUNCE",
|
|
1367
|
+
} as const satisfies Record<string, EmailForwardLogFinalStatus>;
|
|
1368
|
+
|
|
1369
|
+
/**
|
|
1370
|
+
* Array of all EmailForwardLogFinalStatus enum values
|
|
1371
|
+
*
|
|
1372
|
+
* @remarks
|
|
1373
|
+
* This constant provides a array containing all valid EmailForwardLogFinalStatus enum values.
|
|
1374
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
1375
|
+
*
|
|
1376
|
+
* @example
|
|
1377
|
+
* ```typescript
|
|
1378
|
+
* // Iterating through all values
|
|
1379
|
+
* for (const value of EMAIL_FORWARD_LOG_FINAL_STATUS_VALUES) {
|
|
1380
|
+
* console.log(`Processing: ${value}`);
|
|
1381
|
+
* }
|
|
1382
|
+
*
|
|
1383
|
+
* // Validation
|
|
1384
|
+
* const isValid = EMAIL_FORWARD_LOG_FINAL_STATUS_VALUES.includes(someValue);
|
|
1385
|
+
* ```
|
|
1386
|
+
*
|
|
1387
|
+
* @see {@link EmailForwardLogFinalStatus} - The TypeScript type definition
|
|
1388
|
+
* @see {@link EMAIL_FORWARD_LOG_FINAL_STATUS} - The object form of this enum
|
|
1389
|
+
*/
|
|
1390
|
+
export const EMAIL_FORWARD_LOG_FINAL_STATUS_VALUES = [
|
|
1391
|
+
'QUEUED',
|
|
1392
|
+
'DELIVERED',
|
|
1393
|
+
'REFUSED',
|
|
1394
|
+
'SOFT-BOUNCE',
|
|
1395
|
+
'HARD-BOUNCE'
|
|
1396
|
+
] as const satisfies [string, ...string[]] | EmailForwardLogFinalStatus[];
|
|
1397
|
+
|
|
1342
1398
|
/**
|
|
1343
1399
|
* EmailForwardLogSortField. Auto-generated enum for EmailForwardLogSortField
|
|
1344
1400
|
*
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -1882,6 +1882,22 @@ export type EmailForwardLog = components['schemas']['EmailForwardLog'];
|
|
|
1882
1882
|
* @see {@link components} - The OpenAPI components schema definition
|
|
1883
1883
|
*/
|
|
1884
1884
|
export type EmailForwardLogEvent = components['schemas']['EmailForwardLogEvent'];
|
|
1885
|
+
/**
|
|
1886
|
+
* EmailForwardLogFinalStatus
|
|
1887
|
+
*
|
|
1888
|
+
* @remarks
|
|
1889
|
+
* Type alias for the `EmailForwardLogFinalStatus` OpenAPI schema.
|
|
1890
|
+
* This type represents emailforwardlogfinalstatus data structures used in API requests and responses.
|
|
1891
|
+
*
|
|
1892
|
+
* @example
|
|
1893
|
+
* ```typescript
|
|
1894
|
+
* const response = await api.getEmailForwardLogFinalStatus();
|
|
1895
|
+
* const item: EmailForwardLogFinalStatus = response.results;
|
|
1896
|
+
* ```
|
|
1897
|
+
*
|
|
1898
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1899
|
+
*/
|
|
1900
|
+
export type EmailForwardLogFinalStatus = components['schemas']['EmailForwardLogFinalStatus'];
|
|
1885
1901
|
/**
|
|
1886
1902
|
* EmailForwardLogSortField
|
|
1887
1903
|
*
|
package/src/openapi.yaml
CHANGED
|
@@ -2267,8 +2267,6 @@ components:
|
|
|
2267
2267
|
- type: 'null'
|
|
2268
2268
|
description: Reason for restoring the domain
|
|
2269
2269
|
title: Reason
|
|
2270
|
-
required:
|
|
2271
|
-
- reason
|
|
2272
2270
|
title: DomainRestoreRequest
|
|
2273
2271
|
type: object
|
|
2274
2272
|
DomainRestoreResponse:
|
|
@@ -2860,6 +2858,15 @@ components:
|
|
|
2860
2858
|
- status
|
|
2861
2859
|
title: EmailForwardLogEvent
|
|
2862
2860
|
type: object
|
|
2861
|
+
EmailForwardLogFinalStatus:
|
|
2862
|
+
enum:
|
|
2863
|
+
- QUEUED
|
|
2864
|
+
- DELIVERED
|
|
2865
|
+
- REFUSED
|
|
2866
|
+
- SOFT-BOUNCE
|
|
2867
|
+
- HARD-BOUNCE
|
|
2868
|
+
title: EmailForwardLogFinalStatus
|
|
2869
|
+
type: string
|
|
2863
2870
|
EmailForwardLogSortField:
|
|
2864
2871
|
enum:
|
|
2865
2872
|
- log_id
|
|
@@ -6504,7 +6511,7 @@ info:
|
|
|
6504
6511
|
'
|
|
6505
6512
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
6506
6513
|
title: OpusDNS API
|
|
6507
|
-
version: 2026-01-
|
|
6514
|
+
version: 2026-01-09-124349
|
|
6508
6515
|
x-logo:
|
|
6509
6516
|
altText: OpusDNS API Reference
|
|
6510
6517
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -6562,7 +6569,7 @@ paths:
|
|
|
6562
6569
|
required: false
|
|
6563
6570
|
schema:
|
|
6564
6571
|
anyOf:
|
|
6565
|
-
-
|
|
6572
|
+
- $ref: '#/components/schemas/EmailForwardLogFinalStatus'
|
|
6566
6573
|
- type: 'null'
|
|
6567
6574
|
title: Final Status
|
|
6568
6575
|
- in: query
|
|
@@ -6652,7 +6659,7 @@ paths:
|
|
|
6652
6659
|
required: false
|
|
6653
6660
|
schema:
|
|
6654
6661
|
anyOf:
|
|
6655
|
-
-
|
|
6662
|
+
- $ref: '#/components/schemas/EmailForwardLogFinalStatus'
|
|
6656
6663
|
- type: 'null'
|
|
6657
6664
|
title: Final Status
|
|
6658
6665
|
- in: query
|
package/src/schema.d.ts
CHANGED
|
@@ -3238,7 +3238,7 @@ export interface components {
|
|
|
3238
3238
|
* Reason
|
|
3239
3239
|
* @description Reason for restoring the domain
|
|
3240
3240
|
*/
|
|
3241
|
-
reason
|
|
3241
|
+
reason?: string | null;
|
|
3242
3242
|
};
|
|
3243
3243
|
/** DomainRestoreResponse */
|
|
3244
3244
|
DomainRestoreResponse: {
|
|
@@ -3665,6 +3665,11 @@ export interface components {
|
|
|
3665
3665
|
*/
|
|
3666
3666
|
status: string;
|
|
3667
3667
|
};
|
|
3668
|
+
/**
|
|
3669
|
+
* EmailForwardLogFinalStatus
|
|
3670
|
+
* @enum {string}
|
|
3671
|
+
*/
|
|
3672
|
+
EmailForwardLogFinalStatus: "QUEUED" | "DELIVERED" | "REFUSED" | "SOFT-BOUNCE" | "HARD-BOUNCE";
|
|
3668
3673
|
/**
|
|
3669
3674
|
* EmailForwardLogSortField
|
|
3670
3675
|
* @enum {string}
|
|
@@ -6015,7 +6020,7 @@ export interface operations {
|
|
|
6015
6020
|
sort_order?: components["schemas"]["SortOrder"];
|
|
6016
6021
|
page_size?: number;
|
|
6017
6022
|
page?: number;
|
|
6018
|
-
final_status?:
|
|
6023
|
+
final_status?: components["schemas"]["EmailForwardLogFinalStatus"] | null;
|
|
6019
6024
|
start_time?: Date | null;
|
|
6020
6025
|
end_time?: Date | null;
|
|
6021
6026
|
};
|
|
@@ -6054,7 +6059,7 @@ export interface operations {
|
|
|
6054
6059
|
sort_order?: components["schemas"]["SortOrder"];
|
|
6055
6060
|
page_size?: number;
|
|
6056
6061
|
page?: number;
|
|
6057
|
-
final_status?:
|
|
6062
|
+
final_status?: components["schemas"]["EmailForwardLogFinalStatus"] | null;
|
|
6058
6063
|
start_time?: Date | null;
|
|
6059
6064
|
end_time?: Date | null;
|
|
6060
6065
|
};
|