@bugbug-io/api-schema 14.12.0 → 14.13.0

package/dist/generated/v2.d.ts

@@ -1056,6 +1056,54 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v2/testruns/{id}/inbox/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get test run inbox
+         * @description Returns the email inbox assigned to the test run (`{{testRunId}}` inbox variable) with the list of received messages.
+         */
+        get: operations["v2_testruns_inbox_retrieve"];
+        put?: never;
+        post?: never;
+        /**
+         * Clear test run inbox
+         * @description Deletes all messages received in the test run inbox.
+         */
+        delete: operations["v2_testruns_inbox_destroy"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v2/testruns/{id}/inbox/messages/{message_id}/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Retrieve test run inbox message
+         * @description Returns a single message received in the test run inbox, including its HTML body.
+         */
+        get: operations["v2_testruns_inbox_messages_retrieve"];
+        put?: never;
+        post?: never;
+        /**
+         * Delete test run inbox message
+         * @description Deletes a single message from the test run inbox.
+         */
+        delete: operations["v2_testruns_inbox_messages_destroy"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v2/tests/": {
         parameters: {
             query?: never;
@@ -5484,6 +5532,56 @@ export interface components {
             expected?: string | null;
             current?: string | null;
         };
+        InboxAddress: {
+            /** @default  */
+            name: string;
+            address?: string | null;
+        };
+        InboxMessage: {
+            /** @description Message identifier within the inbox. */
+            id: string;
+            /** @default  */
+            subject: string;
+            /** @description Date the message was received in ISO 8601 format. */
+            receivedAt?: string | null;
+            /** @default false */
+            hasAttachments: boolean;
+            /** @default false */
+            unseen: boolean;
+            from?: components["schemas"]["InboxAddress"][];
+            to?: components["schemas"]["InboxAddress"][];
+        };
+        InboxMessageDetails: {
+            /** @description Message identifier within the inbox. */
+            id: string;
+            /** @default  */
+            subject: string;
+            /** @description Date the message was received in ISO 8601 format. */
+            receivedAt?: string | null;
+            /** @default false */
+            hasAttachments: boolean;
+            /** @default false */
+            unseen: boolean;
+            /** @description First 200 characters of the plain text body. */
+            textPreview?: string | null;
+            /** @description HTML body of the message. */
+            readonly html: string | null;
+            from?: components["schemas"]["InboxAddress"][];
+            to?: components["schemas"]["InboxAddress"][];
+        };
+        TestRunInbox: {
+            /**
+             * Format: email
+             * @description Email address of the test run inbox.
+             */
+            address: string;
+            /**
+             * Format: uri
+             * @description Web URL of the test run inbox.
+             */
+            url: string;
+            messages: components["schemas"]["InboxMessage"][];
+        };
     };
     responses: never;
     parameters: never;
@@ -8217,6 +8315,201 @@ export interface operations {
             };
         };
     };
+    v2_testruns_inbox_retrieve: {
+        parameters: {
+            query?: {
+                /** @description Message body contains the value. */
+                body?: string;
+                /** @description Sender name or address contains the value. */
+                from?: string;
+                /** @description Only messages with (true) or without (false) attachments. */
+                hasAttachments?: boolean;
+                limit?: number;
+                /** @description * `-receivedAt` - -receivedAt
+                 *     * `receivedAt` - receivedAt */
+                ordering?: "-receivedAt" | "receivedAt";
+                receivedAfter?: string;
+                receivedBefore?: string;
+                /** @description Case-insensitive match in subject, sender and recipients (names and addresses). */
+                search?: string;
+                /** @description Subject contains the value. */
+                subject?: string;
+                /** @description Recipient name or address contains the value. */
+                to?: string;
+                /** @description Only unread (true) or read (false) messages. */
+                unseen?: boolean;
+            };
+            header?: never;
+            path: {
+                /** @description A UUID string identifying this test run. */
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["TestRunInbox"];
+                };
+            };
+            /** @description Authentication credentials were missing or invalid. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Resource not found. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Inbox service unavailable */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    v2_testruns_inbox_destroy: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description A UUID string identifying this test run. */
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Inbox cleared */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Authentication credentials were missing or invalid. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Resource not found. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Inbox service unavailable */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    v2_testruns_inbox_messages_retrieve: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description A UUID string identifying this test run. */
+                id: string;
+                /** @description Message identifier returned by the inbox endpoint. */
+                message_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["InboxMessageDetails"];
+                };
+            };
+            /** @description Authentication credentials were missing or invalid. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Message not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Inbox service unavailable */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    v2_testruns_inbox_messages_destroy: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description A UUID string identifying this test run. */
+                id: string;
+                /** @description Message identifier returned by the inbox endpoint. */
+                message_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Message deleted */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Authentication credentials were missing or invalid. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Message not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Inbox service unavailable */
+            503: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
     v2_tests_list: {
         parameters: {
             query?: {