From 23fab1f6c1598d9fc153db4cf8d4c3ac61140397 Mon Sep 17 00:00:00 2001
From: Travis Cashion <58757351+TCashion@users.noreply.github.com>
Date: Wed, 29 Nov 2023 10:24:04 -0700
Subject: [PATCH] tc/db2/update-readme-with-deprecation-warning
---
README.md | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/README.md b/README.md
index b048616..74334d6 100644
--- a/README.md
+++ b/README.md
@@ -36,6 +36,14 @@ A valid Brandfolder API key is required for all actions. Find yours at https://b
#### Methods for interacting with resource objects from Brandfolder:
+
+
+| :exclamation: | Deprecation Warning |
+|---------------|:------------------------|
+| | Functionality to list assets and attachments by organization (`org.assets.fetch(...)` and `org.attachments.fetch(...)`) will soon be deprecated. ***This will be a breaking change for all versions.***
Clients wishing to fetch these resources for an entire organization should instead list all Brandfolders for that organization, and then iteratively fetch assets or attachments from each section within a Brandfolder.
See the API documention for [listing assets](https://developers.brandfolder.com/docs/#list-assets) and [listing attachments](https://developers.brandfolder.com/docs/#list-attachments) for more information. |
+
+
+
`obj.get()`: Returns the provided attribute value of the associated object. (e.g. `asset.get('name')`)
`obj.refresh()`: Updates local object attributes with what currently exists in Brandfolder.