Files.com 1.4.205__tar.gz → 1.4.207__tar.gz

{Files.com-1.4.205 → Files.com-1.4.207}/Files.com.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.2
 Name: Files.com
-Version: 1.4.205
+Version: 1.4.207
 Summary: Python bindings for the Files.com API
 Home-page: UNKNOWN
 License: MIT

{Files.com-1.4.205 → Files.com-1.4.207}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.2
 Name: Files.com
-Version: 1.4.205
+Version: 1.4.207
 Summary: Python bindings for the Files.com API
 Home-page: UNKNOWN
 License: MIT

{Files.com-1.4.205 → Files.com-1.4.207}/README.md

@@ -60,7 +60,12 @@ import files_sdk
 files_sdk.set_api_key("YOUR_API_KEY")
 
 ## Alternatively, you can specify the API key on a per-request basis in the final parameter to any method or initializer.
-files_sdk.user.list(params, {"api_key": "YOUR_API_KEY"})
+try:
+  files_sdk.user.list(params, {"api_key": "YOUR_API_KEY"})
+except files_sdk.error.NotAuthenticatedError as err:
+  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
+except files_sdk.error.Error as err:
+  print(f"Unknown Error Occurred ({type(err).__name__}):", err)
 ```
 
 Don't forget to replace the placeholder, `YOUR_API_KEY`, with your actual API key.
@@ -87,7 +92,12 @@ This returns a session object that can be used to authenticate SDK method calls.
 ```python title="Example Request"
 import files_sdk
 
-session = files_sdk.session.create({ "username": "motor", "password": "vroom" })
+try:
+  session = files_sdk.session.create({ "username": "motor", "password": "vroom" })
+except files_sdk.error.NotAuthenticatedError as err:
+  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
+except files_sdk.error.Error as err:
+  print(f"Unknown Error Occurred ({type(err).__name__}):", err)
 ```
 
 #### Using a Session
@@ -100,11 +110,16 @@ import files_sdk
 ## You may set the returned session to be used by default for subsequent requests.
 files_sdk.set_session(session)
 
-## Alternatively, you can specify the session ID on a per-object basis in the second parameter to a model constructor.
-user = files_sdk.user.User(params, {"session_id": session.id})
+try:
+  # Alternatively, you can specify the session ID on a per-object basis in the second parameter to a model constructor.
+  user = files_sdk.user.User(params, {"session_id": session.id})
 
-## You may also specify the session ID on a per-request basis in the final parameter to static methods.
-files_sdk.user.find(id, params, {"session_id": session.id})
+  # You may also specify the session ID on a per-request basis in the final parameter to static methods.
+  files_sdk.user.find(id, params, {"session_id": session.id})
+except files_sdk.error.NotAuthenticatedError as err:
+  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
+except files_sdk.error.Error as err:
+  print(f"Unknown Error Occurred ({type(err).__name__}):", err)
 ```
 
 #### Logging Out
@@ -238,12 +253,17 @@ value of either ```"asc"``` or ```"desc"``` to specify the sort order.
 ```python title="Sort Example"
 import files_sdk
 
-## users sorted by username
-users = files_sdk.user.list({
-  "sort_by": { "username": "asc"}
-})
-for user in users.auto_paging_iter():
-  # Operate on user
+try:
+  # users sorted by username
+  users = files_sdk.user.list({
+    "sort_by": { "username": "asc" }
+  })
+  for user in users.auto_paging_iter():
+    # Operate on user
+except files_sdk.error.NotAuthenticatedError as err:
+  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
+except files_sdk.error.Error as err:
+  print(f"Unknown Error Occurred ({type(err).__name__}):", err)
 ```
 
 ### Filtering
@@ -272,47 +292,67 @@ filter on and a passed in value to use in the filter comparison.
 ```python title="Exact Filter Example"
 import files_sdk
 
-## non admin users
-users = files_sdk.user.list({
-  "filter": { "not_site_admin": true}
-})
-for user in users.auto_paging_iter():
-  # Operate on user
+try:
+  # non admin users
+  users = files_sdk.user.list({
+    "filter": { "not_site_admin": true }
+  })
+  for user in users.auto_paging_iter():
+    # Operate on user
+except files_sdk.error.NotAuthenticatedError as err:
+  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
+except files_sdk.error.Error as err:
+  print(f"Unknown Error Occurred ({type(err).__name__}):", err)
 ```
 
 ```python title="Range Filter Example"
 import files_sdk
 
-## users who haven't logged in since 2024-01-01
-users = files_sdk.user.list({
-  "filter_gteq": { "last_login_at": "2024-01-01" }
-})
-for user in users.auto_paging_iter():
-  # Operate on user
+try:
+  # users who haven't logged in since 2024-01-01
+  users = files_sdk.user.list({
+    "filter_gteq": { "last_login_at": "2024-01-01" }
+  })
+  for user in users.auto_paging_iter():
+    # Operate on user
+except files_sdk.error.NotAuthenticatedError as err:
+  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
+except files_sdk.error.Error as err:
+  print(f"Unknown Error Occurred ({type(err).__name__}):", err)
 ```
 
 ```python title="Pattern Filter Example"
 import files_sdk
 
-## users whose usernames start with 'test'
-users = files_sdk.user.list({
-  "filter_prefix": { "username": "test" }
-})
-for user in users.auto_paging_iter():
-  # Operate on user
+try:
+  # users whose usernames start with 'test'
+  users = files_sdk.user.list({
+    "filter_prefix": { "username": "test" }
+  })
+  for user in users.auto_paging_iter():
+    # Operate on user
+except files_sdk.error.NotAuthenticatedError as err:
+  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
+except files_sdk.error.Error as err:
+  print(f"Unknown Error Occurred ({type(err).__name__}):", err)
 ```
 
 ```python title="Combination Filter with Sort Example"
 import files_sdk
 
-## users whose usernames start with 'test' and are not admins
-users = files_sdk.user.list({
-  "filter_prefix": { "username": "test" },
-  "filter": { "not_site_admin": "true" },
-  "sort_by": { "username": "asc"}
-})
-for user in users.auto_paging_iter():
-  # Operate on user
+try:
+  # users whose usernames start with 'test' and are not admins
+  users = files_sdk.user.list({
+    "filter_prefix": { "username": "test" },
+    "filter": { "not_site_admin": "true" },
+    "sort_by": { "username": "asc" }
+  })
+  for user in users.auto_paging_iter():
+    # Operate on user
+except files_sdk.error.NotAuthenticatedError as err:
+  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
+except files_sdk.error.Error as err:
+  print(f"Unknown Error Occurred ({type(err).__name__}):", err)
 ```
 
 ## Errors
@@ -337,9 +377,9 @@ import files_sdk
 try:
   session = files_sdk.session.create({ "username": "USERNAME", "password": "BADPASSWORD" })
 except files_sdk.error.NotAuthenticatedError as err:
-    print(f"Authentication Error Occurred ({type(err).__name__}):", err)
+  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
 except files_sdk.error.Error as err:
-    print(f"Unknown Error Occurred ({type(err).__name__}):", err)
+  print(f"Unknown Error Occurred ({type(err).__name__}):", err)
 ```
 
 ### Error Types

{Files.com-1.4.205 → Files.com-1.4.207}/files_sdk/__init__.py

@@ -208,7 +208,7 @@ session_id = None
 source_ip = None
 base_url = "https://app.files.com"
 base_path = "api/rest/v1"
-version = "1.4.205"
+version = "1.4.207"
 
 __version__ = version
 

{Files.com-1.4.205 → Files.com-1.4.207}/files_sdk/models/folder.py

@@ -80,7 +80,7 @@ class Folder:
 #   path (required) - string - Path to operate on.
 #   preview_size - string - Request a preview size.  Can be `small` (default), `large`, `xlarge`, or `pdf`.
 #   sort_by - object - Search by field and direction. Valid fields are `path`, `size`, `modified_at_datetime`, `provided_modified_at`.  Valid directions are `asc` and `desc`.  Defaults to `{"path":"asc"}`.
-#   search - string - If specified, will search the folders/files list by name. Ignores text before last `/`. This is the same API used by the search bar in the web UI when running 'Search This Folder'.  Search results are a best effort, not real time, and not guaranteed to perfectly match the latest folder listing.  Results may be trunacted if more than 1,000 possible matches exist.  This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
+#   search - string - If specified, will search the folders/files list by name. Ignores text before last `/`. This is the same API used by the search bar in the web UI when running 'Search This Folder'.  Search results are a best effort, not real time, and not guaranteed to perfectly match the latest folder listing.  Results may be truncated if more than 1,000 possible matches exist.  This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
 #   search_all - boolean - Search entire site?  If set, we will ignore the folder path provided and search the entire site.  This is the same API used by the search bar in the web UI when running 'Search All Files'.  Search results are a best effort, not real time, and not guaranteed to match every file.  This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
 #   with_previews - boolean - Include file previews?
 #   with_priority_color - boolean - Include file priority color information?