files-com 1.5.0__py3-none-any.whl

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.

Potentially problematic release.


This version of files-com might be problematic. Click here for more details.

Files changed (113) hide show
  1. README.md +682 -0
  2. _VERSION +1 -0
  3. files_com-1.5.0.dist-info/METADATA +694 -0
  4. files_com-1.5.0.dist-info/RECORD +113 -0
  5. files_com-1.5.0.dist-info/WHEEL +5 -0
  6. files_com-1.5.0.dist-info/licenses/LICENSE +21 -0
  7. files_com-1.5.0.dist-info/top_level.txt +1 -0
  8. files_sdk/__init__.py +270 -0
  9. files_sdk/api.py +57 -0
  10. files_sdk/api_client.py +327 -0
  11. files_sdk/error.py +2891 -0
  12. files_sdk/list_obj.py +42 -0
  13. files_sdk/models/__init__.py +104 -0
  14. files_sdk/models/account_line_item.py +51 -0
  15. files_sdk/models/action.py +49 -0
  16. files_sdk/models/action_notification_export.py +147 -0
  17. files_sdk/models/action_notification_export_result.py +88 -0
  18. files_sdk/models/api_key.py +322 -0
  19. files_sdk/models/api_request_log.py +87 -0
  20. files_sdk/models/app.py +89 -0
  21. files_sdk/models/as2_incoming_message.py +123 -0
  22. files_sdk/models/as2_outgoing_message.py +119 -0
  23. files_sdk/models/as2_partner.py +374 -0
  24. files_sdk/models/as2_station.py +271 -0
  25. files_sdk/models/auto.py +36 -0
  26. files_sdk/models/automation.py +691 -0
  27. files_sdk/models/automation_log.py +77 -0
  28. files_sdk/models/automation_run.py +108 -0
  29. files_sdk/models/bandwidth_snapshot.py +91 -0
  30. files_sdk/models/behavior.py +334 -0
  31. files_sdk/models/bundle.py +550 -0
  32. files_sdk/models/bundle_action.py +86 -0
  33. files_sdk/models/bundle_download.py +94 -0
  34. files_sdk/models/bundle_notification.py +217 -0
  35. files_sdk/models/bundle_path.py +37 -0
  36. files_sdk/models/bundle_recipient.py +120 -0
  37. files_sdk/models/bundle_registration.py +79 -0
  38. files_sdk/models/clickwrap.py +268 -0
  39. files_sdk/models/dns_record.py +59 -0
  40. files_sdk/models/email_incoming_message.py +102 -0
  41. files_sdk/models/email_log.py +74 -0
  42. files_sdk/models/errors.py +37 -0
  43. files_sdk/models/exavault_api_request_log.py +85 -0
  44. files_sdk/models/external_event.py +148 -0
  45. files_sdk/models/file.py +791 -0
  46. files_sdk/models/file_action.py +39 -0
  47. files_sdk/models/file_comment.py +191 -0
  48. files_sdk/models/file_comment_reaction.py +125 -0
  49. files_sdk/models/file_migration.py +69 -0
  50. files_sdk/models/file_migration_log.py +78 -0
  51. files_sdk/models/file_upload_part.py +54 -0
  52. files_sdk/models/folder.py +154 -0
  53. files_sdk/models/form_field.py +43 -0
  54. files_sdk/models/form_field_set.py +240 -0
  55. files_sdk/models/ftp_action_log.py +87 -0
  56. files_sdk/models/gpg_key.py +254 -0
  57. files_sdk/models/group.py +276 -0
  58. files_sdk/models/group_user.py +231 -0
  59. files_sdk/models/history.py +236 -0
  60. files_sdk/models/history_export.py +238 -0
  61. files_sdk/models/history_export_result.py +98 -0
  62. files_sdk/models/image.py +37 -0
  63. files_sdk/models/inbox_recipient.py +118 -0
  64. files_sdk/models/inbox_registration.py +79 -0
  65. files_sdk/models/inbox_upload.py +80 -0
  66. files_sdk/models/invoice.py +91 -0
  67. files_sdk/models/invoice_line_item.py +46 -0
  68. files_sdk/models/ip_address.py +119 -0
  69. files_sdk/models/lock.py +158 -0
  70. files_sdk/models/message.py +244 -0
  71. files_sdk/models/message_comment.py +223 -0
  72. files_sdk/models/message_comment_reaction.py +181 -0
  73. files_sdk/models/message_reaction.py +170 -0
  74. files_sdk/models/notification.py +357 -0
  75. files_sdk/models/outbound_connection_log.py +88 -0
  76. files_sdk/models/payment.py +91 -0
  77. files_sdk/models/payment_line_item.py +42 -0
  78. files_sdk/models/permission.py +174 -0
  79. files_sdk/models/preview.py +40 -0
  80. files_sdk/models/priority.py +63 -0
  81. files_sdk/models/project.py +205 -0
  82. files_sdk/models/public_hosting_request_log.py +82 -0
  83. files_sdk/models/public_ip_address.py +42 -0
  84. files_sdk/models/public_key.py +212 -0
  85. files_sdk/models/remote_bandwidth_snapshot.py +91 -0
  86. files_sdk/models/remote_server.py +1677 -0
  87. files_sdk/models/remote_server_configuration_file.py +72 -0
  88. files_sdk/models/request.py +180 -0
  89. files_sdk/models/restore.py +104 -0
  90. files_sdk/models/session.py +100 -0
  91. files_sdk/models/settings_change.py +71 -0
  92. files_sdk/models/sftp_action_log.py +91 -0
  93. files_sdk/models/sftp_host_key.py +215 -0
  94. files_sdk/models/share_group.py +228 -0
  95. files_sdk/models/share_group_member.py +41 -0
  96. files_sdk/models/siem_http_destination.py +773 -0
  97. files_sdk/models/site.py +767 -0
  98. files_sdk/models/snapshot.py +255 -0
  99. files_sdk/models/sso_strategy.py +167 -0
  100. files_sdk/models/status.py +42 -0
  101. files_sdk/models/style.py +152 -0
  102. files_sdk/models/sync_log.py +75 -0
  103. files_sdk/models/usage_by_top_level_dir.py +41 -0
  104. files_sdk/models/usage_daily_snapshot.py +93 -0
  105. files_sdk/models/usage_snapshot.py +73 -0
  106. files_sdk/models/user.py +893 -0
  107. files_sdk/models/user_cipher_use.py +68 -0
  108. files_sdk/models/user_request.py +166 -0
  109. files_sdk/models/user_sftp_client_use.py +68 -0
  110. files_sdk/models/web_dav_action_log.py +87 -0
  111. files_sdk/models/webhook_test.py +104 -0
  112. files_sdk/path_util.py +42 -0
  113. files_sdk/util.py +34 -0
@@ -0,0 +1,357 @@
1
+ import builtins # noqa: F401
2
+ from files_sdk.api import Api # noqa: F401
3
+ from files_sdk.list_obj import ListObj
4
+ from files_sdk.error import ( # noqa: F401
5
+ InvalidParameterError,
6
+ MissingParameterError,
7
+ NotImplementedError,
8
+ )
9
+
10
+
11
+ class Notification:
12
+ default_attributes = {
13
+ "id": None, # int64 - Notification ID
14
+ "path": None, # string - Folder path to notify on. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
15
+ "group_id": None, # int64 - ID of Group to receive notifications
16
+ "group_name": None, # string - Group name, if a Group ID is set
17
+ "triggering_group_ids": None, # array(int64) - If set, will only notify on actions made by a member of one of the specified groups
18
+ "triggering_user_ids": None, # array(int64) - If set, will only notify on actions made one of the specified users
19
+ "trigger_by_share_recipients": None, # boolean - Notify when actions are performed by a share recipient?
20
+ "notify_user_actions": None, # boolean - If true, will send notifications about a user's own activity to that user. If false, only activity performed by other users (or anonymous users) will be sent in notifications.
21
+ "notify_on_copy": None, # boolean - Trigger on files copied to this path?
22
+ "notify_on_delete": None, # boolean - Trigger on files deleted in this path?
23
+ "notify_on_download": None, # boolean - Trigger on files downloaded in this path?
24
+ "notify_on_move": None, # boolean - Trigger on files moved to this path?
25
+ "notify_on_upload": None, # boolean - Trigger on files created/uploaded/updated/changed in this path?
26
+ "recursive": None, # boolean - Apply notification recursively? This will enable notifications for each subfolder.
27
+ "send_interval": None, # string - The time interval that notifications are aggregated to
28
+ "message": None, # string - Custom message to include in notification emails
29
+ "triggering_filenames": None, # array(string) - Array of filenames (possibly with wildcards) to scope trigger
30
+ "unsubscribed": None, # boolean - Is the user unsubscribed from this notification?
31
+ "unsubscribed_reason": None, # string - The reason that the user unsubscribed
32
+ "user_id": None, # int64 - Notification user ID
33
+ "username": None, # string - Notification username
34
+ "suppressed_email": None, # boolean - If true, it means that the recipient at this user's email address has manually unsubscribed from all emails, or had their email "hard bounce", which means that we are unable to send mail to this user's current email address. Notifications will resume if the user changes their email address.
35
+ }
36
+
37
+ def __init__(self, attributes=None, options=None):
38
+ if not isinstance(attributes, dict):
39
+ attributes = {}
40
+ if not isinstance(options, dict):
41
+ options = {}
42
+ self.set_attributes(attributes)
43
+ self.options = options
44
+
45
+ def set_attributes(self, attributes):
46
+ for (
47
+ attribute,
48
+ default_value,
49
+ ) in Notification.default_attributes.items():
50
+ setattr(self, attribute, attributes.get(attribute, default_value))
51
+
52
+ def get_attributes(self):
53
+ return {
54
+ k: getattr(self, k, None)
55
+ for k in Notification.default_attributes
56
+ if getattr(self, k, None) is not None
57
+ }
58
+
59
+ # Parameters:
60
+ # notify_on_copy - boolean - If `true`, copying or moving resources into this path will trigger a notification, in addition to just uploads.
61
+ # notify_on_delete - boolean - Trigger on files deleted in this path?
62
+ # notify_on_download - boolean - Trigger on files downloaded in this path?
63
+ # notify_on_move - boolean - Trigger on files moved to this path?
64
+ # notify_on_upload - boolean - Trigger on files created/uploaded/updated/changed in this path?
65
+ # notify_user_actions - boolean - If `true` actions initiated by the user will still result in a notification
66
+ # recursive - boolean - If `true`, enable notifications for each subfolder in this path
67
+ # send_interval - string - The time interval that notifications are aggregated by. Can be `five_minutes`, `fifteen_minutes`, `hourly`, or `daily`.
68
+ # message - string - Custom message to include in notification emails
69
+ # triggering_filenames - array(string) - Array of filenames (possibly with wildcards) to scope trigger
70
+ # triggering_group_ids - array(int64) - If set, will only notify on actions made by a member of one of the specified groups
71
+ # triggering_user_ids - array(int64) - If set, will only notify on actions made one of the specified users
72
+ # trigger_by_share_recipients - boolean - Notify when actions are performed by a share recipient?
73
+ def update(self, params=None):
74
+ if not isinstance(params, dict):
75
+ params = {}
76
+
77
+ if hasattr(self, "id") and self.id:
78
+ params["id"] = self.id
79
+ else:
80
+ raise MissingParameterError("Current object doesn't have a id")
81
+ if "id" not in params:
82
+ raise MissingParameterError("Parameter missing: id")
83
+ if "id" in params and not isinstance(params["id"], int):
84
+ raise InvalidParameterError("Bad parameter: id must be an int")
85
+ if "send_interval" in params and not isinstance(
86
+ params["send_interval"], str
87
+ ):
88
+ raise InvalidParameterError(
89
+ "Bad parameter: send_interval must be an str"
90
+ )
91
+ if "message" in params and not isinstance(params["message"], str):
92
+ raise InvalidParameterError(
93
+ "Bad parameter: message must be an str"
94
+ )
95
+ if "triggering_filenames" in params and not isinstance(
96
+ params["triggering_filenames"], builtins.list
97
+ ):
98
+ raise InvalidParameterError(
99
+ "Bad parameter: triggering_filenames must be an list"
100
+ )
101
+ if "triggering_group_ids" in params and not isinstance(
102
+ params["triggering_group_ids"], builtins.list
103
+ ):
104
+ raise InvalidParameterError(
105
+ "Bad parameter: triggering_group_ids must be an list"
106
+ )
107
+ if "triggering_user_ids" in params and not isinstance(
108
+ params["triggering_user_ids"], builtins.list
109
+ ):
110
+ raise InvalidParameterError(
111
+ "Bad parameter: triggering_user_ids must be an list"
112
+ )
113
+ response, _options = Api.send_request(
114
+ "PATCH",
115
+ "/notifications/{id}".format(id=params["id"]),
116
+ params,
117
+ self.options,
118
+ )
119
+ return response.data
120
+
121
+ def delete(self, params=None):
122
+ if not isinstance(params, dict):
123
+ params = {}
124
+
125
+ if hasattr(self, "id") and self.id:
126
+ params["id"] = self.id
127
+ else:
128
+ raise MissingParameterError("Current object doesn't have a id")
129
+ if "id" not in params:
130
+ raise MissingParameterError("Parameter missing: id")
131
+ if "id" in params and not isinstance(params["id"], int):
132
+ raise InvalidParameterError("Bad parameter: id must be an int")
133
+ Api.send_request(
134
+ "DELETE",
135
+ "/notifications/{id}".format(id=params["id"]),
136
+ params,
137
+ self.options,
138
+ )
139
+
140
+ def destroy(self, params=None):
141
+ self.delete(params)
142
+
143
+ def save(self):
144
+ if hasattr(self, "id") and self.id:
145
+ new_obj = self.update(self.get_attributes())
146
+ self.set_attributes(new_obj.get_attributes())
147
+ return True
148
+ else:
149
+ new_obj = create(self.get_attributes(), self.options)
150
+ self.set_attributes(new_obj.get_attributes())
151
+ return True
152
+
153
+
154
+ # Parameters:
155
+ # 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.
156
+ # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
157
+ # sort_by - object - If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `path`, `user_id` or `group_id`.
158
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `path`, `user_id` or `group_id`.
159
+ # filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`.
160
+ # path - string - Show notifications for this Path.
161
+ # include_ancestors - boolean - If `include_ancestors` is `true` and `path` is specified, include notifications for any parent paths. Ignored if `path` is not specified.
162
+ # group_id - string
163
+ def list(params=None, options=None):
164
+ if not isinstance(params, dict):
165
+ params = {}
166
+ if not isinstance(options, dict):
167
+ options = {}
168
+ if "cursor" in params and not isinstance(params["cursor"], str):
169
+ raise InvalidParameterError("Bad parameter: cursor must be an str")
170
+ if "per_page" in params and not isinstance(params["per_page"], int):
171
+ raise InvalidParameterError("Bad parameter: per_page must be an int")
172
+ if "sort_by" in params and not isinstance(params["sort_by"], dict):
173
+ raise InvalidParameterError("Bad parameter: sort_by must be an dict")
174
+ if "filter" in params and not isinstance(params["filter"], dict):
175
+ raise InvalidParameterError("Bad parameter: filter must be an dict")
176
+ if "filter_prefix" in params and not isinstance(
177
+ params["filter_prefix"], dict
178
+ ):
179
+ raise InvalidParameterError(
180
+ "Bad parameter: filter_prefix must be an dict"
181
+ )
182
+ if "path" in params and not isinstance(params["path"], str):
183
+ raise InvalidParameterError("Bad parameter: path must be an str")
184
+ if "group_id" in params and not isinstance(params["group_id"], str):
185
+ raise InvalidParameterError("Bad parameter: group_id must be an str")
186
+ return ListObj(Notification, "GET", "/notifications", params, options)
187
+
188
+
189
+ def all(params=None, options=None):
190
+ list(params, options)
191
+
192
+
193
+ # Parameters:
194
+ # id (required) - int64 - Notification ID.
195
+ def find(id, params=None, options=None):
196
+ if not isinstance(params, dict):
197
+ params = {}
198
+ if not isinstance(options, dict):
199
+ options = {}
200
+ params["id"] = id
201
+ if "id" in params and not isinstance(params["id"], int):
202
+ raise InvalidParameterError("Bad parameter: id must be an int")
203
+ if "id" not in params:
204
+ raise MissingParameterError("Parameter missing: id")
205
+ response, options = Api.send_request(
206
+ "GET", "/notifications/{id}".format(id=params["id"]), params, options
207
+ )
208
+ return Notification(response.data, options)
209
+
210
+
211
+ def get(id, params=None, options=None):
212
+ find(id, params, options)
213
+
214
+
215
+ # Parameters:
216
+ # user_id - int64 - The id of the user to notify. Provide `user_id`, `username` or `group_id`.
217
+ # notify_on_copy - boolean - If `true`, copying or moving resources into this path will trigger a notification, in addition to just uploads.
218
+ # notify_on_delete - boolean - Trigger on files deleted in this path?
219
+ # notify_on_download - boolean - Trigger on files downloaded in this path?
220
+ # notify_on_move - boolean - Trigger on files moved to this path?
221
+ # notify_on_upload - boolean - Trigger on files created/uploaded/updated/changed in this path?
222
+ # notify_user_actions - boolean - If `true` actions initiated by the user will still result in a notification
223
+ # recursive - boolean - If `true`, enable notifications for each subfolder in this path
224
+ # send_interval - string - The time interval that notifications are aggregated by. Can be `five_minutes`, `fifteen_minutes`, `hourly`, or `daily`.
225
+ # message - string - Custom message to include in notification emails
226
+ # triggering_filenames - array(string) - Array of filenames (possibly with wildcards) to scope trigger
227
+ # triggering_group_ids - array(int64) - If set, will only notify on actions made by a member of one of the specified groups
228
+ # triggering_user_ids - array(int64) - If set, will only notify on actions made one of the specified users
229
+ # trigger_by_share_recipients - boolean - Notify when actions are performed by a share recipient?
230
+ # group_id - int64 - The ID of the group to notify. Provide `user_id`, `username` or `group_id`.
231
+ # path - string - Path
232
+ # username - string - The username of the user to notify. Provide `user_id`, `username` or `group_id`.
233
+ def create(params=None, options=None):
234
+ if not isinstance(params, dict):
235
+ params = {}
236
+ if not isinstance(options, dict):
237
+ options = {}
238
+ if "user_id" in params and not isinstance(params["user_id"], int):
239
+ raise InvalidParameterError("Bad parameter: user_id must be an int")
240
+ if "send_interval" in params and not isinstance(
241
+ params["send_interval"], str
242
+ ):
243
+ raise InvalidParameterError(
244
+ "Bad parameter: send_interval must be an str"
245
+ )
246
+ if "message" in params and not isinstance(params["message"], str):
247
+ raise InvalidParameterError("Bad parameter: message must be an str")
248
+ if "triggering_filenames" in params and not isinstance(
249
+ params["triggering_filenames"], builtins.list
250
+ ):
251
+ raise InvalidParameterError(
252
+ "Bad parameter: triggering_filenames must be an list"
253
+ )
254
+ if "triggering_group_ids" in params and not isinstance(
255
+ params["triggering_group_ids"], builtins.list
256
+ ):
257
+ raise InvalidParameterError(
258
+ "Bad parameter: triggering_group_ids must be an list"
259
+ )
260
+ if "triggering_user_ids" in params and not isinstance(
261
+ params["triggering_user_ids"], builtins.list
262
+ ):
263
+ raise InvalidParameterError(
264
+ "Bad parameter: triggering_user_ids must be an list"
265
+ )
266
+ if "group_id" in params and not isinstance(params["group_id"], int):
267
+ raise InvalidParameterError("Bad parameter: group_id must be an int")
268
+ if "path" in params and not isinstance(params["path"], str):
269
+ raise InvalidParameterError("Bad parameter: path must be an str")
270
+ if "username" in params and not isinstance(params["username"], str):
271
+ raise InvalidParameterError("Bad parameter: username must be an str")
272
+ response, options = Api.send_request(
273
+ "POST", "/notifications", params, options
274
+ )
275
+ return Notification(response.data, options)
276
+
277
+
278
+ # Parameters:
279
+ # notify_on_copy - boolean - If `true`, copying or moving resources into this path will trigger a notification, in addition to just uploads.
280
+ # notify_on_delete - boolean - Trigger on files deleted in this path?
281
+ # notify_on_download - boolean - Trigger on files downloaded in this path?
282
+ # notify_on_move - boolean - Trigger on files moved to this path?
283
+ # notify_on_upload - boolean - Trigger on files created/uploaded/updated/changed in this path?
284
+ # notify_user_actions - boolean - If `true` actions initiated by the user will still result in a notification
285
+ # recursive - boolean - If `true`, enable notifications for each subfolder in this path
286
+ # send_interval - string - The time interval that notifications are aggregated by. Can be `five_minutes`, `fifteen_minutes`, `hourly`, or `daily`.
287
+ # message - string - Custom message to include in notification emails
288
+ # triggering_filenames - array(string) - Array of filenames (possibly with wildcards) to scope trigger
289
+ # triggering_group_ids - array(int64) - If set, will only notify on actions made by a member of one of the specified groups
290
+ # triggering_user_ids - array(int64) - If set, will only notify on actions made one of the specified users
291
+ # trigger_by_share_recipients - boolean - Notify when actions are performed by a share recipient?
292
+ def update(id, params=None, options=None):
293
+ if not isinstance(params, dict):
294
+ params = {}
295
+ if not isinstance(options, dict):
296
+ options = {}
297
+ params["id"] = id
298
+ if "id" in params and not isinstance(params["id"], int):
299
+ raise InvalidParameterError("Bad parameter: id must be an int")
300
+ if "send_interval" in params and not isinstance(
301
+ params["send_interval"], str
302
+ ):
303
+ raise InvalidParameterError(
304
+ "Bad parameter: send_interval must be an str"
305
+ )
306
+ if "message" in params and not isinstance(params["message"], str):
307
+ raise InvalidParameterError("Bad parameter: message must be an str")
308
+ if "triggering_filenames" in params and not isinstance(
309
+ params["triggering_filenames"], builtins.list
310
+ ):
311
+ raise InvalidParameterError(
312
+ "Bad parameter: triggering_filenames must be an list"
313
+ )
314
+ if "triggering_group_ids" in params and not isinstance(
315
+ params["triggering_group_ids"], builtins.list
316
+ ):
317
+ raise InvalidParameterError(
318
+ "Bad parameter: triggering_group_ids must be an list"
319
+ )
320
+ if "triggering_user_ids" in params and not isinstance(
321
+ params["triggering_user_ids"], builtins.list
322
+ ):
323
+ raise InvalidParameterError(
324
+ "Bad parameter: triggering_user_ids must be an list"
325
+ )
326
+ if "id" not in params:
327
+ raise MissingParameterError("Parameter missing: id")
328
+ response, options = Api.send_request(
329
+ "PATCH", "/notifications/{id}".format(id=params["id"]), params, options
330
+ )
331
+ return Notification(response.data, options)
332
+
333
+
334
+ def delete(id, params=None, options=None):
335
+ if not isinstance(params, dict):
336
+ params = {}
337
+ if not isinstance(options, dict):
338
+ options = {}
339
+ params["id"] = id
340
+ if "id" in params and not isinstance(params["id"], int):
341
+ raise InvalidParameterError("Bad parameter: id must be an int")
342
+ if "id" not in params:
343
+ raise MissingParameterError("Parameter missing: id")
344
+ Api.send_request(
345
+ "DELETE",
346
+ "/notifications/{id}".format(id=params["id"]),
347
+ params,
348
+ options,
349
+ )
350
+
351
+
352
+ def destroy(id, params=None, options=None):
353
+ delete(id, params, options)
354
+
355
+
356
+ def new(*args, **kwargs):
357
+ return Notification(*args, **kwargs)
@@ -0,0 +1,88 @@
1
+ import builtins # noqa: F401
2
+ from files_sdk.api import Api # noqa: F401
3
+ from files_sdk.list_obj import ListObj
4
+ from files_sdk.error import ( # noqa: F401
5
+ InvalidParameterError,
6
+ MissingParameterError,
7
+ NotImplementedError,
8
+ )
9
+
10
+
11
+ class OutboundConnectionLog:
12
+ default_attributes = {
13
+ "timestamp": None, # date-time - Start Time of Action
14
+ "path": None, # string - Remote Path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
15
+ "client_ip": None, # string - End User IP
16
+ "src_remote_server_id": None, # int64 - Source Remote Server ID
17
+ "dest_remote_server_id": None, # int64 - Destination Remote Server ID
18
+ "operation": None, # string - Operation Type
19
+ "error_message": None, # string - Error message, if applicable
20
+ "error_operation": None, # string - Error operation, if applicable
21
+ "error_type": None, # string - Error type, if applicable
22
+ "status": None, # string - Status
23
+ "duration_ms": None, # int64 - Duration (in milliseconds)
24
+ "bytes_uploaded": None, # int64 - Data Length in Bytes. Present for upload actions that transfer data.
25
+ "bytes_downloaded": None, # int64 - Data Length in Bytes. Present for download actions that transfer data.
26
+ "list_count": None, # int64 - Number of entries returned for a folder list action.
27
+ }
28
+
29
+ def __init__(self, attributes=None, options=None):
30
+ if not isinstance(attributes, dict):
31
+ attributes = {}
32
+ if not isinstance(options, dict):
33
+ options = {}
34
+ self.set_attributes(attributes)
35
+ self.options = options
36
+
37
+ def set_attributes(self, attributes):
38
+ for (
39
+ attribute,
40
+ default_value,
41
+ ) in OutboundConnectionLog.default_attributes.items():
42
+ setattr(self, attribute, attributes.get(attribute, default_value))
43
+
44
+ def get_attributes(self):
45
+ return {
46
+ k: getattr(self, k, None)
47
+ for k in OutboundConnectionLog.default_attributes
48
+ if getattr(self, k, None) is not None
49
+ }
50
+
51
+
52
+ # Parameters:
53
+ # 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.
54
+ # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
55
+ # filter - object - If set, return records where the specified field is equal to the supplied value. Valid fields are `start_date`, `end_date`, `operation`, `status`, `src_remote_server_id`, `dest_remote_server_id`, `path` or `client_ip`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ operation ]`, `[ status ]`, `[ src_remote_server_id ]`, `[ dest_remote_server_id ]`, `[ path ]`, `[ client_ip ]`, `[ start_date, end_date ]`, `[ start_date, operation ]`, `[ start_date, status ]`, `[ start_date, src_remote_server_id ]`, `[ start_date, dest_remote_server_id ]`, `[ start_date, path ]`, `[ start_date, client_ip ]`, `[ end_date, operation ]`, `[ end_date, status ]`, `[ end_date, src_remote_server_id ]`, `[ end_date, dest_remote_server_id ]`, `[ end_date, path ]`, `[ end_date, client_ip ]`, `[ operation, status ]`, `[ operation, src_remote_server_id ]`, `[ operation, dest_remote_server_id ]`, `[ operation, path ]`, `[ operation, client_ip ]`, `[ status, src_remote_server_id ]`, `[ status, dest_remote_server_id ]`, `[ status, path ]`, `[ status, client_ip ]`, `[ src_remote_server_id, dest_remote_server_id ]`, `[ src_remote_server_id, path ]`, `[ src_remote_server_id, client_ip ]`, `[ dest_remote_server_id, path ]`, `[ dest_remote_server_id, client_ip ]`, `[ path, client_ip ]`, `[ start_date, end_date, operation ]`, `[ start_date, end_date, status ]`, `[ start_date, end_date, src_remote_server_id ]`, `[ start_date, end_date, dest_remote_server_id ]`, `[ start_date, end_date, path ]`, `[ start_date, end_date, client_ip ]`, `[ start_date, operation, status ]`, `[ start_date, operation, src_remote_server_id ]`, `[ start_date, operation, dest_remote_server_id ]`, `[ start_date, operation, path ]`, `[ start_date, operation, client_ip ]`, `[ start_date, status, src_remote_server_id ]`, `[ start_date, status, dest_remote_server_id ]`, `[ start_date, status, path ]`, `[ start_date, status, client_ip ]`, `[ start_date, src_remote_server_id, dest_remote_server_id ]`, `[ start_date, src_remote_server_id, path ]`, `[ start_date, src_remote_server_id, client_ip ]`, `[ start_date, dest_remote_server_id, path ]`, `[ start_date, dest_remote_server_id, client_ip ]`, `[ start_date, path, client_ip ]`, `[ end_date, operation, status ]`, `[ end_date, operation, src_remote_server_id ]`, `[ end_date, operation, dest_remote_server_id ]`, `[ end_date, operation, path ]`, `[ end_date, operation, client_ip ]`, `[ end_date, status, src_remote_server_id ]`, `[ end_date, status, dest_remote_server_id ]`, `[ end_date, status, path ]`, `[ end_date, status, client_ip ]`, `[ end_date, src_remote_server_id, dest_remote_server_id ]`, `[ end_date, src_remote_server_id, path ]`, `[ end_date, src_remote_server_id, client_ip ]`, `[ end_date, dest_remote_server_id, path ]`, `[ end_date, dest_remote_server_id, client_ip ]`, `[ end_date, path, client_ip ]`, `[ operation, status, src_remote_server_id ]`, `[ operation, status, dest_remote_server_id ]`, `[ operation, status, path ]`, `[ operation, status, client_ip ]`, `[ operation, src_remote_server_id, dest_remote_server_id ]`, `[ operation, src_remote_server_id, path ]`, `[ operation, src_remote_server_id, client_ip ]`, `[ operation, dest_remote_server_id, path ]`, `[ operation, dest_remote_server_id, client_ip ]`, `[ operation, path, client_ip ]`, `[ status, src_remote_server_id, dest_remote_server_id ]`, `[ status, src_remote_server_id, path ]`, `[ status, src_remote_server_id, client_ip ]`, `[ status, dest_remote_server_id, path ]`, `[ status, dest_remote_server_id, client_ip ]`, `[ status, path, client_ip ]`, `[ src_remote_server_id, dest_remote_server_id, path ]`, `[ src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ src_remote_server_id, path, client_ip ]`, `[ dest_remote_server_id, path, client_ip ]`, `[ start_date, end_date, operation, status ]`, `[ start_date, end_date, operation, src_remote_server_id ]`, `[ start_date, end_date, operation, dest_remote_server_id ]`, `[ start_date, end_date, operation, path ]`, `[ start_date, end_date, operation, client_ip ]`, `[ start_date, end_date, status, src_remote_server_id ]`, `[ start_date, end_date, status, dest_remote_server_id ]`, `[ start_date, end_date, status, path ]`, `[ start_date, end_date, status, client_ip ]`, `[ start_date, end_date, src_remote_server_id, dest_remote_server_id ]`, `[ start_date, end_date, src_remote_server_id, path ]`, `[ start_date, end_date, src_remote_server_id, client_ip ]`, `[ start_date, end_date, dest_remote_server_id, path ]`, `[ start_date, end_date, dest_remote_server_id, client_ip ]`, `[ start_date, end_date, path, client_ip ]`, `[ start_date, operation, status, src_remote_server_id ]`, `[ start_date, operation, status, dest_remote_server_id ]`, `[ start_date, operation, status, path ]`, `[ start_date, operation, status, client_ip ]`, `[ start_date, operation, src_remote_server_id, dest_remote_server_id ]`, `[ start_date, operation, src_remote_server_id, path ]`, `[ start_date, operation, src_remote_server_id, client_ip ]`, `[ start_date, operation, dest_remote_server_id, path ]`, `[ start_date, operation, dest_remote_server_id, client_ip ]`, `[ start_date, operation, path, client_ip ]`, `[ start_date, status, src_remote_server_id, dest_remote_server_id ]`, `[ start_date, status, src_remote_server_id, path ]`, `[ start_date, status, src_remote_server_id, client_ip ]`, `[ start_date, status, dest_remote_server_id, path ]`, `[ start_date, status, dest_remote_server_id, client_ip ]`, `[ start_date, status, path, client_ip ]`, `[ start_date, src_remote_server_id, dest_remote_server_id, path ]`, `[ start_date, src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ start_date, src_remote_server_id, path, client_ip ]`, `[ start_date, dest_remote_server_id, path, client_ip ]`, `[ end_date, operation, status, src_remote_server_id ]`, `[ end_date, operation, status, dest_remote_server_id ]`, `[ end_date, operation, status, path ]`, `[ end_date, operation, status, client_ip ]`, `[ end_date, operation, src_remote_server_id, dest_remote_server_id ]`, `[ end_date, operation, src_remote_server_id, path ]`, `[ end_date, operation, src_remote_server_id, client_ip ]`, `[ end_date, operation, dest_remote_server_id, path ]`, `[ end_date, operation, dest_remote_server_id, client_ip ]`, `[ end_date, operation, path, client_ip ]`, `[ end_date, status, src_remote_server_id, dest_remote_server_id ]`, `[ end_date, status, src_remote_server_id, path ]`, `[ end_date, status, src_remote_server_id, client_ip ]`, `[ end_date, status, dest_remote_server_id, path ]`, `[ end_date, status, dest_remote_server_id, client_ip ]`, `[ end_date, status, path, client_ip ]`, `[ end_date, src_remote_server_id, dest_remote_server_id, path ]`, `[ end_date, src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ end_date, src_remote_server_id, path, client_ip ]`, `[ end_date, dest_remote_server_id, path, client_ip ]`, `[ operation, status, src_remote_server_id, dest_remote_server_id ]`, `[ operation, status, src_remote_server_id, path ]`, `[ operation, status, src_remote_server_id, client_ip ]`, `[ operation, status, dest_remote_server_id, path ]`, `[ operation, status, dest_remote_server_id, client_ip ]`, `[ operation, status, path, client_ip ]`, `[ operation, src_remote_server_id, dest_remote_server_id, path ]`, `[ operation, src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ operation, src_remote_server_id, path, client_ip ]`, `[ operation, dest_remote_server_id, path, client_ip ]`, `[ status, src_remote_server_id, dest_remote_server_id, path ]`, `[ status, src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ status, src_remote_server_id, path, client_ip ]`, `[ status, dest_remote_server_id, path, client_ip ]`, `[ src_remote_server_id, dest_remote_server_id, path, client_ip ]`, `[ start_date, end_date, operation, status, src_remote_server_id ]`, `[ start_date, end_date, operation, status, dest_remote_server_id ]`, `[ start_date, end_date, operation, status, path ]`, `[ start_date, end_date, operation, status, client_ip ]`, `[ start_date, end_date, operation, src_remote_server_id, dest_remote_server_id ]`, `[ start_date, end_date, operation, src_remote_server_id, path ]`, `[ start_date, end_date, operation, src_remote_server_id, client_ip ]`, `[ start_date, end_date, operation, dest_remote_server_id, path ]`, `[ start_date, end_date, operation, dest_remote_server_id, client_ip ]`, `[ start_date, end_date, operation, path, client_ip ]`, `[ start_date, end_date, status, src_remote_server_id, dest_remote_server_id ]`, `[ start_date, end_date, status, src_remote_server_id, path ]`, `[ start_date, end_date, status, src_remote_server_id, client_ip ]`, `[ start_date, end_date, status, dest_remote_server_id, path ]`, `[ start_date, end_date, status, dest_remote_server_id, client_ip ]`, `[ start_date, end_date, status, path, client_ip ]`, `[ start_date, end_date, src_remote_server_id, dest_remote_server_id, path ]`, `[ start_date, end_date, src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ start_date, end_date, src_remote_server_id, path, client_ip ]`, `[ start_date, end_date, dest_remote_server_id, path, client_ip ]`, `[ start_date, operation, status, src_remote_server_id, dest_remote_server_id ]`, `[ start_date, operation, status, src_remote_server_id, path ]`, `[ start_date, operation, status, src_remote_server_id, client_ip ]`, `[ start_date, operation, status, dest_remote_server_id, path ]`, `[ start_date, operation, status, dest_remote_server_id, client_ip ]`, `[ start_date, operation, status, path, client_ip ]`, `[ start_date, operation, src_remote_server_id, dest_remote_server_id, path ]`, `[ start_date, operation, src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ start_date, operation, src_remote_server_id, path, client_ip ]`, `[ start_date, operation, dest_remote_server_id, path, client_ip ]`, `[ start_date, status, src_remote_server_id, dest_remote_server_id, path ]`, `[ start_date, status, src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ start_date, status, src_remote_server_id, path, client_ip ]`, `[ start_date, status, dest_remote_server_id, path, client_ip ]`, `[ start_date, src_remote_server_id, dest_remote_server_id, path, client_ip ]`, `[ end_date, operation, status, src_remote_server_id, dest_remote_server_id ]`, `[ end_date, operation, status, src_remote_server_id, path ]`, `[ end_date, operation, status, src_remote_server_id, client_ip ]`, `[ end_date, operation, status, dest_remote_server_id, path ]`, `[ end_date, operation, status, dest_remote_server_id, client_ip ]`, `[ end_date, operation, status, path, client_ip ]`, `[ end_date, operation, src_remote_server_id, dest_remote_server_id, path ]`, `[ end_date, operation, src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ end_date, operation, src_remote_server_id, path, client_ip ]`, `[ end_date, operation, dest_remote_server_id, path, client_ip ]`, `[ end_date, status, src_remote_server_id, dest_remote_server_id, path ]`, `[ end_date, status, src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ end_date, status, src_remote_server_id, path, client_ip ]`, `[ end_date, status, dest_remote_server_id, path, client_ip ]`, `[ end_date, src_remote_server_id, dest_remote_server_id, path, client_ip ]`, `[ operation, status, src_remote_server_id, dest_remote_server_id, path ]`, `[ operation, status, src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ operation, status, src_remote_server_id, path, client_ip ]`, `[ operation, status, dest_remote_server_id, path, client_ip ]`, `[ operation, src_remote_server_id, dest_remote_server_id, path, client_ip ]`, `[ status, src_remote_server_id, dest_remote_server_id, path, client_ip ]`, `[ start_date, end_date, operation, status, src_remote_server_id, dest_remote_server_id ]`, `[ start_date, end_date, operation, status, src_remote_server_id, path ]`, `[ start_date, end_date, operation, status, src_remote_server_id, client_ip ]`, `[ start_date, end_date, operation, status, dest_remote_server_id, path ]`, `[ start_date, end_date, operation, status, dest_remote_server_id, client_ip ]`, `[ start_date, end_date, operation, status, path, client_ip ]`, `[ start_date, end_date, operation, src_remote_server_id, dest_remote_server_id, path ]`, `[ start_date, end_date, operation, src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ start_date, end_date, operation, src_remote_server_id, path, client_ip ]`, `[ start_date, end_date, operation, dest_remote_server_id, path, client_ip ]`, `[ start_date, end_date, status, src_remote_server_id, dest_remote_server_id, path ]`, `[ start_date, end_date, status, src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ start_date, end_date, status, src_remote_server_id, path, client_ip ]`, `[ start_date, end_date, status, dest_remote_server_id, path, client_ip ]`, `[ start_date, end_date, src_remote_server_id, dest_remote_server_id, path, client_ip ]`, `[ start_date, operation, status, src_remote_server_id, dest_remote_server_id, path ]`, `[ start_date, operation, status, src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ start_date, operation, status, src_remote_server_id, path, client_ip ]`, `[ start_date, operation, status, dest_remote_server_id, path, client_ip ]`, `[ start_date, operation, src_remote_server_id, dest_remote_server_id, path, client_ip ]`, `[ start_date, status, src_remote_server_id, dest_remote_server_id, path, client_ip ]`, `[ end_date, operation, status, src_remote_server_id, dest_remote_server_id, path ]`, `[ end_date, operation, status, src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ end_date, operation, status, src_remote_server_id, path, client_ip ]`, `[ end_date, operation, status, dest_remote_server_id, path, client_ip ]`, `[ end_date, operation, src_remote_server_id, dest_remote_server_id, path, client_ip ]`, `[ end_date, status, src_remote_server_id, dest_remote_server_id, path, client_ip ]`, `[ operation, status, src_remote_server_id, dest_remote_server_id, path, client_ip ]`, `[ start_date, end_date, operation, status, src_remote_server_id, dest_remote_server_id, path ]`, `[ start_date, end_date, operation, status, src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ start_date, end_date, operation, status, src_remote_server_id, path, client_ip ]`, `[ start_date, end_date, operation, status, dest_remote_server_id, path, client_ip ]`, `[ start_date, end_date, operation, src_remote_server_id, dest_remote_server_id, path, client_ip ]`, `[ start_date, end_date, status, src_remote_server_id, dest_remote_server_id, path, client_ip ]`, `[ start_date, operation, status, src_remote_server_id, dest_remote_server_id, path, client_ip ]` or `[ end_date, operation, status, src_remote_server_id, dest_remote_server_id, path, client_ip ]`.
56
+ # filter_prefix - object - If set, return records where the specified field is prefixed by the supplied value. Valid fields are `operation`, `status` or `path`. Valid field combinations are `[ start_date ]`, `[ end_date ]`, `[ operation ]`, `[ status ]`, `[ src_remote_server_id ]`, `[ dest_remote_server_id ]`, `[ path ]`, `[ client_ip ]`, `[ start_date, end_date ]`, `[ start_date, operation ]`, `[ start_date, status ]`, `[ start_date, src_remote_server_id ]`, `[ start_date, dest_remote_server_id ]`, `[ start_date, path ]`, `[ start_date, client_ip ]`, `[ end_date, operation ]`, `[ end_date, status ]`, `[ end_date, src_remote_server_id ]`, `[ end_date, dest_remote_server_id ]`, `[ end_date, path ]`, `[ end_date, client_ip ]`, `[ operation, status ]`, `[ operation, src_remote_server_id ]`, `[ operation, dest_remote_server_id ]`, `[ operation, path ]`, `[ operation, client_ip ]`, `[ status, src_remote_server_id ]`, `[ status, dest_remote_server_id ]`, `[ status, path ]`, `[ status, client_ip ]`, `[ src_remote_server_id, dest_remote_server_id ]`, `[ src_remote_server_id, path ]`, `[ src_remote_server_id, client_ip ]`, `[ dest_remote_server_id, path ]`, `[ dest_remote_server_id, client_ip ]`, `[ path, client_ip ]`, `[ start_date, end_date, operation ]`, `[ start_date, end_date, status ]`, `[ start_date, end_date, src_remote_server_id ]`, `[ start_date, end_date, dest_remote_server_id ]`, `[ start_date, end_date, path ]`, `[ start_date, end_date, client_ip ]`, `[ start_date, operation, status ]`, `[ start_date, operation, src_remote_server_id ]`, `[ start_date, operation, dest_remote_server_id ]`, `[ start_date, operation, path ]`, `[ start_date, operation, client_ip ]`, `[ start_date, status, src_remote_server_id ]`, `[ start_date, status, dest_remote_server_id ]`, `[ start_date, status, path ]`, `[ start_date, status, client_ip ]`, `[ start_date, src_remote_server_id, dest_remote_server_id ]`, `[ start_date, src_remote_server_id, path ]`, `[ start_date, src_remote_server_id, client_ip ]`, `[ start_date, dest_remote_server_id, path ]`, `[ start_date, dest_remote_server_id, client_ip ]`, `[ start_date, path, client_ip ]`, `[ end_date, operation, status ]`, `[ end_date, operation, src_remote_server_id ]`, `[ end_date, operation, dest_remote_server_id ]`, `[ end_date, operation, path ]`, `[ end_date, operation, client_ip ]`, `[ end_date, status, src_remote_server_id ]`, `[ end_date, status, dest_remote_server_id ]`, `[ end_date, status, path ]`, `[ end_date, status, client_ip ]`, `[ end_date, src_remote_server_id, dest_remote_server_id ]`, `[ end_date, src_remote_server_id, path ]`, `[ end_date, src_remote_server_id, client_ip ]`, `[ end_date, dest_remote_server_id, path ]`, `[ end_date, dest_remote_server_id, client_ip ]`, `[ end_date, path, client_ip ]`, `[ operation, status, src_remote_server_id ]`, `[ operation, status, dest_remote_server_id ]`, `[ operation, status, path ]`, `[ operation, status, client_ip ]`, `[ operation, src_remote_server_id, dest_remote_server_id ]`, `[ operation, src_remote_server_id, path ]`, `[ operation, src_remote_server_id, client_ip ]`, `[ operation, dest_remote_server_id, path ]`, `[ operation, dest_remote_server_id, client_ip ]`, `[ operation, path, client_ip ]`, `[ status, src_remote_server_id, dest_remote_server_id ]`, `[ status, src_remote_server_id, path ]`, `[ status, src_remote_server_id, client_ip ]`, `[ status, dest_remote_server_id, path ]`, `[ status, dest_remote_server_id, client_ip ]`, `[ status, path, client_ip ]`, `[ src_remote_server_id, dest_remote_server_id, path ]`, `[ src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ src_remote_server_id, path, client_ip ]`, `[ dest_remote_server_id, path, client_ip ]`, `[ start_date, end_date, operation, status ]`, `[ start_date, end_date, operation, src_remote_server_id ]`, `[ start_date, end_date, operation, dest_remote_server_id ]`, `[ start_date, end_date, operation, path ]`, `[ start_date, end_date, operation, client_ip ]`, `[ start_date, end_date, status, src_remote_server_id ]`, `[ start_date, end_date, status, dest_remote_server_id ]`, `[ start_date, end_date, status, path ]`, `[ start_date, end_date, status, client_ip ]`, `[ start_date, end_date, src_remote_server_id, dest_remote_server_id ]`, `[ start_date, end_date, src_remote_server_id, path ]`, `[ start_date, end_date, src_remote_server_id, client_ip ]`, `[ start_date, end_date, dest_remote_server_id, path ]`, `[ start_date, end_date, dest_remote_server_id, client_ip ]`, `[ start_date, end_date, path, client_ip ]`, `[ start_date, operation, status, src_remote_server_id ]`, `[ start_date, operation, status, dest_remote_server_id ]`, `[ start_date, operation, status, path ]`, `[ start_date, operation, status, client_ip ]`, `[ start_date, operation, src_remote_server_id, dest_remote_server_id ]`, `[ start_date, operation, src_remote_server_id, path ]`, `[ start_date, operation, src_remote_server_id, client_ip ]`, `[ start_date, operation, dest_remote_server_id, path ]`, `[ start_date, operation, dest_remote_server_id, client_ip ]`, `[ start_date, operation, path, client_ip ]`, `[ start_date, status, src_remote_server_id, dest_remote_server_id ]`, `[ start_date, status, src_remote_server_id, path ]`, `[ start_date, status, src_remote_server_id, client_ip ]`, `[ start_date, status, dest_remote_server_id, path ]`, `[ start_date, status, dest_remote_server_id, client_ip ]`, `[ start_date, status, path, client_ip ]`, `[ start_date, src_remote_server_id, dest_remote_server_id, path ]`, `[ start_date, src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ start_date, src_remote_server_id, path, client_ip ]`, `[ start_date, dest_remote_server_id, path, client_ip ]`, `[ end_date, operation, status, src_remote_server_id ]`, `[ end_date, operation, status, dest_remote_server_id ]`, `[ end_date, operation, status, path ]`, `[ end_date, operation, status, client_ip ]`, `[ end_date, operation, src_remote_server_id, dest_remote_server_id ]`, `[ end_date, operation, src_remote_server_id, path ]`, `[ end_date, operation, src_remote_server_id, client_ip ]`, `[ end_date, operation, dest_remote_server_id, path ]`, `[ end_date, operation, dest_remote_server_id, client_ip ]`, `[ end_date, operation, path, client_ip ]`, `[ end_date, status, src_remote_server_id, dest_remote_server_id ]`, `[ end_date, status, src_remote_server_id, path ]`, `[ end_date, status, src_remote_server_id, client_ip ]`, `[ end_date, status, dest_remote_server_id, path ]`, `[ end_date, status, dest_remote_server_id, client_ip ]`, `[ end_date, status, path, client_ip ]`, `[ end_date, src_remote_server_id, dest_remote_server_id, path ]`, `[ end_date, src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ end_date, src_remote_server_id, path, client_ip ]`, `[ end_date, dest_remote_server_id, path, client_ip ]`, `[ operation, status, src_remote_server_id, dest_remote_server_id ]`, `[ operation, status, src_remote_server_id, path ]`, `[ operation, status, src_remote_server_id, client_ip ]`, `[ operation, status, dest_remote_server_id, path ]`, `[ operation, status, dest_remote_server_id, client_ip ]`, `[ operation, status, path, client_ip ]`, `[ operation, src_remote_server_id, dest_remote_server_id, path ]`, `[ operation, src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ operation, src_remote_server_id, path, client_ip ]`, `[ operation, dest_remote_server_id, path, client_ip ]`, `[ status, src_remote_server_id, dest_remote_server_id, path ]`, `[ status, src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ status, src_remote_server_id, path, client_ip ]`, `[ status, dest_remote_server_id, path, client_ip ]`, `[ src_remote_server_id, dest_remote_server_id, path, client_ip ]`, `[ start_date, end_date, operation, status, src_remote_server_id ]`, `[ start_date, end_date, operation, status, dest_remote_server_id ]`, `[ start_date, end_date, operation, status, path ]`, `[ start_date, end_date, operation, status, client_ip ]`, `[ start_date, end_date, operation, src_remote_server_id, dest_remote_server_id ]`, `[ start_date, end_date, operation, src_remote_server_id, path ]`, `[ start_date, end_date, operation, src_remote_server_id, client_ip ]`, `[ start_date, end_date, operation, dest_remote_server_id, path ]`, `[ start_date, end_date, operation, dest_remote_server_id, client_ip ]`, `[ start_date, end_date, operation, path, client_ip ]`, `[ start_date, end_date, status, src_remote_server_id, dest_remote_server_id ]`, `[ start_date, end_date, status, src_remote_server_id, path ]`, `[ start_date, end_date, status, src_remote_server_id, client_ip ]`, `[ start_date, end_date, status, dest_remote_server_id, path ]`, `[ start_date, end_date, status, dest_remote_server_id, client_ip ]`, `[ start_date, end_date, status, path, client_ip ]`, `[ start_date, end_date, src_remote_server_id, dest_remote_server_id, path ]`, `[ start_date, end_date, src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ start_date, end_date, src_remote_server_id, path, client_ip ]`, `[ start_date, end_date, dest_remote_server_id, path, client_ip ]`, `[ start_date, operation, status, src_remote_server_id, dest_remote_server_id ]`, `[ start_date, operation, status, src_remote_server_id, path ]`, `[ start_date, operation, status, src_remote_server_id, client_ip ]`, `[ start_date, operation, status, dest_remote_server_id, path ]`, `[ start_date, operation, status, dest_remote_server_id, client_ip ]`, `[ start_date, operation, status, path, client_ip ]`, `[ start_date, operation, src_remote_server_id, dest_remote_server_id, path ]`, `[ start_date, operation, src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ start_date, operation, src_remote_server_id, path, client_ip ]`, `[ start_date, operation, dest_remote_server_id, path, client_ip ]`, `[ start_date, status, src_remote_server_id, dest_remote_server_id, path ]`, `[ start_date, status, src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ start_date, status, src_remote_server_id, path, client_ip ]`, `[ start_date, status, dest_remote_server_id, path, client_ip ]`, `[ start_date, src_remote_server_id, dest_remote_server_id, path, client_ip ]`, `[ end_date, operation, status, src_remote_server_id, dest_remote_server_id ]`, `[ end_date, operation, status, src_remote_server_id, path ]`, `[ end_date, operation, status, src_remote_server_id, client_ip ]`, `[ end_date, operation, status, dest_remote_server_id, path ]`, `[ end_date, operation, status, dest_remote_server_id, client_ip ]`, `[ end_date, operation, status, path, client_ip ]`, `[ end_date, operation, src_remote_server_id, dest_remote_server_id, path ]`, `[ end_date, operation, src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ end_date, operation, src_remote_server_id, path, client_ip ]`, `[ end_date, operation, dest_remote_server_id, path, client_ip ]`, `[ end_date, status, src_remote_server_id, dest_remote_server_id, path ]`, `[ end_date, status, src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ end_date, status, src_remote_server_id, path, client_ip ]`, `[ end_date, status, dest_remote_server_id, path, client_ip ]`, `[ end_date, src_remote_server_id, dest_remote_server_id, path, client_ip ]`, `[ operation, status, src_remote_server_id, dest_remote_server_id, path ]`, `[ operation, status, src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ operation, status, src_remote_server_id, path, client_ip ]`, `[ operation, status, dest_remote_server_id, path, client_ip ]`, `[ operation, src_remote_server_id, dest_remote_server_id, path, client_ip ]`, `[ status, src_remote_server_id, dest_remote_server_id, path, client_ip ]`, `[ start_date, end_date, operation, status, src_remote_server_id, dest_remote_server_id ]`, `[ start_date, end_date, operation, status, src_remote_server_id, path ]`, `[ start_date, end_date, operation, status, src_remote_server_id, client_ip ]`, `[ start_date, end_date, operation, status, dest_remote_server_id, path ]`, `[ start_date, end_date, operation, status, dest_remote_server_id, client_ip ]`, `[ start_date, end_date, operation, status, path, client_ip ]`, `[ start_date, end_date, operation, src_remote_server_id, dest_remote_server_id, path ]`, `[ start_date, end_date, operation, src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ start_date, end_date, operation, src_remote_server_id, path, client_ip ]`, `[ start_date, end_date, operation, dest_remote_server_id, path, client_ip ]`, `[ start_date, end_date, status, src_remote_server_id, dest_remote_server_id, path ]`, `[ start_date, end_date, status, src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ start_date, end_date, status, src_remote_server_id, path, client_ip ]`, `[ start_date, end_date, status, dest_remote_server_id, path, client_ip ]`, `[ start_date, end_date, src_remote_server_id, dest_remote_server_id, path, client_ip ]`, `[ start_date, operation, status, src_remote_server_id, dest_remote_server_id, path ]`, `[ start_date, operation, status, src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ start_date, operation, status, src_remote_server_id, path, client_ip ]`, `[ start_date, operation, status, dest_remote_server_id, path, client_ip ]`, `[ start_date, operation, src_remote_server_id, dest_remote_server_id, path, client_ip ]`, `[ start_date, status, src_remote_server_id, dest_remote_server_id, path, client_ip ]`, `[ end_date, operation, status, src_remote_server_id, dest_remote_server_id, path ]`, `[ end_date, operation, status, src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ end_date, operation, status, src_remote_server_id, path, client_ip ]`, `[ end_date, operation, status, dest_remote_server_id, path, client_ip ]`, `[ end_date, operation, src_remote_server_id, dest_remote_server_id, path, client_ip ]`, `[ end_date, status, src_remote_server_id, dest_remote_server_id, path, client_ip ]`, `[ operation, status, src_remote_server_id, dest_remote_server_id, path, client_ip ]`, `[ start_date, end_date, operation, status, src_remote_server_id, dest_remote_server_id, path ]`, `[ start_date, end_date, operation, status, src_remote_server_id, dest_remote_server_id, client_ip ]`, `[ start_date, end_date, operation, status, src_remote_server_id, path, client_ip ]`, `[ start_date, end_date, operation, status, dest_remote_server_id, path, client_ip ]`, `[ start_date, end_date, operation, src_remote_server_id, dest_remote_server_id, path, client_ip ]`, `[ start_date, end_date, status, src_remote_server_id, dest_remote_server_id, path, client_ip ]`, `[ start_date, operation, status, src_remote_server_id, dest_remote_server_id, path, client_ip ]` or `[ end_date, operation, status, src_remote_server_id, dest_remote_server_id, path, client_ip ]`.
57
+ def list(params=None, options=None):
58
+ if not isinstance(params, dict):
59
+ params = {}
60
+ if not isinstance(options, dict):
61
+ options = {}
62
+ if "cursor" in params and not isinstance(params["cursor"], str):
63
+ raise InvalidParameterError("Bad parameter: cursor must be an str")
64
+ if "per_page" in params and not isinstance(params["per_page"], int):
65
+ raise InvalidParameterError("Bad parameter: per_page must be an int")
66
+ if "filter" in params and not isinstance(params["filter"], dict):
67
+ raise InvalidParameterError("Bad parameter: filter must be an dict")
68
+ if "filter_prefix" in params and not isinstance(
69
+ params["filter_prefix"], dict
70
+ ):
71
+ raise InvalidParameterError(
72
+ "Bad parameter: filter_prefix must be an dict"
73
+ )
74
+ return ListObj(
75
+ OutboundConnectionLog,
76
+ "GET",
77
+ "/outbound_connection_logs",
78
+ params,
79
+ options,
80
+ )
81
+
82
+
83
+ def all(params=None, options=None):
84
+ list(params, options)
85
+
86
+
87
+ def new(*args, **kwargs):
88
+ return OutboundConnectionLog(*args, **kwargs)
@@ -0,0 +1,91 @@
1
+ import builtins # noqa: F401
2
+ from files_sdk.models.account_line_item import AccountLineItem
3
+ from files_sdk.api import Api # noqa: F401
4
+ from files_sdk.list_obj import ListObj
5
+ from files_sdk.error import ( # noqa: F401
6
+ InvalidParameterError,
7
+ MissingParameterError,
8
+ NotImplementedError,
9
+ )
10
+
11
+
12
+ class Payment:
13
+ default_attributes = {
14
+ "id": None, # int64 - Line item Id
15
+ "amount": None, # double - Line item amount
16
+ "balance": None, # double - Line item balance
17
+ "created_at": None, # date-time - Line item created at
18
+ "currency": None, # string - Line item currency
19
+ "download_uri": None, # string - Line item download uri
20
+ "invoice_line_items": None, # array(object) - Associated invoice line items
21
+ "method": None, # string - Line item payment method
22
+ "payment_line_items": None, # array(object) - Associated payment line items
23
+ "payment_reversed_at": None, # date-time - Date/time payment was reversed if applicable
24
+ "payment_type": None, # string - Type of payment if applicable
25
+ "site_name": None, # string - Site name this line item is for
26
+ "type": None, # string - Type of line item, either payment or invoice
27
+ }
28
+
29
+ def __init__(self, attributes=None, options=None):
30
+ if not isinstance(attributes, dict):
31
+ attributes = {}
32
+ if not isinstance(options, dict):
33
+ options = {}
34
+ self.set_attributes(attributes)
35
+ self.options = options
36
+
37
+ def set_attributes(self, attributes):
38
+ for attribute, default_value in Payment.default_attributes.items():
39
+ setattr(self, attribute, attributes.get(attribute, default_value))
40
+
41
+ def get_attributes(self):
42
+ return {
43
+ k: getattr(self, k, None)
44
+ for k in Payment.default_attributes
45
+ if getattr(self, k, None) is not None
46
+ }
47
+
48
+
49
+ # Parameters:
50
+ # 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.
51
+ # per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
52
+ def list(params=None, options=None):
53
+ if not isinstance(params, dict):
54
+ params = {}
55
+ if not isinstance(options, dict):
56
+ options = {}
57
+ if "cursor" in params and not isinstance(params["cursor"], str):
58
+ raise InvalidParameterError("Bad parameter: cursor must be an str")
59
+ if "per_page" in params and not isinstance(params["per_page"], int):
60
+ raise InvalidParameterError("Bad parameter: per_page must be an int")
61
+ return ListObj(AccountLineItem, "GET", "/payments", params, options)
62
+
63
+
64
+ def all(params=None, options=None):
65
+ list(params, options)
66
+
67
+
68
+ # Parameters:
69
+ # id (required) - int64 - Payment ID.
70
+ def find(id, params=None, options=None):
71
+ if not isinstance(params, dict):
72
+ params = {}
73
+ if not isinstance(options, dict):
74
+ options = {}
75
+ params["id"] = id
76
+ if "id" in params and not isinstance(params["id"], int):
77
+ raise InvalidParameterError("Bad parameter: id must be an int")
78
+ if "id" not in params:
79
+ raise MissingParameterError("Parameter missing: id")
80
+ response, options = Api.send_request(
81
+ "GET", "/payments/{id}".format(id=params["id"]), params, options
82
+ )
83
+ return AccountLineItem(response.data, options)
84
+
85
+
86
+ def get(id, params=None, options=None):
87
+ find(id, params, options)
88
+
89
+
90
+ def new(*args, **kwargs):
91
+ return Payment(*args, **kwargs)
@@ -0,0 +1,42 @@
1
+ import builtins # noqa: F401
2
+ from files_sdk.api import Api # noqa: F401
3
+ from files_sdk.error import ( # noqa: F401
4
+ InvalidParameterError,
5
+ MissingParameterError,
6
+ NotImplementedError,
7
+ )
8
+
9
+
10
+ class PaymentLineItem:
11
+ default_attributes = {
12
+ "amount": None, # double - Payment line item amount
13
+ "created_at": None, # date-time - Payment line item created at date/time
14
+ "invoice_id": None, # int64 - Invoice ID
15
+ "payment_id": None, # int64 - Payment ID
16
+ }
17
+
18
+ def __init__(self, attributes=None, options=None):
19
+ if not isinstance(attributes, dict):
20
+ attributes = {}
21
+ if not isinstance(options, dict):
22
+ options = {}
23
+ self.set_attributes(attributes)
24
+ self.options = options
25
+
26
+ def set_attributes(self, attributes):
27
+ for (
28
+ attribute,
29
+ default_value,
30
+ ) in PaymentLineItem.default_attributes.items():
31
+ setattr(self, attribute, attributes.get(attribute, default_value))
32
+
33
+ def get_attributes(self):
34
+ return {
35
+ k: getattr(self, k, None)
36
+ for k in PaymentLineItem.default_attributes
37
+ if getattr(self, k, None) is not None
38
+ }
39
+
40
+
41
+ def new(*args, **kwargs):
42
+ return PaymentLineItem(*args, **kwargs)