retab 0.0.40__py3-none-any.whl → 0.0.42__py3-none-any.whl

retab/client.py

@@ -34,7 +34,7 @@ class BaseRetab:
 
     Args:
         api_key (str, optional): Retab API key. If not provided, will look for RETAB_API_KEY env variable.
-        base_url (str, optional): Base URL for API requests. Defaults to https://api.retab.dev
+        base_url (str, optional): Base URL for API requests. Defaults to https://api.retab.com
         timeout (float): Request timeout in seconds. Defaults to 240.0
         max_retries (int): Maximum number of retries for failed requests. Defaults to 3
         openai_api_key (str, optional): OpenAI API key. Will look for OPENAI_API_KEY env variable if not provided
@@ -63,12 +63,12 @@ class BaseRetab:
 
         if api_key is None:
             raise ValueError(
-                "No API key provided. You can create an API key at https://retab.dev\n"
+                "No API key provided. You can create an API key at https://retab.com\n"
                 "Then either pass it to the client (api_key='your-key') or set the RETAB_API_KEY environment variable"
             )
 
         if base_url is None:
-            base_url = os.environ.get("RETAB_API_BASE_URL", "https://api.retab.dev")
+            base_url = os.environ.get("RETAB_API_BASE_URL", "https://api.retab.com")
 
         truststore.inject_into_ssl()
         self.api_key = api_key
@@ -154,7 +154,7 @@ class Retab(BaseRetab):
 
     Args:
         api_key (str, optional): Retab API key. If not provided, will look for RETAB_API_KEY env variable.
-        base_url (str, optional): Base URL for API requests. Defaults to https://api.retab.dev
+        base_url (str, optional): Base URL for API requests. Defaults to https://api.retab.com
         timeout (float): Request timeout in seconds. Defaults to 240.0
         max_retries (int): Maximum number of retries for failed requests. Defaults to 3
         openai_api_key (str, optional): OpenAI API key. Will look for OPENAI_API_KEY env variable if not provided
@@ -422,7 +422,7 @@ class AsyncRetab(BaseRetab):
 
     Args:
         api_key (str, optional): Retab API key. If not provided, will look for RETAB_API_KEY env variable.
-        base_url (str, optional): Base URL for API requests. Defaults to https://api.retab.dev
+        base_url (str, optional): Base URL for API requests. Defaults to https://api.retab.com
         timeout (float): Request timeout in seconds. Defaults to 240.0
         max_retries (int): Maximum number of retries for failed requests. Defaults to 3
         openai_api_key (str, optional): OpenAI API key. Will look for OPENAI_API_KEY env variable if not provided

retab/resources/consensus/completions.py

@@ -5,7 +5,7 @@ from openai.types.shared_params.response_format_json_schema import ResponseForma
 from pydantic import BaseModel as ResponseFormatT
 
 from ..._resource import AsyncAPIResource, SyncAPIResource
-from ..._utils.ai_models import assert_valid_model_extraction
+from ...utils.ai_models import assert_valid_model_extraction
 from ...types.chat import ChatCompletionRetabMessage
 from ...types.completions import RetabChatCompletionsRequest
 from ...types.documents.extractions import RetabParsedChatCompletion

retab/resources/consensus/completions_stream.py

@@ -9,9 +9,9 @@ from openai.types.shared_params.response_format_json_schema import ResponseForma
 from pydantic import BaseModel as ResponseFormatT
 
 from ..._resource import AsyncAPIResource, SyncAPIResource
-from ..._utils.ai_models import assert_valid_model_extraction
-from ..._utils.json_schema import unflatten_dict
-from ..._utils.stream_context_managers import as_async_context_manager, as_context_manager
+from ...utils.ai_models import assert_valid_model_extraction
+from ...utils.json_schema import unflatten_dict
+from ...utils.stream_context_managers import as_async_context_manager, as_context_manager
 from ...types.chat import ChatCompletionRetabMessage
 from ...types.completions import RetabChatCompletionsRequest
 from ...types.documents.extractions import RetabParsedChatCompletion, RetabParsedChatCompletionChunk, RetabParsedChoice
@@ -123,7 +123,7 @@ class Completions(SyncAPIResource, BaseCompletionsMixin):
 
         Usage:
         ```python
-        with retab.devpletions.stream(json_schema, messages, model, temperature, reasoning_effort) as stream:
+        with retab.completions.stream(json_schema, messages, model, temperature, reasoning_effort) as stream:
             for response in stream:
                 print(response)
         ```
@@ -210,7 +210,7 @@ class AsyncCompletions(AsyncAPIResource, BaseCompletionsMixin):
 
         Usage:
         ```python
-        async with retab.devpletions.stream(json_schema, messages, model, temperature, reasoning_effort, n_consensus) as stream:
+        async with retab.completions.stream(json_schema, messages, model, temperature, reasoning_effort, n_consensus) as stream:
             async for response in stream:
                 print(response)
         ```

retab/resources/consensus/responses.py

@@ -7,7 +7,7 @@ from openai.types.shared_params.reasoning import Reasoning
 from pydantic import BaseModel
 
 from ..._resource import AsyncAPIResource, SyncAPIResource
-from ..._utils.ai_models import assert_valid_model_extraction
+from ...utils.ai_models import assert_valid_model_extraction
 from ...types.completions import RetabChatResponseCreateRequest
 from ...types.documents.extractions import UiResponse
 from ...types.schemas.object import Schema

retab/resources/consensus/responses_stream.py

@@ -6,8 +6,8 @@ from openai.types.shared_params.reasoning import Reasoning
 from pydantic import BaseModel
 
 from ..._resource import AsyncAPIResource, SyncAPIResource
-from ..._utils.ai_models import assert_valid_model_extraction
-from ..._utils.stream_context_managers import as_async_context_manager, as_context_manager
+from ...utils.ai_models import assert_valid_model_extraction
+from ...utils.stream_context_managers import as_async_context_manager, as_context_manager
 from ...types.completions import RetabChatResponseCreateRequest
 from ...types.documents.extractions import UiResponse
 from ...types.schemas.object import Schema

retab/resources/documents/client.py

@@ -8,15 +8,16 @@ from pydantic_core import PydanticUndefined
 from openai.types.chat.chat_completion_reasoning_effort import ChatCompletionReasoningEffort
 
 from ..._resource import AsyncAPIResource, SyncAPIResource
-from ..._utils.json_schema import load_json_schema, filter_auxiliary_fields_json
-from ..._utils.mime import convert_mime_data_to_pil_image, prepare_mime_document
-from ..._utils.ai_models import assert_valid_model_extraction
+from ...utils.json_schema import load_json_schema, filter_auxiliary_fields_json
+from ...utils.mime import convert_mime_data_to_pil_image, prepare_mime_document
+from ...utils.ai_models import assert_valid_model_extraction
 from ...types.documents.create_messages import DocumentCreateInputRequest, DocumentCreateMessageRequest, DocumentMessage
 from ...types.documents.extractions import DocumentExtractRequest, RetabParsedChatCompletion
 from ...types.documents.parse import ParseRequest, ParseResult, TableParsingFormat
 from ...types.browser_canvas import BrowserCanvas
 from ...types.mime import MIMEData
 from ...types.modalities import Modality
+from ...types.ai_models import LLMModel
 from ...types.schemas.object import Schema
 from ...types.standards import PreparedRequest
 from .extractions import AsyncExtractions, Extractions
@@ -89,7 +90,7 @@ class BaseDocumentsMixin:
     def _prepare_parse(
         self,
         document: Path | str | IOBase | MIMEData | PIL.Image.Image | HttpUrl,
-        fast_mode: bool = False,
+        model: LLMModel,
         table_parsing_format: TableParsingFormat = "html",
         image_resolution_dpi: int = 72,
         browser_canvas: BrowserCanvas = "A4",
@@ -99,7 +100,7 @@ class BaseDocumentsMixin:
 
         parse_request = ParseRequest(
             document=mime_document,
-            fast_mode=fast_mode,
+            model=model,
             table_parsing_format=table_parsing_format,
             image_resolution_dpi=image_resolution_dpi,
             browser_canvas=browser_canvas,
@@ -290,7 +291,7 @@ class Documents(SyncAPIResource, BaseDocumentsMixin):
     def parse(
         self,
         document: Path | str | IOBase | MIMEData | PIL.Image.Image | HttpUrl,
-        fast_mode: bool = False,
+        model: LLMModel,
         table_parsing_format: TableParsingFormat = "html",
         image_resolution_dpi: int = 72,
         browser_canvas: BrowserCanvas = "A4",
@@ -304,7 +305,7 @@ class Documents(SyncAPIResource, BaseDocumentsMixin):
 
         Args:
             document: The document to parse. Can be a file path (Path or str), file-like object, MIMEData, PIL Image, or URL.
-            fast_mode: Use fast mode for parsing (may reduce quality). Defaults to False.
+            model: The AI model to use for document parsing.
             table_parsing_format: Format for parsing tables. Options: "html", "json", "yaml", "markdown". Defaults to "html".
             image_resolution_dpi: DPI for image processing. Defaults to 72.
             browser_canvas: Canvas size for document rendering. Defaults to "A4".
@@ -318,7 +319,7 @@ class Documents(SyncAPIResource, BaseDocumentsMixin):
         """
         request = self._prepare_parse(
             document=document,
-            fast_mode=fast_mode,
+            model=model,
             table_parsing_format=table_parsing_format,
             image_resolution_dpi=image_resolution_dpi,
             browser_canvas=browser_canvas,
@@ -512,7 +513,7 @@ class AsyncDocuments(AsyncAPIResource, BaseDocumentsMixin):
     async def parse(
         self,
         document: Path | str | IOBase | MIMEData | PIL.Image.Image | HttpUrl,
-        fast_mode: bool = False,
+        model: LLMModel,
         table_parsing_format: TableParsingFormat = "html",
         image_resolution_dpi: int = 72,
         browser_canvas: BrowserCanvas = "A4",
@@ -526,7 +527,7 @@ class AsyncDocuments(AsyncAPIResource, BaseDocumentsMixin):
 
         Args:
             document: The document to parse. Can be a file path (Path or str), file-like object, MIMEData, PIL Image, or URL.
-            fast_mode: Use fast mode for parsing (may reduce quality). Defaults to False.
+            model: The AI model to use for document parsing.
             table_parsing_format: Format for parsing tables. Options: "html", "json", "yaml", "markdown". Defaults to "html".
             image_resolution_dpi: DPI for image processing. Defaults to 72.
             browser_canvas: Canvas size for document rendering. Defaults to "A4".
@@ -540,7 +541,7 @@ class AsyncDocuments(AsyncAPIResource, BaseDocumentsMixin):
         """
         request = self._prepare_parse(
             document=document,
-            fast_mode=fast_mode,
+            model=model,
             table_parsing_format=table_parsing_format,
             image_resolution_dpi=image_resolution_dpi,
             browser_canvas=browser_canvas,

retab/resources/documents/extractions.py

@@ -14,10 +14,10 @@ from pydantic_core import PydanticUndefined
 from pydantic import HttpUrl
 
 from ..._resource import AsyncAPIResource, SyncAPIResource
-from ..._utils.ai_models import assert_valid_model_extraction
-from ..._utils.json_schema import filter_auxiliary_fields_json, load_json_schema, unflatten_dict
-from ..._utils.mime import MIMEData, prepare_mime_document
-from ..._utils.stream_context_managers import as_async_context_manager, as_context_manager
+from ...utils.ai_models import assert_valid_model_extraction
+from ...utils.json_schema import filter_auxiliary_fields_json, load_json_schema, unflatten_dict
+from ...utils.mime import MIMEData, prepare_mime_document
+from ...utils.stream_context_managers import as_async_context_manager, as_context_manager
 from ...types.chat import ChatCompletionRetabMessage
 from ...types.documents.extractions import DocumentExtractRequest, LogExtractionRequest, RetabParsedChatCompletion, RetabParsedChatCompletionChunk, RetabParsedChoice
 from ...types.browser_canvas import BrowserCanvas

retab/resources/evals.py

@@ -7,7 +7,7 @@ from openai.types.chat.chat_completion_reasoning_effort import ChatCompletionRea
 from pydantic import HttpUrl
 
 from .._resource import AsyncAPIResource, SyncAPIResource
-from .._utils.mime import prepare_mime_document
+from ..utils.mime import prepare_mime_document
 from ..types.evals import (
     CreateIterationRequest,
     DistancesResult,

retab/resources/evaluations/documents.py

@@ -6,7 +6,7 @@ import PIL.Image
 from pydantic import HttpUrl
 
 from ..._resource import AsyncAPIResource, SyncAPIResource
-from ..._utils.mime import prepare_mime_document
+from ...utils.mime import prepare_mime_document
 from ...types.evaluations import DocumentItem, EvaluationDocument, PatchEvaluationDocumentRequest
 from ...types.mime import MIMEData
 from ...types.standards import PreparedRequest, DeleteResponse, FieldUnset

retab/resources/jsonlUtils.py

@@ -18,10 +18,10 @@ from pydantic_core import PydanticUndefined
 from tqdm import tqdm
 
 from .._resource import AsyncAPIResource, SyncAPIResource
-from .._utils.ai_models import assert_valid_model_extraction, get_provider_for_model
-from .._utils.chat import convert_to_anthropic_format, convert_to_openai_format, separate_messages
-from .._utils.display import Metrics, display_metrics, process_dataset_and_compute_metrics
-from .._utils.json_schema import load_json_schema
+from ..utils.ai_models import assert_valid_model_extraction, get_provider_for_model
+from ..utils.chat import convert_to_anthropic_format, convert_to_openai_format, separate_messages
+from ..utils.display import Metrics, display_metrics, process_dataset_and_compute_metrics
+from ..utils.json_schema import load_json_schema
 from ..types.chat import ChatCompletionRetabMessage
 from ..types.modalities import Modality
 from ..types.schemas.object import Schema

retab/resources/processors/automations/endpoints.py

@@ -3,7 +3,7 @@ from typing import Literal, Optional
 from pydantic_core import PydanticUndefined
 
 from ...._resource import AsyncAPIResource, SyncAPIResource
-from ...._utils.ai_models import assert_valid_model_extraction
+from ....utils.ai_models import assert_valid_model_extraction
 from ....types.automations.endpoints import Endpoint, ListEndpoints, UpdateEndpointRequest
 from ....types.standards import PreparedRequest
 
@@ -31,6 +31,7 @@ class EndpointsMixin:
 
     def prepare_list(
         self,
+        processor_id: str,
         before: Optional[str] = None,
         after: Optional[str] = None,
         limit: Optional[int] = 10,
@@ -40,6 +41,7 @@ class EndpointsMixin:
         webhook_url: Optional[str] = None,
     ) -> PreparedRequest:
         params = {
+            "processor_id": processor_id,
             "before": before,
             "after": after,
             "limit": limit,
@@ -120,11 +122,12 @@ class Endpoints(SyncAPIResource, EndpointsMixin):
             need_validation=need_validation,
         )
         response = self._client._prepared_request(request)
-        print(f"Endpoint Created. Url: https://www.retab.dev/dashboard/processors/automations/{response['id']}")
+        print(f"Endpoint Created. Url: https://www.retab.com/dashboard/processors/automations/{response['id']}")
         return Endpoint.model_validate(response)
 
     def list(
         self,
+        processor_id: str,
         before: Optional[str] = None,
         after: Optional[str] = None,
         limit: Optional[int] = 10,
@@ -145,7 +148,7 @@ class Endpoints(SyncAPIResource, EndpointsMixin):
         Returns:
             ListEndpoints: Paginated list of endpoint configurations with metadata
         """
-        request = self.prepare_list(before, after, limit, order, name, webhook_url)
+        request = self.prepare_list(processor_id, before, after, limit, order, name, webhook_url)
         response = self._client._prepared_request(request)
         return ListEndpoints.model_validate(response)
 
@@ -229,12 +232,13 @@ class AsyncEndpoints(AsyncAPIResource, EndpointsMixin):
             need_validation=need_validation,
         )
         response = await self._client._prepared_request(request)
-        print(f"Endpoint Created. Url: https://www.retab.dev/dashboard/processors/automations/{response['id']}")
+        print(f"Endpoint Created. Url: https://www.retab.com/dashboard/processors/automations/{response['id']}")
 
         return Endpoint.model_validate(response)
 
     async def list(
         self,
+        processor_id: str,
         before: Optional[str] = None,
         after: Optional[str] = None,
         limit: Optional[int] = 10,
@@ -242,7 +246,7 @@ class AsyncEndpoints(AsyncAPIResource, EndpointsMixin):
         name: Optional[str] = None,
         webhook_url: Optional[str] = None,
     ) -> ListEndpoints:
-        request = self.prepare_list(before, after, limit, order, name, webhook_url)
+        request = self.prepare_list(processor_id, before, after, limit, order, name, webhook_url)
         response = await self._client._prepared_request(request)
         return ListEndpoints.model_validate(response)
 

retab/resources/processors/automations/links.py

@@ -128,7 +128,7 @@ class Links(SyncAPIResource, LinksMixin):
         )
         response = self._client._prepared_request(request)
 
-        print(f"Link Created. Url: https://www.retab.dev/dashboard/processors/automations/{response['id']}")
+        print(f"Link Created. Url: https://www.retab.com/dashboard/processors/automations/{response['id']}")
         return Link.model_validate(response)
 
     def list(
@@ -248,7 +248,7 @@ class AsyncLinks(AsyncAPIResource, LinksMixin):
             password=password,
         )
         response = await self._client._prepared_request(request)
-        print(f"Link Created. Url: https://www.retab.dev/dashboard/processors/automations/{response['id']}")
+        print(f"Link Created. Url: https://www.retab.com/dashboard/processors/automations/{response['id']}")
         return Link.model_validate(response)
 
     async def list(

retab/resources/processors/automations/logs.py

@@ -147,7 +147,7 @@ class Logs(SyncAPIResource, LogsMixin):
         request = self.prepare_rerun(processor_id, log_id)
         response = self._client._prepared_request(request)
 
-        print(f"Webhook call run successfully. Log available at https://www.retab.dev/dashboard/processors/{processor_id}/logs/{log_id}")
+        print(f"Webhook call run successfully. Log available at https://www.retab.com/dashboard/processors/{processor_id}/logs/{log_id}")
 
         return ExternalRequestLog.model_validate(response)
 
@@ -217,6 +217,6 @@ class AsyncLogs(AsyncAPIResource, LogsMixin):
         request = self.prepare_rerun(processor_id, log_id)
         response = await self._client._prepared_request(request)
 
-        print(f"Webhook call run successfully. Log available at https://www.retab.dev/dashboard/processors/{processor_id}/logs/{log_id}")
+        print(f"Webhook call run successfully. Log available at https://www.retab.com/dashboard/processors/{processor_id}/logs/{log_id}")
 
         return ExternalRequestLog.model_validate(response)

retab/resources/processors/automations/mailboxes.py

@@ -6,7 +6,7 @@ from pydantic import EmailStr, HttpUrl
 from pydantic_core import PydanticUndefined
 
 from ...._resource import AsyncAPIResource, SyncAPIResource
-from ...._utils.mime import prepare_mime_document
+from ....utils.mime import prepare_mime_document
 from ....types.automations.mailboxes import ListMailboxes, Mailbox, UpdateMailboxRequest
 from ....types.mime import EmailData, MIMEData
 from ....types.standards import PreparedRequest
@@ -43,6 +43,7 @@ class MailBoxesMixin:
 
     def prepare_list(
         self,
+        processor_id: str,
         before: str | None = None,
         after: str | None = None,
         limit: int = 10,
@@ -52,6 +53,7 @@ class MailBoxesMixin:
         webhook_url: Optional[str] = None,
     ) -> PreparedRequest:
         params = {
+            "processor_id": processor_id,
             "before": before,
             "after": after,
             "limit": limit,
@@ -65,15 +67,12 @@ class MailBoxesMixin:
 
         return PreparedRequest(method="GET", url=self.mailboxes_base_url, params=params)
 
-    def prepare_get(self, email: str) -> PreparedRequest:
-        return PreparedRequest(method="GET", url=f"{self.mailboxes_base_url}/{email}")
-
-    def prepare_get_from_id(self, mailbox_id: str) -> PreparedRequest:
-        return PreparedRequest(method="GET", url=f"{self.mailboxes_base_url}/from_id/{mailbox_id}")
+    def prepare_get(self, mailbox_id: str) -> PreparedRequest:
+        return PreparedRequest(method="GET", url=f"{self.mailboxes_base_url}/{mailbox_id}")
 
     def prepare_update(
         self,
-        email: str,
+        mailbox_id: str,
         name: str = PydanticUndefined,  # type: ignore[assignment]
         default_language: str = PydanticUndefined,  # type: ignore[assignment]
         webhook_url: str = PydanticUndefined,  # type: ignore[assignment]
@@ -91,10 +90,10 @@ class MailBoxesMixin:
             authorized_domains=authorized_domains,
             authorized_emails=authorized_emails,
         )
-        return PreparedRequest(method="PUT", url=f"/v1/processors/automations/mailboxes/{email}", data=update_mailbox_request.model_dump(mode="json"))
+        return PreparedRequest(method="PUT", url=f"/v1/processors/automations/mailboxes/{mailbox_id}", data=update_mailbox_request.model_dump(mode="json"))
 
-    def prepare_delete(self, email: str) -> PreparedRequest:
-        return PreparedRequest(method="DELETE", url=f"/v1/processors/automations/mailboxes/{email}", raise_for_status=True)
+    def prepare_delete(self, mailbox_id: str) -> PreparedRequest:
+        return PreparedRequest(method="DELETE", url=f"/v1/processors/automations/mailboxes/{mailbox_id}", raise_for_status=True)
 
 
 class Mailboxes(SyncAPIResource, MailBoxesMixin):
@@ -144,12 +143,13 @@ class Mailboxes(SyncAPIResource, MailBoxesMixin):
         )
         response = self._client._prepared_request(request)
 
-        print(f"Mailbox {response['email']} created. Url: https://www.retab.dev/dashboard/processors/automations/{response['id']}")
+        print(f"Mailbox {response['email']} created. Url: https://www.retab.com/dashboard/processors/automations/{response['id']}")
 
         return Mailbox.model_validate(response)
 
     def list(
         self,
+        processor_id: str,
         before: str | None = None,
         after: str | None = None,
         limit: int = 10,
@@ -174,6 +174,7 @@ class Mailboxes(SyncAPIResource, MailBoxesMixin):
             ListMailboxes: List of mailbox configurations
         """
         request = self.prepare_list(
+            processor_id=processor_id,
             before=before,
             after=after,
             limit=limit,
@@ -185,22 +186,22 @@ class Mailboxes(SyncAPIResource, MailBoxesMixin):
         response = self._client._prepared_request(request)
         return ListMailboxes.model_validate(response)
 
-    def get(self, email: str) -> Mailbox:
+    def get(self, mailbox_id: str) -> Mailbox:
         """Get a specific email automation configuration.
 
         Args:
-            email: Email address of the mailbox
+            mailbox_id: ID of the mailbox
 
         Returns:
             Mailbox: The mailbox configuration
         """
-        request = self.prepare_get(email)
+        request = self.prepare_get(mailbox_id)
         response = self._client._prepared_request(request)
         return Mailbox.model_validate(response)
 
     def update(
         self,
-        email: str,
+        mailbox_id: str,
         name: str = PydanticUndefined,  # type: ignore[assignment]
         default_language: str = PydanticUndefined,  # type: ignore[assignment]
         webhook_url: str = PydanticUndefined,  # type: ignore[assignment]
@@ -225,7 +226,7 @@ class Mailboxes(SyncAPIResource, MailBoxesMixin):
             Mailbox: The updated mailbox configuration
         """
         request = self.prepare_update(
-            email=email,
+            mailbox_id=mailbox_id,
             name=name,
             default_language=default_language,
             webhook_url=webhook_url,
@@ -237,13 +238,13 @@ class Mailboxes(SyncAPIResource, MailBoxesMixin):
         response = self._client._prepared_request(request)
         return Mailbox.model_validate(response)
 
-    def delete(self, email: str) -> None:
+    def delete(self, mailbox_id: str) -> None:
         """Delete an email automation configuration.
 
         Args:
             email: Email address of the mailbox to delete
         """
-        request = self.prepare_delete(email)
+        request = self.prepare_delete(mailbox_id)
         self._client._prepared_request(request)
         return None
 
@@ -278,12 +279,13 @@ class AsyncMailboxes(AsyncAPIResource, MailBoxesMixin):
         )
         response = await self._client._prepared_request(request)
 
-        print(f"Mailbox {response['email']} created. Url: https://www.retab.dev/dashboard/processors/automations/{response['id']}")
+        print(f"Mailbox {response['email']} created. Url: https://www.retab.com/dashboard/processors/automations/{response['id']}")
 
         return Mailbox.model_validate(response)
 
     async def list(
         self,
+        processor_id: str,
         before: str | None = None,
         after: str | None = None,
         limit: int = 10,
@@ -292,18 +294,27 @@ class AsyncMailboxes(AsyncAPIResource, MailBoxesMixin):
         name: str | None = None,
         webhook_url: str | None = None,
     ) -> ListMailboxes:
-        request = self.prepare_list(before=before, after=after, limit=limit, order=order, email=email, name=name, webhook_url=webhook_url)
+        request = self.prepare_list(
+            processor_id=processor_id,
+            before=before,
+            after=after,
+            limit=limit,
+            order=order,
+            email=email,
+            name=name,
+            webhook_url=webhook_url,
+        )
         response = await self._client._prepared_request(request)
         return ListMailboxes.model_validate(response)
 
-    async def get(self, email: str) -> Mailbox:
-        request = self.prepare_get(email)
+    async def get(self, mailbox_id: str) -> Mailbox:
+        request = self.prepare_get(mailbox_id)
         response = await self._client._prepared_request(request)
         return Mailbox.model_validate(response)
 
     async def update(
         self,
-        email: str,
+        mailbox_id: str,
         name: str = PydanticUndefined,  # type: ignore[assignment]
         default_language: str = PydanticUndefined,  # type: ignore[assignment]
         webhook_url: str = PydanticUndefined,  # type: ignore[assignment]
@@ -313,7 +324,7 @@ class AsyncMailboxes(AsyncAPIResource, MailBoxesMixin):
         authorized_emails: List[str] = PydanticUndefined,  # type: ignore[assignment]
     ) -> Mailbox:
         request = self.prepare_update(
-            email=email,
+            mailbox_id=mailbox_id,
             name=name,
             default_language=default_language,
             webhook_url=webhook_url,
@@ -325,8 +336,8 @@ class AsyncMailboxes(AsyncAPIResource, MailBoxesMixin):
         response = await self._client._prepared_request(request)
         return Mailbox.model_validate(response)
 
-    async def delete(self, email: str) -> None:
-        request = self.prepare_delete(email)
+    async def delete(self, mailbox_id: str) -> None:
+        request = self.prepare_delete(mailbox_id)
         await self._client._prepared_request(request)
         return None
 
@@ -334,12 +345,12 @@ class AsyncMailboxes(AsyncAPIResource, MailBoxesMixin):
 class TestMailboxesMixin:
     def prepare_forward(
         self,
-        email: str,
+        mailbox_id: str,
         document: Path | str | IOBase | HttpUrl | MIMEData,
         verbose: bool = True,
     ) -> PreparedRequest:
         mime_document = prepare_mime_document(document)
-        return PreparedRequest(method="POST", url=f"/v1/processors/automations/mailboxes/tests/forward/{email}", data={"document": mime_document.model_dump()})
+        return PreparedRequest(method="POST", url=f"/v1/processors/automations/mailboxes/tests/forward/{mailbox_id}", data={"document": mime_document.model_dump()})
 
     def print_forward_verbose(self, email_data: EmailData) -> None:
         print("\nTEST EMAIL FORWARDING RESULTS:")
@@ -360,7 +371,7 @@ class TestMailboxesMixin:
 class TestMailboxes(SyncAPIResource, TestMailboxesMixin):
     def forward(
         self,
-        email: str,
+        mailbox_id: str,
         document: Path | str | IOBase | HttpUrl | MIMEData,
         verbose: bool = True,
     ) -> EmailData:
@@ -372,7 +383,7 @@ class TestMailboxes(SyncAPIResource, TestMailboxesMixin):
         Returns:
             DocumentExtractResponse: The simulated extraction response
         """
-        request = self.prepare_forward(email, document, verbose)
+        request = self.prepare_forward(mailbox_id, document, verbose)
         response = self._client._prepared_request(request)
 
         email_data = EmailData.model_validate(response)
@@ -385,11 +396,11 @@ class TestMailboxes(SyncAPIResource, TestMailboxesMixin):
 class AsyncTestMailboxes(AsyncAPIResource, TestMailboxesMixin):
     async def forward(
         self,
-        email: str,
+        mailbox_id: str,
         document: Path | str | IOBase | HttpUrl | MIMEData,
         verbose: bool = True,
     ) -> EmailData:
-        request = self.prepare_forward(email, document, verbose)
+        request = self.prepare_forward(mailbox_id, document, verbose)
         response = await self._client._prepared_request(request)
         email_data = EmailData.model_validate(response)
         if verbose: