@opusdns/api 0.134.0 → 0.136.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
@@ -3,7 +3,7 @@
3
3
  "@opusdns/api-spec-ts-generator": "^0.19.0"
4
4
  },
5
5
  "name": "@opusdns/api",
6
- "version": "0.134.0",
6
+ "version": "0.136.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -21,7 +21,7 @@
21
21
  * ```
22
22
  */
23
23
 
24
- import { AllocationMethodType, AttributeType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ContactRoleType, 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, ObjectEventType, ObjectLogSortField, OrganizationStatus, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, RequestHistorySortField, ReservedSourceType, SortOrder, SyncOperationType, TLDType, 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, EmailForwardLogSortField, EmailForwardSortField, EmailForwardZoneSortField, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, GrantType, HostStatus, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, LaunchPhaseType, LocalPresenceRequirementType, ObjectEventType, ObjectLogSortField, OrganizationStatus, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, RequestHistorySortField, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TransferAckType, UserStatus, VerificationType, ZoneSortField } from './schemas';
25
25
 
26
26
  /**
27
27
  * AllocationMethodType. Auto-generated enum for AllocationMethodType
@@ -357,60 +357,6 @@ export const BILLING_TRANSACTION_STATUS_VALUES = [
357
357
  'canceled'
358
358
  ] as const satisfies [string, ...string[]] | BillingTransactionStatus[];
359
359
 
360
- /**
361
- * ContactRoleType. Auto-generated enum for ContactRoleType
362
- *
363
- * @remarks
364
- * This constant provides both object and array forms for the ContactRoleType enum.
365
- * The object form allows key-value access, while the array form enables iteration and validation.
366
- *
367
- * @example
368
- * ```typescript
369
- * // Using the object form for key-value access
370
- * const status = CONTACT_ROLE_TYPE.SUCCESS;
371
- *
372
- * // Using the array form for iteration
373
- * const allStatuses = CONTACT_ROLE_TYPE_VALUES;
374
- * console.log(`Available statuses: ${allStatuses.join(', ')}`);
375
- * ```
376
- *
377
- * @see {@link ContactRoleType} - The TypeScript type definition
378
- */
379
- export const CONTACT_ROLE_TYPE = {
380
- REGISTRANT: "registrant",
381
- ADMIN: "admin",
382
- TECH: "tech",
383
- BILLING: "billing",
384
- } as const satisfies Record<string, ContactRoleType>;
385
-
386
- /**
387
- * Array of all ContactRoleType enum values
388
- *
389
- * @remarks
390
- * This constant provides a array containing all valid ContactRoleType enum values.
391
- * Useful for iteration, validation, and generating dynamic UI components.
392
- *
393
- * @example
394
- * ```typescript
395
- * // Iterating through all values
396
- * for (const value of CONTACT_ROLE_TYPE_VALUES) {
397
- * console.log(`Processing: ${value}`);
398
- * }
399
- *
400
- * // Validation
401
- * const isValid = CONTACT_ROLE_TYPE_VALUES.includes(someValue);
402
- * ```
403
- *
404
- * @see {@link ContactRoleType} - The TypeScript type definition
405
- * @see {@link CONTACT_ROLE_TYPE} - The object form of this enum
406
- */
407
- export const CONTACT_ROLE_TYPE_VALUES = [
408
- 'registrant',
409
- 'admin',
410
- 'tech',
411
- 'billing'
412
- ] as const satisfies [string, ...string[]] | ContactRoleType[];
413
-
414
360
  /**
415
361
  * ContactSortField. Auto-generated enum for ContactSortField
416
362
  *
@@ -92,6 +92,7 @@ import { DomainSearchMeta } from './schemas';
92
92
  import { DomainSearch } from './schemas';
93
93
  import { DomainSearchSuggestionPriceData } from './schemas';
94
94
  import { DomainSearchSuggestionWithPrice } from './schemas';
95
+ import { DomainStatus2 } from './schemas';
95
96
  import { DomainStatusesBase } from './schemas';
96
97
  import { DomainSummaryData } from './schemas';
97
98
  import { DomainSummary } from './schemas';
@@ -9519,6 +9520,57 @@ export const KEYS_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE = [
9519
9520
  KEY_DOMAIN_SEARCH_SUGGESTION_WITH_PRICE_PRICE,
9520
9521
  ] as const satisfies (keyof DomainSearchSuggestionWithPrice)[];
9521
9522
 
9523
+ /**
9524
+ * Status
9525
+ *
9526
+ * The status of the domain
9527
+ *
9528
+ * @type {string}
9529
+ *
9530
+ *
9531
+ * @remarks
9532
+ * This key constant provides type-safe access to the `status` property of DomainStatus2 objects.
9533
+ * Use this constant when you need to access properties dynamically or ensure type safety.
9534
+ *
9535
+ * @example
9536
+ * ```typescript
9537
+ * // Direct property access
9538
+ * const value = domainstatus2[KEY_DOMAIN_STATUS2_STATUS];
9539
+ *
9540
+ * // Dynamic property access
9541
+ * const propertyName = KEY_DOMAIN_STATUS2_STATUS;
9542
+ * const value = domainstatus2[propertyName];
9543
+ * ```
9544
+ *
9545
+ * @see {@link DomainStatus2} - The TypeScript type definition
9546
+ * @see {@link KEYS_DOMAIN_STATUS2} - Array of all keys for this type
9547
+ */
9548
+ export const KEY_DOMAIN_STATUS2_STATUS: keyof DomainStatus2 = 'status';
9549
+
9550
+ /**
9551
+ * Array of all DomainStatus2 property keys
9552
+ *
9553
+ * @remarks
9554
+ * This constant provides a readonly array containing all valid property keys for DomainStatus2 objects.
9555
+ * Useful for iteration, validation, and generating dynamic UI components.
9556
+ *
9557
+ * @example
9558
+ * ```typescript
9559
+ * // Iterating through all keys
9560
+ * for (const key of KEYS_DOMAIN_STATUS2) {
9561
+ * console.log(`Property: ${key}, Value: ${domainstatus2[key]}`);
9562
+ * }
9563
+ *
9564
+ * // Validation
9565
+ * const isValidKey = KEYS_DOMAIN_STATUS2.includes(someKey);
9566
+ * ```
9567
+ *
9568
+ * @see {@link DomainStatus2} - The TypeScript type definition
9569
+ */
9570
+ export const KEYS_DOMAIN_STATUS2 = [
9571
+ KEY_DOMAIN_STATUS2_STATUS,
9572
+ ] as const satisfies (keyof DomainStatus2)[];
9573
+
9522
9574
  /**
9523
9575
  * Default
9524
9576
  *
@@ -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, RegistryHandleAttributeType, ContactAttributeDefinition, ContactRoleAttributeRequirement, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, DomainForwardPatchOp, HttpRedirectList, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, ObjectLog, Organization, RequestHistory, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
24
+ import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, RegistryHandleAttributeType, ContactAttributeDefinition, ContactRoleAttributeRequirement, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, DomainForwardPatchOp, HttpRedirectList, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, DomainContactType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, ObjectLog, Organization, RequestHistory, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
25
25
 
26
26
  /**
27
27
  * DomainDnssecDataResponse
@@ -570,19 +570,19 @@ export type LaunchPhaseBaseArray = LaunchPhaseBase[];
570
570
  */
571
571
  export type LocalPresenceRequirementTypeArray = LocalPresenceRequirementType[];
572
572
  /**
573
- * ContactRoleType
573
+ * DomainContactType
574
574
  *
575
575
  * @remarks
576
- * Array type for ContactRoleType objects. Used when the API returns a collection of ContactRoleType instances.
576
+ * Array type for DomainContactType objects. Used when the API returns a collection of DomainContactType instances.
577
577
  *
578
578
  * @example
579
579
  * ```typescript
580
- * const items: ContactRoleTypeArray = await api.getContactRoleTypes();
580
+ * const items: DomainContactTypeArray = await api.getDomainContactTypes();
581
581
  * ```
582
582
  *
583
- * @see {@link ContactRoleType} - The individual ContactRoleType type definition
583
+ * @see {@link DomainContactType} - The individual DomainContactType type definition
584
584
  */
585
- export type ContactRoleTypeArray = ContactRoleType[];
585
+ export type DomainContactTypeArray = DomainContactType[];
586
586
  /**
587
587
  * OrganizationAttribute
588
588
  *
@@ -298,22 +298,6 @@ export type Contact = components['schemas']['ContactResponse'];
298
298
  * @see {@link components} - The OpenAPI components schema definition
299
299
  */
300
300
  export type ContactRoleAttributeRequirement = components['schemas']['ContactRoleAttributeRequirement'];
301
- /**
302
- * ContactRoleType
303
- *
304
- * @remarks
305
- * Type alias for the `ContactRoleType` OpenAPI schema.
306
- * This type represents contactroletype data structures used in API requests and responses.
307
- *
308
- * @example
309
- * ```typescript
310
- * const response = await api.getContactRoleType();
311
- * const item: ContactRoleType = response.results;
312
- * ```
313
- *
314
- * @see {@link components} - The OpenAPI components schema definition
315
- */
316
- export type ContactRoleType = components['schemas']['ContactRoleType'];
317
301
  /**
318
302
  * ContactSchema
319
303
  *
@@ -1466,6 +1450,22 @@ export type DomainSortField = components['schemas']['DomainSortField'];
1466
1450
  * @see {@link components} - The OpenAPI components schema definition
1467
1451
  */
1468
1452
  export type DomainStatus = components['schemas']['DomainStatus'];
1453
+ /**
1454
+ * DomainStatusResponse
1455
+ *
1456
+ * @remarks
1457
+ * Type alias for the `DomainStatusResponse` OpenAPI schema.
1458
+ * This type represents domainstatusresponse data structures used in API requests and responses.
1459
+ *
1460
+ * @example
1461
+ * ```typescript
1462
+ * const response = await api.getDomainStatus2();
1463
+ * const item: DomainStatus2 = response.results;
1464
+ * ```
1465
+ *
1466
+ * @see {@link components} - The OpenAPI components schema definition
1467
+ */
1468
+ export type DomainStatus2 = components['schemas']['DomainStatusResponse'];
1469
1469
  /**
1470
1470
  * DomainStatusesBase
1471
1471
  *
package/src/openapi.yaml CHANGED
@@ -240,7 +240,7 @@ components:
240
240
  title: Min
241
241
  type: integer
242
242
  type:
243
- $ref: '#/components/schemas/ContactRoleType'
243
+ $ref: '#/components/schemas/DomainContactType'
244
244
  description: The type of contact
245
245
  required:
246
246
  - type
@@ -257,7 +257,7 @@ components:
257
257
  type: string
258
258
  country:
259
259
  description: The country of the contact
260
- minLength: 1
260
+ pattern: ^\w{2}$
261
261
  title: Country
262
262
  type: string
263
263
  disclose:
@@ -382,7 +382,7 @@ components:
382
382
  type: string
383
383
  country:
384
384
  description: The country of the contact
385
- minLength: 1
385
+ pattern: ^\w{2}$
386
386
  title: Country
387
387
  type: string
388
388
  disclose:
@@ -471,21 +471,13 @@ components:
471
471
  title: Attributes
472
472
  type: array
473
473
  role:
474
- $ref: '#/components/schemas/ContactRoleType'
474
+ $ref: '#/components/schemas/DomainContactType'
475
475
  description: The role this requirement applies to
476
476
  required:
477
477
  - role
478
478
  - attributes
479
479
  title: ContactRoleAttributeRequirement
480
480
  type: object
481
- ContactRoleType:
482
- enum:
483
- - registrant
484
- - admin
485
- - tech
486
- - billing
487
- title: ContactRoleType
488
- type: string
489
481
  ContactSchema:
490
482
  properties:
491
483
  city:
@@ -503,7 +495,7 @@ components:
503
495
  x-typeid-prefix: contact
504
496
  country:
505
497
  description: The country of the contact
506
- minLength: 1
498
+ pattern: ^\w{2}$
507
499
  title: Country
508
500
  type: string
509
501
  created_on:
@@ -2294,6 +2286,16 @@ components:
2294
2286
  - invalid
2295
2287
  title: DomainStatus
2296
2288
  type: string
2289
+ DomainStatusResponse:
2290
+ properties:
2291
+ status:
2292
+ description: The status of the domain
2293
+ title: Status
2294
+ type: string
2295
+ required:
2296
+ - status
2297
+ title: DomainStatusResponse
2298
+ type: object
2297
2299
  DomainStatusesBase:
2298
2300
  properties:
2299
2301
  default:
@@ -3544,7 +3546,7 @@ components:
3544
3546
  type:
3545
3547
  anyOf:
3546
3548
  - items:
3547
- $ref: '#/components/schemas/ContactRoleType'
3549
+ $ref: '#/components/schemas/DomainContactType'
3548
3550
  type: array
3549
3551
  - type: 'null'
3550
3552
  description: Who must meet the requirement
@@ -6143,7 +6145,7 @@ info:
6143
6145
  '
6144
6146
  summary: OpusDNS - your gateway to a seamless domain management experience.
6145
6147
  title: OpusDNS API
6146
- version: 2025-12-18-130936
6148
+ version: 2025-12-22-170801
6147
6149
  x-logo:
6148
6150
  altText: OpusDNS API Reference
6149
6151
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
package/src/schema.d.ts CHANGED
@@ -1749,7 +1749,7 @@ export interface components {
1749
1749
  */
1750
1750
  min: number;
1751
1751
  /** @description The type of contact */
1752
- type: components["schemas"]["ContactRoleType"];
1752
+ type: components["schemas"]["DomainContactType"];
1753
1753
  };
1754
1754
  /** ContactCreate */
1755
1755
  ContactCreate: {
@@ -1925,13 +1925,8 @@ export interface components {
1925
1925
  */
1926
1926
  attributes: components["schemas"]["RegistryHandleAttributeType"][];
1927
1927
  /** @description The role this requirement applies to */
1928
- role: components["schemas"]["ContactRoleType"];
1928
+ role: components["schemas"]["DomainContactType"];
1929
1929
  };
1930
- /**
1931
- * ContactRoleType
1932
- * @enum {string}
1933
- */
1934
- ContactRoleType: "registrant" | "admin" | "tech" | "billing";
1935
1930
  /** ContactSchema */
1936
1931
  ContactSchema: {
1937
1932
  /**
@@ -3104,6 +3099,14 @@ export interface components {
3104
3099
  * @enum {string}
3105
3100
  */
3106
3101
  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";
3102
+ /** DomainStatusResponse */
3103
+ DomainStatusResponse: {
3104
+ /**
3105
+ * Status
3106
+ * @description The status of the domain
3107
+ */
3108
+ status: string;
3109
+ };
3107
3110
  /** DomainStatusesBase */
3108
3111
  DomainStatusesBase: {
3109
3112
  /**
@@ -3990,7 +3993,7 @@ export interface components {
3990
3993
  * Type
3991
3994
  * @description Who must meet the requirement
3992
3995
  */
3993
- type?: components["schemas"]["ContactRoleType"][] | null;
3996
+ type?: components["schemas"]["DomainContactType"][] | null;
3994
3997
  };
3995
3998
  /**
3996
3999
  * LocalPresenceRequirementType