@opusdns/api 0.177.0 → 0.178.0

package/package.json

@@ -3,7 +3,7 @@
     "@opusdns/api-spec-ts-generator": "^0.19.0"
   },
   "name": "@opusdns/api",
-  "version": "0.177.0",
+  "version": "0.178.0",
   "description": "TypeScript types for the OpusDNS OpenAPI specification",
   "main": "./src/index.ts",
   "module": "./src/index.ts",

package/src/helpers/constants.ts

@@ -21,7 +21,7 @@
  * ```
  */
 
-import { AllocationMethodType, AttributeType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ComplianceStatus, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainSortField, DomainStatus, EmailForwardLogSortField, EmailForwardLogStatus, EmailForwardSortField, EmailForwardZoneSortField, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, GrantType, HostStatus, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, LaunchPhaseType, LocalPresenceRequirementType, MetricsGrouping, ObjectEventType, ObjectLogSortField, OrganizationStatus, ParkingSortField, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, Protocol, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, RequestHistorySortField, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TimeRange, TransferAckType, UserStatus, VerificationType, ZoneSortField } from './schemas';
+import { AllocationMethodType, AttributeType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ComplianceStatus, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainSortField, DomainStatus, EmailForwardLogSortField, EmailForwardLogStatus, EmailForwardSortField, EmailForwardZoneSortField, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, ExecutingEntity, GrantType, HTTPMethod, HostStatus, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, LaunchPhaseType, LocalPresenceRequirementType, MetricsGrouping, ObjectEventType, ObjectLogSortField, OrganizationStatus, ParkingSortField, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, Protocol, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, RequestHistorySortField, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TimeRange, TransferAckType, UserStatus, VerificationType, ZoneSortField } from './schemas';
 
 /**
  * AllocationMethodType. Auto-generated enum for AllocationMethodType
@@ -1887,6 +1887,58 @@ export const EVENT_TYPE_VALUES = [
   'VERIFICATION'
 ] as const satisfies [string, ...string[]] | EventType[];
 
+/**
+ * ExecutingEntity. Auto-generated enum for ExecutingEntity
+ *
+ * @remarks
+ * This constant provides both object and array forms for the ExecutingEntity enum.
+ * The object form allows key-value access, while the array form enables iteration and validation.
+ *
+ * @example
+ * ```typescript
+ * // Using the object form for key-value access
+ * const status = EXECUTING_ENTITY.SUCCESS;
+ * 
+ * // Using the array form for iteration
+ * const allStatuses = EXECUTING_ENTITY_VALUES;
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
+ * ```
+ *
+ * @see {@link ExecutingEntity} - The TypeScript type definition
+ */
+export const EXECUTING_ENTITY = {
+  USER: "user",
+  ORGANIZATION: "organization",
+  SYSTEM: "system",
+} as const satisfies Record<string, ExecutingEntity>;
+
+/**
+ * Array of all ExecutingEntity enum values
+ *
+ * @remarks
+ * This constant provides a array containing all valid ExecutingEntity enum values.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all values
+ * for (const value of EXECUTING_ENTITY_VALUES) {
+ *   console.log(`Processing: ${value}`);
+ * }
+ * 
+ * // Validation
+ * const isValid = EXECUTING_ENTITY_VALUES.includes(someValue);
+ * ```
+ *
+ * @see {@link ExecutingEntity} - The TypeScript type definition
+ * @see {@link EXECUTING_ENTITY} - The object form of this enum
+ */
+export const EXECUTING_ENTITY_VALUES = [
+  'user',
+  'organization',
+  'system'
+] as const satisfies [string, ...string[]] | ExecutingEntity[];
+
 /**
  * GrantType. Auto-generated enum for GrantType
  *
@@ -1939,6 +1991,75 @@ export const GRANT_TYPE_VALUES = [
   'refresh_token'
 ] as const satisfies [string, ...string[]] | GrantType[];
 
+/**
+ * HTTPMethod. HTTP methods and descriptions
+
+Methods from the following RFCs are all observed:
+
+    * RFC 9110: HTTP Semantics, obsoletes 7231, which obsoleted 2616
+    * RFC 5789: PATCH Method for HTTP
+ *
+ * @remarks
+ * This constant provides both object and array forms for the HTTPMethod enum.
+ * The object form allows key-value access, while the array form enables iteration and validation.
+ *
+ * @example
+ * ```typescript
+ * // Using the object form for key-value access
+ * const status = HTTP_METHOD.SUCCESS;
+ * 
+ * // Using the array form for iteration
+ * const allStatuses = HTTP_METHOD_VALUES;
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
+ * ```
+ *
+ * @see {@link HTTPMethod} - The TypeScript type definition
+ */
+export const HTTP_METHOD = {
+  CONNECT: "CONNECT",
+  DELETE: "DELETE",
+  GET: "GET",
+  HEAD: "HEAD",
+  OPTIONS: "OPTIONS",
+  PATCH: "PATCH",
+  POST: "POST",
+  PUT: "PUT",
+  TRACE: "TRACE",
+} as const satisfies Record<string, HTTPMethod>;
+
+/**
+ * Array of all HTTPMethod enum values
+ *
+ * @remarks
+ * This constant provides a array containing all valid HTTPMethod enum values.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all values
+ * for (const value of HTTP_METHOD_VALUES) {
+ *   console.log(`Processing: ${value}`);
+ * }
+ * 
+ * // Validation
+ * const isValid = HTTP_METHOD_VALUES.includes(someValue);
+ * ```
+ *
+ * @see {@link HTTPMethod} - The TypeScript type definition
+ * @see {@link HTTP_METHOD} - The object form of this enum
+ */
+export const HTTP_METHOD_VALUES = [
+  'CONNECT',
+  'DELETE',
+  'GET',
+  'HEAD',
+  'OPTIONS',
+  'PATCH',
+  'POST',
+  'PUT',
+  'TRACE'
+] as const satisfies [string, ...string[]] | HTTPMethod[];
+
 /**
  * HostStatus. Auto-generated enum for HostStatus
  *

package/src/helpers/keys.ts

@@ -16311,7 +16311,7 @@ export const KEY_OBJECT_LOG_OBJECT_TYPE: keyof ObjectLog = 'object_type';
  */
 export const KEY_OBJECT_LOG_PERFORMED_BY_ID: keyof ObjectLog = 'performed_by_id';
 /**
- * Performed By Type
+ * performed_by_type property
  *
  * Type of the actor who performed the action
  *
@@ -21522,11 +21522,10 @@ export const KEY_REQUEST_HISTORY_CLIENT_IP: keyof RequestHistory = 'client_ip';
  */
 export const KEY_REQUEST_HISTORY_DURATION: keyof RequestHistory = 'duration';
 /**
- * Method
+ * method property
  *
  * HTTP method
  *
- * @type {string}
  *
  *
  * @remarks
@@ -21599,7 +21598,7 @@ export const KEY_REQUEST_HISTORY_PATH: keyof RequestHistory = 'path';
  */
 export const KEY_REQUEST_HISTORY_PERFORMED_BY_ID: keyof RequestHistory = 'performed_by_id';
 /**
- * Performed By Type
+ * performed_by_type property
  *
  * Type of the actor who performed the request
  *

package/src/helpers/schemas.d.ts

@@ -2202,6 +2202,22 @@ export type EventSubtype = components['schemas']['EventSubtype'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type EventType = components['schemas']['EventType'];
+/**
+ * ExecutingEntity
+ *
+ * @remarks
+ * Type alias for the `ExecutingEntity` OpenAPI schema.
+ * This type represents executingentity data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getExecutingEntity();
+ * const item: ExecutingEntity = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type ExecutingEntity = components['schemas']['ExecutingEntity'];
 /**
  * GeneralAvailabilityBase
  *
@@ -2266,6 +2282,27 @@ export type GetPrices = components['schemas']['GetPricesResponse'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type GrantType = components['schemas']['GrantType'];
+/**
+ * HTTPMethod. HTTP methods and descriptions
+
+Methods from the following RFCs are all observed:
+
+    * RFC 9110: HTTP Semantics, obsoletes 7231, which obsoleted 2616
+    * RFC 5789: PATCH Method for HTTP
+ *
+ * @remarks
+ * Type alias for the `HTTPMethod` OpenAPI schema.
+ * This type represents httpmethod data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getHTTPMethod();
+ * const item: HTTPMethod = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type HTTPMethod = components['schemas']['HTTPMethod'];
 /**
  * RequestValidationError
  *

package/src/openapi.yaml

@@ -3313,6 +3313,13 @@ components:
       - VERIFICATION
       title: EventType
       type: string
+    ExecutingEntity:
+      enum:
+      - user
+      - organization
+      - system
+      title: ExecutingEntity
+      type: string
     GeneralAvailabilityBase:
       properties:
         start_date:
@@ -3356,6 +3363,22 @@ components:
       - refresh_token
       title: GrantType
       type: string
+    HTTPMethod:
+      description: "HTTP methods and descriptions\n\nMethods from the following RFCs\
+        \ are all observed:\n\n    * RFC 9110: HTTP Semantics, obsoletes 7231, which\
+        \ obsoleted 2616\n    * RFC 5789: PATCH Method for HTTP"
+      enum:
+      - CONNECT
+      - DELETE
+      - GET
+      - HEAD
+      - OPTIONS
+      - PATCH
+      - POST
+      - PUT
+      - TRACE
+      title: HTTPMethod
+      type: string
     HTTPValidationError:
       properties:
         errors:
@@ -3971,10 +3994,9 @@ components:
           title: Performed By Id
         performed_by_type:
           anyOf:
-          - type: string
+          - $ref: '#/components/schemas/ExecutingEntity'
           - type: 'null'
           description: Type of the actor who performed the action
-          title: Performed By Type
         server_request_id:
           anyOf:
           - type: string
@@ -5568,6 +5590,7 @@ components:
       properties:
         client_ip:
           description: Client IP address
+          format: ipvanyaddress
           title: Client Ip
           type: string
         duration:
@@ -5575,9 +5598,8 @@ components:
           title: Duration
           type: number
         method:
+          $ref: '#/components/schemas/HTTPMethod'
           description: HTTP method
-          title: Method
-          type: string
         path:
           description: Request path
           title: Path
@@ -5590,10 +5612,9 @@ components:
           title: Performed By Id
         performed_by_type:
           anyOf:
-          - type: string
+          - $ref: '#/components/schemas/ExecutingEntity'
           - type: 'null'
           description: Type of the actor who performed the request
-          title: Performed By Type
         request_body:
           anyOf:
           - additionalProperties: true
@@ -6939,7 +6960,7 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-01-28-123004
+  version: 2026-01-29-080310
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -7222,23 +7243,23 @@ paths:
           - type: 'null'
           title: Performed By Id
       - in: query
-        name: start_time
+        name: created_before
         required: false
         schema:
           anyOf:
           - format: date-time
             type: string
           - type: 'null'
-          title: Start Time
+          title: Created Before
       - in: query
-        name: end_time
+        name: created_after
         required: false
         schema:
           anyOf:
           - format: date-time
             type: string
           - type: 'null'
-          title: End Time
+          title: Created After
       - in: query
         name: object_id
         required: false
@@ -7356,23 +7377,23 @@ paths:
           - type: 'null'
           title: Performed By Id
       - in: query
-        name: start_time
+        name: created_before
         required: false
         schema:
           anyOf:
           - format: date-time
             type: string
           - type: 'null'
-          title: Start Time
+          title: Created Before
       - in: query
-        name: end_time
+        name: created_after
         required: false
         schema:
           anyOf:
           - format: date-time
             type: string
           - type: 'null'
-          title: End Time
+          title: Created After
       responses:
         '200':
           content:
@@ -7431,7 +7452,7 @@ paths:
         required: false
         schema:
           anyOf:
-          - type: string
+          - $ref: '#/components/schemas/HTTPMethod'
           - type: 'null'
           title: Method
       - in: query
@@ -7487,7 +7508,8 @@ paths:
         required: false
         schema:
           anyOf:
-          - type: string
+          - format: ipvanyaddress
+            type: string
           - type: 'null'
           title: Client Ip
       - in: query
@@ -7503,7 +7525,7 @@ paths:
         required: false
         schema:
           anyOf:
-          - type: string
+          - $ref: '#/components/schemas/ExecutingEntity'
           - type: 'null'
           title: Performed By Type
       - in: query
@@ -7515,23 +7537,23 @@ paths:
           - type: 'null'
           title: Performed By Id
       - in: query
-        name: start_time
+        name: request_started_before
         required: false
         schema:
           anyOf:
           - format: date-time
             type: string
           - type: 'null'
-          title: Start Time
+          title: Request Started Before
       - in: query
-        name: end_time
+        name: request_started_after
         required: false
         schema:
           anyOf:
           - format: date-time
             type: string
           - type: 'null'
-          title: End Time
+          title: Request Started After
       responses:
         '200':
           content:

package/src/schema.d.ts

@@ -4064,6 +4064,11 @@ export interface components {
          * @enum {string}
          */
         EventType: "REGISTRATION" | "RENEWAL" | "MODIFICATION" | "DELETION" | "INBOUND_TRANSFER" | "OUTBOUND_TRANSFER" | "VERIFICATION";
+        /**
+         * ExecutingEntity
+         * @enum {string}
+         */
+        ExecutingEntity: "user" | "organization" | "system";
         /** GeneralAvailabilityBase */
         GeneralAvailabilityBase: {
             /**
@@ -4093,6 +4098,17 @@ export interface components {
          * @enum {string}
          */
         GrantType: "client_credentials" | "password" | "refresh_token";
+        /**
+         * HTTPMethod
+         * @description HTTP methods and descriptions
+         *
+         *     Methods from the following RFCs are all observed:
+         *
+         *         * RFC 9110: HTTP Semantics, obsoletes 7231, which obsoleted 2616
+         *         * RFC 5789: PATCH Method for HTTP
+         * @enum {string}
+         */
+        HTTPMethod: "CONNECT" | "DELETE" | "GET" | "HEAD" | "OPTIONS" | "PATCH" | "POST" | "PUT" | "TRACE";
         /** RequestValidationError */
         HTTPValidationError: {
             errors: components["schemas"]["ValidationError"][];
@@ -4511,11 +4527,8 @@ export interface components {
              * @description ID of the actor who performed the action
              */
             performed_by_id?: string | null;
-            /**
-             * Performed By Type
-             * @description Type of the actor who performed the action
-             */
-            performed_by_type?: string | null;
+            /** @description Type of the actor who performed the action */
+            performed_by_type?: components["schemas"]["ExecutingEntity"] | null;
             /**
              * Server Request Id
              * @description Server request ID
@@ -5506,6 +5519,7 @@ export interface components {
         RequestHistory: {
             /**
              * Client Ip
+             * Format: ipvanyaddress
              * @description Client IP address
              */
             client_ip: string;
@@ -5514,11 +5528,8 @@ export interface components {
              * @description Request duration in milliseconds
              */
             duration: number;
-            /**
-             * Method
-             * @description HTTP method
-             */
-            method: string;
+            /** @description HTTP method */
+            method: components["schemas"]["HTTPMethod"];
             /**
              * Path
              * @description Request path
@@ -5529,11 +5540,8 @@ export interface components {
              * @description ID of the actor who performed the request
              */
             performed_by_id?: string | null;
-            /**
-             * Performed By Type
-             * @description Type of the actor who performed the request
-             */
-            performed_by_type?: string | null;
+            /** @description Type of the actor who performed the request */
+            performed_by_type?: components["schemas"]["ExecutingEntity"] | null;
             /**
              * Request Body
              * @description Request body
@@ -6522,8 +6530,8 @@ export interface operations {
                 server_request_id?: string | null;
                 performed_by_type?: string | null;
                 performed_by_id?: string | null;
-                start_time?: Date | null;
-                end_time?: Date | null;
+                created_before?: Date | null;
+                created_after?: Date | null;
                 object_id?: string | null;
             };
             header?: never;
@@ -6565,8 +6573,8 @@ export interface operations {
                 server_request_id?: string | null;
                 performed_by_type?: string | null;
                 performed_by_id?: string | null;
-                start_time?: Date | null;
-                end_time?: Date | null;
+                created_before?: Date | null;
+                created_after?: Date | null;
             };
             header?: never;
             path: {
@@ -6603,7 +6611,7 @@ export interface operations {
                 sort_order?: components["schemas"]["SortOrder"];
                 page_size?: number;
                 page?: number;
-                method?: string | null;
+                method?: components["schemas"]["HTTPMethod"] | null;
                 path?: string | null;
                 status_code?: number | null;
                 min_status_code?: number | null;
@@ -6612,10 +6620,10 @@ export interface operations {
                 max_duration?: number | null;
                 client_ip?: string | null;
                 server_request_id?: string | null;
-                performed_by_type?: string | null;
+                performed_by_type?: components["schemas"]["ExecutingEntity"] | null;
                 performed_by_id?: string | null;
-                start_time?: Date | null;
-                end_time?: Date | null;
+                request_started_before?: Date | null;
+                request_started_after?: Date | null;
             };
             header?: never;
             path?: never;