@opusdns/api 0.113.0 → 0.115.0

package/src/openapi.yaml

@@ -2546,6 +2546,150 @@ components:
       - hostname
       title: EmailForwardCreate
       type: object
+    EmailForwardLog:
+      properties:
+        created_on:
+          description: Timestamp when email was received by ImprovMX
+          format: date-time
+          title: Created On
+          type: string
+        domain:
+          description: Domain name
+          title: Domain
+          type: string
+        events:
+          description: List of processing events
+          items:
+            $ref: '#/components/schemas/EmailForwardLogEvent'
+          title: Events
+          type: array
+        final_status:
+          description: Final status of the email (QUEUED, DELIVERED, REFUSED, SOFT-BOUNCE,
+            HARD-BOUNCE)
+          title: Final Status
+          type: string
+        forward_email:
+          description: Forward destination email address
+          title: Forward Email
+          type: string
+        forward_name:
+          anyOf:
+          - type: string
+          - type: 'null'
+          description: Forward destination name
+          title: Forward Name
+        hostname:
+          description: Hostname that received the email
+          title: Hostname
+          type: string
+        log_id:
+          description: Unique ID of the log from ImprovMX
+          title: Log Id
+          type: string
+        message_id:
+          description: Email message ID
+          title: Message Id
+          type: string
+        recipient_email:
+          description: Recipient email address (the alias)
+          title: Recipient Email
+          type: string
+        recipient_name:
+          anyOf:
+          - type: string
+          - type: 'null'
+          description: Recipient name
+          title: Recipient Name
+        sender_email:
+          description: Sender email address
+          title: Sender Email
+          type: string
+        sender_name:
+          anyOf:
+          - type: string
+          - type: 'null'
+          description: Sender name
+          title: Sender Name
+        subject:
+          description: Email subject
+          title: Subject
+          type: string
+        synced_on:
+          description: Timestamp when record was synced to ClickHouse
+          format: date-time
+          title: Synced On
+          type: string
+        transport:
+          description: Transport method (mx or smtp)
+          title: Transport
+          type: string
+      required:
+      - log_id
+      - domain
+      - sender_email
+      - recipient_email
+      - forward_email
+      - subject
+      - hostname
+      - message_id
+      - transport
+      - final_status
+      - created_on
+      - synced_on
+      title: EmailForwardLog
+      type: object
+    EmailForwardLogEvent:
+      properties:
+        code:
+          description: Event status code
+          title: Code
+          type: integer
+        created:
+          description: Timestamp when the event occurred
+          format: date-time
+          title: Created
+          type: string
+        id:
+          description: Event ID
+          title: Id
+          type: string
+        local:
+          description: ImprovMX server that processed the event
+          title: Local
+          type: string
+        message:
+          description: Event message
+          title: Message
+          type: string
+        server:
+          description: Server that processed the event
+          title: Server
+          type: string
+        status:
+          description: Event status (QUEUED, DELIVERED, REFUSED, SOFT-BOUNCE, HARD-BOUNCE)
+          title: Status
+          type: string
+      required:
+      - code
+      - created
+      - id
+      - local
+      - message
+      - server
+      - status
+      title: EmailForwardLogEvent
+      type: object
+    EmailForwardLogSortField:
+      enum:
+      - log_id
+      - sender_email
+      - recipient_email
+      - forward_email
+      - final_status
+      - created_on
+      - synced_on
+      title: EmailForwardLogSortField
+      type: string
     EmailForwardResponse:
       properties:
         aliases:
@@ -4177,6 +4321,20 @@ components:
       - pagination
       title: Pagination[DomainResponse]
       type: object
+    Pagination_EmailForwardLog_:
+      properties:
+        pagination:
+          $ref: '#/components/schemas/PaginationMetadata'
+        results:
+          items:
+            $ref: '#/components/schemas/EmailForwardLog'
+          title: Results
+          type: array
+      required:
+      - results
+      - pagination
+      title: Pagination[EmailForwardLog]
+      type: object
     Pagination_EmailForwardResponse_:
       properties:
         pagination:
@@ -5763,12 +5921,193 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2025-12-05-091638
+  version: 2025-12-08-100654
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
 openapi: 3.1.0
 paths:
+  /v1/archive/email-forward-logs/alias/{email_forward_alias_id}:
+    get:
+      description: Retrieves a paginated list of email forward logs for a specific
+        email forward alias. Only returns logs created after the email forward was
+        created.
+      operationId: get_email_forward_logs_by_alias_v1_archive_email_forward_logs_alias__email_forward_alias_id__get
+      parameters:
+      - in: path
+        name: email_forward_alias_id
+        required: true
+        schema:
+          examples:
+          - email_forward_alias_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^email_forward_alias_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Email Forward Alias Id
+          type: string
+          x-typeid-prefix: email_forward_alias
+      - in: query
+        name: sort_by
+        required: false
+        schema:
+          $ref: '#/components/schemas/EmailForwardLogSortField'
+          default: created_on
+      - in: query
+        name: sort_order
+        required: false
+        schema:
+          $ref: '#/components/schemas/SortOrder'
+          default: desc
+      - in: query
+        name: page_size
+        required: false
+        schema:
+          default: 10
+          maximum: 1000
+          minimum: 1
+          title: Page Size
+          type: integer
+      - in: query
+        name: page
+        required: false
+        schema:
+          default: 1
+          minimum: 1
+          title: Page
+          type: integer
+      - in: query
+        name: final_status
+        required: false
+        schema:
+          anyOf:
+          - type: string
+          - type: 'null'
+          title: Final Status
+      - in: query
+        name: start_time
+        required: false
+        schema:
+          anyOf:
+          - format: date-time
+            type: string
+          - type: 'null'
+          title: Start Time
+      - in: query
+        name: end_time
+        required: false
+        schema:
+          anyOf:
+          - format: date-time
+            type: string
+          - type: 'null'
+          title: End Time
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Pagination_EmailForwardLog_'
+          description: Successful Response
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      summary: Retrieve email forward logs by alias
+      tags:
+      - archive
+  /v1/archive/email-forward-logs/{email_forward_id}:
+    get:
+      description: Retrieves a paginated list of email forward logs for a specific
+        email forward. Only returns logs created after the email forward was created.
+      operationId: get_email_forward_logs_v1_archive_email_forward_logs__email_forward_id__get
+      parameters:
+      - in: path
+        name: email_forward_id
+        required: true
+        schema:
+          examples:
+          - email_forward_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^email_forward_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Email Forward Id
+          type: string
+          x-typeid-prefix: email_forward
+      - in: query
+        name: sort_by
+        required: false
+        schema:
+          $ref: '#/components/schemas/EmailForwardLogSortField'
+          default: created_on
+      - in: query
+        name: sort_order
+        required: false
+        schema:
+          $ref: '#/components/schemas/SortOrder'
+          default: desc
+      - in: query
+        name: page_size
+        required: false
+        schema:
+          default: 10
+          maximum: 1000
+          minimum: 1
+          title: Page Size
+          type: integer
+      - in: query
+        name: page
+        required: false
+        schema:
+          default: 1
+          minimum: 1
+          title: Page
+          type: integer
+      - in: query
+        name: final_status
+        required: false
+        schema:
+          anyOf:
+          - type: string
+          - type: 'null'
+          title: Final Status
+      - in: query
+        name: start_time
+        required: false
+        schema:
+          anyOf:
+          - format: date-time
+            type: string
+          - type: 'null'
+          title: Start Time
+      - in: query
+        name: end_time
+        required: false
+        schema:
+          anyOf:
+          - format: date-time
+            type: string
+          - type: 'null'
+          title: End Time
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Pagination_EmailForwardLog_'
+          description: Successful Response
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      summary: Retrieve email forward logs
+      tags:
+      - archive
   /v1/archive/object-logs:
     get:
       description: Retrieve all paginated audit logs with optional filtering and sorting
@@ -13134,6 +13473,12 @@ tags:
     '
   name: availability
   x-displayName: Availability
+- description: 'Endpoints for submitting and tracking batch command execution (internal
+    preview).
+
+    '
+  name: jobs
+  x-displayName: Jobs
 - description: 'Endpoints for creating and managing contacts.
 
     '

package/src/schema.d.ts

@@ -1,5 +1,45 @@
 import { TypeId } from "typeid-js";
 export interface paths {
+    "/v1/archive/email-forward-logs/alias/{email_forward_alias_id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Retrieve email forward logs by alias
+         * @description Retrieves a paginated list of email forward logs for a specific email forward alias. Only returns logs created after the email forward was created.
+         */
+        get: operations["get_email_forward_logs_by_alias_v1_archive_email_forward_logs_alias__email_forward_alias_id__get"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/archive/email-forward-logs/{email_forward_id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Retrieve email forward logs
+         * @description Retrieves a paginated list of email forward logs for a specific email forward. Only returns logs created after the email forward was created.
+         */
+        get: operations["get_email_forward_logs_v1_archive_email_forward_logs__email_forward_id__get"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/archive/object-logs": {
         parameters: {
             query?: never;
@@ -3243,6 +3283,135 @@ export interface components {
             /** Hostname */
             hostname: string;
         };
+        /** EmailForwardLog */
+        EmailForwardLog: {
+            /**
+             * Created On
+             * Format: date-time
+             * @description Timestamp when email was received by ImprovMX
+             */
+            created_on: Date;
+            /**
+             * Domain
+             * @description Domain name
+             */
+            domain: string;
+            /**
+             * Events
+             * @description List of processing events
+             */
+            events?: components["schemas"]["EmailForwardLogEvent"][];
+            /**
+             * Final Status
+             * @description Final status of the email (QUEUED, DELIVERED, REFUSED, SOFT-BOUNCE, HARD-BOUNCE)
+             */
+            final_status: string;
+            /**
+             * Forward Email
+             * @description Forward destination email address
+             */
+            forward_email: string;
+            /**
+             * Forward Name
+             * @description Forward destination name
+             */
+            forward_name?: string | null;
+            /**
+             * Hostname
+             * @description Hostname that received the email
+             */
+            hostname: string;
+            /**
+             * Log Id
+             * @description Unique ID of the log from ImprovMX
+             */
+            log_id: string;
+            /**
+             * Message Id
+             * @description Email message ID
+             */
+            message_id: string;
+            /**
+             * Recipient Email
+             * @description Recipient email address (the alias)
+             */
+            recipient_email: string;
+            /**
+             * Recipient Name
+             * @description Recipient name
+             */
+            recipient_name?: string | null;
+            /**
+             * Sender Email
+             * @description Sender email address
+             */
+            sender_email: string;
+            /**
+             * Sender Name
+             * @description Sender name
+             */
+            sender_name?: string | null;
+            /**
+             * Subject
+             * @description Email subject
+             */
+            subject: string;
+            /**
+             * Synced On
+             * Format: date-time
+             * @description Timestamp when record was synced to ClickHouse
+             */
+            synced_on: Date;
+            /**
+             * Transport
+             * @description Transport method (mx or smtp)
+             */
+            transport: string;
+        };
+        /** EmailForwardLogEvent */
+        EmailForwardLogEvent: {
+            /**
+             * Code
+             * @description Event status code
+             */
+            code: number;
+            /**
+             * Created
+             * Format: date-time
+             * @description Timestamp when the event occurred
+             */
+            created: Date;
+            /**
+             * Id
+             * @description Event ID
+             */
+            id: string;
+            /**
+             * Local
+             * @description ImprovMX server that processed the event
+             */
+            local: string;
+            /**
+             * Message
+             * @description Event message
+             */
+            message: string;
+            /**
+             * Server
+             * @description Server that processed the event
+             */
+            server: string;
+            /**
+             * Status
+             * @description Event status (QUEUED, DELIVERED, REFUSED, SOFT-BOUNCE, HARD-BOUNCE)
+             */
+            status: string;
+        };
+        /**
+         * EmailForwardLogSortField
+         * @enum {string}
+         */
+        EmailForwardLogSortField: "log_id" | "sender_email" | "recipient_email" | "forward_email" | "final_status" | "created_on" | "synced_on";
         /** EmailForwardResponse */
         EmailForwardResponse: {
             /** Aliases */
@@ -4314,6 +4483,12 @@ export interface components {
             /** Results */
             results: components["schemas"]["DomainResponse"][];
         };
+        /** Pagination[EmailForwardLog] */
+        Pagination_EmailForwardLog_: {
+            pagination: components["schemas"]["PaginationMetadata"];
+            /** Results */
+            results: components["schemas"]["EmailForwardLog"][];
+        };
         /** Pagination[EmailForwardResponse] */
         Pagination_EmailForwardResponse_: {
             pagination: components["schemas"]["PaginationMetadata"];
@@ -5311,6 +5486,84 @@ export interface components {
 }
 export type $defs = Record<string, never>;
 export interface operations {
+    get_email_forward_logs_by_alias_v1_archive_email_forward_logs_alias__email_forward_alias_id__get: {
+        parameters: {
+            query?: {
+                sort_by?: components["schemas"]["EmailForwardLogSortField"];
+                sort_order?: components["schemas"]["SortOrder"];
+                page_size?: number;
+                page?: number;
+                final_status?: string | null;
+                start_time?: Date | null;
+                end_time?: Date | null;
+            };
+            header?: never;
+            path: {
+                email_forward_alias_id: TypeId<"email_forward_alias">;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Pagination_EmailForwardLog_"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
+    get_email_forward_logs_v1_archive_email_forward_logs__email_forward_id__get: {
+        parameters: {
+            query?: {
+                sort_by?: components["schemas"]["EmailForwardLogSortField"];
+                sort_order?: components["schemas"]["SortOrder"];
+                page_size?: number;
+                page?: number;
+                final_status?: string | null;
+                start_time?: Date | null;
+                end_time?: Date | null;
+            };
+            header?: never;
+            path: {
+                email_forward_id: TypeId<"email_forward">;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Pagination_EmailForwardLog_"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
     get_object_logs_v1_archive_object_logs_get: {
         parameters: {
             query?: {