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
@@ -80,8 +80,8 @@ module Files
|
|
80
80
|
end
|
81
81
|
|
82
82
|
# Parameters:
|
83
|
-
# page -
|
84
|
-
# per_page -
|
83
|
+
# page - int64 - Current page number.
|
84
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
85
85
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
86
86
|
def self.list(params = {}, options = {})
|
87
87
|
raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
|
@@ -96,7 +96,7 @@ module Files
|
|
96
96
|
end
|
97
97
|
|
98
98
|
# Parameters:
|
99
|
-
# id (required) -
|
99
|
+
# id (required) - int64 - Invoice ID.
|
100
100
|
def self.find(id, params = {}, options = {})
|
101
101
|
params ||= {}
|
102
102
|
params[:id] = id
|
@@ -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)
|
@@ -118,8 +118,8 @@ module Files
|
|
118
118
|
end
|
119
119
|
|
120
120
|
# Parameters:
|
121
|
-
# page -
|
122
|
-
# per_page -
|
121
|
+
# page - int64 - Current page number.
|
122
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
123
123
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
124
124
|
# path (required) - string - Path to operate on.
|
125
125
|
# include_children - boolean - Include locks from children objects?
|
@@ -137,7 +137,7 @@ module Files
|
|
137
137
|
|
138
138
|
# Parameters:
|
139
139
|
# path (required) - string - Path
|
140
|
-
# timeout -
|
140
|
+
# timeout - int64 - Lock timeout length
|
141
141
|
def self.create(path, params = {}, options = {})
|
142
142
|
params ||= {}
|
143
143
|
params[:path] = path
|
@@ -64,7 +64,7 @@ module Files
|
|
64
64
|
end
|
65
65
|
|
66
66
|
# Parameters:
|
67
|
-
# project_id (required) -
|
67
|
+
# project_id (required) - int64 - Project to attach the message to.
|
68
68
|
# subject (required) - string - Message subject.
|
69
69
|
# body (required) - string - Message body.
|
70
70
|
def update(params = {})
|
@@ -107,11 +107,11 @@ module Files
|
|
107
107
|
end
|
108
108
|
|
109
109
|
# Parameters:
|
110
|
-
# user_id -
|
111
|
-
# page -
|
112
|
-
# per_page -
|
110
|
+
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
111
|
+
# page - int64 - Current page number.
|
112
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
113
113
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
114
|
-
# project_id (required) -
|
114
|
+
# project_id (required) - int64 - Project to return messages for.
|
115
115
|
def self.list(params = {}, options = {})
|
116
116
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
|
117
117
|
raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
|
@@ -128,7 +128,7 @@ module Files
|
|
128
128
|
end
|
129
129
|
|
130
130
|
# Parameters:
|
131
|
-
# id (required) -
|
131
|
+
# id (required) - int64 - Message ID.
|
132
132
|
def self.find(id, params = {}, options = {})
|
133
133
|
params ||= {}
|
134
134
|
params[:id] = id
|
@@ -144,8 +144,8 @@ module Files
|
|
144
144
|
end
|
145
145
|
|
146
146
|
# Parameters:
|
147
|
-
# user_id -
|
148
|
-
# project_id (required) -
|
147
|
+
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
148
|
+
# project_id (required) - int64 - Project to attach the message to.
|
149
149
|
# subject (required) - string - Message subject.
|
150
150
|
# body (required) - string - Message body.
|
151
151
|
def self.create(params = {}, options = {})
|
@@ -162,7 +162,7 @@ module Files
|
|
162
162
|
end
|
163
163
|
|
164
164
|
# Parameters:
|
165
|
-
# project_id (required) -
|
165
|
+
# project_id (required) - int64 - Project to attach the message to.
|
166
166
|
# subject (required) - string - Message subject.
|
167
167
|
# body (required) - string - Message body.
|
168
168
|
def self.update(id, params = {}, options = {})
|
@@ -83,11 +83,11 @@ module Files
|
|
83
83
|
end
|
84
84
|
|
85
85
|
# Parameters:
|
86
|
-
# user_id -
|
87
|
-
# page -
|
88
|
-
# per_page -
|
86
|
+
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
87
|
+
# page - int64 - Current page number.
|
88
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
89
89
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
90
|
-
# message_id (required) -
|
90
|
+
# message_id (required) - int64 - Message comment to return comments for.
|
91
91
|
def self.list(params = {}, options = {})
|
92
92
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
|
93
93
|
raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
|
@@ -104,7 +104,7 @@ module Files
|
|
104
104
|
end
|
105
105
|
|
106
106
|
# Parameters:
|
107
|
-
# id (required) -
|
107
|
+
# id (required) - int64 - Message Comment ID.
|
108
108
|
def self.find(id, params = {}, options = {})
|
109
109
|
params ||= {}
|
110
110
|
params[:id] = id
|
@@ -120,7 +120,7 @@ module Files
|
|
120
120
|
end
|
121
121
|
|
122
122
|
# Parameters:
|
123
|
-
# user_id -
|
123
|
+
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
124
124
|
# body (required) - string - Comment body.
|
125
125
|
def self.create(params = {}, options = {})
|
126
126
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
|
@@ -60,11 +60,11 @@ module Files
|
|
60
60
|
end
|
61
61
|
|
62
62
|
# Parameters:
|
63
|
-
# user_id -
|
64
|
-
# page -
|
65
|
-
# per_page -
|
63
|
+
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
64
|
+
# page - int64 - Current page number.
|
65
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
66
66
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
67
|
-
# message_comment_id (required) -
|
67
|
+
# message_comment_id (required) - int64 - Message comment to return reactions for.
|
68
68
|
def self.list(params = {}, options = {})
|
69
69
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
|
70
70
|
raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
|
@@ -81,7 +81,7 @@ module Files
|
|
81
81
|
end
|
82
82
|
|
83
83
|
# Parameters:
|
84
|
-
# id (required) -
|
84
|
+
# id (required) - int64 - Message Comment Reaction ID.
|
85
85
|
def self.find(id, params = {}, options = {})
|
86
86
|
params ||= {}
|
87
87
|
params[:id] = id
|
@@ -97,7 +97,7 @@ module Files
|
|
97
97
|
end
|
98
98
|
|
99
99
|
# Parameters:
|
100
|
-
# user_id -
|
100
|
+
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
101
101
|
# emoji (required) - string - Emoji to react with.
|
102
102
|
def self.create(params = {}, options = {})
|
103
103
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
|
@@ -60,11 +60,11 @@ module Files
|
|
60
60
|
end
|
61
61
|
|
62
62
|
# Parameters:
|
63
|
-
# user_id -
|
64
|
-
# page -
|
65
|
-
# per_page -
|
63
|
+
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
64
|
+
# page - int64 - Current page number.
|
65
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
66
66
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
67
|
-
# message_id (required) -
|
67
|
+
# message_id (required) - int64 - Message to return reactions for.
|
68
68
|
def self.list(params = {}, options = {})
|
69
69
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
|
70
70
|
raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
|
@@ -81,7 +81,7 @@ module Files
|
|
81
81
|
end
|
82
82
|
|
83
83
|
# Parameters:
|
84
|
-
# id (required) -
|
84
|
+
# id (required) - int64 - Message Reaction ID.
|
85
85
|
def self.find(id, params = {}, options = {})
|
86
86
|
params ||= {}
|
87
87
|
params[:id] = id
|
@@ -97,7 +97,7 @@ module Files
|
|
97
97
|
end
|
98
98
|
|
99
99
|
# Parameters:
|
100
|
-
# user_id -
|
100
|
+
# user_id - int64 - User ID. Provide a value of `0` to operate the current session's user.
|
101
101
|
# emoji (required) - string - Emoji to react with.
|
102
102
|
def self.create(params = {}, options = {})
|
103
103
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
|
@@ -156,11 +156,11 @@ module Files
|
|
156
156
|
end
|
157
157
|
|
158
158
|
# Parameters:
|
159
|
-
# user_id -
|
160
|
-
# page -
|
161
|
-
# per_page -
|
159
|
+
# user_id - int64 - Show notifications for this User ID.
|
160
|
+
# page - int64 - Current page number.
|
161
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
162
162
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
163
|
-
# group_id -
|
163
|
+
# group_id - int64 - Show notifications for this Group ID.
|
164
164
|
def self.list(params = {}, options = {})
|
165
165
|
raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
|
166
166
|
raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
|
@@ -176,7 +176,7 @@ module Files
|
|
176
176
|
end
|
177
177
|
|
178
178
|
# Parameters:
|
179
|
-
# id (required) -
|
179
|
+
# id (required) - int64 - Notification ID.
|
180
180
|
def self.find(id, params = {}, options = {})
|
181
181
|
params ||= {}
|
182
182
|
params[:id] = id
|
@@ -192,11 +192,11 @@ module Files
|
|
192
192
|
end
|
193
193
|
|
194
194
|
# Parameters:
|
195
|
-
# user_id -
|
195
|
+
# user_id - int64 - The id of the user to notify. Provide `user_id`, `username` or `group_id`.
|
196
196
|
# notify_on_copy - boolean - If `true`, copying or moving resources into this path will trigger a notification, in addition to just uploads.
|
197
197
|
# notify_user_actions - boolean - If `true` actions initiated by the user will still result in a notification
|
198
198
|
# send_interval - string - The time interval that notifications are aggregated by. Can be `five_minutes`, `fifteen_minutes`, `hourly`, or `daily`.
|
199
|
-
# group_id -
|
199
|
+
# group_id - int64 - The ID of the group to notify. Provide `user_id`, `username` or `group_id`.
|
200
200
|
# path - string - Path
|
201
201
|
# username - string - The username of the user to notify. Provide `user_id`, `username` or `group_id`.
|
202
202
|
def self.create(params = {}, options = {})
|
@@ -80,8 +80,8 @@ module Files
|
|
80
80
|
end
|
81
81
|
|
82
82
|
# Parameters:
|
83
|
-
# page -
|
84
|
-
# per_page -
|
83
|
+
# page - int64 - Current page number.
|
84
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
85
85
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
86
86
|
def self.list(params = {}, options = {})
|
87
87
|
raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
|
@@ -96,7 +96,7 @@ module Files
|
|
96
96
|
end
|
97
97
|
|
98
98
|
# Parameters:
|
99
|
-
# id (required) -
|
99
|
+
# id (required) - int64 - Payment ID.
|
100
100
|
def self.find(id, params = {}, options = {})
|
101
101
|
params ||= {}
|
102
102
|
params[:id] = id
|
@@ -91,8 +91,8 @@ module Files
|
|
91
91
|
end
|
92
92
|
|
93
93
|
# Parameters:
|
94
|
-
# page -
|
95
|
-
# per_page -
|
94
|
+
# page - int64 - Current page number.
|
95
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
96
96
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
97
97
|
# path - string - Permission path. If provided, will scope permissions to this path.
|
98
98
|
# group_id - string - Group ID. If provided, will scope permissions to this group.
|
@@ -116,11 +116,11 @@ module Files
|
|
116
116
|
end
|
117
117
|
|
118
118
|
# Parameters:
|
119
|
-
# group_id -
|
119
|
+
# group_id - int64 - Group ID
|
120
120
|
# path - string - Folder path
|
121
121
|
# permission - string - Permission type. Can be `admin`, `full`, `readonly`, `writeonly`, `previewonly`, or `history`
|
122
122
|
# recursive - boolean - Apply to subfolders recursively?
|
123
|
-
# user_id -
|
123
|
+
# user_id - int64 - User ID. Provide `username` or `user_id`
|
124
124
|
# username - string - User username. Provide `username` or `user_id`
|
125
125
|
def self.create(path, params = {}, options = {})
|
126
126
|
params ||= {}
|
@@ -136,7 +136,7 @@ module Files
|
|
136
136
|
end
|
137
137
|
|
138
138
|
# Parameters:
|
139
|
-
# id (required) -
|
139
|
+
# id (required) - int64 - Permission ID.
|
140
140
|
def self.delete(id, params = {}, options = {})
|
141
141
|
params ||= {}
|
142
142
|
params[:id] = id
|
@@ -65,8 +65,8 @@ module Files
|
|
65
65
|
end
|
66
66
|
|
67
67
|
# Parameters:
|
68
|
-
# page -
|
69
|
-
# per_page -
|
68
|
+
# page - int64 - Current page number.
|
69
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
70
70
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
71
71
|
def self.list(params = {}, options = {})
|
72
72
|
raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
|
@@ -81,7 +81,7 @@ module Files
|
|
81
81
|
end
|
82
82
|
|
83
83
|
# Parameters:
|
84
|
-
# id (required) -
|
84
|
+
# id (required) - int64 - Project ID.
|
85
85
|
def self.find(id, params = {}, options = {})
|
86
86
|
params ||= {}
|
87
87
|
params[:id] = id
|
@@ -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 - Public 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
|
# title (required) - string - Internal reference for key.
|
136
136
|
# public_key (required) - string - Actual contents of SSH key.
|
137
137
|
def self.create(params = {}, options = {})
|
@@ -264,8 +264,8 @@ module Files
|
|
264
264
|
# backblaze_b2_application_key - string - Backblaze B2 Cloud Storage applicationKey.
|
265
265
|
# hostname - string - Hostname or IP address
|
266
266
|
# name - string - Internal name for your reference
|
267
|
-
# max_connections -
|
268
|
-
# port -
|
267
|
+
# max_connections - int64 - Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
|
268
|
+
# port - int64 - Port for remote server. Not needed for S3.
|
269
269
|
# s3_bucket - string - S3 bucket name
|
270
270
|
# s3_region - string - S3 region
|
271
271
|
# server_certificate - string - Remote server certificate
|
@@ -337,8 +337,8 @@ module Files
|
|
337
337
|
end
|
338
338
|
|
339
339
|
# Parameters:
|
340
|
-
# page -
|
341
|
-
# per_page -
|
340
|
+
# page - int64 - Current page number.
|
341
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
342
342
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
343
343
|
def self.list(params = {}, options = {})
|
344
344
|
raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
|
@@ -353,7 +353,7 @@ module Files
|
|
353
353
|
end
|
354
354
|
|
355
355
|
# Parameters:
|
356
|
-
# id (required) -
|
356
|
+
# id (required) - int64 - Remote Server ID.
|
357
357
|
def self.find(id, params = {}, options = {})
|
358
358
|
params ||= {}
|
359
359
|
params[:id] = id
|
@@ -380,8 +380,8 @@ module Files
|
|
380
380
|
# backblaze_b2_application_key - string - Backblaze B2 Cloud Storage applicationKey.
|
381
381
|
# hostname - string - Hostname or IP address
|
382
382
|
# name - string - Internal name for your reference
|
383
|
-
# max_connections -
|
384
|
-
# port -
|
383
|
+
# max_connections - int64 - Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
|
384
|
+
# port - int64 - Port for remote server. Not needed for S3.
|
385
385
|
# s3_bucket - string - S3 bucket name
|
386
386
|
# s3_region - string - S3 region
|
387
387
|
# server_certificate - string - Remote server certificate
|
@@ -437,8 +437,8 @@ module Files
|
|
437
437
|
# backblaze_b2_application_key - string - Backblaze B2 Cloud Storage applicationKey.
|
438
438
|
# hostname - string - Hostname or IP address
|
439
439
|
# name - string - Internal name for your reference
|
440
|
-
# max_connections -
|
441
|
-
# port -
|
440
|
+
# max_connections - int64 - Max number of parallel connections. Ignored for S3 connections (we will parallelize these as much as possible).
|
441
|
+
# port - int64 - Port for remote server. Not needed for S3.
|
442
442
|
# s3_bucket - string - S3 bucket name
|
443
443
|
# s3_region - string - S3 region
|
444
444
|
# server_certificate - string - Remote server certificate
|
@@ -84,8 +84,8 @@ module Files
|
|
84
84
|
# List Requests
|
85
85
|
#
|
86
86
|
# Parameters:
|
87
|
-
# page -
|
88
|
-
# per_page -
|
87
|
+
# page - int64 - Current page number.
|
88
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
89
89
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
90
90
|
# mine - boolean - Only show requests of the current user? (Defaults to true if current user is not a site admin.)
|
91
91
|
def folders(params = {})
|
@@ -110,8 +110,8 @@ module Files
|
|
110
110
|
end
|
111
111
|
|
112
112
|
# Parameters:
|
113
|
-
# page -
|
114
|
-
# per_page -
|
113
|
+
# page - int64 - Current page number.
|
114
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
115
115
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
116
116
|
# mine - boolean - Only show requests of the current user? (Defaults to true if current user is not a site admin.)
|
117
117
|
# path - string - Path to show requests for. If omitted, shows all paths. Send `/` to represent the root directory.
|
@@ -133,8 +133,8 @@ module Files
|
|
133
133
|
# List Requests
|
134
134
|
#
|
135
135
|
# Parameters:
|
136
|
-
# page -
|
137
|
-
# per_page -
|
136
|
+
# page - int64 - Current page number.
|
137
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
138
138
|
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
139
139
|
# mine - boolean - Only show requests of the current user? (Defaults to true if current user is not a site admin.)
|
140
140
|
def self.folders(path, params = {}, options = {})
|
@@ -168,7 +168,7 @@ module Files
|
|
168
168
|
end
|
169
169
|
|
170
170
|
# Parameters:
|
171
|
-
# id (required) -
|
171
|
+
# id (required) - int64 - Request ID.
|
172
172
|
def self.delete(id, params = {}, options = {})
|
173
173
|
params ||= {}
|
174
174
|
params[:id] = id
|
@@ -550,7 +550,7 @@ module Files
|
|
550
550
|
# domain - string - Custom domain
|
551
551
|
# email - string - Main email for this site
|
552
552
|
# allow_bundle_names - boolean - Are manual Bundle names allowed?
|
553
|
-
# bundle_expiration -
|
553
|
+
# bundle_expiration - int64 - Site-wide Bundle expiration in days
|
554
554
|
# overage_notify - boolean - Notify site email of overages?
|
555
555
|
# welcome_email_enabled - boolean - Will the welcome email be sent to new users?
|
556
556
|
# ask_about_overwrites - boolean - If false, rename conflicting files instead of asking for overwrite confirmation. Only applies to web interface.
|
@@ -562,22 +562,22 @@ module Files
|
|
562
562
|
# default_time_zone - string - Site default time zone
|
563
563
|
# desktop_app - boolean - Is the desktop app enabled?
|
564
564
|
# desktop_app_session_ip_pinning - boolean - Is desktop app session IP pinning enabled?
|
565
|
-
# desktop_app_session_lifetime -
|
565
|
+
# desktop_app_session_lifetime - int64 - Desktop app session lifetime (in hours)
|
566
566
|
# 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.
|
567
567
|
# welcome_screen - string - Does the welcome screen appear?
|
568
|
-
# session_expiry -
|
568
|
+
# session_expiry - double - Session expiry in hours
|
569
569
|
# ssl_required - boolean - Is SSL required? Disabling this is insecure.
|
570
570
|
# tls_disabled - boolean - Is TLS disabled(site setting)?
|
571
571
|
# user_lockout - boolean - Will users be locked out after incorrect login attempts?
|
572
|
-
# user_lockout_tries -
|
573
|
-
# user_lockout_within -
|
574
|
-
# user_lockout_lock_period -
|
572
|
+
# user_lockout_tries - int64 - Number of login tries within `user_lockout_within` hours before users are locked out
|
573
|
+
# user_lockout_within - int64 - Number of hours for user lockout window
|
574
|
+
# user_lockout_lock_period - int64 - How many hours to lock user out for failed password?
|
575
575
|
# include_password_in_welcome_email - boolean - Include password in emails to new users?
|
576
576
|
# allowed_ips - string - List of allowed IP addresses
|
577
|
-
# days_to_retain_backups -
|
578
|
-
# max_prior_passwords -
|
579
|
-
# password_validity_days -
|
580
|
-
# password_min_length -
|
577
|
+
# days_to_retain_backups - int64 - Number of days to keep deleted files
|
578
|
+
# max_prior_passwords - int64 - Number of prior passwords to disallow
|
579
|
+
# password_validity_days - int64 - Number of days password is valid
|
580
|
+
# password_min_length - int64 - Shortest password length for users
|
581
581
|
# password_require_letter - boolean - Require a letter in passwords?
|
582
582
|
# password_require_mixed - boolean - Require lower and upper case letters in passwords?
|
583
583
|
# password_require_special - boolean - Require special characters in password?
|
@@ -592,7 +592,7 @@ module Files
|
|
592
592
|
# opt_out_global - boolean - Use servers in the USA only?
|
593
593
|
# use_provided_modified_at - boolean - Allow uploaders to set `provided_modified_at` for uploaded files?
|
594
594
|
# custom_namespace - boolean - Is this site using a custom namespace for users?
|
595
|
-
# disable_users_from_inactivity_period_days -
|
595
|
+
# disable_users_from_inactivity_period_days - int64 - If greater than zero, users will unable to login if they do not show activity within this number of days.
|
596
596
|
# allowed_2fa_method_sms - boolean - Is SMS two factor authentication allowed?
|
597
597
|
# allowed_2fa_method_u2f - boolean - Is U2F two factor authentication allowed?
|
598
598
|
# allowed_2fa_method_totp - boolean - Is TOTP two factor authentication allowed?
|
@@ -611,13 +611,13 @@ module Files
|
|
611
611
|
# smtp_authentication - string - SMTP server authentication type
|
612
612
|
# smtp_from - string - From address to use when mailing through custom SMTP
|
613
613
|
# smtp_username - string - SMTP server username
|
614
|
-
# smtp_port -
|
614
|
+
# smtp_port - int64 - SMTP server port
|
615
615
|
# ldap_enabled - boolean - Main LDAP setting: is LDAP enabled?
|
616
616
|
# ldap_type - string - LDAP type
|
617
617
|
# ldap_host - string - LDAP host
|
618
618
|
# ldap_host_2 - string - LDAP backup host
|
619
619
|
# ldap_host_3 - string - LDAP backup host
|
620
|
-
# ldap_port -
|
620
|
+
# ldap_port - int64 - LDAP port
|
621
621
|
# ldap_secure - boolean - Use secure LDAP?
|
622
622
|
# ldap_username - string - Username for signing in to LDAP server.
|
623
623
|
# ldap_username_field - string - LDAP username field
|