files-com 1.5.4__py3-none-any.whl → 1.5.6__py3-none-any.whl

README.md

@@ -357,14 +357,20 @@ except files_sdk.error.Error as err:
 
 ## Foreign Language Support
 
-The Files.com Python SDK will soon be updated to support localized responses by using a configuration
-method. When available, it can be used to guide the API in selecting a preferred language for applicable response content.
+The Files.com PHP SDK supports localized responses by using the `files_sdk.set_language` configuration method.
+When configured, this guides the API in selecting a preferred language for applicable response content.
 
 Language support currently applies to select human-facing fields only, such as notification messages
 and error descriptions.
 
 If the specified language is not supported or the value is omitted, the API defaults to English.
 
+```shell title="Example Request"
+import files_sdk
+
+files_sdk.set_language('es')
+```
+
 ## Errors
 
 The Files.com Python SDK will return errors by raising exceptions. There are many exception classes defined in the Files SDK that correspond

_VERSION

@@ -1 +1 @@
-1.5.4
+1.5.6

{files_com-1.5.4.dist-info → files_com-1.5.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: files_com
-Version: 1.5.4
+Version: 1.5.6
 Summary: Python bindings for the Files.com API
 License: MIT
 Requires-Python: >=3.5
@@ -369,14 +369,20 @@ except files_sdk.error.Error as err:
 
 ## Foreign Language Support
 
-The Files.com Python SDK will soon be updated to support localized responses by using a configuration
-method. When available, it can be used to guide the API in selecting a preferred language for applicable response content.
+The Files.com PHP SDK supports localized responses by using the `files_sdk.set_language` configuration method.
+When configured, this guides the API in selecting a preferred language for applicable response content.
 
 Language support currently applies to select human-facing fields only, such as notification messages
 and error descriptions.
 
 If the specified language is not supported or the value is omitted, the API defaults to English.
 
+```shell title="Example Request"
+import files_sdk
+
+files_sdk.set_language('es')
+```
+
 ## Errors
 
 The Files.com Python SDK will return errors by raising exceptions. There are many exception classes defined in the Files SDK that correspond

{files_com-1.5.4.dist-info → files_com-1.5.6.dist-info}/RECORD

@@ -1,9 +1,9 @@
-README.md,sha256=rVOUbl9T_vio5S50NXggbFF5vlAtu7TOWgMQOWVXrl0,28303
-_VERSION,sha256=h5pnoZdEZHnng8jiKlhoH-0yTwnqwc6Aj2paTF4YlK0,6
-files_com-1.5.4.dist-info/licenses/LICENSE,sha256=ziANl9OTD-5-iE8XYIZNm6IYBDxOCHwQ-mdhci7lNew,1102
-files_sdk/__init__.py,sha256=7UL4sR5fd2bvtqaRHT8Y4AwxvR-ovBhONpNNsFXL2Y0,12163
-files_sdk/api.py,sha256=pApkR1SYNByTLJICNnuC3S9DP5QzIsGv401Z_00oEpI,1717
-files_sdk/api_client.py,sha256=bMzG89eFrAfqy3u69AuZlIj3AFwEKbufC0w2EEKdHPA,11041
+README.md,sha256=g4zPluTMBI4fOaRMhczJi2WgpYWAUVg8YJsXEZwQvmM,28378
+_VERSION,sha256=2rZOBsCBfXe0-IcmGDLLs0ugI8rHx01y2BBoVTZS0MU,6
+files_com-1.5.6.dist-info/licenses/LICENSE,sha256=ziANl9OTD-5-iE8XYIZNm6IYBDxOCHwQ-mdhci7lNew,1102
+files_sdk/__init__.py,sha256=_eUmsS77LgZi9OHvZvKsDZJYxA7Q3CwpGsr7T3_p82g,12329
+files_sdk/api.py,sha256=HOLk50HLQCbnHwnAr9OElQEWvdA_BABBSEvvFSt1S4A,1846
+files_sdk/api_client.py,sha256=cfFvm-o4Ao8SWADiJv7t7qnJfG_LJmWV3l6ALTC-Opo,11264
 files_sdk/error.py,sha256=lZKht6lYj9i99CzRbHschmdSs6T2Y51-YrZX_5Y_o7A,64945
 files_sdk/list_obj.py,sha256=MWgmESLAmfh1uaSw76PWxmnf9f6_08TLUHe8_mCYKL4,1157
 files_sdk/path_util.py,sha256=7x8X3JLoMkcqNefCaBeHYXD8MGvPby4AOy-xnBX_LNk,1694
@@ -23,16 +23,16 @@ files_sdk/models/as2_station.py,sha256=ZFjSw2sBRQgh9x1m76dFB2crSp4P__9xqStaBZa8Z
 files_sdk/models/auto.py,sha256=nODYUPqEsTw7suz0s6zDTsFd8j5yeSIzBELTiaXxzRE,995
 files_sdk/models/automation.py,sha256=kswZXOs6kh-EnZBqAfrAlihwtS0zK4clDYs1vv4VxVw,43565
 files_sdk/models/automation_log.py,sha256=hzaEoc1_ZG8aLmymK4QpB1OD-tYphg2NTNggF8UMFqs,15299
-files_sdk/models/automation_run.py,sha256=RruWjOJ9Ok-PeKNdY-DLQxydk9rKYZwXaF2cdGhYtJE,5099
+files_sdk/models/automation_run.py,sha256=ThDA_5inLYaunKOcNgXFD9QLlhndJXC2TOl7-GqK098,5341
 files_sdk/models/bandwidth_snapshot.py,sha256=IBcRP5r_iFl86lhHOb5o5UZdsT8_-cBrAjKyPAc7OBw,4722
 files_sdk/models/behavior.py,sha256=Z0TbXgoh8-5wGX-jMFEgsF0znbNhdDPlEOZGdGmA6L4,17328
 files_sdk/models/bundle.py,sha256=Ei8V8dkGu3hEJ_qZZC63tHclKNHrbRlDLCuhUYcGOXE,30030
-files_sdk/models/bundle_action.py,sha256=bwD-HLZYXp-hfATKdTpoplVYb4SnJrlh5EzDrmpNdVc,4797
+files_sdk/models/bundle_action.py,sha256=lgDrrFake0zkxE0Cq5QDwlJi2M2ZyJrquP5sgh_XnA0,5039
 files_sdk/models/bundle_download.py,sha256=ZSjf6R0kCiFGgjQq7bu5nsFAtaW0sE72IZhCx2g5D10,4832
 files_sdk/models/bundle_notification.py,sha256=1qJP1wvruz3seXj1Pj0sqFT8wyQhDgp0AD7utAT0ofQ,8530
 files_sdk/models/bundle_path.py,sha256=UQc3Y1zD6s2AWEoFZ1H5_FuXr3cuNoLw18XGHxauMVA,1249
 files_sdk/models/bundle_recipient.py,sha256=Aw1TGxCiVDez20eH43pKpfOjpnjPOPZRhVn2ty9olpQ,5587
-files_sdk/models/bundle_registration.py,sha256=CoYc15qPQ6Enke5glK0ywGhWVhm0hNCjRvql8SsUSvo,3668
+files_sdk/models/bundle_registration.py,sha256=Igvrg3K2dT0re8MO4hmXg6u02ljiR569nOOyG0L7NHE,3910
 files_sdk/models/clickwrap.py,sha256=6xCBvo38zlA2s7U0lIH1nmbEjv2U2A_FL_5pAtbjkGE,11563
 files_sdk/models/dns_record.py,sha256=iXrDPyaovMmPopCGaiPcK1hcuKCYaqnhnsj0Olxjq8g,2370
 files_sdk/models/email_incoming_message.py,sha256=ciP9FI3wxfC7vqzZ0Cx3-_mszoZKfdFwD1sg6QI7tok,5391
@@ -102,12 +102,12 @@ files_sdk/models/usage_by_top_level_dir.py,sha256=o_dETvzcgEA9lsdES_yzwPVAZVFk4Z
 files_sdk/models/usage_daily_snapshot.py,sha256=rWf6GaTlN9spkUPwfF4IJ0Y6z-JTV9TAWjsFrxI-UFg,5477
 files_sdk/models/usage_snapshot.py,sha256=3GzMIxBjKelgNP7ksWq4XlrRlAFcYxzd_J6vAgb52qc,4005
 files_sdk/models/user.py,sha256=dUoxi4amdK0-iZBfsvm7IV2qtyNCYgBmT8fnDxuf4Qw,50520
-files_sdk/models/user_cipher_use.py,sha256=wpvBgzMbySYVF_Z982pcblMa2OtlUZ2rj69zcpt3h5A,3029
+files_sdk/models/user_cipher_use.py,sha256=FugKNQhWaRuqxLiYabpXeskk9DcWVVCN2iL7A3xY-pM,3011
 files_sdk/models/user_request.py,sha256=ykA5Lq0MYB7qTDOMMFBuyKa_R_LgQwGVorC-q-6qxgU,6187
-files_sdk/models/user_sftp_client_use.py,sha256=BCjih2cUqUbdwse_YST21fbbDtCikQQE-0YnH7UPb0g,2845
+files_sdk/models/user_sftp_client_use.py,sha256=VnOo3ll6fwSc8grG5ZqGK8o3grYKg5P9b5B_hGS4vCs,2827
 files_sdk/models/web_dav_action_log.py,sha256=jPX4sOmR9TbYnsU8DU3b0-KQ8E2cHNaqdmFZKTjzpwE,56358
 files_sdk/models/webhook_test.py,sha256=dHqPZ-xhsC83rq7suHA5n6tb9M8yhg0k6i9-u-N_WWQ,4601
-files_com-1.5.4.dist-info/METADATA,sha256=RQY-ojIh55VA2goFCE1y481QHa78nfNFFCG-zdP_spE,28594
-files_com-1.5.4.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
-files_com-1.5.4.dist-info/top_level.txt,sha256=p_2P-gluT_8boeXQNixTP3x-tFd1-la2NedKOiln21I,10
-files_com-1.5.4.dist-info/RECORD,,
+files_com-1.5.6.dist-info/METADATA,sha256=rVhT26Rf3IPO67eg4JuqCYNXoGDyeBiX-QEHrqQ-qKQ,28669
+files_com-1.5.6.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
+files_com-1.5.6.dist-info/top_level.txt,sha256=p_2P-gluT_8boeXQNixTP3x-tFd1-la2NedKOiln21I,10
+files_com-1.5.6.dist-info/RECORD,,

files_sdk/__init__.py

@@ -208,11 +208,12 @@ import socket
 from urllib.parse import urlparse
 
 the_api_key = ""
+language = None
 session_id = None
 source_ip = None
 base_url = "https://app.files.com"
 base_path = "api/rest/v1"
-version = "1.5.4"
+version = "1.5.6"
 
 __version__ = version
 
@@ -224,7 +225,7 @@ max_network_retries = 3
 
 console_log_level = "none"
 
-OPTS = ("api_key", "client", "session_id", "source_ip")
+OPTS = ("api_key", "client", "session_id", "source_ip", "language")
 
 
 def set_api_key(_api_key):
@@ -237,6 +238,16 @@ def get_api_key():
     return the_api_key
 
 
+def set_language(_language):
+    global language
+    language = _language
+
+
+def get_language():
+    global language
+    return language
+
+
 def set_session(_session):
     if not _session.id:
         _session.save()

files_sdk/api.py

@@ -23,6 +23,7 @@ class Api:
         headers = copy.deepcopy(options)
         api_key = headers.pop("api_key", None)
         session_id = headers.pop("session_id", None)
+        language = headers.pop("language", None)
 
         session = headers.pop("session", None)
         if session:
@@ -31,7 +32,12 @@ class Api:
             session_id = str(session.id)
 
         response = Api.client().send_request(
-            verb, path, api_key=api_key, session_id=session_id, params=params
+            verb,
+            path,
+            api_key=api_key,
+            session_id=session_id,
+            language=language,
+            params=params,
         )
 
         # Remove options not in the allow list

files_sdk/api_client.py

@@ -48,6 +48,7 @@ class ApiClient:
         path,
         api_key=None,
         session_id=None,
+        language=None,
         headers=None,
         params=None,
     ):
@@ -66,7 +67,13 @@ class ApiClient:
                 api_key = files_sdk.get_api_key()
             self.check_api_key(api_key)
 
-        headers = {**headers, **self.request_headers(api_key, session_id)}
+        if files_sdk.language:
+            language = files_sdk.language
+
+        headers = {
+            **headers,
+            **self.request_headers(api_key, session_id, language),
+        }
 
         data = None
         query_params = None
@@ -187,7 +194,7 @@ class ApiClient:
         sleep_seconds *= 0.5 * (1 + random.random())
         return max(files_sdk.initial_network_retry_delay, sleep_seconds)
 
-    def request_headers(self, api_key, session_id):
+    def request_headers(self, api_key, session_id, language):
         user_agent = "Files.com Python SDK v{version}".format(
             version=files_sdk.version
         )
@@ -201,6 +208,8 @@ class ApiClient:
             headers["X-FilesAPI-Key"] = api_key
         if session_id:
             headers["X-FilesAPI-Auth"] = session_id
+        if language:
+            headers["Accept-Language"] = language
 
         return headers
 

files_sdk/models/automation_run.py

@@ -49,6 +49,7 @@ class AutomationRun:
 
 
 # Parameters:
+#   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
 #   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
 #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
 #   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `automation_id`, `created_at` or `status`.
@@ -59,6 +60,8 @@ def list(params=None, options=None):
         params = {}
     if not isinstance(options, dict):
         options = {}
+    if "user_id" in params and not isinstance(params["user_id"], int):
+        raise InvalidParameterError("Bad parameter: user_id must be an int")
     if "cursor" in params and not isinstance(params["cursor"], str):
         raise InvalidParameterError("Bad parameter: cursor must be an str")
     if "per_page" in params and not isinstance(params["per_page"], int):

files_sdk/models/bundle_action.py

@@ -42,6 +42,7 @@ class BundleAction:
 
 
 # Parameters:
+#   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
 #   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
 #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
 #   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`.
@@ -55,6 +56,8 @@ def list(params=None, options=None):
         params = {}
     if not isinstance(options, dict):
         options = {}
+    if "user_id" in params and not isinstance(params["user_id"], int):
+        raise InvalidParameterError("Bad parameter: user_id must be an int")
     if "cursor" in params and not isinstance(params["cursor"], str):
         raise InvalidParameterError("Bad parameter: cursor must be an str")
     if "per_page" in params and not isinstance(params["per_page"], int):

files_sdk/models/bundle_registration.py

@@ -49,6 +49,7 @@ class BundleRegistration:
 
 
 # Parameters:
+#   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
 #   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
 #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
 #   sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `bundle_id`.
@@ -58,6 +59,8 @@ def list(params=None, options=None):
         params = {}
     if not isinstance(options, dict):
         options = {}
+    if "user_id" in params and not isinstance(params["user_id"], int):
+        raise InvalidParameterError("Bad parameter: user_id must be an int")
     if "cursor" in params and not isinstance(params["cursor"], str):
         raise InvalidParameterError("Bad parameter: cursor must be an str")
     if "per_page" in params and not isinstance(params["per_page"], int):

files_sdk/models/user_cipher_use.py

@@ -43,7 +43,7 @@ class UserCipherUse:
 
 
 # Parameters:
-#   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+#   user_id - int64 - User ID. If provided, will return uses for this user.
 #   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
 #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
 def list(params=None, options=None):

files_sdk/models/user_sftp_client_use.py

@@ -41,7 +41,7 @@ class UserSftpClientUse:
 
 
 # Parameters:
-#   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
+#   user_id - int64 - User ID. If provided, will return uses for this user.
 #   cursor - string - Used for pagination.  When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`.  Send one of those cursor value here to resume an existing list from the next available record.  Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
 #   per_page - int64 - Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
 def list(params=None, options=None):