DOC: Align and refine API reference pt2

Author: cjdsellers

databento/common/enums.py

@@ -30,7 +30,7 @@ class FeedMode(Enum):
 
 @unique
 class Dataset(Enum):
-    """Represents a dataset."""
+    """Represents a dataset name (string identifier)."""
 
     GLBX_MDP3 = "GLBX.MDP3"
     XNAS_ITCH = "XNAS.ITCH"
@@ -65,7 +65,7 @@ class Encoding(Enum):
 
 @unique
 class Compression(Enum):
-    """Represents a data compression option."""
+    """Represents a data compression mode."""
 
     NONE = "none"
     ZSTD = "zstd"
@@ -110,7 +110,7 @@ class SType(Enum):
 
 @unique
 class RollRule(Enum):
-    """Represents a roll rule."""
+    """Represents a smart symbology roll rule."""
 
     VOLUME = 0
     OPEN_INTEREST = 1

databento/historical/api/batch.py

@@ -136,7 +136,7 @@ def timeseries_submit(
 
     def list_jobs(
         self,
-        states: Optional[str] = "queued,processing,done",
+        states: Optional[str] = "received,queued,processing,done",
         since: Optional[Union[pd.Timestamp, date, str, int]] = None,
     ) -> List[Dict[str, Any]]:
         """
@@ -147,7 +147,7 @@ def list_jobs(
 
         Parameters
         ----------
-        states : str, optional {'queued', 'processing', 'done', 'expired'}
+        states : str, optional {'received', 'queued', 'processing', 'done', 'expired'}
             The comma separated job states to include in the response. If ``None``
             will default to 'queued,processing,done' (may contain whitespace).
         since : pd.Timestamp or date or str or int, optional

tests/test_historical_batch.py

@@ -109,7 +109,7 @@ def test_batch_list_jobs_sends_expected_request(self, mocker) -> None:
         )
         assert call["headers"] == {"accept": "application/json"}
         assert call["params"] == [
-            ("states", "queued,processing,done"),
+            ("states", "received,queued,processing,done"),
             ("since", "2022-01-01T00:00:00"),
         ]
         assert call["timeout"] == (100, 100)