files.com 1.0.57 → 1.0.58
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.
- checksums.yaml +4 -4
- data/_VERSION +1 -1
- data/docs/site.md +2 -2
- data/lib/files.com/models/api_key.rb +5 -5
- data/lib/files.com/models/as2_key.rb +5 -5
- data/lib/files.com/models/automation.rb +3 -3
- data/lib/files.com/models/behavior.rb +5 -5
- data/lib/files.com/models/bundle.rb +8 -8
- data/lib/files.com/models/dns_record.rb +2 -2
- data/lib/files.com/models/file.rb +9 -9
- data/lib/files.com/models/file_action.rb +6 -6
- data/lib/files.com/models/file_comment.rb +2 -2
- data/lib/files.com/models/file_comment_reaction.rb +2 -2
- data/lib/files.com/models/folder.rb +2 -2
- data/lib/files.com/models/group.rb +3 -3
- data/lib/files.com/models/group_user.rb +8 -8
- data/lib/files.com/models/history.rb +11 -11
- data/lib/files.com/models/history_export.rb +10 -10
- data/lib/files.com/models/invoice.rb +3 -3
- data/lib/files.com/models/ip_address.rb +2 -2
- data/lib/files.com/models/lock.rb +3 -3
- data/lib/files.com/models/message.rb +9 -9
- data/lib/files.com/models/message_comment.rb +6 -6
- data/lib/files.com/models/message_comment_reaction.rb +6 -6
- data/lib/files.com/models/message_reaction.rb +6 -6
- data/lib/files.com/models/notification.rb +7 -7
- data/lib/files.com/models/payment.rb +3 -3
- data/lib/files.com/models/permission.rb +5 -5
- data/lib/files.com/models/project.rb +3 -3
- data/lib/files.com/models/public_key.rb +5 -5
- data/lib/files.com/models/remote_server.rb +9 -9
- data/lib/files.com/models/request.rb +7 -7
- data/lib/files.com/models/site.rb +13 -13
- data/lib/files.com/models/sso_strategy.rb +3 -3
- data/lib/files.com/models/usage_daily_snapshot.rb +2 -2
- data/lib/files.com/models/usage_snapshot.rb +2 -2
- data/lib/files.com/models/user.rb +15 -15
- data/lib/files.com/models/user_cipher_use.rb +3 -3
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 95ef0f5e3fcf334ae2d2abecebcf49f85fe6b6527e5d8b5d8553480a0d794395
|
4
|
+
data.tar.gz: 32bf7c269933adf563c492162df9a1d2ed234187623549ae1076144c540cc311
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f257bdbe6e08c15938be2b3009c83c1127194d24d5fd93b4b3427a9a3f32046376ed91ea318890904170a258aa5644169db0af2c9c4fd5a49a745dd4015a62bb
|
7
|
+
data.tar.gz: 7151db08884f1cd7aa4d33f18e25112abf3beaff0750c16212a3c6185836ec4aa5b900bc3707f80144e2eac057d2f8e4d8773a56136ab98ba89ce54b6bb4ed4d
|
data/_VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.0.
|
1
|
+
1.0.58
|
data/docs/site.md
CHANGED
@@ -262,7 +262,7 @@ Files::Site.update(
|
|
262
262
|
desktop_app_session_lifetime: 1,
|
263
263
|
folder_permissions_groups_only: true,
|
264
264
|
welcome_screen: "user_controlled",
|
265
|
-
session_expiry:
|
265
|
+
session_expiry: 1.0,
|
266
266
|
ssl_required: true,
|
267
267
|
tls_disabled: true,
|
268
268
|
user_lockout: true,
|
@@ -349,7 +349,7 @@ Files::Site.update(
|
|
349
349
|
* `desktop_app_session_lifetime` (int64): Desktop app session lifetime (in hours)
|
350
350
|
* `folder_permissions_groups_only` (boolean): If true, permissions for this site must be bound to a group (not a user). Otherwise, permissions must be bound to a user.
|
351
351
|
* `welcome_screen` (string): Does the welcome screen appear?
|
352
|
-
* `session_expiry` (
|
352
|
+
* `session_expiry` (double): Session expiry in hours
|
353
353
|
* `ssl_required` (boolean): Is SSL required? Disabling this is insecure.
|
354
354
|
* `tls_disabled` (boolean): Is TLS disabled(site setting)?
|
355
355
|
* `user_lockout` (boolean): Will users be locked out after incorrect login attempts?
|
@@ -136,9 +136,9 @@ module Files
|
|
136
136
|
end
|
137
137
|
|
138
138
|
# Parameters:
|
139
|
-
# user_id -
|
140
|
-
# page -
|
141
|
-
# per_page -
|
139
|
+
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
140
|
+
# page - int64 - Current page number.
|
141
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
142
142
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
143
143
|
def self.list(params = {}, options = {})
|
144
144
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
|
@@ -159,7 +159,7 @@ module Files
|
|
159
159
|
end
|
160
160
|
|
161
161
|
# Parameters:
|
162
|
-
# id (required) -
|
162
|
+
# id (required) - int64 - Api Key ID.
|
163
163
|
def self.find(id, params = {}, options = {})
|
164
164
|
params ||= {}
|
165
165
|
params[:id] = id
|
@@ -175,7 +175,7 @@ module Files
|
|
175
175
|
end
|
176
176
|
|
177
177
|
# Parameters:
|
178
|
-
# user_id -
|
178
|
+
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
179
179
|
# name - string - Internal name for key. For your reference only.
|
180
180
|
# permission_set - string - Leave blank, or set to 'desktop_app' to restrict the key to only desktop app functions.
|
181
181
|
# expires_at - string - Have the key expire at this date/time.
|
@@ -97,9 +97,9 @@ module Files
|
|
97
97
|
end
|
98
98
|
|
99
99
|
# Parameters:
|
100
|
-
# user_id -
|
101
|
-
# page -
|
102
|
-
# per_page -
|
100
|
+
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
101
|
+
# page - int64 - Current page number.
|
102
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
103
103
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
104
104
|
def self.list(params = {}, options = {})
|
105
105
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
|
@@ -115,7 +115,7 @@ module Files
|
|
115
115
|
end
|
116
116
|
|
117
117
|
# Parameters:
|
118
|
-
# id (required) -
|
118
|
+
# id (required) - int64 - As2 Key ID.
|
119
119
|
def self.find(id, params = {}, options = {})
|
120
120
|
params ||= {}
|
121
121
|
params[:id] = id
|
@@ -131,7 +131,7 @@ module Files
|
|
131
131
|
end
|
132
132
|
|
133
133
|
# Parameters:
|
134
|
-
# user_id -
|
134
|
+
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
135
135
|
# as2_partnership_name (required) - string - AS2 Partnership Name
|
136
136
|
# public_key (required) - string - Actual contents of Public key.
|
137
137
|
def self.create(params = {}, options = {})
|
@@ -180,8 +180,8 @@ module Files
|
|
180
180
|
end
|
181
181
|
|
182
182
|
# Parameters:
|
183
|
-
# page -
|
184
|
-
# per_page -
|
183
|
+
# page - int64 - Current page number.
|
184
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
185
185
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
186
186
|
# automation - string - Type of automation to filter by.
|
187
187
|
def self.list(params = {}, options = {})
|
@@ -198,7 +198,7 @@ module Files
|
|
198
198
|
end
|
199
199
|
|
200
200
|
# Parameters:
|
201
|
-
# id (required) -
|
201
|
+
# id (required) - int64 - Automation ID.
|
202
202
|
def self.find(id, params = {}, options = {})
|
203
203
|
params ||= {}
|
204
204
|
params[:id] = id
|
@@ -101,8 +101,8 @@ module Files
|
|
101
101
|
end
|
102
102
|
|
103
103
|
# Parameters:
|
104
|
-
# page -
|
105
|
-
# per_page -
|
104
|
+
# page - int64 - Current page number.
|
105
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
106
106
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
107
107
|
# behavior - string - If set, only shows folder behaviors matching this behavior type.
|
108
108
|
def self.list(params = {}, options = {})
|
@@ -119,8 +119,8 @@ module Files
|
|
119
119
|
end
|
120
120
|
|
121
121
|
# Parameters:
|
122
|
-
# page -
|
123
|
-
# per_page -
|
122
|
+
# page - int64 - Current page number.
|
123
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
124
124
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
125
125
|
# path (required) - string - Path to operate on.
|
126
126
|
# recursive - string - Show behaviors below this path?
|
@@ -140,7 +140,7 @@ module Files
|
|
140
140
|
end
|
141
141
|
|
142
142
|
# Parameters:
|
143
|
-
# id (required) -
|
143
|
+
# id (required) - int64 - Behavior ID.
|
144
144
|
def self.find(id, params = {}, options = {})
|
145
145
|
params ||= {}
|
146
146
|
params[:id] = id
|
@@ -116,7 +116,7 @@ module Files
|
|
116
116
|
# Send email(s) with a link to bundle
|
117
117
|
#
|
118
118
|
# Parameters:
|
119
|
-
# to (required) - array - A list of email addresses to share this bundle with.
|
119
|
+
# to (required) - array(string) - A list of email addresses to share this bundle with.
|
120
120
|
# note - string - Note to include in email.
|
121
121
|
def share(params = {})
|
122
122
|
params ||= {}
|
@@ -176,9 +176,9 @@ module Files
|
|
176
176
|
end
|
177
177
|
|
178
178
|
# Parameters:
|
179
|
-
# user_id -
|
180
|
-
# page -
|
181
|
-
# per_page -
|
179
|
+
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
180
|
+
# page - int64 - Current page number.
|
181
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
182
182
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
183
183
|
def self.list(params = {}, options = {})
|
184
184
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
|
@@ -194,7 +194,7 @@ module Files
|
|
194
194
|
end
|
195
195
|
|
196
196
|
# Parameters:
|
197
|
-
# id (required) -
|
197
|
+
# id (required) - int64 - Bundle ID.
|
198
198
|
def self.find(id, params = {}, options = {})
|
199
199
|
params ||= {}
|
200
200
|
params[:id] = id
|
@@ -210,8 +210,8 @@ module Files
|
|
210
210
|
end
|
211
211
|
|
212
212
|
# Parameters:
|
213
|
-
# user_id -
|
214
|
-
# paths (required) - array - A list of paths to include in this bundle.
|
213
|
+
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
214
|
+
# paths (required) - array(string) - A list of paths to include in this bundle.
|
215
215
|
# password - string - Password for this bundle.
|
216
216
|
# expires_at - string - Bundle expiration date/time
|
217
217
|
# description - string - Public description
|
@@ -234,7 +234,7 @@ module Files
|
|
234
234
|
# Send email(s) with a link to bundle
|
235
235
|
#
|
236
236
|
# Parameters:
|
237
|
-
# to (required) - array - A list of email addresses to share this bundle with.
|
237
|
+
# to (required) - array(string) - A list of email addresses to share this bundle with.
|
238
238
|
# note - string - Note to include in email.
|
239
239
|
def self.share(id, params = {}, options = {})
|
240
240
|
params ||= {}
|
@@ -30,8 +30,8 @@ module Files
|
|
30
30
|
end
|
31
31
|
|
32
32
|
# Parameters:
|
33
|
-
# page -
|
34
|
-
# per_page -
|
33
|
+
# page - int64 - Current page number.
|
34
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
35
35
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
36
36
|
def self.list(params = {}, options = {})
|
37
37
|
raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
|
@@ -825,7 +825,7 @@ module Files
|
|
825
825
|
#
|
826
826
|
# Parameters:
|
827
827
|
# action - string - Can be blank, `redirect` or `stat`. If set to `stat`, we will return file information but without a download URL, and without logging a download. If set to `redirect` we will serve a 302 redirect directly to the file. This is used for integrations with Zapier, and is not recommended for most integrations.
|
828
|
-
# id -
|
828
|
+
# id - int64 - If provided, lookup the file by id instead of path.
|
829
829
|
# with_previews - boolean - Include file preview information?
|
830
830
|
# with_priority_color - boolean - Include file priority color information?
|
831
831
|
def download(params = {})
|
@@ -884,7 +884,7 @@ module Files
|
|
884
884
|
#
|
885
885
|
# Parameters:
|
886
886
|
# action - string - Can be blank, `redirect` or `stat`. If set to `stat`, we will return file information but without a download URL, and without logging a download. If set to `redirect` we will serve a 302 redirect directly to the file. This is used for integrations with Zapier, and is not recommended for most integrations.
|
887
|
-
# id -
|
887
|
+
# id - int64 - If provided, lookup the file by id instead of path.
|
888
888
|
# with_previews - boolean - Include file preview information?
|
889
889
|
# with_priority_color - boolean - Include file priority color information?
|
890
890
|
def self.download(path, params = {}, options = {})
|
@@ -902,16 +902,16 @@ module Files
|
|
902
902
|
# Parameters:
|
903
903
|
# path (required) - string - Path to operate on.
|
904
904
|
# action - string - The action to perform. Can be `append`, `attachment`, `end`, `upload`, `put`, or may not exist
|
905
|
-
# etags[etag] (required) - array - etag identifier.
|
906
|
-
# etags[part] (required) - array - Part number.
|
907
|
-
# length -
|
905
|
+
# etags[etag] (required) - array(string) - etag identifier.
|
906
|
+
# etags[part] (required) - array(int64) - Part number.
|
907
|
+
# length - int64 - Length of file.
|
908
908
|
# mkdir_parents - boolean - Create parent directories if they do not exist?
|
909
|
-
# part -
|
910
|
-
# parts -
|
909
|
+
# part - int64 - Part if uploading a part.
|
910
|
+
# parts - int64 - How many parts to fetch?
|
911
911
|
# provided_mtime - string - User provided modification time.
|
912
912
|
# ref - string -
|
913
|
-
# restart -
|
914
|
-
# size -
|
913
|
+
# restart - int64 - File byte offset to restart from.
|
914
|
+
# size - int64 - Size of file.
|
915
915
|
# structure - string - If copying folder, copy just the structure?
|
916
916
|
# with_rename - boolean - Allow file rename instead of overwrite?
|
917
917
|
def self.create(path, params = {}, options = {})
|
@@ -45,10 +45,10 @@ module Files
|
|
45
45
|
#
|
46
46
|
# Parameters:
|
47
47
|
# mkdir_parents - boolean - Create parent directories if they do not exist?
|
48
|
-
# part -
|
49
|
-
# parts -
|
48
|
+
# part - int64 - Part if uploading a part.
|
49
|
+
# parts - int64 - How many parts to fetch?
|
50
50
|
# ref - string -
|
51
|
-
# restart -
|
51
|
+
# restart - int64 - File byte offset to restart from.
|
52
52
|
# with_rename - boolean - Allow file rename instead of overwrite?
|
53
53
|
def begin_upload(params = {})
|
54
54
|
params ||= {}
|
@@ -100,10 +100,10 @@ module Files
|
|
100
100
|
#
|
101
101
|
# Parameters:
|
102
102
|
# mkdir_parents - boolean - Create parent directories if they do not exist?
|
103
|
-
# part -
|
104
|
-
# parts -
|
103
|
+
# part - int64 - Part if uploading a part.
|
104
|
+
# parts - int64 - How many parts to fetch?
|
105
105
|
# ref - string -
|
106
|
-
# restart -
|
106
|
+
# restart - int64 - File byte offset to restart from.
|
107
107
|
# with_rename - boolean - Allow file rename instead of overwrite?
|
108
108
|
def self.begin_upload(path, params = {}, options = {})
|
109
109
|
params ||= {}
|
@@ -83,8 +83,8 @@ module Files
|
|
83
83
|
end
|
84
84
|
|
85
85
|
# Parameters:
|
86
|
-
# page -
|
87
|
-
# per_page -
|
86
|
+
# page - int64 - Current page number.
|
87
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
88
88
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
89
89
|
# path (required) - string - Path to operate on.
|
90
90
|
def self.list_for(path, params = {}, options = {})
|
@@ -69,8 +69,8 @@ module Files
|
|
69
69
|
end
|
70
70
|
|
71
71
|
# Parameters:
|
72
|
-
# user_id -
|
73
|
-
# file_comment_id (required) -
|
72
|
+
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
73
|
+
# file_comment_id (required) - int64 - ID of file comment to attach reaction to.
|
74
74
|
# emoji (required) - string - Emoji to react with.
|
75
75
|
def self.create(params = {}, options = {})
|
76
76
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
|
@@ -312,8 +312,8 @@ module Files
|
|
312
312
|
end
|
313
313
|
|
314
314
|
# Parameters:
|
315
|
-
# page -
|
316
|
-
# per_page -
|
315
|
+
# page - int64 - Current page number.
|
316
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
317
317
|
# action - string - Action to take. Can be `count`, `count_nrs` (non recursive), `size`, `permissions`, or blank.
|
318
318
|
# path (required) - string - Path to operate on.
|
319
319
|
# cursor - string - Send cursor to resume an existing list from the point at which you left off. Get a cursor from an existing list via the X-Files-Cursor header.
|
@@ -106,8 +106,8 @@ module Files
|
|
106
106
|
end
|
107
107
|
|
108
108
|
# Parameters:
|
109
|
-
# page -
|
110
|
-
# per_page -
|
109
|
+
# page - int64 - Current page number.
|
110
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
111
111
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
112
112
|
# ids - string - Comma-separated list of group ids to include in results.
|
113
113
|
def self.list(params = {}, options = {})
|
@@ -124,7 +124,7 @@ module Files
|
|
124
124
|
end
|
125
125
|
|
126
126
|
# Parameters:
|
127
|
-
# id (required) -
|
127
|
+
# id (required) - int64 - Group ID.
|
128
128
|
def self.find(id, params = {}, options = {})
|
129
129
|
params ||= {}
|
130
130
|
params[:id] = id
|
@@ -64,8 +64,8 @@ module Files
|
|
64
64
|
end
|
65
65
|
|
66
66
|
# Parameters:
|
67
|
-
# group_id (required) -
|
68
|
-
# user_id (required) -
|
67
|
+
# group_id (required) - int64 - Group ID to add user to.
|
68
|
+
# user_id (required) - int64 - User ID to add to group.
|
69
69
|
# admin - boolean - Is the user a group administrator?
|
70
70
|
def update(params = {})
|
71
71
|
params ||= {}
|
@@ -100,11 +100,11 @@ module Files
|
|
100
100
|
end
|
101
101
|
|
102
102
|
# Parameters:
|
103
|
-
# user_id -
|
104
|
-
# page -
|
105
|
-
# per_page -
|
103
|
+
# user_id - int64 - User ID. If provided, will return groups of which this user is a member.
|
104
|
+
# page - int64 - Current page number.
|
105
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
106
106
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
107
|
-
# group_id -
|
107
|
+
# group_id - int64 - Group ID. If provided, will return members of this group.
|
108
108
|
def self.list(params = {}, options = {})
|
109
109
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
|
110
110
|
raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
|
@@ -120,8 +120,8 @@ module Files
|
|
120
120
|
end
|
121
121
|
|
122
122
|
# Parameters:
|
123
|
-
# group_id (required) -
|
124
|
-
# user_id (required) -
|
123
|
+
# group_id (required) - int64 - Group ID to add user to.
|
124
|
+
# user_id (required) - int64 - User ID to add to group.
|
125
125
|
# admin - boolean - Is the user a group administrator?
|
126
126
|
def self.update(id, params = {}, options = {})
|
127
127
|
params ||= {}
|
@@ -78,8 +78,8 @@ module Files
|
|
78
78
|
# start_at - string - Leave blank or set to a date/time to filter earlier entries.
|
79
79
|
# end_at - string - Leave blank or set to a date/time to filter later entries.
|
80
80
|
# display - string - Display format. Leave blank or set to `full` or `parent`.
|
81
|
-
# page -
|
82
|
-
# per_page -
|
81
|
+
# page - int64 - Current page number.
|
82
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
83
83
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
84
84
|
# path (required) - string - Path to operate on.
|
85
85
|
def self.list_for_file(path, params = {}, options = {})
|
@@ -101,8 +101,8 @@ module Files
|
|
101
101
|
# start_at - string - Leave blank or set to a date/time to filter earlier entries.
|
102
102
|
# end_at - string - Leave blank or set to a date/time to filter later entries.
|
103
103
|
# display - string - Display format. Leave blank or set to `full` or `parent`.
|
104
|
-
# page -
|
105
|
-
# per_page -
|
104
|
+
# page - int64 - Current page number.
|
105
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
106
106
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
107
107
|
# path (required) - string - Path to operate on.
|
108
108
|
def self.list_for_folder(path, params = {}, options = {})
|
@@ -124,10 +124,10 @@ module Files
|
|
124
124
|
# start_at - string - Leave blank or set to a date/time to filter earlier entries.
|
125
125
|
# end_at - string - Leave blank or set to a date/time to filter later entries.
|
126
126
|
# display - string - Display format. Leave blank or set to `full` or `parent`.
|
127
|
-
# page -
|
128
|
-
# per_page -
|
127
|
+
# page - int64 - Current page number.
|
128
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
129
129
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
130
|
-
# user_id (required) -
|
130
|
+
# user_id (required) - int64 - User ID.
|
131
131
|
def self.list_for_user(user_id, params = {}, options = {})
|
132
132
|
params ||= {}
|
133
133
|
params[:user_id] = user_id
|
@@ -147,8 +147,8 @@ module Files
|
|
147
147
|
# start_at - string - Leave blank or set to a date/time to filter earlier entries.
|
148
148
|
# end_at - string - Leave blank or set to a date/time to filter later entries.
|
149
149
|
# display - string - Display format. Leave blank or set to `full` or `parent`.
|
150
|
-
# page -
|
151
|
-
# per_page -
|
150
|
+
# page - int64 - Current page number.
|
151
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
152
152
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
153
153
|
def self.list_logins(params = {}, options = {})
|
154
154
|
raise InvalidParameterError.new("Bad parameter: start_at must be an String") if params.dig(:start_at) and !params.dig(:start_at).is_a?(String)
|
@@ -165,8 +165,8 @@ module Files
|
|
165
165
|
# start_at - string - Leave blank or set to a date/time to filter earlier entries.
|
166
166
|
# end_at - string - Leave blank or set to a date/time to filter later entries.
|
167
167
|
# display - string - Display format. Leave blank or set to `full` or `parent`.
|
168
|
-
# page -
|
169
|
-
# per_page -
|
168
|
+
# page - int64 - Current page number.
|
169
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
170
170
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
171
171
|
def self.list(params = {}, options = {})
|
172
172
|
raise InvalidParameterError.new("Bad parameter: start_at must be an String") if params.dig(:start_at) and !params.dig(:start_at).is_a?(String)
|
@@ -249,9 +249,9 @@ module Files
|
|
249
249
|
end
|
250
250
|
|
251
251
|
# Parameters:
|
252
|
-
# user_id -
|
253
|
-
# page -
|
254
|
-
# per_page -
|
252
|
+
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
253
|
+
# page - int64 - Current page number.
|
254
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
255
255
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
256
256
|
def self.list(params = {}, options = {})
|
257
257
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
|
@@ -267,7 +267,7 @@ module Files
|
|
267
267
|
end
|
268
268
|
|
269
269
|
# Parameters:
|
270
|
-
# id (required) -
|
270
|
+
# id (required) - int64 - History Export ID.
|
271
271
|
def self.find(id, params = {}, options = {})
|
272
272
|
params ||= {}
|
273
273
|
params[:id] = id
|
@@ -283,14 +283,14 @@ module Files
|
|
283
283
|
end
|
284
284
|
|
285
285
|
# Parameters:
|
286
|
-
# user_id -
|
286
|
+
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
287
287
|
# start_at - string - Start date/time of export range.
|
288
288
|
# end_at - string - End date/time of export range.
|
289
289
|
# query_action - string - Filter results by this this action type. Valid values: `create`, `read`, `update`, `destroy`, `move`, `login`, `failedlogin`, `copy`, `user_create`, `user_update`, `user_destroy`, `group_create`, `group_update`, `group_destroy`, `permission_create`, `permission_destroy`, `api_key_create`, `api_key_update`, `api_key_destroy`
|
290
290
|
# query_interface - string - Filter results by this this interface type. Valid values: `web`, `ftp`, `robot`, `jsapi`, `webdesktopapi`, `sftp`, `dav`, `desktop`, `restapi`, `scim`
|
291
|
-
# query_user_id -
|
292
|
-
# query_file_id -
|
293
|
-
# query_parent_id -
|
291
|
+
# query_user_id - int64 - Return results that are actions performed by the user indiciated by this User ID
|
292
|
+
# query_file_id - int64 - Return results that are file actions related to the file indicated by this File ID
|
293
|
+
# query_parent_id - int64 - Return results that are file actions inside the parent folder specified by this folder ID
|
294
294
|
# query_path - string - Return results that are file actions related to this path.
|
295
295
|
# query_folder - string - Return results that are file actions related to files or folders inside this folder path.
|
296
296
|
# query_src - string - Return results that are file moves originating from this path.
|
@@ -298,10 +298,10 @@ module Files
|
|
298
298
|
# query_ip - string - Filter results by this IP address.
|
299
299
|
# query_username - string - Filter results by this username.
|
300
300
|
# query_failure_type - string - If searching for Histories about login failures, this parameter restricts results to failures of this specific type. Valid values: `expired_trial`, `account_overdue`, `locked_out`, `ip_mismatch`, `password_mismatch`, `site_mismatch`, `username_not_found`, `none`, `no_ftp_permission`, `no_web_permission`, `no_directory`, `errno_enoent`, `no_sftp_permission`, `no_dav_permission`, `no_restapi_permission`, `key_mismatch`, `region_mismatch`, `expired_access`, `desktop_ip_mismatch`, `desktop_api_key_not_used_quickly_enough`, `disabled`
|
301
|
-
# query_target_id -
|
301
|
+
# query_target_id - int64 - If searching for Histories about specific objects (such as Users, or API Keys), this paremeter restricts results to objects that match this ID.
|
302
302
|
# query_target_name - string - If searching for Histories about Users, Groups or other objects with names, this parameter restricts results to objects with this name/username.
|
303
303
|
# query_target_permission - string - If searching for Histories about Permisisons, this parameter restricts results to permissions of this level.
|
304
|
-
# query_target_user_id -
|
304
|
+
# query_target_user_id - int64 - If searching for Histories about API keys, this parameter restricts results to API keys created by/for this user ID.
|
305
305
|
# query_target_username - string - If searching for Histories about API keys, this parameter restricts results to API keys created by/for this username.
|
306
306
|
# query_target_platform - string - If searching for Histories about API keys, this parameter restricts results to API keys associated with this platform.
|
307
307
|
# query_target_permission_set - string - If searching for Histories about API keys, this parameter restricts results to API keys with this permission set.
|