@opusdns/api 0.307.0 → 0.308.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.307.0",
6
+ "version": "0.308.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -339,6 +339,7 @@ import { UserWithRelationPermissions } from './schemas';
339
339
  import { ValidationError } from './schemas';
340
340
  import { VerificationDeadline } from './schemas';
341
341
  import { VerificationRegistrantDetails } from './schemas';
342
+ import { Verification } from './schemas';
342
343
  import { VisitsByKeyBucket } from './schemas';
343
344
  import { WhoisBase } from './schemas';
344
345
  import { RequestAuthcode } from './schemas';
@@ -18174,6 +18175,31 @@ export const KEY_DOMAIN_TRANSFER_LOCK: keyof Domain = 'transfer_lock';
18174
18175
  * @see {@link KEYS_DOMAIN} - Array of all keys for this type
18175
18176
  */
18176
18177
  export const KEY_DOMAIN_UPDATED_ON: keyof Domain = 'updated_on';
18178
+ /**
18179
+ * verification_required property
18180
+ *
18181
+ * Verification data for this domain, including pending claims and deadlines.
18182
+ *
18183
+ *
18184
+ *
18185
+ * @remarks
18186
+ * This key constant provides type-safe access to the `verification_required` property of Domain objects.
18187
+ * Use this constant when you need to access properties dynamically or ensure type safety.
18188
+ *
18189
+ * @example
18190
+ * ```typescript
18191
+ * // Direct property access
18192
+ * const value = domain[KEY_DOMAIN_VERIFICATION_REQUIRED];
18193
+ *
18194
+ * // Dynamic property access
18195
+ * const propertyName = KEY_DOMAIN_VERIFICATION_REQUIRED;
18196
+ * const value = domain[propertyName];
18197
+ * ```
18198
+ *
18199
+ * @see {@link Domain} - The TypeScript type definition
18200
+ * @see {@link KEYS_DOMAIN} - Array of all keys for this type
18201
+ */
18202
+ export const KEY_DOMAIN_VERIFICATION_REQUIRED: keyof Domain = 'verification_required';
18177
18203
 
18178
18204
  /**
18179
18205
  * Array of all Domain property keys
@@ -18220,6 +18246,7 @@ export const KEYS_DOMAIN = [
18220
18246
  KEY_DOMAIN_TLD,
18221
18247
  KEY_DOMAIN_TRANSFER_LOCK,
18222
18248
  KEY_DOMAIN_UPDATED_ON,
18249
+ KEY_DOMAIN_VERIFICATION_REQUIRED,
18223
18250
  ] as const satisfies (keyof Domain)[];
18224
18251
 
18225
18252
  /**
@@ -44424,6 +44451,84 @@ export const KEYS_VERIFICATION_REGISTRANT_DETAILS = [
44424
44451
  KEY_VERIFICATION_REGISTRANT_DETAILS_NAME,
44425
44452
  ] as const satisfies (keyof VerificationRegistrantDetails)[];
44426
44453
 
44454
+ /**
44455
+ * Claims
44456
+ *
44457
+ * Verification claims
44458
+ *
44459
+ * @type {array}
44460
+ *
44461
+ *
44462
+ * @remarks
44463
+ * This key constant provides type-safe access to the `claims` property of Verification objects.
44464
+ * Use this constant when you need to access properties dynamically or ensure type safety.
44465
+ *
44466
+ * @example
44467
+ * ```typescript
44468
+ * // Direct property access
44469
+ * const value = verification[KEY_VERIFICATION_CLAIMS];
44470
+ *
44471
+ * // Dynamic property access
44472
+ * const propertyName = KEY_VERIFICATION_CLAIMS;
44473
+ * const value = verification[propertyName];
44474
+ * ```
44475
+ *
44476
+ * @see {@link Verification} - The TypeScript type definition
44477
+ * @see {@link KEYS_VERIFICATION} - Array of all keys for this type
44478
+ */
44479
+ export const KEY_VERIFICATION_CLAIMS: keyof Verification = 'claims';
44480
+ /**
44481
+ * Deadlines
44482
+ *
44483
+ * Verification deadlines
44484
+ *
44485
+ * @type {array}
44486
+ *
44487
+ *
44488
+ * @remarks
44489
+ * This key constant provides type-safe access to the `deadlines` property of Verification objects.
44490
+ * Use this constant when you need to access properties dynamically or ensure type safety.
44491
+ *
44492
+ * @example
44493
+ * ```typescript
44494
+ * // Direct property access
44495
+ * const value = verification[KEY_VERIFICATION_DEADLINES];
44496
+ *
44497
+ * // Dynamic property access
44498
+ * const propertyName = KEY_VERIFICATION_DEADLINES;
44499
+ * const value = verification[propertyName];
44500
+ * ```
44501
+ *
44502
+ * @see {@link Verification} - The TypeScript type definition
44503
+ * @see {@link KEYS_VERIFICATION} - Array of all keys for this type
44504
+ */
44505
+ export const KEY_VERIFICATION_DEADLINES: keyof Verification = 'deadlines';
44506
+
44507
+ /**
44508
+ * Array of all Verification property keys
44509
+ *
44510
+ * @remarks
44511
+ * This constant provides a readonly array containing all valid property keys for Verification objects.
44512
+ * Useful for iteration, validation, and generating dynamic UI components.
44513
+ *
44514
+ * @example
44515
+ * ```typescript
44516
+ * // Iterating through all keys
44517
+ * for (const key of KEYS_VERIFICATION) {
44518
+ * console.log(`Property: ${key}, Value: ${verification[key]}`);
44519
+ * }
44520
+ *
44521
+ * // Validation
44522
+ * const isValidKey = KEYS_VERIFICATION.includes(someKey);
44523
+ * ```
44524
+ *
44525
+ * @see {@link Verification} - The TypeScript type definition
44526
+ */
44527
+ export const KEYS_VERIFICATION = [
44528
+ KEY_VERIFICATION_CLAIMS,
44529
+ KEY_VERIFICATION_DEADLINES,
44530
+ ] as const satisfies (keyof Verification)[];
44531
+
44427
44532
  /**
44428
44533
  * Key
44429
44534
  *
@@ -7028,6 +7028,22 @@ export type VerificationDeadlineType = components['schemas']['VerificationDeadli
7028
7028
  * @see {@link components} - The OpenAPI components schema definition
7029
7029
  */
7030
7030
  export type VerificationRegistrantDetails = components['schemas']['VerificationRegistrantDetails'];
7031
+ /**
7032
+ * VerificationResponse
7033
+ *
7034
+ * @remarks
7035
+ * Type alias for the `VerificationResponse` OpenAPI schema.
7036
+ * This type represents verificationresponse data structures used in API requests and responses.
7037
+ *
7038
+ * @example
7039
+ * ```typescript
7040
+ * const response = await api.getVerification();
7041
+ * const item: Verification = response.results;
7042
+ * ```
7043
+ *
7044
+ * @see {@link components} - The OpenAPI components schema definition
7045
+ */
7046
+ export type Verification = components['schemas']['VerificationResponse'];
7031
7047
  /**
7032
7048
  * VerificationType
7033
7049
  *
package/src/openapi.yaml CHANGED
@@ -4369,6 +4369,12 @@ components:
4369
4369
  format: date-time
4370
4370
  title: Updated On
4371
4371
  type: string
4372
+ verification_required:
4373
+ anyOf:
4374
+ - $ref: '#/components/schemas/VerificationResponse'
4375
+ - type: 'null'
4376
+ description: Verification data for this domain, including pending claims
4377
+ and deadlines.
4372
4378
  required:
4373
4379
  - name
4374
4380
  - sld
@@ -11269,6 +11275,24 @@ components:
11269
11275
  - email
11270
11276
  title: VerificationRegistrantDetails
11271
11277
  type: object
11278
+ VerificationResponse:
11279
+ properties:
11280
+ claims:
11281
+ description: Verification claims
11282
+ items:
11283
+ $ref: '#/components/schemas/VerificationClaimType'
11284
+ title: Claims
11285
+ type: array
11286
+ deadlines:
11287
+ description: Verification deadlines
11288
+ items:
11289
+ $ref: '#/components/schemas/VerificationDeadline'
11290
+ title: Deadlines
11291
+ type: array
11292
+ required:
11293
+ - claims
11294
+ title: VerificationResponse
11295
+ type: object
11272
11296
  VerificationType:
11273
11297
  enum:
11274
11298
  - api
@@ -11505,7 +11529,7 @@ info:
11505
11529
  \n\n"
11506
11530
  summary: OpusDNS - your gateway to a seamless domain management experience.
11507
11531
  title: OpusDNS API
11508
- version: 2026-05-18-215758
11532
+ version: 2026-05-19-074018
11509
11533
  x-logo:
11510
11534
  altText: OpusDNS API Reference
11511
11535
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
package/src/schema.d.ts CHANGED
@@ -5350,6 +5350,8 @@ export interface components {
5350
5350
  * @description The date/time the entry was last updated on
5351
5351
  */
5352
5352
  updated_on?: Date;
5353
+ /** @description Verification data for this domain, including pending claims and deadlines. */
5354
+ verification_required?: components["schemas"]["VerificationResponse"] | null;
5353
5355
  };
5354
5356
  /** DomainRestoreRequest */
5355
5357
  DomainRestoreRequest: {
@@ -9919,6 +9921,19 @@ export interface components {
9919
9921
  /** Name */
9920
9922
  name: string;
9921
9923
  };
9924
+ /** VerificationResponse */
9925
+ VerificationResponse: {
9926
+ /**
9927
+ * Claims
9928
+ * @description Verification claims
9929
+ */
9930
+ claims: components["schemas"]["VerificationClaimType"][];
9931
+ /**
9932
+ * Deadlines
9933
+ * @description Verification deadlines
9934
+ */
9935
+ deadlines?: components["schemas"]["VerificationDeadline"][];
9936
+ };
9922
9937
  /**
9923
9938
  * VerificationType
9924
9939
  * @enum {string}