@opusdns/api 0.21.0 → 0.23.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 CHANGED
@@ -8,7 +8,7 @@
8
8
  "typescript": "^5.8.2"
9
9
  },
10
10
  "name": "@opusdns/api",
11
- "version": "0.21.0",
11
+ "version": "0.23.0",
12
12
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
13
13
  "main": "./src/index.ts",
14
14
  "module": "./src/index.ts",
@@ -890,6 +890,10 @@ export const DOMAIN_STATUS = {
890
890
  CLIENT_DELETE_PROHIBITED: "clientDeleteProhibited",
891
891
  CLIENT_RENEW_PROHIBITED: "clientRenewProhibited",
892
892
  CLIENT_HOLD: "clientHold",
893
+ FREE: "free",
894
+ CONNECT: "connect",
895
+ FAILED: "failed",
896
+ INVALID: "invalid",
893
897
  } as const satisfies Record<string, DomainStatus>;
894
898
 
895
899
  /**
@@ -938,7 +942,11 @@ export const DOMAIN_STATUS_VALUES = [
938
942
  'clientUpdateProhibited',
939
943
  'clientDeleteProhibited',
940
944
  'clientRenewProhibited',
941
- 'clientHold'
945
+ 'clientHold',
946
+ 'free',
947
+ 'connect',
948
+ 'failed',
949
+ 'invalid'
942
950
  ] as const satisfies [string, ...string[]] | DomainStatus[];
943
951
 
944
952
  /**
@@ -130,7 +130,6 @@ import { TrademarkClaimsBase } from './schemas';
130
130
  import { TransferPoliciesBase } from './schemas';
131
131
  import { User } from './schemas';
132
132
  import { UserAttributeBase } from './schemas';
133
- import { UserAttributeUpdate } from './schemas';
134
133
  import { UserCreate } from './schemas';
135
134
  import { UserNotification } from './schemas';
136
135
  import { UserNotificationSummary } from './schemas';
@@ -7357,6 +7356,31 @@ export const KEY_DOMAIN_TRANSFER_IN_CONTACTS = 'contacts' as keyof DomainTransfe
7357
7356
  * @see {@link KEYS_DOMAIN_TRANSFER_IN} - Array of all keys for this type
7358
7357
  */
7359
7358
  export const KEY_DOMAIN_TRANSFER_IN_NAME = 'name' as keyof DomainTransferIn;
7359
+ /**
7360
+ * Nameservers
7361
+ *
7362
+ * The name servers for the domain
7363
+ *
7364
+ *
7365
+ *
7366
+ * @remarks
7367
+ * This key constant provides type-safe access to the `nameservers` property of DomainTransferIn objects.
7368
+ * Use this constant when you need to access properties dynamically or ensure type safety.
7369
+ *
7370
+ * @example
7371
+ * ```typescript
7372
+ * // Direct property access
7373
+ * const value = domaintransferin[KEY_DOMAIN_TRANSFER_IN_NAMESERVERS];
7374
+ *
7375
+ * // Dynamic property access
7376
+ * const propertyName = KEY_DOMAIN_TRANSFER_IN_NAMESERVERS;
7377
+ * const value = domaintransferin[propertyName];
7378
+ * ```
7379
+ *
7380
+ * @see {@link DomainTransferIn} - The TypeScript type definition
7381
+ * @see {@link KEYS_DOMAIN_TRANSFER_IN} - Array of all keys for this type
7382
+ */
7383
+ export const KEY_DOMAIN_TRANSFER_IN_NAMESERVERS = 'nameservers' as keyof DomainTransferIn;
7360
7384
  /**
7361
7385
  * renewal_mode property
7362
7386
  *
@@ -7406,6 +7430,7 @@ export const KEYS_DOMAIN_TRANSFER_IN = [
7406
7430
  KEY_DOMAIN_TRANSFER_IN_AUTH_CODE,
7407
7431
  KEY_DOMAIN_TRANSFER_IN_CONTACTS,
7408
7432
  KEY_DOMAIN_TRANSFER_IN_NAME,
7433
+ KEY_DOMAIN_TRANSFER_IN_NAMESERVERS,
7409
7434
  KEY_DOMAIN_TRANSFER_IN_RENEWAL_MODE,
7410
7435
  ] as const satisfies (keyof DomainTransferIn)[];
7411
7436
 
@@ -16404,83 +16429,6 @@ export const KEYS_USER_ATTRIBUTE_BASE = [
16404
16429
  KEY_USER_ATTRIBUTE_BASE_VALUE,
16405
16430
  ] as const satisfies (keyof UserAttributeBase)[];
16406
16431
 
16407
- /**
16408
- * Key
16409
- *
16410
- * Key of the attribute.
16411
- *
16412
- * @type {string}
16413
- *
16414
- *
16415
- * @remarks
16416
- * This key constant provides type-safe access to the `key` property of UserAttributeUpdate objects.
16417
- * Use this constant when you need to access properties dynamically or ensure type safety.
16418
- *
16419
- * @example
16420
- * ```typescript
16421
- * // Direct property access
16422
- * const value = userattributeupdate[KEY_USER_ATTRIBUTE_UPDATE_KEY];
16423
- *
16424
- * // Dynamic property access
16425
- * const propertyName = KEY_USER_ATTRIBUTE_UPDATE_KEY;
16426
- * const value = userattributeupdate[propertyName];
16427
- * ```
16428
- *
16429
- * @see {@link UserAttributeUpdate} - The TypeScript type definition
16430
- * @see {@link KEYS_USER_ATTRIBUTE_UPDATE} - Array of all keys for this type
16431
- */
16432
- export const KEY_USER_ATTRIBUTE_UPDATE_KEY = 'key' as keyof UserAttributeUpdate;
16433
- /**
16434
- * value property
16435
- *
16436
- * Value of the attribute.
16437
- *
16438
- *
16439
- *
16440
- * @remarks
16441
- * This key constant provides type-safe access to the `value` property of UserAttributeUpdate objects.
16442
- * Use this constant when you need to access properties dynamically or ensure type safety.
16443
- *
16444
- * @example
16445
- * ```typescript
16446
- * // Direct property access
16447
- * const value = userattributeupdate[KEY_USER_ATTRIBUTE_UPDATE_VALUE];
16448
- *
16449
- * // Dynamic property access
16450
- * const propertyName = KEY_USER_ATTRIBUTE_UPDATE_VALUE;
16451
- * const value = userattributeupdate[propertyName];
16452
- * ```
16453
- *
16454
- * @see {@link UserAttributeUpdate} - The TypeScript type definition
16455
- * @see {@link KEYS_USER_ATTRIBUTE_UPDATE} - Array of all keys for this type
16456
- */
16457
- export const KEY_USER_ATTRIBUTE_UPDATE_VALUE = 'value' as keyof UserAttributeUpdate;
16458
-
16459
- /**
16460
- * Array of all UserAttributeUpdate property keys
16461
- *
16462
- * @remarks
16463
- * This constant provides a readonly array containing all valid property keys for UserAttributeUpdate objects.
16464
- * Useful for iteration, validation, and generating dynamic UI components.
16465
- *
16466
- * @example
16467
- * ```typescript
16468
- * // Iterating through all keys
16469
- * for (const key of KEYS_USER_ATTRIBUTE_UPDATE) {
16470
- * console.log(`Property: ${key}, Value: ${userattributeupdate[key]}`);
16471
- * }
16472
- *
16473
- * // Validation
16474
- * const isValidKey = KEYS_USER_ATTRIBUTE_UPDATE.includes(someKey);
16475
- * ```
16476
- *
16477
- * @see {@link UserAttributeUpdate} - The TypeScript type definition
16478
- */
16479
- export const KEYS_USER_ATTRIBUTE_UPDATE = [
16480
- KEY_USER_ATTRIBUTE_UPDATE_KEY,
16481
- KEY_USER_ATTRIBUTE_UPDATE_VALUE,
16482
- ] as const satisfies (keyof UserAttributeUpdate)[];
16483
-
16484
16432
  /**
16485
16433
  * Email
16486
16434
  *
@@ -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, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, Nameserver, DeletePolicyType, SyncOperationType, DomainContact, DomainStatus, DomainSearchSuggestion, DomainClientStatus, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, ContactSchema, DnsZone, Domain, EmailForwardAlias, EventResponse, OrganizationCredential, Organization, UserNotificationSummary, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, UserAttributeUpdate, DomainAvailability } from './schemas.d';
24
+ import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, Nameserver, DeletePolicyType, SyncOperationType, DomainContact, DomainStatus, DomainSearchSuggestion, DomainClientStatus, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, ContactSchema, DnsZone, Domain, EmailForwardAlias, EventResponse, OrganizationCredential, Organization, UserNotificationSummary, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
25
25
 
26
26
  /**
27
27
  * DomainDnssecDataResponse
@@ -667,20 +667,6 @@ export type PostTransferRequirementsArray = PostTransferRequirements[];
667
667
  * @see {@link UserAttributeBase} - The individual UserAttributeBase type definition
668
668
  */
669
669
  export type UserAttributeBaseArray = UserAttributeBase[];
670
- /**
671
- * UserAttributeUpdate
672
- *
673
- * @remarks
674
- * Array type for UserAttributeUpdate objects. Used when the API returns a collection of UserAttributeUpdate instances.
675
- *
676
- * @example
677
- * ```typescript
678
- * const items: UserAttributeUpdateArray = await api.getUserAttributeUpdates();
679
- * ```
680
- *
681
- * @see {@link UserAttributeUpdate} - The individual UserAttributeUpdate type definition
682
- */
683
- export type UserAttributeUpdateArray = UserAttributeUpdate[];
684
670
  /**
685
671
  * DomainAvailability
686
672
  *
@@ -2522,22 +2522,6 @@ export type User = components['schemas']['User'];
2522
2522
  * @see {@link components} - The OpenAPI components schema definition
2523
2523
  */
2524
2524
  export type UserAttributeBase = components['schemas']['UserAttributeBase'];
2525
- /**
2526
- * UserAttributeUpdate
2527
- *
2528
- * @remarks
2529
- * Type alias for the `UserAttributeUpdate` OpenAPI schema.
2530
- * This type represents userattributeupdate data structures used in API requests and responses.
2531
- *
2532
- * @example
2533
- * ```typescript
2534
- * const response = await api.getUserAttributeUpdate();
2535
- * const item: UserAttributeUpdate = response.results;
2536
- * ```
2537
- *
2538
- * @see {@link components} - The OpenAPI components schema definition
2539
- */
2540
- export type UserAttributeUpdate = components['schemas']['UserAttributeUpdate'];
2541
2525
  /**
2542
2526
  * UserCreate
2543
2527
  *
package/src/openapi.yaml CHANGED
@@ -1697,6 +1697,10 @@ components:
1697
1697
  - clientDeleteProhibited
1698
1698
  - clientRenewProhibited
1699
1699
  - clientHold
1700
+ - free
1701
+ - connect
1702
+ - failed
1703
+ - invalid
1700
1704
  title: DomainStatus
1701
1705
  type: string
1702
1706
  DomainStatusesBase:
@@ -1795,6 +1799,14 @@ components:
1795
1799
  - example.com
1796
1800
  title: Name
1797
1801
  type: string
1802
+ nameservers:
1803
+ anyOf:
1804
+ - items:
1805
+ $ref: '#/components/schemas/Nameserver'
1806
+ type: array
1807
+ - type: 'null'
1808
+ description: The name servers for the domain
1809
+ title: Nameservers
1798
1810
  renewal_mode:
1799
1811
  $ref: '#/components/schemas/RenewalMode'
1800
1812
  required:
@@ -4229,22 +4241,6 @@ components:
4229
4241
  - key
4230
4242
  title: UserAttributeBase
4231
4243
  type: object
4232
- UserAttributeUpdate:
4233
- properties:
4234
- key:
4235
- description: Key of the attribute.
4236
- minLength: 1
4237
- title: Key
4238
- type: string
4239
- value:
4240
- anyOf:
4241
- - $ref: '#/components/schemas/JsonValue'
4242
- - type: 'null'
4243
- description: Value of the attribute.
4244
- required:
4245
- - key
4246
- title: UserAttributeUpdate
4247
- type: object
4248
4244
  UserCreate:
4249
4245
  properties:
4250
4246
  email:
@@ -4451,7 +4447,7 @@ components:
4451
4447
  user_attributes:
4452
4448
  anyOf:
4453
4449
  - items:
4454
- $ref: '#/components/schemas/UserAttributeUpdate'
4450
+ $ref: '#/components/schemas/UserAttributeBase'
4455
4451
  type: array
4456
4452
  - type: 'null'
4457
4453
  description: User attributes
@@ -4804,7 +4800,7 @@ info:
4804
4800
  '
4805
4801
  summary: OpusDNS - your gateway to a seamless domain management experience.
4806
4802
  title: OpusDNS API
4807
- version: 2025-08-15-211010
4803
+ version: 2025-08-21-124715
4808
4804
  x-logo:
4809
4805
  altText: OpusDNS API Reference
4810
4806
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
package/src/schema.d.ts CHANGED
@@ -2171,7 +2171,7 @@ export interface components {
2171
2171
  * DomainStatus
2172
2172
  * @enum {string}
2173
2173
  */
2174
- DomainStatus: "ok" | "serverTransferProhibited" | "serverUpdateProhibited" | "serverDeleteProhibited" | "serverRenewProhibited" | "serverRestoreProhibited" | "serverHold" | "transferPeriod" | "renewPeriod" | "redemptionPeriod" | "pendingUpdate" | "pendingTransfer" | "pendingRestore" | "pendingRenew" | "pendingDelete" | "pendingCreate" | "inactive" | "autoRenewPeriod" | "addPeriod" | "deleted" | "clientTransferProhibited" | "clientUpdateProhibited" | "clientDeleteProhibited" | "clientRenewProhibited" | "clientHold";
2174
+ DomainStatus: "ok" | "serverTransferProhibited" | "serverUpdateProhibited" | "serverDeleteProhibited" | "serverRenewProhibited" | "serverRestoreProhibited" | "serverHold" | "transferPeriod" | "renewPeriod" | "redemptionPeriod" | "pendingUpdate" | "pendingTransfer" | "pendingRestore" | "pendingRenew" | "pendingDelete" | "pendingCreate" | "inactive" | "autoRenewPeriod" | "addPeriod" | "deleted" | "clientTransferProhibited" | "clientUpdateProhibited" | "clientDeleteProhibited" | "clientRenewProhibited" | "clientHold" | "free" | "connect" | "failed" | "invalid";
2175
2175
  /** DomainStatusesBase */
2176
2176
  DomainStatusesBase: {
2177
2177
  /**
@@ -2239,6 +2239,11 @@ export interface components {
2239
2239
  * @description The domain name
2240
2240
  */
2241
2241
  name: string;
2242
+ /**
2243
+ * Nameservers
2244
+ * @description The name servers for the domain
2245
+ */
2246
+ nameservers?: components["schemas"]["Nameserver"][] | null;
2242
2247
  renewal_mode: components["schemas"]["RenewalMode"];
2243
2248
  };
2244
2249
  /** DomainUpdate */
@@ -3842,16 +3847,6 @@ export interface components {
3842
3847
  /** @description Value of the attribute. */
3843
3848
  value?: components["schemas"]["JsonValue"] | null;
3844
3849
  };
3845
- /** UserAttributeUpdate */
3846
- UserAttributeUpdate: {
3847
- /**
3848
- * Key
3849
- * @description Key of the attribute.
3850
- */
3851
- key: string;
3852
- /** @description Value of the attribute. */
3853
- value?: components["schemas"]["JsonValue"] | null;
3854
- };
3855
3850
  /** UserCreate */
3856
3851
  UserCreate: {
3857
3852
  /**
@@ -4003,7 +3998,7 @@ export interface components {
4003
3998
  * User Attributes
4004
3999
  * @description User attributes
4005
4000
  */
4006
- user_attributes?: components["schemas"]["UserAttributeUpdate"][] | null;
4001
+ user_attributes?: components["schemas"]["UserAttributeBase"][] | null;
4007
4002
  /**
4008
4003
  * Username
4009
4004
  * @description The user's unique username