@opusdns/api 0.43.0 → 0.45.0

package/package.json

@@ -8,7 +8,7 @@
     "typescript": "^5.8.2"
   },
   "name": "@opusdns/api",
-  "version": "0.43.0",
+  "version": "0.45.0",
   "description": "TypeScript types for the OpusDNS OpenAPI specification",
   "main": "./src/index.ts",
   "module": "./src/index.ts",

package/src/helpers/keys.ts

@@ -72,6 +72,8 @@ import { DomainPeriod } from './schemas';
 import { DomainRenewRequest } from './schemas';
 import { DomainRenew } from './schemas';
 import { Domain } from './schemas';
+import { DomainRestoreRequest } from './schemas';
+import { DomainRestore } from './schemas';
 import { DomainSearchMeta } from './schemas';
 import { DomainSearch } from './schemas';
 import { DomainSearchSuggestionPriceData } from './schemas';
@@ -7115,6 +7117,242 @@ export const KEYS_DOMAIN = [
   KEY_DOMAIN_UPDATED_ON,
 ] as const satisfies (keyof Domain)[];
 
+/**
+ * Additional Info
+ *
+ * Additional information to include in the restore operation
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `additional_info` property of DomainRestoreRequest objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = domainrestorerequest[KEY_DOMAIN_RESTORE_REQUEST_ADDITIONAL_INFO];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DOMAIN_RESTORE_REQUEST_ADDITIONAL_INFO;
+ * const value = domainrestorerequest[propertyName];
+ * ```
+ *
+ * @see {@link DomainRestoreRequest} - The TypeScript type definition
+ * @see {@link KEYS_DOMAIN_RESTORE_REQUEST} - Array of all keys for this type
+ */
+export const KEY_DOMAIN_RESTORE_REQUEST_ADDITIONAL_INFO = 'additional_info' as keyof DomainRestoreRequest;
+/**
+ * Auto Renew
+ *
+ * Whether to automatically renew the domain after restore
+ *
+ * @type {boolean}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `auto_renew` property of DomainRestoreRequest objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = domainrestorerequest[KEY_DOMAIN_RESTORE_REQUEST_AUTO_RENEW];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DOMAIN_RESTORE_REQUEST_AUTO_RENEW;
+ * const value = domainrestorerequest[propertyName];
+ * ```
+ *
+ * @see {@link DomainRestoreRequest} - The TypeScript type definition
+ * @see {@link KEYS_DOMAIN_RESTORE_REQUEST} - Array of all keys for this type
+ */
+export const KEY_DOMAIN_RESTORE_REQUEST_AUTO_RENEW = 'auto_renew' as keyof DomainRestoreRequest;
+/**
+ * Reason
+ *
+ * Reason for restoring the domain
+ *
+ * @type {string}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `reason` property of DomainRestoreRequest objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = domainrestorerequest[KEY_DOMAIN_RESTORE_REQUEST_REASON];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DOMAIN_RESTORE_REQUEST_REASON;
+ * const value = domainrestorerequest[propertyName];
+ * ```
+ *
+ * @see {@link DomainRestoreRequest} - The TypeScript type definition
+ * @see {@link KEYS_DOMAIN_RESTORE_REQUEST} - Array of all keys for this type
+ */
+export const KEY_DOMAIN_RESTORE_REQUEST_REASON = 'reason' as keyof DomainRestoreRequest;
+
+/**
+ * Array of all DomainRestoreRequest property keys
+ *
+ * @remarks
+ * This constant provides a readonly array containing all valid property keys for DomainRestoreRequest objects.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all keys
+ * for (const key of KEYS_DOMAIN_RESTORE_REQUEST) {
+ *   console.log(`Property: ${key}, Value: ${domainrestorerequest[key]}`);
+ * }
+ * 
+ * // Validation
+ * const isValidKey = KEYS_DOMAIN_RESTORE_REQUEST.includes(someKey);
+ * ```
+ *
+ * @see {@link DomainRestoreRequest} - The TypeScript type definition
+ */
+export const KEYS_DOMAIN_RESTORE_REQUEST = [
+  KEY_DOMAIN_RESTORE_REQUEST_ADDITIONAL_INFO,
+  KEY_DOMAIN_RESTORE_REQUEST_AUTO_RENEW,
+  KEY_DOMAIN_RESTORE_REQUEST_REASON,
+] as const satisfies (keyof DomainRestoreRequest)[];
+
+/**
+ * Domain Id
+ *
+ * The ID of the restored domain
+ *
+ * @type {string}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `domain_id` property of DomainRestore objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = domainrestore[KEY_DOMAIN_RESTORE_DOMAIN_ID];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DOMAIN_RESTORE_DOMAIN_ID;
+ * const value = domainrestore[propertyName];
+ * ```
+ *
+ * @see {@link DomainRestore} - The TypeScript type definition
+ * @see {@link KEYS_DOMAIN_RESTORE} - Array of all keys for this type
+ */
+export const KEY_DOMAIN_RESTORE_DOMAIN_ID = 'domain_id' as keyof DomainRestore;
+/**
+ * Expiration Date
+ *
+ * The new expiration date after restore
+ *
+ * @type {string}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `expiration_date` property of DomainRestore objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = domainrestore[KEY_DOMAIN_RESTORE_EXPIRATION_DATE];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DOMAIN_RESTORE_EXPIRATION_DATE;
+ * const value = domainrestore[propertyName];
+ * ```
+ *
+ * @see {@link DomainRestore} - The TypeScript type definition
+ * @see {@link KEYS_DOMAIN_RESTORE} - Array of all keys for this type
+ */
+export const KEY_DOMAIN_RESTORE_EXPIRATION_DATE = 'expiration_date' as keyof DomainRestore;
+/**
+ * Name
+ *
+ * The name of the restored domain
+ *
+ * @type {string}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `name` property of DomainRestore objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = domainrestore[KEY_DOMAIN_RESTORE_NAME];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DOMAIN_RESTORE_NAME;
+ * const value = domainrestore[propertyName];
+ * ```
+ *
+ * @see {@link DomainRestore} - The TypeScript type definition
+ * @see {@link KEYS_DOMAIN_RESTORE} - Array of all keys for this type
+ */
+export const KEY_DOMAIN_RESTORE_NAME = 'name' as keyof DomainRestore;
+/**
+ * Restored At
+ *
+ * When the domain restore operation was completed
+ *
+ * @type {string}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `restored_at` property of DomainRestore objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = domainrestore[KEY_DOMAIN_RESTORE_RESTORED_AT];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DOMAIN_RESTORE_RESTORED_AT;
+ * const value = domainrestore[propertyName];
+ * ```
+ *
+ * @see {@link DomainRestore} - The TypeScript type definition
+ * @see {@link KEYS_DOMAIN_RESTORE} - Array of all keys for this type
+ */
+export const KEY_DOMAIN_RESTORE_RESTORED_AT = 'restored_at' as keyof DomainRestore;
+
+/**
+ * Array of all DomainRestore property keys
+ *
+ * @remarks
+ * This constant provides a readonly array containing all valid property keys for DomainRestore objects.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all keys
+ * for (const key of KEYS_DOMAIN_RESTORE) {
+ *   console.log(`Property: ${key}, Value: ${domainrestore[key]}`);
+ * }
+ * 
+ * // Validation
+ * const isValidKey = KEYS_DOMAIN_RESTORE.includes(someKey);
+ * ```
+ *
+ * @see {@link DomainRestore} - The TypeScript type definition
+ */
+export const KEYS_DOMAIN_RESTORE = [
+  KEY_DOMAIN_RESTORE_DOMAIN_ID,
+  KEY_DOMAIN_RESTORE_EXPIRATION_DATE,
+  KEY_DOMAIN_RESTORE_NAME,
+  KEY_DOMAIN_RESTORE_RESTORED_AT,
+] as const satisfies (keyof DomainRestore)[];
+
 /**
  * Processing Time Ms
  *

package/src/helpers/requests.d.ts

@@ -34,7 +34,7 @@ import { operations } from '../schema';
 
 import { DomainDnssecDataCreateArray, OrganizationAttributeUpdateArray } from './schemas-arrays.d';
 
-import { OrganizationCredentialExtra, SignupCreate, ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainCreate, DomainUpdate, DomainRenewRequest, DomainTransferIn, EmailForwardAlias, EmailForwardAliasUpdate, NotificationCreate, NotificationUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, UserCreate, StartPasswordReset, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
+import { OrganizationCredentialExtra, SignupCreate, ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainCreate, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainTransferIn, EmailForwardAlias, EmailForwardAliasUpdate, NotificationCreate, NotificationUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, UserCreate, StartPasswordReset, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
 
 /**
  * Request type for GET AuthClientCredentials endpoint
@@ -1793,6 +1793,58 @@ export type POST_DomainsDomainReferenceRenew_Request_Path = POST_DomainsDomainRe
  */
 export type POST_DomainsDomainReferenceRenew_Request_Body = POST_DomainsDomainReferenceRenew_Request['requestBody'];
 
+/**
+ * Request type for POST DomainsDomainReferenceRestore endpoint
+ *
+ * Restore Domain
+ *
+ * @remarks
+ * This type defines the complete request structure for the POST DomainsDomainReferenceRestore endpoint.
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @example
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @path /v1/domains/{domain_reference}/restore
+ *
+ * @see {@link POST_DomainsDomainReferenceRestore_Request_Query} - Query parameters type
+ * @see {@link POST_DomainsDomainReferenceRestore_Request_Path} - Path parameters type
+ * @see {@link POST_DomainsDomainReferenceRestore_Request_Body} - Request body type
+ */
+export type POST_DomainsDomainReferenceRestore_Request = {
+  parameters: {
+    path: operations['restore_domain_v1_domains__domain_reference__restore_post']['parameters']['path'];
+  };
+  requestBody: DomainRestoreRequest;
+}
+/**
+ * Path parameters for POST /v1/domains/{domain_reference}/restore
+ *
+ * @remarks
+ * This type defines the path parameters for the POST /v1/domains/{domain_reference}/restore endpoint.
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
+ *
+ * @example
+ * Use this type to ensure type safety for path parameters.
+ *
+ * @path /v1/domains/{domain_reference}/restore
+ */
+export type POST_DomainsDomainReferenceRestore_Request_Path = POST_DomainsDomainReferenceRestore_Request['parameters']['path'];
+/**
+ * Request body for POST /v1/domains/{domain_reference}/restore
+ *
+ * @remarks
+ * This type defines the request body structure for the POST /v1/domains/{domain_reference}/restore endpoint.
+ * It provides type safety for the request body as defined in the OpenAPI specification.
+ *
+ * @example
+ * Use this type to ensure type safety for request body structure.
+ *
+ * @path /v1/domains/{domain_reference}/restore
+ */
+export type POST_DomainsDomainReferenceRestore_Request_Body = POST_DomainsDomainReferenceRestore_Request['requestBody'];
+
 /**
  * Request type for DELETE DomainsDomainReferenceTransfer endpoint
  *

package/src/helpers/responses.d.ts

@@ -34,7 +34,7 @@
 
 import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
 
-import { Pagination_OrganizationCredential, Problem, HTTPValidationError, OrganizationCredentialCreated, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DnsZoneSummary, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainCheck, DomainSummary, Pagination_EmailForwardAlias, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_UserNotificationSummary, Notification, UserNotification, Pagination_Organization, Organization, OrganizationWithBillingData, GetCurrentAvailablePlans, GetPrices, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, UserVerification, UserPasswordResetEmail, UserWithRelationPermissions } from './schemas.d';
+import { Pagination_OrganizationCredential, Problem, HTTPValidationError, OrganizationCredentialCreated, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DnsZoneSummary, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, Pagination_EmailForwardAlias, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_UserNotificationSummary, Notification, UserNotification, Pagination_Organization, Organization, OrganizationWithBillingData, GetCurrentAvailablePlans, GetPrices, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, UserVerification, UserPasswordResetEmail, UserWithRelationPermissions } from './schemas.d';
 
 /**
  * Response types for GET AuthClientCredentials endpoint
@@ -2863,6 +2863,61 @@ export type POST_DomainsByDomainReferenceRenew_Response_200 = DomainRenew
  */
 export type POST_DomainsByDomainReferenceRenew_Response_422 = HTTPValidationError
 
+/**
+ * Response types for POST DomainsByDomainReferenceRestore endpoint
+ *
+ * Restore Domain
+ *
+ * @remarks
+ * This type defines all possible response structures for the POST DomainsByDomainReferenceRestore endpoint.
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
+ * Use this type to ensure type safety when handling API responses from this endpoint.
+ *
+
+ *
+ * @path /v1/domains/{domain_reference}/restore
+ *
+ * @see {@link POST_DomainsByDomainReferenceRestore_Response_200} - 200 response type
+ * @see {@link POST_DomainsByDomainReferenceRestore_Response_422} - 422 response type
+ *
+
+ */
+export type POST_DomainsByDomainReferenceRestore_Response = POST_DomainsByDomainReferenceRestore_Response_200 | POST_DomainsByDomainReferenceRestore_Response_422;
+
+/**
+ * 200 response for POST DomainsByDomainReferenceRestore endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 200 status code
+ * of the POST DomainsByDomainReferenceRestore endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/domains/{domain_reference}/restore
+ *
+ * @see {@link POST_DomainsByDomainReferenceRestore_Response} - The main response type definition
+ * @see {@link DomainRestore} - The actual schema type definition
+ */
+export type POST_DomainsByDomainReferenceRestore_Response_200 = DomainRestore
+
+/**
+ * 422 response for POST DomainsByDomainReferenceRestore endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 422 status code
+ * of the POST DomainsByDomainReferenceRestore endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/domains/{domain_reference}/restore
+ *
+ * @see {@link POST_DomainsByDomainReferenceRestore_Response} - The main response type definition
+ * @see {@link HTTPValidationError} - The actual schema type definition
+ */
+export type POST_DomainsByDomainReferenceRestore_Response_422 = HTTPValidationError
+
 /**
  * Response types for DELETE DomainsByDomainReferenceTransfer endpoint
  *

package/src/helpers/schemas.d.ts

@@ -1034,6 +1034,38 @@ export type DomainRenew = components['schemas']['DomainRenewResponse'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type Domain = components['schemas']['DomainResponse'];
+/**
+ * DomainRestoreRequest
+ *
+ * @remarks
+ * Type alias for the `DomainRestoreRequest` OpenAPI schema.
+ * This type represents domainrestorerequest data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getDomainRestoreRequest();
+ * const item: DomainRestoreRequest = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type DomainRestoreRequest = components['schemas']['DomainRestoreRequest'];
+/**
+ * DomainRestoreResponse
+ *
+ * @remarks
+ * Type alias for the `DomainRestoreResponse` OpenAPI schema.
+ * This type represents domainrestoreresponse data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getDomainRestore();
+ * const item: DomainRestore = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type DomainRestore = components['schemas']['DomainRestoreResponse'];
 /**
  * DomainSearchMeta
  *

package/src/openapi.yaml

@@ -1738,6 +1738,59 @@ components:
       - roid
       title: DomainResponse
       type: object
+    DomainRestoreRequest:
+      properties:
+        additional_info:
+          anyOf:
+          - type: string
+          - type: 'null'
+          description: Additional information to include in the restore operation
+          title: Additional Info
+        auto_renew:
+          default: true
+          description: Whether to automatically renew the domain after restore
+          title: Auto Renew
+          type: boolean
+        reason:
+          description: Reason for restoring the domain
+          title: Reason
+          type: string
+      required:
+      - reason
+      title: DomainRestoreRequest
+      type: object
+    DomainRestoreResponse:
+      properties:
+        domain_id:
+          description: The ID of the restored domain
+          examples:
+          - domain_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^domain_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Domain Id
+          type: string
+          x-typeid-prefix: domain
+        expiration_date:
+          description: The new expiration date after restore
+          format: date-time
+          title: Expiration Date
+          type: string
+        name:
+          description: The name of the restored domain
+          title: Name
+          type: string
+        restored_at:
+          description: When the domain restore operation was completed
+          format: date-time
+          title: Restored At
+          type: string
+      required:
+      - domain_id
+      - name
+      - expiration_date
+      - restored_at
+      title: DomainRestoreResponse
+      type: object
     DomainSearchMeta:
       properties:
         processing_time_ms:
@@ -5271,7 +5324,7 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2025-09-15-073932
+  version: 2025-09-16-171129
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -7758,6 +7811,47 @@ paths:
       summary: Renew a domain
       tags:
       - domain
+  /v1/domains/{domain_reference}/restore:
+    post:
+      operationId: restore_domain_v1_domains__domain_reference__restore_post
+      parameters:
+      - in: path
+        name: domain_reference
+        required: true
+        schema:
+          anyOf:
+          - examples:
+            - domain_01h45ytscbebyvny4gc8cr8ma2
+            format: typeid
+            pattern: ^domain_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+            type: string
+            x-typeid-prefix: domain
+          - type: string
+          title: Domain Reference
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/DomainRestoreRequest'
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/DomainRestoreResponse'
+          description: Successful Response
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      summary: Restore Domain
+      tags:
+      - domain
   /v1/domains/{domain_reference}/transfer:
     delete:
       description: This will cancel the in-progress domain transfer and delete the