@opusdns/api 0.17.0 → 0.19.0

package/package.json

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

package/src/helpers/constants.ts

@@ -870,6 +870,7 @@ export const DOMAIN_STATUS = {
   SERVER_UPDATE_PROHIBITED: "serverUpdateProhibited",
   SERVER_DELETE_PROHIBITED: "serverDeleteProhibited",
   SERVER_RENEW_PROHIBITED: "serverRenewProhibited",
+  SERVER_RESTORE_PROHIBITED: "serverRestoreProhibited",
   SERVER_HOLD: "serverHold",
   TRANSFER_PERIOD: "transferPeriod",
   RENEW_PERIOD: "renewPeriod",
@@ -918,6 +919,7 @@ export const DOMAIN_STATUS_VALUES = [
   'serverUpdateProhibited',
   'serverDeleteProhibited',
   'serverRenewProhibited',
+  'serverRestoreProhibited',
   'serverHold',
   'transferPeriod',
   'renewPeriod',

package/src/helpers/keys.ts

@@ -119,6 +119,7 @@ import { RdapBase } from './schemas';
 import { RegistryLockBase } from './schemas';
 import { RelationSet } from './schemas';
 import { ReservedDomainsBase } from './schemas';
+import { RgpOperations } from './schemas';
 import { SignupCreate } from './schemas';
 import { SldLength } from './schemas';
 import { SpiceDbRelationshipUpdate } from './schemas';
@@ -5791,6 +5792,31 @@ export const KEY_DOMAIN_LIFECYCLE_BASE_REGISTRY_AUTO_RENEW = 'registry_auto_rene
  * @see {@link KEYS_DOMAIN_LIFECYCLE_BASE} - Array of all keys for this type
  */
 export const KEY_DOMAIN_LIFECYCLE_BASE_RENEWAL_PERIODS = 'renewal_periods' as keyof DomainLifecycleBase;
+/**
+ * rgp_operations property
+ *
+ * RGP operations supported by the registry
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `rgp_operations` property of DomainLifecycleBase objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = domainlifecyclebase[KEY_DOMAIN_LIFECYCLE_BASE_RGP_OPERATIONS];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DOMAIN_LIFECYCLE_BASE_RGP_OPERATIONS;
+ * const value = domainlifecyclebase[propertyName];
+ * ```
+ *
+ * @see {@link DomainLifecycleBase} - The TypeScript type definition
+ * @see {@link KEYS_DOMAIN_LIFECYCLE_BASE} - Array of all keys for this type
+ */
+export const KEY_DOMAIN_LIFECYCLE_BASE_RGP_OPERATIONS = 'rgp_operations' as keyof DomainLifecycleBase;
 /**
  * Sync After Operations
  *
@@ -5849,6 +5875,7 @@ export const KEYS_DOMAIN_LIFECYCLE_BASE = [
   KEY_DOMAIN_LIFECYCLE_BASE_REGISTRATION_PERIODS,
   KEY_DOMAIN_LIFECYCLE_BASE_REGISTRY_AUTO_RENEW,
   KEY_DOMAIN_LIFECYCLE_BASE_RENEWAL_PERIODS,
+  KEY_DOMAIN_LIFECYCLE_BASE_RGP_OPERATIONS,
   KEY_DOMAIN_LIFECYCLE_BASE_SYNC_AFTER_OPERATIONS,
 ] as const satisfies (keyof DomainLifecycleBase)[];
 
@@ -14514,6 +14541,84 @@ export const KEYS_RESERVED_DOMAINS_BASE = [
   KEY_RESERVED_DOMAINS_BASE_URL,
 ] as const satisfies (keyof ReservedDomainsBase)[];
 
+/**
+ * Report
+ *
+ * Whether registry supports RGP restore report
+ *
+ * @type {boolean}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `report` property of RgpOperations objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = rgpoperations[KEY_RGP_OPERATIONS_REPORT];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_RGP_OPERATIONS_REPORT;
+ * const value = rgpoperations[propertyName];
+ * ```
+ *
+ * @see {@link RgpOperations} - The TypeScript type definition
+ * @see {@link KEYS_RGP_OPERATIONS} - Array of all keys for this type
+ */
+export const KEY_RGP_OPERATIONS_REPORT = 'report' as keyof RgpOperations;
+/**
+ * Request
+ *
+ * Whether registry supports RGP restore request
+ *
+ * @type {boolean}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `request` property of RgpOperations objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = rgpoperations[KEY_RGP_OPERATIONS_REQUEST];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_RGP_OPERATIONS_REQUEST;
+ * const value = rgpoperations[propertyName];
+ * ```
+ *
+ * @see {@link RgpOperations} - The TypeScript type definition
+ * @see {@link KEYS_RGP_OPERATIONS} - Array of all keys for this type
+ */
+export const KEY_RGP_OPERATIONS_REQUEST = 'request' as keyof RgpOperations;
+
+/**
+ * Array of all RgpOperations property keys
+ *
+ * @remarks
+ * This constant provides a readonly array containing all valid property keys for RgpOperations objects.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all keys
+ * for (const key of KEYS_RGP_OPERATIONS) {
+ *   console.log(`Property: ${key}, Value: ${rgpoperations[key]}`);
+ * }
+ * 
+ * // Validation
+ * const isValidKey = KEYS_RGP_OPERATIONS.includes(someKey);
+ * ```
+ *
+ * @see {@link RgpOperations} - The TypeScript type definition
+ */
+export const KEYS_RGP_OPERATIONS = [
+  KEY_RGP_OPERATIONS_REPORT,
+  KEY_RGP_OPERATIONS_REQUEST,
+] as const satisfies (keyof RgpOperations)[];
+
 /**
  * organization property
  *

package/src/helpers/schemas.d.ts

@@ -2282,6 +2282,22 @@ export type ReservedDomainsBase = components['schemas']['ReservedDomainsBase'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type ReservedSourceType = components['schemas']['ReservedSourceType'];
+/**
+ * RgpOperations
+ *
+ * @remarks
+ * Type alias for the `RgpOperations` OpenAPI schema.
+ * This type represents rgpoperations data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getRgpOperations();
+ * const item: RgpOperations = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type RgpOperations = components['schemas']['RgpOperations'];
 /**
  * SignupCreate
  *

package/src/openapi.yaml

@@ -1395,6 +1395,11 @@ components:
           $ref: '#/components/schemas/PeriodList'
           description: List of allowed renewal periods (e.g., '1y' or ['1y', '2y',
             '5y'])
+        rgp_operations:
+          anyOf:
+          - $ref: '#/components/schemas/RgpOperations'
+          - type: 'null'
+          description: RGP operations supported by the registry
         sync_after_operations:
           anyOf:
           - items:
@@ -1680,6 +1685,7 @@ components:
       - serverUpdateProhibited
       - serverDeleteProhibited
       - serverRenewProhibited
+      - serverRestoreProhibited
       - serverHold
       - transferPeriod
       - renewPeriod
@@ -3782,6 +3788,20 @@ components:
       - manual
       title: ReservedSourceType
       type: string
+    RgpOperations:
+      properties:
+        report:
+          default: true
+          description: Whether registry supports RGP restore report
+          title: Report
+          type: boolean
+        request:
+          default: true
+          description: Whether registry supports RGP restore request
+          title: Request
+          type: boolean
+      title: RgpOperations
+      type: object
     SignupCreate:
       properties:
         organization:
@@ -4819,7 +4839,7 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2025-08-07-211955
+  version: 2025-08-15-171704
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -5269,23 +5289,6 @@ paths:
       description: List all contacts
       operationId: get_contacts_v1_contacts_get
       parameters:
-      - in: query
-        name: page
-        required: false
-        schema:
-          default: 1
-          minimum: 1
-          title: Page
-          type: integer
-      - in: query
-        name: page_size
-        required: false
-        schema:
-          default: 10
-          maximum: 100
-          minimum: 1
-          title: Page Size
-          type: integer
       - in: query
         name: sort_by
         required: false
@@ -5356,6 +5359,23 @@ paths:
             type: string
           - type: 'null'
           title: Created Before
+      - in: query
+        name: page
+        required: false
+        schema:
+          default: 1
+          minimum: 1
+          title: Page
+          type: integer
+      - in: query
+        name: page_size
+        required: false
+        schema:
+          default: 10
+          maximum: 100
+          minimum: 1
+          title: Page Size
+          type: integer
       responses:
         '200':
           content:
@@ -5951,23 +5971,6 @@ paths:
     get:
       operationId: list_zones_v1_dns_get
       parameters:
-      - in: query
-        name: page
-        required: false
-        schema:
-          default: 1
-          minimum: 1
-          title: Page
-          type: integer
-      - in: query
-        name: page_size
-        required: false
-        schema:
-          default: 10
-          maximum: 100
-          minimum: 1
-          title: Page Size
-          type: integer
       - in: query
         name: sort_by
         required: false
@@ -6048,6 +6051,23 @@ paths:
             type: string
           - type: 'null'
           title: Updated Before
+      - in: query
+        name: page
+        required: false
+        schema:
+          default: 1
+          minimum: 1
+          title: Page
+          type: integer
+      - in: query
+        name: page_size
+        required: false
+        schema:
+          default: 10
+          maximum: 100
+          minimum: 1
+          title: Page Size
+          type: integer
       responses:
         '200':
           content:
@@ -6428,23 +6448,6 @@ paths:
       description: Retrieves a paginated list of all domains
       operationId: get_domains_v1_domains_get
       parameters:
-      - in: query
-        name: page
-        required: false
-        schema:
-          default: 1
-          minimum: 1
-          title: Page
-          type: integer
-      - in: query
-        name: page_size
-        required: false
-        schema:
-          default: 10
-          maximum: 100
-          minimum: 1
-          title: Page Size
-          type: integer
       - in: query
         name: sort_by
         required: false
@@ -6593,6 +6596,23 @@ paths:
             type: string
           - type: 'null'
           title: Registered Before
+      - in: query
+        name: page
+        required: false
+        schema:
+          default: 1
+          minimum: 1
+          title: Page
+          type: integer
+      - in: query
+        name: page_size
+        required: false
+        schema:
+          default: 10
+          maximum: 100
+          minimum: 1
+          title: Page Size
+          type: integer
       responses:
         '200':
           content:

package/src/schema.d.ts

@@ -1984,6 +1984,8 @@ export interface components {
             registry_auto_renew?: boolean | null;
             /** @description List of allowed renewal periods (e.g., '1y' or ['1y', '2y', '5y']) */
             renewal_periods?: components["schemas"]["PeriodList"];
+            /** @description RGP operations supported by the registry */
+            rgp_operations?: components["schemas"]["RgpOperations"] | null;
             /**
              * Sync After Operations
              * @description Operations that trigger a sync with the registry
@@ -2173,7 +2175,7 @@ export interface components {
          * DomainStatus
          * @enum {string}
          */
-        DomainStatus: "ok" | "serverTransferProhibited" | "serverUpdateProhibited" | "serverDeleteProhibited" | "serverRenewProhibited" | "serverHold" | "transferPeriod" | "renewPeriod" | "redemptionPeriod" | "pendingUpdate" | "pendingTransfer" | "pendingRestore" | "pendingRenew" | "pendingDelete" | "pendingCreate" | "inactive" | "autoRenewPeriod" | "addPeriod" | "deleted" | "clientTransferProhibited" | "clientUpdateProhibited" | "clientDeleteProhibited" | "clientRenewProhibited" | "clientHold";
+        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";
         /** DomainStatusesBase */
         DomainStatusesBase: {
             /**
@@ -3557,6 +3559,21 @@ export interface components {
          * @enum {string}
          */
         ReservedSourceType: "API" | "CSV" | "manual";
+        /** RgpOperations */
+        RgpOperations: {
+            /**
+             * Report
+             * @description Whether registry supports RGP restore report
+             * @default true
+             */
+            report: boolean;
+            /**
+             * Request
+             * @description Whether registry supports RGP restore request
+             * @default true
+             */
+            request: boolean;
+        };
         /** SignupCreate */
         SignupCreate: {
             /** @description Organization signup. */
@@ -4664,8 +4681,6 @@ export interface operations {
     get_contacts_v1_contacts_get: {
         parameters: {
             query?: {
-                page?: number;
-                page_size?: number;
                 sort_by?: components["schemas"]["ContactSortField"];
                 sort_order?: components["schemas"]["SortOrder"];
                 first_name?: string | null;
@@ -4675,6 +4690,8 @@ export interface operations {
                 country?: string | null;
                 created_after?: Date | null;
                 created_before?: Date | null;
+                page?: number;
+                page_size?: number;
             };
             header?: never;
             path?: never;
@@ -5338,8 +5355,6 @@ export interface operations {
     list_zones_v1_dns_get: {
         parameters: {
             query?: {
-                page?: number;
-                page_size?: number;
                 sort_by?: components["schemas"]["ZoneSortField"];
                 sort_order?: components["schemas"]["SortOrder"];
                 dnssec_status?: components["schemas"]["DnssecStatus"] | null;
@@ -5350,6 +5365,8 @@ export interface operations {
                 created_before?: Date | null;
                 updated_after?: Date | null;
                 updated_before?: Date | null;
+                page?: number;
+                page_size?: number;
             };
             header?: never;
             path?: never;
@@ -5733,8 +5750,6 @@ export interface operations {
     get_domains_v1_domains_get: {
         parameters: {
             query?: {
-                page?: number;
-                page_size?: number;
                 sort_by?: components["schemas"]["DomainSortField"];
                 sort_order?: components["schemas"]["SortOrder"];
                 name?: string | null;
@@ -5753,6 +5768,8 @@ export interface operations {
                 expires_in_90_days?: boolean | null;
                 registered_after?: Date | null;
                 registered_before?: Date | null;
+                page?: number;
+                page_size?: number;
             };
             header?: never;
             path?: never;