@opusdns/api 0.147.0 → 0.149.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 +23 -3
- package/src/schema.d.ts +9 -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
|
@@ -2858,6 +2858,15 @@ components:
|
|
|
2858
2858
|
- status
|
|
2859
2859
|
title: EmailForwardLogEvent
|
|
2860
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
|
|
2861
2870
|
EmailForwardLogSortField:
|
|
2862
2871
|
enum:
|
|
2863
2872
|
- log_id
|
|
@@ -6502,7 +6511,7 @@ info:
|
|
|
6502
6511
|
'
|
|
6503
6512
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
6504
6513
|
title: OpusDNS API
|
|
6505
|
-
version: 2026-01-09-
|
|
6514
|
+
version: 2026-01-09-125102
|
|
6506
6515
|
x-logo:
|
|
6507
6516
|
altText: OpusDNS API Reference
|
|
6508
6517
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -6526,6 +6535,17 @@ paths:
|
|
|
6526
6535
|
title: Email Forward Alias Id
|
|
6527
6536
|
type: string
|
|
6528
6537
|
x-typeid-prefix: email_forward_alias
|
|
6538
|
+
- in: query
|
|
6539
|
+
name: email_forward_id
|
|
6540
|
+
required: true
|
|
6541
|
+
schema:
|
|
6542
|
+
examples:
|
|
6543
|
+
- email_forward_01h45ytscbebyvny4gc8cr8ma2
|
|
6544
|
+
format: typeid
|
|
6545
|
+
pattern: ^email_forward_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
6546
|
+
title: Email Forward Id
|
|
6547
|
+
type: string
|
|
6548
|
+
x-typeid-prefix: email_forward
|
|
6529
6549
|
- in: query
|
|
6530
6550
|
name: sort_by
|
|
6531
6551
|
required: false
|
|
@@ -6560,7 +6580,7 @@ paths:
|
|
|
6560
6580
|
required: false
|
|
6561
6581
|
schema:
|
|
6562
6582
|
anyOf:
|
|
6563
|
-
-
|
|
6583
|
+
- $ref: '#/components/schemas/EmailForwardLogFinalStatus'
|
|
6564
6584
|
- type: 'null'
|
|
6565
6585
|
title: Final Status
|
|
6566
6586
|
- in: query
|
|
@@ -6650,7 +6670,7 @@ paths:
|
|
|
6650
6670
|
required: false
|
|
6651
6671
|
schema:
|
|
6652
6672
|
anyOf:
|
|
6653
|
-
-
|
|
6673
|
+
- $ref: '#/components/schemas/EmailForwardLogFinalStatus'
|
|
6654
6674
|
- type: 'null'
|
|
6655
6675
|
title: Final Status
|
|
6656
6676
|
- in: query
|
package/src/schema.d.ts
CHANGED
|
@@ -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}
|
|
@@ -6010,12 +6015,13 @@ export type $defs = Record<string, never>;
|
|
|
6010
6015
|
export interface operations {
|
|
6011
6016
|
get_email_forward_logs_by_alias_v1_archive_email_forward_logs_aliases__email_forward_alias_id__get: {
|
|
6012
6017
|
parameters: {
|
|
6013
|
-
query
|
|
6018
|
+
query: {
|
|
6019
|
+
email_forward_id: TypeId<"email_forward">;
|
|
6014
6020
|
sort_by?: components["schemas"]["EmailForwardLogSortField"];
|
|
6015
6021
|
sort_order?: components["schemas"]["SortOrder"];
|
|
6016
6022
|
page_size?: number;
|
|
6017
6023
|
page?: number;
|
|
6018
|
-
final_status?:
|
|
6024
|
+
final_status?: components["schemas"]["EmailForwardLogFinalStatus"] | null;
|
|
6019
6025
|
start_time?: Date | null;
|
|
6020
6026
|
end_time?: Date | null;
|
|
6021
6027
|
};
|
|
@@ -6054,7 +6060,7 @@ export interface operations {
|
|
|
6054
6060
|
sort_order?: components["schemas"]["SortOrder"];
|
|
6055
6061
|
page_size?: number;
|
|
6056
6062
|
page?: number;
|
|
6057
|
-
final_status?:
|
|
6063
|
+
final_status?: components["schemas"]["EmailForwardLogFinalStatus"] | null;
|
|
6058
6064
|
start_time?: Date | null;
|
|
6059
6065
|
end_time?: Date | null;
|
|
6060
6066
|
};
|