From 253762a0838d3403221caf7cef41ad71fe4efc0b Mon Sep 17 00:00:00 2001 From: Kamforka Date: Thu, 17 Oct 2024 16:58:53 +0100 Subject: [PATCH] Deployed 67cf7cf to 2.0.0b6 with MkDocs 1.6.1 and mike 2.1.3 --- 2.0.0b6/404.html | 6 +- 2.0.0b6/examples/alert/index.html | 6 +- 2.0.0b6/examples/client/index.html | 6 +- 2.0.0b6/index.html | 6 +- 2.0.0b6/reference/index.html | 208 +++++++++++++++-------------- 5 files changed, 127 insertions(+), 105 deletions(-) diff --git a/2.0.0b6/404.html b/2.0.0b6/404.html index 01624a8..b4335fe 100644 --- a/2.0.0b6/404.html +++ b/2.0.0b6/404.html @@ -76,6 +76,10 @@ + + @@ -493,7 +497,7 @@

404 - Not found

- + diff --git a/2.0.0b6/examples/alert/index.html b/2.0.0b6/examples/alert/index.html index 8a1c66e..4db5e6e 100644 --- a/2.0.0b6/examples/alert/index.html +++ b/2.0.0b6/examples/alert/index.html @@ -85,6 +85,10 @@ + + @@ -1408,7 +1412,7 @@

Delete in bulk

- + diff --git a/2.0.0b6/examples/client/index.html b/2.0.0b6/examples/client/index.html index 898d70e..050c18c 100644 --- a/2.0.0b6/examples/client/index.html +++ b/2.0.0b6/examples/client/index.html @@ -85,6 +85,10 @@ + + @@ -871,7 +875,7 @@

Retries

- + diff --git a/2.0.0b6/index.html b/2.0.0b6/index.html index d106052..338eb13 100644 --- a/2.0.0b6/index.html +++ b/2.0.0b6/index.html @@ -83,6 +83,10 @@ + + @@ -604,7 +608,7 @@

Licensing

- + diff --git a/2.0.0b6/reference/index.html b/2.0.0b6/reference/index.html index 9894254..5edcce3 100644 --- a/2.0.0b6/reference/index.html +++ b/2.0.0b6/reference/index.html @@ -83,6 +83,10 @@ + + @@ -20423,7 +20427,8 @@
60 61 62 -63
def update(
+63
+64
def update(
     self, case_id: CaseId, fields: Optional[InputUpdateCase] = {}, **kwargs
 ) -> None:
 
@@ -20438,6 +20443,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"]
 
@@ -20463,10 +20469,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
     )
@@ -20489,11 +20495,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}"
@@ -20517,10 +20523,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}"
     )
@@ -20543,11 +20549,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"
@@ -20571,8 +20577,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")
 

             
@@ -20593,10 +20599,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}"
     )
@@ -20619,14 +20625,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",
@@ -20653,13 +20659,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",
@@ -20685,8 +20691,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")
 

             
@@ -20707,8 +20713,7 @@ 

               Source code in thehive4py/endpoints/case.py
-              
115
-116
+              
116
 117
 118
 119
@@ -20716,7 +20721,8 @@ 
121
 122
 123
-124
def add_attachment(
+124
+125
def add_attachment(
     self, case_id: CaseId, attachment_paths: List[str]
 ) -> List[OutputAttachment]:
     files = [
@@ -20745,14 +20751,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(
@@ -20779,10 +20785,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}"
     )
@@ -20805,8 +20811,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")
 

             
@@ -20827,10 +20833,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}
     )
@@ -20853,12 +20859,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",
@@ -20883,10 +20889,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}
     )
@@ -20909,10 +20915,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}"
     )
@@ -20935,10 +20941,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}
     )
@@ -20961,8 +20967,7 @@ 

 
             

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

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

 
             

               Source code in thehive4py/endpoints/case.py
-              
188
-189
+              
189
 190
 191
 192
@@ -21025,7 +21030,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),
@@ -21057,12 +21063,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",
@@ -21087,8 +21093,7 @@ 

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

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

               Source code in thehive4py/endpoints/case.py
-              
242
-243
+              
243
 244
 245
 246
@@ -21202,7 +21207,8 @@ 
256
 257
 258
-259
def find_observables(
+259
+260
def find_observables(
     self,
     case_id: CaseId,
     filters: Optional[FilterExpr] = None,
@@ -21239,12 +21245,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(
@@ -21269,8 +21275,7 @@ 

               Source code in thehive4py/endpoints/case.py
-              
268
-269
+              
269
 270
 271
 272
@@ -21287,7 +21292,8 @@ 
283
 284
 285
-286
def find_procedures(
+286
+287
def find_procedures(
     self,
     case_id: str,
     filters: Optional[FilterExpr] = None,
@@ -21325,10 +21331,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
     )
@@ -21351,10 +21357,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}"
     )
@@ -21377,12 +21383,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(
@@ -21407,8 +21413,7 @@ 

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

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

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

 
             

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

 375
 376
 377
-378
def close(
+378
+379
def close(
     self,
     case_id: CaseId,
     status: CaseStatusValue,
@@ -21621,11 +21627,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}
@@ -38944,7 +38950,7 @@ 

     

     
     
-    
+