feat(metadata): add general server payload maximum to secret scan preferences

Author: fnareoh

pygitguardian/client.py

@@ -584,7 +584,9 @@ def read_metadata(self) -> Optional[Detail]:
             result.status_code = resp.status_code
             return result
         metadata = ServerMetadata.from_dict(resp.json())
-
+        metadata.secret_scan_preferences.general__maximum_payload_size = (
+            metadata.preferences["general__maximum_payload_size"]
+        )
         self.secret_scan_preferences = metadata.secret_scan_preferences
         return None
 

pygitguardian/config.py

@@ -4,3 +4,4 @@
 
 MULTI_DOCUMENT_LIMIT = 20
 DOCUMENT_SIZE_THRESHOLD_BYTES = 1048576  # 1MB
+GENERAL_MAXIMUM_PAYLOAD = 2621440  # 2.5MB

pygitguardian/models.py

@@ -16,7 +16,11 @@
 )
 from typing_extensions import Self
 
-from .config import DOCUMENT_SIZE_THRESHOLD_BYTES, MULTI_DOCUMENT_LIMIT
+from .config import (
+    DOCUMENT_SIZE_THRESHOLD_BYTES,
+    GENERAL_MAXIMUM_PAYLOAD,
+    MULTI_DOCUMENT_LIMIT,
+)
 
 
 class ToDictMixin:
@@ -658,6 +662,7 @@ def __repr__(self) -> str:
 class SecretScanPreferences:
     maximum_document_size: int = DOCUMENT_SIZE_THRESHOLD_BYTES
     maximum_documents_per_scan: int = MULTI_DOCUMENT_LIMIT
+    general__maximum_payload_size: int = GENERAL_MAXIMUM_PAYLOAD
 
 
 @dataclass