ds-caselaw-marklogic-api-client 37.1.0__py3-none-any.whl → 37.3.0__py3-none-any.whl

caselawclient/factories.py

@@ -11,6 +11,7 @@ from caselawclient.models.documents import Document
 from caselawclient.models.documents.body import DocumentBody
 from caselawclient.models.identifiers import Identifier
 from caselawclient.models.identifiers.fclid import FindCaseLawIdentifier
+from caselawclient.models.identifiers.neutral_citation import NeutralCitationNumber
 from caselawclient.models.judgments import Judgment
 from caselawclient.models.press_summaries import PressSummary
 from caselawclient.responses.search_result import SearchResult, SearchResultMetadata
@@ -143,24 +144,6 @@ class SearchResultMetadataFactory(SimpleFactory):
     }
 
 
-class SearchResultFactory(SimpleFactory):
-    target_class = SearchResult
-
-    PARAMS_MAP = {
-        "uri": "d-a1b2c3",
-        "name": "Judgment v Judgement",
-        "neutral_citation": "[2025] UKSC 123",
-        "court": "Court of Testing",
-        "date": datetime.datetime(2023, 2, 3),
-        "transformation_date": datetime.datetime(2023, 2, 3, 12, 34).isoformat(),
-        "metadata": SearchResultMetadataFactory.build(),
-        "is_failure": False,
-        "matches": None,
-        "slug": "uksc/2025/1",
-        "content_hash": "ed7002b439e9ac845f22357d822bac1444730fbdb6016d3ec9432297b9ec9f73",
-    }
-
-
 class IdentifierResolutionFactory:
     @classmethod
     def build(
@@ -189,3 +172,22 @@ class IdentifierResolutionsFactory:
         if resolutions is None:
             resolutions = [IdentifierResolutionFactory.build()]
         return IdentifierResolutions(resolutions)
+
+
+class SearchResultFactory(SimpleFactory):
+    target_class = SearchResult
+
+    PARAMS_MAP = {
+        "uri": "d-a1b2c3",
+        "name": "Judgment v Judgement",
+        "neutral_citation": "[2025] UKSC 123",
+        "court": "Court of Testing",
+        "date": datetime.datetime(2023, 2, 3),
+        "transformation_date": str(datetime.datetime(2023, 2, 3, 12, 34)),
+        "metadata": SearchResultMetadataFactory.build(),
+        "is_failure": False,
+        "matches": None,
+        "slug": "uksc/2025/1",
+        "content_hash": "ed7002b439e9ac845f22357d822bac1444730fbdb6016d3ec9432297b9ec9f73",
+        "identifiers": {"id-1": NeutralCitationNumber("[2025] UKSC 123", "id-1")},
+    }

caselawclient/search_parameters.py

@@ -23,6 +23,7 @@ class SearchParameters:
     page_size: int = RESULTS_PER_PAGE
     show_unpublished: bool = False
     only_unpublished: bool = False
+    only_with_html_representation: bool = False
     collections: Optional[List[str]] = None
 
     def as_marklogic_payload(self) -> Dict[str, Any]:
@@ -44,6 +45,7 @@ class SearchParameters:
             "to": str(self.date_to or ""),
             "show_unpublished": str(self.show_unpublished).lower(),
             "only_unpublished": str(self.only_unpublished).lower(),
+            "only_with_html_representation": str(self.only_with_html_representation).lower(),
             "collections": self._marklogic_collections,
             "quoted_phrases": self._quoted_phrases,
         }

{ds_caselaw_marklogic_api_client-37.1.0.dist-info → ds_caselaw_marklogic_api_client-37.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ds-caselaw-marklogic-api-client
-Version: 37.1.0
+Version: 37.3.0
 Summary: An API client for interacting with the underlying data in Find Caselaw.
 Home-page: https://github.com/nationalarchives/ds-caselaw-custom-api-client
 Keywords: national archives,caselaw

{ds_caselaw_marklogic_api_client-37.1.0.dist-info → ds_caselaw_marklogic_api_client-37.3.0.dist-info}/RECORD

@@ -4,7 +4,7 @@ caselawclient/client_helpers/__init__.py,sha256=eucyUXwUqI72TPw-C5zLcHlMu4GtFY50
 caselawclient/client_helpers/search_helpers.py,sha256=R99HyRLeYHgsw2L3DOidEqlKLLvs6Tga5rKTuWQViig,1525
 caselawclient/content_hash.py,sha256=0cPC4OoABq0SC2wYFX9-24DodNigeOqksDxgxQH_hUA,2221
 caselawclient/errors.py,sha256=JC16fEGq_MRJX-_KFzfINCV2Cqx8o6OWOt3C16rQd84,3142
-caselawclient/factories.py,sha256=tAZQ8RfWQwdZsqc6qScXyaXV6nk5lScB3Chx8fwRRro,6949
+caselawclient/factories.py,sha256=XgrnG61hAJ-ty61DLv2qNEAo9ITuDZowZ4MRmPrf2Bg,7109
 caselawclient/identifier_resolution.py,sha256=B5I1sD7o7YjzsXMECjbKjgiGLDda5bGhejsJ-lYpTIg,2429
 caselawclient/models/__init__.py,sha256=kd23EUpvaC7aLHdgk8farqKAQEx3lf7RvNT2jEatvlg,68
 caselawclient/models/documents/__init__.py,sha256=4o6-8Iy5ZA8KEaqOt8xkpbqc7vwOzm8IoHvI8897mPk,19460
@@ -32,7 +32,7 @@ caselawclient/responses/__init__.py,sha256=2-5NJn_PXPTje_W4dHeHYaNRN6vXK4UcB9eLL
 caselawclient/responses/search_response.py,sha256=Z76Zj4VvM-EV_vdiehv2-Jfkr9HZD3SvCTlRrUB_cyE,1951
 caselawclient/responses/search_result.py,sha256=sGVIJMLXuN2A2MFPPDoOkXu3SE4wO5IcelLZj4yfWuY,9385
 caselawclient/responses/xsl/search_match.xsl,sha256=4Sv--MrwBd7J48E9aI7jlFSXGlNi4dBqgzJ3bdMJ_ZU,1018
-caselawclient/search_parameters.py,sha256=nR-UC1aWZbdXzXBrVDaHECU4Ro8Zi4JZATtgrpAVsKY,3342
+caselawclient/search_parameters.py,sha256=A-9icXdyFYLDACjUaRQF8mrnaVRlFJ9XCPtu5uZ-_Lo,3484
 caselawclient/types.py,sha256=0PsEsQzJOInpuwZ-Ydw0UpGns6jbHzlJhc-Ms28sqCU,2064
 caselawclient/xml_helpers.py,sha256=xCboRhhzezqh-VyoKBQwal5lwxv96vTMJyVFWJNN-ok,639
 caselawclient/xquery/break_judgment_checkout.xqy,sha256=rISzoBKxQKrP5ZRdCSoRqOXW8T_NDBSZRFjOXo_H3ns,220
@@ -83,7 +83,7 @@ caselawclient/xquery/validate_document.xqy,sha256=PgaDcnqCRJPIVqfmWsNlXmCLNKd21q
 caselawclient/xquery/xslt.xqy,sha256=w57wNijH3dkwHkpKeAxqjlghVflQwo8cq6jS_sm-erM,199
 caselawclient/xquery/xslt_transform.xqy,sha256=cccaFiGkCcvSfDv007UriZ3I4ak2nTLP1trRZdbOoS8,2462
 caselawclient/xquery_type_dicts.py,sha256=zuyDGTkcN6voOXCm3APXItZ-Ey6tZ2hdZummZWzjl50,6489
-ds_caselaw_marklogic_api_client-37.1.0.dist-info/LICENSE.md,sha256=fGMzyyLuQW-IAXUeDSCrRdsYW536aEWThdbpCjo6ZKg,1108
-ds_caselaw_marklogic_api_client-37.1.0.dist-info/METADATA,sha256=rwN7JhdRezJIDek5Vq-u2_C6sPf4zDQ4GXhVnezYzg8,4206
-ds_caselaw_marklogic_api_client-37.1.0.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
-ds_caselaw_marklogic_api_client-37.1.0.dist-info/RECORD,,
+ds_caselaw_marklogic_api_client-37.3.0.dist-info/LICENSE.md,sha256=fGMzyyLuQW-IAXUeDSCrRdsYW536aEWThdbpCjo6ZKg,1108
+ds_caselaw_marklogic_api_client-37.3.0.dist-info/METADATA,sha256=SBFGKzyXMVM2TbhCofHTIMGJ5O9MLDHjfh-3V4aupk4,4206
+ds_caselaw_marklogic_api_client-37.3.0.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
+ds_caselaw_marklogic_api_client-37.3.0.dist-info/RECORD,,