Release 0.1.5

Author: fern-api[bot]

README.md

@@ -21,7 +21,7 @@ pip install --upgrade fileforge
 from fileforge.client import Fileforge
 
 client = Fileforge(
-    header="YOUR_HEADER",
+    api_key="YOUR_API_KEY",
 )
 ```
 <!-- End Usage  -->
@@ -33,7 +33,7 @@ client = Fileforge(
 from fileforge.client import AsyncFileforge
 
 client = AsyncFileforge(
-    header="YOUR_HEADER",
+    api_key="YOUR_API_KEY",
 )
 ```
 <!-- End Async Usage  -->

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "fileforge"
-version = "0.1.4"
+version = "0.1.5"
 description = ""
 readme = "README.md"
 authors = []

src/fileforge/client.py

@@ -47,7 +47,7 @@ class Fileforge:
 
 
 
-    header : typing.Optional[str]
+    api_key : typing.Optional[str]
     timeout : typing.Optional[float]
         The timeout to be used, in seconds, for requests by default the timeout is 60 seconds, unless a custom httpx client is used, in which case a default is not set.
 
@@ -62,7 +62,7 @@ class Fileforge:
     from fileforge.client import Fileforge
 
     client = Fileforge(
-        header="YOUR_HEADER",
+        api_key="YOUR_API_KEY",
     )
     """
 
@@ -71,19 +71,19 @@ def __init__(
         *,
         base_url: typing.Optional[str] = None,
         environment: FileforgeEnvironment = FileforgeEnvironment.DEFAULT,
-        header: typing.Optional[str] = os.getenv("FILEFORGE_API_KEY"),
+        api_key: typing.Optional[str] = os.getenv("FILEFORGE_API_KEY"),
         timeout: typing.Optional[float] = None,
         follow_redirects: typing.Optional[bool] = True,
         httpx_client: typing.Optional[httpx.Client] = None,
     ):
         _defaulted_timeout = timeout if timeout is not None else 60 if httpx_client is None else None
-        if header is None:
+        if api_key is None:
             raise ApiError(
-                body="The client must be instantiated be either passing in header or setting FILEFORGE_API_KEY"
+                body="The client must be instantiated be either passing in api_key or setting FILEFORGE_API_KEY"
             )
         self._client_wrapper = SyncClientWrapper(
             base_url=_get_base_url(base_url=base_url, environment=environment),
-            header=header,
+            api_key=api_key,
             httpx_client=httpx_client
             if httpx_client is not None
             else httpx.Client(timeout=_defaulted_timeout, follow_redirects=follow_redirects)
@@ -108,7 +108,7 @@ def retrieve_server_status(self, *, request_options: typing.Optional[RequestOpti
         from fileforge.client import Fileforge
 
         client = Fileforge(
-            header="YOUR_HEADER",
+            api_key="YOUR_API_KEY",
         )
         client.retrieve_server_status()
         """
@@ -211,7 +211,7 @@ def convert_docx(
         from fileforge.client import Fileforge
 
         client = Fileforge(
-            header="YOUR_HEADER",
+            api_key="YOUR_API_KEY",
         )
         client.convert_docx()
         """
@@ -292,7 +292,7 @@ def generate(
         from fileforge.client import Fileforge
 
         client = Fileforge(
-            header="YOUR_HEADER",
+            api_key="YOUR_API_KEY",
         )
         client.generate()
         """
@@ -372,7 +372,7 @@ def merge(
         from fileforge.client import Fileforge
 
         client = Fileforge(
-            header="YOUR_HEADER",
+            api_key="YOUR_API_KEY",
         )
         client.merge()
         """
@@ -441,7 +441,7 @@ class AsyncFileforge:
 
 
 
-    header : typing.Optional[str]
+    api_key : typing.Optional[str]
     timeout : typing.Optional[float]
         The timeout to be used, in seconds, for requests by default the timeout is 60 seconds, unless a custom httpx client is used, in which case a default is not set.
 
@@ -456,7 +456,7 @@ class AsyncFileforge:
     from fileforge.client import AsyncFileforge
 
     client = AsyncFileforge(
-        header="YOUR_HEADER",
+        api_key="YOUR_API_KEY",
     )
     """
 
@@ -465,19 +465,19 @@ def __init__(
         *,
         base_url: typing.Optional[str] = None,
         environment: FileforgeEnvironment = FileforgeEnvironment.DEFAULT,
-        header: typing.Optional[str] = os.getenv("FILEFORGE_API_KEY"),
+        api_key: typing.Optional[str] = os.getenv("FILEFORGE_API_KEY"),
         timeout: typing.Optional[float] = None,
         follow_redirects: typing.Optional[bool] = True,
         httpx_client: typing.Optional[httpx.AsyncClient] = None,
     ):
         _defaulted_timeout = timeout if timeout is not None else 60 if httpx_client is None else None
-        if header is None:
+        if api_key is None:
             raise ApiError(
-                body="The client must be instantiated be either passing in header or setting FILEFORGE_API_KEY"
+                body="The client must be instantiated be either passing in api_key or setting FILEFORGE_API_KEY"
             )
         self._client_wrapper = AsyncClientWrapper(
             base_url=_get_base_url(base_url=base_url, environment=environment),
-            header=header,
+            api_key=api_key,
             httpx_client=httpx_client
             if httpx_client is not None
             else httpx.AsyncClient(timeout=_defaulted_timeout, follow_redirects=follow_redirects)
@@ -502,7 +502,7 @@ async def retrieve_server_status(self, *, request_options: typing.Optional[Reque
         from fileforge.client import AsyncFileforge
 
         client = AsyncFileforge(
-            header="YOUR_HEADER",
+            api_key="YOUR_API_KEY",
         )
         await client.retrieve_server_status()
         """
@@ -605,7 +605,7 @@ async def convert_docx(
         from fileforge.client import AsyncFileforge
 
         client = AsyncFileforge(
-            header="YOUR_HEADER",
+            api_key="YOUR_API_KEY",
         )
         await client.convert_docx()
         """
@@ -686,7 +686,7 @@ async def generate(
         from fileforge.client import AsyncFileforge
 
         client = AsyncFileforge(
-            header="YOUR_HEADER",
+            api_key="YOUR_API_KEY",
         )
         await client.generate()
         """
@@ -766,7 +766,7 @@ async def merge(
         from fileforge.client import AsyncFileforge
 
         client = AsyncFileforge(
-            header="YOUR_HEADER",
+            api_key="YOUR_API_KEY",
         )
         await client.merge()
         """

src/fileforge/core/client_wrapper.py

@@ -8,18 +8,18 @@
 
 
 class BaseClientWrapper:
-    def __init__(self, *, header: str, base_url: str, timeout: typing.Optional[float] = None):
-        self.header = header
+    def __init__(self, *, api_key: str, base_url: str, timeout: typing.Optional[float] = None):
+        self.api_key = api_key
         self._base_url = base_url
         self._timeout = timeout
 
     def get_headers(self) -> typing.Dict[str, str]:
         headers: typing.Dict[str, str] = {
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "fileforge",
-            "X-Fern-SDK-Version": "0.1.4",
+            "X-Fern-SDK-Version": "0.1.5",
         }
-        headers["X-API-Key"] = self.header
+        headers["X-API-Key"] = self.api_key
         return headers
 
     def get_base_url(self) -> str:
@@ -31,15 +31,15 @@ def get_timeout(self) -> typing.Optional[float]:
 
 class SyncClientWrapper(BaseClientWrapper):
     def __init__(
-        self, *, header: str, base_url: str, timeout: typing.Optional[float] = None, httpx_client: httpx.Client
+        self, *, api_key: str, base_url: str, timeout: typing.Optional[float] = None, httpx_client: httpx.Client
     ):
-        super().__init__(header=header, base_url=base_url, timeout=timeout)
+        super().__init__(api_key=api_key, base_url=base_url, timeout=timeout)
         self.httpx_client = HttpClient(httpx_client=httpx_client)
 
 
 class AsyncClientWrapper(BaseClientWrapper):
     def __init__(
-        self, *, header: str, base_url: str, timeout: typing.Optional[float] = None, httpx_client: httpx.AsyncClient
+        self, *, api_key: str, base_url: str, timeout: typing.Optional[float] = None, httpx_client: httpx.AsyncClient
     ):
-        super().__init__(header=header, base_url=base_url, timeout=timeout)
+        super().__init__(api_key=api_key, base_url=base_url, timeout=timeout)
         self.httpx_client = AsyncHttpClient(httpx_client=httpx_client)