CheckmarxPythonSDK 1.7.6__tar.gz → 1.7.7__tar.gz

{checkmarxpythonsdk-1.7.6 → checkmarxpythonsdk-1.7.7}/CheckmarxPythonSDK/CxOne/KeycloakAPI/IdentityProvidersApi.py

@@ -27,12 +27,18 @@ class IdentityProvidersApi:
         URL:
             Relative path: /{realm}/identity-provider/import-config
         """
-        relative_url = f"{api_url}/{realm}/identity_provider/import_config"
+        relative_url = f"{api_url}/{realm}/identity-provider/import_config"
         response = self.api_client.post_request(relative_url=relative_url, is_iam=True)
         return response.json()
 
-    def get_instances(self, realm: str, brief_representation: bool = None, first: str = None, max: str = None,
-                      search: bool = None) -> List[IdentityProviderRepresentation]:
+    def get_instances(
+            self, 
+            realm: str, 
+            brief_representation: bool = None, 
+            first: str = None, 
+            max: str = None,
+            search: bool = None
+        ) -> List[IdentityProviderRepresentation]:
         """
         List identity providers
         
@@ -50,11 +56,15 @@ class IdentityProvidersApi:
             Relative path: /{realm}/identity-provider/instances
         """
         params = {"briefRepresentation": brief_representation, "first": first, "max": max, "search": search}
-        relative_url = f"{api_url}/{realm}/identity_provider/instances"
+        relative_url = f"{api_url}/{realm}/identity-provider/instances"
         response = self.api_client.get_request(relative_url=relative_url, params=params, is_iam=True)
         return [IdentityProviderRepresentation.from_dict(item) for item in response.json()]
 
-    def post_instances(self, realm: str, identity_provider_representation: IdentityProviderRepresentation) -> bool:
+    def post_instances(
+            self, 
+            realm: str, 
+            identity_provider_representation: IdentityProviderRepresentation
+        ) -> bool:
         """
         Create a new identity provider
         
@@ -68,7 +78,7 @@ class IdentityProvidersApi:
         URL:
             Relative path: /{realm}/identity-provider/instances
         """
-        relative_url = f"{api_url}/{realm}/identity_provider/instances"
+        relative_url = f"{api_url}/{realm}/identity-provider/instances"
         response = self.api_client.post_request(relative_url=relative_url,
                                                 json=identity_provider_representation.to_dict(), is_iam=True)
         return response.status_code == 200
@@ -87,12 +97,16 @@ class IdentityProvidersApi:
         URL:
             Relative path: /{realm}/identity-provider/instances/{alias}
         """
-        relative_url = f"{api_url}/{realm}/identity_provider/instances/{alias}"
+        relative_url = f"{api_url}/{realm}/identity-provider/instances/{alias}"
         response = self.api_client.get_request(relative_url=relative_url, is_iam=True)
         return IdentityProviderRepresentation.from_dict(response.json())
 
-    def put_instance(self, realm: str, alias: str,
-                     identity_provider_representation: IdentityProviderRepresentation) -> bool:
+    def put_instance(
+            self, 
+            realm: str, 
+            alias: str,
+            identity_provider_representation: IdentityProviderRepresentation
+        ) -> bool:
         """
         Update the identity provider
         
@@ -107,7 +121,7 @@ class IdentityProvidersApi:
         URL:
             Relative path: /{realm}/identity-provider/instances/{alias}
         """
-        relative_url = f"{api_url}/{realm}/identity_provider/instances/{alias}"
+        relative_url = f"{api_url}/{realm}/identity-provider/instances/{alias}"
         response = self.api_client.put_request(relative_url=relative_url,
                                                json=identity_provider_representation.to_dict(), is_iam=True)
         return response.status_code == 200
@@ -126,7 +140,7 @@ class IdentityProvidersApi:
         URL:
             Relative path: /{realm}/identity-provider/instances/{alias}
         """
-        relative_url = f"{api_url}/{realm}/identity_provider/instances/{alias}"
+        relative_url = f"{api_url}/{realm}/identity-provider/instances/{alias}"
         response = self.api_client.delete_request(relative_url=relative_url, is_iam=True)
         return response.status_code == 200
 
@@ -146,7 +160,7 @@ class IdentityProvidersApi:
             Relative path: /{realm}/identity-provider/instances/{alias}/export
         """
         params = {"format": format}
-        relative_url = f"{api_url}/{realm}/identity_provider/instances/{alias}/export"
+        relative_url = f"{api_url}/{realm}/identity-provider/instances/{alias}/export"
         response = self.api_client.get_request(relative_url=relative_url, params=params, is_iam=True)
         return response.status_code == 200
 
@@ -164,12 +178,16 @@ class IdentityProvidersApi:
         URL:
             Relative path: /{realm}/identity-provider/instances/{alias}/management/permissions
         """
-        relative_url = f"{api_url}/{realm}/identity_provider/instances/{alias}/management/permissions"
+        relative_url = f"{api_url}/{realm}/identity-provider/instances/{alias}/management/permissions"
         response = self.api_client.get_request(relative_url=relative_url, is_iam=True)
         return ManagementPermissionReference.from_dict(response.json())
 
-    def put_instance_management_permissions(self, realm: str, alias: str,
-                                            management_permission_reference: ManagementPermissionReference) -> ManagementPermissionReference:
+    def put_instance_management_permissions(
+            self, 
+            realm: str, 
+            alias: str,
+            management_permission_reference: ManagementPermissionReference
+        ) -> ManagementPermissionReference:
         """
         Return object stating whether client Authorization permissions have been initialized or not and a reference
         
@@ -184,7 +202,7 @@ class IdentityProvidersApi:
         URL:
             Relative path: /{realm}/identity-provider/instances/{alias}/management/permissions
         """
-        relative_url = f"{api_url}/{realm}/identity_provider/instances/{alias}/management/permissions"
+        relative_url = f"{api_url}/{realm}/identity-provider/instances/{alias}/management/permissions"
         response = self.api_client.put_request(relative_url=relative_url,
                                                json=management_permission_reference.to_dict(), is_iam=True)
         return ManagementPermissionReference.from_dict(response.json())
@@ -203,7 +221,7 @@ class IdentityProvidersApi:
         URL:
             Relative path: /{realm}/identity-provider/instances/{alias}/mapper-types
         """
-        relative_url = f"{api_url}/{realm}/identity_provider/instances/{alias}/mapper_types"
+        relative_url = f"{api_url}/{realm}/identity-provider/instances/{alias}/mapper_types"
         response = self.api_client.get_request(relative_url=relative_url, is_iam=True)
         return response.status_code == 200
 
@@ -221,7 +239,7 @@ class IdentityProvidersApi:
         URL:
             Relative path: /{realm}/identity-provider/instances/{alias}/mappers
         """
-        relative_url = f"{api_url}/{realm}/identity_provider/instances/{alias}/mappers"
+        relative_url = f"{api_url}/{realm}/identity-provider/instances/{alias}/mappers"
         response = self.api_client.get_request(relative_url=relative_url, is_iam=True)
         return [IdentityProviderMapperRepresentation.from_dict(item) for item in response.json()]
 
@@ -241,7 +259,7 @@ class IdentityProvidersApi:
         URL:
             Relative path: /{realm}/identity-provider/instances/{alias}/mappers
         """
-        relative_url = f"{api_url}/{realm}/identity_provider/instances/{alias}/mappers"
+        relative_url = f"{api_url}/{realm}/identity-provider/instances/{alias}/mappers"
         response = self.api_client.post_request(relative_url=relative_url,
                                                 json=identity_provider_mapper_representation.to_dict(), is_iam=True)
         return response.status_code == 200
@@ -261,12 +279,17 @@ class IdentityProvidersApi:
         URL:
             Relative path: /{realm}/identity-provider/instances/{alias}/mappers/{id}
         """
-        relative_url = f"{api_url}/{realm}/identity_provider/instances/{alias}/mappers/{id}"
+        relative_url = f"{api_url}/{realm}/identity-provider/instances/{alias}/mappers/{id}"
         response = self.api_client.get_request(relative_url=relative_url, is_iam=True)
         return IdentityProviderMapperRepresentation.from_dict(response.json())
 
-    def put_mapper(self, realm: str, alias: str, id: str,
-                   identity_provider_mapper_representation: IdentityProviderMapperRepresentation) -> bool:
+    def put_mapper(
+            self, 
+            realm: str, 
+            alias: str, 
+            id: str,
+            identity_provider_mapper_representation: IdentityProviderMapperRepresentation
+        ) -> bool:
         """
         Update a mapper for the identity provider
         
@@ -282,7 +305,7 @@ class IdentityProvidersApi:
         URL:
             Relative path: /{realm}/identity-provider/instances/{alias}/mappers/{id}
         """
-        relative_url = f"{api_url}/{realm}/identity_provider/instances/{alias}/mappers/{id}"
+        relative_url = f"{api_url}/{realm}/identity-provider/instances/{alias}/mappers/{id}"
         response = self.api_client.put_request(relative_url=relative_url,
                                                json=identity_provider_mapper_representation.to_dict(), is_iam=True)
         return response.status_code == 204
@@ -302,7 +325,7 @@ class IdentityProvidersApi:
         URL:
             Relative path: /{realm}/identity-provider/instances/{alias}/mappers/{id}
         """
-        relative_url = f"{api_url}/{realm}/identity_provider/instances/{alias}/mappers/{id}"
+        relative_url = f"{api_url}/{realm}/identity-provider/instances/{alias}/mappers/{id}"
         response = self.api_client.delete_request(relative_url=relative_url, is_iam=True)
         return response.status_code == 204
 
@@ -320,6 +343,6 @@ class IdentityProvidersApi:
         URL:
             Relative path: /{realm}/identity-provider/providers/{provider_id}
         """
-        relative_url = f"{api_url}/{realm}/identity_provider/providers/{provider_id}"
+        relative_url = f"{api_url}/{realm}/identity-provider/providers/{provider_id}"
         response = self.api_client.get_request(relative_url=relative_url, is_iam=True)
         return response.json()

{checkmarxpythonsdk-1.7.6 → checkmarxpythonsdk-1.7.7}/CheckmarxPythonSDK/CxOne/KeycloakAPI/RolesApi.py

@@ -15,17 +15,17 @@ class RolesApi:
             api_client = ApiClient(configuration=configuration)
         self.api_client = api_client
 
-    def get_client_roles(self, realm: str, id: str, brief_representation: str = None, first: str = None,
-                         max: str = None, search: str = None) -> List[RoleRepresentation]:
+    def get_client_roles(self, realm: str, id: str, brief_representation: bool = False, first: int = None,
+                         max: int = None, search: str = None) -> List[RoleRepresentation]:
         """
         Get all roles for the realm or client
         
         Args:
             realm (str):  [required]
             id (str):  [required]
-            brief_representation (str): 
-            first (str): 
-            max (str): 
+            brief_representation (bool): 
+            first (int): first result to return. Ignored if negative or None.
+            max (int): maximum number of results to return. Ignored if negative or None.
             search (str): 
         
         Returns:
@@ -159,7 +159,7 @@ class RolesApi:
                                                 is_iam=True)
         return response.status_code == 204
 
-    def delete_client_role_composites(self, realm: str, id: str, role_name: str) -> bool:
+    def delete_client_role_composites(self, realm: str, id: str, role_name: str, role_representations: List[RoleRepresentation]) -> bool:
         """
         Remove roles from the role’s composite
         
@@ -167,6 +167,7 @@ class RolesApi:
             realm (str):  [required]
             id (str):  [required]
             role_name (str):  [required]
+            role_representations (List[RoleRepresentation]): Request body data [required]
         
         Returns:
             bool
@@ -175,7 +176,7 @@ class RolesApi:
             Relative path: /{realm}/clients/{id}/roles/{role_name}/composites
         """
         relative_url = f"{api_url}/{realm}/clients/{id}/roles/{role_name}/composites"
-        response = self.api_client.delete_request(relative_url=relative_url, is_iam=True)
+        response = self.api_client.delete_request(relative_url=relative_url, json=[role_representation.to_dict() for role_representation in role_representations], is_iam=True)
         return response.status_code == 204
 
     def get_client_role_composites_client(self, realm: str, id: str, role_name: str, client_uuid: str) -> List[
@@ -543,8 +544,9 @@ class RolesApi:
         response = self.api_client.get_request(relative_url=relative_url, is_iam=True)
         return ManagementPermissionReference.from_dict(response.json())
 
-    def put_role_management_permissions_by_realm_by_role_name(self, realm: str, role_name: str,
-                                                              management_permission_reference: ManagementPermissionReference) -> ManagementPermissionReference:
+    def put_role_management_permissions_by_realm_by_role_name(
+            self, realm: str, role_name: str, management_permission_reference: ManagementPermissionReference
+        ) -> ManagementPermissionReference:
         """
         Return object stating whether role Authorization permissions have been initialized or not and a reference
         
@@ -564,8 +566,9 @@ class RolesApi:
                                                json=management_permission_reference.to_dict(), is_iam=True)
         return ManagementPermissionReference.from_dict(response.json())
 
-    def get_role_users_by_realm_by_role_name(self, realm: str, role_name: str, first: bool = None, max: bool = None) -> \
-    List[UserRepresentation]:
+    def get_role_users_by_realm_by_role_name(
+            self, realm: str, role_name: str, first: bool = None, max: bool = None
+        ) -> List[UserRepresentation]:
         """
         Returns a stream of users that have the specified role name.
         

{checkmarxpythonsdk-1.7.6 → checkmarxpythonsdk-1.7.7}/CheckmarxPythonSDK/CxOne/KeycloakAPI/dto/IdentityProviderRepresentation.py

@@ -21,6 +21,7 @@ class IdentityProviderRepresentation:
     post_broker_login_flow_alias: Optional[str] = None
     config: Optional[Dict[str, Any]] = None
     update_profile_first_login: Optional[bool] = None
+    hide_on_login: Optional[bool] = None
 
     def to_dict(self) -> Dict[str, Any]:
         result: Dict[str, Any] = {}
@@ -69,6 +70,9 @@ class IdentityProviderRepresentation:
         if self.update_profile_first_login is not None:
             value = self.update_profile_first_login
             result['updateProfileFirstLogin'] = value
+        if self.hide_on_login is not None:
+            value = self.hide_on_login
+            result['hideOnLogin'] = value
         return result
 
     @classmethod

checkmarxpythonsdk-1.7.7/CheckmarxPythonSDK/CxOne/KeycloakAPI/dto/KeyUse.py

@@ -0,0 +1,22 @@
+from dataclasses import dataclass
+from typing import Dict, List, Any, Optional, Union
+from typing_extensions import Self
+from inflection import camelize, underscore
+
+
+@dataclass
+class KeyUse:
+    value: str
+
+    def to_dict(self) -> str:
+        return self.value
+
+    @classmethod
+    def from_dict(cls, data: Union[str, Dict[str, Any]]) -> Self:
+        if isinstance(data, str):
+            return cls(value=data)
+        elif isinstance(data, dict):
+            snake_data: Dict[str, Any] = {underscore(k): v for k, v in data.items()}
+            return cls(**snake_data)
+        else:
+            raise ValueError(f'Invalid data type for KeyUse: {type(data)}')

{checkmarxpythonsdk-1.7.6 → checkmarxpythonsdk-1.7.7}/CheckmarxPythonSDK/CxOne/KeycloakAPI/dto/UserRepresentation.py

@@ -11,10 +11,10 @@ from .UserProfileMetadata import UserProfileMetadata
 
 @dataclass
 class UserRepresentation:
-    username: str
-    email: str
-    first_name: str
-    last_name: str
+    username: str = None
+    email: str = None
+    first_name: str = None
+    last_name: str = None
     self: Optional[str] = None
     id: Optional[str] = None
     origin: Optional[str] = None

{checkmarxpythonsdk-1.7.6 → checkmarxpythonsdk-1.7.7}/CheckmarxPythonSDK/CxOne/__init__.py

@@ -172,6 +172,7 @@ from .projectsAPI import (
     get_branches,
     get_a_project_by_id,
     update_a_project,
+    update_specific_project_fields,
     delete_a_project,
     update_project_group,
     update_primary_branch,
@@ -383,4 +384,4 @@ from .versionsAPI import (
 )
 from .webhookAPI import (
     WebHookAPI
-)
+)

{checkmarxpythonsdk-1.7.6 → checkmarxpythonsdk-1.7.7}/CheckmarxPythonSDK/CxOne/projectsAPI.py

@@ -275,6 +275,21 @@ class ProjectsAPI(object):
         response = self.api_client.put_request(relative_url=relative_url, json=project_input.to_dict())
         return response.status_code == NO_CONTENT
 
+    def update_specific_project_fields(self, project_id: str, project_input: ProjectInput) -> bool:
+        """
+        Update specific project fields. all parameters are covered by the input sent
+        Args:
+            project_id (str):
+            project_input (ProjectInput):
+        Returns:
+            bool
+        """
+        if not project_id:
+            return False
+        relative_url = api_url + "/{id}".format(id=project_id)
+        response = self.api_client.patch_request(relative_url=relative_url, json=project_input.to_dict())
+        return response.status_code == NO_CONTENT
+
     def delete_a_project(self, project_id: str) -> bool:
         """
 
@@ -437,6 +452,10 @@ def update_a_project(project_id: str, project_input: ProjectInput) -> bool:
     return ProjectsAPI().update_a_project(project_id=project_id, project_input=project_input)
 
 
+def update_specific_project_fields(project_id: str, project_input: ProjectInput) -> bool:
+    return ProjectsAPI().update_specific_project_fields(project_id=project_id, project_input=project_input)
+
+
 def delete_a_project(project_id: str) -> bool:
     return ProjectsAPI().delete_a_project(project_id=project_id)
 

checkmarxpythonsdk-1.7.7/CheckmarxPythonSDK/__version__.py

@@ -0,0 +1 @@
+__version__ = '1.7.7'

{checkmarxpythonsdk-1.7.6 → checkmarxpythonsdk-1.7.7}/CheckmarxPythonSDK/api_client.py

@@ -252,6 +252,6 @@ class ApiClient(object):
         url = self.create_url(relative_url=relative_url, is_iam=is_iam)
         return self.call_api(method="PATCH", url=url, data=data, auth=auth, headers=headers, params=params, json=json)
 
-    def delete_request(self, relative_url, data=None, auth=None, headers=None, params=None, is_iam=False):
+    def delete_request(self, relative_url, data=None, auth=None, headers=None, params=None, json=None, is_iam=False):
         url = self.create_url(relative_url=relative_url, is_iam=is_iam)
-        return self.call_api(method="DELETE", url=url, data=data, auth=auth, headers=headers, params=params)
+        return self.call_api(method="DELETE", url=url, data=data, auth=auth, headers=headers, params=params, json=json)

{checkmarxpythonsdk-1.7.6 → checkmarxpythonsdk-1.7.7}/CheckmarxPythonSDK.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: CheckmarxPythonSDK
-Version: 1.7.6
+Version: 1.7.7
 Summary: Checkmarx Python SDK
 Home-page: https://github.com/checkmarx-ts/checkmarx-python-sdk
 Author: Happy Yang

{checkmarxpythonsdk-1.7.6 → checkmarxpythonsdk-1.7.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: CheckmarxPythonSDK
-Version: 1.7.6
+Version: 1.7.7
 Summary: Checkmarx Python SDK
 Home-page: https://github.com/checkmarx-ts/checkmarx-python-sdk
 Author: Happy Yang

checkmarxpythonsdk-1.7.6/CheckmarxPythonSDK/CxOne/KeycloakAPI/dto/KeyUse.py

@@ -1,22 +0,0 @@
-from dataclasses import dataclass
-from typing import Dict, List, Any, Optional
-from typing_extensions import Self
-from inflection import camelize, underscore
-
-
-@dataclass
-class KeyUse:
-
-    def to_dict(self) -> Dict[str, Any]:
-        result: Dict[str, Any] = {}
-        return result
-
-    @classmethod
-    def from_dict(cls, data: Dict[str, Any]) -> Self:
-        snake_data: Dict[str, Any] = {underscore(k): v for k, v in data.items()}
-
-        required_fields = []
-        missing = [f for f in required_fields if f not in snake_data]
-        if missing:
-            raise ValueError(f'missing required field: {missing}')
-        return cls(**snake_data)

checkmarxpythonsdk-1.7.6/CheckmarxPythonSDK/__version__.py

@@ -1 +0,0 @@
-__version__ = '1.7.6'