openfilz-ee-sdk 1.3.5__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 changed (174) hide show
  1. openfilz_ee_sdk-1.3.5/LICENSE +148 -0
  2. openfilz_ee_sdk-1.3.5/PKG-INFO +280 -0
  3. openfilz_ee_sdk-1.3.5/README.md +260 -0
  4. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/__init__.py +200 -0
  5. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/api/__init__.py +19 -0
  6. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/api/audit_controller_api.py +839 -0
  7. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/api/collaboration_controller_api.py +4077 -0
  8. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/api/comments_api.py +855 -0
  9. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/api/dashboard_api.py +281 -0
  10. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/api/document_controller_api.py +4310 -0
  11. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/api/document_suggestion_controller_api.py +334 -0
  12. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/api/favorites_api.py +1066 -0
  13. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/api/file_controller_api.py +1139 -0
  14. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/api/folder_controller_api.py +1973 -0
  15. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/api/notifications_api.py +1269 -0
  16. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/api/scan_agent_api.py +575 -0
  17. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/api/scanner_proxy_api.py +1373 -0
  18. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/api/search_administration_api.py +1019 -0
  19. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/api/settings_api.py +556 -0
  20. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/api/tus_controller_api.py +2475 -0
  21. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/api_client.py +805 -0
  22. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/api_response.py +21 -0
  23. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/configuration.py +586 -0
  24. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/exceptions.py +218 -0
  25. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/__init__.py +78 -0
  26. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/ancestor_info.py +92 -0
  27. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/audit_log.py +127 -0
  28. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/audit_log_details.py +131 -0
  29. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/audit_log_details_one_of.py +238 -0
  30. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/audit_verification_result.py +110 -0
  31. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/broken_link.py +91 -0
  32. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/comment_dto.py +105 -0
  33. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/copy_audit.py +94 -0
  34. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/copy_request.py +92 -0
  35. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/copy_response.py +90 -0
  36. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/create_blank_document_request.py +100 -0
  37. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/create_comment_request.py +93 -0
  38. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/create_folder_audit.py +96 -0
  39. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/create_folder_request.py +91 -0
  40. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/create_team_request.py +90 -0
  41. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/dashboard_statistics_response.py +105 -0
  42. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/delete_audit.py +90 -0
  43. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/delete_metadata_audit.py +89 -0
  44. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/delete_metadata_request.py +88 -0
  45. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/delete_request.py +88 -0
  46. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/delete_share_request.py +91 -0
  47. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/document_info.py +108 -0
  48. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/document_position.py +94 -0
  49. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/element_info.py +92 -0
  50. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/file_type_stats.py +91 -0
  51. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/filter_input.py +89 -0
  52. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/folder_element_info.py +102 -0
  53. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/folder_response.py +92 -0
  54. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/ingestion_status_dto.py +104 -0
  55. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/move_audit.py +90 -0
  56. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/move_request.py +92 -0
  57. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/notification_dto.py +115 -0
  58. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/rename_audit.py +89 -0
  59. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/rename_request.py +88 -0
  60. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/replace_audit.py +91 -0
  61. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/scan_job_status_dto.py +100 -0
  62. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/scan_request_dto.py +95 -0
  63. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/scanner_info_dto.py +103 -0
  64. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/search_by_audit_log_request.py +116 -0
  65. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/search_by_metadata_request.py +106 -0
  66. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/search_metadata_request.py +87 -0
  67. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/settings.py +97 -0
  68. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/share_request.py +102 -0
  69. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/share_result_error.py +102 -0
  70. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/share_result_item.py +90 -0
  71. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/share_result_response.py +114 -0
  72. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/sort_input.py +99 -0
  73. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/storage_breakdown.py +99 -0
  74. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/suggest.py +94 -0
  75. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/team_member_info.py +104 -0
  76. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/tus_config_response.py +95 -0
  77. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/tus_finalize_request.py +95 -0
  78. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/tus_upload_info.py +96 -0
  79. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/update_comment_request.py +91 -0
  80. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/update_metadata_audit.py +89 -0
  81. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/update_metadata_request.py +87 -0
  82. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/update_team_request.py +90 -0
  83. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/update_user_request.py +102 -0
  84. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/upload_audit.py +94 -0
  85. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/upload_response.py +98 -0
  86. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/user_preferences_request.py +89 -0
  87. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/models/user_registration_request.py +99 -0
  88. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/py.typed +0 -0
  89. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk/rest.py +263 -0
  90. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk.egg-info/PKG-INFO +280 -0
  91. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk.egg-info/SOURCES.txt +173 -0
  92. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk.egg-info/dependency_links.txt +1 -0
  93. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk.egg-info/requires.txt +4 -0
  94. openfilz_ee_sdk-1.3.5/openfilz_ee_sdk.egg-info/top_level.txt +1 -0
  95. openfilz_ee_sdk-1.3.5/pyproject.toml +95 -0
  96. openfilz_ee_sdk-1.3.5/setup.cfg +7 -0
  97. openfilz_ee_sdk-1.3.5/setup.py +48 -0
  98. openfilz_ee_sdk-1.3.5/test/test_ancestor_info.py +53 -0
  99. openfilz_ee_sdk-1.3.5/test/test_audit_controller_api.py +52 -0
  100. openfilz_ee_sdk-1.3.5/test/test_audit_log.py +58 -0
  101. openfilz_ee_sdk-1.3.5/test/test_audit_log_details.py +52 -0
  102. openfilz_ee_sdk-1.3.5/test/test_audit_log_details_one_of.py +71 -0
  103. openfilz_ee_sdk-1.3.5/test/test_audit_verification_result.py +58 -0
  104. openfilz_ee_sdk-1.3.5/test/test_broken_link.py +53 -0
  105. openfilz_ee_sdk-1.3.5/test/test_collaboration_controller_api.py +136 -0
  106. openfilz_ee_sdk-1.3.5/test/test_comment_dto.py +63 -0
  107. openfilz_ee_sdk-1.3.5/test/test_comments_api.py +52 -0
  108. openfilz_ee_sdk-1.3.5/test/test_copy_audit.py +53 -0
  109. openfilz_ee_sdk-1.3.5/test/test_copy_request.py +55 -0
  110. openfilz_ee_sdk-1.3.5/test/test_copy_response.py +52 -0
  111. openfilz_ee_sdk-1.3.5/test/test_create_blank_document_request.py +55 -0
  112. openfilz_ee_sdk-1.3.5/test/test_create_comment_request.py +61 -0
  113. openfilz_ee_sdk-1.3.5/test/test_create_folder_audit.py +54 -0
  114. openfilz_ee_sdk-1.3.5/test/test_create_folder_request.py +53 -0
  115. openfilz_ee_sdk-1.3.5/test/test_create_team_request.py +54 -0
  116. openfilz_ee_sdk-1.3.5/test/test_dashboard_api.py +38 -0
  117. openfilz_ee_sdk-1.3.5/test/test_dashboard_statistics_response.py +67 -0
  118. openfilz_ee_sdk-1.3.5/test/test_delete_audit.py +51 -0
  119. openfilz_ee_sdk-1.3.5/test/test_delete_metadata_audit.py +53 -0
  120. openfilz_ee_sdk-1.3.5/test/test_delete_metadata_request.py +56 -0
  121. openfilz_ee_sdk-1.3.5/test/test_delete_request.py +53 -0
  122. openfilz_ee_sdk-1.3.5/test/test_delete_share_request.py +62 -0
  123. openfilz_ee_sdk-1.3.5/test/test_document_controller_api.py +136 -0
  124. openfilz_ee_sdk-1.3.5/test/test_document_info.py +58 -0
  125. openfilz_ee_sdk-1.3.5/test/test_document_position.py +54 -0
  126. openfilz_ee_sdk-1.3.5/test/test_document_suggestion_controller_api.py +37 -0
  127. openfilz_ee_sdk-1.3.5/test/test_element_info.py +53 -0
  128. openfilz_ee_sdk-1.3.5/test/test_favorites_api.py +59 -0
  129. openfilz_ee_sdk-1.3.5/test/test_file_controller_api.py +59 -0
  130. openfilz_ee_sdk-1.3.5/test/test_file_type_stats.py +53 -0
  131. openfilz_ee_sdk-1.3.5/test/test_filter_input.py +52 -0
  132. openfilz_ee_sdk-1.3.5/test/test_folder_controller_api.py +80 -0
  133. openfilz_ee_sdk-1.3.5/test/test_folder_element_info.py +53 -0
  134. openfilz_ee_sdk-1.3.5/test/test_folder_response.py +53 -0
  135. openfilz_ee_sdk-1.3.5/test/test_ingestion_status_dto.py +59 -0
  136. openfilz_ee_sdk-1.3.5/test/test_move_audit.py +51 -0
  137. openfilz_ee_sdk-1.3.5/test/test_move_request.py +55 -0
  138. openfilz_ee_sdk-1.3.5/test/test_notification_dto.py +59 -0
  139. openfilz_ee_sdk-1.3.5/test/test_notifications_api.py +66 -0
  140. openfilz_ee_sdk-1.3.5/test/test_rename_audit.py +51 -0
  141. openfilz_ee_sdk-1.3.5/test/test_rename_request.py +52 -0
  142. openfilz_ee_sdk-1.3.5/test/test_replace_audit.py +54 -0
  143. openfilz_ee_sdk-1.3.5/test/test_scan_agent_api.py +45 -0
  144. openfilz_ee_sdk-1.3.5/test/test_scan_job_status_dto.py +57 -0
  145. openfilz_ee_sdk-1.3.5/test/test_scan_request_dto.py +55 -0
  146. openfilz_ee_sdk-1.3.5/test/test_scanner_info_dto.py +65 -0
  147. openfilz_ee_sdk-1.3.5/test/test_scanner_proxy_api.py +66 -0
  148. openfilz_ee_sdk-1.3.5/test/test_search_administration_api.py +59 -0
  149. openfilz_ee_sdk-1.3.5/test/test_search_by_audit_log_request.py +57 -0
  150. openfilz_ee_sdk-1.3.5/test/test_search_by_metadata_request.py +57 -0
  151. openfilz_ee_sdk-1.3.5/test/test_search_metadata_request.py +53 -0
  152. openfilz_ee_sdk-1.3.5/test/test_settings.py +56 -0
  153. openfilz_ee_sdk-1.3.5/test/test_settings_api.py +45 -0
  154. openfilz_ee_sdk-1.3.5/test/test_share_request.py +65 -0
  155. openfilz_ee_sdk-1.3.5/test/test_share_result_error.py +53 -0
  156. openfilz_ee_sdk-1.3.5/test/test_share_result_item.py +52 -0
  157. openfilz_ee_sdk-1.3.5/test/test_share_result_response.py +66 -0
  158. openfilz_ee_sdk-1.3.5/test/test_sort_input.py +52 -0
  159. openfilz_ee_sdk-1.3.5/test/test_storage_breakdown.py +58 -0
  160. openfilz_ee_sdk-1.3.5/test/test_suggest.py +54 -0
  161. openfilz_ee_sdk-1.3.5/test/test_team_member_info.py +54 -0
  162. openfilz_ee_sdk-1.3.5/test/test_tus_config_response.py +55 -0
  163. openfilz_ee_sdk-1.3.5/test/test_tus_controller_api.py +94 -0
  164. openfilz_ee_sdk-1.3.5/test/test_tus_finalize_request.py +57 -0
  165. openfilz_ee_sdk-1.3.5/test/test_tus_upload_info.py +55 -0
  166. openfilz_ee_sdk-1.3.5/test/test_update_comment_request.py +55 -0
  167. openfilz_ee_sdk-1.3.5/test/test_update_metadata_audit.py +53 -0
  168. openfilz_ee_sdk-1.3.5/test/test_update_metadata_request.py +56 -0
  169. openfilz_ee_sdk-1.3.5/test/test_update_team_request.py +54 -0
  170. openfilz_ee_sdk-1.3.5/test/test_update_user_request.py +55 -0
  171. openfilz_ee_sdk-1.3.5/test/test_upload_audit.py +55 -0
  172. openfilz_ee_sdk-1.3.5/test/test_upload_response.py +56 -0
  173. openfilz_ee_sdk-1.3.5/test/test_user_preferences_request.py +52 -0
  174. openfilz_ee_sdk-1.3.5/test/test_user_registration_request.py +56 -0
@@ -0,0 +1,148 @@
1
+ ================================================================================
2
+ OPENFILZ COMMERCIAL LICENSE AGREEMENT
3
+ Version 1.0, April 2026
4
+ ================================================================================
5
+
6
+ Copyright (c) 2024-2026 OpenFilz SAS. All rights reserved.
7
+
8
+ IMPORTANT: READ THIS LICENSE AGREEMENT CAREFULLY BEFORE USING THE SOFTWARE.
9
+
10
+ ================================================================================
11
+ 1. GRANT OF LICENSE
12
+ ================================================================================
13
+
14
+ Subject to the terms of this Agreement and the payment of applicable license
15
+ fees, OpenFilz SAS ("Licensor") grants you ("Licensee") a non-exclusive,
16
+ non-transferable, non-sublicensable license to use, modify, and deploy the
17
+ OpenFilz Enterprise Edition software ("Software") solely for your internal
18
+ business purposes, in accordance with the scope defined in your License file.
19
+
20
+ ================================================================================
21
+ 2. SCOPE AND PERMITTED USE
22
+ ================================================================================
23
+
24
+ Under this Commercial License, you may:
25
+
26
+ (a) Install and use the Software on the number of servers and for the
27
+ number of Authorized Users specified in your License file;
28
+ (b) Modify the Software for your internal business purposes;
29
+ (c) Create derivative works based on the Software for your internal
30
+ business purposes;
31
+ (d) Deploy the Software as part of your internal or customer-facing
32
+ applications WITHOUT the copyleft obligations of the AGPL v3 license;
33
+ (e) Integrate the Software with proprietary software without disclosing
34
+ the source code of your proprietary components.
35
+
36
+ ================================================================================
37
+ 3. RELATIONSHIP TO OPEN-SOURCE COMPONENTS
38
+ ================================================================================
39
+
40
+ 3.1 The OpenFilz Community Edition (openfilz-core, openfilz-web) is
41
+ available under the GNU Affero General Public License v3 (AGPL-3.0).
42
+
43
+ 3.2 This Commercial License provides an alternative to the AGPL-3.0 for
44
+ organizations that:
45
+ (a) Cannot comply with the copyleft requirements of AGPL-3.0;
46
+ (b) Wish to integrate OpenFilz into proprietary products or services
47
+ without disclosing source code;
48
+ (c) Require SaaS/hosted deployment without AGPL-3.0 network interaction
49
+ obligations (Section 13 of AGPL-3.0);
50
+ (d) Need to sublicense or redistribute OpenFilz as part of a
51
+ proprietary offering.
52
+
53
+ 3.3 The Commercial License supersedes and replaces the AGPL-3.0 for
54
+ the specific Software components covered by your License file.
55
+
56
+ ================================================================================
57
+ 4. RESTRICTIONS
58
+ ================================================================================
59
+
60
+ You shall NOT:
61
+
62
+ (a) Sublicense, lease, rent, loan, distribute, sell, resell, or otherwise
63
+ transfer the Software or any rights therein to any third party,
64
+ except as expressly permitted in this Agreement;
65
+ (b) Remove, alter, or obscure any proprietary notices, labels, or marks
66
+ on the Software;
67
+ (c) Use the Software in excess of the Authorized Users or Licensed
68
+ Features specified in your License file;
69
+ (d) Circumvent, disable, or tamper with any license verification,
70
+ activation, or enforcement mechanisms in the Software;
71
+ (e) Share, publish, or disclose license keys, mTLS certificates, or
72
+ other security credentials provided with the Software;
73
+ (f) Use the Software for any unlawful purpose;
74
+ (g) Benchmark, test, or evaluate the Software for the purpose of
75
+ developing a competing product or service.
76
+
77
+ ================================================================================
78
+ 5. INTELLECTUAL PROPERTY
79
+ ================================================================================
80
+
81
+ 5.1 The Software is and shall remain the sole and exclusive property of
82
+ OpenFilz SAS. This Agreement does not convey any ownership rights.
83
+
84
+ 5.2 The Software is protected by copyright laws, international copyright
85
+ treaties, and other intellectual property laws.
86
+
87
+ 5.3 Any modifications or derivative works you create remain subject to the
88
+ restrictions of this Agreement.
89
+
90
+ ================================================================================
91
+ 6. WARRANTY DISCLAIMER
92
+ ================================================================================
93
+
94
+ THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTIES OF ANY KIND, WHETHER
95
+ EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, INCLUDING BUT NOT LIMITED TO
96
+ WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND
97
+ NON-INFRINGEMENT.
98
+
99
+ ================================================================================
100
+ 7. LIMITATION OF LIABILITY
101
+ ================================================================================
102
+
103
+ TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, OPENFILZ SAS SHALL NOT BE
104
+ LIABLE FOR ANY INDIRECT, INCIDENTAL, SPECIAL, CONSEQUENTIAL, OR PUNITIVE
105
+ DAMAGES ARISING OUT OF OR RELATED TO THIS AGREEMENT. OPENFILZ SAS'S TOTAL
106
+ AGGREGATE LIABILITY SHALL NOT EXCEED THE FEES PAID BY YOU DURING THE TWELVE
107
+ (12) MONTHS PRECEDING THE CLAIM.
108
+
109
+ ================================================================================
110
+ 8. TERM AND TERMINATION
111
+ ================================================================================
112
+
113
+ 8.1 This License is effective for the License Term specified in your License
114
+ file.
115
+
116
+ 8.2 OpenFilz SAS may terminate this License upon material breach that
117
+ remains uncured for fifteen (15) days after written notice.
118
+
119
+ 8.3 Upon termination, you must cease all use of the Software and destroy
120
+ all copies.
121
+
122
+ ================================================================================
123
+ 9. GOVERNING LAW
124
+ ================================================================================
125
+
126
+ This Agreement is governed by the laws of France. Any disputes shall be
127
+ submitted to the exclusive jurisdiction of the courts of Paris, France.
128
+
129
+ ================================================================================
130
+ 10. OBTAINING A COMMERCIAL LICENSE
131
+ ================================================================================
132
+
133
+ To obtain a Commercial License for OpenFilz Enterprise Edition, contact:
134
+
135
+ OpenFilz SAS
136
+ Website: https://openfilz.com
137
+ Email: license@openfilz.com
138
+ Sales: sales@openfilz.com
139
+
140
+ ================================================================================
141
+
142
+ For the full terms and conditions governing the use of OpenFilz Enterprise
143
+ Edition, please refer to the Software License Agreement provided with your
144
+ License file, or contact license@openfilz.com.
145
+
146
+ Copyright (c) 2024-2026 OpenFilz SAS. All rights reserved.
147
+
148
+ ================================================================================
@@ -0,0 +1,280 @@
1
+ Metadata-Version: 2.4
2
+ Name: openfilz_ee_sdk
3
+ Version: 1.3.5
4
+ Summary: openfilz-api
5
+ Home-page:
6
+ Author: OpenAPI Generator community
7
+ Author-email: OpenAPI Generator Community <team@openapitools.org>
8
+ License: AGPL-3.0
9
+ Project-URL: Repository, https://github.com/openfilz/openfilz-ee
10
+ Keywords: OpenAPI,OpenAPI-Generator,openfilz-api
11
+ Requires-Python: >=3.9
12
+ Description-Content-Type: text/markdown
13
+ License-File: LICENSE
14
+ Requires-Dist: urllib3<3.0.0,>=2.1.0
15
+ Requires-Dist: python-dateutil>=2.8.2
16
+ Requires-Dist: pydantic>=2
17
+ Requires-Dist: typing-extensions>=4.7.1
18
+ Dynamic: author
19
+ Dynamic: license-file
20
+
21
+ # openfilz-ee-sdk-python
22
+ API for Document Management System
23
+
24
+ This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
25
+
26
+ - API version: 1.0.0
27
+ - Package version: 1.3.5
28
+ - Generator version: 7.20.0
29
+ - Build package: org.openapitools.codegen.languages.PythonClientCodegen
30
+
31
+ ## Requirements.
32
+
33
+ Python 3.9+
34
+
35
+ ## Installation & Usage
36
+ ### pip install
37
+
38
+ If the python package is hosted on a repository, you can install directly using:
39
+
40
+ ```sh
41
+ pip install git+https://github.com/openfilz/openfilz-ee.git
42
+ ```
43
+ (you may need to run `pip` with root permission: `sudo pip install git+https://github.com/openfilz/openfilz-ee.git`)
44
+
45
+ Then import the package:
46
+ ```python
47
+ import openfilz_ee_sdk
48
+ ```
49
+
50
+ ### Setuptools
51
+
52
+ Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
53
+
54
+ ```sh
55
+ python setup.py install --user
56
+ ```
57
+ (or `sudo python setup.py install` to install the package for all users)
58
+
59
+ Then import the package:
60
+ ```python
61
+ import openfilz_ee_sdk
62
+ ```
63
+
64
+ ### Tests
65
+
66
+ Execute `pytest` to run the tests.
67
+
68
+ ## Getting Started
69
+
70
+ Please follow the [installation procedure](#installation--usage) and then run the following:
71
+
72
+ ```python
73
+
74
+ import openfilz_ee_sdk
75
+ from openfilz_ee_sdk.rest import ApiException
76
+ from pprint import pprint
77
+
78
+ # Defining the host is optional and defaults to http://localhost:8081
79
+ # See configuration.py for a list of all supported configuration parameters.
80
+ configuration = openfilz_ee_sdk.Configuration(
81
+ host = "http://localhost:8081"
82
+ )
83
+
84
+ # The client must configure the authentication and authorization parameters
85
+ # in accordance with the API server security policy.
86
+ # Examples for each auth method are provided below, use the example that
87
+ # satisfies your auth use case.
88
+
89
+ # Configure Bearer authorization (JWT): keycloak_auth
90
+ configuration = openfilz_ee_sdk.Configuration(
91
+ access_token = os.environ["BEARER_TOKEN"]
92
+ )
93
+
94
+
95
+ # Enter a context with an instance of the API client
96
+ with openfilz_ee_sdk.ApiClient(configuration) as api_client:
97
+ # Create an instance of the API class
98
+ api_instance = openfilz_ee_sdk.CommentsApi(api_client)
99
+ create_comment_request = openfilz_ee_sdk.CreateCommentRequest() # CreateCommentRequest |
100
+
101
+ try:
102
+ # Create a comment
103
+ api_response = api_instance.create_comment(create_comment_request)
104
+ print("The response of CommentsApi->create_comment:\n")
105
+ pprint(api_response)
106
+ except ApiException as e:
107
+ print("Exception when calling CommentsApi->create_comment: %s\n" % e)
108
+
109
+ ```
110
+
111
+ ## Documentation for API Endpoints
112
+
113
+ All URIs are relative to *http://localhost:8081*
114
+
115
+ Class | Method | HTTP request | Description
116
+ ------------ | ------------- | ------------- | -------------
117
+ *CommentsApi* | [**create_comment**](docs/CommentsApi.md#create_comment) | **POST** /api/v1/documents/comments | Create a comment
118
+ *CommentsApi* | [**delete_comment**](docs/CommentsApi.md#delete_comment) | **DELETE** /api/v1/documents/comments/{id} | Delete a comment
119
+ *CommentsApi* | [**update_comment**](docs/CommentsApi.md#update_comment) | **PUT** /api/v1/documents/comments/{id} | Update a comment
120
+ *DashboardApi* | [**get_dashboard_statistics**](docs/DashboardApi.md#get_dashboard_statistics) | **GET** /api/v1/dashboard/statistics | Get dashboard statistics
121
+ *FavoritesApi* | [**add_favorite**](docs/FavoritesApi.md#add_favorite) | **POST** /api/v1/favorites/{documentId} | Add document to favorites
122
+ *FavoritesApi* | [**is_favorite**](docs/FavoritesApi.md#is_favorite) | **GET** /api/v1/favorites/{documentId}/is-favorite | Check favorite status
123
+ *FavoritesApi* | [**remove_favorite**](docs/FavoritesApi.md#remove_favorite) | **DELETE** /api/v1/favorites/{documentId} | Remove document from favorites
124
+ *FavoritesApi* | [**toggle_favorite**](docs/FavoritesApi.md#toggle_favorite) | **PUT** /api/v1/favorites/{documentId}/toggle | Toggle favorite status
125
+ *NotificationsApi* | [**get_notifications**](docs/NotificationsApi.md#get_notifications) | **GET** /api/v1/notifications | Get all notifications
126
+ *NotificationsApi* | [**get_unread_count**](docs/NotificationsApi.md#get_unread_count) | **GET** /api/v1/notifications/unread/count | Get unread notification count
127
+ *NotificationsApi* | [**mark_all_as_read**](docs/NotificationsApi.md#mark_all_as_read) | **PUT** /api/v1/notifications/read-all | Mark all notifications as read
128
+ *NotificationsApi* | [**mark_as_read**](docs/NotificationsApi.md#mark_as_read) | **PUT** /api/v1/notifications/{id}/read | Mark notification as read
129
+ *NotificationsApi* | [**stream_notifications**](docs/NotificationsApi.md#stream_notifications) | **GET** /api/v1/notifications/stream | Subscribe to notification stream
130
+ *ScanAgentApi* | [**download**](docs/ScanAgentApi.md#download) | **GET** /api/v1/agent/download/{platform} | Download agent binary
131
+ *ScanAgentApi* | [**get_version**](docs/ScanAgentApi.md#get_version) | **GET** /api/v1/agent/version | Get agent version
132
+ *ScannerProxyApi* | [**get_ingestion_status**](docs/ScannerProxyApi.md#get_ingestion_status) | **GET** /api/v1/scan/status | Get ingestion status
133
+ *ScannerProxyApi* | [**get_scan_job_status**](docs/ScannerProxyApi.md#get_scan_job_status) | **GET** /api/v1/scan/scanners/{id}/scan/{jobId}/status | Get scan job status
134
+ *ScannerProxyApi* | [**get_scanner_capabilities**](docs/ScannerProxyApi.md#get_scanner_capabilities) | **GET** /api/v1/scan/scanners/{id}/capabilities | Get scanner capabilities
135
+ *ScannerProxyApi* | [**list_scanners**](docs/ScannerProxyApi.md#list_scanners) | **GET** /api/v1/scan/scanners | List scanners
136
+ *ScannerProxyApi* | [**trigger_scan**](docs/ScannerProxyApi.md#trigger_scan) | **POST** /api/v1/scan/scanners/{id}/scan | Trigger scan
137
+ *SearchAdministrationApi* | [**create_index**](docs/SearchAdministrationApi.md#create_index) | **POST** /api/v1/admin/search | Create search index
138
+ *SearchAdministrationApi* | [**delete_index**](docs/SearchAdministrationApi.md#delete_index) | **DELETE** /api/v1/admin/search | Delete search index
139
+ *SearchAdministrationApi* | [**get_status**](docs/SearchAdministrationApi.md#get_status) | **GET** /api/v1/admin/search/status | Get reindexation status
140
+ *SearchAdministrationApi* | [**reindex_all**](docs/SearchAdministrationApi.md#reindex_all) | **POST** /api/v1/admin/search/reindex | Reindex all documents
141
+ *SettingsApi* | [**get_settings**](docs/SettingsApi.md#get_settings) | **GET** /api/v1/settings | Get user&#39;s settings
142
+ *SettingsApi* | [**save_settings**](docs/SettingsApi.md#save_settings) | **PUT** /api/v1/settings | Save user preferences
143
+ *AuditControllerApi* | [**get_audit_trail**](docs/AuditControllerApi.md#get_audit_trail) | **GET** /api/v1/audit/{id} | Get audit trail for a resource
144
+ *AuditControllerApi* | [**search_audit_trail**](docs/AuditControllerApi.md#search_audit_trail) | **POST** /api/v1/audit/search | Search for audit trails
145
+ *AuditControllerApi* | [**verify_chain**](docs/AuditControllerApi.md#verify_chain) | **GET** /api/v1/audit/verify | Verify audit chain integrity
146
+ *CollaborationControllerApi* | [**accept_share_request**](docs/CollaborationControllerApi.md#accept_share_request) | **POST** /api/v1/users/share-requests/{id}/accept | Accept a share request
147
+ *CollaborationControllerApi* | [**add_team_members**](docs/CollaborationControllerApi.md#add_team_members) | **POST** /api/v1/users/teams/{teamId}/members | Add team members
148
+ *CollaborationControllerApi* | [**create_shared_documents**](docs/CollaborationControllerApi.md#create_shared_documents) | **POST** /api/v1/users/share | Create Share for document(s)
149
+ *CollaborationControllerApi* | [**create_team**](docs/CollaborationControllerApi.md#create_team) | **POST** /api/v1/users/teams | Create a team
150
+ *CollaborationControllerApi* | [**create_user**](docs/CollaborationControllerApi.md#create_user) | **POST** /api/v1/users | Create a new user
151
+ *CollaborationControllerApi* | [**deactivate_user**](docs/CollaborationControllerApi.md#deactivate_user) | **DELETE** /api/v1/users/{userId} | Deactivate a user
152
+ *CollaborationControllerApi* | [**delete_shared_documents**](docs/CollaborationControllerApi.md#delete_shared_documents) | **DELETE** /api/v1/users/share | Delete Share for document(s)
153
+ *CollaborationControllerApi* | [**delete_team**](docs/CollaborationControllerApi.md#delete_team) | **DELETE** /api/v1/users/teams/{teamId} | Delete a team
154
+ *CollaborationControllerApi* | [**get_team_members**](docs/CollaborationControllerApi.md#get_team_members) | **GET** /api/v1/users/teams/{teamId}/members | Get team members
155
+ *CollaborationControllerApi* | [**get_user_status**](docs/CollaborationControllerApi.md#get_user_status) | **GET** /api/v1/users/me/status | Check user status
156
+ *CollaborationControllerApi* | [**reject_share_request**](docs/CollaborationControllerApi.md#reject_share_request) | **DELETE** /api/v1/users/share-requests/{id} | Reject a share request
157
+ *CollaborationControllerApi* | [**remove_team_members**](docs/CollaborationControllerApi.md#remove_team_members) | **DELETE** /api/v1/users/teams/{teamId}/members | Remove team members
158
+ *CollaborationControllerApi* | [**update_shared_documents**](docs/CollaborationControllerApi.md#update_shared_documents) | **PUT** /api/v1/users/share | Update Share for document(s)
159
+ *CollaborationControllerApi* | [**update_team**](docs/CollaborationControllerApi.md#update_team) | **PUT** /api/v1/users/teams/{teamId} | Update a team
160
+ *CollaborationControllerApi* | [**update_user**](docs/CollaborationControllerApi.md#update_user) | **PUT** /api/v1/users/{userId} | Update a user
161
+ *DocumentControllerApi* | [**create_blank_document**](docs/DocumentControllerApi.md#create_blank_document) | **POST** /api/v1/documents/create-blank | Create a blank document from template
162
+ *DocumentControllerApi* | [**delete_document_metadata**](docs/DocumentControllerApi.md#delete_document_metadata) | **DELETE** /api/v1/documents/{documentId}/metadata | Delete specific metadata keys
163
+ *DocumentControllerApi* | [**download_document**](docs/DocumentControllerApi.md#download_document) | **GET** /api/v1/documents/{documentId}/download | Download a document
164
+ *DocumentControllerApi* | [**download_for_only_office**](docs/DocumentControllerApi.md#download_for_only_office) | **GET** /api/v1/documents/{documentId}/onlyoffice-download | Download document for OnlyOffice
165
+ *DocumentControllerApi* | [**download_multiple_documents_as_zip**](docs/DocumentControllerApi.md#download_multiple_documents_as_zip) | **POST** /api/v1/documents/download-multiple | Download multiple documents as ZIP
166
+ *DocumentControllerApi* | [**get_document_ancestors**](docs/DocumentControllerApi.md#get_document_ancestors) | **GET** /api/v1/documents/{documentId}/ancestors | Get document ancestors
167
+ *DocumentControllerApi* | [**get_document_info**](docs/DocumentControllerApi.md#get_document_info) | **GET** /api/v1/documents/{documentId}/info | Get information of a document
168
+ *DocumentControllerApi* | [**get_document_metadata**](docs/DocumentControllerApi.md#get_document_metadata) | **POST** /api/v1/documents/{documentId}/search/metadata | Search metadata of a document
169
+ *DocumentControllerApi* | [**get_document_position**](docs/DocumentControllerApi.md#get_document_position) | **GET** /api/v1/documents/{documentId}/position | Get document position in folder
170
+ *DocumentControllerApi* | [**replace_document_content**](docs/DocumentControllerApi.md#replace_document_content) | **PUT** /api/v1/documents/{documentId}/replace-content | Replace document content
171
+ *DocumentControllerApi* | [**replace_document_metadata**](docs/DocumentControllerApi.md#replace_document_metadata) | **PUT** /api/v1/documents/{documentId}/replace-metadata | Replace document metadata
172
+ *DocumentControllerApi* | [**search_document_ids_by_metadata**](docs/DocumentControllerApi.md#search_document_ids_by_metadata) | **POST** /api/v1/documents/search/ids-by-metadata | Search document IDs by metadata
173
+ *DocumentControllerApi* | [**update_document_metadata**](docs/DocumentControllerApi.md#update_document_metadata) | **PATCH** /api/v1/documents/{documentId}/metadata | Update document metadata
174
+ *DocumentControllerApi* | [**upload_document**](docs/DocumentControllerApi.md#upload_document) | **POST** /api/v1/documents/upload-multiple | Upload multiple documents
175
+ *DocumentControllerApi* | [**upload_document1**](docs/DocumentControllerApi.md#upload_document1) | **POST** /api/v1/documents/upload | Upload a single document
176
+ *DocumentSuggestionControllerApi* | [**get_suggestions**](docs/DocumentSuggestionControllerApi.md#get_suggestions) | **GET** /api/v1/suggestions |
177
+ *FileControllerApi* | [**copy_files**](docs/FileControllerApi.md#copy_files) | **POST** /api/v1/files/copy | Copy files
178
+ *FileControllerApi* | [**delete_files**](docs/FileControllerApi.md#delete_files) | **DELETE** /api/v1/files | Delete files
179
+ *FileControllerApi* | [**move_files**](docs/FileControllerApi.md#move_files) | **POST** /api/v1/files/move | Move files
180
+ *FileControllerApi* | [**rename_file**](docs/FileControllerApi.md#rename_file) | **PUT** /api/v1/files/{fileId}/rename | Rename a file
181
+ *FolderControllerApi* | [**copy_folders**](docs/FolderControllerApi.md#copy_folders) | **POST** /api/v1/folders/copy | Copy folders
182
+ *FolderControllerApi* | [**count_folder_elements**](docs/FolderControllerApi.md#count_folder_elements) | **GET** /api/v1/folders/count | Count files and subfolders contained in a given folder - return 0 if empty or not exists
183
+ *FolderControllerApi* | [**create_folder**](docs/FolderControllerApi.md#create_folder) | **POST** /api/v1/folders | Create a new folder
184
+ *FolderControllerApi* | [**delete_folders**](docs/FolderControllerApi.md#delete_folders) | **DELETE** /api/v1/folders | Delete folders
185
+ *FolderControllerApi* | [**list_folder**](docs/FolderControllerApi.md#list_folder) | **GET** /api/v1/folders/list | List files and subfolders contained in a given folder
186
+ *FolderControllerApi* | [**move_folders**](docs/FolderControllerApi.md#move_folders) | **POST** /api/v1/folders/move | Move folders
187
+ *FolderControllerApi* | [**rename_folder**](docs/FolderControllerApi.md#rename_folder) | **PUT** /api/v1/folders/{folderId}/rename | Rename a folder
188
+ *TusControllerApi* | [**cancel_upload**](docs/TusControllerApi.md#cancel_upload) | **DELETE** /api/v1/tus/{uploadId} | Cancel upload
189
+ *TusControllerApi* | [**create_upload**](docs/TusControllerApi.md#create_upload) | **POST** /api/v1/tus | Create new TUS upload
190
+ *TusControllerApi* | [**finalize_upload**](docs/TusControllerApi.md#finalize_upload) | **POST** /api/v1/tus/{uploadId}/finalize | Finalize upload
191
+ *TusControllerApi* | [**get_config**](docs/TusControllerApi.md#get_config) | **GET** /api/v1/tus/config | Get TUS configuration
192
+ *TusControllerApi* | [**get_upload_info**](docs/TusControllerApi.md#get_upload_info) | **GET** /api/v1/tus/{uploadId}/info | Get upload information
193
+ *TusControllerApi* | [**get_upload_offset**](docs/TusControllerApi.md#get_upload_offset) | **HEAD** /api/v1/tus/{uploadId} | Get upload progress
194
+ *TusControllerApi* | [**is_upload_complete**](docs/TusControllerApi.md#is_upload_complete) | **GET** /api/v1/tus/{uploadId}/complete | Check upload completion
195
+ *TusControllerApi* | [**options**](docs/TusControllerApi.md#options) | **OPTIONS** /api/v1/tus | TUS capability discovery
196
+ *TusControllerApi* | [**upload_chunk**](docs/TusControllerApi.md#upload_chunk) | **PATCH** /api/v1/tus/{uploadId} | Upload chunk
197
+
198
+
199
+ ## Documentation For Models
200
+
201
+ - [AncestorInfo](docs/AncestorInfo.md)
202
+ - [AuditLog](docs/AuditLog.md)
203
+ - [AuditLogDetails](docs/AuditLogDetails.md)
204
+ - [AuditLogDetailsOneOf](docs/AuditLogDetailsOneOf.md)
205
+ - [AuditVerificationResult](docs/AuditVerificationResult.md)
206
+ - [BrokenLink](docs/BrokenLink.md)
207
+ - [CommentDTO](docs/CommentDTO.md)
208
+ - [CopyAudit](docs/CopyAudit.md)
209
+ - [CopyRequest](docs/CopyRequest.md)
210
+ - [CopyResponse](docs/CopyResponse.md)
211
+ - [CreateBlankDocumentRequest](docs/CreateBlankDocumentRequest.md)
212
+ - [CreateCommentRequest](docs/CreateCommentRequest.md)
213
+ - [CreateFolderAudit](docs/CreateFolderAudit.md)
214
+ - [CreateFolderRequest](docs/CreateFolderRequest.md)
215
+ - [CreateTeamRequest](docs/CreateTeamRequest.md)
216
+ - [DashboardStatisticsResponse](docs/DashboardStatisticsResponse.md)
217
+ - [DeleteAudit](docs/DeleteAudit.md)
218
+ - [DeleteMetadataAudit](docs/DeleteMetadataAudit.md)
219
+ - [DeleteMetadataRequest](docs/DeleteMetadataRequest.md)
220
+ - [DeleteRequest](docs/DeleteRequest.md)
221
+ - [DeleteShareRequest](docs/DeleteShareRequest.md)
222
+ - [DocumentInfo](docs/DocumentInfo.md)
223
+ - [DocumentPosition](docs/DocumentPosition.md)
224
+ - [ElementInfo](docs/ElementInfo.md)
225
+ - [FileTypeStats](docs/FileTypeStats.md)
226
+ - [FilterInput](docs/FilterInput.md)
227
+ - [FolderElementInfo](docs/FolderElementInfo.md)
228
+ - [FolderResponse](docs/FolderResponse.md)
229
+ - [IngestionStatusDto](docs/IngestionStatusDto.md)
230
+ - [MoveAudit](docs/MoveAudit.md)
231
+ - [MoveRequest](docs/MoveRequest.md)
232
+ - [NotificationDTO](docs/NotificationDTO.md)
233
+ - [RenameAudit](docs/RenameAudit.md)
234
+ - [RenameRequest](docs/RenameRequest.md)
235
+ - [ReplaceAudit](docs/ReplaceAudit.md)
236
+ - [ScanJobStatusDto](docs/ScanJobStatusDto.md)
237
+ - [ScanRequestDto](docs/ScanRequestDto.md)
238
+ - [ScannerInfoDto](docs/ScannerInfoDto.md)
239
+ - [SearchByAuditLogRequest](docs/SearchByAuditLogRequest.md)
240
+ - [SearchByMetadataRequest](docs/SearchByMetadataRequest.md)
241
+ - [SearchMetadataRequest](docs/SearchMetadataRequest.md)
242
+ - [Settings](docs/Settings.md)
243
+ - [ShareRequest](docs/ShareRequest.md)
244
+ - [ShareResultError](docs/ShareResultError.md)
245
+ - [ShareResultItem](docs/ShareResultItem.md)
246
+ - [ShareResultResponse](docs/ShareResultResponse.md)
247
+ - [SortInput](docs/SortInput.md)
248
+ - [StorageBreakdown](docs/StorageBreakdown.md)
249
+ - [Suggest](docs/Suggest.md)
250
+ - [TeamMemberInfo](docs/TeamMemberInfo.md)
251
+ - [TusConfigResponse](docs/TusConfigResponse.md)
252
+ - [TusFinalizeRequest](docs/TusFinalizeRequest.md)
253
+ - [TusUploadInfo](docs/TusUploadInfo.md)
254
+ - [UpdateCommentRequest](docs/UpdateCommentRequest.md)
255
+ - [UpdateMetadataAudit](docs/UpdateMetadataAudit.md)
256
+ - [UpdateMetadataRequest](docs/UpdateMetadataRequest.md)
257
+ - [UpdateTeamRequest](docs/UpdateTeamRequest.md)
258
+ - [UpdateUserRequest](docs/UpdateUserRequest.md)
259
+ - [UploadAudit](docs/UploadAudit.md)
260
+ - [UploadResponse](docs/UploadResponse.md)
261
+ - [UserPreferencesRequest](docs/UserPreferencesRequest.md)
262
+ - [UserRegistrationRequest](docs/UserRegistrationRequest.md)
263
+
264
+
265
+ <a id="documentation-for-authorization"></a>
266
+ ## Documentation For Authorization
267
+
268
+
269
+ Authentication schemes defined for the API:
270
+ <a id="keycloak_auth"></a>
271
+ ### keycloak_auth
272
+
273
+ - **Type**: Bearer authentication (JWT)
274
+
275
+
276
+ ## Author
277
+
278
+
279
+
280
+