Version 1.6.4 - New collections, operations, and type stubs

.github/wordlist.txt

@@ -1941,4 +1941,7 @@ QThread
 checkboxes
 pipelined
 cancelling
-visualise
+visualise
+IDEs
+terraform
+sdmf

.pylintrc

@@ -85,10 +85,6 @@ py-version=3.9
 # Discover python modules and packages in the file system subtree.
 recursive=no
 
-# When enabled, pylint would attempt to guess common misconfiguration and emit
-# user-friendly hints instead of false-positive error messages.
-suggestion-mode=yes
-
 # Allow loading of arbitrary C extensions. Extensions are imported into the
 # active Python interpreter and may run arbitrary code.
 unsafe-load-any-extension=no

CHANGELOG.md

@@ -1,3 +1,70 @@
+# Version 1.6.4
+## Added features and functionality
++ Added: Added [PEP 561](https://peps.python.org/pep-0561/) type stub (`.pyi`) files for every service collection, along with a `py.typed` marker, so type checkers and IDEs can surface method signatures, keyword arguments, and return types. Deprecated and decommissioned methods are annotated with `@deprecated` so editors flag them at call sites.
+    - `py.typed`
+    - `*.pyi` (one stub per service collection)
+
++ Added: Added `cloud_registration_gcp_post_terraform_script` operation to the __Cloud Google Cloud Registration__ service collection.
+    - _cloud_registration_gcp_post_terraform_script_
+    - `_endpoint/_cloud_google_cloud_registration.py`
+    - `cloud_google_cloud_registration.py`
+    > Unit testing expanded to complete code coverage.
+    - `tests/test_cloud_google_cloud_registration.py`
+
++ Added: New __Falcon Id__ service collection with four operations.
+    - _get_third_party_passkey_registry_
+    - _delete_third_party_passkey_registry_
+    - _update_third_party_passkey_registry_
+    - _query_third_party_passkey_registry_
+    - `_endpoint/__init__.py`
+    - `_endpoint/_falcon_id.py`
+    - `_payload/__init__.py`
+    - `_payload/_falcon_id.py`
+    - `__init__.py`
+    - `falcon_id.py`
+    > Unit testing expanded to complete code coverage.
+    - `tests/test_falcon_id.py`
+
++ Added: Added `DevicesActionsDeleteV1` operation to the __Hosts__ service collection.
+    - _devices_actions_delete_v1_
+    - `_endpoint/_hosts.py`
+    - `hosts.py`
+    > Unit testing expanded to complete code coverage.
+    - `tests/test_hosts.py`
+
++ Added: Added `indicator_sdmf_query_v1` operation to the __Ioc__ service collection.
+    - _indicator_sdmf_query_v1_
+    - `_endpoint/_ioc.py`
+    - `ioc.py`
+    > Unit testing expanded to complete code coverage.
+    - `tests/test_ioc.py`
+
++ Added: Added `CombinedKnowledgeBasesV1` operation to the __Knowledge Bases__ service collection.
+    - _combined_knowledge_bases_v1_
+    - `_endpoint/_knowledge_bases.py`
+    - `knowledge_bases.py`
+    > Unit testing expanded to complete code coverage.
+    - `tests/test_knowledge_bases.py`
+
++ Added: Added `UpdateParserExtension` operation to the __Ngsiem__ service collection.
+    - _update_parser_extension_
+    - `_endpoint/_ngsiem.py`
+    - `ngsiem.py`
+    > Unit testing expanded to complete code coverage.
+    - `tests/test_ngsiem.py`
+
++ Updated: Added `accessed_classified_file`, `classified_file_accessed_by` as allowed `edge_type` values in the _combined_edges_get_ operation, removed `edge_type` value `runs_session` from the _combined_edges_get_ operation, added `fdp-classified-files`, `fdp_classified_files` as allowed `vertex_type` values in the _combined_summary_get_ operation, added `fdp-classified-files`, `fdp_classified_files` as allowed `vertex_type` values in the _entities_vertices_get_ operation, and added `fdp-classified-files`, `fdp_classified_files` as allowed `vertex_type` values in the _entities_vertices_getv2_ operation within the __Threatgraph__ service collection.
+    - `_endpoint/_threatgraph.py`
+    - `threatgraph.py`
+
++ Updated: Added `skip_artifact_resolution` as an allowed parameter in the _WorkflowActivitiesCombined_ operation within the __Workflows__ service collection.
+    - `_endpoint/_workflows.py`
+    - `workflows.py`
+
+# Issues Resolved
++ Fixed: `excluded_from` and `groups` keyword arguments silently dropped from request body in `update_exclusions_v2` when passed as lists. Closes #1482.
+    - `_payload/_ml_exclusions.py`
+
 # Version 1.6.3
 ## Added features and functionality
 + Added: New __Access Scopes__ service collection with two operations.

src/falconpy/__init__.py

@@ -157,6 +157,7 @@
 from .faas_execution import FaaSExecution
 from .falcon_complete_dashboard import CompleteDashboard
 from .falcon_container import FalconContainer
+from .falcon_id import FalconId
 from .falconx_sandbox import FalconXSandbox
 from .fdr import FDR
 from .federated_connections import FederatedConnections
@@ -291,7 +292,8 @@
     "CloudSecurityRegistrationCombined", "CloudSecurityRisks",
     "FederatedConnections", "FoundryLookupFiles",
     "KnowledgeBaseAuditEvents", "KnowledgeBaseFiles",
-    "KnowledgeBases", "ProfileGroups"
+    "KnowledgeBases", "ProfileGroups",
+    "FalconId"
     ]
 """
 This is free and unencumbered software released into the public domain.

src/falconpy/_endpoint/__init__.py

@@ -121,6 +121,7 @@
 from ._faas_execution import _faas_execution_endpoints
 from ._falcon_complete_dashboard import _falcon_complete_dashboard_endpoints
 from ._falcon_container import _falcon_container_endpoints
+from ._falcon_id import _falcon_id_endpoints
 from ._falconx_sandbox import _falconx_sandbox_endpoints
 from ._fdr import _fdr_endpoints
 from ._federated_connections import _federated_connections_endpoints
@@ -246,6 +247,7 @@
 api_endpoints.extend(_faas_execution_endpoints)
 api_endpoints.extend(_falcon_complete_dashboard_endpoints)
 api_endpoints.extend(_falcon_container_endpoints)
+api_endpoints.extend(_falcon_id_endpoints)
 api_endpoints.extend(_falconx_sandbox_endpoints)
 api_endpoints.extend(_fdr_endpoints)
 api_endpoints.extend(_federated_connections_endpoints)

src/falconpy/_endpoint/_cloud_google_cloud_registration.py

@@ -59,7 +59,7 @@
         "type": "string",
         "description": "FQL (Falcon Query Language) string for filtering results. Allowed filters are "
         "entity_type, entity_id, entity_name, registration_id, registration_name, registration_scope, parent_id, "
-        "project_number, ioa_status, iom_status, created, updated",
+        "project_number, ioa_status, iom_status, dspm_status, vulnerability_scanning_status, created, updated",
         "name": "filter",
         "in": "query"
       },
@@ -188,5 +188,19 @@
         "required": True
       }
     ]
+  ],
+  [
+    "cloud_registration_gcp_post_terraform_script",
+    "POST",
+    "/cloud-security-registration-google-cloud/entities/scripts-terraform/v1",
+    "Generate Google Cloud Terraform deployment scripts (zip files)",
+    "cloud_google_cloud_registration",
+    [
+      {
+        "name": "body",
+        "in": "body",
+        "required": True
+      }
+    ]
   ]
 ]

src/falconpy/_endpoint/_cloud_oci_registration.py

@@ -47,14 +47,14 @@
       {
         "type": "string",
         "description": "FQL (Falcon Query Language) string for filtering results. Allowed filters are "
-        "Set{overall_status, created_at, updated_at, tenancy_ocid, tenancy_name, home_region, key_age}",
+        "Set{tenancy_ocid, tenancy_name, home_region, key_age, overall_status, created_at, updated_at}",
         "name": "filter",
         "in": "query"
       },
       {
         "type": "string",
-        "description": "Field and direction for sorting results - allowed sort fields are Set{created_at, "
-        "updated_at, tenancy_ocid, tenancy_name, home_region, key_age, overall_status}",
+        "description": "Field and direction for sorting results - allowed sort fields are Set{key_age, "
+        "overall_status, created_at, updated_at, tenancy_ocid, tenancy_name, home_region}",
         "name": "sort",
         "in": "query"
       },