Add find invitation by token method (#274)

Author: blairworkos

tests/test_user_management.py

@@ -1047,6 +1047,18 @@ def test_get_invitation(self, mock_invitation, capture_and_mock_request):
         assert url[0].endswith("user_management/invitations/invitation_ABCDE")
         assert invitation["id"] == "invitation_ABCDE"
 
+    def test_find_invitation_by_token(self, mock_invitation, capture_and_mock_request):
+        url, request_kwargs = capture_and_mock_request("get", mock_invitation, 200)
+
+        invitation = self.user_management.find_invitation_by_token(
+            "Z1uX3RbwcIl5fIGJJJCXXisdI"
+        )
+
+        assert url[0].endswith(
+            "user_management/invitations/by_token/Z1uX3RbwcIl5fIGJJJCXXisdI"
+        )
+        assert invitation["token"] == "Z1uX3RbwcIl5fIGJJJCXXisdI"
+
     def test_list_invitations_returns_metadata(
         self,
         mock_invitations,

workos/user_management.py

@@ -49,6 +49,7 @@
 EMAIL_VERIFICATION_DETAIL_PATH = "user_management/email_verification/{0}"
 INVITATION_PATH = "user_management/invitations"
 INVITATION_DETAIL_PATH = "user_management/invitations/{0}"
+INVITATION_DETAIL_BY_TOKEN_PATH = "user_management/invitations/by_token/{0}"
 INVITATION_REVOKE_PATH = "user_management/invitations/{0}/revoke"
 PASSWORD_RESET_PATH = "user_management/password_reset"
 PASSWORD_RESET_DETAIL_PATH = "user_management/password_reset/{0}"
@@ -1205,6 +1206,26 @@ def get_invitation(self, invitation_id):
 
         return WorkOSInvitation.construct_from_response(response).to_dict()
 
+    def find_invitation_by_token(self, invitation_token):
+        """Get the details of an invitation.
+
+        Args:
+            invitation_token (str) -  The token of the Invitation.
+
+        Returns:
+            dict: Invitation response from WorkOS.
+        """
+        headers = {}
+
+        response = self.request_helper.request(
+            INVITATION_DETAIL_BY_TOKEN_PATH.format(invitation_token),
+            method=REQUEST_METHOD_GET,
+            headers=headers,
+            token=workos.api_key,
+        )
+
+        return WorkOSInvitation.construct_from_response(response).to_dict()
+
     def list_invitations(
         self,
         email=None,