Merge pull request #101 from code42/bugfix/user-risk-profile-page-param

fix `page` query param in user-risk-profile query

Author: timabrmsn

CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+ All notable changes to this project will be documented in this file.
+
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+ The intended audience of this file is for `incydr` SDK and CLI consumers -- as such, changes that don't affect
+ how a consumer would use the library or CLI tool (e.g. adding unit tests, updating documentation, etc) are not captured
+ here.
+
+## 1.0.1 2023-04-21
+
+### Fixed
+
+- Bug in the `user_risk_profile` client, where `get_page()` was using the incorrect query param for the page number.
+- Bug in `AuditEventsPage` model that prevented some audit log events from being parsed correctly.

src/_incydr_sdk/__version__.py

@@ -1,4 +1,4 @@
 # SPDX-FileCopyrightText: 2022-present Code42 Software <integrations@code42.com>
 #
 # SPDX-License-Identifier: MIT
-__version__ = "1.0.0"
+__version__ = "1.0.1"

src/_incydr_sdk/user_risk_profiles/client.py

@@ -97,7 +97,7 @@ def get_page(
         """
         page_size = page_size or self._parent.settings.page_size
         data = QueryUserRiskProfilesRequest(
-            page_num=page_num,
+            page=page_num,
             page_size=page_size,
             manager_id=manager_id,
             title=title,

src/_incydr_sdk/user_risk_profiles/models.py

@@ -3,10 +3,10 @@
 from typing import List
 from typing import Optional
 
-from pydantic import BaseModel
 from pydantic import Field
 from rich.markdown import Markdown
 
+from _incydr_sdk.core.models import Model
 from _incydr_sdk.core.models import ResponseModel
 
 
@@ -125,8 +125,8 @@ class UserRiskProfilesPage(ResponseModel):
     )
 
 
-class QueryUserRiskProfilesRequest(BaseModel):
-    page_num: Optional[int]
+class QueryUserRiskProfilesRequest(Model):
+    page: Optional[int]
     page_size: Optional[int]
     manager_id: Optional[str]
     title: Optional[str]
@@ -144,7 +144,7 @@ class Config:
         use_enum_values = True
 
 
-class UpdateUserRiskProfileRequest(BaseModel):
+class UpdateUserRiskProfileRequest(Model):
     endDate: Optional[Date] = None
     notes: Optional[str] = Field(
         None,
@@ -154,14 +154,14 @@ class UpdateUserRiskProfileRequest(BaseModel):
     startDate: Optional[Date] = None
 
 
-class AddCloudAliasesRequest(BaseModel):
+class AddCloudAliasesRequest(Model):
     cloudAliases: Optional[List[str]] = None
     userId: Optional[str] = Field(
         None, description="The ID of the user to add cloud aliases.", example="123"
     )
 
 
-class DeleteCloudAliasesRequest(BaseModel):
+class DeleteCloudAliasesRequest(Model):
     cloudAliases: Optional[List[str]] = None
     userId: Optional[str] = Field(
         None, description="The ID of the user to delete cloud aliases.", example="123"

tests/test_user_risk_profiles.py

@@ -158,10 +158,10 @@ def test_iter_all_when_default_params_returns_expected_data(
     httpserver_auth: HTTPServer,
 ):
     query_1 = {
-        "page_num": 1,
+        "page": 1,
         "page_size": 2,
     }
-    query_2 = {"page_num": 2, "page_size": 2}
+    query_2 = {"page": 2, "page_size": 2}
 
     user_risk_profile_data_1 = {
         "userRiskProfiles": [TEST_USER_RISK_PROFILE_1, TEST_USER_RISK_PROFILE_2],
@@ -243,7 +243,7 @@ def test_delete_cloud_alias_when_default_params_returns_expected_data(
 
 def test_cli_list_makes_expected_call(httpserver_auth: HTTPServer, runner):
     query_1 = {
-        "page_num": 1,
+        "page": 1,
         "page_size": 100,
     }
     user_risk_profile_data_1 = {