@opusdns/api 0.103.0 → 0.104.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 +86 -8
- package/src/helpers/schemas.d.ts +16 -0
- package/src/openapi.yaml +20 -6
- package/src/schema.d.ts +15 -5
package/package.json
CHANGED
package/src/helpers/keys.ts
CHANGED
|
@@ -146,6 +146,7 @@ import { TldBase } from './schemas';
|
|
|
146
146
|
import { TldResponseShort } from './schemas';
|
|
147
147
|
import { TldSpecification } from './schemas';
|
|
148
148
|
import { TrademarkClaimsBase } from './schemas';
|
|
149
|
+
import { TransferLockPolicyBase } from './schemas';
|
|
149
150
|
import { TransferPoliciesBase } from './schemas';
|
|
150
151
|
import { User } from './schemas';
|
|
151
152
|
import { UserAttributeBase } from './schemas';
|
|
@@ -18395,6 +18396,84 @@ export const KEYS_TRADEMARK_CLAIMS_BASE = [
|
|
|
18395
18396
|
KEY_TRADEMARK_CLAIMS_BASE_TMCH_REQUIRED,
|
|
18396
18397
|
] as const satisfies (keyof TrademarkClaimsBase)[];
|
|
18397
18398
|
|
|
18399
|
+
/**
|
|
18400
|
+
* Supported By Registrar
|
|
18401
|
+
*
|
|
18402
|
+
* Whether the registrar supports transfer locks
|
|
18403
|
+
*
|
|
18404
|
+
* @type {boolean}
|
|
18405
|
+
*
|
|
18406
|
+
*
|
|
18407
|
+
* @remarks
|
|
18408
|
+
* This key constant provides type-safe access to the `supported_by_registrar` property of TransferLockPolicyBase objects.
|
|
18409
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
18410
|
+
*
|
|
18411
|
+
* @example
|
|
18412
|
+
* ```typescript
|
|
18413
|
+
* // Direct property access
|
|
18414
|
+
* const value = transferlockpolicybase[KEY_TRANSFER_LOCK_POLICY_BASE_SUPPORTED_BY_REGISTRAR];
|
|
18415
|
+
*
|
|
18416
|
+
* // Dynamic property access
|
|
18417
|
+
* const propertyName = KEY_TRANSFER_LOCK_POLICY_BASE_SUPPORTED_BY_REGISTRAR;
|
|
18418
|
+
* const value = transferlockpolicybase[propertyName];
|
|
18419
|
+
* ```
|
|
18420
|
+
*
|
|
18421
|
+
* @see {@link TransferLockPolicyBase} - The TypeScript type definition
|
|
18422
|
+
* @see {@link KEYS_TRANSFER_LOCK_POLICY_BASE} - Array of all keys for this type
|
|
18423
|
+
*/
|
|
18424
|
+
export const KEY_TRANSFER_LOCK_POLICY_BASE_SUPPORTED_BY_REGISTRAR = 'supported_by_registrar' as keyof TransferLockPolicyBase;
|
|
18425
|
+
/**
|
|
18426
|
+
* Supported By Registry
|
|
18427
|
+
*
|
|
18428
|
+
* Whether the registry supports transfer locks
|
|
18429
|
+
*
|
|
18430
|
+
* @type {boolean}
|
|
18431
|
+
*
|
|
18432
|
+
*
|
|
18433
|
+
* @remarks
|
|
18434
|
+
* This key constant provides type-safe access to the `supported_by_registry` property of TransferLockPolicyBase objects.
|
|
18435
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
18436
|
+
*
|
|
18437
|
+
* @example
|
|
18438
|
+
* ```typescript
|
|
18439
|
+
* // Direct property access
|
|
18440
|
+
* const value = transferlockpolicybase[KEY_TRANSFER_LOCK_POLICY_BASE_SUPPORTED_BY_REGISTRY];
|
|
18441
|
+
*
|
|
18442
|
+
* // Dynamic property access
|
|
18443
|
+
* const propertyName = KEY_TRANSFER_LOCK_POLICY_BASE_SUPPORTED_BY_REGISTRY;
|
|
18444
|
+
* const value = transferlockpolicybase[propertyName];
|
|
18445
|
+
* ```
|
|
18446
|
+
*
|
|
18447
|
+
* @see {@link TransferLockPolicyBase} - The TypeScript type definition
|
|
18448
|
+
* @see {@link KEYS_TRANSFER_LOCK_POLICY_BASE} - Array of all keys for this type
|
|
18449
|
+
*/
|
|
18450
|
+
export const KEY_TRANSFER_LOCK_POLICY_BASE_SUPPORTED_BY_REGISTRY = 'supported_by_registry' as keyof TransferLockPolicyBase;
|
|
18451
|
+
|
|
18452
|
+
/**
|
|
18453
|
+
* Array of all TransferLockPolicyBase property keys
|
|
18454
|
+
*
|
|
18455
|
+
* @remarks
|
|
18456
|
+
* This constant provides a readonly array containing all valid property keys for TransferLockPolicyBase objects.
|
|
18457
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
18458
|
+
*
|
|
18459
|
+
* @example
|
|
18460
|
+
* ```typescript
|
|
18461
|
+
* // Iterating through all keys
|
|
18462
|
+
* for (const key of KEYS_TRANSFER_LOCK_POLICY_BASE) {
|
|
18463
|
+
* console.log(`Property: ${key}, Value: ${transferlockpolicybase[key]}`);
|
|
18464
|
+
* }
|
|
18465
|
+
*
|
|
18466
|
+
* // Validation
|
|
18467
|
+
* const isValidKey = KEYS_TRANSFER_LOCK_POLICY_BASE.includes(someKey);
|
|
18468
|
+
* ```
|
|
18469
|
+
*
|
|
18470
|
+
* @see {@link TransferLockPolicyBase} - The TypeScript type definition
|
|
18471
|
+
*/
|
|
18472
|
+
export const KEYS_TRANSFER_LOCK_POLICY_BASE = [
|
|
18473
|
+
KEY_TRANSFER_LOCK_POLICY_BASE_SUPPORTED_BY_REGISTRAR,
|
|
18474
|
+
KEY_TRANSFER_LOCK_POLICY_BASE_SUPPORTED_BY_REGISTRY,
|
|
18475
|
+
] as const satisfies (keyof TransferLockPolicyBase)[];
|
|
18476
|
+
|
|
18398
18477
|
/**
|
|
18399
18478
|
* Authinfo Max Length
|
|
18400
18479
|
*
|
|
@@ -18647,31 +18726,30 @@ export const KEY_TRANSFER_POLICIES_BASE_TRANSFER_ACK = 'transfer_ack' as keyof T
|
|
|
18647
18726
|
*/
|
|
18648
18727
|
export const KEY_TRANSFER_POLICIES_BASE_TRANSFER_EMAIL_REQUIRED = 'transfer_email_required' as keyof TransferPoliciesBase;
|
|
18649
18728
|
/**
|
|
18650
|
-
*
|
|
18729
|
+
* transfer_lock_policy property
|
|
18651
18730
|
*
|
|
18652
|
-
*
|
|
18731
|
+
* Transfer lock policy
|
|
18653
18732
|
*
|
|
18654
|
-
* @type {boolean}
|
|
18655
18733
|
*
|
|
18656
18734
|
*
|
|
18657
18735
|
* @remarks
|
|
18658
|
-
* This key constant provides type-safe access to the `
|
|
18736
|
+
* This key constant provides type-safe access to the `transfer_lock_policy` property of TransferPoliciesBase objects.
|
|
18659
18737
|
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
18660
18738
|
*
|
|
18661
18739
|
* @example
|
|
18662
18740
|
* ```typescript
|
|
18663
18741
|
* // Direct property access
|
|
18664
|
-
* const value = transferpoliciesbase[
|
|
18742
|
+
* const value = transferpoliciesbase[KEY_TRANSFER_POLICIES_BASE_TRANSFER_LOCK_POLICY];
|
|
18665
18743
|
*
|
|
18666
18744
|
* // Dynamic property access
|
|
18667
|
-
* const propertyName =
|
|
18745
|
+
* const propertyName = KEY_TRANSFER_POLICIES_BASE_TRANSFER_LOCK_POLICY;
|
|
18668
18746
|
* const value = transferpoliciesbase[propertyName];
|
|
18669
18747
|
* ```
|
|
18670
18748
|
*
|
|
18671
18749
|
* @see {@link TransferPoliciesBase} - The TypeScript type definition
|
|
18672
18750
|
* @see {@link KEYS_TRANSFER_POLICIES_BASE} - Array of all keys for this type
|
|
18673
18751
|
*/
|
|
18674
|
-
export const
|
|
18752
|
+
export const KEY_TRANSFER_POLICIES_BASE_TRANSFER_LOCK_POLICY = 'transfer_lock_policy' as keyof TransferPoliciesBase;
|
|
18675
18753
|
/**
|
|
18676
18754
|
* transfer_nack property
|
|
18677
18755
|
*
|
|
@@ -18804,7 +18882,7 @@ export const KEYS_TRANSFER_POLICIES_BASE = [
|
|
|
18804
18882
|
KEY_TRANSFER_POLICIES_BASE_POST_TRANSFER_REQUIREMENTS,
|
|
18805
18883
|
KEY_TRANSFER_POLICIES_BASE_TRANSFER_ACK,
|
|
18806
18884
|
KEY_TRANSFER_POLICIES_BASE_TRANSFER_EMAIL_REQUIRED,
|
|
18807
|
-
|
|
18885
|
+
KEY_TRANSFER_POLICIES_BASE_TRANSFER_LOCK_POLICY,
|
|
18808
18886
|
KEY_TRANSFER_POLICIES_BASE_TRANSFER_NACK,
|
|
18809
18887
|
KEY_TRANSFER_POLICIES_BASE_TRANSFER_RENEWAL_PERIOD,
|
|
18810
18888
|
KEY_TRANSFER_POLICIES_BASE_TRANSFER_RENEWS_DOMAIN,
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -3119,6 +3119,22 @@ export type TrademarkClaimsBase = components['schemas']['TrademarkClaimsBase'];
|
|
|
3119
3119
|
* @see {@link components} - The OpenAPI components schema definition
|
|
3120
3120
|
*/
|
|
3121
3121
|
export type TransferAckType = components['schemas']['TransferAckType'];
|
|
3122
|
+
/**
|
|
3123
|
+
* TransferLockPolicyBase
|
|
3124
|
+
*
|
|
3125
|
+
* @remarks
|
|
3126
|
+
* Type alias for the `TransferLockPolicyBase` OpenAPI schema.
|
|
3127
|
+
* This type represents transferlockpolicybase data structures used in API requests and responses.
|
|
3128
|
+
*
|
|
3129
|
+
* @example
|
|
3130
|
+
* ```typescript
|
|
3131
|
+
* const response = await api.getTransferLockPolicyBase();
|
|
3132
|
+
* const item: TransferLockPolicyBase = response.results;
|
|
3133
|
+
* ```
|
|
3134
|
+
*
|
|
3135
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
3136
|
+
*/
|
|
3137
|
+
export type TransferLockPolicyBase = components['schemas']['TransferLockPolicyBase'];
|
|
3122
3138
|
/**
|
|
3123
3139
|
* TransferPoliciesBase
|
|
3124
3140
|
*
|
package/src/openapi.yaml
CHANGED
|
@@ -4781,6 +4781,21 @@ components:
|
|
|
4781
4781
|
- both
|
|
4782
4782
|
title: TransferAckType
|
|
4783
4783
|
type: string
|
|
4784
|
+
TransferLockPolicyBase:
|
|
4785
|
+
properties:
|
|
4786
|
+
supported_by_registrar:
|
|
4787
|
+
description: Whether the registrar supports transfer locks
|
|
4788
|
+
title: Supported By Registrar
|
|
4789
|
+
type: boolean
|
|
4790
|
+
supported_by_registry:
|
|
4791
|
+
description: Whether the registry supports transfer locks
|
|
4792
|
+
title: Supported By Registry
|
|
4793
|
+
type: boolean
|
|
4794
|
+
required:
|
|
4795
|
+
- supported_by_registry
|
|
4796
|
+
- supported_by_registrar
|
|
4797
|
+
title: TransferLockPolicyBase
|
|
4798
|
+
type: object
|
|
4784
4799
|
TransferPoliciesBase:
|
|
4785
4800
|
properties:
|
|
4786
4801
|
authinfo_max_length:
|
|
@@ -4849,10 +4864,9 @@ components:
|
|
|
4849
4864
|
- type: 'null'
|
|
4850
4865
|
description: Whether an email confirmation is required to perform the transfer
|
|
4851
4866
|
title: Transfer Email Required
|
|
4852
|
-
|
|
4853
|
-
|
|
4854
|
-
|
|
4855
|
-
type: boolean
|
|
4867
|
+
transfer_lock_policy:
|
|
4868
|
+
$ref: '#/components/schemas/TransferLockPolicyBase'
|
|
4869
|
+
description: Transfer lock policy
|
|
4856
4870
|
transfer_nack:
|
|
4857
4871
|
anyOf:
|
|
4858
4872
|
- $ref: '#/components/schemas/TransferAckType'
|
|
@@ -4887,7 +4901,7 @@ components:
|
|
|
4887
4901
|
according to the policy, 0 = real-time
|
|
4888
4902
|
title: Transfer Time
|
|
4889
4903
|
required:
|
|
4890
|
-
-
|
|
4904
|
+
- transfer_lock_policy
|
|
4891
4905
|
- authinfo_required
|
|
4892
4906
|
title: TransferPoliciesBase
|
|
4893
4907
|
type: object
|
|
@@ -5534,7 +5548,7 @@ info:
|
|
|
5534
5548
|
'
|
|
5535
5549
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
5536
5550
|
title: OpusDNS API
|
|
5537
|
-
version: 2025-12-
|
|
5551
|
+
version: 2025-12-02-133836
|
|
5538
5552
|
x-logo:
|
|
5539
5553
|
altText: OpusDNS API Reference
|
|
5540
5554
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
package/src/schema.d.ts
CHANGED
|
@@ -4506,6 +4506,19 @@ export interface components {
|
|
|
4506
4506
|
* @enum {string}
|
|
4507
4507
|
*/
|
|
4508
4508
|
TransferAckType: "none" | "registrar" | "registrant" | "both";
|
|
4509
|
+
/** TransferLockPolicyBase */
|
|
4510
|
+
TransferLockPolicyBase: {
|
|
4511
|
+
/**
|
|
4512
|
+
* Supported By Registrar
|
|
4513
|
+
* @description Whether the registrar supports transfer locks
|
|
4514
|
+
*/
|
|
4515
|
+
supported_by_registrar: boolean;
|
|
4516
|
+
/**
|
|
4517
|
+
* Supported By Registry
|
|
4518
|
+
* @description Whether the registry supports transfer locks
|
|
4519
|
+
*/
|
|
4520
|
+
supported_by_registry: boolean;
|
|
4521
|
+
};
|
|
4509
4522
|
/** TransferPoliciesBase */
|
|
4510
4523
|
TransferPoliciesBase: {
|
|
4511
4524
|
/**
|
|
@@ -4555,11 +4568,8 @@ export interface components {
|
|
|
4555
4568
|
* @description Whether an email confirmation is required to perform the transfer
|
|
4556
4569
|
*/
|
|
4557
4570
|
transfer_email_required?: boolean | null;
|
|
4558
|
-
/**
|
|
4559
|
-
|
|
4560
|
-
* @description Whether transfers are locked by default in our system
|
|
4561
|
-
*/
|
|
4562
|
-
transfer_lock_enabled: boolean;
|
|
4571
|
+
/** @description Transfer lock policy */
|
|
4572
|
+
transfer_lock_policy: components["schemas"]["TransferLockPolicyBase"];
|
|
4563
4573
|
/** @description Whether a transfer can be denied */
|
|
4564
4574
|
transfer_nack?: components["schemas"]["TransferAckType"] | null;
|
|
4565
4575
|
/**
|