feat(api): update via SDK Studio

Author: stainless-bot

README.md

@@ -29,7 +29,7 @@ from intercom import Intercom
 
 client = Intercom(
     # This is the default and can be omitted
-    api_key=os.environ.get("INTERCOM_API_KEY"),
+    access_token=os.environ.get("INTERCOM_ACCESS_TOKEN"),
     # or 'production' | 'environment_2'; defaults to "production".
     environment="environment_1",
 )
@@ -38,10 +38,10 @@ admin_with_app = client.me.retrieve()
 print(admin_with_app.id)
 ```
 
-While you can provide an `api_key` keyword argument,
+While you can provide a `access_token` keyword argument,
 we recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)
-to add `INTERCOM_API_KEY="My API Key"` to your `.env` file
-so that your API Key is not stored in source control.
+to add `INTERCOM_ACCESS_TOKEN="My Access Token"` to your `.env` file
+so that your Access Token is not stored in source control.
 
 ## Async usage
 
@@ -54,7 +54,7 @@ from intercom import AsyncIntercom
 
 client = AsyncIntercom(
     # This is the default and can be omitted
-    api_key=os.environ.get("INTERCOM_API_KEY"),
+    access_token=os.environ.get("INTERCOM_ACCESS_TOKEN"),
     # or 'production' | 'environment_2'; defaults to "production".
     environment="environment_1",
 )

src/intercom/_client.py

@@ -80,14 +80,14 @@ class Intercom(SyncAPIClient):
     with_streaming_response: IntercomWithStreamedResponse
 
     # client options
-    api_key: str
+    access_token: str
 
     _environment: Literal["production", "environment_1", "environment_2"] | NotGiven
 
     def __init__(
         self,
         *,
-        api_key: str | None = None,
+        access_token: str | None = None,
         environment: Literal["production", "environment_1", "environment_2"] | NotGiven = NOT_GIVEN,
         base_url: str | httpx.URL | None | NotGiven = NOT_GIVEN,
         timeout: Union[float, Timeout, None, NotGiven] = NOT_GIVEN,
@@ -110,15 +110,15 @@ def __init__(
     ) -> None:
         """Construct a new synchronous intercom client instance.
 
-        This automatically infers the `api_key` argument from the `INTERCOM_API_KEY` environment variable if it is not provided.
+        This automatically infers the `access_token` argument from the `INTERCOM_ACCESS_TOKEN` environment variable if it is not provided.
         """
-        if api_key is None:
-            api_key = os.environ.get("INTERCOM_API_KEY")
-        if api_key is None:
+        if access_token is None:
+            access_token = os.environ.get("INTERCOM_ACCESS_TOKEN")
+        if access_token is None:
             raise IntercomError(
-                "The api_key client option must be set either by passing api_key to the client or by setting the INTERCOM_API_KEY environment variable"
+                "The access_token client option must be set either by passing access_token to the client or by setting the INTERCOM_ACCESS_TOKEN environment variable"
             )
-        self.api_key = api_key
+        self.access_token = access_token
 
         self._environment = environment
 
@@ -191,8 +191,8 @@ def qs(self) -> Querystring:
     @property
     @override
     def auth_headers(self) -> dict[str, str]:
-        api_key = self.api_key
-        return {"Authorization": f"Bearer {api_key}"}
+        access_token = self.access_token
+        return {"Authorization": f"Bearer {access_token}"}
 
     @property
     @override
@@ -206,7 +206,7 @@ def default_headers(self) -> dict[str, str | Omit]:
     def copy(
         self,
         *,
-        api_key: str | None = None,
+        access_token: str | None = None,
         environment: Literal["production", "environment_1", "environment_2"] | None = None,
         base_url: str | httpx.URL | None = None,
         timeout: float | Timeout | None | NotGiven = NOT_GIVEN,
@@ -241,7 +241,7 @@ def copy(
 
         http_client = http_client or self._client
         return self.__class__(
-            api_key=api_key or self.api_key,
+            access_token=access_token or self.access_token,
             base_url=base_url or self.base_url,
             environment=environment or self._environment,
             timeout=self.timeout if isinstance(timeout, NotGiven) else timeout,
@@ -318,14 +318,14 @@ class AsyncIntercom(AsyncAPIClient):
     with_streaming_response: AsyncIntercomWithStreamedResponse
 
     # client options
-    api_key: str
+    access_token: str
 
     _environment: Literal["production", "environment_1", "environment_2"] | NotGiven
 
     def __init__(
         self,
         *,
-        api_key: str | None = None,
+        access_token: str | None = None,
         environment: Literal["production", "environment_1", "environment_2"] | NotGiven = NOT_GIVEN,
         base_url: str | httpx.URL | None | NotGiven = NOT_GIVEN,
         timeout: Union[float, Timeout, None, NotGiven] = NOT_GIVEN,
@@ -348,15 +348,15 @@ def __init__(
     ) -> None:
         """Construct a new async intercom client instance.
 
-        This automatically infers the `api_key` argument from the `INTERCOM_API_KEY` environment variable if it is not provided.
+        This automatically infers the `access_token` argument from the `INTERCOM_ACCESS_TOKEN` environment variable if it is not provided.
         """
-        if api_key is None:
-            api_key = os.environ.get("INTERCOM_API_KEY")
-        if api_key is None:
+        if access_token is None:
+            access_token = os.environ.get("INTERCOM_ACCESS_TOKEN")
+        if access_token is None:
             raise IntercomError(
-                "The api_key client option must be set either by passing api_key to the client or by setting the INTERCOM_API_KEY environment variable"
+                "The access_token client option must be set either by passing access_token to the client or by setting the INTERCOM_ACCESS_TOKEN environment variable"
             )
-        self.api_key = api_key
+        self.access_token = access_token
 
         self._environment = environment
 
@@ -429,8 +429,8 @@ def qs(self) -> Querystring:
     @property
     @override
     def auth_headers(self) -> dict[str, str]:
-        api_key = self.api_key
-        return {"Authorization": f"Bearer {api_key}"}
+        access_token = self.access_token
+        return {"Authorization": f"Bearer {access_token}"}
 
     @property
     @override
@@ -444,7 +444,7 @@ def default_headers(self) -> dict[str, str | Omit]:
     def copy(
         self,
         *,
-        api_key: str | None = None,
+        access_token: str | None = None,
         environment: Literal["production", "environment_1", "environment_2"] | None = None,
         base_url: str | httpx.URL | None = None,
         timeout: float | Timeout | None | NotGiven = NOT_GIVEN,
@@ -479,7 +479,7 @@ def copy(
 
         http_client = http_client or self._client
         return self.__class__(
-            api_key=api_key or self.api_key,
+            access_token=access_token or self.access_token,
             base_url=base_url or self.base_url,
             environment=environment or self._environment,
             timeout=self.timeout if isinstance(timeout, NotGiven) else timeout,

tests/conftest.py

@@ -26,7 +26,7 @@ def event_loop() -> Iterator[asyncio.AbstractEventLoop]:
 
 base_url = os.environ.get("TEST_API_BASE_URL", "http://127.0.0.1:4010")
 
-api_key = "My API Key"
+access_token = "My Access Token"
 
 
 @pytest.fixture(scope="session")
@@ -35,7 +35,7 @@ def client(request: FixtureRequest) -> Iterator[Intercom]:
     if not isinstance(strict, bool):
         raise TypeError(f"Unexpected fixture parameter type {type(strict)}, expected {bool}")
 
-    with Intercom(base_url=base_url, api_key=api_key, _strict_response_validation=strict) as client:
+    with Intercom(base_url=base_url, access_token=access_token, _strict_response_validation=strict) as client:
         yield client
 
 
@@ -45,5 +45,7 @@ async def async_client(request: FixtureRequest) -> AsyncIterator[AsyncIntercom]:
     if not isinstance(strict, bool):
         raise TypeError(f"Unexpected fixture parameter type {type(strict)}, expected {bool}")
 
-    async with AsyncIntercom(base_url=base_url, api_key=api_key, _strict_response_validation=strict) as client:
+    async with AsyncIntercom(
+        base_url=base_url, access_token=access_token, _strict_response_validation=strict
+    ) as client:
         yield client