feat(chat): add Pylon identity verification for chat widget

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 172
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gitpod%2Fgitpod-888178c57cb0f9d7aede8f3fc5ec24bd62f619b728f00716f352b3b5a2fa306d.yml
-openapi_spec_hash: 701f004e9dcb6dd3472d8468a789c338
-config_hash: 8758ac1f8d8913bd960a98b4f05d6391
+configured_endpoints: 173
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gitpod%2Fgitpod-51c0e9db3fb9e3aadf35fb4fcf76107a2fcd9da1b8ff6cd593c1ae23d1a24bc3.yml
+openapi_spec_hash: db222df8620e2270763bef95ff247445
+config_hash: 2fa5dd58c6ab4dd15de320fa0f85dde8

api.md

@@ -42,6 +42,7 @@ from gitpod.types import (
     JoinableOrganization,
     LoginProvider,
     AccountRetrieveResponse,
+    AccountGetChatIdentityTokenResponse,
     AccountGetSSOLoginURLResponse,
     AccountListSSOLoginsResponse,
 )
@@ -51,6 +52,7 @@ Methods:
 
 - <code title="post /gitpod.v1.AccountService/GetAccount">client.accounts.<a href="./src/gitpod/resources/accounts.py">retrieve</a>(\*\*<a href="src/gitpod/types/account_retrieve_params.py">params</a>) -> <a href="./src/gitpod/types/account_retrieve_response.py">AccountRetrieveResponse</a></code>
 - <code title="post /gitpod.v1.AccountService/DeleteAccount">client.accounts.<a href="./src/gitpod/resources/accounts.py">delete</a>(\*\*<a href="src/gitpod/types/account_delete_params.py">params</a>) -> object</code>
+- <code title="post /gitpod.v1.AccountService/GetChatIdentityToken">client.accounts.<a href="./src/gitpod/resources/accounts.py">get_chat_identity_token</a>(\*\*<a href="src/gitpod/types/account_get_chat_identity_token_params.py">params</a>) -> <a href="./src/gitpod/types/account_get_chat_identity_token_response.py">AccountGetChatIdentityTokenResponse</a></code>
 - <code title="post /gitpod.v1.AccountService/GetSSOLoginURL">client.accounts.<a href="./src/gitpod/resources/accounts.py">get_sso_login_url</a>(\*\*<a href="src/gitpod/types/account_get_sso_login_url_params.py">params</a>) -> <a href="./src/gitpod/types/account_get_sso_login_url_response.py">AccountGetSSOLoginURLResponse</a></code>
 - <code title="post /gitpod.v1.AccountService/ListJoinableOrganizations">client.accounts.<a href="./src/gitpod/resources/accounts.py">list_joinable_organizations</a>(\*\*<a href="src/gitpod/types/account_list_joinable_organizations_params.py">params</a>) -> <a href="./src/gitpod/types/joinable_organization.py">SyncJoinableOrganizationsPage[JoinableOrganization]</a></code>
 - <code title="post /gitpod.v1.AccountService/ListLoginProviders">client.accounts.<a href="./src/gitpod/resources/accounts.py">list_login_providers</a>(\*\*<a href="src/gitpod/types/account_list_login_providers_params.py">params</a>) -> <a href="./src/gitpod/types/login_provider.py">SyncLoginProvidersPage[LoginProvider]</a></code>

src/gitpod/resources/accounts.py

@@ -12,6 +12,7 @@
     account_list_sso_logins_params,
     account_get_sso_login_url_params,
     account_list_login_providers_params,
+    account_get_chat_identity_token_params,
     account_list_joinable_organizations_params,
 )
 from .._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
@@ -38,6 +39,7 @@
 from ..types.account_retrieve_response import AccountRetrieveResponse
 from ..types.account_list_sso_logins_response import AccountListSSOLoginsResponse
 from ..types.account_get_sso_login_url_response import AccountGetSSOLoginURLResponse
+from ..types.account_get_chat_identity_token_response import AccountGetChatIdentityTokenResponse
 
 __all__ = ["AccountsResource", "AsyncAccountsResource"]
 
@@ -170,6 +172,58 @@ def delete(
             cast_to=object,
         )
 
+    def get_chat_identity_token(
+        self,
+        *,
+        empty: bool | Omit = omit,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> AccountGetChatIdentityTokenResponse:
+        """
+        Gets the chat identity token for the currently authenticated account.
+
+        Use this method to:
+
+        - Obtain a verification hash for in-app chat identity verification
+        - Secure chat sessions against impersonation
+
+        The returned hash is an HMAC-SHA256 signature of the account's email, used by
+        the chat widget to verify user identity.
+
+        ### Examples
+
+        - Get chat identity token:
+
+          Retrieves the identity verification hash for the authenticated account.
+
+          ```yaml
+          {}
+          ```
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return self._post(
+            "/gitpod.v1.AccountService/GetChatIdentityToken",
+            body=maybe_transform(
+                {"empty": empty}, account_get_chat_identity_token_params.AccountGetChatIdentityTokenParams
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=AccountGetChatIdentityTokenResponse,
+        )
+
     def get_sso_login_url(
         self,
         *,
@@ -580,6 +634,58 @@ async def delete(
             cast_to=object,
         )
 
+    async def get_chat_identity_token(
+        self,
+        *,
+        empty: bool | Omit = omit,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+    ) -> AccountGetChatIdentityTokenResponse:
+        """
+        Gets the chat identity token for the currently authenticated account.
+
+        Use this method to:
+
+        - Obtain a verification hash for in-app chat identity verification
+        - Secure chat sessions against impersonation
+
+        The returned hash is an HMAC-SHA256 signature of the account's email, used by
+        the chat widget to verify user identity.
+
+        ### Examples
+
+        - Get chat identity token:
+
+          Retrieves the identity verification hash for the authenticated account.
+
+          ```yaml
+          {}
+          ```
+
+        Args:
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+        """
+        return await self._post(
+            "/gitpod.v1.AccountService/GetChatIdentityToken",
+            body=await async_maybe_transform(
+                {"empty": empty}, account_get_chat_identity_token_params.AccountGetChatIdentityTokenParams
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=AccountGetChatIdentityTokenResponse,
+        )
+
     async def get_sso_login_url(
         self,
         *,
@@ -872,6 +978,9 @@ def __init__(self, accounts: AccountsResource) -> None:
         self.delete = to_raw_response_wrapper(
             accounts.delete,
         )
+        self.get_chat_identity_token = to_raw_response_wrapper(
+            accounts.get_chat_identity_token,
+        )
         self.get_sso_login_url = to_raw_response_wrapper(
             accounts.get_sso_login_url,
         )
@@ -896,6 +1005,9 @@ def __init__(self, accounts: AsyncAccountsResource) -> None:
         self.delete = async_to_raw_response_wrapper(
             accounts.delete,
         )
+        self.get_chat_identity_token = async_to_raw_response_wrapper(
+            accounts.get_chat_identity_token,
+        )
         self.get_sso_login_url = async_to_raw_response_wrapper(
             accounts.get_sso_login_url,
         )
@@ -920,6 +1032,9 @@ def __init__(self, accounts: AccountsResource) -> None:
         self.delete = to_streamed_response_wrapper(
             accounts.delete,
         )
+        self.get_chat_identity_token = to_streamed_response_wrapper(
+            accounts.get_chat_identity_token,
+        )
         self.get_sso_login_url = to_streamed_response_wrapper(
             accounts.get_sso_login_url,
         )
@@ -944,6 +1059,9 @@ def __init__(self, accounts: AsyncAccountsResource) -> None:
         self.delete = async_to_streamed_response_wrapper(
             accounts.delete,
         )
+        self.get_chat_identity_token = async_to_streamed_response_wrapper(
+            accounts.get_chat_identity_token,
+        )
         self.get_sso_login_url = async_to_streamed_response_wrapper(
             accounts.get_sso_login_url,
         )

src/gitpod/types/__init__.py

@@ -227,6 +227,9 @@
 from .runner_check_repository_access_params import (
     RunnerCheckRepositoryAccessParams as RunnerCheckRepositoryAccessParams,
 )
+from .account_get_chat_identity_token_params import (
+    AccountGetChatIdentityTokenParams as AccountGetChatIdentityTokenParams,
+)
 from .environment_create_from_project_params import (
     EnvironmentCreateFromProjectParams as EnvironmentCreateFromProjectParams,
 )
@@ -242,6 +245,9 @@
 from .runner_check_repository_access_response import (
     RunnerCheckRepositoryAccessResponse as RunnerCheckRepositoryAccessResponse,
 )
+from .account_get_chat_identity_token_response import (
+    AccountGetChatIdentityTokenResponse as AccountGetChatIdentityTokenResponse,
+)
 from .environment_create_from_project_response import (
     EnvironmentCreateFromProjectResponse as EnvironmentCreateFromProjectResponse,
 )

src/gitpod/types/account_get_chat_identity_token_params.py

@@ -0,0 +1,11 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["AccountGetChatIdentityTokenParams"]
+
+
+class AccountGetChatIdentityTokenParams(TypedDict, total=False):
+    empty: bool

src/gitpod/types/account_get_chat_identity_token_response.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["AccountGetChatIdentityTokenResponse"]
+
+
+class AccountGetChatIdentityTokenResponse(BaseModel):
+    email_hash: str = FieldInfo(alias="emailHash")
+    """
+    email_hash is the HMAC-SHA256 hash of the account's email address, used for chat
+    widget identity verification
+    """

tests/api_resources/test_accounts.py

@@ -15,6 +15,7 @@
     AccountRetrieveResponse,
     AccountListSSOLoginsResponse,
     AccountGetSSOLoginURLResponse,
+    AccountGetChatIdentityTokenResponse,
 )
 from gitpod.pagination import (
     SyncLoginsPage,
@@ -110,6 +111,42 @@ def test_streaming_response_delete(self, client: Gitpod) -> None:
 
         assert cast(Any, response.is_closed) is True
 
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    def test_method_get_chat_identity_token(self, client: Gitpod) -> None:
+        account = client.accounts.get_chat_identity_token()
+        assert_matches_type(AccountGetChatIdentityTokenResponse, account, path=["response"])
+
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    def test_method_get_chat_identity_token_with_all_params(self, client: Gitpod) -> None:
+        account = client.accounts.get_chat_identity_token(
+            empty=True,
+        )
+        assert_matches_type(AccountGetChatIdentityTokenResponse, account, path=["response"])
+
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    def test_raw_response_get_chat_identity_token(self, client: Gitpod) -> None:
+        response = client.accounts.with_raw_response.get_chat_identity_token()
+
+        assert response.is_closed is True
+        assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+        account = response.parse()
+        assert_matches_type(AccountGetChatIdentityTokenResponse, account, path=["response"])
+
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    def test_streaming_response_get_chat_identity_token(self, client: Gitpod) -> None:
+        with client.accounts.with_streaming_response.get_chat_identity_token() as response:
+            assert not response.is_closed
+            assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+
+            account = response.parse()
+            assert_matches_type(AccountGetChatIdentityTokenResponse, account, path=["response"])
+
+        assert cast(Any, response.is_closed) is True
+
     @pytest.mark.skip(reason="Prism tests are disabled")
     @parametrize
     def test_method_get_sso_login_url(self, client: Gitpod) -> None:
@@ -373,6 +410,42 @@ async def test_streaming_response_delete(self, async_client: AsyncGitpod) -> Non
 
         assert cast(Any, response.is_closed) is True
 
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    async def test_method_get_chat_identity_token(self, async_client: AsyncGitpod) -> None:
+        account = await async_client.accounts.get_chat_identity_token()
+        assert_matches_type(AccountGetChatIdentityTokenResponse, account, path=["response"])
+
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    async def test_method_get_chat_identity_token_with_all_params(self, async_client: AsyncGitpod) -> None:
+        account = await async_client.accounts.get_chat_identity_token(
+            empty=True,
+        )
+        assert_matches_type(AccountGetChatIdentityTokenResponse, account, path=["response"])
+
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    async def test_raw_response_get_chat_identity_token(self, async_client: AsyncGitpod) -> None:
+        response = await async_client.accounts.with_raw_response.get_chat_identity_token()
+
+        assert response.is_closed is True
+        assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+        account = await response.parse()
+        assert_matches_type(AccountGetChatIdentityTokenResponse, account, path=["response"])
+
+    @pytest.mark.skip(reason="Prism tests are disabled")
+    @parametrize
+    async def test_streaming_response_get_chat_identity_token(self, async_client: AsyncGitpod) -> None:
+        async with async_client.accounts.with_streaming_response.get_chat_identity_token() as response:
+            assert not response.is_closed
+            assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+
+            account = await response.parse()
+            assert_matches_type(AccountGetChatIdentityTokenResponse, account, path=["response"])
+
+        assert cast(Any, response.is_closed) is True
+
     @pytest.mark.skip(reason="Prism tests are disabled")
     @parametrize
     async def test_method_get_sso_login_url(self, async_client: AsyncGitpod) -> None: