Merge pull request #10 from blueinkhq/feature/BIC-3216-python-api-cli…

…ent-fixes Feature/bic 3216 python api client fixes
blueinkhq · Nov 17, 2022 · 7028911 · 7028911
2 parents a25c017 + 276f959
commit 7028911
Show file tree

Hide file tree

Showing 30 changed files with 1,386 additions and 1,189 deletions.
diff --git a/README.md b/README.md
@@ -9,7 +9,8 @@ includes examples for many common use cases.
 
 Additional resources that might be useful include:
 
-* Examples in the `examples/` directory of this repository
+* Examples at [blueink-client-python-examples](https://github.com/blueinkhq/blueink-client-python-examples)
+repo on GitHub
 * The detailed [Blueink API Documentation](https://blueink.com/r/api-docs/), for
   details on the data returned by each API call.
 
@@ -55,6 +56,14 @@ from blueink import Client
 client = Client("YOUR_PRIVATE_API_KEY")
 ```
 
+The Client also has two modes of operations. By default the Client will raise HTTPError
+exceptions whenever there's an issue between the client and server (eg. HTTP4xx,
+HTTP5xx errors). These come from the `requests` module. If within your application
+you already handle exceptions coming out of `requests` then you should be good.
+If you set `raise_exceptions = False` then these  will be returned as
+`NormalizedResponse` objects which are also used for successful communications. See 
+below for information about these objects.
+
 ### Making API Calls
 
 Making API calls with a client instance is easy. For example, to retrieve a list of

diff --git a/examples/create_bundle_from_bytearray.py b/examples/create_bundle_from_bytearray.py
diff --git a/examples/create_bundle_from_file.py b/examples/create_bundle_from_file.py
diff --git a/examples/create_bundle_from_template.py b/examples/create_bundle_from_template.py
diff --git a/examples/create_bundle_from_url.py b/examples/create_bundle_from_url.py