files-com 1.5.4__tar.gz → 1.5.6__tar.gz

{files_com-1.5.4/files_com.egg-info → files_com-1.5.6}/PKG-INFO

@@ -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 → files_com-1.5.6}/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

files_com-1.5.6/_VERSION

@@ -0,0 +1 @@
+1.5.6

{files_com-1.5.4 → files_com-1.5.6/files_com.egg-info}/PKG-INFO

@@ -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 → files_com-1.5.6}/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_com-1.5.4 → files_com-1.5.6}/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_com-1.5.4 → files_com-1.5.6}/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_com-1.5.4 → files_com-1.5.6}/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_com-1.5.4 → files_com-1.5.6}/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_com-1.5.4 → files_com-1.5.6}/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_com-1.5.4 → files_com-1.5.6}/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_com-1.5.4 → files_com-1.5.6}/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):

{files_com-1.5.4 → files_com-1.5.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "files_com"
-version = "1.5.4"
+version = "1.5.6"
 description = "Python bindings for the Files.com API"
 readme = "README.md"
 license = { text = "MIT" }

files_com-1.5.4/_VERSION

@@ -1 +0,0 @@
-1.5.4