caselawclient.xquery_type_dicts

These classes are automatically generated using the script/build_xquery_type_dicts script, as part of pre-commit checks. They are used to enforce appropriately typed variables being passed in to MarkLogic XQuery functions.

  1# This file is built automatically with script/build_xquery_type_dicts.
  2# DO NOT CHANGE IT MANUALLY!
  3
  4"""
  5These classes are automatically generated using the `script/build_xquery_type_dicts` script, as part of pre-commit
  6checks. They are used to enforce appropriately typed variables being passed in to MarkLogic XQuery functions.
  7"""
  8
  9from typing import Any, NewType, Optional, TypedDict
 10from caselawclient.types import DocumentURIString, DocumentIdentifierSlug, DocumentIdentifierValue
 11from caselawclient.types import MarkLogicDocumentURIString as MarkLogicDocumentURIString
 12
 13MarkLogicDocumentVersionURIString = NewType("MarkLogicDocumentVersionURIString", MarkLogicDocumentURIString)
 14
 15MarkLogicPrivilegeURIString = NewType("MarkLogicPrivilegeURIString", str)
 16
 17class MarkLogicAPIDict(TypedDict):
 18    pass
 19
 20
 21# break_judgment_checkout.xqy
 22class BreakJudgmentCheckoutDict(MarkLogicAPIDict):
 23    uri: MarkLogicDocumentURIString
 24
 25
 26# check_content_hash_unique_by_uri.xqy
 27class CheckContentHashUniqueByUriDict(MarkLogicAPIDict):
 28    uri: MarkLogicDocumentURIString
 29
 30
 31# checkin_judgment.xqy
 32class CheckinJudgmentDict(MarkLogicAPIDict):
 33    uri: MarkLogicDocumentURIString
 34
 35
 36# checkout_judgment.xqy
 37class CheckoutJudgmentDict(MarkLogicAPIDict):
 38    annotation: str
 39    timeout: int
 40    uri: MarkLogicDocumentURIString
 41
 42
 43# copy_document.xqy
 44class CopyDocumentDict(MarkLogicAPIDict):
 45    new_uri: MarkLogicDocumentURIString
 46    old_uri: MarkLogicDocumentURIString
 47
 48
 49# delete_judgment.xqy
 50class DeleteJudgmentDict(MarkLogicAPIDict):
 51    uri: MarkLogicDocumentURIString
 52
 53
 54# document_collections.xqy
 55class DocumentCollectionsDict(MarkLogicAPIDict):
 56    uri: MarkLogicDocumentURIString
 57
 58
 59# document_exists.xqy
 60class DocumentExistsDict(MarkLogicAPIDict):
 61    uri: MarkLogicDocumentURIString
 62
 63
 64# get_components_for_document.xqy
 65class GetComponentsForDocumentDict(MarkLogicAPIDict):
 66    component: str
 67    parent_uri: DocumentURIString
 68
 69
 70# get_judgment.xqy
 71class GetJudgmentDict(MarkLogicAPIDict):
 72    search_query: Optional[str]
 73    show_unpublished: Optional[bool]
 74    uri: MarkLogicDocumentURIString
 75    version_uri: Optional[MarkLogicDocumentVersionURIString]
 76
 77
 78# get_judgment_checkout_status.xqy
 79class GetJudgmentCheckoutStatusDict(MarkLogicAPIDict):
 80    uri: MarkLogicDocumentURIString
 81
 82
 83# get_judgment_version.xqy
 84class GetJudgmentVersionDict(MarkLogicAPIDict):
 85    uri: MarkLogicDocumentURIString
 86    version: str
 87
 88
 89# get_last_modified.xqy
 90class GetLastModifiedDict(MarkLogicAPIDict):
 91    uri: MarkLogicDocumentURIString
 92
 93
 94# get_missing_fclid.xqy
 95class GetMissingFclidDict(MarkLogicAPIDict):
 96    maximum_records: Optional[int]
 97
 98
 99# get_pending_enrichment_for_version.xqy
100class GetPendingEnrichmentForVersionDict(MarkLogicAPIDict):
101    maximum_records: Optional[int]
102    target_enrichment_major_version: int
103    target_enrichment_minor_version: int
104    target_parser_major_version: int
105    target_parser_minor_version: int
106
107
108# get_pending_parse_for_version_count.xqy
109class GetPendingParseForVersionCountDict(MarkLogicAPIDict):
110    target_major_version: int
111    target_minor_version: int
112
113
114# get_pending_parse_for_version_documents.xqy
115class GetPendingParseForVersionDocumentsDict(MarkLogicAPIDict):
116    maximum_records: Optional[int]
117    target_major_version: int
118    target_minor_version: int
119
120
121# get_properties_for_search_results.xqy
122class GetPropertiesForSearchResultsDict(MarkLogicAPIDict):
123    uris: list[Any]
124
125
126# get_property.xqy
127class GetPropertyDict(MarkLogicAPIDict):
128    name: str
129    uri: MarkLogicDocumentURIString
130
131
132# get_property_as_node.xqy
133class GetPropertyAsNodeDict(MarkLogicAPIDict):
134    name: str
135    uri: MarkLogicDocumentURIString
136
137
138# get_version_annotation.xqy
139class GetVersionAnnotationDict(MarkLogicAPIDict):
140    uri: MarkLogicDocumentURIString
141
142
143# get_version_created.xqy
144class GetVersionCreatedDict(MarkLogicAPIDict):
145    uri: MarkLogicDocumentURIString
146
147
148# insert_document.xqy
149class InsertDocumentDict(MarkLogicAPIDict):
150    annotation: str
151    document: str
152    type_collection: str
153    uri: MarkLogicDocumentURIString
154
155
156# list_judgment_versions.xqy
157class ListJudgmentVersionsDict(MarkLogicAPIDict):
158    uri: MarkLogicDocumentURIString
159
160
161# resolve_from_identifier_slug.xqy
162class ResolveFromIdentifierSlugDict(MarkLogicAPIDict):
163    identifier_slug: DocumentIdentifierSlug
164    published_only: Optional[int]
165
166
167# resolve_from_identifier_value.xqy
168class ResolveFromIdentifierValueDict(MarkLogicAPIDict):
169    identifier_value: DocumentIdentifierValue
170    published_only: Optional[int]
171
172
173# set_boolean_property.xqy
174class SetBooleanPropertyDict(MarkLogicAPIDict):
175    name: str
176    uri: MarkLogicDocumentURIString
177    value: str
178
179
180# set_datetime_property.xqy
181class SetDatetimePropertyDict(MarkLogicAPIDict):
182    name: str
183    uri: MarkLogicDocumentURIString
184    value: str
185
186
187# set_metadata_citation.xqy
188class SetMetadataCitationDict(MarkLogicAPIDict):
189    content: str
190    uri: MarkLogicDocumentURIString
191
192
193# set_metadata_court.xqy
194class SetMetadataCourtDict(MarkLogicAPIDict):
195    content: str
196    uri: MarkLogicDocumentURIString
197
198
199# set_metadata_jurisdiction.xqy
200class SetMetadataJurisdictionDict(MarkLogicAPIDict):
201    content: str
202    uri: MarkLogicDocumentURIString
203
204
205# set_metadata_name.xqy
206class SetMetadataNameDict(MarkLogicAPIDict):
207    content: str
208    uri: MarkLogicDocumentURIString
209
210
211# set_metadata_this_uri.xqy
212class SetMetadataThisUriDict(MarkLogicAPIDict):
213    content_with_id: str
214    content_with_xml: str
215    content_without_id: str
216    uri: MarkLogicDocumentURIString
217
218
219# set_metadata_work_expression_date.xqy
220class SetMetadataWorkExpressionDateDict(MarkLogicAPIDict):
221    content: str
222    uri: MarkLogicDocumentURIString
223
224
225# set_property.xqy
226class SetPropertyDict(MarkLogicAPIDict):
227    name: str
228    uri: MarkLogicDocumentURIString
229    value: str
230
231
232# set_property_as_node.xqy
233class SetPropertyAsNodeDict(MarkLogicAPIDict):
234    name: str
235    uri: MarkLogicDocumentURIString
236    value: str
237
238
239# update_document.xqy
240class UpdateDocumentDict(MarkLogicAPIDict):
241    annotation: str
242    judgment: str
243    uri: MarkLogicDocumentURIString
244
245
246# update_locked_judgment.xqy
247class UpdateLockedJudgmentDict(MarkLogicAPIDict):
248    annotation: str
249    judgment: str
250    uri: MarkLogicDocumentURIString
251
252
253# user_has_privilege.xqy
254class UserHasPrivilegeDict(MarkLogicAPIDict):
255    privilege_action: str
256    privilege_uri: MarkLogicPrivilegeURIString
257    user: str
258
259
260# user_has_role.xqy
261class UserHasRoleDict(MarkLogicAPIDict):
262    role: str
263    user: str
264
265
266# validate_document.xqy
267class ValidateDocumentDict(MarkLogicAPIDict):
268    uri: MarkLogicDocumentURIString
269
270
271# xslt.xqy
272class XsltDict(MarkLogicAPIDict):
273    uri: MarkLogicDocumentURIString
274
275
276# xslt_transform.xqy
277class XsltTransformDict(MarkLogicAPIDict):
278    img_location: Optional[str]
279    query: Optional[str]
280    show_unpublished: Optional[bool]
281    uri: MarkLogicDocumentURIString
282    version_uri: Optional[MarkLogicDocumentVersionURIString]
283    xsl_filename: Optional[str]
MarkLogicDocumentVersionURIString = MarkLogicDocumentVersionURIString
MarkLogicPrivilegeURIString = MarkLogicPrivilegeURIString
class MarkLogicAPIDict(typing.TypedDict): 
18class MarkLogicAPIDict(TypedDict):
19    pass
class BreakJudgmentCheckoutDict(MarkLogicAPIDict): 
23class BreakJudgmentCheckoutDict(MarkLogicAPIDict):
24    uri: MarkLogicDocumentURIString
class CheckContentHashUniqueByUriDict(MarkLogicAPIDict): 
28class CheckContentHashUniqueByUriDict(MarkLogicAPIDict):
29    uri: MarkLogicDocumentURIString
class CheckinJudgmentDict(MarkLogicAPIDict): 
33class CheckinJudgmentDict(MarkLogicAPIDict):
34    uri: MarkLogicDocumentURIString
class CheckoutJudgmentDict(MarkLogicAPIDict): 
38class CheckoutJudgmentDict(MarkLogicAPIDict):
39    annotation: str
40    timeout: int
41    uri: MarkLogicDocumentURIString
annotation: str
timeout: int
class CopyDocumentDict(MarkLogicAPIDict): 
45class CopyDocumentDict(MarkLogicAPIDict):
46    new_uri: MarkLogicDocumentURIString
47    old_uri: MarkLogicDocumentURIString
class DeleteJudgmentDict(MarkLogicAPIDict): 
51class DeleteJudgmentDict(MarkLogicAPIDict):
52    uri: MarkLogicDocumentURIString
class DocumentCollectionsDict(MarkLogicAPIDict): 
56class DocumentCollectionsDict(MarkLogicAPIDict):
57    uri: MarkLogicDocumentURIString
class DocumentExistsDict(MarkLogicAPIDict): 
61class DocumentExistsDict(MarkLogicAPIDict):
62    uri: MarkLogicDocumentURIString
class GetComponentsForDocumentDict(MarkLogicAPIDict): 
66class GetComponentsForDocumentDict(MarkLogicAPIDict):
67    component: str
68    parent_uri: DocumentURIString
component: str
class GetJudgmentDict(MarkLogicAPIDict): 
72class GetJudgmentDict(MarkLogicAPIDict):
73    search_query: Optional[str]
74    show_unpublished: Optional[bool]
75    uri: MarkLogicDocumentURIString
76    version_uri: Optional[MarkLogicDocumentVersionURIString]
search_query: Optional[str]
show_unpublished: Optional[bool]
version_uri: Optional[MarkLogicDocumentVersionURIString]
class GetJudgmentCheckoutStatusDict(MarkLogicAPIDict): 
80class GetJudgmentCheckoutStatusDict(MarkLogicAPIDict):
81    uri: MarkLogicDocumentURIString
class GetJudgmentVersionDict(MarkLogicAPIDict): 
85class GetJudgmentVersionDict(MarkLogicAPIDict):
86    uri: MarkLogicDocumentURIString
87    version: str
version: str
class GetLastModifiedDict(MarkLogicAPIDict): 
91class GetLastModifiedDict(MarkLogicAPIDict):
92    uri: MarkLogicDocumentURIString
class GetMissingFclidDict(MarkLogicAPIDict): 
96class GetMissingFclidDict(MarkLogicAPIDict):
97    maximum_records: Optional[int]
maximum_records: Optional[int]
class GetPendingEnrichmentForVersionDict(MarkLogicAPIDict): 
101class GetPendingEnrichmentForVersionDict(MarkLogicAPIDict):
102    maximum_records: Optional[int]
103    target_enrichment_major_version: int
104    target_enrichment_minor_version: int
105    target_parser_major_version: int
106    target_parser_minor_version: int
maximum_records: Optional[int]
target_enrichment_major_version: int
target_enrichment_minor_version: int
target_parser_major_version: int
target_parser_minor_version: int
class GetPendingParseForVersionCountDict(MarkLogicAPIDict): 
110class GetPendingParseForVersionCountDict(MarkLogicAPIDict):
111    target_major_version: int
112    target_minor_version: int
target_major_version: int
target_minor_version: int
class GetPendingParseForVersionDocumentsDict(MarkLogicAPIDict): 
116class GetPendingParseForVersionDocumentsDict(MarkLogicAPIDict):
117    maximum_records: Optional[int]
118    target_major_version: int
119    target_minor_version: int
maximum_records: Optional[int]
target_major_version: int
target_minor_version: int
class GetPropertiesForSearchResultsDict(MarkLogicAPIDict): 
123class GetPropertiesForSearchResultsDict(MarkLogicAPIDict):
124    uris: list[Any]
uris: list[typing.Any]
class GetPropertyDict(MarkLogicAPIDict): 
128class GetPropertyDict(MarkLogicAPIDict):
129    name: str
130    uri: MarkLogicDocumentURIString
name: str
class GetPropertyAsNodeDict(MarkLogicAPIDict): 
134class GetPropertyAsNodeDict(MarkLogicAPIDict):
135    name: str
136    uri: MarkLogicDocumentURIString
name: str
class GetVersionAnnotationDict(MarkLogicAPIDict): 
140class GetVersionAnnotationDict(MarkLogicAPIDict):
141    uri: MarkLogicDocumentURIString
class GetVersionCreatedDict(MarkLogicAPIDict): 
145class GetVersionCreatedDict(MarkLogicAPIDict):
146    uri: MarkLogicDocumentURIString
class InsertDocumentDict(MarkLogicAPIDict): 
150class InsertDocumentDict(MarkLogicAPIDict):
151    annotation: str
152    document: str
153    type_collection: str
154    uri: MarkLogicDocumentURIString
annotation: str
document: str
type_collection: str
class ListJudgmentVersionsDict(MarkLogicAPIDict): 
158class ListJudgmentVersionsDict(MarkLogicAPIDict):
159    uri: MarkLogicDocumentURIString
class ResolveFromIdentifierSlugDict(MarkLogicAPIDict): 
163class ResolveFromIdentifierSlugDict(MarkLogicAPIDict):
164    identifier_slug: DocumentIdentifierSlug
165    published_only: Optional[int]
published_only: Optional[int]
class ResolveFromIdentifierValueDict(MarkLogicAPIDict): 
169class ResolveFromIdentifierValueDict(MarkLogicAPIDict):
170    identifier_value: DocumentIdentifierValue
171    published_only: Optional[int]
published_only: Optional[int]
class SetBooleanPropertyDict(MarkLogicAPIDict): 
175class SetBooleanPropertyDict(MarkLogicAPIDict):
176    name: str
177    uri: MarkLogicDocumentURIString
178    value: str
name: str
value: str
class SetDatetimePropertyDict(MarkLogicAPIDict): 
182class SetDatetimePropertyDict(MarkLogicAPIDict):
183    name: str
184    uri: MarkLogicDocumentURIString
185    value: str
name: str
value: str
class SetMetadataCitationDict(MarkLogicAPIDict): 
189class SetMetadataCitationDict(MarkLogicAPIDict):
190    content: str
191    uri: MarkLogicDocumentURIString
content: str
class SetMetadataCourtDict(MarkLogicAPIDict): 
195class SetMetadataCourtDict(MarkLogicAPIDict):
196    content: str
197    uri: MarkLogicDocumentURIString
content: str
class SetMetadataJurisdictionDict(MarkLogicAPIDict): 
201class SetMetadataJurisdictionDict(MarkLogicAPIDict):
202    content: str
203    uri: MarkLogicDocumentURIString
content: str
class SetMetadataNameDict(MarkLogicAPIDict): 
207class SetMetadataNameDict(MarkLogicAPIDict):
208    content: str
209    uri: MarkLogicDocumentURIString
content: str
class SetMetadataThisUriDict(MarkLogicAPIDict): 
213class SetMetadataThisUriDict(MarkLogicAPIDict):
214    content_with_id: str
215    content_with_xml: str
216    content_without_id: str
217    uri: MarkLogicDocumentURIString
content_with_id: str
content_with_xml: str
content_without_id: str
class SetMetadataWorkExpressionDateDict(MarkLogicAPIDict): 
221class SetMetadataWorkExpressionDateDict(MarkLogicAPIDict):
222    content: str
223    uri: MarkLogicDocumentURIString
content: str
class SetPropertyDict(MarkLogicAPIDict): 
227class SetPropertyDict(MarkLogicAPIDict):
228    name: str
229    uri: MarkLogicDocumentURIString
230    value: str
name: str
value: str
class SetPropertyAsNodeDict(MarkLogicAPIDict): 
234class SetPropertyAsNodeDict(MarkLogicAPIDict):
235    name: str
236    uri: MarkLogicDocumentURIString
237    value: str
name: str
value: str
class UpdateDocumentDict(MarkLogicAPIDict): 
241class UpdateDocumentDict(MarkLogicAPIDict):
242    annotation: str
243    judgment: str
244    uri: MarkLogicDocumentURIString
annotation: str
judgment: str
class UpdateLockedJudgmentDict(MarkLogicAPIDict): 
248class UpdateLockedJudgmentDict(MarkLogicAPIDict):
249    annotation: str
250    judgment: str
251    uri: MarkLogicDocumentURIString
annotation: str
judgment: str
class UserHasPrivilegeDict(MarkLogicAPIDict): 
255class UserHasPrivilegeDict(MarkLogicAPIDict):
256    privilege_action: str
257    privilege_uri: MarkLogicPrivilegeURIString
258    user: str
privilege_action: str
user: str
class UserHasRoleDict(MarkLogicAPIDict): 
262class UserHasRoleDict(MarkLogicAPIDict):
263    role: str
264    user: str
role: str
user: str
class ValidateDocumentDict(MarkLogicAPIDict): 
268class ValidateDocumentDict(MarkLogicAPIDict):
269    uri: MarkLogicDocumentURIString
class XsltDict(MarkLogicAPIDict): 
273class XsltDict(MarkLogicAPIDict):
274    uri: MarkLogicDocumentURIString
class XsltTransformDict(MarkLogicAPIDict): 
278class XsltTransformDict(MarkLogicAPIDict):
279    img_location: Optional[str]
280    query: Optional[str]
281    show_unpublished: Optional[bool]
282    uri: MarkLogicDocumentURIString
283    version_uri: Optional[MarkLogicDocumentVersionURIString]
284    xsl_filename: Optional[str]
img_location: Optional[str]
query: Optional[str]
show_unpublished: Optional[bool]
version_uri: Optional[MarkLogicDocumentVersionURIString]
xsl_filename: Optional[str]