From aa56e97410dd9514f5722498714552b2d517dccb Mon Sep 17 00:00:00 2001 From: Kamforka Date: Thu, 17 Oct 2024 16:45:38 +0100 Subject: [PATCH] Deployed 67cf7cf to 2.0.0b6 with MkDocs 1.6.1 and mike 2.1.3 --- 2.0.0b6/reference/index.html | 202 +++++++++++++++++------------------ 1 file changed, 100 insertions(+), 102 deletions(-) diff --git a/2.0.0b6/reference/index.html b/2.0.0b6/reference/index.html index a7bd2e0..9894254 100644 --- a/2.0.0b6/reference/index.html +++ b/2.0.0b6/reference/index.html @@ -20423,8 +20423,7 @@
60 61 62 -63 -64
def update(
+63
def update(
     self, case_id: CaseId, fields: Optional[InputUpdateCase] = {}, **kwargs
 ) -> None:
 
@@ -20439,7 +20438,6 @@ 

             "convention like other update methods. Please use the `fields` "
             "argument to prevent breaking changes in the future.",
             category=DeprecationWarning,
-            stacklevel=2,
         )
         fields = kwargs["case"]
 
@@ -20465,10 +20463,10 @@ 

               Source code in thehive4py/endpoints/case.py
-              
66
+              
65
+66
 67
-68
-69
def bulk_update(self, fields: InputBulkUpdateCase) -> None:
+68
def bulk_update(self, fields: InputBulkUpdateCase) -> None:
     return self._session.make_request(
         "PATCH", path="/api/v1/case/_bulk", json=fields
     )
@@ -20491,11 +20489,11 @@ 

 
             

               Source code in thehive4py/endpoints/case.py
-              
71
+              
70
+71
 72
 73
-74
-75
def merge(self, case_ids: Sequence[CaseId]) -> OutputCase:
+74
def merge(self, case_ids: Sequence[CaseId]) -> OutputCase:
     case_id_subpath = ",".join([str(case_id) for case_id in case_ids])
     return self._session.make_request(
         "POST", path=f"/api/v1/case/_merge/{case_id_subpath}"
@@ -20519,10 +20517,10 @@ 

               Source code in thehive4py/endpoints/case.py
-              
77
+              
76
+77
 78
-79
-80
def unlink_alert(self, case_id: str, alert_id: str) -> None:
+79
def unlink_alert(self, case_id: str, alert_id: str) -> None:
     return self._session.make_request(
         "DELETE", path=f"/api/v1/case/{case_id}/alert/{alert_id}"
     )
@@ -20545,11 +20543,11 @@ 

               Source code in thehive4py/endpoints/case.py
-              
82
+              
81
+82
 83
 84
-85
-86
def merge_similar_observables(self, case_id: CaseId) -> dict:
+85
def merge_similar_observables(self, case_id: CaseId) -> dict:
     # TODO: add better return value type hint
     return self._session.make_request(
         "POST", path=f"/api/v1/case/{case_id}/observable/_merge"
@@ -20573,8 +20571,8 @@ 

               Source code in thehive4py/endpoints/case.py
-              
88
-89
def get_linked_cases(self, case_id: CaseId) -> List[OutputCase]:
+              
87
+88
def get_linked_cases(self, case_id: CaseId) -> List[OutputCase]:
     return self._session.make_request("GET", path=f"/api/v1/case/{case_id}/links")
 

             
@@ -20595,10 +20593,10 @@ 

               Source code in thehive4py/endpoints/case.py
-              
91
+              
90
+91
 92
-93
-94
def delete_custom_field(self, custom_field_id: str) -> None:
+93
def delete_custom_field(self, custom_field_id: str) -> None:
     return self._session.make_request(
         "DELETE", path=f"/api/v1/case/customField/{custom_field_id}"
     )
@@ -20621,14 +20619,14 @@ 

               Source code in thehive4py/endpoints/case.py
-              
 96
+              
 95
+ 96
  97
  98
  99
 100
 101
-102
-103
def import_from_file(self, import_case: InputImportCase, import_path: str) -> dict:
+102
def import_from_file(self, import_case: InputImportCase, import_path: str) -> dict:
     # TODO: add better return type hints
     return self._session.make_request(
         "POST",
@@ -20655,13 +20653,13 @@ 

               Source code in thehive4py/endpoints/case.py
-              
105
+              
104
+105
 106
 107
 108
 109
-110
-111
def export_to_file(self, case_id: CaseId, password: str, export_path: str) -> None:
+110
def export_to_file(self, case_id: CaseId, password: str, export_path: str) -> None:
     return self._session.make_request(
         "GET",
         path=f"/api/v1/case/{case_id}/export",
@@ -20687,8 +20685,8 @@ 

               Source code in thehive4py/endpoints/case.py
-              
113
-114
def get_timeline(self, case_id: CaseId) -> OutputTimeline:
+              
112
+113
def get_timeline(self, case_id: CaseId) -> OutputTimeline:
     return self._session.make_request("GET", f"/api/v1/case/{case_id}/timeline")
 

             
@@ -20709,7 +20707,8 @@ 

               Source code in thehive4py/endpoints/case.py
-              
116
+              
115
+116
 117
 118
 119
@@ -20717,8 +20716,7 @@ 
121
 122
 123
-124
-125
def add_attachment(
+124
def add_attachment(
     self, case_id: CaseId, attachment_paths: List[str]
 ) -> List[OutputAttachment]:
     files = [
@@ -20747,14 +20745,14 @@ 

               Source code in thehive4py/endpoints/case.py
-              
127
+              
126
+127
 128
 129
 130
 131
 132
-133
-134
def download_attachment(
+133
def download_attachment(
     self, case_id: CaseId, attachment_id: str, attachment_path: str
 ) -> None:
     return self._session.make_request(
@@ -20781,10 +20779,10 @@ 

               Source code in thehive4py/endpoints/case.py
-              
136
+              
135
+136
 137
-138
-139
def delete_attachment(self, case_id: CaseId, attachment_id: str) -> None:
+138
def delete_attachment(self, case_id: CaseId, attachment_id: str) -> None:
     return self._session.make_request(
         "DELETE", path=f"/api/v1/case/{case_id}/attachment/{attachment_id}"
     )
@@ -20807,8 +20805,8 @@ 

               Source code in thehive4py/endpoints/case.py
-              
141
-142
def list_shares(self, case_id: CaseId) -> List[OutputShare]:
+              
140
+141
def list_shares(self, case_id: CaseId) -> List[OutputShare]:
     return self._session.make_request("GET", path=f"/api/v1/case/{case_id}/shares")
 

             
@@ -20829,10 +20827,10 @@ 

 
             

               Source code in thehive4py/endpoints/case.py
-              
144
+              
143
+144
 145
-146
-147
def share(self, case_id: CaseId, shares: List[InputShare]) -> List[OutputShare]:
+146
def share(self, case_id: CaseId, shares: List[InputShare]) -> List[OutputShare]:
     return self._session.make_request(
         "POST", path=f"/api/v1/case/{case_id}/shares", json={"shares": shares}
     )
@@ -20855,12 +20853,12 @@ 

 
             

               Source code in thehive4py/endpoints/case.py
-              
149
+              
148
+149
 150
 151
 152
-153
-154
def unshare(self, case_id: CaseId, organisation_ids: List[str]) -> None:
+153
def unshare(self, case_id: CaseId, organisation_ids: List[str]) -> None:
     return self._session.make_request(
         "DELETE",
         path=f"/api/v1/case/{case_id}/shares",
@@ -20885,10 +20883,10 @@ 

               Source code in thehive4py/endpoints/case.py
-              
156
+              
155
+156
 157
-158
-159
def set_share(self, case_id: CaseId, shares: List[InputShare]) -> List[OutputShare]:
+158
def set_share(self, case_id: CaseId, shares: List[InputShare]) -> List[OutputShare]:
     return self._session.make_request(
         "PUT", path=f"/api/v1/case/{case_id}/shares", json={"shares": shares}
     )
@@ -20911,10 +20909,10 @@ 

               Source code in thehive4py/endpoints/case.py
-              
161
+              
160
+161
 162
-163
-164
def remove_share(self, share_id: str) -> None:
+163
def remove_share(self, share_id: str) -> None:
     return self._session.make_request(
         "DELETE", path=f"/api/v1/case/share/{share_id}"
     )
@@ -20937,10 +20935,10 @@ 

               Source code in thehive4py/endpoints/case.py
-              
166
+              
165
+166
 167
-168
-169
def update_share(self, share_id: str, profile: str) -> None:
+168
def update_share(self, share_id: str, profile: str) -> None:
     return self._session.make_request(
         "PATCH", path=f"/api/v1/case/share/{share_id}", json={"profile": profile}
     )
@@ -20963,7 +20961,8 @@ 

 
             

               Source code in thehive4py/endpoints/case.py
-              
171
+              
170
+171
 172
 173
 174
@@ -20978,8 +20977,7 @@ 

 183
 184
 185
-186
-187
def find(
+186
def find(
     self,
     filters: Optional[FilterExpr] = None,
     sortby: Optional[SortExpr] = None,
@@ -21015,7 +21013,8 @@ 

 
             

               Source code in thehive4py/endpoints/case.py
-              
189
+              
188
+189
 190
 191
 192
@@ -21026,8 +21025,7 @@ 

 197
 198
 199
-200
-201
def count(self, filters: Optional[FilterExpr] = None) -> int:
+200
def count(self, filters: Optional[FilterExpr] = None) -> int:
     query: QueryExpr = [
         {"_name": "listCase"},
         *self._build_subquery(filters=filters),
@@ -21059,12 +21057,12 @@ 

               Source code in thehive4py/endpoints/case.py
-              
203
+              
202
+203
 204
 205
 206
-207
-208
def create_task(self, case_id: CaseId, task: InputTask) -> OutputTask:
+207
def create_task(self, case_id: CaseId, task: InputTask) -> OutputTask:
     return self._session.make_request(
         "POST",
         path=f"/api/v1/case/{case_id}/task",
@@ -21089,7 +21087,8 @@ 

               Source code in thehive4py/endpoints/case.py
-              
210
+              
209
+210
 211
 212
 213
@@ -21106,8 +21105,7 @@ 
224
 225
 226
-227
-228
def find_tasks(
+227
def find_tasks(
     self,
     case_id: CaseId,
     filters: Optional[FilterExpr] = None,
@@ -21145,7 +21143,8 @@ 

               Source code in thehive4py/endpoints/case.py
-              
230
+              
229
+230
 231
 232
 233
@@ -21155,8 +21154,7 @@ 
237
 238
 239
-240
-241
def create_observable(
+240
def create_observable(
     self,
     case_id: CaseId,
     observable: InputObservable,
@@ -21187,7 +21185,8 @@ 

               Source code in thehive4py/endpoints/case.py
-              
243
+              
242
+243
 244
 245
 246
@@ -21203,8 +21202,7 @@ 
256
 257
 258
-259
-260
def find_observables(
+259
def find_observables(
     self,
     case_id: CaseId,
     filters: Optional[FilterExpr] = None,
@@ -21241,12 +21239,12 @@ 

               Source code in thehive4py/endpoints/case.py
-              
262
+              
261
+262
 263
 264
 265
-266
-267
def create_procedure(
+266
def create_procedure(
     self, case_id: str, procedure: InputProcedure
 ) -> OutputProcedure:
     return self._session.make_request(
@@ -21271,7 +21269,8 @@ 

               Source code in thehive4py/endpoints/case.py
-              
269
+              
268
+269
 270
 271
 272
@@ -21288,8 +21287,7 @@ 
283
 284
 285
-286
-287
def find_procedures(
+286
def find_procedures(
     self,
     case_id: str,
     filters: Optional[FilterExpr] = None,
@@ -21327,10 +21325,10 @@ 

               Source code in thehive4py/endpoints/case.py
-              
289
+              
288
+289
 290
-291
-292
def create_page(self, case_id: str, page: InputCasePage) -> OutputCasePage:
+291
def create_page(self, case_id: str, page: InputCasePage) -> OutputCasePage:
     return self._session.make_request(
         "POST", path=f"/api/v1/case/{case_id}/page", json=page
     )
@@ -21353,10 +21351,10 @@ 

               Source code in thehive4py/endpoints/case.py
-              
294
+              
293
+294
 295
-296
-297
def delete_page(self, case_id: str, page_id: str) -> None:
+296
def delete_page(self, case_id: str, page_id: str) -> None:
     return self._session.make_request(
         "DELETE", path=f"/api/v1/case/{case_id}/page/{page_id}"
     )
@@ -21379,12 +21377,12 @@ 

               Source code in thehive4py/endpoints/case.py
-              
299
+              
298
+299
 300
 301
 302
-303
-304
def update_page(
+303
def update_page(
     self, case_id: str, page_id: str, page: InputUpdateCasePage
 ) -> None:
     return self._session.make_request(
@@ -21409,7 +21407,8 @@ 

               Source code in thehive4py/endpoints/case.py
-              
306
+              
305
+306
 307
 308
 309
@@ -21426,8 +21425,7 @@ 
320
 321
 322
-323
-324
def find_pages(
+323
def find_pages(
     self,
     case_id: str,
     filters: Optional[FilterExpr] = None,
@@ -21465,7 +21463,8 @@ 

               Source code in thehive4py/endpoints/case.py
-              
326
+              
325
+326
 327
 328
 329
@@ -21481,8 +21480,7 @@ 
339
 340
 341
-342
-343
def find_attachments(
+342
def find_attachments(
     self,
     case_id: CaseId,
     filters: Optional[FilterExpr] = None,
@@ -21519,7 +21517,8 @@ 

               Source code in thehive4py/endpoints/case.py
-              
345
+              
344
+345
 346
 347
 348
@@ -21535,8 +21534,7 @@ 
358
 359
 360
-361
-362
def find_comments(
+361
def find_comments(
     self,
     case_id: CaseId,
     filters: Optional[FilterExpr] = None,
@@ -21573,7 +21571,8 @@ 

 
             

               Source code in thehive4py/endpoints/case.py
-              
364
+              
363
+364
 365
 366
 367
@@ -21587,8 +21586,7 @@ 

 375
 376
 377
-378
-379
def close(
+378
def close(
     self,
     case_id: CaseId,
     status: CaseStatusValue,
@@ -21623,11 +21621,11 @@ 

 
             

               Source code in thehive4py/endpoints/case.py
-              
381
+              
380
+381
 382
 383
-384
-385
def open(
+384
def open(
     self, case_id: CaseId, status: CaseStatusValue = CaseStatus.InProgress
 ) -> None:
     case: InputUpdateCase = {"status": status}