Release 0.5.8-rc1

mercoa-finance · Sep 9, 2024 · 01a139d · 01a139d
1 parent 52d6ceb
commit 01a139d
Show file tree

Hide file tree

Showing 26 changed files with 1,444 additions and 132 deletions.
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "mercoa"
-version = "0.5.7"
+version = "0.5.8-rc1"
 description = ""
 readme = "README.md"
 authors = []

diff --git a/reference.md b/reference.md
@@ -213,7 +213,7 @@ client.entity_group.get(
 <dl>
 <dd>
 
-**entity_metadata:** `typing.Optional[bool]` — If true, will return simple key/value metadata for entities in the group. For more complex metadata, use the Metadata API.
+**return_entity_metadata:** `typing.Optional[bool]` — If true, will return simple key/value metadata for entities in the group. For more complex metadata, use the Metadata API.
 
 </dd>
 </dl>
@@ -1332,6 +1332,14 @@ If false, entities that are marked as payors will not be returned.
 <dl>
 <dd>
 
+**return_metadata:** `typing.Optional[bool]` — If true, will return simple key/value metadata for the entity. For more complex metadata, use the Metadata API.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **limit:** `typing.Optional[int]` — Number of entities to return. Limit can range between 1 and 100, and the default is 10.
 
 </dd>
@@ -1479,7 +1487,7 @@ client.entity.get(
 <dl>
 <dd>
 
-**metadata:** `typing.Optional[bool]` — If true, will return simple key/value metadata for the entity. For more complex metadata, use the Metadata API.
+**return_metadata:** `typing.Optional[bool]` — If true, will return simple key/value metadata for the entity. For more complex metadata, use the Metadata API.
 
 </dd>
 </dl>
@@ -2167,6 +2175,92 @@ client.entity.send_onboarding_link(
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.entity.<a href="src/mercoa/entity/client.py">events</a>(...)</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Get all events for an entity
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```python
+from mercoa import Mercoa
+
+client = Mercoa(
+    token="YOUR_TOKEN",
+)
+client.entity.events(
+    entity_id="ent_a0f6ea94-0761-4a5e-a416-3c453cb7eced",
+)
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**entity_id:** `EntityId` — Entity ID or Entity ForeignID
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**start_date:** `typing.Optional[dt.datetime]` — Start date filter. If not provided, events from the start of time will be returned.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**end_date:** `typing.Optional[dt.datetime]` — End date filter. If not provided, events to the end of time will be returned.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -2681,7 +2775,7 @@ client.entity.user.get(
 <dl>
 <dd>
 
-**user_id:** `EntityUserId` 
+**user_id:** `EntityUserId` — User ID or User ForeignID
 
 </dd>
 </dl>
@@ -2767,7 +2861,7 @@ client.entity.user.update(
 <dl>
 <dd>
 
-**user_id:** `EntityUserId` 
+**user_id:** `EntityUserId` — User ID or User ForeignID
 
 </dd>
 </dl>
@@ -2854,7 +2948,7 @@ client.entity.user.delete(
 <dl>
 <dd>
 
-**user_id:** `EntityUserId` 
+**user_id:** `EntityUserId` — User ID or User ForeignID
 
 </dd>
 </dl>
@@ -2937,7 +3031,7 @@ client.entity.user.get_token(
 <dl>
 <dd>
 
-**user_id:** `EntityUserId` 
+**user_id:** `EntityUserId` — User ID or User ForeignID
 
 </dd>
 </dl>
@@ -3457,6 +3551,92 @@ client.invoice.delete(
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.invoice.<a href="src/mercoa/invoice/client.py">events</a>(...)</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Get all events for an invoice
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```python
+from mercoa import Mercoa
+
+client = Mercoa(
+    token="YOUR_TOKEN",
+)
+client.invoice.events(
+    invoice_id="inv_8545a84e-a45f-41bf-bdf1-33b42a55812c",
+)
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**invoice_id:** `InvoiceId` — Invoice ID or Invoice ForeignID
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**start_date:** `typing.Optional[dt.datetime]` — Start date filter. If not provided, events from the start of time will be returned.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**end_date:** `typing.Optional[dt.datetime]` — End date filter. If not provided, events to the end of time will be returned.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -5512,6 +5692,14 @@ client.entity.counterparty.find_payees(
 <dl>
 <dd>
 
+**return_metadata:** `typing.Optional[bool]` — If true, will return simple key/value metadata for the counterparties.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **limit:** `typing.Optional[int]` — Number of counterparties to return. Limit can range between 1 and 100, and the default is 10.
 
 </dd>
@@ -5645,6 +5833,14 @@ client.entity.counterparty.find_payors(
 <dl>
 <dd>
 
+**return_metadata:** `typing.Optional[bool]` — If true, will return simple key/value metadata for the counterparties.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **limit:** `typing.Optional[int]` — Number of counterparties to return. Limit can range between 1 and 100, and the default is 10.
 
 </dd>
@@ -8919,7 +9115,7 @@ client.entity.user.notification_policy.get_all(
 <dl>
 <dd>
 
-**user_id:** `EntityUserId` 
+**user_id:** `EntityUserId` — User ID or User ForeignID
 
 </dd>
 </dl>
@@ -8999,7 +9195,7 @@ client.entity.user.notification_policy.get(
 <dl>
 <dd>
 
-**user_id:** `EntityUserId` 
+**user_id:** `EntityUserId` — User ID or User ForeignID
 
 </dd>
 </dl>
@@ -9091,7 +9287,7 @@ client.entity.user.notification_policy.update(
 <dl>
 <dd>
 
-**user_id:** `EntityUserId` 
+**user_id:** `EntityUserId` — User ID or User ForeignID
 
 </dd>
 </dl>
@@ -9173,7 +9369,7 @@ client.entity.user.notifications.find(
 <dl>
 <dd>
 
-**user_id:** `EntityUserId` 
+**user_id:** `EntityUserId` — User ID or User ForeignID
 
 </dd>
 </dl>
@@ -9297,7 +9493,7 @@ client.entity.user.notifications.get(
 <dl>
 <dd>
 
-**user_id:** `EntityUserId` 
+**user_id:** `EntityUserId` — User ID or User ForeignID
 
 </dd>
 </dl>
@@ -9389,7 +9585,7 @@ client.entity.user.notifications.update(
 <dl>
 <dd>
 
-**user_id:** `EntityUserId` 
+**user_id:** `EntityUserId` — User ID or User ForeignID
 
 </dd>
 </dl>

diff --git a/src/mercoa/__init__.py b/src/mercoa/__init__.py
@@ -74,6 +74,8 @@
     EntityAddPayorsRequest,
     EntityCustomizationRequest,
     EntityCustomizationResponse,
+    EntityEvent,
+    EntityEventsResponse,
     EntityHidePayeesRequest,
     EntityHidePayorsRequest,
     EntityId,
@@ -153,6 +155,8 @@
     FindInvoiceResponse,
     InvoiceCreationRequest,
     InvoiceDateFilter,
+    InvoiceEvent,
+    InvoiceEventsResponse,
     InvoiceFailureType,
     InvoiceFeesRequest,
     InvoiceFeesResponse,
@@ -393,6 +397,8 @@
     "EntityAddPayorsRequest",
     "EntityCustomizationRequest",
     "EntityCustomizationResponse",
+    "EntityEvent",
+    "EntityEventsResponse",
     "EntityGroupEntityUpdateRequest",
     "EntityGroupFindResponse",
     "EntityGroupId",
@@ -444,6 +450,8 @@
     "InvoiceCreationRequest",
     "InvoiceDateFilter",
     "InvoiceEmailWebhook",
+    "InvoiceEvent",
+    "InvoiceEventsResponse",
     "InvoiceFailureType",
     "InvoiceFeesRequest",
     "InvoiceFeesResponse",

diff --git a/src/mercoa/core/client_wrapper.py b/src/mercoa/core/client_wrapper.py
@@ -22,7 +22,7 @@ def get_headers(self) -> typing.Dict[str, str]:
         headers: typing.Dict[str, str] = {
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "mercoa",
-            "X-Fern-SDK-Version": "0.5.7",
+            "X-Fern-SDK-Version": "0.5.8-rc1",
         }
         headers["Authorization"] = f"Bearer {self._get_token()}"
         return headers