Files.com 1.4.127__tar.gz → 1.4.129__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {Files.com-1.4.127 → Files.com-1.4.129}/Files.com.egg-info/PKG-INFO +1 -1
- {Files.com-1.4.127 → Files.com-1.4.129}/PKG-INFO +1 -1
- {Files.com-1.4.127 → Files.com-1.4.129}/README.md +21 -21
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/__init__.py +1 -1
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/site.py +1 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/Files.com.egg-info/SOURCES.txt +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/Files.com.egg-info/dependency_links.txt +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/Files.com.egg-info/requires.txt +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/Files.com.egg-info/top_level.txt +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/api.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/api_client.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/error.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/list_obj.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/__init__.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/account_line_item.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/action.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/action_notification_export.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/action_notification_export_result.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/api_key.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/api_request_log.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/app.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/as2_incoming_message.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/as2_outgoing_message.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/as2_partner.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/as2_station.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/auto.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/automation.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/automation_log.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/automation_run.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/bandwidth_snapshot.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/behavior.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/bundle.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/bundle_action.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/bundle_download.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/bundle_notification.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/bundle_path.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/bundle_recipient.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/bundle_registration.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/clickwrap.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/dns_record.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/email_incoming_message.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/email_log.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/errors.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/exavault_api_request_log.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/external_event.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/file.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/file_action.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/file_comment.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/file_comment_reaction.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/file_migration.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/file_migration_log.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/file_upload_part.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/folder.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/form_field.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/form_field_set.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/ftp_action_log.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/gpg_key.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/group.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/group_user.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/history.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/history_export.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/history_export_result.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/image.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/inbox_recipient.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/inbox_registration.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/inbox_upload.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/invoice.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/invoice_line_item.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/ip_address.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/lock.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/message.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/message_comment.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/message_comment_reaction.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/message_reaction.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/notification.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/outbound_connection_log.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/payment.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/payment_line_item.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/permission.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/preview.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/priority.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/project.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/public_hosting_request_log.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/public_ip_address.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/public_key.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/remote_bandwidth_snapshot.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/remote_server.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/remote_server_configuration_file.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/request.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/session.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/settings_change.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/sftp_action_log.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/sftp_host_key.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/share_group.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/share_group_member.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/snapshot.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/sso_strategy.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/status.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/style.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/sync_log.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/usage_daily_snapshot.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/usage_snapshot.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/user.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/user_cipher_use.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/user_request.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/web_dav_action_log.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/webhook_test.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/path_util.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/util.py +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/pyproject.toml +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/setup.cfg +0 -0
- {Files.com-1.4.127 → Files.com-1.4.129}/setup.py +0 -0
|
@@ -25,9 +25,9 @@ pip3 install Files.com
|
|
|
25
25
|
|
|
26
26
|
Files.com automatically pushes a new release to PIP every time a commit is made to the `master` branch on GitHub, so there is no benefit in directly linking the package from GitHub.
|
|
27
27
|
|
|
28
|
-
### Files.com
|
|
28
|
+
### Files.com is Committed to Python
|
|
29
29
|
|
|
30
|
-
Python is the most commonly used
|
|
30
|
+
Python is the most commonly used language for custom integrations to Files.com. Our Files.com Desktop v6 application (that we publish) is also written in Python, using this exact same package.
|
|
31
31
|
|
|
32
32
|
Explore the [files-sdk-python](https://github.com/Files-com/files-sdk-python) code on GitHub.
|
|
33
33
|
|
|
@@ -73,7 +73,7 @@ session times out, simply create a new session and resume where you left off. Th
|
|
|
73
73
|
automatically handled by SDKs because we do not want to store password information in memory without
|
|
74
74
|
your explicit consent.
|
|
75
75
|
|
|
76
|
-
#### Logging
|
|
76
|
+
#### Logging In
|
|
77
77
|
|
|
78
78
|
To create a session, the `create` method is called on the `files_sdk` object with the user's username and
|
|
79
79
|
password.
|
|
@@ -84,7 +84,7 @@ This returns a session object that can be used to authenticate SDK method calls.
|
|
|
84
84
|
session = files_sdk.session.create({ "username": "motor", "password": "vroom" })
|
|
85
85
|
```
|
|
86
86
|
|
|
87
|
-
#### Using a
|
|
87
|
+
#### Using a Session
|
|
88
88
|
|
|
89
89
|
Once a session has been created, you can store the session globally, use the session per object, or use the session per request to authenticate SDK operations.
|
|
90
90
|
|
|
@@ -99,7 +99,7 @@ user = files_sdk.user.User(params, {"session_id": session.id})
|
|
|
99
99
|
files_sdk.user.find(id, params, {"session_id": session.id})
|
|
100
100
|
```
|
|
101
101
|
|
|
102
|
-
#### Logging
|
|
102
|
+
#### Logging Out
|
|
103
103
|
|
|
104
104
|
User sessions can be ended calling the `destroy` method on the `session` object.
|
|
105
105
|
|
|
@@ -109,7 +109,7 @@ session.destroy()
|
|
|
109
109
|
|
|
110
110
|
## Configuration
|
|
111
111
|
|
|
112
|
-
### Configuration
|
|
112
|
+
### Configuration Options
|
|
113
113
|
|
|
114
114
|
#### Base URL
|
|
115
115
|
|
|
@@ -120,7 +120,7 @@ This can also be set to use a mock server in development or CI.
|
|
|
120
120
|
files_sdk.base_url = "https://SUBDOMAIN.files.com"
|
|
121
121
|
```
|
|
122
122
|
|
|
123
|
-
#### Log
|
|
123
|
+
#### Log Level
|
|
124
124
|
|
|
125
125
|
This SDK utilizes the standard Python logging framework. It will respect the global log level
|
|
126
126
|
and you can set the module specific log level and other logging settings by getting the logger
|
|
@@ -131,7 +131,7 @@ import logging
|
|
|
131
131
|
logging.getLogger("files_sdk")
|
|
132
132
|
```
|
|
133
133
|
|
|
134
|
-
#### Console
|
|
134
|
+
#### Console Log Level
|
|
135
135
|
|
|
136
136
|
Enables printing of messages to stderr in addition to normal logging.
|
|
137
137
|
|
|
@@ -145,7 +145,7 @@ Allowed values are:
|
|
|
145
145
|
files_sdk.console_log_level = "info"
|
|
146
146
|
```
|
|
147
147
|
|
|
148
|
-
#### Open
|
|
148
|
+
#### Open Timeout
|
|
149
149
|
|
|
150
150
|
Open timeout in seconds. The default value is 30.
|
|
151
151
|
|
|
@@ -153,7 +153,7 @@ Open timeout in seconds. The default value is 30.
|
|
|
153
153
|
files_sdk.open_timeout = 60
|
|
154
154
|
```
|
|
155
155
|
|
|
156
|
-
#### Read
|
|
156
|
+
#### Read Timeout
|
|
157
157
|
|
|
158
158
|
Read timeout in seconds. The default value is 80.
|
|
159
159
|
|
|
@@ -161,7 +161,7 @@ Read timeout in seconds. The default value is 80.
|
|
|
161
161
|
files_sdk.read_timeout = 90
|
|
162
162
|
```
|
|
163
163
|
|
|
164
|
-
#### Initial
|
|
164
|
+
#### Initial Network Retry Delay
|
|
165
165
|
|
|
166
166
|
Initial retry delay in seconds. The default value is 0.5.
|
|
167
167
|
|
|
@@ -169,7 +169,7 @@ Initial retry delay in seconds. The default value is 0.5.
|
|
|
169
169
|
files_sdk.initial_network_retry_delay = 1
|
|
170
170
|
```
|
|
171
171
|
|
|
172
|
-
#### Maximum
|
|
172
|
+
#### Maximum Retry Delay
|
|
173
173
|
|
|
174
174
|
Maximum network retry delay in seconds. The default value is 2.
|
|
175
175
|
|
|
@@ -177,7 +177,7 @@ Maximum network retry delay in seconds. The default value is 2.
|
|
|
177
177
|
files_sdk.max_network_retry_delay = 5
|
|
178
178
|
```
|
|
179
179
|
|
|
180
|
-
#### Maximum
|
|
180
|
+
#### Maximum Network Retries
|
|
181
181
|
|
|
182
182
|
Maximum number of retries. The default value is 3.
|
|
183
183
|
|
|
@@ -446,35 +446,35 @@ If the parent directories do not already exist, they can be automatically create
|
|
|
446
446
|
files_sdk.file.upload_file("local.txt", "/uploads/remote.txt", params={"mkdir_parents": True})
|
|
447
447
|
```
|
|
448
448
|
|
|
449
|
-
#### List
|
|
449
|
+
#### List Root Folder
|
|
450
450
|
|
|
451
451
|
```python
|
|
452
452
|
for f in files_sdk.folder.list_for("/").auto_paging_iter():
|
|
453
453
|
print(f.type, f.path)
|
|
454
454
|
```
|
|
455
455
|
|
|
456
|
-
#### Writing a
|
|
456
|
+
#### Writing a File Example (string)
|
|
457
457
|
|
|
458
458
|
```python
|
|
459
459
|
with files_sdk.file.open("foo.txt", 'w') as f:
|
|
460
460
|
f.write("contents")
|
|
461
461
|
```
|
|
462
462
|
|
|
463
|
-
#### Writing a
|
|
463
|
+
#### Writing a File Example (binary)
|
|
464
464
|
|
|
465
465
|
```python
|
|
466
466
|
with files_sdk.file.open("foo.txt", 'wb') as f:
|
|
467
467
|
f.write(b"contents")
|
|
468
468
|
```
|
|
469
469
|
|
|
470
|
-
#### Reading a
|
|
470
|
+
#### Reading a File Example (string)
|
|
471
471
|
|
|
472
472
|
```python
|
|
473
473
|
with files_sdk.open("foo.txt", 'r') as f:
|
|
474
474
|
print(f.read())
|
|
475
475
|
```
|
|
476
476
|
|
|
477
|
-
#### Reading a
|
|
477
|
+
#### Reading a File Example (binary)
|
|
478
478
|
|
|
479
479
|
```python
|
|
480
480
|
with files_sdk.open("foo.txt", 'rb') as f:
|
|
@@ -488,7 +488,7 @@ which contains a single page of records. It has a built-in `auto_paging_iter`
|
|
|
488
488
|
method to iterate through the pages, making the additional API calls
|
|
489
489
|
as needed.
|
|
490
490
|
|
|
491
|
-
#### Iterating with
|
|
491
|
+
#### Iterating with auto_paging_iter
|
|
492
492
|
|
|
493
493
|
```python
|
|
494
494
|
list_obj = files_sdk.folder.list_for('/')
|
|
@@ -497,7 +497,7 @@ for f in list_obj.auto_paging_iter():
|
|
|
497
497
|
print(f.type, f.path)
|
|
498
498
|
```
|
|
499
499
|
|
|
500
|
-
#### Iterating
|
|
500
|
+
#### Iterating Manually
|
|
501
501
|
|
|
502
502
|
```python
|
|
503
503
|
list_obj = files_sdk.folder.list_for('/')
|
|
@@ -511,7 +511,7 @@ while list_obj.has_next_page:
|
|
|
511
511
|
print(f.type, f.path)
|
|
512
512
|
```
|
|
513
513
|
|
|
514
|
-
### Comparing Case
|
|
514
|
+
### Comparing Case-Insensitive Files and Paths
|
|
515
515
|
|
|
516
516
|
For related documentation see [Case Sensitivity Documentation](https://www.files.com/docs/files-and-folders/file-system-semantics/case-sensitivity).
|
|
517
517
|
|
|
@@ -10,6 +10,7 @@ from files_sdk.error import ( # noqa: F401
|
|
|
10
10
|
|
|
11
11
|
class Site:
|
|
12
12
|
default_attributes = {
|
|
13
|
+
"id": None, # int64 - Site Id
|
|
13
14
|
"name": None, # string - Site name
|
|
14
15
|
"additional_text_file_types": None, # array(string) - Additional extensions that are considered text files
|
|
15
16
|
"allowed_2fa_method_sms": None, # boolean - Is SMS two factor authentication allowed?
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/action_notification_export_result.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{Files.com-1.4.127 → Files.com-1.4.129}/files_sdk/models/remote_server_configuration_file.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|