@opusdns/api 0.85.0 → 0.87.0

package/package.json

@@ -3,7 +3,7 @@
     "@opusdns/api-spec-ts-generator": "^0.9.1"
   },
   "name": "@opusdns/api",
-  "version": "0.85.0",
+  "version": "0.87.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, ContactRoleType, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainSortField, DomainStatus, EmailVerificationStatus, EventObjectType, EventSubtype, EventType, GrantType, LaunchPhaseType, LocalPresenceRequirementType, OrganizationStatus, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TransferAckType, UserStatus, VerificationType, ZoneSortField } from './schemas';
+import { AllocationMethodType, AttributeType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ContactRoleType, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainSortField, DomainStatus, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, GrantType, LaunchPhaseType, LocalPresenceRequirementType, OrganizationStatus, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TransferAckType, UserStatus, VerificationType, ZoneSortField } from './schemas';
 
 /**
  * AllocationMethodType. Auto-generated enum for AllocationMethodType
@@ -1387,6 +1387,56 @@ export const EVENT_OBJECT_TYPE_VALUES = [
   'UNKNOWN'
 ] as const satisfies [string, ...string[]] | EventObjectType[];
 
+/**
+ * EventSortField. Auto-generated enum for EventSortField
+ *
+ * @remarks
+ * This constant provides both object and array forms for the EventSortField 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 = EVENT_SORT_FIELD.SUCCESS;
+ * 
+ * // Using the array form for iteration
+ * const allStatuses = EVENT_SORT_FIELD_VALUES;
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
+ * ```
+ *
+ * @see {@link EventSortField} - The TypeScript type definition
+ */
+export const EVENT_SORT_FIELD = {
+  OBJECT_ID: "object_id",
+  CREATED_ON: "created_on",
+} as const satisfies Record<string, EventSortField>;
+
+/**
+ * Array of all EventSortField enum values
+ *
+ * @remarks
+ * This constant provides a array containing all valid EventSortField enum values.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all values
+ * for (const value of EVENT_SORT_FIELD_VALUES) {
+ *   console.log(`Processing: ${value}`);
+ * }
+ * 
+ * // Validation
+ * const isValid = EVENT_SORT_FIELD_VALUES.includes(someValue);
+ * ```
+ *
+ * @see {@link EventSortField} - The TypeScript type definition
+ * @see {@link EVENT_SORT_FIELD} - The object form of this enum
+ */
+export const EVENT_SORT_FIELD_VALUES = [
+  'object_id',
+  'created_on'
+] as const satisfies [string, ...string[]] | EventSortField[];
+
 /**
  * EventSubtype. Auto-generated enum for EventSubtype
  *

package/src/helpers/requests.d.ts

@@ -2443,7 +2443,7 @@ export type PATCH_EmailForwardsZoneNameEnable_Request_Path = PATCH_EmailForwards
  * Request type for GET Events endpoint
  *
  * Get pending events
- * Retrieves a paginated list of pending events for the organization
+ * Retrieves a paginated list of events for the organization
  *
  * @remarks
  * This type defines the complete request structure for the GET Events endpoint.
@@ -3377,6 +3377,45 @@ export type GET_OrganizationsUsers_Request = {
  */
 export type GET_OrganizationsUsers_Request_Query = GET_OrganizationsUsers_Request['parameters']['query'];
 
+/**
+ * Request type for GET Tlds endpoint
+ *
+ * Get list of Specifications for all TLDs we support
+ * Retrieves a list of TLD Specifications we have support for
+ *
+ * @remarks
+ * This type defines the complete request structure for the GET Tlds 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/tlds/
+ *
+ * @see {@link GET_Tlds_Request_Query} - Query parameters type
+ * @see {@link GET_Tlds_Request_Path} - Path parameters type
+ * @see {@link GET_Tlds_Request_Body} - Request body type
+ */
+export type GET_Tlds_Request = {
+  parameters: {
+    query: operations['get_tld_specifications_v1_tlds__get']['parameters']['query'];
+  };
+}
+/**
+ * Query parameters for GET /v1/tlds/
+ *
+ * @remarks
+ * This type defines the query parameters for the GET /v1/tlds/ endpoint.
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
+ *
+ * @example
+ * Use this type to ensure type safety for query parameters.
+ *
+ * @path /v1/tlds/
+ */
+export type GET_Tlds_Request_Query = GET_Tlds_Request['parameters']['query'];
+
 /**
  * Request type for GET TldsPortfolio endpoint
  *

package/src/helpers/responses.d.ts

@@ -3581,7 +3581,7 @@ export type PATCH_EmailForwardsByZoneNameEnable_Response_422 = HTTPValidationErr
  * Response types for GET Events endpoint
  *
  * Get pending events
- * Retrieves a paginated list of pending events for the organization
+ * Retrieves a paginated list of events for the organization
  *
  * @remarks
  * This type defines all possible response structures for the GET Events endpoint.
@@ -5499,6 +5499,44 @@ export type GET_OrganizationsUsers_Response_403 = Problem
  */
 export type GET_OrganizationsUsers_Response_422 = HTTPValidationError
 
+/**
+ * Response types for GET Tlds endpoint
+ *
+ * Get list of Specifications for all TLDs we support
+ * Retrieves a list of TLD Specifications we have support for
+ *
+ * @remarks
+ * This type defines all possible response structures for the GET Tlds 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/tlds/
+ *
+ * @see {@link GET_Tlds_Response_422} - 422 response type
+ *
+
+ */
+export type GET_Tlds_Response = GET_Tlds_Response_422;
+
+/**
+ * 422 response for GET Tlds endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 422 status code
+ * of the GET Tlds endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/tlds/
+ *
+ * @see {@link GET_Tlds_Response} - The main response type definition
+ * @see {@link HTTPValidationError} - The actual schema type definition
+ */
+export type GET_Tlds_Response_422 = HTTPValidationError
+
 /**
  * Response types for GET TldsByTld endpoint
  *

package/src/helpers/schemas.d.ts

@@ -1450,6 +1450,22 @@ export type EventResponse = components['schemas']['EventResponse'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type EventSchema = components['schemas']['EventSchema'];
+/**
+ * EventSortField
+ *
+ * @remarks
+ * Type alias for the `EventSortField` OpenAPI schema.
+ * This type represents eventsortfield data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getEventSortField();
+ * const item: EventSortField = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type EventSortField = components['schemas']['EventSortField'];
 /**
  * EventSubtype
  *

package/src/openapi.yaml

@@ -2383,6 +2383,12 @@ components:
       - source
       title: EventSchema
       type: object
+    EventSortField:
+      enum:
+      - object_id
+      - created_on
+      title: EventSortField
+      type: string
     EventSubtype:
       enum:
       - NOTIFICATION
@@ -4946,7 +4952,7 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2025-10-20-101702
+  version: 2025-10-28-111859
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -8033,9 +8039,62 @@ paths:
       - email_forward
   /v1/events:
     get:
-      description: Retrieves a paginated list of pending events for the organization
+      description: Retrieves a paginated list of events for the organization
       operationId: get_events_v1_events_get
       parameters:
+      - in: query
+        name: sort_by
+        required: false
+        schema:
+          $ref: '#/components/schemas/EventSortField'
+          default: created_on
+      - in: query
+        name: sort_order
+        required: false
+        schema:
+          $ref: '#/components/schemas/SortOrder'
+          default: desc
+      - in: query
+        name: object_type
+        required: false
+        schema:
+          anyOf:
+          - $ref: '#/components/schemas/EventObjectType'
+          - type: 'null'
+          title: Object Type
+      - in: query
+        name: object_id
+        required: false
+        schema:
+          anyOf:
+          - type: string
+          - type: 'null'
+          title: Object Id
+      - in: query
+        name: type
+        required: false
+        schema:
+          anyOf:
+          - $ref: '#/components/schemas/EventType'
+          - type: 'null'
+          title: Type
+      - in: query
+        name: subtype
+        required: false
+        schema:
+          anyOf:
+          - $ref: '#/components/schemas/EventSubtype'
+          - type: 'null'
+          title: Subtype
+      - in: query
+        name: acknowledged
+        required: false
+        schema:
+          anyOf:
+          - type: boolean
+          - type: 'null'
+          default: false
+          title: Acknowledged
       - in: query
         name: page
         required: false
@@ -9469,6 +9528,50 @@ paths:
       summary: Get a specific transaction
       tags:
       - organization
+  /v1/tlds/:
+    get:
+      description: Retrieves a list of TLD Specifications we have support for
+      operationId: get_tld_specifications_v1_tlds__get
+      parameters:
+      - in: query
+        name: fields
+        required: false
+        schema:
+          anyOf:
+          - type: string
+          - type: 'null'
+          title: Fields
+      - in: query
+        name: tlds
+        required: false
+        schema:
+          anyOf:
+          - type: string
+          - type: 'null'
+          title: Tlds
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                additionalProperties:
+                  items:
+                    type: object
+                  type: array
+                title: Response Get Tld Specifications V1 Tlds  Get
+                type: object
+          description: Successful Response
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      summary: Get list of Specifications for all TLDs we support
+      tags:
+      - tld
   /v1/tlds/portfolio:
     get:
       description: Retrieves a list of TLDs we have support for

package/src/schema.d.ts

@@ -688,7 +688,7 @@ export interface paths {
         };
         /**
          * Get pending events
-         * @description Retrieves a paginated list of pending events for the organization
+         * @description Retrieves a paginated list of events for the organization
          */
         get: operations["get_events_v1_events_get"];
         put?: never;
@@ -989,6 +989,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/tlds/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get list of Specifications for all TLDs we support
+         * @description Retrieves a list of TLD Specifications we have support for
+         */
+        get: operations["get_tld_specifications_v1_tlds__get"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/tlds/portfolio": {
         parameters: {
             query?: never;
@@ -2797,6 +2817,11 @@ export interface components {
             /** @description The type of the event - indicates the kind of operation occurring (e.g., 'ACCOUNT_CREATE', 'DOMAIN_MODIFICATION') */
             type?: components["schemas"]["EventType"] | null;
         };
+        /**
+         * EventSortField
+         * @enum {string}
+         */
+        EventSortField: "object_id" | "created_on";
         /**
          * EventSubtype
          * @enum {string}
@@ -7095,6 +7120,13 @@ export interface operations {
     get_events_v1_events_get: {
         parameters: {
             query?: {
+                sort_by?: components["schemas"]["EventSortField"];
+                sort_order?: components["schemas"]["SortOrder"];
+                object_type?: components["schemas"]["EventObjectType"] | null;
+                object_id?: string | null;
+                type?: components["schemas"]["EventType"] | null;
+                subtype?: components["schemas"]["EventSubtype"] | null;
+                acknowledged?: boolean | null;
                 page?: number;
                 page_size?: number;
             };
@@ -8482,6 +8514,40 @@ export interface operations {
             };
         };
     };
+    get_tld_specifications_v1_tlds__get: {
+        parameters: {
+            query?: {
+                fields?: string | null;
+                tlds?: string | null;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        [key: string]: Record<string, never>[];
+                    };
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
     get_tld_portfolio_v1_tlds_portfolio_get: {
         parameters: {
             query?: never;