fix(client): explicit add status code for all response

Author: GG-Yanne

pygitguardian/client.py

@@ -27,11 +27,11 @@
 from .models import (
     APITokensResponse,
     CreateInvitation,
-    CreateInvitationParameter,
+    CreateInvitationParameters,
     CreateTeam,
     CreateTeamInvitation,
     CreateTeamMember,
-    CreateTeamMemberParameter,
+    CreateTeamMemberParameters,
     DeleteMemberParameters,
     Detail,
     Document,
@@ -40,7 +40,7 @@
     HoneytokenResponse,
     HoneytokenWithContextResponse,
     Invitation,
-    InvitationParameter,
+    InvitationParameters,
     JWTResponse,
     JWTService,
     Member,
@@ -56,11 +56,11 @@
     SourceParameters,
     Team,
     TeamInvitation,
-    TeamInvitationParameter,
+    TeamInvitationParameters,
     TeamMember,
-    TeamMemberParameter,
+    TeamMemberParameters,
     TeamSourceParameters,
-    TeamsParameter,
+    TeamsParameters,
     UpdateMember,
     UpdateTeam,
     UpdateTeamSource,
@@ -1005,7 +1005,7 @@ def delete_member(
 
     def list_teams(
         self,
-        parameters: Optional[TeamsParameter] = None,
+        parameters: Optional[TeamsParameters] = None,
         extra_headers: Optional[Dict[str, str]] = None,
     ) -> Union[Detail, CursorPaginatedResponse[Team]]:
         params = parameters.to_dict() if parameters else {}
@@ -1021,6 +1021,7 @@ def list_teams(
         else:
             obj = load_detail(response)
 
+        obj.status_code = response.status_code
         return obj
 
     def get_team(
@@ -1100,7 +1101,7 @@ def delete_team(
     def list_team_invitations(
         self,
         team_id: int,
-        parameters: Optional[TeamInvitationParameter] = None,
+        parameters: Optional[TeamInvitationParameters] = None,
         extra_headers: Optional[Dict[str, str]] = None,
     ) -> Union[Detail, CursorPaginatedResponse[TeamInvitation]]:
         response = self.get(
@@ -1117,6 +1118,7 @@ def list_team_invitations(
         else:
             obj = load_detail(response)
 
+        obj.status_code = response.status_code
         return obj
 
     def create_team_invitation(
@@ -1157,7 +1159,7 @@ def delete_team_invitation(
     def list_team_members(
         self,
         team_id: int,
-        parameters: Optional[TeamMemberParameter] = None,
+        parameters: Optional[TeamMemberParameters] = None,
         extra_headers: Optional[Dict[str, str]] = None,
     ) -> Union[Detail, CursorPaginatedResponse[TeamMember]]:
         response = self.get(
@@ -1174,13 +1176,14 @@ def list_team_members(
         else:
             obj = load_detail(response)
 
+        obj.status_code = response.status_code
         return obj
 
     def create_team_member(
         self,
         team_id: int,
         member: CreateTeamMember,
-        parameters: Optional[CreateTeamMemberParameter] = None,
+        parameters: Optional[CreateTeamMemberParameters] = None,
         extra_headers: Optional[Dict[str, str]] = None,
     ) -> Union[Detail, TeamMember]:
         response = self.post(
@@ -1230,6 +1233,7 @@ def list_sources(
         else:
             obj = load_detail(response)
 
+        obj.status_code = response.status_code
         return obj
 
     def list_team_sources(
@@ -1250,6 +1254,7 @@ def list_team_sources(
         else:
             obj = load_detail(response)
 
+        obj.status_code = response.status_code
         return obj
 
     def update_team_source(
@@ -1272,7 +1277,7 @@ def update_team_source(
 
     def list_invitations(
         self,
-        parameters: Optional[InvitationParameter] = None,
+        parameters: Optional[InvitationParameters] = None,
         extra_headers: Optional[Dict[str, str]] = None,
     ) -> Union[Detail, CursorPaginatedResponse[Invitation]]:
         response = self.get(
@@ -1289,12 +1294,13 @@ def list_invitations(
         else:
             obj = load_detail(response)
 
+        obj.status_code = response.status_code
         return obj
 
     def create_invitation(
         self,
         invitation: CreateInvitation,
-        parameters: Optional[CreateInvitationParameter] = None,
+        parameters: Optional[CreateInvitationParameters] = None,
         extra_headers: Optional[Dict[str, str]] = None,
     ) -> Union[Detail, Invitation]:
         response = self.post(

pygitguardian/models.py

@@ -1207,15 +1207,15 @@ class DeleteMemberParameters(Base, FromDictMixin):
 
 
 @dataclass
-class TeamsParameter(PaginationParameter, SearchParameter, FromDictMixin, ToDictMixin):
+class TeamsParameters(PaginationParameter, SearchParameter, FromDictMixin, ToDictMixin):
     is_global: Optional[bool] = None
 
 
 TeamsParameterSchema = cast(
     Type[BaseSchema],
-    marshmallow_dataclass.class_schema(TeamsParameter, base_schema=BaseSchema),
+    marshmallow_dataclass.class_schema(TeamsParameters, base_schema=BaseSchema),
 )
-TeamsParameter.SCHEMA = TeamsParameterSchema()
+TeamsParameters.SCHEMA = TeamsParameterSchema()
 
 
 @dataclass
@@ -1275,7 +1275,7 @@ class IncidentPermission(str, Enum):
 
 
 @dataclass
-class TeamInvitationParameter(PaginationParameter, ToDictMixin):
+class TeamInvitationParameters(PaginationParameter, ToDictMixin):
     invitation_id: Optional[int] = None
     is_team_leader: Optional[bool] = None
     incident_permission: Optional[IncidentPermission] = None
@@ -1292,7 +1292,7 @@ class Meta:
         exclude_none = True
 
 
-TeamInvitationParameter.SCHEMA = TeamInvitationParameterSchema()
+TeamInvitationParameters.SCHEMA = TeamInvitationParameterSchema()
 
 
 @dataclass
@@ -1351,7 +1351,7 @@ class Meta:
 
 
 @dataclass
-class TeamMemberParameter(PaginationParameter, SearchParameter, ToDictMixin):
+class TeamMemberParameters(PaginationParameter, SearchParameter, ToDictMixin):
     is_team_leader: Optional[bool] = None
     incident_permission: Optional[IncidentPermission] = None
     member_id: Optional[int] = None
@@ -1366,13 +1366,13 @@ class TeamMembershipParameterSchema(BaseSchema):
 
     @post_load
     def make_team_member_parameter(self, data: Dict[str, Any], **kwargs: Any):
-        return TeamMemberParameter(**data)
+        return TeamMemberParameters(**data)
 
     class Meta:
         exclude_none = True
 
 
-TeamMemberParameter.SCHEMA = TeamMembershipParameterSchema()
+TeamMemberParameters.SCHEMA = TeamMembershipParameterSchema()
 
 
 @dataclass
@@ -1402,17 +1402,17 @@ def make_team_member(self, data: Dict[str, Any], **kwargs: Any):
 
 
 @dataclass
-class CreateTeamMemberParameter(ToDictMixin):
-    send_email: bool
+class CreateTeamMemberParameters(ToDictMixin):
+    send_email: Optional[bool] = None
 
 
 CreateTeamMemberParameterSchema = cast(
     Type[BaseSchema],
     marshmallow_dataclass.class_schema(
-        CreateTeamMemberParameter, base_schema=BaseSchema
+        CreateTeamMemberParameters, base_schema=BaseSchema
     ),
 )
-CreateTeamMemberParameter.SCHEMA = CreateTeamMemberParameterSchema()
+CreateTeamMemberParameters.SCHEMA = CreateTeamMemberParameterSchema()
 
 
 @dataclass
@@ -1483,10 +1483,10 @@ class SourceParameters(TeamSourceParameters):
 
 
 @dataclass
-class InvitationParameter(
+class InvitationParameters(
     PaginationParameter, SearchParameter, FromDictMixin, ToDictMixin
 ):
-    ordering: Literal["date", "-date"]
+    ordering: Optional[Literal["date", "-date"]] = None
 
 
 @dataclass
@@ -1512,17 +1512,17 @@ def make_invitation(self, data: Dict[str, Any], **kwargs: Any):
 
 
 @dataclass
-class CreateInvitationParameter(FromDictMixin, ToDictMixin):
+class CreateInvitationParameters(FromDictMixin, ToDictMixin):
     send_email: Optional[bool] = None
 
 
 CreateInvitationParameterSchema = cast(
     Type[BaseSchema],
     marshmallow_dataclass.class_schema(
-        CreateInvitationParameter, base_schema=BaseSchema
+        CreateInvitationParameters, base_schema=BaseSchema
     ),
 )
-CreateInvitationParameter.SCHEMA = CreateInvitationParameterSchema()
+CreateInvitationParameters.SCHEMA = CreateInvitationParameterSchema()
 
 
 @dataclass

pygitguardian/models_utils.py

@@ -77,13 +77,15 @@ def __bool__(self) -> bool:
         return self.status_code == 200
 
 
+@dataclass
 class PaginationParameter(ToDictMixin):
     """Pagination mixin used for endpoints that support pagination."""
 
     cursor: str = ""
     per_page: int = 20
 
 
+@dataclass
 class SearchParameter(ToDictMixin):
     search: Optional[str] = None
 

tests/cassettes/test_add_team_sources.yaml

@@ -11,7 +11,7 @@ interactions:
         User-Agent:
           - pygitguardian/1.18.0 (Darwin;py3.11.8)
       method: GET
-      uri: https://api.gitguardian.com/v1/teams?is_global=False
+      uri: https://api.gitguardian.com/v1/teams?cursor=&per_page=20&is_global=False
     response:
       body:
         string:
@@ -200,7 +200,7 @@ interactions:
         User-Agent:
           - pygitguardian/1.18.0 (Darwin;py3.11.8)
       method: GET
-      uri: https://api.gitguardian.com/v1/teams/19/sources?type=azure_devops
+      uri: https://api.gitguardian.com/v1/teams/19/sources?cursor=&per_page=20&type=azure_devops
     response:
       body:
         string: '[{"id":124,"type":"azure_devops","full_name":"gg-integration-test /

tests/cassettes/test_create_team_invitation.yaml

@@ -11,7 +11,7 @@ interactions:
         User-Agent:
           - pygitguardian/1.18.0 (Darwin;py3.11.8)
       method: GET
-      uri: https://api.gitguardian.com/v1/teams?is_global=False
+      uri: https://api.gitguardian.com/v1/teams?cursor=&per_page=20&is_global=False
     response:
       body:
         string:

tests/cassettes/test_create_team_member.yaml

@@ -70,7 +70,7 @@ interactions:
         User-Agent:
           - pygitguardian/1.18.0 (Darwin;py3.11.8)
       method: GET
-      uri: https://api.gitguardian.com/v1/teams?is_global=False
+      uri: https://api.gitguardian.com/v1/teams?cursor=&per_page=20&is_global=False
     response:
       body:
         string:

tests/cassettes/test_create_team_member_parameters.yaml

@@ -70,7 +70,7 @@ interactions:
         User-Agent:
           - pygitguardian/1.18.0 (Darwin;py3.11.8)
       method: GET
-      uri: https://api.gitguardian.com/v1/teams?is_global=False
+      uri: https://api.gitguardian.com/v1/teams?cursor=&per_page=20&is_global=False
     response:
       body:
         string:

tests/cassettes/test_delete_team.yaml

@@ -11,7 +11,7 @@ interactions:
         User-Agent:
           - pygitguardian/1.18.0 (Darwin;py3.11.8)
       method: GET
-      uri: https://api.gitguardian.com/v1/teams?is_global=False
+      uri: https://api.gitguardian.com/v1/teams?cursor=&per_page=20&is_global=False
     response:
       body:
         string:

tests/cassettes/test_delete_team_invitation.yaml

@@ -11,7 +11,7 @@ interactions:
         User-Agent:
           - pygitguardian/1.18.0 (Darwin;py3.11.8)
       method: GET
-      uri: https://api.gitguardian.com/v1/teams?is_global=False
+      uri: https://api.gitguardian.com/v1/teams?cursor=&per_page=20&is_global=False
     response:
       body:
         string:

tests/cassettes/test_delete_team_member.yaml

@@ -70,7 +70,7 @@ interactions:
         User-Agent:
           - pygitguardian/1.18.0 (Darwin;py3.11.8)
       method: GET
-      uri: https://api.gitguardian.com/v1/teams?is_global=False
+      uri: https://api.gitguardian.com/v1/teams?cursor=&per_page=20&is_global=False
     response:
       body:
         string:

tests/cassettes/test_delete_team_sources.yaml

@@ -11,7 +11,7 @@ interactions:
         User-Agent:
           - pygitguardian/1.18.0 (Darwin;py3.11.8)
       method: GET
-      uri: https://api.gitguardian.com/v1/teams?is_global=False
+      uri: https://api.gitguardian.com/v1/teams?cursor=&per_page=20&is_global=False
     response:
       body:
         string:

tests/cassettes/test_get_team.yaml

@@ -11,7 +11,7 @@ interactions:
         User-Agent:
           - pygitguardian/1.18.0 (Darwin;py3.11.8)
       method: GET
-      uri: https://api.gitguardian.com/v1/teams?is_global=False
+      uri: https://api.gitguardian.com/v1/teams?cursor=&per_page=20&is_global=False
     response:
       body:
         string:

tests/cassettes/test_global_team.yaml

@@ -11,7 +11,7 @@ interactions:
         User-Agent:
           - pygitguardian/1.18.0 (Darwin;py3.11.8)
       method: GET
-      uri: https://api.gitguardian.com/v1/teams?is_global=True
+      uri: https://api.gitguardian.com/v1/teams?cursor=&per_page=20&is_global=True
     response:
       body:
         string: '[{"id":6,"is_global":true,"name":"All incidents","description":null,"gitguardian_url":"http://localhost:3000/workspace/6/settings/user/teams/6"}]'

tests/cassettes/test_list_team_invitations.yaml

@@ -11,7 +11,7 @@ interactions:
         User-Agent:
           - pygitguardian/1.18.0 (Darwin;py3.11.8)
       method: GET
-      uri: https://api.gitguardian.com/v1/teams?is_global=False
+      uri: https://api.gitguardian.com/v1/teams?cursor=&per_page=20&is_global=False
     response:
       body:
         string:

tests/cassettes/test_list_team_members.yaml

@@ -11,7 +11,7 @@ interactions:
         User-Agent:
           - pygitguardian/1.18.0 (Darwin;py3.11.8)
       method: GET
-      uri: https://api.gitguardian.com/v1/teams?is_global=False
+      uri: https://api.gitguardian.com/v1/teams?cursor=&per_page=20&is_global=False
     response:
       body:
         string:

tests/cassettes/test_list_teams_sources.yaml

@@ -11,7 +11,7 @@ interactions:
         User-Agent:
           - pygitguardian/1.18.0 (Darwin;py3.11.8)
       method: GET
-      uri: https://api.gitguardian.com/v1/teams?is_global=False
+      uri: https://api.gitguardian.com/v1/teams?cursor=&per_page=20&is_global=False
     response:
       body:
         string: