From 5a8e7b1c4bed4e793897a7ddb69241aa821854b2 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Tue, 22 Oct 2024 18:47:59 +0000 Subject: [PATCH] Deployed b3162f6 to main with MkDocs 1.6.1 and mike 2.1.3 --- main/404.html | 2 +- main/examples/alert/index.html | 2 +- main/examples/client/index.html | 2 +- main/index.html | 2 +- main/reference/index.html | 204 ++++++++++++++++---------------- main/sitemap.xml.gz | Bin 127 -> 127 bytes 6 files changed, 107 insertions(+), 105 deletions(-) diff --git a/main/404.html b/main/404.html index 110ee73..c9ef229 100644 --- a/main/404.html +++ b/main/404.html @@ -12,7 +12,7 @@ - + diff --git a/main/examples/alert/index.html b/main/examples/alert/index.html index 213f5d7..368d04a 100644 --- a/main/examples/alert/index.html +++ b/main/examples/alert/index.html @@ -16,7 +16,7 @@ - + diff --git a/main/examples/client/index.html b/main/examples/client/index.html index 9a67aaa..e99e7ec 100644 --- a/main/examples/client/index.html +++ b/main/examples/client/index.html @@ -16,7 +16,7 @@ - + diff --git a/main/index.html b/main/index.html index 7866606..d343e4e 100644 --- a/main/index.html +++ b/main/index.html @@ -14,7 +14,7 @@ - + diff --git a/main/reference/index.html b/main/reference/index.html index 80894a2..3a1b9ce 100644 --- a/main/reference/index.html +++ b/main/reference/index.html @@ -14,7 +14,7 @@ - + @@ -20587,7 +20587,8 @@
60 61 62 -63
def update(
+63
+64
def update(
     self, case_id: CaseId, fields: Optional[InputUpdateCase] = {}, **kwargs
 ) -> None:
 
@@ -20602,6 +20603,7 @@ 

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

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

 
             

               Source code in thehive4py/endpoints/case.py
-              
70
-71
+              
71
 72
 73
-74
def merge(self, case_ids: Sequence[CaseId]) -> OutputCase:
+74
+75
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}"
@@ -20681,10 +20683,10 @@ 

               Source code in thehive4py/endpoints/case.py
-              
76
-77
+              
77
 78
-79
def unlink_alert(self, case_id: str, alert_id: str) -> None:
+79
+80
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}"
     )
@@ -20707,11 +20709,11 @@ 

               Source code in thehive4py/endpoints/case.py
-              
81
-82
+              
82
 83
 84
-85
def merge_similar_observables(self, case_id: CaseId) -> dict:
+85
+86
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"
@@ -20735,8 +20737,8 @@ 

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

             
@@ -20757,10 +20759,10 @@ 

               Source code in thehive4py/endpoints/case.py
-              
90
-91
+              
91
 92
-93
def delete_custom_field(self, custom_field_id: str) -> None:
+93
+94
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}"
     )
@@ -20783,14 +20785,14 @@ 

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

               Source code in thehive4py/endpoints/case.py
-              
104
-105
+              
105
 106
 107
 108
 109
-110
def export_to_file(self, case_id: CaseId, password: str, export_path: str) -> None:
+110
+111
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",
@@ -20849,8 +20851,8 @@ 

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

             
@@ -20871,8 +20873,7 @@ 

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

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

               Source code in thehive4py/endpoints/case.py
-              
135
-136
+              
136
 137
-138
def delete_attachment(self, case_id: CaseId, attachment_id: str) -> None:
+138
+139
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}"
     )
@@ -20969,8 +20971,8 @@ 

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

             
@@ -20991,10 +20993,10 @@ 

 
             

               Source code in thehive4py/endpoints/case.py
-              
143
-144
+              
144
 145
-146
def share(self, case_id: CaseId, shares: List[InputShare]) -> List[OutputShare]:
+146
+147
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}
     )
@@ -21017,12 +21019,12 @@ 

 
             

               Source code in thehive4py/endpoints/case.py
-              
148
-149
+              
149
 150
 151
 152
-153
def unshare(self, case_id: CaseId, organisation_ids: List[str]) -> None:
+153
+154
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",
@@ -21047,10 +21049,10 @@ 

               Source code in thehive4py/endpoints/case.py
-              
155
-156
+              
156
 157
-158
def set_share(self, case_id: CaseId, shares: List[InputShare]) -> List[OutputShare]:
+158
+159
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}
     )
@@ -21073,10 +21075,10 @@ 

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

               Source code in thehive4py/endpoints/case.py
-              
165
-166
+              
166
 167
-168
def update_share(self, share_id: str, profile: str) -> None:
+168
+169
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}
     )
@@ -21125,8 +21127,7 @@ 

 
             

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

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

 
             

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

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

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

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

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

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

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

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

               Source code in thehive4py/endpoints/case.py
-              
288
-289
+              
289
 290
-291
def create_page(self, case_id: str, page: InputCasePage) -> OutputCasePage:
+291
+292
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
     )
@@ -21515,10 +21517,10 @@ 

               Source code in thehive4py/endpoints/case.py
-              
293
-294
+              
294
 295
-296
def delete_page(self, case_id: str, page_id: str) -> None:
+296
+297
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}"
     )
@@ -21541,12 +21543,12 @@ 

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

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

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

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

 
             

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

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

 
             

               Source code in thehive4py/endpoints/case.py
-              
380
-381
+              
381
 382
 383
-384
def open(
+384
+385
def open(
     self, case_id: CaseId, status: CaseStatusValue = CaseStatus.InProgress
 ) -> None:
     case: InputUpdateCase = {"status": status}
diff --git a/main/sitemap.xml.gz b/main/sitemap.xml.gz
index 45db7515fcac11098b65e6a958f0fba0537a97b1..8f2bbf57c823a26f80a69dd6cdd1f1e7cb7c1f01 100644
GIT binary patch
delta 13
Ucmb=gXP58h;9z(yHj%vo02+D&(EtDd

delta 13
Ucmb=gXP58h;9yuPIFY>q02v4ah5!Hn