@opusdns/api 0.237.0 → 0.239.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/src/helpers/keys.ts +211 -0
- package/src/helpers/responses.d.ts +3 -63
- package/src/helpers/schemas-arrays.d.ts +15 -1
- package/src/helpers/schemas.d.ts +32 -0
- package/src/openapi.yaml +47 -38
- package/src/schema.d.ts +35 -48
package/package.json
CHANGED
package/src/helpers/keys.ts
CHANGED
|
@@ -253,6 +253,8 @@ import { Period } from './schemas';
|
|
|
253
253
|
import { PermissionSet } from './schemas';
|
|
254
254
|
import { PlatformStatsBucket } from './schemas';
|
|
255
255
|
import { PremiumDomainsBase } from './schemas';
|
|
256
|
+
import { PremiumPricingAction } from './schemas';
|
|
257
|
+
import { PremiumPricing } from './schemas';
|
|
256
258
|
import { PriceInfo } from './schemas';
|
|
257
259
|
import { PricingPeriod } from './schemas';
|
|
258
260
|
import { Problem } from './schemas';
|
|
@@ -31673,6 +31675,162 @@ export const KEYS_PREMIUM_DOMAINS_BASE = [
|
|
|
31673
31675
|
KEY_PREMIUM_DOMAINS_BASE_SUPPORTED,
|
|
31674
31676
|
] as const satisfies (keyof PremiumDomainsBase)[];
|
|
31675
31677
|
|
|
31678
|
+
/**
|
|
31679
|
+
* Action
|
|
31680
|
+
*
|
|
31681
|
+
* The action (e.g., create, renew, transfer)
|
|
31682
|
+
*
|
|
31683
|
+
* @type {string}
|
|
31684
|
+
*
|
|
31685
|
+
*
|
|
31686
|
+
* @remarks
|
|
31687
|
+
* This key constant provides type-safe access to the `action` property of PremiumPricingAction objects.
|
|
31688
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
31689
|
+
*
|
|
31690
|
+
* @example
|
|
31691
|
+
* ```typescript
|
|
31692
|
+
* // Direct property access
|
|
31693
|
+
* const value = premiumpricingaction[KEY_PREMIUM_PRICING_ACTION_ACTION];
|
|
31694
|
+
*
|
|
31695
|
+
* // Dynamic property access
|
|
31696
|
+
* const propertyName = KEY_PREMIUM_PRICING_ACTION_ACTION;
|
|
31697
|
+
* const value = premiumpricingaction[propertyName];
|
|
31698
|
+
* ```
|
|
31699
|
+
*
|
|
31700
|
+
* @see {@link PremiumPricingAction} - The TypeScript type definition
|
|
31701
|
+
* @see {@link KEYS_PREMIUM_PRICING_ACTION} - Array of all keys for this type
|
|
31702
|
+
*/
|
|
31703
|
+
export const KEY_PREMIUM_PRICING_ACTION_ACTION: keyof PremiumPricingAction = 'action';
|
|
31704
|
+
/**
|
|
31705
|
+
* Currency
|
|
31706
|
+
*
|
|
31707
|
+
* Currency of the price
|
|
31708
|
+
*
|
|
31709
|
+
* @type {string}
|
|
31710
|
+
*
|
|
31711
|
+
*
|
|
31712
|
+
* @remarks
|
|
31713
|
+
* This key constant provides type-safe access to the `currency` property of PremiumPricingAction objects.
|
|
31714
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
31715
|
+
*
|
|
31716
|
+
* @example
|
|
31717
|
+
* ```typescript
|
|
31718
|
+
* // Direct property access
|
|
31719
|
+
* const value = premiumpricingaction[KEY_PREMIUM_PRICING_ACTION_CURRENCY];
|
|
31720
|
+
*
|
|
31721
|
+
* // Dynamic property access
|
|
31722
|
+
* const propertyName = KEY_PREMIUM_PRICING_ACTION_CURRENCY;
|
|
31723
|
+
* const value = premiumpricingaction[propertyName];
|
|
31724
|
+
* ```
|
|
31725
|
+
*
|
|
31726
|
+
* @see {@link PremiumPricingAction} - The TypeScript type definition
|
|
31727
|
+
* @see {@link KEYS_PREMIUM_PRICING_ACTION} - Array of all keys for this type
|
|
31728
|
+
*/
|
|
31729
|
+
export const KEY_PREMIUM_PRICING_ACTION_CURRENCY: keyof PremiumPricingAction = 'currency';
|
|
31730
|
+
/**
|
|
31731
|
+
* Price
|
|
31732
|
+
*
|
|
31733
|
+
* Customer-facing price after markup
|
|
31734
|
+
*
|
|
31735
|
+
* @type {string}
|
|
31736
|
+
*
|
|
31737
|
+
*
|
|
31738
|
+
* @remarks
|
|
31739
|
+
* This key constant provides type-safe access to the `price` property of PremiumPricingAction objects.
|
|
31740
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
31741
|
+
*
|
|
31742
|
+
* @example
|
|
31743
|
+
* ```typescript
|
|
31744
|
+
* // Direct property access
|
|
31745
|
+
* const value = premiumpricingaction[KEY_PREMIUM_PRICING_ACTION_PRICE];
|
|
31746
|
+
*
|
|
31747
|
+
* // Dynamic property access
|
|
31748
|
+
* const propertyName = KEY_PREMIUM_PRICING_ACTION_PRICE;
|
|
31749
|
+
* const value = premiumpricingaction[propertyName];
|
|
31750
|
+
* ```
|
|
31751
|
+
*
|
|
31752
|
+
* @see {@link PremiumPricingAction} - The TypeScript type definition
|
|
31753
|
+
* @see {@link KEYS_PREMIUM_PRICING_ACTION} - Array of all keys for this type
|
|
31754
|
+
*/
|
|
31755
|
+
export const KEY_PREMIUM_PRICING_ACTION_PRICE: keyof PremiumPricingAction = 'price';
|
|
31756
|
+
|
|
31757
|
+
/**
|
|
31758
|
+
* Array of all PremiumPricingAction property keys
|
|
31759
|
+
*
|
|
31760
|
+
* @remarks
|
|
31761
|
+
* This constant provides a readonly array containing all valid property keys for PremiumPricingAction objects.
|
|
31762
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
31763
|
+
*
|
|
31764
|
+
* @example
|
|
31765
|
+
* ```typescript
|
|
31766
|
+
* // Iterating through all keys
|
|
31767
|
+
* for (const key of KEYS_PREMIUM_PRICING_ACTION) {
|
|
31768
|
+
* console.log(`Property: ${key}, Value: ${premiumpricingaction[key]}`);
|
|
31769
|
+
* }
|
|
31770
|
+
*
|
|
31771
|
+
* // Validation
|
|
31772
|
+
* const isValidKey = KEYS_PREMIUM_PRICING_ACTION.includes(someKey);
|
|
31773
|
+
* ```
|
|
31774
|
+
*
|
|
31775
|
+
* @see {@link PremiumPricingAction} - The TypeScript type definition
|
|
31776
|
+
*/
|
|
31777
|
+
export const KEYS_PREMIUM_PRICING_ACTION = [
|
|
31778
|
+
KEY_PREMIUM_PRICING_ACTION_ACTION,
|
|
31779
|
+
KEY_PREMIUM_PRICING_ACTION_CURRENCY,
|
|
31780
|
+
KEY_PREMIUM_PRICING_ACTION_PRICE,
|
|
31781
|
+
] as const satisfies (keyof PremiumPricingAction)[];
|
|
31782
|
+
|
|
31783
|
+
/**
|
|
31784
|
+
* Prices
|
|
31785
|
+
*
|
|
31786
|
+
* Premium prices per action
|
|
31787
|
+
*
|
|
31788
|
+
* @type {array}
|
|
31789
|
+
*
|
|
31790
|
+
*
|
|
31791
|
+
* @remarks
|
|
31792
|
+
* This key constant provides type-safe access to the `prices` property of PremiumPricing objects.
|
|
31793
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
31794
|
+
*
|
|
31795
|
+
* @example
|
|
31796
|
+
* ```typescript
|
|
31797
|
+
* // Direct property access
|
|
31798
|
+
* const value = premiumpricing[KEY_PREMIUM_PRICING_PRICES];
|
|
31799
|
+
*
|
|
31800
|
+
* // Dynamic property access
|
|
31801
|
+
* const propertyName = KEY_PREMIUM_PRICING_PRICES;
|
|
31802
|
+
* const value = premiumpricing[propertyName];
|
|
31803
|
+
* ```
|
|
31804
|
+
*
|
|
31805
|
+
* @see {@link PremiumPricing} - The TypeScript type definition
|
|
31806
|
+
* @see {@link KEYS_PREMIUM_PRICING} - Array of all keys for this type
|
|
31807
|
+
*/
|
|
31808
|
+
export const KEY_PREMIUM_PRICING_PRICES: keyof PremiumPricing = 'prices';
|
|
31809
|
+
|
|
31810
|
+
/**
|
|
31811
|
+
* Array of all PremiumPricing property keys
|
|
31812
|
+
*
|
|
31813
|
+
* @remarks
|
|
31814
|
+
* This constant provides a readonly array containing all valid property keys for PremiumPricing objects.
|
|
31815
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
31816
|
+
*
|
|
31817
|
+
* @example
|
|
31818
|
+
* ```typescript
|
|
31819
|
+
* // Iterating through all keys
|
|
31820
|
+
* for (const key of KEYS_PREMIUM_PRICING) {
|
|
31821
|
+
* console.log(`Property: ${key}, Value: ${premiumpricing[key]}`);
|
|
31822
|
+
* }
|
|
31823
|
+
*
|
|
31824
|
+
* // Validation
|
|
31825
|
+
* const isValidKey = KEYS_PREMIUM_PRICING.includes(someKey);
|
|
31826
|
+
* ```
|
|
31827
|
+
*
|
|
31828
|
+
* @see {@link PremiumPricing} - The TypeScript type definition
|
|
31829
|
+
*/
|
|
31830
|
+
export const KEYS_PREMIUM_PRICING = [
|
|
31831
|
+
KEY_PREMIUM_PRICING_PRICES,
|
|
31832
|
+
] as const satisfies (keyof PremiumPricing)[];
|
|
31833
|
+
|
|
31676
31834
|
/**
|
|
31677
31835
|
* Currency
|
|
31678
31836
|
*
|
|
@@ -38266,6 +38424,57 @@ export const KEY_DOMAIN_AVAILABILITY_CHECK_AVAILABLE: keyof DomainAvailabilityCh
|
|
|
38266
38424
|
* @see {@link KEYS_DOMAIN_AVAILABILITY_CHECK} - Array of all keys for this type
|
|
38267
38425
|
*/
|
|
38268
38426
|
export const KEY_DOMAIN_AVAILABILITY_CHECK_DOMAIN: keyof DomainAvailabilityCheck = 'domain';
|
|
38427
|
+
/**
|
|
38428
|
+
* Is Premium
|
|
38429
|
+
*
|
|
38430
|
+
* Whether this is a premium domain
|
|
38431
|
+
*
|
|
38432
|
+
* @type {boolean}
|
|
38433
|
+
*
|
|
38434
|
+
*
|
|
38435
|
+
* @remarks
|
|
38436
|
+
* This key constant provides type-safe access to the `is_premium` property of DomainAvailabilityCheck objects.
|
|
38437
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
38438
|
+
*
|
|
38439
|
+
* @example
|
|
38440
|
+
* ```typescript
|
|
38441
|
+
* // Direct property access
|
|
38442
|
+
* const value = domainavailabilitycheck[KEY_DOMAIN_AVAILABILITY_CHECK_IS_PREMIUM];
|
|
38443
|
+
*
|
|
38444
|
+
* // Dynamic property access
|
|
38445
|
+
* const propertyName = KEY_DOMAIN_AVAILABILITY_CHECK_IS_PREMIUM;
|
|
38446
|
+
* const value = domainavailabilitycheck[propertyName];
|
|
38447
|
+
* ```
|
|
38448
|
+
*
|
|
38449
|
+
* @see {@link DomainAvailabilityCheck} - The TypeScript type definition
|
|
38450
|
+
* @see {@link KEYS_DOMAIN_AVAILABILITY_CHECK} - Array of all keys for this type
|
|
38451
|
+
*/
|
|
38452
|
+
export const KEY_DOMAIN_AVAILABILITY_CHECK_IS_PREMIUM: keyof DomainAvailabilityCheck = 'is_premium';
|
|
38453
|
+
/**
|
|
38454
|
+
* premium_pricing property
|
|
38455
|
+
*
|
|
38456
|
+
* Premium pricing details, present when domain is premium and pricing is available
|
|
38457
|
+
*
|
|
38458
|
+
*
|
|
38459
|
+
*
|
|
38460
|
+
* @remarks
|
|
38461
|
+
* This key constant provides type-safe access to the `premium_pricing` property of DomainAvailabilityCheck objects.
|
|
38462
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
38463
|
+
*
|
|
38464
|
+
* @example
|
|
38465
|
+
* ```typescript
|
|
38466
|
+
* // Direct property access
|
|
38467
|
+
* const value = domainavailabilitycheck[KEY_DOMAIN_AVAILABILITY_CHECK_PREMIUM_PRICING];
|
|
38468
|
+
*
|
|
38469
|
+
* // Dynamic property access
|
|
38470
|
+
* const propertyName = KEY_DOMAIN_AVAILABILITY_CHECK_PREMIUM_PRICING;
|
|
38471
|
+
* const value = domainavailabilitycheck[propertyName];
|
|
38472
|
+
* ```
|
|
38473
|
+
*
|
|
38474
|
+
* @see {@link DomainAvailabilityCheck} - The TypeScript type definition
|
|
38475
|
+
* @see {@link KEYS_DOMAIN_AVAILABILITY_CHECK} - Array of all keys for this type
|
|
38476
|
+
*/
|
|
38477
|
+
export const KEY_DOMAIN_AVAILABILITY_CHECK_PREMIUM_PRICING: keyof DomainAvailabilityCheck = 'premium_pricing';
|
|
38269
38478
|
/**
|
|
38270
38479
|
* Reason
|
|
38271
38480
|
*
|
|
@@ -38314,5 +38523,7 @@ export const KEY_DOMAIN_AVAILABILITY_CHECK_REASON: keyof DomainAvailabilityCheck
|
|
|
38314
38523
|
export const KEYS_DOMAIN_AVAILABILITY_CHECK = [
|
|
38315
38524
|
KEY_DOMAIN_AVAILABILITY_CHECK_AVAILABLE,
|
|
38316
38525
|
KEY_DOMAIN_AVAILABILITY_CHECK_DOMAIN,
|
|
38526
|
+
KEY_DOMAIN_AVAILABILITY_CHECK_IS_PREMIUM,
|
|
38527
|
+
KEY_DOMAIN_AVAILABILITY_CHECK_PREMIUM_PRICING,
|
|
38317
38528
|
KEY_DOMAIN_AVAILABILITY_CHECK_REASON,
|
|
38318
38529
|
] as const satisfies (keyof DomainAvailabilityCheck)[];
|
|
@@ -374,11 +374,10 @@ Specify one or more domains to check for availability.
|
|
|
374
374
|
* @see {@link GET_Availability_Response_200} - 200 response type
|
|
375
375
|
* @see {@link GET_Availability_Response_401} - 401 response type
|
|
376
376
|
* @see {@link GET_Availability_Response_422} - 422 response type
|
|
377
|
-
* @see {@link GET_Availability_Response_500} - 500 response type
|
|
378
377
|
*
|
|
379
378
|
|
|
380
379
|
*/
|
|
381
|
-
export type GET_Availability_Response = GET_Availability_Response_200 | GET_Availability_Response_401 | GET_Availability_Response_422
|
|
380
|
+
export type GET_Availability_Response = GET_Availability_Response_200 | GET_Availability_Response_401 | GET_Availability_Response_422;
|
|
382
381
|
|
|
383
382
|
/**
|
|
384
383
|
* 200 response for GET Availability endpoint
|
|
@@ -440,26 +439,6 @@ Specify one or more domains to check for availability.
|
|
|
440
439
|
*/
|
|
441
440
|
export type GET_Availability_Response_422 = HTTPValidationError
|
|
442
441
|
|
|
443
|
-
/**
|
|
444
|
-
* 500 response for GET Availability endpoint
|
|
445
|
-
*
|
|
446
|
-
* @remarks
|
|
447
|
-
* This type defines the response structure for the 500 status code
|
|
448
|
-
* of the GET Availability endpoint.
|
|
449
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
450
|
-
*
|
|
451
|
-
|
|
452
|
-
*
|
|
453
|
-
* @path /v1/availability
|
|
454
|
-
* @param domains (query) -
|
|
455
|
-
Specify one or more domains to check for availability.
|
|
456
|
-
|
|
457
|
-
*
|
|
458
|
-
* @see {@link GET_Availability_Response} - The main response type definition
|
|
459
|
-
* @see {@link Problem} - The actual schema type definition
|
|
460
|
-
*/
|
|
461
|
-
export type GET_Availability_Response_500 = Problem
|
|
462
|
-
|
|
463
442
|
/**
|
|
464
443
|
* Response types for GET AvailabilityStream endpoint
|
|
465
444
|
*
|
|
@@ -480,11 +459,10 @@ Specify one or more domains to check for availability.
|
|
|
480
459
|
*
|
|
481
460
|
* @see {@link GET_AvailabilityStream_Response_401} - 401 response type
|
|
482
461
|
* @see {@link GET_AvailabilityStream_Response_422} - 422 response type
|
|
483
|
-
* @see {@link GET_AvailabilityStream_Response_500} - 500 response type
|
|
484
462
|
*
|
|
485
463
|
|
|
486
464
|
*/
|
|
487
|
-
export type GET_AvailabilityStream_Response = GET_AvailabilityStream_Response_401 | GET_AvailabilityStream_Response_422
|
|
465
|
+
export type GET_AvailabilityStream_Response = GET_AvailabilityStream_Response_401 | GET_AvailabilityStream_Response_422;
|
|
488
466
|
|
|
489
467
|
/**
|
|
490
468
|
* 401 response for GET AvailabilityStream endpoint
|
|
@@ -526,26 +504,6 @@ Specify one or more domains to check for availability.
|
|
|
526
504
|
*/
|
|
527
505
|
export type GET_AvailabilityStream_Response_422 = HTTPValidationError
|
|
528
506
|
|
|
529
|
-
/**
|
|
530
|
-
* 500 response for GET AvailabilityStream endpoint
|
|
531
|
-
*
|
|
532
|
-
* @remarks
|
|
533
|
-
* This type defines the response structure for the 500 status code
|
|
534
|
-
* of the GET AvailabilityStream endpoint.
|
|
535
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
536
|
-
*
|
|
537
|
-
|
|
538
|
-
*
|
|
539
|
-
* @path /v1/availability/stream
|
|
540
|
-
* @param domains (query) -
|
|
541
|
-
Specify one or more domains to check for availability.
|
|
542
|
-
|
|
543
|
-
*
|
|
544
|
-
* @see {@link GET_AvailabilityStream_Response} - The main response type definition
|
|
545
|
-
* @see {@link Problem} - The actual schema type definition
|
|
546
|
-
*/
|
|
547
|
-
export type GET_AvailabilityStream_Response_500 = Problem
|
|
548
|
-
|
|
549
507
|
/**
|
|
550
508
|
* Response types for POST AvailabilityStream endpoint
|
|
551
509
|
*
|
|
@@ -563,11 +521,10 @@ export type GET_AvailabilityStream_Response_500 = Problem
|
|
|
563
521
|
*
|
|
564
522
|
* @see {@link POST_AvailabilityStream_Response_401} - 401 response type
|
|
565
523
|
* @see {@link POST_AvailabilityStream_Response_422} - 422 response type
|
|
566
|
-
* @see {@link POST_AvailabilityStream_Response_500} - 500 response type
|
|
567
524
|
*
|
|
568
525
|
|
|
569
526
|
*/
|
|
570
|
-
export type POST_AvailabilityStream_Response = POST_AvailabilityStream_Response_401 | POST_AvailabilityStream_Response_422
|
|
527
|
+
export type POST_AvailabilityStream_Response = POST_AvailabilityStream_Response_401 | POST_AvailabilityStream_Response_422;
|
|
571
528
|
|
|
572
529
|
/**
|
|
573
530
|
* 401 response for POST AvailabilityStream endpoint
|
|
@@ -603,23 +560,6 @@ export type POST_AvailabilityStream_Response_401 = Problem
|
|
|
603
560
|
*/
|
|
604
561
|
export type POST_AvailabilityStream_Response_422 = HTTPValidationError
|
|
605
562
|
|
|
606
|
-
/**
|
|
607
|
-
* 500 response for POST AvailabilityStream endpoint
|
|
608
|
-
*
|
|
609
|
-
* @remarks
|
|
610
|
-
* This type defines the response structure for the 500 status code
|
|
611
|
-
* of the POST AvailabilityStream endpoint.
|
|
612
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
613
|
-
*
|
|
614
|
-
|
|
615
|
-
*
|
|
616
|
-
* @path /v1/availability/stream
|
|
617
|
-
*
|
|
618
|
-
* @see {@link POST_AvailabilityStream_Response} - The main response type definition
|
|
619
|
-
* @see {@link Problem} - The actual schema type definition
|
|
620
|
-
*/
|
|
621
|
-
export type POST_AvailabilityStream_Response_500 = Problem
|
|
622
|
-
|
|
623
563
|
/**
|
|
624
564
|
* Response types for GET Contacts endpoint
|
|
625
565
|
*
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
* This file is auto-generated from the OpenAPI specification.
|
|
22
22
|
* Do not edit manually.
|
|
23
23
|
*/
|
|
24
|
-
import { DomainDnssecData, DomainDnssecDataCreate, JobStatus, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, ReportType, ReportStatus, TldResponseShort, AttributeCondition, DomainContactType, ContactCreateBulkInstance, ContactAttributeLinkDetail, ContactAttributeDefinition, PostalAddressType, ContactConfigBase, CommandError, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsZoneCreateBulkInstance, DnsRecordPatchOp, DnsZonePatchRecordsBulkInstance, DnsRrsetPatchOp, DnsZonePatchRrsetsBulkInstance, DnsRrset, DnsZoneUpdateBulkInstance, DomainAvailabilityCheck, ContactHandle, Nameserver, DomainCreateBulkInstance, BrowserStatsBucket, GeoStatsBucket, TimeSeriesBucket, DomainForwardPatchOp, PlatformStatsBucket, HttpRedirectRequest, HttpRedirectList, ReferrerStatsBucket, StatusCodeStatsBucket, UserAgentStatsBucket, VisitsByKeyBucket, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainSearchSuggestionWithPrice, DomainStatus, DomainTransferBulkInstance, DomainClientStatus, DomainUpdateBulkInstance, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAliasMetrics, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LegalRequirementOperationType, LocalPresenceRequirementType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactAttributeSet, Contact, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, JobBatchMetadata, Job, ObjectLog, Organization, Parking, RequestHistory, UserPublic, ParkingCreateBulkInstance, ParkingDeleteBulkInstance, ParkingDisableBulkInstance, ParkingEnableBulkInstance, Period, Permission, PremiumAffectsType, PublicReportRes, Relation, LegalRequirementBase, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
|
|
24
|
+
import { DomainDnssecData, DomainDnssecDataCreate, JobStatus, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, ReportType, ReportStatus, TldResponseShort, AttributeCondition, DomainContactType, ContactCreateBulkInstance, ContactAttributeLinkDetail, ContactAttributeDefinition, PostalAddressType, ContactConfigBase, CommandError, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsZoneCreateBulkInstance, DnsRecordPatchOp, DnsZonePatchRecordsBulkInstance, DnsRrsetPatchOp, DnsZonePatchRrsetsBulkInstance, DnsRrset, DnsZoneUpdateBulkInstance, DomainAvailabilityCheck, ContactHandle, Nameserver, DomainCreateBulkInstance, BrowserStatsBucket, GeoStatsBucket, TimeSeriesBucket, DomainForwardPatchOp, PlatformStatsBucket, HttpRedirectRequest, HttpRedirectList, ReferrerStatsBucket, StatusCodeStatsBucket, UserAgentStatsBucket, VisitsByKeyBucket, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainSearchSuggestionWithPrice, DomainStatus, DomainTransferBulkInstance, DomainClientStatus, DomainUpdateBulkInstance, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAliasMetrics, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LegalRequirementOperationType, LocalPresenceRequirementType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactAttributeSet, Contact, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, JobBatchMetadata, Job, ObjectLog, Organization, Parking, RequestHistory, UserPublic, ParkingCreateBulkInstance, ParkingDeleteBulkInstance, ParkingDisableBulkInstance, ParkingEnableBulkInstance, Period, Permission, PremiumAffectsType, PremiumPricingAction, PublicReportRes, Relation, LegalRequirementBase, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* DomainDnssecDataResponse
|
|
@@ -1297,6 +1297,20 @@ export type PermissionArray = Permission[];
|
|
|
1297
1297
|
* @see {@link PremiumAffectsType} - The individual PremiumAffectsType type definition
|
|
1298
1298
|
*/
|
|
1299
1299
|
export type PremiumAffectsTypeArray = PremiumAffectsType[];
|
|
1300
|
+
/**
|
|
1301
|
+
* PremiumPricingAction
|
|
1302
|
+
*
|
|
1303
|
+
* @remarks
|
|
1304
|
+
* Array type for PremiumPricingAction objects. Used when the API returns a collection of PremiumPricingAction instances.
|
|
1305
|
+
*
|
|
1306
|
+
* @example
|
|
1307
|
+
* ```typescript
|
|
1308
|
+
* const items: PremiumPricingActionArray = await api.getPremiumPricingActions();
|
|
1309
|
+
* ```
|
|
1310
|
+
*
|
|
1311
|
+
* @see {@link PremiumPricingAction} - The individual PremiumPricingAction type definition
|
|
1312
|
+
*/
|
|
1313
|
+
export type PremiumPricingActionArray = PremiumPricingAction[];
|
|
1300
1314
|
/**
|
|
1301
1315
|
* PublicReportRes
|
|
1302
1316
|
*
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -5044,6 +5044,38 @@ export type PremiumAffectsType = components['schemas']['PremiumAffectsType'];
|
|
|
5044
5044
|
* @see {@link components} - The OpenAPI components schema definition
|
|
5045
5045
|
*/
|
|
5046
5046
|
export type PremiumDomainsBase = components['schemas']['PremiumDomainsBase'];
|
|
5047
|
+
/**
|
|
5048
|
+
* PremiumPricingAction
|
|
5049
|
+
*
|
|
5050
|
+
* @remarks
|
|
5051
|
+
* Type alias for the `PremiumPricingAction` OpenAPI schema.
|
|
5052
|
+
* This type represents premiumpricingaction data structures used in API requests and responses.
|
|
5053
|
+
*
|
|
5054
|
+
* @example
|
|
5055
|
+
* ```typescript
|
|
5056
|
+
* const response = await api.getPremiumPricingAction();
|
|
5057
|
+
* const item: PremiumPricingAction = response.results;
|
|
5058
|
+
* ```
|
|
5059
|
+
*
|
|
5060
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
5061
|
+
*/
|
|
5062
|
+
export type PremiumPricingAction = components['schemas']['PremiumPricingAction'];
|
|
5063
|
+
/**
|
|
5064
|
+
* PremiumPricingResponse
|
|
5065
|
+
*
|
|
5066
|
+
* @remarks
|
|
5067
|
+
* Type alias for the `PremiumPricingResponse` OpenAPI schema.
|
|
5068
|
+
* This type represents premiumpricingresponse data structures used in API requests and responses.
|
|
5069
|
+
*
|
|
5070
|
+
* @example
|
|
5071
|
+
* ```typescript
|
|
5072
|
+
* const response = await api.getPremiumPricing();
|
|
5073
|
+
* const item: PremiumPricing = response.results;
|
|
5074
|
+
* ```
|
|
5075
|
+
*
|
|
5076
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
5077
|
+
*/
|
|
5078
|
+
export type PremiumPricing = components['schemas']['PremiumPricingResponse'];
|
|
5047
5079
|
/**
|
|
5048
5080
|
* PremiumSourceType
|
|
5049
5081
|
*
|
package/src/openapi.yaml
CHANGED
|
@@ -7906,6 +7906,39 @@ components:
|
|
|
7906
7906
|
- supported
|
|
7907
7907
|
title: PremiumDomainsBase
|
|
7908
7908
|
type: object
|
|
7909
|
+
PremiumPricingAction:
|
|
7910
|
+
properties:
|
|
7911
|
+
action:
|
|
7912
|
+
description: The action (e.g., create, renew, transfer)
|
|
7913
|
+
title: Action
|
|
7914
|
+
type: string
|
|
7915
|
+
currency:
|
|
7916
|
+
description: Currency of the price
|
|
7917
|
+
title: Currency
|
|
7918
|
+
type: string
|
|
7919
|
+
price:
|
|
7920
|
+
description: Customer-facing price after markup
|
|
7921
|
+
pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
|
|
7922
|
+
title: Price
|
|
7923
|
+
type: string
|
|
7924
|
+
required:
|
|
7925
|
+
- action
|
|
7926
|
+
- price
|
|
7927
|
+
- currency
|
|
7928
|
+
title: PremiumPricingAction
|
|
7929
|
+
type: object
|
|
7930
|
+
PremiumPricingResponse:
|
|
7931
|
+
properties:
|
|
7932
|
+
prices:
|
|
7933
|
+
description: Premium prices per action
|
|
7934
|
+
items:
|
|
7935
|
+
$ref: '#/components/schemas/PremiumPricingAction'
|
|
7936
|
+
title: Prices
|
|
7937
|
+
type: array
|
|
7938
|
+
required:
|
|
7939
|
+
- prices
|
|
7940
|
+
title: PremiumPricingResponse
|
|
7941
|
+
type: object
|
|
7909
7942
|
PremiumSourceType:
|
|
7910
7943
|
enum:
|
|
7911
7944
|
- EPP
|
|
@@ -9572,6 +9605,17 @@ components:
|
|
|
9572
9605
|
- example.com
|
|
9573
9606
|
title: Domain
|
|
9574
9607
|
type: string
|
|
9608
|
+
is_premium:
|
|
9609
|
+
default: false
|
|
9610
|
+
description: Whether this is a premium domain
|
|
9611
|
+
title: Is Premium
|
|
9612
|
+
type: boolean
|
|
9613
|
+
premium_pricing:
|
|
9614
|
+
anyOf:
|
|
9615
|
+
- $ref: '#/components/schemas/PremiumPricingResponse'
|
|
9616
|
+
- type: 'null'
|
|
9617
|
+
description: Premium pricing details, present when domain is premium and
|
|
9618
|
+
pricing is available
|
|
9575
9619
|
reason:
|
|
9576
9620
|
anyOf:
|
|
9577
9621
|
- type: string
|
|
@@ -9653,7 +9697,7 @@ info:
|
|
|
9653
9697
|
\n\n"
|
|
9654
9698
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
9655
9699
|
title: OpusDNS API
|
|
9656
|
-
version: 2026-04-
|
|
9700
|
+
version: 2026-04-08-180509
|
|
9657
9701
|
x-logo:
|
|
9658
9702
|
altText: OpusDNS API Reference
|
|
9659
9703
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -10332,7 +10376,7 @@ paths:
|
|
|
10332
10376
|
'
|
|
10333
10377
|
items:
|
|
10334
10378
|
type: string
|
|
10335
|
-
maxItems:
|
|
10379
|
+
maxItems: 50
|
|
10336
10380
|
title: Domains
|
|
10337
10381
|
type: array
|
|
10338
10382
|
responses:
|
|
@@ -10360,18 +10404,6 @@ paths:
|
|
|
10360
10404
|
schema:
|
|
10361
10405
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
10362
10406
|
description: Validation Error
|
|
10363
|
-
'500':
|
|
10364
|
-
content:
|
|
10365
|
-
application/problem+json:
|
|
10366
|
-
example:
|
|
10367
|
-
code: ERROR_AVAILABILITY_PROVIDER
|
|
10368
|
-
detail: Additional error context.
|
|
10369
|
-
status: 500
|
|
10370
|
-
title: Availability Error
|
|
10371
|
-
type: availability-internal
|
|
10372
|
-
schema:
|
|
10373
|
-
$ref: '#/components/schemas/Problem'
|
|
10374
|
-
description: Internal Server Error
|
|
10375
10407
|
security:
|
|
10376
10408
|
- OAuth2PasswordBearer: []
|
|
10377
10409
|
- APIKeyHeader: []
|
|
@@ -10380,6 +10412,7 @@ paths:
|
|
|
10380
10412
|
- availability
|
|
10381
10413
|
/v1/availability/stream:
|
|
10382
10414
|
get:
|
|
10415
|
+
deprecated: true
|
|
10383
10416
|
description: Stream domain availability results using Server-Sent Events (SSE)
|
|
10384
10417
|
until the `done` event is received.
|
|
10385
10418
|
operationId: stream_availability_v1_availability_stream_get
|
|
@@ -10443,18 +10476,6 @@ paths:
|
|
|
10443
10476
|
schema:
|
|
10444
10477
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
10445
10478
|
description: Validation Error
|
|
10446
|
-
'500':
|
|
10447
|
-
content:
|
|
10448
|
-
application/problem+json:
|
|
10449
|
-
example:
|
|
10450
|
-
code: ERROR_AVAILABILITY_PROVIDER
|
|
10451
|
-
detail: Additional error context.
|
|
10452
|
-
status: 500
|
|
10453
|
-
title: Availability Error
|
|
10454
|
-
type: availability-internal
|
|
10455
|
-
schema:
|
|
10456
|
-
$ref: '#/components/schemas/Problem'
|
|
10457
|
-
description: Internal Server Error
|
|
10458
10479
|
security:
|
|
10459
10480
|
- OAuth2PasswordBearer: []
|
|
10460
10481
|
- APIKeyHeader: []
|
|
@@ -10505,18 +10526,6 @@ paths:
|
|
|
10505
10526
|
schema:
|
|
10506
10527
|
$ref: '#/components/schemas/HTTPValidationError'
|
|
10507
10528
|
description: Validation Error
|
|
10508
|
-
'500':
|
|
10509
|
-
content:
|
|
10510
|
-
application/problem+json:
|
|
10511
|
-
example:
|
|
10512
|
-
code: ERROR_AVAILABILITY_PROVIDER
|
|
10513
|
-
detail: Additional error context.
|
|
10514
|
-
status: 500
|
|
10515
|
-
title: Availability Error
|
|
10516
|
-
type: availability-internal
|
|
10517
|
-
schema:
|
|
10518
|
-
$ref: '#/components/schemas/Problem'
|
|
10519
|
-
description: Internal Server Error
|
|
10520
10529
|
security:
|
|
10521
10530
|
- OAuth2PasswordBearer: []
|
|
10522
10531
|
- APIKeyHeader: []
|
package/src/schema.d.ts
CHANGED
|
@@ -146,6 +146,7 @@ export interface paths {
|
|
|
146
146
|
};
|
|
147
147
|
/**
|
|
148
148
|
* Stream domain availability results
|
|
149
|
+
* @deprecated
|
|
149
150
|
* @description Stream domain availability results using Server-Sent Events (SSE) until the `done` event is received.
|
|
150
151
|
*/
|
|
151
152
|
get: operations["stream_availability_v1_availability_stream_get"];
|
|
@@ -7455,6 +7456,32 @@ export interface components {
|
|
|
7455
7456
|
*/
|
|
7456
7457
|
supported: boolean;
|
|
7457
7458
|
};
|
|
7459
|
+
/** PremiumPricingAction */
|
|
7460
|
+
PremiumPricingAction: {
|
|
7461
|
+
/**
|
|
7462
|
+
* Action
|
|
7463
|
+
* @description The action (e.g., create, renew, transfer)
|
|
7464
|
+
*/
|
|
7465
|
+
action: string;
|
|
7466
|
+
/**
|
|
7467
|
+
* Currency
|
|
7468
|
+
* @description Currency of the price
|
|
7469
|
+
*/
|
|
7470
|
+
currency: string;
|
|
7471
|
+
/**
|
|
7472
|
+
* Price
|
|
7473
|
+
* @description Customer-facing price after markup
|
|
7474
|
+
*/
|
|
7475
|
+
price: string;
|
|
7476
|
+
};
|
|
7477
|
+
/** PremiumPricingResponse */
|
|
7478
|
+
PremiumPricingResponse: {
|
|
7479
|
+
/**
|
|
7480
|
+
* Prices
|
|
7481
|
+
* @description Premium prices per action
|
|
7482
|
+
*/
|
|
7483
|
+
prices: components["schemas"]["PremiumPricingAction"][];
|
|
7484
|
+
};
|
|
7458
7485
|
/**
|
|
7459
7486
|
* PremiumSourceType
|
|
7460
7487
|
* @enum {string}
|
|
@@ -8587,6 +8614,14 @@ export interface components {
|
|
|
8587
8614
|
* @example example.com
|
|
8588
8615
|
*/
|
|
8589
8616
|
domain: string;
|
|
8617
|
+
/**
|
|
8618
|
+
* Is Premium
|
|
8619
|
+
* @description Whether this is a premium domain
|
|
8620
|
+
* @default false
|
|
8621
|
+
*/
|
|
8622
|
+
is_premium: boolean;
|
|
8623
|
+
/** @description Premium pricing details, present when domain is premium and pricing is available */
|
|
8624
|
+
premium_pricing?: components["schemas"]["PremiumPricingResponse"] | null;
|
|
8590
8625
|
/** Reason */
|
|
8591
8626
|
reason: string | null;
|
|
8592
8627
|
};
|
|
@@ -8901,22 +8936,6 @@ export interface operations {
|
|
|
8901
8936
|
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
8902
8937
|
};
|
|
8903
8938
|
};
|
|
8904
|
-
/** @description Internal Server Error */
|
|
8905
|
-
500: {
|
|
8906
|
-
headers: {
|
|
8907
|
-
[name: string]: unknown;
|
|
8908
|
-
};
|
|
8909
|
-
content: {
|
|
8910
|
-
/** @example {
|
|
8911
|
-
* "code": "ERROR_AVAILABILITY_PROVIDER",
|
|
8912
|
-
* "detail": "Additional error context.",
|
|
8913
|
-
* "status": 500,
|
|
8914
|
-
* "title": "Availability Error",
|
|
8915
|
-
* "type": "availability-internal"
|
|
8916
|
-
* } */
|
|
8917
|
-
"application/problem+json": components["schemas"]["Problem"];
|
|
8918
|
-
};
|
|
8919
|
-
};
|
|
8920
8939
|
};
|
|
8921
8940
|
};
|
|
8922
8941
|
stream_availability_v1_availability_stream_get: {
|
|
@@ -8967,22 +8986,6 @@ export interface operations {
|
|
|
8967
8986
|
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
8968
8987
|
};
|
|
8969
8988
|
};
|
|
8970
|
-
/** @description Internal Server Error */
|
|
8971
|
-
500: {
|
|
8972
|
-
headers: {
|
|
8973
|
-
[name: string]: unknown;
|
|
8974
|
-
};
|
|
8975
|
-
content: {
|
|
8976
|
-
/** @example {
|
|
8977
|
-
* "code": "ERROR_AVAILABILITY_PROVIDER",
|
|
8978
|
-
* "detail": "Additional error context.",
|
|
8979
|
-
* "status": 500,
|
|
8980
|
-
* "title": "Availability Error",
|
|
8981
|
-
* "type": "availability-internal"
|
|
8982
|
-
* } */
|
|
8983
|
-
"application/problem+json": components["schemas"]["Problem"];
|
|
8984
|
-
};
|
|
8985
|
-
};
|
|
8986
8989
|
};
|
|
8987
8990
|
};
|
|
8988
8991
|
stream_availability_post_v1_availability_stream_post: {
|
|
@@ -9032,22 +9035,6 @@ export interface operations {
|
|
|
9032
9035
|
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
9033
9036
|
};
|
|
9034
9037
|
};
|
|
9035
|
-
/** @description Internal Server Error */
|
|
9036
|
-
500: {
|
|
9037
|
-
headers: {
|
|
9038
|
-
[name: string]: unknown;
|
|
9039
|
-
};
|
|
9040
|
-
content: {
|
|
9041
|
-
/** @example {
|
|
9042
|
-
* "code": "ERROR_AVAILABILITY_PROVIDER",
|
|
9043
|
-
* "detail": "Additional error context.",
|
|
9044
|
-
* "status": 500,
|
|
9045
|
-
* "title": "Availability Error",
|
|
9046
|
-
* "type": "availability-internal"
|
|
9047
|
-
* } */
|
|
9048
|
-
"application/problem+json": components["schemas"]["Problem"];
|
|
9049
|
-
};
|
|
9050
|
-
};
|
|
9051
9038
|
};
|
|
9052
9039
|
};
|
|
9053
9040
|
get_contacts_v1_contacts_get: {
|