Files.com 1.4.116__tar.gz → 1.4.118__tar.gz

{Files.com-1.4.116 → Files.com-1.4.118}/Files.com.egg-info/PKG-INFO

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

{Files.com-1.4.116 → Files.com-1.4.118}/PKG-INFO

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

{Files.com-1.4.116 → Files.com-1.4.118}/README.md

@@ -251,16 +251,16 @@ handle the general `files_sdk.error.Error` exception as a catch-all.
 try:
   session = files_sdk.session.create({ "username": "USERNAME", "password": "BADPASSWORD" })
 except files_sdk.error.NotAuthenticatedError as err:
-    print(f"Authentication Error Occured ({type(err).__name__}):", err)
+    print(f"Authentication Error Occurred ({type(err).__name__}):", err)
 except files_sdk.error.Error as err:
-    print(f"Unknown Error Occured ({type(err).__name__}):", err)
+    print(f"Unknown Error Occurred ({type(err).__name__}):", err)
 ```
 
 ### Error Types
 
 #### SDK Errors
 
-SDK errors are general errors that occure within the SDK code.  Each exception class inherits from a standard `Error` base class.
+SDK errors are general errors that occur within the SDK code.  Each exception class inherits from a standard `Error` base class.
 
 ```python title="Example SDK Exception Class Inheritance Structure"
 files_sdk.error.APIConnectionError -> files_sdk.error.Error -> Exception
@@ -281,7 +281,7 @@ API errors are errors returned by the Files.com API.  Each exception class inher
 The error group base class indicates a particular type of error.
 
 ```python title="Example API Exception Class Inheritance Structure"
- files_sdk.error.FolderAdminPermissionRequiredError -> files_sdk.error.NotAuthorizedError -> files_sdk.error.APIError -> files_sdk.error.Error -> Exception
+files_sdk.error.FolderAdminPermissionRequiredError -> files_sdk.error.NotAuthorizedError -> files_sdk.error.APIError -> files_sdk.error.Error -> Exception
 ```
 ##### API Exception Classes
 
@@ -466,7 +466,7 @@ This SDK allows both file based transfer and data based transfer. Please see the
 The second parameter is optional and will simply use the remote filename by default.
 
 ```python
-    files_sdk.file.download_file("/remote.txt", "local.txt")
+files_sdk.file.download_file("/remote.txt", "local.txt")
 ```
 
 #### File Upload
@@ -474,49 +474,49 @@ The second parameter is optional and will simply use the remote filename by defa
 The second parameter is optional and will simply use the local filename by default.
 
 ```python
-    files_sdk.file.upload_file("local.txt", "/remote.txt")
+files_sdk.file.upload_file("local.txt", "/remote.txt")
 ```
 
 If the parent directories do not already exist, they can be automatically created by passing
 `mkdir_parents` in the `params`.
 
 ```python
-    files_sdk.file.upload_file("local.txt", "/uploads/remote.txt", params={"mkdir_parents": True})
+files_sdk.file.upload_file("local.txt", "/uploads/remote.txt", params={"mkdir_parents": True})
 ```
 
 #### List root folder
 
 ```python
-    for f in files_sdk.folder.list_for("/").auto_paging_iter():
-        print(f.type, f.path)
+for f in files_sdk.folder.list_for("/").auto_paging_iter():
+    print(f.type, f.path)
 ```
 
 #### Writing a file example (string)
 
 ```python
-    with files_sdk.file.open("foo.txt", 'w') as f:
-        f.write("contents")
+with files_sdk.file.open("foo.txt", 'w') as f:
+    f.write("contents")
 ```
 
 #### Writing a file example (binary)
 
 ```python
-    with files_sdk.file.open("foo.txt", 'wb') as f:
-        f.write(b"contents")
+with files_sdk.file.open("foo.txt", 'wb') as f:
+    f.write(b"contents")
 ```
 
 #### Reading a file example (string)
 
 ```python
-    with files_sdk.open("foo.txt", 'r') as f:
-        print(f.read())
+with files_sdk.open("foo.txt", 'r') as f:
+    print(f.read())
 ```
 
 #### Reading a file example (binary)
 
 ```python
-    with files_sdk.open("foo.txt", 'rb') as f:
-        print(f.read())
+with files_sdk.open("foo.txt", 'rb') as f:
+    print(f.read())
 ```
 
 ### List Responses and Cursor Paging
@@ -529,24 +529,24 @@ as needed.
 #### Iterating with with auto_paging_iter
 
 ```python
-    list_obj = files_sdk.folder.list_for('/')
+list_obj = files_sdk.folder.list_for('/')
 
-    for f in list_obj.auto_paging_iter():
-        print(f.type, f.path)
+for f in list_obj.auto_paging_iter():
+    print(f.type, f.path)
 ```
 
 #### Iterating manually
 
 ```python
-    list_obj = files_sdk.folder.list_for('/')
+list_obj = files_sdk.folder.list_for('/')
 
+for f in list_obj:
+    print(f.type, f.path)
+
+while list_obj.has_next_page:
+    list_obj.load_next_page()
     for f in list_obj:
         print(f.type, f.path)
-
-    while list_obj.has_next_page:
-        list_obj.load_next_page()
-        for f in list_obj:
-            print(f.type, f.path)
 ```
 
 ### Comparing Case insensitive files and paths
@@ -554,8 +554,8 @@ as needed.
 For related documentation see [Case Sensitivity Documentation](https://www.files.com/docs/files-and-folders/file-system-semantics/case-sensitivity).
 
 ```python
-    if files_sdk.path_util.is_same("Fïłèńämê.Txt", "filename.txt"):
-        print("Paths are the same")
+if files_sdk.path_util.is_same("Fïłèńämê.Txt", "filename.txt"):
+    print("Paths are the same")
 ```
 
 ## Mock Server

{Files.com-1.4.116 → Files.com-1.4.118}/files_sdk/__init__.py

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

{Files.com-1.4.116 → Files.com-1.4.118}/files_sdk/models/site.py

@@ -23,7 +23,7 @@ class Site:
         "admin_user_id": None,  # int64 - User ID for the main site administrator
         "admins_bypass_locked_subfolders": None,  # boolean - Allow admins to bypass the locked subfolders setting.
         "allow_bundle_names": None,  # boolean - Are manual Bundle names allowed?
-        "allowed_countries": None,  # string - Comma seperated list of allowed Country codes
+        "allowed_countries": None,  # string - Comma separated list of allowed Country codes
         "allowed_ips": None,  # string - List of allowed IP addresses
         "always_mkdir_parents": None,  # boolean - Create parent directories if they do not exist during uploads?  This is primarily used to work around broken upload clients that assume servers will perform this step.
         "ask_about_overwrites": None,  # boolean - If false, rename conflicting files instead of asking for overwrite confirmation.  Only applies to web interface.
@@ -60,7 +60,7 @@ class Site:
         "mobile_app": None,  # boolean - Is the mobile app enabled?
         "mobile_app_session_ip_pinning": None,  # boolean - Is mobile app session IP pinning enabled?
         "mobile_app_session_lifetime": None,  # int64 - Mobile app session lifetime (in hours)
-        "disallowed_countries": None,  # string - Comma seperated list of disallowed Country codes
+        "disallowed_countries": None,  # string - Comma separated list of disallowed Country codes
         "disable_files_certificate_generation": None,  # boolean - If set, Files.com will not set the CAA records required to generate future SSL certificates for this domain.
         "disable_notifications": None,  # boolean - Are notifications disabled?
         "disable_password_reset": None,  # boolean - Is password reset disabled?
@@ -132,7 +132,7 @@ class Site:
         "sftp_enabled": None,  # boolean - Is SFTP enabled?
         "sftp_host_key_type": None,  # string - Sftp Host Key Type
         "active_sftp_host_key_id": None,  # int64 - Id of the currently selected custom SFTP Host Key
-        "sftp_insecure_ciphers": None,  # boolean - If true, we will allow weak and known insecure ciphers to be used for SFTP connections.  Enabling this setting severly weakens the security of your site and it is not recommend, except as a last resort for compatibility.
+        "sftp_insecure_ciphers": None,  # boolean - If true, we will allow weak and known insecure ciphers to be used for SFTP connections.  Enabling this setting severely weakens the security of your site and it is not recommend, except as a last resort for compatibility.
         "sftp_insecure_diffie_hellman": None,  # boolean - If true, we will allow weak Diffie Hellman parameters to be used within ciphers for SFTP that are otherwise on our secure list.  This has the effect of making the cipher weaker than our normal threshold for security, but is required to support certain legacy or broken SSH and MFT clients.  Enabling this weakens security, but not nearly as much as enabling the full `sftp_insecure_ciphers` option.
         "sftp_user_root_enabled": None,  # boolean - Use user FTP roots also for SFTP?
         "sharing_enabled": None,  # boolean - Allow bundle creation
@@ -251,7 +251,7 @@ def get_usage(params=None, options=None):
 #   session_expiry - double - Session expiry in hours
 #   ssl_required - boolean - Is SSL required?  Disabling this is insecure.
 #   tls_disabled - boolean - DO NOT ENABLE. This setting allows TLSv1.0 and TLSv1.1 to be used on your site.  We intend to remove this capability entirely in early 2024.  If set, the `sftp_insecure_ciphers` flag will be automatically set to true.
-#   sftp_insecure_ciphers - boolean - If true, we will allow weak and known insecure ciphers to be used for SFTP connections.  Enabling this setting severly weakens the security of your site and it is not recommend, except as a last resort for compatibility.
+#   sftp_insecure_ciphers - boolean - If true, we will allow weak and known insecure ciphers to be used for SFTP connections.  Enabling this setting severely weakens the security of your site and it is not recommend, except as a last resort for compatibility.
 #   sftp_insecure_diffie_hellman - boolean - If true, we will allow weak Diffie Hellman parameters to be used within ciphers for SFTP that are otherwise on our secure list.  This has the effect of making the cipher weaker than our normal threshold for security, but is required to support certain legacy or broken SSH and MFT clients.  Enabling this weakens security, but not nearly as much as enabling the full `sftp_insecure_ciphers` option.
 #   disable_files_certificate_generation - boolean - If set, Files.com will not set the CAA records required to generate future SSL certificates for this domain.
 #   user_lockout - boolean - Will users be locked out after incorrect login attempts?
@@ -259,9 +259,9 @@ def get_usage(params=None, options=None):
 #   user_lockout_within - int64 - Number of hours for user lockout window
 #   user_lockout_lock_period - int64 - How many hours to lock user out for failed password?
 #   include_password_in_welcome_email - boolean - Include password in emails to new users?
-#   allowed_countries - string - Comma seperated list of allowed Country codes
+#   allowed_countries - string - Comma separated list of allowed Country codes
 #   allowed_ips - string - List of allowed IP addresses
-#   disallowed_countries - string - Comma seperated list of disallowed Country codes
+#   disallowed_countries - string - Comma separated list of disallowed Country codes
 #   days_to_retain_backups - int64 - Number of days to keep deleted files
 #   max_prior_passwords - int64 - Number of prior passwords to disallow
 #   password_validity_days - int64 - Number of days password is valid

{Files.com-1.4.116 → Files.com-1.4.118}/files_sdk/models/user.py

@@ -79,7 +79,7 @@ class User:
         "change_password_confirmation": None,  # string - Optional, but if provided, we will ensure that it matches the value sent in `change_password`.
         "grant_permission": None,  # string - Permission to grant on the user root.  Can be blank or `full`, `read`, `write`, `list`, `read+write`, or `list+write`
         "group_id": None,  # int64 - Group ID to associate this user with.
-        "imported_password_hash": None,  # string - Pre-calculated hash of the user's password. If supplied, this will be used to authenticate the user on first login. Supported hash menthods are MD5, SHA1, and SHA256.
+        "imported_password_hash": None,  # string - Pre-calculated hash of the user's password. If supplied, this will be used to authenticate the user on first login. Supported hash methods are MD5, SHA1, and SHA256.
         "password": None,  # string - User password.
         "password_confirmation": None,  # string - Optional, but if provided, we will ensure that it matches the value sent in `password`.
         "announcements_read": None,  # boolean - Signifies that the user has read all the announcements in the UI.
@@ -173,7 +173,7 @@ class User:
     #   grant_permission - string - Permission to grant on the user root.  Can be blank or `full`, `read`, `write`, `list`, `read+write`, or `list+write`
     #   group_id - int64 - Group ID to associate this user with.
     #   group_ids - string - A list of group ids to associate this user with.  Comma delimited.
-    #   imported_password_hash - string - Pre-calculated hash of the user's password. If supplied, this will be used to authenticate the user on first login. Supported hash menthods are MD5, SHA1, and SHA256.
+    #   imported_password_hash - string - Pre-calculated hash of the user's password. If supplied, this will be used to authenticate the user on first login. Supported hash methods are MD5, SHA1, and SHA256.
     #   password - string - User password.
     #   password_confirmation - string - Optional, but if provided, we will ensure that it matches the value sent in `password`.
     #   announcements_read - boolean - Signifies that the user has read all the announcements in the UI.
@@ -477,7 +477,7 @@ def get(id, params=None, options=None):
 #   grant_permission - string - Permission to grant on the user root.  Can be blank or `full`, `read`, `write`, `list`, `read+write`, or `list+write`
 #   group_id - int64 - Group ID to associate this user with.
 #   group_ids - string - A list of group ids to associate this user with.  Comma delimited.
-#   imported_password_hash - string - Pre-calculated hash of the user's password. If supplied, this will be used to authenticate the user on first login. Supported hash menthods are MD5, SHA1, and SHA256.
+#   imported_password_hash - string - Pre-calculated hash of the user's password. If supplied, this will be used to authenticate the user on first login. Supported hash methods are MD5, SHA1, and SHA256.
 #   password - string - User password.
 #   password_confirmation - string - Optional, but if provided, we will ensure that it matches the value sent in `password`.
 #   announcements_read - boolean - Signifies that the user has read all the announcements in the UI.
@@ -695,7 +695,7 @@ def user_2fa_reset(id, params=None, options=None):
 #   grant_permission - string - Permission to grant on the user root.  Can be blank or `full`, `read`, `write`, `list`, `read+write`, or `list+write`
 #   group_id - int64 - Group ID to associate this user with.
 #   group_ids - string - A list of group ids to associate this user with.  Comma delimited.
-#   imported_password_hash - string - Pre-calculated hash of the user's password. If supplied, this will be used to authenticate the user on first login. Supported hash menthods are MD5, SHA1, and SHA256.
+#   imported_password_hash - string - Pre-calculated hash of the user's password. If supplied, this will be used to authenticate the user on first login. Supported hash methods are MD5, SHA1, and SHA256.
 #   password - string - User password.
 #   password_confirmation - string - Optional, but if provided, we will ensure that it matches the value sent in `password`.
 #   announcements_read - boolean - Signifies that the user has read all the announcements in the UI.