feat(client): add invitation related endpoints

Author: GG-Yanne

pygitguardian/client.py

@@ -26,6 +26,8 @@
 )
 from .models import (
     APITokensResponse,
+    CreateInvitation,
+    CreateInvitationParameter,
     CreateTeam,
     CreateTeamInvitation,
     CreateTeamMember,
@@ -37,6 +39,8 @@
     HealthCheckResponse,
     HoneytokenResponse,
     HoneytokenWithContextResponse,
+    Invitation,
+    InvitationParameter,
     JWTResponse,
     JWTService,
     Member,
@@ -929,7 +933,7 @@ def list_members(
 
         response = self.get(
             endpoint="members",
-            data=query_parameters.to_dict() if query_parameters else {},
+            params=query_parameters.to_dict() if query_parameters else {},
             extra_headers=extra_headers,
         )
 
@@ -1106,7 +1110,7 @@ def list_team_invitations(
     ) -> Union[Detail, CursorPaginatedResponse[TeamInvitation]]:
         response = self.get(
             endpoint=f"teams/{team_id}/team_invitations",
-            data=parameters.to_dict() if parameters else {},
+            params=parameters.to_dict() if parameters else {},
             extra_headers=extra_headers,
         )
 
@@ -1166,7 +1170,7 @@ def list_team_members(
     ) -> Union[Detail, CursorPaginatedResponse[TeamMember]]:
         response = self.get(
             endpoint=f"teams/{team_id}/team_memberships",
-            data=parameters.to_dict() if parameters else {},
+            params=parameters.to_dict() if parameters else {},
             extra_headers=extra_headers,
         )
 
@@ -1225,7 +1229,7 @@ def list_sources(
     ) -> Union[Detail, CursorPaginatedResponse[Source]]:
         response = self.get(
             endpoint="sources",
-            data=parameters.to_dict() if parameters else {},
+            params=parameters.to_dict() if parameters else {},
             extra_headers=extra_headers,
         )
 
@@ -1246,7 +1250,7 @@ def list_teams_sources(
     ) -> Union[Detail, CursorPaginatedResponse[Source]]:
         response = self.get(
             endpoint=f"teams/{team_id}/sources",
-            data=parameters.to_dict() if parameters else {},
+            params=parameters.to_dict() if parameters else {},
             extra_headers=extra_headers,
         )
 
@@ -1278,3 +1282,61 @@ def update_team_source(
             return 204
 
         return load_detail(response)
+
+    def list_invitations(
+        self,
+        parameters: Optional[InvitationParameter] = None,
+        extra_headers: Optional[Dict[str, str]] = None,
+    ) -> Union[Detail, CursorPaginatedResponse[Invitation]]:
+        response = self.get(
+            endpoint="invitations",
+            params=parameters.to_dict() if parameters else {},
+            extra_headers=extra_headers,
+        )
+
+        obj: Union[Detail, CursorPaginatedResponse[Invitation]]
+        if is_ok(response):
+            obj = CursorPaginatedResponse[Invitation].from_response(
+                response, Invitation
+            )
+        else:
+            obj = load_detail(response)
+
+        obj.status_code
+        return obj
+
+    def send_invitation(
+        self,
+        invitation: CreateInvitation,
+        parameters: Optional[CreateInvitationParameter] = None,
+        extra_headers: Optional[Dict[str, str]] = None,
+    ) -> Union[Detail, Invitation]:
+        response = self.post(
+            endpoint="invitations",
+            data=CreateInvitation.to_dict(invitation),
+            params=parameters.to_dict() if parameters else {},
+            extra_headers=extra_headers,
+        )
+
+        obj: Union[Detail, Invitation]
+        if is_create_ok(response):
+            obj = Invitation.from_dict(response.json())
+        else:
+            obj = load_detail(response)
+
+        obj.status_code = response.status_code
+        return obj
+
+    def delete_invitation(
+        self,
+        invitation_id: int,
+        extra_headers: Optional[Dict[str, str]] = None,
+    ) -> Union[Detail, int]:
+        response = self.delete(
+            endpoint=f"invitations/{invitation_id}", extra_headers=extra_headers
+        )
+
+        if is_delete_ok(response):
+            return response.status_code
+
+        return load_detail(response)

pygitguardian/models.py

@@ -1199,10 +1199,16 @@ class MembersParameters(PaginationParameter, SearchParameter, ToDictMixin):
     ] = None
 
 
-MembersParametersSchema = cast(
-    Type[BaseSchema],
-    marshmallow_dataclass.class_schema(MembersParameters, base_schema=BaseSchema),
-)
+class MembersParametersSchema(BaseSchema):
+    access_level = fields.Enum(AccessLevel, by_value=True, allow_none=True)
+    active = fields.Bool(allow_none=True)
+    ordering = fields.Str(allow_none=True)
+
+    @post_load
+    def return_members_parameters(self, data: dict[str, Any], **kwargs: dict[str, Any]):
+        return MembersParameters(**data)
+
+
 MembersParameters.SCHEMA = MembersParametersSchema()
 
 
@@ -1565,3 +1571,64 @@ class SourceParameters(TeamSourceParameters):
     marshmallow_dataclass.class_schema(SourceParameters, base_schema=BaseSchema),
 )
 SourceParameters.SCHEMA = SourceParametersSchema()
+
+
+@dataclass
+class InvitationParameter(
+    PaginationParameter, SearchParameter, FromDictMixin, ToDictMixin
+):
+    ordering: Literal["date", "-date"]
+
+
+@dataclass
+class Invitation(Base, FromDictMixin):
+    id: int
+    email: str
+    access_level: AccessLevel
+    date: datetime
+
+
+class InvitationSchema(BaseSchema):
+    id = fields.Int(required=True)
+    email = fields.Str(required=True)
+    access_level = fields.Enum(AccessLevel, by_value=True, required=True)
+    date = fields.DateTime(required=True)
+
+    @post_load
+    def return_invitation(self, data: dict[str, Any], **kwargs: dict[str, Any]):
+        return Invitation(**data)
+
+
+Invitation.SCHEMA = InvitationSchema()
+
+
+@dataclass
+class CreateInvitationParameter(FromDictMixin, ToDictMixin):
+    send_email: Optional[bool] = None
+
+
+CreateInvitationParameterSchema = cast(
+    Type[BaseSchema],
+    marshmallow_dataclass.class_schema(
+        CreateInvitationParameter, base_schema=BaseSchema
+    ),
+)
+CreateInvitationParameter.SCHEMA = CreateInvitationParameterSchema()
+
+
+@dataclass
+class CreateInvitation(FromDictMixin, ToDictMixin):
+    email: str
+    access_level: AccessLevel
+
+
+class CreateInvitationSchema(BaseSchema):
+    email = fields.Str(required=True)
+    access_level = fields.Enum(AccessLevel, by_value=True, required=True)
+
+    @post_load
+    def return_invitation(self, data: dict[str, Any], **kwargs: dict[str, Any]):
+        return CreateInvitation(**data)
+
+
+CreateInvitation.SCHEMA = CreateInvitationSchema()

tests/cassettes/test_delete_invitation.yaml

@@ -0,0 +1,54 @@
+interactions:
+  - request:
+      body: null
+      headers:
+        Accept:
+          - '*/*'
+        Accept-Encoding:
+          - gzip, deflate
+        Connection:
+          - keep-alive
+        Content-Length:
+          - '0'
+        User-Agent:
+          - pygitguardian/1.18.0 (Darwin;py3.11.8)
+      method: DELETE
+      uri: https://api.gitguardian.com/v1/invitations/2
+    response:
+      body:
+        string: ''
+      headers:
+        Access-Control-Expose-Headers:
+          - X-App-Version
+        Allow:
+          - DELETE, OPTIONS
+        Connection:
+          - keep-alive
+        Content-Length:
+          - '0'
+        Cross-Origin-Opener-Policy:
+          - same-origin
+        Date:
+          - Fri, 06 Dec 2024 13:38:57 GMT
+        Referrer-Policy:
+          - same-origin
+        Server:
+          - nginx/1.24.0
+        Vary:
+          - Cookie
+        X-App-Version:
+          - dev
+        X-Content-Type-Options:
+          - nosniff
+        X-Frame-Options:
+          - DENY
+        X-Request-ID:
+          - fd715a797aabb2eddf49823db3e54209
+        X-SCA-Engine-Version:
+          - 2.2.0
+        X-Secrets-Engine-Version:
+          - 2.127.0
+      status:
+        code: 204
+        message: No Content
+version: 1

tests/cassettes/test_list_invitations.yaml

@@ -0,0 +1,58 @@
+interactions:
+  - request:
+      body: null
+      headers:
+        Accept:
+          - '*/*'
+        Accept-Encoding:
+          - gzip, deflate
+        Connection:
+          - keep-alive
+        User-Agent:
+          - pygitguardian/1.18.0 (Darwin;py3.11.8)
+      method: GET
+      uri: https://api.gitguardian.com/v1/invitations
+    response:
+      body:
+        string: '[{"id":1,"date":"2024-12-05T17:35:12.273332Z","email":"[email protected]","role":"member","access_level":"member"}]'
+      headers:
+        Access-Control-Expose-Headers:
+          - X-App-Version
+        Allow:
+          - GET, POST, HEAD, OPTIONS
+        Connection:
+          - keep-alive
+        Content-Length:
+          - '114'
+        Content-Type:
+          - application/json
+        Cross-Origin-Opener-Policy:
+          - same-origin
+        Date:
+          - Fri, 06 Dec 2024 13:33:31 GMT
+        Link:
+          - ''
+        Referrer-Policy:
+          - same-origin
+        Server:
+          - nginx/1.24.0
+        Vary:
+          - Cookie
+        X-App-Version:
+          - dev
+        X-Content-Type-Options:
+          - nosniff
+        X-Frame-Options:
+          - DENY
+        X-Per-Page:
+          - '20'
+        X-Request-ID:
+          - 182ad8123736b9315def7a957569ef89
+        X-SCA-Engine-Version:
+          - 2.2.0
+        X-Secrets-Engine-Version:
+          - 2.127.0
+      status:
+        code: 200
+        message: OK
+version: 1

tests/cassettes/test_list_members_parameters.yaml

@@ -0,0 +1,58 @@
+interactions:
+  - request:
+      body: null
+      headers:
+        Accept:
+          - '*/*'
+        Accept-Encoding:
+          - gzip, deflate
+        Connection:
+          - keep-alive
+        User-Agent:
+          - pygitguardian/1.18.0 (Darwin;py3.11.8)
+      method: GET
+      uri: https://api.gitguardian.com/v1/members?access_level=manager
+    response:
+      body:
+        string: '[]'
+      headers:
+        Access-Control-Expose-Headers:
+          - X-App-Version
+        Allow:
+          - GET, HEAD, OPTIONS
+        Connection:
+          - keep-alive
+        Content-Length:
+          - '2'
+        Content-Type:
+          - application/json
+        Cross-Origin-Opener-Policy:
+          - same-origin
+        Date:
+          - Fri, 06 Dec 2024 13:53:52 GMT
+        Link:
+          - ''
+        Referrer-Policy:
+          - same-origin
+        Server:
+          - nginx/1.24.0
+        Vary:
+          - Cookie
+        X-App-Version:
+          - dev
+        X-Content-Type-Options:
+          - nosniff
+        X-Frame-Options:
+          - DENY
+        X-Per-Page:
+          - '20'
+        X-Request-ID:
+          - 345625b0c1e6c814a9b997bd7ea3ea96
+        X-SCA-Engine-Version:
+          - 2.2.0
+        X-Secrets-Engine-Version:
+          - 2.127.0
+      status:
+        code: 200
+        message: OK
+version: 1