files.com 1.0.91
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/CONTRIBUTORS +4 -0
- data/Gemfile +12 -0
- data/Gemfile.lock +82 -0
- data/LICENSE +21 -0
- data/README.md +119 -0
- data/Rakefile +12 -0
- data/SECURITY.md +24 -0
- data/_VERSION +1 -0
- data/bin/files +8 -0
- data/bin/files-console +16 -0
- data/docs/account_line_item.md +41 -0
- data/docs/action.md +37 -0
- data/docs/api_key.md +202 -0
- data/docs/app.md +57 -0
- data/docs/as2_key.md +133 -0
- data/docs/auto.md +11 -0
- data/docs/automation.md +190 -0
- data/docs/behavior.md +208 -0
- data/docs/bundle.md +252 -0
- data/docs/bundle_download.md +35 -0
- data/docs/clickwrap.md +143 -0
- data/docs/dns_record.md +35 -0
- data/docs/errors.md +17 -0
- data/docs/file.md +204 -0
- data/docs/file_action.md +126 -0
- data/docs/file_comment.md +116 -0
- data/docs/file_comment_reaction.md +62 -0
- data/docs/file_part_upload.md +37 -0
- data/docs/file_utils.md +4 -0
- data/docs/folder.md +90 -0
- data/docs/group.md +153 -0
- data/docs/group_user.md +124 -0
- data/docs/history.md +171 -0
- data/docs/history_export.md +174 -0
- data/docs/image.md +13 -0
- data/docs/invoice.md +72 -0
- data/docs/invoice_line_item.md +27 -0
- data/docs/ip_address.md +55 -0
- data/docs/lock.md +98 -0
- data/docs/message.md +147 -0
- data/docs/message_comment.md +132 -0
- data/docs/message_comment_reaction.md +94 -0
- data/docs/message_reaction.md +94 -0
- data/docs/notification.md +177 -0
- data/docs/payment.md +72 -0
- data/docs/payment_line_item.md +19 -0
- data/docs/permission.md +95 -0
- data/docs/preview.md +19 -0
- data/docs/project.md +121 -0
- data/docs/public_ip_address.md +13 -0
- data/docs/public_key.md +133 -0
- data/docs/remote_server.md +356 -0
- data/docs/request.md +100 -0
- data/docs/session.md +78 -0
- data/docs/site.md +448 -0
- data/docs/sso_strategy.md +114 -0
- data/docs/status.md +21 -0
- data/docs/style.md +93 -0
- data/docs/usage_daily_snapshot.md +45 -0
- data/docs/usage_snapshot.md +53 -0
- data/docs/user.md +535 -0
- data/docs/user_cipher_use.md +41 -0
- data/docs/user_request.md +93 -0
- data/files.com.gemspec +22 -0
- data/lib/files.com.rb +184 -0
- data/lib/files.com/api.rb +38 -0
- data/lib/files.com/api_client.rb +340 -0
- data/lib/files.com/errors.rb +41 -0
- data/lib/files.com/list.rb +95 -0
- data/lib/files.com/models/account_line_item.rb +82 -0
- data/lib/files.com/models/action.rb +77 -0
- data/lib/files.com/models/api_key.rb +270 -0
- data/lib/files.com/models/app.rb +101 -0
- data/lib/files.com/models/as2_key.rb +179 -0
- data/lib/files.com/models/auto.rb +17 -0
- data/lib/files.com/models/automation.rb +304 -0
- data/lib/files.com/models/behavior.rb +266 -0
- data/lib/files.com/models/bundle.rb +371 -0
- data/lib/files.com/models/bundle_download.rb +49 -0
- data/lib/files.com/models/clickwrap.rb +197 -0
- data/lib/files.com/models/dir.rb +3 -0
- data/lib/files.com/models/dns_record.rb +51 -0
- data/lib/files.com/models/errors.rb +22 -0
- data/lib/files.com/models/file.rb +968 -0
- data/lib/files.com/models/file_action.rb +126 -0
- data/lib/files.com/models/file_comment.rb +146 -0
- data/lib/files.com/models/file_comment_reaction.rb +100 -0
- data/lib/files.com/models/file_part_upload.rb +82 -0
- data/lib/files.com/models/file_utils.rb +118 -0
- data/lib/files.com/models/folder.rb +357 -0
- data/lib/files.com/models/group.rb +208 -0
- data/lib/files.com/models/group_user.rb +171 -0
- data/lib/files.com/models/history.rb +228 -0
- data/lib/files.com/models/history_export.rb +353 -0
- data/lib/files.com/models/image.rb +22 -0
- data/lib/files.com/models/invoice.rb +117 -0
- data/lib/files.com/models/invoice_line_item.rb +57 -0
- data/lib/files.com/models/ip_address.rb +66 -0
- data/lib/files.com/models/lock.rb +173 -0
- data/lib/files.com/models/message.rb +201 -0
- data/lib/files.com/models/message_comment.rb +165 -0
- data/lib/files.com/models/message_comment_reaction.rb +128 -0
- data/lib/files.com/models/message_reaction.rb +128 -0
- data/lib/files.com/models/notification.rb +263 -0
- data/lib/files.com/models/payment.rb +117 -0
- data/lib/files.com/models/payment_line_item.rb +37 -0
- data/lib/files.com/models/permission.rb +172 -0
- data/lib/files.com/models/preview.rb +37 -0
- data/lib/files.com/models/project.rb +140 -0
- data/lib/files.com/models/public_ip_address.rb +22 -0
- data/lib/files.com/models/public_key.rb +179 -0
- data/lib/files.com/models/remote_server.rb +680 -0
- data/lib/files.com/models/request.rb +179 -0
- data/lib/files.com/models/session.rb +247 -0
- data/lib/files.com/models/site.rb +733 -0
- data/lib/files.com/models/sso_strategy.rb +227 -0
- data/lib/files.com/models/status.rb +37 -0
- data/lib/files.com/models/style.rb +131 -0
- data/lib/files.com/models/usage_daily_snapshot.rb +66 -0
- data/lib/files.com/models/usage_snapshot.rb +96 -0
- data/lib/files.com/models/user.rb +876 -0
- data/lib/files.com/models/user_cipher_use.rb +63 -0
- data/lib/files.com/models/user_request.rb +127 -0
- data/lib/files.com/response.rb +25 -0
- data/lib/files.com/sizable_io.rb +32 -0
- data/lib/files.com/system_profiler.rb +56 -0
- data/lib/files.com/util.rb +106 -0
- data/lib/files.com/version.rb +5 -0
- data/spec/list_spec.rb +214 -0
- data/spec/models/file_spec.rb +68 -0
- data/spec/models/folder_spec.rb +40 -0
- data/spec/spec_helper.rb +36 -0
- data/test.sh +8 -0
- data/test/test.rb +75 -0
- metadata +235 -0
@@ -0,0 +1,227 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Files
|
4
|
+
class SsoStrategy
|
5
|
+
attr_reader :options, :attributes
|
6
|
+
|
7
|
+
def initialize(attributes = {}, options = {})
|
8
|
+
@attributes = attributes || {}
|
9
|
+
@options = options || {}
|
10
|
+
end
|
11
|
+
|
12
|
+
# array - SSO Protocol
|
13
|
+
def protocol
|
14
|
+
@attributes[:protocol]
|
15
|
+
end
|
16
|
+
|
17
|
+
# string - Provider name
|
18
|
+
def provider
|
19
|
+
@attributes[:provider]
|
20
|
+
end
|
21
|
+
|
22
|
+
# string - Custom label for the SSO provider on the login page.
|
23
|
+
def label
|
24
|
+
@attributes[:label]
|
25
|
+
end
|
26
|
+
|
27
|
+
# string - URL holding a custom logo for the SSO provider on the login page.
|
28
|
+
def logo_url
|
29
|
+
@attributes[:logo_url]
|
30
|
+
end
|
31
|
+
|
32
|
+
# int64 - ID
|
33
|
+
def id
|
34
|
+
@attributes[:id]
|
35
|
+
end
|
36
|
+
|
37
|
+
# string - Identity provider sha256 cert fingerprint if saml_provider_metadata_url is not available.
|
38
|
+
def saml_provider_cert_fingerprint
|
39
|
+
@attributes[:saml_provider_cert_fingerprint]
|
40
|
+
end
|
41
|
+
|
42
|
+
# string - Identity provider issuer url
|
43
|
+
def saml_provider_issuer_url
|
44
|
+
@attributes[:saml_provider_issuer_url]
|
45
|
+
end
|
46
|
+
|
47
|
+
# string - Metadata URL for the SAML identity provider
|
48
|
+
def saml_provider_metadata_url
|
49
|
+
@attributes[:saml_provider_metadata_url]
|
50
|
+
end
|
51
|
+
|
52
|
+
# string - Identity provider SLO endpoint
|
53
|
+
def saml_provider_slo_target_url
|
54
|
+
@attributes[:saml_provider_slo_target_url]
|
55
|
+
end
|
56
|
+
|
57
|
+
# string - Identity provider SSO endpoint if saml_provider_metadata_url is not available.
|
58
|
+
def saml_provider_sso_target_url
|
59
|
+
@attributes[:saml_provider_sso_target_url]
|
60
|
+
end
|
61
|
+
|
62
|
+
# string - SCIM authentication type.
|
63
|
+
def scim_authentication_method
|
64
|
+
@attributes[:scim_authentication_method]
|
65
|
+
end
|
66
|
+
|
67
|
+
# string - SCIM username.
|
68
|
+
def scim_username
|
69
|
+
@attributes[:scim_username]
|
70
|
+
end
|
71
|
+
|
72
|
+
# string - Subdomain
|
73
|
+
def subdomain
|
74
|
+
@attributes[:subdomain]
|
75
|
+
end
|
76
|
+
|
77
|
+
# boolean - Auto-provision users?
|
78
|
+
def provision_users
|
79
|
+
@attributes[:provision_users]
|
80
|
+
end
|
81
|
+
|
82
|
+
# boolean - Auto-provision group membership based on group memberships on the SSO side?
|
83
|
+
def provision_groups
|
84
|
+
@attributes[:provision_groups]
|
85
|
+
end
|
86
|
+
|
87
|
+
# boolean - Auto-deprovision users?
|
88
|
+
def deprovision_users
|
89
|
+
@attributes[:deprovision_users]
|
90
|
+
end
|
91
|
+
|
92
|
+
# boolean - Auto-deprovision group membership based on group memberships on the SSO side?
|
93
|
+
def deprovision_groups
|
94
|
+
@attributes[:deprovision_groups]
|
95
|
+
end
|
96
|
+
|
97
|
+
# string - Comma-separated list of group names for groups to automatically add all auto-provisioned users to.
|
98
|
+
def provision_group_default
|
99
|
+
@attributes[:provision_group_default]
|
100
|
+
end
|
101
|
+
|
102
|
+
# string - Comma-separated list of group names for groups (with optional wildcards) that will be excluded from auto-provisioning.
|
103
|
+
def provision_group_exclusion
|
104
|
+
@attributes[:provision_group_exclusion]
|
105
|
+
end
|
106
|
+
|
107
|
+
# string - Comma-separated list of group names for groups (with optional wildcards) that will be auto-provisioned.
|
108
|
+
def provision_group_inclusion
|
109
|
+
@attributes[:provision_group_inclusion]
|
110
|
+
end
|
111
|
+
|
112
|
+
# string - Comma or newline separated list of group names (with optional wildcards) to require membership for user provisioning.
|
113
|
+
def provision_group_required
|
114
|
+
@attributes[:provision_group_required]
|
115
|
+
end
|
116
|
+
|
117
|
+
# boolean - Auto-provisioned users get Sharing permission?
|
118
|
+
def provision_attachments_permission
|
119
|
+
@attributes[:provision_attachments_permission]
|
120
|
+
end
|
121
|
+
|
122
|
+
# boolean - Auto-provisioned users get WebDAV permission?
|
123
|
+
def provision_dav_permission
|
124
|
+
@attributes[:provision_dav_permission]
|
125
|
+
end
|
126
|
+
|
127
|
+
# boolean - Auto-provisioned users get FTP permission?
|
128
|
+
def provision_ftp_permission
|
129
|
+
@attributes[:provision_ftp_permission]
|
130
|
+
end
|
131
|
+
|
132
|
+
# boolean - Auto-provisioned users get SFTP permission?
|
133
|
+
def provision_sftp_permission
|
134
|
+
@attributes[:provision_sftp_permission]
|
135
|
+
end
|
136
|
+
|
137
|
+
# string - Default time zone for auto provisioned users.
|
138
|
+
def provision_time_zone
|
139
|
+
@attributes[:provision_time_zone]
|
140
|
+
end
|
141
|
+
|
142
|
+
# string - Base DN for looking up users in LDAP server
|
143
|
+
def ldap_base_dn
|
144
|
+
@attributes[:ldap_base_dn]
|
145
|
+
end
|
146
|
+
|
147
|
+
# string - Domain name that will be appended to LDAP usernames
|
148
|
+
def ldap_domain
|
149
|
+
@attributes[:ldap_domain]
|
150
|
+
end
|
151
|
+
|
152
|
+
# boolean - Is strategy enabled?
|
153
|
+
def enabled
|
154
|
+
@attributes[:enabled]
|
155
|
+
end
|
156
|
+
|
157
|
+
# string - LDAP host
|
158
|
+
def ldap_host
|
159
|
+
@attributes[:ldap_host]
|
160
|
+
end
|
161
|
+
|
162
|
+
# string - LDAP backup host
|
163
|
+
def ldap_host_2
|
164
|
+
@attributes[:ldap_host_2]
|
165
|
+
end
|
166
|
+
|
167
|
+
# string - LDAP backup host
|
168
|
+
def ldap_host_3
|
169
|
+
@attributes[:ldap_host_3]
|
170
|
+
end
|
171
|
+
|
172
|
+
# int64 - LDAP port
|
173
|
+
def ldap_port
|
174
|
+
@attributes[:ldap_port]
|
175
|
+
end
|
176
|
+
|
177
|
+
# boolean - Use secure LDAP?
|
178
|
+
def ldap_secure
|
179
|
+
@attributes[:ldap_secure]
|
180
|
+
end
|
181
|
+
|
182
|
+
# string - Username for signing in to LDAP server.
|
183
|
+
def ldap_username
|
184
|
+
@attributes[:ldap_username]
|
185
|
+
end
|
186
|
+
|
187
|
+
# string - LDAP username field
|
188
|
+
def ldap_username_field
|
189
|
+
@attributes[:ldap_username_field]
|
190
|
+
end
|
191
|
+
|
192
|
+
# Parameters:
|
193
|
+
# page - int64 - Current page number.
|
194
|
+
# per_page - int64 - Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
|
195
|
+
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
196
|
+
def self.list(params = {}, options = {})
|
197
|
+
raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
|
198
|
+
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
|
199
|
+
raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
|
200
|
+
|
201
|
+
response, options = Api.send_request("/sso_strategies", :get, params, options)
|
202
|
+
response.data.map do |entity_data|
|
203
|
+
SsoStrategy.new(entity_data, options)
|
204
|
+
end
|
205
|
+
end
|
206
|
+
|
207
|
+
def self.all(params = {}, options = {})
|
208
|
+
list(params, options)
|
209
|
+
end
|
210
|
+
|
211
|
+
# Parameters:
|
212
|
+
# id (required) - int64 - Sso Strategy ID.
|
213
|
+
def self.find(id, params = {}, options = {})
|
214
|
+
params ||= {}
|
215
|
+
params[:id] = id
|
216
|
+
raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
|
217
|
+
raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
|
218
|
+
|
219
|
+
response, options = Api.send_request("/sso_strategies/#{params[:id]}", :get, params, options)
|
220
|
+
SsoStrategy.new(response.data, options)
|
221
|
+
end
|
222
|
+
|
223
|
+
def self.get(id, params = {}, options = {})
|
224
|
+
find(id, params, options)
|
225
|
+
end
|
226
|
+
end
|
227
|
+
end
|
@@ -0,0 +1,37 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Files
|
4
|
+
class Status
|
5
|
+
attr_reader :options, :attributes
|
6
|
+
|
7
|
+
def initialize(attributes = {}, options = {})
|
8
|
+
@attributes = attributes || {}
|
9
|
+
@options = options || {}
|
10
|
+
end
|
11
|
+
|
12
|
+
# int64 - Status http code
|
13
|
+
def code
|
14
|
+
@attributes[:code]
|
15
|
+
end
|
16
|
+
|
17
|
+
# string - Error message
|
18
|
+
def message
|
19
|
+
@attributes[:message]
|
20
|
+
end
|
21
|
+
|
22
|
+
# string - Status message
|
23
|
+
def status
|
24
|
+
@attributes[:status]
|
25
|
+
end
|
26
|
+
|
27
|
+
# Additional data
|
28
|
+
def data
|
29
|
+
@attributes[:data]
|
30
|
+
end
|
31
|
+
|
32
|
+
# array - A list of api errors
|
33
|
+
def errors
|
34
|
+
@attributes[:errors]
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
@@ -0,0 +1,131 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Files
|
4
|
+
class Style
|
5
|
+
attr_reader :options, :attributes
|
6
|
+
|
7
|
+
def initialize(attributes = {}, options = {})
|
8
|
+
@attributes = attributes || {}
|
9
|
+
@options = options || {}
|
10
|
+
end
|
11
|
+
|
12
|
+
# int64 - Style ID
|
13
|
+
def id
|
14
|
+
@attributes[:id]
|
15
|
+
end
|
16
|
+
|
17
|
+
def id=(value)
|
18
|
+
@attributes[:id] = value
|
19
|
+
end
|
20
|
+
|
21
|
+
# string - Folder path This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
|
22
|
+
def path
|
23
|
+
@attributes[:path]
|
24
|
+
end
|
25
|
+
|
26
|
+
def path=(value)
|
27
|
+
@attributes[:path] = value
|
28
|
+
end
|
29
|
+
|
30
|
+
# Logo
|
31
|
+
def logo
|
32
|
+
@attributes[:logo]
|
33
|
+
end
|
34
|
+
|
35
|
+
def logo=(value)
|
36
|
+
@attributes[:logo] = value
|
37
|
+
end
|
38
|
+
|
39
|
+
# Logo thumbnail
|
40
|
+
def thumbnail
|
41
|
+
@attributes[:thumbnail]
|
42
|
+
end
|
43
|
+
|
44
|
+
def thumbnail=(value)
|
45
|
+
@attributes[:thumbnail] = value
|
46
|
+
end
|
47
|
+
|
48
|
+
# file - Logo for custom branding.
|
49
|
+
def file
|
50
|
+
@attributes[:file]
|
51
|
+
end
|
52
|
+
|
53
|
+
def file=(value)
|
54
|
+
@attributes[:file] = value
|
55
|
+
end
|
56
|
+
|
57
|
+
# Parameters:
|
58
|
+
# file (required) - file - Logo for custom branding.
|
59
|
+
def update(params = {})
|
60
|
+
params ||= {}
|
61
|
+
params[:path] = @attributes[:path]
|
62
|
+
raise MissingParameterError.new("Current object doesn't have a path") unless @attributes[:path]
|
63
|
+
raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
|
64
|
+
raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
|
65
|
+
raise MissingParameterError.new("Parameter missing: file") unless params.dig(:file)
|
66
|
+
|
67
|
+
Api.send_request("/styles/#{@attributes[:path]}", :patch, params, @options)
|
68
|
+
end
|
69
|
+
|
70
|
+
def delete(params = {})
|
71
|
+
params ||= {}
|
72
|
+
params[:path] = @attributes[:path]
|
73
|
+
raise MissingParameterError.new("Current object doesn't have a path") unless @attributes[:path]
|
74
|
+
raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
|
75
|
+
raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
|
76
|
+
|
77
|
+
Api.send_request("/styles/#{@attributes[:path]}", :delete, params, @options)
|
78
|
+
end
|
79
|
+
|
80
|
+
def destroy(params = {})
|
81
|
+
delete(params)
|
82
|
+
end
|
83
|
+
|
84
|
+
def save
|
85
|
+
update(@attributes)
|
86
|
+
end
|
87
|
+
|
88
|
+
# Parameters:
|
89
|
+
# path (required) - string - Style path.
|
90
|
+
def self.find(path, params = {}, options = {})
|
91
|
+
params ||= {}
|
92
|
+
params[:path] = path
|
93
|
+
raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
|
94
|
+
raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
|
95
|
+
|
96
|
+
response, options = Api.send_request("/styles/#{params[:path]}", :get, params, options)
|
97
|
+
Style.new(response.data, options)
|
98
|
+
end
|
99
|
+
|
100
|
+
def self.get(path, params = {}, options = {})
|
101
|
+
find(path, params, options)
|
102
|
+
end
|
103
|
+
|
104
|
+
# Parameters:
|
105
|
+
# file (required) - file - Logo for custom branding.
|
106
|
+
def self.update(path, params = {}, options = {})
|
107
|
+
params ||= {}
|
108
|
+
params[:path] = path
|
109
|
+
raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
|
110
|
+
raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
|
111
|
+
raise MissingParameterError.new("Parameter missing: file") unless params.dig(:file)
|
112
|
+
|
113
|
+
response, options = Api.send_request("/styles/#{params[:path]}", :patch, params, options)
|
114
|
+
Style.new(response.data, options)
|
115
|
+
end
|
116
|
+
|
117
|
+
def self.delete(path, params = {}, options = {})
|
118
|
+
params ||= {}
|
119
|
+
params[:path] = path
|
120
|
+
raise InvalidParameterError.new("Bad parameter: path must be an String") if params.dig(:path) and !params.dig(:path).is_a?(String)
|
121
|
+
raise MissingParameterError.new("Parameter missing: path") unless params.dig(:path)
|
122
|
+
|
123
|
+
response, _options = Api.send_request("/styles/#{params[:path]}", :delete, params, options)
|
124
|
+
response.data
|
125
|
+
end
|
126
|
+
|
127
|
+
def self.destroy(path, params = {}, options = {})
|
128
|
+
delete(path, params, options)
|
129
|
+
end
|
130
|
+
end
|
131
|
+
end
|
@@ -0,0 +1,66 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Files
|
4
|
+
class UsageDailySnapshot
|
5
|
+
attr_reader :options, :attributes
|
6
|
+
|
7
|
+
def initialize(attributes = {}, options = {})
|
8
|
+
@attributes = attributes || {}
|
9
|
+
@options = options || {}
|
10
|
+
end
|
11
|
+
|
12
|
+
# int64 - ID of the usage record
|
13
|
+
def id
|
14
|
+
@attributes[:id]
|
15
|
+
end
|
16
|
+
|
17
|
+
# date - The date of this usage record
|
18
|
+
def date
|
19
|
+
@attributes[:date]
|
20
|
+
end
|
21
|
+
|
22
|
+
# int64 - The quantity of storage held for this site
|
23
|
+
def current_storage
|
24
|
+
@attributes[:current_storage]
|
25
|
+
end
|
26
|
+
|
27
|
+
# array - Usage broken down by each top-level folder
|
28
|
+
def usage_by_top_level_dir
|
29
|
+
@attributes[:usage_by_top_level_dir]
|
30
|
+
end
|
31
|
+
|
32
|
+
# Parameters:
|
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
|
+
# action - string - Deprecated: If set to `count` returns a count of matching records rather than the records themselves.
|
36
|
+
# 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-Next header.
|
37
|
+
# sort_by - object - If set, sort records by the specified field in either 'asc' or 'desc' direction (e.g. sort_by[last_login_at]=desc). Valid fields are `site_id`, `date` or `usage_snapshot_id`.
|
38
|
+
# filter - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`.
|
39
|
+
# filter_gt - object - If set, return records where the specifiied field is greater than the supplied value. Valid fields are `date` and `usage_snapshot_id`.
|
40
|
+
# filter_gteq - object - If set, return records where the specifiied field is greater than or equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`.
|
41
|
+
# filter_like - object - If set, return records where the specifiied field is equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`.
|
42
|
+
# filter_lt - object - If set, return records where the specifiied field is less than the supplied value. Valid fields are `date` and `usage_snapshot_id`.
|
43
|
+
# filter_lteq - object - If set, return records where the specifiied field is less than or equal to the supplied value. Valid fields are `date` and `usage_snapshot_id`.
|
44
|
+
def self.list(params = {}, options = {})
|
45
|
+
raise InvalidParameterError.new("Bad parameter: page must be an Integer") if params.dig(:page) and !params.dig(:page).is_a?(Integer)
|
46
|
+
raise InvalidParameterError.new("Bad parameter: per_page must be an Integer") if params.dig(:per_page) and !params.dig(:per_page).is_a?(Integer)
|
47
|
+
raise InvalidParameterError.new("Bad parameter: action must be an String") if params.dig(:action) and !params.dig(:action).is_a?(String)
|
48
|
+
raise InvalidParameterError.new("Bad parameter: cursor must be an String") if params.dig(:cursor) and !params.dig(:cursor).is_a?(String)
|
49
|
+
raise InvalidParameterError.new("Bad parameter: sort_by must be an Hash") if params.dig(:sort_by) and !params.dig(:sort_by).is_a?(Hash)
|
50
|
+
raise InvalidParameterError.new("Bad parameter: filter must be an Hash") if params.dig(:filter) and !params.dig(:filter).is_a?(Hash)
|
51
|
+
raise InvalidParameterError.new("Bad parameter: filter_gt must be an Hash") if params.dig(:filter_gt) and !params.dig(:filter_gt).is_a?(Hash)
|
52
|
+
raise InvalidParameterError.new("Bad parameter: filter_gteq must be an Hash") if params.dig(:filter_gteq) and !params.dig(:filter_gteq).is_a?(Hash)
|
53
|
+
raise InvalidParameterError.new("Bad parameter: filter_like must be an Hash") if params.dig(:filter_like) and !params.dig(:filter_like).is_a?(Hash)
|
54
|
+
raise InvalidParameterError.new("Bad parameter: filter_lt must be an Hash") if params.dig(:filter_lt) and !params.dig(:filter_lt).is_a?(Hash)
|
55
|
+
raise InvalidParameterError.new("Bad parameter: filter_lteq must be an Hash") if params.dig(:filter_lteq) and !params.dig(:filter_lteq).is_a?(Hash)
|
56
|
+
|
57
|
+
List.new(UsageDailySnapshot, params) do
|
58
|
+
Api.send_request("/usage_daily_snapshots", :get, params, options)
|
59
|
+
end
|
60
|
+
end
|
61
|
+
|
62
|
+
def self.all(params = {}, options = {})
|
63
|
+
list(params, options)
|
64
|
+
end
|
65
|
+
end
|
66
|
+
end
|